1 /* 2 * Copyright (c) International Business Machines Corp., 2006 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation; either version 2 of the License, or 7 * (at your option) any later version. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 12 * the GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program; if not, write to the Free Software 16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 17 * 18 * Author: Artem Bityutskiy (Битюцкий Артём) 19 */ 20 21 #ifndef __UBI_DEBUG_H__ 22 #define __UBI_DEBUG_H__ 23 24 void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len); 25 void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr); 26 void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr); 27 28 #include <linux/random.h> 29 30 #define ubi_assert(expr) do { \ 31 if (unlikely(!(expr))) { \ 32 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ 33 __func__, __LINE__, current->pid); \ 34 dump_stack(); \ 35 } \ 36 } while (0) 37 38 #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \ 39 print_hex_dump(l, ps, pt, r, g, b, len, a) 40 41 #define ubi_dbg_msg(type, fmt, ...) \ 42 pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__) 43 44 /* Just a debugging messages not related to any specific UBI subsystem */ 45 #define dbg_msg(fmt, ...) \ 46 printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \ 47 current->pid, __func__, ##__VA_ARGS__) 48 49 /* General debugging messages */ 50 #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__) 51 /* Messages from the eraseblock association sub-system */ 52 #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__) 53 /* Messages from the wear-leveling sub-system */ 54 #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__) 55 /* Messages from the input/output sub-system */ 56 #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__) 57 /* Initialization and build messages */ 58 #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__) 59 60 void ubi_dump_vol_info(const struct ubi_volume *vol); 61 void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx); 62 void ubi_dump_av(const struct ubi_ainf_volume *av); 63 void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type); 64 void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req); 65 int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset, 66 int len); 67 int ubi_debugging_init_dev(struct ubi_device *ubi); 68 void ubi_debugging_exit_dev(struct ubi_device *ubi); 69 int ubi_debugfs_init(void); 70 void ubi_debugfs_exit(void); 71 int ubi_debugfs_init_dev(struct ubi_device *ubi); 72 void ubi_debugfs_exit_dev(struct ubi_device *ubi); 73 74 /* 75 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi" 76 * + 2 for the number plus 1 for the trailing zero byte. 77 */ 78 #define UBI_DFS_DIR_NAME "ubi%d" 79 #define UBI_DFS_DIR_LEN (3 + 2 + 1) 80 81 /** 82 * struct ubi_debug_info - debugging information for an UBI device. 83 * 84 * @chk_gen: if UBI general extra checks are enabled 85 * @chk_io: if UBI I/O extra checks are enabled 86 * @disable_bgt: disable the background task for testing purposes 87 * @emulate_bitflips: emulate bit-flips for testing purposes 88 * @emulate_io_failures: emulate write/erase failures for testing purposes 89 * @dfs_dir_name: name of debugfs directory containing files of this UBI device 90 * @dfs_dir: direntry object of the UBI device debugfs directory 91 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks 92 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks 93 * @dfs_disable_bgt: debugfs knob to disable the background task 94 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips 95 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures 96 */ 97 struct ubi_debug_info { 98 unsigned int chk_gen:1; 99 unsigned int chk_io:1; 100 unsigned int disable_bgt:1; 101 unsigned int emulate_bitflips:1; 102 unsigned int emulate_io_failures:1; 103 char dfs_dir_name[UBI_DFS_DIR_LEN + 1]; 104 struct dentry *dfs_dir; 105 struct dentry *dfs_chk_gen; 106 struct dentry *dfs_chk_io; 107 struct dentry *dfs_disable_bgt; 108 struct dentry *dfs_emulate_bitflips; 109 struct dentry *dfs_emulate_io_failures; 110 }; 111 112 /** 113 * ubi_dbg_is_bgt_disabled - if the background thread is disabled. 114 * @ubi: UBI device description object 115 * 116 * Returns non-zero if the UBI background thread is disabled for testing 117 * purposes. 118 */ 119 static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) 120 { 121 return ubi->dbg->disable_bgt; 122 } 123 124 /** 125 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip. 126 * @ubi: UBI device description object 127 * 128 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero. 129 */ 130 static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) 131 { 132 if (ubi->dbg->emulate_bitflips) 133 return !(random32() % 200); 134 return 0; 135 } 136 137 /** 138 * ubi_dbg_is_write_failure - if it is time to emulate a write failure. 139 * @ubi: UBI device description object 140 * 141 * Returns non-zero if a write failure should be emulated, otherwise returns 142 * zero. 143 */ 144 static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi) 145 { 146 if (ubi->dbg->emulate_io_failures) 147 return !(random32() % 500); 148 return 0; 149 } 150 151 /** 152 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure. 153 * @ubi: UBI device description object 154 * 155 * Returns non-zero if an erase failure should be emulated, otherwise returns 156 * zero. 157 */ 158 static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi) 159 { 160 if (ubi->dbg->emulate_io_failures) 161 return !(random32() % 400); 162 return 0; 163 } 164 165 #endif /* !__UBI_DEBUG_H__ */ 166