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
25 #include <sys/types.h>
27 #include <lttng/ust-abi.h>
30 #error "LTTNG_PACKED should be defined"
33 #ifndef LTTNG_UST_UUID_LEN
34 #define LTTNG_UST_UUID_LEN 16
37 /* Default unix socket path */
38 #define LTTNG_UST_SOCK_FILENAME \
40 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
43 * Shared memory files path are automatically related to shm root, e.g.
44 * /dev/shm under linux.
46 #define LTTNG_UST_WAIT_FILENAME \
48 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
50 struct lttng_ust_shm_handle
;
51 struct lttng_ust_lib_ring_buffer
;
53 struct ustctl_consumer_channel_attr
{
54 enum lttng_ust_chan_type type
;
55 uint64_t subbuf_size
; /* bytes */
56 uint64_t num_subbuf
; /* power of 2 */
57 int overwrite
; /* 1: overwrite, 0: discard */
58 unsigned int switch_timer_interval
; /* usec */
59 unsigned int read_timer_interval
; /* usec */
60 enum lttng_ust_output output
; /* splice, mmap */
61 uint32_t chan_id
; /* channel ID */
62 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
63 int64_t blocking_timeout
; /* Blocking timeout (usec) */
67 * API used by sessiond.
70 struct lttng_ust_context_attr
{
71 enum lttng_ust_context_type ctx
;
73 struct lttng_ust_perf_counter_ctx perf_counter
;
82 * Error values: all the following functions return:
83 * >= 0: Success (LTTNG_UST_OK)
86 int ustctl_register_done(int sock
);
87 int ustctl_create_session(int sock
);
88 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
89 struct lttng_ust_object_data
*channel_data
,
90 struct lttng_ust_object_data
**event_data
);
91 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
92 struct lttng_ust_object_data
*obj_data
,
93 struct lttng_ust_object_data
**context_data
);
94 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
95 struct lttng_ust_object_data
*obj_data
);
96 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
97 struct lttng_ust_object_data
*obj_data
);
99 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
100 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
101 int ustctl_start_session(int sock
, int handle
);
102 int ustctl_stop_session(int sock
, int handle
);
105 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
108 int ustctl_tracepoint_list(int sock
);
111 * ustctl_tracepoint_list_get is used to iterate on the tp list
112 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
115 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
116 struct lttng_ust_tracepoint_iter
*iter
);
119 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
120 * or negative error value.
122 int ustctl_tracepoint_field_list(int sock
);
125 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
126 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
129 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
130 struct lttng_ust_field_iter
*iter
);
132 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
133 int ustctl_wait_quiescent(int sock
);
135 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
137 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
139 /* Release object created by members of this API. */
140 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
141 /* Release handle returned by create session. */
142 int ustctl_release_handle(int sock
, int handle
);
144 int ustctl_recv_channel_from_consumer(int sock
,
145 struct lttng_ust_object_data
**channel_data
);
146 int ustctl_recv_stream_from_consumer(int sock
,
147 struct lttng_ust_object_data
**stream_data
);
148 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
149 struct lttng_ust_object_data
*channel_data
);
150 int ustctl_send_stream_to_ust(int sock
,
151 struct lttng_ust_object_data
*channel_data
,
152 struct lttng_ust_object_data
*stream_data
);
155 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
156 * it succeeds (returns 0). It must be released using
157 * ustctl_release_object() and then freed with free().
159 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
160 struct lttng_ust_object_data
*src
);
163 * API used by consumer.
166 struct ustctl_consumer_channel
;
167 struct ustctl_consumer_stream
;
168 struct ustctl_consumer_channel_attr
;
170 int ustctl_get_nr_stream_per_channel(void);
172 struct ustctl_consumer_channel
*
173 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
174 const int *stream_fds
, int nr_stream_fds
);
176 * Each stream created needs to be destroyed before calling
177 * ustctl_destroy_channel().
179 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
181 int ustctl_send_channel_to_sessiond(int sock
,
182 struct ustctl_consumer_channel
*channel
);
183 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
184 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
185 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
186 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
188 int ustctl_write_metadata_to_channel(
189 struct ustctl_consumer_channel
*channel
,
190 const char *metadata_str
, /* NOT null-terminated */
191 size_t len
); /* metadata length */
192 ssize_t
ustctl_write_one_packet_to_channel(
193 struct ustctl_consumer_channel
*channel
,
194 const char *metadata_str
, /* NOT null-terminated */
195 size_t len
); /* metadata length */
198 * Send a NULL stream to finish iteration over all streams of a given
201 int ustctl_send_stream_to_sessiond(int sock
,
202 struct ustctl_consumer_stream
*stream
);
203 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
204 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
205 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
206 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
208 /* Create/destroy stream buffers for read */
209 struct ustctl_consumer_stream
*
210 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
212 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
214 /* For mmap mode, readable without "get" operation */
215 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
217 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
221 * For mmap mode, operate on the current packet (between get/put or
222 * get_next/put_next).
224 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
225 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
227 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
229 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
231 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
232 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
236 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
237 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
);
238 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
240 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
242 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
244 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
246 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
247 int producer_active
);
248 void ustctl_clear_buffer(struct ustctl_consumer_stream
*stream
);
253 * Getters which need to be used on the current packet (between get/put
254 * or get_next/put_next.
257 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
258 uint64_t *timestamp_begin
);
259 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
260 uint64_t *timestamp_end
);
261 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
262 uint64_t *events_discarded
);
263 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
264 uint64_t *content_size
);
265 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
266 uint64_t *packet_size
);
267 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
271 * Getter returning state invariant for the stream, which can be used
272 * without "get" operation.
275 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
276 uint64_t *stream_id
);
277 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
281 * Getter returning the current timestamp as perceived from the
284 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
287 /* returns whether UST has perf counters support. */
288 int ustctl_has_perf_counters(void);
290 /* Regenerate the statedump. */
291 int ustctl_regenerate_statedump(int sock
, int handle
);
293 /* event registry management */
295 enum ustctl_socket_type
{
296 USTCTL_SOCKET_CMD
= 0,
297 USTCTL_SOCKET_NOTIFY
= 1,
300 enum ustctl_notify_cmd
{
301 USTCTL_NOTIFY_CMD_EVENT
= 0,
302 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
303 USTCTL_NOTIFY_CMD_ENUM
= 2,
306 enum ustctl_channel_header
{
307 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
308 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
309 USTCTL_CHANNEL_HEADER_LARGE
= 2,
312 /* event type structures */
314 enum ustctl_abstract_types
{
315 ustctl_atype_integer
,
316 ustctl_atype_enum
, /* legacy */
317 ustctl_atype_array
, /* legacy */
318 ustctl_atype_sequence
, /* legacy */
321 ustctl_atype_variant
, /* legacy */
322 ustctl_atype_struct
, /* legacy */
323 ustctl_atype_enum_nestable
,
324 ustctl_atype_array_nestable
,
325 ustctl_atype_sequence_nestable
,
326 ustctl_atype_struct_nestable
,
327 ustctl_atype_variant_nestable
,
328 NR_USTCTL_ABSTRACT_TYPES
,
331 enum ustctl_string_encodings
{
332 ustctl_encode_none
= 0,
333 ustctl_encode_UTF8
= 1,
334 ustctl_encode_ASCII
= 2,
335 NR_USTCTL_STRING_ENCODINGS
,
338 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
339 struct ustctl_integer_type
{
340 uint32_t size
; /* in bits */
342 uint32_t reverse_byte_order
;
343 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
344 int32_t encoding
; /* enum ustctl_string_encodings */
345 uint16_t alignment
; /* in bits */
346 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
349 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
350 struct ustctl_float_type
{
351 uint32_t exp_dig
; /* exponent digits, in bits */
352 uint32_t mant_dig
; /* mantissa digits, in bits */
353 uint32_t reverse_byte_order
;
354 uint16_t alignment
; /* in bits */
355 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
358 #define USTCTL_UST_ENUM_VALUE_PADDING 15
359 struct ustctl_enum_value
{
362 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
365 enum ustctl_ust_enum_entry_options
{
366 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
369 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
370 struct ustctl_enum_entry
{
371 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
372 char string
[LTTNG_UST_SYM_NAME_LEN
];
376 } LTTNG_PACKED extra
;
377 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
382 #define USTCTL_UST_BASIC_TYPE_PADDING 296
383 union _ustctl_basic_type
{
384 struct ustctl_integer_type integer
;
386 char name
[LTTNG_UST_SYM_NAME_LEN
];
387 struct ustctl_integer_type container_type
;
388 uint64_t id
; /* enum ID in sessiond. */
391 int32_t encoding
; /* enum ustctl_string_encodings */
393 struct ustctl_float_type _float
;
394 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
398 struct ustctl_basic_type
{
399 enum ustctl_abstract_types atype
;
401 union _ustctl_basic_type basic
;
406 * Padding is derived from largest member: u.legacy.sequence which
407 * contains two basic types, each with USTCTL_UST_BASIC_TYPE_PADDING.
409 #define USTCTL_UST_TYPE_PADDING (2 * USTCTL_UST_BASIC_TYPE_PADDING)
411 enum ustctl_abstract_types atype
;
413 struct ustctl_integer_type integer
;
414 struct ustctl_float_type _float
;
416 int32_t encoding
; /* enum ustctl_string_encodings */
419 char name
[LTTNG_UST_SYM_NAME_LEN
];
420 uint64_t id
; /* enum ID in sessiond. */
421 /* container_type follows after this struct ustctl_field. */
424 uint32_t length
; /* num. elems. */
426 /* elem_type follows after this struct ustctl_field. */
429 char length_name
[LTTNG_UST_SYM_NAME_LEN
];
430 uint32_t alignment
; /* Alignment before elements. */
431 /* elem_type follows after the length_type. */
436 /* Followed by nr_fields struct ustctl_field. */
440 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
442 /* Followed by nr_choices struct ustctl_field. */
447 union _ustctl_basic_type basic
;
449 struct ustctl_basic_type elem_type
;
450 uint32_t length
; /* num. elems. */
453 struct ustctl_basic_type length_type
;
454 struct ustctl_basic_type elem_type
;
458 /* Followed by nr_fields struct ustctl_field. */
462 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
463 /* Followed by nr_choices struct ustctl_field. */
466 char padding
[USTCTL_UST_TYPE_PADDING
];
470 #define USTCTL_UST_FIELD_PADDING 28
471 struct ustctl_field
{
472 char name
[LTTNG_UST_SYM_NAME_LEN
];
473 struct ustctl_type type
;
474 char padding
[USTCTL_UST_FIELD_PADDING
];
478 * Returns 0 on success, negative error value on error.
479 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
480 * the output fields are not populated.
482 int ustctl_recv_reg_msg(int sock
,
483 enum ustctl_socket_type
*type
,
490 uint32_t *bits_per_long
,
491 uint32_t *uint8_t_alignment
,
492 uint32_t *uint16_t_alignment
,
493 uint32_t *uint32_t_alignment
,
494 uint32_t *uint64_t_alignment
,
495 uint32_t *long_alignment
,
497 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
500 * Returns 0 on success, negative UST or system error value on error.
501 * Receive the notification command. The "notify_cmd" can then be used
502 * by the caller to find out which ustctl_recv_* function should be
503 * called to receive the notification, and which ustctl_reply_* is
506 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
509 * Returns 0 on success, negative UST or system error value on error.
511 int ustctl_recv_register_event(int sock
,
512 int *session_objd
, /* session descriptor (output) */
513 int *channel_objd
, /* channel descriptor (output) */
515 * event name (output,
516 * size LTTNG_UST_SYM_NAME_LEN)
521 * (output, dynamically
522 * allocated, must be free(3)'d
523 * by the caller if function
527 struct ustctl_field
**fields
,
528 char **model_emf_uri
);
531 * Returns 0 on success, negative error value on error.
533 int ustctl_reply_register_event(int sock
,
534 uint32_t id
, /* event id (input) */
535 int ret_code
); /* return code. 0 ok, negative error */
538 * Returns 0 on success, negative UST or system error value on error.
540 int ustctl_recv_register_enum(int sock
,
543 struct ustctl_enum_entry
**entries
,
547 * Returns 0 on success, negative error value on error.
549 int ustctl_reply_register_enum(int sock
,
550 uint64_t id
, /* enum id (input) */
554 * Returns 0 on success, negative UST or system error value on error.
556 int ustctl_recv_register_channel(int sock
,
557 int *session_objd
, /* session descriptor (output) */
558 int *channel_objd
, /* channel descriptor (output) */
559 size_t *nr_fields
, /* context fields */
560 struct ustctl_field
**fields
);
563 * Returns 0 on success, negative error value on error.
565 int ustctl_reply_register_channel(int sock
,
567 enum ustctl_channel_header header_type
,
568 int ret_code
); /* return code. 0 ok, negative error */
570 #endif /* _LTTNG_UST_CTL_H */