2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License only.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #ifndef _LTTNG_UST_CTL_H
20 #define _LTTNG_UST_CTL_H
22 #include <sys/types.h>
24 #include "lttng-ust-abi.h"
26 #ifndef LTTNG_UST_UUID_LEN
27 #define LTTNG_UST_UUID_LEN 16
30 /* Default unix socket path */
31 #define LTTNG_UST_SOCK_FILENAME \
33 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
36 * Shared memory files path are automatically related to shm root, e.g.
37 * /dev/shm under linux.
39 #define LTTNG_UST_WAIT_FILENAME \
41 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
43 struct lttng_ust_shm_handle
;
44 struct lttng_ust_lib_ring_buffer
;
46 struct ustctl_consumer_channel_attr
{
47 enum lttng_ust_chan_type type
;
48 uint64_t subbuf_size
; /* bytes, power of 2 */
49 uint64_t num_subbuf
; /* power of 2 */
50 int overwrite
; /* 1: overwrite, 0: discard */
51 unsigned int switch_timer_interval
; /* usec */
52 unsigned int read_timer_interval
; /* usec */
53 enum lttng_ust_output output
; /* splice, mmap */
54 uint32_t chan_id
; /* channel ID */
55 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
59 * API used by sessiond.
62 struct lttng_ust_context_attr
{
63 enum lttng_ust_context_type ctx
;
65 struct lttng_ust_perf_counter_ctx perf_counter
;
74 * Error values: all the following functions return:
75 * >= 0: Success (LTTNG_UST_OK)
78 int ustctl_register_done(int sock
);
79 int ustctl_create_session(int sock
);
80 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
81 struct lttng_ust_object_data
*channel_data
,
82 struct lttng_ust_object_data
**event_data
);
83 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
84 struct lttng_ust_object_data
*obj_data
,
85 struct lttng_ust_object_data
**context_data
);
86 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
87 struct lttng_ust_object_data
*obj_data
);
89 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
90 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
91 int ustctl_start_session(int sock
, int handle
);
92 int ustctl_stop_session(int sock
, int handle
);
95 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
98 int ustctl_tracepoint_list(int sock
);
101 * ustctl_tracepoint_list_get is used to iterate on the tp list
102 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
105 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
106 struct lttng_ust_tracepoint_iter
*iter
);
109 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
110 * or negative error value.
112 int ustctl_tracepoint_field_list(int sock
);
115 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
116 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
119 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
120 struct lttng_ust_field_iter
*iter
);
122 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
123 int ustctl_wait_quiescent(int sock
);
125 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
127 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
129 /* Release object created by members of this API. */
130 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
131 /* Release handle returned by create session. */
132 int ustctl_release_handle(int sock
, int handle
);
134 int ustctl_recv_channel_from_consumer(int sock
,
135 struct lttng_ust_object_data
**channel_data
);
136 int ustctl_recv_stream_from_consumer(int sock
,
137 struct lttng_ust_object_data
**stream_data
);
138 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
139 struct lttng_ust_object_data
*channel_data
);
140 int ustctl_send_stream_to_ust(int sock
,
141 struct lttng_ust_object_data
*channel_data
,
142 struct lttng_ust_object_data
*stream_data
);
145 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
146 * it succeeds (returns 0). It must be released using
147 * ustctl_release_object() and then freed with free().
149 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
150 struct lttng_ust_object_data
*src
);
153 * API used by consumer.
156 struct ustctl_consumer_channel
;
157 struct ustctl_consumer_stream
;
158 struct ustctl_consumer_channel_attr
;
160 struct ustctl_consumer_channel
*
161 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
);
163 * Each stream created needs to be destroyed before calling
164 * ustctl_destroy_channel().
166 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
168 int ustctl_send_channel_to_sessiond(int sock
,
169 struct ustctl_consumer_channel
*channel
);
170 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
171 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
172 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
173 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
175 int ustctl_write_metadata_to_channel(
176 struct ustctl_consumer_channel
*channel
,
177 const char *metadata_str
, /* NOT null-terminated */
178 size_t len
); /* metadata length */
181 * Send a NULL stream to finish iteration over all streams of a given
184 int ustctl_send_stream_to_sessiond(int sock
,
185 struct ustctl_consumer_stream
*stream
);
186 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
187 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
188 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
189 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
191 /* Create/destroy stream buffers for read */
192 struct ustctl_consumer_stream
*
193 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
195 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
197 /* For mmap mode, readable without "get" operation */
198 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
200 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
204 * For mmap mode, operate on the current packet (between get/put or
205 * get_next/put_next).
207 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
208 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
210 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
212 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
214 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
215 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
219 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
220 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
222 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
224 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
226 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
228 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
229 int producer_active
);
231 /* event registry management */
233 enum ustctl_socket_type
{
234 USTCTL_SOCKET_CMD
= 0,
235 USTCTL_SOCKET_NOTIFY
= 1,
238 enum ustctl_notify_cmd
{
239 USTCTL_NOTIFY_CMD_EVENT
= 0,
240 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
241 USTCTL_NOTIFY_CMD_ENUM
= 2,
244 enum ustctl_channel_header
{
245 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
246 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
247 USTCTL_CHANNEL_HEADER_LARGE
= 2,
250 /* event type structures */
252 enum ustctl_abstract_types
{
253 ustctl_atype_integer
,
256 ustctl_atype_sequence
,
259 NR_USTCTL_ABSTRACT_TYPES
,
262 enum ustctl_string_encodings
{
263 ustctl_encode_none
= 0,
264 ustctl_encode_UTF8
= 1,
265 ustctl_encode_ASCII
= 2,
266 NR_USTCTL_STRING_ENCODINGS
,
269 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
270 struct ustctl_integer_type
{
271 uint32_t size
; /* in bits */
273 uint32_t reverse_byte_order
;
274 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
275 enum ustctl_string_encodings encoding
;
276 uint16_t alignment
; /* in bits */
277 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
280 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
281 struct ustctl_float_type
{
282 uint32_t exp_dig
; /* exponent digits, in bits */
283 uint32_t mant_dig
; /* mantissa digits, in bits */
284 uint32_t reverse_byte_order
;
285 uint16_t alignment
; /* in bits */
286 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
289 #define USTCTL_UST_ENUM_VALUE_PADDING 15
290 struct ustctl_enum_value
{
293 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
296 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
297 struct ustctl_enum_entry
{
298 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
299 char string
[LTTNG_UST_SYM_NAME_LEN
];
300 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
303 #define USTCTL_UST_BASIC_TYPE_PADDING 296
304 union _ustctl_basic_type
{
305 struct ustctl_integer_type integer
;
307 enum ustctl_string_encodings encoding
;
309 struct ustctl_float_type _float
;
311 char name
[LTTNG_UST_SYM_NAME_LEN
];
313 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
316 struct ustctl_basic_type
{
317 enum ustctl_abstract_types atype
;
319 union _ustctl_basic_type basic
;
323 #define USTCTL_UST_TYPE_PADDING 128
325 enum ustctl_abstract_types atype
;
327 union _ustctl_basic_type basic
;
329 struct ustctl_basic_type elem_type
;
330 uint32_t length
; /* num. elems. */
333 struct ustctl_basic_type length_type
;
334 struct ustctl_basic_type elem_type
;
336 char padding
[USTCTL_UST_TYPE_PADDING
];
340 #define USTCTL_UST_FIELD_PADDING 28
341 struct ustctl_field
{
342 char name
[LTTNG_UST_SYM_NAME_LEN
];
343 struct ustctl_type type
;
344 char padding
[USTCTL_UST_FIELD_PADDING
];
348 * Returns 0 on success, negative error value on error.
349 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
350 * the output fields are not populated.
352 int ustctl_recv_reg_msg(int sock
,
353 enum ustctl_socket_type
*type
,
360 uint32_t *bits_per_long
,
361 uint32_t *uint8_t_alignment
,
362 uint32_t *uint16_t_alignment
,
363 uint32_t *uint32_t_alignment
,
364 uint32_t *uint64_t_alignment
,
365 uint32_t *long_alignment
,
367 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
370 * Returns 0 on success, negative UST or system error value on error.
371 * Receive the notification command. The "notify_cmd" can then be used
372 * by the caller to find out which ustctl_recv_* function should be
373 * called to receive the notification, and which ustctl_reply_* is
376 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
379 * Returns 0 on success, negative UST or system error value on error.
381 int ustctl_recv_register_event(int sock
,
382 int *session_objd
, /* session descriptor (output) */
383 int *channel_objd
, /* channel descriptor (output) */
385 * event name (output,
386 * size LTTNG_UST_SYM_NAME_LEN)
391 * (output, dynamically
392 * allocated, must be free(3)'d
393 * by the caller if function
397 struct ustctl_field
**fields
,
398 char **model_emf_uri
);
401 * Returns 0 on success, negative error value on error.
403 int ustctl_reply_register_event(int sock
,
404 uint32_t id
, /* event id (input) */
405 int ret_code
); /* return code. 0 ok, negative error */
408 * Returns 0 on success, negative UST or system error value on error.
410 int ustctl_recv_register_enum(int sock
,
413 struct ustctl_enum_entry
**entries
,
414 unsigned int *nr_entries
);
417 * Returns 0 on success, negative error value on error.
419 int ustctl_reply_register_enum(int sock
,
420 int64_t id
, /* enum id (input) */
424 * Returns 0 on success, negative UST or system error value on error.
426 int ustctl_recv_register_channel(int sock
,
427 int *session_objd
, /* session descriptor (output) */
428 int *channel_objd
, /* channel descriptor (output) */
429 size_t *nr_fields
, /* context fields */
430 struct ustctl_field
**fields
);
433 * Returns 0 on success, negative error value on error.
435 int ustctl_reply_register_channel(int sock
,
437 enum ustctl_channel_header header_type
,
438 int ret_code
); /* return code. 0 ok, negative error */
440 #endif /* _LTTNG_UST_CTL_H */