Add tracelog documentation to lttng-ust(3)
[lttng-ust.git] / include / lttng / tracepoint-event.h
1 /*
2 * Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 #ifdef TRACEPOINT_CREATE_PROBES
24
25 #define __tp_stringify1(x) #x
26 #define __tp_stringify(x) __tp_stringify1(x)
27
28 #undef TRACEPOINT_EVENT_INSTANCE
29 #define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)
30
31 #undef TRACEPOINT_EVENT
32 #define TRACEPOINT_EVENT(_provider, _name, _args, _fields) \
33 TRACEPOINT_EVENT_CLASS(_provider, _name, _TP_PARAMS(_args), \
34 _TP_PARAMS(_fields)) \
35 TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name, \
36 _TP_PARAMS(_args))
37
38
39 #undef TRACEPOINT_CREATE_PROBES
40
41 #define TRACEPOINT_HEADER_MULTI_READ
42
43 /*
44 * LTTng-UST 2.0 expects TRACEPOINT_INCLUDE_FILE, but this approach has
45 * the unwanted side-effect of expanding any macro name found within
46 * TRACEPOINT_INCLUDE_FILE.
47 *
48 * Starting from LTTng-UST 2.1, we expect the TRACEPOINT_INCLUDE to be
49 * defined by probes as a string. We still check for
50 * TRACEPOINT_INCLUDE_FILE for API backward compatibility.
51 */
52 #ifdef TRACEPOINT_INCLUDE_FILE
53 #define TRACEPOINT_INCLUDE __tp_stringify(TRACEPOINT_INCLUDE_FILE)
54 #endif
55
56 #include TRACEPOINT_INCLUDE
57
58 #include <lttng/ust-tracepoint-event.h>
59
60 #undef TRACEPOINT_HEADER_MULTI_READ
61 #undef TRACEPOINT_INCLUDE_FILE
62 #undef TRACEPOINT_INCLUDE
63
64 #define TRACEPOINT_CREATE_PROBES
65
66 /*
67 * Put back definitions to the state they were when defined by
68 * tracepoint.h.
69 */
70 #undef TP_ARGS
71 #define TP_ARGS(...) __VA_ARGS__
72
73 #undef TRACEPOINT_EVENT
74 #define TRACEPOINT_EVENT(provider, name, args, fields) \
75 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
76 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
77
78 #undef TRACEPOINT_EVENT_CLASS
79 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
80
81 #undef TRACEPOINT_EVENT_INSTANCE
82 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
83 _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
84 _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
85
86 #undef TRACEPOINT_LOGLEVEL
87 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
88
89 #undef TRACEPOINT_MODEL_EMF_URI
90 #define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
91
92 #endif /* TRACEPOINT_CREATE_PROBES */
This page took 0.074085 seconds and 4 git commands to generate.