SoW-2019-0002: Dynamic Snapshot
[lttng-tools.git] / src / bin / lttng-sessiond / ust-abi-internal.h
CommitLineData
75018ab6 1/*
ab5be9fa 2 * Copyright 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
75018ab6 3 *
ab5be9fa 4 * SPDX-License-Identifier: MIT
75018ab6 5 *
ab5be9fa 6 * Copied from LTTng-UST lttng/ust-abi.h
75018ab6 7 *
ab5be9fa 8 * LTTng-UST ABI header
75018ab6 9 *
75018ab6
JG
10 */
11
12#ifndef LTTNG_UST_ABI_INTERNAL_H
13#define LTTNG_UST_ABI_INTERNAL_H
14
15#include <stdint.h>
fe7de4bf 16#include <common/macros.h>
75018ab6 17
95194333
JG
18#ifndef LTTNG_PACKED
19#error "LTTNG_PACKED should be defined"
20#endif
75018ab6
JG
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
208ddc06 35#define LTTNG_UST_ABI_MINOR_VERSION 1
75018ab6 36
75018ab6
JG
37enum lttng_ust_instrumentation {
38 LTTNG_UST_TRACEPOINT = 0,
39 LTTNG_UST_PROBE = 1,
40 LTTNG_UST_FUNCTION = 2,
41};
42
43enum lttng_ust_loglevel_type {
44 LTTNG_UST_LOGLEVEL_ALL = 0,
45 LTTNG_UST_LOGLEVEL_RANGE = 1,
46 LTTNG_UST_LOGLEVEL_SINGLE = 2,
47};
48
49enum lttng_ust_output {
50 LTTNG_UST_MMAP = 0,
51};
52
53enum lttng_ust_chan_type {
54 LTTNG_UST_CHAN_PER_CPU = 0,
55 LTTNG_UST_CHAN_METADATA = 1,
56};
57
58struct 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
72struct 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)
80struct 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
1831ae68
FD
90#define LTTNG_UST_TRIGGER_PADDING1 16
91#define LTTNG_UST_TRIGGER_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
92struct lttng_ust_trigger {
93 uint64_t id;
94 enum lttng_ust_instrumentation instrumentation;
95 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
96
97 enum lttng_ust_loglevel_type loglevel_type;
98 int loglevel; /* value, -1: all */
99 char padding[LTTNG_UST_TRIGGER_PADDING1];
100
101 /* Per instrumentation type configuration */
102 union {
103 char padding[LTTNG_UST_TRIGGER_PADDING2];
104 } u;
105} LTTNG_PACKED;
106
107#define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
108struct lttng_ust_trigger_notification {
109 uint64_t id;
110 char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
111} LTTNG_PACKED;
112
75018ab6
JG
113#define LTTNG_UST_EVENT_PADDING1 16
114#define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
115struct lttng_ust_event {
116 enum lttng_ust_instrumentation instrumentation;
117 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
118
119 enum lttng_ust_loglevel_type loglevel_type;
120 int loglevel; /* value, -1: all */
121 char padding[LTTNG_UST_EVENT_PADDING1];
122
123 /* Per instrumentation type configuration */
124 union {
125 char padding[LTTNG_UST_EVENT_PADDING2];
126 } u;
127} LTTNG_PACKED;
128
129enum lttng_ust_field_type {
130 LTTNG_UST_FIELD_OTHER = 0,
131 LTTNG_UST_FIELD_INTEGER = 1,
132 LTTNG_UST_FIELD_ENUM = 2,
133 LTTNG_UST_FIELD_FLOAT = 3,
134 LTTNG_UST_FIELD_STRING = 4,
135};
136
137#define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
138struct lttng_ust_field_iter {
139 char event_name[LTTNG_UST_SYM_NAME_LEN];
140 char field_name[LTTNG_UST_SYM_NAME_LEN];
141 enum lttng_ust_field_type type;
142 int loglevel; /* event loglevel */
143 int nowrite;
144 char padding[LTTNG_UST_FIELD_ITER_PADDING];
145} LTTNG_PACKED;
146
147enum lttng_ust_context_type {
148 LTTNG_UST_CONTEXT_VTID = 0,
149 LTTNG_UST_CONTEXT_VPID = 1,
150 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
151 LTTNG_UST_CONTEXT_PROCNAME = 3,
152 LTTNG_UST_CONTEXT_IP = 4,
153 LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
154 LTTNG_UST_CONTEXT_CPU_ID = 6,
155 LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
95194333
JG
156 LTTNG_UST_CONTEXT_CGROUP_NS = 8,
157 LTTNG_UST_CONTEXT_IPC_NS = 9,
158 LTTNG_UST_CONTEXT_MNT_NS = 10,
159 LTTNG_UST_CONTEXT_NET_NS = 11,
160 LTTNG_UST_CONTEXT_PID_NS = 12,
161 LTTNG_UST_CONTEXT_USER_NS = 13,
162 LTTNG_UST_CONTEXT_UTS_NS = 14,
163 LTTNG_UST_CONTEXT_VUID = 15,
164 LTTNG_UST_CONTEXT_VEUID = 16,
165 LTTNG_UST_CONTEXT_VSUID = 17,
166 LTTNG_UST_CONTEXT_VGID = 18,
167 LTTNG_UST_CONTEXT_VEGID = 19,
168 LTTNG_UST_CONTEXT_VSGID = 20,
75018ab6
JG
169};
170
171struct lttng_ust_perf_counter_ctx {
172 uint32_t type;
173 uint64_t config;
174 char name[LTTNG_UST_SYM_NAME_LEN];
175} LTTNG_PACKED;
176
177#define LTTNG_UST_CONTEXT_PADDING1 16
178#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
179struct lttng_ust_context {
180 enum lttng_ust_context_type ctx;
181 char padding[LTTNG_UST_CONTEXT_PADDING1];
182
183 union {
184 struct lttng_ust_perf_counter_ctx perf_counter;
185 struct {
186 /* Includes trailing '\0'. */
187 uint32_t provider_name_len;
188 uint32_t ctx_name_len;
189 } app_ctx;
190 char padding[LTTNG_UST_CONTEXT_PADDING2];
191 } u;
192} LTTNG_PACKED;
193
194/*
195 * Tracer channel attributes.
196 */
197#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
198struct lttng_ust_channel_attr {
95194333 199 uint64_t subbuf_size; /* bytes */
75018ab6
JG
200 uint64_t num_subbuf; /* power of 2 */
201 int overwrite; /* 1: overwrite, 0: discard */
202 unsigned int switch_timer_interval; /* usec */
203 unsigned int read_timer_interval; /* usec */
204 enum lttng_ust_output output; /* splice, mmap */
205 union {
206 struct {
95194333 207 int64_t blocking_timeout; /* Blocking timeout (usec) */
75018ab6
JG
208 } s;
209 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
210 } u;
211} LTTNG_PACKED;
212
213#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
214struct lttng_ust_tracepoint_iter {
215 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
216 int loglevel;
217 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
218} LTTNG_PACKED;
219
220enum lttng_ust_object_type {
221 LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
222 LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
223 LTTNG_UST_OBJECT_TYPE_STREAM = 1,
224 LTTNG_UST_OBJECT_TYPE_EVENT = 2,
225 LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
226};
227
228#define LTTNG_UST_OBJECT_DATA_PADDING1 32
229#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
230
231struct lttng_ust_object_data {
232 enum lttng_ust_object_type type;
233 int handle;
234 uint64_t size;
235 char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
236 union {
237 struct {
238 void *data;
239 enum lttng_ust_chan_type type;
240 int wakeup_fd;
241 } channel;
242 struct {
243 int shm_fd;
244 int wakeup_fd;
245 uint32_t stream_nr;
246 } stream;
247 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
248 } u;
249} LTTNG_PACKED;
250
95194333
JG
251enum lttng_ust_calibrate_type {
252 LTTNG_UST_CALIBRATE_TRACEPOINT,
253};
254
255#define LTTNG_UST_CALIBRATE_PADDING1 16
256#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
257struct lttng_ust_calibrate {
258 enum lttng_ust_calibrate_type type; /* type (input) */
259 char padding[LTTNG_UST_CALIBRATE_PADDING1];
260
261 union {
262 char padding[LTTNG_UST_CALIBRATE_PADDING2];
263 } u;
264} LTTNG_PACKED;
265
75018ab6
JG
266#define FILTER_BYTECODE_MAX_LEN 65536
267#define LTTNG_UST_FILTER_PADDING 32
268struct lttng_ust_filter_bytecode {
269 uint32_t len;
270 uint32_t reloc_offset;
271 uint64_t seqnum;
272 char padding[LTTNG_UST_FILTER_PADDING];
273 char data[0];
274} LTTNG_PACKED;
275
276#define LTTNG_UST_EXCLUSION_PADDING 32
277struct lttng_ust_event_exclusion {
278 uint32_t count;
279 char padding[LTTNG_UST_EXCLUSION_PADDING];
280 char names[LTTNG_UST_SYM_NAME_LEN][0];
281} LTTNG_PACKED;
282
283#define _UST_CMD(minor) (minor)
284#define _UST_CMDR(minor, type) (minor)
285#define _UST_CMDW(minor, type) (minor)
286
287/* Handled by object descriptor */
288#define LTTNG_UST_RELEASE _UST_CMD(0x1)
289
290/* Handled by object cmd */
291
292/* LTTng-UST commands */
293#define LTTNG_UST_SESSION _UST_CMD(0x40)
294#define LTTNG_UST_TRACER_VERSION \
295 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
296#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
297#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
298#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
299#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
300
301/* Session FD commands */
302#define LTTNG_UST_CHANNEL \
303 _UST_CMDW(0x51, struct lttng_ust_channel)
304#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
305#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
306#define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
307
308/* Channel FD commands */
309#define LTTNG_UST_STREAM _UST_CMD(0x60)
310#define LTTNG_UST_EVENT \
311 _UST_CMDW(0x61, struct lttng_ust_event)
312
313/* Event and Channel FD commands */
314#define LTTNG_UST_CONTEXT \
315 _UST_CMDW(0x70, struct lttng_ust_context)
316#define LTTNG_UST_FLUSH_BUFFER \
317 _UST_CMD(0x71)
318
319/* Event, Channel and Session commands */
320#define LTTNG_UST_ENABLE _UST_CMD(0x80)
321#define LTTNG_UST_DISABLE _UST_CMD(0x81)
322
323/* Tracepoint list commands */
324#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
325#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
326
327/* Event FD commands */
328#define LTTNG_UST_FILTER _UST_CMD(0xA0)
95194333 329#define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
75018ab6 330
1831ae68
FD
331#define LTTNG_UST_TRIGGER_SEND_FD _UST_CMD(0xB0)
332#define LTTNG_UST_TRIGGER_CREATE _UST_CMDW(0xB1, struct lttng_ust_trigger)
333
75018ab6
JG
334#define LTTNG_UST_ROOT_HANDLE 0
335
336struct lttng_ust_obj;
337
338union ust_args {
339 struct {
340 void *chan_data;
341 int wakeup_fd;
342 } channel;
343 struct {
344 int shm_fd;
345 int wakeup_fd;
346 } stream;
347 struct {
348 struct lttng_ust_field_iter entry;
349 } field_list;
95194333
JG
350 struct {
351 char *ctxname;
352 } app_context;
75018ab6
JG
353};
354
355struct lttng_ust_objd_ops {
356 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
357 union ust_args *args, void *owner);
358 int (*release)(int objd);
359};
360
361/* Create root handle. Always ID 0. */
362int lttng_abi_create_root_handle(void);
363
364const struct lttng_ust_objd_ops *objd_ops(int id);
365int lttng_ust_objd_unref(int id, int is_owner);
366
367void lttng_ust_abi_exit(void);
368void lttng_ust_events_exit(void);
369void lttng_ust_objd_table_owner_cleanup(void *owner);
370
371#endif /* LTTNG_UST_ABI_INTERNAL_H */
This page took 0.042529 seconds and 5 git commands to generate.