drivers/staging/lustre/include/linux/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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  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 unsigned int libcfs_watchdog_ratelimit;
  54 extern unsigned int libcfs_console_max_delay;
  55 extern unsigned int libcfs_console_min_delay;
  56 extern unsigned int libcfs_console_backoff;
  57 extern unsigned int libcfs_debug_binary;
  58 extern char libcfs_debug_file_path_arr[PATH_MAX];
  59
  60 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
  61 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
  62
  63 /* Has there been an LBUG? */
  64 extern unsigned int libcfs_catastrophe;
  65 extern unsigned int libcfs_panic_on_lbug;
  66
  67 /**
  68  * Format for debug message headers
  69  */
  70 struct ptldebug_header {
  71         __u32 ph_len;
  72         __u32 ph_flags;
  73         __u32 ph_subsys;
  74         __u32 ph_mask;
  75         __u16 ph_cpu_id;
  76         __u16 ph_type;
  77         __u32 ph_sec;
  78         __u64 ph_usec;
  79         __u32 ph_stack;
  80         __u32 ph_pid;
  81         __u32 ph_extern_pid;
  82         __u32 ph_line_num;
  83 } __attribute__((packed));
  84
  85
  86 #define PH_FLAG_FIRST_RECORD 1
  87
  88 /* Debugging subsystems (32 bits, non-overlapping) */
  89 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
  90 #define S_UNDEFINED   0x00000001
  91 #define S_MDC    0x00000002
  92 #define S_MDS    0x00000004
  93 #define S_OSC    0x00000008
  94 #define S_OST    0x00000010
  95 #define S_CLASS       0x00000020
  96 #define S_LOG    0x00000040
  97 #define S_LLITE       0x00000080
  98 #define S_RPC    0x00000100
  99 #define S_MGMT  0x00000200
 100 #define S_LNET  0x00000400
 101 #define S_LND    0x00000800 /* ALL LNDs */
 102 #define S_PINGER      0x00001000
 103 #define S_FILTER      0x00002000
 104 /* unused */
 105 #define S_ECHO  0x00008000
 106 #define S_LDLM  0x00010000
 107 #define S_LOV    0x00020000
 108 #define S_LQUOTA      0x00040000
 109 #define S_OSD           0x00080000
 110 /* unused */
 111 /* unused */
 112 /* unused */
 113 #define S_LMV    0x00800000 /* b_new_cmd */
 114 /* unused */
 115 #define S_SEC    0x02000000 /* upcall cache */
 116 #define S_GSS    0x04000000 /* b_new_cmd */
 117 /* unused */
 118 #define S_MGC    0x10000000
 119 #define S_MGS    0x20000000
 120 #define S_FID    0x40000000 /* b_new_cmd */
 121 #define S_FLD    0x80000000 /* b_new_cmd */
 122 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
 123
 124 /* Debugging masks (32 bits, non-overlapping) */
 125 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
 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 /* keep these in sync with lnet/{utils,libcfs}/debug.c */
 156
 157 #define D_HSM    D_TRACE
 158
 159 #define D_CANTMASK   (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
 160
 161 #ifndef DEBUG_SUBSYSTEM
 162 # define DEBUG_SUBSYSTEM S_UNDEFINED
 163 #endif
 164
 165 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600))         /* jiffies */
 166 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
 167 #define CDEBUG_DEFAULT_BACKOFF   2
 168 typedef struct {
 169         cfs_time_t      cdls_next;
 170         unsigned int    cdls_delay;
 171         int          cdls_count;
 172 } cfs_debug_limit_state_t;
 173
 174 struct libcfs_debug_msg_data {
 175         const char             *msg_file;
 176         const char             *msg_fn;
 177         int                   msg_subsys;
 178         int                   msg_line;
 179         int                   msg_mask;
 180         cfs_debug_limit_state_t  *msg_cdls;
 181 };
 182
 183 #define LIBCFS_DEBUG_MSG_DATA_INIT(data, mask, cdls)    \
 184 do {                                                    \
 185         (data)->msg_subsys = DEBUG_SUBSYSTEM;          \
 186         (data)->msg_file   = __FILE__;                \
 187         (data)->msg_fn     = __FUNCTION__;                \
 188         (data)->msg_line   = __LINE__;                \
 189         (data)->msg_cdls   = (cdls);                    \
 190         (data)->msg_mask   = (mask);                    \
 191 } while (0)
 192
 193 #define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls)    \
 194         static struct libcfs_debug_msg_data dataname = {    \
 195                .msg_subsys = DEBUG_SUBSYSTEM,          \
 196                .msg_file   = __FILE__,                \
 197                .msg_fn     = __FUNCTION__,                \
 198                .msg_line   = __LINE__,                \
 199                .msg_cdls   = (cdls)      };           \
 200         dataname.msg_mask   = (mask);
 201
 202
 203
 204 /**
 205  * Filters out logging messages based on mask and subsystem.
 206  */
 207 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
 208 {
 209         return mask & D_CANTMASK ||
 210                 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
 211 }
 212
 213 #define __CDEBUG(cdls, mask, format, ...)                              \
 214 do {                                                                \
 215         static struct libcfs_debug_msg_data msgdata;                \
 216                                                                         \
 217         CFS_CHECK_STACK(&msgdata, mask, cdls);                    \
 218                                                                         \
 219         if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {              \
 220                 LIBCFS_DEBUG_MSG_DATA_INIT(&msgdata, mask, cdls);       \
 221                 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__);     \
 222         }                                                              \
 223 } while (0)
 224
 225 #define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
 226
 227 #define CDEBUG_LIMIT(mask, format, ...)  \
 228 do {                                        \
 229         static cfs_debug_limit_state_t cdls;    \
 230                                                 \
 231         __CDEBUG(&cdls, mask, format, ## __VA_ARGS__);\
 232 } while (0)
 233
 234
 235
 236
 237 #define CWARN(format, ...)        CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
 238 #define CERROR(format, ...)      CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
 239 #define CNETERR(format, a...)       CDEBUG_LIMIT(D_NETERROR, format, ## a)
 240 #define CEMERG(format, ...)      CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
 241
 242 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
 243 #define LCONSOLE_INFO(format, ...)  CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
 244 #define LCONSOLE_WARN(format, ...)  CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
 245 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
 246                            "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
 247 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
 248
 249 #define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
 250
 251
 252 void libcfs_log_goto(struct libcfs_debug_msg_data *, const char *, long_ptr_t);
 253 #define GOTO(label, rc)                                          \
 254 do {                                                                \
 255         if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) {                \
 256                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL);     \
 257                 libcfs_log_goto(&msgdata, #label, (long_ptr_t)(rc));    \
 258         } else {                                                        \
 259                 (void)(rc);                                          \
 260         }                                                              \
 261         goto label;                                                  \
 262 } while (0)
 263
 264
 265 /*
 266  * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
 267  * there will be a warning in osx.
 268  */
 269 #if defined(__GNUC__)
 270
 271 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
 272 #if BITS_PER_LONG > 32
 273 #define RETURN(rc)                                                      \
 274 do {                                                                    \
 275         EXIT_NESTING;                                                   \
 276         if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) {                \
 277                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL);     \
 278                 return (typeof(rc))libcfs_log_return(&msgdata,          \
 279                                                      (long)(rc));       \
 280         }                                                               \
 281                                                                         \
 282         return (rc);                                                    \
 283 } while (0)
 284 #else /* BITS_PER_LONG == 32 */
 285 /* We need an on-stack variable, because we cannot case a 32-bit pointer
 286  * directly to (long long) without generating a complier warning/error, yet
 287  * casting directly to (long) will truncate 64-bit return values. The log
 288  * values will print as 32-bit values, but they always have been. LU-1436
 289  */
 290 #define RETURN(rc)                                                      \
 291 do {                                                                    \
 292         EXIT_NESTING;                                                   \
 293         if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) {                \
 294                 typeof(rc) __rc = (rc);                                 \
 295                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL);     \
 296                 libcfs_log_return(&msgdata, (long_ptr_t)__rc);          \
 297                 return __rc;                                            \
 298         }                                                               \
 299                                                                         \
 300         return (rc);                                                    \
 301 } while (0)
 302 #endif /* BITS_PER_LONG > 32 */
 303
 304 #elif defined(_MSC_VER)
 305 #define RETURN(rc)                                                    \
 306 do {                                                                \
 307         CDEBUG(D_TRACE, "Process leaving.\n");                    \
 308         EXIT_NESTING;                                              \
 309         return (rc);                                                \
 310 } while (0)
 311 #else
 312 # error "Unkown compiler"
 313 #endif /* __GNUC__ */
 314
 315 #define ENTRY                                                      \
 316 ENTRY_NESTING;                                                    \
 317 do {                                                                \
 318         CDEBUG(D_TRACE, "Process entered\n");                      \
 319 } while (0)
 320
 321 #define EXIT                                                        \
 322 do {                                                                \
 323         CDEBUG(D_TRACE, "Process leaving\n");                      \
 324         EXIT_NESTING;                                              \
 325 } while(0)
 326
 327 #define RETURN_EXIT                                                     \
 328 do {                                                                    \
 329         EXIT;                                                           \
 330         return;                                                         \
 331 } while (0)
 332
 333 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
 334                             const char *format1, ...)
 335         __attribute__ ((format (printf, 2, 3)));
 336
 337 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
 338                               const char *format1,
 339                               va_list args, const char *format2, ...)
 340         __attribute__ ((format (printf, 4, 5)));
 341
 342 /* other external symbols that tracefile provides: */
 343 extern int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
 344                                    const char *usr_buffer, int usr_buffer_nob);
 345 extern int cfs_trace_copyout_string(char *usr_buffer, int usr_buffer_nob,
 346                                     const char *knl_buffer, char *append);
 347
 348 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
 349
 350 #endif  /* __LIBCFS_DEBUG_H__ */