Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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#ifdef CONFIG_MTD_UBI_DEBUG
25#include <linux/random.h>
26
27#define ubi_assert(expr) do { \
28 if (unlikely(!(expr))) { \
29 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
30 __func__, __LINE__, current->pid); \
31 ubi_dbg_dump_stack(); \
32 } \
33} while (0)
34
35#define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__)
36
37#define ubi_dbg_dump_stack() dump_stack()
38
39#define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \
40 print_hex_dump(l, ps, pt, r, g, b, len, a)
41
42#define ubi_dbg_msg(type, fmt, ...) \
43 pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__)
44
45/* Just a debugging messages not related to any specific UBI subsystem */
46#define dbg_msg(fmt, ...) \
47 printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \
48 current->pid, __func__, ##__VA_ARGS__)
49
50/* General debugging messages */
51#define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
52/* Messages from the eraseblock association sub-system */
53#define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
54/* Messages from the wear-leveling sub-system */
55#define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
56/* Messages from the input/output sub-system */
57#define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
58/* Initialization and build messages */
59#define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)
60
61void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
62void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);
63void ubi_dbg_dump_vol_info(const struct ubi_volume *vol);
64void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
65void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv);
66void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type);
67void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req);
68void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
69int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len);
70int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum,
71 int offset, int len);
72int ubi_debugging_init_dev(struct ubi_device *ubi);
73void ubi_debugging_exit_dev(struct ubi_device *ubi);
74int ubi_debugfs_init(void);
75void ubi_debugfs_exit(void);
76int ubi_debugfs_init_dev(struct ubi_device *ubi);
77void ubi_debugfs_exit_dev(struct ubi_device *ubi);
78
79/*
80 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
81 * + 2 for the number plus 1 for the trailing zero byte.
82 */
83#define UBI_DFS_DIR_NAME "ubi%d"
84#define UBI_DFS_DIR_LEN (3 + 2 + 1)
85
86/**
87 * struct ubi_debug_info - debugging information for an UBI device.
88 *
89 * @chk_gen: if UBI general extra checks are enabled
90 * @chk_io: if UBI I/O extra checks are enabled
91 * @disable_bgt: disable the background task for testing purposes
92 * @emulate_bitflips: emulate bit-flips for testing purposes
93 * @emulate_io_failures: emulate write/erase failures for testing purposes
94 * @dfs_dir_name: name of debugfs directory containing files of this UBI device
95 * @dfs_dir: direntry object of the UBI device debugfs directory
96 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
97 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
98 * @dfs_disable_bgt: debugfs knob to disable the background task
99 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
100 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
101 */
102struct ubi_debug_info {
103 unsigned int chk_gen:1;
104 unsigned int chk_io:1;
105 unsigned int disable_bgt:1;
106 unsigned int emulate_bitflips:1;
107 unsigned int emulate_io_failures:1;
108 char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
109 struct dentry *dfs_dir;
110 struct dentry *dfs_chk_gen;
111 struct dentry *dfs_chk_io;
112 struct dentry *dfs_disable_bgt;
113 struct dentry *dfs_emulate_bitflips;
114 struct dentry *dfs_emulate_io_failures;
115};
116
117/**
118 * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
119 * @ubi: UBI device description object
120 *
121 * Returns non-zero if the UBI background thread is disabled for testing
122 * purposes.
123 */
124static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
125{
126 return ubi->dbg->disable_bgt;
127}
128
129/**
130 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
131 * @ubi: UBI device description object
132 *
133 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
134 */
135static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
136{
137 if (ubi->dbg->emulate_bitflips)
138 return !(random32() % 200);
139 return 0;
140}
141
142/**
143 * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
144 * @ubi: UBI device description object
145 *
146 * Returns non-zero if a write failure should be emulated, otherwise returns
147 * zero.
148 */
149static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
150{
151 if (ubi->dbg->emulate_io_failures)
152 return !(random32() % 500);
153 return 0;
154}
155
156/**
157 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
158 * @ubi: UBI device description object
159 *
160 * Returns non-zero if an erase failure should be emulated, otherwise returns
161 * zero.
162 */
163static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
164{
165 if (ubi->dbg->emulate_io_failures)
166 return !(random32() % 400);
167 return 0;
168}
169
170#else
171
172/* Use "if (0)" to make compiler check arguments even if debugging is off */
173#define ubi_assert(expr) do { \
174 if (0) { \
175 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
176 __func__, __LINE__, current->pid); \
177 } \
178} while (0)
179
180#define dbg_err(fmt, ...) do { \
181 if (0) \
182 ubi_err(fmt, ##__VA_ARGS__); \
183} while (0)
184
185#define ubi_dbg_msg(fmt, ...) do { \
186 if (0) \
187 printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \
188} while (0)
189
190#define dbg_msg(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
191#define dbg_gen(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
192#define dbg_eba(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
193#define dbg_wl(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
194#define dbg_io(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
195#define dbg_bld(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
196
197static inline void ubi_dbg_dump_stack(void) { return; }
198static inline void
199ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr) { return; }
200static inline void
201ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr) { return; }
202static inline void
203ubi_dbg_dump_vol_info(const struct ubi_volume *vol) { return; }
204static inline void
205ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx) { return; }
206static inline void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv) { return; }
207static inline void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb,
208 int type) { return; }
209static inline void
210ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req) { return; }
211static inline void ubi_dbg_dump_flash(struct ubi_device *ubi,
212 int pnum, int offset, int len) { return; }
213static inline void
214ubi_dbg_print_hex_dump(const char *l, const char *ps, int pt, int r,
215 int g, const void *b, size_t len, bool a) { return; }
216static inline int ubi_dbg_check_all_ff(struct ubi_device *ubi,
217 int pnum, int offset,
218 int len) { return 0; }
219static inline int ubi_dbg_check_write(struct ubi_device *ubi,
220 const void *buf, int pnum,
221 int offset, int len) { return 0; }
222
223static inline int ubi_debugging_init_dev(struct ubi_device *ubi) { return 0; }
224static inline void ubi_debugging_exit_dev(struct ubi_device *ubi) { return; }
225static inline int ubi_debugfs_init(void) { return 0; }
226static inline void ubi_debugfs_exit(void) { return; }
227static inline int ubi_debugfs_init_dev(struct ubi_device *ubi) { return 0; }
228static inline void ubi_debugfs_exit_dev(struct ubi_device *ubi) { return; }
229
230static inline int
231ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) { return 0; }
232static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) { return 0; }
233static inline int
234ubi_dbg_is_write_failure(const struct ubi_device *ubi) { return 0; }
235static inline int
236ubi_dbg_is_erase_failure(const struct ubi_device *ubi) { return 0; }
237
238#endif /* !CONFIG_MTD_UBI_DEBUG */
239#endif /* !__UBI_DEBUG_H__ */