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 <linux/limits.h>
42 #include <uapi/linux/lnet/libcfs_debug.h>
47 extern unsigned int libcfs_subsystem_debug;
48 extern unsigned int libcfs_stack;
49 extern unsigned int libcfs_debug;
50 extern unsigned int libcfs_printk;
51 extern unsigned int libcfs_watchdog_ratelimit;
52 extern unsigned int libcfs_console_ratelimit;
53 extern unsigned int libcfs_console_max_delay;
54 extern unsigned int libcfs_console_min_delay;
55 extern unsigned int libcfs_console_backoff;
56 extern unsigned int libcfs_debug_binary;
57 extern char *libcfs_debug_file_path;
61 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
62 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
63 void libcfs_debug_dumpstack(struct task_struct *tsk);
65 /* Has there been an LBUG? */
66 extern unsigned int libcfs_catastrophe;
67 extern unsigned int libcfs_panic_on_lbug;
69 #ifndef DEBUG_SUBSYSTEM
70 # define DEBUG_SUBSYSTEM S_UNDEFINED
73 #define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
74 #define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
75 #define CDEBUG_DEFAULT_BACKOFF 2
76 struct cfs_debug_limit_state {
77 unsigned long cdls_next;
78 unsigned int cdls_delay;
82 struct libcfs_debug_msg_data {
88 struct cfs_debug_limit_state *msg_cdls;
91 #define LIBCFS_DEBUG_MSG_DATA_INIT(file, func, line, msgdata, mask, cdls)\
93 (msgdata)->msg_subsys = DEBUG_SUBSYSTEM; \
94 (msgdata)->msg_file = (file); \
95 (msgdata)->msg_fn = (func); \
96 (msgdata)->msg_line = (line); \
97 (msgdata)->msg_mask = (mask); \
98 (msgdata)->msg_cdls = (cdls); \
101 #define LIBCFS_DEBUG_MSG_DATA_DECL_LOC(file, func, line, msgdata, mask, cdls)\
102 static struct libcfs_debug_msg_data msgdata = { \
103 .msg_subsys = DEBUG_SUBSYSTEM, \
104 .msg_file = (file), \
106 .msg_line = (line), \
107 .msg_cdls = (cdls) }; \
108 msgdata.msg_mask = (mask)
110 #define LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, cdls) \
111 LIBCFS_DEBUG_MSG_DATA_DECL_LOC(__FILE__, __func__, __LINE__, \
114 #ifdef CDEBUG_ENABLED
116 #if !defined(__x86_64__)
118 # define CDEBUG_STACK() (THREAD_SIZE - \
119 ((unsigned long)__builtin_dwarf_cfa() & \
122 # define CDEBUG_STACK() (THREAD_SIZE - \
123 ((unsigned long)__builtin_frame_address(0) & \
125 # endif /* __ia64__ */
127 #define __CHECK_STACK_WITH_LOC(file, func, line, msgdata, mask, cdls) \
129 if (unlikely(CDEBUG_STACK() > libcfs_stack)) { \
130 LIBCFS_DEBUG_MSG_DATA_INIT(file, func, line, msgdata, \
132 libcfs_stack = CDEBUG_STACK(); \
133 libcfs_debug_msg(msgdata, "maximum lustre stack %u\n", \
135 (msgdata)->msg_mask = mask; \
136 (msgdata)->msg_cdls = cdls; \
141 #else /* __x86_64__ */
142 #define CDEBUG_STACK() (0L)
143 #define __CHECK_STACK_WITH_LOC(file, func, line, msgdata, mask, cdls) \
145 #endif /* __x86_64__ */
147 #define CFS_CHECK_STACK(msgdata, mask, cdls) \
148 __CHECK_STACK_WITH_LOC(__FILE__, __func__, __LINE__, \
151 * Filters out logging messages based on mask and subsystem.
153 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
155 return mask & D_CANTMASK ||
156 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
159 # define __CDEBUG_WITH_LOC(file, func, line, mask, cdls, format, ...) \
161 static struct libcfs_debug_msg_data msgdata; \
163 __CHECK_STACK_WITH_LOC(file, func, line, &msgdata, mask, cdls); \
165 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
166 LIBCFS_DEBUG_MSG_DATA_INIT(file, func, line, \
167 &msgdata, mask, cdls); \
168 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
172 # define CDEBUG(mask, format, ...) \
173 __CDEBUG_WITH_LOC(__FILE__, __func__, __LINE__, \
174 mask, NULL, format, ## __VA_ARGS__)
176 # define CDEBUG_LIMIT(mask, format, ...) \
178 static struct cfs_debug_limit_state cdls; \
180 __CDEBUG_WITH_LOC(__FILE__, __func__, __LINE__, \
181 mask, &cdls, format, ## __VA_ARGS__); \
184 # else /* !CDEBUG_ENABLED */
185 static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
189 # define CDEBUG(mask, format, ...) (void)(0)
190 # define CDEBUG_LIMIT(mask, format, ...) (void)(0)
191 # warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
192 # endif /* CDEBUG_ENABLED */
195 * Lustre Error Checksum: calculates checksum
196 * of Hex number by XORing each bit.
198 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
199 ((hexnum) >> 8 & 0xf))
201 #define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
202 #define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
203 #define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
204 #define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
206 #define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
207 #define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
208 #define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
209 #define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
210 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
211 #define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
213 #define LCONSOLE_EMERG(format, ...) \
214 CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
216 #if defined(CDEBUG_ENTRY_EXIT)
218 void libcfs_log_goto(struct libcfs_debug_msg_data *goto_data,
219 const char *label, long rc);
221 # define GOTO(label, rc) \
223 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
224 LIBCFS_DEBUG_MSG_DATA_DECL(_goto_data, D_TRACE, NULL); \
225 libcfs_log_goto(&_goto_data, #label, (long)(rc)); \
234 long libcfs_log_return(struct libcfs_debug_msg_data *, long rc);
235 # if BITS_PER_LONG > 32
236 # define RETURN(rc) \
238 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
239 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
240 return (typeof(rc))libcfs_log_return(&msgdata, \
246 # else /* BITS_PER_LONG == 32 */
247 /* We need an on-stack variable, because we cannot case a 32-bit pointer
248 * directly to (long long) without generating a complier warning/error, yet
249 * casting directly to (long) will truncate 64-bit return values. The log
250 * values will print as 32-bit values, but they always have been. LU-1436
252 # define RETURN(rc) \
254 if (cfs_cdebug_show(D_TRACE, DEBUG_SUBSYSTEM)) { \
255 typeof(rc) __rc = (rc); \
256 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_TRACE, NULL); \
257 libcfs_log_return(&msgdata, (long)__rc); \
264 # endif /* BITS_PER_LONG > 32 */
266 # define ENTRY CDEBUG(D_TRACE, "Process entered\n")
267 # define EXIT CDEBUG(D_TRACE, "Process leaving\n")
269 #else /* !CDEBUG_ENTRY_EXIT */
271 # define GOTO(label, rc) \
277 # define RETURN(rc) return (rc)
278 # define ENTRY do { } while (0)
279 # define EXIT do { } while (0)
281 #endif /* CDEBUG_ENTRY_EXIT */
283 #define RETURN_EXIT \
289 int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
290 const char *format1, ...)
293 /* other external symbols that tracefile provides: */
294 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
295 const char *knl_buffer, char *append);
297 #define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
299 void cfs_debug_init(void);
301 #endif /* __LIBCFS_DEBUG_H__ */