1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/include/libcfs/libcfs_debug.h
38 * Debug messages and assertions
42 #ifndef __LIBCFS_DEBUG_H__
43 #define __LIBCFS_DEBUG_H__
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];
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);
63 /* Has there been an LBUG? */
64 extern unsigned int libcfs_catastrophe;
65 extern unsigned int libcfs_panic_on_lbug;
68 * Format for debug message headers
70 struct ptldebug_header {
83 } __attribute__((packed));
86 #define PH_FLAG_FIRST_RECORD 1
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
105 #define S_ECHO 0x00008000
106 #define S_LDLM 0x00010000
107 #define S_LOV 0x00020000
108 #define S_LQUOTA 0x00040000
113 #define S_LMV 0x00800000 /* b_new_cmd */
115 #define S_SEC 0x02000000 /* upcall cache */
116 #define S_GSS 0x04000000 /* b_new_cmd */
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 */
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 /* keep these in sync with lnet/{utils,libcfs}/debug.c */
156 #define D_HSM D_TRACE
158 #define D_CANTMASK (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
160 #ifndef DEBUG_SUBSYSTEM
161 # define DEBUG_SUBSYSTEM S_UNDEFINED
164 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
165 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
166 #define CDEBUG_DEFAULT_BACKOFF 2
168 cfs_time_t cdls_next;
169 unsigned int cdls_delay;
171 } cfs_debug_limit_state_t;
173 struct libcfs_debug_msg_data {
174 const char *msg_file;
179 cfs_debug_limit_state_t *msg_cdls;
182 #define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls) \
183 static struct libcfs_debug_msg_data dataname = { \
184 .msg_subsys = DEBUG_SUBSYSTEM, \
185 .msg_file = __FILE__, \
186 .msg_fn = __FUNCTION__, \
187 .msg_line = __LINE__, \
188 .msg_cdls = (cdls) }; \
189 dataname.msg_mask = (mask);
191 #if defined(__KERNEL__) || (defined(__arch_lib__) && !defined(LUSTRE_UTILS))
193 #ifdef CDEBUG_ENABLED
196 * Filters out logging messages based on mask and subsystem.
198 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
200 return mask & D_CANTMASK ||
201 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
204 #define __CDEBUG(cdls, mask, format, ...) \
206 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, cdls); \
208 CFS_CHECK_STACK(&msgdata, mask, cdls); \
210 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) \
211 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
214 #define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
216 #define CDEBUG_LIMIT(mask, format, ...) \
218 static cfs_debug_limit_state_t cdls; \
220 __CDEBUG(&cdls, mask, format, ## __VA_ARGS__);\
223 #else /* !CDEBUG_ENABLED */
224 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
228 #define CDEBUG(mask, format, ...) (void)(0)
229 #define CDEBUG_LIMIT(mask, format, ...) (void)(0)
230 #warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
233 #else /* !__KERNEL__ && (!__arch_lib__ || LUSTRE_UTILS) */
234 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
238 #define CDEBUG(mask, format, ...) \
240 if (((mask) & D_CANTMASK) != 0) \
241 fprintf(stderr, "(%s:%d:%s()) " format, \
242 __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__);\
245 #define CDEBUG_LIMIT CDEBUG
247 #endif /* !__KERNEL__ ... */
250 #define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
251 #define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
252 #define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
253 #define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
255 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
256 #define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
257 #define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
258 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
259 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
260 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
262 #define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
264 #ifdef CDEBUG_ENABLED
266 void libcfs_log_goto(struct libcfs_debug_msg_data *, const char *, long_ptr_t);
267 #define GOTO(label, rc) \
269 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
270 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
271 libcfs_log_goto(&msgdata, #label, (long_ptr_t)(rc)); \
278 #define GOTO(label, rc) do { ((void)(rc)); goto label; } while (0)
281 #ifdef CDEBUG_ENTRY_EXIT
284 * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
285 * there will be a warning in osx.
287 #if defined(__GNUC__)
289 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
293 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
294 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
295 return (typeof(rc))libcfs_log_return(&msgdata, \
301 #elif defined(_MSC_VER)
304 CDEBUG(D_TRACE, "Process leaving.\n"); \
309 # error "Unkown compiler"
310 #endif /* __GNUC__ */
315 CDEBUG(D_TRACE, "Process entered\n"); \
320 CDEBUG(D_TRACE, "Process leaving\n"); \
323 #else /* !CDEBUG_ENTRY_EXIT */
325 #define RETURN(rc) return (rc)
326 #define ENTRY do { } while (0)
327 #define EXIT do { } while (0)
329 #endif /* !CDEBUG_ENTRY_EXIT */
331 #define RETURN_EXIT \
337 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
338 const char *format1, ...)
339 __attribute__ ((format (printf, 2, 3)));
341 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
343 va_list args, const char *format2, ...)
344 __attribute__ ((format (printf, 4, 5)));
346 /* one more external symbol that tracefile provides: */
347 extern int cfs_trace_copyout_string(char *usr_buffer, int usr_buffer_nob,
348 const char *knl_buffer, char *append);
351 #if defined(HAVE_BGL_SUPPORT)
352 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/bgl/ion/tmp/lustre-log"
353 #elif defined(__arch_um__)
354 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/r/tmp/lustre-log"
355 #elif defined(__WINNT__)
356 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "\\SystemRoot\\temp\\lustre-log"
358 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
361 #endif /* __LIBCFS_DEBUG_H__ */