1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2018-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/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 rc = spdk_nvmf_subsystem_remove_listener(subsystem, &ctx->trid); 729 if (rc == 0) { 730 spdk_nvmf_transport_stop_listen_async(ctx->transport, &ctx->trid, nvmf_rpc_stop_listen_async_done, 731 ctx); 732 return; 733 } 734 SPDK_ERRLOG("Unable to remove listener, rc %d\n", rc); 735 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 736 "Invalid parameters"); 737 ctx->response_sent = true; 738 } else if (ctx->op == NVMF_RPC_LISTEN_SET_ANA_STATE) { 739 nvmf_subsystem_set_ana_state(subsystem, &ctx->trid, ctx->ana_state, 740 nvmf_rpc_set_ana_state_done, ctx); 741 return; 742 } else { 743 SPDK_UNREACHABLE(); 744 } 745 746 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_listen_resumed, ctx)) { 747 if (!ctx->response_sent) { 748 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 749 "Internal error"); 750 } 751 nvmf_rpc_listener_ctx_free(ctx); 752 /* Can't really do anything to recover here - subsystem will remain paused. */ 753 } 754 } 755 756 static int 757 rpc_listen_address_to_trid(const struct rpc_listen_address *address, 758 struct spdk_nvme_transport_id *trid) 759 { 760 size_t len; 761 762 memset(trid, 0, sizeof(*trid)); 763 764 if (spdk_nvme_transport_id_populate_trstring(trid, address->transport)) { 765 SPDK_ERRLOG("Invalid transport string: %s\n", address->transport); 766 return -EINVAL; 767 } 768 769 if (spdk_nvme_transport_id_parse_trtype(&trid->trtype, address->transport)) { 770 SPDK_ERRLOG("Invalid transport type: %s\n", address->transport); 771 return -EINVAL; 772 } 773 774 if (address->adrfam) { 775 if (spdk_nvme_transport_id_parse_adrfam(&trid->adrfam, address->adrfam)) { 776 SPDK_ERRLOG("Invalid adrfam: %s\n", address->adrfam); 777 return -EINVAL; 778 } 779 } else { 780 trid->adrfam = SPDK_NVMF_ADRFAM_IPV4; 781 } 782 783 len = strlen(address->traddr); 784 if (len > sizeof(trid->traddr) - 1) { 785 SPDK_ERRLOG("Transport address longer than %zu characters: %s\n", 786 sizeof(trid->traddr) - 1, address->traddr); 787 return -EINVAL; 788 } 789 memcpy(trid->traddr, address->traddr, len + 1); 790 791 trid->trsvcid[0] = '\0'; 792 if (address->trsvcid) { 793 len = strlen(address->trsvcid); 794 if (len > sizeof(trid->trsvcid) - 1) { 795 SPDK_ERRLOG("Transport service id longer than %zu characters: %s\n", 796 sizeof(trid->trsvcid) - 1, address->trsvcid); 797 return -EINVAL; 798 } 799 memcpy(trid->trsvcid, address->trsvcid, len + 1); 800 } 801 802 return 0; 803 } 804 805 static void 806 rpc_nvmf_subsystem_add_listener(struct spdk_jsonrpc_request *request, 807 const struct spdk_json_val *params) 808 { 809 struct nvmf_rpc_listener_ctx *ctx; 810 struct spdk_nvmf_subsystem *subsystem; 811 struct spdk_nvmf_tgt *tgt; 812 int rc; 813 814 ctx = calloc(1, sizeof(*ctx)); 815 if (!ctx) { 816 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 817 return; 818 } 819 820 ctx->request = request; 821 822 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_listener_decoder, 823 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 824 ctx)) { 825 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 826 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 827 nvmf_rpc_listener_ctx_free(ctx); 828 return; 829 } 830 831 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 832 if (!tgt) { 833 SPDK_ERRLOG("Unable to find a target object.\n"); 834 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 835 "Unable to find a target."); 836 nvmf_rpc_listener_ctx_free(ctx); 837 return; 838 } 839 ctx->tgt = tgt; 840 841 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 842 if (!subsystem) { 843 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 844 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 845 nvmf_rpc_listener_ctx_free(ctx); 846 return; 847 } 848 849 ctx->subsystem = subsystem; 850 851 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 852 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 853 "Invalid parameters"); 854 nvmf_rpc_listener_ctx_free(ctx); 855 return; 856 } 857 858 ctx->op = NVMF_RPC_LISTEN_ADD; 859 spdk_nvmf_listen_opts_init(&ctx->opts, sizeof(ctx->opts)); 860 ctx->opts.transport_specific = params; 861 862 rc = spdk_nvmf_subsystem_pause(subsystem, 0, nvmf_rpc_listen_paused, ctx); 863 if (rc != 0) { 864 if (rc == -EBUSY) { 865 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 866 "subsystem busy, retry later.\n"); 867 } else { 868 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 869 } 870 nvmf_rpc_listener_ctx_free(ctx); 871 } 872 } 873 SPDK_RPC_REGISTER("nvmf_subsystem_add_listener", rpc_nvmf_subsystem_add_listener, 874 SPDK_RPC_RUNTIME); 875 876 static void 877 rpc_nvmf_subsystem_remove_listener(struct spdk_jsonrpc_request *request, 878 const struct spdk_json_val *params) 879 { 880 struct nvmf_rpc_listener_ctx *ctx; 881 struct spdk_nvmf_subsystem *subsystem; 882 struct spdk_nvmf_tgt *tgt; 883 int rc; 884 885 ctx = calloc(1, sizeof(*ctx)); 886 if (!ctx) { 887 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 888 return; 889 } 890 891 ctx->request = request; 892 893 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 894 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 895 ctx)) { 896 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 897 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 898 nvmf_rpc_listener_ctx_free(ctx); 899 return; 900 } 901 902 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 903 if (!tgt) { 904 SPDK_ERRLOG("Unable to find a target object.\n"); 905 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 906 "Unable to find a target."); 907 nvmf_rpc_listener_ctx_free(ctx); 908 return; 909 } 910 ctx->tgt = tgt; 911 912 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 913 if (!subsystem) { 914 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 915 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 916 nvmf_rpc_listener_ctx_free(ctx); 917 return; 918 } 919 920 ctx->subsystem = subsystem; 921 922 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 923 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 924 "Invalid parameters"); 925 nvmf_rpc_listener_ctx_free(ctx); 926 return; 927 } 928 929 ctx->transport = spdk_nvmf_tgt_get_transport(tgt, ctx->trid.trstring); 930 if (!ctx->transport) { 931 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 932 ctx->trid.trstring); 933 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 934 "Invalid parameters"); 935 nvmf_rpc_listener_ctx_free(ctx); 936 return; 937 } 938 939 ctx->op = NVMF_RPC_LISTEN_REMOVE; 940 941 rc = spdk_nvmf_subsystem_pause(subsystem, 0, nvmf_rpc_listen_paused, ctx); 942 if (rc != 0) { 943 if (rc == -EBUSY) { 944 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 945 "subsystem busy, retry later.\n"); 946 } else { 947 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 948 } 949 nvmf_rpc_listener_ctx_free(ctx); 950 } 951 } 952 SPDK_RPC_REGISTER("nvmf_subsystem_remove_listener", rpc_nvmf_subsystem_remove_listener, 953 SPDK_RPC_RUNTIME); 954 955 static const struct spdk_json_object_decoder nvmf_rpc_set_ana_state_decoder[] = { 956 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 957 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 958 {"ana_state", offsetof(struct nvmf_rpc_listener_ctx, ana_state_str), spdk_json_decode_string}, 959 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 960 }; 961 962 static int 963 rpc_ana_state_parse(const char *str, enum spdk_nvme_ana_state *ana_state) 964 { 965 if (ana_state == NULL || str == NULL) { 966 return -EINVAL; 967 } 968 969 if (strcasecmp(str, "optimized") == 0) { 970 *ana_state = SPDK_NVME_ANA_OPTIMIZED_STATE; 971 } else if (strcasecmp(str, "non_optimized") == 0) { 972 *ana_state = SPDK_NVME_ANA_NON_OPTIMIZED_STATE; 973 } else if (strcasecmp(str, "inaccessible") == 0) { 974 *ana_state = SPDK_NVME_ANA_INACCESSIBLE_STATE; 975 } else { 976 return -ENOENT; 977 } 978 979 return 0; 980 } 981 982 static void 983 rpc_nvmf_subsystem_listener_set_ana_state(struct spdk_jsonrpc_request *request, 984 const struct spdk_json_val *params) 985 { 986 struct nvmf_rpc_listener_ctx *ctx; 987 struct spdk_nvmf_subsystem *subsystem; 988 struct spdk_nvmf_tgt *tgt; 989 990 ctx = calloc(1, sizeof(*ctx)); 991 if (!ctx) { 992 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 993 "Out of memory"); 994 return; 995 } 996 997 ctx->request = request; 998 999 if (spdk_json_decode_object(params, nvmf_rpc_set_ana_state_decoder, 1000 SPDK_COUNTOF(nvmf_rpc_set_ana_state_decoder), 1001 ctx)) { 1002 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1003 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1004 "Invalid parameters"); 1005 nvmf_rpc_listener_ctx_free(ctx); 1006 return; 1007 } 1008 1009 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1010 if (!tgt) { 1011 SPDK_ERRLOG("Unable to find a target object.\n"); 1012 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1013 "Unable to find a target.\n"); 1014 nvmf_rpc_listener_ctx_free(ctx); 1015 return; 1016 } 1017 1018 ctx->tgt = tgt; 1019 1020 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1021 if (!subsystem) { 1022 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1023 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1024 "Unable to find subsystem with NQN %s", 1025 ctx->nqn); 1026 nvmf_rpc_listener_ctx_free(ctx); 1027 return; 1028 } 1029 1030 ctx->subsystem = subsystem; 1031 1032 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 1033 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1034 "Invalid parameters"); 1035 nvmf_rpc_listener_ctx_free(ctx); 1036 return; 1037 } 1038 1039 if (rpc_ana_state_parse(ctx->ana_state_str, &ctx->ana_state)) { 1040 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1041 "Invalid parameters"); 1042 nvmf_rpc_listener_ctx_free(ctx); 1043 return; 1044 } 1045 1046 ctx->op = NVMF_RPC_LISTEN_SET_ANA_STATE; 1047 1048 if (spdk_nvmf_subsystem_pause(subsystem, 0, nvmf_rpc_listen_paused, ctx)) { 1049 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1050 "Internal error"); 1051 nvmf_rpc_listener_ctx_free(ctx); 1052 } 1053 } 1054 SPDK_RPC_REGISTER("nvmf_subsystem_listener_set_ana_state", 1055 rpc_nvmf_subsystem_listener_set_ana_state, SPDK_RPC_RUNTIME); 1056 1057 struct spdk_nvmf_ns_params { 1058 char *bdev_name; 1059 char *ptpl_file; 1060 uint32_t nsid; 1061 char nguid[16]; 1062 char eui64[8]; 1063 struct spdk_uuid uuid; 1064 }; 1065 1066 static const struct spdk_json_object_decoder rpc_ns_params_decoders[] = { 1067 {"nsid", offsetof(struct spdk_nvmf_ns_params, nsid), spdk_json_decode_uint32, true}, 1068 {"bdev_name", offsetof(struct spdk_nvmf_ns_params, bdev_name), spdk_json_decode_string}, 1069 {"ptpl_file", offsetof(struct spdk_nvmf_ns_params, ptpl_file), spdk_json_decode_string, true}, 1070 {"nguid", offsetof(struct spdk_nvmf_ns_params, nguid), decode_ns_nguid, true}, 1071 {"eui64", offsetof(struct spdk_nvmf_ns_params, eui64), decode_ns_eui64, true}, 1072 {"uuid", offsetof(struct spdk_nvmf_ns_params, uuid), decode_ns_uuid, true}, 1073 }; 1074 1075 static int 1076 decode_rpc_ns_params(const struct spdk_json_val *val, void *out) 1077 { 1078 struct spdk_nvmf_ns_params *ns_params = out; 1079 1080 return spdk_json_decode_object(val, rpc_ns_params_decoders, 1081 SPDK_COUNTOF(rpc_ns_params_decoders), 1082 ns_params); 1083 } 1084 1085 struct nvmf_rpc_ns_ctx { 1086 char *nqn; 1087 char *tgt_name; 1088 struct spdk_nvmf_ns_params ns_params; 1089 1090 struct spdk_jsonrpc_request *request; 1091 bool response_sent; 1092 }; 1093 1094 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ns_decoder[] = { 1095 {"nqn", offsetof(struct nvmf_rpc_ns_ctx, nqn), spdk_json_decode_string}, 1096 {"namespace", offsetof(struct nvmf_rpc_ns_ctx, ns_params), decode_rpc_ns_params}, 1097 {"tgt_name", offsetof(struct nvmf_rpc_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1098 }; 1099 1100 static void 1101 nvmf_rpc_ns_ctx_free(struct nvmf_rpc_ns_ctx *ctx) 1102 { 1103 free(ctx->nqn); 1104 free(ctx->tgt_name); 1105 free(ctx->ns_params.bdev_name); 1106 free(ctx->ns_params.ptpl_file); 1107 free(ctx); 1108 } 1109 1110 static void 1111 nvmf_rpc_ns_failback_resumed(struct spdk_nvmf_subsystem *subsystem, 1112 void *cb_arg, int status) 1113 { 1114 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1115 struct spdk_jsonrpc_request *request = ctx->request; 1116 1117 if (status) { 1118 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1119 "Unable to add ns, subsystem in invalid state"); 1120 } else { 1121 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1122 "Unable to add ns, subsystem in active state"); 1123 } 1124 1125 nvmf_rpc_ns_ctx_free(ctx); 1126 } 1127 1128 static void 1129 nvmf_rpc_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1130 void *cb_arg, int status) 1131 { 1132 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1133 struct spdk_jsonrpc_request *request = ctx->request; 1134 uint32_t nsid = ctx->ns_params.nsid; 1135 bool response_sent = ctx->response_sent; 1136 struct spdk_json_write_ctx *w; 1137 int rc; 1138 1139 /* The case where the call to add the namespace was successful, but the subsystem couldn't be resumed. */ 1140 if (status && !ctx->response_sent) { 1141 rc = spdk_nvmf_subsystem_remove_ns(subsystem, nsid); 1142 if (rc != 0) { 1143 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1144 "Unable to add ns, subsystem in invalid state"); 1145 nvmf_rpc_ns_ctx_free(ctx); 1146 return; 1147 } 1148 1149 rc = spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_failback_resumed, ctx); 1150 if (rc != 0) { 1151 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1152 nvmf_rpc_ns_ctx_free(ctx); 1153 return; 1154 } 1155 1156 return; 1157 } 1158 1159 nvmf_rpc_ns_ctx_free(ctx); 1160 1161 if (response_sent) { 1162 return; 1163 } 1164 1165 w = spdk_jsonrpc_begin_result(request); 1166 spdk_json_write_uint32(w, nsid); 1167 spdk_jsonrpc_end_result(request, w); 1168 } 1169 1170 static void 1171 nvmf_rpc_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1172 void *cb_arg, int status) 1173 { 1174 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1175 struct spdk_nvmf_ns_opts ns_opts; 1176 1177 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 1178 ns_opts.nsid = ctx->ns_params.nsid; 1179 1180 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 1181 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 1182 1183 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 1184 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 1185 1186 if (!spdk_mem_all_zero(&ctx->ns_params.uuid, sizeof(ctx->ns_params.uuid))) { 1187 ns_opts.uuid = ctx->ns_params.uuid; 1188 } 1189 1190 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns_ext(subsystem, ctx->ns_params.bdev_name, 1191 &ns_opts, sizeof(ns_opts), 1192 ctx->ns_params.ptpl_file); 1193 if (ctx->ns_params.nsid == 0) { 1194 SPDK_ERRLOG("Unable to add namespace\n"); 1195 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1196 "Invalid parameters"); 1197 ctx->response_sent = true; 1198 goto resume; 1199 } 1200 1201 resume: 1202 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 1203 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1204 nvmf_rpc_ns_ctx_free(ctx); 1205 } 1206 } 1207 1208 static void 1209 rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 1210 const struct spdk_json_val *params) 1211 { 1212 struct nvmf_rpc_ns_ctx *ctx; 1213 struct spdk_nvmf_subsystem *subsystem; 1214 struct spdk_nvmf_tgt *tgt; 1215 int rc; 1216 1217 ctx = calloc(1, sizeof(*ctx)); 1218 if (!ctx) { 1219 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1220 return; 1221 } 1222 1223 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ns_decoder, 1224 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), 1225 ctx)) { 1226 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1227 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1228 nvmf_rpc_ns_ctx_free(ctx); 1229 return; 1230 } 1231 1232 ctx->request = request; 1233 ctx->response_sent = false; 1234 1235 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1236 if (!tgt) { 1237 SPDK_ERRLOG("Unable to find a target object.\n"); 1238 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1239 "Unable to find a target."); 1240 nvmf_rpc_ns_ctx_free(ctx); 1241 return; 1242 } 1243 1244 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1245 if (!subsystem) { 1246 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1247 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1248 nvmf_rpc_ns_ctx_free(ctx); 1249 return; 1250 } 1251 1252 rc = spdk_nvmf_subsystem_pause(subsystem, ctx->ns_params.nsid, nvmf_rpc_ns_paused, ctx); 1253 if (rc != 0) { 1254 if (rc == -EBUSY) { 1255 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1256 "subsystem busy, retry later.\n"); 1257 } else { 1258 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1259 } 1260 nvmf_rpc_ns_ctx_free(ctx); 1261 } 1262 } 1263 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1264 1265 struct nvmf_rpc_remove_ns_ctx { 1266 char *nqn; 1267 char *tgt_name; 1268 uint32_t nsid; 1269 1270 struct spdk_jsonrpc_request *request; 1271 bool response_sent; 1272 }; 1273 1274 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1275 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1276 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1277 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1278 }; 1279 1280 static void 1281 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1282 { 1283 free(ctx->nqn); 1284 free(ctx->tgt_name); 1285 free(ctx); 1286 } 1287 1288 static void 1289 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1290 void *cb_arg, int status) 1291 { 1292 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1293 struct spdk_jsonrpc_request *request = ctx->request; 1294 bool response_sent = ctx->response_sent; 1295 1296 nvmf_rpc_remove_ns_ctx_free(ctx); 1297 1298 if (response_sent) { 1299 return; 1300 } 1301 1302 spdk_jsonrpc_send_bool_response(request, true); 1303 } 1304 1305 static void 1306 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1307 void *cb_arg, int status) 1308 { 1309 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1310 int ret; 1311 1312 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1313 if (ret < 0) { 1314 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1315 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1316 "Invalid parameters"); 1317 ctx->response_sent = true; 1318 } 1319 1320 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1321 if (!ctx->response_sent) { 1322 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1323 } 1324 nvmf_rpc_remove_ns_ctx_free(ctx); 1325 } 1326 } 1327 1328 static void 1329 rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1330 const struct spdk_json_val *params) 1331 { 1332 struct nvmf_rpc_remove_ns_ctx *ctx; 1333 struct spdk_nvmf_subsystem *subsystem; 1334 struct spdk_nvmf_tgt *tgt; 1335 int rc; 1336 1337 ctx = calloc(1, sizeof(*ctx)); 1338 if (!ctx) { 1339 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1340 return; 1341 } 1342 1343 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1344 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1345 ctx)) { 1346 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1347 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1348 nvmf_rpc_remove_ns_ctx_free(ctx); 1349 return; 1350 } 1351 1352 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1353 if (!tgt) { 1354 SPDK_ERRLOG("Unable to find a target object.\n"); 1355 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1356 "Unable to find a target."); 1357 nvmf_rpc_remove_ns_ctx_free(ctx); 1358 return; 1359 } 1360 1361 ctx->request = request; 1362 ctx->response_sent = false; 1363 1364 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1365 if (!subsystem) { 1366 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1367 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1368 nvmf_rpc_remove_ns_ctx_free(ctx); 1369 return; 1370 } 1371 1372 rc = spdk_nvmf_subsystem_pause(subsystem, ctx->nsid, nvmf_rpc_remove_ns_paused, ctx); 1373 if (rc != 0) { 1374 if (rc == -EBUSY) { 1375 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1376 "subsystem busy, retry later.\n"); 1377 } else { 1378 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1379 } 1380 nvmf_rpc_remove_ns_ctx_free(ctx); 1381 } 1382 } 1383 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1384 1385 struct nvmf_rpc_host_ctx { 1386 struct spdk_jsonrpc_request *request; 1387 char *nqn; 1388 char *host; 1389 char *tgt_name; 1390 bool allow_any_host; 1391 }; 1392 1393 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1394 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1395 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1396 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1397 }; 1398 1399 static void 1400 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1401 { 1402 free(ctx->nqn); 1403 free(ctx->host); 1404 free(ctx->tgt_name); 1405 } 1406 1407 static void 1408 rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1409 const struct spdk_json_val *params) 1410 { 1411 struct nvmf_rpc_host_ctx ctx = {}; 1412 struct spdk_nvmf_subsystem *subsystem; 1413 struct spdk_nvmf_tgt *tgt; 1414 int rc; 1415 1416 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1417 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1418 &ctx)) { 1419 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1420 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1421 nvmf_rpc_host_ctx_free(&ctx); 1422 return; 1423 } 1424 1425 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1426 if (!tgt) { 1427 SPDK_ERRLOG("Unable to find a target object.\n"); 1428 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1429 "Unable to find a target."); 1430 nvmf_rpc_host_ctx_free(&ctx); 1431 return; 1432 } 1433 1434 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 1435 if (!subsystem) { 1436 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx.nqn); 1437 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1438 nvmf_rpc_host_ctx_free(&ctx); 1439 return; 1440 } 1441 1442 rc = spdk_nvmf_subsystem_add_host(subsystem, ctx.host); 1443 if (rc != 0) { 1444 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1445 nvmf_rpc_host_ctx_free(&ctx); 1446 return; 1447 } 1448 1449 spdk_jsonrpc_send_bool_response(request, true); 1450 nvmf_rpc_host_ctx_free(&ctx); 1451 } 1452 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 1453 1454 static void 1455 rpc_nvmf_subsystem_remove_host_done(void *_ctx, int status) 1456 { 1457 struct nvmf_rpc_host_ctx *ctx = _ctx; 1458 1459 spdk_jsonrpc_send_bool_response(ctx->request, true); 1460 nvmf_rpc_host_ctx_free(ctx); 1461 free(ctx); 1462 } 1463 1464 static void 1465 rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 1466 const struct spdk_json_val *params) 1467 { 1468 struct nvmf_rpc_host_ctx *ctx; 1469 struct spdk_nvmf_subsystem *subsystem; 1470 struct spdk_nvmf_tgt *tgt; 1471 int rc; 1472 1473 ctx = calloc(1, sizeof(*ctx)); 1474 if (ctx == NULL) { 1475 SPDK_ERRLOG("Unable to allocate context to perform RPC\n"); 1476 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1477 return; 1478 } 1479 1480 ctx->request = request; 1481 1482 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1483 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1484 ctx)) { 1485 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1486 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1487 nvmf_rpc_host_ctx_free(ctx); 1488 free(ctx); 1489 return; 1490 } 1491 1492 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1493 if (!tgt) { 1494 SPDK_ERRLOG("Unable to find a target object.\n"); 1495 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1496 "Unable to find a target."); 1497 nvmf_rpc_host_ctx_free(ctx); 1498 free(ctx); 1499 return; 1500 } 1501 1502 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1503 if (!subsystem) { 1504 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1505 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1506 nvmf_rpc_host_ctx_free(ctx); 1507 free(ctx); 1508 return; 1509 } 1510 1511 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 1512 if (rc != 0) { 1513 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1514 nvmf_rpc_host_ctx_free(ctx); 1515 free(ctx); 1516 return; 1517 } 1518 1519 rc = spdk_nvmf_subsystem_disconnect_host(subsystem, ctx->host, 1520 rpc_nvmf_subsystem_remove_host_done, 1521 ctx); 1522 if (rc != 0) { 1523 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1524 nvmf_rpc_host_ctx_free(ctx); 1525 free(ctx); 1526 return; 1527 } 1528 } 1529 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", rpc_nvmf_subsystem_remove_host, 1530 SPDK_RPC_RUNTIME) 1531 1532 1533 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 1534 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1535 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 1536 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1537 }; 1538 1539 static void 1540 rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 1541 const struct spdk_json_val *params) 1542 { 1543 struct nvmf_rpc_host_ctx ctx = {}; 1544 struct spdk_nvmf_subsystem *subsystem; 1545 struct spdk_nvmf_tgt *tgt; 1546 int rc; 1547 1548 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 1549 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 1550 &ctx)) { 1551 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1552 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1553 nvmf_rpc_host_ctx_free(&ctx); 1554 return; 1555 } 1556 1557 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1558 if (!tgt) { 1559 SPDK_ERRLOG("Unable to find a target object.\n"); 1560 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1561 "Unable to find a target."); 1562 nvmf_rpc_host_ctx_free(&ctx); 1563 return; 1564 } 1565 1566 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 1567 if (!subsystem) { 1568 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx.nqn); 1569 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1570 nvmf_rpc_host_ctx_free(&ctx); 1571 return; 1572 } 1573 1574 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx.allow_any_host); 1575 if (rc != 0) { 1576 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1577 nvmf_rpc_host_ctx_free(&ctx); 1578 return; 1579 } 1580 1581 spdk_jsonrpc_send_bool_response(request, true); 1582 nvmf_rpc_host_ctx_free(&ctx); 1583 } 1584 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", rpc_nvmf_subsystem_allow_any_host, 1585 SPDK_RPC_RUNTIME) 1586 1587 struct nvmf_rpc_target_ctx { 1588 char *name; 1589 uint32_t max_subsystems; 1590 }; 1591 1592 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 1593 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1594 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 1595 }; 1596 1597 static void 1598 rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 1599 const struct spdk_json_val *params) 1600 { 1601 struct spdk_nvmf_target_opts opts; 1602 struct nvmf_rpc_target_ctx ctx = {0}; 1603 struct spdk_nvmf_tgt *tgt; 1604 struct spdk_json_write_ctx *w; 1605 1606 /* Decode parameters the first time to get the transport type */ 1607 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 1608 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 1609 &ctx)) { 1610 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1611 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1612 free(ctx.name); 1613 return; 1614 } 1615 1616 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 1617 opts.max_subsystems = ctx.max_subsystems; 1618 1619 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 1620 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1621 "Target already exists."); 1622 free(ctx.name); 1623 return; 1624 } 1625 1626 tgt = spdk_nvmf_tgt_create(&opts); 1627 1628 if (tgt == NULL) { 1629 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1630 "Unable to create the requested target."); 1631 free(ctx.name); 1632 return; 1633 } 1634 1635 w = spdk_jsonrpc_begin_result(request); 1636 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 1637 spdk_jsonrpc_end_result(request, w); 1638 free(ctx.name); 1639 } 1640 SPDK_RPC_REGISTER("nvmf_create_target", rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 1641 1642 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 1643 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1644 }; 1645 1646 static void 1647 nvmf_rpc_destroy_target_done(void *ctx, int status) 1648 { 1649 struct spdk_jsonrpc_request *request = ctx; 1650 1651 spdk_jsonrpc_send_bool_response(request, true); 1652 } 1653 1654 static void 1655 rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 1656 const struct spdk_json_val *params) 1657 { 1658 struct nvmf_rpc_target_ctx ctx = {0}; 1659 struct spdk_nvmf_tgt *tgt; 1660 1661 /* Decode parameters the first time to get the transport type */ 1662 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 1663 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 1664 &ctx)) { 1665 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1666 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1667 free(ctx.name); 1668 return; 1669 } 1670 1671 tgt = spdk_nvmf_get_tgt(ctx.name); 1672 1673 if (tgt == NULL) { 1674 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1675 "The specified target doesn't exist, cannot delete it."); 1676 free(ctx.name); 1677 return; 1678 } 1679 1680 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 1681 free(ctx.name); 1682 } 1683 SPDK_RPC_REGISTER("nvmf_delete_target", rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 1684 1685 static void 1686 rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 1687 const struct spdk_json_val *params) 1688 { 1689 struct spdk_json_write_ctx *w; 1690 struct spdk_nvmf_tgt *tgt; 1691 const char *name; 1692 1693 if (params != NULL) { 1694 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1695 "nvmf_get_targets has no parameters."); 1696 return; 1697 } 1698 1699 w = spdk_jsonrpc_begin_result(request); 1700 spdk_json_write_array_begin(w); 1701 1702 tgt = spdk_nvmf_get_first_tgt(); 1703 1704 while (tgt != NULL) { 1705 name = spdk_nvmf_tgt_get_name(tgt); 1706 spdk_json_write_string(w, name); 1707 tgt = spdk_nvmf_get_next_tgt(tgt); 1708 } 1709 1710 spdk_json_write_array_end(w); 1711 spdk_jsonrpc_end_result(request, w); 1712 } 1713 SPDK_RPC_REGISTER("nvmf_get_targets", rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 1714 1715 struct nvmf_rpc_create_transport_ctx { 1716 char *trtype; 1717 char *tgt_name; 1718 struct spdk_nvmf_transport_opts opts; 1719 struct spdk_jsonrpc_request *request; 1720 }; 1721 1722 /** 1723 * `max_qpairs_per_ctrlr` represents both admin and IO qpairs, that confuses 1724 * users when they configure a transport using RPC. So it was decided to 1725 * deprecate `max_qpairs_per_ctrlr` RPC parameter and use `max_io_qpairs_per_ctrlr` 1726 * But internal logic remains unchanged and SPDK expects that 1727 * spdk_nvmf_transport_opts::max_qpairs_per_ctrlr includes an admin qpair. 1728 * This function parses the number of IO qpairs and adds +1 for admin qpair. 1729 */ 1730 static int 1731 nvmf_rpc_decode_max_io_qpairs(const struct spdk_json_val *val, void *out) 1732 { 1733 uint16_t *i = out; 1734 int rc; 1735 1736 rc = spdk_json_number_to_uint16(val, i); 1737 if (rc == 0) { 1738 (*i)++; 1739 } 1740 1741 return rc; 1742 } 1743 1744 /** 1745 * This function parses deprecated `max_qpairs_per_ctrlr` and warns the user to use 1746 * the new parameter `max_io_qpairs_per_ctrlr` 1747 */ 1748 static int 1749 nvmf_rpc_decode_max_qpairs(const struct spdk_json_val *val, void *out) 1750 { 1751 uint16_t *i = out; 1752 int rc; 1753 1754 rc = spdk_json_number_to_uint16(val, i); 1755 if (rc == 0) { 1756 SPDK_WARNLOG("Parameter max_qpairs_per_ctrlr is deprecated, use max_io_qpairs_per_ctrlr instead.\n"); 1757 } 1758 1759 return rc; 1760 } 1761 1762 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 1763 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 1764 { 1765 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 1766 spdk_json_decode_uint16, true 1767 }, 1768 { 1769 "max_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1770 nvmf_rpc_decode_max_qpairs, true 1771 }, 1772 { 1773 "max_io_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1774 nvmf_rpc_decode_max_io_qpairs, true 1775 }, 1776 { 1777 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 1778 spdk_json_decode_uint32, true 1779 }, 1780 { 1781 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 1782 spdk_json_decode_uint32, true 1783 }, 1784 { 1785 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 1786 spdk_json_decode_uint32, true 1787 }, 1788 { 1789 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 1790 spdk_json_decode_uint32, true 1791 }, 1792 { 1793 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 1794 spdk_json_decode_uint32, true 1795 }, 1796 { 1797 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 1798 spdk_json_decode_uint32, true 1799 }, 1800 { 1801 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 1802 spdk_json_decode_bool, true 1803 }, 1804 { 1805 "abort_timeout_sec", offsetof(struct nvmf_rpc_create_transport_ctx, opts.abort_timeout_sec), 1806 spdk_json_decode_uint32, true 1807 }, 1808 { 1809 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 1810 spdk_json_decode_string, true 1811 }, 1812 }; 1813 1814 static void 1815 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 1816 { 1817 free(ctx->trtype); 1818 free(ctx->tgt_name); 1819 free(ctx); 1820 } 1821 1822 static void 1823 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 1824 { 1825 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 1826 struct spdk_jsonrpc_request *request; 1827 1828 request = ctx->request; 1829 nvmf_rpc_create_transport_ctx_free(ctx); 1830 1831 if (status) { 1832 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 1833 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1834 "Failed to add transport to tgt.(%d)", 1835 status); 1836 return; 1837 } 1838 1839 spdk_jsonrpc_send_bool_response(request, true); 1840 } 1841 1842 static void 1843 rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 1844 const struct spdk_json_val *params) 1845 { 1846 struct nvmf_rpc_create_transport_ctx *ctx; 1847 enum spdk_nvme_transport_type trtype; 1848 struct spdk_nvmf_transport *transport; 1849 struct spdk_nvmf_tgt *tgt; 1850 1851 ctx = calloc(1, sizeof(*ctx)); 1852 if (!ctx) { 1853 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1854 return; 1855 } 1856 1857 /* Decode parameters the first time to get the transport type */ 1858 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_create_transport_decoder, 1859 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1860 ctx)) { 1861 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 1862 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1863 nvmf_rpc_create_transport_ctx_free(ctx); 1864 return; 1865 } 1866 1867 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1868 if (!tgt) { 1869 SPDK_ERRLOG("Unable to find a target object.\n"); 1870 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1871 "Unable to find a target."); 1872 nvmf_rpc_create_transport_ctx_free(ctx); 1873 return; 1874 } 1875 1876 if (spdk_nvme_transport_id_parse_trtype(&trtype, ctx->trtype)) { 1877 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1878 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1879 "Invalid transport type '%s'", ctx->trtype); 1880 nvmf_rpc_create_transport_ctx_free(ctx); 1881 return; 1882 } 1883 1884 /* Initialize all the transport options (based on transport type) and decode the 1885 * parameters again to update any options passed in rpc create transport call. 1886 */ 1887 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts, sizeof(ctx->opts))) { 1888 /* This can happen if user specifies PCIE transport type which isn't valid for 1889 * NVMe-oF. 1890 */ 1891 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1892 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1893 "Invalid transport type '%s'", ctx->trtype); 1894 nvmf_rpc_create_transport_ctx_free(ctx); 1895 return; 1896 } 1897 1898 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_create_transport_decoder, 1899 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1900 ctx)) { 1901 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 1902 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1903 nvmf_rpc_create_transport_ctx_free(ctx); 1904 return; 1905 } 1906 1907 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 1908 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 1909 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1910 "Transport type '%s' already exists", ctx->trtype); 1911 nvmf_rpc_create_transport_ctx_free(ctx); 1912 return; 1913 } 1914 1915 /* Transport can parse additional params themselves */ 1916 ctx->opts.transport_specific = params; 1917 1918 transport = spdk_nvmf_transport_create(ctx->trtype, &ctx->opts); 1919 1920 if (!transport) { 1921 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 1922 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1923 "Transport type '%s' create failed", ctx->trtype); 1924 nvmf_rpc_create_transport_ctx_free(ctx); 1925 return; 1926 } 1927 1928 /* add transport to target */ 1929 ctx->request = request; 1930 spdk_nvmf_tgt_add_transport(tgt, transport, nvmf_rpc_tgt_add_transport_done, ctx); 1931 } 1932 SPDK_RPC_REGISTER("nvmf_create_transport", rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 1933 1934 static void 1935 dump_nvmf_transport(struct spdk_json_write_ctx *w, struct spdk_nvmf_transport *transport) 1936 { 1937 const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport); 1938 1939 spdk_json_write_object_begin(w); 1940 1941 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport)); 1942 spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth); 1943 spdk_json_write_named_uint32(w, "max_io_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr - 1); 1944 spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size); 1945 spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size); 1946 spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size); 1947 spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth); 1948 spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers); 1949 spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size); 1950 spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip); 1951 1952 if (transport->ops->dump_opts) { 1953 transport->ops->dump_opts(transport, w); 1954 } 1955 1956 spdk_json_write_named_uint32(w, "abort_timeout_sec", opts->abort_timeout_sec); 1957 1958 spdk_json_write_object_end(w); 1959 } 1960 1961 struct rpc_get_transport { 1962 char *tgt_name; 1963 }; 1964 1965 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 1966 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 1967 }; 1968 1969 static void 1970 rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 1971 const struct spdk_json_val *params) 1972 { 1973 struct rpc_get_transport req = { 0 }; 1974 struct spdk_json_write_ctx *w; 1975 struct spdk_nvmf_transport *transport; 1976 struct spdk_nvmf_tgt *tgt; 1977 1978 if (params) { 1979 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 1980 SPDK_COUNTOF(rpc_get_transport_decoders), 1981 &req)) { 1982 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1983 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1984 return; 1985 } 1986 } 1987 1988 tgt = spdk_nvmf_get_tgt(req.tgt_name); 1989 if (!tgt) { 1990 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1991 "Unable to find a target."); 1992 free(req.tgt_name); 1993 return; 1994 } 1995 1996 w = spdk_jsonrpc_begin_result(request); 1997 spdk_json_write_array_begin(w); 1998 transport = spdk_nvmf_transport_get_first(tgt); 1999 while (transport) { 2000 dump_nvmf_transport(w, transport); 2001 transport = spdk_nvmf_transport_get_next(transport); 2002 } 2003 spdk_json_write_array_end(w); 2004 spdk_jsonrpc_end_result(request, w); 2005 free(req.tgt_name); 2006 } 2007 SPDK_RPC_REGISTER("nvmf_get_transports", rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 2008 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_transports, get_nvmf_transports) 2009 2010 struct rpc_nvmf_get_stats_ctx { 2011 char *tgt_name; 2012 struct spdk_nvmf_tgt *tgt; 2013 struct spdk_jsonrpc_request *request; 2014 struct spdk_json_write_ctx *w; 2015 }; 2016 2017 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 2018 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 2019 }; 2020 2021 static void 2022 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 2023 { 2024 free(ctx->tgt_name); 2025 free(ctx); 2026 } 2027 2028 static void 2029 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 2030 { 2031 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2032 2033 spdk_json_write_array_end(ctx->w); 2034 spdk_json_write_object_end(ctx->w); 2035 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2036 free_get_stats_ctx(ctx); 2037 } 2038 2039 static void 2040 _rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 2041 { 2042 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2043 struct spdk_io_channel *ch; 2044 struct spdk_nvmf_poll_group *group; 2045 2046 ch = spdk_get_io_channel(ctx->tgt); 2047 group = spdk_io_channel_get_ctx(ch); 2048 2049 spdk_nvmf_poll_group_dump_stat(group, ctx->w); 2050 2051 spdk_put_io_channel(ch); 2052 spdk_for_each_channel_continue(i, 0); 2053 } 2054 2055 2056 static void 2057 rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 2058 const struct spdk_json_val *params) 2059 { 2060 struct rpc_nvmf_get_stats_ctx *ctx; 2061 2062 ctx = calloc(1, sizeof(*ctx)); 2063 if (!ctx) { 2064 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2065 "Memory allocation error"); 2066 return; 2067 } 2068 ctx->request = request; 2069 2070 if (params) { 2071 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 2072 SPDK_COUNTOF(rpc_get_stats_decoders), 2073 ctx)) { 2074 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2075 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2076 free_get_stats_ctx(ctx); 2077 return; 2078 } 2079 } 2080 2081 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2082 if (!ctx->tgt) { 2083 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2084 "Unable to find a target."); 2085 free_get_stats_ctx(ctx); 2086 return; 2087 } 2088 2089 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2090 spdk_json_write_object_begin(ctx->w); 2091 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 2092 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 2093 2094 spdk_for_each_channel(ctx->tgt, 2095 _rpc_nvmf_get_stats, 2096 ctx, 2097 rpc_nvmf_get_stats_done); 2098 } 2099 2100 SPDK_RPC_REGISTER("nvmf_get_stats", rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 2101 2102 static void 2103 dump_nvmf_ctrlr(struct spdk_json_write_ctx *w, struct spdk_nvmf_ctrlr *ctrlr) 2104 { 2105 char uuid_str[SPDK_UUID_STRING_LEN] = {}; 2106 uint32_t count; 2107 2108 spdk_json_write_object_begin(w); 2109 2110 spdk_json_write_named_uint32(w, "cntlid", ctrlr->cntlid); 2111 2112 spdk_json_write_named_string(w, "hostnqn", ctrlr->hostnqn); 2113 2114 spdk_uuid_fmt_lower(uuid_str, sizeof(uuid_str), &ctrlr->hostid); 2115 spdk_json_write_named_string(w, "hostid", uuid_str); 2116 2117 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 2118 spdk_json_write_named_uint32(w, "num_io_qpairs", count); 2119 2120 spdk_json_write_object_end(w); 2121 } 2122 2123 static const char * 2124 nvmf_qpair_state_str(enum spdk_nvmf_qpair_state state) 2125 { 2126 switch (state) { 2127 case SPDK_NVMF_QPAIR_UNINITIALIZED: 2128 return "uninitialized"; 2129 case SPDK_NVMF_QPAIR_ACTIVE: 2130 return "active"; 2131 case SPDK_NVMF_QPAIR_DEACTIVATING: 2132 return "deactivating"; 2133 case SPDK_NVMF_QPAIR_ERROR: 2134 return "error"; 2135 default: 2136 return NULL; 2137 } 2138 } 2139 2140 static void 2141 dump_nvmf_qpair(struct spdk_json_write_ctx *w, struct spdk_nvmf_qpair *qpair) 2142 { 2143 struct spdk_nvme_transport_id listen_trid = {}; 2144 const char *adrfam; 2145 2146 spdk_json_write_object_begin(w); 2147 2148 spdk_json_write_named_uint32(w, "cntlid", qpair->ctrlr->cntlid); 2149 spdk_json_write_named_uint32(w, "qid", qpair->qid); 2150 spdk_json_write_named_string(w, "state", nvmf_qpair_state_str(qpair->state)); 2151 2152 if (spdk_nvmf_qpair_get_listen_trid(qpair, &listen_trid) == 0) { 2153 spdk_json_write_named_object_begin(w, "listen_address"); 2154 adrfam = spdk_nvme_transport_id_adrfam_str(listen_trid.adrfam); 2155 if (adrfam == NULL) { 2156 adrfam = "unknown"; 2157 } 2158 spdk_json_write_named_string(w, "trtype", listen_trid.trstring); 2159 spdk_json_write_named_string(w, "adrfam", adrfam); 2160 spdk_json_write_named_string(w, "traddr", listen_trid.traddr); 2161 spdk_json_write_named_string(w, "trsvcid", listen_trid.trsvcid); 2162 spdk_json_write_object_end(w); 2163 } 2164 2165 spdk_json_write_object_end(w); 2166 } 2167 2168 static const char * 2169 nvme_ana_state_str(enum spdk_nvme_ana_state ana_state) 2170 { 2171 switch (ana_state) { 2172 case SPDK_NVME_ANA_OPTIMIZED_STATE: 2173 return "optimized"; 2174 case SPDK_NVME_ANA_NON_OPTIMIZED_STATE: 2175 return "non_optimized"; 2176 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 2177 return "inaccessible"; 2178 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 2179 return "persistent_loss"; 2180 case SPDK_NVME_ANA_CHANGE_STATE: 2181 return "change"; 2182 default: 2183 return NULL; 2184 } 2185 } 2186 2187 static void 2188 dump_nvmf_subsystem_listener(struct spdk_json_write_ctx *w, 2189 struct spdk_nvmf_subsystem_listener *listener) 2190 { 2191 const struct spdk_nvme_transport_id *trid = listener->trid; 2192 const char *adrfam; 2193 2194 spdk_json_write_object_begin(w); 2195 2196 spdk_json_write_named_object_begin(w, "address"); 2197 adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam); 2198 if (adrfam == NULL) { 2199 adrfam = "unknown"; 2200 } 2201 spdk_json_write_named_string(w, "trtype", trid->trstring); 2202 spdk_json_write_named_string(w, "adrfam", adrfam); 2203 spdk_json_write_named_string(w, "traddr", trid->traddr); 2204 spdk_json_write_named_string(w, "trsvcid", trid->trsvcid); 2205 spdk_json_write_object_end(w); 2206 2207 spdk_json_write_named_string(w, "ana_state", 2208 nvme_ana_state_str(listener->ana_state)); 2209 2210 spdk_json_write_object_end(w); 2211 } 2212 2213 struct rpc_subsystem_query_ctx { 2214 char *nqn; 2215 char *tgt_name; 2216 struct spdk_nvmf_subsystem *subsystem; 2217 struct spdk_jsonrpc_request *request; 2218 struct spdk_json_write_ctx *w; 2219 }; 2220 2221 static const struct spdk_json_object_decoder rpc_subsystem_query_decoders[] = { 2222 {"nqn", offsetof(struct rpc_subsystem_query_ctx, nqn), spdk_json_decode_string}, 2223 {"tgt_name", offsetof(struct rpc_subsystem_query_ctx, tgt_name), spdk_json_decode_string, true}, 2224 }; 2225 2226 static void 2227 free_rpc_subsystem_query_ctx(struct rpc_subsystem_query_ctx *ctx) 2228 { 2229 free(ctx->nqn); 2230 free(ctx->tgt_name); 2231 free(ctx); 2232 } 2233 2234 static void 2235 rpc_nvmf_get_controllers_paused(struct spdk_nvmf_subsystem *subsystem, 2236 void *cb_arg, int status) 2237 { 2238 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2239 struct spdk_json_write_ctx *w; 2240 struct spdk_nvmf_ctrlr *ctrlr; 2241 2242 w = spdk_jsonrpc_begin_result(ctx->request); 2243 2244 spdk_json_write_array_begin(w); 2245 TAILQ_FOREACH(ctrlr, &ctx->subsystem->ctrlrs, link) { 2246 dump_nvmf_ctrlr(w, ctrlr); 2247 } 2248 spdk_json_write_array_end(w); 2249 2250 spdk_jsonrpc_end_result(ctx->request, w); 2251 2252 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2253 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2254 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2255 } 2256 2257 free_rpc_subsystem_query_ctx(ctx); 2258 } 2259 2260 static void 2261 rpc_nvmf_get_qpairs_done(struct spdk_io_channel_iter *i, int status) 2262 { 2263 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2264 2265 spdk_json_write_array_end(ctx->w); 2266 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2267 2268 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2269 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2270 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2271 } 2272 2273 free_rpc_subsystem_query_ctx(ctx); 2274 } 2275 2276 static void 2277 rpc_nvmf_get_qpairs(struct spdk_io_channel_iter *i) 2278 { 2279 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2280 struct spdk_io_channel *ch; 2281 struct spdk_nvmf_poll_group *group; 2282 struct spdk_nvmf_qpair *qpair; 2283 2284 ch = spdk_get_io_channel(ctx->subsystem->tgt); 2285 group = spdk_io_channel_get_ctx(ch); 2286 2287 TAILQ_FOREACH(qpair, &group->qpairs, link) { 2288 if (qpair->ctrlr->subsys == ctx->subsystem) { 2289 dump_nvmf_qpair(ctx->w, qpair); 2290 } 2291 } 2292 2293 spdk_for_each_channel_continue(i, 0); 2294 } 2295 2296 static void 2297 rpc_nvmf_get_qpairs_paused(struct spdk_nvmf_subsystem *subsystem, 2298 void *cb_arg, int status) 2299 { 2300 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2301 2302 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2303 2304 spdk_json_write_array_begin(ctx->w); 2305 2306 spdk_for_each_channel(ctx->subsystem->tgt, 2307 rpc_nvmf_get_qpairs, 2308 ctx, 2309 rpc_nvmf_get_qpairs_done); 2310 } 2311 2312 static void 2313 rpc_nvmf_get_listeners_paused(struct spdk_nvmf_subsystem *subsystem, 2314 void *cb_arg, int status) 2315 { 2316 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2317 struct spdk_json_write_ctx *w; 2318 struct spdk_nvmf_subsystem_listener *listener; 2319 2320 w = spdk_jsonrpc_begin_result(ctx->request); 2321 2322 spdk_json_write_array_begin(w); 2323 2324 for (listener = spdk_nvmf_subsystem_get_first_listener(ctx->subsystem); 2325 listener != NULL; 2326 listener = spdk_nvmf_subsystem_get_next_listener(ctx->subsystem, listener)) { 2327 dump_nvmf_subsystem_listener(w, listener); 2328 } 2329 spdk_json_write_array_end(w); 2330 2331 spdk_jsonrpc_end_result(ctx->request, w); 2332 2333 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2334 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2335 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2336 } 2337 2338 free_rpc_subsystem_query_ctx(ctx); 2339 } 2340 2341 static void 2342 _rpc_nvmf_subsystem_query(struct spdk_jsonrpc_request *request, 2343 const struct spdk_json_val *params, 2344 spdk_nvmf_subsystem_state_change_done cb_fn) 2345 { 2346 struct rpc_subsystem_query_ctx *ctx; 2347 struct spdk_nvmf_subsystem *subsystem; 2348 struct spdk_nvmf_tgt *tgt; 2349 2350 ctx = calloc(1, sizeof(*ctx)); 2351 if (!ctx) { 2352 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2353 "Out of memory"); 2354 return; 2355 } 2356 2357 ctx->request = request; 2358 2359 if (spdk_json_decode_object(params, rpc_subsystem_query_decoders, 2360 SPDK_COUNTOF(rpc_subsystem_query_decoders), 2361 ctx)) { 2362 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2363 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2364 "Invalid parameters"); 2365 free_rpc_subsystem_query_ctx(ctx); 2366 return; 2367 } 2368 2369 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2370 if (!tgt) { 2371 SPDK_ERRLOG("Unable to find a target object.\n"); 2372 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2373 "Unable to find a target"); 2374 free_rpc_subsystem_query_ctx(ctx); 2375 return; 2376 } 2377 2378 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 2379 if (!subsystem) { 2380 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 2381 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2382 "Invalid parameters"); 2383 free_rpc_subsystem_query_ctx(ctx); 2384 return; 2385 } 2386 2387 ctx->subsystem = subsystem; 2388 2389 if (spdk_nvmf_subsystem_pause(subsystem, 0, cb_fn, ctx)) { 2390 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2391 "Internal error"); 2392 free_rpc_subsystem_query_ctx(ctx); 2393 return; 2394 } 2395 } 2396 2397 static void 2398 rpc_nvmf_subsystem_get_controllers(struct spdk_jsonrpc_request *request, 2399 const struct spdk_json_val *params) 2400 { 2401 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_controllers_paused); 2402 } 2403 SPDK_RPC_REGISTER("nvmf_subsystem_get_controllers", rpc_nvmf_subsystem_get_controllers, 2404 SPDK_RPC_RUNTIME); 2405 2406 static void 2407 rpc_nvmf_subsystem_get_qpairs(struct spdk_jsonrpc_request *request, 2408 const struct spdk_json_val *params) 2409 { 2410 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_qpairs_paused); 2411 } 2412 SPDK_RPC_REGISTER("nvmf_subsystem_get_qpairs", rpc_nvmf_subsystem_get_qpairs, SPDK_RPC_RUNTIME); 2413 2414 static void 2415 rpc_nvmf_subsystem_get_listeners(struct spdk_jsonrpc_request *request, 2416 const struct spdk_json_val *params) 2417 { 2418 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_listeners_paused); 2419 } 2420 SPDK_RPC_REGISTER("nvmf_subsystem_get_listeners", rpc_nvmf_subsystem_get_listeners, 2421 SPDK_RPC_RUNTIME); 2422