/* SPDX-License-Identifier: GPL-2.0-only */ /* * This file is part of UBIFS. * * Copyright (C) 2006-2008 Nokia Corporation. * * Authors: Artem Bityutskiy (Битюцкий Артём) * Adrian Hunter */ #ifndef __UBIFS_DEBUG_H__ #define __UBIFS_DEBUG_H__ /* Checking helper functions */ dbg_leaf_callback; dbg_znode_callback; /* * The UBIFS debugfs directory name pattern and maximum name length (3 for "ubi" * + 1 for "_" and 2 for UBI device numbers and 3 for volume number and 1 for * the trailing zero byte. */ #define UBIFS_DFS_DIR_NAME … #define UBIFS_DFS_DIR_LEN … /** * ubifs_debug_info - per-FS debugging information. * @old_zroot: old index root - used by 'dbg_check_old_index()' * @old_zroot_level: old index root level - used by 'dbg_check_old_index()' * @old_zroot_sqnum: old index root sqnum - used by 'dbg_check_old_index()' * * @pc_happened: non-zero if an emulated power cut happened * @pc_delay: 0=>don't delay, 1=>delay a time, 2=>delay a number of calls * @pc_timeout: time in jiffies when delay of failure mode expires * @pc_cnt: current number of calls to failure mode I/O functions * @pc_cnt_max: number of calls by which to delay failure mode * * @chk_lpt_sz: used by LPT tree size checker * @chk_lpt_sz2: used by LPT tree size checker * @chk_lpt_wastage: used by LPT tree size checker * @chk_lpt_lebs: used by LPT tree size checker * @new_nhead_offs: used by LPT tree size checker * @new_ihead_lnum: used by debugging to check @c->ihead_lnum * @new_ihead_offs: used by debugging to check @c->ihead_offs * * @saved_lst: saved lprops statistics (used by 'dbg_save_space_info()') * @saved_bi: saved budgeting information * @saved_free: saved amount of free space * @saved_idx_gc_cnt: saved value of @c->idx_gc_cnt * * @chk_gen: if general extra checks are enabled * @chk_index: if index xtra checks are enabled * @chk_orph: if orphans extra checks are enabled * @chk_lprops: if lprops extra checks are enabled * @chk_fs: if UBIFS contents extra checks are enabled * @tst_rcvry: if UBIFS recovery testing mode enabled * * @dfs_dir_name: name of debugfs directory containing this file-system's files * @dfs_dir: direntry object of the file-system debugfs directory * @dfs_dump_lprops: "dump lprops" debugfs knob * @dfs_dump_budg: "dump budgeting information" debugfs knob * @dfs_dump_tnc: "dump TNC" debugfs knob * @dfs_chk_gen: debugfs knob to enable UBIFS general extra checks * @dfs_chk_index: debugfs knob to enable UBIFS index extra checks * @dfs_chk_orph: debugfs knob to enable UBIFS orphans extra checks * @dfs_chk_lprops: debugfs knob to enable UBIFS LEP properties extra checks * @dfs_chk_fs: debugfs knob to enable UBIFS contents extra checks * @dfs_tst_rcvry: debugfs knob to enable UBIFS recovery testing * @dfs_ro_error: debugfs knob to switch UBIFS to R/O mode (different to * re-mounting to R/O mode because it does not flush any buffers * and UBIFS just starts returning -EROFS on all write * operations) */ struct ubifs_debug_info { … }; /** * ubifs_global_debug_info - global (not per-FS) UBIFS debugging information. * * @chk_gen: if general extra checks are enabled * @chk_index: if index xtra checks are enabled * @chk_orph: if orphans extra checks are enabled * @chk_lprops: if lprops extra checks are enabled * @chk_fs: if UBIFS contents extra checks are enabled * @tst_rcvry: if UBIFS recovery testing mode enabled */ struct ubifs_global_debug_info { … }; void ubifs_assert_failed(struct ubifs_info *c, const char *expr, const char *file, int line); #define ubifs_assert(c, expr) … #define ubifs_assert_cmt_locked(c) … #define ubifs_dbg_msg(type, fmt, ...) … #define DBG_KEY_BUF_LEN … #define ubifs_dbg_msg_key(type, key, fmt, ...) … /* General messages */ #define dbg_gen(fmt, ...) … /* Additional journal messages */ #define dbg_jnl(fmt, ...) … #define dbg_jnlk(key, fmt, ...) … /* Additional TNC messages */ #define dbg_tnc(fmt, ...) … #define dbg_tnck(key, fmt, ...) … /* Additional lprops messages */ #define dbg_lp(fmt, ...) … /* Additional LEB find messages */ #define dbg_find(fmt, ...) … /* Additional mount messages */ #define dbg_mnt(fmt, ...) … #define dbg_mntk(key, fmt, ...) … /* Additional I/O messages */ #define dbg_io(fmt, ...) … /* Additional commit messages */ #define dbg_cmt(fmt, ...) … /* Additional budgeting messages */ #define dbg_budg(fmt, ...) … /* Additional log messages */ #define dbg_log(fmt, ...) … /* Additional gc messages */ #define dbg_gc(fmt, ...) … /* Additional scan messages */ #define dbg_scan(fmt, ...) … /* Additional recovery messages */ #define dbg_rcvry(fmt, ...) … extern struct ubifs_global_debug_info ubifs_dbg; static inline int dbg_is_chk_gen(const struct ubifs_info *c) { … } static inline int dbg_is_chk_index(const struct ubifs_info *c) { … } static inline int dbg_is_chk_orph(const struct ubifs_info *c) { … } static inline int dbg_is_chk_lprops(const struct ubifs_info *c) { … } static inline int dbg_is_chk_fs(const struct ubifs_info *c) { … } static inline int dbg_is_tst_rcvry(const struct ubifs_info *c) { … } static inline int dbg_is_power_cut(const struct ubifs_info *c) { … } int ubifs_debugging_init(struct ubifs_info *c); void ubifs_debugging_exit(struct ubifs_info *c); /* Dump functions */ const char *dbg_ntype(int type); const char *dbg_cstate(int cmt_state); const char *dbg_jhead(int jhead); const char *dbg_get_key_dump(const struct ubifs_info *c, const union ubifs_key *key); const char *dbg_snprintf_key(const struct ubifs_info *c, const union ubifs_key *key, char *buffer, int len); void ubifs_dump_inode(struct ubifs_info *c, const struct inode *inode); void ubifs_dump_node(const struct ubifs_info *c, const void *node, int node_len); void ubifs_dump_budget_req(const struct ubifs_budget_req *req); void ubifs_dump_lstats(const struct ubifs_lp_stats *lst); void ubifs_dump_budg(struct ubifs_info *c, const struct ubifs_budg_info *bi); void ubifs_dump_lprop(const struct ubifs_info *c, const struct ubifs_lprops *lp); void ubifs_dump_lprops(struct ubifs_info *c); void ubifs_dump_lpt_info(struct ubifs_info *c); void ubifs_dump_leb(const struct ubifs_info *c, int lnum); void ubifs_dump_znode(const struct ubifs_info *c, const struct ubifs_znode *znode); void ubifs_dump_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat); void ubifs_dump_pnode(struct ubifs_info *c, struct ubifs_pnode *pnode, struct ubifs_nnode *parent, int iip); void ubifs_dump_tnc(struct ubifs_info *c); void ubifs_dump_index(struct ubifs_info *c); void ubifs_dump_lpt_lebs(const struct ubifs_info *c); int dbg_walk_index(struct ubifs_info *c, dbg_leaf_callback leaf_cb, dbg_znode_callback znode_cb, void *priv); /* Checking functions */ void dbg_save_space_info(struct ubifs_info *c); int dbg_check_space_info(struct ubifs_info *c); int dbg_check_lprops(struct ubifs_info *c); int dbg_old_index_check_init(struct ubifs_info *c, struct ubifs_zbranch *zroot); int dbg_check_old_index(struct ubifs_info *c, struct ubifs_zbranch *zroot); int dbg_check_cats(struct ubifs_info *c); int dbg_check_ltab(struct ubifs_info *c); int dbg_chk_lpt_free_spc(struct ubifs_info *c); int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len); int dbg_check_synced_i_size(const struct ubifs_info *c, struct inode *inode); int dbg_check_dir(struct ubifs_info *c, const struct inode *dir); int dbg_check_tnc(struct ubifs_info *c, int extra); int dbg_check_idx_size(struct ubifs_info *c, long long idx_size); int dbg_check_filesystem(struct ubifs_info *c); void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat, int add_pos); int dbg_check_lpt_nodes(struct ubifs_info *c, struct ubifs_cnode *cnode, int row, int col); int dbg_check_inode_size(struct ubifs_info *c, const struct inode *inode, loff_t size); int dbg_check_data_nodes_order(struct ubifs_info *c, struct list_head *head); int dbg_check_nondata_nodes_order(struct ubifs_info *c, struct list_head *head); int dbg_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs, int len); int dbg_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len); int dbg_leb_unmap(struct ubifs_info *c, int lnum); int dbg_leb_map(struct ubifs_info *c, int lnum); /* Debugfs-related stuff */ void dbg_debugfs_init(void); void dbg_debugfs_exit(void); void dbg_debugfs_init_fs(struct ubifs_info *c); void dbg_debugfs_exit_fs(struct ubifs_info *c); #endif /* !__UBIFS_DEBUG_H__ */
Codebase Browser
linux