Commit | Line | Data |
---|---|---|
730554d9 AB |
1 | /* |
2 | * JFFS2 -- Journalling Flash File System, Version 2. | |
3 | * | |
4 | * Copyright (C) 2001-2003 Red Hat, Inc. | |
5 | * | |
6 | * Created by David Woodhouse <dwmw2@infradead.org> | |
7 | * | |
8 | * For licensing information, see the file 'LICENCE' in this directory. | |
9 | * | |
182ec4ee | 10 | * $Id: debug.h,v 1.21 2005/11/07 11:14:39 gleixner Exp $ |
730554d9 AB |
11 | * |
12 | */ | |
13 | #ifndef _JFFS2_DEBUG_H_ | |
14 | #define _JFFS2_DEBUG_H_ | |
15 | ||
e499e01d | 16 | #include <linux/sched.h> |
730554d9 AB |
17 | |
18 | #ifndef CONFIG_JFFS2_FS_DEBUG | |
f538c96b | 19 | #define CONFIG_JFFS2_FS_DEBUG 0 |
730554d9 AB |
20 | #endif |
21 | ||
008531f4 | 22 | #if CONFIG_JFFS2_FS_DEBUG > 0 |
e0c8e42f | 23 | /* Enable "paranoia" checks and dumps */ |
730554d9 | 24 | #define JFFS2_DBG_PARANOIA_CHECKS |
e0c8e42f | 25 | #define JFFS2_DBG_DUMPS |
733802d9 | 26 | |
182ec4ee | 27 | /* |
733802d9 AB |
28 | * By defining/undefining the below macros one may select debugging messages |
29 | * fro specific JFFS2 subsystems. | |
30 | */ | |
e0c8e42f AB |
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 | |
e631ddba | 36 | #define JFFS2_DBG_SUMMARY_MESSAGES |
733802d9 | 37 | #define JFFS2_DBG_FSBUILD_MESSAGES |
e0c8e42f AB |
38 | #endif |
39 | ||
008531f4 | 40 | #if CONFIG_JFFS2_FS_DEBUG > 1 |
e0c8e42f | 41 | #define JFFS2_DBG_FRAGTREE2_MESSAGES |
733802d9 | 42 | #define JFFS2_DBG_MEMALLOC_MESSAGES |
e0c8e42f AB |
43 | #endif |
44 | ||
45ca1b50 | 45 | /* Sanity checks are supposed to be light-weight and enabled by default */ |
e0c8e42f AB |
46 | #define JFFS2_DBG_SANITY_CHECKS |
47 | ||
182ec4ee | 48 | /* |
e0c8e42f | 49 | * Dx() are mainly used for debugging messages, they must go away and be |
733802d9 | 50 | * superseded by nicer dbg_xxx() macros... |
e0c8e42f AB |
51 | */ |
52 | #if CONFIG_JFFS2_FS_DEBUG > 0 | |
730554d9 AB |
53 | #define D1(x) x |
54 | #else | |
55 | #define D1(x) | |
56 | #endif | |
57 | ||
58 | #if CONFIG_JFFS2_FS_DEBUG > 1 | |
59 | #define D2(x) x | |
60 | #else | |
61 | #define D2(x) | |
62 | #endif | |
63 | ||
e0c8e42f | 64 | /* The prefixes of JFFS2 messages */ |
81e39cf0 AB |
65 | #define JFFS2_DBG_PREFIX "[JFFS2 DBG]" |
66 | #define JFFS2_ERR_PREFIX "JFFS2 error:" | |
67 | #define JFFS2_WARN_PREFIX "JFFS2 warning:" | |
68 | #define JFFS2_NOTICE_PREFIX "JFFS2 notice:" | |
730554d9 | 69 | |
81e39cf0 AB |
70 | #define JFFS2_ERR KERN_ERR |
71 | #define JFFS2_WARN KERN_WARNING | |
72 | #define JFFS2_NOT KERN_NOTICE | |
73 | #define JFFS2_DBG KERN_DEBUG | |
74 | ||
75 | #define JFFS2_DBG_MSG_PREFIX JFFS2_DBG JFFS2_DBG_PREFIX | |
76 | #define JFFS2_ERR_MSG_PREFIX JFFS2_ERR JFFS2_ERR_PREFIX | |
77 | #define JFFS2_WARN_MSG_PREFIX JFFS2_WARN JFFS2_WARN_PREFIX | |
78 | #define JFFS2_NOTICE_MSG_PREFIX JFFS2_NOT JFFS2_NOTICE_PREFIX | |
730554d9 | 79 | |
e0c8e42f AB |
80 | /* JFFS2 message macros */ |
81 | #define JFFS2_ERROR(fmt, ...) \ | |
82 | do { \ | |
81e39cf0 | 83 | printk(JFFS2_ERR_MSG_PREFIX \ |
8d5df409 | 84 | " (%d) %s: " fmt, current->pid, \ |
02b70682 | 85 | __FUNCTION__ , ##__VA_ARGS__); \ |
e0c8e42f | 86 | } while(0) |
730554d9 | 87 | |
e0c8e42f AB |
88 | #define JFFS2_WARNING(fmt, ...) \ |
89 | do { \ | |
81e39cf0 | 90 | printk(JFFS2_WARN_MSG_PREFIX \ |
8d5df409 | 91 | " (%d) %s: " fmt, current->pid, \ |
02b70682 | 92 | __FUNCTION__ , ##__VA_ARGS__); \ |
e0c8e42f | 93 | } while(0) |
182ec4ee | 94 | |
e0c8e42f AB |
95 | #define JFFS2_NOTICE(fmt, ...) \ |
96 | do { \ | |
81e39cf0 | 97 | printk(JFFS2_NOTICE_MSG_PREFIX \ |
8d5df409 | 98 | " (%d) %s: " fmt, current->pid, \ |
02b70682 | 99 | __FUNCTION__ , ##__VA_ARGS__); \ |
e0c8e42f | 100 | } while(0) |
730554d9 | 101 | |
e0c8e42f AB |
102 | #define JFFS2_DEBUG(fmt, ...) \ |
103 | do { \ | |
81e39cf0 | 104 | printk(JFFS2_DBG_MSG_PREFIX \ |
8d5df409 | 105 | " (%d) %s: " fmt, current->pid, \ |
02b70682 | 106 | __FUNCTION__ , ##__VA_ARGS__); \ |
e0c8e42f AB |
107 | } while(0) |
108 | ||
182ec4ee | 109 | /* |
e0c8e42f AB |
110 | * We split our debugging messages on several parts, depending on the JFFS2 |
111 | * subsystem the message belongs to. | |
112 | */ | |
113 | /* Read inode debugging messages */ | |
114 | #ifdef JFFS2_DBG_READINODE_MESSAGES | |
733802d9 | 115 | #define dbg_readinode(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
e0c8e42f | 116 | #else |
733802d9 | 117 | #define dbg_readinode(fmt, ...) |
730554d9 AB |
118 | #endif |
119 | ||
e0c8e42f AB |
120 | /* Fragtree build debugging messages */ |
121 | #ifdef JFFS2_DBG_FRAGTREE_MESSAGES | |
733802d9 | 122 | #define dbg_fragtree(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
e0c8e42f | 123 | #else |
733802d9 | 124 | #define dbg_fragtree(fmt, ...) |
e0c8e42f | 125 | #endif |
e0e3006f | 126 | #ifdef JFFS2_DBG_FRAGTREE2_MESSAGES |
733802d9 | 127 | #define dbg_fragtree2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
e0e3006f | 128 | #else |
733802d9 | 129 | #define dbg_fragtree2(fmt, ...) |
e0e3006f | 130 | #endif |
e0c8e42f AB |
131 | |
132 | /* Directory entry list manilulation debugging messages */ | |
133 | #ifdef JFFS2_DBG_DENTLIST_MESSAGES | |
733802d9 | 134 | #define dbg_dentlist(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
e0c8e42f | 135 | #else |
733802d9 | 136 | #define dbg_dentlist(fmt, ...) |
e0c8e42f | 137 | #endif |
e0c8e42f | 138 | |
f538c96b | 139 | /* Print the messages about manipulating node_refs */ |
e0c8e42f | 140 | #ifdef JFFS2_DBG_NODEREF_MESSAGES |
733802d9 | 141 | #define dbg_noderef(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
e0c8e42f | 142 | #else |
733802d9 | 143 | #define dbg_noderef(fmt, ...) |
e0c8e42f | 144 | #endif |
730554d9 | 145 | |
f538c96b | 146 | /* Manipulations with the list of inodes (JFFS2 inocache) */ |
e0c8e42f | 147 | #ifdef JFFS2_DBG_INOCACHE_MESSAGES |
733802d9 | 148 | #define dbg_inocache(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
e0c8e42f | 149 | #else |
733802d9 | 150 | #define dbg_inocache(fmt, ...) |
e0c8e42f AB |
151 | #endif |
152 | ||
e631ddba FH |
153 | /* Summary debugging messages */ |
154 | #ifdef JFFS2_DBG_SUMMARY_MESSAGES | |
733802d9 AB |
155 | #define dbg_summary(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
156 | #else | |
157 | #define dbg_summary(fmt, ...) | |
158 | #endif | |
159 | ||
160 | /* File system build messages */ | |
161 | #ifdef JFFS2_DBG_FSBUILD_MESSAGES | |
162 | #define dbg_fsbuild(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) | |
e631ddba | 163 | #else |
733802d9 | 164 | #define dbg_fsbuild(fmt, ...) |
e631ddba FH |
165 | #endif |
166 | ||
f538c96b AB |
167 | /* Watch the object allocations */ |
168 | #ifdef JFFS2_DBG_MEMALLOC_MESSAGES | |
733802d9 | 169 | #define dbg_memalloc(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) |
f538c96b | 170 | #else |
733802d9 | 171 | #define dbg_memalloc(fmt, ...) |
f538c96b AB |
172 | #endif |
173 | ||
aa98d7cf KK |
174 | /* Watch the XATTR subsystem */ |
175 | #ifdef JFFS2_DBG_XATTR_MESSAGES | |
176 | #define dbg_xattr(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__) | |
177 | #else | |
178 | #define dbg_xattr(fmt, ...) | |
179 | #endif | |
f538c96b | 180 | |
45ca1b50 AB |
181 | /* "Sanity" checks */ |
182 | void | |
183 | __jffs2_dbg_acct_sanity_check_nolock(struct jffs2_sb_info *c, | |
184 | struct jffs2_eraseblock *jeb); | |
185 | void | |
186 | __jffs2_dbg_acct_sanity_check(struct jffs2_sb_info *c, | |
187 | struct jffs2_eraseblock *jeb); | |
188 | ||
e0c8e42f AB |
189 | /* "Paranoia" checks */ |
190 | void | |
191 | __jffs2_dbg_fragtree_paranoia_check(struct jffs2_inode_info *f); | |
730554d9 | 192 | void |
e0c8e42f AB |
193 | __jffs2_dbg_fragtree_paranoia_check_nolock(struct jffs2_inode_info *f); |
194 | void | |
195 | __jffs2_dbg_acct_paranoia_check(struct jffs2_sb_info *c, | |
196 | struct jffs2_eraseblock *jeb); | |
197 | void | |
198 | __jffs2_dbg_acct_paranoia_check_nolock(struct jffs2_sb_info *c, | |
199 | struct jffs2_eraseblock *jeb); | |
200 | void | |
201 | __jffs2_dbg_prewrite_paranoia_check(struct jffs2_sb_info *c, | |
202 | uint32_t ofs, int len); | |
730554d9 | 203 | |
e0c8e42f AB |
204 | /* "Dump" functions */ |
205 | void | |
206 | __jffs2_dbg_dump_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); | |
207 | void | |
208 | __jffs2_dbg_dump_jeb_nolock(struct jffs2_eraseblock *jeb); | |
209 | void | |
210 | __jffs2_dbg_dump_block_lists(struct jffs2_sb_info *c); | |
211 | void | |
212 | __jffs2_dbg_dump_block_lists_nolock(struct jffs2_sb_info *c); | |
213 | void | |
214 | __jffs2_dbg_dump_node_refs(struct jffs2_sb_info *c, | |
215 | struct jffs2_eraseblock *jeb); | |
216 | void | |
217 | __jffs2_dbg_dump_node_refs_nolock(struct jffs2_sb_info *c, | |
218 | struct jffs2_eraseblock *jeb); | |
219 | void | |
220 | __jffs2_dbg_dump_fragtree(struct jffs2_inode_info *f); | |
221 | void | |
222 | __jffs2_dbg_dump_fragtree_nolock(struct jffs2_inode_info *f); | |
730554d9 | 223 | void |
e0c8e42f AB |
224 | __jffs2_dbg_dump_buffer(unsigned char *buf, int len, uint32_t offs); |
225 | void | |
226 | __jffs2_dbg_dump_node(struct jffs2_sb_info *c, uint32_t ofs); | |
227 | ||
228 | #ifdef JFFS2_DBG_PARANOIA_CHECKS | |
229 | #define jffs2_dbg_fragtree_paranoia_check(f) \ | |
230 | __jffs2_dbg_fragtree_paranoia_check(f) | |
231 | #define jffs2_dbg_fragtree_paranoia_check_nolock(f) \ | |
232 | __jffs2_dbg_fragtree_paranoia_check_nolock(f) | |
233 | #define jffs2_dbg_acct_paranoia_check(c, jeb) \ | |
234 | __jffs2_dbg_acct_paranoia_check(c,jeb) | |
235 | #define jffs2_dbg_acct_paranoia_check_nolock(c, jeb) \ | |
236 | __jffs2_dbg_acct_paranoia_check_nolock(c,jeb) | |
237 | #define jffs2_dbg_prewrite_paranoia_check(c, ofs, len) \ | |
238 | __jffs2_dbg_prewrite_paranoia_check(c, ofs, len) | |
730554d9 AB |
239 | #else |
240 | #define jffs2_dbg_fragtree_paranoia_check(f) | |
e0c8e42f | 241 | #define jffs2_dbg_fragtree_paranoia_check_nolock(f) |
730554d9 | 242 | #define jffs2_dbg_acct_paranoia_check(c, jeb) |
e0c8e42f | 243 | #define jffs2_dbg_acct_paranoia_check_nolock(c, jeb) |
730554d9 AB |
244 | #define jffs2_dbg_prewrite_paranoia_check(c, ofs, len) |
245 | #endif /* !JFFS2_PARANOIA_CHECKS */ | |
246 | ||
e0c8e42f AB |
247 | #ifdef JFFS2_DBG_DUMPS |
248 | #define jffs2_dbg_dump_jeb(c, jeb) \ | |
249 | __jffs2_dbg_dump_jeb(c, jeb); | |
250 | #define jffs2_dbg_dump_jeb_nolock(jeb) \ | |
251 | __jffs2_dbg_dump_jeb_nolock(jeb); | |
252 | #define jffs2_dbg_dump_block_lists(c) \ | |
253 | __jffs2_dbg_dump_block_lists(c) | |
254 | #define jffs2_dbg_dump_block_lists_nolock(c) \ | |
255 | __jffs2_dbg_dump_block_lists_nolock(c) | |
256 | #define jffs2_dbg_dump_fragtree(f) \ | |
257 | __jffs2_dbg_dump_fragtree(f); | |
258 | #define jffs2_dbg_dump_fragtree_nolock(f) \ | |
259 | __jffs2_dbg_dump_fragtree_nolock(f); | |
260 | #define jffs2_dbg_dump_buffer(buf, len, offs) \ | |
261 | __jffs2_dbg_dump_buffer(*buf, len, offs); | |
262 | #define jffs2_dbg_dump_node(c, ofs) \ | |
263 | __jffs2_dbg_dump_node(c, ofs); | |
264 | #else | |
265 | #define jffs2_dbg_dump_jeb(c, jeb) | |
266 | #define jffs2_dbg_dump_jeb_nolock(jeb) | |
267 | #define jffs2_dbg_dump_block_lists(c) | |
268 | #define jffs2_dbg_dump_block_lists_nolock(c) | |
269 | #define jffs2_dbg_dump_fragtree(f) | |
270 | #define jffs2_dbg_dump_fragtree_nolock(f) | |
271 | #define jffs2_dbg_dump_buffer(buf, len, offs) | |
272 | #define jffs2_dbg_dump_node(c, ofs) | |
273 | #endif /* !JFFS2_DBG_DUMPS */ | |
274 | ||
730554d9 | 275 | #ifdef JFFS2_DBG_SANITY_CHECKS |
45ca1b50 AB |
276 | #define jffs2_dbg_acct_sanity_check(c, jeb) \ |
277 | __jffs2_dbg_acct_sanity_check(c, jeb) | |
278 | #define jffs2_dbg_acct_sanity_check_nolock(c, jeb) \ | |
279 | __jffs2_dbg_acct_sanity_check_nolock(c, jeb) | |
e0c8e42f AB |
280 | #else |
281 | #define jffs2_dbg_acct_sanity_check(c, jeb) | |
282 | #define jffs2_dbg_acct_sanity_check_nolock(c, jeb) | |
730554d9 AB |
283 | #endif /* !JFFS2_DBG_SANITY_CHECKS */ |
284 | ||
285 | #endif /* _JFFS2_DEBUG_H_ */ |