Commit | Line | Data |
---|---|---|
1e51764a AB |
1 | /* |
2 | * This file is part of UBIFS. | |
3 | * | |
4 | * Copyright (C) 2006-2008 Nokia Corporation. | |
5 | * | |
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. | |
9 | * | |
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 | |
13 | * more details. | |
14 | * | |
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 | |
18 | * | |
19 | * Authors: Artem Bityutskiy (Битюцкий Артём) | |
20 | * Adrian Hunter | |
21 | */ | |
22 | ||
23 | #ifndef __UBIFS_DEBUG_H__ | |
24 | #define __UBIFS_DEBUG_H__ | |
25 | ||
26 | #ifdef CONFIG_UBIFS_FS_DEBUG | |
27 | ||
28 | #define UBIFS_DBG(op) op | |
29 | ||
840dc6b8 | 30 | #define ubifs_assert(expr) do { \ |
1e51764a AB |
31 | if (unlikely(!(expr))) { \ |
32 | printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \ | |
33 | __func__, __LINE__, current->pid); \ | |
34 | dbg_dump_stack(); \ | |
35 | } \ | |
36 | } while (0) | |
37 | ||
38 | #define ubifs_assert_cmt_locked(c) do { \ | |
39 | if (unlikely(down_write_trylock(&(c)->commit_sem))) { \ | |
40 | up_write(&(c)->commit_sem); \ | |
41 | printk(KERN_CRIT "commit lock is not locked!\n"); \ | |
42 | ubifs_assert(0); \ | |
43 | } \ | |
44 | } while (0) | |
45 | ||
46 | #define dbg_dump_stack() do { \ | |
47 | if (!dbg_failure_mode) \ | |
48 | dump_stack(); \ | |
49 | } while (0) | |
50 | ||
51 | /* Generic debugging messages */ | |
52 | #define dbg_msg(fmt, ...) do { \ | |
53 | spin_lock(&dbg_lock); \ | |
54 | printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \ | |
55 | __func__, ##__VA_ARGS__); \ | |
56 | spin_unlock(&dbg_lock); \ | |
57 | } while (0) | |
58 | ||
59 | #define dbg_do_msg(typ, fmt, ...) do { \ | |
60 | if (ubifs_msg_flags & typ) \ | |
61 | dbg_msg(fmt, ##__VA_ARGS__); \ | |
62 | } while (0) | |
63 | ||
64 | #define dbg_err(fmt, ...) do { \ | |
65 | spin_lock(&dbg_lock); \ | |
66 | ubifs_err(fmt, ##__VA_ARGS__); \ | |
67 | spin_unlock(&dbg_lock); \ | |
68 | } while (0) | |
69 | ||
70 | const char *dbg_key_str0(const struct ubifs_info *c, | |
71 | const union ubifs_key *key); | |
72 | const char *dbg_key_str1(const struct ubifs_info *c, | |
73 | const union ubifs_key *key); | |
74 | ||
75 | /* | |
840dc6b8 | 76 | * DBGKEY macros require @dbg_lock to be held, which it is in the dbg message |
1e51764a AB |
77 | * macros. |
78 | */ | |
79 | #define DBGKEY(key) dbg_key_str0(c, (key)) | |
80 | #define DBGKEY1(key) dbg_key_str1(c, (key)) | |
81 | ||
82 | /* General messages */ | |
840dc6b8 | 83 | #define dbg_gen(fmt, ...) dbg_do_msg(UBIFS_MSG_GEN, fmt, ##__VA_ARGS__) |
1e51764a AB |
84 | |
85 | /* Additional journal messages */ | |
840dc6b8 | 86 | #define dbg_jnl(fmt, ...) dbg_do_msg(UBIFS_MSG_JNL, fmt, ##__VA_ARGS__) |
1e51764a AB |
87 | |
88 | /* Additional TNC messages */ | |
840dc6b8 | 89 | #define dbg_tnc(fmt, ...) dbg_do_msg(UBIFS_MSG_TNC, fmt, ##__VA_ARGS__) |
1e51764a AB |
90 | |
91 | /* Additional lprops messages */ | |
840dc6b8 | 92 | #define dbg_lp(fmt, ...) dbg_do_msg(UBIFS_MSG_LP, fmt, ##__VA_ARGS__) |
1e51764a AB |
93 | |
94 | /* Additional LEB find messages */ | |
840dc6b8 | 95 | #define dbg_find(fmt, ...) dbg_do_msg(UBIFS_MSG_FIND, fmt, ##__VA_ARGS__) |
1e51764a AB |
96 | |
97 | /* Additional mount messages */ | |
840dc6b8 | 98 | #define dbg_mnt(fmt, ...) dbg_do_msg(UBIFS_MSG_MNT, fmt, ##__VA_ARGS__) |
1e51764a AB |
99 | |
100 | /* Additional I/O messages */ | |
840dc6b8 | 101 | #define dbg_io(fmt, ...) dbg_do_msg(UBIFS_MSG_IO, fmt, ##__VA_ARGS__) |
1e51764a AB |
102 | |
103 | /* Additional commit messages */ | |
840dc6b8 | 104 | #define dbg_cmt(fmt, ...) dbg_do_msg(UBIFS_MSG_CMT, fmt, ##__VA_ARGS__) |
1e51764a AB |
105 | |
106 | /* Additional budgeting messages */ | |
840dc6b8 | 107 | #define dbg_budg(fmt, ...) dbg_do_msg(UBIFS_MSG_BUDG, fmt, ##__VA_ARGS__) |
1e51764a AB |
108 | |
109 | /* Additional log messages */ | |
840dc6b8 | 110 | #define dbg_log(fmt, ...) dbg_do_msg(UBIFS_MSG_LOG, fmt, ##__VA_ARGS__) |
1e51764a AB |
111 | |
112 | /* Additional gc messages */ | |
840dc6b8 | 113 | #define dbg_gc(fmt, ...) dbg_do_msg(UBIFS_MSG_GC, fmt, ##__VA_ARGS__) |
1e51764a AB |
114 | |
115 | /* Additional scan messages */ | |
840dc6b8 | 116 | #define dbg_scan(fmt, ...) dbg_do_msg(UBIFS_MSG_SCAN, fmt, ##__VA_ARGS__) |
1e51764a AB |
117 | |
118 | /* Additional recovery messages */ | |
840dc6b8 | 119 | #define dbg_rcvry(fmt, ...) dbg_do_msg(UBIFS_MSG_RCVRY, fmt, ##__VA_ARGS__) |
1e51764a AB |
120 | |
121 | /* | |
122 | * Debugging message type flags (must match msg_type_names in debug.c). | |
123 | * | |
124 | * UBIFS_MSG_GEN: general messages | |
125 | * UBIFS_MSG_JNL: journal messages | |
126 | * UBIFS_MSG_MNT: mount messages | |
127 | * UBIFS_MSG_CMT: commit messages | |
128 | * UBIFS_MSG_FIND: LEB find messages | |
129 | * UBIFS_MSG_BUDG: budgeting messages | |
130 | * UBIFS_MSG_GC: garbage collection messages | |
131 | * UBIFS_MSG_TNC: TNC messages | |
132 | * UBIFS_MSG_LP: lprops messages | |
133 | * UBIFS_MSG_IO: I/O messages | |
134 | * UBIFS_MSG_LOG: log messages | |
135 | * UBIFS_MSG_SCAN: scan messages | |
136 | * UBIFS_MSG_RCVRY: recovery messages | |
137 | */ | |
138 | enum { | |
139 | UBIFS_MSG_GEN = 0x1, | |
140 | UBIFS_MSG_JNL = 0x2, | |
141 | UBIFS_MSG_MNT = 0x4, | |
142 | UBIFS_MSG_CMT = 0x8, | |
143 | UBIFS_MSG_FIND = 0x10, | |
144 | UBIFS_MSG_BUDG = 0x20, | |
145 | UBIFS_MSG_GC = 0x40, | |
146 | UBIFS_MSG_TNC = 0x80, | |
147 | UBIFS_MSG_LP = 0x100, | |
148 | UBIFS_MSG_IO = 0x200, | |
149 | UBIFS_MSG_LOG = 0x400, | |
150 | UBIFS_MSG_SCAN = 0x800, | |
151 | UBIFS_MSG_RCVRY = 0x1000, | |
152 | }; | |
153 | ||
154 | /* Debugging message type flags for each default debug message level */ | |
155 | #define UBIFS_MSG_LVL_0 0 | |
156 | #define UBIFS_MSG_LVL_1 0x1 | |
157 | #define UBIFS_MSG_LVL_2 0x7f | |
158 | #define UBIFS_MSG_LVL_3 0xffff | |
159 | ||
160 | /* | |
161 | * Debugging check flags (must match chk_names in debug.c). | |
162 | * | |
163 | * UBIFS_CHK_GEN: general checks | |
164 | * UBIFS_CHK_TNC: check TNC | |
165 | * UBIFS_CHK_IDX_SZ: check index size | |
166 | * UBIFS_CHK_ORPH: check orphans | |
167 | * UBIFS_CHK_OLD_IDX: check the old index | |
168 | * UBIFS_CHK_LPROPS: check lprops | |
169 | * UBIFS_CHK_FS: check the file-system | |
170 | */ | |
171 | enum { | |
172 | UBIFS_CHK_GEN = 0x1, | |
173 | UBIFS_CHK_TNC = 0x2, | |
174 | UBIFS_CHK_IDX_SZ = 0x4, | |
175 | UBIFS_CHK_ORPH = 0x8, | |
176 | UBIFS_CHK_OLD_IDX = 0x10, | |
177 | UBIFS_CHK_LPROPS = 0x20, | |
178 | UBIFS_CHK_FS = 0x40, | |
179 | }; | |
180 | ||
181 | /* | |
182 | * Special testing flags (must match tst_names in debug.c). | |
183 | * | |
184 | * UBIFS_TST_FORCE_IN_THE_GAPS: force the use of in-the-gaps method | |
185 | * UBIFS_TST_RCVRY: failure mode for recovery testing | |
186 | */ | |
187 | enum { | |
188 | UBIFS_TST_FORCE_IN_THE_GAPS = 0x2, | |
189 | UBIFS_TST_RCVRY = 0x4, | |
190 | }; | |
191 | ||
192 | #if CONFIG_UBIFS_FS_DEBUG_MSG_LVL == 1 | |
193 | #define UBIFS_MSG_FLAGS_DEFAULT UBIFS_MSG_LVL_1 | |
194 | #elif CONFIG_UBIFS_FS_DEBUG_MSG_LVL == 2 | |
195 | #define UBIFS_MSG_FLAGS_DEFAULT UBIFS_MSG_LVL_2 | |
196 | #elif CONFIG_UBIFS_FS_DEBUG_MSG_LVL == 3 | |
197 | #define UBIFS_MSG_FLAGS_DEFAULT UBIFS_MSG_LVL_3 | |
198 | #else | |
199 | #define UBIFS_MSG_FLAGS_DEFAULT UBIFS_MSG_LVL_0 | |
200 | #endif | |
201 | ||
202 | #ifdef CONFIG_UBIFS_FS_DEBUG_CHKS | |
203 | #define UBIFS_CHK_FLAGS_DEFAULT 0xffffffff | |
204 | #else | |
205 | #define UBIFS_CHK_FLAGS_DEFAULT 0 | |
206 | #endif | |
207 | ||
208 | extern spinlock_t dbg_lock; | |
209 | ||
210 | extern unsigned int ubifs_msg_flags; | |
211 | extern unsigned int ubifs_chk_flags; | |
212 | extern unsigned int ubifs_tst_flags; | |
213 | ||
214 | /* Dump functions */ | |
215 | ||
216 | const char *dbg_ntype(int type); | |
217 | const char *dbg_cstate(int cmt_state); | |
218 | const char *dbg_get_key_dump(const struct ubifs_info *c, | |
219 | const union ubifs_key *key); | |
220 | void dbg_dump_inode(const struct ubifs_info *c, const struct inode *inode); | |
221 | void dbg_dump_node(const struct ubifs_info *c, const void *node); | |
222 | void dbg_dump_budget_req(const struct ubifs_budget_req *req); | |
223 | void dbg_dump_lstats(const struct ubifs_lp_stats *lst); | |
224 | void dbg_dump_budg(struct ubifs_info *c); | |
225 | void dbg_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp); | |
226 | void dbg_dump_lprops(struct ubifs_info *c); | |
227 | void dbg_dump_leb(const struct ubifs_info *c, int lnum); | |
228 | void dbg_dump_znode(const struct ubifs_info *c, | |
229 | const struct ubifs_znode *znode); | |
230 | void dbg_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat); | |
231 | void dbg_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode, | |
232 | struct ubifs_nnode *parent, int iip); | |
233 | void dbg_dump_tnc(struct ubifs_info *c); | |
234 | void dbg_dump_index(struct ubifs_info *c); | |
235 | ||
236 | /* Checking helper functions */ | |
237 | ||
238 | typedef int (*dbg_leaf_callback)(struct ubifs_info *c, | |
239 | struct ubifs_zbranch *zbr, void *priv); | |
240 | typedef int (*dbg_znode_callback)(struct ubifs_info *c, | |
241 | struct ubifs_znode *znode, void *priv); | |
1e51764a AB |
242 | int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb, |
243 | dbg_znode_callback znode_cb, void *priv); | |
244 | ||
245 | /* Checking functions */ | |
246 | ||
247 | int dbg_check_lprops(struct ubifs_info *c); | |
1e51764a AB |
248 | int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot); |
249 | int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot); | |
1e51764a | 250 | int dbg_check_cats(struct ubifs_info *c); |
1e51764a | 251 | int dbg_check_ltab(struct ubifs_info *c); |
1e51764a | 252 | int dbg_check_synced_i_size(struct inode *inode); |
1e51764a | 253 | int dbg_check_dir_size(struct ubifs_info *c, const struct inode *dir); |
1e51764a | 254 | int dbg_check_tnc(struct ubifs_info *c, int extra); |
1e51764a | 255 | int dbg_check_idx_size(struct ubifs_info *c, long long idx_size); |
1e51764a | 256 | int dbg_check_filesystem(struct ubifs_info *c); |
1e51764a AB |
257 | void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat, |
258 | int add_pos); | |
1e51764a AB |
259 | int dbg_check_lprops(struct ubifs_info *c); |
260 | int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode, | |
261 | int row, int col); | |
262 | ||
263 | /* Force the use of in-the-gaps method for testing */ | |
264 | ||
265 | #define dbg_force_in_the_gaps_enabled \ | |
266 | (ubifs_tst_flags & UBIFS_TST_FORCE_IN_THE_GAPS) | |
267 | ||
268 | int dbg_force_in_the_gaps(void); | |
269 | ||
270 | /* Failure mode for recovery testing */ | |
271 | ||
272 | #define dbg_failure_mode (ubifs_tst_flags & UBIFS_TST_RCVRY) | |
273 | ||
274 | void dbg_failure_mode_registration(struct ubifs_info *c); | |
275 | void dbg_failure_mode_deregistration(struct ubifs_info *c); | |
276 | ||
277 | #ifndef UBIFS_DBG_PRESERVE_UBI | |
278 | ||
279 | #define ubi_leb_read dbg_leb_read | |
280 | #define ubi_leb_write dbg_leb_write | |
281 | #define ubi_leb_change dbg_leb_change | |
282 | #define ubi_leb_erase dbg_leb_erase | |
283 | #define ubi_leb_unmap dbg_leb_unmap | |
284 | #define ubi_is_mapped dbg_is_mapped | |
285 | #define ubi_leb_map dbg_leb_map | |
286 | ||
287 | #endif | |
288 | ||
289 | int dbg_leb_read(struct ubi_volume_desc *desc, int lnum, char *buf, int offset, | |
290 | int len, int check); | |
291 | int dbg_leb_write(struct ubi_volume_desc *desc, int lnum, const void *buf, | |
292 | int offset, int len, int dtype); | |
293 | int dbg_leb_change(struct ubi_volume_desc *desc, int lnum, const void *buf, | |
294 | int len, int dtype); | |
295 | int dbg_leb_erase(struct ubi_volume_desc *desc, int lnum); | |
296 | int dbg_leb_unmap(struct ubi_volume_desc *desc, int lnum); | |
297 | int dbg_is_mapped(struct ubi_volume_desc *desc, int lnum); | |
298 | int dbg_leb_map(struct ubi_volume_desc *desc, int lnum, int dtype); | |
299 | ||
300 | static inline int dbg_read(struct ubi_volume_desc *desc, int lnum, char *buf, | |
301 | int offset, int len) | |
302 | { | |
303 | return dbg_leb_read(desc, lnum, buf, offset, len, 0); | |
304 | } | |
305 | ||
306 | static inline int dbg_write(struct ubi_volume_desc *desc, int lnum, | |
307 | const void *buf, int offset, int len) | |
308 | { | |
309 | return dbg_leb_write(desc, lnum, buf, offset, len, UBI_UNKNOWN); | |
310 | } | |
311 | ||
312 | static inline int dbg_change(struct ubi_volume_desc *desc, int lnum, | |
313 | const void *buf, int len) | |
314 | { | |
315 | return dbg_leb_change(desc, lnum, buf, len, UBI_UNKNOWN); | |
316 | } | |
317 | ||
318 | #else /* !CONFIG_UBIFS_FS_DEBUG */ | |
319 | ||
320 | #define UBIFS_DBG(op) | |
840dc6b8 AB |
321 | |
322 | /* Use "if (0)" to make compiler check arguments even if debugging is off */ | |
323 | #define ubifs_assert(expr) do { \ | |
324 | if (0 && (expr)) \ | |
325 | printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \ | |
326 | __func__, __LINE__, current->pid); \ | |
327 | } while (0) | |
328 | ||
329 | #define dbg_err(fmt, ...) do { \ | |
330 | if (0) \ | |
331 | ubifs_err(fmt, ##__VA_ARGS__); \ | |
332 | } while (0) | |
333 | ||
334 | #define dbg_msg(fmt, ...) do { \ | |
335 | if (0) \ | |
336 | printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", \ | |
337 | current->pid, __func__, ##__VA_ARGS__); \ | |
338 | } while (0) | |
339 | ||
1e51764a | 340 | #define dbg_dump_stack() |
840dc6b8 | 341 | #define ubifs_assert_cmt_locked(c) |
1e51764a | 342 | |
840dc6b8 AB |
343 | #define dbg_gen(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) |
344 | #define dbg_jnl(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
345 | #define dbg_tnc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
346 | #define dbg_lp(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
347 | #define dbg_find(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
348 | #define dbg_mnt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
349 | #define dbg_io(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
350 | #define dbg_cmt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
351 | #define dbg_budg(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
352 | #define dbg_log(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
353 | #define dbg_gc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
354 | #define dbg_scan(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
355 | #define dbg_rcvry(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__) | |
356 | ||
357 | #define DBGKEY(key) ((char *)(key)) | |
358 | #define DBGKEY1(key) ((char *)(key)) | |
359 | ||
360 | #define dbg_ntype(type) "" | |
361 | #define dbg_cstate(cmt_state) "" | |
362 | #define dbg_get_key_dump(c, key) ({}) | |
363 | #define dbg_dump_inode(c, inode) ({}) | |
364 | #define dbg_dump_node(c, node) ({}) | |
365 | #define dbg_dump_budget_req(req) ({}) | |
366 | #define dbg_dump_lstats(lst) ({}) | |
367 | #define dbg_dump_budg(c) ({}) | |
368 | #define dbg_dump_lprop(c, lp) ({}) | |
369 | #define dbg_dump_lprops(c) ({}) | |
370 | #define dbg_dump_leb(c, lnum) ({}) | |
371 | #define dbg_dump_znode(c, znode) ({}) | |
372 | #define dbg_dump_heap(c, heap, cat) ({}) | |
373 | #define dbg_dump_pnode(c, pnode, parent, iip) ({}) | |
374 | #define dbg_dump_tnc(c) ({}) | |
375 | #define dbg_dump_index(c) ({}) | |
1e51764a | 376 | |
840dc6b8 | 377 | #define dbg_walk_index(c, leaf_cb, znode_cb, priv) 0 |
1e51764a AB |
378 | #define dbg_old_index_check_init(c, zroot) 0 |
379 | #define dbg_check_old_index(c, zroot) 0 | |
1e51764a | 380 | #define dbg_check_cats(c) 0 |
1e51764a | 381 | #define dbg_check_ltab(c) 0 |
1e51764a | 382 | #define dbg_check_synced_i_size(inode) 0 |
1e51764a | 383 | #define dbg_check_dir_size(c, dir) 0 |
1e51764a | 384 | #define dbg_check_tnc(c, x) 0 |
1e51764a | 385 | #define dbg_check_idx_size(c, idx_size) 0 |
1e51764a | 386 | #define dbg_check_filesystem(c) 0 |
1e51764a | 387 | #define dbg_check_heap(c, heap, cat, add_pos) ({}) |
1e51764a AB |
388 | #define dbg_check_lprops(c) 0 |
389 | #define dbg_check_lpt_nodes(c, cnode, row, col) 0 | |
1e51764a AB |
390 | #define dbg_force_in_the_gaps_enabled 0 |
391 | #define dbg_force_in_the_gaps() 0 | |
1e51764a AB |
392 | #define dbg_failure_mode 0 |
393 | #define dbg_failure_mode_registration(c) ({}) | |
394 | #define dbg_failure_mode_deregistration(c) ({}) | |
395 | ||
396 | #endif /* !CONFIG_UBIFS_FS_DEBUG */ | |
397 | ||
398 | #endif /* !__UBIFS_DEBUG_H__ */ |