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_DEFINE0(prov, mod, func, name, sname)
90 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)
91 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)
92 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)
93 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3)
94 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4)
95 #define SDT_PROBE_DEFINE6(prov, mod, func, name, snamp, arg0, arg1, arg2, \
97 #define SDT_PROBE_DEFINE7(prov, mod, func, name, snamp, arg0, arg1, arg2, \
98 arg3, arg4, arg5, arg6)
100 #define SDT_PROBE0(prov, mod, func, name)
101 #define SDT_PROBE1(prov, mod, func, name, arg0)
102 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)
103 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)
104 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)
105 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
106 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5)
107 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5, \
113 * This type definition must match that of dtrace_probe. It is defined this
114 * way to avoid having to rely on CDDL code.
116 typedef void (*sdt_probe_func_t)(u_int32_t, uintptr_t arg0, uintptr_t arg1,
117 uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
120 * The hook for the probe function. See kern_sdt.c which defaults this to
121 * it's own stub. The 'sdt' provider will set it to dtrace_probe when it
124 extern sdt_probe_func_t sdt_probe_func;
135 int ndx; /* Argument index. */
136 const char *type; /* Argument type string. */
137 TAILQ_ENTRY(sdt_argtype)
138 argtype_entry; /* Argument type list entry. */
140 *probe; /* Ptr to the probe structure. */
144 int version; /* Set to sizeof(struct sdt_ref). */
147 *prov; /* Ptr to the provider structure. */
148 TAILQ_ENTRY(sdt_probe)
149 probe_entry; /* SDT probe list entry. */
150 TAILQ_HEAD(argtype_list_head, sdt_argtype) argtype_list;
154 id_t id; /* DTrace probe ID. */
155 int n_args; /* Number of arguments. */
158 struct sdt_provider {
159 const char *name; /* Provider name. */
160 TAILQ_ENTRY(sdt_provider)
161 prov_entry; /* SDT provider list entry. */
162 TAILQ_HEAD(probe_list_head, sdt_probe) probe_list;
163 uintptr_t id; /* DTrace provider ID. */
166 #define SDT_PROVIDER_DEFINE(prov) \
167 struct sdt_provider sdt_provider_##prov[1] = { \
168 { #prov, { NULL, NULL }, { NULL, NULL } } \
170 SYSINIT(sdt_provider_##prov##_init, SI_SUB_KDTRACE, \
171 SI_ORDER_SECOND, sdt_provider_register, \
172 sdt_provider_##prov ); \
173 SYSUNINIT(sdt_provider_##prov##_uninit, SI_SUB_KDTRACE, \
174 SI_ORDER_SECOND, sdt_provider_deregister, \
175 sdt_provider_##prov )
177 #define SDT_PROVIDER_DECLARE(prov) \
178 extern struct sdt_provider sdt_provider_##prov[1]
180 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname) \
181 struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1] = { \
182 { sizeof(struct sdt_probe), 0, sdt_provider_##prov, \
183 { NULL, NULL }, { NULL, NULL }, #mod, #func, #sname, 0, 0 } \
185 SYSINIT(sdt_##prov##_##mod##_##func##_##name##_init, SI_SUB_KDTRACE, \
186 SI_ORDER_SECOND + 1, sdt_probe_register, \
187 sdt_##prov##_##mod##_##func##_##name ); \
188 SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##_uninit, \
189 SI_SUB_KDTRACE, SI_ORDER_SECOND + 1, sdt_probe_deregister, \
190 sdt_##prov##_##mod##_##func##_##name )
192 #define SDT_PROBE_DECLARE(prov, mod, func, name) \
193 extern struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1]
195 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) do { \
196 if (sdt_##prov##_##mod##_##func##_##name->id) \
197 (*sdt_probe_func)(sdt_##prov##_##mod##_##func##_##name->id, \
198 (uintptr_t) arg0, (uintptr_t) arg1, (uintptr_t) arg2, \
199 (uintptr_t) arg3, (uintptr_t) arg4); \
202 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type) \
203 static struct sdt_argtype sdt_##prov##_##mod##_##func##_##name##num[1] \
204 = { { num, type, { NULL, NULL }, \
205 sdt_##prov##_##mod##_##func##_##name } \
207 SYSINIT(sdt_##prov##_##mod##_##func##_##name##num##_init, \
208 SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_register, \
209 sdt_##prov##_##mod##_##func##_##name##num ); \
210 SYSUNINIT(sdt_##prov##_##mod##_##func##_##name##num##_uninit, \
211 SI_SUB_KDTRACE, SI_ORDER_SECOND + 2, sdt_argtype_deregister, \
212 sdt_##prov##_##mod##_##func##_##name##num )
214 #define SDT_PROBE_DEFINE0(prov, mod, func, name, sname) \
215 SDT_PROBE_DEFINE(prov, mod, func, name, sname)
217 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0) \
218 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
219 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0)
221 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1) \
222 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
223 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
224 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1)
226 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)\
227 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
228 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
229 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
230 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2)
232 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3) \
233 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
234 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
235 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
236 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2); \
237 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3)
239 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4) \
240 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
241 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
242 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
243 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2); \
244 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3); \
245 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4)
247 #define SDT_PROBE_DEFINE6(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
249 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
250 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
251 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
252 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2); \
253 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3); \
254 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4); \
255 SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5);
257 #define SDT_PROBE_DEFINE7(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
259 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
260 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0); \
261 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1); \
262 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2); \
263 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3); \
264 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4); \
265 SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5); \
266 SDT_PROBE_ARGTYPE(prov, mod, func, name, 6, arg6);
268 #define SDT_PROBE0(prov, mod, func, name) \
269 SDT_PROBE(prov, mod, func, name, 0, 0, 0, 0, 0)
270 #define SDT_PROBE1(prov, mod, func, name, arg0) \
271 SDT_PROBE(prov, mod, func, name, arg0, 0, 0, 0, 0)
272 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1) \
273 SDT_PROBE(prov, mod, func, name, arg0, arg1, 0, 0, 0)
274 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2) \
275 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, 0, 0)
276 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3) \
277 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, 0)
278 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
279 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
280 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5) \
282 if (sdt_##prov##_##mod##_##func##_##name->id) \
283 (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
284 uintptr_t, uintptr_t, uintptr_t))sdt_probe_func)( \
285 sdt_##prov##_##mod##_##func##_##name->id, \
286 (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
287 (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5);\
289 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5, \
292 if (sdt_##prov##_##mod##_##func##_##name->id) \
293 (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
294 uintptr_t, uintptr_t, uintptr_t, uintptr_t)) \
296 sdt_##prov##_##mod##_##func##_##name->id, \
297 (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
298 (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5, \
302 typedef int (*sdt_argtype_listall_func_t)(struct sdt_argtype *, void *);
303 typedef int (*sdt_probe_listall_func_t)(struct sdt_probe *, void *);
304 typedef int (*sdt_provider_listall_func_t)(struct sdt_provider *, void *);
306 void sdt_argtype_deregister(void *);
307 void sdt_argtype_register(void *);
308 void sdt_probe_deregister(void *);
309 void sdt_probe_register(void *);
310 void sdt_provider_deregister(void *);
311 void sdt_provider_register(void *);
312 void sdt_probe_stub(u_int32_t, uintptr_t arg0, uintptr_t arg1, uintptr_t arg2,
313 uintptr_t arg3, uintptr_t arg4);
314 int sdt_argtype_listall(struct sdt_probe *, sdt_argtype_listall_func_t, void *);
315 int sdt_probe_listall(struct sdt_provider *, sdt_probe_listall_func_t, void *);
316 int sdt_provider_listall(sdt_provider_listall_func_t,void *);
318 void sdt_register_callbacks(sdt_provider_listall_func_t, void *,
319 sdt_provider_listall_func_t, void *, sdt_probe_listall_func_t, void *);
320 void sdt_deregister_callbacks(void);
322 #endif /* KDTRACE_HOOKS */
326 #endif /* _SYS_SDT_H */