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 */
59 * API used by sessiond.
63 * Error values: all the following functions return:
64 * >= 0: Success (LTTNG_UST_OK)
67 int ustctl_register_done(int sock
);
68 int ustctl_create_session(int sock
);
69 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
70 struct lttng_ust_object_data
*channel_data
,
71 struct lttng_ust_object_data
**event_data
);
72 int ustctl_add_context(int sock
, struct lttng_ust_context
*ctx
,
73 struct lttng_ust_object_data
*obj_data
,
74 struct lttng_ust_object_data
**context_data
);
75 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
76 struct lttng_ust_object_data
*obj_data
);
78 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
79 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
80 int ustctl_start_session(int sock
, int handle
);
81 int ustctl_stop_session(int sock
, int handle
);
84 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
87 int ustctl_tracepoint_list(int sock
);
90 * ustctl_tracepoint_list_get is used to iterate on the tp list
91 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
94 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
95 struct lttng_ust_tracepoint_iter
*iter
);
98 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
99 * or negative error value.
101 int ustctl_tracepoint_field_list(int sock
);
104 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
105 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
108 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
109 struct lttng_ust_field_iter
*iter
);
111 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
112 int ustctl_wait_quiescent(int sock
);
114 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
116 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
118 /* Release object created by members of this API. */
119 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
120 /* Release handle returned by create session. */
121 int ustctl_release_handle(int sock
, int handle
);
123 int ustctl_recv_channel_from_consumer(int sock
,
124 struct lttng_ust_object_data
**channel_data
);
125 int ustctl_recv_stream_from_consumer(int sock
,
126 struct lttng_ust_object_data
**stream_data
);
127 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
128 struct lttng_ust_object_data
*channel_data
);
129 int ustctl_send_stream_to_ust(int sock
,
130 struct lttng_ust_object_data
*channel_data
,
131 struct lttng_ust_object_data
*stream_data
);
134 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
135 * it succeeds (returns 0). It must be released using
136 * ustctl_release_object() and then freed with free().
138 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
139 struct lttng_ust_object_data
*src
);
142 * API used by consumer.
145 struct ustctl_consumer_channel
;
146 struct ustctl_consumer_stream
;
147 struct ustctl_consumer_channel_attr
;
149 struct ustctl_consumer_channel
*
150 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
);
152 * Each stream created needs to be destroyed before calling
153 * ustctl_destroy_channel().
155 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
157 int ustctl_send_channel_to_sessiond(int sock
,
158 struct ustctl_consumer_channel
*channel
);
159 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
160 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
161 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
162 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
164 int ustctl_write_metadata_to_channel(
165 struct ustctl_consumer_channel
*channel
,
166 const char *metadata_str
, /* NOT null-terminated */
167 size_t len
); /* metadata length */
170 * Send a NULL stream to finish iteration over all streams of a given
173 int ustctl_send_stream_to_sessiond(int sock
,
174 struct ustctl_consumer_stream
*stream
);
175 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
176 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
177 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
178 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
180 /* Create/destroy stream buffers for read */
181 struct ustctl_consumer_stream
*
182 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
184 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
186 /* For mmap mode, readable without "get" operation */
187 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
189 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
193 * For mmap mode, operate on the current packet (between get/put or
194 * get_next/put_next).
196 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
197 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
199 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
201 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
203 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
204 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
208 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
209 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
211 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
213 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
215 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
217 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
218 int producer_active
);
220 /* event registry management */
222 enum ustctl_socket_type
{
223 USTCTL_SOCKET_CMD
= 0,
224 USTCTL_SOCKET_NOTIFY
= 1,
227 enum ustctl_notify_cmd
{
228 USTCTL_NOTIFY_CMD_EVENT
= 0,
229 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
232 enum ustctl_channel_header
{
233 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
234 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
235 USTCTL_CHANNEL_HEADER_LARGE
= 2,
238 /* event type structures */
240 enum ustctl_abstract_types
{
241 ustctl_atype_integer
,
244 ustctl_atype_sequence
,
247 NR_USTCTL_ABSTRACT_TYPES
,
250 enum ustctl_string_encodings
{
251 ustctl_encode_none
= 0,
252 ustctl_encode_UTF8
= 1,
253 ustctl_encode_ASCII
= 2,
254 NR_USTCTL_STRING_ENCODINGS
,
257 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
258 struct ustctl_integer_type
{
259 uint32_t size
; /* in bits */
261 uint32_t reverse_byte_order
;
262 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
263 enum ustctl_string_encodings encoding
;
264 uint16_t alignment
; /* in bits */
265 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
268 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
269 struct ustctl_float_type
{
270 uint32_t exp_dig
; /* exponent digits, in bits */
271 uint32_t mant_dig
; /* mantissa digits, in bits */
272 uint32_t reverse_byte_order
;
273 uint16_t alignment
; /* in bits */
274 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
277 #define USTCTL_UST_BASIC_TYPE_PADDING 296
278 union _ustctl_basic_type
{
279 struct ustctl_integer_type integer
;
281 enum ustctl_string_encodings encoding
;
283 struct ustctl_float_type _float
;
284 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
287 struct ustctl_basic_type
{
288 enum ustctl_abstract_types atype
;
290 union _ustctl_basic_type basic
;
294 #define USTCTL_UST_TYPE_PADDING 128
296 enum ustctl_abstract_types atype
;
298 union _ustctl_basic_type basic
;
300 struct ustctl_basic_type elem_type
;
301 uint32_t length
; /* num. elems. */
304 struct ustctl_basic_type length_type
;
305 struct ustctl_basic_type elem_type
;
307 char padding
[USTCTL_UST_TYPE_PADDING
];
311 #define USTCTL_UST_FIELD_PADDING 28
312 struct ustctl_field
{
313 char name
[LTTNG_UST_SYM_NAME_LEN
];
314 struct ustctl_type type
;
315 char padding
[USTCTL_UST_FIELD_PADDING
];
319 * Returns 0 on success, negative error value on error.
320 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
321 * the output fields are not populated.
323 int ustctl_recv_reg_msg(int sock
,
324 enum ustctl_socket_type
*type
,
331 uint32_t *bits_per_long
,
332 uint32_t *uint8_t_alignment
,
333 uint32_t *uint16_t_alignment
,
334 uint32_t *uint32_t_alignment
,
335 uint32_t *uint64_t_alignment
,
336 uint32_t *long_alignment
,
338 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
341 * Returns 0 on success, negative UST or system error value on error.
342 * Receive the notification command. The "notify_cmd" can then be used
343 * by the caller to find out which ustctl_recv_* function should be
344 * called to receive the notification, and which ustctl_reply_* is
347 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
350 * Returns 0 on success, negative UST or system error value on error.
352 int ustctl_recv_register_event(int sock
,
353 int *session_objd
, /* session descriptor (output) */
354 int *channel_objd
, /* channel descriptor (output) */
356 * event name (output,
357 * size LTTNG_UST_SYM_NAME_LEN)
362 * (output, dynamically
363 * allocated, must be free(3)'d
364 * by the caller if function
368 struct ustctl_field
**fields
,
369 char **model_emf_uri
);
372 * Returns 0 on success, negative error value on error.
374 int ustctl_reply_register_event(int sock
,
375 uint32_t id
, /* event id (input) */
376 int ret_code
); /* return code. 0 ok, negative error */
379 * Returns 0 on success, negative UST or system error value on error.
381 int ustctl_recv_register_channel(int sock
,
382 int *session_objd
, /* session descriptor (output) */
383 int *channel_objd
, /* channel descriptor (output) */
384 size_t *nr_fields
, /* context fields */
385 struct ustctl_field
**fields
);
388 * Returns 0 on success, negative error value on error.
390 int ustctl_reply_register_channel(int sock
,
392 enum ustctl_channel_header header_type
,
393 int ret_code
); /* return code. 0 ok, negative error */
395 #endif /* _LTTNG_UST_CTL_H */