2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Artem Bityutskiy (Битюцкий Артём)
23 #ifndef __UBIFS_DEBUG_H__
24 #define __UBIFS_DEBUG_H__
26 /* Checking helper functions */
27 typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
28 struct ubifs_zbranch *zbr, void *priv);
29 typedef int (*dbg_znode_callback)(struct ubifs_info *c,
30 struct ubifs_znode *znode, void *priv);
32 #ifdef CONFIG_UBIFS_FS_DEBUG
35 * ubifs_debug_info - per-FS debugging information.
36 * @old_zroot: old index root - used by 'dbg_check_old_index()'
37 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
38 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
39 * @failure_mode: failure mode for recovery testing
40 * @fail_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
41 * @fail_timeout: time in jiffies when delay of failure mode expires
42 * @fail_cnt: current number of calls to failure mode I/O functions
43 * @fail_cnt_max: number of calls by which to delay failure mode
44 * @chk_lpt_sz: used by LPT tree size checker
45 * @chk_lpt_sz2: used by LPT tree size checker
46 * @chk_lpt_wastage: used by LPT tree size checker
47 * @chk_lpt_lebs: used by LPT tree size checker
48 * @new_nhead_offs: used by LPT tree size checker
49 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
50 * @new_ihead_offs: used by debugging to check @c->ihead_offs
52 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
53 * @saved_bi: saved budgeting information
54 * @saved_free: saved amount of free space
55 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
57 * dfs_dir_name: name of debugfs directory containing this file-system's files
58 * dfs_dir: direntry object of the file-system debugfs directory
59 * dfs_dump_lprops: "dump lprops" debugfs knob
60 * dfs_dump_budg: "dump budgeting information" debugfs knob
61 * dfs_dump_tnc: "dump TNC" debugfs knob
63 struct ubifs_debug_info {
64 struct ubifs_zbranch old_zroot;
66 unsigned long long old_zroot_sqnum;
69 unsigned long fail_timeout;
70 unsigned int fail_cnt;
71 unsigned int fail_cnt_max;
73 long long chk_lpt_sz2;
74 long long chk_lpt_wastage;
80 struct ubifs_lp_stats saved_lst;
81 struct ubifs_budg_info saved_bi;
85 char dfs_dir_name[100];
86 struct dentry *dfs_dir;
87 struct dentry *dfs_dump_lprops;
88 struct dentry *dfs_dump_budg;
89 struct dentry *dfs_dump_tnc;
92 #define ubifs_assert(expr) do { \
93 if (unlikely(!(expr))) { \
94 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
95 __func__, __LINE__, current->pid); \
100 #define ubifs_assert_cmt_locked(c) do { \
101 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
102 up_write(&(c)->commit_sem); \
103 printk(KERN_CRIT "commit lock is not locked!\n"); \
108 #define dbg_dump_stack() do { \
109 if (!dbg_failure_mode) \
113 /* Generic debugging messages */
114 #define dbg_msg(fmt, ...) do { \
115 spin_lock(&dbg_lock); \
116 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
117 __func__, ##__VA_ARGS__); \
118 spin_unlock(&dbg_lock); \
121 #define dbg_do_msg(typ, fmt, ...) do { \
122 if (ubifs_msg_flags & typ) \
123 dbg_msg(fmt, ##__VA_ARGS__); \
126 #define dbg_err(fmt, ...) do { \
127 spin_lock(&dbg_lock); \
128 ubifs_err(fmt, ##__VA_ARGS__); \
129 spin_unlock(&dbg_lock); \
132 const char *dbg_key_str0(const struct ubifs_info *c,
133 const union ubifs_key *key);
134 const char *dbg_key_str1(const struct ubifs_info *c,
135 const union ubifs_key *key);
138 * DBGKEY macros require @dbg_lock to be held, which it is in the dbg message
141 #define DBGKEY(key) dbg_key_str0(c, (key))
142 #define DBGKEY1(key) dbg_key_str1(c, (key))
144 /* General messages */
145 #define dbg_gen(fmt, ...) dbg_do_msg(UBIFS_MSG_GEN, fmt, ##__VA_ARGS__)
147 /* Additional journal messages */
148 #define dbg_jnl(fmt, ...) dbg_do_msg(UBIFS_MSG_JNL, fmt, ##__VA_ARGS__)
150 /* Additional TNC messages */
151 #define dbg_tnc(fmt, ...) dbg_do_msg(UBIFS_MSG_TNC, fmt, ##__VA_ARGS__)
153 /* Additional lprops messages */
154 #define dbg_lp(fmt, ...) dbg_do_msg(UBIFS_MSG_LP, fmt, ##__VA_ARGS__)
156 /* Additional LEB find messages */
157 #define dbg_find(fmt, ...) dbg_do_msg(UBIFS_MSG_FIND, fmt, ##__VA_ARGS__)
159 /* Additional mount messages */
160 #define dbg_mnt(fmt, ...) dbg_do_msg(UBIFS_MSG_MNT, fmt, ##__VA_ARGS__)
162 /* Additional I/O messages */
163 #define dbg_io(fmt, ...) dbg_do_msg(UBIFS_MSG_IO, fmt, ##__VA_ARGS__)
165 /* Additional commit messages */
166 #define dbg_cmt(fmt, ...) dbg_do_msg(UBIFS_MSG_CMT, fmt, ##__VA_ARGS__)
168 /* Additional budgeting messages */
169 #define dbg_budg(fmt, ...) dbg_do_msg(UBIFS_MSG_BUDG, fmt, ##__VA_ARGS__)
171 /* Additional log messages */
172 #define dbg_log(fmt, ...) dbg_do_msg(UBIFS_MSG_LOG, fmt, ##__VA_ARGS__)
174 /* Additional gc messages */
175 #define dbg_gc(fmt, ...) dbg_do_msg(UBIFS_MSG_GC, fmt, ##__VA_ARGS__)
177 /* Additional scan messages */
178 #define dbg_scan(fmt, ...) dbg_do_msg(UBIFS_MSG_SCAN, fmt, ##__VA_ARGS__)
180 /* Additional recovery messages */
181 #define dbg_rcvry(fmt, ...) dbg_do_msg(UBIFS_MSG_RCVRY, fmt, ##__VA_ARGS__)
184 * Debugging message type flags.
186 * UBIFS_MSG_GEN: general messages
187 * UBIFS_MSG_JNL: journal messages
188 * UBIFS_MSG_MNT: mount messages
189 * UBIFS_MSG_CMT: commit messages
190 * UBIFS_MSG_FIND: LEB find messages
191 * UBIFS_MSG_BUDG: budgeting messages
192 * UBIFS_MSG_GC: garbage collection messages
193 * UBIFS_MSG_TNC: TNC messages
194 * UBIFS_MSG_LP: lprops messages
195 * UBIFS_MSG_IO: I/O messages
196 * UBIFS_MSG_LOG: log messages
197 * UBIFS_MSG_SCAN: scan messages
198 * UBIFS_MSG_RCVRY: recovery messages
205 UBIFS_MSG_FIND = 0x10,
206 UBIFS_MSG_BUDG = 0x20,
208 UBIFS_MSG_TNC = 0x80,
209 UBIFS_MSG_LP = 0x100,
210 UBIFS_MSG_IO = 0x200,
211 UBIFS_MSG_LOG = 0x400,
212 UBIFS_MSG_SCAN = 0x800,
213 UBIFS_MSG_RCVRY = 0x1000,
217 * Debugging check flags.
219 * UBIFS_CHK_GEN: general checks
220 * UBIFS_CHK_TNC: check TNC
221 * UBIFS_CHK_IDX_SZ: check index size
222 * UBIFS_CHK_ORPH: check orphans
223 * UBIFS_CHK_OLD_IDX: check the old index
224 * UBIFS_CHK_LPROPS: check lprops
225 * UBIFS_CHK_FS: check the file-system
230 UBIFS_CHK_IDX_SZ = 0x4,
231 UBIFS_CHK_ORPH = 0x8,
232 UBIFS_CHK_OLD_IDX = 0x10,
233 UBIFS_CHK_LPROPS = 0x20,
238 * Special testing flags.
240 * UBIFS_TST_FORCE_IN_THE_GAPS: force the use of in-the-gaps method
241 * UBIFS_TST_RCVRY: failure mode for recovery testing
244 UBIFS_TST_FORCE_IN_THE_GAPS = 0x2,
245 UBIFS_TST_RCVRY = 0x4,
248 extern spinlock_t dbg_lock;
250 extern unsigned int ubifs_msg_flags;
251 extern unsigned int ubifs_chk_flags;
252 extern unsigned int ubifs_tst_flags;
254 int ubifs_debugging_init(struct ubifs_info *c);
255 void ubifs_debugging_exit(struct ubifs_info *c);
258 const char *dbg_ntype(int type);
259 const char *dbg_cstate(int cmt_state);
260 const char *dbg_jhead(int jhead);
261 const char *dbg_get_key_dump(const struct ubifs_info *c,
262 const union ubifs_key *key);
263 void dbg_dump_inode(const struct ubifs_info *c, const struct inode *inode);
264 void dbg_dump_node(const struct ubifs_info *c, const void *node);
265 void dbg_dump_lpt_node(const struct ubifs_info *c, void *node, int lnum,
267 void dbg_dump_budget_req(const struct ubifs_budget_req *req);
268 void dbg_dump_lstats(const struct ubifs_lp_stats *lst);
269 void dbg_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
270 void dbg_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp);
271 void dbg_dump_lprops(struct ubifs_info *c);
272 void dbg_dump_lpt_info(struct ubifs_info *c);
273 void dbg_dump_leb(const struct ubifs_info *c, int lnum);
274 void dbg_dump_znode(const struct ubifs_info *c,
275 const struct ubifs_znode *znode);
276 void dbg_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat);
277 void dbg_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
278 struct ubifs_nnode *parent, int iip);
279 void dbg_dump_tnc(struct ubifs_info *c);
280 void dbg_dump_index(struct ubifs_info *c);
281 void dbg_dump_lpt_lebs(const struct ubifs_info *c);
283 int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
284 dbg_znode_callback znode_cb, void *priv);
286 /* Checking functions */
287 void dbg_save_space_info(struct ubifs_info *c);
288 int dbg_check_space_info(struct ubifs_info *c);
289 int dbg_check_lprops(struct ubifs_info *c);
290 int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
291 int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
292 int dbg_check_cats(struct ubifs_info *c);
293 int dbg_check_ltab(struct ubifs_info *c);
294 int dbg_chk_lpt_free_spc(struct ubifs_info *c);
295 int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
296 int dbg_check_synced_i_size(struct inode *inode);
297 int dbg_check_dir_size(struct ubifs_info *c, const struct inode *dir);
298 int dbg_check_tnc(struct ubifs_info *c, int extra);
299 int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
300 int dbg_check_filesystem(struct ubifs_info *c);
301 void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
303 int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
305 int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
307 int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
308 int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
310 /* Force the use of in-the-gaps method for testing */
312 #define dbg_force_in_the_gaps_enabled \
313 (ubifs_tst_flags & UBIFS_TST_FORCE_IN_THE_GAPS)
315 int dbg_force_in_the_gaps(void);
317 /* Failure mode for recovery testing */
319 #define dbg_failure_mode (ubifs_tst_flags & UBIFS_TST_RCVRY)
321 #ifndef UBIFS_DBG_PRESERVE_UBI
323 #define ubi_leb_read dbg_leb_read
324 #define ubi_leb_write dbg_leb_write
325 #define ubi_leb_change dbg_leb_change
326 #define ubi_leb_erase dbg_leb_erase
327 #define ubi_leb_unmap dbg_leb_unmap
328 #define ubi_is_mapped dbg_is_mapped
329 #define ubi_leb_map dbg_leb_map
333 int dbg_leb_read(struct ubi_volume_desc *desc, int lnum, char *buf, int offset,
335 int dbg_leb_write(struct ubi_volume_desc *desc, int lnum, const void *buf,
336 int offset, int len, int dtype);
337 int dbg_leb_change(struct ubi_volume_desc *desc, int lnum, const void *buf,
339 int dbg_leb_erase(struct ubi_volume_desc *desc, int lnum);
340 int dbg_leb_unmap(struct ubi_volume_desc *desc, int lnum);
341 int dbg_is_mapped(struct ubi_volume_desc *desc, int lnum);
342 int dbg_leb_map(struct ubi_volume_desc *desc, int lnum, int dtype);
344 static inline int dbg_read(struct ubi_volume_desc *desc, int lnum, char *buf,
347 return dbg_leb_read(desc, lnum, buf, offset, len, 0);
350 static inline int dbg_write(struct ubi_volume_desc *desc, int lnum,
351 const void *buf, int offset, int len)
353 return dbg_leb_write(desc, lnum, buf, offset, len, UBI_UNKNOWN);
356 static inline int dbg_change(struct ubi_volume_desc *desc, int lnum,
357 const void *buf, int len)
359 return dbg_leb_change(desc, lnum, buf, len, UBI_UNKNOWN);
362 /* Debugfs-related stuff */
363 int dbg_debugfs_init(void);
364 void dbg_debugfs_exit(void);
365 int dbg_debugfs_init_fs(struct ubifs_info *c);
366 void dbg_debugfs_exit_fs(struct ubifs_info *c);
368 #else /* !CONFIG_UBIFS_FS_DEBUG */
370 /* Use "if (0)" to make compiler check arguments even if debugging is off */
371 #define ubifs_assert(expr) do { \
373 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
374 __func__, __LINE__, current->pid); \
377 #define dbg_err(fmt, ...) do { \
379 ubifs_err(fmt, ##__VA_ARGS__); \
382 #define dbg_msg(fmt, ...) do { \
384 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", \
385 current->pid, __func__, ##__VA_ARGS__); \
388 #define dbg_dump_stack()
389 #define ubifs_assert_cmt_locked(c)
391 #define dbg_gen(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
392 #define dbg_jnl(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
393 #define dbg_tnc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
394 #define dbg_lp(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
395 #define dbg_find(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
396 #define dbg_mnt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
397 #define dbg_io(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
398 #define dbg_cmt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
399 #define dbg_budg(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
400 #define dbg_log(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
401 #define dbg_gc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
402 #define dbg_scan(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
403 #define dbg_rcvry(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
405 #define DBGKEY(key) ((char *)(key))
406 #define DBGKEY1(key) ((char *)(key))
408 static inline int ubifs_debugging_init(struct ubifs_info *c) { return 0; }
409 static inline void ubifs_debugging_exit(struct ubifs_info *c) { return; }
410 static inline const char *dbg_ntype(int type) { return ""; }
411 static inline const char *dbg_cstate(int cmt_state) { return ""; }
412 static inline const char *dbg_jhead(int jhead) { return ""; }
413 static inline const char *
414 dbg_get_key_dump(const struct ubifs_info *c,
415 const union ubifs_key *key) { return ""; }
416 static inline void dbg_dump_inode(const struct ubifs_info *c,
417 const struct inode *inode) { return; }
418 static inline void dbg_dump_node(const struct ubifs_info *c,
419 const void *node) { return; }
420 static inline void dbg_dump_lpt_node(const struct ubifs_info *c,
421 void *node, int lnum,
422 int offs) { return; }
424 dbg_dump_budget_req(const struct ubifs_budget_req *req) { return; }
426 dbg_dump_lstats(const struct ubifs_lp_stats *lst) { return; }
428 dbg_dump_budg(struct ubifs_info *c,
429 const struct ubifs_budg_info *bi) { return; }
430 static inline void dbg_dump_lprop(const struct ubifs_info *c,
431 const struct ubifs_lprops *lp) { return; }
432 static inline void dbg_dump_lprops(struct ubifs_info *c) { return; }
433 static inline void dbg_dump_lpt_info(struct ubifs_info *c) { return; }
434 static inline void dbg_dump_leb(const struct ubifs_info *c,
435 int lnum) { return; }
437 dbg_dump_znode(const struct ubifs_info *c,
438 const struct ubifs_znode *znode) { return; }
439 static inline void dbg_dump_heap(struct ubifs_info *c,
440 struct ubifs_lpt_heap *heap,
442 static inline void dbg_dump_pnode(struct ubifs_info *c,
443 struct ubifs_pnode *pnode,
444 struct ubifs_nnode *parent,
446 static inline void dbg_dump_tnc(struct ubifs_info *c) { return; }
447 static inline void dbg_dump_index(struct ubifs_info *c) { return; }
448 static inline void dbg_dump_lpt_lebs(const struct ubifs_info *c) { return; }
450 static inline int dbg_walk_index(struct ubifs_info *c,
451 dbg_leaf_callback leaf_cb,
452 dbg_znode_callback znode_cb,
453 void *priv) { return 0; }
454 static inline void dbg_save_space_info(struct ubifs_info *c) { return; }
455 static inline int dbg_check_space_info(struct ubifs_info *c) { return 0; }
456 static inline int dbg_check_lprops(struct ubifs_info *c) { return 0; }
458 dbg_old_index_check_init(struct ubifs_info *c,
459 struct ubifs_zbranch *zroot) { return 0; }
461 dbg_check_old_index(struct ubifs_info *c,
462 struct ubifs_zbranch *zroot) { return 0; }
463 static inline int dbg_check_cats(struct ubifs_info *c) { return 0; }
464 static inline int dbg_check_ltab(struct ubifs_info *c) { return 0; }
465 static inline int dbg_chk_lpt_free_spc(struct ubifs_info *c) { return 0; }
466 static inline int dbg_chk_lpt_sz(struct ubifs_info *c,
467 int action, int len) { return 0; }
468 static inline int dbg_check_synced_i_size(struct inode *inode) { return 0; }
469 static inline int dbg_check_dir_size(struct ubifs_info *c,
470 const struct inode *dir) { return 0; }
471 static inline int dbg_check_tnc(struct ubifs_info *c, int extra) { return 0; }
472 static inline int dbg_check_idx_size(struct ubifs_info *c,
473 long long idx_size) { return 0; }
474 static inline int dbg_check_filesystem(struct ubifs_info *c) { return 0; }
475 static inline void dbg_check_heap(struct ubifs_info *c,
476 struct ubifs_lpt_heap *heap,
477 int cat, int add_pos) { return; }
478 static inline int dbg_check_lpt_nodes(struct ubifs_info *c,
479 struct ubifs_cnode *cnode, int row, int col) { return 0; }
480 static inline int dbg_check_inode_size(struct ubifs_info *c,
481 const struct inode *inode,
482 loff_t size) { return 0; }
484 dbg_check_data_nodes_order(struct ubifs_info *c,
485 struct list_head *head) { return 0; }
487 dbg_check_nondata_nodes_order(struct ubifs_info *c,
488 struct list_head *head) { return 0; }
490 static inline int dbg_force_in_the_gaps(void) { return 0; }
491 #define dbg_force_in_the_gaps_enabled 0
492 #define dbg_failure_mode 0
494 static inline int dbg_debugfs_init(void) { return 0; }
495 static inline void dbg_debugfs_exit(void) { return; }
496 static inline int dbg_debugfs_init_fs(struct ubifs_info *c) { return 0; }
497 static inline int dbg_debugfs_exit_fs(struct ubifs_info *c) { return 0; }
499 #endif /* !CONFIG_UBIFS_FS_DEBUG */
500 #endif /* !__UBIFS_DEBUG_H__ */