drivers/mtd/ubi/debug.h

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