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
34 #include <linux/random.h>
37 * ubifs_debug_info - per-FS debugging information.
38 * @old_zroot: old index root - used by 'dbg_check_old_index()'
39 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
40 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
41 * @failure_mode: failure mode for recovery testing
42 * @fail_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
43 * @fail_timeout: time in jiffies when delay of failure mode expires
44 * @fail_cnt: current number of calls to failure mode I/O functions
45 * @fail_cnt_max: number of calls by which to delay failure mode
46 * @chk_lpt_sz: used by LPT tree size checker
47 * @chk_lpt_sz2: used by LPT tree size checker
48 * @chk_lpt_wastage: used by LPT tree size checker
49 * @chk_lpt_lebs: used by LPT tree size checker
50 * @new_nhead_offs: used by LPT tree size checker
51 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
52 * @new_ihead_offs: used by debugging to check @c->ihead_offs
54 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
55 * @saved_bi: saved budgeting information
56 * @saved_free: saved amount of free space
57 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
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
65 struct ubifs_debug_info {
66 struct ubifs_zbranch old_zroot;
68 unsigned long long old_zroot_sqnum;
71 unsigned long fail_timeout;
72 unsigned int fail_cnt;
73 unsigned int fail_cnt_max;
75 long long chk_lpt_sz2;
76 long long chk_lpt_wastage;
82 struct ubifs_lp_stats saved_lst;
83 struct ubifs_budg_info saved_bi;
87 char dfs_dir_name[100];
88 struct dentry *dfs_dir;
89 struct dentry *dfs_dump_lprops;
90 struct dentry *dfs_dump_budg;
91 struct dentry *dfs_dump_tnc;
94 #define ubifs_assert(expr) do { \
95 if (unlikely(!(expr))) { \
96 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
97 __func__, __LINE__, current->pid); \
102 #define ubifs_assert_cmt_locked(c) do { \
103 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
104 up_write(&(c)->commit_sem); \
105 printk(KERN_CRIT "commit lock is not locked!\n"); \
110 #define dbg_dump_stack() dump_stack()
112 /* Generic debugging messages */
113 #define dbg_msg(fmt, ...) do { \
114 spin_lock(&dbg_lock); \
115 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
116 __func__, ##__VA_ARGS__); \
117 spin_unlock(&dbg_lock); \
120 #define dbg_do_msg(typ, fmt, ...) do { \
121 if (ubifs_msg_flags & typ) \
122 dbg_msg(fmt, ##__VA_ARGS__); \
125 #define dbg_err(fmt, ...) do { \
126 spin_lock(&dbg_lock); \
127 ubifs_err(fmt, ##__VA_ARGS__); \
128 spin_unlock(&dbg_lock); \
131 const char *dbg_key_str0(const struct ubifs_info *c,
132 const union ubifs_key *key);
133 const char *dbg_key_str1(const struct ubifs_info *c,
134 const union ubifs_key *key);
137 * DBGKEY macros require @dbg_lock to be held, which it is in the dbg message
140 #define DBGKEY(key) dbg_key_str0(c, (key))
141 #define DBGKEY1(key) dbg_key_str1(c, (key))
143 /* General messages */
144 #define dbg_gen(fmt, ...) dbg_do_msg(UBIFS_MSG_GEN, fmt, ##__VA_ARGS__)
146 /* Additional journal messages */
147 #define dbg_jnl(fmt, ...) dbg_do_msg(UBIFS_MSG_JNL, fmt, ##__VA_ARGS__)
149 /* Additional TNC messages */
150 #define dbg_tnc(fmt, ...) dbg_do_msg(UBIFS_MSG_TNC, fmt, ##__VA_ARGS__)
152 /* Additional lprops messages */
153 #define dbg_lp(fmt, ...) dbg_do_msg(UBIFS_MSG_LP, fmt, ##__VA_ARGS__)
155 /* Additional LEB find messages */
156 #define dbg_find(fmt, ...) dbg_do_msg(UBIFS_MSG_FIND, fmt, ##__VA_ARGS__)
158 /* Additional mount messages */
159 #define dbg_mnt(fmt, ...) dbg_do_msg(UBIFS_MSG_MNT, fmt, ##__VA_ARGS__)
161 /* Additional I/O messages */
162 #define dbg_io(fmt, ...) dbg_do_msg(UBIFS_MSG_IO, fmt, ##__VA_ARGS__)
164 /* Additional commit messages */
165 #define dbg_cmt(fmt, ...) dbg_do_msg(UBIFS_MSG_CMT, fmt, ##__VA_ARGS__)
167 /* Additional budgeting messages */
168 #define dbg_budg(fmt, ...) dbg_do_msg(UBIFS_MSG_BUDG, fmt, ##__VA_ARGS__)
170 /* Additional log messages */
171 #define dbg_log(fmt, ...) dbg_do_msg(UBIFS_MSG_LOG, fmt, ##__VA_ARGS__)
173 /* Additional gc messages */
174 #define dbg_gc(fmt, ...) dbg_do_msg(UBIFS_MSG_GC, fmt, ##__VA_ARGS__)
176 /* Additional scan messages */
177 #define dbg_scan(fmt, ...) dbg_do_msg(UBIFS_MSG_SCAN, fmt, ##__VA_ARGS__)
179 /* Additional recovery messages */
180 #define dbg_rcvry(fmt, ...) dbg_do_msg(UBIFS_MSG_RCVRY, fmt, ##__VA_ARGS__)
183 * Debugging message type flags.
185 * UBIFS_MSG_GEN: general messages
186 * UBIFS_MSG_JNL: journal messages
187 * UBIFS_MSG_MNT: mount messages
188 * UBIFS_MSG_CMT: commit messages
189 * UBIFS_MSG_FIND: LEB find messages
190 * UBIFS_MSG_BUDG: budgeting messages
191 * UBIFS_MSG_GC: garbage collection messages
192 * UBIFS_MSG_TNC: TNC messages
193 * UBIFS_MSG_LP: lprops messages
194 * UBIFS_MSG_IO: I/O messages
195 * UBIFS_MSG_LOG: log messages
196 * UBIFS_MSG_SCAN: scan messages
197 * UBIFS_MSG_RCVRY: recovery messages
204 UBIFS_MSG_FIND = 0x10,
205 UBIFS_MSG_BUDG = 0x20,
207 UBIFS_MSG_TNC = 0x80,
208 UBIFS_MSG_LP = 0x100,
209 UBIFS_MSG_IO = 0x200,
210 UBIFS_MSG_LOG = 0x400,
211 UBIFS_MSG_SCAN = 0x800,
212 UBIFS_MSG_RCVRY = 0x1000,
216 * Debugging check flags.
218 * UBIFS_CHK_GEN: general checks
219 * UBIFS_CHK_TNC: check TNC
220 * UBIFS_CHK_IDX_SZ: check index size
221 * UBIFS_CHK_ORPH: check orphans
222 * UBIFS_CHK_OLD_IDX: check the old index
223 * UBIFS_CHK_LPROPS: check lprops
224 * UBIFS_CHK_FS: check the file-system
229 UBIFS_CHK_IDX_SZ = 0x4,
230 UBIFS_CHK_ORPH = 0x8,
231 UBIFS_CHK_OLD_IDX = 0x10,
232 UBIFS_CHK_LPROPS = 0x20,
237 * Special testing flags.
239 * UBIFS_TST_RCVRY: failure mode for recovery testing
242 UBIFS_TST_RCVRY = 0x4,
245 extern spinlock_t dbg_lock;
247 extern unsigned int ubifs_msg_flags;
248 extern unsigned int ubifs_chk_flags;
249 extern unsigned int ubifs_tst_flags;
251 int ubifs_debugging_init(struct ubifs_info *c);
252 void ubifs_debugging_exit(struct ubifs_info *c);
255 const char *dbg_ntype(int type);
256 const char *dbg_cstate(int cmt_state);
257 const char *dbg_jhead(int jhead);
258 const char *dbg_get_key_dump(const struct ubifs_info *c,
259 const union ubifs_key *key);
260 void dbg_dump_inode(const struct ubifs_info *c, const struct inode *inode);
261 void dbg_dump_node(const struct ubifs_info *c, const void *node);
262 void dbg_dump_lpt_node(const struct ubifs_info *c, void *node, int lnum,
264 void dbg_dump_budget_req(const struct ubifs_budget_req *req);
265 void dbg_dump_lstats(const struct ubifs_lp_stats *lst);
266 void dbg_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
267 void dbg_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp);
268 void dbg_dump_lprops(struct ubifs_info *c);
269 void dbg_dump_lpt_info(struct ubifs_info *c);
270 void dbg_dump_leb(const struct ubifs_info *c, int lnum);
271 void dbg_dump_znode(const struct ubifs_info *c,
272 const struct ubifs_znode *znode);
273 void dbg_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat);
274 void dbg_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
275 struct ubifs_nnode *parent, int iip);
276 void dbg_dump_tnc(struct ubifs_info *c);
277 void dbg_dump_index(struct ubifs_info *c);
278 void dbg_dump_lpt_lebs(const struct ubifs_info *c);
280 int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
281 dbg_znode_callback znode_cb, void *priv);
283 /* Checking functions */
284 void dbg_save_space_info(struct ubifs_info *c);
285 int dbg_check_space_info(struct ubifs_info *c);
286 int dbg_check_lprops(struct ubifs_info *c);
287 int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
288 int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
289 int dbg_check_cats(struct ubifs_info *c);
290 int dbg_check_ltab(struct ubifs_info *c);
291 int dbg_chk_lpt_free_spc(struct ubifs_info *c);
292 int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
293 int dbg_check_synced_i_size(struct inode *inode);
294 int dbg_check_dir_size(struct ubifs_info *c, const struct inode *dir);
295 int dbg_check_tnc(struct ubifs_info *c, int extra);
296 int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
297 int dbg_check_filesystem(struct ubifs_info *c);
298 void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
300 int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
302 int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
304 int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
305 int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
307 /* Force the use of in-the-gaps method for testing */
308 static inline int dbg_force_in_the_gaps_enabled(void)
310 return ubifs_chk_flags & UBIFS_CHK_GEN;
312 int dbg_force_in_the_gaps(void);
314 /* Failure mode for recovery testing */
315 #define dbg_failure_mode (ubifs_tst_flags & UBIFS_TST_RCVRY)
317 #ifndef UBIFS_DBG_PRESERVE_UBI
318 #define ubi_leb_read dbg_leb_read
319 #define ubi_leb_write dbg_leb_write
320 #define ubi_leb_change dbg_leb_change
321 #define ubi_leb_erase dbg_leb_erase
322 #define ubi_leb_unmap dbg_leb_unmap
323 #define ubi_is_mapped dbg_is_mapped
324 #define ubi_leb_map dbg_leb_map
327 int dbg_leb_read(struct ubi_volume_desc *desc, int lnum, char *buf, int offset,
329 int dbg_leb_write(struct ubi_volume_desc *desc, int lnum, const void *buf,
330 int offset, int len, int dtype);
331 int dbg_leb_change(struct ubi_volume_desc *desc, int lnum, const void *buf,
333 int dbg_leb_erase(struct ubi_volume_desc *desc, int lnum);
334 int dbg_leb_unmap(struct ubi_volume_desc *desc, int lnum);
335 int dbg_is_mapped(struct ubi_volume_desc *desc, int lnum);
336 int dbg_leb_map(struct ubi_volume_desc *desc, int lnum, int dtype);
338 static inline int dbg_read(struct ubi_volume_desc *desc, int lnum, char *buf,
341 return dbg_leb_read(desc, lnum, buf, offset, len, 0);
344 static inline int dbg_write(struct ubi_volume_desc *desc, int lnum,
345 const void *buf, int offset, int len)
347 return dbg_leb_write(desc, lnum, buf, offset, len, UBI_UNKNOWN);
350 static inline int dbg_change(struct ubi_volume_desc *desc, int lnum,
351 const void *buf, int len)
353 return dbg_leb_change(desc, lnum, buf, len, UBI_UNKNOWN);
356 /* Debugfs-related stuff */
357 int dbg_debugfs_init(void);
358 void dbg_debugfs_exit(void);
359 int dbg_debugfs_init_fs(struct ubifs_info *c);
360 void dbg_debugfs_exit_fs(struct ubifs_info *c);
362 #else /* !CONFIG_UBIFS_FS_DEBUG */
364 /* Use "if (0)" to make compiler check arguments even if debugging is off */
365 #define ubifs_assert(expr) do { \
367 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
368 __func__, __LINE__, current->pid); \
371 #define dbg_err(fmt, ...) do { \
373 ubifs_err(fmt, ##__VA_ARGS__); \
376 #define dbg_msg(fmt, ...) do { \
378 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", \
379 current->pid, __func__, ##__VA_ARGS__); \
382 #define dbg_dump_stack()
383 #define ubifs_assert_cmt_locked(c)
385 #define dbg_gen(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
386 #define dbg_jnl(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
387 #define dbg_tnc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
388 #define dbg_lp(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
389 #define dbg_find(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
390 #define dbg_mnt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
391 #define dbg_io(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
392 #define dbg_cmt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
393 #define dbg_budg(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
394 #define dbg_log(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
395 #define dbg_gc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
396 #define dbg_scan(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
397 #define dbg_rcvry(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
399 #define DBGKEY(key) ((char *)(key))
400 #define DBGKEY1(key) ((char *)(key))
402 static inline int ubifs_debugging_init(struct ubifs_info *c) { return 0; }
403 static inline void ubifs_debugging_exit(struct ubifs_info *c) { return; }
404 static inline const char *dbg_ntype(int type) { return ""; }
405 static inline const char *dbg_cstate(int cmt_state) { return ""; }
406 static inline const char *dbg_jhead(int jhead) { return ""; }
407 static inline const char *
408 dbg_get_key_dump(const struct ubifs_info *c,
409 const union ubifs_key *key) { return ""; }
410 static inline void dbg_dump_inode(const struct ubifs_info *c,
411 const struct inode *inode) { return; }
412 static inline void dbg_dump_node(const struct ubifs_info *c,
413 const void *node) { return; }
414 static inline void dbg_dump_lpt_node(const struct ubifs_info *c,
415 void *node, int lnum,
416 int offs) { return; }
418 dbg_dump_budget_req(const struct ubifs_budget_req *req) { return; }
420 dbg_dump_lstats(const struct ubifs_lp_stats *lst) { return; }
422 dbg_dump_budg(struct ubifs_info *c,
423 const struct ubifs_budg_info *bi) { return; }
424 static inline void dbg_dump_lprop(const struct ubifs_info *c,
425 const struct ubifs_lprops *lp) { return; }
426 static inline void dbg_dump_lprops(struct ubifs_info *c) { return; }
427 static inline void dbg_dump_lpt_info(struct ubifs_info *c) { return; }
428 static inline void dbg_dump_leb(const struct ubifs_info *c,
429 int lnum) { return; }
431 dbg_dump_znode(const struct ubifs_info *c,
432 const struct ubifs_znode *znode) { return; }
433 static inline void dbg_dump_heap(struct ubifs_info *c,
434 struct ubifs_lpt_heap *heap,
436 static inline void dbg_dump_pnode(struct ubifs_info *c,
437 struct ubifs_pnode *pnode,
438 struct ubifs_nnode *parent,
440 static inline void dbg_dump_tnc(struct ubifs_info *c) { return; }
441 static inline void dbg_dump_index(struct ubifs_info *c) { return; }
442 static inline void dbg_dump_lpt_lebs(const struct ubifs_info *c) { return; }
444 static inline int dbg_walk_index(struct ubifs_info *c,
445 dbg_leaf_callback leaf_cb,
446 dbg_znode_callback znode_cb,
447 void *priv) { return 0; }
448 static inline void dbg_save_space_info(struct ubifs_info *c) { return; }
449 static inline int dbg_check_space_info(struct ubifs_info *c) { return 0; }
450 static inline int dbg_check_lprops(struct ubifs_info *c) { return 0; }
452 dbg_old_index_check_init(struct ubifs_info *c,
453 struct ubifs_zbranch *zroot) { return 0; }
455 dbg_check_old_index(struct ubifs_info *c,
456 struct ubifs_zbranch *zroot) { return 0; }
457 static inline int dbg_check_cats(struct ubifs_info *c) { return 0; }
458 static inline int dbg_check_ltab(struct ubifs_info *c) { return 0; }
459 static inline int dbg_chk_lpt_free_spc(struct ubifs_info *c) { return 0; }
460 static inline int dbg_chk_lpt_sz(struct ubifs_info *c,
461 int action, int len) { return 0; }
462 static inline int dbg_check_synced_i_size(struct inode *inode) { return 0; }
463 static inline int dbg_check_dir_size(struct ubifs_info *c,
464 const struct inode *dir) { return 0; }
465 static inline int dbg_check_tnc(struct ubifs_info *c, int extra) { return 0; }
466 static inline int dbg_check_idx_size(struct ubifs_info *c,
467 long long idx_size) { return 0; }
468 static inline int dbg_check_filesystem(struct ubifs_info *c) { return 0; }
469 static inline void dbg_check_heap(struct ubifs_info *c,
470 struct ubifs_lpt_heap *heap,
471 int cat, int add_pos) { return; }
472 static inline int dbg_check_lpt_nodes(struct ubifs_info *c,
473 struct ubifs_cnode *cnode, int row, int col) { return 0; }
474 static inline int dbg_check_inode_size(struct ubifs_info *c,
475 const struct inode *inode,
476 loff_t size) { return 0; }
478 dbg_check_data_nodes_order(struct ubifs_info *c,
479 struct list_head *head) { return 0; }
481 dbg_check_nondata_nodes_order(struct ubifs_info *c,
482 struct list_head *head) { return 0; }
484 static inline int dbg_force_in_the_gaps(void) { return 0; }
485 #define dbg_force_in_the_gaps_enabled() 0
486 #define dbg_failure_mode 0
488 static inline int dbg_debugfs_init(void) { return 0; }
489 static inline void dbg_debugfs_exit(void) { return; }
490 static inline int dbg_debugfs_init_fs(struct ubifs_info *c) { return 0; }
491 static inline int dbg_debugfs_exit_fs(struct ubifs_info *c) { return 0; }
493 #endif /* !CONFIG_UBIFS_FS_DEBUG */
494 #endif /* !__UBIFS_DEBUG_H__ */