4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * libcfs/include/libcfs/libcfs_debug.h
36 * Debug messages and assertions
40 #ifndef __LIBCFS_DEBUG_H__
41 #define __LIBCFS_DEBUG_H__
46 extern unsigned int libcfs_subsystem_debug;
47 extern unsigned int libcfs_stack;
48 extern unsigned int libcfs_debug;
49 extern unsigned int libcfs_printk;
50 extern unsigned int libcfs_console_ratelimit;
51 extern unsigned int libcfs_watchdog_ratelimit;
52 extern unsigned int libcfs_console_max_delay;
53 extern unsigned int libcfs_console_min_delay;
54 extern unsigned int libcfs_console_backoff;
55 extern unsigned int libcfs_debug_binary;
56 extern char libcfs_debug_file_path_arr[PATH_MAX];
58 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
59 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
61 /* Has there been an LBUG? */
62 extern unsigned int libcfs_catastrophe;
63 extern unsigned int libcfs_panic_on_lbug;
66 * Format for debug message headers
68 struct ptldebug_header {
81 } __attribute__((packed));
84 #define PH_FLAG_FIRST_RECORD 1
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
103 #define S_ECHO 0x00008000
104 #define S_LDLM 0x00010000
105 #define S_LOV 0x00020000
106 #define S_LQUOTA 0x00040000
111 #define S_LMV 0x00800000 /* b_new_cmd */
113 #define S_SEC 0x02000000 /* upcall cache */
114 #define S_GSS 0x04000000 /* b_new_cmd */
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 */
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 */
154 #define D_HSM D_TRACE
156 #define D_CANTMASK (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
158 #ifndef DEBUG_SUBSYSTEM
159 # define DEBUG_SUBSYSTEM S_UNDEFINED
162 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
163 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
164 #define CDEBUG_DEFAULT_BACKOFF 2
166 cfs_time_t cdls_next;
167 unsigned int cdls_delay;
169 } cfs_debug_limit_state_t;
171 struct libcfs_debug_msg_data {
172 const char *msg_file;
177 cfs_debug_limit_state_t *msg_cdls;
180 #define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls) \
181 static struct libcfs_debug_msg_data dataname = { \
182 .msg_subsys = DEBUG_SUBSYSTEM, \
183 .msg_file = __FILE__, \
184 .msg_fn = __FUNCTION__, \
185 .msg_line = __LINE__, \
186 .msg_cdls = (cdls) }; \
187 dataname.msg_mask = (mask);
189 #if defined(__KERNEL__) || (defined(__arch_lib__) && !defined(LUSTRE_UTILS))
191 #ifdef CDEBUG_ENABLED
194 * Filters out logging messages based on mask and subsystem.
196 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
198 return mask & D_CANTMASK ||
199 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
202 #define __CDEBUG(cdls, mask, format, ...) \
204 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, cdls); \
206 CFS_CHECK_STACK(&msgdata, mask, cdls); \
208 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) \
209 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
212 #define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
214 #define CDEBUG_LIMIT(mask, format, ...) \
216 static cfs_debug_limit_state_t cdls; \
218 __CDEBUG(&cdls, mask, format, ## __VA_ARGS__);\
221 #else /* !CDEBUG_ENABLED */
222 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
226 #define CDEBUG(mask, format, ...) (void)(0)
227 #define CDEBUG_LIMIT(mask, format, ...) (void)(0)
228 #warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
231 #else /* !__KERNEL__ && (!__arch_lib__ || LUSTRE_UTILS) */
232 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
236 #define CDEBUG(mask, format, ...) \
238 if (((mask) & D_CANTMASK) != 0) \
239 fprintf(stderr, "(%s:%d:%s()) " format, \
240 __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__);\
243 #define CDEBUG_LIMIT CDEBUG
245 #endif /* !__KERNEL__ ... */
248 #define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
249 #define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
250 #define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
251 #define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
253 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
254 #define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
255 #define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
256 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
257 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
258 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
260 #define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
262 #ifdef CDEBUG_ENABLED
264 void libcfs_log_goto(struct libcfs_debug_msg_data *, const char *, long_ptr_t);
265 #define GOTO(label, rc) \
267 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
268 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
269 libcfs_log_goto(&msgdata, #label, (long_ptr_t)(rc)); \
276 #define GOTO(label, rc) do { ((void)(rc)); goto label; } while (0)
279 #ifdef CDEBUG_ENTRY_EXIT
282 * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
283 * there will be a warning in osx.
285 #if defined(__GNUC__)
287 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
291 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
292 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
293 return (typeof(rc))libcfs_log_return(&msgdata, \
299 #elif defined(_MSC_VER)
302 CDEBUG(D_TRACE, "Process leaving.\n"); \
307 # error "Unkown compiler"
308 #endif /* __GNUC__ */
313 CDEBUG(D_TRACE, "Process entered\n"); \
318 CDEBUG(D_TRACE, "Process leaving\n"); \
321 #else /* !CDEBUG_ENTRY_EXIT */
323 #define RETURN(rc) return (rc)
324 #define ENTRY do { } while (0)
325 #define EXIT do { } while (0)
327 #endif /* !CDEBUG_ENTRY_EXIT */
329 #define RETURN_EXIT \
335 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
336 const char *format1, ...)
337 __attribute__ ((format (printf, 2, 3)));
339 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
341 va_list args, const char *format2, ...)
342 __attribute__ ((format (printf, 4, 5)));
344 /* one more external symbol that tracefile provides: */
345 extern int cfs_trace_copyout_string(char *usr_buffer, int usr_buffer_nob,
346 const char *knl_buffer, char *append);
349 #if defined(HAVE_BGL_SUPPORT)
350 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/bgl/ion/tmp/lustre-log"
351 #elif defined(__arch_um__)
352 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/r/tmp/lustre-log"
353 #elif defined(__WINNT__)
354 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "\\SystemRoot\\temp\\lustre-log"
356 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
359 #endif /* __LIBCFS_DEBUG_H__ */