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"
30 #ifndef LTTNG_UST_UUID_LEN
31 #define LTTNG_UST_UUID_LEN 16
34 /* Default unix socket path */
35 #define LTTNG_UST_SOCK_FILENAME \
37 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
40 * Shared memory files path are automatically related to shm root, e.g.
41 * /dev/shm under linux.
43 #define LTTNG_UST_WAIT_FILENAME \
45 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
47 struct lttng_ust_shm_handle
;
48 struct lttng_ust_lib_ring_buffer
;
50 struct ustctl_consumer_channel_attr
{
51 enum lttng_ust_chan_type type
;
52 uint64_t subbuf_size
; /* bytes */
53 uint64_t num_subbuf
; /* power of 2 */
54 int overwrite
; /* 1: overwrite, 0: discard */
55 unsigned int switch_timer_interval
; /* usec */
56 unsigned int read_timer_interval
; /* usec */
57 enum lttng_ust_output output
; /* splice, mmap */
58 uint32_t chan_id
; /* channel ID */
59 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
60 int64_t blocking_timeout
; /* Blocking timeout (usec) */
64 * API used by sessiond.
67 struct lttng_ust_context_attr
{
68 enum lttng_ust_context_type ctx
;
70 struct lttng_ust_perf_counter_ctx perf_counter
;
79 * Error values: all the following functions return:
80 * >= 0: Success (LTTNG_UST_OK)
83 int ustctl_register_done(int sock
);
84 int ustctl_create_session(int sock
);
85 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
86 struct lttng_ust_object_data
*channel_data
,
87 struct lttng_ust_object_data
**event_data
);
88 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
89 struct lttng_ust_object_data
*obj_data
,
90 struct lttng_ust_object_data
**context_data
);
91 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
92 struct lttng_ust_object_data
*obj_data
);
93 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
94 struct lttng_ust_object_data
*obj_data
);
96 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
97 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
98 int ustctl_start_session(int sock
, int handle
);
99 int ustctl_stop_session(int sock
, int handle
);
102 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
105 int ustctl_tracepoint_list(int sock
);
108 * ustctl_tracepoint_list_get is used to iterate on the tp list
109 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
112 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
113 struct lttng_ust_tracepoint_iter
*iter
);
116 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
117 * or negative error value.
119 int ustctl_tracepoint_field_list(int sock
);
122 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
123 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
126 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
127 struct lttng_ust_field_iter
*iter
);
129 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
130 int ustctl_wait_quiescent(int sock
);
132 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
134 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
136 /* Release object created by members of this API. */
137 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
138 /* Release handle returned by create session. */
139 int ustctl_release_handle(int sock
, int handle
);
141 int ustctl_recv_channel_from_consumer(int sock
,
142 struct lttng_ust_object_data
**channel_data
);
143 int ustctl_recv_stream_from_consumer(int sock
,
144 struct lttng_ust_object_data
**stream_data
);
145 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
146 struct lttng_ust_object_data
*channel_data
);
147 int ustctl_send_stream_to_ust(int sock
,
148 struct lttng_ust_object_data
*channel_data
,
149 struct lttng_ust_object_data
*stream_data
);
152 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
153 * it succeeds (returns 0). It must be released using
154 * ustctl_release_object() and then freed with free().
156 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
157 struct lttng_ust_object_data
*src
);
160 * API used by consumer.
163 struct ustctl_consumer_channel
;
164 struct ustctl_consumer_stream
;
165 struct ustctl_consumer_channel_attr
;
167 int ustctl_get_nr_stream_per_channel(void);
169 struct ustctl_consumer_channel
*
170 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
171 const int *stream_fds
, int nr_stream_fds
);
173 * Each stream created needs to be destroyed before calling
174 * ustctl_destroy_channel().
176 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
178 int ustctl_send_channel_to_sessiond(int sock
,
179 struct ustctl_consumer_channel
*channel
);
180 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
181 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
182 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
183 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
185 int ustctl_write_metadata_to_channel(
186 struct ustctl_consumer_channel
*channel
,
187 const char *metadata_str
, /* NOT null-terminated */
188 size_t len
); /* metadata length */
189 ssize_t
ustctl_write_one_packet_to_channel(
190 struct ustctl_consumer_channel
*channel
,
191 const char *metadata_str
, /* NOT null-terminated */
192 size_t len
); /* metadata length */
195 * Send a NULL stream to finish iteration over all streams of a given
198 int ustctl_send_stream_to_sessiond(int sock
,
199 struct ustctl_consumer_stream
*stream
);
200 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
201 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
202 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
203 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
205 /* Create/destroy stream buffers for read */
206 struct ustctl_consumer_stream
*
207 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
209 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
211 /* For mmap mode, readable without "get" operation */
212 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
214 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
218 * For mmap mode, operate on the current packet (between get/put or
219 * get_next/put_next).
221 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
222 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
224 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
226 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
228 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
229 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
233 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
234 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
);
235 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
237 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
239 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
241 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
243 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
244 int producer_active
);
247 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
248 uint64_t *timestamp_begin
);
249 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
250 uint64_t *timestamp_end
);
251 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
252 uint64_t *events_discarded
);
253 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
254 uint64_t *content_size
);
255 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
256 uint64_t *packet_size
);
257 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
258 uint64_t *stream_id
);
259 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
261 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
263 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
266 /* returns whether UST has perf counters support. */
267 int ustctl_has_perf_counters(void);
269 /* Regenerate the statedump. */
270 int ustctl_regenerate_statedump(int sock
, int handle
);
272 /* event registry management */
274 enum ustctl_socket_type
{
275 USTCTL_SOCKET_CMD
= 0,
276 USTCTL_SOCKET_NOTIFY
= 1,
279 enum ustctl_notify_cmd
{
280 USTCTL_NOTIFY_CMD_EVENT
= 0,
281 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
282 USTCTL_NOTIFY_CMD_ENUM
= 2,
285 enum ustctl_channel_header
{
286 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
287 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
288 USTCTL_CHANNEL_HEADER_LARGE
= 2,
291 /* event type structures */
293 enum ustctl_abstract_types
{
294 ustctl_atype_integer
,
297 ustctl_atype_sequence
,
300 ustctl_atype_variant
,
302 NR_USTCTL_ABSTRACT_TYPES
,
305 enum ustctl_string_encodings
{
306 ustctl_encode_none
= 0,
307 ustctl_encode_UTF8
= 1,
308 ustctl_encode_ASCII
= 2,
309 NR_USTCTL_STRING_ENCODINGS
,
312 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
313 struct ustctl_integer_type
{
314 uint32_t size
; /* in bits */
316 uint32_t reverse_byte_order
;
317 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
318 int32_t encoding
; /* enum ustctl_string_encodings */
319 uint16_t alignment
; /* in bits */
320 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
323 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
324 struct ustctl_float_type
{
325 uint32_t exp_dig
; /* exponent digits, in bits */
326 uint32_t mant_dig
; /* mantissa digits, in bits */
327 uint32_t reverse_byte_order
;
328 uint16_t alignment
; /* in bits */
329 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
332 #define USTCTL_UST_ENUM_VALUE_PADDING 15
333 struct ustctl_enum_value
{
336 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
339 enum ustctl_ust_enum_entry_options
{
340 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
343 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
344 struct ustctl_enum_entry
{
345 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
346 char string
[LTTNG_UST_SYM_NAME_LEN
];
350 } LTTNG_PACKED extra
;
351 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
355 #define USTCTL_UST_BASIC_TYPE_PADDING 296
356 union _ustctl_basic_type
{
357 struct ustctl_integer_type integer
;
359 char name
[LTTNG_UST_SYM_NAME_LEN
];
360 struct ustctl_integer_type container_type
;
361 uint64_t id
; /* enum ID in sessiond. */
364 int32_t encoding
; /* enum ustctl_string_encodings */
366 struct ustctl_float_type _float
;
367 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
370 struct ustctl_basic_type
{
371 enum ustctl_abstract_types atype
;
373 union _ustctl_basic_type basic
;
377 #define USTCTL_UST_TYPE_PADDING 128
379 enum ustctl_abstract_types atype
;
381 union _ustctl_basic_type basic
;
383 struct ustctl_basic_type elem_type
;
384 uint32_t length
; /* num. elems. */
387 struct ustctl_basic_type length_type
;
388 struct ustctl_basic_type elem_type
;
392 char tag_name
[LTTNG_UST_SYM_NAME_LEN
];
393 /* Followed by nr_choices struct ustctl_field. */
397 /* Followed by nr_fields struct ustctl_field. */
399 char padding
[USTCTL_UST_TYPE_PADDING
];
403 #define USTCTL_UST_FIELD_PADDING 28
404 struct ustctl_field
{
405 char name
[LTTNG_UST_SYM_NAME_LEN
];
406 struct ustctl_type type
;
407 char padding
[USTCTL_UST_FIELD_PADDING
];
411 * Returns 0 on success, negative error value on error.
412 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
413 * the output fields are not populated.
415 int ustctl_recv_reg_msg(int sock
,
416 enum ustctl_socket_type
*type
,
423 uint32_t *bits_per_long
,
424 uint32_t *uint8_t_alignment
,
425 uint32_t *uint16_t_alignment
,
426 uint32_t *uint32_t_alignment
,
427 uint32_t *uint64_t_alignment
,
428 uint32_t *long_alignment
,
430 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
433 * Returns 0 on success, negative UST or system error value on error.
434 * Receive the notification command. The "notify_cmd" can then be used
435 * by the caller to find out which ustctl_recv_* function should be
436 * called to receive the notification, and which ustctl_reply_* is
439 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
442 * Returns 0 on success, negative UST or system error value on error.
444 int ustctl_recv_register_event(int sock
,
445 int *session_objd
, /* session descriptor (output) */
446 int *channel_objd
, /* channel descriptor (output) */
448 * event name (output,
449 * size LTTNG_UST_SYM_NAME_LEN)
454 * (output, dynamically
455 * allocated, must be free(3)'d
456 * by the caller if function
460 struct ustctl_field
**fields
,
461 char **model_emf_uri
);
464 * Returns 0 on success, negative error value on error.
466 int ustctl_reply_register_event(int sock
,
467 uint32_t id
, /* event id (input) */
468 int ret_code
); /* return code. 0 ok, negative error */
471 * Returns 0 on success, negative UST or system error value on error.
473 int ustctl_recv_register_enum(int sock
,
476 struct ustctl_enum_entry
**entries
,
480 * Returns 0 on success, negative error value on error.
482 int ustctl_reply_register_enum(int sock
,
483 uint64_t id
, /* enum id (input) */
487 * Returns 0 on success, negative UST or system error value on error.
489 int ustctl_recv_register_channel(int sock
,
490 int *session_objd
, /* session descriptor (output) */
491 int *channel_objd
, /* channel descriptor (output) */
492 size_t *nr_fields
, /* context fields */
493 struct ustctl_field
**fields
);
496 * Returns 0 on success, negative error value on error.
498 int ustctl_reply_register_channel(int sock
,
500 enum ustctl_channel_header header_type
,
501 int ret_code
); /* return code. 0 ok, negative error */
503 #endif /* _LTTNG_UST_CTL_H */