blob: 0ecc2e0c8e98d3439c506e41634b841caf02acf3 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Stefan Roese9eefe2a2009-03-19 15:35:05 +01002/*
3 * This file is part of UBIFS.
4 *
5 * Copyright (C) 2006-2008 Nokia Corporation.
6 *
Stefan Roese9eefe2a2009-03-19 15:35:05 +01007 * Authors: Artem Bityutskiy (Битюцкий Артём)
8 * Adrian Hunter
9 */
10
11#ifndef __UBIFS_DEBUG_H__
12#define __UBIFS_DEBUG_H__
13
Heiko Schocherff94bc42014-06-24 10:10:04 +020014/* Checking helper functions */
15typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
16 struct ubifs_zbranch *zbr, void *priv);
17typedef int (*dbg_znode_callback)(struct ubifs_info *c,
18 struct ubifs_znode *znode, void *priv);
19
20/*
21 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
22 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
23 */
24#define UBIFS_DFS_DIR_NAME "ubi%d_%d"
25#define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
Stefan Roese9eefe2a2009-03-19 15:35:05 +010026
27/**
28 * ubifs_debug_info - per-FS debugging information.
Stefan Roese9eefe2a2009-03-19 15:35:05 +010029 * @old_zroot: old index root - used by 'dbg_check_old_index()'
30 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
31 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
Heiko Schocherff94bc42014-06-24 10:10:04 +020032 *
33 * @pc_happened: non-zero if an emulated power cut happened
34 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
35 * @pc_timeout: time in jiffies when delay of failure mode expires
36 * @pc_cnt: current number of calls to failure mode I/O functions
37 * @pc_cnt_max: number of calls by which to delay failure mode
38 *
Stefan Roese9eefe2a2009-03-19 15:35:05 +010039 * @chk_lpt_sz: used by LPT tree size checker
40 * @chk_lpt_sz2: used by LPT tree size checker
41 * @chk_lpt_wastage: used by LPT tree size checker
42 * @chk_lpt_lebs: used by LPT tree size checker
43 * @new_nhead_offs: used by LPT tree size checker
44 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
45 * @new_ihead_offs: used by debugging to check @c->ihead_offs
46 *
47 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
Heiko Schocherff94bc42014-06-24 10:10:04 +020048 * @saved_bi: saved budgeting information
49 * @saved_free: saved amount of free space
50 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
Stefan Roese9eefe2a2009-03-19 15:35:05 +010051 *
Heiko Schocherff94bc42014-06-24 10:10:04 +020052 * @chk_gen: if general extra checks are enabled
53 * @chk_index: if index xtra checks are enabled
54 * @chk_orph: if orphans extra checks are enabled
55 * @chk_lprops: if lprops extra checks are enabled
56 * @chk_fs: if UBIFS contents extra checks are enabled
57 * @tst_rcvry: if UBIFS recovery testing mode enabled
58 *
59 * @dfs_dir_name: name of debugfs directory containing this file-system's files
60 * @dfs_dir: direntry object of the file-system debugfs directory
61 * @dfs_dump_lprops: "dump lprops" debugfs knob
62 * @dfs_dump_budg: "dump budgeting information" debugfs knob
63 * @dfs_dump_tnc: "dump TNC" debugfs knob
64 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
65 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
66 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
67 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
68 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
69 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
70 * @dfs_ro_error: debugfs knob to switch UBIFS to R/O mode (different to
71 * re-mounting to R/O mode because it does not flush any buffers
72 * and UBIFS just starts returning -EROFS on all write
73 * operations)
Stefan Roese9eefe2a2009-03-19 15:35:05 +010074 */
75struct ubifs_debug_info {
Stefan Roese9eefe2a2009-03-19 15:35:05 +010076 struct ubifs_zbranch old_zroot;
77 int old_zroot_level;
78 unsigned long long old_zroot_sqnum;
Heiko Schocherff94bc42014-06-24 10:10:04 +020079
80 int pc_happened;
81 int pc_delay;
82 unsigned long pc_timeout;
83 unsigned int pc_cnt;
84 unsigned int pc_cnt_max;
85
Stefan Roese9eefe2a2009-03-19 15:35:05 +010086 long long chk_lpt_sz;
87 long long chk_lpt_sz2;
88 long long chk_lpt_wastage;
89 int chk_lpt_lebs;
90 int new_nhead_offs;
91 int new_ihead_lnum;
92 int new_ihead_offs;
93
94 struct ubifs_lp_stats saved_lst;
Heiko Schocherff94bc42014-06-24 10:10:04 +020095 struct ubifs_budg_info saved_bi;
Stefan Roese9eefe2a2009-03-19 15:35:05 +010096 long long saved_free;
Heiko Schocherff94bc42014-06-24 10:10:04 +020097 int saved_idx_gc_cnt;
Stefan Roese9eefe2a2009-03-19 15:35:05 +010098
Heiko Schocherff94bc42014-06-24 10:10:04 +020099 unsigned int chk_gen:1;
100 unsigned int chk_index:1;
101 unsigned int chk_orph:1;
102 unsigned int chk_lprops:1;
103 unsigned int chk_fs:1;
104 unsigned int tst_rcvry:1;
105
106 char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100107 struct dentry *dfs_dir;
108 struct dentry *dfs_dump_lprops;
109 struct dentry *dfs_dump_budg;
110 struct dentry *dfs_dump_tnc;
Heiko Schocherff94bc42014-06-24 10:10:04 +0200111 struct dentry *dfs_chk_gen;
112 struct dentry *dfs_chk_index;
113 struct dentry *dfs_chk_orph;
114 struct dentry *dfs_chk_lprops;
115 struct dentry *dfs_chk_fs;
116 struct dentry *dfs_tst_rcvry;
117 struct dentry *dfs_ro_error;
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100118};
119
Heiko Schocherff94bc42014-06-24 10:10:04 +0200120/**
121 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
122 *
123 * @chk_gen: if general extra checks are enabled
124 * @chk_index: if index xtra checks are enabled
125 * @chk_orph: if orphans extra checks are enabled
126 * @chk_lprops: if lprops extra checks are enabled
127 * @chk_fs: if UBIFS contents extra checks are enabled
128 * @tst_rcvry: if UBIFS recovery testing mode enabled
129 */
130struct ubifs_global_debug_info {
131 unsigned int chk_gen:1;
132 unsigned int chk_index:1;
133 unsigned int chk_orph:1;
134 unsigned int chk_lprops:1;
135 unsigned int chk_fs:1;
136 unsigned int tst_rcvry:1;
137};
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100138
Heiko Schocherff94bc42014-06-24 10:10:04 +0200139#ifndef __UBOOT__
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100140#define ubifs_assert(expr) do { \
141 if (unlikely(!(expr))) { \
Heiko Schocherff94bc42014-06-24 10:10:04 +0200142 pr_crit("UBIFS assert failed in %s at %u (pid %d)\n", \
143 __func__, __LINE__, current->pid); \
144 dump_stack(); \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100145 } \
146} while (0)
147
148#define ubifs_assert_cmt_locked(c) do { \
149 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
150 up_write(&(c)->commit_sem); \
Heiko Schocherff94bc42014-06-24 10:10:04 +0200151 pr_crit("commit lock is not locked!\n"); \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100152 ubifs_assert(0); \
153 } \
154} while (0)
155
Heiko Schocherff94bc42014-06-24 10:10:04 +0200156#define ubifs_dbg_msg(type, fmt, ...) \
157 pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid, \
158 ##__VA_ARGS__)
159
160#define DBG_KEY_BUF_LEN 48
161#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
162 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
163 pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid, \
164 ##__VA_ARGS__, \
165 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
166} while (0)
167#else
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100168
Pali Roháre2e6caa2022-07-10 13:38:07 +0200169#include <log.h>
170#define ubifs_assert(expr) assert(expr)
Pali Rohárb4f21052022-07-10 13:38:06 +0200171#define ubifs_assert_cmt_locked(c) do { } while (0)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100172
Heiko Schocherff94bc42014-06-24 10:10:04 +0200173#define ubifs_dbg_msg(type, fmt, ...) \
174 pr_debug("UBIFS DBG " type ": " fmt "\n", \
175 ##__VA_ARGS__)
176
177#define DBG_KEY_BUF_LEN 48
Heiko Schocherff94bc42014-06-24 10:10:04 +0200178#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
179 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
180 pr_debug("UBIFS DBG " type ": " fmt "%s\n", \
181 ##__VA_ARGS__, \
182 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
183} while (0)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100184
Heiko Schocherff94bc42014-06-24 10:10:04 +0200185#endif
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100186
187/* General messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200188#define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100189/* Additional journal messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200190#define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
191#define dbg_jnlk(key, fmt, ...) \
192 ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100193/* Additional TNC messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200194#define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
195#define dbg_tnck(key, fmt, ...) \
196 ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100197/* Additional lprops messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200198#define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100199/* Additional LEB find messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200200#define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100201/* Additional mount messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200202#define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
203#define dbg_mntk(key, fmt, ...) \
204 ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100205/* Additional I/O messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200206#define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100207/* Additional commit messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200208#define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100209/* Additional budgeting messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200210#define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100211/* Additional log messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200212#define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100213/* Additional gc messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200214#define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100215/* Additional scan messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200216#define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100217/* Additional recovery messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200218#define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100219
Heiko Schocherff94bc42014-06-24 10:10:04 +0200220#ifndef __UBOOT__
221extern struct ubifs_global_debug_info ubifs_dbg;
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100222
Heiko Schocherff94bc42014-06-24 10:10:04 +0200223static inline int dbg_is_chk_gen(const struct ubifs_info *c)
224{
225 return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
226}
227static inline int dbg_is_chk_index(const struct ubifs_info *c)
228{
229 return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
230}
231static inline int dbg_is_chk_orph(const struct ubifs_info *c)
232{
233 return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
234}
235static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
236{
237 return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
238}
239static inline int dbg_is_chk_fs(const struct ubifs_info *c)
240{
241 return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
242}
243static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
244{
245 return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
246}
247static inline int dbg_is_power_cut(const struct ubifs_info *c)
248{
249 return !!c->dbg->pc_happened;
250}
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100251
Heiko Schocherff94bc42014-06-24 10:10:04 +0200252int ubifs_debugging_init(struct ubifs_info *c);
253void ubifs_debugging_exit(struct ubifs_info *c);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100254#else
Heiko Schocherff94bc42014-06-24 10:10:04 +0200255static inline int dbg_is_chk_gen(const struct ubifs_info *c)
256{
257 return 0;
258}
259static inline int dbg_is_chk_index(const struct ubifs_info *c)
260{
261 return 0;
262}
263static inline int dbg_is_chk_orph(const struct ubifs_info *c)
264{
265 return 0;
266}
267static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
268{
269 return 0;
270}
271static inline int dbg_is_chk_fs(const struct ubifs_info *c)
272{
273 return 0;
274}
275static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
276{
277 return 0;
278}
279static inline int dbg_is_power_cut(const struct ubifs_info *c)
280{
281 return 0;
282}
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100283
284int ubifs_debugging_init(struct ubifs_info *c);
285void ubifs_debugging_exit(struct ubifs_info *c);
286
Heiko Schocherff94bc42014-06-24 10:10:04 +0200287#endif
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100288
Heiko Schocherff94bc42014-06-24 10:10:04 +0200289/* Dump functions */
290const char *dbg_ntype(int type);
291const char *dbg_cstate(int cmt_state);
292const char *dbg_jhead(int jhead);
293const char *dbg_get_key_dump(const struct ubifs_info *c,
294 const union ubifs_key *key);
295const char *dbg_snprintf_key(const struct ubifs_info *c,
296 const union ubifs_key *key, char *buffer, int len);
297void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode);
298void ubifs_dump_node(const struct ubifs_info *c, const void *node);
299void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
300void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
301void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
302void ubifs_dump_lprop(const struct ubifs_info *c,
303 const struct ubifs_lprops *lp);
304void ubifs_dump_lprops(struct ubifs_info *c);
305void ubifs_dump_lpt_info(struct ubifs_info *c);
306void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
307void ubifs_dump_sleb(const struct ubifs_info *c,
308 const struct ubifs_scan_leb *sleb, int offs);
309void ubifs_dump_znode(const struct ubifs_info *c,
310 const struct ubifs_znode *znode);
311void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap,
312 int cat);
313void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
314 struct ubifs_nnode *parent, int iip);
315void ubifs_dump_tnc(struct ubifs_info *c);
316void ubifs_dump_index(struct ubifs_info *c);
317void ubifs_dump_lpt_lebs(const struct ubifs_info *c);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100318
Heiko Schocherff94bc42014-06-24 10:10:04 +0200319int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
320 dbg_znode_callback znode_cb, void *priv);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100321
Heiko Schocherff94bc42014-06-24 10:10:04 +0200322/* Checking functions */
323void dbg_save_space_info(struct ubifs_info *c);
324int dbg_check_space_info(struct ubifs_info *c);
325int dbg_check_lprops(struct ubifs_info *c);
326int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
327int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
328int dbg_check_cats(struct ubifs_info *c);
329int dbg_check_ltab(struct ubifs_info *c);
330int dbg_chk_lpt_free_spc(struct ubifs_info *c);
331int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
332int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
333int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
334int dbg_check_tnc(struct ubifs_info *c, int extra);
335int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
336int dbg_check_filesystem(struct ubifs_info *c);
337void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
338 int add_pos);
339int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
340 int row, int col);
341int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
342 loff_t size);
343int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
344int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100345
Heiko Schocherff94bc42014-06-24 10:10:04 +0200346int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
347 int len);
348int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
349int dbg_leb_unmap(struct ubifs_info *c, int lnum);
350int dbg_leb_map(struct ubifs_info *c, int lnum);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100351
Heiko Schocherff94bc42014-06-24 10:10:04 +0200352/* Debugfs-related stuff */
353int dbg_debugfs_init(void);
354void dbg_debugfs_exit(void);
355int dbg_debugfs_init_fs(struct ubifs_info *c);
356void dbg_debugfs_exit_fs(struct ubifs_info *c);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100357
358#endif /* !__UBIFS_DEBUG_H__ */