2 * Copyright (c) 2007-2008 John Birrell (jb@freebsd.org)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
28 * This file contains BSD shims for Sun's DTrace code.
31 #ifndef _SYS_DTRACE_BSD_H
32 #define _SYS_DTRACE_BSD_H
34 /* Forward definitions: */
43 * Cyclic clock function type definition used to hook the cyclic
44 * subsystem into the appropriate timer interrupt.
46 typedef void (*cyclic_clock_func_t)(struct trapframe *);
47 extern cyclic_clock_func_t cyclic_clock_func;
49 void clocksource_cyc_set(const struct bintime *t);
51 int dtrace_trap(struct trapframe *);
54 * The dtrace module handles traps that occur during a DTrace probe.
55 * This type definition is used in the trap handler to provide a
56 * hook for the dtrace module to register its handler with.
58 typedef int (*dtrace_trap_func_t)(struct trapframe *);
59 extern dtrace_trap_func_t dtrace_trap_func;
62 * A hook which removes active FBT probes before executing the double fault
63 * handler. We want to ensure that DTrace doesn't trigger another trap, which
64 * would result in a reset.
66 typedef void (*dtrace_doubletrap_func_t)(void);
67 extern dtrace_doubletrap_func_t dtrace_doubletrap_func;
69 /* Pid provider hooks */
70 typedef int (*dtrace_pid_probe_ptr_t)(struct reg *);
71 extern dtrace_pid_probe_ptr_t dtrace_pid_probe_ptr;
72 typedef int (*dtrace_return_probe_ptr_t)(struct reg *);
73 extern dtrace_return_probe_ptr_t dtrace_return_probe_ptr;
75 /* Virtual time hook function type. */
76 typedef void (*dtrace_vtime_switch_func_t)(struct thread *);
78 extern int dtrace_vtime_active;
79 extern dtrace_vtime_switch_func_t dtrace_vtime_switch_func;
81 /* The fasttrap module hooks into the fork, exit and exit. */
82 typedef void (*dtrace_fork_func_t)(struct proc *, struct proc *);
83 typedef void (*dtrace_execexit_func_t)(struct proc *);
85 /* Global variable in kern_fork.c */
86 extern dtrace_fork_func_t dtrace_fasttrap_fork;
88 /* Global variable in kern_exec.c */
89 extern dtrace_execexit_func_t dtrace_fasttrap_exec;
91 /* Global variable in kern_exit.c */
92 extern dtrace_execexit_func_t dtrace_fasttrap_exit;
94 /* The dtmalloc provider hooks into malloc. */
95 typedef void (*dtrace_malloc_probe_func_t)(u_int32_t, uintptr_t arg0,
96 uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
98 extern dtrace_malloc_probe_func_t dtrace_malloc_probe;
100 /* dtnfsclient NFSv[34] access cache provider hooks. */
101 typedef void (*dtrace_nfsclient_accesscache_flush_probe_func_t)(uint32_t,
103 extern dtrace_nfsclient_accesscache_flush_probe_func_t
104 dtrace_nfsclient_accesscache_flush_done_probe;
105 extern dtrace_nfsclient_accesscache_flush_probe_func_t
106 dtrace_nfscl_accesscache_flush_done_probe;
108 typedef void (*dtrace_nfsclient_accesscache_get_probe_func_t)(uint32_t,
109 struct vnode *, uid_t, uint32_t);
110 extern dtrace_nfsclient_accesscache_get_probe_func_t
111 dtrace_nfsclient_accesscache_get_hit_probe,
112 dtrace_nfsclient_accesscache_get_miss_probe;
113 extern dtrace_nfsclient_accesscache_get_probe_func_t
114 dtrace_nfscl_accesscache_get_hit_probe,
115 dtrace_nfscl_accesscache_get_miss_probe;
117 typedef void (*dtrace_nfsclient_accesscache_load_probe_func_t)(uint32_t,
118 struct vnode *, uid_t, uint32_t, int);
119 extern dtrace_nfsclient_accesscache_load_probe_func_t
120 dtrace_nfsclient_accesscache_load_done_probe;
121 extern dtrace_nfsclient_accesscache_load_probe_func_t
122 dtrace_nfscl_accesscache_load_done_probe;
124 /* dtnfsclient NFSv[234] attribute cache provider hooks. */
125 typedef void (*dtrace_nfsclient_attrcache_flush_probe_func_t)(uint32_t,
127 extern dtrace_nfsclient_attrcache_flush_probe_func_t
128 dtrace_nfsclient_attrcache_flush_done_probe;
129 extern dtrace_nfsclient_attrcache_flush_probe_func_t
130 dtrace_nfscl_attrcache_flush_done_probe;
132 typedef void (*dtrace_nfsclient_attrcache_get_hit_probe_func_t)(uint32_t,
133 struct vnode *, struct vattr *);
134 extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
135 dtrace_nfsclient_attrcache_get_hit_probe;
136 extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
137 dtrace_nfscl_attrcache_get_hit_probe;
139 typedef void (*dtrace_nfsclient_attrcache_get_miss_probe_func_t)(uint32_t,
141 extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
142 dtrace_nfsclient_attrcache_get_miss_probe;
143 extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
144 dtrace_nfscl_attrcache_get_miss_probe;
146 typedef void (*dtrace_nfsclient_attrcache_load_probe_func_t)(uint32_t,
147 struct vnode *, struct vattr *, int);
148 extern dtrace_nfsclient_attrcache_load_probe_func_t
149 dtrace_nfsclient_attrcache_load_done_probe;
150 extern dtrace_nfsclient_attrcache_load_probe_func_t
151 dtrace_nfscl_attrcache_load_done_probe;
153 /* dtnfsclient NFSv[234] RPC provider hooks. */
154 typedef void (*dtrace_nfsclient_nfs23_start_probe_func_t)(uint32_t,
155 struct vnode *, struct mbuf *, struct ucred *, int);
156 extern dtrace_nfsclient_nfs23_start_probe_func_t
157 dtrace_nfsclient_nfs23_start_probe;
158 extern dtrace_nfsclient_nfs23_start_probe_func_t
159 dtrace_nfscl_nfs234_start_probe;
161 typedef void (*dtrace_nfsclient_nfs23_done_probe_func_t)(uint32_t,
162 struct vnode *, struct mbuf *, struct ucred *, int, int);
163 extern dtrace_nfsclient_nfs23_done_probe_func_t
164 dtrace_nfsclient_nfs23_done_probe;
165 extern dtrace_nfsclient_nfs23_done_probe_func_t
166 dtrace_nfscl_nfs234_done_probe;
169 * Functions which allow the dtrace module to check that the kernel
170 * hooks have been compiled with sufficient space for it's private
173 size_t kdtrace_proc_size(void);
174 size_t kdtrace_thread_size(void);
177 * OpenSolaris compatible time functions returning nanoseconds.
178 * On OpenSolaris these return hrtime_t which we define as uint64_t.
180 uint64_t dtrace_gethrtime(void);
181 uint64_t dtrace_gethrestime(void);
183 #endif /* _SYS_DTRACE_BSD_H */