projects / lttng-ust.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Introduce LTTNG_UST_MAP_POPULATE_POLICY environment variable
[lttng-ust.git] / include / lttng / tracepoint.h
CommitLineData
1c196845
MJ		 1// SPDX-FileCopyrightText: 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
2//
3// SPDX-License-Identifier: MIT
b728d87e 4
9b14815a
MD		 5#ifndef _LTTNG_UST_TRACEPOINT_H
6#define _LTTNG_UST_TRACEPOINT_H
c0c0989a 7
76aca78d
MD		 8#include <stdio.h>
9#include <stdlib.h>
8fce9e2b 10#include <lttng/tracepoint-types.h>
40b2b5a4 11#include <lttng/tracepoint-rcu.h>
8041f641
MD		 12#include <lttng/ust-utils.h>
13#include <sys/types.h>
14#include <unistd.h>
15
b728d87e 16#include <urcu/compiler.h>
c082d14b 17#include <urcu/system.h>
deb6e540 18#include <dlfcn.h> /* for dlopen */
51920067 19#include <string.h> /* for memset */
8041f641 20#include <stdbool.h>
3d3dc207 21
b2f60c79 22#include <lttng/ust-config.h> /* for sdt */
a8909ba5 23#include <lttng/ust-compiler.h>
3d3dc207 24#include <lttng/ust-tracer.h>
cbc06a3b 25#include <lttng/ust-api-compat.h>
b2f60c79 26
e0ca901d
MJ		 27#if (defined(__cplusplus) && (__cplusplus <= 199711L))
28#error "C++11 support is required to build tracepoints and providers as C++"
29#endif
30
81b16412
MD		 31#define LTTNG_UST_TRACEPOINT_NAME_LEN_MAX 256
32
b2f60c79 33#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
23b75ae5
MJ		 34/*
35 * Instead of using SDT_USE_VARIADIC from 'sys/sdt.h', use our own namespaced
36 * macros since the instrumented application might already have included
37 * 'sys/sdt.h' without variadic support.
38 */
b2f60c79 39#include <sys/sdt.h>
23b75ae5 40
bd75d5b9
MJ		 41#define LTTNG_UST__SDT_NARG(...) \
42 LTTNG_UST___SDT_NARG(__VA_ARGS__, 12,11,10,9,8,7,6,5,4,3,2,1,0)
23b75ae5 43
bd75d5b9 44#define LTTNG_UST___SDT_NARG(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12, N, ...) N
23b75ae5 45
bd75d5b9 46#define LTTNG_UST__SDT_PROBE_N(provider, name, N, ...) \
23b75ae5
MJ		 47 _SDT_PROBE(provider, name, N, (__VA_ARGS__))
48
b88f9167 49#define LTTNG_UST_STAP_PROBEV(provider, name, ...) \
bd75d5b9 50 LTTNG_UST__SDT_PROBE_N(provider, name, LTTNG_UST__SDT_NARG(0, ##__VA_ARGS__), ##__VA_ARGS__)
23b75ae5 51
b2f60c79 52#else
b88f9167 53#define LTTNG_UST_STAP_PROBEV(...)
b2f60c79 54#endif
b728d87e
MD		 55
56#ifdef __cplusplus
57extern "C" {
58#endif
59
cbc06a3b 60#define lttng_ust_tracepoint_enabled(provider, name) \
0274f7f2 61 caa_unlikely(CMM_LOAD_SHARED(lttng_ust_tracepoint_##provider##___##name.state))
8da6d0c8 62
cbc06a3b 63#define lttng_ust_do_tracepoint(provider, name, ...) \
0274f7f2 64 lttng_ust_tracepoint_cb_##provider##___##name(__VA_ARGS__)
8da6d0c8 65
cbc06a3b
MD		 66#define lttng_ust_tracepoint(provider, name, ...) \
67 do { \
68 LTTNG_UST_STAP_PROBEV(provider, name, ## __VA_ARGS__); \
69 if (lttng_ust_tracepoint_enabled(provider, name)) \
70 lttng_ust_do_tracepoint(provider, name, __VA_ARGS__); \
b728d87e
MD		 71 } while (0)
72
cadfcbfc 73#define LTTNG_UST_TP_ARGS(...) __VA_ARGS__
b728d87e
MD		 74
75/*
cadfcbfc 76 * LTTNG_UST_TP_ARGS takes tuples of type, argument separated by a comma.
b728d87e
MD		 77 * It can take up to 10 tuples (which means that less than 10 tuples is
78 * fine too).
79 * Each tuple is also separated by a comma.
80 */
aec5037b 81#define LTTNG_UST___TP_COMBINE_TOKENS(_tokena, _tokenb) \
df854e41 82 _tokena##_tokenb
aec5037b
MJ		 83#define LTTNG_UST__TP_COMBINE_TOKENS(_tokena, _tokenb) \
84 LTTNG_UST___TP_COMBINE_TOKENS(_tokena, _tokenb)
85#define LTTNG_UST___TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
df854e41 86 _tokena##_tokenb##_tokenc
aec5037b
MJ		 87#define LTTNG_UST__TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
88 LTTNG_UST___TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
89#define LTTNG_UST___TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
df854e41 90 _tokena##_tokenb##_tokenc##_tokend
aec5037b
MJ		 91#define LTTNG_UST__TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
92 LTTNG_UST___TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
b728d87e 93
4495dd39 94/*
20bbaf92 95 * LTTNG_UST__TP_EXVAR* extract the var names.
26772f59 96 * LTTNG_UST__TP_EXVAR1 and LTTNG_UST__TP_EXDATA_VAR1 are needed for -std=c99.
4495dd39 97 */
20bbaf92
MJ		 98#define LTTNG_UST__TP_EXVAR0()
99#define LTTNG_UST__TP_EXVAR1(a)
100#define LTTNG_UST__TP_EXVAR2(a,b) b
101#define LTTNG_UST__TP_EXVAR4(a,b,c,d) b,d
102#define LTTNG_UST__TP_EXVAR6(a,b,c,d,e,f) b,d,f
103#define LTTNG_UST__TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
104#define LTTNG_UST__TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
105#define LTTNG_UST__TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
106#define LTTNG_UST__TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
107#define LTTNG_UST__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
108#define LTTNG_UST__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
109#define LTTNG_UST__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
b728d87e 110
26772f59
MJ		 111#define LTTNG_UST__TP_EXDATA_VAR0() __tp_data
112#define LTTNG_UST__TP_EXDATA_VAR1(a) __tp_data
113#define LTTNG_UST__TP_EXDATA_VAR2(a,b) __tp_data,b
114#define LTTNG_UST__TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
115#define LTTNG_UST__TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
116#define LTTNG_UST__TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
117#define LTTNG_UST__TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
118#define LTTNG_UST__TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
119#define LTTNG_UST__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
120#define LTTNG_UST__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
121#define LTTNG_UST__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
122#define LTTNG_UST__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
b728d87e 123
4495dd39 124/*
0efe0fcd
MJ		 125 * LTTNG_UST__TP_EXPROTO* extract tuples of type, var.
126 * LTTNG_UST__TP_EXPROTO1 and LTTNG_UST__TP_EXDATA_PROTO1 are needed for -std=c99.
4495dd39 127 */
0efe0fcd
MJ		 128#define LTTNG_UST__TP_EXPROTO0() void
129#define LTTNG_UST__TP_EXPROTO1(a) void
130#define LTTNG_UST__TP_EXPROTO2(a,b) a b
131#define LTTNG_UST__TP_EXPROTO4(a,b,c,d) a b,c d
132#define LTTNG_UST__TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
133#define LTTNG_UST__TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
134#define LTTNG_UST__TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
135#define LTTNG_UST__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
136#define LTTNG_UST__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
137#define LTTNG_UST__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
138#define LTTNG_UST__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
139#define LTTNG_UST__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
b728d87e 140
26772f59
MJ		 141#define LTTNG_UST__TP_EXDATA_PROTO0() void *__tp_data
142#define LTTNG_UST__TP_EXDATA_PROTO1(a) void *__tp_data
143#define LTTNG_UST__TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
144#define LTTNG_UST__TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
145#define LTTNG_UST__TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
146#define LTTNG_UST__TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
147#define LTTNG_UST__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
148#define LTTNG_UST__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
149#define LTTNG_UST__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
150#define LTTNG_UST__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
151#define LTTNG_UST__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
152#define LTTNG_UST__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
b728d87e
MD		 153
154/* Preprocessor trick to count arguments. Inspired from sdt.h. */
6eddcb06
MJ		 155#define LTTNG_UST__TP_NARGS(...) LTTNG_UST___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)
156#define LTTNG_UST___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
157#define LTTNG_UST__TP_PROTO_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXPROTO, N)(__VA_ARGS__))
158#define LTTNG_UST__TP_VAR_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXVAR, N)(__VA_ARGS__))
159#define LTTNG_UST__TP_DATA_PROTO_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXDATA_PROTO, N)(__VA_ARGS__))
160#define LTTNG_UST__TP_DATA_VAR_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXDATA_VAR, N)(__VA_ARGS__))
161#define LTTNG_UST__TP_ARGS_PROTO(...) LTTNG_UST__TP_PROTO_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
162#define LTTNG_UST__TP_ARGS_VAR(...) LTTNG_UST__TP_VAR_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
163#define LTTNG_UST__TP_ARGS_DATA_PROTO(...) LTTNG_UST__TP_DATA_PROTO_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
164#define LTTNG_UST__TP_ARGS_DATA_VAR(...) LTTNG_UST__TP_DATA_VAR_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
165#define LTTNG_UST__TP_PARAMS(...) __VA_ARGS__
b728d87e 166
81b16412
MD		 167/*
168 * sizeof(#_provider) - 1 : length of the provider string (excluding \0).
169 * sizeof(#_name) - 1 : length of the name string (excluding \0).
170 * + 1 : separator between provider and event name.
171 *
172 * Upper bound (inclusive) is LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1 to
173 * account for \0.
174 *
175 * The comparison is:
176 * left hand side: sizeof(#_provider) - 1 + sizeof(#_name) - 1 + 1
177 * right hand side: LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1
178 * operator: <= (inclusive)
179 * Simplified in the code below.
180 */
181#define lttng_ust_tracepoint_validate_name_len(_provider, _name) \
182 lttng_ust_static_assert(sizeof(#_provider) + sizeof(#_name) <= LTTNG_UST_TRACEPOINT_NAME_LEN_MAX, \
183 "Tracepoint name length is too long", \
184 Tracepoint_name_length_is_too_long)
185
96f85541
MD		 186/*
187 * The tracepoint cb is marked always inline so we can distinguish
188 * between caller's ip addresses within the probe using the return
189 * address.
190 */
7f2f82c3 191#define LTTNG_UST__DECLARE_TRACEPOINT(_provider, _name, ...) \
29d6f421
MD		 192extern struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name \
193 LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY; \
8da9deee 194static inline \
6eddcb06 195void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__)) \
8da9deee 196 __attribute__((always_inline, unused)) lttng_ust_notrace; \
96f85541 197static \
6eddcb06 198void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__)) \
b728d87e 199{ \
10544ee8 200 struct lttng_ust_tracepoint_probe *__tp_probe; \
b728d87e 201 \
251c9f75 202 if (caa_unlikely(!LTTNG_UST_TP_RCU_LINK_TEST())) \
deb6e540 203 return; \
251c9f75
MJ		 204 lttng_ust_tp_rcu_read_lock(); \
205 __tp_probe = lttng_ust_tp_rcu_dereference(lttng_ust_tracepoint_##_provider##___##_name.probes); \
23c8854a 206 if (caa_unlikely(!__tp_probe)) \
b728d87e
MD		 207 goto end; \
208 do { \
1a206094 209 void (*__tp_cb)(void) = __tp_probe->func; \
23c8854a 210 void *__tp_data = __tp_probe->data; \
b728d87e 211 \
6eddcb06
MJ		 212 URCU_FORCE_CAST(void (*)(LTTNG_UST__TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
213 (LTTNG_UST__TP_ARGS_DATA_VAR(__VA_ARGS__)); \
23c8854a 214 } while ((++__tp_probe)->func); \
b728d87e 215end: \
251c9f75 216 lttng_ust_tp_rcu_read_unlock(); \
b728d87e 217} \
106ff4da 218static inline \
0274f7f2 219void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \
106ff4da
MJ		 220 void (*func)(void), void *data) \
221 lttng_ust_notrace; \
a8909ba5 222static inline \
0274f7f2 223void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \
a8909ba5 224 void (*func)(void), void *data) \
b728d87e 225{ \
9b34a2b2 226 lttng_ust_tracepoint_provider_register(provider_name, event_name, func, data, \
0274f7f2 227 lttng_ust_tracepoint_##_provider##___##_name.signature); \
b728d87e 228} \
106ff4da 229static inline \
0274f7f2 230void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \
106ff4da
MJ		 231 void (*func)(void), void *data) \
232 lttng_ust_notrace; \
a8909ba5 233static inline \
0274f7f2 234void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \
a8909ba5 235 void (*func)(void), void *data) \
b728d87e 236{ \
9b34a2b2 237 lttng_ust_tracepoint_provider_unregister(provider_name, event_name, func, data); \
b728d87e
MD		 238}
239
8812e921
MD		 240/*
241 * Registration of tracepoint provider probe functions with
242 * lttng_ust_tracepoint_provider_register, unregistration with
243 * lttng_ust_tracepoint_provider_unregister.
244 */
245int lttng_ust_tracepoint_provider_register(const char *provider_name, const char *event_name,
34f7f142 246 void (*func)(void), void *data, const char *signature);
8812e921 247int lttng_ust_tracepoint_provider_unregister(const char *provider_name, const char *event_name,
34f7f142 248 void (*func)(void), void *data);
deb6e540 249
8812e921
MD		 250/*
251 * Registration of tracepoint instrumentation modules with lttng_ust_tracepoint_module_register,
252 * unregistration with lttng_ust_tracepoint_module_unregister.
253 */
254int lttng_ust_tracepoint_module_register(struct lttng_ust_tracepoint * const *tracepoints_start,
255 int tracepoints_count);
256int lttng_ust_tracepoint_module_unregister(struct lttng_ust_tracepoint * const *tracepoints_start);
257
51920067
MD		 258/*
259 * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
260 * shared across objects in a module/main executable.
f641d544
MD		 261 *
262 * IMPORTANT: this structure is part of the ABI between instrumented
263 * applications and UST. Fields need to be only added at the end, never
264 * reordered, never removed.
265 *
266 * The field @struct_size should be used to determine the size of the
267 * structure. It should be queried before using additional fields added
268 * at the end of the structure.
51920067 269 */
1a206094 270struct lttng_ust_tracepoint_dlopen {
f641d544
MD		 271 uint32_t struct_size;
272
51920067
MD		 273 void *liblttngust_handle;
274
14227bde 275 int (*lttng_ust_tracepoint_module_register)(struct lttng_ust_tracepoint * const *tracepoints_start,
51920067 276 int tracepoints_count);
14227bde 277 int (*lttng_ust_tracepoint_module_unregister)(struct lttng_ust_tracepoint * const *tracepoints_start);
10544ee8
MD		 278 void (*rcu_read_lock_sym)(void);
279 void (*rcu_read_unlock_sym)(void);
280 void *(*rcu_dereference_sym)(void *p);
f641d544
MD		 281
282 /* End of base ABI. Fields below should be used after checking struct_size. */
51920067
MD		 283};
284
7863d51a
MJ		 285extern struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen;
286extern struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr;
51920067 287
46c881a7
MD		 288/*
289 * These weak symbols, the constructor, and destructor take care of
290 * registering only _one_ instance of the tracepoints per shared-ojbect
291 * (or for the whole main program).
292 */
0274f7f2 293int lttng_ust_tracepoint_registered
46c881a7 294 __attribute__((weak, visibility("hidden")));
0274f7f2 295int lttng_ust_tracepoint_ptrs_registered
46c881a7 296 __attribute__((weak, visibility("hidden")));
7863d51a 297struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen
f641d544
MD		 298 __attribute__((weak, visibility("hidden"))) = {
299 .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen),
300};
9443a022
MD		 301/*
302 * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
303 * 4.8 and prior does not have the same behavior for symbol scoping on
304 * 32-bit powerpc depending on the object size: symbols for objects of 8
305 * bytes or less have the same address throughout a module, whereas they
306 * have different addresses between compile units for objects larger
307 * than 8 bytes. Add this pointer indirection to ensure that the symbol
308 * scoping match that of the other weak hidden symbols found in this
309 * header.
310 */
7863d51a 311struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr
9443a022 312 __attribute__((weak, visibility("hidden")));
46c881a7 313
0fd0de10
FD		 314/*
315 * Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared
316 * across objects in a module/main executable. The callbacks are used to
317 * control and check if the destructors should be executed.
f641d544
MD		 318 *
319 * IMPORTANT: this structure is part of the ABI between instrumented
320 * applications and UST. Fields need to be only added at the end, never
321 * reordered, never removed.
322 *
323 * The field @struct_size should be used to determine the size of the
324 * structure. It should be queried before using additional fields added
325 * at the end of the structure.
0fd0de10
FD		 326 */
327struct lttng_ust_tracepoint_destructors_syms {
f641d544
MD		 328 uint32_t struct_size;
329
0fd0de10
FD		 330 void (*tracepoint_disable_destructors)(void);
331 int (*tracepoint_get_destructors_state)(void);
f641d544
MD		 332
333 /* End of base ABI. Fields below should be used after checking struct_size. */
0fd0de10
FD		 334};
335
62eb90f3
MJ		 336extern struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms;
337extern struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr;
0fd0de10 338
62eb90f3 339struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms
f641d544
MD		 340 __attribute__((weak, visibility("hidden"))) = {
341 .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms),
342};
62eb90f3 343struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr
0fd0de10
FD		 344 __attribute__((weak, visibility("hidden")));
345
346static inline void tracepoint_disable_destructors(void)
347{
7863d51a
MJ		 348 if (!lttng_ust_tracepoint_dlopen_ptr)
349 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
62eb90f3
MJ		 350 if (!lttng_ust_tracepoint_destructors_syms_ptr)
351 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
7863d51a 352 if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle
62eb90f3
MJ		 353 && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors)
354 lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors();
0fd0de10
FD		 355}
356
99234da6 357#ifndef _LGPL_SOURCE
106ff4da 358static inline void
0274f7f2 359lttng_ust_tracepoint__init_urcu_sym(void)
106ff4da 360 lttng_ust_notrace;
99234da6 361static inline void
0274f7f2 362lttng_ust_tracepoint__init_urcu_sym(void)
99234da6 363{
7863d51a
MJ		 364 if (!lttng_ust_tracepoint_dlopen_ptr)
365 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
99234da6
MD		 366 /*
367 * Symbols below are needed by tracepoint call sites and probe
368 * providers.
369 */
7863d51a
MJ		 370 if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym)
371 lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym =
99234da6 372 URCU_FORCE_CAST(void (*)(void),
7863d51a 373 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
251c9f75 374 "lttng_ust_tp_rcu_read_lock"));
7863d51a
MJ		 375 if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym)
376 lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym =
99234da6 377 URCU_FORCE_CAST(void (*)(void),
7863d51a 378 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
251c9f75 379 "lttng_ust_tp_rcu_read_unlock"));
7863d51a
MJ		 380 if (!lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym)
381 lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym =
99234da6 382 URCU_FORCE_CAST(void *(*)(void *p),
7863d51a 383 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
251c9f75 384 "lttng_ust_tp_rcu_dereference_sym"));
99234da6
MD		 385}
386#else
106ff4da 387static inline void
0274f7f2 388lttng_ust_tracepoint__init_urcu_sym(void)
106ff4da 389 lttng_ust_notrace;
99234da6 390static inline void
0274f7f2 391lttng_ust_tracepoint__init_urcu_sym(void)
99234da6
MD		 392{
393}
394#endif
395
8041f641
MD		 396/*
397 * Use getenv() directly and bypass lttng-ust helper functions
398 * because we may not have access to lttng-ust shared libraries.
399 */
400#ifdef LTTNG_UST_DEBUG
401static inline
402bool lttng_ust_tracepoint_logging_debug_enabled(void)
403{
404 return true;
405}
406#else /* #ifdef LTTNG_UST_DEBUG */
407static inline
408bool lttng_ust_tracepoint_logging_debug_enabled(void)
409{
410 return getenv("LTTNG_UST_DEBUG");
411}
412#endif /* #ifdef LTTNG_UST_DEBUG */
413
a24e542a
MD		 414#ifdef LTTNG_UST_ABORT_ON_CRITICAL
415static inline
416bool lttng_ust_tracepoint_logging_abort_on_critical_enabled(void)
417{
418 return true;
419}
420#else /* #ifdef LTTNG_UST_ABORT_ON_CRITICAL */
421static inline
422bool lttng_ust_tracepoint_logging_abort_on_critical_enabled(void)
423{
424 return getenv("LTTNG_UST_ABORT_ON_CRITICAL");
425}
426#endif
427
8041f641
MD		 428#define LTTNG_UST_TRACEPOINT_THIS_IP \
429 ({ __label__ here; here: &&here; })
430
431static void
432lttng_ust_tracepoints_print_disabled_message(void)
433{
a24e542a
MD		 434 if (lttng_ust_tracepoint_logging_debug_enabled())
435 fprintf(stderr, "lttng-ust-tracepoint [%ld]: Critical: dlopen() failed to find '%s', tracepoints in this binary won't be registered. "
436 "(at addr=%p in %s() at " __FILE__ ":" lttng_ust_stringify(__LINE__) ")\n",
437 (long) getpid(),
438 LTTNG_UST_TRACEPOINT_LIB_SONAME,
439 LTTNG_UST_TRACEPOINT_THIS_IP,
440 __func__);
441 if (lttng_ust_tracepoint_logging_abort_on_critical_enabled())
442 abort();
8041f641
MD		 443}
444
465a0d04 445static void
ac9f44c2 446lttng_ust__tracepoints__init(void)
63661b66 447 lttng_ust_notrace __attribute__((constructor(LTTNG_UST_CONSTRUCTOR_PRIO)));
46c881a7 448static void
ac9f44c2 449lttng_ust__tracepoints__init(void)
46c881a7 450{
0274f7f2 451 if (lttng_ust_tracepoint_registered++) {
7863d51a 452 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
8f0d1c78 453 return;
0274f7f2 454 lttng_ust_tracepoint__init_urcu_sym();
46c881a7 455 return;
8f0d1c78 456 }
46c881a7 457
7863d51a
MJ		 458 if (!lttng_ust_tracepoint_dlopen_ptr)
459 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
460 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
461 lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle =
3d3dc207 462 dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
8041f641
MD		 463 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) {
464 lttng_ust_tracepoints_print_disabled_message();
46c881a7 465 return;
8041f641 466 }
0274f7f2 467 lttng_ust_tracepoint__init_urcu_sym();
46c881a7
MD		 468}
469
c589eca2 470static void
ac9f44c2 471lttng_ust__tracepoints__destroy(void)
63661b66 472 lttng_ust_notrace __attribute__((destructor(LTTNG_UST_CONSTRUCTOR_PRIO)));
46c881a7 473static void
ac9f44c2 474lttng_ust__tracepoints__destroy(void)
46c881a7
MD		 475{
476 int ret;
477
0274f7f2 478 if (--lttng_ust_tracepoint_registered)
46c881a7 479 return;
7863d51a
MJ		 480 if (!lttng_ust_tracepoint_dlopen_ptr)
481 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
62eb90f3
MJ		 482 if (!lttng_ust_tracepoint_destructors_syms_ptr)
483 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
7863d51a 484 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
0fd0de10 485 return;
0274f7f2 486 if (lttng_ust_tracepoint_ptrs_registered)
0fd0de10
FD		 487 return;
488 /*
489 * Lookup if destructors must be executed using the new method.
490 */
62eb90f3
MJ		 491 if (lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
492 && !lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()) {
0fd0de10
FD		 493 /*
494 * The tracepoint_get_destructors_state symbol was found with
495 * dlsym but its returned value is 0 meaning that destructors
496 * must not be executed.
497 */
498 return;
499 }
7863d51a 500 ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle);
0fd0de10
FD		 501 if (ret) {
502 fprintf(stderr, "Error (%d) in dlclose\n", ret);
503 abort();
504 }
7863d51a 505 memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr));
46c881a7
MD		 506}
507
88c7c4ea
MJ		 508#if LTTNG_UST_COMPAT_API(0)
509# if defined(TRACEPOINT_DEFINE) && !defined(LTTNG_UST_TRACEPOINT_DEFINE)
510# define LTTNG_UST_TRACEPOINT_DEFINE
511# endif
512#endif /* #if LTTNG_UST_COMPAT_API(0) */
513
faa63343
MD		 514#if LTTNG_UST_COMPAT_API(0)
515#define tracepoint lttng_ust_tracepoint
516#define do_tracepoint lttng_ust_do_tracepoint
517#define tracepoint_enabled lttng_ust_tracepoint_enabled
518#define TP_ARGS LTTNG_UST_TP_ARGS
519#endif /* #if LTTNG_UST_COMPAT_API(0) */
520
521#ifdef __cplusplus
522}
523#endif
524
525#endif /* _LTTNG_UST_TRACEPOINT_H */
526
527/* The following declarations must be outside re-inclusion protection. */
528
88c7c4ea 529#ifdef LTTNG_UST_TRACEPOINT_DEFINE
deb6e540 530
faa63343
MD		 531#ifndef _LTTNG_UST_TRACEPOINT_DEFINE_ONCE
532#define _LTTNG_UST_TRACEPOINT_DEFINE_ONCE
533
534#ifdef __cplusplus
535extern "C" {
536#endif
537
558b9d86
MD		 538/*
539 * These weak symbols, the constructor, and destructor take care of
540 * registering only _one_ instance of the tracepoints per shared-ojbect
541 * (or for the whole main program).
542 */
ac9f44c2 543extern struct lttng_ust_tracepoint * const __start_lttng_ust_tracepoints_ptrs[]
558b9d86 544 __attribute__((weak, visibility("hidden")));
ac9f44c2 545extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[]
558b9d86
MD		 546 __attribute__((weak, visibility("hidden")));
547
628e1d81 548/*
341a19e8 549 * When LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
628e1d81 550 * unresolved symbol that requires the provider to be linked in. When
341a19e8 551 * LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
628e1d81
MD		 552 * unresolved symbol that depends on having the provider linked in,
553 * otherwise the linker complains. This deals with use of static
554 * libraries, ensuring that the linker does not remove the provider
555 * object from the executable.
556 */
341a19e8
MJ		 557
558#if LTTNG_UST_COMPAT_API(0)
559# if defined(TRACEPOINT_PROBE_DYNAMIC_LINKAGE) && !defined(LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE)
560# define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
561# endif
562#endif /* #if LTTNG_UST_COMPAT_API(0) */
563
564#ifdef LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
565#define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider) NULL
566#else /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
567#define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider) &lttng_ust_tracepoint_provider_##provider
568#endif /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
628e1d81 569
b728d87e
MD		 570/*
571 * Note: to allow PIC code, we need to allow the linker to update the pointers
ac9f44c2 572 * in the lttng_ust_tracepoints_ptrs section.
b728d87e
MD		 573 * Therefore, this section is _not_ const (read-only).
574 */
341a19e8 575#define LTTNG_UST__TP_EXTRACT_STRING(...) #__VA_ARGS__
b4f3bc52 576
faa63343 577#undef LTTNG_UST__DEFINE_TRACEPOINT
7f2f82c3 578#define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args) \
81b16412 579 lttng_ust_tracepoint_validate_name_len(_provider, _name); \
29d6f421
MD		 580 extern int lttng_ust_tracepoint_provider_##_provider \
581 LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY; \
92866a9d 582 static const char lttng_ust_tp_provider_strtab_##_provider##___##_name[] \
ac9f44c2 583 __attribute__((section("lttng_ust_tracepoints_strings"))) = \
34f7f142 584 #_provider; \
92866a9d 585 static const char lttng_ust_tp_name_strtab_##_provider##___##_name[] \
ac9f44c2 586 __attribute__((section("lttng_ust_tracepoints_strings"))) = \
34f7f142 587 #_name; \
0274f7f2 588 struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name \
29d6f421
MD		 589 __attribute__((section("lttng_ust_tracepoints"))) \
590 LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY = { \
f641d544 591 sizeof(struct lttng_ust_tracepoint), \
92866a9d
MJ		 592 lttng_ust_tp_provider_strtab_##_provider##___##_name, \
593 lttng_ust_tp_name_strtab_##_provider##___##_name, \
b4f3bc52
MD		 594 0, \
595 NULL, \
341a19e8
MJ		 596 LTTNG_UST__TRACEPOINT_UNDEFINED_REF(_provider), \
597 LTTNG_UST__TP_EXTRACT_STRING(_args), \
b4f3bc52 598 }; \
1a206094 599 static struct lttng_ust_tracepoint * \
0274f7f2 600 lttng_ust_tracepoint_ptr_##_provider##___##_name \
ac9f44c2 601 __attribute__((section("lttng_ust_tracepoints_ptrs"), used)) \
4f74bc5e 602 __lttng_ust_variable_attribute_no_sanitize_address = \
0274f7f2 603 &lttng_ust_tracepoint_##_provider##___##_name;
b728d87e 604
465a0d04 605static void
ac9f44c2 606lttng_ust__tracepoints__ptrs_init(void)
63661b66 607 lttng_ust_notrace __attribute__((constructor(LTTNG_UST_CONSTRUCTOR_PRIO)));
a8909ba5 608static void
ac9f44c2 609lttng_ust__tracepoints__ptrs_init(void)
b728d87e 610{
0274f7f2 611 if (lttng_ust_tracepoint_ptrs_registered++)
b728d87e 612 return;
7863d51a
MJ		 613 if (!lttng_ust_tracepoint_dlopen_ptr)
614 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
615 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
616 lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle =
3d3dc207 617 dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
8041f641
MD		 618 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) {
619 lttng_ust_tracepoints_print_disabled_message();
deb6e540 620 return;
8041f641 621 }
62eb90f3
MJ		 622 if (!lttng_ust_tracepoint_destructors_syms_ptr)
623 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
14227bde 624 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_register =
1a206094 625 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int),
7863d51a 626 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
14227bde
MJ		 627 "lttng_ust_tracepoint_module_register"));
628 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_unregister =
1a206094 629 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *),
7863d51a 630 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
14227bde 631 "lttng_ust_tracepoint_module_unregister"));
62eb90f3 632 lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors =
0fd0de10 633 URCU_FORCE_CAST(void (*)(void),
7863d51a 634 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
096c06e5 635 "lttng_ust_tp_disable_destructors"));
62eb90f3 636 lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state =
0fd0de10 637 URCU_FORCE_CAST(int (*)(void),
7863d51a 638 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
096c06e5 639 "lttng_ust_tp_get_destructors_state"));
0274f7f2 640 lttng_ust_tracepoint__init_urcu_sym();
14227bde
MJ		 641 if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_register) {
642 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_register(__start_lttng_ust_tracepoints_ptrs,
ac9f44c2
MJ		 643 __stop_lttng_ust_tracepoints_ptrs -
644 __start_lttng_ust_tracepoints_ptrs);
99234da6 645 }
b728d87e
MD		 646}
647
c589eca2 648static void
ac9f44c2 649lttng_ust__tracepoints__ptrs_destroy(void)
63661b66 650 lttng_ust_notrace __attribute__((destructor(LTTNG_UST_CONSTRUCTOR_PRIO)));
a8909ba5 651static void
ac9f44c2 652lttng_ust__tracepoints__ptrs_destroy(void)
b728d87e 653{
deb6e540 654 int ret;
51920067 655
0274f7f2 656 if (--lttng_ust_tracepoint_ptrs_registered)
b728d87e 657 return;
7863d51a
MJ		 658 if (!lttng_ust_tracepoint_dlopen_ptr)
659 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
62eb90f3
MJ		 660 if (!lttng_ust_tracepoint_destructors_syms_ptr)
661 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
14227bde
MJ		 662 if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_unregister)
663 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_unregister(__start_lttng_ust_tracepoints_ptrs);
7863d51a 664 if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle
62eb90f3
MJ		 665 && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
666 && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()
0274f7f2 667 && !lttng_ust_tracepoint_ptrs_registered) {
7863d51a 668 ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle);
76aca78d
MD		 669 if (ret) {
670 fprintf(stderr, "Error (%d) in dlclose\n", ret);
671 abort();
672 }
7863d51a 673 memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr));
deb6e540 674 }
b728d87e
MD		 675}
676
677#ifdef __cplusplus
678}
679#endif
680
faa63343 681#endif /* _LTTNG_UST_TRACEPOINT_DEFINE_ONCE */
b728d87e 682
faa63343
MD		 683#else /* LTTNG_UST_TRACEPOINT_DEFINE */
684
685#undef LTTNG_UST__DEFINE_TRACEPOINT
686#define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args)
687
688#endif /* #else LTTNG_UST_TRACEPOINT_DEFINE */
b728d87e 689
29d6f421
MD		 690/*
691 * LTTNG_UST_TRACEPOINT_HIDDEN_DEFINITION: Define this before including
692 * a tracepoint instrumentation header to hide symbols associated with
693 * tracepoint module instrumentation. This is useful if all compile
694 * units using the lttng_ust_tracepoint(),
695 * lttng_ust_tracepoint_enabled() and lttng_ust_do_tracepoint() macros
696 * is within the same module as the compile unit including the
697 * tracepoint header after defining LTTNG_UST_TRACEPOINT_DEFINE.
698 */
699
700#undef LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY
701#ifdef LTTNG_UST_TRACEPOINT_HIDDEN_DEFINITION
702#define LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY __attribute__((visibility("hidden")))
703#else
704#define LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY __attribute__((visibility("default")))
705#endif
706
707/*
708 * LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION: Define this before
709 * including a tracepoint instrumentation header to hide symbols
710 * associated with the tracepoint provider. This is useful if the
711 * tracepoint definition (including the header after defining
712 * LTTNG_UST_TRACEPOINT_DEFINE) is in the same module as the provider
713 * (including the header after defining
714 * LTTNG_UST_TRACEPOINT_CREATE_PROBES).
715 */
716#undef LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY
717#ifdef LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION
718#define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY __attribute__((visibility("hidden")))
719#else
720#define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY __attribute__((visibility("default")))
721#endif
722
2ebf164b 723#ifndef LTTNG_UST_TRACEPOINT_ENUM
c785c634
MD		 724
725/*
726 * Tracepoint Enumerations
727 *
728 * The enumeration is a mapping between an integer, or range of integers, and
729 * a string. It can be used to have a more compact trace in cases where the
730 * possible values for a field are limited:
731 *
732 * An example:
733 *
2ebf164b 734 * LTTNG_UST_TRACEPOINT_ENUM(someproject_component, enumname,
4849bc7a 735 * LTTNG_UST_TP_ENUM_VALUES(
78684808
MJ		 736 * lttng_ust_field_enum_value("even", 0)
737 * lttng_ust_field_enum_value("uneven", 1)
738 * lttng_ust_field_enum_range("twoto4", 2, 4)
739 * lttng_ust_field_enum_value("five", 5)
c785c634
MD		 740 * )
741 * )
742 *
743 * Where "someproject_component" is the name of the component this enumeration
744 * belongs to and "enumname" identifies this enumeration. Inside the
4849bc7a 745 * LTTNG_UST_TP_ENUM_VALUES macro is the actual mapping. Each string value can map
78684808
MJ		 746 * to either a single value with lttng_ust_field_enum_value or a range of values
747 * with lttng_ust_field_enum_range.
c785c634
MD		 748 *
749 * Enumeration ranges may overlap, but the behavior is implementation-defined,
750 * each trace reader will handle overlapping as it wishes.
751 *
752 * That enumeration can then be used in a field inside the TP_FIELD macro using
753 * the following line:
754 *
78684808 755 * lttng_ust_field_enum(someproject_component, enumname, enumtype, enumfield, enumval)
c785c634
MD		 756 *
757 * Where "someproject_component" and "enumname" match those in the
2ebf164b 758 * LTTNG_UST_TRACEPOINT_ENUM, "enumtype" is a signed or unsigned integer type
c785c634
MD		 759 * backing the enumeration, "enumfield" is the name of the field and
760 * "enumval" is the value.
761 */
762
2ebf164b 763#define LTTNG_UST_TRACEPOINT_ENUM(provider, name, values)
c785c634 764
2ebf164b
MJ		 765#if LTTNG_UST_COMPAT_API(0)
766#define TRACEPOINT_ENUM LTTNG_UST_TRACEPOINT_ENUM
767#endif /* #if LTTNG_UST_COMPAT_API(0) */
768
769#endif /* #ifndef LTTNG_UST_TRACEPOINT_ENUM */
c785c634 770
7f2f82c3 771#ifndef LTTNG_UST_TRACEPOINT_EVENT
b728d87e
MD		 772
773/*
7f2f82c3 774 * How to use the LTTNG_UST_TRACEPOINT_EVENT macro:
b728d87e
MD		 775 *
776 * An example:
a60af3a5 777 *
7f2f82c3 778 * LTTNG_UST_TRACEPOINT_EVENT(someproject_component, event_name,
b728d87e 779 *
cadfcbfc 780 * * LTTNG_UST_TP_ARGS takes from 0 to 10 "type, field_name" pairs *
b728d87e 781 *
cadfcbfc 782 * LTTNG_UST_TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
b728d87e
MD		 783 * long *, arg4, size_t, arg4_len),
784 *
efa14d16 785 * * LTTNG_UST_TP_FIELDS describes the event payload layout in the trace *
b728d87e 786 *
efa14d16 787 * LTTNG_UST_TP_FIELDS(
a60af3a5 788 * * Integer, printed in base 10 *
b4064f28 789 * lttng_ust_field_integer(int, field_a, arg0)
b728d87e 790 *
a60af3a5 791 * * Integer, printed with 0x base 16 *
b4064f28 792 * lttng_ust_field_integer_hex(unsigned long, field_d, arg1)
b728d87e 793 *
c785c634 794 * * Enumeration *
78684808 795 * lttng_ust_field_enum(someproject_component, enum_name, int, field_e, arg0)
c785c634 796 *
a60af3a5 797 * * Array Sequence, printed as UTF8-encoded array of bytes *
10937ee5 798 * lttng_ust_field_array_text(char, field_b, string, FIXED_LEN)
1d188af9 799 * lttng_ust_field_sequence_text(char, field_c, string, size_t, strlen)
b728d87e 800 *
a60af3a5 801 * * String, printed as UTF8-encoded string *
3202f63a 802 * lttng_ust_field_string(field_e, string)
b728d87e 803 *
a60af3a5 804 * * Array sequence of signed integer values *
10937ee5 805 * lttng_ust_field_array(long, field_f, arg4, FIXED_LEN4)
1d188af9 806 * lttng_ust_field_sequence(long, field_g, arg4, size_t, arg4_len)
b728d87e
MD		 807 * )
808 * )
809 *
810 * More detailed explanation:
811 *
812 * The name of the tracepoint is expressed as a tuple with the provider
813 * and name arguments.
814 *
815 * The provider and name should be a proper C99 identifier.
816 * The "provider" and "name" MUST follow these rules to ensure no
817 * namespace clash occurs:
818 *
819 * For projects (applications and libraries) for which an entity
820 * specific to the project controls the source code and thus its
821 * tracepoints (typically with a scope larger than a single company):
822 *
823 * either:
824 * project_component, event
825 * or:
826 * project, event
827 *
828 * Where "project" is the name of the project,
829 * "component" is the name of the project component (which may
830 * include several levels of sub-components, e.g.
831 * ...component_subcomponent_...) where the tracepoint is located
832 * (optional),
833 * "event" is the name of the tracepoint event.
834 *
835 * For projects issued from a single company wishing to advertise that
836 * the company controls the source code and thus the tracepoints, the
837 * "com_" prefix should be used:
838 *
839 * either:
840 * com_company_project_component, event
841 * or:
842 * com_company_project, event
843 *
844 * Where "company" is the name of the company,
845 * "project" is the name of the project,
846 * "component" is the name of the project component (which may
847 * include several levels of sub-components, e.g.
848 * ...component_subcomponent_...) where the tracepoint is located
849 * (optional),
850 * "event" is the name of the tracepoint event.
851 *
852 * the provider:event identifier is limited to 127 characters.
853 */
854
7f2f82c3 855#define LTTNG_UST_TRACEPOINT_EVENT(provider, name, args, fields) \
6eddcb06
MJ		 856 LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) \
857 LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))
b728d87e 858
7f2f82c3 859#define LTTNG_UST_TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
b728d87e 860
5b675300 861#define LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(template_provider, template_name, provider, name, args) \
6eddcb06
MJ		 862 LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) \
863 LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))
b728d87e 864
7f2f82c3
MJ		 865#if LTTNG_UST_COMPAT_API(0)
866#define TRACEPOINT_EVENT LTTNG_UST_TRACEPOINT_EVENT
867#define TRACEPOINT_EVENT_CLASS LTTNG_UST_TRACEPOINT_EVENT_CLASS
5b675300
MD		 868#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, args) \
869 LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(_provider, _template, \
870 _provider, _name, LTTNG_UST__TP_PARAMS(args))
871
7f2f82c3
MJ		 872#endif /* #if LTTNG_UST_COMPAT_API(0) */
873
874#endif /* #ifndef LTTNG_UST_TRACEPOINT_EVENT */
b728d87e 875
612e9ce4 876#ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL
b728d87e
MD		 877
878/*
75c5ad79 879 * Tracepoint Loglevels
b728d87e
MD		 880 *
881 * Typical use of these loglevels:
882 *
d8de1354 883 * The loglevels go from 0 to 14. Higher numbers imply the most
75c5ad79
MD		 884 * verbosity (higher event throughput expected.
885 *
d8de1354
MD		 886 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
887 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
888 * debug information.
75c5ad79 889 *
612e9ce4 890 * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG 0
75c5ad79
MD		 891 * system is unusable
892 *
612e9ce4 893 * LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT 1
75c5ad79
MD		 894 * action must be taken immediately
895 *
612e9ce4 896 * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT 2
75c5ad79
MD		 897 * critical conditions
898 *
612e9ce4 899 * LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR 3
75c5ad79
MD		 900 * error conditions
901 *
612e9ce4 902 * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING 4
75c5ad79
MD		 903 * warning conditions
904 *
612e9ce4 905 * LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE 5
75c5ad79
MD		 906 * normal, but significant, condition
907 *
612e9ce4 908 * LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO 6
75c5ad79
MD		 909 * informational message
910 *
612e9ce4 911 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM 7
d8de1354 912 * debug information with system-level scope (set of programs)
75c5ad79 913 *
612e9ce4 914 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM 8
d8de1354 915 * debug information with program-level scope (set of processes)
75c5ad79 916 *
612e9ce4 917 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS 9
d8de1354 918 * debug information with process-level scope (set of modules)
75c5ad79 919 *
612e9ce4 920 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE 10
d8de1354 921 * debug information with module (executable/library) scope (set of units)
75c5ad79 922 *
612e9ce4 923 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT 11
d8de1354 924 * debug information with compilation unit scope (set of functions)
75c5ad79 925 *
612e9ce4 926 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION 12
d8de1354 927 * debug information with function-level scope
75c5ad79 928 *
612e9ce4 929 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE 13
7f2f82c3 930 * debug information with line-level scope (LTTNG_UST_TRACEPOINT_EVENT default)
902e1379 931 *
612e9ce4 932 * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG 14
1e3b0059 933 * debug-level message
75c5ad79 934 *
7f2f82c3 935 * Declare tracepoint loglevels for tracepoints. A LTTNG_UST_TRACEPOINT_EVENT
612e9ce4 936 * should be declared prior to the the LTTNG_UST_TRACEPOINT_LOGLEVEL for a given
853cda88
MD		 937 * tracepoint name. The first field is the provider name, the second
938 * field is the name of the tracepoint, the third field is the loglevel
939 * name.
b728d87e 940 *
612e9ce4 941 * LTTNG_UST_TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
b728d87e
MD		 942 * < loglevel_name >)
943 *
5b393d64 944 * The LTTNG_UST_TRACEPOINT_PROVIDER must be already declared before declaring a
612e9ce4 945 * LTTNG_UST_TRACEPOINT_LOGLEVEL.
b728d87e
MD		 946 */
947
882a56d7 948enum {
612e9ce4
MJ		 949 LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG = 0,
950 LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT = 1,
951 LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT = 2,
952 LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR = 3,
953 LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING = 4,
954 LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE = 5,
955 LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO = 6,
956 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM = 7,
957 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM = 8,
958 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS = 9,
959 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE = 10,
960 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT = 11,
961 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION = 12,
962 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE = 13,
963 LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG = 14,
882a56d7
MD		 964};
965
612e9ce4 966#define LTTNG_UST_TRACEPOINT_LOGLEVEL(provider, name, loglevel)
b728d87e 967
612e9ce4
MJ		 968#if LTTNG_UST_COMPAT_API(0)
969#define TRACEPOINT_LOGLEVEL LTTNG_UST_TRACEPOINT_LOGLEVEL
970
971#define TRACE_EMERG LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG
972#define TRACE_ALERT LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT
973#define TRACE_CRIT LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT
974#define TRACE_ERR LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR
975#define TRACE_WARNING LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING
976#define TRACE_NOTICE LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE
977#define TRACE_INFO LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO
978#define TRACE_DEBUG_SYSTEM LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM
979#define TRACE_DEBUG_PROGRAM LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM
980#define TRACE_DEBUG_PROCESS LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS
981#define TRACE_DEBUG_MODULE LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE
982#define TRACE_DEBUG_UNIT LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT
983#define TRACE_DEBUG_FUNCTION LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION
984#define TRACE_DEBUG_LINE LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE
985#define TRACE_DEBUG LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG
986#endif
987
988#endif /* #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL */
6ddc916d 989
dbcc2f92 990#ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
6ddc916d 991
dbcc2f92 992#define LTTNG_UST_TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
6ddc916d 993
dbcc2f92
MJ		 994#if LTTNG_UST_COMPAT_API(0)
995#define TRACEPOINT_MODEL_EMF_URI LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
996#endif
997
998#endif /* #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI */
LTTng 2.0 Userspace Tracer
This page took 0.09185 seconds and 4 git commands to generate.