Line data Source code
1 : /* SPDX-License-Identifier: BSD-3-Clause
2 : * Copyright (C) 2020 Intel Corporation.
3 : * Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
4 : * All rights reserved.
5 : * Copyright 2023 Solidigm All Rights Reserved
6 : */
7 :
8 : #include "spdk/rpc.h"
9 : #include "spdk/util.h"
10 : #include "spdk/bdev_module.h"
11 : #include "spdk/string.h"
12 : #include "spdk/log.h"
13 :
14 : #include "bdev_ftl.h"
15 :
16 : static void
17 0 : rpc_bdev_ftl_basic_cb(void *cb_arg, int bdeverrno)
18 : {
19 0 : struct spdk_jsonrpc_request *request = cb_arg;
20 :
21 0 : if (bdeverrno == 0) {
22 0 : spdk_jsonrpc_send_bool_response(request, true);
23 : } else {
24 0 : spdk_jsonrpc_send_error_response(request, bdeverrno, spdk_strerror(-bdeverrno));
25 : }
26 0 : }
27 :
28 : struct rpc_ftl_basic_param {
29 : char *name;
30 : };
31 :
32 : static const struct spdk_json_object_decoder rpc_ftl_basic_decoders[] = {
33 : {"name", offsetof(struct rpc_ftl_basic_param, name), spdk_json_decode_string},
34 : };
35 :
36 : static const struct spdk_json_object_decoder rpc_bdev_ftl_create_decoders[] = {
37 : {"name", offsetof(struct spdk_ftl_conf, name), spdk_json_decode_string},
38 : {"base_bdev", offsetof(struct spdk_ftl_conf, base_bdev), spdk_json_decode_string},
39 : {"uuid", offsetof(struct spdk_ftl_conf, uuid), spdk_json_decode_uuid, true},
40 : {"cache", offsetof(struct spdk_ftl_conf, cache_bdev), spdk_json_decode_string},
41 : {
42 : "overprovisioning", offsetof(struct spdk_ftl_conf, overprovisioning),
43 : spdk_json_decode_uint64, true
44 : },
45 : {
46 : "l2p_dram_limit", offsetof(struct spdk_ftl_conf, l2p_dram_limit),
47 : spdk_json_decode_uint64, true
48 : },
49 : {
50 : "core_mask", offsetof(struct spdk_ftl_conf, core_mask),
51 : spdk_json_decode_string, true
52 : },
53 : {
54 : "fast_shutdown", offsetof(struct spdk_ftl_conf, fast_shutdown),
55 : spdk_json_decode_bool, true
56 : },
57 : };
58 :
59 : static void
60 0 : rpc_bdev_ftl_create_cb(const struct ftl_bdev_info *bdev_info, void *ctx, int status)
61 : {
62 0 : struct spdk_jsonrpc_request *request = ctx;
63 : struct spdk_json_write_ctx *w;
64 :
65 0 : if (status) {
66 0 : spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
67 : "Failed to create FTL bdev: %s",
68 : spdk_strerror(-status));
69 0 : return;
70 : }
71 :
72 0 : w = spdk_jsonrpc_begin_result(request);
73 0 : spdk_json_write_object_begin(w);
74 0 : spdk_json_write_named_string(w, "name", bdev_info->name);
75 0 : spdk_json_write_named_uuid(w, "uuid", &bdev_info->uuid);
76 0 : spdk_json_write_object_end(w);
77 0 : spdk_jsonrpc_end_result(request, w);
78 : }
79 :
80 : static void
81 0 : rpc_bdev_ftl_create(struct spdk_jsonrpc_request *request,
82 : const struct spdk_json_val *params)
83 : {
84 0 : struct spdk_ftl_conf conf = {};
85 : struct spdk_json_write_ctx *w;
86 : int rc;
87 :
88 0 : spdk_ftl_get_default_conf(&conf, sizeof(conf));
89 :
90 0 : if (spdk_json_decode_object(params, rpc_bdev_ftl_create_decoders,
91 : SPDK_COUNTOF(rpc_bdev_ftl_create_decoders),
92 : &conf)) {
93 0 : spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
94 : "Invalid parameters");
95 0 : goto out;
96 : }
97 :
98 0 : if (spdk_uuid_is_null(&conf.uuid)) {
99 0 : conf.mode |= SPDK_FTL_MODE_CREATE;
100 : }
101 :
102 0 : if (spdk_bdev_get_by_name(conf.name) != NULL) {
103 0 : SPDK_ERRLOG("Bdev \"%s\" already exists", conf.name);
104 0 : spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
105 : "Failed to create FTL bdev: %s",
106 : spdk_strerror(EEXIST));
107 0 : goto out;
108 : }
109 :
110 0 : rc = bdev_ftl_create_bdev(&conf, rpc_bdev_ftl_create_cb, request);
111 0 : if (rc == -ENODEV) {
112 0 : rc = bdev_ftl_defer_init(&conf);
113 0 : if (rc == 0) {
114 0 : w = spdk_jsonrpc_begin_result(request);
115 0 : spdk_json_write_string_fmt(w, "FTL bdev: %s creation deferred", conf.name);
116 0 : spdk_jsonrpc_end_result(request, w);
117 : }
118 : }
119 :
120 0 : if (rc) {
121 0 : spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
122 : "Failed to create FTL bdev: %s",
123 : spdk_strerror(-rc));
124 : }
125 0 : out:
126 0 : spdk_ftl_conf_deinit(&conf);
127 0 : }
128 0 : SPDK_RPC_REGISTER("bdev_ftl_create", rpc_bdev_ftl_create, SPDK_RPC_RUNTIME)
129 :
130 : static void
131 0 : rpc_bdev_ftl_load(struct spdk_jsonrpc_request *request,
132 : const struct spdk_json_val *params)
133 : {
134 0 : rpc_bdev_ftl_create(request, params);
135 0 : }
136 0 : SPDK_RPC_REGISTER("bdev_ftl_load", rpc_bdev_ftl_load, SPDK_RPC_RUNTIME)
137 :
138 : struct rpc_delete_ftl {
139 : char *name;
140 : bool fast_shutdown;
141 : };
142 :
143 : static const struct spdk_json_object_decoder rpc_delete_ftl_decoders[] = {
144 : {"name", offsetof(struct rpc_delete_ftl, name), spdk_json_decode_string},
145 : {
146 : "fast_shutdown", offsetof(struct rpc_delete_ftl, fast_shutdown),
147 : spdk_json_decode_bool, true
148 : },
149 : };
150 :
151 : static void
152 0 : rpc_bdev_ftl_delete(struct spdk_jsonrpc_request *request,
153 : const struct spdk_json_val *params)
154 : {
155 0 : struct rpc_delete_ftl attrs = {};
156 :
157 0 : if (spdk_json_decode_object(params, rpc_delete_ftl_decoders,
158 : SPDK_COUNTOF(rpc_delete_ftl_decoders),
159 : &attrs)) {
160 0 : spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
161 : "Invalid parameters");
162 0 : goto invalid;
163 : }
164 :
165 0 : bdev_ftl_delete_bdev(attrs.name, attrs.fast_shutdown, rpc_bdev_ftl_basic_cb, request);
166 0 : invalid:
167 0 : free(attrs.name);
168 0 : }
169 0 : SPDK_RPC_REGISTER("bdev_ftl_delete", rpc_bdev_ftl_delete, SPDK_RPC_RUNTIME)
170 :
171 : static void
172 0 : rpc_bdev_ftl_unload(struct spdk_jsonrpc_request *request,
173 : const struct spdk_json_val *params)
174 : {
175 0 : rpc_bdev_ftl_delete(request, params);
176 0 : }
177 0 : SPDK_RPC_REGISTER("bdev_ftl_unload", rpc_bdev_ftl_unload, SPDK_RPC_RUNTIME)
178 :
179 : struct rpc_ftl_unmap {
180 : char *name;
181 : uint64_t lba;
182 : uint64_t num_blocks;
183 : };
184 :
185 : static const struct spdk_json_object_decoder rpc_ftl_unmap_decoders[] = {
186 : {"name", offsetof(struct rpc_delete_ftl, name), spdk_json_decode_string},
187 : {"lba", offsetof(struct rpc_ftl_unmap, lba), spdk_json_decode_uint64, true},
188 : {"num_blocks", offsetof(struct rpc_ftl_unmap, num_blocks), spdk_json_decode_uint64, true},
189 : };
190 :
191 :
192 : static void
193 0 : rpc_bdev_ftl_unmap(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params)
194 : {
195 0 : struct rpc_ftl_unmap attrs = {};
196 :
197 0 : if (spdk_json_decode_object(params, rpc_ftl_unmap_decoders, SPDK_COUNTOF(rpc_ftl_unmap_decoders),
198 : &attrs)) {
199 0 : spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
200 : } else {
201 0 : bdev_ftl_unmap(attrs.name, attrs.lba, attrs.num_blocks, rpc_bdev_ftl_basic_cb, request);
202 : }
203 0 : free(attrs.name);
204 0 : }
205 :
206 0 : SPDK_RPC_REGISTER("bdev_ftl_unmap", rpc_bdev_ftl_unmap, SPDK_RPC_RUNTIME)
207 :
208 : static void
209 0 : _rpc_bdev_ftl_get_stats(void *ctx, int rc)
210 : {
211 0 : struct rpc_ftl_stats_ctx *ftl_stats_ctx = ctx;
212 0 : struct spdk_jsonrpc_request *request = ftl_stats_ctx->request;
213 0 : struct ftl_stats *stats = &ftl_stats_ctx->ftl_stats;
214 : struct spdk_json_write_ctx *w;
215 :
216 0 : if (rc) {
217 0 : free(ftl_stats_ctx);
218 0 : spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
219 0 : return;
220 : }
221 :
222 0 : w = spdk_jsonrpc_begin_result(request);
223 0 : spdk_json_write_object_begin(w);
224 0 : spdk_json_write_named_string(w, "name",
225 0 : spdk_bdev_desc_get_bdev(ftl_stats_ctx->ftl_bdev_desc)->name);
226 :
227 : /* TODO: Instead of named objects, store them in an array with the name being an attribute */
228 0 : for (uint64_t i = 0; i < FTL_STATS_TYPE_MAX; i++) {
229 0 : switch (i) {
230 0 : case FTL_STATS_TYPE_USER:
231 0 : spdk_json_write_named_object_begin(w, "user");
232 0 : break;
233 0 : case FTL_STATS_TYPE_CMP:
234 0 : spdk_json_write_named_object_begin(w, "cmp");
235 0 : break;
236 0 : case FTL_STATS_TYPE_GC:
237 0 : spdk_json_write_named_object_begin(w, "gc");
238 0 : break;
239 0 : case FTL_STATS_TYPE_MD_BASE:
240 0 : spdk_json_write_named_object_begin(w, "md_base");
241 0 : break;
242 0 : case FTL_STATS_TYPE_MD_NV_CACHE:
243 0 : spdk_json_write_named_object_begin(w, "md_nv_cache");
244 0 : break;
245 0 : case FTL_STATS_TYPE_L2P:
246 0 : spdk_json_write_named_object_begin(w, "l2p");
247 0 : break;
248 0 : default:
249 0 : assert(false);
250 : continue;
251 : }
252 :
253 0 : spdk_json_write_named_object_begin(w, "read");
254 0 : spdk_json_write_named_uint64(w, "ios", stats->entries[i].read.ios);
255 0 : spdk_json_write_named_uint64(w, "blocks", stats->entries[i].read.blocks);
256 0 : spdk_json_write_named_object_begin(w, "errors");
257 0 : spdk_json_write_named_uint64(w, "media", stats->entries[i].read.errors.media);
258 0 : spdk_json_write_named_uint64(w, "crc", stats->entries[i].read.errors.crc);
259 0 : spdk_json_write_named_uint64(w, "other", stats->entries[i].read.errors.other);
260 0 : spdk_json_write_object_end(w);
261 0 : spdk_json_write_object_end(w);
262 :
263 0 : spdk_json_write_named_object_begin(w, "write");
264 0 : spdk_json_write_named_uint64(w, "ios", stats->entries[i].write.ios);
265 0 : spdk_json_write_named_uint64(w, "blocks", stats->entries[i].write.blocks);
266 0 : spdk_json_write_named_object_begin(w, "errors");
267 0 : spdk_json_write_named_uint64(w, "media", stats->entries[i].write.errors.media);
268 0 : spdk_json_write_named_uint64(w, "other", stats->entries[i].write.errors.other);
269 0 : spdk_json_write_object_end(w);
270 0 : spdk_json_write_object_end(w);
271 :
272 0 : spdk_json_write_object_end(w);
273 : }
274 :
275 0 : spdk_json_write_object_end(w);
276 0 : spdk_jsonrpc_end_result(request, w);
277 0 : free(ftl_stats_ctx);
278 : }
279 :
280 : static void
281 0 : rpc_bdev_ftl_get_stats(struct spdk_jsonrpc_request *request,
282 : const struct spdk_json_val *params)
283 : {
284 0 : struct rpc_ftl_basic_param attrs = {};
285 0 : struct rpc_ftl_stats_ctx *ctx = calloc(1, sizeof(*ctx));
286 :
287 0 : if (!ctx) {
288 0 : spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(-ENOMEM));
289 0 : return;
290 : }
291 :
292 0 : if (spdk_json_decode_object(params, rpc_ftl_basic_decoders, SPDK_COUNTOF(rpc_ftl_basic_decoders),
293 : &attrs)) {
294 0 : spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
295 0 : free(ctx);
296 0 : free(attrs.name);
297 0 : return;
298 : }
299 :
300 0 : ctx->request = request;
301 0 : bdev_ftl_get_stats(attrs.name, _rpc_bdev_ftl_get_stats, ctx);
302 0 : free(attrs.name);
303 : }
304 :
305 0 : SPDK_RPC_REGISTER("bdev_ftl_get_stats", rpc_bdev_ftl_get_stats, SPDK_RPC_RUNTIME)
306 :
307 : static void
308 0 : rpc_bdev_ftl_get_properties_cb(void *ctx, int rc)
309 : {
310 0 : struct spdk_jsonrpc_request *request = ctx;
311 :
312 0 : if (rc) {
313 0 : spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
314 : }
315 0 : }
316 :
317 : static void
318 0 : rpc_bdev_ftl_get_properties(struct spdk_jsonrpc_request *request,
319 : const struct spdk_json_val *params)
320 : {
321 0 : struct rpc_ftl_basic_param attrs = {};
322 :
323 0 : if (spdk_json_decode_object(params, rpc_ftl_basic_decoders, SPDK_COUNTOF(rpc_ftl_basic_decoders),
324 : &attrs)) {
325 0 : spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
326 0 : free(attrs.name);
327 0 : return;
328 : }
329 :
330 0 : bdev_ftl_get_properties(attrs.name, rpc_bdev_ftl_get_properties_cb, request);
331 0 : free(attrs.name);
332 : }
333 :
334 0 : SPDK_RPC_REGISTER("bdev_ftl_get_properties", rpc_bdev_ftl_get_properties, SPDK_RPC_RUNTIME)
335 :
336 : struct rpc_ftl_set_property_param {
337 : char *name;
338 : char *ftl_property;
339 : char *value;
340 : };
341 :
342 : static const struct spdk_json_object_decoder rpc_ftl_set_property_decoders[] = {
343 : {"name", offsetof(struct rpc_ftl_set_property_param, name), spdk_json_decode_string},
344 : {"ftl_property", offsetof(struct rpc_ftl_set_property_param, ftl_property), spdk_json_decode_string},
345 : {"value", offsetof(struct rpc_ftl_set_property_param, value), spdk_json_decode_string},
346 : };
347 :
348 : static void
349 0 : rpc_bdev_ftl_set_property(struct spdk_jsonrpc_request *request,
350 : const struct spdk_json_val *params)
351 : {
352 0 : struct rpc_ftl_set_property_param attrs = {};
353 :
354 0 : if (spdk_json_decode_object(params, rpc_ftl_set_property_decoders,
355 : SPDK_COUNTOF(rpc_ftl_set_property_decoders),
356 : &attrs)) {
357 0 : spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
358 0 : free(attrs.name);
359 0 : free(attrs.ftl_property);
360 0 : free(attrs.value);
361 0 : return;
362 : }
363 :
364 0 : bdev_ftl_set_property(attrs.name, attrs.ftl_property, attrs.value,
365 : rpc_bdev_ftl_basic_cb, request);
366 0 : free(attrs.name);
367 0 : free(attrs.ftl_property);
368 0 : free(attrs.value);
369 : }
370 :
371 0 : SPDK_RPC_REGISTER("bdev_ftl_set_property", rpc_bdev_ftl_set_property, SPDK_RPC_RUNTIME)
|