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 dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__)
28
29#define ubi_assert(expr) do { \
30 if (unlikely(!(expr))) { \
31 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
32 __func__, __LINE__, current->pid); \
33 ubi_dbg_dump_stack(); \
34 } \
35} while (0)
36
37#define dbg_msg(fmt, ...) \
38 printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \
39 current->pid, __func__, ##__VA_ARGS__)
40
41#define dbg_do_msg(typ, fmt, ...) do { \
42 if (ubi_msg_flags & typ) \
43 dbg_msg(fmt, ##__VA_ARGS__); \
44} while (0)
45
46#define ubi_dbg_dump_stack() dump_stack()
47
48struct ubi_ec_hdr;
49struct ubi_vid_hdr;
50struct ubi_volume;
51struct ubi_vtbl_record;
52struct ubi_scan_volume;
53struct ubi_scan_leb;
54struct ubi_mkvol_req;
55
56void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
57void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);
58void ubi_dbg_dump_vol_info(const struct ubi_volume *vol);
59void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
60void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv);
61void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type);
62void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req);
63void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
64
65extern unsigned int ubi_msg_flags;
66
67/*
68 * Debugging message type flags (must match msg_type_names in debug.c).
69 *
70 * UBI_MSG_GEN: general messages
71 * UBI_MSG_EBA: journal messages
72 * UBI_MSG_WL: mount messages
73 * UBI_MSG_IO: commit messages
74 * UBI_MSG_BLD: LEB find messages
75 */
76enum {
77 UBI_MSG_GEN = 0x1,
78 UBI_MSG_EBA = 0x2,
79 UBI_MSG_WL = 0x4,
80 UBI_MSG_IO = 0x8,
81 UBI_MSG_BLD = 0x10,
82};
83
84#define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \
85 print_hex_dump(l, ps, pt, r, g, b, len, a)
86
87/* General debugging messages */
88#define dbg_gen(fmt, ...) dbg_do_msg(UBI_MSG_GEN, fmt, ##__VA_ARGS__)
89
90/* Messages from the eraseblock association sub-system */
91#define dbg_eba(fmt, ...) dbg_do_msg(UBI_MSG_EBA, fmt, ##__VA_ARGS__)
92
93/* Messages from the wear-leveling sub-system */
94#define dbg_wl(fmt, ...) dbg_do_msg(UBI_MSG_WL, fmt, ##__VA_ARGS__)
95
96/* Messages from the input/output sub-system */
97#define dbg_io(fmt, ...) dbg_do_msg(UBI_MSG_IO, fmt, ##__VA_ARGS__)
98
99/* Initialization and build messages */
100#define dbg_bld(fmt, ...) dbg_do_msg(UBI_MSG_BLD, fmt, ##__VA_ARGS__)
101
102extern unsigned int ubi_chk_flags;
103
104/*
105 * Debugging check flags.
106 *
107 * UBI_CHK_GEN: general checks
108 * UBI_CHK_IO: check writes and erases
109 */
110enum {
111 UBI_CHK_GEN = 0x1,
112 UBI_CHK_IO = 0x2,
113};
114
115int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len);
116int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum,
117 int offset, int len);
118
119extern unsigned int ubi_tst_flags;
120
121/*
122 * Special testing flags.
123 *
124 * UBIFS_TST_DISABLE_BGT: disable the background thread
125 * UBI_TST_EMULATE_BITFLIPS: emulate bit-flips
126 * UBI_TST_EMULATE_WRITE_FAILURES: emulate write failures
127 * UBI_TST_EMULATE_ERASE_FAILURES: emulate erase failures
128 */
129enum {
130 UBI_TST_DISABLE_BGT = 0x1,
131 UBI_TST_EMULATE_BITFLIPS = 0x2,
132 UBI_TST_EMULATE_WRITE_FAILURES = 0x4,
133 UBI_TST_EMULATE_ERASE_FAILURES = 0x8,
134};
135
136/**
137 * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
138 *
139 * Returns non-zero if the UBI background thread is disabled for testing
140 * purposes.
141 */
142static inline int ubi_dbg_is_bgt_disabled(void)
143{
144 return ubi_tst_flags & UBI_TST_DISABLE_BGT;
145}
146
147/**
148 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
149 *
150 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
151 */
152static inline int ubi_dbg_is_bitflip(void)
153{
154 if (ubi_tst_flags & UBI_TST_EMULATE_BITFLIPS)
155 return !(random32() % 200);
156 return 0;
157}
158
159/**
160 * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
161 *
162 * Returns non-zero if a write failure should be emulated, otherwise returns
163 * zero.
164 */
165static inline int ubi_dbg_is_write_failure(void)
166{
167 if (ubi_tst_flags & UBI_TST_EMULATE_WRITE_FAILURES)
168 return !(random32() % 500);
169 return 0;
170}
171
172/**
173 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
174 *
175 * Returns non-zero if an erase failure should be emulated, otherwise returns
176 * zero.
177 */
178static inline int ubi_dbg_is_erase_failure(void)
179{
180 if (ubi_tst_flags & UBI_TST_EMULATE_ERASE_FAILURES)
181 return !(random32() % 400);
182 return 0;
183}
184
185#else
186
187#define ubi_assert(expr) ({})
188#define dbg_err(fmt, ...) ({})
189#define dbg_msg(fmt, ...) ({})
190#define dbg_gen(fmt, ...) ({})
191#define dbg_eba(fmt, ...) ({})
192#define dbg_wl(fmt, ...) ({})
193#define dbg_io(fmt, ...) ({})
194#define dbg_bld(fmt, ...) ({})
195#define ubi_dbg_dump_stack() ({})
196#define ubi_dbg_dump_ec_hdr(ec_hdr) ({})
197#define ubi_dbg_dump_vid_hdr(vid_hdr) ({})
198#define ubi_dbg_dump_vol_info(vol) ({})
199#define ubi_dbg_dump_vtbl_record(r, idx) ({})
200#define ubi_dbg_dump_sv(sv) ({})
201#define ubi_dbg_dump_seb(seb, type) ({})
202#define ubi_dbg_dump_mkvol_req(req) ({})
203#define ubi_dbg_dump_flash(ubi, pnum, offset, len) ({})
204#define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) ({})
205
206#define ubi_dbg_is_bgt_disabled() 0
207#define ubi_dbg_is_bitflip() 0
208#define ubi_dbg_is_write_failure() 0
209#define ubi_dbg_is_erase_failure() 0
210#define ubi_dbg_check_all_ff(ubi, pnum, offset, len) 0
211#define ubi_dbg_check_write(ubi, buf, pnum, offset, len) 0
212
213#endif /* !CONFIG_MTD_UBI_DEBUG */
214#endif /* !__UBI_DEBUG_H__ */