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__
42 #include <linux/limits.h>
43 #include <uapi/linux/lnet/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;
67 #ifndef DEBUG_SUBSYSTEM
68 # define DEBUG_SUBSYSTEM S_UNDEFINED
71 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
72 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
73 #define CDEBUG_DEFAULT_BACKOFF 2
74 struct cfs_debug_limit_state {
75 unsigned long cdls_next;
76 unsigned int cdls_delay;
80 struct libcfs_debug_msg_data {
86 struct cfs_debug_limit_state *msg_cdls;
89 #define LIBCFS_DEBUG_MSG_DATA_INIT(file, func, line, msgdata, mask, cdls)\
91 (msgdata)->msg_subsys = DEBUG_SUBSYSTEM; \
92 (msgdata)->msg_file = (file); \
93 (msgdata)->msg_fn = (func); \
94 (msgdata)->msg_line = (line); \
95 (msgdata)->msg_mask = (mask); \
96 (msgdata)->msg_cdls = (cdls); \
99 #define LIBCFS_DEBUG_MSG_DATA_DECL_LOC(file, func, line, msgdata, mask, cdls)\
100 static struct libcfs_debug_msg_data msgdata = { \
101 .msg_subsys = DEBUG_SUBSYSTEM, \
102 .msg_file = (file), \
104 .msg_line = (line), \
105 .msg_cdls = (cdls) }; \
106 msgdata.msg_mask = (mask)
108 #define LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, cdls) \
109 LIBCFS_DEBUG_MSG_DATA_DECL_LOC(__FILE__, __func__, __LINE__, \
112 #ifdef CDEBUG_ENABLED
114 #if !defined(__x86_64__)
116 # define CDEBUG_STACK() (THREAD_SIZE - \
117 ((unsigned long)__builtin_dwarf_cfa() & \
120 # define CDEBUG_STACK() (THREAD_SIZE - \
121 ((unsigned long)__builtin_frame_address(0) & \
123 # endif /* __ia64__ */
125 #define __CHECK_STACK_WITH_LOC(file, func, line, msgdata, mask, cdls) \
127 if (unlikely(CDEBUG_STACK() > libcfs_stack)) { \
128 LIBCFS_DEBUG_MSG_DATA_INIT(file, func, line, msgdata, \
130 libcfs_stack = CDEBUG_STACK(); \
131 libcfs_debug_msg(msgdata, "maximum lustre stack %u\n", \
133 (msgdata)->msg_mask = mask; \
134 (msgdata)->msg_cdls = cdls; \
139 #else /* __x86_64__ */
140 #define CDEBUG_STACK() (0L)
141 #define __CHECK_STACK_WITH_LOC(file, func, line, msgdata, mask, cdls) \
143 #endif /* __x86_64__ */
145 #define CFS_CHECK_STACK(msgdata, mask, cdls) \
146 __CHECK_STACK_WITH_LOC(__FILE__, __func__, __LINE__, \
149 * Filters out logging messages based on mask and subsystem.
151 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
153 return mask & D_CANTMASK ||
154 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
157 # define __CDEBUG_WITH_LOC(file, func, line, mask, cdls, format, ...) \
159 static struct libcfs_debug_msg_data msgdata; \
161 __CHECK_STACK_WITH_LOC(file, func, line, &msgdata, mask, cdls); \
163 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
164 LIBCFS_DEBUG_MSG_DATA_INIT(file, func, line, \
165 &msgdata, mask, cdls); \
166 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
170 # define CDEBUG(mask, format, ...) \
171 __CDEBUG_WITH_LOC(__FILE__, __func__, __LINE__, \
172 mask, NULL, format, ## __VA_ARGS__)
174 # define CDEBUG_LIMIT(mask, format, ...) \
176 static struct cfs_debug_limit_state cdls; \
178 __CDEBUG_WITH_LOC(__FILE__, __func__, __LINE__, \
179 mask, &cdls, format, ## __VA_ARGS__); \
182 # else /* !CDEBUG_ENABLED */
183 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
187 # define CDEBUG(mask, format, ...) (void)(0)
188 # define CDEBUG_LIMIT(mask, format, ...) (void)(0)
189 # warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
190 # endif /* CDEBUG_ENABLED */
193 * Lustre Error Checksum: calculates checksum
194 * of Hex number by XORing each bit.
196 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
197 ((hexnum) >> 8 & 0xf))
199 #define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
200 #define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
201 #define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
202 #define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
204 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
205 #define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
206 #define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
207 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
208 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
209 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
211 #define LCONSOLE_EMERG(format, ...) \
212 CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
214 #if defined(CDEBUG_ENTRY_EXIT)
216 void libcfs_log_goto(struct libcfs_debug_msg_data *goto_data,
217 const char *label, long rc);
219 # define GOTO(label, rc) \
221 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
222 LIBCFS_DEBUG_MSG_DATA_DECL(_goto_data, D_TRACE, NULL); \
223 libcfs_log_goto(&_goto_data, #label, (long)(rc)); \
232 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
233 # if BITS_PER_LONG > 32
234 # define RETURN(rc) \
236 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
237 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
238 return (typeof(rc))libcfs_log_return(&msgdata, \
244 # else /* BITS_PER_LONG == 32 */
245 /* We need an on-stack variable, because we cannot case a 32-bit pointer
246 * directly to (long long) without generating a complier warning/error, yet
247 * casting directly to (long) will truncate 64-bit return values. The log
248 * values will print as 32-bit values, but they always have been. LU-1436
250 # define RETURN(rc) \
252 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
253 typeof(rc) __rc = (rc); \
254 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
255 libcfs_log_return(&msgdata, (long)__rc); \
262 # endif /* BITS_PER_LONG > 32 */
264 # define ENTRY CDEBUG(D_TRACE, "Process entered\n")
265 # define EXIT CDEBUG(D_TRACE, "Process leaving\n")
267 #else /* !CDEBUG_ENTRY_EXIT */
269 # define GOTO(label, rc) \
275 # define RETURN(rc) return (rc)
276 # define ENTRY do { } while (0)
277 # define EXIT do { } while (0)
279 #endif /* CDEBUG_ENTRY_EXIT */
281 #define RETURN_EXIT \
287 extern int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
288 const char *format1, ...)
289 __attribute__ ((format (printf, 2, 3)));
291 extern int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
293 va_list args, const char *format2, ...)
294 __attribute__ ((format (printf, 4, 5)));
296 /* other external symbols that tracefile provides: */
297 extern int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
298 const char __user *usr_buffer,
300 extern int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
301 const char *knl_buffer, char *append);
303 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
305 #endif /* __LIBCFS_DEBUG_H__ */