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