1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "vbdev_ocf.h" 35 #include "stats.h" 36 #include "spdk/log.h" 37 #include "spdk/rpc.h" 38 #include "spdk/string.h" 39 40 /* Structure to hold the parameters for this RPC method. */ 41 struct rpc_bdev_ocf_create { 42 char *name; /* master vbdev */ 43 char *mode; /* OCF mode (choose one) */ 44 uint64_t cache_line_size; /* OCF cache line size */ 45 char *cache_bdev_name; /* sub bdev */ 46 char *core_bdev_name; /* sub bdev */ 47 }; 48 49 static void 50 free_rpc_bdev_ocf_create(struct rpc_bdev_ocf_create *r) 51 { 52 free(r->name); 53 free(r->core_bdev_name); 54 free(r->cache_bdev_name); 55 free(r->mode); 56 } 57 58 /* Structure to decode the input parameters for this RPC method. */ 59 static const struct spdk_json_object_decoder rpc_bdev_ocf_create_decoders[] = { 60 {"name", offsetof(struct rpc_bdev_ocf_create, name), spdk_json_decode_string}, 61 {"mode", offsetof(struct rpc_bdev_ocf_create, mode), spdk_json_decode_string}, 62 {"cache_line_size", offsetof(struct rpc_bdev_ocf_create, cache_line_size), spdk_json_decode_uint64, true}, 63 {"cache_bdev_name", offsetof(struct rpc_bdev_ocf_create, cache_bdev_name), spdk_json_decode_string}, 64 {"core_bdev_name", offsetof(struct rpc_bdev_ocf_create, core_bdev_name), spdk_json_decode_string}, 65 }; 66 67 static void 68 construct_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 69 { 70 struct spdk_jsonrpc_request *request = cb_arg; 71 struct spdk_json_write_ctx *w; 72 73 if (status) { 74 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 75 "Could not create OCF vbdev: %d", 76 status); 77 } else { 78 w = spdk_jsonrpc_begin_result(request); 79 spdk_json_write_string(w, vbdev->name); 80 spdk_jsonrpc_end_result(request, w); 81 } 82 } 83 84 static void 85 rpc_bdev_ocf_create(struct spdk_jsonrpc_request *request, 86 const struct spdk_json_val *params) 87 { 88 struct rpc_bdev_ocf_create req = {NULL}; 89 int ret; 90 91 ret = spdk_json_decode_object(params, rpc_bdev_ocf_create_decoders, 92 SPDK_COUNTOF(rpc_bdev_ocf_create_decoders), 93 &req); 94 if (ret) { 95 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 96 "Invalid parameters"); 97 free_rpc_bdev_ocf_create(&req); 98 return; 99 } 100 101 vbdev_ocf_construct(req.name, req.mode, req.cache_line_size, req.cache_bdev_name, 102 req.core_bdev_name, false, construct_cb, request); 103 free_rpc_bdev_ocf_create(&req); 104 } 105 SPDK_RPC_REGISTER("bdev_ocf_create", rpc_bdev_ocf_create, SPDK_RPC_RUNTIME) 106 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_create, construct_ocf_bdev) 107 108 /* Structure to hold the parameters for this RPC method. */ 109 struct rpc_bdev_ocf_delete { 110 char *name; /* master vbdev name */ 111 }; 112 113 static void 114 free_rpc_bdev_ocf_delete(struct rpc_bdev_ocf_delete *r) 115 { 116 free(r->name); 117 } 118 119 /* Structure to decode the input parameters for this RPC method. */ 120 static const struct spdk_json_object_decoder rpc_bdev_ocf_delete_decoders[] = { 121 {"name", offsetof(struct rpc_bdev_ocf_delete, name), spdk_json_decode_string}, 122 }; 123 124 static void 125 delete_cb(void *cb_arg, int status) 126 { 127 struct spdk_jsonrpc_request *request = cb_arg; 128 struct spdk_json_write_ctx *w; 129 130 if (status) { 131 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 132 "Could not delete OCF vbdev: %d", 133 status); 134 } else { 135 w = spdk_jsonrpc_begin_result(request); 136 spdk_json_write_bool(w, true); 137 spdk_jsonrpc_end_result(request, w); 138 } 139 } 140 141 static void 142 rpc_bdev_ocf_delete(struct spdk_jsonrpc_request *request, 143 const struct spdk_json_val *params) 144 { 145 struct rpc_bdev_ocf_delete req = {NULL}; 146 struct vbdev_ocf *vbdev; 147 int status; 148 149 status = spdk_json_decode_object(params, rpc_bdev_ocf_delete_decoders, 150 SPDK_COUNTOF(rpc_bdev_ocf_delete_decoders), 151 &req); 152 if (status) { 153 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 154 "Invalid parameters"); 155 goto end; 156 } 157 158 vbdev = vbdev_ocf_get_by_name(req.name); 159 if (vbdev == NULL) { 160 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 161 spdk_strerror(ENODEV)); 162 goto end; 163 } 164 165 status = vbdev_ocf_delete_clean(vbdev, delete_cb, request); 166 if (status) { 167 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 168 "Could not delete OCF vbdev: %s", 169 spdk_strerror(-status)); 170 goto end; 171 } 172 173 end: 174 free_rpc_bdev_ocf_delete(&req); 175 } 176 SPDK_RPC_REGISTER("bdev_ocf_delete", rpc_bdev_ocf_delete, SPDK_RPC_RUNTIME) 177 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_delete, delete_ocf_bdev) 178 179 /* Structure to hold the parameters for this RPC method. */ 180 struct rpc_bdev_ocf_get_stats { 181 char *name; /* master vbdev name */ 182 }; 183 184 static void 185 free_rpc_bdev_ocf_get_stats(struct rpc_bdev_ocf_get_stats *r) 186 { 187 free(r->name); 188 } 189 190 /* Structure to decode the input parameters for this RPC method. */ 191 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_stats_decoders[] = { 192 {"name", offsetof(struct rpc_bdev_ocf_get_stats, name), spdk_json_decode_string}, 193 }; 194 195 struct get_ocf_stats_ctx { 196 struct spdk_jsonrpc_request *request; 197 char *core_name; 198 }; 199 200 static void 201 rpc_bdev_ocf_get_stats_cmpl(ocf_cache_t cache, void *priv, int error) 202 { 203 struct get_ocf_stats_ctx *ctx = (struct get_ocf_stats_ctx *) priv; 204 struct spdk_json_write_ctx *w; 205 struct vbdev_ocf_stats stats; 206 207 if (error) { 208 goto end; 209 } 210 211 error = vbdev_ocf_stats_get(cache, ctx->core_name, &stats); 212 213 ocf_mngt_cache_read_unlock(cache); 214 215 if (error) { 216 goto end; 217 } 218 219 w = spdk_jsonrpc_begin_result(ctx->request); 220 vbdev_ocf_stats_write_json(w, &stats); 221 spdk_jsonrpc_end_result(ctx->request, w); 222 223 end: 224 if (error) { 225 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 226 "Could not get stats: %s", 227 spdk_strerror(-error)); 228 } 229 free(ctx); 230 } 231 232 static void 233 rpc_bdev_ocf_get_stats(struct spdk_jsonrpc_request *request, 234 const struct spdk_json_val *params) 235 { 236 struct rpc_bdev_ocf_get_stats req = {NULL}; 237 struct vbdev_ocf *vbdev; 238 struct get_ocf_stats_ctx *ctx; 239 240 ctx = calloc(1, sizeof(*ctx)); 241 if (!ctx) { 242 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 243 "Not enough memory to process request"); 244 goto end; 245 } 246 247 if (spdk_json_decode_object(params, rpc_bdev_ocf_get_stats_decoders, 248 SPDK_COUNTOF(rpc_bdev_ocf_get_stats_decoders), 249 &req)) { 250 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 251 "Invalid parameters"); 252 free(ctx); 253 goto end; 254 } 255 256 vbdev = vbdev_ocf_get_by_name(req.name); 257 if (vbdev == NULL) { 258 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 259 spdk_strerror(ENODEV)); 260 free(ctx); 261 goto end; 262 } 263 264 ctx->core_name = vbdev->core.name; 265 ctx->request = request; 266 ocf_mngt_cache_read_lock(vbdev->ocf_cache, rpc_bdev_ocf_get_stats_cmpl, ctx); 267 268 end: 269 free_rpc_bdev_ocf_get_stats(&req); 270 } 271 SPDK_RPC_REGISTER("bdev_ocf_get_stats", rpc_bdev_ocf_get_stats, SPDK_RPC_RUNTIME) 272 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_get_stats, get_ocf_stats) 273 274 /* Structure to hold the parameters for this RPC method. */ 275 struct rpc_bdev_ocf_get_bdevs { 276 char *name; 277 }; 278 279 static void 280 free_rpc_bdev_ocf_get_bdevs(struct rpc_bdev_ocf_get_bdevs *r) 281 { 282 free(r->name); 283 } 284 285 /* Structure to decode the input parameters for this RPC method. */ 286 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_bdevs_decoders[] = { 287 {"name", offsetof(struct rpc_bdev_ocf_get_bdevs, name), spdk_json_decode_string, true}, 288 }; 289 290 struct bdev_get_bdevs_ctx { 291 char *name; 292 struct spdk_json_write_ctx *w; 293 }; 294 295 static void 296 bdev_get_bdevs_fn(struct vbdev_ocf *vbdev, void *ctx) 297 { 298 struct bdev_get_bdevs_ctx *cctx = ctx; 299 struct spdk_json_write_ctx *w = cctx->w; 300 301 if (cctx->name != NULL && 302 strcmp(vbdev->name, cctx->name) && 303 strcmp(vbdev->cache.name, cctx->name) && 304 strcmp(vbdev->core.name, cctx->name)) { 305 return; 306 } 307 308 spdk_json_write_object_begin(w); 309 spdk_json_write_named_string(w, "name", vbdev->name); 310 spdk_json_write_named_bool(w, "started", vbdev->state.started); 311 312 spdk_json_write_named_object_begin(w, "cache"); 313 spdk_json_write_named_string(w, "name", vbdev->cache.name); 314 spdk_json_write_named_bool(w, "attached", vbdev->cache.attached); 315 spdk_json_write_object_end(w); 316 317 spdk_json_write_named_object_begin(w, "core"); 318 spdk_json_write_named_string(w, "name", vbdev->core.name); 319 spdk_json_write_named_bool(w, "attached", vbdev->core.attached); 320 spdk_json_write_object_end(w); 321 322 spdk_json_write_object_end(w); 323 } 324 325 static void 326 rpc_bdev_ocf_get_bdevs(struct spdk_jsonrpc_request *request, 327 const struct spdk_json_val *params) 328 { 329 struct spdk_json_write_ctx *w; 330 struct rpc_bdev_ocf_get_bdevs req = {NULL}; 331 struct bdev_get_bdevs_ctx cctx; 332 333 if (params && spdk_json_decode_object(params, rpc_bdev_ocf_get_bdevs_decoders, 334 SPDK_COUNTOF(rpc_bdev_ocf_get_bdevs_decoders), 335 &req)) { 336 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 337 "Invalid parameters"); 338 goto end; 339 } 340 341 if (req.name) { 342 if (!(vbdev_ocf_get_by_name(req.name) || vbdev_ocf_get_base_by_name(req.name))) { 343 spdk_jsonrpc_send_error_response(request, 344 SPDK_JSONRPC_ERROR_INVALID_PARAMS, 345 spdk_strerror(ENODEV)); 346 goto end; 347 } 348 } 349 350 w = spdk_jsonrpc_begin_result(request); 351 352 cctx.name = req.name; 353 cctx.w = w; 354 355 spdk_json_write_array_begin(w); 356 vbdev_ocf_foreach(bdev_get_bdevs_fn, &cctx); 357 spdk_json_write_array_end(w); 358 spdk_jsonrpc_end_result(request, w); 359 360 end: 361 free_rpc_bdev_ocf_get_bdevs(&req); 362 } 363 SPDK_RPC_REGISTER("bdev_ocf_get_bdevs", rpc_bdev_ocf_get_bdevs, SPDK_RPC_RUNTIME) 364 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_ocf_get_bdevs, get_ocf_bdevs) 365