1 #ifndef _BCACHEFS_JOURNAL_TYPES_H
2 #define _BCACHEFS_JOURNAL_TYPES_H
4 #include <linux/cache.h>
5 #include <linux/workqueue.h>
7 #include "alloc_types.h"
8 #include "super_types.h"
14 * We put two of these in struct journal; we used them for writes to the
15 * journal that are being staged or in flight.
22 struct closure_waitlist wait;
25 unsigned disk_sectors;
27 unsigned long has_inode[1024 / sizeof(unsigned long)];
31 * Something that makes a journal entry dirty - i.e. a btree node that has to be
35 struct journal_entry_pin_list {
36 struct list_head list;
37 struct list_head flushed;
39 struct bch_devs_list devs;
43 struct journal_entry_pin;
44 typedef void (*journal_pin_flush_fn)(struct journal *j,
45 struct journal_entry_pin *, u64);
47 struct journal_entry_pin {
48 struct list_head list;
49 journal_pin_flush_fn flush;
50 struct journal_entry_pin_list *pin_list;
53 /* corresponds to a btree node with a blacklisted bset: */
54 struct blacklisted_node {
56 enum btree_id btree_id;
60 struct journal_seq_blacklist {
61 struct list_head list;
64 struct journal_entry_pin pin;
66 struct blacklisted_node *entries;
78 union journal_res_state {
88 u64 cur_entry_offset:20,
97 #define JOURNAL_ENTRY_SIZE_MIN (64U << 10) /* 64k */
98 #define JOURNAL_ENTRY_SIZE_MAX (4U << 20) /* 4M */
101 * We stash some journal state as sentinal values in cur_entry_offset:
102 * note - cur_entry_offset is in units of u64s
104 #define JOURNAL_ENTRY_OFFSET_MAX ((1U << 20) - 1)
106 #define JOURNAL_ENTRY_CLOSED_VAL (JOURNAL_ENTRY_OFFSET_MAX - 1)
107 #define JOURNAL_ENTRY_ERROR_VAL (JOURNAL_ENTRY_OFFSET_MAX)
110 * JOURNAL_NEED_WRITE - current (pending) journal entry should be written ASAP,
111 * either because something's waiting on the write to complete or because it's
112 * been dirty too long and the timer's expired.
121 /* Embedded in struct bch_fs */
123 /* Fastpath stuff up front: */
127 union journal_res_state reservations;
128 unsigned cur_entry_u64s;
129 unsigned prev_buf_sectors;
130 unsigned cur_buf_sectors;
131 unsigned buf_size_want;
134 * Two journal entries -- one is currently open for new entries, the
135 * other is possibly being written out.
137 struct journal_buf buf[2];
141 /* Used when waiting because the journal was full */
142 wait_queue_head_t wait;
145 struct delayed_work write_work;
147 /* Sequence number of most recent journal entry (last entry in @pin) */
150 /* last_seq from the most recent journal entry written */
154 * FIFO of journal entries whose btree updates have not yet been
157 * Each entry is a reference count. The position in the FIFO is the
158 * entry's sequence number relative to @seq.
160 * The journal entry itself holds a reference count, put when the
161 * journal entry is written out. Each btree node modified by the journal
162 * entry also holds a reference count, put when the btree node is
165 * When a reference count reaches zero, the journal entry is no longer
166 * needed. When all journal entries in the oldest journal bucket are no
167 * longer needed, the bucket can be discarded and reused.
169 DECLARE_FIFO(struct journal_entry_pin_list, pin);
170 struct journal_entry_pin_list *replay_pin_list;
172 struct mutex blacklist_lock;
173 struct list_head seq_blacklist;
176 struct write_point wp;
179 struct delayed_work reclaim_work;
180 unsigned long last_flushed;
182 /* protects advancing ja->last_idx: */
183 struct mutex reclaim_lock;
184 unsigned write_delay_ms;
185 unsigned reclaim_delay_ms;
187 u64 res_get_blocked_start;
189 u64 write_start_time;
191 struct time_stats *write_time;
192 struct time_stats *delay_time;
193 struct time_stats *blocked_time;
194 struct time_stats *flush_seq_time;
196 #ifdef CONFIG_DEBUG_LOCK_ALLOC
197 struct lockdep_map res_map;
202 * Embedded in struct bch_dev. First three fields refer to the array of journal
203 * buckets, in bch_sb.
205 struct journal_device {
207 * For each journal bucket, contains the max sequence number of the
208 * journal writes it contains - so we know when a bucket can be reused.
212 unsigned sectors_free;
214 /* Journal bucket we're currently writing to */
217 /* Last journal bucket that still contains an open journal entry */
220 * j->lock and j->reclaim_lock must both be held to modify, j->lock
221 * sufficient to read:
227 /* Bio for journal reads/writes to this device */
230 /* for bch_journal_read_device */
234 #endif /* _BCACHEFS_JOURNAL_TYPES_H */