dtrace_bsd.h revision 262042 
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: stable/10/sys/sys/dtrace_bsd.h 262042 2014-02-17 12:57:13Z avg $
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: */
35struct mbuf;
36struct trapframe;
37struct thread;
38struct vattr;
39struct vnode;
40struct reg;
41struct devstat;
42struct bio;
43
44/*
45 * Cyclic clock function type definition used to hook the cyclic
46 * subsystem into the appropriate timer interrupt.
47 */
48typedef	void (*cyclic_clock_func_t)(struct trapframe *);
49extern cyclic_clock_func_t	cyclic_clock_func;
50
51void clocksource_cyc_set(const struct bintime *t);
52
53/*
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 it's handler with.
57 */
58typedef int (*dtrace_trap_func_t)(struct trapframe *, u_int);
59
60int	dtrace_trap(struct trapframe *, u_int);
61
62extern dtrace_trap_func_t	dtrace_trap_func;
63
64/* Used by the machine dependent trap() code. */
65typedef	int (*dtrace_invop_func_t)(uintptr_t, uintptr_t *, uintptr_t);
66typedef void (*dtrace_doubletrap_func_t)(void);
67
68/* Global variables in trap.c */
69extern	dtrace_invop_func_t	dtrace_invop_func;
70extern	dtrace_doubletrap_func_t	dtrace_doubletrap_func;
71
72/* Pid provider hooks */
73typedef int (*dtrace_pid_probe_ptr_t)(struct reg *);
74extern	dtrace_pid_probe_ptr_t	dtrace_pid_probe_ptr;
75typedef int (*dtrace_return_probe_ptr_t)(struct reg *);
76extern	dtrace_return_probe_ptr_t	dtrace_return_probe_ptr;
77
78/* Virtual time hook function type. */
79typedef	void (*dtrace_vtime_switch_func_t)(struct thread *);
80
81extern int			dtrace_vtime_active;
82extern dtrace_vtime_switch_func_t	dtrace_vtime_switch_func;
83
84/* The fasttrap module hooks into the fork, exit and exit. */
85typedef void (*dtrace_fork_func_t)(struct proc *, struct proc *);
86typedef void (*dtrace_execexit_func_t)(struct proc *);
87
88/* Global variable in kern_fork.c */
89extern dtrace_fork_func_t	dtrace_fasttrap_fork;
90
91/* Global variable in kern_exec.c */
92extern dtrace_execexit_func_t	dtrace_fasttrap_exec;
93
94/* Global variable in kern_exit.c */
95extern dtrace_execexit_func_t	dtrace_fasttrap_exit;
96
97/* The dtmalloc provider hooks into malloc. */
98typedef	void (*dtrace_malloc_probe_func_t)(u_int32_t, uintptr_t arg0,
99    uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
100
101extern dtrace_malloc_probe_func_t   dtrace_malloc_probe;
102
103/* dtnfsclient NFSv[34] access cache provider hooks. */
104typedef void (*dtrace_nfsclient_accesscache_flush_probe_func_t)(uint32_t,
105    struct vnode *);
106extern dtrace_nfsclient_accesscache_flush_probe_func_t
107    dtrace_nfsclient_accesscache_flush_done_probe;
108extern dtrace_nfsclient_accesscache_flush_probe_func_t
109    dtrace_nfscl_accesscache_flush_done_probe;
110
111typedef void (*dtrace_nfsclient_accesscache_get_probe_func_t)(uint32_t,
112    struct vnode *, uid_t, uint32_t);
113extern dtrace_nfsclient_accesscache_get_probe_func_t
114    dtrace_nfsclient_accesscache_get_hit_probe,
115    dtrace_nfsclient_accesscache_get_miss_probe;
116extern dtrace_nfsclient_accesscache_get_probe_func_t
117    dtrace_nfscl_accesscache_get_hit_probe,
118    dtrace_nfscl_accesscache_get_miss_probe;
119
120typedef void (*dtrace_nfsclient_accesscache_load_probe_func_t)(uint32_t,
121    struct vnode *, uid_t, uint32_t, int);
122extern dtrace_nfsclient_accesscache_load_probe_func_t
123    dtrace_nfsclient_accesscache_load_done_probe;
124extern dtrace_nfsclient_accesscache_load_probe_func_t
125    dtrace_nfscl_accesscache_load_done_probe;
126
127/* dtnfsclient NFSv[234] attribute cache provider hooks. */
128typedef void (*dtrace_nfsclient_attrcache_flush_probe_func_t)(uint32_t,
129    struct vnode *);
130extern dtrace_nfsclient_attrcache_flush_probe_func_t
131    dtrace_nfsclient_attrcache_flush_done_probe;
132extern dtrace_nfsclient_attrcache_flush_probe_func_t
133    dtrace_nfscl_attrcache_flush_done_probe;
134
135typedef void (*dtrace_nfsclient_attrcache_get_hit_probe_func_t)(uint32_t,
136    struct vnode *, struct vattr *);
137extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
138    dtrace_nfsclient_attrcache_get_hit_probe;
139extern dtrace_nfsclient_attrcache_get_hit_probe_func_t
140    dtrace_nfscl_attrcache_get_hit_probe;
141
142typedef void (*dtrace_nfsclient_attrcache_get_miss_probe_func_t)(uint32_t,
143    struct vnode *);
144extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
145    dtrace_nfsclient_attrcache_get_miss_probe;
146extern dtrace_nfsclient_attrcache_get_miss_probe_func_t
147    dtrace_nfscl_attrcache_get_miss_probe;
148
149typedef void (*dtrace_nfsclient_attrcache_load_probe_func_t)(uint32_t,
150    struct vnode *, struct vattr *, int);
151extern dtrace_nfsclient_attrcache_load_probe_func_t
152    dtrace_nfsclient_attrcache_load_done_probe;
153extern dtrace_nfsclient_attrcache_load_probe_func_t
154    dtrace_nfscl_attrcache_load_done_probe;
155
156/* dtnfsclient NFSv[234] RPC provider hooks. */
157typedef void (*dtrace_nfsclient_nfs23_start_probe_func_t)(uint32_t,
158    struct vnode *, struct mbuf *, struct ucred *, int);
159extern dtrace_nfsclient_nfs23_start_probe_func_t
160    dtrace_nfsclient_nfs23_start_probe;
161extern dtrace_nfsclient_nfs23_start_probe_func_t
162    dtrace_nfscl_nfs234_start_probe;
163
164typedef void (*dtrace_nfsclient_nfs23_done_probe_func_t)(uint32_t,
165    struct vnode *, struct mbuf *, struct ucred *, int, int);
166extern dtrace_nfsclient_nfs23_done_probe_func_t
167    dtrace_nfsclient_nfs23_done_probe;
168extern dtrace_nfsclient_nfs23_done_probe_func_t
169    dtrace_nfscl_nfs234_done_probe;
170
171/* IO Provider hooks, really hook into devstat */
172typedef void (*dtrace_io_start_probe_func_t)(uint32_t, struct bio *,
173					     struct devstat *);
174extern dtrace_io_start_probe_func_t dtrace_io_start_probe;
175
176typedef void (*dtrace_io_done_probe_func_t)(uint32_t, struct bio *,
177					    struct devstat *);
178extern dtrace_io_done_probe_func_t dtrace_io_done_probe;
179
180typedef void (*dtrace_io_wait_start_probe_func_t)(uint32_t, uintptr_t *,
181						  struct devstat *);
182extern dtrace_io_wait_start_probe_func_t dtrace_io_wait_start_probe;
183
184typedef void (*dtrace_io_wait_done_probe_func_t)(uint32_t, uintptr_t *,
185						 struct devstat *);
186extern dtrace_io_wait_done_probe_func_t dtrace_io_wait_done_probe;
187
188/*
189 * Functions which allow the dtrace module to check that the kernel
190 * hooks have been compiled with sufficient space for it's private
191 * structures.
192 */
193size_t	kdtrace_proc_size(void);
194size_t	kdtrace_thread_size(void);
195
196/*
197 * OpenSolaris compatible time functions returning nanoseconds.
198 * On OpenSolaris these return hrtime_t which we define as uint64_t.
199 */
200uint64_t	dtrace_gethrtime(void);
201uint64_t	dtrace_gethrestime(void);
202
203#endif /* _SYS_DTRACE_BSD_H */
204