1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2018-2019 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_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_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 struct spdk_json_write_ctx *w; 363 364 w = spdk_jsonrpc_begin_result(request); 365 spdk_json_write_bool(w, true); 366 spdk_jsonrpc_end_result(request, w); 367 } 368 369 static void 370 spdk_rpc_nvmf_create_subsystem(struct spdk_jsonrpc_request *request, 371 const struct spdk_json_val *params) 372 { 373 struct rpc_subsystem_create *req; 374 struct spdk_nvmf_subsystem *subsystem; 375 struct spdk_nvmf_tgt *tgt; 376 377 req = calloc(1, sizeof(*req)); 378 if (!req) { 379 goto invalid; 380 } 381 382 if (spdk_json_decode_object(params, rpc_subsystem_create_decoders, 383 SPDK_COUNTOF(rpc_subsystem_create_decoders), 384 req)) { 385 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 386 goto invalid; 387 } 388 389 tgt = spdk_nvmf_get_tgt(req->tgt_name); 390 if (!tgt) { 391 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 392 "Unable to find a target."); 393 goto invalid_custom_response; 394 } 395 396 subsystem = spdk_nvmf_subsystem_create(tgt, req->nqn, SPDK_NVMF_SUBTYPE_NVME, 397 req->max_namespaces); 398 if (!subsystem) { 399 goto invalid; 400 } 401 402 if (req->serial_number) { 403 if (spdk_nvmf_subsystem_set_sn(subsystem, req->serial_number)) { 404 SPDK_ERRLOG("Subsystem %s: invalid serial number '%s'\n", req->nqn, req->serial_number); 405 goto invalid; 406 } 407 } 408 409 if (req->model_number) { 410 if (spdk_nvmf_subsystem_set_mn(subsystem, req->model_number)) { 411 SPDK_ERRLOG("Subsystem %s: invalid model number '%s'\n", req->nqn, req->model_number); 412 goto invalid; 413 } 414 } 415 416 spdk_nvmf_subsystem_set_allow_any_host(subsystem, req->allow_any_host); 417 418 free(req->nqn); 419 free(req->tgt_name); 420 free(req->serial_number); 421 free(req->model_number); 422 free(req); 423 424 spdk_nvmf_subsystem_start(subsystem, 425 spdk_rpc_nvmf_subsystem_started, 426 request); 427 428 return; 429 430 invalid: 431 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 432 invalid_custom_response: 433 if (req) { 434 free(req->nqn); 435 free(req->tgt_name); 436 free(req->serial_number); 437 free(req->model_number); 438 } 439 free(req); 440 } 441 SPDK_RPC_REGISTER("nvmf_create_subsystem", spdk_rpc_nvmf_create_subsystem, SPDK_RPC_RUNTIME) 442 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_create_subsystem, nvmf_subsystem_create) 443 444 struct rpc_delete_subsystem { 445 char *nqn; 446 char *tgt_name; 447 }; 448 449 static void 450 free_rpc_delete_subsystem(struct rpc_delete_subsystem *r) 451 { 452 free(r->nqn); 453 free(r->tgt_name); 454 } 455 456 static void 457 spdk_rpc_nvmf_subsystem_stopped(struct spdk_nvmf_subsystem *subsystem, 458 void *cb_arg, int status) 459 { 460 struct spdk_jsonrpc_request *request = cb_arg; 461 struct spdk_json_write_ctx *w; 462 463 spdk_nvmf_subsystem_remove_all_listeners(subsystem, true); 464 spdk_nvmf_subsystem_destroy(subsystem); 465 466 w = spdk_jsonrpc_begin_result(request); 467 spdk_json_write_bool(w, true); 468 spdk_jsonrpc_end_result(request, w); 469 } 470 471 static const struct spdk_json_object_decoder rpc_delete_subsystem_decoders[] = { 472 {"nqn", offsetof(struct rpc_delete_subsystem, nqn), spdk_json_decode_string}, 473 {"tgt_name", offsetof(struct rpc_delete_subsystem, tgt_name), spdk_json_decode_string, true}, 474 }; 475 476 static void 477 spdk_rpc_nvmf_delete_subsystem(struct spdk_jsonrpc_request *request, 478 const struct spdk_json_val *params) 479 { 480 struct rpc_delete_subsystem req = { 0 }; 481 struct spdk_nvmf_subsystem *subsystem; 482 struct spdk_nvmf_tgt *tgt; 483 484 if (spdk_json_decode_object(params, rpc_delete_subsystem_decoders, 485 SPDK_COUNTOF(rpc_delete_subsystem_decoders), 486 &req)) { 487 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 488 goto invalid; 489 } 490 491 if (req.nqn == NULL) { 492 SPDK_ERRLOG("missing name param\n"); 493 goto invalid; 494 } 495 496 tgt = spdk_nvmf_get_tgt(req.tgt_name); 497 if (!tgt) { 498 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 499 "Unable to find a target."); 500 goto invalid_custom_response; 501 } 502 503 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, req.nqn); 504 if (!subsystem) { 505 goto invalid; 506 } 507 508 free_rpc_delete_subsystem(&req); 509 510 spdk_nvmf_subsystem_stop(subsystem, 511 spdk_rpc_nvmf_subsystem_stopped, 512 request); 513 514 return; 515 516 invalid: 517 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 518 invalid_custom_response: 519 free_rpc_delete_subsystem(&req); 520 } 521 SPDK_RPC_REGISTER("nvmf_delete_subsystem", spdk_rpc_nvmf_delete_subsystem, SPDK_RPC_RUNTIME) 522 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_delete_subsystem, delete_nvmf_subsystem) 523 524 struct rpc_listen_address { 525 char *transport; 526 char *adrfam; 527 char *traddr; 528 char *trsvcid; 529 }; 530 531 #define RPC_MAX_LISTEN_ADDRESSES 255 532 #define RPC_MAX_NAMESPACES 255 533 534 struct rpc_listen_addresses { 535 size_t num_listen_address; 536 struct rpc_listen_address addresses[RPC_MAX_LISTEN_ADDRESSES]; 537 }; 538 539 static const struct spdk_json_object_decoder rpc_listen_address_decoders[] = { 540 /* NOTE: "transport" is kept for compatibility; new code should use "trtype" */ 541 {"transport", offsetof(struct rpc_listen_address, transport), spdk_json_decode_string, true}, 542 {"trtype", offsetof(struct rpc_listen_address, transport), spdk_json_decode_string, true}, 543 {"adrfam", offsetof(struct rpc_listen_address, adrfam), spdk_json_decode_string, true}, 544 {"traddr", offsetof(struct rpc_listen_address, traddr), spdk_json_decode_string}, 545 {"trsvcid", offsetof(struct rpc_listen_address, trsvcid), spdk_json_decode_string}, 546 }; 547 548 static int 549 decode_rpc_listen_address(const struct spdk_json_val *val, void *out) 550 { 551 struct rpc_listen_address *req = (struct rpc_listen_address *)out; 552 if (spdk_json_decode_object(val, rpc_listen_address_decoders, 553 SPDK_COUNTOF(rpc_listen_address_decoders), 554 req)) { 555 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 556 return -1; 557 } 558 return 0; 559 } 560 561 static void 562 free_rpc_listen_address(struct rpc_listen_address *r) 563 { 564 free(r->transport); 565 free(r->adrfam); 566 free(r->traddr); 567 free(r->trsvcid); 568 } 569 570 enum nvmf_rpc_listen_op { 571 NVMF_RPC_LISTEN_ADD, 572 NVMF_RPC_LISTEN_REMOVE, 573 }; 574 575 struct nvmf_rpc_listener_ctx { 576 char *nqn; 577 char *tgt_name; 578 struct spdk_nvmf_tgt *tgt; 579 struct spdk_nvmf_subsystem *subsystem; 580 struct rpc_listen_address address; 581 582 struct spdk_jsonrpc_request *request; 583 struct spdk_nvme_transport_id trid; 584 enum nvmf_rpc_listen_op op; 585 bool response_sent; 586 }; 587 588 static const struct spdk_json_object_decoder nvmf_rpc_listener_decoder[] = { 589 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 590 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 591 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 592 }; 593 594 static void 595 nvmf_rpc_listener_ctx_free(struct nvmf_rpc_listener_ctx *ctx) 596 { 597 free(ctx->nqn); 598 free(ctx->tgt_name); 599 free_rpc_listen_address(&ctx->address); 600 free(ctx); 601 } 602 603 static void 604 nvmf_rpc_listen_resumed(struct spdk_nvmf_subsystem *subsystem, 605 void *cb_arg, int status) 606 { 607 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 608 struct spdk_jsonrpc_request *request; 609 struct spdk_json_write_ctx *w; 610 611 request = ctx->request; 612 if (ctx->response_sent) { 613 /* If an error occurred, the response has already been sent. */ 614 nvmf_rpc_listener_ctx_free(ctx); 615 return; 616 } 617 618 nvmf_rpc_listener_ctx_free(ctx); 619 620 w = spdk_jsonrpc_begin_result(request); 621 spdk_json_write_bool(w, true); 622 spdk_jsonrpc_end_result(request, w); 623 } 624 625 static void 626 nvmf_rpc_tgt_listen(void *cb_arg, int status) 627 { 628 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 629 630 if (status) { 631 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 632 "Invalid parameters"); 633 ctx->response_sent = true; 634 } else { 635 if (spdk_nvmf_subsystem_add_listener(ctx->subsystem, &ctx->trid)) { 636 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 637 "Invalid parameters"); 638 ctx->response_sent = true; 639 } 640 } 641 642 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 643 if (!ctx->response_sent) { 644 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 645 } 646 nvmf_rpc_listener_ctx_free(ctx); 647 /* Can't really do anything to recover here - subsystem will remain paused. */ 648 } 649 } 650 651 static void 652 nvmf_rpc_listen_paused(struct spdk_nvmf_subsystem *subsystem, 653 void *cb_arg, int status) 654 { 655 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 656 657 if (ctx->op == NVMF_RPC_LISTEN_ADD) { 658 if (!spdk_nvmf_subsystem_find_listener(subsystem, &ctx->trid)) { 659 spdk_nvmf_tgt_listen(ctx->tgt, &ctx->trid, nvmf_rpc_tgt_listen, ctx); 660 return; 661 } 662 } else if (ctx->op == NVMF_RPC_LISTEN_REMOVE) { 663 if (spdk_nvmf_subsystem_remove_listener(subsystem, &ctx->trid)) { 664 SPDK_ERRLOG("Unable to remove listener.\n"); 665 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 666 "Invalid parameters"); 667 ctx->response_sent = true; 668 } 669 spdk_nvmf_tgt_stop_listen(ctx->tgt, &ctx->trid); 670 } else { 671 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 672 "Invalid parameters"); 673 ctx->response_sent = true; 674 } 675 676 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_listen_resumed, ctx)) { 677 if (!ctx->response_sent) { 678 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 679 } 680 nvmf_rpc_listener_ctx_free(ctx); 681 /* Can't really do anything to recover here - subsystem will remain paused. */ 682 } 683 } 684 685 static int 686 rpc_listen_address_to_trid(const struct rpc_listen_address *address, 687 struct spdk_nvme_transport_id *trid) 688 { 689 size_t len; 690 691 memset(trid, 0, sizeof(*trid)); 692 693 if (spdk_nvme_transport_id_populate_trstring(trid, address->transport)) { 694 SPDK_ERRLOG("Invalid transport string: %s\n", address->transport); 695 return -EINVAL; 696 } 697 698 if (spdk_nvme_transport_id_parse_trtype(&trid->trtype, address->transport)) { 699 SPDK_ERRLOG("Invalid transport type: %s\n", address->transport); 700 return -EINVAL; 701 } 702 703 if (address->adrfam) { 704 if (spdk_nvme_transport_id_parse_adrfam(&trid->adrfam, address->adrfam)) { 705 SPDK_ERRLOG("Invalid adrfam: %s\n", address->adrfam); 706 return -EINVAL; 707 } 708 } else { 709 trid->adrfam = SPDK_NVMF_ADRFAM_IPV4; 710 } 711 712 len = strlen(address->traddr); 713 if (len > sizeof(trid->traddr) - 1) { 714 SPDK_ERRLOG("Transport address longer than %zu characters: %s\n", 715 sizeof(trid->traddr) - 1, address->traddr); 716 return -EINVAL; 717 } 718 memcpy(trid->traddr, address->traddr, len + 1); 719 720 len = strlen(address->trsvcid); 721 if (len > sizeof(trid->trsvcid) - 1) { 722 SPDK_ERRLOG("Transport service id longer than %zu characters: %s\n", 723 sizeof(trid->trsvcid) - 1, address->trsvcid); 724 return -EINVAL; 725 } 726 memcpy(trid->trsvcid, address->trsvcid, len + 1); 727 728 return 0; 729 } 730 731 static void 732 spdk_rpc_nvmf_subsystem_add_listener(struct spdk_jsonrpc_request *request, 733 const struct spdk_json_val *params) 734 { 735 struct nvmf_rpc_listener_ctx *ctx; 736 struct spdk_nvmf_subsystem *subsystem; 737 struct spdk_nvmf_tgt *tgt; 738 739 ctx = calloc(1, sizeof(*ctx)); 740 if (!ctx) { 741 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 742 return; 743 } 744 745 ctx->request = request; 746 747 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 748 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 749 ctx)) { 750 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 751 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 752 nvmf_rpc_listener_ctx_free(ctx); 753 return; 754 } 755 756 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 757 if (!tgt) { 758 SPDK_ERRLOG("Unable to find a target object.\n"); 759 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 760 "Unable to find a target."); 761 nvmf_rpc_listener_ctx_free(ctx); 762 return; 763 } 764 ctx->tgt = tgt; 765 766 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 767 if (!subsystem) { 768 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 769 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 770 nvmf_rpc_listener_ctx_free(ctx); 771 return; 772 } 773 774 ctx->subsystem = subsystem; 775 776 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 777 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 778 "Invalid parameters"); 779 nvmf_rpc_listener_ctx_free(ctx); 780 return; 781 } 782 783 ctx->op = NVMF_RPC_LISTEN_ADD; 784 785 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 786 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 787 nvmf_rpc_listener_ctx_free(ctx); 788 return; 789 } 790 } 791 SPDK_RPC_REGISTER("nvmf_subsystem_add_listener", spdk_rpc_nvmf_subsystem_add_listener, 792 SPDK_RPC_RUNTIME); 793 794 static void 795 spdk_rpc_nvmf_subsystem_remove_listener(struct spdk_jsonrpc_request *request, 796 const struct spdk_json_val *params) 797 { 798 struct nvmf_rpc_listener_ctx *ctx; 799 struct spdk_nvmf_subsystem *subsystem; 800 struct spdk_nvmf_tgt *tgt; 801 802 ctx = calloc(1, sizeof(*ctx)); 803 if (!ctx) { 804 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 805 return; 806 } 807 808 ctx->request = request; 809 810 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 811 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 812 ctx)) { 813 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 814 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 815 nvmf_rpc_listener_ctx_free(ctx); 816 return; 817 } 818 819 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 820 if (!tgt) { 821 SPDK_ERRLOG("Unable to find a target object.\n"); 822 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 823 "Unable to find a target."); 824 nvmf_rpc_listener_ctx_free(ctx); 825 return; 826 } 827 ctx->tgt = tgt; 828 829 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 830 if (!subsystem) { 831 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 832 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 833 nvmf_rpc_listener_ctx_free(ctx); 834 return; 835 } 836 837 ctx->subsystem = subsystem; 838 839 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 840 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 841 "Invalid parameters"); 842 nvmf_rpc_listener_ctx_free(ctx); 843 return; 844 } 845 846 ctx->op = NVMF_RPC_LISTEN_REMOVE; 847 848 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_listen_paused, ctx)) { 849 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 850 nvmf_rpc_listener_ctx_free(ctx); 851 return; 852 } 853 854 } 855 SPDK_RPC_REGISTER("nvmf_subsystem_remove_listener", spdk_rpc_nvmf_subsystem_remove_listener, 856 SPDK_RPC_RUNTIME); 857 858 struct spdk_nvmf_ns_params { 859 char *bdev_name; 860 char *ptpl_file; 861 uint32_t nsid; 862 char nguid[16]; 863 char eui64[8]; 864 struct spdk_uuid uuid; 865 }; 866 867 struct rpc_namespaces { 868 size_t num_ns; 869 struct spdk_nvmf_ns_params ns_params[RPC_MAX_NAMESPACES]; 870 }; 871 872 873 static const struct spdk_json_object_decoder rpc_ns_params_decoders[] = { 874 {"nsid", offsetof(struct spdk_nvmf_ns_params, nsid), spdk_json_decode_uint32, true}, 875 {"bdev_name", offsetof(struct spdk_nvmf_ns_params, bdev_name), spdk_json_decode_string}, 876 {"ptpl_file", offsetof(struct spdk_nvmf_ns_params, ptpl_file), spdk_json_decode_string, true}, 877 {"nguid", offsetof(struct spdk_nvmf_ns_params, nguid), decode_ns_nguid, true}, 878 {"eui64", offsetof(struct spdk_nvmf_ns_params, eui64), decode_ns_eui64, true}, 879 {"uuid", offsetof(struct spdk_nvmf_ns_params, uuid), decode_ns_uuid, true}, 880 }; 881 882 static int 883 decode_rpc_ns_params(const struct spdk_json_val *val, void *out) 884 { 885 struct spdk_nvmf_ns_params *ns_params = out; 886 887 return spdk_json_decode_object(val, rpc_ns_params_decoders, 888 SPDK_COUNTOF(rpc_ns_params_decoders), 889 ns_params); 890 } 891 892 struct nvmf_rpc_ns_ctx { 893 char *nqn; 894 char *tgt_name; 895 struct spdk_nvmf_ns_params ns_params; 896 897 struct spdk_jsonrpc_request *request; 898 bool response_sent; 899 }; 900 901 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ns_decoder[] = { 902 {"nqn", offsetof(struct nvmf_rpc_ns_ctx, nqn), spdk_json_decode_string}, 903 {"namespace", offsetof(struct nvmf_rpc_ns_ctx, ns_params), decode_rpc_ns_params}, 904 {"tgt_name", offsetof(struct nvmf_rpc_ns_ctx, tgt_name), spdk_json_decode_string, true}, 905 }; 906 907 static void 908 nvmf_rpc_ns_ctx_free(struct nvmf_rpc_ns_ctx *ctx) 909 { 910 free(ctx->nqn); 911 free(ctx->tgt_name); 912 free(ctx->ns_params.bdev_name); 913 free(ctx->ns_params.ptpl_file); 914 free(ctx); 915 } 916 917 static void 918 nvmf_rpc_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 919 void *cb_arg, int status) 920 { 921 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 922 struct spdk_jsonrpc_request *request = ctx->request; 923 uint32_t nsid = ctx->ns_params.nsid; 924 bool response_sent = ctx->response_sent; 925 struct spdk_json_write_ctx *w; 926 927 nvmf_rpc_ns_ctx_free(ctx); 928 929 if (response_sent) { 930 return; 931 } 932 933 w = spdk_jsonrpc_begin_result(request); 934 spdk_json_write_uint32(w, nsid); 935 spdk_jsonrpc_end_result(request, w); 936 } 937 938 static void 939 nvmf_rpc_ns_paused(struct spdk_nvmf_subsystem *subsystem, 940 void *cb_arg, int status) 941 { 942 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 943 struct spdk_nvmf_ns_opts ns_opts; 944 struct spdk_bdev *bdev; 945 946 bdev = spdk_bdev_get_by_name(ctx->ns_params.bdev_name); 947 if (!bdev) { 948 SPDK_ERRLOG("No bdev with name %s\n", ctx->ns_params.bdev_name); 949 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 950 "Invalid parameters"); 951 ctx->response_sent = true; 952 goto resume; 953 } 954 955 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 956 ns_opts.nsid = ctx->ns_params.nsid; 957 958 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 959 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 960 961 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 962 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 963 964 if (!spdk_mem_all_zero(&ctx->ns_params.uuid, sizeof(ctx->ns_params.uuid))) { 965 ns_opts.uuid = ctx->ns_params.uuid; 966 } 967 968 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns(subsystem, bdev, &ns_opts, sizeof(ns_opts), 969 ctx->ns_params.ptpl_file); 970 if (ctx->ns_params.nsid == 0) { 971 SPDK_ERRLOG("Unable to add namespace\n"); 972 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 973 "Invalid parameters"); 974 ctx->response_sent = true; 975 goto resume; 976 } 977 978 resume: 979 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 980 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 981 nvmf_rpc_ns_ctx_free(ctx); 982 return; 983 } 984 } 985 986 static void 987 spdk_rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 988 const struct spdk_json_val *params) 989 { 990 struct nvmf_rpc_ns_ctx *ctx; 991 struct spdk_nvmf_subsystem *subsystem; 992 struct spdk_nvmf_tgt *tgt; 993 994 ctx = calloc(1, sizeof(*ctx)); 995 if (!ctx) { 996 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 997 return; 998 } 999 1000 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ns_decoder, 1001 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), 1002 ctx)) { 1003 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1004 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1005 nvmf_rpc_ns_ctx_free(ctx); 1006 return; 1007 } 1008 1009 ctx->request = request; 1010 ctx->response_sent = false; 1011 1012 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1013 if (!tgt) { 1014 SPDK_ERRLOG("Unable to find a target object.\n"); 1015 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1016 "Unable to find a target."); 1017 nvmf_rpc_ns_ctx_free(ctx); 1018 return; 1019 } 1020 1021 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1022 if (!subsystem) { 1023 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1024 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1025 nvmf_rpc_ns_ctx_free(ctx); 1026 return; 1027 } 1028 1029 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_ns_paused, ctx)) { 1030 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1031 nvmf_rpc_ns_ctx_free(ctx); 1032 return; 1033 } 1034 } 1035 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", spdk_rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1036 1037 struct nvmf_rpc_remove_ns_ctx { 1038 char *nqn; 1039 char *tgt_name; 1040 uint32_t nsid; 1041 1042 struct spdk_jsonrpc_request *request; 1043 bool response_sent; 1044 }; 1045 1046 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1047 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1048 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1049 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1050 }; 1051 1052 static void 1053 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1054 { 1055 free(ctx->nqn); 1056 free(ctx->tgt_name); 1057 free(ctx); 1058 } 1059 1060 static void 1061 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1062 void *cb_arg, int status) 1063 { 1064 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1065 struct spdk_jsonrpc_request *request = ctx->request; 1066 bool response_sent = ctx->response_sent; 1067 struct spdk_json_write_ctx *w; 1068 1069 nvmf_rpc_remove_ns_ctx_free(ctx); 1070 1071 if (response_sent) { 1072 return; 1073 } 1074 1075 w = spdk_jsonrpc_begin_result(request); 1076 spdk_json_write_bool(w, true); 1077 spdk_jsonrpc_end_result(request, w); 1078 } 1079 1080 static void 1081 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1082 void *cb_arg, int status) 1083 { 1084 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1085 int ret; 1086 1087 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1088 if (ret < 0) { 1089 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1090 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1091 "Invalid parameters"); 1092 ctx->response_sent = true; 1093 } 1094 1095 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1096 if (!ctx->response_sent) { 1097 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1098 } 1099 nvmf_rpc_remove_ns_ctx_free(ctx); 1100 return; 1101 } 1102 } 1103 1104 static void 1105 spdk_rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1106 const struct spdk_json_val *params) 1107 { 1108 struct nvmf_rpc_remove_ns_ctx *ctx; 1109 struct spdk_nvmf_subsystem *subsystem; 1110 struct spdk_nvmf_tgt *tgt; 1111 1112 ctx = calloc(1, sizeof(*ctx)); 1113 if (!ctx) { 1114 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1115 return; 1116 } 1117 1118 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1119 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1120 ctx)) { 1121 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1122 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1123 nvmf_rpc_remove_ns_ctx_free(ctx); 1124 return; 1125 } 1126 1127 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1128 if (!tgt) { 1129 SPDK_ERRLOG("Unable to find a target object.\n"); 1130 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1131 "Unable to find a target."); 1132 nvmf_rpc_remove_ns_ctx_free(ctx); 1133 return; 1134 } 1135 1136 ctx->request = request; 1137 ctx->response_sent = false; 1138 1139 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1140 if (!subsystem) { 1141 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1142 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1143 nvmf_rpc_remove_ns_ctx_free(ctx); 1144 return; 1145 } 1146 1147 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_remove_ns_paused, ctx)) { 1148 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1149 nvmf_rpc_remove_ns_ctx_free(ctx); 1150 return; 1151 } 1152 } 1153 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", spdk_rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1154 1155 enum nvmf_rpc_host_op { 1156 NVMF_RPC_HOST_ADD, 1157 NVMF_RPC_HOST_REMOVE, 1158 NVMF_RPC_HOST_ALLOW_ANY, 1159 }; 1160 1161 struct nvmf_rpc_host_ctx { 1162 struct spdk_jsonrpc_request *request; 1163 1164 char *nqn; 1165 char *host; 1166 char *tgt_name; 1167 1168 enum nvmf_rpc_host_op op; 1169 1170 bool allow_any_host; 1171 1172 bool response_sent; 1173 }; 1174 1175 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1176 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1177 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1178 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1179 }; 1180 1181 static void 1182 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1183 { 1184 free(ctx->nqn); 1185 free(ctx->host); 1186 free(ctx->tgt_name); 1187 free(ctx); 1188 } 1189 1190 static void 1191 nvmf_rpc_host_resumed(struct spdk_nvmf_subsystem *subsystem, 1192 void *cb_arg, int status) 1193 { 1194 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1195 struct spdk_jsonrpc_request *request; 1196 struct spdk_json_write_ctx *w; 1197 bool response_sent = ctx->response_sent; 1198 1199 request = ctx->request; 1200 nvmf_rpc_host_ctx_free(ctx); 1201 1202 if (response_sent) { 1203 return; 1204 } 1205 1206 w = spdk_jsonrpc_begin_result(request); 1207 spdk_json_write_bool(w, true); 1208 spdk_jsonrpc_end_result(request, w); 1209 } 1210 1211 static void 1212 nvmf_rpc_host_paused(struct spdk_nvmf_subsystem *subsystem, 1213 void *cb_arg, int status) 1214 { 1215 struct nvmf_rpc_host_ctx *ctx = cb_arg; 1216 int rc = -1; 1217 1218 switch (ctx->op) { 1219 case NVMF_RPC_HOST_ADD: 1220 rc = spdk_nvmf_subsystem_add_host(subsystem, ctx->host); 1221 break; 1222 case NVMF_RPC_HOST_REMOVE: 1223 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 1224 break; 1225 case NVMF_RPC_HOST_ALLOW_ANY: 1226 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx->allow_any_host); 1227 break; 1228 } 1229 1230 if (rc != 0) { 1231 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1232 ctx->response_sent = true; 1233 } 1234 1235 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_host_resumed, ctx)) { 1236 if (!ctx->response_sent) { 1237 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1238 } 1239 nvmf_rpc_host_ctx_free(ctx); 1240 return; 1241 } 1242 } 1243 1244 static void 1245 spdk_rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1246 const struct spdk_json_val *params) 1247 { 1248 struct nvmf_rpc_host_ctx *ctx; 1249 struct spdk_nvmf_subsystem *subsystem; 1250 struct spdk_nvmf_tgt *tgt; 1251 1252 ctx = calloc(1, sizeof(*ctx)); 1253 if (!ctx) { 1254 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1255 return; 1256 } 1257 1258 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1259 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1260 ctx)) { 1261 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1262 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1263 nvmf_rpc_host_ctx_free(ctx); 1264 return; 1265 } 1266 1267 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1268 if (!tgt) { 1269 SPDK_ERRLOG("Unable to find a target object.\n"); 1270 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1271 "Unable to find a target."); 1272 nvmf_rpc_host_ctx_free(ctx); 1273 return; 1274 } 1275 1276 ctx->request = request; 1277 ctx->op = NVMF_RPC_HOST_ADD; 1278 ctx->response_sent = false; 1279 1280 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1281 if (!subsystem) { 1282 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1283 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1284 nvmf_rpc_host_ctx_free(ctx); 1285 return; 1286 } 1287 1288 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1289 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1290 nvmf_rpc_host_ctx_free(ctx); 1291 return; 1292 } 1293 } 1294 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", spdk_rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 1295 1296 static void 1297 spdk_rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 1298 const struct spdk_json_val *params) 1299 { 1300 struct nvmf_rpc_host_ctx *ctx; 1301 struct spdk_nvmf_subsystem *subsystem; 1302 struct spdk_nvmf_tgt *tgt; 1303 1304 ctx = calloc(1, sizeof(*ctx)); 1305 if (!ctx) { 1306 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1307 return; 1308 } 1309 1310 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 1311 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1312 ctx)) { 1313 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1314 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1315 nvmf_rpc_host_ctx_free(ctx); 1316 return; 1317 } 1318 1319 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1320 if (!tgt) { 1321 SPDK_ERRLOG("Unable to find a target object.\n"); 1322 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1323 "Unable to find a target."); 1324 nvmf_rpc_host_ctx_free(ctx); 1325 return; 1326 } 1327 1328 ctx->request = request; 1329 ctx->op = NVMF_RPC_HOST_REMOVE; 1330 ctx->response_sent = false; 1331 1332 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1333 if (!subsystem) { 1334 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1335 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1336 nvmf_rpc_host_ctx_free(ctx); 1337 return; 1338 } 1339 1340 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1341 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1342 nvmf_rpc_host_ctx_free(ctx); 1343 return; 1344 } 1345 } 1346 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", spdk_rpc_nvmf_subsystem_remove_host, 1347 SPDK_RPC_RUNTIME) 1348 1349 1350 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 1351 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1352 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 1353 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1354 }; 1355 1356 static void 1357 spdk_rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 1358 const struct spdk_json_val *params) 1359 { 1360 struct nvmf_rpc_host_ctx *ctx; 1361 struct spdk_nvmf_subsystem *subsystem; 1362 struct spdk_nvmf_tgt *tgt; 1363 1364 ctx = calloc(1, sizeof(*ctx)); 1365 if (!ctx) { 1366 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1367 return; 1368 } 1369 1370 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 1371 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 1372 ctx)) { 1373 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1374 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1375 nvmf_rpc_host_ctx_free(ctx); 1376 return; 1377 } 1378 1379 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1380 if (!tgt) { 1381 SPDK_ERRLOG("Unable to find a target object.\n"); 1382 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1383 "Unable to find a target."); 1384 nvmf_rpc_host_ctx_free(ctx); 1385 return; 1386 } 1387 1388 ctx->request = request; 1389 ctx->op = NVMF_RPC_HOST_ALLOW_ANY; 1390 ctx->response_sent = false; 1391 1392 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1393 if (!subsystem) { 1394 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1395 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1396 nvmf_rpc_host_ctx_free(ctx); 1397 return; 1398 } 1399 1400 if (spdk_nvmf_subsystem_pause(subsystem, nvmf_rpc_host_paused, ctx)) { 1401 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1402 nvmf_rpc_host_ctx_free(ctx); 1403 return; 1404 } 1405 } 1406 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", spdk_rpc_nvmf_subsystem_allow_any_host, 1407 SPDK_RPC_RUNTIME) 1408 1409 struct nvmf_rpc_target_ctx { 1410 char *name; 1411 uint32_t max_subsystems; 1412 }; 1413 1414 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 1415 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1416 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 1417 }; 1418 1419 static void 1420 spdk_rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 1421 const struct spdk_json_val *params) 1422 { 1423 struct spdk_nvmf_target_opts opts; 1424 struct nvmf_rpc_target_ctx ctx = {0}; 1425 struct spdk_nvmf_tgt *tgt; 1426 struct spdk_json_write_ctx *w; 1427 1428 /* Decode parameters the first time to get the transport type */ 1429 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 1430 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 1431 &ctx)) { 1432 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1433 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1434 free(ctx.name); 1435 return; 1436 } 1437 1438 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 1439 opts.max_subsystems = ctx.max_subsystems; 1440 1441 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 1442 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1443 "Target already exists."); 1444 free(ctx.name); 1445 return; 1446 } 1447 1448 tgt = spdk_nvmf_tgt_create(&opts); 1449 1450 if (tgt == NULL) { 1451 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1452 "Unable to create the requested target."); 1453 free(ctx.name); 1454 return; 1455 } 1456 1457 w = spdk_jsonrpc_begin_result(request); 1458 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 1459 spdk_jsonrpc_end_result(request, w); 1460 free(ctx.name); 1461 } 1462 SPDK_RPC_REGISTER("nvmf_create_target", spdk_rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 1463 1464 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 1465 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 1466 }; 1467 1468 static void 1469 nvmf_rpc_destroy_target_done(void *ctx, int status) 1470 { 1471 struct spdk_jsonrpc_request *request = ctx; 1472 struct spdk_json_write_ctx *w; 1473 1474 w = spdk_jsonrpc_begin_result(request); 1475 spdk_json_write_bool(w, true); 1476 spdk_jsonrpc_end_result(request, w); 1477 } 1478 1479 static void 1480 spdk_rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 1481 const struct spdk_json_val *params) 1482 { 1483 struct nvmf_rpc_target_ctx ctx = {0}; 1484 struct spdk_nvmf_tgt *tgt; 1485 1486 /* Decode parameters the first time to get the transport type */ 1487 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 1488 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 1489 &ctx)) { 1490 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1491 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1492 free(ctx.name); 1493 return; 1494 } 1495 1496 tgt = spdk_nvmf_get_tgt(ctx.name); 1497 1498 if (tgt == NULL) { 1499 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1500 "The specified target doesn't exist, cannot delete it."); 1501 free(ctx.name); 1502 return; 1503 } 1504 1505 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 1506 free(ctx.name); 1507 } 1508 SPDK_RPC_REGISTER("nvmf_delete_target", spdk_rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 1509 1510 static void 1511 spdk_rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 1512 const struct spdk_json_val *params) 1513 { 1514 struct spdk_json_write_ctx *w; 1515 struct spdk_nvmf_tgt *tgt; 1516 const char *name; 1517 1518 if (params != NULL) { 1519 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1520 "nvmf_get_targets has no parameters."); 1521 return; 1522 } 1523 1524 w = spdk_jsonrpc_begin_result(request); 1525 spdk_json_write_array_begin(w); 1526 1527 tgt = spdk_nvmf_get_first_tgt(); 1528 1529 while (tgt != NULL) { 1530 name = spdk_nvmf_tgt_get_name(tgt); 1531 spdk_json_write_string(w, name); 1532 tgt = spdk_nvmf_get_next_tgt(tgt); 1533 } 1534 1535 spdk_json_write_array_end(w); 1536 spdk_jsonrpc_end_result(request, w); 1537 } 1538 SPDK_RPC_REGISTER("nvmf_get_targets", spdk_rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 1539 1540 struct nvmf_rpc_create_transport_ctx { 1541 char *trtype; 1542 char *tgt_name; 1543 struct spdk_nvmf_transport_opts opts; 1544 struct spdk_jsonrpc_request *request; 1545 }; 1546 1547 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 1548 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 1549 { 1550 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 1551 spdk_json_decode_uint16, true 1552 }, 1553 { 1554 "max_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 1555 spdk_json_decode_uint16, true 1556 }, 1557 { 1558 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 1559 spdk_json_decode_uint32, true 1560 }, 1561 { 1562 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 1563 spdk_json_decode_uint32, true 1564 }, 1565 { 1566 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 1567 spdk_json_decode_uint32, true 1568 }, 1569 { 1570 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 1571 spdk_json_decode_uint32, true 1572 }, 1573 { 1574 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 1575 spdk_json_decode_uint32, true 1576 }, 1577 { 1578 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 1579 spdk_json_decode_uint32, true 1580 }, 1581 { 1582 "max_srq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_srq_depth), 1583 spdk_json_decode_uint32, true 1584 }, 1585 { 1586 "no_srq", offsetof(struct nvmf_rpc_create_transport_ctx, opts.no_srq), 1587 spdk_json_decode_bool, true 1588 }, 1589 { 1590 "c2h_success", offsetof(struct nvmf_rpc_create_transport_ctx, opts.c2h_success), 1591 spdk_json_decode_bool, true 1592 }, 1593 { 1594 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 1595 spdk_json_decode_bool, true 1596 }, 1597 { 1598 "sock_priority", offsetof(struct nvmf_rpc_create_transport_ctx, opts.sock_priority), 1599 spdk_json_decode_uint32, true 1600 }, 1601 { 1602 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 1603 spdk_json_decode_string, true 1604 }, 1605 }; 1606 1607 static void 1608 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 1609 { 1610 free(ctx->trtype); 1611 free(ctx->tgt_name); 1612 free(ctx); 1613 } 1614 1615 static void 1616 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 1617 { 1618 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 1619 struct spdk_jsonrpc_request *request; 1620 struct spdk_json_write_ctx *w; 1621 1622 request = ctx->request; 1623 nvmf_rpc_create_transport_ctx_free(ctx); 1624 1625 if (status) { 1626 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 1627 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1628 "Failed to add transport to tgt.(%d)\n", 1629 status); 1630 return; 1631 } 1632 1633 w = spdk_jsonrpc_begin_result(request); 1634 spdk_json_write_bool(w, true); 1635 spdk_jsonrpc_end_result(request, w); 1636 } 1637 1638 static void 1639 spdk_rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 1640 const struct spdk_json_val *params) 1641 { 1642 struct nvmf_rpc_create_transport_ctx *ctx; 1643 enum spdk_nvme_transport_type trtype; 1644 struct spdk_nvmf_transport *transport; 1645 struct spdk_nvmf_tgt *tgt; 1646 1647 ctx = calloc(1, sizeof(*ctx)); 1648 if (!ctx) { 1649 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1650 return; 1651 } 1652 1653 /* Decode parameters the first time to get the transport type */ 1654 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 1655 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1656 ctx)) { 1657 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1658 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1659 nvmf_rpc_create_transport_ctx_free(ctx); 1660 return; 1661 } 1662 1663 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1664 if (!tgt) { 1665 SPDK_ERRLOG("Unable to find a target object.\n"); 1666 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1667 "Unable to find a target."); 1668 nvmf_rpc_create_transport_ctx_free(ctx); 1669 return; 1670 } 1671 1672 if (spdk_nvme_transport_id_parse_trtype(&trtype, ctx->trtype)) { 1673 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1674 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1675 "Invalid transport type '%s'\n", ctx->trtype); 1676 nvmf_rpc_create_transport_ctx_free(ctx); 1677 return; 1678 } 1679 1680 /* Initialize all the transport options (based on transport type) and decode the 1681 * parameters again to update any options passed in rpc create transport call. 1682 */ 1683 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts)) { 1684 /* This can happen if user specifies PCIE transport type which isn't valid for 1685 * NVMe-oF. 1686 */ 1687 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 1688 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1689 "Invalid transport type '%s'\n", ctx->trtype); 1690 nvmf_rpc_create_transport_ctx_free(ctx); 1691 return; 1692 } 1693 1694 if (spdk_json_decode_object(params, nvmf_rpc_create_transport_decoder, 1695 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 1696 ctx)) { 1697 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1698 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1699 nvmf_rpc_create_transport_ctx_free(ctx); 1700 return; 1701 } 1702 1703 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 1704 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 1705 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1706 "Transport type '%s' already exists\n", ctx->trtype); 1707 nvmf_rpc_create_transport_ctx_free(ctx); 1708 return; 1709 } 1710 1711 transport = spdk_nvmf_transport_create(ctx->trtype, &ctx->opts); 1712 1713 if (!transport) { 1714 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 1715 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1716 "Transport type '%s' create failed\n", ctx->trtype); 1717 nvmf_rpc_create_transport_ctx_free(ctx); 1718 return; 1719 } 1720 1721 /* add transport to target */ 1722 ctx->request = request; 1723 spdk_nvmf_tgt_add_transport(tgt, transport, nvmf_rpc_tgt_add_transport_done, ctx); 1724 } 1725 SPDK_RPC_REGISTER("nvmf_create_transport", spdk_rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 1726 1727 static void 1728 dump_nvmf_transport(struct spdk_json_write_ctx *w, struct spdk_nvmf_transport *transport) 1729 { 1730 const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport); 1731 spdk_nvme_transport_type_t type = spdk_nvmf_get_transport_type(transport); 1732 1733 spdk_json_write_object_begin(w); 1734 1735 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport)); 1736 spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth); 1737 spdk_json_write_named_uint32(w, "max_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr); 1738 spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size); 1739 spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size); 1740 spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size); 1741 spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth); 1742 spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers); 1743 spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size); 1744 spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip); 1745 if (type == SPDK_NVME_TRANSPORT_RDMA) { 1746 spdk_json_write_named_uint32(w, "max_srq_depth", opts->max_srq_depth); 1747 spdk_json_write_named_bool(w, "no_srq", opts->no_srq); 1748 } else if (type == SPDK_NVME_TRANSPORT_TCP) { 1749 spdk_json_write_named_bool(w, "c2h_success", opts->c2h_success); 1750 spdk_json_write_named_uint32(w, "sock_priority", opts->sock_priority); 1751 } 1752 1753 spdk_json_write_object_end(w); 1754 } 1755 1756 struct rpc_get_transport { 1757 char *tgt_name; 1758 }; 1759 1760 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 1761 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 1762 }; 1763 1764 static void 1765 spdk_rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 1766 const struct spdk_json_val *params) 1767 { 1768 struct rpc_get_transport req = { 0 }; 1769 struct spdk_json_write_ctx *w; 1770 struct spdk_nvmf_transport *transport; 1771 struct spdk_nvmf_tgt *tgt; 1772 1773 if (params) { 1774 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 1775 SPDK_COUNTOF(rpc_get_transport_decoders), 1776 &req)) { 1777 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1778 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1779 return; 1780 } 1781 } 1782 1783 tgt = spdk_nvmf_get_tgt(req.tgt_name); 1784 if (!tgt) { 1785 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1786 "Unable to find a target."); 1787 free(req.tgt_name); 1788 return; 1789 } 1790 1791 w = spdk_jsonrpc_begin_result(request); 1792 spdk_json_write_array_begin(w); 1793 transport = spdk_nvmf_transport_get_first(tgt); 1794 while (transport) { 1795 dump_nvmf_transport(w, transport); 1796 transport = spdk_nvmf_transport_get_next(transport); 1797 } 1798 spdk_json_write_array_end(w); 1799 spdk_jsonrpc_end_result(request, w); 1800 free(req.tgt_name); 1801 } 1802 SPDK_RPC_REGISTER("nvmf_get_transports", spdk_rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 1803 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nvmf_get_transports, get_nvmf_transports) 1804 1805 struct rpc_nvmf_get_stats_ctx { 1806 char *tgt_name; 1807 struct spdk_nvmf_tgt *tgt; 1808 struct spdk_jsonrpc_request *request; 1809 struct spdk_json_write_ctx *w; 1810 }; 1811 1812 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 1813 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 1814 }; 1815 1816 static void 1817 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 1818 { 1819 free(ctx->tgt_name); 1820 free(ctx); 1821 } 1822 1823 static void 1824 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 1825 { 1826 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1827 1828 spdk_json_write_array_end(ctx->w); 1829 spdk_json_write_object_end(ctx->w); 1830 spdk_jsonrpc_end_result(ctx->request, ctx->w); 1831 free_get_stats_ctx(ctx); 1832 } 1833 1834 static void 1835 write_nvmf_transport_stats(struct spdk_json_write_ctx *w, 1836 struct spdk_nvmf_transport_poll_group_stat *stat) 1837 { 1838 uint64_t i; 1839 1840 spdk_json_write_object_begin(w); 1841 spdk_json_write_named_string(w, "trtype", 1842 spdk_nvme_transport_id_trtype_str(stat->trtype)); 1843 switch (stat->trtype) { 1844 case SPDK_NVME_TRANSPORT_RDMA: 1845 spdk_json_write_named_uint64(w, "pending_data_buffer", stat->rdma.pending_data_buffer); 1846 spdk_json_write_named_array_begin(w, "devices"); 1847 for (i = 0; i < stat->rdma.num_devices; ++i) { 1848 spdk_json_write_object_begin(w); 1849 spdk_json_write_named_string(w, "name", stat->rdma.devices[i].name); 1850 spdk_json_write_named_uint64(w, "polls", stat->rdma.devices[i].polls); 1851 spdk_json_write_named_uint64(w, "completions", stat->rdma.devices[i].completions); 1852 spdk_json_write_named_uint64(w, "requests", 1853 stat->rdma.devices[i].requests); 1854 spdk_json_write_named_uint64(w, "request_latency", 1855 stat->rdma.devices[i].request_latency); 1856 spdk_json_write_named_uint64(w, "pending_free_request", 1857 stat->rdma.devices[i].pending_free_request); 1858 spdk_json_write_named_uint64(w, "pending_rdma_read", 1859 stat->rdma.devices[i].pending_rdma_read); 1860 spdk_json_write_named_uint64(w, "pending_rdma_write", 1861 stat->rdma.devices[i].pending_rdma_write); 1862 spdk_json_write_object_end(w); 1863 } 1864 spdk_json_write_array_end(w); 1865 break; 1866 default: 1867 break; 1868 } 1869 spdk_json_write_object_end(w); 1870 } 1871 1872 static void 1873 rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 1874 { 1875 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1876 struct spdk_nvmf_transport *transport; 1877 struct spdk_nvmf_poll_group_stat stat; 1878 struct spdk_nvmf_transport_poll_group_stat *trstat; 1879 int rc; 1880 1881 if (0 == spdk_nvmf_poll_group_get_stat(ctx->tgt, &stat)) { 1882 spdk_json_write_object_begin(ctx->w); 1883 spdk_json_write_named_string(ctx->w, "name", spdk_thread_get_name(spdk_get_thread())); 1884 spdk_json_write_named_uint32(ctx->w, "admin_qpairs", stat.admin_qpairs); 1885 spdk_json_write_named_uint32(ctx->w, "io_qpairs", stat.io_qpairs); 1886 spdk_json_write_named_uint64(ctx->w, "pending_bdev_io", stat.pending_bdev_io); 1887 1888 spdk_json_write_named_array_begin(ctx->w, "transports"); 1889 transport = spdk_nvmf_transport_get_first(ctx->tgt); 1890 while (transport) { 1891 rc = spdk_nvmf_transport_poll_group_get_stat(ctx->tgt, transport, &trstat); 1892 if (0 == rc) { 1893 write_nvmf_transport_stats(ctx->w, trstat); 1894 spdk_nvmf_transport_poll_group_free_stat(transport, trstat); 1895 } else if (-ENOTSUP != rc) { 1896 SPDK_ERRLOG("Failed to get poll group statistics for transport %s, errno %d\n", 1897 spdk_nvme_transport_id_trtype_str(spdk_nvmf_get_transport_type(transport)), 1898 rc); 1899 } 1900 transport = spdk_nvmf_transport_get_next(transport); 1901 } 1902 spdk_json_write_array_end(ctx->w); 1903 spdk_json_write_object_end(ctx->w); 1904 } 1905 1906 spdk_for_each_channel_continue(i, 0); 1907 } 1908 1909 1910 static void 1911 spdk_rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 1912 const struct spdk_json_val *params) 1913 { 1914 struct rpc_nvmf_get_stats_ctx *ctx; 1915 1916 ctx = calloc(1, sizeof(*ctx)); 1917 if (!ctx) { 1918 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1919 "Memory allocation error"); 1920 return; 1921 } 1922 ctx->request = request; 1923 1924 if (params) { 1925 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 1926 SPDK_COUNTOF(rpc_get_stats_decoders), 1927 ctx)) { 1928 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1929 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1930 free_get_stats_ctx(ctx); 1931 return; 1932 } 1933 } 1934 1935 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1936 if (!ctx->tgt) { 1937 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1938 "Unable to find a target."); 1939 free_get_stats_ctx(ctx); 1940 return; 1941 } 1942 1943 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 1944 if (NULL == ctx->w) { 1945 free_get_stats_ctx(ctx); 1946 return; 1947 } 1948 1949 spdk_json_write_object_begin(ctx->w); 1950 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 1951 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 1952 1953 spdk_for_each_channel(ctx->tgt, 1954 rpc_nvmf_get_stats, 1955 ctx, 1956 rpc_nvmf_get_stats_done); 1957 } 1958 1959 SPDK_RPC_REGISTER("nvmf_get_stats", spdk_rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 1960