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