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); \
80 #include <sys/cdefs.h>
81 #include <sys/linker_set.h>
85 #define SDT_PROVIDER_DEFINE(prov)
86 #define SDT_PROVIDER_DECLARE(prov)
87 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname)
88 #define SDT_PROBE_DECLARE(prov, mod, func, name)
89 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
90 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type, xtype)
92 #define SDT_PROBE_DEFINE0(prov, mod, func, name, sname)
93 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0)
94 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1)
95 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)
96 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3)
97 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4)
98 #define SDT_PROBE_DEFINE6(prov, mod, func, name, snamp, arg0, arg1, arg2, \
100 #define SDT_PROBE_DEFINE7(prov, mod, func, name, snamp, arg0, arg1, arg2, \
101 arg3, arg4, arg5, arg6)
103 #define SDT_PROBE0(prov, mod, func, name)
104 #define SDT_PROBE1(prov, mod, func, name, arg0)
105 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1)
106 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2)
107 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3)
108 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
109 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5)
110 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5, \
113 #define SDT_PROBE_DEFINE0_XLATE(prov, mod, func, name, sname)
114 #define SDT_PROBE_DEFINE1_XLATE(prov, mod, func, name, sname, arg0, xarg0)
115 #define SDT_PROBE_DEFINE2_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
117 #define SDT_PROBE_DEFINE3_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
118 arg1, xarg1, arg2, xarg2)
119 #define SDT_PROBE_DEFINE4_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
120 arg1, xarg1, arg2, xarg2, arg3, xarg3)
121 #define SDT_PROBE_DEFINE5_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
122 arg1, xarg1, arg2, xarg2, arg3, xarg3, arg4, xarg4)
123 #define SDT_PROBE_DEFINE6_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
124 arg1, xarg1, arg2, xarg2, arg3, xarg3, arg4, xarg4, arg5, xarg5)
125 #define SDT_PROBE_DEFINE7_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
126 arg1, xarg1, arg2, xarg2, arg3, xarg3, arg4, xarg4, arg5, xarg5, arg6, \
131 SET_DECLARE(sdt_providers_set, struct sdt_provider);
132 SET_DECLARE(sdt_probes_set, struct sdt_probe);
133 SET_DECLARE(sdt_argtypes_set, struct sdt_argtype);
135 #define SDT_PROVIDER_DEFINE(prov) \
136 struct sdt_provider sdt_provider_##prov[1] = { \
137 { #prov, { NULL, NULL }, { NULL, NULL }, 0, 0 } \
139 DATA_SET(sdt_providers_set, sdt_provider_##prov);
141 #define SDT_PROVIDER_DECLARE(prov) \
142 extern struct sdt_provider sdt_provider_##prov[1]
144 #define SDT_PROBE_DEFINE(prov, mod, func, name, sname) \
145 struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1] = { \
146 { sizeof(struct sdt_probe), sdt_provider_##prov, \
147 { NULL, NULL }, { NULL, NULL }, #mod, #func, #sname, 0, 0, \
150 DATA_SET(sdt_probes_set, sdt_##prov##_##mod##_##func##_##name);
152 #define SDT_PROBE_DECLARE(prov, mod, func, name) \
153 extern struct sdt_probe sdt_##prov##_##mod##_##func##_##name[1]
155 #define SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) do { \
156 if (sdt_##prov##_##mod##_##func##_##name->id) \
157 (*sdt_probe_func)(sdt_##prov##_##mod##_##func##_##name->id, \
158 (uintptr_t) arg0, (uintptr_t) arg1, (uintptr_t) arg2, \
159 (uintptr_t) arg3, (uintptr_t) arg4); \
162 #define SDT_PROBE_ARGTYPE(prov, mod, func, name, num, type, xtype) \
163 static struct sdt_argtype sdta_##prov##_##mod##_##func##_##name##num[1] \
164 = { { num, type, xtype, { NULL, NULL }, \
165 sdt_##prov##_##mod##_##func##_##name } \
167 DATA_SET(sdt_argtypes_set, sdta_##prov##_##mod##_##func##_##name##num);
169 #define SDT_PROBE_DEFINE0(prov, mod, func, name, sname) \
170 SDT_PROBE_DEFINE(prov, mod, func, name, sname)
172 #define SDT_PROBE_DEFINE1(prov, mod, func, name, sname, arg0) \
173 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
174 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL)
176 #define SDT_PROBE_DEFINE2(prov, mod, func, name, sname, arg0, arg1) \
177 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
178 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL); \
179 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, NULL)
181 #define SDT_PROBE_DEFINE3(prov, mod, func, name, sname, arg0, arg1, arg2)\
182 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
183 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL); \
184 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, NULL); \
185 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, NULL)
187 #define SDT_PROBE_DEFINE4(prov, mod, func, name, sname, arg0, arg1, arg2, arg3) \
188 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
189 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL); \
190 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, NULL); \
191 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, NULL); \
192 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, NULL)
194 #define SDT_PROBE_DEFINE5(prov, mod, func, name, sname, arg0, arg1, arg2, arg3, arg4) \
195 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
196 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL); \
197 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, NULL); \
198 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, NULL); \
199 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, NULL); \
200 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4, NULL)
202 #define SDT_PROBE_DEFINE6(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
204 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
205 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL); \
206 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, NULL); \
207 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, NULL); \
208 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, NULL); \
209 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4, NULL); \
210 SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5, NULL)
212 #define SDT_PROBE_DEFINE7(prov, mod, func, name, sname, arg0, arg1, arg2, arg3,\
214 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
215 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, NULL); \
216 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, NULL); \
217 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, NULL); \
218 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, NULL); \
219 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4, NULL); \
220 SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5, NULL); \
221 SDT_PROBE_ARGTYPE(prov, mod, func, name, 6, arg6, NULL)
223 #define SDT_PROBE_DEFINE0_XLATE(prov, mod, func, name, sname) \
224 SDT_PROBE_DEFINE(prov, mod, func, name, sname)
226 #define SDT_PROBE_DEFINE1_XLATE(prov, mod, func, name, sname, arg0, xarg0) \
227 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
228 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0)
230 #define SDT_PROBE_DEFINE2_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
232 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
233 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0); \
234 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, xarg1)
236 #define SDT_PROBE_DEFINE3_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
237 arg1, xarg1, arg2, xarg2) \
238 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
239 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0); \
240 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, xarg1); \
241 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, xarg2)
243 #define SDT_PROBE_DEFINE4_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
244 arg1, xarg1, arg2, xarg2, arg3, xarg3) \
245 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
246 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0); \
247 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, xarg1); \
248 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, xarg2); \
249 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, xarg3)
251 #define SDT_PROBE_DEFINE5_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
252 arg1, xarg1, arg2, xarg2, arg3, xarg3, arg4, xarg4) \
253 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
254 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0); \
255 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, xarg1); \
256 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, xarg2); \
257 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, xarg3); \
258 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4, xarg4)
260 #define SDT_PROBE_DEFINE6_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
261 arg1, xarg1, arg2, xarg2, arg3, xarg3, arg4, xarg4, arg5, xarg5) \
262 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
263 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0); \
264 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, xarg1); \
265 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, xarg2); \
266 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, xarg3); \
267 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4, xarg4); \
268 SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5, xarg5)
270 #define SDT_PROBE_DEFINE7_XLATE(prov, mod, func, name, sname, arg0, xarg0, \
271 arg1, xarg1, arg2, xarg2, arg3, xarg3, arg4, xarg4, arg5, xarg5, arg6, \
273 SDT_PROBE_DEFINE(prov, mod, func, name, sname); \
274 SDT_PROBE_ARGTYPE(prov, mod, func, name, 0, arg0, xarg0); \
275 SDT_PROBE_ARGTYPE(prov, mod, func, name, 1, arg1, xarg1); \
276 SDT_PROBE_ARGTYPE(prov, mod, func, name, 2, arg2, xarg2); \
277 SDT_PROBE_ARGTYPE(prov, mod, func, name, 3, arg3, xarg3); \
278 SDT_PROBE_ARGTYPE(prov, mod, func, name, 4, arg4, xarg4); \
279 SDT_PROBE_ARGTYPE(prov, mod, func, name, 5, arg5, xarg5); \
280 SDT_PROBE_ARGTYPE(prov, mod, func, name, 6, arg6, xarg6)
282 #define SDT_PROBE0(prov, mod, func, name) \
283 SDT_PROBE(prov, mod, func, name, 0, 0, 0, 0, 0)
284 #define SDT_PROBE1(prov, mod, func, name, arg0) \
285 SDT_PROBE(prov, mod, func, name, arg0, 0, 0, 0, 0)
286 #define SDT_PROBE2(prov, mod, func, name, arg0, arg1) \
287 SDT_PROBE(prov, mod, func, name, arg0, arg1, 0, 0, 0)
288 #define SDT_PROBE3(prov, mod, func, name, arg0, arg1, arg2) \
289 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, 0, 0)
290 #define SDT_PROBE4(prov, mod, func, name, arg0, arg1, arg2, arg3) \
291 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, 0)
292 #define SDT_PROBE5(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4) \
293 SDT_PROBE(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4)
294 #define SDT_PROBE6(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5) \
296 if (sdt_##prov##_##mod##_##func##_##name->id) \
297 (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
298 uintptr_t, uintptr_t, uintptr_t))sdt_probe_func)( \
299 sdt_##prov##_##mod##_##func##_##name->id, \
300 (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
301 (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5);\
303 #define SDT_PROBE7(prov, mod, func, name, arg0, arg1, arg2, arg3, arg4, arg5, \
306 if (sdt_##prov##_##mod##_##func##_##name->id) \
307 (*(void (*)(uint32_t, uintptr_t, uintptr_t, uintptr_t, \
308 uintptr_t, uintptr_t, uintptr_t, uintptr_t)) \
310 sdt_##prov##_##mod##_##func##_##name->id, \
311 (uintptr_t)arg0, (uintptr_t)arg1, (uintptr_t)arg2, \
312 (uintptr_t)arg3, (uintptr_t)arg4, (uintptr_t)arg5, \
316 #endif /* KDTRACE_HOOKS */
319 * This type definition must match that of dtrace_probe. It is defined this
320 * way to avoid having to rely on CDDL code.
322 typedef void (*sdt_probe_func_t)(uint32_t, uintptr_t arg0, uintptr_t arg1,
323 uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
326 * The 'sdt' provider will set it to dtrace_probe when it loads.
328 extern sdt_probe_func_t sdt_probe_func;
335 int ndx; /* Argument index. */
336 const char *type; /* Argument type string. */
337 const char *xtype; /* Translated argument type. */
338 TAILQ_ENTRY(sdt_argtype)
339 argtype_entry; /* Argument type list entry. */
340 struct sdt_probe *probe; /* Ptr to the probe structure. */
344 int version; /* Set to sizeof(struct sdt_probe). */
345 struct sdt_provider *prov; /* Ptr to the provider structure. */
346 TAILQ_ENTRY(sdt_probe)
347 probe_entry; /* SDT probe list entry. */
348 TAILQ_HEAD(argtype_list_head, sdt_argtype) argtype_list;
352 id_t id; /* DTrace probe ID. */
353 int n_args; /* Number of arguments. */
354 struct linker_file *sdtp_lf; /* Module in which we're defined. */
357 struct sdt_provider {
358 char *name; /* Provider name. */
359 TAILQ_ENTRY(sdt_provider)
360 prov_entry; /* SDT provider list entry. */
361 TAILQ_HEAD(probe_list_head, sdt_probe) probe_list;
362 uintptr_t id; /* DTrace provider ID. */
363 int sdt_refs; /* Number of module references. */
366 void sdt_probe_stub(uint32_t, uintptr_t, uintptr_t, uintptr_t, uintptr_t,
371 #endif /* _SYS_SDT_H */