1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "spdk/stdinc.h" 35 36 #include "spdk/blob.h" 37 #include "spdk/crc32.h" 38 #include "spdk/env.h" 39 #include "spdk/queue.h" 40 #include "spdk/thread.h" 41 #include "spdk/bit_array.h" 42 #include "spdk/likely.h" 43 #include "spdk/util.h" 44 45 #include "spdk_internal/assert.h" 46 #include "spdk_internal/log.h" 47 48 #include "blobstore.h" 49 50 #define BLOB_CRC32C_INITIAL 0xffffffffUL 51 52 static int spdk_bs_register_md_thread(struct spdk_blob_store *bs); 53 static int spdk_bs_unregister_md_thread(struct spdk_blob_store *bs); 54 static void _spdk_blob_close_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno); 55 static void _spdk_blob_insert_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 56 uint64_t cluster, spdk_blob_op_complete cb_fn, void *cb_arg); 57 58 static int _spdk_blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 59 uint16_t value_len, bool internal); 60 static int _spdk_blob_get_xattr_value(struct spdk_blob *blob, const char *name, 61 const void **value, size_t *value_len, bool internal); 62 static int _spdk_blob_remove_xattr(struct spdk_blob *blob, const char *name, bool internal); 63 64 static void 65 _spdk_blob_verify_md_op(struct spdk_blob *blob) 66 { 67 assert(blob != NULL); 68 assert(spdk_get_thread() == blob->bs->md_thread); 69 assert(blob->state != SPDK_BLOB_STATE_LOADING); 70 } 71 72 static struct spdk_blob_list * 73 _spdk_bs_get_snapshot_entry(struct spdk_blob_store *bs, spdk_blob_id blobid) 74 { 75 struct spdk_blob_list *snapshot_entry = NULL; 76 77 TAILQ_FOREACH(snapshot_entry, &bs->snapshots, link) { 78 if (snapshot_entry->id == blobid) { 79 break; 80 } 81 } 82 83 return snapshot_entry; 84 } 85 86 static void 87 _spdk_bs_claim_cluster(struct spdk_blob_store *bs, uint32_t cluster_num) 88 { 89 assert(cluster_num < spdk_bit_array_capacity(bs->used_clusters)); 90 assert(spdk_bit_array_get(bs->used_clusters, cluster_num) == false); 91 assert(bs->num_free_clusters > 0); 92 93 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Claiming cluster %u\n", cluster_num); 94 95 spdk_bit_array_set(bs->used_clusters, cluster_num); 96 bs->num_free_clusters--; 97 } 98 99 static int 100 _spdk_blob_insert_cluster(struct spdk_blob *blob, uint32_t cluster_num, uint64_t cluster) 101 { 102 uint64_t *cluster_lba = &blob->active.clusters[cluster_num]; 103 104 _spdk_blob_verify_md_op(blob); 105 106 if (*cluster_lba != 0) { 107 return -EEXIST; 108 } 109 110 *cluster_lba = _spdk_bs_cluster_to_lba(blob->bs, cluster); 111 return 0; 112 } 113 114 static int 115 _spdk_bs_allocate_cluster(struct spdk_blob *blob, uint32_t cluster_num, 116 uint64_t *lowest_free_cluster, bool update_map) 117 { 118 pthread_mutex_lock(&blob->bs->used_clusters_mutex); 119 *lowest_free_cluster = spdk_bit_array_find_first_clear(blob->bs->used_clusters, 120 *lowest_free_cluster); 121 if (*lowest_free_cluster == UINT32_MAX) { 122 /* No more free clusters. Cannot satisfy the request */ 123 pthread_mutex_unlock(&blob->bs->used_clusters_mutex); 124 return -ENOSPC; 125 } 126 127 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Claiming cluster %lu for blob %lu\n", *lowest_free_cluster, blob->id); 128 _spdk_bs_claim_cluster(blob->bs, *lowest_free_cluster); 129 pthread_mutex_unlock(&blob->bs->used_clusters_mutex); 130 131 if (update_map) { 132 _spdk_blob_insert_cluster(blob, cluster_num, *lowest_free_cluster); 133 } 134 135 return 0; 136 } 137 138 static void 139 _spdk_bs_release_cluster(struct spdk_blob_store *bs, uint32_t cluster_num) 140 { 141 assert(cluster_num < spdk_bit_array_capacity(bs->used_clusters)); 142 assert(spdk_bit_array_get(bs->used_clusters, cluster_num) == true); 143 assert(bs->num_free_clusters < bs->total_clusters); 144 145 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Releasing cluster %u\n", cluster_num); 146 147 pthread_mutex_lock(&bs->used_clusters_mutex); 148 spdk_bit_array_clear(bs->used_clusters, cluster_num); 149 bs->num_free_clusters++; 150 pthread_mutex_unlock(&bs->used_clusters_mutex); 151 } 152 153 static void 154 _spdk_blob_xattrs_init(struct spdk_blob_xattr_opts *xattrs) 155 { 156 xattrs->count = 0; 157 xattrs->names = NULL; 158 xattrs->ctx = NULL; 159 xattrs->get_value = NULL; 160 } 161 162 void 163 spdk_blob_opts_init(struct spdk_blob_opts *opts) 164 { 165 opts->num_clusters = 0; 166 opts->thin_provision = false; 167 _spdk_blob_xattrs_init(&opts->xattrs); 168 } 169 170 void 171 spdk_blob_open_opts_init(struct spdk_blob_open_opts *opts) 172 { 173 opts->clear_method = BLOB_CLEAR_WITH_UNMAP; 174 } 175 176 static struct spdk_blob * 177 _spdk_blob_alloc(struct spdk_blob_store *bs, spdk_blob_id id) 178 { 179 struct spdk_blob *blob; 180 181 blob = calloc(1, sizeof(*blob)); 182 if (!blob) { 183 return NULL; 184 } 185 186 blob->id = id; 187 blob->bs = bs; 188 189 blob->parent_id = SPDK_BLOBID_INVALID; 190 191 blob->state = SPDK_BLOB_STATE_DIRTY; 192 blob->active.num_pages = 1; 193 blob->active.pages = calloc(1, sizeof(*blob->active.pages)); 194 if (!blob->active.pages) { 195 free(blob); 196 return NULL; 197 } 198 199 blob->active.pages[0] = _spdk_bs_blobid_to_page(id); 200 201 TAILQ_INIT(&blob->xattrs); 202 TAILQ_INIT(&blob->xattrs_internal); 203 204 return blob; 205 } 206 207 static void 208 _spdk_xattrs_free(struct spdk_xattr_tailq *xattrs) 209 { 210 struct spdk_xattr *xattr, *xattr_tmp; 211 212 TAILQ_FOREACH_SAFE(xattr, xattrs, link, xattr_tmp) { 213 TAILQ_REMOVE(xattrs, xattr, link); 214 free(xattr->name); 215 free(xattr->value); 216 free(xattr); 217 } 218 } 219 220 static void 221 _spdk_blob_free(struct spdk_blob *blob) 222 { 223 assert(blob != NULL); 224 225 free(blob->active.clusters); 226 free(blob->clean.clusters); 227 free(blob->active.pages); 228 free(blob->clean.pages); 229 230 _spdk_xattrs_free(&blob->xattrs); 231 _spdk_xattrs_free(&blob->xattrs_internal); 232 233 if (blob->back_bs_dev) { 234 blob->back_bs_dev->destroy(blob->back_bs_dev); 235 } 236 237 free(blob); 238 } 239 240 struct freeze_io_ctx { 241 struct spdk_bs_cpl cpl; 242 struct spdk_blob *blob; 243 }; 244 245 static void 246 _spdk_blob_io_sync(struct spdk_io_channel_iter *i) 247 { 248 spdk_for_each_channel_continue(i, 0); 249 } 250 251 static void 252 _spdk_blob_execute_queued_io(struct spdk_io_channel_iter *i) 253 { 254 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 255 struct spdk_bs_channel *ch = spdk_io_channel_get_ctx(_ch); 256 struct freeze_io_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 257 struct spdk_bs_request_set *set; 258 struct spdk_bs_user_op_args *args; 259 spdk_bs_user_op_t *op, *tmp; 260 261 TAILQ_FOREACH_SAFE(op, &ch->queued_io, link, tmp) { 262 set = (struct spdk_bs_request_set *)op; 263 args = &set->u.user_op; 264 265 if (args->blob == ctx->blob) { 266 TAILQ_REMOVE(&ch->queued_io, op, link); 267 spdk_bs_user_op_execute(op); 268 } 269 } 270 271 spdk_for_each_channel_continue(i, 0); 272 } 273 274 static void 275 _spdk_blob_io_cpl(struct spdk_io_channel_iter *i, int status) 276 { 277 struct freeze_io_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 278 279 ctx->cpl.u.blob_basic.cb_fn(ctx->cpl.u.blob_basic.cb_arg, 0); 280 281 free(ctx); 282 } 283 284 static void 285 _spdk_blob_freeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 286 { 287 struct freeze_io_ctx *ctx; 288 289 ctx = calloc(1, sizeof(*ctx)); 290 if (!ctx) { 291 cb_fn(cb_arg, -ENOMEM); 292 return; 293 } 294 295 ctx->cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 296 ctx->cpl.u.blob_basic.cb_fn = cb_fn; 297 ctx->cpl.u.blob_basic.cb_arg = cb_arg; 298 ctx->blob = blob; 299 300 /* Freeze I/O on blob */ 301 blob->frozen_refcnt++; 302 303 if (blob->frozen_refcnt == 1) { 304 spdk_for_each_channel(blob->bs, _spdk_blob_io_sync, ctx, _spdk_blob_io_cpl); 305 } else { 306 cb_fn(cb_arg, 0); 307 free(ctx); 308 } 309 } 310 311 static void 312 _spdk_blob_unfreeze_io(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 313 { 314 struct freeze_io_ctx *ctx; 315 316 ctx = calloc(1, sizeof(*ctx)); 317 if (!ctx) { 318 cb_fn(cb_arg, -ENOMEM); 319 return; 320 } 321 322 ctx->cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 323 ctx->cpl.u.blob_basic.cb_fn = cb_fn; 324 ctx->cpl.u.blob_basic.cb_arg = cb_arg; 325 ctx->blob = blob; 326 327 assert(blob->frozen_refcnt > 0); 328 329 blob->frozen_refcnt--; 330 331 if (blob->frozen_refcnt == 0) { 332 spdk_for_each_channel(blob->bs, _spdk_blob_execute_queued_io, ctx, _spdk_blob_io_cpl); 333 } else { 334 cb_fn(cb_arg, 0); 335 free(ctx); 336 } 337 } 338 339 static int 340 _spdk_blob_mark_clean(struct spdk_blob *blob) 341 { 342 uint64_t *clusters = NULL; 343 uint32_t *pages = NULL; 344 345 assert(blob != NULL); 346 347 if (blob->active.num_clusters) { 348 assert(blob->active.clusters); 349 clusters = calloc(blob->active.num_clusters, sizeof(*blob->active.clusters)); 350 if (!clusters) { 351 return -ENOMEM; 352 } 353 memcpy(clusters, blob->active.clusters, blob->active.num_clusters * sizeof(*clusters)); 354 } 355 356 if (blob->active.num_pages) { 357 assert(blob->active.pages); 358 pages = calloc(blob->active.num_pages, sizeof(*blob->active.pages)); 359 if (!pages) { 360 free(clusters); 361 return -ENOMEM; 362 } 363 memcpy(pages, blob->active.pages, blob->active.num_pages * sizeof(*pages)); 364 } 365 366 free(blob->clean.clusters); 367 free(blob->clean.pages); 368 369 blob->clean.num_clusters = blob->active.num_clusters; 370 blob->clean.clusters = blob->active.clusters; 371 blob->clean.num_pages = blob->active.num_pages; 372 blob->clean.pages = blob->active.pages; 373 374 blob->active.clusters = clusters; 375 blob->active.pages = pages; 376 377 /* If the metadata was dirtied again while the metadata was being written to disk, 378 * we do not want to revert the DIRTY state back to CLEAN here. 379 */ 380 if (blob->state == SPDK_BLOB_STATE_LOADING) { 381 blob->state = SPDK_BLOB_STATE_CLEAN; 382 } 383 384 return 0; 385 } 386 387 static int 388 _spdk_blob_deserialize_xattr(struct spdk_blob *blob, 389 struct spdk_blob_md_descriptor_xattr *desc_xattr, bool internal) 390 { 391 struct spdk_xattr *xattr; 392 393 if (desc_xattr->length != sizeof(desc_xattr->name_length) + 394 sizeof(desc_xattr->value_length) + 395 desc_xattr->name_length + desc_xattr->value_length) { 396 return -EINVAL; 397 } 398 399 xattr = calloc(1, sizeof(*xattr)); 400 if (xattr == NULL) { 401 return -ENOMEM; 402 } 403 404 xattr->name = malloc(desc_xattr->name_length + 1); 405 if (xattr->name == NULL) { 406 free(xattr); 407 return -ENOMEM; 408 } 409 memcpy(xattr->name, desc_xattr->name, desc_xattr->name_length); 410 xattr->name[desc_xattr->name_length] = '\0'; 411 412 xattr->value = malloc(desc_xattr->value_length); 413 if (xattr->value == NULL) { 414 free(xattr->name); 415 free(xattr); 416 return -ENOMEM; 417 } 418 xattr->value_len = desc_xattr->value_length; 419 memcpy(xattr->value, 420 (void *)((uintptr_t)desc_xattr->name + desc_xattr->name_length), 421 desc_xattr->value_length); 422 423 TAILQ_INSERT_TAIL(internal ? &blob->xattrs_internal : &blob->xattrs, xattr, link); 424 425 return 0; 426 } 427 428 429 static int 430 _spdk_blob_parse_page(const struct spdk_blob_md_page *page, struct spdk_blob *blob) 431 { 432 struct spdk_blob_md_descriptor *desc; 433 size_t cur_desc = 0; 434 void *tmp; 435 436 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 437 while (cur_desc < sizeof(page->descriptors)) { 438 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 439 if (desc->length == 0) { 440 /* If padding and length are 0, this terminates the page */ 441 break; 442 } 443 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 444 struct spdk_blob_md_descriptor_flags *desc_flags; 445 446 desc_flags = (struct spdk_blob_md_descriptor_flags *)desc; 447 448 if (desc_flags->length != sizeof(*desc_flags) - sizeof(*desc)) { 449 return -EINVAL; 450 } 451 452 if ((desc_flags->invalid_flags | SPDK_BLOB_INVALID_FLAGS_MASK) != 453 SPDK_BLOB_INVALID_FLAGS_MASK) { 454 return -EINVAL; 455 } 456 457 if ((desc_flags->data_ro_flags | SPDK_BLOB_DATA_RO_FLAGS_MASK) != 458 SPDK_BLOB_DATA_RO_FLAGS_MASK) { 459 blob->data_ro = true; 460 blob->md_ro = true; 461 } 462 463 if ((desc_flags->md_ro_flags | SPDK_BLOB_MD_RO_FLAGS_MASK) != 464 SPDK_BLOB_MD_RO_FLAGS_MASK) { 465 blob->md_ro = true; 466 } 467 468 if ((desc_flags->data_ro_flags & SPDK_BLOB_READ_ONLY)) { 469 blob->data_ro = true; 470 blob->md_ro = true; 471 } 472 473 blob->invalid_flags = desc_flags->invalid_flags; 474 blob->data_ro_flags = desc_flags->data_ro_flags; 475 blob->md_ro_flags = desc_flags->md_ro_flags; 476 477 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT) { 478 struct spdk_blob_md_descriptor_extent *desc_extent; 479 unsigned int i, j; 480 unsigned int cluster_count = blob->active.num_clusters; 481 482 desc_extent = (struct spdk_blob_md_descriptor_extent *)desc; 483 484 if (desc_extent->length == 0 || 485 (desc_extent->length % sizeof(desc_extent->extents[0]) != 0)) { 486 return -EINVAL; 487 } 488 489 for (i = 0; i < desc_extent->length / sizeof(desc_extent->extents[0]); i++) { 490 for (j = 0; j < desc_extent->extents[i].length; j++) { 491 if (desc_extent->extents[i].cluster_idx != 0) { 492 if (!spdk_bit_array_get(blob->bs->used_clusters, 493 desc_extent->extents[i].cluster_idx + j)) { 494 return -EINVAL; 495 } 496 } 497 cluster_count++; 498 } 499 } 500 501 if (cluster_count == 0) { 502 return -EINVAL; 503 } 504 tmp = realloc(blob->active.clusters, cluster_count * sizeof(uint64_t)); 505 if (tmp == NULL) { 506 return -ENOMEM; 507 } 508 blob->active.clusters = tmp; 509 blob->active.cluster_array_size = cluster_count; 510 511 for (i = 0; i < desc_extent->length / sizeof(desc_extent->extents[0]); i++) { 512 for (j = 0; j < desc_extent->extents[i].length; j++) { 513 if (desc_extent->extents[i].cluster_idx != 0) { 514 blob->active.clusters[blob->active.num_clusters++] = _spdk_bs_cluster_to_lba(blob->bs, 515 desc_extent->extents[i].cluster_idx + j); 516 } else if (spdk_blob_is_thin_provisioned(blob)) { 517 blob->active.clusters[blob->active.num_clusters++] = 0; 518 } else { 519 return -EINVAL; 520 } 521 } 522 } 523 524 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 525 int rc; 526 527 rc = _spdk_blob_deserialize_xattr(blob, 528 (struct spdk_blob_md_descriptor_xattr *) desc, false); 529 if (rc != 0) { 530 return rc; 531 } 532 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 533 int rc; 534 535 rc = _spdk_blob_deserialize_xattr(blob, 536 (struct spdk_blob_md_descriptor_xattr *) desc, true); 537 if (rc != 0) { 538 return rc; 539 } 540 } else { 541 /* Unrecognized descriptor type. Do not fail - just continue to the 542 * next descriptor. If this descriptor is associated with some feature 543 * defined in a newer version of blobstore, that version of blobstore 544 * should create and set an associated feature flag to specify if this 545 * blob can be loaded or not. 546 */ 547 } 548 549 /* Advance to the next descriptor */ 550 cur_desc += sizeof(*desc) + desc->length; 551 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 552 break; 553 } 554 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 555 } 556 557 return 0; 558 } 559 560 static int 561 _spdk_blob_parse(const struct spdk_blob_md_page *pages, uint32_t page_count, 562 struct spdk_blob *blob) 563 { 564 const struct spdk_blob_md_page *page; 565 uint32_t i; 566 int rc; 567 568 assert(page_count > 0); 569 assert(pages[0].sequence_num == 0); 570 assert(blob != NULL); 571 assert(blob->state == SPDK_BLOB_STATE_LOADING); 572 assert(blob->active.clusters == NULL); 573 574 /* The blobid provided doesn't match what's in the MD, this can 575 * happen for example if a bogus blobid is passed in through open. 576 */ 577 if (blob->id != pages[0].id) { 578 SPDK_ERRLOG("Blobid (%lu) doesn't match what's in metadata (%lu)\n", 579 blob->id, pages[0].id); 580 return -ENOENT; 581 } 582 583 for (i = 0; i < page_count; i++) { 584 page = &pages[i]; 585 586 assert(page->id == blob->id); 587 assert(page->sequence_num == i); 588 589 rc = _spdk_blob_parse_page(page, blob); 590 if (rc != 0) { 591 return rc; 592 } 593 } 594 595 return 0; 596 } 597 598 static int 599 _spdk_blob_serialize_add_page(const struct spdk_blob *blob, 600 struct spdk_blob_md_page **pages, 601 uint32_t *page_count, 602 struct spdk_blob_md_page **last_page) 603 { 604 struct spdk_blob_md_page *page; 605 606 assert(pages != NULL); 607 assert(page_count != NULL); 608 609 if (*page_count == 0) { 610 assert(*pages == NULL); 611 *page_count = 1; 612 *pages = spdk_malloc(SPDK_BS_PAGE_SIZE, SPDK_BS_PAGE_SIZE, 613 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 614 } else { 615 assert(*pages != NULL); 616 (*page_count)++; 617 *pages = spdk_realloc(*pages, 618 SPDK_BS_PAGE_SIZE * (*page_count), 619 SPDK_BS_PAGE_SIZE); 620 } 621 622 if (*pages == NULL) { 623 *page_count = 0; 624 *last_page = NULL; 625 return -ENOMEM; 626 } 627 628 page = &(*pages)[*page_count - 1]; 629 memset(page, 0, sizeof(*page)); 630 page->id = blob->id; 631 page->sequence_num = *page_count - 1; 632 page->next = SPDK_INVALID_MD_PAGE; 633 *last_page = page; 634 635 return 0; 636 } 637 638 /* Transform the in-memory representation 'xattr' into an on-disk xattr descriptor. 639 * Update required_sz on both success and failure. 640 * 641 */ 642 static int 643 _spdk_blob_serialize_xattr(const struct spdk_xattr *xattr, 644 uint8_t *buf, size_t buf_sz, 645 size_t *required_sz, bool internal) 646 { 647 struct spdk_blob_md_descriptor_xattr *desc; 648 649 *required_sz = sizeof(struct spdk_blob_md_descriptor_xattr) + 650 strlen(xattr->name) + 651 xattr->value_len; 652 653 if (buf_sz < *required_sz) { 654 return -1; 655 } 656 657 desc = (struct spdk_blob_md_descriptor_xattr *)buf; 658 659 desc->type = internal ? SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL : SPDK_MD_DESCRIPTOR_TYPE_XATTR; 660 desc->length = sizeof(desc->name_length) + 661 sizeof(desc->value_length) + 662 strlen(xattr->name) + 663 xattr->value_len; 664 desc->name_length = strlen(xattr->name); 665 desc->value_length = xattr->value_len; 666 667 memcpy(desc->name, xattr->name, desc->name_length); 668 memcpy((void *)((uintptr_t)desc->name + desc->name_length), 669 xattr->value, 670 desc->value_length); 671 672 return 0; 673 } 674 675 static void 676 _spdk_blob_serialize_extent(const struct spdk_blob *blob, 677 uint64_t start_cluster, uint64_t *next_cluster, 678 uint8_t *buf, size_t buf_sz) 679 { 680 struct spdk_blob_md_descriptor_extent *desc; 681 size_t cur_sz; 682 uint64_t i, extent_idx; 683 uint64_t lba, lba_per_cluster, lba_count; 684 685 /* The buffer must have room for at least one extent */ 686 cur_sz = sizeof(struct spdk_blob_md_descriptor) + sizeof(desc->extents[0]); 687 if (buf_sz < cur_sz) { 688 *next_cluster = start_cluster; 689 return; 690 } 691 692 desc = (struct spdk_blob_md_descriptor_extent *)buf; 693 desc->type = SPDK_MD_DESCRIPTOR_TYPE_EXTENT; 694 695 lba_per_cluster = _spdk_bs_cluster_to_lba(blob->bs, 1); 696 697 lba = blob->active.clusters[start_cluster]; 698 lba_count = lba_per_cluster; 699 extent_idx = 0; 700 for (i = start_cluster + 1; i < blob->active.num_clusters; i++) { 701 if ((lba + lba_count) == blob->active.clusters[i]) { 702 lba_count += lba_per_cluster; 703 continue; 704 } else if (lba == 0 && blob->active.clusters[i] == 0) { 705 lba_count += lba_per_cluster; 706 continue; 707 } 708 desc->extents[extent_idx].cluster_idx = lba / lba_per_cluster; 709 desc->extents[extent_idx].length = lba_count / lba_per_cluster; 710 extent_idx++; 711 712 cur_sz += sizeof(desc->extents[extent_idx]); 713 714 if (buf_sz < cur_sz) { 715 /* If we ran out of buffer space, return */ 716 desc->length = sizeof(desc->extents[0]) * extent_idx; 717 *next_cluster = i; 718 return; 719 } 720 721 lba = blob->active.clusters[i]; 722 lba_count = lba_per_cluster; 723 } 724 725 desc->extents[extent_idx].cluster_idx = lba / lba_per_cluster; 726 desc->extents[extent_idx].length = lba_count / lba_per_cluster; 727 extent_idx++; 728 729 desc->length = sizeof(desc->extents[0]) * extent_idx; 730 *next_cluster = blob->active.num_clusters; 731 732 return; 733 } 734 735 static void 736 _spdk_blob_serialize_flags(const struct spdk_blob *blob, 737 uint8_t *buf, size_t *buf_sz) 738 { 739 struct spdk_blob_md_descriptor_flags *desc; 740 741 /* 742 * Flags get serialized first, so we should always have room for the flags 743 * descriptor. 744 */ 745 assert(*buf_sz >= sizeof(*desc)); 746 747 desc = (struct spdk_blob_md_descriptor_flags *)buf; 748 desc->type = SPDK_MD_DESCRIPTOR_TYPE_FLAGS; 749 desc->length = sizeof(*desc) - sizeof(struct spdk_blob_md_descriptor); 750 desc->invalid_flags = blob->invalid_flags; 751 desc->data_ro_flags = blob->data_ro_flags; 752 desc->md_ro_flags = blob->md_ro_flags; 753 754 *buf_sz -= sizeof(*desc); 755 } 756 757 static int 758 _spdk_blob_serialize_xattrs(const struct spdk_blob *blob, 759 const struct spdk_xattr_tailq *xattrs, bool internal, 760 struct spdk_blob_md_page **pages, 761 struct spdk_blob_md_page *cur_page, 762 uint32_t *page_count, uint8_t **buf, 763 size_t *remaining_sz) 764 { 765 const struct spdk_xattr *xattr; 766 int rc; 767 768 TAILQ_FOREACH(xattr, xattrs, link) { 769 size_t required_sz = 0; 770 771 rc = _spdk_blob_serialize_xattr(xattr, 772 *buf, *remaining_sz, 773 &required_sz, internal); 774 if (rc < 0) { 775 /* Need to add a new page to the chain */ 776 rc = _spdk_blob_serialize_add_page(blob, pages, page_count, 777 &cur_page); 778 if (rc < 0) { 779 spdk_free(*pages); 780 *pages = NULL; 781 *page_count = 0; 782 return rc; 783 } 784 785 *buf = (uint8_t *)cur_page->descriptors; 786 *remaining_sz = sizeof(cur_page->descriptors); 787 788 /* Try again */ 789 required_sz = 0; 790 rc = _spdk_blob_serialize_xattr(xattr, 791 *buf, *remaining_sz, 792 &required_sz, internal); 793 794 if (rc < 0) { 795 spdk_free(*pages); 796 *pages = NULL; 797 *page_count = 0; 798 return rc; 799 } 800 } 801 802 *remaining_sz -= required_sz; 803 *buf += required_sz; 804 } 805 806 return 0; 807 } 808 809 static int 810 _spdk_blob_serialize(const struct spdk_blob *blob, struct spdk_blob_md_page **pages, 811 uint32_t *page_count) 812 { 813 struct spdk_blob_md_page *cur_page; 814 int rc; 815 uint8_t *buf; 816 size_t remaining_sz; 817 uint64_t last_cluster; 818 819 assert(pages != NULL); 820 assert(page_count != NULL); 821 assert(blob != NULL); 822 assert(blob->state == SPDK_BLOB_STATE_DIRTY); 823 824 *pages = NULL; 825 *page_count = 0; 826 827 /* A blob always has at least 1 page, even if it has no descriptors */ 828 rc = _spdk_blob_serialize_add_page(blob, pages, page_count, &cur_page); 829 if (rc < 0) { 830 return rc; 831 } 832 833 buf = (uint8_t *)cur_page->descriptors; 834 remaining_sz = sizeof(cur_page->descriptors); 835 836 /* Serialize flags */ 837 _spdk_blob_serialize_flags(blob, buf, &remaining_sz); 838 buf += sizeof(struct spdk_blob_md_descriptor_flags); 839 840 /* Serialize xattrs */ 841 rc = _spdk_blob_serialize_xattrs(blob, &blob->xattrs, false, 842 pages, cur_page, page_count, &buf, &remaining_sz); 843 if (rc < 0) { 844 return rc; 845 } 846 847 /* Serialize internal xattrs */ 848 rc = _spdk_blob_serialize_xattrs(blob, &blob->xattrs_internal, true, 849 pages, cur_page, page_count, &buf, &remaining_sz); 850 if (rc < 0) { 851 return rc; 852 } 853 854 /* Serialize extents */ 855 last_cluster = 0; 856 while (last_cluster < blob->active.num_clusters) { 857 _spdk_blob_serialize_extent(blob, last_cluster, &last_cluster, 858 buf, remaining_sz); 859 860 if (last_cluster == blob->active.num_clusters) { 861 break; 862 } 863 864 rc = _spdk_blob_serialize_add_page(blob, pages, page_count, 865 &cur_page); 866 if (rc < 0) { 867 return rc; 868 } 869 870 buf = (uint8_t *)cur_page->descriptors; 871 remaining_sz = sizeof(cur_page->descriptors); 872 } 873 874 return 0; 875 } 876 877 struct spdk_blob_load_ctx { 878 struct spdk_blob *blob; 879 880 struct spdk_blob_md_page *pages; 881 uint32_t num_pages; 882 spdk_bs_sequence_t *seq; 883 884 spdk_bs_sequence_cpl cb_fn; 885 void *cb_arg; 886 }; 887 888 static uint32_t 889 _spdk_blob_md_page_calc_crc(void *page) 890 { 891 uint32_t crc; 892 893 crc = BLOB_CRC32C_INITIAL; 894 crc = spdk_crc32c_update(page, SPDK_BS_PAGE_SIZE - 4, crc); 895 crc ^= BLOB_CRC32C_INITIAL; 896 897 return crc; 898 899 } 900 901 static void 902 _spdk_blob_load_final(void *cb_arg, int bserrno) 903 { 904 struct spdk_blob_load_ctx *ctx = cb_arg; 905 struct spdk_blob *blob = ctx->blob; 906 907 _spdk_blob_mark_clean(blob); 908 909 ctx->cb_fn(ctx->seq, ctx->cb_arg, bserrno); 910 911 /* Free the memory */ 912 spdk_free(ctx->pages); 913 free(ctx); 914 } 915 916 static void 917 _spdk_blob_load_snapshot_cpl(void *cb_arg, struct spdk_blob *snapshot, int bserrno) 918 { 919 struct spdk_blob_load_ctx *ctx = cb_arg; 920 struct spdk_blob *blob = ctx->blob; 921 922 if (bserrno != 0) { 923 goto error; 924 } 925 926 blob->back_bs_dev = spdk_bs_create_blob_bs_dev(snapshot); 927 928 if (blob->back_bs_dev == NULL) { 929 bserrno = -ENOMEM; 930 goto error; 931 } 932 933 _spdk_blob_load_final(ctx, bserrno); 934 return; 935 936 error: 937 SPDK_ERRLOG("Snapshot fail\n"); 938 _spdk_blob_free(blob); 939 ctx->cb_fn(ctx->seq, NULL, bserrno); 940 spdk_free(ctx->pages); 941 free(ctx); 942 } 943 944 static void 945 _spdk_blob_load_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 946 { 947 struct spdk_blob_load_ctx *ctx = cb_arg; 948 struct spdk_blob *blob = ctx->blob; 949 struct spdk_blob_md_page *page; 950 const void *value; 951 size_t len; 952 int rc; 953 uint32_t crc; 954 955 if (bserrno) { 956 SPDK_ERRLOG("Metadata page read failed: %d\n", bserrno); 957 _spdk_blob_free(blob); 958 ctx->cb_fn(seq, NULL, bserrno); 959 spdk_free(ctx->pages); 960 free(ctx); 961 return; 962 } 963 964 page = &ctx->pages[ctx->num_pages - 1]; 965 crc = _spdk_blob_md_page_calc_crc(page); 966 if (crc != page->crc) { 967 SPDK_ERRLOG("Metadata page %d crc mismatch\n", ctx->num_pages); 968 _spdk_blob_free(blob); 969 ctx->cb_fn(seq, NULL, -EINVAL); 970 spdk_free(ctx->pages); 971 free(ctx); 972 return; 973 } 974 975 if (page->next != SPDK_INVALID_MD_PAGE) { 976 uint32_t next_page = page->next; 977 uint64_t next_lba = _spdk_bs_page_to_lba(blob->bs, blob->bs->md_start + next_page); 978 uint64_t max_md_lba = _spdk_bs_page_to_lba(blob->bs, blob->bs->md_start + blob->bs->md_len); 979 980 assert(next_lba < max_md_lba); 981 982 /* Read the next page */ 983 ctx->num_pages++; 984 ctx->pages = spdk_realloc(ctx->pages, (sizeof(*page) * ctx->num_pages), 985 sizeof(*page)); 986 if (ctx->pages == NULL) { 987 ctx->cb_fn(seq, ctx->cb_arg, -ENOMEM); 988 free(ctx); 989 return; 990 } 991 992 spdk_bs_sequence_read_dev(seq, &ctx->pages[ctx->num_pages - 1], 993 next_lba, 994 _spdk_bs_byte_to_lba(blob->bs, sizeof(*page)), 995 _spdk_blob_load_cpl, ctx); 996 return; 997 } 998 999 /* Parse the pages */ 1000 rc = _spdk_blob_parse(ctx->pages, ctx->num_pages, blob); 1001 if (rc) { 1002 _spdk_blob_free(blob); 1003 ctx->cb_fn(seq, NULL, rc); 1004 spdk_free(ctx->pages); 1005 free(ctx); 1006 return; 1007 } 1008 ctx->seq = seq; 1009 1010 1011 if (spdk_blob_is_thin_provisioned(blob)) { 1012 rc = _spdk_blob_get_xattr_value(blob, BLOB_SNAPSHOT, &value, &len, true); 1013 if (rc == 0) { 1014 if (len != sizeof(spdk_blob_id)) { 1015 _spdk_blob_free(blob); 1016 ctx->cb_fn(seq, NULL, -EINVAL); 1017 spdk_free(ctx->pages); 1018 free(ctx); 1019 return; 1020 } 1021 /* open snapshot blob and continue in the callback function */ 1022 blob->parent_id = *(spdk_blob_id *)value; 1023 spdk_bs_open_blob(blob->bs, blob->parent_id, 1024 _spdk_blob_load_snapshot_cpl, ctx); 1025 return; 1026 } else { 1027 /* add zeroes_dev for thin provisioned blob */ 1028 blob->back_bs_dev = spdk_bs_create_zeroes_dev(); 1029 } 1030 } else { 1031 /* standard blob */ 1032 blob->back_bs_dev = NULL; 1033 } 1034 _spdk_blob_load_final(ctx, bserrno); 1035 } 1036 1037 /* Load a blob from disk given a blobid */ 1038 static void 1039 _spdk_blob_load(spdk_bs_sequence_t *seq, struct spdk_blob *blob, 1040 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 1041 { 1042 struct spdk_blob_load_ctx *ctx; 1043 struct spdk_blob_store *bs; 1044 uint32_t page_num; 1045 uint64_t lba; 1046 1047 _spdk_blob_verify_md_op(blob); 1048 1049 bs = blob->bs; 1050 1051 ctx = calloc(1, sizeof(*ctx)); 1052 if (!ctx) { 1053 cb_fn(seq, cb_arg, -ENOMEM); 1054 return; 1055 } 1056 1057 ctx->blob = blob; 1058 ctx->pages = spdk_realloc(ctx->pages, SPDK_BS_PAGE_SIZE, SPDK_BS_PAGE_SIZE); 1059 if (!ctx->pages) { 1060 free(ctx); 1061 cb_fn(seq, cb_arg, -ENOMEM); 1062 return; 1063 } 1064 ctx->num_pages = 1; 1065 ctx->cb_fn = cb_fn; 1066 ctx->cb_arg = cb_arg; 1067 1068 page_num = _spdk_bs_blobid_to_page(blob->id); 1069 lba = _spdk_bs_page_to_lba(blob->bs, bs->md_start + page_num); 1070 1071 blob->state = SPDK_BLOB_STATE_LOADING; 1072 1073 spdk_bs_sequence_read_dev(seq, &ctx->pages[0], lba, 1074 _spdk_bs_byte_to_lba(bs, SPDK_BS_PAGE_SIZE), 1075 _spdk_blob_load_cpl, ctx); 1076 } 1077 1078 struct spdk_blob_persist_ctx { 1079 struct spdk_blob *blob; 1080 1081 struct spdk_bs_super_block *super; 1082 1083 struct spdk_blob_md_page *pages; 1084 1085 uint64_t idx; 1086 1087 spdk_bs_sequence_t *seq; 1088 spdk_bs_sequence_cpl cb_fn; 1089 void *cb_arg; 1090 }; 1091 1092 static void 1093 spdk_bs_batch_clear_dev(struct spdk_blob_persist_ctx *ctx, spdk_bs_batch_t *batch, uint64_t lba, 1094 uint32_t lba_count) 1095 { 1096 if (ctx->blob->clear_method == BLOB_CLEAR_WITH_DEFAULT || 1097 ctx->blob->clear_method == BLOB_CLEAR_WITH_UNMAP) { 1098 spdk_bs_batch_unmap_dev(batch, lba, lba_count); 1099 } else if (ctx->blob->clear_method == BLOB_CLEAR_WITH_WRITE_ZEROES) { 1100 spdk_bs_batch_write_zeroes_dev(batch, lba, lba_count); 1101 } 1102 } 1103 1104 static void 1105 _spdk_blob_persist_complete(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1106 { 1107 struct spdk_blob_persist_ctx *ctx = cb_arg; 1108 struct spdk_blob *blob = ctx->blob; 1109 1110 if (bserrno == 0) { 1111 _spdk_blob_mark_clean(blob); 1112 } 1113 1114 /* Call user callback */ 1115 ctx->cb_fn(seq, ctx->cb_arg, bserrno); 1116 1117 /* Free the memory */ 1118 spdk_free(ctx->pages); 1119 free(ctx); 1120 } 1121 1122 static void 1123 _spdk_blob_persist_clear_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1124 { 1125 struct spdk_blob_persist_ctx *ctx = cb_arg; 1126 struct spdk_blob *blob = ctx->blob; 1127 struct spdk_blob_store *bs = blob->bs; 1128 void *tmp; 1129 size_t i; 1130 1131 /* Release all clusters that were truncated */ 1132 for (i = blob->active.num_clusters; i < blob->active.cluster_array_size; i++) { 1133 uint32_t cluster_num = _spdk_bs_lba_to_cluster(bs, blob->active.clusters[i]); 1134 1135 /* Nothing to release if it was not allocated */ 1136 if (blob->active.clusters[i] != 0) { 1137 _spdk_bs_release_cluster(bs, cluster_num); 1138 } 1139 } 1140 1141 if (blob->active.num_clusters == 0) { 1142 free(blob->active.clusters); 1143 blob->active.clusters = NULL; 1144 blob->active.cluster_array_size = 0; 1145 } else if (blob->active.num_clusters != blob->active.cluster_array_size) { 1146 tmp = realloc(blob->active.clusters, sizeof(uint64_t) * blob->active.num_clusters); 1147 assert(tmp != NULL); 1148 blob->active.clusters = tmp; 1149 blob->active.cluster_array_size = blob->active.num_clusters; 1150 } 1151 1152 _spdk_blob_persist_complete(seq, ctx, bserrno); 1153 } 1154 1155 static void 1156 _spdk_blob_persist_clear_clusters(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1157 { 1158 struct spdk_blob_persist_ctx *ctx = cb_arg; 1159 struct spdk_blob *blob = ctx->blob; 1160 struct spdk_blob_store *bs = blob->bs; 1161 spdk_bs_batch_t *batch; 1162 size_t i; 1163 uint64_t lba; 1164 uint32_t lba_count; 1165 1166 /* Clusters don't move around in blobs. The list shrinks or grows 1167 * at the end, but no changes ever occur in the middle of the list. 1168 */ 1169 1170 batch = spdk_bs_sequence_to_batch(seq, _spdk_blob_persist_clear_clusters_cpl, ctx); 1171 1172 /* Clear all clusters that were truncated */ 1173 lba = 0; 1174 lba_count = 0; 1175 for (i = blob->active.num_clusters; i < blob->active.cluster_array_size; i++) { 1176 uint64_t next_lba = blob->active.clusters[i]; 1177 uint32_t next_lba_count = _spdk_bs_cluster_to_lba(bs, 1); 1178 1179 if (next_lba > 0 && (lba + lba_count) == next_lba) { 1180 /* This cluster is contiguous with the previous one. */ 1181 lba_count += next_lba_count; 1182 continue; 1183 } 1184 1185 /* This cluster is not contiguous with the previous one. */ 1186 1187 /* If a run of LBAs previously existing, clear them now */ 1188 if (lba_count > 0) { 1189 spdk_bs_batch_clear_dev(ctx, batch, lba, lba_count); 1190 } 1191 1192 /* Start building the next batch */ 1193 lba = next_lba; 1194 if (next_lba > 0) { 1195 lba_count = next_lba_count; 1196 } else { 1197 lba_count = 0; 1198 } 1199 } 1200 1201 /* If we ended with a contiguous set of LBAs, clear them now */ 1202 if (lba_count > 0) { 1203 spdk_bs_batch_clear_dev(ctx, batch, lba, lba_count); 1204 } 1205 1206 spdk_bs_batch_close(batch); 1207 } 1208 1209 static void 1210 _spdk_blob_persist_zero_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1211 { 1212 struct spdk_blob_persist_ctx *ctx = cb_arg; 1213 struct spdk_blob *blob = ctx->blob; 1214 struct spdk_blob_store *bs = blob->bs; 1215 size_t i; 1216 1217 /* This loop starts at 1 because the first page is special and handled 1218 * below. The pages (except the first) are never written in place, 1219 * so any pages in the clean list must be zeroed. 1220 */ 1221 for (i = 1; i < blob->clean.num_pages; i++) { 1222 spdk_bit_array_clear(bs->used_md_pages, blob->clean.pages[i]); 1223 } 1224 1225 if (blob->active.num_pages == 0) { 1226 uint32_t page_num; 1227 1228 page_num = _spdk_bs_blobid_to_page(blob->id); 1229 spdk_bit_array_clear(bs->used_md_pages, page_num); 1230 } 1231 1232 /* Move on to clearing clusters */ 1233 _spdk_blob_persist_clear_clusters(seq, ctx, 0); 1234 } 1235 1236 static void 1237 _spdk_blob_persist_zero_pages(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1238 { 1239 struct spdk_blob_persist_ctx *ctx = cb_arg; 1240 struct spdk_blob *blob = ctx->blob; 1241 struct spdk_blob_store *bs = blob->bs; 1242 uint64_t lba; 1243 uint32_t lba_count; 1244 spdk_bs_batch_t *batch; 1245 size_t i; 1246 1247 batch = spdk_bs_sequence_to_batch(seq, _spdk_blob_persist_zero_pages_cpl, ctx); 1248 1249 lba_count = _spdk_bs_byte_to_lba(bs, SPDK_BS_PAGE_SIZE); 1250 1251 /* This loop starts at 1 because the first page is special and handled 1252 * below. The pages (except the first) are never written in place, 1253 * so any pages in the clean list must be zeroed. 1254 */ 1255 for (i = 1; i < blob->clean.num_pages; i++) { 1256 lba = _spdk_bs_page_to_lba(bs, bs->md_start + blob->clean.pages[i]); 1257 1258 spdk_bs_batch_write_zeroes_dev(batch, lba, lba_count); 1259 } 1260 1261 /* The first page will only be zeroed if this is a delete. */ 1262 if (blob->active.num_pages == 0) { 1263 uint32_t page_num; 1264 1265 /* The first page in the metadata goes where the blobid indicates */ 1266 page_num = _spdk_bs_blobid_to_page(blob->id); 1267 lba = _spdk_bs_page_to_lba(bs, bs->md_start + page_num); 1268 1269 spdk_bs_batch_write_zeroes_dev(batch, lba, lba_count); 1270 } 1271 1272 spdk_bs_batch_close(batch); 1273 } 1274 1275 static void 1276 _spdk_blob_persist_write_page_root(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1277 { 1278 struct spdk_blob_persist_ctx *ctx = cb_arg; 1279 struct spdk_blob *blob = ctx->blob; 1280 struct spdk_blob_store *bs = blob->bs; 1281 uint64_t lba; 1282 uint32_t lba_count; 1283 struct spdk_blob_md_page *page; 1284 1285 if (blob->active.num_pages == 0) { 1286 /* Move on to the next step */ 1287 _spdk_blob_persist_zero_pages(seq, ctx, 0); 1288 return; 1289 } 1290 1291 lba_count = _spdk_bs_byte_to_lba(bs, sizeof(*page)); 1292 1293 page = &ctx->pages[0]; 1294 /* The first page in the metadata goes where the blobid indicates */ 1295 lba = _spdk_bs_page_to_lba(bs, bs->md_start + _spdk_bs_blobid_to_page(blob->id)); 1296 1297 spdk_bs_sequence_write_dev(seq, page, lba, lba_count, 1298 _spdk_blob_persist_zero_pages, ctx); 1299 } 1300 1301 static void 1302 _spdk_blob_persist_write_page_chain(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1303 { 1304 struct spdk_blob_persist_ctx *ctx = cb_arg; 1305 struct spdk_blob *blob = ctx->blob; 1306 struct spdk_blob_store *bs = blob->bs; 1307 uint64_t lba; 1308 uint32_t lba_count; 1309 struct spdk_blob_md_page *page; 1310 spdk_bs_batch_t *batch; 1311 size_t i; 1312 1313 /* Clusters don't move around in blobs. The list shrinks or grows 1314 * at the end, but no changes ever occur in the middle of the list. 1315 */ 1316 1317 lba_count = _spdk_bs_byte_to_lba(bs, sizeof(*page)); 1318 1319 batch = spdk_bs_sequence_to_batch(seq, _spdk_blob_persist_write_page_root, ctx); 1320 1321 /* This starts at 1. The root page is not written until 1322 * all of the others are finished 1323 */ 1324 for (i = 1; i < blob->active.num_pages; i++) { 1325 page = &ctx->pages[i]; 1326 assert(page->sequence_num == i); 1327 1328 lba = _spdk_bs_page_to_lba(bs, bs->md_start + blob->active.pages[i]); 1329 1330 spdk_bs_batch_write_dev(batch, page, lba, lba_count); 1331 } 1332 1333 spdk_bs_batch_close(batch); 1334 } 1335 1336 static int 1337 _spdk_blob_resize(struct spdk_blob *blob, uint64_t sz) 1338 { 1339 uint64_t i; 1340 uint64_t *tmp; 1341 uint64_t lfc; /* lowest free cluster */ 1342 uint64_t num_clusters; 1343 struct spdk_blob_store *bs; 1344 1345 bs = blob->bs; 1346 1347 _spdk_blob_verify_md_op(blob); 1348 1349 if (blob->active.num_clusters == sz) { 1350 return 0; 1351 } 1352 1353 if (blob->active.num_clusters < blob->active.cluster_array_size) { 1354 /* If this blob was resized to be larger, then smaller, then 1355 * larger without syncing, then the cluster array already 1356 * contains spare assigned clusters we can use. 1357 */ 1358 num_clusters = spdk_min(blob->active.cluster_array_size, 1359 sz); 1360 } else { 1361 num_clusters = blob->active.num_clusters; 1362 } 1363 1364 /* Do two passes - one to verify that we can obtain enough clusters 1365 * and another to actually claim them. 1366 */ 1367 1368 if (spdk_blob_is_thin_provisioned(blob) == false) { 1369 lfc = 0; 1370 for (i = num_clusters; i < sz; i++) { 1371 lfc = spdk_bit_array_find_first_clear(bs->used_clusters, lfc); 1372 if (lfc == UINT32_MAX) { 1373 /* No more free clusters. Cannot satisfy the request */ 1374 return -ENOSPC; 1375 } 1376 lfc++; 1377 } 1378 } 1379 1380 if (sz > num_clusters) { 1381 /* Expand the cluster array if necessary. 1382 * We only shrink the array when persisting. 1383 */ 1384 tmp = realloc(blob->active.clusters, sizeof(uint64_t) * sz); 1385 if (sz > 0 && tmp == NULL) { 1386 return -ENOMEM; 1387 } 1388 memset(tmp + blob->active.cluster_array_size, 0, 1389 sizeof(uint64_t) * (sz - blob->active.cluster_array_size)); 1390 blob->active.clusters = tmp; 1391 blob->active.cluster_array_size = sz; 1392 } 1393 1394 blob->state = SPDK_BLOB_STATE_DIRTY; 1395 1396 if (spdk_blob_is_thin_provisioned(blob) == false) { 1397 lfc = 0; 1398 for (i = num_clusters; i < sz; i++) { 1399 _spdk_bs_allocate_cluster(blob, i, &lfc, true); 1400 lfc++; 1401 } 1402 } 1403 1404 blob->active.num_clusters = sz; 1405 1406 return 0; 1407 } 1408 1409 static void 1410 _spdk_blob_persist_start(struct spdk_blob_persist_ctx *ctx) 1411 { 1412 spdk_bs_sequence_t *seq = ctx->seq; 1413 struct spdk_blob *blob = ctx->blob; 1414 struct spdk_blob_store *bs = blob->bs; 1415 uint64_t i; 1416 uint32_t page_num; 1417 void *tmp; 1418 int rc; 1419 1420 if (blob->active.num_pages == 0) { 1421 /* This is the signal that the blob should be deleted. 1422 * Immediately jump to the clean up routine. */ 1423 assert(blob->clean.num_pages > 0); 1424 ctx->idx = blob->clean.num_pages - 1; 1425 blob->state = SPDK_BLOB_STATE_CLEAN; 1426 _spdk_blob_persist_zero_pages(seq, ctx, 0); 1427 return; 1428 1429 } 1430 1431 /* Generate the new metadata */ 1432 rc = _spdk_blob_serialize(blob, &ctx->pages, &blob->active.num_pages); 1433 if (rc < 0) { 1434 _spdk_blob_persist_complete(seq, ctx, rc); 1435 return; 1436 } 1437 1438 assert(blob->active.num_pages >= 1); 1439 1440 /* Resize the cache of page indices */ 1441 tmp = realloc(blob->active.pages, blob->active.num_pages * sizeof(*blob->active.pages)); 1442 if (!tmp) { 1443 _spdk_blob_persist_complete(seq, ctx, -ENOMEM); 1444 return; 1445 } 1446 blob->active.pages = tmp; 1447 1448 /* Assign this metadata to pages. This requires two passes - 1449 * one to verify that there are enough pages and a second 1450 * to actually claim them. */ 1451 page_num = 0; 1452 /* Note that this loop starts at one. The first page location is fixed by the blobid. */ 1453 for (i = 1; i < blob->active.num_pages; i++) { 1454 page_num = spdk_bit_array_find_first_clear(bs->used_md_pages, page_num); 1455 if (page_num == UINT32_MAX) { 1456 _spdk_blob_persist_complete(seq, ctx, -ENOMEM); 1457 return; 1458 } 1459 page_num++; 1460 } 1461 1462 page_num = 0; 1463 blob->active.pages[0] = _spdk_bs_blobid_to_page(blob->id); 1464 for (i = 1; i < blob->active.num_pages; i++) { 1465 page_num = spdk_bit_array_find_first_clear(bs->used_md_pages, page_num); 1466 ctx->pages[i - 1].next = page_num; 1467 /* Now that previous metadata page is complete, calculate the crc for it. */ 1468 ctx->pages[i - 1].crc = _spdk_blob_md_page_calc_crc(&ctx->pages[i - 1]); 1469 blob->active.pages[i] = page_num; 1470 spdk_bit_array_set(bs->used_md_pages, page_num); 1471 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Claiming page %u for blob %lu\n", page_num, blob->id); 1472 page_num++; 1473 } 1474 ctx->pages[i - 1].crc = _spdk_blob_md_page_calc_crc(&ctx->pages[i - 1]); 1475 /* Start writing the metadata from last page to first */ 1476 ctx->idx = blob->active.num_pages - 1; 1477 blob->state = SPDK_BLOB_STATE_CLEAN; 1478 _spdk_blob_persist_write_page_chain(seq, ctx, 0); 1479 } 1480 1481 static void 1482 _spdk_blob_persist_dirty_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1483 { 1484 struct spdk_blob_persist_ctx *ctx = cb_arg; 1485 1486 ctx->blob->bs->clean = 0; 1487 1488 spdk_free(ctx->super); 1489 1490 _spdk_blob_persist_start(ctx); 1491 } 1492 1493 static void 1494 _spdk_bs_write_super(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 1495 struct spdk_bs_super_block *super, spdk_bs_sequence_cpl cb_fn, void *cb_arg); 1496 1497 1498 static void 1499 _spdk_blob_persist_dirty(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1500 { 1501 struct spdk_blob_persist_ctx *ctx = cb_arg; 1502 1503 ctx->super->clean = 0; 1504 if (ctx->super->size == 0) { 1505 ctx->super->size = ctx->blob->bs->dev->blockcnt * ctx->blob->bs->dev->blocklen; 1506 } 1507 1508 _spdk_bs_write_super(seq, ctx->blob->bs, ctx->super, _spdk_blob_persist_dirty_cpl, ctx); 1509 } 1510 1511 1512 /* Write a blob to disk */ 1513 static void 1514 _spdk_blob_persist(spdk_bs_sequence_t *seq, struct spdk_blob *blob, 1515 spdk_bs_sequence_cpl cb_fn, void *cb_arg) 1516 { 1517 struct spdk_blob_persist_ctx *ctx; 1518 1519 _spdk_blob_verify_md_op(blob); 1520 1521 if (blob->state == SPDK_BLOB_STATE_CLEAN) { 1522 cb_fn(seq, cb_arg, 0); 1523 return; 1524 } 1525 1526 ctx = calloc(1, sizeof(*ctx)); 1527 if (!ctx) { 1528 cb_fn(seq, cb_arg, -ENOMEM); 1529 return; 1530 } 1531 ctx->blob = blob; 1532 ctx->seq = seq; 1533 ctx->cb_fn = cb_fn; 1534 ctx->cb_arg = cb_arg; 1535 1536 if (blob->bs->clean) { 1537 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 1538 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 1539 if (!ctx->super) { 1540 cb_fn(seq, cb_arg, -ENOMEM); 1541 free(ctx); 1542 return; 1543 } 1544 1545 spdk_bs_sequence_read_dev(seq, ctx->super, _spdk_bs_page_to_lba(blob->bs, 0), 1546 _spdk_bs_byte_to_lba(blob->bs, sizeof(*ctx->super)), 1547 _spdk_blob_persist_dirty, ctx); 1548 } else { 1549 _spdk_blob_persist_start(ctx); 1550 } 1551 } 1552 1553 struct spdk_blob_copy_cluster_ctx { 1554 struct spdk_blob *blob; 1555 uint8_t *buf; 1556 uint64_t page; 1557 uint64_t new_cluster; 1558 spdk_bs_sequence_t *seq; 1559 }; 1560 1561 static void 1562 _spdk_blob_allocate_and_copy_cluster_cpl(void *cb_arg, int bserrno) 1563 { 1564 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 1565 struct spdk_bs_request_set *set = (struct spdk_bs_request_set *)ctx->seq; 1566 TAILQ_HEAD(, spdk_bs_request_set) requests; 1567 spdk_bs_user_op_t *op; 1568 1569 TAILQ_INIT(&requests); 1570 TAILQ_SWAP(&set->channel->need_cluster_alloc, &requests, spdk_bs_request_set, link); 1571 1572 while (!TAILQ_EMPTY(&requests)) { 1573 op = TAILQ_FIRST(&requests); 1574 TAILQ_REMOVE(&requests, op, link); 1575 if (bserrno == 0) { 1576 spdk_bs_user_op_execute(op); 1577 } else { 1578 spdk_bs_user_op_abort(op); 1579 } 1580 } 1581 1582 spdk_free(ctx->buf); 1583 free(ctx); 1584 } 1585 1586 static void 1587 _spdk_blob_insert_cluster_cpl(void *cb_arg, int bserrno) 1588 { 1589 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 1590 1591 if (bserrno) { 1592 if (bserrno == -EEXIST) { 1593 /* The metadata insert failed because another thread 1594 * allocated the cluster first. Free our cluster 1595 * but continue without error. */ 1596 bserrno = 0; 1597 } 1598 _spdk_bs_release_cluster(ctx->blob->bs, ctx->new_cluster); 1599 } 1600 1601 spdk_bs_sequence_finish(ctx->seq, bserrno); 1602 } 1603 1604 static void 1605 _spdk_blob_write_copy_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1606 { 1607 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 1608 uint32_t cluster_number; 1609 1610 if (bserrno) { 1611 /* The write failed, so jump to the final completion handler */ 1612 spdk_bs_sequence_finish(seq, bserrno); 1613 return; 1614 } 1615 1616 cluster_number = _spdk_bs_page_to_cluster(ctx->blob->bs, ctx->page); 1617 1618 _spdk_blob_insert_cluster_on_md_thread(ctx->blob, cluster_number, ctx->new_cluster, 1619 _spdk_blob_insert_cluster_cpl, ctx); 1620 } 1621 1622 static void 1623 _spdk_blob_write_copy(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 1624 { 1625 struct spdk_blob_copy_cluster_ctx *ctx = cb_arg; 1626 1627 if (bserrno != 0) { 1628 /* The read failed, so jump to the final completion handler */ 1629 spdk_bs_sequence_finish(seq, bserrno); 1630 return; 1631 } 1632 1633 /* Write whole cluster */ 1634 spdk_bs_sequence_write_dev(seq, ctx->buf, 1635 _spdk_bs_cluster_to_lba(ctx->blob->bs, ctx->new_cluster), 1636 _spdk_bs_cluster_to_lba(ctx->blob->bs, 1), 1637 _spdk_blob_write_copy_cpl, ctx); 1638 } 1639 1640 static void 1641 _spdk_bs_allocate_and_copy_cluster(struct spdk_blob *blob, 1642 struct spdk_io_channel *_ch, 1643 uint64_t io_unit, spdk_bs_user_op_t *op) 1644 { 1645 struct spdk_bs_cpl cpl; 1646 struct spdk_bs_channel *ch; 1647 struct spdk_blob_copy_cluster_ctx *ctx; 1648 uint32_t cluster_start_page; 1649 uint32_t cluster_number; 1650 int rc; 1651 1652 ch = spdk_io_channel_get_ctx(_ch); 1653 1654 if (!TAILQ_EMPTY(&ch->need_cluster_alloc)) { 1655 /* There are already operations pending. Queue this user op 1656 * and return because it will be re-executed when the outstanding 1657 * cluster allocation completes. */ 1658 TAILQ_INSERT_TAIL(&ch->need_cluster_alloc, op, link); 1659 return; 1660 } 1661 1662 /* Round the io_unit offset down to the first page in the cluster */ 1663 cluster_start_page = _spdk_bs_io_unit_to_cluster_start(blob, io_unit); 1664 1665 /* Calculate which index in the metadata cluster array the corresponding 1666 * cluster is supposed to be at. */ 1667 cluster_number = _spdk_bs_io_unit_to_cluster_number(blob, io_unit); 1668 1669 ctx = calloc(1, sizeof(*ctx)); 1670 if (!ctx) { 1671 spdk_bs_user_op_abort(op); 1672 return; 1673 } 1674 1675 assert(blob->bs->cluster_sz % blob->back_bs_dev->blocklen == 0); 1676 1677 ctx->blob = blob; 1678 ctx->page = cluster_start_page; 1679 1680 if (blob->parent_id != SPDK_BLOBID_INVALID) { 1681 ctx->buf = spdk_malloc(blob->bs->cluster_sz, blob->back_bs_dev->blocklen, 1682 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 1683 if (!ctx->buf) { 1684 SPDK_ERRLOG("DMA allocation for cluster of size = %" PRIu32 " failed.\n", 1685 blob->bs->cluster_sz); 1686 free(ctx); 1687 spdk_bs_user_op_abort(op); 1688 return; 1689 } 1690 } 1691 1692 rc = _spdk_bs_allocate_cluster(blob, cluster_number, &ctx->new_cluster, false); 1693 if (rc != 0) { 1694 spdk_free(ctx->buf); 1695 free(ctx); 1696 spdk_bs_user_op_abort(op); 1697 return; 1698 } 1699 1700 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 1701 cpl.u.blob_basic.cb_fn = _spdk_blob_allocate_and_copy_cluster_cpl; 1702 cpl.u.blob_basic.cb_arg = ctx; 1703 1704 ctx->seq = spdk_bs_sequence_start(_ch, &cpl); 1705 if (!ctx->seq) { 1706 _spdk_bs_release_cluster(blob->bs, ctx->new_cluster); 1707 spdk_free(ctx->buf); 1708 free(ctx); 1709 spdk_bs_user_op_abort(op); 1710 return; 1711 } 1712 1713 /* Queue the user op to block other incoming operations */ 1714 TAILQ_INSERT_TAIL(&ch->need_cluster_alloc, op, link); 1715 1716 if (blob->parent_id != SPDK_BLOBID_INVALID) { 1717 /* Read cluster from backing device */ 1718 spdk_bs_sequence_read_bs_dev(ctx->seq, blob->back_bs_dev, ctx->buf, 1719 _spdk_bs_dev_page_to_lba(blob->back_bs_dev, cluster_start_page), 1720 _spdk_bs_dev_byte_to_lba(blob->back_bs_dev, blob->bs->cluster_sz), 1721 _spdk_blob_write_copy, ctx); 1722 } else { 1723 _spdk_blob_insert_cluster_on_md_thread(ctx->blob, cluster_number, ctx->new_cluster, 1724 _spdk_blob_insert_cluster_cpl, ctx); 1725 } 1726 } 1727 1728 static void 1729 _spdk_blob_calculate_lba_and_lba_count(struct spdk_blob *blob, uint64_t io_unit, uint64_t length, 1730 uint64_t *lba, uint32_t *lba_count) 1731 { 1732 *lba_count = length; 1733 1734 if (!_spdk_bs_io_unit_is_allocated(blob, io_unit)) { 1735 assert(blob->back_bs_dev != NULL); 1736 *lba = _spdk_bs_io_unit_to_back_dev_lba(blob, io_unit); 1737 *lba_count = _spdk_bs_io_unit_to_back_dev_lba(blob, *lba_count); 1738 } else { 1739 *lba = _spdk_bs_blob_io_unit_to_lba(blob, io_unit); 1740 } 1741 } 1742 1743 struct op_split_ctx { 1744 struct spdk_blob *blob; 1745 struct spdk_io_channel *channel; 1746 uint64_t io_unit_offset; 1747 uint64_t io_units_remaining; 1748 void *curr_payload; 1749 enum spdk_blob_op_type op_type; 1750 spdk_bs_sequence_t *seq; 1751 }; 1752 1753 static void 1754 _spdk_blob_request_submit_op_split_next(void *cb_arg, int bserrno) 1755 { 1756 struct op_split_ctx *ctx = cb_arg; 1757 struct spdk_blob *blob = ctx->blob; 1758 struct spdk_io_channel *ch = ctx->channel; 1759 enum spdk_blob_op_type op_type = ctx->op_type; 1760 uint8_t *buf = ctx->curr_payload; 1761 uint64_t offset = ctx->io_unit_offset; 1762 uint64_t length = ctx->io_units_remaining; 1763 uint64_t op_length; 1764 1765 if (bserrno != 0 || ctx->io_units_remaining == 0) { 1766 spdk_bs_sequence_finish(ctx->seq, bserrno); 1767 free(ctx); 1768 return; 1769 } 1770 1771 op_length = spdk_min(length, _spdk_bs_num_io_units_to_cluster_boundary(blob, 1772 offset)); 1773 1774 /* Update length and payload for next operation */ 1775 ctx->io_units_remaining -= op_length; 1776 ctx->io_unit_offset += op_length; 1777 if (op_type == SPDK_BLOB_WRITE || op_type == SPDK_BLOB_READ) { 1778 ctx->curr_payload += op_length * blob->bs->io_unit_size; 1779 } 1780 1781 switch (op_type) { 1782 case SPDK_BLOB_READ: 1783 spdk_blob_io_read(blob, ch, buf, offset, op_length, 1784 _spdk_blob_request_submit_op_split_next, ctx); 1785 break; 1786 case SPDK_BLOB_WRITE: 1787 spdk_blob_io_write(blob, ch, buf, offset, op_length, 1788 _spdk_blob_request_submit_op_split_next, ctx); 1789 break; 1790 case SPDK_BLOB_UNMAP: 1791 spdk_blob_io_unmap(blob, ch, offset, op_length, 1792 _spdk_blob_request_submit_op_split_next, ctx); 1793 break; 1794 case SPDK_BLOB_WRITE_ZEROES: 1795 spdk_blob_io_write_zeroes(blob, ch, offset, op_length, 1796 _spdk_blob_request_submit_op_split_next, ctx); 1797 break; 1798 case SPDK_BLOB_READV: 1799 case SPDK_BLOB_WRITEV: 1800 SPDK_ERRLOG("readv/write not valid for %s\n", __func__); 1801 spdk_bs_sequence_finish(ctx->seq, -EINVAL); 1802 free(ctx); 1803 break; 1804 } 1805 } 1806 1807 static void 1808 _spdk_blob_request_submit_op_split(struct spdk_io_channel *ch, struct spdk_blob *blob, 1809 void *payload, uint64_t offset, uint64_t length, 1810 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 1811 { 1812 struct op_split_ctx *ctx; 1813 spdk_bs_sequence_t *seq; 1814 struct spdk_bs_cpl cpl; 1815 1816 assert(blob != NULL); 1817 1818 ctx = calloc(1, sizeof(struct op_split_ctx)); 1819 if (ctx == NULL) { 1820 cb_fn(cb_arg, -ENOMEM); 1821 return; 1822 } 1823 1824 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 1825 cpl.u.blob_basic.cb_fn = cb_fn; 1826 cpl.u.blob_basic.cb_arg = cb_arg; 1827 1828 seq = spdk_bs_sequence_start(ch, &cpl); 1829 if (!seq) { 1830 free(ctx); 1831 cb_fn(cb_arg, -ENOMEM); 1832 return; 1833 } 1834 1835 ctx->blob = blob; 1836 ctx->channel = ch; 1837 ctx->curr_payload = payload; 1838 ctx->io_unit_offset = offset; 1839 ctx->io_units_remaining = length; 1840 ctx->op_type = op_type; 1841 ctx->seq = seq; 1842 1843 _spdk_blob_request_submit_op_split_next(ctx, 0); 1844 } 1845 1846 static void 1847 _spdk_blob_request_submit_op_single(struct spdk_io_channel *_ch, struct spdk_blob *blob, 1848 void *payload, uint64_t offset, uint64_t length, 1849 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 1850 { 1851 struct spdk_bs_cpl cpl; 1852 uint64_t lba; 1853 uint32_t lba_count; 1854 1855 assert(blob != NULL); 1856 1857 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 1858 cpl.u.blob_basic.cb_fn = cb_fn; 1859 cpl.u.blob_basic.cb_arg = cb_arg; 1860 1861 _spdk_blob_calculate_lba_and_lba_count(blob, offset, length, &lba, &lba_count); 1862 1863 if (blob->frozen_refcnt) { 1864 /* This blob I/O is frozen */ 1865 spdk_bs_user_op_t *op; 1866 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_ch); 1867 1868 op = spdk_bs_user_op_alloc(_ch, &cpl, op_type, blob, payload, 0, offset, length); 1869 if (!op) { 1870 cb_fn(cb_arg, -ENOMEM); 1871 return; 1872 } 1873 1874 TAILQ_INSERT_TAIL(&bs_channel->queued_io, op, link); 1875 1876 return; 1877 } 1878 1879 switch (op_type) { 1880 case SPDK_BLOB_READ: { 1881 spdk_bs_batch_t *batch; 1882 1883 batch = spdk_bs_batch_open(_ch, &cpl); 1884 if (!batch) { 1885 cb_fn(cb_arg, -ENOMEM); 1886 return; 1887 } 1888 1889 if (_spdk_bs_io_unit_is_allocated(blob, offset)) { 1890 /* Read from the blob */ 1891 spdk_bs_batch_read_dev(batch, payload, lba, lba_count); 1892 } else { 1893 /* Read from the backing block device */ 1894 spdk_bs_batch_read_bs_dev(batch, blob->back_bs_dev, payload, lba, lba_count); 1895 } 1896 1897 spdk_bs_batch_close(batch); 1898 break; 1899 } 1900 case SPDK_BLOB_WRITE: 1901 case SPDK_BLOB_WRITE_ZEROES: { 1902 if (_spdk_bs_io_unit_is_allocated(blob, offset)) { 1903 /* Write to the blob */ 1904 spdk_bs_batch_t *batch; 1905 1906 if (lba_count == 0) { 1907 cb_fn(cb_arg, 0); 1908 return; 1909 } 1910 1911 batch = spdk_bs_batch_open(_ch, &cpl); 1912 if (!batch) { 1913 cb_fn(cb_arg, -ENOMEM); 1914 return; 1915 } 1916 1917 if (op_type == SPDK_BLOB_WRITE) { 1918 spdk_bs_batch_write_dev(batch, payload, lba, lba_count); 1919 } else { 1920 spdk_bs_batch_write_zeroes_dev(batch, lba, lba_count); 1921 } 1922 1923 spdk_bs_batch_close(batch); 1924 } else { 1925 /* Queue this operation and allocate the cluster */ 1926 spdk_bs_user_op_t *op; 1927 1928 op = spdk_bs_user_op_alloc(_ch, &cpl, op_type, blob, payload, 0, offset, length); 1929 if (!op) { 1930 cb_fn(cb_arg, -ENOMEM); 1931 return; 1932 } 1933 1934 _spdk_bs_allocate_and_copy_cluster(blob, _ch, offset, op); 1935 } 1936 break; 1937 } 1938 case SPDK_BLOB_UNMAP: { 1939 spdk_bs_batch_t *batch; 1940 1941 batch = spdk_bs_batch_open(_ch, &cpl); 1942 if (!batch) { 1943 cb_fn(cb_arg, -ENOMEM); 1944 return; 1945 } 1946 1947 if (_spdk_bs_io_unit_is_allocated(blob, offset)) { 1948 spdk_bs_batch_unmap_dev(batch, lba, lba_count); 1949 } 1950 1951 spdk_bs_batch_close(batch); 1952 break; 1953 } 1954 case SPDK_BLOB_READV: 1955 case SPDK_BLOB_WRITEV: 1956 SPDK_ERRLOG("readv/write not valid\n"); 1957 cb_fn(cb_arg, -EINVAL); 1958 break; 1959 } 1960 } 1961 1962 static void 1963 _spdk_blob_request_submit_op(struct spdk_blob *blob, struct spdk_io_channel *_channel, 1964 void *payload, uint64_t offset, uint64_t length, 1965 spdk_blob_op_complete cb_fn, void *cb_arg, enum spdk_blob_op_type op_type) 1966 { 1967 assert(blob != NULL); 1968 1969 if (blob->data_ro && op_type != SPDK_BLOB_READ) { 1970 cb_fn(cb_arg, -EPERM); 1971 return; 1972 } 1973 1974 if (offset + length > _spdk_bs_cluster_to_lba(blob->bs, blob->active.num_clusters)) { 1975 cb_fn(cb_arg, -EINVAL); 1976 return; 1977 } 1978 if (length <= _spdk_bs_num_io_units_to_cluster_boundary(blob, offset)) { 1979 _spdk_blob_request_submit_op_single(_channel, blob, payload, offset, length, 1980 cb_fn, cb_arg, op_type); 1981 } else { 1982 _spdk_blob_request_submit_op_split(_channel, blob, payload, offset, length, 1983 cb_fn, cb_arg, op_type); 1984 } 1985 } 1986 1987 struct rw_iov_ctx { 1988 struct spdk_blob *blob; 1989 struct spdk_io_channel *channel; 1990 spdk_blob_op_complete cb_fn; 1991 void *cb_arg; 1992 bool read; 1993 int iovcnt; 1994 struct iovec *orig_iov; 1995 uint64_t io_unit_offset; 1996 uint64_t io_units_remaining; 1997 uint64_t io_units_done; 1998 struct iovec iov[0]; 1999 }; 2000 2001 static void 2002 _spdk_rw_iov_done(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2003 { 2004 assert(cb_arg == NULL); 2005 spdk_bs_sequence_finish(seq, bserrno); 2006 } 2007 2008 static void 2009 _spdk_rw_iov_split_next(void *cb_arg, int bserrno) 2010 { 2011 struct rw_iov_ctx *ctx = cb_arg; 2012 struct spdk_blob *blob = ctx->blob; 2013 struct iovec *iov, *orig_iov; 2014 int iovcnt; 2015 size_t orig_iovoff; 2016 uint64_t io_units_count, io_units_to_boundary, io_unit_offset; 2017 uint64_t byte_count; 2018 2019 if (bserrno != 0 || ctx->io_units_remaining == 0) { 2020 ctx->cb_fn(ctx->cb_arg, bserrno); 2021 free(ctx); 2022 return; 2023 } 2024 2025 io_unit_offset = ctx->io_unit_offset; 2026 io_units_to_boundary = _spdk_bs_num_io_units_to_cluster_boundary(blob, io_unit_offset); 2027 io_units_count = spdk_min(ctx->io_units_remaining, io_units_to_boundary); 2028 /* 2029 * Get index and offset into the original iov array for our current position in the I/O sequence. 2030 * byte_count will keep track of how many bytes remaining until orig_iov and orig_iovoff will 2031 * point to the current position in the I/O sequence. 2032 */ 2033 byte_count = ctx->io_units_done * blob->bs->io_unit_size; 2034 orig_iov = &ctx->orig_iov[0]; 2035 orig_iovoff = 0; 2036 while (byte_count > 0) { 2037 if (byte_count >= orig_iov->iov_len) { 2038 byte_count -= orig_iov->iov_len; 2039 orig_iov++; 2040 } else { 2041 orig_iovoff = byte_count; 2042 byte_count = 0; 2043 } 2044 } 2045 2046 /* 2047 * Build an iov array for the next I/O in the sequence. byte_count will keep track of how many 2048 * bytes of this next I/O remain to be accounted for in the new iov array. 2049 */ 2050 byte_count = io_units_count * blob->bs->io_unit_size; 2051 iov = &ctx->iov[0]; 2052 iovcnt = 0; 2053 while (byte_count > 0) { 2054 assert(iovcnt < ctx->iovcnt); 2055 iov->iov_len = spdk_min(byte_count, orig_iov->iov_len - orig_iovoff); 2056 iov->iov_base = orig_iov->iov_base + orig_iovoff; 2057 byte_count -= iov->iov_len; 2058 orig_iovoff = 0; 2059 orig_iov++; 2060 iov++; 2061 iovcnt++; 2062 } 2063 2064 ctx->io_unit_offset += io_units_count; 2065 ctx->io_units_remaining -= io_units_count; 2066 ctx->io_units_done += io_units_count; 2067 iov = &ctx->iov[0]; 2068 2069 if (ctx->read) { 2070 spdk_blob_io_readv(ctx->blob, ctx->channel, iov, iovcnt, io_unit_offset, 2071 io_units_count, _spdk_rw_iov_split_next, ctx); 2072 } else { 2073 spdk_blob_io_writev(ctx->blob, ctx->channel, iov, iovcnt, io_unit_offset, 2074 io_units_count, _spdk_rw_iov_split_next, ctx); 2075 } 2076 } 2077 2078 static void 2079 _spdk_blob_request_submit_rw_iov(struct spdk_blob *blob, struct spdk_io_channel *_channel, 2080 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 2081 spdk_blob_op_complete cb_fn, void *cb_arg, bool read) 2082 { 2083 struct spdk_bs_cpl cpl; 2084 2085 assert(blob != NULL); 2086 2087 if (!read && blob->data_ro) { 2088 cb_fn(cb_arg, -EPERM); 2089 return; 2090 } 2091 2092 if (length == 0) { 2093 cb_fn(cb_arg, 0); 2094 return; 2095 } 2096 2097 if (offset + length > _spdk_bs_cluster_to_lba(blob->bs, blob->active.num_clusters)) { 2098 cb_fn(cb_arg, -EINVAL); 2099 return; 2100 } 2101 2102 /* 2103 * For now, we implement readv/writev using a sequence (instead of a batch) to account for having 2104 * to split a request that spans a cluster boundary. For I/O that do not span a cluster boundary, 2105 * there will be no noticeable difference compared to using a batch. For I/O that do span a cluster 2106 * boundary, the target LBAs (after blob offset to LBA translation) may not be contiguous, so we need 2107 * to allocate a separate iov array and split the I/O such that none of the resulting 2108 * smaller I/O cross a cluster boundary. These smaller I/O will be issued in sequence (not in parallel) 2109 * but since this case happens very infrequently, any performance impact will be negligible. 2110 * 2111 * This could be optimized in the future to allocate a big enough iov array to account for all of the iovs 2112 * for all of the smaller I/Os, pre-build all of the iov arrays for the smaller I/Os, then issue them 2113 * in a batch. That would also require creating an intermediate spdk_bs_cpl that would get called 2114 * when the batch was completed, to allow for freeing the memory for the iov arrays. 2115 */ 2116 if (spdk_likely(length <= _spdk_bs_num_io_units_to_cluster_boundary(blob, offset))) { 2117 uint32_t lba_count; 2118 uint64_t lba; 2119 2120 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 2121 cpl.u.blob_basic.cb_fn = cb_fn; 2122 cpl.u.blob_basic.cb_arg = cb_arg; 2123 2124 if (blob->frozen_refcnt) { 2125 /* This blob I/O is frozen */ 2126 enum spdk_blob_op_type op_type; 2127 spdk_bs_user_op_t *op; 2128 struct spdk_bs_channel *bs_channel = spdk_io_channel_get_ctx(_channel); 2129 2130 op_type = read ? SPDK_BLOB_READV : SPDK_BLOB_WRITEV; 2131 op = spdk_bs_user_op_alloc(_channel, &cpl, op_type, blob, iov, iovcnt, offset, length); 2132 if (!op) { 2133 cb_fn(cb_arg, -ENOMEM); 2134 return; 2135 } 2136 2137 TAILQ_INSERT_TAIL(&bs_channel->queued_io, op, link); 2138 2139 return; 2140 } 2141 2142 _spdk_blob_calculate_lba_and_lba_count(blob, offset, length, &lba, &lba_count); 2143 2144 if (read) { 2145 spdk_bs_sequence_t *seq; 2146 2147 seq = spdk_bs_sequence_start(_channel, &cpl); 2148 if (!seq) { 2149 cb_fn(cb_arg, -ENOMEM); 2150 return; 2151 } 2152 2153 if (_spdk_bs_io_unit_is_allocated(blob, offset)) { 2154 spdk_bs_sequence_readv_dev(seq, iov, iovcnt, lba, lba_count, _spdk_rw_iov_done, NULL); 2155 } else { 2156 spdk_bs_sequence_readv_bs_dev(seq, blob->back_bs_dev, iov, iovcnt, lba, lba_count, 2157 _spdk_rw_iov_done, NULL); 2158 } 2159 } else { 2160 if (_spdk_bs_io_unit_is_allocated(blob, offset)) { 2161 spdk_bs_sequence_t *seq; 2162 2163 seq = spdk_bs_sequence_start(_channel, &cpl); 2164 if (!seq) { 2165 cb_fn(cb_arg, -ENOMEM); 2166 return; 2167 } 2168 2169 spdk_bs_sequence_writev_dev(seq, iov, iovcnt, lba, lba_count, _spdk_rw_iov_done, NULL); 2170 } else { 2171 /* Queue this operation and allocate the cluster */ 2172 spdk_bs_user_op_t *op; 2173 2174 op = spdk_bs_user_op_alloc(_channel, &cpl, SPDK_BLOB_WRITEV, blob, iov, iovcnt, offset, 2175 length); 2176 if (!op) { 2177 cb_fn(cb_arg, -ENOMEM); 2178 return; 2179 } 2180 2181 _spdk_bs_allocate_and_copy_cluster(blob, _channel, offset, op); 2182 } 2183 } 2184 } else { 2185 struct rw_iov_ctx *ctx; 2186 2187 ctx = calloc(1, sizeof(struct rw_iov_ctx) + iovcnt * sizeof(struct iovec)); 2188 if (ctx == NULL) { 2189 cb_fn(cb_arg, -ENOMEM); 2190 return; 2191 } 2192 2193 ctx->blob = blob; 2194 ctx->channel = _channel; 2195 ctx->cb_fn = cb_fn; 2196 ctx->cb_arg = cb_arg; 2197 ctx->read = read; 2198 ctx->orig_iov = iov; 2199 ctx->iovcnt = iovcnt; 2200 ctx->io_unit_offset = offset; 2201 ctx->io_units_remaining = length; 2202 ctx->io_units_done = 0; 2203 2204 _spdk_rw_iov_split_next(ctx, 0); 2205 } 2206 } 2207 2208 static struct spdk_blob * 2209 _spdk_blob_lookup(struct spdk_blob_store *bs, spdk_blob_id blobid) 2210 { 2211 struct spdk_blob *blob; 2212 2213 TAILQ_FOREACH(blob, &bs->blobs, link) { 2214 if (blob->id == blobid) { 2215 return blob; 2216 } 2217 } 2218 2219 return NULL; 2220 } 2221 2222 static void 2223 _spdk_blob_get_snapshot_and_clone_entries(struct spdk_blob *blob, 2224 struct spdk_blob_list **snapshot_entry, struct spdk_blob_list **clone_entry) 2225 { 2226 assert(blob != NULL); 2227 *snapshot_entry = NULL; 2228 *clone_entry = NULL; 2229 2230 if (blob->parent_id == SPDK_BLOBID_INVALID) { 2231 return; 2232 } 2233 2234 TAILQ_FOREACH(*snapshot_entry, &blob->bs->snapshots, link) { 2235 if ((*snapshot_entry)->id == blob->parent_id) { 2236 break; 2237 } 2238 } 2239 2240 if (*snapshot_entry != NULL) { 2241 TAILQ_FOREACH(*clone_entry, &(*snapshot_entry)->clones, link) { 2242 if ((*clone_entry)->id == blob->id) { 2243 break; 2244 } 2245 } 2246 2247 assert(clone_entry != NULL); 2248 } 2249 } 2250 2251 static int 2252 _spdk_bs_channel_create(void *io_device, void *ctx_buf) 2253 { 2254 struct spdk_blob_store *bs = io_device; 2255 struct spdk_bs_channel *channel = ctx_buf; 2256 struct spdk_bs_dev *dev; 2257 uint32_t max_ops = bs->max_channel_ops; 2258 uint32_t i; 2259 2260 dev = bs->dev; 2261 2262 channel->req_mem = calloc(max_ops, sizeof(struct spdk_bs_request_set)); 2263 if (!channel->req_mem) { 2264 return -1; 2265 } 2266 2267 TAILQ_INIT(&channel->reqs); 2268 2269 for (i = 0; i < max_ops; i++) { 2270 TAILQ_INSERT_TAIL(&channel->reqs, &channel->req_mem[i], link); 2271 } 2272 2273 channel->bs = bs; 2274 channel->dev = dev; 2275 channel->dev_channel = dev->create_channel(dev); 2276 2277 if (!channel->dev_channel) { 2278 SPDK_ERRLOG("Failed to create device channel.\n"); 2279 free(channel->req_mem); 2280 return -1; 2281 } 2282 2283 TAILQ_INIT(&channel->need_cluster_alloc); 2284 TAILQ_INIT(&channel->queued_io); 2285 2286 return 0; 2287 } 2288 2289 static void 2290 _spdk_bs_channel_destroy(void *io_device, void *ctx_buf) 2291 { 2292 struct spdk_bs_channel *channel = ctx_buf; 2293 spdk_bs_user_op_t *op; 2294 2295 while (!TAILQ_EMPTY(&channel->need_cluster_alloc)) { 2296 op = TAILQ_FIRST(&channel->need_cluster_alloc); 2297 TAILQ_REMOVE(&channel->need_cluster_alloc, op, link); 2298 spdk_bs_user_op_abort(op); 2299 } 2300 2301 while (!TAILQ_EMPTY(&channel->queued_io)) { 2302 op = TAILQ_FIRST(&channel->queued_io); 2303 TAILQ_REMOVE(&channel->queued_io, op, link); 2304 spdk_bs_user_op_abort(op); 2305 } 2306 2307 free(channel->req_mem); 2308 channel->dev->destroy_channel(channel->dev, channel->dev_channel); 2309 } 2310 2311 static void 2312 _spdk_bs_dev_destroy(void *io_device) 2313 { 2314 struct spdk_blob_store *bs = io_device; 2315 struct spdk_blob *blob, *blob_tmp; 2316 2317 bs->dev->destroy(bs->dev); 2318 2319 TAILQ_FOREACH_SAFE(blob, &bs->blobs, link, blob_tmp) { 2320 TAILQ_REMOVE(&bs->blobs, blob, link); 2321 _spdk_blob_free(blob); 2322 } 2323 2324 pthread_mutex_destroy(&bs->used_clusters_mutex); 2325 2326 spdk_bit_array_free(&bs->used_blobids); 2327 spdk_bit_array_free(&bs->used_md_pages); 2328 spdk_bit_array_free(&bs->used_clusters); 2329 /* 2330 * If this function is called for any reason except a successful unload, 2331 * the unload_cpl type will be NONE and this will be a nop. 2332 */ 2333 spdk_bs_call_cpl(&bs->unload_cpl, bs->unload_err); 2334 2335 free(bs); 2336 } 2337 2338 static int 2339 _spdk_bs_blob_list_add(struct spdk_blob *blob) 2340 { 2341 spdk_blob_id snapshot_id; 2342 struct spdk_blob_list *snapshot_entry = NULL; 2343 struct spdk_blob_list *clone_entry = NULL; 2344 2345 assert(blob != NULL); 2346 2347 snapshot_id = blob->parent_id; 2348 if (snapshot_id == SPDK_BLOBID_INVALID) { 2349 return 0; 2350 } 2351 2352 snapshot_entry = _spdk_bs_get_snapshot_entry(blob->bs, snapshot_id); 2353 if (snapshot_entry == NULL) { 2354 /* Snapshot not found */ 2355 snapshot_entry = calloc(1, sizeof(struct spdk_blob_list)); 2356 if (snapshot_entry == NULL) { 2357 return -ENOMEM; 2358 } 2359 snapshot_entry->id = snapshot_id; 2360 TAILQ_INIT(&snapshot_entry->clones); 2361 TAILQ_INSERT_TAIL(&blob->bs->snapshots, snapshot_entry, link); 2362 } else { 2363 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 2364 if (clone_entry->id == blob->id) { 2365 break; 2366 } 2367 } 2368 } 2369 2370 if (clone_entry == NULL) { 2371 /* Clone not found */ 2372 clone_entry = calloc(1, sizeof(struct spdk_blob_list)); 2373 if (clone_entry == NULL) { 2374 return -ENOMEM; 2375 } 2376 clone_entry->id = blob->id; 2377 TAILQ_INIT(&clone_entry->clones); 2378 TAILQ_INSERT_TAIL(&snapshot_entry->clones, clone_entry, link); 2379 snapshot_entry->clone_count++; 2380 } 2381 2382 return 0; 2383 } 2384 2385 static void 2386 _spdk_bs_blob_list_remove(struct spdk_blob *blob) 2387 { 2388 struct spdk_blob_list *snapshot_entry = NULL; 2389 struct spdk_blob_list *clone_entry = NULL; 2390 2391 _spdk_blob_get_snapshot_and_clone_entries(blob, &snapshot_entry, &clone_entry); 2392 2393 if (snapshot_entry == NULL) { 2394 return; 2395 } 2396 2397 blob->parent_id = SPDK_BLOBID_INVALID; 2398 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 2399 free(clone_entry); 2400 2401 snapshot_entry->clone_count--; 2402 } 2403 2404 static int 2405 _spdk_bs_blob_list_free(struct spdk_blob_store *bs) 2406 { 2407 struct spdk_blob_list *snapshot_entry; 2408 struct spdk_blob_list *snapshot_entry_tmp; 2409 struct spdk_blob_list *clone_entry; 2410 struct spdk_blob_list *clone_entry_tmp; 2411 2412 TAILQ_FOREACH_SAFE(snapshot_entry, &bs->snapshots, link, snapshot_entry_tmp) { 2413 TAILQ_FOREACH_SAFE(clone_entry, &snapshot_entry->clones, link, clone_entry_tmp) { 2414 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 2415 free(clone_entry); 2416 } 2417 TAILQ_REMOVE(&bs->snapshots, snapshot_entry, link); 2418 free(snapshot_entry); 2419 } 2420 2421 return 0; 2422 } 2423 2424 static void 2425 _spdk_bs_free(struct spdk_blob_store *bs) 2426 { 2427 _spdk_bs_blob_list_free(bs); 2428 2429 spdk_bs_unregister_md_thread(bs); 2430 spdk_io_device_unregister(bs, _spdk_bs_dev_destroy); 2431 } 2432 2433 void 2434 spdk_bs_opts_init(struct spdk_bs_opts *opts) 2435 { 2436 opts->cluster_sz = SPDK_BLOB_OPTS_CLUSTER_SZ; 2437 opts->num_md_pages = SPDK_BLOB_OPTS_NUM_MD_PAGES; 2438 opts->max_md_ops = SPDK_BLOB_OPTS_MAX_MD_OPS; 2439 opts->max_channel_ops = SPDK_BLOB_OPTS_DEFAULT_CHANNEL_OPS; 2440 opts->clear_method = BS_CLEAR_WITH_UNMAP; 2441 memset(&opts->bstype, 0, sizeof(opts->bstype)); 2442 opts->iter_cb_fn = NULL; 2443 opts->iter_cb_arg = NULL; 2444 } 2445 2446 static int 2447 _spdk_bs_opts_verify(struct spdk_bs_opts *opts) 2448 { 2449 if (opts->cluster_sz == 0 || opts->num_md_pages == 0 || opts->max_md_ops == 0 || 2450 opts->max_channel_ops == 0) { 2451 SPDK_ERRLOG("Blobstore options cannot be set to 0\n"); 2452 return -1; 2453 } 2454 2455 return 0; 2456 } 2457 2458 static int 2459 _spdk_bs_alloc(struct spdk_bs_dev *dev, struct spdk_bs_opts *opts, struct spdk_blob_store **_bs) 2460 { 2461 struct spdk_blob_store *bs; 2462 uint64_t dev_size; 2463 int rc; 2464 2465 dev_size = dev->blocklen * dev->blockcnt; 2466 if (dev_size < opts->cluster_sz) { 2467 /* Device size cannot be smaller than cluster size of blobstore */ 2468 SPDK_INFOLOG(SPDK_LOG_BLOB, "Device size %" PRIu64 " is smaller than cluster size %" PRIu32 "\n", 2469 dev_size, opts->cluster_sz); 2470 return -ENOSPC; 2471 } 2472 if (opts->cluster_sz < SPDK_BS_PAGE_SIZE) { 2473 /* Cluster size cannot be smaller than page size */ 2474 SPDK_ERRLOG("Cluster size %" PRIu32 " is smaller than page size %d\n", 2475 opts->cluster_sz, SPDK_BS_PAGE_SIZE); 2476 return -EINVAL; 2477 } 2478 bs = calloc(1, sizeof(struct spdk_blob_store)); 2479 if (!bs) { 2480 return -ENOMEM; 2481 } 2482 2483 TAILQ_INIT(&bs->blobs); 2484 TAILQ_INIT(&bs->snapshots); 2485 bs->dev = dev; 2486 bs->md_thread = spdk_get_thread(); 2487 assert(bs->md_thread != NULL); 2488 2489 /* 2490 * Do not use _spdk_bs_lba_to_cluster() here since blockcnt may not be an 2491 * even multiple of the cluster size. 2492 */ 2493 bs->cluster_sz = opts->cluster_sz; 2494 bs->total_clusters = dev->blockcnt / (bs->cluster_sz / dev->blocklen); 2495 bs->pages_per_cluster = bs->cluster_sz / SPDK_BS_PAGE_SIZE; 2496 bs->num_free_clusters = bs->total_clusters; 2497 bs->used_clusters = spdk_bit_array_create(bs->total_clusters); 2498 bs->io_unit_size = dev->blocklen; 2499 if (bs->used_clusters == NULL) { 2500 free(bs); 2501 return -ENOMEM; 2502 } 2503 2504 bs->max_channel_ops = opts->max_channel_ops; 2505 bs->super_blob = SPDK_BLOBID_INVALID; 2506 memcpy(&bs->bstype, &opts->bstype, sizeof(opts->bstype)); 2507 2508 /* The metadata is assumed to be at least 1 page */ 2509 bs->used_md_pages = spdk_bit_array_create(1); 2510 bs->used_blobids = spdk_bit_array_create(0); 2511 2512 pthread_mutex_init(&bs->used_clusters_mutex, NULL); 2513 2514 spdk_io_device_register(bs, _spdk_bs_channel_create, _spdk_bs_channel_destroy, 2515 sizeof(struct spdk_bs_channel), "blobstore"); 2516 rc = spdk_bs_register_md_thread(bs); 2517 if (rc == -1) { 2518 spdk_io_device_unregister(bs, NULL); 2519 pthread_mutex_destroy(&bs->used_clusters_mutex); 2520 spdk_bit_array_free(&bs->used_blobids); 2521 spdk_bit_array_free(&bs->used_md_pages); 2522 spdk_bit_array_free(&bs->used_clusters); 2523 free(bs); 2524 /* FIXME: this is a lie but don't know how to get a proper error code here */ 2525 return -ENOMEM; 2526 } 2527 2528 *_bs = bs; 2529 return 0; 2530 } 2531 2532 /* START spdk_bs_load, spdk_bs_load_ctx will used for both load and unload. */ 2533 2534 struct spdk_bs_load_ctx { 2535 struct spdk_blob_store *bs; 2536 struct spdk_bs_super_block *super; 2537 2538 struct spdk_bs_md_mask *mask; 2539 bool in_page_chain; 2540 uint32_t page_index; 2541 uint32_t cur_page; 2542 struct spdk_blob_md_page *page; 2543 2544 spdk_bs_sequence_t *seq; 2545 spdk_blob_op_with_handle_complete iter_cb_fn; 2546 void *iter_cb_arg; 2547 struct spdk_blob *blob; 2548 spdk_blob_id blobid; 2549 }; 2550 2551 static void 2552 _spdk_bs_load_ctx_fail(spdk_bs_sequence_t *seq, struct spdk_bs_load_ctx *ctx, int bserrno) 2553 { 2554 assert(bserrno != 0); 2555 2556 spdk_free(ctx->super); 2557 spdk_bs_sequence_finish(seq, bserrno); 2558 _spdk_bs_free(ctx->bs); 2559 free(ctx); 2560 } 2561 2562 static void 2563 _spdk_bs_set_mask(struct spdk_bit_array *array, struct spdk_bs_md_mask *mask) 2564 { 2565 uint32_t i = 0; 2566 2567 while (true) { 2568 i = spdk_bit_array_find_first_set(array, i); 2569 if (i >= mask->length) { 2570 break; 2571 } 2572 mask->mask[i / 8] |= 1U << (i % 8); 2573 i++; 2574 } 2575 } 2576 2577 static int 2578 _spdk_bs_load_mask(struct spdk_bit_array **array_ptr, struct spdk_bs_md_mask *mask) 2579 { 2580 struct spdk_bit_array *array; 2581 uint32_t i; 2582 2583 if (spdk_bit_array_resize(array_ptr, mask->length) < 0) { 2584 return -ENOMEM; 2585 } 2586 2587 array = *array_ptr; 2588 for (i = 0; i < mask->length; i++) { 2589 if (mask->mask[i / 8] & (1U << (i % 8))) { 2590 spdk_bit_array_set(array, i); 2591 } 2592 } 2593 2594 return 0; 2595 } 2596 2597 static void 2598 _spdk_bs_write_super(spdk_bs_sequence_t *seq, struct spdk_blob_store *bs, 2599 struct spdk_bs_super_block *super, spdk_bs_sequence_cpl cb_fn, void *cb_arg) 2600 { 2601 /* Update the values in the super block */ 2602 super->super_blob = bs->super_blob; 2603 memcpy(&super->bstype, &bs->bstype, sizeof(bs->bstype)); 2604 super->crc = _spdk_blob_md_page_calc_crc(super); 2605 spdk_bs_sequence_write_dev(seq, super, _spdk_bs_page_to_lba(bs, 0), 2606 _spdk_bs_byte_to_lba(bs, sizeof(*super)), 2607 cb_fn, cb_arg); 2608 } 2609 2610 static void 2611 _spdk_bs_write_used_clusters(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 2612 { 2613 struct spdk_bs_load_ctx *ctx = arg; 2614 uint64_t mask_size, lba, lba_count; 2615 2616 /* Write out the used clusters mask */ 2617 mask_size = ctx->super->used_cluster_mask_len * SPDK_BS_PAGE_SIZE; 2618 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 2619 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 2620 if (!ctx->mask) { 2621 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 2622 return; 2623 } 2624 2625 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_CLUSTERS; 2626 ctx->mask->length = ctx->bs->total_clusters; 2627 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_clusters)); 2628 2629 _spdk_bs_set_mask(ctx->bs->used_clusters, ctx->mask); 2630 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 2631 lba_count = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 2632 spdk_bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 2633 } 2634 2635 static void 2636 _spdk_bs_write_used_md(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 2637 { 2638 struct spdk_bs_load_ctx *ctx = arg; 2639 uint64_t mask_size, lba, lba_count; 2640 2641 if (seq->bserrno) { 2642 _spdk_bs_load_ctx_fail(seq, ctx, seq->bserrno); 2643 return; 2644 } 2645 2646 mask_size = ctx->super->used_page_mask_len * SPDK_BS_PAGE_SIZE; 2647 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 2648 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 2649 if (!ctx->mask) { 2650 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 2651 return; 2652 } 2653 2654 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_PAGES; 2655 ctx->mask->length = ctx->super->md_len; 2656 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_md_pages)); 2657 2658 _spdk_bs_set_mask(ctx->bs->used_md_pages, ctx->mask); 2659 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_start); 2660 lba_count = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_len); 2661 spdk_bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 2662 } 2663 2664 static void 2665 _spdk_bs_write_used_blobids(spdk_bs_sequence_t *seq, void *arg, spdk_bs_sequence_cpl cb_fn) 2666 { 2667 struct spdk_bs_load_ctx *ctx = arg; 2668 uint64_t mask_size, lba, lba_count; 2669 2670 if (ctx->super->used_blobid_mask_len == 0) { 2671 /* 2672 * This is a pre-v3 on-disk format where the blobid mask does not get 2673 * written to disk. 2674 */ 2675 cb_fn(seq, arg, 0); 2676 return; 2677 } 2678 2679 mask_size = ctx->super->used_blobid_mask_len * SPDK_BS_PAGE_SIZE; 2680 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_SOCKET_ID_ANY, 2681 SPDK_MALLOC_DMA); 2682 if (!ctx->mask) { 2683 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 2684 return; 2685 } 2686 2687 ctx->mask->type = SPDK_MD_MASK_TYPE_USED_BLOBIDS; 2688 ctx->mask->length = ctx->super->md_len; 2689 assert(ctx->mask->length == spdk_bit_array_capacity(ctx->bs->used_blobids)); 2690 2691 _spdk_bs_set_mask(ctx->bs->used_blobids, ctx->mask); 2692 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_start); 2693 lba_count = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_len); 2694 spdk_bs_sequence_write_dev(seq, ctx->mask, lba, lba_count, cb_fn, arg); 2695 } 2696 2697 static void 2698 _spdk_blob_set_thin_provision(struct spdk_blob *blob) 2699 { 2700 _spdk_blob_verify_md_op(blob); 2701 blob->invalid_flags |= SPDK_BLOB_THIN_PROV; 2702 blob->state = SPDK_BLOB_STATE_DIRTY; 2703 } 2704 2705 static void _spdk_bs_load_iter(void *arg, struct spdk_blob *blob, int bserrno); 2706 2707 static void 2708 _spdk_bs_delete_corrupted_blob_cpl(void *cb_arg, int bserrno) 2709 { 2710 struct spdk_bs_load_ctx *ctx = cb_arg; 2711 spdk_blob_id id; 2712 int64_t page_num; 2713 2714 /* Iterate to next blob (we can't use spdk_bs_iter_next function as our 2715 * last blob has been removed */ 2716 page_num = _spdk_bs_blobid_to_page(ctx->blobid); 2717 page_num++; 2718 page_num = spdk_bit_array_find_first_set(ctx->bs->used_blobids, page_num); 2719 if (page_num >= spdk_bit_array_capacity(ctx->bs->used_blobids)) { 2720 _spdk_bs_load_iter(ctx, NULL, -ENOENT); 2721 return; 2722 } 2723 2724 id = _spdk_bs_page_to_blobid(page_num); 2725 2726 spdk_bs_open_blob(ctx->bs, id, _spdk_bs_load_iter, ctx); 2727 } 2728 2729 static void 2730 _spdk_bs_delete_corrupted_close_cb(void *cb_arg, int bserrno) 2731 { 2732 struct spdk_bs_load_ctx *ctx = cb_arg; 2733 2734 if (bserrno != 0) { 2735 SPDK_ERRLOG("Failed to close corrupted blob\n"); 2736 spdk_bs_iter_next(ctx->bs, ctx->blob, _spdk_bs_load_iter, ctx); 2737 return; 2738 } 2739 2740 spdk_bs_delete_blob(ctx->bs, ctx->blobid, _spdk_bs_delete_corrupted_blob_cpl, ctx); 2741 } 2742 2743 static void 2744 _spdk_bs_delete_corrupted_blob(void *cb_arg, int bserrno) 2745 { 2746 struct spdk_bs_load_ctx *ctx = cb_arg; 2747 uint64_t i; 2748 2749 if (bserrno != 0) { 2750 SPDK_ERRLOG("Failed to close clone of a corrupted blob\n"); 2751 spdk_bs_iter_next(ctx->bs, ctx->blob, _spdk_bs_load_iter, ctx); 2752 return; 2753 } 2754 2755 /* Snapshot and clone have the same copy of cluster map at this point. 2756 * Let's clear cluster map for snpashot now so that it won't be cleared 2757 * for clone later when we remove snapshot. Also set thin provision to 2758 * pass data corruption check */ 2759 for (i = 0; i < ctx->blob->active.num_clusters; i++) { 2760 ctx->blob->active.clusters[i] = 0; 2761 } 2762 2763 ctx->blob->md_ro = false; 2764 2765 _spdk_blob_set_thin_provision(ctx->blob); 2766 2767 ctx->blobid = ctx->blob->id; 2768 2769 spdk_blob_close(ctx->blob, _spdk_bs_delete_corrupted_close_cb, ctx); 2770 } 2771 2772 static void 2773 _spdk_bs_update_corrupted_blob(void *cb_arg, int bserrno) 2774 { 2775 struct spdk_bs_load_ctx *ctx = cb_arg; 2776 2777 if (bserrno != 0) { 2778 SPDK_ERRLOG("Failed to close clone of a corrupted blob\n"); 2779 spdk_bs_iter_next(ctx->bs, ctx->blob, _spdk_bs_load_iter, ctx); 2780 return; 2781 } 2782 2783 ctx->blob->md_ro = false; 2784 _spdk_blob_remove_xattr(ctx->blob, SNAPSHOT_PENDING_REMOVAL, true); 2785 _spdk_blob_remove_xattr(ctx->blob, SNAPSHOT_IN_PROGRESS, true); 2786 spdk_blob_set_read_only(ctx->blob); 2787 2788 if (ctx->iter_cb_fn) { 2789 ctx->iter_cb_fn(ctx->iter_cb_arg, ctx->blob, 0); 2790 } 2791 _spdk_bs_blob_list_add(ctx->blob); 2792 2793 spdk_bs_iter_next(ctx->bs, ctx->blob, _spdk_bs_load_iter, ctx); 2794 } 2795 2796 static void 2797 _spdk_bs_examine_clone(void *cb_arg, struct spdk_blob *blob, int bserrno) 2798 { 2799 struct spdk_bs_load_ctx *ctx = cb_arg; 2800 2801 if (bserrno != 0) { 2802 SPDK_ERRLOG("Failed to open clone of a corrupted blob\n"); 2803 spdk_bs_iter_next(ctx->bs, ctx->blob, _spdk_bs_load_iter, ctx); 2804 return; 2805 } 2806 2807 if (blob->parent_id == ctx->blob->id) { 2808 /* Power failure occured before updating clone (snapshot delete case) 2809 * or after updating clone (creating snapshot case) - keep snapshot */ 2810 spdk_blob_close(blob, _spdk_bs_update_corrupted_blob, ctx); 2811 } else { 2812 /* Power failure occured after updating clone (snapshot delete case) 2813 * or before updating clone (creating snapshot case) - remove snapshot */ 2814 spdk_blob_close(blob, _spdk_bs_delete_corrupted_blob, ctx); 2815 } 2816 } 2817 2818 static void 2819 _spdk_bs_load_iter(void *arg, struct spdk_blob *blob, int bserrno) 2820 { 2821 struct spdk_bs_load_ctx *ctx = arg; 2822 const void *value; 2823 size_t len; 2824 int rc = 0; 2825 2826 if (bserrno == 0) { 2827 /* Examine blob if it is corrupted after power failure. Fix 2828 * the ones that can be fixed and remove any other corrupted 2829 * ones. If it is not corrupted just process it */ 2830 rc = _spdk_blob_get_xattr_value(blob, SNAPSHOT_PENDING_REMOVAL, &value, &len, true); 2831 if (rc != 0) { 2832 rc = _spdk_blob_get_xattr_value(blob, SNAPSHOT_IN_PROGRESS, &value, &len, true); 2833 if (rc != 0) { 2834 /* Not corrupted - process it and continue with iterating through blobs */ 2835 if (ctx->iter_cb_fn) { 2836 ctx->iter_cb_fn(ctx->iter_cb_arg, blob, 0); 2837 } 2838 _spdk_bs_blob_list_add(blob); 2839 spdk_bs_iter_next(ctx->bs, blob, _spdk_bs_load_iter, ctx); 2840 return; 2841 } 2842 2843 } 2844 2845 assert(len == sizeof(spdk_blob_id)); 2846 2847 ctx->blob = blob; 2848 2849 /* Open clone to check if we are able to fix this blob or should we remove it */ 2850 spdk_bs_open_blob(ctx->bs, *(spdk_blob_id *)value, _spdk_bs_examine_clone, ctx); 2851 return; 2852 } else if (bserrno == -ENOENT) { 2853 bserrno = 0; 2854 } else { 2855 /* 2856 * This case needs to be looked at further. Same problem 2857 * exists with applications that rely on explicit blob 2858 * iteration. We should just skip the blob that failed 2859 * to load and continue on to the next one. 2860 */ 2861 SPDK_ERRLOG("Error in iterating blobs\n"); 2862 } 2863 2864 ctx->iter_cb_fn = NULL; 2865 2866 spdk_free(ctx->super); 2867 spdk_free(ctx->mask); 2868 spdk_bs_sequence_finish(ctx->seq, bserrno); 2869 free(ctx); 2870 } 2871 2872 static void 2873 _spdk_bs_load_complete(spdk_bs_sequence_t *seq, struct spdk_bs_load_ctx *ctx, int bserrno) 2874 { 2875 ctx->seq = seq; 2876 spdk_bs_iter_first(ctx->bs, _spdk_bs_load_iter, ctx); 2877 } 2878 2879 static void 2880 _spdk_bs_load_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2881 { 2882 struct spdk_bs_load_ctx *ctx = cb_arg; 2883 int rc; 2884 2885 /* The type must be correct */ 2886 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_BLOBIDS); 2887 2888 /* The length of the mask (in bits) must not be greater than 2889 * the length of the buffer (converted to bits) */ 2890 assert(ctx->mask->length <= (ctx->super->used_blobid_mask_len * SPDK_BS_PAGE_SIZE * 8)); 2891 2892 /* The length of the mask must be exactly equal to the size 2893 * (in pages) of the metadata region */ 2894 assert(ctx->mask->length == ctx->super->md_len); 2895 2896 rc = _spdk_bs_load_mask(&ctx->bs->used_blobids, ctx->mask); 2897 if (rc < 0) { 2898 spdk_free(ctx->mask); 2899 _spdk_bs_load_ctx_fail(seq, ctx, rc); 2900 return; 2901 } 2902 2903 _spdk_bs_load_complete(seq, ctx, bserrno); 2904 } 2905 2906 static void 2907 _spdk_bs_load_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2908 { 2909 struct spdk_bs_load_ctx *ctx = cb_arg; 2910 uint64_t lba, lba_count, mask_size; 2911 int rc; 2912 2913 /* The type must be correct */ 2914 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_CLUSTERS); 2915 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 2916 assert(ctx->mask->length <= (ctx->super->used_cluster_mask_len * sizeof( 2917 struct spdk_blob_md_page) * 8)); 2918 /* The length of the mask must be exactly equal to the total number of clusters */ 2919 assert(ctx->mask->length == ctx->bs->total_clusters); 2920 2921 rc = _spdk_bs_load_mask(&ctx->bs->used_clusters, ctx->mask); 2922 if (rc < 0) { 2923 spdk_free(ctx->mask); 2924 _spdk_bs_load_ctx_fail(seq, ctx, rc); 2925 return; 2926 } 2927 2928 ctx->bs->num_free_clusters = spdk_bit_array_count_clear(ctx->bs->used_clusters); 2929 assert(ctx->bs->num_free_clusters <= ctx->bs->total_clusters); 2930 2931 spdk_free(ctx->mask); 2932 2933 /* Read the used blobids mask */ 2934 mask_size = ctx->super->used_blobid_mask_len * SPDK_BS_PAGE_SIZE; 2935 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_SOCKET_ID_ANY, 2936 SPDK_MALLOC_DMA); 2937 if (!ctx->mask) { 2938 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 2939 return; 2940 } 2941 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_start); 2942 lba_count = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_blobid_mask_len); 2943 spdk_bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 2944 _spdk_bs_load_used_blobids_cpl, ctx); 2945 } 2946 2947 static void 2948 _spdk_bs_load_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 2949 { 2950 struct spdk_bs_load_ctx *ctx = cb_arg; 2951 uint64_t lba, lba_count, mask_size; 2952 int rc; 2953 2954 /* The type must be correct */ 2955 assert(ctx->mask->type == SPDK_MD_MASK_TYPE_USED_PAGES); 2956 /* The length of the mask (in bits) must not be greater than the length of the buffer (converted to bits) */ 2957 assert(ctx->mask->length <= (ctx->super->used_page_mask_len * SPDK_BS_PAGE_SIZE * 2958 8)); 2959 /* The length of the mask must be exactly equal to the size (in pages) of the metadata region */ 2960 assert(ctx->mask->length == ctx->super->md_len); 2961 2962 rc = _spdk_bs_load_mask(&ctx->bs->used_md_pages, ctx->mask); 2963 if (rc < 0) { 2964 spdk_free(ctx->mask); 2965 _spdk_bs_load_ctx_fail(seq, ctx, rc); 2966 return; 2967 } 2968 2969 spdk_free(ctx->mask); 2970 2971 /* Read the used clusters mask */ 2972 mask_size = ctx->super->used_cluster_mask_len * SPDK_BS_PAGE_SIZE; 2973 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, SPDK_ENV_SOCKET_ID_ANY, 2974 SPDK_MALLOC_DMA); 2975 if (!ctx->mask) { 2976 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 2977 return; 2978 } 2979 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_start); 2980 lba_count = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_cluster_mask_len); 2981 spdk_bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 2982 _spdk_bs_load_used_clusters_cpl, ctx); 2983 } 2984 2985 static void 2986 _spdk_bs_load_read_used_pages(spdk_bs_sequence_t *seq, void *cb_arg) 2987 { 2988 struct spdk_bs_load_ctx *ctx = cb_arg; 2989 uint64_t lba, lba_count, mask_size; 2990 2991 /* Read the used pages mask */ 2992 mask_size = ctx->super->used_page_mask_len * SPDK_BS_PAGE_SIZE; 2993 ctx->mask = spdk_zmalloc(mask_size, 0x1000, NULL, 2994 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 2995 if (!ctx->mask) { 2996 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 2997 return; 2998 } 2999 3000 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_start); 3001 lba_count = _spdk_bs_page_to_lba(ctx->bs, ctx->super->used_page_mask_len); 3002 spdk_bs_sequence_read_dev(seq, ctx->mask, lba, lba_count, 3003 _spdk_bs_load_used_pages_cpl, ctx); 3004 } 3005 3006 static int 3007 _spdk_bs_load_replay_md_parse_page(const struct spdk_blob_md_page *page, struct spdk_blob_store *bs) 3008 { 3009 struct spdk_blob_md_descriptor *desc; 3010 size_t cur_desc = 0; 3011 3012 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 3013 while (cur_desc < sizeof(page->descriptors)) { 3014 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 3015 if (desc->length == 0) { 3016 /* If padding and length are 0, this terminates the page */ 3017 break; 3018 } 3019 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT) { 3020 struct spdk_blob_md_descriptor_extent *desc_extent; 3021 unsigned int i, j; 3022 unsigned int cluster_count = 0; 3023 uint32_t cluster_idx; 3024 3025 desc_extent = (struct spdk_blob_md_descriptor_extent *)desc; 3026 3027 for (i = 0; i < desc_extent->length / sizeof(desc_extent->extents[0]); i++) { 3028 for (j = 0; j < desc_extent->extents[i].length; j++) { 3029 cluster_idx = desc_extent->extents[i].cluster_idx; 3030 /* 3031 * cluster_idx = 0 means an unallocated cluster - don't mark that 3032 * in the used cluster map. 3033 */ 3034 if (cluster_idx != 0) { 3035 spdk_bit_array_set(bs->used_clusters, cluster_idx + j); 3036 if (bs->num_free_clusters == 0) { 3037 return -ENOSPC; 3038 } 3039 bs->num_free_clusters--; 3040 } 3041 cluster_count++; 3042 } 3043 } 3044 if (cluster_count == 0) { 3045 return -EINVAL; 3046 } 3047 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 3048 /* Skip this item */ 3049 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 3050 /* Skip this item */ 3051 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 3052 /* Skip this item */ 3053 } else { 3054 /* Error */ 3055 return -EINVAL; 3056 } 3057 /* Advance to the next descriptor */ 3058 cur_desc += sizeof(*desc) + desc->length; 3059 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 3060 break; 3061 } 3062 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 3063 } 3064 return 0; 3065 } 3066 3067 static bool _spdk_bs_load_cur_md_page_valid(struct spdk_bs_load_ctx *ctx) 3068 { 3069 uint32_t crc; 3070 3071 crc = _spdk_blob_md_page_calc_crc(ctx->page); 3072 if (crc != ctx->page->crc) { 3073 return false; 3074 } 3075 3076 if (ctx->page->sequence_num == 0 && 3077 _spdk_bs_page_to_blobid(ctx->cur_page) != ctx->page->id) { 3078 return false; 3079 } 3080 return true; 3081 } 3082 3083 static void 3084 _spdk_bs_load_replay_cur_md_page(spdk_bs_sequence_t *seq, void *cb_arg); 3085 3086 static void 3087 _spdk_bs_load_write_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3088 { 3089 struct spdk_bs_load_ctx *ctx = cb_arg; 3090 3091 _spdk_bs_load_complete(seq, ctx, bserrno); 3092 } 3093 3094 static void 3095 _spdk_bs_load_write_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3096 { 3097 struct spdk_bs_load_ctx *ctx = cb_arg; 3098 3099 spdk_free(ctx->mask); 3100 ctx->mask = NULL; 3101 3102 _spdk_bs_write_used_clusters(seq, cb_arg, _spdk_bs_load_write_used_clusters_cpl); 3103 } 3104 3105 static void 3106 _spdk_bs_load_write_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3107 { 3108 struct spdk_bs_load_ctx *ctx = cb_arg; 3109 3110 spdk_free(ctx->mask); 3111 ctx->mask = NULL; 3112 3113 _spdk_bs_write_used_blobids(seq, cb_arg, _spdk_bs_load_write_used_blobids_cpl); 3114 } 3115 3116 static void 3117 _spdk_bs_load_write_used_md(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3118 { 3119 _spdk_bs_write_used_md(seq, cb_arg, _spdk_bs_load_write_used_pages_cpl); 3120 } 3121 3122 static void 3123 _spdk_bs_load_replay_md_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3124 { 3125 struct spdk_bs_load_ctx *ctx = cb_arg; 3126 uint64_t num_md_clusters; 3127 uint64_t i; 3128 uint32_t page_num; 3129 3130 if (bserrno != 0) { 3131 _spdk_bs_load_ctx_fail(seq, ctx, bserrno); 3132 return; 3133 } 3134 3135 page_num = ctx->cur_page; 3136 if (_spdk_bs_load_cur_md_page_valid(ctx) == true) { 3137 if (ctx->page->sequence_num == 0 || ctx->in_page_chain == true) { 3138 spdk_bit_array_set(ctx->bs->used_md_pages, page_num); 3139 if (ctx->page->sequence_num == 0) { 3140 spdk_bit_array_set(ctx->bs->used_blobids, page_num); 3141 } 3142 if (_spdk_bs_load_replay_md_parse_page(ctx->page, ctx->bs)) { 3143 _spdk_bs_load_ctx_fail(seq, ctx, -EILSEQ); 3144 return; 3145 } 3146 if (ctx->page->next != SPDK_INVALID_MD_PAGE) { 3147 ctx->in_page_chain = true; 3148 ctx->cur_page = ctx->page->next; 3149 _spdk_bs_load_replay_cur_md_page(seq, cb_arg); 3150 return; 3151 } 3152 } 3153 } 3154 3155 ctx->in_page_chain = false; 3156 3157 do { 3158 ctx->page_index++; 3159 } while (spdk_bit_array_get(ctx->bs->used_md_pages, ctx->page_index) == true); 3160 3161 if (ctx->page_index < ctx->super->md_len) { 3162 ctx->cur_page = ctx->page_index; 3163 _spdk_bs_load_replay_cur_md_page(seq, cb_arg); 3164 } else { 3165 /* Claim all of the clusters used by the metadata */ 3166 num_md_clusters = spdk_divide_round_up(ctx->super->md_len, ctx->bs->pages_per_cluster); 3167 for (i = 0; i < num_md_clusters; i++) { 3168 _spdk_bs_claim_cluster(ctx->bs, i); 3169 } 3170 spdk_free(ctx->page); 3171 _spdk_bs_load_write_used_md(seq, ctx, bserrno); 3172 } 3173 } 3174 3175 static void 3176 _spdk_bs_load_replay_cur_md_page(spdk_bs_sequence_t *seq, void *cb_arg) 3177 { 3178 struct spdk_bs_load_ctx *ctx = cb_arg; 3179 uint64_t lba; 3180 3181 assert(ctx->cur_page < ctx->super->md_len); 3182 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->md_start + ctx->cur_page); 3183 spdk_bs_sequence_read_dev(seq, ctx->page, lba, 3184 _spdk_bs_byte_to_lba(ctx->bs, SPDK_BS_PAGE_SIZE), 3185 _spdk_bs_load_replay_md_cpl, ctx); 3186 } 3187 3188 static void 3189 _spdk_bs_load_replay_md(spdk_bs_sequence_t *seq, void *cb_arg) 3190 { 3191 struct spdk_bs_load_ctx *ctx = cb_arg; 3192 3193 ctx->page_index = 0; 3194 ctx->cur_page = 0; 3195 ctx->page = spdk_zmalloc(SPDK_BS_PAGE_SIZE, SPDK_BS_PAGE_SIZE, 3196 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3197 if (!ctx->page) { 3198 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 3199 return; 3200 } 3201 _spdk_bs_load_replay_cur_md_page(seq, cb_arg); 3202 } 3203 3204 static void 3205 _spdk_bs_recover(spdk_bs_sequence_t *seq, void *cb_arg) 3206 { 3207 struct spdk_bs_load_ctx *ctx = cb_arg; 3208 int rc; 3209 3210 rc = spdk_bit_array_resize(&ctx->bs->used_md_pages, ctx->super->md_len); 3211 if (rc < 0) { 3212 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 3213 return; 3214 } 3215 3216 rc = spdk_bit_array_resize(&ctx->bs->used_blobids, ctx->super->md_len); 3217 if (rc < 0) { 3218 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 3219 return; 3220 } 3221 3222 rc = spdk_bit_array_resize(&ctx->bs->used_clusters, ctx->bs->total_clusters); 3223 if (rc < 0) { 3224 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 3225 return; 3226 } 3227 3228 ctx->bs->num_free_clusters = ctx->bs->total_clusters; 3229 _spdk_bs_load_replay_md(seq, cb_arg); 3230 } 3231 3232 static void 3233 _spdk_bs_load_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3234 { 3235 struct spdk_bs_load_ctx *ctx = cb_arg; 3236 uint32_t crc; 3237 int rc; 3238 static const char zeros[SPDK_BLOBSTORE_TYPE_LENGTH]; 3239 3240 if (ctx->super->version > SPDK_BS_VERSION || 3241 ctx->super->version < SPDK_BS_INITIAL_VERSION) { 3242 _spdk_bs_load_ctx_fail(seq, ctx, -EILSEQ); 3243 return; 3244 } 3245 3246 if (memcmp(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 3247 sizeof(ctx->super->signature)) != 0) { 3248 _spdk_bs_load_ctx_fail(seq, ctx, -EILSEQ); 3249 return; 3250 } 3251 3252 crc = _spdk_blob_md_page_calc_crc(ctx->super); 3253 if (crc != ctx->super->crc) { 3254 _spdk_bs_load_ctx_fail(seq, ctx, -EILSEQ); 3255 return; 3256 } 3257 3258 if (memcmp(&ctx->bs->bstype, &ctx->super->bstype, SPDK_BLOBSTORE_TYPE_LENGTH) == 0) { 3259 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Bstype matched - loading blobstore\n"); 3260 } else if (memcmp(&ctx->bs->bstype, zeros, SPDK_BLOBSTORE_TYPE_LENGTH) == 0) { 3261 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Bstype wildcard used - loading blobstore regardless bstype\n"); 3262 } else { 3263 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Unexpected bstype\n"); 3264 SPDK_LOGDUMP(SPDK_LOG_BLOB, "Expected:", ctx->bs->bstype.bstype, SPDK_BLOBSTORE_TYPE_LENGTH); 3265 SPDK_LOGDUMP(SPDK_LOG_BLOB, "Found:", ctx->super->bstype.bstype, SPDK_BLOBSTORE_TYPE_LENGTH); 3266 _spdk_bs_load_ctx_fail(seq, ctx, -ENXIO); 3267 return; 3268 } 3269 3270 if (ctx->super->size > ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen) { 3271 SPDK_NOTICELOG("Size mismatch, dev size: %lu, blobstore size: %lu\n", 3272 ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen, ctx->super->size); 3273 _spdk_bs_load_ctx_fail(seq, ctx, -EILSEQ); 3274 return; 3275 } 3276 3277 if (ctx->super->size == 0) { 3278 ctx->super->size = ctx->bs->dev->blockcnt * ctx->bs->dev->blocklen; 3279 } 3280 3281 if (ctx->super->io_unit_size == 0) { 3282 ctx->super->io_unit_size = SPDK_BS_PAGE_SIZE; 3283 } 3284 3285 /* Parse the super block */ 3286 ctx->bs->clean = 1; 3287 ctx->bs->cluster_sz = ctx->super->cluster_size; 3288 ctx->bs->total_clusters = ctx->super->size / ctx->super->cluster_size; 3289 ctx->bs->pages_per_cluster = ctx->bs->cluster_sz / SPDK_BS_PAGE_SIZE; 3290 ctx->bs->io_unit_size = ctx->super->io_unit_size; 3291 rc = spdk_bit_array_resize(&ctx->bs->used_clusters, ctx->bs->total_clusters); 3292 if (rc < 0) { 3293 _spdk_bs_load_ctx_fail(seq, ctx, -ENOMEM); 3294 return; 3295 } 3296 ctx->bs->md_start = ctx->super->md_start; 3297 ctx->bs->md_len = ctx->super->md_len; 3298 ctx->bs->total_data_clusters = ctx->bs->total_clusters - spdk_divide_round_up( 3299 ctx->bs->md_start + ctx->bs->md_len, ctx->bs->pages_per_cluster); 3300 ctx->bs->super_blob = ctx->super->super_blob; 3301 memcpy(&ctx->bs->bstype, &ctx->super->bstype, sizeof(ctx->super->bstype)); 3302 3303 if (ctx->super->used_blobid_mask_len == 0 || ctx->super->clean == 0) { 3304 _spdk_bs_recover(seq, ctx); 3305 } else { 3306 _spdk_bs_load_read_used_pages(seq, ctx); 3307 } 3308 } 3309 3310 void 3311 spdk_bs_load(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 3312 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 3313 { 3314 struct spdk_blob_store *bs; 3315 struct spdk_bs_cpl cpl; 3316 spdk_bs_sequence_t *seq; 3317 struct spdk_bs_load_ctx *ctx; 3318 struct spdk_bs_opts opts = {}; 3319 int err; 3320 3321 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Loading blobstore from dev %p\n", dev); 3322 3323 if ((SPDK_BS_PAGE_SIZE % dev->blocklen) != 0) { 3324 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "unsupported dev block length of %d\n", dev->blocklen); 3325 dev->destroy(dev); 3326 cb_fn(cb_arg, NULL, -EINVAL); 3327 return; 3328 } 3329 3330 if (o) { 3331 opts = *o; 3332 } else { 3333 spdk_bs_opts_init(&opts); 3334 } 3335 3336 if (opts.max_md_ops == 0 || opts.max_channel_ops == 0) { 3337 dev->destroy(dev); 3338 cb_fn(cb_arg, NULL, -EINVAL); 3339 return; 3340 } 3341 3342 err = _spdk_bs_alloc(dev, &opts, &bs); 3343 if (err) { 3344 dev->destroy(dev); 3345 cb_fn(cb_arg, NULL, err); 3346 return; 3347 } 3348 3349 ctx = calloc(1, sizeof(*ctx)); 3350 if (!ctx) { 3351 _spdk_bs_free(bs); 3352 cb_fn(cb_arg, NULL, -ENOMEM); 3353 return; 3354 } 3355 3356 ctx->bs = bs; 3357 ctx->iter_cb_fn = opts.iter_cb_fn; 3358 ctx->iter_cb_arg = opts.iter_cb_arg; 3359 3360 /* Allocate memory for the super block */ 3361 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 3362 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3363 if (!ctx->super) { 3364 free(ctx); 3365 _spdk_bs_free(bs); 3366 cb_fn(cb_arg, NULL, -ENOMEM); 3367 return; 3368 } 3369 3370 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 3371 cpl.u.bs_handle.cb_fn = cb_fn; 3372 cpl.u.bs_handle.cb_arg = cb_arg; 3373 cpl.u.bs_handle.bs = bs; 3374 3375 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 3376 if (!seq) { 3377 spdk_free(ctx->super); 3378 free(ctx); 3379 _spdk_bs_free(bs); 3380 cb_fn(cb_arg, NULL, -ENOMEM); 3381 return; 3382 } 3383 3384 /* Read the super block */ 3385 spdk_bs_sequence_read_dev(seq, ctx->super, _spdk_bs_page_to_lba(bs, 0), 3386 _spdk_bs_byte_to_lba(bs, sizeof(*ctx->super)), 3387 _spdk_bs_load_super_cpl, ctx); 3388 } 3389 3390 /* END spdk_bs_load */ 3391 3392 /* START spdk_bs_dump */ 3393 3394 struct spdk_bs_dump_ctx { 3395 struct spdk_blob_store *bs; 3396 struct spdk_bs_super_block *super; 3397 uint32_t cur_page; 3398 struct spdk_blob_md_page *page; 3399 spdk_bs_sequence_t *seq; 3400 FILE *fp; 3401 spdk_bs_dump_print_xattr print_xattr_fn; 3402 char xattr_name[4096]; 3403 }; 3404 3405 static void 3406 _spdk_bs_dump_finish(spdk_bs_sequence_t *seq, struct spdk_bs_dump_ctx *ctx, int bserrno) 3407 { 3408 spdk_free(ctx->super); 3409 3410 /* 3411 * We need to defer calling spdk_bs_call_cpl() until after 3412 * dev destruction, so tuck these away for later use. 3413 */ 3414 ctx->bs->unload_err = bserrno; 3415 memcpy(&ctx->bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 3416 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 3417 3418 spdk_bs_sequence_finish(seq, 0); 3419 _spdk_bs_free(ctx->bs); 3420 free(ctx); 3421 } 3422 3423 static void _spdk_bs_dump_read_md_page(spdk_bs_sequence_t *seq, void *cb_arg); 3424 3425 static void 3426 _spdk_bs_dump_print_md_page(struct spdk_bs_dump_ctx *ctx) 3427 { 3428 uint32_t page_idx = ctx->cur_page; 3429 struct spdk_blob_md_page *page = ctx->page; 3430 struct spdk_blob_md_descriptor *desc; 3431 size_t cur_desc = 0; 3432 uint32_t crc; 3433 3434 fprintf(ctx->fp, "=========\n"); 3435 fprintf(ctx->fp, "Metadata Page Index: %" PRIu32 " (0x%" PRIx32 ")\n", page_idx, page_idx); 3436 fprintf(ctx->fp, "Blob ID: 0x%" PRIx64 "\n", page->id); 3437 3438 crc = _spdk_blob_md_page_calc_crc(page); 3439 fprintf(ctx->fp, "CRC: 0x%" PRIx32 " (%s)\n", page->crc, crc == page->crc ? "OK" : "Mismatch"); 3440 3441 desc = (struct spdk_blob_md_descriptor *)page->descriptors; 3442 while (cur_desc < sizeof(page->descriptors)) { 3443 if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_PADDING) { 3444 if (desc->length == 0) { 3445 /* If padding and length are 0, this terminates the page */ 3446 break; 3447 } 3448 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_EXTENT) { 3449 struct spdk_blob_md_descriptor_extent *desc_extent; 3450 unsigned int i; 3451 3452 desc_extent = (struct spdk_blob_md_descriptor_extent *)desc; 3453 3454 for (i = 0; i < desc_extent->length / sizeof(desc_extent->extents[0]); i++) { 3455 if (desc_extent->extents[i].cluster_idx != 0) { 3456 fprintf(ctx->fp, "Allocated Extent - Start: %" PRIu32, 3457 desc_extent->extents[i].cluster_idx); 3458 } else { 3459 fprintf(ctx->fp, "Unallocated Extent - "); 3460 } 3461 fprintf(ctx->fp, " Length: %" PRIu32, desc_extent->extents[i].length); 3462 fprintf(ctx->fp, "\n"); 3463 } 3464 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR) { 3465 struct spdk_blob_md_descriptor_xattr *desc_xattr; 3466 uint32_t i; 3467 3468 desc_xattr = (struct spdk_blob_md_descriptor_xattr *)desc; 3469 3470 if (desc_xattr->length != 3471 sizeof(desc_xattr->name_length) + sizeof(desc_xattr->value_length) + 3472 desc_xattr->name_length + desc_xattr->value_length) { 3473 } 3474 3475 memcpy(ctx->xattr_name, desc_xattr->name, desc_xattr->name_length); 3476 ctx->xattr_name[desc_xattr->name_length] = '\0'; 3477 fprintf(ctx->fp, "XATTR: name = \"%s\"\n", ctx->xattr_name); 3478 fprintf(ctx->fp, " value = \""); 3479 ctx->print_xattr_fn(ctx->fp, ctx->super->bstype.bstype, ctx->xattr_name, 3480 (void *)((uintptr_t)desc_xattr->name + desc_xattr->name_length), 3481 desc_xattr->value_length); 3482 fprintf(ctx->fp, "\"\n"); 3483 for (i = 0; i < desc_xattr->value_length; i++) { 3484 if (i % 16 == 0) { 3485 fprintf(ctx->fp, " "); 3486 } 3487 fprintf(ctx->fp, "%02" PRIx8 " ", *((uint8_t *)desc_xattr->name + desc_xattr->name_length + i)); 3488 if ((i + 1) % 16 == 0) { 3489 fprintf(ctx->fp, "\n"); 3490 } 3491 } 3492 if (i % 16 != 0) { 3493 fprintf(ctx->fp, "\n"); 3494 } 3495 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL) { 3496 /* TODO */ 3497 } else if (desc->type == SPDK_MD_DESCRIPTOR_TYPE_FLAGS) { 3498 /* TODO */ 3499 } else { 3500 /* Error */ 3501 } 3502 /* Advance to the next descriptor */ 3503 cur_desc += sizeof(*desc) + desc->length; 3504 if (cur_desc + sizeof(*desc) > sizeof(page->descriptors)) { 3505 break; 3506 } 3507 desc = (struct spdk_blob_md_descriptor *)((uintptr_t)page->descriptors + cur_desc); 3508 } 3509 } 3510 3511 static void 3512 _spdk_bs_dump_read_md_page_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3513 { 3514 struct spdk_bs_dump_ctx *ctx = cb_arg; 3515 3516 if (bserrno != 0) { 3517 _spdk_bs_dump_finish(seq, ctx, bserrno); 3518 return; 3519 } 3520 3521 if (ctx->page->id != 0) { 3522 _spdk_bs_dump_print_md_page(ctx); 3523 } 3524 3525 ctx->cur_page++; 3526 3527 if (ctx->cur_page < ctx->super->md_len) { 3528 _spdk_bs_dump_read_md_page(seq, cb_arg); 3529 } else { 3530 spdk_free(ctx->page); 3531 _spdk_bs_dump_finish(seq, ctx, 0); 3532 } 3533 } 3534 3535 static void 3536 _spdk_bs_dump_read_md_page(spdk_bs_sequence_t *seq, void *cb_arg) 3537 { 3538 struct spdk_bs_dump_ctx *ctx = cb_arg; 3539 uint64_t lba; 3540 3541 assert(ctx->cur_page < ctx->super->md_len); 3542 lba = _spdk_bs_page_to_lba(ctx->bs, ctx->super->md_start + ctx->cur_page); 3543 spdk_bs_sequence_read_dev(seq, ctx->page, lba, 3544 _spdk_bs_byte_to_lba(ctx->bs, SPDK_BS_PAGE_SIZE), 3545 _spdk_bs_dump_read_md_page_cpl, ctx); 3546 } 3547 3548 static void 3549 _spdk_bs_dump_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3550 { 3551 struct spdk_bs_dump_ctx *ctx = cb_arg; 3552 3553 fprintf(ctx->fp, "Signature: \"%.8s\" ", ctx->super->signature); 3554 if (memcmp(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 3555 sizeof(ctx->super->signature)) != 0) { 3556 fprintf(ctx->fp, "(Mismatch)\n"); 3557 _spdk_bs_dump_finish(seq, ctx, bserrno); 3558 return; 3559 } else { 3560 fprintf(ctx->fp, "(OK)\n"); 3561 } 3562 fprintf(ctx->fp, "Version: %" PRIu32 "\n", ctx->super->version); 3563 fprintf(ctx->fp, "CRC: 0x%x (%s)\n", ctx->super->crc, 3564 (ctx->super->crc == _spdk_blob_md_page_calc_crc(ctx->super)) ? "OK" : "Mismatch"); 3565 fprintf(ctx->fp, "Blobstore Type: %.*s\n", SPDK_BLOBSTORE_TYPE_LENGTH, ctx->super->bstype.bstype); 3566 fprintf(ctx->fp, "Cluster Size: %" PRIu32 "\n", ctx->super->cluster_size); 3567 fprintf(ctx->fp, "Super Blob ID: "); 3568 if (ctx->super->super_blob == SPDK_BLOBID_INVALID) { 3569 fprintf(ctx->fp, "(None)\n"); 3570 } else { 3571 fprintf(ctx->fp, "%" PRIu64 "\n", ctx->super->super_blob); 3572 } 3573 fprintf(ctx->fp, "Clean: %" PRIu32 "\n", ctx->super->clean); 3574 fprintf(ctx->fp, "Used Metadata Page Mask Start: %" PRIu32 "\n", ctx->super->used_page_mask_start); 3575 fprintf(ctx->fp, "Used Metadata Page Mask Length: %" PRIu32 "\n", ctx->super->used_page_mask_len); 3576 fprintf(ctx->fp, "Used Cluster Mask Start: %" PRIu32 "\n", ctx->super->used_cluster_mask_start); 3577 fprintf(ctx->fp, "Used Cluster Mask Length: %" PRIu32 "\n", ctx->super->used_cluster_mask_len); 3578 fprintf(ctx->fp, "Used Blob ID Mask Start: %" PRIu32 "\n", ctx->super->used_blobid_mask_start); 3579 fprintf(ctx->fp, "Used Blob ID Mask Length: %" PRIu32 "\n", ctx->super->used_blobid_mask_len); 3580 fprintf(ctx->fp, "Metadata Start: %" PRIu32 "\n", ctx->super->md_start); 3581 fprintf(ctx->fp, "Metadata Length: %" PRIu32 "\n", ctx->super->md_len); 3582 3583 ctx->cur_page = 0; 3584 ctx->page = spdk_zmalloc(SPDK_BS_PAGE_SIZE, SPDK_BS_PAGE_SIZE, 3585 NULL, SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3586 if (!ctx->page) { 3587 _spdk_bs_dump_finish(seq, ctx, -ENOMEM); 3588 return; 3589 } 3590 _spdk_bs_dump_read_md_page(seq, cb_arg); 3591 } 3592 3593 void 3594 spdk_bs_dump(struct spdk_bs_dev *dev, FILE *fp, spdk_bs_dump_print_xattr print_xattr_fn, 3595 spdk_bs_op_complete cb_fn, void *cb_arg) 3596 { 3597 struct spdk_blob_store *bs; 3598 struct spdk_bs_cpl cpl; 3599 spdk_bs_sequence_t *seq; 3600 struct spdk_bs_dump_ctx *ctx; 3601 struct spdk_bs_opts opts = {}; 3602 int err; 3603 3604 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Dumping blobstore from dev %p\n", dev); 3605 3606 spdk_bs_opts_init(&opts); 3607 3608 err = _spdk_bs_alloc(dev, &opts, &bs); 3609 if (err) { 3610 dev->destroy(dev); 3611 cb_fn(cb_arg, err); 3612 return; 3613 } 3614 3615 ctx = calloc(1, sizeof(*ctx)); 3616 if (!ctx) { 3617 _spdk_bs_free(bs); 3618 cb_fn(cb_arg, -ENOMEM); 3619 return; 3620 } 3621 3622 ctx->bs = bs; 3623 ctx->fp = fp; 3624 ctx->print_xattr_fn = print_xattr_fn; 3625 3626 /* Allocate memory for the super block */ 3627 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 3628 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3629 if (!ctx->super) { 3630 free(ctx); 3631 _spdk_bs_free(bs); 3632 cb_fn(cb_arg, -ENOMEM); 3633 return; 3634 } 3635 3636 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 3637 cpl.u.bs_basic.cb_fn = cb_fn; 3638 cpl.u.bs_basic.cb_arg = cb_arg; 3639 3640 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 3641 if (!seq) { 3642 spdk_free(ctx->super); 3643 free(ctx); 3644 _spdk_bs_free(bs); 3645 cb_fn(cb_arg, -ENOMEM); 3646 return; 3647 } 3648 3649 /* Read the super block */ 3650 spdk_bs_sequence_read_dev(seq, ctx->super, _spdk_bs_page_to_lba(bs, 0), 3651 _spdk_bs_byte_to_lba(bs, sizeof(*ctx->super)), 3652 _spdk_bs_dump_super_cpl, ctx); 3653 } 3654 3655 /* END spdk_bs_dump */ 3656 3657 /* START spdk_bs_init */ 3658 3659 struct spdk_bs_init_ctx { 3660 struct spdk_blob_store *bs; 3661 struct spdk_bs_super_block *super; 3662 }; 3663 3664 static void 3665 _spdk_bs_init_persist_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3666 { 3667 struct spdk_bs_init_ctx *ctx = cb_arg; 3668 3669 spdk_free(ctx->super); 3670 free(ctx); 3671 3672 spdk_bs_sequence_finish(seq, bserrno); 3673 } 3674 3675 static void 3676 _spdk_bs_init_trim_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3677 { 3678 struct spdk_bs_init_ctx *ctx = cb_arg; 3679 3680 /* Write super block */ 3681 spdk_bs_sequence_write_dev(seq, ctx->super, _spdk_bs_page_to_lba(ctx->bs, 0), 3682 _spdk_bs_byte_to_lba(ctx->bs, sizeof(*ctx->super)), 3683 _spdk_bs_init_persist_super_cpl, ctx); 3684 } 3685 3686 void 3687 spdk_bs_init(struct spdk_bs_dev *dev, struct spdk_bs_opts *o, 3688 spdk_bs_op_with_handle_complete cb_fn, void *cb_arg) 3689 { 3690 struct spdk_bs_init_ctx *ctx; 3691 struct spdk_blob_store *bs; 3692 struct spdk_bs_cpl cpl; 3693 spdk_bs_sequence_t *seq; 3694 spdk_bs_batch_t *batch; 3695 uint64_t num_md_lba; 3696 uint64_t num_md_pages; 3697 uint64_t num_md_clusters; 3698 uint32_t i; 3699 struct spdk_bs_opts opts = {}; 3700 int rc; 3701 3702 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Initializing blobstore on dev %p\n", dev); 3703 3704 if ((SPDK_BS_PAGE_SIZE % dev->blocklen) != 0) { 3705 SPDK_ERRLOG("unsupported dev block length of %d\n", 3706 dev->blocklen); 3707 dev->destroy(dev); 3708 cb_fn(cb_arg, NULL, -EINVAL); 3709 return; 3710 } 3711 3712 if (o) { 3713 opts = *o; 3714 } else { 3715 spdk_bs_opts_init(&opts); 3716 } 3717 3718 if (_spdk_bs_opts_verify(&opts) != 0) { 3719 dev->destroy(dev); 3720 cb_fn(cb_arg, NULL, -EINVAL); 3721 return; 3722 } 3723 3724 rc = _spdk_bs_alloc(dev, &opts, &bs); 3725 if (rc) { 3726 dev->destroy(dev); 3727 cb_fn(cb_arg, NULL, rc); 3728 return; 3729 } 3730 3731 if (opts.num_md_pages == SPDK_BLOB_OPTS_NUM_MD_PAGES) { 3732 /* By default, allocate 1 page per cluster. 3733 * Technically, this over-allocates metadata 3734 * because more metadata will reduce the number 3735 * of usable clusters. This can be addressed with 3736 * more complex math in the future. 3737 */ 3738 bs->md_len = bs->total_clusters; 3739 } else { 3740 bs->md_len = opts.num_md_pages; 3741 } 3742 rc = spdk_bit_array_resize(&bs->used_md_pages, bs->md_len); 3743 if (rc < 0) { 3744 _spdk_bs_free(bs); 3745 cb_fn(cb_arg, NULL, -ENOMEM); 3746 return; 3747 } 3748 3749 rc = spdk_bit_array_resize(&bs->used_blobids, bs->md_len); 3750 if (rc < 0) { 3751 _spdk_bs_free(bs); 3752 cb_fn(cb_arg, NULL, -ENOMEM); 3753 return; 3754 } 3755 3756 ctx = calloc(1, sizeof(*ctx)); 3757 if (!ctx) { 3758 _spdk_bs_free(bs); 3759 cb_fn(cb_arg, NULL, -ENOMEM); 3760 return; 3761 } 3762 3763 ctx->bs = bs; 3764 3765 /* Allocate memory for the super block */ 3766 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 3767 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 3768 if (!ctx->super) { 3769 free(ctx); 3770 _spdk_bs_free(bs); 3771 cb_fn(cb_arg, NULL, -ENOMEM); 3772 return; 3773 } 3774 memcpy(ctx->super->signature, SPDK_BS_SUPER_BLOCK_SIG, 3775 sizeof(ctx->super->signature)); 3776 ctx->super->version = SPDK_BS_VERSION; 3777 ctx->super->length = sizeof(*ctx->super); 3778 ctx->super->super_blob = bs->super_blob; 3779 ctx->super->clean = 0; 3780 ctx->super->cluster_size = bs->cluster_sz; 3781 ctx->super->io_unit_size = bs->io_unit_size; 3782 memcpy(&ctx->super->bstype, &bs->bstype, sizeof(bs->bstype)); 3783 3784 /* Calculate how many pages the metadata consumes at the front 3785 * of the disk. 3786 */ 3787 3788 /* The super block uses 1 page */ 3789 num_md_pages = 1; 3790 3791 /* The used_md_pages mask requires 1 bit per metadata page, rounded 3792 * up to the nearest page, plus a header. 3793 */ 3794 ctx->super->used_page_mask_start = num_md_pages; 3795 ctx->super->used_page_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 3796 spdk_divide_round_up(bs->md_len, 8), 3797 SPDK_BS_PAGE_SIZE); 3798 num_md_pages += ctx->super->used_page_mask_len; 3799 3800 /* The used_clusters mask requires 1 bit per cluster, rounded 3801 * up to the nearest page, plus a header. 3802 */ 3803 ctx->super->used_cluster_mask_start = num_md_pages; 3804 ctx->super->used_cluster_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 3805 spdk_divide_round_up(bs->total_clusters, 8), 3806 SPDK_BS_PAGE_SIZE); 3807 num_md_pages += ctx->super->used_cluster_mask_len; 3808 3809 /* The used_blobids mask requires 1 bit per metadata page, rounded 3810 * up to the nearest page, plus a header. 3811 */ 3812 ctx->super->used_blobid_mask_start = num_md_pages; 3813 ctx->super->used_blobid_mask_len = spdk_divide_round_up(sizeof(struct spdk_bs_md_mask) + 3814 spdk_divide_round_up(bs->md_len, 8), 3815 SPDK_BS_PAGE_SIZE); 3816 num_md_pages += ctx->super->used_blobid_mask_len; 3817 3818 /* The metadata region size was chosen above */ 3819 ctx->super->md_start = bs->md_start = num_md_pages; 3820 ctx->super->md_len = bs->md_len; 3821 num_md_pages += bs->md_len; 3822 3823 num_md_lba = _spdk_bs_page_to_lba(bs, num_md_pages); 3824 3825 ctx->super->size = dev->blockcnt * dev->blocklen; 3826 3827 ctx->super->crc = _spdk_blob_md_page_calc_crc(ctx->super); 3828 3829 num_md_clusters = spdk_divide_round_up(num_md_pages, bs->pages_per_cluster); 3830 if (num_md_clusters > bs->total_clusters) { 3831 SPDK_ERRLOG("Blobstore metadata cannot use more clusters than is available, " 3832 "please decrease number of pages reserved for metadata " 3833 "or increase cluster size.\n"); 3834 spdk_free(ctx->super); 3835 free(ctx); 3836 _spdk_bs_free(bs); 3837 cb_fn(cb_arg, NULL, -ENOMEM); 3838 return; 3839 } 3840 /* Claim all of the clusters used by the metadata */ 3841 for (i = 0; i < num_md_clusters; i++) { 3842 _spdk_bs_claim_cluster(bs, i); 3843 } 3844 3845 bs->total_data_clusters = bs->num_free_clusters; 3846 3847 cpl.type = SPDK_BS_CPL_TYPE_BS_HANDLE; 3848 cpl.u.bs_handle.cb_fn = cb_fn; 3849 cpl.u.bs_handle.cb_arg = cb_arg; 3850 cpl.u.bs_handle.bs = bs; 3851 3852 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 3853 if (!seq) { 3854 spdk_free(ctx->super); 3855 free(ctx); 3856 _spdk_bs_free(bs); 3857 cb_fn(cb_arg, NULL, -ENOMEM); 3858 return; 3859 } 3860 3861 batch = spdk_bs_sequence_to_batch(seq, _spdk_bs_init_trim_cpl, ctx); 3862 3863 /* Clear metadata space */ 3864 spdk_bs_batch_write_zeroes_dev(batch, 0, num_md_lba); 3865 3866 if (opts.clear_method == BS_CLEAR_WITH_UNMAP) { 3867 /* Trim data clusters */ 3868 spdk_bs_batch_unmap_dev(batch, num_md_lba, ctx->bs->dev->blockcnt - num_md_lba); 3869 } else if (opts.clear_method == BS_CLEAR_WITH_WRITE_ZEROES) { 3870 /* Write_zeroes to data clusters */ 3871 spdk_bs_batch_write_zeroes_dev(batch, num_md_lba, ctx->bs->dev->blockcnt - num_md_lba); 3872 } 3873 3874 spdk_bs_batch_close(batch); 3875 } 3876 3877 /* END spdk_bs_init */ 3878 3879 /* START spdk_bs_destroy */ 3880 3881 static void 3882 _spdk_bs_destroy_trim_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3883 { 3884 struct spdk_bs_init_ctx *ctx = cb_arg; 3885 struct spdk_blob_store *bs = ctx->bs; 3886 3887 /* 3888 * We need to defer calling spdk_bs_call_cpl() until after 3889 * dev destruction, so tuck these away for later use. 3890 */ 3891 bs->unload_err = bserrno; 3892 memcpy(&bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 3893 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 3894 3895 spdk_bs_sequence_finish(seq, bserrno); 3896 3897 _spdk_bs_free(bs); 3898 free(ctx); 3899 } 3900 3901 void 3902 spdk_bs_destroy(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, 3903 void *cb_arg) 3904 { 3905 struct spdk_bs_cpl cpl; 3906 spdk_bs_sequence_t *seq; 3907 struct spdk_bs_init_ctx *ctx; 3908 3909 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Destroying blobstore\n"); 3910 3911 if (!TAILQ_EMPTY(&bs->blobs)) { 3912 SPDK_ERRLOG("Blobstore still has open blobs\n"); 3913 cb_fn(cb_arg, -EBUSY); 3914 return; 3915 } 3916 3917 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 3918 cpl.u.bs_basic.cb_fn = cb_fn; 3919 cpl.u.bs_basic.cb_arg = cb_arg; 3920 3921 ctx = calloc(1, sizeof(*ctx)); 3922 if (!ctx) { 3923 cb_fn(cb_arg, -ENOMEM); 3924 return; 3925 } 3926 3927 ctx->bs = bs; 3928 3929 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 3930 if (!seq) { 3931 free(ctx); 3932 cb_fn(cb_arg, -ENOMEM); 3933 return; 3934 } 3935 3936 /* Write zeroes to the super block */ 3937 spdk_bs_sequence_write_zeroes_dev(seq, 3938 _spdk_bs_page_to_lba(bs, 0), 3939 _spdk_bs_byte_to_lba(bs, sizeof(struct spdk_bs_super_block)), 3940 _spdk_bs_destroy_trim_cpl, ctx); 3941 } 3942 3943 /* END spdk_bs_destroy */ 3944 3945 /* START spdk_bs_unload */ 3946 3947 static void 3948 _spdk_bs_unload_write_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3949 { 3950 struct spdk_bs_load_ctx *ctx = cb_arg; 3951 3952 spdk_free(ctx->super); 3953 3954 /* 3955 * We need to defer calling spdk_bs_call_cpl() until after 3956 * dev destruction, so tuck these away for later use. 3957 */ 3958 ctx->bs->unload_err = bserrno; 3959 memcpy(&ctx->bs->unload_cpl, &seq->cpl, sizeof(struct spdk_bs_cpl)); 3960 seq->cpl.type = SPDK_BS_CPL_TYPE_NONE; 3961 3962 spdk_bs_sequence_finish(seq, bserrno); 3963 3964 _spdk_bs_free(ctx->bs); 3965 free(ctx); 3966 } 3967 3968 static void 3969 _spdk_bs_unload_write_used_clusters_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3970 { 3971 struct spdk_bs_load_ctx *ctx = cb_arg; 3972 3973 spdk_free(ctx->mask); 3974 ctx->super->clean = 1; 3975 3976 _spdk_bs_write_super(seq, ctx->bs, ctx->super, _spdk_bs_unload_write_super_cpl, ctx); 3977 } 3978 3979 static void 3980 _spdk_bs_unload_write_used_blobids_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3981 { 3982 struct spdk_bs_load_ctx *ctx = cb_arg; 3983 3984 spdk_free(ctx->mask); 3985 ctx->mask = NULL; 3986 3987 _spdk_bs_write_used_clusters(seq, cb_arg, _spdk_bs_unload_write_used_clusters_cpl); 3988 } 3989 3990 static void 3991 _spdk_bs_unload_write_used_pages_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 3992 { 3993 struct spdk_bs_load_ctx *ctx = cb_arg; 3994 3995 spdk_free(ctx->mask); 3996 ctx->mask = NULL; 3997 3998 _spdk_bs_write_used_blobids(seq, cb_arg, _spdk_bs_unload_write_used_blobids_cpl); 3999 } 4000 4001 static void 4002 _spdk_bs_unload_read_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4003 { 4004 _spdk_bs_write_used_md(seq, cb_arg, _spdk_bs_unload_write_used_pages_cpl); 4005 } 4006 4007 void 4008 spdk_bs_unload(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, void *cb_arg) 4009 { 4010 struct spdk_bs_cpl cpl; 4011 spdk_bs_sequence_t *seq; 4012 struct spdk_bs_load_ctx *ctx; 4013 4014 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Syncing blobstore\n"); 4015 4016 if (!TAILQ_EMPTY(&bs->blobs)) { 4017 SPDK_ERRLOG("Blobstore still has open blobs\n"); 4018 cb_fn(cb_arg, -EBUSY); 4019 return; 4020 } 4021 4022 ctx = calloc(1, sizeof(*ctx)); 4023 if (!ctx) { 4024 cb_fn(cb_arg, -ENOMEM); 4025 return; 4026 } 4027 4028 ctx->bs = bs; 4029 4030 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 4031 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 4032 if (!ctx->super) { 4033 free(ctx); 4034 cb_fn(cb_arg, -ENOMEM); 4035 return; 4036 } 4037 4038 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 4039 cpl.u.bs_basic.cb_fn = cb_fn; 4040 cpl.u.bs_basic.cb_arg = cb_arg; 4041 4042 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 4043 if (!seq) { 4044 spdk_free(ctx->super); 4045 free(ctx); 4046 cb_fn(cb_arg, -ENOMEM); 4047 return; 4048 } 4049 4050 /* Read super block */ 4051 spdk_bs_sequence_read_dev(seq, ctx->super, _spdk_bs_page_to_lba(bs, 0), 4052 _spdk_bs_byte_to_lba(bs, sizeof(*ctx->super)), 4053 _spdk_bs_unload_read_super_cpl, ctx); 4054 } 4055 4056 /* END spdk_bs_unload */ 4057 4058 /* START spdk_bs_set_super */ 4059 4060 struct spdk_bs_set_super_ctx { 4061 struct spdk_blob_store *bs; 4062 struct spdk_bs_super_block *super; 4063 }; 4064 4065 static void 4066 _spdk_bs_set_super_write_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4067 { 4068 struct spdk_bs_set_super_ctx *ctx = cb_arg; 4069 4070 if (bserrno != 0) { 4071 SPDK_ERRLOG("Unable to write to super block of blobstore\n"); 4072 } 4073 4074 spdk_free(ctx->super); 4075 4076 spdk_bs_sequence_finish(seq, bserrno); 4077 4078 free(ctx); 4079 } 4080 4081 static void 4082 _spdk_bs_set_super_read_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4083 { 4084 struct spdk_bs_set_super_ctx *ctx = cb_arg; 4085 4086 if (bserrno != 0) { 4087 SPDK_ERRLOG("Unable to read super block of blobstore\n"); 4088 spdk_free(ctx->super); 4089 spdk_bs_sequence_finish(seq, bserrno); 4090 free(ctx); 4091 return; 4092 } 4093 4094 _spdk_bs_write_super(seq, ctx->bs, ctx->super, _spdk_bs_set_super_write_cpl, ctx); 4095 } 4096 4097 void 4098 spdk_bs_set_super(struct spdk_blob_store *bs, spdk_blob_id blobid, 4099 spdk_bs_op_complete cb_fn, void *cb_arg) 4100 { 4101 struct spdk_bs_cpl cpl; 4102 spdk_bs_sequence_t *seq; 4103 struct spdk_bs_set_super_ctx *ctx; 4104 4105 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Setting super blob id on blobstore\n"); 4106 4107 ctx = calloc(1, sizeof(*ctx)); 4108 if (!ctx) { 4109 cb_fn(cb_arg, -ENOMEM); 4110 return; 4111 } 4112 4113 ctx->bs = bs; 4114 4115 ctx->super = spdk_zmalloc(sizeof(*ctx->super), 0x1000, NULL, 4116 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_DMA); 4117 if (!ctx->super) { 4118 free(ctx); 4119 cb_fn(cb_arg, -ENOMEM); 4120 return; 4121 } 4122 4123 cpl.type = SPDK_BS_CPL_TYPE_BS_BASIC; 4124 cpl.u.bs_basic.cb_fn = cb_fn; 4125 cpl.u.bs_basic.cb_arg = cb_arg; 4126 4127 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 4128 if (!seq) { 4129 spdk_free(ctx->super); 4130 free(ctx); 4131 cb_fn(cb_arg, -ENOMEM); 4132 return; 4133 } 4134 4135 bs->super_blob = blobid; 4136 4137 /* Read super block */ 4138 spdk_bs_sequence_read_dev(seq, ctx->super, _spdk_bs_page_to_lba(bs, 0), 4139 _spdk_bs_byte_to_lba(bs, sizeof(*ctx->super)), 4140 _spdk_bs_set_super_read_cpl, ctx); 4141 } 4142 4143 /* END spdk_bs_set_super */ 4144 4145 void 4146 spdk_bs_get_super(struct spdk_blob_store *bs, 4147 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 4148 { 4149 if (bs->super_blob == SPDK_BLOBID_INVALID) { 4150 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOENT); 4151 } else { 4152 cb_fn(cb_arg, bs->super_blob, 0); 4153 } 4154 } 4155 4156 uint64_t 4157 spdk_bs_get_cluster_size(struct spdk_blob_store *bs) 4158 { 4159 return bs->cluster_sz; 4160 } 4161 4162 uint64_t 4163 spdk_bs_get_page_size(struct spdk_blob_store *bs) 4164 { 4165 return SPDK_BS_PAGE_SIZE; 4166 } 4167 4168 uint64_t 4169 spdk_bs_get_io_unit_size(struct spdk_blob_store *bs) 4170 { 4171 return bs->io_unit_size; 4172 } 4173 4174 uint64_t 4175 spdk_bs_free_cluster_count(struct spdk_blob_store *bs) 4176 { 4177 return bs->num_free_clusters; 4178 } 4179 4180 uint64_t 4181 spdk_bs_total_data_cluster_count(struct spdk_blob_store *bs) 4182 { 4183 return bs->total_data_clusters; 4184 } 4185 4186 static int 4187 spdk_bs_register_md_thread(struct spdk_blob_store *bs) 4188 { 4189 bs->md_channel = spdk_get_io_channel(bs); 4190 if (!bs->md_channel) { 4191 SPDK_ERRLOG("Failed to get IO channel.\n"); 4192 return -1; 4193 } 4194 4195 return 0; 4196 } 4197 4198 static int 4199 spdk_bs_unregister_md_thread(struct spdk_blob_store *bs) 4200 { 4201 spdk_put_io_channel(bs->md_channel); 4202 4203 return 0; 4204 } 4205 4206 spdk_blob_id spdk_blob_get_id(struct spdk_blob *blob) 4207 { 4208 assert(blob != NULL); 4209 4210 return blob->id; 4211 } 4212 4213 uint64_t spdk_blob_get_num_pages(struct spdk_blob *blob) 4214 { 4215 assert(blob != NULL); 4216 4217 return _spdk_bs_cluster_to_page(blob->bs, blob->active.num_clusters); 4218 } 4219 4220 uint64_t spdk_blob_get_num_io_units(struct spdk_blob *blob) 4221 { 4222 assert(blob != NULL); 4223 4224 return spdk_blob_get_num_pages(blob) * _spdk_bs_io_unit_per_page(blob->bs); 4225 } 4226 4227 uint64_t spdk_blob_get_num_clusters(struct spdk_blob *blob) 4228 { 4229 assert(blob != NULL); 4230 4231 return blob->active.num_clusters; 4232 } 4233 4234 /* START spdk_bs_create_blob */ 4235 4236 static void 4237 _spdk_bs_create_blob_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 4238 { 4239 struct spdk_blob *blob = cb_arg; 4240 4241 _spdk_blob_free(blob); 4242 4243 spdk_bs_sequence_finish(seq, bserrno); 4244 } 4245 4246 static int 4247 _spdk_blob_set_xattrs(struct spdk_blob *blob, const struct spdk_blob_xattr_opts *xattrs, 4248 bool internal) 4249 { 4250 uint64_t i; 4251 size_t value_len = 0; 4252 int rc; 4253 const void *value = NULL; 4254 if (xattrs->count > 0 && xattrs->get_value == NULL) { 4255 return -EINVAL; 4256 } 4257 for (i = 0; i < xattrs->count; i++) { 4258 xattrs->get_value(xattrs->ctx, xattrs->names[i], &value, &value_len); 4259 if (value == NULL || value_len == 0) { 4260 return -EINVAL; 4261 } 4262 rc = _spdk_blob_set_xattr(blob, xattrs->names[i], value, value_len, internal); 4263 if (rc < 0) { 4264 return rc; 4265 } 4266 } 4267 return 0; 4268 } 4269 4270 static void 4271 _spdk_bs_create_blob(struct spdk_blob_store *bs, 4272 const struct spdk_blob_opts *opts, 4273 const struct spdk_blob_xattr_opts *internal_xattrs, 4274 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 4275 { 4276 struct spdk_blob *blob; 4277 uint32_t page_idx; 4278 struct spdk_bs_cpl cpl; 4279 struct spdk_blob_opts opts_default; 4280 struct spdk_blob_xattr_opts internal_xattrs_default; 4281 spdk_bs_sequence_t *seq; 4282 spdk_blob_id id; 4283 int rc; 4284 4285 assert(spdk_get_thread() == bs->md_thread); 4286 4287 page_idx = spdk_bit_array_find_first_clear(bs->used_md_pages, 0); 4288 if (page_idx == UINT32_MAX) { 4289 cb_fn(cb_arg, 0, -ENOMEM); 4290 return; 4291 } 4292 spdk_bit_array_set(bs->used_blobids, page_idx); 4293 spdk_bit_array_set(bs->used_md_pages, page_idx); 4294 4295 id = _spdk_bs_page_to_blobid(page_idx); 4296 4297 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Creating blob with id %lu at page %u\n", id, page_idx); 4298 4299 blob = _spdk_blob_alloc(bs, id); 4300 if (!blob) { 4301 cb_fn(cb_arg, 0, -ENOMEM); 4302 return; 4303 } 4304 4305 if (!opts) { 4306 spdk_blob_opts_init(&opts_default); 4307 opts = &opts_default; 4308 } 4309 if (!internal_xattrs) { 4310 _spdk_blob_xattrs_init(&internal_xattrs_default); 4311 internal_xattrs = &internal_xattrs_default; 4312 } 4313 4314 rc = _spdk_blob_set_xattrs(blob, &opts->xattrs, false); 4315 if (rc < 0) { 4316 _spdk_blob_free(blob); 4317 cb_fn(cb_arg, 0, rc); 4318 return; 4319 } 4320 4321 rc = _spdk_blob_set_xattrs(blob, internal_xattrs, true); 4322 if (rc < 0) { 4323 _spdk_blob_free(blob); 4324 cb_fn(cb_arg, 0, rc); 4325 return; 4326 } 4327 4328 if (opts->thin_provision) { 4329 _spdk_blob_set_thin_provision(blob); 4330 } 4331 4332 rc = _spdk_blob_resize(blob, opts->num_clusters); 4333 if (rc < 0) { 4334 _spdk_blob_free(blob); 4335 cb_fn(cb_arg, 0, rc); 4336 return; 4337 } 4338 cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 4339 cpl.u.blobid.cb_fn = cb_fn; 4340 cpl.u.blobid.cb_arg = cb_arg; 4341 cpl.u.blobid.blobid = blob->id; 4342 4343 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 4344 if (!seq) { 4345 _spdk_blob_free(blob); 4346 cb_fn(cb_arg, 0, -ENOMEM); 4347 return; 4348 } 4349 4350 _spdk_blob_persist(seq, blob, _spdk_bs_create_blob_cpl, blob); 4351 } 4352 4353 void spdk_bs_create_blob(struct spdk_blob_store *bs, 4354 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 4355 { 4356 _spdk_bs_create_blob(bs, NULL, NULL, cb_fn, cb_arg); 4357 } 4358 4359 void spdk_bs_create_blob_ext(struct spdk_blob_store *bs, const struct spdk_blob_opts *opts, 4360 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 4361 { 4362 _spdk_bs_create_blob(bs, opts, NULL, cb_fn, cb_arg); 4363 } 4364 4365 /* END spdk_bs_create_blob */ 4366 4367 /* START blob_cleanup */ 4368 4369 struct spdk_clone_snapshot_ctx { 4370 struct spdk_bs_cpl cpl; 4371 int bserrno; 4372 bool frozen; 4373 4374 struct spdk_io_channel *channel; 4375 4376 /* Current cluster for inflate operation */ 4377 uint64_t cluster; 4378 4379 /* For inflation force allocation of all unallocated clusters and remove 4380 * thin-provisioning. Otherwise only decouple parent and keep clone thin. */ 4381 bool allocate_all; 4382 4383 struct { 4384 spdk_blob_id id; 4385 struct spdk_blob *blob; 4386 } original; 4387 struct { 4388 spdk_blob_id id; 4389 struct spdk_blob *blob; 4390 } new; 4391 4392 /* xattrs specified for snapshot/clones only. They have no impact on 4393 * the original blobs xattrs. */ 4394 const struct spdk_blob_xattr_opts *xattrs; 4395 }; 4396 4397 static void 4398 _spdk_bs_clone_snapshot_cleanup_finish(void *cb_arg, int bserrno) 4399 { 4400 struct spdk_clone_snapshot_ctx *ctx = cb_arg; 4401 struct spdk_bs_cpl *cpl = &ctx->cpl; 4402 4403 if (bserrno != 0) { 4404 if (ctx->bserrno != 0) { 4405 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 4406 } else { 4407 ctx->bserrno = bserrno; 4408 } 4409 } 4410 4411 switch (cpl->type) { 4412 case SPDK_BS_CPL_TYPE_BLOBID: 4413 cpl->u.blobid.cb_fn(cpl->u.blobid.cb_arg, cpl->u.blobid.blobid, ctx->bserrno); 4414 break; 4415 case SPDK_BS_CPL_TYPE_BLOB_BASIC: 4416 cpl->u.blob_basic.cb_fn(cpl->u.blob_basic.cb_arg, ctx->bserrno); 4417 break; 4418 default: 4419 SPDK_UNREACHABLE(); 4420 break; 4421 } 4422 4423 free(ctx); 4424 } 4425 4426 static void 4427 _spdk_bs_snapshot_unfreeze_cpl(void *cb_arg, int bserrno) 4428 { 4429 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4430 struct spdk_blob *origblob = ctx->original.blob; 4431 4432 if (bserrno != 0) { 4433 if (ctx->bserrno != 0) { 4434 SPDK_ERRLOG("Unfreeze error %d\n", bserrno); 4435 } else { 4436 ctx->bserrno = bserrno; 4437 } 4438 } 4439 4440 ctx->original.id = origblob->id; 4441 origblob->locked_operation_in_progress = false; 4442 4443 spdk_blob_close(origblob, _spdk_bs_clone_snapshot_cleanup_finish, ctx); 4444 } 4445 4446 static void 4447 _spdk_bs_clone_snapshot_origblob_cleanup(void *cb_arg, int bserrno) 4448 { 4449 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4450 struct spdk_blob *origblob = ctx->original.blob; 4451 4452 if (bserrno != 0) { 4453 if (ctx->bserrno != 0) { 4454 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 4455 } else { 4456 ctx->bserrno = bserrno; 4457 } 4458 } 4459 4460 if (ctx->frozen) { 4461 /* Unfreeze any outstanding I/O */ 4462 _spdk_blob_unfreeze_io(origblob, _spdk_bs_snapshot_unfreeze_cpl, ctx); 4463 } else { 4464 _spdk_bs_snapshot_unfreeze_cpl(ctx, 0); 4465 } 4466 4467 } 4468 4469 static void 4470 _spdk_bs_clone_snapshot_newblob_cleanup(void *cb_arg, int bserrno) 4471 { 4472 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4473 struct spdk_blob *newblob = ctx->new.blob; 4474 4475 if (bserrno != 0) { 4476 if (ctx->bserrno != 0) { 4477 SPDK_ERRLOG("Cleanup error %d\n", bserrno); 4478 } else { 4479 ctx->bserrno = bserrno; 4480 } 4481 } 4482 4483 ctx->new.id = newblob->id; 4484 spdk_blob_close(newblob, _spdk_bs_clone_snapshot_origblob_cleanup, ctx); 4485 } 4486 4487 /* END blob_cleanup */ 4488 4489 /* START spdk_bs_create_snapshot */ 4490 4491 static void 4492 _spdk_bs_snapshot_swap_cluster_maps(struct spdk_blob *blob1, struct spdk_blob *blob2) 4493 { 4494 uint64_t *cluster_temp; 4495 4496 cluster_temp = blob1->active.clusters; 4497 blob1->active.clusters = blob2->active.clusters; 4498 blob2->active.clusters = cluster_temp; 4499 } 4500 4501 static void 4502 _spdk_bs_snapshot_origblob_sync_cpl(void *cb_arg, int bserrno) 4503 { 4504 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4505 struct spdk_blob *origblob = ctx->original.blob; 4506 struct spdk_blob *newblob = ctx->new.blob; 4507 4508 if (bserrno != 0) { 4509 _spdk_bs_snapshot_swap_cluster_maps(newblob, origblob); 4510 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4511 return; 4512 } 4513 4514 /* Remove metadata descriptor SNAPSHOT_IN_PROGRESS */ 4515 bserrno = _spdk_blob_remove_xattr(newblob, SNAPSHOT_IN_PROGRESS, true); 4516 if (bserrno != 0) { 4517 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4518 return; 4519 } 4520 4521 _spdk_bs_blob_list_add(ctx->original.blob); 4522 4523 spdk_blob_set_read_only(newblob); 4524 4525 /* sync snapshot metadata */ 4526 spdk_blob_sync_md(newblob, _spdk_bs_clone_snapshot_origblob_cleanup, cb_arg); 4527 } 4528 4529 static void 4530 _spdk_bs_snapshot_newblob_sync_cpl(void *cb_arg, int bserrno) 4531 { 4532 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4533 struct spdk_blob *origblob = ctx->original.blob; 4534 struct spdk_blob *newblob = ctx->new.blob; 4535 4536 if (bserrno != 0) { 4537 /* return cluster map back to original */ 4538 _spdk_bs_snapshot_swap_cluster_maps(newblob, origblob); 4539 _spdk_bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 4540 return; 4541 } 4542 4543 /* Set internal xattr for snapshot id */ 4544 bserrno = _spdk_blob_set_xattr(origblob, BLOB_SNAPSHOT, &newblob->id, sizeof(spdk_blob_id), true); 4545 if (bserrno != 0) { 4546 /* return cluster map back to original */ 4547 _spdk_bs_snapshot_swap_cluster_maps(newblob, origblob); 4548 _spdk_bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 4549 return; 4550 } 4551 4552 _spdk_bs_blob_list_remove(origblob); 4553 origblob->parent_id = newblob->id; 4554 4555 /* Create new back_bs_dev for snapshot */ 4556 origblob->back_bs_dev = spdk_bs_create_blob_bs_dev(newblob); 4557 if (origblob->back_bs_dev == NULL) { 4558 /* return cluster map back to original */ 4559 _spdk_bs_snapshot_swap_cluster_maps(newblob, origblob); 4560 _spdk_bs_clone_snapshot_newblob_cleanup(ctx, -EINVAL); 4561 return; 4562 } 4563 4564 /* set clone blob as thin provisioned */ 4565 _spdk_blob_set_thin_provision(origblob); 4566 4567 _spdk_bs_blob_list_add(newblob); 4568 4569 /* sync clone metadata */ 4570 spdk_blob_sync_md(origblob, _spdk_bs_snapshot_origblob_sync_cpl, ctx); 4571 } 4572 4573 static void 4574 _spdk_bs_snapshot_freeze_cpl(void *cb_arg, int rc) 4575 { 4576 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4577 struct spdk_blob *origblob = ctx->original.blob; 4578 struct spdk_blob *newblob = ctx->new.blob; 4579 int bserrno; 4580 4581 if (rc != 0) { 4582 _spdk_bs_clone_snapshot_newblob_cleanup(ctx, rc); 4583 return; 4584 } 4585 4586 ctx->frozen = true; 4587 4588 /* set new back_bs_dev for snapshot */ 4589 newblob->back_bs_dev = origblob->back_bs_dev; 4590 /* Set invalid flags from origblob */ 4591 newblob->invalid_flags = origblob->invalid_flags; 4592 4593 /* inherit parent from original blob if set */ 4594 newblob->parent_id = origblob->parent_id; 4595 if (origblob->parent_id != SPDK_BLOBID_INVALID) { 4596 /* Set internal xattr for snapshot id */ 4597 bserrno = _spdk_blob_set_xattr(newblob, BLOB_SNAPSHOT, 4598 &origblob->parent_id, sizeof(spdk_blob_id), true); 4599 if (bserrno != 0) { 4600 _spdk_bs_clone_snapshot_newblob_cleanup(ctx, bserrno); 4601 return; 4602 } 4603 } 4604 4605 /* swap cluster maps */ 4606 _spdk_bs_snapshot_swap_cluster_maps(newblob, origblob); 4607 4608 /* sync snapshot metadata */ 4609 spdk_blob_sync_md(newblob, _spdk_bs_snapshot_newblob_sync_cpl, ctx); 4610 } 4611 4612 static void 4613 _spdk_bs_snapshot_newblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 4614 { 4615 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4616 struct spdk_blob *origblob = ctx->original.blob; 4617 struct spdk_blob *newblob = _blob; 4618 4619 if (bserrno != 0) { 4620 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4621 return; 4622 } 4623 4624 ctx->new.blob = newblob; 4625 4626 /* Zero out newblob cluster map */ 4627 memset(newblob->active.clusters, 0, 4628 newblob->active.num_clusters * sizeof(newblob->active.clusters)); 4629 4630 _spdk_blob_freeze_io(origblob, _spdk_bs_snapshot_freeze_cpl, ctx); 4631 } 4632 4633 static void 4634 _spdk_bs_snapshot_newblob_create_cpl(void *cb_arg, spdk_blob_id blobid, int bserrno) 4635 { 4636 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4637 struct spdk_blob *origblob = ctx->original.blob; 4638 4639 if (bserrno != 0) { 4640 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4641 return; 4642 } 4643 4644 ctx->new.id = blobid; 4645 ctx->cpl.u.blobid.blobid = blobid; 4646 4647 spdk_bs_open_blob(origblob->bs, ctx->new.id, _spdk_bs_snapshot_newblob_open_cpl, ctx); 4648 } 4649 4650 4651 static void 4652 _spdk_bs_xattr_snapshot(void *arg, const char *name, 4653 const void **value, size_t *value_len) 4654 { 4655 assert(strncmp(name, SNAPSHOT_IN_PROGRESS, sizeof(SNAPSHOT_IN_PROGRESS)) == 0); 4656 4657 struct spdk_blob *blob = (struct spdk_blob *)arg; 4658 *value = &blob->id; 4659 *value_len = sizeof(blob->id); 4660 } 4661 4662 static void 4663 _spdk_bs_snapshot_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 4664 { 4665 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4666 struct spdk_blob_opts opts; 4667 struct spdk_blob_xattr_opts internal_xattrs; 4668 char *xattrs_names[] = { SNAPSHOT_IN_PROGRESS }; 4669 4670 if (bserrno != 0) { 4671 _spdk_bs_clone_snapshot_cleanup_finish(ctx, bserrno); 4672 return; 4673 } 4674 4675 ctx->original.blob = _blob; 4676 4677 if (_blob->data_ro || _blob->md_ro) { 4678 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Cannot create snapshot from read only blob with id %lu\n", 4679 _blob->id); 4680 ctx->bserrno = -EINVAL; 4681 spdk_blob_close(_blob, _spdk_bs_clone_snapshot_cleanup_finish, ctx); 4682 return; 4683 } 4684 4685 if (_blob->locked_operation_in_progress) { 4686 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Cannot create snapshot - another operation in progress\n"); 4687 ctx->bserrno = -EBUSY; 4688 spdk_blob_close(_blob, _spdk_bs_clone_snapshot_cleanup_finish, ctx); 4689 return; 4690 } 4691 4692 _blob->locked_operation_in_progress = true; 4693 4694 spdk_blob_opts_init(&opts); 4695 _spdk_blob_xattrs_init(&internal_xattrs); 4696 4697 /* Change the size of new blob to the same as in original blob, 4698 * but do not allocate clusters */ 4699 opts.thin_provision = true; 4700 opts.num_clusters = spdk_blob_get_num_clusters(_blob); 4701 4702 /* If there are any xattrs specified for snapshot, set them now */ 4703 if (ctx->xattrs) { 4704 memcpy(&opts.xattrs, ctx->xattrs, sizeof(*ctx->xattrs)); 4705 } 4706 /* Set internal xattr SNAPSHOT_IN_PROGRESS */ 4707 internal_xattrs.count = 1; 4708 internal_xattrs.ctx = _blob; 4709 internal_xattrs.names = xattrs_names; 4710 internal_xattrs.get_value = _spdk_bs_xattr_snapshot; 4711 4712 _spdk_bs_create_blob(_blob->bs, &opts, &internal_xattrs, 4713 _spdk_bs_snapshot_newblob_create_cpl, ctx); 4714 } 4715 4716 void spdk_bs_create_snapshot(struct spdk_blob_store *bs, spdk_blob_id blobid, 4717 const struct spdk_blob_xattr_opts *snapshot_xattrs, 4718 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 4719 { 4720 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 4721 4722 if (!ctx) { 4723 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOMEM); 4724 return; 4725 } 4726 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 4727 ctx->cpl.u.blobid.cb_fn = cb_fn; 4728 ctx->cpl.u.blobid.cb_arg = cb_arg; 4729 ctx->cpl.u.blobid.blobid = SPDK_BLOBID_INVALID; 4730 ctx->bserrno = 0; 4731 ctx->frozen = false; 4732 ctx->original.id = blobid; 4733 ctx->xattrs = snapshot_xattrs; 4734 4735 spdk_bs_open_blob(bs, ctx->original.id, _spdk_bs_snapshot_origblob_open_cpl, ctx); 4736 } 4737 /* END spdk_bs_create_snapshot */ 4738 4739 /* START spdk_bs_create_clone */ 4740 4741 static void 4742 _spdk_bs_xattr_clone(void *arg, const char *name, 4743 const void **value, size_t *value_len) 4744 { 4745 assert(strncmp(name, BLOB_SNAPSHOT, sizeof(BLOB_SNAPSHOT)) == 0); 4746 4747 struct spdk_blob *blob = (struct spdk_blob *)arg; 4748 *value = &blob->id; 4749 *value_len = sizeof(blob->id); 4750 } 4751 4752 static void 4753 _spdk_bs_clone_newblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 4754 { 4755 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4756 struct spdk_blob *clone = _blob; 4757 4758 ctx->new.blob = clone; 4759 _spdk_bs_blob_list_add(clone); 4760 4761 spdk_blob_close(clone, _spdk_bs_clone_snapshot_origblob_cleanup, ctx); 4762 } 4763 4764 static void 4765 _spdk_bs_clone_newblob_create_cpl(void *cb_arg, spdk_blob_id blobid, int bserrno) 4766 { 4767 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4768 4769 ctx->cpl.u.blobid.blobid = blobid; 4770 spdk_bs_open_blob(ctx->original.blob->bs, blobid, _spdk_bs_clone_newblob_open_cpl, ctx); 4771 } 4772 4773 static void 4774 _spdk_bs_clone_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 4775 { 4776 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4777 struct spdk_blob_opts opts; 4778 struct spdk_blob_xattr_opts internal_xattrs; 4779 char *xattr_names[] = { BLOB_SNAPSHOT }; 4780 4781 if (bserrno != 0) { 4782 _spdk_bs_clone_snapshot_cleanup_finish(ctx, bserrno); 4783 return; 4784 } 4785 4786 ctx->original.blob = _blob; 4787 4788 if (!_blob->data_ro || !_blob->md_ro) { 4789 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Clone not from read-only blob\n"); 4790 ctx->bserrno = -EINVAL; 4791 spdk_blob_close(_blob, _spdk_bs_clone_snapshot_cleanup_finish, ctx); 4792 return; 4793 } 4794 4795 if (_blob->locked_operation_in_progress) { 4796 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Cannot create clone - another operation in progress\n"); 4797 ctx->bserrno = -EBUSY; 4798 spdk_blob_close(_blob, _spdk_bs_clone_snapshot_cleanup_finish, ctx); 4799 return; 4800 } 4801 4802 _blob->locked_operation_in_progress = true; 4803 4804 spdk_blob_opts_init(&opts); 4805 _spdk_blob_xattrs_init(&internal_xattrs); 4806 4807 opts.thin_provision = true; 4808 opts.num_clusters = spdk_blob_get_num_clusters(_blob); 4809 if (ctx->xattrs) { 4810 memcpy(&opts.xattrs, ctx->xattrs, sizeof(*ctx->xattrs)); 4811 } 4812 4813 /* Set internal xattr BLOB_SNAPSHOT */ 4814 internal_xattrs.count = 1; 4815 internal_xattrs.ctx = _blob; 4816 internal_xattrs.names = xattr_names; 4817 internal_xattrs.get_value = _spdk_bs_xattr_clone; 4818 4819 _spdk_bs_create_blob(_blob->bs, &opts, &internal_xattrs, 4820 _spdk_bs_clone_newblob_create_cpl, ctx); 4821 } 4822 4823 void spdk_bs_create_clone(struct spdk_blob_store *bs, spdk_blob_id blobid, 4824 const struct spdk_blob_xattr_opts *clone_xattrs, 4825 spdk_blob_op_with_id_complete cb_fn, void *cb_arg) 4826 { 4827 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 4828 4829 if (!ctx) { 4830 cb_fn(cb_arg, SPDK_BLOBID_INVALID, -ENOMEM); 4831 return; 4832 } 4833 4834 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOBID; 4835 ctx->cpl.u.blobid.cb_fn = cb_fn; 4836 ctx->cpl.u.blobid.cb_arg = cb_arg; 4837 ctx->cpl.u.blobid.blobid = SPDK_BLOBID_INVALID; 4838 ctx->bserrno = 0; 4839 ctx->xattrs = clone_xattrs; 4840 ctx->original.id = blobid; 4841 4842 spdk_bs_open_blob(bs, ctx->original.id, _spdk_bs_clone_origblob_open_cpl, ctx); 4843 } 4844 4845 /* END spdk_bs_create_clone */ 4846 4847 /* START spdk_bs_inflate_blob */ 4848 4849 static void 4850 _spdk_bs_inflate_blob_set_parent_cpl(void *cb_arg, struct spdk_blob *_parent, int bserrno) 4851 { 4852 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4853 struct spdk_blob *_blob = ctx->original.blob; 4854 4855 if (bserrno != 0) { 4856 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4857 return; 4858 } 4859 4860 assert(_parent != NULL); 4861 4862 _spdk_bs_blob_list_remove(_blob); 4863 _blob->parent_id = _parent->id; 4864 _spdk_blob_set_xattr(_blob, BLOB_SNAPSHOT, &_blob->parent_id, 4865 sizeof(spdk_blob_id), true); 4866 4867 _blob->back_bs_dev->destroy(_blob->back_bs_dev); 4868 _blob->back_bs_dev = spdk_bs_create_blob_bs_dev(_parent); 4869 _spdk_bs_blob_list_add(_blob); 4870 4871 spdk_blob_sync_md(_blob, _spdk_bs_clone_snapshot_origblob_cleanup, ctx); 4872 } 4873 4874 static void 4875 _spdk_bs_inflate_blob_done(void *cb_arg, int bserrno) 4876 { 4877 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4878 struct spdk_blob *_blob = ctx->original.blob; 4879 struct spdk_blob *_parent; 4880 4881 if (bserrno != 0) { 4882 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4883 return; 4884 } 4885 4886 if (ctx->allocate_all) { 4887 /* remove thin provisioning */ 4888 _spdk_bs_blob_list_remove(_blob); 4889 _spdk_blob_remove_xattr(_blob, BLOB_SNAPSHOT, true); 4890 _blob->invalid_flags = _blob->invalid_flags & ~SPDK_BLOB_THIN_PROV; 4891 _blob->back_bs_dev->destroy(_blob->back_bs_dev); 4892 _blob->back_bs_dev = NULL; 4893 _blob->parent_id = SPDK_BLOBID_INVALID; 4894 } else { 4895 _parent = ((struct spdk_blob_bs_dev *)(_blob->back_bs_dev))->blob; 4896 if (_parent->parent_id != SPDK_BLOBID_INVALID) { 4897 /* We must change the parent of the inflated blob */ 4898 spdk_bs_open_blob(_blob->bs, _parent->parent_id, 4899 _spdk_bs_inflate_blob_set_parent_cpl, ctx); 4900 return; 4901 } 4902 4903 _spdk_bs_blob_list_remove(_blob); 4904 _spdk_blob_remove_xattr(_blob, BLOB_SNAPSHOT, true); 4905 _blob->parent_id = SPDK_BLOBID_INVALID; 4906 _blob->back_bs_dev->destroy(_blob->back_bs_dev); 4907 _blob->back_bs_dev = spdk_bs_create_zeroes_dev(); 4908 } 4909 4910 _blob->state = SPDK_BLOB_STATE_DIRTY; 4911 spdk_blob_sync_md(_blob, _spdk_bs_clone_snapshot_origblob_cleanup, ctx); 4912 } 4913 4914 /* Check if cluster needs allocation */ 4915 static inline bool 4916 _spdk_bs_cluster_needs_allocation(struct spdk_blob *blob, uint64_t cluster, bool allocate_all) 4917 { 4918 struct spdk_blob_bs_dev *b; 4919 4920 assert(blob != NULL); 4921 4922 if (blob->active.clusters[cluster] != 0) { 4923 /* Cluster is already allocated */ 4924 return false; 4925 } 4926 4927 if (blob->parent_id == SPDK_BLOBID_INVALID) { 4928 /* Blob have no parent blob */ 4929 return allocate_all; 4930 } 4931 4932 b = (struct spdk_blob_bs_dev *)blob->back_bs_dev; 4933 return (allocate_all || b->blob->active.clusters[cluster] != 0); 4934 } 4935 4936 static void 4937 _spdk_bs_inflate_blob_touch_next(void *cb_arg, int bserrno) 4938 { 4939 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4940 struct spdk_blob *_blob = ctx->original.blob; 4941 uint64_t offset; 4942 4943 if (bserrno != 0) { 4944 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, bserrno); 4945 return; 4946 } 4947 4948 for (; ctx->cluster < _blob->active.num_clusters; ctx->cluster++) { 4949 if (_spdk_bs_cluster_needs_allocation(_blob, ctx->cluster, ctx->allocate_all)) { 4950 break; 4951 } 4952 } 4953 4954 if (ctx->cluster < _blob->active.num_clusters) { 4955 offset = _spdk_bs_cluster_to_lba(_blob->bs, ctx->cluster); 4956 4957 /* We may safely increment a cluster before write */ 4958 ctx->cluster++; 4959 4960 /* Use zero length write to touch a cluster */ 4961 spdk_blob_io_write(_blob, ctx->channel, NULL, offset, 0, 4962 _spdk_bs_inflate_blob_touch_next, ctx); 4963 } else { 4964 _spdk_bs_inflate_blob_done(cb_arg, bserrno); 4965 } 4966 } 4967 4968 static void 4969 _spdk_bs_inflate_blob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 4970 { 4971 struct spdk_clone_snapshot_ctx *ctx = (struct spdk_clone_snapshot_ctx *)cb_arg; 4972 uint64_t lfc; /* lowest free cluster */ 4973 uint64_t i; 4974 4975 if (bserrno != 0) { 4976 _spdk_bs_clone_snapshot_cleanup_finish(ctx, bserrno); 4977 return; 4978 } 4979 4980 ctx->original.blob = _blob; 4981 4982 if (_blob->locked_operation_in_progress) { 4983 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Cannot inflate blob - another operation in progress\n"); 4984 ctx->bserrno = -EBUSY; 4985 spdk_blob_close(_blob, _spdk_bs_clone_snapshot_cleanup_finish, ctx); 4986 return; 4987 } 4988 4989 _blob->locked_operation_in_progress = true; 4990 4991 if (!ctx->allocate_all && _blob->parent_id == SPDK_BLOBID_INVALID) { 4992 /* This blob have no parent, so we cannot decouple it. */ 4993 SPDK_ERRLOG("Cannot decouple parent of blob with no parent.\n"); 4994 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, -EINVAL); 4995 return; 4996 } 4997 4998 if (spdk_blob_is_thin_provisioned(_blob) == false) { 4999 /* This is not thin provisioned blob. No need to inflate. */ 5000 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, 0); 5001 return; 5002 } 5003 5004 /* Do two passes - one to verify that we can obtain enough clusters 5005 * and another to actually claim them. 5006 */ 5007 lfc = 0; 5008 for (i = 0; i < _blob->active.num_clusters; i++) { 5009 if (_spdk_bs_cluster_needs_allocation(_blob, i, ctx->allocate_all)) { 5010 lfc = spdk_bit_array_find_first_clear(_blob->bs->used_clusters, lfc); 5011 if (lfc == UINT32_MAX) { 5012 /* No more free clusters. Cannot satisfy the request */ 5013 _spdk_bs_clone_snapshot_origblob_cleanup(ctx, -ENOSPC); 5014 return; 5015 } 5016 lfc++; 5017 } 5018 } 5019 5020 ctx->cluster = 0; 5021 _spdk_bs_inflate_blob_touch_next(ctx, 0); 5022 } 5023 5024 static void 5025 _spdk_bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 5026 spdk_blob_id blobid, bool allocate_all, spdk_blob_op_complete cb_fn, void *cb_arg) 5027 { 5028 struct spdk_clone_snapshot_ctx *ctx = calloc(1, sizeof(*ctx)); 5029 5030 if (!ctx) { 5031 cb_fn(cb_arg, -ENOMEM); 5032 return; 5033 } 5034 ctx->cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 5035 ctx->cpl.u.bs_basic.cb_fn = cb_fn; 5036 ctx->cpl.u.bs_basic.cb_arg = cb_arg; 5037 ctx->bserrno = 0; 5038 ctx->original.id = blobid; 5039 ctx->channel = channel; 5040 ctx->allocate_all = allocate_all; 5041 5042 spdk_bs_open_blob(bs, ctx->original.id, _spdk_bs_inflate_blob_open_cpl, ctx); 5043 } 5044 5045 void 5046 spdk_bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 5047 spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg) 5048 { 5049 _spdk_bs_inflate_blob(bs, channel, blobid, true, cb_fn, cb_arg); 5050 } 5051 5052 void 5053 spdk_bs_blob_decouple_parent(struct spdk_blob_store *bs, struct spdk_io_channel *channel, 5054 spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg) 5055 { 5056 _spdk_bs_inflate_blob(bs, channel, blobid, false, cb_fn, cb_arg); 5057 } 5058 /* END spdk_bs_inflate_blob */ 5059 5060 /* START spdk_blob_resize */ 5061 struct spdk_bs_resize_ctx { 5062 spdk_blob_op_complete cb_fn; 5063 void *cb_arg; 5064 struct spdk_blob *blob; 5065 uint64_t sz; 5066 int rc; 5067 }; 5068 5069 static void 5070 _spdk_bs_resize_unfreeze_cpl(void *cb_arg, int rc) 5071 { 5072 struct spdk_bs_resize_ctx *ctx = (struct spdk_bs_resize_ctx *)cb_arg; 5073 5074 if (rc != 0) { 5075 SPDK_ERRLOG("Unfreeze failed, rc=%d\n", rc); 5076 } 5077 5078 if (ctx->rc != 0) { 5079 SPDK_ERRLOG("Unfreeze failed, ctx->rc=%d\n", ctx->rc); 5080 rc = ctx->rc; 5081 } 5082 5083 ctx->blob->locked_operation_in_progress = false; 5084 5085 ctx->cb_fn(ctx->cb_arg, rc); 5086 free(ctx); 5087 } 5088 5089 static void 5090 _spdk_bs_resize_freeze_cpl(void *cb_arg, int rc) 5091 { 5092 struct spdk_bs_resize_ctx *ctx = (struct spdk_bs_resize_ctx *)cb_arg; 5093 5094 if (rc != 0) { 5095 ctx->blob->locked_operation_in_progress = false; 5096 ctx->cb_fn(ctx->cb_arg, rc); 5097 free(ctx); 5098 return; 5099 } 5100 5101 ctx->rc = _spdk_blob_resize(ctx->blob, ctx->sz); 5102 5103 _spdk_blob_unfreeze_io(ctx->blob, _spdk_bs_resize_unfreeze_cpl, ctx); 5104 } 5105 5106 void 5107 spdk_blob_resize(struct spdk_blob *blob, uint64_t sz, spdk_blob_op_complete cb_fn, void *cb_arg) 5108 { 5109 struct spdk_bs_resize_ctx *ctx; 5110 5111 _spdk_blob_verify_md_op(blob); 5112 5113 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Resizing blob %lu to %lu clusters\n", blob->id, sz); 5114 5115 if (blob->md_ro) { 5116 cb_fn(cb_arg, -EPERM); 5117 return; 5118 } 5119 5120 if (sz == blob->active.num_clusters) { 5121 cb_fn(cb_arg, 0); 5122 return; 5123 } 5124 5125 if (blob->locked_operation_in_progress) { 5126 cb_fn(cb_arg, -EBUSY); 5127 return; 5128 } 5129 5130 ctx = calloc(1, sizeof(*ctx)); 5131 if (!ctx) { 5132 cb_fn(cb_arg, -ENOMEM); 5133 return; 5134 } 5135 5136 blob->locked_operation_in_progress = true; 5137 ctx->cb_fn = cb_fn; 5138 ctx->cb_arg = cb_arg; 5139 ctx->blob = blob; 5140 ctx->sz = sz; 5141 _spdk_blob_freeze_io(blob, _spdk_bs_resize_freeze_cpl, ctx); 5142 } 5143 5144 /* END spdk_blob_resize */ 5145 5146 5147 /* START spdk_bs_delete_blob */ 5148 5149 static void 5150 _spdk_bs_delete_close_cpl(void *cb_arg, int bserrno) 5151 { 5152 spdk_bs_sequence_t *seq = cb_arg; 5153 5154 spdk_bs_sequence_finish(seq, bserrno); 5155 } 5156 5157 static void 5158 _spdk_bs_delete_persist_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5159 { 5160 struct spdk_blob *blob = cb_arg; 5161 5162 if (bserrno != 0) { 5163 /* 5164 * We already removed this blob from the blobstore tailq, so 5165 * we need to free it here since this is the last reference 5166 * to it. 5167 */ 5168 _spdk_blob_free(blob); 5169 _spdk_bs_delete_close_cpl(seq, bserrno); 5170 return; 5171 } 5172 5173 /* 5174 * This will immediately decrement the ref_count and call 5175 * the completion routine since the metadata state is clean. 5176 * By calling spdk_blob_close, we reduce the number of call 5177 * points into code that touches the blob->open_ref count 5178 * and the blobstore's blob list. 5179 */ 5180 spdk_blob_close(blob, _spdk_bs_delete_close_cpl, seq); 5181 } 5182 5183 struct delete_snapshot_ctx { 5184 struct spdk_blob_list *parent_snapshot_entry; 5185 struct spdk_blob *snapshot; 5186 bool snapshot_md_ro; 5187 struct spdk_blob *clone; 5188 bool clone_md_ro; 5189 spdk_blob_op_with_handle_complete cb_fn; 5190 void *cb_arg; 5191 int bserrno; 5192 }; 5193 5194 static void 5195 _spdk_delete_blob_cleanup_finish(void *cb_arg, int bserrno) 5196 { 5197 struct delete_snapshot_ctx *ctx = cb_arg; 5198 5199 if (bserrno != 0) { 5200 SPDK_ERRLOG("Snapshot cleanup error %d\n", bserrno); 5201 } 5202 5203 assert(ctx != NULL); 5204 5205 if (bserrno != 0 && ctx->bserrno == 0) { 5206 ctx->bserrno = bserrno; 5207 } 5208 5209 ctx->cb_fn(ctx->cb_arg, ctx->snapshot, ctx->bserrno); 5210 free(ctx); 5211 } 5212 5213 static void 5214 _spdk_delete_snapshot_cleanup_snapshot(void *cb_arg, int bserrno) 5215 { 5216 struct delete_snapshot_ctx *ctx = cb_arg; 5217 5218 if (bserrno != 0) { 5219 ctx->bserrno = bserrno; 5220 SPDK_ERRLOG("Clone cleanup error %d\n", bserrno); 5221 } 5222 5223 /* open_ref == 1 menas that only deletion context has opened this snapshot 5224 * open_ref == 2 menas that clone has opened this snapshot as well, 5225 * so we have to add it back to the blobs list */ 5226 if (ctx->snapshot->open_ref == 2) { 5227 TAILQ_INSERT_HEAD(&ctx->snapshot->bs->blobs, ctx->snapshot, link); 5228 } 5229 5230 ctx->snapshot->locked_operation_in_progress = false; 5231 ctx->snapshot->md_ro = ctx->snapshot_md_ro; 5232 5233 spdk_blob_close(ctx->snapshot, _spdk_delete_blob_cleanup_finish, ctx); 5234 } 5235 5236 static void 5237 _spdk_delete_snapshot_cleanup_clone(void *cb_arg, int bserrno) 5238 { 5239 struct delete_snapshot_ctx *ctx = cb_arg; 5240 5241 ctx->clone->locked_operation_in_progress = false; 5242 ctx->clone->md_ro = ctx->clone_md_ro; 5243 5244 spdk_blob_close(ctx->clone, _spdk_delete_snapshot_cleanup_snapshot, ctx); 5245 } 5246 5247 static void 5248 _spdk_delete_snapshot_unfreeze_cpl(void *cb_arg, int bserrno) 5249 { 5250 struct delete_snapshot_ctx *ctx = cb_arg; 5251 5252 if (bserrno) { 5253 ctx->bserrno = bserrno; 5254 _spdk_delete_snapshot_cleanup_clone(ctx, 0); 5255 return; 5256 } 5257 5258 ctx->clone->locked_operation_in_progress = false; 5259 spdk_blob_close(ctx->clone, _spdk_delete_blob_cleanup_finish, ctx); 5260 } 5261 5262 static void 5263 _spdk_delete_snapshot_sync_snapshot_cpl(void *cb_arg, int bserrno) 5264 { 5265 struct delete_snapshot_ctx *ctx = cb_arg; 5266 struct spdk_blob_list *parent_snapshot_entry = NULL; 5267 struct spdk_blob_list *snapshot_entry = NULL; 5268 struct spdk_blob_list *clone_entry = NULL; 5269 struct spdk_blob_list *snapshot_clone_entry = NULL; 5270 5271 if (bserrno) { 5272 SPDK_ERRLOG("Failed to sync MD on blob\n"); 5273 ctx->bserrno = bserrno; 5274 _spdk_delete_snapshot_cleanup_clone(ctx, 0); 5275 return; 5276 } 5277 5278 /* Get snapshot entry for the snapshot we want to remove */ 5279 snapshot_entry = _spdk_bs_get_snapshot_entry(ctx->snapshot->bs, ctx->snapshot->id); 5280 5281 assert(snapshot_entry != NULL); 5282 5283 /* Remove clone entry in this snapshot (at this point there can be only one clone) */ 5284 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 5285 assert(clone_entry != NULL); 5286 TAILQ_REMOVE(&snapshot_entry->clones, clone_entry, link); 5287 snapshot_entry->clone_count--; 5288 assert(TAILQ_EMPTY(&snapshot_entry->clones)); 5289 5290 if (ctx->snapshot->parent_id != SPDK_BLOBID_INVALID) { 5291 /* This snapshot is at the same time a clone of another snapshot - we need to 5292 * update parent snapshot (remove current clone, add new one inherited from 5293 * the snapshot that is being removed) */ 5294 5295 /* Get snapshot entry for parent snapshot and clone entry within that snapshot for 5296 * snapshot that we are removing */ 5297 _spdk_blob_get_snapshot_and_clone_entries(ctx->snapshot, &parent_snapshot_entry, 5298 &snapshot_clone_entry); 5299 5300 /* Switch clone entry in parent snapshot */ 5301 TAILQ_INSERT_TAIL(&parent_snapshot_entry->clones, clone_entry, link); 5302 TAILQ_REMOVE(&parent_snapshot_entry->clones, snapshot_clone_entry, link); 5303 free(snapshot_clone_entry); 5304 } else { 5305 /* No parent snapshot - just remove clone entry */ 5306 free(clone_entry); 5307 } 5308 5309 /* Restore md_ro flags */ 5310 ctx->clone->md_ro = ctx->clone_md_ro; 5311 ctx->snapshot->md_ro = ctx->snapshot_md_ro; 5312 5313 _spdk_blob_unfreeze_io(ctx->clone, _spdk_delete_snapshot_unfreeze_cpl, ctx); 5314 } 5315 5316 static void 5317 _spdk_delete_snapshot_sync_clone_cpl(void *cb_arg, int bserrno) 5318 { 5319 struct delete_snapshot_ctx *ctx = cb_arg; 5320 uint64_t i; 5321 5322 ctx->snapshot->md_ro = false; 5323 5324 if (bserrno) { 5325 SPDK_ERRLOG("Failed to sync MD on clone\n"); 5326 ctx->bserrno = bserrno; 5327 5328 /* Restore snapshot to previous state */ 5329 bserrno = _spdk_blob_remove_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, true); 5330 if (bserrno != 0) { 5331 _spdk_delete_snapshot_cleanup_clone(ctx, bserrno); 5332 return; 5333 } 5334 5335 spdk_blob_sync_md(ctx->snapshot, _spdk_delete_snapshot_cleanup_clone, ctx); 5336 return; 5337 } 5338 5339 /* Clear cluster map entries for snapshot */ 5340 for (i = 0; i < ctx->snapshot->active.num_clusters && i < ctx->clone->active.num_clusters; i++) { 5341 if (ctx->clone->active.clusters[i] == ctx->snapshot->active.clusters[i]) { 5342 ctx->snapshot->active.clusters[i] = 0; 5343 } 5344 } 5345 5346 ctx->snapshot->state = SPDK_BLOB_STATE_DIRTY; 5347 5348 if (ctx->parent_snapshot_entry != NULL) { 5349 ctx->snapshot->back_bs_dev = NULL; 5350 } 5351 5352 spdk_blob_sync_md(ctx->snapshot, _spdk_delete_snapshot_sync_snapshot_cpl, ctx); 5353 } 5354 5355 static void 5356 _spdk_delete_snapshot_sync_snapshot_xattr_cpl(void *cb_arg, int bserrno) 5357 { 5358 struct delete_snapshot_ctx *ctx = cb_arg; 5359 uint64_t i; 5360 5361 /* Temporarily override md_ro flag for clone for MD modification */ 5362 ctx->clone_md_ro = ctx->clone->md_ro; 5363 ctx->clone->md_ro = false; 5364 5365 if (bserrno) { 5366 SPDK_ERRLOG("Failed to sync MD with xattr on blob\n"); 5367 ctx->bserrno = bserrno; 5368 _spdk_delete_snapshot_cleanup_clone(ctx, 0); 5369 return; 5370 } 5371 5372 /* Copy snapshot map to clone map (only unallocated clusters in clone) */ 5373 for (i = 0; i < ctx->snapshot->active.num_clusters && i < ctx->clone->active.num_clusters; i++) { 5374 if (ctx->clone->active.clusters[i] == 0) { 5375 ctx->clone->active.clusters[i] = ctx->snapshot->active.clusters[i]; 5376 } 5377 } 5378 5379 /* Delete old backing bs_dev from clone (related to snapshot that will be removed) */ 5380 ctx->clone->back_bs_dev->destroy(ctx->clone->back_bs_dev); 5381 5382 /* Set/remove snapshot xattr and switch parent ID and backing bs_dev on clone... */ 5383 if (ctx->parent_snapshot_entry != NULL) { 5384 /* ...to parent snapshot */ 5385 ctx->clone->parent_id = ctx->parent_snapshot_entry->id; 5386 ctx->clone->back_bs_dev = ctx->snapshot->back_bs_dev; 5387 _spdk_blob_set_xattr(ctx->clone, BLOB_SNAPSHOT, &ctx->parent_snapshot_entry->id, 5388 sizeof(spdk_blob_id), 5389 true); 5390 } else { 5391 /* ...to blobid invalid and zeroes dev */ 5392 ctx->clone->parent_id = SPDK_BLOBID_INVALID; 5393 ctx->clone->back_bs_dev = spdk_bs_create_zeroes_dev(); 5394 _spdk_blob_remove_xattr(ctx->clone, BLOB_SNAPSHOT, true); 5395 } 5396 5397 spdk_blob_sync_md(ctx->clone, _spdk_delete_snapshot_sync_clone_cpl, ctx); 5398 } 5399 5400 static void 5401 _spdk_delete_snapshot_freeze_io_cb(void *cb_arg, int bserrno) 5402 { 5403 struct delete_snapshot_ctx *ctx = cb_arg; 5404 5405 if (bserrno) { 5406 SPDK_ERRLOG("Failed to freeze I/O on clone\n"); 5407 ctx->bserrno = bserrno; 5408 _spdk_delete_snapshot_cleanup_clone(ctx, 0); 5409 return; 5410 } 5411 5412 /* Temporarily override md_ro flag for snapshot for MD modification */ 5413 ctx->snapshot_md_ro = ctx->snapshot->md_ro; 5414 ctx->snapshot->md_ro = false; 5415 5416 /* Mark blob as pending for removal for power failure safety, use clone id for recovery */ 5417 ctx->bserrno = _spdk_blob_set_xattr(ctx->snapshot, SNAPSHOT_PENDING_REMOVAL, &ctx->clone->id, 5418 sizeof(spdk_blob_id), true); 5419 if (ctx->bserrno != 0) { 5420 _spdk_delete_snapshot_cleanup_clone(ctx, 0); 5421 return; 5422 } 5423 5424 spdk_blob_sync_md(ctx->snapshot, _spdk_delete_snapshot_sync_snapshot_xattr_cpl, ctx); 5425 } 5426 5427 static void 5428 _spdk_delete_snapshot_open_clone_cb(void *cb_arg, struct spdk_blob *clone, int bserrno) 5429 { 5430 struct delete_snapshot_ctx *ctx = cb_arg; 5431 5432 if (bserrno) { 5433 SPDK_ERRLOG("Failed to open clone\n"); 5434 ctx->bserrno = bserrno; 5435 _spdk_delete_snapshot_cleanup_snapshot(ctx, 0); 5436 return; 5437 } 5438 5439 ctx->clone = clone; 5440 5441 if (clone->locked_operation_in_progress) { 5442 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Cannot remove blob - another operation in progress on its clone\n"); 5443 ctx->bserrno = -EBUSY; 5444 spdk_blob_close(ctx->clone, _spdk_delete_snapshot_cleanup_snapshot, ctx); 5445 return; 5446 } 5447 5448 clone->locked_operation_in_progress = true; 5449 5450 _spdk_blob_freeze_io(clone, _spdk_delete_snapshot_freeze_io_cb, ctx); 5451 } 5452 5453 static void 5454 _spdk_update_clone_on_snapshot_deletion(struct spdk_blob *snapshot, struct delete_snapshot_ctx *ctx) 5455 { 5456 struct spdk_blob_list *snapshot_entry = NULL; 5457 struct spdk_blob_list *clone_entry = NULL; 5458 struct spdk_blob_list *snapshot_clone_entry = NULL; 5459 5460 /* Get snapshot entry for the snapshot we want to remove */ 5461 snapshot_entry = _spdk_bs_get_snapshot_entry(snapshot->bs, snapshot->id); 5462 5463 assert(snapshot_entry != NULL); 5464 5465 /* Get clone of the snapshot (at this point there can be only one clone) */ 5466 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 5467 assert(snapshot_entry->clone_count == 1); 5468 assert(clone_entry != NULL); 5469 5470 /* Get snapshot entry for parent snapshot and clone entry within that snapshot for 5471 * snapshot that we are removing */ 5472 _spdk_blob_get_snapshot_and_clone_entries(snapshot, &ctx->parent_snapshot_entry, 5473 &snapshot_clone_entry); 5474 5475 spdk_bs_open_blob(snapshot->bs, clone_entry->id, _spdk_delete_snapshot_open_clone_cb, ctx); 5476 } 5477 5478 static void 5479 _spdk_bs_delete_blob_finish(void *cb_arg, struct spdk_blob *blob, int bserrno) 5480 { 5481 spdk_bs_sequence_t *seq = cb_arg; 5482 struct spdk_blob_list *snapshot_entry = NULL; 5483 uint32_t page_num; 5484 5485 if (bserrno) { 5486 SPDK_ERRLOG("Failed to remove blob\n"); 5487 spdk_bs_sequence_finish(seq, bserrno); 5488 return; 5489 } 5490 5491 /* Remove snapshot from the list */ 5492 snapshot_entry = _spdk_bs_get_snapshot_entry(blob->bs, blob->id); 5493 if (snapshot_entry != NULL) { 5494 TAILQ_REMOVE(&blob->bs->snapshots, snapshot_entry, link); 5495 free(snapshot_entry); 5496 } 5497 5498 page_num = _spdk_bs_blobid_to_page(blob->id); 5499 spdk_bit_array_clear(blob->bs->used_blobids, page_num); 5500 blob->state = SPDK_BLOB_STATE_DIRTY; 5501 blob->active.num_pages = 0; 5502 _spdk_blob_resize(blob, 0); 5503 5504 _spdk_blob_persist(seq, blob, _spdk_bs_delete_persist_cpl, blob); 5505 } 5506 5507 static int 5508 _spdk_bs_is_blob_deletable(struct spdk_blob *blob, bool *update_clone) 5509 { 5510 struct spdk_blob_list *snapshot_entry = NULL; 5511 struct spdk_blob_list *clone_entry = NULL; 5512 struct spdk_blob *clone = NULL; 5513 bool has_one_clone = false; 5514 5515 /* Check if this is a snapshot with clones */ 5516 snapshot_entry = _spdk_bs_get_snapshot_entry(blob->bs, blob->id); 5517 if (snapshot_entry != NULL) { 5518 if (snapshot_entry->clone_count > 1) { 5519 SPDK_ERRLOG("Cannot remove snapshot with more than one clone\n"); 5520 return -EBUSY; 5521 } else if (snapshot_entry->clone_count == 1) { 5522 has_one_clone = true; 5523 } 5524 } 5525 5526 /* Check if someone has this blob open (besides this delete context): 5527 * - open_ref = 1 - only this context opened blob, so it is ok to remove it 5528 * - open_ref <= 2 && has_one_clone = true - clone is holding snapshot 5529 * and that is ok, because we will update it accordingly */ 5530 if (blob->open_ref <= 2 && has_one_clone) { 5531 clone_entry = TAILQ_FIRST(&snapshot_entry->clones); 5532 assert(clone_entry != NULL); 5533 clone = _spdk_blob_lookup(blob->bs, clone_entry->id); 5534 5535 if (blob->open_ref == 2 && clone == NULL) { 5536 /* Clone is closed and someone else opened this blob */ 5537 SPDK_ERRLOG("Cannot remove snapshot because it is open\n"); 5538 return -EBUSY; 5539 } 5540 5541 *update_clone = true; 5542 return 0; 5543 } 5544 5545 if (blob->open_ref > 1) { 5546 SPDK_ERRLOG("Cannot remove snapshot because it is open\n"); 5547 return -EBUSY; 5548 } 5549 5550 assert(has_one_clone == false); 5551 *update_clone = false; 5552 return 0; 5553 } 5554 5555 static void 5556 _spdk_bs_delete_enomem_close_cpl(void *cb_arg, int bserrno) 5557 { 5558 spdk_bs_sequence_t *seq = cb_arg; 5559 5560 spdk_bs_sequence_finish(seq, -ENOMEM); 5561 } 5562 5563 static void 5564 _spdk_bs_delete_open_cpl(void *cb_arg, struct spdk_blob *blob, int bserrno) 5565 { 5566 spdk_bs_sequence_t *seq = cb_arg; 5567 struct delete_snapshot_ctx *ctx; 5568 bool update_clone = false; 5569 5570 if (bserrno != 0) { 5571 spdk_bs_sequence_finish(seq, bserrno); 5572 return; 5573 } 5574 5575 _spdk_blob_verify_md_op(blob); 5576 5577 ctx = calloc(1, sizeof(*ctx)); 5578 if (ctx == NULL) { 5579 spdk_blob_close(blob, _spdk_bs_delete_enomem_close_cpl, seq); 5580 return; 5581 } 5582 5583 ctx->snapshot = blob; 5584 ctx->cb_fn = _spdk_bs_delete_blob_finish; 5585 ctx->cb_arg = seq; 5586 5587 /* Check if blob can be removed and if it is a snapshot with clone on top of it */ 5588 ctx->bserrno = _spdk_bs_is_blob_deletable(blob, &update_clone); 5589 if (ctx->bserrno) { 5590 spdk_blob_close(blob, _spdk_delete_blob_cleanup_finish, ctx); 5591 return; 5592 } 5593 5594 if (blob->locked_operation_in_progress) { 5595 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Cannot remove blob - another operation in progress\n"); 5596 ctx->bserrno = -EBUSY; 5597 spdk_blob_close(blob, _spdk_delete_blob_cleanup_finish, ctx); 5598 return; 5599 } 5600 5601 blob->locked_operation_in_progress = true; 5602 5603 /* 5604 * Remove the blob from the blob_store list now, to ensure it does not 5605 * get returned after this point by _spdk_blob_lookup(). 5606 */ 5607 TAILQ_REMOVE(&blob->bs->blobs, blob, link); 5608 5609 if (update_clone) { 5610 /* This blob is a snapshot with active clone - update clone first */ 5611 _spdk_update_clone_on_snapshot_deletion(blob, ctx); 5612 } else { 5613 /* This blob does not have any clones - just remove it */ 5614 _spdk_bs_blob_list_remove(blob); 5615 _spdk_bs_delete_blob_finish(seq, blob, 0); 5616 free(ctx); 5617 } 5618 } 5619 5620 void 5621 spdk_bs_delete_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 5622 spdk_blob_op_complete cb_fn, void *cb_arg) 5623 { 5624 struct spdk_bs_cpl cpl; 5625 spdk_bs_sequence_t *seq; 5626 5627 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Deleting blob %lu\n", blobid); 5628 5629 assert(spdk_get_thread() == bs->md_thread); 5630 5631 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 5632 cpl.u.blob_basic.cb_fn = cb_fn; 5633 cpl.u.blob_basic.cb_arg = cb_arg; 5634 5635 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 5636 if (!seq) { 5637 cb_fn(cb_arg, -ENOMEM); 5638 return; 5639 } 5640 5641 spdk_bs_open_blob(bs, blobid, _spdk_bs_delete_open_cpl, seq); 5642 } 5643 5644 /* END spdk_bs_delete_blob */ 5645 5646 /* START spdk_bs_open_blob */ 5647 5648 static void 5649 _spdk_bs_open_blob_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5650 { 5651 struct spdk_blob *blob = cb_arg; 5652 5653 /* If the blob have crc error, we just return NULL. */ 5654 if (blob == NULL) { 5655 seq->cpl.u.blob_handle.blob = NULL; 5656 spdk_bs_sequence_finish(seq, bserrno); 5657 return; 5658 } 5659 5660 blob->open_ref++; 5661 5662 TAILQ_INSERT_HEAD(&blob->bs->blobs, blob, link); 5663 5664 spdk_bs_sequence_finish(seq, bserrno); 5665 } 5666 5667 static void _spdk_bs_open_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 5668 struct spdk_blob_open_opts *opts, spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 5669 { 5670 struct spdk_blob *blob; 5671 struct spdk_bs_cpl cpl; 5672 struct spdk_blob_open_opts opts_default; 5673 spdk_bs_sequence_t *seq; 5674 uint32_t page_num; 5675 5676 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Opening blob %lu\n", blobid); 5677 assert(spdk_get_thread() == bs->md_thread); 5678 5679 page_num = _spdk_bs_blobid_to_page(blobid); 5680 if (spdk_bit_array_get(bs->used_blobids, page_num) == false) { 5681 /* Invalid blobid */ 5682 cb_fn(cb_arg, NULL, -ENOENT); 5683 return; 5684 } 5685 5686 blob = _spdk_blob_lookup(bs, blobid); 5687 if (blob) { 5688 blob->open_ref++; 5689 cb_fn(cb_arg, blob, 0); 5690 return; 5691 } 5692 5693 blob = _spdk_blob_alloc(bs, blobid); 5694 if (!blob) { 5695 cb_fn(cb_arg, NULL, -ENOMEM); 5696 return; 5697 } 5698 5699 if (!opts) { 5700 spdk_blob_open_opts_init(&opts_default); 5701 opts = &opts_default; 5702 } 5703 5704 blob->clear_method = opts->clear_method; 5705 5706 cpl.type = SPDK_BS_CPL_TYPE_BLOB_HANDLE; 5707 cpl.u.blob_handle.cb_fn = cb_fn; 5708 cpl.u.blob_handle.cb_arg = cb_arg; 5709 cpl.u.blob_handle.blob = blob; 5710 5711 seq = spdk_bs_sequence_start(bs->md_channel, &cpl); 5712 if (!seq) { 5713 _spdk_blob_free(blob); 5714 cb_fn(cb_arg, NULL, -ENOMEM); 5715 return; 5716 } 5717 5718 _spdk_blob_load(seq, blob, _spdk_bs_open_blob_cpl, blob); 5719 } 5720 5721 void spdk_bs_open_blob(struct spdk_blob_store *bs, spdk_blob_id blobid, 5722 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 5723 { 5724 _spdk_bs_open_blob(bs, blobid, NULL, cb_fn, cb_arg); 5725 } 5726 5727 void spdk_bs_open_blob_ext(struct spdk_blob_store *bs, spdk_blob_id blobid, 5728 struct spdk_blob_open_opts *opts, spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 5729 { 5730 _spdk_bs_open_blob(bs, blobid, opts, cb_fn, cb_arg); 5731 } 5732 5733 /* END spdk_bs_open_blob */ 5734 5735 /* START spdk_blob_set_read_only */ 5736 int spdk_blob_set_read_only(struct spdk_blob *blob) 5737 { 5738 _spdk_blob_verify_md_op(blob); 5739 5740 blob->data_ro_flags |= SPDK_BLOB_READ_ONLY; 5741 5742 blob->state = SPDK_BLOB_STATE_DIRTY; 5743 return 0; 5744 } 5745 /* END spdk_blob_set_read_only */ 5746 5747 /* START spdk_blob_sync_md */ 5748 5749 static void 5750 _spdk_blob_sync_md_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5751 { 5752 struct spdk_blob *blob = cb_arg; 5753 5754 if (bserrno == 0 && (blob->data_ro_flags & SPDK_BLOB_READ_ONLY)) { 5755 blob->data_ro = true; 5756 blob->md_ro = true; 5757 } 5758 5759 spdk_bs_sequence_finish(seq, bserrno); 5760 } 5761 5762 static void 5763 _spdk_blob_sync_md(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 5764 { 5765 struct spdk_bs_cpl cpl; 5766 spdk_bs_sequence_t *seq; 5767 5768 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 5769 cpl.u.blob_basic.cb_fn = cb_fn; 5770 cpl.u.blob_basic.cb_arg = cb_arg; 5771 5772 seq = spdk_bs_sequence_start(blob->bs->md_channel, &cpl); 5773 if (!seq) { 5774 cb_fn(cb_arg, -ENOMEM); 5775 return; 5776 } 5777 5778 _spdk_blob_persist(seq, blob, _spdk_blob_sync_md_cpl, blob); 5779 } 5780 5781 void 5782 spdk_blob_sync_md(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 5783 { 5784 _spdk_blob_verify_md_op(blob); 5785 5786 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Syncing blob %lu\n", blob->id); 5787 5788 if (blob->md_ro) { 5789 assert(blob->state == SPDK_BLOB_STATE_CLEAN); 5790 cb_fn(cb_arg, 0); 5791 return; 5792 } 5793 5794 _spdk_blob_sync_md(blob, cb_fn, cb_arg); 5795 } 5796 5797 /* END spdk_blob_sync_md */ 5798 5799 struct spdk_blob_insert_cluster_ctx { 5800 struct spdk_thread *thread; 5801 struct spdk_blob *blob; 5802 uint32_t cluster_num; /* cluster index in blob */ 5803 uint32_t cluster; /* cluster on disk */ 5804 int rc; 5805 spdk_blob_op_complete cb_fn; 5806 void *cb_arg; 5807 }; 5808 5809 static void 5810 _spdk_blob_insert_cluster_msg_cpl(void *arg) 5811 { 5812 struct spdk_blob_insert_cluster_ctx *ctx = arg; 5813 5814 ctx->cb_fn(ctx->cb_arg, ctx->rc); 5815 free(ctx); 5816 } 5817 5818 static void 5819 _spdk_blob_insert_cluster_msg_cb(void *arg, int bserrno) 5820 { 5821 struct spdk_blob_insert_cluster_ctx *ctx = arg; 5822 5823 ctx->rc = bserrno; 5824 spdk_thread_send_msg(ctx->thread, _spdk_blob_insert_cluster_msg_cpl, ctx); 5825 } 5826 5827 static void 5828 _spdk_blob_insert_cluster_msg(void *arg) 5829 { 5830 struct spdk_blob_insert_cluster_ctx *ctx = arg; 5831 5832 ctx->rc = _spdk_blob_insert_cluster(ctx->blob, ctx->cluster_num, ctx->cluster); 5833 if (ctx->rc != 0) { 5834 spdk_thread_send_msg(ctx->thread, _spdk_blob_insert_cluster_msg_cpl, ctx); 5835 return; 5836 } 5837 5838 ctx->blob->state = SPDK_BLOB_STATE_DIRTY; 5839 _spdk_blob_sync_md(ctx->blob, _spdk_blob_insert_cluster_msg_cb, ctx); 5840 } 5841 5842 static void 5843 _spdk_blob_insert_cluster_on_md_thread(struct spdk_blob *blob, uint32_t cluster_num, 5844 uint64_t cluster, spdk_blob_op_complete cb_fn, void *cb_arg) 5845 { 5846 struct spdk_blob_insert_cluster_ctx *ctx; 5847 5848 ctx = calloc(1, sizeof(*ctx)); 5849 if (ctx == NULL) { 5850 cb_fn(cb_arg, -ENOMEM); 5851 return; 5852 } 5853 5854 ctx->thread = spdk_get_thread(); 5855 ctx->blob = blob; 5856 ctx->cluster_num = cluster_num; 5857 ctx->cluster = cluster; 5858 ctx->cb_fn = cb_fn; 5859 ctx->cb_arg = cb_arg; 5860 5861 spdk_thread_send_msg(blob->bs->md_thread, _spdk_blob_insert_cluster_msg, ctx); 5862 } 5863 5864 /* START spdk_blob_close */ 5865 5866 static void 5867 _spdk_blob_close_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno) 5868 { 5869 struct spdk_blob *blob = cb_arg; 5870 5871 if (bserrno == 0) { 5872 blob->open_ref--; 5873 if (blob->open_ref == 0) { 5874 /* 5875 * Blobs with active.num_pages == 0 are deleted blobs. 5876 * these blobs are removed from the blob_store list 5877 * when the deletion process starts - so don't try to 5878 * remove them again. 5879 */ 5880 if (blob->active.num_pages > 0) { 5881 TAILQ_REMOVE(&blob->bs->blobs, blob, link); 5882 } 5883 _spdk_blob_free(blob); 5884 } 5885 } 5886 5887 spdk_bs_sequence_finish(seq, bserrno); 5888 } 5889 5890 void spdk_blob_close(struct spdk_blob *blob, spdk_blob_op_complete cb_fn, void *cb_arg) 5891 { 5892 struct spdk_bs_cpl cpl; 5893 spdk_bs_sequence_t *seq; 5894 5895 _spdk_blob_verify_md_op(blob); 5896 5897 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Closing blob %lu\n", blob->id); 5898 5899 if (blob->open_ref == 0) { 5900 cb_fn(cb_arg, -EBADF); 5901 return; 5902 } 5903 5904 cpl.type = SPDK_BS_CPL_TYPE_BLOB_BASIC; 5905 cpl.u.blob_basic.cb_fn = cb_fn; 5906 cpl.u.blob_basic.cb_arg = cb_arg; 5907 5908 seq = spdk_bs_sequence_start(blob->bs->md_channel, &cpl); 5909 if (!seq) { 5910 cb_fn(cb_arg, -ENOMEM); 5911 return; 5912 } 5913 5914 /* Sync metadata */ 5915 _spdk_blob_persist(seq, blob, _spdk_blob_close_cpl, blob); 5916 } 5917 5918 /* END spdk_blob_close */ 5919 5920 struct spdk_io_channel *spdk_bs_alloc_io_channel(struct spdk_blob_store *bs) 5921 { 5922 return spdk_get_io_channel(bs); 5923 } 5924 5925 void spdk_bs_free_io_channel(struct spdk_io_channel *channel) 5926 { 5927 spdk_put_io_channel(channel); 5928 } 5929 5930 void spdk_blob_io_unmap(struct spdk_blob *blob, struct spdk_io_channel *channel, 5931 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg) 5932 { 5933 _spdk_blob_request_submit_op(blob, channel, NULL, offset, length, cb_fn, cb_arg, 5934 SPDK_BLOB_UNMAP); 5935 } 5936 5937 void spdk_blob_io_write_zeroes(struct spdk_blob *blob, struct spdk_io_channel *channel, 5938 uint64_t offset, uint64_t length, spdk_blob_op_complete cb_fn, void *cb_arg) 5939 { 5940 _spdk_blob_request_submit_op(blob, channel, NULL, offset, length, cb_fn, cb_arg, 5941 SPDK_BLOB_WRITE_ZEROES); 5942 } 5943 5944 void spdk_blob_io_write(struct spdk_blob *blob, struct spdk_io_channel *channel, 5945 void *payload, uint64_t offset, uint64_t length, 5946 spdk_blob_op_complete cb_fn, void *cb_arg) 5947 { 5948 _spdk_blob_request_submit_op(blob, channel, payload, offset, length, cb_fn, cb_arg, 5949 SPDK_BLOB_WRITE); 5950 } 5951 5952 void spdk_blob_io_read(struct spdk_blob *blob, struct spdk_io_channel *channel, 5953 void *payload, uint64_t offset, uint64_t length, 5954 spdk_blob_op_complete cb_fn, void *cb_arg) 5955 { 5956 _spdk_blob_request_submit_op(blob, channel, payload, offset, length, cb_fn, cb_arg, 5957 SPDK_BLOB_READ); 5958 } 5959 5960 void spdk_blob_io_writev(struct spdk_blob *blob, struct spdk_io_channel *channel, 5961 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 5962 spdk_blob_op_complete cb_fn, void *cb_arg) 5963 { 5964 _spdk_blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, false); 5965 } 5966 5967 void spdk_blob_io_readv(struct spdk_blob *blob, struct spdk_io_channel *channel, 5968 struct iovec *iov, int iovcnt, uint64_t offset, uint64_t length, 5969 spdk_blob_op_complete cb_fn, void *cb_arg) 5970 { 5971 _spdk_blob_request_submit_rw_iov(blob, channel, iov, iovcnt, offset, length, cb_fn, cb_arg, true); 5972 } 5973 5974 struct spdk_bs_iter_ctx { 5975 int64_t page_num; 5976 struct spdk_blob_store *bs; 5977 5978 spdk_blob_op_with_handle_complete cb_fn; 5979 void *cb_arg; 5980 }; 5981 5982 static void 5983 _spdk_bs_iter_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno) 5984 { 5985 struct spdk_bs_iter_ctx *ctx = cb_arg; 5986 struct spdk_blob_store *bs = ctx->bs; 5987 spdk_blob_id id; 5988 5989 if (bserrno == 0) { 5990 ctx->cb_fn(ctx->cb_arg, _blob, bserrno); 5991 free(ctx); 5992 return; 5993 } 5994 5995 ctx->page_num++; 5996 ctx->page_num = spdk_bit_array_find_first_set(bs->used_blobids, ctx->page_num); 5997 if (ctx->page_num >= spdk_bit_array_capacity(bs->used_blobids)) { 5998 ctx->cb_fn(ctx->cb_arg, NULL, -ENOENT); 5999 free(ctx); 6000 return; 6001 } 6002 6003 id = _spdk_bs_page_to_blobid(ctx->page_num); 6004 6005 spdk_bs_open_blob(bs, id, _spdk_bs_iter_cpl, ctx); 6006 } 6007 6008 void 6009 spdk_bs_iter_first(struct spdk_blob_store *bs, 6010 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 6011 { 6012 struct spdk_bs_iter_ctx *ctx; 6013 6014 ctx = calloc(1, sizeof(*ctx)); 6015 if (!ctx) { 6016 cb_fn(cb_arg, NULL, -ENOMEM); 6017 return; 6018 } 6019 6020 ctx->page_num = -1; 6021 ctx->bs = bs; 6022 ctx->cb_fn = cb_fn; 6023 ctx->cb_arg = cb_arg; 6024 6025 _spdk_bs_iter_cpl(ctx, NULL, -1); 6026 } 6027 6028 static void 6029 _spdk_bs_iter_close_cpl(void *cb_arg, int bserrno) 6030 { 6031 struct spdk_bs_iter_ctx *ctx = cb_arg; 6032 6033 _spdk_bs_iter_cpl(ctx, NULL, -1); 6034 } 6035 6036 void 6037 spdk_bs_iter_next(struct spdk_blob_store *bs, struct spdk_blob *blob, 6038 spdk_blob_op_with_handle_complete cb_fn, void *cb_arg) 6039 { 6040 struct spdk_bs_iter_ctx *ctx; 6041 6042 assert(blob != NULL); 6043 6044 ctx = calloc(1, sizeof(*ctx)); 6045 if (!ctx) { 6046 cb_fn(cb_arg, NULL, -ENOMEM); 6047 return; 6048 } 6049 6050 ctx->page_num = _spdk_bs_blobid_to_page(blob->id); 6051 ctx->bs = bs; 6052 ctx->cb_fn = cb_fn; 6053 ctx->cb_arg = cb_arg; 6054 6055 /* Close the existing blob */ 6056 spdk_blob_close(blob, _spdk_bs_iter_close_cpl, ctx); 6057 } 6058 6059 static int 6060 _spdk_blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 6061 uint16_t value_len, bool internal) 6062 { 6063 struct spdk_xattr_tailq *xattrs; 6064 struct spdk_xattr *xattr; 6065 size_t desc_size; 6066 6067 _spdk_blob_verify_md_op(blob); 6068 6069 if (blob->md_ro) { 6070 return -EPERM; 6071 } 6072 6073 desc_size = sizeof(struct spdk_blob_md_descriptor_xattr) + strlen(name) + value_len; 6074 if (desc_size > SPDK_BS_MAX_DESC_SIZE) { 6075 SPDK_DEBUGLOG(SPDK_LOG_BLOB, "Xattr '%s' of size %ld does not fix into single page %ld\n", name, 6076 desc_size, SPDK_BS_MAX_DESC_SIZE); 6077 return -ENOMEM; 6078 } 6079 6080 if (internal) { 6081 xattrs = &blob->xattrs_internal; 6082 blob->invalid_flags |= SPDK_BLOB_INTERNAL_XATTR; 6083 } else { 6084 xattrs = &blob->xattrs; 6085 } 6086 6087 TAILQ_FOREACH(xattr, xattrs, link) { 6088 if (!strcmp(name, xattr->name)) { 6089 free(xattr->value); 6090 xattr->value_len = value_len; 6091 xattr->value = malloc(value_len); 6092 memcpy(xattr->value, value, value_len); 6093 6094 blob->state = SPDK_BLOB_STATE_DIRTY; 6095 6096 return 0; 6097 } 6098 } 6099 6100 xattr = calloc(1, sizeof(*xattr)); 6101 if (!xattr) { 6102 return -ENOMEM; 6103 } 6104 xattr->name = strdup(name); 6105 xattr->value_len = value_len; 6106 xattr->value = malloc(value_len); 6107 memcpy(xattr->value, value, value_len); 6108 TAILQ_INSERT_TAIL(xattrs, xattr, link); 6109 6110 blob->state = SPDK_BLOB_STATE_DIRTY; 6111 6112 return 0; 6113 } 6114 6115 int 6116 spdk_blob_set_xattr(struct spdk_blob *blob, const char *name, const void *value, 6117 uint16_t value_len) 6118 { 6119 return _spdk_blob_set_xattr(blob, name, value, value_len, false); 6120 } 6121 6122 static int 6123 _spdk_blob_remove_xattr(struct spdk_blob *blob, const char *name, bool internal) 6124 { 6125 struct spdk_xattr_tailq *xattrs; 6126 struct spdk_xattr *xattr; 6127 6128 _spdk_blob_verify_md_op(blob); 6129 6130 if (blob->md_ro) { 6131 return -EPERM; 6132 } 6133 xattrs = internal ? &blob->xattrs_internal : &blob->xattrs; 6134 6135 TAILQ_FOREACH(xattr, xattrs, link) { 6136 if (!strcmp(name, xattr->name)) { 6137 TAILQ_REMOVE(xattrs, xattr, link); 6138 free(xattr->value); 6139 free(xattr->name); 6140 free(xattr); 6141 6142 if (internal && TAILQ_EMPTY(&blob->xattrs_internal)) { 6143 blob->invalid_flags &= ~SPDK_BLOB_INTERNAL_XATTR; 6144 } 6145 blob->state = SPDK_BLOB_STATE_DIRTY; 6146 6147 return 0; 6148 } 6149 } 6150 6151 return -ENOENT; 6152 } 6153 6154 int 6155 spdk_blob_remove_xattr(struct spdk_blob *blob, const char *name) 6156 { 6157 return _spdk_blob_remove_xattr(blob, name, false); 6158 } 6159 6160 static int 6161 _spdk_blob_get_xattr_value(struct spdk_blob *blob, const char *name, 6162 const void **value, size_t *value_len, bool internal) 6163 { 6164 struct spdk_xattr *xattr; 6165 struct spdk_xattr_tailq *xattrs; 6166 6167 xattrs = internal ? &blob->xattrs_internal : &blob->xattrs; 6168 6169 TAILQ_FOREACH(xattr, xattrs, link) { 6170 if (!strcmp(name, xattr->name)) { 6171 *value = xattr->value; 6172 *value_len = xattr->value_len; 6173 return 0; 6174 } 6175 } 6176 return -ENOENT; 6177 } 6178 6179 int 6180 spdk_blob_get_xattr_value(struct spdk_blob *blob, const char *name, 6181 const void **value, size_t *value_len) 6182 { 6183 _spdk_blob_verify_md_op(blob); 6184 6185 return _spdk_blob_get_xattr_value(blob, name, value, value_len, false); 6186 } 6187 6188 struct spdk_xattr_names { 6189 uint32_t count; 6190 const char *names[0]; 6191 }; 6192 6193 static int 6194 _spdk_blob_get_xattr_names(struct spdk_xattr_tailq *xattrs, struct spdk_xattr_names **names) 6195 { 6196 struct spdk_xattr *xattr; 6197 int count = 0; 6198 6199 TAILQ_FOREACH(xattr, xattrs, link) { 6200 count++; 6201 } 6202 6203 *names = calloc(1, sizeof(struct spdk_xattr_names) + count * sizeof(char *)); 6204 if (*names == NULL) { 6205 return -ENOMEM; 6206 } 6207 6208 TAILQ_FOREACH(xattr, xattrs, link) { 6209 (*names)->names[(*names)->count++] = xattr->name; 6210 } 6211 6212 return 0; 6213 } 6214 6215 int 6216 spdk_blob_get_xattr_names(struct spdk_blob *blob, struct spdk_xattr_names **names) 6217 { 6218 _spdk_blob_verify_md_op(blob); 6219 6220 return _spdk_blob_get_xattr_names(&blob->xattrs, names); 6221 } 6222 6223 uint32_t 6224 spdk_xattr_names_get_count(struct spdk_xattr_names *names) 6225 { 6226 assert(names != NULL); 6227 6228 return names->count; 6229 } 6230 6231 const char * 6232 spdk_xattr_names_get_name(struct spdk_xattr_names *names, uint32_t index) 6233 { 6234 if (index >= names->count) { 6235 return NULL; 6236 } 6237 6238 return names->names[index]; 6239 } 6240 6241 void 6242 spdk_xattr_names_free(struct spdk_xattr_names *names) 6243 { 6244 free(names); 6245 } 6246 6247 struct spdk_bs_type 6248 spdk_bs_get_bstype(struct spdk_blob_store *bs) 6249 { 6250 return bs->bstype; 6251 } 6252 6253 void 6254 spdk_bs_set_bstype(struct spdk_blob_store *bs, struct spdk_bs_type bstype) 6255 { 6256 memcpy(&bs->bstype, &bstype, sizeof(bstype)); 6257 } 6258 6259 bool 6260 spdk_blob_is_read_only(struct spdk_blob *blob) 6261 { 6262 assert(blob != NULL); 6263 return (blob->data_ro || blob->md_ro); 6264 } 6265 6266 bool 6267 spdk_blob_is_snapshot(struct spdk_blob *blob) 6268 { 6269 struct spdk_blob_list *snapshot_entry; 6270 6271 assert(blob != NULL); 6272 6273 snapshot_entry = _spdk_bs_get_snapshot_entry(blob->bs, blob->id); 6274 if (snapshot_entry == NULL) { 6275 return false; 6276 } 6277 6278 return true; 6279 } 6280 6281 bool 6282 spdk_blob_is_clone(struct spdk_blob *blob) 6283 { 6284 assert(blob != NULL); 6285 6286 if (blob->parent_id != SPDK_BLOBID_INVALID) { 6287 assert(spdk_blob_is_thin_provisioned(blob)); 6288 return true; 6289 } 6290 6291 return false; 6292 } 6293 6294 bool 6295 spdk_blob_is_thin_provisioned(struct spdk_blob *blob) 6296 { 6297 assert(blob != NULL); 6298 return !!(blob->invalid_flags & SPDK_BLOB_THIN_PROV); 6299 } 6300 6301 spdk_blob_id 6302 spdk_blob_get_parent_snapshot(struct spdk_blob_store *bs, spdk_blob_id blob_id) 6303 { 6304 struct spdk_blob_list *snapshot_entry = NULL; 6305 struct spdk_blob_list *clone_entry = NULL; 6306 6307 TAILQ_FOREACH(snapshot_entry, &bs->snapshots, link) { 6308 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 6309 if (clone_entry->id == blob_id) { 6310 return snapshot_entry->id; 6311 } 6312 } 6313 } 6314 6315 return SPDK_BLOBID_INVALID; 6316 } 6317 6318 int 6319 spdk_blob_get_clones(struct spdk_blob_store *bs, spdk_blob_id blobid, spdk_blob_id *ids, 6320 size_t *count) 6321 { 6322 struct spdk_blob_list *snapshot_entry, *clone_entry; 6323 size_t n; 6324 6325 snapshot_entry = _spdk_bs_get_snapshot_entry(bs, blobid); 6326 if (snapshot_entry == NULL) { 6327 *count = 0; 6328 return 0; 6329 } 6330 6331 if (ids == NULL || *count < snapshot_entry->clone_count) { 6332 *count = snapshot_entry->clone_count; 6333 return -ENOMEM; 6334 } 6335 *count = snapshot_entry->clone_count; 6336 6337 n = 0; 6338 TAILQ_FOREACH(clone_entry, &snapshot_entry->clones, link) { 6339 ids[n++] = clone_entry->id; 6340 } 6341 6342 return 0; 6343 } 6344 6345 SPDK_LOG_REGISTER_COMPONENT("blob", SPDK_LOG_BLOB) 6346