Commit | Line | Data |
---|---|---|
75018ab6 | 1 | /* |
ab5be9fa | 2 | * Copyright 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
75018ab6 | 3 | * |
ab5be9fa | 4 | * SPDX-License-Identifier: MIT |
75018ab6 | 5 | * |
ab5be9fa | 6 | * Copied from LTTng-UST lttng/ust-abi.h |
75018ab6 | 7 | * |
ab5be9fa | 8 | * LTTng-UST ABI header |
75018ab6 | 9 | * |
75018ab6 JG |
10 | */ |
11 | ||
12 | #ifndef LTTNG_UST_ABI_INTERNAL_H | |
13 | #define LTTNG_UST_ABI_INTERNAL_H | |
14 | ||
15 | #include <stdint.h> | |
fe7de4bf | 16 | #include <common/macros.h> |
75018ab6 | 17 | |
95194333 JG |
18 | #ifndef LTTNG_PACKED |
19 | #error "LTTNG_PACKED should be defined" | |
20 | #endif | |
75018ab6 JG |
21 | |
22 | #ifndef __ust_stringify | |
23 | #define __ust_stringify1(x) #x | |
24 | #define __ust_stringify(x) __ust_stringify1(x) | |
25 | #endif /* __ust_stringify */ | |
26 | ||
27 | #define LTTNG_UST_SYM_NAME_LEN 256 | |
28 | #define LTTNG_UST_ABI_PROCNAME_LEN 16 | |
29 | ||
30 | /* UST comm magic number, used to validate protocol and endianness. */ | |
31 | #define LTTNG_UST_COMM_MAGIC 0xC57C57C5 | |
32 | ||
33 | /* Version for ABI between liblttng-ust, sessiond, consumerd */ | |
34 | #define LTTNG_UST_ABI_MAJOR_VERSION 8 | |
208ddc06 | 35 | #define LTTNG_UST_ABI_MINOR_VERSION 1 |
75018ab6 | 36 | |
75018ab6 JG |
37 | enum lttng_ust_instrumentation { |
38 | LTTNG_UST_TRACEPOINT = 0, | |
39 | LTTNG_UST_PROBE = 1, | |
40 | LTTNG_UST_FUNCTION = 2, | |
41 | }; | |
42 | ||
43 | enum lttng_ust_loglevel_type { | |
44 | LTTNG_UST_LOGLEVEL_ALL = 0, | |
45 | LTTNG_UST_LOGLEVEL_RANGE = 1, | |
46 | LTTNG_UST_LOGLEVEL_SINGLE = 2, | |
47 | }; | |
48 | ||
49 | enum lttng_ust_output { | |
50 | LTTNG_UST_MMAP = 0, | |
51 | }; | |
52 | ||
53 | enum lttng_ust_chan_type { | |
54 | LTTNG_UST_CHAN_PER_CPU = 0, | |
55 | LTTNG_UST_CHAN_METADATA = 1, | |
56 | }; | |
57 | ||
58 | struct lttng_ust_tracer_version { | |
59 | uint32_t major; | |
60 | uint32_t minor; | |
61 | uint32_t patchlevel; | |
62 | } LTTNG_PACKED; | |
63 | ||
64 | #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) | |
65 | /* | |
66 | * Given that the consumerd is limited to 64k file descriptors, we | |
67 | * cannot expect much more than 1MB channel structure size. This size is | |
68 | * depends on the number of streams within a channel, which depends on | |
69 | * the number of possible CPUs on the system. | |
70 | */ | |
71 | #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U | |
72 | struct lttng_ust_channel { | |
73 | uint64_t len; | |
74 | enum lttng_ust_chan_type type; | |
75 | char padding[LTTNG_UST_CHANNEL_PADDING]; | |
76 | char data[]; /* variable sized data */ | |
77 | } LTTNG_PACKED; | |
78 | ||
79 | #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32) | |
80 | struct lttng_ust_stream { | |
81 | uint64_t len; /* shm len */ | |
82 | uint32_t stream_nr; /* stream number */ | |
83 | char padding[LTTNG_UST_STREAM_PADDING1]; | |
84 | /* | |
85 | * shm_fd and wakeup_fd are send over unix socket as file | |
86 | * descriptors after this structure. | |
87 | */ | |
88 | } LTTNG_PACKED; | |
89 | ||
5024c2ac JR |
90 | #define LTTNG_UST_TRIGGER_PADDING1 16 |
91 | #define LTTNG_UST_TRIGGER_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
92 | struct lttng_ust_trigger { | |
93 | uint64_t id; | |
94 | enum lttng_ust_instrumentation instrumentation; | |
95 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ | |
96 | ||
97 | enum lttng_ust_loglevel_type loglevel_type; | |
98 | int loglevel; /* value, -1: all */ | |
99 | char padding[LTTNG_UST_TRIGGER_PADDING1]; | |
100 | ||
101 | /* Per instrumentation type configuration */ | |
102 | union { | |
103 | char padding[LTTNG_UST_TRIGGER_PADDING2]; | |
104 | } u; | |
105 | } LTTNG_PACKED; | |
106 | ||
107 | #define LTTNG_TRIGGER_NOTIFICATION_PADDING 32 | |
108 | struct lttng_ust_trigger_notification { | |
109 | uint64_t id; | |
110 | uint16_t capture_buf_size; | |
111 | char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING]; | |
112 | } LTTNG_PACKED; | |
113 | ||
75018ab6 JG |
114 | #define LTTNG_UST_EVENT_PADDING1 16 |
115 | #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
116 | struct lttng_ust_event { | |
117 | enum lttng_ust_instrumentation instrumentation; | |
118 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ | |
119 | ||
120 | enum lttng_ust_loglevel_type loglevel_type; | |
121 | int loglevel; /* value, -1: all */ | |
122 | char padding[LTTNG_UST_EVENT_PADDING1]; | |
123 | ||
124 | /* Per instrumentation type configuration */ | |
125 | union { | |
126 | char padding[LTTNG_UST_EVENT_PADDING2]; | |
127 | } u; | |
128 | } LTTNG_PACKED; | |
129 | ||
130 | enum lttng_ust_field_type { | |
131 | LTTNG_UST_FIELD_OTHER = 0, | |
132 | LTTNG_UST_FIELD_INTEGER = 1, | |
133 | LTTNG_UST_FIELD_ENUM = 2, | |
134 | LTTNG_UST_FIELD_FLOAT = 3, | |
135 | LTTNG_UST_FIELD_STRING = 4, | |
136 | }; | |
137 | ||
138 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) | |
139 | struct lttng_ust_field_iter { | |
140 | char event_name[LTTNG_UST_SYM_NAME_LEN]; | |
141 | char field_name[LTTNG_UST_SYM_NAME_LEN]; | |
142 | enum lttng_ust_field_type type; | |
143 | int loglevel; /* event loglevel */ | |
144 | int nowrite; | |
145 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; | |
146 | } LTTNG_PACKED; | |
147 | ||
148 | enum lttng_ust_context_type { | |
149 | LTTNG_UST_CONTEXT_VTID = 0, | |
150 | LTTNG_UST_CONTEXT_VPID = 1, | |
151 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
152 | LTTNG_UST_CONTEXT_PROCNAME = 3, | |
153 | LTTNG_UST_CONTEXT_IP = 4, | |
154 | LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5, | |
155 | LTTNG_UST_CONTEXT_CPU_ID = 6, | |
156 | LTTNG_UST_CONTEXT_APP_CONTEXT = 7, | |
95194333 JG |
157 | LTTNG_UST_CONTEXT_CGROUP_NS = 8, |
158 | LTTNG_UST_CONTEXT_IPC_NS = 9, | |
159 | LTTNG_UST_CONTEXT_MNT_NS = 10, | |
160 | LTTNG_UST_CONTEXT_NET_NS = 11, | |
161 | LTTNG_UST_CONTEXT_PID_NS = 12, | |
162 | LTTNG_UST_CONTEXT_USER_NS = 13, | |
163 | LTTNG_UST_CONTEXT_UTS_NS = 14, | |
164 | LTTNG_UST_CONTEXT_VUID = 15, | |
165 | LTTNG_UST_CONTEXT_VEUID = 16, | |
166 | LTTNG_UST_CONTEXT_VSUID = 17, | |
167 | LTTNG_UST_CONTEXT_VGID = 18, | |
168 | LTTNG_UST_CONTEXT_VEGID = 19, | |
169 | LTTNG_UST_CONTEXT_VSGID = 20, | |
75018ab6 JG |
170 | }; |
171 | ||
172 | struct lttng_ust_perf_counter_ctx { | |
173 | uint32_t type; | |
174 | uint64_t config; | |
175 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
176 | } LTTNG_PACKED; | |
177 | ||
178 | #define LTTNG_UST_CONTEXT_PADDING1 16 | |
179 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
180 | struct lttng_ust_context { | |
181 | enum lttng_ust_context_type ctx; | |
182 | char padding[LTTNG_UST_CONTEXT_PADDING1]; | |
183 | ||
184 | union { | |
185 | struct lttng_ust_perf_counter_ctx perf_counter; | |
186 | struct { | |
187 | /* Includes trailing '\0'. */ | |
188 | uint32_t provider_name_len; | |
189 | uint32_t ctx_name_len; | |
190 | } app_ctx; | |
191 | char padding[LTTNG_UST_CONTEXT_PADDING2]; | |
192 | } u; | |
193 | } LTTNG_PACKED; | |
194 | ||
195 | /* | |
196 | * Tracer channel attributes. | |
197 | */ | |
198 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) | |
199 | struct lttng_ust_channel_attr { | |
95194333 | 200 | uint64_t subbuf_size; /* bytes */ |
75018ab6 JG |
201 | uint64_t num_subbuf; /* power of 2 */ |
202 | int overwrite; /* 1: overwrite, 0: discard */ | |
203 | unsigned int switch_timer_interval; /* usec */ | |
204 | unsigned int read_timer_interval; /* usec */ | |
205 | enum lttng_ust_output output; /* splice, mmap */ | |
206 | union { | |
207 | struct { | |
95194333 | 208 | int64_t blocking_timeout; /* Blocking timeout (usec) */ |
75018ab6 JG |
209 | } s; |
210 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; | |
211 | } u; | |
212 | } LTTNG_PACKED; | |
213 | ||
214 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 | |
215 | struct lttng_ust_tracepoint_iter { | |
216 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
217 | int loglevel; | |
218 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; | |
219 | } LTTNG_PACKED; | |
220 | ||
221 | enum lttng_ust_object_type { | |
222 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
223 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
224 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
225 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, | |
226 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
227 | }; | |
228 | ||
229 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 | |
230 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
231 | ||
232 | struct lttng_ust_object_data { | |
233 | enum lttng_ust_object_type type; | |
234 | int handle; | |
235 | uint64_t size; | |
236 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
237 | union { | |
238 | struct { | |
239 | void *data; | |
240 | enum lttng_ust_chan_type type; | |
241 | int wakeup_fd; | |
242 | } channel; | |
243 | struct { | |
244 | int shm_fd; | |
245 | int wakeup_fd; | |
246 | uint32_t stream_nr; | |
247 | } stream; | |
248 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
249 | } u; | |
250 | } LTTNG_PACKED; | |
251 | ||
95194333 JG |
252 | enum lttng_ust_calibrate_type { |
253 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
254 | }; | |
255 | ||
256 | #define LTTNG_UST_CALIBRATE_PADDING1 16 | |
257 | #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
258 | struct lttng_ust_calibrate { | |
259 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
260 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; | |
261 | ||
262 | union { | |
263 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
264 | } u; | |
265 | } LTTNG_PACKED; | |
266 | ||
75018ab6 JG |
267 | #define FILTER_BYTECODE_MAX_LEN 65536 |
268 | #define LTTNG_UST_FILTER_PADDING 32 | |
269 | struct lttng_ust_filter_bytecode { | |
270 | uint32_t len; | |
271 | uint32_t reloc_offset; | |
272 | uint64_t seqnum; | |
273 | char padding[LTTNG_UST_FILTER_PADDING]; | |
274 | char data[0]; | |
275 | } LTTNG_PACKED; | |
276 | ||
5024c2ac JR |
277 | #define CAPTURE_BYTECODE_MAX_LEN 65536 |
278 | #define LTTNG_UST_CAPTURE_PADDING 32 | |
279 | struct lttng_ust_capture_bytecode { | |
280 | uint32_t len; | |
281 | uint32_t reloc_offset; | |
282 | uint64_t seqnum; | |
283 | char padding[LTTNG_UST_CAPTURE_PADDING]; | |
284 | char data[0]; | |
285 | } LTTNG_PACKED; | |
286 | ||
75018ab6 JG |
287 | #define LTTNG_UST_EXCLUSION_PADDING 32 |
288 | struct lttng_ust_event_exclusion { | |
289 | uint32_t count; | |
290 | char padding[LTTNG_UST_EXCLUSION_PADDING]; | |
291 | char names[LTTNG_UST_SYM_NAME_LEN][0]; | |
292 | } LTTNG_PACKED; | |
293 | ||
294 | #define _UST_CMD(minor) (minor) | |
295 | #define _UST_CMDR(minor, type) (minor) | |
296 | #define _UST_CMDW(minor, type) (minor) | |
297 | ||
298 | /* Handled by object descriptor */ | |
299 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
300 | ||
301 | /* Handled by object cmd */ | |
302 | ||
303 | /* LTTng-UST commands */ | |
304 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
305 | #define LTTNG_UST_TRACER_VERSION \ | |
306 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
307 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
308 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
309 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) | |
310 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) | |
311 | ||
312 | /* Session FD commands */ | |
313 | #define LTTNG_UST_CHANNEL \ | |
314 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
315 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
316 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
317 | #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54) | |
318 | ||
319 | /* Channel FD commands */ | |
320 | #define LTTNG_UST_STREAM _UST_CMD(0x60) | |
321 | #define LTTNG_UST_EVENT \ | |
322 | _UST_CMDW(0x61, struct lttng_ust_event) | |
323 | ||
324 | /* Event and Channel FD commands */ | |
325 | #define LTTNG_UST_CONTEXT \ | |
326 | _UST_CMDW(0x70, struct lttng_ust_context) | |
327 | #define LTTNG_UST_FLUSH_BUFFER \ | |
328 | _UST_CMD(0x71) | |
329 | ||
330 | /* Event, Channel and Session commands */ | |
331 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) | |
332 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
333 | ||
334 | /* Tracepoint list commands */ | |
335 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
336 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) | |
337 | ||
338 | /* Event FD commands */ | |
339 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
95194333 | 340 | #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1) |
75018ab6 | 341 | |
5024c2ac JR |
342 | #define LTTNG_UST_TRIGGER_SEND_FD _UST_CMD(0xB0) |
343 | #define LTTNG_UST_TRIGGER_CREATE _UST_CMDW(0xB1, struct lttng_ust_trigger) | |
344 | ||
75018ab6 JG |
345 | #define LTTNG_UST_ROOT_HANDLE 0 |
346 | ||
347 | struct lttng_ust_obj; | |
348 | ||
349 | union ust_args { | |
350 | struct { | |
351 | void *chan_data; | |
352 | int wakeup_fd; | |
353 | } channel; | |
354 | struct { | |
355 | int shm_fd; | |
356 | int wakeup_fd; | |
357 | } stream; | |
358 | struct { | |
359 | struct lttng_ust_field_iter entry; | |
360 | } field_list; | |
95194333 JG |
361 | struct { |
362 | char *ctxname; | |
363 | } app_context; | |
75018ab6 JG |
364 | }; |
365 | ||
366 | struct lttng_ust_objd_ops { | |
367 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, | |
368 | union ust_args *args, void *owner); | |
369 | int (*release)(int objd); | |
370 | }; | |
371 | ||
372 | /* Create root handle. Always ID 0. */ | |
373 | int lttng_abi_create_root_handle(void); | |
374 | ||
375 | const struct lttng_ust_objd_ops *objd_ops(int id); | |
376 | int lttng_ust_objd_unref(int id, int is_owner); | |
377 | ||
378 | void lttng_ust_abi_exit(void); | |
379 | void lttng_ust_events_exit(void); | |
380 | void lttng_ust_objd_table_owner_cleanup(void *owner); | |
381 | ||
382 | #endif /* LTTNG_UST_ABI_INTERNAL_H */ |