1 #ifndef _LTTNG_UST_ABI_H
2 #define _LTTNG_UST_ABI_H
9 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
31 #include <lttng/ust-compiler.h>
33 #define LTTNG_UST_SYM_NAME_LEN 256
35 /* Version for comm protocol between sessiond and ust */
36 #define LTTNG_UST_COMM_VERSION_MAJOR 2
37 #define LTTNG_UST_COMM_VERSION_MINOR 1
39 /* Version for ABI between liblttng-ust, sessiond, consumerd */
40 #define LTTNG_UST_INTERNAL_MAJOR_VERSION 3
41 #define LTTNG_UST_INTERNAL_MINOR_VERSION 0
42 #define LTTNG_UST_INTERNAL_PATCHLEVEL_VERSION 0
44 enum lttng_ust_instrumentation
{
45 LTTNG_UST_TRACEPOINT
= 0,
47 LTTNG_UST_FUNCTION
= 2,
50 enum lttng_ust_loglevel_type
{
51 LTTNG_UST_LOGLEVEL_ALL
= 0,
52 LTTNG_UST_LOGLEVEL_RANGE
= 1,
53 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
56 enum lttng_ust_output
{
60 enum lttng_ust_chan_type
{
61 LTTNG_UST_CHAN_PER_CPU
= 0,
62 LTTNG_UST_CHAN_METADATA
= 1,
65 struct lttng_ust_tracer_version
{
71 #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
73 * Given that the consumerd is limited to 64k file descriptors, we
74 * cannot expect much more than 1MB channel structure size. This size is
75 * depends on the number of streams within a channel, which depends on
76 * the number of possible CPUs on the system.
78 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
79 struct lttng_ust_channel
{
81 enum lttng_ust_chan_type type
;
82 char padding
[LTTNG_UST_CHANNEL_PADDING
];
83 char data
[]; /* variable sized data */
86 #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
87 struct lttng_ust_stream
{
88 uint64_t len
; /* shm len */
89 uint32_t stream_nr
; /* stream number */
90 char padding
[LTTNG_UST_STREAM_PADDING1
];
92 * shm_fd and wakeup_fd are send over unix socket as file
93 * descriptors after this structure.
97 #define LTTNG_UST_EVENT_PADDING1 16
98 #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
99 struct lttng_ust_event
{
100 enum lttng_ust_instrumentation instrumentation
;
101 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
103 enum lttng_ust_loglevel_type loglevel_type
;
104 int loglevel
; /* value, -1: all */
105 char padding
[LTTNG_UST_EVENT_PADDING1
];
107 /* Per instrumentation type configuration */
109 char padding
[LTTNG_UST_EVENT_PADDING2
];
113 enum lttng_ust_field_type
{
114 LTTNG_UST_FIELD_OTHER
= 0,
115 LTTNG_UST_FIELD_INTEGER
= 1,
116 LTTNG_UST_FIELD_ENUM
= 2,
117 LTTNG_UST_FIELD_FLOAT
= 3,
118 LTTNG_UST_FIELD_STRING
= 4,
121 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
122 struct lttng_ust_field_iter
{
123 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
124 char field_name
[LTTNG_UST_SYM_NAME_LEN
];
125 enum lttng_ust_field_type type
;
126 int loglevel
; /* event loglevel */
128 char padding
[LTTNG_UST_FIELD_ITER_PADDING
];
131 enum lttng_ust_context_type
{
132 LTTNG_UST_CONTEXT_VTID
= 0,
133 LTTNG_UST_CONTEXT_VPID
= 1,
134 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
135 LTTNG_UST_CONTEXT_PROCNAME
= 3,
138 #define LTTNG_UST_CONTEXT_PADDING1 16
139 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
140 struct lttng_ust_context
{
141 enum lttng_ust_context_type ctx
;
142 char padding
[LTTNG_UST_CONTEXT_PADDING1
];
145 char padding
[LTTNG_UST_CONTEXT_PADDING2
];
150 * Tracer channel attributes.
152 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
153 struct lttng_ust_channel_attr
{
154 uint64_t subbuf_size
; /* bytes */
155 uint64_t num_subbuf
; /* power of 2 */
156 int overwrite
; /* 1: overwrite, 0: discard */
157 unsigned int switch_timer_interval
; /* usec */
158 unsigned int read_timer_interval
; /* usec */
159 enum lttng_ust_output output
; /* splice, mmap */
160 char padding
[LTTNG_UST_CHANNEL_ATTR_PADDING
];
163 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
164 struct lttng_ust_tracepoint_iter
{
165 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
167 char padding
[LTTNG_UST_TRACEPOINT_ITER_PADDING
];
170 enum lttng_ust_object_type
{
171 LTTNG_UST_OBJECT_TYPE_UNKNOWN
= -1,
172 LTTNG_UST_OBJECT_TYPE_CHANNEL
= 0,
173 LTTNG_UST_OBJECT_TYPE_STREAM
= 1,
176 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
177 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
179 struct lttng_ust_object_data
{
180 enum lttng_ust_object_type type
;
183 char padding1
[LTTNG_UST_OBJECT_DATA_PADDING1
];
187 enum lttng_ust_chan_type type
;
194 char padding2
[LTTNG_UST_OBJECT_DATA_PADDING2
];
198 enum lttng_ust_calibrate_type
{
199 LTTNG_UST_CALIBRATE_TRACEPOINT
,
202 #define LTTNG_UST_CALIBRATE_PADDING1 16
203 #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
204 struct lttng_ust_calibrate
{
205 enum lttng_ust_calibrate_type type
; /* type (input) */
206 char padding
[LTTNG_UST_CALIBRATE_PADDING1
];
209 char padding
[LTTNG_UST_CALIBRATE_PADDING2
];
213 #define FILTER_BYTECODE_MAX_LEN 65536
214 #define LTTNG_UST_FILTER_PADDING 32
215 struct lttng_ust_filter_bytecode
{
217 uint32_t reloc_offset
;
219 char padding
[LTTNG_UST_FILTER_PADDING
];
223 #define _UST_CMD(minor) (minor)
224 #define _UST_CMDR(minor, type) (minor)
225 #define _UST_CMDW(minor, type) (minor)
227 /* Handled by object descriptor */
228 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
230 /* Handled by object cmd */
232 /* LTTng-UST commands */
233 #define LTTNG_UST_SESSION _UST_CMD(0x40)
234 #define LTTNG_UST_TRACER_VERSION \
235 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
236 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
237 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
238 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
239 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
241 /* Session FD commands */
242 #define LTTNG_UST_CHANNEL \
243 _UST_CMDW(0x51, struct lttng_ust_channel)
244 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
245 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
247 /* Channel FD commands */
248 #define LTTNG_UST_STREAM _UST_CMD(0x60)
249 #define LTTNG_UST_EVENT \
250 _UST_CMDW(0x61, struct lttng_ust_event)
252 /* Event and Channel FD commands */
253 #define LTTNG_UST_CONTEXT \
254 _UST_CMDW(0x70, struct lttng_ust_context)
255 #define LTTNG_UST_FLUSH_BUFFER \
258 /* Event, Channel and Session commands */
259 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
260 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
262 /* Tracepoint list commands */
263 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
264 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
266 /* Event FD commands */
267 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
269 #define LTTNG_UST_ROOT_HANDLE 0
271 struct lttng_ust_obj
;
282 struct lttng_ust_field_iter entry
;
286 struct lttng_ust_objd_ops
{
287 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
288 union ust_args
*args
, void *owner
);
289 int (*release
)(int objd
);
292 /* Create root handle. Always ID 0. */
293 int lttng_abi_create_root_handle(void);
295 const struct lttng_ust_objd_ops
*objd_ops(int id
);
296 int lttng_ust_objd_unref(int id
);
298 void lttng_ust_abi_exit(void);
299 void lttng_ust_events_exit(void);
300 void lttng_ust_objd_table_owner_cleanup(void *owner
);
302 #endif /* _LTTNG_UST_ABI_H */