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         struct dentry *dfs_lca_debug;
 131         struct dentry *dfs_lca_show_tnc;
 132         struct dentry *dfs_wbuf_count;
 133         struct dentry *dfs_host_wcount;
 134 };
 135
 136 /**
 137  * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information.
 138  *
 139  * @chk_gen: if general extra checks are enabled
 140  * @chk_index: if index xtra checks are enabled
 141  * @chk_orph: if orphans extra checks are enabled
 142  * @chk_lprops: if lprops extra checks are enabled
 143  * @chk_fs: if UBIFS contents extra checks are enabled
 144  * @tst_rcvry: if UBIFS recovery testing mode enabled
 145  */
 146 struct ubifs_global_debug_info {
 147         unsigned int chk_gen:1;
 148         unsigned int chk_index:1;
 149         unsigned int chk_orph:1;
 150         unsigned int chk_lprops:1;
 151         unsigned int chk_fs:1;
 152         unsigned int tst_rcvry:1;
 153 };
 154
 155 /**
 156  * ubifs_global_debug_tnc - global (not per-FS) UBIFS debugging tnc information.
 157  *
 158  */
 159 struct ubifs_global_debug_tnc {
 160     unsigned int total_ubifs_volume;
 161     uint32_t total_znode;
 162     uint32_t total_tnc_leaf_lens;
 163     uint32_t total_clean_znode;
 164     uint32_t total_clean_tnc_leaf_lens;
 165 };
 166
 167 #define ubifs_assert(expr) do {                                                \
 168         if (unlikely(!(expr))) {                                               \
 169                 pr_crit("UBIFS assert failed in %s at %u (pid %d)\n",          \
 170                        __func__, __LINE__, current->pid);                      \
 171                 dump_stack();                                                  \
 172         }                                                                      \
 173 } while (0)
 174
 175 #define ubifs_assert_cmt_locked(c) do {                                        \
 176         if (unlikely(down_write_trylock(&(c)->commit_sem))) {                  \
 177                 up_write(&(c)->commit_sem);                                    \
 178                 pr_crit("commit lock is not locked!\n");                       \
 179                 ubifs_assert(0);                                               \
 180         }                                                                      \
 181 } while (0)
 182
 183 #define ubifs_dbg_msg(type, fmt, ...) \
 184         pr_debug("UBIFS DBG " type " (pid %d): " fmt "\n", current->pid,       \
 185                  ##__VA_ARGS__)
 186
 187 #define DBG_KEY_BUF_LEN 48
 188 #define ubifs_dbg_msg_key(type, key, fmt, ...) do {                            \
 189         char __tmp_key_buf[DBG_KEY_BUF_LEN];                                   \
 190         pr_debug("UBIFS DBG " type " (pid %d): " fmt "%s\n", current->pid,     \
 191                  ##__VA_ARGS__,                                                \
 192                  dbg_snprintf_key(c, key, __tmp_key_buf, DBG_KEY_BUF_LEN));    \
 193 } while (0)
 194
 195 /* General messages */
 196 #define dbg_gen(fmt, ...)   ubifs_dbg_msg("gen", fmt, ##__VA_ARGS__)
 197 /* Additional journal messages */
 198 #define dbg_jnl(fmt, ...)   ubifs_dbg_msg("jnl", fmt, ##__VA_ARGS__)
 199 #define dbg_jnlk(key, fmt, ...) \
 200         ubifs_dbg_msg_key("jnl", key, fmt, ##__VA_ARGS__)
 201 /* Additional TNC messages */
 202 #define dbg_tnc(fmt, ...)   ubifs_dbg_msg("tnc", fmt, ##__VA_ARGS__)
 203 #define dbg_tnck(key, fmt, ...) \
 204         ubifs_dbg_msg_key("tnc", key, fmt, ##__VA_ARGS__)
 205 /* Additional lprops messages */
 206 #define dbg_lp(fmt, ...)    ubifs_dbg_msg("lp", fmt, ##__VA_ARGS__)
 207 /* Additional LEB find messages */
 208 #define dbg_find(fmt, ...)  ubifs_dbg_msg("find", fmt, ##__VA_ARGS__)
 209 /* Additional mount messages */
 210 #define dbg_mnt(fmt, ...)   ubifs_dbg_msg("mnt", fmt, ##__VA_ARGS__)
 211 #define dbg_mntk(key, fmt, ...) \
 212         ubifs_dbg_msg_key("mnt", key, fmt, ##__VA_ARGS__)
 213 /* Additional I/O messages */
 214 #define dbg_io(fmt, ...)    ubifs_dbg_msg("io", fmt, ##__VA_ARGS__)
 215 /* Additional commit messages */
 216 #define dbg_cmt(fmt, ...)   ubifs_dbg_msg("cmt", fmt, ##__VA_ARGS__)
 217 /* Additional budgeting messages */
 218 #define dbg_budg(fmt, ...)  ubifs_dbg_msg("budg", fmt, ##__VA_ARGS__)
 219 /* Additional log messages */
 220 #define dbg_log(fmt, ...)   ubifs_dbg_msg("log", fmt, ##__VA_ARGS__)
 221 /* Additional gc messages */
 222 #define dbg_gc(fmt, ...)    ubifs_dbg_msg("gc", fmt, ##__VA_ARGS__)
 223 /* Additional scan messages */
 224 #define dbg_scan(fmt, ...)  ubifs_dbg_msg("scan", fmt, ##__VA_ARGS__)
 225 /* Additional recovery messages */
 226 #define dbg_rcvry(fmt, ...) ubifs_dbg_msg("rcvry", fmt, ##__VA_ARGS__)
 227
 228 extern struct ubifs_global_debug_info ubifs_dbg;
 229
 230 static inline int dbg_is_chk_gen(const struct ubifs_info *c)
 231 {
 232         return !!(ubifs_dbg.chk_gen || c->dbg->chk_gen);
 233 }
 234 static inline int dbg_is_chk_index(const struct ubifs_info *c)
 235 {
 236         return !!(ubifs_dbg.chk_index || c->dbg->chk_index);
 237 }
 238 static inline int dbg_is_chk_orph(const struct ubifs_info *c)
 239 {
 240         return !!(ubifs_dbg.chk_orph || c->dbg->chk_orph);
 241 }
 242 static inline int dbg_is_chk_lprops(const struct ubifs_info *c)
 243 {
 244         return !!(ubifs_dbg.chk_lprops || c->dbg->chk_lprops);
 245 }
 246 static inline int dbg_is_chk_fs(const struct ubifs_info *c)
 247 {
 248         return !!(ubifs_dbg.chk_fs || c->dbg->chk_fs);
 249 }
 250 static inline int dbg_is_tst_rcvry(const struct ubifs_info *c)
 251 {
 252         return !!(ubifs_dbg.tst_rcvry || c->dbg->tst_rcvry);
 253 }
 254 static inline int dbg_is_power_cut(const struct ubifs_info *c)
 255 {
 256         return !!c->dbg->pc_happened;
 257 }
 258
 259 int ubifs_debugging_init(struct ubifs_info *c);
 260 void ubifs_debugging_exit(struct ubifs_info *c);
 261
 262 /* Dump functions */
 263 const char *dbg_ntype(int type);
 264 const char *dbg_cstate(int cmt_state);
 265 const char *dbg_jhead(int jhead);
 266 const char *dbg_get_key_dump(const struct ubifs_info *c,
 267                              const union ubifs_key *key);
 268 const char *dbg_snprintf_key(const struct ubifs_info *c,
 269                              const union ubifs_key *key, char *buffer, int len);
 270 void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode);
 271 void ubifs_dump_node(const struct ubifs_info *c, const void *node);
 272 void ubifs_dump_budget_req(const struct ubifs_budget_req *req);
 273 void ubifs_dump_lstats(const struct ubifs_lp_stats *lst);
 274 void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi);
 275 void ubifs_dump_lprop(const struct ubifs_info *c,
 276                       const struct ubifs_lprops *lp);
 277 void ubifs_dump_lprops(struct ubifs_info *c);
 278 void ubifs_dump_lpt_info(struct ubifs_info *c);
 279 void ubifs_dump_leb(const struct ubifs_info *c, int lnum);
 280 void ubifs_dump_sleb(const struct ubifs_info *c,
 281                      const struct ubifs_scan_leb *sleb, int offs);
 282 void ubifs_dump_znode(const struct ubifs_info *c,
 283                       const struct ubifs_znode *znode);
 284 void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap,
 285                      int cat);
 286 void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode,
 287                       struct ubifs_nnode *parent, int iip);
 288 void ubifs_dump_tnc(struct ubifs_info *c);
 289 void ubifs_dump_index(struct ubifs_info *c);
 290 void ubifs_dump_lpt_lebs(const struct ubifs_info *c);
 291
 292 int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb,
 293                    dbg_znode_callback znode_cb, void *priv);
 294
 295 /* Checking functions */
 296 void dbg_save_space_info(struct ubifs_info *c);
 297 int dbg_check_space_info(struct ubifs_info *c);
 298 int dbg_check_lprops(struct ubifs_info *c);
 299 int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot);
 300 int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot);
 301 int dbg_check_cats(struct ubifs_info *c);
 302 int dbg_check_ltab(struct ubifs_info *c);
 303 int dbg_chk_lpt_free_spc(struct ubifs_info *c);
 304 int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len);
 305 int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode);
 306 int dbg_check_dir(struct ubifs_info *c, const struct inode *dir);
 307 int dbg_check_tnc(struct ubifs_info *c, int extra);
 308 int dbg_check_idx_size(struct ubifs_info *c, long long idx_size);
 309 int dbg_check_filesystem(struct ubifs_info *c);
 310 void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
 311                     int add_pos);
 312 int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode,
 313                         int row, int col);
 314 int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode,
 315                          loff_t size);
 316 int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head);
 317 int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head);
 318
 319 int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
 320                   int len);
 321 int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len);
 322 int dbg_leb_unmap(struct ubifs_info *c, int lnum);
 323 int dbg_leb_map(struct ubifs_info *c, int lnum);
 324
 325 /* Debugfs-related stuff */
 326 int dbg_debugfs_init(void);
 327 void dbg_debugfs_exit(void);
 328 int dbg_debugfs_init_fs(struct ubifs_info *c);
 329 void dbg_debugfs_exit_fs(struct ubifs_info *c);
 330
 331 #endif /* !__UBIFS_DEBUG_H__ */