1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2018 Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk/rpc.h" 7 #include "spdk/bdev.h" 8 #include "bdev_raid.h" 9 #include "spdk/util.h" 10 #include "spdk/string.h" 11 #include "spdk/log.h" 12 #include "spdk/env.h" 13 14 #define RPC_MAX_BASE_BDEVS 255 15 16 /* 17 * Input structure for bdev_raid_get_bdevs RPC 18 */ 19 struct rpc_bdev_raid_get_bdevs { 20 /* category - all or online or configuring or offline */ 21 char *category; 22 }; 23 24 /* 25 * brief: 26 * free_rpc_bdev_raid_get_bdevs function frees RPC bdev_raid_get_bdevs related parameters 27 * params: 28 * req - pointer to RPC request 29 * returns: 30 * none 31 */ 32 static void 33 free_rpc_bdev_raid_get_bdevs(struct rpc_bdev_raid_get_bdevs *req) 34 { 35 free(req->category); 36 } 37 38 /* 39 * Decoder object for RPC get_raids 40 */ 41 static const struct spdk_json_object_decoder rpc_bdev_raid_get_bdevs_decoders[] = { 42 {"category", offsetof(struct rpc_bdev_raid_get_bdevs, category), spdk_json_decode_string}, 43 }; 44 45 /* 46 * brief: 47 * rpc_bdev_raid_get_bdevs function is the RPC for rpc_bdev_raid_get_bdevs. This is used to list 48 * all the raid bdev names based on the input category requested. Category should be 49 * one of "all", "online", "configuring" or "offline". "all" means all the raids 50 * whether they are online or configuring or offline. "online" is the raid bdev which 51 * is registered with bdev layer. "configuring" is the raid bdev which does not have 52 * full configuration discovered yet. "offline" is the raid bdev which is not 53 * registered with bdev as of now and it has encountered any error or user has 54 * requested to offline the raid. 55 * params: 56 * request - pointer to json rpc request 57 * params - pointer to request parameters 58 * returns: 59 * none 60 */ 61 static void 62 rpc_bdev_raid_get_bdevs(struct spdk_jsonrpc_request *request, 63 const struct spdk_json_val *params) 64 { 65 struct rpc_bdev_raid_get_bdevs req = {}; 66 struct spdk_json_write_ctx *w; 67 struct raid_bdev *raid_bdev; 68 enum raid_bdev_state state; 69 70 if (spdk_json_decode_object(params, rpc_bdev_raid_get_bdevs_decoders, 71 SPDK_COUNTOF(rpc_bdev_raid_get_bdevs_decoders), 72 &req)) { 73 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_PARSE_ERROR, 74 "spdk_json_decode_object failed"); 75 goto cleanup; 76 } 77 78 state = raid_bdev_str_to_state(req.category); 79 if (state == RAID_BDEV_STATE_MAX && strcmp(req.category, "all") != 0) { 80 spdk_jsonrpc_send_error_response(request, -EINVAL, spdk_strerror(EINVAL)); 81 goto cleanup; 82 } 83 84 w = spdk_jsonrpc_begin_result(request); 85 spdk_json_write_array_begin(w); 86 87 /* Get raid bdev list based on the category requested */ 88 TAILQ_FOREACH(raid_bdev, &g_raid_bdev_list, global_link) { 89 if (raid_bdev->state == state || state == RAID_BDEV_STATE_MAX) { 90 spdk_json_write_object_begin(w); 91 spdk_json_write_named_string(w, "name", raid_bdev->bdev.name); 92 raid_bdev_write_info_json(raid_bdev, w); 93 spdk_json_write_object_end(w); 94 } 95 } 96 spdk_json_write_array_end(w); 97 spdk_jsonrpc_end_result(request, w); 98 99 cleanup: 100 free_rpc_bdev_raid_get_bdevs(&req); 101 } 102 SPDK_RPC_REGISTER("bdev_raid_get_bdevs", rpc_bdev_raid_get_bdevs, SPDK_RPC_RUNTIME) 103 104 /* 105 * Base bdevs in RPC bdev_raid_create 106 */ 107 struct rpc_bdev_raid_create_base_bdevs { 108 /* Number of base bdevs */ 109 size_t num_base_bdevs; 110 111 /* List of base bdevs names */ 112 char *base_bdevs[RPC_MAX_BASE_BDEVS]; 113 }; 114 115 /* 116 * Input structure for RPC rpc_bdev_raid_create 117 */ 118 struct rpc_bdev_raid_create { 119 /* Raid bdev name */ 120 char *name; 121 122 /* RAID strip size in KB */ 123 uint32_t strip_size_kb; 124 125 /* RAID raid level */ 126 enum raid_level level; 127 128 /* Base bdevs information */ 129 struct rpc_bdev_raid_create_base_bdevs base_bdevs; 130 }; 131 132 /* 133 * brief: 134 * free_rpc_bdev_raid_create function is to free RPC bdev_raid_create related parameters 135 * params: 136 * req - pointer to RPC request 137 * returns: 138 * none 139 */ 140 static void 141 free_rpc_bdev_raid_create(struct rpc_bdev_raid_create *req) 142 { 143 size_t i; 144 145 free(req->name); 146 for (i = 0; i < req->base_bdevs.num_base_bdevs; i++) { 147 free(req->base_bdevs.base_bdevs[i]); 148 } 149 } 150 151 /* 152 * Decoder function for RPC bdev_raid_create to decode raid level 153 */ 154 static int 155 decode_raid_level(const struct spdk_json_val *val, void *out) 156 { 157 int ret; 158 char *str = NULL; 159 enum raid_level level; 160 161 ret = spdk_json_decode_string(val, &str); 162 if (ret == 0 && str != NULL) { 163 level = raid_bdev_str_to_level(str); 164 if (level == INVALID_RAID_LEVEL) { 165 ret = -EINVAL; 166 } else { 167 *(enum raid_level *)out = level; 168 } 169 } 170 171 free(str); 172 return ret; 173 } 174 175 /* 176 * Decoder function for RPC bdev_raid_create to decode base bdevs list 177 */ 178 static int 179 decode_base_bdevs(const struct spdk_json_val *val, void *out) 180 { 181 struct rpc_bdev_raid_create_base_bdevs *base_bdevs = out; 182 return spdk_json_decode_array(val, spdk_json_decode_string, base_bdevs->base_bdevs, 183 RPC_MAX_BASE_BDEVS, &base_bdevs->num_base_bdevs, sizeof(char *)); 184 } 185 186 /* 187 * Decoder object for RPC bdev_raid_create 188 */ 189 static const struct spdk_json_object_decoder rpc_bdev_raid_create_decoders[] = { 190 {"name", offsetof(struct rpc_bdev_raid_create, name), spdk_json_decode_string}, 191 {"strip_size_kb", offsetof(struct rpc_bdev_raid_create, strip_size_kb), spdk_json_decode_uint32, true}, 192 {"raid_level", offsetof(struct rpc_bdev_raid_create, level), decode_raid_level}, 193 {"base_bdevs", offsetof(struct rpc_bdev_raid_create, base_bdevs), decode_base_bdevs}, 194 }; 195 196 /* 197 * brief: 198 * rpc_bdev_raid_create function is the RPC for creating RAID bdevs. It takes 199 * input as raid bdev name, raid level, strip size in KB and list of base bdev names. 200 * params: 201 * request - pointer to json rpc request 202 * params - pointer to request parameters 203 * returns: 204 * none 205 */ 206 static void 207 rpc_bdev_raid_create(struct spdk_jsonrpc_request *request, 208 const struct spdk_json_val *params) 209 { 210 struct rpc_bdev_raid_create req = {}; 211 struct raid_bdev *raid_bdev; 212 int rc; 213 size_t i; 214 215 if (spdk_json_decode_object(params, rpc_bdev_raid_create_decoders, 216 SPDK_COUNTOF(rpc_bdev_raid_create_decoders), 217 &req)) { 218 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_PARSE_ERROR, 219 "spdk_json_decode_object failed"); 220 goto cleanup; 221 } 222 223 if (req.strip_size_kb == 0) { 224 spdk_jsonrpc_send_error_response(request, -EINVAL, "strip size not specified"); 225 goto cleanup; 226 } 227 228 rc = raid_bdev_create(req.name, req.strip_size_kb, req.base_bdevs.num_base_bdevs, 229 req.level, &raid_bdev); 230 if (rc != 0) { 231 spdk_jsonrpc_send_error_response_fmt(request, rc, 232 "Failed to create RAID bdev %s: %s", 233 req.name, spdk_strerror(-rc)); 234 goto cleanup; 235 } 236 237 for (i = 0; i < req.base_bdevs.num_base_bdevs; i++) { 238 const char *base_bdev_name = req.base_bdevs.base_bdevs[i]; 239 240 rc = raid_bdev_add_base_device(raid_bdev, base_bdev_name, i); 241 if (rc == -ENODEV) { 242 SPDK_DEBUGLOG(bdev_raid, "base bdev %s doesn't exist now\n", base_bdev_name); 243 } else if (rc != 0) { 244 raid_bdev_delete(raid_bdev, NULL, NULL); 245 spdk_jsonrpc_send_error_response_fmt(request, rc, 246 "Failed to add base bdev %s to RAID bdev %s: %s", 247 base_bdev_name, req.name, 248 spdk_strerror(-rc)); 249 goto cleanup; 250 } 251 } 252 253 spdk_jsonrpc_send_bool_response(request, true); 254 255 cleanup: 256 free_rpc_bdev_raid_create(&req); 257 } 258 SPDK_RPC_REGISTER("bdev_raid_create", rpc_bdev_raid_create, SPDK_RPC_RUNTIME) 259 260 /* 261 * Input structure for RPC deleting a raid bdev 262 */ 263 struct rpc_bdev_raid_delete { 264 /* raid bdev name */ 265 char *name; 266 }; 267 268 /* 269 * brief: 270 * free_rpc_bdev_raid_delete function is used to free RPC bdev_raid_delete related parameters 271 * params: 272 * req - pointer to RPC request 273 * params: 274 * none 275 */ 276 static void 277 free_rpc_bdev_raid_delete(struct rpc_bdev_raid_delete *req) 278 { 279 free(req->name); 280 } 281 282 /* 283 * Decoder object for RPC raid_bdev_delete 284 */ 285 static const struct spdk_json_object_decoder rpc_bdev_raid_delete_decoders[] = { 286 {"name", offsetof(struct rpc_bdev_raid_delete, name), spdk_json_decode_string}, 287 }; 288 289 struct rpc_bdev_raid_delete_ctx { 290 struct rpc_bdev_raid_delete req; 291 struct spdk_jsonrpc_request *request; 292 }; 293 294 /* 295 * brief: 296 * params: 297 * cb_arg - pointer to the callback context. 298 * rc - return code of the deletion of the raid bdev. 299 * returns: 300 * none 301 */ 302 static void 303 bdev_raid_delete_done(void *cb_arg, int rc) 304 { 305 struct rpc_bdev_raid_delete_ctx *ctx = cb_arg; 306 struct spdk_jsonrpc_request *request = ctx->request; 307 308 if (rc != 0) { 309 SPDK_ERRLOG("Failed to delete raid bdev %s (%d): %s\n", 310 ctx->req.name, rc, spdk_strerror(-rc)); 311 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 312 spdk_strerror(-rc)); 313 goto exit; 314 } 315 316 spdk_jsonrpc_send_bool_response(request, true); 317 exit: 318 free_rpc_bdev_raid_delete(&ctx->req); 319 free(ctx); 320 } 321 322 /* 323 * brief: 324 * rpc_bdev_raid_delete function is the RPC for deleting a raid bdev. It takes raid 325 * name as input and delete that raid bdev including freeing the base bdev 326 * resources. 327 * params: 328 * request - pointer to json rpc request 329 * params - pointer to request parameters 330 * returns: 331 * none 332 */ 333 static void 334 rpc_bdev_raid_delete(struct spdk_jsonrpc_request *request, 335 const struct spdk_json_val *params) 336 { 337 struct rpc_bdev_raid_delete_ctx *ctx; 338 struct raid_bdev *raid_bdev; 339 340 ctx = calloc(1, sizeof(*ctx)); 341 if (!ctx) { 342 spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM)); 343 return; 344 } 345 346 if (spdk_json_decode_object(params, rpc_bdev_raid_delete_decoders, 347 SPDK_COUNTOF(rpc_bdev_raid_delete_decoders), 348 &ctx->req)) { 349 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_PARSE_ERROR, 350 "spdk_json_decode_object failed"); 351 goto cleanup; 352 } 353 354 raid_bdev = raid_bdev_find_by_name(ctx->req.name); 355 if (raid_bdev == NULL) { 356 spdk_jsonrpc_send_error_response_fmt(request, -ENODEV, 357 "raid bdev %s not found", 358 ctx->req.name); 359 goto cleanup; 360 } 361 362 ctx->request = request; 363 364 raid_bdev_delete(raid_bdev, bdev_raid_delete_done, ctx); 365 366 return; 367 368 cleanup: 369 free_rpc_bdev_raid_delete(&ctx->req); 370 free(ctx); 371 } 372 SPDK_RPC_REGISTER("bdev_raid_delete", rpc_bdev_raid_delete, SPDK_RPC_RUNTIME) 373