1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23#ifndef __UBIFS_DEBUG_H__
24#define __UBIFS_DEBUG_H__
25
26
27typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
28 struct ubifs_zbranch *zbr, void *priv);
29typedef int (*dbg_znode_callback)(struct ubifs_info *c,
30 struct ubifs_znode *znode, void *priv);
31
32#ifdef CONFIG_UBIFS_FS_DEBUG
33
34
35
36
37
38#define UBIFS_DFS_DIR_NAME "ubi%d_%d"
39#define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85struct ubifs_debug_info {
86 struct ubifs_zbranch old_zroot;
87 int old_zroot_level;
88 unsigned long long old_zroot_sqnum;
89
90 int pc_happened;
91 int pc_delay;
92 unsigned long pc_timeout;
93 unsigned int pc_cnt;
94 unsigned int pc_cnt_max;
95
96 long long chk_lpt_sz;
97 long long chk_lpt_sz2;
98 long long chk_lpt_wastage;
99 int chk_lpt_lebs;
100 int new_nhead_offs;
101 int new_ihead_lnum;
102 int new_ihead_offs;
103
104 struct ubifs_lp_stats saved_lst;
105 struct ubifs_budg_info saved_bi;
106 long long saved_free;
107 int saved_idx_gc_cnt;
108
109 unsigned int chk_gen:1;
110 unsigned int chk_index:1;
111 unsigned int chk_orph:1;
112 unsigned int chk_lprops:1;
113 unsigned int chk_fs:1;
114 unsigned int tst_rcvry:1;
115
116 char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
117 struct dentry *dfs_dir;
118 struct dentry *dfs_dump_lprops;
119 struct dentry *dfs_dump_budg;
120 struct dentry *dfs_dump_tnc;
121 struct dentry *dfs_chk_gen;
122 struct dentry *dfs_chk_index;
123 struct dentry *dfs_chk_orph;
124 struct dentry *dfs_chk_lprops;
125 struct dentry *dfs_chk_fs;
126 struct dentry *dfs_tst_rcvry;
127};
128
129
130
131
132
133
134
135
136
137
138
139struct ubifs_global_debug_info {
140 unsigned int chk_gen:1;
141 unsigned int chk_index:1;
142 unsigned int chk_orph:1;
143 unsigned int chk_lprops:1;
144 unsigned int chk_fs:1;
145 unsigned int tst_rcvry:1;
146};
147
148#define ubifs_assert(expr) do { \
149 if (unlikely(!(expr))) { \
150 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
151 __func__, __LINE__, current->pid); \
152 dbg_dump_stack(); \
153 } \
154} while (0)
155
156#define ubifs_assert_cmt_locked(c) do { \
157 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
158 up_write(&(c)->commit_sem); \
159 printk(KERN_CRIT "commit lock is not locked!\n"); \
160 ubifs_assert(0); \
161 } \
162} while (0)
163
164#define dbg_dump_stack() dump_stack()
165
166#define dbg_err(fmt, ...) do { \
167 spin_lock(&dbg_lock); \
168 ubifs_err(fmt, ##__VA_ARGS__); \
169 spin_unlock(&dbg_lock); \
170} while (0)
171
172#define ubifs_dbg_msg(type, fmt, ...) \
173 pr_debug("UBIFS DBG " type ": " fmt "\n", ##__VA_ARGS__)
174
175#define DBG_KEY_BUF_LEN 32
176#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
177 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
178 pr_debug("UBIFS DBG " type ": " fmt "%s\n", ##__VA_ARGS__, \
179 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
180} while (0)
181
182
183#define dbg_msg(fmt, ...) \
184 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
185 __func__, ##__VA_ARGS__)
186
187
188#define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
189
190#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__)
193
194#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__)
197
198#define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
199
200#define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
201
202#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__)
205
206#define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
207
208#define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
209
210#define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
211
212#define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
213
214#define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
215
216#define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
217
218#define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
219
220extern spinlock_t dbg_lock;
221extern struct ubifs_global_debug_info ubifs_dbg;
222
223static 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}
251
252int ubifs_debugging_init(struct ubifs_info *c);
253void ubifs_debugging_exit(struct ubifs_info *c);
254
255
256const char *dbg_ntype(int type);
257const char *dbg_cstate(int cmt_state);
258const char *dbg_jhead(int jhead);
259const char *dbg_get_key_dump(const struct ubifs_info *c,
260 const union ubifs_key *key);
261const char *dbg_snprintf_key(const struct ubifs_info *c,
262 const union ubifs_key *key, char *buffer, int len);
263void dbg_dump_inode(struct ubifs_info *c, const struct inode *inode);
264void dbg_dump_node(const struct ubifs_info *c, const void *node);
265void dbg_dump_lpt_node(const struct ubifs_info *c, void *node, int lnum,
266 int offs);
267void dbg_dump_budget_req(const struct ubifs_budget_req *req);
268void dbg_dump_lstats(const struct ubifs_lp_stats *lst);
269void dbg_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
270void dbg_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp);
271void dbg_dump_lprops(struct ubifs_info *c);
272void dbg_dump_lpt_info(struct ubifs_info *c);
273void dbg_dump_leb(const struct ubifs_info *c, int lnum);
274void dbg_dump_sleb(const struct ubifs_info *c,
275 const struct ubifs_scan_leb *sleb, int offs);
276void dbg_dump_znode(const struct ubifs_info *c,
277 const struct ubifs_znode *znode);
278void dbg_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat);
279void dbg_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
280 struct ubifs_nnode *parent, int iip);
281void dbg_dump_tnc(struct ubifs_info *c);
282void dbg_dump_index(struct ubifs_info *c);
283void dbg_dump_lpt_lebs(const struct ubifs_info *c);
284
285int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
286 dbg_znode_callback znode_cb, void *priv);
287
288
289void dbg_save_space_info(struct ubifs_info *c);
290int dbg_check_space_info(struct ubifs_info *c);
291int dbg_check_lprops(struct ubifs_info *c);
292int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
293int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
294int dbg_check_cats(struct ubifs_info *c);
295int dbg_check_ltab(struct ubifs_info *c);
296int dbg_chk_lpt_free_spc(struct ubifs_info *c);
297int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
298int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
299int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
300int dbg_check_tnc(struct ubifs_info *c, int extra);
301int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
302int dbg_check_filesystem(struct ubifs_info *c);
303void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
304 int add_pos);
305int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
306 int row, int col);
307int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
308 loff_t size);
309int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
310int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
311
312int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
313 int len, int dtype);
314int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len,
315 int dtype);
316int dbg_leb_unmap(struct ubifs_info *c, int lnum);
317int dbg_leb_map(struct ubifs_info *c, int lnum, int dtype);
318
319
320int dbg_debugfs_init(void);
321void dbg_debugfs_exit(void);
322int dbg_debugfs_init_fs(struct ubifs_info *c);
323void dbg_debugfs_exit_fs(struct ubifs_info *c);
324
325#else
326
327
328#define ubifs_assert(expr) do { \
329 if (0) \
330 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
331 __func__, __LINE__, current->pid); \
332} while (0)
333
334#define dbg_err(fmt, ...) do { \
335 if (0) \
336 ubifs_err(fmt, ##__VA_ARGS__); \
337} while (0)
338
339#define DBGKEY(key) ((char *)(key))
340#define DBGKEY1(key) ((char *)(key))
341
342#define ubifs_dbg_msg(fmt, ...) do { \
343 if (0) \
344 printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \
345} while (0)
346
347#define dbg_dump_stack()
348#define ubifs_assert_cmt_locked(c)
349
350#define dbg_msg(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
351#define dbg_gen(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
352#define dbg_jnl(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
353#define dbg_jnlk(key, fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
354#define dbg_tnc(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
355#define dbg_tnck(key, fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
356#define dbg_lp(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
357#define dbg_find(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
358#define dbg_mnt(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
359#define dbg_mntk(key, fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
360#define dbg_io(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
361#define dbg_cmt(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
362#define dbg_budg(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
363#define dbg_log(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
364#define dbg_gc(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
365#define dbg_scan(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
366#define dbg_rcvry(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
367
368static inline int ubifs_debugging_init(struct ubifs_info *c) { return 0; }
369static inline void ubifs_debugging_exit(struct ubifs_info *c) { return; }
370static inline const char *dbg_ntype(int type) { return ""; }
371static inline const char *dbg_cstate(int cmt_state) { return ""; }
372static inline const char *dbg_jhead(int jhead) { return ""; }
373static inline const char *
374dbg_get_key_dump(const struct ubifs_info *c,
375 const union ubifs_key *key) { return ""; }
376static inline const char *
377dbg_snprintf_key(const struct ubifs_info *c,
378 const union ubifs_key *key, char *buffer,
379 int len) { return ""; }
380static inline void dbg_dump_inode(struct ubifs_info *c,
381 const struct inode *inode) { return; }
382static inline void dbg_dump_node(const struct ubifs_info *c,
383 const void *node) { return; }
384static inline void dbg_dump_lpt_node(const struct ubifs_info *c,
385 void *node, int lnum,
386 int offs) { return; }
387static inline void
388dbg_dump_budget_req(const struct ubifs_budget_req *req) { return; }
389static inline void
390dbg_dump_lstats(const struct ubifs_lp_stats *lst) { return; }
391static inline void
392dbg_dump_budg(struct ubifs_info *c,
393 const struct ubifs_budg_info *bi) { return; }
394static inline void dbg_dump_lprop(const struct ubifs_info *c,
395 const struct ubifs_lprops *lp) { return; }
396static inline void dbg_dump_lprops(struct ubifs_info *c) { return; }
397static inline void dbg_dump_lpt_info(struct ubifs_info *c) { return; }
398static inline void dbg_dump_leb(const struct ubifs_info *c,
399 int lnum) { return; }
400static inline void
401dbg_dump_sleb(const struct ubifs_info *c,
402 const struct ubifs_scan_leb *sleb, int offs) { return; }
403static inline void
404dbg_dump_znode(const struct ubifs_info *c,
405 const struct ubifs_znode *znode) { return; }
406static inline void dbg_dump_heap(struct ubifs_info *c,
407 struct ubifs_lpt_heap *heap,
408 int cat) { return; }
409static inline void dbg_dump_pnode(struct ubifs_info *c,
410 struct ubifs_pnode *pnode,
411 struct ubifs_nnode *parent,
412 int iip) { return; }
413static inline void dbg_dump_tnc(struct ubifs_info *c) { return; }
414static inline void dbg_dump_index(struct ubifs_info *c) { return; }
415static inline void dbg_dump_lpt_lebs(const struct ubifs_info *c) { return; }
416
417static inline int dbg_walk_index(struct ubifs_info *c,
418 dbg_leaf_callback leaf_cb,
419 dbg_znode_callback znode_cb,
420 void *priv) { return 0; }
421static inline void dbg_save_space_info(struct ubifs_info *c) { return; }
422static inline int dbg_check_space_info(struct ubifs_info *c) { return 0; }
423static inline int dbg_check_lprops(struct ubifs_info *c) { return 0; }
424static inline int
425dbg_old_index_check_init(struct ubifs_info *c,
426 struct ubifs_zbranch *zroot) { return 0; }
427static inline int
428dbg_check_old_index(struct ubifs_info *c,
429 struct ubifs_zbranch *zroot) { return 0; }
430static inline int dbg_check_cats(struct ubifs_info *c) { return 0; }
431static inline int dbg_check_ltab(struct ubifs_info *c) { return 0; }
432static inline int dbg_chk_lpt_free_spc(struct ubifs_info *c) { return 0; }
433static inline int dbg_chk_lpt_sz(struct ubifs_info *c,
434 int action, int len) { return 0; }
435static inline int
436dbg_check_synced_i_size(const struct ubifs_info *c,
437 struct inode *inode) { return 0; }
438static inline int dbg_check_dir(struct ubifs_info *c,
439 const struct inode *dir) { return 0; }
440static inline int dbg_check_tnc(struct ubifs_info *c, int extra) { return 0; }
441static inline int dbg_check_idx_size(struct ubifs_info *c,
442 long long idx_size) { return 0; }
443static inline int dbg_check_filesystem(struct ubifs_info *c) { return 0; }
444static inline void dbg_check_heap(struct ubifs_info *c,
445 struct ubifs_lpt_heap *heap,
446 int cat, int add_pos) { return; }
447static inline int dbg_check_lpt_nodes(struct ubifs_info *c,
448 struct ubifs_cnode *cnode, int row, int col) { return 0; }
449static inline int dbg_check_inode_size(struct ubifs_info *c,
450 const struct inode *inode,
451 loff_t size) { return 0; }
452static inline int
453dbg_check_data_nodes_order(struct ubifs_info *c,
454 struct list_head *head) { return 0; }
455static inline int
456dbg_check_nondata_nodes_order(struct ubifs_info *c,
457 struct list_head *head) { return 0; }
458
459static inline int dbg_leb_write(struct ubifs_info *c, int lnum,
460 const void *buf, int offset,
461 int len, int dtype) { return 0; }
462static inline int dbg_leb_change(struct ubifs_info *c, int lnum,
463 const void *buf, int len,
464 int dtype) { return 0; }
465static inline int dbg_leb_unmap(struct ubifs_info *c, int lnum) { return 0; }
466static inline int dbg_leb_map(struct ubifs_info *c, int lnum,
467 int dtype) { return 0; }
468
469static inline int dbg_is_chk_gen(const struct ubifs_info *c) { return 0; }
470static inline int dbg_is_chk_index(const struct ubifs_info *c) { return 0; }
471static inline int dbg_is_chk_orph(const struct ubifs_info *c) { return 0; }
472static inline int dbg_is_chk_lprops(const struct ubifs_info *c) { return 0; }
473static inline int dbg_is_chk_fs(const struct ubifs_info *c) { return 0; }
474static inline int dbg_is_tst_rcvry(const struct ubifs_info *c) { return 0; }
475static inline int dbg_is_power_cut(const struct ubifs_info *c) { return 0; }
476
477static inline int dbg_debugfs_init(void) { return 0; }
478static inline void dbg_debugfs_exit(void) { return; }
479static inline int dbg_debugfs_init_fs(struct ubifs_info *c) { return 0; }
480static inline int dbg_debugfs_exit_fs(struct ubifs_info *c) { return 0; }
481
482#endif
483#endif
484