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.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #include <lttng/tracepoint-types.h>
29 #include <lttng/tracepoint-rcu.h>
30 #include <urcu/compiler.h>
31 #include <urcu/system.h>
32 #include <dlfcn.h> /* for dlopen */
33 #include <string.h> /* for memset */
34 #include <lttng/ust-config.h> /* for sdt */
35 #include <lttng/ust-compiler.h>
37 #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
38 #define SDT_USE_VARIADIC
40 #define LTTNG_STAP_PROBEV STAP_PROBEV
42 #define LTTNG_STAP_PROBEV(...)
49 #define tracepoint_enabled(provider, name) \
50 caa_unlikely(CMM_LOAD_SHARED(__tracepoint_##provider##___##name.state))
52 #define do_tracepoint(provider, name, ...) \
53 __tracepoint_cb_##provider##___##name(__VA_ARGS__)
55 #define tracepoint(provider, name, ...) \
57 LTTNG_STAP_PROBEV(provider, name, ## __VA_ARGS__); \
58 if (tracepoint_enabled(provider, name)) \
59 do_tracepoint(provider, name, __VA_ARGS__); \
62 #define TP_ARGS(...) __VA_ARGS__
65 * TP_ARGS takes tuples of type, argument separated by a comma.
66 * It can take up to 10 tuples (which means that less than 10 tuples is
68 * Each tuple is also separated by a comma.
70 #define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
72 #define _TP_COMBINE_TOKENS(_tokena, _tokenb) \
73 __TP_COMBINE_TOKENS(_tokena, _tokenb)
74 #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
75 _tokena##_tokenb##_tokenc
76 #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
77 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
78 #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
79 _tokena##_tokenb##_tokenc##_tokend
80 #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
81 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
84 * _TP_EXVAR* extract the var names.
85 * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
89 #define _TP_EXVAR2(a,b) b
90 #define _TP_EXVAR4(a,b,c,d) b,d
91 #define _TP_EXVAR6(a,b,c,d,e,f) b,d,f
92 #define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
93 #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
94 #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
95 #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
96 #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
97 #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
98 #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
100 #define _TP_EXDATA_VAR0() __tp_data
101 #define _TP_EXDATA_VAR1(a) __tp_data
102 #define _TP_EXDATA_VAR2(a,b) __tp_data,b
103 #define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
104 #define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
105 #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
106 #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
107 #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
108 #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
109 #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
110 #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
111 #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
114 * _TP_EXPROTO* extract tuples of type, var.
115 * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
117 #define _TP_EXPROTO0() void
118 #define _TP_EXPROTO1(a) void
119 #define _TP_EXPROTO2(a,b) a b
120 #define _TP_EXPROTO4(a,b,c,d) a b,c d
121 #define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
122 #define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
123 #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
124 #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
125 #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
126 #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
127 #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
128 #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
130 #define _TP_EXDATA_PROTO0() void *__tp_data
131 #define _TP_EXDATA_PROTO1(a) void *__tp_data
132 #define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
133 #define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
134 #define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
135 #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
136 #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
137 #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
138 #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
139 #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
140 #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
141 #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
143 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
144 #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)
145 #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
146 #define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
147 #define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
148 #define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
149 #define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
150 #define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
151 #define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
152 #define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
153 #define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
154 #define _TP_PARAMS(...) __VA_ARGS__
157 * The tracepoint cb is marked always inline so we can distinguish
158 * between caller's ip addresses within the probe using the return
161 #define _DECLARE_TRACEPOINT(_provider, _name, ...) \
162 extern struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name; \
163 static inline __attribute__((always_inline, unused)) lttng_ust_notrace \
164 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \
166 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
168 struct lttng_ust_tracepoint_probe *__tp_probe; \
170 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
172 tp_rcu_read_lock_bp(); \
173 __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
174 if (caa_unlikely(!__tp_probe)) \
177 void (*__tp_cb)(void) = __tp_probe->func; \
178 void *__tp_data = __tp_probe->data; \
180 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
181 (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \
182 } while ((++__tp_probe)->func); \
184 tp_rcu_read_unlock_bp(); \
186 static inline lttng_ust_notrace \
187 void __tracepoint_register_##_provider##___##_name(char *name, \
188 void (*func)(void), void *data); \
190 void __tracepoint_register_##_provider##___##_name(char *name, \
191 void (*func)(void), void *data) \
193 __tracepoint_probe_register(name, func, data, \
194 __tracepoint_##_provider##___##_name.signature); \
196 static inline lttng_ust_notrace \
197 void __tracepoint_unregister_##_provider##___##_name(char *name, \
198 void (*func)(void), void *data); \
200 void __tracepoint_unregister_##_provider##___##_name(char *name, \
201 void (*func)(void), void *data) \
203 __tracepoint_probe_unregister(name, func, data); \
206 extern int __tracepoint_probe_register(const char *name
, void (*func
)(void),
207 void *data
, const char *signature
);
208 extern int __tracepoint_probe_unregister(const char *name
, void (*func
)(void),
212 * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
213 * shared across objects in a module/main executable.
215 struct lttng_ust_tracepoint_dlopen
{
216 void *liblttngust_handle
;
218 int (*tracepoint_register_lib
)(struct lttng_ust_tracepoint
* const *tracepoints_start
,
219 int tracepoints_count
);
220 int (*tracepoint_unregister_lib
)(struct lttng_ust_tracepoint
* const *tracepoints_start
);
222 void (*rcu_read_lock_sym_bp
)(void);
223 void (*rcu_read_unlock_sym_bp
)(void);
224 void *(*rcu_dereference_sym_bp
)(void *p
);
228 extern struct lttng_ust_tracepoint_dlopen tracepoint_dlopen
;
230 #if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES)
233 * These weak symbols, the constructor, and destructor take care of
234 * registering only _one_ instance of the tracepoints per shared-ojbect
235 * (or for the whole main program).
237 int __tracepoint_registered
238 __attribute__((weak
, visibility("hidden")));
239 int __tracepoint_ptrs_registered
240 __attribute__((weak
, visibility("hidden")));
241 struct lttng_ust_tracepoint_dlopen tracepoint_dlopen
242 __attribute__((weak
, visibility("hidden")));
244 * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
245 * 4.8 and prior does not have the same behavior for symbol scoping on
246 * 32-bit powerpc depending on the object size: symbols for objects of 8
247 * bytes or less have the same address throughout a module, whereas they
248 * have different addresses between compile units for objects larger
249 * than 8 bytes. Add this pointer indirection to ensure that the symbol
250 * scoping match that of the other weak hidden symbols found in this
253 struct lttng_ust_tracepoint_dlopen
*tracepoint_dlopen_ptr
254 __attribute__((weak
, visibility("hidden")));
257 static inline void lttng_ust_notrace
258 __tracepoint__init_urcu_sym(void);
260 __tracepoint__init_urcu_sym(void)
262 if (!tracepoint_dlopen_ptr
)
263 tracepoint_dlopen_ptr
= &tracepoint_dlopen
;
265 * Symbols below are needed by tracepoint call sites and probe
268 if (!tracepoint_dlopen_ptr
->rcu_read_lock_sym_bp
)
269 tracepoint_dlopen_ptr
->rcu_read_lock_sym_bp
=
270 URCU_FORCE_CAST(void (*)(void),
271 dlsym(tracepoint_dlopen_ptr
->liblttngust_handle
,
272 "tp_rcu_read_lock_bp"));
273 if (!tracepoint_dlopen_ptr
->rcu_read_unlock_sym_bp
)
274 tracepoint_dlopen_ptr
->rcu_read_unlock_sym_bp
=
275 URCU_FORCE_CAST(void (*)(void),
276 dlsym(tracepoint_dlopen_ptr
->liblttngust_handle
,
277 "tp_rcu_read_unlock_bp"));
278 if (!tracepoint_dlopen_ptr
->rcu_dereference_sym_bp
)
279 tracepoint_dlopen_ptr
->rcu_dereference_sym_bp
=
280 URCU_FORCE_CAST(void *(*)(void *p
),
281 dlsym(tracepoint_dlopen_ptr
->liblttngust_handle
,
282 "tp_rcu_dereference_sym_bp"));
285 static inline void lttng_ust_notrace
286 __tracepoint__init_urcu_sym(void);
288 __tracepoint__init_urcu_sym(void)
293 static void lttng_ust_notrace
__attribute__((constructor
))
294 __tracepoints__init(void);
296 __tracepoints__init(void)
298 if (__tracepoint_registered
++)
301 if (!tracepoint_dlopen_ptr
)
302 tracepoint_dlopen_ptr
= &tracepoint_dlopen
;
303 if (!tracepoint_dlopen_ptr
->liblttngust_handle
)
304 tracepoint_dlopen_ptr
->liblttngust_handle
=
305 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW
| RTLD_GLOBAL
);
306 if (!tracepoint_dlopen_ptr
->liblttngust_handle
)
308 __tracepoint__init_urcu_sym();
311 static void lttng_ust_notrace
__attribute__((destructor
))
312 __tracepoints__destroy(void);
314 __tracepoints__destroy(void)
318 if (--__tracepoint_registered
)
320 if (!tracepoint_dlopen_ptr
)
321 tracepoint_dlopen_ptr
= &tracepoint_dlopen
;
322 if (tracepoint_dlopen_ptr
->liblttngust_handle
&& !__tracepoint_ptrs_registered
) {
323 ret
= dlclose(tracepoint_dlopen_ptr
->liblttngust_handle
);
325 fprintf(stderr
, "Error (%d) in dlclose\n", ret
);
328 memset(tracepoint_dlopen_ptr
, 0, sizeof(*tracepoint_dlopen_ptr
));
334 #ifdef TRACEPOINT_DEFINE
337 * These weak symbols, the constructor, and destructor take care of
338 * registering only _one_ instance of the tracepoints per shared-ojbect
339 * (or for the whole main program).
341 extern struct lttng_ust_tracepoint
* const __start___tracepoints_ptrs
[]
342 __attribute__((weak
, visibility("hidden")));
343 extern struct lttng_ust_tracepoint
* const __stop___tracepoints_ptrs
[]
344 __attribute__((weak
, visibility("hidden")));
347 * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
348 * unresolved symbol that requires the provider to be linked in. When
349 * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
350 * unresolved symbol that depends on having the provider linked in,
351 * otherwise the linker complains. This deals with use of static
352 * libraries, ensuring that the linker does not remove the provider
353 * object from the executable.
355 #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
356 #define _TRACEPOINT_UNDEFINED_REF(provider) NULL
357 #else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
358 #define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider
359 #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
362 * Note: to allow PIC code, we need to allow the linker to update the pointers
363 * in the __tracepoints_ptrs section.
364 * Therefore, this section is _not_ const (read-only).
366 #define _TP_EXTRACT_STRING(...) #__VA_ARGS__
368 #define _DEFINE_TRACEPOINT(_provider, _name, _args) \
369 extern int __tracepoint_provider_##_provider; \
370 static const char __tp_strtab_##_provider##___##_name[] \
371 __attribute__((section("__tracepoints_strings"))) = \
372 #_provider ":" #_name; \
373 struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name \
374 __attribute__((section("__tracepoints"))) = \
376 __tp_strtab_##_provider##___##_name, \
379 _TRACEPOINT_UNDEFINED_REF(_provider), \
380 _TP_EXTRACT_STRING(_args), \
383 static struct lttng_ust_tracepoint * \
384 __tracepoint_ptr_##_provider##___##_name \
385 __attribute__((used, section("__tracepoints_ptrs"))) = \
386 &__tracepoint_##_provider##___##_name;
388 static void lttng_ust_notrace
__attribute__((constructor
))
389 __tracepoints__ptrs_init(void);
391 __tracepoints__ptrs_init(void)
393 if (__tracepoint_ptrs_registered
++)
395 if (!tracepoint_dlopen_ptr
)
396 tracepoint_dlopen_ptr
= &tracepoint_dlopen
;
397 if (!tracepoint_dlopen_ptr
->liblttngust_handle
)
398 tracepoint_dlopen_ptr
->liblttngust_handle
=
399 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW
| RTLD_GLOBAL
);
400 if (!tracepoint_dlopen_ptr
->liblttngust_handle
)
402 tracepoint_dlopen_ptr
->tracepoint_register_lib
=
403 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint
* const *, int),
404 dlsym(tracepoint_dlopen_ptr
->liblttngust_handle
,
405 "tracepoint_register_lib"));
406 tracepoint_dlopen_ptr
->tracepoint_unregister_lib
=
407 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint
* const *),
408 dlsym(tracepoint_dlopen_ptr
->liblttngust_handle
,
409 "tracepoint_unregister_lib"));
410 __tracepoint__init_urcu_sym();
411 if (tracepoint_dlopen_ptr
->tracepoint_register_lib
) {
412 tracepoint_dlopen_ptr
->tracepoint_register_lib(__start___tracepoints_ptrs
,
413 __stop___tracepoints_ptrs
-
414 __start___tracepoints_ptrs
);
418 static void lttng_ust_notrace
__attribute__((destructor
))
419 __tracepoints__ptrs_destroy(void);
421 __tracepoints__ptrs_destroy(void)
425 if (--__tracepoint_ptrs_registered
)
427 if (!tracepoint_dlopen_ptr
)
428 tracepoint_dlopen_ptr
= &tracepoint_dlopen
;
429 if (tracepoint_dlopen_ptr
->tracepoint_unregister_lib
)
430 tracepoint_dlopen_ptr
->tracepoint_unregister_lib(__start___tracepoints_ptrs
);
431 if (tracepoint_dlopen_ptr
->liblttngust_handle
&& !__tracepoint_registered
) {
432 ret
= dlclose(tracepoint_dlopen_ptr
->liblttngust_handle
);
434 fprintf(stderr
, "Error (%d) in dlclose\n", ret
);
437 memset(tracepoint_dlopen_ptr
, 0, sizeof(*tracepoint_dlopen_ptr
));
441 #else /* TRACEPOINT_DEFINE */
443 #define _DEFINE_TRACEPOINT(_provider, _name, _args)
445 #endif /* #else TRACEPOINT_DEFINE */
451 #endif /* _LTTNG_TRACEPOINT_H */
453 /* The following declarations must be outside re-inclusion protection. */
455 #ifndef TRACEPOINT_EVENT
458 * How to use the TRACEPOINT_EVENT macro:
462 * TRACEPOINT_EVENT(someproject_component, event_name,
464 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
466 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
467 * long *, arg4, size_t, arg4_len),
469 * * TP_FIELDS describes the event payload layout in the trace *
472 * * Integer, printed in base 10 *
473 * ctf_integer(int, field_a, arg0)
475 * * Integer, printed with 0x base 16 *
476 * ctf_integer_hex(unsigned long, field_d, arg1)
478 * * Array Sequence, printed as UTF8-encoded array of bytes *
479 * ctf_array_text(char, field_b, string, FIXED_LEN)
480 * ctf_sequence_text(char, field_c, string, size_t, strlen)
482 * * String, printed as UTF8-encoded string *
483 * ctf_string(field_e, string)
485 * * Array sequence of signed integer values *
486 * ctf_array(long, field_f, arg4, FIXED_LEN4)
487 * ctf_sequence(long, field_g, arg4, size_t, arg4_len)
491 * More detailed explanation:
493 * The name of the tracepoint is expressed as a tuple with the provider
494 * and name arguments.
496 * The provider and name should be a proper C99 identifier.
497 * The "provider" and "name" MUST follow these rules to ensure no
498 * namespace clash occurs:
500 * For projects (applications and libraries) for which an entity
501 * specific to the project controls the source code and thus its
502 * tracepoints (typically with a scope larger than a single company):
505 * project_component, event
509 * Where "project" is the name of the project,
510 * "component" is the name of the project component (which may
511 * include several levels of sub-components, e.g.
512 * ...component_subcomponent_...) where the tracepoint is located
514 * "event" is the name of the tracepoint event.
516 * For projects issued from a single company wishing to advertise that
517 * the company controls the source code and thus the tracepoints, the
518 * "com_" prefix should be used:
521 * com_company_project_component, event
523 * com_company_project, event
525 * Where "company" is the name of the company,
526 * "project" is the name of the project,
527 * "component" is the name of the project component (which may
528 * include several levels of sub-components, e.g.
529 * ...component_subcomponent_...) where the tracepoint is located
531 * "event" is the name of the tracepoint event.
533 * the provider:event identifier is limited to 127 characters.
536 #define TRACEPOINT_EVENT(provider, name, args, fields) \
537 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
538 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
540 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
542 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
543 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
544 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
546 #endif /* #ifndef TRACEPOINT_EVENT */
548 #ifndef TRACEPOINT_LOGLEVEL
551 * Tracepoint Loglevels
553 * Typical use of these loglevels:
555 * The loglevels go from 0 to 14. Higher numbers imply the most
556 * verbosity (higher event throughput expected.
558 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
559 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
566 * action must be taken immediately
569 * critical conditions
578 * normal, but significant, condition
581 * informational message
583 * TRACE_DEBUG_SYSTEM 7
584 * debug information with system-level scope (set of programs)
586 * TRACE_DEBUG_PROGRAM 8
587 * debug information with program-level scope (set of processes)
589 * TRACE_DEBUG_PROCESS 9
590 * debug information with process-level scope (set of modules)
592 * TRACE_DEBUG_MODULE 10
593 * debug information with module (executable/library) scope (set of units)
595 * TRACE_DEBUG_UNIT 11
596 * debug information with compilation unit scope (set of functions)
598 * TRACE_DEBUG_FUNCTION 12
599 * debug information with function-level scope
601 * TRACE_DEBUG_LINE 13
602 * debug information with line-level scope (TRACEPOINT_EVENT default)
605 * debug-level message
607 * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
608 * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
609 * tracepoint name. The first field is the provider name, the second
610 * field is the name of the tracepoint, the third field is the loglevel
613 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
616 * The TRACEPOINT_PROVIDER must be already declared before declaring a
617 * TRACEPOINT_LOGLEVEL.
628 TRACE_DEBUG_SYSTEM
= 7,
629 TRACE_DEBUG_PROGRAM
= 8,
630 TRACE_DEBUG_PROCESS
= 9,
631 TRACE_DEBUG_MODULE
= 10,
632 TRACE_DEBUG_UNIT
= 11,
633 TRACE_DEBUG_FUNCTION
= 12,
634 TRACE_DEBUG_LINE
= 13,
638 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
640 #endif /* #ifndef TRACEPOINT_LOGLEVEL */
642 #ifndef TRACEPOINT_MODEL_EMF_URI
644 #define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
646 #endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */