debug.h

Go to the documentation of this file.

/*
 * Copyright (c) International Business Machines Corp., 2006
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
 * the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Author: Artem Bityutskiy (Битюцкий Артём)
 */

#ifndef __UBI_DEBUG_H__
#define __UBI_DEBUG_H__

void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);

#include <linux/random.h>

#define ubi_assert(expr)  do {                                               \
    if (unlikely(!(expr))) {                                             \
        pr_crit("UBI assert failed in %s at %u (pid %d)\n",          \
               __func__, __LINE__, current->pid);                    \
        dump_stack();                                                \
    }                                                                    \
} while (0)

#define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a)                   \
        print_hex_dump(l, ps, pt, r, g, b, len, a)

#define ubi_dbg_msg(type, fmt, ...) \
    pr_debug("UBI DBG " type " (pid %d): " fmt "\n", current->pid,       \
         ##__VA_ARGS__)

/* General debugging messages */
#define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
/* Messages from the eraseblock association sub-system */
#define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
/* Messages from the wear-leveling sub-system */
#define dbg_wl(fmt, ...)  ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
/* Messages from the input/output sub-system */
#define dbg_io(fmt, ...)  ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
/* Initialization and build messages */
#define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)

void ubi_dump_vol_info(const struct ubi_volume *vol);
void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
void ubi_dump_av(const struct ubi_ainf_volume *av);
void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type);
void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req);
int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset,
              int len);
int ubi_debugging_init_dev(struct ubi_device *ubi);
void ubi_debugging_exit_dev(struct ubi_device *ubi);
int ubi_debugfs_init(void);
void ubi_debugfs_exit(void);
int ubi_debugfs_init_dev(struct ubi_device *ubi);
void ubi_debugfs_exit_dev(struct ubi_device *ubi);

/*
 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
 * + 2 for the number plus 1 for the trailing zero byte.
 */
#define UBI_DFS_DIR_NAME "ubi%d"
#define UBI_DFS_DIR_LEN  (3 + 2 + 1)

struct ubi_debug_info {
    unsigned int chk_gen:1;
    unsigned int chk_io:1;
    unsigned int disable_bgt:1;
    unsigned int emulate_bitflips:1;
    unsigned int emulate_io_failures:1;
    char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
    struct dentry *dfs_dir;
    struct dentry *dfs_chk_gen;
    struct dentry *dfs_chk_io;
    struct dentry *dfs_disable_bgt;
    struct dentry *dfs_emulate_bitflips;
    struct dentry *dfs_emulate_io_failures;
};

static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
{
    return ubi->dbg->disable_bgt;
}

static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
{
    if (ubi->dbg->emulate_bitflips)
        return !(random32() % 200);
    return 0;
}

static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
{
    if (ubi->dbg->emulate_io_failures)
        return !(random32() % 500);
    return 0;
}

static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
{
    if (ubi->dbg->emulate_io_failures)
        return !(random32() % 400);
    return 0;
}

#endif /* !__UBI_DEBUG_H__ */