1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * Copyright (c) 2021-2022, NVIDIA CORPORATION & AFFILIATES. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * * Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * * Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * * Neither the name of Intel Corporation nor the names of its 19 * contributors may be used to endorse or promote products derived 20 * from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #include "spdk/stdinc.h" 36 37 #include "spdk/blob.h" 38 #include "spdk/crc32.h" 39 #include "spdk/env.h" 40 #include "spdk/queue.h" 41 #include "spdk/thread.h" 42 #include "spdk/bit_array.h" 43 #include "spdk/bit_pool.h" 44 #include "spdk/likely.h" 45 #include "spdk/util.h" 46 #include "spdk/string.h" 47 48 #include "spdk_internal/assert.h" 49 #include "spdk/log.h" 50 51 #include "blobstore.h" 52 53 #define BLOB_CRC32C_INITIAL 0xffffffffUL 54 55 static int bs_register_md_thread(struct spdk_blob_store *bs); 56 static int bs_unregister_md_thread(struct spdk_blob_store *bs); 57 static void blob_close_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno); 58 static void blob_insert_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 59 uint64_t cluster, uint32_t extent, spdk_blob_op_complete cb_fn, void *cb_arg); 60 61 static int blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 62 uint16_t value_len, bool internal); 63 static int blob_get_xattr_value(struct spdk_blob *blob, const char *name, 64 const void **value, size_t *value_len, bool internal); 65 static int blob_remove_xattr(struct spdk_blob *blob, const char *name, bool internal); 66 67 static void blob_write_extent_page(struct spdk_blob *blob, uint32_t extent, uint64_t cluster_num, 68 spdk_blob_op_complete cb_fn, void *cb_arg); 69 70 static int 71 blob_id_cmp(struct spdk_blob *blob1, struct spdk_blob *blob2) 72 { 73 return (blob1->id < blob2->id ? -1 : blob1->id > blob2->id); 74 } 75 76 RB_GENERATE_STATIC(spdk_blob_tree, spdk_blob, link, blob_id_cmp); 77 78 static void 79 blob_verify_md_op(struct spdk_blob *blob) 80 { 81 assert(blob != NULL); 82 assert(spdk_get_thread() == blob->bs->md_thread); 83 assert(blob->state != SPDK_BLOB_STATE_LOADING); 84 } 85 86 static struct spdk_blob_list * 87 bs_get_snapshot_entry(struct spdk_blob_store *bs, spdk_blob_id blobid) 88 { 89 struct spdk_blob_list *snapshot_entry = NULL; 90 91 TAILQ_FOREACH(snapshot_entry, &bs->snapshots, link) { 92 if (snapshot_entry->id == blobid) { 93 break; 94 } 95 } 96 97 return snapshot_entry; 98 } 99 100 static void 101 bs_claim_md_page(struct spdk_blob_store *bs, uint32_t page) 102 { 103 assert(page < spdk_bit_array_capacity(bs->used_md_pages)); 104 assert(spdk_bit_array_get(bs->used_md_pages, page) == false); 105 106 spdk_bit_array_set(bs->used_md_pages, page); 107 } 108 109 static void 110 bs_release_md_page(struct spdk_blob_store *bs, uint32_t page) 111 { 112 assert(page < spdk_bit_array_capacity(bs->used_md_pages)); 113 assert(spdk_bit_array_get(bs->used_md_pages, page) == true); 114 115 spdk_bit_array_clear(bs->used_md_pages, page); 116 } 117 118 static uint32_t 119 bs_claim_cluster(struct spdk_blob_store *bs) 120 { 121 uint32_t cluster_num; 122 123 cluster_num = spdk_bit_pool_allocate_bit(bs->used_clusters); 124 if (cluster_num == UINT32_MAX) { 125 return UINT32_MAX; 126 } 127 128 SPDK_DEBUGLOG(blob, "Claiming cluster %u\n", cluster_num); 129 bs->num_free_clusters--; 130 131 return cluster_num; 132 } 133 134 static void 135 bs_release_cluster(struct spdk_blob_store *bs, uint32_t cluster_num) 136 { 137 assert(cluster_num < spdk_bit_pool_capacity(bs->used_clusters)); 138 assert(spdk_bit_pool_is_allocated(bs->used_clusters, cluster_num) == true); 139 assert(bs->num_free_clusters < bs->total_clusters); 140 141 SPDK_DEBUGLOG(blob, "Releasing cluster %u\n", cluster_num); 142 143 spdk_bit_pool_free_bit(bs->used_clusters, cluster_num); 144 bs->num_free_clusters++; 145 } 146 147 static int 148 blob_insert_cluster(struct spdk_blob *blob, uint32_t cluster_num, uint64_t cluster) 149 { 150 uint64_t *cluster_lba = &blob->active.clusters[cluster_num]; 151 152 blob_verify_md_op(blob); 153 154 if (*cluster_lba != 0) { 155 return -EEXIST; 156 } 157 158 *cluster_lba = bs_cluster_to_lba(blob->bs, cluster); 159 return 0; 160 } 161 162 static int 163 bs_allocate_cluster(struct spdk_blob *blob, uint32_t cluster_num, 164 uint64_t *cluster, uint32_t *lowest_free_md_page, bool update_map) 165 { 166 uint32_t *extent_page = 0; 167 168 *cluster = bs_claim_cluster(blob->bs); 169 if (*cluster == UINT32_MAX) { 170 /* No more free clusters. Cannot satisfy the request */ 171 return -ENOSPC; 172 } 173 174 if (blob->use_extent_table) { 175 extent_page = bs_cluster_to_extent_page(blob, cluster_num); 176 if (*extent_page == 0) { 177 /* Extent page shall never occupy md_page so start the search from 1 */ 178 if (*lowest_free_md_page == 0) { 179 *lowest_free_md_page = 1; 180 } 181 /* No extent_page is allocated for the cluster */ 182 *lowest_free_md_page = spdk_bit_array_find_first_clear(blob->bs->used_md_pages, 183 *lowest_free_md_page); 184 if (*lowest_free_md_page == UINT32_MAX) { 185 /* No more free md pages. Cannot satisfy the request */ 186 bs_release_cluster(blob->bs, *cluster); 187 return -ENOSPC; 188 } 189 bs_claim_md_page(blob->bs, *lowest_free_md_page); 190 } 191 } 192 193 SPDK_DEBUGLOG(blob, "Claiming cluster %" PRIu64 " for blob %" PRIu64 "\n", *cluster, blob->id); 194 195 if (update_map) { 196 blob_insert_cluster(blob, cluster_num, *cluster); 197 if (blob->use_extent_table && *extent_page == 0) { 198 *extent_page = *lowest_free_md_page; 199 } 200 } 201 202 return 0; 203 } 204 205 static void 206 blob_xattrs_init(struct spdk_blob_xattr_opts *xattrs) 207 { 208 xattrs->count = 0; 209 xattrs->names = NULL; 210 xattrs->ctx = NULL; 211 xattrs->get_value = NULL; 212 } 213 214 void 215 spdk_blob_opts_init(struct spdk_blob_opts *opts, size_t opts_size) 216 { 217 if (!opts) { 218 SPDK_ERRLOG("opts should not be NULL\n"); 219 return; 220 } 221 222 if (!opts_size) { 223 SPDK_ERRLOG("opts_size should not be zero value\n"); 224 return; 225 } 226 227 memset(opts, 0, opts_size); 228 opts->opts_size = opts_size; 229 230 #define FIELD_OK(field) \ 231 offsetof(struct spdk_blob_opts, field) + sizeof(opts->field) <= opts_size 232 233 #define SET_FIELD(field, value) \ 234 if (FIELD_OK(field)) { \ 235 opts->field = value; \ 236 } \ 237 238 SET_FIELD(num_clusters, 0); 239 SET_FIELD(thin_provision, false); 240 SET_FIELD(clear_method, BLOB_CLEAR_WITH_DEFAULT); 241 242 if (FIELD_OK(xattrs)) { 243 blob_xattrs_init(&opts->xattrs); 244 } 245 246 SET_FIELD(use_extent_table, true); 247 248 #undef FIELD_OK 249 #undef SET_FIELD 250 } 251 252 void 253 spdk_blob_open_opts_init(struct spdk_blob_open_opts *opts, size_t opts_size) 254 { 255 if (!opts) { 256 SPDK_ERRLOG("opts should not be NULL\n"); 257 return; 258 } 259 260 if (!opts_size) { 261 SPDK_ERRLOG("opts_size should not be zero value\n"); 262 return; 263 } 264 265 memset(opts, 0, opts_size); 266 opts->opts_size = opts_size; 267 268 #define FIELD_OK(field) \ 269 offsetof(struct spdk_blob_open_opts, field) + sizeof(opts->field) <= opts_size 270 271 #define SET_FIELD(field, value) \ 272 if (FIELD_OK(field)) { \ 273 opts->field = value; \ 274 } \ 275 276 SET_FIELD(clear_method, BLOB_CLEAR_WITH_DEFAULT); 277 278 #undef FIELD_OK 279 #undef SET_FILED 280 } 281 282 static struct spdk_blob * 283 blob_alloc(struct spdk_blob_store *bs, spdk_blob_id id) 284 { 285 struct spdk_blob *blob; 286 287 blob = calloc(1, sizeof(*blob)); 288 if (!blob) { 289 return NULL; 290 } 291 292 blob->id = id; 293 blob->bs = bs; 294 295 blob->parent_id = SPDK_BLOBID_INVALID; 296 297 blob->state = SPDK_BLOB_STATE_DIRTY; 298 blob->extent_rle_found = false; 299 blob->extent_table_found = false; 300 blob->active.num_pages = 1; 301 blob->active.pages = calloc(1, sizeof(*blob->active.pages)); 302 if (!blob->active.pages) { 303 free(blob); 304 return NULL; 305 } 306 307 blob->active.pages[0] = bs_blobid_to_page(id); 308 309 TAILQ_INIT(&blob->xattrs); 310 TAILQ_INIT(&blob->xattrs_internal); 311 TAILQ_INIT(&blob->pending_persists); 312 TAILQ_INIT(&blob->persists_to_complete); 313 314 return blob; 315 } 316 317 static void 318 xattrs_free(struct spdk_xattr_tailq *xattrs) 319 { 320 struct spdk_xattr *xattr, *xattr_tmp; 321 322 TAILQ_FOREACH_SAFE(xattr, xattrs, link, xattr_tmp) { 323 TAILQ_REMOVE(xattrs, xattr, link); 324 free(xattr->name); 325 free(xattr->value); 326 free(xattr); 327 } 328 } 329 330 static void 331 blob_free(struct spdk_blob *blob) 332 { 333 assert(blob != NULL); 334 assert(TAILQ_EMPTY(&blob->pending_persists)); 335 assert(TAILQ_EMPTY(&blob->persists_to_complete)); 336 337 free(blob->active.extent_pages); 338 free(blob->clean.extent_pages); 339 free(blob->active.clusters); 340 free(blob->clean.clusters); 341 free(blob->active.pages); 342 free(blob->clean.pages); 343 344 xattrs_free(&blob->xattrs); 345 xattrs_free(&blob->xattrs_internal); 346 347 if (blob->back_bs_dev) { 348 blob->back_bs_dev->destroy(blob->back_bs_dev); 349 } 350 351 free(blob); 352 } 353 354 struct freeze_io_ctx { 355 struct spdk_bs_cpl cpl; 356 struct spdk_blob *blob; 357 }; 358 359 static void 360 blob_io_sync(struct spdk_io_channel_iter *i) 361 { 362 spdk_for_each_channel_continue(i, 0); 363 } 364 365 static void 366 blob_execute_queued_io(struct spdk_io_channel_iter *i) 367 { 368 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 369 struct spdk_bs_channel *ch = spdk_io_channel_get_ctx(_ch); 370 struct freeze_io_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 371 struct spdk_bs_request_set *set; 372 struct spdk_bs_user_op_args *args; 373 spdk_bs_user_op_t *op, *tmp; 374 375 TAILQ_FOREACH_SAFE(op, &ch->queued_io, link, tmp) { 376 set = (struct spdk_bs_request_set *)op; 377 args = &set->u.user_op; 378 379 if (args->blob == ctx->blob) { 380 TAILQ_REMOVE(&ch->queued_io, op, link); 381 bs_user_op_execute(op); 382 } 383 } 384 385 spdk_for_each_channel_continue(i, 0); 386 } 387 388 static void 389 blob_io_cpl(struct spdk_io_channel_iter *i, int status) 390 { 391 struct freeze_io_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 392 393 ctx->cpl.u.blob_basic.cb_fn(ctx->cpl.u.blob_basic.cb_arg, 0); 394 395 free(ctx); 396 } 397 398 static void 399 blob_freeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 400 { 401 struct freeze_io_ctx *ctx; 402 403 ctx = calloc(1, sizeof(*ctx)); 404 if (!ctx) { 405 cb_fn(cb_arg, -ENOMEM); 406 return; 407 } 408 409 ctx->cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 410 ctx->cpl.u.blob_basic.cb_fn = cb_fn; 411 ctx->cpl.u.blob_basic.cb_arg = cb_arg; 412 ctx->blob = blob; 413 414 /* Freeze I/O on blob */ 415 blob->frozen_refcnt++; 416 417 if (blob->frozen_refcnt == 1) { 418 spdk_for_each_channel(blob->bs, blob_io_sync, ctx, blob_io_cpl); 419 } else { 420 cb_fn(cb_arg, 0); 421 free(ctx); 422 } 423 } 424 425 static void 426 blob_unfreeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 427 { 428 struct freeze_io_ctx *ctx; 429 430 ctx = calloc(1, sizeof(*ctx)); 431 if (!ctx) { 432 cb_fn(cb_arg, -ENOMEM); 433 return; 434 } 435 436 ctx->cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 437 ctx->cpl.u.blob_basic.cb_fn = cb_fn; 438 ctx->cpl.u.blob_basic.cb_arg = cb_arg; 439 ctx->blob = blob; 440 441 assert(blob->frozen_refcnt > 0); 442 443 blob->frozen_refcnt--; 444 445 if (blob->frozen_refcnt == 0) { 446 spdk_for_each_channel(blob->bs, blob_execute_queued_io, ctx, blob_io_cpl); 447 } else { 448 cb_fn(cb_arg, 0); 449 free(ctx); 450 } 451 } 452 453 static int 454 blob_mark_clean(struct spdk_blob *blob) 455 { 456 uint32_t *extent_pages = NULL; 457 uint64_t *clusters = NULL; 458 uint32_t *pages = NULL; 459 460 assert(blob != NULL); 461 462 if (blob->active.num_extent_pages) { 463 assert(blob->active.extent_pages); 464 extent_pages = calloc(blob->active.num_extent_pages, sizeof(*blob->active.extent_pages)); 465 if (!extent_pages) { 466 return -ENOMEM; 467 } 468 memcpy(extent_pages, blob->active.extent_pages, 469 blob->active.num_extent_pages * sizeof(*extent_pages)); 470 } 471 472 if (blob->active.num_clusters) { 473 assert(blob->active.clusters); 474 clusters = calloc(blob->active.num_clusters, sizeof(*blob->active.clusters)); 475 if (!clusters) { 476 free(extent_pages); 477 return -ENOMEM; 478 } 479 memcpy(clusters, blob->active.clusters, blob->active.num_clusters * sizeof(*blob->active.clusters)); 480 } 481 482 if (blob->active.num_pages) { 483 assert(blob->active.pages); 484 pages = calloc(blob->active.num_pages, sizeof(*blob->active.pages)); 485 if (!pages) { 486 free(extent_pages); 487 free(clusters); 488 return -ENOMEM; 489 } 490 memcpy(pages, blob->active.pages, blob->active.num_pages * sizeof(*blob->active.pages)); 491 } 492 493 free(blob->clean.extent_pages); 494 free(blob->clean.clusters); 495 free(blob->clean.pages); 496 497 blob->clean.num_extent_pages = blob->active.num_extent_pages; 498 blob->clean.extent_pages = blob->active.extent_pages; 499 blob->clean.num_clusters = blob->active.num_clusters; 500 blob->clean.clusters = blob->active.clusters; 501 blob->clean.num_pages = blob->active.num_pages; 502 blob->clean.pages = blob->active.pages; 503 504 blob->active.extent_pages = extent_pages; 505 blob->active.clusters = clusters; 506 blob->active.pages = pages; 507 508 /* If the metadata was dirtied again while the metadata was being written to disk, 509 * we do not want to revert the DIRTY state back to CLEAN here. 510 */ 511 if (blob->state == SPDK_BLOB_STATE_LOADING) { 512 blob->state = SPDK_BLOB_STATE_CLEAN; 513 } 514 515 return 0; 516 } 517 518 static int 519 blob_deserialize_xattr(struct spdk_blob *blob, 520 struct spdk_blob_md_descriptor_xattr *desc_xattr, bool internal) 521 { 522 struct spdk_xattr *xattr; 523 524 if (desc_xattr->length != sizeof(desc_xattr->name_length) + 525 sizeof(desc_xattr->value_length) + 526 desc_xattr->name_length + desc_xattr->value_length) { 527 return -EINVAL; 528 } 529 530 xattr = calloc(1, sizeof(*xattr)); 531 if (xattr == NULL) { 532 return -ENOMEM; 533 } 534 535 xattr->name = malloc(desc_xattr->name_length + 1); 536 if (xattr->name == NULL) { 537 free(xattr); 538 return -ENOMEM; 539 } 540 memcpy(xattr->name, desc_xattr->name, desc_xattr->name_length); 541 xattr->name[desc_xattr->name_length] = '\0'; 542 543 xattr->value = malloc(desc_xattr->value_length); 544 if (xattr->value == NULL) { 545 free(xattr->name); 546 free(xattr); 547 return -ENOMEM; 548 } 549 xattr->value_len = desc_xattr->value_length; 550 memcpy(xattr->value, 551 (void *)((uintptr_t)desc_xattr->name + desc_xattr->name_length), 552 desc_xattr->value_length); 553 554 TAILQ_INSERT_TAIL(internal ? &blob->xattrs_internal : &blob->xattrs, xattr, link); 555 556 return 0; 557 } 558 559 560 static int 561 blob_parse_page(const struct spdk_blob_md_page *page, struct spdk_blob *blob) 562 { 563 struct spdk_blob_md_descriptor *desc; 564 size_t cur_desc = 0; 565 void *tmp; 566 567 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 568 while (cur_desc < sizeof(page->descriptors)) { 569 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 570 if (desc->length == 0) { 571 /* If padding and length are 0, this terminates the page */ 572 break; 573 } 574 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 575 struct spdk_blob_md_descriptor_flags *desc_flags; 576 577 desc_flags = (struct spdk_blob_md_descriptor_flags *)desc; 578 579 if (desc_flags->length != sizeof(*desc_flags) - sizeof(*desc)) { 580 return -EINVAL; 581 } 582 583 if ((desc_flags->invalid_flags | SPDK_BLOB_INVALID_FLAGS_MASK) != 584 SPDK_BLOB_INVALID_FLAGS_MASK) { 585 return -EINVAL; 586 } 587 588 if ((desc_flags->data_ro_flags | SPDK_BLOB_DATA_RO_FLAGS_MASK) != 589 SPDK_BLOB_DATA_RO_FLAGS_MASK) { 590 blob->data_ro = true; 591 blob->md_ro = true; 592 } 593 594 if ((desc_flags->md_ro_flags | SPDK_BLOB_MD_RO_FLAGS_MASK) != 595 SPDK_BLOB_MD_RO_FLAGS_MASK) { 596 blob->md_ro = true; 597 } 598 599 if ((desc_flags->data_ro_flags & SPDK_BLOB_READ_ONLY)) { 600 blob->data_ro = true; 601 blob->md_ro = true; 602 } 603 604 blob->invalid_flags = desc_flags->invalid_flags; 605 blob->data_ro_flags = desc_flags->data_ro_flags; 606 blob->md_ro_flags = desc_flags->md_ro_flags; 607 608 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE) { 609 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 610 unsigned int i, j; 611 unsigned int cluster_count = blob->active.num_clusters; 612 613 if (blob->extent_table_found) { 614 /* Extent Table already present in the md, 615 * both descriptors should never be at the same time. */ 616 return -EINVAL; 617 } 618 blob->extent_rle_found = true; 619 620 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)desc; 621 622 if (desc_extent_rle->length == 0 || 623 (desc_extent_rle->length % sizeof(desc_extent_rle->extents[0]) != 0)) { 624 return -EINVAL; 625 } 626 627 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 628 for (j = 0; j < desc_extent_rle->extents[i].length; j++) { 629 if (desc_extent_rle->extents[i].cluster_idx != 0) { 630 if (!spdk_bit_pool_is_allocated(blob->bs->used_clusters, 631 desc_extent_rle->extents[i].cluster_idx + j)) { 632 return -EINVAL; 633 } 634 } 635 cluster_count++; 636 } 637 } 638 639 if (cluster_count == 0) { 640 return -EINVAL; 641 } 642 tmp = realloc(blob->active.clusters, cluster_count * sizeof(*blob->active.clusters)); 643 if (tmp == NULL) { 644 return -ENOMEM; 645 } 646 blob->active.clusters = tmp; 647 blob->active.cluster_array_size = cluster_count; 648 649 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 650 for (j = 0; j < desc_extent_rle->extents[i].length; j++) { 651 if (desc_extent_rle->extents[i].cluster_idx != 0) { 652 blob->active.clusters[blob->active.num_clusters++] = bs_cluster_to_lba(blob->bs, 653 desc_extent_rle->extents[i].cluster_idx + j); 654 } else if (spdk_blob_is_thin_provisioned(blob)) { 655 blob->active.clusters[blob->active.num_clusters++] = 0; 656 } else { 657 return -EINVAL; 658 } 659 } 660 } 661 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE) { 662 struct spdk_blob_md_descriptor_extent_table *desc_extent_table; 663 uint32_t num_extent_pages = blob->active.num_extent_pages; 664 uint32_t i, j; 665 size_t extent_pages_length; 666 667 desc_extent_table = (struct spdk_blob_md_descriptor_extent_table *)desc; 668 extent_pages_length = desc_extent_table->length - sizeof(desc_extent_table->num_clusters); 669 670 if (blob->extent_rle_found) { 671 /* This means that Extent RLE is present in MD, 672 * both should never be at the same time. */ 673 return -EINVAL; 674 } else if (blob->extent_table_found && 675 desc_extent_table->num_clusters != blob->remaining_clusters_in_et) { 676 /* Number of clusters in this ET does not match number 677 * from previously read EXTENT_TABLE. */ 678 return -EINVAL; 679 } 680 681 if (desc_extent_table->length == 0 || 682 (extent_pages_length % sizeof(desc_extent_table->extent_page[0]) != 0)) { 683 return -EINVAL; 684 } 685 686 blob->extent_table_found = true; 687 688 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 689 num_extent_pages += desc_extent_table->extent_page[i].num_pages; 690 } 691 692 if (num_extent_pages > 0) { 693 tmp = realloc(blob->active.extent_pages, num_extent_pages * sizeof(uint32_t)); 694 if (tmp == NULL) { 695 return -ENOMEM; 696 } 697 blob->active.extent_pages = tmp; 698 } 699 blob->active.extent_pages_array_size = num_extent_pages; 700 701 blob->remaining_clusters_in_et = desc_extent_table->num_clusters; 702 703 /* Extent table entries contain md page numbers for extent pages. 704 * Zeroes represent unallocated extent pages, those are run-length-encoded. 705 */ 706 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 707 if (desc_extent_table->extent_page[i].page_idx != 0) { 708 assert(desc_extent_table->extent_page[i].num_pages == 1); 709 blob->active.extent_pages[blob->active.num_extent_pages++] = 710 desc_extent_table->extent_page[i].page_idx; 711 } else if (spdk_blob_is_thin_provisioned(blob)) { 712 for (j = 0; j < desc_extent_table->extent_page[i].num_pages; j++) { 713 blob->active.extent_pages[blob->active.num_extent_pages++] = 0; 714 } 715 } else { 716 return -EINVAL; 717 } 718 } 719 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 720 struct spdk_blob_md_descriptor_extent_page *desc_extent; 721 unsigned int i; 722 unsigned int cluster_count = 0; 723 size_t cluster_idx_length; 724 725 if (blob->extent_rle_found) { 726 /* This means that Extent RLE is present in MD, 727 * both should never be at the same time. */ 728 return -EINVAL; 729 } 730 731 desc_extent = (struct spdk_blob_md_descriptor_extent_page *)desc; 732 cluster_idx_length = desc_extent->length - sizeof(desc_extent->start_cluster_idx); 733 734 if (desc_extent->length <= sizeof(desc_extent->start_cluster_idx) || 735 (cluster_idx_length % sizeof(desc_extent->cluster_idx[0]) != 0)) { 736 return -EINVAL; 737 } 738 739 for (i = 0; i < cluster_idx_length / sizeof(desc_extent->cluster_idx[0]); i++) { 740 if (desc_extent->cluster_idx[i] != 0) { 741 if (!spdk_bit_pool_is_allocated(blob->bs->used_clusters, desc_extent->cluster_idx[i])) { 742 return -EINVAL; 743 } 744 } 745 cluster_count++; 746 } 747 748 if (cluster_count == 0) { 749 return -EINVAL; 750 } 751 752 /* When reading extent pages sequentially starting cluster idx should match 753 * current size of a blob. 754 * If changed to batch reading, this check shall be removed. */ 755 if (desc_extent->start_cluster_idx != blob->active.num_clusters) { 756 return -EINVAL; 757 } 758 759 tmp = realloc(blob->active.clusters, 760 (cluster_count + blob->active.num_clusters) * sizeof(*blob->active.clusters)); 761 if (tmp == NULL) { 762 return -ENOMEM; 763 } 764 blob->active.clusters = tmp; 765 blob->active.cluster_array_size = (cluster_count + blob->active.num_clusters); 766 767 for (i = 0; i < cluster_idx_length / sizeof(desc_extent->cluster_idx[0]); i++) { 768 if (desc_extent->cluster_idx[i] != 0) { 769 blob->active.clusters[blob->active.num_clusters++] = bs_cluster_to_lba(blob->bs, 770 desc_extent->cluster_idx[i]); 771 } else if (spdk_blob_is_thin_provisioned(blob)) { 772 blob->active.clusters[blob->active.num_clusters++] = 0; 773 } else { 774 return -EINVAL; 775 } 776 } 777 assert(desc_extent->start_cluster_idx + cluster_count == blob->active.num_clusters); 778 assert(blob->remaining_clusters_in_et >= cluster_count); 779 blob->remaining_clusters_in_et -= cluster_count; 780 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 781 int rc; 782 783 rc = blob_deserialize_xattr(blob, 784 (struct spdk_blob_md_descriptor_xattr *) desc, false); 785 if (rc != 0) { 786 return rc; 787 } 788 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 789 int rc; 790 791 rc = blob_deserialize_xattr(blob, 792 (struct spdk_blob_md_descriptor_xattr *) desc, true); 793 if (rc != 0) { 794 return rc; 795 } 796 } else { 797 /* Unrecognized descriptor type. Do not fail - just continue to the 798 * next descriptor. If this descriptor is associated with some feature 799 * defined in a newer version of blobstore, that version of blobstore 800 * should create and set an associated feature flag to specify if this 801 * blob can be loaded or not. 802 */ 803 } 804 805 /* Advance to the next descriptor */ 806 cur_desc += sizeof(*desc) + desc->length; 807 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 808 break; 809 } 810 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 811 } 812 813 return 0; 814 } 815 816 static bool bs_load_cur_extent_page_valid(struct spdk_blob_md_page *page); 817 818 static int 819 blob_parse_extent_page(struct spdk_blob_md_page *extent_page, struct spdk_blob *blob) 820 { 821 assert(blob != NULL); 822 assert(blob->state == SPDK_BLOB_STATE_LOADING); 823 824 if (bs_load_cur_extent_page_valid(extent_page) == false) { 825 return -ENOENT; 826 } 827 828 return blob_parse_page(extent_page, blob); 829 } 830 831 static int 832 blob_parse(const struct spdk_blob_md_page *pages, uint32_t page_count, 833 struct spdk_blob *blob) 834 { 835 const struct spdk_blob_md_page *page; 836 uint32_t i; 837 int rc; 838 void *tmp; 839 840 assert(page_count > 0); 841 assert(pages[0].sequence_num == 0); 842 assert(blob != NULL); 843 assert(blob->state == SPDK_BLOB_STATE_LOADING); 844 assert(blob->active.clusters == NULL); 845 846 /* The blobid provided doesn't match what's in the MD, this can 847 * happen for example if a bogus blobid is passed in through open. 848 */ 849 if (blob->id != pages[0].id) { 850 SPDK_ERRLOG("Blobid (%" PRIu64 ") doesn't match what's in metadata (%" PRIu64 ")\n", 851 blob->id, pages[0].id); 852 return -ENOENT; 853 } 854 855 tmp = realloc(blob->active.pages, page_count * sizeof(*blob->active.pages)); 856 if (!tmp) { 857 return -ENOMEM; 858 } 859 blob->active.pages = tmp; 860 861 blob->active.pages[0] = pages[0].id; 862 863 for (i = 1; i < page_count; i++) { 864 assert(spdk_bit_array_get(blob->bs->used_md_pages, pages[i - 1].next)); 865 blob->active.pages[i] = pages[i - 1].next; 866 } 867 blob->active.num_pages = page_count; 868 869 for (i = 0; i < page_count; i++) { 870 page = &pages[i]; 871 872 assert(page->id == blob->id); 873 assert(page->sequence_num == i); 874 875 rc = blob_parse_page(page, blob); 876 if (rc != 0) { 877 return rc; 878 } 879 } 880 881 return 0; 882 } 883 884 static int 885 blob_serialize_add_page(const struct spdk_blob *blob, 886 struct spdk_blob_md_page **pages, 887 uint32_t *page_count, 888 struct spdk_blob_md_page **last_page) 889 { 890 struct spdk_blob_md_page *page, *tmp_pages; 891 892 assert(pages != NULL); 893 assert(page_count != NULL); 894 895 *last_page = NULL; 896 if (*page_count == 0) { 897 assert(*pages == NULL); 898 *pages = spdk_malloc(SPDK_BS_PAGE_SIZE, 0, 899 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 900 if (*pages == NULL) { 901 return -ENOMEM; 902 } 903 *page_count = 1; 904 } else { 905 assert(*pages != NULL); 906 tmp_pages = spdk_realloc(*pages, SPDK_BS_PAGE_SIZE * (*page_count + 1), 0); 907 if (tmp_pages == NULL) { 908 return -ENOMEM; 909 } 910 (*page_count)++; 911 *pages = tmp_pages; 912 } 913 914 page = &(*pages)[*page_count - 1]; 915 memset(page, 0, sizeof(*page)); 916 page->id = blob->id; 917 page->sequence_num = *page_count - 1; 918 page->next = SPDK_INVALID_MD_PAGE; 919 *last_page = page; 920 921 return 0; 922 } 923 924 /* Transform the in-memory representation 'xattr' into an on-disk xattr descriptor. 925 * Update required_sz on both success and failure. 926 * 927 */ 928 static int 929 blob_serialize_xattr(const struct spdk_xattr *xattr, 930 uint8_t *buf, size_t buf_sz, 931 size_t *required_sz, bool internal) 932 { 933 struct spdk_blob_md_descriptor_xattr *desc; 934 935 *required_sz = sizeof(struct spdk_blob_md_descriptor_xattr) + 936 strlen(xattr->name) + 937 xattr->value_len; 938 939 if (buf_sz < *required_sz) { 940 return -1; 941 } 942 943 desc = (struct spdk_blob_md_descriptor_xattr *)buf; 944 945 desc->type = internal ? SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL : SPDK_MD_DESCRIPTOR_TYPE_XATTR; 946 desc->length = sizeof(desc->name_length) + 947 sizeof(desc->value_length) + 948 strlen(xattr->name) + 949 xattr->value_len; 950 desc->name_length = strlen(xattr->name); 951 desc->value_length = xattr->value_len; 952 953 memcpy(desc->name, xattr->name, desc->name_length); 954 memcpy((void *)((uintptr_t)desc->name + desc->name_length), 955 xattr->value, 956 desc->value_length); 957 958 return 0; 959 } 960 961 static void 962 blob_serialize_extent_table_entry(const struct spdk_blob *blob, 963 uint64_t start_ep, uint64_t *next_ep, 964 uint8_t **buf, size_t *remaining_sz) 965 { 966 struct spdk_blob_md_descriptor_extent_table *desc; 967 size_t cur_sz; 968 uint64_t i, et_idx; 969 uint32_t extent_page, ep_len; 970 971 /* The buffer must have room for at least num_clusters entry */ 972 cur_sz = sizeof(struct spdk_blob_md_descriptor) + sizeof(desc->num_clusters); 973 if (*remaining_sz < cur_sz) { 974 *next_ep = start_ep; 975 return; 976 } 977 978 desc = (struct spdk_blob_md_descriptor_extent_table *)*buf; 979 desc->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE; 980 981 desc->num_clusters = blob->active.num_clusters; 982 983 ep_len = 1; 984 et_idx = 0; 985 for (i = start_ep; i < blob->active.num_extent_pages; i++) { 986 if (*remaining_sz < cur_sz + sizeof(desc->extent_page[0])) { 987 /* If we ran out of buffer space, return */ 988 break; 989 } 990 991 extent_page = blob->active.extent_pages[i]; 992 /* Verify that next extent_page is unallocated */ 993 if (extent_page == 0 && 994 (i + 1 < blob->active.num_extent_pages && blob->active.extent_pages[i + 1] == 0)) { 995 ep_len++; 996 continue; 997 } 998 desc->extent_page[et_idx].page_idx = extent_page; 999 desc->extent_page[et_idx].num_pages = ep_len; 1000 et_idx++; 1001 1002 ep_len = 1; 1003 cur_sz += sizeof(desc->extent_page[et_idx]); 1004 } 1005 *next_ep = i; 1006 1007 desc->length = sizeof(desc->num_clusters) + sizeof(desc->extent_page[0]) * et_idx; 1008 *remaining_sz -= sizeof(struct spdk_blob_md_descriptor) + desc->length; 1009 *buf += sizeof(struct spdk_blob_md_descriptor) + desc->length; 1010 } 1011 1012 static int 1013 blob_serialize_extent_table(const struct spdk_blob *blob, 1014 struct spdk_blob_md_page **pages, 1015 struct spdk_blob_md_page *cur_page, 1016 uint32_t *page_count, uint8_t **buf, 1017 size_t *remaining_sz) 1018 { 1019 uint64_t last_extent_page; 1020 int rc; 1021 1022 last_extent_page = 0; 1023 /* At least single extent table entry has to be always persisted. 1024 * Such case occurs with num_extent_pages == 0. */ 1025 while (last_extent_page <= blob->active.num_extent_pages) { 1026 blob_serialize_extent_table_entry(blob, last_extent_page, &last_extent_page, buf, 1027 remaining_sz); 1028 1029 if (last_extent_page == blob->active.num_extent_pages) { 1030 break; 1031 } 1032 1033 rc = blob_serialize_add_page(blob, pages, page_count, &cur_page); 1034 if (rc < 0) { 1035 return rc; 1036 } 1037 1038 *buf = (uint8_t *)cur_page->descriptors; 1039 *remaining_sz = sizeof(cur_page->descriptors); 1040 } 1041 1042 return 0; 1043 } 1044 1045 static void 1046 blob_serialize_extent_rle(const struct spdk_blob *blob, 1047 uint64_t start_cluster, uint64_t *next_cluster, 1048 uint8_t **buf, size_t *buf_sz) 1049 { 1050 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 1051 size_t cur_sz; 1052 uint64_t i, extent_idx; 1053 uint64_t lba, lba_per_cluster, lba_count; 1054 1055 /* The buffer must have room for at least one extent */ 1056 cur_sz = sizeof(struct spdk_blob_md_descriptor) + sizeof(desc_extent_rle->extents[0]); 1057 if (*buf_sz < cur_sz) { 1058 *next_cluster = start_cluster; 1059 return; 1060 } 1061 1062 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)*buf; 1063 desc_extent_rle->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE; 1064 1065 lba_per_cluster = bs_cluster_to_lba(blob->bs, 1); 1066 1067 lba = blob->active.clusters[start_cluster]; 1068 lba_count = lba_per_cluster; 1069 extent_idx = 0; 1070 for (i = start_cluster + 1; i < blob->active.num_clusters; i++) { 1071 if ((lba + lba_count) == blob->active.clusters[i] && lba != 0) { 1072 /* Run-length encode sequential non-zero LBA */ 1073 lba_count += lba_per_cluster; 1074 continue; 1075 } else if (lba == 0 && blob->active.clusters[i] == 0) { 1076 /* Run-length encode unallocated clusters */ 1077 lba_count += lba_per_cluster; 1078 continue; 1079 } 1080 desc_extent_rle->extents[extent_idx].cluster_idx = lba / lba_per_cluster; 1081 desc_extent_rle->extents[extent_idx].length = lba_count / lba_per_cluster; 1082 extent_idx++; 1083 1084 cur_sz += sizeof(desc_extent_rle->extents[extent_idx]); 1085 1086 if (*buf_sz < cur_sz) { 1087 /* If we ran out of buffer space, return */ 1088 *next_cluster = i; 1089 break; 1090 } 1091 1092 lba = blob->active.clusters[i]; 1093 lba_count = lba_per_cluster; 1094 } 1095 1096 if (*buf_sz >= cur_sz) { 1097 desc_extent_rle->extents[extent_idx].cluster_idx = lba / lba_per_cluster; 1098 desc_extent_rle->extents[extent_idx].length = lba_count / lba_per_cluster; 1099 extent_idx++; 1100 1101 *next_cluster = blob->active.num_clusters; 1102 } 1103 1104 desc_extent_rle->length = sizeof(desc_extent_rle->extents[0]) * extent_idx; 1105 *buf_sz -= sizeof(struct spdk_blob_md_descriptor) + desc_extent_rle->length; 1106 *buf += sizeof(struct spdk_blob_md_descriptor) + desc_extent_rle->length; 1107 } 1108 1109 static int 1110 blob_serialize_extents_rle(const struct spdk_blob *blob, 1111 struct spdk_blob_md_page **pages, 1112 struct spdk_blob_md_page *cur_page, 1113 uint32_t *page_count, uint8_t **buf, 1114 size_t *remaining_sz) 1115 { 1116 uint64_t last_cluster; 1117 int rc; 1118 1119 last_cluster = 0; 1120 while (last_cluster < blob->active.num_clusters) { 1121 blob_serialize_extent_rle(blob, last_cluster, &last_cluster, buf, remaining_sz); 1122 1123 if (last_cluster == blob->active.num_clusters) { 1124 break; 1125 } 1126 1127 rc = blob_serialize_add_page(blob, pages, page_count, &cur_page); 1128 if (rc < 0) { 1129 return rc; 1130 } 1131 1132 *buf = (uint8_t *)cur_page->descriptors; 1133 *remaining_sz = sizeof(cur_page->descriptors); 1134 } 1135 1136 return 0; 1137 } 1138 1139 static void 1140 blob_serialize_extent_page(const struct spdk_blob *blob, 1141 uint64_t cluster, struct spdk_blob_md_page *page) 1142 { 1143 struct spdk_blob_md_descriptor_extent_page *desc_extent; 1144 uint64_t i, extent_idx; 1145 uint64_t lba, lba_per_cluster; 1146 uint64_t start_cluster_idx = (cluster / SPDK_EXTENTS_PER_EP) * SPDK_EXTENTS_PER_EP; 1147 1148 desc_extent = (struct spdk_blob_md_descriptor_extent_page *) page->descriptors; 1149 desc_extent->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE; 1150 1151 lba_per_cluster = bs_cluster_to_lba(blob->bs, 1); 1152 1153 desc_extent->start_cluster_idx = start_cluster_idx; 1154 extent_idx = 0; 1155 for (i = start_cluster_idx; i < blob->active.num_clusters; i++) { 1156 lba = blob->active.clusters[i]; 1157 desc_extent->cluster_idx[extent_idx++] = lba / lba_per_cluster; 1158 if (extent_idx >= SPDK_EXTENTS_PER_EP) { 1159 break; 1160 } 1161 } 1162 desc_extent->length = sizeof(desc_extent->start_cluster_idx) + 1163 sizeof(desc_extent->cluster_idx[0]) * extent_idx; 1164 } 1165 1166 static void 1167 blob_serialize_flags(const struct spdk_blob *blob, 1168 uint8_t *buf, size_t *buf_sz) 1169 { 1170 struct spdk_blob_md_descriptor_flags *desc; 1171 1172 /* 1173 * Flags get serialized first, so we should always have room for the flags 1174 * descriptor. 1175 */ 1176 assert(*buf_sz >= sizeof(*desc)); 1177 1178 desc = (struct spdk_blob_md_descriptor_flags *)buf; 1179 desc->type = SPDK_MD_DESCRIPTOR_TYPE_FLAGS; 1180 desc->length = sizeof(*desc) - sizeof(struct spdk_blob_md_descriptor); 1181 desc->invalid_flags = blob->invalid_flags; 1182 desc->data_ro_flags = blob->data_ro_flags; 1183 desc->md_ro_flags = blob->md_ro_flags; 1184 1185 *buf_sz -= sizeof(*desc); 1186 } 1187 1188 static int 1189 blob_serialize_xattrs(const struct spdk_blob *blob, 1190 const struct spdk_xattr_tailq *xattrs, bool internal, 1191 struct spdk_blob_md_page **pages, 1192 struct spdk_blob_md_page *cur_page, 1193 uint32_t *page_count, uint8_t **buf, 1194 size_t *remaining_sz) 1195 { 1196 const struct spdk_xattr *xattr; 1197 int rc; 1198 1199 TAILQ_FOREACH(xattr, xattrs, link) { 1200 size_t required_sz = 0; 1201 1202 rc = blob_serialize_xattr(xattr, 1203 *buf, *remaining_sz, 1204 &required_sz, internal); 1205 if (rc < 0) { 1206 /* Need to add a new page to the chain */ 1207 rc = blob_serialize_add_page(blob, pages, page_count, 1208 &cur_page); 1209 if (rc < 0) { 1210 spdk_free(*pages); 1211 *pages = NULL; 1212 *page_count = 0; 1213 return rc; 1214 } 1215 1216 *buf = (uint8_t *)cur_page->descriptors; 1217 *remaining_sz = sizeof(cur_page->descriptors); 1218 1219 /* Try again */ 1220 required_sz = 0; 1221 rc = blob_serialize_xattr(xattr, 1222 *buf, *remaining_sz, 1223 &required_sz, internal); 1224 1225 if (rc < 0) { 1226 spdk_free(*pages); 1227 *pages = NULL; 1228 *page_count = 0; 1229 return rc; 1230 } 1231 } 1232 1233 *remaining_sz -= required_sz; 1234 *buf += required_sz; 1235 } 1236 1237 return 0; 1238 } 1239 1240 static int 1241 blob_serialize(const struct spdk_blob *blob, struct spdk_blob_md_page **pages, 1242 uint32_t *page_count) 1243 { 1244 struct spdk_blob_md_page *cur_page; 1245 int rc; 1246 uint8_t *buf; 1247 size_t remaining_sz; 1248 1249 assert(pages != NULL); 1250 assert(page_count != NULL); 1251 assert(blob != NULL); 1252 assert(blob->state == SPDK_BLOB_STATE_DIRTY); 1253 1254 *pages = NULL; 1255 *page_count = 0; 1256 1257 /* A blob always has at least 1 page, even if it has no descriptors */ 1258 rc = blob_serialize_add_page(blob, pages, page_count, &cur_page); 1259 if (rc < 0) { 1260 return rc; 1261 } 1262 1263 buf = (uint8_t *)cur_page->descriptors; 1264 remaining_sz = sizeof(cur_page->descriptors); 1265 1266 /* Serialize flags */ 1267 blob_serialize_flags(blob, buf, &remaining_sz); 1268 buf += sizeof(struct spdk_blob_md_descriptor_flags); 1269 1270 /* Serialize xattrs */ 1271 rc = blob_serialize_xattrs(blob, &blob->xattrs, false, 1272 pages, cur_page, page_count, &buf, &remaining_sz); 1273 if (rc < 0) { 1274 return rc; 1275 } 1276 1277 /* Serialize internal xattrs */ 1278 rc = blob_serialize_xattrs(blob, &blob->xattrs_internal, true, 1279 pages, cur_page, page_count, &buf, &remaining_sz); 1280 if (rc < 0) { 1281 return rc; 1282 } 1283 1284 if (blob->use_extent_table) { 1285 /* Serialize extent table */ 1286 rc = blob_serialize_extent_table(blob, pages, cur_page, page_count, &buf, &remaining_sz); 1287 } else { 1288 /* Serialize extents */ 1289 rc = blob_serialize_extents_rle(blob, pages, cur_page, page_count, &buf, &remaining_sz); 1290 } 1291 1292 return rc; 1293 } 1294 1295 struct spdk_blob_load_ctx { 1296 struct spdk_blob *blob; 1297 1298 struct spdk_blob_md_page *pages; 1299 uint32_t num_pages; 1300 uint32_t next_extent_page; 1301 spdk_bs_sequence_t *seq; 1302 1303 spdk_bs_sequence_cpl cb_fn; 1304 void *cb_arg; 1305 }; 1306 1307 static uint32_t 1308 blob_md_page_calc_crc(void *page) 1309 { 1310 uint32_t crc; 1311 1312 crc = BLOB_CRC32C_INITIAL; 1313 crc = spdk_crc32c_update(page, SPDK_BS_PAGE_SIZE - 4, crc); 1314 crc ^= BLOB_CRC32C_INITIAL; 1315 1316 return crc; 1317 1318 } 1319 1320 static void 1321 blob_load_final(struct spdk_blob_load_ctx *ctx, int bserrno) 1322 { 1323 struct spdk_blob *blob = ctx->blob; 1324 1325 if (bserrno == 0) { 1326 blob_mark_clean(blob); 1327 } 1328 1329 ctx->cb_fn(ctx->seq, ctx->cb_arg, bserrno); 1330 1331 /* Free the memory */ 1332 spdk_free(ctx->pages); 1333 free(ctx); 1334 } 1335 1336 static void 1337 blob_load_snapshot_cpl(void *cb_arg, struct spdk_blob *snapshot, int bserrno) 1338 { 1339 struct spdk_blob_load_ctx *ctx = cb_arg; 1340 struct spdk_blob *blob = ctx->blob; 1341 1342 if (bserrno == 0) { 1343 blob->back_bs_dev = bs_create_blob_bs_dev(snapshot); 1344 if (blob->back_bs_dev == NULL) { 1345 bserrno = -ENOMEM; 1346 } 1347 } 1348 if (bserrno != 0) { 1349 SPDK_ERRLOG("Snapshot fail\n"); 1350 } 1351 1352 blob_load_final(ctx, bserrno); 1353 } 1354 1355 static void blob_update_clear_method(struct spdk_blob *blob); 1356 1357 static void 1358 blob_load_backing_dev(void *cb_arg) 1359 { 1360 struct spdk_blob_load_ctx *ctx = cb_arg; 1361 struct spdk_blob *blob = ctx->blob; 1362 const void *value; 1363 size_t len; 1364 int rc; 1365 1366 if (spdk_blob_is_thin_provisioned(blob)) { 1367 rc = blob_get_xattr_value(blob, BLOB_SNAPSHOT, &value, &len, true); 1368 if (rc == 0) { 1369 if (len != sizeof(spdk_blob_id)) { 1370 blob_load_final(ctx, -EINVAL); 1371 return; 1372 } 1373 /* open snapshot blob and continue in the callback function */ 1374 blob->parent_id = *(spdk_blob_id *)value; 1375 spdk_bs_open_blob(blob->bs, blob->parent_id, 1376 blob_load_snapshot_cpl, ctx); 1377 return; 1378 } else { 1379 /* add zeroes_dev for thin provisioned blob */ 1380 blob->back_bs_dev = bs_create_zeroes_dev(); 1381 } 1382 } else { 1383 /* standard blob */ 1384 blob->back_bs_dev = NULL; 1385 } 1386 blob_load_final(ctx, 0); 1387 } 1388 1389 static void 1390 blob_load_cpl_extents_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1391 { 1392 struct spdk_blob_load_ctx *ctx = cb_arg; 1393 struct spdk_blob *blob = ctx->blob; 1394 struct spdk_blob_md_page *page; 1395 uint64_t i; 1396 uint32_t crc; 1397 uint64_t lba; 1398 void *tmp; 1399 uint64_t sz; 1400 1401 if (bserrno) { 1402 SPDK_ERRLOG("Extent page read failed: %d\n", bserrno); 1403 blob_load_final(ctx, bserrno); 1404 return; 1405 } 1406 1407 if (ctx->pages == NULL) { 1408 /* First iteration of this function, allocate buffer for single EXTENT_PAGE */ 1409 ctx->pages = spdk_zmalloc(SPDK_BS_PAGE_SIZE, 0, 1410 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 1411 if (!ctx->pages) { 1412 blob_load_final(ctx, -ENOMEM); 1413 return; 1414 } 1415 ctx->num_pages = 1; 1416 ctx->next_extent_page = 0; 1417 } else { 1418 page = &ctx->pages[0]; 1419 crc = blob_md_page_calc_crc(page); 1420 if (crc != page->crc) { 1421 blob_load_final(ctx, -EINVAL); 1422 return; 1423 } 1424 1425 if (page->next != SPDK_INVALID_MD_PAGE) { 1426 blob_load_final(ctx, -EINVAL); 1427 return; 1428 } 1429 1430 bserrno = blob_parse_extent_page(page, blob); 1431 if (bserrno) { 1432 blob_load_final(ctx, bserrno); 1433 return; 1434 } 1435 } 1436 1437 for (i = ctx->next_extent_page; i < blob->active.num_extent_pages; i++) { 1438 if (blob->active.extent_pages[i] != 0) { 1439 /* Extent page was allocated, read and parse it. */ 1440 lba = bs_md_page_to_lba(blob->bs, blob->active.extent_pages[i]); 1441 ctx->next_extent_page = i + 1; 1442 1443 bs_sequence_read_dev(seq, &ctx->pages[0], lba, 1444 bs_byte_to_lba(blob->bs, SPDK_BS_PAGE_SIZE), 1445 blob_load_cpl_extents_cpl, ctx); 1446 return; 1447 } else { 1448 /* Thin provisioned blobs can point to unallocated extent pages. 1449 * In this case blob size should be increased by up to the amount left in remaining_clusters_in_et. */ 1450 1451 sz = spdk_min(blob->remaining_clusters_in_et, SPDK_EXTENTS_PER_EP); 1452 blob->active.num_clusters += sz; 1453 blob->remaining_clusters_in_et -= sz; 1454 1455 assert(spdk_blob_is_thin_provisioned(blob)); 1456 assert(i + 1 < blob->active.num_extent_pages || blob->remaining_clusters_in_et == 0); 1457 1458 tmp = realloc(blob->active.clusters, blob->active.num_clusters * sizeof(*blob->active.clusters)); 1459 if (tmp == NULL) { 1460 blob_load_final(ctx, -ENOMEM); 1461 return; 1462 } 1463 memset(tmp + sizeof(*blob->active.clusters) * blob->active.cluster_array_size, 0, 1464 sizeof(*blob->active.clusters) * (blob->active.num_clusters - blob->active.cluster_array_size)); 1465 blob->active.clusters = tmp; 1466 blob->active.cluster_array_size = blob->active.num_clusters; 1467 } 1468 } 1469 1470 blob_load_backing_dev(ctx); 1471 } 1472 1473 static void 1474 blob_load_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1475 { 1476 struct spdk_blob_load_ctx *ctx = cb_arg; 1477 struct spdk_blob *blob = ctx->blob; 1478 struct spdk_blob_md_page *page; 1479 int rc; 1480 uint32_t crc; 1481 uint32_t current_page; 1482 1483 if (ctx->num_pages == 1) { 1484 current_page = bs_blobid_to_page(blob->id); 1485 } else { 1486 assert(ctx->num_pages != 0); 1487 page = &ctx->pages[ctx->num_pages - 2]; 1488 current_page = page->next; 1489 } 1490 1491 if (bserrno) { 1492 SPDK_ERRLOG("Metadata page %d read failed for blobid %" PRIu64 ": %d\n", 1493 current_page, blob->id, bserrno); 1494 blob_load_final(ctx, bserrno); 1495 return; 1496 } 1497 1498 page = &ctx->pages[ctx->num_pages - 1]; 1499 crc = blob_md_page_calc_crc(page); 1500 if (crc != page->crc) { 1501 SPDK_ERRLOG("Metadata page %d crc mismatch for blobid %" PRIu64 "\n", 1502 current_page, blob->id); 1503 blob_load_final(ctx, -EINVAL); 1504 return; 1505 } 1506 1507 if (page->next != SPDK_INVALID_MD_PAGE) { 1508 struct spdk_blob_md_page *tmp_pages; 1509 uint32_t next_page = page->next; 1510 uint64_t next_lba = bs_md_page_to_lba(blob->bs, next_page); 1511 1512 /* Read the next page */ 1513 tmp_pages = spdk_realloc(ctx->pages, (sizeof(*page) * (ctx->num_pages + 1)), 0); 1514 if (tmp_pages == NULL) { 1515 blob_load_final(ctx, -ENOMEM); 1516 return; 1517 } 1518 ctx->num_pages++; 1519 ctx->pages = tmp_pages; 1520 1521 bs_sequence_read_dev(seq, &ctx->pages[ctx->num_pages - 1], 1522 next_lba, 1523 bs_byte_to_lba(blob->bs, sizeof(*page)), 1524 blob_load_cpl, ctx); 1525 return; 1526 } 1527 1528 /* Parse the pages */ 1529 rc = blob_parse(ctx->pages, ctx->num_pages, blob); 1530 if (rc) { 1531 blob_load_final(ctx, rc); 1532 return; 1533 } 1534 1535 if (blob->extent_table_found == true) { 1536 /* If EXTENT_TABLE was found, that means support for it should be enabled. */ 1537 assert(blob->extent_rle_found == false); 1538 blob->use_extent_table = true; 1539 } else { 1540 /* If EXTENT_RLE or no extent_* descriptor was found disable support 1541 * for extent table. No extent_* descriptors means that blob has length of 0 1542 * and no extent_rle descriptors were persisted for it. 1543 * EXTENT_TABLE if used, is always present in metadata regardless of length. */ 1544 blob->use_extent_table = false; 1545 } 1546 1547 /* Check the clear_method stored in metadata vs what may have been passed 1548 * via spdk_bs_open_blob_ext() and update accordingly. 1549 */ 1550 blob_update_clear_method(blob); 1551 1552 spdk_free(ctx->pages); 1553 ctx->pages = NULL; 1554 1555 if (blob->extent_table_found) { 1556 blob_load_cpl_extents_cpl(seq, ctx, 0); 1557 } else { 1558 blob_load_backing_dev(ctx); 1559 } 1560 } 1561 1562 /* Load a blob from disk given a blobid */ 1563 static void 1564 blob_load(spdk_bs_sequence_t *seq, struct spdk_blob *blob, 1565 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 1566 { 1567 struct spdk_blob_load_ctx *ctx; 1568 struct spdk_blob_store *bs; 1569 uint32_t page_num; 1570 uint64_t lba; 1571 1572 blob_verify_md_op(blob); 1573 1574 bs = blob->bs; 1575 1576 ctx = calloc(1, sizeof(*ctx)); 1577 if (!ctx) { 1578 cb_fn(seq, cb_arg, -ENOMEM); 1579 return; 1580 } 1581 1582 ctx->blob = blob; 1583 ctx->pages = spdk_realloc(ctx->pages, SPDK_BS_PAGE_SIZE, 0); 1584 if (!ctx->pages) { 1585 free(ctx); 1586 cb_fn(seq, cb_arg, -ENOMEM); 1587 return; 1588 } 1589 ctx->num_pages = 1; 1590 ctx->cb_fn = cb_fn; 1591 ctx->cb_arg = cb_arg; 1592 ctx->seq = seq; 1593 1594 page_num = bs_blobid_to_page(blob->id); 1595 lba = bs_md_page_to_lba(blob->bs, page_num); 1596 1597 blob->state = SPDK_BLOB_STATE_LOADING; 1598 1599 bs_sequence_read_dev(seq, &ctx->pages[0], lba, 1600 bs_byte_to_lba(bs, SPDK_BS_PAGE_SIZE), 1601 blob_load_cpl, ctx); 1602 } 1603 1604 struct spdk_blob_persist_ctx { 1605 struct spdk_blob *blob; 1606 1607 struct spdk_bs_super_block *super; 1608 1609 struct spdk_blob_md_page *pages; 1610 uint32_t next_extent_page; 1611 struct spdk_blob_md_page *extent_page; 1612 1613 spdk_bs_sequence_t *seq; 1614 spdk_bs_sequence_cpl cb_fn; 1615 void *cb_arg; 1616 TAILQ_ENTRY(spdk_blob_persist_ctx) link; 1617 }; 1618 1619 static void 1620 bs_batch_clear_dev(struct spdk_blob_persist_ctx *ctx, spdk_bs_batch_t *batch, uint64_t lba, 1621 uint64_t lba_count) 1622 { 1623 switch (ctx->blob->clear_method) { 1624 case BLOB_CLEAR_WITH_DEFAULT: 1625 case BLOB_CLEAR_WITH_UNMAP: 1626 bs_batch_unmap_dev(batch, lba, lba_count); 1627 break; 1628 case BLOB_CLEAR_WITH_WRITE_ZEROES: 1629 bs_batch_write_zeroes_dev(batch, lba, lba_count); 1630 break; 1631 case BLOB_CLEAR_WITH_NONE: 1632 default: 1633 break; 1634 } 1635 } 1636 1637 static void blob_persist_check_dirty(struct spdk_blob_persist_ctx *ctx); 1638 1639 static void 1640 blob_persist_complete_cb(void *arg) 1641 { 1642 struct spdk_blob_persist_ctx *ctx = arg; 1643 1644 /* Call user callback */ 1645 ctx->cb_fn(ctx->seq, ctx->cb_arg, 0); 1646 1647 /* Free the memory */ 1648 spdk_free(ctx->pages); 1649 free(ctx); 1650 } 1651 1652 static void 1653 blob_persist_complete(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx, int bserrno) 1654 { 1655 struct spdk_blob_persist_ctx *next_persist, *tmp; 1656 struct spdk_blob *blob = ctx->blob; 1657 1658 if (bserrno == 0) { 1659 blob_mark_clean(blob); 1660 } 1661 1662 assert(ctx == TAILQ_FIRST(&blob->persists_to_complete)); 1663 1664 /* Complete all persists that were pending when the current persist started */ 1665 TAILQ_FOREACH_SAFE(next_persist, &blob->persists_to_complete, link, tmp) { 1666 TAILQ_REMOVE(&blob->persists_to_complete, next_persist, link); 1667 spdk_thread_send_msg(spdk_get_thread(), blob_persist_complete_cb, next_persist); 1668 } 1669 1670 if (TAILQ_EMPTY(&blob->pending_persists)) { 1671 return; 1672 } 1673 1674 /* Queue up all pending persists for completion and start blob persist with first one */ 1675 TAILQ_SWAP(&blob->persists_to_complete, &blob->pending_persists, spdk_blob_persist_ctx, link); 1676 next_persist = TAILQ_FIRST(&blob->persists_to_complete); 1677 1678 blob->state = SPDK_BLOB_STATE_DIRTY; 1679 blob_persist_check_dirty(next_persist); 1680 } 1681 1682 static void 1683 blob_persist_clear_extents_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1684 { 1685 struct spdk_blob_persist_ctx *ctx = cb_arg; 1686 struct spdk_blob *blob = ctx->blob; 1687 struct spdk_blob_store *bs = blob->bs; 1688 size_t i; 1689 1690 if (bserrno != 0) { 1691 blob_persist_complete(seq, ctx, bserrno); 1692 return; 1693 } 1694 1695 /* Release all extent_pages that were truncated */ 1696 for (i = blob->active.num_extent_pages; i < blob->active.extent_pages_array_size; i++) { 1697 /* Nothing to release if it was not allocated */ 1698 if (blob->active.extent_pages[i] != 0) { 1699 bs_release_md_page(bs, blob->active.extent_pages[i]); 1700 } 1701 } 1702 1703 if (blob->active.num_extent_pages == 0) { 1704 free(blob->active.extent_pages); 1705 blob->active.extent_pages = NULL; 1706 blob->active.extent_pages_array_size = 0; 1707 } else if (blob->active.num_extent_pages != blob->active.extent_pages_array_size) { 1708 #ifndef __clang_analyzer__ 1709 void *tmp; 1710 1711 /* scan-build really can't figure reallocs, workaround it */ 1712 tmp = realloc(blob->active.extent_pages, sizeof(uint32_t) * blob->active.num_extent_pages); 1713 assert(tmp != NULL); 1714 blob->active.extent_pages = tmp; 1715 #endif 1716 blob->active.extent_pages_array_size = blob->active.num_extent_pages; 1717 } 1718 1719 blob_persist_complete(seq, ctx, bserrno); 1720 } 1721 1722 static void 1723 blob_persist_clear_extents(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx) 1724 { 1725 struct spdk_blob *blob = ctx->blob; 1726 struct spdk_blob_store *bs = blob->bs; 1727 size_t i; 1728 uint64_t lba; 1729 uint64_t lba_count; 1730 spdk_bs_batch_t *batch; 1731 1732 batch = bs_sequence_to_batch(seq, blob_persist_clear_extents_cpl, ctx); 1733 lba_count = bs_byte_to_lba(bs, SPDK_BS_PAGE_SIZE); 1734 1735 /* Clear all extent_pages that were truncated */ 1736 for (i = blob->active.num_extent_pages; i < blob->active.extent_pages_array_size; i++) { 1737 /* Nothing to clear if it was not allocated */ 1738 if (blob->active.extent_pages[i] != 0) { 1739 lba = bs_md_page_to_lba(bs, blob->active.extent_pages[i]); 1740 bs_batch_write_zeroes_dev(batch, lba, lba_count); 1741 } 1742 } 1743 1744 bs_batch_close(batch); 1745 } 1746 1747 static void 1748 blob_persist_clear_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1749 { 1750 struct spdk_blob_persist_ctx *ctx = cb_arg; 1751 struct spdk_blob *blob = ctx->blob; 1752 struct spdk_blob_store *bs = blob->bs; 1753 size_t i; 1754 1755 if (bserrno != 0) { 1756 blob_persist_complete(seq, ctx, bserrno); 1757 return; 1758 } 1759 1760 pthread_mutex_lock(&bs->used_clusters_mutex); 1761 /* Release all clusters that were truncated */ 1762 for (i = blob->active.num_clusters; i < blob->active.cluster_array_size; i++) { 1763 uint32_t cluster_num = bs_lba_to_cluster(bs, blob->active.clusters[i]); 1764 1765 /* Nothing to release if it was not allocated */ 1766 if (blob->active.clusters[i] != 0) { 1767 bs_release_cluster(bs, cluster_num); 1768 } 1769 } 1770 pthread_mutex_unlock(&bs->used_clusters_mutex); 1771 1772 if (blob->active.num_clusters == 0) { 1773 free(blob->active.clusters); 1774 blob->active.clusters = NULL; 1775 blob->active.cluster_array_size = 0; 1776 } else if (blob->active.num_clusters != blob->active.cluster_array_size) { 1777 #ifndef __clang_analyzer__ 1778 void *tmp; 1779 1780 /* scan-build really can't figure reallocs, workaround it */ 1781 tmp = realloc(blob->active.clusters, sizeof(*blob->active.clusters) * blob->active.num_clusters); 1782 assert(tmp != NULL); 1783 blob->active.clusters = tmp; 1784 1785 #endif 1786 blob->active.cluster_array_size = blob->active.num_clusters; 1787 } 1788 1789 /* Move on to clearing extent pages */ 1790 blob_persist_clear_extents(seq, ctx); 1791 } 1792 1793 static void 1794 blob_persist_clear_clusters(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx) 1795 { 1796 struct spdk_blob *blob = ctx->blob; 1797 struct spdk_blob_store *bs = blob->bs; 1798 spdk_bs_batch_t *batch; 1799 size_t i; 1800 uint64_t lba; 1801 uint64_t lba_count; 1802 1803 /* Clusters don't move around in blobs. The list shrinks or grows 1804 * at the end, but no changes ever occur in the middle of the list. 1805 */ 1806 1807 batch = bs_sequence_to_batch(seq, blob_persist_clear_clusters_cpl, ctx); 1808 1809 /* Clear all clusters that were truncated */ 1810 lba = 0; 1811 lba_count = 0; 1812 for (i = blob->active.num_clusters; i < blob->active.cluster_array_size; i++) { 1813 uint64_t next_lba = blob->active.clusters[i]; 1814 uint64_t next_lba_count = bs_cluster_to_lba(bs, 1); 1815 1816 if (next_lba > 0 && (lba + lba_count) == next_lba) { 1817 /* This cluster is contiguous with the previous one. */ 1818 lba_count += next_lba_count; 1819 continue; 1820 } else if (next_lba == 0) { 1821 continue; 1822 } 1823 1824 /* This cluster is not contiguous with the previous one. */ 1825 1826 /* If a run of LBAs previously existing, clear them now */ 1827 if (lba_count > 0) { 1828 bs_batch_clear_dev(ctx, batch, lba, lba_count); 1829 } 1830 1831 /* Start building the next batch */ 1832 lba = next_lba; 1833 if (next_lba > 0) { 1834 lba_count = next_lba_count; 1835 } else { 1836 lba_count = 0; 1837 } 1838 } 1839 1840 /* If we ended with a contiguous set of LBAs, clear them now */ 1841 if (lba_count > 0) { 1842 bs_batch_clear_dev(ctx, batch, lba, lba_count); 1843 } 1844 1845 bs_batch_close(batch); 1846 } 1847 1848 static void 1849 blob_persist_zero_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1850 { 1851 struct spdk_blob_persist_ctx *ctx = cb_arg; 1852 struct spdk_blob *blob = ctx->blob; 1853 struct spdk_blob_store *bs = blob->bs; 1854 size_t i; 1855 1856 if (bserrno != 0) { 1857 blob_persist_complete(seq, ctx, bserrno); 1858 return; 1859 } 1860 1861 /* This loop starts at 1 because the first page is special and handled 1862 * below. The pages (except the first) are never written in place, 1863 * so any pages in the clean list must be zeroed. 1864 */ 1865 for (i = 1; i < blob->clean.num_pages; i++) { 1866 bs_release_md_page(bs, blob->clean.pages[i]); 1867 } 1868 1869 if (blob->active.num_pages == 0) { 1870 uint32_t page_num; 1871 1872 page_num = bs_blobid_to_page(blob->id); 1873 bs_release_md_page(bs, page_num); 1874 } 1875 1876 /* Move on to clearing clusters */ 1877 blob_persist_clear_clusters(seq, ctx); 1878 } 1879 1880 static void 1881 blob_persist_zero_pages(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1882 { 1883 struct spdk_blob_persist_ctx *ctx = cb_arg; 1884 struct spdk_blob *blob = ctx->blob; 1885 struct spdk_blob_store *bs = blob->bs; 1886 uint64_t lba; 1887 uint64_t lba_count; 1888 spdk_bs_batch_t *batch; 1889 size_t i; 1890 1891 if (bserrno != 0) { 1892 blob_persist_complete(seq, ctx, bserrno); 1893 return; 1894 } 1895 1896 batch = bs_sequence_to_batch(seq, blob_persist_zero_pages_cpl, ctx); 1897 1898 lba_count = bs_byte_to_lba(bs, SPDK_BS_PAGE_SIZE); 1899 1900 /* This loop starts at 1 because the first page is special and handled 1901 * below. The pages (except the first) are never written in place, 1902 * so any pages in the clean list must be zeroed. 1903 */ 1904 for (i = 1; i < blob->clean.num_pages; i++) { 1905 lba = bs_md_page_to_lba(bs, blob->clean.pages[i]); 1906 1907 bs_batch_write_zeroes_dev(batch, lba, lba_count); 1908 } 1909 1910 /* The first page will only be zeroed if this is a delete. */ 1911 if (blob->active.num_pages == 0) { 1912 uint32_t page_num; 1913 1914 /* The first page in the metadata goes where the blobid indicates */ 1915 page_num = bs_blobid_to_page(blob->id); 1916 lba = bs_md_page_to_lba(bs, page_num); 1917 1918 bs_batch_write_zeroes_dev(batch, lba, lba_count); 1919 } 1920 1921 bs_batch_close(batch); 1922 } 1923 1924 static void 1925 blob_persist_write_page_root(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1926 { 1927 struct spdk_blob_persist_ctx *ctx = cb_arg; 1928 struct spdk_blob *blob = ctx->blob; 1929 struct spdk_blob_store *bs = blob->bs; 1930 uint64_t lba; 1931 uint32_t lba_count; 1932 struct spdk_blob_md_page *page; 1933 1934 if (bserrno != 0) { 1935 blob_persist_complete(seq, ctx, bserrno); 1936 return; 1937 } 1938 1939 if (blob->active.num_pages == 0) { 1940 /* Move on to the next step */ 1941 blob_persist_zero_pages(seq, ctx, 0); 1942 return; 1943 } 1944 1945 lba_count = bs_byte_to_lba(bs, sizeof(*page)); 1946 1947 page = &ctx->pages[0]; 1948 /* The first page in the metadata goes where the blobid indicates */ 1949 lba = bs_md_page_to_lba(bs, bs_blobid_to_page(blob->id)); 1950 1951 bs_sequence_write_dev(seq, page, lba, lba_count, 1952 blob_persist_zero_pages, ctx); 1953 } 1954 1955 static void 1956 blob_persist_write_page_chain(spdk_bs_sequence_t *seq, struct spdk_blob_persist_ctx *ctx) 1957 { 1958 struct spdk_blob *blob = ctx->blob; 1959 struct spdk_blob_store *bs = blob->bs; 1960 uint64_t lba; 1961 uint32_t lba_count; 1962 struct spdk_blob_md_page *page; 1963 spdk_bs_batch_t *batch; 1964 size_t i; 1965 1966 /* Clusters don't move around in blobs. The list shrinks or grows 1967 * at the end, but no changes ever occur in the middle of the list. 1968 */ 1969 1970 lba_count = bs_byte_to_lba(bs, sizeof(*page)); 1971 1972 batch = bs_sequence_to_batch(seq, blob_persist_write_page_root, ctx); 1973 1974 /* This starts at 1. The root page is not written until 1975 * all of the others are finished 1976 */ 1977 for (i = 1; i < blob->active.num_pages; i++) { 1978 page = &ctx->pages[i]; 1979 assert(page->sequence_num == i); 1980 1981 lba = bs_md_page_to_lba(bs, blob->active.pages[i]); 1982 1983 bs_batch_write_dev(batch, page, lba, lba_count); 1984 } 1985 1986 bs_batch_close(batch); 1987 } 1988 1989 static int 1990 blob_resize(struct spdk_blob *blob, uint64_t sz) 1991 { 1992 uint64_t i; 1993 uint64_t *tmp; 1994 uint64_t cluster; 1995 uint32_t lfmd; /* lowest free md page */ 1996 uint64_t num_clusters; 1997 uint32_t *ep_tmp; 1998 uint64_t new_num_ep = 0, current_num_ep = 0; 1999 struct spdk_blob_store *bs; 2000 2001 bs = blob->bs; 2002 2003 blob_verify_md_op(blob); 2004 2005 if (blob->active.num_clusters == sz) { 2006 return 0; 2007 } 2008 2009 if (blob->active.num_clusters < blob->active.cluster_array_size) { 2010 /* If this blob was resized to be larger, then smaller, then 2011 * larger without syncing, then the cluster array already 2012 * contains spare assigned clusters we can use. 2013 */ 2014 num_clusters = spdk_min(blob->active.cluster_array_size, 2015 sz); 2016 } else { 2017 num_clusters = blob->active.num_clusters; 2018 } 2019 2020 if (blob->use_extent_table) { 2021 /* Round up since every cluster beyond current Extent Table size, 2022 * requires new extent page. */ 2023 new_num_ep = spdk_divide_round_up(sz, SPDK_EXTENTS_PER_EP); 2024 current_num_ep = spdk_divide_round_up(num_clusters, SPDK_EXTENTS_PER_EP); 2025 } 2026 2027 /* Check first that we have enough clusters and md pages before we start claiming them. */ 2028 if (sz > num_clusters && spdk_blob_is_thin_provisioned(blob) == false) { 2029 if ((sz - num_clusters) > bs->num_free_clusters) { 2030 return -ENOSPC; 2031 } 2032 lfmd = 0; 2033 for (i = current_num_ep; i < new_num_ep ; i++) { 2034 lfmd = spdk_bit_array_find_first_clear(blob->bs->used_md_pages, lfmd); 2035 if (lfmd == UINT32_MAX) { 2036 /* No more free md pages. Cannot satisfy the request */ 2037 return -ENOSPC; 2038 } 2039 } 2040 } 2041 2042 if (sz > num_clusters) { 2043 /* Expand the cluster array if necessary. 2044 * We only shrink the array when persisting. 2045 */ 2046 tmp = realloc(blob->active.clusters, sizeof(*blob->active.clusters) * sz); 2047 if (sz > 0 && tmp == NULL) { 2048 return -ENOMEM; 2049 } 2050 memset(tmp + blob->active.cluster_array_size, 0, 2051 sizeof(*blob->active.clusters) * (sz - blob->active.cluster_array_size)); 2052 blob->active.clusters = tmp; 2053 blob->active.cluster_array_size = sz; 2054 2055 /* Expand the extents table, only if enough clusters were added */ 2056 if (new_num_ep > current_num_ep && blob->use_extent_table) { 2057 ep_tmp = realloc(blob->active.extent_pages, sizeof(*blob->active.extent_pages) * new_num_ep); 2058 if (new_num_ep > 0 && ep_tmp == NULL) { 2059 return -ENOMEM; 2060 } 2061 memset(ep_tmp + blob->active.extent_pages_array_size, 0, 2062 sizeof(*blob->active.extent_pages) * (new_num_ep - blob->active.extent_pages_array_size)); 2063 blob->active.extent_pages = ep_tmp; 2064 blob->active.extent_pages_array_size = new_num_ep; 2065 } 2066 } 2067 2068 blob->state = SPDK_BLOB_STATE_DIRTY; 2069 2070 if (spdk_blob_is_thin_provisioned(blob) == false) { 2071 cluster = 0; 2072 lfmd = 0; 2073 pthread_mutex_lock(&blob->bs->used_clusters_mutex); 2074 for (i = num_clusters; i < sz; i++) { 2075 bs_allocate_cluster(blob, i, &cluster, &lfmd, true); 2076 lfmd++; 2077 } 2078 pthread_mutex_unlock(&blob->bs->used_clusters_mutex); 2079 } 2080 2081 blob->active.num_clusters = sz; 2082 blob->active.num_extent_pages = new_num_ep; 2083 2084 return 0; 2085 } 2086 2087 static void 2088 blob_persist_generate_new_md(struct spdk_blob_persist_ctx *ctx) 2089 { 2090 spdk_bs_sequence_t *seq = ctx->seq; 2091 struct spdk_blob *blob = ctx->blob; 2092 struct spdk_blob_store *bs = blob->bs; 2093 uint64_t i; 2094 uint32_t page_num; 2095 void *tmp; 2096 int rc; 2097 2098 /* Generate the new metadata */ 2099 rc = blob_serialize(blob, &ctx->pages, &blob->active.num_pages); 2100 if (rc < 0) { 2101 blob_persist_complete(seq, ctx, rc); 2102 return; 2103 } 2104 2105 assert(blob->active.num_pages >= 1); 2106 2107 /* Resize the cache of page indices */ 2108 tmp = realloc(blob->active.pages, blob->active.num_pages * sizeof(*blob->active.pages)); 2109 if (!tmp) { 2110 blob_persist_complete(seq, ctx, -ENOMEM); 2111 return; 2112 } 2113 blob->active.pages = tmp; 2114 2115 /* Assign this metadata to pages. This requires two passes - 2116 * one to verify that there are enough pages and a second 2117 * to actually claim them. */ 2118 page_num = 0; 2119 /* Note that this loop starts at one. The first page location is fixed by the blobid. */ 2120 for (i = 1; i < blob->active.num_pages; i++) { 2121 page_num = spdk_bit_array_find_first_clear(bs->used_md_pages, page_num); 2122 if (page_num == UINT32_MAX) { 2123 blob_persist_complete(seq, ctx, -ENOMEM); 2124 return; 2125 } 2126 page_num++; 2127 } 2128 2129 page_num = 0; 2130 blob->active.pages[0] = bs_blobid_to_page(blob->id); 2131 for (i = 1; i < blob->active.num_pages; i++) { 2132 page_num = spdk_bit_array_find_first_clear(bs->used_md_pages, page_num); 2133 ctx->pages[i - 1].next = page_num; 2134 /* Now that previous metadata page is complete, calculate the crc for it. */ 2135 ctx->pages[i - 1].crc = blob_md_page_calc_crc(&ctx->pages[i - 1]); 2136 blob->active.pages[i] = page_num; 2137 bs_claim_md_page(bs, page_num); 2138 SPDK_DEBUGLOG(blob, "Claiming page %u for blob %" PRIu64 "\n", page_num, blob->id); 2139 page_num++; 2140 } 2141 ctx->pages[i - 1].crc = blob_md_page_calc_crc(&ctx->pages[i - 1]); 2142 /* Start writing the metadata from last page to first */ 2143 blob->state = SPDK_BLOB_STATE_CLEAN; 2144 blob_persist_write_page_chain(seq, ctx); 2145 } 2146 2147 static void 2148 blob_persist_write_extent_pages(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2149 { 2150 struct spdk_blob_persist_ctx *ctx = cb_arg; 2151 struct spdk_blob *blob = ctx->blob; 2152 size_t i; 2153 uint32_t extent_page_id; 2154 uint32_t page_count = 0; 2155 int rc; 2156 2157 if (ctx->extent_page != NULL) { 2158 spdk_free(ctx->extent_page); 2159 ctx->extent_page = NULL; 2160 } 2161 2162 if (bserrno != 0) { 2163 blob_persist_complete(seq, ctx, bserrno); 2164 return; 2165 } 2166 2167 /* Only write out Extent Pages when blob was resized. */ 2168 for (i = ctx->next_extent_page; i < blob->active.extent_pages_array_size; i++) { 2169 extent_page_id = blob->active.extent_pages[i]; 2170 if (extent_page_id == 0) { 2171 /* No Extent Page to persist */ 2172 assert(spdk_blob_is_thin_provisioned(blob)); 2173 continue; 2174 } 2175 assert(spdk_bit_array_get(blob->bs->used_md_pages, extent_page_id)); 2176 ctx->next_extent_page = i + 1; 2177 rc = blob_serialize_add_page(ctx->blob, &ctx->extent_page, &page_count, &ctx->extent_page); 2178 if (rc < 0) { 2179 blob_persist_complete(seq, ctx, rc); 2180 return; 2181 } 2182 2183 blob->state = SPDK_BLOB_STATE_DIRTY; 2184 blob_serialize_extent_page(blob, i * SPDK_EXTENTS_PER_EP, ctx->extent_page); 2185 2186 ctx->extent_page->crc = blob_md_page_calc_crc(ctx->extent_page); 2187 2188 bs_sequence_write_dev(seq, ctx->extent_page, bs_md_page_to_lba(blob->bs, extent_page_id), 2189 bs_byte_to_lba(blob->bs, SPDK_BS_PAGE_SIZE), 2190 blob_persist_write_extent_pages, ctx); 2191 return; 2192 } 2193 2194 blob_persist_generate_new_md(ctx); 2195 } 2196 2197 static void 2198 blob_persist_start(struct spdk_blob_persist_ctx *ctx) 2199 { 2200 spdk_bs_sequence_t *seq = ctx->seq; 2201 struct spdk_blob *blob = ctx->blob; 2202 2203 if (blob->active.num_pages == 0) { 2204 /* This is the signal that the blob should be deleted. 2205 * Immediately jump to the clean up routine. */ 2206 assert(blob->clean.num_pages > 0); 2207 blob->state = SPDK_BLOB_STATE_CLEAN; 2208 blob_persist_zero_pages(seq, ctx, 0); 2209 return; 2210 2211 } 2212 2213 if (blob->clean.num_clusters < blob->active.num_clusters) { 2214 /* Blob was resized up */ 2215 assert(blob->clean.num_extent_pages <= blob->active.num_extent_pages); 2216 ctx->next_extent_page = spdk_max(1, blob->clean.num_extent_pages) - 1; 2217 } else if (blob->active.num_clusters < blob->active.cluster_array_size) { 2218 /* Blob was resized down */ 2219 assert(blob->clean.num_extent_pages >= blob->active.num_extent_pages); 2220 ctx->next_extent_page = spdk_max(1, blob->active.num_extent_pages) - 1; 2221 } else { 2222 /* No change in size occurred */ 2223 blob_persist_generate_new_md(ctx); 2224 return; 2225 } 2226 2227 blob_persist_write_extent_pages(seq, ctx, 0); 2228 } 2229 2230 static void 2231 blob_persist_dirty_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2232 { 2233 struct spdk_blob_persist_ctx *ctx = cb_arg; 2234 2235 spdk_free(ctx->super); 2236 2237 if (bserrno != 0) { 2238 blob_persist_complete(seq, ctx, bserrno); 2239 return; 2240 } 2241 2242 ctx->blob->bs->clean = 0; 2243 2244 blob_persist_start(ctx); 2245 } 2246 2247 static void 2248 bs_write_super(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 2249 struct spdk_bs_super_block *super, spdk_bs_sequence_cpl cb_fn, void *cb_arg); 2250 2251 2252 static void 2253 blob_persist_dirty(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2254 { 2255 struct spdk_blob_persist_ctx *ctx = cb_arg; 2256 2257 if (bserrno != 0) { 2258 spdk_free(ctx->super); 2259 blob_persist_complete(seq, ctx, bserrno); 2260 return; 2261 } 2262 2263 ctx->super->clean = 0; 2264 if (ctx->super->size == 0) { 2265 ctx->super->size = ctx->blob->bs->dev->blockcnt * ctx->blob->bs->dev->blocklen; 2266 } 2267 2268 bs_write_super(seq, ctx->blob->bs, ctx->super, blob_persist_dirty_cpl, ctx); 2269 } 2270 2271 static void 2272 blob_persist_check_dirty(struct spdk_blob_persist_ctx *ctx) 2273 { 2274 if (ctx->blob->bs->clean) { 2275 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 2276 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 2277 if (!ctx->super) { 2278 blob_persist_complete(ctx->seq, ctx, -ENOMEM); 2279 return; 2280 } 2281 2282 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(ctx->blob->bs, 0), 2283 bs_byte_to_lba(ctx->blob->bs, sizeof(*ctx->super)), 2284 blob_persist_dirty, ctx); 2285 } else { 2286 blob_persist_start(ctx); 2287 } 2288 } 2289 2290 /* Write a blob to disk */ 2291 static void 2292 blob_persist(spdk_bs_sequence_t *seq, struct spdk_blob *blob, 2293 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 2294 { 2295 struct spdk_blob_persist_ctx *ctx; 2296 2297 blob_verify_md_op(blob); 2298 2299 if (blob->state == SPDK_BLOB_STATE_CLEAN && TAILQ_EMPTY(&blob->persists_to_complete)) { 2300 cb_fn(seq, cb_arg, 0); 2301 return; 2302 } 2303 2304 ctx = calloc(1, sizeof(*ctx)); 2305 if (!ctx) { 2306 cb_fn(seq, cb_arg, -ENOMEM); 2307 return; 2308 } 2309 ctx->blob = blob; 2310 ctx->seq = seq; 2311 ctx->cb_fn = cb_fn; 2312 ctx->cb_arg = cb_arg; 2313 2314 /* Multiple blob persists can affect one another, via blob->state or 2315 * blob mutable data changes. To prevent it, queue up the persists. */ 2316 if (!TAILQ_EMPTY(&blob->persists_to_complete)) { 2317 TAILQ_INSERT_TAIL(&blob->pending_persists, ctx, link); 2318 return; 2319 } 2320 TAILQ_INSERT_HEAD(&blob->persists_to_complete, ctx, link); 2321 2322 blob_persist_check_dirty(ctx); 2323 } 2324 2325 struct spdk_blob_copy_cluster_ctx { 2326 struct spdk_blob *blob; 2327 uint8_t *buf; 2328 uint64_t page; 2329 uint64_t new_cluster; 2330 uint32_t new_extent_page; 2331 spdk_bs_sequence_t *seq; 2332 }; 2333 2334 static void 2335 blob_allocate_and_copy_cluster_cpl(void *cb_arg, int bserrno) 2336 { 2337 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2338 struct spdk_bs_request_set *set = (struct spdk_bs_request_set *)ctx->seq; 2339 TAILQ_HEAD(, spdk_bs_request_set) requests; 2340 spdk_bs_user_op_t *op; 2341 2342 TAILQ_INIT(&requests); 2343 TAILQ_SWAP(&set->channel->need_cluster_alloc, &requests, spdk_bs_request_set, link); 2344 2345 while (!TAILQ_EMPTY(&requests)) { 2346 op = TAILQ_FIRST(&requests); 2347 TAILQ_REMOVE(&requests, op, link); 2348 if (bserrno == 0) { 2349 bs_user_op_execute(op); 2350 } else { 2351 bs_user_op_abort(op); 2352 } 2353 } 2354 2355 spdk_free(ctx->buf); 2356 free(ctx); 2357 } 2358 2359 static void 2360 blob_insert_cluster_cpl(void *cb_arg, int bserrno) 2361 { 2362 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2363 2364 if (bserrno) { 2365 if (bserrno == -EEXIST) { 2366 /* The metadata insert failed because another thread 2367 * allocated the cluster first. Free our cluster 2368 * but continue without error. */ 2369 bserrno = 0; 2370 } 2371 pthread_mutex_lock(&ctx->blob->bs->used_clusters_mutex); 2372 bs_release_cluster(ctx->blob->bs, ctx->new_cluster); 2373 pthread_mutex_unlock(&ctx->blob->bs->used_clusters_mutex); 2374 if (ctx->new_extent_page != 0) { 2375 bs_release_md_page(ctx->blob->bs, ctx->new_extent_page); 2376 } 2377 } 2378 2379 bs_sequence_finish(ctx->seq, bserrno); 2380 } 2381 2382 static void 2383 blob_write_copy_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2384 { 2385 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2386 uint32_t cluster_number; 2387 2388 if (bserrno) { 2389 /* The write failed, so jump to the final completion handler */ 2390 bs_sequence_finish(seq, bserrno); 2391 return; 2392 } 2393 2394 cluster_number = bs_page_to_cluster(ctx->blob->bs, ctx->page); 2395 2396 blob_insert_cluster_on_md_thread(ctx->blob, cluster_number, ctx->new_cluster, 2397 ctx->new_extent_page, blob_insert_cluster_cpl, ctx); 2398 } 2399 2400 static void 2401 blob_write_copy(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2402 { 2403 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 2404 2405 if (bserrno != 0) { 2406 /* The read failed, so jump to the final completion handler */ 2407 bs_sequence_finish(seq, bserrno); 2408 return; 2409 } 2410 2411 /* Write whole cluster */ 2412 bs_sequence_write_dev(seq, ctx->buf, 2413 bs_cluster_to_lba(ctx->blob->bs, ctx->new_cluster), 2414 bs_cluster_to_lba(ctx->blob->bs, 1), 2415 blob_write_copy_cpl, ctx); 2416 } 2417 2418 static void 2419 bs_allocate_and_copy_cluster(struct spdk_blob *blob, 2420 struct spdk_io_channel *_ch, 2421 uint64_t io_unit, spdk_bs_user_op_t *op) 2422 { 2423 struct spdk_bs_cpl cpl; 2424 struct spdk_bs_channel *ch; 2425 struct spdk_blob_copy_cluster_ctx *ctx; 2426 uint32_t cluster_start_page; 2427 uint32_t cluster_number; 2428 int rc; 2429 2430 ch = spdk_io_channel_get_ctx(_ch); 2431 2432 if (!TAILQ_EMPTY(&ch->need_cluster_alloc)) { 2433 /* There are already operations pending. Queue this user op 2434 * and return because it will be re-executed when the outstanding 2435 * cluster allocation completes. */ 2436 TAILQ_INSERT_TAIL(&ch->need_cluster_alloc, op, link); 2437 return; 2438 } 2439 2440 /* Round the io_unit offset down to the first page in the cluster */ 2441 cluster_start_page = bs_io_unit_to_cluster_start(blob, io_unit); 2442 2443 /* Calculate which index in the metadata cluster array the corresponding 2444 * cluster is supposed to be at. */ 2445 cluster_number = bs_io_unit_to_cluster_number(blob, io_unit); 2446 2447 ctx = calloc(1, sizeof(*ctx)); 2448 if (!ctx) { 2449 bs_user_op_abort(op); 2450 return; 2451 } 2452 2453 assert(blob->bs->cluster_sz % blob->back_bs_dev->blocklen == 0); 2454 2455 ctx->blob = blob; 2456 ctx->page = cluster_start_page; 2457 2458 if (blob->parent_id != SPDK_BLOBID_INVALID) { 2459 ctx->buf = spdk_malloc(blob->bs->cluster_sz, blob->back_bs_dev->blocklen, 2460 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 2461 if (!ctx->buf) { 2462 SPDK_ERRLOG("DMA allocation for cluster of size = %" PRIu32 " failed.\n", 2463 blob->bs->cluster_sz); 2464 free(ctx); 2465 bs_user_op_abort(op); 2466 return; 2467 } 2468 } 2469 2470 pthread_mutex_lock(&blob->bs->used_clusters_mutex); 2471 rc = bs_allocate_cluster(blob, cluster_number, &ctx->new_cluster, &ctx->new_extent_page, 2472 false); 2473 pthread_mutex_unlock(&blob->bs->used_clusters_mutex); 2474 if (rc != 0) { 2475 spdk_free(ctx->buf); 2476 free(ctx); 2477 bs_user_op_abort(op); 2478 return; 2479 } 2480 2481 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2482 cpl.u.blob_basic.cb_fn = blob_allocate_and_copy_cluster_cpl; 2483 cpl.u.blob_basic.cb_arg = ctx; 2484 2485 ctx->seq = bs_sequence_start(_ch, &cpl); 2486 if (!ctx->seq) { 2487 pthread_mutex_lock(&blob->bs->used_clusters_mutex); 2488 bs_release_cluster(blob->bs, ctx->new_cluster); 2489 pthread_mutex_unlock(&blob->bs->used_clusters_mutex); 2490 spdk_free(ctx->buf); 2491 free(ctx); 2492 bs_user_op_abort(op); 2493 return; 2494 } 2495 2496 /* Queue the user op to block other incoming operations */ 2497 TAILQ_INSERT_TAIL(&ch->need_cluster_alloc, op, link); 2498 2499 if (blob->parent_id != SPDK_BLOBID_INVALID) { 2500 /* Read cluster from backing device */ 2501 bs_sequence_read_bs_dev(ctx->seq, blob->back_bs_dev, ctx->buf, 2502 bs_dev_page_to_lba(blob->back_bs_dev, cluster_start_page), 2503 bs_dev_byte_to_lba(blob->back_bs_dev, blob->bs->cluster_sz), 2504 blob_write_copy, ctx); 2505 } else { 2506 blob_insert_cluster_on_md_thread(ctx->blob, cluster_number, ctx->new_cluster, 2507 ctx->new_extent_page, blob_insert_cluster_cpl, ctx); 2508 } 2509 } 2510 2511 static inline bool 2512 blob_calculate_lba_and_lba_count(struct spdk_blob *blob, uint64_t io_unit, uint64_t length, 2513 uint64_t *lba, uint64_t *lba_count) 2514 { 2515 *lba_count = length; 2516 2517 if (!bs_io_unit_is_allocated(blob, io_unit)) { 2518 assert(blob->back_bs_dev != NULL); 2519 *lba = bs_io_unit_to_back_dev_lba(blob, io_unit); 2520 *lba_count = bs_io_unit_to_back_dev_lba(blob, *lba_count); 2521 return false; 2522 } else { 2523 *lba = bs_blob_io_unit_to_lba(blob, io_unit); 2524 return true; 2525 } 2526 } 2527 2528 struct op_split_ctx { 2529 struct spdk_blob *blob; 2530 struct spdk_io_channel *channel; 2531 uint64_t io_unit_offset; 2532 uint64_t io_units_remaining; 2533 void *curr_payload; 2534 enum spdk_blob_op_type op_type; 2535 spdk_bs_sequence_t *seq; 2536 }; 2537 2538 static void 2539 blob_request_submit_op_split_next(void *cb_arg, int bserrno) 2540 { 2541 struct op_split_ctx *ctx = cb_arg; 2542 struct spdk_blob *blob = ctx->blob; 2543 struct spdk_io_channel *ch = ctx->channel; 2544 enum spdk_blob_op_type op_type = ctx->op_type; 2545 uint8_t *buf = ctx->curr_payload; 2546 uint64_t offset = ctx->io_unit_offset; 2547 uint64_t length = ctx->io_units_remaining; 2548 uint64_t op_length; 2549 2550 if (bserrno != 0 || ctx->io_units_remaining == 0) { 2551 bs_sequence_finish(ctx->seq, bserrno); 2552 free(ctx); 2553 return; 2554 } 2555 2556 op_length = spdk_min(length, bs_num_io_units_to_cluster_boundary(blob, 2557 offset)); 2558 2559 /* Update length and payload for next operation */ 2560 ctx->io_units_remaining -= op_length; 2561 ctx->io_unit_offset += op_length; 2562 if (op_type == SPDK_BLOB_WRITE || op_type == SPDK_BLOB_READ) { 2563 ctx->curr_payload += op_length * blob->bs->io_unit_size; 2564 } 2565 2566 switch (op_type) { 2567 case SPDK_BLOB_READ: 2568 spdk_blob_io_read(blob, ch, buf, offset, op_length, 2569 blob_request_submit_op_split_next, ctx); 2570 break; 2571 case SPDK_BLOB_WRITE: 2572 spdk_blob_io_write(blob, ch, buf, offset, op_length, 2573 blob_request_submit_op_split_next, ctx); 2574 break; 2575 case SPDK_BLOB_UNMAP: 2576 spdk_blob_io_unmap(blob, ch, offset, op_length, 2577 blob_request_submit_op_split_next, ctx); 2578 break; 2579 case SPDK_BLOB_WRITE_ZEROES: 2580 spdk_blob_io_write_zeroes(blob, ch, offset, op_length, 2581 blob_request_submit_op_split_next, ctx); 2582 break; 2583 case SPDK_BLOB_READV: 2584 case SPDK_BLOB_WRITEV: 2585 SPDK_ERRLOG("readv/write not valid\n"); 2586 bs_sequence_finish(ctx->seq, -EINVAL); 2587 free(ctx); 2588 break; 2589 } 2590 } 2591 2592 static void 2593 blob_request_submit_op_split(struct spdk_io_channel *ch, struct spdk_blob *blob, 2594 void *payload, uint64_t offset, uint64_t length, 2595 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 2596 { 2597 struct op_split_ctx *ctx; 2598 spdk_bs_sequence_t *seq; 2599 struct spdk_bs_cpl cpl; 2600 2601 assert(blob != NULL); 2602 2603 ctx = calloc(1, sizeof(struct op_split_ctx)); 2604 if (ctx == NULL) { 2605 cb_fn(cb_arg, -ENOMEM); 2606 return; 2607 } 2608 2609 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2610 cpl.u.blob_basic.cb_fn = cb_fn; 2611 cpl.u.blob_basic.cb_arg = cb_arg; 2612 2613 seq = bs_sequence_start(ch, &cpl); 2614 if (!seq) { 2615 free(ctx); 2616 cb_fn(cb_arg, -ENOMEM); 2617 return; 2618 } 2619 2620 ctx->blob = blob; 2621 ctx->channel = ch; 2622 ctx->curr_payload = payload; 2623 ctx->io_unit_offset = offset; 2624 ctx->io_units_remaining = length; 2625 ctx->op_type = op_type; 2626 ctx->seq = seq; 2627 2628 blob_request_submit_op_split_next(ctx, 0); 2629 } 2630 2631 static void 2632 blob_request_submit_op_single(struct spdk_io_channel *_ch, struct spdk_blob *blob, 2633 void *payload, uint64_t offset, uint64_t length, 2634 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 2635 { 2636 struct spdk_bs_cpl cpl; 2637 uint64_t lba; 2638 uint64_t lba_count; 2639 bool is_allocated; 2640 2641 assert(blob != NULL); 2642 2643 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2644 cpl.u.blob_basic.cb_fn = cb_fn; 2645 cpl.u.blob_basic.cb_arg = cb_arg; 2646 2647 if (blob->frozen_refcnt) { 2648 /* This blob I/O is frozen */ 2649 spdk_bs_user_op_t *op; 2650 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_ch); 2651 2652 op = bs_user_op_alloc(_ch, &cpl, op_type, blob, payload, 0, offset, length); 2653 if (!op) { 2654 cb_fn(cb_arg, -ENOMEM); 2655 return; 2656 } 2657 2658 TAILQ_INSERT_TAIL(&bs_channel->queued_io, op, link); 2659 2660 return; 2661 } 2662 2663 is_allocated = blob_calculate_lba_and_lba_count(blob, offset, length, &lba, &lba_count); 2664 2665 switch (op_type) { 2666 case SPDK_BLOB_READ: { 2667 spdk_bs_batch_t *batch; 2668 2669 batch = bs_batch_open(_ch, &cpl); 2670 if (!batch) { 2671 cb_fn(cb_arg, -ENOMEM); 2672 return; 2673 } 2674 2675 if (is_allocated) { 2676 /* Read from the blob */ 2677 bs_batch_read_dev(batch, payload, lba, lba_count); 2678 } else { 2679 /* Read from the backing block device */ 2680 bs_batch_read_bs_dev(batch, blob->back_bs_dev, payload, lba, lba_count); 2681 } 2682 2683 bs_batch_close(batch); 2684 break; 2685 } 2686 case SPDK_BLOB_WRITE: 2687 case SPDK_BLOB_WRITE_ZEROES: { 2688 if (is_allocated) { 2689 /* Write to the blob */ 2690 spdk_bs_batch_t *batch; 2691 2692 if (lba_count == 0) { 2693 cb_fn(cb_arg, 0); 2694 return; 2695 } 2696 2697 batch = bs_batch_open(_ch, &cpl); 2698 if (!batch) { 2699 cb_fn(cb_arg, -ENOMEM); 2700 return; 2701 } 2702 2703 if (op_type == SPDK_BLOB_WRITE) { 2704 bs_batch_write_dev(batch, payload, lba, lba_count); 2705 } else { 2706 bs_batch_write_zeroes_dev(batch, lba, lba_count); 2707 } 2708 2709 bs_batch_close(batch); 2710 } else { 2711 /* Queue this operation and allocate the cluster */ 2712 spdk_bs_user_op_t *op; 2713 2714 op = bs_user_op_alloc(_ch, &cpl, op_type, blob, payload, 0, offset, length); 2715 if (!op) { 2716 cb_fn(cb_arg, -ENOMEM); 2717 return; 2718 } 2719 2720 bs_allocate_and_copy_cluster(blob, _ch, offset, op); 2721 } 2722 break; 2723 } 2724 case SPDK_BLOB_UNMAP: { 2725 spdk_bs_batch_t *batch; 2726 2727 batch = bs_batch_open(_ch, &cpl); 2728 if (!batch) { 2729 cb_fn(cb_arg, -ENOMEM); 2730 return; 2731 } 2732 2733 if (is_allocated) { 2734 bs_batch_unmap_dev(batch, lba, lba_count); 2735 } 2736 2737 bs_batch_close(batch); 2738 break; 2739 } 2740 case SPDK_BLOB_READV: 2741 case SPDK_BLOB_WRITEV: 2742 SPDK_ERRLOG("readv/write not valid\n"); 2743 cb_fn(cb_arg, -EINVAL); 2744 break; 2745 } 2746 } 2747 2748 static void 2749 blob_request_submit_op(struct spdk_blob *blob, struct spdk_io_channel *_channel, 2750 void *payload, uint64_t offset, uint64_t length, 2751 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 2752 { 2753 assert(blob != NULL); 2754 2755 if (blob->data_ro && op_type != SPDK_BLOB_READ) { 2756 cb_fn(cb_arg, -EPERM); 2757 return; 2758 } 2759 2760 if (length == 0) { 2761 cb_fn(cb_arg, 0); 2762 return; 2763 } 2764 2765 if (offset + length > bs_cluster_to_lba(blob->bs, blob->active.num_clusters)) { 2766 cb_fn(cb_arg, -EINVAL); 2767 return; 2768 } 2769 if (length <= bs_num_io_units_to_cluster_boundary(blob, offset)) { 2770 blob_request_submit_op_single(_channel, blob, payload, offset, length, 2771 cb_fn, cb_arg, op_type); 2772 } else { 2773 blob_request_submit_op_split(_channel, blob, payload, offset, length, 2774 cb_fn, cb_arg, op_type); 2775 } 2776 } 2777 2778 struct rw_iov_ctx { 2779 struct spdk_blob *blob; 2780 struct spdk_io_channel *channel; 2781 spdk_blob_op_complete cb_fn; 2782 void *cb_arg; 2783 bool read; 2784 int iovcnt; 2785 struct iovec *orig_iov; 2786 uint64_t io_unit_offset; 2787 uint64_t io_units_remaining; 2788 uint64_t io_units_done; 2789 struct iovec iov[0]; 2790 }; 2791 2792 static void 2793 rw_iov_done(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2794 { 2795 assert(cb_arg == NULL); 2796 bs_sequence_finish(seq, bserrno); 2797 } 2798 2799 static void 2800 rw_iov_split_next(void *cb_arg, int bserrno) 2801 { 2802 struct rw_iov_ctx *ctx = cb_arg; 2803 struct spdk_blob *blob = ctx->blob; 2804 struct iovec *iov, *orig_iov; 2805 int iovcnt; 2806 size_t orig_iovoff; 2807 uint64_t io_units_count, io_units_to_boundary, io_unit_offset; 2808 uint64_t byte_count; 2809 2810 if (bserrno != 0 || ctx->io_units_remaining == 0) { 2811 ctx->cb_fn(ctx->cb_arg, bserrno); 2812 free(ctx); 2813 return; 2814 } 2815 2816 io_unit_offset = ctx->io_unit_offset; 2817 io_units_to_boundary = bs_num_io_units_to_cluster_boundary(blob, io_unit_offset); 2818 io_units_count = spdk_min(ctx->io_units_remaining, io_units_to_boundary); 2819 /* 2820 * Get index and offset into the original iov array for our current position in the I/O sequence. 2821 * byte_count will keep track of how many bytes remaining until orig_iov and orig_iovoff will 2822 * point to the current position in the I/O sequence. 2823 */ 2824 byte_count = ctx->io_units_done * blob->bs->io_unit_size; 2825 orig_iov = &ctx->orig_iov[0]; 2826 orig_iovoff = 0; 2827 while (byte_count > 0) { 2828 if (byte_count >= orig_iov->iov_len) { 2829 byte_count -= orig_iov->iov_len; 2830 orig_iov++; 2831 } else { 2832 orig_iovoff = byte_count; 2833 byte_count = 0; 2834 } 2835 } 2836 2837 /* 2838 * Build an iov array for the next I/O in the sequence. byte_count will keep track of how many 2839 * bytes of this next I/O remain to be accounted for in the new iov array. 2840 */ 2841 byte_count = io_units_count * blob->bs->io_unit_size; 2842 iov = &ctx->iov[0]; 2843 iovcnt = 0; 2844 while (byte_count > 0) { 2845 assert(iovcnt < ctx->iovcnt); 2846 iov->iov_len = spdk_min(byte_count, orig_iov->iov_len - orig_iovoff); 2847 iov->iov_base = orig_iov->iov_base + orig_iovoff; 2848 byte_count -= iov->iov_len; 2849 orig_iovoff = 0; 2850 orig_iov++; 2851 iov++; 2852 iovcnt++; 2853 } 2854 2855 ctx->io_unit_offset += io_units_count; 2856 ctx->io_units_remaining -= io_units_count; 2857 ctx->io_units_done += io_units_count; 2858 iov = &ctx->iov[0]; 2859 2860 if (ctx->read) { 2861 spdk_blob_io_readv(ctx->blob, ctx->channel, iov, iovcnt, io_unit_offset, 2862 io_units_count, rw_iov_split_next, ctx); 2863 } else { 2864 spdk_blob_io_writev(ctx->blob, ctx->channel, iov, iovcnt, io_unit_offset, 2865 io_units_count, rw_iov_split_next, ctx); 2866 } 2867 } 2868 2869 static void 2870 blob_request_submit_rw_iov(struct spdk_blob *blob, struct spdk_io_channel *_channel, 2871 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 2872 spdk_blob_op_complete cb_fn, void *cb_arg, bool read) 2873 { 2874 struct spdk_bs_cpl cpl; 2875 2876 assert(blob != NULL); 2877 2878 if (!read && blob->data_ro) { 2879 cb_fn(cb_arg, -EPERM); 2880 return; 2881 } 2882 2883 if (length == 0) { 2884 cb_fn(cb_arg, 0); 2885 return; 2886 } 2887 2888 if (offset + length > bs_cluster_to_lba(blob->bs, blob->active.num_clusters)) { 2889 cb_fn(cb_arg, -EINVAL); 2890 return; 2891 } 2892 2893 /* 2894 * For now, we implement readv/writev using a sequence (instead of a batch) to account for having 2895 * to split a request that spans a cluster boundary. For I/O that do not span a cluster boundary, 2896 * there will be no noticeable difference compared to using a batch. For I/O that do span a cluster 2897 * boundary, the target LBAs (after blob offset to LBA translation) may not be contiguous, so we need 2898 * to allocate a separate iov array and split the I/O such that none of the resulting 2899 * smaller I/O cross a cluster boundary. These smaller I/O will be issued in sequence (not in parallel) 2900 * but since this case happens very infrequently, any performance impact will be negligible. 2901 * 2902 * This could be optimized in the future to allocate a big enough iov array to account for all of the iovs 2903 * for all of the smaller I/Os, pre-build all of the iov arrays for the smaller I/Os, then issue them 2904 * in a batch. That would also require creating an intermediate spdk_bs_cpl that would get called 2905 * when the batch was completed, to allow for freeing the memory for the iov arrays. 2906 */ 2907 if (spdk_likely(length <= bs_num_io_units_to_cluster_boundary(blob, offset))) { 2908 uint64_t lba_count; 2909 uint64_t lba; 2910 bool is_allocated; 2911 2912 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2913 cpl.u.blob_basic.cb_fn = cb_fn; 2914 cpl.u.blob_basic.cb_arg = cb_arg; 2915 2916 if (blob->frozen_refcnt) { 2917 /* This blob I/O is frozen */ 2918 enum spdk_blob_op_type op_type; 2919 spdk_bs_user_op_t *op; 2920 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_channel); 2921 2922 op_type = read ? SPDK_BLOB_READV : SPDK_BLOB_WRITEV; 2923 op = bs_user_op_alloc(_channel, &cpl, op_type, blob, iov, iovcnt, offset, length); 2924 if (!op) { 2925 cb_fn(cb_arg, -ENOMEM); 2926 return; 2927 } 2928 2929 TAILQ_INSERT_TAIL(&bs_channel->queued_io, op, link); 2930 2931 return; 2932 } 2933 2934 is_allocated = blob_calculate_lba_and_lba_count(blob, offset, length, &lba, &lba_count); 2935 2936 if (read) { 2937 spdk_bs_sequence_t *seq; 2938 2939 seq = bs_sequence_start(_channel, &cpl); 2940 if (!seq) { 2941 cb_fn(cb_arg, -ENOMEM); 2942 return; 2943 } 2944 2945 if (is_allocated) { 2946 bs_sequence_readv_dev(seq, iov, iovcnt, lba, lba_count, rw_iov_done, NULL); 2947 } else { 2948 bs_sequence_readv_bs_dev(seq, blob->back_bs_dev, iov, iovcnt, lba, lba_count, 2949 rw_iov_done, NULL); 2950 } 2951 } else { 2952 if (is_allocated) { 2953 spdk_bs_sequence_t *seq; 2954 2955 seq = bs_sequence_start(_channel, &cpl); 2956 if (!seq) { 2957 cb_fn(cb_arg, -ENOMEM); 2958 return; 2959 } 2960 2961 bs_sequence_writev_dev(seq, iov, iovcnt, lba, lba_count, rw_iov_done, NULL); 2962 } else { 2963 /* Queue this operation and allocate the cluster */ 2964 spdk_bs_user_op_t *op; 2965 2966 op = bs_user_op_alloc(_channel, &cpl, SPDK_BLOB_WRITEV, blob, iov, iovcnt, offset, 2967 length); 2968 if (!op) { 2969 cb_fn(cb_arg, -ENOMEM); 2970 return; 2971 } 2972 2973 bs_allocate_and_copy_cluster(blob, _channel, offset, op); 2974 } 2975 } 2976 } else { 2977 struct rw_iov_ctx *ctx; 2978 2979 ctx = calloc(1, sizeof(struct rw_iov_ctx) + iovcnt * sizeof(struct iovec)); 2980 if (ctx == NULL) { 2981 cb_fn(cb_arg, -ENOMEM); 2982 return; 2983 } 2984 2985 ctx->blob = blob; 2986 ctx->channel = _channel; 2987 ctx->cb_fn = cb_fn; 2988 ctx->cb_arg = cb_arg; 2989 ctx->read = read; 2990 ctx->orig_iov = iov; 2991 ctx->iovcnt = iovcnt; 2992 ctx->io_unit_offset = offset; 2993 ctx->io_units_remaining = length; 2994 ctx->io_units_done = 0; 2995 2996 rw_iov_split_next(ctx, 0); 2997 } 2998 } 2999 3000 static struct spdk_blob * 3001 blob_lookup(struct spdk_blob_store *bs, spdk_blob_id blobid) 3002 { 3003 struct spdk_blob find; 3004 3005 if (spdk_bit_array_get(bs->open_blobids, blobid) == 0) { 3006 return NULL; 3007 } 3008 3009 find.id = blobid; 3010 return RB_FIND(spdk_blob_tree, &bs->open_blobs, &find); 3011 } 3012 3013 static void 3014 blob_get_snapshot_and_clone_entries(struct spdk_blob *blob, 3015 struct spdk_blob_list **snapshot_entry, struct spdk_blob_list **clone_entry) 3016 { 3017 assert(blob != NULL); 3018 *snapshot_entry = NULL; 3019 *clone_entry = NULL; 3020 3021 if (blob->parent_id == SPDK_BLOBID_INVALID) { 3022 return; 3023 } 3024 3025 TAILQ_FOREACH(*snapshot_entry, &blob->bs->snapshots, link) { 3026 if ((*snapshot_entry)->id == blob->parent_id) { 3027 break; 3028 } 3029 } 3030 3031 if (*snapshot_entry != NULL) { 3032 TAILQ_FOREACH(*clone_entry, &(*snapshot_entry)->clones, link) { 3033 if ((*clone_entry)->id == blob->id) { 3034 break; 3035 } 3036 } 3037 3038 assert(*clone_entry != NULL); 3039 } 3040 } 3041 3042 static int 3043 bs_channel_create(void *io_device, void *ctx_buf) 3044 { 3045 struct spdk_blob_store *bs = io_device; 3046 struct spdk_bs_channel *channel = ctx_buf; 3047 struct spdk_bs_dev *dev; 3048 uint32_t max_ops = bs->max_channel_ops; 3049 uint32_t i; 3050 3051 dev = bs->dev; 3052 3053 channel->req_mem = calloc(max_ops, sizeof(struct spdk_bs_request_set)); 3054 if (!channel->req_mem) { 3055 return -1; 3056 } 3057 3058 TAILQ_INIT(&channel->reqs); 3059 3060 for (i = 0; i < max_ops; i++) { 3061 TAILQ_INSERT_TAIL(&channel->reqs, &channel->req_mem[i], link); 3062 } 3063 3064 channel->bs = bs; 3065 channel->dev = dev; 3066 channel->dev_channel = dev->create_channel(dev); 3067 3068 if (!channel->dev_channel) { 3069 SPDK_ERRLOG("Failed to create device channel.\n"); 3070 free(channel->req_mem); 3071 return -1; 3072 } 3073 3074 TAILQ_INIT(&channel->need_cluster_alloc); 3075 TAILQ_INIT(&channel->queued_io); 3076 3077 return 0; 3078 } 3079 3080 static void 3081 bs_channel_destroy(void *io_device, void *ctx_buf) 3082 { 3083 struct spdk_bs_channel *channel = ctx_buf; 3084 spdk_bs_user_op_t *op; 3085 3086 while (!TAILQ_EMPTY(&channel->need_cluster_alloc)) { 3087 op = TAILQ_FIRST(&channel->need_cluster_alloc); 3088 TAILQ_REMOVE(&channel->need_cluster_alloc, op, link); 3089 bs_user_op_abort(op); 3090 } 3091 3092 while (!TAILQ_EMPTY(&channel->queued_io)) { 3093 op = TAILQ_FIRST(&channel->queued_io); 3094 TAILQ_REMOVE(&channel->queued_io, op, link); 3095 bs_user_op_abort(op); 3096 } 3097 3098 free(channel->req_mem); 3099 channel->dev->destroy_channel(channel->dev, channel->dev_channel); 3100 } 3101 3102 static void 3103 bs_dev_destroy(void *io_device) 3104 { 3105 struct spdk_blob_store *bs = io_device; 3106 struct spdk_blob *blob, *blob_tmp; 3107 3108 bs->dev->destroy(bs->dev); 3109 3110 RB_FOREACH_SAFE(blob, spdk_blob_tree, &bs->open_blobs, blob_tmp) { 3111 RB_REMOVE(spdk_blob_tree, &bs->open_blobs, blob); 3112 spdk_bit_array_clear(bs->open_blobids, blob->id); 3113 blob_free(blob); 3114 } 3115 3116 pthread_mutex_destroy(&bs->used_clusters_mutex); 3117 3118 spdk_bit_array_free(&bs->open_blobids); 3119 spdk_bit_array_free(&bs->used_blobids); 3120 spdk_bit_array_free(&bs->used_md_pages); 3121 spdk_bit_pool_free(&bs->used_clusters); 3122 /* 3123 * If this function is called for any reason except a successful unload, 3124 * the unload_cpl type will be NONE and this will be a nop. 3125 */ 3126 bs_call_cpl(&bs->unload_cpl, bs->unload_err); 3127 3128 free(bs); 3129 } 3130 3131 static int 3132 bs_blob_list_add(struct spdk_blob *blob) 3133 { 3134 spdk_blob_id snapshot_id; 3135 struct spdk_blob_list *snapshot_entry = NULL; 3136 struct spdk_blob_list *clone_entry = NULL; 3137 3138 assert(blob != NULL); 3139 3140 snapshot_id = blob->parent_id; 3141 if (snapshot_id == SPDK_BLOBID_INVALID) { 3142 return 0; 3143 } 3144 3145 snapshot_entry = bs_get_snapshot_entry(blob->bs, snapshot_id); 3146 if (snapshot_entry == NULL) { 3147 /* Snapshot not found */ 3148 snapshot_entry = calloc(1, sizeof(struct spdk_blob_list)); 3149 if (snapshot_entry == NULL) { 3150 return -ENOMEM; 3151 } 3152 snapshot_entry->id = snapshot_id; 3153 TAILQ_INIT(&snapshot_entry->clones); 3154 TAILQ_INSERT_TAIL(&blob->bs->snapshots, snapshot_entry, link); 3155 } else { 3156 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 3157 if (clone_entry->id == blob->id) { 3158 break; 3159 } 3160 } 3161 } 3162 3163 if (clone_entry == NULL) { 3164 /* Clone not found */ 3165 clone_entry = calloc(1, sizeof(struct spdk_blob_list)); 3166 if (clone_entry == NULL) { 3167 return -ENOMEM; 3168 } 3169 clone_entry->id = blob->id; 3170 TAILQ_INIT(&clone_entry->clones); 3171 TAILQ_INSERT_TAIL(&snapshot_entry->clones, clone_entry, link); 3172 snapshot_entry->clone_count++; 3173 } 3174 3175 return 0; 3176 } 3177 3178 static void 3179 bs_blob_list_remove(struct spdk_blob *blob) 3180 { 3181 struct spdk_blob_list *snapshot_entry = NULL; 3182 struct spdk_blob_list *clone_entry = NULL; 3183 3184 blob_get_snapshot_and_clone_entries(blob, &snapshot_entry, &clone_entry); 3185 3186 if (snapshot_entry == NULL) { 3187 return; 3188 } 3189 3190 blob->parent_id = SPDK_BLOBID_INVALID; 3191 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 3192 free(clone_entry); 3193 3194 snapshot_entry->clone_count--; 3195 } 3196 3197 static int 3198 bs_blob_list_free(struct spdk_blob_store *bs) 3199 { 3200 struct spdk_blob_list *snapshot_entry; 3201 struct spdk_blob_list *snapshot_entry_tmp; 3202 struct spdk_blob_list *clone_entry; 3203 struct spdk_blob_list *clone_entry_tmp; 3204 3205 TAILQ_FOREACH_SAFE(snapshot_entry, &bs->snapshots, link, snapshot_entry_tmp) { 3206 TAILQ_FOREACH_SAFE(clone_entry, &snapshot_entry->clones, link, clone_entry_tmp) { 3207 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 3208 free(clone_entry); 3209 } 3210 TAILQ_REMOVE(&bs->snapshots, snapshot_entry, link); 3211 free(snapshot_entry); 3212 } 3213 3214 return 0; 3215 } 3216 3217 static void 3218 bs_free(struct spdk_blob_store *bs) 3219 { 3220 bs_blob_list_free(bs); 3221 3222 bs_unregister_md_thread(bs); 3223 spdk_io_device_unregister(bs, bs_dev_destroy); 3224 } 3225 3226 void 3227 spdk_bs_opts_init(struct spdk_bs_opts *opts, size_t opts_size) 3228 { 3229 3230 if (!opts) { 3231 SPDK_ERRLOG("opts should not be NULL\n"); 3232 return; 3233 } 3234 3235 if (!opts_size) { 3236 SPDK_ERRLOG("opts_size should not be zero value\n"); 3237 return; 3238 } 3239 3240 memset(opts, 0, opts_size); 3241 opts->opts_size = opts_size; 3242 3243 #define FIELD_OK(field) \ 3244 offsetof(struct spdk_bs_opts, field) + sizeof(opts->field) <= opts_size 3245 3246 #define SET_FIELD(field, value) \ 3247 if (FIELD_OK(field)) { \ 3248 opts->field = value; \ 3249 } \ 3250 3251 SET_FIELD(cluster_sz, SPDK_BLOB_OPTS_CLUSTER_SZ); 3252 SET_FIELD(num_md_pages, SPDK_BLOB_OPTS_NUM_MD_PAGES); 3253 SET_FIELD(max_md_ops, SPDK_BLOB_OPTS_NUM_MD_PAGES); 3254 SET_FIELD(max_channel_ops, SPDK_BLOB_OPTS_DEFAULT_CHANNEL_OPS); 3255 SET_FIELD(clear_method, BS_CLEAR_WITH_UNMAP); 3256 3257 if (FIELD_OK(bstype)) { 3258 memset(&opts->bstype, 0, sizeof(opts->bstype)); 3259 } 3260 3261 SET_FIELD(iter_cb_fn, NULL); 3262 SET_FIELD(iter_cb_arg, NULL); 3263 SET_FIELD(force_recover, false); 3264 3265 #undef FIELD_OK 3266 #undef SET_FIELD 3267 } 3268 3269 static int 3270 bs_opts_verify(struct spdk_bs_opts *opts) 3271 { 3272 if (opts->cluster_sz == 0 || opts->num_md_pages == 0 || opts->max_md_ops == 0 || 3273 opts->max_channel_ops == 0) { 3274 SPDK_ERRLOG("Blobstore options cannot be set to 0\n"); 3275 return -1; 3276 } 3277 3278 return 0; 3279 } 3280 3281 /* START spdk_bs_load */ 3282 3283 /* spdk_bs_load_ctx is used for init, load, unload and dump code paths. */ 3284 3285 struct spdk_bs_load_ctx { 3286 struct spdk_blob_store *bs; 3287 struct spdk_bs_super_block *super; 3288 3289 struct spdk_bs_md_mask *mask; 3290 bool in_page_chain; 3291 uint32_t page_index; 3292 uint32_t cur_page; 3293 struct spdk_blob_md_page *page; 3294 3295 uint64_t num_extent_pages; 3296 uint32_t *extent_page_num; 3297 struct spdk_blob_md_page *extent_pages; 3298 struct spdk_bit_array *used_clusters; 3299 3300 spdk_bs_sequence_t *seq; 3301 spdk_blob_op_with_handle_complete iter_cb_fn; 3302 void *iter_cb_arg; 3303 struct spdk_blob *blob; 3304 spdk_blob_id blobid; 3305 3306 bool force_recover; 3307 3308 /* These fields are used in the spdk_bs_dump path. */ 3309 bool dumping; 3310 FILE *fp; 3311 spdk_bs_dump_print_xattr print_xattr_fn; 3312 char xattr_name[4096]; 3313 }; 3314 3315 static int 3316 bs_alloc(struct spdk_bs_dev *dev, struct spdk_bs_opts *opts, struct spdk_blob_store **_bs, 3317 struct spdk_bs_load_ctx **_ctx) 3318 { 3319 struct spdk_blob_store *bs; 3320 struct spdk_bs_load_ctx *ctx; 3321 uint64_t dev_size; 3322 int rc; 3323 3324 dev_size = dev->blocklen * dev->blockcnt; 3325 if (dev_size < opts->cluster_sz) { 3326 /* Device size cannot be smaller than cluster size of blobstore */ 3327 SPDK_INFOLOG(blob, "Device size %" PRIu64 " is smaller than cluster size %" PRIu32 "\n", 3328 dev_size, opts->cluster_sz); 3329 return -ENOSPC; 3330 } 3331 if (opts->cluster_sz < SPDK_BS_PAGE_SIZE) { 3332 /* Cluster size cannot be smaller than page size */ 3333 SPDK_ERRLOG("Cluster size %" PRIu32 " is smaller than page size %d\n", 3334 opts->cluster_sz, SPDK_BS_PAGE_SIZE); 3335 return -EINVAL; 3336 } 3337 bs = calloc(1, sizeof(struct spdk_blob_store)); 3338 if (!bs) { 3339 return -ENOMEM; 3340 } 3341 3342 ctx = calloc(1, sizeof(struct spdk_bs_load_ctx)); 3343 if (!ctx) { 3344 free(bs); 3345 return -ENOMEM; 3346 } 3347 3348 ctx->bs = bs; 3349 ctx->iter_cb_fn = opts->iter_cb_fn; 3350 ctx->iter_cb_arg = opts->iter_cb_arg; 3351 ctx->force_recover = opts->force_recover; 3352 3353 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 3354 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3355 if (!ctx->super) { 3356 free(ctx); 3357 free(bs); 3358 return -ENOMEM; 3359 } 3360 3361 RB_INIT(&bs->open_blobs); 3362 TAILQ_INIT(&bs->snapshots); 3363 bs->dev = dev; 3364 bs->md_thread = spdk_get_thread(); 3365 assert(bs->md_thread != NULL); 3366 3367 /* 3368 * Do not use bs_lba_to_cluster() here since blockcnt may not be an 3369 * even multiple of the cluster size. 3370 */ 3371 bs->cluster_sz = opts->cluster_sz; 3372 bs->total_clusters = dev->blockcnt / (bs->cluster_sz / dev->blocklen); 3373 ctx->used_clusters = spdk_bit_array_create(bs->total_clusters); 3374 if (!ctx->used_clusters) { 3375 spdk_free(ctx->super); 3376 free(ctx); 3377 free(bs); 3378 return -ENOMEM; 3379 } 3380 3381 bs->pages_per_cluster = bs->cluster_sz / SPDK_BS_PAGE_SIZE; 3382 if (spdk_u32_is_pow2(bs->pages_per_cluster)) { 3383 bs->pages_per_cluster_shift = spdk_u32log2(bs->pages_per_cluster); 3384 } 3385 bs->num_free_clusters = bs->total_clusters; 3386 bs->io_unit_size = dev->blocklen; 3387 3388 bs->max_channel_ops = opts->max_channel_ops; 3389 bs->super_blob = SPDK_BLOBID_INVALID; 3390 memcpy(&bs->bstype, &opts->bstype, sizeof(opts->bstype)); 3391 3392 /* The metadata is assumed to be at least 1 page */ 3393 bs->used_md_pages = spdk_bit_array_create(1); 3394 bs->used_blobids = spdk_bit_array_create(0); 3395 bs->open_blobids = spdk_bit_array_create(0); 3396 3397 pthread_mutex_init(&bs->used_clusters_mutex, NULL); 3398 3399 spdk_io_device_register(bs, bs_channel_create, bs_channel_destroy, 3400 sizeof(struct spdk_bs_channel), "blobstore"); 3401 rc = bs_register_md_thread(bs); 3402 if (rc == -1) { 3403 spdk_io_device_unregister(bs, NULL); 3404 pthread_mutex_destroy(&bs->used_clusters_mutex); 3405 spdk_bit_array_free(&bs->open_blobids); 3406 spdk_bit_array_free(&bs->used_blobids); 3407 spdk_bit_array_free(&bs->used_md_pages); 3408 spdk_bit_array_free(&ctx->used_clusters); 3409 spdk_free(ctx->super); 3410 free(ctx); 3411 free(bs); 3412 /* FIXME: this is a lie but don't know how to get a proper error code here */ 3413 return -ENOMEM; 3414 } 3415 3416 *_ctx = ctx; 3417 *_bs = bs; 3418 return 0; 3419 } 3420 3421 static void 3422 bs_load_ctx_fail(struct spdk_bs_load_ctx *ctx, int bserrno) 3423 { 3424 assert(bserrno != 0); 3425 3426 spdk_free(ctx->super); 3427 bs_sequence_finish(ctx->seq, bserrno); 3428 bs_free(ctx->bs); 3429 spdk_bit_array_free(&ctx->used_clusters); 3430 free(ctx); 3431 } 3432 3433 static void 3434 bs_write_super(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 3435 struct spdk_bs_super_block *super, spdk_bs_sequence_cpl cb_fn, void *cb_arg) 3436 { 3437 /* Update the values in the super block */ 3438 super->super_blob = bs->super_blob; 3439 memcpy(&super->bstype, &bs->bstype, sizeof(bs->bstype)); 3440 super->crc = blob_md_page_calc_crc(super); 3441 bs_sequence_write_dev(seq, super, bs_page_to_lba(bs, 0), 3442 bs_byte_to_lba(bs, sizeof(*super)), 3443 cb_fn, cb_arg); 3444 } 3445 3446 static void 3447 bs_write_used_clusters(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 3448 { 3449 struct spdk_bs_load_ctx *ctx = arg; 3450 uint64_t mask_size, lba, lba_count; 3451 3452 /* Write out the used clusters mask */ 3453 mask_size = ctx->super->used_cluster_mask_len * SPDK_BS_PAGE_SIZE; 3454 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 3455 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3456 if (!ctx->mask) { 3457 bs_load_ctx_fail(ctx, -ENOMEM); 3458 return; 3459 } 3460 3461 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_CLUSTERS; 3462 ctx->mask->length = ctx->bs->total_clusters; 3463 /* We could get here through the normal unload path, or through dirty 3464 * shutdown recovery. For the normal unload path, we use the mask from 3465 * the bit pool. For dirty shutdown recovery, we don't have a bit pool yet - 3466 * only the bit array from the load ctx. 3467 */ 3468 if (ctx->bs->used_clusters) { 3469 assert(ctx->mask->length == spdk_bit_pool_capacity(ctx->bs->used_clusters)); 3470 spdk_bit_pool_store_mask(ctx->bs->used_clusters, ctx->mask->mask); 3471 } else { 3472 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->used_clusters)); 3473 spdk_bit_array_store_mask(ctx->used_clusters, ctx->mask->mask); 3474 } 3475 lba = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 3476 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 3477 bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 3478 } 3479 3480 static void 3481 bs_write_used_md(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 3482 { 3483 struct spdk_bs_load_ctx *ctx = arg; 3484 uint64_t mask_size, lba, lba_count; 3485 3486 mask_size = ctx->super->used_page_mask_len * SPDK_BS_PAGE_SIZE; 3487 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 3488 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3489 if (!ctx->mask) { 3490 bs_load_ctx_fail(ctx, -ENOMEM); 3491 return; 3492 } 3493 3494 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_PAGES; 3495 ctx->mask->length = ctx->super->md_len; 3496 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_md_pages)); 3497 3498 spdk_bit_array_store_mask(ctx->bs->used_md_pages, ctx->mask->mask); 3499 lba = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_start); 3500 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_len); 3501 bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 3502 } 3503 3504 static void 3505 bs_write_used_blobids(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 3506 { 3507 struct spdk_bs_load_ctx *ctx = arg; 3508 uint64_t mask_size, lba, lba_count; 3509 3510 if (ctx->super->used_blobid_mask_len == 0) { 3511 /* 3512 * This is a pre-v3 on-disk format where the blobid mask does not get 3513 * written to disk. 3514 */ 3515 cb_fn(seq, arg, 0); 3516 return; 3517 } 3518 3519 mask_size = ctx->super->used_blobid_mask_len * SPDK_BS_PAGE_SIZE; 3520 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_SOCKET_ID_ANY, 3521 SPDK_MALLOC_DMA); 3522 if (!ctx->mask) { 3523 bs_load_ctx_fail(ctx, -ENOMEM); 3524 return; 3525 } 3526 3527 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_BLOBIDS; 3528 ctx->mask->length = ctx->super->md_len; 3529 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_blobids)); 3530 3531 spdk_bit_array_store_mask(ctx->bs->used_blobids, ctx->mask->mask); 3532 lba = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_start); 3533 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_len); 3534 bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 3535 } 3536 3537 static void 3538 blob_set_thin_provision(struct spdk_blob *blob) 3539 { 3540 blob_verify_md_op(blob); 3541 blob->invalid_flags |= SPDK_BLOB_THIN_PROV; 3542 blob->state = SPDK_BLOB_STATE_DIRTY; 3543 } 3544 3545 static void 3546 blob_set_clear_method(struct spdk_blob *blob, enum blob_clear_method clear_method) 3547 { 3548 blob_verify_md_op(blob); 3549 blob->clear_method = clear_method; 3550 blob->md_ro_flags |= (clear_method << SPDK_BLOB_CLEAR_METHOD_SHIFT); 3551 blob->state = SPDK_BLOB_STATE_DIRTY; 3552 } 3553 3554 static void bs_load_iter(void *arg, struct spdk_blob *blob, int bserrno); 3555 3556 static void 3557 bs_delete_corrupted_blob_cpl(void *cb_arg, int bserrno) 3558 { 3559 struct spdk_bs_load_ctx *ctx = cb_arg; 3560 spdk_blob_id id; 3561 int64_t page_num; 3562 3563 /* Iterate to next blob (we can't use spdk_bs_iter_next function as our 3564 * last blob has been removed */ 3565 page_num = bs_blobid_to_page(ctx->blobid); 3566 page_num++; 3567 page_num = spdk_bit_array_find_first_set(ctx->bs->used_blobids, page_num); 3568 if (page_num >= spdk_bit_array_capacity(ctx->bs->used_blobids)) { 3569 bs_load_iter(ctx, NULL, -ENOENT); 3570 return; 3571 } 3572 3573 id = bs_page_to_blobid(page_num); 3574 3575 spdk_bs_open_blob(ctx->bs, id, bs_load_iter, ctx); 3576 } 3577 3578 static void 3579 bs_delete_corrupted_close_cb(void *cb_arg, int bserrno) 3580 { 3581 struct spdk_bs_load_ctx *ctx = cb_arg; 3582 3583 if (bserrno != 0) { 3584 SPDK_ERRLOG("Failed to close corrupted blob\n"); 3585 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 3586 return; 3587 } 3588 3589 spdk_bs_delete_blob(ctx->bs, ctx->blobid, bs_delete_corrupted_blob_cpl, ctx); 3590 } 3591 3592 static void 3593 bs_delete_corrupted_blob(void *cb_arg, int bserrno) 3594 { 3595 struct spdk_bs_load_ctx *ctx = cb_arg; 3596 uint64_t i; 3597 3598 if (bserrno != 0) { 3599 SPDK_ERRLOG("Failed to close clone of a corrupted blob\n"); 3600 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 3601 return; 3602 } 3603 3604 /* Snapshot and clone have the same copy of cluster map and extent pages 3605 * at this point. Let's clear both for snapshot now, 3606 * so that it won't be cleared for clone later when we remove snapshot. 3607 * Also set thin provision to pass data corruption check */ 3608 for (i = 0; i < ctx->blob->active.num_clusters; i++) { 3609 ctx->blob->active.clusters[i] = 0; 3610 } 3611 for (i = 0; i < ctx->blob->active.num_extent_pages; i++) { 3612 ctx->blob->active.extent_pages[i] = 0; 3613 } 3614 3615 ctx->blob->md_ro = false; 3616 3617 blob_set_thin_provision(ctx->blob); 3618 3619 ctx->blobid = ctx->blob->id; 3620 3621 spdk_blob_close(ctx->blob, bs_delete_corrupted_close_cb, ctx); 3622 } 3623 3624 static void 3625 bs_update_corrupted_blob(void *cb_arg, int bserrno) 3626 { 3627 struct spdk_bs_load_ctx *ctx = cb_arg; 3628 3629 if (bserrno != 0) { 3630 SPDK_ERRLOG("Failed to close clone of a corrupted blob\n"); 3631 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 3632 return; 3633 } 3634 3635 ctx->blob->md_ro = false; 3636 blob_remove_xattr(ctx->blob, SNAPSHOT_PENDING_REMOVAL, true); 3637 blob_remove_xattr(ctx->blob, SNAPSHOT_IN_PROGRESS, true); 3638 spdk_blob_set_read_only(ctx->blob); 3639 3640 if (ctx->iter_cb_fn) { 3641 ctx->iter_cb_fn(ctx->iter_cb_arg, ctx->blob, 0); 3642 } 3643 bs_blob_list_add(ctx->blob); 3644 3645 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 3646 } 3647 3648 static void 3649 bs_examine_clone(void *cb_arg, struct spdk_blob *blob, int bserrno) 3650 { 3651 struct spdk_bs_load_ctx *ctx = cb_arg; 3652 3653 if (bserrno != 0) { 3654 SPDK_ERRLOG("Failed to open clone of a corrupted blob\n"); 3655 spdk_bs_iter_next(ctx->bs, ctx->blob, bs_load_iter, ctx); 3656 return; 3657 } 3658 3659 if (blob->parent_id == ctx->blob->id) { 3660 /* Power failure occurred before updating clone (snapshot delete case) 3661 * or after updating clone (creating snapshot case) - keep snapshot */ 3662 spdk_blob_close(blob, bs_update_corrupted_blob, ctx); 3663 } else { 3664 /* Power failure occurred after updating clone (snapshot delete case) 3665 * or before updating clone (creating snapshot case) - remove snapshot */ 3666 spdk_blob_close(blob, bs_delete_corrupted_blob, ctx); 3667 } 3668 } 3669 3670 static void 3671 bs_load_iter(void *arg, struct spdk_blob *blob, int bserrno) 3672 { 3673 struct spdk_bs_load_ctx *ctx = arg; 3674 const void *value; 3675 size_t len; 3676 int rc = 0; 3677 3678 if (bserrno == 0) { 3679 /* Examine blob if it is corrupted after power failure. Fix 3680 * the ones that can be fixed and remove any other corrupted 3681 * ones. If it is not corrupted just process it */ 3682 rc = blob_get_xattr_value(blob, SNAPSHOT_PENDING_REMOVAL, &value, &len, true); 3683 if (rc != 0) { 3684 rc = blob_get_xattr_value(blob, SNAPSHOT_IN_PROGRESS, &value, &len, true); 3685 if (rc != 0) { 3686 /* Not corrupted - process it and continue with iterating through blobs */ 3687 if (ctx->iter_cb_fn) { 3688 ctx->iter_cb_fn(ctx->iter_cb_arg, blob, 0); 3689 } 3690 bs_blob_list_add(blob); 3691 spdk_bs_iter_next(ctx->bs, blob, bs_load_iter, ctx); 3692 return; 3693 } 3694 3695 } 3696 3697 assert(len == sizeof(spdk_blob_id)); 3698 3699 ctx->blob = blob; 3700 3701 /* Open clone to check if we are able to fix this blob or should we remove it */ 3702 spdk_bs_open_blob(ctx->bs, *(spdk_blob_id *)value, bs_examine_clone, ctx); 3703 return; 3704 } else if (bserrno == -ENOENT) { 3705 bserrno = 0; 3706 } else { 3707 /* 3708 * This case needs to be looked at further. Same problem 3709 * exists with applications that rely on explicit blob 3710 * iteration. We should just skip the blob that failed 3711 * to load and continue on to the next one. 3712 */ 3713 SPDK_ERRLOG("Error in iterating blobs\n"); 3714 } 3715 3716 ctx->iter_cb_fn = NULL; 3717 3718 spdk_free(ctx->super); 3719 spdk_free(ctx->mask); 3720 bs_sequence_finish(ctx->seq, bserrno); 3721 free(ctx); 3722 } 3723 3724 static void bs_dump_read_md_page(spdk_bs_sequence_t *seq, void *cb_arg); 3725 3726 static void 3727 bs_load_complete(struct spdk_bs_load_ctx *ctx) 3728 { 3729 ctx->bs->used_clusters = spdk_bit_pool_create_from_array(ctx->used_clusters); 3730 if (ctx->dumping) { 3731 bs_dump_read_md_page(ctx->seq, ctx); 3732 return; 3733 } 3734 spdk_bs_iter_first(ctx->bs, bs_load_iter, ctx); 3735 } 3736 3737 static void 3738 bs_load_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3739 { 3740 struct spdk_bs_load_ctx *ctx = cb_arg; 3741 int rc; 3742 3743 /* The type must be correct */ 3744 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_BLOBIDS); 3745 3746 /* The length of the mask (in bits) must not be greater than 3747 * the length of the buffer (converted to bits) */ 3748 assert(ctx->mask->length <= (ctx->super->used_blobid_mask_len * SPDK_BS_PAGE_SIZE * 8)); 3749 3750 /* The length of the mask must be exactly equal to the size 3751 * (in pages) of the metadata region */ 3752 assert(ctx->mask->length == ctx->super->md_len); 3753 3754 rc = spdk_bit_array_resize(&ctx->bs->used_blobids, ctx->mask->length); 3755 if (rc < 0) { 3756 spdk_free(ctx->mask); 3757 bs_load_ctx_fail(ctx, rc); 3758 return; 3759 } 3760 3761 spdk_bit_array_load_mask(ctx->bs->used_blobids, ctx->mask->mask); 3762 bs_load_complete(ctx); 3763 } 3764 3765 static void 3766 bs_load_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3767 { 3768 struct spdk_bs_load_ctx *ctx = cb_arg; 3769 uint64_t lba, lba_count, mask_size; 3770 int rc; 3771 3772 if (bserrno != 0) { 3773 bs_load_ctx_fail(ctx, bserrno); 3774 return; 3775 } 3776 3777 /* The type must be correct */ 3778 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_CLUSTERS); 3779 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 3780 assert(ctx->mask->length <= (ctx->super->used_cluster_mask_len * sizeof( 3781 struct spdk_blob_md_page) * 8)); 3782 /* The length of the mask must be exactly equal to the total number of clusters */ 3783 assert(ctx->mask->length == ctx->bs->total_clusters); 3784 3785 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->mask->length); 3786 if (rc < 0) { 3787 spdk_free(ctx->mask); 3788 bs_load_ctx_fail(ctx, rc); 3789 return; 3790 } 3791 3792 spdk_bit_array_load_mask(ctx->used_clusters, ctx->mask->mask); 3793 ctx->bs->num_free_clusters = spdk_bit_array_count_clear(ctx->used_clusters); 3794 assert(ctx->bs->num_free_clusters <= ctx->bs->total_clusters); 3795 3796 spdk_free(ctx->mask); 3797 3798 /* Read the used blobids mask */ 3799 mask_size = ctx->super->used_blobid_mask_len * SPDK_BS_PAGE_SIZE; 3800 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_SOCKET_ID_ANY, 3801 SPDK_MALLOC_DMA); 3802 if (!ctx->mask) { 3803 bs_load_ctx_fail(ctx, -ENOMEM); 3804 return; 3805 } 3806 lba = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_start); 3807 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_len); 3808 bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 3809 bs_load_used_blobids_cpl, ctx); 3810 } 3811 3812 static void 3813 bs_load_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3814 { 3815 struct spdk_bs_load_ctx *ctx = cb_arg; 3816 uint64_t lba, lba_count, mask_size; 3817 int rc; 3818 3819 if (bserrno != 0) { 3820 bs_load_ctx_fail(ctx, bserrno); 3821 return; 3822 } 3823 3824 /* The type must be correct */ 3825 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_PAGES); 3826 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 3827 assert(ctx->mask->length <= (ctx->super->used_page_mask_len * SPDK_BS_PAGE_SIZE * 3828 8)); 3829 /* The length of the mask must be exactly equal to the size (in pages) of the metadata region */ 3830 if (ctx->mask->length != ctx->super->md_len) { 3831 SPDK_ERRLOG("mismatched md_len in used_pages mask: " 3832 "mask->length=%" PRIu32 " super->md_len=%" PRIu32 "\n", 3833 ctx->mask->length, ctx->super->md_len); 3834 assert(false); 3835 } 3836 3837 rc = spdk_bit_array_resize(&ctx->bs->used_md_pages, ctx->mask->length); 3838 if (rc < 0) { 3839 spdk_free(ctx->mask); 3840 bs_load_ctx_fail(ctx, rc); 3841 return; 3842 } 3843 3844 spdk_bit_array_load_mask(ctx->bs->used_md_pages, ctx->mask->mask); 3845 spdk_free(ctx->mask); 3846 3847 /* Read the used clusters mask */ 3848 mask_size = ctx->super->used_cluster_mask_len * SPDK_BS_PAGE_SIZE; 3849 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_SOCKET_ID_ANY, 3850 SPDK_MALLOC_DMA); 3851 if (!ctx->mask) { 3852 bs_load_ctx_fail(ctx, -ENOMEM); 3853 return; 3854 } 3855 lba = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 3856 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 3857 bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 3858 bs_load_used_clusters_cpl, ctx); 3859 } 3860 3861 static void 3862 bs_load_read_used_pages(struct spdk_bs_load_ctx *ctx) 3863 { 3864 uint64_t lba, lba_count, mask_size; 3865 3866 /* Read the used pages mask */ 3867 mask_size = ctx->super->used_page_mask_len * SPDK_BS_PAGE_SIZE; 3868 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 3869 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3870 if (!ctx->mask) { 3871 bs_load_ctx_fail(ctx, -ENOMEM); 3872 return; 3873 } 3874 3875 lba = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_start); 3876 lba_count = bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_len); 3877 bs_sequence_read_dev(ctx->seq, ctx->mask, lba, lba_count, 3878 bs_load_used_pages_cpl, ctx); 3879 } 3880 3881 static int 3882 bs_load_replay_md_parse_page(struct spdk_bs_load_ctx *ctx, struct spdk_blob_md_page *page) 3883 { 3884 struct spdk_blob_store *bs = ctx->bs; 3885 struct spdk_blob_md_descriptor *desc; 3886 size_t cur_desc = 0; 3887 3888 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 3889 while (cur_desc < sizeof(page->descriptors)) { 3890 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 3891 if (desc->length == 0) { 3892 /* If padding and length are 0, this terminates the page */ 3893 break; 3894 } 3895 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE) { 3896 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 3897 unsigned int i, j; 3898 unsigned int cluster_count = 0; 3899 uint32_t cluster_idx; 3900 3901 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)desc; 3902 3903 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 3904 for (j = 0; j < desc_extent_rle->extents[i].length; j++) { 3905 cluster_idx = desc_extent_rle->extents[i].cluster_idx; 3906 /* 3907 * cluster_idx = 0 means an unallocated cluster - don't mark that 3908 * in the used cluster map. 3909 */ 3910 if (cluster_idx != 0) { 3911 SPDK_NOTICELOG("Recover: cluster %" PRIu32 "\n", cluster_idx + j); 3912 spdk_bit_array_set(ctx->used_clusters, cluster_idx + j); 3913 if (bs->num_free_clusters == 0) { 3914 return -ENOSPC; 3915 } 3916 bs->num_free_clusters--; 3917 } 3918 cluster_count++; 3919 } 3920 } 3921 if (cluster_count == 0) { 3922 return -EINVAL; 3923 } 3924 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 3925 struct spdk_blob_md_descriptor_extent_page *desc_extent; 3926 uint32_t i; 3927 uint32_t cluster_count = 0; 3928 uint32_t cluster_idx; 3929 size_t cluster_idx_length; 3930 3931 desc_extent = (struct spdk_blob_md_descriptor_extent_page *)desc; 3932 cluster_idx_length = desc_extent->length - sizeof(desc_extent->start_cluster_idx); 3933 3934 if (desc_extent->length <= sizeof(desc_extent->start_cluster_idx) || 3935 (cluster_idx_length % sizeof(desc_extent->cluster_idx[0]) != 0)) { 3936 return -EINVAL; 3937 } 3938 3939 for (i = 0; i < cluster_idx_length / sizeof(desc_extent->cluster_idx[0]); i++) { 3940 cluster_idx = desc_extent->cluster_idx[i]; 3941 /* 3942 * cluster_idx = 0 means an unallocated cluster - don't mark that 3943 * in the used cluster map. 3944 */ 3945 if (cluster_idx != 0) { 3946 if (cluster_idx < desc_extent->start_cluster_idx && 3947 cluster_idx >= desc_extent->start_cluster_idx + cluster_count) { 3948 return -EINVAL; 3949 } 3950 spdk_bit_array_set(ctx->used_clusters, cluster_idx); 3951 if (bs->num_free_clusters == 0) { 3952 return -ENOSPC; 3953 } 3954 bs->num_free_clusters--; 3955 } 3956 cluster_count++; 3957 } 3958 3959 if (cluster_count == 0) { 3960 return -EINVAL; 3961 } 3962 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 3963 /* Skip this item */ 3964 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 3965 /* Skip this item */ 3966 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 3967 /* Skip this item */ 3968 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE) { 3969 struct spdk_blob_md_descriptor_extent_table *desc_extent_table; 3970 uint32_t num_extent_pages = ctx->num_extent_pages; 3971 uint32_t i; 3972 size_t extent_pages_length; 3973 void *tmp; 3974 3975 desc_extent_table = (struct spdk_blob_md_descriptor_extent_table *)desc; 3976 extent_pages_length = desc_extent_table->length - sizeof(desc_extent_table->num_clusters); 3977 3978 if (desc_extent_table->length == 0 || 3979 (extent_pages_length % sizeof(desc_extent_table->extent_page[0]) != 0)) { 3980 return -EINVAL; 3981 } 3982 3983 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 3984 if (desc_extent_table->extent_page[i].page_idx != 0) { 3985 if (desc_extent_table->extent_page[i].num_pages != 1) { 3986 return -EINVAL; 3987 } 3988 num_extent_pages += 1; 3989 } 3990 } 3991 3992 if (num_extent_pages > 0) { 3993 tmp = realloc(ctx->extent_page_num, num_extent_pages * sizeof(uint32_t)); 3994 if (tmp == NULL) { 3995 return -ENOMEM; 3996 } 3997 ctx->extent_page_num = tmp; 3998 3999 /* Extent table entries contain md page numbers for extent pages. 4000 * Zeroes represent unallocated extent pages, those are run-length-encoded. 4001 */ 4002 for (i = 0; i < extent_pages_length / sizeof(desc_extent_table->extent_page[0]); i++) { 4003 if (desc_extent_table->extent_page[i].page_idx != 0) { 4004 ctx->extent_page_num[ctx->num_extent_pages] = desc_extent_table->extent_page[i].page_idx; 4005 ctx->num_extent_pages += 1; 4006 } 4007 } 4008 } 4009 } else { 4010 /* Error */ 4011 return -EINVAL; 4012 } 4013 /* Advance to the next descriptor */ 4014 cur_desc += sizeof(*desc) + desc->length; 4015 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 4016 break; 4017 } 4018 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 4019 } 4020 return 0; 4021 } 4022 4023 static bool bs_load_cur_extent_page_valid(struct spdk_blob_md_page *page) 4024 { 4025 uint32_t crc; 4026 struct spdk_blob_md_descriptor *desc = (struct spdk_blob_md_descriptor *)page->descriptors; 4027 size_t desc_len; 4028 4029 crc = blob_md_page_calc_crc(page); 4030 if (crc != page->crc) { 4031 return false; 4032 } 4033 4034 /* Extent page should always be of sequence num 0. */ 4035 if (page->sequence_num != 0) { 4036 return false; 4037 } 4038 4039 /* Descriptor type must be EXTENT_PAGE. */ 4040 if (desc->type != SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 4041 return false; 4042 } 4043 4044 /* Descriptor length cannot exceed the page. */ 4045 desc_len = sizeof(*desc) + desc->length; 4046 if (desc_len > sizeof(page->descriptors)) { 4047 return false; 4048 } 4049 4050 /* It has to be the only descriptor in the page. */ 4051 if (desc_len + sizeof(*desc) <= sizeof(page->descriptors)) { 4052 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + desc_len); 4053 if (desc->length != 0) { 4054 return false; 4055 } 4056 } 4057 4058 return true; 4059 } 4060 4061 static bool bs_load_cur_md_page_valid(struct spdk_bs_load_ctx *ctx) 4062 { 4063 uint32_t crc; 4064 struct spdk_blob_md_page *page = ctx->page; 4065 4066 crc = blob_md_page_calc_crc(page); 4067 if (crc != page->crc) { 4068 return false; 4069 } 4070 4071 /* First page of a sequence should match the blobid. */ 4072 if (page->sequence_num == 0 && 4073 bs_page_to_blobid(ctx->cur_page) != page->id) { 4074 return false; 4075 } 4076 assert(bs_load_cur_extent_page_valid(page) == false); 4077 4078 return true; 4079 } 4080 4081 static void 4082 bs_load_replay_cur_md_page(struct spdk_bs_load_ctx *ctx); 4083 4084 static void 4085 bs_load_write_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4086 { 4087 struct spdk_bs_load_ctx *ctx = cb_arg; 4088 4089 if (bserrno != 0) { 4090 bs_load_ctx_fail(ctx, bserrno); 4091 return; 4092 } 4093 4094 bs_load_complete(ctx); 4095 } 4096 4097 static void 4098 bs_load_write_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4099 { 4100 struct spdk_bs_load_ctx *ctx = cb_arg; 4101 4102 spdk_free(ctx->mask); 4103 ctx->mask = NULL; 4104 4105 if (bserrno != 0) { 4106 bs_load_ctx_fail(ctx, bserrno); 4107 return; 4108 } 4109 4110 bs_write_used_clusters(seq, ctx, bs_load_write_used_clusters_cpl); 4111 } 4112 4113 static void 4114 bs_load_write_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4115 { 4116 struct spdk_bs_load_ctx *ctx = cb_arg; 4117 4118 spdk_free(ctx->mask); 4119 ctx->mask = NULL; 4120 4121 if (bserrno != 0) { 4122 bs_load_ctx_fail(ctx, bserrno); 4123 return; 4124 } 4125 4126 bs_write_used_blobids(seq, ctx, bs_load_write_used_blobids_cpl); 4127 } 4128 4129 static void 4130 bs_load_write_used_md(struct spdk_bs_load_ctx *ctx) 4131 { 4132 bs_write_used_md(ctx->seq, ctx, bs_load_write_used_pages_cpl); 4133 } 4134 4135 static void 4136 bs_load_replay_md_chain_cpl(struct spdk_bs_load_ctx *ctx) 4137 { 4138 uint64_t num_md_clusters; 4139 uint64_t i; 4140 4141 ctx->in_page_chain = false; 4142 4143 do { 4144 ctx->page_index++; 4145 } while (spdk_bit_array_get(ctx->bs->used_md_pages, ctx->page_index) == true); 4146 4147 if (ctx->page_index < ctx->super->md_len) { 4148 ctx->cur_page = ctx->page_index; 4149 bs_load_replay_cur_md_page(ctx); 4150 } else { 4151 /* Claim all of the clusters used by the metadata */ 4152 num_md_clusters = spdk_divide_round_up( 4153 ctx->super->md_start + ctx->super->md_len, ctx->bs->pages_per_cluster); 4154 for (i = 0; i < num_md_clusters; i++) { 4155 spdk_bit_array_set(ctx->used_clusters, i); 4156 } 4157 ctx->bs->num_free_clusters -= num_md_clusters; 4158 spdk_free(ctx->page); 4159 bs_load_write_used_md(ctx); 4160 } 4161 } 4162 4163 static void 4164 bs_load_replay_extent_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4165 { 4166 struct spdk_bs_load_ctx *ctx = cb_arg; 4167 uint32_t page_num; 4168 uint64_t i; 4169 4170 if (bserrno != 0) { 4171 spdk_free(ctx->extent_pages); 4172 bs_load_ctx_fail(ctx, bserrno); 4173 return; 4174 } 4175 4176 for (i = 0; i < ctx->num_extent_pages; i++) { 4177 /* Extent pages are only read when present within in chain md. 4178 * Integrity of md is not right if that page was not a valid extent page. */ 4179 if (bs_load_cur_extent_page_valid(&ctx->extent_pages[i]) != true) { 4180 spdk_free(ctx->extent_pages); 4181 bs_load_ctx_fail(ctx, -EILSEQ); 4182 return; 4183 } 4184 4185 page_num = ctx->extent_page_num[i]; 4186 spdk_bit_array_set(ctx->bs->used_md_pages, page_num); 4187 if (bs_load_replay_md_parse_page(ctx, &ctx->extent_pages[i])) { 4188 spdk_free(ctx->extent_pages); 4189 bs_load_ctx_fail(ctx, -EILSEQ); 4190 return; 4191 } 4192 } 4193 4194 spdk_free(ctx->extent_pages); 4195 free(ctx->extent_page_num); 4196 ctx->extent_page_num = NULL; 4197 ctx->num_extent_pages = 0; 4198 4199 bs_load_replay_md_chain_cpl(ctx); 4200 } 4201 4202 static void 4203 bs_load_replay_extent_pages(struct spdk_bs_load_ctx *ctx) 4204 { 4205 spdk_bs_batch_t *batch; 4206 uint32_t page; 4207 uint64_t lba; 4208 uint64_t i; 4209 4210 ctx->extent_pages = spdk_zmalloc(SPDK_BS_PAGE_SIZE * ctx->num_extent_pages, 0, 4211 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 4212 if (!ctx->extent_pages) { 4213 bs_load_ctx_fail(ctx, -ENOMEM); 4214 return; 4215 } 4216 4217 batch = bs_sequence_to_batch(ctx->seq, bs_load_replay_extent_page_cpl, ctx); 4218 4219 for (i = 0; i < ctx->num_extent_pages; i++) { 4220 page = ctx->extent_page_num[i]; 4221 assert(page < ctx->super->md_len); 4222 lba = bs_md_page_to_lba(ctx->bs, page); 4223 bs_batch_read_dev(batch, &ctx->extent_pages[i], lba, 4224 bs_byte_to_lba(ctx->bs, SPDK_BS_PAGE_SIZE)); 4225 } 4226 4227 bs_batch_close(batch); 4228 } 4229 4230 static void 4231 bs_load_replay_md_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4232 { 4233 struct spdk_bs_load_ctx *ctx = cb_arg; 4234 uint32_t page_num; 4235 struct spdk_blob_md_page *page; 4236 4237 if (bserrno != 0) { 4238 bs_load_ctx_fail(ctx, bserrno); 4239 return; 4240 } 4241 4242 page_num = ctx->cur_page; 4243 page = ctx->page; 4244 if (bs_load_cur_md_page_valid(ctx) == true) { 4245 if (page->sequence_num == 0 || ctx->in_page_chain == true) { 4246 bs_claim_md_page(ctx->bs, page_num); 4247 if (page->sequence_num == 0) { 4248 SPDK_NOTICELOG("Recover: blob %" PRIu32 "\n", page_num); 4249 spdk_bit_array_set(ctx->bs->used_blobids, page_num); 4250 } 4251 if (bs_load_replay_md_parse_page(ctx, page)) { 4252 bs_load_ctx_fail(ctx, -EILSEQ); 4253 return; 4254 } 4255 if (page->next != SPDK_INVALID_MD_PAGE) { 4256 ctx->in_page_chain = true; 4257 ctx->cur_page = page->next; 4258 bs_load_replay_cur_md_page(ctx); 4259 return; 4260 } 4261 if (ctx->num_extent_pages != 0) { 4262 bs_load_replay_extent_pages(ctx); 4263 return; 4264 } 4265 } 4266 } 4267 bs_load_replay_md_chain_cpl(ctx); 4268 } 4269 4270 static void 4271 bs_load_replay_cur_md_page(struct spdk_bs_load_ctx *ctx) 4272 { 4273 uint64_t lba; 4274 4275 assert(ctx->cur_page < ctx->super->md_len); 4276 lba = bs_md_page_to_lba(ctx->bs, ctx->cur_page); 4277 bs_sequence_read_dev(ctx->seq, ctx->page, lba, 4278 bs_byte_to_lba(ctx->bs, SPDK_BS_PAGE_SIZE), 4279 bs_load_replay_md_cpl, ctx); 4280 } 4281 4282 static void 4283 bs_load_replay_md(struct spdk_bs_load_ctx *ctx) 4284 { 4285 ctx->page_index = 0; 4286 ctx->cur_page = 0; 4287 ctx->page = spdk_zmalloc(SPDK_BS_PAGE_SIZE, 0, 4288 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 4289 if (!ctx->page) { 4290 bs_load_ctx_fail(ctx, -ENOMEM); 4291 return; 4292 } 4293 bs_load_replay_cur_md_page(ctx); 4294 } 4295 4296 static void 4297 bs_recover(struct spdk_bs_load_ctx *ctx) 4298 { 4299 int rc; 4300 4301 SPDK_NOTICELOG("Performing recovery on blobstore\n"); 4302 rc = spdk_bit_array_resize(&ctx->bs->used_md_pages, ctx->super->md_len); 4303 if (rc < 0) { 4304 bs_load_ctx_fail(ctx, -ENOMEM); 4305 return; 4306 } 4307 4308 rc = spdk_bit_array_resize(&ctx->bs->used_blobids, ctx->super->md_len); 4309 if (rc < 0) { 4310 bs_load_ctx_fail(ctx, -ENOMEM); 4311 return; 4312 } 4313 4314 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->bs->total_clusters); 4315 if (rc < 0) { 4316 bs_load_ctx_fail(ctx, -ENOMEM); 4317 return; 4318 } 4319 4320 rc = spdk_bit_array_resize(&ctx->bs->open_blobids, ctx->super->md_len); 4321 if (rc < 0) { 4322 bs_load_ctx_fail(ctx, -ENOMEM); 4323 return; 4324 } 4325 4326 ctx->bs->num_free_clusters = ctx->bs->total_clusters; 4327 bs_load_replay_md(ctx); 4328 } 4329 4330 static int 4331 bs_parse_super(struct spdk_bs_load_ctx *ctx) 4332 { 4333 int rc; 4334 4335 if (ctx->super->size == 0) { 4336 ctx->super->size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 4337 } 4338 4339 if (ctx->super->io_unit_size == 0) { 4340 ctx->super->io_unit_size = SPDK_BS_PAGE_SIZE; 4341 } 4342 4343 ctx->bs->clean = 1; 4344 ctx->bs->cluster_sz = ctx->super->cluster_size; 4345 ctx->bs->total_clusters = ctx->super->size / ctx->super->cluster_size; 4346 ctx->bs->pages_per_cluster = ctx->bs->cluster_sz / SPDK_BS_PAGE_SIZE; 4347 if (spdk_u32_is_pow2(ctx->bs->pages_per_cluster)) { 4348 ctx->bs->pages_per_cluster_shift = spdk_u32log2(ctx->bs->pages_per_cluster); 4349 } 4350 ctx->bs->io_unit_size = ctx->super->io_unit_size; 4351 rc = spdk_bit_array_resize(&ctx->used_clusters, ctx->bs->total_clusters); 4352 if (rc < 0) { 4353 return -ENOMEM; 4354 } 4355 ctx->bs->md_start = ctx->super->md_start; 4356 ctx->bs->md_len = ctx->super->md_len; 4357 rc = spdk_bit_array_resize(&ctx->bs->open_blobids, ctx->bs->md_len); 4358 if (rc < 0) { 4359 return -ENOMEM; 4360 } 4361 4362 ctx->bs->total_data_clusters = ctx->bs->total_clusters - spdk_divide_round_up( 4363 ctx->bs->md_start + ctx->bs->md_len, ctx->bs->pages_per_cluster); 4364 ctx->bs->super_blob = ctx->super->super_blob; 4365 memcpy(&ctx->bs->bstype, &ctx->super->bstype, sizeof(ctx->super->bstype)); 4366 4367 return 0; 4368 } 4369 4370 static void 4371 bs_load_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4372 { 4373 struct spdk_bs_load_ctx *ctx = cb_arg; 4374 uint32_t crc; 4375 int rc; 4376 static const char zeros[SPDK_BLOBSTORE_TYPE_LENGTH]; 4377 4378 if (ctx->super->version > SPDK_BS_VERSION || 4379 ctx->super->version < SPDK_BS_INITIAL_VERSION) { 4380 bs_load_ctx_fail(ctx, -EILSEQ); 4381 return; 4382 } 4383 4384 if (memcmp(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 4385 sizeof(ctx->super->signature)) != 0) { 4386 bs_load_ctx_fail(ctx, -EILSEQ); 4387 return; 4388 } 4389 4390 crc = blob_md_page_calc_crc(ctx->super); 4391 if (crc != ctx->super->crc) { 4392 bs_load_ctx_fail(ctx, -EILSEQ); 4393 return; 4394 } 4395 4396 if (memcmp(&ctx->bs->bstype, &ctx->super->bstype, SPDK_BLOBSTORE_TYPE_LENGTH) == 0) { 4397 SPDK_DEBUGLOG(blob, "Bstype matched - loading blobstore\n"); 4398 } else if (memcmp(&ctx->bs->bstype, zeros, SPDK_BLOBSTORE_TYPE_LENGTH) == 0) { 4399 SPDK_DEBUGLOG(blob, "Bstype wildcard used - loading blobstore regardless bstype\n"); 4400 } else { 4401 SPDK_DEBUGLOG(blob, "Unexpected bstype\n"); 4402 SPDK_LOGDUMP(blob, "Expected:", ctx->bs->bstype.bstype, SPDK_BLOBSTORE_TYPE_LENGTH); 4403 SPDK_LOGDUMP(blob, "Found:", ctx->super->bstype.bstype, SPDK_BLOBSTORE_TYPE_LENGTH); 4404 bs_load_ctx_fail(ctx, -ENXIO); 4405 return; 4406 } 4407 4408 if (ctx->super->size > ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen) { 4409 SPDK_NOTICELOG("Size mismatch, dev size: %" PRIu64 ", blobstore size: %" PRIu64 "\n", 4410 ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen, ctx->super->size); 4411 bs_load_ctx_fail(ctx, -EILSEQ); 4412 return; 4413 } 4414 4415 rc = bs_parse_super(ctx); 4416 if (rc < 0) { 4417 bs_load_ctx_fail(ctx, rc); 4418 return; 4419 } 4420 4421 if (ctx->super->used_blobid_mask_len == 0 || ctx->super->clean == 0 || ctx->force_recover) { 4422 bs_recover(ctx); 4423 } else { 4424 bs_load_read_used_pages(ctx); 4425 } 4426 } 4427 4428 static inline int 4429 bs_opts_copy(struct spdk_bs_opts *src, struct spdk_bs_opts *dst) 4430 { 4431 4432 if (!src->opts_size) { 4433 SPDK_ERRLOG("opts_size should not be zero value\n"); 4434 return -1; 4435 } 4436 4437 #define FIELD_OK(field) \ 4438 offsetof(struct spdk_bs_opts, field) + sizeof(src->field) <= src->opts_size 4439 4440 #define SET_FIELD(field) \ 4441 if (FIELD_OK(field)) { \ 4442 dst->field = src->field; \ 4443 } \ 4444 4445 SET_FIELD(cluster_sz); 4446 SET_FIELD(num_md_pages); 4447 SET_FIELD(max_md_ops); 4448 SET_FIELD(max_channel_ops); 4449 SET_FIELD(clear_method); 4450 4451 if (FIELD_OK(bstype)) { 4452 memcpy(&dst->bstype, &src->bstype, sizeof(dst->bstype)); 4453 } 4454 SET_FIELD(iter_cb_fn); 4455 SET_FIELD(iter_cb_arg); 4456 SET_FIELD(force_recover); 4457 4458 dst->opts_size = src->opts_size; 4459 4460 /* You should not remove this statement, but need to update the assert statement 4461 * if you add a new field, and also add a corresponding SET_FIELD statement */ 4462 SPDK_STATIC_ASSERT(sizeof(struct spdk_bs_opts) == 72, "Incorrect size"); 4463 4464 #undef FIELD_OK 4465 #undef SET_FIELD 4466 4467 return 0; 4468 } 4469 4470 void 4471 spdk_bs_load(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 4472 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 4473 { 4474 struct spdk_blob_store *bs; 4475 struct spdk_bs_cpl cpl; 4476 struct spdk_bs_load_ctx *ctx; 4477 struct spdk_bs_opts opts = {}; 4478 int err; 4479 4480 SPDK_DEBUGLOG(blob, "Loading blobstore from dev %p\n", dev); 4481 4482 if ((SPDK_BS_PAGE_SIZE % dev->blocklen) != 0) { 4483 SPDK_DEBUGLOG(blob, "unsupported dev block length of %d\n", dev->blocklen); 4484 dev->destroy(dev); 4485 cb_fn(cb_arg, NULL, -EINVAL); 4486 return; 4487 } 4488 4489 spdk_bs_opts_init(&opts, sizeof(opts)); 4490 if (o) { 4491 if (bs_opts_copy(o, &opts)) { 4492 return; 4493 } 4494 } 4495 4496 if (opts.max_md_ops == 0 || opts.max_channel_ops == 0) { 4497 dev->destroy(dev); 4498 cb_fn(cb_arg, NULL, -EINVAL); 4499 return; 4500 } 4501 4502 err = bs_alloc(dev, &opts, &bs, &ctx); 4503 if (err) { 4504 dev->destroy(dev); 4505 cb_fn(cb_arg, NULL, err); 4506 return; 4507 } 4508 4509 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 4510 cpl.u.bs_handle.cb_fn = cb_fn; 4511 cpl.u.bs_handle.cb_arg = cb_arg; 4512 cpl.u.bs_handle.bs = bs; 4513 4514 ctx->seq = bs_sequence_start(bs->md_channel, &cpl); 4515 if (!ctx->seq) { 4516 spdk_free(ctx->super); 4517 free(ctx); 4518 bs_free(bs); 4519 cb_fn(cb_arg, NULL, -ENOMEM); 4520 return; 4521 } 4522 4523 /* Read the super block */ 4524 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 4525 bs_byte_to_lba(bs, sizeof(*ctx->super)), 4526 bs_load_super_cpl, ctx); 4527 } 4528 4529 /* END spdk_bs_load */ 4530 4531 /* START spdk_bs_dump */ 4532 4533 static void 4534 bs_dump_finish(spdk_bs_sequence_t *seq, struct spdk_bs_load_ctx *ctx, int bserrno) 4535 { 4536 spdk_free(ctx->super); 4537 4538 /* 4539 * We need to defer calling bs_call_cpl() until after 4540 * dev destruction, so tuck these away for later use. 4541 */ 4542 ctx->bs->unload_err = bserrno; 4543 memcpy(&ctx->bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 4544 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 4545 4546 bs_sequence_finish(seq, 0); 4547 bs_free(ctx->bs); 4548 free(ctx); 4549 } 4550 4551 static void 4552 bs_dump_print_xattr(struct spdk_bs_load_ctx *ctx, struct spdk_blob_md_descriptor *desc) 4553 { 4554 struct spdk_blob_md_descriptor_xattr *desc_xattr; 4555 uint32_t i; 4556 const char *type; 4557 4558 desc_xattr = (struct spdk_blob_md_descriptor_xattr *)desc; 4559 4560 if (desc_xattr->length != 4561 sizeof(desc_xattr->name_length) + sizeof(desc_xattr->value_length) + 4562 desc_xattr->name_length + desc_xattr->value_length) { 4563 } 4564 4565 memcpy(ctx->xattr_name, desc_xattr->name, desc_xattr->name_length); 4566 ctx->xattr_name[desc_xattr->name_length] = '\0'; 4567 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 4568 type = "XATTR"; 4569 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 4570 type = "XATTR_INTERNAL"; 4571 } else { 4572 assert(false); 4573 type = "XATTR_?"; 4574 } 4575 fprintf(ctx->fp, "%s: name = \"%s\"\n", type, ctx->xattr_name); 4576 fprintf(ctx->fp, " value = \""); 4577 ctx->print_xattr_fn(ctx->fp, ctx->super->bstype.bstype, ctx->xattr_name, 4578 (void *)((uintptr_t)desc_xattr->name + desc_xattr->name_length), 4579 desc_xattr->value_length); 4580 fprintf(ctx->fp, "\"\n"); 4581 for (i = 0; i < desc_xattr->value_length; i++) { 4582 if (i % 16 == 0) { 4583 fprintf(ctx->fp, " "); 4584 } 4585 fprintf(ctx->fp, "%02" PRIx8 " ", *((uint8_t *)desc_xattr->name + desc_xattr->name_length + i)); 4586 if ((i + 1) % 16 == 0) { 4587 fprintf(ctx->fp, "\n"); 4588 } 4589 } 4590 if (i % 16 != 0) { 4591 fprintf(ctx->fp, "\n"); 4592 } 4593 } 4594 4595 static void 4596 bs_dump_print_md_page(struct spdk_bs_load_ctx *ctx) 4597 { 4598 uint32_t page_idx = ctx->cur_page; 4599 struct spdk_blob_md_page *page = ctx->page; 4600 struct spdk_blob_md_descriptor *desc; 4601 size_t cur_desc = 0; 4602 uint32_t crc; 4603 4604 fprintf(ctx->fp, "=========\n"); 4605 fprintf(ctx->fp, "Metadata Page Index: %" PRIu32 " (0x%" PRIx32 ")\n", page_idx, page_idx); 4606 fprintf(ctx->fp, "Blob ID: 0x%" PRIx64 "\n", page->id); 4607 fprintf(ctx->fp, "Sequence: %" PRIu32 "\n", page->sequence_num); 4608 if (page->next == SPDK_INVALID_MD_PAGE) { 4609 fprintf(ctx->fp, "Next: None\n"); 4610 } else { 4611 fprintf(ctx->fp, "Next: %" PRIu32 "\n", page->next); 4612 } 4613 fprintf(ctx->fp, "In used bit array%s:", ctx->super->clean ? "" : " (not clean: dubious)"); 4614 if (spdk_bit_array_get(ctx->bs->used_md_pages, page_idx)) { 4615 fprintf(ctx->fp, " md"); 4616 } 4617 if (spdk_bit_array_get(ctx->bs->used_blobids, page_idx)) { 4618 fprintf(ctx->fp, " blob"); 4619 } 4620 fprintf(ctx->fp, "\n"); 4621 4622 crc = blob_md_page_calc_crc(page); 4623 fprintf(ctx->fp, "CRC: 0x%" PRIx32 " (%s)\n", page->crc, crc == page->crc ? "OK" : "Mismatch"); 4624 4625 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 4626 while (cur_desc < sizeof(page->descriptors)) { 4627 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 4628 if (desc->length == 0) { 4629 /* If padding and length are 0, this terminates the page */ 4630 break; 4631 } 4632 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE) { 4633 struct spdk_blob_md_descriptor_extent_rle *desc_extent_rle; 4634 unsigned int i; 4635 4636 desc_extent_rle = (struct spdk_blob_md_descriptor_extent_rle *)desc; 4637 4638 for (i = 0; i < desc_extent_rle->length / sizeof(desc_extent_rle->extents[0]); i++) { 4639 if (desc_extent_rle->extents[i].cluster_idx != 0) { 4640 fprintf(ctx->fp, "Allocated Extent - Start: %" PRIu32, 4641 desc_extent_rle->extents[i].cluster_idx); 4642 } else { 4643 fprintf(ctx->fp, "Unallocated Extent - "); 4644 } 4645 fprintf(ctx->fp, " Length: %" PRIu32, desc_extent_rle->extents[i].length); 4646 fprintf(ctx->fp, "\n"); 4647 } 4648 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE) { 4649 struct spdk_blob_md_descriptor_extent_page *desc_extent; 4650 unsigned int i; 4651 4652 desc_extent = (struct spdk_blob_md_descriptor_extent_page *)desc; 4653 4654 for (i = 0; i < desc_extent->length / sizeof(desc_extent->cluster_idx[0]); i++) { 4655 if (desc_extent->cluster_idx[i] != 0) { 4656 fprintf(ctx->fp, "Allocated Extent - Start: %" PRIu32, 4657 desc_extent->cluster_idx[i]); 4658 } else { 4659 fprintf(ctx->fp, "Unallocated Extent"); 4660 } 4661 fprintf(ctx->fp, "\n"); 4662 } 4663 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 4664 bs_dump_print_xattr(ctx, desc); 4665 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 4666 bs_dump_print_xattr(ctx, desc); 4667 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 4668 /* TODO */ 4669 } else { 4670 /* Error */ 4671 } 4672 /* Advance to the next descriptor */ 4673 cur_desc += sizeof(*desc) + desc->length; 4674 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 4675 break; 4676 } 4677 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 4678 } 4679 } 4680 4681 static void 4682 bs_dump_read_md_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4683 { 4684 struct spdk_bs_load_ctx *ctx = cb_arg; 4685 4686 if (bserrno != 0) { 4687 bs_dump_finish(seq, ctx, bserrno); 4688 return; 4689 } 4690 4691 if (ctx->page->id != 0) { 4692 bs_dump_print_md_page(ctx); 4693 } 4694 4695 ctx->cur_page++; 4696 4697 if (ctx->cur_page < ctx->super->md_len) { 4698 bs_dump_read_md_page(seq, ctx); 4699 } else { 4700 spdk_free(ctx->page); 4701 bs_dump_finish(seq, ctx, 0); 4702 } 4703 } 4704 4705 static void 4706 bs_dump_read_md_page(spdk_bs_sequence_t *seq, void *cb_arg) 4707 { 4708 struct spdk_bs_load_ctx *ctx = cb_arg; 4709 uint64_t lba; 4710 4711 assert(ctx->cur_page < ctx->super->md_len); 4712 lba = bs_page_to_lba(ctx->bs, ctx->super->md_start + ctx->cur_page); 4713 bs_sequence_read_dev(seq, ctx->page, lba, 4714 bs_byte_to_lba(ctx->bs, SPDK_BS_PAGE_SIZE), 4715 bs_dump_read_md_page_cpl, ctx); 4716 } 4717 4718 static void 4719 bs_dump_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4720 { 4721 struct spdk_bs_load_ctx *ctx = cb_arg; 4722 int rc; 4723 4724 fprintf(ctx->fp, "Signature: \"%.8s\" ", ctx->super->signature); 4725 if (memcmp(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 4726 sizeof(ctx->super->signature)) != 0) { 4727 fprintf(ctx->fp, "(Mismatch)\n"); 4728 bs_dump_finish(seq, ctx, bserrno); 4729 return; 4730 } else { 4731 fprintf(ctx->fp, "(OK)\n"); 4732 } 4733 fprintf(ctx->fp, "Version: %" PRIu32 "\n", ctx->super->version); 4734 fprintf(ctx->fp, "CRC: 0x%x (%s)\n", ctx->super->crc, 4735 (ctx->super->crc == blob_md_page_calc_crc(ctx->super)) ? "OK" : "Mismatch"); 4736 fprintf(ctx->fp, "Blobstore Type: %.*s\n", SPDK_BLOBSTORE_TYPE_LENGTH, ctx->super->bstype.bstype); 4737 fprintf(ctx->fp, "Cluster Size: %" PRIu32 "\n", ctx->super->cluster_size); 4738 fprintf(ctx->fp, "Super Blob ID: "); 4739 if (ctx->super->super_blob == SPDK_BLOBID_INVALID) { 4740 fprintf(ctx->fp, "(None)\n"); 4741 } else { 4742 fprintf(ctx->fp, "0x%" PRIx64 "\n", ctx->super->super_blob); 4743 } 4744 fprintf(ctx->fp, "Clean: %" PRIu32 "\n", ctx->super->clean); 4745 fprintf(ctx->fp, "Used Metadata Page Mask Start: %" PRIu32 "\n", ctx->super->used_page_mask_start); 4746 fprintf(ctx->fp, "Used Metadata Page Mask Length: %" PRIu32 "\n", ctx->super->used_page_mask_len); 4747 fprintf(ctx->fp, "Used Cluster Mask Start: %" PRIu32 "\n", ctx->super->used_cluster_mask_start); 4748 fprintf(ctx->fp, "Used Cluster Mask Length: %" PRIu32 "\n", ctx->super->used_cluster_mask_len); 4749 fprintf(ctx->fp, "Used Blob ID Mask Start: %" PRIu32 "\n", ctx->super->used_blobid_mask_start); 4750 fprintf(ctx->fp, "Used Blob ID Mask Length: %" PRIu32 "\n", ctx->super->used_blobid_mask_len); 4751 fprintf(ctx->fp, "Metadata Start: %" PRIu32 "\n", ctx->super->md_start); 4752 fprintf(ctx->fp, "Metadata Length: %" PRIu32 "\n", ctx->super->md_len); 4753 4754 ctx->cur_page = 0; 4755 ctx->page = spdk_zmalloc(SPDK_BS_PAGE_SIZE, 0, 4756 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 4757 if (!ctx->page) { 4758 bs_dump_finish(seq, ctx, -ENOMEM); 4759 return; 4760 } 4761 4762 rc = bs_parse_super(ctx); 4763 if (rc < 0) { 4764 bs_load_ctx_fail(ctx, rc); 4765 return; 4766 } 4767 4768 bs_load_read_used_pages(ctx); 4769 } 4770 4771 void 4772 spdk_bs_dump(struct spdk_bs_dev *dev, FILE *fp, spdk_bs_dump_print_xattr print_xattr_fn, 4773 spdk_bs_op_complete cb_fn, void *cb_arg) 4774 { 4775 struct spdk_blob_store *bs; 4776 struct spdk_bs_cpl cpl; 4777 struct spdk_bs_load_ctx *ctx; 4778 struct spdk_bs_opts opts = {}; 4779 int err; 4780 4781 SPDK_DEBUGLOG(blob, "Dumping blobstore from dev %p\n", dev); 4782 4783 spdk_bs_opts_init(&opts, sizeof(opts)); 4784 4785 err = bs_alloc(dev, &opts, &bs, &ctx); 4786 if (err) { 4787 dev->destroy(dev); 4788 cb_fn(cb_arg, err); 4789 return; 4790 } 4791 4792 ctx->dumping = true; 4793 ctx->fp = fp; 4794 ctx->print_xattr_fn = print_xattr_fn; 4795 4796 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 4797 cpl.u.bs_basic.cb_fn = cb_fn; 4798 cpl.u.bs_basic.cb_arg = cb_arg; 4799 4800 ctx->seq = bs_sequence_start(bs->md_channel, &cpl); 4801 if (!ctx->seq) { 4802 spdk_free(ctx->super); 4803 free(ctx); 4804 bs_free(bs); 4805 cb_fn(cb_arg, -ENOMEM); 4806 return; 4807 } 4808 4809 /* Read the super block */ 4810 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 4811 bs_byte_to_lba(bs, sizeof(*ctx->super)), 4812 bs_dump_super_cpl, ctx); 4813 } 4814 4815 /* END spdk_bs_dump */ 4816 4817 /* START spdk_bs_init */ 4818 4819 static void 4820 bs_init_persist_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4821 { 4822 struct spdk_bs_load_ctx *ctx = cb_arg; 4823 4824 ctx->bs->used_clusters = spdk_bit_pool_create_from_array(ctx->used_clusters); 4825 spdk_free(ctx->super); 4826 free(ctx); 4827 4828 bs_sequence_finish(seq, bserrno); 4829 } 4830 4831 static void 4832 bs_init_trim_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4833 { 4834 struct spdk_bs_load_ctx *ctx = cb_arg; 4835 4836 /* Write super block */ 4837 bs_sequence_write_dev(seq, ctx->super, bs_page_to_lba(ctx->bs, 0), 4838 bs_byte_to_lba(ctx->bs, sizeof(*ctx->super)), 4839 bs_init_persist_super_cpl, ctx); 4840 } 4841 4842 void 4843 spdk_bs_init(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 4844 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 4845 { 4846 struct spdk_bs_load_ctx *ctx; 4847 struct spdk_blob_store *bs; 4848 struct spdk_bs_cpl cpl; 4849 spdk_bs_sequence_t *seq; 4850 spdk_bs_batch_t *batch; 4851 uint64_t num_md_lba; 4852 uint64_t num_md_pages; 4853 uint64_t num_md_clusters; 4854 uint32_t i; 4855 struct spdk_bs_opts opts = {}; 4856 int rc; 4857 uint64_t lba, lba_count; 4858 4859 SPDK_DEBUGLOG(blob, "Initializing blobstore on dev %p\n", dev); 4860 4861 if ((SPDK_BS_PAGE_SIZE % dev->blocklen) != 0) { 4862 SPDK_ERRLOG("unsupported dev block length of %d\n", 4863 dev->blocklen); 4864 dev->destroy(dev); 4865 cb_fn(cb_arg, NULL, -EINVAL); 4866 return; 4867 } 4868 4869 spdk_bs_opts_init(&opts, sizeof(opts)); 4870 if (o) { 4871 if (bs_opts_copy(o, &opts)) { 4872 return; 4873 } 4874 } 4875 4876 if (bs_opts_verify(&opts) != 0) { 4877 dev->destroy(dev); 4878 cb_fn(cb_arg, NULL, -EINVAL); 4879 return; 4880 } 4881 4882 rc = bs_alloc(dev, &opts, &bs, &ctx); 4883 if (rc) { 4884 dev->destroy(dev); 4885 cb_fn(cb_arg, NULL, rc); 4886 return; 4887 } 4888 4889 if (opts.num_md_pages == SPDK_BLOB_OPTS_NUM_MD_PAGES) { 4890 /* By default, allocate 1 page per cluster. 4891 * Technically, this over-allocates metadata 4892 * because more metadata will reduce the number 4893 * of usable clusters. This can be addressed with 4894 * more complex math in the future. 4895 */ 4896 bs->md_len = bs->total_clusters; 4897 } else { 4898 bs->md_len = opts.num_md_pages; 4899 } 4900 rc = spdk_bit_array_resize(&bs->used_md_pages, bs->md_len); 4901 if (rc < 0) { 4902 spdk_free(ctx->super); 4903 free(ctx); 4904 bs_free(bs); 4905 cb_fn(cb_arg, NULL, -ENOMEM); 4906 return; 4907 } 4908 4909 rc = spdk_bit_array_resize(&bs->used_blobids, bs->md_len); 4910 if (rc < 0) { 4911 spdk_free(ctx->super); 4912 free(ctx); 4913 bs_free(bs); 4914 cb_fn(cb_arg, NULL, -ENOMEM); 4915 return; 4916 } 4917 4918 rc = spdk_bit_array_resize(&bs->open_blobids, bs->md_len); 4919 if (rc < 0) { 4920 spdk_free(ctx->super); 4921 free(ctx); 4922 bs_free(bs); 4923 cb_fn(cb_arg, NULL, -ENOMEM); 4924 return; 4925 } 4926 4927 memcpy(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 4928 sizeof(ctx->super->signature)); 4929 ctx->super->version = SPDK_BS_VERSION; 4930 ctx->super->length = sizeof(*ctx->super); 4931 ctx->super->super_blob = bs->super_blob; 4932 ctx->super->clean = 0; 4933 ctx->super->cluster_size = bs->cluster_sz; 4934 ctx->super->io_unit_size = bs->io_unit_size; 4935 memcpy(&ctx->super->bstype, &bs->bstype, sizeof(bs->bstype)); 4936 4937 /* Calculate how many pages the metadata consumes at the front 4938 * of the disk. 4939 */ 4940 4941 /* The super block uses 1 page */ 4942 num_md_pages = 1; 4943 4944 /* The used_md_pages mask requires 1 bit per metadata page, rounded 4945 * up to the nearest page, plus a header. 4946 */ 4947 ctx->super->used_page_mask_start = num_md_pages; 4948 ctx->super->used_page_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 4949 spdk_divide_round_up(bs->md_len, 8), 4950 SPDK_BS_PAGE_SIZE); 4951 num_md_pages += ctx->super->used_page_mask_len; 4952 4953 /* The used_clusters mask requires 1 bit per cluster, rounded 4954 * up to the nearest page, plus a header. 4955 */ 4956 ctx->super->used_cluster_mask_start = num_md_pages; 4957 ctx->super->used_cluster_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 4958 spdk_divide_round_up(bs->total_clusters, 8), 4959 SPDK_BS_PAGE_SIZE); 4960 num_md_pages += ctx->super->used_cluster_mask_len; 4961 4962 /* The used_blobids mask requires 1 bit per metadata page, rounded 4963 * up to the nearest page, plus a header. 4964 */ 4965 ctx->super->used_blobid_mask_start = num_md_pages; 4966 ctx->super->used_blobid_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 4967 spdk_divide_round_up(bs->md_len, 8), 4968 SPDK_BS_PAGE_SIZE); 4969 num_md_pages += ctx->super->used_blobid_mask_len; 4970 4971 /* The metadata region size was chosen above */ 4972 ctx->super->md_start = bs->md_start = num_md_pages; 4973 ctx->super->md_len = bs->md_len; 4974 num_md_pages += bs->md_len; 4975 4976 num_md_lba = bs_page_to_lba(bs, num_md_pages); 4977 4978 ctx->super->size = dev->blockcnt * dev->blocklen; 4979 4980 ctx->super->crc = blob_md_page_calc_crc(ctx->super); 4981 4982 num_md_clusters = spdk_divide_round_up(num_md_pages, bs->pages_per_cluster); 4983 if (num_md_clusters > bs->total_clusters) { 4984 SPDK_ERRLOG("Blobstore metadata cannot use more clusters than is available, " 4985 "please decrease number of pages reserved for metadata " 4986 "or increase cluster size.\n"); 4987 spdk_free(ctx->super); 4988 spdk_bit_array_free(&ctx->used_clusters); 4989 free(ctx); 4990 bs_free(bs); 4991 cb_fn(cb_arg, NULL, -ENOMEM); 4992 return; 4993 } 4994 /* Claim all of the clusters used by the metadata */ 4995 for (i = 0; i < num_md_clusters; i++) { 4996 spdk_bit_array_set(ctx->used_clusters, i); 4997 } 4998 4999 bs->num_free_clusters -= num_md_clusters; 5000 bs->total_data_clusters = bs->num_free_clusters; 5001 5002 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 5003 cpl.u.bs_handle.cb_fn = cb_fn; 5004 cpl.u.bs_handle.cb_arg = cb_arg; 5005 cpl.u.bs_handle.bs = bs; 5006 5007 seq = bs_sequence_start(bs->md_channel, &cpl); 5008 if (!seq) { 5009 spdk_free(ctx->super); 5010 free(ctx); 5011 bs_free(bs); 5012 cb_fn(cb_arg, NULL, -ENOMEM); 5013 return; 5014 } 5015 5016 batch = bs_sequence_to_batch(seq, bs_init_trim_cpl, ctx); 5017 5018 /* Clear metadata space */ 5019 bs_batch_write_zeroes_dev(batch, 0, num_md_lba); 5020 5021 lba = num_md_lba; 5022 lba_count = ctx->bs->dev->blockcnt - lba; 5023 switch (opts.clear_method) { 5024 case BS_CLEAR_WITH_UNMAP: 5025 /* Trim data clusters */ 5026 bs_batch_unmap_dev(batch, lba, lba_count); 5027 break; 5028 case BS_CLEAR_WITH_WRITE_ZEROES: 5029 /* Write_zeroes to data clusters */ 5030 bs_batch_write_zeroes_dev(batch, lba, lba_count); 5031 break; 5032 case BS_CLEAR_WITH_NONE: 5033 default: 5034 break; 5035 } 5036 5037 bs_batch_close(batch); 5038 } 5039 5040 /* END spdk_bs_init */ 5041 5042 /* START spdk_bs_destroy */ 5043 5044 static void 5045 bs_destroy_trim_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5046 { 5047 struct spdk_bs_load_ctx *ctx = cb_arg; 5048 struct spdk_blob_store *bs = ctx->bs; 5049 5050 /* 5051 * We need to defer calling bs_call_cpl() until after 5052 * dev destruction, so tuck these away for later use. 5053 */ 5054 bs->unload_err = bserrno; 5055 memcpy(&bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 5056 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 5057 5058 bs_sequence_finish(seq, bserrno); 5059 5060 bs_free(bs); 5061 free(ctx); 5062 } 5063 5064 void 5065 spdk_bs_destroy(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, 5066 void *cb_arg) 5067 { 5068 struct spdk_bs_cpl cpl; 5069 spdk_bs_sequence_t *seq; 5070 struct spdk_bs_load_ctx *ctx; 5071 5072 SPDK_DEBUGLOG(blob, "Destroying blobstore\n"); 5073 5074 if (!RB_EMPTY(&bs->open_blobs)) { 5075 SPDK_ERRLOG("Blobstore still has open blobs\n"); 5076 cb_fn(cb_arg, -EBUSY); 5077 return; 5078 } 5079 5080 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 5081 cpl.u.bs_basic.cb_fn = cb_fn; 5082 cpl.u.bs_basic.cb_arg = cb_arg; 5083 5084 ctx = calloc(1, sizeof(*ctx)); 5085 if (!ctx) { 5086 cb_fn(cb_arg, -ENOMEM); 5087 return; 5088 } 5089 5090 ctx->bs = bs; 5091 5092 seq = bs_sequence_start(bs->md_channel, &cpl); 5093 if (!seq) { 5094 free(ctx); 5095 cb_fn(cb_arg, -ENOMEM); 5096 return; 5097 } 5098 5099 /* Write zeroes to the super block */ 5100 bs_sequence_write_zeroes_dev(seq, 5101 bs_page_to_lba(bs, 0), 5102 bs_byte_to_lba(bs, sizeof(struct spdk_bs_super_block)), 5103 bs_destroy_trim_cpl, ctx); 5104 } 5105 5106 /* END spdk_bs_destroy */ 5107 5108 /* START spdk_bs_unload */ 5109 5110 static void 5111 bs_unload_finish(struct spdk_bs_load_ctx *ctx, int bserrno) 5112 { 5113 spdk_bs_sequence_t *seq = ctx->seq; 5114 5115 spdk_free(ctx->super); 5116 5117 /* 5118 * We need to defer calling bs_call_cpl() until after 5119 * dev destruction, so tuck these away for later use. 5120 */ 5121 ctx->bs->unload_err = bserrno; 5122 memcpy(&ctx->bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 5123 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 5124 5125 bs_sequence_finish(seq, bserrno); 5126 5127 bs_free(ctx->bs); 5128 free(ctx); 5129 } 5130 5131 static void 5132 bs_unload_write_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5133 { 5134 struct spdk_bs_load_ctx *ctx = cb_arg; 5135 5136 bs_unload_finish(ctx, bserrno); 5137 } 5138 5139 static void 5140 bs_unload_write_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5141 { 5142 struct spdk_bs_load_ctx *ctx = cb_arg; 5143 5144 spdk_free(ctx->mask); 5145 5146 if (bserrno != 0) { 5147 bs_unload_finish(ctx, bserrno); 5148 return; 5149 } 5150 5151 ctx->super->clean = 1; 5152 5153 bs_write_super(seq, ctx->bs, ctx->super, bs_unload_write_super_cpl, ctx); 5154 } 5155 5156 static void 5157 bs_unload_write_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5158 { 5159 struct spdk_bs_load_ctx *ctx = cb_arg; 5160 5161 spdk_free(ctx->mask); 5162 ctx->mask = NULL; 5163 5164 if (bserrno != 0) { 5165 bs_unload_finish(ctx, bserrno); 5166 return; 5167 } 5168 5169 bs_write_used_clusters(seq, ctx, bs_unload_write_used_clusters_cpl); 5170 } 5171 5172 static void 5173 bs_unload_write_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5174 { 5175 struct spdk_bs_load_ctx *ctx = cb_arg; 5176 5177 spdk_free(ctx->mask); 5178 ctx->mask = NULL; 5179 5180 if (bserrno != 0) { 5181 bs_unload_finish(ctx, bserrno); 5182 return; 5183 } 5184 5185 bs_write_used_blobids(seq, ctx, bs_unload_write_used_blobids_cpl); 5186 } 5187 5188 static void 5189 bs_unload_read_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5190 { 5191 struct spdk_bs_load_ctx *ctx = cb_arg; 5192 5193 if (bserrno != 0) { 5194 bs_unload_finish(ctx, bserrno); 5195 return; 5196 } 5197 5198 bs_write_used_md(seq, cb_arg, bs_unload_write_used_pages_cpl); 5199 } 5200 5201 void 5202 spdk_bs_unload(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, void *cb_arg) 5203 { 5204 struct spdk_bs_cpl cpl; 5205 struct spdk_bs_load_ctx *ctx; 5206 5207 SPDK_DEBUGLOG(blob, "Syncing blobstore\n"); 5208 5209 if (!RB_EMPTY(&bs->open_blobs)) { 5210 SPDK_ERRLOG("Blobstore still has open blobs\n"); 5211 cb_fn(cb_arg, -EBUSY); 5212 return; 5213 } 5214 5215 ctx = calloc(1, sizeof(*ctx)); 5216 if (!ctx) { 5217 cb_fn(cb_arg, -ENOMEM); 5218 return; 5219 } 5220 5221 ctx->bs = bs; 5222 5223 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 5224 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 5225 if (!ctx->super) { 5226 free(ctx); 5227 cb_fn(cb_arg, -ENOMEM); 5228 return; 5229 } 5230 5231 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 5232 cpl.u.bs_basic.cb_fn = cb_fn; 5233 cpl.u.bs_basic.cb_arg = cb_arg; 5234 5235 ctx->seq = bs_sequence_start(bs->md_channel, &cpl); 5236 if (!ctx->seq) { 5237 spdk_free(ctx->super); 5238 free(ctx); 5239 cb_fn(cb_arg, -ENOMEM); 5240 return; 5241 } 5242 5243 /* Read super block */ 5244 bs_sequence_read_dev(ctx->seq, ctx->super, bs_page_to_lba(bs, 0), 5245 bs_byte_to_lba(bs, sizeof(*ctx->super)), 5246 bs_unload_read_super_cpl, ctx); 5247 } 5248 5249 /* END spdk_bs_unload */ 5250 5251 /* START spdk_bs_set_super */ 5252 5253 struct spdk_bs_set_super_ctx { 5254 struct spdk_blob_store *bs; 5255 struct spdk_bs_super_block *super; 5256 }; 5257 5258 static void 5259 bs_set_super_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5260 { 5261 struct spdk_bs_set_super_ctx *ctx = cb_arg; 5262 5263 if (bserrno != 0) { 5264 SPDK_ERRLOG("Unable to write to super block of blobstore\n"); 5265 } 5266 5267 spdk_free(ctx->super); 5268 5269 bs_sequence_finish(seq, bserrno); 5270 5271 free(ctx); 5272 } 5273 5274 static void 5275 bs_set_super_read_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5276 { 5277 struct spdk_bs_set_super_ctx *ctx = cb_arg; 5278 5279 if (bserrno != 0) { 5280 SPDK_ERRLOG("Unable to read super block of blobstore\n"); 5281 spdk_free(ctx->super); 5282 bs_sequence_finish(seq, bserrno); 5283 free(ctx); 5284 return; 5285 } 5286 5287 bs_write_super(seq, ctx->bs, ctx->super, bs_set_super_write_cpl, ctx); 5288 } 5289 5290 void 5291 spdk_bs_set_super(struct spdk_blob_store *bs, spdk_blob_id blobid, 5292 spdk_bs_op_complete cb_fn, void *cb_arg) 5293 { 5294 struct spdk_bs_cpl cpl; 5295 spdk_bs_sequence_t *seq; 5296 struct spdk_bs_set_super_ctx *ctx; 5297 5298 SPDK_DEBUGLOG(blob, "Setting super blob id on blobstore\n"); 5299 5300 ctx = calloc(1, sizeof(*ctx)); 5301 if (!ctx) { 5302 cb_fn(cb_arg, -ENOMEM); 5303 return; 5304 } 5305 5306 ctx->bs = bs; 5307 5308 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 5309 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 5310 if (!ctx->super) { 5311 free(ctx); 5312 cb_fn(cb_arg, -ENOMEM); 5313 return; 5314 } 5315 5316 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 5317 cpl.u.bs_basic.cb_fn = cb_fn; 5318 cpl.u.bs_basic.cb_arg = cb_arg; 5319 5320 seq = bs_sequence_start(bs->md_channel, &cpl); 5321 if (!seq) { 5322 spdk_free(ctx->super); 5323 free(ctx); 5324 cb_fn(cb_arg, -ENOMEM); 5325 return; 5326 } 5327 5328 bs->super_blob = blobid; 5329 5330 /* Read super block */ 5331 bs_sequence_read_dev(seq, ctx->super, bs_page_to_lba(bs, 0), 5332 bs_byte_to_lba(bs, sizeof(*ctx->super)), 5333 bs_set_super_read_cpl, ctx); 5334 } 5335 5336 /* END spdk_bs_set_super */ 5337 5338 void 5339 spdk_bs_get_super(struct spdk_blob_store *bs, 5340 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 5341 { 5342 if (bs->super_blob == SPDK_BLOBID_INVALID) { 5343 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOENT); 5344 } else { 5345 cb_fn(cb_arg, bs->super_blob, 0); 5346 } 5347 } 5348 5349 uint64_t 5350 spdk_bs_get_cluster_size(struct spdk_blob_store *bs) 5351 { 5352 return bs->cluster_sz; 5353 } 5354 5355 uint64_t 5356 spdk_bs_get_page_size(struct spdk_blob_store *bs) 5357 { 5358 return SPDK_BS_PAGE_SIZE; 5359 } 5360 5361 uint64_t 5362 spdk_bs_get_io_unit_size(struct spdk_blob_store *bs) 5363 { 5364 return bs->io_unit_size; 5365 } 5366 5367 uint64_t 5368 spdk_bs_free_cluster_count(struct spdk_blob_store *bs) 5369 { 5370 return bs->num_free_clusters; 5371 } 5372 5373 uint64_t 5374 spdk_bs_total_data_cluster_count(struct spdk_blob_store *bs) 5375 { 5376 return bs->total_data_clusters; 5377 } 5378 5379 static int 5380 bs_register_md_thread(struct spdk_blob_store *bs) 5381 { 5382 bs->md_channel = spdk_get_io_channel(bs); 5383 if (!bs->md_channel) { 5384 SPDK_ERRLOG("Failed to get IO channel.\n"); 5385 return -1; 5386 } 5387 5388 return 0; 5389 } 5390 5391 static int 5392 bs_unregister_md_thread(struct spdk_blob_store *bs) 5393 { 5394 spdk_put_io_channel(bs->md_channel); 5395 5396 return 0; 5397 } 5398 5399 spdk_blob_id spdk_blob_get_id(struct spdk_blob *blob) 5400 { 5401 assert(blob != NULL); 5402 5403 return blob->id; 5404 } 5405 5406 uint64_t spdk_blob_get_num_pages(struct spdk_blob *blob) 5407 { 5408 assert(blob != NULL); 5409 5410 return bs_cluster_to_page(blob->bs, blob->active.num_clusters); 5411 } 5412 5413 uint64_t spdk_blob_get_num_io_units(struct spdk_blob *blob) 5414 { 5415 assert(blob != NULL); 5416 5417 return spdk_blob_get_num_pages(blob) * bs_io_unit_per_page(blob->bs); 5418 } 5419 5420 uint64_t spdk_blob_get_num_clusters(struct spdk_blob *blob) 5421 { 5422 assert(blob != NULL); 5423 5424 return blob->active.num_clusters; 5425 } 5426 5427 /* START spdk_bs_create_blob */ 5428 5429 static void 5430 bs_create_blob_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5431 { 5432 struct spdk_blob *blob = cb_arg; 5433 uint32_t page_idx = bs_blobid_to_page(blob->id); 5434 5435 if (bserrno != 0) { 5436 spdk_bit_array_clear(blob->bs->used_blobids, page_idx); 5437 bs_release_md_page(blob->bs, page_idx); 5438 } 5439 5440 blob_free(blob); 5441 5442 bs_sequence_finish(seq, bserrno); 5443 } 5444 5445 static int 5446 blob_set_xattrs(struct spdk_blob *blob, const struct spdk_blob_xattr_opts *xattrs, 5447 bool internal) 5448 { 5449 uint64_t i; 5450 size_t value_len = 0; 5451 int rc; 5452 const void *value = NULL; 5453 if (xattrs->count > 0 && xattrs->get_value == NULL) { 5454 return -EINVAL; 5455 } 5456 for (i = 0; i < xattrs->count; i++) { 5457 xattrs->get_value(xattrs->ctx, xattrs->names[i], &value, &value_len); 5458 if (value == NULL || value_len == 0) { 5459 return -EINVAL; 5460 } 5461 rc = blob_set_xattr(blob, xattrs->names[i], value, value_len, internal); 5462 if (rc < 0) { 5463 return rc; 5464 } 5465 } 5466 return 0; 5467 } 5468 5469 static void 5470 blob_opts_copy(const struct spdk_blob_opts *src, struct spdk_blob_opts *dst) 5471 { 5472 #define FIELD_OK(field) \ 5473 offsetof(struct spdk_blob_opts, field) + sizeof(src->field) <= src->opts_size 5474 5475 #define SET_FIELD(field) \ 5476 if (FIELD_OK(field)) { \ 5477 dst->field = src->field; \ 5478 } \ 5479 5480 SET_FIELD(num_clusters); 5481 SET_FIELD(thin_provision); 5482 SET_FIELD(clear_method); 5483 5484 if (FIELD_OK(xattrs)) { 5485 memcpy(&dst->xattrs, &src->xattrs, sizeof(src->xattrs)); 5486 } 5487 5488 SET_FIELD(use_extent_table); 5489 5490 dst->opts_size = src->opts_size; 5491 5492 /* You should not remove this statement, but need to update the assert statement 5493 * if you add a new field, and also add a corresponding SET_FIELD statement */ 5494 SPDK_STATIC_ASSERT(sizeof(struct spdk_blob_opts) == 64, "Incorrect size"); 5495 5496 #undef FIELD_OK 5497 #undef SET_FIELD 5498 } 5499 5500 static void 5501 bs_create_blob(struct spdk_blob_store *bs, 5502 const struct spdk_blob_opts *opts, 5503 const struct spdk_blob_xattr_opts *internal_xattrs, 5504 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 5505 { 5506 struct spdk_blob *blob; 5507 uint32_t page_idx; 5508 struct spdk_bs_cpl cpl; 5509 struct spdk_blob_opts opts_local; 5510 struct spdk_blob_xattr_opts internal_xattrs_default; 5511 spdk_bs_sequence_t *seq; 5512 spdk_blob_id id; 5513 int rc; 5514 5515 assert(spdk_get_thread() == bs->md_thread); 5516 5517 page_idx = spdk_bit_array_find_first_clear(bs->used_md_pages, 0); 5518 if (page_idx == UINT32_MAX) { 5519 cb_fn(cb_arg, 0, -ENOMEM); 5520 return; 5521 } 5522 spdk_bit_array_set(bs->used_blobids, page_idx); 5523 bs_claim_md_page(bs, page_idx); 5524 5525 id = bs_page_to_blobid(page_idx); 5526 5527 SPDK_DEBUGLOG(blob, "Creating blob with id %" PRIu64 " at page %u\n", id, page_idx); 5528 5529 blob = blob_alloc(bs, id); 5530 if (!blob) { 5531 spdk_bit_array_clear(bs->used_blobids, page_idx); 5532 bs_release_md_page(bs, page_idx); 5533 cb_fn(cb_arg, 0, -ENOMEM); 5534 return; 5535 } 5536 5537 spdk_blob_opts_init(&opts_local, sizeof(opts_local)); 5538 if (opts) { 5539 blob_opts_copy(opts, &opts_local); 5540 } 5541 5542 blob->use_extent_table = opts_local.use_extent_table; 5543 if (blob->use_extent_table) { 5544 blob->invalid_flags |= SPDK_BLOB_EXTENT_TABLE; 5545 } 5546 5547 if (!internal_xattrs) { 5548 blob_xattrs_init(&internal_xattrs_default); 5549 internal_xattrs = &internal_xattrs_default; 5550 } 5551 5552 rc = blob_set_xattrs(blob, &opts_local.xattrs, false); 5553 if (rc < 0) { 5554 blob_free(blob); 5555 spdk_bit_array_clear(bs->used_blobids, page_idx); 5556 bs_release_md_page(bs, page_idx); 5557 cb_fn(cb_arg, 0, rc); 5558 return; 5559 } 5560 5561 rc = blob_set_xattrs(blob, internal_xattrs, true); 5562 if (rc < 0) { 5563 blob_free(blob); 5564 spdk_bit_array_clear(bs->used_blobids, page_idx); 5565 bs_release_md_page(bs, page_idx); 5566 cb_fn(cb_arg, 0, rc); 5567 return; 5568 } 5569 5570 if (opts_local.thin_provision) { 5571 blob_set_thin_provision(blob); 5572 } 5573 5574 blob_set_clear_method(blob, opts_local.clear_method); 5575 5576 rc = blob_resize(blob, opts_local.num_clusters); 5577 if (rc < 0) { 5578 blob_free(blob); 5579 spdk_bit_array_clear(bs->used_blobids, page_idx); 5580 bs_release_md_page(bs, page_idx); 5581 cb_fn(cb_arg, 0, rc); 5582 return; 5583 } 5584 cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 5585 cpl.u.blobid.cb_fn = cb_fn; 5586 cpl.u.blobid.cb_arg = cb_arg; 5587 cpl.u.blobid.blobid = blob->id; 5588 5589 seq = bs_sequence_start(bs->md_channel, &cpl); 5590 if (!seq) { 5591 blob_free(blob); 5592 spdk_bit_array_clear(bs->used_blobids, page_idx); 5593 bs_release_md_page(bs, page_idx); 5594 cb_fn(cb_arg, 0, -ENOMEM); 5595 return; 5596 } 5597 5598 blob_persist(seq, blob, bs_create_blob_cpl, blob); 5599 } 5600 5601 void spdk_bs_create_blob(struct spdk_blob_store *bs, 5602 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 5603 { 5604 bs_create_blob(bs, NULL, NULL, cb_fn, cb_arg); 5605 } 5606 5607 void spdk_bs_create_blob_ext(struct spdk_blob_store *bs, const struct spdk_blob_opts *opts, 5608 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 5609 { 5610 bs_create_blob(bs, opts, NULL, cb_fn, cb_arg); 5611 } 5612 5613 /* END spdk_bs_create_blob */ 5614 5615 /* START blob_cleanup */ 5616 5617 struct spdk_clone_snapshot_ctx { 5618 struct spdk_bs_cpl cpl; 5619 int bserrno; 5620 bool frozen; 5621 5622 struct spdk_io_channel *channel; 5623 5624 /* Current cluster for inflate operation */ 5625 uint64_t cluster; 5626 5627 /* For inflation force allocation of all unallocated clusters and remove 5628 * thin-provisioning. Otherwise only decouple parent and keep clone thin. */ 5629 bool allocate_all; 5630 5631 struct { 5632 spdk_blob_id id; 5633 struct spdk_blob *blob; 5634 bool md_ro; 5635 } original; 5636 struct { 5637 spdk_blob_id id; 5638 struct spdk_blob *blob; 5639 } new; 5640 5641 /* xattrs specified for snapshot/clones only. They have no impact on 5642 * the original blobs xattrs. */ 5643 const struct spdk_blob_xattr_opts *xattrs; 5644 }; 5645 5646 static void 5647 bs_clone_snapshot_cleanup_finish(void *cb_arg, int bserrno) 5648 { 5649 struct spdk_clone_snapshot_ctx *ctx = cb_arg; 5650 struct spdk_bs_cpl *cpl = &ctx->cpl; 5651 5652 if (bserrno != 0) { 5653 if (ctx->bserrno != 0) { 5654 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 5655 } else { 5656 ctx->bserrno = bserrno; 5657 } 5658 } 5659 5660 switch (cpl->type) { 5661 case SPDK_BS_CPL_TYPE_BLOBID: 5662 cpl->u.blobid.cb_fn(cpl->u.blobid.cb_arg, cpl->u.blobid.blobid, ctx->bserrno); 5663 break; 5664 case SPDK_BS_CPL_TYPE_BLOB_BASIC: 5665 cpl->u.blob_basic.cb_fn(cpl->u.blob_basic.cb_arg, ctx->bserrno); 5666 break; 5667 default: 5668 SPDK_UNREACHABLE(); 5669 break; 5670 } 5671 5672 free(ctx); 5673 } 5674 5675 static void 5676 bs_snapshot_unfreeze_cpl(void *cb_arg, int bserrno) 5677 { 5678 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5679 struct spdk_blob *origblob = ctx->original.blob; 5680 5681 if (bserrno != 0) { 5682 if (ctx->bserrno != 0) { 5683 SPDK_ERRLOG("Unfreeze error %d\n", bserrno); 5684 } else { 5685 ctx->bserrno = bserrno; 5686 } 5687 } 5688 5689 ctx->original.id = origblob->id; 5690 origblob->locked_operation_in_progress = false; 5691 5692 /* Revert md_ro to original state */ 5693 origblob->md_ro = ctx->original.md_ro; 5694 5695 spdk_blob_close(origblob, bs_clone_snapshot_cleanup_finish, ctx); 5696 } 5697 5698 static void 5699 bs_clone_snapshot_origblob_cleanup(void *cb_arg, int bserrno) 5700 { 5701 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5702 struct spdk_blob *origblob = ctx->original.blob; 5703 5704 if (bserrno != 0) { 5705 if (ctx->bserrno != 0) { 5706 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 5707 } else { 5708 ctx->bserrno = bserrno; 5709 } 5710 } 5711 5712 if (ctx->frozen) { 5713 /* Unfreeze any outstanding I/O */ 5714 blob_unfreeze_io(origblob, bs_snapshot_unfreeze_cpl, ctx); 5715 } else { 5716 bs_snapshot_unfreeze_cpl(ctx, 0); 5717 } 5718 5719 } 5720 5721 static void 5722 bs_clone_snapshot_newblob_cleanup(struct spdk_clone_snapshot_ctx *ctx, int bserrno) 5723 { 5724 struct spdk_blob *newblob = ctx->new.blob; 5725 5726 if (bserrno != 0) { 5727 if (ctx->bserrno != 0) { 5728 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 5729 } else { 5730 ctx->bserrno = bserrno; 5731 } 5732 } 5733 5734 ctx->new.id = newblob->id; 5735 spdk_blob_close(newblob, bs_clone_snapshot_origblob_cleanup, ctx); 5736 } 5737 5738 /* END blob_cleanup */ 5739 5740 /* START spdk_bs_create_snapshot */ 5741 5742 static void 5743 bs_snapshot_swap_cluster_maps(struct spdk_blob *blob1, struct spdk_blob *blob2) 5744 { 5745 uint64_t *cluster_temp; 5746 uint32_t *extent_page_temp; 5747 5748 cluster_temp = blob1->active.clusters; 5749 blob1->active.clusters = blob2->active.clusters; 5750 blob2->active.clusters = cluster_temp; 5751 5752 extent_page_temp = blob1->active.extent_pages; 5753 blob1->active.extent_pages = blob2->active.extent_pages; 5754 blob2->active.extent_pages = extent_page_temp; 5755 } 5756 5757 static void 5758 bs_snapshot_origblob_sync_cpl(void *cb_arg, int bserrno) 5759 { 5760 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5761 struct spdk_blob *origblob = ctx->original.blob; 5762 struct spdk_blob *newblob = ctx->new.blob; 5763 5764 if (bserrno != 0) { 5765 bs_snapshot_swap_cluster_maps(newblob, origblob); 5766 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 5767 return; 5768 } 5769 5770 /* Remove metadata descriptor SNAPSHOT_IN_PROGRESS */ 5771 bserrno = blob_remove_xattr(newblob, SNAPSHOT_IN_PROGRESS, true); 5772 if (bserrno != 0) { 5773 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 5774 return; 5775 } 5776 5777 bs_blob_list_add(ctx->original.blob); 5778 5779 spdk_blob_set_read_only(newblob); 5780 5781 /* sync snapshot metadata */ 5782 spdk_blob_sync_md(newblob, bs_clone_snapshot_origblob_cleanup, ctx); 5783 } 5784 5785 static void 5786 bs_snapshot_newblob_sync_cpl(void *cb_arg, int bserrno) 5787 { 5788 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5789 struct spdk_blob *origblob = ctx->original.blob; 5790 struct spdk_blob *newblob = ctx->new.blob; 5791 5792 if (bserrno != 0) { 5793 /* return cluster map back to original */ 5794 bs_snapshot_swap_cluster_maps(newblob, origblob); 5795 5796 /* Newblob md sync failed. Valid clusters are only present in origblob. 5797 * Since I/O is frozen on origblob, not changes to zeroed out cluster map should have occurred. 5798 * Newblob needs to be reverted to thin_provisioned state at creation to properly close. */ 5799 blob_set_thin_provision(newblob); 5800 assert(spdk_mem_all_zero(newblob->active.clusters, 5801 newblob->active.num_clusters * sizeof(*newblob->active.clusters))); 5802 assert(spdk_mem_all_zero(newblob->active.extent_pages, 5803 newblob->active.num_extent_pages * sizeof(*newblob->active.extent_pages))); 5804 5805 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 5806 return; 5807 } 5808 5809 /* Set internal xattr for snapshot id */ 5810 bserrno = blob_set_xattr(origblob, BLOB_SNAPSHOT, &newblob->id, sizeof(spdk_blob_id), true); 5811 if (bserrno != 0) { 5812 /* return cluster map back to original */ 5813 bs_snapshot_swap_cluster_maps(newblob, origblob); 5814 blob_set_thin_provision(newblob); 5815 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 5816 return; 5817 } 5818 5819 /* Create new back_bs_dev for snapshot */ 5820 origblob->back_bs_dev = bs_create_blob_bs_dev(newblob); 5821 if (origblob->back_bs_dev == NULL) { 5822 /* return cluster map back to original */ 5823 bs_snapshot_swap_cluster_maps(newblob, origblob); 5824 blob_set_thin_provision(newblob); 5825 bs_clone_snapshot_newblob_cleanup(ctx, -EINVAL); 5826 return; 5827 } 5828 5829 bs_blob_list_remove(origblob); 5830 origblob->parent_id = newblob->id; 5831 /* set clone blob as thin provisioned */ 5832 blob_set_thin_provision(origblob); 5833 5834 bs_blob_list_add(newblob); 5835 5836 /* sync clone metadata */ 5837 spdk_blob_sync_md(origblob, bs_snapshot_origblob_sync_cpl, ctx); 5838 } 5839 5840 static void 5841 bs_snapshot_freeze_cpl(void *cb_arg, int rc) 5842 { 5843 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5844 struct spdk_blob *origblob = ctx->original.blob; 5845 struct spdk_blob *newblob = ctx->new.blob; 5846 int bserrno; 5847 5848 if (rc != 0) { 5849 bs_clone_snapshot_newblob_cleanup(ctx, rc); 5850 return; 5851 } 5852 5853 ctx->frozen = true; 5854 5855 /* set new back_bs_dev for snapshot */ 5856 newblob->back_bs_dev = origblob->back_bs_dev; 5857 /* Set invalid flags from origblob */ 5858 newblob->invalid_flags = origblob->invalid_flags; 5859 5860 /* inherit parent from original blob if set */ 5861 newblob->parent_id = origblob->parent_id; 5862 if (origblob->parent_id != SPDK_BLOBID_INVALID) { 5863 /* Set internal xattr for snapshot id */ 5864 bserrno = blob_set_xattr(newblob, BLOB_SNAPSHOT, 5865 &origblob->parent_id, sizeof(spdk_blob_id), true); 5866 if (bserrno != 0) { 5867 bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 5868 return; 5869 } 5870 } 5871 5872 /* swap cluster maps */ 5873 bs_snapshot_swap_cluster_maps(newblob, origblob); 5874 5875 /* Set the clear method on the new blob to match the original. */ 5876 blob_set_clear_method(newblob, origblob->clear_method); 5877 5878 /* sync snapshot metadata */ 5879 spdk_blob_sync_md(newblob, bs_snapshot_newblob_sync_cpl, ctx); 5880 } 5881 5882 static void 5883 bs_snapshot_newblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 5884 { 5885 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5886 struct spdk_blob *origblob = ctx->original.blob; 5887 struct spdk_blob *newblob = _blob; 5888 5889 if (bserrno != 0) { 5890 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 5891 return; 5892 } 5893 5894 ctx->new.blob = newblob; 5895 assert(spdk_blob_is_thin_provisioned(newblob)); 5896 assert(spdk_mem_all_zero(newblob->active.clusters, 5897 newblob->active.num_clusters * sizeof(*newblob->active.clusters))); 5898 assert(spdk_mem_all_zero(newblob->active.extent_pages, 5899 newblob->active.num_extent_pages * sizeof(*newblob->active.extent_pages))); 5900 5901 blob_freeze_io(origblob, bs_snapshot_freeze_cpl, ctx); 5902 } 5903 5904 static void 5905 bs_snapshot_newblob_create_cpl(void *cb_arg, spdk_blob_id blobid, int bserrno) 5906 { 5907 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5908 struct spdk_blob *origblob = ctx->original.blob; 5909 5910 if (bserrno != 0) { 5911 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 5912 return; 5913 } 5914 5915 ctx->new.id = blobid; 5916 ctx->cpl.u.blobid.blobid = blobid; 5917 5918 spdk_bs_open_blob(origblob->bs, ctx->new.id, bs_snapshot_newblob_open_cpl, ctx); 5919 } 5920 5921 5922 static void 5923 bs_xattr_snapshot(void *arg, const char *name, 5924 const void **value, size_t *value_len) 5925 { 5926 assert(strncmp(name, SNAPSHOT_IN_PROGRESS, sizeof(SNAPSHOT_IN_PROGRESS)) == 0); 5927 5928 struct spdk_blob *blob = (struct spdk_blob *)arg; 5929 *value = &blob->id; 5930 *value_len = sizeof(blob->id); 5931 } 5932 5933 static void 5934 bs_snapshot_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 5935 { 5936 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 5937 struct spdk_blob_opts opts; 5938 struct spdk_blob_xattr_opts internal_xattrs; 5939 char *xattrs_names[] = { SNAPSHOT_IN_PROGRESS }; 5940 5941 if (bserrno != 0) { 5942 bs_clone_snapshot_cleanup_finish(ctx, bserrno); 5943 return; 5944 } 5945 5946 ctx->original.blob = _blob; 5947 5948 if (_blob->data_ro || _blob->md_ro) { 5949 SPDK_DEBUGLOG(blob, "Cannot create snapshot from read only blob with id %" PRIu64 "\n", 5950 _blob->id); 5951 ctx->bserrno = -EINVAL; 5952 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 5953 return; 5954 } 5955 5956 if (_blob->locked_operation_in_progress) { 5957 SPDK_DEBUGLOG(blob, "Cannot create snapshot - another operation in progress\n"); 5958 ctx->bserrno = -EBUSY; 5959 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 5960 return; 5961 } 5962 5963 _blob->locked_operation_in_progress = true; 5964 5965 spdk_blob_opts_init(&opts, sizeof(opts)); 5966 blob_xattrs_init(&internal_xattrs); 5967 5968 /* Change the size of new blob to the same as in original blob, 5969 * but do not allocate clusters */ 5970 opts.thin_provision = true; 5971 opts.num_clusters = spdk_blob_get_num_clusters(_blob); 5972 opts.use_extent_table = _blob->use_extent_table; 5973 5974 /* If there are any xattrs specified for snapshot, set them now */ 5975 if (ctx->xattrs) { 5976 memcpy(&opts.xattrs, ctx->xattrs, sizeof(*ctx->xattrs)); 5977 } 5978 /* Set internal xattr SNAPSHOT_IN_PROGRESS */ 5979 internal_xattrs.count = 1; 5980 internal_xattrs.ctx = _blob; 5981 internal_xattrs.names = xattrs_names; 5982 internal_xattrs.get_value = bs_xattr_snapshot; 5983 5984 bs_create_blob(_blob->bs, &opts, &internal_xattrs, 5985 bs_snapshot_newblob_create_cpl, ctx); 5986 } 5987 5988 void spdk_bs_create_snapshot(struct spdk_blob_store *bs, spdk_blob_id blobid, 5989 const struct spdk_blob_xattr_opts *snapshot_xattrs, 5990 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 5991 { 5992 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 5993 5994 if (!ctx) { 5995 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOMEM); 5996 return; 5997 } 5998 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 5999 ctx->cpl.u.blobid.cb_fn = cb_fn; 6000 ctx->cpl.u.blobid.cb_arg = cb_arg; 6001 ctx->cpl.u.blobid.blobid = SPDK_BLOBID_INVALID; 6002 ctx->bserrno = 0; 6003 ctx->frozen = false; 6004 ctx->original.id = blobid; 6005 ctx->xattrs = snapshot_xattrs; 6006 6007 spdk_bs_open_blob(bs, ctx->original.id, bs_snapshot_origblob_open_cpl, ctx); 6008 } 6009 /* END spdk_bs_create_snapshot */ 6010 6011 /* START spdk_bs_create_clone */ 6012 6013 static void 6014 bs_xattr_clone(void *arg, const char *name, 6015 const void **value, size_t *value_len) 6016 { 6017 assert(strncmp(name, BLOB_SNAPSHOT, sizeof(BLOB_SNAPSHOT)) == 0); 6018 6019 struct spdk_blob *blob = (struct spdk_blob *)arg; 6020 *value = &blob->id; 6021 *value_len = sizeof(blob->id); 6022 } 6023 6024 static void 6025 bs_clone_newblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6026 { 6027 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6028 struct spdk_blob *clone = _blob; 6029 6030 ctx->new.blob = clone; 6031 bs_blob_list_add(clone); 6032 6033 spdk_blob_close(clone, bs_clone_snapshot_origblob_cleanup, ctx); 6034 } 6035 6036 static void 6037 bs_clone_newblob_create_cpl(void *cb_arg, spdk_blob_id blobid, int bserrno) 6038 { 6039 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6040 6041 ctx->cpl.u.blobid.blobid = blobid; 6042 spdk_bs_open_blob(ctx->original.blob->bs, blobid, bs_clone_newblob_open_cpl, ctx); 6043 } 6044 6045 static void 6046 bs_clone_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6047 { 6048 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6049 struct spdk_blob_opts opts; 6050 struct spdk_blob_xattr_opts internal_xattrs; 6051 char *xattr_names[] = { BLOB_SNAPSHOT }; 6052 6053 if (bserrno != 0) { 6054 bs_clone_snapshot_cleanup_finish(ctx, bserrno); 6055 return; 6056 } 6057 6058 ctx->original.blob = _blob; 6059 ctx->original.md_ro = _blob->md_ro; 6060 6061 if (!_blob->data_ro || !_blob->md_ro) { 6062 SPDK_DEBUGLOG(blob, "Clone not from read-only blob\n"); 6063 ctx->bserrno = -EINVAL; 6064 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6065 return; 6066 } 6067 6068 if (_blob->locked_operation_in_progress) { 6069 SPDK_DEBUGLOG(blob, "Cannot create clone - another operation in progress\n"); 6070 ctx->bserrno = -EBUSY; 6071 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6072 return; 6073 } 6074 6075 _blob->locked_operation_in_progress = true; 6076 6077 spdk_blob_opts_init(&opts, sizeof(opts)); 6078 blob_xattrs_init(&internal_xattrs); 6079 6080 opts.thin_provision = true; 6081 opts.num_clusters = spdk_blob_get_num_clusters(_blob); 6082 opts.use_extent_table = _blob->use_extent_table; 6083 if (ctx->xattrs) { 6084 memcpy(&opts.xattrs, ctx->xattrs, sizeof(*ctx->xattrs)); 6085 } 6086 6087 /* Set internal xattr BLOB_SNAPSHOT */ 6088 internal_xattrs.count = 1; 6089 internal_xattrs.ctx = _blob; 6090 internal_xattrs.names = xattr_names; 6091 internal_xattrs.get_value = bs_xattr_clone; 6092 6093 bs_create_blob(_blob->bs, &opts, &internal_xattrs, 6094 bs_clone_newblob_create_cpl, ctx); 6095 } 6096 6097 void spdk_bs_create_clone(struct spdk_blob_store *bs, spdk_blob_id blobid, 6098 const struct spdk_blob_xattr_opts *clone_xattrs, 6099 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 6100 { 6101 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 6102 6103 if (!ctx) { 6104 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOMEM); 6105 return; 6106 } 6107 6108 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 6109 ctx->cpl.u.blobid.cb_fn = cb_fn; 6110 ctx->cpl.u.blobid.cb_arg = cb_arg; 6111 ctx->cpl.u.blobid.blobid = SPDK_BLOBID_INVALID; 6112 ctx->bserrno = 0; 6113 ctx->xattrs = clone_xattrs; 6114 ctx->original.id = blobid; 6115 6116 spdk_bs_open_blob(bs, ctx->original.id, bs_clone_origblob_open_cpl, ctx); 6117 } 6118 6119 /* END spdk_bs_create_clone */ 6120 6121 /* START spdk_bs_inflate_blob */ 6122 6123 static void 6124 bs_inflate_blob_set_parent_cpl(void *cb_arg, struct spdk_blob *_parent, int bserrno) 6125 { 6126 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6127 struct spdk_blob *_blob = ctx->original.blob; 6128 6129 if (bserrno != 0) { 6130 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6131 return; 6132 } 6133 6134 /* Temporarily override md_ro flag for MD modification */ 6135 _blob->md_ro = false; 6136 6137 bserrno = blob_set_xattr(_blob, BLOB_SNAPSHOT, &_parent->id, sizeof(spdk_blob_id), true); 6138 if (bserrno != 0) { 6139 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6140 return; 6141 } 6142 6143 assert(_parent != NULL); 6144 6145 bs_blob_list_remove(_blob); 6146 _blob->parent_id = _parent->id; 6147 6148 _blob->back_bs_dev->destroy(_blob->back_bs_dev); 6149 _blob->back_bs_dev = bs_create_blob_bs_dev(_parent); 6150 bs_blob_list_add(_blob); 6151 6152 spdk_blob_sync_md(_blob, bs_clone_snapshot_origblob_cleanup, ctx); 6153 } 6154 6155 static void 6156 bs_inflate_blob_done(struct spdk_clone_snapshot_ctx *ctx) 6157 { 6158 struct spdk_blob *_blob = ctx->original.blob; 6159 struct spdk_blob *_parent; 6160 6161 if (ctx->allocate_all) { 6162 /* remove thin provisioning */ 6163 bs_blob_list_remove(_blob); 6164 blob_remove_xattr(_blob, BLOB_SNAPSHOT, true); 6165 _blob->invalid_flags = _blob->invalid_flags & ~SPDK_BLOB_THIN_PROV; 6166 _blob->back_bs_dev->destroy(_blob->back_bs_dev); 6167 _blob->back_bs_dev = NULL; 6168 _blob->parent_id = SPDK_BLOBID_INVALID; 6169 } else { 6170 _parent = ((struct spdk_blob_bs_dev *)(_blob->back_bs_dev))->blob; 6171 if (_parent->parent_id != SPDK_BLOBID_INVALID) { 6172 /* We must change the parent of the inflated blob */ 6173 spdk_bs_open_blob(_blob->bs, _parent->parent_id, 6174 bs_inflate_blob_set_parent_cpl, ctx); 6175 return; 6176 } 6177 6178 bs_blob_list_remove(_blob); 6179 blob_remove_xattr(_blob, BLOB_SNAPSHOT, true); 6180 _blob->parent_id = SPDK_BLOBID_INVALID; 6181 _blob->back_bs_dev->destroy(_blob->back_bs_dev); 6182 _blob->back_bs_dev = bs_create_zeroes_dev(); 6183 } 6184 6185 /* Temporarily override md_ro flag for MD modification */ 6186 _blob->md_ro = false; 6187 _blob->state = SPDK_BLOB_STATE_DIRTY; 6188 6189 spdk_blob_sync_md(_blob, bs_clone_snapshot_origblob_cleanup, ctx); 6190 } 6191 6192 /* Check if cluster needs allocation */ 6193 static inline bool 6194 bs_cluster_needs_allocation(struct spdk_blob *blob, uint64_t cluster, bool allocate_all) 6195 { 6196 struct spdk_blob_bs_dev *b; 6197 6198 assert(blob != NULL); 6199 6200 if (blob->active.clusters[cluster] != 0) { 6201 /* Cluster is already allocated */ 6202 return false; 6203 } 6204 6205 if (blob->parent_id == SPDK_BLOBID_INVALID) { 6206 /* Blob have no parent blob */ 6207 return allocate_all; 6208 } 6209 6210 b = (struct spdk_blob_bs_dev *)blob->back_bs_dev; 6211 return (allocate_all || b->blob->active.clusters[cluster] != 0); 6212 } 6213 6214 static void 6215 bs_inflate_blob_touch_next(void *cb_arg, int bserrno) 6216 { 6217 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6218 struct spdk_blob *_blob = ctx->original.blob; 6219 struct spdk_bs_cpl cpl; 6220 spdk_bs_user_op_t *op; 6221 uint64_t offset; 6222 6223 if (bserrno != 0) { 6224 bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 6225 return; 6226 } 6227 6228 for (; ctx->cluster < _blob->active.num_clusters; ctx->cluster++) { 6229 if (bs_cluster_needs_allocation(_blob, ctx->cluster, ctx->allocate_all)) { 6230 break; 6231 } 6232 } 6233 6234 if (ctx->cluster < _blob->active.num_clusters) { 6235 offset = bs_cluster_to_lba(_blob->bs, ctx->cluster); 6236 6237 /* We may safely increment a cluster before copying */ 6238 ctx->cluster++; 6239 6240 /* Use a dummy 0B read as a context for cluster copy */ 6241 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 6242 cpl.u.blob_basic.cb_fn = bs_inflate_blob_touch_next; 6243 cpl.u.blob_basic.cb_arg = ctx; 6244 6245 op = bs_user_op_alloc(ctx->channel, &cpl, SPDK_BLOB_READ, _blob, 6246 NULL, 0, offset, 0); 6247 if (!op) { 6248 bs_clone_snapshot_origblob_cleanup(ctx, -ENOMEM); 6249 return; 6250 } 6251 6252 bs_allocate_and_copy_cluster(_blob, ctx->channel, offset, op); 6253 } else { 6254 bs_inflate_blob_done(ctx); 6255 } 6256 } 6257 6258 static void 6259 bs_inflate_blob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 6260 { 6261 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 6262 uint64_t clusters_needed; 6263 uint64_t i; 6264 6265 if (bserrno != 0) { 6266 bs_clone_snapshot_cleanup_finish(ctx, bserrno); 6267 return; 6268 } 6269 6270 ctx->original.blob = _blob; 6271 ctx->original.md_ro = _blob->md_ro; 6272 6273 if (_blob->locked_operation_in_progress) { 6274 SPDK_DEBUGLOG(blob, "Cannot inflate blob - another operation in progress\n"); 6275 ctx->bserrno = -EBUSY; 6276 spdk_blob_close(_blob, bs_clone_snapshot_cleanup_finish, ctx); 6277 return; 6278 } 6279 6280 _blob->locked_operation_in_progress = true; 6281 6282 if (!ctx->allocate_all && _blob->parent_id == SPDK_BLOBID_INVALID) { 6283 /* This blob have no parent, so we cannot decouple it. */ 6284 SPDK_ERRLOG("Cannot decouple parent of blob with no parent.\n"); 6285 bs_clone_snapshot_origblob_cleanup(ctx, -EINVAL); 6286 return; 6287 } 6288 6289 if (spdk_blob_is_thin_provisioned(_blob) == false) { 6290 /* This is not thin provisioned blob. No need to inflate. */ 6291 bs_clone_snapshot_origblob_cleanup(ctx, 0); 6292 return; 6293 } 6294 6295 /* Do two passes - one to verify that we can obtain enough clusters 6296 * and another to actually claim them. 6297 */ 6298 clusters_needed = 0; 6299 for (i = 0; i < _blob->active.num_clusters; i++) { 6300 if (bs_cluster_needs_allocation(_blob, i, ctx->allocate_all)) { 6301 clusters_needed++; 6302 } 6303 } 6304 6305 if (clusters_needed > _blob->bs->num_free_clusters) { 6306 /* Not enough free clusters. Cannot satisfy the request. */ 6307 bs_clone_snapshot_origblob_cleanup(ctx, -ENOSPC); 6308 return; 6309 } 6310 6311 ctx->cluster = 0; 6312 bs_inflate_blob_touch_next(ctx, 0); 6313 } 6314 6315 static void 6316 bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 6317 spdk_blob_id blobid, bool allocate_all, spdk_blob_op_complete cb_fn, void *cb_arg) 6318 { 6319 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 6320 6321 if (!ctx) { 6322 cb_fn(cb_arg, -ENOMEM); 6323 return; 6324 } 6325 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 6326 ctx->cpl.u.bs_basic.cb_fn = cb_fn; 6327 ctx->cpl.u.bs_basic.cb_arg = cb_arg; 6328 ctx->bserrno = 0; 6329 ctx->original.id = blobid; 6330 ctx->channel = channel; 6331 ctx->allocate_all = allocate_all; 6332 6333 spdk_bs_open_blob(bs, ctx->original.id, bs_inflate_blob_open_cpl, ctx); 6334 } 6335 6336 void 6337 spdk_bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 6338 spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg) 6339 { 6340 bs_inflate_blob(bs, channel, blobid, true, cb_fn, cb_arg); 6341 } 6342 6343 void 6344 spdk_bs_blob_decouple_parent(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 6345 spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg) 6346 { 6347 bs_inflate_blob(bs, channel, blobid, false, cb_fn, cb_arg); 6348 } 6349 /* END spdk_bs_inflate_blob */ 6350 6351 /* START spdk_blob_resize */ 6352 struct spdk_bs_resize_ctx { 6353 spdk_blob_op_complete cb_fn; 6354 void *cb_arg; 6355 struct spdk_blob *blob; 6356 uint64_t sz; 6357 int rc; 6358 }; 6359 6360 static void 6361 bs_resize_unfreeze_cpl(void *cb_arg, int rc) 6362 { 6363 struct spdk_bs_resize_ctx *ctx = (struct spdk_bs_resize_ctx *)cb_arg; 6364 6365 if (rc != 0) { 6366 SPDK_ERRLOG("Unfreeze failed, rc=%d\n", rc); 6367 } 6368 6369 if (ctx->rc != 0) { 6370 SPDK_ERRLOG("Unfreeze failed, ctx->rc=%d\n", ctx->rc); 6371 rc = ctx->rc; 6372 } 6373 6374 ctx->blob->locked_operation_in_progress = false; 6375 6376 ctx->cb_fn(ctx->cb_arg, rc); 6377 free(ctx); 6378 } 6379 6380 static void 6381 bs_resize_freeze_cpl(void *cb_arg, int rc) 6382 { 6383 struct spdk_bs_resize_ctx *ctx = (struct spdk_bs_resize_ctx *)cb_arg; 6384 6385 if (rc != 0) { 6386 ctx->blob->locked_operation_in_progress = false; 6387 ctx->cb_fn(ctx->cb_arg, rc); 6388 free(ctx); 6389 return; 6390 } 6391 6392 ctx->rc = blob_resize(ctx->blob, ctx->sz); 6393 6394 blob_unfreeze_io(ctx->blob, bs_resize_unfreeze_cpl, ctx); 6395 } 6396 6397 void 6398 spdk_blob_resize(struct spdk_blob *blob, uint64_t sz, spdk_blob_op_complete cb_fn, void *cb_arg) 6399 { 6400 struct spdk_bs_resize_ctx *ctx; 6401 6402 blob_verify_md_op(blob); 6403 6404 SPDK_DEBUGLOG(blob, "Resizing blob %" PRIu64 " to %" PRIu64 " clusters\n", blob->id, sz); 6405 6406 if (blob->md_ro) { 6407 cb_fn(cb_arg, -EPERM); 6408 return; 6409 } 6410 6411 if (sz == blob->active.num_clusters) { 6412 cb_fn(cb_arg, 0); 6413 return; 6414 } 6415 6416 if (blob->locked_operation_in_progress) { 6417 cb_fn(cb_arg, -EBUSY); 6418 return; 6419 } 6420 6421 ctx = calloc(1, sizeof(*ctx)); 6422 if (!ctx) { 6423 cb_fn(cb_arg, -ENOMEM); 6424 return; 6425 } 6426 6427 blob->locked_operation_in_progress = true; 6428 ctx->cb_fn = cb_fn; 6429 ctx->cb_arg = cb_arg; 6430 ctx->blob = blob; 6431 ctx->sz = sz; 6432 blob_freeze_io(blob, bs_resize_freeze_cpl, ctx); 6433 } 6434 6435 /* END spdk_blob_resize */ 6436 6437 6438 /* START spdk_bs_delete_blob */ 6439 6440 static void 6441 bs_delete_close_cpl(void *cb_arg, int bserrno) 6442 { 6443 spdk_bs_sequence_t *seq = cb_arg; 6444 6445 bs_sequence_finish(seq, bserrno); 6446 } 6447 6448 static void 6449 bs_delete_persist_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 6450 { 6451 struct spdk_blob *blob = cb_arg; 6452 6453 if (bserrno != 0) { 6454 /* 6455 * We already removed this blob from the blobstore tailq, so 6456 * we need to free it here since this is the last reference 6457 * to it. 6458 */ 6459 blob_free(blob); 6460 bs_delete_close_cpl(seq, bserrno); 6461 return; 6462 } 6463 6464 /* 6465 * This will immediately decrement the ref_count and call 6466 * the completion routine since the metadata state is clean. 6467 * By calling spdk_blob_close, we reduce the number of call 6468 * points into code that touches the blob->open_ref count 6469 * and the blobstore's blob list. 6470 */ 6471 spdk_blob_close(blob, bs_delete_close_cpl, seq); 6472 } 6473 6474 struct delete_snapshot_ctx { 6475 struct spdk_blob_list *parent_snapshot_entry; 6476 struct spdk_blob *snapshot; 6477 bool snapshot_md_ro; 6478 struct spdk_blob *clone; 6479 bool clone_md_ro; 6480 spdk_blob_op_with_handle_complete cb_fn; 6481 void *cb_arg; 6482 int bserrno; 6483 uint32_t next_extent_page; 6484 }; 6485 6486 static void 6487 delete_blob_cleanup_finish(void *cb_arg, int bserrno) 6488 { 6489 struct delete_snapshot_ctx *ctx = cb_arg; 6490 6491 if (bserrno != 0) { 6492 SPDK_ERRLOG("Snapshot cleanup error %d\n", bserrno); 6493 } 6494 6495 assert(ctx != NULL); 6496 6497 if (bserrno != 0 && ctx->bserrno == 0) { 6498 ctx->bserrno = bserrno; 6499 } 6500 6501 ctx->cb_fn(ctx->cb_arg, ctx->snapshot, ctx->bserrno); 6502 free(ctx); 6503 } 6504 6505 static void 6506 delete_snapshot_cleanup_snapshot(void *cb_arg, int bserrno) 6507 { 6508 struct delete_snapshot_ctx *ctx = cb_arg; 6509 6510 if (bserrno != 0) { 6511 ctx->bserrno = bserrno; 6512 SPDK_ERRLOG("Clone cleanup error %d\n", bserrno); 6513 } 6514 6515 if (ctx->bserrno != 0) { 6516 assert(blob_lookup(ctx->snapshot->bs, ctx->snapshot->id) == NULL); 6517 RB_INSERT(spdk_blob_tree, &ctx->snapshot->bs->open_blobs, ctx->snapshot); 6518 spdk_bit_array_set(ctx->snapshot->bs->open_blobids, ctx->snapshot->id); 6519 } 6520 6521 ctx->snapshot->locked_operation_in_progress = false; 6522 ctx->snapshot->md_ro = ctx->snapshot_md_ro; 6523 6524 spdk_blob_close(ctx->snapshot, delete_blob_cleanup_finish, ctx); 6525 } 6526 6527 static void 6528 delete_snapshot_cleanup_clone(void *cb_arg, int bserrno) 6529 { 6530 struct delete_snapshot_ctx *ctx = cb_arg; 6531 6532 ctx->clone->locked_operation_in_progress = false; 6533 ctx->clone->md_ro = ctx->clone_md_ro; 6534 6535 spdk_blob_close(ctx->clone, delete_snapshot_cleanup_snapshot, ctx); 6536 } 6537 6538 static void 6539 delete_snapshot_unfreeze_cpl(void *cb_arg, int bserrno) 6540 { 6541 struct delete_snapshot_ctx *ctx = cb_arg; 6542 6543 if (bserrno) { 6544 ctx->bserrno = bserrno; 6545 delete_snapshot_cleanup_clone(ctx, 0); 6546 return; 6547 } 6548 6549 ctx->clone->locked_operation_in_progress = false; 6550 spdk_blob_close(ctx->clone, delete_blob_cleanup_finish, ctx); 6551 } 6552 6553 static void 6554 delete_snapshot_sync_snapshot_cpl(void *cb_arg, int bserrno) 6555 { 6556 struct delete_snapshot_ctx *ctx = cb_arg; 6557 struct spdk_blob_list *parent_snapshot_entry = NULL; 6558 struct spdk_blob_list *snapshot_entry = NULL; 6559 struct spdk_blob_list *clone_entry = NULL; 6560 struct spdk_blob_list *snapshot_clone_entry = NULL; 6561 6562 if (bserrno) { 6563 SPDK_ERRLOG("Failed to sync MD on blob\n"); 6564 ctx->bserrno = bserrno; 6565 delete_snapshot_cleanup_clone(ctx, 0); 6566 return; 6567 } 6568 6569 /* Get snapshot entry for the snapshot we want to remove */ 6570 snapshot_entry = bs_get_snapshot_entry(ctx->snapshot->bs, ctx->snapshot->id); 6571 6572 assert(snapshot_entry != NULL); 6573 6574 /* Remove clone entry in this snapshot (at this point there can be only one clone) */ 6575 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 6576 assert(clone_entry != NULL); 6577 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 6578 snapshot_entry->clone_count--; 6579 assert(TAILQ_EMPTY(&snapshot_entry->clones)); 6580 6581 if (ctx->snapshot->parent_id != SPDK_BLOBID_INVALID) { 6582 /* This snapshot is at the same time a clone of another snapshot - we need to 6583 * update parent snapshot (remove current clone, add new one inherited from 6584 * the snapshot that is being removed) */ 6585 6586 /* Get snapshot entry for parent snapshot and clone entry within that snapshot for 6587 * snapshot that we are removing */ 6588 blob_get_snapshot_and_clone_entries(ctx->snapshot, &parent_snapshot_entry, 6589 &snapshot_clone_entry); 6590 6591 /* Switch clone entry in parent snapshot */ 6592 TAILQ_INSERT_TAIL(&parent_snapshot_entry->clones, clone_entry, link); 6593 TAILQ_REMOVE(&parent_snapshot_entry->clones, snapshot_clone_entry, link); 6594 free(snapshot_clone_entry); 6595 } else { 6596 /* No parent snapshot - just remove clone entry */ 6597 free(clone_entry); 6598 } 6599 6600 /* Restore md_ro flags */ 6601 ctx->clone->md_ro = ctx->clone_md_ro; 6602 ctx->snapshot->md_ro = ctx->snapshot_md_ro; 6603 6604 blob_unfreeze_io(ctx->clone, delete_snapshot_unfreeze_cpl, ctx); 6605 } 6606 6607 static void 6608 delete_snapshot_sync_clone_cpl(void *cb_arg, int bserrno) 6609 { 6610 struct delete_snapshot_ctx *ctx = cb_arg; 6611 uint64_t i; 6612 6613 ctx->snapshot->md_ro = false; 6614 6615 if (bserrno) { 6616 SPDK_ERRLOG("Failed to sync MD on clone\n"); 6617 ctx->bserrno = bserrno; 6618 6619 /* Restore snapshot to previous state */ 6620 bserrno = blob_remove_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, true); 6621 if (bserrno != 0) { 6622 delete_snapshot_cleanup_clone(ctx, bserrno); 6623 return; 6624 } 6625 6626 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_cleanup_clone, ctx); 6627 return; 6628 } 6629 6630 /* Clear cluster map entries for snapshot */ 6631 for (i = 0; i < ctx->snapshot->active.num_clusters && i < ctx->clone->active.num_clusters; i++) { 6632 if (ctx->clone->active.clusters[i] == ctx->snapshot->active.clusters[i]) { 6633 ctx->snapshot->active.clusters[i] = 0; 6634 } 6635 } 6636 for (i = 0; i < ctx->snapshot->active.num_extent_pages && 6637 i < ctx->clone->active.num_extent_pages; i++) { 6638 if (ctx->clone->active.extent_pages[i] == ctx->snapshot->active.extent_pages[i]) { 6639 ctx->snapshot->active.extent_pages[i] = 0; 6640 } 6641 } 6642 6643 blob_set_thin_provision(ctx->snapshot); 6644 ctx->snapshot->state = SPDK_BLOB_STATE_DIRTY; 6645 6646 if (ctx->parent_snapshot_entry != NULL) { 6647 ctx->snapshot->back_bs_dev = NULL; 6648 } 6649 6650 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_sync_snapshot_cpl, ctx); 6651 } 6652 6653 static void 6654 delete_snapshot_update_extent_pages_cpl(struct delete_snapshot_ctx *ctx) 6655 { 6656 /* Delete old backing bs_dev from clone (related to snapshot that will be removed) */ 6657 ctx->clone->back_bs_dev->destroy(ctx->clone->back_bs_dev); 6658 6659 /* Set/remove snapshot xattr and switch parent ID and backing bs_dev on clone... */ 6660 if (ctx->parent_snapshot_entry != NULL) { 6661 /* ...to parent snapshot */ 6662 ctx->clone->parent_id = ctx->parent_snapshot_entry->id; 6663 ctx->clone->back_bs_dev = ctx->snapshot->back_bs_dev; 6664 blob_set_xattr(ctx->clone, BLOB_SNAPSHOT, &ctx->parent_snapshot_entry->id, 6665 sizeof(spdk_blob_id), 6666 true); 6667 } else { 6668 /* ...to blobid invalid and zeroes dev */ 6669 ctx->clone->parent_id = SPDK_BLOBID_INVALID; 6670 ctx->clone->back_bs_dev = bs_create_zeroes_dev(); 6671 blob_remove_xattr(ctx->clone, BLOB_SNAPSHOT, true); 6672 } 6673 6674 spdk_blob_sync_md(ctx->clone, delete_snapshot_sync_clone_cpl, ctx); 6675 } 6676 6677 static void 6678 delete_snapshot_update_extent_pages(void *cb_arg, int bserrno) 6679 { 6680 struct delete_snapshot_ctx *ctx = cb_arg; 6681 uint32_t *extent_page; 6682 uint64_t i; 6683 6684 for (i = ctx->next_extent_page; i < ctx->snapshot->active.num_extent_pages && 6685 i < ctx->clone->active.num_extent_pages; i++) { 6686 if (ctx->snapshot->active.extent_pages[i] == 0) { 6687 /* No extent page to use from snapshot */ 6688 continue; 6689 } 6690 6691 extent_page = &ctx->clone->active.extent_pages[i]; 6692 if (*extent_page == 0) { 6693 /* Copy extent page from snapshot when clone did not have a matching one */ 6694 *extent_page = ctx->snapshot->active.extent_pages[i]; 6695 continue; 6696 } 6697 6698 /* Clone and snapshot both contain partially filled matching extent pages. 6699 * Update the clone extent page in place with cluster map containing the mix of both. */ 6700 ctx->next_extent_page = i + 1; 6701 6702 blob_write_extent_page(ctx->clone, *extent_page, i * SPDK_EXTENTS_PER_EP, 6703 delete_snapshot_update_extent_pages, ctx); 6704 return; 6705 } 6706 delete_snapshot_update_extent_pages_cpl(ctx); 6707 } 6708 6709 static void 6710 delete_snapshot_sync_snapshot_xattr_cpl(void *cb_arg, int bserrno) 6711 { 6712 struct delete_snapshot_ctx *ctx = cb_arg; 6713 uint64_t i; 6714 6715 /* Temporarily override md_ro flag for clone for MD modification */ 6716 ctx->clone_md_ro = ctx->clone->md_ro; 6717 ctx->clone->md_ro = false; 6718 6719 if (bserrno) { 6720 SPDK_ERRLOG("Failed to sync MD with xattr on blob\n"); 6721 ctx->bserrno = bserrno; 6722 delete_snapshot_cleanup_clone(ctx, 0); 6723 return; 6724 } 6725 6726 /* Copy snapshot map to clone map (only unallocated clusters in clone) */ 6727 for (i = 0; i < ctx->snapshot->active.num_clusters && i < ctx->clone->active.num_clusters; i++) { 6728 if (ctx->clone->active.clusters[i] == 0) { 6729 ctx->clone->active.clusters[i] = ctx->snapshot->active.clusters[i]; 6730 } 6731 } 6732 ctx->next_extent_page = 0; 6733 delete_snapshot_update_extent_pages(ctx, 0); 6734 } 6735 6736 static void 6737 delete_snapshot_freeze_io_cb(void *cb_arg, int bserrno) 6738 { 6739 struct delete_snapshot_ctx *ctx = cb_arg; 6740 6741 if (bserrno) { 6742 SPDK_ERRLOG("Failed to freeze I/O on clone\n"); 6743 ctx->bserrno = bserrno; 6744 delete_snapshot_cleanup_clone(ctx, 0); 6745 return; 6746 } 6747 6748 /* Temporarily override md_ro flag for snapshot for MD modification */ 6749 ctx->snapshot_md_ro = ctx->snapshot->md_ro; 6750 ctx->snapshot->md_ro = false; 6751 6752 /* Mark blob as pending for removal for power failure safety, use clone id for recovery */ 6753 ctx->bserrno = blob_set_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, &ctx->clone->id, 6754 sizeof(spdk_blob_id), true); 6755 if (ctx->bserrno != 0) { 6756 delete_snapshot_cleanup_clone(ctx, 0); 6757 return; 6758 } 6759 6760 spdk_blob_sync_md(ctx->snapshot, delete_snapshot_sync_snapshot_xattr_cpl, ctx); 6761 } 6762 6763 static void 6764 delete_snapshot_open_clone_cb(void *cb_arg, struct spdk_blob *clone, int bserrno) 6765 { 6766 struct delete_snapshot_ctx *ctx = cb_arg; 6767 6768 if (bserrno) { 6769 SPDK_ERRLOG("Failed to open clone\n"); 6770 ctx->bserrno = bserrno; 6771 delete_snapshot_cleanup_snapshot(ctx, 0); 6772 return; 6773 } 6774 6775 ctx->clone = clone; 6776 6777 if (clone->locked_operation_in_progress) { 6778 SPDK_DEBUGLOG(blob, "Cannot remove blob - another operation in progress on its clone\n"); 6779 ctx->bserrno = -EBUSY; 6780 spdk_blob_close(ctx->clone, delete_snapshot_cleanup_snapshot, ctx); 6781 return; 6782 } 6783 6784 clone->locked_operation_in_progress = true; 6785 6786 blob_freeze_io(clone, delete_snapshot_freeze_io_cb, ctx); 6787 } 6788 6789 static void 6790 update_clone_on_snapshot_deletion(struct spdk_blob *snapshot, struct delete_snapshot_ctx *ctx) 6791 { 6792 struct spdk_blob_list *snapshot_entry = NULL; 6793 struct spdk_blob_list *clone_entry = NULL; 6794 struct spdk_blob_list *snapshot_clone_entry = NULL; 6795 6796 /* Get snapshot entry for the snapshot we want to remove */ 6797 snapshot_entry = bs_get_snapshot_entry(snapshot->bs, snapshot->id); 6798 6799 assert(snapshot_entry != NULL); 6800 6801 /* Get clone of the snapshot (at this point there can be only one clone) */ 6802 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 6803 assert(snapshot_entry->clone_count == 1); 6804 assert(clone_entry != NULL); 6805 6806 /* Get snapshot entry for parent snapshot and clone entry within that snapshot for 6807 * snapshot that we are removing */ 6808 blob_get_snapshot_and_clone_entries(snapshot, &ctx->parent_snapshot_entry, 6809 &snapshot_clone_entry); 6810 6811 spdk_bs_open_blob(snapshot->bs, clone_entry->id, delete_snapshot_open_clone_cb, ctx); 6812 } 6813 6814 static void 6815 bs_delete_blob_finish(void *cb_arg, struct spdk_blob *blob, int bserrno) 6816 { 6817 spdk_bs_sequence_t *seq = cb_arg; 6818 struct spdk_blob_list *snapshot_entry = NULL; 6819 uint32_t page_num; 6820 6821 if (bserrno) { 6822 SPDK_ERRLOG("Failed to remove blob\n"); 6823 bs_sequence_finish(seq, bserrno); 6824 return; 6825 } 6826 6827 /* Remove snapshot from the list */ 6828 snapshot_entry = bs_get_snapshot_entry(blob->bs, blob->id); 6829 if (snapshot_entry != NULL) { 6830 TAILQ_REMOVE(&blob->bs->snapshots, snapshot_entry, link); 6831 free(snapshot_entry); 6832 } 6833 6834 page_num = bs_blobid_to_page(blob->id); 6835 spdk_bit_array_clear(blob->bs->used_blobids, page_num); 6836 blob->state = SPDK_BLOB_STATE_DIRTY; 6837 blob->active.num_pages = 0; 6838 blob_resize(blob, 0); 6839 6840 blob_persist(seq, blob, bs_delete_persist_cpl, blob); 6841 } 6842 6843 static int 6844 bs_is_blob_deletable(struct spdk_blob *blob, bool *update_clone) 6845 { 6846 struct spdk_blob_list *snapshot_entry = NULL; 6847 struct spdk_blob_list *clone_entry = NULL; 6848 struct spdk_blob *clone = NULL; 6849 bool has_one_clone = false; 6850 6851 /* Check if this is a snapshot with clones */ 6852 snapshot_entry = bs_get_snapshot_entry(blob->bs, blob->id); 6853 if (snapshot_entry != NULL) { 6854 if (snapshot_entry->clone_count > 1) { 6855 SPDK_ERRLOG("Cannot remove snapshot with more than one clone\n"); 6856 return -EBUSY; 6857 } else if (snapshot_entry->clone_count == 1) { 6858 has_one_clone = true; 6859 } 6860 } 6861 6862 /* Check if someone has this blob open (besides this delete context): 6863 * - open_ref = 1 - only this context opened blob, so it is ok to remove it 6864 * - open_ref <= 2 && has_one_clone = true - clone is holding snapshot 6865 * and that is ok, because we will update it accordingly */ 6866 if (blob->open_ref <= 2 && has_one_clone) { 6867 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 6868 assert(clone_entry != NULL); 6869 clone = blob_lookup(blob->bs, clone_entry->id); 6870 6871 if (blob->open_ref == 2 && clone == NULL) { 6872 /* Clone is closed and someone else opened this blob */ 6873 SPDK_ERRLOG("Cannot remove snapshot because it is open\n"); 6874 return -EBUSY; 6875 } 6876 6877 *update_clone = true; 6878 return 0; 6879 } 6880 6881 if (blob->open_ref > 1) { 6882 SPDK_ERRLOG("Cannot remove snapshot because it is open\n"); 6883 return -EBUSY; 6884 } 6885 6886 assert(has_one_clone == false); 6887 *update_clone = false; 6888 return 0; 6889 } 6890 6891 static void 6892 bs_delete_enomem_close_cpl(void *cb_arg, int bserrno) 6893 { 6894 spdk_bs_sequence_t *seq = cb_arg; 6895 6896 bs_sequence_finish(seq, -ENOMEM); 6897 } 6898 6899 static void 6900 bs_delete_open_cpl(void *cb_arg, struct spdk_blob *blob, int bserrno) 6901 { 6902 spdk_bs_sequence_t *seq = cb_arg; 6903 struct delete_snapshot_ctx *ctx; 6904 bool update_clone = false; 6905 6906 if (bserrno != 0) { 6907 bs_sequence_finish(seq, bserrno); 6908 return; 6909 } 6910 6911 blob_verify_md_op(blob); 6912 6913 ctx = calloc(1, sizeof(*ctx)); 6914 if (ctx == NULL) { 6915 spdk_blob_close(blob, bs_delete_enomem_close_cpl, seq); 6916 return; 6917 } 6918 6919 ctx->snapshot = blob; 6920 ctx->cb_fn = bs_delete_blob_finish; 6921 ctx->cb_arg = seq; 6922 6923 /* Check if blob can be removed and if it is a snapshot with clone on top of it */ 6924 ctx->bserrno = bs_is_blob_deletable(blob, &update_clone); 6925 if (ctx->bserrno) { 6926 spdk_blob_close(blob, delete_blob_cleanup_finish, ctx); 6927 return; 6928 } 6929 6930 if (blob->locked_operation_in_progress) { 6931 SPDK_DEBUGLOG(blob, "Cannot remove blob - another operation in progress\n"); 6932 ctx->bserrno = -EBUSY; 6933 spdk_blob_close(blob, delete_blob_cleanup_finish, ctx); 6934 return; 6935 } 6936 6937 blob->locked_operation_in_progress = true; 6938 6939 /* 6940 * Remove the blob from the blob_store list now, to ensure it does not 6941 * get returned after this point by blob_lookup(). 6942 */ 6943 spdk_bit_array_clear(blob->bs->open_blobids, blob->id); 6944 RB_REMOVE(spdk_blob_tree, &blob->bs->open_blobs, blob); 6945 6946 if (update_clone) { 6947 /* This blob is a snapshot with active clone - update clone first */ 6948 update_clone_on_snapshot_deletion(blob, ctx); 6949 } else { 6950 /* This blob does not have any clones - just remove it */ 6951 bs_blob_list_remove(blob); 6952 bs_delete_blob_finish(seq, blob, 0); 6953 free(ctx); 6954 } 6955 } 6956 6957 void 6958 spdk_bs_delete_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 6959 spdk_blob_op_complete cb_fn, void *cb_arg) 6960 { 6961 struct spdk_bs_cpl cpl; 6962 spdk_bs_sequence_t *seq; 6963 6964 SPDK_DEBUGLOG(blob, "Deleting blob %" PRIu64 "\n", blobid); 6965 6966 assert(spdk_get_thread() == bs->md_thread); 6967 6968 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 6969 cpl.u.blob_basic.cb_fn = cb_fn; 6970 cpl.u.blob_basic.cb_arg = cb_arg; 6971 6972 seq = bs_sequence_start(bs->md_channel, &cpl); 6973 if (!seq) { 6974 cb_fn(cb_arg, -ENOMEM); 6975 return; 6976 } 6977 6978 spdk_bs_open_blob(bs, blobid, bs_delete_open_cpl, seq); 6979 } 6980 6981 /* END spdk_bs_delete_blob */ 6982 6983 /* START spdk_bs_open_blob */ 6984 6985 static void 6986 bs_open_blob_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 6987 { 6988 struct spdk_blob *blob = cb_arg; 6989 struct spdk_blob *existing; 6990 6991 if (bserrno != 0) { 6992 blob_free(blob); 6993 seq->cpl.u.blob_handle.blob = NULL; 6994 bs_sequence_finish(seq, bserrno); 6995 return; 6996 } 6997 6998 existing = blob_lookup(blob->bs, blob->id); 6999 if (existing) { 7000 blob_free(blob); 7001 existing->open_ref++; 7002 seq->cpl.u.blob_handle.blob = existing; 7003 bs_sequence_finish(seq, 0); 7004 return; 7005 } 7006 7007 blob->open_ref++; 7008 7009 spdk_bit_array_set(blob->bs->open_blobids, blob->id); 7010 RB_INSERT(spdk_blob_tree, &blob->bs->open_blobs, blob); 7011 7012 bs_sequence_finish(seq, bserrno); 7013 } 7014 7015 static inline void 7016 blob_open_opts_copy(const struct spdk_blob_open_opts *src, struct spdk_blob_open_opts *dst) 7017 { 7018 #define FIELD_OK(field) \ 7019 offsetof(struct spdk_blob_opts, field) + sizeof(src->field) <= src->opts_size 7020 7021 #define SET_FIELD(field) \ 7022 if (FIELD_OK(field)) { \ 7023 dst->field = src->field; \ 7024 } \ 7025 7026 SET_FIELD(clear_method); 7027 7028 dst->opts_size = src->opts_size; 7029 7030 /* You should not remove this statement, but need to update the assert statement 7031 * if you add a new field, and also add a corresponding SET_FIELD statement */ 7032 SPDK_STATIC_ASSERT(sizeof(struct spdk_blob_open_opts) == 16, "Incorrect size"); 7033 7034 #undef FIELD_OK 7035 #undef SET_FIELD 7036 } 7037 7038 static void 7039 bs_open_blob(struct spdk_blob_store *bs, 7040 spdk_blob_id blobid, 7041 struct spdk_blob_open_opts *opts, 7042 spdk_blob_op_with_handle_complete cb_fn, 7043 void *cb_arg) 7044 { 7045 struct spdk_blob *blob; 7046 struct spdk_bs_cpl cpl; 7047 struct spdk_blob_open_opts opts_local; 7048 spdk_bs_sequence_t *seq; 7049 uint32_t page_num; 7050 7051 SPDK_DEBUGLOG(blob, "Opening blob %" PRIu64 "\n", blobid); 7052 assert(spdk_get_thread() == bs->md_thread); 7053 7054 page_num = bs_blobid_to_page(blobid); 7055 if (spdk_bit_array_get(bs->used_blobids, page_num) == false) { 7056 /* Invalid blobid */ 7057 cb_fn(cb_arg, NULL, -ENOENT); 7058 return; 7059 } 7060 7061 blob = blob_lookup(bs, blobid); 7062 if (blob) { 7063 blob->open_ref++; 7064 cb_fn(cb_arg, blob, 0); 7065 return; 7066 } 7067 7068 blob = blob_alloc(bs, blobid); 7069 if (!blob) { 7070 cb_fn(cb_arg, NULL, -ENOMEM); 7071 return; 7072 } 7073 7074 spdk_blob_open_opts_init(&opts_local, sizeof(opts_local)); 7075 if (opts) { 7076 blob_open_opts_copy(opts, &opts_local); 7077 } 7078 7079 blob->clear_method = opts_local.clear_method; 7080 7081 cpl.type = SPDK_BS_CPL_TYPE_BLOB_HANDLE; 7082 cpl.u.blob_handle.cb_fn = cb_fn; 7083 cpl.u.blob_handle.cb_arg = cb_arg; 7084 cpl.u.blob_handle.blob = blob; 7085 7086 seq = bs_sequence_start(bs->md_channel, &cpl); 7087 if (!seq) { 7088 blob_free(blob); 7089 cb_fn(cb_arg, NULL, -ENOMEM); 7090 return; 7091 } 7092 7093 blob_load(seq, blob, bs_open_blob_cpl, blob); 7094 } 7095 7096 void spdk_bs_open_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 7097 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 7098 { 7099 bs_open_blob(bs, blobid, NULL, cb_fn, cb_arg); 7100 } 7101 7102 void spdk_bs_open_blob_ext(struct spdk_blob_store *bs, spdk_blob_id blobid, 7103 struct spdk_blob_open_opts *opts, spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 7104 { 7105 bs_open_blob(bs, blobid, opts, cb_fn, cb_arg); 7106 } 7107 7108 /* END spdk_bs_open_blob */ 7109 7110 /* START spdk_blob_set_read_only */ 7111 int spdk_blob_set_read_only(struct spdk_blob *blob) 7112 { 7113 blob_verify_md_op(blob); 7114 7115 blob->data_ro_flags |= SPDK_BLOB_READ_ONLY; 7116 7117 blob->state = SPDK_BLOB_STATE_DIRTY; 7118 return 0; 7119 } 7120 /* END spdk_blob_set_read_only */ 7121 7122 /* START spdk_blob_sync_md */ 7123 7124 static void 7125 blob_sync_md_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 7126 { 7127 struct spdk_blob *blob = cb_arg; 7128 7129 if (bserrno == 0 && (blob->data_ro_flags & SPDK_BLOB_READ_ONLY)) { 7130 blob->data_ro = true; 7131 blob->md_ro = true; 7132 } 7133 7134 bs_sequence_finish(seq, bserrno); 7135 } 7136 7137 static void 7138 blob_sync_md(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 7139 { 7140 struct spdk_bs_cpl cpl; 7141 spdk_bs_sequence_t *seq; 7142 7143 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 7144 cpl.u.blob_basic.cb_fn = cb_fn; 7145 cpl.u.blob_basic.cb_arg = cb_arg; 7146 7147 seq = bs_sequence_start(blob->bs->md_channel, &cpl); 7148 if (!seq) { 7149 cb_fn(cb_arg, -ENOMEM); 7150 return; 7151 } 7152 7153 blob_persist(seq, blob, blob_sync_md_cpl, blob); 7154 } 7155 7156 void 7157 spdk_blob_sync_md(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 7158 { 7159 blob_verify_md_op(blob); 7160 7161 SPDK_DEBUGLOG(blob, "Syncing blob %" PRIu64 "\n", blob->id); 7162 7163 if (blob->md_ro) { 7164 assert(blob->state == SPDK_BLOB_STATE_CLEAN); 7165 cb_fn(cb_arg, 0); 7166 return; 7167 } 7168 7169 blob_sync_md(blob, cb_fn, cb_arg); 7170 } 7171 7172 /* END spdk_blob_sync_md */ 7173 7174 struct spdk_blob_insert_cluster_ctx { 7175 struct spdk_thread *thread; 7176 struct spdk_blob *blob; 7177 uint32_t cluster_num; /* cluster index in blob */ 7178 uint32_t cluster; /* cluster on disk */ 7179 uint32_t extent_page; /* extent page on disk */ 7180 int rc; 7181 spdk_blob_op_complete cb_fn; 7182 void *cb_arg; 7183 }; 7184 7185 static void 7186 blob_insert_cluster_msg_cpl(void *arg) 7187 { 7188 struct spdk_blob_insert_cluster_ctx *ctx = arg; 7189 7190 ctx->cb_fn(ctx->cb_arg, ctx->rc); 7191 free(ctx); 7192 } 7193 7194 static void 7195 blob_insert_cluster_msg_cb(void *arg, int bserrno) 7196 { 7197 struct spdk_blob_insert_cluster_ctx *ctx = arg; 7198 7199 ctx->rc = bserrno; 7200 spdk_thread_send_msg(ctx->thread, blob_insert_cluster_msg_cpl, ctx); 7201 } 7202 7203 static void 7204 blob_insert_new_ep_cb(void *arg, int bserrno) 7205 { 7206 struct spdk_blob_insert_cluster_ctx *ctx = arg; 7207 uint32_t *extent_page; 7208 7209 extent_page = bs_cluster_to_extent_page(ctx->blob, ctx->cluster_num); 7210 *extent_page = ctx->extent_page; 7211 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 7212 blob_sync_md(ctx->blob, blob_insert_cluster_msg_cb, ctx); 7213 } 7214 7215 static void 7216 blob_persist_extent_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 7217 { 7218 struct spdk_blob_md_page *page = cb_arg; 7219 7220 bs_sequence_finish(seq, bserrno); 7221 spdk_free(page); 7222 } 7223 7224 static void 7225 blob_write_extent_page(struct spdk_blob *blob, uint32_t extent, uint64_t cluster_num, 7226 spdk_blob_op_complete cb_fn, void *cb_arg) 7227 { 7228 spdk_bs_sequence_t *seq; 7229 struct spdk_bs_cpl cpl; 7230 struct spdk_blob_md_page *page = NULL; 7231 uint32_t page_count = 0; 7232 int rc; 7233 7234 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 7235 cpl.u.blob_basic.cb_fn = cb_fn; 7236 cpl.u.blob_basic.cb_arg = cb_arg; 7237 7238 seq = bs_sequence_start(blob->bs->md_channel, &cpl); 7239 if (!seq) { 7240 cb_fn(cb_arg, -ENOMEM); 7241 return; 7242 } 7243 rc = blob_serialize_add_page(blob, &page, &page_count, &page); 7244 if (rc < 0) { 7245 bs_sequence_finish(seq, rc); 7246 return; 7247 } 7248 7249 blob_serialize_extent_page(blob, cluster_num, page); 7250 7251 page->crc = blob_md_page_calc_crc(page); 7252 7253 assert(spdk_bit_array_get(blob->bs->used_md_pages, extent) == true); 7254 7255 bs_sequence_write_dev(seq, page, bs_md_page_to_lba(blob->bs, extent), 7256 bs_byte_to_lba(blob->bs, SPDK_BS_PAGE_SIZE), 7257 blob_persist_extent_page_cpl, page); 7258 } 7259 7260 static void 7261 blob_insert_cluster_msg(void *arg) 7262 { 7263 struct spdk_blob_insert_cluster_ctx *ctx = arg; 7264 uint32_t *extent_page; 7265 7266 ctx->rc = blob_insert_cluster(ctx->blob, ctx->cluster_num, ctx->cluster); 7267 if (ctx->rc != 0) { 7268 spdk_thread_send_msg(ctx->thread, blob_insert_cluster_msg_cpl, ctx); 7269 return; 7270 } 7271 7272 if (ctx->blob->use_extent_table == false) { 7273 /* Extent table is not used, proceed with sync of md that will only use extents_rle. */ 7274 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 7275 blob_sync_md(ctx->blob, blob_insert_cluster_msg_cb, ctx); 7276 return; 7277 } 7278 7279 extent_page = bs_cluster_to_extent_page(ctx->blob, ctx->cluster_num); 7280 if (*extent_page == 0) { 7281 /* Extent page requires allocation. 7282 * It was already claimed in the used_md_pages map and placed in ctx. */ 7283 assert(ctx->extent_page != 0); 7284 assert(spdk_bit_array_get(ctx->blob->bs->used_md_pages, ctx->extent_page) == true); 7285 blob_write_extent_page(ctx->blob, ctx->extent_page, ctx->cluster_num, 7286 blob_insert_new_ep_cb, ctx); 7287 } else { 7288 /* It is possible for original thread to allocate extent page for 7289 * different cluster in the same extent page. In such case proceed with 7290 * updating the existing extent page, but release the additional one. */ 7291 if (ctx->extent_page != 0) { 7292 assert(spdk_bit_array_get(ctx->blob->bs->used_md_pages, ctx->extent_page) == true); 7293 bs_release_md_page(ctx->blob->bs, ctx->extent_page); 7294 ctx->extent_page = 0; 7295 } 7296 /* Extent page already allocated. 7297 * Every cluster allocation, requires just an update of single extent page. */ 7298 blob_write_extent_page(ctx->blob, *extent_page, ctx->cluster_num, 7299 blob_insert_cluster_msg_cb, ctx); 7300 } 7301 } 7302 7303 static void 7304 blob_insert_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 7305 uint64_t cluster, uint32_t extent_page, spdk_blob_op_complete cb_fn, void *cb_arg) 7306 { 7307 struct spdk_blob_insert_cluster_ctx *ctx; 7308 7309 ctx = calloc(1, sizeof(*ctx)); 7310 if (ctx == NULL) { 7311 cb_fn(cb_arg, -ENOMEM); 7312 return; 7313 } 7314 7315 ctx->thread = spdk_get_thread(); 7316 ctx->blob = blob; 7317 ctx->cluster_num = cluster_num; 7318 ctx->cluster = cluster; 7319 ctx->extent_page = extent_page; 7320 ctx->cb_fn = cb_fn; 7321 ctx->cb_arg = cb_arg; 7322 7323 spdk_thread_send_msg(blob->bs->md_thread, blob_insert_cluster_msg, ctx); 7324 } 7325 7326 /* START spdk_blob_close */ 7327 7328 static void 7329 blob_close_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 7330 { 7331 struct spdk_blob *blob = cb_arg; 7332 7333 if (bserrno == 0) { 7334 blob->open_ref--; 7335 if (blob->open_ref == 0) { 7336 /* 7337 * Blobs with active.num_pages == 0 are deleted blobs. 7338 * these blobs are removed from the blob_store list 7339 * when the deletion process starts - so don't try to 7340 * remove them again. 7341 */ 7342 if (blob->active.num_pages > 0) { 7343 spdk_bit_array_clear(blob->bs->open_blobids, blob->id); 7344 RB_REMOVE(spdk_blob_tree, &blob->bs->open_blobs, blob); 7345 } 7346 blob_free(blob); 7347 } 7348 } 7349 7350 bs_sequence_finish(seq, bserrno); 7351 } 7352 7353 void spdk_blob_close(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 7354 { 7355 struct spdk_bs_cpl cpl; 7356 spdk_bs_sequence_t *seq; 7357 7358 blob_verify_md_op(blob); 7359 7360 SPDK_DEBUGLOG(blob, "Closing blob %" PRIu64 "\n", blob->id); 7361 7362 if (blob->open_ref == 0) { 7363 cb_fn(cb_arg, -EBADF); 7364 return; 7365 } 7366 7367 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 7368 cpl.u.blob_basic.cb_fn = cb_fn; 7369 cpl.u.blob_basic.cb_arg = cb_arg; 7370 7371 seq = bs_sequence_start(blob->bs->md_channel, &cpl); 7372 if (!seq) { 7373 cb_fn(cb_arg, -ENOMEM); 7374 return; 7375 } 7376 7377 /* Sync metadata */ 7378 blob_persist(seq, blob, blob_close_cpl, blob); 7379 } 7380 7381 /* END spdk_blob_close */ 7382 7383 struct spdk_io_channel *spdk_bs_alloc_io_channel(struct spdk_blob_store *bs) 7384 { 7385 return spdk_get_io_channel(bs); 7386 } 7387 7388 void spdk_bs_free_io_channel(struct spdk_io_channel *channel) 7389 { 7390 spdk_put_io_channel(channel); 7391 } 7392 7393 void spdk_blob_io_unmap(struct spdk_blob *blob, struct spdk_io_channel *channel, 7394 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg) 7395 { 7396 blob_request_submit_op(blob, channel, NULL, offset, length, cb_fn, cb_arg, 7397 SPDK_BLOB_UNMAP); 7398 } 7399 7400 void spdk_blob_io_write_zeroes(struct spdk_blob *blob, struct spdk_io_channel *channel, 7401 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg) 7402 { 7403 blob_request_submit_op(blob, channel, NULL, offset, length, cb_fn, cb_arg, 7404 SPDK_BLOB_WRITE_ZEROES); 7405 } 7406 7407 void spdk_blob_io_write(struct spdk_blob *blob, struct spdk_io_channel *channel, 7408 void *payload, uint64_t offset, uint64_t length, 7409 spdk_blob_op_complete cb_fn, void *cb_arg) 7410 { 7411 blob_request_submit_op(blob, channel, payload, offset, length, cb_fn, cb_arg, 7412 SPDK_BLOB_WRITE); 7413 } 7414 7415 void spdk_blob_io_read(struct spdk_blob *blob, struct spdk_io_channel *channel, 7416 void *payload, uint64_t offset, uint64_t length, 7417 spdk_blob_op_complete cb_fn, void *cb_arg) 7418 { 7419 blob_request_submit_op(blob, channel, payload, offset, length, cb_fn, cb_arg, 7420 SPDK_BLOB_READ); 7421 } 7422 7423 void spdk_blob_io_writev(struct spdk_blob *blob, struct spdk_io_channel *channel, 7424 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 7425 spdk_blob_op_complete cb_fn, void *cb_arg) 7426 { 7427 blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, false); 7428 } 7429 7430 void spdk_blob_io_readv(struct spdk_blob *blob, struct spdk_io_channel *channel, 7431 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 7432 spdk_blob_op_complete cb_fn, void *cb_arg) 7433 { 7434 blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, true); 7435 } 7436 7437 struct spdk_bs_iter_ctx { 7438 int64_t page_num; 7439 struct spdk_blob_store *bs; 7440 7441 spdk_blob_op_with_handle_complete cb_fn; 7442 void *cb_arg; 7443 }; 7444 7445 static void 7446 bs_iter_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 7447 { 7448 struct spdk_bs_iter_ctx *ctx = cb_arg; 7449 struct spdk_blob_store *bs = ctx->bs; 7450 spdk_blob_id id; 7451 7452 if (bserrno == 0) { 7453 ctx->cb_fn(ctx->cb_arg, _blob, bserrno); 7454 free(ctx); 7455 return; 7456 } 7457 7458 ctx->page_num++; 7459 ctx->page_num = spdk_bit_array_find_first_set(bs->used_blobids, ctx->page_num); 7460 if (ctx->page_num >= spdk_bit_array_capacity(bs->used_blobids)) { 7461 ctx->cb_fn(ctx->cb_arg, NULL, -ENOENT); 7462 free(ctx); 7463 return; 7464 } 7465 7466 id = bs_page_to_blobid(ctx->page_num); 7467 7468 spdk_bs_open_blob(bs, id, bs_iter_cpl, ctx); 7469 } 7470 7471 void 7472 spdk_bs_iter_first(struct spdk_blob_store *bs, 7473 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 7474 { 7475 struct spdk_bs_iter_ctx *ctx; 7476 7477 ctx = calloc(1, sizeof(*ctx)); 7478 if (!ctx) { 7479 cb_fn(cb_arg, NULL, -ENOMEM); 7480 return; 7481 } 7482 7483 ctx->page_num = -1; 7484 ctx->bs = bs; 7485 ctx->cb_fn = cb_fn; 7486 ctx->cb_arg = cb_arg; 7487 7488 bs_iter_cpl(ctx, NULL, -1); 7489 } 7490 7491 static void 7492 bs_iter_close_cpl(void *cb_arg, int bserrno) 7493 { 7494 struct spdk_bs_iter_ctx *ctx = cb_arg; 7495 7496 bs_iter_cpl(ctx, NULL, -1); 7497 } 7498 7499 void 7500 spdk_bs_iter_next(struct spdk_blob_store *bs, struct spdk_blob *blob, 7501 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 7502 { 7503 struct spdk_bs_iter_ctx *ctx; 7504 7505 assert(blob != NULL); 7506 7507 ctx = calloc(1, sizeof(*ctx)); 7508 if (!ctx) { 7509 cb_fn(cb_arg, NULL, -ENOMEM); 7510 return; 7511 } 7512 7513 ctx->page_num = bs_blobid_to_page(blob->id); 7514 ctx->bs = bs; 7515 ctx->cb_fn = cb_fn; 7516 ctx->cb_arg = cb_arg; 7517 7518 /* Close the existing blob */ 7519 spdk_blob_close(blob, bs_iter_close_cpl, ctx); 7520 } 7521 7522 static int 7523 blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 7524 uint16_t value_len, bool internal) 7525 { 7526 struct spdk_xattr_tailq *xattrs; 7527 struct spdk_xattr *xattr; 7528 size_t desc_size; 7529 void *tmp; 7530 7531 blob_verify_md_op(blob); 7532 7533 if (blob->md_ro) { 7534 return -EPERM; 7535 } 7536 7537 desc_size = sizeof(struct spdk_blob_md_descriptor_xattr) + strlen(name) + value_len; 7538 if (desc_size > SPDK_BS_MAX_DESC_SIZE) { 7539 SPDK_DEBUGLOG(blob, "Xattr '%s' of size %zu does not fix into single page %zu\n", name, 7540 desc_size, SPDK_BS_MAX_DESC_SIZE); 7541 return -ENOMEM; 7542 } 7543 7544 if (internal) { 7545 xattrs = &blob->xattrs_internal; 7546 blob->invalid_flags |= SPDK_BLOB_INTERNAL_XATTR; 7547 } else { 7548 xattrs = &blob->xattrs; 7549 } 7550 7551 TAILQ_FOREACH(xattr, xattrs, link) { 7552 if (!strcmp(name, xattr->name)) { 7553 tmp = malloc(value_len); 7554 if (!tmp) { 7555 return -ENOMEM; 7556 } 7557 7558 free(xattr->value); 7559 xattr->value_len = value_len; 7560 xattr->value = tmp; 7561 memcpy(xattr->value, value, value_len); 7562 7563 blob->state = SPDK_BLOB_STATE_DIRTY; 7564 7565 return 0; 7566 } 7567 } 7568 7569 xattr = calloc(1, sizeof(*xattr)); 7570 if (!xattr) { 7571 return -ENOMEM; 7572 } 7573 7574 xattr->name = strdup(name); 7575 if (!xattr->name) { 7576 free(xattr); 7577 return -ENOMEM; 7578 } 7579 7580 xattr->value_len = value_len; 7581 xattr->value = malloc(value_len); 7582 if (!xattr->value) { 7583 free(xattr->name); 7584 free(xattr); 7585 return -ENOMEM; 7586 } 7587 memcpy(xattr->value, value, value_len); 7588 TAILQ_INSERT_TAIL(xattrs, xattr, link); 7589 7590 blob->state = SPDK_BLOB_STATE_DIRTY; 7591 7592 return 0; 7593 } 7594 7595 int 7596 spdk_blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 7597 uint16_t value_len) 7598 { 7599 return blob_set_xattr(blob, name, value, value_len, false); 7600 } 7601 7602 static int 7603 blob_remove_xattr(struct spdk_blob *blob, const char *name, bool internal) 7604 { 7605 struct spdk_xattr_tailq *xattrs; 7606 struct spdk_xattr *xattr; 7607 7608 blob_verify_md_op(blob); 7609 7610 if (blob->md_ro) { 7611 return -EPERM; 7612 } 7613 xattrs = internal ? &blob->xattrs_internal : &blob->xattrs; 7614 7615 TAILQ_FOREACH(xattr, xattrs, link) { 7616 if (!strcmp(name, xattr->name)) { 7617 TAILQ_REMOVE(xattrs, xattr, link); 7618 free(xattr->value); 7619 free(xattr->name); 7620 free(xattr); 7621 7622 if (internal && TAILQ_EMPTY(&blob->xattrs_internal)) { 7623 blob->invalid_flags &= ~SPDK_BLOB_INTERNAL_XATTR; 7624 } 7625 blob->state = SPDK_BLOB_STATE_DIRTY; 7626 7627 return 0; 7628 } 7629 } 7630 7631 return -ENOENT; 7632 } 7633 7634 int 7635 spdk_blob_remove_xattr(struct spdk_blob *blob, const char *name) 7636 { 7637 return blob_remove_xattr(blob, name, false); 7638 } 7639 7640 static int 7641 blob_get_xattr_value(struct spdk_blob *blob, const char *name, 7642 const void **value, size_t *value_len, bool internal) 7643 { 7644 struct spdk_xattr *xattr; 7645 struct spdk_xattr_tailq *xattrs; 7646 7647 xattrs = internal ? &blob->xattrs_internal : &blob->xattrs; 7648 7649 TAILQ_FOREACH(xattr, xattrs, link) { 7650 if (!strcmp(name, xattr->name)) { 7651 *value = xattr->value; 7652 *value_len = xattr->value_len; 7653 return 0; 7654 } 7655 } 7656 return -ENOENT; 7657 } 7658 7659 int 7660 spdk_blob_get_xattr_value(struct spdk_blob *blob, const char *name, 7661 const void **value, size_t *value_len) 7662 { 7663 blob_verify_md_op(blob); 7664 7665 return blob_get_xattr_value(blob, name, value, value_len, false); 7666 } 7667 7668 struct spdk_xattr_names { 7669 uint32_t count; 7670 const char *names[0]; 7671 }; 7672 7673 static int 7674 blob_get_xattr_names(struct spdk_xattr_tailq *xattrs, struct spdk_xattr_names **names) 7675 { 7676 struct spdk_xattr *xattr; 7677 int count = 0; 7678 7679 TAILQ_FOREACH(xattr, xattrs, link) { 7680 count++; 7681 } 7682 7683 *names = calloc(1, sizeof(struct spdk_xattr_names) + count * sizeof(char *)); 7684 if (*names == NULL) { 7685 return -ENOMEM; 7686 } 7687 7688 TAILQ_FOREACH(xattr, xattrs, link) { 7689 (*names)->names[(*names)->count++] = xattr->name; 7690 } 7691 7692 return 0; 7693 } 7694 7695 int 7696 spdk_blob_get_xattr_names(struct spdk_blob *blob, struct spdk_xattr_names **names) 7697 { 7698 blob_verify_md_op(blob); 7699 7700 return blob_get_xattr_names(&blob->xattrs, names); 7701 } 7702 7703 uint32_t 7704 spdk_xattr_names_get_count(struct spdk_xattr_names *names) 7705 { 7706 assert(names != NULL); 7707 7708 return names->count; 7709 } 7710 7711 const char * 7712 spdk_xattr_names_get_name(struct spdk_xattr_names *names, uint32_t index) 7713 { 7714 if (index >= names->count) { 7715 return NULL; 7716 } 7717 7718 return names->names[index]; 7719 } 7720 7721 void 7722 spdk_xattr_names_free(struct spdk_xattr_names *names) 7723 { 7724 free(names); 7725 } 7726 7727 struct spdk_bs_type 7728 spdk_bs_get_bstype(struct spdk_blob_store *bs) 7729 { 7730 return bs->bstype; 7731 } 7732 7733 void 7734 spdk_bs_set_bstype(struct spdk_blob_store *bs, struct spdk_bs_type bstype) 7735 { 7736 memcpy(&bs->bstype, &bstype, sizeof(bstype)); 7737 } 7738 7739 bool 7740 spdk_blob_is_read_only(struct spdk_blob *blob) 7741 { 7742 assert(blob != NULL); 7743 return (blob->data_ro || blob->md_ro); 7744 } 7745 7746 bool 7747 spdk_blob_is_snapshot(struct spdk_blob *blob) 7748 { 7749 struct spdk_blob_list *snapshot_entry; 7750 7751 assert(blob != NULL); 7752 7753 snapshot_entry = bs_get_snapshot_entry(blob->bs, blob->id); 7754 if (snapshot_entry == NULL) { 7755 return false; 7756 } 7757 7758 return true; 7759 } 7760 7761 bool 7762 spdk_blob_is_clone(struct spdk_blob *blob) 7763 { 7764 assert(blob != NULL); 7765 7766 if (blob->parent_id != SPDK_BLOBID_INVALID) { 7767 assert(spdk_blob_is_thin_provisioned(blob)); 7768 return true; 7769 } 7770 7771 return false; 7772 } 7773 7774 bool 7775 spdk_blob_is_thin_provisioned(struct spdk_blob *blob) 7776 { 7777 assert(blob != NULL); 7778 return !!(blob->invalid_flags & SPDK_BLOB_THIN_PROV); 7779 } 7780 7781 static void 7782 blob_update_clear_method(struct spdk_blob *blob) 7783 { 7784 enum blob_clear_method stored_cm; 7785 7786 assert(blob != NULL); 7787 7788 /* If BLOB_CLEAR_WITH_DEFAULT was passed in, use the setting stored 7789 * in metadata previously. If something other than the default was 7790 * specified, ignore stored value and used what was passed in. 7791 */ 7792 stored_cm = ((blob->md_ro_flags & SPDK_BLOB_CLEAR_METHOD) >> SPDK_BLOB_CLEAR_METHOD_SHIFT); 7793 7794 if (blob->clear_method == BLOB_CLEAR_WITH_DEFAULT) { 7795 blob->clear_method = stored_cm; 7796 } else if (blob->clear_method != stored_cm) { 7797 SPDK_WARNLOG("Using passed in clear method 0x%x instead of stored value of 0x%x\n", 7798 blob->clear_method, stored_cm); 7799 } 7800 } 7801 7802 spdk_blob_id 7803 spdk_blob_get_parent_snapshot(struct spdk_blob_store *bs, spdk_blob_id blob_id) 7804 { 7805 struct spdk_blob_list *snapshot_entry = NULL; 7806 struct spdk_blob_list *clone_entry = NULL; 7807 7808 TAILQ_FOREACH(snapshot_entry, &bs->snapshots, link) { 7809 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 7810 if (clone_entry->id == blob_id) { 7811 return snapshot_entry->id; 7812 } 7813 } 7814 } 7815 7816 return SPDK_BLOBID_INVALID; 7817 } 7818 7819 int 7820 spdk_blob_get_clones(struct spdk_blob_store *bs, spdk_blob_id blobid, spdk_blob_id *ids, 7821 size_t *count) 7822 { 7823 struct spdk_blob_list *snapshot_entry, *clone_entry; 7824 size_t n; 7825 7826 snapshot_entry = bs_get_snapshot_entry(bs, blobid); 7827 if (snapshot_entry == NULL) { 7828 *count = 0; 7829 return 0; 7830 } 7831 7832 if (ids == NULL || *count < snapshot_entry->clone_count) { 7833 *count = snapshot_entry->clone_count; 7834 return -ENOMEM; 7835 } 7836 *count = snapshot_entry->clone_count; 7837 7838 n = 0; 7839 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 7840 ids[n++] = clone_entry->id; 7841 } 7842 7843 return 0; 7844 } 7845 7846 SPDK_LOG_REGISTER_COMPONENT(blob) 7847