projects / lttng-ust.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fix: tracepoint header: declare tracepoint_dlopen_ptr
[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#ifndef _LGPL_SOURCE
222 void (*rcu_read_lock_sym_bp)(void);
223 void (*rcu_read_unlock_sym_bp)(void);
224 void *(*rcu_dereference_sym_bp)(void *p);
225#endif
226};
227
1a206094 228extern struct lttng_ust_tracepoint_dlopen tracepoint_dlopen;
1b5274d2 229extern struct lttng_ust_tracepoint_dlopen *tracepoint_dlopen_ptr;
51920067 230
46c881a7
MD		 231#if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES)
232
233/*
234 * These weak symbols, the constructor, and destructor take care of
235 * registering only _one_ instance of the tracepoints per shared-ojbect
236 * (or for the whole main program).
237 */
238int __tracepoint_registered
239 __attribute__((weak, visibility("hidden")));
240int __tracepoint_ptrs_registered
241 __attribute__((weak, visibility("hidden")));
1a206094 242struct lttng_ust_tracepoint_dlopen tracepoint_dlopen
46c881a7 243 __attribute__((weak, visibility("hidden")));
1e4e01a7
MD		 244/*
245 * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
246 * 4.8 and prior does not have the same behavior for symbol scoping on
247 * 32-bit powerpc depending on the object size: symbols for objects of 8
248 * bytes or less have the same address throughout a module, whereas they
249 * have different addresses between compile units for objects larger
250 * than 8 bytes. Add this pointer indirection to ensure that the symbol
251 * scoping match that of the other weak hidden symbols found in this
252 * header.
253 */
254struct lttng_ust_tracepoint_dlopen *tracepoint_dlopen_ptr
255 __attribute__((weak, visibility("hidden")));
46c881a7 256
99234da6
MD		 257#ifndef _LGPL_SOURCE
258static inline void lttng_ust_notrace
259__tracepoint__init_urcu_sym(void);
260static inline void
261__tracepoint__init_urcu_sym(void)
262{
1e4e01a7
MD		 263 if (!tracepoint_dlopen_ptr)
264 tracepoint_dlopen_ptr = &tracepoint_dlopen;
99234da6
MD		 265 /*
266 * Symbols below are needed by tracepoint call sites and probe
267 * providers.
268 */
1e4e01a7
MD		 269 if (!tracepoint_dlopen_ptr->rcu_read_lock_sym_bp)
270 tracepoint_dlopen_ptr->rcu_read_lock_sym_bp =
99234da6 271 URCU_FORCE_CAST(void (*)(void),
1e4e01a7 272 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
99234da6 273 "tp_rcu_read_lock_bp"));
1e4e01a7
MD		 274 if (!tracepoint_dlopen_ptr->rcu_read_unlock_sym_bp)
275 tracepoint_dlopen_ptr->rcu_read_unlock_sym_bp =
99234da6 276 URCU_FORCE_CAST(void (*)(void),
1e4e01a7 277 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
99234da6 278 "tp_rcu_read_unlock_bp"));
1e4e01a7
MD		 279 if (!tracepoint_dlopen_ptr->rcu_dereference_sym_bp)
280 tracepoint_dlopen_ptr->rcu_dereference_sym_bp =
99234da6 281 URCU_FORCE_CAST(void *(*)(void *p),
1e4e01a7 282 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
99234da6
MD		 283 "tp_rcu_dereference_sym_bp"));
284}
285#else
286static inline void lttng_ust_notrace
287__tracepoint__init_urcu_sym(void);
288static inline void
289__tracepoint__init_urcu_sym(void)
290{
291}
292#endif
293
46c881a7
MD		 294static void lttng_ust_notrace __attribute__((constructor))
295__tracepoints__init(void);
296static void
297__tracepoints__init(void)
298{
299 if (__tracepoint_registered++)
300 return;
301
1e4e01a7
MD		 302 if (!tracepoint_dlopen_ptr)
303 tracepoint_dlopen_ptr = &tracepoint_dlopen;
304 if (!tracepoint_dlopen_ptr->liblttngust_handle)
305 tracepoint_dlopen_ptr->liblttngust_handle =
46c881a7 306 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
1e4e01a7 307 if (!tracepoint_dlopen_ptr->liblttngust_handle)
46c881a7 308 return;
99234da6 309 __tracepoint__init_urcu_sym();
46c881a7
MD		 310}
311
312static void lttng_ust_notrace __attribute__((destructor))
313__tracepoints__destroy(void);
314static void
315__tracepoints__destroy(void)
316{
317 int ret;
318
319 if (--__tracepoint_registered)
320 return;
1e4e01a7
MD		 321 if (!tracepoint_dlopen_ptr)
322 tracepoint_dlopen_ptr = &tracepoint_dlopen;
323 if (tracepoint_dlopen_ptr->liblttngust_handle && !__tracepoint_ptrs_registered) {
324 ret = dlclose(tracepoint_dlopen_ptr->liblttngust_handle);
76aca78d
MD		 325 if (ret) {
326 fprintf(stderr, "Error (%d) in dlclose\n", ret);
327 abort();
328 }
1e4e01a7 329 memset(tracepoint_dlopen_ptr, 0, sizeof(*tracepoint_dlopen_ptr));
46c881a7
MD		 330 }
331}
332
333#endif
334
deb6e540
MD		 335#ifdef TRACEPOINT_DEFINE
336
558b9d86
MD		 337/*
338 * These weak symbols, the constructor, and destructor take care of
339 * registering only _one_ instance of the tracepoints per shared-ojbect
340 * (or for the whole main program).
341 */
1a206094 342extern struct lttng_ust_tracepoint * const __start___tracepoints_ptrs[]
558b9d86 343 __attribute__((weak, visibility("hidden")));
1a206094 344extern struct lttng_ust_tracepoint * const __stop___tracepoints_ptrs[]
558b9d86
MD		 345 __attribute__((weak, visibility("hidden")));
346
628e1d81
MD		 347/*
348 * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
349 * unresolved symbol that requires the provider to be linked in. When
350 * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
351 * unresolved symbol that depends on having the provider linked in,
352 * otherwise the linker complains. This deals with use of static
353 * libraries, ensuring that the linker does not remove the provider
354 * object from the executable.
355 */
356#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
b4f3bc52 357#define _TRACEPOINT_UNDEFINED_REF(provider) NULL
628e1d81 358#else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
b4f3bc52 359#define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider
628e1d81
MD		 360#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
361
b728d87e
MD		 362/*
363 * Note: to allow PIC code, we need to allow the linker to update the pointers
364 * in the __tracepoints_ptrs section.
365 * Therefore, this section is _not_ const (read-only).
366 */
b4f3bc52
MD		 367#define _TP_EXTRACT_STRING(...) #__VA_ARGS__
368
369#define _DEFINE_TRACEPOINT(_provider, _name, _args) \
370 extern int __tracepoint_provider_##_provider; \
371 static const char __tp_strtab_##_provider##___##_name[] \
b728d87e 372 __attribute__((section("__tracepoints_strings"))) = \
b4f3bc52 373 #_provider ":" #_name; \
1a206094 374 struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name \
b728d87e 375 __attribute__((section("__tracepoints"))) = \
b4f3bc52
MD		 376 { \
377 __tp_strtab_##_provider##___##_name, \
378 0, \
379 NULL, \
380 _TRACEPOINT_UNDEFINED_REF(_provider), \
381 _TP_EXTRACT_STRING(_args), \
10e594aa 382 { }, \
b4f3bc52 383 }; \
1a206094
SM		 384 static struct lttng_ust_tracepoint * \
385 __tracepoint_ptr_##_provider##___##_name \
b728d87e 386 __attribute__((used, section("__tracepoints_ptrs"))) = \
b4f3bc52 387 &__tracepoint_##_provider##___##_name;
b728d87e 388
a8909ba5 389static void lttng_ust_notrace __attribute__((constructor))
46c881a7 390__tracepoints__ptrs_init(void);
a8909ba5 391static void
46c881a7 392__tracepoints__ptrs_init(void)
b728d87e 393{
46c881a7 394 if (__tracepoint_ptrs_registered++)
b728d87e 395 return;
1e4e01a7
MD		 396 if (!tracepoint_dlopen_ptr)
397 tracepoint_dlopen_ptr = &tracepoint_dlopen;
398 if (!tracepoint_dlopen_ptr->liblttngust_handle)
399 tracepoint_dlopen_ptr->liblttngust_handle =
46c881a7 400 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
1e4e01a7 401 if (!tracepoint_dlopen_ptr->liblttngust_handle)
deb6e540 402 return;
1e4e01a7 403 tracepoint_dlopen_ptr->tracepoint_register_lib =
1a206094 404 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int),
1e4e01a7 405 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
99234da6 406 "tracepoint_register_lib"));
1e4e01a7 407 tracepoint_dlopen_ptr->tracepoint_unregister_lib =
1a206094 408 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *),
1e4e01a7 409 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
99234da6
MD		 410 "tracepoint_unregister_lib"));
411 __tracepoint__init_urcu_sym();
1e4e01a7
MD		 412 if (tracepoint_dlopen_ptr->tracepoint_register_lib) {
413 tracepoint_dlopen_ptr->tracepoint_register_lib(__start___tracepoints_ptrs,
46c881a7
MD		 414 __stop___tracepoints_ptrs -
415 __start___tracepoints_ptrs);
99234da6 416 }
b728d87e
MD		 417}
418
a8909ba5 419static void lttng_ust_notrace __attribute__((destructor))
46c881a7 420__tracepoints__ptrs_destroy(void);
a8909ba5 421static void
46c881a7 422__tracepoints__ptrs_destroy(void)
b728d87e 423{
deb6e540 424 int ret;
51920067 425
46c881a7 426 if (--__tracepoint_ptrs_registered)
b728d87e 427 return;
1e4e01a7
MD		 428 if (!tracepoint_dlopen_ptr)
429 tracepoint_dlopen_ptr = &tracepoint_dlopen;
430 if (tracepoint_dlopen_ptr->tracepoint_unregister_lib)
431 tracepoint_dlopen_ptr->tracepoint_unregister_lib(__start___tracepoints_ptrs);
432 if (tracepoint_dlopen_ptr->liblttngust_handle && !__tracepoint_registered) {
433 ret = dlclose(tracepoint_dlopen_ptr->liblttngust_handle);
76aca78d
MD		 434 if (ret) {
435 fprintf(stderr, "Error (%d) in dlclose\n", ret);
436 abort();
437 }
1e4e01a7 438 memset(tracepoint_dlopen_ptr, 0, sizeof(*tracepoint_dlopen_ptr));
deb6e540 439 }
b728d87e
MD		 440}
441
46c881a7
MD		 442#else /* TRACEPOINT_DEFINE */
443
444#define _DEFINE_TRACEPOINT(_provider, _name, _args)
445
446#endif /* #else TRACEPOINT_DEFINE */
deb6e540 447
b728d87e
MD		 448#ifdef __cplusplus
449}
450#endif
451
452#endif /* _LTTNG_TRACEPOINT_H */
453
454/* The following declarations must be outside re-inclusion protection. */
455
456#ifndef TRACEPOINT_EVENT
457
458/*
459 * How to use the TRACEPOINT_EVENT macro:
460 *
461 * An example:
462 *
463 * TRACEPOINT_EVENT(someproject_component, event_name,
464 *
465 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
466 *
467 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
468 * long *, arg4, size_t, arg4_len),
469 *
470 * * TP_FIELDS describes the event payload layout in the trace *
471 *
472 * TP_FIELDS(
473 * * Integer, printed in base 10 *
474 * ctf_integer(int, field_a, arg0)
475 *
476 * * Integer, printed with 0x base 16 *
477 * ctf_integer_hex(unsigned long, field_d, arg1)
478 *
479 * * Array Sequence, printed as UTF8-encoded array of bytes *
480 * ctf_array_text(char, field_b, string, FIXED_LEN)
481 * ctf_sequence_text(char, field_c, string, size_t, strlen)
482 *
483 * * String, printed as UTF8-encoded string *
484 * ctf_string(field_e, string)
485 *
486 * * Array sequence of signed integer values *
487 * ctf_array(long, field_f, arg4, FIXED_LEN4)
488 * ctf_sequence(long, field_g, arg4, size_t, arg4_len)
489 * )
490 * )
491 *
492 * More detailed explanation:
493 *
494 * The name of the tracepoint is expressed as a tuple with the provider
495 * and name arguments.
496 *
497 * The provider and name should be a proper C99 identifier.
498 * The "provider" and "name" MUST follow these rules to ensure no
499 * namespace clash occurs:
500 *
501 * For projects (applications and libraries) for which an entity
502 * specific to the project controls the source code and thus its
503 * tracepoints (typically with a scope larger than a single company):
504 *
505 * either:
506 * project_component, event
507 * or:
508 * project, event
509 *
510 * Where "project" is the name of the project,
511 * "component" is the name of the project component (which may
512 * include several levels of sub-components, e.g.
513 * ...component_subcomponent_...) where the tracepoint is located
514 * (optional),
515 * "event" is the name of the tracepoint event.
516 *
517 * For projects issued from a single company wishing to advertise that
518 * the company controls the source code and thus the tracepoints, the
519 * "com_" prefix should be used:
520 *
521 * either:
522 * com_company_project_component, event
523 * or:
524 * com_company_project, event
525 *
526 * Where "company" is the name of the company,
527 * "project" is the name of the project,
528 * "component" is the name of the project component (which may
529 * include several levels of sub-components, e.g.
530 * ...component_subcomponent_...) where the tracepoint is located
531 * (optional),
532 * "event" is the name of the tracepoint event.
533 *
534 * the provider:event identifier is limited to 127 characters.
535 */
536
b728d87e 537#define TRACEPOINT_EVENT(provider, name, args, fields) \
deb6e540 538 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
b4f3bc52 539 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
b728d87e
MD		 540
541#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
542
543#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
deb6e540 544 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
b4f3bc52 545 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
b728d87e
MD		 546
547#endif /* #ifndef TRACEPOINT_EVENT */
548
549#ifndef TRACEPOINT_LOGLEVEL
550
551/*
75c5ad79 552 * Tracepoint Loglevels
b728d87e
MD		 553 *
554 * Typical use of these loglevels:
555 *
d8de1354 556 * The loglevels go from 0 to 14. Higher numbers imply the most
75c5ad79
MD		 557 * verbosity (higher event throughput expected.
558 *
d8de1354
MD		 559 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
560 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
561 * debug information.
75c5ad79 562 *
d8de1354 563 * TRACE_EMERG 0
75c5ad79
MD		 564 * system is unusable
565 *
d8de1354 566 * TRACE_ALERT 1
75c5ad79
MD		 567 * action must be taken immediately
568 *
d8de1354 569 * TRACE_CRIT 2
75c5ad79
MD		 570 * critical conditions
571 *
d8de1354 572 * TRACE_ERR 3
75c5ad79
MD		 573 * error conditions
574 *
d8de1354 575 * TRACE_WARNING 4
75c5ad79
MD		 576 * warning conditions
577 *
d8de1354 578 * TRACE_NOTICE 5
75c5ad79
MD		 579 * normal, but significant, condition
580 *
d8de1354 581 * TRACE_INFO 6
75c5ad79
MD		 582 * informational message
583 *
d8de1354
MD		 584 * TRACE_DEBUG_SYSTEM 7
585 * debug information with system-level scope (set of programs)
75c5ad79 586 *
d8de1354
MD		 587 * TRACE_DEBUG_PROGRAM 8
588 * debug information with program-level scope (set of processes)
75c5ad79 589 *
d8de1354
MD		 590 * TRACE_DEBUG_PROCESS 9
591 * debug information with process-level scope (set of modules)
75c5ad79 592 *
d8de1354
MD		 593 * TRACE_DEBUG_MODULE 10
594 * debug information with module (executable/library) scope (set of units)
75c5ad79 595 *
d8de1354
MD		 596 * TRACE_DEBUG_UNIT 11
597 * debug information with compilation unit scope (set of functions)
75c5ad79 598 *
d8de1354
MD		 599 * TRACE_DEBUG_FUNCTION 12
600 * debug information with function-level scope
75c5ad79 601 *
d8de1354
MD		 602 * TRACE_DEBUG_LINE 13
603 * debug information with line-level scope (TRACEPOINT_EVENT default)
902e1379 604 *
d8de1354 605 * TRACE_DEBUG 14
1e3b0059 606 * debug-level message
75c5ad79
MD		 607 *
608 * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
609 * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
853cda88
MD		 610 * tracepoint name. The first field is the provider name, the second
611 * field is the name of the tracepoint, the third field is the loglevel
612 * name.
b728d87e
MD		 613 *
614 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
615 * < loglevel_name >)
616 *
75c5ad79
MD		 617 * The TRACEPOINT_PROVIDER must be already declared before declaring a
618 * TRACEPOINT_LOGLEVEL.
b728d87e
MD		 619 */
620
882a56d7 621enum {
d8de1354
MD		 622 TRACE_EMERG = 0,
623 TRACE_ALERT = 1,
624 TRACE_CRIT = 2,
625 TRACE_ERR = 3,
626 TRACE_WARNING = 4,
627 TRACE_NOTICE = 5,
628 TRACE_INFO = 6,
629 TRACE_DEBUG_SYSTEM = 7,
630 TRACE_DEBUG_PROGRAM = 8,
631 TRACE_DEBUG_PROCESS = 9,
632 TRACE_DEBUG_MODULE = 10,
633 TRACE_DEBUG_UNIT = 11,
634 TRACE_DEBUG_FUNCTION = 12,
635 TRACE_DEBUG_LINE = 13,
636 TRACE_DEBUG = 14,
882a56d7
MD		 637};
638
05ceaafd 639#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
b728d87e
MD		 640
641#endif /* #ifndef TRACEPOINT_LOGLEVEL */
6ddc916d
MD		 642
643#ifndef TRACEPOINT_MODEL_EMF_URI
644
645#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
646
647#endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */
LTTng 2.0 Userspace Tracer
This page took 0.057529 seconds and 4 git commands to generate.