1 // SPDX-License-Identifier: GPL-2.0
3 * bcache setup/teardown code, and some metadata io - read a superblock and
4 * figure out what to do with it.
6 * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
7 * Copyright 2012 Google, Inc.
15 #include "writeback.h"
17 #include <linux/blkdev.h>
18 #include <linux/buffer_head.h>
19 #include <linux/debugfs.h>
20 #include <linux/genhd.h>
21 #include <linux/idr.h>
22 #include <linux/kthread.h>
23 #include <linux/module.h>
24 #include <linux/random.h>
25 #include <linux/reboot.h>
26 #include <linux/sysfs.h>
28 unsigned int bch_cutoff_writeback;
29 unsigned int bch_cutoff_writeback_sync;
31 static const char bcache_magic[] = {
32 0xc6, 0x85, 0x73, 0xf6, 0x4e, 0x1a, 0x45, 0xca,
33 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81
36 static const char invalid_uuid[] = {
37 0xa0, 0x3e, 0xf8, 0xed, 0x3e, 0xe1, 0xb8, 0x78,
38 0xc8, 0x50, 0xfc, 0x5e, 0xcb, 0x16, 0xcd, 0x99
41 static struct kobject *bcache_kobj;
42 struct mutex bch_register_lock;
43 bool bcache_is_reboot;
44 LIST_HEAD(bch_cache_sets);
45 static LIST_HEAD(uncached_devices);
47 static int bcache_major;
48 static DEFINE_IDA(bcache_device_idx);
49 static wait_queue_head_t unregister_wait;
50 struct workqueue_struct *bcache_wq;
51 struct workqueue_struct *bch_journal_wq;
54 #define BTREE_MAX_PAGES (256 * 1024 / PAGE_SIZE)
55 /* limitation of partitions number on single bcache device */
56 #define BCACHE_MINORS 128
57 /* limitation of bcache devices number on single system */
58 #define BCACHE_DEVICE_IDX_MAX ((1U << MINORBITS)/BCACHE_MINORS)
62 static const char *read_super(struct cache_sb *sb, struct block_device *bdev,
67 struct buffer_head *bh = __bread(bdev, 1, SB_SIZE);
73 s = (struct cache_sb *) bh->b_data;
75 sb->offset = le64_to_cpu(s->offset);
76 sb->version = le64_to_cpu(s->version);
78 memcpy(sb->magic, s->magic, 16);
79 memcpy(sb->uuid, s->uuid, 16);
80 memcpy(sb->set_uuid, s->set_uuid, 16);
81 memcpy(sb->label, s->label, SB_LABEL_SIZE);
83 sb->flags = le64_to_cpu(s->flags);
84 sb->seq = le64_to_cpu(s->seq);
85 sb->last_mount = le32_to_cpu(s->last_mount);
86 sb->first_bucket = le16_to_cpu(s->first_bucket);
87 sb->keys = le16_to_cpu(s->keys);
89 for (i = 0; i < SB_JOURNAL_BUCKETS; i++)
90 sb->d[i] = le64_to_cpu(s->d[i]);
92 pr_debug("read sb version %llu, flags %llu, seq %llu, journal size %u",
93 sb->version, sb->flags, sb->seq, sb->keys);
95 err = "Not a bcache superblock";
96 if (sb->offset != SB_SECTOR)
99 if (memcmp(sb->magic, bcache_magic, 16))
102 err = "Too many journal buckets";
103 if (sb->keys > SB_JOURNAL_BUCKETS)
106 err = "Bad checksum";
107 if (s->csum != csum_set(s))
111 if (bch_is_zero(sb->uuid, 16))
114 sb->block_size = le16_to_cpu(s->block_size);
116 err = "Superblock block size smaller than device block size";
117 if (sb->block_size << 9 < bdev_logical_block_size(bdev))
120 switch (sb->version) {
121 case BCACHE_SB_VERSION_BDEV:
122 sb->data_offset = BDEV_DATA_START_DEFAULT;
124 case BCACHE_SB_VERSION_BDEV_WITH_OFFSET:
125 sb->data_offset = le64_to_cpu(s->data_offset);
127 err = "Bad data offset";
128 if (sb->data_offset < BDEV_DATA_START_DEFAULT)
132 case BCACHE_SB_VERSION_CDEV:
133 case BCACHE_SB_VERSION_CDEV_WITH_UUID:
134 sb->nbuckets = le64_to_cpu(s->nbuckets);
135 sb->bucket_size = le16_to_cpu(s->bucket_size);
137 sb->nr_in_set = le16_to_cpu(s->nr_in_set);
138 sb->nr_this_dev = le16_to_cpu(s->nr_this_dev);
140 err = "Too many buckets";
141 if (sb->nbuckets > LONG_MAX)
144 err = "Not enough buckets";
145 if (sb->nbuckets < 1 << 7)
148 err = "Bad block/bucket size";
149 if (!is_power_of_2(sb->block_size) ||
150 sb->block_size > PAGE_SECTORS ||
151 !is_power_of_2(sb->bucket_size) ||
152 sb->bucket_size < PAGE_SECTORS)
155 err = "Invalid superblock: device too small";
156 if (get_capacity(bdev->bd_disk) <
157 sb->bucket_size * sb->nbuckets)
161 if (bch_is_zero(sb->set_uuid, 16))
164 err = "Bad cache device number in set";
165 if (!sb->nr_in_set ||
166 sb->nr_in_set <= sb->nr_this_dev ||
167 sb->nr_in_set > MAX_CACHES_PER_SET)
170 err = "Journal buckets not sequential";
171 for (i = 0; i < sb->keys; i++)
172 if (sb->d[i] != sb->first_bucket + i)
175 err = "Too many journal buckets";
176 if (sb->first_bucket + sb->keys > sb->nbuckets)
179 err = "Invalid superblock: first bucket comes before end of super";
180 if (sb->first_bucket * sb->bucket_size < 16)
185 err = "Unsupported superblock version";
189 sb->last_mount = (u32)ktime_get_real_seconds();
192 get_page(bh->b_page);
199 static void write_bdev_super_endio(struct bio *bio)
201 struct cached_dev *dc = bio->bi_private;
204 bch_count_backing_io_errors(dc, bio);
206 closure_put(&dc->sb_write);
209 static void __write_super(struct cache_sb *sb, struct bio *bio)
211 struct cache_sb *out = page_address(bio_first_page_all(bio));
214 bio->bi_iter.bi_sector = SB_SECTOR;
215 bio->bi_iter.bi_size = SB_SIZE;
216 bio_set_op_attrs(bio, REQ_OP_WRITE, REQ_SYNC|REQ_META);
217 bch_bio_map(bio, NULL);
219 out->offset = cpu_to_le64(sb->offset);
220 out->version = cpu_to_le64(sb->version);
222 memcpy(out->uuid, sb->uuid, 16);
223 memcpy(out->set_uuid, sb->set_uuid, 16);
224 memcpy(out->label, sb->label, SB_LABEL_SIZE);
226 out->flags = cpu_to_le64(sb->flags);
227 out->seq = cpu_to_le64(sb->seq);
229 out->last_mount = cpu_to_le32(sb->last_mount);
230 out->first_bucket = cpu_to_le16(sb->first_bucket);
231 out->keys = cpu_to_le16(sb->keys);
233 for (i = 0; i < sb->keys; i++)
234 out->d[i] = cpu_to_le64(sb->d[i]);
236 out->csum = csum_set(out);
238 pr_debug("ver %llu, flags %llu, seq %llu",
239 sb->version, sb->flags, sb->seq);
244 static void bch_write_bdev_super_unlock(struct closure *cl)
246 struct cached_dev *dc = container_of(cl, struct cached_dev, sb_write);
248 up(&dc->sb_write_mutex);
251 void bch_write_bdev_super(struct cached_dev *dc, struct closure *parent)
253 struct closure *cl = &dc->sb_write;
254 struct bio *bio = &dc->sb_bio;
256 down(&dc->sb_write_mutex);
257 closure_init(cl, parent);
260 bio_set_dev(bio, dc->bdev);
261 bio->bi_end_io = write_bdev_super_endio;
262 bio->bi_private = dc;
265 /* I/O request sent to backing device */
266 __write_super(&dc->sb, bio);
268 closure_return_with_destructor(cl, bch_write_bdev_super_unlock);
271 static void write_super_endio(struct bio *bio)
273 struct cache *ca = bio->bi_private;
276 bch_count_io_errors(ca, bio->bi_status, 0,
277 "writing superblock");
278 closure_put(&ca->set->sb_write);
281 static void bcache_write_super_unlock(struct closure *cl)
283 struct cache_set *c = container_of(cl, struct cache_set, sb_write);
285 up(&c->sb_write_mutex);
288 void bcache_write_super(struct cache_set *c)
290 struct closure *cl = &c->sb_write;
294 down(&c->sb_write_mutex);
295 closure_init(cl, &c->cl);
299 for_each_cache(ca, c, i) {
300 struct bio *bio = &ca->sb_bio;
302 ca->sb.version = BCACHE_SB_VERSION_CDEV_WITH_UUID;
303 ca->sb.seq = c->sb.seq;
304 ca->sb.last_mount = c->sb.last_mount;
306 SET_CACHE_SYNC(&ca->sb, CACHE_SYNC(&c->sb));
309 bio_set_dev(bio, ca->bdev);
310 bio->bi_end_io = write_super_endio;
311 bio->bi_private = ca;
314 __write_super(&ca->sb, bio);
317 closure_return_with_destructor(cl, bcache_write_super_unlock);
322 static void uuid_endio(struct bio *bio)
324 struct closure *cl = bio->bi_private;
325 struct cache_set *c = container_of(cl, struct cache_set, uuid_write);
327 cache_set_err_on(bio->bi_status, c, "accessing uuids");
328 bch_bbio_free(bio, c);
332 static void uuid_io_unlock(struct closure *cl)
334 struct cache_set *c = container_of(cl, struct cache_set, uuid_write);
336 up(&c->uuid_write_mutex);
339 static void uuid_io(struct cache_set *c, int op, unsigned long op_flags,
340 struct bkey *k, struct closure *parent)
342 struct closure *cl = &c->uuid_write;
343 struct uuid_entry *u;
348 down(&c->uuid_write_mutex);
349 closure_init(cl, parent);
351 for (i = 0; i < KEY_PTRS(k); i++) {
352 struct bio *bio = bch_bbio_alloc(c);
354 bio->bi_opf = REQ_SYNC | REQ_META | op_flags;
355 bio->bi_iter.bi_size = KEY_SIZE(k) << 9;
357 bio->bi_end_io = uuid_endio;
358 bio->bi_private = cl;
359 bio_set_op_attrs(bio, op, REQ_SYNC|REQ_META|op_flags);
360 bch_bio_map(bio, c->uuids);
362 bch_submit_bbio(bio, c, k, i);
364 if (op != REQ_OP_WRITE)
368 bch_extent_to_text(buf, sizeof(buf), k);
369 pr_debug("%s UUIDs at %s", op == REQ_OP_WRITE ? "wrote" : "read", buf);
371 for (u = c->uuids; u < c->uuids + c->nr_uuids; u++)
372 if (!bch_is_zero(u->uuid, 16))
373 pr_debug("Slot %zi: %pU: %s: 1st: %u last: %u inv: %u",
374 u - c->uuids, u->uuid, u->label,
375 u->first_reg, u->last_reg, u->invalidated);
377 closure_return_with_destructor(cl, uuid_io_unlock);
380 static char *uuid_read(struct cache_set *c, struct jset *j, struct closure *cl)
382 struct bkey *k = &j->uuid_bucket;
384 if (__bch_btree_ptr_invalid(c, k))
385 return "bad uuid pointer";
387 bkey_copy(&c->uuid_bucket, k);
388 uuid_io(c, REQ_OP_READ, 0, k, cl);
390 if (j->version < BCACHE_JSET_VERSION_UUIDv1) {
391 struct uuid_entry_v0 *u0 = (void *) c->uuids;
392 struct uuid_entry *u1 = (void *) c->uuids;
398 * Since the new uuid entry is bigger than the old, we have to
399 * convert starting at the highest memory address and work down
400 * in order to do it in place
403 for (i = c->nr_uuids - 1;
406 memcpy(u1[i].uuid, u0[i].uuid, 16);
407 memcpy(u1[i].label, u0[i].label, 32);
409 u1[i].first_reg = u0[i].first_reg;
410 u1[i].last_reg = u0[i].last_reg;
411 u1[i].invalidated = u0[i].invalidated;
421 static int __uuid_write(struct cache_set *c)
427 closure_init_stack(&cl);
428 lockdep_assert_held(&bch_register_lock);
430 if (bch_bucket_alloc_set(c, RESERVE_BTREE, &k.key, 1, true))
433 SET_KEY_SIZE(&k.key, c->sb.bucket_size);
434 uuid_io(c, REQ_OP_WRITE, 0, &k.key, &cl);
437 /* Only one bucket used for uuid write */
438 ca = PTR_CACHE(c, &k.key, 0);
439 atomic_long_add(ca->sb.bucket_size, &ca->meta_sectors_written);
441 bkey_copy(&c->uuid_bucket, &k.key);
446 int bch_uuid_write(struct cache_set *c)
448 int ret = __uuid_write(c);
451 bch_journal_meta(c, NULL);
456 static struct uuid_entry *uuid_find(struct cache_set *c, const char *uuid)
458 struct uuid_entry *u;
461 u < c->uuids + c->nr_uuids; u++)
462 if (!memcmp(u->uuid, uuid, 16))
468 static struct uuid_entry *uuid_find_empty(struct cache_set *c)
470 static const char zero_uuid[16] = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
472 return uuid_find(c, zero_uuid);
476 * Bucket priorities/gens:
478 * For each bucket, we store on disk its
482 * See alloc.c for an explanation of the gen. The priority is used to implement
483 * lru (and in the future other) cache replacement policies; for most purposes
484 * it's just an opaque integer.
486 * The gens and the priorities don't have a whole lot to do with each other, and
487 * it's actually the gens that must be written out at specific times - it's no
488 * big deal if the priorities don't get written, if we lose them we just reuse
489 * buckets in suboptimal order.
491 * On disk they're stored in a packed array, and in as many buckets are required
492 * to fit them all. The buckets we use to store them form a list; the journal
493 * header points to the first bucket, the first bucket points to the second
496 * This code is used by the allocation code; periodically (whenever it runs out
497 * of buckets to allocate from) the allocation code will invalidate some
498 * buckets, but it can't use those buckets until their new gens are safely on
502 static void prio_endio(struct bio *bio)
504 struct cache *ca = bio->bi_private;
506 cache_set_err_on(bio->bi_status, ca->set, "accessing priorities");
507 bch_bbio_free(bio, ca->set);
508 closure_put(&ca->prio);
511 static void prio_io(struct cache *ca, uint64_t bucket, int op,
512 unsigned long op_flags)
514 struct closure *cl = &ca->prio;
515 struct bio *bio = bch_bbio_alloc(ca->set);
517 closure_init_stack(cl);
519 bio->bi_iter.bi_sector = bucket * ca->sb.bucket_size;
520 bio_set_dev(bio, ca->bdev);
521 bio->bi_iter.bi_size = bucket_bytes(ca);
523 bio->bi_end_io = prio_endio;
524 bio->bi_private = ca;
525 bio_set_op_attrs(bio, op, REQ_SYNC|REQ_META|op_flags);
526 bch_bio_map(bio, ca->disk_buckets);
528 closure_bio_submit(ca->set, bio, &ca->prio);
532 void bch_prio_write(struct cache *ca)
538 closure_init_stack(&cl);
540 lockdep_assert_held(&ca->set->bucket_lock);
542 ca->disk_buckets->seq++;
544 atomic_long_add(ca->sb.bucket_size * prio_buckets(ca),
545 &ca->meta_sectors_written);
547 //pr_debug("free %zu, free_inc %zu, unused %zu", fifo_used(&ca->free),
548 // fifo_used(&ca->free_inc), fifo_used(&ca->unused));
550 for (i = prio_buckets(ca) - 1; i >= 0; --i) {
552 struct prio_set *p = ca->disk_buckets;
553 struct bucket_disk *d = p->data;
554 struct bucket_disk *end = d + prios_per_bucket(ca);
556 for (b = ca->buckets + i * prios_per_bucket(ca);
557 b < ca->buckets + ca->sb.nbuckets && d < end;
559 d->prio = cpu_to_le16(b->prio);
563 p->next_bucket = ca->prio_buckets[i + 1];
564 p->magic = pset_magic(&ca->sb);
565 p->csum = bch_crc64(&p->magic, bucket_bytes(ca) - 8);
567 bucket = bch_bucket_alloc(ca, RESERVE_PRIO, true);
568 BUG_ON(bucket == -1);
570 mutex_unlock(&ca->set->bucket_lock);
571 prio_io(ca, bucket, REQ_OP_WRITE, 0);
572 mutex_lock(&ca->set->bucket_lock);
574 ca->prio_buckets[i] = bucket;
575 atomic_dec_bug(&ca->buckets[bucket].pin);
578 mutex_unlock(&ca->set->bucket_lock);
580 bch_journal_meta(ca->set, &cl);
583 mutex_lock(&ca->set->bucket_lock);
586 * Don't want the old priorities to get garbage collected until after we
587 * finish writing the new ones, and they're journalled
589 for (i = 0; i < prio_buckets(ca); i++) {
590 if (ca->prio_last_buckets[i])
591 __bch_bucket_free(ca,
592 &ca->buckets[ca->prio_last_buckets[i]]);
594 ca->prio_last_buckets[i] = ca->prio_buckets[i];
598 static void prio_read(struct cache *ca, uint64_t bucket)
600 struct prio_set *p = ca->disk_buckets;
601 struct bucket_disk *d = p->data + prios_per_bucket(ca), *end = d;
603 unsigned int bucket_nr = 0;
605 for (b = ca->buckets;
606 b < ca->buckets + ca->sb.nbuckets;
609 ca->prio_buckets[bucket_nr] = bucket;
610 ca->prio_last_buckets[bucket_nr] = bucket;
613 prio_io(ca, bucket, REQ_OP_READ, 0);
616 bch_crc64(&p->magic, bucket_bytes(ca) - 8))
617 pr_warn("bad csum reading priorities");
619 if (p->magic != pset_magic(&ca->sb))
620 pr_warn("bad magic reading priorities");
622 bucket = p->next_bucket;
626 b->prio = le16_to_cpu(d->prio);
627 b->gen = b->last_gc = d->gen;
633 static int open_dev(struct block_device *b, fmode_t mode)
635 struct bcache_device *d = b->bd_disk->private_data;
637 if (test_bit(BCACHE_DEV_CLOSING, &d->flags))
644 static void release_dev(struct gendisk *b, fmode_t mode)
646 struct bcache_device *d = b->private_data;
651 static int ioctl_dev(struct block_device *b, fmode_t mode,
652 unsigned int cmd, unsigned long arg)
654 struct bcache_device *d = b->bd_disk->private_data;
656 return d->ioctl(d, mode, cmd, arg);
659 static const struct block_device_operations bcache_ops = {
661 .release = release_dev,
663 .owner = THIS_MODULE,
666 void bcache_device_stop(struct bcache_device *d)
668 if (!test_and_set_bit(BCACHE_DEV_CLOSING, &d->flags))
671 * - cached device: cached_dev_flush()
672 * - flash dev: flash_dev_flush()
674 closure_queue(&d->cl);
677 static void bcache_device_unlink(struct bcache_device *d)
679 lockdep_assert_held(&bch_register_lock);
681 if (d->c && !test_and_set_bit(BCACHE_DEV_UNLINK_DONE, &d->flags)) {
685 sysfs_remove_link(&d->c->kobj, d->name);
686 sysfs_remove_link(&d->kobj, "cache");
688 for_each_cache(ca, d->c, i)
689 bd_unlink_disk_holder(ca->bdev, d->disk);
693 static void bcache_device_link(struct bcache_device *d, struct cache_set *c,
700 for_each_cache(ca, d->c, i)
701 bd_link_disk_holder(ca->bdev, d->disk);
703 snprintf(d->name, BCACHEDEVNAME_SIZE,
704 "%s%u", name, d->id);
706 ret = sysfs_create_link(&d->kobj, &c->kobj, "cache");
708 pr_err("Couldn't create device -> cache set symlink");
710 ret = sysfs_create_link(&c->kobj, &d->kobj, d->name);
712 pr_err("Couldn't create cache set -> device symlink");
714 clear_bit(BCACHE_DEV_UNLINK_DONE, &d->flags);
717 static void bcache_device_detach(struct bcache_device *d)
719 lockdep_assert_held(&bch_register_lock);
721 atomic_dec(&d->c->attached_dev_nr);
723 if (test_bit(BCACHE_DEV_DETACHING, &d->flags)) {
724 struct uuid_entry *u = d->c->uuids + d->id;
726 SET_UUID_FLASH_ONLY(u, 0);
727 memcpy(u->uuid, invalid_uuid, 16);
728 u->invalidated = cpu_to_le32((u32)ktime_get_real_seconds());
729 bch_uuid_write(d->c);
732 bcache_device_unlink(d);
734 d->c->devices[d->id] = NULL;
735 closure_put(&d->c->caching);
739 static void bcache_device_attach(struct bcache_device *d, struct cache_set *c,
746 if (id >= c->devices_max_used)
747 c->devices_max_used = id + 1;
749 closure_get(&c->caching);
752 static inline int first_minor_to_idx(int first_minor)
754 return (first_minor/BCACHE_MINORS);
757 static inline int idx_to_first_minor(int idx)
759 return (idx * BCACHE_MINORS);
762 static void bcache_device_free(struct bcache_device *d)
764 lockdep_assert_held(&bch_register_lock);
766 pr_info("%s stopped", d->disk->disk_name);
769 bcache_device_detach(d);
770 if (d->disk && d->disk->flags & GENHD_FL_UP)
771 del_gendisk(d->disk);
772 if (d->disk && d->disk->queue)
773 blk_cleanup_queue(d->disk->queue);
775 ida_simple_remove(&bcache_device_idx,
776 first_minor_to_idx(d->disk->first_minor));
780 bioset_exit(&d->bio_split);
781 kvfree(d->full_dirty_stripes);
782 kvfree(d->stripe_sectors_dirty);
784 closure_debug_destroy(&d->cl);
787 static int bcache_device_init(struct bcache_device *d, unsigned int block_size,
790 struct request_queue *q;
791 const size_t max_stripes = min_t(size_t, INT_MAX,
792 SIZE_MAX / sizeof(atomic_t));
797 d->stripe_size = 1 << 31;
799 d->nr_stripes = DIV_ROUND_UP_ULL(sectors, d->stripe_size);
801 if (!d->nr_stripes || d->nr_stripes > max_stripes) {
802 pr_err("nr_stripes too large or invalid: %u (start sector beyond end of disk?)",
803 (unsigned int)d->nr_stripes);
807 n = d->nr_stripes * sizeof(atomic_t);
808 d->stripe_sectors_dirty = kvzalloc(n, GFP_KERNEL);
809 if (!d->stripe_sectors_dirty)
812 n = BITS_TO_LONGS(d->nr_stripes) * sizeof(unsigned long);
813 d->full_dirty_stripes = kvzalloc(n, GFP_KERNEL);
814 if (!d->full_dirty_stripes)
817 idx = ida_simple_get(&bcache_device_idx, 0,
818 BCACHE_DEVICE_IDX_MAX, GFP_KERNEL);
822 if (bioset_init(&d->bio_split, 4, offsetof(struct bbio, bio),
823 BIOSET_NEED_BVECS|BIOSET_NEED_RESCUER))
826 d->disk = alloc_disk(BCACHE_MINORS);
830 set_capacity(d->disk, sectors);
831 snprintf(d->disk->disk_name, DISK_NAME_LEN, "bcache%i", idx);
833 d->disk->major = bcache_major;
834 d->disk->first_minor = idx_to_first_minor(idx);
835 d->disk->fops = &bcache_ops;
836 d->disk->private_data = d;
838 q = blk_alloc_queue(GFP_KERNEL);
842 blk_queue_make_request(q, NULL);
845 q->backing_dev_info->congested_data = d;
846 q->limits.max_hw_sectors = UINT_MAX;
847 q->limits.max_sectors = UINT_MAX;
848 q->limits.max_segment_size = UINT_MAX;
849 q->limits.max_segments = BIO_MAX_PAGES;
850 blk_queue_max_discard_sectors(q, UINT_MAX);
851 q->limits.discard_granularity = 512;
852 q->limits.io_min = block_size;
853 q->limits.logical_block_size = block_size;
854 q->limits.physical_block_size = block_size;
855 blk_queue_flag_set(QUEUE_FLAG_NONROT, d->disk->queue);
856 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, d->disk->queue);
857 blk_queue_flag_set(QUEUE_FLAG_DISCARD, d->disk->queue);
859 blk_queue_write_cache(q, true, true);
864 ida_simple_remove(&bcache_device_idx, idx);
871 static void calc_cached_dev_sectors(struct cache_set *c)
873 uint64_t sectors = 0;
874 struct cached_dev *dc;
876 list_for_each_entry(dc, &c->cached_devs, list)
877 sectors += bdev_sectors(dc->bdev);
879 c->cached_dev_sectors = sectors;
882 #define BACKING_DEV_OFFLINE_TIMEOUT 5
883 static int cached_dev_status_update(void *arg)
885 struct cached_dev *dc = arg;
886 struct request_queue *q;
889 * If this delayed worker is stopping outside, directly quit here.
890 * dc->io_disable might be set via sysfs interface, so check it
893 while (!kthread_should_stop() && !dc->io_disable) {
894 q = bdev_get_queue(dc->bdev);
895 if (blk_queue_dying(q))
896 dc->offline_seconds++;
898 dc->offline_seconds = 0;
900 if (dc->offline_seconds >= BACKING_DEV_OFFLINE_TIMEOUT) {
901 pr_err("%s: device offline for %d seconds",
902 dc->backing_dev_name,
903 BACKING_DEV_OFFLINE_TIMEOUT);
904 pr_err("%s: disable I/O request due to backing "
905 "device offline", dc->disk.name);
906 dc->io_disable = true;
907 /* let others know earlier that io_disable is true */
909 bcache_device_stop(&dc->disk);
912 schedule_timeout_interruptible(HZ);
915 wait_for_kthread_stop();
920 int bch_cached_dev_run(struct cached_dev *dc)
922 struct bcache_device *d = &dc->disk;
923 char *buf = kmemdup_nul(dc->sb.label, SB_LABEL_SIZE, GFP_KERNEL);
926 kasprintf(GFP_KERNEL, "CACHED_UUID=%pU", dc->sb.uuid),
927 kasprintf(GFP_KERNEL, "CACHED_LABEL=%s", buf ? : ""),
931 if (dc->io_disable) {
932 pr_err("I/O disabled on cached dev %s",
933 dc->backing_dev_name);
937 if (atomic_xchg(&dc->running, 1)) {
941 pr_info("cached dev %s is running already",
942 dc->backing_dev_name);
947 BDEV_STATE(&dc->sb) != BDEV_STATE_NONE) {
950 closure_init_stack(&cl);
952 SET_BDEV_STATE(&dc->sb, BDEV_STATE_STALE);
953 bch_write_bdev_super(dc, &cl);
958 bd_link_disk_holder(dc->bdev, dc->disk.disk);
960 * won't show up in the uevent file, use udevadm monitor -e instead
961 * only class / kset properties are persistent
963 kobject_uevent_env(&disk_to_dev(d->disk)->kobj, KOBJ_CHANGE, env);
968 if (sysfs_create_link(&d->kobj, &disk_to_dev(d->disk)->kobj, "dev") ||
969 sysfs_create_link(&disk_to_dev(d->disk)->kobj,
970 &d->kobj, "bcache")) {
971 pr_err("Couldn't create bcache dev <-> disk sysfs symlinks");
975 dc->status_update_thread = kthread_run(cached_dev_status_update,
976 dc, "bcache_status_update");
977 if (IS_ERR(dc->status_update_thread)) {
978 pr_warn("failed to create bcache_status_update kthread, "
979 "continue to run without monitoring backing "
987 * If BCACHE_DEV_RATE_DW_RUNNING is set, it means routine of the delayed
988 * work dc->writeback_rate_update is running. Wait until the routine
989 * quits (BCACHE_DEV_RATE_DW_RUNNING is clear), then continue to
990 * cancel it. If BCACHE_DEV_RATE_DW_RUNNING is not clear after time_out
991 * seconds, give up waiting here and continue to cancel it too.
993 static void cancel_writeback_rate_update_dwork(struct cached_dev *dc)
995 int time_out = WRITEBACK_RATE_UPDATE_SECS_MAX * HZ;
998 if (!test_bit(BCACHE_DEV_RATE_DW_RUNNING,
1002 schedule_timeout_interruptible(1);
1003 } while (time_out > 0);
1006 pr_warn("give up waiting for dc->writeback_write_update to quit");
1008 cancel_delayed_work_sync(&dc->writeback_rate_update);
1011 static void cached_dev_detach_finish(struct work_struct *w)
1013 struct cached_dev *dc = container_of(w, struct cached_dev, detach);
1016 closure_init_stack(&cl);
1018 BUG_ON(!test_bit(BCACHE_DEV_DETACHING, &dc->disk.flags));
1019 BUG_ON(refcount_read(&dc->count));
1022 if (test_and_clear_bit(BCACHE_DEV_WB_RUNNING, &dc->disk.flags))
1023 cancel_writeback_rate_update_dwork(dc);
1025 if (!IS_ERR_OR_NULL(dc->writeback_thread)) {
1026 kthread_stop(dc->writeback_thread);
1027 dc->writeback_thread = NULL;
1030 memset(&dc->sb.set_uuid, 0, 16);
1031 SET_BDEV_STATE(&dc->sb, BDEV_STATE_NONE);
1033 bch_write_bdev_super(dc, &cl);
1036 mutex_lock(&bch_register_lock);
1038 calc_cached_dev_sectors(dc->disk.c);
1039 bcache_device_detach(&dc->disk);
1040 list_move(&dc->list, &uncached_devices);
1042 clear_bit(BCACHE_DEV_DETACHING, &dc->disk.flags);
1043 clear_bit(BCACHE_DEV_UNLINK_DONE, &dc->disk.flags);
1045 mutex_unlock(&bch_register_lock);
1047 pr_info("Caching disabled for %s", dc->backing_dev_name);
1049 /* Drop ref we took in cached_dev_detach() */
1050 closure_put(&dc->disk.cl);
1053 void bch_cached_dev_detach(struct cached_dev *dc)
1055 lockdep_assert_held(&bch_register_lock);
1057 if (test_bit(BCACHE_DEV_CLOSING, &dc->disk.flags))
1060 if (test_and_set_bit(BCACHE_DEV_DETACHING, &dc->disk.flags))
1064 * Block the device from being closed and freed until we're finished
1067 closure_get(&dc->disk.cl);
1069 bch_writeback_queue(dc);
1074 int bch_cached_dev_attach(struct cached_dev *dc, struct cache_set *c,
1077 uint32_t rtime = cpu_to_le32((u32)ktime_get_real_seconds());
1078 struct uuid_entry *u;
1079 struct cached_dev *exist_dc, *t;
1082 if ((set_uuid && memcmp(set_uuid, c->sb.set_uuid, 16)) ||
1083 (!set_uuid && memcmp(dc->sb.set_uuid, c->sb.set_uuid, 16)))
1087 pr_err("Can't attach %s: already attached",
1088 dc->backing_dev_name);
1092 if (test_bit(CACHE_SET_STOPPING, &c->flags)) {
1093 pr_err("Can't attach %s: shutting down",
1094 dc->backing_dev_name);
1098 if (dc->sb.block_size < c->sb.block_size) {
1100 pr_err("Couldn't attach %s: block size less than set's block size",
1101 dc->backing_dev_name);
1105 /* Check whether already attached */
1106 list_for_each_entry_safe(exist_dc, t, &c->cached_devs, list) {
1107 if (!memcmp(dc->sb.uuid, exist_dc->sb.uuid, 16)) {
1108 pr_err("Tried to attach %s but duplicate UUID already attached",
1109 dc->backing_dev_name);
1115 u = uuid_find(c, dc->sb.uuid);
1118 (BDEV_STATE(&dc->sb) == BDEV_STATE_STALE ||
1119 BDEV_STATE(&dc->sb) == BDEV_STATE_NONE)) {
1120 memcpy(u->uuid, invalid_uuid, 16);
1121 u->invalidated = cpu_to_le32((u32)ktime_get_real_seconds());
1126 if (BDEV_STATE(&dc->sb) == BDEV_STATE_DIRTY) {
1127 pr_err("Couldn't find uuid for %s in set",
1128 dc->backing_dev_name);
1132 u = uuid_find_empty(c);
1134 pr_err("Not caching %s, no room for UUID",
1135 dc->backing_dev_name);
1141 * Deadlocks since we're called via sysfs...
1142 * sysfs_remove_file(&dc->kobj, &sysfs_attach);
1145 if (bch_is_zero(u->uuid, 16)) {
1148 closure_init_stack(&cl);
1150 memcpy(u->uuid, dc->sb.uuid, 16);
1151 memcpy(u->label, dc->sb.label, SB_LABEL_SIZE);
1152 u->first_reg = u->last_reg = rtime;
1155 memcpy(dc->sb.set_uuid, c->sb.set_uuid, 16);
1156 SET_BDEV_STATE(&dc->sb, BDEV_STATE_CLEAN);
1158 bch_write_bdev_super(dc, &cl);
1161 u->last_reg = rtime;
1165 bcache_device_attach(&dc->disk, c, u - c->uuids);
1166 list_move(&dc->list, &c->cached_devs);
1167 calc_cached_dev_sectors(c);
1170 * dc->c must be set before dc->count != 0 - paired with the mb in
1174 refcount_set(&dc->count, 1);
1176 /* Block writeback thread, but spawn it */
1177 down_write(&dc->writeback_lock);
1178 if (bch_cached_dev_writeback_start(dc)) {
1179 up_write(&dc->writeback_lock);
1180 pr_err("Couldn't start writeback facilities for %s",
1181 dc->disk.disk->disk_name);
1185 if (BDEV_STATE(&dc->sb) == BDEV_STATE_DIRTY) {
1186 atomic_set(&dc->has_dirty, 1);
1187 bch_writeback_queue(dc);
1190 bch_sectors_dirty_init(&dc->disk);
1192 ret = bch_cached_dev_run(dc);
1193 if (ret && (ret != -EBUSY)) {
1194 up_write(&dc->writeback_lock);
1196 * bch_register_lock is held, bcache_device_stop() is not
1197 * able to be directly called. The kthread and kworker
1198 * created previously in bch_cached_dev_writeback_start()
1199 * have to be stopped manually here.
1201 kthread_stop(dc->writeback_thread);
1202 cancel_writeback_rate_update_dwork(dc);
1203 pr_err("Couldn't run cached device %s",
1204 dc->backing_dev_name);
1208 bcache_device_link(&dc->disk, c, "bdev");
1209 atomic_inc(&c->attached_dev_nr);
1211 /* Allow the writeback thread to proceed */
1212 up_write(&dc->writeback_lock);
1214 pr_info("Caching %s as %s on set %pU",
1215 dc->backing_dev_name,
1216 dc->disk.disk->disk_name,
1217 dc->disk.c->sb.set_uuid);
1221 /* when dc->disk.kobj released */
1222 void bch_cached_dev_release(struct kobject *kobj)
1224 struct cached_dev *dc = container_of(kobj, struct cached_dev,
1227 module_put(THIS_MODULE);
1230 static void cached_dev_free(struct closure *cl)
1232 struct cached_dev *dc = container_of(cl, struct cached_dev, disk.cl);
1234 if (test_and_clear_bit(BCACHE_DEV_WB_RUNNING, &dc->disk.flags))
1235 cancel_writeback_rate_update_dwork(dc);
1237 if (!IS_ERR_OR_NULL(dc->writeback_thread))
1238 kthread_stop(dc->writeback_thread);
1239 if (!IS_ERR_OR_NULL(dc->status_update_thread))
1240 kthread_stop(dc->status_update_thread);
1242 mutex_lock(&bch_register_lock);
1244 if (atomic_read(&dc->running))
1245 bd_unlink_disk_holder(dc->bdev, dc->disk.disk);
1246 bcache_device_free(&dc->disk);
1247 list_del(&dc->list);
1249 mutex_unlock(&bch_register_lock);
1251 if (!IS_ERR_OR_NULL(dc->bdev))
1252 blkdev_put(dc->bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
1254 wake_up(&unregister_wait);
1256 kobject_put(&dc->disk.kobj);
1259 static void cached_dev_flush(struct closure *cl)
1261 struct cached_dev *dc = container_of(cl, struct cached_dev, disk.cl);
1262 struct bcache_device *d = &dc->disk;
1264 mutex_lock(&bch_register_lock);
1265 bcache_device_unlink(d);
1266 mutex_unlock(&bch_register_lock);
1268 bch_cache_accounting_destroy(&dc->accounting);
1269 kobject_del(&d->kobj);
1271 continue_at(cl, cached_dev_free, system_wq);
1274 static int cached_dev_init(struct cached_dev *dc, unsigned int block_size)
1278 struct request_queue *q = bdev_get_queue(dc->bdev);
1280 __module_get(THIS_MODULE);
1281 INIT_LIST_HEAD(&dc->list);
1282 closure_init(&dc->disk.cl, NULL);
1283 set_closure_fn(&dc->disk.cl, cached_dev_flush, system_wq);
1284 kobject_init(&dc->disk.kobj, &bch_cached_dev_ktype);
1285 INIT_WORK(&dc->detach, cached_dev_detach_finish);
1286 sema_init(&dc->sb_write_mutex, 1);
1287 INIT_LIST_HEAD(&dc->io_lru);
1288 spin_lock_init(&dc->io_lock);
1289 bch_cache_accounting_init(&dc->accounting, &dc->disk.cl);
1291 dc->sequential_cutoff = 4 << 20;
1293 for (io = dc->io; io < dc->io + RECENT_IO; io++) {
1294 list_add(&io->lru, &dc->io_lru);
1295 hlist_add_head(&io->hash, dc->io_hash + RECENT_IO);
1298 dc->disk.stripe_size = q->limits.io_opt >> 9;
1300 if (dc->disk.stripe_size)
1301 dc->partial_stripes_expensive =
1302 q->limits.raid_partial_stripes_expensive;
1304 ret = bcache_device_init(&dc->disk, block_size,
1305 dc->bdev->bd_part->nr_sects - dc->sb.data_offset);
1309 dc->disk.disk->queue->backing_dev_info->ra_pages =
1310 max(dc->disk.disk->queue->backing_dev_info->ra_pages,
1311 q->backing_dev_info->ra_pages);
1313 atomic_set(&dc->io_errors, 0);
1314 dc->io_disable = false;
1315 dc->error_limit = DEFAULT_CACHED_DEV_ERROR_LIMIT;
1316 /* default to auto */
1317 dc->stop_when_cache_set_failed = BCH_CACHED_DEV_STOP_AUTO;
1319 bch_cached_dev_request_init(dc);
1320 bch_cached_dev_writeback_init(dc);
1324 /* Cached device - bcache superblock */
1326 static int register_bdev(struct cache_sb *sb, struct page *sb_page,
1327 struct block_device *bdev,
1328 struct cached_dev *dc)
1330 const char *err = "cannot allocate memory";
1331 struct cache_set *c;
1334 bdevname(bdev, dc->backing_dev_name);
1335 memcpy(&dc->sb, sb, sizeof(struct cache_sb));
1337 dc->bdev->bd_holder = dc;
1339 bio_init(&dc->sb_bio, dc->sb_bio.bi_inline_vecs, 1);
1340 bio_first_bvec_all(&dc->sb_bio)->bv_page = sb_page;
1344 if (cached_dev_init(dc, sb->block_size << 9))
1347 err = "error creating kobject";
1348 if (kobject_add(&dc->disk.kobj, &part_to_dev(bdev->bd_part)->kobj,
1351 if (bch_cache_accounting_add_kobjs(&dc->accounting, &dc->disk.kobj))
1354 pr_info("registered backing device %s", dc->backing_dev_name);
1356 list_add(&dc->list, &uncached_devices);
1357 /* attach to a matched cache set if it exists */
1358 list_for_each_entry(c, &bch_cache_sets, list)
1359 bch_cached_dev_attach(dc, c, NULL);
1361 if (BDEV_STATE(&dc->sb) == BDEV_STATE_NONE ||
1362 BDEV_STATE(&dc->sb) == BDEV_STATE_STALE) {
1363 err = "failed to run cached device";
1364 ret = bch_cached_dev_run(dc);
1371 pr_notice("error %s: %s", dc->backing_dev_name, err);
1372 bcache_device_stop(&dc->disk);
1376 /* Flash only volumes */
1378 /* When d->kobj released */
1379 void bch_flash_dev_release(struct kobject *kobj)
1381 struct bcache_device *d = container_of(kobj, struct bcache_device,
1386 static void flash_dev_free(struct closure *cl)
1388 struct bcache_device *d = container_of(cl, struct bcache_device, cl);
1390 mutex_lock(&bch_register_lock);
1391 atomic_long_sub(bcache_dev_sectors_dirty(d),
1392 &d->c->flash_dev_dirty_sectors);
1393 bcache_device_free(d);
1394 mutex_unlock(&bch_register_lock);
1395 kobject_put(&d->kobj);
1398 static void flash_dev_flush(struct closure *cl)
1400 struct bcache_device *d = container_of(cl, struct bcache_device, cl);
1402 mutex_lock(&bch_register_lock);
1403 bcache_device_unlink(d);
1404 mutex_unlock(&bch_register_lock);
1405 kobject_del(&d->kobj);
1406 continue_at(cl, flash_dev_free, system_wq);
1409 static int flash_dev_run(struct cache_set *c, struct uuid_entry *u)
1411 struct bcache_device *d = kzalloc(sizeof(struct bcache_device),
1416 closure_init(&d->cl, NULL);
1417 set_closure_fn(&d->cl, flash_dev_flush, system_wq);
1419 kobject_init(&d->kobj, &bch_flash_dev_ktype);
1421 if (bcache_device_init(d, block_bytes(c), u->sectors))
1424 bcache_device_attach(d, c, u - c->uuids);
1425 bch_sectors_dirty_init(d);
1426 bch_flash_dev_request_init(d);
1429 if (kobject_add(&d->kobj, &disk_to_dev(d->disk)->kobj, "bcache"))
1432 bcache_device_link(d, c, "volume");
1436 kobject_put(&d->kobj);
1440 static int flash_devs_run(struct cache_set *c)
1443 struct uuid_entry *u;
1446 u < c->uuids + c->nr_uuids && !ret;
1448 if (UUID_FLASH_ONLY(u))
1449 ret = flash_dev_run(c, u);
1454 int bch_flash_dev_create(struct cache_set *c, uint64_t size)
1456 struct uuid_entry *u;
1458 if (test_bit(CACHE_SET_STOPPING, &c->flags))
1461 if (!test_bit(CACHE_SET_RUNNING, &c->flags))
1464 u = uuid_find_empty(c);
1466 pr_err("Can't create volume, no room for UUID");
1470 get_random_bytes(u->uuid, 16);
1471 memset(u->label, 0, 32);
1472 u->first_reg = u->last_reg = cpu_to_le32((u32)ktime_get_real_seconds());
1474 SET_UUID_FLASH_ONLY(u, 1);
1475 u->sectors = size >> 9;
1479 return flash_dev_run(c, u);
1482 bool bch_cached_dev_error(struct cached_dev *dc)
1484 if (!dc || test_bit(BCACHE_DEV_CLOSING, &dc->disk.flags))
1487 dc->io_disable = true;
1488 /* make others know io_disable is true earlier */
1491 pr_err("stop %s: too many IO errors on backing device %s\n",
1492 dc->disk.disk->disk_name, dc->backing_dev_name);
1494 bcache_device_stop(&dc->disk);
1501 bool bch_cache_set_error(struct cache_set *c, const char *fmt, ...)
1505 if (c->on_error != ON_ERROR_PANIC &&
1506 test_bit(CACHE_SET_STOPPING, &c->flags))
1509 if (test_and_set_bit(CACHE_SET_IO_DISABLE, &c->flags))
1510 pr_info("CACHE_SET_IO_DISABLE already set");
1513 * XXX: we can be called from atomic context
1514 * acquire_console_sem();
1517 pr_err("bcache: error on %pU: ", c->sb.set_uuid);
1519 va_start(args, fmt);
1523 pr_err(", disabling caching\n");
1525 if (c->on_error == ON_ERROR_PANIC)
1526 panic("panic forced after error\n");
1528 bch_cache_set_unregister(c);
1532 /* When c->kobj released */
1533 void bch_cache_set_release(struct kobject *kobj)
1535 struct cache_set *c = container_of(kobj, struct cache_set, kobj);
1538 module_put(THIS_MODULE);
1541 static void cache_set_free(struct closure *cl)
1543 struct cache_set *c = container_of(cl, struct cache_set, cl);
1547 debugfs_remove(c->debug);
1549 bch_open_buckets_free(c);
1550 bch_btree_cache_free(c);
1551 bch_journal_free(c);
1553 mutex_lock(&bch_register_lock);
1554 for_each_cache(ca, c, i)
1557 c->cache[ca->sb.nr_this_dev] = NULL;
1558 kobject_put(&ca->kobj);
1561 bch_bset_sort_state_free(&c->sort);
1562 free_pages((unsigned long) c->uuids, ilog2(bucket_pages(c)));
1564 if (c->moving_gc_wq)
1565 destroy_workqueue(c->moving_gc_wq);
1566 bioset_exit(&c->bio_split);
1567 mempool_exit(&c->fill_iter);
1568 mempool_exit(&c->bio_meta);
1569 mempool_exit(&c->search);
1573 mutex_unlock(&bch_register_lock);
1575 pr_info("Cache set %pU unregistered", c->sb.set_uuid);
1576 wake_up(&unregister_wait);
1578 closure_debug_destroy(&c->cl);
1579 kobject_put(&c->kobj);
1582 static void cache_set_flush(struct closure *cl)
1584 struct cache_set *c = container_of(cl, struct cache_set, caching);
1589 bch_cache_accounting_destroy(&c->accounting);
1591 kobject_put(&c->internal);
1592 kobject_del(&c->kobj);
1594 if (!IS_ERR_OR_NULL(c->gc_thread))
1595 kthread_stop(c->gc_thread);
1597 if (!IS_ERR_OR_NULL(c->root))
1598 list_add(&c->root->list, &c->btree_cache);
1601 * Avoid flushing cached nodes if cache set is retiring
1602 * due to too many I/O errors detected.
1604 if (!test_bit(CACHE_SET_IO_DISABLE, &c->flags))
1605 list_for_each_entry(b, &c->btree_cache, list) {
1606 mutex_lock(&b->write_lock);
1607 if (btree_node_dirty(b))
1608 __bch_btree_node_write(b, NULL);
1609 mutex_unlock(&b->write_lock);
1612 for_each_cache(ca, c, i)
1613 if (ca->alloc_thread)
1614 kthread_stop(ca->alloc_thread);
1616 if (c->journal.cur) {
1617 cancel_delayed_work_sync(&c->journal.work);
1618 /* flush last journal entry if needed */
1619 c->journal.work.work.func(&c->journal.work.work);
1626 * This function is only called when CACHE_SET_IO_DISABLE is set, which means
1627 * cache set is unregistering due to too many I/O errors. In this condition,
1628 * the bcache device might be stopped, it depends on stop_when_cache_set_failed
1629 * value and whether the broken cache has dirty data:
1631 * dc->stop_when_cache_set_failed dc->has_dirty stop bcache device
1632 * BCH_CACHED_STOP_AUTO 0 NO
1633 * BCH_CACHED_STOP_AUTO 1 YES
1634 * BCH_CACHED_DEV_STOP_ALWAYS 0 YES
1635 * BCH_CACHED_DEV_STOP_ALWAYS 1 YES
1637 * The expected behavior is, if stop_when_cache_set_failed is configured to
1638 * "auto" via sysfs interface, the bcache device will not be stopped if the
1639 * backing device is clean on the broken cache device.
1641 static void conditional_stop_bcache_device(struct cache_set *c,
1642 struct bcache_device *d,
1643 struct cached_dev *dc)
1645 if (dc->stop_when_cache_set_failed == BCH_CACHED_DEV_STOP_ALWAYS) {
1646 pr_warn("stop_when_cache_set_failed of %s is \"always\", stop it for failed cache set %pU.",
1647 d->disk->disk_name, c->sb.set_uuid);
1648 bcache_device_stop(d);
1649 } else if (atomic_read(&dc->has_dirty)) {
1651 * dc->stop_when_cache_set_failed == BCH_CACHED_STOP_AUTO
1652 * and dc->has_dirty == 1
1654 pr_warn("stop_when_cache_set_failed of %s is \"auto\" and cache is dirty, stop it to avoid potential data corruption.",
1655 d->disk->disk_name);
1657 * There might be a small time gap that cache set is
1658 * released but bcache device is not. Inside this time
1659 * gap, regular I/O requests will directly go into
1660 * backing device as no cache set attached to. This
1661 * behavior may also introduce potential inconsistence
1662 * data in writeback mode while cache is dirty.
1663 * Therefore before calling bcache_device_stop() due
1664 * to a broken cache device, dc->io_disable should be
1665 * explicitly set to true.
1667 dc->io_disable = true;
1668 /* make others know io_disable is true earlier */
1670 bcache_device_stop(d);
1673 * dc->stop_when_cache_set_failed == BCH_CACHED_STOP_AUTO
1674 * and dc->has_dirty == 0
1676 pr_warn("stop_when_cache_set_failed of %s is \"auto\" and cache is clean, keep it alive.",
1677 d->disk->disk_name);
1681 static void __cache_set_unregister(struct closure *cl)
1683 struct cache_set *c = container_of(cl, struct cache_set, caching);
1684 struct cached_dev *dc;
1685 struct bcache_device *d;
1688 mutex_lock(&bch_register_lock);
1690 for (i = 0; i < c->devices_max_used; i++) {
1695 if (!UUID_FLASH_ONLY(&c->uuids[i]) &&
1696 test_bit(CACHE_SET_UNREGISTERING, &c->flags)) {
1697 dc = container_of(d, struct cached_dev, disk);
1698 bch_cached_dev_detach(dc);
1699 if (test_bit(CACHE_SET_IO_DISABLE, &c->flags))
1700 conditional_stop_bcache_device(c, d, dc);
1702 bcache_device_stop(d);
1706 mutex_unlock(&bch_register_lock);
1708 continue_at(cl, cache_set_flush, system_wq);
1711 void bch_cache_set_stop(struct cache_set *c)
1713 if (!test_and_set_bit(CACHE_SET_STOPPING, &c->flags))
1714 /* closure_fn set to __cache_set_unregister() */
1715 closure_queue(&c->caching);
1718 void bch_cache_set_unregister(struct cache_set *c)
1720 set_bit(CACHE_SET_UNREGISTERING, &c->flags);
1721 bch_cache_set_stop(c);
1724 #define alloc_bucket_pages(gfp, c) \
1725 ((void *) __get_free_pages(__GFP_ZERO|gfp, ilog2(bucket_pages(c))))
1727 struct cache_set *bch_cache_set_alloc(struct cache_sb *sb)
1730 struct cache_set *c = kzalloc(sizeof(struct cache_set), GFP_KERNEL);
1735 __module_get(THIS_MODULE);
1736 closure_init(&c->cl, NULL);
1737 set_closure_fn(&c->cl, cache_set_free, system_wq);
1739 closure_init(&c->caching, &c->cl);
1740 set_closure_fn(&c->caching, __cache_set_unregister, system_wq);
1742 /* Maybe create continue_at_noreturn() and use it here? */
1743 closure_set_stopped(&c->cl);
1744 closure_put(&c->cl);
1746 kobject_init(&c->kobj, &bch_cache_set_ktype);
1747 kobject_init(&c->internal, &bch_cache_set_internal_ktype);
1749 bch_cache_accounting_init(&c->accounting, &c->cl);
1751 memcpy(c->sb.set_uuid, sb->set_uuid, 16);
1752 c->sb.block_size = sb->block_size;
1753 c->sb.bucket_size = sb->bucket_size;
1754 c->sb.nr_in_set = sb->nr_in_set;
1755 c->sb.last_mount = sb->last_mount;
1756 c->bucket_bits = ilog2(sb->bucket_size);
1757 c->block_bits = ilog2(sb->block_size);
1758 c->nr_uuids = bucket_bytes(c) / sizeof(struct uuid_entry);
1759 c->devices_max_used = 0;
1760 atomic_set(&c->attached_dev_nr, 0);
1761 c->btree_pages = bucket_pages(c);
1762 if (c->btree_pages > BTREE_MAX_PAGES)
1763 c->btree_pages = max_t(int, c->btree_pages / 4,
1766 sema_init(&c->sb_write_mutex, 1);
1767 mutex_init(&c->bucket_lock);
1768 init_waitqueue_head(&c->btree_cache_wait);
1769 init_waitqueue_head(&c->bucket_wait);
1770 init_waitqueue_head(&c->gc_wait);
1771 sema_init(&c->uuid_write_mutex, 1);
1773 spin_lock_init(&c->btree_gc_time.lock);
1774 spin_lock_init(&c->btree_split_time.lock);
1775 spin_lock_init(&c->btree_read_time.lock);
1777 bch_moving_init_cache_set(c);
1779 INIT_LIST_HEAD(&c->list);
1780 INIT_LIST_HEAD(&c->cached_devs);
1781 INIT_LIST_HEAD(&c->btree_cache);
1782 INIT_LIST_HEAD(&c->btree_cache_freeable);
1783 INIT_LIST_HEAD(&c->btree_cache_freed);
1784 INIT_LIST_HEAD(&c->data_buckets);
1786 iter_size = (sb->bucket_size / sb->block_size + 1) *
1787 sizeof(struct btree_iter_set);
1789 if (!(c->devices = kcalloc(c->nr_uuids, sizeof(void *), GFP_KERNEL)) ||
1790 mempool_init_slab_pool(&c->search, 32, bch_search_cache) ||
1791 mempool_init_kmalloc_pool(&c->bio_meta, 2,
1792 sizeof(struct bbio) + sizeof(struct bio_vec) *
1794 mempool_init_kmalloc_pool(&c->fill_iter, 1, iter_size) ||
1795 bioset_init(&c->bio_split, 4, offsetof(struct bbio, bio),
1796 BIOSET_NEED_BVECS|BIOSET_NEED_RESCUER) ||
1797 !(c->uuids = alloc_bucket_pages(GFP_KERNEL, c)) ||
1798 !(c->moving_gc_wq = alloc_workqueue("bcache_gc",
1799 WQ_MEM_RECLAIM, 0)) ||
1800 bch_journal_alloc(c) ||
1801 bch_btree_cache_alloc(c) ||
1802 bch_open_buckets_alloc(c) ||
1803 bch_bset_sort_state_init(&c->sort, ilog2(c->btree_pages)))
1806 c->congested_read_threshold_us = 2000;
1807 c->congested_write_threshold_us = 20000;
1808 c->error_limit = DEFAULT_IO_ERROR_LIMIT;
1809 WARN_ON(test_and_clear_bit(CACHE_SET_IO_DISABLE, &c->flags));
1813 bch_cache_set_unregister(c);
1817 static int run_cache_set(struct cache_set *c)
1819 const char *err = "cannot allocate memory";
1820 struct cached_dev *dc, *t;
1825 struct journal_replay *l;
1827 closure_init_stack(&cl);
1829 for_each_cache(ca, c, i)
1830 c->nbuckets += ca->sb.nbuckets;
1833 if (CACHE_SYNC(&c->sb)) {
1837 err = "cannot allocate memory for journal";
1838 if (bch_journal_read(c, &journal))
1841 pr_debug("btree_journal_read() done");
1843 err = "no journal entries found";
1844 if (list_empty(&journal))
1847 j = &list_entry(journal.prev, struct journal_replay, list)->j;
1849 err = "IO error reading priorities";
1850 for_each_cache(ca, c, i)
1851 prio_read(ca, j->prio_bucket[ca->sb.nr_this_dev]);
1854 * If prio_read() fails it'll call cache_set_error and we'll
1855 * tear everything down right away, but if we perhaps checked
1856 * sooner we could avoid journal replay.
1861 err = "bad btree root";
1862 if (__bch_btree_ptr_invalid(c, k))
1865 err = "error reading btree root";
1866 c->root = bch_btree_node_get(c, NULL, k,
1869 if (IS_ERR_OR_NULL(c->root))
1872 list_del_init(&c->root->list);
1873 rw_unlock(true, c->root);
1875 err = uuid_read(c, j, &cl);
1879 err = "error in recovery";
1880 if (bch_btree_check(c))
1883 bch_journal_mark(c, &journal);
1884 bch_initial_gc_finish(c);
1885 pr_debug("btree_check() done");
1888 * bcache_journal_next() can't happen sooner, or
1889 * btree_gc_finish() will give spurious errors about last_gc >
1890 * gc_gen - this is a hack but oh well.
1892 bch_journal_next(&c->journal);
1894 err = "error starting allocator thread";
1895 for_each_cache(ca, c, i)
1896 if (bch_cache_allocator_start(ca))
1900 * First place it's safe to allocate: btree_check() and
1901 * btree_gc_finish() have to run before we have buckets to
1902 * allocate, and bch_bucket_alloc_set() might cause a journal
1903 * entry to be written so bcache_journal_next() has to be called
1906 * If the uuids were in the old format we have to rewrite them
1907 * before the next journal entry is written:
1909 if (j->version < BCACHE_JSET_VERSION_UUID)
1912 err = "bcache: replay journal failed";
1913 if (bch_journal_replay(c, &journal))
1916 pr_notice("invalidating existing data");
1918 for_each_cache(ca, c, i) {
1921 ca->sb.keys = clamp_t(int, ca->sb.nbuckets >> 7,
1922 2, SB_JOURNAL_BUCKETS);
1924 for (j = 0; j < ca->sb.keys; j++)
1925 ca->sb.d[j] = ca->sb.first_bucket + j;
1928 bch_initial_gc_finish(c);
1930 err = "error starting allocator thread";
1931 for_each_cache(ca, c, i)
1932 if (bch_cache_allocator_start(ca))
1935 mutex_lock(&c->bucket_lock);
1936 for_each_cache(ca, c, i)
1938 mutex_unlock(&c->bucket_lock);
1940 err = "cannot allocate new UUID bucket";
1941 if (__uuid_write(c))
1944 err = "cannot allocate new btree root";
1945 c->root = __bch_btree_node_alloc(c, NULL, 0, true, NULL);
1946 if (IS_ERR_OR_NULL(c->root))
1949 mutex_lock(&c->root->write_lock);
1950 bkey_copy_key(&c->root->key, &MAX_KEY);
1951 bch_btree_node_write(c->root, &cl);
1952 mutex_unlock(&c->root->write_lock);
1954 bch_btree_set_root(c->root);
1955 rw_unlock(true, c->root);
1958 * We don't want to write the first journal entry until
1959 * everything is set up - fortunately journal entries won't be
1960 * written until the SET_CACHE_SYNC() here:
1962 SET_CACHE_SYNC(&c->sb, true);
1964 bch_journal_next(&c->journal);
1965 bch_journal_meta(c, &cl);
1968 err = "error starting gc thread";
1969 if (bch_gc_thread_start(c))
1973 c->sb.last_mount = (u32)ktime_get_real_seconds();
1974 bcache_write_super(c);
1976 list_for_each_entry_safe(dc, t, &uncached_devices, list)
1977 bch_cached_dev_attach(dc, c, NULL);
1981 set_bit(CACHE_SET_RUNNING, &c->flags);
1984 while (!list_empty(&journal)) {
1985 l = list_first_entry(&journal, struct journal_replay, list);
1992 bch_cache_set_error(c, "%s", err);
1997 static bool can_attach_cache(struct cache *ca, struct cache_set *c)
1999 return ca->sb.block_size == c->sb.block_size &&
2000 ca->sb.bucket_size == c->sb.bucket_size &&
2001 ca->sb.nr_in_set == c->sb.nr_in_set;
2004 static const char *register_cache_set(struct cache *ca)
2007 const char *err = "cannot allocate memory";
2008 struct cache_set *c;
2010 list_for_each_entry(c, &bch_cache_sets, list)
2011 if (!memcmp(c->sb.set_uuid, ca->sb.set_uuid, 16)) {
2012 if (c->cache[ca->sb.nr_this_dev])
2013 return "duplicate cache set member";
2015 if (!can_attach_cache(ca, c))
2016 return "cache sb does not match set";
2018 if (!CACHE_SYNC(&ca->sb))
2019 SET_CACHE_SYNC(&c->sb, false);
2024 c = bch_cache_set_alloc(&ca->sb);
2028 err = "error creating kobject";
2029 if (kobject_add(&c->kobj, bcache_kobj, "%pU", c->sb.set_uuid) ||
2030 kobject_add(&c->internal, &c->kobj, "internal"))
2033 if (bch_cache_accounting_add_kobjs(&c->accounting, &c->kobj))
2036 bch_debug_init_cache_set(c);
2038 list_add(&c->list, &bch_cache_sets);
2040 sprintf(buf, "cache%i", ca->sb.nr_this_dev);
2041 if (sysfs_create_link(&ca->kobj, &c->kobj, "set") ||
2042 sysfs_create_link(&c->kobj, &ca->kobj, buf))
2045 if (ca->sb.seq > c->sb.seq) {
2046 c->sb.version = ca->sb.version;
2047 memcpy(c->sb.set_uuid, ca->sb.set_uuid, 16);
2048 c->sb.flags = ca->sb.flags;
2049 c->sb.seq = ca->sb.seq;
2050 pr_debug("set version = %llu", c->sb.version);
2053 kobject_get(&ca->kobj);
2055 ca->set->cache[ca->sb.nr_this_dev] = ca;
2056 c->cache_by_alloc[c->caches_loaded++] = ca;
2058 if (c->caches_loaded == c->sb.nr_in_set) {
2059 err = "failed to run cache set";
2060 if (run_cache_set(c) < 0)
2066 bch_cache_set_unregister(c);
2072 /* When ca->kobj released */
2073 void bch_cache_release(struct kobject *kobj)
2075 struct cache *ca = container_of(kobj, struct cache, kobj);
2079 BUG_ON(ca->set->cache[ca->sb.nr_this_dev] != ca);
2080 ca->set->cache[ca->sb.nr_this_dev] = NULL;
2083 free_pages((unsigned long) ca->disk_buckets, ilog2(bucket_pages(ca)));
2084 kfree(ca->prio_buckets);
2087 free_heap(&ca->heap);
2088 free_fifo(&ca->free_inc);
2090 for (i = 0; i < RESERVE_NR; i++)
2091 free_fifo(&ca->free[i]);
2093 if (ca->sb_bio.bi_inline_vecs[0].bv_page)
2094 put_page(bio_first_page_all(&ca->sb_bio));
2096 if (!IS_ERR_OR_NULL(ca->bdev))
2097 blkdev_put(ca->bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
2100 module_put(THIS_MODULE);
2103 static int cache_alloc(struct cache *ca)
2106 size_t btree_buckets;
2109 const char *err = NULL;
2111 __module_get(THIS_MODULE);
2112 kobject_init(&ca->kobj, &bch_cache_ktype);
2114 bio_init(&ca->journal.bio, ca->journal.bio.bi_inline_vecs, 8);
2117 * when ca->sb.njournal_buckets is not zero, journal exists,
2118 * and in bch_journal_replay(), tree node may split,
2119 * so bucket of RESERVE_BTREE type is needed,
2120 * the worst situation is all journal buckets are valid journal,
2121 * and all the keys need to replay,
2122 * so the number of RESERVE_BTREE type buckets should be as much
2123 * as journal buckets
2125 btree_buckets = ca->sb.njournal_buckets ?: 8;
2126 free = roundup_pow_of_two(ca->sb.nbuckets) >> 10;
2129 err = "ca->sb.nbuckets is too small";
2133 if (!init_fifo(&ca->free[RESERVE_BTREE], btree_buckets,
2135 err = "ca->free[RESERVE_BTREE] alloc failed";
2136 goto err_btree_alloc;
2139 if (!init_fifo_exact(&ca->free[RESERVE_PRIO], prio_buckets(ca),
2141 err = "ca->free[RESERVE_PRIO] alloc failed";
2142 goto err_prio_alloc;
2145 if (!init_fifo(&ca->free[RESERVE_MOVINGGC], free, GFP_KERNEL)) {
2146 err = "ca->free[RESERVE_MOVINGGC] alloc failed";
2147 goto err_movinggc_alloc;
2150 if (!init_fifo(&ca->free[RESERVE_NONE], free, GFP_KERNEL)) {
2151 err = "ca->free[RESERVE_NONE] alloc failed";
2152 goto err_none_alloc;
2155 if (!init_fifo(&ca->free_inc, free << 2, GFP_KERNEL)) {
2156 err = "ca->free_inc alloc failed";
2157 goto err_free_inc_alloc;
2160 if (!init_heap(&ca->heap, free << 3, GFP_KERNEL)) {
2161 err = "ca->heap alloc failed";
2162 goto err_heap_alloc;
2165 ca->buckets = vzalloc(array_size(sizeof(struct bucket),
2168 err = "ca->buckets alloc failed";
2169 goto err_buckets_alloc;
2172 ca->prio_buckets = kzalloc(array3_size(sizeof(uint64_t),
2173 prio_buckets(ca), 2),
2175 if (!ca->prio_buckets) {
2176 err = "ca->prio_buckets alloc failed";
2177 goto err_prio_buckets_alloc;
2180 ca->disk_buckets = alloc_bucket_pages(GFP_KERNEL, ca);
2181 if (!ca->disk_buckets) {
2182 err = "ca->disk_buckets alloc failed";
2183 goto err_disk_buckets_alloc;
2186 ca->prio_last_buckets = ca->prio_buckets + prio_buckets(ca);
2188 for_each_bucket(b, ca)
2189 atomic_set(&b->pin, 0);
2192 err_disk_buckets_alloc:
2193 kfree(ca->prio_buckets);
2194 err_prio_buckets_alloc:
2197 free_heap(&ca->heap);
2199 free_fifo(&ca->free_inc);
2201 free_fifo(&ca->free[RESERVE_NONE]);
2203 free_fifo(&ca->free[RESERVE_MOVINGGC]);
2205 free_fifo(&ca->free[RESERVE_PRIO]);
2207 free_fifo(&ca->free[RESERVE_BTREE]);
2210 module_put(THIS_MODULE);
2212 pr_notice("error %s: %s", ca->cache_dev_name, err);
2216 static int register_cache(struct cache_sb *sb, struct page *sb_page,
2217 struct block_device *bdev, struct cache *ca)
2219 const char *err = NULL; /* must be set for any error case */
2222 bdevname(bdev, ca->cache_dev_name);
2223 memcpy(&ca->sb, sb, sizeof(struct cache_sb));
2225 ca->bdev->bd_holder = ca;
2227 bio_init(&ca->sb_bio, ca->sb_bio.bi_inline_vecs, 1);
2228 bio_first_bvec_all(&ca->sb_bio)->bv_page = sb_page;
2231 if (blk_queue_discard(bdev_get_queue(bdev)))
2232 ca->discard = CACHE_DISCARD(&ca->sb);
2234 ret = cache_alloc(ca);
2237 * If we failed here, it means ca->kobj is not initialized yet,
2238 * kobject_put() won't be called and there is no chance to
2239 * call blkdev_put() to bdev in bch_cache_release(). So we
2240 * explicitly call blkdev_put() here.
2242 blkdev_put(bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
2244 err = "cache_alloc(): -ENOMEM";
2245 else if (ret == -EPERM)
2246 err = "cache_alloc(): cache device is too small";
2248 err = "cache_alloc(): unknown error";
2252 if (kobject_add(&ca->kobj,
2253 &part_to_dev(bdev->bd_part)->kobj,
2255 err = "error calling kobject_add";
2260 mutex_lock(&bch_register_lock);
2261 err = register_cache_set(ca);
2262 mutex_unlock(&bch_register_lock);
2269 pr_info("registered cache device %s", ca->cache_dev_name);
2272 kobject_put(&ca->kobj);
2276 pr_notice("error %s: %s", ca->cache_dev_name, err);
2281 /* Global interfaces/init */
2283 static ssize_t register_bcache(struct kobject *k, struct kobj_attribute *attr,
2284 const char *buffer, size_t size);
2285 static ssize_t bch_pending_bdevs_cleanup(struct kobject *k,
2286 struct kobj_attribute *attr,
2287 const char *buffer, size_t size);
2289 kobj_attribute_write(register, register_bcache);
2290 kobj_attribute_write(register_quiet, register_bcache);
2291 kobj_attribute_write(pendings_cleanup, bch_pending_bdevs_cleanup);
2293 static bool bch_is_open_backing(struct block_device *bdev)
2295 struct cache_set *c, *tc;
2296 struct cached_dev *dc, *t;
2298 list_for_each_entry_safe(c, tc, &bch_cache_sets, list)
2299 list_for_each_entry_safe(dc, t, &c->cached_devs, list)
2300 if (dc->bdev == bdev)
2302 list_for_each_entry_safe(dc, t, &uncached_devices, list)
2303 if (dc->bdev == bdev)
2308 static bool bch_is_open_cache(struct block_device *bdev)
2310 struct cache_set *c, *tc;
2314 list_for_each_entry_safe(c, tc, &bch_cache_sets, list)
2315 for_each_cache(ca, c, i)
2316 if (ca->bdev == bdev)
2321 static bool bch_is_open(struct block_device *bdev)
2323 return bch_is_open_cache(bdev) || bch_is_open_backing(bdev);
2326 static ssize_t register_bcache(struct kobject *k, struct kobj_attribute *attr,
2327 const char *buffer, size_t size)
2329 ssize_t ret = -EINVAL;
2330 const char *err = "cannot allocate memory";
2332 struct cache_sb *sb = NULL;
2333 struct block_device *bdev = NULL;
2334 struct page *sb_page = NULL;
2336 if (!try_module_get(THIS_MODULE))
2339 /* For latest state of bcache_is_reboot */
2341 if (bcache_is_reboot)
2344 path = kstrndup(buffer, size, GFP_KERNEL);
2348 sb = kmalloc(sizeof(struct cache_sb), GFP_KERNEL);
2352 err = "failed to open device";
2353 bdev = blkdev_get_by_path(strim(path),
2354 FMODE_READ|FMODE_WRITE|FMODE_EXCL,
2357 if (bdev == ERR_PTR(-EBUSY)) {
2358 bdev = lookup_bdev(strim(path));
2359 mutex_lock(&bch_register_lock);
2360 if (!IS_ERR(bdev) && bch_is_open(bdev))
2361 err = "device already registered";
2363 err = "device busy";
2364 mutex_unlock(&bch_register_lock);
2367 if (attr == &ksysfs_register_quiet)
2373 err = "failed to set blocksize";
2374 if (set_blocksize(bdev, 4096))
2377 err = read_super(sb, bdev, &sb_page);
2381 err = "failed to register device";
2382 if (SB_IS_BDEV(sb)) {
2383 struct cached_dev *dc = kzalloc(sizeof(*dc), GFP_KERNEL);
2388 mutex_lock(&bch_register_lock);
2389 ret = register_bdev(sb, sb_page, bdev, dc);
2390 mutex_unlock(&bch_register_lock);
2391 /* blkdev_put() will be called in cached_dev_free() */
2395 struct cache *ca = kzalloc(sizeof(*ca), GFP_KERNEL);
2400 /* blkdev_put() will be called in bch_cache_release() */
2401 if (register_cache(sb, sb_page, bdev, ca) != 0)
2411 module_put(THIS_MODULE);
2415 blkdev_put(bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
2417 pr_info("error %s: %s", path, err);
2423 struct list_head list;
2424 struct cached_dev *dc;
2427 static ssize_t bch_pending_bdevs_cleanup(struct kobject *k,
2428 struct kobj_attribute *attr,
2432 LIST_HEAD(pending_devs);
2434 struct cached_dev *dc, *tdc;
2435 struct pdev *pdev, *tpdev;
2436 struct cache_set *c, *tc;
2438 mutex_lock(&bch_register_lock);
2439 list_for_each_entry_safe(dc, tdc, &uncached_devices, list) {
2440 pdev = kmalloc(sizeof(struct pdev), GFP_KERNEL);
2444 list_add(&pdev->list, &pending_devs);
2447 list_for_each_entry_safe(pdev, tpdev, &pending_devs, list) {
2448 list_for_each_entry_safe(c, tc, &bch_cache_sets, list) {
2449 char *pdev_set_uuid = pdev->dc->sb.set_uuid;
2450 char *set_uuid = c->sb.uuid;
2452 if (!memcmp(pdev_set_uuid, set_uuid, 16)) {
2453 list_del(&pdev->list);
2459 mutex_unlock(&bch_register_lock);
2461 list_for_each_entry_safe(pdev, tpdev, &pending_devs, list) {
2462 pr_info("delete pdev %p", pdev);
2463 list_del(&pdev->list);
2464 bcache_device_stop(&pdev->dc->disk);
2471 static int bcache_reboot(struct notifier_block *n, unsigned long code, void *x)
2473 if (bcache_is_reboot)
2476 if (code == SYS_DOWN ||
2478 code == SYS_POWER_OFF) {
2480 unsigned long start = jiffies;
2481 bool stopped = false;
2483 struct cache_set *c, *tc;
2484 struct cached_dev *dc, *tdc;
2486 mutex_lock(&bch_register_lock);
2488 if (bcache_is_reboot)
2491 /* New registration is rejected since now */
2492 bcache_is_reboot = true;
2494 * Make registering caller (if there is) on other CPU
2495 * core know bcache_is_reboot set to true earlier
2499 if (list_empty(&bch_cache_sets) &&
2500 list_empty(&uncached_devices))
2503 mutex_unlock(&bch_register_lock);
2505 pr_info("Stopping all devices:");
2508 * The reason bch_register_lock is not held to call
2509 * bch_cache_set_stop() and bcache_device_stop() is to
2510 * avoid potential deadlock during reboot, because cache
2511 * set or bcache device stopping process will acqurie
2512 * bch_register_lock too.
2514 * We are safe here because bcache_is_reboot sets to
2515 * true already, register_bcache() will reject new
2516 * registration now. bcache_is_reboot also makes sure
2517 * bcache_reboot() won't be re-entered on by other thread,
2518 * so there is no race in following list iteration by
2519 * list_for_each_entry_safe().
2521 list_for_each_entry_safe(c, tc, &bch_cache_sets, list)
2522 bch_cache_set_stop(c);
2524 list_for_each_entry_safe(dc, tdc, &uncached_devices, list)
2525 bcache_device_stop(&dc->disk);
2529 * Give an early chance for other kthreads and
2530 * kworkers to stop themselves
2534 /* What's a condition variable? */
2536 long timeout = start + 10 * HZ - jiffies;
2538 mutex_lock(&bch_register_lock);
2539 stopped = list_empty(&bch_cache_sets) &&
2540 list_empty(&uncached_devices);
2542 if (timeout < 0 || stopped)
2545 prepare_to_wait(&unregister_wait, &wait,
2546 TASK_UNINTERRUPTIBLE);
2548 mutex_unlock(&bch_register_lock);
2549 schedule_timeout(timeout);
2552 finish_wait(&unregister_wait, &wait);
2555 pr_info("All devices stopped");
2557 pr_notice("Timeout waiting for devices to be closed");
2559 mutex_unlock(&bch_register_lock);
2565 static struct notifier_block reboot = {
2566 .notifier_call = bcache_reboot,
2567 .priority = INT_MAX, /* before any real devices */
2570 static void bcache_exit(void)
2575 kobject_put(bcache_kobj);
2577 destroy_workqueue(bcache_wq);
2579 destroy_workqueue(bch_journal_wq);
2582 unregister_blkdev(bcache_major, "bcache");
2583 unregister_reboot_notifier(&reboot);
2584 mutex_destroy(&bch_register_lock);
2587 /* Check and fixup module parameters */
2588 static void check_module_parameters(void)
2590 if (bch_cutoff_writeback_sync == 0)
2591 bch_cutoff_writeback_sync = CUTOFF_WRITEBACK_SYNC;
2592 else if (bch_cutoff_writeback_sync > CUTOFF_WRITEBACK_SYNC_MAX) {
2593 pr_warn("set bch_cutoff_writeback_sync (%u) to max value %u",
2594 bch_cutoff_writeback_sync, CUTOFF_WRITEBACK_SYNC_MAX);
2595 bch_cutoff_writeback_sync = CUTOFF_WRITEBACK_SYNC_MAX;
2598 if (bch_cutoff_writeback == 0)
2599 bch_cutoff_writeback = CUTOFF_WRITEBACK;
2600 else if (bch_cutoff_writeback > CUTOFF_WRITEBACK_MAX) {
2601 pr_warn("set bch_cutoff_writeback (%u) to max value %u",
2602 bch_cutoff_writeback, CUTOFF_WRITEBACK_MAX);
2603 bch_cutoff_writeback = CUTOFF_WRITEBACK_MAX;
2606 if (bch_cutoff_writeback > bch_cutoff_writeback_sync) {
2607 pr_warn("set bch_cutoff_writeback (%u) to %u",
2608 bch_cutoff_writeback, bch_cutoff_writeback_sync);
2609 bch_cutoff_writeback = bch_cutoff_writeback_sync;
2613 static int __init bcache_init(void)
2615 static const struct attribute *files[] = {
2616 &ksysfs_register.attr,
2617 &ksysfs_register_quiet.attr,
2618 &ksysfs_pendings_cleanup.attr,
2622 check_module_parameters();
2624 mutex_init(&bch_register_lock);
2625 init_waitqueue_head(&unregister_wait);
2626 register_reboot_notifier(&reboot);
2628 bcache_major = register_blkdev(0, "bcache");
2629 if (bcache_major < 0) {
2630 unregister_reboot_notifier(&reboot);
2631 mutex_destroy(&bch_register_lock);
2632 return bcache_major;
2635 bcache_wq = alloc_workqueue("bcache", WQ_MEM_RECLAIM, 0);
2639 bch_journal_wq = alloc_workqueue("bch_journal", WQ_MEM_RECLAIM, 0);
2640 if (!bch_journal_wq)
2643 bcache_kobj = kobject_create_and_add("bcache", fs_kobj);
2647 if (bch_request_init() ||
2648 sysfs_create_files(bcache_kobj, files))
2652 closure_debug_init();
2654 bcache_is_reboot = false;
2665 module_exit(bcache_exit);
2666 module_init(bcache_init);
2668 module_param(bch_cutoff_writeback, uint, 0);
2669 MODULE_PARM_DESC(bch_cutoff_writeback, "threshold to cutoff writeback");
2671 module_param(bch_cutoff_writeback_sync, uint, 0);
2672 MODULE_PARM_DESC(bch_cutoff_writeback_sync, "hard threshold to cutoff writeback");
2674 MODULE_DESCRIPTION("Bcache: a Linux block layer cache");
2675 MODULE_AUTHOR("Kent Overstreet <kent.overstreet@gmail.com>");
2676 MODULE_LICENSE("GPL");