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