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

/*
 *
 *   Copyright (c) International Business Machines  Corp., 2000,2002
 *   Modified by Steve French (sfrench@us.ibm.com)
 *
 *   This program is free software;  you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 *   the GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program;  if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
*/

#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)

/*
 *	debug OFF
 *	---------
 */
#else		/* _CIFS_DEBUG */
#define cifs_dbg(type, fmt, ...)					\
do {									\
	if (0)								\
		pr_debug(fmt, ##__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
1da177e4 LT	1	/*
	2	*
	3	* Copyright (c) International Business Machines Corp., 2000,2002
	4	* Modified by Steve French (sfrench@us.ibm.com)
	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 as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
	14	* the GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*
	20	*/
1da177e4 LT	21
	22	#ifndef _H_CIFS_DEBUG
	23	#define _H_CIFS_DEBUG
	24
	25	void cifs_dump_mem(char label, void data, int length);
14547f7d	26	void cifs_dump_detail(void buf, struct TCP_Server_Info ptcp_info);
3979877e	27	void cifs_dump_mids(struct TCP_Server_Info *);
1404297e	28	extern bool traceSMB; /* flag which enables the function below */
792af7b0	29	void dump_smb(void *, int);
1047abc1	30	#define CIFS_INFO 0x01
13cd4b7f	31	#define CIFS_RC 0x02
1047abc1	32	#define CIFS_TIMER 0x04
1da177e4	33
f96637be JP	34	#define VFS 1
f96637be JP	35	#define FYI 2
bde98197	36	extern int cifsFYI;
f96637be JP	37	#ifdef CONFIG_CIFS_DEBUG2
	38	#define NOISY 4
	39	#else
	40	#define NOISY 0
	41	#endif
f2f176b4	42	#define ONCE 8
bde98197	43
1da177e4 LT	44	/*
	45	* debug ON
	46	* --------
	47	*/
471b1f98	48	#ifdef CONFIG_CIFS_DEBUG
1da177e4	49
8c1beb98 SF	50
	51	/*
	52	* When adding tracepoints and debug messages we have various choices.
	53	* Some considerations:
	54	*
	55	* Use cifs_dbg(VFS, ...) for things we always want logged, and the user to see
	56	* cifs_info(...) slightly less important, admin can filter via loglevel > 6
	57	* cifs_dbg(FYI, ...) minor debugging messages, off by default
	58	* trace_smb3_* ftrace functions are preferred for complex debug messages
	59	* intended for developers or experienced admins, off by default
	60	*/
	61
9a0efecc RF	62	/* Information level messages, minor events */
	63	#define cifs_info_func(ratefunc, fmt, ...) \
	64	do { \
	65	pr_info_ ## ratefunc("CIFS: " fmt, ##__VA_ARGS__); \
	66	} while (0)
	67
	68	#define cifs_info(fmt, ...) \
	69	do { \
	70	cifs_info_func(ratelimited, fmt, ##__VA_ARGS__); \
	71	} while (0)
	72
f96637be	73	/* information message: e.g., configuration, major event */
f2f176b4 AA	74	#define cifs_dbg_func(ratefunc, type, fmt, ...) \
	75	do { \
	76	if ((type) & FYI && cifsFYI & CIFS_INFO) { \
	77	pr_debug_ ## ratefunc("%s: " \
	78	fmt, __FILE__, ##__VA_ARGS__); \
	79	} else if ((type) & VFS) { \
596632de	80	pr_err_ ## ratefunc("CIFS VFS: " \
f2f176b4 AA	81	fmt, ##__VA_ARGS__); \
	82	} else if ((type) & NOISY && (NOISY != 0)) { \
	83	pr_debug_ ## ratefunc(fmt, ##__VA_ARGS__); \
	84	} \
	85	} while (0)
	86
	87	#define cifs_dbg(type, fmt, ...) \
	88	do { \
	89	if ((type) & ONCE) \
	90	cifs_dbg_func(once, \
	91	type, fmt, ##__VA_ARGS__); \
	92	else \
	93	cifs_dbg_func(ratelimited, \
	94	type, fmt, ##__VA_ARGS__); \
b6b38f70	95	} while (0)
1da177e4 LT	96
	97	/*
	98	* debug OFF
	99	* ---------
	100	*/
	101	#else /* _CIFS_DEBUG */
f96637be	102	#define cifs_dbg(type, fmt, ...) \
bde98197 JP	103	do { \
bde98197 JP	104	if (0) \
0b456f04	105	pr_debug(fmt, ##__VA_ARGS__); \
bde98197	106	} while (0)
9a0efecc RF	107
	108	#define cifs_info(fmt, ...) \
	109	do { \
	110	pr_info("CIFS: "fmt, ##__VA_ARGS__); \
	111	} while (0)
f96637be	112	#endif
1da177e4 LT	113
1da177e4 LT	114	#endif /* _H_CIFS_DEBUG */