drivers/md/dm-era-target.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 #include "dm.h"
   3 #include "persistent-data/dm-transaction-manager.h"
   4 #include "persistent-data/dm-bitset.h"
   5 #include "persistent-data/dm-space-map.h"
   6
   7 #include <linux/dm-io.h>
   8 #include <linux/dm-kcopyd.h>
   9 #include <linux/init.h>
  10 #include <linux/mempool.h>
  11 #include <linux/module.h>
  12 #include <linux/slab.h>
  13 #include <linux/vmalloc.h>
  14
  15 #define DM_MSG_PREFIX "era"
  16
  17 #define SUPERBLOCK_LOCATION 0
  18 #define SUPERBLOCK_MAGIC 2126579579
  19 #define SUPERBLOCK_CSUM_XOR 146538381
  20 #define MIN_ERA_VERSION 1
  21 #define MAX_ERA_VERSION 1
  22 #define INVALID_WRITESET_ROOT SUPERBLOCK_LOCATION
  23 #define MIN_BLOCK_SIZE 8
  24
  25 /*----------------------------------------------------------------
  26  * Writeset
  27  *--------------------------------------------------------------*/
  28 struct writeset_metadata {
  29         uint32_t nr_bits;
  30         dm_block_t root;
  31 };
  32
  33 struct writeset {
  34         struct writeset_metadata md;
  35
  36         /*
  37          * An in core copy of the bits to save constantly doing look ups on
  38          * disk.
  39          */
  40         unsigned long *bits;
  41 };
  42
  43 /*
  44  * This does not free off the on disk bitset as this will normally be done
  45  * after digesting into the era array.
  46  */
  47 static void writeset_free(struct writeset *ws)
  48 {
  49         vfree(ws->bits);
  50 }
  51
  52 static int setup_on_disk_bitset(struct dm_disk_bitset *info,
  53                                 unsigned nr_bits, dm_block_t *root)
  54 {
  55         int r;
  56
  57         r = dm_bitset_empty(info, root);
  58         if (r)
  59                 return r;
  60
  61         return dm_bitset_resize(info, *root, 0, nr_bits, false, root);
  62 }
  63
  64 static size_t bitset_size(unsigned nr_bits)
  65 {
  66         return sizeof(unsigned long) * dm_div_up(nr_bits, BITS_PER_LONG);
  67 }
  68
  69 /*
  70  * Allocates memory for the in core bitset.
  71  */
  72 static int writeset_alloc(struct writeset *ws, dm_block_t nr_blocks)
  73 {
  74         ws->bits = vzalloc(bitset_size(nr_blocks));
  75         if (!ws->bits) {
  76                 DMERR("%s: couldn't allocate in memory bitset", __func__);
  77                 return -ENOMEM;
  78         }
  79
  80         return 0;
  81 }
  82
  83 /*
  84  * Wipes the in-core bitset, and creates a new on disk bitset.
  85  */
  86 static int writeset_init(struct dm_disk_bitset *info, struct writeset *ws,
  87                          dm_block_t nr_blocks)
  88 {
  89         int r;
  90
  91         memset(ws->bits, 0, bitset_size(nr_blocks));
  92
  93         ws->md.nr_bits = nr_blocks;
  94         r = setup_on_disk_bitset(info, ws->md.nr_bits, &ws->md.root);
  95         if (r) {
  96                 DMERR("%s: setup_on_disk_bitset failed", __func__);
  97                 return r;
  98         }
  99
 100         return 0;
 101 }
 102
 103 static bool writeset_marked(struct writeset *ws, dm_block_t block)
 104 {
 105         return test_bit(block, ws->bits);
 106 }
 107
 108 static int writeset_marked_on_disk(struct dm_disk_bitset *info,
 109                                    struct writeset_metadata *m, dm_block_t block,
 110                                    bool *result)
 111 {
 112         dm_block_t old = m->root;
 113
 114         /*
 115          * The bitset was flushed when it was archived, so we know there'll
 116          * be no change to the root.
 117          */
 118         int r = dm_bitset_test_bit(info, m->root, block, &m->root, result);
 119         if (r) {
 120                 DMERR("%s: dm_bitset_test_bit failed", __func__);
 121                 return r;
 122         }
 123
 124         BUG_ON(m->root != old);
 125
 126         return r;
 127 }
 128
 129 /*
 130  * Returns < 0 on error, 0 if the bit wasn't previously set, 1 if it was.
 131  */
 132 static int writeset_test_and_set(struct dm_disk_bitset *info,
 133                                  struct writeset *ws, uint32_t block)
 134 {
 135         int r;
 136
 137         if (!test_and_set_bit(block, ws->bits)) {
 138                 r = dm_bitset_set_bit(info, ws->md.root, block, &ws->md.root);
 139                 if (r) {
 140                         /* FIXME: fail mode */
 141                         return r;
 142                 }
 143
 144                 return 0;
 145         }
 146
 147         return 1;
 148 }
 149
 150 /*----------------------------------------------------------------
 151  * On disk metadata layout
 152  *--------------------------------------------------------------*/
 153 #define SPACE_MAP_ROOT_SIZE 128
 154 #define UUID_LEN 16
 155
 156 struct writeset_disk {
 157         __le32 nr_bits;
 158         __le64 root;
 159 } __packed;
 160
 161 struct superblock_disk {
 162         __le32 csum;
 163         __le32 flags;
 164         __le64 blocknr;
 165
 166         __u8 uuid[UUID_LEN];
 167         __le64 magic;
 168         __le32 version;
 169
 170         __u8 metadata_space_map_root[SPACE_MAP_ROOT_SIZE];
 171
 172         __le32 data_block_size;
 173         __le32 metadata_block_size;
 174         __le32 nr_blocks;
 175
 176         __le32 current_era;
 177         struct writeset_disk current_writeset;
 178
 179         /*
 180          * Only these two fields are valid within the metadata snapshot.
 181          */
 182         __le64 writeset_tree_root;
 183         __le64 era_array_root;
 184
 185         __le64 metadata_snap;
 186 } __packed;
 187
 188 /*----------------------------------------------------------------
 189  * Superblock validation
 190  *--------------------------------------------------------------*/
 191 static void sb_prepare_for_write(struct dm_block_validator *v,
 192                                  struct dm_block *b,
 193                                  size_t sb_block_size)
 194 {
 195         struct superblock_disk *disk = dm_block_data(b);
 196
 197         disk->blocknr = cpu_to_le64(dm_block_location(b));
 198         disk->csum = cpu_to_le32(dm_bm_checksum(&disk->flags,
 199                                                 sb_block_size - sizeof(__le32),
 200                                                 SUPERBLOCK_CSUM_XOR));
 201 }
 202
 203 static int check_metadata_version(struct superblock_disk *disk)
 204 {
 205         uint32_t metadata_version = le32_to_cpu(disk->version);
 206         if (metadata_version < MIN_ERA_VERSION || metadata_version > MAX_ERA_VERSION) {
 207                 DMERR("Era metadata version %u found, but only versions between %u and %u supported.",
 208                       metadata_version, MIN_ERA_VERSION, MAX_ERA_VERSION);
 209                 return -EINVAL;
 210         }
 211
 212         return 0;
 213 }
 214
 215 static int sb_check(struct dm_block_validator *v,
 216                     struct dm_block *b,
 217                     size_t sb_block_size)
 218 {
 219         struct superblock_disk *disk = dm_block_data(b);
 220         __le32 csum_le;
 221
 222         if (dm_block_location(b) != le64_to_cpu(disk->blocknr)) {
 223                 DMERR("sb_check failed: blocknr %llu: wanted %llu",
 224                       le64_to_cpu(disk->blocknr),
 225                       (unsigned long long)dm_block_location(b));
 226                 return -ENOTBLK;
 227         }
 228
 229         if (le64_to_cpu(disk->magic) != SUPERBLOCK_MAGIC) {
 230                 DMERR("sb_check failed: magic %llu: wanted %llu",
 231                       le64_to_cpu(disk->magic),
 232                       (unsigned long long) SUPERBLOCK_MAGIC);
 233                 return -EILSEQ;
 234         }
 235
 236         csum_le = cpu_to_le32(dm_bm_checksum(&disk->flags,
 237                                              sb_block_size - sizeof(__le32),
 238                                              SUPERBLOCK_CSUM_XOR));
 239         if (csum_le != disk->csum) {
 240                 DMERR("sb_check failed: csum %u: wanted %u",
 241                       le32_to_cpu(csum_le), le32_to_cpu(disk->csum));
 242                 return -EILSEQ;
 243         }
 244
 245         return check_metadata_version(disk);
 246 }
 247
 248 static struct dm_block_validator sb_validator = {
 249         .name = "superblock",
 250         .prepare_for_write = sb_prepare_for_write,
 251         .check = sb_check
 252 };
 253
 254 /*----------------------------------------------------------------
 255  * Low level metadata handling
 256  *--------------------------------------------------------------*/
 257 #define DM_ERA_METADATA_BLOCK_SIZE 4096
 258 #define ERA_MAX_CONCURRENT_LOCKS 5
 259
 260 struct era_metadata {
 261         struct block_device *bdev;
 262         struct dm_block_manager *bm;
 263         struct dm_space_map *sm;
 264         struct dm_transaction_manager *tm;
 265
 266         dm_block_t block_size;
 267         uint32_t nr_blocks;
 268
 269         uint32_t current_era;
 270
 271         /*
 272          * We preallocate 2 writesets.  When an era rolls over we
 273          * switch between them. This means the allocation is done at
 274          * preresume time, rather than on the io path.
 275          */
 276         struct writeset writesets[2];
 277         struct writeset *current_writeset;
 278
 279         dm_block_t writeset_tree_root;
 280         dm_block_t era_array_root;
 281
 282         struct dm_disk_bitset bitset_info;
 283         struct dm_btree_info writeset_tree_info;
 284         struct dm_array_info era_array_info;
 285
 286         dm_block_t metadata_snap;
 287
 288         /*
 289          * A flag that is set whenever a writeset has been archived.
 290          */
 291         bool archived_writesets;
 292
 293         /*
 294          * Reading the space map root can fail, so we read it into this
 295          * buffer before the superblock is locked and updated.
 296          */
 297         __u8 metadata_space_map_root[SPACE_MAP_ROOT_SIZE];
 298 };
 299
 300 static int superblock_read_lock(struct era_metadata *md,
 301                                 struct dm_block **sblock)
 302 {
 303         return dm_bm_read_lock(md->bm, SUPERBLOCK_LOCATION,
 304                                &sb_validator, sblock);
 305 }
 306
 307 static int superblock_lock_zero(struct era_metadata *md,
 308                                 struct dm_block **sblock)
 309 {
 310         return dm_bm_write_lock_zero(md->bm, SUPERBLOCK_LOCATION,
 311                                      &sb_validator, sblock);
 312 }
 313
 314 static int superblock_lock(struct era_metadata *md,
 315                            struct dm_block **sblock)
 316 {
 317         return dm_bm_write_lock(md->bm, SUPERBLOCK_LOCATION,
 318                                 &sb_validator, sblock);
 319 }
 320
 321 /* FIXME: duplication with cache and thin */
 322 static int superblock_all_zeroes(struct dm_block_manager *bm, bool *result)
 323 {
 324         int r;
 325         unsigned i;
 326         struct dm_block *b;
 327         __le64 *data_le, zero = cpu_to_le64(0);
 328         unsigned sb_block_size = dm_bm_block_size(bm) / sizeof(__le64);
 329
 330         /*
 331          * We can't use a validator here - it may be all zeroes.
 332          */
 333         r = dm_bm_read_lock(bm, SUPERBLOCK_LOCATION, NULL, &b);
 334         if (r)
 335                 return r;
 336
 337         data_le = dm_block_data(b);
 338         *result = true;
 339         for (i = 0; i < sb_block_size; i++) {
 340                 if (data_le[i] != zero) {
 341                         *result = false;
 342                         break;
 343                 }
 344         }
 345
 346         dm_bm_unlock(b);
 347
 348         return 0;
 349 }
 350
 351 /*----------------------------------------------------------------*/
 352
 353 static void ws_pack(const struct writeset_metadata *core, struct writeset_disk *disk)
 354 {
 355         disk->nr_bits = cpu_to_le32(core->nr_bits);
 356         disk->root = cpu_to_le64(core->root);
 357 }
 358
 359 static void ws_unpack(const struct writeset_disk *disk, struct writeset_metadata *core)
 360 {
 361         core->nr_bits = le32_to_cpu(disk->nr_bits);
 362         core->root = le64_to_cpu(disk->root);
 363 }
 364
 365 static void ws_inc(void *context, const void *value)
 366 {
 367         struct era_metadata *md = context;
 368         struct writeset_disk ws_d;
 369         dm_block_t b;
 370
 371         memcpy(&ws_d, value, sizeof(ws_d));
 372         b = le64_to_cpu(ws_d.root);
 373
 374         dm_tm_inc(md->tm, b);
 375 }
 376
 377 static void ws_dec(void *context, const void *value)
 378 {
 379         struct era_metadata *md = context;
 380         struct writeset_disk ws_d;
 381         dm_block_t b;
 382
 383         memcpy(&ws_d, value, sizeof(ws_d));
 384         b = le64_to_cpu(ws_d.root);
 385
 386         dm_bitset_del(&md->bitset_info, b);
 387 }
 388
 389 static int ws_eq(void *context, const void *value1, const void *value2)
 390 {
 391         return !memcmp(value1, value2, sizeof(struct writeset_metadata));
 392 }
 393
 394 /*----------------------------------------------------------------*/
 395
 396 static void setup_writeset_tree_info(struct era_metadata *md)
 397 {
 398         struct dm_btree_value_type *vt = &md->writeset_tree_info.value_type;
 399         md->writeset_tree_info.tm = md->tm;
 400         md->writeset_tree_info.levels = 1;
 401         vt->context = md;
 402         vt->size = sizeof(struct writeset_disk);
 403         vt->inc = ws_inc;
 404         vt->dec = ws_dec;
 405         vt->equal = ws_eq;
 406 }
 407
 408 static void setup_era_array_info(struct era_metadata *md)
 409
 410 {
 411         struct dm_btree_value_type vt;
 412         vt.context = NULL;
 413         vt.size = sizeof(__le32);
 414         vt.inc = NULL;
 415         vt.dec = NULL;
 416         vt.equal = NULL;
 417
 418         dm_array_info_init(&md->era_array_info, md->tm, &vt);
 419 }
 420
 421 static void setup_infos(struct era_metadata *md)
 422 {
 423         dm_disk_bitset_init(md->tm, &md->bitset_info);
 424         setup_writeset_tree_info(md);
 425         setup_era_array_info(md);
 426 }
 427
 428 /*----------------------------------------------------------------*/
 429
 430 static int create_fresh_metadata(struct era_metadata *md)
 431 {
 432         int r;
 433
 434         r = dm_tm_create_with_sm(md->bm, SUPERBLOCK_LOCATION,
 435                                  &md->tm, &md->sm);
 436         if (r < 0) {
 437                 DMERR("dm_tm_create_with_sm failed");
 438                 return r;
 439         }
 440
 441         setup_infos(md);
 442
 443         r = dm_btree_empty(&md->writeset_tree_info, &md->writeset_tree_root);
 444         if (r) {
 445                 DMERR("couldn't create new writeset tree");
 446                 goto bad;
 447         }
 448
 449         r = dm_array_empty(&md->era_array_info, &md->era_array_root);
 450         if (r) {
 451                 DMERR("couldn't create era array");
 452                 goto bad;
 453         }
 454
 455         return 0;
 456
 457 bad:
 458         dm_sm_destroy(md->sm);
 459         dm_tm_destroy(md->tm);
 460
 461         return r;
 462 }
 463
 464 static int save_sm_root(struct era_metadata *md)
 465 {
 466         int r;
 467         size_t metadata_len;
 468
 469         r = dm_sm_root_size(md->sm, &metadata_len);
 470         if (r < 0)
 471                 return r;
 472
 473         return dm_sm_copy_root(md->sm, &md->metadata_space_map_root,
 474                                metadata_len);
 475 }
 476
 477 static void copy_sm_root(struct era_metadata *md, struct superblock_disk *disk)
 478 {
 479         memcpy(&disk->metadata_space_map_root,
 480                &md->metadata_space_map_root,
 481                sizeof(md->metadata_space_map_root));
 482 }
 483
 484 /*
 485  * Writes a superblock, including the static fields that don't get updated
 486  * with every commit (possible optimisation here).  'md' should be fully
 487  * constructed when this is called.
 488  */
 489 static void prepare_superblock(struct era_metadata *md, struct superblock_disk *disk)
 490 {
 491         disk->magic = cpu_to_le64(SUPERBLOCK_MAGIC);
 492         disk->flags = cpu_to_le32(0ul);
 493
 494         /* FIXME: can't keep blanking the uuid (uuid is currently unused though) */
 495         memset(disk->uuid, 0, sizeof(disk->uuid));
 496         disk->version = cpu_to_le32(MAX_ERA_VERSION);
 497
 498         copy_sm_root(md, disk);
 499
 500         disk->data_block_size = cpu_to_le32(md->block_size);
 501         disk->metadata_block_size = cpu_to_le32(DM_ERA_METADATA_BLOCK_SIZE >> SECTOR_SHIFT);
 502         disk->nr_blocks = cpu_to_le32(md->nr_blocks);
 503         disk->current_era = cpu_to_le32(md->current_era);
 504
 505         ws_pack(&md->current_writeset->md, &disk->current_writeset);
 506         disk->writeset_tree_root = cpu_to_le64(md->writeset_tree_root);
 507         disk->era_array_root = cpu_to_le64(md->era_array_root);
 508         disk->metadata_snap = cpu_to_le64(md->metadata_snap);
 509 }
 510
 511 static int write_superblock(struct era_metadata *md)
 512 {
 513         int r;
 514         struct dm_block *sblock;
 515         struct superblock_disk *disk;
 516
 517         r = save_sm_root(md);
 518         if (r) {
 519                 DMERR("%s: save_sm_root failed", __func__);
 520                 return r;
 521         }
 522
 523         r = superblock_lock_zero(md, &sblock);
 524         if (r)
 525                 return r;
 526
 527         disk = dm_block_data(sblock);
 528         prepare_superblock(md, disk);
 529
 530         return dm_tm_commit(md->tm, sblock);
 531 }
 532
 533 /*
 534  * Assumes block_size and the infos are set.
 535  */
 536 static int format_metadata(struct era_metadata *md)
 537 {
 538         int r;
 539
 540         r = create_fresh_metadata(md);
 541         if (r)
 542                 return r;
 543
 544         r = write_superblock(md);
 545         if (r) {
 546                 dm_sm_destroy(md->sm);
 547                 dm_tm_destroy(md->tm);
 548                 return r;
 549         }
 550
 551         return 0;
 552 }
 553
 554 static int open_metadata(struct era_metadata *md)
 555 {
 556         int r;
 557         struct dm_block *sblock;
 558         struct superblock_disk *disk;
 559
 560         r = superblock_read_lock(md, &sblock);
 561         if (r) {
 562                 DMERR("couldn't read_lock superblock");
 563                 return r;
 564         }
 565
 566         disk = dm_block_data(sblock);
 567         r = dm_tm_open_with_sm(md->bm, SUPERBLOCK_LOCATION,
 568                                disk->metadata_space_map_root,
 569                                sizeof(disk->metadata_space_map_root),
 570                                &md->tm, &md->sm);
 571         if (r) {
 572                 DMERR("dm_tm_open_with_sm failed");
 573                 goto bad;
 574         }
 575
 576         setup_infos(md);
 577
 578         md->block_size = le32_to_cpu(disk->data_block_size);
 579         md->nr_blocks = le32_to_cpu(disk->nr_blocks);
 580         md->current_era = le32_to_cpu(disk->current_era);
 581
 582         ws_unpack(&disk->current_writeset, &md->current_writeset->md);
 583         md->writeset_tree_root = le64_to_cpu(disk->writeset_tree_root);
 584         md->era_array_root = le64_to_cpu(disk->era_array_root);
 585         md->metadata_snap = le64_to_cpu(disk->metadata_snap);
 586         md->archived_writesets = true;
 587
 588         dm_bm_unlock(sblock);
 589
 590         return 0;
 591
 592 bad:
 593         dm_bm_unlock(sblock);
 594         return r;
 595 }
 596
 597 static int open_or_format_metadata(struct era_metadata *md,
 598                                    bool may_format)
 599 {
 600         int r;
 601         bool unformatted = false;
 602
 603         r = superblock_all_zeroes(md->bm, &unformatted);
 604         if (r)
 605                 return r;
 606
 607         if (unformatted)
 608                 return may_format ? format_metadata(md) : -EPERM;
 609
 610         return open_metadata(md);
 611 }
 612
 613 static int create_persistent_data_objects(struct era_metadata *md,
 614                                           bool may_format)
 615 {
 616         int r;
 617
 618         md->bm = dm_block_manager_create(md->bdev, DM_ERA_METADATA_BLOCK_SIZE,
 619                                          ERA_MAX_CONCURRENT_LOCKS);
 620         if (IS_ERR(md->bm)) {
 621                 DMERR("could not create block manager");
 622                 return PTR_ERR(md->bm);
 623         }
 624
 625         r = open_or_format_metadata(md, may_format);
 626         if (r)
 627                 dm_block_manager_destroy(md->bm);
 628
 629         return r;
 630 }
 631
 632 static void destroy_persistent_data_objects(struct era_metadata *md)
 633 {
 634         dm_sm_destroy(md->sm);
 635         dm_tm_destroy(md->tm);
 636         dm_block_manager_destroy(md->bm);
 637 }
 638
 639 /*
 640  * This waits until all era_map threads have picked up the new filter.
 641  */
 642 static void swap_writeset(struct era_metadata *md, struct writeset *new_writeset)
 643 {
 644         rcu_assign_pointer(md->current_writeset, new_writeset);
 645         synchronize_rcu();
 646 }
 647
 648 /*----------------------------------------------------------------
 649  * Writesets get 'digested' into the main era array.
 650  *
 651  * We're using a coroutine here so the worker thread can do the digestion,
 652  * thus avoiding synchronisation of the metadata.  Digesting a whole
 653  * writeset in one go would cause too much latency.
 654  *--------------------------------------------------------------*/
 655 struct digest {
 656         uint32_t era;
 657         unsigned nr_bits, current_bit;
 658         struct writeset_metadata writeset;
 659         __le32 value;
 660         struct dm_disk_bitset info;
 661
 662         int (*step)(struct era_metadata *, struct digest *);
 663 };
 664
 665 static int metadata_digest_lookup_writeset(struct era_metadata *md,
 666                                            struct digest *d);
 667
 668 static int metadata_digest_remove_writeset(struct era_metadata *md,
 669                                            struct digest *d)
 670 {
 671         int r;
 672         uint64_t key = d->era;
 673
 674         r = dm_btree_remove(&md->writeset_tree_info, md->writeset_tree_root,
 675                             &key, &md->writeset_tree_root);
 676         if (r) {
 677                 DMERR("%s: dm_btree_remove failed", __func__);
 678                 return r;
 679         }
 680
 681         d->step = metadata_digest_lookup_writeset;
 682         return 0;
 683 }
 684
 685 #define INSERTS_PER_STEP 100
 686
 687 static int metadata_digest_transcribe_writeset(struct era_metadata *md,
 688                                                struct digest *d)
 689 {
 690         int r;
 691         bool marked;
 692         unsigned b, e = min(d->current_bit + INSERTS_PER_STEP, d->nr_bits);
 693
 694         for (b = d->current_bit; b < e; b++) {
 695                 r = writeset_marked_on_disk(&d->info, &d->writeset, b, &marked);
 696                 if (r) {
 697                         DMERR("%s: writeset_marked_on_disk failed", __func__);
 698                         return r;
 699                 }
 700
 701                 if (!marked)
 702                         continue;
 703
 704                 __dm_bless_for_disk(&d->value);
 705                 r = dm_array_set_value(&md->era_array_info, md->era_array_root,
 706                                        b, &d->value, &md->era_array_root);
 707                 if (r) {
 708                         DMERR("%s: dm_array_set_value failed", __func__);
 709                         return r;
 710                 }
 711         }
 712
 713         if (b == d->nr_bits)
 714                 d->step = metadata_digest_remove_writeset;
 715         else
 716                 d->current_bit = b;
 717
 718         return 0;
 719 }
 720
 721 static int metadata_digest_lookup_writeset(struct era_metadata *md,
 722                                            struct digest *d)
 723 {
 724         int r;
 725         uint64_t key;
 726         struct writeset_disk disk;
 727
 728         r = dm_btree_find_lowest_key(&md->writeset_tree_info,
 729                                      md->writeset_tree_root, &key);
 730         if (r < 0)
 731                 return r;
 732
 733         d->era = key;
 734
 735         r = dm_btree_lookup(&md->writeset_tree_info,
 736                             md->writeset_tree_root, &key, &disk);
 737         if (r) {
 738                 if (r == -ENODATA) {
 739                         d->step = NULL;
 740                         return 0;
 741                 }
 742
 743                 DMERR("%s: dm_btree_lookup failed", __func__);
 744                 return r;
 745         }
 746
 747         ws_unpack(&disk, &d->writeset);
 748         d->value = cpu_to_le32(key);
 749
 750         d->nr_bits = min(d->writeset.nr_bits, md->nr_blocks);
 751         d->current_bit = 0;
 752         d->step = metadata_digest_transcribe_writeset;
 753
 754         return 0;
 755 }
 756
 757 static int metadata_digest_start(struct era_metadata *md, struct digest *d)
 758 {
 759         if (d->step)
 760                 return 0;
 761
 762         memset(d, 0, sizeof(*d));
 763
 764         /*
 765          * We initialise another bitset info to avoid any caching side
 766          * effects with the previous one.
 767          */
 768         dm_disk_bitset_init(md->tm, &d->info);
 769         d->step = metadata_digest_lookup_writeset;
 770
 771         return 0;
 772 }
 773
 774 /*----------------------------------------------------------------
 775  * High level metadata interface.  Target methods should use these, and not
 776  * the lower level ones.
 777  *--------------------------------------------------------------*/
 778 static struct era_metadata *metadata_open(struct block_device *bdev,
 779                                           sector_t block_size,
 780                                           bool may_format)
 781 {
 782         int r;
 783         struct era_metadata *md = kzalloc(sizeof(*md), GFP_KERNEL);
 784
 785         if (!md)
 786                 return NULL;
 787
 788         md->bdev = bdev;
 789         md->block_size = block_size;
 790
 791         md->writesets[0].md.root = INVALID_WRITESET_ROOT;
 792         md->writesets[1].md.root = INVALID_WRITESET_ROOT;
 793         md->current_writeset = &md->writesets[0];
 794
 795         r = create_persistent_data_objects(md, may_format);
 796         if (r) {
 797                 kfree(md);
 798                 return ERR_PTR(r);
 799         }
 800
 801         return md;
 802 }
 803
 804 static void metadata_close(struct era_metadata *md)
 805 {
 806         destroy_persistent_data_objects(md);
 807         kfree(md);
 808 }
 809
 810 static bool valid_nr_blocks(dm_block_t n)
 811 {
 812         /*
 813          * dm_bitset restricts us to 2^32.  test_bit & co. restrict us
 814          * further to 2^31 - 1
 815          */
 816         return n < (1ull << 31);
 817 }
 818
 819 static int metadata_resize(struct era_metadata *md, void *arg)
 820 {
 821         int r;
 822         dm_block_t *new_size = arg;
 823         __le32 value;
 824
 825         if (!valid_nr_blocks(*new_size)) {
 826                 DMERR("Invalid number of origin blocks %llu",
 827                       (unsigned long long) *new_size);
 828                 return -EINVAL;
 829         }
 830
 831         writeset_free(&md->writesets[0]);
 832         writeset_free(&md->writesets[1]);
 833
 834         r = writeset_alloc(&md->writesets[0], *new_size);
 835         if (r) {
 836                 DMERR("%s: writeset_alloc failed for writeset 0", __func__);
 837                 return r;
 838         }
 839
 840         r = writeset_alloc(&md->writesets[1], *new_size);
 841         if (r) {
 842                 DMERR("%s: writeset_alloc failed for writeset 1", __func__);
 843                 return r;
 844         }
 845
 846         value = cpu_to_le32(0u);
 847         __dm_bless_for_disk(&value);
 848         r = dm_array_resize(&md->era_array_info, md->era_array_root,
 849                             md->nr_blocks, *new_size,
 850                             &value, &md->era_array_root);
 851         if (r) {
 852                 DMERR("%s: dm_array_resize failed", __func__);
 853                 return r;
 854         }
 855
 856         md->nr_blocks = *new_size;
 857         return 0;
 858 }
 859
 860 static int metadata_era_archive(struct era_metadata *md)
 861 {
 862         int r;
 863         uint64_t keys[1];
 864         struct writeset_disk value;
 865
 866         r = dm_bitset_flush(&md->bitset_info, md->current_writeset->md.root,
 867                             &md->current_writeset->md.root);
 868         if (r) {
 869                 DMERR("%s: dm_bitset_flush failed", __func__);
 870                 return r;
 871         }
 872
 873         ws_pack(&md->current_writeset->md, &value);
 874
 875         keys[0] = md->current_era;
 876         __dm_bless_for_disk(&value);
 877         r = dm_btree_insert(&md->writeset_tree_info, md->writeset_tree_root,
 878                             keys, &value, &md->writeset_tree_root);
 879         if (r) {
 880                 DMERR("%s: couldn't insert writeset into btree", __func__);
 881                 /* FIXME: fail mode */
 882                 return r;
 883         }
 884
 885         md->current_writeset->md.root = INVALID_WRITESET_ROOT;
 886         md->archived_writesets = true;
 887
 888         return 0;
 889 }
 890
 891 static struct writeset *next_writeset(struct era_metadata *md)
 892 {
 893         return (md->current_writeset == &md->writesets[0]) ?
 894                 &md->writesets[1] : &md->writesets[0];
 895 }
 896
 897 static int metadata_new_era(struct era_metadata *md)
 898 {
 899         int r;
 900         struct writeset *new_writeset = next_writeset(md);
 901
 902         r = writeset_init(&md->bitset_info, new_writeset, md->nr_blocks);
 903         if (r) {
 904                 DMERR("%s: writeset_init failed", __func__);
 905                 return r;
 906         }
 907
 908         swap_writeset(md, new_writeset);
 909         md->current_era++;
 910
 911         return 0;
 912 }
 913
 914 static int metadata_era_rollover(struct era_metadata *md)
 915 {
 916         int r;
 917
 918         if (md->current_writeset->md.root != INVALID_WRITESET_ROOT) {
 919                 r = metadata_era_archive(md);
 920                 if (r) {
 921                         DMERR("%s: metadata_archive_era failed", __func__);
 922                         /* FIXME: fail mode? */
 923                         return r;
 924                 }
 925         }
 926
 927         r = metadata_new_era(md);
 928         if (r) {
 929                 DMERR("%s: new era failed", __func__);
 930                 /* FIXME: fail mode */
 931                 return r;
 932         }
 933
 934         return 0;
 935 }
 936
 937 static bool metadata_current_marked(struct era_metadata *md, dm_block_t block)
 938 {
 939         bool r;
 940         struct writeset *ws;
 941
 942         rcu_read_lock();
 943         ws = rcu_dereference(md->current_writeset);
 944         r = writeset_marked(ws, block);
 945         rcu_read_unlock();
 946
 947         return r;
 948 }
 949
 950 static int metadata_commit(struct era_metadata *md)
 951 {
 952         int r;
 953         struct dm_block *sblock;
 954
 955         if (md->current_writeset->md.root != INVALID_WRITESET_ROOT) {
 956                 r = dm_bitset_flush(&md->bitset_info, md->current_writeset->md.root,
 957                                     &md->current_writeset->md.root);
 958                 if (r) {
 959                         DMERR("%s: bitset flush failed", __func__);
 960                         return r;
 961                 }
 962         }
 963
 964         r = dm_tm_pre_commit(md->tm);
 965         if (r) {
 966                 DMERR("%s: pre commit failed", __func__);
 967                 return r;
 968         }
 969
 970         r = save_sm_root(md);
 971         if (r) {
 972                 DMERR("%s: save_sm_root failed", __func__);
 973                 return r;
 974         }
 975
 976         r = superblock_lock(md, &sblock);
 977         if (r) {
 978                 DMERR("%s: superblock lock failed", __func__);
 979                 return r;
 980         }
 981
 982         prepare_superblock(md, dm_block_data(sblock));
 983
 984         return dm_tm_commit(md->tm, sblock);
 985 }
 986
 987 static int metadata_checkpoint(struct era_metadata *md)
 988 {
 989         /*
 990          * For now we just rollover, but later I want to put a check in to
 991          * avoid this if the filter is still pretty fresh.
 992          */
 993         return metadata_era_rollover(md);
 994 }
 995
 996 /*
 997  * Metadata snapshots allow userland to access era data.
 998  */
 999 static int metadata_take_snap(struct era_metadata *md)
1000 {
1001         int r, inc;
1002         struct dm_block *clone;
1003
1004         if (md->metadata_snap != SUPERBLOCK_LOCATION) {
1005                 DMERR("%s: metadata snapshot already exists", __func__);
1006                 return -EINVAL;
1007         }
1008
1009         r = metadata_era_rollover(md);
1010         if (r) {
1011                 DMERR("%s: era rollover failed", __func__);
1012                 return r;
1013         }
1014
1015         r = metadata_commit(md);
1016         if (r) {
1017                 DMERR("%s: pre commit failed", __func__);
1018                 return r;
1019         }
1020
1021         r = dm_sm_inc_block(md->sm, SUPERBLOCK_LOCATION);
1022         if (r) {
1023                 DMERR("%s: couldn't increment superblock", __func__);
1024                 return r;
1025         }
1026
1027         r = dm_tm_shadow_block(md->tm, SUPERBLOCK_LOCATION,
1028                                &sb_validator, &clone, &inc);
1029         if (r) {
1030                 DMERR("%s: couldn't shadow superblock", __func__);
1031                 dm_sm_dec_block(md->sm, SUPERBLOCK_LOCATION);
1032                 return r;
1033         }
1034         BUG_ON(!inc);
1035
1036         r = dm_sm_inc_block(md->sm, md->writeset_tree_root);
1037         if (r) {
1038                 DMERR("%s: couldn't inc writeset tree root", __func__);
1039                 dm_tm_unlock(md->tm, clone);
1040                 return r;
1041         }
1042
1043         r = dm_sm_inc_block(md->sm, md->era_array_root);
1044         if (r) {
1045                 DMERR("%s: couldn't inc era tree root", __func__);
1046                 dm_sm_dec_block(md->sm, md->writeset_tree_root);
1047                 dm_tm_unlock(md->tm, clone);
1048                 return r;
1049         }
1050
1051         md->metadata_snap = dm_block_location(clone);
1052
1053         dm_tm_unlock(md->tm, clone);
1054
1055         return 0;
1056 }
1057
1058 static int metadata_drop_snap(struct era_metadata *md)
1059 {
1060         int r;
1061         dm_block_t location;
1062         struct dm_block *clone;
1063         struct superblock_disk *disk;
1064
1065         if (md->metadata_snap == SUPERBLOCK_LOCATION) {
1066                 DMERR("%s: no snap to drop", __func__);
1067                 return -EINVAL;
1068         }
1069
1070         r = dm_tm_read_lock(md->tm, md->metadata_snap, &sb_validator, &clone);
1071         if (r) {
1072                 DMERR("%s: couldn't read lock superblock clone", __func__);
1073                 return r;
1074         }
1075
1076         /*
1077          * Whatever happens now we'll commit with no record of the metadata
1078          * snap.
1079          */
1080         md->metadata_snap = SUPERBLOCK_LOCATION;
1081
1082         disk = dm_block_data(clone);
1083         r = dm_btree_del(&md->writeset_tree_info,
1084                          le64_to_cpu(disk->writeset_tree_root));
1085         if (r) {
1086                 DMERR("%s: error deleting writeset tree clone", __func__);
1087                 dm_tm_unlock(md->tm, clone);
1088                 return r;
1089         }
1090
1091         r = dm_array_del(&md->era_array_info, le64_to_cpu(disk->era_array_root));
1092         if (r) {
1093                 DMERR("%s: error deleting era array clone", __func__);
1094                 dm_tm_unlock(md->tm, clone);
1095                 return r;
1096         }
1097
1098         location = dm_block_location(clone);
1099         dm_tm_unlock(md->tm, clone);
1100
1101         return dm_sm_dec_block(md->sm, location);
1102 }
1103
1104 struct metadata_stats {
1105         dm_block_t used;
1106         dm_block_t total;
1107         dm_block_t snap;
1108         uint32_t era;
1109 };
1110
1111 static int metadata_get_stats(struct era_metadata *md, void *ptr)
1112 {
1113         int r;
1114         struct metadata_stats *s = ptr;
1115         dm_block_t nr_free, nr_total;
1116
1117         r = dm_sm_get_nr_free(md->sm, &nr_free);
1118         if (r) {
1119                 DMERR("dm_sm_get_nr_free returned %d", r);
1120                 return r;
1121         }
1122
1123         r = dm_sm_get_nr_blocks(md->sm, &nr_total);
1124         if (r) {
1125                 DMERR("dm_pool_get_metadata_dev_size returned %d", r);
1126                 return r;
1127         }
1128
1129         s->used = nr_total - nr_free;
1130         s->total = nr_total;
1131         s->snap = md->metadata_snap;
1132         s->era = md->current_era;
1133
1134         return 0;
1135 }
1136
1137 /*----------------------------------------------------------------*/
1138
1139 struct era {
1140         struct dm_target *ti;
1141
1142         struct dm_dev *metadata_dev;
1143         struct dm_dev *origin_dev;
1144
1145         dm_block_t nr_blocks;
1146         uint32_t sectors_per_block;
1147         int sectors_per_block_shift;
1148         struct era_metadata *md;
1149
1150         struct workqueue_struct *wq;
1151         struct work_struct worker;
1152
1153         spinlock_t deferred_lock;
1154         struct bio_list deferred_bios;
1155
1156         spinlock_t rpc_lock;
1157         struct list_head rpc_calls;
1158
1159         struct digest digest;
1160         atomic_t suspended;
1161 };
1162
1163 struct rpc {
1164         struct list_head list;
1165
1166         int (*fn0)(struct era_metadata *);
1167         int (*fn1)(struct era_metadata *, void *);
1168         void *arg;
1169         int result;
1170
1171         struct completion complete;
1172 };
1173
1174 /*----------------------------------------------------------------
1175  * Remapping.
1176  *---------------------------------------------------------------*/
1177 static bool block_size_is_power_of_two(struct era *era)
1178 {
1179         return era->sectors_per_block_shift >= 0;
1180 }
1181
1182 static dm_block_t get_block(struct era *era, struct bio *bio)
1183 {
1184         sector_t block_nr = bio->bi_iter.bi_sector;
1185
1186         if (!block_size_is_power_of_two(era))
1187                 (void) sector_div(block_nr, era->sectors_per_block);
1188         else
1189                 block_nr >>= era->sectors_per_block_shift;
1190
1191         return block_nr;
1192 }
1193
1194 static void remap_to_origin(struct era *era, struct bio *bio)
1195 {
1196         bio_set_dev(bio, era->origin_dev->bdev);
1197 }
1198
1199 /*----------------------------------------------------------------
1200  * Worker thread
1201  *--------------------------------------------------------------*/
1202 static void wake_worker(struct era *era)
1203 {
1204         if (!atomic_read(&era->suspended))
1205                 queue_work(era->wq, &era->worker);
1206 }
1207
1208 static void process_old_eras(struct era *era)
1209 {
1210         int r;
1211
1212         if (!era->digest.step)
1213                 return;
1214
1215         r = era->digest.step(era->md, &era->digest);
1216         if (r < 0) {
1217                 DMERR("%s: digest step failed, stopping digestion", __func__);
1218                 era->digest.step = NULL;
1219
1220         } else if (era->digest.step)
1221                 wake_worker(era);
1222 }
1223
1224 static void process_deferred_bios(struct era *era)
1225 {
1226         int r;
1227         struct bio_list deferred_bios, marked_bios;
1228         struct bio *bio;
1229         bool commit_needed = false;
1230         bool failed = false;
1231
1232         bio_list_init(&deferred_bios);
1233         bio_list_init(&marked_bios);
1234
1235         spin_lock(&era->deferred_lock);
1236         bio_list_merge(&deferred_bios, &era->deferred_bios);
1237         bio_list_init(&era->deferred_bios);
1238         spin_unlock(&era->deferred_lock);
1239
1240         while ((bio = bio_list_pop(&deferred_bios))) {
1241                 r = writeset_test_and_set(&era->md->bitset_info,
1242                                           era->md->current_writeset,
1243                                           get_block(era, bio));
1244                 if (r < 0) {
1245                         /*
1246                          * This is bad news, we need to rollback.
1247                          * FIXME: finish.
1248                          */
1249                         failed = true;
1250
1251                 } else if (r == 0)
1252                         commit_needed = true;
1253
1254                 bio_list_add(&marked_bios, bio);
1255         }
1256
1257         if (commit_needed) {
1258                 r = metadata_commit(era->md);
1259                 if (r)
1260                         failed = true;
1261         }
1262
1263         if (failed)
1264                 while ((bio = bio_list_pop(&marked_bios)))
1265                         bio_io_error(bio);
1266         else
1267                 while ((bio = bio_list_pop(&marked_bios)))
1268                         submit_bio_noacct(bio);
1269 }
1270
1271 static void process_rpc_calls(struct era *era)
1272 {
1273         int r;
1274         bool need_commit = false;
1275         struct list_head calls;
1276         struct rpc *rpc, *tmp;
1277
1278         INIT_LIST_HEAD(&calls);
1279         spin_lock(&era->rpc_lock);
1280         list_splice_init(&era->rpc_calls, &calls);
1281         spin_unlock(&era->rpc_lock);
1282
1283         list_for_each_entry_safe(rpc, tmp, &calls, list) {
1284                 rpc->result = rpc->fn0 ? rpc->fn0(era->md) : rpc->fn1(era->md, rpc->arg);
1285                 need_commit = true;
1286         }
1287
1288         if (need_commit) {
1289                 r = metadata_commit(era->md);
1290                 if (r)
1291                         list_for_each_entry_safe(rpc, tmp, &calls, list)
1292                                 rpc->result = r;
1293         }
1294
1295         list_for_each_entry_safe(rpc, tmp, &calls, list)
1296                 complete(&rpc->complete);
1297 }
1298
1299 static void kick_off_digest(struct era *era)
1300 {
1301         if (era->md->archived_writesets) {
1302                 era->md->archived_writesets = false;
1303                 metadata_digest_start(era->md, &era->digest);
1304         }
1305 }
1306
1307 static void do_work(struct work_struct *ws)
1308 {
1309         struct era *era = container_of(ws, struct era, worker);
1310
1311         kick_off_digest(era);
1312         process_old_eras(era);
1313         process_deferred_bios(era);
1314         process_rpc_calls(era);
1315 }
1316
1317 static void defer_bio(struct era *era, struct bio *bio)
1318 {
1319         spin_lock(&era->deferred_lock);
1320         bio_list_add(&era->deferred_bios, bio);
1321         spin_unlock(&era->deferred_lock);
1322
1323         wake_worker(era);
1324 }
1325
1326 /*
1327  * Make an rpc call to the worker to change the metadata.
1328  */
1329 static int perform_rpc(struct era *era, struct rpc *rpc)
1330 {
1331         rpc->result = 0;
1332         init_completion(&rpc->complete);
1333
1334         spin_lock(&era->rpc_lock);
1335         list_add(&rpc->list, &era->rpc_calls);
1336         spin_unlock(&era->rpc_lock);
1337
1338         wake_worker(era);
1339         wait_for_completion(&rpc->complete);
1340
1341         return rpc->result;
1342 }
1343
1344 static int in_worker0(struct era *era, int (*fn)(struct era_metadata *))
1345 {
1346         struct rpc rpc;
1347         rpc.fn0 = fn;
1348         rpc.fn1 = NULL;
1349
1350         return perform_rpc(era, &rpc);
1351 }
1352
1353 static int in_worker1(struct era *era,
1354                       int (*fn)(struct era_metadata *, void *), void *arg)
1355 {
1356         struct rpc rpc;
1357         rpc.fn0 = NULL;
1358         rpc.fn1 = fn;
1359         rpc.arg = arg;
1360
1361         return perform_rpc(era, &rpc);
1362 }
1363
1364 static void start_worker(struct era *era)
1365 {
1366         atomic_set(&era->suspended, 0);
1367 }
1368
1369 static void stop_worker(struct era *era)
1370 {
1371         atomic_set(&era->suspended, 1);
1372         flush_workqueue(era->wq);
1373 }
1374
1375 /*----------------------------------------------------------------
1376  * Target methods
1377  *--------------------------------------------------------------*/
1378 static void era_destroy(struct era *era)
1379 {
1380         if (era->md)
1381                 metadata_close(era->md);
1382
1383         if (era->wq)
1384                 destroy_workqueue(era->wq);
1385
1386         if (era->origin_dev)
1387                 dm_put_device(era->ti, era->origin_dev);
1388
1389         if (era->metadata_dev)
1390                 dm_put_device(era->ti, era->metadata_dev);
1391
1392         kfree(era);
1393 }
1394
1395 static dm_block_t calc_nr_blocks(struct era *era)
1396 {
1397         return dm_sector_div_up(era->ti->len, era->sectors_per_block);
1398 }
1399
1400 static bool valid_block_size(dm_block_t block_size)
1401 {
1402         bool greater_than_zero = block_size > 0;
1403         bool multiple_of_min_block_size = (block_size & (MIN_BLOCK_SIZE - 1)) == 0;
1404
1405         return greater_than_zero && multiple_of_min_block_size;
1406 }
1407
1408 /*
1409  * <metadata dev> <data dev> <data block size (sectors)>
1410  */
1411 static int era_ctr(struct dm_target *ti, unsigned argc, char **argv)
1412 {
1413         int r;
1414         char dummy;
1415         struct era *era;
1416         struct era_metadata *md;
1417
1418         if (argc != 3) {
1419                 ti->error = "Invalid argument count";
1420                 return -EINVAL;
1421         }
1422
1423         era = kzalloc(sizeof(*era), GFP_KERNEL);
1424         if (!era) {
1425                 ti->error = "Error allocating era structure";
1426                 return -ENOMEM;
1427         }
1428
1429         era->ti = ti;
1430
1431         r = dm_get_device(ti, argv[0], FMODE_READ | FMODE_WRITE, &era->metadata_dev);
1432         if (r) {
1433                 ti->error = "Error opening metadata device";
1434                 era_destroy(era);
1435                 return -EINVAL;
1436         }
1437
1438         r = dm_get_device(ti, argv[1], FMODE_READ | FMODE_WRITE, &era->origin_dev);
1439         if (r) {
1440                 ti->error = "Error opening data device";
1441                 era_destroy(era);
1442                 return -EINVAL;
1443         }
1444
1445         r = sscanf(argv[2], "%u%c", &era->sectors_per_block, &dummy);
1446         if (r != 1) {
1447                 ti->error = "Error parsing block size";
1448                 era_destroy(era);
1449                 return -EINVAL;
1450         }
1451
1452         r = dm_set_target_max_io_len(ti, era->sectors_per_block);
1453         if (r) {
1454                 ti->error = "could not set max io len";
1455                 era_destroy(era);
1456                 return -EINVAL;
1457         }
1458
1459         if (!valid_block_size(era->sectors_per_block)) {
1460                 ti->error = "Invalid block size";
1461                 era_destroy(era);
1462                 return -EINVAL;
1463         }
1464         if (era->sectors_per_block & (era->sectors_per_block - 1))
1465                 era->sectors_per_block_shift = -1;
1466         else
1467                 era->sectors_per_block_shift = __ffs(era->sectors_per_block);
1468
1469         md = metadata_open(era->metadata_dev->bdev, era->sectors_per_block, true);
1470         if (IS_ERR(md)) {
1471                 ti->error = "Error reading metadata";
1472                 era_destroy(era);
1473                 return PTR_ERR(md);
1474         }
1475         era->md = md;
1476
1477         era->nr_blocks = calc_nr_blocks(era);
1478
1479         r = metadata_resize(era->md, &era->nr_blocks);
1480         if (r) {
1481                 ti->error = "couldn't resize metadata";
1482                 era_destroy(era);
1483                 return -ENOMEM;
1484         }
1485
1486         era->wq = alloc_ordered_workqueue("dm-" DM_MSG_PREFIX, WQ_MEM_RECLAIM);
1487         if (!era->wq) {
1488                 ti->error = "could not create workqueue for metadata object";
1489                 era_destroy(era);
1490                 return -ENOMEM;
1491         }
1492         INIT_WORK(&era->worker, do_work);
1493
1494         spin_lock_init(&era->deferred_lock);
1495         bio_list_init(&era->deferred_bios);
1496
1497         spin_lock_init(&era->rpc_lock);
1498         INIT_LIST_HEAD(&era->rpc_calls);
1499
1500         ti->private = era;
1501         ti->num_flush_bios = 1;
1502         ti->flush_supported = true;
1503
1504         ti->num_discard_bios = 1;
1505
1506         return 0;
1507 }
1508
1509 static void era_dtr(struct dm_target *ti)
1510 {
1511         era_destroy(ti->private);
1512 }
1513
1514 static int era_map(struct dm_target *ti, struct bio *bio)
1515 {
1516         struct era *era = ti->private;
1517         dm_block_t block = get_block(era, bio);
1518
1519         /*
1520          * All bios get remapped to the origin device.  We do this now, but
1521          * it may not get issued until later.  Depending on whether the
1522          * block is marked in this era.
1523          */
1524         remap_to_origin(era, bio);
1525
1526         /*
1527          * REQ_PREFLUSH bios carry no data, so we're not interested in them.
1528          */
1529         if (!(bio->bi_opf & REQ_PREFLUSH) &&
1530             (bio_data_dir(bio) == WRITE) &&
1531             !metadata_current_marked(era->md, block)) {
1532                 defer_bio(era, bio);
1533                 return DM_MAPIO_SUBMITTED;
1534         }
1535
1536         return DM_MAPIO_REMAPPED;
1537 }
1538
1539 static void era_postsuspend(struct dm_target *ti)
1540 {
1541         int r;
1542         struct era *era = ti->private;
1543
1544         r = in_worker0(era, metadata_era_archive);
1545         if (r) {
1546                 DMERR("%s: couldn't archive current era", __func__);
1547                 /* FIXME: fail mode */
1548         }
1549
1550         stop_worker(era);
1551 }
1552
1553 static int era_preresume(struct dm_target *ti)
1554 {
1555         int r;
1556         struct era *era = ti->private;
1557         dm_block_t new_size = calc_nr_blocks(era);
1558
1559         if (era->nr_blocks != new_size) {
1560                 r = in_worker1(era, metadata_resize, &new_size);
1561                 if (r)
1562                         return r;
1563
1564                 era->nr_blocks = new_size;
1565         }
1566
1567         start_worker(era);
1568
1569         r = in_worker0(era, metadata_era_rollover);
1570         if (r) {
1571                 DMERR("%s: metadata_era_rollover failed", __func__);
1572                 return r;
1573         }
1574
1575         return 0;
1576 }
1577
1578 /*
1579  * Status format:
1580  *
1581  * <metadata block size> <#used metadata blocks>/<#total metadata blocks>
1582  * <current era> <held metadata root | '-'>
1583  */
1584 static void era_status(struct dm_target *ti, status_type_t type,
1585                        unsigned status_flags, char *result, unsigned maxlen)
1586 {
1587         int r;
1588         struct era *era = ti->private;
1589         ssize_t sz = 0;
1590         struct metadata_stats stats;
1591         char buf[BDEVNAME_SIZE];
1592
1593         switch (type) {
1594         case STATUSTYPE_INFO:
1595                 r = in_worker1(era, metadata_get_stats, &stats);
1596                 if (r)
1597                         goto err;
1598
1599                 DMEMIT("%u %llu/%llu %u",
1600                        (unsigned) (DM_ERA_METADATA_BLOCK_SIZE >> SECTOR_SHIFT),
1601                        (unsigned long long) stats.used,
1602                        (unsigned long long) stats.total,
1603                        (unsigned) stats.era);
1604
1605                 if (stats.snap != SUPERBLOCK_LOCATION)
1606                         DMEMIT(" %llu", stats.snap);
1607                 else
1608                         DMEMIT(" -");
1609                 break;
1610
1611         case STATUSTYPE_TABLE:
1612                 format_dev_t(buf, era->metadata_dev->bdev->bd_dev);
1613                 DMEMIT("%s ", buf);
1614                 format_dev_t(buf, era->origin_dev->bdev->bd_dev);
1615                 DMEMIT("%s %u", buf, era->sectors_per_block);
1616                 break;
1617         }
1618
1619         return;
1620
1621 err:
1622         DMEMIT("Error");
1623 }
1624
1625 static int era_message(struct dm_target *ti, unsigned argc, char **argv,
1626                        char *result, unsigned maxlen)
1627 {
1628         struct era *era = ti->private;
1629
1630         if (argc != 1) {
1631                 DMERR("incorrect number of message arguments");
1632                 return -EINVAL;
1633         }
1634
1635         if (!strcasecmp(argv[0], "checkpoint"))
1636                 return in_worker0(era, metadata_checkpoint);
1637
1638         if (!strcasecmp(argv[0], "take_metadata_snap"))
1639                 return in_worker0(era, metadata_take_snap);
1640
1641         if (!strcasecmp(argv[0], "drop_metadata_snap"))
1642                 return in_worker0(era, metadata_drop_snap);
1643
1644         DMERR("unsupported message '%s'", argv[0]);
1645         return -EINVAL;
1646 }
1647
1648 static sector_t get_dev_size(struct dm_dev *dev)
1649 {
1650         return i_size_read(dev->bdev->bd_inode) >> SECTOR_SHIFT;
1651 }
1652
1653 static int era_iterate_devices(struct dm_target *ti,
1654                                iterate_devices_callout_fn fn, void *data)
1655 {
1656         struct era *era = ti->private;
1657         return fn(ti, era->origin_dev, 0, get_dev_size(era->origin_dev), data);
1658 }
1659
1660 static void era_io_hints(struct dm_target *ti, struct queue_limits *limits)
1661 {
1662         struct era *era = ti->private;
1663         uint64_t io_opt_sectors = limits->io_opt >> SECTOR_SHIFT;
1664
1665         /*
1666          * If the system-determined stacked limits are compatible with the
1667          * era device's blocksize (io_opt is a factor) do not override them.
1668          */
1669         if (io_opt_sectors < era->sectors_per_block ||
1670             do_div(io_opt_sectors, era->sectors_per_block)) {
1671                 blk_limits_io_min(limits, 0);
1672                 blk_limits_io_opt(limits, era->sectors_per_block << SECTOR_SHIFT);
1673         }
1674 }
1675
1676 /*----------------------------------------------------------------*/
1677
1678 static struct target_type era_target = {
1679         .name = "era",
1680         .version = {1, 0, 0},
1681         .module = THIS_MODULE,
1682         .ctr = era_ctr,
1683         .dtr = era_dtr,
1684         .map = era_map,
1685         .postsuspend = era_postsuspend,
1686         .preresume = era_preresume,
1687         .status = era_status,
1688         .message = era_message,
1689         .iterate_devices = era_iterate_devices,
1690         .io_hints = era_io_hints
1691 };
1692
1693 static int __init dm_era_init(void)
1694 {
1695         int r;
1696
1697         r = dm_register_target(&era_target);
1698         if (r) {
1699                 DMERR("era target registration failed: %d", r);
1700                 return r;
1701         }
1702
1703         return 0;
1704 }
1705
1706 static void __exit dm_era_exit(void)
1707 {
1708         dm_unregister_target(&era_target);
1709 }
1710
1711 module_init(dm_era_init);
1712 module_exit(dm_era_exit);
1713
1714 MODULE_DESCRIPTION(DM_NAME " era target");
1715 MODULE_AUTHOR("Joe Thornber <ejt@redhat.com>");
1716 MODULE_LICENSE("GPL");