1 #ifndef _LTTNG_TRACEPOINT_H
2 #define _LTTNG_TRACEPOINT_H
5 * Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
8 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
10 * Permission is hereby granted to use or copy this program
11 * for any purpose, provided the above notices are retained on all copies.
12 * Permission to modify the code and to distribute modified code is granted,
13 * provided the above notices are retained, and a notice that the code was
14 * modified is included with the above copyright notice.
18 #include <lttng/tracepoint-types.h>
19 #include <urcu/compiler.h>
20 #include <dlfcn.h> /* for dlopen */
26 #define tracepoint(provider, name, ...) \
28 if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
29 __tracepoint_cb_##provider##___##name(__VA_ARGS__); \
32 #define TP_ARGS(...) __VA_ARGS__
35 * TP_ARGS takes tuples of type, argument separated by a comma.
36 * It can take up to 10 tuples (which means that less than 10 tuples is
38 * Each tuple is also separated by a comma.
40 #define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
42 #define _TP_COMBINE_TOKENS(_tokena, _tokenb) \
43 __TP_COMBINE_TOKENS(_tokena, _tokenb)
44 #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
45 _tokena##_tokenb##_tokenc
46 #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
47 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
48 #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
49 _tokena##_tokenb##_tokenc##_tokend
50 #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
51 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
53 /* _TP_EXVAR* extract the var names. */
55 #define _TP_EXVAR2(a,b) b
56 #define _TP_EXVAR4(a,b,c,d) b,d
57 #define _TP_EXVAR6(a,b,c,d,e,f) b,d,f
58 #define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
59 #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
60 #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
61 #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
62 #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
63 #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
64 #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
66 #define _TP_EXDATA_VAR0() __tp_data
67 #define _TP_EXDATA_VAR2(a,b) __tp_data,b
68 #define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
69 #define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
70 #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
71 #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
72 #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
73 #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
74 #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
75 #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
76 #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
78 /* _TP_EXPROTO* extract tuples of type, var */
79 #define _TP_EXPROTO0()
80 #define _TP_EXPROTO2(a,b) a b
81 #define _TP_EXPROTO4(a,b,c,d) a b,c d
82 #define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
83 #define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
84 #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
85 #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
86 #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
87 #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
88 #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
89 #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
91 #define _TP_EXDATA_PROTO0() void *__tp_data
92 #define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
93 #define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
94 #define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
95 #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
96 #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
97 #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
98 #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
99 #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
100 #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
101 #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
103 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
104 #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)
105 #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
106 #define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
107 #define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
108 #define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
109 #define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
110 #define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
111 #define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
112 #define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
113 #define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
114 #define _TP_PARAMS(...) __VA_ARGS__
116 #define _DECLARE_TRACEPOINT(provider, name, ...) \
117 extern struct tracepoint __tracepoint_##provider##___##name; \
118 static inline void __tracepoint_cb_##provider##___##name(_TP_ARGS_PROTO(__VA_ARGS__)) \
120 struct tracepoint_probe *__tp_probe; \
122 if (!rcu_read_lock_bp) \
124 rcu_read_lock_bp(); \
125 __tp_probe = rcu_dereference_bp(__tracepoint_##provider##___##name.probes); \
126 if (caa_unlikely(!__tp_probe)) \
129 void *__tp_cb = __tp_probe->func; \
130 void *__tp_data = __tp_probe->data; \
132 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
133 (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \
134 } while ((++__tp_probe)->func); \
136 rcu_read_unlock_bp(); \
138 static inline void __tracepoint_register_##provider##___##name(char *name, \
139 void *func, void *data) \
141 __tracepoint_probe_register(name, func, data); \
143 static inline void __tracepoint_unregister_##provider##___##name(char *name, \
144 void *func, void *data) \
146 __tracepoint_probe_unregister(name, func, data); \
149 extern int __tracepoint_probe_register(const char *name
, void *func
, void *data
);
150 extern int __tracepoint_probe_unregister(const char *name
, void *func
, void *data
);
152 #ifdef TRACEPOINT_DEFINE
155 * Note: to allow PIC code, we need to allow the linker to update the pointers
156 * in the __tracepoints_ptrs section.
157 * Therefore, this section is _not_ const (read-only).
159 #define _DEFINE_TRACEPOINT(provider, name) \
160 static const char __tp_strtab_##provider##___##name[] \
161 __attribute__((section("__tracepoints_strings"))) = \
162 #provider ":" #name; \
163 struct tracepoint __tracepoint_##provider##___##name \
164 __attribute__((section("__tracepoints"))) = \
165 { __tp_strtab_##provider##___##name, 0, NULL }; \
166 static struct tracepoint * __tracepoint_ptr_##provider##___##name \
167 __attribute__((used, section("__tracepoints_ptrs"))) = \
168 &__tracepoint_##provider##___##name;
170 static int (*tracepoint_register_lib
)(struct tracepoint
* const *tracepoints_start
,
171 int tracepoints_count
);
172 static int (*tracepoint_unregister_lib
)(struct tracepoint
* const *tracepoints_start
);
173 static void *liblttngust_handle
;
176 * These weak symbols, the constructor, and destructor take care of
177 * registering only _one_ instance of the tracepoints per shared-ojbect
178 * (or for the whole main program).
180 extern struct tracepoint
* const __start___tracepoints_ptrs
[]
181 __attribute__((weak
, visibility("hidden")));
182 extern struct tracepoint
* const __stop___tracepoints_ptrs
[]
183 __attribute__((weak
, visibility("hidden")));
184 int __tracepoint_registered
185 __attribute__((weak
, visibility("hidden")));
187 static void __attribute__((constructor
)) __tracepoints__init(void)
189 if (__tracepoint_registered
++)
192 liblttngust_handle
= dlopen("liblttng-ust.so", RTLD_NOW
| RTLD_GLOBAL
);
193 if (!liblttngust_handle
)
195 tracepoint_register_lib
=
196 URCU_FORCE_CAST(int (*)(struct tracepoint
* const *, int),
197 dlsym(liblttngust_handle
,
198 "tracepoint_register_lib"));
199 tracepoint_unregister_lib
=
200 URCU_FORCE_CAST(int (*)(struct tracepoint
* const *),
201 dlsym(liblttngust_handle
,
202 "tracepoint_unregister_lib"));
203 tracepoint_register_lib(__start___tracepoints_ptrs
,
204 __stop___tracepoints_ptrs
-
205 __start___tracepoints_ptrs
);
208 static void __attribute__((destructor
)) __tracepoints__destroy(void)
211 if (--__tracepoint_registered
)
213 if (tracepoint_unregister_lib
)
214 tracepoint_unregister_lib(__start___tracepoints_ptrs
);
215 if (liblttngust_handle
) {
216 tracepoint_unregister_lib
= NULL
;
217 tracepoint_register_lib
= NULL
;
218 ret
= dlclose(liblttngust_handle
);
223 #else /* TRACEPOINT_DEFINE */
225 #define _DEFINE_TRACEPOINT(provider, name)
227 #endif /* #else TRACEPOINT_DEFINE */
233 #endif /* _LTTNG_TRACEPOINT_H */
235 /* The following declarations must be outside re-inclusion protection. */
237 #ifndef TRACEPOINT_EVENT
240 * How to use the TRACEPOINT_EVENT macro:
244 * TRACEPOINT_EVENT(someproject_component, event_name,
246 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
248 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
249 * long *, arg4, size_t, arg4_len),
251 * * TP_FIELDS describes the event payload layout in the trace *
254 * * Integer, printed in base 10 *
255 * ctf_integer(int, field_a, arg0)
257 * * Integer, printed with 0x base 16 *
258 * ctf_integer_hex(unsigned long, field_d, arg1)
260 * * Array Sequence, printed as UTF8-encoded array of bytes *
261 * ctf_array_text(char, field_b, string, FIXED_LEN)
262 * ctf_sequence_text(char, field_c, string, size_t, strlen)
264 * * String, printed as UTF8-encoded string *
265 * ctf_string(field_e, string)
267 * * Array sequence of signed integer values *
268 * ctf_array(long, field_f, arg4, FIXED_LEN4)
269 * ctf_sequence(long, field_g, arg4, size_t, arg4_len)
273 * More detailed explanation:
275 * The name of the tracepoint is expressed as a tuple with the provider
276 * and name arguments.
278 * The provider and name should be a proper C99 identifier.
279 * The "provider" and "name" MUST follow these rules to ensure no
280 * namespace clash occurs:
282 * For projects (applications and libraries) for which an entity
283 * specific to the project controls the source code and thus its
284 * tracepoints (typically with a scope larger than a single company):
287 * project_component, event
291 * Where "project" is the name of the project,
292 * "component" is the name of the project component (which may
293 * include several levels of sub-components, e.g.
294 * ...component_subcomponent_...) where the tracepoint is located
296 * "event" is the name of the tracepoint event.
298 * For projects issued from a single company wishing to advertise that
299 * the company controls the source code and thus the tracepoints, the
300 * "com_" prefix should be used:
303 * com_company_project_component, event
305 * com_company_project, event
307 * Where "company" is the name of the company,
308 * "project" is the name of the project,
309 * "component" is the name of the project component (which may
310 * include several levels of sub-components, e.g.
311 * ...component_subcomponent_...) where the tracepoint is located
313 * "event" is the name of the tracepoint event.
315 * the provider:event identifier is limited to 127 characters.
318 #define TRACEPOINT_EVENT(provider, name, args, fields) \
319 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
320 _DEFINE_TRACEPOINT(provider, name)
322 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
324 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
325 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
326 _DEFINE_TRACEPOINT(provider, name)
328 #endif /* #ifndef TRACEPOINT_EVENT */
330 #ifndef TRACEPOINT_LOGLEVEL
333 * Tracepoint Loglevel Declaration Facility
335 * This is a place-holder the tracepoint loglevel declaration,
336 * overridden by the tracer implementation.
338 * Typical use of these loglevels:
340 * 1) Declare the mapping between loglevel names and an integer values
341 * within TRACEPOINT_LOGLEVEL_ENUM(), using tp_loglevel() for each
342 * tuple. Do _NOT_ add comma (,) nor semicolon (;) between the
343 * tp_loglevel entries contained within TRACEPOINT_LOGLEVEL_ENUM().
344 * Do _NOT_ add comma (,) nor semicolon (;) after the
345 * TRACEPOINT_LOGLEVEL_ENUM() declaration. The name should be a
346 * proper C99 identifier.
348 * TRACEPOINT_LOGLEVEL_ENUM(
349 * tp_loglevel( < loglevel_name >, < value > )
350 * tp_loglevel( < loglevel_name >, < value > )
356 * TRACEPOINT_LOGLEVEL_ENUM(
357 * tp_loglevel(LOG_EMERG, 0)
358 * tp_loglevel(LOG_ALERT, 1)
359 * tp_loglevel(LOG_CRIT, 2)
360 * tp_loglevel(LOG_ERR, 3)
361 * tp_loglevel(LOG_WARNING, 4)
362 * tp_loglevel(LOG_NOTICE, 5)
363 * tp_loglevel(LOG_INFO, 6)
364 * tp_loglevel(LOG_DEBUG, 7)
367 * 2) Then, declare tracepoint loglevels for tracepoints. A
368 * TRACEPOINT_EVENT should be declared prior to the the
369 * TRACEPOINT_LOGLEVEL for a given tracepoint name. The first field
370 * is the name of the tracepoint, the second field is the loglevel
373 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
376 * The TRACEPOINT_PROVIDER must be defined when declaring a
377 * TRACEPOINT_LOGLEVEL_ENUM and TRACEPOINT_LOGLEVEL. The tracepoint
378 * loglevel enumeration apply to the entire TRACEPOINT_PROVIDER. Only one
379 * tracepoint loglevel enumeration should be declared per tracepoint
383 #define TRACEPOINT_LOGLEVEL_ENUM(...)
384 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
386 #endif /* #ifndef TRACEPOINT_LOGLEVEL */