Commit | Line | Data |
---|---|---|
f3105c67 MD |
1 | /* |
2 | * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca> | |
74d81a6c | 3 | * Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
f3105c67 | 4 | * |
e92f3e28 MD |
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. | |
f3105c67 MD |
8 | * |
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. | |
13 | * | |
e92f3e28 MD |
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. | |
f3105c67 MD |
17 | */ |
18 | ||
19 | #ifndef _LTTNG_UST_CTL_H | |
20 | #define _LTTNG_UST_CTL_H | |
21 | ||
4318ae1b | 22 | #include <lttng/ust-abi.h> |
32ce8569 | 23 | #include <sys/types.h> |
a9ff648c | 24 | #include <limits.h> |
74d81a6c MD |
25 | |
26 | #ifndef LTTNG_UST_UUID_LEN | |
27 | #define LTTNG_UST_UUID_LEN 16 | |
28 | #endif | |
29 | ||
32ce8569 MD |
30 | /* Default unix socket path */ |
31 | #define LTTNG_UST_SOCK_FILENAME \ | |
32 | "lttng-ust-sock-" \ | |
33 | __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION) | |
34 | ||
35 | /* | |
36 | * Shared memory files path are automatically related to shm root, e.g. | |
37 | * /dev/shm under linux. | |
38 | */ | |
39 | #define LTTNG_UST_WAIT_FILENAME \ | |
40 | "lttng-ust-wait-" \ | |
41 | __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION) | |
42 | ||
74d81a6c MD |
43 | struct lttng_ust_shm_handle; |
44 | struct lttng_ust_lib_ring_buffer; | |
45 | ||
46 | struct ustctl_consumer_channel_attr { | |
47 | enum lttng_ust_chan_type type; | |
48 | uint64_t subbuf_size; /* bytes */ | |
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 */ | |
6ca18e66 | 54 | uint32_t chan_id; /* channel ID */ |
74d81a6c | 55 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
a9ff648c | 56 | char shm_path[PATH_MAX]; /* Shared memory path */ |
74d81a6c MD |
57 | } LTTNG_PACKED; |
58 | ||
59 | /* | |
60 | * API used by sessiond. | |
61 | */ | |
62 | ||
7bc53e94 MD |
63 | /* |
64 | * Error values: all the following functions return: | |
c354a72c | 65 | * >= 0: Success (LTTNG_UST_OK) |
7bc53e94 MD |
66 | * < 0: error code. |
67 | */ | |
1c5e467e | 68 | int ustctl_register_done(int sock); |
f3105c67 | 69 | int ustctl_create_session(int sock); |
f3105c67 | 70 | int ustctl_create_event(int sock, struct lttng_ust_event *ev, |
61f02aea MD |
71 | struct lttng_ust_object_data *channel_data, |
72 | struct lttng_ust_object_data **event_data); | |
f3105c67 | 73 | int ustctl_add_context(int sock, struct lttng_ust_context *ctx, |
61f02aea MD |
74 | struct lttng_ust_object_data *obj_data, |
75 | struct lttng_ust_object_data **context_data); | |
cd54f6d9 MD |
76 | int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode, |
77 | struct lttng_ust_object_data *obj_data); | |
da57c034 JI |
78 | int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion, |
79 | struct lttng_ust_object_data *obj_data); | |
f3105c67 | 80 | |
61f02aea MD |
81 | int ustctl_enable(int sock, struct lttng_ust_object_data *object); |
82 | int ustctl_disable(int sock, struct lttng_ust_object_data *object); | |
4a6ca058 MD |
83 | int ustctl_start_session(int sock, int handle); |
84 | int ustctl_stop_session(int sock, int handle); | |
f3105c67 | 85 | |
b115631f MD |
86 | /* |
87 | * ustctl_tracepoint_list returns a tracepoint list handle, or negative | |
88 | * error value. | |
89 | */ | |
90 | int ustctl_tracepoint_list(int sock); | |
74d81a6c | 91 | |
b115631f MD |
92 | /* |
93 | * ustctl_tracepoint_list_get is used to iterate on the tp list | |
7bc53e94 MD |
94 | * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is |
95 | * returned. | |
b115631f MD |
96 | */ |
97 | int ustctl_tracepoint_list_get(int sock, int tp_list_handle, | |
cbef6901 | 98 | struct lttng_ust_tracepoint_iter *iter); |
b115631f | 99 | |
40003310 MD |
100 | /* |
101 | * ustctl_tracepoint_field_list returns a tracepoint field list handle, | |
102 | * or negative error value. | |
103 | */ | |
104 | int ustctl_tracepoint_field_list(int sock); | |
105 | ||
106 | /* | |
107 | * ustctl_tracepoint_field_list_get is used to iterate on the tp field | |
7bc53e94 MD |
108 | * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is |
109 | * returned. | |
40003310 MD |
110 | */ |
111 | int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle, | |
112 | struct lttng_ust_field_iter *iter); | |
113 | ||
f3105c67 MD |
114 | int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v); |
115 | int ustctl_wait_quiescent(int sock); | |
116 | ||
f1fffc57 MD |
117 | int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object); |
118 | ||
f3105c67 MD |
119 | int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate); |
120 | ||
74d81a6c MD |
121 | /* Release object created by members of this API. */ |
122 | int ustctl_release_object(int sock, struct lttng_ust_object_data *data); | |
123 | /* Release handle returned by create session. */ | |
124 | int ustctl_release_handle(int sock, int handle); | |
125 | ||
126 | int ustctl_recv_channel_from_consumer(int sock, | |
127 | struct lttng_ust_object_data **channel_data); | |
128 | int ustctl_recv_stream_from_consumer(int sock, | |
129 | struct lttng_ust_object_data **stream_data); | |
130 | int ustctl_send_channel_to_ust(int sock, int session_handle, | |
131 | struct lttng_ust_object_data *channel_data); | |
132 | int ustctl_send_stream_to_ust(int sock, | |
133 | struct lttng_ust_object_data *channel_data, | |
134 | struct lttng_ust_object_data *stream_data); | |
135 | ||
12f3dabc MD |
136 | /* |
137 | * ustctl_duplicate_ust_object_data allocated a new object in "dest" if | |
138 | * it succeeds (returns 0). It must be released using | |
139 | * ustctl_release_object() and then freed with free(). | |
140 | */ | |
141 | int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest, | |
142 | struct lttng_ust_object_data *src); | |
143 | ||
f3105c67 | 144 | /* |
74d81a6c | 145 | * API used by consumer. |
f3105c67 | 146 | */ |
74d81a6c MD |
147 | |
148 | struct ustctl_consumer_channel; | |
149 | struct ustctl_consumer_stream; | |
150 | struct ustctl_consumer_channel_attr; | |
151 | ||
152 | struct ustctl_consumer_channel * | |
153 | ustctl_create_channel(struct ustctl_consumer_channel_attr *attr); | |
5224b5c8 | 154 | /* |
74d81a6c MD |
155 | * Each stream created needs to be destroyed before calling |
156 | * ustctl_destroy_channel(). | |
5224b5c8 | 157 | */ |
74d81a6c | 158 | void ustctl_destroy_channel(struct ustctl_consumer_channel *chan); |
f3105c67 | 159 | |
74d81a6c MD |
160 | int ustctl_send_channel_to_sessiond(int sock, |
161 | struct ustctl_consumer_channel *channel); | |
ff0f5728 MD |
162 | int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan); |
163 | int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan); | |
164 | int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan); | |
165 | int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan); | |
c9023c93 MD |
166 | |
167 | int ustctl_write_metadata_to_channel( | |
168 | struct ustctl_consumer_channel *channel, | |
169 | const char *metadata_str, /* NOT null-terminated */ | |
170 | size_t len); /* metadata length */ | |
3ef94b0e JD |
171 | ssize_t ustctl_write_one_packet_to_channel( |
172 | struct ustctl_consumer_channel *channel, | |
173 | const char *metadata_str, /* NOT null-terminated */ | |
174 | size_t len); /* metadata length */ | |
c9023c93 | 175 | |
74d81a6c MD |
176 | /* |
177 | * Send a NULL stream to finish iteration over all streams of a given | |
178 | * channel. | |
179 | */ | |
180 | int ustctl_send_stream_to_sessiond(int sock, | |
181 | struct ustctl_consumer_stream *stream); | |
182 | int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream); | |
183 | int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream); | |
ff0f5728 MD |
184 | int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream); |
185 | int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream); | |
f3105c67 | 186 | |
74d81a6c MD |
187 | /* Create/destroy stream buffers for read */ |
188 | struct ustctl_consumer_stream * | |
189 | ustctl_create_stream(struct ustctl_consumer_channel *channel, | |
190 | int cpu); | |
191 | void ustctl_destroy_stream(struct ustctl_consumer_stream *stream); | |
f3105c67 MD |
192 | |
193 | /* For mmap mode, readable without "get" operation */ | |
74d81a6c | 194 | int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream, |
f3105c67 | 195 | unsigned long *len); |
74d81a6c | 196 | int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream, |
f3105c67 MD |
197 | unsigned long *len); |
198 | ||
199 | /* | |
200 | * For mmap mode, operate on the current packet (between get/put or | |
201 | * get_next/put_next). | |
202 | */ | |
74d81a6c MD |
203 | void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream); |
204 | int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream, | |
205 | unsigned long *off); | |
206 | int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream, | |
207 | unsigned long *len); | |
208 | int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream, | |
209 | unsigned long *len); | |
210 | int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream); | |
211 | int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream); | |
f3105c67 MD |
212 | |
213 | /* snapshot */ | |
214 | ||
74d81a6c MD |
215 | int ustctl_snapshot(struct ustctl_consumer_stream *stream); |
216 | int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream, | |
217 | unsigned long *pos); | |
218 | int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream, | |
219 | unsigned long *pos); | |
220 | int ustctl_get_subbuf(struct ustctl_consumer_stream *stream, | |
221 | unsigned long *pos); | |
222 | int ustctl_put_subbuf(struct ustctl_consumer_stream *stream); | |
5f9d3dbc | 223 | |
74d81a6c MD |
224 | void ustctl_flush_buffer(struct ustctl_consumer_stream *stream, |
225 | int producer_active); | |
f3105c67 | 226 | |
b2f3252a JD |
227 | /* index */ |
228 | int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream, | |
229 | uint64_t *timestamp_begin); | |
230 | int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream, | |
231 | uint64_t *timestamp_end); | |
232 | int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream, | |
233 | uint64_t *events_discarded); | |
234 | int ustctl_get_content_size(struct ustctl_consumer_stream *stream, | |
235 | uint64_t *content_size); | |
236 | int ustctl_get_packet_size(struct ustctl_consumer_stream *stream, | |
237 | uint64_t *packet_size); | |
238 | int ustctl_get_stream_id(struct ustctl_consumer_stream *stream, | |
239 | uint64_t *stream_id); | |
fca361e8 JD |
240 | int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream, |
241 | uint64_t *ts); | |
b2f3252a | 242 | |
57201bb3 MD |
243 | /* returns whether UST has perf counters support. */ |
244 | int ustctl_has_perf_counters(void); | |
245 | ||
32ce8569 MD |
246 | /* event registry management */ |
247 | ||
248 | enum ustctl_socket_type { | |
249 | USTCTL_SOCKET_CMD = 0, | |
250 | USTCTL_SOCKET_NOTIFY = 1, | |
251 | }; | |
252 | ||
253 | enum ustctl_notify_cmd { | |
254 | USTCTL_NOTIFY_CMD_EVENT = 0, | |
255 | USTCTL_NOTIFY_CMD_CHANNEL = 1, | |
256 | }; | |
257 | ||
258 | enum ustctl_channel_header { | |
259 | USTCTL_CHANNEL_HEADER_UNKNOWN = 0, | |
260 | USTCTL_CHANNEL_HEADER_COMPACT = 1, | |
261 | USTCTL_CHANNEL_HEADER_LARGE = 2, | |
262 | }; | |
263 | ||
264 | /* event type structures */ | |
265 | ||
266 | enum ustctl_abstract_types { | |
267 | ustctl_atype_integer, | |
268 | ustctl_atype_enum, | |
269 | ustctl_atype_array, | |
270 | ustctl_atype_sequence, | |
271 | ustctl_atype_string, | |
272 | ustctl_atype_float, | |
273 | NR_USTCTL_ABSTRACT_TYPES, | |
274 | }; | |
275 | ||
276 | enum ustctl_string_encodings { | |
277 | ustctl_encode_none = 0, | |
278 | ustctl_encode_UTF8 = 1, | |
279 | ustctl_encode_ASCII = 2, | |
280 | NR_USTCTL_STRING_ENCODINGS, | |
281 | }; | |
282 | ||
283 | #define USTCTL_UST_INTEGER_TYPE_PADDING 24 | |
284 | struct ustctl_integer_type { | |
285 | uint32_t size; /* in bits */ | |
286 | uint32_t signedness; | |
287 | uint32_t reverse_byte_order; | |
288 | uint32_t base; /* 2, 8, 10, 16, for pretty print */ | |
289 | enum ustctl_string_encodings encoding; | |
290 | uint16_t alignment; /* in bits */ | |
291 | char padding[USTCTL_UST_INTEGER_TYPE_PADDING]; | |
292 | } LTTNG_PACKED; | |
293 | ||
294 | #define USTCTL_UST_FLOAT_TYPE_PADDING 24 | |
295 | struct ustctl_float_type { | |
296 | uint32_t exp_dig; /* exponent digits, in bits */ | |
297 | uint32_t mant_dig; /* mantissa digits, in bits */ | |
298 | uint32_t reverse_byte_order; | |
299 | uint16_t alignment; /* in bits */ | |
300 | char padding[USTCTL_UST_FLOAT_TYPE_PADDING]; | |
301 | } LTTNG_PACKED; | |
302 | ||
303 | #define USTCTL_UST_BASIC_TYPE_PADDING 296 | |
304 | union _ustctl_basic_type { | |
305 | struct ustctl_integer_type integer; | |
306 | struct { | |
307 | enum ustctl_string_encodings encoding; | |
308 | } string; | |
309 | struct ustctl_float_type _float; | |
310 | char padding[USTCTL_UST_BASIC_TYPE_PADDING]; | |
311 | } LTTNG_PACKED; | |
312 | ||
313 | struct ustctl_basic_type { | |
314 | enum ustctl_abstract_types atype; | |
315 | union { | |
316 | union _ustctl_basic_type basic; | |
317 | } u; | |
318 | } LTTNG_PACKED; | |
319 | ||
320 | #define USTCTL_UST_TYPE_PADDING 128 | |
321 | struct ustctl_type { | |
322 | enum ustctl_abstract_types atype; | |
323 | union { | |
324 | union _ustctl_basic_type basic; | |
325 | struct { | |
326 | struct ustctl_basic_type elem_type; | |
327 | uint32_t length; /* num. elems. */ | |
328 | } array; | |
329 | struct { | |
330 | struct ustctl_basic_type length_type; | |
331 | struct ustctl_basic_type elem_type; | |
332 | } sequence; | |
333 | char padding[USTCTL_UST_TYPE_PADDING]; | |
334 | } u; | |
335 | } LTTNG_PACKED; | |
336 | ||
337 | #define USTCTL_UST_FIELD_PADDING 28 | |
338 | struct ustctl_field { | |
339 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
340 | struct ustctl_type type; | |
341 | char padding[USTCTL_UST_FIELD_PADDING]; | |
342 | } LTTNG_PACKED; | |
343 | ||
344 | /* | |
345 | * Returns 0 on success, negative error value on error. | |
346 | * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned, | |
347 | * the output fields are not populated. | |
348 | */ | |
349 | int ustctl_recv_reg_msg(int sock, | |
350 | enum ustctl_socket_type *type, | |
351 | uint32_t *major, | |
352 | uint32_t *minor, | |
353 | uint32_t *pid, | |
354 | uint32_t *ppid, | |
355 | uint32_t *uid, | |
356 | uint32_t *gid, | |
357 | uint32_t *bits_per_long, | |
358 | uint32_t *uint8_t_alignment, | |
359 | uint32_t *uint16_t_alignment, | |
360 | uint32_t *uint32_t_alignment, | |
361 | uint32_t *uint64_t_alignment, | |
362 | uint32_t *long_alignment, | |
363 | int *byte_order, | |
364 | char *name); /* size LTTNG_UST_ABI_PROCNAME_LEN */ | |
365 | ||
366 | /* | |
367 | * Returns 0 on success, negative UST or system error value on error. | |
368 | * Receive the notification command. The "notify_cmd" can then be used | |
369 | * by the caller to find out which ustctl_recv_* function should be | |
370 | * called to receive the notification, and which ustctl_reply_* is | |
371 | * appropriate. | |
372 | */ | |
373 | int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd); | |
374 | ||
375 | /* | |
376 | * Returns 0 on success, negative UST or system error value on error. | |
377 | */ | |
378 | int ustctl_recv_register_event(int sock, | |
379 | int *session_objd, /* session descriptor (output) */ | |
380 | int *channel_objd, /* channel descriptor (output) */ | |
381 | char *event_name, /* | |
382 | * event name (output, | |
383 | * size LTTNG_UST_SYM_NAME_LEN) | |
384 | */ | |
385 | int *loglevel, | |
386 | char **signature, /* | |
387 | * event signature | |
388 | * (output, dynamically | |
389 | * allocated, must be free(3)'d | |
390 | * by the caller if function | |
391 | * returns success.) | |
392 | */ | |
393 | size_t *nr_fields, | |
394 | struct ustctl_field **fields, | |
395 | char **model_emf_uri); | |
396 | ||
397 | /* | |
398 | * Returns 0 on success, negative error value on error. | |
399 | */ | |
400 | int ustctl_reply_register_event(int sock, | |
401 | uint32_t id, /* event id (input) */ | |
402 | int ret_code); /* return code. 0 ok, negative error */ | |
403 | ||
404 | /* | |
405 | * Returns 0 on success, negative UST or system error value on error. | |
406 | */ | |
407 | int ustctl_recv_register_channel(int sock, | |
408 | int *session_objd, /* session descriptor (output) */ | |
409 | int *channel_objd, /* channel descriptor (output) */ | |
410 | size_t *nr_fields, /* context fields */ | |
411 | struct ustctl_field **fields); | |
412 | ||
413 | /* | |
414 | * Returns 0 on success, negative error value on error. | |
415 | */ | |
416 | int ustctl_reply_register_channel(int sock, | |
417 | uint32_t chan_id, | |
418 | enum ustctl_channel_header header_type, | |
419 | int ret_code); /* return code. 0 ok, negative error */ | |
420 | ||
f3105c67 | 421 | #endif /* _LTTNG_UST_CTL_H */ |