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 <sys/types.h>
24 #include "lttng-ust-abi.h"
26 #ifndef LTTNG_UST_UUID_LEN
27 #define LTTNG_UST_UUID_LEN 16
30 /* Default unix socket path */
31 #define LTTNG_UST_SOCK_FILENAME \
33 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
36 * Shared memory files path are automatically related to shm root, e.g.
37 * /dev/shm under linux.
39 #define LTTNG_UST_WAIT_FILENAME \
41 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
43 struct lttng_ust_shm_handle
;
44 struct lttng_ust_lib_ring_buffer
;
46 struct ustctl_consumer_channel_attr
{
47 enum lttng_ust_chan_type type
;
48 uint64_t subbuf_size
; /* bytes, power of 2 */
49 uint64_t num_subbuf
; /* power of 2 */
50 int overwrite
; /* 1: overwrite, 0: discard */
51 unsigned int switch_timer_interval
; /* usec */
52 unsigned int read_timer_interval
; /* usec */
53 enum lttng_ust_output output
; /* splice, mmap */
54 uint32_t chan_id
; /* channel ID */
55 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
56 int64_t blocking_timeout
; /* Retry timeout (usec) */
60 * API used by sessiond.
63 struct lttng_ust_context_attr
{
64 enum lttng_ust_context_type ctx
;
66 struct lttng_ust_perf_counter_ctx perf_counter
;
75 * Error values: all the following functions return:
76 * >= 0: Success (LTTNG_UST_OK)
79 int ustctl_register_done(int sock
);
80 int ustctl_create_session(int sock
);
81 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
82 struct lttng_ust_object_data
*channel_data
,
83 struct lttng_ust_object_data
**event_data
);
84 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
85 struct lttng_ust_object_data
*obj_data
,
86 struct lttng_ust_object_data
**context_data
);
87 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
88 struct lttng_ust_object_data
*obj_data
);
90 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
91 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
92 int ustctl_start_session(int sock
, int handle
);
93 int ustctl_stop_session(int sock
, int handle
);
96 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
99 int ustctl_tracepoint_list(int sock
);
102 * ustctl_tracepoint_list_get is used to iterate on the tp list
103 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
106 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
107 struct lttng_ust_tracepoint_iter
*iter
);
110 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
111 * or negative error value.
113 int ustctl_tracepoint_field_list(int sock
);
116 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
117 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
120 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
121 struct lttng_ust_field_iter
*iter
);
123 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
124 int ustctl_wait_quiescent(int sock
);
126 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
128 /* Release object created by members of this API. */
129 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
130 /* Release handle returned by create session. */
131 int ustctl_release_handle(int sock
, int handle
);
133 int ustctl_recv_channel_from_consumer(int sock
,
134 struct lttng_ust_object_data
**channel_data
);
135 int ustctl_recv_stream_from_consumer(int sock
,
136 struct lttng_ust_object_data
**stream_data
);
137 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
138 struct lttng_ust_object_data
*channel_data
);
139 int ustctl_send_stream_to_ust(int sock
,
140 struct lttng_ust_object_data
*channel_data
,
141 struct lttng_ust_object_data
*stream_data
);
144 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
145 * it succeeds (returns 0). It must be released using
146 * ustctl_release_object() and then freed with free().
148 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
149 struct lttng_ust_object_data
*src
);
152 * API used by consumer.
155 struct ustctl_consumer_channel
;
156 struct ustctl_consumer_stream
;
157 struct ustctl_consumer_channel_attr
;
159 struct ustctl_consumer_channel
*
160 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
);
162 * Each stream created needs to be destroyed before calling
163 * ustctl_destroy_channel().
165 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
167 int ustctl_send_channel_to_sessiond(int sock
,
168 struct ustctl_consumer_channel
*channel
);
169 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
170 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
171 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
172 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
174 int ustctl_write_metadata_to_channel(
175 struct ustctl_consumer_channel
*channel
,
176 const char *metadata_str
, /* NOT null-terminated */
177 size_t len
); /* metadata length */
180 * Send a NULL stream to finish iteration over all streams of a given
183 int ustctl_send_stream_to_sessiond(int sock
,
184 struct ustctl_consumer_stream
*stream
);
185 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
186 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
187 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
188 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
190 /* Create/destroy stream buffers for read */
191 struct ustctl_consumer_stream
*
192 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
194 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
196 /* For mmap mode, readable without "get" operation */
197 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
199 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
203 * For mmap mode, operate on the current packet (between get/put or
204 * get_next/put_next).
206 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
207 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
209 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
211 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
213 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
214 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
218 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
219 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
);
220 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
222 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
224 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
226 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
228 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
229 int producer_active
);
231 /* event registry management */
233 enum ustctl_socket_type
{
234 USTCTL_SOCKET_CMD
= 0,
235 USTCTL_SOCKET_NOTIFY
= 1,
238 enum ustctl_notify_cmd
{
239 USTCTL_NOTIFY_CMD_EVENT
= 0,
240 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
241 USTCTL_NOTIFY_CMD_ENUM
= 2,
244 enum ustctl_channel_header
{
245 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
246 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
247 USTCTL_CHANNEL_HEADER_LARGE
= 2,
250 /* event type structures */
252 enum ustctl_abstract_types
{
253 ustctl_atype_integer
,
256 ustctl_atype_sequence
,
259 NR_USTCTL_ABSTRACT_TYPES
,
262 enum ustctl_string_encodings
{
263 ustctl_encode_none
= 0,
264 ustctl_encode_UTF8
= 1,
265 ustctl_encode_ASCII
= 2,
266 NR_USTCTL_STRING_ENCODINGS
,
269 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
270 struct ustctl_integer_type
{
271 uint32_t size
; /* in bits */
273 uint32_t reverse_byte_order
;
274 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
276 uint16_t alignment
; /* in bits */
277 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
280 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
281 struct ustctl_float_type
{
282 uint32_t exp_dig
; /* exponent digits, in bits */
283 uint32_t mant_dig
; /* mantissa digits, in bits */
284 uint32_t reverse_byte_order
;
285 uint16_t alignment
; /* in bits */
286 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
289 #define USTCTL_UST_ENUM_VALUE_PADDING 15
290 struct ustctl_enum_value
{
293 char padding
[USTCTL_UST_ENUM_VALUE_PADDING
];
296 enum ustctl_ust_enum_entry_options
{
297 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
300 #define USTCTL_UST_ENUM_ENTRY_PADDING 32
301 struct ustctl_enum_entry
{
302 struct ustctl_enum_value start
, end
; /* start and end are inclusive */
303 char string
[LTTNG_UST_SYM_NAME_LEN
];
307 } LTTNG_PACKED extra
;
308 char padding
[USTCTL_UST_ENUM_ENTRY_PADDING
];
312 #define USTCTL_UST_BASIC_TYPE_PADDING 296
313 union _ustctl_basic_type
{
314 struct ustctl_integer_type integer
;
318 struct ustctl_float_type _float
;
320 char name
[LTTNG_UST_SYM_NAME_LEN
];
322 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
325 struct ustctl_basic_type
{
326 enum ustctl_abstract_types atype
;
328 union _ustctl_basic_type basic
;
332 #define USTCTL_UST_TYPE_PADDING 128
334 enum ustctl_abstract_types atype
;
336 union _ustctl_basic_type basic
;
338 struct ustctl_basic_type elem_type
;
339 uint32_t length
; /* num. elems. */
342 struct ustctl_basic_type length_type
;
343 struct ustctl_basic_type elem_type
;
345 char padding
[USTCTL_UST_TYPE_PADDING
];
349 #define USTCTL_UST_FIELD_PADDING 28
350 struct ustctl_field
{
351 char name
[LTTNG_UST_SYM_NAME_LEN
];
352 struct ustctl_type type
;
353 char padding
[USTCTL_UST_FIELD_PADDING
];
357 * Returns 0 on success, negative error value on error.
358 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
359 * the output fields are not populated.
361 int ustctl_recv_reg_msg(int sock
,
362 enum ustctl_socket_type
*type
,
369 uint32_t *bits_per_long
,
370 uint32_t *uint8_t_alignment
,
371 uint32_t *uint16_t_alignment
,
372 uint32_t *uint32_t_alignment
,
373 uint32_t *uint64_t_alignment
,
374 uint32_t *long_alignment
,
376 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
379 * Returns 0 on success, negative UST or system error value on error.
380 * Receive the notification command. The "notify_cmd" can then be used
381 * by the caller to find out which ustctl_recv_* function should be
382 * called to receive the notification, and which ustctl_reply_* is
385 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
388 * Returns 0 on success, negative UST or system error value on error.
390 int ustctl_recv_register_event(int sock
,
391 int *session_objd
, /* session descriptor (output) */
392 int *channel_objd
, /* channel descriptor (output) */
394 * event name (output,
395 * size LTTNG_UST_SYM_NAME_LEN)
400 * (output, dynamically
401 * allocated, must be free(3)'d
402 * by the caller if function
406 struct ustctl_field
**fields
,
407 char **model_emf_uri
);
410 * Returns 0 on success, negative error value on error.
412 int ustctl_reply_register_event(int sock
,
413 uint32_t id
, /* event id (input) */
414 int ret_code
); /* return code. 0 ok, negative error */
417 * Returns 0 on success, negative UST or system error value on error.
419 int ustctl_recv_register_enum(int sock
,
422 struct ustctl_enum_entry
**entries
,
423 unsigned int *nr_entries
);
426 * Returns 0 on success, negative error value on error.
428 int ustctl_reply_register_enum(int sock
,
429 int64_t id
, /* enum id (input) */
433 * Returns 0 on success, negative UST or system error value on error.
435 int ustctl_recv_register_channel(int sock
,
436 int *session_objd
, /* session descriptor (output) */
437 int *channel_objd
, /* channel descriptor (output) */
438 size_t *nr_fields
, /* context fields */
439 struct ustctl_field
**fields
);
442 * Returns 0 on success, negative error value on error.
444 int ustctl_reply_register_channel(int sock
,
446 enum ustctl_channel_header header_type
,
447 int ret_code
); /* return code. 0 ok, negative error */
449 #endif /* _LTTNG_UST_CTL_H */