Commit | Line | Data |
---|---|---|
b728d87e MD |
1 | #ifndef _LTTNG_TRACEPOINT_H |
2 | #define _LTTNG_TRACEPOINT_H | |
3 | ||
4 | /* | |
5 | * Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
6 | * | |
7 | * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED | |
8 | * OR IMPLIED. ANY USE IS AT YOUR OWN RISK. | |
9 | * | |
10 | * Permission is hereby granted to use or copy this program | |
11 | * for any purpose, provided the above notices are retained on all copies. | |
12 | * Permission to modify the code and to distribute modified code is granted, | |
13 | * provided the above notices are retained, and a notice that the code was | |
14 | * modified is included with the above copyright notice. | |
15 | */ | |
16 | ||
8fce9e2b | 17 | #include <lttng/tracepoint-types.h> |
40b2b5a4 | 18 | #include <lttng/tracepoint-rcu.h> |
b728d87e | 19 | #include <urcu/compiler.h> |
deb6e540 | 20 | #include <dlfcn.h> /* for dlopen */ |
51920067 | 21 | #include <string.h> /* for memset */ |
40b2b5a4 | 22 | #include <assert.h> |
b2f60c79 MD |
23 | #include <lttng/ust-config.h> /* for sdt */ |
24 | ||
25 | #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION | |
26 | #define SDT_USE_VARIADIC | |
27 | #include <sys/sdt.h> | |
28 | #else | |
29 | #define STAP_PROBEV(...) | |
30 | #endif | |
b728d87e MD |
31 | |
32 | #ifdef __cplusplus | |
33 | extern "C" { | |
34 | #endif | |
35 | ||
23c8854a MD |
36 | #define tracepoint(provider, name, ...) \ |
37 | do { \ | |
7cb85a18 | 38 | STAP_PROBEV(provider, name, ## __VA_ARGS__); \ |
23c8854a MD |
39 | if (caa_unlikely(__tracepoint_##provider##___##name.state)) \ |
40 | __tracepoint_cb_##provider##___##name(__VA_ARGS__); \ | |
b728d87e MD |
41 | } while (0) |
42 | ||
43 | #define TP_ARGS(...) __VA_ARGS__ | |
44 | ||
45 | /* | |
46 | * TP_ARGS takes tuples of type, argument separated by a comma. | |
47 | * It can take up to 10 tuples (which means that less than 10 tuples is | |
48 | * fine too). | |
49 | * Each tuple is also separated by a comma. | |
50 | */ | |
df854e41 MD |
51 | #define __TP_COMBINE_TOKENS(_tokena, _tokenb) \ |
52 | _tokena##_tokenb | |
53 | #define _TP_COMBINE_TOKENS(_tokena, _tokenb) \ | |
54 | __TP_COMBINE_TOKENS(_tokena, _tokenb) | |
55 | #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \ | |
56 | _tokena##_tokenb##_tokenc | |
57 | #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \ | |
58 | __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) | |
59 | #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ | |
60 | _tokena##_tokenb##_tokenc##_tokend | |
61 | #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ | |
62 | __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) | |
b728d87e | 63 | |
23c8854a | 64 | /* _TP_EXVAR* extract the var names. */ |
b728d87e MD |
65 | #define _TP_EXVAR0() |
66 | #define _TP_EXVAR2(a,b) b | |
67 | #define _TP_EXVAR4(a,b,c,d) b,d | |
68 | #define _TP_EXVAR6(a,b,c,d,e,f) b,d,f | |
69 | #define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h | |
70 | #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j | |
71 | #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l | |
72 | #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n | |
73 | #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 | |
74 | #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 | |
75 | #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 | |
76 | ||
77 | #define _TP_EXDATA_VAR0() __tp_data | |
78 | #define _TP_EXDATA_VAR2(a,b) __tp_data,b | |
79 | #define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d | |
80 | #define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f | |
81 | #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h | |
82 | #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j | |
83 | #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l | |
84 | #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 | |
85 | #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 | |
86 | #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 | |
87 | #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 | |
88 | ||
89 | /* _TP_EXPROTO* extract tuples of type, var */ | |
90 | #define _TP_EXPROTO0() | |
91 | #define _TP_EXPROTO2(a,b) a b | |
92 | #define _TP_EXPROTO4(a,b,c,d) a b,c d | |
93 | #define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f | |
94 | #define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h | |
95 | #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j | |
96 | #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 | |
97 | #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 | |
98 | #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 | |
99 | #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 | |
100 | #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 | |
101 | ||
102 | #define _TP_EXDATA_PROTO0() void *__tp_data | |
103 | #define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b | |
104 | #define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d | |
105 | #define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f | |
106 | #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h | |
107 | #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 | |
108 | #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 | |
109 | #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 | |
110 | #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 | |
111 | #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 | |
112 | #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 | |
113 | ||
114 | /* Preprocessor trick to count arguments. Inspired from sdt.h. */ | |
115 | #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) | |
116 | #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 |
117 | #define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__)) |
118 | #define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__)) | |
119 | #define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__)) | |
120 | #define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__)) | |
b728d87e | 121 | #define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
23c8854a | 122 | #define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
b728d87e | 123 | #define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
23c8854a | 124 | #define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) |
b728d87e MD |
125 | #define _TP_PARAMS(...) __VA_ARGS__ |
126 | ||
0f2f7e21 MD |
127 | #define _DECLARE_TRACEPOINT(_provider, _name, ...) \ |
128 | extern struct tracepoint __tracepoint_##_provider##___##_name; \ | |
129 | static inline void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \ | |
b728d87e MD |
130 | { \ |
131 | struct tracepoint_probe *__tp_probe; \ | |
132 | \ | |
40b2b5a4 | 133 | if (!TP_RCU_LINK_TEST()) \ |
deb6e540 | 134 | return; \ |
40b2b5a4 | 135 | tp_rcu_read_lock_bp(); \ |
0f2f7e21 | 136 | __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \ |
23c8854a | 137 | if (caa_unlikely(!__tp_probe)) \ |
b728d87e MD |
138 | goto end; \ |
139 | do { \ | |
23c8854a MD |
140 | void *__tp_cb = __tp_probe->func; \ |
141 | void *__tp_data = __tp_probe->data; \ | |
b728d87e | 142 | \ |
23c8854a MD |
143 | URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \ |
144 | (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \ | |
145 | } while ((++__tp_probe)->func); \ | |
b728d87e | 146 | end: \ |
40b2b5a4 | 147 | tp_rcu_read_unlock_bp(); \ |
b728d87e | 148 | } \ |
0f2f7e21 | 149 | static inline void __tracepoint_register_##_provider##___##_name(char *name, \ |
23c8854a | 150 | void *func, void *data) \ |
b728d87e | 151 | { \ |
23c8854a | 152 | __tracepoint_probe_register(name, func, data); \ |
b728d87e | 153 | } \ |
0f2f7e21 | 154 | static inline void __tracepoint_unregister_##_provider##___##_name(char *name, \ |
23c8854a | 155 | void *func, void *data) \ |
b728d87e | 156 | { \ |
23c8854a | 157 | __tracepoint_probe_unregister(name, func, data); \ |
b728d87e MD |
158 | } |
159 | ||
deb6e540 MD |
160 | extern int __tracepoint_probe_register(const char *name, void *func, void *data); |
161 | extern int __tracepoint_probe_unregister(const char *name, void *func, void *data); | |
162 | ||
51920067 MD |
163 | /* |
164 | * tracepoint dynamic linkage handling (callbacks). Hidden visibility: | |
165 | * shared across objects in a module/main executable. | |
166 | */ | |
167 | struct tracepoint_dlopen { | |
168 | void *liblttngust_handle; | |
169 | ||
170 | int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start, | |
171 | int tracepoints_count); | |
172 | int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start); | |
173 | #ifndef _LGPL_SOURCE | |
174 | void (*rcu_read_lock_sym_bp)(void); | |
175 | void (*rcu_read_unlock_sym_bp)(void); | |
176 | void *(*rcu_dereference_sym_bp)(void *p); | |
177 | #endif | |
178 | }; | |
179 | ||
180 | extern struct tracepoint_dlopen tracepoint_dlopen; | |
181 | ||
deb6e540 MD |
182 | #ifdef TRACEPOINT_DEFINE |
183 | ||
628e1d81 MD |
184 | /* |
185 | * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a | |
186 | * unresolved symbol that requires the provider to be linked in. When | |
187 | * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an | |
188 | * unresolved symbol that depends on having the provider linked in, | |
189 | * otherwise the linker complains. This deals with use of static | |
190 | * libraries, ensuring that the linker does not remove the provider | |
191 | * object from the executable. | |
192 | */ | |
193 | #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE | |
194 | #define _TRACEPOINT_UNDEFINED_REF(provider) | |
195 | #else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ | |
196 | #define _TRACEPOINT_UNDEFINED_REF(provider) \ | |
197 | &__tracepoint_provider_##provider, | |
198 | #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ | |
199 | ||
b728d87e MD |
200 | /* |
201 | * Note: to allow PIC code, we need to allow the linker to update the pointers | |
202 | * in the __tracepoints_ptrs section. | |
203 | * Therefore, this section is _not_ const (read-only). | |
204 | */ | |
205 | #define _DEFINE_TRACEPOINT(provider, name) \ | |
628e1d81 | 206 | extern int __tracepoint_provider_##provider; \ |
b728d87e MD |
207 | static const char __tp_strtab_##provider##___##name[] \ |
208 | __attribute__((section("__tracepoints_strings"))) = \ | |
209 | #provider ":" #name; \ | |
210 | struct tracepoint __tracepoint_##provider##___##name \ | |
211 | __attribute__((section("__tracepoints"))) = \ | |
628e1d81 | 212 | { __tp_strtab_##provider##___##name, 0, NULL, _TRACEPOINT_UNDEFINED_REF(provider) }; \ |
b728d87e MD |
213 | static struct tracepoint * __tracepoint_ptr_##provider##___##name \ |
214 | __attribute__((used, section("__tracepoints_ptrs"))) = \ | |
215 | &__tracepoint_##provider##___##name; | |
216 | ||
b728d87e MD |
217 | /* |
218 | * These weak symbols, the constructor, and destructor take care of | |
219 | * registering only _one_ instance of the tracepoints per shared-ojbect | |
220 | * (or for the whole main program). | |
221 | */ | |
222 | extern struct tracepoint * const __start___tracepoints_ptrs[] | |
223 | __attribute__((weak, visibility("hidden"))); | |
224 | extern struct tracepoint * const __stop___tracepoints_ptrs[] | |
225 | __attribute__((weak, visibility("hidden"))); | |
226 | int __tracepoint_registered | |
227 | __attribute__((weak, visibility("hidden"))); | |
51920067 MD |
228 | struct tracepoint_dlopen tracepoint_dlopen |
229 | __attribute__((weak, visibility("hidden"))); | |
b728d87e MD |
230 | |
231 | static void __attribute__((constructor)) __tracepoints__init(void) | |
232 | { | |
233 | if (__tracepoint_registered++) | |
234 | return; | |
deb6e540 | 235 | |
51920067 MD |
236 | tracepoint_dlopen.liblttngust_handle = |
237 | dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL); | |
238 | if (!tracepoint_dlopen.liblttngust_handle) | |
deb6e540 | 239 | return; |
51920067 | 240 | tracepoint_dlopen.tracepoint_register_lib = |
93ffe366 | 241 | URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int), |
51920067 | 242 | dlsym(tracepoint_dlopen.liblttngust_handle, |
93ffe366 | 243 | "tracepoint_register_lib")); |
51920067 | 244 | tracepoint_dlopen.tracepoint_unregister_lib = |
93ffe366 | 245 | URCU_FORCE_CAST(int (*)(struct tracepoint * const *), |
51920067 | 246 | dlsym(tracepoint_dlopen.liblttngust_handle, |
93ffe366 | 247 | "tracepoint_unregister_lib")); |
40b2b5a4 | 248 | #ifndef _LGPL_SOURCE |
51920067 | 249 | tracepoint_dlopen.rcu_read_lock_sym_bp = |
40b2b5a4 | 250 | URCU_FORCE_CAST(void (*)(void), |
51920067 | 251 | dlsym(tracepoint_dlopen.liblttngust_handle, |
40b2b5a4 | 252 | "tp_rcu_read_lock_bp")); |
51920067 | 253 | tracepoint_dlopen.rcu_read_unlock_sym_bp = |
40b2b5a4 | 254 | URCU_FORCE_CAST(void (*)(void), |
51920067 | 255 | dlsym(tracepoint_dlopen.liblttngust_handle, |
40b2b5a4 | 256 | "tp_rcu_read_unlock_bp")); |
51920067 | 257 | tracepoint_dlopen.rcu_dereference_sym_bp = |
40b2b5a4 | 258 | URCU_FORCE_CAST(void *(*)(void *p), |
51920067 | 259 | dlsym(tracepoint_dlopen.liblttngust_handle, |
40b2b5a4 MD |
260 | "tp_rcu_dereference_sym_bp")); |
261 | #endif | |
51920067 | 262 | tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs, |
b728d87e MD |
263 | __stop___tracepoints_ptrs - |
264 | __start___tracepoints_ptrs); | |
265 | } | |
266 | ||
267 | static void __attribute__((destructor)) __tracepoints__destroy(void) | |
268 | { | |
deb6e540 | 269 | int ret; |
51920067 | 270 | |
b728d87e MD |
271 | if (--__tracepoint_registered) |
272 | return; | |
51920067 MD |
273 | if (tracepoint_dlopen.tracepoint_unregister_lib) |
274 | tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs); | |
275 | if (tracepoint_dlopen.liblttngust_handle) { | |
276 | ret = dlclose(tracepoint_dlopen.liblttngust_handle); | |
deb6e540 | 277 | assert(!ret); |
51920067 | 278 | memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen)); |
deb6e540 | 279 | } |
b728d87e MD |
280 | } |
281 | ||
deb6e540 MD |
282 | #else /* TRACEPOINT_DEFINE */ |
283 | ||
284 | #define _DEFINE_TRACEPOINT(provider, name) | |
285 | ||
286 | #endif /* #else TRACEPOINT_DEFINE */ | |
287 | ||
b728d87e MD |
288 | #ifdef __cplusplus |
289 | } | |
290 | #endif | |
291 | ||
292 | #endif /* _LTTNG_TRACEPOINT_H */ | |
293 | ||
294 | /* The following declarations must be outside re-inclusion protection. */ | |
295 | ||
296 | #ifndef TRACEPOINT_EVENT | |
297 | ||
298 | /* | |
299 | * How to use the TRACEPOINT_EVENT macro: | |
300 | * | |
301 | * An example: | |
302 | * | |
303 | * TRACEPOINT_EVENT(someproject_component, event_name, | |
304 | * | |
305 | * * TP_ARGS takes from 0 to 10 "type, field_name" pairs * | |
306 | * | |
307 | * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen, | |
308 | * long *, arg4, size_t, arg4_len), | |
309 | * | |
310 | * * TP_FIELDS describes the event payload layout in the trace * | |
311 | * | |
312 | * TP_FIELDS( | |
313 | * * Integer, printed in base 10 * | |
314 | * ctf_integer(int, field_a, arg0) | |
315 | * | |
316 | * * Integer, printed with 0x base 16 * | |
317 | * ctf_integer_hex(unsigned long, field_d, arg1) | |
318 | * | |
319 | * * Array Sequence, printed as UTF8-encoded array of bytes * | |
320 | * ctf_array_text(char, field_b, string, FIXED_LEN) | |
321 | * ctf_sequence_text(char, field_c, string, size_t, strlen) | |
322 | * | |
323 | * * String, printed as UTF8-encoded string * | |
324 | * ctf_string(field_e, string) | |
325 | * | |
326 | * * Array sequence of signed integer values * | |
327 | * ctf_array(long, field_f, arg4, FIXED_LEN4) | |
328 | * ctf_sequence(long, field_g, arg4, size_t, arg4_len) | |
329 | * ) | |
330 | * ) | |
331 | * | |
332 | * More detailed explanation: | |
333 | * | |
334 | * The name of the tracepoint is expressed as a tuple with the provider | |
335 | * and name arguments. | |
336 | * | |
337 | * The provider and name should be a proper C99 identifier. | |
338 | * The "provider" and "name" MUST follow these rules to ensure no | |
339 | * namespace clash occurs: | |
340 | * | |
341 | * For projects (applications and libraries) for which an entity | |
342 | * specific to the project controls the source code and thus its | |
343 | * tracepoints (typically with a scope larger than a single company): | |
344 | * | |
345 | * either: | |
346 | * project_component, event | |
347 | * or: | |
348 | * project, event | |
349 | * | |
350 | * Where "project" is the name of the project, | |
351 | * "component" is the name of the project component (which may | |
352 | * include several levels of sub-components, e.g. | |
353 | * ...component_subcomponent_...) where the tracepoint is located | |
354 | * (optional), | |
355 | * "event" is the name of the tracepoint event. | |
356 | * | |
357 | * For projects issued from a single company wishing to advertise that | |
358 | * the company controls the source code and thus the tracepoints, the | |
359 | * "com_" prefix should be used: | |
360 | * | |
361 | * either: | |
362 | * com_company_project_component, event | |
363 | * or: | |
364 | * com_company_project, event | |
365 | * | |
366 | * Where "company" is the name of the company, | |
367 | * "project" is the name of the project, | |
368 | * "component" is the name of the project component (which may | |
369 | * include several levels of sub-components, e.g. | |
370 | * ...component_subcomponent_...) where the tracepoint is located | |
371 | * (optional), | |
372 | * "event" is the name of the tracepoint event. | |
373 | * | |
374 | * the provider:event identifier is limited to 127 characters. | |
375 | */ | |
376 | ||
b728d87e | 377 | #define TRACEPOINT_EVENT(provider, name, args, fields) \ |
deb6e540 MD |
378 | _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \ |
379 | _DEFINE_TRACEPOINT(provider, name) | |
b728d87e MD |
380 | |
381 | #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields) | |
382 | ||
383 | #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \ | |
deb6e540 MD |
384 | _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \ |
385 | _DEFINE_TRACEPOINT(provider, name) | |
b728d87e MD |
386 | |
387 | #endif /* #ifndef TRACEPOINT_EVENT */ | |
388 | ||
389 | #ifndef TRACEPOINT_LOGLEVEL | |
390 | ||
391 | /* | |
75c5ad79 | 392 | * Tracepoint Loglevels |
b728d87e MD |
393 | * |
394 | * Typical use of these loglevels: | |
395 | * | |
d8de1354 | 396 | * The loglevels go from 0 to 14. Higher numbers imply the most |
75c5ad79 MD |
397 | * verbosity (higher event throughput expected. |
398 | * | |
d8de1354 MD |
399 | * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels |
400 | * semantic. Loglevels 7 through 13 offer more fine-grained selection of | |
401 | * debug information. | |
75c5ad79 | 402 | * |
d8de1354 | 403 | * TRACE_EMERG 0 |
75c5ad79 MD |
404 | * system is unusable |
405 | * | |
d8de1354 | 406 | * TRACE_ALERT 1 |
75c5ad79 MD |
407 | * action must be taken immediately |
408 | * | |
d8de1354 | 409 | * TRACE_CRIT 2 |
75c5ad79 MD |
410 | * critical conditions |
411 | * | |
d8de1354 | 412 | * TRACE_ERR 3 |
75c5ad79 MD |
413 | * error conditions |
414 | * | |
d8de1354 | 415 | * TRACE_WARNING 4 |
75c5ad79 MD |
416 | * warning conditions |
417 | * | |
d8de1354 | 418 | * TRACE_NOTICE 5 |
75c5ad79 MD |
419 | * normal, but significant, condition |
420 | * | |
d8de1354 | 421 | * TRACE_INFO 6 |
75c5ad79 MD |
422 | * informational message |
423 | * | |
d8de1354 MD |
424 | * TRACE_DEBUG_SYSTEM 7 |
425 | * debug information with system-level scope (set of programs) | |
75c5ad79 | 426 | * |
d8de1354 MD |
427 | * TRACE_DEBUG_PROGRAM 8 |
428 | * debug information with program-level scope (set of processes) | |
75c5ad79 | 429 | * |
d8de1354 MD |
430 | * TRACE_DEBUG_PROCESS 9 |
431 | * debug information with process-level scope (set of modules) | |
75c5ad79 | 432 | * |
d8de1354 MD |
433 | * TRACE_DEBUG_MODULE 10 |
434 | * debug information with module (executable/library) scope (set of units) | |
75c5ad79 | 435 | * |
d8de1354 MD |
436 | * TRACE_DEBUG_UNIT 11 |
437 | * debug information with compilation unit scope (set of functions) | |
75c5ad79 | 438 | * |
d8de1354 MD |
439 | * TRACE_DEBUG_FUNCTION 12 |
440 | * debug information with function-level scope | |
75c5ad79 | 441 | * |
d8de1354 MD |
442 | * TRACE_DEBUG_LINE 13 |
443 | * debug information with line-level scope (TRACEPOINT_EVENT default) | |
902e1379 | 444 | * |
d8de1354 | 445 | * TRACE_DEBUG 14 |
902e1379 | 446 | * debug-level message (trace_printf default) |
75c5ad79 MD |
447 | * |
448 | * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT | |
449 | * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given | |
853cda88 MD |
450 | * tracepoint name. The first field is the provider name, the second |
451 | * field is the name of the tracepoint, the third field is the loglevel | |
452 | * name. | |
b728d87e MD |
453 | * |
454 | * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >, | |
455 | * < loglevel_name >) | |
456 | * | |
75c5ad79 MD |
457 | * The TRACEPOINT_PROVIDER must be already declared before declaring a |
458 | * TRACEPOINT_LOGLEVEL. | |
b728d87e MD |
459 | */ |
460 | ||
882a56d7 | 461 | enum { |
d8de1354 MD |
462 | TRACE_EMERG = 0, |
463 | TRACE_ALERT = 1, | |
464 | TRACE_CRIT = 2, | |
465 | TRACE_ERR = 3, | |
466 | TRACE_WARNING = 4, | |
467 | TRACE_NOTICE = 5, | |
468 | TRACE_INFO = 6, | |
469 | TRACE_DEBUG_SYSTEM = 7, | |
470 | TRACE_DEBUG_PROGRAM = 8, | |
471 | TRACE_DEBUG_PROCESS = 9, | |
472 | TRACE_DEBUG_MODULE = 10, | |
473 | TRACE_DEBUG_UNIT = 11, | |
474 | TRACE_DEBUG_FUNCTION = 12, | |
475 | TRACE_DEBUG_LINE = 13, | |
476 | TRACE_DEBUG = 14, | |
882a56d7 MD |
477 | }; |
478 | ||
05ceaafd | 479 | #define TRACEPOINT_LOGLEVEL(provider, name, loglevel) |
b728d87e MD |
480 | |
481 | #endif /* #ifndef TRACEPOINT_LOGLEVEL */ |