xref: /linux-6.15/include/linux/sunrpc/debug.h (revision a509050b)
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_PMAP		0x0020
21 #define RPCDBG_BIND		0x0020
22 #define RPCDBG_SCHED		0x0040
23 #define RPCDBG_TRANS		0x0080
24 #define RPCDBG_SVCSOCK		0x0100
25 #define RPCDBG_SVCDSP		0x0200
26 #define RPCDBG_MISC		0x0400
27 #define RPCDBG_CACHE		0x0800
28 #define RPCDBG_ALL		0x7fff
29 
30 #ifdef __KERNEL__
31 
32 #include <linux/timer.h>
33 #include <linux/workqueue.h>
34 
35 /*
36  * Enable RPC debugging/profiling.
37  */
38 #ifdef CONFIG_SYSCTL
39 #define  RPC_DEBUG
40 #endif
41 /* #define  RPC_PROFILE */
42 
43 /*
44  * Debugging macros etc
45  */
46 #ifdef RPC_DEBUG
47 extern unsigned int		rpc_debug;
48 extern unsigned int		nfs_debug;
49 extern unsigned int		nfsd_debug;
50 extern unsigned int		nlm_debug;
51 #endif
52 
53 #define dprintk(args...)	dfprintk(FACILITY, ## args)
54 
55 #undef ifdebug
56 #ifdef RPC_DEBUG
57 # define ifdebug(fac)		if (unlikely(rpc_debug & RPCDBG_##fac))
58 # define dfprintk(fac, args...)	do { ifdebug(fac) printk(args); } while(0)
59 # define RPC_IFDEBUG(x)		x
60 #else
61 # define ifdebug(fac)		if (0)
62 # define dfprintk(fac, args...)	do ; while (0)
63 # define RPC_IFDEBUG(x)
64 #endif
65 
66 /*
67  * Sysctl interface for RPC debugging
68  */
69 #ifdef RPC_DEBUG
70 void		rpc_register_sysctl(void);
71 void		rpc_unregister_sysctl(void);
72 #endif
73 
74 #endif /* __KERNEL__ */
75 
76 /*
77  * Declarations for the sysctl debug interface, which allows to read or
78  * change the debug flags for rpc, nfs, nfsd, and lockd. Since the sunrpc
79  * module currently registers its sysctl table dynamically, the sysctl path
80  * for module FOO is <CTL_SUNRPC, CTL_FOODEBUG>.
81  */
82 
83 enum {
84 	CTL_RPCDEBUG = 1,
85 	CTL_NFSDEBUG,
86 	CTL_NFSDDEBUG,
87 	CTL_NLMDEBUG,
88 	CTL_SLOTTABLE_UDP,
89 	CTL_SLOTTABLE_TCP,
90 	CTL_MIN_RESVPORT,
91 	CTL_MAX_RESVPORT,
92 };
93 
94 #endif /* _LINUX_SUNRPC_DEBUG_H_ */
95