1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2018 Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #ifndef SPDK_BDEV_RAID_INTERNAL_H 7 #define SPDK_BDEV_RAID_INTERNAL_H 8 9 #include "spdk/bdev_module.h" 10 #include "spdk/uuid.h" 11 12 #define RAID_BDEV_MIN_DATA_OFFSET_SIZE (1024*1024) /* 1 MiB */ 13 14 enum raid_level { 15 INVALID_RAID_LEVEL = -1, 16 RAID0 = 0, 17 RAID1 = 1, 18 RAID5F = 95, /* 0x5f */ 19 CONCAT = 99, 20 }; 21 22 /* 23 * Raid state describes the state of the raid. This raid bdev can be either in 24 * configured list or configuring list 25 */ 26 enum raid_bdev_state { 27 /* raid bdev is ready and is seen by upper layers */ 28 RAID_BDEV_STATE_ONLINE, 29 30 /* 31 * raid bdev is configuring, not all underlying bdevs are present. 32 * And can't be seen by upper layers. 33 */ 34 RAID_BDEV_STATE_CONFIGURING, 35 36 /* 37 * In offline state, raid bdev layer will complete all incoming commands without 38 * submitting to underlying base nvme bdevs 39 */ 40 RAID_BDEV_STATE_OFFLINE, 41 42 /* raid bdev state max, new states should be added before this */ 43 RAID_BDEV_STATE_MAX 44 }; 45 46 enum raid_process_type { 47 RAID_PROCESS_NONE, 48 RAID_PROCESS_REBUILD, 49 RAID_PROCESS_MAX 50 }; 51 52 typedef void (*raid_base_bdev_cb)(void *ctx, int status); 53 54 /* 55 * raid_base_bdev_info contains information for the base bdevs which are part of some 56 * raid. This structure contains the per base bdev information. Whatever is 57 * required per base device for raid bdev will be kept here 58 */ 59 struct raid_base_bdev_info { 60 /* The raid bdev that this base bdev belongs to */ 61 struct raid_bdev *raid_bdev; 62 63 /* name of the bdev */ 64 char *name; 65 66 /* uuid of the bdev */ 67 struct spdk_uuid uuid; 68 69 /* 70 * Pointer to base bdev descriptor opened by raid bdev. This is NULL when the bdev for 71 * this slot is missing. 72 */ 73 struct spdk_bdev_desc *desc; 74 75 /* offset in blocks from the start of the base bdev to the start of the data region */ 76 uint64_t data_offset; 77 78 /* size in blocks of the base bdev's data region */ 79 uint64_t data_size; 80 81 /* 82 * When underlying base device calls the hot plug function on drive removal, 83 * this flag will be set and later after doing some processing, base device 84 * descriptor will be closed 85 */ 86 bool remove_scheduled; 87 88 /* callback for base bdev removal */ 89 raid_base_bdev_cb remove_cb; 90 91 /* context of the callback */ 92 void *remove_cb_ctx; 93 94 /* Hold the number of blocks to know how large the base bdev is resized. */ 95 uint64_t blockcnt; 96 97 /* io channel for the app thread */ 98 struct spdk_io_channel *app_thread_ch; 99 100 /* Set to true when base bdev has completed the configuration process */ 101 bool is_configured; 102 103 /* callback for base bdev configuration */ 104 raid_base_bdev_cb configure_cb; 105 106 /* context of the callback */ 107 void *configure_cb_ctx; 108 }; 109 110 struct raid_bdev_io; 111 typedef void (*raid_bdev_io_completion_cb)(struct raid_bdev_io *raid_io, 112 enum spdk_bdev_io_status status); 113 114 /* 115 * raid_bdev_io is the context part of bdev_io. It contains the information 116 * related to bdev_io for a raid bdev 117 */ 118 struct raid_bdev_io { 119 /* The raid bdev associated with this IO */ 120 struct raid_bdev *raid_bdev; 121 122 uint64_t offset_blocks; 123 uint64_t num_blocks; 124 struct iovec *iovs; 125 int iovcnt; 126 enum spdk_bdev_io_type type; 127 struct spdk_memory_domain *memory_domain; 128 void *memory_domain_ctx; 129 void *md_buf; 130 131 /* WaitQ entry, used only in waitq logic */ 132 struct spdk_bdev_io_wait_entry waitq_entry; 133 134 /* Context of the original channel for this IO */ 135 struct raid_bdev_io_channel *raid_ch; 136 137 /* Used for tracking progress on io requests sent to member disks. */ 138 uint64_t base_bdev_io_remaining; 139 uint8_t base_bdev_io_submitted; 140 enum spdk_bdev_io_status base_bdev_io_status; 141 142 /* Private data for the raid module */ 143 void *module_private; 144 145 /* Custom completion callback. Overrides bdev_io completion if set. */ 146 raid_bdev_io_completion_cb completion_cb; 147 148 struct { 149 uint64_t offset; 150 struct iovec *iov; 151 struct iovec iov_copy; 152 } split; 153 }; 154 155 struct raid_bdev_process_request { 156 struct raid_bdev_process *process; 157 struct raid_base_bdev_info *target; 158 struct spdk_io_channel *target_ch; 159 uint64_t offset_blocks; 160 uint32_t num_blocks; 161 struct iovec iov; 162 void *md_buf; 163 /* bdev_io is raid_io's driver_ctx - don't reorder them! 164 * These are needed for re-using raid module I/O functions for process I/O. */ 165 struct spdk_bdev_io bdev_io; 166 struct raid_bdev_io raid_io; 167 TAILQ_ENTRY(raid_bdev_process_request) link; 168 }; 169 170 /* 171 * raid_bdev is the single entity structure which contains SPDK block device 172 * and the information related to any raid bdev either configured or 173 * in configuring list. io device is created on this. 174 */ 175 struct raid_bdev { 176 /* raid bdev device, this will get registered in bdev layer */ 177 struct spdk_bdev bdev; 178 179 /* the raid bdev descriptor, opened for internal use */ 180 struct spdk_bdev_desc *self_desc; 181 182 /* link of raid bdev to link it to global raid bdev list */ 183 TAILQ_ENTRY(raid_bdev) global_link; 184 185 /* array of base bdev info */ 186 struct raid_base_bdev_info *base_bdev_info; 187 188 /* lock to protect the base bdev array */ 189 struct spdk_spinlock base_bdev_lock; 190 191 /* strip size of raid bdev in blocks */ 192 uint32_t strip_size; 193 194 /* strip size of raid bdev in KB */ 195 uint32_t strip_size_kb; 196 197 /* strip size bit shift for optimized calculation */ 198 uint32_t strip_size_shift; 199 200 /* block length bit shift for optimized calculation */ 201 uint32_t blocklen_shift; 202 203 /* state of raid bdev */ 204 enum raid_bdev_state state; 205 206 /* number of base bdevs comprising raid bdev */ 207 uint8_t num_base_bdevs; 208 209 /* number of base bdevs discovered */ 210 uint8_t num_base_bdevs_discovered; 211 212 /* 213 * Number of operational base bdevs, i.e. how many we know/expect to be working. This 214 * will be less than num_base_bdevs when starting a degraded array. 215 */ 216 uint8_t num_base_bdevs_operational; 217 218 /* minimum number of viable base bdevs that are required by array to operate */ 219 uint8_t min_base_bdevs_operational; 220 221 /* Raid Level of this raid bdev */ 222 enum raid_level level; 223 224 /* Set to true if destroy of this raid bdev is started. */ 225 bool destroy_started; 226 227 /* Module for RAID-level specific operations */ 228 struct raid_bdev_module *module; 229 230 /* Private data for the raid module */ 231 void *module_private; 232 233 /* Superblock */ 234 bool superblock_enabled; 235 struct raid_bdev_superblock *sb; 236 237 /* Superblock buffer used for I/O */ 238 void *sb_io_buf; 239 uint32_t sb_io_buf_size; 240 241 /* Raid bdev background process, e.g. rebuild */ 242 struct raid_bdev_process *process; 243 }; 244 245 #define RAID_FOR_EACH_BASE_BDEV(r, i) \ 246 for (i = r->base_bdev_info; i < r->base_bdev_info + r->num_base_bdevs; i++) 247 248 struct raid_bdev_io_channel; 249 250 /* TAIL head for raid bdev list */ 251 TAILQ_HEAD(raid_all_tailq, raid_bdev); 252 253 extern struct raid_all_tailq g_raid_bdev_list; 254 255 typedef void (*raid_bdev_destruct_cb)(void *cb_ctx, int rc); 256 257 int raid_bdev_create(const char *name, uint32_t strip_size, uint8_t num_base_bdevs, 258 enum raid_level level, bool superblock, const struct spdk_uuid *uuid, 259 struct raid_bdev **raid_bdev_out); 260 void raid_bdev_delete(struct raid_bdev *raid_bdev, raid_bdev_destruct_cb cb_fn, void *cb_ctx); 261 int raid_bdev_add_base_device(struct raid_bdev *raid_bdev, const char *name, uint8_t slot, 262 raid_base_bdev_cb cb_fn, void *cb_ctx); 263 struct raid_bdev *raid_bdev_find_by_name(const char *name); 264 enum raid_level raid_bdev_str_to_level(const char *str); 265 const char *raid_bdev_level_to_str(enum raid_level level); 266 enum raid_bdev_state raid_bdev_str_to_state(const char *str); 267 const char *raid_bdev_state_to_str(enum raid_bdev_state state); 268 const char *raid_bdev_process_to_str(enum raid_process_type value); 269 void raid_bdev_write_info_json(struct raid_bdev *raid_bdev, struct spdk_json_write_ctx *w); 270 int raid_bdev_remove_base_bdev(struct spdk_bdev *base_bdev, raid_base_bdev_cb cb_fn, void *cb_ctx); 271 int raid_bdev_attach_base_bdev(struct raid_bdev *raid_bdev, struct spdk_bdev *base_bdev, 272 raid_base_bdev_cb cb_fn, void *cb_ctx); 273 274 /* 275 * RAID module descriptor 276 */ 277 struct raid_bdev_module { 278 /* RAID level implemented by this module */ 279 enum raid_level level; 280 281 /* Minimum required number of base bdevs. Must be > 0. */ 282 uint8_t base_bdevs_min; 283 284 /* 285 * RAID constraint. Determines number of base bdevs that can be removed 286 * without failing the array. 287 */ 288 struct { 289 enum { 290 CONSTRAINT_UNSET = 0, 291 CONSTRAINT_MAX_BASE_BDEVS_REMOVED, 292 CONSTRAINT_MIN_BASE_BDEVS_OPERATIONAL, 293 } type; 294 uint8_t value; 295 } base_bdevs_constraint; 296 297 /* Set to true if this module supports memory domains. */ 298 bool memory_domains_supported; 299 300 /* Set to true if this module supports DIF/DIX */ 301 bool dif_supported; 302 303 /* 304 * Called when the raid is starting, right before changing the state to 305 * online and registering the bdev. Parameters of the bdev like blockcnt 306 * should be set here. 307 * 308 * Non-zero return value will abort the startup process. 309 */ 310 int (*start)(struct raid_bdev *raid_bdev); 311 312 /* 313 * Called when the raid is stopping, right before changing the state to 314 * offline and unregistering the bdev. Optional. 315 * 316 * The function should return false if it is asynchronous. Then, after 317 * the async operation has completed and the module is fully stopped 318 * raid_bdev_module_stop_done() must be called. 319 */ 320 bool (*stop)(struct raid_bdev *raid_bdev); 321 322 /* Handler for R/W requests */ 323 void (*submit_rw_request)(struct raid_bdev_io *raid_io); 324 325 /* Handler for requests without payload (flush, unmap). Optional. */ 326 void (*submit_null_payload_request)(struct raid_bdev_io *raid_io); 327 328 /* 329 * Called when the bdev's IO channel is created to get the module's private IO channel. 330 * Optional. 331 */ 332 struct spdk_io_channel *(*get_io_channel)(struct raid_bdev *raid_bdev); 333 334 /* 335 * Called when a base_bdev is resized to resize the raid if the condition 336 * is satisfied. Optional. 337 * 338 * Returns true if the resize was performed. 339 */ 340 bool (*resize)(struct raid_bdev *raid_bdev); 341 342 /* Handler for raid process requests. Required for raid modules with redundancy. */ 343 int (*submit_process_request)(struct raid_bdev_process_request *process_req, 344 struct raid_bdev_io_channel *raid_ch); 345 346 TAILQ_ENTRY(raid_bdev_module) link; 347 }; 348 349 void raid_bdev_module_list_add(struct raid_bdev_module *raid_module); 350 351 #define __RAID_MODULE_REGISTER(line) __RAID_MODULE_REGISTER_(line) 352 #define __RAID_MODULE_REGISTER_(line) raid_module_register_##line 353 354 #define RAID_MODULE_REGISTER(_module) \ 355 __attribute__((constructor)) static void \ 356 __RAID_MODULE_REGISTER(__LINE__)(void) \ 357 { \ 358 raid_bdev_module_list_add(_module); \ 359 } 360 361 bool raid_bdev_io_complete_part(struct raid_bdev_io *raid_io, uint64_t completed, 362 enum spdk_bdev_io_status status); 363 void raid_bdev_queue_io_wait(struct raid_bdev_io *raid_io, struct spdk_bdev *bdev, 364 struct spdk_io_channel *ch, spdk_bdev_io_wait_cb cb_fn); 365 void raid_bdev_io_complete(struct raid_bdev_io *raid_io, enum spdk_bdev_io_status status); 366 void raid_bdev_module_stop_done(struct raid_bdev *raid_bdev); 367 struct spdk_io_channel *raid_bdev_channel_get_base_channel(struct raid_bdev_io_channel *raid_ch, 368 uint8_t idx); 369 void *raid_bdev_channel_get_module_ctx(struct raid_bdev_io_channel *raid_ch); 370 void raid_bdev_process_request_complete(struct raid_bdev_process_request *process_req, int status); 371 void raid_bdev_io_init(struct raid_bdev_io *raid_io, struct raid_bdev_io_channel *raid_ch, 372 enum spdk_bdev_io_type type, uint64_t offset_blocks, 373 uint64_t num_blocks, struct iovec *iovs, int iovcnt, void *md_buf, 374 struct spdk_memory_domain *memory_domain, void *memory_domain_ctx); 375 376 static inline uint8_t 377 raid_bdev_base_bdev_slot(struct raid_base_bdev_info *base_info) 378 { 379 return base_info - base_info->raid_bdev->base_bdev_info; 380 } 381 382 int raid_bdev_verify_dix_reftag(struct iovec *iovs, int iovcnt, void *md_buf, 383 uint64_t num_blocks, struct spdk_bdev *bdev, uint32_t offset_blocks); 384 385 /** 386 * Raid bdev I/O read/write wrapper for spdk_bdev_readv_blocks_ext function. 387 */ 388 int raid_bdev_readv_blocks_ext(struct raid_base_bdev_info *base_info, struct spdk_io_channel *ch, 389 struct iovec *iov, int iovcnt, uint64_t offset_blocks, 390 uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg, 391 struct spdk_bdev_ext_io_opts *opts); 392 393 /** 394 * Raid bdev I/O read/write wrapper for spdk_bdev_writev_blocks_ext function. 395 */ 396 int raid_bdev_writev_blocks_ext(struct raid_base_bdev_info *base_info, struct spdk_io_channel *ch, 397 struct iovec *iov, int iovcnt, uint64_t offset_blocks, 398 uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg, 399 struct spdk_bdev_ext_io_opts *opts); 400 401 /** 402 * Raid bdev I/O read/write wrapper for spdk_bdev_unmap_blocks function. 403 */ 404 static inline int 405 raid_bdev_unmap_blocks(struct raid_base_bdev_info *base_info, struct spdk_io_channel *ch, 406 uint64_t offset_blocks, uint64_t num_blocks, 407 spdk_bdev_io_completion_cb cb, void *cb_arg) 408 { 409 return spdk_bdev_unmap_blocks(base_info->desc, ch, base_info->data_offset + offset_blocks, 410 num_blocks, cb, cb_arg); 411 } 412 413 /** 414 * Raid bdev I/O read/write wrapper for spdk_bdev_flush_blocks function. 415 */ 416 static inline int 417 raid_bdev_flush_blocks(struct raid_base_bdev_info *base_info, struct spdk_io_channel *ch, 418 uint64_t offset_blocks, uint64_t num_blocks, 419 spdk_bdev_io_completion_cb cb, void *cb_arg) 420 { 421 return spdk_bdev_flush_blocks(base_info->desc, ch, base_info->data_offset + offset_blocks, 422 num_blocks, cb, cb_arg); 423 } 424 425 /* 426 * Definitions related to raid bdev superblock 427 */ 428 429 #define RAID_BDEV_SB_VERSION_MAJOR 1 430 #define RAID_BDEV_SB_VERSION_MINOR 0 431 432 #define RAID_BDEV_SB_NAME_SIZE 64 433 434 enum raid_bdev_sb_base_bdev_state { 435 RAID_SB_BASE_BDEV_MISSING = 0, 436 RAID_SB_BASE_BDEV_CONFIGURED = 1, 437 RAID_SB_BASE_BDEV_FAILED = 2, 438 RAID_SB_BASE_BDEV_SPARE = 3, 439 }; 440 441 struct raid_bdev_sb_base_bdev { 442 /* uuid of the base bdev */ 443 struct spdk_uuid uuid; 444 /* offset in blocks from base device start to the start of raid data area */ 445 uint64_t data_offset; 446 /* size in blocks of the base device raid data area */ 447 uint64_t data_size; 448 /* state of the base bdev */ 449 uint32_t state; 450 /* feature/status flags */ 451 uint32_t flags; 452 /* slot number of this base bdev in the raid */ 453 uint8_t slot; 454 455 uint8_t reserved[23]; 456 }; 457 SPDK_STATIC_ASSERT(sizeof(struct raid_bdev_sb_base_bdev) == 64, "incorrect size"); 458 459 struct raid_bdev_superblock { 460 #define RAID_BDEV_SB_SIG "SPDKRAID" 461 uint8_t signature[8]; 462 struct { 463 /* incremented when a breaking change in the superblock structure is made */ 464 uint16_t major; 465 /* incremented for changes in the superblock that are backward compatible */ 466 uint16_t minor; 467 } version; 468 /* length in bytes of the entire superblock */ 469 uint32_t length; 470 /* crc32c checksum of the entire superblock */ 471 uint32_t crc; 472 /* feature/status flags */ 473 uint32_t flags; 474 /* unique id of the raid bdev */ 475 struct spdk_uuid uuid; 476 /* name of the raid bdev */ 477 uint8_t name[RAID_BDEV_SB_NAME_SIZE]; 478 /* size of the raid bdev in blocks */ 479 uint64_t raid_size; 480 /* the raid bdev block size - must be the same for all base bdevs */ 481 uint32_t block_size; 482 /* the raid level */ 483 uint32_t level; 484 /* strip (chunk) size in blocks */ 485 uint32_t strip_size; 486 /* state of the raid */ 487 uint32_t state; 488 /* sequence number, incremented on every superblock update */ 489 uint64_t seq_number; 490 /* number of raid base devices */ 491 uint8_t num_base_bdevs; 492 493 uint8_t reserved[118]; 494 495 /* size of the base bdevs array */ 496 uint8_t base_bdevs_size; 497 /* array of base bdev descriptors */ 498 struct raid_bdev_sb_base_bdev base_bdevs[]; 499 }; 500 SPDK_STATIC_ASSERT(sizeof(struct raid_bdev_superblock) == 256, "incorrect size"); 501 502 #define RAID_BDEV_SB_MAX_LENGTH (sizeof(struct raid_bdev_superblock) + UINT8_MAX * sizeof(struct raid_bdev_sb_base_bdev)) 503 504 SPDK_STATIC_ASSERT(RAID_BDEV_SB_MAX_LENGTH < RAID_BDEV_MIN_DATA_OFFSET_SIZE, 505 "Incorrect min data offset"); 506 507 typedef void (*raid_bdev_write_sb_cb)(int status, struct raid_bdev *raid_bdev, void *ctx); 508 typedef void (*raid_bdev_load_sb_cb)(const struct raid_bdev_superblock *sb, int status, void *ctx); 509 510 int raid_bdev_alloc_superblock(struct raid_bdev *raid_bdev, uint32_t block_size); 511 void raid_bdev_free_superblock(struct raid_bdev *raid_bdev); 512 void raid_bdev_init_superblock(struct raid_bdev *raid_bdev); 513 void raid_bdev_write_superblock(struct raid_bdev *raid_bdev, raid_bdev_write_sb_cb cb, 514 void *cb_ctx); 515 int raid_bdev_load_base_bdev_superblock(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 516 raid_bdev_load_sb_cb cb, void *cb_ctx); 517 518 struct spdk_raid_bdev_opts { 519 /* Size of the background process window in KiB */ 520 uint32_t process_window_size_kb; 521 }; 522 523 void raid_bdev_get_opts(struct spdk_raid_bdev_opts *opts); 524 int raid_bdev_set_opts(const struct spdk_raid_bdev_opts *opts); 525 526 #endif /* SPDK_BDEV_RAID_INTERNAL_H */ 527