2 * Copyright 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * SPDX-License-Identifier: MIT
6 * Copied from LTTng-UST lttng/ust-abi.h
12 #ifndef LTTNG_UST_ABI_INTERNAL_H
13 #define LTTNG_UST_ABI_INTERNAL_H
16 #include <common/macros.h>
19 #error "LTTNG_PACKED should be defined"
22 #ifndef __ust_stringify
23 #define __ust_stringify1(x) #x
24 #define __ust_stringify(x) __ust_stringify1(x)
25 #endif /* __ust_stringify */
27 #define LTTNG_UST_SYM_NAME_LEN 256
28 #define LTTNG_UST_ABI_PROCNAME_LEN 16
30 /* UST comm magic number, used to validate protocol and endianness. */
31 #define LTTNG_UST_COMM_MAGIC 0xC57C57C5
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
37 enum lttng_ust_instrumentation
{
38 LTTNG_UST_TRACEPOINT
= 0,
40 LTTNG_UST_FUNCTION
= 2,
43 enum lttng_ust_loglevel_type
{
44 LTTNG_UST_LOGLEVEL_ALL
= 0,
45 LTTNG_UST_LOGLEVEL_RANGE
= 1,
46 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
49 enum lttng_ust_output
{
53 enum lttng_ust_chan_type
{
54 LTTNG_UST_CHAN_PER_CPU
= 0,
55 LTTNG_UST_CHAN_METADATA
= 1,
58 struct lttng_ust_tracer_version
{
64 #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
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.
71 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
72 struct lttng_ust_channel
{
74 enum lttng_ust_chan_type type
;
75 char padding
[LTTNG_UST_CHANNEL_PADDING
];
76 char data
[]; /* variable sized data */
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
];
85 * shm_fd and wakeup_fd are send over unix socket as file
86 * descriptors after this structure.
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 */
96 enum lttng_ust_loglevel_type loglevel_type
;
97 int loglevel
; /* value, -1: all */
99 char padding
[LTTNG_UST_EVENT_PADDING1
];
101 /* Per instrumentation type configuration */
103 char padding
[LTTNG_UST_EVENT_PADDING2
];
107 #define LTTNG_UST_EVENT_NOTIFIER_PADDING 40
108 struct lttng_ust_event_notifier
{
109 struct lttng_ust_event event
;
110 char padding
[LTTNG_UST_EVENT_NOTIFIER_PADDING
];
113 #define LTTNG_UST_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
114 struct lttng_ust_event_notifier_notification
{
116 uint16_t capture_buf_size
;
117 char padding
[LTTNG_UST_EVENT_NOTIFIER_NOTIFICATION_PADDING
];
120 enum lttng_ust_field_type
{
121 LTTNG_UST_FIELD_OTHER
= 0,
122 LTTNG_UST_FIELD_INTEGER
= 1,
123 LTTNG_UST_FIELD_ENUM
= 2,
124 LTTNG_UST_FIELD_FLOAT
= 3,
125 LTTNG_UST_FIELD_STRING
= 4,
128 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
129 struct lttng_ust_field_iter
{
130 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
131 char field_name
[LTTNG_UST_SYM_NAME_LEN
];
132 enum lttng_ust_field_type type
;
133 int loglevel
; /* event loglevel */
135 char padding
[LTTNG_UST_FIELD_ITER_PADDING
];
138 enum lttng_ust_context_type
{
139 LTTNG_UST_CONTEXT_VTID
= 0,
140 LTTNG_UST_CONTEXT_VPID
= 1,
141 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
142 LTTNG_UST_CONTEXT_PROCNAME
= 3,
143 LTTNG_UST_CONTEXT_IP
= 4,
144 LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
= 5,
145 LTTNG_UST_CONTEXT_CPU_ID
= 6,
146 LTTNG_UST_CONTEXT_APP_CONTEXT
= 7,
147 LTTNG_UST_CONTEXT_CGROUP_NS
= 8,
148 LTTNG_UST_CONTEXT_IPC_NS
= 9,
149 LTTNG_UST_CONTEXT_MNT_NS
= 10,
150 LTTNG_UST_CONTEXT_NET_NS
= 11,
151 LTTNG_UST_CONTEXT_PID_NS
= 12,
152 LTTNG_UST_CONTEXT_USER_NS
= 13,
153 LTTNG_UST_CONTEXT_UTS_NS
= 14,
154 LTTNG_UST_CONTEXT_VUID
= 15,
155 LTTNG_UST_CONTEXT_VEUID
= 16,
156 LTTNG_UST_CONTEXT_VSUID
= 17,
157 LTTNG_UST_CONTEXT_VGID
= 18,
158 LTTNG_UST_CONTEXT_VEGID
= 19,
159 LTTNG_UST_CONTEXT_VSGID
= 20,
160 LTTNG_UST_CONTEXT_TIME_NS
= 21,
163 struct lttng_ust_perf_counter_ctx
{
166 char name
[LTTNG_UST_SYM_NAME_LEN
];
169 #define LTTNG_UST_CONTEXT_PADDING1 16
170 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
171 struct lttng_ust_context
{
172 enum lttng_ust_context_type ctx
;
173 char padding
[LTTNG_UST_CONTEXT_PADDING1
];
176 struct lttng_ust_perf_counter_ctx perf_counter
;
178 /* Includes trailing '\0'. */
179 uint32_t provider_name_len
;
180 uint32_t ctx_name_len
;
182 char padding
[LTTNG_UST_CONTEXT_PADDING2
];
187 * Tracer channel attributes.
189 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
190 struct lttng_ust_channel_attr
{
191 uint64_t subbuf_size
; /* bytes */
192 uint64_t num_subbuf
; /* power of 2 */
193 int overwrite
; /* 1: overwrite, 0: discard */
194 unsigned int switch_timer_interval
; /* usec */
195 unsigned int read_timer_interval
; /* usec */
196 enum lttng_ust_output output
; /* splice, mmap */
199 int64_t blocking_timeout
; /* Blocking timeout (usec) */
201 char padding
[LTTNG_UST_CHANNEL_ATTR_PADDING
];
205 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
206 struct lttng_ust_tracepoint_iter
{
207 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
209 char padding
[LTTNG_UST_TRACEPOINT_ITER_PADDING
];
212 enum lttng_ust_object_type
{
213 LTTNG_UST_OBJECT_TYPE_UNKNOWN
= -1,
214 LTTNG_UST_OBJECT_TYPE_CHANNEL
= 0,
215 LTTNG_UST_OBJECT_TYPE_STREAM
= 1,
216 LTTNG_UST_OBJECT_TYPE_EVENT
= 2,
217 LTTNG_UST_OBJECT_TYPE_CONTEXT
= 3,
220 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
221 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
223 struct lttng_ust_object_data
{
224 enum lttng_ust_object_type type
;
227 char padding1
[LTTNG_UST_OBJECT_DATA_PADDING1
];
231 enum lttng_ust_chan_type type
;
239 char padding2
[LTTNG_UST_OBJECT_DATA_PADDING2
];
243 enum lttng_ust_calibrate_type
{
244 LTTNG_UST_CALIBRATE_TRACEPOINT
,
247 #define LTTNG_UST_CALIBRATE_PADDING1 16
248 #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
249 struct lttng_ust_calibrate
{
250 enum lttng_ust_calibrate_type type
; /* type (input) */
251 char padding
[LTTNG_UST_CALIBRATE_PADDING1
];
254 char padding
[LTTNG_UST_CALIBRATE_PADDING2
];
258 #define FILTER_BYTECODE_MAX_LEN 65536
259 #define LTTNG_UST_FILTER_PADDING 32
260 struct lttng_ust_filter_bytecode
{
262 uint32_t reloc_offset
;
264 char padding
[LTTNG_UST_FILTER_PADDING
];
268 #define CAPTURE_BYTECODE_MAX_LEN 65536
269 #define LTTNG_UST_CAPTURE_PADDING 32
270 struct lttng_ust_capture_bytecode
{
272 uint32_t reloc_offset
;
274 char padding
[LTTNG_UST_CAPTURE_PADDING
];
278 #define LTTNG_UST_EXCLUSION_PADDING 32
279 struct lttng_ust_event_exclusion
{
281 char padding
[LTTNG_UST_EXCLUSION_PADDING
];
282 char names
[LTTNG_UST_SYM_NAME_LEN
][0];
285 #define _UST_CMD(minor) (minor)
286 #define _UST_CMDR(minor, type) (minor)
287 #define _UST_CMDW(minor, type) (minor)
289 /* Handled by object descriptor */
290 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
292 /* Handled by object cmd */
294 /* LTTng-UST commands */
295 #define LTTNG_UST_SESSION _UST_CMD(0x40)
296 #define LTTNG_UST_TRACER_VERSION \
297 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
298 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
299 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
300 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
301 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
302 #define LTTNG_UST_EVENT_NOTIFIER_GROUP_CREATE _UST_CMD(0x46)
304 /* Session FD commands */
305 #define LTTNG_UST_CHANNEL \
306 _UST_CMDW(0x51, struct lttng_ust_channel)
307 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
308 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
309 #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
311 /* Channel FD commands */
312 #define LTTNG_UST_STREAM _UST_CMD(0x60)
313 #define LTTNG_UST_EVENT \
314 _UST_CMDW(0x61, struct lttng_ust_event)
316 /* Event and Channel FD commands */
317 #define LTTNG_UST_CONTEXT \
318 _UST_CMDW(0x70, struct lttng_ust_context)
319 #define LTTNG_UST_FLUSH_BUFFER \
322 /* Event, Channel and Session commands */
323 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
324 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
326 /* Tracepoint list commands */
327 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
328 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
330 /* Event FD commands */
331 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
332 #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
334 /* Event notifier group commands */
335 #define LTTNG_UST_EVENT_NOTIFIER_CREATE \
336 _UST_CMDW(0xB0, struct lttng_ust_event_notifier)
338 #define LTTNG_UST_ROOT_HANDLE 0
340 struct lttng_ust_obj
;
352 struct lttng_ust_field_iter entry
;
359 struct lttng_ust_objd_ops
{
360 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
361 union ust_args
*args
, void *owner
);
362 int (*release
)(int objd
);
365 /* Create root handle. Always ID 0. */
366 int lttng_abi_create_root_handle(void);
368 const struct lttng_ust_objd_ops
*objd_ops(int id
);
369 int lttng_ust_objd_unref(int id
, int is_owner
);
371 void lttng_ust_abi_exit(void);
372 void lttng_ust_events_exit(void);
373 void lttng_ust_objd_table_owner_cleanup(void *owner
);
375 #endif /* LTTNG_UST_ABI_INTERNAL_H */