1 // SPDX-License-Identifier: GPL-2.0
3 * bcache journalling code, for btree insertions
5 * Copyright 2012 Google, Inc.
13 #include <trace/events/bcache.h>
16 * Journal replay/recovery:
18 * This code is all driven from run_cache_set(); we first read the journal
19 * entries, do some other stuff, then we mark all the keys in the journal
20 * entries (same as garbage collection would), then we replay them - reinserting
21 * them into the cache in precisely the same order as they appear in the
24 * We only journal keys that go in leaf nodes, which simplifies things quite a
28 static void journal_read_endio(struct bio *bio)
30 struct closure *cl = bio->bi_private;
34 static int journal_read_bucket(struct cache *ca, struct list_head *list,
35 unsigned bucket_index)
37 struct journal_device *ja = &ca->journal;
38 struct bio *bio = &ja->bio;
40 struct journal_replay *i;
41 struct jset *j, *data = ca->set->journal.w[0].data;
43 unsigned len, left, offset = 0;
45 sector_t bucket = bucket_to_sector(ca->set, ca->sb.d[bucket_index]);
47 closure_init_stack(&cl);
49 pr_debug("reading %u", bucket_index);
51 while (offset < ca->sb.bucket_size) {
52 reread: left = ca->sb.bucket_size - offset;
53 len = min_t(unsigned, left, PAGE_SECTORS << JSET_BITS);
56 bio->bi_iter.bi_sector = bucket + offset;
57 bio_set_dev(bio, ca->bdev);
58 bio->bi_iter.bi_size = len << 9;
60 bio->bi_end_io = journal_read_endio;
61 bio->bi_private = &cl;
62 bio_set_op_attrs(bio, REQ_OP_READ, 0);
63 bch_bio_map(bio, data);
65 closure_bio_submit(bio, &cl);
68 /* This function could be simpler now since we no longer write
69 * journal entries that overlap bucket boundaries; this means
70 * the start of a bucket will always have a valid journal entry
71 * if it has any journal entries at all.
76 struct list_head *where;
77 size_t blocks, bytes = set_bytes(j);
79 if (j->magic != jset_magic(&ca->sb)) {
80 pr_debug("%u: bad magic", bucket_index);
84 if (bytes > left << 9 ||
85 bytes > PAGE_SIZE << JSET_BITS) {
86 pr_info("%u: too big, %zu bytes, offset %u",
87 bucket_index, bytes, offset);
94 if (j->csum != csum_set(j)) {
95 pr_info("%u: bad csum, %zu bytes, offset %u",
96 bucket_index, bytes, offset);
100 blocks = set_blocks(j, block_bytes(ca->set));
102 while (!list_empty(list)) {
103 i = list_first_entry(list,
104 struct journal_replay, list);
105 if (i->j.seq >= j->last_seq)
111 list_for_each_entry_reverse(i, list, list) {
112 if (j->seq == i->j.seq)
115 if (j->seq < i->j.last_seq)
118 if (j->seq > i->j.seq) {
126 i = kmalloc(offsetof(struct journal_replay, j) +
130 memcpy(&i->j, j, bytes);
131 list_add(&i->list, where);
134 ja->seq[bucket_index] = j->seq;
136 offset += blocks * ca->sb.block_size;
137 len -= blocks * ca->sb.block_size;
138 j = ((void *) j) + blocks * block_bytes(ca);
145 int bch_journal_read(struct cache_set *c, struct list_head *list)
147 #define read_bucket(b) \
149 int ret = journal_read_bucket(ca, list, b); \
150 __set_bit(b, bitmap); \
159 for_each_cache(ca, c, iter) {
160 struct journal_device *ja = &ca->journal;
161 DECLARE_BITMAP(bitmap, SB_JOURNAL_BUCKETS);
165 bitmap_zero(bitmap, SB_JOURNAL_BUCKETS);
166 pr_debug("%u journal buckets", ca->sb.njournal_buckets);
169 * Read journal buckets ordered by golden ratio hash to quickly
170 * find a sequence of buckets with valid journal entries
172 for (i = 0; i < ca->sb.njournal_buckets; i++) {
173 l = (i * 2654435769U) % ca->sb.njournal_buckets;
175 if (test_bit(l, bitmap))
183 * If that fails, check all the buckets we haven't checked
186 pr_debug("falling back to linear search");
188 for (l = find_first_zero_bit(bitmap, ca->sb.njournal_buckets);
189 l < ca->sb.njournal_buckets;
190 l = find_next_zero_bit(bitmap, ca->sb.njournal_buckets, l + 1))
194 /* no journal entries on this device? */
195 if (l == ca->sb.njournal_buckets)
198 BUG_ON(list_empty(list));
202 r = find_next_bit(bitmap, ca->sb.njournal_buckets, l + 1);
203 pr_debug("starting binary search, l %u r %u", l, r);
206 seq = list_entry(list->prev, struct journal_replay,
212 if (seq != list_entry(list->prev, struct journal_replay,
220 * Read buckets in reverse order until we stop finding more
223 pr_debug("finishing up: m %u njournal_buckets %u",
224 m, ca->sb.njournal_buckets);
229 l = ca->sb.njournal_buckets - 1;
234 if (test_bit(l, bitmap))
243 for (i = 0; i < ca->sb.njournal_buckets; i++)
244 if (ja->seq[i] > seq) {
247 * When journal_reclaim() goes to allocate for
248 * the first time, it'll use the bucket after
252 ja->last_idx = ja->discard_idx = (i + 1) %
253 ca->sb.njournal_buckets;
258 if (!list_empty(list))
259 c->journal.seq = list_entry(list->prev,
260 struct journal_replay,
267 void bch_journal_mark(struct cache_set *c, struct list_head *list)
271 struct journal_replay *i;
272 struct journal *j = &c->journal;
273 uint64_t last = j->seq;
276 * journal.pin should never fill up - we never write a journal
277 * entry when it would fill up. But if for some reason it does, we
278 * iterate over the list in reverse order so that we can just skip that
279 * refcount instead of bugging.
282 list_for_each_entry_reverse(i, list, list) {
283 BUG_ON(last < i->j.seq);
286 while (last-- != i->j.seq)
287 if (fifo_free(&j->pin) > 1) {
288 fifo_push_front(&j->pin, p);
289 atomic_set(&fifo_front(&j->pin), 0);
292 if (fifo_free(&j->pin) > 1) {
293 fifo_push_front(&j->pin, p);
294 i->pin = &fifo_front(&j->pin);
295 atomic_set(i->pin, 1);
299 k < bset_bkey_last(&i->j);
301 if (!__bch_extent_invalid(c, k)) {
304 for (j = 0; j < KEY_PTRS(k); j++)
305 if (ptr_available(c, k, j))
306 atomic_inc(&PTR_BUCKET(c, k, j)->pin);
308 bch_initial_mark_key(c, 0, k);
313 bool is_discard_enabled(struct cache_set *s)
318 for_each_cache(ca, s, i)
325 int bch_journal_replay(struct cache_set *s, struct list_head *list)
327 int ret = 0, keys = 0, entries = 0;
329 struct journal_replay *i =
330 list_entry(list->prev, struct journal_replay, list);
332 uint64_t start = i->j.last_seq, end = i->j.seq, n = start;
333 struct keylist keylist;
335 list_for_each_entry(i, list, list) {
336 BUG_ON(i->pin && atomic_read(i->pin) != 1);
339 if (n == start && is_discard_enabled(s))
340 pr_info("bcache: journal entries %llu-%llu may be discarded! (replaying %llu-%llu)",
341 n, i->j.seq - 1, start, end);
343 pr_err("bcache: journal entries %llu-%llu missing! (replaying %llu-%llu)",
344 n, i->j.seq - 1, start, end);
351 k < bset_bkey_last(&i->j);
353 trace_bcache_journal_replay_key(k);
355 bch_keylist_init_single(&keylist, k);
357 ret = bch_btree_insert(s, &keylist, i->pin, NULL);
361 BUG_ON(!bch_keylist_empty(&keylist));
373 pr_info("journal replay done, %i keys in %i entries, seq %llu",
376 while (!list_empty(list)) {
377 i = list_first_entry(list, struct journal_replay, list);
387 static void btree_flush_write(struct cache_set *c)
390 * Try to find the btree node with that references the oldest journal
391 * entry, best is our current candidate and is locked if non NULL:
393 struct btree *b, *best;
398 for_each_cached_btree(b, c, i)
399 if (btree_current_write(b)->journal) {
402 else if (journal_pin_cmp(c,
403 btree_current_write(best)->journal,
404 btree_current_write(b)->journal)) {
411 mutex_lock(&b->write_lock);
412 if (!btree_current_write(b)->journal) {
413 mutex_unlock(&b->write_lock);
418 __bch_btree_node_write(b, NULL);
419 mutex_unlock(&b->write_lock);
423 #define last_seq(j) ((j)->seq - fifo_used(&(j)->pin) + 1)
425 static void journal_discard_endio(struct bio *bio)
427 struct journal_device *ja =
428 container_of(bio, struct journal_device, discard_bio);
429 struct cache *ca = container_of(ja, struct cache, journal);
431 atomic_set(&ja->discard_in_flight, DISCARD_DONE);
433 closure_wake_up(&ca->set->journal.wait);
434 closure_put(&ca->set->cl);
437 static void journal_discard_work(struct work_struct *work)
439 struct journal_device *ja =
440 container_of(work, struct journal_device, discard_work);
442 submit_bio(&ja->discard_bio);
445 static void do_journal_discard(struct cache *ca)
447 struct journal_device *ja = &ca->journal;
448 struct bio *bio = &ja->discard_bio;
451 ja->discard_idx = ja->last_idx;
455 switch (atomic_read(&ja->discard_in_flight)) {
456 case DISCARD_IN_FLIGHT:
460 ja->discard_idx = (ja->discard_idx + 1) %
461 ca->sb.njournal_buckets;
463 atomic_set(&ja->discard_in_flight, DISCARD_READY);
467 if (ja->discard_idx == ja->last_idx)
470 atomic_set(&ja->discard_in_flight, DISCARD_IN_FLIGHT);
472 bio_init(bio, bio->bi_inline_vecs, 1);
473 bio_set_op_attrs(bio, REQ_OP_DISCARD, 0);
474 bio->bi_iter.bi_sector = bucket_to_sector(ca->set,
475 ca->sb.d[ja->discard_idx]);
476 bio_set_dev(bio, ca->bdev);
477 bio->bi_iter.bi_size = bucket_bytes(ca);
478 bio->bi_end_io = journal_discard_endio;
480 closure_get(&ca->set->cl);
481 INIT_WORK(&ja->discard_work, journal_discard_work);
482 schedule_work(&ja->discard_work);
486 static void journal_reclaim(struct cache_set *c)
488 struct bkey *k = &c->journal.key;
491 unsigned iter, n = 0;
494 while (!atomic_read(&fifo_front(&c->journal.pin)))
495 fifo_pop(&c->journal.pin, p);
497 last_seq = last_seq(&c->journal);
499 /* Update last_idx */
501 for_each_cache(ca, c, iter) {
502 struct journal_device *ja = &ca->journal;
504 while (ja->last_idx != ja->cur_idx &&
505 ja->seq[ja->last_idx] < last_seq)
506 ja->last_idx = (ja->last_idx + 1) %
507 ca->sb.njournal_buckets;
510 for_each_cache(ca, c, iter)
511 do_journal_discard(ca);
513 if (c->journal.blocks_free)
518 * XXX: Sort by free journal space
521 for_each_cache(ca, c, iter) {
522 struct journal_device *ja = &ca->journal;
523 unsigned next = (ja->cur_idx + 1) % ca->sb.njournal_buckets;
525 /* No space available on this device */
526 if (next == ja->discard_idx)
530 k->ptr[n++] = MAKE_PTR(0,
531 bucket_to_sector(c, ca->sb.d[ja->cur_idx]),
538 c->journal.blocks_free = c->sb.bucket_size >> c->block_bits;
541 if (!journal_full(&c->journal))
542 __closure_wake_up(&c->journal.wait);
545 void bch_journal_next(struct journal *j)
549 j->cur = (j->cur == j->w)
554 * The fifo_push() needs to happen at the same time as j->seq is
555 * incremented for last_seq() to be calculated correctly
557 BUG_ON(!fifo_push(&j->pin, p));
558 atomic_set(&fifo_back(&j->pin), 1);
560 j->cur->data->seq = ++j->seq;
561 j->cur->dirty = false;
562 j->cur->need_write = false;
563 j->cur->data->keys = 0;
565 if (fifo_full(&j->pin))
566 pr_debug("journal_pin full (%zu)", fifo_used(&j->pin));
569 static void journal_write_endio(struct bio *bio)
571 struct journal_write *w = bio->bi_private;
573 cache_set_err_on(bio->bi_status, w->c, "journal io error");
574 closure_put(&w->c->journal.io);
577 static void journal_write(struct closure *);
579 static void journal_write_done(struct closure *cl)
581 struct journal *j = container_of(cl, struct journal, io);
582 struct journal_write *w = (j->cur == j->w)
586 __closure_wake_up(&w->wait);
587 continue_at_nobarrier(cl, journal_write, system_wq);
590 static void journal_write_unlock(struct closure *cl)
592 struct cache_set *c = container_of(cl, struct cache_set, journal.io);
594 c->journal.io_in_flight = 0;
595 spin_unlock(&c->journal.lock);
598 static void journal_write_unlocked(struct closure *cl)
599 __releases(c->journal.lock)
601 struct cache_set *c = container_of(cl, struct cache_set, journal.io);
603 struct journal_write *w = c->journal.cur;
604 struct bkey *k = &c->journal.key;
605 unsigned i, sectors = set_blocks(w->data, block_bytes(c)) *
609 struct bio_list list;
610 bio_list_init(&list);
612 if (!w->need_write) {
613 closure_return_with_destructor(cl, journal_write_unlock);
615 } else if (journal_full(&c->journal)) {
617 spin_unlock(&c->journal.lock);
619 btree_flush_write(c);
620 continue_at(cl, journal_write, system_wq);
624 c->journal.blocks_free -= set_blocks(w->data, block_bytes(c));
626 w->data->btree_level = c->root->level;
628 bkey_copy(&w->data->btree_root, &c->root->key);
629 bkey_copy(&w->data->uuid_bucket, &c->uuid_bucket);
631 for_each_cache(ca, c, i)
632 w->data->prio_bucket[ca->sb.nr_this_dev] = ca->prio_buckets[0];
634 w->data->magic = jset_magic(&c->sb);
635 w->data->version = BCACHE_JSET_VERSION;
636 w->data->last_seq = last_seq(&c->journal);
637 w->data->csum = csum_set(w->data);
639 for (i = 0; i < KEY_PTRS(k); i++) {
640 ca = PTR_CACHE(c, k, i);
641 bio = &ca->journal.bio;
643 atomic_long_add(sectors, &ca->meta_sectors_written);
646 bio->bi_iter.bi_sector = PTR_OFFSET(k, i);
647 bio_set_dev(bio, ca->bdev);
648 bio->bi_iter.bi_size = sectors << 9;
650 bio->bi_end_io = journal_write_endio;
652 bio_set_op_attrs(bio, REQ_OP_WRITE,
653 REQ_SYNC|REQ_META|REQ_PREFLUSH|REQ_FUA);
654 bch_bio_map(bio, w->data);
656 trace_bcache_journal_write(bio);
657 bio_list_add(&list, bio);
659 SET_PTR_OFFSET(k, i, PTR_OFFSET(k, i) + sectors);
661 ca->journal.seq[ca->journal.cur_idx] = w->data->seq;
664 /* If KEY_PTRS(k) == 0, this jset gets lost in air */
667 atomic_dec_bug(&fifo_back(&c->journal.pin));
668 bch_journal_next(&c->journal);
671 spin_unlock(&c->journal.lock);
673 while ((bio = bio_list_pop(&list)))
674 closure_bio_submit(bio, cl);
676 continue_at(cl, journal_write_done, NULL);
679 static void journal_write(struct closure *cl)
681 struct cache_set *c = container_of(cl, struct cache_set, journal.io);
683 spin_lock(&c->journal.lock);
684 journal_write_unlocked(cl);
687 static void journal_try_write(struct cache_set *c)
688 __releases(c->journal.lock)
690 struct closure *cl = &c->journal.io;
691 struct journal_write *w = c->journal.cur;
693 w->need_write = true;
695 if (!c->journal.io_in_flight) {
696 c->journal.io_in_flight = 1;
697 closure_call(cl, journal_write_unlocked, NULL, &c->cl);
699 spin_unlock(&c->journal.lock);
703 static struct journal_write *journal_wait_for_write(struct cache_set *c,
710 closure_init_stack(&cl);
712 spin_lock(&c->journal.lock);
715 struct journal_write *w = c->journal.cur;
717 sectors = __set_blocks(w->data, w->data->keys + nkeys,
718 block_bytes(c)) * c->sb.block_size;
720 if (sectors <= min_t(size_t,
721 c->journal.blocks_free * c->sb.block_size,
722 PAGE_SECTORS << JSET_BITS))
726 closure_wait(&c->journal.wait, &cl);
728 if (!journal_full(&c->journal)) {
730 trace_bcache_journal_entry_full(c);
733 * XXX: If we were inserting so many keys that they
734 * won't fit in an _empty_ journal write, we'll
735 * deadlock. For now, handle this in
736 * bch_keylist_realloc() - but something to think about.
738 BUG_ON(!w->data->keys);
740 journal_try_write(c); /* unlocks */
743 trace_bcache_journal_full(c);
746 spin_unlock(&c->journal.lock);
748 btree_flush_write(c);
752 spin_lock(&c->journal.lock);
757 static void journal_write_work(struct work_struct *work)
759 struct cache_set *c = container_of(to_delayed_work(work),
762 spin_lock(&c->journal.lock);
763 if (c->journal.cur->dirty)
764 journal_try_write(c);
766 spin_unlock(&c->journal.lock);
770 * Entry point to the journalling code - bio_insert() and btree_invalidate()
771 * pass bch_journal() a list of keys to be journalled, and then
772 * bch_journal() hands those same keys off to btree_insert_async()
775 atomic_t *bch_journal(struct cache_set *c,
776 struct keylist *keys,
777 struct closure *parent)
779 struct journal_write *w;
782 if (!CACHE_SYNC(&c->sb))
785 w = journal_wait_for_write(c, bch_keylist_nkeys(keys));
787 memcpy(bset_bkey_last(w->data), keys->keys, bch_keylist_bytes(keys));
788 w->data->keys += bch_keylist_nkeys(keys);
790 ret = &fifo_back(&c->journal.pin);
794 closure_wait(&w->wait, parent);
795 journal_try_write(c);
796 } else if (!w->dirty) {
798 schedule_delayed_work(&c->journal.work,
799 msecs_to_jiffies(c->journal_delay_ms));
800 spin_unlock(&c->journal.lock);
802 spin_unlock(&c->journal.lock);
809 void bch_journal_meta(struct cache_set *c, struct closure *cl)
814 bch_keylist_init(&keys);
816 ref = bch_journal(c, &keys, cl);
821 void bch_journal_free(struct cache_set *c)
823 free_pages((unsigned long) c->journal.w[1].data, JSET_BITS);
824 free_pages((unsigned long) c->journal.w[0].data, JSET_BITS);
825 free_fifo(&c->journal.pin);
828 int bch_journal_alloc(struct cache_set *c)
830 struct journal *j = &c->journal;
832 spin_lock_init(&j->lock);
833 INIT_DELAYED_WORK(&j->work, journal_write_work);
835 c->journal_delay_ms = 100;
840 if (!(init_fifo(&j->pin, JOURNAL_PIN, GFP_KERNEL)) ||
841 !(j->w[0].data = (void *) __get_free_pages(GFP_KERNEL|__GFP_COMP, JSET_BITS)) ||
842 !(j->w[1].data = (void *) __get_free_pages(GFP_KERNEL|__GFP_COMP, JSET_BITS)))