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 "utils.h" 37 #include "spdk/log.h" 38 #include "spdk/rpc.h" 39 #include "spdk/string.h" 40 41 /* Structure to hold the parameters for this RPC method. */ 42 struct rpc_bdev_ocf_create { 43 char *name; /* main vbdev */ 44 char *mode; /* OCF mode (choose one) */ 45 uint64_t cache_line_size; /* OCF cache line size */ 46 char *cache_bdev_name; /* sub bdev */ 47 char *core_bdev_name; /* sub bdev */ 48 }; 49 50 static void 51 free_rpc_bdev_ocf_create(struct rpc_bdev_ocf_create *r) 52 { 53 free(r->name); 54 free(r->core_bdev_name); 55 free(r->cache_bdev_name); 56 free(r->mode); 57 } 58 59 /* Structure to decode the input parameters for this RPC method. */ 60 static const struct spdk_json_object_decoder rpc_bdev_ocf_create_decoders[] = { 61 {"name", offsetof(struct rpc_bdev_ocf_create, name), spdk_json_decode_string}, 62 {"mode", offsetof(struct rpc_bdev_ocf_create, mode), spdk_json_decode_string}, 63 {"cache_line_size", offsetof(struct rpc_bdev_ocf_create, cache_line_size), spdk_json_decode_uint64, true}, 64 {"cache_bdev_name", offsetof(struct rpc_bdev_ocf_create, cache_bdev_name), spdk_json_decode_string}, 65 {"core_bdev_name", offsetof(struct rpc_bdev_ocf_create, core_bdev_name), spdk_json_decode_string}, 66 }; 67 68 static void 69 construct_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 70 { 71 struct spdk_jsonrpc_request *request = cb_arg; 72 struct spdk_json_write_ctx *w; 73 74 if (status) { 75 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 76 "Could not create OCF vbdev: %d", 77 status); 78 } else { 79 w = spdk_jsonrpc_begin_result(request); 80 spdk_json_write_string(w, vbdev->name); 81 spdk_jsonrpc_end_result(request, w); 82 } 83 } 84 85 static void 86 rpc_bdev_ocf_create(struct spdk_jsonrpc_request *request, 87 const struct spdk_json_val *params) 88 { 89 struct rpc_bdev_ocf_create req = {NULL}; 90 int ret; 91 92 ret = spdk_json_decode_object(params, rpc_bdev_ocf_create_decoders, 93 SPDK_COUNTOF(rpc_bdev_ocf_create_decoders), 94 &req); 95 if (ret) { 96 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 97 "Invalid parameters"); 98 free_rpc_bdev_ocf_create(&req); 99 return; 100 } 101 102 vbdev_ocf_construct(req.name, req.mode, req.cache_line_size, req.cache_bdev_name, 103 req.core_bdev_name, false, construct_cb, request); 104 free_rpc_bdev_ocf_create(&req); 105 } 106 SPDK_RPC_REGISTER("bdev_ocf_create", rpc_bdev_ocf_create, SPDK_RPC_RUNTIME) 107 108 /* Structure to hold the parameters for this RPC method. */ 109 struct rpc_bdev_ocf_delete { 110 char *name; /* main 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 129 if (status) { 130 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 131 "Could not delete OCF vbdev: %d", 132 status); 133 } else { 134 spdk_jsonrpc_send_bool_response(request, true); 135 } 136 } 137 138 static void 139 rpc_bdev_ocf_delete(struct spdk_jsonrpc_request *request, 140 const struct spdk_json_val *params) 141 { 142 struct rpc_bdev_ocf_delete req = {NULL}; 143 struct vbdev_ocf *vbdev; 144 int status; 145 146 status = spdk_json_decode_object(params, rpc_bdev_ocf_delete_decoders, 147 SPDK_COUNTOF(rpc_bdev_ocf_delete_decoders), 148 &req); 149 if (status) { 150 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 151 "Invalid parameters"); 152 goto end; 153 } 154 155 vbdev = vbdev_ocf_get_by_name(req.name); 156 if (vbdev == NULL) { 157 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 158 spdk_strerror(ENODEV)); 159 goto end; 160 } 161 162 status = vbdev_ocf_delete_clean(vbdev, delete_cb, request); 163 if (status) { 164 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 165 "Could not delete OCF vbdev: %s", 166 spdk_strerror(-status)); 167 goto end; 168 } 169 170 end: 171 free_rpc_bdev_ocf_delete(&req); 172 } 173 SPDK_RPC_REGISTER("bdev_ocf_delete", rpc_bdev_ocf_delete, SPDK_RPC_RUNTIME) 174 175 /* Structure to hold the parameters for this RPC method. */ 176 struct rpc_bdev_ocf_get_stats { 177 char *name; /* main vbdev name */ 178 }; 179 180 static void 181 free_rpc_bdev_ocf_get_stats(struct rpc_bdev_ocf_get_stats *r) 182 { 183 free(r->name); 184 } 185 186 /* Structure to decode the input parameters for this RPC method. */ 187 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_stats_decoders[] = { 188 {"name", offsetof(struct rpc_bdev_ocf_get_stats, name), spdk_json_decode_string}, 189 }; 190 191 struct get_ocf_stats_ctx { 192 struct spdk_jsonrpc_request *request; 193 char *core_name; 194 }; 195 196 static void 197 rpc_bdev_ocf_get_stats_cmpl(ocf_cache_t cache, void *priv, int error) 198 { 199 struct get_ocf_stats_ctx *ctx = (struct get_ocf_stats_ctx *) priv; 200 struct spdk_json_write_ctx *w; 201 struct vbdev_ocf_stats stats; 202 203 if (error) { 204 goto end; 205 } 206 207 error = vbdev_ocf_stats_get(cache, ctx->core_name, &stats); 208 209 ocf_mngt_cache_read_unlock(cache); 210 211 if (error) { 212 goto end; 213 } 214 215 w = spdk_jsonrpc_begin_result(ctx->request); 216 vbdev_ocf_stats_write_json(w, &stats); 217 spdk_jsonrpc_end_result(ctx->request, w); 218 219 end: 220 if (error) { 221 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 222 "Could not get stats: %s", 223 spdk_strerror(-error)); 224 } 225 free(ctx); 226 } 227 228 static void 229 rpc_bdev_ocf_get_stats(struct spdk_jsonrpc_request *request, 230 const struct spdk_json_val *params) 231 { 232 struct rpc_bdev_ocf_get_stats req = {NULL}; 233 struct vbdev_ocf *vbdev; 234 struct get_ocf_stats_ctx *ctx; 235 236 ctx = calloc(1, sizeof(*ctx)); 237 if (!ctx) { 238 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 239 "Not enough memory to process request"); 240 goto end; 241 } 242 243 if (spdk_json_decode_object(params, rpc_bdev_ocf_get_stats_decoders, 244 SPDK_COUNTOF(rpc_bdev_ocf_get_stats_decoders), 245 &req)) { 246 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 247 "Invalid parameters"); 248 free(ctx); 249 goto end; 250 } 251 252 vbdev = vbdev_ocf_get_by_name(req.name); 253 if (vbdev == NULL) { 254 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 255 spdk_strerror(ENODEV)); 256 free(ctx); 257 goto end; 258 } 259 260 ctx->core_name = vbdev->core.name; 261 ctx->request = request; 262 ocf_mngt_cache_read_lock(vbdev->ocf_cache, rpc_bdev_ocf_get_stats_cmpl, ctx); 263 264 end: 265 free_rpc_bdev_ocf_get_stats(&req); 266 } 267 SPDK_RPC_REGISTER("bdev_ocf_get_stats", rpc_bdev_ocf_get_stats, SPDK_RPC_RUNTIME) 268 269 /* Structure to hold the parameters for this RPC method. */ 270 struct rpc_bdev_ocf_get_bdevs { 271 char *name; 272 }; 273 274 static void 275 free_rpc_bdev_ocf_get_bdevs(struct rpc_bdev_ocf_get_bdevs *r) 276 { 277 free(r->name); 278 } 279 280 /* Structure to decode the input parameters for this RPC method. */ 281 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_bdevs_decoders[] = { 282 {"name", offsetof(struct rpc_bdev_ocf_get_bdevs, name), spdk_json_decode_string, true}, 283 }; 284 285 struct bdev_get_bdevs_ctx { 286 char *name; 287 struct spdk_json_write_ctx *w; 288 }; 289 290 static void 291 bdev_get_bdevs_fn(struct vbdev_ocf *vbdev, void *ctx) 292 { 293 struct bdev_get_bdevs_ctx *cctx = ctx; 294 struct spdk_json_write_ctx *w = cctx->w; 295 296 if (cctx->name != NULL && 297 strcmp(vbdev->name, cctx->name) && 298 strcmp(vbdev->cache.name, cctx->name) && 299 strcmp(vbdev->core.name, cctx->name)) { 300 return; 301 } 302 303 spdk_json_write_object_begin(w); 304 spdk_json_write_named_string(w, "name", vbdev->name); 305 spdk_json_write_named_bool(w, "started", vbdev->state.started); 306 307 spdk_json_write_named_object_begin(w, "cache"); 308 spdk_json_write_named_string(w, "name", vbdev->cache.name); 309 spdk_json_write_named_bool(w, "attached", vbdev->cache.attached); 310 spdk_json_write_object_end(w); 311 312 spdk_json_write_named_object_begin(w, "core"); 313 spdk_json_write_named_string(w, "name", vbdev->core.name); 314 spdk_json_write_named_bool(w, "attached", vbdev->core.attached); 315 spdk_json_write_object_end(w); 316 317 spdk_json_write_object_end(w); 318 } 319 320 static void 321 rpc_bdev_ocf_get_bdevs(struct spdk_jsonrpc_request *request, 322 const struct spdk_json_val *params) 323 { 324 struct spdk_json_write_ctx *w; 325 struct rpc_bdev_ocf_get_bdevs req = {NULL}; 326 struct bdev_get_bdevs_ctx cctx; 327 328 if (params && spdk_json_decode_object(params, rpc_bdev_ocf_get_bdevs_decoders, 329 SPDK_COUNTOF(rpc_bdev_ocf_get_bdevs_decoders), 330 &req)) { 331 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 332 "Invalid parameters"); 333 goto end; 334 } 335 336 if (req.name) { 337 if (!(vbdev_ocf_get_by_name(req.name) || vbdev_ocf_get_base_by_name(req.name))) { 338 spdk_jsonrpc_send_error_response(request, 339 SPDK_JSONRPC_ERROR_INVALID_PARAMS, 340 spdk_strerror(ENODEV)); 341 goto end; 342 } 343 } 344 345 w = spdk_jsonrpc_begin_result(request); 346 347 cctx.name = req.name; 348 cctx.w = w; 349 350 spdk_json_write_array_begin(w); 351 vbdev_ocf_foreach(bdev_get_bdevs_fn, &cctx); 352 spdk_json_write_array_end(w); 353 spdk_jsonrpc_end_result(request, w); 354 355 end: 356 free_rpc_bdev_ocf_get_bdevs(&req); 357 } 358 SPDK_RPC_REGISTER("bdev_ocf_get_bdevs", rpc_bdev_ocf_get_bdevs, SPDK_RPC_RUNTIME) 359 360 /* Structure to hold the parameters for this RPC method. */ 361 struct rpc_bdev_ocf_set_cache_mode { 362 char *name; /* main vbdev name */ 363 char *mode; /* OCF cache mode to switch to */ 364 }; 365 366 static void 367 free_rpc_bdev_ocf_set_cache_mode(struct rpc_bdev_ocf_set_cache_mode *r) 368 { 369 free(r->name); 370 free(r->mode); 371 } 372 373 /* Structure to decode the input parameters for this RPC method. */ 374 static const struct spdk_json_object_decoder rpc_bdev_ocf_set_cache_mode_decoders[] = { 375 {"name", offsetof(struct rpc_bdev_ocf_set_cache_mode, name), spdk_json_decode_string}, 376 {"mode", offsetof(struct rpc_bdev_ocf_set_cache_mode, mode), spdk_json_decode_string}, 377 }; 378 379 static void 380 cache_mode_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 381 { 382 struct spdk_jsonrpc_request *request = cb_arg; 383 struct spdk_json_write_ctx *w; 384 385 if (status) { 386 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 387 "Could not change OCF vbdev cache mode: %d", 388 status); 389 } else { 390 w = spdk_jsonrpc_begin_result(request); 391 spdk_json_write_string(w, ocf_get_cache_modename( 392 ocf_cache_get_mode(vbdev->ocf_cache))); 393 spdk_jsonrpc_end_result(request, w); 394 } 395 } 396 397 static void 398 rpc_bdev_ocf_set_cache_mode(struct spdk_jsonrpc_request *request, 399 const struct spdk_json_val *params) 400 { 401 struct rpc_bdev_ocf_set_cache_mode req = {NULL}; 402 struct vbdev_ocf *vbdev; 403 int status; 404 405 status = spdk_json_decode_object(params, rpc_bdev_ocf_set_cache_mode_decoders, 406 SPDK_COUNTOF(rpc_bdev_ocf_set_cache_mode_decoders), 407 &req); 408 if (status) { 409 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 410 "Invalid parameters"); 411 goto end; 412 } 413 414 vbdev = vbdev_ocf_get_by_name(req.name); 415 if (vbdev == NULL) { 416 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 417 spdk_strerror(ENODEV)); 418 goto end; 419 } 420 421 vbdev_ocf_set_cache_mode(vbdev, req.mode, cache_mode_cb, request); 422 423 end: 424 free_rpc_bdev_ocf_set_cache_mode(&req); 425 } 426 SPDK_RPC_REGISTER("bdev_ocf_set_cache_mode", rpc_bdev_ocf_set_cache_mode, SPDK_RPC_RUNTIME) 427 428 static void 429 seqcutoff_cb(int status, void *cb_arg) 430 { 431 struct spdk_jsonrpc_request *request = cb_arg; 432 433 if (status) { 434 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 435 "OCF could not set sequential cutoff parameters: %d", status); 436 } else { 437 spdk_jsonrpc_send_bool_response(request, true); 438 } 439 } 440 441 /* Structure to hold the parameters for this RPC method. */ 442 struct rpc_bdev_ocf_set_seqcutoff { 443 char *name; /* main vbdev name */ 444 char *policy; 445 uint32_t threshold; 446 uint32_t promotion_count; 447 }; 448 449 static void 450 free_rpc_bdev_ocf_set_seqcutoff(struct rpc_bdev_ocf_set_seqcutoff *r) 451 { 452 free(r->name); 453 free(r->policy); 454 } 455 456 /* Structure to decode the input parameters for this RPC method. */ 457 static const struct spdk_json_object_decoder rpc_bdev_ocf_set_seqcutoff_decoders[] = { 458 {"name", offsetof(struct rpc_bdev_ocf_set_seqcutoff, name), spdk_json_decode_string}, 459 {"policy", offsetof(struct rpc_bdev_ocf_set_seqcutoff, policy), spdk_json_decode_string}, 460 {"threshold", offsetof(struct rpc_bdev_ocf_set_seqcutoff, threshold), spdk_json_decode_uint32, true}, 461 {"promotion_count", offsetof(struct rpc_bdev_ocf_set_seqcutoff, promotion_count), spdk_json_decode_uint32, true}, 462 }; 463 464 static void 465 rpc_bdev_ocf_set_seqcutoff(struct spdk_jsonrpc_request *request, 466 const struct spdk_json_val *params) 467 { 468 struct rpc_bdev_ocf_set_seqcutoff req = {NULL}; 469 struct vbdev_ocf *vbdev; 470 int ret; 471 472 ret = spdk_json_decode_object(params, rpc_bdev_ocf_set_seqcutoff_decoders, 473 SPDK_COUNTOF(rpc_bdev_ocf_set_seqcutoff_decoders), &req); 474 if (ret) { 475 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 476 "Invalid parameters"); 477 goto end; 478 } 479 480 vbdev = vbdev_ocf_get_by_name(req.name); 481 if (vbdev == NULL) { 482 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 483 spdk_strerror(ENODEV)); 484 goto end; 485 } 486 487 vbdev_ocf_set_seqcutoff(vbdev, req.policy, req.threshold, req.promotion_count, seqcutoff_cb, 488 request); 489 490 end: 491 free_rpc_bdev_ocf_set_seqcutoff(&req); 492 } 493 SPDK_RPC_REGISTER("bdev_ocf_set_seqcutoff", rpc_bdev_ocf_set_seqcutoff, SPDK_RPC_RUNTIME) 494