1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2018 Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "vbdev_ocf.h" 7 #include "stats.h" 8 #include "utils.h" 9 #include "spdk/log.h" 10 #include "spdk/rpc.h" 11 #include "spdk/string.h" 12 13 /* Common structure to hold the name parameter for RPC methods using bdev name only. */ 14 struct rpc_bdev_ocf_name { 15 char *name; /* main vbdev name */ 16 }; 17 18 /* Common free function for RPC methods using bdev name only. */ 19 static void 20 free_rpc_bdev_ocf_name(struct rpc_bdev_ocf_name *r) 21 { 22 free(r->name); 23 } 24 25 /* Common function to decode the name input parameter for RPC methods using bdev name only. */ 26 static const struct spdk_json_object_decoder rpc_bdev_ocf_name_decoders[] = { 27 {"name", offsetof(struct rpc_bdev_ocf_name, name), spdk_json_decode_string}, 28 }; 29 30 31 /* Structure to hold the parameters for this RPC method. */ 32 struct rpc_bdev_ocf_create { 33 char *name; /* main vbdev */ 34 char *mode; /* OCF mode (choose one) */ 35 uint64_t cache_line_size; /* OCF cache line size */ 36 char *cache_bdev_name; /* sub bdev */ 37 char *core_bdev_name; /* sub bdev */ 38 }; 39 40 static void 41 free_rpc_bdev_ocf_create(struct rpc_bdev_ocf_create *r) 42 { 43 free(r->name); 44 free(r->core_bdev_name); 45 free(r->cache_bdev_name); 46 free(r->mode); 47 } 48 49 /* Structure to decode the input parameters for this RPC method. */ 50 static const struct spdk_json_object_decoder rpc_bdev_ocf_create_decoders[] = { 51 {"name", offsetof(struct rpc_bdev_ocf_create, name), spdk_json_decode_string}, 52 {"mode", offsetof(struct rpc_bdev_ocf_create, mode), spdk_json_decode_string}, 53 {"cache_line_size", offsetof(struct rpc_bdev_ocf_create, cache_line_size), spdk_json_decode_uint64, true}, 54 {"cache_bdev_name", offsetof(struct rpc_bdev_ocf_create, cache_bdev_name), spdk_json_decode_string}, 55 {"core_bdev_name", offsetof(struct rpc_bdev_ocf_create, core_bdev_name), spdk_json_decode_string}, 56 }; 57 58 static void 59 construct_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 60 { 61 struct spdk_jsonrpc_request *request = cb_arg; 62 struct spdk_json_write_ctx *w; 63 64 if (status) { 65 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 66 "Could not create OCF vbdev: %d", 67 status); 68 } else { 69 w = spdk_jsonrpc_begin_result(request); 70 spdk_json_write_string(w, vbdev->name); 71 spdk_jsonrpc_end_result(request, w); 72 } 73 } 74 75 static void 76 rpc_bdev_ocf_create(struct spdk_jsonrpc_request *request, 77 const struct spdk_json_val *params) 78 { 79 struct rpc_bdev_ocf_create req = {NULL}; 80 int ret; 81 82 ret = spdk_json_decode_object(params, rpc_bdev_ocf_create_decoders, 83 SPDK_COUNTOF(rpc_bdev_ocf_create_decoders), 84 &req); 85 if (ret) { 86 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 87 "Invalid parameters"); 88 free_rpc_bdev_ocf_create(&req); 89 return; 90 } 91 92 vbdev_ocf_construct(req.name, req.mode, req.cache_line_size, req.cache_bdev_name, 93 req.core_bdev_name, false, construct_cb, request); 94 free_rpc_bdev_ocf_create(&req); 95 } 96 SPDK_RPC_REGISTER("bdev_ocf_create", rpc_bdev_ocf_create, SPDK_RPC_RUNTIME) 97 98 static void 99 delete_cb(void *cb_arg, int status) 100 { 101 struct spdk_jsonrpc_request *request = cb_arg; 102 103 if (status) { 104 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 105 "Could not delete OCF vbdev: %d", 106 status); 107 } else { 108 spdk_jsonrpc_send_bool_response(request, true); 109 } 110 } 111 112 static void 113 rpc_bdev_ocf_delete(struct spdk_jsonrpc_request *request, 114 const struct spdk_json_val *params) 115 { 116 struct rpc_bdev_ocf_name req = {NULL}; 117 struct vbdev_ocf *vbdev; 118 int status; 119 120 status = spdk_json_decode_object(params, rpc_bdev_ocf_name_decoders, 121 SPDK_COUNTOF(rpc_bdev_ocf_name_decoders), 122 &req); 123 if (status) { 124 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 125 "Invalid parameters"); 126 goto end; 127 } 128 129 vbdev = vbdev_ocf_get_by_name(req.name); 130 if (vbdev == NULL) { 131 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 132 spdk_strerror(ENODEV)); 133 goto end; 134 } 135 136 status = vbdev_ocf_delete_clean(vbdev, delete_cb, request); 137 if (status) { 138 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 139 "Could not delete OCF vbdev: %s", 140 spdk_strerror(-status)); 141 goto end; 142 } 143 144 end: 145 free_rpc_bdev_ocf_name(&req); 146 } 147 SPDK_RPC_REGISTER("bdev_ocf_delete", rpc_bdev_ocf_delete, SPDK_RPC_RUNTIME) 148 149 struct get_ocf_stats_ctx { 150 struct spdk_jsonrpc_request *request; 151 char *core_name; 152 }; 153 154 static void 155 rpc_bdev_ocf_get_stats_cmpl(ocf_cache_t cache, void *priv, int error) 156 { 157 struct get_ocf_stats_ctx *ctx = (struct get_ocf_stats_ctx *) priv; 158 struct spdk_json_write_ctx *w; 159 struct vbdev_ocf_stats stats; 160 161 if (error) { 162 goto end; 163 } 164 165 error = vbdev_ocf_stats_get(cache, ctx->core_name, &stats); 166 167 ocf_mngt_cache_read_unlock(cache); 168 169 if (error) { 170 goto end; 171 } 172 173 w = spdk_jsonrpc_begin_result(ctx->request); 174 vbdev_ocf_stats_write_json(w, &stats); 175 spdk_jsonrpc_end_result(ctx->request, w); 176 177 end: 178 if (error) { 179 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 180 "Could not get stats: %s", 181 spdk_strerror(-error)); 182 } 183 free(ctx); 184 } 185 186 static void 187 rpc_bdev_ocf_get_stats(struct spdk_jsonrpc_request *request, 188 const struct spdk_json_val *params) 189 { 190 struct rpc_bdev_ocf_name req = {NULL}; 191 struct vbdev_ocf *vbdev; 192 struct get_ocf_stats_ctx *ctx; 193 194 ctx = calloc(1, sizeof(*ctx)); 195 if (!ctx) { 196 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 197 "Not enough memory to process request"); 198 goto end; 199 } 200 201 if (spdk_json_decode_object(params, rpc_bdev_ocf_name_decoders, 202 SPDK_COUNTOF(rpc_bdev_ocf_name_decoders), 203 &req)) { 204 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 205 "Invalid parameters"); 206 free(ctx); 207 goto end; 208 } 209 210 vbdev = vbdev_ocf_get_by_name(req.name); 211 if (vbdev == NULL) { 212 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 213 spdk_strerror(ENODEV)); 214 free(ctx); 215 goto end; 216 } 217 218 ctx->core_name = vbdev->core.name; 219 ctx->request = request; 220 ocf_mngt_cache_read_lock(vbdev->ocf_cache, rpc_bdev_ocf_get_stats_cmpl, ctx); 221 222 end: 223 free_rpc_bdev_ocf_name(&req); 224 } 225 SPDK_RPC_REGISTER("bdev_ocf_get_stats", rpc_bdev_ocf_get_stats, SPDK_RPC_RUNTIME) 226 227 /* Structure to decode the input parameters for this RPC method. */ 228 static const struct spdk_json_object_decoder rpc_bdev_ocf_get_bdevs_decoders[] = { 229 {"name", offsetof(struct rpc_bdev_ocf_name, name), spdk_json_decode_string, true}, 230 }; 231 232 struct bdev_get_bdevs_ctx { 233 char *name; 234 struct spdk_json_write_ctx *w; 235 }; 236 237 static void 238 bdev_get_bdevs_fn(struct vbdev_ocf *vbdev, void *ctx) 239 { 240 struct bdev_get_bdevs_ctx *cctx = ctx; 241 struct spdk_json_write_ctx *w = cctx->w; 242 243 if (cctx->name != NULL && 244 strcmp(vbdev->name, cctx->name) && 245 strcmp(vbdev->cache.name, cctx->name) && 246 strcmp(vbdev->core.name, cctx->name)) { 247 return; 248 } 249 250 spdk_json_write_object_begin(w); 251 spdk_json_write_named_string(w, "name", vbdev->name); 252 spdk_json_write_named_bool(w, "started", vbdev->state.started); 253 254 spdk_json_write_named_object_begin(w, "cache"); 255 spdk_json_write_named_string(w, "name", vbdev->cache.name); 256 spdk_json_write_named_bool(w, "attached", vbdev->cache.attached); 257 spdk_json_write_object_end(w); 258 259 spdk_json_write_named_object_begin(w, "core"); 260 spdk_json_write_named_string(w, "name", vbdev->core.name); 261 spdk_json_write_named_bool(w, "attached", vbdev->core.attached); 262 spdk_json_write_object_end(w); 263 264 spdk_json_write_object_end(w); 265 } 266 267 static void 268 rpc_bdev_ocf_get_bdevs(struct spdk_jsonrpc_request *request, 269 const struct spdk_json_val *params) 270 { 271 struct spdk_json_write_ctx *w; 272 struct rpc_bdev_ocf_name req = {NULL}; 273 struct bdev_get_bdevs_ctx cctx; 274 275 if (params && spdk_json_decode_object(params, rpc_bdev_ocf_get_bdevs_decoders, 276 SPDK_COUNTOF(rpc_bdev_ocf_get_bdevs_decoders), 277 &req)) { 278 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 279 "Invalid parameters"); 280 goto end; 281 } 282 283 if (req.name) { 284 if (!(vbdev_ocf_get_by_name(req.name) || vbdev_ocf_get_base_by_name(req.name))) { 285 spdk_jsonrpc_send_error_response(request, 286 SPDK_JSONRPC_ERROR_INVALID_PARAMS, 287 spdk_strerror(ENODEV)); 288 goto end; 289 } 290 } 291 292 w = spdk_jsonrpc_begin_result(request); 293 294 cctx.name = req.name; 295 cctx.w = w; 296 297 spdk_json_write_array_begin(w); 298 vbdev_ocf_foreach(bdev_get_bdevs_fn, &cctx); 299 spdk_json_write_array_end(w); 300 spdk_jsonrpc_end_result(request, w); 301 302 end: 303 free_rpc_bdev_ocf_name(&req); 304 } 305 SPDK_RPC_REGISTER("bdev_ocf_get_bdevs", rpc_bdev_ocf_get_bdevs, SPDK_RPC_RUNTIME) 306 307 /* Structure to hold the parameters for this RPC method. */ 308 struct rpc_bdev_ocf_set_cache_mode { 309 char *name; /* main vbdev name */ 310 char *mode; /* OCF cache mode to switch to */ 311 }; 312 313 static void 314 free_rpc_bdev_ocf_set_cache_mode(struct rpc_bdev_ocf_set_cache_mode *r) 315 { 316 free(r->name); 317 free(r->mode); 318 } 319 320 /* Structure to decode the input parameters for this RPC method. */ 321 static const struct spdk_json_object_decoder rpc_bdev_ocf_set_cache_mode_decoders[] = { 322 {"name", offsetof(struct rpc_bdev_ocf_set_cache_mode, name), spdk_json_decode_string}, 323 {"mode", offsetof(struct rpc_bdev_ocf_set_cache_mode, mode), spdk_json_decode_string}, 324 }; 325 326 static void 327 cache_mode_cb(int status, struct vbdev_ocf *vbdev, void *cb_arg) 328 { 329 struct spdk_jsonrpc_request *request = cb_arg; 330 struct spdk_json_write_ctx *w; 331 332 if (status) { 333 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 334 "Could not change OCF vbdev cache mode: %d", 335 status); 336 } else { 337 w = spdk_jsonrpc_begin_result(request); 338 spdk_json_write_string(w, ocf_get_cache_modename( 339 ocf_cache_get_mode(vbdev->ocf_cache))); 340 spdk_jsonrpc_end_result(request, w); 341 } 342 } 343 344 static void 345 rpc_bdev_ocf_set_cache_mode(struct spdk_jsonrpc_request *request, 346 const struct spdk_json_val *params) 347 { 348 struct rpc_bdev_ocf_set_cache_mode req = {NULL}; 349 struct vbdev_ocf *vbdev; 350 int status; 351 352 status = spdk_json_decode_object(params, rpc_bdev_ocf_set_cache_mode_decoders, 353 SPDK_COUNTOF(rpc_bdev_ocf_set_cache_mode_decoders), 354 &req); 355 if (status) { 356 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 357 "Invalid parameters"); 358 goto end; 359 } 360 361 vbdev = vbdev_ocf_get_by_name(req.name); 362 if (vbdev == NULL) { 363 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 364 spdk_strerror(ENODEV)); 365 goto end; 366 } 367 368 vbdev_ocf_set_cache_mode(vbdev, req.mode, cache_mode_cb, request); 369 370 end: 371 free_rpc_bdev_ocf_set_cache_mode(&req); 372 } 373 SPDK_RPC_REGISTER("bdev_ocf_set_cache_mode", rpc_bdev_ocf_set_cache_mode, SPDK_RPC_RUNTIME) 374 375 static void 376 seqcutoff_cb(int status, void *cb_arg) 377 { 378 struct spdk_jsonrpc_request *request = cb_arg; 379 380 if (status) { 381 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 382 "OCF could not set sequential cutoff parameters: %d", status); 383 } else { 384 spdk_jsonrpc_send_bool_response(request, true); 385 } 386 } 387 388 /* Structure to hold the parameters for this RPC method. */ 389 struct rpc_bdev_ocf_set_seqcutoff { 390 char *name; /* main vbdev name */ 391 char *policy; 392 uint32_t threshold; 393 uint32_t promotion_count; 394 }; 395 396 static void 397 free_rpc_bdev_ocf_set_seqcutoff(struct rpc_bdev_ocf_set_seqcutoff *r) 398 { 399 free(r->name); 400 free(r->policy); 401 } 402 403 /* Structure to decode the input parameters for this RPC method. */ 404 static const struct spdk_json_object_decoder rpc_bdev_ocf_set_seqcutoff_decoders[] = { 405 {"name", offsetof(struct rpc_bdev_ocf_set_seqcutoff, name), spdk_json_decode_string}, 406 {"policy", offsetof(struct rpc_bdev_ocf_set_seqcutoff, policy), spdk_json_decode_string}, 407 {"threshold", offsetof(struct rpc_bdev_ocf_set_seqcutoff, threshold), spdk_json_decode_uint32, true}, 408 {"promotion_count", offsetof(struct rpc_bdev_ocf_set_seqcutoff, promotion_count), spdk_json_decode_uint32, true}, 409 }; 410 411 static void 412 rpc_bdev_ocf_set_seqcutoff(struct spdk_jsonrpc_request *request, 413 const struct spdk_json_val *params) 414 { 415 struct rpc_bdev_ocf_set_seqcutoff req = {NULL}; 416 struct vbdev_ocf *vbdev; 417 int ret; 418 419 ret = spdk_json_decode_object(params, rpc_bdev_ocf_set_seqcutoff_decoders, 420 SPDK_COUNTOF(rpc_bdev_ocf_set_seqcutoff_decoders), &req); 421 if (ret) { 422 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 423 "Invalid parameters"); 424 goto end; 425 } 426 427 vbdev = vbdev_ocf_get_by_name(req.name); 428 if (vbdev == NULL) { 429 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 430 spdk_strerror(ENODEV)); 431 goto end; 432 } 433 434 vbdev_ocf_set_seqcutoff(vbdev, req.policy, req.threshold, req.promotion_count, seqcutoff_cb, 435 request); 436 437 end: 438 free_rpc_bdev_ocf_set_seqcutoff(&req); 439 } 440 SPDK_RPC_REGISTER("bdev_ocf_set_seqcutoff", rpc_bdev_ocf_set_seqcutoff, SPDK_RPC_RUNTIME) 441 442 struct get_ocf_flush_start_ctx { 443 struct spdk_jsonrpc_request *request; 444 struct vbdev_ocf *vbdev; 445 }; 446 447 static void 448 rpc_bdev_ocf_flush_start_cmpl(ocf_cache_t cache, void *priv, int error) 449 { 450 struct get_ocf_flush_start_ctx *ctx = priv; 451 452 ctx->vbdev->flush.in_progress = false; 453 ctx->vbdev->flush.status = error; 454 455 ocf_mngt_cache_read_unlock(cache); 456 457 free(ctx); 458 } 459 460 static void 461 rpc_bdev_ocf_flush_start_lock_cmpl(ocf_cache_t cache, void *priv, int error) 462 { 463 struct get_ocf_flush_start_ctx *ctx = priv; 464 465 if (error) { 466 spdk_jsonrpc_send_error_response_fmt(ctx->request, 467 SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 468 "Could not lock cache: %d", error); 469 free(ctx); 470 return; 471 } 472 473 ctx->vbdev->flush.in_progress = true; 474 ocf_mngt_cache_flush(cache, rpc_bdev_ocf_flush_start_cmpl, ctx); 475 476 spdk_jsonrpc_send_bool_response(ctx->request, true); 477 } 478 479 static void 480 rpc_bdev_ocf_flush_start(struct spdk_jsonrpc_request *request, 481 const struct spdk_json_val *params) 482 { 483 struct rpc_bdev_ocf_name req = {NULL}; 484 struct get_ocf_flush_start_ctx *ctx; 485 int status; 486 487 ctx = calloc(1, sizeof(*ctx)); 488 if (!ctx) { 489 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 490 "Not enough memory to process request"); 491 goto end; 492 } 493 494 status = spdk_json_decode_object(params, rpc_bdev_ocf_name_decoders, 495 SPDK_COUNTOF(rpc_bdev_ocf_name_decoders), 496 &req); 497 if (status) { 498 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 499 "Invalid parameters"); 500 free(ctx); 501 goto end; 502 } 503 504 ctx->vbdev = vbdev_ocf_get_by_name(req.name); 505 if (ctx->vbdev == NULL) { 506 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 507 spdk_strerror(ENODEV)); 508 free(ctx); 509 goto end; 510 } 511 512 if (!ctx->vbdev->ocf_cache) { 513 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 514 "Couldn't flush cache: device not attached"); 515 free(ctx); 516 goto end; 517 } 518 519 ctx->request = request; 520 ocf_mngt_cache_read_lock(ctx->vbdev->ocf_cache, rpc_bdev_ocf_flush_start_lock_cmpl, ctx); 521 522 end: 523 free_rpc_bdev_ocf_name(&req); 524 } 525 SPDK_RPC_REGISTER("bdev_ocf_flush_start", rpc_bdev_ocf_flush_start, SPDK_RPC_RUNTIME) 526 527 static void 528 rpc_bdev_ocf_flush_status(struct spdk_jsonrpc_request *request, 529 const struct spdk_json_val *params) 530 { 531 struct rpc_bdev_ocf_name req = {NULL}; 532 struct spdk_json_write_ctx *w; 533 struct vbdev_ocf *vbdev; 534 int status; 535 536 status = spdk_json_decode_object(params, rpc_bdev_ocf_name_decoders, 537 SPDK_COUNTOF(rpc_bdev_ocf_name_decoders), 538 &req); 539 if (status) { 540 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 541 "Invalid parameters"); 542 goto end; 543 } 544 545 vbdev = vbdev_ocf_get_by_name(req.name); 546 if (vbdev == NULL) { 547 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 548 spdk_strerror(ENODEV)); 549 goto end; 550 } 551 552 w = spdk_jsonrpc_begin_result(request); 553 554 spdk_json_write_object_begin(w); 555 spdk_json_write_named_bool(w, "in_progress", vbdev->flush.in_progress); 556 if (!vbdev->flush.in_progress) { 557 spdk_json_write_named_int32(w, "status", vbdev->flush.status); 558 } 559 spdk_json_write_object_end(w); 560 561 spdk_jsonrpc_end_result(request, w); 562 563 end: 564 free_rpc_bdev_ocf_name(&req); 565 } 566 SPDK_RPC_REGISTER("bdev_ocf_flush_status", rpc_bdev_ocf_flush_status, SPDK_RPC_RUNTIME) 567