[linux-2.6-block.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__

/* 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);

/*
 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
 */
#define UBIFS_DFS_DIR_NAME "ubi%d_%d"
#define UBIFS_DFS_DIR_LEN  (3 + 1 + 2*2 + 1)

/**
 * 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()'
 *
 * @pc_happened: non-zero if an emulated power cut happened
 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
 * @pc_timeout: time in jiffies when delay of failure mode expires
 * @pc_cnt: current number of calls to failure mode I/O functions
 * @pc_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_bi: saved budgeting information
 * @saved_free: saved amount of free space
 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
 *
 * @chk_gen: if general extra checks are enabled
 * @chk_index: if index xtra checks are enabled
 * @chk_orph: if orphans extra checks are enabled
 * @chk_lprops: if lprops extra checks are enabled
 * @chk_fs: if UBIFS contents extra checks are enabled
 * @tst_rcvry: if UBIFS recovery testing mode enabled
 *
 * @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
 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
 * @dfs_ro_error: debugfs knob to switch UBIFS to R/O mode (different to
 *                re-mounting to R/O mode because it does not flush any buffers
 *                and UBIFS just starts returning -EROFS on all write
 *               operations)
 */
struct ubifs_debug_info {
	struct ubifs_zbranch old_zroot;
	int old_zroot_level;
	unsigned long long old_zroot_sqnum;

	int pc_happened;
	int pc_delay;
	unsigned long pc_timeout;
	unsigned int pc_cnt;
	unsigned int pc_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;
	struct ubifs_budg_info saved_bi;
	long long saved_free;
	int saved_idx_gc_cnt;

	unsigned int chk_gen:1;
	unsigned int chk_index:1;
	unsigned int chk_orph:1;
	unsigned int chk_lprops:1;
	unsigned int chk_fs:1;
	unsigned int tst_rcvry:1;

	char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
	struct dentry *dfs_dir;
	struct dentry *dfs_dump_lprops;
	struct dentry *dfs_dump_budg;
	struct dentry *dfs_dump_tnc;
	struct dentry *dfs_chk_gen;
	struct dentry *dfs_chk_index;
	struct dentry *dfs_chk_orph;
	struct dentry *dfs_chk_lprops;
	struct dentry *dfs_chk_fs;
	struct dentry *dfs_tst_rcvry;
	struct dentry *dfs_ro_error;
};

/**
 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
 *
 * @chk_gen: if general extra checks are enabled
 * @chk_index: if index xtra checks are enabled
 * @chk_orph: if orphans extra checks are enabled
 * @chk_lprops: if lprops extra checks are enabled
 * @chk_fs: if UBIFS contents extra checks are enabled
 * @tst_rcvry: if UBIFS recovery testing mode enabled
 */
struct ubifs_global_debug_info {
	unsigned int chk_gen:1;
	unsigned int chk_index:1;
	unsigned int chk_orph:1;
	unsigned int chk_lprops:1;
	unsigned int chk_fs:1;
	unsigned int tst_rcvry:1;
};

void ubifs_assert_failed(struct ubifs_info *c, const char *expr,
	const char *file, int line);

#define ubifs_assert(c, expr) do {                                             \
	if (unlikely(!(expr))) {                                               \
		ubifs_assert_failed((struct ubifs_info *)c, #expr, __FILE__,   \
		 __LINE__);                                                    \
	}                                                                      \
} while (0)

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

#define ubifs_dbg_msg(type, fmt, ...) \
	pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid,       \
		 ##__VA_ARGS__)

#define DBG_KEY_BUF_LEN 48
#define ubifs_dbg_msg_key(type, key, fmt, ...) do {                            \
	char __tmp_key_buf[DBG_KEY_BUF_LEN];                                   \
	pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid,     \
		 ##__VA_ARGS__,                                                \
		 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN));    \
} while (0)

/* General messages */
#define dbg_gen(fmt, ...)   ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
/* Additional journal messages */
#define dbg_jnl(fmt, ...)   ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
#define dbg_jnlk(key, fmt, ...) \
	ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
/* Additional TNC messages */
#define dbg_tnc(fmt, ...)   ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
#define dbg_tnck(key, fmt, ...) \
	ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
/* Additional lprops messages */
#define dbg_lp(fmt, ...)    ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
/* Additional LEB find messages */
#define dbg_find(fmt, ...)  ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
/* Additional mount messages */
#define dbg_mnt(fmt, ...)   ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
#define dbg_mntk(key, fmt, ...) \
	ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
/* Additional I/O messages */
#define dbg_io(fmt, ...)    ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
/* Additional commit messages */
#define dbg_cmt(fmt, ...)   ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
/* Additional budgeting messages */
#define dbg_budg(fmt, ...)  ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
/* Additional log messages */
#define dbg_log(fmt, ...)   ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
/* Additional gc messages */
#define dbg_gc(fmt, ...)    ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
/* Additional scan messages */
#define dbg_scan(fmt, ...)  ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
/* Additional recovery messages */
#define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)

extern struct ubifs_global_debug_info ubifs_dbg;

static inline int dbg_is_chk_gen(const struct ubifs_info *c)
{
	return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
}
static inline int dbg_is_chk_index(const struct ubifs_info *c)
{
	return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
}
static inline int dbg_is_chk_orph(const struct ubifs_info *c)
{
	return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
}
static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
{
	return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
}
static inline int dbg_is_chk_fs(const struct ubifs_info *c)
{
	return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
}
static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
{
	return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
}
static inline int dbg_is_power_cut(const struct ubifs_info *c)
{
	return !!c->dbg->pc_happened;
}

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);
const char *dbg_snprintf_key(const struct ubifs_info *c,
			     const union ubifs_key *key, char *buffer, int len);
void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode);
void ubifs_dump_node(const struct ubifs_info *c, const void *node);
void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
void ubifs_dump_lprop(const struct ubifs_info *c,
		      const struct ubifs_lprops *lp);
void ubifs_dump_lprops(struct ubifs_info *c);
void ubifs_dump_lpt_info(struct ubifs_info *c);
void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
void ubifs_dump_sleb(const struct ubifs_info *c,
		     const struct ubifs_scan_leb *sleb, int offs);
void ubifs_dump_znode(const struct ubifs_info *c,
		      const struct ubifs_znode *znode);
void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap,
		     int cat);
void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
		      struct ubifs_nnode *parent, int iip);
void ubifs_dump_tnc(struct ubifs_info *c);
void ubifs_dump_index(struct ubifs_info *c);
void ubifs_dump_lpt_lebs(const struct ubifs_info *c);

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(const struct ubifs_info *c, struct inode *inode);
int dbg_check_dir(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_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);

int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
		  int len);
int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
int dbg_leb_unmap(struct ubifs_info *c, int lnum);
int dbg_leb_map(struct ubifs_info *c, int lnum);

/* 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);

#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
1dcffad7 MR	26	/* Checking helper functions */
	27	typedef int (dbg_leaf_callback)(struct ubifs_info c,
	28	struct ubifs_zbranch zbr, void priv);
	29	typedef int (dbg_znode_callback)(struct ubifs_info c,
	30	struct ubifs_znode znode, void priv);
	31
ae380ce0 AB	32	/*
	33	* The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
	34	* + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
	35	*/
	36	#define UBIFS_DFS_DIR_NAME "ubi%d_%d"
	37	#define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
	38
17c2f9f8 AB	39	/**
17c2f9f8 AB	40	* ubifs_debug_info - per-FS debugging information.
17c2f9f8 AB	41	* @old_zroot: old index root - used by 'dbg_check_old_index()'
	42	* @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
	43	* @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
81e79d38	44	*
d27462a5 AB	45	* @pc_happened: non-zero if an emulated power cut happened
	46	* @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
	47	* @pc_timeout: time in jiffies when delay of failure mode expires
	48	* @pc_cnt: current number of calls to failure mode I/O functions
	49	* @pc_cnt_max: number of calls by which to delay failure mode
81e79d38	50	*
17c2f9f8 AB	51	* @chk_lpt_sz: used by LPT tree size checker
	52	* @chk_lpt_sz2: used by LPT tree size checker
	53	* @chk_lpt_wastage: used by LPT tree size checker
	54	* @chk_lpt_lebs: used by LPT tree size checker
	55	* @new_nhead_offs: used by LPT tree size checker
84abf972 AB	56	* @new_ihead_lnum: used by debugging to check @c->ihead_lnum
84abf972 AB	57	* @new_ihead_offs: used by debugging to check @c->ihead_offs
552ff317	58	*
84abf972	59	* @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
f1bd66af AB	60	* @saved_bi: saved budgeting information
	61	* @saved_free: saved amount of free space
	62	* @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
84abf972	63	*
81e79d38 AB	64	* @chk_gen: if general extra checks are enabled
	65	* @chk_index: if index xtra checks are enabled
	66	* @chk_orph: if orphans extra checks are enabled
	67	* @chk_lprops: if lprops extra checks are enabled
	68	* @chk_fs: if UBIFS contents extra checks are enabled
	69	* @tst_rcvry: if UBIFS recovery testing mode enabled
	70	*
bdc1a1b6 AB	71	* @dfs_dir_name: name of debugfs directory containing this file-system's files
	72	* @dfs_dir: direntry object of the file-system debugfs directory
	73	* @dfs_dump_lprops: "dump lprops" debugfs knob
	74	* @dfs_dump_budg: "dump budgeting information" debugfs knob
	75	* @dfs_dump_tnc: "dump TNC" debugfs knob
81e79d38 AB	76	* @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
	77	* @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
	78	* @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
	79	* @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
	80	* @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
	81	* @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
06bef945 AB	82	* @dfs_ro_error: debugfs knob to switch UBIFS to R/O mode (different to
	83	* re-mounting to R/O mode because it does not flush any buffers
	84	* and UBIFS just starts returning -EROFS on all write
	85	* operations)
17c2f9f8 AB	86	*/
17c2f9f8 AB	87	struct ubifs_debug_info {
17c2f9f8 AB	88	struct ubifs_zbranch old_zroot;
	89	int old_zroot_level;
	90	unsigned long long old_zroot_sqnum;
81e79d38	91
d27462a5 AB	92	int pc_happened;
	93	int pc_delay;
	94	unsigned long pc_timeout;
	95	unsigned int pc_cnt;
	96	unsigned int pc_cnt_max;
81e79d38	97
17c2f9f8 AB	98	long long chk_lpt_sz;
	99	long long chk_lpt_sz2;
	100	long long chk_lpt_wastage;
	101	int chk_lpt_lebs;
	102	int new_nhead_offs;
	103	int new_ihead_lnum;
	104	int new_ihead_offs;
552ff317	105
84abf972	106	struct ubifs_lp_stats saved_lst;
f1bd66af	107	struct ubifs_budg_info saved_bi;
84abf972	108	long long saved_free;
f1bd66af	109	int saved_idx_gc_cnt;
84abf972	110
81e79d38 AB	111	unsigned int chk_gen:1;
	112	unsigned int chk_index:1;
	113	unsigned int chk_orph:1;
	114	unsigned int chk_lprops:1;
	115	unsigned int chk_fs:1;
	116	unsigned int tst_rcvry:1;
	117
ae380ce0	118	char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
84abf972 AB	119	struct dentry *dfs_dir;
	120	struct dentry *dfs_dump_lprops;
	121	struct dentry *dfs_dump_budg;
	122	struct dentry *dfs_dump_tnc;
81e79d38 AB	123	struct dentry *dfs_chk_gen;
	124	struct dentry *dfs_chk_index;
	125	struct dentry *dfs_chk_orph;
	126	struct dentry *dfs_chk_lprops;
	127	struct dentry *dfs_chk_fs;
	128	struct dentry *dfs_tst_rcvry;
06bef945	129	struct dentry *dfs_ro_error;
17c2f9f8	130	};
1e51764a	131
e7717060 AB	132	/**
	133	* ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
	134	*
	135	* @chk_gen: if general extra checks are enabled
	136	* @chk_index: if index xtra checks are enabled
	137	* @chk_orph: if orphans extra checks are enabled
	138	* @chk_lprops: if lprops extra checks are enabled
	139	* @chk_fs: if UBIFS contents extra checks are enabled
	140	* @tst_rcvry: if UBIFS recovery testing mode enabled
	141	*/
	142	struct ubifs_global_debug_info {
	143	unsigned int chk_gen:1;
	144	unsigned int chk_index:1;
	145	unsigned int chk_orph:1;
	146	unsigned int chk_lprops:1;
	147	unsigned int chk_fs:1;
	148	unsigned int tst_rcvry:1;
	149	};
	150
2e52eb74 RW	151	void ubifs_assert_failed(struct ubifs_info c, const char expr,
	152	const char *file, int line);
	153
6eb61d58	154	#define ubifs_assert(c, expr) do { \
1e51764a	155	if (unlikely(!(expr))) { \
2e52eb74 RW	156	ubifs_assert_failed((struct ubifs_info *)c, #expr, __FILE__, \
2e52eb74 RW	157	__LINE__); \
1e51764a AB	158	} \
	159	} while (0)
	160
	161	#define ubifs_assert_cmt_locked(c) do { \
	162	if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
	163	up_write(&(c)->commit_sem); \
2e52eb74	164	ubifs_err(c, "commit lock is not locked!\n"); \
6eb61d58	165	ubifs_assert(c, 0); \
1e51764a AB	166	} \
	167	} while (0)
	168
1f5d78dc	169	#define ubifs_dbg_msg(type, fmt, ...) \
c45640d8 AB	170	pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid, \
c45640d8 AB	171	##__VA_ARGS__)
1e51764a	172
65b455b1	173	#define DBG_KEY_BUF_LEN 48
515315a1 AB	174	#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
515315a1 AB	175	char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
c45640d8 AB	176	pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid, \
c45640d8 AB	177	##__VA_ARGS__, \
515315a1 AB	178	dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
	179	} while (0)
	180
56e46742 AB	181	/* General messages */
56e46742 AB	182	#define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
1e51764a	183	/* Additional journal messages */
56e46742	184	#define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
515315a1 AB	185	#define dbg_jnlk(key, fmt, ...) \
515315a1 AB	186	ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
1e51764a	187	/* Additional TNC messages */
56e46742	188	#define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
515315a1 AB	189	#define dbg_tnck(key, fmt, ...) \
515315a1 AB	190	ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
1e51764a	191	/* Additional lprops messages */
56e46742	192	#define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
1e51764a	193	/* Additional LEB find messages */
56e46742	194	#define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
1e51764a	195	/* Additional mount messages */
56e46742	196	#define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
515315a1 AB	197	#define dbg_mntk(key, fmt, ...) \
515315a1 AB	198	ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
1e51764a	199	/* Additional I/O messages */
56e46742	200	#define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
1e51764a	201	/* Additional commit messages */
56e46742	202	#define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
1e51764a	203	/* Additional budgeting messages */
56e46742	204	#define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
1e51764a	205	/* Additional log messages */
56e46742	206	#define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
1e51764a	207	/* Additional gc messages */
56e46742	208	#define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
1e51764a	209	/* Additional scan messages */
56e46742	210	#define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
1e51764a	211	/* Additional recovery messages */
56e46742	212	#define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
1e51764a	213
e7717060	214	extern struct ubifs_global_debug_info ubifs_dbg;
2b1844a8	215
2b1844a8 AB	216	static inline int dbg_is_chk_gen(const struct ubifs_info *c)
2b1844a8 AB	217	{
e7717060	218	return !!(ubifs_dbg.chk_gen \|\| c->dbg->chk_gen);
2b1844a8	219	}
8d7819b4	220	static inline int dbg_is_chk_index(const struct ubifs_info *c)
2b1844a8	221	{
e7717060	222	return !!(ubifs_dbg.chk_index \|\| c->dbg->chk_index);
2b1844a8 AB	223	}
	224	static inline int dbg_is_chk_orph(const struct ubifs_info *c)
	225	{
e7717060	226	return !!(ubifs_dbg.chk_orph \|\| c->dbg->chk_orph);
2b1844a8	227	}
2b1844a8 AB	228	static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
2b1844a8 AB	229	{
e7717060	230	return !!(ubifs_dbg.chk_lprops \|\| c->dbg->chk_lprops);
2b1844a8 AB	231	}
	232	static inline int dbg_is_chk_fs(const struct ubifs_info *c)
	233	{
e7717060	234	return !!(ubifs_dbg.chk_fs \|\| c->dbg->chk_fs);
2b1844a8 AB	235	}
	236	static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
	237	{
e7717060	238	return !!(ubifs_dbg.tst_rcvry \|\| c->dbg->tst_rcvry);
2b1844a8	239	}
83cef708 AB	240	static inline int dbg_is_power_cut(const struct ubifs_info *c)
83cef708 AB	241	{
d27462a5	242	return !!c->dbg->pc_happened;
83cef708	243	}
2b1844a8	244
17c2f9f8 AB	245	int ubifs_debugging_init(struct ubifs_info *c);
	246	void ubifs_debugging_exit(struct ubifs_info *c);
	247
1e51764a	248	/* Dump functions */
1e51764a AB	249	const char *dbg_ntype(int type);
1e51764a AB	250	const char *dbg_cstate(int cmt_state);
77a7ae58	251	const char *dbg_jhead(int jhead);
1e51764a AB	252	const char dbg_get_key_dump(const struct ubifs_info c,
1e51764a AB	253	const union ubifs_key *key);
515315a1 AB	254	const char dbg_snprintf_key(const struct ubifs_info c,
515315a1 AB	255	const union ubifs_key key, char buffer, int len);
edf6be24 AB	256	void ubifs_dump_inode(struct ubifs_info c, const struct inode inode);
	257	void ubifs_dump_node(const struct ubifs_info c, const void node);
	258	void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
	259	void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
	260	void ubifs_dump_budg(struct ubifs_info c, const struct ubifs_budg_info bi);
	261	void ubifs_dump_lprop(const struct ubifs_info *c,
	262	const struct ubifs_lprops *lp);
	263	void ubifs_dump_lprops(struct ubifs_info *c);
	264	void ubifs_dump_lpt_info(struct ubifs_info *c);
	265	void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
	266	void ubifs_dump_sleb(const struct ubifs_info *c,
	267	const struct ubifs_scan_leb *sleb, int offs);
	268	void ubifs_dump_znode(const struct ubifs_info *c,
	269	const struct ubifs_znode *znode);
	270	void ubifs_dump_heap(struct ubifs_info c, struct ubifs_lpt_heap heap,
	271	int cat);
	272	void ubifs_dump_pnode(struct ubifs_info c, struct ubifs_pnode pnode,
	273	struct ubifs_nnode *parent, int iip);
	274	void ubifs_dump_tnc(struct ubifs_info *c);
	275	void ubifs_dump_index(struct ubifs_info *c);
	276	void ubifs_dump_lpt_lebs(const struct ubifs_info *c);
1e51764a	277
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);
d808efb4	291	int dbg_check_synced_i_size(const struct ubifs_info c, struct inode inode);
1b51e983	292	int dbg_check_dir(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_lpt_nodes(struct ubifs_info c, struct ubifs_cnode cnode,
1e51764a AB	299	int row, int col);
e3c3efc2 AB	300	int dbg_check_inode_size(struct ubifs_info c, const struct inode inode,
e3c3efc2 AB	301	loff_t size);
3bb66b47 AB	302	int dbg_check_data_nodes_order(struct ubifs_info c, struct list_head head);
3bb66b47 AB	303	int dbg_check_nondata_nodes_order(struct ubifs_info c, struct list_head head);
1e51764a	304
f57cb188	305	int dbg_leb_write(struct ubifs_info c, int lnum, const void buf, int offs,
b36a261e RW	306	int len);
b36a261e RW	307	int dbg_leb_change(struct ubifs_info c, int lnum, const void buf, int len);
f57cb188	308	int dbg_leb_unmap(struct ubifs_info *c, int lnum);
b36a261e	309	int dbg_leb_map(struct ubifs_info *c, int lnum);
1e51764a	310
552ff317 AB	311	/* Debugfs-related stuff */
	312	int dbg_debugfs_init(void);
	313	void dbg_debugfs_exit(void);
	314	int dbg_debugfs_init_fs(struct ubifs_info *c);
	315	void dbg_debugfs_exit_fs(struct ubifs_info *c);
	316
1e51764a	317	#endif /* !__UBIFS_DEBUG_H__ */