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_device_idx
);
57 static wait_queue_head_t unregister_wait
;
58 struct workqueue_struct
*bcache_wq
;
60 #define BTREE_MAX_PAGES (256 * 1024 / PAGE_SIZE)
61 /* limitation of partitions number on single bcache device */
62 #define BCACHE_MINORS 128
63 /* limitation of bcache devices number on single system */
64 #define BCACHE_DEVICE_IDX_MAX ((1U << MINORBITS)/BCACHE_MINORS)
68 static const char *read_super(struct cache_sb
*sb
, struct block_device
*bdev
,
73 struct buffer_head
*bh
= __bread(bdev
, 1, SB_SIZE
);
79 s
= (struct cache_sb
*) bh
->b_data
;
81 sb
->offset
= le64_to_cpu(s
->offset
);
82 sb
->version
= le64_to_cpu(s
->version
);
84 memcpy(sb
->magic
, s
->magic
, 16);
85 memcpy(sb
->uuid
, s
->uuid
, 16);
86 memcpy(sb
->set_uuid
, s
->set_uuid
, 16);
87 memcpy(sb
->label
, s
->label
, SB_LABEL_SIZE
);
89 sb
->flags
= le64_to_cpu(s
->flags
);
90 sb
->seq
= le64_to_cpu(s
->seq
);
91 sb
->last_mount
= le32_to_cpu(s
->last_mount
);
92 sb
->first_bucket
= le16_to_cpu(s
->first_bucket
);
93 sb
->keys
= le16_to_cpu(s
->keys
);
95 for (i
= 0; i
< SB_JOURNAL_BUCKETS
; i
++)
96 sb
->d
[i
] = le64_to_cpu(s
->d
[i
]);
98 pr_debug("read sb version %llu, flags %llu, seq %llu, journal size %u",
99 sb
->version
, sb
->flags
, sb
->seq
, sb
->keys
);
101 err
= "Not a bcache superblock";
102 if (sb
->offset
!= SB_SECTOR
)
105 if (memcmp(sb
->magic
, bcache_magic
, 16))
108 err
= "Too many journal buckets";
109 if (sb
->keys
> SB_JOURNAL_BUCKETS
)
112 err
= "Bad checksum";
113 if (s
->csum
!= csum_set(s
))
117 if (bch_is_zero(sb
->uuid
, 16))
120 sb
->block_size
= le16_to_cpu(s
->block_size
);
122 err
= "Superblock block size smaller than device block size";
123 if (sb
->block_size
<< 9 < bdev_logical_block_size(bdev
))
126 switch (sb
->version
) {
127 case BCACHE_SB_VERSION_BDEV
:
128 sb
->data_offset
= BDEV_DATA_START_DEFAULT
;
130 case BCACHE_SB_VERSION_BDEV_WITH_OFFSET
:
131 sb
->data_offset
= le64_to_cpu(s
->data_offset
);
133 err
= "Bad data offset";
134 if (sb
->data_offset
< BDEV_DATA_START_DEFAULT
)
138 case BCACHE_SB_VERSION_CDEV
:
139 case BCACHE_SB_VERSION_CDEV_WITH_UUID
:
140 sb
->nbuckets
= le64_to_cpu(s
->nbuckets
);
141 sb
->bucket_size
= le16_to_cpu(s
->bucket_size
);
143 sb
->nr_in_set
= le16_to_cpu(s
->nr_in_set
);
144 sb
->nr_this_dev
= le16_to_cpu(s
->nr_this_dev
);
146 err
= "Too many buckets";
147 if (sb
->nbuckets
> LONG_MAX
)
150 err
= "Not enough buckets";
151 if (sb
->nbuckets
< 1 << 7)
154 err
= "Bad block/bucket size";
155 if (!is_power_of_2(sb
->block_size
) ||
156 sb
->block_size
> PAGE_SECTORS
||
157 !is_power_of_2(sb
->bucket_size
) ||
158 sb
->bucket_size
< PAGE_SECTORS
)
161 err
= "Invalid superblock: device too small";
162 if (get_capacity(bdev
->bd_disk
) < sb
->bucket_size
* sb
->nbuckets
)
166 if (bch_is_zero(sb
->set_uuid
, 16))
169 err
= "Bad cache device number in set";
170 if (!sb
->nr_in_set
||
171 sb
->nr_in_set
<= sb
->nr_this_dev
||
172 sb
->nr_in_set
> MAX_CACHES_PER_SET
)
175 err
= "Journal buckets not sequential";
176 for (i
= 0; i
< sb
->keys
; i
++)
177 if (sb
->d
[i
] != sb
->first_bucket
+ i
)
180 err
= "Too many journal buckets";
181 if (sb
->first_bucket
+ sb
->keys
> sb
->nbuckets
)
184 err
= "Invalid superblock: first bucket comes before end of super";
185 if (sb
->first_bucket
* sb
->bucket_size
< 16)
190 err
= "Unsupported superblock version";
194 sb
->last_mount
= get_seconds();
197 get_page(bh
->b_page
);
204 static void write_bdev_super_endio(struct bio
*bio
)
206 struct cached_dev
*dc
= bio
->bi_private
;
207 /* XXX: error checking */
209 closure_put(&dc
->sb_write
);
212 static void __write_super(struct cache_sb
*sb
, struct bio
*bio
)
214 struct cache_sb
*out
= page_address(bio_first_page_all(bio
));
217 bio
->bi_iter
.bi_sector
= SB_SECTOR
;
218 bio
->bi_iter
.bi_size
= SB_SIZE
;
219 bio_set_op_attrs(bio
, REQ_OP_WRITE
, REQ_SYNC
|REQ_META
);
220 bch_bio_map(bio
, NULL
);
222 out
->offset
= cpu_to_le64(sb
->offset
);
223 out
->version
= cpu_to_le64(sb
->version
);
225 memcpy(out
->uuid
, sb
->uuid
, 16);
226 memcpy(out
->set_uuid
, sb
->set_uuid
, 16);
227 memcpy(out
->label
, sb
->label
, SB_LABEL_SIZE
);
229 out
->flags
= cpu_to_le64(sb
->flags
);
230 out
->seq
= cpu_to_le64(sb
->seq
);
232 out
->last_mount
= cpu_to_le32(sb
->last_mount
);
233 out
->first_bucket
= cpu_to_le16(sb
->first_bucket
);
234 out
->keys
= cpu_to_le16(sb
->keys
);
236 for (i
= 0; i
< sb
->keys
; i
++)
237 out
->d
[i
] = cpu_to_le64(sb
->d
[i
]);
239 out
->csum
= csum_set(out
);
241 pr_debug("ver %llu, flags %llu, seq %llu",
242 sb
->version
, sb
->flags
, sb
->seq
);
247 static void bch_write_bdev_super_unlock(struct closure
*cl
)
249 struct cached_dev
*dc
= container_of(cl
, struct cached_dev
, sb_write
);
251 up(&dc
->sb_write_mutex
);
254 void bch_write_bdev_super(struct cached_dev
*dc
, struct closure
*parent
)
256 struct closure
*cl
= &dc
->sb_write
;
257 struct bio
*bio
= &dc
->sb_bio
;
259 down(&dc
->sb_write_mutex
);
260 closure_init(cl
, parent
);
263 bio_set_dev(bio
, dc
->bdev
);
264 bio
->bi_end_io
= write_bdev_super_endio
;
265 bio
->bi_private
= dc
;
268 __write_super(&dc
->sb
, bio
);
270 closure_return_with_destructor(cl
, bch_write_bdev_super_unlock
);
273 static void write_super_endio(struct bio
*bio
)
275 struct cache
*ca
= bio
->bi_private
;
278 bch_count_io_errors(ca
, bio
->bi_status
, 0,
279 "writing superblock");
280 closure_put(&ca
->set
->sb_write
);
283 static void bcache_write_super_unlock(struct closure
*cl
)
285 struct cache_set
*c
= container_of(cl
, struct cache_set
, sb_write
);
287 up(&c
->sb_write_mutex
);
290 void bcache_write_super(struct cache_set
*c
)
292 struct closure
*cl
= &c
->sb_write
;
296 down(&c
->sb_write_mutex
);
297 closure_init(cl
, &c
->cl
);
301 for_each_cache(ca
, c
, i
) {
302 struct bio
*bio
= &ca
->sb_bio
;
304 ca
->sb
.version
= BCACHE_SB_VERSION_CDEV_WITH_UUID
;
305 ca
->sb
.seq
= c
->sb
.seq
;
306 ca
->sb
.last_mount
= c
->sb
.last_mount
;
308 SET_CACHE_SYNC(&ca
->sb
, CACHE_SYNC(&c
->sb
));
311 bio_set_dev(bio
, ca
->bdev
);
312 bio
->bi_end_io
= write_super_endio
;
313 bio
->bi_private
= ca
;
316 __write_super(&ca
->sb
, bio
);
319 closure_return_with_destructor(cl
, bcache_write_super_unlock
);
324 static void uuid_endio(struct bio
*bio
)
326 struct closure
*cl
= bio
->bi_private
;
327 struct cache_set
*c
= container_of(cl
, struct cache_set
, uuid_write
);
329 cache_set_err_on(bio
->bi_status
, c
, "accessing uuids");
330 bch_bbio_free(bio
, c
);
334 static void uuid_io_unlock(struct closure
*cl
)
336 struct cache_set
*c
= container_of(cl
, struct cache_set
, uuid_write
);
338 up(&c
->uuid_write_mutex
);
341 static void uuid_io(struct cache_set
*c
, int op
, unsigned long op_flags
,
342 struct bkey
*k
, struct closure
*parent
)
344 struct closure
*cl
= &c
->uuid_write
;
345 struct uuid_entry
*u
;
350 down(&c
->uuid_write_mutex
);
351 closure_init(cl
, parent
);
353 for (i
= 0; i
< KEY_PTRS(k
); i
++) {
354 struct bio
*bio
= bch_bbio_alloc(c
);
356 bio
->bi_opf
= REQ_SYNC
| REQ_META
| op_flags
;
357 bio
->bi_iter
.bi_size
= KEY_SIZE(k
) << 9;
359 bio
->bi_end_io
= uuid_endio
;
360 bio
->bi_private
= cl
;
361 bio_set_op_attrs(bio
, op
, REQ_SYNC
|REQ_META
|op_flags
);
362 bch_bio_map(bio
, c
->uuids
);
364 bch_submit_bbio(bio
, c
, k
, i
);
366 if (op
!= REQ_OP_WRITE
)
370 bch_extent_to_text(buf
, sizeof(buf
), k
);
371 pr_debug("%s UUIDs at %s", op
== REQ_OP_WRITE
? "wrote" : "read", buf
);
373 for (u
= c
->uuids
; u
< c
->uuids
+ c
->nr_uuids
; u
++)
374 if (!bch_is_zero(u
->uuid
, 16))
375 pr_debug("Slot %zi: %pU: %s: 1st: %u last: %u inv: %u",
376 u
- c
->uuids
, u
->uuid
, u
->label
,
377 u
->first_reg
, u
->last_reg
, u
->invalidated
);
379 closure_return_with_destructor(cl
, uuid_io_unlock
);
382 static char *uuid_read(struct cache_set
*c
, struct jset
*j
, struct closure
*cl
)
384 struct bkey
*k
= &j
->uuid_bucket
;
386 if (__bch_btree_ptr_invalid(c
, k
))
387 return "bad uuid pointer";
389 bkey_copy(&c
->uuid_bucket
, k
);
390 uuid_io(c
, REQ_OP_READ
, 0, k
, cl
);
392 if (j
->version
< BCACHE_JSET_VERSION_UUIDv1
) {
393 struct uuid_entry_v0
*u0
= (void *) c
->uuids
;
394 struct uuid_entry
*u1
= (void *) c
->uuids
;
400 * Since the new uuid entry is bigger than the old, we have to
401 * convert starting at the highest memory address and work down
402 * in order to do it in place
405 for (i
= c
->nr_uuids
- 1;
408 memcpy(u1
[i
].uuid
, u0
[i
].uuid
, 16);
409 memcpy(u1
[i
].label
, u0
[i
].label
, 32);
411 u1
[i
].first_reg
= u0
[i
].first_reg
;
412 u1
[i
].last_reg
= u0
[i
].last_reg
;
413 u1
[i
].invalidated
= u0
[i
].invalidated
;
423 static int __uuid_write(struct cache_set
*c
)
427 closure_init_stack(&cl
);
429 lockdep_assert_held(&bch_register_lock
);
431 if (bch_bucket_alloc_set(c
, RESERVE_BTREE
, &k
.key
, 1, true))
434 SET_KEY_SIZE(&k
.key
, c
->sb
.bucket_size
);
435 uuid_io(c
, REQ_OP_WRITE
, 0, &k
.key
, &cl
);
438 bkey_copy(&c
->uuid_bucket
, &k
.key
);
443 int bch_uuid_write(struct cache_set
*c
)
445 int ret
= __uuid_write(c
);
448 bch_journal_meta(c
, NULL
);
453 static struct uuid_entry
*uuid_find(struct cache_set
*c
, const char *uuid
)
455 struct uuid_entry
*u
;
458 u
< c
->uuids
+ c
->nr_uuids
; u
++)
459 if (!memcmp(u
->uuid
, uuid
, 16))
465 static struct uuid_entry
*uuid_find_empty(struct cache_set
*c
)
467 static const char zero_uuid
[16] = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
468 return uuid_find(c
, zero_uuid
);
472 * Bucket priorities/gens:
474 * For each bucket, we store on disk its
478 * See alloc.c for an explanation of the gen. The priority is used to implement
479 * lru (and in the future other) cache replacement policies; for most purposes
480 * it's just an opaque integer.
482 * The gens and the priorities don't have a whole lot to do with each other, and
483 * it's actually the gens that must be written out at specific times - it's no
484 * big deal if the priorities don't get written, if we lose them we just reuse
485 * buckets in suboptimal order.
487 * On disk they're stored in a packed array, and in as many buckets are required
488 * to fit them all. The buckets we use to store them form a list; the journal
489 * header points to the first bucket, the first bucket points to the second
492 * This code is used by the allocation code; periodically (whenever it runs out
493 * of buckets to allocate from) the allocation code will invalidate some
494 * buckets, but it can't use those buckets until their new gens are safely on
498 static void prio_endio(struct bio
*bio
)
500 struct cache
*ca
= bio
->bi_private
;
502 cache_set_err_on(bio
->bi_status
, ca
->set
, "accessing priorities");
503 bch_bbio_free(bio
, ca
->set
);
504 closure_put(&ca
->prio
);
507 static void prio_io(struct cache
*ca
, uint64_t bucket
, int op
,
508 unsigned long op_flags
)
510 struct closure
*cl
= &ca
->prio
;
511 struct bio
*bio
= bch_bbio_alloc(ca
->set
);
513 closure_init_stack(cl
);
515 bio
->bi_iter
.bi_sector
= bucket
* ca
->sb
.bucket_size
;
516 bio_set_dev(bio
, ca
->bdev
);
517 bio
->bi_iter
.bi_size
= bucket_bytes(ca
);
519 bio
->bi_end_io
= prio_endio
;
520 bio
->bi_private
= ca
;
521 bio_set_op_attrs(bio
, op
, REQ_SYNC
|REQ_META
|op_flags
);
522 bch_bio_map(bio
, ca
->disk_buckets
);
524 closure_bio_submit(bio
, &ca
->prio
);
528 void bch_prio_write(struct cache
*ca
)
534 closure_init_stack(&cl
);
536 lockdep_assert_held(&ca
->set
->bucket_lock
);
538 ca
->disk_buckets
->seq
++;
540 atomic_long_add(ca
->sb
.bucket_size
* prio_buckets(ca
),
541 &ca
->meta_sectors_written
);
543 //pr_debug("free %zu, free_inc %zu, unused %zu", fifo_used(&ca->free),
544 // fifo_used(&ca->free_inc), fifo_used(&ca->unused));
546 for (i
= prio_buckets(ca
) - 1; i
>= 0; --i
) {
548 struct prio_set
*p
= ca
->disk_buckets
;
549 struct bucket_disk
*d
= p
->data
;
550 struct bucket_disk
*end
= d
+ prios_per_bucket(ca
);
552 for (b
= ca
->buckets
+ i
* prios_per_bucket(ca
);
553 b
< ca
->buckets
+ ca
->sb
.nbuckets
&& d
< end
;
555 d
->prio
= cpu_to_le16(b
->prio
);
559 p
->next_bucket
= ca
->prio_buckets
[i
+ 1];
560 p
->magic
= pset_magic(&ca
->sb
);
561 p
->csum
= bch_crc64(&p
->magic
, bucket_bytes(ca
) - 8);
563 bucket
= bch_bucket_alloc(ca
, RESERVE_PRIO
, true);
564 BUG_ON(bucket
== -1);
566 mutex_unlock(&ca
->set
->bucket_lock
);
567 prio_io(ca
, bucket
, REQ_OP_WRITE
, 0);
568 mutex_lock(&ca
->set
->bucket_lock
);
570 ca
->prio_buckets
[i
] = bucket
;
571 atomic_dec_bug(&ca
->buckets
[bucket
].pin
);
574 mutex_unlock(&ca
->set
->bucket_lock
);
576 bch_journal_meta(ca
->set
, &cl
);
579 mutex_lock(&ca
->set
->bucket_lock
);
582 * Don't want the old priorities to get garbage collected until after we
583 * finish writing the new ones, and they're journalled
585 for (i
= 0; i
< prio_buckets(ca
); i
++) {
586 if (ca
->prio_last_buckets
[i
])
587 __bch_bucket_free(ca
,
588 &ca
->buckets
[ca
->prio_last_buckets
[i
]]);
590 ca
->prio_last_buckets
[i
] = ca
->prio_buckets
[i
];
594 static void prio_read(struct cache
*ca
, uint64_t bucket
)
596 struct prio_set
*p
= ca
->disk_buckets
;
597 struct bucket_disk
*d
= p
->data
+ prios_per_bucket(ca
), *end
= d
;
599 unsigned bucket_nr
= 0;
601 for (b
= ca
->buckets
;
602 b
< ca
->buckets
+ ca
->sb
.nbuckets
;
605 ca
->prio_buckets
[bucket_nr
] = bucket
;
606 ca
->prio_last_buckets
[bucket_nr
] = bucket
;
609 prio_io(ca
, bucket
, REQ_OP_READ
, 0);
611 if (p
->csum
!= bch_crc64(&p
->magic
, bucket_bytes(ca
) - 8))
612 pr_warn("bad csum reading priorities");
614 if (p
->magic
!= pset_magic(&ca
->sb
))
615 pr_warn("bad magic reading priorities");
617 bucket
= p
->next_bucket
;
621 b
->prio
= le16_to_cpu(d
->prio
);
622 b
->gen
= b
->last_gc
= d
->gen
;
628 static int open_dev(struct block_device
*b
, fmode_t mode
)
630 struct bcache_device
*d
= b
->bd_disk
->private_data
;
631 if (test_bit(BCACHE_DEV_CLOSING
, &d
->flags
))
638 static void release_dev(struct gendisk
*b
, fmode_t mode
)
640 struct bcache_device
*d
= b
->private_data
;
644 static int ioctl_dev(struct block_device
*b
, fmode_t mode
,
645 unsigned int cmd
, unsigned long arg
)
647 struct bcache_device
*d
= b
->bd_disk
->private_data
;
648 return d
->ioctl(d
, mode
, cmd
, arg
);
651 static const struct block_device_operations bcache_ops
= {
653 .release
= release_dev
,
655 .owner
= THIS_MODULE
,
658 void bcache_device_stop(struct bcache_device
*d
)
660 if (!test_and_set_bit(BCACHE_DEV_CLOSING
, &d
->flags
))
661 closure_queue(&d
->cl
);
664 static void bcache_device_unlink(struct bcache_device
*d
)
666 lockdep_assert_held(&bch_register_lock
);
668 if (d
->c
&& !test_and_set_bit(BCACHE_DEV_UNLINK_DONE
, &d
->flags
)) {
672 sysfs_remove_link(&d
->c
->kobj
, d
->name
);
673 sysfs_remove_link(&d
->kobj
, "cache");
675 for_each_cache(ca
, d
->c
, i
)
676 bd_unlink_disk_holder(ca
->bdev
, d
->disk
);
680 static void bcache_device_link(struct bcache_device
*d
, struct cache_set
*c
,
686 for_each_cache(ca
, d
->c
, i
)
687 bd_link_disk_holder(ca
->bdev
, d
->disk
);
689 snprintf(d
->name
, BCACHEDEVNAME_SIZE
,
690 "%s%u", name
, d
->id
);
692 WARN(sysfs_create_link(&d
->kobj
, &c
->kobj
, "cache") ||
693 sysfs_create_link(&c
->kobj
, &d
->kobj
, d
->name
),
694 "Couldn't create device <-> cache set symlinks");
696 clear_bit(BCACHE_DEV_UNLINK_DONE
, &d
->flags
);
699 static void bcache_device_detach(struct bcache_device
*d
)
701 lockdep_assert_held(&bch_register_lock
);
703 if (test_bit(BCACHE_DEV_DETACHING
, &d
->flags
)) {
704 struct uuid_entry
*u
= d
->c
->uuids
+ d
->id
;
706 SET_UUID_FLASH_ONLY(u
, 0);
707 memcpy(u
->uuid
, invalid_uuid
, 16);
708 u
->invalidated
= cpu_to_le32(get_seconds());
709 bch_uuid_write(d
->c
);
712 bcache_device_unlink(d
);
714 d
->c
->devices
[d
->id
] = NULL
;
715 closure_put(&d
->c
->caching
);
719 static void bcache_device_attach(struct bcache_device
*d
, struct cache_set
*c
,
726 if (id
>= c
->devices_max_used
)
727 c
->devices_max_used
= id
+ 1;
729 closure_get(&c
->caching
);
732 static inline int first_minor_to_idx(int first_minor
)
734 return (first_minor
/BCACHE_MINORS
);
737 static inline int idx_to_first_minor(int idx
)
739 return (idx
* BCACHE_MINORS
);
742 static void bcache_device_free(struct bcache_device
*d
)
744 lockdep_assert_held(&bch_register_lock
);
746 pr_info("%s stopped", d
->disk
->disk_name
);
749 bcache_device_detach(d
);
750 if (d
->disk
&& d
->disk
->flags
& GENHD_FL_UP
)
751 del_gendisk(d
->disk
);
752 if (d
->disk
&& d
->disk
->queue
)
753 blk_cleanup_queue(d
->disk
->queue
);
755 ida_simple_remove(&bcache_device_idx
,
756 first_minor_to_idx(d
->disk
->first_minor
));
761 bioset_free(d
->bio_split
);
762 kvfree(d
->full_dirty_stripes
);
763 kvfree(d
->stripe_sectors_dirty
);
765 closure_debug_destroy(&d
->cl
);
768 static int bcache_device_init(struct bcache_device
*d
, unsigned block_size
,
771 struct request_queue
*q
;
776 d
->stripe_size
= 1 << 31;
778 d
->nr_stripes
= DIV_ROUND_UP_ULL(sectors
, d
->stripe_size
);
780 if (!d
->nr_stripes
||
781 d
->nr_stripes
> INT_MAX
||
782 d
->nr_stripes
> SIZE_MAX
/ sizeof(atomic_t
)) {
783 pr_err("nr_stripes too large or invalid: %u (start sector beyond end of disk?)",
784 (unsigned)d
->nr_stripes
);
788 n
= d
->nr_stripes
* sizeof(atomic_t
);
789 d
->stripe_sectors_dirty
= kvzalloc(n
, GFP_KERNEL
);
790 if (!d
->stripe_sectors_dirty
)
793 n
= BITS_TO_LONGS(d
->nr_stripes
) * sizeof(unsigned long);
794 d
->full_dirty_stripes
= kvzalloc(n
, GFP_KERNEL
);
795 if (!d
->full_dirty_stripes
)
798 idx
= ida_simple_get(&bcache_device_idx
, 0,
799 BCACHE_DEVICE_IDX_MAX
, GFP_KERNEL
);
803 if (!(d
->bio_split
= bioset_create(4, offsetof(struct bbio
, bio
),
805 BIOSET_NEED_RESCUER
)) ||
806 !(d
->disk
= alloc_disk(BCACHE_MINORS
))) {
807 ida_simple_remove(&bcache_device_idx
, idx
);
811 set_capacity(d
->disk
, sectors
);
812 snprintf(d
->disk
->disk_name
, DISK_NAME_LEN
, "bcache%i", idx
);
814 d
->disk
->major
= bcache_major
;
815 d
->disk
->first_minor
= idx_to_first_minor(idx
);
816 d
->disk
->fops
= &bcache_ops
;
817 d
->disk
->private_data
= d
;
819 q
= blk_alloc_queue(GFP_KERNEL
);
823 blk_queue_make_request(q
, NULL
);
826 q
->backing_dev_info
->congested_data
= d
;
827 q
->limits
.max_hw_sectors
= UINT_MAX
;
828 q
->limits
.max_sectors
= UINT_MAX
;
829 q
->limits
.max_segment_size
= UINT_MAX
;
830 q
->limits
.max_segments
= BIO_MAX_PAGES
;
831 blk_queue_max_discard_sectors(q
, UINT_MAX
);
832 q
->limits
.discard_granularity
= 512;
833 q
->limits
.io_min
= block_size
;
834 q
->limits
.logical_block_size
= block_size
;
835 q
->limits
.physical_block_size
= block_size
;
836 set_bit(QUEUE_FLAG_NONROT
, &d
->disk
->queue
->queue_flags
);
837 clear_bit(QUEUE_FLAG_ADD_RANDOM
, &d
->disk
->queue
->queue_flags
);
838 set_bit(QUEUE_FLAG_DISCARD
, &d
->disk
->queue
->queue_flags
);
840 blk_queue_write_cache(q
, true, true);
847 static void calc_cached_dev_sectors(struct cache_set
*c
)
849 uint64_t sectors
= 0;
850 struct cached_dev
*dc
;
852 list_for_each_entry(dc
, &c
->cached_devs
, list
)
853 sectors
+= bdev_sectors(dc
->bdev
);
855 c
->cached_dev_sectors
= sectors
;
858 void bch_cached_dev_run(struct cached_dev
*dc
)
860 struct bcache_device
*d
= &dc
->disk
;
861 char buf
[SB_LABEL_SIZE
+ 1];
864 kasprintf(GFP_KERNEL
, "CACHED_UUID=%pU", dc
->sb
.uuid
),
869 memcpy(buf
, dc
->sb
.label
, SB_LABEL_SIZE
);
870 buf
[SB_LABEL_SIZE
] = '\0';
871 env
[2] = kasprintf(GFP_KERNEL
, "CACHED_LABEL=%s", buf
);
873 if (atomic_xchg(&dc
->running
, 1)) {
880 BDEV_STATE(&dc
->sb
) != BDEV_STATE_NONE
) {
882 closure_init_stack(&cl
);
884 SET_BDEV_STATE(&dc
->sb
, BDEV_STATE_STALE
);
885 bch_write_bdev_super(dc
, &cl
);
890 bd_link_disk_holder(dc
->bdev
, dc
->disk
.disk
);
891 /* won't show up in the uevent file, use udevadm monitor -e instead
892 * only class / kset properties are persistent */
893 kobject_uevent_env(&disk_to_dev(d
->disk
)->kobj
, KOBJ_CHANGE
, env
);
897 if (sysfs_create_link(&d
->kobj
, &disk_to_dev(d
->disk
)->kobj
, "dev") ||
898 sysfs_create_link(&disk_to_dev(d
->disk
)->kobj
, &d
->kobj
, "bcache"))
899 pr_debug("error creating sysfs link");
902 static void cached_dev_detach_finish(struct work_struct
*w
)
904 struct cached_dev
*dc
= container_of(w
, struct cached_dev
, detach
);
905 char buf
[BDEVNAME_SIZE
];
907 closure_init_stack(&cl
);
909 BUG_ON(!test_bit(BCACHE_DEV_DETACHING
, &dc
->disk
.flags
));
910 BUG_ON(refcount_read(&dc
->count
));
912 mutex_lock(&bch_register_lock
);
914 cancel_delayed_work_sync(&dc
->writeback_rate_update
);
915 if (!IS_ERR_OR_NULL(dc
->writeback_thread
)) {
916 kthread_stop(dc
->writeback_thread
);
917 dc
->writeback_thread
= NULL
;
920 memset(&dc
->sb
.set_uuid
, 0, 16);
921 SET_BDEV_STATE(&dc
->sb
, BDEV_STATE_NONE
);
923 bch_write_bdev_super(dc
, &cl
);
926 bcache_device_detach(&dc
->disk
);
927 list_move(&dc
->list
, &uncached_devices
);
929 clear_bit(BCACHE_DEV_DETACHING
, &dc
->disk
.flags
);
930 clear_bit(BCACHE_DEV_UNLINK_DONE
, &dc
->disk
.flags
);
932 mutex_unlock(&bch_register_lock
);
934 pr_info("Caching disabled for %s", bdevname(dc
->bdev
, buf
));
936 /* Drop ref we took in cached_dev_detach() */
937 closure_put(&dc
->disk
.cl
);
940 void bch_cached_dev_detach(struct cached_dev
*dc
)
942 lockdep_assert_held(&bch_register_lock
);
944 if (test_bit(BCACHE_DEV_CLOSING
, &dc
->disk
.flags
))
947 if (test_and_set_bit(BCACHE_DEV_DETACHING
, &dc
->disk
.flags
))
951 * Block the device from being closed and freed until we're finished
954 closure_get(&dc
->disk
.cl
);
956 bch_writeback_queue(dc
);
960 int bch_cached_dev_attach(struct cached_dev
*dc
, struct cache_set
*c
,
963 uint32_t rtime
= cpu_to_le32(get_seconds());
964 struct uuid_entry
*u
;
965 char buf
[BDEVNAME_SIZE
];
967 bdevname(dc
->bdev
, buf
);
969 if ((set_uuid
&& memcmp(set_uuid
, c
->sb
.set_uuid
, 16)) ||
970 (!set_uuid
&& 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 refcount_set(&dc
->count
, 1);
1047 /* Block writeback thread, but spawn it */
1048 down_write(&dc
->writeback_lock
);
1049 if (bch_cached_dev_writeback_start(dc
)) {
1050 up_write(&dc
->writeback_lock
);
1054 if (BDEV_STATE(&dc
->sb
) == BDEV_STATE_DIRTY
) {
1055 bch_sectors_dirty_init(&dc
->disk
);
1056 atomic_set(&dc
->has_dirty
, 1);
1057 refcount_inc(&dc
->count
);
1058 bch_writeback_queue(dc
);
1061 bch_cached_dev_run(dc
);
1062 bcache_device_link(&dc
->disk
, c
, "bdev");
1064 /* Allow the writeback thread to proceed */
1065 up_write(&dc
->writeback_lock
);
1067 pr_info("Caching %s as %s on set %pU",
1068 bdevname(dc
->bdev
, buf
), dc
->disk
.disk
->disk_name
,
1069 dc
->disk
.c
->sb
.set_uuid
);
1073 void bch_cached_dev_release(struct kobject
*kobj
)
1075 struct cached_dev
*dc
= container_of(kobj
, struct cached_dev
,
1078 module_put(THIS_MODULE
);
1081 static void cached_dev_free(struct closure
*cl
)
1083 struct cached_dev
*dc
= container_of(cl
, struct cached_dev
, disk
.cl
);
1085 cancel_delayed_work_sync(&dc
->writeback_rate_update
);
1086 if (!IS_ERR_OR_NULL(dc
->writeback_thread
))
1087 kthread_stop(dc
->writeback_thread
);
1088 if (dc
->writeback_write_wq
)
1089 destroy_workqueue(dc
->writeback_write_wq
);
1091 mutex_lock(&bch_register_lock
);
1093 if (atomic_read(&dc
->running
))
1094 bd_unlink_disk_holder(dc
->bdev
, dc
->disk
.disk
);
1095 bcache_device_free(&dc
->disk
);
1096 list_del(&dc
->list
);
1098 mutex_unlock(&bch_register_lock
);
1100 if (!IS_ERR_OR_NULL(dc
->bdev
))
1101 blkdev_put(dc
->bdev
, FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
);
1103 wake_up(&unregister_wait
);
1105 kobject_put(&dc
->disk
.kobj
);
1108 static void cached_dev_flush(struct closure
*cl
)
1110 struct cached_dev
*dc
= container_of(cl
, struct cached_dev
, disk
.cl
);
1111 struct bcache_device
*d
= &dc
->disk
;
1113 mutex_lock(&bch_register_lock
);
1114 bcache_device_unlink(d
);
1115 mutex_unlock(&bch_register_lock
);
1117 bch_cache_accounting_destroy(&dc
->accounting
);
1118 kobject_del(&d
->kobj
);
1120 continue_at(cl
, cached_dev_free
, system_wq
);
1123 static int cached_dev_init(struct cached_dev
*dc
, unsigned block_size
)
1127 struct request_queue
*q
= bdev_get_queue(dc
->bdev
);
1129 __module_get(THIS_MODULE
);
1130 INIT_LIST_HEAD(&dc
->list
);
1131 closure_init(&dc
->disk
.cl
, NULL
);
1132 set_closure_fn(&dc
->disk
.cl
, cached_dev_flush
, system_wq
);
1133 kobject_init(&dc
->disk
.kobj
, &bch_cached_dev_ktype
);
1134 INIT_WORK(&dc
->detach
, cached_dev_detach_finish
);
1135 sema_init(&dc
->sb_write_mutex
, 1);
1136 INIT_LIST_HEAD(&dc
->io_lru
);
1137 spin_lock_init(&dc
->io_lock
);
1138 bch_cache_accounting_init(&dc
->accounting
, &dc
->disk
.cl
);
1140 dc
->sequential_cutoff
= 4 << 20;
1142 for (io
= dc
->io
; io
< dc
->io
+ RECENT_IO
; io
++) {
1143 list_add(&io
->lru
, &dc
->io_lru
);
1144 hlist_add_head(&io
->hash
, dc
->io_hash
+ RECENT_IO
);
1147 dc
->disk
.stripe_size
= q
->limits
.io_opt
>> 9;
1149 if (dc
->disk
.stripe_size
)
1150 dc
->partial_stripes_expensive
=
1151 q
->limits
.raid_partial_stripes_expensive
;
1153 ret
= bcache_device_init(&dc
->disk
, block_size
,
1154 dc
->bdev
->bd_part
->nr_sects
- dc
->sb
.data_offset
);
1158 dc
->disk
.disk
->queue
->backing_dev_info
->ra_pages
=
1159 max(dc
->disk
.disk
->queue
->backing_dev_info
->ra_pages
,
1160 q
->backing_dev_info
->ra_pages
);
1162 bch_cached_dev_request_init(dc
);
1163 bch_cached_dev_writeback_init(dc
);
1167 /* Cached device - bcache superblock */
1169 static void register_bdev(struct cache_sb
*sb
, struct page
*sb_page
,
1170 struct block_device
*bdev
,
1171 struct cached_dev
*dc
)
1173 char name
[BDEVNAME_SIZE
];
1174 const char *err
= "cannot allocate memory";
1175 struct cache_set
*c
;
1177 memcpy(&dc
->sb
, sb
, sizeof(struct cache_sb
));
1179 dc
->bdev
->bd_holder
= dc
;
1181 bio_init(&dc
->sb_bio
, dc
->sb_bio
.bi_inline_vecs
, 1);
1182 bio_first_bvec_all(&dc
->sb_bio
)->bv_page
= sb_page
;
1185 if (cached_dev_init(dc
, sb
->block_size
<< 9))
1188 err
= "error creating kobject";
1189 if (kobject_add(&dc
->disk
.kobj
, &part_to_dev(bdev
->bd_part
)->kobj
,
1192 if (bch_cache_accounting_add_kobjs(&dc
->accounting
, &dc
->disk
.kobj
))
1195 pr_info("registered backing device %s", bdevname(bdev
, name
));
1197 list_add(&dc
->list
, &uncached_devices
);
1198 list_for_each_entry(c
, &bch_cache_sets
, list
)
1199 bch_cached_dev_attach(dc
, c
, NULL
);
1201 if (BDEV_STATE(&dc
->sb
) == BDEV_STATE_NONE
||
1202 BDEV_STATE(&dc
->sb
) == BDEV_STATE_STALE
)
1203 bch_cached_dev_run(dc
);
1207 pr_notice("error opening %s: %s", bdevname(bdev
, name
), err
);
1208 bcache_device_stop(&dc
->disk
);
1211 /* Flash only volumes */
1213 void bch_flash_dev_release(struct kobject
*kobj
)
1215 struct bcache_device
*d
= container_of(kobj
, struct bcache_device
,
1220 static void flash_dev_free(struct closure
*cl
)
1222 struct bcache_device
*d
= container_of(cl
, struct bcache_device
, cl
);
1223 mutex_lock(&bch_register_lock
);
1224 bcache_device_free(d
);
1225 mutex_unlock(&bch_register_lock
);
1226 kobject_put(&d
->kobj
);
1229 static void flash_dev_flush(struct closure
*cl
)
1231 struct bcache_device
*d
= container_of(cl
, struct bcache_device
, cl
);
1233 mutex_lock(&bch_register_lock
);
1234 bcache_device_unlink(d
);
1235 mutex_unlock(&bch_register_lock
);
1236 kobject_del(&d
->kobj
);
1237 continue_at(cl
, flash_dev_free
, system_wq
);
1240 static int flash_dev_run(struct cache_set
*c
, struct uuid_entry
*u
)
1242 struct bcache_device
*d
= kzalloc(sizeof(struct bcache_device
),
1247 closure_init(&d
->cl
, NULL
);
1248 set_closure_fn(&d
->cl
, flash_dev_flush
, system_wq
);
1250 kobject_init(&d
->kobj
, &bch_flash_dev_ktype
);
1252 if (bcache_device_init(d
, block_bytes(c
), u
->sectors
))
1255 bcache_device_attach(d
, c
, u
- c
->uuids
);
1256 bch_sectors_dirty_init(d
);
1257 bch_flash_dev_request_init(d
);
1260 if (kobject_add(&d
->kobj
, &disk_to_dev(d
->disk
)->kobj
, "bcache"))
1263 bcache_device_link(d
, c
, "volume");
1267 kobject_put(&d
->kobj
);
1271 static int flash_devs_run(struct cache_set
*c
)
1274 struct uuid_entry
*u
;
1277 u
< c
->uuids
+ c
->devices_max_used
&& !ret
;
1279 if (UUID_FLASH_ONLY(u
))
1280 ret
= flash_dev_run(c
, u
);
1285 int bch_flash_dev_create(struct cache_set
*c
, uint64_t size
)
1287 struct uuid_entry
*u
;
1289 if (test_bit(CACHE_SET_STOPPING
, &c
->flags
))
1292 if (!test_bit(CACHE_SET_RUNNING
, &c
->flags
))
1295 u
= uuid_find_empty(c
);
1297 pr_err("Can't create volume, no room for UUID");
1301 get_random_bytes(u
->uuid
, 16);
1302 memset(u
->label
, 0, 32);
1303 u
->first_reg
= u
->last_reg
= cpu_to_le32(get_seconds());
1305 SET_UUID_FLASH_ONLY(u
, 1);
1306 u
->sectors
= size
>> 9;
1310 return flash_dev_run(c
, u
);
1316 bool bch_cache_set_error(struct cache_set
*c
, const char *fmt
, ...)
1320 if (c
->on_error
!= ON_ERROR_PANIC
&&
1321 test_bit(CACHE_SET_STOPPING
, &c
->flags
))
1324 /* XXX: we can be called from atomic context
1325 acquire_console_sem();
1328 printk(KERN_ERR
"bcache: error on %pU: ", c
->sb
.set_uuid
);
1330 va_start(args
, fmt
);
1334 printk(", disabling caching\n");
1336 if (c
->on_error
== ON_ERROR_PANIC
)
1337 panic("panic forced after error\n");
1339 bch_cache_set_unregister(c
);
1343 void bch_cache_set_release(struct kobject
*kobj
)
1345 struct cache_set
*c
= container_of(kobj
, struct cache_set
, kobj
);
1347 module_put(THIS_MODULE
);
1350 static void cache_set_free(struct closure
*cl
)
1352 struct cache_set
*c
= container_of(cl
, struct cache_set
, cl
);
1356 if (!IS_ERR_OR_NULL(c
->debug
))
1357 debugfs_remove(c
->debug
);
1359 bch_open_buckets_free(c
);
1360 bch_btree_cache_free(c
);
1361 bch_journal_free(c
);
1363 for_each_cache(ca
, c
, i
)
1366 c
->cache
[ca
->sb
.nr_this_dev
] = NULL
;
1367 kobject_put(&ca
->kobj
);
1370 bch_bset_sort_state_free(&c
->sort
);
1371 free_pages((unsigned long) c
->uuids
, ilog2(bucket_pages(c
)));
1373 if (c
->moving_gc_wq
)
1374 destroy_workqueue(c
->moving_gc_wq
);
1376 bioset_free(c
->bio_split
);
1378 mempool_destroy(c
->fill_iter
);
1380 mempool_destroy(c
->bio_meta
);
1382 mempool_destroy(c
->search
);
1385 mutex_lock(&bch_register_lock
);
1387 mutex_unlock(&bch_register_lock
);
1389 pr_info("Cache set %pU unregistered", c
->sb
.set_uuid
);
1390 wake_up(&unregister_wait
);
1392 closure_debug_destroy(&c
->cl
);
1393 kobject_put(&c
->kobj
);
1396 static void cache_set_flush(struct closure
*cl
)
1398 struct cache_set
*c
= container_of(cl
, struct cache_set
, caching
);
1403 bch_cache_accounting_destroy(&c
->accounting
);
1405 kobject_put(&c
->internal
);
1406 kobject_del(&c
->kobj
);
1409 kthread_stop(c
->gc_thread
);
1411 if (!IS_ERR_OR_NULL(c
->root
))
1412 list_add(&c
->root
->list
, &c
->btree_cache
);
1414 /* Should skip this if we're unregistering because of an error */
1415 list_for_each_entry(b
, &c
->btree_cache
, list
) {
1416 mutex_lock(&b
->write_lock
);
1417 if (btree_node_dirty(b
))
1418 __bch_btree_node_write(b
, NULL
);
1419 mutex_unlock(&b
->write_lock
);
1422 for_each_cache(ca
, c
, i
)
1423 if (ca
->alloc_thread
)
1424 kthread_stop(ca
->alloc_thread
);
1426 if (c
->journal
.cur
) {
1427 cancel_delayed_work_sync(&c
->journal
.work
);
1428 /* flush last journal entry if needed */
1429 c
->journal
.work
.work
.func(&c
->journal
.work
.work
);
1435 static void __cache_set_unregister(struct closure
*cl
)
1437 struct cache_set
*c
= container_of(cl
, struct cache_set
, caching
);
1438 struct cached_dev
*dc
;
1441 mutex_lock(&bch_register_lock
);
1443 for (i
= 0; i
< c
->devices_max_used
; i
++)
1444 if (c
->devices
[i
]) {
1445 if (!UUID_FLASH_ONLY(&c
->uuids
[i
]) &&
1446 test_bit(CACHE_SET_UNREGISTERING
, &c
->flags
)) {
1447 dc
= container_of(c
->devices
[i
],
1448 struct cached_dev
, disk
);
1449 bch_cached_dev_detach(dc
);
1451 bcache_device_stop(c
->devices
[i
]);
1455 mutex_unlock(&bch_register_lock
);
1457 continue_at(cl
, cache_set_flush
, system_wq
);
1460 void bch_cache_set_stop(struct cache_set
*c
)
1462 if (!test_and_set_bit(CACHE_SET_STOPPING
, &c
->flags
))
1463 closure_queue(&c
->caching
);
1466 void bch_cache_set_unregister(struct cache_set
*c
)
1468 set_bit(CACHE_SET_UNREGISTERING
, &c
->flags
);
1469 bch_cache_set_stop(c
);
1472 #define alloc_bucket_pages(gfp, c) \
1473 ((void *) __get_free_pages(__GFP_ZERO|gfp, ilog2(bucket_pages(c))))
1475 struct cache_set
*bch_cache_set_alloc(struct cache_sb
*sb
)
1478 struct cache_set
*c
= kzalloc(sizeof(struct cache_set
), GFP_KERNEL
);
1482 __module_get(THIS_MODULE
);
1483 closure_init(&c
->cl
, NULL
);
1484 set_closure_fn(&c
->cl
, cache_set_free
, system_wq
);
1486 closure_init(&c
->caching
, &c
->cl
);
1487 set_closure_fn(&c
->caching
, __cache_set_unregister
, system_wq
);
1489 /* Maybe create continue_at_noreturn() and use it here? */
1490 closure_set_stopped(&c
->cl
);
1491 closure_put(&c
->cl
);
1493 kobject_init(&c
->kobj
, &bch_cache_set_ktype
);
1494 kobject_init(&c
->internal
, &bch_cache_set_internal_ktype
);
1496 bch_cache_accounting_init(&c
->accounting
, &c
->cl
);
1498 memcpy(c
->sb
.set_uuid
, sb
->set_uuid
, 16);
1499 c
->sb
.block_size
= sb
->block_size
;
1500 c
->sb
.bucket_size
= sb
->bucket_size
;
1501 c
->sb
.nr_in_set
= sb
->nr_in_set
;
1502 c
->sb
.last_mount
= sb
->last_mount
;
1503 c
->bucket_bits
= ilog2(sb
->bucket_size
);
1504 c
->block_bits
= ilog2(sb
->block_size
);
1505 c
->nr_uuids
= bucket_bytes(c
) / sizeof(struct uuid_entry
);
1506 c
->devices_max_used
= 0;
1507 c
->btree_pages
= bucket_pages(c
);
1508 if (c
->btree_pages
> BTREE_MAX_PAGES
)
1509 c
->btree_pages
= max_t(int, c
->btree_pages
/ 4,
1512 sema_init(&c
->sb_write_mutex
, 1);
1513 mutex_init(&c
->bucket_lock
);
1514 init_waitqueue_head(&c
->btree_cache_wait
);
1515 init_waitqueue_head(&c
->bucket_wait
);
1516 init_waitqueue_head(&c
->gc_wait
);
1517 sema_init(&c
->uuid_write_mutex
, 1);
1519 spin_lock_init(&c
->btree_gc_time
.lock
);
1520 spin_lock_init(&c
->btree_split_time
.lock
);
1521 spin_lock_init(&c
->btree_read_time
.lock
);
1523 bch_moving_init_cache_set(c
);
1525 INIT_LIST_HEAD(&c
->list
);
1526 INIT_LIST_HEAD(&c
->cached_devs
);
1527 INIT_LIST_HEAD(&c
->btree_cache
);
1528 INIT_LIST_HEAD(&c
->btree_cache_freeable
);
1529 INIT_LIST_HEAD(&c
->btree_cache_freed
);
1530 INIT_LIST_HEAD(&c
->data_buckets
);
1532 c
->search
= mempool_create_slab_pool(32, bch_search_cache
);
1536 iter_size
= (sb
->bucket_size
/ sb
->block_size
+ 1) *
1537 sizeof(struct btree_iter_set
);
1539 if (!(c
->devices
= kzalloc(c
->nr_uuids
* sizeof(void *), GFP_KERNEL
)) ||
1540 !(c
->bio_meta
= mempool_create_kmalloc_pool(2,
1541 sizeof(struct bbio
) + sizeof(struct bio_vec
) *
1542 bucket_pages(c
))) ||
1543 !(c
->fill_iter
= mempool_create_kmalloc_pool(1, iter_size
)) ||
1544 !(c
->bio_split
= bioset_create(4, offsetof(struct bbio
, bio
),
1546 BIOSET_NEED_RESCUER
)) ||
1547 !(c
->uuids
= alloc_bucket_pages(GFP_KERNEL
, c
)) ||
1548 !(c
->moving_gc_wq
= alloc_workqueue("bcache_gc",
1549 WQ_MEM_RECLAIM
, 0)) ||
1550 bch_journal_alloc(c
) ||
1551 bch_btree_cache_alloc(c
) ||
1552 bch_open_buckets_alloc(c
) ||
1553 bch_bset_sort_state_init(&c
->sort
, ilog2(c
->btree_pages
)))
1556 c
->congested_read_threshold_us
= 2000;
1557 c
->congested_write_threshold_us
= 20000;
1558 c
->error_limit
= DEFAULT_IO_ERROR_LIMIT
;
1562 bch_cache_set_unregister(c
);
1566 static void run_cache_set(struct cache_set
*c
)
1568 const char *err
= "cannot allocate memory";
1569 struct cached_dev
*dc
, *t
;
1574 closure_init_stack(&cl
);
1576 for_each_cache(ca
, c
, i
)
1577 c
->nbuckets
+= ca
->sb
.nbuckets
;
1580 if (CACHE_SYNC(&c
->sb
)) {
1585 err
= "cannot allocate memory for journal";
1586 if (bch_journal_read(c
, &journal
))
1589 pr_debug("btree_journal_read() done");
1591 err
= "no journal entries found";
1592 if (list_empty(&journal
))
1595 j
= &list_entry(journal
.prev
, struct journal_replay
, list
)->j
;
1597 err
= "IO error reading priorities";
1598 for_each_cache(ca
, c
, i
)
1599 prio_read(ca
, j
->prio_bucket
[ca
->sb
.nr_this_dev
]);
1602 * If prio_read() fails it'll call cache_set_error and we'll
1603 * tear everything down right away, but if we perhaps checked
1604 * sooner we could avoid journal replay.
1609 err
= "bad btree root";
1610 if (__bch_btree_ptr_invalid(c
, k
))
1613 err
= "error reading btree root";
1614 c
->root
= bch_btree_node_get(c
, NULL
, k
, j
->btree_level
, true, NULL
);
1615 if (IS_ERR_OR_NULL(c
->root
))
1618 list_del_init(&c
->root
->list
);
1619 rw_unlock(true, c
->root
);
1621 err
= uuid_read(c
, j
, &cl
);
1625 err
= "error in recovery";
1626 if (bch_btree_check(c
))
1629 bch_journal_mark(c
, &journal
);
1630 bch_initial_gc_finish(c
);
1631 pr_debug("btree_check() done");
1634 * bcache_journal_next() can't happen sooner, or
1635 * btree_gc_finish() will give spurious errors about last_gc >
1636 * gc_gen - this is a hack but oh well.
1638 bch_journal_next(&c
->journal
);
1640 err
= "error starting allocator thread";
1641 for_each_cache(ca
, c
, i
)
1642 if (bch_cache_allocator_start(ca
))
1646 * First place it's safe to allocate: btree_check() and
1647 * btree_gc_finish() have to run before we have buckets to
1648 * allocate, and bch_bucket_alloc_set() might cause a journal
1649 * entry to be written so bcache_journal_next() has to be called
1652 * If the uuids were in the old format we have to rewrite them
1653 * before the next journal entry is written:
1655 if (j
->version
< BCACHE_JSET_VERSION_UUID
)
1658 bch_journal_replay(c
, &journal
);
1660 pr_notice("invalidating existing data");
1662 for_each_cache(ca
, c
, i
) {
1665 ca
->sb
.keys
= clamp_t(int, ca
->sb
.nbuckets
>> 7,
1666 2, SB_JOURNAL_BUCKETS
);
1668 for (j
= 0; j
< ca
->sb
.keys
; j
++)
1669 ca
->sb
.d
[j
] = ca
->sb
.first_bucket
+ j
;
1672 bch_initial_gc_finish(c
);
1674 err
= "error starting allocator thread";
1675 for_each_cache(ca
, c
, i
)
1676 if (bch_cache_allocator_start(ca
))
1679 mutex_lock(&c
->bucket_lock
);
1680 for_each_cache(ca
, c
, i
)
1682 mutex_unlock(&c
->bucket_lock
);
1684 err
= "cannot allocate new UUID bucket";
1685 if (__uuid_write(c
))
1688 err
= "cannot allocate new btree root";
1689 c
->root
= __bch_btree_node_alloc(c
, NULL
, 0, true, NULL
);
1690 if (IS_ERR_OR_NULL(c
->root
))
1693 mutex_lock(&c
->root
->write_lock
);
1694 bkey_copy_key(&c
->root
->key
, &MAX_KEY
);
1695 bch_btree_node_write(c
->root
, &cl
);
1696 mutex_unlock(&c
->root
->write_lock
);
1698 bch_btree_set_root(c
->root
);
1699 rw_unlock(true, c
->root
);
1702 * We don't want to write the first journal entry until
1703 * everything is set up - fortunately journal entries won't be
1704 * written until the SET_CACHE_SYNC() here:
1706 SET_CACHE_SYNC(&c
->sb
, true);
1708 bch_journal_next(&c
->journal
);
1709 bch_journal_meta(c
, &cl
);
1712 err
= "error starting gc thread";
1713 if (bch_gc_thread_start(c
))
1717 c
->sb
.last_mount
= get_seconds();
1718 bcache_write_super(c
);
1720 list_for_each_entry_safe(dc
, t
, &uncached_devices
, list
)
1721 bch_cached_dev_attach(dc
, c
, NULL
);
1725 set_bit(CACHE_SET_RUNNING
, &c
->flags
);
1729 /* XXX: test this, it's broken */
1730 bch_cache_set_error(c
, "%s", err
);
1733 static bool can_attach_cache(struct cache
*ca
, struct cache_set
*c
)
1735 return ca
->sb
.block_size
== c
->sb
.block_size
&&
1736 ca
->sb
.bucket_size
== c
->sb
.bucket_size
&&
1737 ca
->sb
.nr_in_set
== c
->sb
.nr_in_set
;
1740 static const char *register_cache_set(struct cache
*ca
)
1743 const char *err
= "cannot allocate memory";
1744 struct cache_set
*c
;
1746 list_for_each_entry(c
, &bch_cache_sets
, list
)
1747 if (!memcmp(c
->sb
.set_uuid
, ca
->sb
.set_uuid
, 16)) {
1748 if (c
->cache
[ca
->sb
.nr_this_dev
])
1749 return "duplicate cache set member";
1751 if (!can_attach_cache(ca
, c
))
1752 return "cache sb does not match set";
1754 if (!CACHE_SYNC(&ca
->sb
))
1755 SET_CACHE_SYNC(&c
->sb
, false);
1760 c
= bch_cache_set_alloc(&ca
->sb
);
1764 err
= "error creating kobject";
1765 if (kobject_add(&c
->kobj
, bcache_kobj
, "%pU", c
->sb
.set_uuid
) ||
1766 kobject_add(&c
->internal
, &c
->kobj
, "internal"))
1769 if (bch_cache_accounting_add_kobjs(&c
->accounting
, &c
->kobj
))
1772 bch_debug_init_cache_set(c
);
1774 list_add(&c
->list
, &bch_cache_sets
);
1776 sprintf(buf
, "cache%i", ca
->sb
.nr_this_dev
);
1777 if (sysfs_create_link(&ca
->kobj
, &c
->kobj
, "set") ||
1778 sysfs_create_link(&c
->kobj
, &ca
->kobj
, buf
))
1781 if (ca
->sb
.seq
> c
->sb
.seq
) {
1782 c
->sb
.version
= ca
->sb
.version
;
1783 memcpy(c
->sb
.set_uuid
, ca
->sb
.set_uuid
, 16);
1784 c
->sb
.flags
= ca
->sb
.flags
;
1785 c
->sb
.seq
= ca
->sb
.seq
;
1786 pr_debug("set version = %llu", c
->sb
.version
);
1789 kobject_get(&ca
->kobj
);
1791 ca
->set
->cache
[ca
->sb
.nr_this_dev
] = ca
;
1792 c
->cache_by_alloc
[c
->caches_loaded
++] = ca
;
1794 if (c
->caches_loaded
== c
->sb
.nr_in_set
)
1799 bch_cache_set_unregister(c
);
1805 void bch_cache_release(struct kobject
*kobj
)
1807 struct cache
*ca
= container_of(kobj
, struct cache
, kobj
);
1811 BUG_ON(ca
->set
->cache
[ca
->sb
.nr_this_dev
] != ca
);
1812 ca
->set
->cache
[ca
->sb
.nr_this_dev
] = NULL
;
1815 free_pages((unsigned long) ca
->disk_buckets
, ilog2(bucket_pages(ca
)));
1816 kfree(ca
->prio_buckets
);
1819 free_heap(&ca
->heap
);
1820 free_fifo(&ca
->free_inc
);
1822 for (i
= 0; i
< RESERVE_NR
; i
++)
1823 free_fifo(&ca
->free
[i
]);
1825 if (ca
->sb_bio
.bi_inline_vecs
[0].bv_page
)
1826 put_page(bio_first_page_all(&ca
->sb_bio
));
1828 if (!IS_ERR_OR_NULL(ca
->bdev
))
1829 blkdev_put(ca
->bdev
, FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
);
1832 module_put(THIS_MODULE
);
1835 static int cache_alloc(struct cache
*ca
)
1838 size_t btree_buckets
;
1841 __module_get(THIS_MODULE
);
1842 kobject_init(&ca
->kobj
, &bch_cache_ktype
);
1844 bio_init(&ca
->journal
.bio
, ca
->journal
.bio
.bi_inline_vecs
, 8);
1847 * when ca->sb.njournal_buckets is not zero, journal exists,
1848 * and in bch_journal_replay(), tree node may split,
1849 * so bucket of RESERVE_BTREE type is needed,
1850 * the worst situation is all journal buckets are valid journal,
1851 * and all the keys need to replay,
1852 * so the number of RESERVE_BTREE type buckets should be as much
1853 * as journal buckets
1855 btree_buckets
= ca
->sb
.njournal_buckets
?: 8;
1856 free
= roundup_pow_of_two(ca
->sb
.nbuckets
) >> 10;
1858 if (!init_fifo(&ca
->free
[RESERVE_BTREE
], btree_buckets
, GFP_KERNEL
) ||
1859 !init_fifo_exact(&ca
->free
[RESERVE_PRIO
], prio_buckets(ca
), GFP_KERNEL
) ||
1860 !init_fifo(&ca
->free
[RESERVE_MOVINGGC
], free
, GFP_KERNEL
) ||
1861 !init_fifo(&ca
->free
[RESERVE_NONE
], free
, GFP_KERNEL
) ||
1862 !init_fifo(&ca
->free_inc
, free
<< 2, GFP_KERNEL
) ||
1863 !init_heap(&ca
->heap
, free
<< 3, GFP_KERNEL
) ||
1864 !(ca
->buckets
= vzalloc(sizeof(struct bucket
) *
1865 ca
->sb
.nbuckets
)) ||
1866 !(ca
->prio_buckets
= kzalloc(sizeof(uint64_t) * prio_buckets(ca
) *
1868 !(ca
->disk_buckets
= alloc_bucket_pages(GFP_KERNEL
, ca
)))
1871 ca
->prio_last_buckets
= ca
->prio_buckets
+ prio_buckets(ca
);
1873 for_each_bucket(b
, ca
)
1874 atomic_set(&b
->pin
, 0);
1879 static int register_cache(struct cache_sb
*sb
, struct page
*sb_page
,
1880 struct block_device
*bdev
, struct cache
*ca
)
1882 char name
[BDEVNAME_SIZE
];
1883 const char *err
= NULL
; /* must be set for any error case */
1886 memcpy(&ca
->sb
, sb
, sizeof(struct cache_sb
));
1888 ca
->bdev
->bd_holder
= ca
;
1890 bio_init(&ca
->sb_bio
, ca
->sb_bio
.bi_inline_vecs
, 1);
1891 bio_first_bvec_all(&ca
->sb_bio
)->bv_page
= sb_page
;
1894 if (blk_queue_discard(bdev_get_queue(ca
->bdev
)))
1895 ca
->discard
= CACHE_DISCARD(&ca
->sb
);
1897 ret
= cache_alloc(ca
);
1900 err
= "cache_alloc(): -ENOMEM";
1902 err
= "cache_alloc(): unknown error";
1906 if (kobject_add(&ca
->kobj
, &part_to_dev(bdev
->bd_part
)->kobj
, "bcache")) {
1907 err
= "error calling kobject_add";
1912 mutex_lock(&bch_register_lock
);
1913 err
= register_cache_set(ca
);
1914 mutex_unlock(&bch_register_lock
);
1921 pr_info("registered cache device %s", bdevname(bdev
, name
));
1924 kobject_put(&ca
->kobj
);
1928 pr_notice("error opening %s: %s", bdevname(bdev
, name
), err
);
1933 /* Global interfaces/init */
1935 static ssize_t
register_bcache(struct kobject
*, struct kobj_attribute
*,
1936 const char *, size_t);
1938 kobj_attribute_write(register, register_bcache
);
1939 kobj_attribute_write(register_quiet
, register_bcache
);
1941 static bool bch_is_open_backing(struct block_device
*bdev
) {
1942 struct cache_set
*c
, *tc
;
1943 struct cached_dev
*dc
, *t
;
1945 list_for_each_entry_safe(c
, tc
, &bch_cache_sets
, list
)
1946 list_for_each_entry_safe(dc
, t
, &c
->cached_devs
, list
)
1947 if (dc
->bdev
== bdev
)
1949 list_for_each_entry_safe(dc
, t
, &uncached_devices
, list
)
1950 if (dc
->bdev
== bdev
)
1955 static bool bch_is_open_cache(struct block_device
*bdev
) {
1956 struct cache_set
*c
, *tc
;
1960 list_for_each_entry_safe(c
, tc
, &bch_cache_sets
, list
)
1961 for_each_cache(ca
, c
, i
)
1962 if (ca
->bdev
== bdev
)
1967 static bool bch_is_open(struct block_device
*bdev
) {
1968 return bch_is_open_cache(bdev
) || bch_is_open_backing(bdev
);
1971 static ssize_t
register_bcache(struct kobject
*k
, struct kobj_attribute
*attr
,
1972 const char *buffer
, size_t size
)
1975 const char *err
= "cannot allocate memory";
1977 struct cache_sb
*sb
= NULL
;
1978 struct block_device
*bdev
= NULL
;
1979 struct page
*sb_page
= NULL
;
1981 if (!try_module_get(THIS_MODULE
))
1984 if (!(path
= kstrndup(buffer
, size
, GFP_KERNEL
)) ||
1985 !(sb
= kmalloc(sizeof(struct cache_sb
), GFP_KERNEL
)))
1988 err
= "failed to open device";
1989 bdev
= blkdev_get_by_path(strim(path
),
1990 FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
,
1993 if (bdev
== ERR_PTR(-EBUSY
)) {
1994 bdev
= lookup_bdev(strim(path
));
1995 mutex_lock(&bch_register_lock
);
1996 if (!IS_ERR(bdev
) && bch_is_open(bdev
))
1997 err
= "device already registered";
1999 err
= "device busy";
2000 mutex_unlock(&bch_register_lock
);
2003 if (attr
== &ksysfs_register_quiet
)
2009 err
= "failed to set blocksize";
2010 if (set_blocksize(bdev
, 4096))
2013 err
= read_super(sb
, bdev
, &sb_page
);
2017 if (SB_IS_BDEV(sb
)) {
2018 struct cached_dev
*dc
= kzalloc(sizeof(*dc
), GFP_KERNEL
);
2022 mutex_lock(&bch_register_lock
);
2023 register_bdev(sb
, sb_page
, bdev
, dc
);
2024 mutex_unlock(&bch_register_lock
);
2026 struct cache
*ca
= kzalloc(sizeof(*ca
), GFP_KERNEL
);
2030 if (register_cache(sb
, sb_page
, bdev
, ca
) != 0)
2038 module_put(THIS_MODULE
);
2042 blkdev_put(bdev
, FMODE_READ
|FMODE_WRITE
|FMODE_EXCL
);
2044 pr_info("error opening %s: %s", path
, err
);
2049 static int bcache_reboot(struct notifier_block
*n
, unsigned long code
, void *x
)
2051 if (code
== SYS_DOWN
||
2053 code
== SYS_POWER_OFF
) {
2055 unsigned long start
= jiffies
;
2056 bool stopped
= false;
2058 struct cache_set
*c
, *tc
;
2059 struct cached_dev
*dc
, *tdc
;
2061 mutex_lock(&bch_register_lock
);
2063 if (list_empty(&bch_cache_sets
) &&
2064 list_empty(&uncached_devices
))
2067 pr_info("Stopping all devices:");
2069 list_for_each_entry_safe(c
, tc
, &bch_cache_sets
, list
)
2070 bch_cache_set_stop(c
);
2072 list_for_each_entry_safe(dc
, tdc
, &uncached_devices
, list
)
2073 bcache_device_stop(&dc
->disk
);
2075 /* What's a condition variable? */
2077 long timeout
= start
+ 2 * HZ
- jiffies
;
2079 stopped
= list_empty(&bch_cache_sets
) &&
2080 list_empty(&uncached_devices
);
2082 if (timeout
< 0 || stopped
)
2085 prepare_to_wait(&unregister_wait
, &wait
,
2086 TASK_UNINTERRUPTIBLE
);
2088 mutex_unlock(&bch_register_lock
);
2089 schedule_timeout(timeout
);
2090 mutex_lock(&bch_register_lock
);
2093 finish_wait(&unregister_wait
, &wait
);
2096 pr_info("All devices stopped");
2098 pr_notice("Timeout waiting for devices to be closed");
2100 mutex_unlock(&bch_register_lock
);
2106 static struct notifier_block reboot
= {
2107 .notifier_call
= bcache_reboot
,
2108 .priority
= INT_MAX
, /* before any real devices */
2111 static void bcache_exit(void)
2116 kobject_put(bcache_kobj
);
2118 destroy_workqueue(bcache_wq
);
2120 unregister_blkdev(bcache_major
, "bcache");
2121 unregister_reboot_notifier(&reboot
);
2122 mutex_destroy(&bch_register_lock
);
2125 static int __init
bcache_init(void)
2127 static const struct attribute
*files
[] = {
2128 &ksysfs_register
.attr
,
2129 &ksysfs_register_quiet
.attr
,
2133 mutex_init(&bch_register_lock
);
2134 init_waitqueue_head(&unregister_wait
);
2135 register_reboot_notifier(&reboot
);
2136 closure_debug_init();
2138 bcache_major
= register_blkdev(0, "bcache");
2139 if (bcache_major
< 0) {
2140 unregister_reboot_notifier(&reboot
);
2141 mutex_destroy(&bch_register_lock
);
2142 return bcache_major
;
2145 if (!(bcache_wq
= alloc_workqueue("bcache", WQ_MEM_RECLAIM
, 0)) ||
2146 !(bcache_kobj
= kobject_create_and_add("bcache", fs_kobj
)) ||
2147 bch_request_init() ||
2148 bch_debug_init(bcache_kobj
) ||
2149 sysfs_create_files(bcache_kobj
, files
))
2158 module_exit(bcache_exit
);
2159 module_init(bcache_init
);