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>
25 #ifndef LTTNG_UST_UUID_LEN
26 #define LTTNG_UST_UUID_LEN 16
29 /* Default unix socket path */
30 #define LTTNG_UST_SOCK_FILENAME \
32 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
35 * Shared memory files path are automatically related to shm root, e.g.
36 * /dev/shm under linux.
38 #define LTTNG_UST_WAIT_FILENAME \
40 __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
42 struct lttng_ust_shm_handle
;
43 struct lttng_ust_lib_ring_buffer
;
45 struct ustctl_consumer_channel_attr
{
46 enum lttng_ust_chan_type type
;
47 uint64_t subbuf_size
; /* bytes */
48 uint64_t num_subbuf
; /* power of 2 */
49 int overwrite
; /* 1: overwrite, 0: discard */
50 unsigned int switch_timer_interval
; /* usec */
51 unsigned int read_timer_interval
; /* usec */
52 enum lttng_ust_output output
; /* splice, mmap */
53 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
57 * API used by sessiond.
61 * Error values: all the following functions return:
62 * >= 0: Success (LTTNG_UST_OK)
65 int ustctl_register_done(int sock
);
66 int ustctl_create_session(int sock
);
67 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
68 struct lttng_ust_object_data
*channel_data
,
69 struct lttng_ust_object_data
**event_data
);
70 int ustctl_add_context(int sock
, struct lttng_ust_context
*ctx
,
71 struct lttng_ust_object_data
*obj_data
,
72 struct lttng_ust_object_data
**context_data
);
73 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
74 struct lttng_ust_object_data
*obj_data
);
76 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
77 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
78 int ustctl_start_session(int sock
, int handle
);
79 int ustctl_stop_session(int sock
, int handle
);
82 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
85 int ustctl_tracepoint_list(int sock
);
88 * ustctl_tracepoint_list_get is used to iterate on the tp list
89 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
92 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
93 struct lttng_ust_tracepoint_iter
*iter
);
96 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
97 * or negative error value.
99 int ustctl_tracepoint_field_list(int sock
);
102 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
103 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
106 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
107 struct lttng_ust_field_iter
*iter
);
109 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
110 int ustctl_wait_quiescent(int sock
);
112 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
114 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
116 /* Release object created by members of this API. */
117 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
118 /* Release handle returned by create session. */
119 int ustctl_release_handle(int sock
, int handle
);
121 int ustctl_recv_channel_from_consumer(int sock
,
122 struct lttng_ust_object_data
**channel_data
);
123 int ustctl_recv_stream_from_consumer(int sock
,
124 struct lttng_ust_object_data
**stream_data
);
125 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
126 struct lttng_ust_object_data
*channel_data
);
127 int ustctl_send_stream_to_ust(int sock
,
128 struct lttng_ust_object_data
*channel_data
,
129 struct lttng_ust_object_data
*stream_data
);
132 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
133 * it succeeds (returns 0). It must be released using
134 * ustctl_release_object() and then freed with free().
136 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
137 struct lttng_ust_object_data
*src
);
140 * API used by consumer.
143 struct ustctl_consumer_channel
;
144 struct ustctl_consumer_stream
;
145 struct ustctl_consumer_channel_attr
;
147 struct ustctl_consumer_channel
*
148 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
);
150 * Each stream created needs to be destroyed before calling
151 * ustctl_destroy_channel().
153 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
);
155 int ustctl_send_channel_to_sessiond(int sock
,
156 struct ustctl_consumer_channel
*channel
);
157 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
158 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
159 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*consumer_chan
);
160 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
);
162 int ustctl_write_metadata_to_channel(
163 struct ustctl_consumer_channel
*channel
,
164 const char *metadata_str
, /* NOT null-terminated */
165 size_t len
); /* metadata length */
168 * Send a NULL stream to finish iteration over all streams of a given
171 int ustctl_send_stream_to_sessiond(int sock
,
172 struct ustctl_consumer_stream
*stream
);
173 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
);
174 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
);
175 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
);
176 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
);
178 /* Create/destroy stream buffers for read */
179 struct ustctl_consumer_stream
*
180 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
182 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
);
184 /* For mmap mode, readable without "get" operation */
185 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
187 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
191 * For mmap mode, operate on the current packet (between get/put or
192 * get_next/put_next).
194 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
);
195 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
197 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
199 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
201 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
);
202 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
);
206 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
);
207 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
209 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
211 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
213 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
);
215 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
216 int producer_active
);
218 /* event registry management */
220 enum ustctl_socket_type
{
221 USTCTL_SOCKET_CMD
= 0,
222 USTCTL_SOCKET_NOTIFY
= 1,
225 enum ustctl_notify_cmd
{
226 USTCTL_NOTIFY_CMD_EVENT
= 0,
227 USTCTL_NOTIFY_CMD_CHANNEL
= 1,
230 enum ustctl_channel_header
{
231 USTCTL_CHANNEL_HEADER_UNKNOWN
= 0,
232 USTCTL_CHANNEL_HEADER_COMPACT
= 1,
233 USTCTL_CHANNEL_HEADER_LARGE
= 2,
236 /* event type structures */
238 enum ustctl_abstract_types
{
239 ustctl_atype_integer
,
242 ustctl_atype_sequence
,
245 NR_USTCTL_ABSTRACT_TYPES
,
248 enum ustctl_string_encodings
{
249 ustctl_encode_none
= 0,
250 ustctl_encode_UTF8
= 1,
251 ustctl_encode_ASCII
= 2,
252 NR_USTCTL_STRING_ENCODINGS
,
255 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
256 struct ustctl_integer_type
{
257 uint32_t size
; /* in bits */
259 uint32_t reverse_byte_order
;
260 uint32_t base
; /* 2, 8, 10, 16, for pretty print */
261 enum ustctl_string_encodings encoding
;
262 uint16_t alignment
; /* in bits */
263 char padding
[USTCTL_UST_INTEGER_TYPE_PADDING
];
266 #define USTCTL_UST_FLOAT_TYPE_PADDING 24
267 struct ustctl_float_type
{
268 uint32_t exp_dig
; /* exponent digits, in bits */
269 uint32_t mant_dig
; /* mantissa digits, in bits */
270 uint32_t reverse_byte_order
;
271 uint16_t alignment
; /* in bits */
272 char padding
[USTCTL_UST_FLOAT_TYPE_PADDING
];
275 #define USTCTL_UST_BASIC_TYPE_PADDING 296
276 union _ustctl_basic_type
{
277 struct ustctl_integer_type integer
;
279 enum ustctl_string_encodings encoding
;
281 struct ustctl_float_type _float
;
282 char padding
[USTCTL_UST_BASIC_TYPE_PADDING
];
285 struct ustctl_basic_type
{
286 enum ustctl_abstract_types atype
;
288 union _ustctl_basic_type basic
;
292 #define USTCTL_UST_TYPE_PADDING 128
294 enum ustctl_abstract_types atype
;
296 union _ustctl_basic_type basic
;
298 struct ustctl_basic_type elem_type
;
299 uint32_t length
; /* num. elems. */
302 struct ustctl_basic_type length_type
;
303 struct ustctl_basic_type elem_type
;
305 char padding
[USTCTL_UST_TYPE_PADDING
];
309 #define USTCTL_UST_FIELD_PADDING 28
310 struct ustctl_field
{
311 char name
[LTTNG_UST_SYM_NAME_LEN
];
312 struct ustctl_type type
;
313 char padding
[USTCTL_UST_FIELD_PADDING
];
317 * Returns 0 on success, negative error value on error.
318 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
319 * the output fields are not populated.
321 int ustctl_recv_reg_msg(int sock
,
322 enum ustctl_socket_type
*type
,
329 uint32_t *bits_per_long
,
330 uint32_t *uint8_t_alignment
,
331 uint32_t *uint16_t_alignment
,
332 uint32_t *uint32_t_alignment
,
333 uint32_t *uint64_t_alignment
,
334 uint32_t *long_alignment
,
336 char *name
); /* size LTTNG_UST_ABI_PROCNAME_LEN */
339 * Returns 0 on success, negative UST or system error value on error.
340 * Receive the notification command. The "notify_cmd" can then be used
341 * by the caller to find out which ustctl_recv_* function should be
342 * called to receive the notification, and which ustctl_reply_* is
345 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
);
348 * Returns 0 on success, negative UST or system error value on error.
350 int ustctl_recv_register_event(int sock
,
351 int *session_objd
, /* session descriptor (output) */
352 int *channel_objd
, /* channel descriptor (output) */
354 * event name (output,
355 * size LTTNG_UST_SYM_NAME_LEN)
360 * (output, dynamically
361 * allocated, must be free(3)'d
362 * by the caller if function
366 struct ustctl_field
**fields
,
367 char **model_emf_uri
);
370 * Returns 0 on success, negative error value on error.
372 int ustctl_reply_register_event(int sock
,
373 uint32_t id
, /* event id (input) */
374 int ret_code
); /* return code. 0 ok, negative error */
377 * Returns 0 on success, negative UST or system error value on error.
379 int ustctl_recv_register_channel(int sock
,
380 int *session_objd
, /* session descriptor (output) */
381 int *channel_objd
, /* channel descriptor (output) */
382 size_t *nr_fields
, /* context fields */
383 struct ustctl_field
**fields
);
386 * Returns 0 on success, negative error value on error.
388 int ustctl_reply_register_channel(int sock
,
390 enum ustctl_channel_header header_type
,
391 int ret_code
); /* return code. 0 ok, negative error */
393 #endif /* _LTTNG_UST_CTL_H */