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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2014, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * libcfs/include/libcfs/libcfs_debug.h
34 * Debug messages and assertions
38 #ifndef __LIBCFS_DEBUG_H__
39 #define __LIBCFS_DEBUG_H__
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];
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);
59 /* Has there been an LBUG? */
60 extern unsigned int libcfs_catastrophe;
61 extern unsigned int libcfs_panic_on_lbug;
64 * Format for debug message headers
66 struct ptldebug_header {
79 } __attribute__((packed));
82 #define PH_FLAG_FIRST_RECORD 1
84 /* Debugging subsystems (32 bits, non-overlapping) */
85 #define S_UNDEFINED 0x00000001
86 #define S_MDC 0x00000002
87 #define S_MDS 0x00000004
88 #define S_OSC 0x00000008
89 #define S_OST 0x00000010
90 #define S_CLASS 0x00000020
91 #define S_LOG 0x00000040
92 #define S_LLITE 0x00000080
93 #define S_RPC 0x00000100
94 #define S_MGMT 0x00000200
95 #define S_LNET 0x00000400
96 #define S_LND 0x00000800 /* ALL LNDs */
97 #define S_PINGER 0x00001000
98 #define S_FILTER 0x00002000
100 #define S_ECHO 0x00008000
101 #define S_LDLM 0x00010000
102 #define S_LOV 0x00020000
103 #define S_LQUOTA 0x00040000
104 #define S_OSD 0x00080000
105 #define S_LFSCK 0x00100000
108 #define S_LMV 0x00800000 /* b_new_cmd */
110 #define S_SEC 0x02000000 /* upcall cache */
111 #define S_GSS 0x04000000 /* b_new_cmd */
113 #define S_MGC 0x10000000
114 #define S_MGS 0x20000000
115 #define S_FID 0x40000000 /* b_new_cmd */
116 #define S_FLD 0x80000000 /* b_new_cmd */
118 #define LIBCFS_DEBUG_SUBSYS_NAMES { \
119 "undefined", "mdc", "mds", "osc", "ost", "class", "log", \
120 "llite", "rpc", "mgmt", "lnet", "lnd", "pinger", "filter", "", \
121 "echo", "ldlm", "lov", "lquota", "osd", "lfsck", "", "", "lmv", \
122 "", "sec", "gss", "", "mgc", "mgs", "fid", "fld", NULL }
124 /* Debugging masks (32 bits, non-overlapping) */
125 #define D_TRACE 0x00000001 /* ENTRY/EXIT markers */
126 #define D_INODE 0x00000002
127 #define D_SUPER 0x00000004
128 #define D_EXT2 0x00000008 /* anything from ext2_debug */
129 #define D_MALLOC 0x00000010 /* print malloc, free information */
130 #define D_CACHE 0x00000020 /* cache-related items */
131 #define D_INFO 0x00000040 /* general information */
132 #define D_IOCTL 0x00000080 /* ioctl related information */
133 #define D_NETERROR 0x00000100 /* network errors */
134 #define D_NET 0x00000200 /* network communications */
135 #define D_WARNING 0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
136 #define D_BUFFS 0x00000800
137 #define D_OTHER 0x00001000
138 #define D_DENTRY 0x00002000
139 #define D_NETTRACE 0x00004000
140 #define D_PAGE 0x00008000 /* bulk page handling */
141 #define D_DLMTRACE 0x00010000
142 #define D_ERROR 0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
143 #define D_EMERG 0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
144 #define D_HA 0x00080000 /* recovery and failover */
145 #define D_RPCTRACE 0x00100000 /* for distributed debugging */
146 #define D_VFSTRACE 0x00200000
147 #define D_READA 0x00400000 /* read-ahead */
148 #define D_MMAP 0x00800000
149 #define D_CONFIG 0x01000000
150 #define D_CONSOLE 0x02000000
151 #define D_QUOTA 0x04000000
152 #define D_SEC 0x08000000
153 #define D_LFSCK 0x10000000 /* For both OI scrub and LFSCK */
154 #define D_HSM 0x20000000
156 #define LIBCFS_DEBUG_MASKS_NAMES { \
157 "trace", "inode", "super", "ext2", "malloc", "cache", "info", \
158 "ioctl", "neterror", "net", "warning", "buffs", "other", \
159 "dentry", "nettrace", "page", "dlmtrace", "error", "emerg", \
160 "ha", "rpctrace", "vfstrace", "reada", "mmap", "config", \
161 "console", "quota", "sec", "lfsck", "hsm", NULL }
163 #define D_CANTMASK (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
165 #ifndef DEBUG_SUBSYSTEM
166 # define DEBUG_SUBSYSTEM S_UNDEFINED
169 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
170 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
171 #define CDEBUG_DEFAULT_BACKOFF 2
172 struct cfs_debug_limit_state {
173 unsigned long cdls_next;
174 unsigned int cdls_delay;
178 struct libcfs_debug_msg_data {
179 const char *msg_file;
184 struct cfs_debug_limit_state *msg_cdls;
187 #define LIBCFS_DEBUG_MSG_DATA_INIT(data, mask, cdls) \
189 (data)->msg_subsys = DEBUG_SUBSYSTEM; \
190 (data)->msg_file = __FILE__; \
191 (data)->msg_fn = __FUNCTION__; \
192 (data)->msg_line = __LINE__; \
193 (data)->msg_cdls = (cdls); \
194 (data)->msg_mask = (mask); \
197 #define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls) \
198 static struct libcfs_debug_msg_data dataname = { \
199 .msg_subsys = DEBUG_SUBSYSTEM, \
200 .msg_file = __FILE__, \
201 .msg_fn = __FUNCTION__, \
202 .msg_line = __LINE__, \
203 .msg_cdls = (cdls) }; \
204 dataname.msg_mask = (mask);
208 # ifdef CDEBUG_ENABLED
211 * Filters out logging messages based on mask and subsystem.
213 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
215 return mask & D_CANTMASK ||
216 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
219 # define __CDEBUG(cdls, mask, format, ...) \
221 static struct libcfs_debug_msg_data msgdata; \
223 CFS_CHECK_STACK(&msgdata, mask, cdls); \
225 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
226 LIBCFS_DEBUG_MSG_DATA_INIT(&msgdata, mask, cdls); \
227 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
231 # define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
233 # define CDEBUG_LIMIT(mask, format, ...) \
235 static struct cfs_debug_limit_state cdls; \
237 __CDEBUG(&cdls, mask, format, ## __VA_ARGS__); \
240 # else /* !CDEBUG_ENABLED */
241 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
245 # define CDEBUG(mask, format, ...) (void)(0)
246 # define CDEBUG_LIMIT(mask, format, ...) (void)(0)
247 # warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
248 # endif /* CDEBUG_ENABLED */
250 #else /* !__KERNEL__ */
251 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
255 # define CDEBUG(mask, format, ...) \
257 if (((mask) & D_CANTMASK) != 0) \
258 fprintf(stderr, "(%s:%d:%s()) " format, \
259 __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__);\
262 # define CDEBUG_LIMIT CDEBUG
264 #endif /* __KERNEL__ */
267 * Lustre Error Checksum: calculates checksum
268 * of Hex number by XORing each bit.
270 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
271 ((hexnum) >> 8 & 0xf))
273 #define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
274 #define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
275 #define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
276 #define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
278 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
279 #define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
280 #define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
281 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
282 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
283 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
285 #define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
287 #if defined(CDEBUG_ENTRY_EXIT) && defined(__KERNEL__)
289 void libcfs_log_goto(struct libcfs_debug_msg_data *goto_data,
290 const char *label, long rc);
292 # define GOTO(label, rc) \
294 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
295 LIBCFS_DEBUG_MSG_DATA_DECL(_goto_data, D_TRACE, NULL); \
296 libcfs_log_goto(&_goto_data, #label, (long)(rc)); \
305 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
306 # if BITS_PER_LONG > 32
307 # define RETURN(rc) \
309 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
310 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
311 return (typeof(rc))libcfs_log_return(&msgdata, \
317 # else /* BITS_PER_LONG == 32 */
318 /* We need an on-stack variable, because we cannot case a 32-bit pointer
319 * directly to (long long) without generating a complier warning/error, yet
320 * casting directly to (long) will truncate 64-bit return values. The log
321 * values will print as 32-bit values, but they always have been. LU-1436
323 # define RETURN(rc) \
325 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
326 typeof(rc) __rc = (rc); \
327 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
328 libcfs_log_return(&msgdata, (long)__rc); \
335 # endif /* BITS_PER_LONG > 32 */
337 # define ENTRY CDEBUG(D_TRACE, "Process entered\n")
338 # define EXIT CDEBUG(D_TRACE, "Process leaving\n")
340 #else /* !CDEBUG_ENTRY_EXIT || !__KERNEL__ */
342 # define GOTO(label, rc) \
348 # define RETURN(rc) return (rc)
349 # define ENTRY do { } while (0)
350 # define EXIT do { } while (0)
352 #endif /* CDEBUG_ENTRY_EXIT && __KERNEL__ */
354 #define RETURN_EXIT \
360 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
361 const char *format1, ...)
362 __attribute__ ((format (printf, 2, 3)));
364 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
366 va_list args, const char *format2, ...)
367 __attribute__ ((format (printf, 4, 5)));
370 /* other external symbols that tracefile provides: */
371 extern int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
372 const char __user *usr_buffer,
374 extern int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
375 const char *knl_buffer, char *append);
376 #endif /* __KERNEL__ */
378 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
380 #endif /* __LIBCFS_DEBUG_H__ */