xref: /spdk/module/bdev/xnvme/bdev_xnvme_rpc.c (revision 307b8c112ffd90a26d53dd15fad67bd9038ef526)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (c) Samsung Electronics Co., Ltd.
3  *   All rights reserved.
4  */
5 
6 #include "bdev_xnvme.h"
7 #include "spdk/rpc.h"
8 #include "spdk/util.h"
9 #include "spdk/string.h"
10 #include "spdk/log.h"
11 
12 /* Structure to hold the parameters for this RPC method. */
13 struct rpc_create_xnvme {
14 	char *name;
15 	char *filename;
16 	char *io_mechanism;
17 };
18 
19 /* Free the allocated memory resource after the RPC handling. */
20 static void
21 free_rpc_create_xnvme(struct rpc_create_xnvme *r)
22 {
23 	free(r->name);
24 	free(r->filename);
25 	free(r->io_mechanism);
26 }
27 
28 /* Structure to decode the input parameters for this RPC method. */
29 static const struct spdk_json_object_decoder rpc_create_xnvme_decoders[] = {
30 	{"name", offsetof(struct rpc_create_xnvme, name), spdk_json_decode_string},
31 	{"filename", offsetof(struct rpc_create_xnvme, filename), spdk_json_decode_string},
32 	{"io_mechanism", offsetof(struct rpc_create_xnvme, io_mechanism), spdk_json_decode_string},
33 };
34 
35 static void
36 dummy_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *ctx)
37 {
38 }
39 
40 /* Decode the parameters for this RPC method and properly create the xnvme
41  * device. Error status returned in the failed cases.
42  */
43 static void
44 rpc_bdev_xnvme_create(struct spdk_jsonrpc_request *request,
45 		      const struct spdk_json_val *params)
46 {
47 	struct rpc_create_xnvme req = {};
48 	struct spdk_json_write_ctx *w;
49 	struct spdk_bdev *bdev;
50 
51 	if (spdk_json_decode_object(params, rpc_create_xnvme_decoders,
52 				    SPDK_COUNTOF(rpc_create_xnvme_decoders),
53 				    &req)) {
54 		SPDK_ERRLOG("spdk_json_decode_object failed\n");
55 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
56 						 "spdk_json_decode_object failed");
57 		goto cleanup;
58 	}
59 
60 	bdev = create_xnvme_bdev(req.name, req.filename, req.io_mechanism);
61 	if (!bdev) {
62 		SPDK_ERRLOG("Unable to create xNVMe bdev from file %s\n", req.filename);
63 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
64 						 "Unable to create xNVMe bdev.");
65 		goto cleanup;
66 	}
67 
68 	w = spdk_jsonrpc_begin_result(request);
69 	spdk_json_write_string(w, req.name);
70 	spdk_jsonrpc_end_result(request, w);
71 
72 cleanup:
73 	free_rpc_create_xnvme(&req);
74 }
75 SPDK_RPC_REGISTER("bdev_xnvme_create", rpc_bdev_xnvme_create, SPDK_RPC_RUNTIME)
76 
77 struct rpc_delete_xnvme {
78 	char *name;
79 };
80 
81 static void
82 free_rpc_delete_xnvme(struct rpc_delete_xnvme *req)
83 {
84 	free(req->name);
85 }
86 
87 static const struct spdk_json_object_decoder rpc_delete_xnvme_decoders[] = {
88 	{"name", offsetof(struct rpc_delete_xnvme, name), spdk_json_decode_string},
89 };
90 
91 static void
92 _rpc_bdev_xnvme_delete_cb(void *cb_arg, int bdeverrno)
93 {
94 	struct spdk_jsonrpc_request *request = cb_arg;
95 
96 	spdk_jsonrpc_send_bool_response(request, bdeverrno == 0);
97 }
98 
99 static void
100 rpc_bdev_xnvme_delete(struct spdk_jsonrpc_request *request,
101 		      const struct spdk_json_val *params)
102 {
103 	struct rpc_delete_xnvme req = {NULL};
104 	struct spdk_bdev_desc *desc;
105 	struct spdk_bdev *bdev = NULL;
106 	int rc;
107 
108 	if (spdk_json_decode_object(params, rpc_delete_xnvme_decoders,
109 				    SPDK_COUNTOF(rpc_delete_xnvme_decoders),
110 				    &req)) {
111 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
112 						 "spdk_json_decode_object failed");
113 		goto cleanup;
114 	}
115 
116 	rc = spdk_bdev_open_ext(req.name, false, dummy_bdev_event_cb, NULL, &desc);
117 	if (rc == 0) {
118 		bdev = spdk_bdev_desc_get_bdev(desc);
119 		spdk_bdev_close(desc);
120 	} else {
121 		goto cleanup;
122 	}
123 
124 	if (bdev == NULL) {
125 		spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV));
126 		goto cleanup;
127 	}
128 
129 	delete_xnvme_bdev(bdev, _rpc_bdev_xnvme_delete_cb, request);
130 
131 cleanup:
132 	free_rpc_delete_xnvme(&req);
133 }
134 SPDK_RPC_REGISTER("bdev_xnvme_delete", rpc_bdev_xnvme_delete, SPDK_RPC_RUNTIME)
135