1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2016 Intel Corporation. All rights reserved. 3 * Copyright (c) 2018-2021 Mellanox Technologies LTD. All rights reserved. 4 * Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 5 */ 6 7 #include "spdk/bdev.h" 8 #include "spdk/log.h" 9 #include "spdk/rpc.h" 10 #include "spdk/env.h" 11 #include "spdk/nvme.h" 12 #include "spdk/nvmf.h" 13 #include "spdk/string.h" 14 #include "spdk/util.h" 15 #include "spdk/bit_array.h" 16 #include "spdk/config.h" 17 18 #include "spdk_internal/assert.h" 19 20 #include "nvmf_internal.h" 21 22 static int rpc_ana_state_parse(const char *str, enum spdk_nvme_ana_state *ana_state); 23 24 static int 25 json_write_hex_str(struct spdk_json_write_ctx *w, const void *data, size_t size) 26 { 27 static const char hex_char[16] = "0123456789ABCDEF"; 28 const uint8_t *buf = data; 29 char *str, *out; 30 int rc; 31 32 str = malloc(size * 2 + 1); 33 if (str == NULL) { 34 return -1; 35 } 36 37 out = str; 38 while (size--) { 39 unsigned byte = *buf++; 40 41 out[0] = hex_char[(byte >> 4) & 0xF]; 42 out[1] = hex_char[byte & 0xF]; 43 44 out += 2; 45 } 46 *out = '\0'; 47 48 rc = spdk_json_write_string(w, str); 49 free(str); 50 51 return rc; 52 } 53 54 static int 55 hex_nybble_to_num(char c) 56 { 57 if (c >= '0' && c <= '9') { 58 return c - '0'; 59 } 60 61 if (c >= 'a' && c <= 'f') { 62 return c - 'a' + 0xA; 63 } 64 65 if (c >= 'A' && c <= 'F') { 66 return c - 'A' + 0xA; 67 } 68 69 return -1; 70 } 71 72 static int 73 hex_byte_to_num(const char *str) 74 { 75 int hi, lo; 76 77 hi = hex_nybble_to_num(str[0]); 78 if (hi < 0) { 79 return hi; 80 } 81 82 lo = hex_nybble_to_num(str[1]); 83 if (lo < 0) { 84 return lo; 85 } 86 87 return hi * 16 + lo; 88 } 89 90 static int 91 decode_hex_string_be(const char *str, uint8_t *out, size_t size) 92 { 93 size_t i; 94 95 /* Decode a string in "ABCDEF012345" format to its binary representation */ 96 for (i = 0; i < size; i++) { 97 int num = hex_byte_to_num(str); 98 99 if (num < 0) { 100 /* Invalid hex byte or end of string */ 101 return -1; 102 } 103 104 out[i] = (uint8_t)num; 105 str += 2; 106 } 107 108 if (i != size || *str != '\0') { 109 /* Length mismatch */ 110 return -1; 111 } 112 113 return 0; 114 } 115 116 static int 117 decode_ns_nguid(const struct spdk_json_val *val, void *out) 118 { 119 char *str = NULL; 120 int rc; 121 122 rc = spdk_json_decode_string(val, &str); 123 if (rc == 0) { 124 /* 16-byte NGUID */ 125 rc = decode_hex_string_be(str, out, 16); 126 } 127 128 free(str); 129 return rc; 130 } 131 132 static int 133 decode_ns_eui64(const struct spdk_json_val *val, void *out) 134 { 135 char *str = NULL; 136 int rc; 137 138 rc = spdk_json_decode_string(val, &str); 139 if (rc == 0) { 140 /* 8-byte EUI-64 */ 141 rc = decode_hex_string_be(str, out, 8); 142 } 143 144 free(str); 145 return rc; 146 } 147 148 struct rpc_get_subsystem { 149 char *nqn; 150 char *tgt_name; 151 }; 152 153 static const struct spdk_json_object_decoder rpc_get_subsystem_decoders[] = { 154 {"nqn", offsetof(struct rpc_get_subsystem, nqn), spdk_json_decode_string, true}, 155 {"tgt_name", offsetof(struct rpc_get_subsystem, tgt_name), spdk_json_decode_string, true}, 156 }; 157 158 static void 159 dump_nvmf_subsystem(struct spdk_json_write_ctx *w, struct spdk_nvmf_subsystem *subsystem) 160 { 161 struct spdk_nvmf_host *host; 162 struct spdk_nvmf_subsystem_listener *listener; 163 164 spdk_json_write_object_begin(w); 165 166 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 167 spdk_json_write_name(w, "subtype"); 168 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 169 spdk_json_write_string(w, "NVMe"); 170 } else { 171 spdk_json_write_string(w, "Discovery"); 172 } 173 174 spdk_json_write_named_array_begin(w, "listen_addresses"); 175 176 for (listener = spdk_nvmf_subsystem_get_first_listener(subsystem); listener != NULL; 177 listener = spdk_nvmf_subsystem_get_next_listener(subsystem, listener)) { 178 const struct spdk_nvme_transport_id *trid; 179 180 trid = spdk_nvmf_subsystem_listener_get_trid(listener); 181 182 spdk_json_write_object_begin(w); 183 nvmf_transport_listen_dump_trid(trid, w); 184 spdk_json_write_object_end(w); 185 } 186 spdk_json_write_array_end(w); 187 188 spdk_json_write_named_bool(w, "allow_any_host", 189 spdk_nvmf_subsystem_get_allow_any_host(subsystem)); 190 191 spdk_json_write_named_array_begin(w, "hosts"); 192 193 for (host = spdk_nvmf_subsystem_get_first_host(subsystem); host != NULL; 194 host = spdk_nvmf_subsystem_get_next_host(subsystem, host)) { 195 spdk_json_write_object_begin(w); 196 spdk_json_write_named_string(w, "nqn", spdk_nvmf_host_get_nqn(host)); 197 if (host->dhchap_key != NULL) { 198 spdk_json_write_named_string(w, "dhchap_key", 199 spdk_key_get_name(host->dhchap_key)); 200 } 201 if (host->dhchap_ctrlr_key != NULL) { 202 spdk_json_write_named_string(w, "dhchap_ctrlr_key", 203 spdk_key_get_name(host->dhchap_ctrlr_key)); 204 } 205 spdk_json_write_object_end(w); 206 } 207 spdk_json_write_array_end(w); 208 209 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 210 struct spdk_nvmf_ns *ns; 211 struct spdk_nvmf_ns_opts ns_opts; 212 uint32_t max_namespaces; 213 214 spdk_json_write_named_string(w, "serial_number", spdk_nvmf_subsystem_get_sn(subsystem)); 215 216 spdk_json_write_named_string(w, "model_number", spdk_nvmf_subsystem_get_mn(subsystem)); 217 218 max_namespaces = spdk_nvmf_subsystem_get_max_namespaces(subsystem); 219 if (max_namespaces != 0) { 220 spdk_json_write_named_uint32(w, "max_namespaces", max_namespaces); 221 } 222 223 spdk_json_write_named_uint32(w, "min_cntlid", spdk_nvmf_subsystem_get_min_cntlid(subsystem)); 224 spdk_json_write_named_uint32(w, "max_cntlid", spdk_nvmf_subsystem_get_max_cntlid(subsystem)); 225 226 spdk_json_write_named_array_begin(w, "namespaces"); 227 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 228 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 229 spdk_nvmf_ns_get_opts(ns, &ns_opts, sizeof(ns_opts)); 230 spdk_json_write_object_begin(w); 231 spdk_json_write_named_int32(w, "nsid", spdk_nvmf_ns_get_id(ns)); 232 spdk_json_write_named_string(w, "bdev_name", 233 spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 234 /* NOTE: "name" is kept for compatibility only - new code should use bdev_name. */ 235 spdk_json_write_named_string(w, "name", 236 spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 237 238 if (!spdk_mem_all_zero(ns_opts.nguid, sizeof(ns_opts.nguid))) { 239 spdk_json_write_name(w, "nguid"); 240 json_write_hex_str(w, ns_opts.nguid, sizeof(ns_opts.nguid)); 241 } 242 243 if (!spdk_mem_all_zero(ns_opts.eui64, sizeof(ns_opts.eui64))) { 244 spdk_json_write_name(w, "eui64"); 245 json_write_hex_str(w, ns_opts.eui64, sizeof(ns_opts.eui64)); 246 } 247 248 if (!spdk_uuid_is_null(&ns_opts.uuid)) { 249 spdk_json_write_named_uuid(w, "uuid", &ns_opts.uuid); 250 } 251 252 if (spdk_nvmf_subsystem_get_ana_reporting(subsystem)) { 253 spdk_json_write_named_uint32(w, "anagrpid", ns_opts.anagrpid); 254 } 255 256 spdk_json_write_object_end(w); 257 } 258 spdk_json_write_array_end(w); 259 } 260 spdk_json_write_object_end(w); 261 } 262 263 static void 264 rpc_nvmf_get_subsystems(struct spdk_jsonrpc_request *request, 265 const struct spdk_json_val *params) 266 { 267 struct rpc_get_subsystem req = { 0 }; 268 struct spdk_json_write_ctx *w; 269 struct spdk_nvmf_subsystem *subsystem = NULL; 270 struct spdk_nvmf_tgt *tgt; 271 272 if (params) { 273 if (spdk_json_decode_object(params, rpc_get_subsystem_decoders, 274 SPDK_COUNTOF(rpc_get_subsystem_decoders), 275 &req)) { 276 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 277 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 278 return; 279 } 280 } 281 282 tgt = spdk_nvmf_get_tgt(req.tgt_name); 283 if (!tgt) { 284 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 285 "Unable to find a target."); 286 free(req.tgt_name); 287 free(req.nqn); 288 return; 289 } 290 291 if (req.nqn) { 292 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, req.nqn); 293 if (!subsystem) { 294 SPDK_ERRLOG("subsystem '%s' does not exist\n", req.nqn); 295 spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV)); 296 free(req.tgt_name); 297 free(req.nqn); 298 return; 299 } 300 } 301 302 w = spdk_jsonrpc_begin_result(request); 303 spdk_json_write_array_begin(w); 304 305 if (subsystem) { 306 dump_nvmf_subsystem(w, subsystem); 307 } else { 308 for (subsystem = spdk_nvmf_subsystem_get_first(tgt); subsystem != NULL; 309 subsystem = spdk_nvmf_subsystem_get_next(subsystem)) { 310 dump_nvmf_subsystem(w, subsystem); 311 } 312 } 313 314 spdk_json_write_array_end(w); 315 spdk_jsonrpc_end_result(request, w); 316 free(req.tgt_name); 317 free(req.nqn); 318 } 319 SPDK_RPC_REGISTER("nvmf_get_subsystems", rpc_nvmf_get_subsystems, SPDK_RPC_RUNTIME) 320 321 struct rpc_subsystem_create { 322 char *nqn; 323 char *serial_number; 324 char *model_number; 325 char *tgt_name; 326 uint32_t max_namespaces; 327 bool allow_any_host; 328 bool ana_reporting; 329 uint16_t min_cntlid; 330 uint16_t max_cntlid; 331 uint64_t max_discard_size_kib; 332 uint64_t max_write_zeroes_size_kib; 333 bool passthrough; 334 }; 335 336 static const struct spdk_json_object_decoder rpc_subsystem_create_decoders[] = { 337 {"nqn", offsetof(struct rpc_subsystem_create, nqn), spdk_json_decode_string}, 338 {"serial_number", offsetof(struct rpc_subsystem_create, serial_number), spdk_json_decode_string, true}, 339 {"model_number", offsetof(struct rpc_subsystem_create, model_number), spdk_json_decode_string, true}, 340 {"tgt_name", offsetof(struct rpc_subsystem_create, tgt_name), spdk_json_decode_string, true}, 341 {"max_namespaces", offsetof(struct rpc_subsystem_create, max_namespaces), spdk_json_decode_uint32, true}, 342 {"allow_any_host", offsetof(struct rpc_subsystem_create, allow_any_host), spdk_json_decode_bool, true}, 343 {"ana_reporting", offsetof(struct rpc_subsystem_create, ana_reporting), spdk_json_decode_bool, true}, 344 {"min_cntlid", offsetof(struct rpc_subsystem_create, min_cntlid), spdk_json_decode_uint16, true}, 345 {"max_cntlid", offsetof(struct rpc_subsystem_create, max_cntlid), spdk_json_decode_uint16, true}, 346 {"max_discard_size_kib", offsetof(struct rpc_subsystem_create, max_discard_size_kib), spdk_json_decode_uint64, true}, 347 {"max_write_zeroes_size_kib", offsetof(struct rpc_subsystem_create, max_write_zeroes_size_kib), spdk_json_decode_uint64, true}, 348 {"passthrough", offsetof(struct rpc_subsystem_create, passthrough), spdk_json_decode_bool, true}, 349 }; 350 351 static void 352 rpc_nvmf_subsystem_started(struct spdk_nvmf_subsystem *subsystem, 353 void *cb_arg, int status) 354 { 355 struct spdk_jsonrpc_request *request = cb_arg; 356 357 if (!status) { 358 spdk_jsonrpc_send_bool_response(request, true); 359 } else { 360 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 361 "Subsystem %s start failed", 362 subsystem->subnqn); 363 spdk_nvmf_subsystem_destroy(subsystem, NULL, NULL); 364 } 365 } 366 367 static void 368 rpc_nvmf_create_subsystem(struct spdk_jsonrpc_request *request, 369 const struct spdk_json_val *params) 370 { 371 struct rpc_subsystem_create *req; 372 struct spdk_nvmf_subsystem *subsystem = NULL; 373 struct spdk_nvmf_tgt *tgt; 374 int rc = -1; 375 376 req = calloc(1, sizeof(*req)); 377 if (!req) { 378 SPDK_ERRLOG("Memory allocation failed\n"); 379 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 380 "Memory allocation failed"); 381 return; 382 } 383 req->min_cntlid = NVMF_MIN_CNTLID; 384 req->max_cntlid = NVMF_MAX_CNTLID; 385 386 if (spdk_json_decode_object(params, rpc_subsystem_create_decoders, 387 SPDK_COUNTOF(rpc_subsystem_create_decoders), 388 req)) { 389 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 390 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 391 goto cleanup; 392 } 393 394 tgt = spdk_nvmf_get_tgt(req->tgt_name); 395 if (!tgt) { 396 SPDK_ERRLOG("Unable to find target %s\n", req->tgt_name); 397 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 398 "Unable to find target %s", req->tgt_name); 399 goto cleanup; 400 } 401 402 subsystem = spdk_nvmf_subsystem_create(tgt, req->nqn, SPDK_NVMF_SUBTYPE_NVME, 403 req->max_namespaces); 404 if (!subsystem) { 405 SPDK_ERRLOG("Unable to create subsystem %s\n", req->nqn); 406 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 407 "Unable to create subsystem %s", req->nqn); 408 goto cleanup; 409 } 410 411 if (req->serial_number) { 412 if (spdk_nvmf_subsystem_set_sn(subsystem, req->serial_number)) { 413 SPDK_ERRLOG("Subsystem %s: invalid serial number '%s'\n", req->nqn, req->serial_number); 414 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 415 "Invalid SN %s", req->serial_number); 416 goto cleanup; 417 } 418 } 419 420 if (req->model_number) { 421 if (spdk_nvmf_subsystem_set_mn(subsystem, req->model_number)) { 422 SPDK_ERRLOG("Subsystem %s: invalid model number '%s'\n", req->nqn, req->model_number); 423 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 424 "Invalid MN %s", req->model_number); 425 goto cleanup; 426 } 427 } 428 429 spdk_nvmf_subsystem_set_allow_any_host(subsystem, req->allow_any_host); 430 431 spdk_nvmf_subsystem_set_ana_reporting(subsystem, req->ana_reporting); 432 433 if (spdk_nvmf_subsystem_set_cntlid_range(subsystem, req->min_cntlid, req->max_cntlid)) { 434 SPDK_ERRLOG("Subsystem %s: invalid cntlid range [%u-%u]\n", req->nqn, req->min_cntlid, 435 req->max_cntlid); 436 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 437 "Invalid cntlid range [%u-%u]", req->min_cntlid, req->max_cntlid); 438 goto cleanup; 439 } 440 441 subsystem->max_discard_size_kib = req->max_discard_size_kib; 442 443 /* max_write_zeroes_size_kib must be aligned to 4 and power of 2 */ 444 if (req->max_write_zeroes_size_kib == 0 || (req->max_write_zeroes_size_kib > 2 && 445 spdk_u64_is_pow2(req->max_write_zeroes_size_kib))) { 446 subsystem->max_write_zeroes_size_kib = req->max_write_zeroes_size_kib; 447 } else { 448 SPDK_ERRLOG("Subsystem %s: invalid max_write_zeroes_size_kib %"PRIu64"\n", req->nqn, 449 req->max_write_zeroes_size_kib); 450 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 451 "Invalid max_write_zeroes_size_kib %"PRIu64, req->max_write_zeroes_size_kib); 452 goto cleanup; 453 } 454 455 subsystem->passthrough = req->passthrough; 456 457 rc = spdk_nvmf_subsystem_start(subsystem, 458 rpc_nvmf_subsystem_started, 459 request); 460 if (rc) { 461 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 462 "Failed to start subsystem"); 463 } 464 465 cleanup: 466 free(req->nqn); 467 free(req->tgt_name); 468 free(req->serial_number); 469 free(req->model_number); 470 free(req); 471 472 if (rc && subsystem) { 473 spdk_nvmf_subsystem_destroy(subsystem, NULL, NULL); 474 } 475 } 476 SPDK_RPC_REGISTER("nvmf_create_subsystem", rpc_nvmf_create_subsystem, SPDK_RPC_RUNTIME) 477 478 struct rpc_delete_subsystem { 479 char *nqn; 480 char *tgt_name; 481 }; 482 483 static void 484 free_rpc_delete_subsystem(struct rpc_delete_subsystem *r) 485 { 486 free(r->nqn); 487 free(r->tgt_name); 488 } 489 490 static void 491 rpc_nvmf_subsystem_destroy_complete_cb(void *cb_arg) 492 { 493 struct spdk_jsonrpc_request *request = cb_arg; 494 495 spdk_jsonrpc_send_bool_response(request, true); 496 } 497 498 static void 499 rpc_nvmf_subsystem_stopped(struct spdk_nvmf_subsystem *subsystem, 500 void *cb_arg, int status) 501 { 502 struct spdk_jsonrpc_request *request = cb_arg; 503 int rc; 504 505 nvmf_subsystem_remove_all_listeners(subsystem, true); 506 rc = spdk_nvmf_subsystem_destroy(subsystem, rpc_nvmf_subsystem_destroy_complete_cb, request); 507 if (rc) { 508 if (rc == -EINPROGRESS) { 509 /* response will be sent in completion callback */ 510 return; 511 } else { 512 SPDK_ERRLOG("Subsystem destruction failed, rc %d\n", rc); 513 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 514 "Subsystem destruction failed, rc %d", rc); 515 return; 516 } 517 } 518 spdk_jsonrpc_send_bool_response(request, true); 519 } 520 521 static const struct spdk_json_object_decoder rpc_delete_subsystem_decoders[] = { 522 {"nqn", offsetof(struct rpc_delete_subsystem, nqn), spdk_json_decode_string}, 523 {"tgt_name", offsetof(struct rpc_delete_subsystem, tgt_name), spdk_json_decode_string, true}, 524 }; 525 526 static void 527 rpc_nvmf_delete_subsystem(struct spdk_jsonrpc_request *request, 528 const struct spdk_json_val *params) 529 { 530 struct rpc_delete_subsystem req = { 0 }; 531 struct spdk_nvmf_subsystem *subsystem; 532 struct spdk_nvmf_tgt *tgt; 533 int rc; 534 535 if (spdk_json_decode_object(params, rpc_delete_subsystem_decoders, 536 SPDK_COUNTOF(rpc_delete_subsystem_decoders), 537 &req)) { 538 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 539 goto invalid; 540 } 541 542 if (req.nqn == NULL) { 543 SPDK_ERRLOG("missing name param\n"); 544 goto invalid; 545 } 546 547 tgt = spdk_nvmf_get_tgt(req.tgt_name); 548 if (!tgt) { 549 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 550 "Unable to find a target."); 551 goto invalid_custom_response; 552 } 553 554 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, req.nqn); 555 if (!subsystem) { 556 goto invalid; 557 } 558 559 free_rpc_delete_subsystem(&req); 560 561 rc = spdk_nvmf_subsystem_stop(subsystem, 562 rpc_nvmf_subsystem_stopped, 563 request); 564 if (rc == -EBUSY) { 565 SPDK_ERRLOG("Subsystem currently in another state change try again later.\n"); 566 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 567 "Subsystem currently in another state change try again later."); 568 } else if (rc != 0) { 569 SPDK_ERRLOG("Unable to change state on subsystem. rc=%d\n", rc); 570 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 571 "Unable to change state on subsystem. rc=%d", rc); 572 } 573 574 return; 575 576 invalid: 577 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 578 invalid_custom_response: 579 free_rpc_delete_subsystem(&req); 580 } 581 SPDK_RPC_REGISTER("nvmf_delete_subsystem", rpc_nvmf_delete_subsystem, SPDK_RPC_RUNTIME) 582 583 struct rpc_listen_address { 584 char *trtype; 585 char *adrfam; 586 char *traddr; 587 char *trsvcid; 588 }; 589 590 static const struct spdk_json_object_decoder rpc_listen_address_decoders[] = { 591 {"trtype", offsetof(struct rpc_listen_address, trtype), spdk_json_decode_string, true}, 592 {"adrfam", offsetof(struct rpc_listen_address, adrfam), spdk_json_decode_string, true}, 593 {"traddr", offsetof(struct rpc_listen_address, traddr), spdk_json_decode_string}, 594 {"trsvcid", offsetof(struct rpc_listen_address, trsvcid), spdk_json_decode_string, true}, 595 }; 596 597 static int 598 decode_rpc_listen_address(const struct spdk_json_val *val, void *out) 599 { 600 struct rpc_listen_address *req = (struct rpc_listen_address *)out; 601 602 return spdk_json_decode_object(val, rpc_listen_address_decoders, 603 SPDK_COUNTOF(rpc_listen_address_decoders), req); 604 } 605 606 static void 607 free_rpc_listen_address(struct rpc_listen_address *r) 608 { 609 free(r->trtype); 610 free(r->adrfam); 611 free(r->traddr); 612 free(r->trsvcid); 613 } 614 615 enum nvmf_rpc_listen_op { 616 NVMF_RPC_LISTEN_ADD, 617 NVMF_RPC_LISTEN_REMOVE, 618 NVMF_RPC_LISTEN_SET_ANA_STATE, 619 }; 620 621 struct nvmf_rpc_listener_ctx { 622 char *nqn; 623 char *tgt_name; 624 struct spdk_nvmf_tgt *tgt; 625 struct spdk_nvmf_transport *transport; 626 struct spdk_nvmf_subsystem *subsystem; 627 struct rpc_listen_address address; 628 char *ana_state_str; 629 enum spdk_nvme_ana_state ana_state; 630 uint32_t anagrpid; 631 632 struct spdk_jsonrpc_request *request; 633 struct spdk_nvme_transport_id trid; 634 enum nvmf_rpc_listen_op op; 635 bool response_sent; 636 struct spdk_nvmf_listen_opts opts; 637 638 /* Hole at bytes 705-711 */ 639 uint8_t reserved1[7]; 640 641 /* Additional options for listener creation. 642 * Must be 8-byte aligned. */ 643 struct spdk_nvmf_listener_opts listener_opts; 644 }; 645 646 static const struct spdk_json_object_decoder nvmf_rpc_listener_decoder[] = { 647 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 648 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 649 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 650 {"secure_channel", offsetof(struct nvmf_rpc_listener_ctx, listener_opts.secure_channel), spdk_json_decode_bool, true}, 651 {"ana_state", offsetof(struct nvmf_rpc_listener_ctx, ana_state_str), spdk_json_decode_string, true}, 652 {"sock_impl", offsetof(struct nvmf_rpc_listener_ctx, listener_opts.sock_impl), spdk_json_decode_string, true}, 653 }; 654 655 static void 656 nvmf_rpc_listener_ctx_free(struct nvmf_rpc_listener_ctx *ctx) 657 { 658 free(ctx->nqn); 659 free(ctx->tgt_name); 660 free_rpc_listen_address(&ctx->address); 661 free(ctx->ana_state_str); 662 free(ctx); 663 } 664 665 static void 666 nvmf_rpc_listen_resumed(struct spdk_nvmf_subsystem *subsystem, 667 void *cb_arg, int status) 668 { 669 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 670 struct spdk_jsonrpc_request *request; 671 672 request = ctx->request; 673 if (ctx->response_sent) { 674 /* If an error occurred, the response has already been sent. */ 675 nvmf_rpc_listener_ctx_free(ctx); 676 return; 677 } 678 679 nvmf_rpc_listener_ctx_free(ctx); 680 681 spdk_jsonrpc_send_bool_response(request, true); 682 } 683 684 static void 685 nvmf_rpc_subsystem_listen(void *cb_arg, int status) 686 { 687 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 688 689 if (status) { 690 /* Destroy the listener that we just created. Ignore the error code because 691 * the RPC is failing already anyway. */ 692 spdk_nvmf_tgt_stop_listen(ctx->tgt, &ctx->trid); 693 694 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 695 "Invalid parameters"); 696 ctx->response_sent = true; 697 } 698 699 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 700 if (!ctx->response_sent) { 701 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 702 "Internal error"); 703 } 704 nvmf_rpc_listener_ctx_free(ctx); 705 /* Can't really do anything to recover here - subsystem will remain paused. */ 706 } 707 } 708 static void 709 nvmf_rpc_stop_listen_async_done(void *cb_arg, int status) 710 { 711 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 712 713 if (status) { 714 SPDK_ERRLOG("Unable to stop listener.\n"); 715 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 716 "error stopping listener: %d", status); 717 ctx->response_sent = true; 718 } 719 720 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 721 if (!ctx->response_sent) { 722 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 723 "Internal error"); 724 } 725 nvmf_rpc_listener_ctx_free(ctx); 726 /* Can't really do anything to recover here - subsystem will remain paused. */ 727 } 728 } 729 730 static void 731 nvmf_rpc_set_ana_state_done(void *cb_arg, int status) 732 { 733 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 734 735 if (status) { 736 SPDK_ERRLOG("Unable to set ANA state.\n"); 737 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 738 "error setting ANA state: %d", status); 739 ctx->response_sent = true; 740 } 741 742 if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_rpc_listen_resumed, ctx)) { 743 if (!ctx->response_sent) { 744 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 745 "Internal error"); 746 } 747 nvmf_rpc_listener_ctx_free(ctx); 748 /* Can't really do anything to recover here - subsystem will remain paused. */ 749 } 750 } 751 752 static void 753 nvmf_rpc_listen_paused(struct spdk_nvmf_subsystem *subsystem, 754 void *cb_arg, int status) 755 { 756 struct nvmf_rpc_listener_ctx *ctx = cb_arg; 757 int rc; 758 759 switch (ctx->op) { 760 case NVMF_RPC_LISTEN_ADD: 761 if (nvmf_subsystem_find_listener(subsystem, &ctx->trid)) { 762 SPDK_ERRLOG("Listener already exists\n"); 763 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 764 "Invalid parameters"); 765 ctx->response_sent = true; 766 break; 767 } 768 769 rc = spdk_nvmf_tgt_listen_ext(ctx->tgt, &ctx->trid, &ctx->opts); 770 if (rc) { 771 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 772 "Invalid parameters"); 773 ctx->response_sent = true; 774 break; 775 } 776 777 spdk_nvmf_subsystem_add_listener_ext(ctx->subsystem, &ctx->trid, nvmf_rpc_subsystem_listen, ctx, 778 &ctx->listener_opts); 779 return; 780 case NVMF_RPC_LISTEN_REMOVE: 781 rc = spdk_nvmf_subsystem_remove_listener(subsystem, &ctx->trid); 782 if (rc) { 783 SPDK_ERRLOG("Unable to remove listener, rc %d\n", rc); 784 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 785 "Invalid parameters"); 786 ctx->response_sent = true; 787 break; 788 } 789 790 spdk_nvmf_transport_stop_listen_async(ctx->transport, &ctx->trid, subsystem, 791 nvmf_rpc_stop_listen_async_done, ctx); 792 return; 793 case NVMF_RPC_LISTEN_SET_ANA_STATE: 794 spdk_nvmf_subsystem_set_ana_state(subsystem, &ctx->trid, ctx->ana_state, ctx->anagrpid, 795 nvmf_rpc_set_ana_state_done, ctx); 796 return; 797 default: 798 SPDK_UNREACHABLE(); 799 } 800 801 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_listen_resumed, ctx)) { 802 if (!ctx->response_sent) { 803 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 804 "Internal error"); 805 } 806 807 nvmf_rpc_listener_ctx_free(ctx); 808 /* Can't really do anything to recover here - subsystem will remain paused. */ 809 } 810 } 811 812 static int 813 rpc_listen_address_to_trid(const struct rpc_listen_address *address, 814 struct spdk_nvme_transport_id *trid) 815 { 816 size_t len; 817 818 memset(trid, 0, sizeof(*trid)); 819 820 if (spdk_nvme_transport_id_populate_trstring(trid, address->trtype)) { 821 SPDK_ERRLOG("Invalid trtype string: %s\n", address->trtype); 822 return -EINVAL; 823 } 824 825 if (spdk_nvme_transport_id_parse_trtype(&trid->trtype, address->trtype)) { 826 SPDK_ERRLOG("Invalid trtype type: %s\n", address->trtype); 827 return -EINVAL; 828 } 829 830 if (address->adrfam) { 831 if (spdk_nvme_transport_id_parse_adrfam(&trid->adrfam, address->adrfam)) { 832 SPDK_ERRLOG("Invalid adrfam: %s\n", address->adrfam); 833 return -EINVAL; 834 } 835 } else { 836 trid->adrfam = SPDK_NVMF_ADRFAM_IPV4; 837 } 838 839 len = strlen(address->traddr); 840 if (len > sizeof(trid->traddr) - 1) { 841 SPDK_ERRLOG("Transport address longer than %zu characters: %s\n", 842 sizeof(trid->traddr) - 1, address->traddr); 843 return -EINVAL; 844 } 845 memcpy(trid->traddr, address->traddr, len + 1); 846 847 trid->trsvcid[0] = '\0'; 848 if (address->trsvcid) { 849 len = strlen(address->trsvcid); 850 if (len > sizeof(trid->trsvcid) - 1) { 851 SPDK_ERRLOG("Transport service id longer than %zu characters: %s\n", 852 sizeof(trid->trsvcid) - 1, address->trsvcid); 853 return -EINVAL; 854 } 855 memcpy(trid->trsvcid, address->trsvcid, len + 1); 856 } 857 858 return 0; 859 } 860 861 static void 862 rpc_nvmf_subsystem_add_listener(struct spdk_jsonrpc_request *request, 863 const struct spdk_json_val *params) 864 { 865 struct nvmf_rpc_listener_ctx *ctx; 866 struct spdk_nvmf_subsystem *subsystem; 867 struct spdk_nvmf_tgt *tgt; 868 int rc; 869 870 ctx = calloc(1, sizeof(*ctx)); 871 if (!ctx) { 872 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 873 return; 874 } 875 876 ctx->request = request; 877 878 spdk_nvmf_subsystem_listener_opts_init(&ctx->listener_opts, sizeof(ctx->listener_opts)); 879 880 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_listener_decoder, 881 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 882 ctx)) { 883 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 884 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 885 nvmf_rpc_listener_ctx_free(ctx); 886 return; 887 } 888 889 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 890 if (!tgt) { 891 SPDK_ERRLOG("Unable to find a target object.\n"); 892 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 893 "Unable to find a target."); 894 nvmf_rpc_listener_ctx_free(ctx); 895 return; 896 } 897 ctx->tgt = tgt; 898 899 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 900 if (!subsystem) { 901 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 902 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 903 nvmf_rpc_listener_ctx_free(ctx); 904 return; 905 } 906 907 ctx->subsystem = subsystem; 908 909 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 910 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 911 "Invalid parameters"); 912 nvmf_rpc_listener_ctx_free(ctx); 913 return; 914 } 915 916 ctx->op = NVMF_RPC_LISTEN_ADD; 917 spdk_nvmf_listen_opts_init(&ctx->opts, sizeof(ctx->opts)); 918 ctx->opts.transport_specific = params; 919 if (spdk_nvmf_subsystem_get_allow_any_host(subsystem) && ctx->listener_opts.secure_channel) { 920 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 921 "Cannot establish secure channel, when 'allow_any_host' is set"); 922 nvmf_rpc_listener_ctx_free(ctx); 923 return; 924 } 925 ctx->opts.secure_channel = ctx->listener_opts.secure_channel; 926 927 if (ctx->ana_state_str) { 928 if (rpc_ana_state_parse(ctx->ana_state_str, &ctx->ana_state)) { 929 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 930 "Invalid parameters"); 931 nvmf_rpc_listener_ctx_free(ctx); 932 return; 933 } 934 ctx->listener_opts.ana_state = ctx->ana_state; 935 } 936 937 ctx->opts.sock_impl = ctx->listener_opts.sock_impl; 938 939 rc = spdk_nvmf_subsystem_pause(subsystem, 0, nvmf_rpc_listen_paused, ctx); 940 if (rc != 0) { 941 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 942 nvmf_rpc_listener_ctx_free(ctx); 943 } 944 } 945 SPDK_RPC_REGISTER("nvmf_subsystem_add_listener", rpc_nvmf_subsystem_add_listener, 946 SPDK_RPC_RUNTIME); 947 948 static void 949 rpc_nvmf_subsystem_remove_listener(struct spdk_jsonrpc_request *request, 950 const struct spdk_json_val *params) 951 { 952 struct nvmf_rpc_listener_ctx *ctx; 953 struct spdk_nvmf_subsystem *subsystem; 954 struct spdk_nvmf_tgt *tgt; 955 int rc; 956 957 ctx = calloc(1, sizeof(*ctx)); 958 if (!ctx) { 959 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 960 return; 961 } 962 963 ctx->request = request; 964 965 if (spdk_json_decode_object(params, nvmf_rpc_listener_decoder, 966 SPDK_COUNTOF(nvmf_rpc_listener_decoder), 967 ctx)) { 968 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 969 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 970 nvmf_rpc_listener_ctx_free(ctx); 971 return; 972 } 973 974 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 975 if (!tgt) { 976 SPDK_ERRLOG("Unable to find a target object.\n"); 977 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 978 "Unable to find a target."); 979 nvmf_rpc_listener_ctx_free(ctx); 980 return; 981 } 982 ctx->tgt = tgt; 983 984 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 985 if (!subsystem) { 986 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 987 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 988 nvmf_rpc_listener_ctx_free(ctx); 989 return; 990 } 991 992 ctx->subsystem = subsystem; 993 994 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 995 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 996 "Invalid parameters"); 997 nvmf_rpc_listener_ctx_free(ctx); 998 return; 999 } 1000 1001 ctx->transport = spdk_nvmf_tgt_get_transport(tgt, ctx->trid.trstring); 1002 if (!ctx->transport) { 1003 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 1004 ctx->trid.trstring); 1005 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1006 "Invalid parameters"); 1007 nvmf_rpc_listener_ctx_free(ctx); 1008 return; 1009 } 1010 1011 ctx->op = NVMF_RPC_LISTEN_REMOVE; 1012 1013 rc = spdk_nvmf_subsystem_pause(subsystem, 0, nvmf_rpc_listen_paused, ctx); 1014 if (rc != 0) { 1015 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1016 nvmf_rpc_listener_ctx_free(ctx); 1017 } 1018 } 1019 SPDK_RPC_REGISTER("nvmf_subsystem_remove_listener", rpc_nvmf_subsystem_remove_listener, 1020 SPDK_RPC_RUNTIME); 1021 1022 struct nvmf_rpc_referral_ctx { 1023 char *tgt_name; 1024 struct rpc_listen_address address; 1025 bool secure_channel; 1026 char *subnqn; 1027 }; 1028 1029 static const struct spdk_json_object_decoder nvmf_rpc_referral_decoder[] = { 1030 {"address", offsetof(struct nvmf_rpc_referral_ctx, address), decode_rpc_listen_address}, 1031 {"tgt_name", offsetof(struct nvmf_rpc_referral_ctx, tgt_name), spdk_json_decode_string, true}, 1032 {"secure_channel", offsetof(struct nvmf_rpc_referral_ctx, secure_channel), spdk_json_decode_bool, true}, 1033 {"subnqn", offsetof(struct nvmf_rpc_referral_ctx, subnqn), spdk_json_decode_string, true}, 1034 }; 1035 1036 static void 1037 nvmf_rpc_referral_ctx_free(struct nvmf_rpc_referral_ctx *ctx) 1038 { 1039 free(ctx->tgt_name); 1040 free(ctx->subnqn); 1041 free_rpc_listen_address(&ctx->address); 1042 } 1043 1044 static void 1045 rpc_nvmf_add_referral(struct spdk_jsonrpc_request *request, 1046 const struct spdk_json_val *params) 1047 { 1048 struct nvmf_rpc_referral_ctx ctx = {}; 1049 struct spdk_nvme_transport_id trid = {}; 1050 struct spdk_nvmf_tgt *tgt; 1051 struct spdk_nvmf_referral_opts opts = {}; 1052 int rc; 1053 1054 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_referral_decoder, 1055 SPDK_COUNTOF(nvmf_rpc_referral_decoder), 1056 &ctx)) { 1057 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 1058 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1059 nvmf_rpc_referral_ctx_free(&ctx); 1060 return; 1061 } 1062 1063 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1064 if (!tgt) { 1065 SPDK_ERRLOG("Unable to find a target object.\n"); 1066 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1067 "Unable to find a target."); 1068 nvmf_rpc_referral_ctx_free(&ctx); 1069 return; 1070 } 1071 1072 if (rpc_listen_address_to_trid(&ctx.address, &trid)) { 1073 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1074 "Invalid parameters"); 1075 nvmf_rpc_referral_ctx_free(&ctx); 1076 return; 1077 } 1078 1079 if (ctx.subnqn != NULL) { 1080 rc = snprintf(trid.subnqn, sizeof(trid.subnqn), "%s", ctx.subnqn); 1081 if (rc < 0 || (size_t)rc >= sizeof(trid.subnqn)) { 1082 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1083 "Invalid subsystem NQN"); 1084 nvmf_rpc_referral_ctx_free(&ctx); 1085 return; 1086 } 1087 } 1088 1089 if ((trid.trtype == SPDK_NVME_TRANSPORT_TCP || 1090 trid.trtype == SPDK_NVME_TRANSPORT_RDMA) && 1091 !strlen(trid.trsvcid)) { 1092 SPDK_ERRLOG("Service ID is required.\n"); 1093 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1094 "Service ID is required."); 1095 nvmf_rpc_referral_ctx_free(&ctx); 1096 return; 1097 } 1098 1099 opts.size = SPDK_SIZEOF(&opts, secure_channel); 1100 opts.trid = trid; 1101 opts.secure_channel = ctx.secure_channel; 1102 1103 rc = spdk_nvmf_tgt_add_referral(tgt, &opts); 1104 if (rc != 0) { 1105 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1106 "Internal error"); 1107 nvmf_rpc_referral_ctx_free(&ctx); 1108 return; 1109 } 1110 1111 nvmf_rpc_referral_ctx_free(&ctx); 1112 1113 spdk_jsonrpc_send_bool_response(request, true); 1114 } 1115 1116 SPDK_RPC_REGISTER("nvmf_discovery_add_referral", rpc_nvmf_add_referral, 1117 SPDK_RPC_RUNTIME); 1118 1119 static void 1120 rpc_nvmf_remove_referral(struct spdk_jsonrpc_request *request, 1121 const struct spdk_json_val *params) 1122 { 1123 struct nvmf_rpc_referral_ctx ctx = {}; 1124 struct spdk_nvme_transport_id trid = {}; 1125 struct spdk_nvmf_referral_opts opts = {}; 1126 struct spdk_nvmf_tgt *tgt; 1127 int rc; 1128 1129 if (spdk_json_decode_object(params, nvmf_rpc_referral_decoder, 1130 SPDK_COUNTOF(nvmf_rpc_referral_decoder), 1131 &ctx)) { 1132 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1133 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1134 nvmf_rpc_referral_ctx_free(&ctx); 1135 return; 1136 } 1137 1138 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1139 if (!tgt) { 1140 SPDK_ERRLOG("Unable to find a target object.\n"); 1141 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1142 "Unable to find a target."); 1143 nvmf_rpc_referral_ctx_free(&ctx); 1144 return; 1145 } 1146 1147 if (rpc_listen_address_to_trid(&ctx.address, &trid)) { 1148 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1149 "Invalid parameters"); 1150 nvmf_rpc_referral_ctx_free(&ctx); 1151 return; 1152 } 1153 1154 if (ctx.subnqn != NULL) { 1155 rc = snprintf(trid.subnqn, sizeof(trid.subnqn), "%s", ctx.subnqn); 1156 if (rc < 0 || (size_t)rc >= sizeof(trid.subnqn)) { 1157 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1158 "Invalid subsystem NQN"); 1159 nvmf_rpc_referral_ctx_free(&ctx); 1160 return; 1161 } 1162 } 1163 1164 opts.size = SPDK_SIZEOF(&opts, secure_channel); 1165 opts.trid = trid; 1166 1167 if (spdk_nvmf_tgt_remove_referral(tgt, &opts)) { 1168 SPDK_ERRLOG("Failed to remove referral.\n"); 1169 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1170 "Unable to remove a referral."); 1171 nvmf_rpc_referral_ctx_free(&ctx); 1172 return; 1173 } 1174 1175 nvmf_rpc_referral_ctx_free(&ctx); 1176 1177 spdk_jsonrpc_send_bool_response(request, true); 1178 } 1179 1180 SPDK_RPC_REGISTER("nvmf_discovery_remove_referral", rpc_nvmf_remove_referral, 1181 SPDK_RPC_RUNTIME); 1182 1183 static void 1184 dump_nvmf_referral(struct spdk_json_write_ctx *w, 1185 struct spdk_nvmf_referral *referral) 1186 { 1187 spdk_json_write_object_begin(w); 1188 1189 spdk_json_write_named_object_begin(w, "address"); 1190 nvmf_transport_listen_dump_trid(&referral->trid, w); 1191 spdk_json_write_object_end(w); 1192 spdk_json_write_named_bool(w, "secure_channel", 1193 referral->entry.treq.secure_channel == SPDK_NVMF_TREQ_SECURE_CHANNEL_REQUIRED); 1194 spdk_json_write_named_string(w, "subnqn", referral->trid.subnqn); 1195 1196 spdk_json_write_object_end(w); 1197 } 1198 1199 struct rpc_get_referrals_ctx { 1200 char *tgt_name; 1201 }; 1202 1203 static const struct spdk_json_object_decoder rpc_get_referrals_decoders[] = { 1204 {"tgt_name", offsetof(struct rpc_get_referrals_ctx, tgt_name), spdk_json_decode_string, true}, 1205 }; 1206 1207 static void 1208 free_rpc_get_referrals_ctx(struct rpc_get_referrals_ctx *ctx) 1209 { 1210 free(ctx->tgt_name); 1211 free(ctx); 1212 } 1213 1214 static void 1215 rpc_nvmf_get_referrals(struct spdk_jsonrpc_request *request, 1216 const struct spdk_json_val *params) 1217 { 1218 struct rpc_get_referrals_ctx *ctx; 1219 struct spdk_nvmf_tgt *tgt; 1220 struct spdk_json_write_ctx *w; 1221 struct spdk_nvmf_referral *referral; 1222 1223 ctx = calloc(1, sizeof(*ctx)); 1224 if (!ctx) { 1225 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1226 "Out of memory"); 1227 return; 1228 } 1229 1230 if (params) { 1231 if (spdk_json_decode_object(params, rpc_get_referrals_decoders, 1232 SPDK_COUNTOF(rpc_get_referrals_decoders), 1233 ctx)) { 1234 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1235 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1236 "Invalid parameters"); 1237 free_rpc_get_referrals_ctx(ctx); 1238 return; 1239 } 1240 } 1241 1242 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1243 if (!tgt) { 1244 SPDK_ERRLOG("Unable to find a target object.\n"); 1245 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1246 "Unable to find a target"); 1247 free_rpc_get_referrals_ctx(ctx); 1248 return; 1249 } 1250 1251 w = spdk_jsonrpc_begin_result(request); 1252 1253 spdk_json_write_array_begin(w); 1254 1255 TAILQ_FOREACH(referral, &tgt->referrals, link) { 1256 dump_nvmf_referral(w, referral); 1257 } 1258 1259 spdk_json_write_array_end(w); 1260 1261 spdk_jsonrpc_end_result(request, w); 1262 1263 free_rpc_get_referrals_ctx(ctx); 1264 } 1265 SPDK_RPC_REGISTER("nvmf_discovery_get_referrals", rpc_nvmf_get_referrals, 1266 SPDK_RPC_RUNTIME); 1267 1268 static const struct spdk_json_object_decoder nvmf_rpc_set_ana_state_decoder[] = { 1269 {"nqn", offsetof(struct nvmf_rpc_listener_ctx, nqn), spdk_json_decode_string}, 1270 {"listen_address", offsetof(struct nvmf_rpc_listener_ctx, address), decode_rpc_listen_address}, 1271 {"ana_state", offsetof(struct nvmf_rpc_listener_ctx, ana_state_str), spdk_json_decode_string}, 1272 {"tgt_name", offsetof(struct nvmf_rpc_listener_ctx, tgt_name), spdk_json_decode_string, true}, 1273 {"anagrpid", offsetof(struct nvmf_rpc_listener_ctx, anagrpid), spdk_json_decode_uint32, true}, 1274 }; 1275 1276 static int 1277 rpc_ana_state_parse(const char *str, enum spdk_nvme_ana_state *ana_state) 1278 { 1279 if (ana_state == NULL || str == NULL) { 1280 return -EINVAL; 1281 } 1282 1283 if (strcasecmp(str, "optimized") == 0) { 1284 *ana_state = SPDK_NVME_ANA_OPTIMIZED_STATE; 1285 } else if (strcasecmp(str, "non_optimized") == 0) { 1286 *ana_state = SPDK_NVME_ANA_NON_OPTIMIZED_STATE; 1287 } else if (strcasecmp(str, "inaccessible") == 0) { 1288 *ana_state = SPDK_NVME_ANA_INACCESSIBLE_STATE; 1289 } else { 1290 return -ENOENT; 1291 } 1292 1293 return 0; 1294 } 1295 1296 static void 1297 rpc_nvmf_subsystem_listener_set_ana_state(struct spdk_jsonrpc_request *request, 1298 const struct spdk_json_val *params) 1299 { 1300 struct nvmf_rpc_listener_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, 1307 "Out of memory"); 1308 return; 1309 } 1310 1311 ctx->request = request; 1312 1313 if (spdk_json_decode_object(params, nvmf_rpc_set_ana_state_decoder, 1314 SPDK_COUNTOF(nvmf_rpc_set_ana_state_decoder), 1315 ctx)) { 1316 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1317 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1318 "Invalid parameters"); 1319 nvmf_rpc_listener_ctx_free(ctx); 1320 return; 1321 } 1322 1323 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1324 if (!tgt) { 1325 SPDK_ERRLOG("Unable to find a target object.\n"); 1326 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1327 "Unable to find a target."); 1328 nvmf_rpc_listener_ctx_free(ctx); 1329 return; 1330 } 1331 1332 ctx->tgt = tgt; 1333 1334 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1335 if (!subsystem) { 1336 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1337 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1338 "Unable to find subsystem with NQN %s", 1339 ctx->nqn); 1340 nvmf_rpc_listener_ctx_free(ctx); 1341 return; 1342 } 1343 1344 ctx->subsystem = subsystem; 1345 1346 if (rpc_listen_address_to_trid(&ctx->address, &ctx->trid)) { 1347 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1348 "Invalid parameters"); 1349 nvmf_rpc_listener_ctx_free(ctx); 1350 return; 1351 } 1352 1353 if (rpc_ana_state_parse(ctx->ana_state_str, &ctx->ana_state)) { 1354 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1355 "Invalid parameters"); 1356 nvmf_rpc_listener_ctx_free(ctx); 1357 return; 1358 } 1359 1360 ctx->op = NVMF_RPC_LISTEN_SET_ANA_STATE; 1361 1362 if (spdk_nvmf_subsystem_pause(subsystem, 0, nvmf_rpc_listen_paused, ctx)) { 1363 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1364 "Internal error"); 1365 nvmf_rpc_listener_ctx_free(ctx); 1366 } 1367 } 1368 SPDK_RPC_REGISTER("nvmf_subsystem_listener_set_ana_state", 1369 rpc_nvmf_subsystem_listener_set_ana_state, SPDK_RPC_RUNTIME); 1370 1371 struct nvmf_rpc_ns_params { 1372 char *bdev_name; 1373 char *ptpl_file; 1374 uint32_t nsid; 1375 char nguid[16]; 1376 char eui64[8]; 1377 struct spdk_uuid uuid; 1378 uint32_t anagrpid; 1379 bool no_auto_visible; 1380 }; 1381 1382 static const struct spdk_json_object_decoder rpc_ns_params_decoders[] = { 1383 {"nsid", offsetof(struct nvmf_rpc_ns_params, nsid), spdk_json_decode_uint32, true}, 1384 {"bdev_name", offsetof(struct nvmf_rpc_ns_params, bdev_name), spdk_json_decode_string}, 1385 {"ptpl_file", offsetof(struct nvmf_rpc_ns_params, ptpl_file), spdk_json_decode_string, true}, 1386 {"nguid", offsetof(struct nvmf_rpc_ns_params, nguid), decode_ns_nguid, true}, 1387 {"eui64", offsetof(struct nvmf_rpc_ns_params, eui64), decode_ns_eui64, true}, 1388 {"uuid", offsetof(struct nvmf_rpc_ns_params, uuid), spdk_json_decode_uuid, true}, 1389 {"anagrpid", offsetof(struct nvmf_rpc_ns_params, anagrpid), spdk_json_decode_uint32, true}, 1390 {"no_auto_visible", offsetof(struct nvmf_rpc_ns_params, no_auto_visible), spdk_json_decode_bool, true}, 1391 }; 1392 1393 static int 1394 decode_rpc_ns_params(const struct spdk_json_val *val, void *out) 1395 { 1396 struct nvmf_rpc_ns_params *ns_params = out; 1397 1398 return spdk_json_decode_object(val, rpc_ns_params_decoders, 1399 SPDK_COUNTOF(rpc_ns_params_decoders), 1400 ns_params); 1401 } 1402 1403 struct nvmf_rpc_ns_ctx { 1404 char *nqn; 1405 char *tgt_name; 1406 struct nvmf_rpc_ns_params ns_params; 1407 1408 struct spdk_jsonrpc_request *request; 1409 const struct spdk_json_val *params; 1410 bool response_sent; 1411 }; 1412 1413 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ns_decoder[] = { 1414 {"nqn", offsetof(struct nvmf_rpc_ns_ctx, nqn), spdk_json_decode_string}, 1415 {"namespace", offsetof(struct nvmf_rpc_ns_ctx, ns_params), decode_rpc_ns_params}, 1416 {"tgt_name", offsetof(struct nvmf_rpc_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1417 }; 1418 1419 static void 1420 nvmf_rpc_ns_ctx_free(struct nvmf_rpc_ns_ctx *ctx) 1421 { 1422 free(ctx->nqn); 1423 free(ctx->tgt_name); 1424 free(ctx->ns_params.bdev_name); 1425 free(ctx->ns_params.ptpl_file); 1426 free(ctx); 1427 } 1428 1429 static void 1430 nvmf_rpc_ns_failback_resumed(struct spdk_nvmf_subsystem *subsystem, 1431 void *cb_arg, int status) 1432 { 1433 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1434 struct spdk_jsonrpc_request *request = ctx->request; 1435 1436 if (status) { 1437 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1438 "Unable to add ns, subsystem in invalid state"); 1439 } else { 1440 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1441 "Unable to add ns, subsystem in active state"); 1442 } 1443 1444 nvmf_rpc_ns_ctx_free(ctx); 1445 } 1446 1447 static void 1448 nvmf_rpc_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1449 void *cb_arg, int status) 1450 { 1451 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1452 struct spdk_jsonrpc_request *request = ctx->request; 1453 uint32_t nsid = ctx->ns_params.nsid; 1454 bool response_sent = ctx->response_sent; 1455 struct spdk_json_write_ctx *w; 1456 int rc; 1457 1458 /* The case where the call to add the namespace was successful, but the subsystem couldn't be resumed. */ 1459 if (status && !ctx->response_sent) { 1460 rc = spdk_nvmf_subsystem_remove_ns(subsystem, nsid); 1461 if (rc != 0) { 1462 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1463 "Unable to add ns, subsystem in invalid state"); 1464 nvmf_rpc_ns_ctx_free(ctx); 1465 return; 1466 } 1467 1468 rc = spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_failback_resumed, ctx); 1469 if (rc != 0) { 1470 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1471 nvmf_rpc_ns_ctx_free(ctx); 1472 return; 1473 } 1474 1475 return; 1476 } 1477 1478 nvmf_rpc_ns_ctx_free(ctx); 1479 1480 if (response_sent) { 1481 return; 1482 } 1483 1484 w = spdk_jsonrpc_begin_result(request); 1485 spdk_json_write_uint32(w, nsid); 1486 spdk_jsonrpc_end_result(request, w); 1487 } 1488 1489 static void 1490 nvmf_rpc_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1491 void *cb_arg, int status) 1492 { 1493 struct nvmf_rpc_ns_ctx *ctx = cb_arg; 1494 struct spdk_nvmf_ns_opts ns_opts; 1495 1496 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 1497 ns_opts.nsid = ctx->ns_params.nsid; 1498 ns_opts.transport_specific = ctx->params; 1499 1500 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(ctx->ns_params.nguid), "size mismatch"); 1501 memcpy(ns_opts.nguid, ctx->ns_params.nguid, sizeof(ns_opts.nguid)); 1502 1503 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(ctx->ns_params.eui64), "size mismatch"); 1504 memcpy(ns_opts.eui64, ctx->ns_params.eui64, sizeof(ns_opts.eui64)); 1505 1506 if (!spdk_uuid_is_null(&ctx->ns_params.uuid)) { 1507 ns_opts.uuid = ctx->ns_params.uuid; 1508 } 1509 1510 ns_opts.anagrpid = ctx->ns_params.anagrpid; 1511 ns_opts.no_auto_visible = ctx->ns_params.no_auto_visible; 1512 1513 ctx->ns_params.nsid = spdk_nvmf_subsystem_add_ns_ext(subsystem, ctx->ns_params.bdev_name, 1514 &ns_opts, sizeof(ns_opts), 1515 ctx->ns_params.ptpl_file); 1516 if (ctx->ns_params.nsid == 0) { 1517 SPDK_ERRLOG("Unable to add namespace\n"); 1518 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1519 "Invalid parameters"); 1520 ctx->response_sent = true; 1521 goto resume; 1522 } 1523 1524 resume: 1525 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_resumed, ctx)) { 1526 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1527 nvmf_rpc_ns_ctx_free(ctx); 1528 } 1529 } 1530 1531 static void 1532 rpc_nvmf_subsystem_add_ns(struct spdk_jsonrpc_request *request, 1533 const struct spdk_json_val *params) 1534 { 1535 struct nvmf_rpc_ns_ctx *ctx; 1536 struct spdk_nvmf_subsystem *subsystem; 1537 struct spdk_nvmf_tgt *tgt; 1538 int rc; 1539 1540 ctx = calloc(1, sizeof(*ctx)); 1541 if (!ctx) { 1542 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1543 return; 1544 } 1545 1546 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_subsystem_ns_decoder, 1547 SPDK_COUNTOF(nvmf_rpc_subsystem_ns_decoder), ctx)) { 1548 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1549 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1550 nvmf_rpc_ns_ctx_free(ctx); 1551 return; 1552 } 1553 1554 ctx->request = request; 1555 ctx->params = params; 1556 ctx->response_sent = false; 1557 1558 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1559 if (!tgt) { 1560 SPDK_ERRLOG("Unable to find a target object.\n"); 1561 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1562 "Unable to find a target."); 1563 nvmf_rpc_ns_ctx_free(ctx); 1564 return; 1565 } 1566 1567 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1568 if (!subsystem) { 1569 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1570 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1571 nvmf_rpc_ns_ctx_free(ctx); 1572 return; 1573 } 1574 1575 rc = spdk_nvmf_subsystem_pause(subsystem, ctx->ns_params.nsid, nvmf_rpc_ns_paused, ctx); 1576 if (rc != 0) { 1577 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1578 nvmf_rpc_ns_ctx_free(ctx); 1579 } 1580 } 1581 SPDK_RPC_REGISTER("nvmf_subsystem_add_ns", rpc_nvmf_subsystem_add_ns, SPDK_RPC_RUNTIME) 1582 1583 struct nvmf_rpc_ana_group_ctx { 1584 char *nqn; 1585 char *tgt_name; 1586 uint32_t nsid; 1587 uint32_t anagrpid; 1588 1589 struct spdk_jsonrpc_request *request; 1590 bool response_sent; 1591 }; 1592 1593 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_ana_group_decoder[] = { 1594 {"nqn", offsetof(struct nvmf_rpc_ana_group_ctx, nqn), spdk_json_decode_string}, 1595 {"nsid", offsetof(struct nvmf_rpc_ana_group_ctx, nsid), spdk_json_decode_uint32}, 1596 {"anagrpid", offsetof(struct nvmf_rpc_ana_group_ctx, anagrpid), spdk_json_decode_uint32}, 1597 {"tgt_name", offsetof(struct nvmf_rpc_ana_group_ctx, tgt_name), spdk_json_decode_string, true}, 1598 }; 1599 1600 static void 1601 nvmf_rpc_ana_group_ctx_free(struct nvmf_rpc_ana_group_ctx *ctx) 1602 { 1603 free(ctx->nqn); 1604 free(ctx->tgt_name); 1605 free(ctx); 1606 } 1607 1608 static void 1609 nvmf_rpc_anagrpid_resumed(struct spdk_nvmf_subsystem *subsystem, 1610 void *cb_arg, int status) 1611 { 1612 struct nvmf_rpc_ana_group_ctx *ctx = cb_arg; 1613 struct spdk_jsonrpc_request *request = ctx->request; 1614 bool response_sent = ctx->response_sent; 1615 1616 nvmf_rpc_ana_group_ctx_free(ctx); 1617 1618 if (response_sent) { 1619 return; 1620 } 1621 1622 spdk_jsonrpc_send_bool_response(request, true); 1623 } 1624 1625 static void 1626 nvmf_rpc_ana_group(struct spdk_nvmf_subsystem *subsystem, 1627 void *cb_arg, int status) 1628 { 1629 struct nvmf_rpc_ana_group_ctx *ctx = cb_arg; 1630 int rc; 1631 1632 rc = spdk_nvmf_subsystem_set_ns_ana_group(subsystem, ctx->nsid, ctx->anagrpid); 1633 if (rc != 0) { 1634 SPDK_ERRLOG("Unable to change ANA group ID\n"); 1635 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1636 "Invalid parameters"); 1637 ctx->response_sent = true; 1638 } 1639 1640 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_anagrpid_resumed, ctx)) { 1641 if (!ctx->response_sent) { 1642 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1643 "Internal error"); 1644 } 1645 nvmf_rpc_ana_group_ctx_free(ctx); 1646 } 1647 } 1648 1649 static void 1650 rpc_nvmf_subsystem_set_ns_ana_group(struct spdk_jsonrpc_request *request, 1651 const struct spdk_json_val *params) 1652 { 1653 struct nvmf_rpc_ana_group_ctx *ctx; 1654 struct spdk_nvmf_subsystem *subsystem; 1655 struct spdk_nvmf_tgt *tgt; 1656 int rc; 1657 1658 ctx = calloc(1, sizeof(*ctx)); 1659 if (!ctx) { 1660 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1661 return; 1662 } 1663 1664 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_ana_group_decoder, 1665 SPDK_COUNTOF(nvmf_rpc_subsystem_ana_group_decoder), ctx)) { 1666 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1667 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1668 nvmf_rpc_ana_group_ctx_free(ctx); 1669 return; 1670 } 1671 1672 ctx->request = request; 1673 ctx->response_sent = false; 1674 1675 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1676 if (!tgt) { 1677 SPDK_ERRLOG("Unable to find a target object.\n"); 1678 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1679 "Unable to find a target."); 1680 nvmf_rpc_ana_group_ctx_free(ctx); 1681 return; 1682 } 1683 1684 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1685 if (!subsystem) { 1686 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1687 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1688 nvmf_rpc_ana_group_ctx_free(ctx); 1689 return; 1690 } 1691 1692 rc = spdk_nvmf_subsystem_pause(subsystem, ctx->nsid, nvmf_rpc_ana_group, ctx); 1693 if (rc != 0) { 1694 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1695 nvmf_rpc_ana_group_ctx_free(ctx); 1696 } 1697 } 1698 SPDK_RPC_REGISTER("nvmf_subsystem_set_ns_ana_group", rpc_nvmf_subsystem_set_ns_ana_group, 1699 SPDK_RPC_RUNTIME) 1700 1701 struct nvmf_rpc_remove_ns_ctx { 1702 char *nqn; 1703 char *tgt_name; 1704 uint32_t nsid; 1705 1706 struct spdk_jsonrpc_request *request; 1707 bool response_sent; 1708 }; 1709 1710 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_remove_ns_decoder[] = { 1711 {"nqn", offsetof(struct nvmf_rpc_remove_ns_ctx, nqn), spdk_json_decode_string}, 1712 {"nsid", offsetof(struct nvmf_rpc_remove_ns_ctx, nsid), spdk_json_decode_uint32}, 1713 {"tgt_name", offsetof(struct nvmf_rpc_remove_ns_ctx, tgt_name), spdk_json_decode_string, true}, 1714 }; 1715 1716 static void 1717 nvmf_rpc_remove_ns_ctx_free(struct nvmf_rpc_remove_ns_ctx *ctx) 1718 { 1719 free(ctx->nqn); 1720 free(ctx->tgt_name); 1721 free(ctx); 1722 } 1723 1724 static void 1725 nvmf_rpc_remove_ns_resumed(struct spdk_nvmf_subsystem *subsystem, 1726 void *cb_arg, int status) 1727 { 1728 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1729 struct spdk_jsonrpc_request *request = ctx->request; 1730 bool response_sent = ctx->response_sent; 1731 1732 nvmf_rpc_remove_ns_ctx_free(ctx); 1733 1734 if (response_sent) { 1735 return; 1736 } 1737 1738 spdk_jsonrpc_send_bool_response(request, true); 1739 } 1740 1741 static void 1742 nvmf_rpc_remove_ns_paused(struct spdk_nvmf_subsystem *subsystem, 1743 void *cb_arg, int status) 1744 { 1745 struct nvmf_rpc_remove_ns_ctx *ctx = cb_arg; 1746 int ret; 1747 1748 ret = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1749 if (ret < 0) { 1750 SPDK_ERRLOG("Unable to remove namespace ID %u\n", ctx->nsid); 1751 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1752 "Invalid parameters"); 1753 ctx->response_sent = true; 1754 } 1755 1756 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_remove_ns_resumed, ctx)) { 1757 if (!ctx->response_sent) { 1758 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1759 } 1760 nvmf_rpc_remove_ns_ctx_free(ctx); 1761 } 1762 } 1763 1764 static void 1765 rpc_nvmf_subsystem_remove_ns(struct spdk_jsonrpc_request *request, 1766 const struct spdk_json_val *params) 1767 { 1768 struct nvmf_rpc_remove_ns_ctx *ctx; 1769 struct spdk_nvmf_subsystem *subsystem; 1770 struct spdk_nvmf_tgt *tgt; 1771 int rc; 1772 1773 ctx = calloc(1, sizeof(*ctx)); 1774 if (!ctx) { 1775 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1776 return; 1777 } 1778 1779 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_remove_ns_decoder, 1780 SPDK_COUNTOF(nvmf_rpc_subsystem_remove_ns_decoder), 1781 ctx)) { 1782 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1783 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1784 nvmf_rpc_remove_ns_ctx_free(ctx); 1785 return; 1786 } 1787 1788 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1789 if (!tgt) { 1790 SPDK_ERRLOG("Unable to find a target object.\n"); 1791 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1792 "Unable to find a target."); 1793 nvmf_rpc_remove_ns_ctx_free(ctx); 1794 return; 1795 } 1796 1797 ctx->request = request; 1798 ctx->response_sent = false; 1799 1800 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1801 if (!subsystem) { 1802 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1803 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1804 nvmf_rpc_remove_ns_ctx_free(ctx); 1805 return; 1806 } 1807 1808 rc = spdk_nvmf_subsystem_pause(subsystem, ctx->nsid, nvmf_rpc_remove_ns_paused, ctx); 1809 if (rc != 0) { 1810 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1811 nvmf_rpc_remove_ns_ctx_free(ctx); 1812 } 1813 } 1814 SPDK_RPC_REGISTER("nvmf_subsystem_remove_ns", rpc_nvmf_subsystem_remove_ns, SPDK_RPC_RUNTIME) 1815 1816 struct nvmf_rpc_ns_visible_ctx { 1817 struct spdk_jsonrpc_request *request; 1818 char *nqn; 1819 uint32_t nsid; 1820 char *host; 1821 char *tgt_name; 1822 bool visible; 1823 bool response_sent; 1824 }; 1825 1826 static const struct spdk_json_object_decoder nvmf_rpc_ns_visible_decoder[] = { 1827 {"nqn", offsetof(struct nvmf_rpc_ns_visible_ctx, nqn), spdk_json_decode_string}, 1828 {"nsid", offsetof(struct nvmf_rpc_ns_visible_ctx, nsid), spdk_json_decode_uint32}, 1829 {"host", offsetof(struct nvmf_rpc_ns_visible_ctx, host), spdk_json_decode_string}, 1830 {"tgt_name", offsetof(struct nvmf_rpc_ns_visible_ctx, tgt_name), spdk_json_decode_string, true}, 1831 }; 1832 1833 static void 1834 nvmf_rpc_ns_visible_ctx_free(struct nvmf_rpc_ns_visible_ctx *ctx) 1835 { 1836 free(ctx->nqn); 1837 free(ctx->host); 1838 free(ctx->tgt_name); 1839 free(ctx); 1840 } 1841 1842 static void 1843 nvmf_rpc_ns_visible_resumed(struct spdk_nvmf_subsystem *subsystem, 1844 void *cb_arg, int status) 1845 { 1846 struct nvmf_rpc_ns_visible_ctx *ctx = cb_arg; 1847 struct spdk_jsonrpc_request *request = ctx->request; 1848 bool response_sent = ctx->response_sent; 1849 1850 nvmf_rpc_ns_visible_ctx_free(ctx); 1851 1852 if (!response_sent) { 1853 spdk_jsonrpc_send_bool_response(request, true); 1854 } 1855 } 1856 1857 static void 1858 nvmf_rpc_ns_visible_paused(struct spdk_nvmf_subsystem *subsystem, 1859 void *cb_arg, int status) 1860 { 1861 struct nvmf_rpc_ns_visible_ctx *ctx = cb_arg; 1862 int ret; 1863 1864 if (ctx->visible) { 1865 ret = spdk_nvmf_ns_add_host(subsystem, ctx->nsid, ctx->host, 0); 1866 } else { 1867 ret = spdk_nvmf_ns_remove_host(subsystem, ctx->nsid, ctx->host, 0); 1868 } 1869 if (ret < 0) { 1870 SPDK_ERRLOG("Unable to add/remove %s to namespace ID %u\n", ctx->host, ctx->nsid); 1871 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 1872 "Invalid parameters"); 1873 ctx->response_sent = true; 1874 } 1875 1876 if (spdk_nvmf_subsystem_resume(subsystem, nvmf_rpc_ns_visible_resumed, ctx)) { 1877 if (!ctx->response_sent) { 1878 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1879 } 1880 nvmf_rpc_ns_visible_ctx_free(ctx); 1881 } 1882 } 1883 1884 static void 1885 nvmf_rpc_ns_visible(struct spdk_jsonrpc_request *request, 1886 const struct spdk_json_val *params, 1887 bool visible) 1888 { 1889 struct nvmf_rpc_ns_visible_ctx *ctx; 1890 struct spdk_nvmf_subsystem *subsystem; 1891 struct spdk_nvmf_tgt *tgt; 1892 int rc; 1893 1894 ctx = calloc(1, sizeof(*ctx)); 1895 if (!ctx) { 1896 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 1897 return; 1898 } 1899 ctx->visible = visible; 1900 1901 if (spdk_json_decode_object(params, nvmf_rpc_ns_visible_decoder, 1902 SPDK_COUNTOF(nvmf_rpc_ns_visible_decoder), 1903 ctx)) { 1904 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1905 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1906 nvmf_rpc_ns_visible_ctx_free(ctx); 1907 return; 1908 } 1909 ctx->request = request; 1910 1911 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 1912 if (!tgt) { 1913 SPDK_ERRLOG("Unable to find a target object.\n"); 1914 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 1915 "Unable to find a target."); 1916 nvmf_rpc_ns_visible_ctx_free(ctx); 1917 return; 1918 } 1919 1920 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 1921 if (!subsystem) { 1922 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 1923 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1924 nvmf_rpc_ns_visible_ctx_free(ctx); 1925 return; 1926 } 1927 1928 rc = spdk_nvmf_subsystem_pause(subsystem, ctx->nsid, nvmf_rpc_ns_visible_paused, ctx); 1929 if (rc != 0) { 1930 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 1931 nvmf_rpc_ns_visible_ctx_free(ctx); 1932 } 1933 } 1934 1935 static void 1936 rpc_nvmf_ns_add_host(struct spdk_jsonrpc_request *request, 1937 const struct spdk_json_val *params) 1938 { 1939 nvmf_rpc_ns_visible(request, params, true); 1940 } 1941 SPDK_RPC_REGISTER("nvmf_ns_add_host", rpc_nvmf_ns_add_host, SPDK_RPC_RUNTIME) 1942 1943 static void 1944 rpc_nvmf_ns_remove_host(struct spdk_jsonrpc_request *request, 1945 const struct spdk_json_val *params) 1946 { 1947 nvmf_rpc_ns_visible(request, params, false); 1948 } 1949 SPDK_RPC_REGISTER("nvmf_ns_remove_host", rpc_nvmf_ns_remove_host, SPDK_RPC_RUNTIME) 1950 1951 struct nvmf_rpc_host_ctx { 1952 struct spdk_jsonrpc_request *request; 1953 char *nqn; 1954 char *host; 1955 char *tgt_name; 1956 char *dhchap_key; 1957 char *dhchap_ctrlr_key; 1958 bool allow_any_host; 1959 }; 1960 1961 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_host_decoder[] = { 1962 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 1963 {"host", offsetof(struct nvmf_rpc_host_ctx, host), spdk_json_decode_string}, 1964 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 1965 {"dhchap_key", offsetof(struct nvmf_rpc_host_ctx, dhchap_key), spdk_json_decode_string, true}, 1966 {"dhchap_ctrlr_key", offsetof(struct nvmf_rpc_host_ctx, dhchap_ctrlr_key), spdk_json_decode_string, true}, 1967 }; 1968 1969 static void 1970 nvmf_rpc_host_ctx_free(struct nvmf_rpc_host_ctx *ctx) 1971 { 1972 free(ctx->nqn); 1973 free(ctx->host); 1974 free(ctx->tgt_name); 1975 free(ctx->dhchap_key); 1976 free(ctx->dhchap_ctrlr_key); 1977 } 1978 1979 static void 1980 rpc_nvmf_subsystem_add_host(struct spdk_jsonrpc_request *request, 1981 const struct spdk_json_val *params) 1982 { 1983 struct nvmf_rpc_host_ctx ctx = {}; 1984 struct spdk_nvmf_subsystem *subsystem; 1985 struct spdk_nvmf_host_opts opts = {}; 1986 struct spdk_nvmf_tgt *tgt; 1987 struct spdk_key *key = NULL, *ckey = NULL; 1988 int rc; 1989 1990 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_subsystem_host_decoder, 1991 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 1992 &ctx)) { 1993 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 1994 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 1995 goto out; 1996 } 1997 1998 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 1999 if (!tgt) { 2000 SPDK_ERRLOG("Unable to find a target object.\n"); 2001 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2002 "Unable to find a target."); 2003 goto out; 2004 } 2005 2006 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 2007 if (!subsystem) { 2008 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx.nqn); 2009 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2010 goto out; 2011 } 2012 2013 if (ctx.dhchap_key != NULL) { 2014 key = spdk_keyring_get_key(ctx.dhchap_key); 2015 if (key == NULL) { 2016 SPDK_ERRLOG("Unable to find DH-HMAC-CHAP key: %s\n", ctx.dhchap_key); 2017 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2018 "Invalid parameters"); 2019 goto out; 2020 } 2021 } 2022 2023 if (ctx.dhchap_ctrlr_key != NULL) { 2024 ckey = spdk_keyring_get_key(ctx.dhchap_ctrlr_key); 2025 if (ckey == NULL) { 2026 SPDK_ERRLOG("Unable to find DH-HMAC-CHAP ctrlr key: %s\n", 2027 ctx.dhchap_ctrlr_key); 2028 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2029 "Invalid parameters"); 2030 goto out; 2031 } 2032 } 2033 2034 opts.size = SPDK_SIZEOF(&opts, dhchap_ctrlr_key); 2035 opts.params = params; 2036 opts.dhchap_key = key; 2037 opts.dhchap_ctrlr_key = ckey; 2038 rc = spdk_nvmf_subsystem_add_host_ext(subsystem, ctx.host, &opts); 2039 if (rc != 0) { 2040 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 2041 goto out; 2042 } 2043 2044 spdk_jsonrpc_send_bool_response(request, true); 2045 out: 2046 spdk_keyring_put_key(ckey); 2047 spdk_keyring_put_key(key); 2048 nvmf_rpc_host_ctx_free(&ctx); 2049 } 2050 SPDK_RPC_REGISTER("nvmf_subsystem_add_host", rpc_nvmf_subsystem_add_host, SPDK_RPC_RUNTIME) 2051 2052 static void 2053 rpc_nvmf_subsystem_remove_host_done(void *_ctx, int status) 2054 { 2055 struct nvmf_rpc_host_ctx *ctx = _ctx; 2056 2057 spdk_jsonrpc_send_bool_response(ctx->request, true); 2058 nvmf_rpc_host_ctx_free(ctx); 2059 free(ctx); 2060 } 2061 2062 static void 2063 rpc_nvmf_subsystem_remove_host(struct spdk_jsonrpc_request *request, 2064 const struct spdk_json_val *params) 2065 { 2066 struct nvmf_rpc_host_ctx *ctx; 2067 struct spdk_nvmf_subsystem *subsystem; 2068 struct spdk_nvmf_tgt *tgt; 2069 int rc; 2070 2071 ctx = calloc(1, sizeof(*ctx)); 2072 if (ctx == NULL) { 2073 SPDK_ERRLOG("Unable to allocate context to perform RPC\n"); 2074 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 2075 return; 2076 } 2077 2078 ctx->request = request; 2079 2080 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 2081 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), 2082 ctx)) { 2083 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2084 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2085 nvmf_rpc_host_ctx_free(ctx); 2086 free(ctx); 2087 return; 2088 } 2089 2090 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2091 if (!tgt) { 2092 SPDK_ERRLOG("Unable to find a target object.\n"); 2093 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2094 "Unable to find a target."); 2095 nvmf_rpc_host_ctx_free(ctx); 2096 free(ctx); 2097 return; 2098 } 2099 2100 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 2101 if (!subsystem) { 2102 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 2103 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2104 nvmf_rpc_host_ctx_free(ctx); 2105 free(ctx); 2106 return; 2107 } 2108 2109 rc = spdk_nvmf_subsystem_remove_host(subsystem, ctx->host); 2110 if (rc != 0) { 2111 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 2112 nvmf_rpc_host_ctx_free(ctx); 2113 free(ctx); 2114 return; 2115 } 2116 2117 rc = spdk_nvmf_subsystem_disconnect_host(subsystem, ctx->host, 2118 rpc_nvmf_subsystem_remove_host_done, 2119 ctx); 2120 if (rc != 0) { 2121 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 2122 nvmf_rpc_host_ctx_free(ctx); 2123 free(ctx); 2124 return; 2125 } 2126 } 2127 SPDK_RPC_REGISTER("nvmf_subsystem_remove_host", rpc_nvmf_subsystem_remove_host, 2128 SPDK_RPC_RUNTIME) 2129 2130 static void 2131 rpc_nvmf_subsystem_set_keys(struct spdk_jsonrpc_request *request, 2132 const struct spdk_json_val *params) 2133 { 2134 struct nvmf_rpc_host_ctx ctx = {}; 2135 struct spdk_nvmf_subsystem *subsystem; 2136 struct spdk_nvmf_subsystem_key_opts opts = {}; 2137 struct spdk_nvmf_tgt *tgt; 2138 struct spdk_key *key = NULL, *ckey = NULL; 2139 int rc; 2140 2141 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_host_decoder, 2142 SPDK_COUNTOF(nvmf_rpc_subsystem_host_decoder), &ctx)) { 2143 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2144 "Invalid parameters"); 2145 goto out; 2146 } 2147 2148 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 2149 if (!tgt) { 2150 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2151 "Invalid parameters"); 2152 goto out; 2153 } 2154 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 2155 if (!subsystem) { 2156 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2157 "Invalid parameters"); 2158 goto out; 2159 } 2160 2161 if (ctx.dhchap_key != NULL) { 2162 key = spdk_keyring_get_key(ctx.dhchap_key); 2163 if (key == NULL) { 2164 SPDK_ERRLOG("Unable to find DH-HMAC-CHAP key: %s\n", ctx.dhchap_key); 2165 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2166 "Invalid parameters"); 2167 goto out; 2168 } 2169 } 2170 if (ctx.dhchap_ctrlr_key != NULL) { 2171 ckey = spdk_keyring_get_key(ctx.dhchap_ctrlr_key); 2172 if (ckey == NULL) { 2173 SPDK_ERRLOG("Unable to find DH-HMAC-CHAP ctrlr key: %s\n", 2174 ctx.dhchap_ctrlr_key); 2175 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2176 "Invalid parameters"); 2177 goto out; 2178 } 2179 } 2180 2181 opts.size = SPDK_SIZEOF(&opts, dhchap_ctrlr_key); 2182 opts.dhchap_key = key; 2183 opts.dhchap_ctrlr_key = ckey; 2184 rc = spdk_nvmf_subsystem_set_keys(subsystem, ctx.host, &opts); 2185 if (rc != 0) { 2186 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 2187 goto out; 2188 } 2189 2190 spdk_jsonrpc_send_bool_response(request, true); 2191 out: 2192 spdk_keyring_put_key(ckey); 2193 spdk_keyring_put_key(key); 2194 nvmf_rpc_host_ctx_free(&ctx); 2195 } 2196 SPDK_RPC_REGISTER("nvmf_subsystem_set_keys", rpc_nvmf_subsystem_set_keys, SPDK_RPC_RUNTIME) 2197 2198 static const struct spdk_json_object_decoder nvmf_rpc_subsystem_any_host_decoder[] = { 2199 {"nqn", offsetof(struct nvmf_rpc_host_ctx, nqn), spdk_json_decode_string}, 2200 {"allow_any_host", offsetof(struct nvmf_rpc_host_ctx, allow_any_host), spdk_json_decode_bool}, 2201 {"tgt_name", offsetof(struct nvmf_rpc_host_ctx, tgt_name), spdk_json_decode_string, true}, 2202 }; 2203 2204 static void 2205 rpc_nvmf_subsystem_allow_any_host(struct spdk_jsonrpc_request *request, 2206 const struct spdk_json_val *params) 2207 { 2208 struct nvmf_rpc_host_ctx ctx = {}; 2209 struct spdk_nvmf_subsystem *subsystem; 2210 struct spdk_nvmf_tgt *tgt; 2211 int rc; 2212 2213 if (spdk_json_decode_object(params, nvmf_rpc_subsystem_any_host_decoder, 2214 SPDK_COUNTOF(nvmf_rpc_subsystem_any_host_decoder), 2215 &ctx)) { 2216 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2217 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2218 nvmf_rpc_host_ctx_free(&ctx); 2219 return; 2220 } 2221 2222 tgt = spdk_nvmf_get_tgt(ctx.tgt_name); 2223 if (!tgt) { 2224 SPDK_ERRLOG("Unable to find a target object.\n"); 2225 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2226 "Unable to find a target."); 2227 nvmf_rpc_host_ctx_free(&ctx); 2228 return; 2229 } 2230 2231 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx.nqn); 2232 if (!subsystem) { 2233 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx.nqn); 2234 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2235 nvmf_rpc_host_ctx_free(&ctx); 2236 return; 2237 } 2238 2239 rc = spdk_nvmf_subsystem_set_allow_any_host(subsystem, ctx.allow_any_host); 2240 if (rc != 0) { 2241 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Internal error"); 2242 nvmf_rpc_host_ctx_free(&ctx); 2243 return; 2244 } 2245 2246 spdk_jsonrpc_send_bool_response(request, true); 2247 nvmf_rpc_host_ctx_free(&ctx); 2248 } 2249 SPDK_RPC_REGISTER("nvmf_subsystem_allow_any_host", rpc_nvmf_subsystem_allow_any_host, 2250 SPDK_RPC_RUNTIME) 2251 2252 struct nvmf_rpc_target_ctx { 2253 char *name; 2254 uint32_t max_subsystems; 2255 char *discovery_filter; 2256 }; 2257 2258 static int 2259 decode_discovery_filter(const struct spdk_json_val *val, void *out) 2260 { 2261 uint32_t *_filter = out; 2262 uint32_t filter = SPDK_NVMF_TGT_DISCOVERY_MATCH_ANY; 2263 char *tokens = spdk_json_strdup(val); 2264 char *tok; 2265 int rc = -EINVAL; 2266 bool all_specified = false; 2267 2268 if (!tokens) { 2269 return -ENOMEM; 2270 } 2271 2272 tok = strtok(tokens, ","); 2273 while (tok) { 2274 if (strncmp(tok, "match_any", 9) == 0) { 2275 if (filter != SPDK_NVMF_TGT_DISCOVERY_MATCH_ANY) { 2276 goto out; 2277 } 2278 filter = SPDK_NVMF_TGT_DISCOVERY_MATCH_ANY; 2279 all_specified = true; 2280 } else { 2281 if (all_specified) { 2282 goto out; 2283 } 2284 if (strncmp(tok, "transport", 9) == 0) { 2285 filter |= SPDK_NVMF_TGT_DISCOVERY_MATCH_TRANSPORT_TYPE; 2286 } else if (strncmp(tok, "address", 7) == 0) { 2287 filter |= SPDK_NVMF_TGT_DISCOVERY_MATCH_TRANSPORT_ADDRESS; 2288 } else if (strncmp(tok, "svcid", 5) == 0) { 2289 filter |= SPDK_NVMF_TGT_DISCOVERY_MATCH_TRANSPORT_SVCID; 2290 } else { 2291 SPDK_ERRLOG("Invalid value %s\n", tok); 2292 goto out; 2293 } 2294 } 2295 2296 tok = strtok(NULL, ","); 2297 } 2298 2299 rc = 0; 2300 *_filter = filter; 2301 2302 out: 2303 free(tokens); 2304 2305 return rc; 2306 } 2307 2308 static const struct spdk_json_object_decoder nvmf_rpc_create_target_decoder[] = { 2309 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 2310 {"max_subsystems", offsetof(struct nvmf_rpc_target_ctx, max_subsystems), spdk_json_decode_uint32, true}, 2311 {"discovery_filter", offsetof(struct nvmf_rpc_target_ctx, discovery_filter), decode_discovery_filter, true} 2312 }; 2313 2314 static void 2315 rpc_nvmf_create_target(struct spdk_jsonrpc_request *request, 2316 const struct spdk_json_val *params) 2317 { 2318 struct spdk_nvmf_target_opts opts; 2319 struct nvmf_rpc_target_ctx ctx = {0}; 2320 struct spdk_nvmf_tgt *tgt; 2321 struct spdk_json_write_ctx *w; 2322 2323 /* Decode parameters the first time to get the transport type */ 2324 if (spdk_json_decode_object(params, nvmf_rpc_create_target_decoder, 2325 SPDK_COUNTOF(nvmf_rpc_create_target_decoder), 2326 &ctx)) { 2327 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2328 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2329 goto out; 2330 } 2331 2332 snprintf(opts.name, NVMF_TGT_NAME_MAX_LENGTH, "%s", ctx.name); 2333 opts.max_subsystems = ctx.max_subsystems; 2334 opts.size = SPDK_SIZEOF(&opts, discovery_filter); 2335 2336 if (spdk_nvmf_get_tgt(opts.name) != NULL) { 2337 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2338 "Target already exists."); 2339 goto out; 2340 } 2341 2342 tgt = spdk_nvmf_tgt_create(&opts); 2343 2344 if (tgt == NULL) { 2345 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2346 "Unable to create the requested target."); 2347 goto out; 2348 } 2349 2350 w = spdk_jsonrpc_begin_result(request); 2351 spdk_json_write_string(w, spdk_nvmf_tgt_get_name(tgt)); 2352 spdk_jsonrpc_end_result(request, w); 2353 out: 2354 free(ctx.name); 2355 free(ctx.discovery_filter); 2356 } 2357 /* private */ SPDK_RPC_REGISTER("nvmf_create_target", rpc_nvmf_create_target, SPDK_RPC_RUNTIME); 2358 2359 static const struct spdk_json_object_decoder nvmf_rpc_destroy_target_decoder[] = { 2360 {"name", offsetof(struct nvmf_rpc_target_ctx, name), spdk_json_decode_string}, 2361 }; 2362 2363 static void 2364 nvmf_rpc_destroy_target_done(void *ctx, int status) 2365 { 2366 struct spdk_jsonrpc_request *request = ctx; 2367 2368 spdk_jsonrpc_send_bool_response(request, true); 2369 } 2370 2371 static void 2372 rpc_nvmf_delete_target(struct spdk_jsonrpc_request *request, 2373 const struct spdk_json_val *params) 2374 { 2375 struct nvmf_rpc_target_ctx ctx = {0}; 2376 struct spdk_nvmf_tgt *tgt; 2377 2378 /* Decode parameters the first time to get the transport type */ 2379 if (spdk_json_decode_object(params, nvmf_rpc_destroy_target_decoder, 2380 SPDK_COUNTOF(nvmf_rpc_destroy_target_decoder), 2381 &ctx)) { 2382 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2383 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2384 free(ctx.name); 2385 return; 2386 } 2387 2388 tgt = spdk_nvmf_get_tgt(ctx.name); 2389 2390 if (tgt == NULL) { 2391 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2392 "The specified target doesn't exist, cannot delete it."); 2393 free(ctx.name); 2394 return; 2395 } 2396 2397 spdk_nvmf_tgt_destroy(tgt, nvmf_rpc_destroy_target_done, request); 2398 free(ctx.name); 2399 } 2400 /* private */ SPDK_RPC_REGISTER("nvmf_delete_target", rpc_nvmf_delete_target, SPDK_RPC_RUNTIME); 2401 2402 static void 2403 rpc_nvmf_get_targets(struct spdk_jsonrpc_request *request, 2404 const struct spdk_json_val *params) 2405 { 2406 struct spdk_json_write_ctx *w; 2407 struct spdk_nvmf_tgt *tgt; 2408 const char *name; 2409 2410 if (params != NULL) { 2411 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2412 "nvmf_get_targets has no parameters."); 2413 return; 2414 } 2415 2416 w = spdk_jsonrpc_begin_result(request); 2417 spdk_json_write_array_begin(w); 2418 2419 tgt = spdk_nvmf_get_first_tgt(); 2420 2421 while (tgt != NULL) { 2422 name = spdk_nvmf_tgt_get_name(tgt); 2423 spdk_json_write_string(w, name); 2424 tgt = spdk_nvmf_get_next_tgt(tgt); 2425 } 2426 2427 spdk_json_write_array_end(w); 2428 spdk_jsonrpc_end_result(request, w); 2429 } 2430 /* private */ SPDK_RPC_REGISTER("nvmf_get_targets", rpc_nvmf_get_targets, SPDK_RPC_RUNTIME); 2431 2432 struct nvmf_rpc_create_transport_ctx { 2433 char *trtype; 2434 char *tgt_name; 2435 struct spdk_nvmf_transport_opts opts; 2436 struct spdk_jsonrpc_request *request; 2437 struct spdk_nvmf_transport *transport; 2438 int status; 2439 }; 2440 2441 /** 2442 * `max_qpairs_per_ctrlr` represents both admin and IO qpairs, that confuses 2443 * users when they configure a transport using RPC. So it was decided to 2444 * deprecate `max_qpairs_per_ctrlr` RPC parameter and use `max_io_qpairs_per_ctrlr` 2445 * But internal logic remains unchanged and SPDK expects that 2446 * spdk_nvmf_transport_opts::max_qpairs_per_ctrlr includes an admin qpair. 2447 * This function parses the number of IO qpairs and adds +1 for admin qpair. 2448 */ 2449 static int 2450 nvmf_rpc_decode_max_io_qpairs(const struct spdk_json_val *val, void *out) 2451 { 2452 uint16_t *i = out; 2453 int rc; 2454 2455 rc = spdk_json_number_to_uint16(val, i); 2456 if (rc == 0) { 2457 (*i)++; 2458 } 2459 2460 return rc; 2461 } 2462 2463 static const struct spdk_json_object_decoder nvmf_rpc_create_transport_decoder[] = { 2464 { "trtype", offsetof(struct nvmf_rpc_create_transport_ctx, trtype), spdk_json_decode_string}, 2465 { 2466 "max_queue_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_queue_depth), 2467 spdk_json_decode_uint16, true 2468 }, 2469 { 2470 "max_io_qpairs_per_ctrlr", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_qpairs_per_ctrlr), 2471 nvmf_rpc_decode_max_io_qpairs, true 2472 }, 2473 { 2474 "in_capsule_data_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.in_capsule_data_size), 2475 spdk_json_decode_uint32, true 2476 }, 2477 { 2478 "max_io_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_io_size), 2479 spdk_json_decode_uint32, true 2480 }, 2481 { 2482 "io_unit_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.io_unit_size), 2483 spdk_json_decode_uint32, true 2484 }, 2485 { 2486 "max_aq_depth", offsetof(struct nvmf_rpc_create_transport_ctx, opts.max_aq_depth), 2487 spdk_json_decode_uint32, true 2488 }, 2489 { 2490 "num_shared_buffers", offsetof(struct nvmf_rpc_create_transport_ctx, opts.num_shared_buffers), 2491 spdk_json_decode_uint32, true 2492 }, 2493 { 2494 "buf_cache_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.buf_cache_size), 2495 spdk_json_decode_uint32, true 2496 }, 2497 { 2498 "dif_insert_or_strip", offsetof(struct nvmf_rpc_create_transport_ctx, opts.dif_insert_or_strip), 2499 spdk_json_decode_bool, true 2500 }, 2501 { 2502 "abort_timeout_sec", offsetof(struct nvmf_rpc_create_transport_ctx, opts.abort_timeout_sec), 2503 spdk_json_decode_uint32, true 2504 }, 2505 { 2506 "zcopy", offsetof(struct nvmf_rpc_create_transport_ctx, opts.zcopy), 2507 spdk_json_decode_bool, true 2508 }, 2509 { 2510 "tgt_name", offsetof(struct nvmf_rpc_create_transport_ctx, tgt_name), 2511 spdk_json_decode_string, true 2512 }, 2513 { 2514 "acceptor_poll_rate", offsetof(struct nvmf_rpc_create_transport_ctx, opts.acceptor_poll_rate), 2515 spdk_json_decode_uint32, true 2516 }, 2517 { 2518 "ack_timeout", offsetof(struct nvmf_rpc_create_transport_ctx, opts.ack_timeout), 2519 spdk_json_decode_uint32, true 2520 }, 2521 { 2522 "data_wr_pool_size", offsetof(struct nvmf_rpc_create_transport_ctx, opts.data_wr_pool_size), 2523 spdk_json_decode_uint32, true 2524 }, 2525 { 2526 "disable_command_passthru", offsetof(struct nvmf_rpc_create_transport_ctx, opts.disable_command_passthru), 2527 spdk_json_decode_bool, true 2528 } 2529 }; 2530 2531 static void 2532 nvmf_rpc_create_transport_ctx_free(struct nvmf_rpc_create_transport_ctx *ctx) 2533 { 2534 free(ctx->trtype); 2535 free(ctx->tgt_name); 2536 free(ctx); 2537 } 2538 2539 static void 2540 nvmf_rpc_transport_destroy_done_cb(void *cb_arg) 2541 { 2542 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 2543 2544 spdk_jsonrpc_send_error_response_fmt(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2545 "Failed to add transport to tgt.(%d)", ctx->status); 2546 nvmf_rpc_create_transport_ctx_free(ctx); 2547 } 2548 2549 static void 2550 nvmf_rpc_tgt_add_transport_done(void *cb_arg, int status) 2551 { 2552 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 2553 2554 if (status) { 2555 SPDK_ERRLOG("Failed to add transport to tgt.(%d)\n", status); 2556 ctx->status = status; 2557 spdk_nvmf_transport_destroy(ctx->transport, nvmf_rpc_transport_destroy_done_cb, ctx); 2558 return; 2559 } 2560 2561 spdk_jsonrpc_send_bool_response(ctx->request, true); 2562 nvmf_rpc_create_transport_ctx_free(ctx); 2563 } 2564 2565 static void 2566 nvmf_rpc_create_transport_done(void *cb_arg, struct spdk_nvmf_transport *transport) 2567 { 2568 struct nvmf_rpc_create_transport_ctx *ctx = cb_arg; 2569 2570 if (!transport) { 2571 SPDK_ERRLOG("Failed to create transport.\n"); 2572 spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2573 "Failed to create transport."); 2574 nvmf_rpc_create_transport_ctx_free(ctx); 2575 return; 2576 } 2577 2578 ctx->transport = transport; 2579 2580 spdk_nvmf_tgt_add_transport(spdk_nvmf_get_tgt(ctx->tgt_name), transport, 2581 nvmf_rpc_tgt_add_transport_done, ctx); 2582 } 2583 2584 static void 2585 rpc_nvmf_create_transport(struct spdk_jsonrpc_request *request, 2586 const struct spdk_json_val *params) 2587 { 2588 struct nvmf_rpc_create_transport_ctx *ctx; 2589 struct spdk_nvmf_tgt *tgt; 2590 int rc; 2591 2592 ctx = calloc(1, sizeof(*ctx)); 2593 if (!ctx) { 2594 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "Out of memory"); 2595 return; 2596 } 2597 2598 /* Decode parameters the first time to get the transport type */ 2599 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_create_transport_decoder, 2600 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 2601 ctx)) { 2602 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 2603 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2604 nvmf_rpc_create_transport_ctx_free(ctx); 2605 return; 2606 } 2607 2608 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2609 if (!tgt) { 2610 SPDK_ERRLOG("Unable to find a target object.\n"); 2611 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2612 "Unable to find a target."); 2613 nvmf_rpc_create_transport_ctx_free(ctx); 2614 return; 2615 } 2616 2617 /* Initialize all the transport options (based on transport type) and decode the 2618 * parameters again to update any options passed in rpc create transport call. 2619 */ 2620 if (!spdk_nvmf_transport_opts_init(ctx->trtype, &ctx->opts, sizeof(ctx->opts))) { 2621 /* This can happen if user specifies PCIE transport type which isn't valid for 2622 * NVMe-oF. 2623 */ 2624 SPDK_ERRLOG("Invalid transport type '%s'\n", ctx->trtype); 2625 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 2626 "Invalid transport type '%s'", ctx->trtype); 2627 nvmf_rpc_create_transport_ctx_free(ctx); 2628 return; 2629 } 2630 2631 if (spdk_json_decode_object_relaxed(params, nvmf_rpc_create_transport_decoder, 2632 SPDK_COUNTOF(nvmf_rpc_create_transport_decoder), 2633 ctx)) { 2634 SPDK_ERRLOG("spdk_json_decode_object_relaxed failed\n"); 2635 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2636 nvmf_rpc_create_transport_ctx_free(ctx); 2637 return; 2638 } 2639 2640 if (spdk_nvmf_tgt_get_transport(tgt, ctx->trtype)) { 2641 SPDK_ERRLOG("Transport type '%s' already exists\n", ctx->trtype); 2642 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2643 "Transport type '%s' already exists", ctx->trtype); 2644 nvmf_rpc_create_transport_ctx_free(ctx); 2645 return; 2646 } 2647 2648 /* Transport can parse additional params themselves */ 2649 ctx->opts.transport_specific = params; 2650 ctx->request = request; 2651 2652 rc = spdk_nvmf_transport_create_async(ctx->trtype, &ctx->opts, nvmf_rpc_create_transport_done, ctx); 2653 if (rc) { 2654 SPDK_ERRLOG("Transport type '%s' create failed\n", ctx->trtype); 2655 spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2656 "Transport type '%s' create failed", ctx->trtype); 2657 nvmf_rpc_create_transport_ctx_free(ctx); 2658 } 2659 } 2660 SPDK_RPC_REGISTER("nvmf_create_transport", rpc_nvmf_create_transport, SPDK_RPC_RUNTIME) 2661 2662 struct rpc_get_transport { 2663 char *trtype; 2664 char *tgt_name; 2665 }; 2666 2667 static const struct spdk_json_object_decoder rpc_get_transport_decoders[] = { 2668 {"trtype", offsetof(struct rpc_get_transport, trtype), spdk_json_decode_string, true}, 2669 {"tgt_name", offsetof(struct rpc_get_transport, tgt_name), spdk_json_decode_string, true}, 2670 }; 2671 2672 static void 2673 rpc_nvmf_get_transports(struct spdk_jsonrpc_request *request, 2674 const struct spdk_json_val *params) 2675 { 2676 struct rpc_get_transport req = { 0 }; 2677 struct spdk_json_write_ctx *w; 2678 struct spdk_nvmf_transport *transport = NULL; 2679 struct spdk_nvmf_tgt *tgt; 2680 2681 if (params) { 2682 if (spdk_json_decode_object(params, rpc_get_transport_decoders, 2683 SPDK_COUNTOF(rpc_get_transport_decoders), 2684 &req)) { 2685 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2686 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2687 return; 2688 } 2689 } 2690 2691 tgt = spdk_nvmf_get_tgt(req.tgt_name); 2692 if (!tgt) { 2693 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2694 "Unable to find a target."); 2695 free(req.trtype); 2696 free(req.tgt_name); 2697 return; 2698 } 2699 2700 if (req.trtype) { 2701 transport = spdk_nvmf_tgt_get_transport(tgt, req.trtype); 2702 if (transport == NULL) { 2703 SPDK_ERRLOG("transport '%s' does not exist\n", req.trtype); 2704 spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV)); 2705 free(req.trtype); 2706 free(req.tgt_name); 2707 return; 2708 } 2709 } 2710 2711 w = spdk_jsonrpc_begin_result(request); 2712 spdk_json_write_array_begin(w); 2713 2714 if (transport) { 2715 nvmf_transport_dump_opts(transport, w, false); 2716 } else { 2717 for (transport = spdk_nvmf_transport_get_first(tgt); transport != NULL; 2718 transport = spdk_nvmf_transport_get_next(transport)) { 2719 nvmf_transport_dump_opts(transport, w, false); 2720 } 2721 } 2722 2723 spdk_json_write_array_end(w); 2724 spdk_jsonrpc_end_result(request, w); 2725 free(req.trtype); 2726 free(req.tgt_name); 2727 } 2728 SPDK_RPC_REGISTER("nvmf_get_transports", rpc_nvmf_get_transports, SPDK_RPC_RUNTIME) 2729 2730 struct rpc_nvmf_get_stats_ctx { 2731 char *tgt_name; 2732 struct spdk_nvmf_tgt *tgt; 2733 struct spdk_jsonrpc_request *request; 2734 struct spdk_json_write_ctx *w; 2735 }; 2736 2737 static const struct spdk_json_object_decoder rpc_get_stats_decoders[] = { 2738 {"tgt_name", offsetof(struct rpc_nvmf_get_stats_ctx, tgt_name), spdk_json_decode_string, true}, 2739 }; 2740 2741 static void 2742 free_get_stats_ctx(struct rpc_nvmf_get_stats_ctx *ctx) 2743 { 2744 free(ctx->tgt_name); 2745 free(ctx); 2746 } 2747 2748 static void 2749 rpc_nvmf_get_stats_done(struct spdk_io_channel_iter *i, int status) 2750 { 2751 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2752 2753 spdk_json_write_array_end(ctx->w); 2754 spdk_json_write_object_end(ctx->w); 2755 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2756 free_get_stats_ctx(ctx); 2757 } 2758 2759 static void 2760 _rpc_nvmf_get_stats(struct spdk_io_channel_iter *i) 2761 { 2762 struct rpc_nvmf_get_stats_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2763 struct spdk_io_channel *ch; 2764 struct spdk_nvmf_poll_group *group; 2765 2766 ch = spdk_get_io_channel(ctx->tgt); 2767 group = spdk_io_channel_get_ctx(ch); 2768 2769 spdk_nvmf_poll_group_dump_stat(group, ctx->w); 2770 2771 spdk_put_io_channel(ch); 2772 spdk_for_each_channel_continue(i, 0); 2773 } 2774 2775 2776 static void 2777 rpc_nvmf_get_stats(struct spdk_jsonrpc_request *request, 2778 const struct spdk_json_val *params) 2779 { 2780 struct rpc_nvmf_get_stats_ctx *ctx; 2781 2782 ctx = calloc(1, sizeof(*ctx)); 2783 if (!ctx) { 2784 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2785 "Memory allocation error"); 2786 return; 2787 } 2788 ctx->request = request; 2789 2790 if (params) { 2791 if (spdk_json_decode_object(params, rpc_get_stats_decoders, 2792 SPDK_COUNTOF(rpc_get_stats_decoders), 2793 ctx)) { 2794 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 2795 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 2796 free_get_stats_ctx(ctx); 2797 return; 2798 } 2799 } 2800 2801 ctx->tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 2802 if (!ctx->tgt) { 2803 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 2804 "Unable to find a target."); 2805 free_get_stats_ctx(ctx); 2806 return; 2807 } 2808 2809 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 2810 spdk_json_write_object_begin(ctx->w); 2811 spdk_json_write_named_uint64(ctx->w, "tick_rate", spdk_get_ticks_hz()); 2812 spdk_json_write_named_array_begin(ctx->w, "poll_groups"); 2813 2814 spdk_for_each_channel(ctx->tgt, 2815 _rpc_nvmf_get_stats, 2816 ctx, 2817 rpc_nvmf_get_stats_done); 2818 } 2819 2820 SPDK_RPC_REGISTER("nvmf_get_stats", rpc_nvmf_get_stats, SPDK_RPC_RUNTIME) 2821 2822 static void 2823 dump_nvmf_ctrlr(struct spdk_json_write_ctx *w, struct spdk_nvmf_ctrlr *ctrlr) 2824 { 2825 uint32_t count; 2826 2827 spdk_json_write_object_begin(w); 2828 2829 spdk_json_write_named_uint32(w, "cntlid", ctrlr->cntlid); 2830 spdk_json_write_named_string(w, "hostnqn", ctrlr->hostnqn); 2831 spdk_json_write_named_uuid(w, "hostid", &ctrlr->hostid); 2832 2833 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 2834 spdk_json_write_named_uint32(w, "num_io_qpairs", count); 2835 2836 spdk_json_write_object_end(w); 2837 } 2838 2839 static const char * 2840 nvmf_qpair_state_str(enum spdk_nvmf_qpair_state state) 2841 { 2842 switch (state) { 2843 case SPDK_NVMF_QPAIR_UNINITIALIZED: 2844 return "uninitialized"; 2845 case SPDK_NVMF_QPAIR_CONNECTING: 2846 return "connecting"; 2847 case SPDK_NVMF_QPAIR_ENABLED: 2848 return "enabled"; 2849 case SPDK_NVMF_QPAIR_DEACTIVATING: 2850 return "deactivating"; 2851 case SPDK_NVMF_QPAIR_ERROR: 2852 return "error"; 2853 default: 2854 return NULL; 2855 } 2856 } 2857 2858 static void 2859 dump_nvmf_qpair(struct spdk_json_write_ctx *w, struct spdk_nvmf_qpair *qpair) 2860 { 2861 struct spdk_nvme_transport_id trid = {}; 2862 2863 spdk_json_write_object_begin(w); 2864 2865 spdk_json_write_named_uint32(w, "cntlid", qpair->ctrlr->cntlid); 2866 spdk_json_write_named_uint32(w, "qid", qpair->qid); 2867 spdk_json_write_named_string(w, "state", nvmf_qpair_state_str(qpair->state)); 2868 spdk_json_write_named_string(w, "thread", spdk_thread_get_name(spdk_get_thread())); 2869 spdk_json_write_named_string(w, "hostnqn", qpair->ctrlr->hostnqn); 2870 2871 if (spdk_nvmf_qpair_get_listen_trid(qpair, &trid) == 0) { 2872 spdk_json_write_named_object_begin(w, "listen_address"); 2873 nvmf_transport_listen_dump_trid(&trid, w); 2874 spdk_json_write_object_end(w); 2875 if (qpair->transport->ops->listen_dump_opts) { 2876 qpair->transport->ops->listen_dump_opts(qpair->transport, &trid, w); 2877 } 2878 } 2879 2880 memset(&trid, 0, sizeof(trid)); 2881 if (spdk_nvmf_qpair_get_peer_trid(qpair, &trid) == 0) { 2882 spdk_json_write_named_object_begin(w, "peer_address"); 2883 nvmf_transport_listen_dump_trid(&trid, w); 2884 spdk_json_write_object_end(w); 2885 } 2886 2887 nvmf_qpair_auth_dump(qpair, w); 2888 spdk_json_write_object_end(w); 2889 } 2890 2891 static const char * 2892 nvme_ana_state_str(enum spdk_nvme_ana_state ana_state) 2893 { 2894 switch (ana_state) { 2895 case SPDK_NVME_ANA_OPTIMIZED_STATE: 2896 return "optimized"; 2897 case SPDK_NVME_ANA_NON_OPTIMIZED_STATE: 2898 return "non_optimized"; 2899 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 2900 return "inaccessible"; 2901 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 2902 return "persistent_loss"; 2903 case SPDK_NVME_ANA_CHANGE_STATE: 2904 return "change"; 2905 default: 2906 return NULL; 2907 } 2908 } 2909 2910 static void 2911 dump_nvmf_subsystem_listener(struct spdk_json_write_ctx *w, 2912 struct spdk_nvmf_subsystem_listener *listener) 2913 { 2914 const struct spdk_nvme_transport_id *trid = listener->trid; 2915 uint32_t i; 2916 2917 spdk_json_write_object_begin(w); 2918 2919 spdk_json_write_named_object_begin(w, "address"); 2920 nvmf_transport_listen_dump_trid(trid, w); 2921 spdk_json_write_object_end(w); 2922 2923 if (spdk_nvmf_subsystem_get_ana_reporting(listener->subsystem)) { 2924 spdk_json_write_named_array_begin(w, "ana_states"); 2925 for (i = 0; i < listener->subsystem->max_nsid; i++) { 2926 spdk_json_write_object_begin(w); 2927 spdk_json_write_named_uint32(w, "ana_group", i + 1); 2928 spdk_json_write_named_string(w, "ana_state", 2929 nvme_ana_state_str(listener->ana_state[i])); 2930 spdk_json_write_object_end(w); 2931 } 2932 spdk_json_write_array_end(w); 2933 } 2934 2935 spdk_json_write_object_end(w); 2936 } 2937 2938 struct rpc_subsystem_query_ctx { 2939 char *nqn; 2940 char *tgt_name; 2941 struct spdk_nvmf_subsystem *subsystem; 2942 struct spdk_jsonrpc_request *request; 2943 struct spdk_json_write_ctx *w; 2944 }; 2945 2946 static const struct spdk_json_object_decoder rpc_subsystem_query_decoders[] = { 2947 {"nqn", offsetof(struct rpc_subsystem_query_ctx, nqn), spdk_json_decode_string}, 2948 {"tgt_name", offsetof(struct rpc_subsystem_query_ctx, tgt_name), spdk_json_decode_string, true}, 2949 }; 2950 2951 static void 2952 free_rpc_subsystem_query_ctx(struct rpc_subsystem_query_ctx *ctx) 2953 { 2954 free(ctx->nqn); 2955 free(ctx->tgt_name); 2956 free(ctx); 2957 } 2958 2959 static void 2960 rpc_nvmf_get_controllers_paused(struct spdk_nvmf_subsystem *subsystem, 2961 void *cb_arg, int status) 2962 { 2963 struct rpc_subsystem_query_ctx *ctx = cb_arg; 2964 struct spdk_json_write_ctx *w; 2965 struct spdk_nvmf_ctrlr *ctrlr; 2966 2967 w = spdk_jsonrpc_begin_result(ctx->request); 2968 2969 spdk_json_write_array_begin(w); 2970 TAILQ_FOREACH(ctrlr, &ctx->subsystem->ctrlrs, link) { 2971 dump_nvmf_ctrlr(w, ctrlr); 2972 } 2973 spdk_json_write_array_end(w); 2974 2975 spdk_jsonrpc_end_result(ctx->request, w); 2976 2977 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2978 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2979 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2980 } 2981 2982 free_rpc_subsystem_query_ctx(ctx); 2983 } 2984 2985 static void 2986 rpc_nvmf_get_qpairs_done(struct spdk_io_channel_iter *i, int status) 2987 { 2988 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2989 2990 spdk_json_write_array_end(ctx->w); 2991 spdk_jsonrpc_end_result(ctx->request, ctx->w); 2992 2993 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 2994 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 2995 /* FIXME: RPC should fail if resuming the subsystem failed. */ 2996 } 2997 2998 free_rpc_subsystem_query_ctx(ctx); 2999 } 3000 3001 static void 3002 rpc_nvmf_get_qpairs(struct spdk_io_channel_iter *i) 3003 { 3004 struct rpc_subsystem_query_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 3005 struct spdk_io_channel *ch; 3006 struct spdk_nvmf_poll_group *group; 3007 struct spdk_nvmf_qpair *qpair; 3008 3009 ch = spdk_io_channel_iter_get_channel(i); 3010 group = spdk_io_channel_get_ctx(ch); 3011 3012 TAILQ_FOREACH(qpair, &group->qpairs, link) { 3013 if (qpair->ctrlr->subsys == ctx->subsystem) { 3014 dump_nvmf_qpair(ctx->w, qpair); 3015 } 3016 } 3017 3018 spdk_for_each_channel_continue(i, 0); 3019 } 3020 3021 static void 3022 rpc_nvmf_get_qpairs_paused(struct spdk_nvmf_subsystem *subsystem, 3023 void *cb_arg, int status) 3024 { 3025 struct rpc_subsystem_query_ctx *ctx = cb_arg; 3026 3027 ctx->w = spdk_jsonrpc_begin_result(ctx->request); 3028 3029 spdk_json_write_array_begin(ctx->w); 3030 3031 spdk_for_each_channel(ctx->subsystem->tgt, 3032 rpc_nvmf_get_qpairs, 3033 ctx, 3034 rpc_nvmf_get_qpairs_done); 3035 } 3036 3037 static void 3038 rpc_nvmf_get_listeners_paused(struct spdk_nvmf_subsystem *subsystem, 3039 void *cb_arg, int status) 3040 { 3041 struct rpc_subsystem_query_ctx *ctx = cb_arg; 3042 struct spdk_json_write_ctx *w; 3043 struct spdk_nvmf_subsystem_listener *listener; 3044 3045 w = spdk_jsonrpc_begin_result(ctx->request); 3046 3047 spdk_json_write_array_begin(w); 3048 3049 for (listener = spdk_nvmf_subsystem_get_first_listener(ctx->subsystem); 3050 listener != NULL; 3051 listener = spdk_nvmf_subsystem_get_next_listener(ctx->subsystem, listener)) { 3052 dump_nvmf_subsystem_listener(w, listener); 3053 } 3054 spdk_json_write_array_end(w); 3055 3056 spdk_jsonrpc_end_result(ctx->request, w); 3057 3058 if (spdk_nvmf_subsystem_resume(ctx->subsystem, NULL, NULL)) { 3059 SPDK_ERRLOG("Resuming subsystem with NQN %s failed\n", ctx->nqn); 3060 /* FIXME: RPC should fail if resuming the subsystem failed. */ 3061 } 3062 3063 free_rpc_subsystem_query_ctx(ctx); 3064 } 3065 3066 static void 3067 _rpc_nvmf_subsystem_query(struct spdk_jsonrpc_request *request, 3068 const struct spdk_json_val *params, 3069 spdk_nvmf_subsystem_state_change_done cb_fn) 3070 { 3071 struct rpc_subsystem_query_ctx *ctx; 3072 struct spdk_nvmf_subsystem *subsystem; 3073 struct spdk_nvmf_tgt *tgt; 3074 3075 ctx = calloc(1, sizeof(*ctx)); 3076 if (!ctx) { 3077 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 3078 "Out of memory"); 3079 return; 3080 } 3081 3082 ctx->request = request; 3083 3084 if (spdk_json_decode_object(params, rpc_subsystem_query_decoders, 3085 SPDK_COUNTOF(rpc_subsystem_query_decoders), 3086 ctx)) { 3087 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 3088 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 3089 "Invalid parameters"); 3090 free_rpc_subsystem_query_ctx(ctx); 3091 return; 3092 } 3093 3094 tgt = spdk_nvmf_get_tgt(ctx->tgt_name); 3095 if (!tgt) { 3096 SPDK_ERRLOG("Unable to find a target object.\n"); 3097 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 3098 "Unable to find a target"); 3099 free_rpc_subsystem_query_ctx(ctx); 3100 return; 3101 } 3102 3103 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, ctx->nqn); 3104 if (!subsystem) { 3105 SPDK_ERRLOG("Unable to find subsystem with NQN %s\n", ctx->nqn); 3106 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, 3107 "Invalid parameters"); 3108 free_rpc_subsystem_query_ctx(ctx); 3109 return; 3110 } 3111 3112 ctx->subsystem = subsystem; 3113 3114 if (spdk_nvmf_subsystem_pause(subsystem, 0, cb_fn, ctx)) { 3115 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 3116 "Internal error"); 3117 free_rpc_subsystem_query_ctx(ctx); 3118 return; 3119 } 3120 } 3121 3122 static void 3123 rpc_nvmf_subsystem_get_controllers(struct spdk_jsonrpc_request *request, 3124 const struct spdk_json_val *params) 3125 { 3126 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_controllers_paused); 3127 } 3128 SPDK_RPC_REGISTER("nvmf_subsystem_get_controllers", rpc_nvmf_subsystem_get_controllers, 3129 SPDK_RPC_RUNTIME); 3130 3131 static void 3132 rpc_nvmf_subsystem_get_qpairs(struct spdk_jsonrpc_request *request, 3133 const struct spdk_json_val *params) 3134 { 3135 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_qpairs_paused); 3136 } 3137 SPDK_RPC_REGISTER("nvmf_subsystem_get_qpairs", rpc_nvmf_subsystem_get_qpairs, SPDK_RPC_RUNTIME); 3138 3139 static void 3140 rpc_nvmf_subsystem_get_listeners(struct spdk_jsonrpc_request *request, 3141 const struct spdk_json_val *params) 3142 { 3143 _rpc_nvmf_subsystem_query(request, params, rpc_nvmf_get_listeners_paused); 3144 } 3145 SPDK_RPC_REGISTER("nvmf_subsystem_get_listeners", rpc_nvmf_subsystem_get_listeners, 3146 SPDK_RPC_RUNTIME); 3147 3148 struct rpc_mdns_prr { 3149 char *tgt_name; 3150 }; 3151 3152 static const struct spdk_json_object_decoder rpc_mdns_prr_decoders[] = { 3153 {"tgt_name", offsetof(struct rpc_mdns_prr, tgt_name), spdk_json_decode_string, true}, 3154 }; 3155 3156 static void 3157 rpc_nvmf_publish_mdns_prr(struct spdk_jsonrpc_request *request, 3158 const struct spdk_json_val *params) 3159 { 3160 int rc; 3161 struct rpc_mdns_prr req = { 0 }; 3162 struct spdk_nvmf_tgt *tgt; 3163 3164 if (params) { 3165 if (spdk_json_decode_object(params, rpc_mdns_prr_decoders, 3166 SPDK_COUNTOF(rpc_mdns_prr_decoders), 3167 &req)) { 3168 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 3169 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 3170 return; 3171 } 3172 } 3173 3174 tgt = spdk_nvmf_get_tgt(req.tgt_name); 3175 if (!tgt) { 3176 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 3177 "Unable to find a target."); 3178 free(req.tgt_name); 3179 return; 3180 } 3181 3182 rc = nvmf_publish_mdns_prr(tgt); 3183 if (rc) { 3184 spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); 3185 free(req.tgt_name); 3186 return; 3187 } 3188 3189 spdk_jsonrpc_send_bool_response(request, true); 3190 free(req.tgt_name); 3191 } 3192 SPDK_RPC_REGISTER("nvmf_publish_mdns_prr", rpc_nvmf_publish_mdns_prr, SPDK_RPC_RUNTIME); 3193 3194 static void 3195 rpc_nvmf_stop_mdns_prr(struct spdk_jsonrpc_request *request, 3196 const struct spdk_json_val *params) 3197 { 3198 struct rpc_mdns_prr req = { 0 }; 3199 struct spdk_nvmf_tgt *tgt; 3200 3201 if (params) { 3202 if (spdk_json_decode_object(params, rpc_mdns_prr_decoders, 3203 SPDK_COUNTOF(rpc_mdns_prr_decoders), 3204 &req)) { 3205 SPDK_ERRLOG("spdk_json_decode_object failed\n"); 3206 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); 3207 return; 3208 } 3209 } 3210 3211 tgt = spdk_nvmf_get_tgt(req.tgt_name); 3212 if (!tgt) { 3213 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 3214 "Unable to find a target."); 3215 free(req.tgt_name); 3216 return; 3217 } 3218 3219 nvmf_tgt_stop_mdns_prr(tgt); 3220 3221 spdk_jsonrpc_send_bool_response(request, true); 3222 free(req.tgt_name); 3223 } 3224 SPDK_RPC_REGISTER("nvmf_stop_mdns_prr", rpc_nvmf_stop_mdns_prr, SPDK_RPC_RUNTIME); 3225