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