libcfs/include/libcfs/libcfs_debug.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/libcfs_debug.h
  37  *
  38  * Debug messages and assertions
  39  *
  40  */
  41
  42 #ifndef __LIBCFS_DEBUG_H__
  43 #define __LIBCFS_DEBUG_H__
  44
  45 /*
  46  *  Debugging
  47  */
  48 extern unsigned int libcfs_subsystem_debug;
  49 extern unsigned int libcfs_stack;
  50 extern unsigned int libcfs_debug;
  51 extern unsigned int libcfs_printk;
  52 extern unsigned int libcfs_console_ratelimit;
  53 extern cfs_duration_t libcfs_console_max_delay;
  54 extern cfs_duration_t libcfs_console_min_delay;
  55 extern unsigned int libcfs_console_backoff;
  56 extern unsigned int libcfs_debug_binary;
  57 extern char debug_file_path[1024];
  58
  59 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
  60 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
  61
  62 /* Has there been an LBUG? */
  63 extern unsigned int libcfs_catastrophe;
  64 extern unsigned int libcfs_panic_on_lbug;
  65
  66 /**
  67  * Format for debug message headers
  68  */
  69 struct ptldebug_header {
  70         __u32 ph_len;
  71         __u32 ph_flags;
  72         __u32 ph_subsys;
  73         __u32 ph_mask;
  74         __u32 ph_cpu_id;
  75         __u32 ph_sec;
  76         __u64 ph_usec;
  77         __u32 ph_stack;
  78         __u32 ph_pid;
  79         __u32 ph_extern_pid;
  80         __u32 ph_line_num;
  81 } __attribute__((packed));
  82
  83
  84 #define PH_FLAG_FIRST_RECORD 1
  85
  86 /* Debugging subsystems (32 bits, non-overlapping) */
  87 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
  88 #define S_UNDEFINED   0x00000001
  89 #define S_MDC         0x00000002
  90 #define S_MDS         0x00000004
  91 #define S_OSC         0x00000008
  92 #define S_OST         0x00000010
  93 #define S_CLASS       0x00000020
  94 #define S_LOG         0x00000040
  95 #define S_LLITE       0x00000080
  96 #define S_RPC         0x00000100
  97 #define S_MGMT        0x00000200
  98 #define S_LNET        0x00000400
  99 #define S_LND         0x00000800 /* ALL LNDs */
 100 #define S_PINGER      0x00001000
 101 #define S_FILTER      0x00002000
 102 /* unused */
 103 #define S_ECHO        0x00008000
 104 #define S_LDLM        0x00010000
 105 #define S_LOV         0x00020000
 106 /* unused */
 107 /* unused */
 108 /* unused */
 109 /* unused */
 110 /* unused */
 111 #define S_LMV         0x00800000 /* b_new_cmd */
 112 /* unused */
 113 #define S_SEC         0x02000000 /* upcall cache */
 114 #define S_GSS         0x04000000 /* b_new_cmd */
 115 /* unused */
 116 #define S_MGC         0x10000000
 117 #define S_MGS         0x20000000
 118 #define S_FID         0x40000000 /* b_new_cmd */
 119 #define S_FLD         0x80000000 /* b_new_cmd */
 120 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
 121
 122 /* Debugging masks (32 bits, non-overlapping) */
 123 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
 124 #define D_TRACE       0x00000001 /* ENTRY/EXIT markers */
 125 #define D_INODE       0x00000002
 126 #define D_SUPER       0x00000004
 127 #define D_EXT2        0x00000008 /* anything from ext2_debug */
 128 #define D_MALLOC      0x00000010 /* print malloc, free information */
 129 #define D_CACHE       0x00000020 /* cache-related items */
 130 #define D_INFO        0x00000040 /* general information */
 131 #define D_IOCTL       0x00000080 /* ioctl related information */
 132 #define D_NETERROR    0x00000100 /* network errors */
 133 #define D_NET         0x00000200 /* network communications */
 134 #define D_WARNING     0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
 135 #define D_BUFFS       0x00000800
 136 #define D_OTHER       0x00001000
 137 #define D_DENTRY      0x00002000
 138 #define D_NETTRACE    0x00004000
 139 #define D_PAGE        0x00008000 /* bulk page handling */
 140 #define D_DLMTRACE    0x00010000
 141 #define D_ERROR       0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
 142 #define D_EMERG       0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
 143 #define D_HA          0x00080000 /* recovery and failover */
 144 #define D_RPCTRACE    0x00100000 /* for distributed debugging */
 145 #define D_VFSTRACE    0x00200000
 146 #define D_READA       0x00400000 /* read-ahead */
 147 #define D_MMAP        0x00800000
 148 #define D_CONFIG      0x01000000
 149 #define D_CONSOLE     0x02000000
 150 #define D_QUOTA       0x04000000
 151 #define D_SEC         0x08000000
 152 /* keep these in sync with lnet/{utils,libcfs}/debug.c */
 153
 154 #define D_CANTMASK   (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
 155
 156 #ifndef DEBUG_SUBSYSTEM
 157 # define DEBUG_SUBSYSTEM S_UNDEFINED
 158 #endif
 159
 160 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600))         /* jiffies */
 161 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
 162 #define CDEBUG_DEFAULT_BACKOFF   2
 163 typedef struct {
 164         cfs_time_t      cdls_next;
 165         int             cdls_count;
 166         cfs_duration_t  cdls_delay;
 167 } cfs_debug_limit_state_t;
 168
 169 #if defined(__KERNEL__) || (defined(__arch_lib__) && !defined(LUSTRE_UTILS))
 170
 171 #ifdef CDEBUG_ENABLED
 172 #define __CDEBUG(cdls, mask, format, a...)                              \
 173 do {                                                                    \
 174         CHECK_STACK();                                                  \
 175                                                                         \
 176         if (((mask) & D_CANTMASK) != 0 ||                               \
 177             ((libcfs_debug & (mask)) != 0 &&                            \
 178              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
 179                 libcfs_debug_msg(cdls, DEBUG_SUBSYSTEM, mask,           \
 180                                  __FILE__, __FUNCTION__, __LINE__,      \
 181                                  format, ## a);                         \
 182 } while (0)
 183
 184 #define CDEBUG(mask, format, a...) __CDEBUG(NULL, mask, format, ## a)
 185
 186 #define CDEBUG_LIMIT(mask, format, a...)        \
 187 do {                                            \
 188         static cfs_debug_limit_state_t cdls;    \
 189                                                 \
 190         __CDEBUG(&cdls, mask, format, ## a);    \
 191 } while (0)
 192
 193 #else /* !CDEBUG_ENABLED */
 194 #define CDEBUG(mask, format, a...) (void)(0)
 195 #define CDEBUG_LIMIT(mask, format, a...) (void)(0)
 196 #warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
 197 #endif
 198
 199 #else /* !__KERNEL__ && (!__arch_lib__ || LUSTRE_UTILS) */
 200
 201 #define CDEBUG(mask, format, a...)                                      \
 202 do {                                                                    \
 203         if (((mask) & D_CANTMASK) != 0)                                 \
 204                 fprintf(stderr, "(%s:%d:%s()) " format,                 \
 205                         __FILE__, __LINE__, __FUNCTION__, ## a);        \
 206 } while (0)
 207
 208 #define CDEBUG_LIMIT CDEBUG
 209
 210 #endif /* !__KERNEL__ ... */
 211
 212
 213 #define CWARN(format, a...)          CDEBUG_LIMIT(D_WARNING, format, ## a)
 214 #define CERROR(format, a...)         CDEBUG_LIMIT(D_ERROR, format, ## a)
 215 #define CEMERG(format, a...)         CDEBUG_LIMIT(D_EMERG, format, ## a)
 216
 217 #define LCONSOLE(mask, format, a...) CDEBUG(D_CONSOLE | (mask), format, ## a)
 218 #define LCONSOLE_INFO(format, a...)  CDEBUG_LIMIT(D_CONSOLE, format, ## a)
 219 #define LCONSOLE_WARN(format, a...)  CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## a)
 220 #define LCONSOLE_ERROR_MSG(errnum, format, a...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
 221                            "%x-%x: " format, errnum, LERRCHKSUM(errnum),  ## a)
 222 #define LCONSOLE_ERROR(format, a...) LCONSOLE_ERROR_MSG(0x00, format, ## a)
 223
 224 #define LCONSOLE_EMERG(format, a...) CDEBUG(D_CONSOLE | D_EMERG, format, ## a)
 225
 226 #ifdef CDEBUG_ENABLED
 227
 228 #define GOTO(label, rc)                                                 \
 229 do {                                                                    \
 230         long GOTO__ret = (long)(rc);                                    \
 231         CDEBUG(D_TRACE,"Process leaving via %s (rc=%lu : %ld : %lx)\n", \
 232                #label, (unsigned long)GOTO__ret, (signed long)GOTO__ret,\
 233                (signed long)GOTO__ret);                                 \
 234         goto label;                                                     \
 235 } while (0)
 236 #else
 237 #define GOTO(label, rc) do { ((void)(rc)); goto label; } while (0)
 238 #endif
 239
 240 #ifdef CDEBUG_ENTRY_EXIT
 241
 242 /*
 243  * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
 244  * there will be a warning in osx.
 245  */
 246 #define RETURN(rc)                                                      \
 247 do {                                                                    \
 248         typeof(rc) RETURN__ret = (rc);                                  \
 249         CDEBUG(D_TRACE, "Process leaving (rc=%lu : %ld : %lx)\n",       \
 250                (long)RETURN__ret, (long)RETURN__ret, (long)RETURN__ret);\
 251         EXIT_NESTING;                                                   \
 252         return RETURN__ret;                                             \
 253 } while (0)
 254
 255 #define ENTRY                                                           \
 256 ENTRY_NESTING;                                                          \
 257 do {                                                                    \
 258         CDEBUG(D_TRACE, "Process entered\n");                           \
 259 } while (0)
 260
 261 #define EXIT                                                            \
 262 do {                                                                    \
 263         CDEBUG(D_TRACE, "Process leaving\n");                           \
 264         EXIT_NESTING;                                                   \
 265 } while(0)
 266 #else /* !CDEBUG_ENTRY_EXIT */
 267
 268 #define RETURN(rc) return (rc)
 269 #define ENTRY                           do { } while (0)
 270 #define EXIT                            do { } while (0)
 271
 272 #endif /* !CDEBUG_ENTRY_EXIT */
 273
 274
 275 struct libcfs_debug_msg_data {
 276         cfs_debug_limit_state_t *msg_cdls;
 277         int                      msg_subsys;
 278         const char              *msg_file;
 279         const char              *msg_fn;
 280         int                      msg_line;
 281 };
 282
 283 #define DEBUG_MSG_DATA_INIT(cdls, subsystem, file, func, ln ) { \
 284         .msg_cdls           = (cdls),       \
 285         .msg_subsys         = (subsystem),  \
 286         .msg_file           = (file),       \
 287         .msg_fn             = (func),       \
 288         .msg_line           = (ln)          \
 289     }
 290
 291
 292 extern int libcfs_debug_vmsg2(cfs_debug_limit_state_t *cdls,
 293                               int subsys, int mask,
 294                               const char *file, const char *fn, const int line,
 295                               const char *format1, va_list args,
 296                               const char *format2, ...)
 297         __attribute__ ((format (printf, 9, 10)));
 298
 299 #define libcfs_debug_vmsg(cdls, subsys, mask, file, fn, line, format, args)   \
 300     libcfs_debug_vmsg2(cdls, subsys, mask, file, fn,line,format,args,NULL,NULL)
 301
 302 #define libcfs_debug_msg(cdls, subsys, mask, file, fn, line, format, a...)    \
 303     libcfs_debug_vmsg2(cdls, subsys, mask, file, fn,line,NULL,NULL,format, ##a)
 304
 305 #define cdebug_va(cdls, mask, file, func, line, fmt, args)      do {          \
 306         CHECK_STACK();                                                        \
 307                                                                               \
 308         if (((mask) & D_CANTMASK) != 0 ||                                     \
 309             ((libcfs_debug & (mask)) != 0 &&                                  \
 310              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                \
 311                 libcfs_debug_vmsg(cdls, DEBUG_SUBSYSTEM, (mask),              \
 312                                   (file), (func), (line), fmt, args);         \
 313 } while(0);
 314
 315 #define cdebug(cdls, mask, file, func, line, fmt, a...) do {                  \
 316         CHECK_STACK();                                                        \
 317                                                                               \
 318         if (((mask) & D_CANTMASK) != 0 ||                                     \
 319             ((libcfs_debug & (mask)) != 0 &&                                  \
 320              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                \
 321                 libcfs_debug_msg(cdls, DEBUG_SUBSYSTEM, (mask),               \
 322                                  (file), (func), (line), fmt, ## a);          \
 323 } while(0);
 324
 325 extern void libcfs_assertion_failed(const char *expr, const char *file,
 326                                     const char *fn, const int line);
 327
 328
 329
 330 #endif  /* __LIBCFS_DEBUG_H__ */