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