[linux.git] / fs / ubifs / debug.h

/*
 * This file is part of UBIFS.
 *
 * Copyright (C) 2006-2008 Nokia Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * Authors: Artem Bityutskiy (Битюцкий Артём)
 *          Adrian Hunter
 */

#ifndef __UBIFS_DEBUG_H__
#define __UBIFS_DEBUG_H__

#ifdef CONFIG_UBIFS_FS_DEBUG

/**
 * ubifs_debug_info - per-FS debugging information.
 * @old_zroot: old index root - used by 'dbg_check_old_index()'
 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
 * @failure_mode: failure mode for recovery testing
 * @fail_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
 * @fail_timeout: time in jiffies when delay of failure mode expires
 * @fail_cnt: current number of calls to failure mode I/O functions
 * @fail_cnt_max: number of calls by which to delay failure mode
 * @chk_lpt_sz: used by LPT tree size checker
 * @chk_lpt_sz2: used by LPT tree size checker
 * @chk_lpt_wastage: used by LPT tree size checker
 * @chk_lpt_lebs: used by LPT tree size checker
 * @new_nhead_offs: used by LPT tree size checker
 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
 * @new_ihead_offs: used by debugging to check @c->ihead_offs
 *
 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
 * @saved_free: saved free space (used by 'dbg_save_space_info()')
 *
 * dfs_dir_name: name of debugfs directory containing this file-system's files
 * dfs_dir: direntry object of the file-system debugfs directory
 * dfs_dump_lprops: "dump lprops" debugfs knob
 * dfs_dump_budg: "dump budgeting information" debugfs knob
 * dfs_dump_tnc: "dump TNC" debugfs knob
 */
struct ubifs_debug_info {
	struct ubifs_zbranch old_zroot;
	int old_zroot_level;
	unsigned long long old_zroot_sqnum;
	int failure_mode;
	int fail_delay;
	unsigned long fail_timeout;
	unsigned int fail_cnt;
	unsigned int fail_cnt_max;
	long long chk_lpt_sz;
	long long chk_lpt_sz2;
	long long chk_lpt_wastage;
	int chk_lpt_lebs;
	int new_nhead_offs;
	int new_ihead_lnum;
	int new_ihead_offs;

	struct ubifs_lp_stats saved_lst;
	long long saved_free;

	char dfs_dir_name[100];
	struct dentry *dfs_dir;
	struct dentry *dfs_dump_lprops;
	struct dentry *dfs_dump_budg;
	struct dentry *dfs_dump_tnc;
};

#define ubifs_assert(expr) do {                                                \
	if (unlikely(!(expr))) {                                               \
		printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
		       __func__, __LINE__, current->pid);                      \
		dbg_dump_stack();                                              \
	}                                                                      \
} while (0)

#define ubifs_assert_cmt_locked(c) do {                                        \
	if (unlikely(down_write_trylock(&(c)->commit_sem))) {                  \
		up_write(&(c)->commit_sem);                                    \
		printk(KERN_CRIT "commit lock is not locked!\n");              \
		ubifs_assert(0);                                               \
	}                                                                      \
} while (0)

#define dbg_dump_stack() do {                                                  \
	if (!dbg_failure_mode)                                                 \
		dump_stack();                                                  \
} while (0)

/* Generic debugging messages */
#define dbg_msg(fmt, ...) do {                                                 \
	spin_lock(&dbg_lock);                                                  \
	printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid,   \
	       __func__, ##__VA_ARGS__);                                       \
	spin_unlock(&dbg_lock);                                                \
} while (0)

#define dbg_do_msg(typ, fmt, ...) do {                                         \
	if (ubifs_msg_flags & typ)                                             \
		dbg_msg(fmt, ##__VA_ARGS__);                                   \
} while (0)

#define dbg_err(fmt, ...) do {                                                 \
	spin_lock(&dbg_lock);                                                  \
	ubifs_err(fmt, ##__VA_ARGS__);                                         \
	spin_unlock(&dbg_lock);                                                \
} while (0)

const char *dbg_key_str0(const struct ubifs_info *c,
			 const union ubifs_key *key);
const char *dbg_key_str1(const struct ubifs_info *c,
			 const union ubifs_key *key);

/*
 * DBGKEY macros require @dbg_lock to be held, which it is in the dbg message
 * macros.
 */
#define DBGKEY(key) dbg_key_str0(c, (key))
#define DBGKEY1(key) dbg_key_str1(c, (key))

/* General messages */
#define dbg_gen(fmt, ...)   dbg_do_msg(UBIFS_MSG_GEN, fmt, ##__VA_ARGS__)

/* Additional journal messages */
#define dbg_jnl(fmt, ...)   dbg_do_msg(UBIFS_MSG_JNL, fmt, ##__VA_ARGS__)

/* Additional TNC messages */
#define dbg_tnc(fmt, ...)   dbg_do_msg(UBIFS_MSG_TNC, fmt, ##__VA_ARGS__)

/* Additional lprops messages */
#define dbg_lp(fmt, ...)    dbg_do_msg(UBIFS_MSG_LP, fmt, ##__VA_ARGS__)

/* Additional LEB find messages */
#define dbg_find(fmt, ...)  dbg_do_msg(UBIFS_MSG_FIND, fmt, ##__VA_ARGS__)

/* Additional mount messages */
#define dbg_mnt(fmt, ...)   dbg_do_msg(UBIFS_MSG_MNT, fmt, ##__VA_ARGS__)

/* Additional I/O messages */
#define dbg_io(fmt, ...)    dbg_do_msg(UBIFS_MSG_IO, fmt, ##__VA_ARGS__)

/* Additional commit messages */
#define dbg_cmt(fmt, ...)   dbg_do_msg(UBIFS_MSG_CMT, fmt, ##__VA_ARGS__)

/* Additional budgeting messages */
#define dbg_budg(fmt, ...)  dbg_do_msg(UBIFS_MSG_BUDG, fmt, ##__VA_ARGS__)

/* Additional log messages */
#define dbg_log(fmt, ...)   dbg_do_msg(UBIFS_MSG_LOG, fmt, ##__VA_ARGS__)

/* Additional gc messages */
#define dbg_gc(fmt, ...)    dbg_do_msg(UBIFS_MSG_GC, fmt, ##__VA_ARGS__)

/* Additional scan messages */
#define dbg_scan(fmt, ...)  dbg_do_msg(UBIFS_MSG_SCAN, fmt, ##__VA_ARGS__)

/* Additional recovery messages */
#define dbg_rcvry(fmt, ...) dbg_do_msg(UBIFS_MSG_RCVRY, fmt, ##__VA_ARGS__)

/*
 * Debugging message type flags (must match msg_type_names in debug.c).
 *
 * UBIFS_MSG_GEN: general messages
 * UBIFS_MSG_JNL: journal messages
 * UBIFS_MSG_MNT: mount messages
 * UBIFS_MSG_CMT: commit messages
 * UBIFS_MSG_FIND: LEB find messages
 * UBIFS_MSG_BUDG: budgeting messages
 * UBIFS_MSG_GC: garbage collection messages
 * UBIFS_MSG_TNC: TNC messages
 * UBIFS_MSG_LP: lprops messages
 * UBIFS_MSG_IO: I/O messages
 * UBIFS_MSG_LOG: log messages
 * UBIFS_MSG_SCAN: scan messages
 * UBIFS_MSG_RCVRY: recovery messages
 */
enum {
	UBIFS_MSG_GEN   = 0x1,
	UBIFS_MSG_JNL   = 0x2,
	UBIFS_MSG_MNT   = 0x4,
	UBIFS_MSG_CMT   = 0x8,
	UBIFS_MSG_FIND  = 0x10,
	UBIFS_MSG_BUDG  = 0x20,
	UBIFS_MSG_GC    = 0x40,
	UBIFS_MSG_TNC   = 0x80,
	UBIFS_MSG_LP    = 0x100,
	UBIFS_MSG_IO    = 0x200,
	UBIFS_MSG_LOG   = 0x400,
	UBIFS_MSG_SCAN  = 0x800,
	UBIFS_MSG_RCVRY = 0x1000,
};

/*
 * Debugging check flags (must match chk_names in debug.c).
 *
 * UBIFS_CHK_GEN: general checks
 * UBIFS_CHK_TNC: check TNC
 * UBIFS_CHK_IDX_SZ: check index size
 * UBIFS_CHK_ORPH: check orphans
 * UBIFS_CHK_OLD_IDX: check the old index
 * UBIFS_CHK_LPROPS: check lprops
 * UBIFS_CHK_FS: check the file-system
 */
enum {
	UBIFS_CHK_GEN     = 0x1,
	UBIFS_CHK_TNC     = 0x2,
	UBIFS_CHK_IDX_SZ  = 0x4,
	UBIFS_CHK_ORPH    = 0x8,
	UBIFS_CHK_OLD_IDX = 0x10,
	UBIFS_CHK_LPROPS  = 0x20,
	UBIFS_CHK_FS      = 0x40,
};

/*
 * Special testing flags (must match tst_names in debug.c).
 *
 * UBIFS_TST_FORCE_IN_THE_GAPS: force the use of in-the-gaps method
 * UBIFS_TST_RCVRY: failure mode for recovery testing
 */
enum {
	UBIFS_TST_FORCE_IN_THE_GAPS = 0x2,
	UBIFS_TST_RCVRY             = 0x4,
};

extern spinlock_t dbg_lock;

extern unsigned int ubifs_msg_flags;
extern unsigned int ubifs_chk_flags;
extern unsigned int ubifs_tst_flags;

int ubifs_debugging_init(struct ubifs_info *c);
void ubifs_debugging_exit(struct ubifs_info *c);

/* Dump functions */
const char *dbg_ntype(int type);
const char *dbg_cstate(int cmt_state);
const char *dbg_jhead(int jhead);
const char *dbg_get_key_dump(const struct ubifs_info *c,
			     const union ubifs_key *key);
void dbg_dump_inode(const struct ubifs_info *c, const struct inode *inode);
void dbg_dump_node(const struct ubifs_info *c, const void *node);
void dbg_dump_lpt_node(const struct ubifs_info *c, void *node, int lnum,
		       int offs);
void dbg_dump_budget_req(const struct ubifs_budget_req *req);
void dbg_dump_lstats(const struct ubifs_lp_stats *lst);
void dbg_dump_budg(struct ubifs_info *c);
void dbg_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp);
void dbg_dump_lprops(struct ubifs_info *c);
void dbg_dump_lpt_info(struct ubifs_info *c);
void dbg_dump_leb(const struct ubifs_info *c, int lnum);
void dbg_dump_znode(const struct ubifs_info *c,
		    const struct ubifs_znode *znode);
void dbg_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat);
void dbg_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
		    struct ubifs_nnode *parent, int iip);
void dbg_dump_tnc(struct ubifs_info *c);
void dbg_dump_index(struct ubifs_info *c);
void dbg_dump_lpt_lebs(const struct ubifs_info *c);

/* Checking helper functions */
typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
				 struct ubifs_zbranch *zbr, void *priv);
typedef int (*dbg_znode_callback)(struct ubifs_info *c,
				  struct ubifs_znode *znode, void *priv);
int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
		   dbg_znode_callback znode_cb, void *priv);

/* Checking functions */
void dbg_save_space_info(struct ubifs_info *c);
int dbg_check_space_info(struct ubifs_info *c);
int dbg_check_lprops(struct ubifs_info *c);
int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
int dbg_check_cats(struct ubifs_info *c);
int dbg_check_ltab(struct ubifs_info *c);
int dbg_chk_lpt_free_spc(struct ubifs_info *c);
int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
int dbg_check_synced_i_size(struct inode *inode);
int dbg_check_dir_size(struct ubifs_info *c, const struct inode *dir);
int dbg_check_tnc(struct ubifs_info *c, int extra);
int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
int dbg_check_filesystem(struct ubifs_info *c);
void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
		    int add_pos);
int dbg_check_lprops(struct ubifs_info *c);
int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
			int row, int col);
int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
			 loff_t size);
int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);

/* Force the use of in-the-gaps method for testing */

#define dbg_force_in_the_gaps_enabled \
	(ubifs_tst_flags & UBIFS_TST_FORCE_IN_THE_GAPS)

int dbg_force_in_the_gaps(void);

/* Failure mode for recovery testing */

#define dbg_failure_mode (ubifs_tst_flags & UBIFS_TST_RCVRY)

#ifndef UBIFS_DBG_PRESERVE_UBI

#define ubi_leb_read   dbg_leb_read
#define ubi_leb_write  dbg_leb_write
#define ubi_leb_change dbg_leb_change
#define ubi_leb_erase  dbg_leb_erase
#define ubi_leb_unmap  dbg_leb_unmap
#define ubi_is_mapped  dbg_is_mapped
#define ubi_leb_map    dbg_leb_map

#endif

int dbg_leb_read(struct ubi_volume_desc *desc, int lnum, char *buf, int offset,
		 int len, int check);
int dbg_leb_write(struct ubi_volume_desc *desc, int lnum, const void *buf,
		  int offset, int len, int dtype);
int dbg_leb_change(struct ubi_volume_desc *desc, int lnum, const void *buf,
		   int len, int dtype);
int dbg_leb_erase(struct ubi_volume_desc *desc, int lnum);
int dbg_leb_unmap(struct ubi_volume_desc *desc, int lnum);
int dbg_is_mapped(struct ubi_volume_desc *desc, int lnum);
int dbg_leb_map(struct ubi_volume_desc *desc, int lnum, int dtype);

static inline int dbg_read(struct ubi_volume_desc *desc, int lnum, char *buf,
			   int offset, int len)
{
	return dbg_leb_read(desc, lnum, buf, offset, len, 0);
}

static inline int dbg_write(struct ubi_volume_desc *desc, int lnum,
			    const void *buf, int offset, int len)
{
	return dbg_leb_write(desc, lnum, buf, offset, len, UBI_UNKNOWN);
}

static inline int dbg_change(struct ubi_volume_desc *desc, int lnum,
				    const void *buf, int len)
{
	return dbg_leb_change(desc, lnum, buf, len, UBI_UNKNOWN);
}

/* Debugfs-related stuff */
int dbg_debugfs_init(void);
void dbg_debugfs_exit(void);
int dbg_debugfs_init_fs(struct ubifs_info *c);
void dbg_debugfs_exit_fs(struct ubifs_info *c);

#else /* !CONFIG_UBIFS_FS_DEBUG */

/* Use "if (0)" to make compiler check arguments even if debugging is off */
#define ubifs_assert(expr)  do {                                               \
	if (0 && (expr))                                                       \
		printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
		       __func__, __LINE__, current->pid);                      \
} while (0)

#define dbg_err(fmt, ...)   do {                                               \
	if (0)                                                                 \
		ubifs_err(fmt, ##__VA_ARGS__);                                 \
} while (0)

#define dbg_msg(fmt, ...) do {                                                 \
	if (0)                                                                 \
		printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n",         \
		       current->pid, __func__, ##__VA_ARGS__);                 \
} while (0)

#define dbg_dump_stack()
#define ubifs_assert_cmt_locked(c)

#define dbg_gen(fmt, ...)   dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_jnl(fmt, ...)   dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_tnc(fmt, ...)   dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_lp(fmt, ...)    dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_find(fmt, ...)  dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_mnt(fmt, ...)   dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_io(fmt, ...)    dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_cmt(fmt, ...)   dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_budg(fmt, ...)  dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_log(fmt, ...)   dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_gc(fmt, ...)    dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_scan(fmt, ...)  dbg_msg(fmt, ##__VA_ARGS__)
#define dbg_rcvry(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)

#define DBGKEY(key)  ((char *)(key))
#define DBGKEY1(key) ((char *)(key))

#define ubifs_debugging_init(c)                0
#define ubifs_debugging_exit(c)                ({})

#define dbg_ntype(type)                        ""
#define dbg_cstate(cmt_state)                  ""
#define dbg_jhead(jhead)                       ""
#define dbg_get_key_dump(c, key)               ({})
#define dbg_dump_inode(c, inode)               ({})
#define dbg_dump_node(c, node)                 ({})
#define dbg_dump_lpt_node(c, node, lnum, offs) ({})
#define dbg_dump_budget_req(req)               ({})
#define dbg_dump_lstats(lst)                   ({})
#define dbg_dump_budg(c)                       ({})
#define dbg_dump_lprop(c, lp)                  ({})
#define dbg_dump_lprops(c)                     ({})
#define dbg_dump_lpt_info(c)                   ({})
#define dbg_dump_leb(c, lnum)                  ({})
#define dbg_dump_znode(c, znode)               ({})
#define dbg_dump_heap(c, heap, cat)            ({})
#define dbg_dump_pnode(c, pnode, parent, iip)  ({})
#define dbg_dump_tnc(c)                        ({})
#define dbg_dump_index(c)                      ({})
#define dbg_dump_lpt_lebs(c)                   ({})

#define dbg_walk_index(c, leaf_cb, znode_cb, priv) 0
#define dbg_old_index_check_init(c, zroot)         0
#define dbg_save_space_info(c)                     ({})
#define dbg_check_space_info(c)                    0
#define dbg_check_old_index(c, zroot)              0
#define dbg_check_cats(c)                          0
#define dbg_check_ltab(c)                          0
#define dbg_chk_lpt_free_spc(c)                    0
#define dbg_chk_lpt_sz(c, action, len)             0
#define dbg_check_synced_i_size(inode)             0
#define dbg_check_dir_size(c, dir)                 0
#define dbg_check_tnc(c, x)                        0
#define dbg_check_idx_size(c, idx_size)            0
#define dbg_check_filesystem(c)                    0
#define dbg_check_heap(c, heap, cat, add_pos)      ({})
#define dbg_check_lprops(c)                        0
#define dbg_check_lpt_nodes(c, cnode, row, col)    0
#define dbg_check_inode_size(c, inode, size)       0
#define dbg_check_data_nodes_order(c, head)        0
#define dbg_check_nondata_nodes_order(c, head)     0
#define dbg_force_in_the_gaps_enabled              0
#define dbg_force_in_the_gaps()                    0
#define dbg_failure_mode                           0

#define dbg_debugfs_init()                         0
#define dbg_debugfs_exit()
#define dbg_debugfs_init_fs(c)                     0
#define dbg_debugfs_exit_fs(c)                     0

#endif /* !CONFIG_UBIFS_FS_DEBUG */
#endif /* !__UBIFS_DEBUG_H__ */
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
17c2f9f8 AB	28	/**
17c2f9f8 AB	29	* ubifs_debug_info - per-FS debugging information.
17c2f9f8 AB	30	* @old_zroot: old index root - used by 'dbg_check_old_index()'
	31	* @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
	32	* @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
	33	* @failure_mode: failure mode for recovery testing
	34	* @fail_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
	35	* @fail_timeout: time in jiffies when delay of failure mode expires
	36	* @fail_cnt: current number of calls to failure mode I/O functions
	37	* @fail_cnt_max: number of calls by which to delay failure mode
	38	* @chk_lpt_sz: used by LPT tree size checker
	39	* @chk_lpt_sz2: used by LPT tree size checker
	40	* @chk_lpt_wastage: used by LPT tree size checker
	41	* @chk_lpt_lebs: used by LPT tree size checker
	42	* @new_nhead_offs: used by LPT tree size checker
84abf972 AB	43	* @new_ihead_lnum: used by debugging to check @c->ihead_lnum
84abf972 AB	44	* @new_ihead_offs: used by debugging to check @c->ihead_offs
552ff317	45	*
84abf972 AB	46	* @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
	47	* @saved_free: saved free space (used by 'dbg_save_space_info()')
	48	*
	49	* dfs_dir_name: name of debugfs directory containing this file-system's files
	50	* dfs_dir: direntry object of the file-system debugfs directory
	51	* dfs_dump_lprops: "dump lprops" debugfs knob
	52	* dfs_dump_budg: "dump budgeting information" debugfs knob
	53	* dfs_dump_tnc: "dump TNC" debugfs knob
17c2f9f8 AB	54	*/
17c2f9f8 AB	55	struct ubifs_debug_info {
17c2f9f8 AB	56	struct ubifs_zbranch old_zroot;
	57	int old_zroot_level;
	58	unsigned long long old_zroot_sqnum;
	59	int failure_mode;
	60	int fail_delay;
	61	unsigned long fail_timeout;
	62	unsigned int fail_cnt;
	63	unsigned int fail_cnt_max;
	64	long long chk_lpt_sz;
	65	long long chk_lpt_sz2;
	66	long long chk_lpt_wastage;
	67	int chk_lpt_lebs;
	68	int new_nhead_offs;
	69	int new_ihead_lnum;
	70	int new_ihead_offs;
552ff317	71
84abf972 AB	72	struct ubifs_lp_stats saved_lst;
	73	long long saved_free;
	74
	75	char dfs_dir_name[100];
	76	struct dentry *dfs_dir;
	77	struct dentry *dfs_dump_lprops;
	78	struct dentry *dfs_dump_budg;
	79	struct dentry *dfs_dump_tnc;
17c2f9f8	80	};
1e51764a	81
840dc6b8	82	#define ubifs_assert(expr) do { \
1e51764a AB	83	if (unlikely(!(expr))) { \
	84	printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
	85	__func__, __LINE__, current->pid); \
	86	dbg_dump_stack(); \
	87	} \
	88	} while (0)
	89
	90	#define ubifs_assert_cmt_locked(c) do { \
	91	if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
	92	up_write(&(c)->commit_sem); \
	93	printk(KERN_CRIT "commit lock is not locked!\n"); \
	94	ubifs_assert(0); \
	95	} \
	96	} while (0)
	97
	98	#define dbg_dump_stack() do { \
	99	if (!dbg_failure_mode) \
	100	dump_stack(); \
	101	} while (0)
	102
	103	/* Generic debugging messages */
	104	#define dbg_msg(fmt, ...) do { \
	105	spin_lock(&dbg_lock); \
	106	printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
	107	__func__, ##__VA_ARGS__); \
	108	spin_unlock(&dbg_lock); \
	109	} while (0)
	110
	111	#define dbg_do_msg(typ, fmt, ...) do { \
	112	if (ubifs_msg_flags & typ) \
	113	dbg_msg(fmt, ##__VA_ARGS__); \
	114	} while (0)
	115
	116	#define dbg_err(fmt, ...) do { \
	117	spin_lock(&dbg_lock); \
	118	ubifs_err(fmt, ##__VA_ARGS__); \
	119	spin_unlock(&dbg_lock); \
	120	} while (0)
	121
	122	const char dbg_key_str0(const struct ubifs_info c,
	123	const union ubifs_key *key);
	124	const char dbg_key_str1(const struct ubifs_info c,
	125	const union ubifs_key *key);
	126
	127	/*
840dc6b8	128	* DBGKEY macros require @dbg_lock to be held, which it is in the dbg message
1e51764a AB	129	* macros.
	130	*/
	131	#define DBGKEY(key) dbg_key_str0(c, (key))
	132	#define DBGKEY1(key) dbg_key_str1(c, (key))
	133
	134	/* General messages */
840dc6b8	135	#define dbg_gen(fmt, ...) dbg_do_msg(UBIFS_MSG_GEN, fmt, ##__VA_ARGS__)
1e51764a AB	136
1e51764a AB	137	/* Additional journal messages */
840dc6b8	138	#define dbg_jnl(fmt, ...) dbg_do_msg(UBIFS_MSG_JNL, fmt, ##__VA_ARGS__)
1e51764a AB	139
1e51764a AB	140	/* Additional TNC messages */
840dc6b8	141	#define dbg_tnc(fmt, ...) dbg_do_msg(UBIFS_MSG_TNC, fmt, ##__VA_ARGS__)
1e51764a AB	142
1e51764a AB	143	/* Additional lprops messages */
840dc6b8	144	#define dbg_lp(fmt, ...) dbg_do_msg(UBIFS_MSG_LP, fmt, ##__VA_ARGS__)
1e51764a AB	145
1e51764a AB	146	/* Additional LEB find messages */
840dc6b8	147	#define dbg_find(fmt, ...) dbg_do_msg(UBIFS_MSG_FIND, fmt, ##__VA_ARGS__)
1e51764a AB	148
1e51764a AB	149	/* Additional mount messages */
840dc6b8	150	#define dbg_mnt(fmt, ...) dbg_do_msg(UBIFS_MSG_MNT, fmt, ##__VA_ARGS__)
1e51764a AB	151
1e51764a AB	152	/* Additional I/O messages */
840dc6b8	153	#define dbg_io(fmt, ...) dbg_do_msg(UBIFS_MSG_IO, fmt, ##__VA_ARGS__)
1e51764a AB	154
1e51764a AB	155	/* Additional commit messages */
840dc6b8	156	#define dbg_cmt(fmt, ...) dbg_do_msg(UBIFS_MSG_CMT, fmt, ##__VA_ARGS__)
1e51764a AB	157
1e51764a AB	158	/* Additional budgeting messages */
840dc6b8	159	#define dbg_budg(fmt, ...) dbg_do_msg(UBIFS_MSG_BUDG, fmt, ##__VA_ARGS__)
1e51764a AB	160
1e51764a AB	161	/* Additional log messages */
840dc6b8	162	#define dbg_log(fmt, ...) dbg_do_msg(UBIFS_MSG_LOG, fmt, ##__VA_ARGS__)
1e51764a AB	163
1e51764a AB	164	/* Additional gc messages */
840dc6b8	165	#define dbg_gc(fmt, ...) dbg_do_msg(UBIFS_MSG_GC, fmt, ##__VA_ARGS__)
1e51764a AB	166
1e51764a AB	167	/* Additional scan messages */
840dc6b8	168	#define dbg_scan(fmt, ...) dbg_do_msg(UBIFS_MSG_SCAN, fmt, ##__VA_ARGS__)
1e51764a AB	169
1e51764a AB	170	/* Additional recovery messages */
840dc6b8	171	#define dbg_rcvry(fmt, ...) dbg_do_msg(UBIFS_MSG_RCVRY, fmt, ##__VA_ARGS__)
1e51764a AB	172
	173	/*
	174	* Debugging message type flags (must match msg_type_names in debug.c).
	175	*
	176	* UBIFS_MSG_GEN: general messages
	177	* UBIFS_MSG_JNL: journal messages
	178	* UBIFS_MSG_MNT: mount messages
	179	* UBIFS_MSG_CMT: commit messages
	180	* UBIFS_MSG_FIND: LEB find messages
	181	* UBIFS_MSG_BUDG: budgeting messages
	182	* UBIFS_MSG_GC: garbage collection messages
	183	* UBIFS_MSG_TNC: TNC messages
	184	* UBIFS_MSG_LP: lprops messages
	185	* UBIFS_MSG_IO: I/O messages
	186	* UBIFS_MSG_LOG: log messages
	187	* UBIFS_MSG_SCAN: scan messages
	188	* UBIFS_MSG_RCVRY: recovery messages
	189	*/
	190	enum {
	191	UBIFS_MSG_GEN = 0x1,
	192	UBIFS_MSG_JNL = 0x2,
	193	UBIFS_MSG_MNT = 0x4,
	194	UBIFS_MSG_CMT = 0x8,
	195	UBIFS_MSG_FIND = 0x10,
	196	UBIFS_MSG_BUDG = 0x20,
	197	UBIFS_MSG_GC = 0x40,
	198	UBIFS_MSG_TNC = 0x80,
	199	UBIFS_MSG_LP = 0x100,
	200	UBIFS_MSG_IO = 0x200,
	201	UBIFS_MSG_LOG = 0x400,
	202	UBIFS_MSG_SCAN = 0x800,
	203	UBIFS_MSG_RCVRY = 0x1000,
	204	};
	205
1e51764a AB	206	/*
	207	* Debugging check flags (must match chk_names in debug.c).
	208	*
	209	* UBIFS_CHK_GEN: general checks
	210	* UBIFS_CHK_TNC: check TNC
	211	* UBIFS_CHK_IDX_SZ: check index size
	212	* UBIFS_CHK_ORPH: check orphans
	213	* UBIFS_CHK_OLD_IDX: check the old index
	214	* UBIFS_CHK_LPROPS: check lprops
	215	* UBIFS_CHK_FS: check the file-system
	216	*/
	217	enum {
	218	UBIFS_CHK_GEN = 0x1,
	219	UBIFS_CHK_TNC = 0x2,
	220	UBIFS_CHK_IDX_SZ = 0x4,
	221	UBIFS_CHK_ORPH = 0x8,
	222	UBIFS_CHK_OLD_IDX = 0x10,
	223	UBIFS_CHK_LPROPS = 0x20,
	224	UBIFS_CHK_FS = 0x40,
	225	};
	226
	227	/*
	228	* Special testing flags (must match tst_names in debug.c).
	229	*
	230	* UBIFS_TST_FORCE_IN_THE_GAPS: force the use of in-the-gaps method
	231	* UBIFS_TST_RCVRY: failure mode for recovery testing
	232	*/
	233	enum {
	234	UBIFS_TST_FORCE_IN_THE_GAPS = 0x2,
	235	UBIFS_TST_RCVRY = 0x4,
	236	};
	237
1e51764a AB	238	extern spinlock_t dbg_lock;
	239
	240	extern unsigned int ubifs_msg_flags;
	241	extern unsigned int ubifs_chk_flags;
	242	extern unsigned int ubifs_tst_flags;
	243
17c2f9f8 AB	244	int ubifs_debugging_init(struct ubifs_info *c);
	245	void ubifs_debugging_exit(struct ubifs_info *c);
	246
1e51764a	247	/* Dump functions */
1e51764a AB	248	const char *dbg_ntype(int type);
1e51764a AB	249	const char *dbg_cstate(int cmt_state);
77a7ae58	250	const char *dbg_jhead(int jhead);
1e51764a AB	251	const char dbg_get_key_dump(const struct ubifs_info c,
	252	const union ubifs_key *key);
	253	void dbg_dump_inode(const struct ubifs_info c, const struct inode inode);
	254	void dbg_dump_node(const struct ubifs_info c, const void node);
2ba5f7ae AB	255	void dbg_dump_lpt_node(const struct ubifs_info c, void node, int lnum,
2ba5f7ae AB	256	int offs);
1e51764a AB	257	void dbg_dump_budget_req(const struct ubifs_budget_req *req);
	258	void dbg_dump_lstats(const struct ubifs_lp_stats *lst);
	259	void dbg_dump_budg(struct ubifs_info *c);
	260	void dbg_dump_lprop(const struct ubifs_info c, const struct ubifs_lprops lp);
	261	void dbg_dump_lprops(struct ubifs_info *c);
73944a6d	262	void dbg_dump_lpt_info(struct ubifs_info *c);
1e51764a AB	263	void dbg_dump_leb(const struct ubifs_info *c, int lnum);
	264	void dbg_dump_znode(const struct ubifs_info *c,
	265	const struct ubifs_znode *znode);
	266	void dbg_dump_heap(struct ubifs_info c, struct ubifs_lpt_heap heap, int cat);
	267	void dbg_dump_pnode(struct ubifs_info c, struct ubifs_pnode pnode,
	268	struct ubifs_nnode *parent, int iip);
	269	void dbg_dump_tnc(struct ubifs_info *c);
	270	void dbg_dump_index(struct ubifs_info *c);
2ba5f7ae	271	void dbg_dump_lpt_lebs(const struct ubifs_info *c);
1e51764a AB	272
1e51764a AB	273	/* Checking helper functions */
1e51764a AB	274	typedef int (dbg_leaf_callback)(struct ubifs_info c,
	275	struct ubifs_zbranch zbr, void priv);
	276	typedef int (dbg_znode_callback)(struct ubifs_info c,
	277	struct ubifs_znode znode, void priv);
1e51764a AB	278	int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
	279	dbg_znode_callback znode_cb, void *priv);
	280
	281	/* Checking functions */
84abf972 AB	282	void dbg_save_space_info(struct ubifs_info *c);
84abf972 AB	283	int dbg_check_space_info(struct ubifs_info *c);
1e51764a	284	int dbg_check_lprops(struct ubifs_info *c);
1e51764a AB	285	int dbg_old_index_check_init(struct ubifs_info c, struct ubifs_zbranch zroot);
1e51764a AB	286	int dbg_check_old_index(struct ubifs_info c, struct ubifs_zbranch zroot);
1e51764a	287	int dbg_check_cats(struct ubifs_info *c);
1e51764a	288	int dbg_check_ltab(struct ubifs_info *c);
73944a6d AH	289	int dbg_chk_lpt_free_spc(struct ubifs_info *c);
73944a6d AH	290	int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
1e51764a	291	int dbg_check_synced_i_size(struct inode *inode);
1e51764a	292	int dbg_check_dir_size(struct ubifs_info c, const struct inode dir);
1e51764a	293	int dbg_check_tnc(struct ubifs_info *c, int extra);
1e51764a	294	int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
1e51764a	295	int dbg_check_filesystem(struct ubifs_info *c);
1e51764a AB	296	void dbg_check_heap(struct ubifs_info c, struct ubifs_lpt_heap heap, int cat,
1e51764a AB	297	int add_pos);
1e51764a AB	298	int dbg_check_lprops(struct ubifs_info *c);
	299	int dbg_check_lpt_nodes(struct ubifs_info c, struct ubifs_cnode cnode,
	300	int row, int col);
e3c3efc2 AB	301	int dbg_check_inode_size(struct ubifs_info c, const struct inode inode,
e3c3efc2 AB	302	loff_t size);
3bb66b47 AB	303	int dbg_check_data_nodes_order(struct ubifs_info c, struct list_head head);
3bb66b47 AB	304	int dbg_check_nondata_nodes_order(struct ubifs_info c, struct list_head head);
1e51764a AB	305
	306	/* Force the use of in-the-gaps method for testing */
	307
	308	#define dbg_force_in_the_gaps_enabled \
	309	(ubifs_tst_flags & UBIFS_TST_FORCE_IN_THE_GAPS)
	310
	311	int dbg_force_in_the_gaps(void);
	312
	313	/* Failure mode for recovery testing */
	314
	315	#define dbg_failure_mode (ubifs_tst_flags & UBIFS_TST_RCVRY)
	316
1e51764a AB	317	#ifndef UBIFS_DBG_PRESERVE_UBI
	318
	319	#define ubi_leb_read dbg_leb_read
	320	#define ubi_leb_write dbg_leb_write
	321	#define ubi_leb_change dbg_leb_change
	322	#define ubi_leb_erase dbg_leb_erase
	323	#define ubi_leb_unmap dbg_leb_unmap
	324	#define ubi_is_mapped dbg_is_mapped
	325	#define ubi_leb_map dbg_leb_map
	326
	327	#endif
	328
	329	int dbg_leb_read(struct ubi_volume_desc desc, int lnum, char buf, int offset,
	330	int len, int check);
	331	int dbg_leb_write(struct ubi_volume_desc desc, int lnum, const void buf,
	332	int offset, int len, int dtype);
	333	int dbg_leb_change(struct ubi_volume_desc desc, int lnum, const void buf,
	334	int len, int dtype);
	335	int dbg_leb_erase(struct ubi_volume_desc *desc, int lnum);
	336	int dbg_leb_unmap(struct ubi_volume_desc *desc, int lnum);
	337	int dbg_is_mapped(struct ubi_volume_desc *desc, int lnum);
	338	int dbg_leb_map(struct ubi_volume_desc *desc, int lnum, int dtype);
	339
	340	static inline int dbg_read(struct ubi_volume_desc desc, int lnum, char buf,
	341	int offset, int len)
	342	{
	343	return dbg_leb_read(desc, lnum, buf, offset, len, 0);
	344	}
	345
	346	static inline int dbg_write(struct ubi_volume_desc *desc, int lnum,
	347	const void *buf, int offset, int len)
	348	{
	349	return dbg_leb_write(desc, lnum, buf, offset, len, UBI_UNKNOWN);
	350	}
	351
	352	static inline int dbg_change(struct ubi_volume_desc *desc, int lnum,
	353	const void *buf, int len)
	354	{
	355	return dbg_leb_change(desc, lnum, buf, len, UBI_UNKNOWN);
	356	}
	357
552ff317 AB	358	/* Debugfs-related stuff */
	359	int dbg_debugfs_init(void);
	360	void dbg_debugfs_exit(void);
	361	int dbg_debugfs_init_fs(struct ubifs_info *c);
	362	void dbg_debugfs_exit_fs(struct ubifs_info *c);
	363
1e51764a AB	364	#else /* !CONFIG_UBIFS_FS_DEBUG */
1e51764a AB	365
840dc6b8 AB	366	/* Use "if (0)" to make compiler check arguments even if debugging is off */
	367	#define ubifs_assert(expr) do { \
	368	if (0 && (expr)) \
	369	printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
	370	__func__, __LINE__, current->pid); \
	371	} while (0)
	372
	373	#define dbg_err(fmt, ...) do { \
	374	if (0) \
	375	ubifs_err(fmt, ##__VA_ARGS__); \
	376	} while (0)
	377
	378	#define dbg_msg(fmt, ...) do { \
	379	if (0) \
	380	printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", \
	381	current->pid, __func__, ##__VA_ARGS__); \
	382	} while (0)
	383
1e51764a	384	#define dbg_dump_stack()
840dc6b8	385	#define ubifs_assert_cmt_locked(c)
1e51764a	386
840dc6b8 AB	387	#define dbg_gen(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	388	#define dbg_jnl(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	389	#define dbg_tnc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	390	#define dbg_lp(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	391	#define dbg_find(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	392	#define dbg_mnt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	393	#define dbg_io(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	394	#define dbg_cmt(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	395	#define dbg_budg(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	396	#define dbg_log(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	397	#define dbg_gc(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	398	#define dbg_scan(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	399	#define dbg_rcvry(fmt, ...) dbg_msg(fmt, ##__VA_ARGS__)
	400
	401	#define DBGKEY(key) ((char *)(key))
	402	#define DBGKEY1(key) ((char *)(key))
	403
2ba5f7ae AB	404	#define ubifs_debugging_init(c) 0
	405	#define ubifs_debugging_exit(c) ({})
	406
	407	#define dbg_ntype(type) ""
	408	#define dbg_cstate(cmt_state) ""
77a7ae58	409	#define dbg_jhead(jhead) ""
2ba5f7ae AB	410	#define dbg_get_key_dump(c, key) ({})
	411	#define dbg_dump_inode(c, inode) ({})
	412	#define dbg_dump_node(c, node) ({})
	413	#define dbg_dump_lpt_node(c, node, lnum, offs) ({})
	414	#define dbg_dump_budget_req(req) ({})
	415	#define dbg_dump_lstats(lst) ({})
	416	#define dbg_dump_budg(c) ({})
	417	#define dbg_dump_lprop(c, lp) ({})
	418	#define dbg_dump_lprops(c) ({})
	419	#define dbg_dump_lpt_info(c) ({})
	420	#define dbg_dump_leb(c, lnum) ({})
	421	#define dbg_dump_znode(c, znode) ({})
	422	#define dbg_dump_heap(c, heap, cat) ({})
	423	#define dbg_dump_pnode(c, pnode, parent, iip) ({})
	424	#define dbg_dump_tnc(c) ({})
	425	#define dbg_dump_index(c) ({})
	426	#define dbg_dump_lpt_lebs(c) ({})
1e51764a	427
840dc6b8	428	#define dbg_walk_index(c, leaf_cb, znode_cb, priv) 0
1e51764a	429	#define dbg_old_index_check_init(c, zroot) 0
84abf972 AB	430	#define dbg_save_space_info(c) ({})
84abf972 AB	431	#define dbg_check_space_info(c) 0
1e51764a	432	#define dbg_check_old_index(c, zroot) 0
1e51764a	433	#define dbg_check_cats(c) 0
1e51764a	434	#define dbg_check_ltab(c) 0
73944a6d AH	435	#define dbg_chk_lpt_free_spc(c) 0
73944a6d AH	436	#define dbg_chk_lpt_sz(c, action, len) 0
1e51764a	437	#define dbg_check_synced_i_size(inode) 0
1e51764a	438	#define dbg_check_dir_size(c, dir) 0
1e51764a	439	#define dbg_check_tnc(c, x) 0
1e51764a	440	#define dbg_check_idx_size(c, idx_size) 0
1e51764a	441	#define dbg_check_filesystem(c) 0
1e51764a	442	#define dbg_check_heap(c, heap, cat, add_pos) ({})
1e51764a AB	443	#define dbg_check_lprops(c) 0
1e51764a AB	444	#define dbg_check_lpt_nodes(c, cnode, row, col) 0
e3c3efc2	445	#define dbg_check_inode_size(c, inode, size) 0
3bb66b47 AB	446	#define dbg_check_data_nodes_order(c, head) 0
3bb66b47 AB	447	#define dbg_check_nondata_nodes_order(c, head) 0
1e51764a AB	448	#define dbg_force_in_the_gaps_enabled 0
1e51764a AB	449	#define dbg_force_in_the_gaps() 0
1e51764a	450	#define dbg_failure_mode 0
1e51764a	451
552ff317 AB	452	#define dbg_debugfs_init() 0
	453	#define dbg_debugfs_exit()
	454	#define dbg_debugfs_init_fs(c) 0
	455	#define dbg_debugfs_exit_fs(c) 0
1e51764a	456
552ff317	457	#endif /* !CONFIG_UBIFS_FS_DEBUG */
1e51764a	458	#endif /* !__UBIFS_DEBUG_H__ */