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
);
33 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
34 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
36 #define UBIFS_DFS_DIR_NAME "ubi%d_%d"
37 #define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
40 * ubifs_debug_info - per-FS debugging information.
41 * @old_zroot: old index root - used by 'dbg_check_old_index()'
42 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
43 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
45 * @pc_happened: non-zero if an emulated power cut happened
46 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
47 * @pc_timeout: time in jiffies when delay of failure mode expires
48 * @pc_cnt: current number of calls to failure mode I/O functions
49 * @pc_cnt_max: number of calls by which to delay failure mode
51 * @chk_lpt_sz: used by LPT tree size checker
52 * @chk_lpt_sz2: used by LPT tree size checker
53 * @chk_lpt_wastage: used by LPT tree size checker
54 * @chk_lpt_lebs: used by LPT tree size checker
55 * @new_nhead_offs: used by LPT tree size checker
56 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
57 * @new_ihead_offs: used by debugging to check @c->ihead_offs
59 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
60 * @saved_bi: saved budgeting information
61 * @saved_free: saved amount of free space
62 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
64 * @chk_gen: if general extra checks are enabled
65 * @chk_index: if index xtra checks are enabled
66 * @chk_orph: if orphans extra checks are enabled
67 * @chk_lprops: if lprops extra checks are enabled
68 * @chk_fs: if UBIFS contents extra checks are enabled
69 * @tst_rcvry: if UBIFS recovery testing mode enabled
71 * @dfs_dir_name: name of debugfs directory containing this file-system's files
72 * @dfs_dir: direntry object of the file-system debugfs directory
73 * @dfs_dump_lprops: "dump lprops" debugfs knob
74 * @dfs_dump_budg: "dump budgeting information" debugfs knob
75 * @dfs_dump_tnc: "dump TNC" debugfs knob
76 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
77 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
78 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
79 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
80 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
81 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
83 struct ubifs_debug_info
{
84 struct ubifs_zbranch old_zroot
;
86 unsigned long long old_zroot_sqnum
;
90 unsigned long pc_timeout
;
92 unsigned int pc_cnt_max
;
95 long long chk_lpt_sz2
;
96 long long chk_lpt_wastage
;
102 struct ubifs_lp_stats saved_lst
;
103 struct ubifs_budg_info saved_bi
;
104 long long saved_free
;
105 int saved_idx_gc_cnt
;
107 unsigned int chk_gen
:1;
108 unsigned int chk_index
:1;
109 unsigned int chk_orph
:1;
110 unsigned int chk_lprops
:1;
111 unsigned int chk_fs
:1;
112 unsigned int tst_rcvry
:1;
114 char dfs_dir_name
[UBIFS_DFS_DIR_LEN
+ 1];
115 struct dentry
*dfs_dir
;
116 struct dentry
*dfs_dump_lprops
;
117 struct dentry
*dfs_dump_budg
;
118 struct dentry
*dfs_dump_tnc
;
119 struct dentry
*dfs_chk_gen
;
120 struct dentry
*dfs_chk_index
;
121 struct dentry
*dfs_chk_orph
;
122 struct dentry
*dfs_chk_lprops
;
123 struct dentry
*dfs_chk_fs
;
124 struct dentry
*dfs_tst_rcvry
;
128 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
130 * @chk_gen: if general extra checks are enabled
131 * @chk_index: if index xtra checks are enabled
132 * @chk_orph: if orphans extra checks are enabled
133 * @chk_lprops: if lprops extra checks are enabled
134 * @chk_fs: if UBIFS contents extra checks are enabled
135 * @tst_rcvry: if UBIFS recovery testing mode enabled
137 struct ubifs_global_debug_info
{
138 unsigned int chk_gen
:1;
139 unsigned int chk_index
:1;
140 unsigned int chk_orph
:1;
141 unsigned int chk_lprops
:1;
142 unsigned int chk_fs
:1;
143 unsigned int tst_rcvry
:1;
146 #define ubifs_assert(expr) do { \
147 if (unlikely(!(expr))) { \
148 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
149 __func__, __LINE__, current->pid); \
154 #define ubifs_assert_cmt_locked(c) do { \
155 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
156 up_write(&(c)->commit_sem); \
157 printk(KERN_CRIT "commit lock is not locked!\n"); \
162 #define ubifs_dbg_msg(type, fmt, ...) \
163 pr_debug("UBIFS DBG " type ": " fmt "\n", ##__VA_ARGS__)
165 #define DBG_KEY_BUF_LEN 32
166 #define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
167 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
168 pr_debug("UBIFS DBG " type ": " fmt "%s\n", ##__VA_ARGS__, \
169 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
172 /* Just a debugging messages not related to any specific UBIFS subsystem */
173 #define dbg_msg(fmt, ...) \
174 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
175 __func__, ##__VA_ARGS__)
177 /* General messages */
178 #define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
179 /* Additional journal messages */
180 #define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
181 #define dbg_jnlk(key, fmt, ...) \
182 ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
183 /* Additional TNC messages */
184 #define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
185 #define dbg_tnck(key, fmt, ...) \
186 ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
187 /* Additional lprops messages */
188 #define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
189 /* Additional LEB find messages */
190 #define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
191 /* Additional mount messages */
192 #define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
193 #define dbg_mntk(key, fmt, ...) \
194 ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
195 /* Additional I/O messages */
196 #define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
197 /* Additional commit messages */
198 #define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
199 /* Additional budgeting messages */
200 #define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
201 /* Additional log messages */
202 #define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
203 /* Additional gc messages */
204 #define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
205 /* Additional scan messages */
206 #define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
207 /* Additional recovery messages */
208 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
210 extern struct ubifs_global_debug_info ubifs_dbg
;
212 static inline int dbg_is_chk_gen(const struct ubifs_info
*c
)
214 return !!(ubifs_dbg
.chk_gen
|| c
->dbg
->chk_gen
);
216 static inline int dbg_is_chk_index(const struct ubifs_info
*c
)
218 return !!(ubifs_dbg
.chk_index
|| c
->dbg
->chk_index
);
220 static inline int dbg_is_chk_orph(const struct ubifs_info
*c
)
222 return !!(ubifs_dbg
.chk_orph
|| c
->dbg
->chk_orph
);
224 static inline int dbg_is_chk_lprops(const struct ubifs_info
*c
)
226 return !!(ubifs_dbg
.chk_lprops
|| c
->dbg
->chk_lprops
);
228 static inline int dbg_is_chk_fs(const struct ubifs_info
*c
)
230 return !!(ubifs_dbg
.chk_fs
|| c
->dbg
->chk_fs
);
232 static inline int dbg_is_tst_rcvry(const struct ubifs_info
*c
)
234 return !!(ubifs_dbg
.tst_rcvry
|| c
->dbg
->tst_rcvry
);
236 static inline int dbg_is_power_cut(const struct ubifs_info
*c
)
238 return !!c
->dbg
->pc_happened
;
241 int ubifs_debugging_init(struct ubifs_info
*c
);
242 void ubifs_debugging_exit(struct ubifs_info
*c
);
245 const char *dbg_ntype(int type
);
246 const char *dbg_cstate(int cmt_state
);
247 const char *dbg_jhead(int jhead
);
248 const char *dbg_get_key_dump(const struct ubifs_info
*c
,
249 const union ubifs_key
*key
);
250 const char *dbg_snprintf_key(const struct ubifs_info
*c
,
251 const union ubifs_key
*key
, char *buffer
, int len
);
252 void ubifs_dump_inode(struct ubifs_info
*c
, const struct inode
*inode
);
253 void ubifs_dump_node(const struct ubifs_info
*c
, const void *node
);
254 void ubifs_dump_budget_req(const struct ubifs_budget_req
*req
);
255 void ubifs_dump_lstats(const struct ubifs_lp_stats
*lst
);
256 void ubifs_dump_budg(struct ubifs_info
*c
, const struct ubifs_budg_info
*bi
);
257 void ubifs_dump_lprop(const struct ubifs_info
*c
,
258 const struct ubifs_lprops
*lp
);
259 void ubifs_dump_lprops(struct ubifs_info
*c
);
260 void ubifs_dump_lpt_info(struct ubifs_info
*c
);
261 void ubifs_dump_leb(const struct ubifs_info
*c
, int lnum
);
262 void ubifs_dump_sleb(const struct ubifs_info
*c
,
263 const struct ubifs_scan_leb
*sleb
, int offs
);
264 void ubifs_dump_znode(const struct ubifs_info
*c
,
265 const struct ubifs_znode
*znode
);
266 void ubifs_dump_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
,
268 void ubifs_dump_pnode(struct ubifs_info
*c
, struct ubifs_pnode
*pnode
,
269 struct ubifs_nnode
*parent
, int iip
);
270 void ubifs_dump_tnc(struct ubifs_info
*c
);
271 void ubifs_dump_index(struct ubifs_info
*c
);
272 void ubifs_dump_lpt_lebs(const struct ubifs_info
*c
);
274 int dbg_walk_index(struct ubifs_info
*c
, dbg_leaf_callback leaf_cb
,
275 dbg_znode_callback znode_cb
, void *priv
);
277 /* Checking functions */
278 void dbg_save_space_info(struct ubifs_info
*c
);
279 int dbg_check_space_info(struct ubifs_info
*c
);
280 int dbg_check_lprops(struct ubifs_info
*c
);
281 int dbg_old_index_check_init(struct ubifs_info
*c
, struct ubifs_zbranch
*zroot
);
282 int dbg_check_old_index(struct ubifs_info
*c
, struct ubifs_zbranch
*zroot
);
283 int dbg_check_cats(struct ubifs_info
*c
);
284 int dbg_check_ltab(struct ubifs_info
*c
);
285 int dbg_chk_lpt_free_spc(struct ubifs_info
*c
);
286 int dbg_chk_lpt_sz(struct ubifs_info
*c
, int action
, int len
);
287 int dbg_check_synced_i_size(const struct ubifs_info
*c
, struct inode
*inode
);
288 int dbg_check_dir(struct ubifs_info
*c
, const struct inode
*dir
);
289 int dbg_check_tnc(struct ubifs_info
*c
, int extra
);
290 int dbg_check_idx_size(struct ubifs_info
*c
, long long idx_size
);
291 int dbg_check_filesystem(struct ubifs_info
*c
);
292 void dbg_check_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
, int cat
,
294 int dbg_check_lpt_nodes(struct ubifs_info
*c
, struct ubifs_cnode
*cnode
,
296 int dbg_check_inode_size(struct ubifs_info
*c
, const struct inode
*inode
,
298 int dbg_check_data_nodes_order(struct ubifs_info
*c
, struct list_head
*head
);
299 int dbg_check_nondata_nodes_order(struct ubifs_info
*c
, struct list_head
*head
);
301 int dbg_leb_write(struct ubifs_info
*c
, int lnum
, const void *buf
, int offs
,
303 int dbg_leb_change(struct ubifs_info
*c
, int lnum
, const void *buf
, int len
);
304 int dbg_leb_unmap(struct ubifs_info
*c
, int lnum
);
305 int dbg_leb_map(struct ubifs_info
*c
, int lnum
);
307 /* Debugfs-related stuff */
308 int dbg_debugfs_init(void);
309 void dbg_debugfs_exit(void);
310 int dbg_debugfs_init_fs(struct ubifs_info
*c
);
311 void dbg_debugfs_exit_fs(struct ubifs_info
*c
);
313 #endif /* !__UBIFS_DEBUG_H__ */