xref: /linux-6.15/include/linux/sunrpc/debug.h (revision dbb9c2a2)
1 /*
2  * linux/include/linux/sunrpc/debug.h
3  *
4  * Debugging support for sunrpc module
5  *
6  * Copyright (C) 1996, Olaf Kirch <[email protected]>
7  */
8 
9 #ifndef _LINUX_SUNRPC_DEBUG_H_
10 #define _LINUX_SUNRPC_DEBUG_H_
11 
12 /*
13  * RPC debug facilities
14  */
15 #define RPCDBG_XPRT		0x0001
16 #define RPCDBG_CALL		0x0002
17 #define RPCDBG_DEBUG		0x0004
18 #define RPCDBG_NFS		0x0008
19 #define RPCDBG_AUTH		0x0010
20 #define RPCDBG_BIND		0x0020
21 #define RPCDBG_SCHED		0x0040
22 #define RPCDBG_TRANS		0x0080
23 #define RPCDBG_SVCXPRT		0x0100
24 #define RPCDBG_SVCDSP		0x0200
25 #define RPCDBG_MISC		0x0400
26 #define RPCDBG_CACHE		0x0800
27 #define RPCDBG_ALL		0x7fff
28 
29 #ifdef __KERNEL__
30 
31 /*
32  * Enable RPC debugging/profiling.
33  */
34 #ifdef CONFIG_SYSCTL
35 #define  RPC_DEBUG
36 #endif
37 #ifdef CONFIG_TRACEPOINTS
38 #define RPC_TRACEPOINTS
39 #endif
40 /* #define  RPC_PROFILE */
41 
42 /*
43  * Debugging macros etc
44  */
45 #ifdef RPC_DEBUG
46 extern unsigned int		rpc_debug;
47 extern unsigned int		nfs_debug;
48 extern unsigned int		nfsd_debug;
49 extern unsigned int		nlm_debug;
50 #endif
51 
52 #define dprintk(args...)	dfprintk(FACILITY, ## args)
53 
54 #undef ifdebug
55 #ifdef RPC_DEBUG
56 # define ifdebug(fac)		if (unlikely(rpc_debug & RPCDBG_##fac))
57 # define dfprintk(fac, args...)	\
58 	do { \
59 		ifdebug(fac) \
60 			printk(KERN_DEFAULT args); \
61 	} while (0)
62 # define RPC_IFDEBUG(x)		x
63 #else
64 # define ifdebug(fac)		if (0)
65 # define dfprintk(fac, args...)	do ; while (0)
66 # define RPC_IFDEBUG(x)
67 #endif
68 
69 /*
70  * Sysctl interface for RPC debugging
71  */
72 #ifdef RPC_DEBUG
73 void		rpc_register_sysctl(void);
74 void		rpc_unregister_sysctl(void);
75 #endif
76 
77 #endif /* __KERNEL__ */
78 
79 /*
80  * Declarations for the sysctl debug interface, which allows to read or
81  * change the debug flags for rpc, nfs, nfsd, and lockd. Since the sunrpc
82  * module currently registers its sysctl table dynamically, the sysctl path
83  * for module FOO is <CTL_SUNRPC, CTL_FOODEBUG>.
84  */
85 
86 enum {
87 	CTL_RPCDEBUG = 1,
88 	CTL_NFSDEBUG,
89 	CTL_NFSDDEBUG,
90 	CTL_NLMDEBUG,
91 	CTL_SLOTTABLE_UDP,
92 	CTL_SLOTTABLE_TCP,
93 	CTL_MIN_RESVPORT,
94 	CTL_MAX_RESVPORT,
95 };
96 
97 #endif /* _LINUX_SUNRPC_DEBUG_H_ */
98