blob: 4fd9be4cbc984a56b6b8bbb85c3d97d8c8a3166c [file] [log] [blame]
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +01001/*
2 * JFFS2 -- Journalling Flash File System, Version 2.
3 *
David Woodhousec00c3102007-04-25 14:16:47 +01004 * Copyright © 2001-2007 Red Hat, Inc.
David Woodhouse6088c052010-08-08 14:15:22 +01005 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +01006 *
7 * Created by David Woodhouse <dwmw2@infradead.org>
8 *
9 * For licensing information, see the file 'LICENCE' in this directory.
10 *
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010011 */
David Woodhousec00c3102007-04-25 14:16:47 +010012
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010013#ifndef _JFFS2_DEBUG_H_
14#define _JFFS2_DEBUG_H_
15
David Woodhousee499e012007-01-13 08:19:03 +080016#include <linux/sched.h>
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010017
18#ifndef CONFIG_JFFS2_FS_DEBUG
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +010019#define CONFIG_JFFS2_FS_DEBUG 0
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010020#endif
21
Artem B. Bityutskiy008531f2005-10-24 17:22:36 +010022#if CONFIG_JFFS2_FS_DEBUG > 0
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010023/* Enable "paranoia" checks and dumps */
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010024#define JFFS2_DBG_PARANOIA_CHECKS
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010025#define JFFS2_DBG_DUMPS
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +010026
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000027/*
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +010028 * By defining/undefining the below macros one may select debugging messages
29 * fro specific JFFS2 subsystems.
30 */
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010031#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
Ferenc Havasie631ddba2005-09-07 09:35:26 +010036#define JFFS2_DBG_SUMMARY_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +010037#define JFFS2_DBG_FSBUILD_MESSAGES
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010038#endif
39
Artem B. Bityutskiy008531f2005-10-24 17:22:36 +010040#if CONFIG_JFFS2_FS_DEBUG > 1
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010041#define JFFS2_DBG_FRAGTREE2_MESSAGES
David Woodhouse2c61cb22008-04-23 16:43:15 +010042#define JFFS2_DBG_READINODE2_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +010043#define JFFS2_DBG_MEMALLOC_MESSAGES
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010044#endif
45
Artem B. Bityutskiy45ca1b52005-08-05 12:43:47 +010046/* Sanity checks are supposed to be light-weight and enabled by default */
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010047#define JFFS2_DBG_SANITY_CHECKS
48
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000049/*
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010050 * Dx() are mainly used for debugging messages, they must go away and be
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +010051 * superseded by nicer dbg_xxx() macros...
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010052 */
53#if CONFIG_JFFS2_FS_DEBUG > 0
Joe Perches9c261b32012-02-15 15:56:43 -080054#define DEBUG
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010055#define D1(x) x
56#else
57#define D1(x)
58#endif
59
60#if CONFIG_JFFS2_FS_DEBUG > 1
61#define D2(x) x
62#else
63#define D2(x)
64#endif
65
Joe Perches9c261b32012-02-15 15:56:43 -080066#define jffs2_dbg(level, fmt, ...) \
67do { \
68 if (CONFIG_JFFS2_FS_DEBUG >= level) \
69 pr_debug(fmt, ##__VA_ARGS__); \
70} while (0)
71
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010072/* The prefixes of JFFS2 messages */
Joe Perches9bbf29e2012-02-15 15:56:46 -080073#define JFFS2_DBG KERN_DEBUG
Artem B. Bityutskiy81e39cf2005-09-14 17:57:35 +010074#define JFFS2_DBG_PREFIX "[JFFS2 DBG]"
Artem B. Bityutskiy81e39cf2005-09-14 17:57:35 +010075#define JFFS2_DBG_MSG_PREFIX JFFS2_DBG JFFS2_DBG_PREFIX
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010076
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010077/* JFFS2 message macros */
Joe Perches9bbf29e2012-02-15 15:56:46 -080078#define JFFS2_ERROR(fmt, ...) \
79 pr_err("error: (%d) %s: " fmt, \
80 task_pid_nr(current), __func__, ##__VA_ARGS__)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010081
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010082#define JFFS2_WARNING(fmt, ...) \
Joe Perches9bbf29e2012-02-15 15:56:46 -080083 pr_warn("warning: (%d) %s: " fmt, \
84 task_pid_nr(current), __func__, ##__VA_ARGS__)
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000085
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010086#define JFFS2_NOTICE(fmt, ...) \
Joe Perches9bbf29e2012-02-15 15:56:46 -080087 pr_notice("notice: (%d) %s: " fmt, \
88 task_pid_nr(current), __func__, ##__VA_ARGS__)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +010089
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010090#define JFFS2_DEBUG(fmt, ...) \
Joe Perches9bbf29e2012-02-15 15:56:46 -080091 printk(KERN_DEBUG "[JFFS2 DBG] (%d) %s: " fmt, \
92 task_pid_nr(current), __func__, ##__VA_ARGS__)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010093
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000094/*
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +010095 * We split our debugging messages on several parts, depending on the JFFS2
96 * subsystem the message belongs to.
97 */
98/* Read inode debugging messages */
99#ifdef JFFS2_DBG_READINODE_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100100#define dbg_readinode(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100101#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100102#define dbg_readinode(fmt, ...)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100103#endif
David Woodhouse2c61cb22008-04-23 16:43:15 +0100104#ifdef JFFS2_DBG_READINODE2_MESSAGES
105#define dbg_readinode2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
106#else
107#define dbg_readinode2(fmt, ...)
108#endif
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100109
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100110/* Fragtree build debugging messages */
111#ifdef JFFS2_DBG_FRAGTREE_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100112#define dbg_fragtree(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100113#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100114#define dbg_fragtree(fmt, ...)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100115#endif
Artem B. Bityutskiye0e3006f2005-07-31 10:08:41 +0100116#ifdef JFFS2_DBG_FRAGTREE2_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100117#define dbg_fragtree2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiye0e3006f2005-07-31 10:08:41 +0100118#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100119#define dbg_fragtree2(fmt, ...)
Artem B. Bityutskiye0e3006f2005-07-31 10:08:41 +0100120#endif
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100121
122/* Directory entry list manilulation debugging messages */
123#ifdef JFFS2_DBG_DENTLIST_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100124#define dbg_dentlist(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100125#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100126#define dbg_dentlist(fmt, ...)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100127#endif
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100128
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +0100129/* Print the messages about manipulating node_refs */
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100130#ifdef JFFS2_DBG_NODEREF_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100131#define dbg_noderef(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100132#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100133#define dbg_noderef(fmt, ...)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100134#endif
135
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +0100136/* Manipulations with the list of inodes (JFFS2 inocache) */
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100137#ifdef JFFS2_DBG_INOCACHE_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100138#define dbg_inocache(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100139#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100140#define dbg_inocache(fmt, ...)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100141#endif
142
Ferenc Havasie631ddba2005-09-07 09:35:26 +0100143/* Summary debugging messages */
144#ifdef JFFS2_DBG_SUMMARY_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100145#define dbg_summary(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Ferenc Havasie631ddba2005-09-07 09:35:26 +0100146#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100147#define dbg_summary(fmt, ...)
148#endif
149
150/* File system build messages */
151#ifdef JFFS2_DBG_FSBUILD_MESSAGES
152#define dbg_fsbuild(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
153#else
154#define dbg_fsbuild(fmt, ...)
Ferenc Havasie631ddba2005-09-07 09:35:26 +0100155#endif
156
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +0100157/* Watch the object allocations */
158#ifdef JFFS2_DBG_MEMALLOC_MESSAGES
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100159#define dbg_memalloc(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +0100160#else
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +0100161#define dbg_memalloc(fmt, ...)
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +0100162#endif
163
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900164/* Watch the XATTR subsystem */
165#ifdef JFFS2_DBG_XATTR_MESSAGES
166#define dbg_xattr(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
167#else
168#define dbg_xattr(fmt, ...)
169#endif
Artem B. Bityutskiyf538c962005-07-27 15:16:57 +0100170
Artem B. Bityutskiy45ca1b52005-08-05 12:43:47 +0100171/* "Sanity" checks */
172void
173__jffs2_dbg_acct_sanity_check_nolock(struct jffs2_sb_info *c,
174 struct jffs2_eraseblock *jeb);
175void
176__jffs2_dbg_acct_sanity_check(struct jffs2_sb_info *c,
177 struct jffs2_eraseblock *jeb);
178
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100179/* "Paranoia" checks */
180void
181__jffs2_dbg_fragtree_paranoia_check(struct jffs2_inode_info *f);
182void
183__jffs2_dbg_fragtree_paranoia_check_nolock(struct jffs2_inode_info *f);
184void
185__jffs2_dbg_acct_paranoia_check(struct jffs2_sb_info *c,
186 struct jffs2_eraseblock *jeb);
187void
188__jffs2_dbg_acct_paranoia_check_nolock(struct jffs2_sb_info *c,
189 struct jffs2_eraseblock *jeb);
190void
191__jffs2_dbg_prewrite_paranoia_check(struct jffs2_sb_info *c,
192 uint32_t ofs, int len);
193
194/* "Dump" functions */
195void
196__jffs2_dbg_dump_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
197void
198__jffs2_dbg_dump_jeb_nolock(struct jffs2_eraseblock *jeb);
199void
200__jffs2_dbg_dump_block_lists(struct jffs2_sb_info *c);
201void
202__jffs2_dbg_dump_block_lists_nolock(struct jffs2_sb_info *c);
203void
204__jffs2_dbg_dump_node_refs(struct jffs2_sb_info *c,
205 struct jffs2_eraseblock *jeb);
206void
207__jffs2_dbg_dump_node_refs_nolock(struct jffs2_sb_info *c,
208 struct jffs2_eraseblock *jeb);
209void
210__jffs2_dbg_dump_fragtree(struct jffs2_inode_info *f);
211void
212__jffs2_dbg_dump_fragtree_nolock(struct jffs2_inode_info *f);
213void
214__jffs2_dbg_dump_buffer(unsigned char *buf, int len, uint32_t offs);
215void
216__jffs2_dbg_dump_node(struct jffs2_sb_info *c, uint32_t ofs);
217
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100218#ifdef JFFS2_DBG_PARANOIA_CHECKS
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100219#define jffs2_dbg_fragtree_paranoia_check(f) \
220 __jffs2_dbg_fragtree_paranoia_check(f)
221#define jffs2_dbg_fragtree_paranoia_check_nolock(f) \
222 __jffs2_dbg_fragtree_paranoia_check_nolock(f)
223#define jffs2_dbg_acct_paranoia_check(c, jeb) \
224 __jffs2_dbg_acct_paranoia_check(c,jeb)
225#define jffs2_dbg_acct_paranoia_check_nolock(c, jeb) \
226 __jffs2_dbg_acct_paranoia_check_nolock(c,jeb)
227#define jffs2_dbg_prewrite_paranoia_check(c, ofs, len) \
228 __jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100229#else
230#define jffs2_dbg_fragtree_paranoia_check(f)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100231#define jffs2_dbg_fragtree_paranoia_check_nolock(f)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100232#define jffs2_dbg_acct_paranoia_check(c, jeb)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100233#define jffs2_dbg_acct_paranoia_check_nolock(c, jeb)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100234#define jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
235#endif /* !JFFS2_PARANOIA_CHECKS */
236
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100237#ifdef JFFS2_DBG_DUMPS
238#define jffs2_dbg_dump_jeb(c, jeb) \
239 __jffs2_dbg_dump_jeb(c, jeb);
240#define jffs2_dbg_dump_jeb_nolock(jeb) \
241 __jffs2_dbg_dump_jeb_nolock(jeb);
242#define jffs2_dbg_dump_block_lists(c) \
243 __jffs2_dbg_dump_block_lists(c)
244#define jffs2_dbg_dump_block_lists_nolock(c) \
245 __jffs2_dbg_dump_block_lists_nolock(c)
246#define jffs2_dbg_dump_fragtree(f) \
247 __jffs2_dbg_dump_fragtree(f);
248#define jffs2_dbg_dump_fragtree_nolock(f) \
249 __jffs2_dbg_dump_fragtree_nolock(f);
250#define jffs2_dbg_dump_buffer(buf, len, offs) \
251 __jffs2_dbg_dump_buffer(*buf, len, offs);
252#define jffs2_dbg_dump_node(c, ofs) \
253 __jffs2_dbg_dump_node(c, ofs);
254#else
255#define jffs2_dbg_dump_jeb(c, jeb)
256#define jffs2_dbg_dump_jeb_nolock(jeb)
257#define jffs2_dbg_dump_block_lists(c)
258#define jffs2_dbg_dump_block_lists_nolock(c)
259#define jffs2_dbg_dump_fragtree(f)
260#define jffs2_dbg_dump_fragtree_nolock(f)
261#define jffs2_dbg_dump_buffer(buf, len, offs)
262#define jffs2_dbg_dump_node(c, ofs)
263#endif /* !JFFS2_DBG_DUMPS */
264
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100265#ifdef JFFS2_DBG_SANITY_CHECKS
Artem B. Bityutskiy45ca1b52005-08-05 12:43:47 +0100266#define jffs2_dbg_acct_sanity_check(c, jeb) \
267 __jffs2_dbg_acct_sanity_check(c, jeb)
268#define jffs2_dbg_acct_sanity_check_nolock(c, jeb) \
269 __jffs2_dbg_acct_sanity_check_nolock(c, jeb)
Artem B. Bityutskiye0c8e422005-07-24 16:14:17 +0100270#else
271#define jffs2_dbg_acct_sanity_check(c, jeb)
272#define jffs2_dbg_acct_sanity_check_nolock(c, jeb)
Artem B. Bityutskiy730554d2005-07-17 07:56:26 +0100273#endif /* !JFFS2_DBG_SANITY_CHECKS */
274
275#endif /* _JFFS2_DEBUG_H_ */