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/event.h" 44 #include "spdk_internal/log.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 spdk_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", spdk_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 spdk_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 spdk_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 spdk_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", spdk_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 spdk_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 spdk_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 spdk_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 spdk_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", spdk_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 (!spdk_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_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 689 "Invalid parameters"); 690 ctx->response_sent = true; 691 } 692 693 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_listen_resumed, ctx)) { 694 if (!ctx->response_sent) { 695 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 696 } 697 nvmf_rpc_listener_ctx_free(ctx); 698 /* Can't really do anything to recover here - subsystem will remain paused. */ 699 } 700 } 701 702 static int 703 rpc_listen_address_to_trid(const struct rpc_listen_address *address, 704 struct spdk_nvme_transport_id *trid) 705 { 706 size_t len; 707 708 memset(trid, 0, sizeof(*trid)); 709 710 if (spdk_nvme_transport_id_populate_trstring(trid, address->transport)) { 711 SPDK_ERRLOG("Invalid transport string: %s\n", address->transport); 712 return -EINVAL; 713 } 714 715 if (spdk_nvme_transport_id_parse_trtype(&trid->trtype, address->transport)) { 716 SPDK_ERRLOG("Invalid transport type: %s\n", address->transport); 717 return -EINVAL; 718 } 719 720 if (address->adrfam) { 721 if (spdk_nvme_transport_id_parse_adrfam(&trid->adrfam, address->adrfam)) { 722 SPDK_ERRLOG("Invalid adrfam: %s\n", address->adrfam); 723 return -EINVAL; 724 } 725 } else { 726 trid->adrfam = SPDK_NVMF_ADRFAM_IPV4; 727 } 728 729 len = strlen(address->traddr); 730 if (len > sizeof(trid->traddr) - 1) { 731 SPDK_ERRLOG("Transport address longer than %zu characters: %s\n", 732 sizeof(trid->traddr) - 1, address->traddr); 733 return -EINVAL; 734 } 735 memcpy(trid->traddr, address->traddr, len + 1); 736 737 len = strlen(address->trsvcid); 738 if (len > sizeof(trid->trsvcid) - 1) { 739 SPDK_ERRLOG("Transport service id longer than %zu characters: %s\n", 740 sizeof(trid->trsvcid) - 1, address->trsvcid); 741 return -EINVAL; 742 } 743 memcpy(trid->trsvcid, address->trsvcid, len + 1); 744 745 return 0; 746 } 747 748 static void 749 spdk_rpc_nvmf_subsystem_add_listener(struct spdk_jsonrpc_request *request, 750 const struct spdk_json_val *params) 751 { 752 struct nvmf_rpc_listener_ctx *ctx; 753 struct spdk_nvmf_subsystem *subsystem; 754 struct spdk_nvmf_tgt *tgt; 755 756 ctx = calloc(1, sizeof(*ctx)); 757 if (!ctx) { 758 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 759 return; 760 } 761 762 ctx->request = request; 763 764 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 765 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 766 ctx)) { 767 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 768 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 769 nvmf_rpc_listener_ctx_free(ctx); 770 return; 771 } 772 773 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 774 if (!tgt) { 775 SPDK_ERRLOG("Unable to find a target object.\n"); 776 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 777 "Unable to find a target."); 778 nvmf_rpc_listener_ctx_free(ctx); 779 return; 780 } 781 ctx->tgt = tgt; 782 783 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 784 if (!subsystem) { 785 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 786 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 787 nvmf_rpc_listener_ctx_free(ctx); 788 return; 789 } 790 791 ctx->subsystem = subsystem; 792 793 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 794 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 795 "Invalid parameters"); 796 nvmf_rpc_listener_ctx_free(ctx); 797 return; 798 } 799 800 ctx->op = NVMF_RPC_LISTEN_ADD; 801 802 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 803 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 804 nvmf_rpc_listener_ctx_free(ctx); 805 return; 806 } 807 } 808 SPDK_RPC_REGISTER("nvmf_subsystem_add_listener", spdk_rpc_nvmf_subsystem_add_listener, 809 SPDK_RPC_RUNTIME); 810 811 static void 812 spdk_rpc_nvmf_subsystem_remove_listener(struct spdk_jsonrpc_request *request, 813 const struct spdk_json_val *params) 814 { 815 struct nvmf_rpc_listener_ctx *ctx; 816 struct spdk_nvmf_subsystem *subsystem; 817 struct spdk_nvmf_tgt *tgt; 818 819 ctx = calloc(1, sizeof(*ctx)); 820 if (!ctx) { 821 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 822 return; 823 } 824 825 ctx->request = request; 826 827 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 828 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 829 ctx)) { 830 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 831 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 832 nvmf_rpc_listener_ctx_free(ctx); 833 return; 834 } 835 836 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 837 if (!tgt) { 838 SPDK_ERRLOG("Unable to find a target object.\n"); 839 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 840 "Unable to find a target."); 841 nvmf_rpc_listener_ctx_free(ctx); 842 return; 843 } 844 ctx->tgt = tgt; 845 846 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 847 if (!subsystem) { 848 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 849 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 850 nvmf_rpc_listener_ctx_free(ctx); 851 return; 852 } 853 854 ctx->subsystem = subsystem; 855 856 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 857 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 858 "Invalid parameters"); 859 nvmf_rpc_listener_ctx_free(ctx); 860 return; 861 } 862 863 ctx->op = NVMF_RPC_LISTEN_REMOVE; 864 865 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 866 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 867 nvmf_rpc_listener_ctx_free(ctx); 868 return; 869 } 870 871 } 872 SPDK_RPC_REGISTER("nvmf_subsystem_remove_listener", spdk_rpc_nvmf_subsystem_remove_listener, 873 SPDK_RPC_RUNTIME); 874 875 struct spdk_nvmf_ns_params { 876 char *bdev_name; 877 char *ptpl_file; 878 uint32_t nsid; 879 char nguid[16]; 880 char eui64[8]; 881 struct spdk_uuid uuid; 882 }; 883 884 struct rpc_namespaces { 885 size_t num_ns; 886 struct spdk_nvmf_ns_params ns_params[RPC_MAX_NAMESPACES]; 887 }; 888 889 890 static const struct spdk_json_object_decoder rpc_ns_params_decoders[] = { 891 {"nsid", offsetof(struct spdk_nvmf_ns_params, nsid), spdk_json_decode_uint32, true}, 892 {"bdev_name", offsetof(struct spdk_nvmf_ns_params, bdev_name), spdk_json_decode_string}, 893 {"ptpl_file", offsetof(struct spdk_nvmf_ns_params, ptpl_file), spdk_json_decode_string, true}, 894 {"nguid", offsetof(struct spdk_nvmf_ns_params, nguid), decode_ns_nguid, true}, 895 {"eui64", offsetof(struct spdk_nvmf_ns_params, eui64), decode_ns_eui64, true}, 896 {"uuid", offsetof(struct spdk_nvmf_ns_params, uuid), decode_ns_uuid, true}, 897 }; 898 899 static int 900 decode_rpc_ns_params(const struct spdk_json_val *val, void *out) 901 { 902 struct spdk_nvmf_ns_params *ns_params = out; 903 904 return spdk_json_decode_object(val, rpc_ns_params_decoders, 905 SPDK_COUNTOF(rpc_ns_params_decoders), 906 ns_params); 907 } 908 909 struct nvmf_rpc_ns_ctx { 910 char *nqn; 911 char *tgt_name; 912 struct spdk_nvmf_ns_params ns_params; 913 914 struct spdk_jsonrpc_request *request; 915 bool response_sent; 916 }; 917 918 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ns_decoder[] = { 919 {"nqn", offsetof(struct nvmf_rpc_ns_ctx, nqn), spdk_json_decode_string}, 920 {"namespace", offsetof(struct nvmf_rpc_ns_ctx, ns_params), decode_rpc_ns_params}, 921 {"tgt_name", offsetof(struct nvmf_rpc_ns_ctx, tgt_name), spdk_json_decode_string, true}, 922 }; 923 924 static void 925 nvmf_rpc_ns_ctx_free(struct nvmf_rpc_ns_ctx *ctx) 926 { 927 free(ctx->nqn); 928 free(ctx->tgt_name); 929 free(ctx->ns_params.bdev_name); 930 free(ctx->ns_params.ptpl_file); 931 free(ctx); 932 } 933 934 static void 935 nvmf_rpc_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 936 void *cb_arg, int status) 937 { 938 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 939 struct spdk_jsonrpc_request *request = ctx->request; 940 uint32_t nsid = ctx->ns_params.nsid; 941 bool response_sent = ctx->response_sent; 942 struct spdk_json_write_ctx *w; 943 944 nvmf_rpc_ns_ctx_free(ctx); 945 946 if (response_sent) { 947 return; 948 } 949 950 w = spdk_jsonrpc_begin_result(request); 951 spdk_json_write_uint32(w, nsid); 952 spdk_jsonrpc_end_result(request, w); 953 } 954 955 static void 956 nvmf_rpc_ns_paused(struct spdk_nvmf_subsystem *subsystem, 957 void *cb_arg, int status) 958 { 959 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 960 struct spdk_nvmf_ns_opts ns_opts; 961 struct spdk_bdev *bdev; 962 963 bdev = spdk_bdev_get_by_name(ctx->ns_params.bdev_name); 964 if (!bdev) { 965 SPDK_ERRLOG("No bdev with name %s\n", ctx->ns_params.bdev_name); 966 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 967 "Invalid parameters"); 968 ctx->response_sent = true; 969 goto resume; 970 } 971 972 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 973 ns_opts.nsid = ctx->ns_params.nsid; 974 975 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 976 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 977 978 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 979 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 980 981 if (!spdk_mem_all_zero(&ctx->ns_params.uuid, sizeof(ctx->ns_params.uuid))) { 982 ns_opts.uuid = ctx->ns_params.uuid; 983 } 984 985 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns(subsystem, bdev, &ns_opts, sizeof(ns_opts), 986 ctx->ns_params.ptpl_file); 987 if (ctx->ns_params.nsid == 0) { 988 SPDK_ERRLOG("Unable to add namespace\n"); 989 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 990 "Invalid parameters"); 991 ctx->response_sent = true; 992 goto resume; 993 } 994 995 resume: 996 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 997 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 998 nvmf_rpc_ns_ctx_free(ctx); 999 return; 1000 } 1001 } 1002 1003 static void 1004 spdk_rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 1005 const struct spdk_json_val *params) 1006 { 1007 struct nvmf_rpc_ns_ctx *ctx; 1008 struct spdk_nvmf_subsystem *subsystem; 1009 struct spdk_nvmf_tgt *tgt; 1010 1011 ctx = calloc(1, sizeof(*ctx)); 1012 if (!ctx) { 1013 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1014 return; 1015 } 1016 1017 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ns_decoder, 1018 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), 1019 ctx)) { 1020 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1021 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1022 nvmf_rpc_ns_ctx_free(ctx); 1023 return; 1024 } 1025 1026 ctx->request = request; 1027 ctx->response_sent = false; 1028 1029 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1030 if (!tgt) { 1031 SPDK_ERRLOG("Unable to find a target object.\n"); 1032 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1033 "Unable to find a target."); 1034 nvmf_rpc_ns_ctx_free(ctx); 1035 return; 1036 } 1037 1038 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1039 if (!subsystem) { 1040 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1041 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1042 nvmf_rpc_ns_ctx_free(ctx); 1043 return; 1044 } 1045 1046 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_ns_paused, ctx)) { 1047 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1048 nvmf_rpc_ns_ctx_free(ctx); 1049 return; 1050 } 1051 } 1052 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", spdk_rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1053 1054 struct nvmf_rpc_remove_ns_ctx { 1055 char *nqn; 1056 char *tgt_name; 1057 uint32_t nsid; 1058 1059 struct spdk_jsonrpc_request *request; 1060 bool response_sent; 1061 }; 1062 1063 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1064 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1065 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1066 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1067 }; 1068 1069 static void 1070 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1071 { 1072 free(ctx->nqn); 1073 free(ctx->tgt_name); 1074 free(ctx); 1075 } 1076 1077 static void 1078 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1079 void *cb_arg, int status) 1080 { 1081 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1082 struct spdk_jsonrpc_request *request = ctx->request; 1083 bool response_sent = ctx->response_sent; 1084 struct spdk_json_write_ctx *w; 1085 1086 nvmf_rpc_remove_ns_ctx_free(ctx); 1087 1088 if (response_sent) { 1089 return; 1090 } 1091 1092 w = spdk_jsonrpc_begin_result(request); 1093 spdk_json_write_bool(w, true); 1094 spdk_jsonrpc_end_result(request, w); 1095 } 1096 1097 static void 1098 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1099 void *cb_arg, int status) 1100 { 1101 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1102 int ret; 1103 1104 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1105 if (ret < 0) { 1106 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1107 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1108 "Invalid parameters"); 1109 ctx->response_sent = true; 1110 } 1111 1112 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1113 if (!ctx->response_sent) { 1114 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1115 } 1116 nvmf_rpc_remove_ns_ctx_free(ctx); 1117 return; 1118 } 1119 } 1120 1121 static void 1122 spdk_rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1123 const struct spdk_json_val *params) 1124 { 1125 struct nvmf_rpc_remove_ns_ctx *ctx; 1126 struct spdk_nvmf_subsystem *subsystem; 1127 struct spdk_nvmf_tgt *tgt; 1128 1129 ctx = calloc(1, sizeof(*ctx)); 1130 if (!ctx) { 1131 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1132 return; 1133 } 1134 1135 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1136 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1137 ctx)) { 1138 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1139 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1140 nvmf_rpc_remove_ns_ctx_free(ctx); 1141 return; 1142 } 1143 1144 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1145 if (!tgt) { 1146 SPDK_ERRLOG("Unable to find a target object.\n"); 1147 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1148 "Unable to find a target."); 1149 nvmf_rpc_remove_ns_ctx_free(ctx); 1150 return; 1151 } 1152 1153 ctx->request = request; 1154 ctx->response_sent = false; 1155 1156 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1157 if (!subsystem) { 1158 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1159 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1160 nvmf_rpc_remove_ns_ctx_free(ctx); 1161 return; 1162 } 1163 1164 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_remove_ns_paused, ctx)) { 1165 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1166 nvmf_rpc_remove_ns_ctx_free(ctx); 1167 return; 1168 } 1169 } 1170 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", spdk_rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1171 1172 enum nvmf_rpc_host_op { 1173 NVMF_RPC_HOST_ADD, 1174 NVMF_RPC_HOST_REMOVE, 1175 NVMF_RPC_HOST_ALLOW_ANY, 1176 }; 1177 1178 struct nvmf_rpc_host_ctx { 1179 struct spdk_jsonrpc_request *request; 1180 1181 char *nqn; 1182 char *host; 1183 char *tgt_name; 1184 1185 enum nvmf_rpc_host_op op; 1186 1187 bool allow_any_host; 1188 1189 bool response_sent; 1190 }; 1191 1192 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1193 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1194 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1195 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1196 }; 1197 1198 static void 1199 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1200 { 1201 free(ctx->nqn); 1202 free(ctx->host); 1203 free(ctx->tgt_name); 1204 free(ctx); 1205 } 1206 1207 static void 1208 nvmf_rpc_host_resumed(struct spdk_nvmf_subsystem *subsystem, 1209 void *cb_arg, int status) 1210 { 1211 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1212 struct spdk_jsonrpc_request *request; 1213 struct spdk_json_write_ctx *w; 1214 bool response_sent = ctx->response_sent; 1215 1216 request = ctx->request; 1217 nvmf_rpc_host_ctx_free(ctx); 1218 1219 if (response_sent) { 1220 return; 1221 } 1222 1223 w = spdk_jsonrpc_begin_result(request); 1224 spdk_json_write_bool(w, true); 1225 spdk_jsonrpc_end_result(request, w); 1226 } 1227 1228 static void 1229 nvmf_rpc_host_paused(struct spdk_nvmf_subsystem *subsystem, 1230 void *cb_arg, int status) 1231 { 1232 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1233 int rc = -1; 1234 1235 switch (ctx->op) { 1236 case NVMF_RPC_HOST_ADD: 1237 rc = spdk_nvmf_subsystem_add_host(subsystem, ctx->host); 1238 break; 1239 case NVMF_RPC_HOST_REMOVE: 1240 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 1241 break; 1242 case NVMF_RPC_HOST_ALLOW_ANY: 1243 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx->allow_any_host); 1244 break; 1245 } 1246 1247 if (rc != 0) { 1248 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1249 ctx->response_sent = true; 1250 } 1251 1252 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_host_resumed, ctx)) { 1253 if (!ctx->response_sent) { 1254 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1255 } 1256 nvmf_rpc_host_ctx_free(ctx); 1257 return; 1258 } 1259 } 1260 1261 static void 1262 spdk_rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1263 const struct spdk_json_val *params) 1264 { 1265 struct nvmf_rpc_host_ctx *ctx; 1266 struct spdk_nvmf_subsystem *subsystem; 1267 struct spdk_nvmf_tgt *tgt; 1268 1269 ctx = calloc(1, sizeof(*ctx)); 1270 if (!ctx) { 1271 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1272 return; 1273 } 1274 1275 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1276 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1277 ctx)) { 1278 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1279 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1280 nvmf_rpc_host_ctx_free(ctx); 1281 return; 1282 } 1283 1284 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1285 if (!tgt) { 1286 SPDK_ERRLOG("Unable to find a target object.\n"); 1287 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1288 "Unable to find a target."); 1289 nvmf_rpc_host_ctx_free(ctx); 1290 return; 1291 } 1292 1293 ctx->request = request; 1294 ctx->op = NVMF_RPC_HOST_ADD; 1295 ctx->response_sent = false; 1296 1297 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1298 if (!subsystem) { 1299 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1300 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1301 nvmf_rpc_host_ctx_free(ctx); 1302 return; 1303 } 1304 1305 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1306 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1307 nvmf_rpc_host_ctx_free(ctx); 1308 return; 1309 } 1310 } 1311 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", spdk_rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 1312 1313 static void 1314 spdk_rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 1315 const struct spdk_json_val *params) 1316 { 1317 struct nvmf_rpc_host_ctx *ctx; 1318 struct spdk_nvmf_subsystem *subsystem; 1319 struct spdk_nvmf_tgt *tgt; 1320 1321 ctx = calloc(1, sizeof(*ctx)); 1322 if (!ctx) { 1323 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1324 return; 1325 } 1326 1327 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1328 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1329 ctx)) { 1330 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1331 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1332 nvmf_rpc_host_ctx_free(ctx); 1333 return; 1334 } 1335 1336 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1337 if (!tgt) { 1338 SPDK_ERRLOG("Unable to find a target object.\n"); 1339 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1340 "Unable to find a target."); 1341 nvmf_rpc_host_ctx_free(ctx); 1342 return; 1343 } 1344 1345 ctx->request = request; 1346 ctx->op = NVMF_RPC_HOST_REMOVE; 1347 ctx->response_sent = false; 1348 1349 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1350 if (!subsystem) { 1351 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1352 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1353 nvmf_rpc_host_ctx_free(ctx); 1354 return; 1355 } 1356 1357 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1358 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1359 nvmf_rpc_host_ctx_free(ctx); 1360 return; 1361 } 1362 } 1363 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", spdk_rpc_nvmf_subsystem_remove_host, 1364 SPDK_RPC_RUNTIME) 1365 1366 1367 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 1368 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1369 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 1370 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1371 }; 1372 1373 static void 1374 spdk_rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 1375 const struct spdk_json_val *params) 1376 { 1377 struct nvmf_rpc_host_ctx *ctx; 1378 struct spdk_nvmf_subsystem *subsystem; 1379 struct spdk_nvmf_tgt *tgt; 1380 1381 ctx = calloc(1, sizeof(*ctx)); 1382 if (!ctx) { 1383 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1384 return; 1385 } 1386 1387 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 1388 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 1389 ctx)) { 1390 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1391 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1392 nvmf_rpc_host_ctx_free(ctx); 1393 return; 1394 } 1395 1396 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1397 if (!tgt) { 1398 SPDK_ERRLOG("Unable to find a target object.\n"); 1399 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1400 "Unable to find a target."); 1401 nvmf_rpc_host_ctx_free(ctx); 1402 return; 1403 } 1404 1405 ctx->request = request; 1406 ctx->op = NVMF_RPC_HOST_ALLOW_ANY; 1407 ctx->response_sent = false; 1408 1409 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1410 if (!subsystem) { 1411 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1412 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1413 nvmf_rpc_host_ctx_free(ctx); 1414 return; 1415 } 1416 1417 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1418 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1419 nvmf_rpc_host_ctx_free(ctx); 1420 return; 1421 } 1422 } 1423 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", spdk_rpc_nvmf_subsystem_allow_any_host, 1424 SPDK_RPC_RUNTIME) 1425 1426 struct nvmf_rpc_target_ctx { 1427 char *name; 1428 uint32_t max_subsystems; 1429 }; 1430 1431 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 1432 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1433 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 1434 }; 1435 1436 static void 1437 spdk_rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 1438 const struct spdk_json_val *params) 1439 { 1440 struct spdk_nvmf_target_opts opts; 1441 struct nvmf_rpc_target_ctx ctx = {0}; 1442 struct spdk_nvmf_tgt *tgt; 1443 struct spdk_json_write_ctx *w; 1444 1445 /* Decode parameters the first time to get the transport type */ 1446 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 1447 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 1448 &ctx)) { 1449 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1450 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1451 free(ctx.name); 1452 return; 1453 } 1454 1455 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 1456 opts.max_subsystems = ctx.max_subsystems; 1457 1458 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 1459 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1460 "Target already exists."); 1461 free(ctx.name); 1462 return; 1463 } 1464 1465 tgt = spdk_nvmf_tgt_create(&opts); 1466 1467 if (tgt == NULL) { 1468 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1469 "Unable to create the requested target."); 1470 free(ctx.name); 1471 return; 1472 } 1473 1474 w = spdk_jsonrpc_begin_result(request); 1475 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 1476 spdk_jsonrpc_end_result(request, w); 1477 free(ctx.name); 1478 } 1479 SPDK_RPC_REGISTER("nvmf_create_target", spdk_rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 1480 1481 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 1482 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1483 }; 1484 1485 static void 1486 nvmf_rpc_destroy_target_done(void *ctx, int status) 1487 { 1488 struct spdk_jsonrpc_request *request = ctx; 1489 struct spdk_json_write_ctx *w; 1490 1491 w = spdk_jsonrpc_begin_result(request); 1492 spdk_json_write_bool(w, true); 1493 spdk_jsonrpc_end_result(request, w); 1494 } 1495 1496 static void 1497 spdk_rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 1498 const struct spdk_json_val *params) 1499 { 1500 struct nvmf_rpc_target_ctx ctx = {0}; 1501 struct spdk_nvmf_tgt *tgt; 1502 1503 /* Decode parameters the first time to get the transport type */ 1504 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 1505 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 1506 &ctx)) { 1507 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1508 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1509 free(ctx.name); 1510 return; 1511 } 1512 1513 tgt = spdk_nvmf_get_tgt(ctx.name); 1514 1515 if (tgt == NULL) { 1516 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1517 "The specified target doesn't exist, cannot delete it."); 1518 free(ctx.name); 1519 return; 1520 } 1521 1522 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 1523 free(ctx.name); 1524 } 1525 SPDK_RPC_REGISTER("nvmf_delete_target", spdk_rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 1526 1527 static void 1528 spdk_rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 1529 const struct spdk_json_val *params) 1530 { 1531 struct spdk_json_write_ctx *w; 1532 struct spdk_nvmf_tgt *tgt; 1533 const char *name; 1534 1535 if (params != NULL) { 1536 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1537 "nvmf_get_targets has no parameters."); 1538 return; 1539 } 1540 1541 w = spdk_jsonrpc_begin_result(request); 1542 spdk_json_write_array_begin(w); 1543 1544 tgt = spdk_nvmf_get_first_tgt(); 1545 1546 while (tgt != NULL) { 1547 name = spdk_nvmf_tgt_get_name(tgt); 1548 spdk_json_write_string(w, name); 1549 tgt = spdk_nvmf_get_next_tgt(tgt); 1550 } 1551 1552 spdk_json_write_array_end(w); 1553 spdk_jsonrpc_end_result(request, w); 1554 } 1555 SPDK_RPC_REGISTER("nvmf_get_targets", spdk_rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 1556 1557 struct nvmf_rpc_create_transport_ctx { 1558 char *trtype; 1559 char *tgt_name; 1560 struct spdk_nvmf_transport_opts opts; 1561 struct spdk_jsonrpc_request *request; 1562 }; 1563 1564 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 1565 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 1566 { 1567 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 1568 spdk_json_decode_uint16, true 1569 }, 1570 { 1571 "max_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1572 spdk_json_decode_uint16, true 1573 }, 1574 { 1575 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 1576 spdk_json_decode_uint32, true 1577 }, 1578 { 1579 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 1580 spdk_json_decode_uint32, true 1581 }, 1582 { 1583 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 1584 spdk_json_decode_uint32, true 1585 }, 1586 { 1587 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 1588 spdk_json_decode_uint32, true 1589 }, 1590 { 1591 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 1592 spdk_json_decode_uint32, true 1593 }, 1594 { 1595 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 1596 spdk_json_decode_uint32, true 1597 }, 1598 { 1599 "max_srq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_srq_depth), 1600 spdk_json_decode_uint32, true 1601 }, 1602 { 1603 "no_srq", offsetof(struct nvmf_rpc_create_transport_ctx, opts.no_srq), 1604 spdk_json_decode_bool, true 1605 }, 1606 { 1607 "c2h_success", offsetof(struct nvmf_rpc_create_transport_ctx, opts.c2h_success), 1608 spdk_json_decode_bool, true 1609 }, 1610 { 1611 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 1612 spdk_json_decode_bool, true 1613 }, 1614 { 1615 "sock_priority", offsetof(struct nvmf_rpc_create_transport_ctx, opts.sock_priority), 1616 spdk_json_decode_uint32, true 1617 }, 1618 { 1619 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 1620 spdk_json_decode_string, true 1621 }, 1622 }; 1623 1624 static void 1625 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 1626 { 1627 free(ctx->trtype); 1628 free(ctx->tgt_name); 1629 free(ctx); 1630 } 1631 1632 static void 1633 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 1634 { 1635 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 1636 struct spdk_jsonrpc_request *request; 1637 struct spdk_json_write_ctx *w; 1638 1639 request = ctx->request; 1640 nvmf_rpc_create_transport_ctx_free(ctx); 1641 1642 if (status) { 1643 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 1644 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1645 "Failed to add transport to tgt.(%d)\n", 1646 status); 1647 return; 1648 } 1649 1650 w = spdk_jsonrpc_begin_result(request); 1651 spdk_json_write_bool(w, true); 1652 spdk_jsonrpc_end_result(request, w); 1653 } 1654 1655 static void 1656 spdk_rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 1657 const struct spdk_json_val *params) 1658 { 1659 struct nvmf_rpc_create_transport_ctx *ctx; 1660 enum spdk_nvme_transport_type trtype; 1661 struct spdk_nvmf_transport *transport; 1662 struct spdk_nvmf_tgt *tgt; 1663 1664 ctx = calloc(1, sizeof(*ctx)); 1665 if (!ctx) { 1666 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1667 return; 1668 } 1669 1670 /* Decode parameters the first time to get the transport type */ 1671 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 1672 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1673 ctx)) { 1674 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1675 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1676 nvmf_rpc_create_transport_ctx_free(ctx); 1677 return; 1678 } 1679 1680 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1681 if (!tgt) { 1682 SPDK_ERRLOG("Unable to find a target object.\n"); 1683 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1684 "Unable to find a target."); 1685 nvmf_rpc_create_transport_ctx_free(ctx); 1686 return; 1687 } 1688 1689 if (spdk_nvme_transport_id_parse_trtype(&trtype, ctx->trtype)) { 1690 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1691 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1692 "Invalid transport type '%s'\n", ctx->trtype); 1693 nvmf_rpc_create_transport_ctx_free(ctx); 1694 return; 1695 } 1696 1697 /* Initialize all the transport options (based on transport type) and decode the 1698 * parameters again to update any options passed in rpc create transport call. 1699 */ 1700 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts)) { 1701 /* This can happen if user specifies PCIE transport type which isn't valid for 1702 * NVMe-oF. 1703 */ 1704 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1705 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1706 "Invalid transport type '%s'\n", ctx->trtype); 1707 nvmf_rpc_create_transport_ctx_free(ctx); 1708 return; 1709 } 1710 1711 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 1712 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1713 ctx)) { 1714 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1715 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1716 nvmf_rpc_create_transport_ctx_free(ctx); 1717 return; 1718 } 1719 1720 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 1721 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 1722 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1723 "Transport type '%s' already exists\n", ctx->trtype); 1724 nvmf_rpc_create_transport_ctx_free(ctx); 1725 return; 1726 } 1727 1728 transport = spdk_nvmf_transport_create(ctx->trtype, &ctx->opts); 1729 1730 if (!transport) { 1731 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 1732 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1733 "Transport type '%s' create failed\n", ctx->trtype); 1734 nvmf_rpc_create_transport_ctx_free(ctx); 1735 return; 1736 } 1737 1738 /* add transport to target */ 1739 ctx->request = request; 1740 spdk_nvmf_tgt_add_transport(tgt, transport, nvmf_rpc_tgt_add_transport_done, ctx); 1741 } 1742 SPDK_RPC_REGISTER("nvmf_create_transport", spdk_rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 1743 1744 static void 1745 dump_nvmf_transport(struct spdk_json_write_ctx *w, struct spdk_nvmf_transport *transport) 1746 { 1747 const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport); 1748 spdk_nvme_transport_type_t type = spdk_nvmf_get_transport_type(transport); 1749 1750 spdk_json_write_object_begin(w); 1751 1752 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport)); 1753 spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth); 1754 spdk_json_write_named_uint32(w, "max_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr); 1755 spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size); 1756 spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size); 1757 spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size); 1758 spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth); 1759 spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers); 1760 spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size); 1761 spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip); 1762 if (type == SPDK_NVME_TRANSPORT_RDMA) { 1763 spdk_json_write_named_uint32(w, "max_srq_depth", opts->max_srq_depth); 1764 spdk_json_write_named_bool(w, "no_srq", opts->no_srq); 1765 } else if (type == SPDK_NVME_TRANSPORT_TCP) { 1766 spdk_json_write_named_bool(w, "c2h_success", opts->c2h_success); 1767 spdk_json_write_named_uint32(w, "sock_priority", opts->sock_priority); 1768 } 1769 1770 spdk_json_write_object_end(w); 1771 } 1772 1773 struct rpc_get_transport { 1774 char *tgt_name; 1775 }; 1776 1777 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 1778 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 1779 }; 1780 1781 static void 1782 spdk_rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 1783 const struct spdk_json_val *params) 1784 { 1785 struct rpc_get_transport req = { 0 }; 1786 struct spdk_json_write_ctx *w; 1787 struct spdk_nvmf_transport *transport; 1788 struct spdk_nvmf_tgt *tgt; 1789 1790 if (params) { 1791 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 1792 SPDK_COUNTOF(rpc_get_transport_decoders), 1793 &req)) { 1794 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1795 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1796 return; 1797 } 1798 } 1799 1800 tgt = spdk_nvmf_get_tgt(req.tgt_name); 1801 if (!tgt) { 1802 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1803 "Unable to find a target."); 1804 free(req.tgt_name); 1805 return; 1806 } 1807 1808 w = spdk_jsonrpc_begin_result(request); 1809 spdk_json_write_array_begin(w); 1810 transport = spdk_nvmf_transport_get_first(tgt); 1811 while (transport) { 1812 dump_nvmf_transport(w, transport); 1813 transport = spdk_nvmf_transport_get_next(transport); 1814 } 1815 spdk_json_write_array_end(w); 1816 spdk_jsonrpc_end_result(request, w); 1817 free(req.tgt_name); 1818 } 1819 SPDK_RPC_REGISTER("nvmf_get_transports", spdk_rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 1820 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_transports, get_nvmf_transports) 1821 1822 struct rpc_nvmf_get_stats_ctx { 1823 char *tgt_name; 1824 struct spdk_nvmf_tgt *tgt; 1825 struct spdk_jsonrpc_request *request; 1826 struct spdk_json_write_ctx *w; 1827 }; 1828 1829 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 1830 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 1831 }; 1832 1833 static void 1834 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 1835 { 1836 free(ctx->tgt_name); 1837 free(ctx); 1838 } 1839 1840 static void 1841 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 1842 { 1843 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1844 1845 spdk_json_write_array_end(ctx->w); 1846 spdk_json_write_object_end(ctx->w); 1847 spdk_jsonrpc_end_result(ctx->request, ctx->w); 1848 free_get_stats_ctx(ctx); 1849 } 1850 1851 static void 1852 write_nvmf_transport_stats(struct spdk_json_write_ctx *w, 1853 struct spdk_nvmf_transport_poll_group_stat *stat) 1854 { 1855 uint64_t i; 1856 1857 spdk_json_write_object_begin(w); 1858 spdk_json_write_named_string(w, "trtype", 1859 spdk_nvme_transport_id_trtype_str(stat->trtype)); 1860 switch (stat->trtype) { 1861 case SPDK_NVME_TRANSPORT_RDMA: 1862 spdk_json_write_named_uint64(w, "pending_data_buffer", stat->rdma.pending_data_buffer); 1863 spdk_json_write_named_array_begin(w, "devices"); 1864 for (i = 0; i < stat->rdma.num_devices; ++i) { 1865 spdk_json_write_object_begin(w); 1866 spdk_json_write_named_string(w, "name", stat->rdma.devices[i].name); 1867 spdk_json_write_named_uint64(w, "polls", stat->rdma.devices[i].polls); 1868 spdk_json_write_named_uint64(w, "completions", stat->rdma.devices[i].completions); 1869 spdk_json_write_named_uint64(w, "requests", 1870 stat->rdma.devices[i].requests); 1871 spdk_json_write_named_uint64(w, "request_latency", 1872 stat->rdma.devices[i].request_latency); 1873 spdk_json_write_named_uint64(w, "pending_free_request", 1874 stat->rdma.devices[i].pending_free_request); 1875 spdk_json_write_named_uint64(w, "pending_rdma_read", 1876 stat->rdma.devices[i].pending_rdma_read); 1877 spdk_json_write_named_uint64(w, "pending_rdma_write", 1878 stat->rdma.devices[i].pending_rdma_write); 1879 spdk_json_write_object_end(w); 1880 } 1881 spdk_json_write_array_end(w); 1882 break; 1883 default: 1884 break; 1885 } 1886 spdk_json_write_object_end(w); 1887 } 1888 1889 static void 1890 rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 1891 { 1892 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1893 struct spdk_nvmf_transport *transport; 1894 struct spdk_nvmf_poll_group_stat stat; 1895 struct spdk_nvmf_transport_poll_group_stat *trstat; 1896 int rc; 1897 1898 if (0 == spdk_nvmf_poll_group_get_stat(ctx->tgt, &stat)) { 1899 spdk_json_write_object_begin(ctx->w); 1900 spdk_json_write_named_string(ctx->w, "name", spdk_thread_get_name(spdk_get_thread())); 1901 spdk_json_write_named_uint32(ctx->w, "admin_qpairs", stat.admin_qpairs); 1902 spdk_json_write_named_uint32(ctx->w, "io_qpairs", stat.io_qpairs); 1903 spdk_json_write_named_uint64(ctx->w, "pending_bdev_io", stat.pending_bdev_io); 1904 1905 spdk_json_write_named_array_begin(ctx->w, "transports"); 1906 transport = spdk_nvmf_transport_get_first(ctx->tgt); 1907 while (transport) { 1908 rc = spdk_nvmf_transport_poll_group_get_stat(ctx->tgt, transport, &trstat); 1909 if (0 == rc) { 1910 write_nvmf_transport_stats(ctx->w, trstat); 1911 spdk_nvmf_transport_poll_group_free_stat(transport, trstat); 1912 } else if (-ENOTSUP != rc) { 1913 SPDK_ERRLOG("Failed to get poll group statistics for transport %s, errno %d\n", 1914 spdk_nvme_transport_id_trtype_str(spdk_nvmf_get_transport_type(transport)), 1915 rc); 1916 } 1917 transport = spdk_nvmf_transport_get_next(transport); 1918 } 1919 spdk_json_write_array_end(ctx->w); 1920 spdk_json_write_object_end(ctx->w); 1921 } 1922 1923 spdk_for_each_channel_continue(i, 0); 1924 } 1925 1926 1927 static void 1928 spdk_rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 1929 const struct spdk_json_val *params) 1930 { 1931 struct rpc_nvmf_get_stats_ctx *ctx; 1932 1933 ctx = calloc(1, sizeof(*ctx)); 1934 if (!ctx) { 1935 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1936 "Memory allocation error"); 1937 return; 1938 } 1939 ctx->request = request; 1940 1941 if (params) { 1942 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 1943 SPDK_COUNTOF(rpc_get_stats_decoders), 1944 ctx)) { 1945 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1946 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1947 free_get_stats_ctx(ctx); 1948 return; 1949 } 1950 } 1951 1952 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1953 if (!ctx->tgt) { 1954 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1955 "Unable to find a target."); 1956 free_get_stats_ctx(ctx); 1957 return; 1958 } 1959 1960 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 1961 spdk_json_write_object_begin(ctx->w); 1962 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 1963 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 1964 1965 spdk_for_each_channel(ctx->tgt, 1966 rpc_nvmf_get_stats, 1967 ctx, 1968 rpc_nvmf_get_stats_done); 1969 } 1970 1971 SPDK_RPC_REGISTER("nvmf_get_stats", spdk_rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 1972