2 * bcache setup/teardown code, and some metadata io - read a superblock and
3 * figure out what to do with it.
5 * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
6 * Copyright 2012 Google, Inc.
14 #include "writeback.h"
16 #include <linux/blkdev.h>
17 #include <linux/buffer_head.h>
18 #include <linux/debugfs.h>
19 #include <linux/genhd.h>
20 #include <linux/idr.h>
21 #include <linux/kthread.h>
22 #include <linux/module.h>
23 #include <linux/random.h>
24 #include <linux/reboot.h>
25 #include <linux/sysfs.h>
27 MODULE_LICENSE("GPL");
28 MODULE_AUTHOR("Kent Overstreet <kent.overstreet@gmail.com>");
30 static const char bcache_magic
[] = {
31 0xc6, 0x85, 0x73, 0xf6, 0x4e, 0x1a, 0x45, 0xca,
32 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81
35 static const char invalid_uuid
[] = {
36 0xa0, 0x3e, 0xf8, 0xed, 0x3e, 0xe1, 0xb8, 0x78,
37 0xc8, 0x50, 0xfc, 0x5e, 0xcb, 0x16, 0xcd, 0x99
40 /* Default is -1; we skip past it for struct cached_dev's cache mode */
41 const char * const bch_cache_modes
[] = {
50 static struct kobject
*bcache_kobj
;
51 struct mutex bch_register_lock
;
52 LIST_HEAD(bch_cache_sets
);
53 static LIST_HEAD(uncached_devices
);
55 static int bcache_major
;
56 static DEFINE_IDA(bcache_minor
);
57 static wait_queue_head_t unregister_wait
;
58 struct workqueue_struct
*bcache_wq
;
60 #define BTREE_MAX_PAGES (256 * 1024 / PAGE_SIZE)
62 static void bio_split_pool_free(struct bio_split_pool
*p
)
64 if (p
->bio_split_hook
)
65 mempool_destroy(p
->bio_split_hook
);
68 bioset_free(p
->bio_split
);
71 static int bio_split_pool_init(struct bio_split_pool
*p
)
73 p
->bio_split
= bioset_create(4, 0);
77 p
->bio_split_hook
= mempool_create_kmalloc_pool(4,
78 sizeof(struct bio_split_hook
));
79 if (!p
->bio_split_hook
)
87 static const char *read_super(struct cache_sb
*sb
, struct block_device
*bdev
,
92 struct buffer_head
*bh
= __bread(bdev
, 1, SB_SIZE
);
98 s
= (struct cache_sb
*) bh
->b_data
;
100 sb
->offset
= le64_to_cpu(s
->offset
);
101 sb
->version
= le64_to_cpu(s
->version
);
103 memcpy(sb
->magic
, s
->magic
, 16);
104 memcpy(sb
->uuid
, s
->uuid
, 16);
105 memcpy(sb
->set_uuid
, s
->set_uuid
, 16);
106 memcpy(sb
->label
, s
->label
, SB_LABEL_SIZE
);
108 sb
->flags
= le64_to_cpu(s
->flags
);
109 sb
->seq
= le64_to_cpu(s
->seq
);
110 sb
->last_mount
= le32_to_cpu(s
->last_mount
);
111 sb
->first_bucket
= le16_to_cpu(s
->first_bucket
);
112 sb
->keys
= le16_to_cpu(s
->keys
);
114 for (i
= 0; i
< SB_JOURNAL_BUCKETS
; i
++)
115 sb
->d
[i
] = le64_to_cpu(s
->d
[i
]);
117 pr_debug("read sb version %llu, flags %llu, seq %llu, journal size %u",
118 sb
->version
, sb
->flags
, sb
->seq
, sb
->keys
);
120 err
= "Not a bcache superblock";
121 if (sb
->offset
!= SB_SECTOR
)
124 if (memcmp(sb
->magic
, bcache_magic
, 16))
127 err
= "Too many journal buckets";
128 if (sb
->keys
> SB_JOURNAL_BUCKETS
)
131 err
= "Bad checksum";
132 if (s
->csum
!= csum_set(s
))
136 if (bch_is_zero(sb
->uuid
, 16))
139 sb
->block_size
= le16_to_cpu(s
->block_size
);
141 err
= "Superblock block size smaller than device block size";
142 if (sb
->block_size
<< 9 < bdev_logical_block_size(bdev
))
145 switch (sb
->version
) {
146 case BCACHE_SB_VERSION_BDEV
:
147 sb
->data_offset
= BDEV_DATA_START_DEFAULT
;
149 case BCACHE_SB_VERSION_BDEV_WITH_OFFSET
:
150 sb
->data_offset
= le64_to_cpu(s
->data_offset
);
152 err
= "Bad data offset";
153 if (sb
->data_offset
< BDEV_DATA_START_DEFAULT
)
157 case BCACHE_SB_VERSION_CDEV
:
158 case BCACHE_SB_VERSION_CDEV_WITH_UUID
:
159 sb
->nbuckets
= le64_to_cpu(s
->nbuckets
);
160 sb
->block_size
= le16_to_cpu(s
->block_size
);
161 sb
->bucket_size
= le16_to_cpu(s
->bucket_size
);
163 sb
->nr_in_set
= le16_to_cpu(s
->nr_in_set
);
164 sb
->nr_this_dev
= le16_to_cpu(s
->nr_this_dev
);
166 err
= "Too many buckets";
167 if (sb
->nbuckets
> LONG_MAX
)
170 err
= "Not enough buckets";
171 if (sb
->nbuckets
< 1 << 7)
174 err
= "Bad block/bucket size";
175 if (!is_power_of_2(sb
->block_size
) ||
176 sb
->block_size
> PAGE_SECTORS
||
177 !is_power_of_2(sb
->bucket_size
) ||
178 sb
->bucket_size
< PAGE_SECTORS
)
181 err
= "Invalid superblock: device too small";
182 if (get_capacity(bdev
->bd_disk
) < sb
->bucket_size
* sb
->nbuckets
)
186 if (bch_is_zero(sb
->set_uuid
, 16))
189 err
= "Bad cache device number in set";
190 if (!sb
->nr_in_set
||
191 sb
->nr_in_set
<= sb
->nr_this_dev
||
192 sb
->nr_in_set
> MAX_CACHES_PER_SET
)
195 err
= "Journal buckets not sequential";
196 for (i
= 0; i
< sb
->keys
; i
++)
197 if (sb
->d
[i
] != sb
->first_bucket
+ i
)
200 err
= "Too many journal buckets";
201 if (sb
->first_bucket
+ sb
->keys
> sb
->nbuckets
)
204 err
= "Invalid superblock: first bucket comes before end of super";
205 if (sb
->first_bucket
* sb
->bucket_size
< 16)
210 err
= "Unsupported superblock version";
214 sb
->last_mount
= get_seconds();
217 get_page(bh
->b_page
);
224 static void write_bdev_super_endio(struct bio
*bio
, int error
)
226 struct cached_dev
*dc
= bio
->bi_private
;
227 /* XXX: error checking */
229 closure_put(&dc
->sb_write
);
232 static void __write_super(struct cache_sb
*sb
, struct bio
*bio
)
234 struct cache_sb
*out
= page_address(bio
->bi_io_vec
[0].bv_page
);
237 bio
->bi_iter
.bi_sector
= SB_SECTOR
;
238 bio
->bi_rw
= REQ_SYNC
|REQ_META
;
239 bio
->bi_iter
.bi_size
= SB_SIZE
;
240 bch_bio_map(bio
, NULL
);
242 out
->offset
= cpu_to_le64(sb
->offset
);
243 out
->version
= cpu_to_le64(sb
->version
);
245 memcpy(out
->uuid
, sb
->uuid
, 16);
246 memcpy(out
->set_uuid
, sb
->set_uuid
, 16);
247 memcpy(out
->label
, sb
->label
, SB_LABEL_SIZE
);
249 out
->flags
= cpu_to_le64(sb
->flags
);
250 out
->seq
= cpu_to_le64(sb
->seq
);
252 out
->last_mount
= cpu_to_le32(sb
->last_mount
);
253 out
->first_bucket
= cpu_to_le16(sb
->first_bucket
);
254 out
->keys
= cpu_to_le16(sb
->keys
);
256 for (i
= 0; i
< sb
->keys
; i
++)
257 out
->d
[i
] = cpu_to_le64(sb
->d
[i
]);
259 out
->csum
= csum_set(out
);
261 pr_debug("ver %llu, flags %llu, seq %llu",
262 sb
->version
, sb
->flags
, sb
->seq
);
264 submit_bio(REQ_WRITE
, bio
);
267 static void bch_write_bdev_super_unlock(struct closure
*cl
)
269 struct cached_dev
*dc
= container_of(cl
, struct cached_dev
, sb_write
);
271 up(&dc
->sb_write_mutex
);
274 void bch_write_bdev_super(struct cached_dev
*dc
, struct closure
*parent
)
276 struct closure
*cl
= &dc
->sb_write
;
277 struct bio
*bio
= &dc
->sb_bio
;
279 down(&dc
->sb_write_mutex
);
280 closure_init(cl
, parent
);
283 bio
->bi_bdev
= dc
->bdev
;
284 bio
->bi_end_io
= write_bdev_super_endio
;
285 bio
->bi_private
= dc
;
288 __write_super(&dc
->sb
, bio
);
290 closure_return_with_destructor(cl
, bch_write_bdev_super_unlock
);
293 static void write_super_endio(struct bio
*bio
, int error
)
295 struct cache
*ca
= bio
->bi_private
;
297 bch_count_io_errors(ca
, error
, "writing superblock");
298 closure_put(&ca
->set
->sb_write
);
301 static void bcache_write_super_unlock(struct closure
*cl
)
303 struct cache_set
*c
= container_of(cl
, struct cache_set
, sb_write
);
305 up(&c
->sb_write_mutex
);
308 void bcache_write_super(struct cache_set
*c
)
310 struct closure
*cl
= &c
->sb_write
;
314 down(&c
->sb_write_mutex
);
315 closure_init(cl
, &c
->cl
);
319 for_each_cache(ca
, c
, i
) {
320 struct bio
*bio
= &ca
->sb_bio
;
322 ca
->sb
.version
= BCACHE_SB_VERSION_CDEV_WITH_UUID
;
323 ca
->sb
.seq
= c
->sb
.seq
;
324 ca
->sb
.last_mount
= c
->sb
.last_mount
;
326 SET_CACHE_SYNC(&ca
->sb
, CACHE_SYNC(&c
->sb
));
329 bio
->bi_bdev
= ca
->bdev
;
330 bio
->bi_end_io
= write_super_endio
;
331 bio
->bi_private
= ca
;
334 __write_super(&ca
->sb
, bio
);
337 closure_return_with_destructor(cl
, bcache_write_super_unlock
);
342 static void uuid_endio(struct bio
*bio
, int error
)
344 struct closure
*cl
= bio
->bi_private
;
345 struct cache_set
*c
= container_of(cl
, struct cache_set
, uuid_write
);
347 cache_set_err_on(error
, c
, "accessing uuids");
348 bch_bbio_free(bio
, c
);
352 static void uuid_io_unlock(struct closure
*cl
)
354 struct cache_set
*c
= container_of(cl
, struct cache_set
, uuid_write
);
356 up(&c
->uuid_write_mutex
);
359 static void uuid_io(struct cache_set
*c
, unsigned long rw
,
360 struct bkey
*k
, struct closure
*parent
)
362 struct closure
*cl
= &c
->uuid_write
;
363 struct uuid_entry
*u
;
368 down(&c
->uuid_write_mutex
);
369 closure_init(cl
, parent
);
371 for (i
= 0; i
< KEY_PTRS(k
); i
++) {
372 struct bio
*bio
= bch_bbio_alloc(c
);
374 bio
->bi_rw
= REQ_SYNC
|REQ_META
|rw
;
375 bio
->bi_iter
.bi_size
= KEY_SIZE(k
) << 9;
377 bio
->bi_end_io
= uuid_endio
;
378 bio
->bi_private
= cl
;
379 bch_bio_map(bio
, c
->uuids
);
381 bch_submit_bbio(bio
, c
, k
, i
);
387 bch_extent_to_text(buf
, sizeof(buf
), k
);
388 pr_debug("%s UUIDs at %s", rw
& REQ_WRITE
? "wrote" : "read", buf
);
390 for (u
= c
->uuids
; u
< c
->uuids
+ c
->nr_uuids
; u
++)
391 if (!bch_is_zero(u
->uuid
, 16))
392 pr_debug("Slot %zi: %pU: %s: 1st: %u last: %u inv: %u",
393 u
- c
->uuids
, u
->uuid
, u
->label
,
394 u
->first_reg
, u
->last_reg
, u
->invalidated
);
396 closure_return_with_destructor(cl
, uuid_io_unlock
);
399 static char *uuid_read(struct cache_set
*c
, struct jset
*j
, struct closure
*cl
)
401 struct bkey
*k
= &j
->uuid_bucket
;
403 if (__bch_btree_ptr_invalid(c
, k
))
404 return "bad uuid pointer";
406 bkey_copy(&c
->uuid_bucket
, k
);
407 uuid_io(c
, READ_SYNC
, k
, cl
);
409 if (j
->version
< BCACHE_JSET_VERSION_UUIDv1
) {
410 struct uuid_entry_v0
*u0
= (void *) c
->uuids
;
411 struct uuid_entry
*u1
= (void *) c
->uuids
;
417 * Since the new uuid entry is bigger than the old, we have to
418 * convert starting at the highest memory address and work down
419 * in order to do it in place
422 for (i
= c
->nr_uuids
- 1;
425 memcpy(u1
[i
].uuid
, u0
[i
].uuid
, 16);
426 memcpy(u1
[i
].label
, u0
[i
].label
, 32);
428 u1
[i
].first_reg
= u0
[i
].first_reg
;
429 u1
[i
].last_reg
= u0
[i
].last_reg
;
430 u1
[i
].invalidated
= u0
[i
].invalidated
;
440 static int __uuid_write(struct cache_set
*c
)
444 closure_init_stack(&cl
);
446 lockdep_assert_held(&bch_register_lock
);
448 if (bch_bucket_alloc_set(c
, RESERVE_BTREE
, &k
.key
, 1, true))
451 SET_KEY_SIZE(&k
.key
, c
->sb
.bucket_size
);
452 uuid_io(c
, REQ_WRITE
, &k
.key
, &cl
);
455 bkey_copy(&c
->uuid_bucket
, &k
.key
);
460 int bch_uuid_write(struct cache_set
*c
)
462 int ret
= __uuid_write(c
);
465 bch_journal_meta(c
, NULL
);
470 static struct uuid_entry
*uuid_find(struct cache_set
*c
, const char *uuid
)
472 struct uuid_entry
*u
;
475 u
< c
->uuids
+ c
->nr_uuids
; u
++)
476 if (!memcmp(u
->uuid
, uuid
, 16))
482 static struct uuid_entry
*uuid_find_empty(struct cache_set
*c
)
484 static const char zero_uuid
[16] = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
485 return uuid_find(c
, zero_uuid
);
489 * Bucket priorities/gens:
491 * For each bucket, we store on disk its
495 * See alloc.c for an explanation of the gen. The priority is used to implement
496 * lru (and in the future other) cache replacement policies; for most purposes
497 * it's just an opaque integer.
499 * The gens and the priorities don't have a whole lot to do with each other, and
500 * it's actually the gens that must be written out at specific times - it's no
501 * big deal if the priorities don't get written, if we lose them we just reuse
502 * buckets in suboptimal order.
504 * On disk they're stored in a packed array, and in as many buckets are required
505 * to fit them all. The buckets we use to store them form a list; the journal
506 * header points to the first bucket, the first bucket points to the second
509 * This code is used by the allocation code; periodically (whenever it runs out
510 * of buckets to allocate from) the allocation code will invalidate some
511 * buckets, but it can't use those buckets until their new gens are safely on
515 static void prio_endio(struct bio
*bio
, int error
)
517 struct cache
*ca
= bio
->bi_private
;
519 cache_set_err_on(error
, ca
->set
, "accessing priorities");
520 bch_bbio_free(bio
, ca
->set
);
521 closure_put(&ca
->prio
);
524 static void prio_io(struct cache
*ca
, uint64_t bucket
, unsigned long rw
)
526 struct closure
*cl
= &ca
->prio
;
527 struct bio
*bio
= bch_bbio_alloc(ca
->set
);
529 closure_init_stack(cl
);
531 bio
->bi_iter
.bi_sector
= bucket
* ca
->sb
.bucket_size
;
532 bio
->bi_bdev
= ca
->bdev
;
533 bio
->bi_rw
= REQ_SYNC
|REQ_META
|rw
;
534 bio
->bi_iter
.bi_size
= bucket_bytes(ca
);
536 bio
->bi_end_io
= prio_endio
;
537 bio
->bi_private
= ca
;
538 bch_bio_map(bio
, ca
->disk_buckets
);
540 closure_bio_submit(bio
, &ca
->prio
, ca
);
544 #define buckets_free(c) "free %zu, free_inc %zu, unused %zu", \
545 fifo_used(&c->free), fifo_used(&c->free_inc), fifo_used(&c->unused)
547 void bch_prio_write(struct cache
*ca
)
553 closure_init_stack(&cl
);
555 lockdep_assert_held(&ca
->set
->bucket_lock
);
557 for (b
= ca
->buckets
;
558 b
< ca
->buckets
+ ca
->sb
.nbuckets
; b
++)
559 b
->disk_gen
= b
->gen
;
561 ca
->disk_buckets
->seq
++;
563 atomic_long_add(ca
->sb
.bucket_size
* prio_buckets(ca
),
564 &ca
->meta_sectors_written
);
566 //pr_debug("free %zu, free_inc %zu, unused %zu", fifo_used(&ca->free),
567 // fifo_used(&ca->free_inc), fifo_used(&ca->unused));
569 for (i
= prio_buckets(ca
) - 1; i
>= 0; --i
) {
571 struct prio_set
*p
= ca
->disk_buckets
;
572 struct bucket_disk
*d
= p
->data
;
573 struct bucket_disk
*end
= d
+ prios_per_bucket(ca
);
575 for (b
= ca
->buckets
+ i
* prios_per_bucket(ca
);
576 b
< ca
->buckets
+ ca
->sb
.nbuckets
&& d
< end
;
578 d
->prio
= cpu_to_le16(b
->prio
);
582 p
->next_bucket
= ca
->prio_buckets
[i
+ 1];
583 p
->magic
= pset_magic(&ca
->sb
);
584 p
->csum
= bch_crc64(&p
->magic
, bucket_bytes(ca
) - 8);
586 bucket
= bch_bucket_alloc(ca
, RESERVE_PRIO
, true);
587 BUG_ON(bucket
== -1);
589 mutex_unlock(&ca
->set
->bucket_lock
);
590 prio_io(ca
, bucket
, REQ_WRITE
);
591 mutex_lock(&ca
->set
->bucket_lock
);
593 ca
->prio_buckets
[i
] = bucket
;
594 atomic_dec_bug(&ca
->buckets
[bucket
].pin
);
597 mutex_unlock(&ca
->set
->bucket_lock
);
599 bch_journal_meta(ca
->set
, &cl
);
602 mutex_lock(&ca
->set
->bucket_lock
);
604 ca
->need_save_prio
= 0;
607 * Don't want the old priorities to get garbage collected until after we
608 * finish writing the new ones, and they're journalled
610 for (i
= 0; i
< prio_buckets(ca
); i
++)
611 ca
->prio_last_buckets
[i
] = ca
->prio_buckets
[i
];
614 static void prio_read(struct cache
*ca
, uint64_t bucket
)
616 struct prio_set
*p
= ca
->disk_buckets
;
617 struct bucket_disk
*d
= p
->data
+ prios_per_bucket(ca
), *end
= d
;
619 unsigned bucket_nr
= 0;
621 for (b
= ca
->buckets
;
622 b
< ca
->buckets
+ ca
->sb
.nbuckets
;
625 ca
->prio_buckets
[bucket_nr
] = bucket
;
626 ca
->prio_last_buckets
[bucket_nr
] = bucket
;
629 prio_io(ca
, bucket
, READ_SYNC
);
631 if (p
->csum
!= bch_crc64(&p
->magic
, bucket_bytes(ca
) - 8))
632 pr_warn("bad csum reading priorities");
634 if (p
->magic
!= pset_magic(&ca
->sb
))
635 pr_warn("bad magic reading priorities");
637 bucket
= p
->next_bucket
;
641 b
->prio
= le16_to_cpu(d
->prio
);
642 b
->gen
= b
->disk_gen
= b
->last_gc
= b
->gc_gen
= d
->gen
;
648 static int open_dev(struct block_device
*b
, fmode_t mode
)
650 struct bcache_device
*d
= b
->bd_disk
->private_data
;
651 if (test_bit(BCACHE_DEV_CLOSING
, &d
->flags
))
658 static void release_dev(struct gendisk
*b
, fmode_t mode
)
660 struct bcache_device
*d
= b
->private_data
;
664 static int ioctl_dev(struct block_device
*b
, fmode_t mode
,
665 unsigned int cmd
, unsigned long arg
)
667 struct bcache_device
*d
= b
->bd_disk
->private_data
;
668 return d
->ioctl(d
, mode
, cmd
, arg
);
671 static const struct block_device_operations bcache_ops
= {
673 .release
= release_dev
,
675 .owner
= THIS_MODULE
,
678 void bcache_device_stop(struct bcache_device
*d
)
680 if (!test_and_set_bit(BCACHE_DEV_CLOSING
, &d
->flags
))
681 closure_queue(&d
->cl
);
684 static void bcache_device_unlink(struct bcache_device
*d
)
686 lockdep_assert_held(&bch_register_lock
);
688 if (d
->c
&& !test_and_set_bit(BCACHE_DEV_UNLINK_DONE
, &d
->flags
)) {
692 sysfs_remove_link(&d
->c
->kobj
, d
->name
);
693 sysfs_remove_link(&d
->kobj
, "cache");
695 for_each_cache(ca
, d
->c
, i
)
696 bd_unlink_disk_holder(ca
->bdev
, d
->disk
);
700 static void bcache_device_link(struct bcache_device
*d
, struct cache_set
*c
,
706 for_each_cache(ca
, d
->c
, i
)
707 bd_link_disk_holder(ca
->bdev
, d
->disk
);
709 snprintf(d
->name
, BCACHEDEVNAME_SIZE
,
710 "%s%u", name
, d
->id
);
712 WARN(sysfs_create_link(&d
->kobj
, &c
->kobj
, "cache") ||
713 sysfs_create_link(&c
->kobj
, &d
->kobj
, d
->name
),
714 "Couldn't create device <-> cache set symlinks");
717 static void bcache_device_detach(struct bcache_device
*d
)
719 lockdep_assert_held(&bch_register_lock
);
721 if (test_bit(BCACHE_DEV_DETACHING
, &d
->flags
)) {
722 struct uuid_entry
*u
= d
->c
->uuids
+ d
->id
;
724 SET_UUID_FLASH_ONLY(u
, 0);
725 memcpy(u
->uuid
, invalid_uuid
, 16);
726 u
->invalidated
= cpu_to_le32(get_seconds());
727 bch_uuid_write(d
->c
);
730 bcache_device_unlink(d
);
732 d
->c
->devices
[d
->id
] = NULL
;
733 closure_put(&d
->c
->caching
);
737 static void bcache_device_attach(struct bcache_device
*d
, struct cache_set
*c
,
740 BUG_ON(test_bit(CACHE_SET_STOPPING
, &c
->flags
));
746 closure_get(&c
->caching
);
749 static void bcache_device_free(struct bcache_device
*d
)
751 lockdep_assert_held(&bch_register_lock
);
753 pr_info("%s stopped", d
->disk
->disk_name
);
756 bcache_device_detach(d
);
757 if (d
->disk
&& d
->disk
->flags
& GENHD_FL_UP
)
758 del_gendisk(d
->disk
);
759 if (d
->disk
&& d
->disk
->queue
)
760 blk_cleanup_queue(d
->disk
->queue
);
762 ida_simple_remove(&bcache_minor
, d
->disk
->first_minor
);
766 bio_split_pool_free(&d
->bio_split_hook
);
768 bioset_free(d
->bio_split
);
769 if (is_vmalloc_addr(d
->full_dirty_stripes
))
770 vfree(d
->full_dirty_stripes
);
772 kfree(d
->full_dirty_stripes
);
773 if (is_vmalloc_addr(d
->stripe_sectors_dirty
))
774 vfree(d
->stripe_sectors_dirty
);
776 kfree(d
->stripe_sectors_dirty
);
778 closure_debug_destroy(&d
->cl
);
781 static int bcache_device_init(struct bcache_device
*d
, unsigned block_size
,
784 struct request_queue
*q
;
789 d
->stripe_size
= 1 << 31;
791 d
->nr_stripes
= DIV_ROUND_UP_ULL(sectors
, d
->stripe_size
);
793 if (!d
->nr_stripes
||
794 d
->nr_stripes
> INT_MAX
||
795 d
->nr_stripes
> SIZE_MAX
/ sizeof(atomic_t
)) {
796 pr_err("nr_stripes too large");
800 n
= d
->nr_stripes
* sizeof(atomic_t
);
801 d
->stripe_sectors_dirty
= n
< PAGE_SIZE
<< 6
802 ? kzalloc(n
, GFP_KERNEL
)
804 if (!d
->stripe_sectors_dirty
)
807 n
= BITS_TO_LONGS(d
->nr_stripes
) * sizeof(unsigned long);
808 d
->full_dirty_stripes
= n
< PAGE_SIZE
<< 6
809 ? kzalloc(n
, GFP_KERNEL
)
811 if (!d
->full_dirty_stripes
)
814 minor
= ida_simple_get(&bcache_minor
, 0, MINORMASK
+ 1, GFP_KERNEL
);
818 if (!(d
->bio_split
= bioset_create(4, offsetof(struct bbio
, bio
))) ||
819 bio_split_pool_init(&d
->bio_split_hook
) ||
820 !(d
->disk
= alloc_disk(1))) {
821 ida_simple_remove(&bcache_minor
, minor
);
825 set_capacity(d
->disk
, sectors
);
826 snprintf(d
->disk
->disk_name
, DISK_NAME_LEN
, "bcache%i", minor
);
828 d
->disk
->major
= bcache_major
;
829 d
->disk
->first_minor
= minor
;
830 d
->disk
->fops
= &bcache_ops
;
831 d
->disk
->private_data
= d
;
833 q
= blk_alloc_queue(GFP_KERNEL
);
837 blk_queue_make_request(q
, NULL
);
840 q
->backing_dev_info
.congested_data
= d
;
841 q
->limits
.max_hw_sectors
= UINT_MAX
;
842 q
->limits
.max_sectors
= UINT_MAX
;
843 q
->limits
.max_segment_size
= UINT_MAX
;
844 q
->limits
.max_segments
= BIO_MAX_PAGES
;
845 q
->limits
.max_discard_sectors
= UINT_MAX
;
846 q
->limits
.io_min
= block_size
;
847 q
->limits
.logical_block_size
= block_size
;
848 q
->limits
.physical_block_size
= block_size
;
849 set_bit(QUEUE_FLAG_NONROT
, &d
->disk
->queue
->queue_flags
);
850 set_bit(QUEUE_FLAG_DISCARD
, &d
->disk
->queue
->queue_flags
);
852 blk_queue_flush(q
, REQ_FLUSH
|REQ_FUA
);
859 static void calc_cached_dev_sectors(struct cache_set
*c
)
861 uint64_t sectors
= 0;
862 struct cached_dev
*dc
;
864 list_for_each_entry(dc
, &c
->cached_devs
, list
)
865 sectors
+= bdev_sectors(dc
->bdev
);
867 c
->cached_dev_sectors
= sectors
;
870 void bch_cached_dev_run(struct cached_dev
*dc
)
872 struct bcache_device
*d
= &dc
->disk
;
873 char buf
[SB_LABEL_SIZE
+ 1];
876 kasprintf(GFP_KERNEL
, "CACHED_UUID=%pU", dc
->sb
.uuid
),
881 memcpy(buf
, dc
->sb
.label
, SB_LABEL_SIZE
);
882 buf
[SB_LABEL_SIZE
] = '\0';
883 env
[2] = kasprintf(GFP_KERNEL
, "CACHED_LABEL=%s", buf
);
885 if (atomic_xchg(&dc
->running
, 1))
889 BDEV_STATE(&dc
->sb
) != BDEV_STATE_NONE
) {
891 closure_init_stack(&cl
);
893 SET_BDEV_STATE(&dc
->sb
, BDEV_STATE_STALE
);
894 bch_write_bdev_super(dc
, &cl
);
899 bd_link_disk_holder(dc
->bdev
, dc
->disk
.disk
);
900 /* won't show up in the uevent file, use udevadm monitor -e instead
901 * only class / kset properties are persistent */
902 kobject_uevent_env(&disk_to_dev(d
->disk
)->kobj
, KOBJ_CHANGE
, env
);
906 if (sysfs_create_link(&d
->kobj
, &disk_to_dev(d
->disk
)->kobj
, "dev") ||
907 sysfs_create_link(&disk_to_dev(d
->disk
)->kobj
, &d
->kobj
, "bcache"))
908 pr_debug("error creating sysfs link");
911 static void cached_dev_detach_finish(struct work_struct
*w
)
913 struct cached_dev
*dc
= container_of(w
, struct cached_dev
, detach
);
914 char buf
[BDEVNAME_SIZE
];
916 closure_init_stack(&cl
);
918 BUG_ON(!test_bit(BCACHE_DEV_DETACHING
, &dc
->disk
.flags
));
919 BUG_ON(atomic_read(&dc
->count
));
921 mutex_lock(&bch_register_lock
);
923 memset(&dc
->sb
.set_uuid
, 0, 16);
924 SET_BDEV_STATE(&dc
->sb
, BDEV_STATE_NONE
);
926 bch_write_bdev_super(dc
, &cl
);
929 bcache_device_detach(&dc
->disk
);
930 list_move(&dc
->list
, &uncached_devices
);
932 clear_bit(BCACHE_DEV_DETACHING
, &dc
->disk
.flags
);
934 mutex_unlock(&bch_register_lock
);
936 pr_info("Caching disabled for %s", bdevname(dc
->bdev
, buf
));
938 /* Drop ref we took in cached_dev_detach() */
939 closure_put(&dc
->disk
.cl
);
942 void bch_cached_dev_detach(struct cached_dev
*dc
)
944 lockdep_assert_held(&bch_register_lock
);
946 if (test_bit(BCACHE_DEV_CLOSING
, &dc
->disk
.flags
))
949 if (test_and_set_bit(BCACHE_DEV_DETACHING
, &dc
->disk
.flags
))
953 * Block the device from being closed and freed until we're finished
956 closure_get(&dc
->disk
.cl
);
958 bch_writeback_queue(dc
);
962 int bch_cached_dev_attach(struct cached_dev
*dc
, struct cache_set
*c
)
964 uint32_t rtime
= cpu_to_le32(get_seconds());
965 struct uuid_entry
*u
;
966 char buf
[BDEVNAME_SIZE
];
968 bdevname(dc
->bdev
, buf
);
970 if (memcmp(dc
->sb
.set_uuid
, c
->sb
.set_uuid
, 16))
974 pr_err("Can't attach %s: already attached", buf
);
978 if (test_bit(CACHE_SET_STOPPING
, &c
->flags
)) {
979 pr_err("Can't attach %s: shutting down", buf
);
983 if (dc
->sb
.block_size
< c
->sb
.block_size
) {
985 pr_err("Couldn't attach %s: block size less than set's block size",
990 u
= uuid_find(c
, dc
->sb
.uuid
);
993 (BDEV_STATE(&dc
->sb
) == BDEV_STATE_STALE
||
994 BDEV_STATE(&dc
->sb
) == BDEV_STATE_NONE
)) {
995 memcpy(u
->uuid
, invalid_uuid
, 16);
996 u
->invalidated
= cpu_to_le32(get_seconds());
1001 if (BDEV_STATE(&dc
->sb
) == BDEV_STATE_DIRTY
) {
1002 pr_err("Couldn't find uuid for %s in set", buf
);
1006 u
= uuid_find_empty(c
);
1008 pr_err("Not caching %s, no room for UUID", buf
);
1013 /* Deadlocks since we're called via sysfs...
1014 sysfs_remove_file(&dc->kobj, &sysfs_attach);
1017 if (bch_is_zero(u
->uuid
, 16)) {
1019 closure_init_stack(&cl
);
1021 memcpy(u
->uuid
, dc
->sb
.uuid
, 16);
1022 memcpy(u
->label
, dc
->sb
.label
, SB_LABEL_SIZE
);
1023 u
->first_reg
= u
->last_reg
= rtime
;
1026 memcpy(dc
->sb
.set_uuid
, c
->sb
.set_uuid
, 16);
1027 SET_BDEV_STATE(&dc
->sb
, BDEV_STATE_CLEAN
);
1029 bch_write_bdev_super(dc
, &cl
);
1032 u
->last_reg
= rtime
;
1036 bcache_device_attach(&dc
->disk
, c
, u
- c
->uuids
);
1037 list_move(&dc
->list
, &c
->cached_devs
);
1038 calc_cached_dev_sectors(c
);
1042 * dc->c must be set before dc->count != 0 - paired with the mb in
1045 atomic_set(&dc
->count
, 1);
1047 if (BDEV_STATE(&dc
->sb
) == BDEV_STATE_DIRTY
) {
1048 bch_sectors_dirty_init(dc
);
1049 atomic_set(&dc
->has_dirty
, 1);
1050 atomic_inc(&dc
->count
);
1051 bch_writeback_queue(dc
);
1054 bch_cached_dev_run(dc
);
1055 bcache_device_link(&dc
->disk
, c
, "bdev");
1057 pr_info("Caching %s as %s on set %pU",
1058 bdevname(dc
->bdev
, buf
), dc
->disk
.disk
->disk_name
,
1059 dc
->disk
.c
->sb
.set_uuid
);
1063 void bch_cached_dev_release(struct kobject
*kobj
)
1065 struct cached_dev
*dc
= container_of(kobj
, struct cached_dev
,
1068 module_put(THIS_MODULE
);
1071 static void cached_dev_free(struct closure
*cl
)
1073 struct cached_dev
*dc
= container_of(cl
, struct cached_dev
, disk
.cl
);
1075 cancel_delayed_work_sync(&dc
->writeback_rate_update
);
1076 kthread_stop(dc
->writeback_thread
);
1078 mutex_lock(&bch_register_lock
);
1080 if (atomic_read(&dc
->running
))
1081 bd_unlink_disk_holder(dc
->bdev
, dc
->disk
.disk
);
1082 bcache_device_free(&dc
->disk
);
1083 list_del(&dc
->list
);
1085 mutex_unlock(&bch_register_lock
);
1087 if (!IS_ERR_OR_NULL(dc
->bdev
)) {
1088 if (dc
->bdev
->bd_disk
)
1089 blk_sync_queue(bdev_get_queue(dc
->bdev
));
1091 blkdev_put(dc
->bdev
, FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
);
1094 wake_up(&unregister_wait
);
1096 kobject_put(&dc
->disk
.kobj
);
1099 static void cached_dev_flush(struct closure
*cl
)
1101 struct cached_dev
*dc
= container_of(cl
, struct cached_dev
, disk
.cl
);
1102 struct bcache_device
*d
= &dc
->disk
;
1104 mutex_lock(&bch_register_lock
);
1105 bcache_device_unlink(d
);
1106 mutex_unlock(&bch_register_lock
);
1108 bch_cache_accounting_destroy(&dc
->accounting
);
1109 kobject_del(&d
->kobj
);
1111 continue_at(cl
, cached_dev_free
, system_wq
);
1114 static int cached_dev_init(struct cached_dev
*dc
, unsigned block_size
)
1118 struct request_queue
*q
= bdev_get_queue(dc
->bdev
);
1120 __module_get(THIS_MODULE
);
1121 INIT_LIST_HEAD(&dc
->list
);
1122 closure_init(&dc
->disk
.cl
, NULL
);
1123 set_closure_fn(&dc
->disk
.cl
, cached_dev_flush
, system_wq
);
1124 kobject_init(&dc
->disk
.kobj
, &bch_cached_dev_ktype
);
1125 INIT_WORK(&dc
->detach
, cached_dev_detach_finish
);
1126 sema_init(&dc
->sb_write_mutex
, 1);
1127 INIT_LIST_HEAD(&dc
->io_lru
);
1128 spin_lock_init(&dc
->io_lock
);
1129 bch_cache_accounting_init(&dc
->accounting
, &dc
->disk
.cl
);
1131 dc
->sequential_cutoff
= 4 << 20;
1133 for (io
= dc
->io
; io
< dc
->io
+ RECENT_IO
; io
++) {
1134 list_add(&io
->lru
, &dc
->io_lru
);
1135 hlist_add_head(&io
->hash
, dc
->io_hash
+ RECENT_IO
);
1138 dc
->disk
.stripe_size
= q
->limits
.io_opt
>> 9;
1140 if (dc
->disk
.stripe_size
)
1141 dc
->partial_stripes_expensive
=
1142 q
->limits
.raid_partial_stripes_expensive
;
1144 ret
= bcache_device_init(&dc
->disk
, block_size
,
1145 dc
->bdev
->bd_part
->nr_sects
- dc
->sb
.data_offset
);
1149 set_capacity(dc
->disk
.disk
,
1150 dc
->bdev
->bd_part
->nr_sects
- dc
->sb
.data_offset
);
1152 dc
->disk
.disk
->queue
->backing_dev_info
.ra_pages
=
1153 max(dc
->disk
.disk
->queue
->backing_dev_info
.ra_pages
,
1154 q
->backing_dev_info
.ra_pages
);
1156 bch_cached_dev_request_init(dc
);
1157 bch_cached_dev_writeback_init(dc
);
1161 /* Cached device - bcache superblock */
1163 static void register_bdev(struct cache_sb
*sb
, struct page
*sb_page
,
1164 struct block_device
*bdev
,
1165 struct cached_dev
*dc
)
1167 char name
[BDEVNAME_SIZE
];
1168 const char *err
= "cannot allocate memory";
1169 struct cache_set
*c
;
1171 memcpy(&dc
->sb
, sb
, sizeof(struct cache_sb
));
1173 dc
->bdev
->bd_holder
= dc
;
1175 bio_init(&dc
->sb_bio
);
1176 dc
->sb_bio
.bi_max_vecs
= 1;
1177 dc
->sb_bio
.bi_io_vec
= dc
->sb_bio
.bi_inline_vecs
;
1178 dc
->sb_bio
.bi_io_vec
[0].bv_page
= sb_page
;
1181 if (cached_dev_init(dc
, sb
->block_size
<< 9))
1184 err
= "error creating kobject";
1185 if (kobject_add(&dc
->disk
.kobj
, &part_to_dev(bdev
->bd_part
)->kobj
,
1188 if (bch_cache_accounting_add_kobjs(&dc
->accounting
, &dc
->disk
.kobj
))
1191 pr_info("registered backing device %s", bdevname(bdev
, name
));
1193 list_add(&dc
->list
, &uncached_devices
);
1194 list_for_each_entry(c
, &bch_cache_sets
, list
)
1195 bch_cached_dev_attach(dc
, c
);
1197 if (BDEV_STATE(&dc
->sb
) == BDEV_STATE_NONE
||
1198 BDEV_STATE(&dc
->sb
) == BDEV_STATE_STALE
)
1199 bch_cached_dev_run(dc
);
1203 pr_notice("error opening %s: %s", bdevname(bdev
, name
), err
);
1204 bcache_device_stop(&dc
->disk
);
1207 /* Flash only volumes */
1209 void bch_flash_dev_release(struct kobject
*kobj
)
1211 struct bcache_device
*d
= container_of(kobj
, struct bcache_device
,
1216 static void flash_dev_free(struct closure
*cl
)
1218 struct bcache_device
*d
= container_of(cl
, struct bcache_device
, cl
);
1219 bcache_device_free(d
);
1220 kobject_put(&d
->kobj
);
1223 static void flash_dev_flush(struct closure
*cl
)
1225 struct bcache_device
*d
= container_of(cl
, struct bcache_device
, cl
);
1227 bcache_device_unlink(d
);
1228 kobject_del(&d
->kobj
);
1229 continue_at(cl
, flash_dev_free
, system_wq
);
1232 static int flash_dev_run(struct cache_set
*c
, struct uuid_entry
*u
)
1234 struct bcache_device
*d
= kzalloc(sizeof(struct bcache_device
),
1239 closure_init(&d
->cl
, NULL
);
1240 set_closure_fn(&d
->cl
, flash_dev_flush
, system_wq
);
1242 kobject_init(&d
->kobj
, &bch_flash_dev_ktype
);
1244 if (bcache_device_init(d
, block_bytes(c
), u
->sectors
))
1247 bcache_device_attach(d
, c
, u
- c
->uuids
);
1248 bch_flash_dev_request_init(d
);
1251 if (kobject_add(&d
->kobj
, &disk_to_dev(d
->disk
)->kobj
, "bcache"))
1254 bcache_device_link(d
, c
, "volume");
1258 kobject_put(&d
->kobj
);
1262 static int flash_devs_run(struct cache_set
*c
)
1265 struct uuid_entry
*u
;
1268 u
< c
->uuids
+ c
->nr_uuids
&& !ret
;
1270 if (UUID_FLASH_ONLY(u
))
1271 ret
= flash_dev_run(c
, u
);
1276 int bch_flash_dev_create(struct cache_set
*c
, uint64_t size
)
1278 struct uuid_entry
*u
;
1280 if (test_bit(CACHE_SET_STOPPING
, &c
->flags
))
1283 u
= uuid_find_empty(c
);
1285 pr_err("Can't create volume, no room for UUID");
1289 get_random_bytes(u
->uuid
, 16);
1290 memset(u
->label
, 0, 32);
1291 u
->first_reg
= u
->last_reg
= cpu_to_le32(get_seconds());
1293 SET_UUID_FLASH_ONLY(u
, 1);
1294 u
->sectors
= size
>> 9;
1298 return flash_dev_run(c
, u
);
1304 bool bch_cache_set_error(struct cache_set
*c
, const char *fmt
, ...)
1308 if (c
->on_error
!= ON_ERROR_PANIC
&&
1309 test_bit(CACHE_SET_STOPPING
, &c
->flags
))
1312 /* XXX: we can be called from atomic context
1313 acquire_console_sem();
1316 printk(KERN_ERR
"bcache: error on %pU: ", c
->sb
.set_uuid
);
1318 va_start(args
, fmt
);
1322 printk(", disabling caching\n");
1324 if (c
->on_error
== ON_ERROR_PANIC
)
1325 panic("panic forced after error\n");
1327 bch_cache_set_unregister(c
);
1331 void bch_cache_set_release(struct kobject
*kobj
)
1333 struct cache_set
*c
= container_of(kobj
, struct cache_set
, kobj
);
1335 module_put(THIS_MODULE
);
1338 static void cache_set_free(struct closure
*cl
)
1340 struct cache_set
*c
= container_of(cl
, struct cache_set
, cl
);
1344 if (!IS_ERR_OR_NULL(c
->debug
))
1345 debugfs_remove(c
->debug
);
1347 bch_open_buckets_free(c
);
1348 bch_btree_cache_free(c
);
1349 bch_journal_free(c
);
1351 for_each_cache(ca
, c
, i
)
1353 kobject_put(&ca
->kobj
);
1355 bch_bset_sort_state_free(&c
->sort
);
1356 free_pages((unsigned long) c
->uuids
, ilog2(bucket_pages(c
)));
1359 bioset_free(c
->bio_split
);
1361 mempool_destroy(c
->fill_iter
);
1363 mempool_destroy(c
->bio_meta
);
1365 mempool_destroy(c
->search
);
1368 mutex_lock(&bch_register_lock
);
1370 mutex_unlock(&bch_register_lock
);
1372 pr_info("Cache set %pU unregistered", c
->sb
.set_uuid
);
1373 wake_up(&unregister_wait
);
1375 closure_debug_destroy(&c
->cl
);
1376 kobject_put(&c
->kobj
);
1379 static void cache_set_flush(struct closure
*cl
)
1381 struct cache_set
*c
= container_of(cl
, struct cache_set
, caching
);
1386 bch_cache_accounting_destroy(&c
->accounting
);
1388 kobject_put(&c
->internal
);
1389 kobject_del(&c
->kobj
);
1392 kthread_stop(c
->gc_thread
);
1394 if (!IS_ERR_OR_NULL(c
->root
))
1395 list_add(&c
->root
->list
, &c
->btree_cache
);
1397 /* Should skip this if we're unregistering because of an error */
1398 list_for_each_entry(b
, &c
->btree_cache
, list
)
1399 if (btree_node_dirty(b
))
1400 bch_btree_node_write(b
, NULL
);
1402 for_each_cache(ca
, c
, i
)
1403 if (ca
->alloc_thread
)
1404 kthread_stop(ca
->alloc_thread
);
1409 static void __cache_set_unregister(struct closure
*cl
)
1411 struct cache_set
*c
= container_of(cl
, struct cache_set
, caching
);
1412 struct cached_dev
*dc
;
1415 mutex_lock(&bch_register_lock
);
1417 for (i
= 0; i
< c
->nr_uuids
; i
++)
1418 if (c
->devices
[i
]) {
1419 if (!UUID_FLASH_ONLY(&c
->uuids
[i
]) &&
1420 test_bit(CACHE_SET_UNREGISTERING
, &c
->flags
)) {
1421 dc
= container_of(c
->devices
[i
],
1422 struct cached_dev
, disk
);
1423 bch_cached_dev_detach(dc
);
1425 bcache_device_stop(c
->devices
[i
]);
1429 mutex_unlock(&bch_register_lock
);
1431 continue_at(cl
, cache_set_flush
, system_wq
);
1434 void bch_cache_set_stop(struct cache_set
*c
)
1436 if (!test_and_set_bit(CACHE_SET_STOPPING
, &c
->flags
))
1437 closure_queue(&c
->caching
);
1440 void bch_cache_set_unregister(struct cache_set
*c
)
1442 set_bit(CACHE_SET_UNREGISTERING
, &c
->flags
);
1443 bch_cache_set_stop(c
);
1446 #define alloc_bucket_pages(gfp, c) \
1447 ((void *) __get_free_pages(__GFP_ZERO|gfp, ilog2(bucket_pages(c))))
1449 struct cache_set
*bch_cache_set_alloc(struct cache_sb
*sb
)
1452 struct cache_set
*c
= kzalloc(sizeof(struct cache_set
), GFP_KERNEL
);
1456 __module_get(THIS_MODULE
);
1457 closure_init(&c
->cl
, NULL
);
1458 set_closure_fn(&c
->cl
, cache_set_free
, system_wq
);
1460 closure_init(&c
->caching
, &c
->cl
);
1461 set_closure_fn(&c
->caching
, __cache_set_unregister
, system_wq
);
1463 /* Maybe create continue_at_noreturn() and use it here? */
1464 closure_set_stopped(&c
->cl
);
1465 closure_put(&c
->cl
);
1467 kobject_init(&c
->kobj
, &bch_cache_set_ktype
);
1468 kobject_init(&c
->internal
, &bch_cache_set_internal_ktype
);
1470 bch_cache_accounting_init(&c
->accounting
, &c
->cl
);
1472 memcpy(c
->sb
.set_uuid
, sb
->set_uuid
, 16);
1473 c
->sb
.block_size
= sb
->block_size
;
1474 c
->sb
.bucket_size
= sb
->bucket_size
;
1475 c
->sb
.nr_in_set
= sb
->nr_in_set
;
1476 c
->sb
.last_mount
= sb
->last_mount
;
1477 c
->bucket_bits
= ilog2(sb
->bucket_size
);
1478 c
->block_bits
= ilog2(sb
->block_size
);
1479 c
->nr_uuids
= bucket_bytes(c
) / sizeof(struct uuid_entry
);
1481 c
->btree_pages
= bucket_pages(c
);
1482 if (c
->btree_pages
> BTREE_MAX_PAGES
)
1483 c
->btree_pages
= max_t(int, c
->btree_pages
/ 4,
1486 sema_init(&c
->sb_write_mutex
, 1);
1487 mutex_init(&c
->bucket_lock
);
1488 init_waitqueue_head(&c
->try_wait
);
1489 init_waitqueue_head(&c
->bucket_wait
);
1490 sema_init(&c
->uuid_write_mutex
, 1);
1492 spin_lock_init(&c
->btree_gc_time
.lock
);
1493 spin_lock_init(&c
->btree_split_time
.lock
);
1494 spin_lock_init(&c
->btree_read_time
.lock
);
1495 spin_lock_init(&c
->try_harder_time
.lock
);
1497 bch_moving_init_cache_set(c
);
1499 INIT_LIST_HEAD(&c
->list
);
1500 INIT_LIST_HEAD(&c
->cached_devs
);
1501 INIT_LIST_HEAD(&c
->btree_cache
);
1502 INIT_LIST_HEAD(&c
->btree_cache_freeable
);
1503 INIT_LIST_HEAD(&c
->btree_cache_freed
);
1504 INIT_LIST_HEAD(&c
->data_buckets
);
1506 c
->search
= mempool_create_slab_pool(32, bch_search_cache
);
1510 iter_size
= (sb
->bucket_size
/ sb
->block_size
+ 1) *
1511 sizeof(struct btree_iter_set
);
1513 if (!(c
->devices
= kzalloc(c
->nr_uuids
* sizeof(void *), GFP_KERNEL
)) ||
1514 !(c
->bio_meta
= mempool_create_kmalloc_pool(2,
1515 sizeof(struct bbio
) + sizeof(struct bio_vec
) *
1516 bucket_pages(c
))) ||
1517 !(c
->fill_iter
= mempool_create_kmalloc_pool(1, iter_size
)) ||
1518 !(c
->bio_split
= bioset_create(4, offsetof(struct bbio
, bio
))) ||
1519 !(c
->uuids
= alloc_bucket_pages(GFP_KERNEL
, c
)) ||
1520 bch_journal_alloc(c
) ||
1521 bch_btree_cache_alloc(c
) ||
1522 bch_open_buckets_alloc(c
) ||
1523 bch_bset_sort_state_init(&c
->sort
, ilog2(c
->btree_pages
)))
1526 c
->congested_read_threshold_us
= 2000;
1527 c
->congested_write_threshold_us
= 20000;
1528 c
->error_limit
= 8 << IO_ERROR_SHIFT
;
1532 bch_cache_set_unregister(c
);
1536 static void run_cache_set(struct cache_set
*c
)
1538 const char *err
= "cannot allocate memory";
1539 struct cached_dev
*dc
, *t
;
1544 closure_init_stack(&cl
);
1546 for_each_cache(ca
, c
, i
)
1547 c
->nbuckets
+= ca
->sb
.nbuckets
;
1549 if (CACHE_SYNC(&c
->sb
)) {
1554 err
= "cannot allocate memory for journal";
1555 if (bch_journal_read(c
, &journal
))
1558 pr_debug("btree_journal_read() done");
1560 err
= "no journal entries found";
1561 if (list_empty(&journal
))
1564 j
= &list_entry(journal
.prev
, struct journal_replay
, list
)->j
;
1566 err
= "IO error reading priorities";
1567 for_each_cache(ca
, c
, i
)
1568 prio_read(ca
, j
->prio_bucket
[ca
->sb
.nr_this_dev
]);
1571 * If prio_read() fails it'll call cache_set_error and we'll
1572 * tear everything down right away, but if we perhaps checked
1573 * sooner we could avoid journal replay.
1578 err
= "bad btree root";
1579 if (__bch_btree_ptr_invalid(c
, k
))
1582 err
= "error reading btree root";
1583 c
->root
= bch_btree_node_get(c
, k
, j
->btree_level
, true);
1584 if (IS_ERR_OR_NULL(c
->root
))
1587 list_del_init(&c
->root
->list
);
1588 rw_unlock(true, c
->root
);
1590 err
= uuid_read(c
, j
, &cl
);
1594 err
= "error in recovery";
1595 if (bch_btree_check(c
))
1598 bch_journal_mark(c
, &journal
);
1599 bch_btree_gc_finish(c
);
1600 pr_debug("btree_check() done");
1603 * bcache_journal_next() can't happen sooner, or
1604 * btree_gc_finish() will give spurious errors about last_gc >
1605 * gc_gen - this is a hack but oh well.
1607 bch_journal_next(&c
->journal
);
1609 err
= "error starting allocator thread";
1610 for_each_cache(ca
, c
, i
)
1611 if (bch_cache_allocator_start(ca
))
1615 * First place it's safe to allocate: btree_check() and
1616 * btree_gc_finish() have to run before we have buckets to
1617 * allocate, and bch_bucket_alloc_set() might cause a journal
1618 * entry to be written so bcache_journal_next() has to be called
1621 * If the uuids were in the old format we have to rewrite them
1622 * before the next journal entry is written:
1624 if (j
->version
< BCACHE_JSET_VERSION_UUID
)
1627 bch_journal_replay(c
, &journal
);
1629 pr_notice("invalidating existing data");
1631 for_each_cache(ca
, c
, i
) {
1634 ca
->sb
.keys
= clamp_t(int, ca
->sb
.nbuckets
>> 7,
1635 2, SB_JOURNAL_BUCKETS
);
1637 for (j
= 0; j
< ca
->sb
.keys
; j
++)
1638 ca
->sb
.d
[j
] = ca
->sb
.first_bucket
+ j
;
1641 bch_btree_gc_finish(c
);
1643 err
= "error starting allocator thread";
1644 for_each_cache(ca
, c
, i
)
1645 if (bch_cache_allocator_start(ca
))
1648 mutex_lock(&c
->bucket_lock
);
1649 for_each_cache(ca
, c
, i
)
1651 mutex_unlock(&c
->bucket_lock
);
1653 err
= "cannot allocate new UUID bucket";
1654 if (__uuid_write(c
))
1657 err
= "cannot allocate new btree root";
1658 c
->root
= bch_btree_node_alloc(c
, 0, true);
1659 if (IS_ERR_OR_NULL(c
->root
))
1662 bkey_copy_key(&c
->root
->key
, &MAX_KEY
);
1663 bch_btree_node_write(c
->root
, &cl
);
1665 bch_btree_set_root(c
->root
);
1666 rw_unlock(true, c
->root
);
1669 * We don't want to write the first journal entry until
1670 * everything is set up - fortunately journal entries won't be
1671 * written until the SET_CACHE_SYNC() here:
1673 SET_CACHE_SYNC(&c
->sb
, true);
1675 bch_journal_next(&c
->journal
);
1676 bch_journal_meta(c
, &cl
);
1679 err
= "error starting gc thread";
1680 if (bch_gc_thread_start(c
))
1684 c
->sb
.last_mount
= get_seconds();
1685 bcache_write_super(c
);
1687 list_for_each_entry_safe(dc
, t
, &uncached_devices
, list
)
1688 bch_cached_dev_attach(dc
, c
);
1695 /* XXX: test this, it's broken */
1696 bch_cache_set_error(c
, "%s", err
);
1699 static bool can_attach_cache(struct cache
*ca
, struct cache_set
*c
)
1701 return ca
->sb
.block_size
== c
->sb
.block_size
&&
1702 ca
->sb
.bucket_size
== c
->sb
.bucket_size
&&
1703 ca
->sb
.nr_in_set
== c
->sb
.nr_in_set
;
1706 static const char *register_cache_set(struct cache
*ca
)
1709 const char *err
= "cannot allocate memory";
1710 struct cache_set
*c
;
1712 list_for_each_entry(c
, &bch_cache_sets
, list
)
1713 if (!memcmp(c
->sb
.set_uuid
, ca
->sb
.set_uuid
, 16)) {
1714 if (c
->cache
[ca
->sb
.nr_this_dev
])
1715 return "duplicate cache set member";
1717 if (!can_attach_cache(ca
, c
))
1718 return "cache sb does not match set";
1720 if (!CACHE_SYNC(&ca
->sb
))
1721 SET_CACHE_SYNC(&c
->sb
, false);
1726 c
= bch_cache_set_alloc(&ca
->sb
);
1730 err
= "error creating kobject";
1731 if (kobject_add(&c
->kobj
, bcache_kobj
, "%pU", c
->sb
.set_uuid
) ||
1732 kobject_add(&c
->internal
, &c
->kobj
, "internal"))
1735 if (bch_cache_accounting_add_kobjs(&c
->accounting
, &c
->kobj
))
1738 bch_debug_init_cache_set(c
);
1740 list_add(&c
->list
, &bch_cache_sets
);
1742 sprintf(buf
, "cache%i", ca
->sb
.nr_this_dev
);
1743 if (sysfs_create_link(&ca
->kobj
, &c
->kobj
, "set") ||
1744 sysfs_create_link(&c
->kobj
, &ca
->kobj
, buf
))
1747 if (ca
->sb
.seq
> c
->sb
.seq
) {
1748 c
->sb
.version
= ca
->sb
.version
;
1749 memcpy(c
->sb
.set_uuid
, ca
->sb
.set_uuid
, 16);
1750 c
->sb
.flags
= ca
->sb
.flags
;
1751 c
->sb
.seq
= ca
->sb
.seq
;
1752 pr_debug("set version = %llu", c
->sb
.version
);
1756 ca
->set
->cache
[ca
->sb
.nr_this_dev
] = ca
;
1757 c
->cache_by_alloc
[c
->caches_loaded
++] = ca
;
1759 if (c
->caches_loaded
== c
->sb
.nr_in_set
)
1764 bch_cache_set_unregister(c
);
1770 void bch_cache_release(struct kobject
*kobj
)
1772 struct cache
*ca
= container_of(kobj
, struct cache
, kobj
);
1776 ca
->set
->cache
[ca
->sb
.nr_this_dev
] = NULL
;
1778 bio_split_pool_free(&ca
->bio_split_hook
);
1780 free_pages((unsigned long) ca
->disk_buckets
, ilog2(bucket_pages(ca
)));
1781 kfree(ca
->prio_buckets
);
1784 free_heap(&ca
->heap
);
1785 free_fifo(&ca
->unused
);
1786 free_fifo(&ca
->free_inc
);
1788 for (i
= 0; i
< RESERVE_NR
; i
++)
1789 free_fifo(&ca
->free
[i
]);
1791 if (ca
->sb_bio
.bi_inline_vecs
[0].bv_page
)
1792 put_page(ca
->sb_bio
.bi_io_vec
[0].bv_page
);
1794 if (!IS_ERR_OR_NULL(ca
->bdev
)) {
1795 blk_sync_queue(bdev_get_queue(ca
->bdev
));
1796 blkdev_put(ca
->bdev
, FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
);
1800 module_put(THIS_MODULE
);
1803 static int cache_alloc(struct cache_sb
*sb
, struct cache
*ca
)
1808 __module_get(THIS_MODULE
);
1809 kobject_init(&ca
->kobj
, &bch_cache_ktype
);
1811 bio_init(&ca
->journal
.bio
);
1812 ca
->journal
.bio
.bi_max_vecs
= 8;
1813 ca
->journal
.bio
.bi_io_vec
= ca
->journal
.bio
.bi_inline_vecs
;
1815 free
= roundup_pow_of_two(ca
->sb
.nbuckets
) >> 10;
1817 if (!init_fifo(&ca
->free
[RESERVE_BTREE
], 8, GFP_KERNEL
) ||
1818 !init_fifo(&ca
->free
[RESERVE_PRIO
], prio_buckets(ca
), GFP_KERNEL
) ||
1819 !init_fifo(&ca
->free
[RESERVE_MOVINGGC
], free
, GFP_KERNEL
) ||
1820 !init_fifo(&ca
->free
[RESERVE_NONE
], free
, GFP_KERNEL
) ||
1821 !init_fifo(&ca
->free_inc
, free
<< 2, GFP_KERNEL
) ||
1822 !init_fifo(&ca
->unused
, free
<< 2, GFP_KERNEL
) ||
1823 !init_heap(&ca
->heap
, free
<< 3, GFP_KERNEL
) ||
1824 !(ca
->buckets
= vzalloc(sizeof(struct bucket
) *
1825 ca
->sb
.nbuckets
)) ||
1826 !(ca
->prio_buckets
= kzalloc(sizeof(uint64_t) * prio_buckets(ca
) *
1828 !(ca
->disk_buckets
= alloc_bucket_pages(GFP_KERNEL
, ca
)) ||
1829 bio_split_pool_init(&ca
->bio_split_hook
))
1832 ca
->prio_last_buckets
= ca
->prio_buckets
+ prio_buckets(ca
);
1834 for_each_bucket(b
, ca
)
1835 atomic_set(&b
->pin
, 0);
1837 if (bch_cache_allocator_init(ca
))
1842 kobject_put(&ca
->kobj
);
1846 static void register_cache(struct cache_sb
*sb
, struct page
*sb_page
,
1847 struct block_device
*bdev
, struct cache
*ca
)
1849 char name
[BDEVNAME_SIZE
];
1850 const char *err
= "cannot allocate memory";
1852 memcpy(&ca
->sb
, sb
, sizeof(struct cache_sb
));
1854 ca
->bdev
->bd_holder
= ca
;
1856 bio_init(&ca
->sb_bio
);
1857 ca
->sb_bio
.bi_max_vecs
= 1;
1858 ca
->sb_bio
.bi_io_vec
= ca
->sb_bio
.bi_inline_vecs
;
1859 ca
->sb_bio
.bi_io_vec
[0].bv_page
= sb_page
;
1862 if (blk_queue_discard(bdev_get_queue(ca
->bdev
)))
1863 ca
->discard
= CACHE_DISCARD(&ca
->sb
);
1865 if (cache_alloc(sb
, ca
) != 0)
1868 err
= "error creating kobject";
1869 if (kobject_add(&ca
->kobj
, &part_to_dev(bdev
->bd_part
)->kobj
, "bcache"))
1872 err
= register_cache_set(ca
);
1876 pr_info("registered cache device %s", bdevname(bdev
, name
));
1879 pr_notice("error opening %s: %s", bdevname(bdev
, name
), err
);
1880 kobject_put(&ca
->kobj
);
1883 /* Global interfaces/init */
1885 static ssize_t
register_bcache(struct kobject
*, struct kobj_attribute
*,
1886 const char *, size_t);
1888 kobj_attribute_write(register, register_bcache
);
1889 kobj_attribute_write(register_quiet
, register_bcache
);
1891 static bool bch_is_open_backing(struct block_device
*bdev
) {
1892 struct cache_set
*c
, *tc
;
1893 struct cached_dev
*dc
, *t
;
1895 list_for_each_entry_safe(c
, tc
, &bch_cache_sets
, list
)
1896 list_for_each_entry_safe(dc
, t
, &c
->cached_devs
, list
)
1897 if (dc
->bdev
== bdev
)
1899 list_for_each_entry_safe(dc
, t
, &uncached_devices
, list
)
1900 if (dc
->bdev
== bdev
)
1905 static bool bch_is_open_cache(struct block_device
*bdev
) {
1906 struct cache_set
*c
, *tc
;
1910 list_for_each_entry_safe(c
, tc
, &bch_cache_sets
, list
)
1911 for_each_cache(ca
, c
, i
)
1912 if (ca
->bdev
== bdev
)
1917 static bool bch_is_open(struct block_device
*bdev
) {
1918 return bch_is_open_cache(bdev
) || bch_is_open_backing(bdev
);
1921 static ssize_t
register_bcache(struct kobject
*k
, struct kobj_attribute
*attr
,
1922 const char *buffer
, size_t size
)
1925 const char *err
= "cannot allocate memory";
1927 struct cache_sb
*sb
= NULL
;
1928 struct block_device
*bdev
= NULL
;
1929 struct page
*sb_page
= NULL
;
1931 if (!try_module_get(THIS_MODULE
))
1934 mutex_lock(&bch_register_lock
);
1936 if (!(path
= kstrndup(buffer
, size
, GFP_KERNEL
)) ||
1937 !(sb
= kmalloc(sizeof(struct cache_sb
), GFP_KERNEL
)))
1940 err
= "failed to open device";
1941 bdev
= blkdev_get_by_path(strim(path
),
1942 FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
,
1945 if (bdev
== ERR_PTR(-EBUSY
)) {
1946 bdev
= lookup_bdev(strim(path
));
1947 if (!IS_ERR(bdev
) && bch_is_open(bdev
))
1948 err
= "device already registered";
1950 err
= "device busy";
1955 err
= "failed to set blocksize";
1956 if (set_blocksize(bdev
, 4096))
1959 err
= read_super(sb
, bdev
, &sb_page
);
1963 if (SB_IS_BDEV(sb
)) {
1964 struct cached_dev
*dc
= kzalloc(sizeof(*dc
), GFP_KERNEL
);
1968 register_bdev(sb
, sb_page
, bdev
, dc
);
1970 struct cache
*ca
= kzalloc(sizeof(*ca
), GFP_KERNEL
);
1974 register_cache(sb
, sb_page
, bdev
, ca
);
1981 mutex_unlock(&bch_register_lock
);
1982 module_put(THIS_MODULE
);
1986 blkdev_put(bdev
, FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
);
1988 if (attr
!= &ksysfs_register_quiet
)
1989 pr_info("error opening %s: %s", path
, err
);
1994 static int bcache_reboot(struct notifier_block
*n
, unsigned long code
, void *x
)
1996 if (code
== SYS_DOWN
||
1998 code
== SYS_POWER_OFF
) {
2000 unsigned long start
= jiffies
;
2001 bool stopped
= false;
2003 struct cache_set
*c
, *tc
;
2004 struct cached_dev
*dc
, *tdc
;
2006 mutex_lock(&bch_register_lock
);
2008 if (list_empty(&bch_cache_sets
) &&
2009 list_empty(&uncached_devices
))
2012 pr_info("Stopping all devices:");
2014 list_for_each_entry_safe(c
, tc
, &bch_cache_sets
, list
)
2015 bch_cache_set_stop(c
);
2017 list_for_each_entry_safe(dc
, tdc
, &uncached_devices
, list
)
2018 bcache_device_stop(&dc
->disk
);
2020 /* What's a condition variable? */
2022 long timeout
= start
+ 2 * HZ
- jiffies
;
2024 stopped
= list_empty(&bch_cache_sets
) &&
2025 list_empty(&uncached_devices
);
2027 if (timeout
< 0 || stopped
)
2030 prepare_to_wait(&unregister_wait
, &wait
,
2031 TASK_UNINTERRUPTIBLE
);
2033 mutex_unlock(&bch_register_lock
);
2034 schedule_timeout(timeout
);
2035 mutex_lock(&bch_register_lock
);
2038 finish_wait(&unregister_wait
, &wait
);
2041 pr_info("All devices stopped");
2043 pr_notice("Timeout waiting for devices to be closed");
2045 mutex_unlock(&bch_register_lock
);
2051 static struct notifier_block reboot
= {
2052 .notifier_call
= bcache_reboot
,
2053 .priority
= INT_MAX
, /* before any real devices */
2056 static void bcache_exit(void)
2062 kobject_put(bcache_kobj
);
2064 destroy_workqueue(bcache_wq
);
2066 unregister_blkdev(bcache_major
, "bcache");
2067 unregister_reboot_notifier(&reboot
);
2070 static int __init
bcache_init(void)
2072 static const struct attribute
*files
[] = {
2073 &ksysfs_register
.attr
,
2074 &ksysfs_register_quiet
.attr
,
2078 mutex_init(&bch_register_lock
);
2079 init_waitqueue_head(&unregister_wait
);
2080 register_reboot_notifier(&reboot
);
2081 closure_debug_init();
2083 bcache_major
= register_blkdev(0, "bcache");
2084 if (bcache_major
< 0)
2085 return bcache_major
;
2087 if (!(bcache_wq
= create_workqueue("bcache")) ||
2088 !(bcache_kobj
= kobject_create_and_add("bcache", fs_kobj
)) ||
2089 sysfs_create_files(bcache_kobj
, files
) ||
2091 bch_request_init() ||
2092 bch_debug_init(bcache_kobj
))
2101 module_exit(bcache_exit
);
2102 module_init(bcache_init
);