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