1 #ifndef _LTTNG_TRACEPOINT_H
2 #define _LTTNG_TRACEPOINT_H
5 * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
18 #include <lttng/tracepoint-types.h>
19 #include <lttng/tracepoint-rcu.h>
20 #include <urcu/compiler.h>
21 #include <dlfcn.h> /* for dlopen */
22 #include <string.h> /* for memset */
24 #include <lttng/ust-config.h> /* for sdt */
25 #include <lttng/ust-compiler.h>
27 #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
28 #define SDT_USE_VARIADIC
31 #define STAP_PROBEV(...)
38 #define tracepoint(provider, name, ...) \
40 STAP_PROBEV(provider, name, ## __VA_ARGS__); \
41 if (caa_unlikely(__tracepoint_##provider##___##name.state)) { \
42 __tracepoint_cb_##provider##___##name(__VA_ARGS__); \
43 TRACEPOINT_CALLSITE(provider, name); \
47 #define TP_ARGS(...) __VA_ARGS__
50 * TP_ARGS takes tuples of type, argument separated by a comma.
51 * It can take up to 10 tuples (which means that less than 10 tuples is
53 * Each tuple is also separated by a comma.
55 #define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
57 #define _TP_COMBINE_TOKENS(_tokena, _tokenb) \
58 __TP_COMBINE_TOKENS(_tokena, _tokenb)
59 #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
60 _tokena##_tokenb##_tokenc
61 #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
62 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
63 #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
64 _tokena##_tokenb##_tokenc##_tokend
65 #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
66 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
69 * _TP_EXVAR* extract the var names.
70 * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
74 #define _TP_EXVAR2(a,b) b
75 #define _TP_EXVAR4(a,b,c,d) b,d
76 #define _TP_EXVAR6(a,b,c,d,e,f) b,d,f
77 #define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
78 #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
79 #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
80 #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
81 #define _TP_EXVAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) b,d,f,h,j,l,n,p
82 #define _TP_EXVAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) b,d,f,h,j,l,n,p,r
83 #define _TP_EXVAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) b,d,f,h,j,l,n,p,r,t
85 #define _TP_EXDATA_VAR0() __tp_data
86 #define _TP_EXDATA_VAR1(a) __tp_data
87 #define _TP_EXDATA_VAR2(a,b) __tp_data,b
88 #define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
89 #define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
90 #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
91 #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
92 #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
93 #define _TP_EXDATA_VAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) __tp_data,b,d,f,h,j,l,n
94 #define _TP_EXDATA_VAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) __tp_data,b,d,f,h,j,l,n,p
95 #define _TP_EXDATA_VAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) __tp_data,b,d,f,h,j,l,n,p,r
96 #define _TP_EXDATA_VAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) __tp_data,b,d,f,h,j,l,n,p,r,t
99 * _TP_EXPROTO* extract tuples of type, var.
100 * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
102 #define _TP_EXPROTO0() void
103 #define _TP_EXPROTO1(a) void
104 #define _TP_EXPROTO2(a,b) a b
105 #define _TP_EXPROTO4(a,b,c,d) a b,c d
106 #define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
107 #define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
108 #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
109 #define _TP_EXPROTO12(a,b,c,d,e,f,g,h,i,j,k,l) a b,c d,e f,g h,i j,k l
110 #define _TP_EXPROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) a b,c d,e f,g h,i j,k l,m n
111 #define _TP_EXPROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) a b,c d,e f,g h,i j,k l,m n,o p
112 #define _TP_EXPROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) a b,c d,e f,g h,i j,k l,m n,o p,q r
113 #define _TP_EXPROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
115 #define _TP_EXDATA_PROTO0() void *__tp_data
116 #define _TP_EXDATA_PROTO1(a) void *__tp_data
117 #define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
118 #define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
119 #define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
120 #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
121 #define _TP_EXDATA_PROTO10(a,b,c,d,e,f,g,h,i,j) void *__tp_data,a b,c d,e f,g h,i j
122 #define _TP_EXDATA_PROTO12(a,b,c,d,e,f,g,h,i,j,k,l) void *__tp_data,a b,c d,e f,g h,i j,k l
123 #define _TP_EXDATA_PROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) void *__tp_data,a b,c d,e f,g h,i j,k l,m n
124 #define _TP_EXDATA_PROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p
125 #define _TP_EXDATA_PROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r
126 #define _TP_EXDATA_PROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
128 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
129 #define _TP_NARGS(...) __TP_NARGS(__VA_ARGS__, 20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
130 #define __TP_NARGS(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20, N, ...) N
131 #define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
132 #define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
133 #define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
134 #define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
135 #define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
136 #define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
137 #define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
138 #define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
139 #define _TP_PARAMS(...) __VA_ARGS__
142 * The tracepoint cb is marked always inline so we can distinguish
143 * between caller's ip addresses within the probe using the return
146 #define _DECLARE_TRACEPOINT(_provider, _name, ...) \
147 extern struct tracepoint __tracepoint_##_provider##___##_name; \
148 static inline __attribute__((always_inline)) lttng_ust_notrace \
149 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \
151 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
153 struct tracepoint_probe *__tp_probe; \
155 if (!TP_RCU_LINK_TEST()) \
157 tp_rcu_read_lock_bp(); \
158 __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
159 if (caa_unlikely(!__tp_probe)) \
162 void (*__tp_cb)(void) = __tp_probe->func; \
163 void *__tp_data = __tp_probe->data; \
165 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
166 (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \
167 } while ((++__tp_probe)->func); \
169 tp_rcu_read_unlock_bp(); \
171 static inline lttng_ust_notrace \
172 void __tracepoint_register_##_provider##___##_name(char *name, \
173 void (*func)(void), void *data); \
175 void __tracepoint_register_##_provider##___##_name(char *name, \
176 void (*func)(void), void *data) \
178 __tracepoint_probe_register(name, func, data, \
179 __tracepoint_##_provider##___##_name.signature); \
181 static inline lttng_ust_notrace \
182 void __tracepoint_unregister_##_provider##___##_name(char *name, \
183 void (*func)(void), void *data); \
185 void __tracepoint_unregister_##_provider##___##_name(char *name, \
186 void (*func)(void), void *data) \
188 __tracepoint_probe_unregister(name, func, data); \
191 extern int __tracepoint_probe_register(const char *name
, void (*func
)(void),
192 void *data
, const char *signature
);
193 extern int __tracepoint_probe_unregister(const char *name
, void (*func
)(void),
197 * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
198 * shared across objects in a module/main executable.
200 struct tracepoint_dlopen
{
201 void *liblttngust_handle
;
203 int (*tracepoint_register_lib
)(struct tracepoint
* const *tracepoints_start
,
204 int tracepoints_count
);
205 int (*tracepoint_unregister_lib
)(struct tracepoint
* const *tracepoints_start
);
207 void (*rcu_read_lock_sym_bp
)(void);
208 void (*rcu_read_unlock_sym_bp
)(void);
209 void *(*rcu_dereference_sym_bp
)(void *p
);
213 extern struct tracepoint_dlopen tracepoint_dlopen
;
215 struct tracepoint_callsite_dlopen
{
216 void *liblttngust_handle
;
218 int (*tracepoint_register_lib_callsite
)(struct tracepoint_callsite
* const *tp_start
,
220 int (*tracepoint_unregister_lib_callsite
)(struct tracepoint_callsite
* const *tp_start
,
224 struct tracepoint_callsite_dlopen tracepoint_callsite_dlopen
225 __attribute__((weak
, visibility("hidden")));
226 int __tracepoint_callsite_registered
227 __attribute__((weak
, visibility("hidden")));
229 #if (CAA_BITS_PER_LONG == 64)
230 #define __TP_ASM_PTR ".quad "
232 #define __TP_ASM_PTR ".long "
236 * Note: to allow PIC code, we need to allow the linker to update the pointers
237 * in the __tracepoints_callsite_ptrs section.
238 * Therefore, this section is _not_ const (read-only).
240 #define TRACEPOINT_CALLSITE(_provider, _name) \
242 asm volatile ( ".pushsection __tracepoint_callsite, \"aw\"\n\t" \
244 __TP_ASM_PTR "%c0, %c1, %c2, 2f\n\t" \
246 ".space 16\n\t" /* padding */ \
248 ".pushsection __tracepoint_callsite_ptrs, \"aw\"\n\t" \
249 __TP_ASM_PTR "1b\n\t" \
252 : : "i" (#_provider ":" #_name), \
259 * These weak symbols, the constructor, and destructor take care of
260 * registering only _one_ instance of the tracepoint callsite per
261 * shared-ojbect (or for the whole main program).
263 extern struct tracepoint_callsite
* const __start___tracepoint_callsite_ptrs
[]
264 __attribute__((weak
, visibility("hidden")));
265 extern struct tracepoint_callsite
* const __stop___tracepoint_callsite_ptrs
[]
266 __attribute__((weak
, visibility("hidden")));
269 * We need at least one pointer in the section.
271 static struct tracepoint_callsite
*
272 __tracepoint_callsite_ptr_dummy
273 __attribute__((used
, section("__tracepoint_callsite_ptrs"))) =
276 static void lttng_ust_notrace
__attribute__((constructor
))
277 __tracepoint_callsite__init(void);
279 __tracepoint_callsite__init(void)
281 if (__tracepoint_callsite_registered
++)
284 tracepoint_callsite_dlopen
.liblttngust_handle
=
285 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW
| RTLD_GLOBAL
);
286 if (!tracepoint_callsite_dlopen
.liblttngust_handle
)
288 tracepoint_callsite_dlopen
.tracepoint_register_lib_callsite
=
289 URCU_FORCE_CAST(int (*)(struct tracepoint_callsite
* const *, int),
290 dlsym(tracepoint_callsite_dlopen
.liblttngust_handle
,
291 "tracepoint_register_lib_callsite"));
292 tracepoint_callsite_dlopen
.tracepoint_unregister_lib_callsite
=
293 URCU_FORCE_CAST(int (*)(struct tracepoint_callsite
* const *, int),
294 dlsym(tracepoint_callsite_dlopen
.liblttngust_handle
,
295 "tracepoint_unregister_lib_callsite"));
296 tracepoint_callsite_dlopen
.tracepoint_register_lib_callsite(__start___tracepoint_callsite_ptrs
,
297 __stop___tracepoint_callsite_ptrs
-
298 __start___tracepoint_callsite_ptrs
);
301 static void lttng_ust_notrace
__attribute__((destructor
))
302 __tracepoint_callsite__destroy(void);
304 __tracepoint_callsite__destroy(void)
308 if (--__tracepoint_callsite_registered
)
310 if (tracepoint_callsite_dlopen
.tracepoint_unregister_lib_callsite
)
311 tracepoint_callsite_dlopen
.tracepoint_unregister_lib_callsite(__start___tracepoint_callsite_ptrs
,
312 __stop___tracepoint_callsite_ptrs
-
313 __start___tracepoint_callsite_ptrs
);
314 if (tracepoint_callsite_dlopen
.liblttngust_handle
) {
315 ret
= dlclose(tracepoint_callsite_dlopen
.liblttngust_handle
);
317 memset(&tracepoint_callsite_dlopen
, 0, sizeof(tracepoint_callsite_dlopen
));
321 #ifdef TRACEPOINT_DEFINE
324 * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
325 * unresolved symbol that requires the provider to be linked in. When
326 * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
327 * unresolved symbol that depends on having the provider linked in,
328 * otherwise the linker complains. This deals with use of static
329 * libraries, ensuring that the linker does not remove the provider
330 * object from the executable.
332 #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
333 #define _TRACEPOINT_UNDEFINED_REF(provider) NULL
334 #else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
335 #define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider
336 #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
339 * Note: to allow PIC code, we need to allow the linker to update the pointers
340 * in the __tracepoints_ptrs section.
341 * Therefore, this section is _not_ const (read-only).
343 #define _TP_EXTRACT_STRING(...) #__VA_ARGS__
345 #define _DEFINE_TRACEPOINT(_provider, _name, _args) \
346 extern int __tracepoint_provider_##_provider; \
347 static const char __tp_strtab_##_provider##___##_name[] \
348 __attribute__((section("__tracepoints_strings"))) = \
349 #_provider ":" #_name; \
350 struct tracepoint __tracepoint_##_provider##___##_name \
351 __attribute__((section("__tracepoints"))) = \
353 __tp_strtab_##_provider##___##_name, \
356 _TRACEPOINT_UNDEFINED_REF(_provider), \
357 _TP_EXTRACT_STRING(_args), \
359 static struct tracepoint * __tracepoint_ptr_##_provider##___##_name \
360 __attribute__((used, section("__tracepoints_ptrs"))) = \
361 &__tracepoint_##_provider##___##_name;
364 * These weak symbols, the constructor, and destructor take care of
365 * registering only _one_ instance of the tracepoints per shared-ojbect
366 * (or for the whole main program).
368 extern struct tracepoint
* const __start___tracepoints_ptrs
[]
369 __attribute__((weak
, visibility("hidden")));
370 extern struct tracepoint
* const __stop___tracepoints_ptrs
[]
371 __attribute__((weak
, visibility("hidden")));
372 int __tracepoint_registered
373 __attribute__((weak
, visibility("hidden")));
374 struct tracepoint_dlopen tracepoint_dlopen
375 __attribute__((weak
, visibility("hidden")));
377 static void lttng_ust_notrace
__attribute__((constructor
))
378 __tracepoints__init(void);
380 __tracepoints__init(void)
382 if (__tracepoint_registered
++)
385 tracepoint_dlopen
.liblttngust_handle
=
386 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW
| RTLD_GLOBAL
);
387 if (!tracepoint_dlopen
.liblttngust_handle
)
389 tracepoint_dlopen
.tracepoint_register_lib
=
390 URCU_FORCE_CAST(int (*)(struct tracepoint
* const *, int),
391 dlsym(tracepoint_dlopen
.liblttngust_handle
,
392 "tracepoint_register_lib"));
393 tracepoint_dlopen
.tracepoint_unregister_lib
=
394 URCU_FORCE_CAST(int (*)(struct tracepoint
* const *),
395 dlsym(tracepoint_dlopen
.liblttngust_handle
,
396 "tracepoint_unregister_lib"));
398 tracepoint_dlopen
.rcu_read_lock_sym_bp
=
399 URCU_FORCE_CAST(void (*)(void),
400 dlsym(tracepoint_dlopen
.liblttngust_handle
,
401 "tp_rcu_read_lock_bp"));
402 tracepoint_dlopen
.rcu_read_unlock_sym_bp
=
403 URCU_FORCE_CAST(void (*)(void),
404 dlsym(tracepoint_dlopen
.liblttngust_handle
,
405 "tp_rcu_read_unlock_bp"));
406 tracepoint_dlopen
.rcu_dereference_sym_bp
=
407 URCU_FORCE_CAST(void *(*)(void *p
),
408 dlsym(tracepoint_dlopen
.liblttngust_handle
,
409 "tp_rcu_dereference_sym_bp"));
411 tracepoint_dlopen
.tracepoint_register_lib(__start___tracepoints_ptrs
,
412 __stop___tracepoints_ptrs
-
413 __start___tracepoints_ptrs
);
416 static void lttng_ust_notrace
__attribute__((destructor
))
417 __tracepoints__destroy(void);
419 __tracepoints__destroy(void)
423 if (--__tracepoint_registered
)
425 if (tracepoint_dlopen
.tracepoint_unregister_lib
)
426 tracepoint_dlopen
.tracepoint_unregister_lib(__start___tracepoints_ptrs
);
427 if (tracepoint_dlopen
.liblttngust_handle
) {
428 ret
= dlclose(tracepoint_dlopen
.liblttngust_handle
);
430 memset(&tracepoint_dlopen
, 0, sizeof(tracepoint_dlopen
));
434 #else /* TRACEPOINT_DEFINE */
436 #define _DEFINE_TRACEPOINT(_provider, _name, _args)
438 #endif /* #else TRACEPOINT_DEFINE */
444 #endif /* _LTTNG_TRACEPOINT_H */
446 /* The following declarations must be outside re-inclusion protection. */
448 #ifndef TRACEPOINT_EVENT
451 * How to use the TRACEPOINT_EVENT macro:
455 * TRACEPOINT_EVENT(someproject_component, event_name,
457 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
459 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
460 * long *, arg4, size_t, arg4_len),
462 * * TP_FIELDS describes the event payload layout in the trace *
465 * * Integer, printed in base 10 *
466 * ctf_integer(int, field_a, arg0)
468 * * Integer, printed with 0x base 16 *
469 * ctf_integer_hex(unsigned long, field_d, arg1)
471 * * Array Sequence, printed as UTF8-encoded array of bytes *
472 * ctf_array_text(char, field_b, string, FIXED_LEN)
473 * ctf_sequence_text(char, field_c, string, size_t, strlen)
475 * * String, printed as UTF8-encoded string *
476 * ctf_string(field_e, string)
478 * * Array sequence of signed integer values *
479 * ctf_array(long, field_f, arg4, FIXED_LEN4)
480 * ctf_sequence(long, field_g, arg4, size_t, arg4_len)
484 * More detailed explanation:
486 * The name of the tracepoint is expressed as a tuple with the provider
487 * and name arguments.
489 * The provider and name should be a proper C99 identifier.
490 * The "provider" and "name" MUST follow these rules to ensure no
491 * namespace clash occurs:
493 * For projects (applications and libraries) for which an entity
494 * specific to the project controls the source code and thus its
495 * tracepoints (typically with a scope larger than a single company):
498 * project_component, event
502 * Where "project" is the name of the project,
503 * "component" is the name of the project component (which may
504 * include several levels of sub-components, e.g.
505 * ...component_subcomponent_...) where the tracepoint is located
507 * "event" is the name of the tracepoint event.
509 * For projects issued from a single company wishing to advertise that
510 * the company controls the source code and thus the tracepoints, the
511 * "com_" prefix should be used:
514 * com_company_project_component, event
516 * com_company_project, event
518 * Where "company" is the name of the company,
519 * "project" is the name of the project,
520 * "component" is the name of the project component (which may
521 * include several levels of sub-components, e.g.
522 * ...component_subcomponent_...) where the tracepoint is located
524 * "event" is the name of the tracepoint event.
526 * the provider:event identifier is limited to 127 characters.
529 #define TRACEPOINT_EVENT(provider, name, args, fields) \
530 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
531 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
533 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
535 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
536 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
537 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
539 #endif /* #ifndef TRACEPOINT_EVENT */
541 #ifndef TRACEPOINT_LOGLEVEL
544 * Tracepoint Loglevels
546 * Typical use of these loglevels:
548 * The loglevels go from 0 to 14. Higher numbers imply the most
549 * verbosity (higher event throughput expected.
551 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
552 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
559 * action must be taken immediately
562 * critical conditions
571 * normal, but significant, condition
574 * informational message
576 * TRACE_DEBUG_SYSTEM 7
577 * debug information with system-level scope (set of programs)
579 * TRACE_DEBUG_PROGRAM 8
580 * debug information with program-level scope (set of processes)
582 * TRACE_DEBUG_PROCESS 9
583 * debug information with process-level scope (set of modules)
585 * TRACE_DEBUG_MODULE 10
586 * debug information with module (executable/library) scope (set of units)
588 * TRACE_DEBUG_UNIT 11
589 * debug information with compilation unit scope (set of functions)
591 * TRACE_DEBUG_FUNCTION 12
592 * debug information with function-level scope
594 * TRACE_DEBUG_LINE 13
595 * debug information with line-level scope (TRACEPOINT_EVENT default)
598 * debug-level message (trace_printf default)
600 * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
601 * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
602 * tracepoint name. The first field is the provider name, the second
603 * field is the name of the tracepoint, the third field is the loglevel
606 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
609 * The TRACEPOINT_PROVIDER must be already declared before declaring a
610 * TRACEPOINT_LOGLEVEL.
621 TRACE_DEBUG_SYSTEM
= 7,
622 TRACE_DEBUG_PROGRAM
= 8,
623 TRACE_DEBUG_PROCESS
= 9,
624 TRACE_DEBUG_MODULE
= 10,
625 TRACE_DEBUG_UNIT
= 11,
626 TRACE_DEBUG_FUNCTION
= 12,
627 TRACE_DEBUG_LINE
= 13,
631 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
633 #endif /* #ifndef TRACEPOINT_LOGLEVEL */
635 #ifndef TRACEPOINT_MODEL_EMF_URI
637 #define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
639 #endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */