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