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