projects / lttng-ust.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fix: Fix self-assign warning on struct ustfork_clone_info init
[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.
b728d87e
MD		 16 */
17
8fce9e2b 18#include <lttng/tracepoint-types.h>
40b2b5a4 19#include <lttng/tracepoint-rcu.h>
b728d87e 20#include <urcu/compiler.h>
deb6e540 21#include <dlfcn.h> /* for dlopen */
51920067 22#include <string.h> /* for memset */
40b2b5a4 23#include <assert.h>
b2f60c79 24#include <lttng/ust-config.h> /* for sdt */
a8909ba5 25#include <lttng/ust-compiler.h>
b2f60c79
MD		 26
27#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
28#define SDT_USE_VARIADIC
29#include <sys/sdt.h>
30#else
31#define STAP_PROBEV(...)
32#endif
b728d87e
MD		 33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
9dcd5e6d
MD		 38#define tracepoint(provider, name, ...) \
39 do { \
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); \
44 } \
b728d87e
MD		 45 } while (0)
46
47#define TP_ARGS(...) __VA_ARGS__
48
49/*
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
52 * fine too).
53 * Each tuple is also separated by a comma.
54 */
df854e41
MD		 55#define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
56 _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)
b728d87e 67
4495dd39
MD		 68/*
69 * _TP_EXVAR* extract the var names.
70 * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
71 */
b728d87e 72#define _TP_EXVAR0()
4495dd39 73#define _TP_EXVAR1(a)
b728d87e
MD		 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
84
85#define _TP_EXDATA_VAR0() __tp_data
4495dd39 86#define _TP_EXDATA_VAR1(a) __tp_data
b728d87e
MD		 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
97
4495dd39
MD		 98/*
99 * _TP_EXPROTO* extract tuples of type, var.
100 * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
101 */
86637aa6 102#define _TP_EXPROTO0() void
4495dd39 103#define _TP_EXPROTO1(a) void
b728d87e
MD		 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
114
115#define _TP_EXDATA_PROTO0() void *__tp_data
4495dd39 116#define _TP_EXDATA_PROTO1(a) void *__tp_data
b728d87e
MD		 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
127
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
23c8854a
MD		 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__))
b728d87e 135#define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
23c8854a 136#define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
b728d87e 137#define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
23c8854a 138#define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
b728d87e
MD		 139#define _TP_PARAMS(...) __VA_ARGS__
140
e8e05404
MD		 141/*
142 * The tracepoint cb is marked always inline so we can distinguish
143 * between caller's ip addresses within the probe using the return
144 * address.
145 */
0f2f7e21
MD		 146#define _DECLARE_TRACEPOINT(_provider, _name, ...) \
147extern struct tracepoint __tracepoint_##_provider##___##_name; \
e8e05404 148static inline __attribute__((always_inline)) lttng_ust_notrace \
a8909ba5 149void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \
e8e05404 150static \
a8909ba5 151void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
b728d87e
MD		 152{ \
153 struct tracepoint_probe *__tp_probe; \
154 \
40b2b5a4 155 if (!TP_RCU_LINK_TEST()) \
deb6e540 156 return; \
40b2b5a4 157 tp_rcu_read_lock_bp(); \
0f2f7e21 158 __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
23c8854a 159 if (caa_unlikely(!__tp_probe)) \
b728d87e
MD		 160 goto end; \
161 do { \
fbdeb5ec 162 void (*__tp_cb)(void) = __tp_probe->func; \
23c8854a 163 void *__tp_data = __tp_probe->data; \
b728d87e 164 \
23c8854a
MD		 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); \
b728d87e 168end: \
40b2b5a4 169 tp_rcu_read_unlock_bp(); \
b728d87e 170} \
a8909ba5
PW		 171static inline lttng_ust_notrace \
172void __tracepoint_register_##_provider##___##_name(char *name, \
173 void (*func)(void), void *data); \
174static inline \
175void __tracepoint_register_##_provider##___##_name(char *name, \
176 void (*func)(void), void *data) \
b728d87e 177{ \
67e5f391
MD		 178 __tracepoint_probe_register(name, func, data, \
179 __tracepoint_##_provider##___##_name.signature); \
b728d87e 180} \
a8909ba5
PW		 181static inline lttng_ust_notrace \
182void __tracepoint_unregister_##_provider##___##_name(char *name, \
183 void (*func)(void), void *data); \
184static inline \
185void __tracepoint_unregister_##_provider##___##_name(char *name, \
186 void (*func)(void), void *data) \
b728d87e 187{ \
23c8854a 188 __tracepoint_probe_unregister(name, func, data); \
b728d87e
MD		 189}
190
fbdeb5ec
MD		 191extern int __tracepoint_probe_register(const char *name, void (*func)(void),
192 void *data, const char *signature);
193extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
194 void *data);
deb6e540 195
51920067
MD		 196/*
197 * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
198 * shared across objects in a module/main executable.
199 */
200struct tracepoint_dlopen {
201 void *liblttngust_handle;
202
203 int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start,
204 int tracepoints_count);
205 int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start);
206#ifndef _LGPL_SOURCE
207 void (*rcu_read_lock_sym_bp)(void);
208 void (*rcu_read_unlock_sym_bp)(void);
209 void *(*rcu_dereference_sym_bp)(void *p);
210#endif
211};
212
213extern struct tracepoint_dlopen tracepoint_dlopen;
214
4e776b26
MD		 215struct tracepoint_callsite_dlopen {
216 void *liblttngust_handle;
217
218 int (*tracepoint_register_lib_callsite)(struct tracepoint_callsite * const *tp_start,
219 int tp_count);
220 int (*tracepoint_unregister_lib_callsite)(struct tracepoint_callsite * const *tp_start,
221 int tp_count);
222};
223
224struct tracepoint_callsite_dlopen tracepoint_callsite_dlopen
225 __attribute__((weak, visibility("hidden")));
226int __tracepoint_callsite_registered
227 __attribute__((weak, visibility("hidden")));
228
a818861c
MD		 229#if (CAA_BITS_PER_LONG == 64)
230#define __TP_ASM_PTR ".quad "
231#else
232#define __TP_ASM_PTR ".long "
233#endif
234
4e776b26
MD		 235/*
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).
239 */
240#define TRACEPOINT_CALLSITE(_provider, _name) \
a818861c
MD		 241do { \
242 asm volatile ( ".pushsection __tracepoint_callsite, \"aw\"\n\t" \
243 "1:\n\t" \
244 __TP_ASM_PTR "%c0, %c1, %c2, 2f\n\t" \
245 ".int %c3\n\t" \
246 ".space 16\n\t" /* padding */ \
247 ".popsection\n\t" \
248 ".pushsection __tracepoint_callsite_ptrs, \"aw\"\n\t" \
249 __TP_ASM_PTR "1b\n\t" \
250 ".popsection\n\t" \
251 "2:\n\t" \
252 : : "i" (#_provider ":" #_name), \
253 "i" (__func__), \
254 "i" (__FILE__), \
255 "i" (__LINE__)); \
256} while (0)
4e776b26
MD		 257
258/*
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).
262 */
263extern struct tracepoint_callsite * const __start___tracepoint_callsite_ptrs[]
264 __attribute__((weak, visibility("hidden")));
265extern struct tracepoint_callsite * const __stop___tracepoint_callsite_ptrs[]
266 __attribute__((weak, visibility("hidden")));
267
268/*
269 * We need at least one pointer in the section.
270 */
271static struct tracepoint_callsite *
272 __tracepoint_callsite_ptr_dummy
273 __attribute__((used, section("__tracepoint_callsite_ptrs"))) =
274 NULL;
275
276static void lttng_ust_notrace __attribute__((constructor))
277__tracepoint_callsite__init(void);
278static void
279__tracepoint_callsite__init(void)
280{
281 if (__tracepoint_callsite_registered++)
282 return;
283
284 tracepoint_callsite_dlopen.liblttngust_handle =
285 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
286 if (!tracepoint_callsite_dlopen.liblttngust_handle)
287 return;
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);
299}
300
301static void lttng_ust_notrace __attribute__((destructor))
302__tracepoint_callsite__destroy(void);
303static void
304__tracepoint_callsite__destroy(void)
305{
306 int ret;
307
308 if (--__tracepoint_callsite_registered)
309 return;
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);
316 assert(!ret);
317 memset(&tracepoint_callsite_dlopen, 0, sizeof(tracepoint_callsite_dlopen));
318 }
319}
320
deb6e540
MD		 321#ifdef TRACEPOINT_DEFINE
322
628e1d81
MD		 323/*
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.
331 */
332#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
b4f3bc52 333#define _TRACEPOINT_UNDEFINED_REF(provider) NULL
628e1d81 334#else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
b4f3bc52 335#define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider
628e1d81
MD		 336#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
337
b728d87e
MD		 338/*
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).
342 */
b4f3bc52
MD		 343#define _TP_EXTRACT_STRING(...) #__VA_ARGS__
344
345#define _DEFINE_TRACEPOINT(_provider, _name, _args) \
346 extern int __tracepoint_provider_##_provider; \
347 static const char __tp_strtab_##_provider##___##_name[] \
b728d87e 348 __attribute__((section("__tracepoints_strings"))) = \
b4f3bc52
MD		 349 #_provider ":" #_name; \
350 struct tracepoint __tracepoint_##_provider##___##_name \
b728d87e 351 __attribute__((section("__tracepoints"))) = \
b4f3bc52
MD		 352 { \
353 __tp_strtab_##_provider##___##_name, \
354 0, \
355 NULL, \
356 _TRACEPOINT_UNDEFINED_REF(_provider), \
357 _TP_EXTRACT_STRING(_args), \
358 }; \
359 static struct tracepoint * __tracepoint_ptr_##_provider##___##_name \
b728d87e 360 __attribute__((used, section("__tracepoints_ptrs"))) = \
b4f3bc52 361 &__tracepoint_##_provider##___##_name;
b728d87e 362
b728d87e
MD		 363/*
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).
367 */
368extern struct tracepoint * const __start___tracepoints_ptrs[]
369 __attribute__((weak, visibility("hidden")));
370extern struct tracepoint * const __stop___tracepoints_ptrs[]
371 __attribute__((weak, visibility("hidden")));
372int __tracepoint_registered
373 __attribute__((weak, visibility("hidden")));
51920067
MD		 374struct tracepoint_dlopen tracepoint_dlopen
375 __attribute__((weak, visibility("hidden")));
b728d87e 376
a8909ba5
PW		 377static void lttng_ust_notrace __attribute__((constructor))
378__tracepoints__init(void);
379static void
380__tracepoints__init(void)
b728d87e
MD		 381{
382 if (__tracepoint_registered++)
383 return;
deb6e540 384
51920067
MD		 385 tracepoint_dlopen.liblttngust_handle =
386 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
387 if (!tracepoint_dlopen.liblttngust_handle)
deb6e540 388 return;
51920067 389 tracepoint_dlopen.tracepoint_register_lib =
93ffe366 390 URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int),
51920067 391 dlsym(tracepoint_dlopen.liblttngust_handle,
93ffe366 392 "tracepoint_register_lib"));
51920067 393 tracepoint_dlopen.tracepoint_unregister_lib =
93ffe366 394 URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
51920067 395 dlsym(tracepoint_dlopen.liblttngust_handle,
93ffe366 396 "tracepoint_unregister_lib"));
40b2b5a4 397#ifndef _LGPL_SOURCE
51920067 398 tracepoint_dlopen.rcu_read_lock_sym_bp =
40b2b5a4 399 URCU_FORCE_CAST(void (*)(void),
51920067 400 dlsym(tracepoint_dlopen.liblttngust_handle,
40b2b5a4 401 "tp_rcu_read_lock_bp"));
51920067 402 tracepoint_dlopen.rcu_read_unlock_sym_bp =
40b2b5a4 403 URCU_FORCE_CAST(void (*)(void),
51920067 404 dlsym(tracepoint_dlopen.liblttngust_handle,
40b2b5a4 405 "tp_rcu_read_unlock_bp"));
51920067 406 tracepoint_dlopen.rcu_dereference_sym_bp =
40b2b5a4 407 URCU_FORCE_CAST(void *(*)(void *p),
51920067 408 dlsym(tracepoint_dlopen.liblttngust_handle,
40b2b5a4
MD		 409 "tp_rcu_dereference_sym_bp"));
410#endif
51920067 411 tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs,
b728d87e
MD		 412 __stop___tracepoints_ptrs -
413 __start___tracepoints_ptrs);
414}
415
a8909ba5
PW		 416static void lttng_ust_notrace __attribute__((destructor))
417__tracepoints__destroy(void);
418static void
419__tracepoints__destroy(void)
b728d87e 420{
deb6e540 421 int ret;
51920067 422
b728d87e
MD		 423 if (--__tracepoint_registered)
424 return;
51920067
MD		 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);
deb6e540 429 assert(!ret);
51920067 430 memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
deb6e540 431 }
b728d87e
MD		 432}
433
deb6e540
MD		 434#else /* TRACEPOINT_DEFINE */
435
b4f3bc52 436#define _DEFINE_TRACEPOINT(_provider, _name, _args)
deb6e540
MD		 437
438#endif /* #else TRACEPOINT_DEFINE */
439
b728d87e
MD		 440#ifdef __cplusplus
441}
442#endif
443
444#endif /* _LTTNG_TRACEPOINT_H */
445
446/* The following declarations must be outside re-inclusion protection. */
447
448#ifndef TRACEPOINT_EVENT
449
450/*
451 * How to use the TRACEPOINT_EVENT macro:
452 *
453 * An example:
454 *
455 * TRACEPOINT_EVENT(someproject_component, event_name,
456 *
457 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
458 *
459 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
460 * long *, arg4, size_t, arg4_len),
461 *
462 * * TP_FIELDS describes the event payload layout in the trace *
463 *
464 * TP_FIELDS(
465 * * Integer, printed in base 10 *
466 * ctf_integer(int, field_a, arg0)
467 *
468 * * Integer, printed with 0x base 16 *
469 * ctf_integer_hex(unsigned long, field_d, arg1)
470 *
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)
474 *
475 * * String, printed as UTF8-encoded string *
476 * ctf_string(field_e, string)
477 *
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)
481 * )
482 * )
483 *
484 * More detailed explanation:
485 *
486 * The name of the tracepoint is expressed as a tuple with the provider
487 * and name arguments.
488 *
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:
492 *
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):
496 *
497 * either:
498 * project_component, event
499 * or:
500 * project, event
501 *
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
506 * (optional),
507 * "event" is the name of the tracepoint event.
508 *
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:
512 *
513 * either:
514 * com_company_project_component, event
515 * or:
516 * com_company_project, event
517 *
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
523 * (optional),
524 * "event" is the name of the tracepoint event.
525 *
526 * the provider:event identifier is limited to 127 characters.
527 */
528
b728d87e 529#define TRACEPOINT_EVENT(provider, name, args, fields) \
deb6e540 530 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
b4f3bc52 531 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
b728d87e
MD		 532
533#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
534
535#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
deb6e540 536 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
b4f3bc52 537 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
b728d87e
MD		 538
539#endif /* #ifndef TRACEPOINT_EVENT */
540
541#ifndef TRACEPOINT_LOGLEVEL
542
543/*
75c5ad79 544 * Tracepoint Loglevels
b728d87e
MD		 545 *
546 * Typical use of these loglevels:
547 *
d8de1354 548 * The loglevels go from 0 to 14. Higher numbers imply the most
75c5ad79
MD		 549 * verbosity (higher event throughput expected.
550 *
d8de1354
MD		 551 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
552 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
553 * debug information.
75c5ad79 554 *
d8de1354 555 * TRACE_EMERG 0
75c5ad79
MD		 556 * system is unusable
557 *
d8de1354 558 * TRACE_ALERT 1
75c5ad79
MD		 559 * action must be taken immediately
560 *
d8de1354 561 * TRACE_CRIT 2
75c5ad79
MD		 562 * critical conditions
563 *
d8de1354 564 * TRACE_ERR 3
75c5ad79
MD		 565 * error conditions
566 *
d8de1354 567 * TRACE_WARNING 4
75c5ad79
MD		 568 * warning conditions
569 *
d8de1354 570 * TRACE_NOTICE 5
75c5ad79
MD		 571 * normal, but significant, condition
572 *
d8de1354 573 * TRACE_INFO 6
75c5ad79
MD		 574 * informational message
575 *
d8de1354
MD		 576 * TRACE_DEBUG_SYSTEM 7
577 * debug information with system-level scope (set of programs)
75c5ad79 578 *
d8de1354
MD		 579 * TRACE_DEBUG_PROGRAM 8
580 * debug information with program-level scope (set of processes)
75c5ad79 581 *
d8de1354
MD		 582 * TRACE_DEBUG_PROCESS 9
583 * debug information with process-level scope (set of modules)
75c5ad79 584 *
d8de1354
MD		 585 * TRACE_DEBUG_MODULE 10
586 * debug information with module (executable/library) scope (set of units)
75c5ad79 587 *
d8de1354
MD		 588 * TRACE_DEBUG_UNIT 11
589 * debug information with compilation unit scope (set of functions)
75c5ad79 590 *
d8de1354
MD		 591 * TRACE_DEBUG_FUNCTION 12
592 * debug information with function-level scope
75c5ad79 593 *
d8de1354
MD		 594 * TRACE_DEBUG_LINE 13
595 * debug information with line-level scope (TRACEPOINT_EVENT default)
902e1379 596 *
d8de1354 597 * TRACE_DEBUG 14
902e1379 598 * debug-level message (trace_printf default)
75c5ad79
MD		 599 *
600 * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
601 * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
853cda88
MD		 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
604 * name.
b728d87e
MD		 605 *
606 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
607 * < loglevel_name >)
608 *
75c5ad79
MD		 609 * The TRACEPOINT_PROVIDER must be already declared before declaring a
610 * TRACEPOINT_LOGLEVEL.
b728d87e
MD		 611 */
612
882a56d7 613enum {
d8de1354
MD		 614 TRACE_EMERG = 0,
615 TRACE_ALERT = 1,
616 TRACE_CRIT = 2,
617 TRACE_ERR = 3,
618 TRACE_WARNING = 4,
619 TRACE_NOTICE = 5,
620 TRACE_INFO = 6,
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,
628 TRACE_DEBUG = 14,
882a56d7
MD		 629};
630
05ceaafd 631#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
b728d87e
MD		 632
633#endif /* #ifndef TRACEPOINT_LOGLEVEL */
6ddc916d
MD		 634
635#ifndef TRACEPOINT_MODEL_EMF_URI
636
637#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
638
639#endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */
LTTng 2.0 Userspace Tracer
This page took 0.054077 seconds and 4 git commands to generate.