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_capture(int sock
, struct lttng_ust_capture_bytecode
*bytecode
,
97 struct lttng_ust_object_data
*obj_data
);
98 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
99 struct lttng_ust_object_data
*obj_data
);
101 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
102 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
103 int ustctl_start_session(int sock
, int handle
);
104 int ustctl_stop_session(int sock
, int handle
);
107 * ustctl_create_trigger_group creates a trigger group. It establishes the
108 * connection with the application by providing a file descriptor of the pipe
109 * to be used by the application when a trigger of that group is fired. It
110 * returns a handle to be used when creating trigger in that group.
112 int ustctl_create_trigger_group(int sock
, int pipe_fd
,
113 struct lttng_ust_object_data
**trigger_group
);
116 * ustctl_create_trigger creates a trigger in a trigger group giving a trigger
117 * description and a trigger group handle. It returns a trigger handle to be
118 * used when enabling the trigger, attaching filter, attaching exclusion, and
119 * disabling the trigger.
121 int ustctl_create_trigger(int sock
, struct lttng_ust_trigger
*trigger
,
122 struct lttng_ust_object_data
*trigger_group
,
123 struct lttng_ust_object_data
**trigger_data
);
126 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
129 int ustctl_tracepoint_list(int sock
);
132 * ustctl_tracepoint_list_get is used to iterate on the tp list
133 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
136 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
137 struct lttng_ust_tracepoint_iter
*iter
);
140 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
141 * or negative error value.
143 int ustctl_tracepoint_field_list(int sock
);
146 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
147 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
150 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
151 struct lttng_ust_field_iter
*iter
);
153 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
154 int ustctl_wait_quiescent(int sock
);
156 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
158 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
160 /* Release object created by members of this API. */
161 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
162 /* Release handle returned by create session. */
163 int ustctl_release_handle(int sock
, int handle
);
165 int ustctl_recv_channel_from_consumer(int sock
,
166 struct lttng_ust_object_data
**channel_data
);
167 int ustctl_recv_stream_from_consumer(int sock
,
168 struct lttng_ust_object_data
**stream_data
);
169 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
170 struct lttng_ust_object_data
*channel_data
);
171 int ustctl_send_stream_to_ust(int sock
,
172 struct lttng_ust_object_data
*channel_data
,
173 struct lttng_ust_object_data
*stream_data
);
176 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
177 * it succeeds (returns 0). It must be released using
178 * ustctl_release_object() and then freed with free().
180 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
181 struct lttng_ust_object_data
*src
);
184 * API used by consumer.
187 struct ustctl_consumer_channel
;
188 struct ustctl_consumer_stream
;
189 struct ustctl_consumer_channel_attr
;
191 int ustctl_get_nr_stream_per_channel(void);
193 struct ustctl_consumer_channel
*
194 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
195 const int *stream_fds
, int nr_stream_fds
);
197 * Each stream created needs to be destroyed before calling
198 * ustctl_destroy_channel().
200 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
202 int ustctl_send_channel_to_sessiond(int sock
,
203 struct ustctl_consumer_channel
*channel
);
204 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
205 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
206 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
207 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
209 int ustctl_write_metadata_to_channel(
210 struct ustctl_consumer_channel
*channel
,
211 const char *metadata_str
, /* NOT null-terminated */
212 size_t len
); /* metadata length */
213 ssize_t
ustctl_write_one_packet_to_channel(
214 struct ustctl_consumer_channel
*channel
,
215 const char *metadata_str
, /* NOT null-terminated */
216 size_t len
); /* metadata length */
219 * Send a NULL stream to finish iteration over all streams of a given
222 int ustctl_send_stream_to_sessiond(int sock
,
223 struct ustctl_consumer_stream
*stream
);
224 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
225 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
226 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
227 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
229 /* Create/destroy stream buffers for read */
230 struct ustctl_consumer_stream
*
231 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
233 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
235 /* For mmap mode, readable without "get" operation */
236 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
238 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
242 * For mmap mode, operate on the current packet (between get/put or
243 * get_next/put_next).
245 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
246 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
248 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
250 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
252 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
253 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
257 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
258 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
);
259 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
261 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
263 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
265 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
267 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
268 int producer_active
);
269 void ustctl_clear_buffer(struct ustctl_consumer_stream
*stream
);
274 * Getters which need to be used on the current packet (between get/put
275 * or get_next/put_next.
278 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
279 uint64_t *timestamp_begin
);
280 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
281 uint64_t *timestamp_end
);
282 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
283 uint64_t *events_discarded
);
284 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
285 uint64_t *content_size
);
286 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
287 uint64_t *packet_size
);
288 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
292 * Getter returning state invariant for the stream, which can be used
293 * without "get" operation.
296 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
297 uint64_t *stream_id
);
298 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
302 * Getter returning the current timestamp as perceived from the
305 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
308 /* returns whether UST has perf counters support. */
309 int ustctl_has_perf_counters(void);
311 /* Regenerate the statedump. */
312 int ustctl_regenerate_statedump(int sock
, int handle
);
314 /* event registry management */
316 enum ustctl_socket_type
{
317 USTCTL_SOCKET_CMD
= 0,
318 USTCTL_SOCKET_NOTIFY
= 1,
321 enum ustctl_notify_cmd
{
322 USTCTL_NOTIFY_CMD_EVENT
= 0,
323 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
324 USTCTL_NOTIFY_CMD_ENUM
= 2,
327 enum ustctl_channel_header
{
328 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
329 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
330 USTCTL_CHANNEL_HEADER_LARGE
= 2,
333 /* event type structures */
335 enum ustctl_abstract_types
{
336 ustctl_atype_integer
,
337 ustctl_atype_enum
, /* legacy */
338 ustctl_atype_array
, /* legacy */
339 ustctl_atype_sequence
, /* legacy */
342 ustctl_atype_variant
, /* legacy */
343 ustctl_atype_struct
, /* legacy */
344 ustctl_atype_enum_nestable
,
345 ustctl_atype_array_nestable
,
346 ustctl_atype_sequence_nestable
,
347 ustctl_atype_struct_nestable
,
348 ustctl_atype_variant_nestable
,
349 NR_USTCTL_ABSTRACT_TYPES
,
352 enum ustctl_string_encodings
{
353 ustctl_encode_none
= 0,
354 ustctl_encode_UTF8
= 1,
355 ustctl_encode_ASCII
= 2,
356 NR_USTCTL_STRING_ENCODINGS
,
359 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
360 struct ustctl_integer_type
{
361 uint32_t size
; /* in bits */
363 uint32_t reverse_byte_order
;
364 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
365 int32_t encoding
; /* enum ustctl_string_encodings */
366 uint16_t alignment
; /* in bits */
367 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
370 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
371 struct ustctl_float_type
{
372 uint32_t exp_dig
; /* exponent digits, in bits */
373 uint32_t mant_dig
; /* mantissa digits, in bits */
374 uint32_t reverse_byte_order
;
375 uint16_t alignment
; /* in bits */
376 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
379 #define USTCTL_UST_ENUM_VALUE_PADDING 15
380 struct ustctl_enum_value
{
383 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
386 enum ustctl_ust_enum_entry_options
{
387 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
390 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
391 struct ustctl_enum_entry
{
392 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
393 char string
[LTTNG_UST_SYM_NAME_LEN
];
397 } LTTNG_PACKED extra
;
398 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
403 #define USTCTL_UST_BASIC_TYPE_PADDING 296
404 union _ustctl_basic_type
{
405 struct ustctl_integer_type integer
;
407 char name
[LTTNG_UST_SYM_NAME_LEN
];
408 struct ustctl_integer_type container_type
;
409 uint64_t id
; /* enum ID in sessiond. */
412 int32_t encoding
; /* enum ustctl_string_encodings */
414 struct ustctl_float_type _float
;
415 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
419 struct ustctl_basic_type
{
420 enum ustctl_abstract_types atype
;
422 union _ustctl_basic_type basic
;
427 * Padding is derived from largest member: u.legacy.sequence which
428 * contains two basic types, each with USTCTL_UST_BASIC_TYPE_PADDING.
430 #define USTCTL_UST_TYPE_PADDING (2 * USTCTL_UST_BASIC_TYPE_PADDING)
432 enum ustctl_abstract_types atype
;
434 struct ustctl_integer_type integer
;
435 struct ustctl_float_type _float
;
437 int32_t encoding
; /* enum ustctl_string_encodings */
440 char name
[LTTNG_UST_SYM_NAME_LEN
];
441 uint64_t id
; /* enum ID in sessiond. */
442 /* container_type follows after this struct ustctl_field. */
445 uint32_t length
; /* num. elems. */
447 /* elem_type follows after this struct ustctl_field. */
450 char length_name
[LTTNG_UST_SYM_NAME_LEN
];
451 uint32_t alignment
; /* Alignment before elements. */
452 /* elem_type follows after the length_type. */
457 /* Followed by nr_fields struct ustctl_field. */
461 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
463 /* Followed by nr_choices struct ustctl_field. */
468 union _ustctl_basic_type basic
;
470 struct ustctl_basic_type elem_type
;
471 uint32_t length
; /* num. elems. */
474 struct ustctl_basic_type length_type
;
475 struct ustctl_basic_type elem_type
;
479 /* Followed by nr_fields struct ustctl_field. */
483 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
484 /* Followed by nr_choices struct ustctl_field. */
487 char padding
[USTCTL_UST_TYPE_PADDING
];
491 #define USTCTL_UST_FIELD_PADDING 28
492 struct ustctl_field
{
493 char name
[LTTNG_UST_SYM_NAME_LEN
];
494 struct ustctl_type type
;
495 char padding
[USTCTL_UST_FIELD_PADDING
];
499 * Returns 0 on success, negative error value on error.
500 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
501 * the output fields are not populated.
503 int ustctl_recv_reg_msg(int sock
,
504 enum ustctl_socket_type
*type
,
511 uint32_t *bits_per_long
,
512 uint32_t *uint8_t_alignment
,
513 uint32_t *uint16_t_alignment
,
514 uint32_t *uint32_t_alignment
,
515 uint32_t *uint64_t_alignment
,
516 uint32_t *long_alignment
,
518 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
521 * Returns 0 on success, negative UST or system error value on error.
522 * Receive the notification command. The "notify_cmd" can then be used
523 * by the caller to find out which ustctl_recv_* function should be
524 * called to receive the notification, and which ustctl_reply_* is
527 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
530 * Returns 0 on success, negative UST or system error value on error.
532 int ustctl_recv_register_event(int sock
,
533 int *session_objd
, /* session descriptor (output) */
534 int *channel_objd
, /* channel descriptor (output) */
536 * event name (output,
537 * size LTTNG_UST_SYM_NAME_LEN)
542 * (output, dynamically
543 * allocated, must be free(3)'d
544 * by the caller if function
548 struct ustctl_field
**fields
,
549 char **model_emf_uri
);
552 * Returns 0 on success, negative error value on error.
554 int ustctl_reply_register_event(int sock
,
555 uint32_t id
, /* event id (input) */
556 int ret_code
); /* return code. 0 ok, negative error */
559 * Returns 0 on success, negative UST or system error value on error.
561 int ustctl_recv_register_enum(int sock
,
564 struct ustctl_enum_entry
**entries
,
568 * Returns 0 on success, negative error value on error.
570 int ustctl_reply_register_enum(int sock
,
571 uint64_t id
, /* enum id (input) */
575 * Returns 0 on success, negative UST or system error value on error.
577 int ustctl_recv_register_channel(int sock
,
578 int *session_objd
, /* session descriptor (output) */
579 int *channel_objd
, /* channel descriptor (output) */
580 size_t *nr_fields
, /* context fields */
581 struct ustctl_field
**fields
);
584 * Returns 0 on success, negative error value on error.
586 int ustctl_reply_register_channel(int sock
,
588 enum ustctl_channel_header header_type
,
589 int ret_code
); /* return code. 0 ok, negative error */
591 #endif /* _LTTNG_UST_CTL_H */