fs/aufs/debug.h

   1 /*
   2  * Copyright (C) 2005-2012 Junjiro R. Okajima
   3  *
   4  * This program, aufs 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 the
  12  * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18
  19 /*
  20  * debug print functions
  21  */
  22
  23 #ifndef __AUFS_DEBUG_H__
  24 #define __AUFS_DEBUG_H__
  25
  26 #ifdef __KERNEL__
  27
  28 #include <asm/system.h>
  29 #include <linux/module.h>
  30 #include <linux/kallsyms.h>
  31 #include <linux/sysrq.h>
  32
  33 #ifdef CONFIG_AUFS_DEBUG
  34 #define AuDebugOn(a)            BUG_ON(a)
  35
  36 /* module parameter */
  37 extern int aufs_debug;
  38 static inline void au_debug(int n)
  39 {
  40         aufs_debug = n;
  41         smp_mb();
  42 }
  43
  44 static inline int au_debug_test(void)
  45 {
  46         return aufs_debug;
  47 }
  48 #else
  49 #define AuDebugOn(a)            do {} while (0)
  50 AuStubVoid(au_debug, int n)
  51 AuStubInt0(au_debug_test, void)
  52 #endif /* CONFIG_AUFS_DEBUG */
  53
  54 /* ---------------------------------------------------------------------- */
  55
  56 /* debug print */
  57
  58 #define AuDbg(fmt, ...) do { \
  59         if (au_debug_test()) \
  60                 pr_debug("DEBUG: " fmt, ##__VA_ARGS__); \
  61 } while (0)
  62 #define AuLabel(l)              AuDbg(#l "\n")
  63 #define AuIOErr(fmt, ...)       pr_err("I/O Error, " fmt, ##__VA_ARGS__)
  64 #define AuWarn1(fmt, ...) do { \
  65         static unsigned char _c; \
  66         if (!_c++) \
  67                 pr_warning(fmt, ##__VA_ARGS__); \
  68 } while (0)
  69
  70 #define AuErr1(fmt, ...) do { \
  71         static unsigned char _c; \
  72         if (!_c++) \
  73                 pr_err(fmt, ##__VA_ARGS__); \
  74 } while (0)
  75
  76 #define AuIOErr1(fmt, ...) do { \
  77         static unsigned char _c; \
  78         if (!_c++) \
  79                 AuIOErr(fmt, ##__VA_ARGS__); \
  80 } while (0)
  81
  82 #define AuUnsupportMsg  "This operation is not supported." \
  83                         " Please report this application to aufs-users ML."
  84 #define AuUnsupport(fmt, ...) do { \
  85         pr_err(AuUnsupportMsg "\n" fmt, ##__VA_ARGS__); \
  86         dump_stack(); \
  87 } while (0)
  88
  89 #define AuTraceErr(e) do { \
  90         if (unlikely((e) < 0)) \
  91                 AuDbg("err %d\n", (int)(e)); \
  92 } while (0)
  93
  94 #define AuTraceErrPtr(p) do { \
  95         if (IS_ERR(p)) \
  96                 AuDbg("err %ld\n", PTR_ERR(p)); \
  97 } while (0)
  98
  99 /* dirty macros for debug print, use with "%.*s" and caution */
 100 #define AuLNPair(qstr)          (qstr)->len, (qstr)->name
 101 #define AuDLNPair(d)            AuLNPair(&(d)->d_name)
 102
 103 /* ---------------------------------------------------------------------- */
 104
 105 struct au_sbinfo;
 106 struct au_finfo;
 107 struct dentry;
 108 #ifdef CONFIG_AUFS_DEBUG
 109 extern char *au_plevel;
 110 struct au_nhash;
 111 void au_dpri_whlist(struct au_nhash *whlist);
 112 struct au_vdir;
 113 void au_dpri_vdir(struct au_vdir *vdir);
 114 struct inode;
 115 void au_dpri_inode(struct inode *inode);
 116 void au_dpri_dalias(struct inode *inode);
 117 void au_dpri_dentry(struct dentry *dentry);
 118 struct file;
 119 void au_dpri_file(struct file *filp);
 120 struct super_block;
 121 void au_dpri_sb(struct super_block *sb);
 122
 123 void au_dbg_sleep_jiffy(int jiffy);
 124 struct iattr;
 125 void au_dbg_iattr(struct iattr *ia);
 126
 127 #define au_dbg_verify_dinode(d) __au_dbg_verify_dinode(d, __func__, __LINE__)
 128 void __au_dbg_verify_dinode(struct dentry *dentry, const char *func, int line);
 129 void au_dbg_verify_dir_parent(struct dentry *dentry, unsigned int sigen);
 130 void au_dbg_verify_nondir_parent(struct dentry *dentry, unsigned int sigen);
 131 void au_dbg_verify_gen(struct dentry *parent, unsigned int sigen);
 132 void au_dbg_verify_kthread(void);
 133
 134 int __init au_debug_init(void);
 135 void au_debug_sbinfo_init(struct au_sbinfo *sbinfo);
 136 #define AuDbgWhlist(w) do { \
 137         AuDbg(#w "\n"); \
 138         au_dpri_whlist(w); \
 139 } while (0)
 140
 141 #define AuDbgVdir(v) do { \
 142         AuDbg(#v "\n"); \
 143         au_dpri_vdir(v); \
 144 } while (0)
 145
 146 #define AuDbgInode(i) do { \
 147         AuDbg(#i "\n"); \
 148         au_dpri_inode(i); \
 149 } while (0)
 150
 151 #define AuDbgDAlias(i) do { \
 152         AuDbg(#i "\n"); \
 153         au_dpri_dalias(i); \
 154 } while (0)
 155
 156 #define AuDbgDentry(d) do { \
 157         AuDbg(#d "\n"); \
 158         au_dpri_dentry(d); \
 159 } while (0)
 160
 161 #define AuDbgFile(f) do { \
 162         AuDbg(#f "\n"); \
 163         au_dpri_file(f); \
 164 } while (0)
 165
 166 #define AuDbgSb(sb) do { \
 167         AuDbg(#sb "\n"); \
 168         au_dpri_sb(sb); \
 169 } while (0)
 170
 171 #define AuDbgSleep(sec) do { \
 172         AuDbg("sleep %d sec\n", sec); \
 173         ssleep(sec); \
 174 } while (0)
 175
 176 #define AuDbgSleepJiffy(jiffy) do { \
 177         AuDbg("sleep %d jiffies\n", jiffy); \
 178         au_dbg_sleep_jiffy(jiffy); \
 179 } while (0)
 180
 181 #define AuDbgIAttr(ia) do { \
 182         AuDbg("ia_valid 0x%x\n", (ia)->ia_valid); \
 183         au_dbg_iattr(ia); \
 184 } while (0)
 185
 186 #define AuDbgSym(addr) do {                             \
 187         char sym[KSYM_SYMBOL_LEN];                      \
 188         sprint_symbol(sym, (unsigned long)addr);        \
 189         AuDbg("%s\n", sym);                             \
 190 } while (0)
 191
 192 #define AuInfoSym(addr) do {                            \
 193         char sym[KSYM_SYMBOL_LEN];                      \
 194         sprint_symbol(sym, (unsigned long)addr);        \
 195         AuInfo("%s\n", sym);                            \
 196 } while (0)
 197 #else
 198 AuStubVoid(au_dbg_verify_dinode, struct dentry *dentry)
 199 AuStubVoid(au_dbg_verify_dir_parent, struct dentry *dentry, unsigned int sigen)
 200 AuStubVoid(au_dbg_verify_nondir_parent, struct dentry *dentry,
 201            unsigned int sigen)
 202 AuStubVoid(au_dbg_verify_gen, struct dentry *parent, unsigned int sigen)
 203 AuStubVoid(au_dbg_verify_kthread, void)
 204 AuStubInt0(__init au_debug_init, void)
 205 AuStubVoid(au_debug_sbinfo_init, struct au_sbinfo *sbinfo)
 206
 207 #define AuDbgWhlist(w)          do {} while (0)
 208 #define AuDbgVdir(v)            do {} while (0)
 209 #define AuDbgInode(i)           do {} while (0)
 210 #define AuDbgDAlias(i)          do {} while (0)
 211 #define AuDbgDentry(d)          do {} while (0)
 212 #define AuDbgFile(f)            do {} while (0)
 213 #define AuDbgSb(sb)             do {} while (0)
 214 #define AuDbgSleep(sec)         do {} while (0)
 215 #define AuDbgSleepJiffy(jiffy)  do {} while (0)
 216 #define AuDbgIAttr(ia)          do {} while (0)
 217 #define AuDbgSym(addr)          do {} while (0)
 218 #define AuInfoSym(addr)         do {} while (0)
 219 #endif /* CONFIG_AUFS_DEBUG */
 220
 221 /* ---------------------------------------------------------------------- */
 222
 223 #ifdef CONFIG_AUFS_MAGIC_SYSRQ
 224 int __init au_sysrq_init(void);
 225 void au_sysrq_fin(void);
 226
 227 #ifdef CONFIG_HW_CONSOLE
 228 #define au_dbg_blocked() do { \
 229         WARN_ON(1); \
 230         handle_sysrq('w'); \
 231 } while (0)
 232 #else
 233 AuStubVoid(au_dbg_blocked, void)
 234 #endif
 235
 236 #else
 237 AuStubInt0(__init au_sysrq_init, void)
 238 AuStubVoid(au_sysrq_fin, void)
 239 AuStubVoid(au_dbg_blocked, void)
 240 #endif /* CONFIG_AUFS_MAGIC_SYSRQ */
 241
 242 #endif /* __KERNEL__ */
 243 #endif /* __AUFS_DEBUG_H__ */