blob: 807ce1b7338033dded1ffc68c45eb0d7e53957a2 [file] [log] [blame]
Stefan Roese9eefe2a2009-03-19 15:35:05 +01001/*
2 * This file is part of UBIFS.
3 *
4 * Copyright (C) 2006-2008 Nokia Corporation.
5 *
Heiko Schocherff94bc42014-06-24 10:10:04 +02006 * SPDX-License-Identifier: GPL-2.0+
Stefan Roese9eefe2a2009-03-19 15:35:05 +01007 *
8 * Authors: Artem Bityutskiy (Битюцкий Артём)
9 * Adrian Hunter
10 */
11
12#ifndef __UBIFS_DEBUG_H__
13#define __UBIFS_DEBUG_H__
14
Heiko Schocherff94bc42014-06-24 10:10:04 +020015/* Checking helper functions */
16typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
17 struct ubifs_zbranch *zbr, void *priv);
18typedef int (*dbg_znode_callback)(struct ubifs_info *c,
19 struct ubifs_znode *znode, void *priv);
20
21/*
22 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi"
23 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte.
24 */
25#define UBIFS_DFS_DIR_NAME "ubi%d_%d"
26#define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1)
Stefan Roese9eefe2a2009-03-19 15:35:05 +010027
28/**
29 * ubifs_debug_info - per-FS debugging information.
Stefan Roese9eefe2a2009-03-19 15:35:05 +010030 * @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()'
Heiko Schocherff94bc42014-06-24 10:10:04 +020033 *
34 * @pc_happened: non-zero if an emulated power cut happened
35 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls
36 * @pc_timeout: time in jiffies when delay of failure mode expires
37 * @pc_cnt: current number of calls to failure mode I/O functions
38 * @pc_cnt_max: number of calls by which to delay failure mode
39 *
Stefan Roese9eefe2a2009-03-19 15:35:05 +010040 * @chk_lpt_sz: used by LPT tree size checker
41 * @chk_lpt_sz2: used by LPT tree size checker
42 * @chk_lpt_wastage: used by LPT tree size checker
43 * @chk_lpt_lebs: used by LPT tree size checker
44 * @new_nhead_offs: used by LPT tree size checker
45 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum
46 * @new_ihead_offs: used by debugging to check @c->ihead_offs
47 *
48 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()')
Heiko Schocherff94bc42014-06-24 10:10:04 +020049 * @saved_bi: saved budgeting information
50 * @saved_free: saved amount of free space
51 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt
Stefan Roese9eefe2a2009-03-19 15:35:05 +010052 *
Heiko Schocherff94bc42014-06-24 10:10:04 +020053 * @chk_gen: if general extra checks are enabled
54 * @chk_index: if index xtra checks are enabled
55 * @chk_orph: if orphans extra checks are enabled
56 * @chk_lprops: if lprops extra checks are enabled
57 * @chk_fs: if UBIFS contents extra checks are enabled
58 * @tst_rcvry: if UBIFS recovery testing mode enabled
59 *
60 * @dfs_dir_name: name of debugfs directory containing this file-system's files
61 * @dfs_dir: direntry object of the file-system debugfs directory
62 * @dfs_dump_lprops: "dump lprops" debugfs knob
63 * @dfs_dump_budg: "dump budgeting information" debugfs knob
64 * @dfs_dump_tnc: "dump TNC" debugfs knob
65 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks
66 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks
67 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks
68 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks
69 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks
70 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing
71 * @dfs_ro_error: debugfs knob to switch UBIFS to R/O mode (different to
72 * re-mounting to R/O mode because it does not flush any buffers
73 * and UBIFS just starts returning -EROFS on all write
74 * operations)
Stefan Roese9eefe2a2009-03-19 15:35:05 +010075 */
76struct ubifs_debug_info {
Stefan Roese9eefe2a2009-03-19 15:35:05 +010077 struct ubifs_zbranch old_zroot;
78 int old_zroot_level;
79 unsigned long long old_zroot_sqnum;
Heiko Schocherff94bc42014-06-24 10:10:04 +020080
81 int pc_happened;
82 int pc_delay;
83 unsigned long pc_timeout;
84 unsigned int pc_cnt;
85 unsigned int pc_cnt_max;
86
Stefan Roese9eefe2a2009-03-19 15:35:05 +010087 long long chk_lpt_sz;
88 long long chk_lpt_sz2;
89 long long chk_lpt_wastage;
90 int chk_lpt_lebs;
91 int new_nhead_offs;
92 int new_ihead_lnum;
93 int new_ihead_offs;
94
95 struct ubifs_lp_stats saved_lst;
Heiko Schocherff94bc42014-06-24 10:10:04 +020096 struct ubifs_budg_info saved_bi;
Stefan Roese9eefe2a2009-03-19 15:35:05 +010097 long long saved_free;
Heiko Schocherff94bc42014-06-24 10:10:04 +020098 int saved_idx_gc_cnt;
Stefan Roese9eefe2a2009-03-19 15:35:05 +010099
Heiko Schocherff94bc42014-06-24 10:10:04 +0200100 unsigned int chk_gen:1;
101 unsigned int chk_index:1;
102 unsigned int chk_orph:1;
103 unsigned int chk_lprops:1;
104 unsigned int chk_fs:1;
105 unsigned int tst_rcvry:1;
106
107 char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1];
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100108 struct dentry *dfs_dir;
109 struct dentry *dfs_dump_lprops;
110 struct dentry *dfs_dump_budg;
111 struct dentry *dfs_dump_tnc;
Heiko Schocherff94bc42014-06-24 10:10:04 +0200112 struct dentry *dfs_chk_gen;
113 struct dentry *dfs_chk_index;
114 struct dentry *dfs_chk_orph;
115 struct dentry *dfs_chk_lprops;
116 struct dentry *dfs_chk_fs;
117 struct dentry *dfs_tst_rcvry;
118 struct dentry *dfs_ro_error;
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100119};
120
Heiko Schocherff94bc42014-06-24 10:10:04 +0200121/**
122 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
123 *
124 * @chk_gen: if general extra checks are enabled
125 * @chk_index: if index xtra checks are enabled
126 * @chk_orph: if orphans extra checks are enabled
127 * @chk_lprops: if lprops extra checks are enabled
128 * @chk_fs: if UBIFS contents extra checks are enabled
129 * @tst_rcvry: if UBIFS recovery testing mode enabled
130 */
131struct ubifs_global_debug_info {
132 unsigned int chk_gen:1;
133 unsigned int chk_index:1;
134 unsigned int chk_orph:1;
135 unsigned int chk_lprops:1;
136 unsigned int chk_fs:1;
137 unsigned int tst_rcvry:1;
138};
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100139
Heiko Schocherff94bc42014-06-24 10:10:04 +0200140#ifndef __UBOOT__
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100141#define ubifs_assert(expr) do { \
142 if (unlikely(!(expr))) { \
Heiko Schocherff94bc42014-06-24 10:10:04 +0200143 pr_crit("UBIFS assert failed in %s at %u (pid %d)\n", \
144 __func__, __LINE__, current->pid); \
145 dump_stack(); \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100146 } \
147} while (0)
148
149#define ubifs_assert_cmt_locked(c) do { \
150 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
151 up_write(&(c)->commit_sem); \
Heiko Schocherff94bc42014-06-24 10:10:04 +0200152 pr_crit("commit lock is not locked!\n"); \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100153 ubifs_assert(0); \
154 } \
155} while (0)
156
Heiko Schocherff94bc42014-06-24 10:10:04 +0200157#define ubifs_dbg_msg(type, fmt, ...) \
158 pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid, \
159 ##__VA_ARGS__)
160
161#define DBG_KEY_BUF_LEN 48
162#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
163 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
164 pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid, \
165 ##__VA_ARGS__, \
166 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
167} while (0)
168#else
169#define ubifs_assert(expr) do { \
170 if (unlikely(!(expr))) { \
171 pr_crit("UBIFS assert failed in %s at %u\n", \
172 __func__, __LINE__); \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100173 dump_stack(); \
Heiko Schocherff94bc42014-06-24 10:10:04 +0200174 } \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100175} while (0)
176
Heiko Schocherff94bc42014-06-24 10:10:04 +0200177#define ubifs_assert_cmt_locked(c) do { \
178 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \
179 up_write(&(c)->commit_sem); \
180 pr_crit("commit lock is not locked!\n"); \
181 ubifs_assert(0); \
182 } \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100183} while (0)
184
Heiko Schocherff94bc42014-06-24 10:10:04 +0200185#define ubifs_dbg_msg(type, fmt, ...) \
186 pr_debug("UBIFS DBG " type ": " fmt "\n", \
187 ##__VA_ARGS__)
188
189#define DBG_KEY_BUF_LEN 48
190#if defined CONFIG_MTD_DEBUG
191#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
192 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \
193 pr_debug("UBIFS DBG " type ": " fmt "%s\n", \
194 ##__VA_ARGS__, \
195 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \
196} while (0)
197#else
198#define ubifs_dbg_msg_key(type, key, fmt, ...) do { \
199 pr_debug("UBIFS DBG\n"); \
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100200} while (0)
201
Heiko Schocherff94bc42014-06-24 10:10:04 +0200202#endif
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100203
Heiko Schocherff94bc42014-06-24 10:10:04 +0200204#endif
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100205
206/* General messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200207#define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100208/* Additional journal messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200209#define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
210#define dbg_jnlk(key, fmt, ...) \
211 ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100212/* Additional TNC messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200213#define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
214#define dbg_tnck(key, fmt, ...) \
215 ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100216/* Additional lprops messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200217#define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100218/* Additional LEB find messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200219#define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100220/* Additional mount messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200221#define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
222#define dbg_mntk(key, fmt, ...) \
223 ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100224/* Additional I/O messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200225#define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100226/* Additional commit messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200227#define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100228/* Additional budgeting messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200229#define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100230/* Additional log messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200231#define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100232/* Additional gc messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200233#define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100234/* Additional scan messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200235#define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100236/* Additional recovery messages */
Heiko Schocherff94bc42014-06-24 10:10:04 +0200237#define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100238
Heiko Schocherff94bc42014-06-24 10:10:04 +0200239#ifndef __UBOOT__
240extern struct ubifs_global_debug_info ubifs_dbg;
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100241
Heiko Schocherff94bc42014-06-24 10:10:04 +0200242static inline int dbg_is_chk_gen(const struct ubifs_info *c)
243{
244 return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
245}
246static inline int dbg_is_chk_index(const struct ubifs_info *c)
247{
248 return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
249}
250static inline int dbg_is_chk_orph(const struct ubifs_info *c)
251{
252 return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
253}
254static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
255{
256 return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
257}
258static inline int dbg_is_chk_fs(const struct ubifs_info *c)
259{
260 return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
261}
262static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
263{
264 return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
265}
266static inline int dbg_is_power_cut(const struct ubifs_info *c)
267{
268 return !!c->dbg->pc_happened;
269}
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100270
Heiko Schocherff94bc42014-06-24 10:10:04 +0200271int ubifs_debugging_init(struct ubifs_info *c);
272void ubifs_debugging_exit(struct ubifs_info *c);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100273#else
Heiko Schocherff94bc42014-06-24 10:10:04 +0200274static inline int dbg_is_chk_gen(const struct ubifs_info *c)
275{
276 return 0;
277}
278static inline int dbg_is_chk_index(const struct ubifs_info *c)
279{
280 return 0;
281}
282static inline int dbg_is_chk_orph(const struct ubifs_info *c)
283{
284 return 0;
285}
286static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
287{
288 return 0;
289}
290static inline int dbg_is_chk_fs(const struct ubifs_info *c)
291{
292 return 0;
293}
294static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
295{
296 return 0;
297}
298static inline int dbg_is_power_cut(const struct ubifs_info *c)
299{
300 return 0;
301}
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100302
303int ubifs_debugging_init(struct ubifs_info *c);
304void ubifs_debugging_exit(struct ubifs_info *c);
305
Heiko Schocherff94bc42014-06-24 10:10:04 +0200306#endif
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100307
Heiko Schocherff94bc42014-06-24 10:10:04 +0200308/* Dump functions */
309const char *dbg_ntype(int type);
310const char *dbg_cstate(int cmt_state);
311const char *dbg_jhead(int jhead);
312const char *dbg_get_key_dump(const struct ubifs_info *c,
313 const union ubifs_key *key);
314const char *dbg_snprintf_key(const struct ubifs_info *c,
315 const union ubifs_key *key, char *buffer, int len);
316void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode);
317void ubifs_dump_node(const struct ubifs_info *c, const void *node);
318void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
319void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
320void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
321void ubifs_dump_lprop(const struct ubifs_info *c,
322 const struct ubifs_lprops *lp);
323void ubifs_dump_lprops(struct ubifs_info *c);
324void ubifs_dump_lpt_info(struct ubifs_info *c);
325void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
326void ubifs_dump_sleb(const struct ubifs_info *c,
327 const struct ubifs_scan_leb *sleb, int offs);
328void ubifs_dump_znode(const struct ubifs_info *c,
329 const struct ubifs_znode *znode);
330void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap,
331 int cat);
332void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
333 struct ubifs_nnode *parent, int iip);
334void ubifs_dump_tnc(struct ubifs_info *c);
335void ubifs_dump_index(struct ubifs_info *c);
336void ubifs_dump_lpt_lebs(const struct ubifs_info *c);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100337
Heiko Schocherff94bc42014-06-24 10:10:04 +0200338int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
339 dbg_znode_callback znode_cb, void *priv);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100340
Heiko Schocherff94bc42014-06-24 10:10:04 +0200341/* Checking functions */
342void dbg_save_space_info(struct ubifs_info *c);
343int dbg_check_space_info(struct ubifs_info *c);
344int dbg_check_lprops(struct ubifs_info *c);
345int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
346int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
347int dbg_check_cats(struct ubifs_info *c);
348int dbg_check_ltab(struct ubifs_info *c);
349int dbg_chk_lpt_free_spc(struct ubifs_info *c);
350int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
351int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
352int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
353int dbg_check_tnc(struct ubifs_info *c, int extra);
354int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
355int dbg_check_filesystem(struct ubifs_info *c);
356void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
357 int add_pos);
358int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
359 int row, int col);
360int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
361 loff_t size);
362int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
363int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100364
Heiko Schocherff94bc42014-06-24 10:10:04 +0200365int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
366 int len);
367int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
368int dbg_leb_unmap(struct ubifs_info *c, int lnum);
369int dbg_leb_map(struct ubifs_info *c, int lnum);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100370
Heiko Schocherff94bc42014-06-24 10:10:04 +0200371/* Debugfs-related stuff */
372int dbg_debugfs_init(void);
373void dbg_debugfs_exit(void);
374int dbg_debugfs_init_fs(struct ubifs_info *c);
375void dbg_debugfs_exit_fs(struct ubifs_info *c);
Stefan Roese9eefe2a2009-03-19 15:35:05 +0100376
377#endif /* !__UBIFS_DEBUG_H__ */