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