projects / lttng-ust.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
callsite: move after the call
[lttng-ust.git] / include / lttng / tracepoint.h
... / ...
CommitLineData
1#ifndef _LTTNG_TRACEPOINT_H
2#define _LTTNG_TRACEPOINT_H
3
4/*
5 * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 */
17
18#include <lttng/tracepoint-types.h>
19#include <lttng/tracepoint-rcu.h>
20#include <urcu/compiler.h>
21#include <dlfcn.h> /* for dlopen */
22#include <string.h> /* for memset */
23#include <assert.h>
24#include <lttng/ust-config.h> /* for sdt */
25#include <lttng/ust-compiler.h>
26
27#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
28#define SDT_USE_VARIADIC
29#include <sys/sdt.h>
30#else
31#define STAP_PROBEV(...)
32#endif
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38#define tracepoint(provider, name, ...) \
39 do { \
40 STAP_PROBEV(provider, name, ## __VA_ARGS__); \
41 if (caa_unlikely(__tracepoint_##provider##___##name.state)) { \
42 __tracepoint_cb_##provider##___##name(__VA_ARGS__); \
43 TRACEPOINT_CALLSITE(provider, name); \
44 } \
45 } while (0)
46
47#define TP_ARGS(...) __VA_ARGS__
48
49/*
50 * TP_ARGS takes tuples of type, argument separated by a comma.
51 * It can take up to 10 tuples (which means that less than 10 tuples is
52 * fine too).
53 * Each tuple is also separated by a comma.
54 */
55#define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
56 _tokena##_tokenb
57#define _TP_COMBINE_TOKENS(_tokena, _tokenb) \
58 __TP_COMBINE_TOKENS(_tokena, _tokenb)
59#define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
60 _tokena##_tokenb##_tokenc
61#define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
62 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
63#define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
64 _tokena##_tokenb##_tokenc##_tokend
65#define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
66 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
67
68/*
69 * _TP_EXVAR* extract the var names.
70 * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
71 */
72#define _TP_EXVAR0()
73#define _TP_EXVAR1(a)
74#define _TP_EXVAR2(a,b) b
75#define _TP_EXVAR4(a,b,c,d) b,d
76#define _TP_EXVAR6(a,b,c,d,e,f) b,d,f
77#define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
78#define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
79#define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
80#define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
81#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
82#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
83#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
84
85#define _TP_EXDATA_VAR0() __tp_data
86#define _TP_EXDATA_VAR1(a) __tp_data
87#define _TP_EXDATA_VAR2(a,b) __tp_data,b
88#define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
89#define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
90#define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
91#define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
92#define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
93#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
94#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
95#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
96#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
97
98/*
99 * _TP_EXPROTO* extract tuples of type, var.
100 * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
101 */
102#define _TP_EXPROTO0() void
103#define _TP_EXPROTO1(a) void
104#define _TP_EXPROTO2(a,b) a b
105#define _TP_EXPROTO4(a,b,c,d) a b,c d
106#define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
107#define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
108#define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
109#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
110#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
111#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
112#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
113#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
114
115#define _TP_EXDATA_PROTO0() void *__tp_data
116#define _TP_EXDATA_PROTO1(a) void *__tp_data
117#define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
118#define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
119#define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
120#define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
121#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
122#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
123#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
124#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
125#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
126#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
127
128/* Preprocessor trick to count arguments. Inspired from sdt.h. */
129#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)
130#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
131#define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
132#define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
133#define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
134#define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
135#define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
136#define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
137#define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
138#define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
139#define _TP_PARAMS(...) __VA_ARGS__
140
141#define _DECLARE_TRACEPOINT(_provider, _name, ...) \
142extern struct tracepoint __tracepoint_##_provider##___##_name; \
143static inline lttng_ust_notrace \
144void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \
145static inline \
146void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \
147{ \
148 struct tracepoint_probe *__tp_probe; \
149 \
150 if (!TP_RCU_LINK_TEST()) \
151 return; \
152 tp_rcu_read_lock_bp(); \
153 __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
154 if (caa_unlikely(!__tp_probe)) \
155 goto end; \
156 do { \
157 void (*__tp_cb)(void) = __tp_probe->func; \
158 void *__tp_data = __tp_probe->data; \
159 \
160 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
161 (_TP_ARGS_DATA_VAR(__VA_ARGS__)); \
162 } while ((++__tp_probe)->func); \
163end: \
164 tp_rcu_read_unlock_bp(); \
165} \
166static inline lttng_ust_notrace \
167void __tracepoint_register_##_provider##___##_name(char *name, \
168 void (*func)(void), void *data); \
169static inline \
170void __tracepoint_register_##_provider##___##_name(char *name, \
171 void (*func)(void), void *data) \
172{ \
173 __tracepoint_probe_register(name, func, data, \
174 __tracepoint_##_provider##___##_name.signature); \
175} \
176static inline lttng_ust_notrace \
177void __tracepoint_unregister_##_provider##___##_name(char *name, \
178 void (*func)(void), void *data); \
179static inline \
180void __tracepoint_unregister_##_provider##___##_name(char *name, \
181 void (*func)(void), void *data) \
182{ \
183 __tracepoint_probe_unregister(name, func, data); \
184}
185
186extern int __tracepoint_probe_register(const char *name, void (*func)(void),
187 void *data, const char *signature);
188extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
189 void *data);
190
191/*
192 * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
193 * shared across objects in a module/main executable.
194 */
195struct tracepoint_dlopen {
196 void *liblttngust_handle;
197
198 int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start,
199 int tracepoints_count);
200 int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start);
201#ifndef _LGPL_SOURCE
202 void (*rcu_read_lock_sym_bp)(void);
203 void (*rcu_read_unlock_sym_bp)(void);
204 void *(*rcu_dereference_sym_bp)(void *p);
205#endif
206};
207
208extern struct tracepoint_dlopen tracepoint_dlopen;
209
210struct tracepoint_callsite_dlopen {
211 void *liblttngust_handle;
212
213 int (*tracepoint_register_lib_callsite)(struct tracepoint_callsite * const *tp_start,
214 int tp_count);
215 int (*tracepoint_unregister_lib_callsite)(struct tracepoint_callsite * const *tp_start,
216 int tp_count);
217};
218
219struct tracepoint_callsite_dlopen tracepoint_callsite_dlopen
220 __attribute__((weak, visibility("hidden")));
221int __tracepoint_callsite_registered
222 __attribute__((weak, visibility("hidden")));
223
224#if (CAA_BITS_PER_LONG == 64)
225#define __TP_ASM_PTR ".quad "
226#else
227#define __TP_ASM_PTR ".long "
228#endif
229
230/*
231 * Note: to allow PIC code, we need to allow the linker to update the pointers
232 * in the __tracepoints_callsite_ptrs section.
233 * Therefore, this section is _not_ const (read-only).
234 */
235#define TRACEPOINT_CALLSITE(_provider, _name) \
236do { \
237 asm volatile ( ".pushsection __tracepoint_callsite, \"aw\"\n\t" \
238 "1:\n\t" \
239 __TP_ASM_PTR "%c0, %c1, %c2, 2f\n\t" \
240 ".int %c3\n\t" \
241 ".space 16\n\t" /* padding */ \
242 ".popsection\n\t" \
243 ".pushsection __tracepoint_callsite_ptrs, \"aw\"\n\t" \
244 __TP_ASM_PTR "1b\n\t" \
245 ".popsection\n\t" \
246 "2:\n\t" \
247 : : "i" (#_provider ":" #_name), \
248 "i" (__func__), \
249 "i" (__FILE__), \
250 "i" (__LINE__)); \
251} while (0)
252
253/*
254 * These weak symbols, the constructor, and destructor take care of
255 * registering only _one_ instance of the tracepoint callsite per
256 * shared-ojbect (or for the whole main program).
257 */
258extern struct tracepoint_callsite * const __start___tracepoint_callsite_ptrs[]
259 __attribute__((weak, visibility("hidden")));
260extern struct tracepoint_callsite * const __stop___tracepoint_callsite_ptrs[]
261 __attribute__((weak, visibility("hidden")));
262
263/*
264 * We need at least one pointer in the section.
265 */
266static struct tracepoint_callsite *
267 __tracepoint_callsite_ptr_dummy
268 __attribute__((used, section("__tracepoint_callsite_ptrs"))) =
269 NULL;
270
271static void lttng_ust_notrace __attribute__((constructor))
272__tracepoint_callsite__init(void);
273static void
274__tracepoint_callsite__init(void)
275{
276 if (__tracepoint_callsite_registered++)
277 return;
278
279 tracepoint_callsite_dlopen.liblttngust_handle =
280 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
281 if (!tracepoint_callsite_dlopen.liblttngust_handle)
282 return;
283 tracepoint_callsite_dlopen.tracepoint_register_lib_callsite =
284 URCU_FORCE_CAST(int (*)(struct tracepoint_callsite * const *, int),
285 dlsym(tracepoint_callsite_dlopen.liblttngust_handle,
286 "tracepoint_register_lib_callsite"));
287 tracepoint_callsite_dlopen.tracepoint_unregister_lib_callsite =
288 URCU_FORCE_CAST(int (*)(struct tracepoint_callsite * const *, int),
289 dlsym(tracepoint_callsite_dlopen.liblttngust_handle,
290 "tracepoint_unregister_lib_callsite"));
291 tracepoint_callsite_dlopen.tracepoint_register_lib_callsite(__start___tracepoint_callsite_ptrs,
292 __stop___tracepoint_callsite_ptrs -
293 __start___tracepoint_callsite_ptrs);
294}
295
296static void lttng_ust_notrace __attribute__((destructor))
297__tracepoint_callsite__destroy(void);
298static void
299__tracepoint_callsite__destroy(void)
300{
301 int ret;
302
303 if (--__tracepoint_callsite_registered)
304 return;
305 if (tracepoint_callsite_dlopen.tracepoint_unregister_lib_callsite)
306 tracepoint_callsite_dlopen.tracepoint_unregister_lib_callsite(__start___tracepoint_callsite_ptrs,
307 __stop___tracepoint_callsite_ptrs -
308 __start___tracepoint_callsite_ptrs);
309 if (tracepoint_callsite_dlopen.liblttngust_handle) {
310 ret = dlclose(tracepoint_callsite_dlopen.liblttngust_handle);
311 assert(!ret);
312 memset(&tracepoint_callsite_dlopen, 0, sizeof(tracepoint_callsite_dlopen));
313 }
314}
315
316#ifdef TRACEPOINT_DEFINE
317
318/*
319 * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
320 * unresolved symbol that requires the provider to be linked in. When
321 * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
322 * unresolved symbol that depends on having the provider linked in,
323 * otherwise the linker complains. This deals with use of static
324 * libraries, ensuring that the linker does not remove the provider
325 * object from the executable.
326 */
327#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
328#define _TRACEPOINT_UNDEFINED_REF(provider) NULL
329#else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
330#define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider
331#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
332
333/*
334 * Note: to allow PIC code, we need to allow the linker to update the pointers
335 * in the __tracepoints_ptrs section.
336 * Therefore, this section is _not_ const (read-only).
337 */
338#define _TP_EXTRACT_STRING(...) #__VA_ARGS__
339
340#define _DEFINE_TRACEPOINT(_provider, _name, _args) \
341 extern int __tracepoint_provider_##_provider; \
342 static const char __tp_strtab_##_provider##___##_name[] \
343 __attribute__((section("__tracepoints_strings"))) = \
344 #_provider ":" #_name; \
345 struct tracepoint __tracepoint_##_provider##___##_name \
346 __attribute__((section("__tracepoints"))) = \
347 { \
348 __tp_strtab_##_provider##___##_name, \
349 0, \
350 NULL, \
351 _TRACEPOINT_UNDEFINED_REF(_provider), \
352 _TP_EXTRACT_STRING(_args), \
353 }; \
354 static struct tracepoint * __tracepoint_ptr_##_provider##___##_name \
355 __attribute__((used, section("__tracepoints_ptrs"))) = \
356 &__tracepoint_##_provider##___##_name;
357
358/*
359 * These weak symbols, the constructor, and destructor take care of
360 * registering only _one_ instance of the tracepoints per shared-ojbect
361 * (or for the whole main program).
362 */
363extern struct tracepoint * const __start___tracepoints_ptrs[]
364 __attribute__((weak, visibility("hidden")));
365extern struct tracepoint * const __stop___tracepoints_ptrs[]
366 __attribute__((weak, visibility("hidden")));
367int __tracepoint_registered
368 __attribute__((weak, visibility("hidden")));
369struct tracepoint_dlopen tracepoint_dlopen
370 __attribute__((weak, visibility("hidden")));
371
372static void lttng_ust_notrace __attribute__((constructor))
373__tracepoints__init(void);
374static void
375__tracepoints__init(void)
376{
377 if (__tracepoint_registered++)
378 return;
379
380 tracepoint_dlopen.liblttngust_handle =
381 dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
382 if (!tracepoint_dlopen.liblttngust_handle)
383 return;
384 tracepoint_dlopen.tracepoint_register_lib =
385 URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int),
386 dlsym(tracepoint_dlopen.liblttngust_handle,
387 "tracepoint_register_lib"));
388 tracepoint_dlopen.tracepoint_unregister_lib =
389 URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
390 dlsym(tracepoint_dlopen.liblttngust_handle,
391 "tracepoint_unregister_lib"));
392#ifndef _LGPL_SOURCE
393 tracepoint_dlopen.rcu_read_lock_sym_bp =
394 URCU_FORCE_CAST(void (*)(void),
395 dlsym(tracepoint_dlopen.liblttngust_handle,
396 "tp_rcu_read_lock_bp"));
397 tracepoint_dlopen.rcu_read_unlock_sym_bp =
398 URCU_FORCE_CAST(void (*)(void),
399 dlsym(tracepoint_dlopen.liblttngust_handle,
400 "tp_rcu_read_unlock_bp"));
401 tracepoint_dlopen.rcu_dereference_sym_bp =
402 URCU_FORCE_CAST(void *(*)(void *p),
403 dlsym(tracepoint_dlopen.liblttngust_handle,
404 "tp_rcu_dereference_sym_bp"));
405#endif
406 tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs,
407 __stop___tracepoints_ptrs -
408 __start___tracepoints_ptrs);
409}
410
411static void lttng_ust_notrace __attribute__((destructor))
412__tracepoints__destroy(void);
413static void
414__tracepoints__destroy(void)
415{
416 int ret;
417
418 if (--__tracepoint_registered)
419 return;
420 if (tracepoint_dlopen.tracepoint_unregister_lib)
421 tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs);
422 if (tracepoint_dlopen.liblttngust_handle) {
423 ret = dlclose(tracepoint_dlopen.liblttngust_handle);
424 assert(!ret);
425 memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
426 }
427}
428
429#else /* TRACEPOINT_DEFINE */
430
431#define _DEFINE_TRACEPOINT(_provider, _name, _args)
432
433#endif /* #else TRACEPOINT_DEFINE */
434
435#ifdef __cplusplus
436}
437#endif
438
439#endif /* _LTTNG_TRACEPOINT_H */
440
441/* The following declarations must be outside re-inclusion protection. */
442
443#ifndef TRACEPOINT_EVENT
444
445/*
446 * How to use the TRACEPOINT_EVENT macro:
447 *
448 * An example:
449 *
450 * TRACEPOINT_EVENT(someproject_component, event_name,
451 *
452 * * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
453 *
454 * TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
455 * long *, arg4, size_t, arg4_len),
456 *
457 * * TP_FIELDS describes the event payload layout in the trace *
458 *
459 * TP_FIELDS(
460 * * Integer, printed in base 10 *
461 * ctf_integer(int, field_a, arg0)
462 *
463 * * Integer, printed with 0x base 16 *
464 * ctf_integer_hex(unsigned long, field_d, arg1)
465 *
466 * * Array Sequence, printed as UTF8-encoded array of bytes *
467 * ctf_array_text(char, field_b, string, FIXED_LEN)
468 * ctf_sequence_text(char, field_c, string, size_t, strlen)
469 *
470 * * String, printed as UTF8-encoded string *
471 * ctf_string(field_e, string)
472 *
473 * * Array sequence of signed integer values *
474 * ctf_array(long, field_f, arg4, FIXED_LEN4)
475 * ctf_sequence(long, field_g, arg4, size_t, arg4_len)
476 * )
477 * )
478 *
479 * More detailed explanation:
480 *
481 * The name of the tracepoint is expressed as a tuple with the provider
482 * and name arguments.
483 *
484 * The provider and name should be a proper C99 identifier.
485 * The "provider" and "name" MUST follow these rules to ensure no
486 * namespace clash occurs:
487 *
488 * For projects (applications and libraries) for which an entity
489 * specific to the project controls the source code and thus its
490 * tracepoints (typically with a scope larger than a single company):
491 *
492 * either:
493 * project_component, event
494 * or:
495 * project, event
496 *
497 * Where "project" is the name of the project,
498 * "component" is the name of the project component (which may
499 * include several levels of sub-components, e.g.
500 * ...component_subcomponent_...) where the tracepoint is located
501 * (optional),
502 * "event" is the name of the tracepoint event.
503 *
504 * For projects issued from a single company wishing to advertise that
505 * the company controls the source code and thus the tracepoints, the
506 * "com_" prefix should be used:
507 *
508 * either:
509 * com_company_project_component, event
510 * or:
511 * com_company_project, event
512 *
513 * Where "company" is the name of the company,
514 * "project" is the name of the project,
515 * "component" is the name of the project component (which may
516 * include several levels of sub-components, e.g.
517 * ...component_subcomponent_...) where the tracepoint is located
518 * (optional),
519 * "event" is the name of the tracepoint event.
520 *
521 * the provider:event identifier is limited to 127 characters.
522 */
523
524#define TRACEPOINT_EVENT(provider, name, args, fields) \
525 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
526 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
527
528#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
529
530#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
531 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
532 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
533
534#endif /* #ifndef TRACEPOINT_EVENT */
535
536#ifndef TRACEPOINT_LOGLEVEL
537
538/*
539 * Tracepoint Loglevels
540 *
541 * Typical use of these loglevels:
542 *
543 * The loglevels go from 0 to 14. Higher numbers imply the most
544 * verbosity (higher event throughput expected.
545 *
546 * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
547 * semantic. Loglevels 7 through 13 offer more fine-grained selection of
548 * debug information.
549 *
550 * TRACE_EMERG 0
551 * system is unusable
552 *
553 * TRACE_ALERT 1
554 * action must be taken immediately
555 *
556 * TRACE_CRIT 2
557 * critical conditions
558 *
559 * TRACE_ERR 3
560 * error conditions
561 *
562 * TRACE_WARNING 4
563 * warning conditions
564 *
565 * TRACE_NOTICE 5
566 * normal, but significant, condition
567 *
568 * TRACE_INFO 6
569 * informational message
570 *
571 * TRACE_DEBUG_SYSTEM 7
572 * debug information with system-level scope (set of programs)
573 *
574 * TRACE_DEBUG_PROGRAM 8
575 * debug information with program-level scope (set of processes)
576 *
577 * TRACE_DEBUG_PROCESS 9
578 * debug information with process-level scope (set of modules)
579 *
580 * TRACE_DEBUG_MODULE 10
581 * debug information with module (executable/library) scope (set of units)
582 *
583 * TRACE_DEBUG_UNIT 11
584 * debug information with compilation unit scope (set of functions)
585 *
586 * TRACE_DEBUG_FUNCTION 12
587 * debug information with function-level scope
588 *
589 * TRACE_DEBUG_LINE 13
590 * debug information with line-level scope (TRACEPOINT_EVENT default)
591 *
592 * TRACE_DEBUG 14
593 * debug-level message (trace_printf default)
594 *
595 * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
596 * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
597 * tracepoint name. The first field is the provider name, the second
598 * field is the name of the tracepoint, the third field is the loglevel
599 * name.
600 *
601 * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
602 * < loglevel_name >)
603 *
604 * The TRACEPOINT_PROVIDER must be already declared before declaring a
605 * TRACEPOINT_LOGLEVEL.
606 */
607
608enum {
609 TRACE_EMERG = 0,
610 TRACE_ALERT = 1,
611 TRACE_CRIT = 2,
612 TRACE_ERR = 3,
613 TRACE_WARNING = 4,
614 TRACE_NOTICE = 5,
615 TRACE_INFO = 6,
616 TRACE_DEBUG_SYSTEM = 7,
617 TRACE_DEBUG_PROGRAM = 8,
618 TRACE_DEBUG_PROCESS = 9,
619 TRACE_DEBUG_MODULE = 10,
620 TRACE_DEBUG_UNIT = 11,
621 TRACE_DEBUG_FUNCTION = 12,
622 TRACE_DEBUG_LINE = 13,
623 TRACE_DEBUG = 14,
624};
625
626#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
627
628#endif /* #ifndef TRACEPOINT_LOGLEVEL */
629
630#ifndef TRACEPOINT_MODEL_EMF_URI
631
632#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
633
634#endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */
LTTng 2.0 Userspace Tracer
This page took 0.024123 seconds and 4 git commands to generate.