38230b1e544e355359534faf98fec7a7d8c6bd2b
[linux-3.10.git] / fs / ubifs / debug.h
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 /* 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
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
39 /**
40  * ubifs_debug_info - per-FS debugging information.
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()'
44  *
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
50  *
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
56  * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
57  * @new_ihead_offs: used by debugging to check @c->ihead_offs
58  *
59  * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
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
63  *
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  *
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
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
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)
86  */
87 struct ubifs_debug_info {
88         struct ubifs_zbranch old_zroot;
89         int old_zroot_level;
90         unsigned long long old_zroot_sqnum;
91
92         int pc_happened;
93         int pc_delay;
94         unsigned long pc_timeout;
95         unsigned int pc_cnt;
96         unsigned int pc_cnt_max;
97
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;
105
106         struct ubifs_lp_stats saved_lst;
107         struct ubifs_budg_info saved_bi;
108         long long saved_free;
109         int saved_idx_gc_cnt;
110
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
118         char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
119         struct dentry *dfs_dir;
120         struct dentry *dfs_dump_lprops;
121         struct dentry *dfs_dump_budg;
122         struct dentry *dfs_dump_tnc;
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;
129         struct dentry *dfs_ro_error;
130 };
131
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
151 #define ubifs_assert(expr) do {                                                \
152         if (unlikely(!(expr))) {                                               \
153                 pr_crit("UBIFS assert failed in %s at %u (pid %d)\n",          \
154                        __func__, __LINE__, current->pid);                      \
155                 dump_stack();                                                  \
156         }                                                                      \
157 } while (0)
158
159 #define ubifs_assert_cmt_locked(c) do {                                        \
160         if (unlikely(down_write_trylock(&(c)->commit_sem))) {                  \
161                 up_write(&(c)->commit_sem);                                    \
162                 pr_crit("commit lock is not locked!\n");                       \
163                 ubifs_assert(0);                                               \
164         }                                                                      \
165 } while (0)
166
167 #define ubifs_dbg_msg(type, fmt, ...) \
168         pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid,       \
169                  ##__VA_ARGS__)
170
171 #define DBG_KEY_BUF_LEN 48
172 #define ubifs_dbg_msg_key(type, key, fmt, ...) do {                            \
173         char __tmp_key_buf[DBG_KEY_BUF_LEN];                                   \
174         pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid,     \
175                  ##__VA_ARGS__,                                                \
176                  dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN));    \
177 } while (0)
178
179 /* Just a debugging messages not related to any specific UBIFS subsystem */
180 #define dbg_msg(fmt, ...)                                                      \
181         pr_err("UBIFS DBG (pid %d): %s: " fmt "\n", current->pid,              \
182                __func__, ##__VA_ARGS__)
183
184 /* General messages */
185 #define dbg_gen(fmt, ...)   ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
186 /* Additional journal messages */
187 #define dbg_jnl(fmt, ...)   ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
188 #define dbg_jnlk(key, fmt, ...) \
189         ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
190 /* Additional TNC messages */
191 #define dbg_tnc(fmt, ...)   ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
192 #define dbg_tnck(key, fmt, ...) \
193         ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
194 /* Additional lprops messages */
195 #define dbg_lp(fmt, ...)    ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
196 /* Additional LEB find messages */
197 #define dbg_find(fmt, ...)  ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
198 /* Additional mount messages */
199 #define dbg_mnt(fmt, ...)   ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
200 #define dbg_mntk(key, fmt, ...) \
201         ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
202 /* Additional I/O messages */
203 #define dbg_io(fmt, ...)    ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
204 /* Additional commit messages */
205 #define dbg_cmt(fmt, ...)   ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
206 /* Additional budgeting messages */
207 #define dbg_budg(fmt, ...)  ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
208 /* Additional log messages */
209 #define dbg_log(fmt, ...)   ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
210 /* Additional gc messages */
211 #define dbg_gc(fmt, ...)    ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
212 /* Additional scan messages */
213 #define dbg_scan(fmt, ...)  ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
214 /* Additional recovery messages */
215 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
216
217 extern struct ubifs_global_debug_info ubifs_dbg;
218
219 static inline int dbg_is_chk_gen(const struct ubifs_info *c)
220 {
221         return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
222 }
223 static inline int dbg_is_chk_index(const struct ubifs_info *c)
224 {
225         return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
226 }
227 static inline int dbg_is_chk_orph(const struct ubifs_info *c)
228 {
229         return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
230 }
231 static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
232 {
233         return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
234 }
235 static inline int dbg_is_chk_fs(const struct ubifs_info *c)
236 {
237         return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
238 }
239 static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
240 {
241         return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
242 }
243 static inline int dbg_is_power_cut(const struct ubifs_info *c)
244 {
245         return !!c->dbg->pc_happened;
246 }
247
248 int ubifs_debugging_init(struct ubifs_info *c);
249 void ubifs_debugging_exit(struct ubifs_info *c);
250
251 /* Dump functions */
252 const char *dbg_ntype(int type);
253 const char *dbg_cstate(int cmt_state);
254 const char *dbg_jhead(int jhead);
255 const char *dbg_get_key_dump(const struct ubifs_info *c,
256                              const union ubifs_key *key);
257 const char *dbg_snprintf_key(const struct ubifs_info *c,
258                              const union ubifs_key *key, char *buffer, int len);
259 void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode);
260 void ubifs_dump_node(const struct ubifs_info *c, const void *node);
261 void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
262 void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
263 void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
264 void ubifs_dump_lprop(const struct ubifs_info *c,
265                       const struct ubifs_lprops *lp);
266 void ubifs_dump_lprops(struct ubifs_info *c);
267 void ubifs_dump_lpt_info(struct ubifs_info *c);
268 void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
269 void ubifs_dump_sleb(const struct ubifs_info *c,
270                      const struct ubifs_scan_leb *sleb, int offs);
271 void ubifs_dump_znode(const struct ubifs_info *c,
272                       const struct ubifs_znode *znode);
273 void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap,
274                      int cat);
275 void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
276                       struct ubifs_nnode *parent, int iip);
277 void ubifs_dump_tnc(struct ubifs_info *c);
278 void ubifs_dump_index(struct ubifs_info *c);
279 void ubifs_dump_lpt_lebs(const struct ubifs_info *c);
280
281 int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
282                    dbg_znode_callback znode_cb, void *priv);
283
284 /* Checking functions */
285 void dbg_save_space_info(struct ubifs_info *c);
286 int dbg_check_space_info(struct ubifs_info *c);
287 int dbg_check_lprops(struct ubifs_info *c);
288 int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
289 int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
290 int dbg_check_cats(struct ubifs_info *c);
291 int dbg_check_ltab(struct ubifs_info *c);
292 int dbg_chk_lpt_free_spc(struct ubifs_info *c);
293 int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
294 int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
295 int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
296 int dbg_check_tnc(struct ubifs_info *c, int extra);
297 int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
298 int dbg_check_filesystem(struct ubifs_info *c);
299 void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
300                     int add_pos);
301 int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
302                         int row, int col);
303 int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
304                          loff_t size);
305 int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
306 int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
307
308 int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
309                   int len);
310 int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
311 int dbg_leb_unmap(struct ubifs_info *c, int lnum);
312 int dbg_leb_map(struct ubifs_info *c, int lnum);
313
314 /* Debugfs-related stuff */
315 int dbg_debugfs_init(void);
316 void dbg_debugfs_exit(void);
317 int dbg_debugfs_init_fs(struct ubifs_info *c);
318 void dbg_debugfs_exit_fs(struct ubifs_info *c);
319
320 #endif /* !__UBIFS_DEBUG_H__ */