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