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