1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2018 Intel Corporation. 3 * Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. 4 * All rights reserved. 5 */ 6 7 /* 8 * Common code for partition-like virtual bdevs. 9 */ 10 11 #include "spdk/bdev.h" 12 #include "spdk/likely.h" 13 #include "spdk/log.h" 14 #include "spdk/string.h" 15 #include "spdk/thread.h" 16 17 #include "spdk/bdev_module.h" 18 19 struct spdk_bdev_part_base { 20 struct spdk_bdev *bdev; 21 struct spdk_bdev_desc *desc; 22 uint32_t ref; 23 uint32_t channel_size; 24 spdk_bdev_part_base_free_fn base_free_fn; 25 void *ctx; 26 bool claimed; 27 struct spdk_bdev_module *module; 28 struct spdk_bdev_fn_table *fn_table; 29 struct bdev_part_tailq *tailq; 30 spdk_io_channel_create_cb ch_create_cb; 31 spdk_io_channel_destroy_cb ch_destroy_cb; 32 spdk_bdev_remove_cb_t remove_cb; 33 struct spdk_thread *thread; 34 }; 35 36 struct spdk_bdev * 37 spdk_bdev_part_base_get_bdev(struct spdk_bdev_part_base *part_base) 38 { 39 return part_base->bdev; 40 } 41 42 struct spdk_bdev_desc * 43 spdk_bdev_part_base_get_desc(struct spdk_bdev_part_base *part_base) 44 { 45 return part_base->desc; 46 } 47 48 struct bdev_part_tailq * 49 spdk_bdev_part_base_get_tailq(struct spdk_bdev_part_base *part_base) 50 { 51 return part_base->tailq; 52 } 53 54 void * 55 spdk_bdev_part_base_get_ctx(struct spdk_bdev_part_base *part_base) 56 { 57 return part_base->ctx; 58 } 59 60 const char * 61 spdk_bdev_part_base_get_bdev_name(struct spdk_bdev_part_base *part_base) 62 { 63 return part_base->bdev->name; 64 } 65 66 static void 67 bdev_part_base_free(void *ctx) 68 { 69 struct spdk_bdev_desc *desc = ctx; 70 71 spdk_bdev_close(desc); 72 } 73 74 void 75 spdk_bdev_part_base_free(struct spdk_bdev_part_base *base) 76 { 77 if (base->desc) { 78 /* Close the underlying bdev on its same opened thread. */ 79 if (base->thread && base->thread != spdk_get_thread()) { 80 spdk_thread_send_msg(base->thread, bdev_part_base_free, base->desc); 81 } else { 82 spdk_bdev_close(base->desc); 83 } 84 } 85 86 if (base->base_free_fn != NULL) { 87 base->base_free_fn(base->ctx); 88 } 89 90 free(base); 91 } 92 93 static void 94 bdev_part_free_cb(void *io_device) 95 { 96 struct spdk_bdev_part *part = io_device; 97 struct spdk_bdev_part_base *base; 98 99 assert(part); 100 assert(part->internal.base); 101 102 base = part->internal.base; 103 104 TAILQ_REMOVE(base->tailq, part, tailq); 105 106 if (--base->ref == 0) { 107 spdk_bdev_module_release_bdev(base->bdev); 108 spdk_bdev_part_base_free(base); 109 } 110 111 spdk_bdev_destruct_done(&part->internal.bdev, 0); 112 free(part->internal.bdev.name); 113 free(part->internal.bdev.product_name); 114 free(part); 115 } 116 117 int 118 spdk_bdev_part_free(struct spdk_bdev_part *part) 119 { 120 spdk_io_device_unregister(part, bdev_part_free_cb); 121 122 /* Return 1 to indicate that this is an asynchronous operation that isn't complete 123 * until spdk_bdev_destruct_done is called */ 124 return 1; 125 } 126 127 void 128 spdk_bdev_part_base_hotremove(struct spdk_bdev_part_base *part_base, struct bdev_part_tailq *tailq) 129 { 130 struct spdk_bdev_part *part, *tmp; 131 132 TAILQ_FOREACH_SAFE(part, tailq, tailq, tmp) { 133 if (part->internal.base == part_base) { 134 spdk_bdev_unregister(&part->internal.bdev, NULL, NULL); 135 } 136 } 137 } 138 139 static bool 140 bdev_part_io_type_supported(void *_part, enum spdk_bdev_io_type io_type) 141 { 142 struct spdk_bdev_part *part = _part; 143 144 /* We can't decode/modify passthrough NVMe commands, so don't report 145 * that a partition supports these io types, even if the underlying 146 * bdev does. 147 */ 148 switch (io_type) { 149 case SPDK_BDEV_IO_TYPE_NVME_ADMIN: 150 case SPDK_BDEV_IO_TYPE_NVME_IO: 151 case SPDK_BDEV_IO_TYPE_NVME_IO_MD: 152 return false; 153 default: 154 break; 155 } 156 157 return part->internal.base->bdev->fn_table->io_type_supported(part->internal.base->bdev->ctxt, 158 io_type); 159 } 160 161 static struct spdk_io_channel * 162 bdev_part_get_io_channel(void *_part) 163 { 164 struct spdk_bdev_part *part = _part; 165 166 return spdk_get_io_channel(part); 167 } 168 169 struct spdk_bdev * 170 spdk_bdev_part_get_bdev(struct spdk_bdev_part *part) 171 { 172 return &part->internal.bdev; 173 } 174 175 struct spdk_bdev_part_base * 176 spdk_bdev_part_get_base(struct spdk_bdev_part *part) 177 { 178 return part->internal.base; 179 } 180 181 struct spdk_bdev * 182 spdk_bdev_part_get_base_bdev(struct spdk_bdev_part *part) 183 { 184 return part->internal.base->bdev; 185 } 186 187 uint64_t 188 spdk_bdev_part_get_offset_blocks(struct spdk_bdev_part *part) 189 { 190 return part->internal.offset_blocks; 191 } 192 193 static int 194 bdev_part_remap_dif(struct spdk_bdev_io *bdev_io, uint32_t offset, 195 uint32_t remapped_offset) 196 { 197 struct spdk_bdev *bdev = bdev_io->bdev; 198 struct spdk_dif_ctx dif_ctx; 199 struct spdk_dif_error err_blk = {}; 200 int rc; 201 202 if (spdk_likely(!(bdev->dif_check_flags & SPDK_DIF_FLAGS_REFTAG_CHECK))) { 203 return 0; 204 } 205 206 rc = spdk_dif_ctx_init(&dif_ctx, 207 bdev->blocklen, bdev->md_len, bdev->md_interleave, 208 bdev->dif_is_head_of_md, bdev->dif_type, bdev->dif_check_flags, 209 offset, 0, 0, 0, 0); 210 if (rc != 0) { 211 SPDK_ERRLOG("Initialization of DIF context failed\n"); 212 return rc; 213 } 214 215 spdk_dif_ctx_set_remapped_init_ref_tag(&dif_ctx, remapped_offset); 216 217 if (bdev->md_interleave) { 218 rc = spdk_dif_remap_ref_tag(bdev_io->u.bdev.iovs, bdev_io->u.bdev.iovcnt, 219 bdev_io->u.bdev.num_blocks, &dif_ctx, &err_blk); 220 } else { 221 struct iovec md_iov = { 222 .iov_base = bdev_io->u.bdev.md_buf, 223 .iov_len = bdev_io->u.bdev.num_blocks * bdev->md_len, 224 }; 225 226 rc = spdk_dix_remap_ref_tag(&md_iov, bdev_io->u.bdev.num_blocks, &dif_ctx, &err_blk); 227 } 228 229 if (rc != 0) { 230 SPDK_ERRLOG("Remapping reference tag failed. type=%d, offset=%" PRIu32 "\n", 231 err_blk.err_type, err_blk.err_offset); 232 } 233 234 return rc; 235 } 236 237 static void 238 bdev_part_complete_io(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 239 { 240 struct spdk_bdev_io *part_io = cb_arg; 241 uint32_t offset, remapped_offset; 242 spdk_bdev_io_completion_cb cb; 243 int rc, status; 244 245 switch (bdev_io->type) { 246 case SPDK_BDEV_IO_TYPE_READ: 247 if (success) { 248 offset = bdev_io->u.bdev.offset_blocks; 249 remapped_offset = part_io->u.bdev.offset_blocks; 250 251 rc = bdev_part_remap_dif(bdev_io, offset, remapped_offset); 252 if (rc != 0) { 253 success = false; 254 } 255 } 256 break; 257 case SPDK_BDEV_IO_TYPE_ZCOPY: 258 spdk_bdev_io_set_buf(part_io, bdev_io->u.bdev.iovs[0].iov_base, 259 bdev_io->u.bdev.iovs[0].iov_len); 260 break; 261 default: 262 break; 263 } 264 265 266 cb = part_io->u.bdev.stored_user_cb; 267 if (cb != NULL) { 268 cb(part_io, success, NULL); 269 } else { 270 status = success ? SPDK_BDEV_IO_STATUS_SUCCESS : SPDK_BDEV_IO_STATUS_FAILED; 271 272 spdk_bdev_io_complete(part_io, status); 273 } 274 275 spdk_bdev_free_io(bdev_io); 276 } 277 278 int 279 spdk_bdev_part_submit_request_ext(struct spdk_bdev_part_channel *ch, struct spdk_bdev_io *bdev_io, 280 spdk_bdev_io_completion_cb cb) 281 { 282 struct spdk_bdev_part *part = ch->part; 283 struct spdk_io_channel *base_ch = ch->base_ch; 284 struct spdk_bdev_desc *base_desc = part->internal.base->desc; 285 uint64_t offset, remapped_offset, remapped_src_offset; 286 int rc = 0; 287 288 bdev_io->u.bdev.stored_user_cb = cb; 289 290 offset = bdev_io->u.bdev.offset_blocks; 291 remapped_offset = offset + part->internal.offset_blocks; 292 293 /* Modify the I/O to adjust for the offset within the base bdev. */ 294 switch (bdev_io->type) { 295 case SPDK_BDEV_IO_TYPE_READ: 296 if (bdev_io->u.bdev.ext_opts) { 297 rc = spdk_bdev_readv_blocks_ext(base_desc, base_ch, bdev_io->u.bdev.iovs, 298 bdev_io->u.bdev.iovcnt, remapped_offset, 299 bdev_io->u.bdev.num_blocks, 300 bdev_part_complete_io, bdev_io, 301 bdev_io->u.bdev.ext_opts); 302 } else { 303 rc = spdk_bdev_readv_blocks_with_md(base_desc, base_ch, 304 bdev_io->u.bdev.iovs, 305 bdev_io->u.bdev.iovcnt, 306 bdev_io->u.bdev.md_buf, remapped_offset, 307 bdev_io->u.bdev.num_blocks, 308 bdev_part_complete_io, bdev_io); 309 } 310 break; 311 case SPDK_BDEV_IO_TYPE_WRITE: 312 rc = bdev_part_remap_dif(bdev_io, offset, remapped_offset); 313 if (rc != 0) { 314 return SPDK_BDEV_IO_STATUS_FAILED; 315 } 316 317 if (bdev_io->u.bdev.ext_opts) { 318 rc = spdk_bdev_writev_blocks_ext(base_desc, base_ch, bdev_io->u.bdev.iovs, 319 bdev_io->u.bdev.iovcnt, remapped_offset, 320 bdev_io->u.bdev.num_blocks, 321 bdev_part_complete_io, bdev_io, 322 bdev_io->u.bdev.ext_opts); 323 } else { 324 rc = spdk_bdev_writev_blocks_with_md(base_desc, base_ch, 325 bdev_io->u.bdev.iovs, 326 bdev_io->u.bdev.iovcnt, 327 bdev_io->u.bdev.md_buf, remapped_offset, 328 bdev_io->u.bdev.num_blocks, 329 bdev_part_complete_io, bdev_io); 330 } 331 break; 332 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 333 rc = spdk_bdev_write_zeroes_blocks(base_desc, base_ch, remapped_offset, 334 bdev_io->u.bdev.num_blocks, bdev_part_complete_io, 335 bdev_io); 336 break; 337 case SPDK_BDEV_IO_TYPE_UNMAP: 338 rc = spdk_bdev_unmap_blocks(base_desc, base_ch, remapped_offset, 339 bdev_io->u.bdev.num_blocks, bdev_part_complete_io, 340 bdev_io); 341 break; 342 case SPDK_BDEV_IO_TYPE_FLUSH: 343 rc = spdk_bdev_flush_blocks(base_desc, base_ch, remapped_offset, 344 bdev_io->u.bdev.num_blocks, bdev_part_complete_io, 345 bdev_io); 346 break; 347 case SPDK_BDEV_IO_TYPE_RESET: 348 rc = spdk_bdev_reset(base_desc, base_ch, 349 bdev_part_complete_io, bdev_io); 350 break; 351 case SPDK_BDEV_IO_TYPE_ZCOPY: 352 rc = spdk_bdev_zcopy_start(base_desc, base_ch, NULL, 0, remapped_offset, 353 bdev_io->u.bdev.num_blocks, bdev_io->u.bdev.zcopy.populate, 354 bdev_part_complete_io, bdev_io); 355 break; 356 case SPDK_BDEV_IO_TYPE_COMPARE: 357 if (!bdev_io->u.bdev.md_buf) { 358 rc = spdk_bdev_comparev_blocks(base_desc, base_ch, 359 bdev_io->u.bdev.iovs, 360 bdev_io->u.bdev.iovcnt, 361 remapped_offset, 362 bdev_io->u.bdev.num_blocks, 363 bdev_part_complete_io, bdev_io); 364 } else { 365 rc = spdk_bdev_comparev_blocks_with_md(base_desc, base_ch, 366 bdev_io->u.bdev.iovs, 367 bdev_io->u.bdev.iovcnt, 368 bdev_io->u.bdev.md_buf, 369 remapped_offset, 370 bdev_io->u.bdev.num_blocks, 371 bdev_part_complete_io, bdev_io); 372 } 373 break; 374 case SPDK_BDEV_IO_TYPE_COMPARE_AND_WRITE: 375 rc = spdk_bdev_comparev_and_writev_blocks(base_desc, base_ch, bdev_io->u.bdev.iovs, 376 bdev_io->u.bdev.iovcnt, 377 bdev_io->u.bdev.fused_iovs, 378 bdev_io->u.bdev.fused_iovcnt, 379 remapped_offset, 380 bdev_io->u.bdev.num_blocks, 381 bdev_part_complete_io, bdev_io); 382 break; 383 case SPDK_BDEV_IO_TYPE_COPY: 384 remapped_src_offset = bdev_io->u.bdev.copy.src_offset_blocks + part->internal.offset_blocks; 385 rc = spdk_bdev_copy_blocks(base_desc, base_ch, remapped_offset, remapped_src_offset, 386 bdev_io->u.bdev.num_blocks, bdev_part_complete_io, 387 bdev_io); 388 break; 389 default: 390 SPDK_ERRLOG("unknown I/O type %d\n", bdev_io->type); 391 return SPDK_BDEV_IO_STATUS_FAILED; 392 } 393 394 return rc; 395 } 396 397 int 398 spdk_bdev_part_submit_request(struct spdk_bdev_part_channel *ch, struct spdk_bdev_io *bdev_io) 399 { 400 return spdk_bdev_part_submit_request_ext(ch, bdev_io, NULL); 401 } 402 403 static int 404 bdev_part_channel_create_cb(void *io_device, void *ctx_buf) 405 { 406 struct spdk_bdev_part *part = (struct spdk_bdev_part *)io_device; 407 struct spdk_bdev_part_channel *ch = ctx_buf; 408 409 ch->part = part; 410 ch->base_ch = spdk_bdev_get_io_channel(part->internal.base->desc); 411 if (ch->base_ch == NULL) { 412 return -1; 413 } 414 415 if (part->internal.base->ch_create_cb) { 416 return part->internal.base->ch_create_cb(io_device, ctx_buf); 417 } else { 418 return 0; 419 } 420 } 421 422 static void 423 bdev_part_channel_destroy_cb(void *io_device, void *ctx_buf) 424 { 425 struct spdk_bdev_part *part = (struct spdk_bdev_part *)io_device; 426 struct spdk_bdev_part_channel *ch = ctx_buf; 427 428 if (part->internal.base->ch_destroy_cb) { 429 part->internal.base->ch_destroy_cb(io_device, ctx_buf); 430 } 431 spdk_put_io_channel(ch->base_ch); 432 } 433 434 static void 435 bdev_part_base_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, 436 void *event_ctx) 437 { 438 struct spdk_bdev_part_base *base = event_ctx; 439 440 switch (type) { 441 case SPDK_BDEV_EVENT_REMOVE: 442 base->remove_cb(base); 443 break; 444 default: 445 SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type); 446 break; 447 } 448 } 449 450 int 451 spdk_bdev_part_base_construct_ext(const char *bdev_name, 452 spdk_bdev_remove_cb_t remove_cb, struct spdk_bdev_module *module, 453 struct spdk_bdev_fn_table *fn_table, struct bdev_part_tailq *tailq, 454 spdk_bdev_part_base_free_fn free_fn, void *ctx, 455 uint32_t channel_size, spdk_io_channel_create_cb ch_create_cb, 456 spdk_io_channel_destroy_cb ch_destroy_cb, 457 struct spdk_bdev_part_base **_base) 458 { 459 int rc; 460 struct spdk_bdev_part_base *base; 461 462 if (_base == NULL) { 463 return -EINVAL; 464 } 465 466 base = calloc(1, sizeof(*base)); 467 if (!base) { 468 SPDK_ERRLOG("Memory allocation failure\n"); 469 return -ENOMEM; 470 } 471 fn_table->get_io_channel = bdev_part_get_io_channel; 472 fn_table->io_type_supported = bdev_part_io_type_supported; 473 474 base->desc = NULL; 475 base->ref = 0; 476 base->module = module; 477 base->fn_table = fn_table; 478 base->tailq = tailq; 479 base->base_free_fn = free_fn; 480 base->ctx = ctx; 481 base->claimed = false; 482 base->channel_size = channel_size; 483 base->ch_create_cb = ch_create_cb; 484 base->ch_destroy_cb = ch_destroy_cb; 485 base->remove_cb = remove_cb; 486 487 rc = spdk_bdev_open_ext(bdev_name, false, bdev_part_base_event_cb, base, &base->desc); 488 if (rc) { 489 if (rc == -ENODEV) { 490 free(base); 491 } else { 492 SPDK_ERRLOG("could not open bdev %s: %s\n", bdev_name, spdk_strerror(-rc)); 493 spdk_bdev_part_base_free(base); 494 } 495 return rc; 496 } 497 498 base->bdev = spdk_bdev_desc_get_bdev(base->desc); 499 500 /* Save the thread where the base device is opened */ 501 base->thread = spdk_get_thread(); 502 503 *_base = base; 504 505 return 0; 506 } 507 508 int 509 spdk_bdev_part_construct(struct spdk_bdev_part *part, struct spdk_bdev_part_base *base, 510 char *name, uint64_t offset_blocks, uint64_t num_blocks, 511 char *product_name) 512 { 513 part->internal.bdev.blocklen = base->bdev->blocklen; 514 part->internal.bdev.blockcnt = num_blocks; 515 part->internal.offset_blocks = offset_blocks; 516 517 part->internal.bdev.write_cache = base->bdev->write_cache; 518 part->internal.bdev.required_alignment = base->bdev->required_alignment; 519 part->internal.bdev.ctxt = part; 520 part->internal.bdev.module = base->module; 521 part->internal.bdev.fn_table = base->fn_table; 522 523 part->internal.bdev.md_interleave = base->bdev->md_interleave; 524 part->internal.bdev.md_len = base->bdev->md_len; 525 part->internal.bdev.dif_type = base->bdev->dif_type; 526 part->internal.bdev.dif_is_head_of_md = base->bdev->dif_is_head_of_md; 527 part->internal.bdev.dif_check_flags = base->bdev->dif_check_flags; 528 529 part->internal.bdev.name = strdup(name); 530 if (part->internal.bdev.name == NULL) { 531 SPDK_ERRLOG("Failed to allocate name for new part of bdev %s\n", spdk_bdev_get_name(base->bdev)); 532 return -1; 533 } 534 535 part->internal.bdev.product_name = strdup(product_name); 536 if (part->internal.bdev.product_name == NULL) { 537 free(part->internal.bdev.name); 538 SPDK_ERRLOG("Failed to allocate product name for new part of bdev %s\n", 539 spdk_bdev_get_name(base->bdev)); 540 return -1; 541 } 542 543 base->ref++; 544 part->internal.base = base; 545 546 if (!base->claimed) { 547 int rc; 548 549 rc = spdk_bdev_module_claim_bdev(base->bdev, base->desc, base->module); 550 if (rc) { 551 SPDK_ERRLOG("could not claim bdev %s\n", spdk_bdev_get_name(base->bdev)); 552 free(part->internal.bdev.name); 553 free(part->internal.bdev.product_name); 554 return -1; 555 } 556 base->claimed = true; 557 } 558 559 spdk_io_device_register(part, bdev_part_channel_create_cb, 560 bdev_part_channel_destroy_cb, 561 base->channel_size, 562 name); 563 564 spdk_bdev_register(&part->internal.bdev); 565 TAILQ_INSERT_TAIL(base->tailq, part, tailq); 566 567 return 0; 568 } 569