2 * Copyright 2006-2008 John Birrell <jb@FreeBSD.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * Statically Defined Tracing (SDT) definitions.
36 #define _DTRACE_VERSION 1
38 #define DTRACE_PROBE(prov, name) { \
39 extern void __dtrace_##prov##___##name(void); \
40 __dtrace_##prov##___##name(); \
43 #define DTRACE_PROBE1(prov, name, arg1) { \
44 extern void __dtrace_##prov##___##name(unsigned long); \
45 __dtrace_##prov##___##name((unsigned long)arg1); \
48 #define DTRACE_PROBE2(prov, name, arg1, arg2) { \
49 extern void __dtrace_##prov##___##name(unsigned long, \
51 __dtrace_##prov##___##name((unsigned long)arg1, \
52 (unsigned long)arg2); \
55 #define DTRACE_PROBE3(prov, name, arg1, arg2, arg3) { \
56 extern void __dtrace_##prov##___##name(unsigned long, \
57 unsigned long, unsigned long); \
58 __dtrace_##prov##___##name((unsigned long)arg1, \
59 (unsigned long)arg2, (unsigned long)arg3); \
62 #define DTRACE_PROBE4(prov, name, arg1, arg2, arg3, arg4) { \
63 extern void __dtrace_##prov##___##name(unsigned long, \
64 unsigned long, unsigned long, unsigned long); \
65 __dtrace_##prov##___##name((unsigned long)arg1, \
66 (unsigned long)arg2, (unsigned long)arg3, \
67 (unsigned long)arg4); \
70 #define DTRACE_PROBE5(prov, name, arg1, arg2, arg3, arg4, arg5) { \
71 extern void __dtrace_##prov##___##name(unsigned long, \
72 unsigned long, unsigned long, unsigned long, unsigned long);\
73 __dtrace_##prov##___##name((unsigned long)arg1, \
74 (unsigned long)arg2, (unsigned long)arg3, \
75 (unsigned long)arg4, (unsigned long)arg5); \
82 #define SDT_PROVIDER_DEFINE(prov)
83 #define SDT_PROVIDER_DECLARE(prov)
84 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)
85 #define SDT_PROBE_DECLARE(prov, mod, func, name)
86 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
87 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type)
89 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)
90 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)
91 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)
92 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3)
93 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4)
95 #define SDT_PROBE0(prov, mod, func, name)
96 #define SDT_PROBE1(prov, mod, func, name, arg0)
97 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)
98 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)
99 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)
100 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
105 * This type definition must match that of dtrace_probe. It is defined this
106 * way to avoid having to rely on CDDL code.
108 typedef void (*sdt_probe_func_t)(u_int32_t, uintptr_t arg0, uintptr_t arg1,
109 uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
112 * The hook for the probe function. See kern_sdt.c which defaults this to
113 * it's own stub. The 'sdt' provider will set it to dtrace_probe when it
116 extern sdt_probe_func_t sdt_probe_func;
127 int ndx; /* Argument index. */
128 const char *type; /* Argument type string. */
129 TAILQ_ENTRY(sdt_argtype)
130 argtype_entry; /* Argument type list entry. */
132 *probe; /* Ptr to the probe structure. */
136 int version; /* Set to sizeof(struct sdt_ref). */
139 *prov; /* Ptr to the provider structure. */
140 TAILQ_ENTRY(sdt_probe)
141 probe_entry; /* SDT probe list entry. */
142 TAILQ_HEAD(argtype_list_head, sdt_argtype) argtype_list;
146 id_t id; /* DTrace probe ID. */
147 int n_args; /* Number of arguments. */
150 struct sdt_provider {
151 const char *name; /* Provider name. */
152 TAILQ_ENTRY(sdt_provider)
153 prov_entry; /* SDT provider list entry. */
154 TAILQ_HEAD(probe_list_head, sdt_probe) probe_list;
155 uintptr_t id; /* DTrace provider ID. */
158 #define SDT_PROVIDER_DEFINE(prov) \
159 struct sdt_provider sdt_provider_##prov[1] = { \
160 { #prov, { NULL, NULL }, { NULL, NULL } } \
162 SYSINIT(sdt_provider_##prov##_init, SI_SUB_KDTRACE, \
163 SI_ORDER_SECOND, sdt_provider_register, \
164 sdt_provider_##prov ); \
165 SYSUNINIT(sdt_provider_##prov##_uninit, SI_SUB_KDTRACE, \
166 SI_ORDER_SECOND, sdt_provider_deregister, \
167 sdt_provider_##prov )
169 #define SDT_PROVIDER_DECLARE(prov) \
170 extern struct sdt_provider sdt_provider_##prov[1]
172 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname) \
173 struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1] = { \
174 { sizeof(struct sdt_probe), 0, sdt_provider_##prov, \
175 { NULL, NULL }, { NULL, NULL }, #mod, #func, #sname, 0, 0 } \
177 SYSINIT(sdt_##prov##_##mod##_##func##_##name##_init, SI_SUB_KDTRACE, \
178 SI_ORDER_SECOND + 1, sdt_probe_register, \
179 sdt_##prov##_##mod##_##func##_##name ); \
180 SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##_uninit, \
181 SI_SUB_KDTRACE, SI_ORDER_SECOND + 1, sdt_probe_deregister, \
182 sdt_##prov##_##mod##_##func##_##name )
184 #define SDT_PROBE_DECLARE(prov, mod, func, name) \
185 extern struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1]
187 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
188 if (sdt_##prov##_##mod##_##func##_##name->id) \
189 (*sdt_probe_func)(sdt_##prov##_##mod##_##func##_##name->id, \
190 (uintptr_t) arg0, (uintptr_t) arg1, (uintptr_t) arg2, \
191 (uintptr_t) arg3, (uintptr_t) arg4)
193 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type) \
194 struct sdt_argtype sdt_##prov##_##mod##_##func##_##name##num[1] \
195 = { { num, type, { NULL, NULL }, \
196 sdt_##prov##_##mod##_##func##_##name } \
198 SYSINIT(sdt_##prov##_##mod##_##func##_##name##num##_init, \
199 SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_register, \
200 sdt_##prov##_##mod##_##func##_##name##num ); \
201 SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##num##_uninit, \
202 SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_deregister, \
203 sdt_##prov##_##mod##_##func##_##name##num )
205 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0) \
206 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
207 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0)
209 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1) \
210 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
211 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
212 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1)
214 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)\
215 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
216 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
217 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
218 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2)
220 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3) \
221 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
222 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
223 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
224 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2); \
225 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3)
227 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4) \
228 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
229 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
230 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
231 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2); \
232 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3); \
233 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4)
235 #define SDT_PROBE0(prov, mod, func, name) \
236 SDT_PROBE(prov, mod, func, name, 0, 0, 0, 0, 0)
237 #define SDT_PROBE1(prov, mod, func, name, arg0) \
238 SDT_PROBE(prov, mod, func, name, arg0, 0, 0, 0, 0)
239 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1) \
240 SDT_PROBE(prov, mod, func, name, arg0, arg1, 0, 0, 0)
241 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2) \
242 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, 0, 0)
243 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3) \
244 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, 0)
245 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
246 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
248 typedef int (*sdt_argtype_listall_func_t)(struct sdt_argtype *, void *);
249 typedef int (*sdt_probe_listall_func_t)(struct sdt_probe *, void *);
250 typedef int (*sdt_provider_listall_func_t)(struct sdt_provider *, void *);
252 void sdt_argtype_deregister(void *);
253 void sdt_argtype_register(void *);
254 void sdt_probe_deregister(void *);
255 void sdt_probe_register(void *);
256 void sdt_provider_deregister(void *);
257 void sdt_provider_register(void *);
258 void sdt_probe_stub(u_int32_t, uintptr_t arg0, uintptr_t arg1, uintptr_t arg2,
259 uintptr_t arg3, uintptr_t arg4);
260 int sdt_argtype_listall(struct sdt_probe *, sdt_argtype_listall_func_t, void *);
261 int sdt_probe_listall(struct sdt_provider *, sdt_probe_listall_func_t, void *);
262 int sdt_provider_listall(sdt_provider_listall_func_t,void *);
264 void sdt_register_callbacks(sdt_provider_listall_func_t, void *,
265 sdt_provider_listall_func_t, void *, sdt_probe_listall_func_t, void *);
266 void sdt_deregister_callbacks(void);
268 #endif /* KDTRACE_HOOKS */
272 #endif /* _SYS_SDT_H */