projects / lttng-ust.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Refactor liblttng-ust-jul in liblttng-ust-agent
[lttng-ust.git] / include / lttng / tracepoint.h
CommitLineData
b728d87e
MD		 1#ifndef _LTTNG_TRACEPOINT_H
2#define _LTTNG_TRACEPOINT_H
3
4/*
e92f3e28 5 * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
b728d87e 6 *
e92f3e28
MD		 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:
b728d87e 13 *
e92f3e28
MD		 14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
d2428e87
MD		 16 *
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
23 * SOFTWARE.
b728d87e
MD		 24 */
25
76aca78d
MD		 26#include <stdio.h>
27#include <stdlib.h>
8fce9e2b 28#include <lttng/tracepoint-types.h>
40b2b5a4 29#include <lttng/tracepoint-rcu.h>
b728d87e 30#include <urcu/compiler.h>
deb6e540 31#include <dlfcn.h> /* for dlopen */
51920067 32#include <string.h> /* for memset */
b2f60c79 33#include <lttng/ust-config.h> /* for sdt */
a8909ba5 34#include <lttng/ust-compiler.h>
b2f60c79
MD		 35
36#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
37#define SDT_USE_VARIADIC
38#include <sys/sdt.h>
39#else
40#define STAP_PROBEV(...)
41#endif
b728d87e
MD		 42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
23c8854a
MD		 47#define tracepoint(provider, name, ...) \
48 do { \
7cb85a18 49 STAP_PROBEV(provider, name, ## __VA_ARGS__); \
23c8854a
MD		 50 if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
51 __tracepoint_cb_##provider##___##name(__VA_ARGS__); \
b728d87e
MD		 52 } while (0)
53
54#define TP_ARGS(...) __VA_ARGS__
55
56/*
57 * TP_ARGS takes tuples of type, argument separated by a comma.
58 * It can take up to 10 tuples (which means that less than 10 tuples is
59 * fine too).
60 * Each tuple is also separated by a comma.
61 */
df854e41
MD		 62#define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
63 _tokena##_tokenb
64#define _TP_COMBINE_TOKENS(_tokena, _tokenb) \
65 __TP_COMBINE_TOKENS(_tokena, _tokenb)
66#define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
67 _tokena##_tokenb##_tokenc
68#define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
69 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
70#define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
71 _tokena##_tokenb##_tokenc##_tokend
72#define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
73 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
b728d87e 74
4495dd39
MD		 75/*
76 * _TP_EXVAR* extract the var names.
77 * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
78 */
b728d87e 79#define _TP_EXVAR0()
4495dd39 80#define _TP_EXVAR1(a)
b728d87e
MD		 81#define _TP_EXVAR2(a,b) b
82#define _TP_EXVAR4(a,b,c,d) b,d
83#define _TP_EXVAR6(a,b,c,d,e,f) b,d,f
84#define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
85#define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
86#define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
87#define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
88#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
89#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
90#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
91
92#define _TP_EXDATA_VAR0() __tp_data
4495dd39 93#define _TP_EXDATA_VAR1(a) __tp_data
b728d87e
MD		 94#define _TP_EXDATA_VAR2(a,b) __tp_data,b
95#define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
96#define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
97#define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
98#define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
99#define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
100#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
101#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
102#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
103#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
104
4495dd39
MD		 105/*
106 * _TP_EXPROTO* extract tuples of type, var.
107 * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
108 */
86637aa6 109#define _TP_EXPROTO0() void
4495dd39 110#define _TP_EXPROTO1(a) void
b728d87e
MD		 111#define _TP_EXPROTO2(a,b) a b
112#define _TP_EXPROTO4(a,b,c,d) a b,c d
113#define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
114#define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
115#define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
116#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
117#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
118#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
119#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
120#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
121
122#define _TP_EXDATA_PROTO0() void *__tp_data
4495dd39 123#define _TP_EXDATA_PROTO1(a) void *__tp_data
b728d87e
MD		 124#define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
125#define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
126#define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
127#define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
128#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
129#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
130#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
131#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
132#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
133#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
134
135/* Preprocessor trick to count arguments. Inspired from sdt.h. */
136#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)
137#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
23c8854a
MD		 138#define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
139#define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
140#define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
141#define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
b728d87e 142#define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
23c8854a 143#define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
b728d87e 144#define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
23c8854a 145#define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
b728d87e
MD		 146#define _TP_PARAMS(...) __VA_ARGS__
147
96f85541
MD		 148/*
149 * The tracepoint cb is marked always inline so we can distinguish
150 * between caller's ip addresses within the probe using the return
151 * address.
152 */
0f2f7e21
MD		 153#define _DECLARE_TRACEPOINT(_provider, _name, ...) \
154extern struct tracepoint __tracepoint_##_provider##___##_name; \
17ca0600 155static inline __attribute__((always_inline, unused)) lttng_ust_notrace \
a8909ba5 156void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \
96f85541 157static \
a8909ba5 158void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
b728d87e
MD		 159{ \
160 struct tracepoint_probe *__tp_probe; \
161 \
d3db6a40 162 if (caa_unlikely(!TP_RCU_LINK_TEST())) \
deb6e540 163 return; \
40b2b5a4 164 tp_rcu_read_lock_bp(); \
0f2f7e21 165 __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
23c8854a 166 if (caa_unlikely(!__tp_probe)) \
b728d87e
MD		 167 goto end; \
168 do { \
fbdeb5ec 169 void (*__tp_cb)(void) = __tp_probe->func; \
23c8854a 170 void *__tp_data = __tp_probe->data; \
b728d87e 171 \
23c8854a
MD		 172 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
173 (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \
174 } while ((++__tp_probe)->func); \
b728d87e 175end: \
40b2b5a4 176 tp_rcu_read_unlock_bp(); \
b728d87e 177} \
a8909ba5
PW		 178static inline lttng_ust_notrace \
179void __tracepoint_register_##_provider##___##_name(char *name, \
180 void (*func)(void), void *data); \
181static inline \
182void __tracepoint_register_##_provider##___##_name(char *name, \
183 void (*func)(void), void *data) \
b728d87e 184{ \
67e5f391
MD		 185 __tracepoint_probe_register(name, func, data, \
186 __tracepoint_##_provider##___##_name.signature); \
b728d87e 187} \
a8909ba5
PW		 188static inline lttng_ust_notrace \
189void __tracepoint_unregister_##_provider##___##_name(char *name, \
190 void (*func)(void), void *data); \
191static inline \
192void __tracepoint_unregister_##_provider##___##_name(char *name, \
193 void (*func)(void), void *data) \
b728d87e 194{ \
23c8854a 195 __tracepoint_probe_unregister(name, func, data); \
b728d87e
MD		 196}
197
fbdeb5ec
MD		 198extern int __tracepoint_probe_register(const char *name, void (*func)(void),
199 void *data, const char *signature);
200extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
201 void *data);
deb6e540 202
51920067
MD		 203/*
204 * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
205 * shared across objects in a module/main executable.
206 */
207struct tracepoint_dlopen {
208 void *liblttngust_handle;
209
210 int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start,
211 int tracepoints_count);
212 int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start);
213#ifndef _LGPL_SOURCE
214 void (*rcu_read_lock_sym_bp)(void);
215 void (*rcu_read_unlock_sym_bp)(void);
216 void *(*rcu_dereference_sym_bp)(void *p);
217#endif
218};
219
220extern struct tracepoint_dlopen tracepoint_dlopen;
221
46c881a7
MD		 222#if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES)
223
224/*
225 * These weak symbols, the constructor, and destructor take care of
226 * registering only _one_ instance of the tracepoints per shared-ojbect
227 * (or for the whole main program).
228 */
229int __tracepoint_registered
230 __attribute__((weak, visibility("hidden")));
231int __tracepoint_ptrs_registered
232 __attribute__((weak, visibility("hidden")));
233struct tracepoint_dlopen tracepoint_dlopen
234 __attribute__((weak, visibility("hidden")));
235
99234da6
MD		 236#ifndef _LGPL_SOURCE
237static inline void lttng_ust_notrace
238__tracepoint__init_urcu_sym(void);
239static inline void
240__tracepoint__init_urcu_sym(void)
241{
242 /*
243 * Symbols below are needed by tracepoint call sites and probe
244 * providers.
245 */
246 if (!tracepoint_dlopen.rcu_read_lock_sym_bp)
247 tracepoint_dlopen.rcu_read_lock_sym_bp =
248 URCU_FORCE_CAST(void (*)(void),
249 dlsym(tracepoint_dlopen.liblttngust_handle,
250 "tp_rcu_read_lock_bp"));
251 if (!tracepoint_dlopen.rcu_read_unlock_sym_bp)
252 tracepoint_dlopen.rcu_read_unlock_sym_bp =
253 URCU_FORCE_CAST(void (*)(void),
254 dlsym(tracepoint_dlopen.liblttngust_handle,
255 "tp_rcu_read_unlock_bp"));
256 if (!tracepoint_dlopen.rcu_dereference_sym_bp)
257 tracepoint_dlopen.rcu_dereference_sym_bp =
258 URCU_FORCE_CAST(void *(*)(void *p),
259 dlsym(tracepoint_dlopen.liblttngust_handle,
260 "tp_rcu_dereference_sym_bp"));
261}
262#else
263static inline void lttng_ust_notrace
264__tracepoint__init_urcu_sym(void);
265static inline void
266__tracepoint__init_urcu_sym(void)
267{
268}
269#endif
270
46c881a7
MD		 271static void lttng_ust_notrace __attribute__((constructor))
272__tracepoints__init(void);
273static void
274__tracepoints__init(void)
275{
276 if (__tracepoint_registered++)
277 return;
278
279 if (!tracepoint_dlopen.liblttngust_handle)
280 tracepoint_dlopen.liblttngust_handle =
281 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
282 if (!tracepoint_dlopen.liblttngust_handle)
283 return;
99234da6 284 __tracepoint__init_urcu_sym();
46c881a7
MD		 285}
286
287static void lttng_ust_notrace __attribute__((destructor))
288__tracepoints__destroy(void);
289static void
290__tracepoints__destroy(void)
291{
292 int ret;
293
294 if (--__tracepoint_registered)
295 return;
296 if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_ptrs_registered) {
297 ret = dlclose(tracepoint_dlopen.liblttngust_handle);
76aca78d
MD		 298 if (ret) {
299 fprintf(stderr, "Error (%d) in dlclose\n", ret);
300 abort();
301 }
46c881a7
MD		 302 memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
303 }
304}
305
306#endif
307
deb6e540
MD		 308#ifdef TRACEPOINT_DEFINE
309
558b9d86
MD		 310/*
311 * These weak symbols, the constructor, and destructor take care of
312 * registering only _one_ instance of the tracepoints per shared-ojbect
313 * (or for the whole main program).
314 */
315extern struct tracepoint * const __start___tracepoints_ptrs[]
316 __attribute__((weak, visibility("hidden")));
317extern struct tracepoint * const __stop___tracepoints_ptrs[]
318 __attribute__((weak, visibility("hidden")));
319
628e1d81
MD		 320/*
321 * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
322 * unresolved symbol that requires the provider to be linked in. When
323 * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
324 * unresolved symbol that depends on having the provider linked in,
325 * otherwise the linker complains. This deals with use of static
326 * libraries, ensuring that the linker does not remove the provider
327 * object from the executable.
328 */
329#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
b4f3bc52 330#define _TRACEPOINT_UNDEFINED_REF(provider) NULL
628e1d81 331#else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
b4f3bc52 332#define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider
628e1d81
MD		 333#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
334
b728d87e
MD		 335/*
336 * Note: to allow PIC code, we need to allow the linker to update the pointers
337 * in the __tracepoints_ptrs section.
338 * Therefore, this section is _not_ const (read-only).
339 */
b4f3bc52
MD		 340#define _TP_EXTRACT_STRING(...) #__VA_ARGS__
341
342#define _DEFINE_TRACEPOINT(_provider, _name, _args) \
343 extern int __tracepoint_provider_##_provider; \
344 static const char __tp_strtab_##_provider##___##_name[] \
b728d87e 345 __attribute__((section("__tracepoints_strings"))) = \
b4f3bc52
MD		 346 #_provider ":" #_name; \
347 struct tracepoint __tracepoint_##_provider##___##_name \
b728d87e 348 __attribute__((section("__tracepoints"))) = \
b4f3bc52
MD		 349 { \
350 __tp_strtab_##_provider##___##_name, \
351 0, \
352 NULL, \
353 _TRACEPOINT_UNDEFINED_REF(_provider), \
354 _TP_EXTRACT_STRING(_args), \
10e594aa 355 { }, \
b4f3bc52
MD		 356 }; \
357 static struct tracepoint * __tracepoint_ptr_##_provider##___##_name \
b728d87e 358 __attribute__((used, section("__tracepoints_ptrs"))) = \
b4f3bc52 359 &__tracepoint_##_provider##___##_name;
b728d87e 360
a8909ba5 361static void lttng_ust_notrace __attribute__((constructor))
46c881a7 362__tracepoints__ptrs_init(void);
a8909ba5 363static void
46c881a7 364__tracepoints__ptrs_init(void)
b728d87e 365{
46c881a7 366 if (__tracepoint_ptrs_registered++)
b728d87e 367 return;
46c881a7
MD		 368 if (!tracepoint_dlopen.liblttngust_handle)
369 tracepoint_dlopen.liblttngust_handle =
370 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
51920067 371 if (!tracepoint_dlopen.liblttngust_handle)
deb6e540 372 return;
99234da6
MD		 373 tracepoint_dlopen.tracepoint_register_lib =
374 URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int),
375 dlsym(tracepoint_dlopen.liblttngust_handle,
376 "tracepoint_register_lib"));
377 tracepoint_dlopen.tracepoint_unregister_lib =
378 URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
379 dlsym(tracepoint_dlopen.liblttngust_handle,
380 "tracepoint_unregister_lib"));
381 __tracepoint__init_urcu_sym();
382 if (tracepoint_dlopen.tracepoint_register_lib) {
383 tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs,
46c881a7
MD		 384 __stop___tracepoints_ptrs -
385 __start___tracepoints_ptrs);
99234da6 386 }
b728d87e
MD		 387}
388
a8909ba5 389static void lttng_ust_notrace __attribute__((destructor))
46c881a7 390__tracepoints__ptrs_destroy(void);
a8909ba5 391static void
46c881a7 392__tracepoints__ptrs_destroy(void)
b728d87e 393{
deb6e540 394 int ret;
51920067 395
46c881a7 396 if (--__tracepoint_ptrs_registered)
b728d87e 397 return;
46c881a7
MD		 398 if (tracepoint_dlopen.tracepoint_unregister_lib)
399 tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs);
400 if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_registered) {
51920067 401 ret = dlclose(tracepoint_dlopen.liblttngust_handle);
76aca78d
MD		 402 if (ret) {
403 fprintf(stderr, "Error (%d) in dlclose\n", ret);
404 abort();
405 }
51920067 406 memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
deb6e540 407 }
b728d87e
MD		 408}
409
46c881a7
MD		 410#else /* TRACEPOINT_DEFINE */
411
412#define _DEFINE_TRACEPOINT(_provider, _name, _args)
413
414#endif /* #else TRACEPOINT_DEFINE */
deb6e540 415
b728d87e
MD		 416#ifdef __cplusplus
417}
418#endif
419
420#endif /* _LTTNG_TRACEPOINT_H */
421
422/* The following declarations must be outside re-inclusion protection. */
423
424#ifndef TRACEPOINT_EVENT
425
426/*
427 * How to use the TRACEPOINT_EVENT macro:
428 *
429 * An example:
430 *
431 * TRACEPOINT_EVENT(someproject_component, event_name,
432 *
433 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
434 *
435 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
436 * long *, arg4, size_t, arg4_len),
437 *
438 * * TP_FIELDS describes the event payload layout in the trace *
439 *
440 * TP_FIELDS(
441 * * Integer, printed in base 10 *
442 * ctf_integer(int, field_a, arg0)
443 *
444 * * Integer, printed with 0x base 16 *
445 * ctf_integer_hex(unsigned long, field_d, arg1)
446 *
447 * * Array Sequence, printed as UTF8-encoded array of bytes *
448 * ctf_array_text(char, field_b, string, FIXED_LEN)
449 * ctf_sequence_text(char, field_c, string, size_t, strlen)
450 *
451 * * String, printed as UTF8-encoded string *
452 * ctf_string(field_e, string)
453 *
454 * * Array sequence of signed integer values *
455 * ctf_array(long, field_f, arg4, FIXED_LEN4)
456 * ctf_sequence(long, field_g, arg4, size_t, arg4_len)
457 * )
458 * )
459 *
460 * More detailed explanation:
461 *
462 * The name of the tracepoint is expressed as a tuple with the provider
463 * and name arguments.
464 *
465 * The provider and name should be a proper C99 identifier.
466 * The "provider" and "name" MUST follow these rules to ensure no
467 * namespace clash occurs:
468 *
469 * For projects (applications and libraries) for which an entity
470 * specific to the project controls the source code and thus its
471 * tracepoints (typically with a scope larger than a single company):
472 *
473 * either:
474 * project_component, event
475 * or:
476 * project, event
477 *
478 * Where "project" is the name of the project,
479 * "component" is the name of the project component (which may
480 * include several levels of sub-components, e.g.
481 * ...component_subcomponent_...) where the tracepoint is located
482 * (optional),
483 * "event" is the name of the tracepoint event.
484 *
485 * For projects issued from a single company wishing to advertise that
486 * the company controls the source code and thus the tracepoints, the
487 * "com_" prefix should be used:
488 *
489 * either:
490 * com_company_project_component, event
491 * or:
492 * com_company_project, event
493 *
494 * Where "company" is the name of the company,
495 * "project" is the name of the project,
496 * "component" is the name of the project component (which may
497 * include several levels of sub-components, e.g.
498 * ...component_subcomponent_...) where the tracepoint is located
499 * (optional),
500 * "event" is the name of the tracepoint event.
501 *
502 * the provider:event identifier is limited to 127 characters.
503 */
504
b728d87e 505#define TRACEPOINT_EVENT(provider, name, args, fields) \
deb6e540 506 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
b4f3bc52 507 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
b728d87e
MD		 508
509#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
510
511#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
deb6e540 512 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
b4f3bc52 513 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
b728d87e
MD		 514
515#endif /* #ifndef TRACEPOINT_EVENT */
516
517#ifndef TRACEPOINT_LOGLEVEL
518
519/*
75c5ad79 520 * Tracepoint Loglevels
b728d87e
MD		 521 *
522 * Typical use of these loglevels:
523 *
d8de1354 524 * The loglevels go from 0 to 14. Higher numbers imply the most
75c5ad79
MD		 525 * verbosity (higher event throughput expected.
526 *
d8de1354
MD		 527 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
528 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
529 * debug information.
75c5ad79 530 *
d8de1354 531 * TRACE_EMERG 0
75c5ad79
MD		 532 * system is unusable
533 *
d8de1354 534 * TRACE_ALERT 1
75c5ad79
MD		 535 * action must be taken immediately
536 *
d8de1354 537 * TRACE_CRIT 2
75c5ad79
MD		 538 * critical conditions
539 *
d8de1354 540 * TRACE_ERR 3
75c5ad79
MD		 541 * error conditions
542 *
d8de1354 543 * TRACE_WARNING 4
75c5ad79
MD		 544 * warning conditions
545 *
d8de1354 546 * TRACE_NOTICE 5
75c5ad79
MD		 547 * normal, but significant, condition
548 *
d8de1354 549 * TRACE_INFO 6
75c5ad79
MD		 550 * informational message
551 *
d8de1354
MD		 552 * TRACE_DEBUG_SYSTEM 7
553 * debug information with system-level scope (set of programs)
75c5ad79 554 *
d8de1354
MD		 555 * TRACE_DEBUG_PROGRAM 8
556 * debug information with program-level scope (set of processes)
75c5ad79 557 *
d8de1354
MD		 558 * TRACE_DEBUG_PROCESS 9
559 * debug information with process-level scope (set of modules)
75c5ad79 560 *
d8de1354
MD		 561 * TRACE_DEBUG_MODULE 10
562 * debug information with module (executable/library) scope (set of units)
75c5ad79 563 *
d8de1354
MD		 564 * TRACE_DEBUG_UNIT 11
565 * debug information with compilation unit scope (set of functions)
75c5ad79 566 *
d8de1354
MD		 567 * TRACE_DEBUG_FUNCTION 12
568 * debug information with function-level scope
75c5ad79 569 *
d8de1354
MD		 570 * TRACE_DEBUG_LINE 13
571 * debug information with line-level scope (TRACEPOINT_EVENT default)
902e1379 572 *
d8de1354 573 * TRACE_DEBUG 14
1e3b0059 574 * debug-level message
75c5ad79
MD		 575 *
576 * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
577 * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
853cda88
MD		 578 * tracepoint name. The first field is the provider name, the second
579 * field is the name of the tracepoint, the third field is the loglevel
580 * name.
b728d87e
MD		 581 *
582 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
583 * < loglevel_name >)
584 *
75c5ad79
MD		 585 * The TRACEPOINT_PROVIDER must be already declared before declaring a
586 * TRACEPOINT_LOGLEVEL.
b728d87e
MD		 587 */
588
882a56d7 589enum {
d8de1354
MD		 590 TRACE_EMERG = 0,
591 TRACE_ALERT = 1,
592 TRACE_CRIT = 2,
593 TRACE_ERR = 3,
594 TRACE_WARNING = 4,
595 TRACE_NOTICE = 5,
596 TRACE_INFO = 6,
597 TRACE_DEBUG_SYSTEM = 7,
598 TRACE_DEBUG_PROGRAM = 8,
599 TRACE_DEBUG_PROCESS = 9,
600 TRACE_DEBUG_MODULE = 10,
601 TRACE_DEBUG_UNIT = 11,
602 TRACE_DEBUG_FUNCTION = 12,
603 TRACE_DEBUG_LINE = 13,
604 TRACE_DEBUG = 14,
882a56d7
MD		 605};
606
05ceaafd 607#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
b728d87e
MD		 608
609#endif /* #ifndef TRACEPOINT_LOGLEVEL */
6ddc916d
MD		 610
611#ifndef TRACEPOINT_MODEL_EMF_URI
612
613#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
614
615#endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */
LTTng 2.0 Userspace Tracer
This page took 0.05375 seconds and 4 git commands to generate.