1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2019-2021 Mellanox Technologies LTD. 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 "spdk/stdinc.h" 35 36 #include "bdev_nvme.h" 37 38 #include "spdk/config.h" 39 40 #include "spdk/string.h" 41 #include "spdk/rpc.h" 42 #include "spdk/util.h" 43 #include "spdk/env.h" 44 #include "spdk/nvme.h" 45 #include "spdk/nvme_spec.h" 46 47 #include "spdk/log.h" 48 #include "spdk/bdev_module.h" 49 50 struct open_descriptors { 51 void *desc; 52 struct spdk_bdev *bdev; 53 TAILQ_ENTRY(open_descriptors) tqlst; 54 struct spdk_thread *thread; 55 }; 56 typedef TAILQ_HEAD(, open_descriptors) open_descriptors_t; 57 58 static int 59 rpc_decode_action_on_timeout(const struct spdk_json_val *val, void *out) 60 { 61 enum spdk_bdev_timeout_action *action = out; 62 63 if (spdk_json_strequal(val, "none") == true) { 64 *action = SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE; 65 } else if (spdk_json_strequal(val, "abort") == true) { 66 *action = SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT; 67 } else if (spdk_json_strequal(val, "reset") == true) { 68 *action = SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET; 69 } else { 70 SPDK_NOTICELOG("Invalid parameter value: action_on_timeout\n"); 71 return -EINVAL; 72 } 73 74 return 0; 75 } 76 77 static const struct spdk_json_object_decoder rpc_bdev_nvme_options_decoders[] = { 78 {"action_on_timeout", offsetof(struct spdk_bdev_nvme_opts, action_on_timeout), rpc_decode_action_on_timeout, true}, 79 {"timeout_us", offsetof(struct spdk_bdev_nvme_opts, timeout_us), spdk_json_decode_uint64, true}, 80 {"timeout_admin_us", offsetof(struct spdk_bdev_nvme_opts, timeout_admin_us), spdk_json_decode_uint64, true}, 81 {"keep_alive_timeout_ms", offsetof(struct spdk_bdev_nvme_opts, keep_alive_timeout_ms), spdk_json_decode_uint32, true}, 82 {"retry_count", offsetof(struct spdk_bdev_nvme_opts, retry_count), spdk_json_decode_uint32, true}, 83 {"arbitration_burst", offsetof(struct spdk_bdev_nvme_opts, arbitration_burst), spdk_json_decode_uint32, true}, 84 {"low_priority_weight", offsetof(struct spdk_bdev_nvme_opts, low_priority_weight), spdk_json_decode_uint32, true}, 85 {"medium_priority_weight", offsetof(struct spdk_bdev_nvme_opts, medium_priority_weight), spdk_json_decode_uint32, true}, 86 {"high_priority_weight", offsetof(struct spdk_bdev_nvme_opts, high_priority_weight), spdk_json_decode_uint32, true}, 87 {"nvme_adminq_poll_period_us", offsetof(struct spdk_bdev_nvme_opts, nvme_adminq_poll_period_us), spdk_json_decode_uint64, true}, 88 {"nvme_ioq_poll_period_us", offsetof(struct spdk_bdev_nvme_opts, nvme_ioq_poll_period_us), spdk_json_decode_uint64, true}, 89 {"io_queue_requests", offsetof(struct spdk_bdev_nvme_opts, io_queue_requests), spdk_json_decode_uint32, true}, 90 {"delay_cmd_submit", offsetof(struct spdk_bdev_nvme_opts, delay_cmd_submit), spdk_json_decode_bool, true}, 91 }; 92 93 static void 94 rpc_bdev_nvme_set_options(struct spdk_jsonrpc_request *request, 95 const struct spdk_json_val *params) 96 { 97 struct spdk_bdev_nvme_opts opts; 98 int rc; 99 100 bdev_nvme_get_opts(&opts); 101 if (params && spdk_json_decode_object(params, rpc_bdev_nvme_options_decoders, 102 SPDK_COUNTOF(rpc_bdev_nvme_options_decoders), 103 &opts)) { 104 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 105 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 106 "spdk_json_decode_object failed"); 107 return; 108 } 109 110 rc = bdev_nvme_set_opts(&opts); 111 if (rc) { 112 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 113 return; 114 } 115 116 spdk_jsonrpc_send_bool_response(request, true); 117 118 return; 119 } 120 SPDK_RPC_REGISTER("bdev_nvme_set_options", rpc_bdev_nvme_set_options, 121 SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME) 122 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_set_options, set_bdev_nvme_options) 123 124 struct rpc_bdev_nvme_hotplug { 125 bool enabled; 126 uint64_t period_us; 127 }; 128 129 static const struct spdk_json_object_decoder rpc_bdev_nvme_hotplug_decoders[] = { 130 {"enable", offsetof(struct rpc_bdev_nvme_hotplug, enabled), spdk_json_decode_bool, false}, 131 {"period_us", offsetof(struct rpc_bdev_nvme_hotplug, period_us), spdk_json_decode_uint64, true}, 132 }; 133 134 static void 135 rpc_bdev_nvme_set_hotplug_done(void *ctx) 136 { 137 struct spdk_jsonrpc_request *request = ctx; 138 139 spdk_jsonrpc_send_bool_response(request, true); 140 } 141 142 static void 143 rpc_bdev_nvme_set_hotplug(struct spdk_jsonrpc_request *request, 144 const struct spdk_json_val *params) 145 { 146 struct rpc_bdev_nvme_hotplug req = {false, 0}; 147 int rc; 148 149 if (spdk_json_decode_object(params, rpc_bdev_nvme_hotplug_decoders, 150 SPDK_COUNTOF(rpc_bdev_nvme_hotplug_decoders), &req)) { 151 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 152 rc = -EINVAL; 153 goto invalid; 154 } 155 156 rc = bdev_nvme_set_hotplug(req.enabled, req.period_us, rpc_bdev_nvme_set_hotplug_done, 157 request); 158 if (rc) { 159 goto invalid; 160 } 161 162 return; 163 invalid: 164 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc)); 165 } 166 SPDK_RPC_REGISTER("bdev_nvme_set_hotplug", rpc_bdev_nvme_set_hotplug, SPDK_RPC_RUNTIME) 167 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_set_hotplug, set_bdev_nvme_hotplug) 168 169 struct rpc_bdev_nvme_attach_controller { 170 char *name; 171 char *trtype; 172 char *adrfam; 173 char *traddr; 174 char *trsvcid; 175 char *priority; 176 char *subnqn; 177 char *hostnqn; 178 char *hostaddr; 179 char *hostsvcid; 180 bool prchk_reftag; 181 bool prchk_guard; 182 uint64_t fabrics_connect_timeout_us; 183 struct spdk_nvme_ctrlr_opts opts; 184 }; 185 186 static void 187 free_rpc_bdev_nvme_attach_controller(struct rpc_bdev_nvme_attach_controller *req) 188 { 189 free(req->name); 190 free(req->trtype); 191 free(req->adrfam); 192 free(req->traddr); 193 free(req->trsvcid); 194 free(req->priority); 195 free(req->subnqn); 196 free(req->hostnqn); 197 free(req->hostaddr); 198 free(req->hostsvcid); 199 } 200 201 static const struct spdk_json_object_decoder rpc_bdev_nvme_attach_controller_decoders[] = { 202 {"name", offsetof(struct rpc_bdev_nvme_attach_controller, name), spdk_json_decode_string}, 203 {"trtype", offsetof(struct rpc_bdev_nvme_attach_controller, trtype), spdk_json_decode_string}, 204 {"traddr", offsetof(struct rpc_bdev_nvme_attach_controller, traddr), spdk_json_decode_string}, 205 206 {"adrfam", offsetof(struct rpc_bdev_nvme_attach_controller, adrfam), spdk_json_decode_string, true}, 207 {"trsvcid", offsetof(struct rpc_bdev_nvme_attach_controller, trsvcid), spdk_json_decode_string, true}, 208 {"priority", offsetof(struct rpc_bdev_nvme_attach_controller, priority), spdk_json_decode_string, true}, 209 {"subnqn", offsetof(struct rpc_bdev_nvme_attach_controller, subnqn), spdk_json_decode_string, true}, 210 {"hostnqn", offsetof(struct rpc_bdev_nvme_attach_controller, hostnqn), spdk_json_decode_string, true}, 211 {"hostaddr", offsetof(struct rpc_bdev_nvme_attach_controller, hostaddr), spdk_json_decode_string, true}, 212 {"hostsvcid", offsetof(struct rpc_bdev_nvme_attach_controller, hostsvcid), spdk_json_decode_string, true}, 213 214 {"prchk_reftag", offsetof(struct rpc_bdev_nvme_attach_controller, prchk_reftag), spdk_json_decode_bool, true}, 215 {"prchk_guard", offsetof(struct rpc_bdev_nvme_attach_controller, prchk_guard), spdk_json_decode_bool, true}, 216 {"hdgst", offsetof(struct rpc_bdev_nvme_attach_controller, opts.header_digest), spdk_json_decode_bool, true}, 217 {"ddgst", offsetof(struct rpc_bdev_nvme_attach_controller, opts.data_digest), spdk_json_decode_bool, true}, 218 {"fabrics_connect_timeout_us", offsetof(struct rpc_bdev_nvme_attach_controller, opts.fabrics_connect_timeout_us), spdk_json_decode_uint64, true}, 219 }; 220 221 #define NVME_MAX_BDEVS_PER_RPC 128 222 223 struct rpc_bdev_nvme_attach_controller_ctx { 224 struct rpc_bdev_nvme_attach_controller req; 225 uint32_t count; 226 size_t bdev_count; 227 const char *names[NVME_MAX_BDEVS_PER_RPC]; 228 struct spdk_jsonrpc_request *request; 229 }; 230 231 static void 232 rpc_bdev_nvme_attach_controller_examined(void *cb_ctx) 233 { 234 struct rpc_bdev_nvme_attach_controller_ctx *ctx = cb_ctx; 235 struct spdk_jsonrpc_request *request = ctx->request; 236 struct spdk_json_write_ctx *w; 237 size_t i; 238 239 w = spdk_jsonrpc_begin_result(request); 240 spdk_json_write_array_begin(w); 241 for (i = 0; i < ctx->bdev_count; i++) { 242 spdk_json_write_string(w, ctx->names[i]); 243 } 244 spdk_json_write_array_end(w); 245 spdk_jsonrpc_end_result(request, w); 246 247 free_rpc_bdev_nvme_attach_controller(&ctx->req); 248 free(ctx); 249 } 250 251 static void 252 rpc_bdev_nvme_attach_controller_done(void *cb_ctx, size_t bdev_count, int rc) 253 { 254 struct rpc_bdev_nvme_attach_controller_ctx *ctx = cb_ctx; 255 struct spdk_jsonrpc_request *request = ctx->request; 256 257 if (rc < 0) { 258 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 259 free_rpc_bdev_nvme_attach_controller(&ctx->req); 260 free(ctx); 261 return; 262 } 263 264 ctx->bdev_count = bdev_count; 265 spdk_bdev_wait_for_examine(rpc_bdev_nvme_attach_controller_examined, ctx); 266 } 267 268 static void 269 rpc_bdev_nvme_attach_controller(struct spdk_jsonrpc_request *request, 270 const struct spdk_json_val *params) 271 { 272 struct rpc_bdev_nvme_attach_controller_ctx *ctx; 273 struct spdk_nvme_transport_id trid = {}; 274 const struct spdk_nvme_ctrlr_opts *opts; 275 uint32_t prchk_flags = 0; 276 struct nvme_ctrlr *ctrlr = NULL; 277 size_t len, maxlen; 278 int rc; 279 280 ctx = calloc(1, sizeof(*ctx)); 281 if (!ctx) { 282 spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM)); 283 return; 284 } 285 286 spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctx->req.opts, sizeof(ctx->req.opts)); 287 288 if (spdk_json_decode_object(params, rpc_bdev_nvme_attach_controller_decoders, 289 SPDK_COUNTOF(rpc_bdev_nvme_attach_controller_decoders), 290 &ctx->req)) { 291 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 292 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 293 "spdk_json_decode_object failed"); 294 goto cleanup; 295 } 296 297 /* Parse trstring */ 298 rc = spdk_nvme_transport_id_populate_trstring(&trid, ctx->req.trtype); 299 if (rc < 0) { 300 SPDK_ERRLOG("Failed to parse trtype: %s\n", ctx->req.trtype); 301 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s", 302 ctx->req.trtype); 303 goto cleanup; 304 } 305 306 /* Parse trtype */ 307 rc = spdk_nvme_transport_id_parse_trtype(&trid.trtype, ctx->req.trtype); 308 assert(rc == 0); 309 310 /* Parse traddr */ 311 maxlen = sizeof(trid.traddr); 312 len = strnlen(ctx->req.traddr, maxlen); 313 if (len == maxlen) { 314 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "traddr too long: %s", 315 ctx->req.traddr); 316 goto cleanup; 317 } 318 memcpy(trid.traddr, ctx->req.traddr, len + 1); 319 320 /* Parse adrfam */ 321 if (ctx->req.adrfam) { 322 rc = spdk_nvme_transport_id_parse_adrfam(&trid.adrfam, ctx->req.adrfam); 323 if (rc < 0) { 324 SPDK_ERRLOG("Failed to parse adrfam: %s\n", ctx->req.adrfam); 325 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse adrfam: %s", 326 ctx->req.adrfam); 327 goto cleanup; 328 } 329 } 330 331 /* Parse trsvcid */ 332 if (ctx->req.trsvcid) { 333 maxlen = sizeof(trid.trsvcid); 334 len = strnlen(ctx->req.trsvcid, maxlen); 335 if (len == maxlen) { 336 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "trsvcid too long: %s", 337 ctx->req.trsvcid); 338 goto cleanup; 339 } 340 memcpy(trid.trsvcid, ctx->req.trsvcid, len + 1); 341 } 342 343 /* Parse priority for the NVMe-oF transport connection */ 344 if (ctx->req.priority) { 345 trid.priority = spdk_strtol(ctx->req.priority, 10); 346 } 347 348 /* Parse subnqn */ 349 if (ctx->req.subnqn) { 350 maxlen = sizeof(trid.subnqn); 351 len = strnlen(ctx->req.subnqn, maxlen); 352 if (len == maxlen) { 353 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "subnqn too long: %s", 354 ctx->req.subnqn); 355 goto cleanup; 356 } 357 memcpy(trid.subnqn, ctx->req.subnqn, len + 1); 358 } 359 360 if (ctx->req.hostnqn) { 361 snprintf(ctx->req.opts.hostnqn, sizeof(ctx->req.opts.hostnqn), "%s", 362 ctx->req.hostnqn); 363 } 364 365 if (ctx->req.hostaddr) { 366 maxlen = sizeof(ctx->req.opts.src_addr); 367 len = strnlen(ctx->req.hostaddr, maxlen); 368 if (len == maxlen) { 369 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "hostaddr too long: %s", 370 ctx->req.hostaddr); 371 goto cleanup; 372 } 373 snprintf(ctx->req.opts.src_addr, maxlen, "%s", ctx->req.hostaddr); 374 } 375 376 if (ctx->req.hostsvcid) { 377 maxlen = sizeof(ctx->req.opts.src_svcid); 378 len = strnlen(ctx->req.hostsvcid, maxlen); 379 if (len == maxlen) { 380 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "hostsvcid too long: %s", 381 ctx->req.hostsvcid); 382 goto cleanup; 383 } 384 snprintf(ctx->req.opts.src_svcid, maxlen, "%s", ctx->req.hostsvcid); 385 } 386 387 ctrlr = nvme_ctrlr_get_by_name(ctx->req.name); 388 389 if (ctrlr) { 390 /* This controller already exists. Verify the parameters match sufficiently. */ 391 opts = spdk_nvme_ctrlr_get_opts(ctrlr->ctrlr); 392 393 if (strncmp(trid.subnqn, 394 spdk_nvme_ctrlr_get_transport_id(ctrlr->ctrlr)->subnqn, 395 SPDK_NVMF_NQN_MAX_LEN) != 0) { 396 /* Different SUBNQN is not allowed when specifying the same controller name. */ 397 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, 398 "A controller named %s already exists, but uses a different subnqn (%s)\n", 399 ctx->req.name, spdk_nvme_ctrlr_get_transport_id(ctrlr->ctrlr)->subnqn); 400 goto cleanup; 401 } 402 403 if (strncmp(ctx->req.opts.hostnqn, opts->hostnqn, SPDK_NVMF_NQN_MAX_LEN) != 0) { 404 /* Different HOSTNQN is not allowed when specifying the same controller name. */ 405 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, 406 "A controller named %s already exists, but uses a different hostnqn (%s)\n", 407 ctx->req.name, opts->hostnqn); 408 goto cleanup; 409 } 410 411 if (ctx->req.prchk_guard || ctx->req.prchk_reftag) { 412 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, 413 "A controller named %s already exists. To add a path, do not specify PI options.\n", 414 ctx->req.name); 415 goto cleanup; 416 } 417 } 418 419 if (ctx->req.prchk_reftag) { 420 prchk_flags |= SPDK_NVME_IO_FLAGS_PRCHK_REFTAG; 421 } 422 423 if (ctx->req.prchk_guard) { 424 prchk_flags |= SPDK_NVME_IO_FLAGS_PRCHK_GUARD; 425 } 426 427 ctx->request = request; 428 ctx->count = NVME_MAX_BDEVS_PER_RPC; 429 rc = bdev_nvme_create(&trid, ctx->req.name, ctx->names, ctx->count, prchk_flags, 430 rpc_bdev_nvme_attach_controller_done, ctx, &ctx->req.opts, 431 false); 432 if (rc) { 433 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 434 goto cleanup; 435 } 436 437 return; 438 439 cleanup: 440 free_rpc_bdev_nvme_attach_controller(&ctx->req); 441 free(ctx); 442 } 443 SPDK_RPC_REGISTER("bdev_nvme_attach_controller", rpc_bdev_nvme_attach_controller, 444 SPDK_RPC_RUNTIME) 445 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_attach_controller, construct_nvme_bdev) 446 447 static void 448 rpc_dump_nvme_controller_info(struct nvme_ctrlr *nvme_ctrlr, void *ctx) 449 { 450 struct spdk_json_write_ctx *w = ctx; 451 struct spdk_nvme_transport_id *trid; 452 const struct spdk_nvme_ctrlr_opts *opts; 453 454 trid = &nvme_ctrlr->connected_trid->trid; 455 456 spdk_json_write_object_begin(w); 457 spdk_json_write_named_string(w, "name", nvme_ctrlr->nbdev_ctrlr->name); 458 459 #ifdef SPDK_CONFIG_NVME_CUSE 460 size_t cuse_name_size = 128; 461 char cuse_name[cuse_name_size]; 462 463 int rc = spdk_nvme_cuse_get_ctrlr_name(nvme_ctrlr->ctrlr, cuse_name, &cuse_name_size); 464 if (rc == 0) { 465 spdk_json_write_named_string(w, "cuse_device", cuse_name); 466 } 467 #endif 468 469 spdk_json_write_named_object_begin(w, "trid"); 470 nvme_bdev_dump_trid_json(trid, w); 471 spdk_json_write_object_end(w); 472 473 opts = spdk_nvme_ctrlr_get_opts(nvme_ctrlr->ctrlr); 474 475 spdk_json_write_named_object_begin(w, "host"); 476 spdk_json_write_named_string(w, "nqn", opts->hostnqn); 477 spdk_json_write_named_string(w, "addr", opts->src_addr); 478 spdk_json_write_named_string(w, "svcid", opts->src_svcid); 479 spdk_json_write_object_end(w); 480 spdk_json_write_object_end(w); 481 } 482 483 struct rpc_bdev_nvme_get_controllers { 484 char *name; 485 }; 486 487 static void 488 free_rpc_bdev_nvme_get_controllers(struct rpc_bdev_nvme_get_controllers *r) 489 { 490 free(r->name); 491 } 492 493 static const struct spdk_json_object_decoder rpc_bdev_nvme_get_controllers_decoders[] = { 494 {"name", offsetof(struct rpc_bdev_nvme_get_controllers, name), spdk_json_decode_string, true}, 495 }; 496 497 static void 498 rpc_bdev_nvme_get_controllers(struct spdk_jsonrpc_request *request, 499 const struct spdk_json_val *params) 500 { 501 struct rpc_bdev_nvme_get_controllers req = {}; 502 struct spdk_json_write_ctx *w; 503 struct nvme_ctrlr *ctrlr = NULL; 504 505 if (params && spdk_json_decode_object(params, rpc_bdev_nvme_get_controllers_decoders, 506 SPDK_COUNTOF(rpc_bdev_nvme_get_controllers_decoders), 507 &req)) { 508 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 509 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 510 "spdk_json_decode_object failed"); 511 goto cleanup; 512 } 513 514 if (req.name) { 515 ctrlr = nvme_ctrlr_get_by_name(req.name); 516 if (ctrlr == NULL) { 517 SPDK_ERRLOG("ctrlr '%s' does not exist\n", req.name); 518 spdk_jsonrpc_send_error_response_fmt(request, EINVAL, "Controller %s does not exist", req.name); 519 goto cleanup; 520 } 521 } 522 523 w = spdk_jsonrpc_begin_result(request); 524 spdk_json_write_array_begin(w); 525 526 if (ctrlr != NULL) { 527 rpc_dump_nvme_controller_info(ctrlr, w); 528 } else { 529 nvme_ctrlr_for_each(rpc_dump_nvme_controller_info, w); 530 } 531 532 spdk_json_write_array_end(w); 533 534 spdk_jsonrpc_end_result(request, w); 535 536 cleanup: 537 free_rpc_bdev_nvme_get_controllers(&req); 538 } 539 SPDK_RPC_REGISTER("bdev_nvme_get_controllers", rpc_bdev_nvme_get_controllers, SPDK_RPC_RUNTIME) 540 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_get_controllers, get_nvme_controllers) 541 542 struct rpc_bdev_nvme_detach_controller { 543 char *name; 544 char *trtype; 545 char *adrfam; 546 char *traddr; 547 char *trsvcid; 548 char *subnqn; 549 }; 550 551 static void 552 free_rpc_bdev_nvme_detach_controller(struct rpc_bdev_nvme_detach_controller *req) 553 { 554 free(req->name); 555 free(req->trtype); 556 free(req->adrfam); 557 free(req->traddr); 558 free(req->trsvcid); 559 free(req->subnqn); 560 } 561 562 static const struct spdk_json_object_decoder rpc_bdev_nvme_detach_controller_decoders[] = { 563 {"name", offsetof(struct rpc_bdev_nvme_detach_controller, name), spdk_json_decode_string}, 564 {"trtype", offsetof(struct rpc_bdev_nvme_detach_controller, trtype), spdk_json_decode_string, true}, 565 {"traddr", offsetof(struct rpc_bdev_nvme_detach_controller, traddr), spdk_json_decode_string, true}, 566 {"adrfam", offsetof(struct rpc_bdev_nvme_detach_controller, adrfam), spdk_json_decode_string, true}, 567 {"trsvcid", offsetof(struct rpc_bdev_nvme_detach_controller, trsvcid), spdk_json_decode_string, true}, 568 {"subnqn", offsetof(struct rpc_bdev_nvme_detach_controller, subnqn), spdk_json_decode_string, true}, 569 }; 570 571 static void 572 rpc_bdev_nvme_detach_controller(struct spdk_jsonrpc_request *request, 573 const struct spdk_json_val *params) 574 { 575 struct rpc_bdev_nvme_detach_controller req = {NULL}; 576 struct spdk_nvme_transport_id trid = {}; 577 size_t len, maxlen; 578 int rc = 0; 579 580 if (spdk_json_decode_object(params, rpc_bdev_nvme_detach_controller_decoders, 581 SPDK_COUNTOF(rpc_bdev_nvme_detach_controller_decoders), 582 &req)) { 583 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 584 "spdk_json_decode_object failed"); 585 goto cleanup; 586 } 587 588 if (req.trtype != NULL) { 589 rc = spdk_nvme_transport_id_populate_trstring(&trid, req.trtype); 590 if (rc < 0) { 591 SPDK_ERRLOG("Failed to parse trtype: %s\n", req.trtype); 592 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s", 593 req.trtype); 594 goto cleanup; 595 } 596 597 rc = spdk_nvme_transport_id_parse_trtype(&trid.trtype, req.trtype); 598 if (rc < 0) { 599 SPDK_ERRLOG("Failed to parse trtype: %s\n", req.trtype); 600 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s", 601 req.trtype); 602 goto cleanup; 603 } 604 } 605 606 if (req.traddr != NULL) { 607 maxlen = sizeof(trid.traddr); 608 len = strnlen(req.traddr, maxlen); 609 if (len == maxlen) { 610 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "traddr too long: %s", 611 req.traddr); 612 goto cleanup; 613 } 614 memcpy(trid.traddr, req.traddr, len + 1); 615 } 616 617 if (req.adrfam != NULL) { 618 rc = spdk_nvme_transport_id_parse_adrfam(&trid.adrfam, req.adrfam); 619 if (rc < 0) { 620 SPDK_ERRLOG("Failed to parse adrfam: %s\n", req.adrfam); 621 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse adrfam: %s", 622 req.adrfam); 623 goto cleanup; 624 } 625 } 626 627 if (req.trsvcid != NULL) { 628 maxlen = sizeof(trid.trsvcid); 629 len = strnlen(req.trsvcid, maxlen); 630 if (len == maxlen) { 631 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "trsvcid too long: %s", 632 req.trsvcid); 633 goto cleanup; 634 } 635 memcpy(trid.trsvcid, req.trsvcid, len + 1); 636 } 637 638 /* Parse subnqn */ 639 if (req.subnqn != NULL) { 640 maxlen = sizeof(trid.subnqn); 641 len = strnlen(req.subnqn, maxlen); 642 if (len == maxlen) { 643 spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "subnqn too long: %s", 644 req.subnqn); 645 goto cleanup; 646 } 647 memcpy(trid.subnqn, req.subnqn, len + 1); 648 } 649 650 rc = bdev_nvme_delete(req.name, &trid); 651 652 if (rc != 0) { 653 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 654 goto cleanup; 655 } 656 657 spdk_jsonrpc_send_bool_response(request, true); 658 659 cleanup: 660 free_rpc_bdev_nvme_detach_controller(&req); 661 } 662 SPDK_RPC_REGISTER("bdev_nvme_detach_controller", rpc_bdev_nvme_detach_controller, 663 SPDK_RPC_RUNTIME) 664 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_detach_controller, delete_nvme_controller) 665 666 struct rpc_apply_firmware { 667 char *filename; 668 char *bdev_name; 669 }; 670 671 static void 672 free_rpc_apply_firmware(struct rpc_apply_firmware *req) 673 { 674 free(req->filename); 675 free(req->bdev_name); 676 } 677 678 static const struct spdk_json_object_decoder rpc_apply_firmware_decoders[] = { 679 {"filename", offsetof(struct rpc_apply_firmware, filename), spdk_json_decode_string}, 680 {"bdev_name", offsetof(struct rpc_apply_firmware, bdev_name), spdk_json_decode_string}, 681 }; 682 683 struct firmware_update_info { 684 void *fw_image; 685 void *p; 686 unsigned int size; 687 unsigned int size_remaining; 688 unsigned int offset; 689 unsigned int transfer; 690 691 void *desc; 692 struct spdk_io_channel *ch; 693 struct spdk_jsonrpc_request *request; 694 struct spdk_nvme_ctrlr *ctrlr; 695 open_descriptors_t desc_head; 696 struct rpc_apply_firmware *req; 697 }; 698 699 static void 700 _apply_firmware_cleanup(void *ctx) 701 { 702 struct spdk_bdev_desc *desc = ctx; 703 704 spdk_bdev_close(desc); 705 } 706 707 static void 708 apply_firmware_cleanup(void *cb_arg) 709 { 710 struct open_descriptors *opt, *tmp; 711 struct firmware_update_info *firm_ctx = cb_arg; 712 713 if (!firm_ctx) { 714 return; 715 } 716 717 if (firm_ctx->fw_image) { 718 spdk_free(firm_ctx->fw_image); 719 } 720 721 if (firm_ctx->req) { 722 free_rpc_apply_firmware(firm_ctx->req); 723 free(firm_ctx->req); 724 } 725 726 if (firm_ctx->ch) { 727 spdk_put_io_channel(firm_ctx->ch); 728 } 729 730 TAILQ_FOREACH_SAFE(opt, &firm_ctx->desc_head, tqlst, tmp) { 731 TAILQ_REMOVE(&firm_ctx->desc_head, opt, tqlst); 732 /* Close the underlying bdev on its same opened thread. */ 733 if (opt->thread && opt->thread != spdk_get_thread()) { 734 spdk_thread_send_msg(opt->thread, _apply_firmware_cleanup, opt->desc); 735 } else { 736 spdk_bdev_close(opt->desc); 737 } 738 free(opt); 739 } 740 free(firm_ctx); 741 } 742 743 static void 744 apply_firmware_complete_reset(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 745 { 746 struct spdk_json_write_ctx *w; 747 struct firmware_update_info *firm_ctx = cb_arg; 748 749 spdk_bdev_free_io(bdev_io); 750 751 if (!success) { 752 spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 753 "firmware commit failed."); 754 apply_firmware_cleanup(firm_ctx); 755 return; 756 } 757 758 if (spdk_nvme_ctrlr_reset(firm_ctx->ctrlr) != 0) { 759 spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 760 "Controller reset failed."); 761 apply_firmware_cleanup(firm_ctx); 762 return; 763 } 764 765 w = spdk_jsonrpc_begin_result(firm_ctx->request); 766 spdk_json_write_string(w, "firmware commit succeeded. Controller reset in progress."); 767 spdk_jsonrpc_end_result(firm_ctx->request, w); 768 apply_firmware_cleanup(firm_ctx); 769 } 770 771 static void 772 apply_firmware_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 773 { 774 struct spdk_nvme_cmd cmd = {}; 775 struct spdk_nvme_fw_commit fw_commit; 776 int slot = 0; 777 int rc; 778 struct firmware_update_info *firm_ctx = cb_arg; 779 enum spdk_nvme_fw_commit_action commit_action = SPDK_NVME_FW_COMMIT_REPLACE_AND_ENABLE_IMG; 780 781 if (!success) { 782 spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 783 "firmware download failed ."); 784 spdk_bdev_free_io(bdev_io); 785 apply_firmware_cleanup(firm_ctx); 786 return; 787 } 788 789 firm_ctx->p += firm_ctx->transfer; 790 firm_ctx->offset += firm_ctx->transfer; 791 firm_ctx->size_remaining -= firm_ctx->transfer; 792 793 switch (firm_ctx->size_remaining) { 794 case 0: 795 /* firmware download completed. Commit firmware */ 796 memset(&fw_commit, 0, sizeof(struct spdk_nvme_fw_commit)); 797 fw_commit.fs = slot; 798 fw_commit.ca = commit_action; 799 800 cmd.opc = SPDK_NVME_OPC_FIRMWARE_COMMIT; 801 memcpy(&cmd.cdw10, &fw_commit, sizeof(uint32_t)); 802 rc = spdk_bdev_nvme_admin_passthru(firm_ctx->desc, firm_ctx->ch, &cmd, NULL, 0, 803 apply_firmware_complete_reset, firm_ctx); 804 if (rc) { 805 spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 806 "firmware commit failed."); 807 spdk_bdev_free_io(bdev_io); 808 apply_firmware_cleanup(firm_ctx); 809 return; 810 } 811 break; 812 default: 813 firm_ctx->transfer = spdk_min(firm_ctx->size_remaining, 4096); 814 cmd.opc = SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD; 815 816 cmd.cdw10 = spdk_nvme_bytes_to_numd(firm_ctx->transfer); 817 cmd.cdw11 = firm_ctx->offset >> 2; 818 rc = spdk_bdev_nvme_admin_passthru(firm_ctx->desc, firm_ctx->ch, &cmd, firm_ctx->p, 819 firm_ctx->transfer, apply_firmware_complete, firm_ctx); 820 if (rc) { 821 spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 822 "firmware download failed."); 823 spdk_bdev_free_io(bdev_io); 824 apply_firmware_cleanup(firm_ctx); 825 return; 826 } 827 break; 828 } 829 } 830 831 static void 832 apply_firmware_open_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 833 { 834 } 835 836 static void 837 rpc_bdev_nvme_apply_firmware(struct spdk_jsonrpc_request *request, 838 const struct spdk_json_val *params) 839 { 840 int rc; 841 int fd = -1; 842 struct stat fw_stat; 843 struct spdk_nvme_ctrlr *ctrlr; 844 char msg[1024]; 845 struct spdk_bdev *bdev; 846 struct spdk_bdev *bdev2; 847 struct open_descriptors *opt; 848 struct spdk_bdev_desc *desc; 849 struct spdk_nvme_cmd *cmd; 850 struct firmware_update_info *firm_ctx; 851 852 firm_ctx = calloc(1, sizeof(struct firmware_update_info)); 853 if (!firm_ctx) { 854 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 855 "Memory allocation error."); 856 return; 857 } 858 firm_ctx->fw_image = NULL; 859 TAILQ_INIT(&firm_ctx->desc_head); 860 firm_ctx->request = request; 861 862 firm_ctx->req = calloc(1, sizeof(struct rpc_apply_firmware)); 863 if (!firm_ctx->req) { 864 snprintf(msg, sizeof(msg), "Memory allocation error."); 865 goto err; 866 } 867 868 if (spdk_json_decode_object(params, rpc_apply_firmware_decoders, 869 SPDK_COUNTOF(rpc_apply_firmware_decoders), firm_ctx->req)) { 870 snprintf(msg, sizeof(msg), "spdk_json_decode_object failed."); 871 goto err; 872 } 873 874 if ((bdev = spdk_bdev_get_by_name(firm_ctx->req->bdev_name)) == NULL) { 875 snprintf(msg, sizeof(msg), "bdev %s were not found", firm_ctx->req->bdev_name); 876 goto err; 877 } 878 879 if ((ctrlr = bdev_nvme_get_ctrlr(bdev)) == NULL) { 880 snprintf(msg, sizeof(msg), "Controller information for %s were not found.", 881 firm_ctx->req->bdev_name); 882 goto err; 883 } 884 firm_ctx->ctrlr = ctrlr; 885 886 for (bdev2 = spdk_bdev_first(); bdev2; bdev2 = spdk_bdev_next(bdev2)) { 887 888 if (bdev_nvme_get_ctrlr(bdev2) != ctrlr) { 889 continue; 890 } 891 892 if (!(opt = malloc(sizeof(struct open_descriptors)))) { 893 snprintf(msg, sizeof(msg), "Memory allocation error."); 894 goto err; 895 } 896 897 if (spdk_bdev_open_ext(spdk_bdev_get_name(bdev2), true, apply_firmware_open_cb, NULL, &desc) != 0) { 898 snprintf(msg, sizeof(msg), "Device %s is in use.", firm_ctx->req->bdev_name); 899 free(opt); 900 goto err; 901 } 902 903 /* Save the thread where the base device is opened */ 904 opt->thread = spdk_get_thread(); 905 906 opt->desc = desc; 907 opt->bdev = bdev; 908 TAILQ_INSERT_TAIL(&firm_ctx->desc_head, opt, tqlst); 909 } 910 911 /* 912 * find a descriptor associated with our bdev 913 */ 914 firm_ctx->desc = NULL; 915 TAILQ_FOREACH(opt, &firm_ctx->desc_head, tqlst) { 916 if (opt->bdev == bdev) { 917 firm_ctx->desc = opt->desc; 918 break; 919 } 920 } 921 922 if (!firm_ctx->desc) { 923 snprintf(msg, sizeof(msg), "No descriptor were found."); 924 goto err; 925 } 926 927 firm_ctx->ch = spdk_bdev_get_io_channel(firm_ctx->desc); 928 if (!firm_ctx->ch) { 929 snprintf(msg, sizeof(msg), "No channels were found."); 930 goto err; 931 } 932 933 fd = open(firm_ctx->req->filename, O_RDONLY); 934 if (fd < 0) { 935 snprintf(msg, sizeof(msg), "open file failed."); 936 goto err; 937 } 938 939 rc = fstat(fd, &fw_stat); 940 if (rc < 0) { 941 close(fd); 942 snprintf(msg, sizeof(msg), "fstat failed."); 943 goto err; 944 } 945 946 firm_ctx->size = fw_stat.st_size; 947 if (fw_stat.st_size % 4) { 948 close(fd); 949 snprintf(msg, sizeof(msg), "Firmware image size is not multiple of 4."); 950 goto err; 951 } 952 953 firm_ctx->fw_image = spdk_zmalloc(firm_ctx->size, 4096, NULL, 954 SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA); 955 if (!firm_ctx->fw_image) { 956 close(fd); 957 snprintf(msg, sizeof(msg), "Memory allocation error."); 958 goto err; 959 } 960 firm_ctx->p = firm_ctx->fw_image; 961 962 if (read(fd, firm_ctx->p, firm_ctx->size) != ((ssize_t)(firm_ctx->size))) { 963 close(fd); 964 snprintf(msg, sizeof(msg), "Read firmware image failed!"); 965 goto err; 966 } 967 close(fd); 968 969 firm_ctx->offset = 0; 970 firm_ctx->size_remaining = firm_ctx->size; 971 firm_ctx->transfer = spdk_min(firm_ctx->size_remaining, 4096); 972 973 cmd = malloc(sizeof(struct spdk_nvme_cmd)); 974 if (!cmd) { 975 snprintf(msg, sizeof(msg), "Memory allocation error."); 976 goto err; 977 } 978 memset(cmd, 0, sizeof(struct spdk_nvme_cmd)); 979 cmd->opc = SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD; 980 981 cmd->cdw10 = spdk_nvme_bytes_to_numd(firm_ctx->transfer); 982 cmd->cdw11 = firm_ctx->offset >> 2; 983 984 rc = spdk_bdev_nvme_admin_passthru(firm_ctx->desc, firm_ctx->ch, cmd, firm_ctx->p, 985 firm_ctx->transfer, apply_firmware_complete, firm_ctx); 986 if (rc == 0) { 987 /* normal return here. */ 988 return; 989 } 990 991 free(cmd); 992 snprintf(msg, sizeof(msg), "Read firmware image failed!"); 993 err: 994 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, msg); 995 apply_firmware_cleanup(firm_ctx); 996 } 997 SPDK_RPC_REGISTER("bdev_nvme_apply_firmware", rpc_bdev_nvme_apply_firmware, SPDK_RPC_RUNTIME) 998 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_apply_firmware, apply_nvme_firmware) 999 1000 struct rpc_bdev_nvme_transport_stat_ctx { 1001 struct spdk_jsonrpc_request *request; 1002 struct spdk_json_write_ctx *w; 1003 }; 1004 1005 static void 1006 rpc_bdev_nvme_rdma_stats(struct spdk_json_write_ctx *w, 1007 struct spdk_nvme_transport_poll_group_stat *stat) 1008 { 1009 struct spdk_nvme_rdma_device_stat *device_stats; 1010 uint32_t i; 1011 1012 spdk_json_write_named_array_begin(w, "devices"); 1013 1014 for (i = 0; i < stat->rdma.num_devices; i++) { 1015 device_stats = &stat->rdma.device_stats[i]; 1016 spdk_json_write_object_begin(w); 1017 spdk_json_write_named_string(w, "dev_name", device_stats->name); 1018 spdk_json_write_named_uint64(w, "polls", device_stats->polls); 1019 spdk_json_write_named_uint64(w, "idle_polls", device_stats->idle_polls); 1020 spdk_json_write_named_uint64(w, "completions", device_stats->completions); 1021 spdk_json_write_named_uint64(w, "queued_requests", device_stats->queued_requests); 1022 spdk_json_write_named_uint64(w, "total_send_wrs", device_stats->total_send_wrs); 1023 spdk_json_write_named_uint64(w, "send_doorbell_updates", device_stats->send_doorbell_updates); 1024 spdk_json_write_named_uint64(w, "total_recv_wrs", device_stats->total_recv_wrs); 1025 spdk_json_write_named_uint64(w, "recv_doorbell_updates", device_stats->recv_doorbell_updates); 1026 spdk_json_write_object_end(w); 1027 } 1028 spdk_json_write_array_end(w); 1029 } 1030 1031 static void 1032 rpc_bdev_nvme_pcie_stats(struct spdk_json_write_ctx *w, 1033 struct spdk_nvme_transport_poll_group_stat *stat) 1034 { 1035 spdk_json_write_named_uint64(w, "polls", stat->pcie.polls); 1036 spdk_json_write_named_uint64(w, "idle_polls", stat->pcie.idle_polls); 1037 spdk_json_write_named_uint64(w, "completions", stat->pcie.completions); 1038 spdk_json_write_named_uint64(w, "cq_doorbell_updates", stat->pcie.cq_doorbell_updates); 1039 spdk_json_write_named_uint64(w, "queued_requests", stat->pcie.queued_requests); 1040 spdk_json_write_named_uint64(w, "submitted_requests", stat->pcie.submitted_requests); 1041 spdk_json_write_named_uint64(w, "sq_doobell_updates", stat->pcie.sq_doobell_updates); 1042 } 1043 1044 static void 1045 rpc_bdev_nvme_tcp_stats(struct spdk_json_write_ctx *w, 1046 struct spdk_nvme_transport_poll_group_stat *stat) 1047 { 1048 spdk_json_write_named_uint64(w, "polls", stat->tcp.polls); 1049 spdk_json_write_named_uint64(w, "idle_polls", stat->tcp.idle_polls); 1050 spdk_json_write_named_uint64(w, "socket_completions", stat->tcp.socket_completions); 1051 spdk_json_write_named_uint64(w, "nvme_completions", stat->tcp.nvme_completions); 1052 spdk_json_write_named_uint64(w, "queued_requests", stat->tcp.queued_requests); 1053 spdk_json_write_named_uint64(w, "submitted_requests", stat->tcp.submitted_requests); 1054 } 1055 1056 static void 1057 rpc_bdev_nvme_stats_per_channel(struct spdk_io_channel_iter *i) 1058 { 1059 struct rpc_bdev_nvme_transport_stat_ctx *ctx; 1060 struct spdk_io_channel *ch; 1061 struct nvme_poll_group *group; 1062 struct spdk_nvme_poll_group_stat *stat; 1063 struct spdk_nvme_transport_poll_group_stat *tr_stat; 1064 uint32_t j; 1065 int rc; 1066 1067 ctx = spdk_io_channel_iter_get_ctx(i); 1068 ch = spdk_io_channel_iter_get_channel(i); 1069 group = spdk_io_channel_get_ctx(ch); 1070 1071 rc = spdk_nvme_poll_group_get_stats(group->group, &stat); 1072 if (rc) { 1073 spdk_for_each_channel_continue(i, rc); 1074 return; 1075 } 1076 1077 spdk_json_write_object_begin(ctx->w); 1078 spdk_json_write_named_string(ctx->w, "thread", spdk_thread_get_name(spdk_get_thread())); 1079 spdk_json_write_named_array_begin(ctx->w, "transports"); 1080 1081 for (j = 0; j < stat->num_transports; j++) { 1082 tr_stat = stat->transport_stat[j]; 1083 spdk_json_write_object_begin(ctx->w); 1084 spdk_json_write_named_string(ctx->w, "trname", spdk_nvme_transport_id_trtype_str(tr_stat->trtype)); 1085 1086 switch (stat->transport_stat[j]->trtype) { 1087 case SPDK_NVME_TRANSPORT_RDMA: 1088 rpc_bdev_nvme_rdma_stats(ctx->w, tr_stat); 1089 break; 1090 case SPDK_NVME_TRANSPORT_PCIE: 1091 rpc_bdev_nvme_pcie_stats(ctx->w, tr_stat); 1092 break; 1093 case SPDK_NVME_TRANSPORT_TCP: 1094 rpc_bdev_nvme_tcp_stats(ctx->w, tr_stat); 1095 break; 1096 default: 1097 SPDK_WARNLOG("Can't handle trtype %d %s\n", tr_stat->trtype, 1098 spdk_nvme_transport_id_trtype_str(tr_stat->trtype)); 1099 } 1100 spdk_json_write_object_end(ctx->w); 1101 } 1102 /* transports array */ 1103 spdk_json_write_array_end(ctx->w); 1104 spdk_json_write_object_end(ctx->w); 1105 1106 spdk_nvme_poll_group_free_stats(group->group, stat); 1107 spdk_for_each_channel_continue(i, 0); 1108 } 1109 1110 static void 1111 rpc_bdev_nvme_stats_done(struct spdk_io_channel_iter *i, int status) 1112 { 1113 struct rpc_bdev_nvme_transport_stat_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1114 1115 spdk_json_write_array_end(ctx->w); 1116 spdk_json_write_object_end(ctx->w); 1117 spdk_jsonrpc_end_result(ctx->request, ctx->w); 1118 free(ctx); 1119 } 1120 1121 static void 1122 rpc_bdev_nvme_get_transport_statistics(struct spdk_jsonrpc_request *request, 1123 const struct spdk_json_val *params) 1124 { 1125 struct rpc_bdev_nvme_transport_stat_ctx *ctx; 1126 1127 if (params) { 1128 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1129 "'bdev_nvme_get_transport_statistics' requires no arguments"); 1130 return; 1131 } 1132 1133 ctx = calloc(1, sizeof(*ctx)); 1134 if (!ctx) { 1135 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1136 "Memory allocation error"); 1137 return; 1138 } 1139 ctx->request = request; 1140 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 1141 spdk_json_write_object_begin(ctx->w); 1142 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 1143 1144 spdk_for_each_channel(&g_nvme_bdev_ctrlrs, 1145 rpc_bdev_nvme_stats_per_channel, 1146 ctx, 1147 rpc_bdev_nvme_stats_done); 1148 } 1149 SPDK_RPC_REGISTER("bdev_nvme_get_transport_statistics", rpc_bdev_nvme_get_transport_statistics, 1150 SPDK_RPC_RUNTIME) 1151 1152 struct rpc_bdev_nvme_reset_controller_req { 1153 char *name; 1154 }; 1155 1156 static void 1157 free_rpc_bdev_nvme_reset_controller_req(struct rpc_bdev_nvme_reset_controller_req *r) 1158 { 1159 free(r->name); 1160 } 1161 1162 static const struct spdk_json_object_decoder rpc_bdev_nvme_reset_controller_req_decoders[] = { 1163 {"name", offsetof(struct rpc_bdev_nvme_reset_controller_req, name), spdk_json_decode_string}, 1164 }; 1165 1166 static void 1167 _rpc_bdev_nvme_reset_controller_cb(void *cb_arg, int rc) 1168 { 1169 struct spdk_jsonrpc_request *request = cb_arg; 1170 1171 spdk_jsonrpc_send_bool_response(request, rc == 0); 1172 } 1173 1174 static void 1175 rpc_bdev_nvme_reset_controller(struct spdk_jsonrpc_request *request, 1176 const struct spdk_json_val *params) 1177 { 1178 struct rpc_bdev_nvme_reset_controller_req req = {NULL}; 1179 struct nvme_ctrlr *nvme_ctrlr; 1180 int rc; 1181 1182 if (spdk_json_decode_object(params, rpc_bdev_nvme_reset_controller_req_decoders, 1183 SPDK_COUNTOF(rpc_bdev_nvme_reset_controller_req_decoders), 1184 &req)) { 1185 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1186 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(EINVAL)); 1187 goto cleanup; 1188 } 1189 1190 nvme_ctrlr = nvme_ctrlr_get_by_name(req.name); 1191 if (nvme_ctrlr == NULL) { 1192 SPDK_ERRLOG("Failed at device lookup\n"); 1193 spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV)); 1194 goto cleanup; 1195 } 1196 1197 rc = bdev_nvme_reset_rpc(nvme_ctrlr, _rpc_bdev_nvme_reset_controller_cb, request); 1198 if (rc != 0) { 1199 SPDK_NOTICELOG("Failed at bdev_nvme_reset_rpc\n"); 1200 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, spdk_strerror(-rc)); 1201 } 1202 1203 cleanup: 1204 free_rpc_bdev_nvme_reset_controller_req(&req); 1205 } 1206 SPDK_RPC_REGISTER("bdev_nvme_reset_controller", rpc_bdev_nvme_reset_controller, SPDK_RPC_RUNTIME) 1207 1208 struct rpc_get_controller_health_info { 1209 char *name; 1210 }; 1211 1212 struct spdk_nvme_health_info_context { 1213 struct spdk_jsonrpc_request *request; 1214 struct spdk_nvme_ctrlr *ctrlr; 1215 struct spdk_nvme_health_information_page health_page; 1216 }; 1217 1218 static void 1219 free_rpc_get_controller_health_info(struct rpc_get_controller_health_info *r) 1220 { 1221 free(r->name); 1222 } 1223 1224 static const struct spdk_json_object_decoder rpc_get_controller_health_info_decoders[] = { 1225 {"name", offsetof(struct rpc_get_controller_health_info, name), spdk_json_decode_string, true}, 1226 }; 1227 1228 static void nvme_health_info_cleanup(struct spdk_nvme_health_info_context *context, bool response) 1229 { 1230 if (response == true) { 1231 spdk_jsonrpc_send_error_response(context->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1232 "Internal error."); 1233 } 1234 1235 free(context); 1236 } 1237 1238 static void 1239 get_health_log_page_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl) 1240 { 1241 int i; 1242 char buf[128]; 1243 struct spdk_nvme_health_info_context *context = cb_arg; 1244 struct spdk_jsonrpc_request *request = context->request; 1245 struct spdk_json_write_ctx *w; 1246 struct spdk_nvme_ctrlr *ctrlr = context->ctrlr; 1247 const struct spdk_nvme_transport_id *trid = NULL; 1248 const struct spdk_nvme_ctrlr_data *cdata = NULL; 1249 struct spdk_nvme_health_information_page *health_page = NULL; 1250 1251 if (spdk_nvme_cpl_is_error(cpl)) { 1252 nvme_health_info_cleanup(context, true); 1253 SPDK_ERRLOG("get log page failed\n"); 1254 return; 1255 } 1256 1257 if (ctrlr == NULL) { 1258 nvme_health_info_cleanup(context, true); 1259 SPDK_ERRLOG("ctrlr is NULL\n"); 1260 return; 1261 } else { 1262 trid = spdk_nvme_ctrlr_get_transport_id(ctrlr); 1263 cdata = spdk_nvme_ctrlr_get_data(ctrlr); 1264 health_page = &(context->health_page); 1265 } 1266 1267 w = spdk_jsonrpc_begin_result(request); 1268 1269 spdk_json_write_object_begin(w); 1270 snprintf(buf, sizeof(cdata->mn) + 1, "%s", cdata->mn); 1271 spdk_str_trim(buf); 1272 spdk_json_write_named_string(w, "model_number", buf); 1273 snprintf(buf, sizeof(cdata->sn) + 1, "%s", cdata->sn); 1274 spdk_str_trim(buf); 1275 spdk_json_write_named_string(w, "serial_number", buf); 1276 snprintf(buf, sizeof(cdata->fr) + 1, "%s", cdata->fr); 1277 spdk_str_trim(buf); 1278 spdk_json_write_named_string(w, "firmware_revision", buf); 1279 spdk_json_write_named_string(w, "traddr", trid->traddr); 1280 spdk_json_write_named_uint64(w, "temperature_celsius", health_page->temperature - 273); 1281 spdk_json_write_named_uint64(w, "available_spare_percentage", health_page->available_spare); 1282 spdk_json_write_named_uint64(w, "available_spare_threshold_percentage", 1283 health_page->available_spare_threshold); 1284 spdk_json_write_named_uint64(w, "percentage_used", health_page->percentage_used); 1285 spdk_json_write_named_uint128(w, "data_units_read", 1286 health_page->data_units_read[0], health_page->data_units_read[1]); 1287 spdk_json_write_named_uint128(w, "data_units_written", 1288 health_page->data_units_written[0], health_page->data_units_written[1]); 1289 spdk_json_write_named_uint128(w, "host_read_commands", 1290 health_page->host_read_commands[0], health_page->host_read_commands[1]); 1291 spdk_json_write_named_uint128(w, "host_write_commands", 1292 health_page->host_write_commands[0], health_page->host_write_commands[1]); 1293 spdk_json_write_named_uint128(w, "controller_busy_time", 1294 health_page->controller_busy_time[0], health_page->controller_busy_time[1]); 1295 spdk_json_write_named_uint128(w, "power_cycles", 1296 health_page->power_cycles[0], health_page->power_cycles[1]); 1297 spdk_json_write_named_uint128(w, "power_on_hours", 1298 health_page->power_on_hours[0], health_page->power_on_hours[1]); 1299 spdk_json_write_named_uint128(w, "unsafe_shutdowns", 1300 health_page->unsafe_shutdowns[0], health_page->unsafe_shutdowns[1]); 1301 spdk_json_write_named_uint128(w, "media_errors", 1302 health_page->media_errors[0], health_page->media_errors[1]); 1303 spdk_json_write_named_uint128(w, "num_err_log_entries", 1304 health_page->num_error_info_log_entries[0], health_page->num_error_info_log_entries[1]); 1305 spdk_json_write_named_uint64(w, "warning_temperature_time_minutes", health_page->warning_temp_time); 1306 spdk_json_write_named_uint64(w, "critical_composite_temperature_time_minutes", 1307 health_page->critical_temp_time); 1308 for (i = 0; i < 8; i++) { 1309 if (health_page->temp_sensor[i] != 0) { 1310 spdk_json_write_named_uint64(w, "temperature_sensor_celsius", health_page->temp_sensor[i] - 273); 1311 } 1312 } 1313 spdk_json_write_object_end(w); 1314 1315 spdk_jsonrpc_end_result(request, w); 1316 nvme_health_info_cleanup(context, false); 1317 } 1318 1319 static void 1320 get_health_log_page(struct spdk_nvme_health_info_context *context) 1321 { 1322 struct spdk_nvme_ctrlr *ctrlr = context->ctrlr; 1323 1324 if (spdk_nvme_ctrlr_cmd_get_log_page(ctrlr, SPDK_NVME_LOG_HEALTH_INFORMATION, 1325 SPDK_NVME_GLOBAL_NS_TAG, 1326 &(context->health_page), sizeof(context->health_page), 0, 1327 get_health_log_page_completion, context)) { 1328 nvme_health_info_cleanup(context, true); 1329 SPDK_ERRLOG("spdk_nvme_ctrlr_cmd_get_log_page() failed\n"); 1330 } 1331 } 1332 1333 static void 1334 get_temperature_threshold_feature_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl) 1335 { 1336 struct spdk_nvme_health_info_context *context = cb_arg; 1337 1338 if (spdk_nvme_cpl_is_error(cpl)) { 1339 nvme_health_info_cleanup(context, true); 1340 SPDK_ERRLOG("feature SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD failed in completion\n"); 1341 } else { 1342 get_health_log_page(context); 1343 } 1344 } 1345 1346 static int 1347 get_temperature_threshold_feature(struct spdk_nvme_health_info_context *context) 1348 { 1349 struct spdk_nvme_cmd cmd = {}; 1350 1351 cmd.opc = SPDK_NVME_OPC_GET_FEATURES; 1352 cmd.cdw10 = SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD; 1353 1354 return spdk_nvme_ctrlr_cmd_admin_raw(context->ctrlr, &cmd, NULL, 0, 1355 get_temperature_threshold_feature_completion, context); 1356 } 1357 1358 static void 1359 get_controller_health_info(struct spdk_jsonrpc_request *request, struct spdk_nvme_ctrlr *ctrlr) 1360 { 1361 struct spdk_nvme_health_info_context *context; 1362 1363 context = calloc(1, sizeof(struct spdk_nvme_health_info_context)); 1364 if (!context) { 1365 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1366 "Memory allocation error."); 1367 return; 1368 } 1369 1370 context->request = request; 1371 context->ctrlr = ctrlr; 1372 1373 if (get_temperature_threshold_feature(context)) { 1374 nvme_health_info_cleanup(context, true); 1375 SPDK_ERRLOG("feature SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD failed to submit\n"); 1376 } 1377 1378 return; 1379 } 1380 1381 static void 1382 rpc_bdev_nvme_get_controller_health_info(struct spdk_jsonrpc_request *request, 1383 const struct spdk_json_val *params) 1384 { 1385 struct rpc_get_controller_health_info req = {}; 1386 struct nvme_ctrlr *nvme_ctrlr = NULL; 1387 1388 if (!params) { 1389 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1390 "Missing device name"); 1391 1392 return; 1393 } 1394 if (spdk_json_decode_object(params, rpc_get_controller_health_info_decoders, 1395 SPDK_COUNTOF(rpc_get_controller_health_info_decoders), &req)) { 1396 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1397 free_rpc_get_controller_health_info(&req); 1398 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1399 "Invalid parameters"); 1400 1401 return; 1402 } 1403 1404 nvme_ctrlr = nvme_ctrlr_get_by_name(req.name); 1405 1406 if (!nvme_ctrlr) { 1407 SPDK_ERRLOG("nvme ctrlr name '%s' does not exist\n", req.name); 1408 free_rpc_get_controller_health_info(&req); 1409 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1410 "Device not found"); 1411 return; 1412 } 1413 1414 get_controller_health_info(request, nvme_ctrlr->ctrlr); 1415 free_rpc_get_controller_health_info(&req); 1416 1417 return; 1418 } 1419 SPDK_RPC_REGISTER("bdev_nvme_get_controller_health_info", 1420 rpc_bdev_nvme_get_controller_health_info, SPDK_RPC_RUNTIME) 1421