Merge remote-tracking branch 'staging/staging-next'
[deliverable/linux.git] / drivers / staging / lustre / include / linux / libcfs / libcfs_debug.h
CommitLineData
d7e09d03
PT
1/*
2 * GPL HEADER START
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
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.
9 *
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).
15 *
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
6a5b99a4 18 * http://www.gnu.org/licenses/gpl-2.0.html
d7e09d03 19 *
d7e09d03
PT
20 * GPL HEADER END
21 */
22/*
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
25 *
26 * Copyright (c) 2012, Intel Corporation.
27 */
28/*
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
31 *
32 * libcfs/include/libcfs/libcfs_debug.h
33 *
34 * Debug messages and assertions
35 *
36 */
37
38#ifndef __LIBCFS_DEBUG_H__
39#define __LIBCFS_DEBUG_H__
40
41/*
42 * Debugging
43 */
44extern unsigned int libcfs_subsystem_debug;
45extern unsigned int libcfs_stack;
46extern unsigned int libcfs_debug;
47extern unsigned int libcfs_printk;
48extern unsigned int libcfs_console_ratelimit;
d7e09d03
PT
49extern unsigned int libcfs_console_max_delay;
50extern unsigned int libcfs_console_min_delay;
51extern unsigned int libcfs_console_backoff;
52extern unsigned int libcfs_debug_binary;
53extern char libcfs_debug_file_path_arr[PATH_MAX];
54
55int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
56int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
57
58/* Has there been an LBUG? */
59extern unsigned int libcfs_catastrophe;
60extern unsigned int libcfs_panic_on_lbug;
61
62/**
63 * Format for debug message headers
64 */
65struct ptldebug_header {
66 __u32 ph_len;
67 __u32 ph_flags;
68 __u32 ph_subsys;
69 __u32 ph_mask;
70 __u16 ph_cpu_id;
71 __u16 ph_type;
65f28840 72 /* time_t overflow in 2106 */
d7e09d03
PT
73 __u32 ph_sec;
74 __u64 ph_usec;
75 __u32 ph_stack;
76 __u32 ph_pid;
77 __u32 ph_extern_pid;
78 __u32 ph_line_num;
fd917652 79} __packed;
d7e09d03 80
d7e09d03
PT
81#define PH_FLAG_FIRST_RECORD 1
82
83/* Debugging subsystems (32 bits, non-overlapping) */
5b50eeff
SS
84#define S_UNDEFINED 0x00000001
85#define S_MDC 0x00000002
86#define S_MDS 0x00000004
87#define S_OSC 0x00000008
88#define S_OST 0x00000010
89#define S_CLASS 0x00000020
90#define S_LOG 0x00000040
91#define S_LLITE 0x00000080
92#define S_RPC 0x00000100
93#define S_MGMT 0x00000200
94#define S_LNET 0x00000400
95#define S_LND 0x00000800 /* ALL LNDs */
96#define S_PINGER 0x00001000
97#define S_FILTER 0x00002000
d7e09d03 98/* unused */
5b50eeff
SS
99#define S_ECHO 0x00008000
100#define S_LDLM 0x00010000
101#define S_LOV 0x00020000
102#define S_LQUOTA 0x00040000
d7e09d03 103#define S_OSD 0x00080000
9581c2c4 104#define S_LFSCK 0x00100000
d7e09d03
PT
105/* unused */
106/* unused */
5b50eeff 107#define S_LMV 0x00800000 /* b_new_cmd */
d7e09d03 108/* unused */
5b50eeff
SS
109#define S_SEC 0x02000000 /* upcall cache */
110#define S_GSS 0x04000000 /* b_new_cmd */
d7e09d03 111/* unused */
5b50eeff
SS
112#define S_MGC 0x10000000
113#define S_MGS 0x20000000
114#define S_FID 0x40000000 /* b_new_cmd */
115#define S_FLD 0x80000000 /* b_new_cmd */
d7e09d03 116
6f11cd97
JX
117#define LIBCFS_DEBUG_SUBSYS_NAMES { \
118 "undefined", "mdc", "mds", "osc", "ost", "class", "log", \
119 "llite", "rpc", "mgmt", "lnet", "lnd", "pinger", "filter", "", \
120 "echo", "ldlm", "lov", "lquota", "osd", "lfsck", "", "", "lmv", \
121 "", "sec", "gss", "", "mgc", "mgs", "fid", "fld", NULL }
122
d7e09d03 123/* Debugging masks (32 bits, non-overlapping) */
5b50eeff
SS
124#define D_TRACE 0x00000001 /* ENTRY/EXIT markers */
125#define D_INODE 0x00000002
126#define D_SUPER 0x00000004
127#define D_EXT2 0x00000008 /* anything from ext2_debug */
128#define D_MALLOC 0x00000010 /* print malloc, free information */
129#define D_CACHE 0x00000020 /* cache-related items */
130#define D_INFO 0x00000040 /* general information */
131#define D_IOCTL 0x00000080 /* ioctl related information */
132#define D_NETERROR 0x00000100 /* network errors */
133#define D_NET 0x00000200 /* network communications */
134#define D_WARNING 0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
135#define D_BUFFS 0x00000800
136#define D_OTHER 0x00001000
137#define D_DENTRY 0x00002000
138#define D_NETTRACE 0x00004000
139#define D_PAGE 0x00008000 /* bulk page handling */
140#define D_DLMTRACE 0x00010000
141#define D_ERROR 0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
142#define D_EMERG 0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
143#define D_HA 0x00080000 /* recovery and failover */
144#define D_RPCTRACE 0x00100000 /* for distributed debugging */
145#define D_VFSTRACE 0x00200000
146#define D_READA 0x00400000 /* read-ahead */
147#define D_MMAP 0x00800000
148#define D_CONFIG 0x01000000
149#define D_CONSOLE 0x02000000
150#define D_QUOTA 0x04000000
151#define D_SEC 0x08000000
152#define D_LFSCK 0x10000000 /* For both OI scrub and LFSCK */
83c61a5c 153#define D_HSM 0x20000000
d7e09d03 154
6f11cd97
JX
155#define LIBCFS_DEBUG_MASKS_NAMES { \
156 "trace", "inode", "super", "ext2", "malloc", "cache", "info", \
157 "ioctl", "neterror", "net", "warning", "buffs", "other", \
158 "dentry", "nettrace", "page", "dlmtrace", "error", "emerg", \
159 "ha", "rpctrace", "vfstrace", "reada", "mmap", "config", \
160 "console", "quota", "sec", "lfsck", "hsm", NULL }
161
d7e09d03
PT
162#define D_CANTMASK (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
163
164#ifndef DEBUG_SUBSYSTEM
165# define DEBUG_SUBSYSTEM S_UNDEFINED
166#endif
167
168#define CDEBUG_DEFAULT_MAX_DELAY (cfs_time_seconds(600)) /* jiffies */
169#define CDEBUG_DEFAULT_MIN_DELAY ((cfs_time_seconds(1) + 1) / 2) /* jiffies */
170#define CDEBUG_DEFAULT_BACKOFF 2
a3ea59e0 171struct cfs_debug_limit_state {
a649ad1d 172 unsigned long cdls_next;
1c4738c3 173 unsigned int cdls_delay;
d7e09d03 174 int cdls_count;
a3ea59e0 175};
d7e09d03
PT
176
177struct libcfs_debug_msg_data {
1c4738c3
SS
178 const char *msg_file;
179 const char *msg_fn;
180 int msg_subsys;
181 int msg_line;
182 int msg_mask;
183 struct cfs_debug_limit_state *msg_cdls;
d7e09d03
PT
184};
185
924a9f94
SS
186#define LIBCFS_DEBUG_MSG_DATA_INIT(data, mask, cdls) \
187do { \
188 (data)->msg_subsys = DEBUG_SUBSYSTEM; \
189 (data)->msg_file = __FILE__; \
f9bd9c1a 190 (data)->msg_fn = __func__; \
924a9f94
SS
191 (data)->msg_line = __LINE__; \
192 (data)->msg_cdls = (cdls); \
193 (data)->msg_mask = (mask); \
d7e09d03
PT
194} while (0)
195
924a9f94
SS
196#define LIBCFS_DEBUG_MSG_DATA_DECL(dataname, mask, cdls) \
197 static struct libcfs_debug_msg_data dataname = { \
198 .msg_subsys = DEBUG_SUBSYSTEM, \
199 .msg_file = __FILE__, \
f9bd9c1a 200 .msg_fn = __func__, \
924a9f94
SS
201 .msg_line = __LINE__, \
202 .msg_cdls = (cdls) }; \
06133e80 203 dataname.msg_mask = (mask)
d7e09d03 204
d7e09d03
PT
205/**
206 * Filters out logging messages based on mask and subsystem.
207 */
208static inline int cfs_cdebug_show(unsigned int mask, unsigned int subsystem)
209{
210 return mask & D_CANTMASK ||
211 ((libcfs_debug & mask) && (libcfs_subsystem_debug & subsystem));
212}
213
924a9f94
SS
214#define __CDEBUG(cdls, mask, format, ...) \
215do { \
216 static struct libcfs_debug_msg_data msgdata; \
d7e09d03 217 \
924a9f94 218 CFS_CHECK_STACK(&msgdata, mask, cdls); \
d7e09d03 219 \
924a9f94
SS
220 if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \
221 LIBCFS_DEBUG_MSG_DATA_INIT(&msgdata, mask, cdls); \
222 libcfs_debug_msg(&msgdata, format, ## __VA_ARGS__); \
223 } \
d7e09d03
PT
224} while (0)
225
226#define CDEBUG(mask, format, ...) __CDEBUG(NULL, mask, format, ## __VA_ARGS__)
227
924a9f94
SS
228#define CDEBUG_LIMIT(mask, format, ...) \
229do { \
230 static struct cfs_debug_limit_state cdls; \
231 \
232 __CDEBUG(&cdls, mask, format, ## __VA_ARGS__); \
d7e09d03
PT
233} while (0)
234
1c4738c3
SS
235#define CWARN(format, ...) CDEBUG_LIMIT(D_WARNING, format, ## __VA_ARGS__)
236#define CERROR(format, ...) CDEBUG_LIMIT(D_ERROR, format, ## __VA_ARGS__)
237#define CNETERR(format, a...) CDEBUG_LIMIT(D_NETERROR, format, ## a)
238#define CEMERG(format, ...) CDEBUG_LIMIT(D_EMERG, format, ## __VA_ARGS__)
d7e09d03
PT
239
240#define LCONSOLE(mask, format, ...) CDEBUG(D_CONSOLE | (mask), format, ## __VA_ARGS__)
241#define LCONSOLE_INFO(format, ...) CDEBUG_LIMIT(D_CONSOLE, format, ## __VA_ARGS__)
242#define LCONSOLE_WARN(format, ...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## __VA_ARGS__)
243#define LCONSOLE_ERROR_MSG(errnum, format, ...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
244 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## __VA_ARGS__)
245#define LCONSOLE_ERROR(format, ...) LCONSOLE_ERROR_MSG(0x00, format, ## __VA_ARGS__)
246
247#define LCONSOLE_EMERG(format, ...) CDEBUG(D_CONSOLE | D_EMERG, format, ## __VA_ARGS__)
248
a393fd54 249int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
24c198e9 250 const char *format1, ...)
70837c12 251 __printf(2, 3);
d7e09d03 252
a393fd54 253int libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
24c198e9
OD
254 const char *format1,
255 va_list args, const char *format2, ...)
70837c12 256 __printf(4, 5);
d7e09d03
PT
257
258/* other external symbols that tracefile provides: */
a393fd54 259int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
24c198e9 260 const char __user *usr_buffer, int usr_buffer_nob);
5a08f067 261int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
24c198e9 262 const char *knl_buffer, char *append);
d7e09d03
PT
263
264#define LIBCFS_DEBUG_FILE_PATH_DEFAULT "/tmp/lustre-log"
265
266#endif /* __LIBCFS_DEBUG_H__ */
This page took 0.5158 seconds and 5 git commands to generate.