1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_JOURNAL_TYPES_H
3 #define _BCACHEFS_JOURNAL_TYPES_H
5 #include <linux/cache.h>
6 #include <linux/workqueue.h>
8 #include "alloc_types.h"
9 #include "super_types.h"
15 * We put two of these in struct journal; we used them for writes to the
16 * journal that are being staged or in flight.
23 struct closure_waitlist wait;
25 unsigned buf_size; /* size in bytes of @data */
26 unsigned sectors; /* maximum size for current entry */
27 unsigned disk_sectors; /* maximum size entry could have been, if
28 buf_size was bigger */
29 unsigned u64s_reserved;
31 unsigned long has_inode[1024 / sizeof(unsigned long)];
35 * Something that makes a journal entry dirty - i.e. a btree node that has to be
39 struct journal_entry_pin_list {
40 struct list_head list;
41 struct list_head flushed;
43 struct bch_devs_list devs;
47 struct journal_entry_pin;
48 typedef void (*journal_pin_flush_fn)(struct journal *j,
49 struct journal_entry_pin *, u64);
51 struct journal_entry_pin {
52 struct list_head list;
53 journal_pin_flush_fn flush;
66 * For reserving space in the journal prior to getting a reservation on a
67 * particular journal entry:
69 struct journal_preres {
73 union journal_res_state {
83 u64 cur_entry_offset:20,
91 union journal_preres_state {
107 #define JOURNAL_ENTRY_SIZE_MIN (64U << 10) /* 64k */
108 #define JOURNAL_ENTRY_SIZE_MAX (4U << 20) /* 4M */
111 * We stash some journal state as sentinal values in cur_entry_offset:
112 * note - cur_entry_offset is in units of u64s
114 #define JOURNAL_ENTRY_OFFSET_MAX ((1U << 20) - 1)
116 #define JOURNAL_ENTRY_CLOSED_VAL (JOURNAL_ENTRY_OFFSET_MAX - 1)
117 #define JOURNAL_ENTRY_ERROR_VAL (JOURNAL_ENTRY_OFFSET_MAX)
120 * JOURNAL_NEED_WRITE - current (pending) journal entry should be written ASAP,
121 * either because something's waiting on the write to complete or because it's
122 * been dirty too long and the timer's expired.
130 JOURNAL_MAY_GET_UNRESERVED,
133 /* Embedded in struct bch_fs */
135 /* Fastpath stuff up front: */
139 union journal_res_state reservations;
141 /* Max size of current journal entry */
142 unsigned cur_entry_u64s;
143 unsigned cur_entry_sectors;
146 * 0, or -ENOSPC if waiting on journal reclaim, or -EROFS if
147 * insufficient devices:
151 union journal_preres_state prereserved;
153 /* Reserved space in journal entry to be used just prior to write */
154 unsigned entry_u64s_reserved;
156 unsigned buf_size_want;
159 * Two journal entries -- one is currently open for new entries, the
160 * other is possibly being written out.
162 struct journal_buf buf[2];
166 /* if nonzero, we may not open a new journal entry: */
169 /* Used when waiting because the journal was full */
170 wait_queue_head_t wait;
171 struct closure_waitlist async_wait;
172 struct closure_waitlist preres_wait;
175 struct delayed_work write_work;
177 /* Sequence number of most recent journal entry (last entry in @pin) */
180 /* seq, last_seq from the most recent journal entry successfully written */
185 * FIFO of journal entries whose btree updates have not yet been
188 * Each entry is a reference count. The position in the FIFO is the
189 * entry's sequence number relative to @seq.
191 * The journal entry itself holds a reference count, put when the
192 * journal entry is written out. Each btree node modified by the journal
193 * entry also holds a reference count, put when the btree node is
196 * When a reference count reaches zero, the journal entry is no longer
197 * needed. When all journal entries in the oldest journal bucket are no
198 * longer needed, the bucket can be discarded and reused.
201 u64 front, back, size, mask;
202 struct journal_entry_pin_list *data;
205 u64 replay_journal_seq;
206 u64 replay_journal_seq_end;
208 struct write_point wp;
211 struct delayed_work reclaim_work;
212 struct mutex reclaim_lock;
213 unsigned long last_flushed;
214 struct journal_entry_pin *flush_in_progress;
215 wait_queue_head_t pin_flush_wait;
217 /* protects advancing ja->discard_idx: */
218 struct mutex discard_lock;
221 unsigned write_delay_ms;
222 unsigned reclaim_delay_ms;
224 u64 res_get_blocked_start;
226 u64 write_start_time;
228 struct time_stats *write_time;
229 struct time_stats *delay_time;
230 struct time_stats *blocked_time;
231 struct time_stats *flush_seq_time;
233 #ifdef CONFIG_DEBUG_LOCK_ALLOC
234 struct lockdep_map res_map;
239 * Embedded in struct bch_dev. First three fields refer to the array of journal
240 * buckets, in bch_sb.
242 struct journal_device {
244 * For each journal bucket, contains the max sequence number of the
245 * journal writes it contains - so we know when a bucket can be reused.
249 unsigned sectors_free;
252 * discard_idx <= dirty_idx_ondisk <= dirty_idx <= cur_idx:
254 unsigned discard_idx; /* Next bucket to discard */
255 unsigned dirty_idx_ondisk;
257 unsigned cur_idx; /* Journal bucket we're currently writing to */
262 /* Bio for journal reads/writes to this device */
265 /* for bch_journal_read_device */
270 * journal_entry_res - reserve space in every journal entry:
272 struct journal_entry_res {
276 #endif /* _BCACHEFS_JOURNAL_TYPES_H */