Commit | Line | Data |
---|---|---|
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 | ||
c0c0989a MJ |
7 | #ifndef _LTTNG_TRACEPOINT_H |
8 | #define _LTTNG_TRACEPOINT_H | |
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 | |
50 | extern "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, ...) \ |
0274f7f2 | 185 | extern struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name; \ |
8da9deee | 186 | static inline \ |
6eddcb06 | 187 | void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__)) \ |
8da9deee | 188 | __attribute__((always_inline, unused)) lttng_ust_notrace; \ |
96f85541 | 189 | static \ |
6eddcb06 | 190 | void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__)) \ |
b728d87e | 191 | { \ |
10544ee8 | 192 | struct lttng_ust_tracepoint_probe *__tp_probe; \ |
b728d87e | 193 | \ |
251c9f75 | 194 | if (caa_unlikely(!LTTNG_UST_TP_RCU_LINK_TEST())) \ |
deb6e540 | 195 | return; \ |
251c9f75 MJ |
196 | lttng_ust_tp_rcu_read_lock(); \ |
197 | __tp_probe = lttng_ust_tp_rcu_dereference(lttng_ust_tracepoint_##_provider##___##_name.probes); \ | |
23c8854a | 198 | if (caa_unlikely(!__tp_probe)) \ |
b728d87e MD |
199 | goto end; \ |
200 | do { \ | |
1a206094 | 201 | void (*__tp_cb)(void) = __tp_probe->func; \ |
23c8854a | 202 | void *__tp_data = __tp_probe->data; \ |
b728d87e | 203 | \ |
6eddcb06 MJ |
204 | URCU_FORCE_CAST(void (*)(LTTNG_UST__TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \ |
205 | (LTTNG_UST__TP_ARGS_DATA_VAR(__VA_ARGS__)); \ | |
23c8854a | 206 | } while ((++__tp_probe)->func); \ |
b728d87e | 207 | end: \ |
251c9f75 | 208 | lttng_ust_tp_rcu_read_unlock(); \ |
b728d87e | 209 | } \ |
106ff4da | 210 | static inline \ |
0274f7f2 | 211 | void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \ |
106ff4da MJ |
212 | void (*func)(void), void *data) \ |
213 | lttng_ust_notrace; \ | |
a8909ba5 | 214 | static inline \ |
0274f7f2 | 215 | void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \ |
a8909ba5 | 216 | void (*func)(void), void *data) \ |
b728d87e | 217 | { \ |
0274f7f2 MJ |
218 | lttng_ust_tracepoint_probe_register(provider_name, event_name, func, data, \ |
219 | lttng_ust_tracepoint_##_provider##___##_name.signature); \ | |
b728d87e | 220 | } \ |
106ff4da | 221 | static inline \ |
0274f7f2 | 222 | void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \ |
106ff4da MJ |
223 | void (*func)(void), void *data) \ |
224 | lttng_ust_notrace; \ | |
a8909ba5 | 225 | static inline \ |
0274f7f2 | 226 | void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \ |
a8909ba5 | 227 | void (*func)(void), void *data) \ |
b728d87e | 228 | { \ |
0274f7f2 | 229 | lttng_ust_tracepoint_probe_unregister(provider_name, event_name, func, data); \ |
b728d87e MD |
230 | } |
231 | ||
0274f7f2 | 232 | extern int lttng_ust_tracepoint_probe_register(const char *provider_name, const char *event_name, |
34f7f142 | 233 | void (*func)(void), void *data, const char *signature); |
0274f7f2 | 234 | extern int lttng_ust_tracepoint_probe_unregister(const char *provider_name, const char *event_name, |
34f7f142 | 235 | void (*func)(void), void *data); |
deb6e540 | 236 | |
51920067 MD |
237 | /* |
238 | * tracepoint dynamic linkage handling (callbacks). Hidden visibility: | |
239 | * shared across objects in a module/main executable. | |
f641d544 MD |
240 | * |
241 | * IMPORTANT: this structure is part of the ABI between instrumented | |
242 | * applications and UST. Fields need to be only added at the end, never | |
243 | * reordered, never removed. | |
244 | * | |
245 | * The field @struct_size should be used to determine the size of the | |
246 | * structure. It should be queried before using additional fields added | |
247 | * at the end of the structure. | |
51920067 | 248 | */ |
1a206094 | 249 | struct lttng_ust_tracepoint_dlopen { |
f641d544 MD |
250 | uint32_t struct_size; |
251 | ||
51920067 MD |
252 | void *liblttngust_handle; |
253 | ||
096c06e5 | 254 | int (*lttng_ust_tracepoint_register_lib)(struct lttng_ust_tracepoint * const *tracepoints_start, |
51920067 | 255 | int tracepoints_count); |
096c06e5 | 256 | int (*lttng_ust_tracepoint_unregister_lib)(struct lttng_ust_tracepoint * const *tracepoints_start); |
10544ee8 MD |
257 | void (*rcu_read_lock_sym)(void); |
258 | void (*rcu_read_unlock_sym)(void); | |
259 | void *(*rcu_dereference_sym)(void *p); | |
f641d544 MD |
260 | |
261 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
51920067 MD |
262 | }; |
263 | ||
7863d51a MJ |
264 | extern struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen; |
265 | extern struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr; | |
51920067 | 266 | |
46c881a7 MD |
267 | /* |
268 | * These weak symbols, the constructor, and destructor take care of | |
269 | * registering only _one_ instance of the tracepoints per shared-ojbect | |
270 | * (or for the whole main program). | |
271 | */ | |
0274f7f2 | 272 | int lttng_ust_tracepoint_registered |
46c881a7 | 273 | __attribute__((weak, visibility("hidden"))); |
0274f7f2 | 274 | int lttng_ust_tracepoint_ptrs_registered |
46c881a7 | 275 | __attribute__((weak, visibility("hidden"))); |
7863d51a | 276 | struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen |
f641d544 MD |
277 | __attribute__((weak, visibility("hidden"))) = { |
278 | .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen), | |
279 | }; | |
9443a022 MD |
280 | /* |
281 | * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc | |
282 | * 4.8 and prior does not have the same behavior for symbol scoping on | |
283 | * 32-bit powerpc depending on the object size: symbols for objects of 8 | |
284 | * bytes or less have the same address throughout a module, whereas they | |
285 | * have different addresses between compile units for objects larger | |
286 | * than 8 bytes. Add this pointer indirection to ensure that the symbol | |
287 | * scoping match that of the other weak hidden symbols found in this | |
288 | * header. | |
289 | */ | |
7863d51a | 290 | struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr |
9443a022 | 291 | __attribute__((weak, visibility("hidden"))); |
46c881a7 | 292 | |
0fd0de10 FD |
293 | /* |
294 | * Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared | |
295 | * across objects in a module/main executable. The callbacks are used to | |
296 | * control and check if the destructors should be executed. | |
f641d544 MD |
297 | * |
298 | * IMPORTANT: this structure is part of the ABI between instrumented | |
299 | * applications and UST. Fields need to be only added at the end, never | |
300 | * reordered, never removed. | |
301 | * | |
302 | * The field @struct_size should be used to determine the size of the | |
303 | * structure. It should be queried before using additional fields added | |
304 | * at the end of the structure. | |
0fd0de10 FD |
305 | */ |
306 | struct lttng_ust_tracepoint_destructors_syms { | |
f641d544 MD |
307 | uint32_t struct_size; |
308 | ||
0fd0de10 FD |
309 | void (*tracepoint_disable_destructors)(void); |
310 | int (*tracepoint_get_destructors_state)(void); | |
f641d544 MD |
311 | |
312 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
0fd0de10 FD |
313 | }; |
314 | ||
62eb90f3 MJ |
315 | extern struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms; |
316 | extern struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr; | |
0fd0de10 | 317 | |
62eb90f3 | 318 | struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms |
f641d544 MD |
319 | __attribute__((weak, visibility("hidden"))) = { |
320 | .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms), | |
321 | }; | |
62eb90f3 | 322 | struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr |
0fd0de10 FD |
323 | __attribute__((weak, visibility("hidden"))); |
324 | ||
325 | static inline void tracepoint_disable_destructors(void) | |
326 | { | |
7863d51a MJ |
327 | if (!lttng_ust_tracepoint_dlopen_ptr) |
328 | lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; | |
62eb90f3 MJ |
329 | if (!lttng_ust_tracepoint_destructors_syms_ptr) |
330 | lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; | |
7863d51a | 331 | if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle |
62eb90f3 MJ |
332 | && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors) |
333 | lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors(); | |
0fd0de10 FD |
334 | } |
335 | ||
99234da6 | 336 | #ifndef _LGPL_SOURCE |
106ff4da | 337 | static inline void |
0274f7f2 | 338 | lttng_ust_tracepoint__init_urcu_sym(void) |
106ff4da | 339 | lttng_ust_notrace; |
99234da6 | 340 | static inline void |
0274f7f2 | 341 | lttng_ust_tracepoint__init_urcu_sym(void) |
99234da6 | 342 | { |
7863d51a MJ |
343 | if (!lttng_ust_tracepoint_dlopen_ptr) |
344 | lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; | |
99234da6 MD |
345 | /* |
346 | * Symbols below are needed by tracepoint call sites and probe | |
347 | * providers. | |
348 | */ | |
7863d51a MJ |
349 | if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym) |
350 | lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym = | |
99234da6 | 351 | URCU_FORCE_CAST(void (*)(void), |
7863d51a | 352 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
251c9f75 | 353 | "lttng_ust_tp_rcu_read_lock")); |
7863d51a MJ |
354 | if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym) |
355 | lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym = | |
99234da6 | 356 | URCU_FORCE_CAST(void (*)(void), |
7863d51a | 357 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
251c9f75 | 358 | "lttng_ust_tp_rcu_read_unlock")); |
7863d51a MJ |
359 | if (!lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym) |
360 | lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym = | |
99234da6 | 361 | URCU_FORCE_CAST(void *(*)(void *p), |
7863d51a | 362 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
251c9f75 | 363 | "lttng_ust_tp_rcu_dereference_sym")); |
99234da6 MD |
364 | } |
365 | #else | |
106ff4da | 366 | static inline void |
0274f7f2 | 367 | lttng_ust_tracepoint__init_urcu_sym(void) |
106ff4da | 368 | lttng_ust_notrace; |
99234da6 | 369 | static inline void |
0274f7f2 | 370 | lttng_ust_tracepoint__init_urcu_sym(void) |
99234da6 MD |
371 | { |
372 | } | |
373 | #endif | |
374 | ||
465a0d04 | 375 | static void |
ac9f44c2 | 376 | lttng_ust__tracepoints__init(void) |
465a0d04 | 377 | lttng_ust_notrace __attribute__((constructor)); |
46c881a7 | 378 | static void |
ac9f44c2 | 379 | lttng_ust__tracepoints__init(void) |
46c881a7 | 380 | { |
0274f7f2 | 381 | if (lttng_ust_tracepoint_registered++) { |
7863d51a | 382 | if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) |
8f0d1c78 | 383 | return; |
0274f7f2 | 384 | lttng_ust_tracepoint__init_urcu_sym(); |
46c881a7 | 385 | return; |
8f0d1c78 | 386 | } |
46c881a7 | 387 | |
7863d51a MJ |
388 | if (!lttng_ust_tracepoint_dlopen_ptr) |
389 | lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; | |
390 | if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) | |
391 | lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle = | |
3d3dc207 | 392 | dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL); |
7863d51a | 393 | if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) |
46c881a7 | 394 | return; |
0274f7f2 | 395 | lttng_ust_tracepoint__init_urcu_sym(); |
46c881a7 MD |
396 | } |
397 | ||
c589eca2 | 398 | static void |
ac9f44c2 | 399 | lttng_ust__tracepoints__destroy(void) |
c589eca2 | 400 | lttng_ust_notrace __attribute__((destructor)); |
46c881a7 | 401 | static void |
ac9f44c2 | 402 | lttng_ust__tracepoints__destroy(void) |
46c881a7 MD |
403 | { |
404 | int ret; | |
405 | ||
0274f7f2 | 406 | if (--lttng_ust_tracepoint_registered) |
46c881a7 | 407 | return; |
7863d51a MJ |
408 | if (!lttng_ust_tracepoint_dlopen_ptr) |
409 | lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; | |
62eb90f3 MJ |
410 | if (!lttng_ust_tracepoint_destructors_syms_ptr) |
411 | lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; | |
7863d51a | 412 | if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) |
0fd0de10 | 413 | return; |
0274f7f2 | 414 | if (lttng_ust_tracepoint_ptrs_registered) |
0fd0de10 FD |
415 | return; |
416 | /* | |
417 | * Lookup if destructors must be executed using the new method. | |
418 | */ | |
62eb90f3 MJ |
419 | if (lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state |
420 | && !lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()) { | |
0fd0de10 FD |
421 | /* |
422 | * The tracepoint_get_destructors_state symbol was found with | |
423 | * dlsym but its returned value is 0 meaning that destructors | |
424 | * must not be executed. | |
425 | */ | |
426 | return; | |
427 | } | |
7863d51a | 428 | ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle); |
0fd0de10 FD |
429 | if (ret) { |
430 | fprintf(stderr, "Error (%d) in dlclose\n", ret); | |
431 | abort(); | |
432 | } | |
7863d51a | 433 | memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr)); |
46c881a7 MD |
434 | } |
435 | ||
88c7c4ea MJ |
436 | #if LTTNG_UST_COMPAT_API(0) |
437 | # if defined(TRACEPOINT_DEFINE) && !defined(LTTNG_UST_TRACEPOINT_DEFINE) | |
438 | # define LTTNG_UST_TRACEPOINT_DEFINE | |
439 | # endif | |
440 | #endif /* #if LTTNG_UST_COMPAT_API(0) */ | |
441 | ||
442 | #ifdef LTTNG_UST_TRACEPOINT_DEFINE | |
deb6e540 | 443 | |
558b9d86 MD |
444 | /* |
445 | * These weak symbols, the constructor, and destructor take care of | |
446 | * registering only _one_ instance of the tracepoints per shared-ojbect | |
447 | * (or for the whole main program). | |
448 | */ | |
ac9f44c2 | 449 | extern struct lttng_ust_tracepoint * const __start_lttng_ust_tracepoints_ptrs[] |
558b9d86 | 450 | __attribute__((weak, visibility("hidden"))); |
ac9f44c2 | 451 | extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[] |
558b9d86 MD |
452 | __attribute__((weak, visibility("hidden"))); |
453 | ||
628e1d81 | 454 | /* |
341a19e8 | 455 | * When LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a |
628e1d81 | 456 | * unresolved symbol that requires the provider to be linked in. When |
341a19e8 | 457 | * LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an |
628e1d81 MD |
458 | * unresolved symbol that depends on having the provider linked in, |
459 | * otherwise the linker complains. This deals with use of static | |
460 | * libraries, ensuring that the linker does not remove the provider | |
461 | * object from the executable. | |
462 | */ | |
341a19e8 MJ |
463 | |
464 | #if LTTNG_UST_COMPAT_API(0) | |
465 | # if defined(TRACEPOINT_PROBE_DYNAMIC_LINKAGE) && !defined(LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE) | |
466 | # define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE | |
467 | # endif | |
468 | #endif /* #if LTTNG_UST_COMPAT_API(0) */ | |
469 | ||
470 | #ifdef LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE | |
471 | #define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider) NULL | |
472 | #else /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ | |
473 | #define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider) <tng_ust_tracepoint_provider_##provider | |
474 | #endif /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ | |
628e1d81 | 475 | |
b728d87e MD |
476 | /* |
477 | * Note: to allow PIC code, we need to allow the linker to update the pointers | |
ac9f44c2 | 478 | * in the lttng_ust_tracepoints_ptrs section. |
b728d87e MD |
479 | * Therefore, this section is _not_ const (read-only). |
480 | */ | |
341a19e8 | 481 | #define LTTNG_UST__TP_EXTRACT_STRING(...) #__VA_ARGS__ |
b4f3bc52 | 482 | |
7f2f82c3 | 483 | #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args) \ |
81b16412 | 484 | lttng_ust_tracepoint_validate_name_len(_provider, _name); \ |
0274f7f2 | 485 | extern int lttng_ust_tracepoint_provider_##_provider; \ |
92866a9d | 486 | static const char lttng_ust_tp_provider_strtab_##_provider##___##_name[] \ |
ac9f44c2 | 487 | __attribute__((section("lttng_ust_tracepoints_strings"))) = \ |
34f7f142 | 488 | #_provider; \ |
92866a9d | 489 | static const char lttng_ust_tp_name_strtab_##_provider##___##_name[] \ |
ac9f44c2 | 490 | __attribute__((section("lttng_ust_tracepoints_strings"))) = \ |
34f7f142 | 491 | #_name; \ |
0274f7f2 | 492 | struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name \ |
ac9f44c2 | 493 | __attribute__((section("lttng_ust_tracepoints"))) = { \ |
f641d544 | 494 | sizeof(struct lttng_ust_tracepoint), \ |
92866a9d MJ |
495 | lttng_ust_tp_provider_strtab_##_provider##___##_name, \ |
496 | lttng_ust_tp_name_strtab_##_provider##___##_name, \ | |
b4f3bc52 MD |
497 | 0, \ |
498 | NULL, \ | |
341a19e8 MJ |
499 | LTTNG_UST__TRACEPOINT_UNDEFINED_REF(_provider), \ |
500 | LTTNG_UST__TP_EXTRACT_STRING(_args), \ | |
b4f3bc52 | 501 | }; \ |
1a206094 | 502 | static struct lttng_ust_tracepoint * \ |
0274f7f2 | 503 | lttng_ust_tracepoint_ptr_##_provider##___##_name \ |
ac9f44c2 | 504 | __attribute__((section("lttng_ust_tracepoints_ptrs"), used)) \ |
4f74bc5e | 505 | __lttng_ust_variable_attribute_no_sanitize_address = \ |
0274f7f2 | 506 | <tng_ust_tracepoint_##_provider##___##_name; |
b728d87e | 507 | |
465a0d04 | 508 | static void |
ac9f44c2 | 509 | lttng_ust__tracepoints__ptrs_init(void) |
465a0d04 | 510 | lttng_ust_notrace __attribute__((constructor)); |
a8909ba5 | 511 | static void |
ac9f44c2 | 512 | lttng_ust__tracepoints__ptrs_init(void) |
b728d87e | 513 | { |
0274f7f2 | 514 | if (lttng_ust_tracepoint_ptrs_registered++) |
b728d87e | 515 | return; |
7863d51a MJ |
516 | if (!lttng_ust_tracepoint_dlopen_ptr) |
517 | lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; | |
518 | if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) | |
519 | lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle = | |
3d3dc207 | 520 | dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL); |
7863d51a | 521 | if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) |
deb6e540 | 522 | return; |
62eb90f3 MJ |
523 | if (!lttng_ust_tracepoint_destructors_syms_ptr) |
524 | lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; | |
096c06e5 | 525 | lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib = |
1a206094 | 526 | URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int), |
7863d51a | 527 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
096c06e5 MJ |
528 | "lttng_ust_tracepoint_register_lib")); |
529 | lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib = | |
1a206094 | 530 | URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *), |
7863d51a | 531 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
096c06e5 | 532 | "lttng_ust_tracepoint_unregister_lib")); |
62eb90f3 | 533 | lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors = |
0fd0de10 | 534 | URCU_FORCE_CAST(void (*)(void), |
7863d51a | 535 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
096c06e5 | 536 | "lttng_ust_tp_disable_destructors")); |
62eb90f3 | 537 | lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state = |
0fd0de10 | 538 | URCU_FORCE_CAST(int (*)(void), |
7863d51a | 539 | dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, |
096c06e5 | 540 | "lttng_ust_tp_get_destructors_state")); |
0274f7f2 | 541 | lttng_ust_tracepoint__init_urcu_sym(); |
096c06e5 MJ |
542 | if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib) { |
543 | lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib(__start_lttng_ust_tracepoints_ptrs, | |
ac9f44c2 MJ |
544 | __stop_lttng_ust_tracepoints_ptrs - |
545 | __start_lttng_ust_tracepoints_ptrs); | |
99234da6 | 546 | } |
b728d87e MD |
547 | } |
548 | ||
c589eca2 | 549 | static void |
ac9f44c2 | 550 | lttng_ust__tracepoints__ptrs_destroy(void) |
c589eca2 | 551 | lttng_ust_notrace __attribute__((destructor)); |
a8909ba5 | 552 | static void |
ac9f44c2 | 553 | lttng_ust__tracepoints__ptrs_destroy(void) |
b728d87e | 554 | { |
deb6e540 | 555 | int ret; |
51920067 | 556 | |
0274f7f2 | 557 | if (--lttng_ust_tracepoint_ptrs_registered) |
b728d87e | 558 | return; |
7863d51a MJ |
559 | if (!lttng_ust_tracepoint_dlopen_ptr) |
560 | lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; | |
62eb90f3 MJ |
561 | if (!lttng_ust_tracepoint_destructors_syms_ptr) |
562 | lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; | |
096c06e5 MJ |
563 | if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib) |
564 | lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib(__start_lttng_ust_tracepoints_ptrs); | |
7863d51a | 565 | if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle |
62eb90f3 MJ |
566 | && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state |
567 | && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state() | |
0274f7f2 | 568 | && !lttng_ust_tracepoint_ptrs_registered) { |
7863d51a | 569 | ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle); |
76aca78d MD |
570 | if (ret) { |
571 | fprintf(stderr, "Error (%d) in dlclose\n", ret); | |
572 | abort(); | |
573 | } | |
7863d51a | 574 | memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr)); |
deb6e540 | 575 | } |
b728d87e MD |
576 | } |
577 | ||
88c7c4ea | 578 | #else /* LTTNG_UST_TRACEPOINT_DEFINE */ |
46c881a7 | 579 | |
7f2f82c3 | 580 | #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args) |
46c881a7 | 581 | |
88c7c4ea | 582 | #endif /* #else LTTNG_UST_TRACEPOINT_DEFINE */ |
deb6e540 | 583 | |
cbc06a3b MD |
584 | #if LTTNG_UST_COMPAT_API(0) |
585 | #define tracepoint lttng_ust_tracepoint | |
586 | #define do_tracepoint lttng_ust_do_tracepoint | |
587 | #define tracepoint_enabled lttng_ust_tracepoint_enabled | |
cadfcbfc | 588 | #define TP_ARGS LTTNG_UST_TP_ARGS |
cbc06a3b MD |
589 | #endif /* #if LTTNG_UST_COMPAT_API(0) */ |
590 | ||
b728d87e MD |
591 | #ifdef __cplusplus |
592 | } | |
593 | #endif | |
594 | ||
595 | #endif /* _LTTNG_TRACEPOINT_H */ | |
596 | ||
597 | /* The following declarations must be outside re-inclusion protection. */ | |
598 | ||
2ebf164b | 599 | #ifndef LTTNG_UST_TRACEPOINT_ENUM |
c785c634 MD |
600 | |
601 | /* | |
602 | * Tracepoint Enumerations | |
603 | * | |
604 | * The enumeration is a mapping between an integer, or range of integers, and | |
605 | * a string. It can be used to have a more compact trace in cases where the | |
606 | * possible values for a field are limited: | |
607 | * | |
608 | * An example: | |
609 | * | |
2ebf164b | 610 | * LTTNG_UST_TRACEPOINT_ENUM(someproject_component, enumname, |
4849bc7a | 611 | * LTTNG_UST_TP_ENUM_VALUES( |
78684808 MJ |
612 | * lttng_ust_field_enum_value("even", 0) |
613 | * lttng_ust_field_enum_value("uneven", 1) | |
614 | * lttng_ust_field_enum_range("twoto4", 2, 4) | |
615 | * lttng_ust_field_enum_value("five", 5) | |
c785c634 MD |
616 | * ) |
617 | * ) | |
618 | * | |
619 | * Where "someproject_component" is the name of the component this enumeration | |
620 | * belongs to and "enumname" identifies this enumeration. Inside the | |
4849bc7a | 621 | * LTTNG_UST_TP_ENUM_VALUES macro is the actual mapping. Each string value can map |
78684808 MJ |
622 | * to either a single value with lttng_ust_field_enum_value or a range of values |
623 | * with lttng_ust_field_enum_range. | |
c785c634 MD |
624 | * |
625 | * Enumeration ranges may overlap, but the behavior is implementation-defined, | |
626 | * each trace reader will handle overlapping as it wishes. | |
627 | * | |
628 | * That enumeration can then be used in a field inside the TP_FIELD macro using | |
629 | * the following line: | |
630 | * | |
78684808 | 631 | * lttng_ust_field_enum(someproject_component, enumname, enumtype, enumfield, enumval) |
c785c634 MD |
632 | * |
633 | * Where "someproject_component" and "enumname" match those in the | |
2ebf164b | 634 | * LTTNG_UST_TRACEPOINT_ENUM, "enumtype" is a signed or unsigned integer type |
c785c634 MD |
635 | * backing the enumeration, "enumfield" is the name of the field and |
636 | * "enumval" is the value. | |
637 | */ | |
638 | ||
2ebf164b | 639 | #define LTTNG_UST_TRACEPOINT_ENUM(provider, name, values) |
c785c634 | 640 | |
2ebf164b MJ |
641 | #if LTTNG_UST_COMPAT_API(0) |
642 | #define TRACEPOINT_ENUM LTTNG_UST_TRACEPOINT_ENUM | |
643 | #endif /* #if LTTNG_UST_COMPAT_API(0) */ | |
644 | ||
645 | #endif /* #ifndef LTTNG_UST_TRACEPOINT_ENUM */ | |
c785c634 | 646 | |
7f2f82c3 | 647 | #ifndef LTTNG_UST_TRACEPOINT_EVENT |
b728d87e MD |
648 | |
649 | /* | |
7f2f82c3 | 650 | * How to use the LTTNG_UST_TRACEPOINT_EVENT macro: |
b728d87e MD |
651 | * |
652 | * An example: | |
a60af3a5 | 653 | * |
7f2f82c3 | 654 | * LTTNG_UST_TRACEPOINT_EVENT(someproject_component, event_name, |
b728d87e | 655 | * |
cadfcbfc | 656 | * * LTTNG_UST_TP_ARGS takes from 0 to 10 "type, field_name" pairs * |
b728d87e | 657 | * |
cadfcbfc | 658 | * LTTNG_UST_TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen, |
b728d87e MD |
659 | * long *, arg4, size_t, arg4_len), |
660 | * | |
efa14d16 | 661 | * * LTTNG_UST_TP_FIELDS describes the event payload layout in the trace * |
b728d87e | 662 | * |
efa14d16 | 663 | * LTTNG_UST_TP_FIELDS( |
a60af3a5 | 664 | * * Integer, printed in base 10 * |
b4064f28 | 665 | * lttng_ust_field_integer(int, field_a, arg0) |
b728d87e | 666 | * |
a60af3a5 | 667 | * * Integer, printed with 0x base 16 * |
b4064f28 | 668 | * lttng_ust_field_integer_hex(unsigned long, field_d, arg1) |
b728d87e | 669 | * |
c785c634 | 670 | * * Enumeration * |
78684808 | 671 | * lttng_ust_field_enum(someproject_component, enum_name, int, field_e, arg0) |
c785c634 | 672 | * |
a60af3a5 | 673 | * * Array Sequence, printed as UTF8-encoded array of bytes * |
10937ee5 | 674 | * lttng_ust_field_array_text(char, field_b, string, FIXED_LEN) |
1d188af9 | 675 | * lttng_ust_field_sequence_text(char, field_c, string, size_t, strlen) |
b728d87e | 676 | * |
a60af3a5 | 677 | * * String, printed as UTF8-encoded string * |
3202f63a | 678 | * lttng_ust_field_string(field_e, string) |
b728d87e | 679 | * |
a60af3a5 | 680 | * * Array sequence of signed integer values * |
10937ee5 | 681 | * lttng_ust_field_array(long, field_f, arg4, FIXED_LEN4) |
1d188af9 | 682 | * lttng_ust_field_sequence(long, field_g, arg4, size_t, arg4_len) |
b728d87e MD |
683 | * ) |
684 | * ) | |
685 | * | |
686 | * More detailed explanation: | |
687 | * | |
688 | * The name of the tracepoint is expressed as a tuple with the provider | |
689 | * and name arguments. | |
690 | * | |
691 | * The provider and name should be a proper C99 identifier. | |
692 | * The "provider" and "name" MUST follow these rules to ensure no | |
693 | * namespace clash occurs: | |
694 | * | |
695 | * For projects (applications and libraries) for which an entity | |
696 | * specific to the project controls the source code and thus its | |
697 | * tracepoints (typically with a scope larger than a single company): | |
698 | * | |
699 | * either: | |
700 | * project_component, event | |
701 | * or: | |
702 | * project, event | |
703 | * | |
704 | * Where "project" is the name of the project, | |
705 | * "component" is the name of the project component (which may | |
706 | * include several levels of sub-components, e.g. | |
707 | * ...component_subcomponent_...) where the tracepoint is located | |
708 | * (optional), | |
709 | * "event" is the name of the tracepoint event. | |
710 | * | |
711 | * For projects issued from a single company wishing to advertise that | |
712 | * the company controls the source code and thus the tracepoints, the | |
713 | * "com_" prefix should be used: | |
714 | * | |
715 | * either: | |
716 | * com_company_project_component, event | |
717 | * or: | |
718 | * com_company_project, event | |
719 | * | |
720 | * Where "company" is the name of the company, | |
721 | * "project" is the name of the project, | |
722 | * "component" is the name of the project component (which may | |
723 | * include several levels of sub-components, e.g. | |
724 | * ...component_subcomponent_...) where the tracepoint is located | |
725 | * (optional), | |
726 | * "event" is the name of the tracepoint event. | |
727 | * | |
728 | * the provider:event identifier is limited to 127 characters. | |
729 | */ | |
730 | ||
7f2f82c3 | 731 | #define LTTNG_UST_TRACEPOINT_EVENT(provider, name, args, fields) \ |
6eddcb06 MJ |
732 | LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) \ |
733 | LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) | |
b728d87e | 734 | |
7f2f82c3 | 735 | #define LTTNG_UST_TRACEPOINT_EVENT_CLASS(provider, name, args, fields) |
b728d87e | 736 | |
7f2f82c3 | 737 | #define LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \ |
6eddcb06 MJ |
738 | LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) \ |
739 | LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) | |
b728d87e | 740 | |
7f2f82c3 MJ |
741 | #if LTTNG_UST_COMPAT_API(0) |
742 | #define TRACEPOINT_EVENT LTTNG_UST_TRACEPOINT_EVENT | |
743 | #define TRACEPOINT_EVENT_CLASS LTTNG_UST_TRACEPOINT_EVENT_CLASS | |
744 | #define TRACEPOINT_EVENT_INSTANCE LTTNG_UST_TRACEPOINT_EVENT_INSTANCE | |
745 | #endif /* #if LTTNG_UST_COMPAT_API(0) */ | |
746 | ||
747 | #endif /* #ifndef LTTNG_UST_TRACEPOINT_EVENT */ | |
b728d87e | 748 | |
612e9ce4 | 749 | #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL |
b728d87e MD |
750 | |
751 | /* | |
75c5ad79 | 752 | * Tracepoint Loglevels |
b728d87e MD |
753 | * |
754 | * Typical use of these loglevels: | |
755 | * | |
d8de1354 | 756 | * The loglevels go from 0 to 14. Higher numbers imply the most |
75c5ad79 MD |
757 | * verbosity (higher event throughput expected. |
758 | * | |
d8de1354 MD |
759 | * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels |
760 | * semantic. Loglevels 7 through 13 offer more fine-grained selection of | |
761 | * debug information. | |
75c5ad79 | 762 | * |
612e9ce4 | 763 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG 0 |
75c5ad79 MD |
764 | * system is unusable |
765 | * | |
612e9ce4 | 766 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT 1 |
75c5ad79 MD |
767 | * action must be taken immediately |
768 | * | |
612e9ce4 | 769 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT 2 |
75c5ad79 MD |
770 | * critical conditions |
771 | * | |
612e9ce4 | 772 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR 3 |
75c5ad79 MD |
773 | * error conditions |
774 | * | |
612e9ce4 | 775 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING 4 |
75c5ad79 MD |
776 | * warning conditions |
777 | * | |
612e9ce4 | 778 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE 5 |
75c5ad79 MD |
779 | * normal, but significant, condition |
780 | * | |
612e9ce4 | 781 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO 6 |
75c5ad79 MD |
782 | * informational message |
783 | * | |
612e9ce4 | 784 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM 7 |
d8de1354 | 785 | * debug information with system-level scope (set of programs) |
75c5ad79 | 786 | * |
612e9ce4 | 787 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM 8 |
d8de1354 | 788 | * debug information with program-level scope (set of processes) |
75c5ad79 | 789 | * |
612e9ce4 | 790 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS 9 |
d8de1354 | 791 | * debug information with process-level scope (set of modules) |
75c5ad79 | 792 | * |
612e9ce4 | 793 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE 10 |
d8de1354 | 794 | * debug information with module (executable/library) scope (set of units) |
75c5ad79 | 795 | * |
612e9ce4 | 796 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT 11 |
d8de1354 | 797 | * debug information with compilation unit scope (set of functions) |
75c5ad79 | 798 | * |
612e9ce4 | 799 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION 12 |
d8de1354 | 800 | * debug information with function-level scope |
75c5ad79 | 801 | * |
612e9ce4 | 802 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE 13 |
7f2f82c3 | 803 | * debug information with line-level scope (LTTNG_UST_TRACEPOINT_EVENT default) |
902e1379 | 804 | * |
612e9ce4 | 805 | * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG 14 |
1e3b0059 | 806 | * debug-level message |
75c5ad79 | 807 | * |
7f2f82c3 | 808 | * Declare tracepoint loglevels for tracepoints. A LTTNG_UST_TRACEPOINT_EVENT |
612e9ce4 | 809 | * should be declared prior to the the LTTNG_UST_TRACEPOINT_LOGLEVEL for a given |
853cda88 MD |
810 | * tracepoint name. The first field is the provider name, the second |
811 | * field is the name of the tracepoint, the third field is the loglevel | |
812 | * name. | |
b728d87e | 813 | * |
612e9ce4 | 814 | * LTTNG_UST_TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >, |
b728d87e MD |
815 | * < loglevel_name >) |
816 | * | |
5b393d64 | 817 | * The LTTNG_UST_TRACEPOINT_PROVIDER must be already declared before declaring a |
612e9ce4 | 818 | * LTTNG_UST_TRACEPOINT_LOGLEVEL. |
b728d87e MD |
819 | */ |
820 | ||
882a56d7 | 821 | enum { |
612e9ce4 MJ |
822 | LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG = 0, |
823 | LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT = 1, | |
824 | LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT = 2, | |
825 | LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR = 3, | |
826 | LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING = 4, | |
827 | LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE = 5, | |
828 | LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO = 6, | |
829 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM = 7, | |
830 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM = 8, | |
831 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS = 9, | |
832 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE = 10, | |
833 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT = 11, | |
834 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION = 12, | |
835 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE = 13, | |
836 | LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG = 14, | |
882a56d7 MD |
837 | }; |
838 | ||
612e9ce4 | 839 | #define LTTNG_UST_TRACEPOINT_LOGLEVEL(provider, name, loglevel) |
b728d87e | 840 | |
612e9ce4 MJ |
841 | #if LTTNG_UST_COMPAT_API(0) |
842 | #define TRACEPOINT_LOGLEVEL LTTNG_UST_TRACEPOINT_LOGLEVEL | |
843 | ||
844 | #define TRACE_EMERG LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG | |
845 | #define TRACE_ALERT LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT | |
846 | #define TRACE_CRIT LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT | |
847 | #define TRACE_ERR LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR | |
848 | #define TRACE_WARNING LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING | |
849 | #define TRACE_NOTICE LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE | |
850 | #define TRACE_INFO LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO | |
851 | #define TRACE_DEBUG_SYSTEM LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM | |
852 | #define TRACE_DEBUG_PROGRAM LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM | |
853 | #define TRACE_DEBUG_PROCESS LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS | |
854 | #define TRACE_DEBUG_MODULE LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE | |
855 | #define TRACE_DEBUG_UNIT LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT | |
856 | #define TRACE_DEBUG_FUNCTION LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION | |
857 | #define TRACE_DEBUG_LINE LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE | |
858 | #define TRACE_DEBUG LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG | |
859 | #endif | |
860 | ||
861 | #endif /* #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL */ | |
6ddc916d | 862 | |
dbcc2f92 | 863 | #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI |
6ddc916d | 864 | |
dbcc2f92 | 865 | #define LTTNG_UST_TRACEPOINT_MODEL_EMF_URI(provider, name, uri) |
6ddc916d | 866 | |
dbcc2f92 MJ |
867 | #if LTTNG_UST_COMPAT_API(0) |
868 | #define TRACEPOINT_MODEL_EMF_URI LTTNG_UST_TRACEPOINT_MODEL_EMF_URI | |
869 | #endif | |
870 | ||
871 | #endif /* #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI */ |