xref: /freebsd/sys/sys/dtrace_bsd.h (revision 5b9c547c)
1 /*-
2  * Copyright (c) 2007-2008 John Birrell (jb@freebsd.org)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  *
28  * This file contains BSD shims for Sun's DTrace code.
29  */
30 
31 #ifndef _SYS_DTRACE_BSD_H
32 #define	_SYS_DTRACE_BSD_H
33 
34 /* Forward definitions: */
35 struct mbuf;
36 struct trapframe;
37 struct thread;
38 struct vattr;
39 struct vnode;
40 struct reg;
41 
42 int dtrace_trap(struct trapframe *, u_int);
43 
44 /*
45  * The dtrace module handles traps that occur during a DTrace probe.
46  * This type definition is used in the trap handler to provide a
47  * hook for the dtrace module to register its handler with.
48  */
49 typedef int (*dtrace_trap_func_t)(struct trapframe *, u_int);
50 extern dtrace_trap_func_t	dtrace_trap_func;
51 
52 /*
53  * A hook which removes active FBT probes before executing the double fault
54  * handler. We want to ensure that DTrace doesn't trigger another trap, which
55  * would result in a reset.
56  */
57 typedef void (*dtrace_doubletrap_func_t)(void);
58 extern	dtrace_doubletrap_func_t	dtrace_doubletrap_func;
59 
60 /* Pid provider hooks */
61 typedef int (*dtrace_pid_probe_ptr_t)(struct reg *);
62 extern	dtrace_pid_probe_ptr_t	dtrace_pid_probe_ptr;
63 typedef int (*dtrace_return_probe_ptr_t)(struct reg *);
64 extern	dtrace_return_probe_ptr_t	dtrace_return_probe_ptr;
65 
66 /* Virtual time hook function type. */
67 typedef	void (*dtrace_vtime_switch_func_t)(struct thread *);
68 
69 extern int			dtrace_vtime_active;
70 extern dtrace_vtime_switch_func_t	dtrace_vtime_switch_func;
71 
72 /* The fasttrap module hooks into the fork, exit and exit. */
73 typedef void (*dtrace_fork_func_t)(struct proc *, struct proc *);
74 typedef void (*dtrace_execexit_func_t)(struct proc *);
75 
76 /* Global variable in kern_fork.c */
77 extern dtrace_fork_func_t	dtrace_fasttrap_fork;
78 
79 /* Global variable in kern_exec.c */
80 extern dtrace_execexit_func_t	dtrace_fasttrap_exec;
81 
82 /* Global variable in kern_exit.c */
83 extern dtrace_execexit_func_t	dtrace_fasttrap_exit;
84 
85 /* The dtmalloc provider hooks into malloc. */
86 typedef	void (*dtrace_malloc_probe_func_t)(u_int32_t, uintptr_t arg0,
87     uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
88 
89 extern dtrace_malloc_probe_func_t   dtrace_malloc_probe;
90 
91 /* dtnfsclient NFSv[34] access cache provider hooks. */
92 typedef void (*dtrace_nfsclient_accesscache_flush_probe_func_t)(uint32_t,
93     struct vnode *);
94 extern dtrace_nfsclient_accesscache_flush_probe_func_t
95     dtrace_nfsclient_accesscache_flush_done_probe;
96 extern dtrace_nfsclient_accesscache_flush_probe_func_t
97     dtrace_nfscl_accesscache_flush_done_probe;
98 
99 typedef void (*dtrace_nfsclient_accesscache_get_probe_func_t)(uint32_t,
100     struct vnode *, uid_t, uint32_t);
101 extern dtrace_nfsclient_accesscache_get_probe_func_t
102     dtrace_nfsclient_accesscache_get_hit_probe,
103     dtrace_nfsclient_accesscache_get_miss_probe;
104 extern dtrace_nfsclient_accesscache_get_probe_func_t
105     dtrace_nfscl_accesscache_get_hit_probe,
106     dtrace_nfscl_accesscache_get_miss_probe;
107 
108 typedef void (*dtrace_nfsclient_accesscache_load_probe_func_t)(uint32_t,
109     struct vnode *, uid_t, uint32_t, int);
110 extern dtrace_nfsclient_accesscache_load_probe_func_t
111     dtrace_nfsclient_accesscache_load_done_probe;
112 extern dtrace_nfsclient_accesscache_load_probe_func_t
113     dtrace_nfscl_accesscache_load_done_probe;
114 
115 /* dtnfsclient NFSv[234] attribute cache provider hooks. */
116 typedef void (*dtrace_nfsclient_attrcache_flush_probe_func_t)(uint32_t,
117     struct vnode *);
118 extern dtrace_nfsclient_attrcache_flush_probe_func_t
119     dtrace_nfsclient_attrcache_flush_done_probe;
120 extern dtrace_nfsclient_attrcache_flush_probe_func_t
121     dtrace_nfscl_attrcache_flush_done_probe;
122 
123 typedef void (*dtrace_nfsclient_attrcache_get_hit_probe_func_t)(uint32_t,
124     struct vnode *, struct vattr *);
125 extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
126     dtrace_nfsclient_attrcache_get_hit_probe;
127 extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
128     dtrace_nfscl_attrcache_get_hit_probe;
129 
130 typedef void (*dtrace_nfsclient_attrcache_get_miss_probe_func_t)(uint32_t,
131     struct vnode *);
132 extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
133     dtrace_nfsclient_attrcache_get_miss_probe;
134 extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
135     dtrace_nfscl_attrcache_get_miss_probe;
136 
137 typedef void (*dtrace_nfsclient_attrcache_load_probe_func_t)(uint32_t,
138     struct vnode *, struct vattr *, int);
139 extern dtrace_nfsclient_attrcache_load_probe_func_t
140     dtrace_nfsclient_attrcache_load_done_probe;
141 extern dtrace_nfsclient_attrcache_load_probe_func_t
142     dtrace_nfscl_attrcache_load_done_probe;
143 
144 /* dtnfsclient NFSv[234] RPC provider hooks. */
145 typedef void (*dtrace_nfsclient_nfs23_start_probe_func_t)(uint32_t,
146     struct vnode *, struct mbuf *, struct ucred *, int);
147 extern dtrace_nfsclient_nfs23_start_probe_func_t
148     dtrace_nfsclient_nfs23_start_probe;
149 extern dtrace_nfsclient_nfs23_start_probe_func_t
150     dtrace_nfscl_nfs234_start_probe;
151 
152 typedef void (*dtrace_nfsclient_nfs23_done_probe_func_t)(uint32_t,
153     struct vnode *, struct mbuf *, struct ucred *, int, int);
154 extern dtrace_nfsclient_nfs23_done_probe_func_t
155     dtrace_nfsclient_nfs23_done_probe;
156 extern dtrace_nfsclient_nfs23_done_probe_func_t
157     dtrace_nfscl_nfs234_done_probe;
158 
159 /*
160  * Functions which allow the dtrace module to check that the kernel
161  * hooks have been compiled with sufficient space for it's private
162  * structures.
163  */
164 size_t	kdtrace_proc_size(void);
165 size_t	kdtrace_thread_size(void);
166 
167 /*
168  * OpenSolaris compatible time functions returning nanoseconds.
169  * On OpenSolaris these return hrtime_t which we define as uint64_t.
170  */
171 uint64_t	dtrace_gethrtime(void);
172 uint64_t	dtrace_gethrestime(void);
173 
174 #endif /* _SYS_DTRACE_BSD_H */
175