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