libcfs/include/libcfs/libcfs_debug.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * libcfs/include/libcfs/libcfs_debug.h
  33  *
  34  * Debug messages and assertions
  35  *
  36  */
  37
  38 #ifndef __LIBCFS_DEBUG_H__
  39 #define __LIBCFS_DEBUG_H__
  40
  41 /*
  42  *  Debugging
  43  */
  44 extern unsigned int libcfs_subsystem_debug;
  45 extern unsigned int libcfs_stack;
  46 extern unsigned int libcfs_debug;
  47 extern unsigned int libcfs_printk;
  48 extern unsigned int libcfs_console_ratelimit;
  49 extern unsigned int libcfs_watchdog_ratelimit;
  50 extern unsigned int libcfs_console_max_delay;
  51 extern unsigned int libcfs_console_min_delay;
  52 extern unsigned int libcfs_console_backoff;
  53 extern unsigned int libcfs_debug_binary;
  54 extern char libcfs_debug_file_path_arr[PATH_MAX];
  55
  56 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
  57 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
  58
  59 /* Has there been an LBUG? */
  60 extern unsigned int libcfs_catastrophe;
  61 extern unsigned int libcfs_panic_on_lbug;
  62
  63 /**
  64  * Format for debug message headers
  65  */
  66 struct ptldebug_header {
  67         __u32 ph_len;
  68         __u32 ph_flags;
  69         __u32 ph_subsys;
  70         __u32 ph_mask;
  71         __u16 ph_cpu_id;
  72         __u16 ph_type;
  73         /* time_t overflow in 2106 */
  74         __u32 ph_sec;
  75         __u64 ph_usec;
  76         __u32 ph_stack;
  77         __u32 ph_pid;
  78         __u32 ph_extern_pid;
  79         __u32 ph_line_num;
  80 } __attribute__((packed));
  81
  82
  83 #define PH_FLAG_FIRST_RECORD 1
  84
  85 /* Debugging subsystems (32 bits, non-overlapping) */
  86 #define S_UNDEFINED     0x00000001
  87 #define S_MDC           0x00000002
  88 #define S_MDS           0x00000004
  89 #define S_OSC           0x00000008
  90 #define S_OST           0x00000010
  91 #define S_CLASS         0x00000020
  92 #define S_LOG           0x00000040
  93 #define S_LLITE         0x00000080
  94 #define S_RPC           0x00000100
  95 #define S_MGMT          0x00000200
  96 #define S_LNET          0x00000400
  97 #define S_LND           0x00000800 /* ALL LNDs */
  98 #define S_PINGER        0x00001000
  99 #define S_FILTER        0x00002000
 100 /* unused */
 101 #define S_ECHO          0x00008000
 102 #define S_LDLM          0x00010000
 103 #define S_LOV           0x00020000
 104 #define S_LQUOTA        0x00040000
 105 #define S_OSD           0x00080000
 106 #define S_LFSCK         0x00100000
 107 #define S_SNAPSHOT      0x00200000
 108 /* unused */
 109 #define S_LMV           0x00800000 /* b_new_cmd */
 110 /* unused */
 111 #define S_SEC           0x02000000 /* upcall cache */
 112 #define S_GSS           0x04000000 /* b_new_cmd */
 113 /* unused */
 114 #define S_MGC           0x10000000
 115 #define S_MGS           0x20000000
 116 #define S_FID           0x40000000 /* b_new_cmd */
 117 #define S_FLD           0x80000000 /* b_new_cmd */
 118
 119 #define LIBCFS_DEBUG_SUBSYS_NAMES {                                     \
 120         "undefined", "mdc", "mds", "osc", "ost", "class", "log",        \
 121         "llite", "rpc", "mgmt", "lnet", "lnd", "pinger", "filter", "",  \
 122         "echo", "ldlm", "lov", "lquota", "osd", "lfsck", "snapshot", "",\
 123         "lmv",  "", "sec", "gss", "", "mgc", "mgs", "fid", "fld", NULL }
 124
 125 /* Debugging masks (32 bits, non-overlapping) */
 126 #define D_TRACE         0x00000001 /* ENTRY/EXIT markers */
 127 #define D_INODE         0x00000002
 128 #define D_SUPER         0x00000004
 129 #define D_EXT2          0x00000008 /* anything from ext2_debug */
 130 #define D_MALLOC        0x00000010 /* print malloc, free information */
 131 #define D_CACHE         0x00000020 /* cache-related items */
 132 #define D_INFO          0x00000040 /* general information */
 133 #define D_IOCTL         0x00000080 /* ioctl related information */
 134 #define D_NETERROR      0x00000100 /* network errors */
 135 #define D_NET           0x00000200 /* network communications */
 136 #define D_WARNING       0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
 137 #define D_BUFFS         0x00000800
 138 #define D_OTHER         0x00001000
 139 #define D_DENTRY        0x00002000
 140 #define D_NETTRACE      0x00004000
 141 #define D_PAGE          0x00008000 /* bulk page handling */
 142 #define D_DLMTRACE      0x00010000
 143 #define D_ERROR         0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
 144 #define D_EMERG         0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
 145 #define D_HA            0x00080000 /* recovery and failover */
 146 #define D_RPCTRACE      0x00100000 /* for distributed debugging */
 147 #define D_VFSTRACE      0x00200000
 148 #define D_READA         0x00400000 /* read-ahead */
 149 #define D_MMAP          0x00800000
 150 #define D_CONFIG        0x01000000
 151 #define D_CONSOLE       0x02000000
 152 #define D_QUOTA         0x04000000
 153 #define D_SEC           0x08000000
 154 #define D_LFSCK         0x10000000 /* For both OI scrub and LFSCK */
 155 #define D_HSM           0x20000000
 156 #define D_SNAPSHOT      0x40000000 /* snapshot */
 157
 158 #define LIBCFS_DEBUG_MASKS_NAMES {                                      \
 159         "trace", "inode", "super", "ext2", "malloc", "cache", "info",   \
 160         "ioctl", "neterror", "net", "warning", "buffs", "other",        \
 161         "dentry", "nettrace", "page", "dlmtrace", "error", "emerg",     \
 162         "ha", "rpctrace", "vfstrace", "reada", "mmap", "config",        \
 163         "console", "quota", "sec", "lfsck", "hsm", "snapshot", NULL }
 164
 165 #define D_CANTMASK   (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
 166
 167 #ifndef DEBUG_SUBSYSTEM
 168 # define DEBUG_SUBSYSTEM S_UNDEFINED
 169 #endif
 170
 171 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600))         /* jiffies */
 172 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
 173 #define CDEBUG_DEFAULT_BACKOFF   2
 174 struct cfs_debug_limit_state {
 175         unsigned long   cdls_next;
 176         unsigned int    cdls_delay;
 177         int             cdls_count;
 178 };
 179
 180 struct libcfs_debug_msg_data {
 181         const char                      *msg_file;
 182         const char                      *msg_fn;
 183         int                              msg_subsys;
 184         int                              msg_line;
 185         int                              msg_mask;
 186         struct cfs_debug_limit_state    *msg_cdls;
 187 };
 188
 189 #define LIBCFS_DEBUG_MSG_DATA_INIT(data, mask, cdls)        \
 190 do {                                                        \
 191         (data)->msg_subsys = DEBUG_SUBSYSTEM;               \
 192         (data)->msg_file   = __FILE__;                      \
 193         (data)->msg_fn     = __FUNCTION__;                  \
 194         (data)->msg_line   = __LINE__;                      \
 195         (data)->msg_cdls   = (cdls);                        \
 196         (data)->msg_mask   = (mask);                        \
 197 } while (0)
 198
 199 #define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls)    \
 200         static struct libcfs_debug_msg_data dataname = {    \
 201                .msg_subsys = DEBUG_SUBSYSTEM,               \
 202                .msg_file   = __FILE__,                      \
 203                .msg_fn     = __FUNCTION__,                  \
 204                .msg_line   = __LINE__,                      \
 205                .msg_cdls   = (cdls)         };              \
 206         dataname.msg_mask   = (mask);
 207
 208 #ifdef __KERNEL__
 209
 210 # ifdef CDEBUG_ENABLED
 211
 212 /**
 213  * Filters out logging messages based on mask and subsystem.
 214  */
 215 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
 216 {
 217         return mask & D_CANTMASK ||
 218                 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
 219 }
 220
 221 #  define __CDEBUG(cdls, mask, format, ...)                             \
 222 do {                                                                    \
 223         static struct libcfs_debug_msg_data msgdata;                    \
 224                                                                         \
 225         CFS_CHECK_STACK(&msgdata, mask, cdls);                          \
 226                                                                         \
 227         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
 228                 LIBCFS_DEBUG_MSG_DATA_INIT(&msgdata, mask, cdls);       \
 229                 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__);     \
 230         }                                                               \
 231 } while (0)
 232
 233 #  define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
 234
 235 #  define CDEBUG_LIMIT(mask, format, ...)                               \
 236 do {                                                                    \
 237         static struct cfs_debug_limit_state cdls;                       \
 238                                                                         \
 239         __CDEBUG(&cdls, mask, format, ## __VA_ARGS__);                  \
 240 } while (0)
 241
 242 # else /* !CDEBUG_ENABLED */
 243 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
 244 {
 245         return 0;
 246 }
 247 #  define CDEBUG(mask, format, ...) (void)(0)
 248 #  define CDEBUG_LIMIT(mask, format, ...) (void)(0)
 249 #  warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
 250 # endif /* CDEBUG_ENABLED */
 251
 252 #else /* !__KERNEL__ */
 253 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
 254 {
 255         return 0;
 256 }
 257 # define CDEBUG(mask, format, ...)                                      \
 258 do {                                                                    \
 259         if (((mask) & D_CANTMASK) != 0)                                 \
 260                 fprintf(stderr, "(%s:%d:%s()) " format,                 \
 261                         __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__);\
 262 } while (0)
 263
 264 # define CDEBUG_LIMIT CDEBUG
 265
 266 #endif /* __KERNEL__ */
 267
 268 /*
 269  * Lustre Error Checksum: calculates checksum
 270  * of Hex number by XORing each bit.
 271  */
 272 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
 273                            ((hexnum) >> 8 & 0xf))
 274
 275 #define CWARN(format, ...)          CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
 276 #define CERROR(format, ...)         CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
 277 #define CNETERR(format, a...)       CDEBUG_LIMIT(D_NETERROR, format, ## a)
 278 #define CEMERG(format, ...)         CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
 279
 280 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
 281 #define LCONSOLE_INFO(format, ...)  CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
 282 #define LCONSOLE_WARN(format, ...)  CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
 283 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
 284                            "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
 285 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
 286
 287 #define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
 288
 289 #if defined(CDEBUG_ENTRY_EXIT) && defined(__KERNEL__)
 290
 291 void libcfs_log_goto(struct libcfs_debug_msg_data *goto_data,
 292                      const char *label, long rc);
 293
 294 # define GOTO(label, rc)                                                \
 295 do {                                                                    \
 296         if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) {                \
 297                 LIBCFS_DEBUG_MSG_DATA_DECL(_goto_data, D_TRACE, NULL);  \
 298                 libcfs_log_goto(&_goto_data, #label, (long)(rc));       \
 299         } else {                                                        \
 300                 (void)(rc);                                             \
 301         }                                                               \
 302                                                                         \
 303         goto label;                                                     \
 304 } while (0)
 305
 306
 307 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
 308 # if BITS_PER_LONG > 32
 309 #  define RETURN(rc)                                                    \
 310 do {                                                                    \
 311         if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) {                \
 312                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL);     \
 313                 return (typeof(rc))libcfs_log_return(&msgdata,          \
 314                                                      (long)(rc));       \
 315         }                                                               \
 316                                                                         \
 317         return (rc);                                                    \
 318 } while (0)
 319 # else /* BITS_PER_LONG == 32 */
 320 /* We need an on-stack variable, because we cannot case a 32-bit pointer
 321  * directly to (long long) without generating a complier warning/error, yet
 322  * casting directly to (long) will truncate 64-bit return values. The log
 323  * values will print as 32-bit values, but they always have been. LU-1436
 324  */
 325 #  define RETURN(rc)                                                    \
 326 do {                                                                    \
 327         if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) {                \
 328                 typeof(rc) __rc = (rc);                                 \
 329                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL);     \
 330                 libcfs_log_return(&msgdata, (long)__rc);                \
 331                 return __rc;                                            \
 332         }                                                               \
 333                                                                         \
 334         return (rc);                                                    \
 335 } while (0)
 336
 337 # endif /* BITS_PER_LONG > 32 */
 338
 339 # define ENTRY  CDEBUG(D_TRACE, "Process entered\n")
 340 # define EXIT   CDEBUG(D_TRACE, "Process leaving\n")
 341
 342 #else /* !CDEBUG_ENTRY_EXIT || !__KERNEL__ */
 343
 344 # define GOTO(label, rc)                                                \
 345         do {                                                            \
 346                 ((void)(rc));                                           \
 347                 goto label;                                             \
 348         } while (0)
 349
 350 # define RETURN(rc) return (rc)
 351 # define ENTRY  do { } while (0)
 352 # define EXIT   do { } while (0)
 353
 354 #endif /* CDEBUG_ENTRY_EXIT && __KERNEL__ */
 355
 356 #define RETURN_EXIT                                                     \
 357 do {                                                                    \
 358         EXIT;                                                           \
 359         return;                                                         \
 360 } while (0)
 361
 362 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
 363                             const char *format1, ...)
 364         __attribute__ ((format (printf, 2, 3)));
 365
 366 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
 367                               const char *format1,
 368                               va_list args, const char *format2, ...)
 369         __attribute__ ((format (printf, 4, 5)));
 370
 371 #ifdef __KERNEL__
 372 /* other external symbols that tracefile provides: */
 373 extern int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
 374                                    const char __user *usr_buffer,
 375                                    int usr_buffer_nob);
 376 extern int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
 377                                     const char *knl_buffer, char *append);
 378 #endif /* __KERNEL__ */
 379
 380 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
 381
 382 #endif  /* __LIBCFS_DEBUG_H__ */