1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2018-2020 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/bdev.h" 35 #include "spdk/log.h" 36 #include "spdk/rpc.h" 37 #include "spdk/env.h" 38 #include "spdk/nvme.h" 39 #include "spdk/nvmf.h" 40 #include "spdk/string.h" 41 #include "spdk/util.h" 42 #include "spdk/bit_array.h" 43 44 #include "spdk_internal/assert.h" 45 46 #include "nvmf_internal.h" 47 48 static int 49 json_write_hex_str(struct spdk_json_write_ctx *w, const void *data, size_t size) 50 { 51 static const char hex_char[16] = "0123456789ABCDEF"; 52 const uint8_t *buf = data; 53 char *str, *out; 54 int rc; 55 56 str = malloc(size * 2 + 1); 57 if (str == NULL) { 58 return -1; 59 } 60 61 out = str; 62 while (size--) { 63 unsigned byte = *buf++; 64 65 out[0] = hex_char[(byte >> 4) & 0xF]; 66 out[1] = hex_char[byte & 0xF]; 67 68 out += 2; 69 } 70 *out = '\0'; 71 72 rc = spdk_json_write_string(w, str); 73 free(str); 74 75 return rc; 76 } 77 78 static int 79 hex_nybble_to_num(char c) 80 { 81 if (c >= '0' && c <= '9') { 82 return c - '0'; 83 } 84 85 if (c >= 'a' && c <= 'f') { 86 return c - 'a' + 0xA; 87 } 88 89 if (c >= 'A' && c <= 'F') { 90 return c - 'A' + 0xA; 91 } 92 93 return -1; 94 } 95 96 static int 97 hex_byte_to_num(const char *str) 98 { 99 int hi, lo; 100 101 hi = hex_nybble_to_num(str[0]); 102 if (hi < 0) { 103 return hi; 104 } 105 106 lo = hex_nybble_to_num(str[1]); 107 if (lo < 0) { 108 return lo; 109 } 110 111 return hi * 16 + lo; 112 } 113 114 static int 115 decode_hex_string_be(const char *str, uint8_t *out, size_t size) 116 { 117 size_t i; 118 119 /* Decode a string in "ABCDEF012345" format to its binary representation */ 120 for (i = 0; i < size; i++) { 121 int num = hex_byte_to_num(str); 122 123 if (num < 0) { 124 /* Invalid hex byte or end of string */ 125 return -1; 126 } 127 128 out[i] = (uint8_t)num; 129 str += 2; 130 } 131 132 if (i != size || *str != '\0') { 133 /* Length mismatch */ 134 return -1; 135 } 136 137 return 0; 138 } 139 140 static int 141 decode_ns_nguid(const struct spdk_json_val *val, void *out) 142 { 143 char *str = NULL; 144 int rc; 145 146 rc = spdk_json_decode_string(val, &str); 147 if (rc == 0) { 148 /* 16-byte NGUID */ 149 rc = decode_hex_string_be(str, out, 16); 150 } 151 152 free(str); 153 return rc; 154 } 155 156 static int 157 decode_ns_eui64(const struct spdk_json_val *val, void *out) 158 { 159 char *str = NULL; 160 int rc; 161 162 rc = spdk_json_decode_string(val, &str); 163 if (rc == 0) { 164 /* 8-byte EUI-64 */ 165 rc = decode_hex_string_be(str, out, 8); 166 } 167 168 free(str); 169 return rc; 170 } 171 172 static int 173 decode_ns_uuid(const struct spdk_json_val *val, void *out) 174 { 175 char *str = NULL; 176 int rc; 177 178 rc = spdk_json_decode_string(val, &str); 179 if (rc == 0) { 180 rc = spdk_uuid_parse(out, str); 181 } 182 183 free(str); 184 return rc; 185 } 186 187 struct rpc_get_subsystem { 188 char *tgt_name; 189 }; 190 191 static const struct spdk_json_object_decoder rpc_get_subsystem_decoders[] = { 192 {"tgt_name", offsetof(struct rpc_get_subsystem, tgt_name), spdk_json_decode_string, true}, 193 }; 194 195 static void 196 dump_nvmf_subsystem(struct spdk_json_write_ctx *w, struct spdk_nvmf_subsystem *subsystem) 197 { 198 struct spdk_nvmf_host *host; 199 struct spdk_nvmf_subsystem_listener *listener; 200 201 spdk_json_write_object_begin(w); 202 203 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 204 spdk_json_write_name(w, "subtype"); 205 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 206 spdk_json_write_string(w, "NVMe"); 207 } else { 208 spdk_json_write_string(w, "Discovery"); 209 } 210 211 spdk_json_write_named_array_begin(w, "listen_addresses"); 212 213 for (listener = spdk_nvmf_subsystem_get_first_listener(subsystem); listener != NULL; 214 listener = spdk_nvmf_subsystem_get_next_listener(subsystem, listener)) { 215 const struct spdk_nvme_transport_id *trid; 216 const char *adrfam; 217 218 trid = spdk_nvmf_subsystem_listener_get_trid(listener); 219 220 spdk_json_write_object_begin(w); 221 adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam); 222 if (adrfam == NULL) { 223 adrfam = "unknown"; 224 } 225 /* NOTE: "transport" is kept for compatibility; new code should use "trtype" */ 226 spdk_json_write_named_string(w, "transport", trid->trstring); 227 spdk_json_write_named_string(w, "trtype", trid->trstring); 228 spdk_json_write_named_string(w, "adrfam", adrfam); 229 spdk_json_write_named_string(w, "traddr", trid->traddr); 230 spdk_json_write_named_string(w, "trsvcid", trid->trsvcid); 231 spdk_json_write_object_end(w); 232 } 233 spdk_json_write_array_end(w); 234 235 spdk_json_write_named_bool(w, "allow_any_host", 236 spdk_nvmf_subsystem_get_allow_any_host(subsystem)); 237 238 spdk_json_write_named_array_begin(w, "hosts"); 239 240 for (host = spdk_nvmf_subsystem_get_first_host(subsystem); host != NULL; 241 host = spdk_nvmf_subsystem_get_next_host(subsystem, host)) { 242 spdk_json_write_object_begin(w); 243 spdk_json_write_named_string(w, "nqn", spdk_nvmf_host_get_nqn(host)); 244 spdk_json_write_object_end(w); 245 } 246 spdk_json_write_array_end(w); 247 248 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 249 struct spdk_nvmf_ns *ns; 250 struct spdk_nvmf_ns_opts ns_opts; 251 uint32_t max_namespaces; 252 253 spdk_json_write_named_string(w, "serial_number", spdk_nvmf_subsystem_get_sn(subsystem)); 254 255 spdk_json_write_named_string(w, "model_number", spdk_nvmf_subsystem_get_mn(subsystem)); 256 257 max_namespaces = spdk_nvmf_subsystem_get_max_namespaces(subsystem); 258 if (max_namespaces != 0) { 259 spdk_json_write_named_uint32(w, "max_namespaces", max_namespaces); 260 } 261 262 spdk_json_write_named_array_begin(w, "namespaces"); 263 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 264 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 265 spdk_nvmf_ns_get_opts(ns, &ns_opts, sizeof(ns_opts)); 266 spdk_json_write_object_begin(w); 267 spdk_json_write_named_int32(w, "nsid", spdk_nvmf_ns_get_id(ns)); 268 spdk_json_write_named_string(w, "bdev_name", 269 spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 270 /* NOTE: "name" is kept for compatibility only - new code should use bdev_name. */ 271 spdk_json_write_named_string(w, "name", 272 spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 273 274 if (!spdk_mem_all_zero(ns_opts.nguid, sizeof(ns_opts.nguid))) { 275 spdk_json_write_name(w, "nguid"); 276 json_write_hex_str(w, ns_opts.nguid, sizeof(ns_opts.nguid)); 277 } 278 279 if (!spdk_mem_all_zero(ns_opts.eui64, sizeof(ns_opts.eui64))) { 280 spdk_json_write_name(w, "eui64"); 281 json_write_hex_str(w, ns_opts.eui64, sizeof(ns_opts.eui64)); 282 } 283 284 if (!spdk_mem_all_zero(&ns_opts.uuid, sizeof(ns_opts.uuid))) { 285 char uuid_str[SPDK_UUID_STRING_LEN]; 286 287 spdk_uuid_fmt_lower(uuid_str, sizeof(uuid_str), &ns_opts.uuid); 288 spdk_json_write_named_string(w, "uuid", uuid_str); 289 } 290 291 spdk_json_write_object_end(w); 292 } 293 spdk_json_write_array_end(w); 294 } 295 spdk_json_write_object_end(w); 296 } 297 298 static void 299 rpc_nvmf_get_subsystems(struct spdk_jsonrpc_request *request, 300 const struct spdk_json_val *params) 301 { 302 struct rpc_get_subsystem req = { 0 }; 303 struct spdk_json_write_ctx *w; 304 struct spdk_nvmf_subsystem *subsystem; 305 struct spdk_nvmf_tgt *tgt; 306 307 if (params) { 308 if (spdk_json_decode_object(params, rpc_get_subsystem_decoders, 309 SPDK_COUNTOF(rpc_get_subsystem_decoders), 310 &req)) { 311 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 312 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 313 return; 314 } 315 } 316 317 tgt = spdk_nvmf_get_tgt(req.tgt_name); 318 if (!tgt) { 319 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 320 "Unable to find a target."); 321 free(req.tgt_name); 322 return; 323 } 324 325 w = spdk_jsonrpc_begin_result(request); 326 spdk_json_write_array_begin(w); 327 subsystem = spdk_nvmf_subsystem_get_first(tgt); 328 while (subsystem) { 329 dump_nvmf_subsystem(w, subsystem); 330 subsystem = spdk_nvmf_subsystem_get_next(subsystem); 331 } 332 spdk_json_write_array_end(w); 333 spdk_jsonrpc_end_result(request, w); 334 free(req.tgt_name); 335 } 336 SPDK_RPC_REGISTER("nvmf_get_subsystems", rpc_nvmf_get_subsystems, SPDK_RPC_RUNTIME) 337 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_subsystems, get_nvmf_subsystems) 338 339 struct rpc_subsystem_create { 340 char *nqn; 341 char *serial_number; 342 char *model_number; 343 char *tgt_name; 344 uint32_t max_namespaces; 345 bool allow_any_host; 346 bool ana_reporting; 347 }; 348 349 static const struct spdk_json_object_decoder rpc_subsystem_create_decoders[] = { 350 {"nqn", offsetof(struct rpc_subsystem_create, nqn), spdk_json_decode_string}, 351 {"serial_number", offsetof(struct rpc_subsystem_create, serial_number), spdk_json_decode_string, true}, 352 {"model_number", offsetof(struct rpc_subsystem_create, model_number), spdk_json_decode_string, true}, 353 {"tgt_name", offsetof(struct rpc_subsystem_create, tgt_name), spdk_json_decode_string, true}, 354 {"max_namespaces", offsetof(struct rpc_subsystem_create, max_namespaces), spdk_json_decode_uint32, true}, 355 {"allow_any_host", offsetof(struct rpc_subsystem_create, allow_any_host), spdk_json_decode_bool, true}, 356 {"ana_reporting", offsetof(struct rpc_subsystem_create, ana_reporting), spdk_json_decode_bool, true}, 357 }; 358 359 static void 360 rpc_nvmf_subsystem_started(struct spdk_nvmf_subsystem *subsystem, 361 void *cb_arg, int status) 362 { 363 struct spdk_jsonrpc_request *request = cb_arg; 364 365 if (!status) { 366 spdk_jsonrpc_send_bool_response(request, true); 367 } else { 368 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 369 "Subsystem %s start failed", 370 subsystem->subnqn); 371 spdk_nvmf_subsystem_destroy(subsystem); 372 } 373 } 374 375 static void 376 rpc_nvmf_create_subsystem(struct spdk_jsonrpc_request *request, 377 const struct spdk_json_val *params) 378 { 379 struct rpc_subsystem_create *req; 380 struct spdk_nvmf_subsystem *subsystem = NULL; 381 struct spdk_nvmf_tgt *tgt; 382 int rc = -1; 383 384 req = calloc(1, sizeof(*req)); 385 if (!req) { 386 SPDK_ERRLOG("Memory allocation failed\n"); 387 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 388 "Memory allocation failed"); 389 return; 390 } 391 392 if (spdk_json_decode_object(params, rpc_subsystem_create_decoders, 393 SPDK_COUNTOF(rpc_subsystem_create_decoders), 394 req)) { 395 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 396 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 397 goto cleanup; 398 } 399 400 tgt = spdk_nvmf_get_tgt(req->tgt_name); 401 if (!tgt) { 402 SPDK_ERRLOG("Unable to find target %s\n", req->tgt_name); 403 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 404 "Unable to find target %s", req->tgt_name); 405 goto cleanup; 406 } 407 408 subsystem = spdk_nvmf_subsystem_create(tgt, req->nqn, SPDK_NVMF_SUBTYPE_NVME, 409 req->max_namespaces); 410 if (!subsystem) { 411 SPDK_ERRLOG("Unable to create subsystem %s\n", req->nqn); 412 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 413 "Unable to create subsystem %s", req->nqn); 414 goto cleanup; 415 } 416 417 if (req->serial_number) { 418 if (spdk_nvmf_subsystem_set_sn(subsystem, req->serial_number)) { 419 SPDK_ERRLOG("Subsystem %s: invalid serial number '%s'\n", req->nqn, req->serial_number); 420 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 421 "Invalid SN %s", req->serial_number); 422 goto cleanup; 423 } 424 } 425 426 if (req->model_number) { 427 if (spdk_nvmf_subsystem_set_mn(subsystem, req->model_number)) { 428 SPDK_ERRLOG("Subsystem %s: invalid model number '%s'\n", req->nqn, req->model_number); 429 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 430 "Invalid MN %s", req->model_number); 431 goto cleanup; 432 } 433 } 434 435 spdk_nvmf_subsystem_set_allow_any_host(subsystem, req->allow_any_host); 436 437 spdk_nvmf_subsystem_set_ana_reporting(subsystem, req->ana_reporting); 438 439 rc = spdk_nvmf_subsystem_start(subsystem, 440 rpc_nvmf_subsystem_started, 441 request); 442 443 cleanup: 444 free(req->nqn); 445 free(req->tgt_name); 446 free(req->serial_number); 447 free(req->model_number); 448 free(req); 449 450 if (rc && subsystem) { 451 spdk_nvmf_subsystem_destroy(subsystem); 452 } 453 } 454 SPDK_RPC_REGISTER("nvmf_create_subsystem", rpc_nvmf_create_subsystem, SPDK_RPC_RUNTIME) 455 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_create_subsystem, nvmf_subsystem_create) 456 457 struct rpc_delete_subsystem { 458 char *nqn; 459 char *tgt_name; 460 }; 461 462 static void 463 free_rpc_delete_subsystem(struct rpc_delete_subsystem *r) 464 { 465 free(r->nqn); 466 free(r->tgt_name); 467 } 468 469 static void 470 rpc_nvmf_subsystem_stopped(struct spdk_nvmf_subsystem *subsystem, 471 void *cb_arg, int status) 472 { 473 struct spdk_jsonrpc_request *request = cb_arg; 474 475 nvmf_subsystem_remove_all_listeners(subsystem, true); 476 spdk_nvmf_subsystem_destroy(subsystem); 477 478 spdk_jsonrpc_send_bool_response(request, true); 479 } 480 481 static const struct spdk_json_object_decoder rpc_delete_subsystem_decoders[] = { 482 {"nqn", offsetof(struct rpc_delete_subsystem, nqn), spdk_json_decode_string}, 483 {"tgt_name", offsetof(struct rpc_delete_subsystem, tgt_name), spdk_json_decode_string, true}, 484 }; 485 486 static void 487 rpc_nvmf_delete_subsystem(struct spdk_jsonrpc_request *request, 488 const struct spdk_json_val *params) 489 { 490 struct rpc_delete_subsystem req = { 0 }; 491 struct spdk_nvmf_subsystem *subsystem; 492 struct spdk_nvmf_tgt *tgt; 493 int rc; 494 495 if (spdk_json_decode_object(params, rpc_delete_subsystem_decoders, 496 SPDK_COUNTOF(rpc_delete_subsystem_decoders), 497 &req)) { 498 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 499 goto invalid; 500 } 501 502 if (req.nqn == NULL) { 503 SPDK_ERRLOG("missing name param\n"); 504 goto invalid; 505 } 506 507 tgt = spdk_nvmf_get_tgt(req.tgt_name); 508 if (!tgt) { 509 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 510 "Unable to find a target."); 511 goto invalid_custom_response; 512 } 513 514 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, req.nqn); 515 if (!subsystem) { 516 goto invalid; 517 } 518 519 free_rpc_delete_subsystem(&req); 520 521 rc = spdk_nvmf_subsystem_stop(subsystem, 522 rpc_nvmf_subsystem_stopped, 523 request); 524 if (rc == -EBUSY) { 525 SPDK_ERRLOG("Subsystem currently in another state change try again later.\n"); 526 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 527 "Subsystem currently in another state change try again later."); 528 } else if (rc != 0) { 529 SPDK_ERRLOG("Unable to change state on subsystem. rc=%d\n", rc); 530 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 531 "Unable to change state on subsystem. rc=%d", rc); 532 } 533 534 return; 535 536 invalid: 537 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 538 invalid_custom_response: 539 free_rpc_delete_subsystem(&req); 540 } 541 SPDK_RPC_REGISTER("nvmf_delete_subsystem", rpc_nvmf_delete_subsystem, SPDK_RPC_RUNTIME) 542 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_delete_subsystem, delete_nvmf_subsystem) 543 544 struct rpc_listen_address { 545 char *transport; 546 char *adrfam; 547 char *traddr; 548 char *trsvcid; 549 }; 550 551 static const struct spdk_json_object_decoder rpc_listen_address_decoders[] = { 552 /* NOTE: "transport" is kept for compatibility; new code should use "trtype" */ 553 {"transport", offsetof(struct rpc_listen_address, transport), spdk_json_decode_string, true}, 554 {"trtype", offsetof(struct rpc_listen_address, transport), spdk_json_decode_string, true}, 555 {"adrfam", offsetof(struct rpc_listen_address, adrfam), spdk_json_decode_string, true}, 556 {"traddr", offsetof(struct rpc_listen_address, traddr), spdk_json_decode_string}, 557 {"trsvcid", offsetof(struct rpc_listen_address, trsvcid), spdk_json_decode_string, true}, 558 }; 559 560 static int 561 decode_rpc_listen_address(const struct spdk_json_val *val, void *out) 562 { 563 struct rpc_listen_address *req = (struct rpc_listen_address *)out; 564 if (spdk_json_decode_object(val, rpc_listen_address_decoders, 565 SPDK_COUNTOF(rpc_listen_address_decoders), 566 req)) { 567 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 568 return -1; 569 } 570 return 0; 571 } 572 573 static void 574 free_rpc_listen_address(struct rpc_listen_address *r) 575 { 576 free(r->transport); 577 free(r->adrfam); 578 free(r->traddr); 579 free(r->trsvcid); 580 } 581 582 enum nvmf_rpc_listen_op { 583 NVMF_RPC_LISTEN_ADD, 584 NVMF_RPC_LISTEN_REMOVE, 585 NVMF_RPC_LISTEN_SET_ANA_STATE, 586 }; 587 588 struct nvmf_rpc_listener_ctx { 589 char *nqn; 590 char *tgt_name; 591 struct spdk_nvmf_tgt *tgt; 592 struct spdk_nvmf_transport *transport; 593 struct spdk_nvmf_subsystem *subsystem; 594 struct rpc_listen_address address; 595 char *ana_state_str; 596 enum spdk_nvme_ana_state ana_state; 597 598 struct spdk_jsonrpc_request *request; 599 struct spdk_nvme_transport_id trid; 600 enum nvmf_rpc_listen_op op; 601 bool response_sent; 602 struct spdk_nvmf_listen_opts opts; 603 }; 604 605 static const struct spdk_json_object_decoder nvmf_rpc_listener_decoder[] = { 606 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 607 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 608 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 609 }; 610 611 static void 612 nvmf_rpc_listener_ctx_free(struct nvmf_rpc_listener_ctx *ctx) 613 { 614 free(ctx->nqn); 615 free(ctx->tgt_name); 616 free_rpc_listen_address(&ctx->address); 617 free(ctx->ana_state_str); 618 free(ctx); 619 } 620 621 static void 622 nvmf_rpc_listen_resumed(struct spdk_nvmf_subsystem *subsystem, 623 void *cb_arg, int status) 624 { 625 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 626 struct spdk_jsonrpc_request *request; 627 628 request = ctx->request; 629 if (ctx->response_sent) { 630 /* If an error occurred, the response has already been sent. */ 631 nvmf_rpc_listener_ctx_free(ctx); 632 return; 633 } 634 635 nvmf_rpc_listener_ctx_free(ctx); 636 637 spdk_jsonrpc_send_bool_response(request, true); 638 } 639 640 static void 641 nvmf_rpc_subsystem_listen(void *cb_arg, int status) 642 { 643 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 644 645 if (status) { 646 /* Destroy the listener that we just created. Ignore the error code because 647 * the RPC is failing already anyway. */ 648 spdk_nvmf_tgt_stop_listen(ctx->tgt, &ctx->trid); 649 650 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 651 "Invalid parameters"); 652 ctx->response_sent = true; 653 } 654 655 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 656 if (!ctx->response_sent) { 657 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 658 "Internal error"); 659 } 660 nvmf_rpc_listener_ctx_free(ctx); 661 /* Can't really do anything to recover here - subsystem will remain paused. */ 662 } 663 } 664 static void 665 nvmf_rpc_stop_listen_async_done(void *cb_arg, int status) 666 { 667 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 668 669 if (status) { 670 SPDK_ERRLOG("Unable to stop listener.\n"); 671 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 672 "error stopping listener: %d", status); 673 ctx->response_sent = true; 674 } 675 676 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 677 if (!ctx->response_sent) { 678 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 679 "Internal error"); 680 } 681 nvmf_rpc_listener_ctx_free(ctx); 682 /* Can't really do anything to recover here - subsystem will remain paused. */ 683 } 684 } 685 686 static void 687 nvmf_rpc_set_ana_state_done(void *cb_arg, int status) 688 { 689 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 690 691 if (status) { 692 SPDK_ERRLOG("Unable to set ANA state.\n"); 693 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 694 "error setting ANA state: %d", status); 695 ctx->response_sent = true; 696 } 697 698 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 699 if (!ctx->response_sent) { 700 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 701 "Internal error"); 702 } 703 nvmf_rpc_listener_ctx_free(ctx); 704 /* Can't really do anything to recover here - subsystem will remain paused. */ 705 } 706 } 707 708 static void 709 nvmf_rpc_listen_paused(struct spdk_nvmf_subsystem *subsystem, 710 void *cb_arg, int status) 711 { 712 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 713 int rc; 714 715 if (ctx->op == NVMF_RPC_LISTEN_ADD) { 716 if (!nvmf_subsystem_find_listener(subsystem, &ctx->trid)) { 717 rc = spdk_nvmf_tgt_listen_ext(ctx->tgt, &ctx->trid, &ctx->opts); 718 if (rc == 0) { 719 spdk_nvmf_subsystem_add_listener(ctx->subsystem, &ctx->trid, nvmf_rpc_subsystem_listen, ctx); 720 return; 721 } 722 723 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 724 "Invalid parameters"); 725 ctx->response_sent = true; 726 } 727 } else if (ctx->op == NVMF_RPC_LISTEN_REMOVE) { 728 if (spdk_nvmf_subsystem_remove_listener(subsystem, &ctx->trid)) { 729 SPDK_ERRLOG("Unable to remove listener.\n"); 730 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 731 "Invalid parameters"); 732 ctx->response_sent = true; 733 } 734 spdk_nvmf_transport_stop_listen_async(ctx->transport, &ctx->trid, nvmf_rpc_stop_listen_async_done, 735 ctx); 736 return; 737 } else if (ctx->op == NVMF_RPC_LISTEN_SET_ANA_STATE) { 738 nvmf_subsystem_set_ana_state(subsystem, &ctx->trid, ctx->ana_state, 739 nvmf_rpc_set_ana_state_done, ctx); 740 return; 741 } else { 742 SPDK_UNREACHABLE(); 743 } 744 745 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_listen_resumed, ctx)) { 746 if (!ctx->response_sent) { 747 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 748 "Internal error"); 749 } 750 nvmf_rpc_listener_ctx_free(ctx); 751 /* Can't really do anything to recover here - subsystem will remain paused. */ 752 } 753 } 754 755 static int 756 rpc_listen_address_to_trid(const struct rpc_listen_address *address, 757 struct spdk_nvme_transport_id *trid) 758 { 759 size_t len; 760 761 memset(trid, 0, sizeof(*trid)); 762 763 if (spdk_nvme_transport_id_populate_trstring(trid, address->transport)) { 764 SPDK_ERRLOG("Invalid transport string: %s\n", address->transport); 765 return -EINVAL; 766 } 767 768 if (spdk_nvme_transport_id_parse_trtype(&trid->trtype, address->transport)) { 769 SPDK_ERRLOG("Invalid transport type: %s\n", address->transport); 770 return -EINVAL; 771 } 772 773 if (address->adrfam) { 774 if (spdk_nvme_transport_id_parse_adrfam(&trid->adrfam, address->adrfam)) { 775 SPDK_ERRLOG("Invalid adrfam: %s\n", address->adrfam); 776 return -EINVAL; 777 } 778 } else { 779 trid->adrfam = SPDK_NVMF_ADRFAM_IPV4; 780 } 781 782 len = strlen(address->traddr); 783 if (len > sizeof(trid->traddr) - 1) { 784 SPDK_ERRLOG("Transport address longer than %zu characters: %s\n", 785 sizeof(trid->traddr) - 1, address->traddr); 786 return -EINVAL; 787 } 788 memcpy(trid->traddr, address->traddr, len + 1); 789 790 trid->trsvcid[0] = '\0'; 791 if (address->trsvcid) { 792 len = strlen(address->trsvcid); 793 if (len > sizeof(trid->trsvcid) - 1) { 794 SPDK_ERRLOG("Transport service id longer than %zu characters: %s\n", 795 sizeof(trid->trsvcid) - 1, address->trsvcid); 796 return -EINVAL; 797 } 798 memcpy(trid->trsvcid, address->trsvcid, len + 1); 799 } 800 801 return 0; 802 } 803 804 static void 805 rpc_nvmf_subsystem_add_listener(struct spdk_jsonrpc_request *request, 806 const struct spdk_json_val *params) 807 { 808 struct nvmf_rpc_listener_ctx *ctx; 809 struct spdk_nvmf_subsystem *subsystem; 810 struct spdk_nvmf_tgt *tgt; 811 int rc; 812 813 ctx = calloc(1, sizeof(*ctx)); 814 if (!ctx) { 815 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 816 return; 817 } 818 819 ctx->request = request; 820 821 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_listener_decoder, 822 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 823 ctx)) { 824 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 825 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 826 nvmf_rpc_listener_ctx_free(ctx); 827 return; 828 } 829 830 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 831 if (!tgt) { 832 SPDK_ERRLOG("Unable to find a target object.\n"); 833 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 834 "Unable to find a target."); 835 nvmf_rpc_listener_ctx_free(ctx); 836 return; 837 } 838 ctx->tgt = tgt; 839 840 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 841 if (!subsystem) { 842 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 843 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 844 nvmf_rpc_listener_ctx_free(ctx); 845 return; 846 } 847 848 ctx->subsystem = subsystem; 849 850 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 851 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 852 "Invalid parameters"); 853 nvmf_rpc_listener_ctx_free(ctx); 854 return; 855 } 856 857 ctx->op = NVMF_RPC_LISTEN_ADD; 858 spdk_nvmf_listen_opts_init(&ctx->opts, sizeof(ctx->opts)); 859 ctx->opts.transport_specific = params; 860 861 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx); 862 if (rc != 0) { 863 if (rc == -EBUSY) { 864 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 865 "subsystem busy, retry later.\n"); 866 } else { 867 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 868 } 869 nvmf_rpc_listener_ctx_free(ctx); 870 } 871 } 872 SPDK_RPC_REGISTER("nvmf_subsystem_add_listener", rpc_nvmf_subsystem_add_listener, 873 SPDK_RPC_RUNTIME); 874 875 static void 876 rpc_nvmf_subsystem_remove_listener(struct spdk_jsonrpc_request *request, 877 const struct spdk_json_val *params) 878 { 879 struct nvmf_rpc_listener_ctx *ctx; 880 struct spdk_nvmf_subsystem *subsystem; 881 struct spdk_nvmf_tgt *tgt; 882 int rc; 883 884 ctx = calloc(1, sizeof(*ctx)); 885 if (!ctx) { 886 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 887 return; 888 } 889 890 ctx->request = request; 891 892 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 893 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 894 ctx)) { 895 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 896 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 897 nvmf_rpc_listener_ctx_free(ctx); 898 return; 899 } 900 901 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 902 if (!tgt) { 903 SPDK_ERRLOG("Unable to find a target object.\n"); 904 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 905 "Unable to find a target."); 906 nvmf_rpc_listener_ctx_free(ctx); 907 return; 908 } 909 ctx->tgt = tgt; 910 911 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 912 if (!subsystem) { 913 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 914 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 915 nvmf_rpc_listener_ctx_free(ctx); 916 return; 917 } 918 919 ctx->subsystem = subsystem; 920 921 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 922 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 923 "Invalid parameters"); 924 nvmf_rpc_listener_ctx_free(ctx); 925 return; 926 } 927 928 ctx->transport = spdk_nvmf_tgt_get_transport(tgt, ctx->trid.trstring); 929 if (!ctx->transport) { 930 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 931 ctx->trid.trstring); 932 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 933 "Invalid parameters"); 934 nvmf_rpc_listener_ctx_free(ctx); 935 return; 936 } 937 938 ctx->op = NVMF_RPC_LISTEN_REMOVE; 939 940 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx); 941 if (rc != 0) { 942 if (rc == -EBUSY) { 943 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 944 "subsystem busy, retry later.\n"); 945 } else { 946 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 947 } 948 nvmf_rpc_listener_ctx_free(ctx); 949 } 950 } 951 SPDK_RPC_REGISTER("nvmf_subsystem_remove_listener", rpc_nvmf_subsystem_remove_listener, 952 SPDK_RPC_RUNTIME); 953 954 static const struct spdk_json_object_decoder nvmf_rpc_set_ana_state_decoder[] = { 955 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 956 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 957 {"ana_state", offsetof(struct nvmf_rpc_listener_ctx, ana_state_str), spdk_json_decode_string}, 958 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 959 }; 960 961 static int 962 rpc_ana_state_parse(const char *str, enum spdk_nvme_ana_state *ana_state) 963 { 964 if (ana_state == NULL || str == NULL) { 965 return -EINVAL; 966 } 967 968 if (strcasecmp(str, "optimized") == 0) { 969 *ana_state = SPDK_NVME_ANA_OPTIMIZED_STATE; 970 } else if (strcasecmp(str, "non_optimized") == 0) { 971 *ana_state = SPDK_NVME_ANA_NON_OPTIMIZED_STATE; 972 } else if (strcasecmp(str, "inaccessible") == 0) { 973 *ana_state = SPDK_NVME_ANA_INACCESSIBLE_STATE; 974 } else { 975 return -ENOENT; 976 } 977 978 return 0; 979 } 980 981 static void 982 rpc_nvmf_subsystem_listener_set_ana_state(struct spdk_jsonrpc_request *request, 983 const struct spdk_json_val *params) 984 { 985 struct nvmf_rpc_listener_ctx *ctx; 986 struct spdk_nvmf_subsystem *subsystem; 987 struct spdk_nvmf_tgt *tgt; 988 989 ctx = calloc(1, sizeof(*ctx)); 990 if (!ctx) { 991 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 992 "Out of memory"); 993 return; 994 } 995 996 ctx->request = request; 997 998 if (spdk_json_decode_object(params, nvmf_rpc_set_ana_state_decoder, 999 SPDK_COUNTOF(nvmf_rpc_set_ana_state_decoder), 1000 ctx)) { 1001 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1002 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1003 "Invalid parameters"); 1004 nvmf_rpc_listener_ctx_free(ctx); 1005 return; 1006 } 1007 1008 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1009 if (!tgt) { 1010 SPDK_ERRLOG("Unable to find a target object.\n"); 1011 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1012 "Unable to find a target.\n"); 1013 nvmf_rpc_listener_ctx_free(ctx); 1014 return; 1015 } 1016 1017 ctx->tgt = tgt; 1018 1019 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1020 if (!subsystem) { 1021 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1022 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1023 "Unable to find subsystem with NQN %s", 1024 ctx->nqn); 1025 nvmf_rpc_listener_ctx_free(ctx); 1026 return; 1027 } 1028 1029 ctx->subsystem = subsystem; 1030 1031 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 1032 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1033 "Invalid parameters"); 1034 nvmf_rpc_listener_ctx_free(ctx); 1035 return; 1036 } 1037 1038 if (rpc_ana_state_parse(ctx->ana_state_str, &ctx->ana_state)) { 1039 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1040 "Invalid parameters"); 1041 nvmf_rpc_listener_ctx_free(ctx); 1042 return; 1043 } 1044 1045 ctx->op = NVMF_RPC_LISTEN_SET_ANA_STATE; 1046 1047 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 1048 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1049 "Internal error"); 1050 nvmf_rpc_listener_ctx_free(ctx); 1051 } 1052 } 1053 SPDK_RPC_REGISTER("nvmf_subsystem_listener_set_ana_state", 1054 rpc_nvmf_subsystem_listener_set_ana_state, SPDK_RPC_RUNTIME); 1055 1056 struct spdk_nvmf_ns_params { 1057 char *bdev_name; 1058 char *ptpl_file; 1059 uint32_t nsid; 1060 char nguid[16]; 1061 char eui64[8]; 1062 struct spdk_uuid uuid; 1063 }; 1064 1065 static const struct spdk_json_object_decoder rpc_ns_params_decoders[] = { 1066 {"nsid", offsetof(struct spdk_nvmf_ns_params, nsid), spdk_json_decode_uint32, true}, 1067 {"bdev_name", offsetof(struct spdk_nvmf_ns_params, bdev_name), spdk_json_decode_string}, 1068 {"ptpl_file", offsetof(struct spdk_nvmf_ns_params, ptpl_file), spdk_json_decode_string, true}, 1069 {"nguid", offsetof(struct spdk_nvmf_ns_params, nguid), decode_ns_nguid, true}, 1070 {"eui64", offsetof(struct spdk_nvmf_ns_params, eui64), decode_ns_eui64, true}, 1071 {"uuid", offsetof(struct spdk_nvmf_ns_params, uuid), decode_ns_uuid, true}, 1072 }; 1073 1074 static int 1075 decode_rpc_ns_params(const struct spdk_json_val *val, void *out) 1076 { 1077 struct spdk_nvmf_ns_params *ns_params = out; 1078 1079 return spdk_json_decode_object(val, rpc_ns_params_decoders, 1080 SPDK_COUNTOF(rpc_ns_params_decoders), 1081 ns_params); 1082 } 1083 1084 struct nvmf_rpc_ns_ctx { 1085 char *nqn; 1086 char *tgt_name; 1087 struct spdk_nvmf_ns_params ns_params; 1088 1089 struct spdk_jsonrpc_request *request; 1090 bool response_sent; 1091 }; 1092 1093 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ns_decoder[] = { 1094 {"nqn", offsetof(struct nvmf_rpc_ns_ctx, nqn), spdk_json_decode_string}, 1095 {"namespace", offsetof(struct nvmf_rpc_ns_ctx, ns_params), decode_rpc_ns_params}, 1096 {"tgt_name", offsetof(struct nvmf_rpc_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1097 }; 1098 1099 static void 1100 nvmf_rpc_ns_ctx_free(struct nvmf_rpc_ns_ctx *ctx) 1101 { 1102 free(ctx->nqn); 1103 free(ctx->tgt_name); 1104 free(ctx->ns_params.bdev_name); 1105 free(ctx->ns_params.ptpl_file); 1106 free(ctx); 1107 } 1108 1109 static void 1110 nvmf_rpc_ns_failback_resumed(struct spdk_nvmf_subsystem *subsystem, 1111 void *cb_arg, int status) 1112 { 1113 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1114 struct spdk_jsonrpc_request *request = ctx->request; 1115 1116 if (status) { 1117 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1118 "Unable to add ns, subsystem in invalid state"); 1119 } else { 1120 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1121 "Unable to add ns, subsystem in active state"); 1122 } 1123 1124 nvmf_rpc_ns_ctx_free(ctx); 1125 } 1126 1127 static void 1128 nvmf_rpc_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1129 void *cb_arg, int status) 1130 { 1131 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1132 struct spdk_jsonrpc_request *request = ctx->request; 1133 uint32_t nsid = ctx->ns_params.nsid; 1134 bool response_sent = ctx->response_sent; 1135 struct spdk_json_write_ctx *w; 1136 int rc; 1137 1138 /* The case where the call to add the namespace was successful, but the subsystem couldn't be resumed. */ 1139 if (status && !ctx->response_sent) { 1140 rc = spdk_nvmf_subsystem_remove_ns(subsystem, nsid); 1141 if (rc != 0) { 1142 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1143 "Unable to add ns, subsystem in invalid state"); 1144 nvmf_rpc_ns_ctx_free(ctx); 1145 return; 1146 } 1147 1148 rc = spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_failback_resumed, ctx); 1149 if (rc != 0) { 1150 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1151 nvmf_rpc_ns_ctx_free(ctx); 1152 return; 1153 } 1154 1155 return; 1156 } 1157 1158 nvmf_rpc_ns_ctx_free(ctx); 1159 1160 if (response_sent) { 1161 return; 1162 } 1163 1164 w = spdk_jsonrpc_begin_result(request); 1165 spdk_json_write_uint32(w, nsid); 1166 spdk_jsonrpc_end_result(request, w); 1167 } 1168 1169 static void 1170 nvmf_rpc_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1171 void *cb_arg, int status) 1172 { 1173 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1174 struct spdk_nvmf_ns_opts ns_opts; 1175 1176 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 1177 ns_opts.nsid = ctx->ns_params.nsid; 1178 1179 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 1180 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 1181 1182 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 1183 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 1184 1185 if (!spdk_mem_all_zero(&ctx->ns_params.uuid, sizeof(ctx->ns_params.uuid))) { 1186 ns_opts.uuid = ctx->ns_params.uuid; 1187 } 1188 1189 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns_ext(subsystem, ctx->ns_params.bdev_name, 1190 &ns_opts, sizeof(ns_opts), 1191 ctx->ns_params.ptpl_file); 1192 if (ctx->ns_params.nsid == 0) { 1193 SPDK_ERRLOG("Unable to add namespace\n"); 1194 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1195 "Invalid parameters"); 1196 ctx->response_sent = true; 1197 goto resume; 1198 } 1199 1200 resume: 1201 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 1202 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1203 nvmf_rpc_ns_ctx_free(ctx); 1204 } 1205 } 1206 1207 static void 1208 rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 1209 const struct spdk_json_val *params) 1210 { 1211 struct nvmf_rpc_ns_ctx *ctx; 1212 struct spdk_nvmf_subsystem *subsystem; 1213 struct spdk_nvmf_tgt *tgt; 1214 int rc; 1215 1216 ctx = calloc(1, sizeof(*ctx)); 1217 if (!ctx) { 1218 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1219 return; 1220 } 1221 1222 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ns_decoder, 1223 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), 1224 ctx)) { 1225 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1226 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1227 nvmf_rpc_ns_ctx_free(ctx); 1228 return; 1229 } 1230 1231 ctx->request = request; 1232 ctx->response_sent = false; 1233 1234 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1235 if (!tgt) { 1236 SPDK_ERRLOG("Unable to find a target object.\n"); 1237 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1238 "Unable to find a target."); 1239 nvmf_rpc_ns_ctx_free(ctx); 1240 return; 1241 } 1242 1243 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1244 if (!subsystem) { 1245 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1246 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1247 nvmf_rpc_ns_ctx_free(ctx); 1248 return; 1249 } 1250 1251 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_ns_paused, ctx); 1252 if (rc != 0) { 1253 if (rc == -EBUSY) { 1254 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1255 "subsystem busy, retry later.\n"); 1256 } else { 1257 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1258 } 1259 nvmf_rpc_ns_ctx_free(ctx); 1260 } 1261 } 1262 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1263 1264 struct nvmf_rpc_remove_ns_ctx { 1265 char *nqn; 1266 char *tgt_name; 1267 uint32_t nsid; 1268 1269 struct spdk_jsonrpc_request *request; 1270 bool response_sent; 1271 }; 1272 1273 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1274 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1275 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1276 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1277 }; 1278 1279 static void 1280 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1281 { 1282 free(ctx->nqn); 1283 free(ctx->tgt_name); 1284 free(ctx); 1285 } 1286 1287 static void 1288 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1289 void *cb_arg, int status) 1290 { 1291 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1292 struct spdk_jsonrpc_request *request = ctx->request; 1293 bool response_sent = ctx->response_sent; 1294 1295 nvmf_rpc_remove_ns_ctx_free(ctx); 1296 1297 if (response_sent) { 1298 return; 1299 } 1300 1301 spdk_jsonrpc_send_bool_response(request, true); 1302 } 1303 1304 static void 1305 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1306 void *cb_arg, int status) 1307 { 1308 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1309 int ret; 1310 1311 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1312 if (ret < 0) { 1313 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1314 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1315 "Invalid parameters"); 1316 ctx->response_sent = true; 1317 } 1318 1319 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1320 if (!ctx->response_sent) { 1321 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1322 } 1323 nvmf_rpc_remove_ns_ctx_free(ctx); 1324 } 1325 } 1326 1327 static void 1328 rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1329 const struct spdk_json_val *params) 1330 { 1331 struct nvmf_rpc_remove_ns_ctx *ctx; 1332 struct spdk_nvmf_subsystem *subsystem; 1333 struct spdk_nvmf_tgt *tgt; 1334 int rc; 1335 1336 ctx = calloc(1, sizeof(*ctx)); 1337 if (!ctx) { 1338 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1339 return; 1340 } 1341 1342 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1343 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1344 ctx)) { 1345 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1346 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1347 nvmf_rpc_remove_ns_ctx_free(ctx); 1348 return; 1349 } 1350 1351 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1352 if (!tgt) { 1353 SPDK_ERRLOG("Unable to find a target object.\n"); 1354 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1355 "Unable to find a target."); 1356 nvmf_rpc_remove_ns_ctx_free(ctx); 1357 return; 1358 } 1359 1360 ctx->request = request; 1361 ctx->response_sent = false; 1362 1363 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1364 if (!subsystem) { 1365 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1366 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1367 nvmf_rpc_remove_ns_ctx_free(ctx); 1368 return; 1369 } 1370 1371 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_remove_ns_paused, ctx); 1372 if (rc != 0) { 1373 if (rc == -EBUSY) { 1374 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1375 "subsystem busy, retry later.\n"); 1376 } else { 1377 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1378 } 1379 nvmf_rpc_remove_ns_ctx_free(ctx); 1380 } 1381 } 1382 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1383 1384 struct nvmf_rpc_host_ctx { 1385 struct spdk_jsonrpc_request *request; 1386 char *nqn; 1387 char *host; 1388 char *tgt_name; 1389 bool allow_any_host; 1390 }; 1391 1392 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1393 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1394 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1395 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1396 }; 1397 1398 static void 1399 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1400 { 1401 free(ctx->nqn); 1402 free(ctx->host); 1403 free(ctx->tgt_name); 1404 } 1405 1406 static void 1407 rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1408 const struct spdk_json_val *params) 1409 { 1410 struct nvmf_rpc_host_ctx ctx = {}; 1411 struct spdk_nvmf_subsystem *subsystem; 1412 struct spdk_nvmf_tgt *tgt; 1413 int rc; 1414 1415 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1416 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1417 &ctx)) { 1418 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1419 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1420 nvmf_rpc_host_ctx_free(&ctx); 1421 return; 1422 } 1423 1424 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1425 if (!tgt) { 1426 SPDK_ERRLOG("Unable to find a target object.\n"); 1427 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1428 "Unable to find a target."); 1429 nvmf_rpc_host_ctx_free(&ctx); 1430 return; 1431 } 1432 1433 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 1434 if (!subsystem) { 1435 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx.nqn); 1436 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1437 nvmf_rpc_host_ctx_free(&ctx); 1438 return; 1439 } 1440 1441 rc = spdk_nvmf_subsystem_add_host(subsystem, ctx.host); 1442 if (rc != 0) { 1443 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1444 nvmf_rpc_host_ctx_free(&ctx); 1445 return; 1446 } 1447 1448 spdk_jsonrpc_send_bool_response(request, true); 1449 nvmf_rpc_host_ctx_free(&ctx); 1450 } 1451 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 1452 1453 static void 1454 rpc_nvmf_subsystem_remove_host_done(void *_ctx, int status) 1455 { 1456 struct nvmf_rpc_host_ctx *ctx = _ctx; 1457 1458 spdk_jsonrpc_send_bool_response(ctx->request, true); 1459 nvmf_rpc_host_ctx_free(ctx); 1460 free(ctx); 1461 } 1462 1463 static void 1464 rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 1465 const struct spdk_json_val *params) 1466 { 1467 struct nvmf_rpc_host_ctx *ctx; 1468 struct spdk_nvmf_subsystem *subsystem; 1469 struct spdk_nvmf_tgt *tgt; 1470 int rc; 1471 1472 ctx = calloc(1, sizeof(*ctx)); 1473 if (ctx == NULL) { 1474 SPDK_ERRLOG("Unable to allocate context to perform RPC\n"); 1475 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1476 return; 1477 } 1478 1479 ctx->request = request; 1480 1481 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1482 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1483 ctx)) { 1484 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1485 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1486 nvmf_rpc_host_ctx_free(ctx); 1487 free(ctx); 1488 return; 1489 } 1490 1491 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1492 if (!tgt) { 1493 SPDK_ERRLOG("Unable to find a target object.\n"); 1494 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1495 "Unable to find a target."); 1496 nvmf_rpc_host_ctx_free(ctx); 1497 free(ctx); 1498 return; 1499 } 1500 1501 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1502 if (!subsystem) { 1503 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1504 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1505 nvmf_rpc_host_ctx_free(ctx); 1506 free(ctx); 1507 return; 1508 } 1509 1510 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 1511 if (rc != 0) { 1512 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1513 nvmf_rpc_host_ctx_free(ctx); 1514 free(ctx); 1515 return; 1516 } 1517 1518 rc = spdk_nvmf_subsystem_disconnect_host(subsystem, ctx->host, 1519 rpc_nvmf_subsystem_remove_host_done, 1520 ctx); 1521 if (rc != 0) { 1522 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1523 nvmf_rpc_host_ctx_free(ctx); 1524 free(ctx); 1525 return; 1526 } 1527 } 1528 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", rpc_nvmf_subsystem_remove_host, 1529 SPDK_RPC_RUNTIME) 1530 1531 1532 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 1533 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1534 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 1535 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1536 }; 1537 1538 static void 1539 rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 1540 const struct spdk_json_val *params) 1541 { 1542 struct nvmf_rpc_host_ctx ctx = {}; 1543 struct spdk_nvmf_subsystem *subsystem; 1544 struct spdk_nvmf_tgt *tgt; 1545 int rc; 1546 1547 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 1548 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 1549 &ctx)) { 1550 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1551 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1552 nvmf_rpc_host_ctx_free(&ctx); 1553 return; 1554 } 1555 1556 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1557 if (!tgt) { 1558 SPDK_ERRLOG("Unable to find a target object.\n"); 1559 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1560 "Unable to find a target."); 1561 nvmf_rpc_host_ctx_free(&ctx); 1562 return; 1563 } 1564 1565 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 1566 if (!subsystem) { 1567 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx.nqn); 1568 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1569 nvmf_rpc_host_ctx_free(&ctx); 1570 return; 1571 } 1572 1573 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx.allow_any_host); 1574 if (rc != 0) { 1575 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1576 nvmf_rpc_host_ctx_free(&ctx); 1577 return; 1578 } 1579 1580 spdk_jsonrpc_send_bool_response(request, true); 1581 nvmf_rpc_host_ctx_free(&ctx); 1582 } 1583 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", rpc_nvmf_subsystem_allow_any_host, 1584 SPDK_RPC_RUNTIME) 1585 1586 struct nvmf_rpc_target_ctx { 1587 char *name; 1588 uint32_t max_subsystems; 1589 }; 1590 1591 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 1592 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1593 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 1594 }; 1595 1596 static void 1597 rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 1598 const struct spdk_json_val *params) 1599 { 1600 struct spdk_nvmf_target_opts opts; 1601 struct nvmf_rpc_target_ctx ctx = {0}; 1602 struct spdk_nvmf_tgt *tgt; 1603 struct spdk_json_write_ctx *w; 1604 1605 /* Decode parameters the first time to get the transport type */ 1606 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 1607 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 1608 &ctx)) { 1609 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1610 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1611 free(ctx.name); 1612 return; 1613 } 1614 1615 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 1616 opts.max_subsystems = ctx.max_subsystems; 1617 1618 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 1619 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1620 "Target already exists."); 1621 free(ctx.name); 1622 return; 1623 } 1624 1625 tgt = spdk_nvmf_tgt_create(&opts); 1626 1627 if (tgt == NULL) { 1628 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1629 "Unable to create the requested target."); 1630 free(ctx.name); 1631 return; 1632 } 1633 1634 w = spdk_jsonrpc_begin_result(request); 1635 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 1636 spdk_jsonrpc_end_result(request, w); 1637 free(ctx.name); 1638 } 1639 SPDK_RPC_REGISTER("nvmf_create_target", rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 1640 1641 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 1642 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1643 }; 1644 1645 static void 1646 nvmf_rpc_destroy_target_done(void *ctx, int status) 1647 { 1648 struct spdk_jsonrpc_request *request = ctx; 1649 1650 spdk_jsonrpc_send_bool_response(request, true); 1651 } 1652 1653 static void 1654 rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 1655 const struct spdk_json_val *params) 1656 { 1657 struct nvmf_rpc_target_ctx ctx = {0}; 1658 struct spdk_nvmf_tgt *tgt; 1659 1660 /* Decode parameters the first time to get the transport type */ 1661 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 1662 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 1663 &ctx)) { 1664 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1665 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1666 free(ctx.name); 1667 return; 1668 } 1669 1670 tgt = spdk_nvmf_get_tgt(ctx.name); 1671 1672 if (tgt == NULL) { 1673 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1674 "The specified target doesn't exist, cannot delete it."); 1675 free(ctx.name); 1676 return; 1677 } 1678 1679 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 1680 free(ctx.name); 1681 } 1682 SPDK_RPC_REGISTER("nvmf_delete_target", rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 1683 1684 static void 1685 rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 1686 const struct spdk_json_val *params) 1687 { 1688 struct spdk_json_write_ctx *w; 1689 struct spdk_nvmf_tgt *tgt; 1690 const char *name; 1691 1692 if (params != NULL) { 1693 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1694 "nvmf_get_targets has no parameters."); 1695 return; 1696 } 1697 1698 w = spdk_jsonrpc_begin_result(request); 1699 spdk_json_write_array_begin(w); 1700 1701 tgt = spdk_nvmf_get_first_tgt(); 1702 1703 while (tgt != NULL) { 1704 name = spdk_nvmf_tgt_get_name(tgt); 1705 spdk_json_write_string(w, name); 1706 tgt = spdk_nvmf_get_next_tgt(tgt); 1707 } 1708 1709 spdk_json_write_array_end(w); 1710 spdk_jsonrpc_end_result(request, w); 1711 } 1712 SPDK_RPC_REGISTER("nvmf_get_targets", rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 1713 1714 struct nvmf_rpc_create_transport_ctx { 1715 char *trtype; 1716 char *tgt_name; 1717 struct spdk_nvmf_transport_opts opts; 1718 struct spdk_jsonrpc_request *request; 1719 }; 1720 1721 /** 1722 * `max_qpairs_per_ctrlr` represents both admin and IO qpairs, that confuses 1723 * users when they configure a transport using RPC. So it was decided to 1724 * deprecate `max_qpairs_per_ctrlr` RPC parameter and use `max_io_qpairs_per_ctrlr` 1725 * But internal logic remains unchanged and SPDK expects that 1726 * spdk_nvmf_transport_opts::max_qpairs_per_ctrlr includes an admin qpair. 1727 * This function parses the number of IO qpairs and adds +1 for admin qpair. 1728 */ 1729 static int 1730 nvmf_rpc_decode_max_io_qpairs(const struct spdk_json_val *val, void *out) 1731 { 1732 uint16_t *i = out; 1733 int rc; 1734 1735 rc = spdk_json_number_to_uint16(val, i); 1736 if (rc == 0) { 1737 (*i)++; 1738 } 1739 1740 return rc; 1741 } 1742 1743 /** 1744 * This function parses deprecated `max_qpairs_per_ctrlr` and warns the user to use 1745 * the new parameter `max_io_qpairs_per_ctrlr` 1746 */ 1747 static int 1748 nvmf_rpc_decode_max_qpairs(const struct spdk_json_val *val, void *out) 1749 { 1750 uint16_t *i = out; 1751 int rc; 1752 1753 rc = spdk_json_number_to_uint16(val, i); 1754 if (rc == 0) { 1755 SPDK_WARNLOG("Parameter max_qpairs_per_ctrlr is deprecated, use max_io_qpairs_per_ctrlr instead.\n"); 1756 } 1757 1758 return rc; 1759 } 1760 1761 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 1762 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 1763 { 1764 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 1765 spdk_json_decode_uint16, true 1766 }, 1767 { 1768 "max_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1769 nvmf_rpc_decode_max_qpairs, true 1770 }, 1771 { 1772 "max_io_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1773 nvmf_rpc_decode_max_io_qpairs, true 1774 }, 1775 { 1776 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 1777 spdk_json_decode_uint32, true 1778 }, 1779 { 1780 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 1781 spdk_json_decode_uint32, true 1782 }, 1783 { 1784 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 1785 spdk_json_decode_uint32, true 1786 }, 1787 { 1788 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 1789 spdk_json_decode_uint32, true 1790 }, 1791 { 1792 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 1793 spdk_json_decode_uint32, true 1794 }, 1795 { 1796 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 1797 spdk_json_decode_uint32, true 1798 }, 1799 { 1800 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 1801 spdk_json_decode_bool, true 1802 }, 1803 { 1804 "abort_timeout_sec", offsetof(struct nvmf_rpc_create_transport_ctx, opts.abort_timeout_sec), 1805 spdk_json_decode_uint32, true 1806 }, 1807 { 1808 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 1809 spdk_json_decode_string, true 1810 }, 1811 }; 1812 1813 static void 1814 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 1815 { 1816 free(ctx->trtype); 1817 free(ctx->tgt_name); 1818 free(ctx); 1819 } 1820 1821 static void 1822 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 1823 { 1824 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 1825 struct spdk_jsonrpc_request *request; 1826 1827 request = ctx->request; 1828 nvmf_rpc_create_transport_ctx_free(ctx); 1829 1830 if (status) { 1831 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 1832 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1833 "Failed to add transport to tgt.(%d)", 1834 status); 1835 return; 1836 } 1837 1838 spdk_jsonrpc_send_bool_response(request, true); 1839 } 1840 1841 static void 1842 rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 1843 const struct spdk_json_val *params) 1844 { 1845 struct nvmf_rpc_create_transport_ctx *ctx; 1846 enum spdk_nvme_transport_type trtype; 1847 struct spdk_nvmf_transport *transport; 1848 struct spdk_nvmf_tgt *tgt; 1849 1850 ctx = calloc(1, sizeof(*ctx)); 1851 if (!ctx) { 1852 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1853 return; 1854 } 1855 1856 /* Decode parameters the first time to get the transport type */ 1857 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_create_transport_decoder, 1858 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1859 ctx)) { 1860 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 1861 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1862 nvmf_rpc_create_transport_ctx_free(ctx); 1863 return; 1864 } 1865 1866 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1867 if (!tgt) { 1868 SPDK_ERRLOG("Unable to find a target object.\n"); 1869 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1870 "Unable to find a target."); 1871 nvmf_rpc_create_transport_ctx_free(ctx); 1872 return; 1873 } 1874 1875 if (spdk_nvme_transport_id_parse_trtype(&trtype, ctx->trtype)) { 1876 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1877 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1878 "Invalid transport type '%s'", ctx->trtype); 1879 nvmf_rpc_create_transport_ctx_free(ctx); 1880 return; 1881 } 1882 1883 /* Initialize all the transport options (based on transport type) and decode the 1884 * parameters again to update any options passed in rpc create transport call. 1885 */ 1886 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts, sizeof(ctx->opts))) { 1887 /* This can happen if user specifies PCIE transport type which isn't valid for 1888 * NVMe-oF. 1889 */ 1890 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1891 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1892 "Invalid transport type '%s'", ctx->trtype); 1893 nvmf_rpc_create_transport_ctx_free(ctx); 1894 return; 1895 } 1896 1897 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_create_transport_decoder, 1898 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1899 ctx)) { 1900 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 1901 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1902 nvmf_rpc_create_transport_ctx_free(ctx); 1903 return; 1904 } 1905 1906 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 1907 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 1908 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1909 "Transport type '%s' already exists", ctx->trtype); 1910 nvmf_rpc_create_transport_ctx_free(ctx); 1911 return; 1912 } 1913 1914 /* Transport can parse additional params themselves */ 1915 ctx->opts.transport_specific = params; 1916 1917 transport = spdk_nvmf_transport_create(ctx->trtype, &ctx->opts); 1918 1919 if (!transport) { 1920 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 1921 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1922 "Transport type '%s' create failed", ctx->trtype); 1923 nvmf_rpc_create_transport_ctx_free(ctx); 1924 return; 1925 } 1926 1927 /* add transport to target */ 1928 ctx->request = request; 1929 spdk_nvmf_tgt_add_transport(tgt, transport, nvmf_rpc_tgt_add_transport_done, ctx); 1930 } 1931 SPDK_RPC_REGISTER("nvmf_create_transport", rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 1932 1933 static void 1934 dump_nvmf_transport(struct spdk_json_write_ctx *w, struct spdk_nvmf_transport *transport) 1935 { 1936 const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport); 1937 1938 spdk_json_write_object_begin(w); 1939 1940 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport)); 1941 spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth); 1942 spdk_json_write_named_uint32(w, "max_io_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr - 1); 1943 spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size); 1944 spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size); 1945 spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size); 1946 spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth); 1947 spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers); 1948 spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size); 1949 spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip); 1950 1951 if (transport->ops->dump_opts) { 1952 transport->ops->dump_opts(transport, w); 1953 } 1954 1955 spdk_json_write_named_uint32(w, "abort_timeout_sec", opts->abort_timeout_sec); 1956 1957 spdk_json_write_object_end(w); 1958 } 1959 1960 struct rpc_get_transport { 1961 char *tgt_name; 1962 }; 1963 1964 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 1965 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 1966 }; 1967 1968 static void 1969 rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 1970 const struct spdk_json_val *params) 1971 { 1972 struct rpc_get_transport req = { 0 }; 1973 struct spdk_json_write_ctx *w; 1974 struct spdk_nvmf_transport *transport; 1975 struct spdk_nvmf_tgt *tgt; 1976 1977 if (params) { 1978 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 1979 SPDK_COUNTOF(rpc_get_transport_decoders), 1980 &req)) { 1981 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1982 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1983 return; 1984 } 1985 } 1986 1987 tgt = spdk_nvmf_get_tgt(req.tgt_name); 1988 if (!tgt) { 1989 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1990 "Unable to find a target."); 1991 free(req.tgt_name); 1992 return; 1993 } 1994 1995 w = spdk_jsonrpc_begin_result(request); 1996 spdk_json_write_array_begin(w); 1997 transport = spdk_nvmf_transport_get_first(tgt); 1998 while (transport) { 1999 dump_nvmf_transport(w, transport); 2000 transport = spdk_nvmf_transport_get_next(transport); 2001 } 2002 spdk_json_write_array_end(w); 2003 spdk_jsonrpc_end_result(request, w); 2004 free(req.tgt_name); 2005 } 2006 SPDK_RPC_REGISTER("nvmf_get_transports", rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 2007 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_transports, get_nvmf_transports) 2008 2009 struct rpc_nvmf_get_stats_ctx { 2010 char *tgt_name; 2011 struct spdk_nvmf_tgt *tgt; 2012 struct spdk_jsonrpc_request *request; 2013 struct spdk_json_write_ctx *w; 2014 }; 2015 2016 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 2017 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 2018 }; 2019 2020 static void 2021 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 2022 { 2023 free(ctx->tgt_name); 2024 free(ctx); 2025 } 2026 2027 static void 2028 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 2029 { 2030 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2031 2032 spdk_json_write_array_end(ctx->w); 2033 spdk_json_write_object_end(ctx->w); 2034 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2035 free_get_stats_ctx(ctx); 2036 } 2037 2038 static void 2039 write_nvmf_transport_stats(struct spdk_json_write_ctx *w, 2040 struct spdk_nvmf_transport_poll_group_stat *stat) 2041 { 2042 uint64_t i; 2043 2044 spdk_json_write_object_begin(w); 2045 spdk_json_write_named_string(w, "trtype", 2046 spdk_nvme_transport_id_trtype_str(stat->trtype)); 2047 switch (stat->trtype) { 2048 case SPDK_NVME_TRANSPORT_RDMA: 2049 spdk_json_write_named_uint64(w, "pending_data_buffer", stat->rdma.pending_data_buffer); 2050 spdk_json_write_named_array_begin(w, "devices"); 2051 for (i = 0; i < stat->rdma.num_devices; ++i) { 2052 spdk_json_write_object_begin(w); 2053 spdk_json_write_named_string(w, "name", stat->rdma.devices[i].name); 2054 spdk_json_write_named_uint64(w, "polls", stat->rdma.devices[i].polls); 2055 spdk_json_write_named_uint64(w, "completions", stat->rdma.devices[i].completions); 2056 spdk_json_write_named_uint64(w, "requests", 2057 stat->rdma.devices[i].requests); 2058 spdk_json_write_named_uint64(w, "request_latency", 2059 stat->rdma.devices[i].request_latency); 2060 spdk_json_write_named_uint64(w, "pending_free_request", 2061 stat->rdma.devices[i].pending_free_request); 2062 spdk_json_write_named_uint64(w, "pending_rdma_read", 2063 stat->rdma.devices[i].pending_rdma_read); 2064 spdk_json_write_named_uint64(w, "pending_rdma_write", 2065 stat->rdma.devices[i].pending_rdma_write); 2066 spdk_json_write_object_end(w); 2067 } 2068 spdk_json_write_array_end(w); 2069 break; 2070 default: 2071 break; 2072 } 2073 spdk_json_write_object_end(w); 2074 } 2075 2076 static void 2077 _rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 2078 { 2079 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2080 struct spdk_nvmf_transport *transport; 2081 struct spdk_nvmf_poll_group_stat stat; 2082 struct spdk_nvmf_transport_poll_group_stat *trstat; 2083 int rc; 2084 2085 if (0 == spdk_nvmf_poll_group_get_stat(ctx->tgt, &stat)) { 2086 spdk_json_write_object_begin(ctx->w); 2087 spdk_json_write_named_string(ctx->w, "name", spdk_thread_get_name(spdk_get_thread())); 2088 spdk_json_write_named_uint32(ctx->w, "admin_qpairs", stat.admin_qpairs); 2089 spdk_json_write_named_uint32(ctx->w, "io_qpairs", stat.io_qpairs); 2090 spdk_json_write_named_uint64(ctx->w, "pending_bdev_io", stat.pending_bdev_io); 2091 2092 spdk_json_write_named_array_begin(ctx->w, "transports"); 2093 transport = spdk_nvmf_transport_get_first(ctx->tgt); 2094 while (transport) { 2095 rc = spdk_nvmf_transport_poll_group_get_stat(ctx->tgt, transport, &trstat); 2096 if (0 == rc) { 2097 write_nvmf_transport_stats(ctx->w, trstat); 2098 spdk_nvmf_transport_poll_group_free_stat(transport, trstat); 2099 } else if (-ENOTSUP != rc) { 2100 SPDK_ERRLOG("Failed to get poll group statistics for transport %s, errno %d\n", 2101 spdk_nvme_transport_id_trtype_str(spdk_nvmf_get_transport_type(transport)), 2102 rc); 2103 } 2104 transport = spdk_nvmf_transport_get_next(transport); 2105 } 2106 spdk_json_write_array_end(ctx->w); 2107 spdk_json_write_object_end(ctx->w); 2108 } 2109 2110 spdk_for_each_channel_continue(i, 0); 2111 } 2112 2113 2114 static void 2115 rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 2116 const struct spdk_json_val *params) 2117 { 2118 struct rpc_nvmf_get_stats_ctx *ctx; 2119 2120 ctx = calloc(1, sizeof(*ctx)); 2121 if (!ctx) { 2122 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2123 "Memory allocation error"); 2124 return; 2125 } 2126 ctx->request = request; 2127 2128 if (params) { 2129 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 2130 SPDK_COUNTOF(rpc_get_stats_decoders), 2131 ctx)) { 2132 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2133 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2134 free_get_stats_ctx(ctx); 2135 return; 2136 } 2137 } 2138 2139 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2140 if (!ctx->tgt) { 2141 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2142 "Unable to find a target."); 2143 free_get_stats_ctx(ctx); 2144 return; 2145 } 2146 2147 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2148 spdk_json_write_object_begin(ctx->w); 2149 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 2150 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 2151 2152 spdk_for_each_channel(ctx->tgt, 2153 _rpc_nvmf_get_stats, 2154 ctx, 2155 rpc_nvmf_get_stats_done); 2156 } 2157 2158 SPDK_RPC_REGISTER("nvmf_get_stats", rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 2159 2160 static void 2161 dump_nvmf_ctrlr(struct spdk_json_write_ctx *w, struct spdk_nvmf_ctrlr *ctrlr) 2162 { 2163 char uuid_str[SPDK_UUID_STRING_LEN] = {}; 2164 uint32_t count; 2165 2166 spdk_json_write_object_begin(w); 2167 2168 spdk_json_write_named_uint32(w, "cntlid", ctrlr->cntlid); 2169 2170 spdk_json_write_named_string(w, "hostnqn", ctrlr->hostnqn); 2171 2172 spdk_uuid_fmt_lower(uuid_str, sizeof(uuid_str), &ctrlr->hostid); 2173 spdk_json_write_named_string(w, "hostid", uuid_str); 2174 2175 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 2176 spdk_json_write_named_uint32(w, "num_io_qpairs", count); 2177 2178 spdk_json_write_object_end(w); 2179 } 2180 2181 static const char * 2182 nvmf_qpair_state_str(enum spdk_nvmf_qpair_state state) 2183 { 2184 switch (state) { 2185 case SPDK_NVMF_QPAIR_UNINITIALIZED: 2186 return "uninitialized"; 2187 case SPDK_NVMF_QPAIR_ACTIVE: 2188 return "active"; 2189 case SPDK_NVMF_QPAIR_DEACTIVATING: 2190 return "deactivating"; 2191 case SPDK_NVMF_QPAIR_ERROR: 2192 return "error"; 2193 default: 2194 return NULL; 2195 } 2196 } 2197 2198 static void 2199 dump_nvmf_qpair(struct spdk_json_write_ctx *w, struct spdk_nvmf_qpair *qpair) 2200 { 2201 struct spdk_nvme_transport_id listen_trid = {}; 2202 const char *adrfam; 2203 2204 spdk_json_write_object_begin(w); 2205 2206 spdk_json_write_named_uint32(w, "cntlid", qpair->ctrlr->cntlid); 2207 spdk_json_write_named_uint32(w, "qid", qpair->qid); 2208 spdk_json_write_named_string(w, "state", nvmf_qpair_state_str(qpair->state)); 2209 2210 if (spdk_nvmf_qpair_get_listen_trid(qpair, &listen_trid) == 0) { 2211 spdk_json_write_named_object_begin(w, "listen_address"); 2212 adrfam = spdk_nvme_transport_id_adrfam_str(listen_trid.adrfam); 2213 if (adrfam == NULL) { 2214 adrfam = "unknown"; 2215 } 2216 spdk_json_write_named_string(w, "trtype", listen_trid.trstring); 2217 spdk_json_write_named_string(w, "adrfam", adrfam); 2218 spdk_json_write_named_string(w, "traddr", listen_trid.traddr); 2219 spdk_json_write_named_string(w, "trsvcid", listen_trid.trsvcid); 2220 spdk_json_write_object_end(w); 2221 } 2222 2223 spdk_json_write_object_end(w); 2224 } 2225 2226 static const char * 2227 nvme_ana_state_str(enum spdk_nvme_ana_state ana_state) 2228 { 2229 switch (ana_state) { 2230 case SPDK_NVME_ANA_OPTIMIZED_STATE: 2231 return "optimized"; 2232 case SPDK_NVME_ANA_NON_OPTIMIZED_STATE: 2233 return "non_optimized"; 2234 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 2235 return "inaccessible"; 2236 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 2237 return "persistent_loss"; 2238 case SPDK_NVME_ANA_CHANGE_STATE: 2239 return "change"; 2240 default: 2241 return NULL; 2242 } 2243 } 2244 2245 static void 2246 dump_nvmf_subsystem_listener(struct spdk_json_write_ctx *w, 2247 struct spdk_nvmf_subsystem_listener *listener) 2248 { 2249 const struct spdk_nvme_transport_id *trid = listener->trid; 2250 const char *adrfam; 2251 2252 spdk_json_write_object_begin(w); 2253 2254 spdk_json_write_named_object_begin(w, "address"); 2255 adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam); 2256 if (adrfam == NULL) { 2257 adrfam = "unknown"; 2258 } 2259 spdk_json_write_named_string(w, "trtype", trid->trstring); 2260 spdk_json_write_named_string(w, "adrfam", adrfam); 2261 spdk_json_write_named_string(w, "traddr", trid->traddr); 2262 spdk_json_write_named_string(w, "trsvcid", trid->trsvcid); 2263 spdk_json_write_object_end(w); 2264 2265 spdk_json_write_named_string(w, "ana_state", 2266 nvme_ana_state_str(listener->ana_state)); 2267 2268 spdk_json_write_object_end(w); 2269 } 2270 2271 struct rpc_subsystem_query_ctx { 2272 char *nqn; 2273 char *tgt_name; 2274 struct spdk_nvmf_subsystem *subsystem; 2275 struct spdk_jsonrpc_request *request; 2276 struct spdk_json_write_ctx *w; 2277 }; 2278 2279 static const struct spdk_json_object_decoder rpc_subsystem_query_decoders[] = { 2280 {"nqn", offsetof(struct rpc_subsystem_query_ctx, nqn), spdk_json_decode_string}, 2281 {"tgt_name", offsetof(struct rpc_subsystem_query_ctx, tgt_name), spdk_json_decode_string, true}, 2282 }; 2283 2284 static void 2285 free_rpc_subsystem_query_ctx(struct rpc_subsystem_query_ctx *ctx) 2286 { 2287 free(ctx->nqn); 2288 free(ctx->tgt_name); 2289 free(ctx); 2290 } 2291 2292 static void 2293 rpc_nvmf_get_controllers_paused(struct spdk_nvmf_subsystem *subsystem, 2294 void *cb_arg, int status) 2295 { 2296 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2297 struct spdk_json_write_ctx *w; 2298 struct spdk_nvmf_ctrlr *ctrlr; 2299 2300 w = spdk_jsonrpc_begin_result(ctx->request); 2301 2302 spdk_json_write_array_begin(w); 2303 TAILQ_FOREACH(ctrlr, &ctx->subsystem->ctrlrs, link) { 2304 dump_nvmf_ctrlr(w, ctrlr); 2305 } 2306 spdk_json_write_array_end(w); 2307 2308 spdk_jsonrpc_end_result(ctx->request, w); 2309 2310 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2311 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2312 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2313 } 2314 2315 free_rpc_subsystem_query_ctx(ctx); 2316 } 2317 2318 static void 2319 rpc_nvmf_get_qpairs_done(struct spdk_io_channel_iter *i, int status) 2320 { 2321 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2322 2323 spdk_json_write_array_end(ctx->w); 2324 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2325 2326 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2327 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2328 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2329 } 2330 2331 free_rpc_subsystem_query_ctx(ctx); 2332 } 2333 2334 static void 2335 rpc_nvmf_get_qpairs(struct spdk_io_channel_iter *i) 2336 { 2337 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2338 struct spdk_io_channel *ch; 2339 struct spdk_nvmf_poll_group *group; 2340 struct spdk_nvmf_qpair *qpair; 2341 2342 ch = spdk_get_io_channel(ctx->subsystem->tgt); 2343 group = spdk_io_channel_get_ctx(ch); 2344 2345 TAILQ_FOREACH(qpair, &group->qpairs, link) { 2346 if (qpair->ctrlr->subsys == ctx->subsystem) { 2347 dump_nvmf_qpair(ctx->w, qpair); 2348 } 2349 } 2350 2351 spdk_for_each_channel_continue(i, 0); 2352 } 2353 2354 static void 2355 rpc_nvmf_get_qpairs_paused(struct spdk_nvmf_subsystem *subsystem, 2356 void *cb_arg, int status) 2357 { 2358 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2359 2360 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2361 2362 spdk_json_write_array_begin(ctx->w); 2363 2364 spdk_for_each_channel(ctx->subsystem->tgt, 2365 rpc_nvmf_get_qpairs, 2366 ctx, 2367 rpc_nvmf_get_qpairs_done); 2368 } 2369 2370 static void 2371 rpc_nvmf_get_listeners_paused(struct spdk_nvmf_subsystem *subsystem, 2372 void *cb_arg, int status) 2373 { 2374 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2375 struct spdk_json_write_ctx *w; 2376 struct spdk_nvmf_subsystem_listener *listener; 2377 2378 w = spdk_jsonrpc_begin_result(ctx->request); 2379 2380 spdk_json_write_array_begin(w); 2381 2382 for (listener = spdk_nvmf_subsystem_get_first_listener(ctx->subsystem); 2383 listener != NULL; 2384 listener = spdk_nvmf_subsystem_get_next_listener(ctx->subsystem, listener)) { 2385 dump_nvmf_subsystem_listener(w, listener); 2386 } 2387 spdk_json_write_array_end(w); 2388 2389 spdk_jsonrpc_end_result(ctx->request, w); 2390 2391 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2392 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2393 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2394 } 2395 2396 free_rpc_subsystem_query_ctx(ctx); 2397 } 2398 2399 static void 2400 _rpc_nvmf_subsystem_query(struct spdk_jsonrpc_request *request, 2401 const struct spdk_json_val *params, 2402 spdk_nvmf_subsystem_state_change_done cb_fn) 2403 { 2404 struct rpc_subsystem_query_ctx *ctx; 2405 struct spdk_nvmf_subsystem *subsystem; 2406 struct spdk_nvmf_tgt *tgt; 2407 2408 ctx = calloc(1, sizeof(*ctx)); 2409 if (!ctx) { 2410 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2411 "Out of memory"); 2412 return; 2413 } 2414 2415 ctx->request = request; 2416 2417 if (spdk_json_decode_object(params, rpc_subsystem_query_decoders, 2418 SPDK_COUNTOF(rpc_subsystem_query_decoders), 2419 ctx)) { 2420 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2421 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2422 "Invalid parameters"); 2423 free_rpc_subsystem_query_ctx(ctx); 2424 return; 2425 } 2426 2427 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2428 if (!tgt) { 2429 SPDK_ERRLOG("Unable to find a target object.\n"); 2430 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2431 "Unable to find a target"); 2432 free_rpc_subsystem_query_ctx(ctx); 2433 return; 2434 } 2435 2436 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 2437 if (!subsystem) { 2438 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 2439 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2440 "Invalid parameters"); 2441 free_rpc_subsystem_query_ctx(ctx); 2442 return; 2443 } 2444 2445 ctx->subsystem = subsystem; 2446 2447 if (spdk_nvmf_subsystem_pause(subsystem, cb_fn, ctx)) { 2448 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2449 "Internal error"); 2450 free_rpc_subsystem_query_ctx(ctx); 2451 return; 2452 } 2453 } 2454 2455 static void 2456 rpc_nvmf_subsystem_get_controllers(struct spdk_jsonrpc_request *request, 2457 const struct spdk_json_val *params) 2458 { 2459 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_controllers_paused); 2460 } 2461 SPDK_RPC_REGISTER("nvmf_subsystem_get_controllers", rpc_nvmf_subsystem_get_controllers, 2462 SPDK_RPC_RUNTIME); 2463 2464 static void 2465 rpc_nvmf_subsystem_get_qpairs(struct spdk_jsonrpc_request *request, 2466 const struct spdk_json_val *params) 2467 { 2468 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_qpairs_paused); 2469 } 2470 SPDK_RPC_REGISTER("nvmf_subsystem_get_qpairs", rpc_nvmf_subsystem_get_qpairs, SPDK_RPC_RUNTIME); 2471 2472 static void 2473 rpc_nvmf_subsystem_get_listeners(struct spdk_jsonrpc_request *request, 2474 const struct spdk_json_val *params) 2475 { 2476 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_listeners_paused); 2477 } 2478 SPDK_RPC_REGISTER("nvmf_subsystem_get_listeners", rpc_nvmf_subsystem_get_listeners, 2479 SPDK_RPC_RUNTIME); 2480