Fix: sessiond: use system LTTng-UST headers when available
[lttng-tools.git] / src / bin / lttng-sessiond / ust-abi-internal.h
1 /*
2 * lttng/ust-abi.h
3 *
4 * LTTng-UST ABI header
5 *
6 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 #ifndef LTTNG_UST_ABI_INTERNAL_H
28 #define LTTNG_UST_ABI_INTERNAL_H
29
30 #include <stdint.h>
31
32 #define lttng_ust_notrace __attribute__((no_instrument_function))
33 #define LTTNG_PACKED __attribute__((__packed__))
34
35 #ifndef __ust_stringify
36 #define __ust_stringify1(x) #x
37 #define __ust_stringify(x) __ust_stringify1(x)
38 #endif /* __ust_stringify */
39
40 #define LTTNG_UST_SYM_NAME_LEN 256
41 #define LTTNG_UST_ABI_PROCNAME_LEN 16
42
43 /* UST comm magic number, used to validate protocol and endianness. */
44 #define LTTNG_UST_COMM_MAGIC 0xC57C57C5
45
46 /* Version for ABI between liblttng-ust, sessiond, consumerd */
47 #define LTTNG_UST_ABI_MAJOR_VERSION 8
48 #define LTTNG_UST_ABI_MINOR_VERSION 0
49
50 struct lttng_ust_calibrate;
51
52 enum lttng_ust_instrumentation {
53 LTTNG_UST_TRACEPOINT = 0,
54 LTTNG_UST_PROBE = 1,
55 LTTNG_UST_FUNCTION = 2,
56 };
57
58 enum lttng_ust_loglevel_type {
59 LTTNG_UST_LOGLEVEL_ALL = 0,
60 LTTNG_UST_LOGLEVEL_RANGE = 1,
61 LTTNG_UST_LOGLEVEL_SINGLE = 2,
62 };
63
64 enum lttng_ust_output {
65 LTTNG_UST_MMAP = 0,
66 };
67
68 enum lttng_ust_chan_type {
69 LTTNG_UST_CHAN_PER_CPU = 0,
70 LTTNG_UST_CHAN_METADATA = 1,
71 };
72
73 struct lttng_ust_tracer_version {
74 uint32_t major;
75 uint32_t minor;
76 uint32_t patchlevel;
77 } LTTNG_PACKED;
78
79 #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
80 /*
81 * Given that the consumerd is limited to 64k file descriptors, we
82 * cannot expect much more than 1MB channel structure size. This size is
83 * depends on the number of streams within a channel, which depends on
84 * the number of possible CPUs on the system.
85 */
86 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
87 struct lttng_ust_channel {
88 uint64_t len;
89 enum lttng_ust_chan_type type;
90 char padding[LTTNG_UST_CHANNEL_PADDING];
91 char data[]; /* variable sized data */
92 } LTTNG_PACKED;
93
94 #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
95 struct lttng_ust_stream {
96 uint64_t len; /* shm len */
97 uint32_t stream_nr; /* stream number */
98 char padding[LTTNG_UST_STREAM_PADDING1];
99 /*
100 * shm_fd and wakeup_fd are send over unix socket as file
101 * descriptors after this structure.
102 */
103 } LTTNG_PACKED;
104
105 #define LTTNG_UST_EVENT_PADDING1 16
106 #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
107 struct lttng_ust_event {
108 enum lttng_ust_instrumentation instrumentation;
109 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
110
111 enum lttng_ust_loglevel_type loglevel_type;
112 int loglevel; /* value, -1: all */
113 char padding[LTTNG_UST_EVENT_PADDING1];
114
115 /* Per instrumentation type configuration */
116 union {
117 char padding[LTTNG_UST_EVENT_PADDING2];
118 } u;
119 } LTTNG_PACKED;
120
121 enum lttng_ust_field_type {
122 LTTNG_UST_FIELD_OTHER = 0,
123 LTTNG_UST_FIELD_INTEGER = 1,
124 LTTNG_UST_FIELD_ENUM = 2,
125 LTTNG_UST_FIELD_FLOAT = 3,
126 LTTNG_UST_FIELD_STRING = 4,
127 };
128
129 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
130 struct lttng_ust_field_iter {
131 char event_name[LTTNG_UST_SYM_NAME_LEN];
132 char field_name[LTTNG_UST_SYM_NAME_LEN];
133 enum lttng_ust_field_type type;
134 int loglevel; /* event loglevel */
135 int nowrite;
136 char padding[LTTNG_UST_FIELD_ITER_PADDING];
137 } LTTNG_PACKED;
138
139 enum lttng_ust_context_type {
140 LTTNG_UST_CONTEXT_VTID = 0,
141 LTTNG_UST_CONTEXT_VPID = 1,
142 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
143 LTTNG_UST_CONTEXT_PROCNAME = 3,
144 LTTNG_UST_CONTEXT_IP = 4,
145 LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
146 LTTNG_UST_CONTEXT_CPU_ID = 6,
147 LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
148 };
149
150 struct lttng_ust_perf_counter_ctx {
151 uint32_t type;
152 uint64_t config;
153 char name[LTTNG_UST_SYM_NAME_LEN];
154 } LTTNG_PACKED;
155
156 #define LTTNG_UST_CONTEXT_PADDING1 16
157 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
158 struct lttng_ust_context {
159 enum lttng_ust_context_type ctx;
160 char padding[LTTNG_UST_CONTEXT_PADDING1];
161
162 union {
163 struct lttng_ust_perf_counter_ctx perf_counter;
164 struct {
165 /* Includes trailing '\0'. */
166 uint32_t provider_name_len;
167 uint32_t ctx_name_len;
168 } app_ctx;
169 char padding[LTTNG_UST_CONTEXT_PADDING2];
170 } u;
171 } LTTNG_PACKED;
172
173 /*
174 * Tracer channel attributes.
175 */
176 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
177 struct lttng_ust_channel_attr {
178 uint64_t subbuf_size; /* bytes, power of 2 */
179 uint64_t num_subbuf; /* power of 2 */
180 int overwrite; /* 1: overwrite, 0: discard */
181 unsigned int switch_timer_interval; /* usec */
182 unsigned int read_timer_interval; /* usec */
183 enum lttng_ust_output output; /* splice, mmap */
184 union {
185 struct {
186 int64_t blocking_timeout; /* Retry timeout (usec) */
187 } s;
188 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
189 } u;
190 } LTTNG_PACKED;
191
192 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
193 struct lttng_ust_tracepoint_iter {
194 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
195 int loglevel;
196 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
197 } LTTNG_PACKED;
198
199 enum lttng_ust_object_type {
200 LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
201 LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
202 LTTNG_UST_OBJECT_TYPE_STREAM = 1,
203 LTTNG_UST_OBJECT_TYPE_EVENT = 2,
204 LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
205 };
206
207 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
208 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
209
210 struct lttng_ust_object_data {
211 enum lttng_ust_object_type type;
212 int handle;
213 uint64_t size;
214 char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
215 union {
216 struct {
217 void *data;
218 enum lttng_ust_chan_type type;
219 int wakeup_fd;
220 } channel;
221 struct {
222 int shm_fd;
223 int wakeup_fd;
224 uint32_t stream_nr;
225 } stream;
226 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
227 } u;
228 } LTTNG_PACKED;
229
230 #define FILTER_BYTECODE_MAX_LEN 65536
231 #define LTTNG_UST_FILTER_PADDING 32
232 struct lttng_ust_filter_bytecode {
233 uint32_t len;
234 uint32_t reloc_offset;
235 uint64_t seqnum;
236 char padding[LTTNG_UST_FILTER_PADDING];
237 char data[0];
238 } LTTNG_PACKED;
239
240 #define LTTNG_UST_EXCLUSION_PADDING 32
241 struct lttng_ust_event_exclusion {
242 uint32_t count;
243 char padding[LTTNG_UST_EXCLUSION_PADDING];
244 char names[LTTNG_UST_SYM_NAME_LEN][0];
245 } LTTNG_PACKED;
246
247 #define _UST_CMD(minor) (minor)
248 #define _UST_CMDR(minor, type) (minor)
249 #define _UST_CMDW(minor, type) (minor)
250
251 /* Handled by object descriptor */
252 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
253
254 /* Handled by object cmd */
255
256 /* LTTng-UST commands */
257 #define LTTNG_UST_SESSION _UST_CMD(0x40)
258 #define LTTNG_UST_TRACER_VERSION \
259 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
260 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
261 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
262 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
263 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
264
265 /* Session FD commands */
266 #define LTTNG_UST_CHANNEL \
267 _UST_CMDW(0x51, struct lttng_ust_channel)
268 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
269 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
270 #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
271
272 /* Channel FD commands */
273 #define LTTNG_UST_STREAM _UST_CMD(0x60)
274 #define LTTNG_UST_EVENT \
275 _UST_CMDW(0x61, struct lttng_ust_event)
276
277 /* Event and Channel FD commands */
278 #define LTTNG_UST_CONTEXT \
279 _UST_CMDW(0x70, struct lttng_ust_context)
280 #define LTTNG_UST_FLUSH_BUFFER \
281 _UST_CMD(0x71)
282
283 /* Event, Channel and Session commands */
284 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
285 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
286
287 /* Tracepoint list commands */
288 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
289 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
290
291 /* Event FD commands */
292 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
293
294 #define LTTNG_UST_ROOT_HANDLE 0
295
296 struct lttng_ust_obj;
297
298 union ust_args {
299 struct {
300 void *chan_data;
301 int wakeup_fd;
302 } channel;
303 struct {
304 int shm_fd;
305 int wakeup_fd;
306 } stream;
307 struct {
308 struct lttng_ust_field_iter entry;
309 } field_list;
310 };
311
312 struct lttng_ust_objd_ops {
313 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
314 union ust_args *args, void *owner);
315 int (*release)(int objd);
316 };
317
318 /* Create root handle. Always ID 0. */
319 int lttng_abi_create_root_handle(void);
320
321 const struct lttng_ust_objd_ops *objd_ops(int id);
322 int lttng_ust_objd_unref(int id, int is_owner);
323
324 void lttng_ust_abi_exit(void);
325 void lttng_ust_events_exit(void);
326 void lttng_ust_objd_table_owner_cleanup(void *owner);
327
328 #endif /* LTTNG_UST_ABI_INTERNAL_H */
This page took 0.052457 seconds and 5 git commands to generate.