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 | ||
fb31eb73 | 22 | #include <limits.h> |
b4051ad8 | 23 | #include <stddef.h> |
fb31eb73 | 24 | #include <stdint.h> |
ebabbf58 | 25 | #include <stdbool.h> |
32ce8569 | 26 | #include <sys/types.h> |
fb31eb73 FD |
27 | |
28 | #include <lttng/ust-abi.h> | |
74d81a6c | 29 | |
db56acaf MD |
30 | #ifndef LTTNG_PACKED |
31 | #error "LTTNG_PACKED should be defined" | |
32 | #endif | |
33 | ||
74d81a6c MD |
34 | #ifndef LTTNG_UST_UUID_LEN |
35 | #define LTTNG_UST_UUID_LEN 16 | |
36 | #endif | |
37 | ||
32ce8569 MD |
38 | /* Default unix socket path */ |
39 | #define LTTNG_UST_SOCK_FILENAME \ | |
40 | "lttng-ust-sock-" \ | |
41 | __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION) | |
42 | ||
43 | /* | |
44 | * Shared memory files path are automatically related to shm root, e.g. | |
45 | * /dev/shm under linux. | |
46 | */ | |
47 | #define LTTNG_UST_WAIT_FILENAME \ | |
48 | "lttng-ust-wait-" \ | |
49 | __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION) | |
50 | ||
74d81a6c MD |
51 | struct lttng_ust_shm_handle; |
52 | struct lttng_ust_lib_ring_buffer; | |
53 | ||
54 | struct ustctl_consumer_channel_attr { | |
55 | enum lttng_ust_chan_type type; | |
56 | uint64_t subbuf_size; /* bytes */ | |
57 | uint64_t num_subbuf; /* power of 2 */ | |
58 | int overwrite; /* 1: overwrite, 0: discard */ | |
59 | unsigned int switch_timer_interval; /* usec */ | |
60 | unsigned int read_timer_interval; /* usec */ | |
61 | enum lttng_ust_output output; /* splice, mmap */ | |
6ca18e66 | 62 | uint32_t chan_id; /* channel ID */ |
74d81a6c | 63 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
b2c5f61a | 64 | int64_t blocking_timeout; /* Blocking timeout (usec) */ |
74d81a6c MD |
65 | } LTTNG_PACKED; |
66 | ||
67 | /* | |
68 | * API used by sessiond. | |
69 | */ | |
70 | ||
53f0df51 JG |
71 | struct lttng_ust_context_attr { |
72 | enum lttng_ust_context_type ctx; | |
73 | union { | |
74 | struct lttng_ust_perf_counter_ctx perf_counter; | |
75 | struct { | |
76 | char *provider_name; | |
77 | char *ctx_name; | |
78 | } app_ctx; | |
79 | } u; | |
80 | }; | |
81 | ||
7bc53e94 MD |
82 | /* |
83 | * Error values: all the following functions return: | |
c354a72c | 84 | * >= 0: Success (LTTNG_UST_OK) |
7bc53e94 MD |
85 | * < 0: error code. |
86 | */ | |
1c5e467e | 87 | int ustctl_register_done(int sock); |
f3105c67 | 88 | int ustctl_create_session(int sock); |
f3105c67 | 89 | int ustctl_create_event(int sock, struct lttng_ust_event *ev, |
61f02aea MD |
90 | struct lttng_ust_object_data *channel_data, |
91 | struct lttng_ust_object_data **event_data); | |
53f0df51 | 92 | int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx, |
61f02aea MD |
93 | struct lttng_ust_object_data *obj_data, |
94 | struct lttng_ust_object_data **context_data); | |
cd54f6d9 MD |
95 | int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode, |
96 | struct lttng_ust_object_data *obj_data); | |
d37ecb3f FD |
97 | int ustctl_set_capture(int sock, struct lttng_ust_capture_bytecode *bytecode, |
98 | struct lttng_ust_object_data *obj_data); | |
da57c034 JI |
99 | int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion, |
100 | struct lttng_ust_object_data *obj_data); | |
f3105c67 | 101 | |
61f02aea MD |
102 | int ustctl_enable(int sock, struct lttng_ust_object_data *object); |
103 | int ustctl_disable(int sock, struct lttng_ust_object_data *object); | |
4a6ca058 MD |
104 | int ustctl_start_session(int sock, int handle); |
105 | int ustctl_stop_session(int sock, int handle); | |
f3105c67 | 106 | |
d8d2416d FD |
107 | /* |
108 | * ustctl_create_event notifier_group creates a event notifier group. It | |
109 | * establishes the connection with the application by providing a file | |
110 | * descriptor of the pipe to be used by the application when a event notifier | |
111 | * of that group is fired. It returns a handle to be used when creating event | |
112 | * notifier in that group. | |
113 | */ | |
114 | int ustctl_create_event_notifier_group(int sock, int pipe_fd, | |
115 | struct lttng_ust_object_data **event_notifier_group); | |
116 | ||
117 | /* | |
118 | * ustctl_create_event notifier creates a event notifier in a event notifier | |
119 | * group giving a event notifier description and a event notifier group handle. | |
120 | * It returns a event notifier handle to be used when enabling the event | |
121 | * notifier, attaching filter, attaching exclusion, and disabling the event | |
122 | * notifier. | |
123 | */ | |
124 | int ustctl_create_event_notifier(int sock, | |
125 | struct lttng_ust_event_notifier *event_notifier, | |
126 | struct lttng_ust_object_data *event_notifier_group, | |
127 | struct lttng_ust_object_data **event_notifier_data); | |
128 | ||
b115631f MD |
129 | /* |
130 | * ustctl_tracepoint_list returns a tracepoint list handle, or negative | |
131 | * error value. | |
132 | */ | |
133 | int ustctl_tracepoint_list(int sock); | |
74d81a6c | 134 | |
b115631f MD |
135 | /* |
136 | * ustctl_tracepoint_list_get is used to iterate on the tp list | |
7bc53e94 MD |
137 | * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is |
138 | * returned. | |
b115631f MD |
139 | */ |
140 | int ustctl_tracepoint_list_get(int sock, int tp_list_handle, | |
cbef6901 | 141 | struct lttng_ust_tracepoint_iter *iter); |
b115631f | 142 | |
40003310 MD |
143 | /* |
144 | * ustctl_tracepoint_field_list returns a tracepoint field list handle, | |
145 | * or negative error value. | |
146 | */ | |
147 | int ustctl_tracepoint_field_list(int sock); | |
148 | ||
149 | /* | |
150 | * ustctl_tracepoint_field_list_get is used to iterate on the tp field | |
7bc53e94 MD |
151 | * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is |
152 | * returned. | |
40003310 MD |
153 | */ |
154 | int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle, | |
155 | struct lttng_ust_field_iter *iter); | |
156 | ||
f3105c67 MD |
157 | int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v); |
158 | int ustctl_wait_quiescent(int sock); | |
159 | ||
f1fffc57 MD |
160 | int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object); |
161 | ||
f3105c67 MD |
162 | int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate); |
163 | ||
74d81a6c MD |
164 | /* Release object created by members of this API. */ |
165 | int ustctl_release_object(int sock, struct lttng_ust_object_data *data); | |
166 | /* Release handle returned by create session. */ | |
167 | int ustctl_release_handle(int sock, int handle); | |
168 | ||
169 | int ustctl_recv_channel_from_consumer(int sock, | |
170 | struct lttng_ust_object_data **channel_data); | |
171 | int ustctl_recv_stream_from_consumer(int sock, | |
172 | struct lttng_ust_object_data **stream_data); | |
173 | int ustctl_send_channel_to_ust(int sock, int session_handle, | |
174 | struct lttng_ust_object_data *channel_data); | |
175 | int ustctl_send_stream_to_ust(int sock, | |
176 | struct lttng_ust_object_data *channel_data, | |
177 | struct lttng_ust_object_data *stream_data); | |
178 | ||
12f3dabc MD |
179 | /* |
180 | * ustctl_duplicate_ust_object_data allocated a new object in "dest" if | |
181 | * it succeeds (returns 0). It must be released using | |
182 | * ustctl_release_object() and then freed with free(). | |
183 | */ | |
184 | int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest, | |
185 | struct lttng_ust_object_data *src); | |
186 | ||
f3105c67 | 187 | /* |
74d81a6c | 188 | * API used by consumer. |
f3105c67 | 189 | */ |
74d81a6c MD |
190 | |
191 | struct ustctl_consumer_channel; | |
192 | struct ustctl_consumer_stream; | |
193 | struct ustctl_consumer_channel_attr; | |
194 | ||
5ea386c3 MD |
195 | int ustctl_get_nr_stream_per_channel(void); |
196 | ||
74d81a6c | 197 | struct ustctl_consumer_channel * |
5ea386c3 MD |
198 | ustctl_create_channel(struct ustctl_consumer_channel_attr *attr, |
199 | const int *stream_fds, int nr_stream_fds); | |
5224b5c8 | 200 | /* |
74d81a6c MD |
201 | * Each stream created needs to be destroyed before calling |
202 | * ustctl_destroy_channel(). | |
5224b5c8 | 203 | */ |
74d81a6c | 204 | void ustctl_destroy_channel(struct ustctl_consumer_channel *chan); |
f3105c67 | 205 | |
74d81a6c MD |
206 | int ustctl_send_channel_to_sessiond(int sock, |
207 | struct ustctl_consumer_channel *channel); | |
ff0f5728 MD |
208 | int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan); |
209 | int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan); | |
210 | int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan); | |
211 | int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan); | |
c9023c93 MD |
212 | |
213 | int ustctl_write_metadata_to_channel( | |
214 | struct ustctl_consumer_channel *channel, | |
215 | const char *metadata_str, /* NOT null-terminated */ | |
216 | size_t len); /* metadata length */ | |
3ef94b0e JD |
217 | ssize_t ustctl_write_one_packet_to_channel( |
218 | struct ustctl_consumer_channel *channel, | |
219 | const char *metadata_str, /* NOT null-terminated */ | |
220 | size_t len); /* metadata length */ | |
c9023c93 | 221 | |
74d81a6c MD |
222 | /* |
223 | * Send a NULL stream to finish iteration over all streams of a given | |
224 | * channel. | |
225 | */ | |
226 | int ustctl_send_stream_to_sessiond(int sock, | |
227 | struct ustctl_consumer_stream *stream); | |
228 | int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream); | |
229 | int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream); | |
ff0f5728 MD |
230 | int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream); |
231 | int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream); | |
f3105c67 | 232 | |
74d81a6c MD |
233 | /* Create/destroy stream buffers for read */ |
234 | struct ustctl_consumer_stream * | |
235 | ustctl_create_stream(struct ustctl_consumer_channel *channel, | |
236 | int cpu); | |
237 | void ustctl_destroy_stream(struct ustctl_consumer_stream *stream); | |
f3105c67 MD |
238 | |
239 | /* For mmap mode, readable without "get" operation */ | |
74d81a6c | 240 | int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream, |
f3105c67 | 241 | unsigned long *len); |
74d81a6c | 242 | int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream, |
f3105c67 MD |
243 | unsigned long *len); |
244 | ||
245 | /* | |
246 | * For mmap mode, operate on the current packet (between get/put or | |
247 | * get_next/put_next). | |
248 | */ | |
74d81a6c MD |
249 | void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream); |
250 | int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream, | |
251 | unsigned long *off); | |
252 | int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream, | |
253 | unsigned long *len); | |
254 | int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream, | |
255 | unsigned long *len); | |
256 | int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream); | |
257 | int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream); | |
f3105c67 MD |
258 | |
259 | /* snapshot */ | |
260 | ||
74d81a6c | 261 | int ustctl_snapshot(struct ustctl_consumer_stream *stream); |
f45930b7 | 262 | int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream *stream); |
74d81a6c MD |
263 | int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream, |
264 | unsigned long *pos); | |
265 | int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream, | |
266 | unsigned long *pos); | |
267 | int ustctl_get_subbuf(struct ustctl_consumer_stream *stream, | |
268 | unsigned long *pos); | |
269 | int ustctl_put_subbuf(struct ustctl_consumer_stream *stream); | |
5f9d3dbc | 270 | |
74d81a6c MD |
271 | void ustctl_flush_buffer(struct ustctl_consumer_stream *stream, |
272 | int producer_active); | |
beca55a1 | 273 | void ustctl_clear_buffer(struct ustctl_consumer_stream *stream); |
f3105c67 | 274 | |
b2f3252a | 275 | /* index */ |
82df14e4 MD |
276 | |
277 | /* | |
278 | * Getters which need to be used on the current packet (between get/put | |
279 | * or get_next/put_next. | |
280 | */ | |
281 | ||
b2f3252a JD |
282 | int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream, |
283 | uint64_t *timestamp_begin); | |
284 | int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream, | |
285 | uint64_t *timestamp_end); | |
286 | int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream, | |
287 | uint64_t *events_discarded); | |
288 | int ustctl_get_content_size(struct ustctl_consumer_stream *stream, | |
289 | uint64_t *content_size); | |
290 | int ustctl_get_packet_size(struct ustctl_consumer_stream *stream, | |
291 | uint64_t *packet_size); | |
1ff31389 JD |
292 | int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream, |
293 | uint64_t *seq); | |
82df14e4 MD |
294 | |
295 | /* | |
296 | * Getter returning state invariant for the stream, which can be used | |
297 | * without "get" operation. | |
298 | */ | |
299 | ||
300 | int ustctl_get_stream_id(struct ustctl_consumer_stream *stream, | |
301 | uint64_t *stream_id); | |
45a00b05 JD |
302 | int ustctl_get_instance_id(struct ustctl_consumer_stream *stream, |
303 | uint64_t *id); | |
b2f3252a | 304 | |
82df14e4 MD |
305 | /* |
306 | * Getter returning the current timestamp as perceived from the | |
307 | * tracer. | |
308 | */ | |
309 | int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream, | |
310 | uint64_t *ts); | |
311 | ||
57201bb3 MD |
312 | /* returns whether UST has perf counters support. */ |
313 | int ustctl_has_perf_counters(void); | |
314 | ||
f53329f3 JD |
315 | /* Regenerate the statedump. */ |
316 | int ustctl_regenerate_statedump(int sock, int handle); | |
317 | ||
32ce8569 MD |
318 | /* event registry management */ |
319 | ||
320 | enum ustctl_socket_type { | |
321 | USTCTL_SOCKET_CMD = 0, | |
322 | USTCTL_SOCKET_NOTIFY = 1, | |
323 | }; | |
324 | ||
325 | enum ustctl_notify_cmd { | |
326 | USTCTL_NOTIFY_CMD_EVENT = 0, | |
327 | USTCTL_NOTIFY_CMD_CHANNEL = 1, | |
c785c634 | 328 | USTCTL_NOTIFY_CMD_ENUM = 2, |
32ce8569 MD |
329 | }; |
330 | ||
331 | enum ustctl_channel_header { | |
332 | USTCTL_CHANNEL_HEADER_UNKNOWN = 0, | |
333 | USTCTL_CHANNEL_HEADER_COMPACT = 1, | |
334 | USTCTL_CHANNEL_HEADER_LARGE = 2, | |
335 | }; | |
336 | ||
337 | /* event type structures */ | |
338 | ||
339 | enum ustctl_abstract_types { | |
340 | ustctl_atype_integer, | |
218deb69 MD |
341 | ustctl_atype_enum, /* legacy */ |
342 | ustctl_atype_array, /* legacy */ | |
343 | ustctl_atype_sequence, /* legacy */ | |
32ce8569 MD |
344 | ustctl_atype_string, |
345 | ustctl_atype_float, | |
218deb69 MD |
346 | ustctl_atype_variant, /* legacy */ |
347 | ustctl_atype_struct, /* legacy */ | |
348 | ustctl_atype_enum_nestable, | |
349 | ustctl_atype_array_nestable, | |
350 | ustctl_atype_sequence_nestable, | |
351 | ustctl_atype_struct_nestable, | |
352 | ustctl_atype_variant_nestable, | |
32ce8569 MD |
353 | NR_USTCTL_ABSTRACT_TYPES, |
354 | }; | |
355 | ||
356 | enum ustctl_string_encodings { | |
357 | ustctl_encode_none = 0, | |
358 | ustctl_encode_UTF8 = 1, | |
359 | ustctl_encode_ASCII = 2, | |
360 | NR_USTCTL_STRING_ENCODINGS, | |
361 | }; | |
362 | ||
363 | #define USTCTL_UST_INTEGER_TYPE_PADDING 24 | |
364 | struct ustctl_integer_type { | |
365 | uint32_t size; /* in bits */ | |
366 | uint32_t signedness; | |
367 | uint32_t reverse_byte_order; | |
368 | uint32_t base; /* 2, 8, 10, 16, for pretty print */ | |
735ea6a8 | 369 | int32_t encoding; /* enum ustctl_string_encodings */ |
32ce8569 MD |
370 | uint16_t alignment; /* in bits */ |
371 | char padding[USTCTL_UST_INTEGER_TYPE_PADDING]; | |
372 | } LTTNG_PACKED; | |
373 | ||
374 | #define USTCTL_UST_FLOAT_TYPE_PADDING 24 | |
375 | struct ustctl_float_type { | |
376 | uint32_t exp_dig; /* exponent digits, in bits */ | |
377 | uint32_t mant_dig; /* mantissa digits, in bits */ | |
378 | uint32_t reverse_byte_order; | |
379 | uint16_t alignment; /* in bits */ | |
380 | char padding[USTCTL_UST_FLOAT_TYPE_PADDING]; | |
381 | } LTTNG_PACKED; | |
382 | ||
a6f80644 MD |
383 | #define USTCTL_UST_ENUM_VALUE_PADDING 15 |
384 | struct ustctl_enum_value { | |
385 | uint64_t value; | |
386 | uint8_t signedness; | |
387 | char padding[USTCTL_UST_ENUM_VALUE_PADDING]; | |
388 | } LTTNG_PACKED; | |
389 | ||
3e762260 PP |
390 | enum ustctl_ust_enum_entry_options { |
391 | USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0, | |
392 | }; | |
393 | ||
c785c634 MD |
394 | #define USTCTL_UST_ENUM_ENTRY_PADDING 32 |
395 | struct ustctl_enum_entry { | |
a6f80644 | 396 | struct ustctl_enum_value start, end; /* start and end are inclusive */ |
c785c634 | 397 | char string[LTTNG_UST_SYM_NAME_LEN]; |
3e762260 PP |
398 | union { |
399 | struct { | |
400 | uint32_t options; | |
401 | } LTTNG_PACKED extra; | |
402 | char padding[USTCTL_UST_ENUM_ENTRY_PADDING]; | |
403 | } u; | |
a6f80644 | 404 | } LTTNG_PACKED; |
c785c634 | 405 | |
218deb69 | 406 | /* legacy */ |
32ce8569 MD |
407 | #define USTCTL_UST_BASIC_TYPE_PADDING 296 |
408 | union _ustctl_basic_type { | |
409 | struct ustctl_integer_type integer; | |
c785c634 MD |
410 | struct { |
411 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
412 | struct ustctl_integer_type container_type; | |
413 | uint64_t id; /* enum ID in sessiond. */ | |
414 | } enumeration; | |
32ce8569 | 415 | struct { |
735ea6a8 | 416 | int32_t encoding; /* enum ustctl_string_encodings */ |
32ce8569 MD |
417 | } string; |
418 | struct ustctl_float_type _float; | |
419 | char padding[USTCTL_UST_BASIC_TYPE_PADDING]; | |
420 | } LTTNG_PACKED; | |
421 | ||
218deb69 | 422 | /* legacy */ |
32ce8569 MD |
423 | struct ustctl_basic_type { |
424 | enum ustctl_abstract_types atype; | |
425 | union { | |
426 | union _ustctl_basic_type basic; | |
427 | } u; | |
428 | } LTTNG_PACKED; | |
429 | ||
218deb69 MD |
430 | /* |
431 | * Padding is derived from largest member: u.legacy.sequence which | |
432 | * contains two basic types, each with USTCTL_UST_BASIC_TYPE_PADDING. | |
433 | */ | |
434 | #define USTCTL_UST_TYPE_PADDING (2 * USTCTL_UST_BASIC_TYPE_PADDING) | |
32ce8569 MD |
435 | struct ustctl_type { |
436 | enum ustctl_abstract_types atype; | |
437 | union { | |
218deb69 MD |
438 | struct ustctl_integer_type integer; |
439 | struct ustctl_float_type _float; | |
440 | struct { | |
441 | int32_t encoding; /* enum ustctl_string_encodings */ | |
442 | } string; | |
443 | struct { | |
444 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
445 | uint64_t id; /* enum ID in sessiond. */ | |
446 | /* container_type follows after this struct ustctl_field. */ | |
447 | } enum_nestable; | |
32ce8569 | 448 | struct { |
32ce8569 | 449 | uint32_t length; /* num. elems. */ |
218deb69 MD |
450 | uint32_t alignment; |
451 | /* elem_type follows after this struct ustctl_field. */ | |
452 | } array_nestable; | |
32ce8569 | 453 | struct { |
218deb69 MD |
454 | char length_name[LTTNG_UST_SYM_NAME_LEN]; |
455 | uint32_t alignment; /* Alignment before elements. */ | |
456 | /* elem_type follows after the length_type. */ | |
457 | } sequence_nestable; | |
458 | struct { | |
459 | uint32_t nr_fields; | |
460 | uint32_t alignment; | |
461 | /* Followed by nr_fields struct ustctl_field. */ | |
462 | } struct_nestable; | |
53569322 MD |
463 | struct { |
464 | uint32_t nr_choices; | |
465 | char tag_name[LTTNG_UST_SYM_NAME_LEN]; | |
218deb69 | 466 | uint32_t alignment; |
53569322 | 467 | /* Followed by nr_choices struct ustctl_field. */ |
218deb69 MD |
468 | } variant_nestable; |
469 | ||
470 | /* Legacy ABI */ | |
471 | union { | |
472 | union _ustctl_basic_type basic; | |
473 | struct { | |
474 | struct ustctl_basic_type elem_type; | |
475 | uint32_t length; /* num. elems. */ | |
476 | } array; | |
477 | struct { | |
478 | struct ustctl_basic_type length_type; | |
479 | struct ustctl_basic_type elem_type; | |
480 | } sequence; | |
481 | struct { | |
482 | uint32_t nr_fields; | |
483 | /* Followed by nr_fields struct ustctl_field. */ | |
484 | } _struct; | |
485 | struct { | |
486 | uint32_t nr_choices; | |
487 | char tag_name[LTTNG_UST_SYM_NAME_LEN]; | |
488 | /* Followed by nr_choices struct ustctl_field. */ | |
489 | } variant; | |
490 | } legacy; | |
32ce8569 MD |
491 | char padding[USTCTL_UST_TYPE_PADDING]; |
492 | } u; | |
493 | } LTTNG_PACKED; | |
494 | ||
495 | #define USTCTL_UST_FIELD_PADDING 28 | |
496 | struct ustctl_field { | |
497 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
498 | struct ustctl_type type; | |
499 | char padding[USTCTL_UST_FIELD_PADDING]; | |
500 | } LTTNG_PACKED; | |
501 | ||
502 | /* | |
503 | * Returns 0 on success, negative error value on error. | |
504 | * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned, | |
505 | * the output fields are not populated. | |
506 | */ | |
507 | int ustctl_recv_reg_msg(int sock, | |
508 | enum ustctl_socket_type *type, | |
509 | uint32_t *major, | |
510 | uint32_t *minor, | |
511 | uint32_t *pid, | |
512 | uint32_t *ppid, | |
513 | uint32_t *uid, | |
514 | uint32_t *gid, | |
515 | uint32_t *bits_per_long, | |
516 | uint32_t *uint8_t_alignment, | |
517 | uint32_t *uint16_t_alignment, | |
518 | uint32_t *uint32_t_alignment, | |
519 | uint32_t *uint64_t_alignment, | |
520 | uint32_t *long_alignment, | |
521 | int *byte_order, | |
522 | char *name); /* size LTTNG_UST_ABI_PROCNAME_LEN */ | |
523 | ||
524 | /* | |
525 | * Returns 0 on success, negative UST or system error value on error. | |
526 | * Receive the notification command. The "notify_cmd" can then be used | |
527 | * by the caller to find out which ustctl_recv_* function should be | |
528 | * called to receive the notification, and which ustctl_reply_* is | |
529 | * appropriate. | |
530 | */ | |
531 | int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd); | |
532 | ||
533 | /* | |
534 | * Returns 0 on success, negative UST or system error value on error. | |
535 | */ | |
536 | int ustctl_recv_register_event(int sock, | |
537 | int *session_objd, /* session descriptor (output) */ | |
538 | int *channel_objd, /* channel descriptor (output) */ | |
539 | char *event_name, /* | |
540 | * event name (output, | |
541 | * size LTTNG_UST_SYM_NAME_LEN) | |
542 | */ | |
543 | int *loglevel, | |
544 | char **signature, /* | |
545 | * event signature | |
546 | * (output, dynamically | |
547 | * allocated, must be free(3)'d | |
548 | * by the caller if function | |
549 | * returns success.) | |
550 | */ | |
551 | size_t *nr_fields, | |
552 | struct ustctl_field **fields, | |
553 | char **model_emf_uri); | |
554 | ||
555 | /* | |
556 | * Returns 0 on success, negative error value on error. | |
557 | */ | |
558 | int ustctl_reply_register_event(int sock, | |
559 | uint32_t id, /* event id (input) */ | |
560 | int ret_code); /* return code. 0 ok, negative error */ | |
561 | ||
c785c634 MD |
562 | /* |
563 | * Returns 0 on success, negative UST or system error value on error. | |
564 | */ | |
565 | int ustctl_recv_register_enum(int sock, | |
566 | int *session_objd, | |
567 | char *enum_name, | |
568 | struct ustctl_enum_entry **entries, | |
569 | size_t *nr_entries); | |
570 | ||
571 | /* | |
572 | * Returns 0 on success, negative error value on error. | |
573 | */ | |
574 | int ustctl_reply_register_enum(int sock, | |
575 | uint64_t id, /* enum id (input) */ | |
576 | int ret_code); | |
577 | ||
32ce8569 MD |
578 | /* |
579 | * Returns 0 on success, negative UST or system error value on error. | |
580 | */ | |
581 | int ustctl_recv_register_channel(int sock, | |
582 | int *session_objd, /* session descriptor (output) */ | |
583 | int *channel_objd, /* channel descriptor (output) */ | |
584 | size_t *nr_fields, /* context fields */ | |
585 | struct ustctl_field **fields); | |
586 | ||
587 | /* | |
588 | * Returns 0 on success, negative error value on error. | |
589 | */ | |
590 | int ustctl_reply_register_channel(int sock, | |
591 | uint32_t chan_id, | |
592 | enum ustctl_channel_header header_type, | |
593 | int ret_code); /* return code. 0 ok, negative error */ | |
594 | ||
ebabbf58 MD |
595 | /* |
596 | * Counter API. | |
597 | */ | |
598 | ||
599 | enum ustctl_counter_bitness { | |
48dff3ac MD |
600 | USTCTL_COUNTER_BITNESS_32 = 0, |
601 | USTCTL_COUNTER_BITNESS_64 = 1, | |
ebabbf58 MD |
602 | }; |
603 | ||
604 | enum ustctl_counter_arithmetic { | |
605 | USTCTL_COUNTER_ARITHMETIC_MODULAR = 0, | |
606 | USTCTL_COUNTER_ARITHMETIC_SATURATION = 1, | |
607 | }; | |
608 | ||
609 | /* Used as alloc flags. */ | |
610 | enum ustctl_counter_alloc { | |
611 | USTCTL_COUNTER_ALLOC_PER_CPU = (1 << 0), | |
612 | USTCTL_COUNTER_ALLOC_GLOBAL = (1 << 1), | |
613 | }; | |
614 | ||
615 | struct ustctl_daemon_counter; | |
616 | ||
617 | int ustctl_get_nr_cpu_per_counter(void); | |
618 | ||
619 | struct ustctl_counter_dimension { | |
620 | uint64_t size; | |
621 | uint64_t underflow_index; | |
622 | uint64_t overflow_index; | |
623 | uint8_t has_underflow; | |
624 | uint8_t has_overflow; | |
625 | }; | |
626 | ||
627 | struct ustctl_daemon_counter * | |
628 | ustctl_create_counter(size_t nr_dimensions, | |
629 | const struct ustctl_counter_dimension *dimensions, | |
630 | int64_t global_sum_step, | |
631 | int global_counter_fd, | |
632 | int nr_counter_cpu_fds, | |
633 | const int *counter_cpu_fds, | |
634 | enum ustctl_counter_bitness bitness, | |
635 | enum ustctl_counter_arithmetic arithmetic, | |
636 | uint32_t alloc_flags); | |
637 | ||
638 | int ustctl_create_counter_data(struct ustctl_daemon_counter *counter, | |
639 | struct lttng_ust_object_data **counter_data); | |
640 | ||
641 | int ustctl_create_counter_global_data(struct ustctl_daemon_counter *counter, | |
642 | struct lttng_ust_object_data **counter_global_data); | |
643 | int ustctl_create_counter_cpu_data(struct ustctl_daemon_counter *counter, int cpu, | |
644 | struct lttng_ust_object_data **counter_cpu_data); | |
645 | ||
646 | /* | |
647 | * Each counter data and counter cpu data created need to be destroyed | |
648 | * before calling ustctl_destroy_counter(). | |
649 | */ | |
650 | void ustctl_destroy_counter(struct ustctl_daemon_counter *counter); | |
651 | ||
652 | int ustctl_send_counter_data_to_ust(int sock, int parent_handle, | |
653 | struct lttng_ust_object_data *counter_data); | |
654 | int ustctl_send_counter_global_data_to_ust(int sock, | |
655 | struct lttng_ust_object_data *counter_data, | |
656 | struct lttng_ust_object_data *counter_global_data); | |
657 | int ustctl_send_counter_cpu_data_to_ust(int sock, | |
658 | struct lttng_ust_object_data *counter_data, | |
659 | struct lttng_ust_object_data *counter_cpu_data); | |
660 | ||
661 | int ustctl_counter_read(struct ustctl_daemon_counter *counter, | |
662 | const size_t *dimension_indexes, | |
663 | int cpu, int64_t *value, | |
664 | bool *overflow, bool *underflow); | |
665 | int ustctl_counter_aggregate(struct ustctl_daemon_counter *counter, | |
666 | const size_t *dimension_indexes, | |
667 | int64_t *value, | |
668 | bool *overflow, bool *underflow); | |
669 | int ustctl_counter_clear(struct ustctl_daemon_counter *counter, | |
670 | const size_t *dimension_indexes); | |
671 | ||
f3105c67 | 672 | #endif /* _LTTNG_UST_CTL_H */ |