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, 2017, 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__
41 #include <uapi/linux/lnet/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;
65 #ifndef DEBUG_SUBSYSTEM
66 # define DEBUG_SUBSYSTEM S_UNDEFINED
69 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
70 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
71 #define CDEBUG_DEFAULT_BACKOFF 2
72 struct cfs_debug_limit_state {
73 unsigned long cdls_next;
74 unsigned int cdls_delay;
78 struct libcfs_debug_msg_data {
84 struct cfs_debug_limit_state *msg_cdls;
87 #define LIBCFS_DEBUG_MSG_DATA_INIT(data, mask, cdls) \
89 (data)->msg_subsys = DEBUG_SUBSYSTEM; \
90 (data)->msg_file = __FILE__; \
91 (data)->msg_fn = __FUNCTION__; \
92 (data)->msg_line = __LINE__; \
93 (data)->msg_cdls = (cdls); \
94 (data)->msg_mask = (mask); \
97 #define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls) \
98 static struct libcfs_debug_msg_data dataname = { \
99 .msg_subsys = DEBUG_SUBSYSTEM, \
100 .msg_file = __FILE__, \
101 .msg_fn = __FUNCTION__, \
102 .msg_line = __LINE__, \
103 .msg_cdls = (cdls) }; \
104 dataname.msg_mask = (mask);
106 #ifdef CDEBUG_ENABLED
109 * Filters out logging messages based on mask and subsystem.
111 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
113 return mask & D_CANTMASK ||
114 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
117 # define __CDEBUG(cdls, mask, format, ...) \
119 static struct libcfs_debug_msg_data msgdata; \
121 CFS_CHECK_STACK(&msgdata, mask, cdls); \
123 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
124 LIBCFS_DEBUG_MSG_DATA_INIT(&msgdata, mask, cdls); \
125 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
129 # define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
131 # define CDEBUG_LIMIT(mask, format, ...) \
133 static struct cfs_debug_limit_state cdls; \
135 __CDEBUG(&cdls, mask, format, ## __VA_ARGS__); \
138 # else /* !CDEBUG_ENABLED */
139 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
143 # define CDEBUG(mask, format, ...) (void)(0)
144 # define CDEBUG_LIMIT(mask, format, ...) (void)(0)
145 # warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
146 # endif /* CDEBUG_ENABLED */
149 * Lustre Error Checksum: calculates checksum
150 * of Hex number by XORing each bit.
152 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
153 ((hexnum) >> 8 & 0xf))
155 #define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
156 #define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
157 #define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
158 #define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
160 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
161 #define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
162 #define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
163 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
164 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
165 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
167 #define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
169 #if defined(CDEBUG_ENTRY_EXIT)
171 void libcfs_log_goto(struct libcfs_debug_msg_data *goto_data,
172 const char *label, long rc);
174 # define GOTO(label, rc) \
176 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
177 LIBCFS_DEBUG_MSG_DATA_DECL(_goto_data, D_TRACE, NULL); \
178 libcfs_log_goto(&_goto_data, #label, (long)(rc)); \
187 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
188 # if BITS_PER_LONG > 32
189 # define RETURN(rc) \
191 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
192 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
193 return (typeof(rc))libcfs_log_return(&msgdata, \
199 # else /* BITS_PER_LONG == 32 */
200 /* We need an on-stack variable, because we cannot case a 32-bit pointer
201 * directly to (long long) without generating a complier warning/error, yet
202 * casting directly to (long) will truncate 64-bit return values. The log
203 * values will print as 32-bit values, but they always have been. LU-1436
205 # define RETURN(rc) \
207 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
208 typeof(rc) __rc = (rc); \
209 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
210 libcfs_log_return(&msgdata, (long)__rc); \
217 # endif /* BITS_PER_LONG > 32 */
219 # define ENTRY CDEBUG(D_TRACE, "Process entered\n")
220 # define EXIT CDEBUG(D_TRACE, "Process leaving\n")
222 #else /* !CDEBUG_ENTRY_EXIT */
224 # define GOTO(label, rc) \
230 # define RETURN(rc) return (rc)
231 # define ENTRY do { } while (0)
232 # define EXIT do { } while (0)
234 #endif /* CDEBUG_ENTRY_EXIT */
236 #define RETURN_EXIT \
242 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
243 const char *format1, ...)
244 __attribute__ ((format (printf, 2, 3)));
246 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
248 va_list args, const char *format2, ...)
249 __attribute__ ((format (printf, 4, 5)));
251 /* other external symbols that tracefile provides: */
252 extern int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
253 const char __user *usr_buffer,
255 extern int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
256 const char *knl_buffer, char *append);
258 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
260 #endif /* __LIBCFS_DEBUG_H__ */