8 #include "libbcachefs.h"
9 #include "tools-util.h"
11 #include "libbcachefs/bcachefs.h"
12 #include "libbcachefs/btree_iter.h"
13 #include "libbcachefs/errcode.h"
14 #include "libbcachefs/error.h"
15 #include "libbcachefs/journal_io.h"
16 #include "libbcachefs/journal_seq_blacklist.h"
17 #include "libbcachefs/super.h"
19 static const char *NORMAL = "\x1B[0m";
20 static const char *RED = "\x1B[31m";
22 static void list_journal_usage(void)
24 puts("bcachefs list_journal - print contents of journal\n"
25 "Usage: bcachefs list_journal [OPTION]... <devices>\n"
28 " -a Read entire journal, not just dirty entries\n"
29 " -n, --nr-entries=nr Number of journal entries to print, starting from the most recent\n"
30 " -t, --transaction-filter=bbpos Filter transactions not updating <bbpos>\n"
31 " Or entries not matching the range <bbpos-bbpos>\n"
32 " -k, --key-filter=btree Filter keys not updating btree\n"
33 " -v, --verbose Verbose mode\n"
34 " -h, --help Display this help and exit\n"
35 "Report bugs to <linux-bcachefs@vger.kernel.org>");
38 static void star_start_of_lines(char *buf)
45 while ((p = strstr(p, "\n ")))
49 static inline bool entry_is_transaction_start(struct jset_entry *entry)
51 return entry->type == BCH_JSET_ENTRY_log && !entry->level;
54 typedef DARRAY(struct bbpos_range) d_bbpos_range;
55 typedef DARRAY(enum btree_id) d_btree_id;
57 static bool bkey_matches_filter(d_bbpos_range filter, struct jset_entry *entry, struct bkey_i *k)
59 darray_for_each(filter, i) {
60 struct bbpos k_start = BBPOS(entry->btree_id, bkey_start_pos(&k->k));
61 struct bbpos k_end = BBPOS(entry->btree_id, k->k.p);
63 if (bbpos_cmp(k_start, i->end) < 0 &&
64 bbpos_cmp(k_end, i->start) > 0)
70 static bool entry_matches_transaction_filter(struct jset_entry *entry,
73 if (entry->type == BCH_JSET_ENTRY_btree_root ||
74 entry->type == BCH_JSET_ENTRY_btree_keys ||
75 entry->type == BCH_JSET_ENTRY_overwrite) {
78 jset_entry_for_each_key(entry, k)
79 if (bkey_matches_filter(filter, entry, k))
86 static bool should_print_transaction(struct jset_entry *entry, struct jset_entry *end,
92 for (entry = vstruct_next(entry);
93 entry != end && !entry_is_transaction_start(entry);
94 entry = vstruct_next(entry))
95 if (entry_matches_transaction_filter(entry, filter))
101 static bool should_print_entry(struct jset_entry *entry, d_btree_id filter)
108 if (entry->type != BCH_JSET_ENTRY_btree_root &&
109 entry->type != BCH_JSET_ENTRY_btree_keys &&
110 entry->type != BCH_JSET_ENTRY_overwrite)
113 jset_entry_for_each_key(entry, k)
114 darray_for_each(filter, id)
115 if (entry->btree_id == *id)
121 static void journal_entries_print(struct bch_fs *c, unsigned nr_entries,
122 d_bbpos_range transaction_filter,
123 d_btree_id key_filter)
125 struct journal_replay *p, **_p;
126 struct genradix_iter iter;
127 struct printbuf buf = PRINTBUF;
129 genradix_for_each(&c->journal_entries, iter, _p) {
134 if (le64_to_cpu(p->j.seq) + nr_entries < atomic64_read(&c->journal.seq))
137 bool blacklisted = p->ignore ||
138 bch2_journal_seq_is_blacklisted(c,
139 le64_to_cpu(p->j.seq), false);
141 if (!transaction_filter.nr) {
143 printf("blacklisted ");
145 printf("journal entry %llu\n", le64_to_cpu(p->j.seq));
147 printbuf_reset(&buf);
154 le32_to_cpu(p->j.version),
155 le64_to_cpu(p->j.last_seq),
156 !JSET_NO_FLUSH(&p->j));
157 bch2_journal_ptrs_to_text(&buf, c, p);
160 star_start_of_lines(buf.buf);
161 printf("%s\n", buf.buf);
162 printbuf_reset(&buf);
165 struct jset_entry *entry = p->j.start;
166 struct jset_entry *end = vstruct_last(&p->j);
167 while (entry != end) {
170 * log entries denote the start of a new transaction
173 if (entry_is_transaction_start(entry)) {
174 if (!should_print_transaction(entry, end, transaction_filter)) {
176 entry = vstruct_next(entry);
177 } while (entry != end && !entry_is_transaction_start(entry));
185 if (!should_print_entry(entry, key_filter))
188 bool highlight = entry_matches_transaction_filter(entry, transaction_filter);
192 printbuf_indent_add(&buf, 4);
193 bch2_journal_entry_to_text(&buf, c, entry);
196 star_start_of_lines(buf.buf);
197 printf("%s\n", buf.buf);
198 printbuf_reset(&buf);
201 fputs(NORMAL, stdout);
203 entry = vstruct_next(entry);
210 int cmd_list_journal(int argc, char *argv[])
212 static const struct option longopts[] = {
213 { "nr-entries", required_argument, NULL, 'n' },
214 { "transaction-filter", required_argument, NULL, 't' },
215 { "key-filter", required_argument, NULL, 'k' },
216 { "verbose", no_argument, NULL, 'v' },
217 { "help", no_argument, NULL, 'h' },
220 struct bch_opts opts = bch2_opts_empty();
221 u32 nr_entries = U32_MAX;
222 d_bbpos_range transaction_filter = { 0 };
223 d_btree_id key_filter = { 0 };
226 opt_set(opts, nochanges, true);
227 opt_set(opts, norecovery, true);
228 opt_set(opts, read_only, true);
229 opt_set(opts, degraded, true);
230 opt_set(opts, errors, BCH_ON_ERROR_continue);
231 opt_set(opts, fix_errors, FSCK_FIX_yes);
232 opt_set(opts, keep_journal, true);
233 opt_set(opts, read_journal_only,true);
235 while ((opt = getopt_long(argc, argv, "an:t:k:vh",
236 longopts, NULL)) != -1)
239 opt_set(opts, read_entire_journal, true);
242 if (kstrtouint(optarg, 10, &nr_entries))
243 die("error parsing nr_entries");
244 opt_set(opts, read_entire_journal, true);
247 darray_push(&transaction_filter, bbpos_range_parse(optarg));
250 darray_push(&key_filter, read_string_list_or_die(optarg, __bch2_btree_ids, "btree id"));
253 opt_set(opts, verbose, true);
256 list_journal_usage();
262 die("Please supply device(s) to open");
264 darray_str devs = get_or_split_cmdline_devs(argc, argv);
266 struct bch_fs *c = bch2_fs_open(devs.data, devs.nr, opts);
268 die("error opening %s: %s", argv[0], bch2_err_str(PTR_ERR(c)));
270 journal_entries_print(c, nr_entries, transaction_filter, key_filter);