[linux-2.6-block.git] / fs / cifs / cifs_debug.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *
 *   Copyright (c) International Business Machines  Corp., 2000,2002
 *   Modified by Steve French (sfrench@us.ibm.com)
*/

#ifndef _H_CIFS_DEBUG
#define _H_CIFS_DEBUG

void cifs_dump_mem(char *label, void *data, int length);
void cifs_dump_detail(void *buf, struct TCP_Server_Info *ptcp_info);
void cifs_dump_mids(struct TCP_Server_Info *);
extern bool traceSMB;		/* flag which enables the function below */
void dump_smb(void *, int);
#define CIFS_INFO	0x01
#define CIFS_RC		0x02
#define CIFS_TIMER	0x04

#define VFS 1
#define FYI 2
extern int cifsFYI;
#ifdef CONFIG_CIFS_DEBUG2
#define NOISY 4
#else
#define NOISY 0
#endif
#define ONCE 8

/*
 *	debug ON
 *	--------
 */
#ifdef CONFIG_CIFS_DEBUG


/*
 * When adding tracepoints and debug messages we have various choices.
 * Some considerations:
 *
 * Use cifs_dbg(VFS, ...) for things we always want logged, and the user to see
 *     cifs_info(...) slightly less important, admin can filter via loglevel > 6
 *     cifs_dbg(FYI, ...) minor debugging messages, off by default
 *     trace_smb3_*  ftrace functions are preferred for complex debug messages
 *                 intended for developers or experienced admins, off by default
 */

/* Information level messages, minor events */
#define cifs_info_func(ratefunc, fmt, ...)			\
do {								\
	pr_info_ ## ratefunc("CIFS: " fmt, ##__VA_ARGS__); 	\
} while (0)

#define cifs_info(fmt, ...)					\
do { 								\
	cifs_info_func(ratelimited, fmt, ##__VA_ARGS__); 	\
} while (0)

/* information message: e.g., configuration, major event */
#define cifs_dbg_func(ratefunc, type, fmt, ...)			\
do {								\
	if ((type) & FYI && cifsFYI & CIFS_INFO) {		\
		pr_debug_ ## ratefunc("%s: "			\
				fmt, __FILE__, ##__VA_ARGS__);	\
	} else if ((type) & VFS) {				\
		pr_err_ ## ratefunc("CIFS VFS: "		\
				 fmt, ##__VA_ARGS__);		\
	} else if ((type) & NOISY && (NOISY != 0)) {		\
		pr_debug_ ## ratefunc(fmt, ##__VA_ARGS__);	\
	}							\
} while (0)

#define cifs_dbg(type, fmt, ...) \
do {							\
	if ((type) & ONCE)				\
		cifs_dbg_func(once,			\
			 type, fmt, ##__VA_ARGS__);	\
	else						\
		cifs_dbg_func(ratelimited,		\
			type, fmt, ##__VA_ARGS__);	\
} while (0)

#define cifs_server_dbg_func(ratefunc, type, fmt, ...)		\
do {								\
	const char *sn = "";					\
	if (server && server->hostname)				\
		sn = server->hostname;				\
	if ((type) & FYI && cifsFYI & CIFS_INFO) {		\
		pr_debug_ ## ratefunc("%s: \\\\%s "	fmt,	\
			__FILE__, sn, ##__VA_ARGS__);		\
	} else if ((type) & VFS) {				\
		pr_err_ ## ratefunc("CIFS VFS: \\\\%s " fmt,	\
			sn, ##__VA_ARGS__);			\
	} else if ((type) & NOISY && (NOISY != 0)) {		\
		pr_debug_ ## ratefunc("\\\\%s " fmt,		\
			sn, ##__VA_ARGS__);			\
	}							\
} while (0)

#define cifs_server_dbg(type, fmt, ...)			\
do {							\
	if ((type) & ONCE)				\
		cifs_server_dbg_func(once,		\
			type, fmt, ##__VA_ARGS__);	\
	else						\
		cifs_server_dbg_func(ratelimited,	\
			type, fmt, ##__VA_ARGS__);	\
} while (0)

#define cifs_tcon_dbg_func(ratefunc, type, fmt, ...)		\
do {								\
	const char *tn = "";					\
	if (tcon && tcon->treeName)				\
		tn = tcon->treeName;				\
	if ((type) & FYI && cifsFYI & CIFS_INFO) {		\
		pr_debug_ ## ratefunc("%s: %s "	fmt,		\
			__FILE__, tn, ##__VA_ARGS__);		\
	} else if ((type) & VFS) {				\
		pr_err_ ## ratefunc("CIFS VFS: %s " fmt,	\
			tn, ##__VA_ARGS__);			\
	} else if ((type) & NOISY && (NOISY != 0)) {		\
		pr_debug_ ## ratefunc("%s " fmt,		\
			tn, ##__VA_ARGS__);			\
	}							\
} while (0)

#define cifs_tcon_dbg(type, fmt, ...)			\
do {							\
	if ((type) & ONCE)				\
		cifs_tcon_dbg_func(once,		\
			type, fmt, ##__VA_ARGS__);	\
	else						\
		cifs_tcon_dbg_func(ratelimited,	\
			type, fmt, ##__VA_ARGS__);	\
} while (0)

/*
 *	debug OFF
 *	---------
 */
#else		/* _CIFS_DEBUG */
#define cifs_dbg(type, fmt, ...)					\
do {									\
	if (0)								\
		pr_debug(fmt, ##__VA_ARGS__);				\
} while (0)

#define cifs_server_dbg(type, fmt, ...)					\
do {									\
	if (0)								\
		pr_debug("\\\\%s " fmt,					\
			 server->hostname, ##__VA_ARGS__);		\
} while (0)

#define cifs_tcon_dbg(type, fmt, ...)					\
do {									\
	if (0)								\
		pr_debug("%s " fmt, tcon->treeName, ##__VA_ARGS__);	\
} while (0)

#define cifs_info(fmt, ...)						\
do {									\
	pr_info("CIFS: "fmt, ##__VA_ARGS__);				\
} while (0)
#endif

#endif				/* _H_CIFS_DEBUG */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	*
	4	* Copyright (c) International Business Machines Corp., 2000,2002
	5	* Modified by Steve French (sfrench@us.ibm.com)
1da177e4	6	*/
1da177e4 LT	7
	8	#ifndef _H_CIFS_DEBUG
	9	#define _H_CIFS_DEBUG
	10
	11	void cifs_dump_mem(char label, void data, int length);
14547f7d	12	void cifs_dump_detail(void buf, struct TCP_Server_Info ptcp_info);
3979877e	13	void cifs_dump_mids(struct TCP_Server_Info *);
1404297e	14	extern bool traceSMB; /* flag which enables the function below */
792af7b0	15	void dump_smb(void *, int);
1047abc1	16	#define CIFS_INFO 0x01
13cd4b7f	17	#define CIFS_RC 0x02
1047abc1	18	#define CIFS_TIMER 0x04
1da177e4	19
f96637be JP	20	#define VFS 1
f96637be JP	21	#define FYI 2
bde98197	22	extern int cifsFYI;
f96637be JP	23	#ifdef CONFIG_CIFS_DEBUG2
	24	#define NOISY 4
	25	#else
	26	#define NOISY 0
	27	#endif
f2f176b4	28	#define ONCE 8
bde98197	29
1da177e4 LT	30	/*
	31	* debug ON
	32	* --------
	33	*/
471b1f98	34	#ifdef CONFIG_CIFS_DEBUG
1da177e4	35
8c1beb98 SF	36
	37	/*
	38	* When adding tracepoints and debug messages we have various choices.
	39	* Some considerations:
	40	*
	41	* Use cifs_dbg(VFS, ...) for things we always want logged, and the user to see
	42	* cifs_info(...) slightly less important, admin can filter via loglevel > 6
	43	* cifs_dbg(FYI, ...) minor debugging messages, off by default
	44	* trace_smb3_* ftrace functions are preferred for complex debug messages
	45	* intended for developers or experienced admins, off by default
	46	*/
	47
9a0efecc RF	48	/* Information level messages, minor events */
	49	#define cifs_info_func(ratefunc, fmt, ...) \
	50	do { \
	51	pr_info_ ## ratefunc("CIFS: " fmt, ##__VA_ARGS__); \
	52	} while (0)
	53
	54	#define cifs_info(fmt, ...) \
	55	do { \
	56	cifs_info_func(ratelimited, fmt, ##__VA_ARGS__); \
	57	} while (0)
	58
f96637be	59	/* information message: e.g., configuration, major event */
f2f176b4 AA	60	#define cifs_dbg_func(ratefunc, type, fmt, ...) \
	61	do { \
	62	if ((type) & FYI && cifsFYI & CIFS_INFO) { \
	63	pr_debug_ ## ratefunc("%s: " \
	64	fmt, __FILE__, ##__VA_ARGS__); \
	65	} else if ((type) & VFS) { \
596632de	66	pr_err_ ## ratefunc("CIFS VFS: " \
f2f176b4 AA	67	fmt, ##__VA_ARGS__); \
	68	} else if ((type) & NOISY && (NOISY != 0)) { \
	69	pr_debug_ ## ratefunc(fmt, ##__VA_ARGS__); \
	70	} \
	71	} while (0)
	72
	73	#define cifs_dbg(type, fmt, ...) \
	74	do { \
	75	if ((type) & ONCE) \
	76	cifs_dbg_func(once, \
	77	type, fmt, ##__VA_ARGS__); \
	78	else \
	79	cifs_dbg_func(ratelimited, \
	80	type, fmt, ##__VA_ARGS__); \
b6b38f70	81	} while (0)
1da177e4	82
afe6f653 RS	83	#define cifs_server_dbg_func(ratefunc, type, fmt, ...) \
afe6f653 RS	84	do { \
3175eb9b RS	85	const char *sn = ""; \
	86	if (server && server->hostname) \
	87	sn = server->hostname; \
afe6f653	88	if ((type) & FYI && cifsFYI & CIFS_INFO) { \
3175eb9b RS	89	pr_debug_ ## ratefunc("%s: \\\\%s " fmt, \
3175eb9b RS	90	__FILE__, sn, ##__VA_ARGS__); \
afe6f653	91	} else if ((type) & VFS) { \
3175eb9b RS	92	pr_err_ ## ratefunc("CIFS VFS: \\\\%s " fmt, \
3175eb9b RS	93	sn, ##__VA_ARGS__); \
afe6f653	94	} else if ((type) & NOISY && (NOISY != 0)) { \
3175eb9b RS	95	pr_debug_ ## ratefunc("\\\\%s " fmt, \
3175eb9b RS	96	sn, ##__VA_ARGS__); \
afe6f653 RS	97	} \
	98	} while (0)
	99
	100	#define cifs_server_dbg(type, fmt, ...) \
	101	do { \
	102	if ((type) & ONCE) \
	103	cifs_server_dbg_func(once, \
	104	type, fmt, ##__VA_ARGS__); \
	105	else \
	106	cifs_server_dbg_func(ratelimited, \
	107	type, fmt, ##__VA_ARGS__); \
	108	} while (0)
	109
3175eb9b RS	110	#define cifs_tcon_dbg_func(ratefunc, type, fmt, ...) \
	111	do { \
	112	const char *tn = ""; \
	113	if (tcon && tcon->treeName) \
	114	tn = tcon->treeName; \
	115	if ((type) & FYI && cifsFYI & CIFS_INFO) { \
	116	pr_debug_ ## ratefunc("%s: %s " fmt, \
	117	__FILE__, tn, ##__VA_ARGS__); \
	118	} else if ((type) & VFS) { \
	119	pr_err_ ## ratefunc("CIFS VFS: %s " fmt, \
	120	tn, ##__VA_ARGS__); \
	121	} else if ((type) & NOISY && (NOISY != 0)) { \
	122	pr_debug_ ## ratefunc("%s " fmt, \
	123	tn, ##__VA_ARGS__); \
	124	} \
	125	} while (0)
	126
	127	#define cifs_tcon_dbg(type, fmt, ...) \
	128	do { \
	129	if ((type) & ONCE) \
	130	cifs_tcon_dbg_func(once, \
	131	type, fmt, ##__VA_ARGS__); \
	132	else \
	133	cifs_tcon_dbg_func(ratelimited, \
	134	type, fmt, ##__VA_ARGS__); \
	135	} while (0)
	136
1da177e4 LT	137	/*
	138	* debug OFF
	139	* ---------
	140	*/
	141	#else /* _CIFS_DEBUG */
f96637be	142	#define cifs_dbg(type, fmt, ...) \
bde98197 JP	143	do { \
bde98197 JP	144	if (0) \
0b456f04	145	pr_debug(fmt, ##__VA_ARGS__); \
bde98197	146	} while (0)
9a0efecc	147
afe6f653 RS	148	#define cifs_server_dbg(type, fmt, ...) \
	149	do { \
	150	if (0) \
3175eb9b	151	pr_debug("\\\\%s " fmt, \
afe6f653 RS	152	server->hostname, ##__VA_ARGS__); \
	153	} while (0)
	154
3175eb9b RS	155	#define cifs_tcon_dbg(type, fmt, ...) \
	156	do { \
	157	if (0) \
	158	pr_debug("%s " fmt, tcon->treeName, ##__VA_ARGS__); \
	159	} while (0)
	160
9a0efecc RF	161	#define cifs_info(fmt, ...) \
	162	do { \
	163	pr_info("CIFS: "fmt, ##__VA_ARGS__); \
	164	} while (0)
f96637be	165	#endif
1da177e4 LT	166
1da177e4 LT	167	#endif /* _H_CIFS_DEBUG */