fs/ubifs/debug.h

   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 #include <linux/printk.h>
  16 typedef int (*dbg_leaf_callback)(struct ubifs_info *c,
  17                                  struct ubifs_zbranch *zbr, void *priv);
  18 typedef 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)
  27
  28 /**
  29  * ubifs_debug_info - per-FS debugging information.
  30  * @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()'
  33  *
  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  *
  40  * @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()')
  49  * @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
  52  *
  53  * @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)
  75  */
  76 struct ubifs_debug_info {
  77         struct ubifs_zbranch old_zroot;
  78         int old_zroot_level;
  79         unsigned long long old_zroot_sqnum;
  80
  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
  87         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;
  96         struct ubifs_budg_info saved_bi;
  97         long long saved_free;
  98         int saved_idx_gc_cnt;
  99
 100         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];
 108         struct dentry *dfs_dir;
 109         struct dentry *dfs_dump_lprops;
 110         struct dentry *dfs_dump_budg;
 111         struct dentry *dfs_dump_tnc;
 112         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;
 119 };
 120
 121 /**
 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  */
 131 struct 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 };
 139
 140 #ifndef __UBOOT__
 141 #define ubifs_assert(expr) do {                                                \
 142         if (unlikely(!(expr))) {                                               \
 143                 pr_crit("UBIFS assert failed in %s at %u (pid %d)\n",          \
 144                        __func__, __LINE__, current->pid);                      \
 145                 dump_stack();                                                  \
 146         }                                                                      \
 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);                                    \
 152                 pr_crit("commit lock is not locked!\n");                       \
 153                 ubifs_assert(0);                                               \
 154         }                                                                      \
 155 } while (0)
 156
 157 #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
 170 #include <log.h>
 171 #define ubifs_assert(expr) assert(expr)
 172 #define ubifs_assert_cmt_locked(c) do { } while (0)
 173
 174 #define ubifs_dbg_msg(type, fmt, ...) \
 175         pr_debug("UBIFS DBG " type ": " fmt "\n",                              \
 176                  ##__VA_ARGS__)
 177
 178 #define DBG_KEY_BUF_LEN 48
 179 #define ubifs_dbg_msg_key(type, key, fmt, ...) do {                            \
 180         char __tmp_key_buf[DBG_KEY_BUF_LEN];                                   \
 181         pr_debug("UBIFS DBG " type ": " fmt "%s\n",                            \
 182                  ##__VA_ARGS__,                                                \
 183                  dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN));    \
 184 } while (0)
 185
 186 #endif
 187
 188 /* General messages */
 189 #define dbg_gen(fmt, ...)   ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
 190 /* Additional journal messages */
 191 #define dbg_jnl(fmt, ...)   ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
 192 #define dbg_jnlk(key, fmt, ...) \
 193         ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
 194 /* Additional TNC messages */
 195 #define dbg_tnc(fmt, ...)   ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
 196 #define dbg_tnck(key, fmt, ...) \
 197         ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
 198 /* Additional lprops messages */
 199 #define dbg_lp(fmt, ...)    ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
 200 /* Additional LEB find messages */
 201 #define dbg_find(fmt, ...)  ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
 202 /* Additional mount messages */
 203 #define dbg_mnt(fmt, ...)   ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
 204 #define dbg_mntk(key, fmt, ...) \
 205         ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
 206 /* Additional I/O messages */
 207 #define dbg_io(fmt, ...)    ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
 208 /* Additional commit messages */
 209 #define dbg_cmt(fmt, ...)   ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
 210 /* Additional budgeting messages */
 211 #define dbg_budg(fmt, ...)  ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
 212 /* Additional log messages */
 213 #define dbg_log(fmt, ...)   ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
 214 /* Additional gc messages */
 215 #define dbg_gc(fmt, ...)    ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
 216 /* Additional scan messages */
 217 #define dbg_scan(fmt, ...)  ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
 218 /* Additional recovery messages */
 219 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
 220
 221 #ifndef __UBOOT__
 222 extern struct ubifs_global_debug_info ubifs_dbg;
 223
 224 static inline int dbg_is_chk_gen(const struct ubifs_info *c)
 225 {
 226         return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
 227 }
 228 static inline int dbg_is_chk_index(const struct ubifs_info *c)
 229 {
 230         return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
 231 }
 232 static inline int dbg_is_chk_orph(const struct ubifs_info *c)
 233 {
 234         return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
 235 }
 236 static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
 237 {
 238         return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
 239 }
 240 static inline int dbg_is_chk_fs(const struct ubifs_info *c)
 241 {
 242         return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
 243 }
 244 static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
 245 {
 246         return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
 247 }
 248 static inline int dbg_is_power_cut(const struct ubifs_info *c)
 249 {
 250         return !!c->dbg->pc_happened;
 251 }
 252
 253 int ubifs_debugging_init(struct ubifs_info *c);
 254 void ubifs_debugging_exit(struct ubifs_info *c);
 255 #else
 256 static inline int dbg_is_chk_gen(const struct ubifs_info *c)
 257 {
 258         return 0;
 259 }
 260 static inline int dbg_is_chk_index(const struct ubifs_info *c)
 261 {
 262         return 0;
 263 }
 264 static inline int dbg_is_chk_orph(const struct ubifs_info *c)
 265 {
 266         return 0;
 267 }
 268 static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
 269 {
 270         return 0;
 271 }
 272 static inline int dbg_is_chk_fs(const struct ubifs_info *c)
 273 {
 274         return 0;
 275 }
 276 static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
 277 {
 278         return 0;
 279 }
 280 static inline int dbg_is_power_cut(const struct ubifs_info *c)
 281 {
 282         return 0;
 283 }
 284
 285 int ubifs_debugging_init(struct ubifs_info *c);
 286 void ubifs_debugging_exit(struct ubifs_info *c);
 287
 288 #endif
 289
 290 /* Dump functions */
 291 const char *dbg_ntype(int type);
 292 const char *dbg_cstate(int cmt_state);
 293 const char *dbg_jhead(int jhead);
 294 const char *dbg_get_key_dump(const struct ubifs_info *c,
 295                              const union ubifs_key *key);
 296 const char *dbg_snprintf_key(const struct ubifs_info *c,
 297                              const union ubifs_key *key, char *buffer, int len);
 298 void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode);
 299 void ubifs_dump_node(const struct ubifs_info *c, const void *node);
 300 void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
 301 void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
 302 void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
 303 void ubifs_dump_lprop(const struct ubifs_info *c,
 304                       const struct ubifs_lprops *lp);
 305 void ubifs_dump_lprops(struct ubifs_info *c);
 306 void ubifs_dump_lpt_info(struct ubifs_info *c);
 307 void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
 308 void ubifs_dump_sleb(const struct ubifs_info *c,
 309                      const struct ubifs_scan_leb *sleb, int offs);
 310 void ubifs_dump_znode(const struct ubifs_info *c,
 311                       const struct ubifs_znode *znode);
 312 void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap,
 313                      int cat);
 314 void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
 315                       struct ubifs_nnode *parent, int iip);
 316 void ubifs_dump_tnc(struct ubifs_info *c);
 317 void ubifs_dump_index(struct ubifs_info *c);
 318 void ubifs_dump_lpt_lebs(const struct ubifs_info *c);
 319
 320 int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
 321                    dbg_znode_callback znode_cb, void *priv);
 322
 323 /* Checking functions */
 324 void dbg_save_space_info(struct ubifs_info *c);
 325 int dbg_check_space_info(struct ubifs_info *c);
 326 int dbg_check_lprops(struct ubifs_info *c);
 327 int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
 328 int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
 329 int dbg_check_cats(struct ubifs_info *c);
 330 int dbg_check_ltab(struct ubifs_info *c);
 331 int dbg_chk_lpt_free_spc(struct ubifs_info *c);
 332 int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
 333 int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
 334 int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
 335 int dbg_check_tnc(struct ubifs_info *c, int extra);
 336 int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
 337 int dbg_check_filesystem(struct ubifs_info *c);
 338 void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
 339                     int add_pos);
 340 int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
 341                         int row, int col);
 342 int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
 343                          loff_t size);
 344 int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
 345 int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
 346
 347 int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
 348                   int len);
 349 int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
 350 int dbg_leb_unmap(struct ubifs_info *c, int lnum);
 351 int dbg_leb_map(struct ubifs_info *c, int lnum);
 352
 353 /* Debugfs-related stuff */
 354 int dbg_debugfs_init(void);
 355 void dbg_debugfs_exit(void);
 356 int dbg_debugfs_init_fs(struct ubifs_info *c);
 357 void dbg_debugfs_exit_fs(struct ubifs_info *c);
 358
 359 #endif /* !__UBIFS_DEBUG_H__ */