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 /* UUID for this raid bdev */ 132 struct spdk_uuid uuid; 133 134 /* If set, information about raid bdev will be stored in superblock on each base bdev */ 135 bool superblock_enabled; 136 }; 137 138 /* 139 * brief: 140 * free_rpc_bdev_raid_create function is to free RPC bdev_raid_create related parameters 141 * params: 142 * req - pointer to RPC request 143 * returns: 144 * none 145 */ 146 static void 147 free_rpc_bdev_raid_create(struct rpc_bdev_raid_create *req) 148 { 149 size_t i; 150 151 free(req->name); 152 for (i = 0; i < req->base_bdevs.num_base_bdevs; i++) { 153 free(req->base_bdevs.base_bdevs[i]); 154 } 155 } 156 157 /* 158 * Decoder function for RPC bdev_raid_create to decode raid level 159 */ 160 static int 161 decode_raid_level(const struct spdk_json_val *val, void *out) 162 { 163 int ret; 164 char *str = NULL; 165 enum raid_level level; 166 167 ret = spdk_json_decode_string(val, &str); 168 if (ret == 0 && str != NULL) { 169 level = raid_bdev_str_to_level(str); 170 if (level == INVALID_RAID_LEVEL) { 171 ret = -EINVAL; 172 } else { 173 *(enum raid_level *)out = level; 174 } 175 } 176 177 free(str); 178 return ret; 179 } 180 181 /* 182 * Decoder function for RPC bdev_raid_create to decode base bdevs list 183 */ 184 static int 185 decode_base_bdevs(const struct spdk_json_val *val, void *out) 186 { 187 struct rpc_bdev_raid_create_base_bdevs *base_bdevs = out; 188 return spdk_json_decode_array(val, spdk_json_decode_string, base_bdevs->base_bdevs, 189 RPC_MAX_BASE_BDEVS, &base_bdevs->num_base_bdevs, sizeof(char *)); 190 } 191 192 /* 193 * Decoder object for RPC bdev_raid_create 194 */ 195 static const struct spdk_json_object_decoder rpc_bdev_raid_create_decoders[] = { 196 {"name", offsetof(struct rpc_bdev_raid_create, name), spdk_json_decode_string}, 197 {"strip_size_kb", offsetof(struct rpc_bdev_raid_create, strip_size_kb), spdk_json_decode_uint32, true}, 198 {"raid_level", offsetof(struct rpc_bdev_raid_create, level), decode_raid_level}, 199 {"base_bdevs", offsetof(struct rpc_bdev_raid_create, base_bdevs), decode_base_bdevs}, 200 {"uuid", offsetof(struct rpc_bdev_raid_create, uuid), spdk_json_decode_uuid, true}, 201 {"superblock", offsetof(struct rpc_bdev_raid_create, superblock_enabled), spdk_json_decode_bool, true}, 202 }; 203 204 /* 205 * brief: 206 * rpc_bdev_raid_create function is the RPC for creating RAID bdevs. It takes 207 * input as raid bdev name, raid level, strip size in KB and list of base bdev names. 208 * params: 209 * request - pointer to json rpc request 210 * params - pointer to request parameters 211 * returns: 212 * none 213 */ 214 static void 215 rpc_bdev_raid_create(struct spdk_jsonrpc_request *request, 216 const struct spdk_json_val *params) 217 { 218 struct rpc_bdev_raid_create req = {}; 219 struct raid_bdev *raid_bdev; 220 int rc; 221 size_t i; 222 223 if (spdk_json_decode_object(params, rpc_bdev_raid_create_decoders, 224 SPDK_COUNTOF(rpc_bdev_raid_create_decoders), 225 &req)) { 226 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_PARSE_ERROR, 227 "spdk_json_decode_object failed"); 228 goto cleanup; 229 } 230 231 rc = raid_bdev_create(req.name, req.strip_size_kb, req.base_bdevs.num_base_bdevs, 232 req.level, req.superblock_enabled, &req.uuid, &raid_bdev); 233 if (rc != 0) { 234 spdk_jsonrpc_send_error_response_fmt(request, rc, 235 "Failed to create RAID bdev %s: %s", 236 req.name, spdk_strerror(-rc)); 237 goto cleanup; 238 } 239 240 for (i = 0; i < req.base_bdevs.num_base_bdevs; i++) { 241 const char *base_bdev_name = req.base_bdevs.base_bdevs[i]; 242 243 rc = raid_bdev_add_base_device(raid_bdev, base_bdev_name, i); 244 if (rc == -ENODEV) { 245 SPDK_DEBUGLOG(bdev_raid, "base bdev %s doesn't exist now\n", base_bdev_name); 246 } else if (rc != 0) { 247 raid_bdev_delete(raid_bdev, NULL, NULL); 248 spdk_jsonrpc_send_error_response_fmt(request, rc, 249 "Failed to add base bdev %s to RAID bdev %s: %s", 250 base_bdev_name, req.name, 251 spdk_strerror(-rc)); 252 goto cleanup; 253 } 254 } 255 256 spdk_jsonrpc_send_bool_response(request, true); 257 258 cleanup: 259 free_rpc_bdev_raid_create(&req); 260 } 261 SPDK_RPC_REGISTER("bdev_raid_create", rpc_bdev_raid_create, SPDK_RPC_RUNTIME) 262 263 /* 264 * Input structure for RPC deleting a raid bdev 265 */ 266 struct rpc_bdev_raid_delete { 267 /* raid bdev name */ 268 char *name; 269 }; 270 271 /* 272 * brief: 273 * free_rpc_bdev_raid_delete function is used to free RPC bdev_raid_delete related parameters 274 * params: 275 * req - pointer to RPC request 276 * params: 277 * none 278 */ 279 static void 280 free_rpc_bdev_raid_delete(struct rpc_bdev_raid_delete *req) 281 { 282 free(req->name); 283 } 284 285 /* 286 * Decoder object for RPC raid_bdev_delete 287 */ 288 static const struct spdk_json_object_decoder rpc_bdev_raid_delete_decoders[] = { 289 {"name", offsetof(struct rpc_bdev_raid_delete, name), spdk_json_decode_string}, 290 }; 291 292 struct rpc_bdev_raid_delete_ctx { 293 struct rpc_bdev_raid_delete req; 294 struct spdk_jsonrpc_request *request; 295 }; 296 297 /* 298 * brief: 299 * params: 300 * cb_arg - pointer to the callback context. 301 * rc - return code of the deletion of the raid bdev. 302 * returns: 303 * none 304 */ 305 static void 306 bdev_raid_delete_done(void *cb_arg, int rc) 307 { 308 struct rpc_bdev_raid_delete_ctx *ctx = cb_arg; 309 struct spdk_jsonrpc_request *request = ctx->request; 310 311 if (rc != 0) { 312 SPDK_ERRLOG("Failed to delete raid bdev %s (%d): %s\n", 313 ctx->req.name, rc, spdk_strerror(-rc)); 314 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 315 spdk_strerror(-rc)); 316 goto exit; 317 } 318 319 spdk_jsonrpc_send_bool_response(request, true); 320 exit: 321 free_rpc_bdev_raid_delete(&ctx->req); 322 free(ctx); 323 } 324 325 /* 326 * brief: 327 * rpc_bdev_raid_delete function is the RPC for deleting a raid bdev. It takes raid 328 * name as input and delete that raid bdev including freeing the base bdev 329 * resources. 330 * params: 331 * request - pointer to json rpc request 332 * params - pointer to request parameters 333 * returns: 334 * none 335 */ 336 static void 337 rpc_bdev_raid_delete(struct spdk_jsonrpc_request *request, 338 const struct spdk_json_val *params) 339 { 340 struct rpc_bdev_raid_delete_ctx *ctx; 341 struct raid_bdev *raid_bdev; 342 343 ctx = calloc(1, sizeof(*ctx)); 344 if (!ctx) { 345 spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM)); 346 return; 347 } 348 349 if (spdk_json_decode_object(params, rpc_bdev_raid_delete_decoders, 350 SPDK_COUNTOF(rpc_bdev_raid_delete_decoders), 351 &ctx->req)) { 352 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_PARSE_ERROR, 353 "spdk_json_decode_object failed"); 354 goto cleanup; 355 } 356 357 raid_bdev = raid_bdev_find_by_name(ctx->req.name); 358 if (raid_bdev == NULL) { 359 spdk_jsonrpc_send_error_response_fmt(request, -ENODEV, 360 "raid bdev %s not found", 361 ctx->req.name); 362 goto cleanup; 363 } 364 365 ctx->request = request; 366 367 raid_bdev_delete(raid_bdev, bdev_raid_delete_done, ctx); 368 369 return; 370 371 cleanup: 372 free_rpc_bdev_raid_delete(&ctx->req); 373 free(ctx); 374 } 375 SPDK_RPC_REGISTER("bdev_raid_delete", rpc_bdev_raid_delete, SPDK_RPC_RUNTIME) 376 377 /* 378 * Decoder object for RPC bdev_raid_remove_base_bdev 379 */ 380 static const struct spdk_json_object_decoder rpc_bdev_raid_remove_base_bdev_decoders[] = { 381 {"name", 0, spdk_json_decode_string}, 382 }; 383 384 static void 385 rpc_bdev_raid_remove_base_bdev_done(void *ctx, int status) 386 { 387 struct spdk_jsonrpc_request *request = ctx; 388 389 if (status != 0) { 390 spdk_jsonrpc_send_error_response_fmt(request, status, "Failed to remove base bdev from raid bdev"); 391 return; 392 } 393 394 spdk_jsonrpc_send_bool_response(request, true); 395 } 396 397 static void 398 rpc_bdev_raid_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 399 { 400 } 401 402 /* 403 * brief: 404 * bdev_raid_remove_base_bdev function is the RPC for removing base bdev from a raid bdev. 405 * It takes base bdev name as input. 406 * params: 407 * request - pointer to json rpc request 408 * params - pointer to request parameters 409 * returns: 410 * none 411 */ 412 static void 413 rpc_bdev_raid_remove_base_bdev(struct spdk_jsonrpc_request *request, 414 const struct spdk_json_val *params) 415 { 416 struct spdk_bdev_desc *desc; 417 char *name = NULL; 418 int rc; 419 420 if (spdk_json_decode_object(params, rpc_bdev_raid_remove_base_bdev_decoders, 421 SPDK_COUNTOF(rpc_bdev_raid_remove_base_bdev_decoders), 422 &name)) { 423 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_PARSE_ERROR, 424 "spdk_json_decode_object failed"); 425 return; 426 } 427 428 rc = spdk_bdev_open_ext(name, false, rpc_bdev_raid_event_cb, NULL, &desc); 429 free(name); 430 if (rc != 0) { 431 goto err; 432 } 433 434 rc = raid_bdev_remove_base_bdev(spdk_bdev_desc_get_bdev(desc), rpc_bdev_raid_remove_base_bdev_done, 435 request); 436 spdk_bdev_close(desc); 437 if (rc != 0) { 438 goto err; 439 } 440 441 return; 442 err: 443 rpc_bdev_raid_remove_base_bdev_done(request, rc); 444 } 445 SPDK_RPC_REGISTER("bdev_raid_remove_base_bdev", rpc_bdev_raid_remove_base_bdev, SPDK_RPC_RUNTIME) 446