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