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 " -k, --key-filter=btree Filter keys not updating btree\n"
32 " -v, --verbose Verbose mode\n"
33 " -h, --help Display this help and exit\n"
34 "Report bugs to <linux-bcachefs@vger.kernel.org>");
37 static void star_start_of_lines(char *buf)
44 while ((p = strstr(p, "\n ")))
48 static inline bool entry_is_transaction_start(struct jset_entry *entry)
50 return entry->type == BCH_JSET_ENTRY_log && !entry->level;
53 typedef DARRAY(struct bbpos) d_bbpos;
54 typedef DARRAY(enum btree_id) d_btree_id;
56 static bool bkey_matches_filter(d_bbpos filter, struct jset_entry *entry, struct bkey_i *k)
60 darray_for_each(filter, i) {
61 if (i->btree != entry->btree_id)
64 if (bkey_eq(i->pos, k->k.p))
67 if (btree_node_type_is_extents(i->btree) &&
68 bkey_ge(i->pos, bkey_start_pos(&k->k)) &&
69 bkey_lt(i->pos, k->k.p))
75 static bool entry_matches_transaction_filter(struct jset_entry *entry,
78 if (entry->type == BCH_JSET_ENTRY_btree_root ||
79 entry->type == BCH_JSET_ENTRY_btree_keys ||
80 entry->type == BCH_JSET_ENTRY_overwrite) {
83 jset_entry_for_each_key(entry, k)
84 if (bkey_matches_filter(filter, entry, k))
91 static bool should_print_transaction(struct jset_entry *entry, struct jset_entry *end,
97 for (entry = vstruct_next(entry);
98 entry != end && !entry_is_transaction_start(entry);
99 entry = vstruct_next(entry))
100 if (entry_matches_transaction_filter(entry, filter))
106 static bool should_print_entry(struct jset_entry *entry, d_btree_id filter)
114 if (entry->type != BCH_JSET_ENTRY_btree_root &&
115 entry->type != BCH_JSET_ENTRY_btree_keys &&
116 entry->type != BCH_JSET_ENTRY_overwrite)
119 jset_entry_for_each_key(entry, k)
120 darray_for_each(filter, id)
121 if (entry->btree_id == *id)
127 static void journal_entries_print(struct bch_fs *c, unsigned nr_entries,
128 d_bbpos transaction_filter,
129 d_btree_id key_filter)
131 struct journal_replay *p, **_p;
132 struct genradix_iter iter;
133 struct printbuf buf = PRINTBUF;
135 genradix_for_each(&c->journal_entries, iter, _p) {
140 if (le64_to_cpu(p->j.seq) + nr_entries < atomic64_read(&c->journal.seq))
144 bch2_journal_seq_is_blacklisted(c,
145 le64_to_cpu(p->j.seq), false);
147 if (!transaction_filter.nr) {
149 printf("blacklisted ");
151 printf("journal entry %llu\n", le64_to_cpu(p->j.seq));
153 printbuf_reset(&buf);
160 le32_to_cpu(p->j.version),
161 le64_to_cpu(p->j.last_seq),
162 !JSET_NO_FLUSH(&p->j));
163 bch2_journal_ptrs_to_text(&buf, c, p);
166 star_start_of_lines(buf.buf);
167 printf("%s\n", buf.buf);
168 printbuf_reset(&buf);
171 struct jset_entry *entry = p->j.start;
172 struct jset_entry *end = vstruct_last(&p->j);
173 while (entry != end) {
176 * log entries denote the start of a new transaction
179 if (entry_is_transaction_start(entry)) {
180 if (!should_print_transaction(entry, end, transaction_filter)) {
182 entry = vstruct_next(entry);
183 } while (entry != end && !entry_is_transaction_start(entry));
191 if (!should_print_entry(entry, key_filter))
194 bool highlight = entry_matches_transaction_filter(entry, transaction_filter);
198 printbuf_indent_add(&buf, 4);
199 bch2_journal_entry_to_text(&buf, c, entry);
202 star_start_of_lines(buf.buf);
203 printf("%s\n", buf.buf);
204 printbuf_reset(&buf);
207 fputs(NORMAL, stdout);
209 entry = vstruct_next(entry);
216 int cmd_list_journal(int argc, char *argv[])
218 static const struct option longopts[] = {
219 { "nr-entries", required_argument, NULL, 'n' },
220 { "transaction-filter", required_argument, NULL, 't' },
221 { "key-filter", required_argument, NULL, 'k' },
222 { "verbose", no_argument, NULL, 'v' },
223 { "help", no_argument, NULL, 'h' },
226 struct bch_opts opts = bch2_opts_empty();
227 u32 nr_entries = U32_MAX;
228 d_bbpos transaction_filter = { 0 };
229 d_btree_id key_filter = { 0 };
232 opt_set(opts, nochanges, true);
233 opt_set(opts, norecovery, true);
234 opt_set(opts, degraded, true);
235 opt_set(opts, errors, BCH_ON_ERROR_continue);
236 opt_set(opts, fix_errors, FSCK_FIX_yes);
237 opt_set(opts, keep_journal, true);
238 opt_set(opts, read_journal_only,true);
240 while ((opt = getopt_long(argc, argv, "an:t:k:vh",
241 longopts, NULL)) != -1)
244 opt_set(opts, read_entire_journal, true);
247 if (kstrtouint(optarg, 10, &nr_entries))
248 die("error parsing nr_entries");
249 opt_set(opts, read_entire_journal, true);
252 darray_push(&transaction_filter, bbpos_parse(optarg));
255 darray_push(&key_filter, read_string_list_or_die(optarg, __bch2_btree_ids, "btree id"));
258 opt_set(opts, verbose, true);
261 list_journal_usage();
267 die("Please supply device(s) to open");
269 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
271 die("error opening %s: %s", argv[0], bch2_err_str(PTR_ERR(c)));
273 journal_entries_print(c, nr_entries, transaction_filter, key_filter);