1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "spdk/rpc.h" 35 #include "spdk/bdev.h" 36 #include "bdev_raid.h" 37 #include "spdk/util.h" 38 #include "spdk/string.h" 39 #include "spdk/log.h" 40 #include "spdk/env.h" 41 42 #define RPC_MAX_BASE_BDEVS 255 43 44 /* 45 * Input structure for bdev_raid_get_bdevs RPC 46 */ 47 struct rpc_bdev_raid_get_bdevs { 48 /* category - all or online or configuring or offline */ 49 char *category; 50 }; 51 52 /* 53 * brief: 54 * free_rpc_bdev_raid_get_bdevs function frees RPC bdev_raid_get_bdevs related parameters 55 * params: 56 * req - pointer to RPC request 57 * returns: 58 * none 59 */ 60 static void 61 free_rpc_bdev_raid_get_bdevs(struct rpc_bdev_raid_get_bdevs *req) 62 { 63 free(req->category); 64 } 65 66 /* 67 * Decoder object for RPC get_raids 68 */ 69 static const struct spdk_json_object_decoder rpc_bdev_raid_get_bdevs_decoders[] = { 70 {"category", offsetof(struct rpc_bdev_raid_get_bdevs, category), spdk_json_decode_string}, 71 }; 72 73 /* 74 * brief: 75 * rpc_bdev_raid_get_bdevs function is the RPC for rpc_bdev_raid_get_bdevs. This is used to list 76 * all the raid bdev names based on the input category requested. Category should be 77 * one of "all", "online", "configuring" or "offline". "all" means all the raids 78 * whether they are online or configuring or offline. "online" is the raid bdev which 79 * is registered with bdev layer. "configuring" is the raid bdev which does not have 80 * full configuration discovered yet. "offline" is the raid bdev which is not 81 * registered with bdev as of now and it has encountered any error or user has 82 * requested to offline the raid. 83 * params: 84 * request - pointer to json rpc request 85 * params - pointer to request parameters 86 * returns: 87 * none 88 */ 89 static void 90 rpc_bdev_raid_get_bdevs(struct spdk_jsonrpc_request *request, 91 const struct spdk_json_val *params) 92 { 93 struct rpc_bdev_raid_get_bdevs req = {}; 94 struct spdk_json_write_ctx *w; 95 struct raid_bdev *raid_bdev; 96 97 if (spdk_json_decode_object(params, rpc_bdev_raid_get_bdevs_decoders, 98 SPDK_COUNTOF(rpc_bdev_raid_get_bdevs_decoders), 99 &req)) { 100 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 101 "spdk_json_decode_object failed"); 102 goto cleanup; 103 } 104 105 if (!(strcmp(req.category, "all") == 0 || 106 strcmp(req.category, "online") == 0 || 107 strcmp(req.category, "configuring") == 0 || 108 strcmp(req.category, "offline") == 0)) { 109 spdk_jsonrpc_send_error_response(request, -EINVAL, spdk_strerror(EINVAL)); 110 goto cleanup; 111 } 112 113 w = spdk_jsonrpc_begin_result(request); 114 spdk_json_write_array_begin(w); 115 116 /* Get raid bdev list based on the category requested */ 117 if (strcmp(req.category, "all") == 0) { 118 TAILQ_FOREACH(raid_bdev, &g_raid_bdev_list, global_link) { 119 spdk_json_write_string(w, raid_bdev->bdev.name); 120 } 121 } else if (strcmp(req.category, "online") == 0) { 122 TAILQ_FOREACH(raid_bdev, &g_raid_bdev_configured_list, state_link) { 123 spdk_json_write_string(w, raid_bdev->bdev.name); 124 } 125 } else if (strcmp(req.category, "configuring") == 0) { 126 TAILQ_FOREACH(raid_bdev, &g_raid_bdev_configuring_list, state_link) { 127 spdk_json_write_string(w, raid_bdev->bdev.name); 128 } 129 } else { 130 TAILQ_FOREACH(raid_bdev, &g_raid_bdev_offline_list, state_link) { 131 spdk_json_write_string(w, raid_bdev->bdev.name); 132 } 133 } 134 spdk_json_write_array_end(w); 135 spdk_jsonrpc_end_result(request, w); 136 137 cleanup: 138 free_rpc_bdev_raid_get_bdevs(&req); 139 } 140 SPDK_RPC_REGISTER("bdev_raid_get_bdevs", rpc_bdev_raid_get_bdevs, SPDK_RPC_RUNTIME) 141 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_raid_get_bdevs, get_raid_bdevs) 142 143 /* 144 * Base bdevs in RPC bdev_raid_create 145 */ 146 struct rpc_bdev_raid_create_base_bdevs { 147 /* Number of base bdevs */ 148 size_t num_base_bdevs; 149 150 /* List of base bdevs names */ 151 char *base_bdevs[RPC_MAX_BASE_BDEVS]; 152 }; 153 154 /* 155 * Input structure for RPC rpc_bdev_raid_create 156 */ 157 struct rpc_bdev_raid_create { 158 /* Raid bdev name */ 159 char *name; 160 161 /* RAID strip size in KB */ 162 uint32_t strip_size_kb; 163 164 /* RAID raid level */ 165 enum raid_level level; 166 167 /* Base bdevs information */ 168 struct rpc_bdev_raid_create_base_bdevs base_bdevs; 169 }; 170 171 /* 172 * brief: 173 * free_rpc_bdev_raid_create function is to free RPC bdev_raid_create related parameters 174 * params: 175 * req - pointer to RPC request 176 * returns: 177 * none 178 */ 179 static void 180 free_rpc_bdev_raid_create(struct rpc_bdev_raid_create *req) 181 { 182 size_t i; 183 184 free(req->name); 185 for (i = 0; i < req->base_bdevs.num_base_bdevs; i++) { 186 free(req->base_bdevs.base_bdevs[i]); 187 } 188 } 189 190 /* 191 * Decoder function for RPC bdev_raid_create to decode raid level 192 */ 193 static int 194 decode_raid_level(const struct spdk_json_val *val, void *out) 195 { 196 int ret; 197 char *str = NULL; 198 enum raid_level level; 199 200 ret = spdk_json_decode_string(val, &str); 201 if (ret == 0 && str != NULL) { 202 level = raid_bdev_parse_raid_level(str); 203 if (level == INVALID_RAID_LEVEL) { 204 ret = -EINVAL; 205 } else { 206 *(enum raid_level *)out = level; 207 } 208 } 209 210 free(str); 211 return ret; 212 } 213 214 /* 215 * Decoder function for RPC bdev_raid_create to decode base bdevs list 216 */ 217 static int 218 decode_base_bdevs(const struct spdk_json_val *val, void *out) 219 { 220 struct rpc_bdev_raid_create_base_bdevs *base_bdevs = out; 221 return spdk_json_decode_array(val, spdk_json_decode_string, base_bdevs->base_bdevs, 222 RPC_MAX_BASE_BDEVS, &base_bdevs->num_base_bdevs, sizeof(char *)); 223 } 224 225 /* 226 * Decoder object for RPC bdev_raid_create 227 */ 228 static const struct spdk_json_object_decoder rpc_bdev_raid_create_decoders[] = { 229 {"name", offsetof(struct rpc_bdev_raid_create, name), spdk_json_decode_string}, 230 {"strip_size_kb", offsetof(struct rpc_bdev_raid_create, strip_size_kb), spdk_json_decode_uint32, true}, 231 {"raid_level", offsetof(struct rpc_bdev_raid_create, level), decode_raid_level}, 232 {"base_bdevs", offsetof(struct rpc_bdev_raid_create, base_bdevs), decode_base_bdevs}, 233 }; 234 235 /* 236 * brief: 237 * rpc_bdev_raid_create function is the RPC for creating RAID bdevs. It takes 238 * input as raid bdev name, raid level, strip size in KB and list of base bdev names. 239 * params: 240 * request - pointer to json rpc request 241 * params - pointer to request parameters 242 * returns: 243 * none 244 */ 245 static void 246 rpc_bdev_raid_create(struct spdk_jsonrpc_request *request, 247 const struct spdk_json_val *params) 248 { 249 struct rpc_bdev_raid_create req = {}; 250 struct raid_bdev_config *raid_cfg; 251 int rc; 252 size_t i; 253 254 if (spdk_json_decode_object(params, rpc_bdev_raid_create_decoders, 255 SPDK_COUNTOF(rpc_bdev_raid_create_decoders), 256 &req)) { 257 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 258 "spdk_json_decode_object failed"); 259 goto cleanup; 260 } 261 262 if (req.strip_size_kb == 0) { 263 spdk_jsonrpc_send_error_response(request, EINVAL, "strip size not specified"); 264 goto cleanup; 265 } 266 267 rc = raid_bdev_config_add(req.name, req.strip_size_kb, req.base_bdevs.num_base_bdevs, 268 req.level, 269 &raid_cfg); 270 if (rc != 0) { 271 spdk_jsonrpc_send_error_response_fmt(request, rc, 272 "Failed to add RAID bdev config %s: %s", 273 req.name, spdk_strerror(-rc)); 274 goto cleanup; 275 } 276 277 for (i = 0; i < req.base_bdevs.num_base_bdevs; i++) { 278 rc = raid_bdev_config_add_base_bdev(raid_cfg, req.base_bdevs.base_bdevs[i], i); 279 if (rc != 0) { 280 raid_bdev_config_cleanup(raid_cfg); 281 spdk_jsonrpc_send_error_response_fmt(request, rc, 282 "Failed to add base bdev %s to RAID bdev config %s: %s", 283 req.base_bdevs.base_bdevs[i], req.name, 284 spdk_strerror(-rc)); 285 goto cleanup; 286 } 287 } 288 289 rc = raid_bdev_create(raid_cfg); 290 if (rc != 0) { 291 raid_bdev_config_cleanup(raid_cfg); 292 spdk_jsonrpc_send_error_response_fmt(request, rc, 293 "Failed to create RAID bdev %s: %s", 294 req.name, spdk_strerror(-rc)); 295 goto cleanup; 296 } 297 298 rc = raid_bdev_add_base_devices(raid_cfg); 299 if (rc != 0) { 300 spdk_jsonrpc_send_error_response_fmt(request, rc, 301 "Failed to add any base bdev to RAID bdev %s: %s", 302 req.name, spdk_strerror(-rc)); 303 goto cleanup; 304 } 305 306 spdk_jsonrpc_send_bool_response(request, true); 307 308 cleanup: 309 free_rpc_bdev_raid_create(&req); 310 } 311 SPDK_RPC_REGISTER("bdev_raid_create", rpc_bdev_raid_create, SPDK_RPC_RUNTIME) 312 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_raid_create, construct_raid_bdev) 313 314 /* 315 * Input structure for RPC deleting a raid bdev 316 */ 317 struct rpc_bdev_raid_delete { 318 /* raid bdev name */ 319 char *name; 320 }; 321 322 /* 323 * brief: 324 * free_rpc_bdev_raid_delete function is used to free RPC bdev_raid_delete related parameters 325 * params: 326 * req - pointer to RPC request 327 * params: 328 * none 329 */ 330 static void 331 free_rpc_bdev_raid_delete(struct rpc_bdev_raid_delete *req) 332 { 333 free(req->name); 334 } 335 336 /* 337 * Decoder object for RPC raid_bdev_delete 338 */ 339 static const struct spdk_json_object_decoder rpc_bdev_raid_delete_decoders[] = { 340 {"name", offsetof(struct rpc_bdev_raid_delete, name), spdk_json_decode_string}, 341 }; 342 343 struct rpc_bdev_raid_delete_ctx { 344 struct rpc_bdev_raid_delete req; 345 struct raid_bdev_config *raid_cfg; 346 struct spdk_jsonrpc_request *request; 347 }; 348 349 /* 350 * brief: 351 * params: 352 * cb_arg - pointer to the callback context. 353 * rc - return code of the deletion of the raid bdev. 354 * returns: 355 * none 356 */ 357 static void 358 bdev_raid_delete_done(void *cb_arg, int rc) 359 { 360 struct rpc_bdev_raid_delete_ctx *ctx = cb_arg; 361 struct raid_bdev_config *raid_cfg; 362 struct spdk_jsonrpc_request *request = ctx->request; 363 364 if (rc != 0) { 365 SPDK_ERRLOG("Failed to delete raid bdev %s (%d): %s\n", 366 ctx->req.name, rc, spdk_strerror(-rc)); 367 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 368 spdk_strerror(-rc)); 369 goto exit; 370 } 371 372 raid_cfg = ctx->raid_cfg; 373 assert(raid_cfg->raid_bdev == NULL); 374 375 raid_bdev_config_cleanup(raid_cfg); 376 377 spdk_jsonrpc_send_bool_response(request, true); 378 exit: 379 free_rpc_bdev_raid_delete(&ctx->req); 380 free(ctx); 381 } 382 383 /* 384 * brief: 385 * rpc_bdev_raid_delete function is the RPC for deleting a raid bdev. It takes raid 386 * name as input and delete that raid bdev including freeing the base bdev 387 * resources. 388 * params: 389 * request - pointer to json rpc request 390 * params - pointer to request parameters 391 * returns: 392 * none 393 */ 394 static void 395 rpc_bdev_raid_delete(struct spdk_jsonrpc_request *request, 396 const struct spdk_json_val *params) 397 { 398 struct rpc_bdev_raid_delete_ctx *ctx; 399 400 ctx = calloc(1, sizeof(*ctx)); 401 if (!ctx) { 402 spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM)); 403 return; 404 } 405 406 if (spdk_json_decode_object(params, rpc_bdev_raid_delete_decoders, 407 SPDK_COUNTOF(rpc_bdev_raid_delete_decoders), 408 &ctx->req)) { 409 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 410 "spdk_json_decode_object failed"); 411 goto cleanup; 412 } 413 414 ctx->raid_cfg = raid_bdev_config_find_by_name(ctx->req.name); 415 if (ctx->raid_cfg == NULL) { 416 spdk_jsonrpc_send_error_response_fmt(request, ENODEV, 417 "raid bdev %s is not found in config", 418 ctx->req.name); 419 goto cleanup; 420 } 421 422 ctx->request = request; 423 424 /* Remove all the base bdevs from this raid bdev before deleting the raid bdev */ 425 raid_bdev_remove_base_devices(ctx->raid_cfg, bdev_raid_delete_done, ctx); 426 427 return; 428 429 cleanup: 430 free_rpc_bdev_raid_delete(&ctx->req); 431 free(ctx); 432 } 433 SPDK_RPC_REGISTER("bdev_raid_delete", rpc_bdev_raid_delete, SPDK_RPC_RUNTIME) 434 SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_raid_delete, destroy_raid_bdev) 435