1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2017 Intel Corporation. 3 * All rights reserved. 4 * Copyright (c) 2021-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 5 */ 6 7 #include "spdk/stdinc.h" 8 9 #include "spdk/blob.h" 10 #include "spdk/crc32.h" 11 #include "spdk/env.h" 12 #include "spdk/queue.h" 13 #include "spdk/thread.h" 14 #include "spdk/bit_array.h" 15 #include "spdk/bit_pool.h" 16 #include "spdk/likely.h" 17 #include "spdk/util.h" 18 #include "spdk/string.h" 19 #include "spdk/trace.h" 20 21 #include "spdk_internal/assert.h" 22 #include "spdk_internal/trace_defs.h" 23 #include "spdk/log.h" 24 25 #include "blobstore.h" 26 27 #define BLOB_CRC32C_INITIAL 0xffffffffUL 28 29 static int bs_register_md_thread(struct spdk_blob_store *bs); 30 static int bs_unregister_md_thread(struct spdk_blob_store *bs); 31 static void blob_close_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno); 32 static void blob_insert_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 33 uint64_t cluster, uint32_t extent, struct spdk_blob_md_page *page, 34 spdk_blob_op_complete cb_fn, void *cb_arg); 35 static void blob_free_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 36 uint32_t extent_page, struct spdk_blob_md_page *page, spdk_blob_op_complete cb_fn, void *cb_arg); 37 38 static int blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 39 uint16_t value_len, bool internal); 40 static int blob_get_xattr_value(struct spdk_blob *blob, const char *name, 41 const void **value, size_t *value_len, bool internal); 42 static int blob_remove_xattr(struct spdk_blob *blob, const char *name, bool internal); 43 44 static void blob_write_extent_page(struct spdk_blob *blob, uint32_t extent, uint64_t cluster_num, 45 struct spdk_blob_md_page *page, spdk_blob_op_complete cb_fn, void *cb_arg); 46 static void blob_freeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg); 47 48 static void bs_shallow_copy_cluster_find_next(void *cb_arg); 49 50 /* 51 * External snapshots require a channel per thread per esnap bdev. The tree 52 * is populated lazily as blob IOs are handled by the back_bs_dev. When this 53 * channel is destroyed, all the channels in the tree are destroyed. 54 */ 55 56 struct blob_esnap_channel { 57 RB_ENTRY(blob_esnap_channel) node; 58 spdk_blob_id blob_id; 59 struct spdk_io_channel *channel; 60 }; 61 62 static int blob_esnap_channel_compare(struct blob_esnap_channel *c1, struct blob_esnap_channel *c2); 63 static void blob_esnap_destroy_bs_dev_channels(struct spdk_blob *blob, bool abort_io, 64 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg); 65 static void blob_esnap_destroy_bs_channel(struct spdk_bs_channel *ch); 66 static void blob_set_back_bs_dev_frozen(void *_ctx, int bserrno); 67 RB_GENERATE_STATIC(blob_esnap_channel_tree, blob_esnap_channel, node, blob_esnap_channel_compare) 68 69 static inline bool 70 blob_is_esnap_clone(const struct spdk_blob *blob) 71 { 72 assert(blob != NULL); 73 return !!(blob->invalid_flags & SPDK_BLOB_EXTERNAL_SNAPSHOT); 74 } 75 76 static int 77 blob_id_cmp(struct spdk_blob *blob1, struct spdk_blob *blob2) 78 { 79 assert(blob1 != NULL && blob2 != NULL); 80 return (blob1->id < blob2->id ? -1 : blob1->id > blob2->id); 81 } 82 83 RB_GENERATE_STATIC(spdk_blob_tree, spdk_blob, link, blob_id_cmp); 84 85 static void 86 blob_verify_md_op(struct spdk_blob *blob) 87 { 88 assert(blob != NULL); 89 assert(spdk_get_thread() == blob->bs->md_thread); 90 assert(blob->state != SPDK_BLOB_STATE_LOADING); 91 } 92 93 static struct spdk_blob_list * 94 bs_get_snapshot_entry(struct spdk_blob_store *bs, spdk_blob_id blobid) 95 { 96 struct spdk_blob_list *snapshot_entry = NULL; 97 98 TAILQ_FOREACH(snapshot_entry, &bs->snapshots, link) { 99 if (snapshot_entry->id == blobid) { 100 break; 101 } 102 } 103 104 return snapshot_entry; 105 } 106 107 static void 108 bs_claim_md_page(struct spdk_blob_store *bs, uint32_t page) 109 { 110 assert(spdk_spin_held(&bs->used_lock)); 111 assert(page < spdk_bit_array_capacity(bs->used_md_pages)); 112 assert(spdk_bit_array_get(bs->used_md_pages, page) == false); 113 114 spdk_bit_array_set(bs->used_md_pages, page); 115 } 116 117 static void 118 bs_release_md_page(struct spdk_blob_store *bs, uint32_t page) 119 { 120 assert(spdk_spin_held(&bs->used_lock)); 121 assert(page < spdk_bit_array_capacity(bs->used_md_pages)); 122 assert(spdk_bit_array_get(bs->used_md_pages, page) == true); 123 124 spdk_bit_array_clear(bs->used_md_pages, page); 125 } 126 127 static uint32_t 128 bs_claim_cluster(struct spdk_blob_store *bs) 129 { 130 uint32_t cluster_num; 131 132 assert(spdk_spin_held(&bs->used_lock)); 133 134 cluster_num = spdk_bit_pool_allocate_bit(bs->used_clusters); 135 if (cluster_num == UINT32_MAX) { 136 return UINT32_MAX; 137 } 138 139 SPDK_DEBUGLOG(blob, "Claiming cluster %u\n", cluster_num); 140 bs->num_free_clusters--; 141 142 return cluster_num; 143 } 144 145 static void 146 bs_release_cluster(struct spdk_blob_store *bs, uint32_t cluster_num) 147 { 148 assert(spdk_spin_held(&bs->used_lock)); 149 assert(cluster_num < spdk_bit_pool_capacity(bs->used_clusters)); 150 assert(spdk_bit_pool_is_allocated(bs->used_clusters, cluster_num) == true); 151 assert(bs->num_free_clusters < bs->total_clusters); 152 153 SPDK_DEBUGLOG(blob, "Releasing cluster %u\n", cluster_num); 154 155 spdk_bit_pool_free_bit(bs->used_clusters, cluster_num); 156 bs->num_free_clusters++; 157 } 158 159 static int 160 blob_insert_cluster(struct spdk_blob *blob, uint32_t cluster_num, uint64_t cluster) 161 { 162 uint64_t *cluster_lba = &blob->active.clusters[cluster_num]; 163 164 blob_verify_md_op(blob); 165 166 if (*cluster_lba != 0) { 167 return -EEXIST; 168 } 169 170 *cluster_lba = bs_cluster_to_lba(blob->bs, cluster); 171 blob->active.num_allocated_clusters++; 172 173 return 0; 174 } 175 176 static int 177 bs_allocate_cluster(struct spdk_blob *blob, uint32_t cluster_num, 178 uint64_t *cluster, uint32_t *lowest_free_md_page, bool update_map) 179 { 180 uint32_t *extent_page = 0; 181 182 assert(spdk_spin_held(&blob->bs->used_lock)); 183 184 *cluster = bs_claim_cluster(blob->bs); 185 if (*cluster == UINT32_MAX) { 186 /* No more free clusters. Cannot satisfy the request */ 187 return -ENOSPC; 188 } 189 190 if (blob->use_extent_table) { 191 extent_page = bs_cluster_to_extent_page(blob, cluster_num); 192 if (*extent_page == 0) { 193 /* Extent page shall never occupy md_page so start the search from 1 */ 194 if (*lowest_free_md_page == 0) { 195 *lowest_free_md_page = 1; 196 } 197 /* No extent_page is allocated for the cluster */ 198 *lowest_free_md_page = spdk_bit_array_find_first_clear(blob->bs->used_md_pages, 199 *lowest_free_md_page); 200 if (*lowest_free_md_page == UINT32_MAX) { 201 /* No more free md pages. Cannot satisfy the request */ 202 bs_release_cluster(blob->bs, *cluster); 203 return -ENOSPC; 204 } 205 bs_claim_md_page(blob->bs, *lowest_free_md_page); 206 } 207 } 208 209 SPDK_DEBUGLOG(blob, "Claiming cluster %" PRIu64 " for blob 0x%" PRIx64 "\n", *cluster, 210 blob->id); 211 212 if (update_map) { 213 blob_insert_cluster(blob, cluster_num, *cluster); 214 if (blob->use_extent_table && *extent_page == 0) { 215 *extent_page = *lowest_free_md_page; 216 } 217 } 218 219 return 0; 220 } 221 222 static void 223 blob_xattrs_init(struct spdk_blob_xattr_opts *xattrs) 224 { 225 xattrs->count = 0; 226 xattrs->names = NULL; 227 xattrs->ctx = NULL; 228 xattrs->get_value = NULL; 229 } 230 231 void 232 spdk_blob_opts_init(struct spdk_blob_opts *opts, size_t opts_size) 233 { 234 if (!opts) { 235 SPDK_ERRLOG("opts should not be NULL\n"); 236 return; 237 } 238 239 if (!opts_size) { 240 SPDK_ERRLOG("opts_size should not be zero value\n"); 241 return; 242 } 243 244 memset(opts, 0, opts_size); 245 opts->opts_size = opts_size; 246 247 #define FIELD_OK(field) \ 248 offsetof(struct spdk_blob_opts, field) + sizeof(opts->field) <= opts_size 249 250 #define SET_FIELD(field, value) \ 251 if (FIELD_OK(field)) { \ 252 opts->field = value; \ 253 } \ 254 255 SET_FIELD(num_clusters, 0); 256 SET_FIELD(thin_provision, false); 257 SET_FIELD(clear_method, BLOB_CLEAR_WITH_DEFAULT); 258 259 if (FIELD_OK(xattrs)) { 260 blob_xattrs_init(&opts->xattrs); 261 } 262 263 SET_FIELD(use_extent_table, true); 264 265 #undef FIELD_OK 266 #undef SET_FIELD 267 } 268 269 void 270 spdk_blob_open_opts_init(struct spdk_blob_open_opts *opts, size_t opts_size) 271 { 272 if (!opts) { 273 SPDK_ERRLOG("opts should not be NULL\n"); 274 return; 275 } 276 277 if (!opts_size) { 278 SPDK_ERRLOG("opts_size should not be zero value\n"); 279 return; 280 } 281 282 memset(opts, 0, opts_size); 283 opts->opts_size = opts_size; 284 285 #define FIELD_OK(field) \ 286 offsetof(struct spdk_blob_open_opts, field) + sizeof(opts->field) <= opts_size 287 288 #define SET_FIELD(field, value) \ 289 if (FIELD_OK(field)) { \ 290 opts->field = value; \ 291 } \ 292 293 SET_FIELD(clear_method, BLOB_CLEAR_WITH_DEFAULT); 294 295 #undef FIELD_OK 296 #undef SET_FILED 297 } 298 299 static struct spdk_blob * 300 blob_alloc(struct spdk_blob_store *bs, spdk_blob_id id) 301 { 302 struct spdk_blob *blob; 303 304 blob = calloc(1, sizeof(*blob)); 305 if (!blob) { 306 return NULL; 307 } 308 309 blob->id = id; 310 blob->bs = bs; 311 312 blob->parent_id = SPDK_BLOBID_INVALID; 313 314 blob->state = SPDK_BLOB_STATE_DIRTY; 315 blob->extent_rle_found = false; 316 blob->extent_table_found = false; 317 blob->active.num_pages = 1; 318 blob->active.pages = calloc(1, sizeof(*blob->active.pages)); 319 if (!blob->active.pages) { 320 free(blob); 321 return NULL; 322 } 323 324 blob->active.pages[0] = bs_blobid_to_page(id); 325 326 TAILQ_INIT(&blob->xattrs); 327 TAILQ_INIT(&blob->xattrs_internal); 328 TAILQ_INIT(&blob->pending_persists); 329 TAILQ_INIT(&blob->persists_to_complete); 330 331 return blob; 332 } 333 334 static void 335 xattrs_free(struct spdk_xattr_tailq *xattrs) 336 { 337 struct spdk_xattr *xattr, *xattr_tmp; 338 339 TAILQ_FOREACH_SAFE(xattr, xattrs, link, xattr_tmp) { 340 TAILQ_REMOVE(xattrs, xattr, link); 341 free(xattr->name); 342 free(xattr->value); 343 free(xattr); 344 } 345 } 346 347 static void 348 blob_unref_back_bs_dev(struct spdk_blob *blob) 349 { 350 blob->back_bs_dev->destroy(blob->back_bs_dev); 351 blob->back_bs_dev = NULL; 352 } 353 354 static void 355 blob_free(struct spdk_blob *blob) 356 { 357 assert(blob != NULL); 358 assert(TAILQ_EMPTY(&blob->pending_persists)); 359 assert(TAILQ_EMPTY(&blob->persists_to_complete)); 360 361 free(blob->active.extent_pages); 362 free(blob->clean.extent_pages); 363 free(blob->active.clusters); 364 free(blob->clean.clusters); 365 free(blob->active.pages); 366 free(blob->clean.pages); 367 368 xattrs_free(&blob->xattrs); 369 xattrs_free(&blob->xattrs_internal); 370 371 if (blob->back_bs_dev) { 372 blob_unref_back_bs_dev(blob); 373 } 374 375 free(blob); 376 } 377 378 static void 379 blob_back_bs_destroy_esnap_done(void *ctx, struct spdk_blob *blob, int bserrno) 380 { 381 struct spdk_bs_dev *bs_dev = ctx; 382 383 if (bserrno != 0) { 384 /* 385 * This is probably due to a memory allocation failure when creating the 386 * blob_esnap_destroy_ctx before iterating threads. 387 */ 388 SPDK_ERRLOG("blob 0x%" PRIx64 ": Unable to destroy bs dev channels: error %d\n", 389 blob->id, bserrno); 390 assert(false); 391 } 392 393 if (bs_dev == NULL) { 394 /* 395 * This check exists to make scanbuild happy. 396 * 397 * blob->back_bs_dev for an esnap is NULL during the first iteration of blobs while 398 * the blobstore is being loaded. It could also be NULL if there was an error 399 * opening the esnap device. In each of these cases, no channels could have been 400 * created because back_bs_dev->create_channel() would have led to a NULL pointer 401 * deref. 402 */ 403 assert(false); 404 return; 405 } 406 407 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": calling destroy on back_bs_dev\n", blob->id); 408 bs_dev->destroy(bs_dev); 409 } 410 411 static void 412 blob_back_bs_destroy(struct spdk_blob *blob) 413 { 414 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": preparing to destroy back_bs_dev\n", 415 blob->id); 416 417 blob_esnap_destroy_bs_dev_channels(blob, false, blob_back_bs_destroy_esnap_done, 418 blob->back_bs_dev); 419 blob->back_bs_dev = NULL; 420 } 421 422 struct blob_parent { 423 union { 424 struct { 425 spdk_blob_id id; 426 struct spdk_blob *blob; 427 } snapshot; 428 429 struct { 430 void *id; 431 uint32_t id_len; 432 struct spdk_bs_dev *back_bs_dev; 433 } esnap; 434 } u; 435 }; 436 437 typedef int (*set_parent_refs_cb)(struct spdk_blob *blob, struct blob_parent *parent); 438 439 struct set_bs_dev_ctx { 440 struct spdk_blob *blob; 441 struct spdk_bs_dev *back_bs_dev; 442 443 /* 444 * This callback is used during a set parent operation to change the references 445 * to the parent of the blob. 446 */ 447 set_parent_refs_cb parent_refs_cb_fn; 448 struct blob_parent *parent_refs_cb_arg; 449 450 spdk_blob_op_complete cb_fn; 451 void *cb_arg; 452 int bserrno; 453 }; 454 455 static void 456 blob_set_back_bs_dev(struct spdk_blob *blob, struct spdk_bs_dev *back_bs_dev, 457 set_parent_refs_cb parent_refs_cb_fn, struct blob_parent *parent_refs_cb_arg, 458 spdk_blob_op_complete cb_fn, void *cb_arg) 459 { 460 struct set_bs_dev_ctx *ctx; 461 462 ctx = calloc(1, sizeof(*ctx)); 463 if (ctx == NULL) { 464 SPDK_ERRLOG("blob 0x%" PRIx64 ": out of memory while setting back_bs_dev\n", 465 blob->id); 466 cb_fn(cb_arg, -ENOMEM); 467 return; 468 } 469 470 ctx->parent_refs_cb_fn = parent_refs_cb_fn; 471 ctx->parent_refs_cb_arg = parent_refs_cb_arg; 472 ctx->cb_fn = cb_fn; 473 ctx->cb_arg = cb_arg; 474 ctx->back_bs_dev = back_bs_dev; 475 ctx->blob = blob; 476 477 blob_freeze_io(blob, blob_set_back_bs_dev_frozen, ctx); 478 } 479 480 struct freeze_io_ctx { 481 struct spdk_bs_cpl cpl; 482 struct spdk_blob *blob; 483 }; 484 485 static void 486 blob_io_sync(struct spdk_io_channel_iter *i) 487 { 488 spdk_for_each_channel_continue(i, 0); 489 } 490 491 static void 492 blob_execute_queued_io(struct spdk_io_channel_iter *i) 493 { 494 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 495 struct spdk_bs_channel *ch = spdk_io_channel_get_ctx(_ch); 496 struct freeze_io_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 497 struct spdk_bs_request_set *set; 498 struct spdk_bs_user_op_args *args; 499 spdk_bs_user_op_t *op, *tmp; 500 501 TAILQ_FOREACH_SAFE(op, &ch->queued_io, link, tmp) { 502 set = (struct spdk_bs_request_set *)op; 503 args = &set->u.user_op; 504 505 if (args->blob == ctx->blob) { 506 TAILQ_REMOVE(&ch->queued_io, op, link); 507 bs_user_op_execute(op); 508 } 509 } 510 511 spdk_for_each_channel_continue(i, 0); 512 } 513 514 static void 515 blob_io_cpl(struct spdk_io_channel_iter *i, int status) 516 { 517 struct freeze_io_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 518 519 ctx->cpl.u.blob_basic.cb_fn(ctx->cpl.u.blob_basic.cb_arg, 0); 520 521 free(ctx); 522 } 523 524 static void 525 blob_freeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 526 { 527 struct freeze_io_ctx *ctx; 528 529 blob_verify_md_op(blob); 530 531 ctx = calloc(1, sizeof(*ctx)); 532 if (!ctx) { 533 cb_fn(cb_arg, -ENOMEM); 534 return; 535 } 536 537 ctx->cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 538 ctx->cpl.u.blob_basic.cb_fn = cb_fn; 539 ctx->cpl.u.blob_basic.cb_arg = cb_arg; 540 ctx->blob = blob; 541 542 /* Freeze I/O on blob */ 543 blob->frozen_refcnt++; 544 545 spdk_for_each_channel(blob->bs, blob_io_sync, ctx, blob_io_cpl); 546 } 547 548 static void 549 blob_unfreeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 550 { 551 struct freeze_io_ctx *ctx; 552 553 blob_verify_md_op(blob); 554 555 ctx = calloc(1, sizeof(*ctx)); 556 if (!ctx) { 557 cb_fn(cb_arg, -ENOMEM); 558 return; 559 } 560 561 ctx->cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 562 ctx->cpl.u.blob_basic.cb_fn = cb_fn; 563 ctx->cpl.u.blob_basic.cb_arg = cb_arg; 564 ctx->blob = blob; 565 566 assert(blob->frozen_refcnt > 0); 567 568 blob->frozen_refcnt--; 569 570 spdk_for_each_channel(blob->bs, blob_execute_queued_io, ctx, blob_io_cpl); 571 } 572 573 static int 574 blob_mark_clean(struct spdk_blob *blob) 575 { 576 uint32_t *extent_pages = NULL; 577 uint64_t *clusters = NULL; 578 uint32_t *pages = NULL; 579 580 assert(blob != NULL); 581 582 if (blob->active.num_extent_pages) { 583 assert(blob->active.extent_pages); 584 extent_pages = calloc(blob->active.num_extent_pages, sizeof(*blob->active.extent_pages)); 585 if (!extent_pages) { 586 return -ENOMEM; 587 } 588 memcpy(extent_pages, blob->active.extent_pages, 589 blob->active.num_extent_pages * sizeof(*extent_pages)); 590 } 591 592 if (blob->active.num_clusters) { 593 assert(blob->active.clusters); 594 clusters = calloc(blob->active.num_clusters, sizeof(*blob->active.clusters)); 595 if (!clusters) { 596 free(extent_pages); 597 return -ENOMEM; 598 } 599 memcpy(clusters, blob->active.clusters, blob->active.num_clusters * sizeof(*blob->active.clusters)); 600 } 601 602 if (blob->active.num_pages) { 603 assert(blob->active.pages); 604 pages = calloc(blob->active.num_pages, sizeof(*blob->active.pages)); 605 if (!pages) { 606 free(extent_pages); 607 free(clusters); 608 return -ENOMEM; 609 } 610 memcpy(pages, blob->active.pages, blob->active.num_pages * sizeof(*blob->active.pages)); 611 } 612 613 free(blob->clean.extent_pages); 614 free(blob->clean.clusters); 615 free(blob->clean.pages); 616 617 blob->clean.num_extent_pages = blob->active.num_extent_pages; 618 blob->clean.extent_pages = blob->active.extent_pages; 619 blob->clean.num_clusters = blob->active.num_clusters; 620 blob->clean.clusters = blob->active.clusters; 621 blob->clean.num_allocated_clusters = blob->active.num_allocated_clusters; 622 blob->clean.num_pages = blob->active.num_pages; 623 blob->clean.pages = blob->active.pages; 624 625 blob->active.extent_pages = extent_pages; 626 blob->active.clusters = clusters; 627 blob->active.pages = pages; 628 629 /* If the metadata was dirtied again while the metadata was being written to disk, 630 * we do not want to revert the DIRTY state back to CLEAN here. 631 */ 632 if (blob->state == SPDK_BLOB_STATE_LOADING) { 633 blob->state = SPDK_BLOB_STATE_CLEAN; 634 } 635 636 return 0; 637 } 638 639 static int 640 blob_deserialize_xattr(struct spdk_blob *blob, 641 struct spdk_blob_md_descriptor_xattr *desc_xattr, bool internal) 642 { 643 struct spdk_xattr *xattr; 644 645 if (desc_xattr->length != sizeof(desc_xattr->name_length) + 646 sizeof(desc_xattr->value_length) + 647 desc_xattr->name_length + desc_xattr->value_length) { 648 return -EINVAL; 649 } 650 651 xattr = calloc(1, sizeof(*xattr)); 652 if (xattr == NULL) { 653 return -ENOMEM; 654 } 655 656 xattr->name = malloc(desc_xattr->name_length + 1); 657 if (xattr->name == NULL) { 658 free(xattr); 659 return -ENOMEM; 660 } 661 662 xattr->value = malloc(desc_xattr->value_length); 663 if (xattr->value == NULL) { 664 free(xattr->name); 665 free(xattr); 666 return -ENOMEM; 667 } 668 669 memcpy(xattr->name, desc_xattr->name, desc_xattr->name_length); 670 xattr->name[desc_xattr->name_length] = '\0'; 671 xattr->value_len = desc_xattr->value_length; 672 memcpy(xattr->value, 673 (void *)((uintptr_t)desc_xattr->name + desc_xattr->name_length), 674 desc_xattr->value_length); 675 676 TAILQ_INSERT_TAIL(internal ? &blob->xattrs_internal : &blob->xattrs, xattr, link); 677 678 return 0; 679 } 680 681 682 static int 683 blob_parse_page(const struct spdk_blob_md_page *page, struct spdk_blob *blob) 684 { 685 struct spdk_blob_md_descriptor *desc; 686 size_t cur_desc = 0; 687 void *tmp; 688 689 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 690 while (cur_desc < sizeof(page->descriptors)) { 691 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 692 if (desc->length == 0) { 693 /* If padding and length are 0, this terminates the page */ 694 break; 695 } 696 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 697 struct spdk_blob_md_descriptor_flags *desc_flags; 698 699 desc_flags = (struct spdk_blob_md_descriptor_flags *)desc; 700 701 if (desc_flags->length != sizeof(*desc_flags) - sizeof(*desc)) { 702 return -EINVAL; 703 } 704 705 if ((desc_flags->invalid_flags | SPDK_BLOB_INVALID_FLAGS_MASK) != 706 SPDK_BLOB_INVALID_FLAGS_MASK) { 707 return -EINVAL; 708 } 709 710 if ((desc_flags->data_ro_flags | SPDK_BLOB_DATA_RO_FLAGS_MASK) != 711 SPDK_BLOB_DATA_RO_FLAGS_MASK) { 712 blob->data_ro = true; 713 blob->md_ro = true; 714 } 715 716 if ((desc_flags->md_ro_flags | SPDK_BLOB_MD_RO_FLAGS_MASK) != 717 SPDK_BLOB_MD_RO_FLAGS_MASK) { 718 blob->md_ro = true; 719 } 720 721 if ((desc_flags->data_ro_flags & SPDK_BLOB_READ_ONLY)) { 722 blob->data_ro = true; 723 blob->md_ro = true; 724 } 725 726 blob->invalid_flags = desc_flags->invalid_flags; 727 blob->data_ro_flags = desc_flags->data_ro_flags; 728 blob->md_ro_flags = desc_flags->md_ro_flags; 729 730 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE) { 731 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 732 unsigned int i, j; 733 unsigned int cluster_count = blob->active.num_clusters; 734 735 if (blob->extent_table_found) { 736 /* Extent Table already present in the md, 737 * both descriptors should never be at the same time. */ 738 return -EINVAL; 739 } 740 blob->extent_rle_found = true; 741 742 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)desc; 743 744 if (desc_extent_rle->length == 0 || 745 (desc_extent_rle->length % sizeof(desc_extent_rle->extents[0]) != 0)) { 746 return -EINVAL; 747 } 748 749 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 750 for (j = 0; j < desc_extent_rle->extents[i].length; j++) { 751 if (desc_extent_rle->extents[i].cluster_idx != 0) { 752 if (!spdk_bit_pool_is_allocated(blob->bs->used_clusters, 753 desc_extent_rle->extents[i].cluster_idx + j)) { 754 return -EINVAL; 755 } 756 } 757 cluster_count++; 758 } 759 } 760 761 if (cluster_count == 0) { 762 return -EINVAL; 763 } 764 tmp = realloc(blob->active.clusters, cluster_count * sizeof(*blob->active.clusters)); 765 if (tmp == NULL) { 766 return -ENOMEM; 767 } 768 blob->active.clusters = tmp; 769 blob->active.cluster_array_size = cluster_count; 770 771 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 772 for (j = 0; j < desc_extent_rle->extents[i].length; j++) { 773 if (desc_extent_rle->extents[i].cluster_idx != 0) { 774 blob->active.clusters[blob->active.num_clusters++] = bs_cluster_to_lba(blob->bs, 775 desc_extent_rle->extents[i].cluster_idx + j); 776 blob->active.num_allocated_clusters++; 777 } else if (spdk_blob_is_thin_provisioned(blob)) { 778 blob->active.clusters[blob->active.num_clusters++] = 0; 779 } else { 780 return -EINVAL; 781 } 782 } 783 } 784 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE) { 785 struct spdk_blob_md_descriptor_extent_table *desc_extent_table; 786 uint32_t num_extent_pages = blob->active.num_extent_pages; 787 uint32_t i, j; 788 size_t extent_pages_length; 789 790 desc_extent_table = (struct spdk_blob_md_descriptor_extent_table *)desc; 791 extent_pages_length = desc_extent_table->length - sizeof(desc_extent_table->num_clusters); 792 793 if (blob->extent_rle_found) { 794 /* This means that Extent RLE is present in MD, 795 * both should never be at the same time. */ 796 return -EINVAL; 797 } else if (blob->extent_table_found && 798 desc_extent_table->num_clusters != blob->remaining_clusters_in_et) { 799 /* Number of clusters in this ET does not match number 800 * from previously read EXTENT_TABLE. */ 801 return -EINVAL; 802 } 803 804 if (desc_extent_table->length == 0 || 805 (extent_pages_length % sizeof(desc_extent_table->extent_page[0]) != 0)) { 806 return -EINVAL; 807 } 808 809 blob->extent_table_found = true; 810 811 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 812 num_extent_pages += desc_extent_table->extent_page[i].num_pages; 813 } 814 815 if (num_extent_pages > 0) { 816 tmp = realloc(blob->active.extent_pages, num_extent_pages * sizeof(uint32_t)); 817 if (tmp == NULL) { 818 return -ENOMEM; 819 } 820 blob->active.extent_pages = tmp; 821 } 822 blob->active.extent_pages_array_size = num_extent_pages; 823 824 blob->remaining_clusters_in_et = desc_extent_table->num_clusters; 825 826 /* Extent table entries contain md page numbers for extent pages. 827 * Zeroes represent unallocated extent pages, those are run-length-encoded. 828 */ 829 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 830 if (desc_extent_table->extent_page[i].page_idx != 0) { 831 assert(desc_extent_table->extent_page[i].num_pages == 1); 832 blob->active.extent_pages[blob->active.num_extent_pages++] = 833 desc_extent_table->extent_page[i].page_idx; 834 } else if (spdk_blob_is_thin_provisioned(blob)) { 835 for (j = 0; j < desc_extent_table->extent_page[i].num_pages; j++) { 836 blob->active.extent_pages[blob->active.num_extent_pages++] = 0; 837 } 838 } else { 839 return -EINVAL; 840 } 841 } 842 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 843 struct spdk_blob_md_descriptor_extent_page *desc_extent; 844 unsigned int i; 845 unsigned int cluster_count = 0; 846 size_t cluster_idx_length; 847 848 if (blob->extent_rle_found) { 849 /* This means that Extent RLE is present in MD, 850 * both should never be at the same time. */ 851 return -EINVAL; 852 } 853 854 desc_extent = (struct spdk_blob_md_descriptor_extent_page *)desc; 855 cluster_idx_length = desc_extent->length - sizeof(desc_extent->start_cluster_idx); 856 857 if (desc_extent->length <= sizeof(desc_extent->start_cluster_idx) || 858 (cluster_idx_length % sizeof(desc_extent->cluster_idx[0]) != 0)) { 859 return -EINVAL; 860 } 861 862 for (i = 0; i < cluster_idx_length / sizeof(desc_extent->cluster_idx[0]); i++) { 863 if (desc_extent->cluster_idx[i] != 0) { 864 if (!spdk_bit_pool_is_allocated(blob->bs->used_clusters, desc_extent->cluster_idx[i])) { 865 return -EINVAL; 866 } 867 } 868 cluster_count++; 869 } 870 871 if (cluster_count == 0) { 872 return -EINVAL; 873 } 874 875 /* When reading extent pages sequentially starting cluster idx should match 876 * current size of a blob. 877 * If changed to batch reading, this check shall be removed. */ 878 if (desc_extent->start_cluster_idx != blob->active.num_clusters) { 879 return -EINVAL; 880 } 881 882 tmp = realloc(blob->active.clusters, 883 (cluster_count + blob->active.num_clusters) * sizeof(*blob->active.clusters)); 884 if (tmp == NULL) { 885 return -ENOMEM; 886 } 887 blob->active.clusters = tmp; 888 blob->active.cluster_array_size = (cluster_count + blob->active.num_clusters); 889 890 for (i = 0; i < cluster_idx_length / sizeof(desc_extent->cluster_idx[0]); i++) { 891 if (desc_extent->cluster_idx[i] != 0) { 892 blob->active.clusters[blob->active.num_clusters++] = bs_cluster_to_lba(blob->bs, 893 desc_extent->cluster_idx[i]); 894 blob->active.num_allocated_clusters++; 895 } else if (spdk_blob_is_thin_provisioned(blob)) { 896 blob->active.clusters[blob->active.num_clusters++] = 0; 897 } else { 898 return -EINVAL; 899 } 900 } 901 assert(desc_extent->start_cluster_idx + cluster_count == blob->active.num_clusters); 902 assert(blob->remaining_clusters_in_et >= cluster_count); 903 blob->remaining_clusters_in_et -= cluster_count; 904 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 905 int rc; 906 907 rc = blob_deserialize_xattr(blob, 908 (struct spdk_blob_md_descriptor_xattr *) desc, false); 909 if (rc != 0) { 910 return rc; 911 } 912 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 913 int rc; 914 915 rc = blob_deserialize_xattr(blob, 916 (struct spdk_blob_md_descriptor_xattr *) desc, true); 917 if (rc != 0) { 918 return rc; 919 } 920 } else { 921 /* Unrecognized descriptor type. Do not fail - just continue to the 922 * next descriptor. If this descriptor is associated with some feature 923 * defined in a newer version of blobstore, that version of blobstore 924 * should create and set an associated feature flag to specify if this 925 * blob can be loaded or not. 926 */ 927 } 928 929 /* Advance to the next descriptor */ 930 cur_desc += sizeof(*desc) + desc->length; 931 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 932 break; 933 } 934 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 935 } 936 937 return 0; 938 } 939 940 static bool bs_load_cur_extent_page_valid(struct spdk_blob_md_page *page); 941 942 static int 943 blob_parse_extent_page(struct spdk_blob_md_page *extent_page, struct spdk_blob *blob) 944 { 945 assert(blob != NULL); 946 assert(blob->state == SPDK_BLOB_STATE_LOADING); 947 948 if (bs_load_cur_extent_page_valid(extent_page) == false) { 949 return -ENOENT; 950 } 951 952 return blob_parse_page(extent_page, blob); 953 } 954 955 static int 956 blob_parse(const struct spdk_blob_md_page *pages, uint32_t page_count, 957 struct spdk_blob *blob) 958 { 959 const struct spdk_blob_md_page *page; 960 uint32_t i; 961 int rc; 962 void *tmp; 963 964 assert(page_count > 0); 965 assert(pages[0].sequence_num == 0); 966 assert(blob != NULL); 967 assert(blob->state == SPDK_BLOB_STATE_LOADING); 968 assert(blob->active.clusters == NULL); 969 970 /* The blobid provided doesn't match what's in the MD, this can 971 * happen for example if a bogus blobid is passed in through open. 972 */ 973 if (blob->id != pages[0].id) { 974 SPDK_ERRLOG("Blobid (0x%" PRIx64 ") doesn't match what's in metadata " 975 "(0x%" PRIx64 ")\n", blob->id, pages[0].id); 976 return -ENOENT; 977 } 978 979 tmp = realloc(blob->active.pages, page_count * sizeof(*blob->active.pages)); 980 if (!tmp) { 981 return -ENOMEM; 982 } 983 blob->active.pages = tmp; 984 985 blob->active.pages[0] = pages[0].id; 986 987 for (i = 1; i < page_count; i++) { 988 assert(spdk_bit_array_get(blob->bs->used_md_pages, pages[i - 1].next)); 989 blob->active.pages[i] = pages[i - 1].next; 990 } 991 blob->active.num_pages = page_count; 992 993 for (i = 0; i < page_count; i++) { 994 page = &pages[i]; 995 996 assert(page->id == blob->id); 997 assert(page->sequence_num == i); 998 999 rc = blob_parse_page(page, blob); 1000 if (rc != 0) { 1001 return rc; 1002 } 1003 } 1004 1005 return 0; 1006 } 1007 1008 static int 1009 blob_serialize_add_page(const struct spdk_blob *blob, 1010 struct spdk_blob_md_page **pages, 1011 uint32_t *page_count, 1012 struct spdk_blob_md_page **last_page) 1013 { 1014 struct spdk_blob_md_page *page, *tmp_pages; 1015 1016 assert(pages != NULL); 1017 assert(page_count != NULL); 1018 1019 *last_page = NULL; 1020 if (*page_count == 0) { 1021 assert(*pages == NULL); 1022 *pages = spdk_malloc(blob->bs->md_page_size, 0, 1023 NULL, SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 1024 if (*pages == NULL) { 1025 return -ENOMEM; 1026 } 1027 *page_count = 1; 1028 } else { 1029 assert(*pages != NULL); 1030 tmp_pages = spdk_realloc(*pages, blob->bs->md_page_size * (*page_count + 1), 0); 1031 if (tmp_pages == NULL) { 1032 return -ENOMEM; 1033 } 1034 (*page_count)++; 1035 *pages = tmp_pages; 1036 } 1037 1038 page = &(*pages)[*page_count - 1]; 1039 memset(page, 0, sizeof(*page)); 1040 page->id = blob->id; 1041 page->sequence_num = *page_count - 1; 1042 page->next = SPDK_INVALID_MD_PAGE; 1043 *last_page = page; 1044 1045 return 0; 1046 } 1047 1048 /* Transform the in-memory representation 'xattr' into an on-disk xattr descriptor. 1049 * Update required_sz on both success and failure. 1050 * 1051 */ 1052 static int 1053 blob_serialize_xattr(const struct spdk_xattr *xattr, 1054 uint8_t *buf, size_t buf_sz, 1055 size_t *required_sz, bool internal) 1056 { 1057 struct spdk_blob_md_descriptor_xattr *desc; 1058 1059 *required_sz = sizeof(struct spdk_blob_md_descriptor_xattr) + 1060 strlen(xattr->name) + 1061 xattr->value_len; 1062 1063 if (buf_sz < *required_sz) { 1064 return -1; 1065 } 1066 1067 desc = (struct spdk_blob_md_descriptor_xattr *)buf; 1068 1069 desc->type = internal ? SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL : SPDK_MD_DESCRIPTOR_TYPE_XATTR; 1070 desc->length = sizeof(desc->name_length) + 1071 sizeof(desc->value_length) + 1072 strlen(xattr->name) + 1073 xattr->value_len; 1074 desc->name_length = strlen(xattr->name); 1075 desc->value_length = xattr->value_len; 1076 1077 memcpy(desc->name, xattr->name, desc->name_length); 1078 memcpy((void *)((uintptr_t)desc->name + desc->name_length), 1079 xattr->value, 1080 desc->value_length); 1081 1082 return 0; 1083 } 1084 1085 static void 1086 blob_serialize_extent_table_entry(const struct spdk_blob *blob, 1087 uint64_t start_ep, uint64_t *next_ep, 1088 uint8_t **buf, size_t *remaining_sz) 1089 { 1090 struct spdk_blob_md_descriptor_extent_table *desc; 1091 size_t cur_sz; 1092 uint64_t i, et_idx; 1093 uint32_t extent_page, ep_len; 1094 1095 /* The buffer must have room for at least num_clusters entry */ 1096 cur_sz = sizeof(struct spdk_blob_md_descriptor) + sizeof(desc->num_clusters); 1097 if (*remaining_sz < cur_sz) { 1098 *next_ep = start_ep; 1099 return; 1100 } 1101 1102 desc = (struct spdk_blob_md_descriptor_extent_table *)*buf; 1103 desc->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE; 1104 1105 desc->num_clusters = blob->active.num_clusters; 1106 1107 ep_len = 1; 1108 et_idx = 0; 1109 for (i = start_ep; i < blob->active.num_extent_pages; i++) { 1110 if (*remaining_sz < cur_sz + sizeof(desc->extent_page[0])) { 1111 /* If we ran out of buffer space, return */ 1112 break; 1113 } 1114 1115 extent_page = blob->active.extent_pages[i]; 1116 /* Verify that next extent_page is unallocated */ 1117 if (extent_page == 0 && 1118 (i + 1 < blob->active.num_extent_pages && blob->active.extent_pages[i + 1] == 0)) { 1119 ep_len++; 1120 continue; 1121 } 1122 desc->extent_page[et_idx].page_idx = extent_page; 1123 desc->extent_page[et_idx].num_pages = ep_len; 1124 et_idx++; 1125 1126 ep_len = 1; 1127 cur_sz += sizeof(desc->extent_page[et_idx]); 1128 } 1129 *next_ep = i; 1130 1131 desc->length = sizeof(desc->num_clusters) + sizeof(desc->extent_page[0]) * et_idx; 1132 *remaining_sz -= sizeof(struct spdk_blob_md_descriptor) + desc->length; 1133 *buf += sizeof(struct spdk_blob_md_descriptor) + desc->length; 1134 } 1135 1136 static int 1137 blob_serialize_extent_table(const struct spdk_blob *blob, 1138 struct spdk_blob_md_page **pages, 1139 struct spdk_blob_md_page *cur_page, 1140 uint32_t *page_count, uint8_t **buf, 1141 size_t *remaining_sz) 1142 { 1143 uint64_t last_extent_page; 1144 int rc; 1145 1146 last_extent_page = 0; 1147 /* At least single extent table entry has to be always persisted. 1148 * Such case occurs with num_extent_pages == 0. */ 1149 while (last_extent_page <= blob->active.num_extent_pages) { 1150 blob_serialize_extent_table_entry(blob, last_extent_page, &last_extent_page, buf, 1151 remaining_sz); 1152 1153 if (last_extent_page == blob->active.num_extent_pages) { 1154 break; 1155 } 1156 1157 rc = blob_serialize_add_page(blob, pages, page_count, &cur_page); 1158 if (rc < 0) { 1159 return rc; 1160 } 1161 1162 *buf = (uint8_t *)cur_page->descriptors; 1163 *remaining_sz = sizeof(cur_page->descriptors); 1164 } 1165 1166 return 0; 1167 } 1168 1169 static void 1170 blob_serialize_extent_rle(const struct spdk_blob *blob, 1171 uint64_t start_cluster, uint64_t *next_cluster, 1172 uint8_t **buf, size_t *buf_sz) 1173 { 1174 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 1175 size_t cur_sz; 1176 uint64_t i, extent_idx; 1177 uint64_t lba, lba_per_cluster, lba_count; 1178 1179 /* The buffer must have room for at least one extent */ 1180 cur_sz = sizeof(struct spdk_blob_md_descriptor) + sizeof(desc_extent_rle->extents[0]); 1181 if (*buf_sz < cur_sz) { 1182 *next_cluster = start_cluster; 1183 return; 1184 } 1185 1186 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)*buf; 1187 desc_extent_rle->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE; 1188 1189 lba_per_cluster = bs_cluster_to_lba(blob->bs, 1); 1190 /* Assert for scan-build false positive */ 1191 assert(lba_per_cluster > 0); 1192 1193 lba = blob->active.clusters[start_cluster]; 1194 lba_count = lba_per_cluster; 1195 extent_idx = 0; 1196 for (i = start_cluster + 1; i < blob->active.num_clusters; i++) { 1197 if ((lba + lba_count) == blob->active.clusters[i] && lba != 0) { 1198 /* Run-length encode sequential non-zero LBA */ 1199 lba_count += lba_per_cluster; 1200 continue; 1201 } else if (lba == 0 && blob->active.clusters[i] == 0) { 1202 /* Run-length encode unallocated clusters */ 1203 lba_count += lba_per_cluster; 1204 continue; 1205 } 1206 desc_extent_rle->extents[extent_idx].cluster_idx = lba / lba_per_cluster; 1207 desc_extent_rle->extents[extent_idx].length = lba_count / lba_per_cluster; 1208 extent_idx++; 1209 1210 cur_sz += sizeof(desc_extent_rle->extents[extent_idx]); 1211 1212 if (*buf_sz < cur_sz) { 1213 /* If we ran out of buffer space, return */ 1214 *next_cluster = i; 1215 break; 1216 } 1217 1218 lba = blob->active.clusters[i]; 1219 lba_count = lba_per_cluster; 1220 } 1221 1222 if (*buf_sz >= cur_sz) { 1223 desc_extent_rle->extents[extent_idx].cluster_idx = lba / lba_per_cluster; 1224 desc_extent_rle->extents[extent_idx].length = lba_count / lba_per_cluster; 1225 extent_idx++; 1226 1227 *next_cluster = blob->active.num_clusters; 1228 } 1229 1230 desc_extent_rle->length = sizeof(desc_extent_rle->extents[0]) * extent_idx; 1231 *buf_sz -= sizeof(struct spdk_blob_md_descriptor) + desc_extent_rle->length; 1232 *buf += sizeof(struct spdk_blob_md_descriptor) + desc_extent_rle->length; 1233 } 1234 1235 static int 1236 blob_serialize_extents_rle(const struct spdk_blob *blob, 1237 struct spdk_blob_md_page **pages, 1238 struct spdk_blob_md_page *cur_page, 1239 uint32_t *page_count, uint8_t **buf, 1240 size_t *remaining_sz) 1241 { 1242 uint64_t last_cluster; 1243 int rc; 1244 1245 last_cluster = 0; 1246 while (last_cluster < blob->active.num_clusters) { 1247 blob_serialize_extent_rle(blob, last_cluster, &last_cluster, buf, remaining_sz); 1248 1249 if (last_cluster == blob->active.num_clusters) { 1250 break; 1251 } 1252 1253 rc = blob_serialize_add_page(blob, pages, page_count, &cur_page); 1254 if (rc < 0) { 1255 return rc; 1256 } 1257 1258 *buf = (uint8_t *)cur_page->descriptors; 1259 *remaining_sz = sizeof(cur_page->descriptors); 1260 } 1261 1262 return 0; 1263 } 1264 1265 static void 1266 blob_serialize_extent_page(const struct spdk_blob *blob, 1267 uint64_t cluster, struct spdk_blob_md_page *page) 1268 { 1269 struct spdk_blob_md_descriptor_extent_page *desc_extent; 1270 uint64_t i, extent_idx; 1271 uint64_t lba, lba_per_cluster; 1272 uint64_t start_cluster_idx = (cluster / SPDK_EXTENTS_PER_EP) * SPDK_EXTENTS_PER_EP; 1273 1274 desc_extent = (struct spdk_blob_md_descriptor_extent_page *) page->descriptors; 1275 desc_extent->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE; 1276 1277 lba_per_cluster = bs_cluster_to_lba(blob->bs, 1); 1278 1279 desc_extent->start_cluster_idx = start_cluster_idx; 1280 extent_idx = 0; 1281 for (i = start_cluster_idx; i < blob->active.num_clusters; i++) { 1282 lba = blob->active.clusters[i]; 1283 desc_extent->cluster_idx[extent_idx++] = lba / lba_per_cluster; 1284 if (extent_idx >= SPDK_EXTENTS_PER_EP) { 1285 break; 1286 } 1287 } 1288 desc_extent->length = sizeof(desc_extent->start_cluster_idx) + 1289 sizeof(desc_extent->cluster_idx[0]) * extent_idx; 1290 } 1291 1292 static void 1293 blob_serialize_flags(const struct spdk_blob *blob, 1294 uint8_t *buf, size_t *buf_sz) 1295 { 1296 struct spdk_blob_md_descriptor_flags *desc; 1297 1298 /* 1299 * Flags get serialized first, so we should always have room for the flags 1300 * descriptor. 1301 */ 1302 assert(*buf_sz >= sizeof(*desc)); 1303 1304 desc = (struct spdk_blob_md_descriptor_flags *)buf; 1305 desc->type = SPDK_MD_DESCRIPTOR_TYPE_FLAGS; 1306 desc->length = sizeof(*desc) - sizeof(struct spdk_blob_md_descriptor); 1307 desc->invalid_flags = blob->invalid_flags; 1308 desc->data_ro_flags = blob->data_ro_flags; 1309 desc->md_ro_flags = blob->md_ro_flags; 1310 1311 *buf_sz -= sizeof(*desc); 1312 } 1313 1314 static int 1315 blob_serialize_xattrs(const struct spdk_blob *blob, 1316 const struct spdk_xattr_tailq *xattrs, bool internal, 1317 struct spdk_blob_md_page **pages, 1318 struct spdk_blob_md_page *cur_page, 1319 uint32_t *page_count, uint8_t **buf, 1320 size_t *remaining_sz) 1321 { 1322 const struct spdk_xattr *xattr; 1323 int rc; 1324 1325 TAILQ_FOREACH(xattr, xattrs, link) { 1326 size_t required_sz = 0; 1327 1328 rc = blob_serialize_xattr(xattr, 1329 *buf, *remaining_sz, 1330 &required_sz, internal); 1331 if (rc < 0) { 1332 /* Need to add a new page to the chain */ 1333 rc = blob_serialize_add_page(blob, pages, page_count, 1334 &cur_page); 1335 if (rc < 0) { 1336 spdk_free(*pages); 1337 *pages = NULL; 1338 *page_count = 0; 1339 return rc; 1340 } 1341 1342 *buf = (uint8_t *)cur_page->descriptors; 1343 *remaining_sz = sizeof(cur_page->descriptors); 1344 1345 /* Try again */ 1346 required_sz = 0; 1347 rc = blob_serialize_xattr(xattr, 1348 *buf, *remaining_sz, 1349 &required_sz, internal); 1350 1351 if (rc < 0) { 1352 spdk_free(*pages); 1353 *pages = NULL; 1354 *page_count = 0; 1355 return rc; 1356 } 1357 } 1358 1359 *remaining_sz -= required_sz; 1360 *buf += required_sz; 1361 } 1362 1363 return 0; 1364 } 1365 1366 static int 1367 blob_serialize(const struct spdk_blob *blob, struct spdk_blob_md_page **pages, 1368 uint32_t *page_count) 1369 { 1370 struct spdk_blob_md_page *cur_page; 1371 int rc; 1372 uint8_t *buf; 1373 size_t remaining_sz; 1374 1375 assert(pages != NULL); 1376 assert(page_count != NULL); 1377 assert(blob != NULL); 1378 assert(blob->state == SPDK_BLOB_STATE_DIRTY); 1379 1380 *pages = NULL; 1381 *page_count = 0; 1382 1383 /* A blob always has at least 1 page, even if it has no descriptors */ 1384 rc = blob_serialize_add_page(blob, pages, page_count, &cur_page); 1385 if (rc < 0) { 1386 return rc; 1387 } 1388 1389 buf = (uint8_t *)cur_page->descriptors; 1390 remaining_sz = sizeof(cur_page->descriptors); 1391 1392 /* Serialize flags */ 1393 blob_serialize_flags(blob, buf, &remaining_sz); 1394 buf += sizeof(struct spdk_blob_md_descriptor_flags); 1395 1396 /* Serialize xattrs */ 1397 rc = blob_serialize_xattrs(blob, &blob->xattrs, false, 1398 pages, cur_page, page_count, &buf, &remaining_sz); 1399 if (rc < 0) { 1400 return rc; 1401 } 1402 1403 /* Serialize internal xattrs */ 1404 rc = blob_serialize_xattrs(blob, &blob->xattrs_internal, true, 1405 pages, cur_page, page_count, &buf, &remaining_sz); 1406 if (rc < 0) { 1407 return rc; 1408 } 1409 1410 if (blob->use_extent_table) { 1411 /* Serialize extent table */ 1412 rc = blob_serialize_extent_table(blob, pages, cur_page, page_count, &buf, &remaining_sz); 1413 } else { 1414 /* Serialize extents */ 1415 rc = blob_serialize_extents_rle(blob, pages, cur_page, page_count, &buf, &remaining_sz); 1416 } 1417 1418 return rc; 1419 } 1420 1421 struct spdk_blob_load_ctx { 1422 struct spdk_blob *blob; 1423 1424 struct spdk_blob_md_page *pages; 1425 uint32_t num_pages; 1426 uint32_t next_extent_page; 1427 spdk_bs_sequence_t *seq; 1428 1429 spdk_bs_sequence_cpl cb_fn; 1430 void *cb_arg; 1431 }; 1432 1433 static uint32_t 1434 blob_md_page_calc_crc(void *page) 1435 { 1436 uint32_t crc; 1437 1438 crc = BLOB_CRC32C_INITIAL; 1439 crc = spdk_crc32c_update(page, SPDK_BS_PAGE_SIZE - 4, crc); 1440 crc ^= BLOB_CRC32C_INITIAL; 1441 1442 return crc; 1443 1444 } 1445 1446 static void 1447 blob_load_final(struct spdk_blob_load_ctx *ctx, int bserrno) 1448 { 1449 struct spdk_blob *blob = ctx->blob; 1450 1451 if (bserrno == 0) { 1452 blob_mark_clean(blob); 1453 } 1454 1455 ctx->cb_fn(ctx->seq, ctx->cb_arg, bserrno); 1456 1457 /* Free the memory */ 1458 spdk_free(ctx->pages); 1459 free(ctx); 1460 } 1461 1462 static void 1463 blob_load_snapshot_cpl(void *cb_arg, struct spdk_blob *snapshot, int bserrno) 1464 { 1465 struct spdk_blob_load_ctx *ctx = cb_arg; 1466 struct spdk_blob *blob = ctx->blob; 1467 1468 if (bserrno == 0) { 1469 blob->back_bs_dev = bs_create_blob_bs_dev(snapshot); 1470 if (blob->back_bs_dev == NULL) { 1471 bserrno = -ENOMEM; 1472 } 1473 } 1474 if (bserrno != 0) { 1475 SPDK_ERRLOG("Snapshot fail\n"); 1476 } 1477 1478 blob_load_final(ctx, bserrno); 1479 } 1480 1481 static void blob_update_clear_method(struct spdk_blob *blob); 1482 1483 static int 1484 blob_load_esnap(struct spdk_blob *blob, void *blob_ctx) 1485 { 1486 struct spdk_blob_store *bs = blob->bs; 1487 struct spdk_bs_dev *bs_dev = NULL; 1488 const void *esnap_id = NULL; 1489 size_t id_len = 0; 1490 int rc; 1491 1492 if (bs->esnap_bs_dev_create == NULL) { 1493 SPDK_NOTICELOG("blob 0x%" PRIx64 " is an esnap clone but the blobstore was opened " 1494 "without support for esnap clones\n", blob->id); 1495 return -ENOTSUP; 1496 } 1497 assert(blob->back_bs_dev == NULL); 1498 1499 rc = blob_get_xattr_value(blob, BLOB_EXTERNAL_SNAPSHOT_ID, &esnap_id, &id_len, true); 1500 if (rc != 0) { 1501 SPDK_ERRLOG("blob 0x%" PRIx64 " is an esnap clone but has no esnap ID\n", blob->id); 1502 return -EINVAL; 1503 } 1504 assert(id_len > 0 && id_len < UINT32_MAX); 1505 1506 SPDK_INFOLOG(blob, "Creating external snapshot device\n"); 1507 1508 rc = bs->esnap_bs_dev_create(bs->esnap_ctx, blob_ctx, blob, esnap_id, (uint32_t)id_len, 1509 &bs_dev); 1510 if (rc != 0) { 1511 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": failed to load back_bs_dev " 1512 "with error %d\n", blob->id, rc); 1513 return rc; 1514 } 1515 1516 /* 1517 * Note: bs_dev might be NULL if the consumer chose to not open the external snapshot. 1518 * This especially might happen during spdk_bs_load() iteration. 1519 */ 1520 if (bs_dev != NULL) { 1521 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": loaded back_bs_dev\n", blob->id); 1522 if ((bs->io_unit_size % bs_dev->blocklen) != 0) { 1523 SPDK_NOTICELOG("blob 0x%" PRIx64 " external snapshot device block size %u " 1524 "is not compatible with blobstore block size %u\n", 1525 blob->id, bs_dev->blocklen, bs->io_unit_size); 1526 bs_dev->destroy(bs_dev); 1527 return -EINVAL; 1528 } 1529 } 1530 1531 blob->back_bs_dev = bs_dev; 1532 blob->parent_id = SPDK_BLOBID_EXTERNAL_SNAPSHOT; 1533 1534 return 0; 1535 } 1536 1537 static void 1538 blob_load_backing_dev(spdk_bs_sequence_t *seq, void *cb_arg) 1539 { 1540 struct spdk_blob_load_ctx *ctx = cb_arg; 1541 struct spdk_blob *blob = ctx->blob; 1542 const void *value; 1543 size_t len; 1544 int rc; 1545 1546 if (blob_is_esnap_clone(blob)) { 1547 rc = blob_load_esnap(blob, seq->cpl.u.blob_handle.esnap_ctx); 1548 blob_load_final(ctx, rc); 1549 return; 1550 } 1551 1552 if (spdk_blob_is_thin_provisioned(blob)) { 1553 rc = blob_get_xattr_value(blob, BLOB_SNAPSHOT, &value, &len, true); 1554 if (rc == 0) { 1555 if (len != sizeof(spdk_blob_id)) { 1556 blob_load_final(ctx, -EINVAL); 1557 return; 1558 } 1559 /* open snapshot blob and continue in the callback function */ 1560 blob->parent_id = *(spdk_blob_id *)value; 1561 spdk_bs_open_blob(blob->bs, blob->parent_id, 1562 blob_load_snapshot_cpl, ctx); 1563 return; 1564 } else { 1565 /* add zeroes_dev for thin provisioned blob */ 1566 blob->back_bs_dev = bs_create_zeroes_dev(); 1567 } 1568 } else { 1569 /* standard blob */ 1570 blob->back_bs_dev = NULL; 1571 } 1572 blob_load_final(ctx, 0); 1573 } 1574 1575 static void 1576 blob_load_cpl_extents_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1577 { 1578 struct spdk_blob_load_ctx *ctx = cb_arg; 1579 struct spdk_blob *blob = ctx->blob; 1580 struct spdk_blob_md_page *page; 1581 uint64_t i; 1582 uint32_t crc; 1583 uint64_t lba; 1584 void *tmp; 1585 uint64_t sz; 1586 1587 if (bserrno) { 1588 SPDK_ERRLOG("Extent page read failed: %d\n", bserrno); 1589 blob_load_final(ctx, bserrno); 1590 return; 1591 } 1592 1593 if (ctx->pages == NULL) { 1594 /* First iteration of this function, allocate buffer for single EXTENT_PAGE */ 1595 ctx->pages = spdk_zmalloc(blob->bs->md_page_size, 0, 1596 NULL, SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 1597 if (!ctx->pages) { 1598 blob_load_final(ctx, -ENOMEM); 1599 return; 1600 } 1601 ctx->num_pages = 1; 1602 ctx->next_extent_page = 0; 1603 } else { 1604 page = &ctx->pages[0]; 1605 crc = blob_md_page_calc_crc(page); 1606 if (crc != page->crc) { 1607 blob_load_final(ctx, -EINVAL); 1608 return; 1609 } 1610 1611 if (page->next != SPDK_INVALID_MD_PAGE) { 1612 blob_load_final(ctx, -EINVAL); 1613 return; 1614 } 1615 1616 bserrno = blob_parse_extent_page(page, blob); 1617 if (bserrno) { 1618 blob_load_final(ctx, bserrno); 1619 return; 1620 } 1621 } 1622 1623 for (i = ctx->next_extent_page; i < blob->active.num_extent_pages; i++) { 1624 if (blob->active.extent_pages[i] != 0) { 1625 /* Extent page was allocated, read and parse it. */ 1626 lba = bs_md_page_to_lba(blob->bs, blob->active.extent_pages[i]); 1627 ctx->next_extent_page = i + 1; 1628 1629 bs_sequence_read_dev(seq, &ctx->pages[0], lba, 1630 bs_byte_to_lba(blob->bs, blob->bs->md_page_size), 1631 blob_load_cpl_extents_cpl, ctx); 1632 return; 1633 } else { 1634 /* Thin provisioned blobs can point to unallocated extent pages. 1635 * In this case blob size should be increased by up to the amount left in remaining_clusters_in_et. */ 1636 1637 sz = spdk_min(blob->remaining_clusters_in_et, SPDK_EXTENTS_PER_EP); 1638 blob->active.num_clusters += sz; 1639 blob->remaining_clusters_in_et -= sz; 1640 1641 assert(spdk_blob_is_thin_provisioned(blob)); 1642 assert(i + 1 < blob->active.num_extent_pages || blob->remaining_clusters_in_et == 0); 1643 1644 tmp = realloc(blob->active.clusters, blob->active.num_clusters * sizeof(*blob->active.clusters)); 1645 if (tmp == NULL) { 1646 blob_load_final(ctx, -ENOMEM); 1647 return; 1648 } 1649 memset(tmp + sizeof(*blob->active.clusters) * blob->active.cluster_array_size, 0, 1650 sizeof(*blob->active.clusters) * (blob->active.num_clusters - blob->active.cluster_array_size)); 1651 blob->active.clusters = tmp; 1652 blob->active.cluster_array_size = blob->active.num_clusters; 1653 } 1654 } 1655 1656 blob_load_backing_dev(seq, ctx); 1657 } 1658 1659 static void 1660 blob_load_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1661 { 1662 struct spdk_blob_load_ctx *ctx = cb_arg; 1663 struct spdk_blob *blob = ctx->blob; 1664 struct spdk_blob_md_page *page; 1665 int rc; 1666 uint32_t crc; 1667 uint32_t current_page; 1668 1669 if (ctx->num_pages == 1) { 1670 current_page = bs_blobid_to_page(blob->id); 1671 } else { 1672 assert(ctx->num_pages != 0); 1673 page = &ctx->pages[ctx->num_pages - 2]; 1674 current_page = page->next; 1675 } 1676 1677 if (bserrno) { 1678 SPDK_ERRLOG("Metadata page %d read failed for blobid 0x%" PRIx64 ": %d\n", 1679 current_page, blob->id, bserrno); 1680 blob_load_final(ctx, bserrno); 1681 return; 1682 } 1683 1684 page = &ctx->pages[ctx->num_pages - 1]; 1685 crc = blob_md_page_calc_crc(page); 1686 if (crc != page->crc) { 1687 SPDK_ERRLOG("Metadata page %d crc mismatch for blobid 0x%" PRIx64 "\n", 1688 current_page, blob->id); 1689 blob_load_final(ctx, -EINVAL); 1690 return; 1691 } 1692 1693 if (page->next != SPDK_INVALID_MD_PAGE) { 1694 struct spdk_blob_md_page *tmp_pages; 1695 uint32_t next_page = page->next; 1696 uint64_t next_lba = bs_md_page_to_lba(blob->bs, next_page); 1697 1698 /* Read the next page */ 1699 tmp_pages = spdk_realloc(ctx->pages, (sizeof(*page) * (ctx->num_pages + 1)), 0); 1700 if (tmp_pages == NULL) { 1701 blob_load_final(ctx, -ENOMEM); 1702 return; 1703 } 1704 ctx->num_pages++; 1705 ctx->pages = tmp_pages; 1706 1707 bs_sequence_read_dev(seq, &ctx->pages[ctx->num_pages - 1], 1708 next_lba, 1709 bs_byte_to_lba(blob->bs, sizeof(*page)), 1710 blob_load_cpl, ctx); 1711 return; 1712 } 1713 1714 /* Parse the pages */ 1715 rc = blob_parse(ctx->pages, ctx->num_pages, blob); 1716 if (rc) { 1717 blob_load_final(ctx, rc); 1718 return; 1719 } 1720 1721 if (blob->extent_table_found == true) { 1722 /* If EXTENT_TABLE was found, that means support for it should be enabled. */ 1723 assert(blob->extent_rle_found == false); 1724 blob->use_extent_table = true; 1725 } else { 1726 /* If EXTENT_RLE or no extent_* descriptor was found disable support 1727 * for extent table. No extent_* descriptors means that blob has length of 0 1728 * and no extent_rle descriptors were persisted for it. 1729 * EXTENT_TABLE if used, is always present in metadata regardless of length. */ 1730 blob->use_extent_table = false; 1731 } 1732 1733 /* Check the clear_method stored in metadata vs what may have been passed 1734 * via spdk_bs_open_blob_ext() and update accordingly. 1735 */ 1736 blob_update_clear_method(blob); 1737 1738 spdk_free(ctx->pages); 1739 ctx->pages = NULL; 1740 1741 if (blob->extent_table_found) { 1742 blob_load_cpl_extents_cpl(seq, ctx, 0); 1743 } else { 1744 blob_load_backing_dev(seq, ctx); 1745 } 1746 } 1747 1748 /* Load a blob from disk given a blobid */ 1749 static void 1750 blob_load(spdk_bs_sequence_t *seq, struct spdk_blob *blob, 1751 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 1752 { 1753 struct spdk_blob_load_ctx *ctx; 1754 struct spdk_blob_store *bs; 1755 uint32_t page_num; 1756 uint64_t lba; 1757 1758 blob_verify_md_op(blob); 1759 1760 bs = blob->bs; 1761 1762 ctx = calloc(1, sizeof(*ctx)); 1763 if (!ctx) { 1764 cb_fn(seq, cb_arg, -ENOMEM); 1765 return; 1766 } 1767 1768 ctx->blob = blob; 1769 ctx->pages = spdk_realloc(ctx->pages, bs->md_page_size, 0); 1770 if (!ctx->pages) { 1771 free(ctx); 1772 cb_fn(seq, cb_arg, -ENOMEM); 1773 return; 1774 } 1775 ctx->num_pages = 1; 1776 ctx->cb_fn = cb_fn; 1777 ctx->cb_arg = cb_arg; 1778 ctx->seq = seq; 1779 1780 page_num = bs_blobid_to_page(blob->id); 1781 lba = bs_md_page_to_lba(blob->bs, page_num); 1782 1783 blob->state = SPDK_BLOB_STATE_LOADING; 1784 1785 bs_sequence_read_dev(seq, &ctx->pages[0], lba, 1786 bs_byte_to_lba(bs, bs->md_page_size), 1787 blob_load_cpl, ctx); 1788 } 1789 1790 struct spdk_blob_persist_ctx { 1791 struct spdk_blob *blob; 1792 1793 struct spdk_blob_md_page *pages; 1794 uint32_t next_extent_page; 1795 struct spdk_blob_md_page *extent_page; 1796 1797 spdk_bs_sequence_t *seq; 1798 spdk_bs_sequence_cpl cb_fn; 1799 void *cb_arg; 1800 TAILQ_ENTRY(spdk_blob_persist_ctx) link; 1801 }; 1802 1803 static void 1804 bs_batch_clear_dev(struct spdk_blob *blob, spdk_bs_batch_t *batch, uint64_t lba, 1805 uint64_t lba_count) 1806 { 1807 switch (blob->clear_method) { 1808 case BLOB_CLEAR_WITH_DEFAULT: 1809 case BLOB_CLEAR_WITH_UNMAP: 1810 bs_batch_unmap_dev(batch, lba, lba_count); 1811 break; 1812 case BLOB_CLEAR_WITH_WRITE_ZEROES: 1813 bs_batch_write_zeroes_dev(batch, lba, lba_count); 1814 break; 1815 case BLOB_CLEAR_WITH_NONE: 1816 default: 1817 break; 1818 } 1819 } 1820 1821 static int 1822 bs_super_validate(struct spdk_bs_super_block *super, struct spdk_blob_store *bs) 1823 { 1824 uint32_t crc; 1825 static const char zeros[SPDK_BLOBSTORE_TYPE_LENGTH]; 1826 1827 if (super->version > SPDK_BS_VERSION || 1828 super->version < SPDK_BS_INITIAL_VERSION) { 1829 return -EILSEQ; 1830 } 1831 1832 if (memcmp(super->signature, SPDK_BS_SUPER_BLOCK_SIG, 1833 sizeof(super->signature)) != 0) { 1834 return -EILSEQ; 1835 } 1836 1837 crc = blob_md_page_calc_crc(super); 1838 if (crc != super->crc) { 1839 return -EILSEQ; 1840 } 1841 1842 if (memcmp(&bs->bstype, &super->bstype, SPDK_BLOBSTORE_TYPE_LENGTH) == 0) { 1843 SPDK_DEBUGLOG(blob, "Bstype matched - loading blobstore\n"); 1844 } else if (memcmp(&bs->bstype, zeros, SPDK_BLOBSTORE_TYPE_LENGTH) == 0) { 1845 SPDK_DEBUGLOG(blob, "Bstype wildcard used - loading blobstore regardless bstype\n"); 1846 } else { 1847 SPDK_DEBUGLOG(blob, "Unexpected bstype\n"); 1848 SPDK_LOGDUMP(blob, "Expected:", bs->bstype.bstype, SPDK_BLOBSTORE_TYPE_LENGTH); 1849 SPDK_LOGDUMP(blob, "Found:", super->bstype.bstype, SPDK_BLOBSTORE_TYPE_LENGTH); 1850 return -ENXIO; 1851 } 1852 1853 if (super->size > bs->dev->blockcnt * bs->dev->blocklen) { 1854 SPDK_NOTICELOG("Size mismatch, dev size: %" PRIu64 ", blobstore size: %" PRIu64 "\n", 1855 bs->dev->blockcnt * bs->dev->blocklen, super->size); 1856 return -EILSEQ; 1857 } 1858 1859 return 0; 1860 } 1861 1862 static void bs_mark_dirty(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 1863 spdk_bs_sequence_cpl cb_fn, void *cb_arg); 1864 1865 static void 1866 blob_persist_complete_cb(void *arg) 1867 { 1868 struct spdk_blob_persist_ctx *ctx = arg; 1869 1870 /* Call user callback */ 1871 ctx->cb_fn(ctx->seq, ctx->cb_arg, 0); 1872 1873 /* Free the memory */ 1874 spdk_free(ctx->pages); 1875 free(ctx); 1876 } 1877 1878 static void blob_persist_start(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno); 1879 1880 static void 1881 blob_persist_complete(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx, int bserrno) 1882 { 1883 struct spdk_blob_persist_ctx *next_persist, *tmp; 1884 struct spdk_blob *blob = ctx->blob; 1885 1886 if (bserrno == 0) { 1887 blob_mark_clean(blob); 1888 } 1889 1890 assert(ctx == TAILQ_FIRST(&blob->persists_to_complete)); 1891 1892 /* Complete all persists that were pending when the current persist started */ 1893 TAILQ_FOREACH_SAFE(next_persist, &blob->persists_to_complete, link, tmp) { 1894 TAILQ_REMOVE(&blob->persists_to_complete, next_persist, link); 1895 spdk_thread_send_msg(spdk_get_thread(), blob_persist_complete_cb, next_persist); 1896 } 1897 1898 if (TAILQ_EMPTY(&blob->pending_persists)) { 1899 return; 1900 } 1901 1902 /* Queue up all pending persists for completion and start blob persist with first one */ 1903 TAILQ_SWAP(&blob->persists_to_complete, &blob->pending_persists, spdk_blob_persist_ctx, link); 1904 next_persist = TAILQ_FIRST(&blob->persists_to_complete); 1905 1906 blob->state = SPDK_BLOB_STATE_DIRTY; 1907 bs_mark_dirty(seq, blob->bs, blob_persist_start, next_persist); 1908 } 1909 1910 static void 1911 blob_persist_clear_extents_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1912 { 1913 struct spdk_blob_persist_ctx *ctx = cb_arg; 1914 struct spdk_blob *blob = ctx->blob; 1915 struct spdk_blob_store *bs = blob->bs; 1916 size_t i; 1917 1918 if (bserrno != 0) { 1919 blob_persist_complete(seq, ctx, bserrno); 1920 return; 1921 } 1922 1923 spdk_spin_lock(&bs->used_lock); 1924 1925 /* Release all extent_pages that were truncated */ 1926 for (i = blob->active.num_extent_pages; i < blob->active.extent_pages_array_size; i++) { 1927 /* Nothing to release if it was not allocated */ 1928 if (blob->active.extent_pages[i] != 0) { 1929 bs_release_md_page(bs, blob->active.extent_pages[i]); 1930 } 1931 } 1932 1933 spdk_spin_unlock(&bs->used_lock); 1934 1935 if (blob->active.num_extent_pages == 0) { 1936 free(blob->active.extent_pages); 1937 blob->active.extent_pages = NULL; 1938 blob->active.extent_pages_array_size = 0; 1939 } else if (blob->active.num_extent_pages != blob->active.extent_pages_array_size) { 1940 #ifndef __clang_analyzer__ 1941 void *tmp; 1942 1943 /* scan-build really can't figure reallocs, workaround it */ 1944 tmp = realloc(blob->active.extent_pages, sizeof(uint32_t) * blob->active.num_extent_pages); 1945 assert(tmp != NULL); 1946 blob->active.extent_pages = tmp; 1947 #endif 1948 blob->active.extent_pages_array_size = blob->active.num_extent_pages; 1949 } 1950 1951 blob_persist_complete(seq, ctx, bserrno); 1952 } 1953 1954 static void 1955 blob_persist_clear_extents(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx) 1956 { 1957 struct spdk_blob *blob = ctx->blob; 1958 struct spdk_blob_store *bs = blob->bs; 1959 size_t i; 1960 uint64_t lba; 1961 uint64_t lba_count; 1962 spdk_bs_batch_t *batch; 1963 1964 batch = bs_sequence_to_batch(seq, blob_persist_clear_extents_cpl, ctx); 1965 lba_count = bs_byte_to_lba(bs, bs->md_page_size); 1966 1967 /* Clear all extent_pages that were truncated */ 1968 for (i = blob->active.num_extent_pages; i < blob->active.extent_pages_array_size; i++) { 1969 /* Nothing to clear if it was not allocated */ 1970 if (blob->active.extent_pages[i] != 0) { 1971 lba = bs_md_page_to_lba(bs, blob->active.extent_pages[i]); 1972 bs_batch_write_zeroes_dev(batch, lba, lba_count); 1973 } 1974 } 1975 1976 bs_batch_close(batch); 1977 } 1978 1979 static void 1980 blob_persist_clear_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1981 { 1982 struct spdk_blob_persist_ctx *ctx = cb_arg; 1983 struct spdk_blob *blob = ctx->blob; 1984 struct spdk_blob_store *bs = blob->bs; 1985 size_t i; 1986 1987 if (bserrno != 0) { 1988 blob_persist_complete(seq, ctx, bserrno); 1989 return; 1990 } 1991 1992 spdk_spin_lock(&bs->used_lock); 1993 /* Release all clusters that were truncated */ 1994 for (i = blob->active.num_clusters; i < blob->active.cluster_array_size; i++) { 1995 uint32_t cluster_num = bs_lba_to_cluster(bs, blob->active.clusters[i]); 1996 1997 /* Nothing to release if it was not allocated */ 1998 if (blob->active.clusters[i] != 0) { 1999 bs_release_cluster(bs, cluster_num); 2000 } 2001 } 2002 spdk_spin_unlock(&bs->used_lock); 2003 2004 if (blob->active.num_clusters == 0) { 2005 free(blob->active.clusters); 2006 blob->active.clusters = NULL; 2007 blob->active.cluster_array_size = 0; 2008 } else if (blob->active.num_clusters != blob->active.cluster_array_size) { 2009 #ifndef __clang_analyzer__ 2010 void *tmp; 2011 2012 /* scan-build really can't figure reallocs, workaround it */ 2013 tmp = realloc(blob->active.clusters, sizeof(*blob->active.clusters) * blob->active.num_clusters); 2014 assert(tmp != NULL); 2015 blob->active.clusters = tmp; 2016 2017 #endif 2018 blob->active.cluster_array_size = blob->active.num_clusters; 2019 } 2020 2021 /* Move on to clearing extent pages */ 2022 blob_persist_clear_extents(seq, ctx); 2023 } 2024 2025 static void 2026 blob_persist_clear_clusters(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx) 2027 { 2028 struct spdk_blob *blob = ctx->blob; 2029 struct spdk_blob_store *bs = blob->bs; 2030 spdk_bs_batch_t *batch; 2031 size_t i; 2032 uint64_t lba; 2033 uint64_t lba_count; 2034 2035 /* Clusters don't move around in blobs. The list shrinks or grows 2036 * at the end, but no changes ever occur in the middle of the list. 2037 */ 2038 2039 batch = bs_sequence_to_batch(seq, blob_persist_clear_clusters_cpl, ctx); 2040 2041 /* Clear all clusters that were truncated */ 2042 lba = 0; 2043 lba_count = 0; 2044 for (i = blob->active.num_clusters; i < blob->active.cluster_array_size; i++) { 2045 uint64_t next_lba = blob->active.clusters[i]; 2046 uint64_t next_lba_count = bs_cluster_to_lba(bs, 1); 2047 2048 if (next_lba > 0 && (lba + lba_count) == next_lba) { 2049 /* This cluster is contiguous with the previous one. */ 2050 lba_count += next_lba_count; 2051 continue; 2052 } else if (next_lba == 0) { 2053 continue; 2054 } 2055 2056 /* This cluster is not contiguous with the previous one. */ 2057 2058 /* If a run of LBAs previously existing, clear them now */ 2059 if (lba_count > 0) { 2060 bs_batch_clear_dev(ctx->blob, batch, lba, lba_count); 2061 } 2062 2063 /* Start building the next batch */ 2064 lba = next_lba; 2065 if (next_lba > 0) { 2066 lba_count = next_lba_count; 2067 } else { 2068 lba_count = 0; 2069 } 2070 } 2071 2072 /* If we ended with a contiguous set of LBAs, clear them now */ 2073 if (lba_count > 0) { 2074 bs_batch_clear_dev(ctx->blob, batch, lba, lba_count); 2075 } 2076 2077 bs_batch_close(batch); 2078 } 2079 2080 static void 2081 blob_persist_zero_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2082 { 2083 struct spdk_blob_persist_ctx *ctx = cb_arg; 2084 struct spdk_blob *blob = ctx->blob; 2085 struct spdk_blob_store *bs = blob->bs; 2086 size_t i; 2087 2088 if (bserrno != 0) { 2089 blob_persist_complete(seq, ctx, bserrno); 2090 return; 2091 } 2092 2093 spdk_spin_lock(&bs->used_lock); 2094 2095 /* This loop starts at 1 because the first page is special and handled 2096 * below. The pages (except the first) are never written in place, 2097 * so any pages in the clean list must be zeroed. 2098 */ 2099 for (i = 1; i < blob->clean.num_pages; i++) { 2100 bs_release_md_page(bs, blob->clean.pages[i]); 2101 } 2102 2103 if (blob->active.num_pages == 0) { 2104 uint32_t page_num; 2105 2106 page_num = bs_blobid_to_page(blob->id); 2107 bs_release_md_page(bs, page_num); 2108 } 2109 2110 spdk_spin_unlock(&bs->used_lock); 2111 2112 /* Move on to clearing clusters */ 2113 blob_persist_clear_clusters(seq, ctx); 2114 } 2115 2116 static void 2117 blob_persist_zero_pages(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2118 { 2119 struct spdk_blob_persist_ctx *ctx = cb_arg; 2120 struct spdk_blob *blob = ctx->blob; 2121 struct spdk_blob_store *bs = blob->bs; 2122 uint64_t lba; 2123 uint64_t lba_count; 2124 spdk_bs_batch_t *batch; 2125 size_t i; 2126 2127 if (bserrno != 0) { 2128 blob_persist_complete(seq, ctx, bserrno); 2129 return; 2130 } 2131 2132 batch = bs_sequence_to_batch(seq, blob_persist_zero_pages_cpl, ctx); 2133 2134 lba_count = bs_byte_to_lba(bs, bs->md_page_size); 2135 2136 /* This loop starts at 1 because the first page is special and handled 2137 * below. The pages (except the first) are never written in place, 2138 * so any pages in the clean list must be zeroed. 2139 */ 2140 for (i = 1; i < blob->clean.num_pages; i++) { 2141 lba = bs_md_page_to_lba(bs, blob->clean.pages[i]); 2142 2143 bs_batch_write_zeroes_dev(batch, lba, lba_count); 2144 } 2145 2146 /* The first page will only be zeroed if this is a delete. */ 2147 if (blob->active.num_pages == 0) { 2148 uint32_t page_num; 2149 2150 /* The first page in the metadata goes where the blobid indicates */ 2151 page_num = bs_blobid_to_page(blob->id); 2152 lba = bs_md_page_to_lba(bs, page_num); 2153 2154 bs_batch_write_zeroes_dev(batch, lba, lba_count); 2155 } 2156 2157 bs_batch_close(batch); 2158 } 2159 2160 static void 2161 blob_persist_write_page_root(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2162 { 2163 struct spdk_blob_persist_ctx *ctx = cb_arg; 2164 struct spdk_blob *blob = ctx->blob; 2165 struct spdk_blob_store *bs = blob->bs; 2166 uint64_t lba; 2167 uint32_t lba_count; 2168 struct spdk_blob_md_page *page; 2169 2170 if (bserrno != 0) { 2171 blob_persist_complete(seq, ctx, bserrno); 2172 return; 2173 } 2174 2175 if (blob->active.num_pages == 0) { 2176 /* Move on to the next step */ 2177 blob_persist_zero_pages(seq, ctx, 0); 2178 return; 2179 } 2180 2181 lba_count = bs_byte_to_lba(bs, bs->md_page_size); 2182 2183 page = &ctx->pages[0]; 2184 /* The first page in the metadata goes where the blobid indicates */ 2185 lba = bs_md_page_to_lba(bs, bs_blobid_to_page(blob->id)); 2186 2187 bs_sequence_write_dev(seq, page, lba, lba_count, 2188 blob_persist_zero_pages, ctx); 2189 } 2190 2191 static void 2192 blob_persist_write_page_chain(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx) 2193 { 2194 struct spdk_blob *blob = ctx->blob; 2195 struct spdk_blob_store *bs = blob->bs; 2196 uint64_t lba; 2197 uint32_t lba_count; 2198 struct spdk_blob_md_page *page; 2199 spdk_bs_batch_t *batch; 2200 size_t i; 2201 2202 /* Clusters don't move around in blobs. The list shrinks or grows 2203 * at the end, but no changes ever occur in the middle of the list. 2204 */ 2205 2206 lba_count = bs_byte_to_lba(bs, sizeof(*page)); 2207 2208 batch = bs_sequence_to_batch(seq, blob_persist_write_page_root, ctx); 2209 2210 /* This starts at 1. The root page is not written until 2211 * all of the others are finished 2212 */ 2213 for (i = 1; i < blob->active.num_pages; i++) { 2214 page = &ctx->pages[i]; 2215 assert(page->sequence_num == i); 2216 2217 lba = bs_md_page_to_lba(bs, blob->active.pages[i]); 2218 2219 bs_batch_write_dev(batch, page, lba, lba_count); 2220 } 2221 2222 bs_batch_close(batch); 2223 } 2224 2225 static int 2226 blob_resize(struct spdk_blob *blob, uint64_t sz) 2227 { 2228 uint64_t i; 2229 uint64_t *tmp; 2230 uint64_t cluster; 2231 uint32_t lfmd; /* lowest free md page */ 2232 uint64_t num_clusters; 2233 uint32_t *ep_tmp; 2234 uint64_t new_num_ep = 0, current_num_ep = 0; 2235 struct spdk_blob_store *bs; 2236 int rc; 2237 2238 bs = blob->bs; 2239 2240 blob_verify_md_op(blob); 2241 2242 if (blob->active.num_clusters == sz) { 2243 return 0; 2244 } 2245 2246 if (blob->active.num_clusters < blob->active.cluster_array_size) { 2247 /* If this blob was resized to be larger, then smaller, then 2248 * larger without syncing, then the cluster array already 2249 * contains spare assigned clusters we can use. 2250 */ 2251 num_clusters = spdk_min(blob->active.cluster_array_size, 2252 sz); 2253 } else { 2254 num_clusters = blob->active.num_clusters; 2255 } 2256 2257 if (blob->use_extent_table) { 2258 /* Round up since every cluster beyond current Extent Table size, 2259 * requires new extent page. */ 2260 new_num_ep = spdk_divide_round_up(sz, SPDK_EXTENTS_PER_EP); 2261 current_num_ep = spdk_divide_round_up(num_clusters, SPDK_EXTENTS_PER_EP); 2262 } 2263 2264 assert(!spdk_spin_held(&bs->used_lock)); 2265 2266 /* Check first that we have enough clusters and md pages before we start claiming them. 2267 * bs->used_lock is held to ensure that clusters we think are free are still free when we go 2268 * to claim them later in this function. 2269 */ 2270 if (sz > num_clusters && spdk_blob_is_thin_provisioned(blob) == false) { 2271 spdk_spin_lock(&bs->used_lock); 2272 if ((sz - num_clusters) > bs->num_free_clusters) { 2273 rc = -ENOSPC; 2274 goto out; 2275 } 2276 lfmd = 0; 2277 for (i = current_num_ep; i < new_num_ep ; i++) { 2278 lfmd = spdk_bit_array_find_first_clear(blob->bs->used_md_pages, lfmd); 2279 if (lfmd == UINT32_MAX) { 2280 /* No more free md pages. Cannot satisfy the request */ 2281 rc = -ENOSPC; 2282 goto out; 2283 } 2284 } 2285 } 2286 2287 if (sz > num_clusters) { 2288 /* Expand the cluster array if necessary. 2289 * We only shrink the array when persisting. 2290 */ 2291 tmp = realloc(blob->active.clusters, sizeof(*blob->active.clusters) * sz); 2292 if (sz > 0 && tmp == NULL) { 2293 rc = -ENOMEM; 2294 goto out; 2295 } 2296 memset(tmp + blob->active.cluster_array_size, 0, 2297 sizeof(*blob->active.clusters) * (sz - blob->active.cluster_array_size)); 2298 blob->active.clusters = tmp; 2299 blob->active.cluster_array_size = sz; 2300 2301 /* Expand the extents table, only if enough clusters were added */ 2302 if (new_num_ep > current_num_ep && blob->use_extent_table) { 2303 ep_tmp = realloc(blob->active.extent_pages, sizeof(*blob->active.extent_pages) * new_num_ep); 2304 if (new_num_ep > 0 && ep_tmp == NULL) { 2305 rc = -ENOMEM; 2306 goto out; 2307 } 2308 memset(ep_tmp + blob->active.extent_pages_array_size, 0, 2309 sizeof(*blob->active.extent_pages) * (new_num_ep - blob->active.extent_pages_array_size)); 2310 blob->active.extent_pages = ep_tmp; 2311 blob->active.extent_pages_array_size = new_num_ep; 2312 } 2313 } 2314 2315 blob->state = SPDK_BLOB_STATE_DIRTY; 2316 2317 if (spdk_blob_is_thin_provisioned(blob) == false) { 2318 cluster = 0; 2319 lfmd = 0; 2320 for (i = num_clusters; i < sz; i++) { 2321 bs_allocate_cluster(blob, i, &cluster, &lfmd, true); 2322 /* Do not increment lfmd here. lfmd will get updated 2323 * to the md_page allocated (if any) when a new extent 2324 * page is needed. Just pass that value again, 2325 * bs_allocate_cluster will just start at that index 2326 * to find the next free md_page when needed. 2327 */ 2328 } 2329 } 2330 2331 /* If we are shrinking the blob, we must adjust num_allocated_clusters */ 2332 for (i = sz; i < num_clusters; i++) { 2333 if (blob->active.clusters[i] != 0) { 2334 blob->active.num_allocated_clusters--; 2335 } 2336 } 2337 2338 blob->active.num_clusters = sz; 2339 blob->active.num_extent_pages = new_num_ep; 2340 2341 rc = 0; 2342 out: 2343 if (spdk_spin_held(&bs->used_lock)) { 2344 spdk_spin_unlock(&bs->used_lock); 2345 } 2346 2347 return rc; 2348 } 2349 2350 static void 2351 blob_persist_generate_new_md(struct spdk_blob_persist_ctx *ctx) 2352 { 2353 spdk_bs_sequence_t *seq = ctx->seq; 2354 struct spdk_blob *blob = ctx->blob; 2355 struct spdk_blob_store *bs = blob->bs; 2356 uint64_t i; 2357 uint32_t page_num; 2358 void *tmp; 2359 int rc; 2360 2361 /* Generate the new metadata */ 2362 rc = blob_serialize(blob, &ctx->pages, &blob->active.num_pages); 2363 if (rc < 0) { 2364 blob_persist_complete(seq, ctx, rc); 2365 return; 2366 } 2367 2368 assert(blob->active.num_pages >= 1); 2369 2370 /* Resize the cache of page indices */ 2371 tmp = realloc(blob->active.pages, blob->active.num_pages * sizeof(*blob->active.pages)); 2372 if (!tmp) { 2373 blob_persist_complete(seq, ctx, -ENOMEM); 2374 return; 2375 } 2376 blob->active.pages = tmp; 2377 2378 /* Assign this metadata to pages. This requires two passes - one to verify that there are 2379 * enough pages and a second to actually claim them. The used_lock is held across 2380 * both passes to ensure things don't change in the middle. 2381 */ 2382 spdk_spin_lock(&bs->used_lock); 2383 page_num = 0; 2384 /* Note that this loop starts at one. The first page location is fixed by the blobid. */ 2385 for (i = 1; i < blob->active.num_pages; i++) { 2386 page_num = spdk_bit_array_find_first_clear(bs->used_md_pages, page_num); 2387 if (page_num == UINT32_MAX) { 2388 spdk_spin_unlock(&bs->used_lock); 2389 blob_persist_complete(seq, ctx, -ENOMEM); 2390 return; 2391 } 2392 page_num++; 2393 } 2394 2395 page_num = 0; 2396 blob->active.pages[0] = bs_blobid_to_page(blob->id); 2397 for (i = 1; i < blob->active.num_pages; i++) { 2398 page_num = spdk_bit_array_find_first_clear(bs->used_md_pages, page_num); 2399 ctx->pages[i - 1].next = page_num; 2400 /* Now that previous metadata page is complete, calculate the crc for it. */ 2401 ctx->pages[i - 1].crc = blob_md_page_calc_crc(&ctx->pages[i - 1]); 2402 blob->active.pages[i] = page_num; 2403 bs_claim_md_page(bs, page_num); 2404 SPDK_DEBUGLOG(blob, "Claiming page %u for blob 0x%" PRIx64 "\n", page_num, 2405 blob->id); 2406 page_num++; 2407 } 2408 spdk_spin_unlock(&bs->used_lock); 2409 ctx->pages[i - 1].crc = blob_md_page_calc_crc(&ctx->pages[i - 1]); 2410 /* Start writing the metadata from last page to first */ 2411 blob->state = SPDK_BLOB_STATE_CLEAN; 2412 blob_persist_write_page_chain(seq, ctx); 2413 } 2414 2415 static void 2416 blob_persist_write_extent_pages(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2417 { 2418 struct spdk_blob_persist_ctx *ctx = cb_arg; 2419 struct spdk_blob *blob = ctx->blob; 2420 size_t i; 2421 uint32_t extent_page_id; 2422 uint32_t page_count = 0; 2423 int rc; 2424 2425 if (ctx->extent_page != NULL) { 2426 spdk_free(ctx->extent_page); 2427 ctx->extent_page = NULL; 2428 } 2429 2430 if (bserrno != 0) { 2431 blob_persist_complete(seq, ctx, bserrno); 2432 return; 2433 } 2434 2435 /* Only write out Extent Pages when blob was resized. */ 2436 for (i = ctx->next_extent_page; i < blob->active.extent_pages_array_size; i++) { 2437 extent_page_id = blob->active.extent_pages[i]; 2438 if (extent_page_id == 0) { 2439 /* No Extent Page to persist */ 2440 assert(spdk_blob_is_thin_provisioned(blob)); 2441 continue; 2442 } 2443 assert(spdk_bit_array_get(blob->bs->used_md_pages, extent_page_id)); 2444 ctx->next_extent_page = i + 1; 2445 rc = blob_serialize_add_page(ctx->blob, &ctx->extent_page, &page_count, &ctx->extent_page); 2446 if (rc < 0) { 2447 blob_persist_complete(seq, ctx, rc); 2448 return; 2449 } 2450 2451 blob->state = SPDK_BLOB_STATE_DIRTY; 2452 blob_serialize_extent_page(blob, i * SPDK_EXTENTS_PER_EP, ctx->extent_page); 2453 2454 ctx->extent_page->crc = blob_md_page_calc_crc(ctx->extent_page); 2455 2456 bs_sequence_write_dev(seq, ctx->extent_page, bs_md_page_to_lba(blob->bs, extent_page_id), 2457 bs_byte_to_lba(blob->bs, blob->bs->md_page_size), 2458 blob_persist_write_extent_pages, ctx); 2459 return; 2460 } 2461 2462 blob_persist_generate_new_md(ctx); 2463 } 2464 2465 static void 2466 blob_persist_start(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2467 { 2468 struct spdk_blob_persist_ctx *ctx = cb_arg; 2469 struct spdk_blob *blob = ctx->blob; 2470 2471 if (bserrno != 0) { 2472 blob_persist_complete(seq, ctx, bserrno); 2473 return; 2474 } 2475 2476 if (blob->active.num_pages == 0) { 2477 /* This is the signal that the blob should be deleted. 2478 * Immediately jump to the clean up routine. */ 2479 assert(blob->clean.num_pages > 0); 2480 blob->state = SPDK_BLOB_STATE_CLEAN; 2481 blob_persist_zero_pages(seq, ctx, 0); 2482 return; 2483 2484 } 2485 2486 if (blob->clean.num_clusters < blob->active.num_clusters) { 2487 /* Blob was resized up */ 2488 assert(blob->clean.num_extent_pages <= blob->active.num_extent_pages); 2489 ctx->next_extent_page = spdk_max(1, blob->clean.num_extent_pages) - 1; 2490 } else if (blob->active.num_clusters < blob->active.cluster_array_size) { 2491 /* Blob was resized down */ 2492 assert(blob->clean.num_extent_pages >= blob->active.num_extent_pages); 2493 ctx->next_extent_page = spdk_max(1, blob->active.num_extent_pages) - 1; 2494 } else { 2495 /* No change in size occurred */ 2496 blob_persist_generate_new_md(ctx); 2497 return; 2498 } 2499 2500 blob_persist_write_extent_pages(seq, ctx, 0); 2501 } 2502 2503 struct spdk_bs_mark_dirty { 2504 struct spdk_blob_store *bs; 2505 struct spdk_bs_super_block *super; 2506 spdk_bs_sequence_cpl cb_fn; 2507 void *cb_arg; 2508 }; 2509 2510 static void 2511 bs_mark_dirty_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2512 { 2513 struct spdk_bs_mark_dirty *ctx = cb_arg; 2514 2515 if (bserrno == 0) { 2516 ctx->bs->clean = 0; 2517 } 2518 2519 ctx->cb_fn(seq, ctx->cb_arg, bserrno); 2520 2521 spdk_free(ctx->super); 2522 free(ctx); 2523 } 2524 2525 static void bs_write_super(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 2526 struct spdk_bs_super_block *super, spdk_bs_sequence_cpl cb_fn, void *cb_arg); 2527 2528 2529 static void 2530 bs_mark_dirty_write(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2531 { 2532 struct spdk_bs_mark_dirty *ctx = cb_arg; 2533 int rc; 2534 2535 if (bserrno != 0) { 2536 bs_mark_dirty_write_cpl(seq, ctx, bserrno); 2537 return; 2538 } 2539 2540 rc = bs_super_validate(ctx->super, ctx->bs); 2541 if (rc != 0) { 2542 bs_mark_dirty_write_cpl(seq, ctx, rc); 2543 return; 2544 } 2545 2546 ctx->super->clean = 0; 2547 if (ctx->super->size == 0) { 2548 ctx->super->size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 2549 } 2550 2551 bs_write_super(seq, ctx->bs, ctx->super, bs_mark_dirty_write_cpl, ctx); 2552 } 2553 2554 static void 2555 bs_mark_dirty(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 2556 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 2557 { 2558 struct spdk_bs_mark_dirty *ctx; 2559 2560 /* Blobstore is already marked dirty */ 2561 if (bs->clean == 0) { 2562 cb_fn(seq, cb_arg, 0); 2563 return; 2564 } 2565 2566 ctx = calloc(1, sizeof(*ctx)); 2567 if (!ctx) { 2568 cb_fn(seq, cb_arg, -ENOMEM); 2569 return; 2570 } 2571 ctx->bs = bs; 2572 ctx->cb_fn = cb_fn; 2573 ctx->cb_arg = cb_arg; 2574 2575 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 2576 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 2577 if (!ctx->super) { 2578 free(ctx); 2579 cb_fn(seq, cb_arg, -ENOMEM); 2580 return; 2581 } 2582 2583 bs_sequence_read_dev(seq, ctx->super, bs_page_to_lba(bs, 0), 2584 bs_byte_to_lba(bs, sizeof(*ctx->super)), 2585 bs_mark_dirty_write, ctx); 2586 } 2587 2588 /* Write a blob to disk */ 2589 static void 2590 blob_persist(spdk_bs_sequence_t *seq, struct spdk_blob *blob, 2591 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 2592 { 2593 struct spdk_blob_persist_ctx *ctx; 2594 2595 blob_verify_md_op(blob); 2596 2597 if (blob->state == SPDK_BLOB_STATE_CLEAN && TAILQ_EMPTY(&blob->persists_to_complete)) { 2598 cb_fn(seq, cb_arg, 0); 2599 return; 2600 } 2601 2602 ctx = calloc(1, sizeof(*ctx)); 2603 if (!ctx) { 2604 cb_fn(seq, cb_arg, -ENOMEM); 2605 return; 2606 } 2607 ctx->blob = blob; 2608 ctx->seq = seq; 2609 ctx->cb_fn = cb_fn; 2610 ctx->cb_arg = cb_arg; 2611 2612 /* Multiple blob persists can affect one another, via blob->state or 2613 * blob mutable data changes. To prevent it, queue up the persists. */ 2614 if (!TAILQ_EMPTY(&blob->persists_to_complete)) { 2615 TAILQ_INSERT_TAIL(&blob->pending_persists, ctx, link); 2616 return; 2617 } 2618 TAILQ_INSERT_HEAD(&blob->persists_to_complete, ctx, link); 2619 2620 bs_mark_dirty(seq, blob->bs, blob_persist_start, ctx); 2621 } 2622 2623 struct spdk_blob_copy_cluster_ctx { 2624 struct spdk_blob *blob; 2625 uint8_t *buf; 2626 uint64_t io_unit; 2627 uint64_t new_cluster; 2628 uint32_t new_extent_page; 2629 spdk_bs_sequence_t *seq; 2630 struct spdk_blob_md_page *new_cluster_page; 2631 }; 2632 2633 struct spdk_blob_free_cluster_ctx { 2634 struct spdk_blob *blob; 2635 uint64_t page; 2636 struct spdk_blob_md_page *md_page; 2637 uint64_t cluster_num; 2638 uint32_t extent_page; 2639 spdk_bs_sequence_t *seq; 2640 }; 2641 2642 static void 2643 blob_allocate_and_copy_cluster_cpl(void *cb_arg, int bserrno) 2644 { 2645 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2646 struct spdk_bs_request_set *set = (struct spdk_bs_request_set *)ctx->seq; 2647 TAILQ_HEAD(, spdk_bs_request_set) requests; 2648 spdk_bs_user_op_t *op; 2649 2650 TAILQ_INIT(&requests); 2651 TAILQ_SWAP(&set->channel->need_cluster_alloc, &requests, spdk_bs_request_set, link); 2652 2653 while (!TAILQ_EMPTY(&requests)) { 2654 op = TAILQ_FIRST(&requests); 2655 TAILQ_REMOVE(&requests, op, link); 2656 if (bserrno == 0) { 2657 bs_user_op_execute(op); 2658 } else { 2659 bs_user_op_abort(op, bserrno); 2660 } 2661 } 2662 2663 spdk_free(ctx->buf); 2664 free(ctx); 2665 } 2666 2667 static void 2668 blob_free_cluster_cpl(void *cb_arg, int bserrno) 2669 { 2670 struct spdk_blob_free_cluster_ctx *ctx = cb_arg; 2671 spdk_bs_sequence_t *seq = ctx->seq; 2672 2673 bs_sequence_finish(seq, bserrno); 2674 2675 free(ctx); 2676 } 2677 2678 static void 2679 blob_insert_cluster_revert(struct spdk_blob_copy_cluster_ctx *ctx) 2680 { 2681 spdk_spin_lock(&ctx->blob->bs->used_lock); 2682 bs_release_cluster(ctx->blob->bs, ctx->new_cluster); 2683 if (ctx->new_extent_page != 0) { 2684 bs_release_md_page(ctx->blob->bs, ctx->new_extent_page); 2685 } 2686 spdk_spin_unlock(&ctx->blob->bs->used_lock); 2687 } 2688 2689 static void 2690 blob_insert_cluster_clear_cpl(void *cb_arg, int bserrno) 2691 { 2692 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2693 2694 if (bserrno) { 2695 SPDK_WARNLOG("Failed to clear cluster: %d\n", bserrno); 2696 } 2697 2698 blob_insert_cluster_revert(ctx); 2699 bs_sequence_finish(ctx->seq, bserrno); 2700 } 2701 2702 static void 2703 blob_insert_cluster_clear(struct spdk_blob_copy_cluster_ctx *ctx) 2704 { 2705 struct spdk_bs_cpl cpl; 2706 spdk_bs_batch_t *batch; 2707 struct spdk_io_channel *ch = spdk_io_channel_from_ctx(ctx->seq->channel); 2708 2709 /* 2710 * We allocated a cluster and we copied data to it. But now, we realized that we don't need 2711 * this cluster and we want to release it. We must ensure that we clear the data on this 2712 * cluster. 2713 * The cluster may later be re-allocated by a thick-provisioned blob for example. When 2714 * reading from this thick-provisioned blob before writing data, we should read zeroes. 2715 */ 2716 2717 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2718 cpl.u.blob_basic.cb_fn = blob_insert_cluster_clear_cpl; 2719 cpl.u.blob_basic.cb_arg = ctx; 2720 2721 batch = bs_batch_open(ch, &cpl, ctx->blob); 2722 if (!batch) { 2723 blob_insert_cluster_clear_cpl(ctx, -ENOMEM); 2724 return; 2725 } 2726 2727 bs_batch_clear_dev(ctx->blob, batch, bs_cluster_to_lba(ctx->blob->bs, ctx->new_cluster), 2728 bs_cluster_to_lba(ctx->blob->bs, 1)); 2729 bs_batch_close(batch); 2730 } 2731 2732 static void 2733 blob_insert_cluster_cpl(void *cb_arg, int bserrno) 2734 { 2735 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2736 2737 if (bserrno) { 2738 if (bserrno == -EEXIST) { 2739 /* The metadata insert failed because another thread 2740 * allocated the cluster first. Clear and free our cluster 2741 * but continue without error. */ 2742 blob_insert_cluster_clear(ctx); 2743 return; 2744 } 2745 2746 blob_insert_cluster_revert(ctx); 2747 } 2748 2749 bs_sequence_finish(ctx->seq, bserrno); 2750 } 2751 2752 static void 2753 blob_write_copy_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2754 { 2755 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2756 uint32_t cluster_number; 2757 2758 if (bserrno) { 2759 /* The write failed, so jump to the final completion handler */ 2760 bs_sequence_finish(seq, bserrno); 2761 return; 2762 } 2763 2764 cluster_number = bs_io_unit_to_cluster(ctx->blob->bs, ctx->io_unit); 2765 2766 blob_insert_cluster_on_md_thread(ctx->blob, cluster_number, ctx->new_cluster, 2767 ctx->new_extent_page, ctx->new_cluster_page, blob_insert_cluster_cpl, ctx); 2768 } 2769 2770 static void 2771 blob_write_copy(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2772 { 2773 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2774 2775 if (bserrno != 0) { 2776 /* The read failed, so jump to the final completion handler */ 2777 bs_sequence_finish(seq, bserrno); 2778 return; 2779 } 2780 2781 /* Write whole cluster */ 2782 bs_sequence_write_dev(seq, ctx->buf, 2783 bs_cluster_to_lba(ctx->blob->bs, ctx->new_cluster), 2784 bs_cluster_to_lba(ctx->blob->bs, 1), 2785 blob_write_copy_cpl, ctx); 2786 } 2787 2788 static bool 2789 blob_can_copy(struct spdk_blob *blob, uint64_t cluster_start_io_unit, uint64_t *base_lba) 2790 { 2791 uint64_t lba = bs_dev_io_unit_to_lba(blob, blob->back_bs_dev, cluster_start_io_unit); 2792 2793 return (!blob_is_esnap_clone(blob) && blob->bs->dev->copy != NULL) && 2794 blob->back_bs_dev->translate_lba(blob->back_bs_dev, lba, base_lba); 2795 } 2796 2797 static void 2798 blob_copy(struct spdk_blob_copy_cluster_ctx *ctx, spdk_bs_user_op_t *op, uint64_t src_lba) 2799 { 2800 struct spdk_blob *blob = ctx->blob; 2801 uint64_t lba_count = bs_dev_byte_to_lba(blob->back_bs_dev, blob->bs->cluster_sz); 2802 2803 bs_sequence_copy_dev(ctx->seq, 2804 bs_cluster_to_lba(blob->bs, ctx->new_cluster), 2805 src_lba, 2806 lba_count, 2807 blob_write_copy_cpl, ctx); 2808 } 2809 2810 static void 2811 bs_allocate_and_copy_cluster(struct spdk_blob *blob, 2812 struct spdk_io_channel *_ch, 2813 uint64_t io_unit, spdk_bs_user_op_t *op) 2814 { 2815 struct spdk_bs_cpl cpl; 2816 struct spdk_bs_channel *ch; 2817 struct spdk_blob_copy_cluster_ctx *ctx; 2818 uint64_t cluster_start_io_unit; 2819 uint32_t cluster_number; 2820 bool is_zeroes; 2821 bool can_copy; 2822 bool is_valid_range; 2823 uint64_t copy_src_lba; 2824 int rc; 2825 2826 ch = spdk_io_channel_get_ctx(_ch); 2827 2828 if (!TAILQ_EMPTY(&ch->need_cluster_alloc)) { 2829 /* There are already operations pending. Queue this user op 2830 * and return because it will be re-executed when the outstanding 2831 * cluster allocation completes. */ 2832 TAILQ_INSERT_TAIL(&ch->need_cluster_alloc, op, link); 2833 return; 2834 } 2835 2836 /* Round the io_unit offset down to the first io_unit in the cluster */ 2837 cluster_start_io_unit = bs_io_unit_to_cluster_start(blob, io_unit); 2838 2839 /* Calculate which index in the metadata cluster array the corresponding 2840 * cluster is supposed to be at. */ 2841 cluster_number = bs_io_unit_to_cluster_number(blob, io_unit); 2842 2843 ctx = calloc(1, sizeof(*ctx)); 2844 if (!ctx) { 2845 bs_user_op_abort(op, -ENOMEM); 2846 return; 2847 } 2848 2849 assert(blob->bs->cluster_sz % blob->back_bs_dev->blocklen == 0); 2850 2851 ctx->blob = blob; 2852 ctx->io_unit = cluster_start_io_unit; 2853 ctx->new_cluster_page = ch->new_cluster_page; 2854 memset(ctx->new_cluster_page, 0, blob->bs->md_page_size); 2855 2856 /* Check if the cluster that we intend to do CoW for is valid for 2857 * the backing dev. For zeroes backing dev, it'll be always valid. 2858 * For other backing dev e.g. a snapshot, it could be invalid if 2859 * the blob has been resized after snapshot was taken. */ 2860 is_valid_range = blob->back_bs_dev->is_range_valid(blob->back_bs_dev, 2861 bs_dev_io_unit_to_lba(blob, blob->back_bs_dev, cluster_start_io_unit), 2862 bs_dev_byte_to_lba(blob->back_bs_dev, blob->bs->cluster_sz)); 2863 2864 can_copy = is_valid_range && blob_can_copy(blob, cluster_start_io_unit, ©_src_lba); 2865 2866 is_zeroes = is_valid_range && blob->back_bs_dev->is_zeroes(blob->back_bs_dev, 2867 bs_dev_io_unit_to_lba(blob, blob->back_bs_dev, cluster_start_io_unit), 2868 bs_dev_byte_to_lba(blob->back_bs_dev, blob->bs->cluster_sz)); 2869 if (blob->parent_id != SPDK_BLOBID_INVALID && !is_zeroes && !can_copy) { 2870 ctx->buf = spdk_malloc(blob->bs->cluster_sz, blob->back_bs_dev->blocklen, 2871 NULL, SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 2872 if (!ctx->buf) { 2873 SPDK_ERRLOG("DMA allocation for cluster of size = %" PRIu32 " failed.\n", 2874 blob->bs->cluster_sz); 2875 free(ctx); 2876 bs_user_op_abort(op, -ENOMEM); 2877 return; 2878 } 2879 } 2880 2881 spdk_spin_lock(&blob->bs->used_lock); 2882 rc = bs_allocate_cluster(blob, cluster_number, &ctx->new_cluster, &ctx->new_extent_page, 2883 false); 2884 spdk_spin_unlock(&blob->bs->used_lock); 2885 if (rc != 0) { 2886 spdk_free(ctx->buf); 2887 free(ctx); 2888 bs_user_op_abort(op, rc); 2889 return; 2890 } 2891 2892 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2893 cpl.u.blob_basic.cb_fn = blob_allocate_and_copy_cluster_cpl; 2894 cpl.u.blob_basic.cb_arg = ctx; 2895 2896 ctx->seq = bs_sequence_start_blob(_ch, &cpl, blob); 2897 if (!ctx->seq) { 2898 spdk_spin_lock(&blob->bs->used_lock); 2899 bs_release_cluster(blob->bs, ctx->new_cluster); 2900 spdk_spin_unlock(&blob->bs->used_lock); 2901 spdk_free(ctx->buf); 2902 free(ctx); 2903 bs_user_op_abort(op, -ENOMEM); 2904 return; 2905 } 2906 2907 /* Queue the user op to block other incoming operations */ 2908 TAILQ_INSERT_TAIL(&ch->need_cluster_alloc, op, link); 2909 2910 if (blob->parent_id != SPDK_BLOBID_INVALID && !is_zeroes) { 2911 if (can_copy) { 2912 blob_copy(ctx, op, copy_src_lba); 2913 } else { 2914 /* Read cluster from backing device */ 2915 bs_sequence_read_bs_dev(ctx->seq, blob->back_bs_dev, ctx->buf, 2916 bs_dev_io_unit_to_lba(blob, blob->back_bs_dev, cluster_start_io_unit), 2917 bs_dev_byte_to_lba(blob->back_bs_dev, blob->bs->cluster_sz), 2918 blob_write_copy, ctx); 2919 } 2920 2921 } else { 2922 blob_insert_cluster_on_md_thread(ctx->blob, cluster_number, ctx->new_cluster, 2923 ctx->new_extent_page, ctx->new_cluster_page, blob_insert_cluster_cpl, ctx); 2924 } 2925 } 2926 2927 static inline bool 2928 blob_calculate_lba_and_lba_count(struct spdk_blob *blob, uint64_t io_unit, uint64_t length, 2929 uint64_t *lba, uint64_t *lba_count) 2930 { 2931 *lba_count = length; 2932 2933 if (!bs_io_unit_is_allocated(blob, io_unit)) { 2934 assert(blob->back_bs_dev != NULL); 2935 *lba = bs_io_unit_to_back_dev_lba(blob, io_unit); 2936 *lba_count = bs_io_unit_to_back_dev_lba(blob, *lba_count); 2937 return false; 2938 } else { 2939 *lba = bs_blob_io_unit_to_lba(blob, io_unit); 2940 return true; 2941 } 2942 } 2943 2944 struct op_split_ctx { 2945 struct spdk_blob *blob; 2946 struct spdk_io_channel *channel; 2947 uint64_t io_unit_offset; 2948 uint64_t io_units_remaining; 2949 void *curr_payload; 2950 enum spdk_blob_op_type op_type; 2951 spdk_bs_sequence_t *seq; 2952 bool in_submit_ctx; 2953 bool completed_in_submit_ctx; 2954 bool done; 2955 }; 2956 2957 static void 2958 blob_request_submit_op_split_next(void *cb_arg, int bserrno) 2959 { 2960 struct op_split_ctx *ctx = cb_arg; 2961 struct spdk_blob *blob = ctx->blob; 2962 struct spdk_io_channel *ch = ctx->channel; 2963 enum spdk_blob_op_type op_type = ctx->op_type; 2964 uint8_t *buf; 2965 uint64_t offset; 2966 uint64_t length; 2967 uint64_t op_length; 2968 2969 if (bserrno != 0 || ctx->io_units_remaining == 0) { 2970 bs_sequence_finish(ctx->seq, bserrno); 2971 if (ctx->in_submit_ctx) { 2972 /* Defer freeing of the ctx object, since it will be 2973 * accessed when this unwinds back to the submission 2974 * context. 2975 */ 2976 ctx->done = true; 2977 } else { 2978 free(ctx); 2979 } 2980 return; 2981 } 2982 2983 if (ctx->in_submit_ctx) { 2984 /* If this split operation completed in the context 2985 * of its submission, mark the flag and return immediately 2986 * to avoid recursion. 2987 */ 2988 ctx->completed_in_submit_ctx = true; 2989 return; 2990 } 2991 2992 while (true) { 2993 ctx->completed_in_submit_ctx = false; 2994 2995 offset = ctx->io_unit_offset; 2996 length = ctx->io_units_remaining; 2997 buf = ctx->curr_payload; 2998 op_length = spdk_min(length, bs_num_io_units_to_cluster_boundary(blob, 2999 offset)); 3000 3001 /* Update length and payload for next operation */ 3002 ctx->io_units_remaining -= op_length; 3003 ctx->io_unit_offset += op_length; 3004 if (op_type == SPDK_BLOB_WRITE || op_type == SPDK_BLOB_READ) { 3005 ctx->curr_payload += op_length * blob->bs->io_unit_size; 3006 } 3007 3008 assert(!ctx->in_submit_ctx); 3009 ctx->in_submit_ctx = true; 3010 3011 switch (op_type) { 3012 case SPDK_BLOB_READ: 3013 spdk_blob_io_read(blob, ch, buf, offset, op_length, 3014 blob_request_submit_op_split_next, ctx); 3015 break; 3016 case SPDK_BLOB_WRITE: 3017 spdk_blob_io_write(blob, ch, buf, offset, op_length, 3018 blob_request_submit_op_split_next, ctx); 3019 break; 3020 case SPDK_BLOB_UNMAP: 3021 spdk_blob_io_unmap(blob, ch, offset, op_length, 3022 blob_request_submit_op_split_next, ctx); 3023 break; 3024 case SPDK_BLOB_WRITE_ZEROES: 3025 spdk_blob_io_write_zeroes(blob, ch, offset, op_length, 3026 blob_request_submit_op_split_next, ctx); 3027 break; 3028 case SPDK_BLOB_READV: 3029 case SPDK_BLOB_WRITEV: 3030 SPDK_ERRLOG("readv/write not valid\n"); 3031 bs_sequence_finish(ctx->seq, -EINVAL); 3032 free(ctx); 3033 return; 3034 } 3035 3036 #ifndef __clang_analyzer__ 3037 /* scan-build reports a false positive around accessing the ctx here. It 3038 * forms a path that recursively calls this function, but then says 3039 * "assuming ctx->in_submit_ctx is false", when that isn't possible. 3040 * This path does free(ctx), returns to here, and reports a use-after-free 3041 * bug. Wrapping this bit of code so that scan-build doesn't see it 3042 * works around the scan-build bug. 3043 */ 3044 assert(ctx->in_submit_ctx); 3045 ctx->in_submit_ctx = false; 3046 3047 /* If the operation completed immediately, loop back and submit the 3048 * next operation. Otherwise we can return and the next split 3049 * operation will get submitted when this current operation is 3050 * later completed asynchronously. 3051 */ 3052 if (ctx->completed_in_submit_ctx) { 3053 continue; 3054 } else if (ctx->done) { 3055 free(ctx); 3056 } 3057 #endif 3058 break; 3059 } 3060 } 3061 3062 static void 3063 blob_request_submit_op_split(struct spdk_io_channel *ch, struct spdk_blob *blob, 3064 void *payload, uint64_t offset, uint64_t length, 3065 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 3066 { 3067 struct op_split_ctx *ctx; 3068 spdk_bs_sequence_t *seq; 3069 struct spdk_bs_cpl cpl; 3070 3071 assert(blob != NULL); 3072 3073 ctx = calloc(1, sizeof(struct op_split_ctx)); 3074 if (ctx == NULL) { 3075 cb_fn(cb_arg, -ENOMEM); 3076 return; 3077 } 3078 3079 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 3080 cpl.u.blob_basic.cb_fn = cb_fn; 3081 cpl.u.blob_basic.cb_arg = cb_arg; 3082 3083 seq = bs_sequence_start_blob(ch, &cpl, blob); 3084 if (!seq) { 3085 free(ctx); 3086 cb_fn(cb_arg, -ENOMEM); 3087 return; 3088 } 3089 3090 ctx->blob = blob; 3091 ctx->channel = ch; 3092 ctx->curr_payload = payload; 3093 ctx->io_unit_offset = offset; 3094 ctx->io_units_remaining = length; 3095 ctx->op_type = op_type; 3096 ctx->seq = seq; 3097 3098 blob_request_submit_op_split_next(ctx, 0); 3099 } 3100 3101 static void 3102 spdk_free_cluster_unmap_complete(void *cb_arg, int bserrno) 3103 { 3104 struct spdk_blob_free_cluster_ctx *ctx = cb_arg; 3105 3106 if (bserrno) { 3107 bs_sequence_finish(ctx->seq, bserrno); 3108 free(ctx); 3109 return; 3110 } 3111 3112 blob_free_cluster_on_md_thread(ctx->blob, ctx->cluster_num, 3113 ctx->extent_page, ctx->md_page, blob_free_cluster_cpl, ctx); 3114 } 3115 3116 static void 3117 blob_request_submit_op_single(struct spdk_io_channel *_ch, struct spdk_blob *blob, 3118 void *payload, uint64_t offset, uint64_t length, 3119 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 3120 { 3121 struct spdk_bs_cpl cpl; 3122 uint64_t lba; 3123 uint64_t lba_count; 3124 bool is_allocated; 3125 3126 assert(blob != NULL); 3127 3128 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 3129 cpl.u.blob_basic.cb_fn = cb_fn; 3130 cpl.u.blob_basic.cb_arg = cb_arg; 3131 3132 if (blob->frozen_refcnt) { 3133 /* This blob I/O is frozen */ 3134 spdk_bs_user_op_t *op; 3135 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_ch); 3136 3137 op = bs_user_op_alloc(_ch, &cpl, op_type, blob, payload, 0, offset, length); 3138 if (!op) { 3139 cb_fn(cb_arg, -ENOMEM); 3140 return; 3141 } 3142 3143 TAILQ_INSERT_TAIL(&bs_channel->queued_io, op, link); 3144 3145 return; 3146 } 3147 3148 is_allocated = blob_calculate_lba_and_lba_count(blob, offset, length, &lba, &lba_count); 3149 3150 switch (op_type) { 3151 case SPDK_BLOB_READ: { 3152 spdk_bs_batch_t *batch; 3153 3154 batch = bs_batch_open(_ch, &cpl, blob); 3155 if (!batch) { 3156 cb_fn(cb_arg, -ENOMEM); 3157 return; 3158 } 3159 3160 if (is_allocated) { 3161 /* Read from the blob */ 3162 bs_batch_read_dev(batch, payload, lba, lba_count); 3163 } else { 3164 /* Read from the backing block device */ 3165 bs_batch_read_bs_dev(batch, blob->back_bs_dev, payload, lba, lba_count); 3166 } 3167 3168 bs_batch_close(batch); 3169 break; 3170 } 3171 case SPDK_BLOB_WRITE: 3172 case SPDK_BLOB_WRITE_ZEROES: { 3173 if (is_allocated) { 3174 /* Write to the blob */ 3175 spdk_bs_batch_t *batch; 3176 3177 if (lba_count == 0) { 3178 cb_fn(cb_arg, 0); 3179 return; 3180 } 3181 3182 batch = bs_batch_open(_ch, &cpl, blob); 3183 if (!batch) { 3184 cb_fn(cb_arg, -ENOMEM); 3185 return; 3186 } 3187 3188 if (op_type == SPDK_BLOB_WRITE) { 3189 bs_batch_write_dev(batch, payload, lba, lba_count); 3190 } else { 3191 bs_batch_write_zeroes_dev(batch, lba, lba_count); 3192 } 3193 3194 bs_batch_close(batch); 3195 } else { 3196 /* Queue this operation and allocate the cluster */ 3197 spdk_bs_user_op_t *op; 3198 3199 op = bs_user_op_alloc(_ch, &cpl, op_type, blob, payload, 0, offset, length); 3200 if (!op) { 3201 cb_fn(cb_arg, -ENOMEM); 3202 return; 3203 } 3204 3205 bs_allocate_and_copy_cluster(blob, _ch, offset, op); 3206 } 3207 break; 3208 } 3209 case SPDK_BLOB_UNMAP: { 3210 struct spdk_blob_free_cluster_ctx *ctx = NULL; 3211 spdk_bs_batch_t *batch; 3212 3213 /* if aligned with cluster release cluster */ 3214 if (spdk_blob_is_thin_provisioned(blob) && is_allocated && 3215 blob_backed_with_zeroes_dev(blob) && 3216 bs_io_units_per_cluster(blob) == length) { 3217 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_ch); 3218 uint64_t cluster_start_page; 3219 uint32_t cluster_number; 3220 3221 assert(offset % bs_io_units_per_cluster(blob) == 0); 3222 3223 /* Round the io_unit offset down to the first page in the cluster */ 3224 cluster_start_page = bs_io_unit_to_cluster_start(blob, offset); 3225 3226 /* Calculate which index in the metadata cluster array the corresponding 3227 * cluster is supposed to be at. */ 3228 cluster_number = bs_io_unit_to_cluster_number(blob, offset); 3229 3230 ctx = calloc(1, sizeof(*ctx)); 3231 if (!ctx) { 3232 cb_fn(cb_arg, -ENOMEM); 3233 return; 3234 } 3235 /* When freeing a cluster the flow should be (in order): 3236 * 1. Unmap the underlying area (so if the cluster is reclaimed in the future, it won't leak 3237 * old data) 3238 * 2. Once the unmap completes (to avoid any races with incoming writes that may claim the 3239 * cluster), update and sync metadata freeing the cluster 3240 * 3. Once metadata update is done, complete the user unmap request 3241 */ 3242 ctx->blob = blob; 3243 ctx->page = cluster_start_page; 3244 ctx->cluster_num = cluster_number; 3245 ctx->md_page = bs_channel->new_cluster_page; 3246 ctx->seq = bs_sequence_start_bs(_ch, &cpl); 3247 if (!ctx->seq) { 3248 free(ctx); 3249 cb_fn(cb_arg, -ENOMEM); 3250 return; 3251 } 3252 3253 if (blob->use_extent_table) { 3254 ctx->extent_page = *bs_cluster_to_extent_page(blob, cluster_number); 3255 } 3256 3257 cpl.u.blob_basic.cb_fn = spdk_free_cluster_unmap_complete; 3258 cpl.u.blob_basic.cb_arg = ctx; 3259 } 3260 3261 batch = bs_batch_open(_ch, &cpl, blob); 3262 if (!batch) { 3263 free(ctx); 3264 cb_fn(cb_arg, -ENOMEM); 3265 return; 3266 } 3267 3268 if (is_allocated) { 3269 bs_batch_unmap_dev(batch, lba, lba_count); 3270 } 3271 3272 bs_batch_close(batch); 3273 break; 3274 } 3275 case SPDK_BLOB_READV: 3276 case SPDK_BLOB_WRITEV: 3277 SPDK_ERRLOG("readv/write not valid\n"); 3278 cb_fn(cb_arg, -EINVAL); 3279 break; 3280 } 3281 } 3282 3283 static void 3284 blob_request_submit_op(struct spdk_blob *blob, struct spdk_io_channel *_channel, 3285 void *payload, uint64_t offset, uint64_t length, 3286 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 3287 { 3288 assert(blob != NULL); 3289 3290 if (blob->data_ro && op_type != SPDK_BLOB_READ) { 3291 cb_fn(cb_arg, -EPERM); 3292 return; 3293 } 3294 3295 if (length == 0) { 3296 cb_fn(cb_arg, 0); 3297 return; 3298 } 3299 3300 if (offset + length > bs_cluster_to_lba(blob->bs, blob->active.num_clusters)) { 3301 cb_fn(cb_arg, -EINVAL); 3302 return; 3303 } 3304 if (length <= bs_num_io_units_to_cluster_boundary(blob, offset)) { 3305 blob_request_submit_op_single(_channel, blob, payload, offset, length, 3306 cb_fn, cb_arg, op_type); 3307 } else { 3308 blob_request_submit_op_split(_channel, blob, payload, offset, length, 3309 cb_fn, cb_arg, op_type); 3310 } 3311 } 3312 3313 struct rw_iov_ctx { 3314 struct spdk_blob *blob; 3315 struct spdk_io_channel *channel; 3316 spdk_blob_op_complete cb_fn; 3317 void *cb_arg; 3318 bool read; 3319 int iovcnt; 3320 struct iovec *orig_iov; 3321 uint64_t io_unit_offset; 3322 uint64_t io_units_remaining; 3323 uint64_t io_units_done; 3324 struct spdk_blob_ext_io_opts *ext_io_opts; 3325 struct iovec iov[0]; 3326 }; 3327 3328 static void 3329 rw_iov_done(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3330 { 3331 assert(cb_arg == NULL); 3332 bs_sequence_finish(seq, bserrno); 3333 } 3334 3335 static void 3336 rw_iov_split_next(void *cb_arg, int bserrno) 3337 { 3338 struct rw_iov_ctx *ctx = cb_arg; 3339 struct spdk_blob *blob = ctx->blob; 3340 struct iovec *iov, *orig_iov; 3341 int iovcnt; 3342 size_t orig_iovoff; 3343 uint64_t io_units_count, io_units_to_boundary, io_unit_offset; 3344 uint64_t byte_count; 3345 3346 if (bserrno != 0 || ctx->io_units_remaining == 0) { 3347 ctx->cb_fn(ctx->cb_arg, bserrno); 3348 free(ctx); 3349 return; 3350 } 3351 3352 io_unit_offset = ctx->io_unit_offset; 3353 io_units_to_boundary = bs_num_io_units_to_cluster_boundary(blob, io_unit_offset); 3354 io_units_count = spdk_min(ctx->io_units_remaining, io_units_to_boundary); 3355 /* 3356 * Get index and offset into the original iov array for our current position in the I/O sequence. 3357 * byte_count will keep track of how many bytes remaining until orig_iov and orig_iovoff will 3358 * point to the current position in the I/O sequence. 3359 */ 3360 byte_count = ctx->io_units_done * blob->bs->io_unit_size; 3361 orig_iov = &ctx->orig_iov[0]; 3362 orig_iovoff = 0; 3363 while (byte_count > 0) { 3364 if (byte_count >= orig_iov->iov_len) { 3365 byte_count -= orig_iov->iov_len; 3366 orig_iov++; 3367 } else { 3368 orig_iovoff = byte_count; 3369 byte_count = 0; 3370 } 3371 } 3372 3373 /* 3374 * Build an iov array for the next I/O in the sequence. byte_count will keep track of how many 3375 * bytes of this next I/O remain to be accounted for in the new iov array. 3376 */ 3377 byte_count = io_units_count * blob->bs->io_unit_size; 3378 iov = &ctx->iov[0]; 3379 iovcnt = 0; 3380 while (byte_count > 0) { 3381 assert(iovcnt < ctx->iovcnt); 3382 iov->iov_len = spdk_min(byte_count, orig_iov->iov_len - orig_iovoff); 3383 iov->iov_base = orig_iov->iov_base + orig_iovoff; 3384 byte_count -= iov->iov_len; 3385 orig_iovoff = 0; 3386 orig_iov++; 3387 iov++; 3388 iovcnt++; 3389 } 3390 3391 ctx->io_unit_offset += io_units_count; 3392 ctx->io_units_remaining -= io_units_count; 3393 ctx->io_units_done += io_units_count; 3394 iov = &ctx->iov[0]; 3395 3396 if (ctx->read) { 3397 spdk_blob_io_readv_ext(ctx->blob, ctx->channel, iov, iovcnt, io_unit_offset, 3398 io_units_count, rw_iov_split_next, ctx, ctx->ext_io_opts); 3399 } else { 3400 spdk_blob_io_writev_ext(ctx->blob, ctx->channel, iov, iovcnt, io_unit_offset, 3401 io_units_count, rw_iov_split_next, ctx, ctx->ext_io_opts); 3402 } 3403 } 3404 3405 static void 3406 blob_request_submit_rw_iov(struct spdk_blob *blob, struct spdk_io_channel *_channel, 3407 struct iovec *iov, int iovcnt, 3408 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg, bool read, 3409 struct spdk_blob_ext_io_opts *ext_io_opts) 3410 { 3411 struct spdk_bs_cpl cpl; 3412 3413 assert(blob != NULL); 3414 3415 if (!read && blob->data_ro) { 3416 cb_fn(cb_arg, -EPERM); 3417 return; 3418 } 3419 3420 if (length == 0) { 3421 cb_fn(cb_arg, 0); 3422 return; 3423 } 3424 3425 if (offset + length > bs_cluster_to_lba(blob->bs, blob->active.num_clusters)) { 3426 cb_fn(cb_arg, -EINVAL); 3427 return; 3428 } 3429 3430 /* 3431 * For now, we implement readv/writev using a sequence (instead of a batch) to account for having 3432 * to split a request that spans a cluster boundary. For I/O that do not span a cluster boundary, 3433 * there will be no noticeable difference compared to using a batch. For I/O that do span a cluster 3434 * boundary, the target LBAs (after blob offset to LBA translation) may not be contiguous, so we need 3435 * to allocate a separate iov array and split the I/O such that none of the resulting 3436 * smaller I/O cross a cluster boundary. These smaller I/O will be issued in sequence (not in parallel) 3437 * but since this case happens very infrequently, any performance impact will be negligible. 3438 * 3439 * This could be optimized in the future to allocate a big enough iov array to account for all of the iovs 3440 * for all of the smaller I/Os, pre-build all of the iov arrays for the smaller I/Os, then issue them 3441 * in a batch. That would also require creating an intermediate spdk_bs_cpl that would get called 3442 * when the batch was completed, to allow for freeing the memory for the iov arrays. 3443 */ 3444 if (spdk_likely(length <= bs_num_io_units_to_cluster_boundary(blob, offset))) { 3445 uint64_t lba_count; 3446 uint64_t lba; 3447 bool is_allocated; 3448 3449 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 3450 cpl.u.blob_basic.cb_fn = cb_fn; 3451 cpl.u.blob_basic.cb_arg = cb_arg; 3452 3453 if (blob->frozen_refcnt) { 3454 /* This blob I/O is frozen */ 3455 enum spdk_blob_op_type op_type; 3456 spdk_bs_user_op_t *op; 3457 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_channel); 3458 3459 op_type = read ? SPDK_BLOB_READV : SPDK_BLOB_WRITEV; 3460 op = bs_user_op_alloc(_channel, &cpl, op_type, blob, iov, iovcnt, offset, length); 3461 if (!op) { 3462 cb_fn(cb_arg, -ENOMEM); 3463 return; 3464 } 3465 3466 TAILQ_INSERT_TAIL(&bs_channel->queued_io, op, link); 3467 3468 return; 3469 } 3470 3471 is_allocated = blob_calculate_lba_and_lba_count(blob, offset, length, &lba, &lba_count); 3472 3473 if (read) { 3474 spdk_bs_sequence_t *seq; 3475 3476 seq = bs_sequence_start_blob(_channel, &cpl, blob); 3477 if (!seq) { 3478 cb_fn(cb_arg, -ENOMEM); 3479 return; 3480 } 3481 3482 seq->ext_io_opts = ext_io_opts; 3483 3484 if (is_allocated) { 3485 bs_sequence_readv_dev(seq, iov, iovcnt, lba, lba_count, rw_iov_done, NULL); 3486 } else { 3487 bs_sequence_readv_bs_dev(seq, blob->back_bs_dev, iov, iovcnt, lba, lba_count, 3488 rw_iov_done, NULL); 3489 } 3490 } else { 3491 if (is_allocated) { 3492 spdk_bs_sequence_t *seq; 3493 3494 seq = bs_sequence_start_blob(_channel, &cpl, blob); 3495 if (!seq) { 3496 cb_fn(cb_arg, -ENOMEM); 3497 return; 3498 } 3499 3500 seq->ext_io_opts = ext_io_opts; 3501 3502 bs_sequence_writev_dev(seq, iov, iovcnt, lba, lba_count, rw_iov_done, NULL); 3503 } else { 3504 /* Queue this operation and allocate the cluster */ 3505 spdk_bs_user_op_t *op; 3506 3507 op = bs_user_op_alloc(_channel, &cpl, SPDK_BLOB_WRITEV, blob, iov, iovcnt, offset, 3508 length); 3509 if (!op) { 3510 cb_fn(cb_arg, -ENOMEM); 3511 return; 3512 } 3513 3514 op->ext_io_opts = ext_io_opts; 3515 3516 bs_allocate_and_copy_cluster(blob, _channel, offset, op); 3517 } 3518 } 3519 } else { 3520 struct rw_iov_ctx *ctx; 3521 3522 ctx = calloc(1, sizeof(struct rw_iov_ctx) + iovcnt * sizeof(struct iovec)); 3523 if (ctx == NULL) { 3524 cb_fn(cb_arg, -ENOMEM); 3525 return; 3526 } 3527 3528 ctx->blob = blob; 3529 ctx->channel = _channel; 3530 ctx->cb_fn = cb_fn; 3531 ctx->cb_arg = cb_arg; 3532 ctx->read = read; 3533 ctx->orig_iov = iov; 3534 ctx->iovcnt = iovcnt; 3535 ctx->io_unit_offset = offset; 3536 ctx->io_units_remaining = length; 3537 ctx->io_units_done = 0; 3538 ctx->ext_io_opts = ext_io_opts; 3539 3540 rw_iov_split_next(ctx, 0); 3541 } 3542 } 3543 3544 static struct spdk_blob * 3545 blob_lookup(struct spdk_blob_store *bs, spdk_blob_id blobid) 3546 { 3547 struct spdk_blob find; 3548 3549 if (spdk_bit_array_get(bs->open_blobids, blobid) == 0) { 3550 return NULL; 3551 } 3552 3553 find.id = blobid; 3554 return RB_FIND(spdk_blob_tree, &bs->open_blobs, &find); 3555 } 3556 3557 static void 3558 blob_get_snapshot_and_clone_entries(struct spdk_blob *blob, 3559 struct spdk_blob_list **snapshot_entry, struct spdk_blob_list **clone_entry) 3560 { 3561 assert(blob != NULL); 3562 *snapshot_entry = NULL; 3563 *clone_entry = NULL; 3564 3565 if (blob->parent_id == SPDK_BLOBID_INVALID) { 3566 return; 3567 } 3568 3569 TAILQ_FOREACH(*snapshot_entry, &blob->bs->snapshots, link) { 3570 if ((*snapshot_entry)->id == blob->parent_id) { 3571 break; 3572 } 3573 } 3574 3575 if (*snapshot_entry != NULL) { 3576 TAILQ_FOREACH(*clone_entry, &(*snapshot_entry)->clones, link) { 3577 if ((*clone_entry)->id == blob->id) { 3578 break; 3579 } 3580 } 3581 3582 assert(*clone_entry != NULL); 3583 } 3584 } 3585 3586 static int 3587 bs_channel_create(void *io_device, void *ctx_buf) 3588 { 3589 struct spdk_blob_store *bs = io_device; 3590 struct spdk_bs_channel *channel = ctx_buf; 3591 struct spdk_bs_dev *dev; 3592 uint32_t max_ops = bs->max_channel_ops; 3593 uint32_t i; 3594 3595 dev = bs->dev; 3596 3597 channel->req_mem = calloc(max_ops, sizeof(struct spdk_bs_request_set)); 3598 if (!channel->req_mem) { 3599 return -1; 3600 } 3601 3602 TAILQ_INIT(&channel->reqs); 3603 3604 for (i = 0; i < max_ops; i++) { 3605 TAILQ_INSERT_TAIL(&channel->reqs, &channel->req_mem[i], link); 3606 } 3607 3608 channel->bs = bs; 3609 channel->dev = dev; 3610 channel->dev_channel = dev->create_channel(dev); 3611 3612 if (!channel->dev_channel) { 3613 SPDK_ERRLOG("Failed to create device channel.\n"); 3614 free(channel->req_mem); 3615 return -1; 3616 } 3617 3618 channel->new_cluster_page = spdk_zmalloc(bs->md_page_size, 0, NULL, SPDK_ENV_NUMA_ID_ANY, 3619 SPDK_MALLOC_DMA); 3620 if (!channel->new_cluster_page) { 3621 SPDK_ERRLOG("Failed to allocate new cluster page\n"); 3622 free(channel->req_mem); 3623 channel->dev->destroy_channel(channel->dev, channel->dev_channel); 3624 return -1; 3625 } 3626 3627 TAILQ_INIT(&channel->need_cluster_alloc); 3628 TAILQ_INIT(&channel->queued_io); 3629 RB_INIT(&channel->esnap_channels); 3630 3631 return 0; 3632 } 3633 3634 static void 3635 bs_channel_destroy(void *io_device, void *ctx_buf) 3636 { 3637 struct spdk_bs_channel *channel = ctx_buf; 3638 spdk_bs_user_op_t *op; 3639 3640 while (!TAILQ_EMPTY(&channel->need_cluster_alloc)) { 3641 op = TAILQ_FIRST(&channel->need_cluster_alloc); 3642 TAILQ_REMOVE(&channel->need_cluster_alloc, op, link); 3643 bs_user_op_abort(op, -EIO); 3644 } 3645 3646 while (!TAILQ_EMPTY(&channel->queued_io)) { 3647 op = TAILQ_FIRST(&channel->queued_io); 3648 TAILQ_REMOVE(&channel->queued_io, op, link); 3649 bs_user_op_abort(op, -EIO); 3650 } 3651 3652 blob_esnap_destroy_bs_channel(channel); 3653 3654 free(channel->req_mem); 3655 spdk_free(channel->new_cluster_page); 3656 channel->dev->destroy_channel(channel->dev, channel->dev_channel); 3657 } 3658 3659 static void 3660 bs_dev_destroy(void *io_device) 3661 { 3662 struct spdk_blob_store *bs = io_device; 3663 struct spdk_blob *blob, *blob_tmp; 3664 3665 bs->dev->destroy(bs->dev); 3666 3667 RB_FOREACH_SAFE(blob, spdk_blob_tree, &bs->open_blobs, blob_tmp) { 3668 RB_REMOVE(spdk_blob_tree, &bs->open_blobs, blob); 3669 spdk_bit_array_clear(bs->open_blobids, blob->id); 3670 blob_free(blob); 3671 } 3672 3673 spdk_spin_destroy(&bs->used_lock); 3674 3675 spdk_bit_array_free(&bs->open_blobids); 3676 spdk_bit_array_free(&bs->used_blobids); 3677 spdk_bit_array_free(&bs->used_md_pages); 3678 spdk_bit_pool_free(&bs->used_clusters); 3679 /* 3680 * If this function is called for any reason except a successful unload, 3681 * the unload_cpl type will be NONE and this will be a nop. 3682 */ 3683 bs_call_cpl(&bs->unload_cpl, bs->unload_err); 3684 3685 free(bs); 3686 } 3687 3688 static int 3689 bs_blob_list_add(struct spdk_blob *blob) 3690 { 3691 spdk_blob_id snapshot_id; 3692 struct spdk_blob_list *snapshot_entry = NULL; 3693 struct spdk_blob_list *clone_entry = NULL; 3694 3695 assert(blob != NULL); 3696 3697 snapshot_id = blob->parent_id; 3698 if (snapshot_id == SPDK_BLOBID_INVALID || 3699 snapshot_id == SPDK_BLOBID_EXTERNAL_SNAPSHOT) { 3700 return 0; 3701 } 3702 3703 snapshot_entry = bs_get_snapshot_entry(blob->bs, snapshot_id); 3704 if (snapshot_entry == NULL) { 3705 /* Snapshot not found */ 3706 snapshot_entry = calloc(1, sizeof(struct spdk_blob_list)); 3707 if (snapshot_entry == NULL) { 3708 return -ENOMEM; 3709 } 3710 snapshot_entry->id = snapshot_id; 3711 TAILQ_INIT(&snapshot_entry->clones); 3712 TAILQ_INSERT_TAIL(&blob->bs->snapshots, snapshot_entry, link); 3713 } else { 3714 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 3715 if (clone_entry->id == blob->id) { 3716 break; 3717 } 3718 } 3719 } 3720 3721 if (clone_entry == NULL) { 3722 /* Clone not found */ 3723 clone_entry = calloc(1, sizeof(struct spdk_blob_list)); 3724 if (clone_entry == NULL) { 3725 return -ENOMEM; 3726 } 3727 clone_entry->id = blob->id; 3728 TAILQ_INIT(&clone_entry->clones); 3729 TAILQ_INSERT_TAIL(&snapshot_entry->clones, clone_entry, link); 3730 snapshot_entry->clone_count++; 3731 } 3732 3733 return 0; 3734 } 3735 3736 static void 3737 bs_blob_list_remove(struct spdk_blob *blob) 3738 { 3739 struct spdk_blob_list *snapshot_entry = NULL; 3740 struct spdk_blob_list *clone_entry = NULL; 3741 3742 blob_get_snapshot_and_clone_entries(blob, &snapshot_entry, &clone_entry); 3743 3744 if (snapshot_entry == NULL) { 3745 return; 3746 } 3747 3748 blob->parent_id = SPDK_BLOBID_INVALID; 3749 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 3750 free(clone_entry); 3751 3752 snapshot_entry->clone_count--; 3753 } 3754 3755 static int 3756 bs_blob_list_free(struct spdk_blob_store *bs) 3757 { 3758 struct spdk_blob_list *snapshot_entry; 3759 struct spdk_blob_list *snapshot_entry_tmp; 3760 struct spdk_blob_list *clone_entry; 3761 struct spdk_blob_list *clone_entry_tmp; 3762 3763 TAILQ_FOREACH_SAFE(snapshot_entry, &bs->snapshots, link, snapshot_entry_tmp) { 3764 TAILQ_FOREACH_SAFE(clone_entry, &snapshot_entry->clones, link, clone_entry_tmp) { 3765 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 3766 free(clone_entry); 3767 } 3768 TAILQ_REMOVE(&bs->snapshots, snapshot_entry, link); 3769 free(snapshot_entry); 3770 } 3771 3772 return 0; 3773 } 3774 3775 static void 3776 bs_free(struct spdk_blob_store *bs) 3777 { 3778 bs_blob_list_free(bs); 3779 3780 bs_unregister_md_thread(bs); 3781 spdk_io_device_unregister(bs, bs_dev_destroy); 3782 } 3783 3784 void 3785 spdk_bs_opts_init(struct spdk_bs_opts *opts, size_t opts_size) 3786 { 3787 3788 if (!opts) { 3789 SPDK_ERRLOG("opts should not be NULL\n"); 3790 return; 3791 } 3792 3793 if (!opts_size) { 3794 SPDK_ERRLOG("opts_size should not be zero value\n"); 3795 return; 3796 } 3797 3798 memset(opts, 0, opts_size); 3799 opts->opts_size = opts_size; 3800 3801 #define FIELD_OK(field) \ 3802 offsetof(struct spdk_bs_opts, field) + sizeof(opts->field) <= opts_size 3803 3804 #define SET_FIELD(field, value) \ 3805 if (FIELD_OK(field)) { \ 3806 opts->field = value; \ 3807 } \ 3808 3809 SET_FIELD(cluster_sz, SPDK_BLOB_OPTS_CLUSTER_SZ); 3810 SET_FIELD(num_md_pages, SPDK_BLOB_OPTS_NUM_MD_PAGES); 3811 SET_FIELD(max_md_ops, SPDK_BLOB_OPTS_NUM_MD_PAGES); 3812 SET_FIELD(max_channel_ops, SPDK_BLOB_OPTS_DEFAULT_CHANNEL_OPS); 3813 SET_FIELD(clear_method, BS_CLEAR_WITH_UNMAP); 3814 3815 if (FIELD_OK(bstype)) { 3816 memset(&opts->bstype, 0, sizeof(opts->bstype)); 3817 } 3818 3819 SET_FIELD(iter_cb_fn, NULL); 3820 SET_FIELD(iter_cb_arg, NULL); 3821 SET_FIELD(force_recover, false); 3822 SET_FIELD(esnap_bs_dev_create, NULL); 3823 SET_FIELD(esnap_ctx, NULL); 3824 3825 #undef FIELD_OK 3826 #undef SET_FIELD 3827 } 3828 3829 static int 3830 bs_opts_verify(struct spdk_bs_opts *opts) 3831 { 3832 if (opts->cluster_sz == 0 || opts->num_md_pages == 0 || opts->max_md_ops == 0 || 3833 opts->max_channel_ops == 0) { 3834 SPDK_ERRLOG("Blobstore options cannot be set to 0\n"); 3835 return -1; 3836 } 3837 3838 if ((opts->cluster_sz % SPDK_BS_PAGE_SIZE) != 0) { 3839 SPDK_ERRLOG("Cluster size %" PRIu32 " is not an integral multiple of blocklen %" PRIu32"\n", 3840 opts->cluster_sz, SPDK_BS_PAGE_SIZE); 3841 return -1; 3842 } 3843 3844 return 0; 3845 } 3846 3847 /* START spdk_bs_load */ 3848 3849 /* spdk_bs_load_ctx is used for init, load, unload and dump code paths. */ 3850 3851 struct spdk_bs_load_ctx { 3852 struct spdk_blob_store *bs; 3853 struct spdk_bs_super_block *super; 3854 3855 struct spdk_bs_md_mask *mask; 3856 bool in_page_chain; 3857 uint32_t page_index; 3858 uint32_t cur_page; 3859 struct spdk_blob_md_page *page; 3860 3861 uint64_t num_extent_pages; 3862 uint32_t *extent_page_num; 3863 struct spdk_blob_md_page *extent_pages; 3864 struct spdk_bit_array *used_clusters; 3865 3866 spdk_bs_sequence_t *seq; 3867 spdk_blob_op_with_handle_complete iter_cb_fn; 3868 void *iter_cb_arg; 3869 struct spdk_blob *blob; 3870 spdk_blob_id blobid; 3871 3872 bool force_recover; 3873 3874 /* These fields are used in the spdk_bs_dump path. */ 3875 bool dumping; 3876 FILE *fp; 3877 spdk_bs_dump_print_xattr print_xattr_fn; 3878 char xattr_name[4096]; 3879 }; 3880 3881 static void 3882 bs_init_per_cluster_fields(struct spdk_blob_store *bs) 3883 { 3884 bs->pages_per_cluster = bs->cluster_sz / bs->md_page_size; 3885 if (spdk_u32_is_pow2(bs->pages_per_cluster)) { 3886 bs->pages_per_cluster_shift = spdk_u32log2(bs->pages_per_cluster); 3887 } 3888 bs->io_units_per_cluster = bs->cluster_sz / bs->io_unit_size; 3889 if (spdk_u32_is_pow2(bs->io_units_per_cluster)) { 3890 bs->io_units_per_cluster_shift = spdk_u32log2(bs->io_units_per_cluster); 3891 } 3892 } 3893 3894 static int 3895 bs_alloc(struct spdk_bs_dev *dev, struct spdk_bs_opts *opts, struct spdk_blob_store **_bs, 3896 struct spdk_bs_load_ctx **_ctx) 3897 { 3898 struct spdk_blob_store *bs; 3899 struct spdk_bs_load_ctx *ctx; 3900 uint64_t dev_size; 3901 uint32_t md_page_size; 3902 int rc; 3903 3904 dev_size = dev->blocklen * dev->blockcnt; 3905 if (dev_size < opts->cluster_sz) { 3906 /* Device size cannot be smaller than cluster size of blobstore */ 3907 SPDK_INFOLOG(blob, "Device size %" PRIu64 " is smaller than cluster size %" PRIu32 "\n", 3908 dev_size, opts->cluster_sz); 3909 return -ENOSPC; 3910 } 3911 3912 md_page_size = spdk_max(spdk_max(dev->phys_blocklen, SPDK_BS_PAGE_SIZE), 3913 opts->md_page_size); 3914 if (opts->cluster_sz < md_page_size) { 3915 /* Cluster size cannot be smaller than page size */ 3916 SPDK_ERRLOG("Cluster size %" PRIu32 " is smaller than page size %d\n", 3917 opts->cluster_sz, md_page_size); 3918 return -EINVAL; 3919 } 3920 bs = calloc(1, sizeof(struct spdk_blob_store)); 3921 if (!bs) { 3922 return -ENOMEM; 3923 } 3924 3925 ctx = calloc(1, sizeof(struct spdk_bs_load_ctx)); 3926 if (!ctx) { 3927 free(bs); 3928 return -ENOMEM; 3929 } 3930 3931 ctx->bs = bs; 3932 ctx->iter_cb_fn = opts->iter_cb_fn; 3933 ctx->iter_cb_arg = opts->iter_cb_arg; 3934 ctx->force_recover = opts->force_recover; 3935 3936 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 3937 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 3938 if (!ctx->super) { 3939 free(ctx); 3940 free(bs); 3941 return -ENOMEM; 3942 } 3943 3944 RB_INIT(&bs->open_blobs); 3945 TAILQ_INIT(&bs->snapshots); 3946 bs->dev = dev; 3947 bs->md_page_size = md_page_size; 3948 bs->md_thread = spdk_get_thread(); 3949 assert(bs->md_thread != NULL); 3950 3951 /* 3952 * Do not use bs_lba_to_cluster() here since blockcnt may not be an 3953 * even multiple of the cluster size. 3954 */ 3955 bs->cluster_sz = opts->cluster_sz; 3956 bs->total_clusters = dev->blockcnt / (bs->cluster_sz / dev->blocklen); 3957 ctx->used_clusters = spdk_bit_array_create(bs->total_clusters); 3958 if (!ctx->used_clusters) { 3959 spdk_free(ctx->super); 3960 free(ctx); 3961 free(bs); 3962 return -ENOMEM; 3963 } 3964 3965 bs->num_free_clusters = bs->total_clusters; 3966 bs->io_unit_size = dev->blocklen; 3967 bs_init_per_cluster_fields(bs); 3968 3969 bs->max_channel_ops = opts->max_channel_ops; 3970 bs->super_blob = SPDK_BLOBID_INVALID; 3971 memcpy(&bs->bstype, &opts->bstype, sizeof(opts->bstype)); 3972 bs->esnap_bs_dev_create = opts->esnap_bs_dev_create; 3973 bs->esnap_ctx = opts->esnap_ctx; 3974 3975 /* The metadata is assumed to be at least 1 page */ 3976 bs->used_md_pages = spdk_bit_array_create(1); 3977 bs->used_blobids = spdk_bit_array_create(0); 3978 bs->open_blobids = spdk_bit_array_create(0); 3979 3980 spdk_spin_init(&bs->used_lock); 3981 3982 spdk_io_device_register(bs, bs_channel_create, bs_channel_destroy, 3983 sizeof(struct spdk_bs_channel), "blobstore"); 3984 rc = bs_register_md_thread(bs); 3985 if (rc == -1) { 3986 spdk_io_device_unregister(bs, NULL); 3987 spdk_spin_destroy(&bs->used_lock); 3988 spdk_bit_array_free(&bs->open_blobids); 3989 spdk_bit_array_free(&bs->used_blobids); 3990 spdk_bit_array_free(&bs->used_md_pages); 3991 spdk_bit_array_free(&ctx->used_clusters); 3992 spdk_free(ctx->super); 3993 free(ctx); 3994 free(bs); 3995 /* FIXME: this is a lie but don't know how to get a proper error code here */ 3996 return -ENOMEM; 3997 } 3998 3999 *_ctx = ctx; 4000 *_bs = bs; 4001 return 0; 4002 } 4003 4004 static void 4005 bs_write_super(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 4006 struct spdk_bs_super_block *super, spdk_bs_sequence_cpl cb_fn, void *cb_arg) 4007 { 4008 /* Update the values in the super block */ 4009 super->super_blob = bs->super_blob; 4010 memcpy(&super->bstype, &bs->bstype, sizeof(bs->bstype)); 4011 super->crc = blob_md_page_calc_crc(super); 4012 bs_sequence_write_dev(seq, super, bs_page_to_lba(bs, 0), 4013 bs_byte_to_lba(bs, sizeof(*super)), 4014 cb_fn, cb_arg); 4015 } 4016 4017 static void 4018 bs_write_used_clusters(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 4019 { 4020 struct spdk_bs_load_ctx *ctx = arg; 4021 uint64_t mask_size, lba, lba_count; 4022 4023 /* Write out the used clusters mask */ 4024 mask_size = ctx->super->used_cluster_mask_len * ctx->bs->md_page_size; 4025 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 4026 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 4027 if (!ctx->mask) { 4028 cb_fn(seq, arg, -ENOMEM); 4029 return; 4030 } 4031 4032 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_CLUSTERS; 4033 ctx->mask->length = ctx->bs->total_clusters; 4034 /* We could get here through the normal unload path, or through dirty 4035 * shutdown recovery. For the normal unload path, we use the mask from 4036 * the bit pool. For dirty shutdown recovery, we don't have a bit pool yet - 4037 * only the bit array from the load ctx. 4038 */ 4039 if (ctx->bs->used_clusters) { 4040 assert(ctx->mask->length == spdk_bit_pool_capacity(ctx->bs->used_clusters)); 4041 spdk_bit_pool_store_mask(ctx->bs->used_clusters, ctx->mask->mask); 4042 } else { 4043 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->used_clusters)); 4044 spdk_bit_array_store_mask(ctx->used_clusters, ctx->mask->mask); 4045 } 4046 lba = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 4047 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 4048 bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 4049 } 4050 4051 static void 4052 bs_write_used_md(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 4053 { 4054 struct spdk_bs_load_ctx *ctx = arg; 4055 uint64_t mask_size, lba, lba_count; 4056 4057 mask_size = ctx->super->used_page_mask_len * ctx->bs->md_page_size; 4058 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 4059 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 4060 if (!ctx->mask) { 4061 cb_fn(seq, arg, -ENOMEM); 4062 return; 4063 } 4064 4065 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_PAGES; 4066 ctx->mask->length = ctx->super->md_len; 4067 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_md_pages)); 4068 4069 spdk_bit_array_store_mask(ctx->bs->used_md_pages, ctx->mask->mask); 4070 lba = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_start); 4071 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_len); 4072 bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 4073 } 4074 4075 static void 4076 bs_write_used_blobids(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 4077 { 4078 struct spdk_bs_load_ctx *ctx = arg; 4079 uint64_t mask_size, lba, lba_count; 4080 4081 if (ctx->super->used_blobid_mask_len == 0) { 4082 /* 4083 * This is a pre-v3 on-disk format where the blobid mask does not get 4084 * written to disk. 4085 */ 4086 cb_fn(seq, arg, 0); 4087 return; 4088 } 4089 4090 mask_size = ctx->super->used_blobid_mask_len * ctx->bs->md_page_size; 4091 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_NUMA_ID_ANY, 4092 SPDK_MALLOC_DMA); 4093 if (!ctx->mask) { 4094 cb_fn(seq, arg, -ENOMEM); 4095 return; 4096 } 4097 4098 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_BLOBIDS; 4099 ctx->mask->length = ctx->super->md_len; 4100 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_blobids)); 4101 4102 spdk_bit_array_store_mask(ctx->bs->used_blobids, ctx->mask->mask); 4103 lba = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_start); 4104 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_len); 4105 bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 4106 } 4107 4108 static void 4109 blob_set_thin_provision(struct spdk_blob *blob) 4110 { 4111 blob_verify_md_op(blob); 4112 blob->invalid_flags |= SPDK_BLOB_THIN_PROV; 4113 blob->state = SPDK_BLOB_STATE_DIRTY; 4114 } 4115 4116 static void 4117 blob_set_clear_method(struct spdk_blob *blob, enum blob_clear_method clear_method) 4118 { 4119 blob_verify_md_op(blob); 4120 blob->clear_method = clear_method; 4121 blob->md_ro_flags |= (clear_method << SPDK_BLOB_CLEAR_METHOD_SHIFT); 4122 blob->state = SPDK_BLOB_STATE_DIRTY; 4123 } 4124 4125 static void bs_load_iter(void *arg, struct spdk_blob *blob, int bserrno); 4126 4127 static void 4128 bs_delete_corrupted_blob_cpl(void *cb_arg, int bserrno) 4129 { 4130 struct spdk_bs_load_ctx *ctx = cb_arg; 4131 spdk_blob_id id; 4132 int64_t page_num; 4133 4134 /* Iterate to next blob (we can't use spdk_bs_iter_next function as our 4135 * last blob has been removed */ 4136 page_num = bs_blobid_to_page(ctx->blobid); 4137 page_num++; 4138 page_num = spdk_bit_array_find_first_set(ctx->bs->used_blobids, page_num); 4139 if (page_num >= spdk_bit_array_capacity(ctx->bs->used_blobids)) { 4140 bs_load_iter(ctx, NULL, -ENOENT); 4141 return; 4142 } 4143 4144 id = bs_page_to_blobid(page_num); 4145 4146 spdk_bs_open_blob(ctx->bs, id, bs_load_iter, ctx); 4147 } 4148 4149 static void 4150 bs_delete_corrupted_close_cb(void *cb_arg, int bserrno) 4151 { 4152 struct spdk_bs_load_ctx *ctx = cb_arg; 4153 4154 if (bserrno != 0) { 4155 SPDK_ERRLOG("Failed to close corrupted blob\n"); 4156 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 4157 return; 4158 } 4159 4160 spdk_bs_delete_blob(ctx->bs, ctx->blobid, bs_delete_corrupted_blob_cpl, ctx); 4161 } 4162 4163 static void 4164 bs_delete_corrupted_blob(void *cb_arg, int bserrno) 4165 { 4166 struct spdk_bs_load_ctx *ctx = cb_arg; 4167 uint64_t i; 4168 4169 if (bserrno != 0) { 4170 SPDK_ERRLOG("Failed to close clone of a corrupted blob\n"); 4171 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 4172 return; 4173 } 4174 4175 /* Snapshot and clone have the same copy of cluster map and extent pages 4176 * at this point. Let's clear both for snapshot now, 4177 * so that it won't be cleared for clone later when we remove snapshot. 4178 * Also set thin provision to pass data corruption check */ 4179 for (i = 0; i < ctx->blob->active.num_clusters; i++) { 4180 ctx->blob->active.clusters[i] = 0; 4181 } 4182 for (i = 0; i < ctx->blob->active.num_extent_pages; i++) { 4183 ctx->blob->active.extent_pages[i] = 0; 4184 } 4185 4186 ctx->blob->active.num_allocated_clusters = 0; 4187 4188 ctx->blob->md_ro = false; 4189 4190 blob_set_thin_provision(ctx->blob); 4191 4192 ctx->blobid = ctx->blob->id; 4193 4194 spdk_blob_close(ctx->blob, bs_delete_corrupted_close_cb, ctx); 4195 } 4196 4197 static void 4198 bs_update_corrupted_blob(void *cb_arg, int bserrno) 4199 { 4200 struct spdk_bs_load_ctx *ctx = cb_arg; 4201 4202 if (bserrno != 0) { 4203 SPDK_ERRLOG("Failed to close clone of a corrupted blob\n"); 4204 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 4205 return; 4206 } 4207 4208 ctx->blob->md_ro = false; 4209 blob_remove_xattr(ctx->blob, SNAPSHOT_PENDING_REMOVAL, true); 4210 blob_remove_xattr(ctx->blob, SNAPSHOT_IN_PROGRESS, true); 4211 spdk_blob_set_read_only(ctx->blob); 4212 4213 if (ctx->iter_cb_fn) { 4214 ctx->iter_cb_fn(ctx->iter_cb_arg, ctx->blob, 0); 4215 } 4216 bs_blob_list_add(ctx->blob); 4217 4218 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 4219 } 4220 4221 static void 4222 bs_examine_clone(void *cb_arg, struct spdk_blob *blob, int bserrno) 4223 { 4224 struct spdk_bs_load_ctx *ctx = cb_arg; 4225 4226 if (bserrno != 0) { 4227 SPDK_ERRLOG("Failed to open clone of a corrupted blob\n"); 4228 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 4229 return; 4230 } 4231 4232 if (blob->parent_id == ctx->blob->id) { 4233 /* Power failure occurred before updating clone (snapshot delete case) 4234 * or after updating clone (creating snapshot case) - keep snapshot */ 4235 spdk_blob_close(blob, bs_update_corrupted_blob, ctx); 4236 } else { 4237 /* Power failure occurred after updating clone (snapshot delete case) 4238 * or before updating clone (creating snapshot case) - remove snapshot */ 4239 spdk_blob_close(blob, bs_delete_corrupted_blob, ctx); 4240 } 4241 } 4242 4243 static void 4244 bs_load_iter(void *arg, struct spdk_blob *blob, int bserrno) 4245 { 4246 struct spdk_bs_load_ctx *ctx = arg; 4247 const void *value; 4248 size_t len; 4249 int rc = 0; 4250 4251 if (bserrno == 0) { 4252 /* Examine blob if it is corrupted after power failure. Fix 4253 * the ones that can be fixed and remove any other corrupted 4254 * ones. If it is not corrupted just process it */ 4255 rc = blob_get_xattr_value(blob, SNAPSHOT_PENDING_REMOVAL, &value, &len, true); 4256 if (rc != 0) { 4257 rc = blob_get_xattr_value(blob, SNAPSHOT_IN_PROGRESS, &value, &len, true); 4258 if (rc != 0) { 4259 /* Not corrupted - process it and continue with iterating through blobs */ 4260 if (ctx->iter_cb_fn) { 4261 ctx->iter_cb_fn(ctx->iter_cb_arg, blob, 0); 4262 } 4263 bs_blob_list_add(blob); 4264 spdk_bs_iter_next(ctx->bs, blob, bs_load_iter, ctx); 4265 return; 4266 } 4267 4268 } 4269 4270 assert(len == sizeof(spdk_blob_id)); 4271 4272 ctx->blob = blob; 4273 4274 /* Open clone to check if we are able to fix this blob or should we remove it */ 4275 spdk_bs_open_blob(ctx->bs, *(spdk_blob_id *)value, bs_examine_clone, ctx); 4276 return; 4277 } else if (bserrno == -ENOENT) { 4278 bserrno = 0; 4279 } else { 4280 /* 4281 * This case needs to be looked at further. Same problem 4282 * exists with applications that rely on explicit blob 4283 * iteration. We should just skip the blob that failed 4284 * to load and continue on to the next one. 4285 */ 4286 SPDK_ERRLOG("Error in iterating blobs\n"); 4287 } 4288 4289 ctx->iter_cb_fn = NULL; 4290 4291 spdk_free(ctx->super); 4292 bs_sequence_finish(ctx->seq, bserrno); 4293 free(ctx); 4294 } 4295 4296 static void bs_dump_read_md_page(spdk_bs_sequence_t *seq, void *cb_arg); 4297 4298 static void 4299 bs_load_complete(struct spdk_bs_load_ctx *ctx) 4300 { 4301 ctx->bs->used_clusters = spdk_bit_pool_create_from_array(ctx->used_clusters); 4302 if (ctx->dumping) { 4303 bs_dump_read_md_page(ctx->seq, ctx); 4304 return; 4305 } 4306 spdk_bs_iter_first(ctx->bs, bs_load_iter, ctx); 4307 } 4308 4309 static void 4310 bs_load_ctx_fail(struct spdk_bs_load_ctx *ctx, int bserrno) 4311 { 4312 assert(bserrno != 0); 4313 4314 spdk_free(ctx->mask); 4315 spdk_free(ctx->super); 4316 bs_sequence_finish(ctx->seq, bserrno); 4317 bs_free(ctx->bs); 4318 spdk_bit_array_free(&ctx->used_clusters); 4319 free(ctx); 4320 } 4321 4322 static void 4323 bs_load_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4324 { 4325 struct spdk_bs_load_ctx *ctx = cb_arg; 4326 int rc; 4327 4328 /* The type must be correct */ 4329 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_BLOBIDS); 4330 4331 /* The length of the mask (in bits) must not be greater than 4332 * the length of the buffer (converted to bits) */ 4333 assert(ctx->mask->length <= (ctx->super->used_blobid_mask_len * ctx->super->md_page_size * 8)); 4334 4335 /* The length of the mask must be exactly equal to the size 4336 * (in pages) of the metadata region */ 4337 assert(ctx->mask->length == ctx->super->md_len); 4338 4339 rc = spdk_bit_array_resize(&ctx->bs->used_blobids, ctx->mask->length); 4340 if (rc < 0) { 4341 bs_load_ctx_fail(ctx, rc); 4342 return; 4343 } 4344 4345 spdk_bit_array_load_mask(ctx->bs->used_blobids, ctx->mask->mask); 4346 spdk_free(ctx->mask); 4347 4348 bs_load_complete(ctx); 4349 } 4350 4351 static void 4352 bs_load_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4353 { 4354 struct spdk_bs_load_ctx *ctx = cb_arg; 4355 uint64_t lba, lba_count, mask_size; 4356 int rc; 4357 4358 if (bserrno != 0) { 4359 bs_load_ctx_fail(ctx, bserrno); 4360 return; 4361 } 4362 4363 /* The type must be correct */ 4364 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_CLUSTERS); 4365 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 4366 assert(ctx->mask->length <= (ctx->super->used_cluster_mask_len * sizeof( 4367 struct spdk_blob_md_page) * 8)); 4368 /* 4369 * The length of the mask must be equal to or larger than the total number of clusters. It may be 4370 * larger than the total number of clusters due to a failure spdk_bs_grow. 4371 */ 4372 assert(ctx->mask->length >= ctx->bs->total_clusters); 4373 if (ctx->mask->length > ctx->bs->total_clusters) { 4374 SPDK_WARNLOG("Shrink the used_custers mask length to total_clusters"); 4375 ctx->mask->length = ctx->bs->total_clusters; 4376 } 4377 4378 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->mask->length); 4379 if (rc < 0) { 4380 spdk_free(ctx->mask); 4381 bs_load_ctx_fail(ctx, rc); 4382 return; 4383 } 4384 4385 spdk_bit_array_load_mask(ctx->used_clusters, ctx->mask->mask); 4386 ctx->bs->num_free_clusters = spdk_bit_array_count_clear(ctx->used_clusters); 4387 assert(ctx->bs->num_free_clusters <= ctx->bs->total_clusters); 4388 4389 spdk_free(ctx->mask); 4390 4391 /* Read the used blobids mask */ 4392 mask_size = ctx->super->used_blobid_mask_len * ctx->super->md_page_size; 4393 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_NUMA_ID_ANY, 4394 SPDK_MALLOC_DMA); 4395 if (!ctx->mask) { 4396 bs_load_ctx_fail(ctx, -ENOMEM); 4397 return; 4398 } 4399 lba = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_start); 4400 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_len); 4401 bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 4402 bs_load_used_blobids_cpl, ctx); 4403 } 4404 4405 static void 4406 bs_load_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4407 { 4408 struct spdk_bs_load_ctx *ctx = cb_arg; 4409 uint64_t lba, lba_count, mask_size; 4410 int rc; 4411 4412 if (bserrno != 0) { 4413 bs_load_ctx_fail(ctx, bserrno); 4414 return; 4415 } 4416 4417 /* The type must be correct */ 4418 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_PAGES); 4419 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 4420 assert(ctx->mask->length <= (ctx->super->used_page_mask_len * ctx->super->md_page_size * 4421 8)); 4422 /* The length of the mask must be exactly equal to the size (in pages) of the metadata region */ 4423 if (ctx->mask->length != ctx->super->md_len) { 4424 SPDK_ERRLOG("mismatched md_len in used_pages mask: " 4425 "mask->length=%" PRIu32 " super->md_len=%" PRIu32 "\n", 4426 ctx->mask->length, ctx->super->md_len); 4427 assert(false); 4428 } 4429 4430 rc = spdk_bit_array_resize(&ctx->bs->used_md_pages, ctx->mask->length); 4431 if (rc < 0) { 4432 bs_load_ctx_fail(ctx, rc); 4433 return; 4434 } 4435 4436 spdk_bit_array_load_mask(ctx->bs->used_md_pages, ctx->mask->mask); 4437 spdk_free(ctx->mask); 4438 4439 /* Read the used clusters mask */ 4440 mask_size = ctx->super->used_cluster_mask_len * ctx->super->md_page_size; 4441 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_NUMA_ID_ANY, 4442 SPDK_MALLOC_DMA); 4443 if (!ctx->mask) { 4444 bs_load_ctx_fail(ctx, -ENOMEM); 4445 return; 4446 } 4447 lba = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 4448 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 4449 bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 4450 bs_load_used_clusters_cpl, ctx); 4451 } 4452 4453 static void 4454 bs_load_read_used_pages(struct spdk_bs_load_ctx *ctx) 4455 { 4456 uint64_t lba, lba_count, mask_size; 4457 4458 /* Read the used pages mask */ 4459 mask_size = ctx->super->used_page_mask_len * ctx->super->md_page_size; 4460 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 4461 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 4462 if (!ctx->mask) { 4463 bs_load_ctx_fail(ctx, -ENOMEM); 4464 return; 4465 } 4466 4467 lba = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_start); 4468 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_len); 4469 bs_sequence_read_dev(ctx->seq, ctx->mask, lba, lba_count, 4470 bs_load_used_pages_cpl, ctx); 4471 } 4472 4473 static int 4474 bs_load_replay_md_parse_page(struct spdk_bs_load_ctx *ctx, struct spdk_blob_md_page *page) 4475 { 4476 struct spdk_blob_store *bs = ctx->bs; 4477 struct spdk_blob_md_descriptor *desc; 4478 size_t cur_desc = 0; 4479 4480 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 4481 while (cur_desc < sizeof(page->descriptors)) { 4482 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 4483 if (desc->length == 0) { 4484 /* If padding and length are 0, this terminates the page */ 4485 break; 4486 } 4487 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE) { 4488 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 4489 unsigned int i, j; 4490 unsigned int cluster_count = 0; 4491 uint32_t cluster_idx; 4492 4493 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)desc; 4494 4495 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 4496 for (j = 0; j < desc_extent_rle->extents[i].length; j++) { 4497 cluster_idx = desc_extent_rle->extents[i].cluster_idx; 4498 /* 4499 * cluster_idx = 0 means an unallocated cluster - don't mark that 4500 * in the used cluster map. 4501 */ 4502 if (cluster_idx != 0) { 4503 SPDK_NOTICELOG("Recover: cluster %" PRIu32 "\n", cluster_idx + j); 4504 spdk_bit_array_set(ctx->used_clusters, cluster_idx + j); 4505 if (bs->num_free_clusters == 0) { 4506 return -ENOSPC; 4507 } 4508 bs->num_free_clusters--; 4509 } 4510 cluster_count++; 4511 } 4512 } 4513 if (cluster_count == 0) { 4514 return -EINVAL; 4515 } 4516 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 4517 struct spdk_blob_md_descriptor_extent_page *desc_extent; 4518 uint32_t i; 4519 uint32_t cluster_count = 0; 4520 uint32_t cluster_idx; 4521 size_t cluster_idx_length; 4522 4523 desc_extent = (struct spdk_blob_md_descriptor_extent_page *)desc; 4524 cluster_idx_length = desc_extent->length - sizeof(desc_extent->start_cluster_idx); 4525 4526 if (desc_extent->length <= sizeof(desc_extent->start_cluster_idx) || 4527 (cluster_idx_length % sizeof(desc_extent->cluster_idx[0]) != 0)) { 4528 return -EINVAL; 4529 } 4530 4531 for (i = 0; i < cluster_idx_length / sizeof(desc_extent->cluster_idx[0]); i++) { 4532 cluster_idx = desc_extent->cluster_idx[i]; 4533 /* 4534 * cluster_idx = 0 means an unallocated cluster - don't mark that 4535 * in the used cluster map. 4536 */ 4537 if (cluster_idx != 0) { 4538 if (cluster_idx < desc_extent->start_cluster_idx && 4539 cluster_idx >= desc_extent->start_cluster_idx + cluster_count) { 4540 return -EINVAL; 4541 } 4542 spdk_bit_array_set(ctx->used_clusters, cluster_idx); 4543 if (bs->num_free_clusters == 0) { 4544 return -ENOSPC; 4545 } 4546 bs->num_free_clusters--; 4547 } 4548 cluster_count++; 4549 } 4550 4551 if (cluster_count == 0) { 4552 return -EINVAL; 4553 } 4554 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 4555 /* Skip this item */ 4556 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 4557 /* Skip this item */ 4558 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 4559 /* Skip this item */ 4560 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE) { 4561 struct spdk_blob_md_descriptor_extent_table *desc_extent_table; 4562 uint32_t num_extent_pages = ctx->num_extent_pages; 4563 uint32_t i; 4564 size_t extent_pages_length; 4565 void *tmp; 4566 4567 desc_extent_table = (struct spdk_blob_md_descriptor_extent_table *)desc; 4568 extent_pages_length = desc_extent_table->length - sizeof(desc_extent_table->num_clusters); 4569 4570 if (desc_extent_table->length == 0 || 4571 (extent_pages_length % sizeof(desc_extent_table->extent_page[0]) != 0)) { 4572 return -EINVAL; 4573 } 4574 4575 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 4576 if (desc_extent_table->extent_page[i].page_idx != 0) { 4577 if (desc_extent_table->extent_page[i].num_pages != 1) { 4578 return -EINVAL; 4579 } 4580 num_extent_pages += 1; 4581 } 4582 } 4583 4584 if (num_extent_pages > 0) { 4585 tmp = realloc(ctx->extent_page_num, num_extent_pages * sizeof(uint32_t)); 4586 if (tmp == NULL) { 4587 return -ENOMEM; 4588 } 4589 ctx->extent_page_num = tmp; 4590 4591 /* Extent table entries contain md page numbers for extent pages. 4592 * Zeroes represent unallocated extent pages, those are run-length-encoded. 4593 */ 4594 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 4595 if (desc_extent_table->extent_page[i].page_idx != 0) { 4596 ctx->extent_page_num[ctx->num_extent_pages] = desc_extent_table->extent_page[i].page_idx; 4597 ctx->num_extent_pages += 1; 4598 } 4599 } 4600 } 4601 } else { 4602 /* Error */ 4603 return -EINVAL; 4604 } 4605 /* Advance to the next descriptor */ 4606 cur_desc += sizeof(*desc) + desc->length; 4607 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 4608 break; 4609 } 4610 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 4611 } 4612 return 0; 4613 } 4614 4615 static bool 4616 bs_load_cur_extent_page_valid(struct spdk_blob_md_page *page) 4617 { 4618 uint32_t crc; 4619 struct spdk_blob_md_descriptor *desc = (struct spdk_blob_md_descriptor *)page->descriptors; 4620 size_t desc_len; 4621 4622 crc = blob_md_page_calc_crc(page); 4623 if (crc != page->crc) { 4624 return false; 4625 } 4626 4627 /* Extent page should always be of sequence num 0. */ 4628 if (page->sequence_num != 0) { 4629 return false; 4630 } 4631 4632 /* Descriptor type must be EXTENT_PAGE. */ 4633 if (desc->type != SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 4634 return false; 4635 } 4636 4637 /* Descriptor length cannot exceed the page. */ 4638 desc_len = sizeof(*desc) + desc->length; 4639 if (desc_len > sizeof(page->descriptors)) { 4640 return false; 4641 } 4642 4643 /* It has to be the only descriptor in the page. */ 4644 if (desc_len + sizeof(*desc) <= sizeof(page->descriptors)) { 4645 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + desc_len); 4646 if (desc->length != 0) { 4647 return false; 4648 } 4649 } 4650 4651 return true; 4652 } 4653 4654 static bool 4655 bs_load_cur_md_page_valid(struct spdk_bs_load_ctx *ctx) 4656 { 4657 uint32_t crc; 4658 struct spdk_blob_md_page *page = ctx->page; 4659 4660 crc = blob_md_page_calc_crc(page); 4661 if (crc != page->crc) { 4662 return false; 4663 } 4664 4665 /* First page of a sequence should match the blobid. */ 4666 if (page->sequence_num == 0 && 4667 bs_page_to_blobid(ctx->cur_page) != page->id) { 4668 return false; 4669 } 4670 assert(bs_load_cur_extent_page_valid(page) == false); 4671 4672 return true; 4673 } 4674 4675 static void bs_load_replay_cur_md_page(struct spdk_bs_load_ctx *ctx); 4676 4677 static void 4678 bs_load_write_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4679 { 4680 struct spdk_bs_load_ctx *ctx = cb_arg; 4681 4682 spdk_free(ctx->mask); 4683 ctx->mask = NULL; 4684 4685 if (bserrno != 0) { 4686 bs_load_ctx_fail(ctx, bserrno); 4687 return; 4688 } 4689 4690 bs_load_complete(ctx); 4691 } 4692 4693 static void 4694 bs_load_write_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4695 { 4696 struct spdk_bs_load_ctx *ctx = cb_arg; 4697 4698 spdk_free(ctx->mask); 4699 ctx->mask = NULL; 4700 4701 if (bserrno != 0) { 4702 bs_load_ctx_fail(ctx, bserrno); 4703 return; 4704 } 4705 4706 bs_write_used_clusters(seq, ctx, bs_load_write_used_clusters_cpl); 4707 } 4708 4709 static void 4710 bs_load_write_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4711 { 4712 struct spdk_bs_load_ctx *ctx = cb_arg; 4713 4714 spdk_free(ctx->mask); 4715 ctx->mask = NULL; 4716 4717 if (bserrno != 0) { 4718 bs_load_ctx_fail(ctx, bserrno); 4719 return; 4720 } 4721 4722 bs_write_used_blobids(seq, ctx, bs_load_write_used_blobids_cpl); 4723 } 4724 4725 static void 4726 bs_load_write_used_md(struct spdk_bs_load_ctx *ctx) 4727 { 4728 bs_write_used_md(ctx->seq, ctx, bs_load_write_used_pages_cpl); 4729 } 4730 4731 static void 4732 bs_load_replay_md_chain_cpl(struct spdk_bs_load_ctx *ctx) 4733 { 4734 uint64_t num_md_clusters; 4735 uint64_t i; 4736 4737 ctx->in_page_chain = false; 4738 4739 do { 4740 ctx->page_index++; 4741 } while (spdk_bit_array_get(ctx->bs->used_md_pages, ctx->page_index) == true); 4742 4743 if (ctx->page_index < ctx->super->md_len) { 4744 ctx->cur_page = ctx->page_index; 4745 bs_load_replay_cur_md_page(ctx); 4746 } else { 4747 /* Claim all of the clusters used by the metadata */ 4748 num_md_clusters = spdk_divide_round_up( 4749 ctx->super->md_start + ctx->super->md_len, ctx->bs->pages_per_cluster); 4750 for (i = 0; i < num_md_clusters; i++) { 4751 spdk_bit_array_set(ctx->used_clusters, i); 4752 } 4753 ctx->bs->num_free_clusters -= num_md_clusters; 4754 spdk_free(ctx->page); 4755 bs_load_write_used_md(ctx); 4756 } 4757 } 4758 4759 static void 4760 bs_load_replay_extent_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4761 { 4762 struct spdk_bs_load_ctx *ctx = cb_arg; 4763 uint32_t page_num; 4764 uint64_t i; 4765 4766 if (bserrno != 0) { 4767 spdk_free(ctx->extent_pages); 4768 bs_load_ctx_fail(ctx, bserrno); 4769 return; 4770 } 4771 4772 for (i = 0; i < ctx->num_extent_pages; i++) { 4773 /* Extent pages are only read when present within in chain md. 4774 * Integrity of md is not right if that page was not a valid extent page. */ 4775 if (bs_load_cur_extent_page_valid(&ctx->extent_pages[i]) != true) { 4776 spdk_free(ctx->extent_pages); 4777 bs_load_ctx_fail(ctx, -EILSEQ); 4778 return; 4779 } 4780 4781 page_num = ctx->extent_page_num[i]; 4782 spdk_bit_array_set(ctx->bs->used_md_pages, page_num); 4783 if (bs_load_replay_md_parse_page(ctx, &ctx->extent_pages[i])) { 4784 spdk_free(ctx->extent_pages); 4785 bs_load_ctx_fail(ctx, -EILSEQ); 4786 return; 4787 } 4788 } 4789 4790 spdk_free(ctx->extent_pages); 4791 free(ctx->extent_page_num); 4792 ctx->extent_page_num = NULL; 4793 ctx->num_extent_pages = 0; 4794 4795 bs_load_replay_md_chain_cpl(ctx); 4796 } 4797 4798 static void 4799 bs_load_replay_extent_pages(struct spdk_bs_load_ctx *ctx) 4800 { 4801 spdk_bs_batch_t *batch; 4802 uint32_t page; 4803 uint64_t lba; 4804 uint64_t i; 4805 4806 ctx->extent_pages = spdk_zmalloc(ctx->super->md_page_size * ctx->num_extent_pages, 0, 4807 NULL, SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 4808 if (!ctx->extent_pages) { 4809 bs_load_ctx_fail(ctx, -ENOMEM); 4810 return; 4811 } 4812 4813 batch = bs_sequence_to_batch(ctx->seq, bs_load_replay_extent_page_cpl, ctx); 4814 4815 for (i = 0; i < ctx->num_extent_pages; i++) { 4816 page = ctx->extent_page_num[i]; 4817 assert(page < ctx->super->md_len); 4818 lba = bs_md_page_to_lba(ctx->bs, page); 4819 bs_batch_read_dev(batch, &ctx->extent_pages[i], lba, 4820 bs_byte_to_lba(ctx->bs, ctx->super->md_page_size)); 4821 } 4822 4823 bs_batch_close(batch); 4824 } 4825 4826 static void 4827 bs_load_replay_md_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4828 { 4829 struct spdk_bs_load_ctx *ctx = cb_arg; 4830 uint32_t page_num; 4831 struct spdk_blob_md_page *page; 4832 4833 if (bserrno != 0) { 4834 bs_load_ctx_fail(ctx, bserrno); 4835 return; 4836 } 4837 4838 page_num = ctx->cur_page; 4839 page = ctx->page; 4840 if (bs_load_cur_md_page_valid(ctx) == true) { 4841 if (page->sequence_num == 0 || ctx->in_page_chain == true) { 4842 spdk_spin_lock(&ctx->bs->used_lock); 4843 bs_claim_md_page(ctx->bs, page_num); 4844 spdk_spin_unlock(&ctx->bs->used_lock); 4845 if (page->sequence_num == 0) { 4846 SPDK_NOTICELOG("Recover: blob 0x%" PRIx32 "\n", page_num); 4847 spdk_bit_array_set(ctx->bs->used_blobids, page_num); 4848 } 4849 if (bs_load_replay_md_parse_page(ctx, page)) { 4850 bs_load_ctx_fail(ctx, -EILSEQ); 4851 return; 4852 } 4853 if (page->next != SPDK_INVALID_MD_PAGE) { 4854 ctx->in_page_chain = true; 4855 ctx->cur_page = page->next; 4856 bs_load_replay_cur_md_page(ctx); 4857 return; 4858 } 4859 if (ctx->num_extent_pages != 0) { 4860 bs_load_replay_extent_pages(ctx); 4861 return; 4862 } 4863 } 4864 } 4865 bs_load_replay_md_chain_cpl(ctx); 4866 } 4867 4868 static void 4869 bs_load_replay_cur_md_page(struct spdk_bs_load_ctx *ctx) 4870 { 4871 uint64_t lba; 4872 4873 assert(ctx->cur_page < ctx->super->md_len); 4874 lba = bs_md_page_to_lba(ctx->bs, ctx->cur_page); 4875 bs_sequence_read_dev(ctx->seq, ctx->page, lba, 4876 bs_byte_to_lba(ctx->bs, ctx->super->md_page_size), 4877 bs_load_replay_md_cpl, ctx); 4878 } 4879 4880 static void 4881 bs_load_replay_md(struct spdk_bs_load_ctx *ctx) 4882 { 4883 ctx->page_index = 0; 4884 ctx->cur_page = 0; 4885 ctx->page = spdk_zmalloc(ctx->bs->md_page_size, 0, 4886 NULL, SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 4887 if (!ctx->page) { 4888 bs_load_ctx_fail(ctx, -ENOMEM); 4889 return; 4890 } 4891 bs_load_replay_cur_md_page(ctx); 4892 } 4893 4894 static void 4895 bs_recover(struct spdk_bs_load_ctx *ctx) 4896 { 4897 int rc; 4898 4899 SPDK_NOTICELOG("Performing recovery on blobstore\n"); 4900 rc = spdk_bit_array_resize(&ctx->bs->used_md_pages, ctx->super->md_len); 4901 if (rc < 0) { 4902 bs_load_ctx_fail(ctx, -ENOMEM); 4903 return; 4904 } 4905 4906 rc = spdk_bit_array_resize(&ctx->bs->used_blobids, ctx->super->md_len); 4907 if (rc < 0) { 4908 bs_load_ctx_fail(ctx, -ENOMEM); 4909 return; 4910 } 4911 4912 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->bs->total_clusters); 4913 if (rc < 0) { 4914 bs_load_ctx_fail(ctx, -ENOMEM); 4915 return; 4916 } 4917 4918 rc = spdk_bit_array_resize(&ctx->bs->open_blobids, ctx->super->md_len); 4919 if (rc < 0) { 4920 bs_load_ctx_fail(ctx, -ENOMEM); 4921 return; 4922 } 4923 4924 ctx->bs->num_free_clusters = ctx->bs->total_clusters; 4925 bs_load_replay_md(ctx); 4926 } 4927 4928 static int 4929 bs_parse_super(struct spdk_bs_load_ctx *ctx) 4930 { 4931 int rc; 4932 4933 if (ctx->super->size == 0) { 4934 ctx->super->size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 4935 } 4936 4937 if (ctx->super->io_unit_size == 0) { 4938 ctx->super->io_unit_size = SPDK_BS_PAGE_SIZE; 4939 } 4940 if (ctx->super->md_page_size == 0) { 4941 ctx->super->md_page_size = SPDK_BS_PAGE_SIZE; 4942 } 4943 4944 ctx->bs->clean = 1; 4945 ctx->bs->cluster_sz = ctx->super->cluster_size; 4946 ctx->bs->total_clusters = ctx->super->size / ctx->super->cluster_size; 4947 ctx->bs->io_unit_size = ctx->super->io_unit_size; 4948 ctx->bs->md_page_size = ctx->super->md_page_size; 4949 bs_init_per_cluster_fields(ctx->bs); 4950 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->bs->total_clusters); 4951 if (rc < 0) { 4952 return -ENOMEM; 4953 } 4954 ctx->bs->md_start = ctx->super->md_start; 4955 ctx->bs->md_len = ctx->super->md_len; 4956 rc = spdk_bit_array_resize(&ctx->bs->open_blobids, ctx->bs->md_len); 4957 if (rc < 0) { 4958 return -ENOMEM; 4959 } 4960 4961 ctx->bs->total_data_clusters = ctx->bs->total_clusters - spdk_divide_round_up( 4962 ctx->bs->md_start + ctx->bs->md_len, ctx->bs->pages_per_cluster); 4963 ctx->bs->super_blob = ctx->super->super_blob; 4964 memcpy(&ctx->bs->bstype, &ctx->super->bstype, sizeof(ctx->super->bstype)); 4965 4966 return 0; 4967 } 4968 4969 static void 4970 bs_load_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4971 { 4972 struct spdk_bs_load_ctx *ctx = cb_arg; 4973 int rc; 4974 4975 rc = bs_super_validate(ctx->super, ctx->bs); 4976 if (rc != 0) { 4977 bs_load_ctx_fail(ctx, rc); 4978 return; 4979 } 4980 4981 rc = bs_parse_super(ctx); 4982 if (rc < 0) { 4983 bs_load_ctx_fail(ctx, rc); 4984 return; 4985 } 4986 4987 if (ctx->super->used_blobid_mask_len == 0 || ctx->super->clean == 0 || ctx->force_recover) { 4988 bs_recover(ctx); 4989 } else { 4990 bs_load_read_used_pages(ctx); 4991 } 4992 } 4993 4994 static inline int 4995 bs_opts_copy(struct spdk_bs_opts *src, struct spdk_bs_opts *dst) 4996 { 4997 4998 if (!src->opts_size) { 4999 SPDK_ERRLOG("opts_size should not be zero value\n"); 5000 return -1; 5001 } 5002 5003 #define FIELD_OK(field) \ 5004 offsetof(struct spdk_bs_opts, field) + sizeof(src->field) <= src->opts_size 5005 5006 #define SET_FIELD(field) \ 5007 if (FIELD_OK(field)) { \ 5008 dst->field = src->field; \ 5009 } \ 5010 5011 SET_FIELD(cluster_sz); 5012 SET_FIELD(num_md_pages); 5013 SET_FIELD(max_md_ops); 5014 SET_FIELD(max_channel_ops); 5015 SET_FIELD(clear_method); 5016 5017 if (FIELD_OK(bstype)) { 5018 memcpy(&dst->bstype, &src->bstype, sizeof(dst->bstype)); 5019 } 5020 SET_FIELD(md_page_size); 5021 SET_FIELD(iter_cb_fn); 5022 SET_FIELD(iter_cb_arg); 5023 SET_FIELD(force_recover); 5024 SET_FIELD(esnap_bs_dev_create); 5025 SET_FIELD(esnap_ctx); 5026 5027 dst->opts_size = src->opts_size; 5028 5029 /* You should not remove this statement, but need to update the assert statement 5030 * if you add a new field, and also add a corresponding SET_FIELD statement */ 5031 SPDK_STATIC_ASSERT(sizeof(struct spdk_bs_opts) == 88, "Incorrect size"); 5032 5033 #undef FIELD_OK 5034 #undef SET_FIELD 5035 5036 return 0; 5037 } 5038 5039 void 5040 spdk_bs_load(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 5041 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 5042 { 5043 struct spdk_blob_store *bs; 5044 struct spdk_bs_cpl cpl; 5045 struct spdk_bs_load_ctx *ctx; 5046 struct spdk_bs_opts opts = {}; 5047 int err; 5048 5049 SPDK_DEBUGLOG(blob, "Loading blobstore from dev %p\n", dev); 5050 5051 if ((dev->phys_blocklen % dev->blocklen) != 0) { 5052 SPDK_DEBUGLOG(blob, "unsupported dev block length of %d\n", dev->blocklen); 5053 dev->destroy(dev); 5054 cb_fn(cb_arg, NULL, -EINVAL); 5055 return; 5056 } 5057 5058 spdk_bs_opts_init(&opts, sizeof(opts)); 5059 if (o) { 5060 if (bs_opts_copy(o, &opts)) { 5061 dev->destroy(dev); 5062 cb_fn(cb_arg, NULL, -EINVAL); 5063 return; 5064 } 5065 } 5066 5067 if (opts.max_md_ops == 0 || opts.max_channel_ops == 0) { 5068 dev->destroy(dev); 5069 cb_fn(cb_arg, NULL, -EINVAL); 5070 return; 5071 } 5072 5073 err = bs_alloc(dev, &opts, &bs, &ctx); 5074 if (err) { 5075 dev->destroy(dev); 5076 cb_fn(cb_arg, NULL, err); 5077 return; 5078 } 5079 5080 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 5081 cpl.u.bs_handle.cb_fn = cb_fn; 5082 cpl.u.bs_handle.cb_arg = cb_arg; 5083 cpl.u.bs_handle.bs = bs; 5084 5085 ctx->seq = bs_sequence_start_bs(bs->md_channel, &cpl); 5086 if (!ctx->seq) { 5087 spdk_free(ctx->super); 5088 free(ctx); 5089 bs_free(bs); 5090 cb_fn(cb_arg, NULL, -ENOMEM); 5091 return; 5092 } 5093 5094 /* Read the super block */ 5095 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 5096 bs_byte_to_lba(bs, sizeof(*ctx->super)), 5097 bs_load_super_cpl, ctx); 5098 } 5099 5100 /* END spdk_bs_load */ 5101 5102 /* START spdk_bs_dump */ 5103 5104 static void 5105 bs_dump_finish(spdk_bs_sequence_t *seq, struct spdk_bs_load_ctx *ctx, int bserrno) 5106 { 5107 spdk_free(ctx->super); 5108 5109 /* 5110 * We need to defer calling bs_call_cpl() until after 5111 * dev destruction, so tuck these away for later use. 5112 */ 5113 ctx->bs->unload_err = bserrno; 5114 memcpy(&ctx->bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 5115 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 5116 5117 bs_sequence_finish(seq, 0); 5118 bs_free(ctx->bs); 5119 free(ctx); 5120 } 5121 5122 static void 5123 bs_dump_print_xattr(struct spdk_bs_load_ctx *ctx, struct spdk_blob_md_descriptor *desc) 5124 { 5125 struct spdk_blob_md_descriptor_xattr *desc_xattr; 5126 uint32_t i; 5127 const char *type; 5128 5129 desc_xattr = (struct spdk_blob_md_descriptor_xattr *)desc; 5130 5131 if (desc_xattr->length != 5132 sizeof(desc_xattr->name_length) + sizeof(desc_xattr->value_length) + 5133 desc_xattr->name_length + desc_xattr->value_length) { 5134 } 5135 5136 memcpy(ctx->xattr_name, desc_xattr->name, desc_xattr->name_length); 5137 ctx->xattr_name[desc_xattr->name_length] = '\0'; 5138 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 5139 type = "XATTR"; 5140 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 5141 type = "XATTR_INTERNAL"; 5142 } else { 5143 assert(false); 5144 type = "XATTR_?"; 5145 } 5146 fprintf(ctx->fp, "%s: name = \"%s\"\n", type, ctx->xattr_name); 5147 fprintf(ctx->fp, " value = \""); 5148 ctx->print_xattr_fn(ctx->fp, ctx->super->bstype.bstype, ctx->xattr_name, 5149 (void *)((uintptr_t)desc_xattr->name + desc_xattr->name_length), 5150 desc_xattr->value_length); 5151 fprintf(ctx->fp, "\"\n"); 5152 for (i = 0; i < desc_xattr->value_length; i++) { 5153 if (i % 16 == 0) { 5154 fprintf(ctx->fp, " "); 5155 } 5156 fprintf(ctx->fp, "%02" PRIx8 " ", *((uint8_t *)desc_xattr->name + desc_xattr->name_length + i)); 5157 if ((i + 1) % 16 == 0) { 5158 fprintf(ctx->fp, "\n"); 5159 } 5160 } 5161 if (i % 16 != 0) { 5162 fprintf(ctx->fp, "\n"); 5163 } 5164 } 5165 5166 struct type_flag_desc { 5167 uint64_t mask; 5168 uint64_t val; 5169 const char *name; 5170 }; 5171 5172 static void 5173 bs_dump_print_type_bits(struct spdk_bs_load_ctx *ctx, uint64_t flags, 5174 struct type_flag_desc *desc, size_t numflags) 5175 { 5176 uint64_t covered = 0; 5177 size_t i; 5178 5179 for (i = 0; i < numflags; i++) { 5180 if ((desc[i].mask & flags) != desc[i].val) { 5181 continue; 5182 } 5183 fprintf(ctx->fp, "\t\t 0x%016" PRIx64 " %s", desc[i].val, desc[i].name); 5184 if (desc[i].mask != desc[i].val) { 5185 fprintf(ctx->fp, " (mask 0x%" PRIx64 " value 0x%" PRIx64 ")", 5186 desc[i].mask, desc[i].val); 5187 } 5188 fprintf(ctx->fp, "\n"); 5189 covered |= desc[i].mask; 5190 } 5191 if ((flags & ~covered) != 0) { 5192 fprintf(ctx->fp, "\t\t 0x%016" PRIx64 " Unknown\n", flags & ~covered); 5193 } 5194 } 5195 5196 static void 5197 bs_dump_print_type_flags(struct spdk_bs_load_ctx *ctx, struct spdk_blob_md_descriptor *desc) 5198 { 5199 struct spdk_blob_md_descriptor_flags *type_desc; 5200 #define ADD_FLAG(f) { f, f, #f } 5201 #define ADD_MASK_VAL(m, v) { m, v, #v } 5202 static struct type_flag_desc invalid[] = { 5203 ADD_FLAG(SPDK_BLOB_THIN_PROV), 5204 ADD_FLAG(SPDK_BLOB_INTERNAL_XATTR), 5205 ADD_FLAG(SPDK_BLOB_EXTENT_TABLE), 5206 }; 5207 static struct type_flag_desc data_ro[] = { 5208 ADD_FLAG(SPDK_BLOB_READ_ONLY), 5209 }; 5210 static struct type_flag_desc md_ro[] = { 5211 ADD_MASK_VAL(SPDK_BLOB_MD_RO_FLAGS_MASK, BLOB_CLEAR_WITH_DEFAULT), 5212 ADD_MASK_VAL(SPDK_BLOB_MD_RO_FLAGS_MASK, BLOB_CLEAR_WITH_NONE), 5213 ADD_MASK_VAL(SPDK_BLOB_MD_RO_FLAGS_MASK, BLOB_CLEAR_WITH_UNMAP), 5214 ADD_MASK_VAL(SPDK_BLOB_MD_RO_FLAGS_MASK, BLOB_CLEAR_WITH_WRITE_ZEROES), 5215 }; 5216 #undef ADD_FLAG 5217 #undef ADD_MASK_VAL 5218 5219 type_desc = (struct spdk_blob_md_descriptor_flags *)desc; 5220 fprintf(ctx->fp, "Flags:\n"); 5221 fprintf(ctx->fp, "\tinvalid: 0x%016" PRIx64 "\n", type_desc->invalid_flags); 5222 bs_dump_print_type_bits(ctx, type_desc->invalid_flags, invalid, 5223 SPDK_COUNTOF(invalid)); 5224 fprintf(ctx->fp, "\tdata_ro: 0x%016" PRIx64 "\n", type_desc->data_ro_flags); 5225 bs_dump_print_type_bits(ctx, type_desc->data_ro_flags, data_ro, 5226 SPDK_COUNTOF(data_ro)); 5227 fprintf(ctx->fp, "\t md_ro: 0x%016" PRIx64 "\n", type_desc->md_ro_flags); 5228 bs_dump_print_type_bits(ctx, type_desc->md_ro_flags, md_ro, 5229 SPDK_COUNTOF(md_ro)); 5230 } 5231 5232 static void 5233 bs_dump_print_extent_table(struct spdk_bs_load_ctx *ctx, struct spdk_blob_md_descriptor *desc) 5234 { 5235 struct spdk_blob_md_descriptor_extent_table *et_desc; 5236 uint64_t num_extent_pages; 5237 uint32_t et_idx; 5238 5239 et_desc = (struct spdk_blob_md_descriptor_extent_table *)desc; 5240 num_extent_pages = (et_desc->length - sizeof(et_desc->num_clusters)) / 5241 sizeof(et_desc->extent_page[0]); 5242 5243 fprintf(ctx->fp, "Extent table:\n"); 5244 for (et_idx = 0; et_idx < num_extent_pages; et_idx++) { 5245 if (et_desc->extent_page[et_idx].page_idx == 0) { 5246 /* Zeroes represent unallocated extent pages. */ 5247 continue; 5248 } 5249 fprintf(ctx->fp, "\tExtent page: %5" PRIu32 " length %3" PRIu32 5250 " at LBA %" PRIu64 "\n", et_desc->extent_page[et_idx].page_idx, 5251 et_desc->extent_page[et_idx].num_pages, 5252 bs_md_page_to_lba(ctx->bs, et_desc->extent_page[et_idx].page_idx)); 5253 } 5254 } 5255 5256 static void 5257 bs_dump_print_md_page(struct spdk_bs_load_ctx *ctx) 5258 { 5259 uint32_t page_idx = ctx->cur_page; 5260 struct spdk_blob_md_page *page = ctx->page; 5261 struct spdk_blob_md_descriptor *desc; 5262 size_t cur_desc = 0; 5263 uint32_t crc; 5264 5265 fprintf(ctx->fp, "=========\n"); 5266 fprintf(ctx->fp, "Metadata Page Index: %" PRIu32 " (0x%" PRIx32 ")\n", page_idx, page_idx); 5267 fprintf(ctx->fp, "Start LBA: %" PRIu64 "\n", bs_md_page_to_lba(ctx->bs, page_idx)); 5268 fprintf(ctx->fp, "Blob ID: 0x%" PRIx64 "\n", page->id); 5269 fprintf(ctx->fp, "Sequence: %" PRIu32 "\n", page->sequence_num); 5270 if (page->next == SPDK_INVALID_MD_PAGE) { 5271 fprintf(ctx->fp, "Next: None\n"); 5272 } else { 5273 fprintf(ctx->fp, "Next: %" PRIu32 "\n", page->next); 5274 } 5275 fprintf(ctx->fp, "In used bit array%s:", ctx->super->clean ? "" : " (not clean: dubious)"); 5276 if (spdk_bit_array_get(ctx->bs->used_md_pages, page_idx)) { 5277 fprintf(ctx->fp, " md"); 5278 } 5279 if (spdk_bit_array_get(ctx->bs->used_blobids, page_idx)) { 5280 fprintf(ctx->fp, " blob"); 5281 } 5282 fprintf(ctx->fp, "\n"); 5283 5284 crc = blob_md_page_calc_crc(page); 5285 fprintf(ctx->fp, "CRC: 0x%" PRIx32 " (%s)\n", page->crc, crc == page->crc ? "OK" : "Mismatch"); 5286 5287 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 5288 while (cur_desc < sizeof(page->descriptors)) { 5289 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 5290 if (desc->length == 0) { 5291 /* If padding and length are 0, this terminates the page */ 5292 break; 5293 } 5294 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE) { 5295 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 5296 unsigned int i; 5297 5298 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)desc; 5299 5300 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 5301 if (desc_extent_rle->extents[i].cluster_idx != 0) { 5302 fprintf(ctx->fp, "Allocated Extent - Start: %" PRIu32, 5303 desc_extent_rle->extents[i].cluster_idx); 5304 } else { 5305 fprintf(ctx->fp, "Unallocated Extent - "); 5306 } 5307 fprintf(ctx->fp, " Length: %" PRIu32, desc_extent_rle->extents[i].length); 5308 fprintf(ctx->fp, "\n"); 5309 } 5310 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 5311 struct spdk_blob_md_descriptor_extent_page *desc_extent; 5312 unsigned int i; 5313 5314 desc_extent = (struct spdk_blob_md_descriptor_extent_page *)desc; 5315 5316 for (i = 0; i < desc_extent->length / sizeof(desc_extent->cluster_idx[0]); i++) { 5317 if (desc_extent->cluster_idx[i] != 0) { 5318 fprintf(ctx->fp, "Allocated Extent - Start: %" PRIu32, 5319 desc_extent->cluster_idx[i]); 5320 } else { 5321 fprintf(ctx->fp, "Unallocated Extent"); 5322 } 5323 fprintf(ctx->fp, "\n"); 5324 } 5325 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 5326 bs_dump_print_xattr(ctx, desc); 5327 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 5328 bs_dump_print_xattr(ctx, desc); 5329 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 5330 bs_dump_print_type_flags(ctx, desc); 5331 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE) { 5332 bs_dump_print_extent_table(ctx, desc); 5333 } else { 5334 /* Error */ 5335 fprintf(ctx->fp, "Unknown descriptor type %" PRIu8 "\n", desc->type); 5336 } 5337 /* Advance to the next descriptor */ 5338 cur_desc += sizeof(*desc) + desc->length; 5339 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 5340 break; 5341 } 5342 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 5343 } 5344 } 5345 5346 static void 5347 bs_dump_read_md_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5348 { 5349 struct spdk_bs_load_ctx *ctx = cb_arg; 5350 5351 if (bserrno != 0) { 5352 bs_dump_finish(seq, ctx, bserrno); 5353 return; 5354 } 5355 5356 if (ctx->page->id != 0) { 5357 bs_dump_print_md_page(ctx); 5358 } 5359 5360 ctx->cur_page++; 5361 5362 if (ctx->cur_page < ctx->super->md_len) { 5363 bs_dump_read_md_page(seq, ctx); 5364 } else { 5365 spdk_free(ctx->page); 5366 bs_dump_finish(seq, ctx, 0); 5367 } 5368 } 5369 5370 static void 5371 bs_dump_read_md_page(spdk_bs_sequence_t *seq, void *cb_arg) 5372 { 5373 struct spdk_bs_load_ctx *ctx = cb_arg; 5374 uint64_t lba; 5375 5376 assert(ctx->cur_page < ctx->super->md_len); 5377 lba = bs_page_to_lba(ctx->bs, ctx->super->md_start + ctx->cur_page); 5378 bs_sequence_read_dev(seq, ctx->page, lba, 5379 bs_byte_to_lba(ctx->bs, ctx->super->md_page_size), 5380 bs_dump_read_md_page_cpl, ctx); 5381 } 5382 5383 static void 5384 bs_dump_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5385 { 5386 struct spdk_bs_load_ctx *ctx = cb_arg; 5387 int rc; 5388 5389 fprintf(ctx->fp, "Signature: \"%.8s\" ", ctx->super->signature); 5390 if (memcmp(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 5391 sizeof(ctx->super->signature)) != 0) { 5392 fprintf(ctx->fp, "(Mismatch)\n"); 5393 bs_dump_finish(seq, ctx, bserrno); 5394 return; 5395 } else { 5396 fprintf(ctx->fp, "(OK)\n"); 5397 } 5398 fprintf(ctx->fp, "Version: %" PRIu32 "\n", ctx->super->version); 5399 fprintf(ctx->fp, "CRC: 0x%x (%s)\n", ctx->super->crc, 5400 (ctx->super->crc == blob_md_page_calc_crc(ctx->super)) ? "OK" : "Mismatch"); 5401 fprintf(ctx->fp, "Blobstore Type: %.*s\n", SPDK_BLOBSTORE_TYPE_LENGTH, ctx->super->bstype.bstype); 5402 fprintf(ctx->fp, "Cluster Size: %" PRIu32 "\n", ctx->super->cluster_size); 5403 fprintf(ctx->fp, "Super Blob ID: "); 5404 if (ctx->super->super_blob == SPDK_BLOBID_INVALID) { 5405 fprintf(ctx->fp, "(None)\n"); 5406 } else { 5407 fprintf(ctx->fp, "0x%" PRIx64 "\n", ctx->super->super_blob); 5408 } 5409 fprintf(ctx->fp, "Clean: %" PRIu32 "\n", ctx->super->clean); 5410 fprintf(ctx->fp, "Used Metadata Page Mask Start: %" PRIu32 "\n", ctx->super->used_page_mask_start); 5411 fprintf(ctx->fp, "Used Metadata Page Mask Length: %" PRIu32 "\n", ctx->super->used_page_mask_len); 5412 fprintf(ctx->fp, "Used Cluster Mask Start: %" PRIu32 "\n", ctx->super->used_cluster_mask_start); 5413 fprintf(ctx->fp, "Used Cluster Mask Length: %" PRIu32 "\n", ctx->super->used_cluster_mask_len); 5414 fprintf(ctx->fp, "Used Blob ID Mask Start: %" PRIu32 "\n", ctx->super->used_blobid_mask_start); 5415 fprintf(ctx->fp, "Used Blob ID Mask Length: %" PRIu32 "\n", ctx->super->used_blobid_mask_len); 5416 fprintf(ctx->fp, "Metadata Start: %" PRIu32 "\n", ctx->super->md_start); 5417 fprintf(ctx->fp, "Metadata Length: %" PRIu32 "\n", ctx->super->md_len); 5418 5419 ctx->cur_page = 0; 5420 ctx->page = spdk_zmalloc(ctx->super->md_page_size, 0, 5421 NULL, SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 5422 if (!ctx->page) { 5423 bs_dump_finish(seq, ctx, -ENOMEM); 5424 return; 5425 } 5426 5427 rc = bs_parse_super(ctx); 5428 if (rc < 0) { 5429 bs_load_ctx_fail(ctx, rc); 5430 return; 5431 } 5432 5433 bs_load_read_used_pages(ctx); 5434 } 5435 5436 void 5437 spdk_bs_dump(struct spdk_bs_dev *dev, FILE *fp, spdk_bs_dump_print_xattr print_xattr_fn, 5438 spdk_bs_op_complete cb_fn, void *cb_arg) 5439 { 5440 struct spdk_blob_store *bs; 5441 struct spdk_bs_cpl cpl; 5442 struct spdk_bs_load_ctx *ctx; 5443 struct spdk_bs_opts opts = {}; 5444 int err; 5445 5446 SPDK_DEBUGLOG(blob, "Dumping blobstore from dev %p\n", dev); 5447 5448 spdk_bs_opts_init(&opts, sizeof(opts)); 5449 5450 err = bs_alloc(dev, &opts, &bs, &ctx); 5451 if (err) { 5452 dev->destroy(dev); 5453 cb_fn(cb_arg, err); 5454 return; 5455 } 5456 5457 ctx->dumping = true; 5458 ctx->fp = fp; 5459 ctx->print_xattr_fn = print_xattr_fn; 5460 5461 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 5462 cpl.u.bs_basic.cb_fn = cb_fn; 5463 cpl.u.bs_basic.cb_arg = cb_arg; 5464 5465 ctx->seq = bs_sequence_start_bs(bs->md_channel, &cpl); 5466 if (!ctx->seq) { 5467 spdk_free(ctx->super); 5468 free(ctx); 5469 bs_free(bs); 5470 cb_fn(cb_arg, -ENOMEM); 5471 return; 5472 } 5473 5474 /* Read the super block */ 5475 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 5476 bs_byte_to_lba(bs, sizeof(*ctx->super)), 5477 bs_dump_super_cpl, ctx); 5478 } 5479 5480 /* END spdk_bs_dump */ 5481 5482 /* START spdk_bs_init */ 5483 5484 static void 5485 bs_init_persist_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5486 { 5487 struct spdk_bs_load_ctx *ctx = cb_arg; 5488 5489 ctx->bs->used_clusters = spdk_bit_pool_create_from_array(ctx->used_clusters); 5490 spdk_free(ctx->super); 5491 free(ctx); 5492 5493 bs_sequence_finish(seq, bserrno); 5494 } 5495 5496 static void 5497 bs_init_trim_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5498 { 5499 struct spdk_bs_load_ctx *ctx = cb_arg; 5500 5501 /* Write super block */ 5502 bs_sequence_write_dev(seq, ctx->super, bs_page_to_lba(ctx->bs, 0), 5503 bs_byte_to_lba(ctx->bs, sizeof(*ctx->super)), 5504 bs_init_persist_super_cpl, ctx); 5505 } 5506 5507 void 5508 spdk_bs_init(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 5509 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 5510 { 5511 struct spdk_bs_load_ctx *ctx; 5512 struct spdk_blob_store *bs; 5513 struct spdk_bs_cpl cpl; 5514 spdk_bs_sequence_t *seq; 5515 spdk_bs_batch_t *batch; 5516 uint64_t num_md_lba; 5517 uint64_t num_md_pages; 5518 uint64_t num_md_clusters; 5519 uint64_t max_used_cluster_mask_len; 5520 uint32_t i; 5521 struct spdk_bs_opts opts = {}; 5522 int rc; 5523 uint64_t lba, lba_count; 5524 5525 SPDK_DEBUGLOG(blob, "Initializing blobstore on dev %p\n", dev); 5526 if ((dev->phys_blocklen % dev->blocklen) != 0) { 5527 SPDK_ERRLOG("unsupported dev block length of %d\n", 5528 dev->blocklen); 5529 dev->destroy(dev); 5530 cb_fn(cb_arg, NULL, -EINVAL); 5531 return; 5532 } 5533 5534 spdk_bs_opts_init(&opts, sizeof(opts)); 5535 if (o) { 5536 if (bs_opts_copy(o, &opts)) { 5537 dev->destroy(dev); 5538 cb_fn(cb_arg, NULL, -EINVAL); 5539 return; 5540 } 5541 } 5542 5543 if (bs_opts_verify(&opts) != 0) { 5544 dev->destroy(dev); 5545 cb_fn(cb_arg, NULL, -EINVAL); 5546 return; 5547 } 5548 5549 rc = bs_alloc(dev, &opts, &bs, &ctx); 5550 if (rc) { 5551 dev->destroy(dev); 5552 cb_fn(cb_arg, NULL, rc); 5553 return; 5554 } 5555 5556 if (opts.num_md_pages == SPDK_BLOB_OPTS_NUM_MD_PAGES) { 5557 /* By default, allocate 1 page per cluster. 5558 * Technically, this over-allocates metadata 5559 * because more metadata will reduce the number 5560 * of usable clusters. This can be addressed with 5561 * more complex math in the future. 5562 */ 5563 bs->md_len = bs->total_clusters; 5564 } else { 5565 bs->md_len = opts.num_md_pages; 5566 } 5567 rc = spdk_bit_array_resize(&bs->used_md_pages, bs->md_len); 5568 if (rc < 0) { 5569 spdk_free(ctx->super); 5570 free(ctx); 5571 bs_free(bs); 5572 cb_fn(cb_arg, NULL, -ENOMEM); 5573 return; 5574 } 5575 5576 rc = spdk_bit_array_resize(&bs->used_blobids, bs->md_len); 5577 if (rc < 0) { 5578 spdk_free(ctx->super); 5579 free(ctx); 5580 bs_free(bs); 5581 cb_fn(cb_arg, NULL, -ENOMEM); 5582 return; 5583 } 5584 5585 rc = spdk_bit_array_resize(&bs->open_blobids, bs->md_len); 5586 if (rc < 0) { 5587 spdk_free(ctx->super); 5588 free(ctx); 5589 bs_free(bs); 5590 cb_fn(cb_arg, NULL, -ENOMEM); 5591 return; 5592 } 5593 5594 memcpy(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 5595 sizeof(ctx->super->signature)); 5596 ctx->super->version = SPDK_BS_VERSION; 5597 ctx->super->length = sizeof(*ctx->super); 5598 ctx->super->super_blob = bs->super_blob; 5599 ctx->super->clean = 0; 5600 ctx->super->cluster_size = bs->cluster_sz; 5601 ctx->super->io_unit_size = bs->io_unit_size; 5602 ctx->super->md_page_size = bs->md_page_size; 5603 memcpy(&ctx->super->bstype, &bs->bstype, sizeof(bs->bstype)); 5604 5605 /* Calculate how many pages the metadata consumes at the front 5606 * of the disk. 5607 */ 5608 5609 /* The super block uses 1 page */ 5610 num_md_pages = 1; 5611 5612 /* The used_md_pages mask requires 1 bit per metadata page, rounded 5613 * up to the nearest page, plus a header. 5614 */ 5615 ctx->super->used_page_mask_start = num_md_pages; 5616 ctx->super->used_page_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 5617 spdk_divide_round_up(bs->md_len, 8), 5618 ctx->super->md_page_size); 5619 num_md_pages += ctx->super->used_page_mask_len; 5620 5621 /* The used_clusters mask requires 1 bit per cluster, rounded 5622 * up to the nearest page, plus a header. 5623 */ 5624 ctx->super->used_cluster_mask_start = num_md_pages; 5625 ctx->super->used_cluster_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 5626 spdk_divide_round_up(bs->total_clusters, 8), 5627 ctx->super->md_page_size); 5628 /* The blobstore might be extended, then the used_cluster bitmap will need more space. 5629 * Here we calculate the max clusters we can support according to the 5630 * num_md_pages (bs->md_len). 5631 */ 5632 max_used_cluster_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 5633 spdk_divide_round_up(bs->md_len, 8), 5634 ctx->super->md_page_size); 5635 max_used_cluster_mask_len = spdk_max(max_used_cluster_mask_len, 5636 ctx->super->used_cluster_mask_len); 5637 num_md_pages += max_used_cluster_mask_len; 5638 5639 /* The used_blobids mask requires 1 bit per metadata page, rounded 5640 * up to the nearest page, plus a header. 5641 */ 5642 ctx->super->used_blobid_mask_start = num_md_pages; 5643 ctx->super->used_blobid_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 5644 spdk_divide_round_up(bs->md_len, 8), 5645 ctx->super->md_page_size); 5646 num_md_pages += ctx->super->used_blobid_mask_len; 5647 5648 /* The metadata region size was chosen above */ 5649 ctx->super->md_start = bs->md_start = num_md_pages; 5650 ctx->super->md_len = bs->md_len; 5651 num_md_pages += bs->md_len; 5652 5653 num_md_lba = bs_page_to_lba(bs, num_md_pages); 5654 5655 ctx->super->size = dev->blockcnt * dev->blocklen; 5656 5657 ctx->super->crc = blob_md_page_calc_crc(ctx->super); 5658 5659 num_md_clusters = spdk_divide_round_up(num_md_pages, bs->pages_per_cluster); 5660 if (num_md_clusters > bs->total_clusters) { 5661 SPDK_ERRLOG("Blobstore metadata cannot use more clusters than is available, " 5662 "please decrease number of pages reserved for metadata " 5663 "or increase cluster size.\n"); 5664 spdk_free(ctx->super); 5665 spdk_bit_array_free(&ctx->used_clusters); 5666 free(ctx); 5667 bs_free(bs); 5668 cb_fn(cb_arg, NULL, -ENOMEM); 5669 return; 5670 } 5671 /* Claim all of the clusters used by the metadata */ 5672 for (i = 0; i < num_md_clusters; i++) { 5673 spdk_bit_array_set(ctx->used_clusters, i); 5674 } 5675 5676 bs->num_free_clusters -= num_md_clusters; 5677 bs->total_data_clusters = bs->num_free_clusters; 5678 5679 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 5680 cpl.u.bs_handle.cb_fn = cb_fn; 5681 cpl.u.bs_handle.cb_arg = cb_arg; 5682 cpl.u.bs_handle.bs = bs; 5683 5684 seq = bs_sequence_start_bs(bs->md_channel, &cpl); 5685 if (!seq) { 5686 spdk_free(ctx->super); 5687 free(ctx); 5688 bs_free(bs); 5689 cb_fn(cb_arg, NULL, -ENOMEM); 5690 return; 5691 } 5692 5693 batch = bs_sequence_to_batch(seq, bs_init_trim_cpl, ctx); 5694 5695 /* Clear metadata space */ 5696 bs_batch_write_zeroes_dev(batch, 0, num_md_lba); 5697 5698 lba = num_md_lba; 5699 lba_count = ctx->bs->dev->blockcnt - lba; 5700 switch (opts.clear_method) { 5701 case BS_CLEAR_WITH_UNMAP: 5702 /* Trim data clusters */ 5703 bs_batch_unmap_dev(batch, lba, lba_count); 5704 break; 5705 case BS_CLEAR_WITH_WRITE_ZEROES: 5706 /* Write_zeroes to data clusters */ 5707 bs_batch_write_zeroes_dev(batch, lba, lba_count); 5708 break; 5709 case BS_CLEAR_WITH_NONE: 5710 default: 5711 break; 5712 } 5713 5714 bs_batch_close(batch); 5715 } 5716 5717 /* END spdk_bs_init */ 5718 5719 /* START spdk_bs_destroy */ 5720 5721 static void 5722 bs_destroy_trim_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5723 { 5724 struct spdk_bs_load_ctx *ctx = cb_arg; 5725 struct spdk_blob_store *bs = ctx->bs; 5726 5727 /* 5728 * We need to defer calling bs_call_cpl() until after 5729 * dev destruction, so tuck these away for later use. 5730 */ 5731 bs->unload_err = bserrno; 5732 memcpy(&bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 5733 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 5734 5735 bs_sequence_finish(seq, bserrno); 5736 5737 bs_free(bs); 5738 free(ctx); 5739 } 5740 5741 void 5742 spdk_bs_destroy(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, 5743 void *cb_arg) 5744 { 5745 struct spdk_bs_cpl cpl; 5746 spdk_bs_sequence_t *seq; 5747 struct spdk_bs_load_ctx *ctx; 5748 5749 SPDK_DEBUGLOG(blob, "Destroying blobstore\n"); 5750 5751 if (!RB_EMPTY(&bs->open_blobs)) { 5752 SPDK_ERRLOG("Blobstore still has open blobs\n"); 5753 cb_fn(cb_arg, -EBUSY); 5754 return; 5755 } 5756 5757 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 5758 cpl.u.bs_basic.cb_fn = cb_fn; 5759 cpl.u.bs_basic.cb_arg = cb_arg; 5760 5761 ctx = calloc(1, sizeof(*ctx)); 5762 if (!ctx) { 5763 cb_fn(cb_arg, -ENOMEM); 5764 return; 5765 } 5766 5767 ctx->bs = bs; 5768 5769 seq = bs_sequence_start_bs(bs->md_channel, &cpl); 5770 if (!seq) { 5771 free(ctx); 5772 cb_fn(cb_arg, -ENOMEM); 5773 return; 5774 } 5775 5776 /* Write zeroes to the super block */ 5777 bs_sequence_write_zeroes_dev(seq, 5778 bs_page_to_lba(bs, 0), 5779 bs_byte_to_lba(bs, sizeof(struct spdk_bs_super_block)), 5780 bs_destroy_trim_cpl, ctx); 5781 } 5782 5783 /* END spdk_bs_destroy */ 5784 5785 /* START spdk_bs_unload */ 5786 5787 static void 5788 bs_unload_finish(struct spdk_bs_load_ctx *ctx, int bserrno) 5789 { 5790 spdk_bs_sequence_t *seq = ctx->seq; 5791 5792 spdk_free(ctx->super); 5793 5794 /* 5795 * We need to defer calling bs_call_cpl() until after 5796 * dev destruction, so tuck these away for later use. 5797 */ 5798 ctx->bs->unload_err = bserrno; 5799 memcpy(&ctx->bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 5800 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 5801 5802 bs_sequence_finish(seq, bserrno); 5803 5804 bs_free(ctx->bs); 5805 free(ctx); 5806 } 5807 5808 static void 5809 bs_unload_write_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5810 { 5811 struct spdk_bs_load_ctx *ctx = cb_arg; 5812 5813 bs_unload_finish(ctx, bserrno); 5814 } 5815 5816 static void 5817 bs_unload_write_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5818 { 5819 struct spdk_bs_load_ctx *ctx = cb_arg; 5820 5821 spdk_free(ctx->mask); 5822 ctx->mask = NULL; 5823 5824 if (bserrno != 0) { 5825 bs_unload_finish(ctx, bserrno); 5826 return; 5827 } 5828 5829 ctx->super->clean = 1; 5830 5831 bs_write_super(seq, ctx->bs, ctx->super, bs_unload_write_super_cpl, ctx); 5832 } 5833 5834 static void 5835 bs_unload_write_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5836 { 5837 struct spdk_bs_load_ctx *ctx = cb_arg; 5838 5839 spdk_free(ctx->mask); 5840 ctx->mask = NULL; 5841 5842 if (bserrno != 0) { 5843 bs_unload_finish(ctx, bserrno); 5844 return; 5845 } 5846 5847 bs_write_used_clusters(seq, ctx, bs_unload_write_used_clusters_cpl); 5848 } 5849 5850 static void 5851 bs_unload_write_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5852 { 5853 struct spdk_bs_load_ctx *ctx = cb_arg; 5854 5855 spdk_free(ctx->mask); 5856 ctx->mask = NULL; 5857 5858 if (bserrno != 0) { 5859 bs_unload_finish(ctx, bserrno); 5860 return; 5861 } 5862 5863 bs_write_used_blobids(seq, ctx, bs_unload_write_used_blobids_cpl); 5864 } 5865 5866 static void 5867 bs_unload_read_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5868 { 5869 struct spdk_bs_load_ctx *ctx = cb_arg; 5870 int rc; 5871 5872 if (bserrno != 0) { 5873 bs_unload_finish(ctx, bserrno); 5874 return; 5875 } 5876 5877 rc = bs_super_validate(ctx->super, ctx->bs); 5878 if (rc != 0) { 5879 bs_unload_finish(ctx, rc); 5880 return; 5881 } 5882 5883 bs_write_used_md(seq, cb_arg, bs_unload_write_used_pages_cpl); 5884 } 5885 5886 void 5887 spdk_bs_unload(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, void *cb_arg) 5888 { 5889 struct spdk_bs_cpl cpl; 5890 struct spdk_bs_load_ctx *ctx; 5891 5892 SPDK_DEBUGLOG(blob, "Syncing blobstore\n"); 5893 5894 /* 5895 * If external snapshot channels are being destroyed while the blobstore is unloaded, the 5896 * unload is deferred until after the channel destruction completes. 5897 */ 5898 if (bs->esnap_channels_unloading != 0) { 5899 if (bs->esnap_unload_cb_fn != NULL) { 5900 SPDK_ERRLOG("Blobstore unload in progress\n"); 5901 cb_fn(cb_arg, -EBUSY); 5902 return; 5903 } 5904 SPDK_DEBUGLOG(blob_esnap, "Blobstore unload deferred: %" PRIu32 5905 " esnap clones are unloading\n", bs->esnap_channels_unloading); 5906 bs->esnap_unload_cb_fn = cb_fn; 5907 bs->esnap_unload_cb_arg = cb_arg; 5908 return; 5909 } 5910 if (bs->esnap_unload_cb_fn != NULL) { 5911 SPDK_DEBUGLOG(blob_esnap, "Blobstore deferred unload progressing\n"); 5912 assert(bs->esnap_unload_cb_fn == cb_fn); 5913 assert(bs->esnap_unload_cb_arg == cb_arg); 5914 bs->esnap_unload_cb_fn = NULL; 5915 bs->esnap_unload_cb_arg = NULL; 5916 } 5917 5918 if (!RB_EMPTY(&bs->open_blobs)) { 5919 SPDK_ERRLOG("Blobstore still has open blobs\n"); 5920 cb_fn(cb_arg, -EBUSY); 5921 return; 5922 } 5923 5924 ctx = calloc(1, sizeof(*ctx)); 5925 if (!ctx) { 5926 cb_fn(cb_arg, -ENOMEM); 5927 return; 5928 } 5929 5930 ctx->bs = bs; 5931 5932 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 5933 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 5934 if (!ctx->super) { 5935 free(ctx); 5936 cb_fn(cb_arg, -ENOMEM); 5937 return; 5938 } 5939 5940 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 5941 cpl.u.bs_basic.cb_fn = cb_fn; 5942 cpl.u.bs_basic.cb_arg = cb_arg; 5943 5944 ctx->seq = bs_sequence_start_bs(bs->md_channel, &cpl); 5945 if (!ctx->seq) { 5946 spdk_free(ctx->super); 5947 free(ctx); 5948 cb_fn(cb_arg, -ENOMEM); 5949 return; 5950 } 5951 5952 /* Read super block */ 5953 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 5954 bs_byte_to_lba(bs, sizeof(*ctx->super)), 5955 bs_unload_read_super_cpl, ctx); 5956 } 5957 5958 /* END spdk_bs_unload */ 5959 5960 /* START spdk_bs_set_super */ 5961 5962 struct spdk_bs_set_super_ctx { 5963 struct spdk_blob_store *bs; 5964 struct spdk_bs_super_block *super; 5965 }; 5966 5967 static void 5968 bs_set_super_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5969 { 5970 struct spdk_bs_set_super_ctx *ctx = cb_arg; 5971 5972 if (bserrno != 0) { 5973 SPDK_ERRLOG("Unable to write to super block of blobstore\n"); 5974 } 5975 5976 spdk_free(ctx->super); 5977 5978 bs_sequence_finish(seq, bserrno); 5979 5980 free(ctx); 5981 } 5982 5983 static void 5984 bs_set_super_read_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5985 { 5986 struct spdk_bs_set_super_ctx *ctx = cb_arg; 5987 int rc; 5988 5989 if (bserrno != 0) { 5990 SPDK_ERRLOG("Unable to read super block of blobstore\n"); 5991 spdk_free(ctx->super); 5992 bs_sequence_finish(seq, bserrno); 5993 free(ctx); 5994 return; 5995 } 5996 5997 rc = bs_super_validate(ctx->super, ctx->bs); 5998 if (rc != 0) { 5999 SPDK_ERRLOG("Not a valid super block\n"); 6000 spdk_free(ctx->super); 6001 bs_sequence_finish(seq, rc); 6002 free(ctx); 6003 return; 6004 } 6005 6006 bs_write_super(seq, ctx->bs, ctx->super, bs_set_super_write_cpl, ctx); 6007 } 6008 6009 void 6010 spdk_bs_set_super(struct spdk_blob_store *bs, spdk_blob_id blobid, 6011 spdk_bs_op_complete cb_fn, void *cb_arg) 6012 { 6013 struct spdk_bs_cpl cpl; 6014 spdk_bs_sequence_t *seq; 6015 struct spdk_bs_set_super_ctx *ctx; 6016 6017 SPDK_DEBUGLOG(blob, "Setting super blob id on blobstore\n"); 6018 6019 ctx = calloc(1, sizeof(*ctx)); 6020 if (!ctx) { 6021 cb_fn(cb_arg, -ENOMEM); 6022 return; 6023 } 6024 6025 ctx->bs = bs; 6026 6027 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 6028 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 6029 if (!ctx->super) { 6030 free(ctx); 6031 cb_fn(cb_arg, -ENOMEM); 6032 return; 6033 } 6034 6035 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 6036 cpl.u.bs_basic.cb_fn = cb_fn; 6037 cpl.u.bs_basic.cb_arg = cb_arg; 6038 6039 seq = bs_sequence_start_bs(bs->md_channel, &cpl); 6040 if (!seq) { 6041 spdk_free(ctx->super); 6042 free(ctx); 6043 cb_fn(cb_arg, -ENOMEM); 6044 return; 6045 } 6046 6047 bs->super_blob = blobid; 6048 6049 /* Read super block */ 6050 bs_sequence_read_dev(seq, ctx->super, bs_page_to_lba(bs, 0), 6051 bs_byte_to_lba(bs, sizeof(*ctx->super)), 6052 bs_set_super_read_cpl, ctx); 6053 } 6054 6055 /* END spdk_bs_set_super */ 6056 6057 void 6058 spdk_bs_get_super(struct spdk_blob_store *bs, 6059 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6060 { 6061 if (bs->super_blob == SPDK_BLOBID_INVALID) { 6062 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOENT); 6063 } else { 6064 cb_fn(cb_arg, bs->super_blob, 0); 6065 } 6066 } 6067 6068 uint64_t 6069 spdk_bs_get_cluster_size(struct spdk_blob_store *bs) 6070 { 6071 return bs->cluster_sz; 6072 } 6073 6074 uint64_t 6075 spdk_bs_get_page_size(struct spdk_blob_store *bs) 6076 { 6077 return bs->md_page_size; 6078 } 6079 6080 uint64_t 6081 spdk_bs_get_io_unit_size(struct spdk_blob_store *bs) 6082 { 6083 return bs->io_unit_size; 6084 } 6085 6086 uint64_t 6087 spdk_bs_free_cluster_count(struct spdk_blob_store *bs) 6088 { 6089 return bs->num_free_clusters; 6090 } 6091 6092 uint64_t 6093 spdk_bs_total_data_cluster_count(struct spdk_blob_store *bs) 6094 { 6095 return bs->total_data_clusters; 6096 } 6097 6098 static int 6099 bs_register_md_thread(struct spdk_blob_store *bs) 6100 { 6101 bs->md_channel = spdk_get_io_channel(bs); 6102 if (!bs->md_channel) { 6103 SPDK_ERRLOG("Failed to get IO channel.\n"); 6104 return -1; 6105 } 6106 6107 return 0; 6108 } 6109 6110 static int 6111 bs_unregister_md_thread(struct spdk_blob_store *bs) 6112 { 6113 spdk_put_io_channel(bs->md_channel); 6114 6115 return 0; 6116 } 6117 6118 spdk_blob_id 6119 spdk_blob_get_id(struct spdk_blob *blob) 6120 { 6121 assert(blob != NULL); 6122 6123 return blob->id; 6124 } 6125 6126 uint64_t 6127 spdk_blob_get_num_io_units(struct spdk_blob *blob) 6128 { 6129 assert(blob != NULL); 6130 6131 return bs_cluster_to_io_unit(blob->bs, blob->active.num_clusters); 6132 } 6133 6134 uint64_t 6135 spdk_blob_get_num_clusters(struct spdk_blob *blob) 6136 { 6137 assert(blob != NULL); 6138 6139 return blob->active.num_clusters; 6140 } 6141 6142 uint64_t 6143 spdk_blob_get_num_allocated_clusters(struct spdk_blob *blob) 6144 { 6145 assert(blob != NULL); 6146 6147 return blob->active.num_allocated_clusters; 6148 } 6149 6150 static uint64_t 6151 blob_find_io_unit(struct spdk_blob *blob, uint64_t offset, bool is_allocated) 6152 { 6153 uint64_t blob_io_unit_num = spdk_blob_get_num_io_units(blob); 6154 6155 while (offset < blob_io_unit_num) { 6156 if (bs_io_unit_is_allocated(blob, offset) == is_allocated) { 6157 return offset; 6158 } 6159 6160 offset += bs_num_io_units_to_cluster_boundary(blob, offset); 6161 } 6162 6163 return UINT64_MAX; 6164 } 6165 6166 uint64_t 6167 spdk_blob_get_next_allocated_io_unit(struct spdk_blob *blob, uint64_t offset) 6168 { 6169 return blob_find_io_unit(blob, offset, true); 6170 } 6171 6172 uint64_t 6173 spdk_blob_get_next_unallocated_io_unit(struct spdk_blob *blob, uint64_t offset) 6174 { 6175 return blob_find_io_unit(blob, offset, false); 6176 } 6177 6178 /* START spdk_bs_create_blob */ 6179 6180 static void 6181 bs_create_blob_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 6182 { 6183 struct spdk_blob *blob = cb_arg; 6184 uint32_t page_idx = bs_blobid_to_page(blob->id); 6185 6186 if (bserrno != 0) { 6187 spdk_spin_lock(&blob->bs->used_lock); 6188 spdk_bit_array_clear(blob->bs->used_blobids, page_idx); 6189 bs_release_md_page(blob->bs, page_idx); 6190 spdk_spin_unlock(&blob->bs->used_lock); 6191 } 6192 6193 blob_free(blob); 6194 6195 bs_sequence_finish(seq, bserrno); 6196 } 6197 6198 static int 6199 blob_set_xattrs(struct spdk_blob *blob, const struct spdk_blob_xattr_opts *xattrs, 6200 bool internal) 6201 { 6202 uint64_t i; 6203 size_t value_len = 0; 6204 int rc; 6205 const void *value = NULL; 6206 if (xattrs->count > 0 && xattrs->get_value == NULL) { 6207 return -EINVAL; 6208 } 6209 for (i = 0; i < xattrs->count; i++) { 6210 xattrs->get_value(xattrs->ctx, xattrs->names[i], &value, &value_len); 6211 if (value == NULL || value_len == 0) { 6212 return -EINVAL; 6213 } 6214 rc = blob_set_xattr(blob, xattrs->names[i], value, value_len, internal); 6215 if (rc < 0) { 6216 return rc; 6217 } 6218 } 6219 return 0; 6220 } 6221 6222 static void 6223 blob_opts_copy(const struct spdk_blob_opts *src, struct spdk_blob_opts *dst) 6224 { 6225 #define FIELD_OK(field) \ 6226 offsetof(struct spdk_blob_opts, field) + sizeof(src->field) <= src->opts_size 6227 6228 #define SET_FIELD(field) \ 6229 if (FIELD_OK(field)) { \ 6230 dst->field = src->field; \ 6231 } \ 6232 6233 SET_FIELD(num_clusters); 6234 SET_FIELD(thin_provision); 6235 SET_FIELD(clear_method); 6236 6237 if (FIELD_OK(xattrs)) { 6238 memcpy(&dst->xattrs, &src->xattrs, sizeof(src->xattrs)); 6239 } 6240 6241 SET_FIELD(use_extent_table); 6242 SET_FIELD(esnap_id); 6243 SET_FIELD(esnap_id_len); 6244 6245 dst->opts_size = src->opts_size; 6246 6247 /* You should not remove this statement, but need to update the assert statement 6248 * if you add a new field, and also add a corresponding SET_FIELD statement */ 6249 SPDK_STATIC_ASSERT(sizeof(struct spdk_blob_opts) == 80, "Incorrect size"); 6250 6251 #undef FIELD_OK 6252 #undef SET_FIELD 6253 } 6254 6255 static void 6256 bs_create_blob(struct spdk_blob_store *bs, 6257 const struct spdk_blob_opts *opts, 6258 const struct spdk_blob_xattr_opts *internal_xattrs, 6259 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6260 { 6261 struct spdk_blob *blob; 6262 uint32_t page_idx; 6263 struct spdk_bs_cpl cpl; 6264 struct spdk_blob_opts opts_local; 6265 struct spdk_blob_xattr_opts internal_xattrs_default; 6266 spdk_bs_sequence_t *seq; 6267 spdk_blob_id id; 6268 int rc; 6269 6270 assert(spdk_get_thread() == bs->md_thread); 6271 6272 spdk_spin_lock(&bs->used_lock); 6273 page_idx = spdk_bit_array_find_first_clear(bs->used_md_pages, 0); 6274 if (page_idx == UINT32_MAX) { 6275 spdk_spin_unlock(&bs->used_lock); 6276 cb_fn(cb_arg, 0, -ENOMEM); 6277 return; 6278 } 6279 spdk_bit_array_set(bs->used_blobids, page_idx); 6280 bs_claim_md_page(bs, page_idx); 6281 spdk_spin_unlock(&bs->used_lock); 6282 6283 id = bs_page_to_blobid(page_idx); 6284 6285 SPDK_DEBUGLOG(blob, "Creating blob with id 0x%" PRIx64 " at page %u\n", id, page_idx); 6286 6287 spdk_blob_opts_init(&opts_local, sizeof(opts_local)); 6288 if (opts) { 6289 blob_opts_copy(opts, &opts_local); 6290 } 6291 6292 blob = blob_alloc(bs, id); 6293 if (!blob) { 6294 rc = -ENOMEM; 6295 goto error; 6296 } 6297 6298 blob->use_extent_table = opts_local.use_extent_table; 6299 if (blob->use_extent_table) { 6300 blob->invalid_flags |= SPDK_BLOB_EXTENT_TABLE; 6301 } 6302 6303 if (!internal_xattrs) { 6304 blob_xattrs_init(&internal_xattrs_default); 6305 internal_xattrs = &internal_xattrs_default; 6306 } 6307 6308 rc = blob_set_xattrs(blob, &opts_local.xattrs, false); 6309 if (rc < 0) { 6310 goto error; 6311 } 6312 6313 rc = blob_set_xattrs(blob, internal_xattrs, true); 6314 if (rc < 0) { 6315 goto error; 6316 } 6317 6318 if (opts_local.thin_provision) { 6319 blob_set_thin_provision(blob); 6320 } 6321 6322 blob_set_clear_method(blob, opts_local.clear_method); 6323 6324 if (opts_local.esnap_id != NULL) { 6325 if (opts_local.esnap_id_len > UINT16_MAX) { 6326 SPDK_ERRLOG("esnap id length %" PRIu64 "is too long\n", 6327 opts_local.esnap_id_len); 6328 rc = -EINVAL; 6329 goto error; 6330 6331 } 6332 blob_set_thin_provision(blob); 6333 blob->invalid_flags |= SPDK_BLOB_EXTERNAL_SNAPSHOT; 6334 rc = blob_set_xattr(blob, BLOB_EXTERNAL_SNAPSHOT_ID, 6335 opts_local.esnap_id, opts_local.esnap_id_len, true); 6336 if (rc != 0) { 6337 goto error; 6338 } 6339 } 6340 6341 rc = blob_resize(blob, opts_local.num_clusters); 6342 if (rc < 0) { 6343 goto error; 6344 } 6345 cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 6346 cpl.u.blobid.cb_fn = cb_fn; 6347 cpl.u.blobid.cb_arg = cb_arg; 6348 cpl.u.blobid.blobid = blob->id; 6349 6350 seq = bs_sequence_start_bs(bs->md_channel, &cpl); 6351 if (!seq) { 6352 rc = -ENOMEM; 6353 goto error; 6354 } 6355 6356 blob_persist(seq, blob, bs_create_blob_cpl, blob); 6357 return; 6358 6359 error: 6360 SPDK_ERRLOG("Failed to create blob: %s, size in clusters/size: %lu (clusters)\n", 6361 spdk_strerror(rc), opts_local.num_clusters); 6362 if (blob != NULL) { 6363 blob_free(blob); 6364 } 6365 spdk_spin_lock(&bs->used_lock); 6366 spdk_bit_array_clear(bs->used_blobids, page_idx); 6367 bs_release_md_page(bs, page_idx); 6368 spdk_spin_unlock(&bs->used_lock); 6369 cb_fn(cb_arg, 0, rc); 6370 } 6371 6372 void 6373 spdk_bs_create_blob(struct spdk_blob_store *bs, 6374 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6375 { 6376 bs_create_blob(bs, NULL, NULL, cb_fn, cb_arg); 6377 } 6378 6379 void 6380 spdk_bs_create_blob_ext(struct spdk_blob_store *bs, const struct spdk_blob_opts *opts, 6381 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6382 { 6383 bs_create_blob(bs, opts, NULL, cb_fn, cb_arg); 6384 } 6385 6386 /* END spdk_bs_create_blob */ 6387 6388 /* START blob_cleanup */ 6389 6390 struct spdk_clone_snapshot_ctx { 6391 struct spdk_bs_cpl cpl; 6392 int bserrno; 6393 bool frozen; 6394 6395 struct spdk_io_channel *channel; 6396 6397 /* Current cluster for inflate operation */ 6398 uint64_t cluster; 6399 6400 /* For inflation force allocation of all unallocated clusters and remove 6401 * thin-provisioning. Otherwise only decouple parent and keep clone thin. */ 6402 bool allocate_all; 6403 6404 struct { 6405 spdk_blob_id id; 6406 struct spdk_blob *blob; 6407 bool md_ro; 6408 } original; 6409 struct { 6410 spdk_blob_id id; 6411 struct spdk_blob *blob; 6412 } new; 6413 6414 /* xattrs specified for snapshot/clones only. They have no impact on 6415 * the original blobs xattrs. */ 6416 const struct spdk_blob_xattr_opts *xattrs; 6417 }; 6418 6419 static void 6420 bs_clone_snapshot_cleanup_finish(void *cb_arg, int bserrno) 6421 { 6422 struct spdk_clone_snapshot_ctx *ctx = cb_arg; 6423 struct spdk_bs_cpl *cpl = &ctx->cpl; 6424 6425 if (bserrno != 0) { 6426 if (ctx->bserrno != 0) { 6427 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 6428 } else { 6429 ctx->bserrno = bserrno; 6430 } 6431 } 6432 6433 switch (cpl->type) { 6434 case SPDK_BS_CPL_TYPE_BLOBID: 6435 cpl->u.blobid.cb_fn(cpl->u.blobid.cb_arg, cpl->u.blobid.blobid, ctx->bserrno); 6436 break; 6437 case SPDK_BS_CPL_TYPE_BLOB_BASIC: 6438 cpl->u.blob_basic.cb_fn(cpl->u.blob_basic.cb_arg, ctx->bserrno); 6439 break; 6440 default: 6441 SPDK_UNREACHABLE(); 6442 break; 6443 } 6444 6445 free(ctx); 6446 } 6447 6448 static void 6449 bs_snapshot_unfreeze_cpl(void *cb_arg, int bserrno) 6450 { 6451 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6452 struct spdk_blob *origblob = ctx->original.blob; 6453 6454 if (bserrno != 0) { 6455 if (ctx->bserrno != 0) { 6456 SPDK_ERRLOG("Unfreeze error %d\n", bserrno); 6457 } else { 6458 ctx->bserrno = bserrno; 6459 } 6460 } 6461 6462 ctx->original.id = origblob->id; 6463 origblob->locked_operation_in_progress = false; 6464 6465 /* Revert md_ro to original state */ 6466 origblob->md_ro = ctx->original.md_ro; 6467 6468 spdk_blob_close(origblob, bs_clone_snapshot_cleanup_finish, ctx); 6469 } 6470 6471 static void 6472 bs_clone_snapshot_origblob_cleanup(void *cb_arg, int bserrno) 6473 { 6474 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6475 struct spdk_blob *origblob = ctx->original.blob; 6476 6477 if (bserrno != 0) { 6478 if (ctx->bserrno != 0) { 6479 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 6480 } else { 6481 ctx->bserrno = bserrno; 6482 } 6483 } 6484 6485 if (ctx->frozen) { 6486 /* Unfreeze any outstanding I/O */ 6487 blob_unfreeze_io(origblob, bs_snapshot_unfreeze_cpl, ctx); 6488 } else { 6489 bs_snapshot_unfreeze_cpl(ctx, 0); 6490 } 6491 6492 } 6493 6494 static void 6495 bs_clone_snapshot_newblob_cleanup(struct spdk_clone_snapshot_ctx *ctx, int bserrno) 6496 { 6497 struct spdk_blob *newblob = ctx->new.blob; 6498 6499 if (bserrno != 0) { 6500 if (ctx->bserrno != 0) { 6501 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 6502 } else { 6503 ctx->bserrno = bserrno; 6504 } 6505 } 6506 6507 ctx->new.id = newblob->id; 6508 spdk_blob_close(newblob, bs_clone_snapshot_origblob_cleanup, ctx); 6509 } 6510 6511 /* END blob_cleanup */ 6512 6513 /* START spdk_bs_create_snapshot */ 6514 6515 static void 6516 bs_snapshot_swap_cluster_maps(struct spdk_blob *blob1, struct spdk_blob *blob2) 6517 { 6518 uint64_t *cluster_temp; 6519 uint64_t num_allocated_clusters_temp; 6520 uint32_t *extent_page_temp; 6521 6522 cluster_temp = blob1->active.clusters; 6523 blob1->active.clusters = blob2->active.clusters; 6524 blob2->active.clusters = cluster_temp; 6525 6526 num_allocated_clusters_temp = blob1->active.num_allocated_clusters; 6527 blob1->active.num_allocated_clusters = blob2->active.num_allocated_clusters; 6528 blob2->active.num_allocated_clusters = num_allocated_clusters_temp; 6529 6530 extent_page_temp = blob1->active.extent_pages; 6531 blob1->active.extent_pages = blob2->active.extent_pages; 6532 blob2->active.extent_pages = extent_page_temp; 6533 } 6534 6535 /* Copies an internal xattr */ 6536 static int 6537 bs_snapshot_copy_xattr(struct spdk_blob *toblob, struct spdk_blob *fromblob, const char *name) 6538 { 6539 const void *val = NULL; 6540 size_t len; 6541 int bserrno; 6542 6543 bserrno = blob_get_xattr_value(fromblob, name, &val, &len, true); 6544 if (bserrno != 0) { 6545 SPDK_ERRLOG("blob 0x%" PRIx64 " missing %s XATTR\n", fromblob->id, name); 6546 return bserrno; 6547 } 6548 6549 bserrno = blob_set_xattr(toblob, name, val, len, true); 6550 if (bserrno != 0) { 6551 SPDK_ERRLOG("could not set %s XATTR on blob 0x%" PRIx64 "\n", 6552 name, toblob->id); 6553 return bserrno; 6554 } 6555 return 0; 6556 } 6557 6558 static void 6559 bs_snapshot_origblob_sync_cpl(void *cb_arg, int bserrno) 6560 { 6561 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6562 struct spdk_blob *origblob = ctx->original.blob; 6563 struct spdk_blob *newblob = ctx->new.blob; 6564 6565 if (bserrno != 0) { 6566 bs_snapshot_swap_cluster_maps(newblob, origblob); 6567 if (blob_is_esnap_clone(newblob)) { 6568 bs_snapshot_copy_xattr(origblob, newblob, BLOB_EXTERNAL_SNAPSHOT_ID); 6569 origblob->invalid_flags |= SPDK_BLOB_EXTERNAL_SNAPSHOT; 6570 } 6571 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6572 return; 6573 } 6574 6575 /* Remove metadata descriptor SNAPSHOT_IN_PROGRESS */ 6576 bserrno = blob_remove_xattr(newblob, SNAPSHOT_IN_PROGRESS, true); 6577 if (bserrno != 0) { 6578 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6579 return; 6580 } 6581 6582 bs_blob_list_add(ctx->original.blob); 6583 6584 spdk_blob_set_read_only(newblob); 6585 6586 /* sync snapshot metadata */ 6587 spdk_blob_sync_md(newblob, bs_clone_snapshot_origblob_cleanup, ctx); 6588 } 6589 6590 static void 6591 bs_snapshot_newblob_sync_cpl(void *cb_arg, int bserrno) 6592 { 6593 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6594 struct spdk_blob *origblob = ctx->original.blob; 6595 struct spdk_blob *newblob = ctx->new.blob; 6596 6597 if (bserrno != 0) { 6598 /* return cluster map back to original */ 6599 bs_snapshot_swap_cluster_maps(newblob, origblob); 6600 6601 /* Newblob md sync failed. Valid clusters are only present in origblob. 6602 * Since I/O is frozen on origblob, not changes to zeroed out cluster map should have occurred. 6603 * Newblob needs to be reverted to thin_provisioned state at creation to properly close. */ 6604 blob_set_thin_provision(newblob); 6605 assert(spdk_mem_all_zero(newblob->active.clusters, 6606 newblob->active.num_clusters * sizeof(*newblob->active.clusters))); 6607 assert(spdk_mem_all_zero(newblob->active.extent_pages, 6608 newblob->active.num_extent_pages * sizeof(*newblob->active.extent_pages))); 6609 6610 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 6611 return; 6612 } 6613 6614 /* Set internal xattr for snapshot id */ 6615 bserrno = blob_set_xattr(origblob, BLOB_SNAPSHOT, &newblob->id, sizeof(spdk_blob_id), true); 6616 if (bserrno != 0) { 6617 /* return cluster map back to original */ 6618 bs_snapshot_swap_cluster_maps(newblob, origblob); 6619 blob_set_thin_provision(newblob); 6620 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 6621 return; 6622 } 6623 6624 /* Create new back_bs_dev for snapshot */ 6625 origblob->back_bs_dev = bs_create_blob_bs_dev(newblob); 6626 if (origblob->back_bs_dev == NULL) { 6627 /* return cluster map back to original */ 6628 bs_snapshot_swap_cluster_maps(newblob, origblob); 6629 blob_set_thin_provision(newblob); 6630 bs_clone_snapshot_newblob_cleanup(ctx, -EINVAL); 6631 return; 6632 } 6633 6634 /* Remove the xattr that references an external snapshot */ 6635 if (blob_is_esnap_clone(origblob)) { 6636 origblob->invalid_flags &= ~SPDK_BLOB_EXTERNAL_SNAPSHOT; 6637 bserrno = blob_remove_xattr(origblob, BLOB_EXTERNAL_SNAPSHOT_ID, true); 6638 if (bserrno != 0) { 6639 if (bserrno == -ENOENT) { 6640 SPDK_ERRLOG("blob 0x%" PRIx64 " has no " BLOB_EXTERNAL_SNAPSHOT_ID 6641 " xattr to remove\n", origblob->id); 6642 assert(false); 6643 } else { 6644 /* return cluster map back to original */ 6645 bs_snapshot_swap_cluster_maps(newblob, origblob); 6646 blob_set_thin_provision(newblob); 6647 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 6648 return; 6649 } 6650 } 6651 } 6652 6653 bs_blob_list_remove(origblob); 6654 origblob->parent_id = newblob->id; 6655 /* set clone blob as thin provisioned */ 6656 blob_set_thin_provision(origblob); 6657 6658 bs_blob_list_add(newblob); 6659 6660 /* sync clone metadata */ 6661 spdk_blob_sync_md(origblob, bs_snapshot_origblob_sync_cpl, ctx); 6662 } 6663 6664 static void 6665 bs_snapshot_freeze_cpl(void *cb_arg, int rc) 6666 { 6667 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6668 struct spdk_blob *origblob = ctx->original.blob; 6669 struct spdk_blob *newblob = ctx->new.blob; 6670 int bserrno; 6671 6672 if (rc != 0) { 6673 bs_clone_snapshot_newblob_cleanup(ctx, rc); 6674 return; 6675 } 6676 6677 ctx->frozen = true; 6678 6679 if (blob_is_esnap_clone(origblob)) { 6680 /* Clean up any channels associated with the original blob id because future IO will 6681 * perform IO using the snapshot blob_id. 6682 */ 6683 blob_esnap_destroy_bs_dev_channels(origblob, false, NULL, NULL); 6684 } 6685 if (newblob->back_bs_dev) { 6686 blob_back_bs_destroy(newblob); 6687 } 6688 /* set new back_bs_dev for snapshot */ 6689 newblob->back_bs_dev = origblob->back_bs_dev; 6690 /* Set invalid flags from origblob */ 6691 newblob->invalid_flags = origblob->invalid_flags; 6692 6693 /* inherit parent from original blob if set */ 6694 newblob->parent_id = origblob->parent_id; 6695 switch (origblob->parent_id) { 6696 case SPDK_BLOBID_EXTERNAL_SNAPSHOT: 6697 bserrno = bs_snapshot_copy_xattr(newblob, origblob, BLOB_EXTERNAL_SNAPSHOT_ID); 6698 if (bserrno != 0) { 6699 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 6700 return; 6701 } 6702 break; 6703 case SPDK_BLOBID_INVALID: 6704 break; 6705 default: 6706 /* Set internal xattr for snapshot id */ 6707 bserrno = blob_set_xattr(newblob, BLOB_SNAPSHOT, 6708 &origblob->parent_id, sizeof(spdk_blob_id), true); 6709 if (bserrno != 0) { 6710 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 6711 return; 6712 } 6713 } 6714 6715 /* swap cluster maps */ 6716 bs_snapshot_swap_cluster_maps(newblob, origblob); 6717 6718 /* Set the clear method on the new blob to match the original. */ 6719 blob_set_clear_method(newblob, origblob->clear_method); 6720 6721 /* sync snapshot metadata */ 6722 spdk_blob_sync_md(newblob, bs_snapshot_newblob_sync_cpl, ctx); 6723 } 6724 6725 static void 6726 bs_snapshot_newblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6727 { 6728 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6729 struct spdk_blob *origblob = ctx->original.blob; 6730 struct spdk_blob *newblob = _blob; 6731 6732 if (bserrno != 0) { 6733 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6734 return; 6735 } 6736 6737 ctx->new.blob = newblob; 6738 assert(spdk_blob_is_thin_provisioned(newblob)); 6739 assert(spdk_mem_all_zero(newblob->active.clusters, 6740 newblob->active.num_clusters * sizeof(*newblob->active.clusters))); 6741 assert(spdk_mem_all_zero(newblob->active.extent_pages, 6742 newblob->active.num_extent_pages * sizeof(*newblob->active.extent_pages))); 6743 6744 blob_freeze_io(origblob, bs_snapshot_freeze_cpl, ctx); 6745 } 6746 6747 static void 6748 bs_snapshot_newblob_create_cpl(void *cb_arg, spdk_blob_id blobid, int bserrno) 6749 { 6750 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6751 struct spdk_blob *origblob = ctx->original.blob; 6752 6753 if (bserrno != 0) { 6754 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6755 return; 6756 } 6757 6758 ctx->new.id = blobid; 6759 ctx->cpl.u.blobid.blobid = blobid; 6760 6761 spdk_bs_open_blob(origblob->bs, ctx->new.id, bs_snapshot_newblob_open_cpl, ctx); 6762 } 6763 6764 6765 static void 6766 bs_xattr_snapshot(void *arg, const char *name, 6767 const void **value, size_t *value_len) 6768 { 6769 assert(strncmp(name, SNAPSHOT_IN_PROGRESS, sizeof(SNAPSHOT_IN_PROGRESS)) == 0); 6770 6771 struct spdk_blob *blob = (struct spdk_blob *)arg; 6772 *value = &blob->id; 6773 *value_len = sizeof(blob->id); 6774 } 6775 6776 static void 6777 bs_snapshot_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6778 { 6779 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6780 struct spdk_blob_opts opts; 6781 struct spdk_blob_xattr_opts internal_xattrs; 6782 char *xattrs_names[] = { SNAPSHOT_IN_PROGRESS }; 6783 6784 if (bserrno != 0) { 6785 bs_clone_snapshot_cleanup_finish(ctx, bserrno); 6786 return; 6787 } 6788 6789 ctx->original.blob = _blob; 6790 6791 if (_blob->data_ro || _blob->md_ro) { 6792 SPDK_DEBUGLOG(blob, "Cannot create snapshot from read only blob with id 0x%" 6793 PRIx64 "\n", _blob->id); 6794 ctx->bserrno = -EINVAL; 6795 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6796 return; 6797 } 6798 6799 if (_blob->locked_operation_in_progress) { 6800 SPDK_DEBUGLOG(blob, "Cannot create snapshot - another operation in progress\n"); 6801 ctx->bserrno = -EBUSY; 6802 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6803 return; 6804 } 6805 6806 _blob->locked_operation_in_progress = true; 6807 6808 spdk_blob_opts_init(&opts, sizeof(opts)); 6809 blob_xattrs_init(&internal_xattrs); 6810 6811 /* Change the size of new blob to the same as in original blob, 6812 * but do not allocate clusters */ 6813 opts.thin_provision = true; 6814 opts.num_clusters = spdk_blob_get_num_clusters(_blob); 6815 opts.use_extent_table = _blob->use_extent_table; 6816 6817 /* If there are any xattrs specified for snapshot, set them now */ 6818 if (ctx->xattrs) { 6819 memcpy(&opts.xattrs, ctx->xattrs, sizeof(*ctx->xattrs)); 6820 } 6821 /* Set internal xattr SNAPSHOT_IN_PROGRESS */ 6822 internal_xattrs.count = 1; 6823 internal_xattrs.ctx = _blob; 6824 internal_xattrs.names = xattrs_names; 6825 internal_xattrs.get_value = bs_xattr_snapshot; 6826 6827 bs_create_blob(_blob->bs, &opts, &internal_xattrs, 6828 bs_snapshot_newblob_create_cpl, ctx); 6829 } 6830 6831 void 6832 spdk_bs_create_snapshot(struct spdk_blob_store *bs, spdk_blob_id blobid, 6833 const struct spdk_blob_xattr_opts *snapshot_xattrs, 6834 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6835 { 6836 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 6837 6838 if (!ctx) { 6839 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOMEM); 6840 return; 6841 } 6842 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 6843 ctx->cpl.u.blobid.cb_fn = cb_fn; 6844 ctx->cpl.u.blobid.cb_arg = cb_arg; 6845 ctx->cpl.u.blobid.blobid = SPDK_BLOBID_INVALID; 6846 ctx->bserrno = 0; 6847 ctx->frozen = false; 6848 ctx->original.id = blobid; 6849 ctx->xattrs = snapshot_xattrs; 6850 6851 spdk_bs_open_blob(bs, ctx->original.id, bs_snapshot_origblob_open_cpl, ctx); 6852 } 6853 /* END spdk_bs_create_snapshot */ 6854 6855 /* START spdk_bs_create_clone */ 6856 6857 static void 6858 bs_xattr_clone(void *arg, const char *name, 6859 const void **value, size_t *value_len) 6860 { 6861 assert(strncmp(name, BLOB_SNAPSHOT, sizeof(BLOB_SNAPSHOT)) == 0); 6862 6863 struct spdk_blob *blob = (struct spdk_blob *)arg; 6864 *value = &blob->id; 6865 *value_len = sizeof(blob->id); 6866 } 6867 6868 static void 6869 bs_clone_newblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6870 { 6871 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6872 struct spdk_blob *clone = _blob; 6873 6874 ctx->new.blob = clone; 6875 bs_blob_list_add(clone); 6876 6877 spdk_blob_close(clone, bs_clone_snapshot_origblob_cleanup, ctx); 6878 } 6879 6880 static void 6881 bs_clone_newblob_create_cpl(void *cb_arg, spdk_blob_id blobid, int bserrno) 6882 { 6883 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6884 6885 ctx->cpl.u.blobid.blobid = blobid; 6886 spdk_bs_open_blob(ctx->original.blob->bs, blobid, bs_clone_newblob_open_cpl, ctx); 6887 } 6888 6889 static void 6890 bs_clone_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6891 { 6892 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6893 struct spdk_blob_opts opts; 6894 struct spdk_blob_xattr_opts internal_xattrs; 6895 char *xattr_names[] = { BLOB_SNAPSHOT }; 6896 6897 if (bserrno != 0) { 6898 bs_clone_snapshot_cleanup_finish(ctx, bserrno); 6899 return; 6900 } 6901 6902 ctx->original.blob = _blob; 6903 ctx->original.md_ro = _blob->md_ro; 6904 6905 if (!_blob->data_ro || !_blob->md_ro) { 6906 SPDK_DEBUGLOG(blob, "Clone not from read-only blob\n"); 6907 ctx->bserrno = -EINVAL; 6908 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6909 return; 6910 } 6911 6912 if (_blob->locked_operation_in_progress) { 6913 SPDK_DEBUGLOG(blob, "Cannot create clone - another operation in progress\n"); 6914 ctx->bserrno = -EBUSY; 6915 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6916 return; 6917 } 6918 6919 _blob->locked_operation_in_progress = true; 6920 6921 spdk_blob_opts_init(&opts, sizeof(opts)); 6922 blob_xattrs_init(&internal_xattrs); 6923 6924 opts.thin_provision = true; 6925 opts.num_clusters = spdk_blob_get_num_clusters(_blob); 6926 opts.use_extent_table = _blob->use_extent_table; 6927 if (ctx->xattrs) { 6928 memcpy(&opts.xattrs, ctx->xattrs, sizeof(*ctx->xattrs)); 6929 } 6930 6931 /* Set internal xattr BLOB_SNAPSHOT */ 6932 internal_xattrs.count = 1; 6933 internal_xattrs.ctx = _blob; 6934 internal_xattrs.names = xattr_names; 6935 internal_xattrs.get_value = bs_xattr_clone; 6936 6937 bs_create_blob(_blob->bs, &opts, &internal_xattrs, 6938 bs_clone_newblob_create_cpl, ctx); 6939 } 6940 6941 void 6942 spdk_bs_create_clone(struct spdk_blob_store *bs, spdk_blob_id blobid, 6943 const struct spdk_blob_xattr_opts *clone_xattrs, 6944 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6945 { 6946 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 6947 6948 if (!ctx) { 6949 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOMEM); 6950 return; 6951 } 6952 6953 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 6954 ctx->cpl.u.blobid.cb_fn = cb_fn; 6955 ctx->cpl.u.blobid.cb_arg = cb_arg; 6956 ctx->cpl.u.blobid.blobid = SPDK_BLOBID_INVALID; 6957 ctx->bserrno = 0; 6958 ctx->xattrs = clone_xattrs; 6959 ctx->original.id = blobid; 6960 6961 spdk_bs_open_blob(bs, ctx->original.id, bs_clone_origblob_open_cpl, ctx); 6962 } 6963 6964 /* END spdk_bs_create_clone */ 6965 6966 /* START spdk_bs_inflate_blob */ 6967 6968 static void 6969 bs_inflate_blob_set_parent_cpl(void *cb_arg, struct spdk_blob *_parent, int bserrno) 6970 { 6971 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6972 struct spdk_blob *_blob = ctx->original.blob; 6973 6974 if (bserrno != 0) { 6975 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6976 return; 6977 } 6978 6979 /* Temporarily override md_ro flag for MD modification */ 6980 _blob->md_ro = false; 6981 6982 bserrno = blob_set_xattr(_blob, BLOB_SNAPSHOT, &_parent->id, sizeof(spdk_blob_id), true); 6983 if (bserrno != 0) { 6984 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6985 return; 6986 } 6987 6988 assert(_parent != NULL); 6989 6990 bs_blob_list_remove(_blob); 6991 _blob->parent_id = _parent->id; 6992 6993 blob_back_bs_destroy(_blob); 6994 _blob->back_bs_dev = bs_create_blob_bs_dev(_parent); 6995 bs_blob_list_add(_blob); 6996 6997 spdk_blob_sync_md(_blob, bs_clone_snapshot_origblob_cleanup, ctx); 6998 } 6999 7000 static void 7001 bs_inflate_blob_done(struct spdk_clone_snapshot_ctx *ctx) 7002 { 7003 struct spdk_blob *_blob = ctx->original.blob; 7004 struct spdk_blob *_parent; 7005 7006 if (ctx->allocate_all) { 7007 /* remove thin provisioning */ 7008 bs_blob_list_remove(_blob); 7009 if (_blob->parent_id == SPDK_BLOBID_EXTERNAL_SNAPSHOT) { 7010 blob_remove_xattr(_blob, BLOB_EXTERNAL_SNAPSHOT_ID, true); 7011 _blob->invalid_flags &= ~SPDK_BLOB_EXTERNAL_SNAPSHOT; 7012 } else { 7013 blob_remove_xattr(_blob, BLOB_SNAPSHOT, true); 7014 } 7015 _blob->invalid_flags = _blob->invalid_flags & ~SPDK_BLOB_THIN_PROV; 7016 blob_back_bs_destroy(_blob); 7017 _blob->parent_id = SPDK_BLOBID_INVALID; 7018 } else { 7019 /* For now, esnap clones always have allocate_all set. */ 7020 assert(!blob_is_esnap_clone(_blob)); 7021 7022 _parent = ((struct spdk_blob_bs_dev *)(_blob->back_bs_dev))->blob; 7023 if (_parent->parent_id != SPDK_BLOBID_INVALID) { 7024 /* We must change the parent of the inflated blob */ 7025 spdk_bs_open_blob(_blob->bs, _parent->parent_id, 7026 bs_inflate_blob_set_parent_cpl, ctx); 7027 return; 7028 } 7029 7030 bs_blob_list_remove(_blob); 7031 _blob->parent_id = SPDK_BLOBID_INVALID; 7032 blob_back_bs_destroy(_blob); 7033 _blob->back_bs_dev = bs_create_zeroes_dev(); 7034 } 7035 7036 /* Temporarily override md_ro flag for MD modification */ 7037 _blob->md_ro = false; 7038 blob_remove_xattr(_blob, BLOB_SNAPSHOT, true); 7039 _blob->state = SPDK_BLOB_STATE_DIRTY; 7040 7041 spdk_blob_sync_md(_blob, bs_clone_snapshot_origblob_cleanup, ctx); 7042 } 7043 7044 /* Check if cluster needs allocation */ 7045 static inline bool 7046 bs_cluster_needs_allocation(struct spdk_blob *blob, uint64_t cluster, bool allocate_all) 7047 { 7048 struct spdk_blob_bs_dev *b; 7049 7050 assert(blob != NULL); 7051 7052 if (blob->active.clusters[cluster] != 0) { 7053 /* Cluster is already allocated */ 7054 return false; 7055 } 7056 7057 if (blob->parent_id == SPDK_BLOBID_INVALID) { 7058 /* Blob have no parent blob */ 7059 return allocate_all; 7060 } 7061 7062 if (blob->parent_id == SPDK_BLOBID_EXTERNAL_SNAPSHOT) { 7063 return true; 7064 } 7065 7066 b = (struct spdk_blob_bs_dev *)blob->back_bs_dev; 7067 return (allocate_all || b->blob->active.clusters[cluster] != 0); 7068 } 7069 7070 static void 7071 bs_inflate_blob_touch_next(void *cb_arg, int bserrno) 7072 { 7073 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 7074 struct spdk_blob *_blob = ctx->original.blob; 7075 struct spdk_bs_cpl cpl; 7076 spdk_bs_user_op_t *op; 7077 uint64_t offset; 7078 7079 if (bserrno != 0) { 7080 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 7081 return; 7082 } 7083 7084 for (; ctx->cluster < _blob->active.num_clusters; ctx->cluster++) { 7085 if (bs_cluster_needs_allocation(_blob, ctx->cluster, ctx->allocate_all)) { 7086 break; 7087 } 7088 } 7089 7090 if (ctx->cluster < _blob->active.num_clusters) { 7091 offset = bs_cluster_to_lba(_blob->bs, ctx->cluster); 7092 7093 /* We may safely increment a cluster before copying */ 7094 ctx->cluster++; 7095 7096 /* Use a dummy 0B read as a context for cluster copy */ 7097 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 7098 cpl.u.blob_basic.cb_fn = bs_inflate_blob_touch_next; 7099 cpl.u.blob_basic.cb_arg = ctx; 7100 7101 op = bs_user_op_alloc(ctx->channel, &cpl, SPDK_BLOB_READ, _blob, 7102 NULL, 0, offset, 0); 7103 if (!op) { 7104 bs_clone_snapshot_origblob_cleanup(ctx, -ENOMEM); 7105 return; 7106 } 7107 7108 bs_allocate_and_copy_cluster(_blob, ctx->channel, offset, op); 7109 } else { 7110 bs_inflate_blob_done(ctx); 7111 } 7112 } 7113 7114 static void 7115 bs_inflate_blob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 7116 { 7117 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 7118 uint64_t clusters_needed; 7119 uint64_t i; 7120 7121 if (bserrno != 0) { 7122 bs_clone_snapshot_cleanup_finish(ctx, bserrno); 7123 return; 7124 } 7125 7126 ctx->original.blob = _blob; 7127 ctx->original.md_ro = _blob->md_ro; 7128 7129 if (_blob->locked_operation_in_progress) { 7130 SPDK_DEBUGLOG(blob, "Cannot inflate blob - another operation in progress\n"); 7131 ctx->bserrno = -EBUSY; 7132 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 7133 return; 7134 } 7135 7136 _blob->locked_operation_in_progress = true; 7137 7138 switch (_blob->parent_id) { 7139 case SPDK_BLOBID_INVALID: 7140 if (!ctx->allocate_all) { 7141 /* This blob has no parent, so we cannot decouple it. */ 7142 SPDK_ERRLOG("Cannot decouple parent of blob with no parent.\n"); 7143 bs_clone_snapshot_origblob_cleanup(ctx, -EINVAL); 7144 return; 7145 } 7146 break; 7147 case SPDK_BLOBID_EXTERNAL_SNAPSHOT: 7148 /* 7149 * It would be better to rely on back_bs_dev->is_zeroes(), to determine which 7150 * clusters require allocation. Until there is a blobstore consumer that 7151 * uses esnaps with an spdk_bs_dev that implements a useful is_zeroes() it is not 7152 * worth the effort. 7153 */ 7154 ctx->allocate_all = true; 7155 break; 7156 default: 7157 break; 7158 } 7159 7160 if (spdk_blob_is_thin_provisioned(_blob) == false) { 7161 /* This is not thin provisioned blob. No need to inflate. */ 7162 bs_clone_snapshot_origblob_cleanup(ctx, 0); 7163 return; 7164 } 7165 7166 /* Do two passes - one to verify that we can obtain enough clusters 7167 * and another to actually claim them. 7168 */ 7169 clusters_needed = 0; 7170 for (i = 0; i < _blob->active.num_clusters; i++) { 7171 if (bs_cluster_needs_allocation(_blob, i, ctx->allocate_all)) { 7172 clusters_needed++; 7173 } 7174 } 7175 7176 if (clusters_needed > _blob->bs->num_free_clusters) { 7177 /* Not enough free clusters. Cannot satisfy the request. */ 7178 bs_clone_snapshot_origblob_cleanup(ctx, -ENOSPC); 7179 return; 7180 } 7181 7182 ctx->cluster = 0; 7183 bs_inflate_blob_touch_next(ctx, 0); 7184 } 7185 7186 static void 7187 bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 7188 spdk_blob_id blobid, bool allocate_all, spdk_blob_op_complete cb_fn, void *cb_arg) 7189 { 7190 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 7191 7192 if (!ctx) { 7193 cb_fn(cb_arg, -ENOMEM); 7194 return; 7195 } 7196 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 7197 ctx->cpl.u.bs_basic.cb_fn = cb_fn; 7198 ctx->cpl.u.bs_basic.cb_arg = cb_arg; 7199 ctx->bserrno = 0; 7200 ctx->original.id = blobid; 7201 ctx->channel = channel; 7202 ctx->allocate_all = allocate_all; 7203 7204 spdk_bs_open_blob(bs, ctx->original.id, bs_inflate_blob_open_cpl, ctx); 7205 } 7206 7207 void 7208 spdk_bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 7209 spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg) 7210 { 7211 bs_inflate_blob(bs, channel, blobid, true, cb_fn, cb_arg); 7212 } 7213 7214 void 7215 spdk_bs_blob_decouple_parent(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 7216 spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg) 7217 { 7218 bs_inflate_blob(bs, channel, blobid, false, cb_fn, cb_arg); 7219 } 7220 /* END spdk_bs_inflate_blob */ 7221 7222 /* START spdk_bs_blob_shallow_copy */ 7223 7224 struct shallow_copy_ctx { 7225 struct spdk_bs_cpl cpl; 7226 int bserrno; 7227 7228 /* Blob source for copy */ 7229 struct spdk_blob_store *bs; 7230 spdk_blob_id blobid; 7231 struct spdk_blob *blob; 7232 struct spdk_io_channel *blob_channel; 7233 7234 /* Destination device for copy */ 7235 struct spdk_bs_dev *ext_dev; 7236 struct spdk_io_channel *ext_channel; 7237 7238 /* Current cluster for copy operation */ 7239 uint64_t cluster; 7240 7241 /* Buffer for blob reading */ 7242 uint8_t *read_buff; 7243 7244 /* Struct for external device writing */ 7245 struct spdk_bs_dev_cb_args ext_args; 7246 7247 /* Actual number of copied clusters */ 7248 uint64_t copied_clusters_count; 7249 7250 /* Status callback for updates about the ongoing operation */ 7251 spdk_blob_shallow_copy_status status_cb; 7252 7253 /* Argument passed to function status_cb */ 7254 void *status_cb_arg; 7255 }; 7256 7257 static void 7258 bs_shallow_copy_cleanup_finish(void *cb_arg, int bserrno) 7259 { 7260 struct shallow_copy_ctx *ctx = cb_arg; 7261 struct spdk_bs_cpl *cpl = &ctx->cpl; 7262 7263 if (bserrno != 0) { 7264 SPDK_ERRLOG("blob 0x%" PRIx64 " shallow copy, cleanup error %d\n", ctx->blob->id, bserrno); 7265 ctx->bserrno = bserrno; 7266 } 7267 7268 ctx->ext_dev->destroy_channel(ctx->ext_dev, ctx->ext_channel); 7269 spdk_free(ctx->read_buff); 7270 7271 cpl->u.blob_basic.cb_fn(cpl->u.blob_basic.cb_arg, ctx->bserrno); 7272 7273 free(ctx); 7274 } 7275 7276 static void 7277 bs_shallow_copy_bdev_write_cpl(struct spdk_io_channel *channel, void *cb_arg, int bserrno) 7278 { 7279 struct shallow_copy_ctx *ctx = cb_arg; 7280 struct spdk_blob *_blob = ctx->blob; 7281 7282 if (bserrno != 0) { 7283 SPDK_ERRLOG("blob 0x%" PRIx64 " shallow copy, ext dev write error %d\n", ctx->blob->id, bserrno); 7284 ctx->bserrno = bserrno; 7285 _blob->locked_operation_in_progress = false; 7286 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7287 return; 7288 } 7289 7290 ctx->cluster++; 7291 if (ctx->status_cb) { 7292 ctx->copied_clusters_count++; 7293 ctx->status_cb(ctx->copied_clusters_count, ctx->status_cb_arg); 7294 } 7295 7296 bs_shallow_copy_cluster_find_next(ctx); 7297 } 7298 7299 static void 7300 bs_shallow_copy_blob_read_cpl(void *cb_arg, int bserrno) 7301 { 7302 struct shallow_copy_ctx *ctx = cb_arg; 7303 struct spdk_bs_dev *ext_dev = ctx->ext_dev; 7304 struct spdk_blob *_blob = ctx->blob; 7305 7306 if (bserrno != 0) { 7307 SPDK_ERRLOG("blob 0x%" PRIx64 " shallow copy, blob read error %d\n", ctx->blob->id, bserrno); 7308 ctx->bserrno = bserrno; 7309 _blob->locked_operation_in_progress = false; 7310 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7311 return; 7312 } 7313 7314 ctx->ext_args.channel = ctx->ext_channel; 7315 ctx->ext_args.cb_fn = bs_shallow_copy_bdev_write_cpl; 7316 ctx->ext_args.cb_arg = ctx; 7317 7318 ext_dev->write(ext_dev, ctx->ext_channel, ctx->read_buff, 7319 bs_cluster_to_lba(_blob->bs, ctx->cluster), 7320 bs_dev_byte_to_lba(_blob->bs->dev, _blob->bs->cluster_sz), 7321 &ctx->ext_args); 7322 } 7323 7324 static void 7325 bs_shallow_copy_cluster_find_next(void *cb_arg) 7326 { 7327 struct shallow_copy_ctx *ctx = cb_arg; 7328 struct spdk_blob *_blob = ctx->blob; 7329 7330 while (ctx->cluster < _blob->active.num_clusters) { 7331 if (_blob->active.clusters[ctx->cluster] != 0) { 7332 break; 7333 } 7334 7335 ctx->cluster++; 7336 } 7337 7338 if (ctx->cluster < _blob->active.num_clusters) { 7339 blob_request_submit_op_single(ctx->blob_channel, _blob, ctx->read_buff, 7340 bs_cluster_to_lba(_blob->bs, ctx->cluster), 7341 bs_dev_byte_to_lba(_blob->bs->dev, _blob->bs->cluster_sz), 7342 bs_shallow_copy_blob_read_cpl, ctx, SPDK_BLOB_READ); 7343 } else { 7344 _blob->locked_operation_in_progress = false; 7345 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7346 } 7347 } 7348 7349 static void 7350 bs_shallow_copy_blob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 7351 { 7352 struct shallow_copy_ctx *ctx = cb_arg; 7353 struct spdk_bs_dev *ext_dev = ctx->ext_dev; 7354 uint32_t blob_block_size; 7355 uint64_t blob_total_size; 7356 7357 if (bserrno != 0) { 7358 SPDK_ERRLOG("Shallow copy blob open error %d\n", bserrno); 7359 ctx->bserrno = bserrno; 7360 bs_shallow_copy_cleanup_finish(ctx, 0); 7361 return; 7362 } 7363 7364 if (!spdk_blob_is_read_only(_blob)) { 7365 SPDK_ERRLOG("blob 0x%" PRIx64 " shallow copy, blob must be read only\n", _blob->id); 7366 ctx->bserrno = -EPERM; 7367 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7368 return; 7369 } 7370 7371 blob_block_size = _blob->bs->dev->blocklen; 7372 blob_total_size = spdk_blob_get_num_clusters(_blob) * spdk_bs_get_cluster_size(_blob->bs); 7373 7374 if (blob_total_size > ext_dev->blockcnt * ext_dev->blocklen) { 7375 SPDK_ERRLOG("blob 0x%" PRIx64 " shallow copy, external device must have at least blob size\n", 7376 _blob->id); 7377 ctx->bserrno = -EINVAL; 7378 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7379 return; 7380 } 7381 7382 if (blob_block_size % ext_dev->blocklen != 0) { 7383 SPDK_ERRLOG("blob 0x%" PRIx64 " shallow copy, external device block size is not compatible with \ 7384 blobstore block size\n", _blob->id); 7385 ctx->bserrno = -EINVAL; 7386 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7387 return; 7388 } 7389 7390 ctx->blob = _blob; 7391 7392 if (_blob->locked_operation_in_progress) { 7393 SPDK_DEBUGLOG(blob, "blob 0x%" PRIx64 " shallow copy - another operation in progress\n", _blob->id); 7394 ctx->bserrno = -EBUSY; 7395 spdk_blob_close(_blob, bs_shallow_copy_cleanup_finish, ctx); 7396 return; 7397 } 7398 7399 _blob->locked_operation_in_progress = true; 7400 7401 ctx->cluster = 0; 7402 bs_shallow_copy_cluster_find_next(ctx); 7403 } 7404 7405 int 7406 spdk_bs_blob_shallow_copy(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 7407 spdk_blob_id blobid, struct spdk_bs_dev *ext_dev, 7408 spdk_blob_shallow_copy_status status_cb_fn, void *status_cb_arg, 7409 spdk_blob_op_complete cb_fn, void *cb_arg) 7410 { 7411 struct shallow_copy_ctx *ctx; 7412 struct spdk_io_channel *ext_channel; 7413 7414 ctx = calloc(1, sizeof(*ctx)); 7415 if (!ctx) { 7416 return -ENOMEM; 7417 } 7418 7419 ctx->bs = bs; 7420 ctx->blobid = blobid; 7421 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 7422 ctx->cpl.u.bs_basic.cb_fn = cb_fn; 7423 ctx->cpl.u.bs_basic.cb_arg = cb_arg; 7424 ctx->bserrno = 0; 7425 ctx->blob_channel = channel; 7426 ctx->status_cb = status_cb_fn; 7427 ctx->status_cb_arg = status_cb_arg; 7428 ctx->read_buff = spdk_malloc(bs->cluster_sz, bs->dev->blocklen, NULL, 7429 SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA); 7430 if (!ctx->read_buff) { 7431 free(ctx); 7432 return -ENOMEM; 7433 } 7434 7435 ext_channel = ext_dev->create_channel(ext_dev); 7436 if (!ext_channel) { 7437 spdk_free(ctx->read_buff); 7438 free(ctx); 7439 return -ENOMEM; 7440 } 7441 ctx->ext_dev = ext_dev; 7442 ctx->ext_channel = ext_channel; 7443 7444 spdk_bs_open_blob(ctx->bs, ctx->blobid, bs_shallow_copy_blob_open_cpl, ctx); 7445 7446 return 0; 7447 } 7448 /* END spdk_bs_blob_shallow_copy */ 7449 7450 /* START spdk_bs_blob_set_parent */ 7451 7452 struct set_parent_ctx { 7453 struct spdk_blob_store *bs; 7454 int bserrno; 7455 spdk_bs_op_complete cb_fn; 7456 void *cb_arg; 7457 7458 struct spdk_blob *blob; 7459 bool blob_md_ro; 7460 7461 struct blob_parent parent; 7462 }; 7463 7464 static void 7465 bs_set_parent_cleanup_finish(void *cb_arg, int bserrno) 7466 { 7467 struct set_parent_ctx *ctx = cb_arg; 7468 7469 assert(ctx != NULL); 7470 7471 if (bserrno != 0) { 7472 SPDK_ERRLOG("blob set parent finish error %d\n", bserrno); 7473 if (ctx->bserrno == 0) { 7474 ctx->bserrno = bserrno; 7475 } 7476 } 7477 7478 ctx->cb_fn(ctx->cb_arg, ctx->bserrno); 7479 7480 free(ctx); 7481 } 7482 7483 static void 7484 bs_set_parent_close_snapshot(void *cb_arg, int bserrno) 7485 { 7486 struct set_parent_ctx *ctx = cb_arg; 7487 7488 if (ctx->bserrno != 0) { 7489 spdk_blob_close(ctx->parent.u.snapshot.blob, bs_set_parent_cleanup_finish, ctx); 7490 return; 7491 } 7492 7493 if (bserrno != 0) { 7494 SPDK_ERRLOG("blob close error %d\n", bserrno); 7495 ctx->bserrno = bserrno; 7496 } 7497 7498 bs_set_parent_cleanup_finish(ctx, ctx->bserrno); 7499 } 7500 7501 static void 7502 bs_set_parent_close_blob(void *cb_arg, int bserrno) 7503 { 7504 struct set_parent_ctx *ctx = cb_arg; 7505 struct spdk_blob *blob = ctx->blob; 7506 struct spdk_blob *snapshot = ctx->parent.u.snapshot.blob; 7507 7508 if (bserrno != 0 && ctx->bserrno == 0) { 7509 SPDK_ERRLOG("error %d in metadata sync\n", bserrno); 7510 ctx->bserrno = bserrno; 7511 } 7512 7513 /* Revert md_ro to original state */ 7514 blob->md_ro = ctx->blob_md_ro; 7515 7516 blob->locked_operation_in_progress = false; 7517 snapshot->locked_operation_in_progress = false; 7518 7519 spdk_blob_close(blob, bs_set_parent_close_snapshot, ctx); 7520 } 7521 7522 static void 7523 bs_set_parent_set_back_bs_dev_done(void *cb_arg, int bserrno) 7524 { 7525 struct set_parent_ctx *ctx = cb_arg; 7526 struct spdk_blob *blob = ctx->blob; 7527 7528 if (bserrno != 0) { 7529 SPDK_ERRLOG("error %d setting back_bs_dev\n", bserrno); 7530 ctx->bserrno = bserrno; 7531 bs_set_parent_close_blob(ctx, bserrno); 7532 return; 7533 } 7534 7535 spdk_blob_sync_md(blob, bs_set_parent_close_blob, ctx); 7536 } 7537 7538 static int 7539 bs_set_parent_refs(struct spdk_blob *blob, struct blob_parent *parent) 7540 { 7541 int rc; 7542 7543 bs_blob_list_remove(blob); 7544 7545 rc = blob_set_xattr(blob, BLOB_SNAPSHOT, &parent->u.snapshot.id, sizeof(spdk_blob_id), true); 7546 if (rc != 0) { 7547 SPDK_ERRLOG("error %d setting snapshot xattr\n", rc); 7548 return rc; 7549 } 7550 blob->parent_id = parent->u.snapshot.id; 7551 7552 if (blob_is_esnap_clone(blob)) { 7553 /* Remove the xattr that references the external snapshot */ 7554 blob->invalid_flags &= ~SPDK_BLOB_EXTERNAL_SNAPSHOT; 7555 blob_remove_xattr(blob, BLOB_EXTERNAL_SNAPSHOT_ID, true); 7556 } 7557 7558 bs_blob_list_add(blob); 7559 7560 return 0; 7561 } 7562 7563 static void 7564 bs_set_parent_snapshot_open_cpl(void *cb_arg, struct spdk_blob *snapshot, int bserrno) 7565 { 7566 struct set_parent_ctx *ctx = cb_arg; 7567 struct spdk_blob *blob = ctx->blob; 7568 struct spdk_bs_dev *back_bs_dev; 7569 7570 if (bserrno != 0) { 7571 SPDK_ERRLOG("snapshot open error %d\n", bserrno); 7572 ctx->bserrno = bserrno; 7573 spdk_blob_close(blob, bs_set_parent_cleanup_finish, ctx); 7574 return; 7575 } 7576 7577 ctx->parent.u.snapshot.blob = snapshot; 7578 ctx->parent.u.snapshot.id = snapshot->id; 7579 7580 if (!spdk_blob_is_snapshot(snapshot)) { 7581 SPDK_ERRLOG("parent blob is not a snapshot\n"); 7582 ctx->bserrno = -EINVAL; 7583 spdk_blob_close(blob, bs_set_parent_close_snapshot, ctx); 7584 return; 7585 } 7586 7587 if (blob->active.num_clusters != snapshot->active.num_clusters) { 7588 SPDK_ERRLOG("parent blob has a number of clusters different from child's ones\n"); 7589 ctx->bserrno = -EINVAL; 7590 spdk_blob_close(blob, bs_set_parent_close_snapshot, ctx); 7591 return; 7592 } 7593 7594 if (blob->locked_operation_in_progress || snapshot->locked_operation_in_progress) { 7595 SPDK_ERRLOG("cannot set parent of blob, another operation in progress\n"); 7596 ctx->bserrno = -EBUSY; 7597 spdk_blob_close(blob, bs_set_parent_close_snapshot, ctx); 7598 return; 7599 } 7600 7601 blob->locked_operation_in_progress = true; 7602 snapshot->locked_operation_in_progress = true; 7603 7604 /* Temporarily override md_ro flag for MD modification */ 7605 blob->md_ro = false; 7606 7607 back_bs_dev = bs_create_blob_bs_dev(snapshot); 7608 7609 blob_set_back_bs_dev(blob, back_bs_dev, bs_set_parent_refs, &ctx->parent, 7610 bs_set_parent_set_back_bs_dev_done, 7611 ctx); 7612 } 7613 7614 static void 7615 bs_set_parent_blob_open_cpl(void *cb_arg, struct spdk_blob *blob, int bserrno) 7616 { 7617 struct set_parent_ctx *ctx = cb_arg; 7618 7619 if (bserrno != 0) { 7620 SPDK_ERRLOG("blob open error %d\n", bserrno); 7621 ctx->bserrno = bserrno; 7622 bs_set_parent_cleanup_finish(ctx, 0); 7623 return; 7624 } 7625 7626 if (!spdk_blob_is_thin_provisioned(blob)) { 7627 SPDK_ERRLOG("blob is not thin-provisioned\n"); 7628 ctx->bserrno = -EINVAL; 7629 spdk_blob_close(blob, bs_set_parent_cleanup_finish, ctx); 7630 return; 7631 } 7632 7633 ctx->blob = blob; 7634 ctx->blob_md_ro = blob->md_ro; 7635 7636 spdk_bs_open_blob(ctx->bs, ctx->parent.u.snapshot.id, bs_set_parent_snapshot_open_cpl, ctx); 7637 } 7638 7639 void 7640 spdk_bs_blob_set_parent(struct spdk_blob_store *bs, spdk_blob_id blob_id, 7641 spdk_blob_id snapshot_id, spdk_blob_op_complete cb_fn, void *cb_arg) 7642 { 7643 struct set_parent_ctx *ctx; 7644 7645 if (snapshot_id == SPDK_BLOBID_INVALID) { 7646 SPDK_ERRLOG("snapshot id not valid\n"); 7647 cb_fn(cb_arg, -EINVAL); 7648 return; 7649 } 7650 7651 if (blob_id == snapshot_id) { 7652 SPDK_ERRLOG("blob id and snapshot id cannot be the same\n"); 7653 cb_fn(cb_arg, -EINVAL); 7654 return; 7655 } 7656 7657 if (spdk_blob_get_parent_snapshot(bs, blob_id) == snapshot_id) { 7658 SPDK_NOTICELOG("snapshot is already the parent of blob\n"); 7659 cb_fn(cb_arg, -EEXIST); 7660 return; 7661 } 7662 7663 ctx = calloc(1, sizeof(*ctx)); 7664 if (!ctx) { 7665 cb_fn(cb_arg, -ENOMEM); 7666 return; 7667 } 7668 7669 ctx->bs = bs; 7670 ctx->parent.u.snapshot.id = snapshot_id; 7671 ctx->cb_fn = cb_fn; 7672 ctx->cb_arg = cb_arg; 7673 ctx->bserrno = 0; 7674 7675 spdk_bs_open_blob(bs, blob_id, bs_set_parent_blob_open_cpl, ctx); 7676 } 7677 /* END spdk_bs_blob_set_parent */ 7678 7679 /* START spdk_bs_blob_set_external_parent */ 7680 7681 static void 7682 bs_set_external_parent_cleanup_finish(void *cb_arg, int bserrno) 7683 { 7684 struct set_parent_ctx *ctx = cb_arg; 7685 7686 if (bserrno != 0) { 7687 SPDK_ERRLOG("blob set external parent finish error %d\n", bserrno); 7688 if (ctx->bserrno == 0) { 7689 ctx->bserrno = bserrno; 7690 } 7691 } 7692 7693 ctx->cb_fn(ctx->cb_arg, ctx->bserrno); 7694 7695 free(ctx->parent.u.esnap.id); 7696 free(ctx); 7697 } 7698 7699 static void 7700 bs_set_external_parent_close_blob(void *cb_arg, int bserrno) 7701 { 7702 struct set_parent_ctx *ctx = cb_arg; 7703 struct spdk_blob *blob = ctx->blob; 7704 7705 if (bserrno != 0 && ctx->bserrno == 0) { 7706 SPDK_ERRLOG("error %d in metadata sync\n", bserrno); 7707 ctx->bserrno = bserrno; 7708 } 7709 7710 /* Revert md_ro to original state */ 7711 blob->md_ro = ctx->blob_md_ro; 7712 7713 blob->locked_operation_in_progress = false; 7714 7715 spdk_blob_close(blob, bs_set_external_parent_cleanup_finish, ctx); 7716 } 7717 7718 static void 7719 bs_set_external_parent_unfrozen(void *cb_arg, int bserrno) 7720 { 7721 struct set_parent_ctx *ctx = cb_arg; 7722 struct spdk_blob *blob = ctx->blob; 7723 7724 if (bserrno != 0) { 7725 SPDK_ERRLOG("error %d setting back_bs_dev\n", bserrno); 7726 ctx->bserrno = bserrno; 7727 bs_set_external_parent_close_blob(ctx, bserrno); 7728 return; 7729 } 7730 7731 spdk_blob_sync_md(blob, bs_set_external_parent_close_blob, ctx); 7732 } 7733 7734 static int 7735 bs_set_external_parent_refs(struct spdk_blob *blob, struct blob_parent *parent) 7736 { 7737 int rc; 7738 7739 bs_blob_list_remove(blob); 7740 7741 if (spdk_blob_is_clone(blob)) { 7742 /* Remove the xattr that references the snapshot */ 7743 blob->parent_id = SPDK_BLOBID_INVALID; 7744 blob_remove_xattr(blob, BLOB_SNAPSHOT, true); 7745 } 7746 7747 rc = blob_set_xattr(blob, BLOB_EXTERNAL_SNAPSHOT_ID, parent->u.esnap.id, 7748 parent->u.esnap.id_len, true); 7749 if (rc != 0) { 7750 SPDK_ERRLOG("error %d setting external snapshot xattr\n", rc); 7751 return rc; 7752 } 7753 blob->invalid_flags |= SPDK_BLOB_EXTERNAL_SNAPSHOT; 7754 blob->parent_id = SPDK_BLOBID_EXTERNAL_SNAPSHOT; 7755 7756 bs_blob_list_add(blob); 7757 7758 return 0; 7759 } 7760 7761 static void 7762 bs_set_external_parent_blob_open_cpl(void *cb_arg, struct spdk_blob *blob, int bserrno) 7763 { 7764 struct set_parent_ctx *ctx = cb_arg; 7765 const void *esnap_id; 7766 size_t esnap_id_len; 7767 int rc; 7768 7769 if (bserrno != 0) { 7770 SPDK_ERRLOG("blob open error %d\n", bserrno); 7771 ctx->bserrno = bserrno; 7772 bs_set_parent_cleanup_finish(ctx, 0); 7773 return; 7774 } 7775 7776 ctx->blob = blob; 7777 ctx->blob_md_ro = blob->md_ro; 7778 7779 rc = spdk_blob_get_esnap_id(blob, &esnap_id, &esnap_id_len); 7780 if (rc == 0 && esnap_id != NULL && esnap_id_len == ctx->parent.u.esnap.id_len && 7781 memcmp(esnap_id, ctx->parent.u.esnap.id, esnap_id_len) == 0) { 7782 SPDK_ERRLOG("external snapshot is already the parent of blob\n"); 7783 ctx->bserrno = -EEXIST; 7784 goto error; 7785 } 7786 7787 if (!spdk_blob_is_thin_provisioned(blob)) { 7788 SPDK_ERRLOG("blob is not thin-provisioned\n"); 7789 ctx->bserrno = -EINVAL; 7790 goto error; 7791 } 7792 7793 if (blob->locked_operation_in_progress) { 7794 SPDK_ERRLOG("cannot set external parent of blob, another operation in progress\n"); 7795 ctx->bserrno = -EBUSY; 7796 goto error; 7797 } 7798 7799 blob->locked_operation_in_progress = true; 7800 7801 /* Temporarily override md_ro flag for MD modification */ 7802 blob->md_ro = false; 7803 7804 blob_set_back_bs_dev(blob, ctx->parent.u.esnap.back_bs_dev, bs_set_external_parent_refs, 7805 &ctx->parent, bs_set_external_parent_unfrozen, ctx); 7806 return; 7807 7808 error: 7809 spdk_blob_close(blob, bs_set_external_parent_cleanup_finish, ctx); 7810 } 7811 7812 void 7813 spdk_bs_blob_set_external_parent(struct spdk_blob_store *bs, spdk_blob_id blob_id, 7814 struct spdk_bs_dev *esnap_bs_dev, const void *esnap_id, 7815 uint32_t esnap_id_len, spdk_blob_op_complete cb_fn, void *cb_arg) 7816 { 7817 struct set_parent_ctx *ctx; 7818 uint64_t esnap_dev_size, cluster_sz; 7819 7820 if (sizeof(blob_id) == esnap_id_len && memcmp(&blob_id, esnap_id, sizeof(blob_id)) == 0) { 7821 SPDK_ERRLOG("blob id and external snapshot id cannot be the same\n"); 7822 cb_fn(cb_arg, -EINVAL); 7823 return; 7824 } 7825 7826 esnap_dev_size = esnap_bs_dev->blockcnt * esnap_bs_dev->blocklen; 7827 cluster_sz = spdk_bs_get_cluster_size(bs); 7828 if ((esnap_dev_size % cluster_sz) != 0) { 7829 SPDK_ERRLOG("Esnap device size %" PRIu64 " is not an integer multiple of " 7830 "cluster size %" PRIu64 "\n", esnap_dev_size, cluster_sz); 7831 cb_fn(cb_arg, -EINVAL); 7832 return; 7833 } 7834 7835 ctx = calloc(1, sizeof(*ctx)); 7836 if (!ctx) { 7837 cb_fn(cb_arg, -ENOMEM); 7838 return; 7839 } 7840 7841 ctx->parent.u.esnap.id = calloc(1, esnap_id_len); 7842 if (!ctx->parent.u.esnap.id) { 7843 free(ctx); 7844 cb_fn(cb_arg, -ENOMEM); 7845 return; 7846 } 7847 7848 ctx->bs = bs; 7849 ctx->parent.u.esnap.back_bs_dev = esnap_bs_dev; 7850 memcpy(ctx->parent.u.esnap.id, esnap_id, esnap_id_len); 7851 ctx->parent.u.esnap.id_len = esnap_id_len; 7852 ctx->cb_fn = cb_fn; 7853 ctx->cb_arg = cb_arg; 7854 ctx->bserrno = 0; 7855 7856 spdk_bs_open_blob(bs, blob_id, bs_set_external_parent_blob_open_cpl, ctx); 7857 } 7858 /* END spdk_bs_blob_set_external_parent */ 7859 7860 /* START spdk_blob_resize */ 7861 struct spdk_bs_resize_ctx { 7862 spdk_blob_op_complete cb_fn; 7863 void *cb_arg; 7864 struct spdk_blob *blob; 7865 uint64_t sz; 7866 int rc; 7867 }; 7868 7869 static void 7870 bs_resize_unfreeze_cpl(void *cb_arg, int rc) 7871 { 7872 struct spdk_bs_resize_ctx *ctx = (struct spdk_bs_resize_ctx *)cb_arg; 7873 7874 if (rc != 0) { 7875 SPDK_ERRLOG("Unfreeze failed, rc=%d\n", rc); 7876 } 7877 7878 if (ctx->rc != 0) { 7879 SPDK_ERRLOG("Unfreeze failed, ctx->rc=%d\n", ctx->rc); 7880 rc = ctx->rc; 7881 } 7882 7883 ctx->blob->locked_operation_in_progress = false; 7884 7885 ctx->cb_fn(ctx->cb_arg, rc); 7886 free(ctx); 7887 } 7888 7889 static void 7890 bs_resize_freeze_cpl(void *cb_arg, int rc) 7891 { 7892 struct spdk_bs_resize_ctx *ctx = (struct spdk_bs_resize_ctx *)cb_arg; 7893 7894 if (rc != 0) { 7895 ctx->blob->locked_operation_in_progress = false; 7896 ctx->cb_fn(ctx->cb_arg, rc); 7897 free(ctx); 7898 return; 7899 } 7900 7901 ctx->rc = blob_resize(ctx->blob, ctx->sz); 7902 7903 blob_unfreeze_io(ctx->blob, bs_resize_unfreeze_cpl, ctx); 7904 } 7905 7906 void 7907 spdk_blob_resize(struct spdk_blob *blob, uint64_t sz, spdk_blob_op_complete cb_fn, void *cb_arg) 7908 { 7909 struct spdk_bs_resize_ctx *ctx; 7910 7911 blob_verify_md_op(blob); 7912 7913 SPDK_DEBUGLOG(blob, "Resizing blob 0x%" PRIx64 " to %" PRIu64 " clusters\n", blob->id, sz); 7914 7915 if (blob->md_ro) { 7916 cb_fn(cb_arg, -EPERM); 7917 return; 7918 } 7919 7920 if (sz == blob->active.num_clusters) { 7921 cb_fn(cb_arg, 0); 7922 return; 7923 } 7924 7925 if (blob->locked_operation_in_progress) { 7926 cb_fn(cb_arg, -EBUSY); 7927 return; 7928 } 7929 7930 ctx = calloc(1, sizeof(*ctx)); 7931 if (!ctx) { 7932 cb_fn(cb_arg, -ENOMEM); 7933 return; 7934 } 7935 7936 blob->locked_operation_in_progress = true; 7937 ctx->cb_fn = cb_fn; 7938 ctx->cb_arg = cb_arg; 7939 ctx->blob = blob; 7940 ctx->sz = sz; 7941 blob_freeze_io(blob, bs_resize_freeze_cpl, ctx); 7942 } 7943 7944 /* END spdk_blob_resize */ 7945 7946 7947 /* START spdk_bs_delete_blob */ 7948 7949 static void 7950 bs_delete_close_cpl(void *cb_arg, int bserrno) 7951 { 7952 spdk_bs_sequence_t *seq = cb_arg; 7953 7954 bs_sequence_finish(seq, bserrno); 7955 } 7956 7957 static void 7958 bs_delete_persist_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 7959 { 7960 struct spdk_blob *blob = cb_arg; 7961 7962 if (bserrno != 0) { 7963 /* 7964 * We already removed this blob from the blobstore tailq, so 7965 * we need to free it here since this is the last reference 7966 * to it. 7967 */ 7968 blob_free(blob); 7969 bs_delete_close_cpl(seq, bserrno); 7970 return; 7971 } 7972 7973 /* 7974 * This will immediately decrement the ref_count and call 7975 * the completion routine since the metadata state is clean. 7976 * By calling spdk_blob_close, we reduce the number of call 7977 * points into code that touches the blob->open_ref count 7978 * and the blobstore's blob list. 7979 */ 7980 spdk_blob_close(blob, bs_delete_close_cpl, seq); 7981 } 7982 7983 struct delete_snapshot_ctx { 7984 struct spdk_blob_list *parent_snapshot_entry; 7985 struct spdk_blob *snapshot; 7986 struct spdk_blob_md_page *page; 7987 bool snapshot_md_ro; 7988 struct spdk_blob *clone; 7989 bool clone_md_ro; 7990 spdk_blob_op_with_handle_complete cb_fn; 7991 void *cb_arg; 7992 int bserrno; 7993 uint32_t next_extent_page; 7994 }; 7995 7996 static void 7997 delete_blob_cleanup_finish(void *cb_arg, int bserrno) 7998 { 7999 struct delete_snapshot_ctx *ctx = cb_arg; 8000 8001 if (bserrno != 0) { 8002 SPDK_ERRLOG("Snapshot cleanup error %d\n", bserrno); 8003 } 8004 8005 assert(ctx != NULL); 8006 8007 if (bserrno != 0 && ctx->bserrno == 0) { 8008 ctx->bserrno = bserrno; 8009 } 8010 8011 ctx->cb_fn(ctx->cb_arg, ctx->snapshot, ctx->bserrno); 8012 spdk_free(ctx->page); 8013 free(ctx); 8014 } 8015 8016 static void 8017 delete_snapshot_cleanup_snapshot(void *cb_arg, int bserrno) 8018 { 8019 struct delete_snapshot_ctx *ctx = cb_arg; 8020 8021 if (bserrno != 0) { 8022 ctx->bserrno = bserrno; 8023 SPDK_ERRLOG("Clone cleanup error %d\n", bserrno); 8024 } 8025 8026 if (ctx->bserrno != 0) { 8027 assert(blob_lookup(ctx->snapshot->bs, ctx->snapshot->id) == NULL); 8028 RB_INSERT(spdk_blob_tree, &ctx->snapshot->bs->open_blobs, ctx->snapshot); 8029 spdk_bit_array_set(ctx->snapshot->bs->open_blobids, ctx->snapshot->id); 8030 } 8031 8032 ctx->snapshot->locked_operation_in_progress = false; 8033 ctx->snapshot->md_ro = ctx->snapshot_md_ro; 8034 8035 spdk_blob_close(ctx->snapshot, delete_blob_cleanup_finish, ctx); 8036 } 8037 8038 static void 8039 delete_snapshot_cleanup_clone(void *cb_arg, int bserrno) 8040 { 8041 struct delete_snapshot_ctx *ctx = cb_arg; 8042 8043 ctx->clone->locked_operation_in_progress = false; 8044 ctx->clone->md_ro = ctx->clone_md_ro; 8045 8046 spdk_blob_close(ctx->clone, delete_snapshot_cleanup_snapshot, ctx); 8047 } 8048 8049 static void 8050 delete_snapshot_unfreeze_cpl(void *cb_arg, int bserrno) 8051 { 8052 struct delete_snapshot_ctx *ctx = cb_arg; 8053 8054 if (bserrno) { 8055 ctx->bserrno = bserrno; 8056 delete_snapshot_cleanup_clone(ctx, 0); 8057 return; 8058 } 8059 8060 ctx->clone->locked_operation_in_progress = false; 8061 spdk_blob_close(ctx->clone, delete_blob_cleanup_finish, ctx); 8062 } 8063 8064 static void 8065 delete_snapshot_sync_snapshot_cpl(void *cb_arg, int bserrno) 8066 { 8067 struct delete_snapshot_ctx *ctx = cb_arg; 8068 struct spdk_blob_list *parent_snapshot_entry = NULL; 8069 struct spdk_blob_list *snapshot_entry = NULL; 8070 struct spdk_blob_list *clone_entry = NULL; 8071 struct spdk_blob_list *snapshot_clone_entry = NULL; 8072 8073 if (bserrno) { 8074 SPDK_ERRLOG("Failed to sync MD on blob\n"); 8075 ctx->bserrno = bserrno; 8076 delete_snapshot_cleanup_clone(ctx, 0); 8077 return; 8078 } 8079 8080 /* Get snapshot entry for the snapshot we want to remove */ 8081 snapshot_entry = bs_get_snapshot_entry(ctx->snapshot->bs, ctx->snapshot->id); 8082 8083 assert(snapshot_entry != NULL); 8084 8085 /* Remove clone entry in this snapshot (at this point there can be only one clone) */ 8086 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 8087 assert(clone_entry != NULL); 8088 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 8089 snapshot_entry->clone_count--; 8090 assert(TAILQ_EMPTY(&snapshot_entry->clones)); 8091 8092 switch (ctx->snapshot->parent_id) { 8093 case SPDK_BLOBID_INVALID: 8094 case SPDK_BLOBID_EXTERNAL_SNAPSHOT: 8095 /* No parent snapshot - just remove clone entry */ 8096 free(clone_entry); 8097 break; 8098 default: 8099 /* This snapshot is at the same time a clone of another snapshot - we need to 8100 * update parent snapshot (remove current clone, add new one inherited from 8101 * the snapshot that is being removed) */ 8102 8103 /* Get snapshot entry for parent snapshot and clone entry within that snapshot for 8104 * snapshot that we are removing */ 8105 blob_get_snapshot_and_clone_entries(ctx->snapshot, &parent_snapshot_entry, 8106 &snapshot_clone_entry); 8107 8108 /* Switch clone entry in parent snapshot */ 8109 TAILQ_INSERT_TAIL(&parent_snapshot_entry->clones, clone_entry, link); 8110 TAILQ_REMOVE(&parent_snapshot_entry->clones, snapshot_clone_entry, link); 8111 free(snapshot_clone_entry); 8112 } 8113 8114 /* Restore md_ro flags */ 8115 ctx->clone->md_ro = ctx->clone_md_ro; 8116 ctx->snapshot->md_ro = ctx->snapshot_md_ro; 8117 8118 blob_unfreeze_io(ctx->clone, delete_snapshot_unfreeze_cpl, ctx); 8119 } 8120 8121 static void 8122 delete_snapshot_sync_clone_cpl(void *cb_arg, int bserrno) 8123 { 8124 struct delete_snapshot_ctx *ctx = cb_arg; 8125 uint64_t i; 8126 8127 ctx->snapshot->md_ro = false; 8128 8129 if (bserrno) { 8130 SPDK_ERRLOG("Failed to sync MD on clone\n"); 8131 ctx->bserrno = bserrno; 8132 8133 /* Restore snapshot to previous state */ 8134 bserrno = blob_remove_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, true); 8135 if (bserrno != 0) { 8136 delete_snapshot_cleanup_clone(ctx, bserrno); 8137 return; 8138 } 8139 8140 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_cleanup_clone, ctx); 8141 return; 8142 } 8143 8144 /* Clear cluster map entries for snapshot */ 8145 for (i = 0; i < ctx->snapshot->active.num_clusters && i < ctx->clone->active.num_clusters; i++) { 8146 if (ctx->clone->active.clusters[i] == ctx->snapshot->active.clusters[i]) { 8147 if (ctx->snapshot->active.clusters[i] != 0) { 8148 ctx->snapshot->active.num_allocated_clusters--; 8149 } 8150 ctx->snapshot->active.clusters[i] = 0; 8151 } 8152 } 8153 for (i = 0; i < ctx->snapshot->active.num_extent_pages && 8154 i < ctx->clone->active.num_extent_pages; i++) { 8155 if (ctx->clone->active.extent_pages[i] == ctx->snapshot->active.extent_pages[i]) { 8156 ctx->snapshot->active.extent_pages[i] = 0; 8157 } 8158 } 8159 8160 blob_set_thin_provision(ctx->snapshot); 8161 ctx->snapshot->state = SPDK_BLOB_STATE_DIRTY; 8162 8163 if (ctx->parent_snapshot_entry != NULL) { 8164 ctx->snapshot->back_bs_dev = NULL; 8165 } 8166 8167 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_sync_snapshot_cpl, ctx); 8168 } 8169 8170 static void 8171 delete_snapshot_update_extent_pages_cpl(struct delete_snapshot_ctx *ctx) 8172 { 8173 int bserrno; 8174 8175 /* Delete old backing bs_dev from clone (related to snapshot that will be removed) */ 8176 blob_back_bs_destroy(ctx->clone); 8177 8178 /* Set/remove snapshot xattr and switch parent ID and backing bs_dev on clone... */ 8179 if (ctx->snapshot->parent_id == SPDK_BLOBID_EXTERNAL_SNAPSHOT) { 8180 bserrno = bs_snapshot_copy_xattr(ctx->clone, ctx->snapshot, 8181 BLOB_EXTERNAL_SNAPSHOT_ID); 8182 if (bserrno != 0) { 8183 ctx->bserrno = bserrno; 8184 8185 /* Restore snapshot to previous state */ 8186 bserrno = blob_remove_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, true); 8187 if (bserrno != 0) { 8188 delete_snapshot_cleanup_clone(ctx, bserrno); 8189 return; 8190 } 8191 8192 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_cleanup_clone, ctx); 8193 return; 8194 } 8195 ctx->clone->parent_id = SPDK_BLOBID_EXTERNAL_SNAPSHOT; 8196 ctx->clone->back_bs_dev = ctx->snapshot->back_bs_dev; 8197 /* Do not delete the external snapshot along with this snapshot */ 8198 ctx->snapshot->back_bs_dev = NULL; 8199 ctx->clone->invalid_flags |= SPDK_BLOB_EXTERNAL_SNAPSHOT; 8200 } else if (ctx->parent_snapshot_entry != NULL) { 8201 /* ...to parent snapshot */ 8202 ctx->clone->parent_id = ctx->parent_snapshot_entry->id; 8203 ctx->clone->back_bs_dev = ctx->snapshot->back_bs_dev; 8204 blob_set_xattr(ctx->clone, BLOB_SNAPSHOT, &ctx->parent_snapshot_entry->id, 8205 sizeof(spdk_blob_id), 8206 true); 8207 } else { 8208 /* ...to blobid invalid and zeroes dev */ 8209 ctx->clone->parent_id = SPDK_BLOBID_INVALID; 8210 ctx->clone->back_bs_dev = bs_create_zeroes_dev(); 8211 blob_remove_xattr(ctx->clone, BLOB_SNAPSHOT, true); 8212 } 8213 8214 spdk_blob_sync_md(ctx->clone, delete_snapshot_sync_clone_cpl, ctx); 8215 } 8216 8217 static void 8218 delete_snapshot_update_extent_pages(void *cb_arg, int bserrno) 8219 { 8220 struct delete_snapshot_ctx *ctx = cb_arg; 8221 uint32_t *extent_page; 8222 uint64_t i; 8223 8224 for (i = ctx->next_extent_page; i < ctx->snapshot->active.num_extent_pages && 8225 i < ctx->clone->active.num_extent_pages; i++) { 8226 if (ctx->snapshot->active.extent_pages[i] == 0) { 8227 /* No extent page to use from snapshot */ 8228 continue; 8229 } 8230 8231 extent_page = &ctx->clone->active.extent_pages[i]; 8232 if (*extent_page == 0) { 8233 /* Copy extent page from snapshot when clone did not have a matching one */ 8234 *extent_page = ctx->snapshot->active.extent_pages[i]; 8235 continue; 8236 } 8237 8238 /* Clone and snapshot both contain partially filled matching extent pages. 8239 * Update the clone extent page in place with cluster map containing the mix of both. */ 8240 ctx->next_extent_page = i + 1; 8241 memset(ctx->page, 0, SPDK_BS_PAGE_SIZE); 8242 8243 blob_write_extent_page(ctx->clone, *extent_page, i * SPDK_EXTENTS_PER_EP, ctx->page, 8244 delete_snapshot_update_extent_pages, ctx); 8245 return; 8246 } 8247 delete_snapshot_update_extent_pages_cpl(ctx); 8248 } 8249 8250 static void 8251 delete_snapshot_sync_snapshot_xattr_cpl(void *cb_arg, int bserrno) 8252 { 8253 struct delete_snapshot_ctx *ctx = cb_arg; 8254 uint64_t i; 8255 8256 /* Temporarily override md_ro flag for clone for MD modification */ 8257 ctx->clone_md_ro = ctx->clone->md_ro; 8258 ctx->clone->md_ro = false; 8259 8260 if (bserrno) { 8261 SPDK_ERRLOG("Failed to sync MD with xattr on blob\n"); 8262 ctx->bserrno = bserrno; 8263 delete_snapshot_cleanup_clone(ctx, 0); 8264 return; 8265 } 8266 8267 /* Copy snapshot map to clone map (only unallocated clusters in clone) */ 8268 for (i = 0; i < ctx->snapshot->active.num_clusters && i < ctx->clone->active.num_clusters; i++) { 8269 if (ctx->clone->active.clusters[i] == 0) { 8270 ctx->clone->active.clusters[i] = ctx->snapshot->active.clusters[i]; 8271 if (ctx->clone->active.clusters[i] != 0) { 8272 ctx->clone->active.num_allocated_clusters++; 8273 } 8274 } 8275 } 8276 ctx->next_extent_page = 0; 8277 delete_snapshot_update_extent_pages(ctx, 0); 8278 } 8279 8280 static void 8281 delete_snapshot_esnap_channels_destroyed_cb(void *cb_arg, struct spdk_blob *blob, int bserrno) 8282 { 8283 struct delete_snapshot_ctx *ctx = cb_arg; 8284 8285 if (bserrno != 0) { 8286 SPDK_ERRLOG("blob 0x%" PRIx64 ": failed to destroy esnap channels: %d\n", 8287 blob->id, bserrno); 8288 /* That error should not stop us from syncing metadata. */ 8289 } 8290 8291 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_sync_snapshot_xattr_cpl, ctx); 8292 } 8293 8294 static void 8295 delete_snapshot_freeze_io_cb(void *cb_arg, int bserrno) 8296 { 8297 struct delete_snapshot_ctx *ctx = cb_arg; 8298 8299 if (bserrno) { 8300 SPDK_ERRLOG("Failed to freeze I/O on clone\n"); 8301 ctx->bserrno = bserrno; 8302 delete_snapshot_cleanup_clone(ctx, 0); 8303 return; 8304 } 8305 8306 /* Temporarily override md_ro flag for snapshot for MD modification */ 8307 ctx->snapshot_md_ro = ctx->snapshot->md_ro; 8308 ctx->snapshot->md_ro = false; 8309 8310 /* Mark blob as pending for removal for power failure safety, use clone id for recovery */ 8311 ctx->bserrno = blob_set_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, &ctx->clone->id, 8312 sizeof(spdk_blob_id), true); 8313 if (ctx->bserrno != 0) { 8314 delete_snapshot_cleanup_clone(ctx, 0); 8315 return; 8316 } 8317 8318 if (blob_is_esnap_clone(ctx->snapshot)) { 8319 blob_esnap_destroy_bs_dev_channels(ctx->snapshot, false, 8320 delete_snapshot_esnap_channels_destroyed_cb, 8321 ctx); 8322 return; 8323 } 8324 8325 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_sync_snapshot_xattr_cpl, ctx); 8326 } 8327 8328 static void 8329 delete_snapshot_open_clone_cb(void *cb_arg, struct spdk_blob *clone, int bserrno) 8330 { 8331 struct delete_snapshot_ctx *ctx = cb_arg; 8332 8333 if (bserrno) { 8334 SPDK_ERRLOG("Failed to open clone\n"); 8335 ctx->bserrno = bserrno; 8336 delete_snapshot_cleanup_snapshot(ctx, 0); 8337 return; 8338 } 8339 8340 ctx->clone = clone; 8341 8342 if (clone->locked_operation_in_progress) { 8343 SPDK_DEBUGLOG(blob, "Cannot remove blob - another operation in progress on its clone\n"); 8344 ctx->bserrno = -EBUSY; 8345 spdk_blob_close(ctx->clone, delete_snapshot_cleanup_snapshot, ctx); 8346 return; 8347 } 8348 8349 clone->locked_operation_in_progress = true; 8350 8351 blob_freeze_io(clone, delete_snapshot_freeze_io_cb, ctx); 8352 } 8353 8354 static void 8355 update_clone_on_snapshot_deletion(struct spdk_blob *snapshot, struct delete_snapshot_ctx *ctx) 8356 { 8357 struct spdk_blob_list *snapshot_entry = NULL; 8358 struct spdk_blob_list *clone_entry = NULL; 8359 struct spdk_blob_list *snapshot_clone_entry = NULL; 8360 8361 /* Get snapshot entry for the snapshot we want to remove */ 8362 snapshot_entry = bs_get_snapshot_entry(snapshot->bs, snapshot->id); 8363 8364 assert(snapshot_entry != NULL); 8365 8366 /* Get clone of the snapshot (at this point there can be only one clone) */ 8367 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 8368 assert(snapshot_entry->clone_count == 1); 8369 assert(clone_entry != NULL); 8370 8371 /* Get snapshot entry for parent snapshot and clone entry within that snapshot for 8372 * snapshot that we are removing */ 8373 blob_get_snapshot_and_clone_entries(snapshot, &ctx->parent_snapshot_entry, 8374 &snapshot_clone_entry); 8375 8376 spdk_bs_open_blob(snapshot->bs, clone_entry->id, delete_snapshot_open_clone_cb, ctx); 8377 } 8378 8379 static void 8380 bs_delete_blob_finish(void *cb_arg, struct spdk_blob *blob, int bserrno) 8381 { 8382 spdk_bs_sequence_t *seq = cb_arg; 8383 struct spdk_blob_list *snapshot_entry = NULL; 8384 uint32_t page_num; 8385 8386 if (bserrno) { 8387 SPDK_ERRLOG("Failed to remove blob\n"); 8388 bs_sequence_finish(seq, bserrno); 8389 return; 8390 } 8391 8392 /* Remove snapshot from the list */ 8393 snapshot_entry = bs_get_snapshot_entry(blob->bs, blob->id); 8394 if (snapshot_entry != NULL) { 8395 TAILQ_REMOVE(&blob->bs->snapshots, snapshot_entry, link); 8396 free(snapshot_entry); 8397 } 8398 8399 page_num = bs_blobid_to_page(blob->id); 8400 spdk_bit_array_clear(blob->bs->used_blobids, page_num); 8401 blob->state = SPDK_BLOB_STATE_DIRTY; 8402 blob->active.num_pages = 0; 8403 blob_resize(blob, 0); 8404 8405 blob_persist(seq, blob, bs_delete_persist_cpl, blob); 8406 } 8407 8408 static int 8409 bs_is_blob_deletable(struct spdk_blob *blob, bool *update_clone) 8410 { 8411 struct spdk_blob_list *snapshot_entry = NULL; 8412 struct spdk_blob_list *clone_entry = NULL; 8413 struct spdk_blob *clone = NULL; 8414 bool has_one_clone = false; 8415 8416 /* Check if this is a snapshot with clones */ 8417 snapshot_entry = bs_get_snapshot_entry(blob->bs, blob->id); 8418 if (snapshot_entry != NULL) { 8419 if (snapshot_entry->clone_count > 1) { 8420 SPDK_ERRLOG("Cannot remove snapshot with more than one clone\n"); 8421 return -EBUSY; 8422 } else if (snapshot_entry->clone_count == 1) { 8423 has_one_clone = true; 8424 } 8425 } 8426 8427 /* Check if someone has this blob open (besides this delete context): 8428 * - open_ref = 1 - only this context opened blob, so it is ok to remove it 8429 * - open_ref <= 2 && has_one_clone = true - clone is holding snapshot 8430 * and that is ok, because we will update it accordingly */ 8431 if (blob->open_ref <= 2 && has_one_clone) { 8432 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 8433 assert(clone_entry != NULL); 8434 clone = blob_lookup(blob->bs, clone_entry->id); 8435 8436 if (blob->open_ref == 2 && clone == NULL) { 8437 /* Clone is closed and someone else opened this blob */ 8438 SPDK_ERRLOG("Cannot remove snapshot because it is open\n"); 8439 return -EBUSY; 8440 } 8441 8442 *update_clone = true; 8443 return 0; 8444 } 8445 8446 if (blob->open_ref > 1) { 8447 SPDK_ERRLOG("Cannot remove snapshot because it is open\n"); 8448 return -EBUSY; 8449 } 8450 8451 assert(has_one_clone == false); 8452 *update_clone = false; 8453 return 0; 8454 } 8455 8456 static void 8457 bs_delete_enomem_close_cpl(void *cb_arg, int bserrno) 8458 { 8459 spdk_bs_sequence_t *seq = cb_arg; 8460 8461 bs_sequence_finish(seq, -ENOMEM); 8462 } 8463 8464 static void 8465 bs_delete_open_cpl(void *cb_arg, struct spdk_blob *blob, int bserrno) 8466 { 8467 spdk_bs_sequence_t *seq = cb_arg; 8468 struct delete_snapshot_ctx *ctx; 8469 bool update_clone = false; 8470 8471 if (bserrno != 0) { 8472 bs_sequence_finish(seq, bserrno); 8473 return; 8474 } 8475 8476 blob_verify_md_op(blob); 8477 8478 ctx = calloc(1, sizeof(*ctx)); 8479 if (ctx == NULL) { 8480 spdk_blob_close(blob, bs_delete_enomem_close_cpl, seq); 8481 return; 8482 } 8483 8484 ctx->snapshot = blob; 8485 ctx->cb_fn = bs_delete_blob_finish; 8486 ctx->cb_arg = seq; 8487 8488 /* Check if blob can be removed and if it is a snapshot with clone on top of it */ 8489 ctx->bserrno = bs_is_blob_deletable(blob, &update_clone); 8490 if (ctx->bserrno) { 8491 spdk_blob_close(blob, delete_blob_cleanup_finish, ctx); 8492 return; 8493 } 8494 8495 if (blob->locked_operation_in_progress) { 8496 SPDK_DEBUGLOG(blob, "Cannot remove blob - another operation in progress\n"); 8497 ctx->bserrno = -EBUSY; 8498 spdk_blob_close(blob, delete_blob_cleanup_finish, ctx); 8499 return; 8500 } 8501 8502 blob->locked_operation_in_progress = true; 8503 8504 /* 8505 * Remove the blob from the blob_store list now, to ensure it does not 8506 * get returned after this point by blob_lookup(). 8507 */ 8508 spdk_bit_array_clear(blob->bs->open_blobids, blob->id); 8509 RB_REMOVE(spdk_blob_tree, &blob->bs->open_blobs, blob); 8510 8511 if (update_clone) { 8512 ctx->page = spdk_zmalloc(blob->bs->md_page_size, 0, NULL, SPDK_ENV_NUMA_ID_ANY, 8513 SPDK_MALLOC_DMA); 8514 if (!ctx->page) { 8515 ctx->bserrno = -ENOMEM; 8516 spdk_blob_close(blob, delete_blob_cleanup_finish, ctx); 8517 return; 8518 } 8519 /* This blob is a snapshot with active clone - update clone first */ 8520 update_clone_on_snapshot_deletion(blob, ctx); 8521 } else { 8522 /* This blob does not have any clones - just remove it */ 8523 bs_blob_list_remove(blob); 8524 bs_delete_blob_finish(seq, blob, 0); 8525 free(ctx); 8526 } 8527 } 8528 8529 void 8530 spdk_bs_delete_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 8531 spdk_blob_op_complete cb_fn, void *cb_arg) 8532 { 8533 struct spdk_bs_cpl cpl; 8534 spdk_bs_sequence_t *seq; 8535 8536 SPDK_DEBUGLOG(blob, "Deleting blob 0x%" PRIx64 "\n", blobid); 8537 8538 assert(spdk_get_thread() == bs->md_thread); 8539 8540 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 8541 cpl.u.blob_basic.cb_fn = cb_fn; 8542 cpl.u.blob_basic.cb_arg = cb_arg; 8543 8544 seq = bs_sequence_start_bs(bs->md_channel, &cpl); 8545 if (!seq) { 8546 cb_fn(cb_arg, -ENOMEM); 8547 return; 8548 } 8549 8550 spdk_bs_open_blob(bs, blobid, bs_delete_open_cpl, seq); 8551 } 8552 8553 /* END spdk_bs_delete_blob */ 8554 8555 /* START spdk_bs_open_blob */ 8556 8557 static void 8558 bs_open_blob_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 8559 { 8560 struct spdk_blob *blob = cb_arg; 8561 struct spdk_blob *existing; 8562 8563 if (bserrno != 0) { 8564 blob_free(blob); 8565 seq->cpl.u.blob_handle.blob = NULL; 8566 bs_sequence_finish(seq, bserrno); 8567 return; 8568 } 8569 8570 existing = blob_lookup(blob->bs, blob->id); 8571 if (existing) { 8572 blob_free(blob); 8573 existing->open_ref++; 8574 seq->cpl.u.blob_handle.blob = existing; 8575 bs_sequence_finish(seq, 0); 8576 return; 8577 } 8578 8579 blob->open_ref++; 8580 8581 spdk_bit_array_set(blob->bs->open_blobids, blob->id); 8582 RB_INSERT(spdk_blob_tree, &blob->bs->open_blobs, blob); 8583 8584 bs_sequence_finish(seq, bserrno); 8585 } 8586 8587 static inline void 8588 blob_open_opts_copy(const struct spdk_blob_open_opts *src, struct spdk_blob_open_opts *dst) 8589 { 8590 #define FIELD_OK(field) \ 8591 offsetof(struct spdk_blob_open_opts, field) + sizeof(src->field) <= src->opts_size 8592 8593 #define SET_FIELD(field) \ 8594 if (FIELD_OK(field)) { \ 8595 dst->field = src->field; \ 8596 } \ 8597 8598 SET_FIELD(clear_method); 8599 SET_FIELD(esnap_ctx); 8600 8601 dst->opts_size = src->opts_size; 8602 8603 /* You should not remove this statement, but need to update the assert statement 8604 * if you add a new field, and also add a corresponding SET_FIELD statement */ 8605 SPDK_STATIC_ASSERT(sizeof(struct spdk_blob_open_opts) == 24, "Incorrect size"); 8606 8607 #undef FIELD_OK 8608 #undef SET_FIELD 8609 } 8610 8611 static void 8612 bs_open_blob(struct spdk_blob_store *bs, 8613 spdk_blob_id blobid, 8614 struct spdk_blob_open_opts *opts, 8615 spdk_blob_op_with_handle_complete cb_fn, 8616 void *cb_arg) 8617 { 8618 struct spdk_blob *blob; 8619 struct spdk_bs_cpl cpl; 8620 struct spdk_blob_open_opts opts_local; 8621 spdk_bs_sequence_t *seq; 8622 uint32_t page_num; 8623 8624 SPDK_DEBUGLOG(blob, "Opening blob 0x%" PRIx64 "\n", blobid); 8625 assert(spdk_get_thread() == bs->md_thread); 8626 8627 page_num = bs_blobid_to_page(blobid); 8628 if (spdk_bit_array_get(bs->used_blobids, page_num) == false) { 8629 /* Invalid blobid */ 8630 cb_fn(cb_arg, NULL, -ENOENT); 8631 return; 8632 } 8633 8634 blob = blob_lookup(bs, blobid); 8635 if (blob) { 8636 blob->open_ref++; 8637 cb_fn(cb_arg, blob, 0); 8638 return; 8639 } 8640 8641 blob = blob_alloc(bs, blobid); 8642 if (!blob) { 8643 cb_fn(cb_arg, NULL, -ENOMEM); 8644 return; 8645 } 8646 8647 spdk_blob_open_opts_init(&opts_local, sizeof(opts_local)); 8648 if (opts) { 8649 blob_open_opts_copy(opts, &opts_local); 8650 } 8651 8652 blob->clear_method = opts_local.clear_method; 8653 8654 cpl.type = SPDK_BS_CPL_TYPE_BLOB_HANDLE; 8655 cpl.u.blob_handle.cb_fn = cb_fn; 8656 cpl.u.blob_handle.cb_arg = cb_arg; 8657 cpl.u.blob_handle.blob = blob; 8658 cpl.u.blob_handle.esnap_ctx = opts_local.esnap_ctx; 8659 8660 seq = bs_sequence_start_bs(bs->md_channel, &cpl); 8661 if (!seq) { 8662 blob_free(blob); 8663 cb_fn(cb_arg, NULL, -ENOMEM); 8664 return; 8665 } 8666 8667 blob_load(seq, blob, bs_open_blob_cpl, blob); 8668 } 8669 8670 void 8671 spdk_bs_open_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 8672 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 8673 { 8674 bs_open_blob(bs, blobid, NULL, cb_fn, cb_arg); 8675 } 8676 8677 void 8678 spdk_bs_open_blob_ext(struct spdk_blob_store *bs, spdk_blob_id blobid, 8679 struct spdk_blob_open_opts *opts, spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 8680 { 8681 bs_open_blob(bs, blobid, opts, cb_fn, cb_arg); 8682 } 8683 8684 /* END spdk_bs_open_blob */ 8685 8686 /* START spdk_blob_set_read_only */ 8687 int 8688 spdk_blob_set_read_only(struct spdk_blob *blob) 8689 { 8690 blob_verify_md_op(blob); 8691 8692 blob->data_ro_flags |= SPDK_BLOB_READ_ONLY; 8693 8694 blob->state = SPDK_BLOB_STATE_DIRTY; 8695 return 0; 8696 } 8697 /* END spdk_blob_set_read_only */ 8698 8699 /* START spdk_blob_sync_md */ 8700 8701 static void 8702 blob_sync_md_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 8703 { 8704 struct spdk_blob *blob = cb_arg; 8705 8706 if (bserrno == 0 && (blob->data_ro_flags & SPDK_BLOB_READ_ONLY)) { 8707 blob->data_ro = true; 8708 blob->md_ro = true; 8709 } 8710 8711 bs_sequence_finish(seq, bserrno); 8712 } 8713 8714 static void 8715 blob_sync_md(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 8716 { 8717 struct spdk_bs_cpl cpl; 8718 spdk_bs_sequence_t *seq; 8719 8720 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 8721 cpl.u.blob_basic.cb_fn = cb_fn; 8722 cpl.u.blob_basic.cb_arg = cb_arg; 8723 8724 seq = bs_sequence_start_bs(blob->bs->md_channel, &cpl); 8725 if (!seq) { 8726 cb_fn(cb_arg, -ENOMEM); 8727 return; 8728 } 8729 8730 blob_persist(seq, blob, blob_sync_md_cpl, blob); 8731 } 8732 8733 void 8734 spdk_blob_sync_md(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 8735 { 8736 blob_verify_md_op(blob); 8737 8738 SPDK_DEBUGLOG(blob, "Syncing blob 0x%" PRIx64 "\n", blob->id); 8739 8740 if (blob->md_ro) { 8741 assert(blob->state == SPDK_BLOB_STATE_CLEAN); 8742 cb_fn(cb_arg, 0); 8743 return; 8744 } 8745 8746 blob_sync_md(blob, cb_fn, cb_arg); 8747 } 8748 8749 /* END spdk_blob_sync_md */ 8750 8751 struct spdk_blob_cluster_op_ctx { 8752 struct spdk_thread *thread; 8753 struct spdk_blob *blob; 8754 uint32_t cluster_num; /* cluster index in blob */ 8755 uint32_t cluster; /* cluster on disk */ 8756 uint32_t extent_page; /* extent page on disk */ 8757 struct spdk_blob_md_page *page; /* preallocated extent page */ 8758 int rc; 8759 spdk_blob_op_complete cb_fn; 8760 void *cb_arg; 8761 }; 8762 8763 static void 8764 blob_op_cluster_msg_cpl(void *arg) 8765 { 8766 struct spdk_blob_cluster_op_ctx *ctx = arg; 8767 8768 ctx->cb_fn(ctx->cb_arg, ctx->rc); 8769 free(ctx); 8770 } 8771 8772 static void 8773 blob_op_cluster_msg_cb(void *arg, int bserrno) 8774 { 8775 struct spdk_blob_cluster_op_ctx *ctx = arg; 8776 8777 ctx->rc = bserrno; 8778 spdk_thread_send_msg(ctx->thread, blob_op_cluster_msg_cpl, ctx); 8779 } 8780 8781 static void 8782 blob_insert_new_ep_cb(void *arg, int bserrno) 8783 { 8784 struct spdk_blob_cluster_op_ctx *ctx = arg; 8785 uint32_t *extent_page; 8786 8787 extent_page = bs_cluster_to_extent_page(ctx->blob, ctx->cluster_num); 8788 *extent_page = ctx->extent_page; 8789 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 8790 blob_sync_md(ctx->blob, blob_op_cluster_msg_cb, ctx); 8791 } 8792 8793 struct spdk_blob_write_extent_page_ctx { 8794 struct spdk_blob_store *bs; 8795 8796 uint32_t extent; 8797 struct spdk_blob_md_page *page; 8798 }; 8799 8800 static void 8801 blob_free_cluster_msg_cb(void *arg, int bserrno) 8802 { 8803 struct spdk_blob_cluster_op_ctx *ctx = arg; 8804 8805 spdk_spin_lock(&ctx->blob->bs->used_lock); 8806 bs_release_cluster(ctx->blob->bs, ctx->cluster); 8807 spdk_spin_unlock(&ctx->blob->bs->used_lock); 8808 8809 ctx->rc = bserrno; 8810 spdk_thread_send_msg(ctx->thread, blob_op_cluster_msg_cpl, ctx); 8811 } 8812 8813 static void 8814 blob_free_cluster_update_ep_cb(void *arg, int bserrno) 8815 { 8816 struct spdk_blob_cluster_op_ctx *ctx = arg; 8817 8818 if (bserrno != 0 || ctx->blob->bs->clean == 0) { 8819 blob_free_cluster_msg_cb(ctx, bserrno); 8820 return; 8821 } 8822 8823 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 8824 blob_sync_md(ctx->blob, blob_free_cluster_msg_cb, ctx); 8825 } 8826 8827 static void 8828 blob_free_cluster_free_ep_cb(void *arg, int bserrno) 8829 { 8830 struct spdk_blob_cluster_op_ctx *ctx = arg; 8831 8832 spdk_spin_lock(&ctx->blob->bs->used_lock); 8833 assert(spdk_bit_array_get(ctx->blob->bs->used_md_pages, ctx->extent_page) == true); 8834 bs_release_md_page(ctx->blob->bs, ctx->extent_page); 8835 spdk_spin_unlock(&ctx->blob->bs->used_lock); 8836 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 8837 blob_sync_md(ctx->blob, blob_free_cluster_msg_cb, ctx); 8838 } 8839 8840 static void 8841 blob_persist_extent_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 8842 { 8843 struct spdk_blob_write_extent_page_ctx *ctx = cb_arg; 8844 8845 free(ctx); 8846 bs_sequence_finish(seq, bserrno); 8847 } 8848 8849 static void 8850 blob_write_extent_page_ready(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 8851 { 8852 struct spdk_blob_write_extent_page_ctx *ctx = cb_arg; 8853 8854 if (bserrno != 0) { 8855 blob_persist_extent_page_cpl(seq, ctx, bserrno); 8856 return; 8857 } 8858 bs_sequence_write_dev(seq, ctx->page, bs_md_page_to_lba(ctx->bs, ctx->extent), 8859 bs_byte_to_lba(ctx->bs, ctx->bs->md_page_size), 8860 blob_persist_extent_page_cpl, ctx); 8861 } 8862 8863 static void 8864 blob_write_extent_page(struct spdk_blob *blob, uint32_t extent, uint64_t cluster_num, 8865 struct spdk_blob_md_page *page, spdk_blob_op_complete cb_fn, void *cb_arg) 8866 { 8867 struct spdk_blob_write_extent_page_ctx *ctx; 8868 spdk_bs_sequence_t *seq; 8869 struct spdk_bs_cpl cpl; 8870 8871 ctx = calloc(1, sizeof(*ctx)); 8872 if (!ctx) { 8873 cb_fn(cb_arg, -ENOMEM); 8874 return; 8875 } 8876 ctx->bs = blob->bs; 8877 ctx->extent = extent; 8878 ctx->page = page; 8879 8880 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 8881 cpl.u.blob_basic.cb_fn = cb_fn; 8882 cpl.u.blob_basic.cb_arg = cb_arg; 8883 8884 seq = bs_sequence_start_bs(blob->bs->md_channel, &cpl); 8885 if (!seq) { 8886 free(ctx); 8887 cb_fn(cb_arg, -ENOMEM); 8888 return; 8889 } 8890 8891 assert(page); 8892 page->next = SPDK_INVALID_MD_PAGE; 8893 page->id = blob->id; 8894 page->sequence_num = 0; 8895 8896 blob_serialize_extent_page(blob, cluster_num, page); 8897 8898 page->crc = blob_md_page_calc_crc(page); 8899 8900 assert(spdk_bit_array_get(blob->bs->used_md_pages, extent) == true); 8901 8902 bs_mark_dirty(seq, blob->bs, blob_write_extent_page_ready, ctx); 8903 } 8904 8905 static void 8906 blob_insert_cluster_msg(void *arg) 8907 { 8908 struct spdk_blob_cluster_op_ctx *ctx = arg; 8909 uint32_t *extent_page; 8910 8911 ctx->rc = blob_insert_cluster(ctx->blob, ctx->cluster_num, ctx->cluster); 8912 if (ctx->rc != 0) { 8913 spdk_thread_send_msg(ctx->thread, blob_op_cluster_msg_cpl, ctx); 8914 return; 8915 } 8916 8917 if (ctx->blob->use_extent_table == false) { 8918 /* Extent table is not used, proceed with sync of md that will only use extents_rle. */ 8919 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 8920 blob_sync_md(ctx->blob, blob_op_cluster_msg_cb, ctx); 8921 return; 8922 } 8923 8924 extent_page = bs_cluster_to_extent_page(ctx->blob, ctx->cluster_num); 8925 if (*extent_page == 0) { 8926 /* Extent page requires allocation. 8927 * It was already claimed in the used_md_pages map and placed in ctx. */ 8928 assert(ctx->extent_page != 0); 8929 assert(spdk_bit_array_get(ctx->blob->bs->used_md_pages, ctx->extent_page) == true); 8930 blob_write_extent_page(ctx->blob, ctx->extent_page, ctx->cluster_num, ctx->page, 8931 blob_insert_new_ep_cb, ctx); 8932 } else { 8933 /* It is possible for original thread to allocate extent page for 8934 * different cluster in the same extent page. In such case proceed with 8935 * updating the existing extent page, but release the additional one. */ 8936 if (ctx->extent_page != 0) { 8937 spdk_spin_lock(&ctx->blob->bs->used_lock); 8938 assert(spdk_bit_array_get(ctx->blob->bs->used_md_pages, ctx->extent_page) == true); 8939 bs_release_md_page(ctx->blob->bs, ctx->extent_page); 8940 spdk_spin_unlock(&ctx->blob->bs->used_lock); 8941 ctx->extent_page = 0; 8942 } 8943 /* Extent page already allocated. 8944 * Every cluster allocation, requires just an update of single extent page. */ 8945 blob_write_extent_page(ctx->blob, *extent_page, ctx->cluster_num, ctx->page, 8946 blob_op_cluster_msg_cb, ctx); 8947 } 8948 } 8949 8950 static void 8951 blob_insert_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 8952 uint64_t cluster, uint32_t extent_page, struct spdk_blob_md_page *page, 8953 spdk_blob_op_complete cb_fn, void *cb_arg) 8954 { 8955 struct spdk_blob_cluster_op_ctx *ctx; 8956 8957 ctx = calloc(1, sizeof(*ctx)); 8958 if (ctx == NULL) { 8959 cb_fn(cb_arg, -ENOMEM); 8960 return; 8961 } 8962 8963 ctx->thread = spdk_get_thread(); 8964 ctx->blob = blob; 8965 ctx->cluster_num = cluster_num; 8966 ctx->cluster = cluster; 8967 ctx->extent_page = extent_page; 8968 ctx->page = page; 8969 ctx->cb_fn = cb_fn; 8970 ctx->cb_arg = cb_arg; 8971 8972 spdk_thread_send_msg(blob->bs->md_thread, blob_insert_cluster_msg, ctx); 8973 } 8974 8975 static void 8976 blob_free_cluster_msg(void *arg) 8977 { 8978 struct spdk_blob_cluster_op_ctx *ctx = arg; 8979 uint32_t *extent_page; 8980 uint32_t start_cluster_idx; 8981 bool free_extent_page = true; 8982 size_t i; 8983 8984 ctx->cluster = bs_lba_to_cluster(ctx->blob->bs, ctx->blob->active.clusters[ctx->cluster_num]); 8985 8986 /* There were concurrent unmaps to the same cluster, only release the cluster on the first one */ 8987 if (ctx->cluster == 0) { 8988 blob_op_cluster_msg_cb(ctx, 0); 8989 return; 8990 } 8991 8992 ctx->blob->active.clusters[ctx->cluster_num] = 0; 8993 if (ctx->cluster != 0) { 8994 ctx->blob->active.num_allocated_clusters--; 8995 } 8996 8997 if (ctx->blob->use_extent_table == false) { 8998 /* Extent table is not used, proceed with sync of md that will only use extents_rle. */ 8999 spdk_spin_lock(&ctx->blob->bs->used_lock); 9000 bs_release_cluster(ctx->blob->bs, ctx->cluster); 9001 spdk_spin_unlock(&ctx->blob->bs->used_lock); 9002 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 9003 blob_sync_md(ctx->blob, blob_op_cluster_msg_cb, ctx); 9004 return; 9005 } 9006 9007 extent_page = bs_cluster_to_extent_page(ctx->blob, ctx->cluster_num); 9008 9009 /* There shouldn't be parallel release operations on same cluster */ 9010 assert(*extent_page == ctx->extent_page); 9011 9012 start_cluster_idx = (ctx->cluster_num / SPDK_EXTENTS_PER_EP) * SPDK_EXTENTS_PER_EP; 9013 for (i = 0; i < SPDK_EXTENTS_PER_EP; ++i) { 9014 if (ctx->blob->active.clusters[start_cluster_idx + i] != 0) { 9015 free_extent_page = false; 9016 break; 9017 } 9018 } 9019 9020 if (free_extent_page) { 9021 assert(ctx->extent_page != 0); 9022 assert(spdk_bit_array_get(ctx->blob->bs->used_md_pages, ctx->extent_page) == true); 9023 ctx->blob->active.extent_pages[bs_cluster_to_extent_table_id(ctx->cluster_num)] = 0; 9024 blob_write_extent_page(ctx->blob, ctx->extent_page, ctx->cluster_num, ctx->page, 9025 blob_free_cluster_free_ep_cb, ctx); 9026 } else { 9027 blob_write_extent_page(ctx->blob, *extent_page, ctx->cluster_num, ctx->page, 9028 blob_free_cluster_update_ep_cb, ctx); 9029 } 9030 } 9031 9032 9033 static void 9034 blob_free_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, uint32_t extent_page, 9035 struct spdk_blob_md_page *page, spdk_blob_op_complete cb_fn, void *cb_arg) 9036 { 9037 struct spdk_blob_cluster_op_ctx *ctx; 9038 9039 ctx = calloc(1, sizeof(*ctx)); 9040 if (ctx == NULL) { 9041 cb_fn(cb_arg, -ENOMEM); 9042 return; 9043 } 9044 9045 ctx->thread = spdk_get_thread(); 9046 ctx->blob = blob; 9047 ctx->cluster_num = cluster_num; 9048 ctx->extent_page = extent_page; 9049 ctx->page = page; 9050 ctx->cb_fn = cb_fn; 9051 ctx->cb_arg = cb_arg; 9052 9053 spdk_thread_send_msg(blob->bs->md_thread, blob_free_cluster_msg, ctx); 9054 } 9055 9056 /* START spdk_blob_close */ 9057 9058 static void 9059 blob_close_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9060 { 9061 struct spdk_blob *blob = cb_arg; 9062 9063 if (bserrno == 0) { 9064 blob->open_ref--; 9065 if (blob->open_ref == 0) { 9066 /* 9067 * Blobs with active.num_pages == 0 are deleted blobs. 9068 * these blobs are removed from the blob_store list 9069 * when the deletion process starts - so don't try to 9070 * remove them again. 9071 */ 9072 if (blob->active.num_pages > 0) { 9073 spdk_bit_array_clear(blob->bs->open_blobids, blob->id); 9074 RB_REMOVE(spdk_blob_tree, &blob->bs->open_blobs, blob); 9075 } 9076 blob_free(blob); 9077 } 9078 } 9079 9080 bs_sequence_finish(seq, bserrno); 9081 } 9082 9083 static void 9084 blob_close_esnap_done(void *cb_arg, struct spdk_blob *blob, int bserrno) 9085 { 9086 spdk_bs_sequence_t *seq = cb_arg; 9087 9088 if (bserrno != 0) { 9089 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": close failed with error %d\n", 9090 blob->id, bserrno); 9091 bs_sequence_finish(seq, bserrno); 9092 return; 9093 } 9094 9095 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": closed, syncing metadata on thread %s\n", 9096 blob->id, spdk_thread_get_name(spdk_get_thread())); 9097 9098 /* Sync metadata */ 9099 blob_persist(seq, blob, blob_close_cpl, blob); 9100 } 9101 9102 void 9103 spdk_blob_close(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 9104 { 9105 struct spdk_bs_cpl cpl; 9106 spdk_bs_sequence_t *seq; 9107 9108 blob_verify_md_op(blob); 9109 9110 SPDK_DEBUGLOG(blob, "Closing blob 0x%" PRIx64 "\n", blob->id); 9111 9112 if (blob->open_ref == 0) { 9113 cb_fn(cb_arg, -EBADF); 9114 return; 9115 } 9116 9117 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 9118 cpl.u.blob_basic.cb_fn = cb_fn; 9119 cpl.u.blob_basic.cb_arg = cb_arg; 9120 9121 seq = bs_sequence_start_bs(blob->bs->md_channel, &cpl); 9122 if (!seq) { 9123 cb_fn(cb_arg, -ENOMEM); 9124 return; 9125 } 9126 9127 if (blob->open_ref == 1 && blob_is_esnap_clone(blob)) { 9128 blob_esnap_destroy_bs_dev_channels(blob, false, blob_close_esnap_done, seq); 9129 return; 9130 } 9131 9132 /* Sync metadata */ 9133 blob_persist(seq, blob, blob_close_cpl, blob); 9134 } 9135 9136 /* END spdk_blob_close */ 9137 9138 struct spdk_io_channel *spdk_bs_alloc_io_channel(struct spdk_blob_store *bs) 9139 { 9140 return spdk_get_io_channel(bs); 9141 } 9142 9143 void 9144 spdk_bs_free_io_channel(struct spdk_io_channel *channel) 9145 { 9146 blob_esnap_destroy_bs_channel(spdk_io_channel_get_ctx(channel)); 9147 spdk_put_io_channel(channel); 9148 } 9149 9150 void 9151 spdk_blob_io_unmap(struct spdk_blob *blob, struct spdk_io_channel *channel, 9152 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg) 9153 { 9154 blob_request_submit_op(blob, channel, NULL, offset, length, cb_fn, cb_arg, 9155 SPDK_BLOB_UNMAP); 9156 } 9157 9158 void 9159 spdk_blob_io_write_zeroes(struct spdk_blob *blob, struct spdk_io_channel *channel, 9160 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg) 9161 { 9162 blob_request_submit_op(blob, channel, NULL, offset, length, cb_fn, cb_arg, 9163 SPDK_BLOB_WRITE_ZEROES); 9164 } 9165 9166 void 9167 spdk_blob_io_write(struct spdk_blob *blob, struct spdk_io_channel *channel, 9168 void *payload, uint64_t offset, uint64_t length, 9169 spdk_blob_op_complete cb_fn, void *cb_arg) 9170 { 9171 blob_request_submit_op(blob, channel, payload, offset, length, cb_fn, cb_arg, 9172 SPDK_BLOB_WRITE); 9173 } 9174 9175 void 9176 spdk_blob_io_read(struct spdk_blob *blob, struct spdk_io_channel *channel, 9177 void *payload, uint64_t offset, uint64_t length, 9178 spdk_blob_op_complete cb_fn, void *cb_arg) 9179 { 9180 blob_request_submit_op(blob, channel, payload, offset, length, cb_fn, cb_arg, 9181 SPDK_BLOB_READ); 9182 } 9183 9184 void 9185 spdk_blob_io_writev(struct spdk_blob *blob, struct spdk_io_channel *channel, 9186 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 9187 spdk_blob_op_complete cb_fn, void *cb_arg) 9188 { 9189 blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, false, NULL); 9190 } 9191 9192 void 9193 spdk_blob_io_readv(struct spdk_blob *blob, struct spdk_io_channel *channel, 9194 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 9195 spdk_blob_op_complete cb_fn, void *cb_arg) 9196 { 9197 blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, true, NULL); 9198 } 9199 9200 void 9201 spdk_blob_io_writev_ext(struct spdk_blob *blob, struct spdk_io_channel *channel, 9202 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 9203 spdk_blob_op_complete cb_fn, void *cb_arg, struct spdk_blob_ext_io_opts *io_opts) 9204 { 9205 blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, false, 9206 io_opts); 9207 } 9208 9209 void 9210 spdk_blob_io_readv_ext(struct spdk_blob *blob, struct spdk_io_channel *channel, 9211 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 9212 spdk_blob_op_complete cb_fn, void *cb_arg, struct spdk_blob_ext_io_opts *io_opts) 9213 { 9214 blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, true, 9215 io_opts); 9216 } 9217 9218 struct spdk_bs_iter_ctx { 9219 int64_t page_num; 9220 struct spdk_blob_store *bs; 9221 9222 spdk_blob_op_with_handle_complete cb_fn; 9223 void *cb_arg; 9224 }; 9225 9226 static void 9227 bs_iter_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 9228 { 9229 struct spdk_bs_iter_ctx *ctx = cb_arg; 9230 struct spdk_blob_store *bs = ctx->bs; 9231 spdk_blob_id id; 9232 9233 if (bserrno == 0) { 9234 ctx->cb_fn(ctx->cb_arg, _blob, bserrno); 9235 free(ctx); 9236 return; 9237 } 9238 9239 ctx->page_num++; 9240 ctx->page_num = spdk_bit_array_find_first_set(bs->used_blobids, ctx->page_num); 9241 if (ctx->page_num >= spdk_bit_array_capacity(bs->used_blobids)) { 9242 ctx->cb_fn(ctx->cb_arg, NULL, -ENOENT); 9243 free(ctx); 9244 return; 9245 } 9246 9247 id = bs_page_to_blobid(ctx->page_num); 9248 9249 spdk_bs_open_blob(bs, id, bs_iter_cpl, ctx); 9250 } 9251 9252 void 9253 spdk_bs_iter_first(struct spdk_blob_store *bs, 9254 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 9255 { 9256 struct spdk_bs_iter_ctx *ctx; 9257 9258 ctx = calloc(1, sizeof(*ctx)); 9259 if (!ctx) { 9260 cb_fn(cb_arg, NULL, -ENOMEM); 9261 return; 9262 } 9263 9264 ctx->page_num = -1; 9265 ctx->bs = bs; 9266 ctx->cb_fn = cb_fn; 9267 ctx->cb_arg = cb_arg; 9268 9269 bs_iter_cpl(ctx, NULL, -1); 9270 } 9271 9272 static void 9273 bs_iter_close_cpl(void *cb_arg, int bserrno) 9274 { 9275 struct spdk_bs_iter_ctx *ctx = cb_arg; 9276 9277 bs_iter_cpl(ctx, NULL, -1); 9278 } 9279 9280 void 9281 spdk_bs_iter_next(struct spdk_blob_store *bs, struct spdk_blob *blob, 9282 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 9283 { 9284 struct spdk_bs_iter_ctx *ctx; 9285 9286 assert(blob != NULL); 9287 9288 ctx = calloc(1, sizeof(*ctx)); 9289 if (!ctx) { 9290 cb_fn(cb_arg, NULL, -ENOMEM); 9291 return; 9292 } 9293 9294 ctx->page_num = bs_blobid_to_page(blob->id); 9295 ctx->bs = bs; 9296 ctx->cb_fn = cb_fn; 9297 ctx->cb_arg = cb_arg; 9298 9299 /* Close the existing blob */ 9300 spdk_blob_close(blob, bs_iter_close_cpl, ctx); 9301 } 9302 9303 static int 9304 blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 9305 uint16_t value_len, bool internal) 9306 { 9307 struct spdk_xattr_tailq *xattrs; 9308 struct spdk_xattr *xattr; 9309 size_t desc_size; 9310 void *tmp; 9311 9312 blob_verify_md_op(blob); 9313 9314 if (blob->md_ro) { 9315 return -EPERM; 9316 } 9317 9318 desc_size = sizeof(struct spdk_blob_md_descriptor_xattr) + strlen(name) + value_len; 9319 if (desc_size > SPDK_BS_MAX_DESC_SIZE) { 9320 SPDK_DEBUGLOG(blob, "Xattr '%s' of size %zu does not fix into single page %zu\n", name, 9321 desc_size, SPDK_BS_MAX_DESC_SIZE); 9322 return -ENOMEM; 9323 } 9324 9325 if (internal) { 9326 xattrs = &blob->xattrs_internal; 9327 blob->invalid_flags |= SPDK_BLOB_INTERNAL_XATTR; 9328 } else { 9329 xattrs = &blob->xattrs; 9330 } 9331 9332 TAILQ_FOREACH(xattr, xattrs, link) { 9333 if (!strcmp(name, xattr->name)) { 9334 tmp = malloc(value_len); 9335 if (!tmp) { 9336 return -ENOMEM; 9337 } 9338 9339 free(xattr->value); 9340 xattr->value_len = value_len; 9341 xattr->value = tmp; 9342 memcpy(xattr->value, value, value_len); 9343 9344 blob->state = SPDK_BLOB_STATE_DIRTY; 9345 9346 return 0; 9347 } 9348 } 9349 9350 xattr = calloc(1, sizeof(*xattr)); 9351 if (!xattr) { 9352 return -ENOMEM; 9353 } 9354 9355 xattr->name = strdup(name); 9356 if (!xattr->name) { 9357 free(xattr); 9358 return -ENOMEM; 9359 } 9360 9361 xattr->value_len = value_len; 9362 xattr->value = malloc(value_len); 9363 if (!xattr->value) { 9364 free(xattr->name); 9365 free(xattr); 9366 return -ENOMEM; 9367 } 9368 memcpy(xattr->value, value, value_len); 9369 TAILQ_INSERT_TAIL(xattrs, xattr, link); 9370 9371 blob->state = SPDK_BLOB_STATE_DIRTY; 9372 9373 return 0; 9374 } 9375 9376 int 9377 spdk_blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 9378 uint16_t value_len) 9379 { 9380 return blob_set_xattr(blob, name, value, value_len, false); 9381 } 9382 9383 static int 9384 blob_remove_xattr(struct spdk_blob *blob, const char *name, bool internal) 9385 { 9386 struct spdk_xattr_tailq *xattrs; 9387 struct spdk_xattr *xattr; 9388 9389 blob_verify_md_op(blob); 9390 9391 if (blob->md_ro) { 9392 return -EPERM; 9393 } 9394 xattrs = internal ? &blob->xattrs_internal : &blob->xattrs; 9395 9396 TAILQ_FOREACH(xattr, xattrs, link) { 9397 if (!strcmp(name, xattr->name)) { 9398 TAILQ_REMOVE(xattrs, xattr, link); 9399 free(xattr->value); 9400 free(xattr->name); 9401 free(xattr); 9402 9403 if (internal && TAILQ_EMPTY(&blob->xattrs_internal)) { 9404 blob->invalid_flags &= ~SPDK_BLOB_INTERNAL_XATTR; 9405 } 9406 blob->state = SPDK_BLOB_STATE_DIRTY; 9407 9408 return 0; 9409 } 9410 } 9411 9412 return -ENOENT; 9413 } 9414 9415 int 9416 spdk_blob_remove_xattr(struct spdk_blob *blob, const char *name) 9417 { 9418 return blob_remove_xattr(blob, name, false); 9419 } 9420 9421 static int 9422 blob_get_xattr_value(struct spdk_blob *blob, const char *name, 9423 const void **value, size_t *value_len, bool internal) 9424 { 9425 struct spdk_xattr *xattr; 9426 struct spdk_xattr_tailq *xattrs; 9427 9428 xattrs = internal ? &blob->xattrs_internal : &blob->xattrs; 9429 9430 TAILQ_FOREACH(xattr, xattrs, link) { 9431 if (!strcmp(name, xattr->name)) { 9432 *value = xattr->value; 9433 *value_len = xattr->value_len; 9434 return 0; 9435 } 9436 } 9437 return -ENOENT; 9438 } 9439 9440 int 9441 spdk_blob_get_xattr_value(struct spdk_blob *blob, const char *name, 9442 const void **value, size_t *value_len) 9443 { 9444 blob_verify_md_op(blob); 9445 9446 return blob_get_xattr_value(blob, name, value, value_len, false); 9447 } 9448 9449 struct spdk_xattr_names { 9450 uint32_t count; 9451 const char *names[0]; 9452 }; 9453 9454 static int 9455 blob_get_xattr_names(struct spdk_xattr_tailq *xattrs, struct spdk_xattr_names **names) 9456 { 9457 struct spdk_xattr *xattr; 9458 int count = 0; 9459 9460 TAILQ_FOREACH(xattr, xattrs, link) { 9461 count++; 9462 } 9463 9464 *names = calloc(1, sizeof(struct spdk_xattr_names) + count * sizeof(char *)); 9465 if (*names == NULL) { 9466 return -ENOMEM; 9467 } 9468 9469 TAILQ_FOREACH(xattr, xattrs, link) { 9470 (*names)->names[(*names)->count++] = xattr->name; 9471 } 9472 9473 return 0; 9474 } 9475 9476 int 9477 spdk_blob_get_xattr_names(struct spdk_blob *blob, struct spdk_xattr_names **names) 9478 { 9479 blob_verify_md_op(blob); 9480 9481 return blob_get_xattr_names(&blob->xattrs, names); 9482 } 9483 9484 uint32_t 9485 spdk_xattr_names_get_count(struct spdk_xattr_names *names) 9486 { 9487 assert(names != NULL); 9488 9489 return names->count; 9490 } 9491 9492 const char * 9493 spdk_xattr_names_get_name(struct spdk_xattr_names *names, uint32_t index) 9494 { 9495 if (index >= names->count) { 9496 return NULL; 9497 } 9498 9499 return names->names[index]; 9500 } 9501 9502 void 9503 spdk_xattr_names_free(struct spdk_xattr_names *names) 9504 { 9505 free(names); 9506 } 9507 9508 struct spdk_bs_type 9509 spdk_bs_get_bstype(struct spdk_blob_store *bs) 9510 { 9511 return bs->bstype; 9512 } 9513 9514 void 9515 spdk_bs_set_bstype(struct spdk_blob_store *bs, struct spdk_bs_type bstype) 9516 { 9517 memcpy(&bs->bstype, &bstype, sizeof(bstype)); 9518 } 9519 9520 bool 9521 spdk_blob_is_read_only(struct spdk_blob *blob) 9522 { 9523 assert(blob != NULL); 9524 return (blob->data_ro || blob->md_ro); 9525 } 9526 9527 bool 9528 spdk_blob_is_snapshot(struct spdk_blob *blob) 9529 { 9530 struct spdk_blob_list *snapshot_entry; 9531 9532 assert(blob != NULL); 9533 9534 snapshot_entry = bs_get_snapshot_entry(blob->bs, blob->id); 9535 if (snapshot_entry == NULL) { 9536 return false; 9537 } 9538 9539 return true; 9540 } 9541 9542 bool 9543 spdk_blob_is_clone(struct spdk_blob *blob) 9544 { 9545 assert(blob != NULL); 9546 9547 if (blob->parent_id != SPDK_BLOBID_INVALID && 9548 blob->parent_id != SPDK_BLOBID_EXTERNAL_SNAPSHOT) { 9549 assert(spdk_blob_is_thin_provisioned(blob)); 9550 return true; 9551 } 9552 9553 return false; 9554 } 9555 9556 bool 9557 spdk_blob_is_thin_provisioned(struct spdk_blob *blob) 9558 { 9559 assert(blob != NULL); 9560 return !!(blob->invalid_flags & SPDK_BLOB_THIN_PROV); 9561 } 9562 9563 bool 9564 spdk_blob_is_esnap_clone(const struct spdk_blob *blob) 9565 { 9566 return blob_is_esnap_clone(blob); 9567 } 9568 9569 static void 9570 blob_update_clear_method(struct spdk_blob *blob) 9571 { 9572 enum blob_clear_method stored_cm; 9573 9574 assert(blob != NULL); 9575 9576 /* If BLOB_CLEAR_WITH_DEFAULT was passed in, use the setting stored 9577 * in metadata previously. If something other than the default was 9578 * specified, ignore stored value and used what was passed in. 9579 */ 9580 stored_cm = ((blob->md_ro_flags & SPDK_BLOB_CLEAR_METHOD) >> SPDK_BLOB_CLEAR_METHOD_SHIFT); 9581 9582 if (blob->clear_method == BLOB_CLEAR_WITH_DEFAULT) { 9583 blob->clear_method = stored_cm; 9584 } else if (blob->clear_method != stored_cm) { 9585 SPDK_WARNLOG("Using passed in clear method 0x%x instead of stored value of 0x%x\n", 9586 blob->clear_method, stored_cm); 9587 } 9588 } 9589 9590 spdk_blob_id 9591 spdk_blob_get_parent_snapshot(struct spdk_blob_store *bs, spdk_blob_id blob_id) 9592 { 9593 struct spdk_blob_list *snapshot_entry = NULL; 9594 struct spdk_blob_list *clone_entry = NULL; 9595 9596 TAILQ_FOREACH(snapshot_entry, &bs->snapshots, link) { 9597 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 9598 if (clone_entry->id == blob_id) { 9599 return snapshot_entry->id; 9600 } 9601 } 9602 } 9603 9604 return SPDK_BLOBID_INVALID; 9605 } 9606 9607 int 9608 spdk_blob_get_clones(struct spdk_blob_store *bs, spdk_blob_id blobid, spdk_blob_id *ids, 9609 size_t *count) 9610 { 9611 struct spdk_blob_list *snapshot_entry, *clone_entry; 9612 size_t n; 9613 9614 snapshot_entry = bs_get_snapshot_entry(bs, blobid); 9615 if (snapshot_entry == NULL) { 9616 *count = 0; 9617 return 0; 9618 } 9619 9620 if (ids == NULL || *count < snapshot_entry->clone_count) { 9621 *count = snapshot_entry->clone_count; 9622 return -ENOMEM; 9623 } 9624 *count = snapshot_entry->clone_count; 9625 9626 n = 0; 9627 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 9628 ids[n++] = clone_entry->id; 9629 } 9630 9631 return 0; 9632 } 9633 9634 static void 9635 bs_load_grow_continue(struct spdk_bs_load_ctx *ctx) 9636 { 9637 int rc; 9638 9639 if (ctx->super->size == 0) { 9640 ctx->super->size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 9641 } 9642 9643 if (ctx->super->io_unit_size == 0) { 9644 ctx->super->io_unit_size = SPDK_BS_PAGE_SIZE; 9645 } 9646 if (ctx->super->md_page_size == 0) { 9647 ctx->super->md_page_size = SPDK_BS_PAGE_SIZE; 9648 } 9649 9650 /* Parse the super block */ 9651 ctx->bs->clean = 1; 9652 ctx->bs->cluster_sz = ctx->super->cluster_size; 9653 ctx->bs->total_clusters = ctx->super->size / ctx->super->cluster_size; 9654 ctx->bs->md_page_size = ctx->super->md_page_size; 9655 ctx->bs->io_unit_size = ctx->super->io_unit_size; 9656 bs_init_per_cluster_fields(ctx->bs); 9657 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->bs->total_clusters); 9658 if (rc < 0) { 9659 bs_load_ctx_fail(ctx, -ENOMEM); 9660 return; 9661 } 9662 ctx->bs->md_start = ctx->super->md_start; 9663 ctx->bs->md_len = ctx->super->md_len; 9664 rc = spdk_bit_array_resize(&ctx->bs->open_blobids, ctx->bs->md_len); 9665 if (rc < 0) { 9666 bs_load_ctx_fail(ctx, -ENOMEM); 9667 return; 9668 } 9669 9670 ctx->bs->total_data_clusters = ctx->bs->total_clusters - spdk_divide_round_up( 9671 ctx->bs->md_start + ctx->bs->md_len, ctx->bs->pages_per_cluster); 9672 ctx->bs->super_blob = ctx->super->super_blob; 9673 memcpy(&ctx->bs->bstype, &ctx->super->bstype, sizeof(ctx->super->bstype)); 9674 9675 if (ctx->super->used_blobid_mask_len == 0 || ctx->super->clean == 0) { 9676 SPDK_ERRLOG("Can not grow an unclean blobstore, please load it normally to clean it.\n"); 9677 bs_load_ctx_fail(ctx, -EIO); 9678 return; 9679 } else { 9680 bs_load_read_used_pages(ctx); 9681 } 9682 } 9683 9684 static void 9685 bs_load_grow_super_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9686 { 9687 struct spdk_bs_load_ctx *ctx = cb_arg; 9688 9689 if (bserrno != 0) { 9690 bs_load_ctx_fail(ctx, bserrno); 9691 return; 9692 } 9693 bs_load_grow_continue(ctx); 9694 } 9695 9696 static void 9697 bs_load_grow_used_clusters_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9698 { 9699 struct spdk_bs_load_ctx *ctx = cb_arg; 9700 9701 if (bserrno != 0) { 9702 bs_load_ctx_fail(ctx, bserrno); 9703 return; 9704 } 9705 9706 spdk_free(ctx->mask); 9707 9708 bs_sequence_write_dev(ctx->seq, ctx->super, bs_page_to_lba(ctx->bs, 0), 9709 bs_byte_to_lba(ctx->bs, sizeof(*ctx->super)), 9710 bs_load_grow_super_write_cpl, ctx); 9711 } 9712 9713 static void 9714 bs_load_grow_used_clusters_read_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9715 { 9716 struct spdk_bs_load_ctx *ctx = cb_arg; 9717 uint64_t lba, lba_count; 9718 uint64_t dev_size; 9719 uint64_t total_clusters; 9720 9721 if (bserrno != 0) { 9722 bs_load_ctx_fail(ctx, bserrno); 9723 return; 9724 } 9725 9726 /* The type must be correct */ 9727 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_CLUSTERS); 9728 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 9729 assert(ctx->mask->length <= (ctx->super->used_cluster_mask_len * sizeof( 9730 struct spdk_blob_md_page) * 8)); 9731 dev_size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 9732 total_clusters = dev_size / ctx->super->cluster_size; 9733 ctx->mask->length = total_clusters; 9734 9735 lba = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 9736 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 9737 bs_sequence_write_dev(ctx->seq, ctx->mask, lba, lba_count, 9738 bs_load_grow_used_clusters_write_cpl, ctx); 9739 } 9740 9741 static void 9742 bs_load_try_to_grow(struct spdk_bs_load_ctx *ctx) 9743 { 9744 uint64_t dev_size, total_clusters, used_cluster_mask_len, max_used_cluster_mask; 9745 uint64_t lba, lba_count, mask_size; 9746 9747 dev_size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 9748 total_clusters = dev_size / ctx->super->cluster_size; 9749 used_cluster_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 9750 spdk_divide_round_up(total_clusters, 8), 9751 ctx->super->md_page_size); 9752 max_used_cluster_mask = ctx->super->used_blobid_mask_start - ctx->super->used_cluster_mask_start; 9753 /* No necessary to grow or no space to grow */ 9754 if (ctx->super->size >= dev_size || used_cluster_mask_len > max_used_cluster_mask) { 9755 SPDK_DEBUGLOG(blob, "No grow\n"); 9756 bs_load_grow_continue(ctx); 9757 return; 9758 } 9759 9760 SPDK_DEBUGLOG(blob, "Resize blobstore\n"); 9761 9762 ctx->super->size = dev_size; 9763 ctx->super->used_cluster_mask_len = used_cluster_mask_len; 9764 ctx->super->crc = blob_md_page_calc_crc(ctx->super); 9765 9766 mask_size = used_cluster_mask_len * ctx->super->md_page_size; 9767 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_NUMA_ID_ANY, 9768 SPDK_MALLOC_DMA); 9769 if (!ctx->mask) { 9770 bs_load_ctx_fail(ctx, -ENOMEM); 9771 return; 9772 } 9773 lba = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 9774 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 9775 bs_sequence_read_dev(ctx->seq, ctx->mask, lba, lba_count, 9776 bs_load_grow_used_clusters_read_cpl, ctx); 9777 } 9778 9779 static void 9780 bs_grow_load_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9781 { 9782 struct spdk_bs_load_ctx *ctx = cb_arg; 9783 int rc; 9784 9785 rc = bs_super_validate(ctx->super, ctx->bs); 9786 if (rc != 0) { 9787 bs_load_ctx_fail(ctx, rc); 9788 return; 9789 } 9790 9791 bs_load_try_to_grow(ctx); 9792 } 9793 9794 struct spdk_bs_grow_ctx { 9795 struct spdk_blob_store *bs; 9796 struct spdk_bs_super_block *super; 9797 9798 struct spdk_bit_pool *new_used_clusters; 9799 struct spdk_bs_md_mask *new_used_clusters_mask; 9800 9801 spdk_bs_sequence_t *seq; 9802 }; 9803 9804 static void 9805 bs_grow_live_done(struct spdk_bs_grow_ctx *ctx, int bserrno) 9806 { 9807 if (bserrno != 0) { 9808 spdk_bit_pool_free(&ctx->new_used_clusters); 9809 } 9810 9811 bs_sequence_finish(ctx->seq, bserrno); 9812 free(ctx->new_used_clusters_mask); 9813 spdk_free(ctx->super); 9814 free(ctx); 9815 } 9816 9817 static void 9818 bs_grow_live_super_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9819 { 9820 struct spdk_bs_grow_ctx *ctx = cb_arg; 9821 struct spdk_blob_store *bs = ctx->bs; 9822 uint64_t total_clusters; 9823 9824 if (bserrno != 0) { 9825 bs_grow_live_done(ctx, bserrno); 9826 return; 9827 } 9828 9829 /* 9830 * Blobstore is not clean until unload, for now only the super block is up to date. 9831 * This is similar to state right after blobstore init, when bs_write_used_md() didn't 9832 * yet execute. 9833 * When cleanly unloaded, the used md pages will be written out. 9834 * In case of unclean shutdown, loading blobstore will go through recovery path correctly 9835 * filling out the used_clusters with new size and writing it out. 9836 */ 9837 bs->clean = 0; 9838 9839 /* Reverting the super->size past this point is complex, avoid any error paths 9840 * that require to do so. */ 9841 spdk_spin_lock(&bs->used_lock); 9842 9843 total_clusters = ctx->super->size / ctx->super->cluster_size; 9844 9845 assert(total_clusters >= spdk_bit_pool_capacity(bs->used_clusters)); 9846 spdk_bit_pool_store_mask(bs->used_clusters, ctx->new_used_clusters_mask); 9847 9848 assert(total_clusters == spdk_bit_pool_capacity(ctx->new_used_clusters)); 9849 spdk_bit_pool_load_mask(ctx->new_used_clusters, ctx->new_used_clusters_mask); 9850 9851 spdk_bit_pool_free(&bs->used_clusters); 9852 bs->used_clusters = ctx->new_used_clusters; 9853 9854 bs->total_clusters = total_clusters; 9855 bs->total_data_clusters = bs->total_clusters - spdk_divide_round_up( 9856 bs->md_start + bs->md_len, bs->pages_per_cluster); 9857 9858 bs->num_free_clusters = spdk_bit_pool_count_free(bs->used_clusters); 9859 assert(ctx->bs->num_free_clusters <= ctx->bs->total_clusters); 9860 spdk_spin_unlock(&bs->used_lock); 9861 9862 bs_grow_live_done(ctx, 0); 9863 } 9864 9865 static void 9866 bs_grow_live_load_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 9867 { 9868 struct spdk_bs_grow_ctx *ctx = cb_arg; 9869 uint64_t dev_size, total_clusters, used_cluster_mask_len, max_used_cluster_mask; 9870 int rc; 9871 9872 if (bserrno != 0) { 9873 bs_grow_live_done(ctx, bserrno); 9874 return; 9875 } 9876 9877 rc = bs_super_validate(ctx->super, ctx->bs); 9878 if (rc != 0) { 9879 bs_grow_live_done(ctx, rc); 9880 return; 9881 } 9882 9883 dev_size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 9884 total_clusters = dev_size / ctx->super->cluster_size; 9885 used_cluster_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 9886 spdk_divide_round_up(total_clusters, 8), 9887 ctx->super->md_page_size); 9888 max_used_cluster_mask = ctx->super->used_blobid_mask_start - ctx->super->used_cluster_mask_start; 9889 /* Only checking dev_size. Since it can change, but total_clusters remain the same. */ 9890 if (dev_size == ctx->super->size) { 9891 SPDK_DEBUGLOG(blob, "No need to grow blobstore\n"); 9892 bs_grow_live_done(ctx, 0); 9893 return; 9894 } 9895 /* 9896 * Blobstore cannot be shrunk, so check before if: 9897 * - new size of the device is smaller than size in super_block 9898 * - new total number of clusters is smaller than used_clusters bit_pool 9899 * - there is enough space in metadata for used_cluster_mask to be written out 9900 */ 9901 if (dev_size < ctx->super->size || 9902 total_clusters < spdk_bit_pool_capacity(ctx->bs->used_clusters) || 9903 used_cluster_mask_len > max_used_cluster_mask) { 9904 SPDK_DEBUGLOG(blob, "No space to grow blobstore\n"); 9905 bs_grow_live_done(ctx, -ENOSPC); 9906 return; 9907 } 9908 9909 SPDK_DEBUGLOG(blob, "Resizing blobstore\n"); 9910 9911 ctx->new_used_clusters_mask = calloc(1, total_clusters); 9912 if (!ctx->new_used_clusters_mask) { 9913 bs_grow_live_done(ctx, -ENOMEM); 9914 return; 9915 } 9916 ctx->new_used_clusters = spdk_bit_pool_create(total_clusters); 9917 if (!ctx->new_used_clusters) { 9918 bs_grow_live_done(ctx, -ENOMEM); 9919 return; 9920 } 9921 9922 ctx->super->clean = 0; 9923 ctx->super->size = dev_size; 9924 ctx->super->used_cluster_mask_len = used_cluster_mask_len; 9925 bs_write_super(seq, ctx->bs, ctx->super, bs_grow_live_super_write_cpl, ctx); 9926 } 9927 9928 void 9929 spdk_bs_grow_live(struct spdk_blob_store *bs, 9930 spdk_bs_op_complete cb_fn, void *cb_arg) 9931 { 9932 struct spdk_bs_cpl cpl; 9933 struct spdk_bs_grow_ctx *ctx; 9934 9935 assert(spdk_get_thread() == bs->md_thread); 9936 9937 SPDK_DEBUGLOG(blob, "Growing blobstore on dev %p\n", bs->dev); 9938 9939 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 9940 cpl.u.bs_basic.cb_fn = cb_fn; 9941 cpl.u.bs_basic.cb_arg = cb_arg; 9942 9943 ctx = calloc(1, sizeof(struct spdk_bs_grow_ctx)); 9944 if (!ctx) { 9945 cb_fn(cb_arg, -ENOMEM); 9946 return; 9947 } 9948 ctx->bs = bs; 9949 9950 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 9951 SPDK_ENV_NUMA_ID_ANY, SPDK_MALLOC_DMA); 9952 if (!ctx->super) { 9953 free(ctx); 9954 cb_fn(cb_arg, -ENOMEM); 9955 return; 9956 } 9957 9958 ctx->seq = bs_sequence_start_bs(bs->md_channel, &cpl); 9959 if (!ctx->seq) { 9960 spdk_free(ctx->super); 9961 free(ctx); 9962 cb_fn(cb_arg, -ENOMEM); 9963 return; 9964 } 9965 9966 /* Read the super block */ 9967 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 9968 bs_byte_to_lba(bs, sizeof(*ctx->super)), 9969 bs_grow_live_load_super_cpl, ctx); 9970 } 9971 9972 void 9973 spdk_bs_grow(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 9974 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 9975 { 9976 struct spdk_blob_store *bs; 9977 struct spdk_bs_cpl cpl; 9978 struct spdk_bs_load_ctx *ctx; 9979 struct spdk_bs_opts opts = {}; 9980 int err; 9981 9982 SPDK_DEBUGLOG(blob, "Loading blobstore from dev %p\n", dev); 9983 9984 if ((dev->phys_blocklen % dev->blocklen) != 0) { 9985 SPDK_DEBUGLOG(blob, "unsupported dev block length of %d\n", dev->blocklen); 9986 dev->destroy(dev); 9987 cb_fn(cb_arg, NULL, -EINVAL); 9988 return; 9989 } 9990 9991 spdk_bs_opts_init(&opts, sizeof(opts)); 9992 if (o) { 9993 if (bs_opts_copy(o, &opts)) { 9994 dev->destroy(dev); 9995 cb_fn(cb_arg, NULL, -EINVAL); 9996 return; 9997 } 9998 } 9999 10000 if (opts.max_md_ops == 0 || opts.max_channel_ops == 0) { 10001 dev->destroy(dev); 10002 cb_fn(cb_arg, NULL, -EINVAL); 10003 return; 10004 } 10005 10006 err = bs_alloc(dev, &opts, &bs, &ctx); 10007 if (err) { 10008 dev->destroy(dev); 10009 cb_fn(cb_arg, NULL, err); 10010 return; 10011 } 10012 10013 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 10014 cpl.u.bs_handle.cb_fn = cb_fn; 10015 cpl.u.bs_handle.cb_arg = cb_arg; 10016 cpl.u.bs_handle.bs = bs; 10017 10018 ctx->seq = bs_sequence_start_bs(bs->md_channel, &cpl); 10019 if (!ctx->seq) { 10020 spdk_free(ctx->super); 10021 free(ctx); 10022 bs_free(bs); 10023 cb_fn(cb_arg, NULL, -ENOMEM); 10024 return; 10025 } 10026 10027 /* Read the super block */ 10028 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 10029 bs_byte_to_lba(bs, sizeof(*ctx->super)), 10030 bs_grow_load_super_cpl, ctx); 10031 } 10032 10033 int 10034 spdk_blob_get_esnap_id(struct spdk_blob *blob, const void **id, size_t *len) 10035 { 10036 if (!blob_is_esnap_clone(blob)) { 10037 return -EINVAL; 10038 } 10039 10040 return blob_get_xattr_value(blob, BLOB_EXTERNAL_SNAPSHOT_ID, id, len, true); 10041 } 10042 10043 struct spdk_io_channel * 10044 blob_esnap_get_io_channel(struct spdk_io_channel *ch, struct spdk_blob *blob) 10045 { 10046 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(ch); 10047 struct spdk_bs_dev *bs_dev = blob->back_bs_dev; 10048 struct blob_esnap_channel find = {}; 10049 struct blob_esnap_channel *esnap_channel, *existing; 10050 10051 find.blob_id = blob->id; 10052 esnap_channel = RB_FIND(blob_esnap_channel_tree, &bs_channel->esnap_channels, &find); 10053 if (spdk_likely(esnap_channel != NULL)) { 10054 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": using cached channel on thread %s\n", 10055 blob->id, spdk_thread_get_name(spdk_get_thread())); 10056 return esnap_channel->channel; 10057 } 10058 10059 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": allocating channel on thread %s\n", 10060 blob->id, spdk_thread_get_name(spdk_get_thread())); 10061 10062 esnap_channel = calloc(1, sizeof(*esnap_channel)); 10063 if (esnap_channel == NULL) { 10064 SPDK_NOTICELOG("blob 0x%" PRIx64 " channel allocation failed: no memory\n", 10065 find.blob_id); 10066 return NULL; 10067 } 10068 esnap_channel->channel = bs_dev->create_channel(bs_dev); 10069 if (esnap_channel->channel == NULL) { 10070 SPDK_NOTICELOG("blob 0x%" PRIx64 " back channel allocation failed\n", blob->id); 10071 free(esnap_channel); 10072 return NULL; 10073 } 10074 esnap_channel->blob_id = find.blob_id; 10075 existing = RB_INSERT(blob_esnap_channel_tree, &bs_channel->esnap_channels, esnap_channel); 10076 if (spdk_unlikely(existing != NULL)) { 10077 /* 10078 * This should be unreachable: all modifications to this tree happen on this thread. 10079 */ 10080 SPDK_ERRLOG("blob 0x%" PRIx64 "lost race to allocate a channel\n", find.blob_id); 10081 assert(false); 10082 10083 bs_dev->destroy_channel(bs_dev, esnap_channel->channel); 10084 free(esnap_channel); 10085 10086 return existing->channel; 10087 } 10088 10089 return esnap_channel->channel; 10090 } 10091 10092 static int 10093 blob_esnap_channel_compare(struct blob_esnap_channel *c1, struct blob_esnap_channel *c2) 10094 { 10095 return (c1->blob_id < c2->blob_id ? -1 : c1->blob_id > c2->blob_id); 10096 } 10097 10098 struct blob_esnap_destroy_ctx { 10099 spdk_blob_op_with_handle_complete cb_fn; 10100 void *cb_arg; 10101 struct spdk_blob *blob; 10102 struct spdk_bs_dev *back_bs_dev; 10103 bool abort_io; 10104 }; 10105 10106 static void 10107 blob_esnap_destroy_channels_done(struct spdk_io_channel_iter *i, int status) 10108 { 10109 struct blob_esnap_destroy_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 10110 struct spdk_blob *blob = ctx->blob; 10111 struct spdk_blob_store *bs = blob->bs; 10112 10113 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": done destroying channels for this blob\n", 10114 blob->id); 10115 10116 if (ctx->cb_fn != NULL) { 10117 ctx->cb_fn(ctx->cb_arg, blob, status); 10118 } 10119 free(ctx); 10120 10121 bs->esnap_channels_unloading--; 10122 if (bs->esnap_channels_unloading == 0 && bs->esnap_unload_cb_fn != NULL) { 10123 spdk_bs_unload(bs, bs->esnap_unload_cb_fn, bs->esnap_unload_cb_arg); 10124 } 10125 } 10126 10127 static void 10128 blob_esnap_destroy_one_channel(struct spdk_io_channel_iter *i) 10129 { 10130 struct blob_esnap_destroy_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 10131 struct spdk_blob *blob = ctx->blob; 10132 struct spdk_bs_dev *bs_dev = ctx->back_bs_dev; 10133 struct spdk_io_channel *channel = spdk_io_channel_iter_get_channel(i); 10134 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(channel); 10135 struct blob_esnap_channel *esnap_channel; 10136 struct blob_esnap_channel find = {}; 10137 10138 assert(spdk_get_thread() == spdk_io_channel_get_thread(channel)); 10139 10140 find.blob_id = blob->id; 10141 esnap_channel = RB_FIND(blob_esnap_channel_tree, &bs_channel->esnap_channels, &find); 10142 if (esnap_channel != NULL) { 10143 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": destroying channel on thread %s\n", 10144 blob->id, spdk_thread_get_name(spdk_get_thread())); 10145 RB_REMOVE(blob_esnap_channel_tree, &bs_channel->esnap_channels, esnap_channel); 10146 10147 if (ctx->abort_io) { 10148 spdk_bs_user_op_t *op, *tmp; 10149 10150 TAILQ_FOREACH_SAFE(op, &bs_channel->queued_io, link, tmp) { 10151 if (op->back_channel == esnap_channel->channel) { 10152 TAILQ_REMOVE(&bs_channel->queued_io, op, link); 10153 bs_user_op_abort(op, -EIO); 10154 } 10155 } 10156 } 10157 10158 bs_dev->destroy_channel(bs_dev, esnap_channel->channel); 10159 free(esnap_channel); 10160 } 10161 10162 spdk_for_each_channel_continue(i, 0); 10163 } 10164 10165 /* 10166 * Destroy the channels for a specific blob on each thread with a blobstore channel. This should be 10167 * used when closing an esnap clone blob and after decoupling from the parent. 10168 */ 10169 static void 10170 blob_esnap_destroy_bs_dev_channels(struct spdk_blob *blob, bool abort_io, 10171 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 10172 { 10173 struct blob_esnap_destroy_ctx *ctx; 10174 10175 if (!blob_is_esnap_clone(blob) || blob->back_bs_dev == NULL) { 10176 if (cb_fn != NULL) { 10177 cb_fn(cb_arg, blob, 0); 10178 } 10179 return; 10180 } 10181 10182 ctx = calloc(1, sizeof(*ctx)); 10183 if (ctx == NULL) { 10184 if (cb_fn != NULL) { 10185 cb_fn(cb_arg, blob, -ENOMEM); 10186 } 10187 return; 10188 } 10189 ctx->cb_fn = cb_fn; 10190 ctx->cb_arg = cb_arg; 10191 ctx->blob = blob; 10192 ctx->back_bs_dev = blob->back_bs_dev; 10193 ctx->abort_io = abort_io; 10194 10195 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 ": destroying channels for this blob\n", 10196 blob->id); 10197 10198 blob->bs->esnap_channels_unloading++; 10199 spdk_for_each_channel(blob->bs, blob_esnap_destroy_one_channel, ctx, 10200 blob_esnap_destroy_channels_done); 10201 } 10202 10203 /* 10204 * Destroy all bs_dev channels on a specific blobstore channel. This should be used when a 10205 * bs_channel is destroyed. 10206 */ 10207 static void 10208 blob_esnap_destroy_bs_channel(struct spdk_bs_channel *ch) 10209 { 10210 struct blob_esnap_channel *esnap_channel, *esnap_channel_tmp; 10211 10212 assert(spdk_get_thread() == spdk_io_channel_get_thread(spdk_io_channel_from_ctx(ch))); 10213 10214 SPDK_DEBUGLOG(blob_esnap, "destroying channels on thread %s\n", 10215 spdk_thread_get_name(spdk_get_thread())); 10216 RB_FOREACH_SAFE(esnap_channel, blob_esnap_channel_tree, &ch->esnap_channels, 10217 esnap_channel_tmp) { 10218 SPDK_DEBUGLOG(blob_esnap, "blob 0x%" PRIx64 10219 ": destroying one channel in thread %s\n", 10220 esnap_channel->blob_id, spdk_thread_get_name(spdk_get_thread())); 10221 RB_REMOVE(blob_esnap_channel_tree, &ch->esnap_channels, esnap_channel); 10222 spdk_put_io_channel(esnap_channel->channel); 10223 free(esnap_channel); 10224 } 10225 SPDK_DEBUGLOG(blob_esnap, "done destroying channels on thread %s\n", 10226 spdk_thread_get_name(spdk_get_thread())); 10227 } 10228 10229 static void 10230 blob_set_back_bs_dev_done(void *_ctx, int bserrno) 10231 { 10232 struct set_bs_dev_ctx *ctx = _ctx; 10233 10234 if (bserrno != 0) { 10235 /* Even though the unfreeze failed, the update may have succeed. */ 10236 SPDK_ERRLOG("blob 0x%" PRIx64 ": unfreeze failed with error %d\n", ctx->blob->id, 10237 bserrno); 10238 } 10239 ctx->cb_fn(ctx->cb_arg, ctx->bserrno); 10240 free(ctx); 10241 } 10242 10243 static void 10244 blob_frozen_set_back_bs_dev(void *_ctx, struct spdk_blob *blob, int bserrno) 10245 { 10246 struct set_bs_dev_ctx *ctx = _ctx; 10247 int rc; 10248 10249 if (bserrno != 0) { 10250 SPDK_ERRLOG("blob 0x%" PRIx64 ": failed to release old back_bs_dev with error %d\n", 10251 blob->id, bserrno); 10252 ctx->bserrno = bserrno; 10253 blob_unfreeze_io(blob, blob_set_back_bs_dev_done, ctx); 10254 return; 10255 } 10256 10257 if (blob->back_bs_dev != NULL) { 10258 blob_unref_back_bs_dev(blob); 10259 } 10260 10261 if (ctx->parent_refs_cb_fn) { 10262 rc = ctx->parent_refs_cb_fn(blob, ctx->parent_refs_cb_arg); 10263 if (rc != 0) { 10264 ctx->bserrno = rc; 10265 blob_unfreeze_io(blob, blob_set_back_bs_dev_done, ctx); 10266 return; 10267 } 10268 } 10269 10270 SPDK_NOTICELOG("blob 0x%" PRIx64 ": hotplugged back_bs_dev\n", blob->id); 10271 blob->back_bs_dev = ctx->back_bs_dev; 10272 ctx->bserrno = 0; 10273 10274 blob_unfreeze_io(blob, blob_set_back_bs_dev_done, ctx); 10275 } 10276 10277 static void 10278 blob_set_back_bs_dev_frozen(void *_ctx, int bserrno) 10279 { 10280 struct set_bs_dev_ctx *ctx = _ctx; 10281 struct spdk_blob *blob = ctx->blob; 10282 10283 if (bserrno != 0) { 10284 SPDK_ERRLOG("blob 0x%" PRIx64 ": failed to freeze with error %d\n", blob->id, 10285 bserrno); 10286 ctx->cb_fn(ctx->cb_arg, bserrno); 10287 free(ctx); 10288 return; 10289 } 10290 10291 /* 10292 * This does not prevent future reads from the esnap device because any future IO will 10293 * lazily create a new esnap IO channel. 10294 */ 10295 blob_esnap_destroy_bs_dev_channels(blob, true, blob_frozen_set_back_bs_dev, ctx); 10296 } 10297 10298 void 10299 spdk_blob_set_esnap_bs_dev(struct spdk_blob *blob, struct spdk_bs_dev *back_bs_dev, 10300 spdk_blob_op_complete cb_fn, void *cb_arg) 10301 { 10302 if (!blob_is_esnap_clone(blob)) { 10303 SPDK_ERRLOG("blob 0x%" PRIx64 ": not an esnap clone\n", blob->id); 10304 cb_fn(cb_arg, -EINVAL); 10305 return; 10306 } 10307 10308 blob_set_back_bs_dev(blob, back_bs_dev, NULL, NULL, cb_fn, cb_arg); 10309 } 10310 10311 struct spdk_bs_dev * 10312 spdk_blob_get_esnap_bs_dev(const struct spdk_blob *blob) 10313 { 10314 if (!blob_is_esnap_clone(blob)) { 10315 SPDK_ERRLOG("blob 0x%" PRIx64 ": not an esnap clone\n", blob->id); 10316 return NULL; 10317 } 10318 10319 return blob->back_bs_dev; 10320 } 10321 10322 bool 10323 spdk_blob_is_degraded(const struct spdk_blob *blob) 10324 { 10325 if (blob->bs->dev->is_degraded != NULL && blob->bs->dev->is_degraded(blob->bs->dev)) { 10326 return true; 10327 } 10328 if (blob->back_bs_dev == NULL || blob->back_bs_dev->is_degraded == NULL) { 10329 return false; 10330 } 10331 10332 return blob->back_bs_dev->is_degraded(blob->back_bs_dev); 10333 } 10334 10335 SPDK_LOG_REGISTER_COMPONENT(blob) 10336 SPDK_LOG_REGISTER_COMPONENT(blob_esnap) 10337 10338 static void 10339 blob_trace(void) 10340 { 10341 struct spdk_trace_tpoint_opts opts[] = { 10342 { 10343 "BLOB_REQ_SET_START", TRACE_BLOB_REQ_SET_START, 10344 OWNER_TYPE_NONE, OBJECT_BLOB_CB_ARG, 1, 10345 { 10346 { "ctx", SPDK_TRACE_ARG_TYPE_PTR, 8 } 10347 } 10348 }, 10349 { 10350 "BLOB_REQ_SET_COMPLETE", TRACE_BLOB_REQ_SET_COMPLETE, 10351 OWNER_TYPE_NONE, OBJECT_BLOB_CB_ARG, 0, 10352 { 10353 { "ctx", SPDK_TRACE_ARG_TYPE_PTR, 8 } 10354 } 10355 }, 10356 }; 10357 10358 spdk_trace_register_object(OBJECT_BLOB_CB_ARG, 'a'); 10359 spdk_trace_register_description_ext(opts, SPDK_COUNTOF(opts)); 10360 spdk_trace_tpoint_register_relation(TRACE_BDEV_IO_START, OBJECT_BLOB_CB_ARG, 1); 10361 spdk_trace_tpoint_register_relation(TRACE_BDEV_IO_DONE, OBJECT_BLOB_CB_ARG, 0); 10362 } 10363 SPDK_TRACE_REGISTER_FN(blob_trace, "blob", TRACE_GROUP_BLOB) 10364