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