Commit | Line | Data |
---|---|---|
801c135c AB |
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 | ||
ef7088e7 | 24 | void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len); |
a904e3f1 AB |
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); | |
ef7088e7 | 27 | |
801c135c AB |
28 | #include <linux/random.h> |
29 | ||
c8566350 | 30 | #define ubi_assert(expr) do { \ |
f2863c54 AB |
31 | if (unlikely(!(expr))) { \ |
32 | printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ | |
33 | __func__, __LINE__, current->pid); \ | |
25886a36 | 34 | dump_stack(); \ |
f2863c54 | 35 | } \ |
c8566350 | 36 | } while (0) |
801c135c | 37 | |
31532494 AB |
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 | ||
ab50ff68 AB |
41 | #define ubi_dbg_msg(type, fmt, ...) \ |
42 | pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__) | |
801c135c | 43 | |
ab50ff68 | 44 | /* Just a debugging messages not related to any specific UBI subsystem */ |
72f0d453 AB |
45 | #define dbg_msg(fmt, ...) \ |
46 | printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \ | |
47 | current->pid, __func__, ##__VA_ARGS__) | |
48 | ||
ab50ff68 AB |
49 | /* General debugging messages */ |
50 | #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__) | |
85c6e6e2 | 51 | /* Messages from the eraseblock association sub-system */ |
ab50ff68 | 52 | #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__) |
85c6e6e2 | 53 | /* Messages from the wear-leveling sub-system */ |
ab50ff68 | 54 | #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__) |
85c6e6e2 | 55 | /* Messages from the input/output sub-system */ |
ab50ff68 | 56 | #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__) |
801c135c | 57 | /* Initialization and build messages */ |
ab50ff68 AB |
58 | #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__) |
59 | ||
766381f0 | 60 | void ubi_dump_vol_info(const struct ubi_volume *vol); |
1f021e1d | 61 | void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx); |
614c74a7 | 62 | void ubi_dump_sv(const struct ubi_scan_volume *sv); |
b989bd4c | 63 | void ubi_dump_seb(const struct ubi_scan_leb *seb, int type); |
718c00bb | 64 | void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req); |
2a734bb8 AB |
65 | int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len); |
66 | int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum, | |
67 | int offset, int len); | |
68 | int ubi_debugging_init_dev(struct ubi_device *ubi); | |
69 | void ubi_debugging_exit_dev(struct ubi_device *ubi); | |
70 | int ubi_debugfs_init(void); | |
71 | void ubi_debugfs_exit(void); | |
72 | int ubi_debugfs_init_dev(struct ubi_device *ubi); | |
73 | void ubi_debugfs_exit_dev(struct ubi_device *ubi); | |
92d124f5 AB |
74 | |
75 | /* | |
2a734bb8 AB |
76 | * The UBI debugfs directory name pattern and maximum name length (3 for "ubi" |
77 | * + 2 for the number plus 1 for the trailing zero byte. | |
78 | */ | |
79 | #define UBI_DFS_DIR_NAME "ubi%d" | |
80 | #define UBI_DFS_DIR_LEN (3 + 2 + 1) | |
81 | ||
82 | /** | |
83 | * struct ubi_debug_info - debugging information for an UBI device. | |
92d124f5 | 84 | * |
2a734bb8 AB |
85 | * @chk_gen: if UBI general extra checks are enabled |
86 | * @chk_io: if UBI I/O extra checks are enabled | |
cd6d8567 AB |
87 | * @disable_bgt: disable the background task for testing purposes |
88 | * @emulate_bitflips: emulate bit-flips for testing purposes | |
89 | * @emulate_io_failures: emulate write/erase failures for testing purposes | |
2a734bb8 AB |
90 | * @dfs_dir_name: name of debugfs directory containing files of this UBI device |
91 | * @dfs_dir: direntry object of the UBI device debugfs directory | |
92 | * @dfs_chk_gen: debugfs knob to enable UBI general extra checks | |
93 | * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks | |
cd6d8567 AB |
94 | * @dfs_disable_bgt: debugfs knob to disable the background task |
95 | * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips | |
96 | * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures | |
92d124f5 | 97 | */ |
2a734bb8 AB |
98 | struct ubi_debug_info { |
99 | unsigned int chk_gen:1; | |
100 | unsigned int chk_io:1; | |
cd6d8567 AB |
101 | unsigned int disable_bgt:1; |
102 | unsigned int emulate_bitflips:1; | |
103 | unsigned int emulate_io_failures:1; | |
2a734bb8 AB |
104 | char dfs_dir_name[UBI_DFS_DIR_LEN + 1]; |
105 | struct dentry *dfs_dir; | |
106 | struct dentry *dfs_chk_gen; | |
107 | struct dentry *dfs_chk_io; | |
cd6d8567 AB |
108 | struct dentry *dfs_disable_bgt; |
109 | struct dentry *dfs_emulate_bitflips; | |
110 | struct dentry *dfs_emulate_io_failures; | |
28237e45 AB |
111 | }; |
112 | ||
113 | /** | |
114 | * ubi_dbg_is_bgt_disabled - if the background thread is disabled. | |
27a0f2a3 | 115 | * @ubi: UBI device description object |
28237e45 AB |
116 | * |
117 | * Returns non-zero if the UBI background thread is disabled for testing | |
118 | * purposes. | |
119 | */ | |
27a0f2a3 | 120 | static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) |
28237e45 | 121 | { |
cd6d8567 | 122 | return ubi->dbg->disable_bgt; |
28237e45 | 123 | } |
c8566350 | 124 | |
801c135c AB |
125 | /** |
126 | * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip. | |
27a0f2a3 | 127 | * @ubi: UBI device description object |
801c135c AB |
128 | * |
129 | * Returns non-zero if a bit-flip should be emulated, otherwise returns zero. | |
130 | */ | |
27a0f2a3 | 131 | static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) |
801c135c | 132 | { |
cd6d8567 | 133 | if (ubi->dbg->emulate_bitflips) |
28237e45 AB |
134 | return !(random32() % 200); |
135 | return 0; | |
801c135c | 136 | } |
801c135c | 137 | |
801c135c AB |
138 | /** |
139 | * ubi_dbg_is_write_failure - if it is time to emulate a write failure. | |
27a0f2a3 | 140 | * @ubi: UBI device description object |
801c135c AB |
141 | * |
142 | * Returns non-zero if a write failure should be emulated, otherwise returns | |
143 | * zero. | |
144 | */ | |
27a0f2a3 | 145 | static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi) |
801c135c | 146 | { |
cd6d8567 | 147 | if (ubi->dbg->emulate_io_failures) |
28237e45 AB |
148 | return !(random32() % 500); |
149 | return 0; | |
801c135c | 150 | } |
801c135c | 151 | |
801c135c AB |
152 | /** |
153 | * ubi_dbg_is_erase_failure - if its time to emulate an erase failure. | |
27a0f2a3 | 154 | * @ubi: UBI device description object |
801c135c AB |
155 | * |
156 | * Returns non-zero if an erase failure should be emulated, otherwise returns | |
157 | * zero. | |
158 | */ | |
27a0f2a3 | 159 | static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi) |
801c135c | 160 | { |
cd6d8567 | 161 | if (ubi->dbg->emulate_io_failures) |
801c135c | 162 | return !(random32() % 400); |
28237e45 | 163 | return 0; |
801c135c | 164 | } |
801c135c AB |
165 | |
166 | #endif /* !__UBI_DEBUG_H__ */ |