1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * This file is part of UBIFS. 4 * 5 * Copyright (C) 2006-2008 Nokia Corporation. 6 * 7 * Authors: Artem Bityutskiy (Битюцкий Артём) 8 * Adrian Hunter 9 */ 10 11 #ifndef __UBIFS_DEBUG_H__ 12 #define __UBIFS_DEBUG_H__ 13 14 /* Checking helper functions */ 15 typedef int (*dbg_leaf_callback)(struct ubifs_info *c, 16 struct ubifs_zbranch *zbr, void *priv); 17 typedef int (*dbg_znode_callback)(struct ubifs_info *c, 18 struct ubifs_znode *znode, void *priv); 19 20 /* 21 * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi" 22 * + 1 for "_" and plus 2x2 for 2 UBI numbers and 1 for the trailing zero byte. 23 */ 24 #define UBIFS_DFS_DIR_NAME "ubi%d_%d" 25 #define UBIFS_DFS_DIR_LEN (3 + 1 + 2*2 + 1) 26 27 /** 28 * ubifs_debug_info - per-FS debugging information. 29 * @old_zroot: old index root - used by 'dbg_check_old_index()' 30 * @old_zroot_level: old index root level - used by 'dbg_check_old_index()' 31 * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()' 32 * 33 * @pc_happened: non-zero if an emulated power cut happened 34 * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls 35 * @pc_timeout: time in jiffies when delay of failure mode expires 36 * @pc_cnt: current number of calls to failure mode I/O functions 37 * @pc_cnt_max: number of calls by which to delay failure mode 38 * 39 * @chk_lpt_sz: used by LPT tree size checker 40 * @chk_lpt_sz2: used by LPT tree size checker 41 * @chk_lpt_wastage: used by LPT tree size checker 42 * @chk_lpt_lebs: used by LPT tree size checker 43 * @new_nhead_offs: used by LPT tree size checker 44 * @new_ihead_lnum: used by debugging to check @c->ihead_lnum 45 * @new_ihead_offs: used by debugging to check @c->ihead_offs 46 * 47 * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()') 48 * @saved_bi: saved budgeting information 49 * @saved_free: saved amount of free space 50 * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt 51 * 52 * @chk_gen: if general extra checks are enabled 53 * @chk_index: if index xtra checks are enabled 54 * @chk_orph: if orphans extra checks are enabled 55 * @chk_lprops: if lprops extra checks are enabled 56 * @chk_fs: if UBIFS contents extra checks are enabled 57 * @tst_rcvry: if UBIFS recovery testing mode enabled 58 * 59 * @dfs_dir_name: name of debugfs directory containing this file-system's files 60 * @dfs_dir: direntry object of the file-system debugfs directory 61 * @dfs_dump_lprops: "dump lprops" debugfs knob 62 * @dfs_dump_budg: "dump budgeting information" debugfs knob 63 * @dfs_dump_tnc: "dump TNC" debugfs knob 64 * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks 65 * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks 66 * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks 67 * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks 68 * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks 69 * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing 70 * @dfs_ro_error: debugfs knob to switch UBIFS to R/O mode (different to 71 * re-mounting to R/O mode because it does not flush any buffers 72 * and UBIFS just starts returning -EROFS on all write 73 * operations) 74 */ 75 struct ubifs_debug_info { 76 struct ubifs_zbranch old_zroot; 77 int old_zroot_level; 78 unsigned long long old_zroot_sqnum; 79 80 int pc_happened; 81 int pc_delay; 82 unsigned long pc_timeout; 83 unsigned int pc_cnt; 84 unsigned int pc_cnt_max; 85 86 long long chk_lpt_sz; 87 long long chk_lpt_sz2; 88 long long chk_lpt_wastage; 89 int chk_lpt_lebs; 90 int new_nhead_offs; 91 int new_ihead_lnum; 92 int new_ihead_offs; 93 94 struct ubifs_lp_stats saved_lst; 95 struct ubifs_budg_info saved_bi; 96 long long saved_free; 97 int saved_idx_gc_cnt; 98 99 unsigned int chk_gen:1; 100 unsigned int chk_index:1; 101 unsigned int chk_orph:1; 102 unsigned int chk_lprops:1; 103 unsigned int chk_fs:1; 104 unsigned int tst_rcvry:1; 105 106 char dfs_dir_name[UBIFS_DFS_DIR_LEN + 1]; 107 struct dentry *dfs_dir; 108 struct dentry *dfs_dump_lprops; 109 struct dentry *dfs_dump_budg; 110 struct dentry *dfs_dump_tnc; 111 struct dentry *dfs_chk_gen; 112 struct dentry *dfs_chk_index; 113 struct dentry *dfs_chk_orph; 114 struct dentry *dfs_chk_lprops; 115 struct dentry *dfs_chk_fs; 116 struct dentry *dfs_tst_rcvry; 117 struct dentry *dfs_ro_error; 118 }; 119 120 /** 121 * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information. 122 * 123 * @chk_gen: if general extra checks are enabled 124 * @chk_index: if index xtra checks are enabled 125 * @chk_orph: if orphans extra checks are enabled 126 * @chk_lprops: if lprops extra checks are enabled 127 * @chk_fs: if UBIFS contents extra checks are enabled 128 * @tst_rcvry: if UBIFS recovery testing mode enabled 129 */ 130 struct ubifs_global_debug_info { 131 unsigned int chk_gen:1; 132 unsigned int chk_index:1; 133 unsigned int chk_orph:1; 134 unsigned int chk_lprops:1; 135 unsigned int chk_fs:1; 136 unsigned int tst_rcvry:1; 137 }; 138 139 #ifndef __UBOOT__ 140 #define ubifs_assert(expr) do { \ 141 if (unlikely(!(expr))) { \ 142 pr_crit("UBIFS assert failed in %s at %u (pid %d)\n", \ 143 __func__, __LINE__, current->pid); \ 144 dump_stack(); \ 145 } \ 146 } while (0) 147 148 #define ubifs_assert_cmt_locked(c) do { \ 149 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \ 150 up_write(&(c)->commit_sem); \ 151 pr_crit("commit lock is not locked!\n"); \ 152 ubifs_assert(0); \ 153 } \ 154 } while (0) 155 156 #define ubifs_dbg_msg(type, fmt, ...) \ 157 pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid, \ 158 ##__VA_ARGS__) 159 160 #define DBG_KEY_BUF_LEN 48 161 #define ubifs_dbg_msg_key(type, key, fmt, ...) do { \ 162 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \ 163 pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid, \ 164 ##__VA_ARGS__, \ 165 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \ 166 } while (0) 167 #else 168 #define ubifs_assert(expr) do { \ 169 if (unlikely(!(expr))) { \ 170 pr_crit("UBIFS assert failed in %s at %u\n", \ 171 __func__, __LINE__); \ 172 dump_stack(); \ 173 } \ 174 } while (0) 175 176 #define ubifs_assert_cmt_locked(c) do { \ 177 if (unlikely(down_write_trylock(&(c)->commit_sem))) { \ 178 up_write(&(c)->commit_sem); \ 179 pr_crit("commit lock is not locked!\n"); \ 180 ubifs_assert(0); \ 181 } \ 182 } while (0) 183 184 #define ubifs_dbg_msg(type, fmt, ...) \ 185 pr_debug("UBIFS DBG " type ": " fmt "\n", \ 186 ##__VA_ARGS__) 187 188 #define DBG_KEY_BUF_LEN 48 189 #define ubifs_dbg_msg_key(type, key, fmt, ...) do { \ 190 char __tmp_key_buf[DBG_KEY_BUF_LEN]; \ 191 pr_debug("UBIFS DBG " type ": " fmt "%s\n", \ 192 ##__VA_ARGS__, \ 193 dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN)); \ 194 } while (0) 195 196 #endif 197 198 /* General messages */ 199 #define dbg_gen(fmt, ...) ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__) 200 /* Additional journal messages */ 201 #define dbg_jnl(fmt, ...) ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__) 202 #define dbg_jnlk(key, fmt, ...) \ 203 ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__) 204 /* Additional TNC messages */ 205 #define dbg_tnc(fmt, ...) ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__) 206 #define dbg_tnck(key, fmt, ...) \ 207 ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__) 208 /* Additional lprops messages */ 209 #define dbg_lp(fmt, ...) ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__) 210 /* Additional LEB find messages */ 211 #define dbg_find(fmt, ...) ubifs_dbg_msg("find", fmt, ##__VA_ARGS__) 212 /* Additional mount messages */ 213 #define dbg_mnt(fmt, ...) ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__) 214 #define dbg_mntk(key, fmt, ...) \ 215 ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__) 216 /* Additional I/O messages */ 217 #define dbg_io(fmt, ...) ubifs_dbg_msg("io", fmt, ##__VA_ARGS__) 218 /* Additional commit messages */ 219 #define dbg_cmt(fmt, ...) ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__) 220 /* Additional budgeting messages */ 221 #define dbg_budg(fmt, ...) ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__) 222 /* Additional log messages */ 223 #define dbg_log(fmt, ...) ubifs_dbg_msg("log", fmt, ##__VA_ARGS__) 224 /* Additional gc messages */ 225 #define dbg_gc(fmt, ...) ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__) 226 /* Additional scan messages */ 227 #define dbg_scan(fmt, ...) ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__) 228 /* Additional recovery messages */ 229 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__) 230 231 #ifndef __UBOOT__ 232 extern struct ubifs_global_debug_info ubifs_dbg; 233 234 static inline int dbg_is_chk_gen(const struct ubifs_info *c) 235 { 236 return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen); 237 } 238 static inline int dbg_is_chk_index(const struct ubifs_info *c) 239 { 240 return !!(ubifs_dbg.chk_index || c->dbg->chk_index); 241 } 242 static inline int dbg_is_chk_orph(const struct ubifs_info *c) 243 { 244 return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph); 245 } 246 static inline int dbg_is_chk_lprops(const struct ubifs_info *c) 247 { 248 return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops); 249 } 250 static inline int dbg_is_chk_fs(const struct ubifs_info *c) 251 { 252 return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs); 253 } 254 static inline int dbg_is_tst_rcvry(const struct ubifs_info *c) 255 { 256 return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry); 257 } 258 static inline int dbg_is_power_cut(const struct ubifs_info *c) 259 { 260 return !!c->dbg->pc_happened; 261 } 262 263 int ubifs_debugging_init(struct ubifs_info *c); 264 void ubifs_debugging_exit(struct ubifs_info *c); 265 #else 266 static inline int dbg_is_chk_gen(const struct ubifs_info *c) 267 { 268 return 0; 269 } 270 static inline int dbg_is_chk_index(const struct ubifs_info *c) 271 { 272 return 0; 273 } 274 static inline int dbg_is_chk_orph(const struct ubifs_info *c) 275 { 276 return 0; 277 } 278 static inline int dbg_is_chk_lprops(const struct ubifs_info *c) 279 { 280 return 0; 281 } 282 static inline int dbg_is_chk_fs(const struct ubifs_info *c) 283 { 284 return 0; 285 } 286 static inline int dbg_is_tst_rcvry(const struct ubifs_info *c) 287 { 288 return 0; 289 } 290 static inline int dbg_is_power_cut(const struct ubifs_info *c) 291 { 292 return 0; 293 } 294 295 int ubifs_debugging_init(struct ubifs_info *c); 296 void ubifs_debugging_exit(struct ubifs_info *c); 297 298 #endif 299 300 /* Dump functions */ 301 const char *dbg_ntype(int type); 302 const char *dbg_cstate(int cmt_state); 303 const char *dbg_jhead(int jhead); 304 const char *dbg_get_key_dump(const struct ubifs_info *c, 305 const union ubifs_key *key); 306 const char *dbg_snprintf_key(const struct ubifs_info *c, 307 const union ubifs_key *key, char *buffer, int len); 308 void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode); 309 void ubifs_dump_node(const struct ubifs_info *c, const void *node); 310 void ubifs_dump_budget_req(const struct ubifs_budget_req *req); 311 void ubifs_dump_lstats(const struct ubifs_lp_stats *lst); 312 void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi); 313 void ubifs_dump_lprop(const struct ubifs_info *c, 314 const struct ubifs_lprops *lp); 315 void ubifs_dump_lprops(struct ubifs_info *c); 316 void ubifs_dump_lpt_info(struct ubifs_info *c); 317 void ubifs_dump_leb(const struct ubifs_info *c, int lnum); 318 void ubifs_dump_sleb(const struct ubifs_info *c, 319 const struct ubifs_scan_leb *sleb, int offs); 320 void ubifs_dump_znode(const struct ubifs_info *c, 321 const struct ubifs_znode *znode); 322 void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, 323 int cat); 324 void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode, 325 struct ubifs_nnode *parent, int iip); 326 void ubifs_dump_tnc(struct ubifs_info *c); 327 void ubifs_dump_index(struct ubifs_info *c); 328 void ubifs_dump_lpt_lebs(const struct ubifs_info *c); 329 330 int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb, 331 dbg_znode_callback znode_cb, void *priv); 332 333 /* Checking functions */ 334 void dbg_save_space_info(struct ubifs_info *c); 335 int dbg_check_space_info(struct ubifs_info *c); 336 int dbg_check_lprops(struct ubifs_info *c); 337 int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot); 338 int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot); 339 int dbg_check_cats(struct ubifs_info *c); 340 int dbg_check_ltab(struct ubifs_info *c); 341 int dbg_chk_lpt_free_spc(struct ubifs_info *c); 342 int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len); 343 int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode); 344 int dbg_check_dir(struct ubifs_info *c, const struct inode *dir); 345 int dbg_check_tnc(struct ubifs_info *c, int extra); 346 int dbg_check_idx_size(struct ubifs_info *c, long long idx_size); 347 int dbg_check_filesystem(struct ubifs_info *c); 348 void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat, 349 int add_pos); 350 int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode, 351 int row, int col); 352 int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode, 353 loff_t size); 354 int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head); 355 int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head); 356 357 int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs, 358 int len); 359 int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len); 360 int dbg_leb_unmap(struct ubifs_info *c, int lnum); 361 int dbg_leb_map(struct ubifs_info *c, int lnum); 362 363 /* Debugfs-related stuff */ 364 int dbg_debugfs_init(void); 365 void dbg_debugfs_exit(void); 366 int dbg_debugfs_init_fs(struct ubifs_info *c); 367 void dbg_debugfs_exit_fs(struct ubifs_info *c); 368 369 #endif /* !__UBIFS_DEBUG_H__ */ 370