blob: 9f717655df18a3e908aff028b3f3c7cae36ef94e [file] [log] [blame]
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001/*
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
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -070026/* Checking helper functions */
27typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
28 struct ubifs_zbranch *zbr, void *priv);
29typedef int (*dbg_znode_callback)(struct ubifs_info *c,
30 struct ubifs_znode *znode, void *priv);
31
Artem Bityutskiy1e517642008-07-14 19:08:37 +030032#ifdef CONFIG_UBIFS_FS_DEBUG
33
Artem Bityutskiyae380ce2011-05-19 14:13:16 +030034/*
35 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
36 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
37 */
38#define UBIFS_DFS_DIR_NAME "ubi%d_%d"
39#define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
40
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +030041/**
42 * ubifs_debug_info - per-FS debugging information.
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +030043 * @old_zroot: old index root - used by 'dbg_check_old_index()'
44 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()'
45 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()'
Artem Bityutskiy81e79d32011-05-31 18:16:34 +030046 *
Artem Bityutskiyd27462a2011-06-03 15:10:33 +030047 * @pc_happened: non-zero if an emulated power cut happened
48 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
49 * @pc_timeout: time in jiffies when delay of failure mode expires
50 * @pc_cnt: current number of calls to failure mode I/O functions
51 * @pc_cnt_max: number of calls by which to delay failure mode
Artem Bityutskiy81e79d32011-05-31 18:16:34 +030052 *
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +030053 * @chk_lpt_sz: used by LPT tree size checker
54 * @chk_lpt_sz2: used by LPT tree size checker
55 * @chk_lpt_wastage: used by LPT tree size checker
56 * @chk_lpt_lebs: used by LPT tree size checker
57 * @new_nhead_offs: used by LPT tree size checker
Artem Bityutskiy84abf972009-01-23 14:54:59 +020058 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
59 * @new_ihead_offs: used by debugging to check @c->ihead_offs
Artem Bityutskiy552ff312008-10-23 11:49:28 +030060 *
Artem Bityutskiy84abf972009-01-23 14:54:59 +020061 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
Artem Bityutskiyf1bd66a2011-03-29 18:36:21 +030062 * @saved_bi: saved budgeting information
63 * @saved_free: saved amount of free space
64 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
Artem Bityutskiy84abf972009-01-23 14:54:59 +020065 *
Artem Bityutskiy81e79d32011-05-31 18:16:34 +030066 * @chk_gen: if general extra checks are enabled
67 * @chk_index: if index xtra checks are enabled
68 * @chk_orph: if orphans extra checks are enabled
69 * @chk_lprops: if lprops extra checks are enabled
70 * @chk_fs: if UBIFS contents extra checks are enabled
71 * @tst_rcvry: if UBIFS recovery testing mode enabled
72 *
Artem Bityutskiybdc1a1b2011-05-17 14:07:24 +030073 * @dfs_dir_name: name of debugfs directory containing this file-system's files
74 * @dfs_dir: direntry object of the file-system debugfs directory
75 * @dfs_dump_lprops: "dump lprops" debugfs knob
76 * @dfs_dump_budg: "dump budgeting information" debugfs knob
77 * @dfs_dump_tnc: "dump TNC" debugfs knob
Artem Bityutskiy81e79d32011-05-31 18:16:34 +030078 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
79 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
80 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
81 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
82 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
83 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +030084 */
85struct ubifs_debug_info {
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +030086 struct ubifs_zbranch old_zroot;
87 int old_zroot_level;
88 unsigned long long old_zroot_sqnum;
Artem Bityutskiy81e79d32011-05-31 18:16:34 +030089
Artem Bityutskiyd27462a2011-06-03 15:10:33 +030090 int pc_happened;
91 int pc_delay;
92 unsigned long pc_timeout;
93 unsigned int pc_cnt;
94 unsigned int pc_cnt_max;
Artem Bityutskiy81e79d32011-05-31 18:16:34 +030095
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +030096 long long chk_lpt_sz;
97 long long chk_lpt_sz2;
98 long long chk_lpt_wastage;
99 int chk_lpt_lebs;
100 int new_nhead_offs;
101 int new_ihead_lnum;
102 int new_ihead_offs;
Artem Bityutskiy552ff312008-10-23 11:49:28 +0300103
Artem Bityutskiy84abf972009-01-23 14:54:59 +0200104 struct ubifs_lp_stats saved_lst;
Artem Bityutskiyf1bd66a2011-03-29 18:36:21 +0300105 struct ubifs_budg_info saved_bi;
Artem Bityutskiy84abf972009-01-23 14:54:59 +0200106 long long saved_free;
Artem Bityutskiyf1bd66a2011-03-29 18:36:21 +0300107 int saved_idx_gc_cnt;
Artem Bityutskiy84abf972009-01-23 14:54:59 +0200108
Artem Bityutskiy81e79d32011-05-31 18:16:34 +0300109 unsigned int chk_gen:1;
110 unsigned int chk_index:1;
111 unsigned int chk_orph:1;
112 unsigned int chk_lprops:1;
113 unsigned int chk_fs:1;
114 unsigned int tst_rcvry:1;
115
Artem Bityutskiyae380ce2011-05-19 14:13:16 +0300116 char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
Artem Bityutskiy84abf972009-01-23 14:54:59 +0200117 struct dentry *dfs_dir;
118 struct dentry *dfs_dump_lprops;
119 struct dentry *dfs_dump_budg;
120 struct dentry *dfs_dump_tnc;
Artem Bityutskiy81e79d32011-05-31 18:16:34 +0300121 struct dentry *dfs_chk_gen;
122 struct dentry *dfs_chk_index;
123 struct dentry *dfs_chk_orph;
124 struct dentry *dfs_chk_lprops;
125 struct dentry *dfs_chk_fs;
126 struct dentry *dfs_tst_rcvry;
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +0300127};
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300128
Artem Bityutskiye7717062011-06-01 17:43:43 +0300129/**
130 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
131 *
132 * @chk_gen: if general extra checks are enabled
133 * @chk_index: if index xtra checks are enabled
134 * @chk_orph: if orphans extra checks are enabled
135 * @chk_lprops: if lprops extra checks are enabled
136 * @chk_fs: if UBIFS contents extra checks are enabled
137 * @tst_rcvry: if UBIFS recovery testing mode enabled
138 */
139struct ubifs_global_debug_info {
140 unsigned int chk_gen:1;
141 unsigned int chk_index:1;
142 unsigned int chk_orph:1;
143 unsigned int chk_lprops:1;
144 unsigned int chk_fs:1;
145 unsigned int tst_rcvry:1;
146};
147
Artem Bityutskiy840dc6b2008-08-01 18:13:37 +0300148#define ubifs_assert(expr) do { \
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300149 if (unlikely(!(expr))) { \
150 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
151 __func__, __LINE__, current->pid); \
152 dbg_dump_stack(); \
153 } \
154} while (0)
155
156#define ubifs_assert_cmt_locked(c) do { \
157 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
158 up_write(&(c)->commit_sem); \
159 printk(KERN_CRIT "commit lock is not locked!\n"); \
160 ubifs_assert(0); \
161 } \
162} while (0)
163
Artem Bityutskiyec068142011-04-26 10:21:54 +0300164#define dbg_dump_stack() dump_stack()
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300165
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300166#define dbg_err(fmt, ...) do { \
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300167 ubifs_err(fmt, ##__VA_ARGS__); \
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300168} while (0)
169
Artem Bityutskiy1f5d78d2012-01-11 15:13:27 +0200170#define ubifs_dbg_msg(type, fmt, ...) \
171 pr_debug("UBIFS DBG " type ": " fmt "\n", ##__VA_ARGS__)
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300172
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200173#define DBG_KEY_BUF_LEN 32
174#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
175 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
176 pr_debug("UBIFS DBG " type ": " fmt "%s\n", ##__VA_ARGS__, \
177 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
178} while (0)
179
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300180/* Just a debugging messages not related to any specific UBIFS subsystem */
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200181#define dbg_msg(fmt, ...) \
182 printk(KERN_DEBUG "UBIFS DBG (pid %d): %s: " fmt "\n", current->pid, \
Artem Bityutskiyd34315d2012-01-10 19:32:30 +0200183 __func__, ##__VA_ARGS__)
184
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300185/* General messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300186#define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300187/* Additional journal messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300188#define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200189#define dbg_jnlk(key, fmt, ...) \
190 ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300191/* Additional TNC messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300192#define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200193#define dbg_tnck(key, fmt, ...) \
194 ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300195/* Additional lprops messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300196#define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300197/* Additional LEB find messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300198#define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300199/* Additional mount messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300200#define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200201#define dbg_mntk(key, fmt, ...) \
202 ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300203/* Additional I/O messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300204#define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300205/* Additional commit messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300206#define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300207/* Additional budgeting messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300208#define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300209/* Additional log messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300210#define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300211/* Additional gc messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300212#define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300213/* Additional scan messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300214#define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300215/* Additional recovery messages */
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300216#define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300217
Artem Bityutskiye7717062011-06-01 17:43:43 +0300218extern struct ubifs_global_debug_info ubifs_dbg;
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300219
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300220static inline int dbg_is_chk_gen(const struct ubifs_info *c)
221{
Artem Bityutskiye7717062011-06-01 17:43:43 +0300222 return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300223}
Artem Bityutskiy8d7819b2011-06-03 08:53:35 +0300224static inline int dbg_is_chk_index(const struct ubifs_info *c)
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300225{
Artem Bityutskiye7717062011-06-01 17:43:43 +0300226 return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300227}
228static inline int dbg_is_chk_orph(const struct ubifs_info *c)
229{
Artem Bityutskiye7717062011-06-01 17:43:43 +0300230 return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300231}
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300232static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
233{
Artem Bityutskiye7717062011-06-01 17:43:43 +0300234 return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300235}
236static inline int dbg_is_chk_fs(const struct ubifs_info *c)
237{
Artem Bityutskiye7717062011-06-01 17:43:43 +0300238 return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300239}
240static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
241{
Artem Bityutskiye7717062011-06-01 17:43:43 +0300242 return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300243}
Artem Bityutskiy83cef702011-06-03 13:45:09 +0300244static inline int dbg_is_power_cut(const struct ubifs_info *c)
245{
Artem Bityutskiyd27462a2011-06-03 15:10:33 +0300246 return !!c->dbg->pc_happened;
Artem Bityutskiy83cef702011-06-03 13:45:09 +0300247}
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300248
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +0300249int ubifs_debugging_init(struct ubifs_info *c);
250void ubifs_debugging_exit(struct ubifs_info *c);
251
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300252/* Dump functions */
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300253const char *dbg_ntype(int type);
254const char *dbg_cstate(int cmt_state);
Artem Bityutskiy77a7ae52009-09-15 15:03:51 +0300255const char *dbg_jhead(int jhead);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300256const char *dbg_get_key_dump(const struct ubifs_info *c,
257 const union ubifs_key *key);
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200258const char *dbg_snprintf_key(const struct ubifs_info *c,
259 const union ubifs_key *key, char *buffer, int len);
Artem Bityutskiy4315fb42011-05-25 17:32:42 +0300260void dbg_dump_inode(struct ubifs_info *c, const struct inode *inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300261void dbg_dump_node(const struct ubifs_info *c, const void *node);
Artem Bityutskiy2ba5f7a2008-10-31 17:32:30 +0200262void dbg_dump_lpt_node(const struct ubifs_info *c, void *node, int lnum,
263 int offs);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300264void dbg_dump_budget_req(const struct ubifs_budget_req *req);
265void dbg_dump_lstats(const struct ubifs_lp_stats *lst);
Artem Bityutskiyf1bd66a2011-03-29 18:36:21 +0300266void dbg_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300267void dbg_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp);
268void dbg_dump_lprops(struct ubifs_info *c);
Adrian Hunter73944a62008-09-12 18:13:31 +0300269void dbg_dump_lpt_info(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300270void dbg_dump_leb(const struct ubifs_info *c, int lnum);
Artem Bityutskiyd37854c2011-08-22 16:23:56 +0300271void dbg_dump_sleb(const struct ubifs_info *c,
272 const struct ubifs_scan_leb *sleb, int offs);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300273void dbg_dump_znode(const struct ubifs_info *c,
274 const struct ubifs_znode *znode);
275void dbg_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat);
276void dbg_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
277 struct ubifs_nnode *parent, int iip);
278void dbg_dump_tnc(struct ubifs_info *c);
279void dbg_dump_index(struct ubifs_info *c);
Artem Bityutskiy2ba5f7a2008-10-31 17:32:30 +0200280void dbg_dump_lpt_lebs(const struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300281
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300282int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
283 dbg_znode_callback znode_cb, void *priv);
284
285/* Checking functions */
Artem Bityutskiy84abf972009-01-23 14:54:59 +0200286void dbg_save_space_info(struct ubifs_info *c);
287int dbg_check_space_info(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300288int dbg_check_lprops(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300289int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
290int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300291int dbg_check_cats(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300292int dbg_check_ltab(struct ubifs_info *c);
Adrian Hunter73944a62008-09-12 18:13:31 +0300293int dbg_chk_lpt_free_spc(struct ubifs_info *c);
294int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
Artem Bityutskiyd808efb2011-05-31 18:14:38 +0300295int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
Artem Bityutskiy1b51e982011-05-25 17:38:29 +0300296int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300297int dbg_check_tnc(struct ubifs_info *c, int extra);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300298int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300299int dbg_check_filesystem(struct ubifs_info *c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300300void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
301 int add_pos);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300302int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
303 int row, int col);
Artem Bityutskiye3c3efc2009-08-27 16:34:19 +0300304int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
305 loff_t size);
Artem Bityutskiy3bb66b42010-08-07 10:06:11 +0300306int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
307int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300308
Artem Bityutskiyf57cb182011-06-03 14:51:41 +0300309int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
310 int len, int dtype);
311int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len,
312 int dtype);
313int dbg_leb_unmap(struct ubifs_info *c, int lnum);
314int dbg_leb_map(struct ubifs_info *c, int lnum, int dtype);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300315
Artem Bityutskiy552ff312008-10-23 11:49:28 +0300316/* Debugfs-related stuff */
317int dbg_debugfs_init(void);
318void dbg_debugfs_exit(void);
319int dbg_debugfs_init_fs(struct ubifs_info *c);
320void dbg_debugfs_exit_fs(struct ubifs_info *c);
321
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300322#else /* !CONFIG_UBIFS_FS_DEBUG */
323
Artem Bityutskiy840dc6b2008-08-01 18:13:37 +0300324/* Use "if (0)" to make compiler check arguments even if debugging is off */
325#define ubifs_assert(expr) do { \
Artem Bityutskiyae380ce2011-05-19 14:13:16 +0300326 if (0) \
Artem Bityutskiy840dc6b2008-08-01 18:13:37 +0300327 printk(KERN_CRIT "UBIFS assert failed in %s at %u (pid %d)\n", \
328 __func__, __LINE__, current->pid); \
329} while (0)
330
Artem Bityutskiy56e46742011-05-17 15:15:30 +0300331#define dbg_err(fmt, ...) do { \
332 if (0) \
333 ubifs_err(fmt, ##__VA_ARGS__); \
Artem Bityutskiy840dc6b2008-08-01 18:13:37 +0300334} while (0)
335
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300336#define DBGKEY(key) ((char *)(key))
337#define DBGKEY1(key) ((char *)(key))
338
Michal Marek016f1c52011-08-11 12:29:46 +0200339#define ubifs_dbg_msg(fmt, ...) do { \
340 if (0) \
341 printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \
Artem Bityutskiy840dc6b2008-08-01 18:13:37 +0300342} while (0)
343
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300344#define dbg_dump_stack()
Artem Bityutskiy840dc6b2008-08-01 18:13:37 +0300345#define ubifs_assert_cmt_locked(c)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300346
Dominique Martinete234b5f2012-01-15 00:28:03 +0100347#define dbg_msg(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
348#define dbg_gen(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
349#define dbg_jnl(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
350#define dbg_jnlk(key, fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
351#define dbg_tnc(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
352#define dbg_tnck(key, fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
353#define dbg_lp(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
354#define dbg_find(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
355#define dbg_mnt(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
356#define dbg_mntk(key, fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
357#define dbg_io(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
358#define dbg_cmt(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
359#define dbg_budg(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
360#define dbg_log(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
361#define dbg_gc(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
362#define dbg_scan(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
363#define dbg_rcvry(fmt, ...) ubifs_dbg_msg(fmt, ##__VA_ARGS__)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300364
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700365static inline int ubifs_debugging_init(struct ubifs_info *c) { return 0; }
366static inline void ubifs_debugging_exit(struct ubifs_info *c) { return; }
367static inline const char *dbg_ntype(int type) { return ""; }
368static inline const char *dbg_cstate(int cmt_state) { return ""; }
369static inline const char *dbg_jhead(int jhead) { return ""; }
370static inline const char *
371dbg_get_key_dump(const struct ubifs_info *c,
372 const union ubifs_key *key) { return ""; }
Artem Bityutskiy515315a2012-01-13 12:33:53 +0200373static inline const char *
374dbg_snprintf_key(const struct ubifs_info *c,
375 const union ubifs_key *key, char *buffer,
376 int len) { return ""; }
Artem Bityutskiy4315fb42011-05-25 17:32:42 +0300377static inline void dbg_dump_inode(struct ubifs_info *c,
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700378 const struct inode *inode) { return; }
379static inline void dbg_dump_node(const struct ubifs_info *c,
380 const void *node) { return; }
381static inline void dbg_dump_lpt_node(const struct ubifs_info *c,
382 void *node, int lnum,
383 int offs) { return; }
384static inline void
385dbg_dump_budget_req(const struct ubifs_budget_req *req) { return; }
386static inline void
387dbg_dump_lstats(const struct ubifs_lp_stats *lst) { return; }
Artem Bityutskiyf1bd66a2011-03-29 18:36:21 +0300388static inline void
389dbg_dump_budg(struct ubifs_info *c,
390 const struct ubifs_budg_info *bi) { return; }
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700391static inline void dbg_dump_lprop(const struct ubifs_info *c,
392 const struct ubifs_lprops *lp) { return; }
393static inline void dbg_dump_lprops(struct ubifs_info *c) { return; }
394static inline void dbg_dump_lpt_info(struct ubifs_info *c) { return; }
395static inline void dbg_dump_leb(const struct ubifs_info *c,
396 int lnum) { return; }
397static inline void
Artem Bityutskiyd37854c2011-08-22 16:23:56 +0300398dbg_dump_sleb(const struct ubifs_info *c,
399 const struct ubifs_scan_leb *sleb, int offs) { return; }
400static inline void
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700401dbg_dump_znode(const struct ubifs_info *c,
402 const struct ubifs_znode *znode) { return; }
403static inline void dbg_dump_heap(struct ubifs_info *c,
404 struct ubifs_lpt_heap *heap,
405 int cat) { return; }
406static inline void dbg_dump_pnode(struct ubifs_info *c,
407 struct ubifs_pnode *pnode,
408 struct ubifs_nnode *parent,
409 int iip) { return; }
410static inline void dbg_dump_tnc(struct ubifs_info *c) { return; }
411static inline void dbg_dump_index(struct ubifs_info *c) { return; }
412static inline void dbg_dump_lpt_lebs(const struct ubifs_info *c) { return; }
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +0300413
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700414static inline int dbg_walk_index(struct ubifs_info *c,
415 dbg_leaf_callback leaf_cb,
416 dbg_znode_callback znode_cb,
417 void *priv) { return 0; }
418static inline void dbg_save_space_info(struct ubifs_info *c) { return; }
419static inline int dbg_check_space_info(struct ubifs_info *c) { return 0; }
420static inline int dbg_check_lprops(struct ubifs_info *c) { return 0; }
421static inline int
422dbg_old_index_check_init(struct ubifs_info *c,
423 struct ubifs_zbranch *zroot) { return 0; }
424static inline int
425dbg_check_old_index(struct ubifs_info *c,
426 struct ubifs_zbranch *zroot) { return 0; }
427static inline int dbg_check_cats(struct ubifs_info *c) { return 0; }
428static inline int dbg_check_ltab(struct ubifs_info *c) { return 0; }
429static inline int dbg_chk_lpt_free_spc(struct ubifs_info *c) { return 0; }
430static inline int dbg_chk_lpt_sz(struct ubifs_info *c,
431 int action, int len) { return 0; }
Artem Bityutskiyd808efb2011-05-31 18:14:38 +0300432static inline int
433dbg_check_synced_i_size(const struct ubifs_info *c,
434 struct inode *inode) { return 0; }
Artem Bityutskiy1b51e982011-05-25 17:38:29 +0300435static inline int dbg_check_dir(struct ubifs_info *c,
Artem Bityutskiy4315fb42011-05-25 17:32:42 +0300436 const struct inode *dir) { return 0; }
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700437static inline int dbg_check_tnc(struct ubifs_info *c, int extra) { return 0; }
438static inline int dbg_check_idx_size(struct ubifs_info *c,
439 long long idx_size) { return 0; }
440static inline int dbg_check_filesystem(struct ubifs_info *c) { return 0; }
441static inline void dbg_check_heap(struct ubifs_info *c,
442 struct ubifs_lpt_heap *heap,
443 int cat, int add_pos) { return; }
444static inline int dbg_check_lpt_nodes(struct ubifs_info *c,
445 struct ubifs_cnode *cnode, int row, int col) { return 0; }
446static inline int dbg_check_inode_size(struct ubifs_info *c,
447 const struct inode *inode,
448 loff_t size) { return 0; }
449static inline int
450dbg_check_data_nodes_order(struct ubifs_info *c,
451 struct list_head *head) { return 0; }
452static inline int
453dbg_check_nondata_nodes_order(struct ubifs_info *c,
454 struct list_head *head) { return 0; }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300455
Artem Bityutskiyf57cb182011-06-03 14:51:41 +0300456static inline int dbg_leb_write(struct ubifs_info *c, int lnum,
457 const void *buf, int offset,
458 int len, int dtype) { return 0; }
459static inline int dbg_leb_change(struct ubifs_info *c, int lnum,
460 const void *buf, int len,
461 int dtype) { return 0; }
462static inline int dbg_leb_unmap(struct ubifs_info *c, int lnum) { return 0; }
463static inline int dbg_leb_map(struct ubifs_info *c, int lnum,
464 int dtype) { return 0; }
Artem Bityutskiy83cef702011-06-03 13:45:09 +0300465
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300466static inline int dbg_is_chk_gen(const struct ubifs_info *c) { return 0; }
Artem Bityutskiy8d7819b2011-06-03 08:53:35 +0300467static inline int dbg_is_chk_index(const struct ubifs_info *c) { return 0; }
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300468static inline int dbg_is_chk_orph(const struct ubifs_info *c) { return 0; }
Artem Bityutskiy2b1844a2011-06-03 08:31:29 +0300469static inline int dbg_is_chk_lprops(const struct ubifs_info *c) { return 0; }
470static inline int dbg_is_chk_fs(const struct ubifs_info *c) { return 0; }
471static inline int dbg_is_tst_rcvry(const struct ubifs_info *c) { return 0; }
Artem Bityutskiy83cef702011-06-03 13:45:09 +0300472static inline int dbg_is_power_cut(const struct ubifs_info *c) { return 0; }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300473
Maksim Rayskiy1dcffad2011-04-12 15:14:56 -0700474static inline int dbg_debugfs_init(void) { return 0; }
475static inline void dbg_debugfs_exit(void) { return; }
476static inline int dbg_debugfs_init_fs(struct ubifs_info *c) { return 0; }
477static inline int dbg_debugfs_exit_fs(struct ubifs_info *c) { return 0; }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300478
Artem Bityutskiy552ff312008-10-23 11:49:28 +0300479#endif /* !CONFIG_UBIFS_FS_DEBUG */
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300480#endif /* !__UBIFS_DEBUG_H__ */