Commit | Line | Data |
---|---|---|
b728d87e MD |
1 | #ifndef _LTTNG_TRACEPOINT_H |
2 | #define _LTTNG_TRACEPOINT_H | |
3 | ||
4 | /* | |
e92f3e28 | 5 | * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
b728d87e | 6 | * |
e92f3e28 MD |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
b728d87e | 13 | * |
e92f3e28 MD |
14 | * The above copyright notice and this permission notice shall be included in |
15 | * all copies or substantial portions of the Software. | |
d2428e87 MD |
16 | * |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
b728d87e MD |
24 | */ |
25 | ||
76aca78d MD |
26 | #include <stdio.h> |
27 | #include <stdlib.h> | |
8fce9e2b | 28 | #include <lttng/tracepoint-types.h> |
40b2b5a4 | 29 | #include <lttng/tracepoint-rcu.h> |
b728d87e | 30 | #include <urcu/compiler.h> |
c082d14b | 31 | #include <urcu/system.h> |
deb6e540 | 32 | #include <dlfcn.h> /* for dlopen */ |
51920067 | 33 | #include <string.h> /* for memset */ |
b2f60c79 | 34 | #include <lttng/ust-config.h> /* for sdt */ |
a8909ba5 | 35 | #include <lttng/ust-compiler.h> |
b2f60c79 MD |
36 | |
37 | #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION | |
38 | #define SDT_USE_VARIADIC | |
39 | #include <sys/sdt.h> | |
f018237c | 40 | #define LTTNG_STAP_PROBEV STAP_PROBEV |
b2f60c79 | 41 | #else |
f018237c | 42 | #define LTTNG_STAP_PROBEV(...) |
b2f60c79 | 43 | #endif |
b728d87e MD |
44 | |
45 | #ifdef __cplusplus | |
46 | extern "C" { | |
47 | #endif | |
48 | ||
8da6d0c8 | 49 | #define tracepoint_enabled(provider, name) \ |
c082d14b | 50 | caa_unlikely(CMM_LOAD_SHARED(__tracepoint_##provider##___##name.state)) |
8da6d0c8 DS |
51 | |
52 | #define do_tracepoint(provider, name, ...) \ | |
53 | __tracepoint_cb_##provider##___##name(__VA_ARGS__) | |
54 | ||
23c8854a MD |
55 | #define tracepoint(provider, name, ...) \ |
56 | do { \ | |
f018237c | 57 | LTTNG_STAP_PROBEV(provider, name, ## __VA_ARGS__); \ |
8da6d0c8 DS |
58 | if (tracepoint_enabled(provider, name)) \ |
59 | do_tracepoint(provider, name, __VA_ARGS__); \ | |
b728d87e MD |
60 | } while (0) |
61 | ||
62 | #define TP_ARGS(...) __VA_ARGS__ | |
63 | ||
64 | /* | |
65 | * TP_ARGS takes tuples of type, argument separated by a comma. | |
66 | * It can take up to 10 tuples (which means that less than 10 tuples is | |
67 | * fine too). | |
68 | * Each tuple is also separated by a comma. | |
69 | */ | |
df854e41 MD |
70 | #define __TP_COMBINE_TOKENS(_tokena, _tokenb) \ |
71 | _tokena##_tokenb | |
72 | #define _TP_COMBINE_TOKENS(_tokena, _tokenb) \ | |
73 | __TP_COMBINE_TOKENS(_tokena, _tokenb) | |
74 | #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \ | |
75 | _tokena##_tokenb##_tokenc | |
76 | #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \ | |
77 | __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) | |
78 | #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ | |
79 | _tokena##_tokenb##_tokenc##_tokend | |
80 | #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ | |
81 | __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) | |
b728d87e | 82 | |
4495dd39 MD |
83 | /* |
84 | * _TP_EXVAR* extract the var names. | |
85 | * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99. | |
86 | */ | |
b728d87e | 87 | #define _TP_EXVAR0() |
4495dd39 | 88 | #define _TP_EXVAR1(a) |
b728d87e MD |
89 | #define _TP_EXVAR2(a,b) b |
90 | #define _TP_EXVAR4(a,b,c,d) b,d | |
91 | #define _TP_EXVAR6(a,b,c,d,e,f) b,d,f | |
92 | #define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h | |
93 | #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j | |
94 | #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l | |
95 | #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n | |
96 | #define _TP_EXVAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) b,d,f,h,j,l,n,p | |
97 | #define _TP_EXVAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) b,d,f,h,j,l,n,p,r | |
98 | #define _TP_EXVAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) b,d,f,h,j,l,n,p,r,t | |
99 | ||
100 | #define _TP_EXDATA_VAR0() __tp_data | |
4495dd39 | 101 | #define _TP_EXDATA_VAR1(a) __tp_data |
b728d87e MD |
102 | #define _TP_EXDATA_VAR2(a,b) __tp_data,b |
103 | #define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d | |
104 | #define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f | |
105 | #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h | |
106 | #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j | |
107 | #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l | |
108 | #define _TP_EXDATA_VAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) __tp_data,b,d,f,h,j,l,n | |
109 | #define _TP_EXDATA_VAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) __tp_data,b,d,f,h,j,l,n,p | |
110 | #define _TP_EXDATA_VAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) __tp_data,b,d,f,h,j,l,n,p,r | |
111 | #define _TP_EXDATA_VAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) __tp_data,b,d,f,h,j,l,n,p,r,t | |
112 | ||
4495dd39 MD |
113 | /* |
114 | * _TP_EXPROTO* extract tuples of type, var. | |
115 | * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99. | |
116 | */ | |
86637aa6 | 117 | #define _TP_EXPROTO0() void |
4495dd39 | 118 | #define _TP_EXPROTO1(a) void |
b728d87e MD |
119 | #define _TP_EXPROTO2(a,b) a b |
120 | #define _TP_EXPROTO4(a,b,c,d) a b,c d | |
121 | #define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f | |
122 | #define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h | |
123 | #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j | |
124 | #define _TP_EXPROTO12(a,b,c,d,e,f,g,h,i,j,k,l) a b,c d,e f,g h,i j,k l | |
125 | #define _TP_EXPROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) a b,c d,e f,g h,i j,k l,m n | |
126 | #define _TP_EXPROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) a b,c d,e f,g h,i j,k l,m n,o p | |
127 | #define _TP_EXPROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) a b,c d,e f,g h,i j,k l,m n,o p,q r | |
128 | #define _TP_EXPROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) a b,c d,e f,g h,i j,k l,m n,o p,q r,s t | |
129 | ||
130 | #define _TP_EXDATA_PROTO0() void *__tp_data | |
4495dd39 | 131 | #define _TP_EXDATA_PROTO1(a) void *__tp_data |
b728d87e MD |
132 | #define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b |
133 | #define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d | |
134 | #define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f | |
135 | #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h | |
136 | #define _TP_EXDATA_PROTO10(a,b,c,d,e,f,g,h,i,j) void *__tp_data,a b,c d,e f,g h,i j | |
137 | #define _TP_EXDATA_PROTO12(a,b,c,d,e,f,g,h,i,j,k,l) void *__tp_data,a b,c d,e f,g h,i j,k l | |
138 | #define _TP_EXDATA_PROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) void *__tp_data,a b,c d,e f,g h,i j,k l,m n | |
139 | #define _TP_EXDATA_PROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p | |
140 | #define _TP_EXDATA_PROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r | |
141 | #define _TP_EXDATA_PROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t | |
142 | ||
143 | /* Preprocessor trick to count arguments. Inspired from sdt.h. */ | |
144 | #define _TP_NARGS(...) __TP_NARGS(__VA_ARGS__, 20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0) | |
145 | #define __TP_NARGS(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20, N, ...) N | |
23c8854a MD |
146 | #define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__)) |
147 | #define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__)) | |
148 | #define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__)) | |
149 | #define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__)) | |
b728d87e | 150 | #define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
23c8854a | 151 | #define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
b728d87e | 152 | #define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
23c8854a | 153 | #define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
b728d87e MD |
154 | #define _TP_PARAMS(...) __VA_ARGS__ |
155 | ||
96f85541 MD |
156 | /* |
157 | * The tracepoint cb is marked always inline so we can distinguish | |
158 | * between caller's ip addresses within the probe using the return | |
159 | * address. | |
160 | */ | |
0f2f7e21 | 161 | #define _DECLARE_TRACEPOINT(_provider, _name, ...) \ |
1a206094 | 162 | extern struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name; \ |
17ca0600 | 163 | static inline __attribute__((always_inline, unused)) lttng_ust_notrace \ |
a8909ba5 | 164 | void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \ |
96f85541 | 165 | static \ |
a8909ba5 | 166 | void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \ |
b728d87e | 167 | { \ |
1a206094 | 168 | struct lttng_ust_tracepoint_probe *__tp_probe; \ |
b728d87e | 169 | \ |
d3db6a40 | 170 | if (caa_unlikely(!TP_RCU_LINK_TEST())) \ |
deb6e540 | 171 | return; \ |
40b2b5a4 | 172 | tp_rcu_read_lock_bp(); \ |
0f2f7e21 | 173 | __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \ |
23c8854a | 174 | if (caa_unlikely(!__tp_probe)) \ |
b728d87e MD |
175 | goto end; \ |
176 | do { \ | |
1a206094 | 177 | void (*__tp_cb)(void) = __tp_probe->func; \ |
23c8854a | 178 | void *__tp_data = __tp_probe->data; \ |
b728d87e | 179 | \ |
23c8854a MD |
180 | URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \ |
181 | (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \ | |
182 | } while ((++__tp_probe)->func); \ | |
b728d87e | 183 | end: \ |
40b2b5a4 | 184 | tp_rcu_read_unlock_bp(); \ |
b728d87e | 185 | } \ |
a8909ba5 PW |
186 | static inline lttng_ust_notrace \ |
187 | void __tracepoint_register_##_provider##___##_name(char *name, \ | |
188 | void (*func)(void), void *data); \ | |
189 | static inline \ | |
190 | void __tracepoint_register_##_provider##___##_name(char *name, \ | |
191 | void (*func)(void), void *data) \ | |
b728d87e | 192 | { \ |
67e5f391 MD |
193 | __tracepoint_probe_register(name, func, data, \ |
194 | __tracepoint_##_provider##___##_name.signature); \ | |
b728d87e | 195 | } \ |
a8909ba5 PW |
196 | static inline lttng_ust_notrace \ |
197 | void __tracepoint_unregister_##_provider##___##_name(char *name, \ | |
198 | void (*func)(void), void *data); \ | |
199 | static inline \ | |
200 | void __tracepoint_unregister_##_provider##___##_name(char *name, \ | |
201 | void (*func)(void), void *data) \ | |
b728d87e | 202 | { \ |
23c8854a | 203 | __tracepoint_probe_unregister(name, func, data); \ |
b728d87e MD |
204 | } |
205 | ||
fbdeb5ec MD |
206 | extern int __tracepoint_probe_register(const char *name, void (*func)(void), |
207 | void *data, const char *signature); | |
208 | extern int __tracepoint_probe_unregister(const char *name, void (*func)(void), | |
209 | void *data); | |
deb6e540 | 210 | |
51920067 MD |
211 | /* |
212 | * tracepoint dynamic linkage handling (callbacks). Hidden visibility: | |
213 | * shared across objects in a module/main executable. | |
214 | */ | |
1a206094 | 215 | struct lttng_ust_tracepoint_dlopen { |
51920067 MD |
216 | void *liblttngust_handle; |
217 | ||
1a206094 | 218 | int (*tracepoint_register_lib)(struct lttng_ust_tracepoint * const *tracepoints_start, |
51920067 | 219 | int tracepoints_count); |
1a206094 | 220 | int (*tracepoint_unregister_lib)(struct lttng_ust_tracepoint * const *tracepoints_start); |
51920067 MD |
221 | #ifndef _LGPL_SOURCE |
222 | void (*rcu_read_lock_sym_bp)(void); | |
223 | void (*rcu_read_unlock_sym_bp)(void); | |
224 | void *(*rcu_dereference_sym_bp)(void *p); | |
225 | #endif | |
226 | }; | |
227 | ||
1a206094 | 228 | extern struct lttng_ust_tracepoint_dlopen tracepoint_dlopen; |
51920067 | 229 | |
46c881a7 MD |
230 | #if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES) |
231 | ||
232 | /* | |
233 | * These weak symbols, the constructor, and destructor take care of | |
234 | * registering only _one_ instance of the tracepoints per shared-ojbect | |
235 | * (or for the whole main program). | |
236 | */ | |
237 | int __tracepoint_registered | |
238 | __attribute__((weak, visibility("hidden"))); | |
239 | int __tracepoint_ptrs_registered | |
240 | __attribute__((weak, visibility("hidden"))); | |
1a206094 | 241 | struct lttng_ust_tracepoint_dlopen tracepoint_dlopen |
46c881a7 MD |
242 | __attribute__((weak, visibility("hidden"))); |
243 | ||
99234da6 MD |
244 | #ifndef _LGPL_SOURCE |
245 | static inline void lttng_ust_notrace | |
246 | __tracepoint__init_urcu_sym(void); | |
247 | static inline void | |
248 | __tracepoint__init_urcu_sym(void) | |
249 | { | |
250 | /* | |
251 | * Symbols below are needed by tracepoint call sites and probe | |
252 | * providers. | |
253 | */ | |
254 | if (!tracepoint_dlopen.rcu_read_lock_sym_bp) | |
255 | tracepoint_dlopen.rcu_read_lock_sym_bp = | |
256 | URCU_FORCE_CAST(void (*)(void), | |
257 | dlsym(tracepoint_dlopen.liblttngust_handle, | |
258 | "tp_rcu_read_lock_bp")); | |
259 | if (!tracepoint_dlopen.rcu_read_unlock_sym_bp) | |
260 | tracepoint_dlopen.rcu_read_unlock_sym_bp = | |
261 | URCU_FORCE_CAST(void (*)(void), | |
262 | dlsym(tracepoint_dlopen.liblttngust_handle, | |
263 | "tp_rcu_read_unlock_bp")); | |
264 | if (!tracepoint_dlopen.rcu_dereference_sym_bp) | |
265 | tracepoint_dlopen.rcu_dereference_sym_bp = | |
266 | URCU_FORCE_CAST(void *(*)(void *p), | |
267 | dlsym(tracepoint_dlopen.liblttngust_handle, | |
268 | "tp_rcu_dereference_sym_bp")); | |
269 | } | |
270 | #else | |
271 | static inline void lttng_ust_notrace | |
272 | __tracepoint__init_urcu_sym(void); | |
273 | static inline void | |
274 | __tracepoint__init_urcu_sym(void) | |
275 | { | |
276 | } | |
277 | #endif | |
278 | ||
46c881a7 MD |
279 | static void lttng_ust_notrace __attribute__((constructor)) |
280 | __tracepoints__init(void); | |
281 | static void | |
282 | __tracepoints__init(void) | |
283 | { | |
284 | if (__tracepoint_registered++) | |
285 | return; | |
286 | ||
287 | if (!tracepoint_dlopen.liblttngust_handle) | |
288 | tracepoint_dlopen.liblttngust_handle = | |
289 | dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL); | |
290 | if (!tracepoint_dlopen.liblttngust_handle) | |
291 | return; | |
99234da6 | 292 | __tracepoint__init_urcu_sym(); |
46c881a7 MD |
293 | } |
294 | ||
295 | static void lttng_ust_notrace __attribute__((destructor)) | |
296 | __tracepoints__destroy(void); | |
297 | static void | |
298 | __tracepoints__destroy(void) | |
299 | { | |
300 | int ret; | |
301 | ||
302 | if (--__tracepoint_registered) | |
303 | return; | |
304 | if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_ptrs_registered) { | |
305 | ret = dlclose(tracepoint_dlopen.liblttngust_handle); | |
76aca78d MD |
306 | if (ret) { |
307 | fprintf(stderr, "Error (%d) in dlclose\n", ret); | |
308 | abort(); | |
309 | } | |
46c881a7 MD |
310 | memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen)); |
311 | } | |
312 | } | |
313 | ||
314 | #endif | |
315 | ||
deb6e540 MD |
316 | #ifdef TRACEPOINT_DEFINE |
317 | ||
558b9d86 MD |
318 | /* |
319 | * These weak symbols, the constructor, and destructor take care of | |
320 | * registering only _one_ instance of the tracepoints per shared-ojbect | |
321 | * (or for the whole main program). | |
322 | */ | |
1a206094 | 323 | extern struct lttng_ust_tracepoint * const __start___tracepoints_ptrs[] |
558b9d86 | 324 | __attribute__((weak, visibility("hidden"))); |
1a206094 | 325 | extern struct lttng_ust_tracepoint * const __stop___tracepoints_ptrs[] |
558b9d86 MD |
326 | __attribute__((weak, visibility("hidden"))); |
327 | ||
628e1d81 MD |
328 | /* |
329 | * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a | |
330 | * unresolved symbol that requires the provider to be linked in. When | |
331 | * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an | |
332 | * unresolved symbol that depends on having the provider linked in, | |
333 | * otherwise the linker complains. This deals with use of static | |
334 | * libraries, ensuring that the linker does not remove the provider | |
335 | * object from the executable. | |
336 | */ | |
337 | #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE | |
b4f3bc52 | 338 | #define _TRACEPOINT_UNDEFINED_REF(provider) NULL |
628e1d81 | 339 | #else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ |
b4f3bc52 | 340 | #define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider |
628e1d81 MD |
341 | #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ |
342 | ||
b728d87e MD |
343 | /* |
344 | * Note: to allow PIC code, we need to allow the linker to update the pointers | |
345 | * in the __tracepoints_ptrs section. | |
346 | * Therefore, this section is _not_ const (read-only). | |
347 | */ | |
b4f3bc52 MD |
348 | #define _TP_EXTRACT_STRING(...) #__VA_ARGS__ |
349 | ||
350 | #define _DEFINE_TRACEPOINT(_provider, _name, _args) \ | |
351 | extern int __tracepoint_provider_##_provider; \ | |
352 | static const char __tp_strtab_##_provider##___##_name[] \ | |
b728d87e | 353 | __attribute__((section("__tracepoints_strings"))) = \ |
b4f3bc52 | 354 | #_provider ":" #_name; \ |
1a206094 | 355 | struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name \ |
b728d87e | 356 | __attribute__((section("__tracepoints"))) = \ |
b4f3bc52 MD |
357 | { \ |
358 | __tp_strtab_##_provider##___##_name, \ | |
359 | 0, \ | |
360 | NULL, \ | |
361 | _TRACEPOINT_UNDEFINED_REF(_provider), \ | |
362 | _TP_EXTRACT_STRING(_args), \ | |
10e594aa | 363 | { }, \ |
b4f3bc52 | 364 | }; \ |
1a206094 SM |
365 | static struct lttng_ust_tracepoint * \ |
366 | __tracepoint_ptr_##_provider##___##_name \ | |
b728d87e | 367 | __attribute__((used, section("__tracepoints_ptrs"))) = \ |
b4f3bc52 | 368 | &__tracepoint_##_provider##___##_name; |
b728d87e | 369 | |
a8909ba5 | 370 | static void lttng_ust_notrace __attribute__((constructor)) |
46c881a7 | 371 | __tracepoints__ptrs_init(void); |
a8909ba5 | 372 | static void |
46c881a7 | 373 | __tracepoints__ptrs_init(void) |
b728d87e | 374 | { |
46c881a7 | 375 | if (__tracepoint_ptrs_registered++) |
b728d87e | 376 | return; |
46c881a7 MD |
377 | if (!tracepoint_dlopen.liblttngust_handle) |
378 | tracepoint_dlopen.liblttngust_handle = | |
379 | dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL); | |
51920067 | 380 | if (!tracepoint_dlopen.liblttngust_handle) |
deb6e540 | 381 | return; |
99234da6 | 382 | tracepoint_dlopen.tracepoint_register_lib = |
1a206094 | 383 | URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int), |
99234da6 MD |
384 | dlsym(tracepoint_dlopen.liblttngust_handle, |
385 | "tracepoint_register_lib")); | |
386 | tracepoint_dlopen.tracepoint_unregister_lib = | |
1a206094 | 387 | URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *), |
99234da6 MD |
388 | dlsym(tracepoint_dlopen.liblttngust_handle, |
389 | "tracepoint_unregister_lib")); | |
390 | __tracepoint__init_urcu_sym(); | |
391 | if (tracepoint_dlopen.tracepoint_register_lib) { | |
392 | tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs, | |
46c881a7 MD |
393 | __stop___tracepoints_ptrs - |
394 | __start___tracepoints_ptrs); | |
99234da6 | 395 | } |
b728d87e MD |
396 | } |
397 | ||
a8909ba5 | 398 | static void lttng_ust_notrace __attribute__((destructor)) |
46c881a7 | 399 | __tracepoints__ptrs_destroy(void); |
a8909ba5 | 400 | static void |
46c881a7 | 401 | __tracepoints__ptrs_destroy(void) |
b728d87e | 402 | { |
deb6e540 | 403 | int ret; |
51920067 | 404 | |
46c881a7 | 405 | if (--__tracepoint_ptrs_registered) |
b728d87e | 406 | return; |
46c881a7 MD |
407 | if (tracepoint_dlopen.tracepoint_unregister_lib) |
408 | tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs); | |
409 | if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_registered) { | |
51920067 | 410 | ret = dlclose(tracepoint_dlopen.liblttngust_handle); |
76aca78d MD |
411 | if (ret) { |
412 | fprintf(stderr, "Error (%d) in dlclose\n", ret); | |
413 | abort(); | |
414 | } | |
51920067 | 415 | memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen)); |
deb6e540 | 416 | } |
b728d87e MD |
417 | } |
418 | ||
46c881a7 MD |
419 | #else /* TRACEPOINT_DEFINE */ |
420 | ||
421 | #define _DEFINE_TRACEPOINT(_provider, _name, _args) | |
422 | ||
423 | #endif /* #else TRACEPOINT_DEFINE */ | |
deb6e540 | 424 | |
b728d87e MD |
425 | #ifdef __cplusplus |
426 | } | |
427 | #endif | |
428 | ||
429 | #endif /* _LTTNG_TRACEPOINT_H */ | |
430 | ||
431 | /* The following declarations must be outside re-inclusion protection. */ | |
432 | ||
433 | #ifndef TRACEPOINT_EVENT | |
434 | ||
435 | /* | |
436 | * How to use the TRACEPOINT_EVENT macro: | |
437 | * | |
438 | * An example: | |
439 | * | |
440 | * TRACEPOINT_EVENT(someproject_component, event_name, | |
441 | * | |
442 | * * TP_ARGS takes from 0 to 10 "type, field_name" pairs * | |
443 | * | |
444 | * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen, | |
445 | * long *, arg4, size_t, arg4_len), | |
446 | * | |
447 | * * TP_FIELDS describes the event payload layout in the trace * | |
448 | * | |
449 | * TP_FIELDS( | |
450 | * * Integer, printed in base 10 * | |
451 | * ctf_integer(int, field_a, arg0) | |
452 | * | |
453 | * * Integer, printed with 0x base 16 * | |
454 | * ctf_integer_hex(unsigned long, field_d, arg1) | |
455 | * | |
456 | * * Array Sequence, printed as UTF8-encoded array of bytes * | |
457 | * ctf_array_text(char, field_b, string, FIXED_LEN) | |
458 | * ctf_sequence_text(char, field_c, string, size_t, strlen) | |
459 | * | |
460 | * * String, printed as UTF8-encoded string * | |
461 | * ctf_string(field_e, string) | |
462 | * | |
463 | * * Array sequence of signed integer values * | |
464 | * ctf_array(long, field_f, arg4, FIXED_LEN4) | |
465 | * ctf_sequence(long, field_g, arg4, size_t, arg4_len) | |
466 | * ) | |
467 | * ) | |
468 | * | |
469 | * More detailed explanation: | |
470 | * | |
471 | * The name of the tracepoint is expressed as a tuple with the provider | |
472 | * and name arguments. | |
473 | * | |
474 | * The provider and name should be a proper C99 identifier. | |
475 | * The "provider" and "name" MUST follow these rules to ensure no | |
476 | * namespace clash occurs: | |
477 | * | |
478 | * For projects (applications and libraries) for which an entity | |
479 | * specific to the project controls the source code and thus its | |
480 | * tracepoints (typically with a scope larger than a single company): | |
481 | * | |
482 | * either: | |
483 | * project_component, event | |
484 | * or: | |
485 | * project, event | |
486 | * | |
487 | * Where "project" is the name of the project, | |
488 | * "component" is the name of the project component (which may | |
489 | * include several levels of sub-components, e.g. | |
490 | * ...component_subcomponent_...) where the tracepoint is located | |
491 | * (optional), | |
492 | * "event" is the name of the tracepoint event. | |
493 | * | |
494 | * For projects issued from a single company wishing to advertise that | |
495 | * the company controls the source code and thus the tracepoints, the | |
496 | * "com_" prefix should be used: | |
497 | * | |
498 | * either: | |
499 | * com_company_project_component, event | |
500 | * or: | |
501 | * com_company_project, event | |
502 | * | |
503 | * Where "company" is the name of the company, | |
504 | * "project" is the name of the project, | |
505 | * "component" is the name of the project component (which may | |
506 | * include several levels of sub-components, e.g. | |
507 | * ...component_subcomponent_...) where the tracepoint is located | |
508 | * (optional), | |
509 | * "event" is the name of the tracepoint event. | |
510 | * | |
511 | * the provider:event identifier is limited to 127 characters. | |
512 | */ | |
513 | ||
b728d87e | 514 | #define TRACEPOINT_EVENT(provider, name, args, fields) \ |
deb6e540 | 515 | _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \ |
b4f3bc52 | 516 | _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args)) |
b728d87e MD |
517 | |
518 | #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields) | |
519 | ||
520 | #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \ | |
deb6e540 | 521 | _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \ |
b4f3bc52 | 522 | _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args)) |
b728d87e MD |
523 | |
524 | #endif /* #ifndef TRACEPOINT_EVENT */ | |
525 | ||
526 | #ifndef TRACEPOINT_LOGLEVEL | |
527 | ||
528 | /* | |
75c5ad79 | 529 | * Tracepoint Loglevels |
b728d87e MD |
530 | * |
531 | * Typical use of these loglevels: | |
532 | * | |
d8de1354 | 533 | * The loglevels go from 0 to 14. Higher numbers imply the most |
75c5ad79 MD |
534 | * verbosity (higher event throughput expected. |
535 | * | |
d8de1354 MD |
536 | * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels |
537 | * semantic. Loglevels 7 through 13 offer more fine-grained selection of | |
538 | * debug information. | |
75c5ad79 | 539 | * |
d8de1354 | 540 | * TRACE_EMERG 0 |
75c5ad79 MD |
541 | * system is unusable |
542 | * | |
d8de1354 | 543 | * TRACE_ALERT 1 |
75c5ad79 MD |
544 | * action must be taken immediately |
545 | * | |
d8de1354 | 546 | * TRACE_CRIT 2 |
75c5ad79 MD |
547 | * critical conditions |
548 | * | |
d8de1354 | 549 | * TRACE_ERR 3 |
75c5ad79 MD |
550 | * error conditions |
551 | * | |
d8de1354 | 552 | * TRACE_WARNING 4 |
75c5ad79 MD |
553 | * warning conditions |
554 | * | |
d8de1354 | 555 | * TRACE_NOTICE 5 |
75c5ad79 MD |
556 | * normal, but significant, condition |
557 | * | |
d8de1354 | 558 | * TRACE_INFO 6 |
75c5ad79 MD |
559 | * informational message |
560 | * | |
d8de1354 MD |
561 | * TRACE_DEBUG_SYSTEM 7 |
562 | * debug information with system-level scope (set of programs) | |
75c5ad79 | 563 | * |
d8de1354 MD |
564 | * TRACE_DEBUG_PROGRAM 8 |
565 | * debug information with program-level scope (set of processes) | |
75c5ad79 | 566 | * |
d8de1354 MD |
567 | * TRACE_DEBUG_PROCESS 9 |
568 | * debug information with process-level scope (set of modules) | |
75c5ad79 | 569 | * |
d8de1354 MD |
570 | * TRACE_DEBUG_MODULE 10 |
571 | * debug information with module (executable/library) scope (set of units) | |
75c5ad79 | 572 | * |
d8de1354 MD |
573 | * TRACE_DEBUG_UNIT 11 |
574 | * debug information with compilation unit scope (set of functions) | |
75c5ad79 | 575 | * |
d8de1354 MD |
576 | * TRACE_DEBUG_FUNCTION 12 |
577 | * debug information with function-level scope | |
75c5ad79 | 578 | * |
d8de1354 MD |
579 | * TRACE_DEBUG_LINE 13 |
580 | * debug information with line-level scope (TRACEPOINT_EVENT default) | |
902e1379 | 581 | * |
d8de1354 | 582 | * TRACE_DEBUG 14 |
1e3b0059 | 583 | * debug-level message |
75c5ad79 MD |
584 | * |
585 | * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT | |
586 | * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given | |
853cda88 MD |
587 | * tracepoint name. The first field is the provider name, the second |
588 | * field is the name of the tracepoint, the third field is the loglevel | |
589 | * name. | |
b728d87e MD |
590 | * |
591 | * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >, | |
592 | * < loglevel_name >) | |
593 | * | |
75c5ad79 MD |
594 | * The TRACEPOINT_PROVIDER must be already declared before declaring a |
595 | * TRACEPOINT_LOGLEVEL. | |
b728d87e MD |
596 | */ |
597 | ||
882a56d7 | 598 | enum { |
d8de1354 MD |
599 | TRACE_EMERG = 0, |
600 | TRACE_ALERT = 1, | |
601 | TRACE_CRIT = 2, | |
602 | TRACE_ERR = 3, | |
603 | TRACE_WARNING = 4, | |
604 | TRACE_NOTICE = 5, | |
605 | TRACE_INFO = 6, | |
606 | TRACE_DEBUG_SYSTEM = 7, | |
607 | TRACE_DEBUG_PROGRAM = 8, | |
608 | TRACE_DEBUG_PROCESS = 9, | |
609 | TRACE_DEBUG_MODULE = 10, | |
610 | TRACE_DEBUG_UNIT = 11, | |
611 | TRACE_DEBUG_FUNCTION = 12, | |
612 | TRACE_DEBUG_LINE = 13, | |
613 | TRACE_DEBUG = 14, | |
882a56d7 MD |
614 | }; |
615 | ||
05ceaafd | 616 | #define TRACEPOINT_LOGLEVEL(provider, name, loglevel) |
b728d87e MD |
617 | |
618 | #endif /* #ifndef TRACEPOINT_LOGLEVEL */ | |
6ddc916d MD |
619 | |
620 | #ifndef TRACEPOINT_MODEL_EMF_URI | |
621 | ||
622 | #define TRACEPOINT_MODEL_EMF_URI(provider, name, uri) | |
623 | ||
624 | #endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */ |