2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
9 #ifndef LTTNG_UST_CTL_INTERNAL_H
10 #define LTTNG_UST_CTL_INTERNAL_H
12 #include <sys/types.h>
15 #include "lttng-ust-abi.h"
17 #ifndef LTTNG_UST_UUID_LEN
18 #define LTTNG_UST_UUID_LEN 16
21 /* Default unix socket path */
22 #define LTTNG_UST_SOCK_FILENAME \
24 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
27 * Shared memory files path are automatically related to shm root, e.g.
28 * /dev/shm under linux.
30 #define LTTNG_UST_WAIT_FILENAME \
32 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
34 struct lttng_ust_shm_handle
;
35 struct lttng_ust_lib_ring_buffer
;
37 struct ustctl_consumer_channel_attr
{
38 enum lttng_ust_chan_type type
;
39 uint64_t subbuf_size
; /* bytes */
40 uint64_t num_subbuf
; /* power of 2 */
41 int overwrite
; /* 1: overwrite, 0: discard */
42 unsigned int switch_timer_interval
; /* usec */
43 unsigned int read_timer_interval
; /* usec */
44 enum lttng_ust_output output
; /* splice, mmap */
45 uint32_t chan_id
; /* channel ID */
46 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
47 int64_t blocking_timeout
; /* Blocking timeout (usec) */
51 * API used by sessiond.
54 struct lttng_ust_context_attr
{
55 enum lttng_ust_context_type ctx
;
57 struct lttng_ust_perf_counter_ctx perf_counter
;
66 * Error values: all the following functions return:
67 * >= 0: Success (LTTNG_UST_OK)
70 int ustctl_register_done(int sock
);
71 int ustctl_create_session(int sock
);
72 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
73 struct lttng_ust_object_data
*channel_data
,
74 struct lttng_ust_object_data
**event_data
);
75 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
76 struct lttng_ust_object_data
*obj_data
,
77 struct lttng_ust_object_data
**context_data
);
78 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
79 struct lttng_ust_object_data
*obj_data
);
80 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
81 struct lttng_ust_object_data
*obj_data
);
83 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
84 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
85 int ustctl_start_session(int sock
, int handle
);
86 int ustctl_stop_session(int sock
, int handle
);
89 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
92 int ustctl_tracepoint_list(int sock
);
95 * ustctl_tracepoint_list_get is used to iterate on the tp list
96 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
99 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
100 struct lttng_ust_tracepoint_iter
*iter
);
103 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
104 * or negative error value.
106 int ustctl_tracepoint_field_list(int sock
);
109 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
110 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
113 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
114 struct lttng_ust_field_iter
*iter
);
116 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
117 int ustctl_wait_quiescent(int sock
);
119 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
121 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
123 /* Release object created by members of this API. */
124 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
125 /* Release handle returned by create session. */
126 int ustctl_release_handle(int sock
, int handle
);
128 int ustctl_recv_channel_from_consumer(int sock
,
129 struct lttng_ust_object_data
**channel_data
);
130 int ustctl_recv_stream_from_consumer(int sock
,
131 struct lttng_ust_object_data
**stream_data
);
132 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
133 struct lttng_ust_object_data
*channel_data
);
134 int ustctl_send_stream_to_ust(int sock
,
135 struct lttng_ust_object_data
*channel_data
,
136 struct lttng_ust_object_data
*stream_data
);
139 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
140 * it succeeds (returns 0). It must be released using
141 * ustctl_release_object() and then freed with free().
143 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
144 struct lttng_ust_object_data
*src
);
147 * API used by consumer.
150 struct ustctl_consumer_channel
;
151 struct ustctl_consumer_stream
;
152 struct ustctl_consumer_channel_attr
;
154 int ustctl_get_nr_stream_per_channel(void);
156 struct ustctl_consumer_channel
*
157 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
158 const int *stream_fds
, int nr_stream_fds
);
160 * Each stream created needs to be destroyed before calling
161 * ustctl_destroy_channel().
163 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
165 int ustctl_send_channel_to_sessiond(int sock
,
166 struct ustctl_consumer_channel
*channel
);
167 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
168 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
169 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
170 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
172 int ustctl_write_metadata_to_channel(
173 struct ustctl_consumer_channel
*channel
,
174 const char *metadata_str
, /* NOT null-terminated */
175 size_t len
); /* metadata length */
176 ssize_t
ustctl_write_one_packet_to_channel(
177 struct ustctl_consumer_channel
*channel
,
178 const char *metadata_str
, /* NOT null-terminated */
179 size_t len
); /* metadata length */
182 * Send a NULL stream to finish iteration over all streams of a given
185 int ustctl_send_stream_to_sessiond(int sock
,
186 struct ustctl_consumer_stream
*stream
);
187 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
188 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
189 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
190 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
192 /* Create/destroy stream buffers for read */
193 struct ustctl_consumer_stream
*
194 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
196 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
198 /* For mmap mode, readable without "get" operation */
199 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
201 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
205 * For mmap mode, operate on the current packet (between get/put or
206 * get_next/put_next).
208 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
209 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
211 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
213 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
215 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
216 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
220 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
221 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
);
222 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
224 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
226 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
228 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
230 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
231 int producer_active
);
234 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
235 uint64_t *timestamp_begin
);
236 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
237 uint64_t *timestamp_end
);
238 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
239 uint64_t *events_discarded
);
240 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
241 uint64_t *content_size
);
242 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
243 uint64_t *packet_size
);
244 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
245 uint64_t *stream_id
);
246 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
248 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
250 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
253 /* returns whether UST has perf counters support. */
254 int ustctl_has_perf_counters(void);
256 /* Regenerate the statedump. */
257 int ustctl_regenerate_statedump(int sock
, int handle
);
259 /* event registry management */
261 enum ustctl_socket_type
{
262 USTCTL_SOCKET_CMD
= 0,
263 USTCTL_SOCKET_NOTIFY
= 1,
266 enum ustctl_notify_cmd
{
267 USTCTL_NOTIFY_CMD_EVENT
= 0,
268 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
269 USTCTL_NOTIFY_CMD_ENUM
= 2,
272 enum ustctl_channel_header
{
273 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
274 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
275 USTCTL_CHANNEL_HEADER_LARGE
= 2,
278 /* event type structures */
280 enum ustctl_abstract_types
{
281 ustctl_atype_integer
,
284 ustctl_atype_sequence
,
287 ustctl_atype_variant
,
289 NR_USTCTL_ABSTRACT_TYPES
,
292 enum ustctl_string_encodings
{
293 ustctl_encode_none
= 0,
294 ustctl_encode_UTF8
= 1,
295 ustctl_encode_ASCII
= 2,
296 NR_USTCTL_STRING_ENCODINGS
,
299 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
300 struct ustctl_integer_type
{
301 uint32_t size
; /* in bits */
303 uint32_t reverse_byte_order
;
304 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
305 int32_t encoding
; /* enum ustctl_string_encodings */
306 uint16_t alignment
; /* in bits */
307 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
310 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
311 struct ustctl_float_type
{
312 uint32_t exp_dig
; /* exponent digits, in bits */
313 uint32_t mant_dig
; /* mantissa digits, in bits */
314 uint32_t reverse_byte_order
;
315 uint16_t alignment
; /* in bits */
316 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
319 #define USTCTL_UST_ENUM_VALUE_PADDING 15
320 struct ustctl_enum_value
{
323 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
326 enum ustctl_ust_enum_entry_options
{
327 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
330 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
331 struct ustctl_enum_entry
{
332 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
333 char string
[LTTNG_UST_SYM_NAME_LEN
];
337 } LTTNG_PACKED extra
;
338 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
342 #define USTCTL_UST_BASIC_TYPE_PADDING 296
343 union _ustctl_basic_type
{
344 struct ustctl_integer_type integer
;
346 char name
[LTTNG_UST_SYM_NAME_LEN
];
347 struct ustctl_integer_type container_type
;
348 uint64_t id
; /* enum ID in sessiond. */
351 int32_t encoding
; /* enum ustctl_string_encodings */
353 struct ustctl_float_type _float
;
354 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
357 struct ustctl_basic_type
{
358 enum ustctl_abstract_types atype
;
360 union _ustctl_basic_type basic
;
364 #define USTCTL_UST_TYPE_PADDING 128
366 enum ustctl_abstract_types atype
;
368 union _ustctl_basic_type basic
;
370 struct ustctl_basic_type elem_type
;
371 uint32_t length
; /* num. elems. */
374 struct ustctl_basic_type length_type
;
375 struct ustctl_basic_type elem_type
;
379 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
380 /* Followed by nr_choices struct ustctl_field. */
384 /* Followed by nr_fields struct ustctl_field. */
386 char padding
[USTCTL_UST_TYPE_PADDING
];
390 #define USTCTL_UST_FIELD_PADDING 28
391 struct ustctl_field
{
392 char name
[LTTNG_UST_SYM_NAME_LEN
];
393 struct ustctl_type type
;
394 char padding
[USTCTL_UST_FIELD_PADDING
];
398 * Returns 0 on success, negative error value on error.
399 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
400 * the output fields are not populated.
402 int ustctl_recv_reg_msg(int sock
,
403 enum ustctl_socket_type
*type
,
410 uint32_t *bits_per_long
,
411 uint32_t *uint8_t_alignment
,
412 uint32_t *uint16_t_alignment
,
413 uint32_t *uint32_t_alignment
,
414 uint32_t *uint64_t_alignment
,
415 uint32_t *long_alignment
,
417 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
420 * Returns 0 on success, negative UST or system error value on error.
421 * Receive the notification command. The "notify_cmd" can then be used
422 * by the caller to find out which ustctl_recv_* function should be
423 * called to receive the notification, and which ustctl_reply_* is
426 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
429 * Returns 0 on success, negative UST or system error value on error.
431 int ustctl_recv_register_event(int sock
,
432 int *session_objd
, /* session descriptor (output) */
433 int *channel_objd
, /* channel descriptor (output) */
435 * event name (output,
436 * size LTTNG_UST_SYM_NAME_LEN)
441 * (output, dynamically
442 * allocated, must be free(3)'d
443 * by the caller if function
447 struct ustctl_field
**fields
,
448 char **model_emf_uri
);
451 * Returns 0 on success, negative error value on error.
453 int ustctl_reply_register_event(int sock
,
454 uint32_t id
, /* event id (input) */
455 int ret_code
); /* return code. 0 ok, negative error */
458 * Returns 0 on success, negative UST or system error value on error.
460 int ustctl_recv_register_enum(int sock
,
463 struct ustctl_enum_entry
**entries
,
467 * Returns 0 on success, negative error value on error.
469 int ustctl_reply_register_enum(int sock
,
470 uint64_t id
, /* enum id (input) */
474 * Returns 0 on success, negative UST or system error value on error.
476 int ustctl_recv_register_channel(int sock
,
477 int *session_objd
, /* session descriptor (output) */
478 int *channel_objd
, /* channel descriptor (output) */
479 size_t *nr_fields
, /* context fields */
480 struct ustctl_field
**fields
);
483 * Returns 0 on success, negative error value on error.
485 int ustctl_reply_register_channel(int sock
,
487 enum ustctl_channel_header header_type
,
488 int ret_code
); /* return code. 0 ok, negative error */
490 #endif /* LTTNG_UST_CTL_INTERNAL_H */