2 * JFFS2 -- Journalling Flash File System, Version 2.
4 * Copyright © 2001-2007 Red Hat, Inc.
5 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
7 * Created by David Woodhouse <dwmw2@infradead.org>
9 * For licensing information, see the file 'LICENCE' in this directory.
13 #ifndef _JFFS2_DEBUG_H_
14 #define _JFFS2_DEBUG_H_
16 #include <linux/sched.h>
18 #ifndef CONFIG_JFFS2_FS_DEBUG
19 #define CONFIG_JFFS2_FS_DEBUG 0
22 #if CONFIG_JFFS2_FS_DEBUG > 0
23 /* Enable "paranoia" checks and dumps */
24 #define JFFS2_DBG_PARANOIA_CHECKS
25 #define JFFS2_DBG_DUMPS
28 * By defining/undefining the below macros one may select debugging messages
29 * fro specific JFFS2 subsystems.
31 #define JFFS2_DBG_READINODE_MESSAGES
32 #define JFFS2_DBG_FRAGTREE_MESSAGES
33 #define JFFS2_DBG_DENTLIST_MESSAGES
34 #define JFFS2_DBG_NODEREF_MESSAGES
35 #define JFFS2_DBG_INOCACHE_MESSAGES
36 #define JFFS2_DBG_SUMMARY_MESSAGES
37 #define JFFS2_DBG_FSBUILD_MESSAGES
40 #if CONFIG_JFFS2_FS_DEBUG > 1
41 #define JFFS2_DBG_FRAGTREE2_MESSAGES
42 #define JFFS2_DBG_READINODE2_MESSAGES
43 #define JFFS2_DBG_MEMALLOC_MESSAGES
46 /* Sanity checks are supposed to be light-weight and enabled by default */
47 #define JFFS2_DBG_SANITY_CHECKS
50 * Dx() are mainly used for debugging messages, they must go away and be
51 * superseded by nicer dbg_xxx() macros...
53 #if CONFIG_JFFS2_FS_DEBUG > 0
60 #if CONFIG_JFFS2_FS_DEBUG > 1
66 #define jffs2_dbg(level, fmt, ...) \
68 if (CONFIG_JFFS2_FS_DEBUG >= level) \
69 pr_debug(fmt, ##__VA_ARGS__); \
72 /* The prefixes of JFFS2 messages */
73 #define JFFS2_DBG_PREFIX "[JFFS2 DBG]"
74 #define JFFS2_ERR_PREFIX "JFFS2 error:"
75 #define JFFS2_WARN_PREFIX "JFFS2 warning:"
76 #define JFFS2_NOTICE_PREFIX "JFFS2 notice:"
78 #define JFFS2_ERR KERN_ERR
79 #define JFFS2_WARN KERN_WARNING
80 #define JFFS2_NOT KERN_NOTICE
81 #define JFFS2_DBG KERN_DEBUG
83 #define JFFS2_DBG_MSG_PREFIX JFFS2_DBG JFFS2_DBG_PREFIX
84 #define JFFS2_ERR_MSG_PREFIX JFFS2_ERR JFFS2_ERR_PREFIX
85 #define JFFS2_WARN_MSG_PREFIX JFFS2_WARN JFFS2_WARN_PREFIX
86 #define JFFS2_NOTICE_MSG_PREFIX JFFS2_NOT JFFS2_NOTICE_PREFIX
88 /* JFFS2 message macros */
89 #define JFFS2_ERROR(fmt, ...) \
91 printk(JFFS2_ERR_MSG_PREFIX \
92 " (%d) %s: " fmt, task_pid_nr(current), \
93 __func__ , ##__VA_ARGS__); \
96 #define JFFS2_WARNING(fmt, ...) \
98 printk(JFFS2_WARN_MSG_PREFIX \
99 " (%d) %s: " fmt, task_pid_nr(current), \
100 __func__ , ##__VA_ARGS__); \
103 #define JFFS2_NOTICE(fmt, ...) \
105 printk(JFFS2_NOTICE_MSG_PREFIX \
106 " (%d) %s: " fmt, task_pid_nr(current), \
107 __func__ , ##__VA_ARGS__); \
110 #define JFFS2_DEBUG(fmt, ...) \
112 printk(JFFS2_DBG_MSG_PREFIX \
113 " (%d) %s: " fmt, task_pid_nr(current), \
114 __func__ , ##__VA_ARGS__); \
118 * We split our debugging messages on several parts, depending on the JFFS2
119 * subsystem the message belongs to.
121 /* Read inode debugging messages */
122 #ifdef JFFS2_DBG_READINODE_MESSAGES
123 #define dbg_readinode(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
125 #define dbg_readinode(fmt, ...)
127 #ifdef JFFS2_DBG_READINODE2_MESSAGES
128 #define dbg_readinode2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
130 #define dbg_readinode2(fmt, ...)
133 /* Fragtree build debugging messages */
134 #ifdef JFFS2_DBG_FRAGTREE_MESSAGES
135 #define dbg_fragtree(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
137 #define dbg_fragtree(fmt, ...)
139 #ifdef JFFS2_DBG_FRAGTREE2_MESSAGES
140 #define dbg_fragtree2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
142 #define dbg_fragtree2(fmt, ...)
145 /* Directory entry list manilulation debugging messages */
146 #ifdef JFFS2_DBG_DENTLIST_MESSAGES
147 #define dbg_dentlist(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
149 #define dbg_dentlist(fmt, ...)
152 /* Print the messages about manipulating node_refs */
153 #ifdef JFFS2_DBG_NODEREF_MESSAGES
154 #define dbg_noderef(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
156 #define dbg_noderef(fmt, ...)
159 /* Manipulations with the list of inodes (JFFS2 inocache) */
160 #ifdef JFFS2_DBG_INOCACHE_MESSAGES
161 #define dbg_inocache(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
163 #define dbg_inocache(fmt, ...)
166 /* Summary debugging messages */
167 #ifdef JFFS2_DBG_SUMMARY_MESSAGES
168 #define dbg_summary(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
170 #define dbg_summary(fmt, ...)
173 /* File system build messages */
174 #ifdef JFFS2_DBG_FSBUILD_MESSAGES
175 #define dbg_fsbuild(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
177 #define dbg_fsbuild(fmt, ...)
180 /* Watch the object allocations */
181 #ifdef JFFS2_DBG_MEMALLOC_MESSAGES
182 #define dbg_memalloc(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
184 #define dbg_memalloc(fmt, ...)
187 /* Watch the XATTR subsystem */
188 #ifdef JFFS2_DBG_XATTR_MESSAGES
189 #define dbg_xattr(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
191 #define dbg_xattr(fmt, ...)
194 /* "Sanity" checks */
196 __jffs2_dbg_acct_sanity_check_nolock(struct jffs2_sb_info *c,
197 struct jffs2_eraseblock *jeb);
199 __jffs2_dbg_acct_sanity_check(struct jffs2_sb_info *c,
200 struct jffs2_eraseblock *jeb);
202 /* "Paranoia" checks */
204 __jffs2_dbg_fragtree_paranoia_check(struct jffs2_inode_info *f);
206 __jffs2_dbg_fragtree_paranoia_check_nolock(struct jffs2_inode_info *f);
208 __jffs2_dbg_acct_paranoia_check(struct jffs2_sb_info *c,
209 struct jffs2_eraseblock *jeb);
211 __jffs2_dbg_acct_paranoia_check_nolock(struct jffs2_sb_info *c,
212 struct jffs2_eraseblock *jeb);
214 __jffs2_dbg_prewrite_paranoia_check(struct jffs2_sb_info *c,
215 uint32_t ofs, int len);
217 /* "Dump" functions */
219 __jffs2_dbg_dump_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
221 __jffs2_dbg_dump_jeb_nolock(struct jffs2_eraseblock *jeb);
223 __jffs2_dbg_dump_block_lists(struct jffs2_sb_info *c);
225 __jffs2_dbg_dump_block_lists_nolock(struct jffs2_sb_info *c);
227 __jffs2_dbg_dump_node_refs(struct jffs2_sb_info *c,
228 struct jffs2_eraseblock *jeb);
230 __jffs2_dbg_dump_node_refs_nolock(struct jffs2_sb_info *c,
231 struct jffs2_eraseblock *jeb);
233 __jffs2_dbg_dump_fragtree(struct jffs2_inode_info *f);
235 __jffs2_dbg_dump_fragtree_nolock(struct jffs2_inode_info *f);
237 __jffs2_dbg_dump_buffer(unsigned char *buf, int len, uint32_t offs);
239 __jffs2_dbg_dump_node(struct jffs2_sb_info *c, uint32_t ofs);
241 #ifdef JFFS2_DBG_PARANOIA_CHECKS
242 #define jffs2_dbg_fragtree_paranoia_check(f) \
243 __jffs2_dbg_fragtree_paranoia_check(f)
244 #define jffs2_dbg_fragtree_paranoia_check_nolock(f) \
245 __jffs2_dbg_fragtree_paranoia_check_nolock(f)
246 #define jffs2_dbg_acct_paranoia_check(c, jeb) \
247 __jffs2_dbg_acct_paranoia_check(c,jeb)
248 #define jffs2_dbg_acct_paranoia_check_nolock(c, jeb) \
249 __jffs2_dbg_acct_paranoia_check_nolock(c,jeb)
250 #define jffs2_dbg_prewrite_paranoia_check(c, ofs, len) \
251 __jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
253 #define jffs2_dbg_fragtree_paranoia_check(f)
254 #define jffs2_dbg_fragtree_paranoia_check_nolock(f)
255 #define jffs2_dbg_acct_paranoia_check(c, jeb)
256 #define jffs2_dbg_acct_paranoia_check_nolock(c, jeb)
257 #define jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
258 #endif /* !JFFS2_PARANOIA_CHECKS */
260 #ifdef JFFS2_DBG_DUMPS
261 #define jffs2_dbg_dump_jeb(c, jeb) \
262 __jffs2_dbg_dump_jeb(c, jeb);
263 #define jffs2_dbg_dump_jeb_nolock(jeb) \
264 __jffs2_dbg_dump_jeb_nolock(jeb);
265 #define jffs2_dbg_dump_block_lists(c) \
266 __jffs2_dbg_dump_block_lists(c)
267 #define jffs2_dbg_dump_block_lists_nolock(c) \
268 __jffs2_dbg_dump_block_lists_nolock(c)
269 #define jffs2_dbg_dump_fragtree(f) \
270 __jffs2_dbg_dump_fragtree(f);
271 #define jffs2_dbg_dump_fragtree_nolock(f) \
272 __jffs2_dbg_dump_fragtree_nolock(f);
273 #define jffs2_dbg_dump_buffer(buf, len, offs) \
274 __jffs2_dbg_dump_buffer(*buf, len, offs);
275 #define jffs2_dbg_dump_node(c, ofs) \
276 __jffs2_dbg_dump_node(c, ofs);
278 #define jffs2_dbg_dump_jeb(c, jeb)
279 #define jffs2_dbg_dump_jeb_nolock(jeb)
280 #define jffs2_dbg_dump_block_lists(c)
281 #define jffs2_dbg_dump_block_lists_nolock(c)
282 #define jffs2_dbg_dump_fragtree(f)
283 #define jffs2_dbg_dump_fragtree_nolock(f)
284 #define jffs2_dbg_dump_buffer(buf, len, offs)
285 #define jffs2_dbg_dump_node(c, ofs)
286 #endif /* !JFFS2_DBG_DUMPS */
288 #ifdef JFFS2_DBG_SANITY_CHECKS
289 #define jffs2_dbg_acct_sanity_check(c, jeb) \
290 __jffs2_dbg_acct_sanity_check(c, jeb)
291 #define jffs2_dbg_acct_sanity_check_nolock(c, jeb) \
292 __jffs2_dbg_acct_sanity_check_nolock(c, jeb)
294 #define jffs2_dbg_acct_sanity_check(c, jeb)
295 #define jffs2_dbg_acct_sanity_check_nolock(c, jeb)
296 #endif /* !JFFS2_DBG_SANITY_CHECKS */
298 #endif /* _JFFS2_DEBUG_H_ */