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