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 struct spdk_bdev *bdev; 1266 1267 bdev = spdk_bdev_get_by_name(ctx->ns_params.bdev_name); 1268 if (!bdev) { 1269 SPDK_ERRLOG("No bdev with name %s\n", ctx->ns_params.bdev_name); 1270 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1271 "Invalid parameters"); 1272 ctx->response_sent = true; 1273 goto resume; 1274 } 1275 1276 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 1277 ns_opts.nsid = ctx->ns_params.nsid; 1278 1279 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 1280 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 1281 1282 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 1283 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 1284 1285 if (!spdk_mem_all_zero(&ctx->ns_params.uuid, sizeof(ctx->ns_params.uuid))) { 1286 ns_opts.uuid = ctx->ns_params.uuid; 1287 } 1288 1289 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns(subsystem, bdev, &ns_opts, sizeof(ns_opts), 1290 ctx->ns_params.ptpl_file); 1291 if (ctx->ns_params.nsid == 0) { 1292 SPDK_ERRLOG("Unable to add namespace\n"); 1293 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1294 "Invalid parameters"); 1295 ctx->response_sent = true; 1296 goto resume; 1297 } 1298 1299 resume: 1300 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 1301 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1302 nvmf_rpc_ns_ctx_free(ctx); 1303 } 1304 } 1305 1306 static void 1307 rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 1308 const struct spdk_json_val *params) 1309 { 1310 struct nvmf_rpc_ns_ctx *ctx; 1311 struct spdk_nvmf_subsystem *subsystem; 1312 struct spdk_nvmf_tgt *tgt; 1313 int rc; 1314 1315 ctx = calloc(1, sizeof(*ctx)); 1316 if (!ctx) { 1317 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1318 return; 1319 } 1320 1321 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ns_decoder, 1322 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), 1323 ctx)) { 1324 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1325 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1326 nvmf_rpc_ns_ctx_free(ctx); 1327 return; 1328 } 1329 1330 ctx->request = request; 1331 ctx->response_sent = false; 1332 1333 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1334 if (!tgt) { 1335 SPDK_ERRLOG("Unable to find a target object.\n"); 1336 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1337 "Unable to find a target."); 1338 nvmf_rpc_ns_ctx_free(ctx); 1339 return; 1340 } 1341 1342 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1343 if (!subsystem) { 1344 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1345 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1346 nvmf_rpc_ns_ctx_free(ctx); 1347 return; 1348 } 1349 1350 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_ns_paused, ctx); 1351 if (rc != 0) { 1352 if (rc == -EBUSY) { 1353 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1354 "subsystem busy, retry later.\n"); 1355 } else { 1356 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1357 } 1358 nvmf_rpc_ns_ctx_free(ctx); 1359 } 1360 } 1361 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1362 1363 struct nvmf_rpc_remove_ns_ctx { 1364 char *nqn; 1365 char *tgt_name; 1366 uint32_t nsid; 1367 1368 struct spdk_jsonrpc_request *request; 1369 bool response_sent; 1370 }; 1371 1372 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1373 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1374 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1375 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1376 }; 1377 1378 static void 1379 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1380 { 1381 free(ctx->nqn); 1382 free(ctx->tgt_name); 1383 free(ctx); 1384 } 1385 1386 static void 1387 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1388 void *cb_arg, int status) 1389 { 1390 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1391 struct spdk_jsonrpc_request *request = ctx->request; 1392 bool response_sent = ctx->response_sent; 1393 struct spdk_json_write_ctx *w; 1394 1395 nvmf_rpc_remove_ns_ctx_free(ctx); 1396 1397 if (response_sent) { 1398 return; 1399 } 1400 1401 w = spdk_jsonrpc_begin_result(request); 1402 spdk_json_write_bool(w, true); 1403 spdk_jsonrpc_end_result(request, w); 1404 } 1405 1406 static void 1407 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1408 void *cb_arg, int status) 1409 { 1410 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1411 int ret; 1412 1413 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1414 if (ret < 0) { 1415 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1416 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1417 "Invalid parameters"); 1418 ctx->response_sent = true; 1419 } 1420 1421 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1422 if (!ctx->response_sent) { 1423 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1424 } 1425 nvmf_rpc_remove_ns_ctx_free(ctx); 1426 } 1427 } 1428 1429 static void 1430 rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1431 const struct spdk_json_val *params) 1432 { 1433 struct nvmf_rpc_remove_ns_ctx *ctx; 1434 struct spdk_nvmf_subsystem *subsystem; 1435 struct spdk_nvmf_tgt *tgt; 1436 int rc; 1437 1438 ctx = calloc(1, sizeof(*ctx)); 1439 if (!ctx) { 1440 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1441 return; 1442 } 1443 1444 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1445 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1446 ctx)) { 1447 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1448 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1449 nvmf_rpc_remove_ns_ctx_free(ctx); 1450 return; 1451 } 1452 1453 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1454 if (!tgt) { 1455 SPDK_ERRLOG("Unable to find a target object.\n"); 1456 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1457 "Unable to find a target."); 1458 nvmf_rpc_remove_ns_ctx_free(ctx); 1459 return; 1460 } 1461 1462 ctx->request = request; 1463 ctx->response_sent = false; 1464 1465 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1466 if (!subsystem) { 1467 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1468 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1469 nvmf_rpc_remove_ns_ctx_free(ctx); 1470 return; 1471 } 1472 1473 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_remove_ns_paused, ctx); 1474 if (rc != 0) { 1475 if (rc == -EBUSY) { 1476 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1477 "subsystem busy, retry later.\n"); 1478 } else { 1479 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1480 } 1481 nvmf_rpc_remove_ns_ctx_free(ctx); 1482 } 1483 } 1484 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1485 1486 enum nvmf_rpc_host_op { 1487 NVMF_RPC_HOST_ADD, 1488 NVMF_RPC_HOST_REMOVE, 1489 NVMF_RPC_HOST_ALLOW_ANY, 1490 }; 1491 1492 struct nvmf_rpc_host_ctx { 1493 struct spdk_jsonrpc_request *request; 1494 1495 char *nqn; 1496 char *host; 1497 char *tgt_name; 1498 1499 enum nvmf_rpc_host_op op; 1500 1501 bool allow_any_host; 1502 1503 bool response_sent; 1504 }; 1505 1506 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1507 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1508 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1509 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1510 }; 1511 1512 static void 1513 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1514 { 1515 free(ctx->nqn); 1516 free(ctx->host); 1517 free(ctx->tgt_name); 1518 free(ctx); 1519 } 1520 1521 static void 1522 nvmf_rpc_host_resumed(struct spdk_nvmf_subsystem *subsystem, 1523 void *cb_arg, int status) 1524 { 1525 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1526 struct spdk_jsonrpc_request *request; 1527 struct spdk_json_write_ctx *w; 1528 bool response_sent = ctx->response_sent; 1529 1530 request = ctx->request; 1531 nvmf_rpc_host_ctx_free(ctx); 1532 1533 if (response_sent) { 1534 return; 1535 } 1536 1537 w = spdk_jsonrpc_begin_result(request); 1538 spdk_json_write_bool(w, true); 1539 spdk_jsonrpc_end_result(request, w); 1540 } 1541 1542 static void 1543 nvmf_rpc_host_paused(struct spdk_nvmf_subsystem *subsystem, 1544 void *cb_arg, int status) 1545 { 1546 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1547 int rc = -1; 1548 1549 switch (ctx->op) { 1550 case NVMF_RPC_HOST_ADD: 1551 rc = spdk_nvmf_subsystem_add_host(subsystem, ctx->host); 1552 break; 1553 case NVMF_RPC_HOST_REMOVE: 1554 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 1555 break; 1556 case NVMF_RPC_HOST_ALLOW_ANY: 1557 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx->allow_any_host); 1558 break; 1559 } 1560 1561 if (rc != 0) { 1562 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1563 ctx->response_sent = true; 1564 } 1565 1566 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_host_resumed, ctx)) { 1567 if (!ctx->response_sent) { 1568 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1569 } 1570 nvmf_rpc_host_ctx_free(ctx); 1571 } 1572 } 1573 1574 static void 1575 rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1576 const struct spdk_json_val *params) 1577 { 1578 struct nvmf_rpc_host_ctx *ctx; 1579 struct spdk_nvmf_subsystem *subsystem; 1580 struct spdk_nvmf_tgt *tgt; 1581 int rc; 1582 1583 ctx = calloc(1, sizeof(*ctx)); 1584 if (!ctx) { 1585 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1586 return; 1587 } 1588 1589 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1590 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1591 ctx)) { 1592 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1593 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1594 nvmf_rpc_host_ctx_free(ctx); 1595 return; 1596 } 1597 1598 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1599 if (!tgt) { 1600 SPDK_ERRLOG("Unable to find a target object.\n"); 1601 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1602 "Unable to find a target."); 1603 nvmf_rpc_host_ctx_free(ctx); 1604 return; 1605 } 1606 1607 ctx->request = request; 1608 ctx->op = NVMF_RPC_HOST_ADD; 1609 ctx->response_sent = false; 1610 1611 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1612 if (!subsystem) { 1613 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1614 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1615 nvmf_rpc_host_ctx_free(ctx); 1616 return; 1617 } 1618 1619 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx); 1620 if (rc != 0) { 1621 if (rc == -EBUSY) { 1622 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1623 "subsystem busy, retry later.\n"); 1624 } else { 1625 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1626 } 1627 nvmf_rpc_host_ctx_free(ctx); 1628 } 1629 } 1630 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 1631 1632 static void 1633 rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 1634 const struct spdk_json_val *params) 1635 { 1636 struct nvmf_rpc_host_ctx *ctx; 1637 struct spdk_nvmf_subsystem *subsystem; 1638 struct spdk_nvmf_tgt *tgt; 1639 int rc; 1640 1641 ctx = calloc(1, sizeof(*ctx)); 1642 if (!ctx) { 1643 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1644 return; 1645 } 1646 1647 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1648 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1649 ctx)) { 1650 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1651 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1652 nvmf_rpc_host_ctx_free(ctx); 1653 return; 1654 } 1655 1656 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1657 if (!tgt) { 1658 SPDK_ERRLOG("Unable to find a target object.\n"); 1659 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1660 "Unable to find a target."); 1661 nvmf_rpc_host_ctx_free(ctx); 1662 return; 1663 } 1664 1665 ctx->request = request; 1666 ctx->op = NVMF_RPC_HOST_REMOVE; 1667 ctx->response_sent = false; 1668 1669 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1670 if (!subsystem) { 1671 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1672 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1673 nvmf_rpc_host_ctx_free(ctx); 1674 return; 1675 } 1676 1677 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx); 1678 if (rc != 0) { 1679 if (rc == -EBUSY) { 1680 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1681 "subsystem busy, retry later.\n"); 1682 } else { 1683 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1684 } 1685 nvmf_rpc_host_ctx_free(ctx); 1686 } 1687 } 1688 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", rpc_nvmf_subsystem_remove_host, 1689 SPDK_RPC_RUNTIME) 1690 1691 1692 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 1693 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1694 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 1695 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1696 }; 1697 1698 static void 1699 rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 1700 const struct spdk_json_val *params) 1701 { 1702 struct nvmf_rpc_host_ctx *ctx; 1703 struct spdk_nvmf_subsystem *subsystem; 1704 struct spdk_nvmf_tgt *tgt; 1705 int rc; 1706 1707 ctx = calloc(1, sizeof(*ctx)); 1708 if (!ctx) { 1709 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1710 return; 1711 } 1712 1713 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 1714 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 1715 ctx)) { 1716 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1717 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1718 nvmf_rpc_host_ctx_free(ctx); 1719 return; 1720 } 1721 1722 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1723 if (!tgt) { 1724 SPDK_ERRLOG("Unable to find a target object.\n"); 1725 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1726 "Unable to find a target."); 1727 nvmf_rpc_host_ctx_free(ctx); 1728 return; 1729 } 1730 1731 ctx->request = request; 1732 ctx->op = NVMF_RPC_HOST_ALLOW_ANY; 1733 ctx->response_sent = false; 1734 1735 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1736 if (!subsystem) { 1737 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1738 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1739 nvmf_rpc_host_ctx_free(ctx); 1740 return; 1741 } 1742 1743 rc = spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx); 1744 if (rc != 0) { 1745 if (rc == -EBUSY) { 1746 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1747 "subsystem busy, retry later.\n"); 1748 } else { 1749 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1750 } 1751 nvmf_rpc_host_ctx_free(ctx); 1752 } 1753 } 1754 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", rpc_nvmf_subsystem_allow_any_host, 1755 SPDK_RPC_RUNTIME) 1756 1757 struct nvmf_rpc_target_ctx { 1758 char *name; 1759 uint32_t max_subsystems; 1760 }; 1761 1762 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 1763 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1764 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 1765 }; 1766 1767 static void 1768 rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 1769 const struct spdk_json_val *params) 1770 { 1771 struct spdk_nvmf_target_opts opts; 1772 struct nvmf_rpc_target_ctx ctx = {0}; 1773 struct spdk_nvmf_tgt *tgt; 1774 struct spdk_json_write_ctx *w; 1775 1776 /* Decode parameters the first time to get the transport type */ 1777 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 1778 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 1779 &ctx)) { 1780 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1781 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1782 free(ctx.name); 1783 return; 1784 } 1785 1786 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 1787 opts.max_subsystems = ctx.max_subsystems; 1788 1789 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 1790 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1791 "Target already exists."); 1792 free(ctx.name); 1793 return; 1794 } 1795 1796 tgt = spdk_nvmf_tgt_create(&opts); 1797 1798 if (tgt == NULL) { 1799 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1800 "Unable to create the requested target."); 1801 free(ctx.name); 1802 return; 1803 } 1804 1805 w = spdk_jsonrpc_begin_result(request); 1806 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 1807 spdk_jsonrpc_end_result(request, w); 1808 free(ctx.name); 1809 } 1810 SPDK_RPC_REGISTER("nvmf_create_target", rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 1811 1812 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 1813 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1814 }; 1815 1816 static void 1817 nvmf_rpc_destroy_target_done(void *ctx, int status) 1818 { 1819 struct spdk_jsonrpc_request *request = ctx; 1820 struct spdk_json_write_ctx *w; 1821 1822 w = spdk_jsonrpc_begin_result(request); 1823 spdk_json_write_bool(w, true); 1824 spdk_jsonrpc_end_result(request, w); 1825 } 1826 1827 static void 1828 rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 1829 const struct spdk_json_val *params) 1830 { 1831 struct nvmf_rpc_target_ctx ctx = {0}; 1832 struct spdk_nvmf_tgt *tgt; 1833 1834 /* Decode parameters the first time to get the transport type */ 1835 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 1836 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 1837 &ctx)) { 1838 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1839 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1840 free(ctx.name); 1841 return; 1842 } 1843 1844 tgt = spdk_nvmf_get_tgt(ctx.name); 1845 1846 if (tgt == NULL) { 1847 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1848 "The specified target doesn't exist, cannot delete it."); 1849 free(ctx.name); 1850 return; 1851 } 1852 1853 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 1854 free(ctx.name); 1855 } 1856 SPDK_RPC_REGISTER("nvmf_delete_target", rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 1857 1858 static void 1859 rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 1860 const struct spdk_json_val *params) 1861 { 1862 struct spdk_json_write_ctx *w; 1863 struct spdk_nvmf_tgt *tgt; 1864 const char *name; 1865 1866 if (params != NULL) { 1867 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1868 "nvmf_get_targets has no parameters."); 1869 return; 1870 } 1871 1872 w = spdk_jsonrpc_begin_result(request); 1873 spdk_json_write_array_begin(w); 1874 1875 tgt = spdk_nvmf_get_first_tgt(); 1876 1877 while (tgt != NULL) { 1878 name = spdk_nvmf_tgt_get_name(tgt); 1879 spdk_json_write_string(w, name); 1880 tgt = spdk_nvmf_get_next_tgt(tgt); 1881 } 1882 1883 spdk_json_write_array_end(w); 1884 spdk_jsonrpc_end_result(request, w); 1885 } 1886 SPDK_RPC_REGISTER("nvmf_get_targets", rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 1887 1888 struct nvmf_rpc_create_transport_ctx { 1889 char *trtype; 1890 char *tgt_name; 1891 struct spdk_nvmf_transport_opts opts; 1892 struct spdk_jsonrpc_request *request; 1893 }; 1894 1895 /** 1896 * `max_qpairs_per_ctrlr` represents both admin and IO qpairs, that confuses 1897 * users when they configure a transport using RPC. So it was decided to 1898 * deprecate `max_qpairs_per_ctrlr` RPC parameter and use `max_io_qpairs_per_ctrlr` 1899 * But internal logic remains unchanged and SPDK expects that 1900 * spdk_nvmf_transport_opts::max_qpairs_per_ctrlr includes an admin qpair. 1901 * This function parses the number of IO qpairs and adds +1 for admin qpair. 1902 */ 1903 static int 1904 nvmf_rpc_decode_max_io_qpairs(const struct spdk_json_val *val, void *out) 1905 { 1906 uint16_t *i = out; 1907 int rc; 1908 1909 rc = spdk_json_number_to_uint16(val, i); 1910 if (rc == 0) { 1911 (*i)++; 1912 } 1913 1914 return rc; 1915 } 1916 1917 /** 1918 * This function parses deprecated `max_qpairs_per_ctrlr` and warns the user to use 1919 * the new parameter `max_io_qpairs_per_ctrlr` 1920 */ 1921 static int 1922 nvmf_rpc_decode_max_qpairs(const struct spdk_json_val *val, void *out) 1923 { 1924 uint16_t *i = out; 1925 int rc; 1926 1927 rc = spdk_json_number_to_uint16(val, i); 1928 if (rc == 0) { 1929 SPDK_WARNLOG("Parameter max_qpairs_per_ctrlr is deprecated, use max_io_qpairs_per_ctrlr instead.\n"); 1930 } 1931 1932 return rc; 1933 } 1934 1935 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 1936 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 1937 { 1938 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 1939 spdk_json_decode_uint16, true 1940 }, 1941 { 1942 "max_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1943 nvmf_rpc_decode_max_qpairs, true 1944 }, 1945 { 1946 "max_io_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1947 nvmf_rpc_decode_max_io_qpairs, true 1948 }, 1949 { 1950 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 1951 spdk_json_decode_uint32, true 1952 }, 1953 { 1954 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 1955 spdk_json_decode_uint32, true 1956 }, 1957 { 1958 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 1959 spdk_json_decode_uint32, true 1960 }, 1961 { 1962 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 1963 spdk_json_decode_uint32, true 1964 }, 1965 { 1966 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 1967 spdk_json_decode_uint32, true 1968 }, 1969 { 1970 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 1971 spdk_json_decode_uint32, true 1972 }, 1973 { 1974 "max_srq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_srq_depth), 1975 spdk_json_decode_uint32, true 1976 }, 1977 { 1978 "no_srq", offsetof(struct nvmf_rpc_create_transport_ctx, opts.no_srq), 1979 spdk_json_decode_bool, true 1980 }, 1981 { 1982 "c2h_success", offsetof(struct nvmf_rpc_create_transport_ctx, opts.c2h_success), 1983 spdk_json_decode_bool, true 1984 }, 1985 { 1986 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 1987 spdk_json_decode_bool, true 1988 }, 1989 { 1990 "sock_priority", offsetof(struct nvmf_rpc_create_transport_ctx, opts.sock_priority), 1991 spdk_json_decode_uint32, true 1992 }, 1993 { 1994 "acceptor_backlog", offsetof(struct nvmf_rpc_create_transport_ctx, opts.acceptor_backlog), 1995 spdk_json_decode_int32, true 1996 }, 1997 { 1998 "abort_timeout_sec", offsetof(struct nvmf_rpc_create_transport_ctx, opts.abort_timeout_sec), 1999 spdk_json_decode_uint32, true 2000 }, 2001 { 2002 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 2003 spdk_json_decode_string, true 2004 }, 2005 }; 2006 2007 static void 2008 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 2009 { 2010 free(ctx->trtype); 2011 free(ctx->tgt_name); 2012 free(ctx); 2013 } 2014 2015 static void 2016 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 2017 { 2018 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 2019 struct spdk_jsonrpc_request *request; 2020 struct spdk_json_write_ctx *w; 2021 2022 request = ctx->request; 2023 nvmf_rpc_create_transport_ctx_free(ctx); 2024 2025 if (status) { 2026 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 2027 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2028 "Failed to add transport to tgt.(%d)\n", 2029 status); 2030 return; 2031 } 2032 2033 w = spdk_jsonrpc_begin_result(request); 2034 spdk_json_write_bool(w, true); 2035 spdk_jsonrpc_end_result(request, w); 2036 } 2037 2038 static void 2039 rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 2040 const struct spdk_json_val *params) 2041 { 2042 struct nvmf_rpc_create_transport_ctx *ctx; 2043 enum spdk_nvme_transport_type trtype; 2044 struct spdk_nvmf_transport *transport; 2045 struct spdk_nvmf_tgt *tgt; 2046 2047 ctx = calloc(1, sizeof(*ctx)); 2048 if (!ctx) { 2049 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 2050 return; 2051 } 2052 2053 /* Decode parameters the first time to get the transport type */ 2054 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 2055 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 2056 ctx)) { 2057 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2058 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2059 nvmf_rpc_create_transport_ctx_free(ctx); 2060 return; 2061 } 2062 2063 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2064 if (!tgt) { 2065 SPDK_ERRLOG("Unable to find a target object.\n"); 2066 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2067 "Unable to find a target."); 2068 nvmf_rpc_create_transport_ctx_free(ctx); 2069 return; 2070 } 2071 2072 if (spdk_nvme_transport_id_parse_trtype(&trtype, ctx->trtype)) { 2073 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 2074 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2075 "Invalid transport type '%s'\n", ctx->trtype); 2076 nvmf_rpc_create_transport_ctx_free(ctx); 2077 return; 2078 } 2079 2080 /* Initialize all the transport options (based on transport type) and decode the 2081 * parameters again to update any options passed in rpc create transport call. 2082 */ 2083 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts)) { 2084 /* This can happen if user specifies PCIE transport type which isn't valid for 2085 * NVMe-oF. 2086 */ 2087 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 2088 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2089 "Invalid transport type '%s'\n", ctx->trtype); 2090 nvmf_rpc_create_transport_ctx_free(ctx); 2091 return; 2092 } 2093 2094 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 2095 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 2096 ctx)) { 2097 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2098 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2099 nvmf_rpc_create_transport_ctx_free(ctx); 2100 return; 2101 } 2102 2103 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 2104 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 2105 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2106 "Transport type '%s' already exists\n", ctx->trtype); 2107 nvmf_rpc_create_transport_ctx_free(ctx); 2108 return; 2109 } 2110 2111 transport = spdk_nvmf_transport_create(ctx->trtype, &ctx->opts); 2112 2113 if (!transport) { 2114 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 2115 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2116 "Transport type '%s' create failed\n", ctx->trtype); 2117 nvmf_rpc_create_transport_ctx_free(ctx); 2118 return; 2119 } 2120 2121 /* add transport to target */ 2122 ctx->request = request; 2123 spdk_nvmf_tgt_add_transport(tgt, transport, nvmf_rpc_tgt_add_transport_done, ctx); 2124 } 2125 SPDK_RPC_REGISTER("nvmf_create_transport", rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 2126 2127 static void 2128 dump_nvmf_transport(struct spdk_json_write_ctx *w, struct spdk_nvmf_transport *transport) 2129 { 2130 const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport); 2131 spdk_nvme_transport_type_t type = spdk_nvmf_get_transport_type(transport); 2132 2133 spdk_json_write_object_begin(w); 2134 2135 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport)); 2136 spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth); 2137 spdk_json_write_named_uint32(w, "max_io_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr - 1); 2138 spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size); 2139 spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size); 2140 spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size); 2141 spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth); 2142 spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers); 2143 spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size); 2144 spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip); 2145 if (type == SPDK_NVME_TRANSPORT_RDMA) { 2146 spdk_json_write_named_uint32(w, "max_srq_depth", opts->max_srq_depth); 2147 spdk_json_write_named_bool(w, "no_srq", opts->no_srq); 2148 spdk_json_write_named_int32(w, "acceptor_backlog", opts->acceptor_backlog); 2149 } else if (type == SPDK_NVME_TRANSPORT_TCP) { 2150 spdk_json_write_named_bool(w, "c2h_success", opts->c2h_success); 2151 spdk_json_write_named_uint32(w, "sock_priority", opts->sock_priority); 2152 } 2153 spdk_json_write_named_uint32(w, "abort_timeout_sec", opts->abort_timeout_sec); 2154 2155 spdk_json_write_object_end(w); 2156 } 2157 2158 struct rpc_get_transport { 2159 char *tgt_name; 2160 }; 2161 2162 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 2163 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 2164 }; 2165 2166 static void 2167 rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 2168 const struct spdk_json_val *params) 2169 { 2170 struct rpc_get_transport req = { 0 }; 2171 struct spdk_json_write_ctx *w; 2172 struct spdk_nvmf_transport *transport; 2173 struct spdk_nvmf_tgt *tgt; 2174 2175 if (params) { 2176 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 2177 SPDK_COUNTOF(rpc_get_transport_decoders), 2178 &req)) { 2179 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2180 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2181 return; 2182 } 2183 } 2184 2185 tgt = spdk_nvmf_get_tgt(req.tgt_name); 2186 if (!tgt) { 2187 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2188 "Unable to find a target."); 2189 free(req.tgt_name); 2190 return; 2191 } 2192 2193 w = spdk_jsonrpc_begin_result(request); 2194 spdk_json_write_array_begin(w); 2195 transport = spdk_nvmf_transport_get_first(tgt); 2196 while (transport) { 2197 dump_nvmf_transport(w, transport); 2198 transport = spdk_nvmf_transport_get_next(transport); 2199 } 2200 spdk_json_write_array_end(w); 2201 spdk_jsonrpc_end_result(request, w); 2202 free(req.tgt_name); 2203 } 2204 SPDK_RPC_REGISTER("nvmf_get_transports", rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 2205 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_transports, get_nvmf_transports) 2206 2207 struct rpc_nvmf_get_stats_ctx { 2208 char *tgt_name; 2209 struct spdk_nvmf_tgt *tgt; 2210 struct spdk_jsonrpc_request *request; 2211 struct spdk_json_write_ctx *w; 2212 }; 2213 2214 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 2215 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 2216 }; 2217 2218 static void 2219 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 2220 { 2221 free(ctx->tgt_name); 2222 free(ctx); 2223 } 2224 2225 static void 2226 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 2227 { 2228 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2229 2230 spdk_json_write_array_end(ctx->w); 2231 spdk_json_write_object_end(ctx->w); 2232 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2233 free_get_stats_ctx(ctx); 2234 } 2235 2236 static void 2237 write_nvmf_transport_stats(struct spdk_json_write_ctx *w, 2238 struct spdk_nvmf_transport_poll_group_stat *stat) 2239 { 2240 uint64_t i; 2241 2242 spdk_json_write_object_begin(w); 2243 spdk_json_write_named_string(w, "trtype", 2244 spdk_nvme_transport_id_trtype_str(stat->trtype)); 2245 switch (stat->trtype) { 2246 case SPDK_NVME_TRANSPORT_RDMA: 2247 spdk_json_write_named_uint64(w, "pending_data_buffer", stat->rdma.pending_data_buffer); 2248 spdk_json_write_named_array_begin(w, "devices"); 2249 for (i = 0; i < stat->rdma.num_devices; ++i) { 2250 spdk_json_write_object_begin(w); 2251 spdk_json_write_named_string(w, "name", stat->rdma.devices[i].name); 2252 spdk_json_write_named_uint64(w, "polls", stat->rdma.devices[i].polls); 2253 spdk_json_write_named_uint64(w, "completions", stat->rdma.devices[i].completions); 2254 spdk_json_write_named_uint64(w, "requests", 2255 stat->rdma.devices[i].requests); 2256 spdk_json_write_named_uint64(w, "request_latency", 2257 stat->rdma.devices[i].request_latency); 2258 spdk_json_write_named_uint64(w, "pending_free_request", 2259 stat->rdma.devices[i].pending_free_request); 2260 spdk_json_write_named_uint64(w, "pending_rdma_read", 2261 stat->rdma.devices[i].pending_rdma_read); 2262 spdk_json_write_named_uint64(w, "pending_rdma_write", 2263 stat->rdma.devices[i].pending_rdma_write); 2264 spdk_json_write_object_end(w); 2265 } 2266 spdk_json_write_array_end(w); 2267 break; 2268 default: 2269 break; 2270 } 2271 spdk_json_write_object_end(w); 2272 } 2273 2274 static void 2275 _rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 2276 { 2277 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2278 struct spdk_nvmf_transport *transport; 2279 struct spdk_nvmf_poll_group_stat stat; 2280 struct spdk_nvmf_transport_poll_group_stat *trstat; 2281 int rc; 2282 2283 if (0 == spdk_nvmf_poll_group_get_stat(ctx->tgt, &stat)) { 2284 spdk_json_write_object_begin(ctx->w); 2285 spdk_json_write_named_string(ctx->w, "name", spdk_thread_get_name(spdk_get_thread())); 2286 spdk_json_write_named_uint32(ctx->w, "admin_qpairs", stat.admin_qpairs); 2287 spdk_json_write_named_uint32(ctx->w, "io_qpairs", stat.io_qpairs); 2288 spdk_json_write_named_uint64(ctx->w, "pending_bdev_io", stat.pending_bdev_io); 2289 2290 spdk_json_write_named_array_begin(ctx->w, "transports"); 2291 transport = spdk_nvmf_transport_get_first(ctx->tgt); 2292 while (transport) { 2293 rc = spdk_nvmf_transport_poll_group_get_stat(ctx->tgt, transport, &trstat); 2294 if (0 == rc) { 2295 write_nvmf_transport_stats(ctx->w, trstat); 2296 spdk_nvmf_transport_poll_group_free_stat(transport, trstat); 2297 } else if (-ENOTSUP != rc) { 2298 SPDK_ERRLOG("Failed to get poll group statistics for transport %s, errno %d\n", 2299 spdk_nvme_transport_id_trtype_str(spdk_nvmf_get_transport_type(transport)), 2300 rc); 2301 } 2302 transport = spdk_nvmf_transport_get_next(transport); 2303 } 2304 spdk_json_write_array_end(ctx->w); 2305 spdk_json_write_object_end(ctx->w); 2306 } 2307 2308 spdk_for_each_channel_continue(i, 0); 2309 } 2310 2311 2312 static void 2313 rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 2314 const struct spdk_json_val *params) 2315 { 2316 struct rpc_nvmf_get_stats_ctx *ctx; 2317 2318 ctx = calloc(1, sizeof(*ctx)); 2319 if (!ctx) { 2320 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2321 "Memory allocation error"); 2322 return; 2323 } 2324 ctx->request = request; 2325 2326 if (params) { 2327 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 2328 SPDK_COUNTOF(rpc_get_stats_decoders), 2329 ctx)) { 2330 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2331 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2332 free_get_stats_ctx(ctx); 2333 return; 2334 } 2335 } 2336 2337 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2338 if (!ctx->tgt) { 2339 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2340 "Unable to find a target."); 2341 free_get_stats_ctx(ctx); 2342 return; 2343 } 2344 2345 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2346 spdk_json_write_object_begin(ctx->w); 2347 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 2348 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 2349 2350 spdk_for_each_channel(ctx->tgt, 2351 _rpc_nvmf_get_stats, 2352 ctx, 2353 rpc_nvmf_get_stats_done); 2354 } 2355 2356 SPDK_RPC_REGISTER("nvmf_get_stats", rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 2357 2358 static void 2359 dump_nvmf_ctrlr(struct spdk_json_write_ctx *w, struct spdk_nvmf_ctrlr *ctrlr) 2360 { 2361 char uuid_str[SPDK_UUID_STRING_LEN] = {}; 2362 uint32_t count; 2363 2364 spdk_json_write_object_begin(w); 2365 2366 spdk_json_write_named_uint32(w, "cntlid", ctrlr->cntlid); 2367 2368 spdk_json_write_named_string(w, "hostnqn", ctrlr->hostnqn); 2369 2370 spdk_uuid_fmt_lower(uuid_str, sizeof(uuid_str), &ctrlr->hostid); 2371 spdk_json_write_named_string(w, "hostid", uuid_str); 2372 2373 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 2374 spdk_json_write_named_uint32(w, "num_io_qpairs", count); 2375 2376 spdk_json_write_object_end(w); 2377 } 2378 2379 static const char * 2380 nvmf_qpair_state_str(enum spdk_nvmf_qpair_state state) 2381 { 2382 switch (state) { 2383 case SPDK_NVMF_QPAIR_UNINITIALIZED: 2384 return "uninitialized"; 2385 case SPDK_NVMF_QPAIR_ACTIVE: 2386 return "active"; 2387 case SPDK_NVMF_QPAIR_DEACTIVATING: 2388 return "deactivating"; 2389 case SPDK_NVMF_QPAIR_ERROR: 2390 return "error"; 2391 default: 2392 return NULL; 2393 } 2394 } 2395 2396 static void 2397 dump_nvmf_qpair(struct spdk_json_write_ctx *w, struct spdk_nvmf_qpair *qpair) 2398 { 2399 const struct spdk_nvme_transport_id *trid = qpair->trid; 2400 const char *adrfam; 2401 2402 spdk_json_write_object_begin(w); 2403 2404 spdk_json_write_named_uint32(w, "cntlid", qpair->ctrlr->cntlid); 2405 spdk_json_write_named_uint32(w, "qid", qpair->qid); 2406 spdk_json_write_named_string(w, "state", nvmf_qpair_state_str(qpair->state)); 2407 2408 spdk_json_write_named_object_begin(w, "listen_address"); 2409 adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam); 2410 if (adrfam == NULL) { 2411 adrfam = "unknown"; 2412 } 2413 spdk_json_write_named_string(w, "trtype", trid->trstring); 2414 spdk_json_write_named_string(w, "adrfam", adrfam); 2415 spdk_json_write_named_string(w, "traddr", trid->traddr); 2416 spdk_json_write_named_string(w, "trsvcid", trid->trsvcid); 2417 spdk_json_write_object_end(w); 2418 2419 spdk_json_write_object_end(w); 2420 } 2421 2422 static const char * 2423 nvme_ana_state_str(enum spdk_nvme_ana_state ana_state) 2424 { 2425 switch (ana_state) { 2426 case SPDK_NVME_ANA_OPTIMIZED_STATE: 2427 return "optimized"; 2428 case SPDK_NVME_ANA_NON_OPTIMIZED_STATE: 2429 return "non_optimized"; 2430 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 2431 return "inaccessible"; 2432 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 2433 return "persistent_loss"; 2434 case SPDK_NVME_ANA_CHANGE_STATE: 2435 return "change"; 2436 default: 2437 return NULL; 2438 } 2439 } 2440 2441 static void 2442 dump_nvmf_subsystem_listener(struct spdk_json_write_ctx *w, 2443 struct spdk_nvmf_subsystem_listener *listener) 2444 { 2445 const struct spdk_nvme_transport_id *trid = listener->trid; 2446 const char *adrfam; 2447 2448 spdk_json_write_object_begin(w); 2449 2450 spdk_json_write_named_object_begin(w, "address"); 2451 adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam); 2452 if (adrfam == NULL) { 2453 adrfam = "unknown"; 2454 } 2455 spdk_json_write_named_string(w, "trtype", trid->trstring); 2456 spdk_json_write_named_string(w, "adrfam", adrfam); 2457 spdk_json_write_named_string(w, "traddr", trid->traddr); 2458 spdk_json_write_named_string(w, "trsvcid", trid->trsvcid); 2459 spdk_json_write_object_end(w); 2460 2461 spdk_json_write_named_string(w, "ana_state", 2462 nvme_ana_state_str(listener->ana_state)); 2463 2464 spdk_json_write_object_end(w); 2465 } 2466 2467 struct rpc_subsystem_query_ctx { 2468 char *nqn; 2469 char *tgt_name; 2470 struct spdk_nvmf_subsystem *subsystem; 2471 struct spdk_jsonrpc_request *request; 2472 struct spdk_json_write_ctx *w; 2473 }; 2474 2475 static const struct spdk_json_object_decoder rpc_subsystem_query_decoders[] = { 2476 {"nqn", offsetof(struct rpc_subsystem_query_ctx, nqn), spdk_json_decode_string}, 2477 {"tgt_name", offsetof(struct rpc_subsystem_query_ctx, tgt_name), spdk_json_decode_string, true}, 2478 }; 2479 2480 static void 2481 free_rpc_subsystem_query_ctx(struct rpc_subsystem_query_ctx *ctx) 2482 { 2483 free(ctx->nqn); 2484 free(ctx->tgt_name); 2485 free(ctx); 2486 } 2487 2488 static void 2489 rpc_nvmf_get_controllers_paused(struct spdk_nvmf_subsystem *subsystem, 2490 void *cb_arg, int status) 2491 { 2492 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2493 struct spdk_json_write_ctx *w; 2494 struct spdk_nvmf_ctrlr *ctrlr; 2495 2496 w = spdk_jsonrpc_begin_result(ctx->request); 2497 2498 spdk_json_write_array_begin(w); 2499 TAILQ_FOREACH(ctrlr, &ctx->subsystem->ctrlrs, link) { 2500 dump_nvmf_ctrlr(w, ctrlr); 2501 } 2502 spdk_json_write_array_end(w); 2503 2504 spdk_jsonrpc_end_result(ctx->request, w); 2505 2506 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2507 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2508 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2509 } 2510 2511 free_rpc_subsystem_query_ctx(ctx); 2512 } 2513 2514 static void 2515 rpc_nvmf_get_qpairs_done(struct spdk_io_channel_iter *i, int status) 2516 { 2517 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2518 2519 spdk_json_write_array_end(ctx->w); 2520 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2521 2522 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2523 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2524 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2525 } 2526 2527 free_rpc_subsystem_query_ctx(ctx); 2528 } 2529 2530 static void 2531 rpc_nvmf_get_qpairs(struct spdk_io_channel_iter *i) 2532 { 2533 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2534 struct spdk_io_channel *ch; 2535 struct spdk_nvmf_poll_group *group; 2536 struct spdk_nvmf_qpair *qpair; 2537 2538 ch = spdk_get_io_channel(ctx->subsystem->tgt); 2539 group = spdk_io_channel_get_ctx(ch); 2540 2541 TAILQ_FOREACH(qpair, &group->qpairs, link) { 2542 if (qpair->ctrlr->subsys == ctx->subsystem) { 2543 dump_nvmf_qpair(ctx->w, qpair); 2544 } 2545 } 2546 2547 spdk_for_each_channel_continue(i, 0); 2548 } 2549 2550 static void 2551 rpc_nvmf_get_qpairs_paused(struct spdk_nvmf_subsystem *subsystem, 2552 void *cb_arg, int status) 2553 { 2554 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2555 2556 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2557 2558 spdk_json_write_array_begin(ctx->w); 2559 2560 spdk_for_each_channel(ctx->subsystem->tgt, 2561 rpc_nvmf_get_qpairs, 2562 ctx, 2563 rpc_nvmf_get_qpairs_done); 2564 } 2565 2566 static void 2567 rpc_nvmf_get_listeners_paused(struct spdk_nvmf_subsystem *subsystem, 2568 void *cb_arg, int status) 2569 { 2570 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2571 struct spdk_json_write_ctx *w; 2572 struct spdk_nvmf_subsystem_listener *listener; 2573 2574 w = spdk_jsonrpc_begin_result(ctx->request); 2575 2576 spdk_json_write_array_begin(w); 2577 2578 for (listener = spdk_nvmf_subsystem_get_first_listener(ctx->subsystem); 2579 listener != NULL; 2580 listener = spdk_nvmf_subsystem_get_next_listener(ctx->subsystem, listener)) { 2581 dump_nvmf_subsystem_listener(w, listener); 2582 } 2583 spdk_json_write_array_end(w); 2584 2585 spdk_jsonrpc_end_result(ctx->request, w); 2586 2587 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2588 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2589 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2590 } 2591 2592 free_rpc_subsystem_query_ctx(ctx); 2593 } 2594 2595 static void 2596 _rpc_nvmf_subsystem_query(struct spdk_jsonrpc_request *request, 2597 const struct spdk_json_val *params, 2598 spdk_nvmf_subsystem_state_change_done cb_fn) 2599 { 2600 struct rpc_subsystem_query_ctx *ctx; 2601 struct spdk_nvmf_subsystem *subsystem; 2602 struct spdk_nvmf_tgt *tgt; 2603 2604 ctx = calloc(1, sizeof(*ctx)); 2605 if (!ctx) { 2606 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2607 "Out of memory"); 2608 return; 2609 } 2610 2611 ctx->request = request; 2612 2613 if (spdk_json_decode_object(params, rpc_subsystem_query_decoders, 2614 SPDK_COUNTOF(rpc_subsystem_query_decoders), 2615 ctx)) { 2616 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2617 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2618 "Invalid parameters"); 2619 free_rpc_subsystem_query_ctx(ctx); 2620 return; 2621 } 2622 2623 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2624 if (!tgt) { 2625 SPDK_ERRLOG("Unable to find a target object.\n"); 2626 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2627 "Unable to find a target"); 2628 free_rpc_subsystem_query_ctx(ctx); 2629 return; 2630 } 2631 2632 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 2633 if (!subsystem) { 2634 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 2635 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2636 "Invalid parameters"); 2637 free_rpc_subsystem_query_ctx(ctx); 2638 return; 2639 } 2640 2641 ctx->subsystem = subsystem; 2642 2643 if (spdk_nvmf_subsystem_pause(subsystem, cb_fn, ctx)) { 2644 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2645 "Internal error"); 2646 free_rpc_subsystem_query_ctx(ctx); 2647 return; 2648 } 2649 } 2650 2651 static void 2652 rpc_nvmf_subsystem_get_controllers(struct spdk_jsonrpc_request *request, 2653 const struct spdk_json_val *params) 2654 { 2655 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_controllers_paused); 2656 } 2657 SPDK_RPC_REGISTER("nvmf_subsystem_get_controllers", rpc_nvmf_subsystem_get_controllers, 2658 SPDK_RPC_RUNTIME); 2659 2660 static void 2661 rpc_nvmf_subsystem_get_qpairs(struct spdk_jsonrpc_request *request, 2662 const struct spdk_json_val *params) 2663 { 2664 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_qpairs_paused); 2665 } 2666 SPDK_RPC_REGISTER("nvmf_subsystem_get_qpairs", rpc_nvmf_subsystem_get_qpairs, SPDK_RPC_RUNTIME); 2667 2668 static void 2669 rpc_nvmf_subsystem_get_listeners(struct spdk_jsonrpc_request *request, 2670 const struct spdk_json_val *params) 2671 { 2672 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_listeners_paused); 2673 } 2674 SPDK_RPC_REGISTER("nvmf_subsystem_get_listeners", rpc_nvmf_subsystem_get_listeners, 2675 SPDK_RPC_RUNTIME); 2676