xref: /freebsd/sys/nfs/nfs_kdtrace.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2009 Robert N. M. Watson
5  * All rights reserved.
6  *
7  * This software was developed at the University of Cambridge Computer
8  * Laboratory with support from a grant from Google, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef _NFSCLIENT_NFS_KDTRACE_H_
33 #define	_NFSCLIENT_NFS_KDTRACE_H_
34 
35 #ifdef KDTRACE_HOOKS
36 #include <sys/dtrace_bsd.h>
37 
38 /*
39  * Definitions for NFS access cache probes.
40  */
41 extern uint32_t nfsclient_accesscache_flush_done_id;
42 extern uint32_t nfsclient_accesscache_get_hit_id;
43 extern uint32_t nfsclient_accesscache_get_miss_id;
44 extern uint32_t nfsclient_accesscache_load_done_id;
45 
46 #define	KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp)	do {			\
47 	if (dtrace_nfsclient_accesscache_flush_done_probe != NULL)	\
48 		(dtrace_nfsclient_accesscache_flush_done_probe)(	\
49 		    nfsclient_accesscache_flush_done_id, (vp));		\
50 } while (0)
51 
52 #define	KDTRACE_NFS_ACCESSCACHE_GET_HIT(vp, uid, mode)	do {		\
53 	if (dtrace_nfsclient_accesscache_get_hit_probe != NULL)		\
54 		(dtrace_nfsclient_accesscache_get_hit_probe)(		\
55 		    nfsclient_accesscache_get_hit_id, (vp), (uid),	\
56 		    (mode));						\
57 } while (0)
58 
59 #define	KDTRACE_NFS_ACCESSCACHE_GET_MISS(vp, uid, mode)	do {		\
60 	if (dtrace_nfsclient_accesscache_get_miss_probe != NULL)	\
61 		(dtrace_nfsclient_accesscache_get_miss_probe)(		\
62 		    nfsclient_accesscache_get_miss_id, (vp), (uid),	\
63 		    (mode));						\
64 } while (0)
65 
66 #define	KDTRACE_NFS_ACCESSCACHE_LOAD_DONE(vp, uid, rmode, error) do {	\
67 	if (dtrace_nfsclient_accesscache_load_done_probe != NULL)	\
68 		(dtrace_nfsclient_accesscache_load_done_probe)(		\
69 		    nfsclient_accesscache_load_done_id, (vp), (uid),	\
70 		    (rmode), (error));					\
71 } while (0)
72 
73 /*
74  * Definitions for NFS attribute cache probes.
75  */
76 extern uint32_t nfsclient_attrcache_flush_done_id;
77 extern uint32_t nfsclient_attrcache_get_hit_id;
78 extern uint32_t nfsclient_attrcache_get_miss_id;
79 extern uint32_t nfsclient_attrcache_load_done_id;
80 
81 #define	KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp)	do {			\
82 	if (dtrace_nfsclient_attrcache_flush_done_probe != NULL)	\
83 		(dtrace_nfsclient_attrcache_flush_done_probe)(		\
84 		    nfsclient_attrcache_flush_done_id, (vp));		\
85 } while (0)
86 
87 #define	KDTRACE_NFS_ATTRCACHE_GET_HIT(vp, vap)	do {			\
88 	if (dtrace_nfsclient_attrcache_get_hit_probe != NULL)		\
89 		(dtrace_nfsclient_attrcache_get_hit_probe)(		\
90 		    nfsclient_attrcache_get_hit_id, (vp), (vap));	\
91 } while (0)
92 
93 #define	KDTRACE_NFS_ATTRCACHE_GET_MISS(vp)	do {			\
94 	if (dtrace_nfsclient_attrcache_get_miss_probe != NULL)		\
95 		(dtrace_nfsclient_attrcache_get_miss_probe)(		\
96 			    nfsclient_attrcache_get_miss_id, (vp));	\
97 } while (0)
98 
99 #define	KDTRACE_NFS_ATTRCACHE_LOAD_DONE(vp, vap, error)	do {		\
100 	if (dtrace_nfsclient_attrcache_load_done_probe != NULL)		\
101 		(dtrace_nfsclient_attrcache_load_done_probe)(		\
102 		    nfsclient_attrcache_load_done_id, (vp), (vap),	\
103 		    (error));						\
104 } while (0)
105 
106 #else /* !KDTRACE_HOOKS */
107 
108 #define	KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp)
109 #define	KDTRACE_NFS_ACCESSCACHE_GET_HIT(vp, uid, mode)
110 #define	KDTRACE_NFS_ACCESSCACHE_GET_MISS(vp, uid, mode)
111 #define	KDTRACE_NFS_ACCESSCACHE_LOAD_DONE(vp, uid, rmode, error)
112 
113 #define	KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp)
114 #define	KDTRACE_NFS_ATTRCACHE_GET_HIT(vp, vap)
115 #define	KDTRACE_NFS_ATTRCACHE_GET_MISS(vp)
116 #define	KDTRACE_NFS_ATTRCACHE_LOAD_DONE(vp, vap, error)
117 
118 #endif /* KDTRACE_HOOKS */
119 
120 #endif /* !_NFSCLIENT_NFS_KDTRACE_H_ */
121