Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 *
10 * $Id: debug.h,v 1.21 2005/11/07 11:14:39 gleixner Exp $
11 *
12 */
13#ifndef _JFFS2_DEBUG_H_
14#define _JFFS2_DEBUG_H_
15
16#include <linux/sched.h>
17
18#ifndef CONFIG_JFFS2_FS_DEBUG
19#define CONFIG_JFFS2_FS_DEBUG 0
20#endif
21
22#if CONFIG_JFFS2_FS_DEBUG > 0
23/* Enable "paranoia" checks and dumps */
24#define JFFS2_DBG_PARANOIA_CHECKS
25#define JFFS2_DBG_DUMPS
26
27/*
28 * By defining/undefining the below macros one may select debugging messages
29 * fro specific JFFS2 subsystems.
30 */
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
38#endif
39
40#if CONFIG_JFFS2_FS_DEBUG > 1
41#define JFFS2_DBG_FRAGTREE2_MESSAGES
42#define JFFS2_DBG_MEMALLOC_MESSAGES
43#endif
44
45/* Sanity checks are supposed to be light-weight and enabled by default */
46#define JFFS2_DBG_SANITY_CHECKS
47
48/*
49 * Dx() are mainly used for debugging messages, they must go away and be
50 * superseded by nicer dbg_xxx() macros...
51 */
52#if CONFIG_JFFS2_FS_DEBUG > 0
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
64/* The prefixes of JFFS2 messages */
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:"
69
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
79
80/* JFFS2 message macros */
81#define JFFS2_ERROR(fmt, ...) \
82 do { \
83 printk(JFFS2_ERR_MSG_PREFIX \
84 " (%d) %s: " fmt, current->pid, \
85 __FUNCTION__ , ##__VA_ARGS__); \
86 } while(0)
87
88#define JFFS2_WARNING(fmt, ...) \
89 do { \
90 printk(JFFS2_WARN_MSG_PREFIX \
91 " (%d) %s: " fmt, current->pid, \
92 __FUNCTION__ , ##__VA_ARGS__); \
93 } while(0)
94
95#define JFFS2_NOTICE(fmt, ...) \
96 do { \
97 printk(JFFS2_NOTICE_MSG_PREFIX \
98 " (%d) %s: " fmt, current->pid, \
99 __FUNCTION__ , ##__VA_ARGS__); \
100 } while(0)
101
102#define JFFS2_DEBUG(fmt, ...) \
103 do { \
104 printk(JFFS2_DBG_MSG_PREFIX \
105 " (%d) %s: " fmt, current->pid, \
106 __FUNCTION__ , ##__VA_ARGS__); \
107 } while(0)
108
109/*
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
115#define dbg_readinode(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
116#else
117#define dbg_readinode(fmt, ...)
118#endif
119
120/* Fragtree build debugging messages */
121#ifdef JFFS2_DBG_FRAGTREE_MESSAGES
122#define dbg_fragtree(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
123#else
124#define dbg_fragtree(fmt, ...)
125#endif
126#ifdef JFFS2_DBG_FRAGTREE2_MESSAGES
127#define dbg_fragtree2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
128#else
129#define dbg_fragtree2(fmt, ...)
130#endif
131
132/* Directory entry list manilulation debugging messages */
133#ifdef JFFS2_DBG_DENTLIST_MESSAGES
134#define dbg_dentlist(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
135#else
136#define dbg_dentlist(fmt, ...)
137#endif
138
139/* Print the messages about manipulating node_refs */
140#ifdef JFFS2_DBG_NODEREF_MESSAGES
141#define dbg_noderef(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
142#else
143#define dbg_noderef(fmt, ...)
144#endif
145
146/* Manipulations with the list of inodes (JFFS2 inocache) */
147#ifdef JFFS2_DBG_INOCACHE_MESSAGES
148#define dbg_inocache(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
149#else
150#define dbg_inocache(fmt, ...)
151#endif
152
153/* Summary debugging messages */
154#ifdef JFFS2_DBG_SUMMARY_MESSAGES
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__)
163#else
164#define dbg_fsbuild(fmt, ...)
165#endif
166
167/* Watch the object allocations */
168#ifdef JFFS2_DBG_MEMALLOC_MESSAGES
169#define dbg_memalloc(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
170#else
171#define dbg_memalloc(fmt, ...)
172#endif
173
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
180
181/* "Sanity" checks */
182void
183__jffs2_dbg_acct_sanity_check_nolock(struct jffs2_sb_info *c,
184 struct jffs2_eraseblock *jeb);
185void
186__jffs2_dbg_acct_sanity_check(struct jffs2_sb_info *c,
187 struct jffs2_eraseblock *jeb);
188
189/* "Paranoia" checks */
190void
191__jffs2_dbg_fragtree_paranoia_check(struct jffs2_inode_info *f);
192void
193__jffs2_dbg_fragtree_paranoia_check_nolock(struct jffs2_inode_info *f);
194void
195__jffs2_dbg_acct_paranoia_check(struct jffs2_sb_info *c,
196 struct jffs2_eraseblock *jeb);
197void
198__jffs2_dbg_acct_paranoia_check_nolock(struct jffs2_sb_info *c,
199 struct jffs2_eraseblock *jeb);
200void
201__jffs2_dbg_prewrite_paranoia_check(struct jffs2_sb_info *c,
202 uint32_t ofs, int len);
203
204/* "Dump" functions */
205void
206__jffs2_dbg_dump_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
207void
208__jffs2_dbg_dump_jeb_nolock(struct jffs2_eraseblock *jeb);
209void
210__jffs2_dbg_dump_block_lists(struct jffs2_sb_info *c);
211void
212__jffs2_dbg_dump_block_lists_nolock(struct jffs2_sb_info *c);
213void
214__jffs2_dbg_dump_node_refs(struct jffs2_sb_info *c,
215 struct jffs2_eraseblock *jeb);
216void
217__jffs2_dbg_dump_node_refs_nolock(struct jffs2_sb_info *c,
218 struct jffs2_eraseblock *jeb);
219void
220__jffs2_dbg_dump_fragtree(struct jffs2_inode_info *f);
221void
222__jffs2_dbg_dump_fragtree_nolock(struct jffs2_inode_info *f);
223void
224__jffs2_dbg_dump_buffer(unsigned char *buf, int len, uint32_t offs);
225void
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)
239#else
240#define jffs2_dbg_fragtree_paranoia_check(f)
241#define jffs2_dbg_fragtree_paranoia_check_nolock(f)
242#define jffs2_dbg_acct_paranoia_check(c, jeb)
243#define jffs2_dbg_acct_paranoia_check_nolock(c, jeb)
244#define jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
245#endif /* !JFFS2_PARANOIA_CHECKS */
246
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
275#ifdef JFFS2_DBG_SANITY_CHECKS
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)
280#else
281#define jffs2_dbg_acct_sanity_check(c, jeb)
282#define jffs2_dbg_acct_sanity_check_nolock(c, jeb)
283#endif /* !JFFS2_DBG_SANITY_CHECKS */
284
285#endif /* _JFFS2_DEBUG_H_ */