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 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
36 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
38 #define UBIFS_DFS_DIR_NAME "ubi%d_%d"
39 #define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
42 * ubifs_debug_info - per-FS debugging information.
43 * @old_zroot: old index root - used by 'dbg_check_old_index()'
44 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
45 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
47 * @pc_happened: non-zero if an emulated power cut happened
48 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
49 * @pc_timeout: time in jiffies when delay of failure mode expires
50 * @pc_cnt: current number of calls to failure mode I/O functions
51 * @pc_cnt_max: number of calls by which to delay failure mode
53 * @chk_lpt_sz: used by LPT tree size checker
54 * @chk_lpt_sz2: used by LPT tree size checker
55 * @chk_lpt_wastage: used by LPT tree size checker
56 * @chk_lpt_lebs: used by LPT tree size checker
57 * @new_nhead_offs: used by LPT tree size checker
58 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
59 * @new_ihead_offs: used by debugging to check @c->ihead_offs
61 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
62 * @saved_bi: saved budgeting information
63 * @saved_free: saved amount of free space
64 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
66 * @chk_gen: if general extra checks are enabled
67 * @chk_index: if index xtra checks are enabled
68 * @chk_orph: if orphans extra checks are enabled
69 * @chk_lprops: if lprops extra checks are enabled
70 * @chk_fs: if UBIFS contents extra checks are enabled
71 * @tst_rcvry: if UBIFS recovery testing mode enabled
73 * @dfs_dir_name: name of debugfs directory containing this file-system's files
74 * @dfs_dir: direntry object of the file-system debugfs directory
75 * @dfs_dump_lprops: "dump lprops" debugfs knob
76 * @dfs_dump_budg: "dump budgeting information" debugfs knob
77 * @dfs_dump_tnc: "dump TNC" debugfs knob
78 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
79 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
80 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
81 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
82 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
83 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
85 struct ubifs_debug_info
{
86 struct ubifs_zbranch old_zroot
;
88 unsigned long long old_zroot_sqnum
;
92 unsigned long pc_timeout
;
94 unsigned int pc_cnt_max
;
97 long long chk_lpt_sz2
;
98 long long chk_lpt_wastage
;
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
;
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;
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
;
130 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
132 * @chk_gen: if general extra checks are enabled
133 * @chk_index: if index xtra checks are enabled
134 * @chk_orph: if orphans extra checks are enabled
135 * @chk_lprops: if lprops extra checks are enabled
136 * @chk_fs: if UBIFS contents extra checks are enabled
137 * @tst_rcvry: if UBIFS recovery testing mode enabled
139 struct 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;
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); \
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"); \
164 #define dbg_dump_stack() dump_stack()
166 #define dbg_err(fmt, ...) do { \
167 spin_lock(&dbg_lock); \
168 ubifs_err(fmt, ##__VA_ARGS__); \
169 spin_unlock(&dbg_lock); \
172 const char *dbg_key_str0(const struct ubifs_info
*c
,
173 const union ubifs_key
*key
);
174 const char *dbg_key_str1(const struct ubifs_info
*c
,
175 const union ubifs_key
*key
);
178 * TODO: these macros are now broken because there is no locking around them
179 * and we use a global buffer for the key string. This means that in case of
180 * concurrent execution we will end up with incorrect and messy key strings.
182 #define DBGKEY(key) dbg_key_str0(c, (key))
183 #define DBGKEY1(key) dbg_key_str1(c, (key))
185 extern spinlock_t dbg_lock
;
187 #define ubifs_dbg_msg(type, fmt, ...) \
188 pr_debug("UBIFS DBG " type ": " fmt "\n", ##__VA_ARGS__)
190 /* Just a debugging messages not related to any specific UBIFS subsystem */
191 #define dbg_msg(fmt, ...) \
192 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
193 __func__, ##__VA_ARGS__)
195 /* General messages */
196 #define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
197 /* Additional journal messages */
198 #define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
199 /* Additional TNC messages */
200 #define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
201 /* Additional lprops messages */
202 #define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
203 /* Additional LEB find messages */
204 #define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
205 /* Additional mount messages */
206 #define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
207 /* Additional I/O messages */
208 #define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
209 /* Additional commit messages */
210 #define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
211 /* Additional budgeting messages */
212 #define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
213 /* Additional log messages */
214 #define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
215 /* Additional gc messages */
216 #define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
217 /* Additional scan messages */
218 #define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
219 /* Additional recovery messages */
220 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
222 extern struct ubifs_global_debug_info ubifs_dbg
;
224 static inline int dbg_is_chk_gen(const struct ubifs_info
*c
)
226 return !!(ubifs_dbg
.chk_gen
|| c
->dbg
->chk_gen
);
228 static inline int dbg_is_chk_index(const struct ubifs_info
*c
)
230 return !!(ubifs_dbg
.chk_index
|| c
->dbg
->chk_index
);
232 static inline int dbg_is_chk_orph(const struct ubifs_info
*c
)
234 return !!(ubifs_dbg
.chk_orph
|| c
->dbg
->chk_orph
);
236 static inline int dbg_is_chk_lprops(const struct ubifs_info
*c
)
238 return !!(ubifs_dbg
.chk_lprops
|| c
->dbg
->chk_lprops
);
240 static inline int dbg_is_chk_fs(const struct ubifs_info
*c
)
242 return !!(ubifs_dbg
.chk_fs
|| c
->dbg
->chk_fs
);
244 static inline int dbg_is_tst_rcvry(const struct ubifs_info
*c
)
246 return !!(ubifs_dbg
.tst_rcvry
|| c
->dbg
->tst_rcvry
);
248 static inline int dbg_is_power_cut(const struct ubifs_info
*c
)
250 return !!c
->dbg
->pc_happened
;
253 int ubifs_debugging_init(struct ubifs_info
*c
);
254 void ubifs_debugging_exit(struct ubifs_info
*c
);
257 const char *dbg_ntype(int type
);
258 const char *dbg_cstate(int cmt_state
);
259 const char *dbg_jhead(int jhead
);
260 const char *dbg_get_key_dump(const struct ubifs_info
*c
,
261 const union ubifs_key
*key
);
262 void dbg_dump_inode(struct ubifs_info
*c
, const struct inode
*inode
);
263 void dbg_dump_node(const struct ubifs_info
*c
, const void *node
);
264 void dbg_dump_lpt_node(const struct ubifs_info
*c
, void *node
, int lnum
,
266 void dbg_dump_budget_req(const struct ubifs_budget_req
*req
);
267 void dbg_dump_lstats(const struct ubifs_lp_stats
*lst
);
268 void dbg_dump_budg(struct ubifs_info
*c
, const struct ubifs_budg_info
*bi
);
269 void dbg_dump_lprop(const struct ubifs_info
*c
, const struct ubifs_lprops
*lp
);
270 void dbg_dump_lprops(struct ubifs_info
*c
);
271 void dbg_dump_lpt_info(struct ubifs_info
*c
);
272 void dbg_dump_leb(const struct ubifs_info
*c
, int lnum
);
273 void dbg_dump_sleb(const struct ubifs_info
*c
,
274 const struct ubifs_scan_leb
*sleb
, int offs
);
275 void dbg_dump_znode(const struct ubifs_info
*c
,
276 const struct ubifs_znode
*znode
);
277 void dbg_dump_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
, int cat
);
278 void dbg_dump_pnode(struct ubifs_info
*c
, struct ubifs_pnode
*pnode
,
279 struct ubifs_nnode
*parent
, int iip
);
280 void dbg_dump_tnc(struct ubifs_info
*c
);
281 void dbg_dump_index(struct ubifs_info
*c
);
282 void dbg_dump_lpt_lebs(const struct ubifs_info
*c
);
284 int dbg_walk_index(struct ubifs_info
*c
, dbg_leaf_callback leaf_cb
,
285 dbg_znode_callback znode_cb
, void *priv
);
287 /* Checking functions */
288 void dbg_save_space_info(struct ubifs_info
*c
);
289 int dbg_check_space_info(struct ubifs_info
*c
);
290 int dbg_check_lprops(struct ubifs_info
*c
);
291 int dbg_old_index_check_init(struct ubifs_info
*c
, struct ubifs_zbranch
*zroot
);
292 int dbg_check_old_index(struct ubifs_info
*c
, struct ubifs_zbranch
*zroot
);
293 int dbg_check_cats(struct ubifs_info
*c
);
294 int dbg_check_ltab(struct ubifs_info
*c
);
295 int dbg_chk_lpt_free_spc(struct ubifs_info
*c
);
296 int dbg_chk_lpt_sz(struct ubifs_info
*c
, int action
, int len
);
297 int dbg_check_synced_i_size(const struct ubifs_info
*c
, struct inode
*inode
);
298 int dbg_check_dir(struct ubifs_info
*c
, const struct inode
*dir
);
299 int dbg_check_tnc(struct ubifs_info
*c
, int extra
);
300 int dbg_check_idx_size(struct ubifs_info
*c
, long long idx_size
);
301 int dbg_check_filesystem(struct ubifs_info
*c
);
302 void dbg_check_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
, int cat
,
304 int dbg_check_lpt_nodes(struct ubifs_info
*c
, struct ubifs_cnode
*cnode
,
306 int dbg_check_inode_size(struct ubifs_info
*c
, const struct inode
*inode
,
308 int dbg_check_data_nodes_order(struct ubifs_info
*c
, struct list_head
*head
);
309 int dbg_check_nondata_nodes_order(struct ubifs_info
*c
, struct list_head
*head
);
311 int dbg_leb_write(struct ubifs_info
*c
, int lnum
, const void *buf
, int offs
,
313 int dbg_leb_change(struct ubifs_info
*c
, int lnum
, const void *buf
, int len
,
315 int dbg_leb_unmap(struct ubifs_info
*c
, int lnum
);
316 int dbg_leb_map(struct ubifs_info
*c
, int lnum
, int dtype
);
318 /* Debugfs-related stuff */
319 int dbg_debugfs_init(void);
320 void dbg_debugfs_exit(void);
321 int dbg_debugfs_init_fs(struct ubifs_info
*c
);
322 void dbg_debugfs_exit_fs(struct ubifs_info
*c
);
324 #else /* !CONFIG_UBIFS_FS_DEBUG */
326 /* Use "if (0)" to make compiler check arguments even if debugging is off */
327 #define ubifs_assert(expr) do { \
329 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
330 __func__, __LINE__, current->pid); \
333 #define dbg_err(fmt, ...) do { \
335 ubifs_err(fmt, ##__VA_ARGS__); \
338 #define DBGKEY(key) ((char *)(key))
339 #define DBGKEY1(key) ((char *)(key))
341 #define ubifs_dbg_msg(fmt, ...) do { \
343 printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \
346 #define dbg_dump_stack()
347 #define ubifs_assert_cmt_locked(c)
349 #define dbg_msg(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
350 #define dbg_gen(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
351 #define dbg_jnl(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
352 #define dbg_tnc(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
353 #define dbg_lp(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
354 #define dbg_find(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
355 #define dbg_mnt(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
356 #define dbg_io(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
357 #define dbg_cmt(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
358 #define dbg_budg(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
359 #define dbg_log(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
360 #define dbg_gc(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
361 #define dbg_scan(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
362 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
364 static inline int ubifs_debugging_init(struct ubifs_info
*c
) { return 0; }
365 static inline void ubifs_debugging_exit(struct ubifs_info
*c
) { return; }
366 static inline const char *dbg_ntype(int type
) { return ""; }
367 static inline const char *dbg_cstate(int cmt_state
) { return ""; }
368 static inline const char *dbg_jhead(int jhead
) { return ""; }
369 static inline const char *
370 dbg_get_key_dump(const struct ubifs_info
*c
,
371 const union ubifs_key
*key
) { return ""; }
372 static inline void dbg_dump_inode(struct ubifs_info
*c
,
373 const struct inode
*inode
) { return; }
374 static inline void dbg_dump_node(const struct ubifs_info
*c
,
375 const void *node
) { return; }
376 static inline void dbg_dump_lpt_node(const struct ubifs_info
*c
,
377 void *node
, int lnum
,
378 int offs
) { return; }
380 dbg_dump_budget_req(const struct ubifs_budget_req
*req
) { return; }
382 dbg_dump_lstats(const struct ubifs_lp_stats
*lst
) { return; }
384 dbg_dump_budg(struct ubifs_info
*c
,
385 const struct ubifs_budg_info
*bi
) { return; }
386 static inline void dbg_dump_lprop(const struct ubifs_info
*c
,
387 const struct ubifs_lprops
*lp
) { return; }
388 static inline void dbg_dump_lprops(struct ubifs_info
*c
) { return; }
389 static inline void dbg_dump_lpt_info(struct ubifs_info
*c
) { return; }
390 static inline void dbg_dump_leb(const struct ubifs_info
*c
,
391 int lnum
) { return; }
393 dbg_dump_sleb(const struct ubifs_info
*c
,
394 const struct ubifs_scan_leb
*sleb
, int offs
) { return; }
396 dbg_dump_znode(const struct ubifs_info
*c
,
397 const struct ubifs_znode
*znode
) { return; }
398 static inline void dbg_dump_heap(struct ubifs_info
*c
,
399 struct ubifs_lpt_heap
*heap
,
401 static inline void dbg_dump_pnode(struct ubifs_info
*c
,
402 struct ubifs_pnode
*pnode
,
403 struct ubifs_nnode
*parent
,
405 static inline void dbg_dump_tnc(struct ubifs_info
*c
) { return; }
406 static inline void dbg_dump_index(struct ubifs_info
*c
) { return; }
407 static inline void dbg_dump_lpt_lebs(const struct ubifs_info
*c
) { return; }
409 static inline int dbg_walk_index(struct ubifs_info
*c
,
410 dbg_leaf_callback leaf_cb
,
411 dbg_znode_callback znode_cb
,
412 void *priv
) { return 0; }
413 static inline void dbg_save_space_info(struct ubifs_info
*c
) { return; }
414 static inline int dbg_check_space_info(struct ubifs_info
*c
) { return 0; }
415 static inline int dbg_check_lprops(struct ubifs_info
*c
) { return 0; }
417 dbg_old_index_check_init(struct ubifs_info
*c
,
418 struct ubifs_zbranch
*zroot
) { return 0; }
420 dbg_check_old_index(struct ubifs_info
*c
,
421 struct ubifs_zbranch
*zroot
) { return 0; }
422 static inline int dbg_check_cats(struct ubifs_info
*c
) { return 0; }
423 static inline int dbg_check_ltab(struct ubifs_info
*c
) { return 0; }
424 static inline int dbg_chk_lpt_free_spc(struct ubifs_info
*c
) { return 0; }
425 static inline int dbg_chk_lpt_sz(struct ubifs_info
*c
,
426 int action
, int len
) { return 0; }
428 dbg_check_synced_i_size(const struct ubifs_info
*c
,
429 struct inode
*inode
) { return 0; }
430 static inline int dbg_check_dir(struct ubifs_info
*c
,
431 const struct inode
*dir
) { return 0; }
432 static inline int dbg_check_tnc(struct ubifs_info
*c
, int extra
) { return 0; }
433 static inline int dbg_check_idx_size(struct ubifs_info
*c
,
434 long long idx_size
) { return 0; }
435 static inline int dbg_check_filesystem(struct ubifs_info
*c
) { return 0; }
436 static inline void dbg_check_heap(struct ubifs_info
*c
,
437 struct ubifs_lpt_heap
*heap
,
438 int cat
, int add_pos
) { return; }
439 static inline int dbg_check_lpt_nodes(struct ubifs_info
*c
,
440 struct ubifs_cnode
*cnode
, int row
, int col
) { return 0; }
441 static inline int dbg_check_inode_size(struct ubifs_info
*c
,
442 const struct inode
*inode
,
443 loff_t size
) { return 0; }
445 dbg_check_data_nodes_order(struct ubifs_info
*c
,
446 struct list_head
*head
) { return 0; }
448 dbg_check_nondata_nodes_order(struct ubifs_info
*c
,
449 struct list_head
*head
) { return 0; }
451 static inline int dbg_leb_write(struct ubifs_info
*c
, int lnum
,
452 const void *buf
, int offset
,
453 int len
, int dtype
) { return 0; }
454 static inline int dbg_leb_change(struct ubifs_info
*c
, int lnum
,
455 const void *buf
, int len
,
456 int dtype
) { return 0; }
457 static inline int dbg_leb_unmap(struct ubifs_info
*c
, int lnum
) { return 0; }
458 static inline int dbg_leb_map(struct ubifs_info
*c
, int lnum
,
459 int dtype
) { return 0; }
461 static inline int dbg_is_chk_gen(const struct ubifs_info
*c
) { return 0; }
462 static inline int dbg_is_chk_index(const struct ubifs_info
*c
) { return 0; }
463 static inline int dbg_is_chk_orph(const struct ubifs_info
*c
) { return 0; }
464 static inline int dbg_is_chk_lprops(const struct ubifs_info
*c
) { return 0; }
465 static inline int dbg_is_chk_fs(const struct ubifs_info
*c
) { return 0; }
466 static inline int dbg_is_tst_rcvry(const struct ubifs_info
*c
) { return 0; }
467 static inline int dbg_is_power_cut(const struct ubifs_info
*c
) { return 0; }
469 static inline int dbg_debugfs_init(void) { return 0; }
470 static inline void dbg_debugfs_exit(void) { return; }
471 static inline int dbg_debugfs_init_fs(struct ubifs_info
*c
) { return 0; }
472 static inline int dbg_debugfs_exit_fs(struct ubifs_info
*c
) { return 0; }
474 #endif /* !CONFIG_UBIFS_FS_DEBUG */
475 #endif /* !__UBIFS_DEBUG_H__ */