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 <lttng/ust-abi.h>
23 #include <sys/types.h>
27 #error "LTTNG_PACKED should be defined"
34 #ifndef LTTNG_UST_UUID_LEN
35 #define LTTNG_UST_UUID_LEN 16
38 /* Default unix socket path */
39 #define LTTNG_UST_SOCK_FILENAME \
41 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
44 * Shared memory files path are automatically related to shm root, e.g.
45 * /dev/shm under linux.
47 #define LTTNG_UST_WAIT_FILENAME \
49 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
51 struct lttng_ust_shm_handle
;
52 struct lttng_ust_lib_ring_buffer
;
54 struct ustctl_consumer_channel_attr
{
55 enum lttng_ust_chan_type type
;
56 uint64_t subbuf_size
; /* bytes */
57 uint64_t num_subbuf
; /* power of 2 */
58 int overwrite
; /* 1: overwrite, 0: discard */
59 unsigned int switch_timer_interval
; /* usec */
60 unsigned int read_timer_interval
; /* usec */
61 enum lttng_ust_output output
; /* splice, mmap */
62 uint32_t chan_id
; /* channel ID */
63 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
64 int64_t blocking_timeout
; /* Blocking timeout (usec) */
68 * API used by sessiond.
71 struct lttng_ust_context_attr
{
72 enum lttng_ust_context_type ctx
;
74 struct lttng_ust_perf_counter_ctx perf_counter
;
83 * Error values: all the following functions return:
84 * >= 0: Success (LTTNG_UST_OK)
87 int ustctl_register_done(int sock
);
88 int ustctl_create_session(int sock
);
89 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
90 struct lttng_ust_object_data
*channel_data
,
91 struct lttng_ust_object_data
**event_data
);
92 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
93 struct lttng_ust_object_data
*obj_data
,
94 struct lttng_ust_object_data
**context_data
);
95 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
96 struct lttng_ust_object_data
*obj_data
);
97 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
98 struct lttng_ust_object_data
*obj_data
);
100 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
101 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
102 int ustctl_start_session(int sock
, int handle
);
103 int ustctl_stop_session(int sock
, int handle
);
106 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
109 int ustctl_tracepoint_list(int sock
);
112 * ustctl_tracepoint_list_get is used to iterate on the tp list
113 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
116 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
117 struct lttng_ust_tracepoint_iter
*iter
);
120 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
121 * or negative error value.
123 int ustctl_tracepoint_field_list(int sock
);
126 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
127 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
130 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
131 struct lttng_ust_field_iter
*iter
);
133 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
134 int ustctl_wait_quiescent(int sock
);
136 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
138 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
140 /* Release object created by members of this API. */
141 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
142 /* Release handle returned by create session. */
143 int ustctl_release_handle(int sock
, int handle
);
145 int ustctl_recv_channel_from_consumer(int sock
,
146 struct lttng_ust_object_data
**channel_data
);
147 int ustctl_recv_stream_from_consumer(int sock
,
148 struct lttng_ust_object_data
**stream_data
);
149 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
150 struct lttng_ust_object_data
*channel_data
);
151 int ustctl_send_stream_to_ust(int sock
,
152 struct lttng_ust_object_data
*channel_data
,
153 struct lttng_ust_object_data
*stream_data
);
156 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
157 * it succeeds (returns 0). It must be released using
158 * ustctl_release_object() and then freed with free().
160 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
161 struct lttng_ust_object_data
*src
);
164 * API used by consumer.
167 struct ustctl_consumer_channel
;
168 struct ustctl_consumer_stream
;
169 struct ustctl_consumer_channel_attr
;
171 int ustctl_get_nr_stream_per_channel(void);
173 struct ustctl_consumer_channel
*
174 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
175 const int *stream_fds
, int nr_stream_fds
);
177 * Each stream created needs to be destroyed before calling
178 * ustctl_destroy_channel().
180 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
182 int ustctl_send_channel_to_sessiond(int sock
,
183 struct ustctl_consumer_channel
*channel
);
184 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
185 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
186 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
187 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
189 int ustctl_write_metadata_to_channel(
190 struct ustctl_consumer_channel
*channel
,
191 const char *metadata_str
, /* NOT null-terminated */
192 size_t len
); /* metadata length */
193 ssize_t
ustctl_write_one_packet_to_channel(
194 struct ustctl_consumer_channel
*channel
,
195 const char *metadata_str
, /* NOT null-terminated */
196 size_t len
); /* metadata length */
199 * Send a NULL stream to finish iteration over all streams of a given
202 int ustctl_send_stream_to_sessiond(int sock
,
203 struct ustctl_consumer_stream
*stream
);
204 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
205 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
206 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
207 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
209 /* Create/destroy stream buffers for read */
210 struct ustctl_consumer_stream
*
211 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
213 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
215 /* For mmap mode, readable without "get" operation */
216 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
218 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
222 * For mmap mode, operate on the current packet (between get/put or
223 * get_next/put_next).
225 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
226 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
228 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
230 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
232 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
233 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
237 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
238 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
);
239 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
241 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
243 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
245 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
247 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
248 int producer_active
);
249 void ustctl_clear_buffer(struct ustctl_consumer_stream
*stream
);
254 * Getters which need to be used on the current packet (between get/put
255 * or get_next/put_next.
258 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
259 uint64_t *timestamp_begin
);
260 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
261 uint64_t *timestamp_end
);
262 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
263 uint64_t *events_discarded
);
264 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
265 uint64_t *content_size
);
266 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
267 uint64_t *packet_size
);
268 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
272 * Getter returning state invariant for the stream, which can be used
273 * without "get" operation.
276 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
277 uint64_t *stream_id
);
278 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
282 * Getter returning the current timestamp as perceived from the
285 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
288 /* returns whether UST has perf counters support. */
289 int ustctl_has_perf_counters(void);
291 /* Regenerate the statedump. */
292 int ustctl_regenerate_statedump(int sock
, int handle
);
294 /* event registry management */
296 enum ustctl_socket_type
{
297 USTCTL_SOCKET_CMD
= 0,
298 USTCTL_SOCKET_NOTIFY
= 1,
301 enum ustctl_notify_cmd
{
302 USTCTL_NOTIFY_CMD_EVENT
= 0,
303 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
304 USTCTL_NOTIFY_CMD_ENUM
= 2,
307 enum ustctl_channel_header
{
308 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
309 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
310 USTCTL_CHANNEL_HEADER_LARGE
= 2,
313 /* event type structures */
315 enum ustctl_abstract_types
{
316 ustctl_atype_integer
,
319 ustctl_atype_sequence
,
322 ustctl_atype_variant
,
324 NR_USTCTL_ABSTRACT_TYPES
,
327 enum ustctl_string_encodings
{
328 ustctl_encode_none
= 0,
329 ustctl_encode_UTF8
= 1,
330 ustctl_encode_ASCII
= 2,
331 NR_USTCTL_STRING_ENCODINGS
,
334 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
335 struct ustctl_integer_type
{
336 uint32_t size
; /* in bits */
338 uint32_t reverse_byte_order
;
339 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
340 int32_t encoding
; /* enum ustctl_string_encodings */
341 uint16_t alignment
; /* in bits */
342 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
345 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
346 struct ustctl_float_type
{
347 uint32_t exp_dig
; /* exponent digits, in bits */
348 uint32_t mant_dig
; /* mantissa digits, in bits */
349 uint32_t reverse_byte_order
;
350 uint16_t alignment
; /* in bits */
351 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
354 #define USTCTL_UST_ENUM_VALUE_PADDING 15
355 struct ustctl_enum_value
{
358 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
361 enum ustctl_ust_enum_entry_options
{
362 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
365 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
366 struct ustctl_enum_entry
{
367 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
368 char string
[LTTNG_UST_SYM_NAME_LEN
];
372 } LTTNG_PACKED extra
;
373 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
377 #define USTCTL_UST_BASIC_TYPE_PADDING 296
378 union _ustctl_basic_type
{
379 struct ustctl_integer_type integer
;
381 char name
[LTTNG_UST_SYM_NAME_LEN
];
382 struct ustctl_integer_type container_type
;
383 uint64_t id
; /* enum ID in sessiond. */
386 int32_t encoding
; /* enum ustctl_string_encodings */
388 struct ustctl_float_type _float
;
389 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
392 struct ustctl_basic_type
{
393 enum ustctl_abstract_types atype
;
395 union _ustctl_basic_type basic
;
399 #define USTCTL_UST_TYPE_PADDING 128
401 enum ustctl_abstract_types atype
;
403 union _ustctl_basic_type basic
;
405 struct ustctl_basic_type elem_type
;
406 uint32_t length
; /* num. elems. */
409 struct ustctl_basic_type length_type
;
410 struct ustctl_basic_type elem_type
;
414 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
415 /* Followed by nr_choices struct ustctl_field. */
419 /* Followed by nr_fields struct ustctl_field. */
421 char padding
[USTCTL_UST_TYPE_PADDING
];
425 #define USTCTL_UST_FIELD_PADDING 28
426 struct ustctl_field
{
427 char name
[LTTNG_UST_SYM_NAME_LEN
];
428 struct ustctl_type type
;
429 char padding
[USTCTL_UST_FIELD_PADDING
];
433 * Returns 0 on success, negative error value on error.
434 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
435 * the output fields are not populated.
437 int ustctl_recv_reg_msg(int sock
,
438 enum ustctl_socket_type
*type
,
445 uint32_t *bits_per_long
,
446 uint32_t *uint8_t_alignment
,
447 uint32_t *uint16_t_alignment
,
448 uint32_t *uint32_t_alignment
,
449 uint32_t *uint64_t_alignment
,
450 uint32_t *long_alignment
,
452 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
455 * Returns 0 on success, negative UST or system error value on error.
456 * Receive the notification command. The "notify_cmd" can then be used
457 * by the caller to find out which ustctl_recv_* function should be
458 * called to receive the notification, and which ustctl_reply_* is
461 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
464 * Returns 0 on success, negative UST or system error value on error.
466 int ustctl_recv_register_event(int sock
,
467 int *session_objd
, /* session descriptor (output) */
468 int *channel_objd
, /* channel descriptor (output) */
470 * event name (output,
471 * size LTTNG_UST_SYM_NAME_LEN)
476 * (output, dynamically
477 * allocated, must be free(3)'d
478 * by the caller if function
482 struct ustctl_field
**fields
,
483 char **model_emf_uri
);
486 * Returns 0 on success, negative error value on error.
488 int ustctl_reply_register_event(int sock
,
489 uint32_t id
, /* event id (input) */
490 int ret_code
); /* return code. 0 ok, negative error */
493 * Returns 0 on success, negative UST or system error value on error.
495 int ustctl_recv_register_enum(int sock
,
498 struct ustctl_enum_entry
**entries
,
502 * Returns 0 on success, negative error value on error.
504 int ustctl_reply_register_enum(int sock
,
505 uint64_t id
, /* enum id (input) */
509 * Returns 0 on success, negative UST or system error value on error.
511 int ustctl_recv_register_channel(int sock
,
512 int *session_objd
, /* session descriptor (output) */
513 int *channel_objd
, /* channel descriptor (output) */
514 size_t *nr_fields
, /* context fields */
515 struct ustctl_field
**fields
);
518 * Returns 0 on success, negative error value on error.
520 int ustctl_reply_register_channel(int sock
,
522 enum ustctl_channel_header header_type
,
523 int ret_code
); /* return code. 0 ok, negative error */
529 #endif /* _LTTNG_UST_CTL_H */