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