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