Commit | Line | Data |
---|---|---|
75018ab6 | 1 | /* |
21cf9b6b | 2 | * Copyright (C) 2011 EfficiOS Inc. |
ab5be9fa | 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 | ||
c9e313bc | 12 | #include "lttng-ust-abi.hpp" |
75018ab6 | 13 | |
3e06faf9 JG |
14 | #include <common/macros.hpp> |
15 | ||
28f23191 JG |
16 | #include <limits.h> |
17 | #include <sys/types.h> | |
18 | ||
75018ab6 | 19 | #ifndef LTTNG_UST_UUID_LEN |
28f23191 | 20 | #define LTTNG_UST_UUID_LEN 16 |
75018ab6 JG |
21 | #endif |
22 | ||
23 | /* Default unix socket path */ | |
28f23191 | 24 | #define LTTNG_UST_SOCK_FILENAME \ |
d038d337 | 25 | "lttng-ust-sock-" lttng_ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE) |
75018ab6 JG |
26 | |
27 | /* | |
28 | * Shared memory files path are automatically related to shm root, e.g. | |
29 | * /dev/shm under linux. | |
30 | */ | |
28f23191 | 31 | #define LTTNG_UST_WAIT_FILENAME \ |
d038d337 | 32 | "lttng-ust-wait-" lttng_ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE) |
75018ab6 | 33 | |
b623cb6a | 34 | struct lttng_ust_ctl_consumer_channel_attr { |
fc4b93fa | 35 | enum lttng_ust_abi_chan_type type; |
28f23191 JG |
36 | uint64_t subbuf_size; /* bytes */ |
37 | uint64_t num_subbuf; /* power of 2 */ | |
38 | int overwrite; /* 1: overwrite, 0: discard */ | |
39 | unsigned int switch_timer_interval; /* usec */ | |
40 | unsigned int read_timer_interval; /* usec */ | |
41 | enum lttng_ust_abi_output output; /* splice, mmap */ | |
42 | uint32_t chan_id; /* channel ID */ | |
75018ab6 | 43 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
28f23191 | 44 | int64_t blocking_timeout; /* Blocking timeout (usec) */ |
75018ab6 JG |
45 | } LTTNG_PACKED; |
46 | ||
47 | /* | |
48 | * API used by sessiond. | |
49 | */ | |
50 | ||
51 | struct lttng_ust_context_attr { | |
fc4b93fa | 52 | enum lttng_ust_abi_context_type ctx; |
75018ab6 | 53 | union { |
fc4b93fa | 54 | struct lttng_ust_abi_perf_counter_ctx perf_counter; |
75018ab6 JG |
55 | struct { |
56 | char *provider_name; | |
57 | char *ctx_name; | |
58 | } app_ctx; | |
59 | } u; | |
60 | }; | |
61 | ||
62 | /* | |
63 | * Error values: all the following functions return: | |
64 | * >= 0: Success (LTTNG_UST_OK) | |
65 | * < 0: error code. | |
66 | */ | |
b623cb6a MJ |
67 | int lttng_ust_ctl_register_done(int sock); |
68 | int lttng_ust_ctl_create_session(int sock); | |
28f23191 JG |
69 | int lttng_ust_ctl_create_event(int sock, |
70 | struct lttng_ust_abi_event *ev, | |
71 | struct lttng_ust_abi_object_data *channel_data, | |
72 | struct lttng_ust_abi_object_data **event_data); | |
73 | int lttng_ust_ctl_add_context(int sock, | |
74 | struct lttng_ust_context_attr *ctx, | |
75 | struct lttng_ust_abi_object_data *obj_data, | |
76 | struct lttng_ust_abi_object_data **context_data); | |
77 | int lttng_ust_ctl_set_filter(int sock, | |
78 | struct lttng_ust_abi_filter_bytecode *bytecode, | |
79 | struct lttng_ust_abi_object_data *obj_data); | |
80 | int lttng_ust_ctl_set_capture(int sock, | |
81 | struct lttng_ust_abi_capture_bytecode *bytecode, | |
82 | struct lttng_ust_abi_object_data *obj_data); | |
83 | int lttng_ust_ctl_set_exclusion(int sock, | |
84 | struct lttng_ust_abi_event_exclusion *exclusion, | |
85 | struct lttng_ust_abi_object_data *obj_data); | |
fc4b93fa | 86 | |
b623cb6a MJ |
87 | int lttng_ust_ctl_enable(int sock, struct lttng_ust_abi_object_data *object); |
88 | int lttng_ust_ctl_disable(int sock, struct lttng_ust_abi_object_data *object); | |
89 | int lttng_ust_ctl_start_session(int sock, int handle); | |
90 | int lttng_ust_ctl_stop_session(int sock, int handle); | |
75018ab6 | 91 | |
fc4b93fa | 92 | /* |
b623cb6a | 93 | * lttng_ust_ctl_create_event notifier_group creates a event notifier group. It |
fc4b93fa MD |
94 | * establishes the connection with the application by providing a file |
95 | * descriptor of the pipe to be used by the application when a event notifier | |
96 | * of that group is fired. It returns a handle to be used when creating event | |
97 | * notifier in that group. | |
98 | */ | |
28f23191 JG |
99 | int lttng_ust_ctl_create_event_notifier_group( |
100 | int sock, int pipe_fd, struct lttng_ust_abi_object_data **event_notifier_group); | |
fc4b93fa MD |
101 | |
102 | /* | |
b623cb6a | 103 | * lttng_ust_ctl_create_event notifier creates a event notifier in a event notifier |
fc4b93fa MD |
104 | * group giving a event notifier description and a event notifier group handle. |
105 | * It returns a event notifier handle to be used when enabling the event | |
106 | * notifier, attaching filter, attaching exclusion, and disabling the event | |
107 | * notifier. | |
108 | */ | |
b623cb6a | 109 | int lttng_ust_ctl_create_event_notifier(int sock, |
28f23191 JG |
110 | struct lttng_ust_abi_event_notifier *event_notifier, |
111 | struct lttng_ust_abi_object_data *event_notifier_group, | |
112 | struct lttng_ust_abi_object_data **event_notifier_data); | |
233350e5 | 113 | |
75018ab6 | 114 | /* |
b623cb6a | 115 | * lttng_ust_ctl_tracepoint_list returns a tracepoint list handle, or negative |
75018ab6 JG |
116 | * error value. |
117 | */ | |
b623cb6a | 118 | int lttng_ust_ctl_tracepoint_list(int sock); |
75018ab6 JG |
119 | |
120 | /* | |
b623cb6a | 121 | * lttng_ust_ctl_tracepoint_list_get is used to iterate on the tp list |
75018ab6 JG |
122 | * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is |
123 | * returned. | |
124 | */ | |
28f23191 JG |
125 | int lttng_ust_ctl_tracepoint_list_get(int sock, |
126 | int tp_list_handle, | |
127 | struct lttng_ust_abi_tracepoint_iter *iter); | |
75018ab6 JG |
128 | |
129 | /* | |
b623cb6a | 130 | * lttng_ust_ctl_tracepoint_field_list returns a tracepoint field list handle, |
75018ab6 JG |
131 | * or negative error value. |
132 | */ | |
b623cb6a | 133 | int lttng_ust_ctl_tracepoint_field_list(int sock); |
75018ab6 JG |
134 | |
135 | /* | |
b623cb6a | 136 | * lttng_ust_ctl_tracepoint_field_list_get is used to iterate on the tp field |
75018ab6 JG |
137 | * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is |
138 | * returned. | |
139 | */ | |
28f23191 JG |
140 | int lttng_ust_ctl_tracepoint_field_list_get(int sock, |
141 | int tp_field_list_handle, | |
142 | struct lttng_ust_abi_field_iter *iter); | |
75018ab6 | 143 | |
b623cb6a MJ |
144 | int lttng_ust_ctl_tracer_version(int sock, struct lttng_ust_abi_tracer_version *v); |
145 | int lttng_ust_ctl_wait_quiescent(int sock); | |
75018ab6 | 146 | |
b623cb6a | 147 | int lttng_ust_ctl_sock_flush_buffer(int sock, struct lttng_ust_abi_object_data *object); |
75018ab6 | 148 | |
b623cb6a | 149 | int lttng_ust_ctl_calibrate(int sock, struct lttng_ust_abi_calibrate *calibrate); |
75018ab6 JG |
150 | |
151 | /* Release object created by members of this API. */ | |
b623cb6a | 152 | int lttng_ust_ctl_release_object(int sock, struct lttng_ust_abi_object_data *data); |
75018ab6 | 153 | /* Release handle returned by create session. */ |
b623cb6a | 154 | int lttng_ust_ctl_release_handle(int sock, int handle); |
75018ab6 | 155 | |
b623cb6a | 156 | int lttng_ust_ctl_recv_channel_from_consumer(int sock, |
28f23191 | 157 | struct lttng_ust_abi_object_data **channel_data); |
b623cb6a | 158 | int lttng_ust_ctl_recv_stream_from_consumer(int sock, |
28f23191 JG |
159 | struct lttng_ust_abi_object_data **stream_data); |
160 | int lttng_ust_ctl_send_channel_to_ust(int sock, | |
161 | int session_handle, | |
162 | struct lttng_ust_abi_object_data *channel_data); | |
b623cb6a | 163 | int lttng_ust_ctl_send_stream_to_ust(int sock, |
28f23191 JG |
164 | struct lttng_ust_abi_object_data *channel_data, |
165 | struct lttng_ust_abi_object_data *stream_data); | |
75018ab6 JG |
166 | |
167 | /* | |
b623cb6a | 168 | * lttng_ust_ctl_duplicate_ust_object_data allocated a new object in "dest" if |
75018ab6 | 169 | * it succeeds (returns 0). It must be released using |
b623cb6a | 170 | * lttng_ust_ctl_release_object() and then freed with free(). |
75018ab6 | 171 | */ |
b623cb6a | 172 | int lttng_ust_ctl_duplicate_ust_object_data(struct lttng_ust_abi_object_data **dest, |
28f23191 | 173 | struct lttng_ust_abi_object_data *src); |
75018ab6 JG |
174 | |
175 | /* | |
176 | * API used by consumer. | |
177 | */ | |
178 | ||
b623cb6a MJ |
179 | struct lttng_ust_ctl_consumer_channel; |
180 | struct lttng_ust_ctl_consumer_stream; | |
181 | struct lttng_ust_ctl_consumer_channel_attr; | |
75018ab6 | 182 | |
af9ab8f4 | 183 | int lttng_ust_ctl_get_nr_stream_per_channel(); |
75018ab6 | 184 | |
28f23191 JG |
185 | struct lttng_ust_ctl_consumer_channel *lttng_ust_ctl_create_channel( |
186 | struct lttng_ust_ctl_consumer_channel_attr *attr, const int *stream_fds, int nr_stream_fds); | |
75018ab6 JG |
187 | /* |
188 | * Each stream created needs to be destroyed before calling | |
b623cb6a | 189 | * lttng_ust_ctl_destroy_channel(). |
75018ab6 | 190 | */ |
b623cb6a | 191 | void lttng_ust_ctl_destroy_channel(struct lttng_ust_ctl_consumer_channel *chan); |
75018ab6 | 192 | |
b623cb6a | 193 | int lttng_ust_ctl_send_channel_to_sessiond(int sock, |
28f23191 | 194 | struct lttng_ust_ctl_consumer_channel *channel); |
b623cb6a MJ |
195 | int lttng_ust_ctl_channel_close_wait_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan); |
196 | int lttng_ust_ctl_channel_close_wakeup_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan); | |
197 | int lttng_ust_ctl_channel_get_wait_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan); | |
198 | int lttng_ust_ctl_channel_get_wakeup_fd(struct lttng_ust_ctl_consumer_channel *consumer_chan); | |
75018ab6 | 199 | |
28f23191 JG |
200 | int lttng_ust_ctl_write_metadata_to_channel(struct lttng_ust_ctl_consumer_channel *channel, |
201 | const char *metadata_str, /* NOT null-terminated */ | |
202 | size_t len); /* metadata length */ | |
203 | ssize_t lttng_ust_ctl_write_one_packet_to_channel(struct lttng_ust_ctl_consumer_channel *channel, | |
204 | const char *metadata_str, /* NOT null-terminated | |
205 | */ | |
206 | size_t len); /* metadata length */ | |
75018ab6 JG |
207 | |
208 | /* | |
209 | * Send a NULL stream to finish iteration over all streams of a given | |
210 | * channel. | |
211 | */ | |
28f23191 | 212 | int lttng_ust_ctl_send_stream_to_sessiond(int sock, struct lttng_ust_ctl_consumer_stream *stream); |
b623cb6a MJ |
213 | int lttng_ust_ctl_stream_close_wait_fd(struct lttng_ust_ctl_consumer_stream *stream); |
214 | int lttng_ust_ctl_stream_close_wakeup_fd(struct lttng_ust_ctl_consumer_stream *stream); | |
215 | int lttng_ust_ctl_stream_get_wait_fd(struct lttng_ust_ctl_consumer_stream *stream); | |
216 | int lttng_ust_ctl_stream_get_wakeup_fd(struct lttng_ust_ctl_consumer_stream *stream); | |
75018ab6 JG |
217 | |
218 | /* Create/destroy stream buffers for read */ | |
b623cb6a | 219 | struct lttng_ust_ctl_consumer_stream * |
28f23191 | 220 | lttng_ust_ctl_create_stream(struct lttng_ust_ctl_consumer_channel *channel, int cpu); |
b623cb6a | 221 | void lttng_ust_ctl_destroy_stream(struct lttng_ust_ctl_consumer_stream *stream); |
75018ab6 JG |
222 | |
223 | /* For mmap mode, readable without "get" operation */ | |
28f23191 | 224 | int lttng_ust_ctl_get_mmap_len(struct lttng_ust_ctl_consumer_stream *stream, unsigned long *len); |
b623cb6a | 225 | int lttng_ust_ctl_get_max_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 | 226 | unsigned long *len); |
75018ab6 JG |
227 | |
228 | /* | |
229 | * For mmap mode, operate on the current packet (between get/put or | |
230 | * get_next/put_next). | |
231 | */ | |
b623cb6a MJ |
232 | void *lttng_ust_ctl_get_mmap_base(struct lttng_ust_ctl_consumer_stream *stream); |
233 | int lttng_ust_ctl_get_mmap_read_offset(struct lttng_ust_ctl_consumer_stream *stream, | |
28f23191 JG |
234 | unsigned long *off); |
235 | int lttng_ust_ctl_get_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream, unsigned long *len); | |
b623cb6a | 236 | int lttng_ust_ctl_get_padded_subbuf_size(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 | 237 | unsigned long *len); |
b623cb6a MJ |
238 | int lttng_ust_ctl_get_next_subbuf(struct lttng_ust_ctl_consumer_stream *stream); |
239 | int lttng_ust_ctl_put_next_subbuf(struct lttng_ust_ctl_consumer_stream *stream); | |
75018ab6 JG |
240 | |
241 | /* snapshot */ | |
242 | ||
b623cb6a MJ |
243 | int lttng_ust_ctl_snapshot(struct lttng_ust_ctl_consumer_stream *stream); |
244 | int lttng_ust_ctl_snapshot_sample_positions(struct lttng_ust_ctl_consumer_stream *stream); | |
245 | int lttng_ust_ctl_snapshot_get_consumed(struct lttng_ust_ctl_consumer_stream *stream, | |
28f23191 | 246 | unsigned long *pos); |
b623cb6a | 247 | int lttng_ust_ctl_snapshot_get_produced(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 JG |
248 | unsigned long *pos); |
249 | int lttng_ust_ctl_get_subbuf(struct lttng_ust_ctl_consumer_stream *stream, unsigned long *pos); | |
b623cb6a | 250 | int lttng_ust_ctl_put_subbuf(struct lttng_ust_ctl_consumer_stream *stream); |
75018ab6 | 251 | |
28f23191 | 252 | int lttng_ust_ctl_flush_buffer(struct lttng_ust_ctl_consumer_stream *stream, int producer_active); |
881fc67f | 253 | int lttng_ust_ctl_clear_buffer(struct lttng_ust_ctl_consumer_stream *stream); |
75018ab6 JG |
254 | |
255 | /* index */ | |
fc4b93fa MD |
256 | |
257 | /* | |
258 | * Getters which need to be used on the current packet (between get/put | |
259 | * or get_next/put_next. | |
260 | */ | |
261 | ||
b623cb6a | 262 | int lttng_ust_ctl_get_timestamp_begin(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 | 263 | uint64_t *timestamp_begin); |
b623cb6a | 264 | int lttng_ust_ctl_get_timestamp_end(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 | 265 | uint64_t *timestamp_end); |
b623cb6a | 266 | int lttng_ust_ctl_get_events_discarded(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 | 267 | uint64_t *events_discarded); |
b623cb6a | 268 | int lttng_ust_ctl_get_content_size(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 | 269 | uint64_t *content_size); |
b623cb6a | 270 | int lttng_ust_ctl_get_packet_size(struct lttng_ust_ctl_consumer_stream *stream, |
28f23191 JG |
271 | uint64_t *packet_size); |
272 | int lttng_ust_ctl_get_sequence_number(struct lttng_ust_ctl_consumer_stream *stream, uint64_t *seq); | |
fc4b93fa MD |
273 | |
274 | /* | |
275 | * Getter returning state invariant for the stream, which can be used | |
276 | * without "get" operation. | |
277 | */ | |
278 | ||
28f23191 JG |
279 | int lttng_ust_ctl_get_stream_id(struct lttng_ust_ctl_consumer_stream *stream, uint64_t *stream_id); |
280 | int lttng_ust_ctl_get_instance_id(struct lttng_ust_ctl_consumer_stream *stream, uint64_t *id); | |
75018ab6 | 281 | |
fc4b93fa MD |
282 | /* |
283 | * Getter returning the current timestamp as perceived from the | |
284 | * tracer. | |
285 | */ | |
28f23191 | 286 | int lttng_ust_ctl_get_current_timestamp(struct lttng_ust_ctl_consumer_stream *stream, uint64_t *ts); |
fc4b93fa | 287 | |
75018ab6 | 288 | /* returns whether UST has perf counters support. */ |
af9ab8f4 | 289 | int lttng_ust_ctl_has_perf_counters(); |
75018ab6 JG |
290 | |
291 | /* Regenerate the statedump. */ | |
b623cb6a | 292 | int lttng_ust_ctl_regenerate_statedump(int sock, int handle); |
75018ab6 JG |
293 | |
294 | /* event registry management */ | |
295 | ||
b623cb6a MJ |
296 | enum lttng_ust_ctl_socket_type { |
297 | LTTNG_UST_CTL_SOCKET_CMD = 0, | |
298 | LTTNG_UST_CTL_SOCKET_NOTIFY = 1, | |
75018ab6 JG |
299 | }; |
300 | ||
b623cb6a MJ |
301 | enum lttng_ust_ctl_notify_cmd { |
302 | LTTNG_UST_CTL_NOTIFY_CMD_EVENT = 0, | |
303 | LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL = 1, | |
304 | LTTNG_UST_CTL_NOTIFY_CMD_ENUM = 2, | |
0f825a63 | 305 | LTTNG_UST_CTL_NOTIFY_CMD_KEY = 3, |
75018ab6 JG |
306 | }; |
307 | ||
b623cb6a MJ |
308 | enum lttng_ust_ctl_channel_header { |
309 | LTTNG_UST_CTL_CHANNEL_HEADER_UNKNOWN = 0, | |
310 | LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT = 1, | |
311 | LTTNG_UST_CTL_CHANNEL_HEADER_LARGE = 2, | |
75018ab6 JG |
312 | }; |
313 | ||
314 | /* event type structures */ | |
315 | ||
b623cb6a MJ |
316 | enum lttng_ust_ctl_abstract_types { |
317 | lttng_ust_ctl_atype_integer, | |
28f23191 JG |
318 | lttng_ust_ctl_atype_enum, /* legacy */ |
319 | lttng_ust_ctl_atype_array, /* legacy */ | |
320 | lttng_ust_ctl_atype_sequence, /* legacy */ | |
b623cb6a MJ |
321 | lttng_ust_ctl_atype_string, |
322 | lttng_ust_ctl_atype_float, | |
28f23191 JG |
323 | lttng_ust_ctl_atype_variant, /* legacy */ |
324 | lttng_ust_ctl_atype_struct, /* legacy */ | |
b623cb6a MJ |
325 | lttng_ust_ctl_atype_enum_nestable, |
326 | lttng_ust_ctl_atype_array_nestable, | |
327 | lttng_ust_ctl_atype_sequence_nestable, | |
328 | lttng_ust_ctl_atype_struct_nestable, | |
329 | lttng_ust_ctl_atype_variant_nestable, | |
330 | NR_LTTNG_UST_CTL_ABSTRACT_TYPES, | |
75018ab6 JG |
331 | }; |
332 | ||
b623cb6a MJ |
333 | enum lttng_ust_ctl_string_encodings { |
334 | lttng_ust_ctl_encode_none = 0, | |
335 | lttng_ust_ctl_encode_UTF8 = 1, | |
336 | lttng_ust_ctl_encode_ASCII = 2, | |
337 | NR_LTTNG_UST_CTL_STRING_ENCODINGS, | |
75018ab6 JG |
338 | }; |
339 | ||
28f23191 | 340 | #define LTTNG_UST_CTL_UST_INTEGER_TYPE_PADDING 24 |
b623cb6a | 341 | struct lttng_ust_ctl_integer_type { |
28f23191 | 342 | uint32_t size; /* in bits */ |
75018ab6 JG |
343 | uint32_t signedness; |
344 | uint32_t reverse_byte_order; | |
28f23191 JG |
345 | uint32_t base; /* 2, 8, 10, 16, for pretty print */ |
346 | int32_t encoding; /* enum lttng_ust_ctl_string_encodings */ | |
347 | uint16_t alignment; /* in bits */ | |
b623cb6a | 348 | char padding[LTTNG_UST_CTL_UST_INTEGER_TYPE_PADDING]; |
75018ab6 JG |
349 | } LTTNG_PACKED; |
350 | ||
28f23191 | 351 | #define LTTNG_UST_CTL_UST_FLOAT_TYPE_PADDING 24 |
b623cb6a | 352 | struct lttng_ust_ctl_float_type { |
28f23191 JG |
353 | uint32_t exp_dig; /* exponent digits, in bits */ |
354 | uint32_t mant_dig; /* mantissa digits, in bits */ | |
75018ab6 | 355 | uint32_t reverse_byte_order; |
28f23191 | 356 | uint16_t alignment; /* in bits */ |
b623cb6a | 357 | char padding[LTTNG_UST_CTL_UST_FLOAT_TYPE_PADDING]; |
75018ab6 JG |
358 | } LTTNG_PACKED; |
359 | ||
28f23191 | 360 | #define LTTNG_UST_CTL_UST_ENUM_VALUE_PADDING 15 |
b623cb6a | 361 | struct lttng_ust_ctl_enum_value { |
75018ab6 JG |
362 | uint64_t value; |
363 | uint8_t signedness; | |
b623cb6a | 364 | char padding[LTTNG_UST_CTL_UST_ENUM_VALUE_PADDING]; |
75018ab6 JG |
365 | } LTTNG_PACKED; |
366 | ||
b623cb6a MJ |
367 | enum lttng_ust_ctl_ust_enum_entry_options { |
368 | LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0, | |
75018ab6 JG |
369 | }; |
370 | ||
28f23191 | 371 | #define LTTNG_UST_CTL_UST_ENUM_ENTRY_PADDING 32 |
b623cb6a MJ |
372 | struct lttng_ust_ctl_enum_entry { |
373 | struct lttng_ust_ctl_enum_value start, end; /* start and end are inclusive */ | |
fc4b93fa | 374 | char string[LTTNG_UST_ABI_SYM_NAME_LEN]; |
75018ab6 JG |
375 | union { |
376 | struct { | |
377 | uint32_t options; | |
378 | } LTTNG_PACKED extra; | |
b623cb6a | 379 | char padding[LTTNG_UST_CTL_UST_ENUM_ENTRY_PADDING]; |
75018ab6 JG |
380 | } u; |
381 | } LTTNG_PACKED; | |
382 | ||
0d32d1a9 | 383 | /* legacy */ |
28f23191 | 384 | #define LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING 296 |
b623cb6a MJ |
385 | union _lttng_ust_ctl_basic_type { |
386 | struct lttng_ust_ctl_integer_type integer; | |
75018ab6 | 387 | struct { |
fc4b93fa | 388 | char name[LTTNG_UST_ABI_SYM_NAME_LEN]; |
b623cb6a | 389 | struct lttng_ust_ctl_integer_type container_type; |
28f23191 | 390 | uint64_t id; /* enum ID in sessiond. */ |
75018ab6 JG |
391 | } enumeration; |
392 | struct { | |
28f23191 | 393 | int32_t encoding; /* enum lttng_ust_ctl_string_encodings */ |
75018ab6 | 394 | } string; |
b623cb6a MJ |
395 | struct lttng_ust_ctl_float_type _float; |
396 | char padding[LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING]; | |
75018ab6 JG |
397 | } LTTNG_PACKED; |
398 | ||
0d32d1a9 | 399 | /* legacy */ |
b623cb6a MJ |
400 | struct lttng_ust_ctl_basic_type { |
401 | enum lttng_ust_ctl_abstract_types atype; | |
75018ab6 | 402 | union { |
b623cb6a | 403 | union _lttng_ust_ctl_basic_type basic; |
75018ab6 JG |
404 | } u; |
405 | } LTTNG_PACKED; | |
406 | ||
0d32d1a9 MD |
407 | /* |
408 | * Padding is derived from largest member: u.legacy.sequence which | |
b623cb6a | 409 | * contains two basic types, each with LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING. |
0d32d1a9 | 410 | */ |
28f23191 | 411 | #define LTTNG_UST_CTL_UST_TYPE_PADDING (2 * LTTNG_UST_CTL_UST_BASIC_TYPE_PADDING) |
b623cb6a MJ |
412 | struct lttng_ust_ctl_type { |
413 | enum lttng_ust_ctl_abstract_types atype; | |
75018ab6 | 414 | union { |
b623cb6a MJ |
415 | struct lttng_ust_ctl_integer_type integer; |
416 | struct lttng_ust_ctl_float_type _float; | |
0d32d1a9 | 417 | struct { |
28f23191 | 418 | int32_t encoding; /* enum lttng_ust_ctl_string_encodings */ |
0d32d1a9 MD |
419 | } string; |
420 | struct { | |
fc4b93fa | 421 | char name[LTTNG_UST_ABI_SYM_NAME_LEN]; |
28f23191 | 422 | uint64_t id; /* enum ID in sessiond. */ |
b623cb6a | 423 | /* container_type follows after this struct lttng_ust_ctl_field. */ |
0d32d1a9 | 424 | } enum_nestable; |
75018ab6 | 425 | struct { |
28f23191 | 426 | uint32_t length; /* num. elems. */ |
0d32d1a9 | 427 | uint32_t alignment; |
b623cb6a | 428 | /* elem_type follows after this struct lttng_ust_ctl_field. */ |
0d32d1a9 | 429 | } array_nestable; |
75018ab6 | 430 | struct { |
fc4b93fa | 431 | char length_name[LTTNG_UST_ABI_SYM_NAME_LEN]; |
28f23191 | 432 | uint32_t alignment; /* Alignment before elements. */ |
0d32d1a9 MD |
433 | /* elem_type follows after the length_type. */ |
434 | } sequence_nestable; | |
435 | struct { | |
436 | uint32_t nr_fields; | |
437 | uint32_t alignment; | |
b623cb6a | 438 | /* Followed by nr_fields struct lttng_ust_ctl_field. */ |
0d32d1a9 | 439 | } struct_nestable; |
75018ab6 JG |
440 | struct { |
441 | uint32_t nr_choices; | |
fc4b93fa | 442 | char tag_name[LTTNG_UST_ABI_SYM_NAME_LEN]; |
0d32d1a9 | 443 | uint32_t alignment; |
b623cb6a | 444 | /* Followed by nr_choices struct lttng_ust_ctl_field. */ |
0d32d1a9 MD |
445 | } variant_nestable; |
446 | ||
447 | /* Legacy ABI */ | |
448 | union { | |
b623cb6a | 449 | union _lttng_ust_ctl_basic_type basic; |
0d32d1a9 | 450 | struct { |
b623cb6a | 451 | struct lttng_ust_ctl_basic_type elem_type; |
28f23191 | 452 | uint32_t length; /* num. elems. */ |
0d32d1a9 MD |
453 | } array; |
454 | struct { | |
b623cb6a MJ |
455 | struct lttng_ust_ctl_basic_type length_type; |
456 | struct lttng_ust_ctl_basic_type elem_type; | |
0d32d1a9 MD |
457 | } sequence; |
458 | struct { | |
459 | uint32_t nr_fields; | |
b623cb6a | 460 | /* Followed by nr_fields struct lttng_ust_ctl_field. */ |
0d32d1a9 MD |
461 | } _struct; |
462 | struct { | |
463 | uint32_t nr_choices; | |
fc4b93fa | 464 | char tag_name[LTTNG_UST_ABI_SYM_NAME_LEN]; |
b623cb6a | 465 | /* Followed by nr_choices struct lttng_ust_ctl_field. */ |
0d32d1a9 MD |
466 | } variant; |
467 | } legacy; | |
b623cb6a | 468 | char padding[LTTNG_UST_CTL_UST_TYPE_PADDING]; |
75018ab6 JG |
469 | } u; |
470 | } LTTNG_PACKED; | |
471 | ||
28f23191 | 472 | #define LTTNG_UST_CTL_UST_FIELD_PADDING 28 |
b623cb6a | 473 | struct lttng_ust_ctl_field { |
fc4b93fa | 474 | char name[LTTNG_UST_ABI_SYM_NAME_LEN]; |
b623cb6a MJ |
475 | struct lttng_ust_ctl_type type; |
476 | char padding[LTTNG_UST_CTL_UST_FIELD_PADDING]; | |
75018ab6 JG |
477 | } LTTNG_PACKED; |
478 | ||
479 | /* | |
480 | * Returns 0 on success, negative error value on error. | |
481 | * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned, | |
482 | * the output fields are not populated. | |
483 | */ | |
b623cb6a | 484 | int lttng_ust_ctl_recv_reg_msg(int sock, |
28f23191 JG |
485 | enum lttng_ust_ctl_socket_type *type, |
486 | uint32_t *major, | |
487 | uint32_t *minor, | |
488 | uint32_t *pid, | |
489 | uint32_t *ppid, | |
490 | uint32_t *uid, | |
491 | uint32_t *gid, | |
492 | uint32_t *bits_per_long, | |
493 | uint32_t *uint8_t_alignment, | |
494 | uint32_t *uint16_t_alignment, | |
495 | uint32_t *uint32_t_alignment, | |
496 | uint32_t *uint64_t_alignment, | |
497 | uint32_t *long_alignment, | |
498 | int *byte_order, | |
499 | char *name); /* size LTTNG_UST_ABI_PROCNAME_LEN */ | |
75018ab6 JG |
500 | |
501 | /* | |
502 | * Returns 0 on success, negative UST or system error value on error. | |
503 | * Receive the notification command. The "notify_cmd" can then be used | |
b623cb6a MJ |
504 | * by the caller to find out which lttng_ust_ctl_recv_* function should be |
505 | * called to receive the notification, and which lttng_ust_ctl_reply_* is | |
75018ab6 JG |
506 | * appropriate. |
507 | */ | |
b623cb6a | 508 | int lttng_ust_ctl_recv_notify(int sock, enum lttng_ust_ctl_notify_cmd *notify_cmd); |
75018ab6 JG |
509 | |
510 | /* | |
511 | * Returns 0 on success, negative UST or system error value on error. | |
512 | */ | |
b623cb6a | 513 | int lttng_ust_ctl_recv_register_event(int sock, |
28f23191 JG |
514 | int *session_objd, /* session descriptor (output) */ |
515 | int *channel_objd, /* channel descriptor (output) */ | |
516 | char *event_name, /* | |
517 | * event name (output, | |
518 | * size LTTNG_UST_ABI_SYM_NAME_LEN) | |
519 | */ | |
520 | int *loglevel, | |
521 | char **signature, /* | |
522 | * event signature | |
523 | * (output, dynamically | |
524 | * allocated, must be free(3)'d | |
525 | * by the caller if function | |
526 | * returns success.) | |
527 | */ | |
528 | size_t *nr_fields, | |
529 | struct lttng_ust_ctl_field **fields, | |
d038d337 FD |
530 | char **model_emf_uri, |
531 | uint64_t *user_token); | |
75018ab6 JG |
532 | |
533 | /* | |
534 | * Returns 0 on success, negative error value on error. | |
535 | */ | |
b623cb6a | 536 | int lttng_ust_ctl_reply_register_event(int sock, |
0f825a63 | 537 | uint32_t id, /* id (input) */ |
28f23191 | 538 | int ret_code); /* return code. 0 ok, negative error */ |
75018ab6 | 539 | |
0f825a63 MD |
540 | /* |
541 | * Returns 0 on success, negative UST or system error value on error. | |
542 | */ | |
543 | int lttng_ust_ctl_recv_register_key(int sock, | |
d425df61 JG |
544 | int *session_objd, /* session descriptor (output) */ |
545 | int *map_objd, /* map descriptor (output) */ | |
546 | uint32_t *dimension, /* | |
547 | * Against which dimension is | |
548 | * this key expressed. (output) | |
549 | */ | |
550 | uint64_t **dimension_indexes, /* | |
551 | * Indexes (output, | |
552 | * dynamically | |
553 | * allocated, must be | |
554 | * free(3)'d by the | |
555 | * caller if function | |
556 | * returns success.) | |
557 | * Contains @dimension | |
558 | * elements. | |
559 | */ | |
560 | char **key_string, /* | |
561 | * key string (output, | |
562 | * dynamically allocated, must | |
563 | * be free(3)'d by the caller if | |
564 | * function returns success.) | |
565 | */ | |
566 | uint64_t *user_token); | |
0f825a63 MD |
567 | |
568 | /* | |
569 | * Returns 0 on success, negative error value on error. | |
570 | */ | |
571 | int lttng_ust_ctl_reply_register_key(int sock, | |
d425df61 JG |
572 | uint64_t index, /* Index within dimension (input) */ |
573 | int ret_code); /* return code. 0 ok, negative error */ | |
0f825a63 | 574 | |
75018ab6 JG |
575 | /* |
576 | * Returns 0 on success, negative UST or system error value on error. | |
577 | */ | |
b623cb6a | 578 | int lttng_ust_ctl_recv_register_enum(int sock, |
28f23191 JG |
579 | int *session_objd, |
580 | char *enum_name, | |
581 | struct lttng_ust_ctl_enum_entry **entries, | |
582 | size_t *nr_entries); | |
75018ab6 JG |
583 | |
584 | /* | |
585 | * Returns 0 on success, negative error value on error. | |
586 | */ | |
b623cb6a | 587 | int lttng_ust_ctl_reply_register_enum(int sock, |
28f23191 JG |
588 | uint64_t id, /* enum id (input) */ |
589 | int ret_code); | |
75018ab6 JG |
590 | |
591 | /* | |
592 | * Returns 0 on success, negative UST or system error value on error. | |
593 | */ | |
b623cb6a | 594 | int lttng_ust_ctl_recv_register_channel(int sock, |
28f23191 JG |
595 | int *session_objd, /* session descriptor (output) */ |
596 | int *channel_objd, /* channel descriptor (output) */ | |
597 | size_t *nr_fields, /* context fields */ | |
598 | struct lttng_ust_ctl_field **fields); | |
75018ab6 JG |
599 | |
600 | /* | |
601 | * Returns 0 on success, negative error value on error. | |
602 | */ | |
b623cb6a | 603 | int lttng_ust_ctl_reply_register_channel(int sock, |
28f23191 JG |
604 | uint32_t chan_id, |
605 | enum lttng_ust_ctl_channel_header header_type, | |
606 | int ret_code); /* return code. 0 ok, negative error */ | |
75018ab6 | 607 | |
fc4b93fa MD |
608 | /* |
609 | * Counter API. | |
610 | */ | |
611 | ||
b623cb6a MJ |
612 | enum lttng_ust_ctl_counter_bitness { |
613 | LTTNG_UST_CTL_COUNTER_BITNESS_32 = 0, | |
614 | LTTNG_UST_CTL_COUNTER_BITNESS_64 = 1, | |
fc4b93fa MD |
615 | }; |
616 | ||
b623cb6a | 617 | enum lttng_ust_ctl_counter_arithmetic { |
28f23191 JG |
618 | LTTNG_UST_CTL_COUNTER_ARITHMETIC_MODULAR = 0, |
619 | LTTNG_UST_CTL_COUNTER_ARITHMETIC_SATURATION = 1, | |
fc4b93fa MD |
620 | }; |
621 | ||
0f825a63 MD |
622 | enum lttng_ust_ctl_key_type { |
623 | LTTNG_UST_CTL_KEY_TYPE_TOKENS = 0, | |
624 | LTTNG_UST_CTL_KEY_TYPE_INTEGER = 1, | |
625 | }; | |
626 | ||
fc4b93fa | 627 | /* Used as alloc flags. */ |
b623cb6a MJ |
628 | enum lttng_ust_ctl_counter_alloc { |
629 | LTTNG_UST_CTL_COUNTER_ALLOC_PER_CPU = (1 << 0), | |
630 | LTTNG_UST_CTL_COUNTER_ALLOC_GLOBAL = (1 << 1), | |
fc4b93fa MD |
631 | }; |
632 | ||
b623cb6a | 633 | struct lttng_ust_ctl_daemon_counter; |
fc4b93fa | 634 | |
af9ab8f4 | 635 | int lttng_ust_ctl_get_nr_cpu_per_counter(); |
fc4b93fa | 636 | |
b623cb6a | 637 | struct lttng_ust_ctl_counter_dimension { |
fc4b93fa MD |
638 | uint64_t size; |
639 | uint64_t underflow_index; | |
640 | uint64_t overflow_index; | |
0f825a63 | 641 | enum lttng_ust_ctl_key_type key_type; |
fc4b93fa MD |
642 | uint8_t has_underflow; |
643 | uint8_t has_overflow; | |
644 | }; | |
645 | ||
b623cb6a | 646 | struct lttng_ust_ctl_daemon_counter * |
28f23191 JG |
647 | lttng_ust_ctl_create_counter(size_t nr_dimensions, |
648 | const struct lttng_ust_ctl_counter_dimension *dimensions, | |
649 | int64_t global_sum_step, | |
650 | int global_counter_fd, | |
651 | int nr_counter_cpu_fds, | |
652 | const int *counter_cpu_fds, | |
653 | enum lttng_ust_ctl_counter_bitness bitness, | |
654 | enum lttng_ust_ctl_counter_arithmetic arithmetic, | |
655 | uint32_t alloc_flags, | |
656 | bool coalesce_hits); | |
fc4b93fa | 657 | |
b623cb6a | 658 | int lttng_ust_ctl_create_counter_data(struct lttng_ust_ctl_daemon_counter *counter, |
28f23191 | 659 | struct lttng_ust_abi_object_data **counter_data); |
fc4b93fa | 660 | |
b623cb6a | 661 | int lttng_ust_ctl_create_counter_global_data(struct lttng_ust_ctl_daemon_counter *counter, |
28f23191 JG |
662 | struct lttng_ust_abi_object_data **counter_global_data); |
663 | int lttng_ust_ctl_create_counter_cpu_data(struct lttng_ust_ctl_daemon_counter *counter, | |
664 | int cpu, | |
665 | struct lttng_ust_abi_object_data **counter_cpu_data); | |
fc4b93fa MD |
666 | |
667 | /* | |
668 | * Each counter data and counter cpu data created need to be destroyed | |
b623cb6a | 669 | * before calling lttng_ust_ctl_destroy_counter(). |
fc4b93fa | 670 | */ |
b623cb6a | 671 | void lttng_ust_ctl_destroy_counter(struct lttng_ust_ctl_daemon_counter *counter); |
fc4b93fa | 672 | |
28f23191 JG |
673 | int lttng_ust_ctl_send_counter_data_to_ust(int sock, |
674 | int parent_handle, | |
675 | struct lttng_ust_abi_object_data *counter_data); | |
676 | int lttng_ust_ctl_send_counter_global_data_to_ust( | |
677 | int sock, | |
678 | struct lttng_ust_abi_object_data *counter_data, | |
679 | struct lttng_ust_abi_object_data *counter_global_data); | |
b623cb6a | 680 | int lttng_ust_ctl_send_counter_cpu_data_to_ust(int sock, |
28f23191 JG |
681 | struct lttng_ust_abi_object_data *counter_data, |
682 | struct lttng_ust_abi_object_data *counter_cpu_data); | |
fc4b93fa | 683 | |
b623cb6a | 684 | int lttng_ust_ctl_counter_read(struct lttng_ust_ctl_daemon_counter *counter, |
28f23191 JG |
685 | const size_t *dimension_indexes, |
686 | int cpu, | |
687 | int64_t *value, | |
688 | bool *overflow, | |
689 | bool *underflow); | |
b623cb6a | 690 | int lttng_ust_ctl_counter_aggregate(struct lttng_ust_ctl_daemon_counter *counter, |
28f23191 JG |
691 | const size_t *dimension_indexes, |
692 | int64_t *value, | |
693 | bool *overflow, | |
694 | bool *underflow); | |
b623cb6a | 695 | int lttng_ust_ctl_counter_clear(struct lttng_ust_ctl_daemon_counter *counter, |
28f23191 | 696 | const size_t *dimension_indexes); |
fc4b93fa | 697 | |
d038d337 FD |
698 | int lttng_ust_ctl_counter_create_event(int sock, |
699 | struct lttng_ust_abi_counter_event *counter_event, | |
700 | size_t counter_event_len, | |
701 | struct lttng_ust_abi_object_data *counter_data, | |
702 | struct lttng_ust_abi_object_data **counter_event_data); | |
703 | ||
a04b9ffd | 704 | void lttng_ust_ctl_sigbus_handle(void *addr); |
881fc67f | 705 | |
d038d337 FD |
706 | int lttng_ust_ctl_get_version(uint32_t *major, uint32_t *minor, uint32_t *patchlevel); |
707 | ||
75018ab6 | 708 | #endif /* LTTNG_UST_CTL_INTERNAL_H */ |