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 43 #include "spdk_internal/log.h" 44 #include "spdk_internal/assert.h" 45 46 #include "nvmf_internal.h" 47 48 static int 49 json_write_hex_str(struct spdk_json_write_ctx *w, const void *data, size_t size) 50 { 51 static const char hex_char[16] = "0123456789ABCDEF"; 52 const uint8_t *buf = data; 53 char *str, *out; 54 int rc; 55 56 str = malloc(size * 2 + 1); 57 if (str == NULL) { 58 return -1; 59 } 60 61 out = str; 62 while (size--) { 63 unsigned byte = *buf++; 64 65 out[0] = hex_char[(byte >> 4) & 0xF]; 66 out[1] = hex_char[byte & 0xF]; 67 68 out += 2; 69 } 70 *out = '\0'; 71 72 rc = spdk_json_write_string(w, str); 73 free(str); 74 75 return rc; 76 } 77 78 static int 79 hex_nybble_to_num(char c) 80 { 81 if (c >= '0' && c <= '9') { 82 return c - '0'; 83 } 84 85 if (c >= 'a' && c <= 'f') { 86 return c - 'a' + 0xA; 87 } 88 89 if (c >= 'A' && c <= 'F') { 90 return c - 'A' + 0xA; 91 } 92 93 return -1; 94 } 95 96 static int 97 hex_byte_to_num(const char *str) 98 { 99 int hi, lo; 100 101 hi = hex_nybble_to_num(str[0]); 102 if (hi < 0) { 103 return hi; 104 } 105 106 lo = hex_nybble_to_num(str[1]); 107 if (lo < 0) { 108 return lo; 109 } 110 111 return hi * 16 + lo; 112 } 113 114 static int 115 decode_hex_string_be(const char *str, uint8_t *out, size_t size) 116 { 117 size_t i; 118 119 /* Decode a string in "ABCDEF012345" format to its binary representation */ 120 for (i = 0; i < size; i++) { 121 int num = hex_byte_to_num(str); 122 123 if (num < 0) { 124 /* Invalid hex byte or end of string */ 125 return -1; 126 } 127 128 out[i] = (uint8_t)num; 129 str += 2; 130 } 131 132 if (i != size || *str != '\0') { 133 /* Length mismatch */ 134 return -1; 135 } 136 137 return 0; 138 } 139 140 static int 141 decode_ns_nguid(const struct spdk_json_val *val, void *out) 142 { 143 char *str = NULL; 144 int rc; 145 146 rc = spdk_json_decode_string(val, &str); 147 if (rc == 0) { 148 /* 16-byte NGUID */ 149 rc = decode_hex_string_be(str, out, 16); 150 } 151 152 free(str); 153 return rc; 154 } 155 156 static int 157 decode_ns_eui64(const struct spdk_json_val *val, void *out) 158 { 159 char *str = NULL; 160 int rc; 161 162 rc = spdk_json_decode_string(val, &str); 163 if (rc == 0) { 164 /* 8-byte EUI-64 */ 165 rc = decode_hex_string_be(str, out, 8); 166 } 167 168 free(str); 169 return rc; 170 } 171 172 static int 173 decode_ns_uuid(const struct spdk_json_val *val, void *out) 174 { 175 char *str = NULL; 176 int rc; 177 178 rc = spdk_json_decode_string(val, &str); 179 if (rc == 0) { 180 rc = spdk_uuid_parse(out, str); 181 } 182 183 free(str); 184 return rc; 185 } 186 187 struct rpc_get_subsystem { 188 char *tgt_name; 189 }; 190 191 static const struct spdk_json_object_decoder rpc_get_subsystem_decoders[] = { 192 {"tgt_name", offsetof(struct rpc_get_subsystem, tgt_name), spdk_json_decode_string, true}, 193 }; 194 195 static void 196 dump_nvmf_subsystem(struct spdk_json_write_ctx *w, struct spdk_nvmf_subsystem *subsystem) 197 { 198 struct spdk_nvmf_host *host; 199 struct spdk_nvmf_subsystem_listener *listener; 200 201 spdk_json_write_object_begin(w); 202 203 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 204 spdk_json_write_name(w, "subtype"); 205 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 206 spdk_json_write_string(w, "NVMe"); 207 } else { 208 spdk_json_write_string(w, "Discovery"); 209 } 210 211 spdk_json_write_named_array_begin(w, "listen_addresses"); 212 213 for (listener = spdk_nvmf_subsystem_get_first_listener(subsystem); listener != NULL; 214 listener = spdk_nvmf_subsystem_get_next_listener(subsystem, listener)) { 215 const struct spdk_nvme_transport_id *trid; 216 const char *adrfam; 217 218 trid = spdk_nvmf_subsystem_listener_get_trid(listener); 219 220 spdk_json_write_object_begin(w); 221 adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam); 222 if (adrfam == NULL) { 223 adrfam = "unknown"; 224 } 225 /* NOTE: "transport" is kept for compatibility; new code should use "trtype" */ 226 spdk_json_write_named_string(w, "transport", trid->trstring); 227 spdk_json_write_named_string(w, "trtype", trid->trstring); 228 spdk_json_write_named_string(w, "adrfam", adrfam); 229 spdk_json_write_named_string(w, "traddr", trid->traddr); 230 spdk_json_write_named_string(w, "trsvcid", trid->trsvcid); 231 spdk_json_write_object_end(w); 232 } 233 spdk_json_write_array_end(w); 234 235 spdk_json_write_named_bool(w, "allow_any_host", 236 spdk_nvmf_subsystem_get_allow_any_host(subsystem)); 237 238 spdk_json_write_named_array_begin(w, "hosts"); 239 240 for (host = spdk_nvmf_subsystem_get_first_host(subsystem); host != NULL; 241 host = spdk_nvmf_subsystem_get_next_host(subsystem, host)) { 242 spdk_json_write_object_begin(w); 243 spdk_json_write_named_string(w, "nqn", spdk_nvmf_host_get_nqn(host)); 244 spdk_json_write_object_end(w); 245 } 246 spdk_json_write_array_end(w); 247 248 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 249 struct spdk_nvmf_ns *ns; 250 struct spdk_nvmf_ns_opts ns_opts; 251 uint32_t max_namespaces; 252 253 spdk_json_write_named_string(w, "serial_number", spdk_nvmf_subsystem_get_sn(subsystem)); 254 255 spdk_json_write_named_string(w, "model_number", spdk_nvmf_subsystem_get_mn(subsystem)); 256 257 max_namespaces = spdk_nvmf_subsystem_get_max_namespaces(subsystem); 258 if (max_namespaces != 0) { 259 spdk_json_write_named_uint32(w, "max_namespaces", max_namespaces); 260 } 261 262 spdk_json_write_named_array_begin(w, "namespaces"); 263 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 264 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 265 spdk_nvmf_ns_get_opts(ns, &ns_opts, sizeof(ns_opts)); 266 spdk_json_write_object_begin(w); 267 spdk_json_write_named_int32(w, "nsid", spdk_nvmf_ns_get_id(ns)); 268 spdk_json_write_named_string(w, "bdev_name", 269 spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 270 /* NOTE: "name" is kept for compatibility only - new code should use bdev_name. */ 271 spdk_json_write_named_string(w, "name", 272 spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 273 274 if (!spdk_mem_all_zero(ns_opts.nguid, sizeof(ns_opts.nguid))) { 275 spdk_json_write_name(w, "nguid"); 276 json_write_hex_str(w, ns_opts.nguid, sizeof(ns_opts.nguid)); 277 } 278 279 if (!spdk_mem_all_zero(ns_opts.eui64, sizeof(ns_opts.eui64))) { 280 spdk_json_write_name(w, "eui64"); 281 json_write_hex_str(w, ns_opts.eui64, sizeof(ns_opts.eui64)); 282 } 283 284 if (!spdk_mem_all_zero(&ns_opts.uuid, sizeof(ns_opts.uuid))) { 285 char uuid_str[SPDK_UUID_STRING_LEN]; 286 287 spdk_uuid_fmt_lower(uuid_str, sizeof(uuid_str), &ns_opts.uuid); 288 spdk_json_write_named_string(w, "uuid", uuid_str); 289 } 290 291 spdk_json_write_object_end(w); 292 } 293 spdk_json_write_array_end(w); 294 } 295 spdk_json_write_object_end(w); 296 } 297 298 static void 299 rpc_nvmf_get_subsystems(struct spdk_jsonrpc_request *request, 300 const struct spdk_json_val *params) 301 { 302 struct rpc_get_subsystem req = { 0 }; 303 struct spdk_json_write_ctx *w; 304 struct spdk_nvmf_subsystem *subsystem; 305 struct spdk_nvmf_tgt *tgt; 306 307 if (params) { 308 if (spdk_json_decode_object(params, rpc_get_subsystem_decoders, 309 SPDK_COUNTOF(rpc_get_subsystem_decoders), 310 &req)) { 311 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 312 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 313 return; 314 } 315 } 316 317 tgt = spdk_nvmf_get_tgt(req.tgt_name); 318 if (!tgt) { 319 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 320 "Unable to find a target."); 321 free(req.tgt_name); 322 return; 323 } 324 325 w = spdk_jsonrpc_begin_result(request); 326 spdk_json_write_array_begin(w); 327 subsystem = spdk_nvmf_subsystem_get_first(tgt); 328 while (subsystem) { 329 dump_nvmf_subsystem(w, subsystem); 330 subsystem = spdk_nvmf_subsystem_get_next(subsystem); 331 } 332 spdk_json_write_array_end(w); 333 spdk_jsonrpc_end_result(request, w); 334 free(req.tgt_name); 335 } 336 SPDK_RPC_REGISTER("nvmf_get_subsystems", rpc_nvmf_get_subsystems, SPDK_RPC_RUNTIME) 337 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_subsystems, get_nvmf_subsystems) 338 339 struct rpc_subsystem_create { 340 char *nqn; 341 char *serial_number; 342 char *model_number; 343 char *tgt_name; 344 uint32_t max_namespaces; 345 bool allow_any_host; 346 }; 347 348 static const struct spdk_json_object_decoder rpc_subsystem_create_decoders[] = { 349 {"nqn", offsetof(struct rpc_subsystem_create, nqn), spdk_json_decode_string}, 350 {"serial_number", offsetof(struct rpc_subsystem_create, serial_number), spdk_json_decode_string, true}, 351 {"model_number", offsetof(struct rpc_subsystem_create, model_number), spdk_json_decode_string, true}, 352 {"tgt_name", offsetof(struct rpc_subsystem_create, tgt_name), spdk_json_decode_string, true}, 353 {"max_namespaces", offsetof(struct rpc_subsystem_create, max_namespaces), spdk_json_decode_uint32, true}, 354 {"allow_any_host", offsetof(struct rpc_subsystem_create, allow_any_host), spdk_json_decode_bool, true}, 355 }; 356 357 static void 358 rpc_nvmf_subsystem_started(struct spdk_nvmf_subsystem *subsystem, 359 void *cb_arg, int status) 360 { 361 struct spdk_jsonrpc_request *request = cb_arg; 362 363 if (!status) { 364 struct spdk_json_write_ctx *w = spdk_jsonrpc_begin_result(request); 365 spdk_json_write_bool(w, true); 366 spdk_jsonrpc_end_result(request, w); 367 } else { 368 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 369 "Subsystem %s start failed", 370 subsystem->subnqn); 371 spdk_nvmf_subsystem_destroy(subsystem); 372 } 373 } 374 375 static void 376 rpc_nvmf_create_subsystem(struct spdk_jsonrpc_request *request, 377 const struct spdk_json_val *params) 378 { 379 struct rpc_subsystem_create *req; 380 struct spdk_nvmf_subsystem *subsystem = NULL; 381 struct spdk_nvmf_tgt *tgt; 382 int rc = -1; 383 384 req = calloc(1, sizeof(*req)); 385 if (!req) { 386 SPDK_ERRLOG("Memory allocation failed\n"); 387 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 388 "Memory allocation failed"); 389 return; 390 } 391 392 if (spdk_json_decode_object(params, rpc_subsystem_create_decoders, 393 SPDK_COUNTOF(rpc_subsystem_create_decoders), 394 req)) { 395 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 396 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 397 goto cleanup; 398 } 399 400 tgt = spdk_nvmf_get_tgt(req->tgt_name); 401 if (!tgt) { 402 SPDK_ERRLOG("Unable to find target %s\n", req->tgt_name); 403 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 404 "Unable to find target %s", req->tgt_name); 405 goto cleanup; 406 } 407 408 subsystem = spdk_nvmf_subsystem_create(tgt, req->nqn, SPDK_NVMF_SUBTYPE_NVME, 409 req->max_namespaces); 410 if (!subsystem) { 411 SPDK_ERRLOG("Unable to create subsystem %s\n", req->nqn); 412 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 413 "Unable to create subsystem %s", req->nqn); 414 goto cleanup; 415 } 416 417 if (req->serial_number) { 418 if (spdk_nvmf_subsystem_set_sn(subsystem, req->serial_number)) { 419 SPDK_ERRLOG("Subsystem %s: invalid serial number '%s'\n", req->nqn, req->serial_number); 420 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 421 "Invalid SN %s", req->serial_number); 422 goto cleanup; 423 } 424 } 425 426 if (req->model_number) { 427 if (spdk_nvmf_subsystem_set_mn(subsystem, req->model_number)) { 428 SPDK_ERRLOG("Subsystem %s: invalid model number '%s'\n", req->nqn, req->model_number); 429 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 430 "Invalid MN %s", req->model_number); 431 goto cleanup; 432 } 433 } 434 435 spdk_nvmf_subsystem_set_allow_any_host(subsystem, req->allow_any_host); 436 437 rc = spdk_nvmf_subsystem_start(subsystem, 438 rpc_nvmf_subsystem_started, 439 request); 440 441 cleanup: 442 free(req->nqn); 443 free(req->tgt_name); 444 free(req->serial_number); 445 free(req->model_number); 446 free(req); 447 448 if (rc && subsystem) { 449 spdk_nvmf_subsystem_destroy(subsystem); 450 } 451 } 452 SPDK_RPC_REGISTER("nvmf_create_subsystem", rpc_nvmf_create_subsystem, SPDK_RPC_RUNTIME) 453 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_create_subsystem, nvmf_subsystem_create) 454 455 struct rpc_delete_subsystem { 456 char *nqn; 457 char *tgt_name; 458 }; 459 460 static void 461 free_rpc_delete_subsystem(struct rpc_delete_subsystem *r) 462 { 463 free(r->nqn); 464 free(r->tgt_name); 465 } 466 467 static void 468 rpc_nvmf_subsystem_stopped(struct spdk_nvmf_subsystem *subsystem, 469 void *cb_arg, int status) 470 { 471 struct spdk_jsonrpc_request *request = cb_arg; 472 struct spdk_json_write_ctx *w; 473 474 nvmf_subsystem_remove_all_listeners(subsystem, true); 475 spdk_nvmf_subsystem_destroy(subsystem); 476 477 w = spdk_jsonrpc_begin_result(request); 478 spdk_json_write_bool(w, true); 479 spdk_jsonrpc_end_result(request, w); 480 } 481 482 static const struct spdk_json_object_decoder rpc_delete_subsystem_decoders[] = { 483 {"nqn", offsetof(struct rpc_delete_subsystem, nqn), spdk_json_decode_string}, 484 {"tgt_name", offsetof(struct rpc_delete_subsystem, tgt_name), spdk_json_decode_string, true}, 485 }; 486 487 static void 488 rpc_nvmf_delete_subsystem(struct spdk_jsonrpc_request *request, 489 const struct spdk_json_val *params) 490 { 491 struct rpc_delete_subsystem req = { 0 }; 492 struct spdk_nvmf_subsystem *subsystem; 493 struct spdk_nvmf_tgt *tgt; 494 495 if (spdk_json_decode_object(params, rpc_delete_subsystem_decoders, 496 SPDK_COUNTOF(rpc_delete_subsystem_decoders), 497 &req)) { 498 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 499 goto invalid; 500 } 501 502 if (req.nqn == NULL) { 503 SPDK_ERRLOG("missing name param\n"); 504 goto invalid; 505 } 506 507 tgt = spdk_nvmf_get_tgt(req.tgt_name); 508 if (!tgt) { 509 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 510 "Unable to find a target."); 511 goto invalid_custom_response; 512 } 513 514 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, req.nqn); 515 if (!subsystem) { 516 goto invalid; 517 } 518 519 free_rpc_delete_subsystem(&req); 520 521 spdk_nvmf_subsystem_stop(subsystem, 522 rpc_nvmf_subsystem_stopped, 523 request); 524 525 return; 526 527 invalid: 528 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 529 invalid_custom_response: 530 free_rpc_delete_subsystem(&req); 531 } 532 SPDK_RPC_REGISTER("nvmf_delete_subsystem", rpc_nvmf_delete_subsystem, SPDK_RPC_RUNTIME) 533 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_delete_subsystem, delete_nvmf_subsystem) 534 535 struct rpc_listen_address { 536 char *transport; 537 char *adrfam; 538 char *traddr; 539 char *trsvcid; 540 }; 541 542 #define RPC_MAX_LISTEN_ADDRESSES 255 543 #define RPC_MAX_NAMESPACES 255 544 545 struct rpc_listen_addresses { 546 size_t num_listen_address; 547 struct rpc_listen_address addresses[RPC_MAX_LISTEN_ADDRESSES]; 548 }; 549 550 static const struct spdk_json_object_decoder rpc_listen_address_decoders[] = { 551 /* NOTE: "transport" is kept for compatibility; new code should use "trtype" */ 552 {"transport", offsetof(struct rpc_listen_address, transport), spdk_json_decode_string, true}, 553 {"trtype", offsetof(struct rpc_listen_address, transport), spdk_json_decode_string, true}, 554 {"adrfam", offsetof(struct rpc_listen_address, adrfam), spdk_json_decode_string, true}, 555 {"traddr", offsetof(struct rpc_listen_address, traddr), spdk_json_decode_string}, 556 {"trsvcid", offsetof(struct rpc_listen_address, trsvcid), spdk_json_decode_string}, 557 }; 558 559 static int 560 decode_rpc_listen_address(const struct spdk_json_val *val, void *out) 561 { 562 struct rpc_listen_address *req = (struct rpc_listen_address *)out; 563 if (spdk_json_decode_object(val, rpc_listen_address_decoders, 564 SPDK_COUNTOF(rpc_listen_address_decoders), 565 req)) { 566 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 567 return -1; 568 } 569 return 0; 570 } 571 572 static void 573 free_rpc_listen_address(struct rpc_listen_address *r) 574 { 575 free(r->transport); 576 free(r->adrfam); 577 free(r->traddr); 578 free(r->trsvcid); 579 } 580 581 enum nvmf_rpc_listen_op { 582 NVMF_RPC_LISTEN_ADD, 583 NVMF_RPC_LISTEN_REMOVE, 584 }; 585 586 struct nvmf_rpc_listener_ctx { 587 char *nqn; 588 char *tgt_name; 589 struct spdk_nvmf_tgt *tgt; 590 struct spdk_nvmf_subsystem *subsystem; 591 struct rpc_listen_address address; 592 593 struct spdk_jsonrpc_request *request; 594 struct spdk_nvme_transport_id trid; 595 enum nvmf_rpc_listen_op op; 596 bool response_sent; 597 }; 598 599 static const struct spdk_json_object_decoder nvmf_rpc_listener_decoder[] = { 600 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 601 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 602 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 603 }; 604 605 static void 606 nvmf_rpc_listener_ctx_free(struct nvmf_rpc_listener_ctx *ctx) 607 { 608 free(ctx->nqn); 609 free(ctx->tgt_name); 610 free_rpc_listen_address(&ctx->address); 611 free(ctx); 612 } 613 614 static void 615 nvmf_rpc_listen_resumed(struct spdk_nvmf_subsystem *subsystem, 616 void *cb_arg, int status) 617 { 618 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 619 struct spdk_jsonrpc_request *request; 620 struct spdk_json_write_ctx *w; 621 622 request = ctx->request; 623 if (ctx->response_sent) { 624 /* If an error occurred, the response has already been sent. */ 625 nvmf_rpc_listener_ctx_free(ctx); 626 return; 627 } 628 629 nvmf_rpc_listener_ctx_free(ctx); 630 631 w = spdk_jsonrpc_begin_result(request); 632 spdk_json_write_bool(w, true); 633 spdk_jsonrpc_end_result(request, w); 634 } 635 636 static void 637 nvmf_rpc_subsystem_listen(void *cb_arg, int status) 638 { 639 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 640 641 if (status) { 642 /* Destroy the listener that we just created. Ignore the error code because 643 * the RPC is failing already anyway. */ 644 spdk_nvmf_tgt_stop_listen(ctx->tgt, &ctx->trid); 645 646 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 647 "Invalid parameters"); 648 ctx->response_sent = true; 649 } 650 651 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 652 if (!ctx->response_sent) { 653 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 654 } 655 nvmf_rpc_listener_ctx_free(ctx); 656 /* Can't really do anything to recover here - subsystem will remain paused. */ 657 } 658 } 659 660 static void 661 nvmf_rpc_listen_paused(struct spdk_nvmf_subsystem *subsystem, 662 void *cb_arg, int status) 663 { 664 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 665 int rc; 666 667 if (ctx->op == NVMF_RPC_LISTEN_ADD) { 668 if (!nvmf_subsystem_find_listener(subsystem, &ctx->trid)) { 669 rc = spdk_nvmf_tgt_listen(ctx->tgt, &ctx->trid); 670 if (rc == 0) { 671 spdk_nvmf_subsystem_add_listener(ctx->subsystem, &ctx->trid, nvmf_rpc_subsystem_listen, ctx); 672 return; 673 } 674 675 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 676 "Invalid parameters"); 677 ctx->response_sent = true; 678 } 679 } else if (ctx->op == NVMF_RPC_LISTEN_REMOVE) { 680 if (spdk_nvmf_subsystem_remove_listener(subsystem, &ctx->trid)) { 681 SPDK_ERRLOG("Unable to remove listener.\n"); 682 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 683 "Invalid parameters"); 684 ctx->response_sent = true; 685 } 686 spdk_nvmf_tgt_stop_listen(ctx->tgt, &ctx->trid); 687 } else { 688 SPDK_UNREACHABLE(); 689 } 690 691 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_listen_resumed, ctx)) { 692 if (!ctx->response_sent) { 693 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 694 } 695 nvmf_rpc_listener_ctx_free(ctx); 696 /* Can't really do anything to recover here - subsystem will remain paused. */ 697 } 698 } 699 700 static int 701 rpc_listen_address_to_trid(const struct rpc_listen_address *address, 702 struct spdk_nvme_transport_id *trid) 703 { 704 size_t len; 705 706 memset(trid, 0, sizeof(*trid)); 707 708 if (spdk_nvme_transport_id_populate_trstring(trid, address->transport)) { 709 SPDK_ERRLOG("Invalid transport string: %s\n", address->transport); 710 return -EINVAL; 711 } 712 713 if (spdk_nvme_transport_id_parse_trtype(&trid->trtype, address->transport)) { 714 SPDK_ERRLOG("Invalid transport type: %s\n", address->transport); 715 return -EINVAL; 716 } 717 718 if (address->adrfam) { 719 if (spdk_nvme_transport_id_parse_adrfam(&trid->adrfam, address->adrfam)) { 720 SPDK_ERRLOG("Invalid adrfam: %s\n", address->adrfam); 721 return -EINVAL; 722 } 723 } else { 724 trid->adrfam = SPDK_NVMF_ADRFAM_IPV4; 725 } 726 727 len = strlen(address->traddr); 728 if (len > sizeof(trid->traddr) - 1) { 729 SPDK_ERRLOG("Transport address longer than %zu characters: %s\n", 730 sizeof(trid->traddr) - 1, address->traddr); 731 return -EINVAL; 732 } 733 memcpy(trid->traddr, address->traddr, len + 1); 734 735 len = strlen(address->trsvcid); 736 if (len > sizeof(trid->trsvcid) - 1) { 737 SPDK_ERRLOG("Transport service id longer than %zu characters: %s\n", 738 sizeof(trid->trsvcid) - 1, address->trsvcid); 739 return -EINVAL; 740 } 741 memcpy(trid->trsvcid, address->trsvcid, len + 1); 742 743 return 0; 744 } 745 746 static void 747 rpc_nvmf_subsystem_add_listener(struct spdk_jsonrpc_request *request, 748 const struct spdk_json_val *params) 749 { 750 struct nvmf_rpc_listener_ctx *ctx; 751 struct spdk_nvmf_subsystem *subsystem; 752 struct spdk_nvmf_tgt *tgt; 753 754 ctx = calloc(1, sizeof(*ctx)); 755 if (!ctx) { 756 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 757 return; 758 } 759 760 ctx->request = request; 761 762 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 763 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 764 ctx)) { 765 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 766 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 767 nvmf_rpc_listener_ctx_free(ctx); 768 return; 769 } 770 771 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 772 if (!tgt) { 773 SPDK_ERRLOG("Unable to find a target object.\n"); 774 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 775 "Unable to find a target."); 776 nvmf_rpc_listener_ctx_free(ctx); 777 return; 778 } 779 ctx->tgt = tgt; 780 781 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 782 if (!subsystem) { 783 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 784 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 785 nvmf_rpc_listener_ctx_free(ctx); 786 return; 787 } 788 789 ctx->subsystem = subsystem; 790 791 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 792 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 793 "Invalid parameters"); 794 nvmf_rpc_listener_ctx_free(ctx); 795 return; 796 } 797 798 ctx->op = NVMF_RPC_LISTEN_ADD; 799 800 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 801 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 802 nvmf_rpc_listener_ctx_free(ctx); 803 } 804 } 805 SPDK_RPC_REGISTER("nvmf_subsystem_add_listener", rpc_nvmf_subsystem_add_listener, 806 SPDK_RPC_RUNTIME); 807 808 static void 809 rpc_nvmf_subsystem_remove_listener(struct spdk_jsonrpc_request *request, 810 const struct spdk_json_val *params) 811 { 812 struct nvmf_rpc_listener_ctx *ctx; 813 struct spdk_nvmf_subsystem *subsystem; 814 struct spdk_nvmf_tgt *tgt; 815 816 ctx = calloc(1, sizeof(*ctx)); 817 if (!ctx) { 818 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 819 return; 820 } 821 822 ctx->request = request; 823 824 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 825 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 826 ctx)) { 827 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 828 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 829 nvmf_rpc_listener_ctx_free(ctx); 830 return; 831 } 832 833 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 834 if (!tgt) { 835 SPDK_ERRLOG("Unable to find a target object.\n"); 836 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 837 "Unable to find a target."); 838 nvmf_rpc_listener_ctx_free(ctx); 839 return; 840 } 841 ctx->tgt = tgt; 842 843 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 844 if (!subsystem) { 845 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 846 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 847 nvmf_rpc_listener_ctx_free(ctx); 848 return; 849 } 850 851 ctx->subsystem = subsystem; 852 853 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 854 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 855 "Invalid parameters"); 856 nvmf_rpc_listener_ctx_free(ctx); 857 return; 858 } 859 860 ctx->op = NVMF_RPC_LISTEN_REMOVE; 861 862 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 863 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 864 nvmf_rpc_listener_ctx_free(ctx); 865 } 866 } 867 SPDK_RPC_REGISTER("nvmf_subsystem_remove_listener", rpc_nvmf_subsystem_remove_listener, 868 SPDK_RPC_RUNTIME); 869 870 struct spdk_nvmf_ns_params { 871 char *bdev_name; 872 char *ptpl_file; 873 uint32_t nsid; 874 char nguid[16]; 875 char eui64[8]; 876 struct spdk_uuid uuid; 877 }; 878 879 struct rpc_namespaces { 880 size_t num_ns; 881 struct spdk_nvmf_ns_params ns_params[RPC_MAX_NAMESPACES]; 882 }; 883 884 885 static const struct spdk_json_object_decoder rpc_ns_params_decoders[] = { 886 {"nsid", offsetof(struct spdk_nvmf_ns_params, nsid), spdk_json_decode_uint32, true}, 887 {"bdev_name", offsetof(struct spdk_nvmf_ns_params, bdev_name), spdk_json_decode_string}, 888 {"ptpl_file", offsetof(struct spdk_nvmf_ns_params, ptpl_file), spdk_json_decode_string, true}, 889 {"nguid", offsetof(struct spdk_nvmf_ns_params, nguid), decode_ns_nguid, true}, 890 {"eui64", offsetof(struct spdk_nvmf_ns_params, eui64), decode_ns_eui64, true}, 891 {"uuid", offsetof(struct spdk_nvmf_ns_params, uuid), decode_ns_uuid, true}, 892 }; 893 894 static int 895 decode_rpc_ns_params(const struct spdk_json_val *val, void *out) 896 { 897 struct spdk_nvmf_ns_params *ns_params = out; 898 899 return spdk_json_decode_object(val, rpc_ns_params_decoders, 900 SPDK_COUNTOF(rpc_ns_params_decoders), 901 ns_params); 902 } 903 904 struct nvmf_rpc_ns_ctx { 905 char *nqn; 906 char *tgt_name; 907 struct spdk_nvmf_ns_params ns_params; 908 909 struct spdk_jsonrpc_request *request; 910 bool response_sent; 911 }; 912 913 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ns_decoder[] = { 914 {"nqn", offsetof(struct nvmf_rpc_ns_ctx, nqn), spdk_json_decode_string}, 915 {"namespace", offsetof(struct nvmf_rpc_ns_ctx, ns_params), decode_rpc_ns_params}, 916 {"tgt_name", offsetof(struct nvmf_rpc_ns_ctx, tgt_name), spdk_json_decode_string, true}, 917 }; 918 919 static void 920 nvmf_rpc_ns_ctx_free(struct nvmf_rpc_ns_ctx *ctx) 921 { 922 free(ctx->nqn); 923 free(ctx->tgt_name); 924 free(ctx->ns_params.bdev_name); 925 free(ctx->ns_params.ptpl_file); 926 free(ctx); 927 } 928 929 static void 930 nvmf_rpc_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 931 void *cb_arg, int status) 932 { 933 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 934 struct spdk_jsonrpc_request *request = ctx->request; 935 uint32_t nsid = ctx->ns_params.nsid; 936 bool response_sent = ctx->response_sent; 937 struct spdk_json_write_ctx *w; 938 939 nvmf_rpc_ns_ctx_free(ctx); 940 941 if (response_sent) { 942 return; 943 } 944 945 w = spdk_jsonrpc_begin_result(request); 946 spdk_json_write_uint32(w, nsid); 947 spdk_jsonrpc_end_result(request, w); 948 } 949 950 static void 951 nvmf_rpc_ns_paused(struct spdk_nvmf_subsystem *subsystem, 952 void *cb_arg, int status) 953 { 954 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 955 struct spdk_nvmf_ns_opts ns_opts; 956 struct spdk_bdev *bdev; 957 958 bdev = spdk_bdev_get_by_name(ctx->ns_params.bdev_name); 959 if (!bdev) { 960 SPDK_ERRLOG("No bdev with name %s\n", ctx->ns_params.bdev_name); 961 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 962 "Invalid parameters"); 963 ctx->response_sent = true; 964 goto resume; 965 } 966 967 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 968 ns_opts.nsid = ctx->ns_params.nsid; 969 970 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 971 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 972 973 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 974 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 975 976 if (!spdk_mem_all_zero(&ctx->ns_params.uuid, sizeof(ctx->ns_params.uuid))) { 977 ns_opts.uuid = ctx->ns_params.uuid; 978 } 979 980 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns(subsystem, bdev, &ns_opts, sizeof(ns_opts), 981 ctx->ns_params.ptpl_file); 982 if (ctx->ns_params.nsid == 0) { 983 SPDK_ERRLOG("Unable to add namespace\n"); 984 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 985 "Invalid parameters"); 986 ctx->response_sent = true; 987 goto resume; 988 } 989 990 resume: 991 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 992 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 993 nvmf_rpc_ns_ctx_free(ctx); 994 } 995 } 996 997 static void 998 rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 999 const struct spdk_json_val *params) 1000 { 1001 struct nvmf_rpc_ns_ctx *ctx; 1002 struct spdk_nvmf_subsystem *subsystem; 1003 struct spdk_nvmf_tgt *tgt; 1004 1005 ctx = calloc(1, sizeof(*ctx)); 1006 if (!ctx) { 1007 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1008 return; 1009 } 1010 1011 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ns_decoder, 1012 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), 1013 ctx)) { 1014 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1015 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1016 nvmf_rpc_ns_ctx_free(ctx); 1017 return; 1018 } 1019 1020 ctx->request = request; 1021 ctx->response_sent = false; 1022 1023 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1024 if (!tgt) { 1025 SPDK_ERRLOG("Unable to find a target object.\n"); 1026 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1027 "Unable to find a target."); 1028 nvmf_rpc_ns_ctx_free(ctx); 1029 return; 1030 } 1031 1032 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1033 if (!subsystem) { 1034 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1035 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1036 nvmf_rpc_ns_ctx_free(ctx); 1037 return; 1038 } 1039 1040 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_ns_paused, ctx)) { 1041 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1042 nvmf_rpc_ns_ctx_free(ctx); 1043 } 1044 } 1045 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1046 1047 struct nvmf_rpc_remove_ns_ctx { 1048 char *nqn; 1049 char *tgt_name; 1050 uint32_t nsid; 1051 1052 struct spdk_jsonrpc_request *request; 1053 bool response_sent; 1054 }; 1055 1056 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1057 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1058 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1059 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1060 }; 1061 1062 static void 1063 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1064 { 1065 free(ctx->nqn); 1066 free(ctx->tgt_name); 1067 free(ctx); 1068 } 1069 1070 static void 1071 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1072 void *cb_arg, int status) 1073 { 1074 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1075 struct spdk_jsonrpc_request *request = ctx->request; 1076 bool response_sent = ctx->response_sent; 1077 struct spdk_json_write_ctx *w; 1078 1079 nvmf_rpc_remove_ns_ctx_free(ctx); 1080 1081 if (response_sent) { 1082 return; 1083 } 1084 1085 w = spdk_jsonrpc_begin_result(request); 1086 spdk_json_write_bool(w, true); 1087 spdk_jsonrpc_end_result(request, w); 1088 } 1089 1090 static void 1091 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1092 void *cb_arg, int status) 1093 { 1094 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1095 int ret; 1096 1097 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1098 if (ret < 0) { 1099 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1100 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1101 "Invalid parameters"); 1102 ctx->response_sent = true; 1103 } 1104 1105 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1106 if (!ctx->response_sent) { 1107 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1108 } 1109 nvmf_rpc_remove_ns_ctx_free(ctx); 1110 } 1111 } 1112 1113 static void 1114 rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1115 const struct spdk_json_val *params) 1116 { 1117 struct nvmf_rpc_remove_ns_ctx *ctx; 1118 struct spdk_nvmf_subsystem *subsystem; 1119 struct spdk_nvmf_tgt *tgt; 1120 1121 ctx = calloc(1, sizeof(*ctx)); 1122 if (!ctx) { 1123 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1124 return; 1125 } 1126 1127 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1128 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1129 ctx)) { 1130 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1131 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1132 nvmf_rpc_remove_ns_ctx_free(ctx); 1133 return; 1134 } 1135 1136 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1137 if (!tgt) { 1138 SPDK_ERRLOG("Unable to find a target object.\n"); 1139 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1140 "Unable to find a target."); 1141 nvmf_rpc_remove_ns_ctx_free(ctx); 1142 return; 1143 } 1144 1145 ctx->request = request; 1146 ctx->response_sent = false; 1147 1148 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1149 if (!subsystem) { 1150 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1151 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1152 nvmf_rpc_remove_ns_ctx_free(ctx); 1153 return; 1154 } 1155 1156 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_remove_ns_paused, ctx)) { 1157 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1158 nvmf_rpc_remove_ns_ctx_free(ctx); 1159 } 1160 } 1161 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1162 1163 enum nvmf_rpc_host_op { 1164 NVMF_RPC_HOST_ADD, 1165 NVMF_RPC_HOST_REMOVE, 1166 NVMF_RPC_HOST_ALLOW_ANY, 1167 }; 1168 1169 struct nvmf_rpc_host_ctx { 1170 struct spdk_jsonrpc_request *request; 1171 1172 char *nqn; 1173 char *host; 1174 char *tgt_name; 1175 1176 enum nvmf_rpc_host_op op; 1177 1178 bool allow_any_host; 1179 1180 bool response_sent; 1181 }; 1182 1183 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1184 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1185 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1186 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1187 }; 1188 1189 static void 1190 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1191 { 1192 free(ctx->nqn); 1193 free(ctx->host); 1194 free(ctx->tgt_name); 1195 free(ctx); 1196 } 1197 1198 static void 1199 nvmf_rpc_host_resumed(struct spdk_nvmf_subsystem *subsystem, 1200 void *cb_arg, int status) 1201 { 1202 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1203 struct spdk_jsonrpc_request *request; 1204 struct spdk_json_write_ctx *w; 1205 bool response_sent = ctx->response_sent; 1206 1207 request = ctx->request; 1208 nvmf_rpc_host_ctx_free(ctx); 1209 1210 if (response_sent) { 1211 return; 1212 } 1213 1214 w = spdk_jsonrpc_begin_result(request); 1215 spdk_json_write_bool(w, true); 1216 spdk_jsonrpc_end_result(request, w); 1217 } 1218 1219 static void 1220 nvmf_rpc_host_paused(struct spdk_nvmf_subsystem *subsystem, 1221 void *cb_arg, int status) 1222 { 1223 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1224 int rc = -1; 1225 1226 switch (ctx->op) { 1227 case NVMF_RPC_HOST_ADD: 1228 rc = spdk_nvmf_subsystem_add_host(subsystem, ctx->host); 1229 break; 1230 case NVMF_RPC_HOST_REMOVE: 1231 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 1232 break; 1233 case NVMF_RPC_HOST_ALLOW_ANY: 1234 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx->allow_any_host); 1235 break; 1236 } 1237 1238 if (rc != 0) { 1239 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1240 ctx->response_sent = true; 1241 } 1242 1243 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_host_resumed, ctx)) { 1244 if (!ctx->response_sent) { 1245 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1246 } 1247 nvmf_rpc_host_ctx_free(ctx); 1248 } 1249 } 1250 1251 static void 1252 rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1253 const struct spdk_json_val *params) 1254 { 1255 struct nvmf_rpc_host_ctx *ctx; 1256 struct spdk_nvmf_subsystem *subsystem; 1257 struct spdk_nvmf_tgt *tgt; 1258 1259 ctx = calloc(1, sizeof(*ctx)); 1260 if (!ctx) { 1261 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1262 return; 1263 } 1264 1265 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1266 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1267 ctx)) { 1268 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1269 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1270 nvmf_rpc_host_ctx_free(ctx); 1271 return; 1272 } 1273 1274 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1275 if (!tgt) { 1276 SPDK_ERRLOG("Unable to find a target object.\n"); 1277 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1278 "Unable to find a target."); 1279 nvmf_rpc_host_ctx_free(ctx); 1280 return; 1281 } 1282 1283 ctx->request = request; 1284 ctx->op = NVMF_RPC_HOST_ADD; 1285 ctx->response_sent = false; 1286 1287 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1288 if (!subsystem) { 1289 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1290 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1291 nvmf_rpc_host_ctx_free(ctx); 1292 return; 1293 } 1294 1295 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1296 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1297 nvmf_rpc_host_ctx_free(ctx); 1298 } 1299 } 1300 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 1301 1302 static void 1303 rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 1304 const struct spdk_json_val *params) 1305 { 1306 struct nvmf_rpc_host_ctx *ctx; 1307 struct spdk_nvmf_subsystem *subsystem; 1308 struct spdk_nvmf_tgt *tgt; 1309 1310 ctx = calloc(1, sizeof(*ctx)); 1311 if (!ctx) { 1312 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1313 return; 1314 } 1315 1316 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1317 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1318 ctx)) { 1319 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1320 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1321 nvmf_rpc_host_ctx_free(ctx); 1322 return; 1323 } 1324 1325 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1326 if (!tgt) { 1327 SPDK_ERRLOG("Unable to find a target object.\n"); 1328 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1329 "Unable to find a target."); 1330 nvmf_rpc_host_ctx_free(ctx); 1331 return; 1332 } 1333 1334 ctx->request = request; 1335 ctx->op = NVMF_RPC_HOST_REMOVE; 1336 ctx->response_sent = false; 1337 1338 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1339 if (!subsystem) { 1340 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1341 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1342 nvmf_rpc_host_ctx_free(ctx); 1343 return; 1344 } 1345 1346 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1347 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1348 nvmf_rpc_host_ctx_free(ctx); 1349 } 1350 } 1351 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", rpc_nvmf_subsystem_remove_host, 1352 SPDK_RPC_RUNTIME) 1353 1354 1355 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 1356 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1357 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 1358 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1359 }; 1360 1361 static void 1362 rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 1363 const struct spdk_json_val *params) 1364 { 1365 struct nvmf_rpc_host_ctx *ctx; 1366 struct spdk_nvmf_subsystem *subsystem; 1367 struct spdk_nvmf_tgt *tgt; 1368 1369 ctx = calloc(1, sizeof(*ctx)); 1370 if (!ctx) { 1371 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1372 return; 1373 } 1374 1375 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 1376 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 1377 ctx)) { 1378 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1379 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1380 nvmf_rpc_host_ctx_free(ctx); 1381 return; 1382 } 1383 1384 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1385 if (!tgt) { 1386 SPDK_ERRLOG("Unable to find a target object.\n"); 1387 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1388 "Unable to find a target."); 1389 nvmf_rpc_host_ctx_free(ctx); 1390 return; 1391 } 1392 1393 ctx->request = request; 1394 ctx->op = NVMF_RPC_HOST_ALLOW_ANY; 1395 ctx->response_sent = false; 1396 1397 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1398 if (!subsystem) { 1399 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1400 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1401 nvmf_rpc_host_ctx_free(ctx); 1402 return; 1403 } 1404 1405 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1406 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1407 nvmf_rpc_host_ctx_free(ctx); 1408 } 1409 } 1410 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", rpc_nvmf_subsystem_allow_any_host, 1411 SPDK_RPC_RUNTIME) 1412 1413 struct nvmf_rpc_target_ctx { 1414 char *name; 1415 uint32_t max_subsystems; 1416 }; 1417 1418 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 1419 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1420 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 1421 }; 1422 1423 static void 1424 rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 1425 const struct spdk_json_val *params) 1426 { 1427 struct spdk_nvmf_target_opts opts; 1428 struct nvmf_rpc_target_ctx ctx = {0}; 1429 struct spdk_nvmf_tgt *tgt; 1430 struct spdk_json_write_ctx *w; 1431 1432 /* Decode parameters the first time to get the transport type */ 1433 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 1434 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 1435 &ctx)) { 1436 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1437 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1438 free(ctx.name); 1439 return; 1440 } 1441 1442 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 1443 opts.max_subsystems = ctx.max_subsystems; 1444 1445 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 1446 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1447 "Target already exists."); 1448 free(ctx.name); 1449 return; 1450 } 1451 1452 tgt = spdk_nvmf_tgt_create(&opts); 1453 1454 if (tgt == NULL) { 1455 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1456 "Unable to create the requested target."); 1457 free(ctx.name); 1458 return; 1459 } 1460 1461 w = spdk_jsonrpc_begin_result(request); 1462 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 1463 spdk_jsonrpc_end_result(request, w); 1464 free(ctx.name); 1465 } 1466 SPDK_RPC_REGISTER("nvmf_create_target", rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 1467 1468 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 1469 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1470 }; 1471 1472 static void 1473 nvmf_rpc_destroy_target_done(void *ctx, int status) 1474 { 1475 struct spdk_jsonrpc_request *request = ctx; 1476 struct spdk_json_write_ctx *w; 1477 1478 w = spdk_jsonrpc_begin_result(request); 1479 spdk_json_write_bool(w, true); 1480 spdk_jsonrpc_end_result(request, w); 1481 } 1482 1483 static void 1484 rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 1485 const struct spdk_json_val *params) 1486 { 1487 struct nvmf_rpc_target_ctx ctx = {0}; 1488 struct spdk_nvmf_tgt *tgt; 1489 1490 /* Decode parameters the first time to get the transport type */ 1491 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 1492 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 1493 &ctx)) { 1494 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1495 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1496 free(ctx.name); 1497 return; 1498 } 1499 1500 tgt = spdk_nvmf_get_tgt(ctx.name); 1501 1502 if (tgt == NULL) { 1503 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1504 "The specified target doesn't exist, cannot delete it."); 1505 free(ctx.name); 1506 return; 1507 } 1508 1509 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 1510 free(ctx.name); 1511 } 1512 SPDK_RPC_REGISTER("nvmf_delete_target", rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 1513 1514 static void 1515 rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 1516 const struct spdk_json_val *params) 1517 { 1518 struct spdk_json_write_ctx *w; 1519 struct spdk_nvmf_tgt *tgt; 1520 const char *name; 1521 1522 if (params != NULL) { 1523 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1524 "nvmf_get_targets has no parameters."); 1525 return; 1526 } 1527 1528 w = spdk_jsonrpc_begin_result(request); 1529 spdk_json_write_array_begin(w); 1530 1531 tgt = spdk_nvmf_get_first_tgt(); 1532 1533 while (tgt != NULL) { 1534 name = spdk_nvmf_tgt_get_name(tgt); 1535 spdk_json_write_string(w, name); 1536 tgt = spdk_nvmf_get_next_tgt(tgt); 1537 } 1538 1539 spdk_json_write_array_end(w); 1540 spdk_jsonrpc_end_result(request, w); 1541 } 1542 SPDK_RPC_REGISTER("nvmf_get_targets", rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 1543 1544 struct nvmf_rpc_create_transport_ctx { 1545 char *trtype; 1546 char *tgt_name; 1547 struct spdk_nvmf_transport_opts opts; 1548 struct spdk_jsonrpc_request *request; 1549 }; 1550 1551 /** 1552 * `max_qpairs_per_ctrlr` represents both admin and IO qpairs, that confuses 1553 * users when they configure a transport using RPC. So it was decided to 1554 * deprecate `max_qpairs_per_ctrlr` RPC parameter and use `max_io_qpairs_per_ctrlr` 1555 * But internal logic remains unchanged and SPDK expects that 1556 * spdk_nvmf_transport_opts::max_qpairs_per_ctrlr includes an admin qpair. 1557 * This function parses the number of IO qpairs and adds +1 for admin qpair. 1558 */ 1559 static int 1560 nvmf_rpc_decode_max_io_qpairs(const struct spdk_json_val *val, void *out) 1561 { 1562 uint16_t *i = out; 1563 int rc; 1564 1565 rc = spdk_json_number_to_uint16(val, i); 1566 if (rc == 0) { 1567 (*i)++; 1568 } 1569 1570 return rc; 1571 } 1572 1573 /** 1574 * This function parses deprecated `max_qpairs_per_ctrlr` and warns the user to use 1575 * the new parameter `max_io_qpairs_per_ctrlr` 1576 */ 1577 static int 1578 nvmf_rpc_decode_max_qpairs(const struct spdk_json_val *val, void *out) 1579 { 1580 uint16_t *i = out; 1581 int rc; 1582 1583 rc = spdk_json_number_to_uint16(val, i); 1584 if (rc == 0) { 1585 SPDK_WARNLOG("Parameter max_qpairs_per_ctrlr is deprecated, use max_io_qpairs_per_ctrlr instead.\n"); 1586 } 1587 1588 return rc; 1589 } 1590 1591 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 1592 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 1593 { 1594 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 1595 spdk_json_decode_uint16, true 1596 }, 1597 { 1598 "max_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1599 nvmf_rpc_decode_max_qpairs, true 1600 }, 1601 { 1602 "max_io_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1603 nvmf_rpc_decode_max_io_qpairs, true 1604 }, 1605 { 1606 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 1607 spdk_json_decode_uint32, true 1608 }, 1609 { 1610 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 1611 spdk_json_decode_uint32, true 1612 }, 1613 { 1614 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 1615 spdk_json_decode_uint32, true 1616 }, 1617 { 1618 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 1619 spdk_json_decode_uint32, true 1620 }, 1621 { 1622 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 1623 spdk_json_decode_uint32, true 1624 }, 1625 { 1626 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 1627 spdk_json_decode_uint32, true 1628 }, 1629 { 1630 "max_srq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_srq_depth), 1631 spdk_json_decode_uint32, true 1632 }, 1633 { 1634 "no_srq", offsetof(struct nvmf_rpc_create_transport_ctx, opts.no_srq), 1635 spdk_json_decode_bool, true 1636 }, 1637 { 1638 "c2h_success", offsetof(struct nvmf_rpc_create_transport_ctx, opts.c2h_success), 1639 spdk_json_decode_bool, true 1640 }, 1641 { 1642 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 1643 spdk_json_decode_bool, true 1644 }, 1645 { 1646 "sock_priority", offsetof(struct nvmf_rpc_create_transport_ctx, opts.sock_priority), 1647 spdk_json_decode_uint32, true 1648 }, 1649 { 1650 "acceptor_backlog", offsetof(struct nvmf_rpc_create_transport_ctx, opts.acceptor_backlog), 1651 spdk_json_decode_int32, true 1652 }, 1653 { 1654 "abort_timeout_sec", offsetof(struct nvmf_rpc_create_transport_ctx, opts.abort_timeout_sec), 1655 spdk_json_decode_uint32, true 1656 }, 1657 { 1658 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 1659 spdk_json_decode_string, true 1660 }, 1661 }; 1662 1663 static void 1664 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 1665 { 1666 free(ctx->trtype); 1667 free(ctx->tgt_name); 1668 free(ctx); 1669 } 1670 1671 static void 1672 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 1673 { 1674 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 1675 struct spdk_jsonrpc_request *request; 1676 struct spdk_json_write_ctx *w; 1677 1678 request = ctx->request; 1679 nvmf_rpc_create_transport_ctx_free(ctx); 1680 1681 if (status) { 1682 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 1683 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1684 "Failed to add transport to tgt.(%d)\n", 1685 status); 1686 return; 1687 } 1688 1689 w = spdk_jsonrpc_begin_result(request); 1690 spdk_json_write_bool(w, true); 1691 spdk_jsonrpc_end_result(request, w); 1692 } 1693 1694 static void 1695 rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 1696 const struct spdk_json_val *params) 1697 { 1698 struct nvmf_rpc_create_transport_ctx *ctx; 1699 enum spdk_nvme_transport_type trtype; 1700 struct spdk_nvmf_transport *transport; 1701 struct spdk_nvmf_tgt *tgt; 1702 1703 ctx = calloc(1, sizeof(*ctx)); 1704 if (!ctx) { 1705 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1706 return; 1707 } 1708 1709 /* Decode parameters the first time to get the transport type */ 1710 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 1711 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1712 ctx)) { 1713 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1714 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1715 nvmf_rpc_create_transport_ctx_free(ctx); 1716 return; 1717 } 1718 1719 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1720 if (!tgt) { 1721 SPDK_ERRLOG("Unable to find a target object.\n"); 1722 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1723 "Unable to find a target."); 1724 nvmf_rpc_create_transport_ctx_free(ctx); 1725 return; 1726 } 1727 1728 if (spdk_nvme_transport_id_parse_trtype(&trtype, ctx->trtype)) { 1729 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1730 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1731 "Invalid transport type '%s'\n", ctx->trtype); 1732 nvmf_rpc_create_transport_ctx_free(ctx); 1733 return; 1734 } 1735 1736 /* Initialize all the transport options (based on transport type) and decode the 1737 * parameters again to update any options passed in rpc create transport call. 1738 */ 1739 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts)) { 1740 /* This can happen if user specifies PCIE transport type which isn't valid for 1741 * NVMe-oF. 1742 */ 1743 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1744 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1745 "Invalid transport type '%s'\n", ctx->trtype); 1746 nvmf_rpc_create_transport_ctx_free(ctx); 1747 return; 1748 } 1749 1750 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 1751 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1752 ctx)) { 1753 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1754 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1755 nvmf_rpc_create_transport_ctx_free(ctx); 1756 return; 1757 } 1758 1759 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 1760 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 1761 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1762 "Transport type '%s' already exists\n", ctx->trtype); 1763 nvmf_rpc_create_transport_ctx_free(ctx); 1764 return; 1765 } 1766 1767 transport = spdk_nvmf_transport_create(ctx->trtype, &ctx->opts); 1768 1769 if (!transport) { 1770 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 1771 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1772 "Transport type '%s' create failed\n", ctx->trtype); 1773 nvmf_rpc_create_transport_ctx_free(ctx); 1774 return; 1775 } 1776 1777 /* add transport to target */ 1778 ctx->request = request; 1779 spdk_nvmf_tgt_add_transport(tgt, transport, nvmf_rpc_tgt_add_transport_done, ctx); 1780 } 1781 SPDK_RPC_REGISTER("nvmf_create_transport", rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 1782 1783 static void 1784 dump_nvmf_transport(struct spdk_json_write_ctx *w, struct spdk_nvmf_transport *transport) 1785 { 1786 const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport); 1787 spdk_nvme_transport_type_t type = spdk_nvmf_get_transport_type(transport); 1788 1789 spdk_json_write_object_begin(w); 1790 1791 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport)); 1792 spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth); 1793 spdk_json_write_named_uint32(w, "max_io_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr - 1); 1794 spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size); 1795 spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size); 1796 spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size); 1797 spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth); 1798 spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers); 1799 spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size); 1800 spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip); 1801 if (type == SPDK_NVME_TRANSPORT_RDMA) { 1802 spdk_json_write_named_uint32(w, "max_srq_depth", opts->max_srq_depth); 1803 spdk_json_write_named_bool(w, "no_srq", opts->no_srq); 1804 spdk_json_write_named_int32(w, "acceptor_backlog", opts->acceptor_backlog); 1805 } else if (type == SPDK_NVME_TRANSPORT_TCP) { 1806 spdk_json_write_named_bool(w, "c2h_success", opts->c2h_success); 1807 spdk_json_write_named_uint32(w, "sock_priority", opts->sock_priority); 1808 } 1809 spdk_json_write_named_uint32(w, "abort_timeout_sec", opts->abort_timeout_sec); 1810 1811 spdk_json_write_object_end(w); 1812 } 1813 1814 struct rpc_get_transport { 1815 char *tgt_name; 1816 }; 1817 1818 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 1819 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 1820 }; 1821 1822 static void 1823 rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 1824 const struct spdk_json_val *params) 1825 { 1826 struct rpc_get_transport req = { 0 }; 1827 struct spdk_json_write_ctx *w; 1828 struct spdk_nvmf_transport *transport; 1829 struct spdk_nvmf_tgt *tgt; 1830 1831 if (params) { 1832 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 1833 SPDK_COUNTOF(rpc_get_transport_decoders), 1834 &req)) { 1835 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1836 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1837 return; 1838 } 1839 } 1840 1841 tgt = spdk_nvmf_get_tgt(req.tgt_name); 1842 if (!tgt) { 1843 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1844 "Unable to find a target."); 1845 free(req.tgt_name); 1846 return; 1847 } 1848 1849 w = spdk_jsonrpc_begin_result(request); 1850 spdk_json_write_array_begin(w); 1851 transport = spdk_nvmf_transport_get_first(tgt); 1852 while (transport) { 1853 dump_nvmf_transport(w, transport); 1854 transport = spdk_nvmf_transport_get_next(transport); 1855 } 1856 spdk_json_write_array_end(w); 1857 spdk_jsonrpc_end_result(request, w); 1858 free(req.tgt_name); 1859 } 1860 SPDK_RPC_REGISTER("nvmf_get_transports", rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 1861 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_transports, get_nvmf_transports) 1862 1863 struct rpc_nvmf_get_stats_ctx { 1864 char *tgt_name; 1865 struct spdk_nvmf_tgt *tgt; 1866 struct spdk_jsonrpc_request *request; 1867 struct spdk_json_write_ctx *w; 1868 }; 1869 1870 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 1871 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 1872 }; 1873 1874 static void 1875 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 1876 { 1877 free(ctx->tgt_name); 1878 free(ctx); 1879 } 1880 1881 static void 1882 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 1883 { 1884 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1885 1886 spdk_json_write_array_end(ctx->w); 1887 spdk_json_write_object_end(ctx->w); 1888 spdk_jsonrpc_end_result(ctx->request, ctx->w); 1889 free_get_stats_ctx(ctx); 1890 } 1891 1892 static void 1893 write_nvmf_transport_stats(struct spdk_json_write_ctx *w, 1894 struct spdk_nvmf_transport_poll_group_stat *stat) 1895 { 1896 uint64_t i; 1897 1898 spdk_json_write_object_begin(w); 1899 spdk_json_write_named_string(w, "trtype", 1900 spdk_nvme_transport_id_trtype_str(stat->trtype)); 1901 switch (stat->trtype) { 1902 case SPDK_NVME_TRANSPORT_RDMA: 1903 spdk_json_write_named_uint64(w, "pending_data_buffer", stat->rdma.pending_data_buffer); 1904 spdk_json_write_named_array_begin(w, "devices"); 1905 for (i = 0; i < stat->rdma.num_devices; ++i) { 1906 spdk_json_write_object_begin(w); 1907 spdk_json_write_named_string(w, "name", stat->rdma.devices[i].name); 1908 spdk_json_write_named_uint64(w, "polls", stat->rdma.devices[i].polls); 1909 spdk_json_write_named_uint64(w, "completions", stat->rdma.devices[i].completions); 1910 spdk_json_write_named_uint64(w, "requests", 1911 stat->rdma.devices[i].requests); 1912 spdk_json_write_named_uint64(w, "request_latency", 1913 stat->rdma.devices[i].request_latency); 1914 spdk_json_write_named_uint64(w, "pending_free_request", 1915 stat->rdma.devices[i].pending_free_request); 1916 spdk_json_write_named_uint64(w, "pending_rdma_read", 1917 stat->rdma.devices[i].pending_rdma_read); 1918 spdk_json_write_named_uint64(w, "pending_rdma_write", 1919 stat->rdma.devices[i].pending_rdma_write); 1920 spdk_json_write_object_end(w); 1921 } 1922 spdk_json_write_array_end(w); 1923 break; 1924 default: 1925 break; 1926 } 1927 spdk_json_write_object_end(w); 1928 } 1929 1930 static void 1931 _rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 1932 { 1933 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1934 struct spdk_nvmf_transport *transport; 1935 struct spdk_nvmf_poll_group_stat stat; 1936 struct spdk_nvmf_transport_poll_group_stat *trstat; 1937 int rc; 1938 1939 if (0 == spdk_nvmf_poll_group_get_stat(ctx->tgt, &stat)) { 1940 spdk_json_write_object_begin(ctx->w); 1941 spdk_json_write_named_string(ctx->w, "name", spdk_thread_get_name(spdk_get_thread())); 1942 spdk_json_write_named_uint32(ctx->w, "admin_qpairs", stat.admin_qpairs); 1943 spdk_json_write_named_uint32(ctx->w, "io_qpairs", stat.io_qpairs); 1944 spdk_json_write_named_uint64(ctx->w, "pending_bdev_io", stat.pending_bdev_io); 1945 1946 spdk_json_write_named_array_begin(ctx->w, "transports"); 1947 transport = spdk_nvmf_transport_get_first(ctx->tgt); 1948 while (transport) { 1949 rc = spdk_nvmf_transport_poll_group_get_stat(ctx->tgt, transport, &trstat); 1950 if (0 == rc) { 1951 write_nvmf_transport_stats(ctx->w, trstat); 1952 spdk_nvmf_transport_poll_group_free_stat(transport, trstat); 1953 } else if (-ENOTSUP != rc) { 1954 SPDK_ERRLOG("Failed to get poll group statistics for transport %s, errno %d\n", 1955 spdk_nvme_transport_id_trtype_str(spdk_nvmf_get_transport_type(transport)), 1956 rc); 1957 } 1958 transport = spdk_nvmf_transport_get_next(transport); 1959 } 1960 spdk_json_write_array_end(ctx->w); 1961 spdk_json_write_object_end(ctx->w); 1962 } 1963 1964 spdk_for_each_channel_continue(i, 0); 1965 } 1966 1967 1968 static void 1969 rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 1970 const struct spdk_json_val *params) 1971 { 1972 struct rpc_nvmf_get_stats_ctx *ctx; 1973 1974 ctx = calloc(1, sizeof(*ctx)); 1975 if (!ctx) { 1976 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1977 "Memory allocation error"); 1978 return; 1979 } 1980 ctx->request = request; 1981 1982 if (params) { 1983 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 1984 SPDK_COUNTOF(rpc_get_stats_decoders), 1985 ctx)) { 1986 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1987 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1988 free_get_stats_ctx(ctx); 1989 return; 1990 } 1991 } 1992 1993 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1994 if (!ctx->tgt) { 1995 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1996 "Unable to find a target."); 1997 free_get_stats_ctx(ctx); 1998 return; 1999 } 2000 2001 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2002 spdk_json_write_object_begin(ctx->w); 2003 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 2004 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 2005 2006 spdk_for_each_channel(ctx->tgt, 2007 _rpc_nvmf_get_stats, 2008 ctx, 2009 rpc_nvmf_get_stats_done); 2010 } 2011 2012 SPDK_RPC_REGISTER("nvmf_get_stats", rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 2013