1 // SPDX-License-Identifier: GPL-2.0
3 * bcachefs journalling code, for btree insertions
5 * Copyright 2012 Google, Inc.
9 #include "alloc_foreground.h"
10 #include "bkey_methods.h"
12 #include "btree_update.h"
13 #include "btree_write_buffer.h"
17 #include "journal_io.h"
18 #include "journal_reclaim.h"
19 #include "journal_sb.h"
20 #include "journal_seq_blacklist.h"
23 static const char * const bch2_journal_errors[] = {
30 static inline bool journal_seq_unwritten(struct journal *j, u64 seq)
32 return seq > j->seq_ondisk;
35 static bool __journal_entry_is_open(union journal_res_state state)
37 return state.cur_entry_offset < JOURNAL_ENTRY_CLOSED_VAL;
40 static inline unsigned nr_unwritten_journal_entries(struct journal *j)
42 return atomic64_read(&j->seq) - j->seq_ondisk;
45 static bool journal_entry_is_open(struct journal *j)
47 return __journal_entry_is_open(j->reservations);
50 static void bch2_journal_buf_to_text(struct printbuf *out, struct journal *j, u64 seq)
52 union journal_res_state s = READ_ONCE(j->reservations);
53 unsigned i = seq & JOURNAL_BUF_MASK;
54 struct journal_buf *buf = j->buf + i;
56 prt_printf(out, "seq:\t%llu\n", seq);
57 printbuf_indent_add(out, 2);
59 prt_printf(out, "refcount:\t%u\n", journal_state_count(s, i));
61 prt_printf(out, "size:\t");
62 prt_human_readable_u64(out, vstruct_bytes(buf->data));
65 prt_printf(out, "expires:\t");
66 prt_printf(out, "%li jiffies\n", buf->expires - jiffies);
68 prt_printf(out, "flags:\t");
70 prt_str(out, "noflush ");
72 prt_str(out, "must_flush ");
73 if (buf->separate_flush)
74 prt_str(out, "separate_flush ");
75 if (buf->need_flush_to_write_buffer)
76 prt_str(out, "need_flush_to_write_buffer ");
77 if (buf->write_started)
78 prt_str(out, "write_started ");
79 if (buf->write_allocated)
80 prt_str(out, "write_allocated ");
82 prt_str(out, "write_done");
85 printbuf_indent_sub(out, 2);
88 static void bch2_journal_bufs_to_text(struct printbuf *out, struct journal *j)
90 if (!out->nr_tabstops)
91 printbuf_tabstop_push(out, 24);
93 for (u64 seq = journal_last_unwritten_seq(j);
94 seq <= journal_cur_seq(j);
96 bch2_journal_buf_to_text(out, j, seq);
97 prt_printf(out, "last buf %s\n", journal_entry_is_open(j) ? "open" : "closed");
100 static inline struct journal_buf *
101 journal_seq_to_buf(struct journal *j, u64 seq)
103 struct journal_buf *buf = NULL;
105 EBUG_ON(seq > journal_cur_seq(j));
107 if (journal_seq_unwritten(j, seq)) {
108 buf = j->buf + (seq & JOURNAL_BUF_MASK);
109 EBUG_ON(le64_to_cpu(buf->data->seq) != seq);
114 static void journal_pin_list_init(struct journal_entry_pin_list *p, int count)
118 for (i = 0; i < ARRAY_SIZE(p->list); i++)
119 INIT_LIST_HEAD(&p->list[i]);
120 INIT_LIST_HEAD(&p->flushed);
121 atomic_set(&p->count, count);
126 * Detect stuck journal conditions and trigger shutdown. Technically the journal
127 * can end up stuck for a variety of reasons, such as a blocked I/O, journal
128 * reservation lockup, etc. Since this is a fatal error with potentially
129 * unpredictable characteristics, we want to be fairly conservative before we
130 * decide to shut things down.
132 * Consider the journal stuck when it appears full with no ability to commit
133 * btree transactions, to discard journal buckets, nor acquire priority
134 * (reserved watermark) reservation.
137 journal_error_check_stuck(struct journal *j, int error, unsigned flags)
139 struct bch_fs *c = container_of(j, struct bch_fs, journal);
141 struct printbuf buf = PRINTBUF;
143 if (!(error == JOURNAL_ERR_journal_full ||
144 error == JOURNAL_ERR_journal_pin_full) ||
145 nr_unwritten_journal_entries(j) ||
146 (flags & BCH_WATERMARK_MASK) != BCH_WATERMARK_reclaim)
151 if (j->can_discard) {
152 spin_unlock(&j->lock);
159 * The journal shutdown path will set ->err_seq, but do it here first to
160 * serialize against concurrent failures and avoid duplicate error
164 spin_unlock(&j->lock);
167 j->err_seq = journal_cur_seq(j);
168 spin_unlock(&j->lock);
170 bch_err(c, "Journal stuck! Hava a pre-reservation but journal full (error %s)",
171 bch2_journal_errors[error]);
172 bch2_journal_debug_to_text(&buf, j);
173 bch_err(c, "%s", buf.buf);
175 printbuf_reset(&buf);
176 bch2_journal_pins_to_text(&buf, j);
177 bch_err(c, "Journal pins:\n%s", buf.buf);
186 void bch2_journal_do_writes(struct journal *j)
188 for (u64 seq = journal_last_unwritten_seq(j);
189 seq <= journal_cur_seq(j);
191 unsigned idx = seq & JOURNAL_BUF_MASK;
192 struct journal_buf *w = j->buf + idx;
194 if (w->write_started && !w->write_allocated)
196 if (w->write_started)
199 if (!journal_state_count(j->reservations, idx)) {
200 w->write_started = true;
201 closure_call(&w->io, bch2_journal_write, j->wq, NULL);
209 * Final processing when the last reference of a journal buffer has been
210 * dropped. Drop the pin list reference acquired at journal entry open and write
211 * the buffer, if requested.
213 void bch2_journal_buf_put_final(struct journal *j, u64 seq)
215 lockdep_assert_held(&j->lock);
217 if (__bch2_journal_pin_put(j, seq))
218 bch2_journal_reclaim_fast(j);
219 bch2_journal_do_writes(j);
223 * Returns true if journal entry is now closed:
225 * We don't close a journal_buf until the next journal_buf is finished writing,
226 * and can be opened again - this also initializes the next journal_buf:
228 static void __journal_entry_close(struct journal *j, unsigned closed_val, bool trace)
230 struct bch_fs *c = container_of(j, struct bch_fs, journal);
231 struct journal_buf *buf = journal_cur_buf(j);
232 union journal_res_state old, new;
235 BUG_ON(closed_val != JOURNAL_ENTRY_CLOSED_VAL &&
236 closed_val != JOURNAL_ENTRY_ERROR_VAL);
238 lockdep_assert_held(&j->lock);
240 old.v = atomic64_read(&j->reservations.counter);
243 new.cur_entry_offset = closed_val;
245 if (old.cur_entry_offset == JOURNAL_ENTRY_ERROR_VAL ||
246 old.cur_entry_offset == new.cur_entry_offset)
248 } while (!atomic64_try_cmpxchg(&j->reservations.counter,
251 if (!__journal_entry_is_open(old))
254 /* Close out old buffer: */
255 buf->data->u64s = cpu_to_le32(old.cur_entry_offset);
257 if (trace_journal_entry_close_enabled() && trace) {
258 struct printbuf pbuf = PRINTBUF;
261 prt_str(&pbuf, "entry size: ");
262 prt_human_readable_u64(&pbuf, vstruct_bytes(buf->data));
264 bch2_prt_task_backtrace(&pbuf, current, 1, GFP_NOWAIT);
265 trace_journal_entry_close(c, pbuf.buf);
266 printbuf_exit(&pbuf);
269 sectors = vstruct_blocks_plus(buf->data, c->block_bits,
270 buf->u64s_reserved) << c->block_bits;
271 BUG_ON(sectors > buf->sectors);
272 buf->sectors = sectors;
275 * We have to set last_seq here, _before_ opening a new journal entry:
277 * A threads may replace an old pin with a new pin on their current
278 * journal reservation - the expectation being that the journal will
279 * contain either what the old pin protected or what the new pin
282 * After the old pin is dropped journal_last_seq() won't include the old
283 * pin, so we can only write the updated last_seq on the entry that
284 * contains whatever the new pin protects.
286 * Restated, we can _not_ update last_seq for a given entry if there
287 * could be a newer entry open with reservations/pins that have been
290 * Hence, we want update/set last_seq on the current journal entry right
291 * before we open a new one:
293 buf->last_seq = journal_last_seq(j);
294 buf->data->last_seq = cpu_to_le64(buf->last_seq);
295 BUG_ON(buf->last_seq > le64_to_cpu(buf->data->seq));
297 cancel_delayed_work(&j->write_work);
299 bch2_journal_space_available(j);
301 __bch2_journal_buf_put(j, old.idx, le64_to_cpu(buf->data->seq));
304 void bch2_journal_halt(struct journal *j)
307 __journal_entry_close(j, JOURNAL_ENTRY_ERROR_VAL, true);
309 j->err_seq = journal_cur_seq(j);
311 spin_unlock(&j->lock);
314 static bool journal_entry_want_write(struct journal *j)
316 bool ret = !journal_entry_is_open(j) ||
317 journal_cur_seq(j) == journal_last_unwritten_seq(j);
319 /* Don't close it yet if we already have a write in flight: */
321 __journal_entry_close(j, JOURNAL_ENTRY_CLOSED_VAL, true);
322 else if (nr_unwritten_journal_entries(j)) {
323 struct journal_buf *buf = journal_cur_buf(j);
325 if (!buf->flush_time) {
326 buf->flush_time = local_clock() ?: 1;
327 buf->expires = jiffies;
334 bool bch2_journal_entry_close(struct journal *j)
339 ret = journal_entry_want_write(j);
340 spin_unlock(&j->lock);
346 * should _only_ called from journal_res_get() - when we actually want a
347 * journal reservation - journal entry is open means journal is dirty:
349 static int journal_entry_open(struct journal *j)
351 struct bch_fs *c = container_of(j, struct bch_fs, journal);
352 struct journal_buf *buf = j->buf +
353 ((journal_cur_seq(j) + 1) & JOURNAL_BUF_MASK);
354 union journal_res_state old, new;
357 lockdep_assert_held(&j->lock);
358 BUG_ON(journal_entry_is_open(j));
359 BUG_ON(BCH_SB_CLEAN(c->disk_sb.sb));
362 return JOURNAL_ERR_blocked;
364 if (j->cur_entry_error)
365 return j->cur_entry_error;
367 if (bch2_journal_error(j))
368 return JOURNAL_ERR_insufficient_devices; /* -EROFS */
370 if (!fifo_free(&j->pin))
371 return JOURNAL_ERR_journal_pin_full;
373 if (nr_unwritten_journal_entries(j) == ARRAY_SIZE(j->buf))
374 return JOURNAL_ERR_max_in_flight;
376 BUG_ON(!j->cur_entry_sectors);
379 (journal_cur_seq(j) == j->flushed_seq_ondisk
381 : j->last_flush_write) +
382 msecs_to_jiffies(c->opts.journal_flush_delay);
384 buf->u64s_reserved = j->entry_u64s_reserved;
385 buf->disk_sectors = j->cur_entry_sectors;
386 buf->sectors = min(buf->disk_sectors, buf->buf_size >> 9);
388 u64s = (int) (buf->sectors << 9) / sizeof(u64) -
389 journal_entry_overhead(j);
390 u64s = clamp_t(int, u64s, 0, JOURNAL_ENTRY_CLOSED_VAL - 1);
392 if (u64s <= (ssize_t) j->early_journal_entries.nr)
393 return JOURNAL_ERR_journal_full;
395 if (fifo_empty(&j->pin) && j->reclaim_thread)
396 wake_up_process(j->reclaim_thread);
399 * The fifo_push() needs to happen at the same time as j->seq is
400 * incremented for journal_last_seq() to be calculated correctly
402 atomic64_inc(&j->seq);
403 journal_pin_list_init(fifo_push_ref(&j->pin), 1);
405 BUG_ON(j->pin.back - 1 != atomic64_read(&j->seq));
407 BUG_ON(j->buf + (journal_cur_seq(j) & JOURNAL_BUF_MASK) != buf);
409 bkey_extent_init(&buf->key);
410 buf->noflush = false;
411 buf->must_flush = false;
412 buf->separate_flush = false;
414 buf->need_flush_to_write_buffer = true;
415 buf->write_started = false;
416 buf->write_allocated = false;
417 buf->write_done = false;
419 memset(buf->data, 0, sizeof(*buf->data));
420 buf->data->seq = cpu_to_le64(journal_cur_seq(j));
423 if (j->early_journal_entries.nr) {
424 memcpy(buf->data->_data, j->early_journal_entries.data,
425 j->early_journal_entries.nr * sizeof(u64));
426 le32_add_cpu(&buf->data->u64s, j->early_journal_entries.nr);
430 * Must be set before marking the journal entry as open:
432 j->cur_entry_u64s = u64s;
434 old.v = atomic64_read(&j->reservations.counter);
438 BUG_ON(old.cur_entry_offset == JOURNAL_ENTRY_ERROR_VAL);
441 BUG_ON(journal_state_count(new, new.idx));
442 BUG_ON(new.idx != (journal_cur_seq(j) & JOURNAL_BUF_MASK));
444 journal_state_inc(&new);
446 /* Handle any already added entries */
447 new.cur_entry_offset = le32_to_cpu(buf->data->u64s);
448 } while (!atomic64_try_cmpxchg(&j->reservations.counter,
451 if (nr_unwritten_journal_entries(j) == 1)
452 mod_delayed_work(j->wq,
454 msecs_to_jiffies(c->opts.journal_flush_delay));
457 if (j->early_journal_entries.nr)
458 darray_exit(&j->early_journal_entries);
462 static bool journal_quiesced(struct journal *j)
464 bool ret = atomic64_read(&j->seq) == j->seq_ondisk;
467 bch2_journal_entry_close(j);
471 static void journal_quiesce(struct journal *j)
473 wait_event(j->wait, journal_quiesced(j));
476 static void journal_write_work(struct work_struct *work)
478 struct journal *j = container_of(work, struct journal, write_work.work);
481 if (__journal_entry_is_open(j->reservations)) {
482 long delta = journal_cur_buf(j)->expires - jiffies;
485 mod_delayed_work(j->wq, &j->write_work, delta);
487 __journal_entry_close(j, JOURNAL_ENTRY_CLOSED_VAL, true);
489 spin_unlock(&j->lock);
492 static int __journal_res_get(struct journal *j, struct journal_res *res,
495 struct bch_fs *c = container_of(j, struct bch_fs, journal);
496 struct journal_buf *buf;
500 if (journal_res_get_fast(j, res, flags))
503 if (bch2_journal_error(j))
504 return -BCH_ERR_erofs_journal_err;
507 return -BCH_ERR_journal_res_get_blocked;
509 if ((flags & BCH_WATERMARK_MASK) < j->watermark) {
510 ret = JOURNAL_ERR_journal_full;
511 can_discard = j->can_discard;
515 if (nr_unwritten_journal_entries(j) == ARRAY_SIZE(j->buf) && !journal_entry_is_open(j)) {
516 ret = JOURNAL_ERR_max_in_flight;
523 * Recheck after taking the lock, so we don't race with another thread
524 * that just did journal_entry_open() and call bch2_journal_entry_close()
527 if (journal_res_get_fast(j, res, flags)) {
533 * If we couldn't get a reservation because the current buf filled up,
534 * and we had room for a bigger entry on disk, signal that we want to
535 * realloc the journal bufs:
537 buf = journal_cur_buf(j);
538 if (journal_entry_is_open(j) &&
539 buf->buf_size >> 9 < buf->disk_sectors &&
540 buf->buf_size < JOURNAL_ENTRY_SIZE_MAX)
541 j->buf_size_want = max(j->buf_size_want, buf->buf_size << 1);
543 __journal_entry_close(j, JOURNAL_ENTRY_CLOSED_VAL, false);
544 ret = journal_entry_open(j) ?: JOURNAL_ERR_retry;
546 can_discard = j->can_discard;
547 spin_unlock(&j->lock);
549 if (ret == JOURNAL_ERR_retry)
554 if (journal_error_check_stuck(j, ret, flags))
555 ret = -BCH_ERR_journal_res_get_blocked;
557 if (ret == JOURNAL_ERR_max_in_flight &&
558 track_event_change(&c->times[BCH_TIME_blocked_journal_max_in_flight], true)) {
560 struct printbuf buf = PRINTBUF;
561 prt_printf(&buf, "seq %llu\n", journal_cur_seq(j));
562 bch2_journal_bufs_to_text(&buf, j);
563 trace_journal_entry_full(c, buf.buf);
565 count_event(c, journal_entry_full);
569 * Journal is full - can't rely on reclaim from work item due to
572 if ((ret == JOURNAL_ERR_journal_full ||
573 ret == JOURNAL_ERR_journal_pin_full) &&
574 !(flags & JOURNAL_RES_GET_NONBLOCK)) {
576 bch2_journal_do_discards(j);
580 if (mutex_trylock(&j->reclaim_lock)) {
581 bch2_journal_reclaim(j);
582 mutex_unlock(&j->reclaim_lock);
586 return ret == JOURNAL_ERR_insufficient_devices
587 ? -BCH_ERR_erofs_journal_err
588 : -BCH_ERR_journal_res_get_blocked;
592 * Essentially the entry function to the journaling code. When bcachefs is doing
593 * a btree insert, it calls this function to get the current journal write.
594 * Journal write is the structure used set up journal writes. The calling
595 * function will then add its keys to the structure, queuing them for the next
598 * To ensure forward progress, the current task must not be holding any
599 * btree node write locks.
601 int bch2_journal_res_get_slowpath(struct journal *j, struct journal_res *res,
606 if (closure_wait_event_timeout(&j->async_wait,
607 (ret = __journal_res_get(j, res, flags)) != -BCH_ERR_journal_res_get_blocked ||
608 (flags & JOURNAL_RES_GET_NONBLOCK),
612 struct bch_fs *c = container_of(j, struct bch_fs, journal);
613 struct printbuf buf = PRINTBUF;
614 bch2_journal_debug_to_text(&buf, j);
615 bch_err(c, "Journal stuck? Waited for 10 seconds...\n%s",
619 closure_wait_event(&j->async_wait,
620 (ret = __journal_res_get(j, res, flags)) != -BCH_ERR_journal_res_get_blocked ||
621 (flags & JOURNAL_RES_GET_NONBLOCK));
625 /* journal_entry_res: */
627 void bch2_journal_entry_res_resize(struct journal *j,
628 struct journal_entry_res *res,
631 union journal_res_state state;
632 int d = new_u64s - res->u64s;
636 j->entry_u64s_reserved += d;
640 j->cur_entry_u64s = max_t(int, 0, j->cur_entry_u64s - d);
642 state = READ_ONCE(j->reservations);
644 if (state.cur_entry_offset < JOURNAL_ENTRY_CLOSED_VAL &&
645 state.cur_entry_offset > j->cur_entry_u64s) {
646 j->cur_entry_u64s += d;
648 * Not enough room in current journal entry, have to flush it:
650 __journal_entry_close(j, JOURNAL_ENTRY_CLOSED_VAL, true);
652 journal_cur_buf(j)->u64s_reserved += d;
655 spin_unlock(&j->lock);
659 /* journal flushing: */
662 * bch2_journal_flush_seq_async - wait for a journal entry to be written
665 * @parent: closure object to wait with
666 * Returns: 1 if @seq has already been flushed, 0 if @seq is being flushed,
667 * -EIO if @seq will never be flushed
669 * Like bch2_journal_wait_on_seq, except that it triggers a write immediately if
672 int bch2_journal_flush_seq_async(struct journal *j, u64 seq,
673 struct closure *parent)
675 struct journal_buf *buf;
678 if (seq <= j->flushed_seq_ondisk)
683 if (WARN_ONCE(seq > journal_cur_seq(j),
684 "requested to flush journal seq %llu, but currently at %llu",
685 seq, journal_cur_seq(j)))
688 /* Recheck under lock: */
689 if (j->err_seq && seq >= j->err_seq) {
694 if (seq <= j->flushed_seq_ondisk) {
699 /* if seq was written, but not flushed - flush a newer one instead */
700 seq = max(seq, journal_last_unwritten_seq(j));
703 if (seq > journal_cur_seq(j)) {
704 struct journal_res res = { 0 };
706 if (journal_entry_is_open(j))
707 __journal_entry_close(j, JOURNAL_ENTRY_CLOSED_VAL, true);
709 spin_unlock(&j->lock);
712 * We're called from bch2_journal_flush_seq() -> wait_event();
713 * but this might block. We won't usually block, so we won't
716 sched_annotate_sleep();
717 ret = bch2_journal_res_get(j, &res, jset_u64s(0), 0);
722 buf = journal_seq_to_buf(j, seq);
723 buf->must_flush = true;
725 if (!buf->flush_time) {
726 buf->flush_time = local_clock() ?: 1;
727 buf->expires = jiffies;
730 if (parent && !closure_wait(&buf->wait, parent))
733 bch2_journal_res_put(j, &res);
740 * if write was kicked off without a flush, or if we promised it
741 * wouldn't be a flush, flush the next sequence number instead
743 buf = journal_seq_to_buf(j, seq);
746 goto recheck_need_open;
749 buf->must_flush = true;
751 if (parent && !closure_wait(&buf->wait, parent))
754 if (seq == journal_cur_seq(j))
755 journal_entry_want_write(j);
757 spin_unlock(&j->lock);
761 int bch2_journal_flush_seq(struct journal *j, u64 seq, unsigned task_state)
763 u64 start_time = local_clock();
767 * Don't update time_stats when @seq is already flushed:
769 if (seq <= j->flushed_seq_ondisk)
772 ret = wait_event_state(j->wait,
773 (ret2 = bch2_journal_flush_seq_async(j, seq, NULL)),
777 bch2_time_stats_update(j->flush_seq_time, start_time);
779 return ret ?: ret2 < 0 ? ret2 : 0;
783 * bch2_journal_flush_async - if there is an open journal entry, or a journal
784 * still being written, write it and wait for the write to complete
786 void bch2_journal_flush_async(struct journal *j, struct closure *parent)
788 bch2_journal_flush_seq_async(j, atomic64_read(&j->seq), parent);
791 int bch2_journal_flush(struct journal *j)
793 return bch2_journal_flush_seq(j, atomic64_read(&j->seq), TASK_UNINTERRUPTIBLE);
797 * bch2_journal_noflush_seq - tell the journal not to issue any flushes before
800 bool bch2_journal_noflush_seq(struct journal *j, u64 seq)
802 struct bch_fs *c = container_of(j, struct bch_fs, journal);
806 if (!(c->sb.features & (1ULL << BCH_FEATURE_journal_no_flush)))
809 if (seq <= c->journal.flushed_seq_ondisk)
813 if (seq <= c->journal.flushed_seq_ondisk)
816 for (unwritten_seq = journal_last_unwritten_seq(j);
819 struct journal_buf *buf = journal_seq_to_buf(j, unwritten_seq);
821 /* journal flush already in flight, or flush requseted */
830 spin_unlock(&j->lock);
834 int bch2_journal_meta(struct journal *j)
836 struct journal_buf *buf;
837 struct journal_res res;
840 memset(&res, 0, sizeof(res));
842 ret = bch2_journal_res_get(j, &res, jset_u64s(0), 0);
846 buf = j->buf + (res.seq & JOURNAL_BUF_MASK);
847 buf->must_flush = true;
849 if (!buf->flush_time) {
850 buf->flush_time = local_clock() ?: 1;
851 buf->expires = jiffies;
854 bch2_journal_res_put(j, &res);
856 return bch2_journal_flush_seq(j, res.seq, TASK_UNINTERRUPTIBLE);
859 /* block/unlock the journal: */
861 void bch2_journal_unblock(struct journal *j)
865 spin_unlock(&j->lock);
870 void bch2_journal_block(struct journal *j)
874 spin_unlock(&j->lock);
879 static struct journal_buf *__bch2_next_write_buffer_flush_journal_buf(struct journal *j, u64 max_seq)
881 struct journal_buf *ret = NULL;
883 /* We're inside wait_event(), but using mutex_lock(: */
884 sched_annotate_sleep();
885 mutex_lock(&j->buf_lock);
887 max_seq = min(max_seq, journal_cur_seq(j));
889 for (u64 seq = journal_last_unwritten_seq(j);
892 unsigned idx = seq & JOURNAL_BUF_MASK;
893 struct journal_buf *buf = j->buf + idx;
895 if (buf->need_flush_to_write_buffer) {
896 if (seq == journal_cur_seq(j))
897 __journal_entry_close(j, JOURNAL_ENTRY_CLOSED_VAL, true);
899 union journal_res_state s;
900 s.v = atomic64_read_acquire(&j->reservations.counter);
902 ret = journal_state_count(s, idx)
909 spin_unlock(&j->lock);
910 if (IS_ERR_OR_NULL(ret))
911 mutex_unlock(&j->buf_lock);
915 struct journal_buf *bch2_next_write_buffer_flush_journal_buf(struct journal *j, u64 max_seq)
917 struct journal_buf *ret;
919 wait_event(j->wait, (ret = __bch2_next_write_buffer_flush_journal_buf(j, max_seq)) != ERR_PTR(-EAGAIN));
923 /* allocate journal on a device: */
925 static int __bch2_set_nr_journal_buckets(struct bch_dev *ca, unsigned nr,
926 bool new_fs, struct closure *cl)
928 struct bch_fs *c = ca->fs;
929 struct journal_device *ja = &ca->journal;
930 u64 *new_bucket_seq = NULL, *new_buckets = NULL;
931 struct open_bucket **ob = NULL;
933 unsigned i, pos, nr_got = 0, nr_want = nr - ja->nr;
936 BUG_ON(nr <= ja->nr);
938 bu = kcalloc(nr_want, sizeof(*bu), GFP_KERNEL);
939 ob = kcalloc(nr_want, sizeof(*ob), GFP_KERNEL);
940 new_buckets = kcalloc(nr, sizeof(u64), GFP_KERNEL);
941 new_bucket_seq = kcalloc(nr, sizeof(u64), GFP_KERNEL);
942 if (!bu || !ob || !new_buckets || !new_bucket_seq) {
943 ret = -BCH_ERR_ENOMEM_set_nr_journal_buckets;
947 for (nr_got = 0; nr_got < nr_want; nr_got++) {
949 bu[nr_got] = bch2_bucket_alloc_new_fs(ca);
950 if (bu[nr_got] < 0) {
951 ret = -BCH_ERR_ENOSPC_bucket_alloc;
955 ob[nr_got] = bch2_bucket_alloc(c, ca, BCH_WATERMARK_normal,
956 BCH_DATA_journal, cl);
957 ret = PTR_ERR_OR_ZERO(ob[nr_got]);
961 ret = bch2_trans_run(c,
962 bch2_trans_mark_metadata_bucket(trans, ca,
963 ob[nr_got]->bucket, BCH_DATA_journal,
964 ca->mi.bucket_size, BTREE_TRIGGER_transactional));
966 bch2_open_bucket_put(c, ob[nr_got]);
967 bch_err_msg(c, ret, "marking new journal buckets");
971 bu[nr_got] = ob[nr_got]->bucket;
978 /* Don't return an error if we successfully allocated some buckets: */
982 bch2_journal_flush_all_pins(&c->journal);
983 bch2_journal_block(&c->journal);
984 mutex_lock(&c->sb_lock);
987 memcpy(new_buckets, ja->buckets, ja->nr * sizeof(u64));
988 memcpy(new_bucket_seq, ja->bucket_seq, ja->nr * sizeof(u64));
990 BUG_ON(ja->discard_idx > ja->nr);
992 pos = ja->discard_idx ?: ja->nr;
994 memmove(new_buckets + pos + nr_got,
996 sizeof(new_buckets[0]) * (ja->nr - pos));
997 memmove(new_bucket_seq + pos + nr_got,
998 new_bucket_seq + pos,
999 sizeof(new_bucket_seq[0]) * (ja->nr - pos));
1001 for (i = 0; i < nr_got; i++) {
1002 new_buckets[pos + i] = bu[i];
1003 new_bucket_seq[pos + i] = 0;
1006 nr = ja->nr + nr_got;
1008 ret = bch2_journal_buckets_to_sb(c, ca, new_buckets, nr);
1013 bch2_write_super(c);
1017 spin_lock(&c->journal.lock);
1019 swap(new_buckets, ja->buckets);
1020 swap(new_bucket_seq, ja->bucket_seq);
1023 if (pos <= ja->discard_idx)
1024 ja->discard_idx = (ja->discard_idx + nr_got) % ja->nr;
1025 if (pos <= ja->dirty_idx_ondisk)
1026 ja->dirty_idx_ondisk = (ja->dirty_idx_ondisk + nr_got) % ja->nr;
1027 if (pos <= ja->dirty_idx)
1028 ja->dirty_idx = (ja->dirty_idx + nr_got) % ja->nr;
1029 if (pos <= ja->cur_idx)
1030 ja->cur_idx = (ja->cur_idx + nr_got) % ja->nr;
1033 spin_unlock(&c->journal.lock);
1036 bch2_journal_unblock(&c->journal);
1037 mutex_unlock(&c->sb_lock);
1041 for (i = 0; i < nr_got; i++)
1043 bch2_trans_mark_metadata_bucket(trans, ca,
1044 bu[i], BCH_DATA_free, 0,
1045 BTREE_TRIGGER_transactional));
1048 for (i = 0; i < nr_got; i++)
1049 bch2_open_bucket_put(c, ob[i]);
1051 kfree(new_bucket_seq);
1059 * Allocate more journal space at runtime - not currently making use if it, but
1062 int bch2_set_nr_journal_buckets(struct bch_fs *c, struct bch_dev *ca,
1065 struct journal_device *ja = &ca->journal;
1069 closure_init_stack(&cl);
1071 down_write(&c->state_lock);
1073 /* don't handle reducing nr of buckets yet: */
1077 while (ja->nr < nr) {
1078 struct disk_reservation disk_res = { 0, 0, 0 };
1081 * note: journal buckets aren't really counted as _sectors_ used yet, so
1082 * we don't need the disk reservation to avoid the BUG_ON() in buckets.c
1083 * when space used goes up without a reservation - but we do need the
1084 * reservation to ensure we'll actually be able to allocate:
1086 * XXX: that's not right, disk reservations only ensure a
1087 * filesystem-wide allocation will succeed, this is a device
1088 * specific allocation - we can hang here:
1091 ret = bch2_disk_reservation_get(c, &disk_res,
1092 bucket_to_sector(ca, nr - ja->nr), 1, 0);
1096 ret = __bch2_set_nr_journal_buckets(ca, nr, false, &cl);
1098 bch2_disk_reservation_put(c, &disk_res);
1102 if (ret && ret != -BCH_ERR_bucket_alloc_blocked)
1108 up_write(&c->state_lock);
1112 int bch2_dev_journal_alloc(struct bch_dev *ca, bool new_fs)
1117 if (dynamic_fault("bcachefs:add:journal_alloc")) {
1118 ret = -BCH_ERR_ENOMEM_set_nr_journal_buckets;
1122 /* 1/128th of the device by default: */
1123 nr = ca->mi.nbuckets >> 7;
1126 * clamp journal size to 8192 buckets or 8GB (in sectors), whichever
1129 nr = clamp_t(unsigned, nr,
1130 BCH_JOURNAL_BUCKETS_MIN,
1132 (1 << 24) / ca->mi.bucket_size));
1134 ret = __bch2_set_nr_journal_buckets(ca, nr, new_fs, NULL);
1136 bch_err_fn(ca, ret);
1140 int bch2_fs_journal_alloc(struct bch_fs *c)
1142 for_each_online_member(c, ca) {
1146 int ret = bch2_dev_journal_alloc(ca, true);
1148 percpu_ref_put(&ca->io_ref);
1156 /* startup/shutdown: */
1158 static bool bch2_journal_writing_to_device(struct journal *j, unsigned dev_idx)
1163 spin_lock(&j->lock);
1164 for (seq = journal_last_unwritten_seq(j);
1165 seq <= journal_cur_seq(j) && !ret;
1167 struct journal_buf *buf = journal_seq_to_buf(j, seq);
1169 if (bch2_bkey_has_device_c(bkey_i_to_s_c(&buf->key), dev_idx))
1172 spin_unlock(&j->lock);
1177 void bch2_dev_journal_stop(struct journal *j, struct bch_dev *ca)
1179 wait_event(j->wait, !bch2_journal_writing_to_device(j, ca->dev_idx));
1182 void bch2_fs_journal_stop(struct journal *j)
1184 if (!test_bit(JOURNAL_running, &j->flags))
1187 bch2_journal_reclaim_stop(j);
1188 bch2_journal_flush_all_pins(j);
1190 wait_event(j->wait, bch2_journal_entry_close(j));
1193 * Always write a new journal entry, to make sure the clock hands are up
1194 * to date (and match the superblock)
1196 bch2_journal_meta(j);
1199 cancel_delayed_work_sync(&j->write_work);
1201 WARN(!bch2_journal_error(j) &&
1202 test_bit(JOURNAL_replay_done, &j->flags) &&
1203 j->last_empty_seq != journal_cur_seq(j),
1204 "journal shutdown error: cur seq %llu but last empty seq %llu",
1205 journal_cur_seq(j), j->last_empty_seq);
1207 if (!bch2_journal_error(j))
1208 clear_bit(JOURNAL_running, &j->flags);
1211 int bch2_fs_journal_start(struct journal *j, u64 cur_seq)
1213 struct bch_fs *c = container_of(j, struct bch_fs, journal);
1214 struct journal_entry_pin_list *p;
1215 struct journal_replay *i, **_i;
1216 struct genradix_iter iter;
1217 bool had_entries = false;
1218 u64 last_seq = cur_seq, nr, seq;
1220 genradix_for_each_reverse(&c->journal_entries, iter, _i) {
1223 if (journal_replay_ignore(i))
1226 last_seq = le64_to_cpu(i->j.last_seq);
1230 nr = cur_seq - last_seq;
1232 if (nr + 1 > j->pin.size) {
1234 init_fifo(&j->pin, roundup_pow_of_two(nr + 1), GFP_KERNEL);
1236 bch_err(c, "error reallocating journal fifo (%llu open entries)", nr);
1237 return -BCH_ERR_ENOMEM_journal_pin_fifo;
1241 j->replay_journal_seq = last_seq;
1242 j->replay_journal_seq_end = cur_seq;
1243 j->last_seq_ondisk = last_seq;
1244 j->flushed_seq_ondisk = cur_seq - 1;
1245 j->seq_ondisk = cur_seq - 1;
1246 j->pin.front = last_seq;
1247 j->pin.back = cur_seq;
1248 atomic64_set(&j->seq, cur_seq - 1);
1250 fifo_for_each_entry_ptr(p, &j->pin, seq)
1251 journal_pin_list_init(p, 1);
1253 genradix_for_each(&c->journal_entries, iter, _i) {
1256 if (journal_replay_ignore(i))
1259 seq = le64_to_cpu(i->j.seq);
1260 BUG_ON(seq >= cur_seq);
1265 if (journal_entry_empty(&i->j))
1266 j->last_empty_seq = le64_to_cpu(i->j.seq);
1268 p = journal_seq_pin(j, seq);
1271 darray_for_each(i->ptrs, ptr)
1272 bch2_dev_list_add_dev(&p->devs, ptr->dev);
1278 j->last_empty_seq = cur_seq - 1; /* to match j->seq */
1280 spin_lock(&j->lock);
1282 set_bit(JOURNAL_running, &j->flags);
1283 j->last_flush_write = jiffies;
1285 j->reservations.idx = j->reservations.unwritten_idx = journal_cur_seq(j);
1286 j->reservations.unwritten_idx++;
1288 c->last_bucket_seq_cleanup = journal_cur_seq(j);
1290 bch2_journal_space_available(j);
1291 spin_unlock(&j->lock);
1293 return bch2_journal_reclaim_start(j);
1298 void bch2_dev_journal_exit(struct bch_dev *ca)
1300 struct journal_device *ja = &ca->journal;
1302 for (unsigned i = 0; i < ARRAY_SIZE(ja->bio); i++) {
1308 kfree(ja->bucket_seq);
1310 ja->bucket_seq = NULL;
1313 int bch2_dev_journal_init(struct bch_dev *ca, struct bch_sb *sb)
1315 struct journal_device *ja = &ca->journal;
1316 struct bch_sb_field_journal *journal_buckets =
1317 bch2_sb_field_get(sb, journal);
1318 struct bch_sb_field_journal_v2 *journal_buckets_v2 =
1319 bch2_sb_field_get(sb, journal_v2);
1323 if (journal_buckets_v2) {
1324 unsigned nr = bch2_sb_field_journal_v2_nr_entries(journal_buckets_v2);
1326 for (unsigned i = 0; i < nr; i++)
1327 ja->nr += le64_to_cpu(journal_buckets_v2->d[i].nr);
1328 } else if (journal_buckets) {
1329 ja->nr = bch2_nr_journal_buckets(journal_buckets);
1332 ja->bucket_seq = kcalloc(ja->nr, sizeof(u64), GFP_KERNEL);
1333 if (!ja->bucket_seq)
1334 return -BCH_ERR_ENOMEM_dev_journal_init;
1336 unsigned nr_bvecs = DIV_ROUND_UP(JOURNAL_ENTRY_SIZE_MAX, PAGE_SIZE);
1338 for (unsigned i = 0; i < ARRAY_SIZE(ja->bio); i++) {
1339 ja->bio[i] = kmalloc(struct_size(ja->bio[i], bio.bi_inline_vecs,
1340 nr_bvecs), GFP_KERNEL);
1342 return -BCH_ERR_ENOMEM_dev_journal_init;
1344 ja->bio[i]->ca = ca;
1345 ja->bio[i]->buf_idx = i;
1346 bio_init(&ja->bio[i]->bio, NULL, ja->bio[i]->bio.bi_inline_vecs, nr_bvecs, 0);
1349 ja->buckets = kcalloc(ja->nr, sizeof(u64), GFP_KERNEL);
1351 return -BCH_ERR_ENOMEM_dev_journal_init;
1353 if (journal_buckets_v2) {
1354 unsigned nr = bch2_sb_field_journal_v2_nr_entries(journal_buckets_v2);
1357 for (unsigned i = 0; i < nr; i++)
1358 for (unsigned j = 0; j < le64_to_cpu(journal_buckets_v2->d[i].nr); j++)
1359 ja->buckets[dst++] =
1360 le64_to_cpu(journal_buckets_v2->d[i].start) + j;
1361 } else if (journal_buckets) {
1362 for (unsigned i = 0; i < ja->nr; i++)
1363 ja->buckets[i] = le64_to_cpu(journal_buckets->buckets[i]);
1369 void bch2_fs_journal_exit(struct journal *j)
1372 destroy_workqueue(j->wq);
1374 darray_exit(&j->early_journal_entries);
1376 for (unsigned i = 0; i < ARRAY_SIZE(j->buf); i++)
1377 kvfree(j->buf[i].data);
1381 int bch2_fs_journal_init(struct journal *j)
1383 static struct lock_class_key res_key;
1385 mutex_init(&j->buf_lock);
1386 spin_lock_init(&j->lock);
1387 spin_lock_init(&j->err_lock);
1388 init_waitqueue_head(&j->wait);
1389 INIT_DELAYED_WORK(&j->write_work, journal_write_work);
1390 init_waitqueue_head(&j->reclaim_wait);
1391 init_waitqueue_head(&j->pin_flush_wait);
1392 mutex_init(&j->reclaim_lock);
1393 mutex_init(&j->discard_lock);
1395 lockdep_init_map(&j->res_map, "journal res", &res_key, 0);
1397 atomic64_set(&j->reservations.counter,
1398 ((union journal_res_state)
1399 { .cur_entry_offset = JOURNAL_ENTRY_CLOSED_VAL }).v);
1401 if (!(init_fifo(&j->pin, JOURNAL_PIN, GFP_KERNEL)))
1402 return -BCH_ERR_ENOMEM_journal_pin_fifo;
1404 for (unsigned i = 0; i < ARRAY_SIZE(j->buf); i++) {
1405 j->buf[i].buf_size = JOURNAL_ENTRY_SIZE_MIN;
1406 j->buf[i].data = kvmalloc(j->buf[i].buf_size, GFP_KERNEL);
1407 if (!j->buf[i].data)
1408 return -BCH_ERR_ENOMEM_journal_buf;
1412 j->pin.front = j->pin.back = 1;
1414 j->wq = alloc_workqueue("bcachefs_journal",
1415 WQ_HIGHPRI|WQ_FREEZABLE|WQ_UNBOUND|WQ_MEM_RECLAIM, 512);
1417 return -BCH_ERR_ENOMEM_fs_other_alloc;
1423 static const char * const bch2_journal_flags_strs[] = {
1430 void __bch2_journal_debug_to_text(struct printbuf *out, struct journal *j)
1432 struct bch_fs *c = container_of(j, struct bch_fs, journal);
1433 union journal_res_state s;
1434 unsigned long now = jiffies;
1435 u64 nr_writes = j->nr_flush_writes + j->nr_noflush_writes;
1437 printbuf_tabstops_reset(out);
1438 printbuf_tabstop_push(out, 28);
1442 s = READ_ONCE(j->reservations);
1444 prt_printf(out, "flags:\t");
1445 prt_bitflags(out, bch2_journal_flags_strs, j->flags);
1447 prt_printf(out, "dirty journal entries:\t%llu/%llu\n", fifo_used(&j->pin), j->pin.size);
1448 prt_printf(out, "seq:\t%llu\n", journal_cur_seq(j));
1449 prt_printf(out, "seq_ondisk:\t%llu\n", j->seq_ondisk);
1450 prt_printf(out, "last_seq:\t%llu\n", journal_last_seq(j));
1451 prt_printf(out, "last_seq_ondisk:\t%llu\n", j->last_seq_ondisk);
1452 prt_printf(out, "flushed_seq_ondisk:\t%llu\n", j->flushed_seq_ondisk);
1453 prt_printf(out, "watermark:\t%s\n", bch2_watermarks[j->watermark]);
1454 prt_printf(out, "each entry reserved:\t%u\n", j->entry_u64s_reserved);
1455 prt_printf(out, "nr flush writes:\t%llu\n", j->nr_flush_writes);
1456 prt_printf(out, "nr noflush writes:\t%llu\n", j->nr_noflush_writes);
1457 prt_printf(out, "average write size:\t");
1458 prt_human_readable_u64(out, nr_writes ? div64_u64(j->entry_bytes_written, nr_writes) : 0);
1460 prt_printf(out, "nr direct reclaim:\t%llu\n", j->nr_direct_reclaim);
1461 prt_printf(out, "nr background reclaim:\t%llu\n", j->nr_background_reclaim);
1462 prt_printf(out, "reclaim kicked:\t%u\n", j->reclaim_kicked);
1463 prt_printf(out, "reclaim runs in:\t%u ms\n", time_after(j->next_reclaim, now)
1464 ? jiffies_to_msecs(j->next_reclaim - jiffies) : 0);
1465 prt_printf(out, "blocked:\t%u\n", j->blocked);
1466 prt_printf(out, "current entry sectors:\t%u\n", j->cur_entry_sectors);
1467 prt_printf(out, "current entry error:\t%s\n", bch2_journal_errors[j->cur_entry_error]);
1468 prt_printf(out, "current entry:\t");
1470 switch (s.cur_entry_offset) {
1471 case JOURNAL_ENTRY_ERROR_VAL:
1472 prt_printf(out, "error\n");
1474 case JOURNAL_ENTRY_CLOSED_VAL:
1475 prt_printf(out, "closed\n");
1478 prt_printf(out, "%u/%u\n", s.cur_entry_offset, j->cur_entry_u64s);
1482 prt_printf(out, "unwritten entries:\n");
1483 bch2_journal_bufs_to_text(out, j);
1485 prt_printf(out, "space:\n");
1486 printbuf_indent_add(out, 2);
1487 prt_printf(out, "discarded\t%u:%u\n",
1488 j->space[journal_space_discarded].next_entry,
1489 j->space[journal_space_discarded].total);
1490 prt_printf(out, "clean ondisk\t%u:%u\n",
1491 j->space[journal_space_clean_ondisk].next_entry,
1492 j->space[journal_space_clean_ondisk].total);
1493 prt_printf(out, "clean\t%u:%u\n",
1494 j->space[journal_space_clean].next_entry,
1495 j->space[journal_space_clean].total);
1496 prt_printf(out, "total\t%u:%u\n",
1497 j->space[journal_space_total].next_entry,
1498 j->space[journal_space_total].total);
1499 printbuf_indent_sub(out, 2);
1501 for_each_member_device_rcu(c, ca, &c->rw_devs[BCH_DATA_journal]) {
1502 struct journal_device *ja = &ca->journal;
1504 if (!test_bit(ca->dev_idx, c->rw_devs[BCH_DATA_journal].d))
1510 prt_printf(out, "dev %u:\n", ca->dev_idx);
1511 printbuf_indent_add(out, 2);
1512 prt_printf(out, "nr\t%u\n", ja->nr);
1513 prt_printf(out, "bucket size\t%u\n", ca->mi.bucket_size);
1514 prt_printf(out, "available\t%u:%u\n", bch2_journal_dev_buckets_available(j, ja, journal_space_discarded), ja->sectors_free);
1515 prt_printf(out, "discard_idx\t%u\n", ja->discard_idx);
1516 prt_printf(out, "dirty_ondisk\t%u (seq %llu)\n",ja->dirty_idx_ondisk, ja->bucket_seq[ja->dirty_idx_ondisk]);
1517 prt_printf(out, "dirty_idx\t%u (seq %llu)\n", ja->dirty_idx, ja->bucket_seq[ja->dirty_idx]);
1518 prt_printf(out, "cur_idx\t%u (seq %llu)\n", ja->cur_idx, ja->bucket_seq[ja->cur_idx]);
1519 printbuf_indent_sub(out, 2);
1527 void bch2_journal_debug_to_text(struct printbuf *out, struct journal *j)
1529 spin_lock(&j->lock);
1530 __bch2_journal_debug_to_text(out, j);
1531 spin_unlock(&j->lock);
1534 bool bch2_journal_seq_pins_to_text(struct printbuf *out, struct journal *j, u64 *seq)
1536 struct journal_entry_pin_list *pin_list;
1537 struct journal_entry_pin *pin;
1539 spin_lock(&j->lock);
1540 if (!test_bit(JOURNAL_running, &j->flags)) {
1541 spin_unlock(&j->lock);
1545 *seq = max(*seq, j->pin.front);
1547 if (*seq >= j->pin.back) {
1548 spin_unlock(&j->lock);
1554 pin_list = journal_seq_pin(j, *seq);
1556 prt_printf(out, "%llu: count %u\n", *seq, atomic_read(&pin_list->count));
1557 printbuf_indent_add(out, 2);
1559 for (unsigned i = 0; i < ARRAY_SIZE(pin_list->list); i++)
1560 list_for_each_entry(pin, &pin_list->list[i], list)
1561 prt_printf(out, "\t%px %ps\n", pin, pin->flush);
1563 if (!list_empty(&pin_list->flushed))
1564 prt_printf(out, "flushed:\n");
1566 list_for_each_entry(pin, &pin_list->flushed, list)
1567 prt_printf(out, "\t%px %ps\n", pin, pin->flush);
1569 printbuf_indent_sub(out, 2);
1572 spin_unlock(&j->lock);
1577 void bch2_journal_pins_to_text(struct printbuf *out, struct journal *j)
1581 while (!bch2_journal_seq_pins_to_text(out, j, &seq))