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 | ||
90 | #define LTTNG_UST_EVENT_PADDING1 16 | |
91 | #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
92 | struct lttng_ust_event { | |
93 | enum lttng_ust_instrumentation instrumentation; | |
94 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ | |
95 | ||
96 | enum lttng_ust_loglevel_type loglevel_type; | |
97 | int loglevel; /* value, -1: all */ | |
98 | char padding[LTTNG_UST_EVENT_PADDING1]; | |
99 | ||
100 | /* Per instrumentation type configuration */ | |
101 | union { | |
102 | char padding[LTTNG_UST_EVENT_PADDING2]; | |
103 | } u; | |
104 | } LTTNG_PACKED; | |
105 | ||
233350e5 JR |
106 | #define LTTNG_UST_EVENT_NOTIFIER_PADDING 40 |
107 | struct lttng_ust_event_notifier { | |
108 | struct lttng_ust_event event; | |
109 | char padding[LTTNG_UST_EVENT_NOTIFIER_PADDING]; | |
110 | } LTTNG_PACKED; | |
111 | ||
112 | #define LTTNG_UST_EVENT_NOTIFIER_NOTIFICATION_PADDING 34 | |
113 | struct lttng_ust_event_notifier_notification { | |
114 | uint64_t token; | |
115 | char padding[LTTNG_UST_EVENT_NOTIFIER_NOTIFICATION_PADDING]; | |
116 | } LTTNG_PACKED; | |
117 | ||
75018ab6 JG |
118 | enum lttng_ust_field_type { |
119 | LTTNG_UST_FIELD_OTHER = 0, | |
120 | LTTNG_UST_FIELD_INTEGER = 1, | |
121 | LTTNG_UST_FIELD_ENUM = 2, | |
122 | LTTNG_UST_FIELD_FLOAT = 3, | |
123 | LTTNG_UST_FIELD_STRING = 4, | |
124 | }; | |
125 | ||
126 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) | |
127 | struct lttng_ust_field_iter { | |
128 | char event_name[LTTNG_UST_SYM_NAME_LEN]; | |
129 | char field_name[LTTNG_UST_SYM_NAME_LEN]; | |
130 | enum lttng_ust_field_type type; | |
131 | int loglevel; /* event loglevel */ | |
132 | int nowrite; | |
133 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; | |
134 | } LTTNG_PACKED; | |
135 | ||
136 | enum lttng_ust_context_type { | |
137 | LTTNG_UST_CONTEXT_VTID = 0, | |
138 | LTTNG_UST_CONTEXT_VPID = 1, | |
139 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
140 | LTTNG_UST_CONTEXT_PROCNAME = 3, | |
141 | LTTNG_UST_CONTEXT_IP = 4, | |
142 | LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5, | |
143 | LTTNG_UST_CONTEXT_CPU_ID = 6, | |
144 | LTTNG_UST_CONTEXT_APP_CONTEXT = 7, | |
95194333 JG |
145 | LTTNG_UST_CONTEXT_CGROUP_NS = 8, |
146 | LTTNG_UST_CONTEXT_IPC_NS = 9, | |
147 | LTTNG_UST_CONTEXT_MNT_NS = 10, | |
148 | LTTNG_UST_CONTEXT_NET_NS = 11, | |
149 | LTTNG_UST_CONTEXT_PID_NS = 12, | |
150 | LTTNG_UST_CONTEXT_USER_NS = 13, | |
151 | LTTNG_UST_CONTEXT_UTS_NS = 14, | |
152 | LTTNG_UST_CONTEXT_VUID = 15, | |
153 | LTTNG_UST_CONTEXT_VEUID = 16, | |
154 | LTTNG_UST_CONTEXT_VSUID = 17, | |
155 | LTTNG_UST_CONTEXT_VGID = 18, | |
156 | LTTNG_UST_CONTEXT_VEGID = 19, | |
157 | LTTNG_UST_CONTEXT_VSGID = 20, | |
d37ac3cd | 158 | LTTNG_UST_CONTEXT_TIME_NS = 21, |
75018ab6 JG |
159 | }; |
160 | ||
161 | struct lttng_ust_perf_counter_ctx { | |
162 | uint32_t type; | |
163 | uint64_t config; | |
164 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
165 | } LTTNG_PACKED; | |
166 | ||
167 | #define LTTNG_UST_CONTEXT_PADDING1 16 | |
168 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
169 | struct lttng_ust_context { | |
170 | enum lttng_ust_context_type ctx; | |
171 | char padding[LTTNG_UST_CONTEXT_PADDING1]; | |
172 | ||
173 | union { | |
174 | struct lttng_ust_perf_counter_ctx perf_counter; | |
175 | struct { | |
176 | /* Includes trailing '\0'. */ | |
177 | uint32_t provider_name_len; | |
178 | uint32_t ctx_name_len; | |
179 | } app_ctx; | |
180 | char padding[LTTNG_UST_CONTEXT_PADDING2]; | |
181 | } u; | |
182 | } LTTNG_PACKED; | |
183 | ||
184 | /* | |
185 | * Tracer channel attributes. | |
186 | */ | |
187 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) | |
188 | struct lttng_ust_channel_attr { | |
95194333 | 189 | uint64_t subbuf_size; /* bytes */ |
75018ab6 JG |
190 | uint64_t num_subbuf; /* power of 2 */ |
191 | int overwrite; /* 1: overwrite, 0: discard */ | |
192 | unsigned int switch_timer_interval; /* usec */ | |
193 | unsigned int read_timer_interval; /* usec */ | |
194 | enum lttng_ust_output output; /* splice, mmap */ | |
195 | union { | |
196 | struct { | |
95194333 | 197 | int64_t blocking_timeout; /* Blocking timeout (usec) */ |
75018ab6 JG |
198 | } s; |
199 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; | |
200 | } u; | |
201 | } LTTNG_PACKED; | |
202 | ||
203 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 | |
204 | struct lttng_ust_tracepoint_iter { | |
205 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
206 | int loglevel; | |
207 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; | |
208 | } LTTNG_PACKED; | |
209 | ||
210 | enum lttng_ust_object_type { | |
211 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
212 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
213 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
214 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, | |
215 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
216 | }; | |
217 | ||
218 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 | |
219 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
220 | ||
221 | struct lttng_ust_object_data { | |
222 | enum lttng_ust_object_type type; | |
223 | int handle; | |
224 | uint64_t size; | |
225 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
226 | union { | |
227 | struct { | |
228 | void *data; | |
229 | enum lttng_ust_chan_type type; | |
230 | int wakeup_fd; | |
231 | } channel; | |
232 | struct { | |
233 | int shm_fd; | |
234 | int wakeup_fd; | |
235 | uint32_t stream_nr; | |
236 | } stream; | |
237 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
238 | } u; | |
239 | } LTTNG_PACKED; | |
240 | ||
95194333 JG |
241 | enum lttng_ust_calibrate_type { |
242 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
243 | }; | |
244 | ||
245 | #define LTTNG_UST_CALIBRATE_PADDING1 16 | |
246 | #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
247 | struct lttng_ust_calibrate { | |
248 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
249 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; | |
250 | ||
251 | union { | |
252 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
253 | } u; | |
254 | } LTTNG_PACKED; | |
255 | ||
75018ab6 JG |
256 | #define FILTER_BYTECODE_MAX_LEN 65536 |
257 | #define LTTNG_UST_FILTER_PADDING 32 | |
258 | struct lttng_ust_filter_bytecode { | |
259 | uint32_t len; | |
260 | uint32_t reloc_offset; | |
261 | uint64_t seqnum; | |
262 | char padding[LTTNG_UST_FILTER_PADDING]; | |
263 | char data[0]; | |
264 | } LTTNG_PACKED; | |
265 | ||
266 | #define LTTNG_UST_EXCLUSION_PADDING 32 | |
267 | struct lttng_ust_event_exclusion { | |
268 | uint32_t count; | |
269 | char padding[LTTNG_UST_EXCLUSION_PADDING]; | |
270 | char names[LTTNG_UST_SYM_NAME_LEN][0]; | |
271 | } LTTNG_PACKED; | |
272 | ||
273 | #define _UST_CMD(minor) (minor) | |
274 | #define _UST_CMDR(minor, type) (minor) | |
275 | #define _UST_CMDW(minor, type) (minor) | |
276 | ||
277 | /* Handled by object descriptor */ | |
278 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
279 | ||
280 | /* Handled by object cmd */ | |
281 | ||
282 | /* LTTng-UST commands */ | |
283 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
284 | #define LTTNG_UST_TRACER_VERSION \ | |
285 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
286 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
287 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
288 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) | |
289 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) | |
290 | ||
291 | /* Session FD commands */ | |
292 | #define LTTNG_UST_CHANNEL \ | |
293 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
294 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
295 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
296 | #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54) | |
297 | ||
298 | /* Channel FD commands */ | |
299 | #define LTTNG_UST_STREAM _UST_CMD(0x60) | |
300 | #define LTTNG_UST_EVENT \ | |
301 | _UST_CMDW(0x61, struct lttng_ust_event) | |
302 | ||
303 | /* Event and Channel FD commands */ | |
304 | #define LTTNG_UST_CONTEXT \ | |
305 | _UST_CMDW(0x70, struct lttng_ust_context) | |
306 | #define LTTNG_UST_FLUSH_BUFFER \ | |
307 | _UST_CMD(0x71) | |
308 | ||
309 | /* Event, Channel and Session commands */ | |
310 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) | |
311 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
312 | ||
313 | /* Tracepoint list commands */ | |
314 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
315 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) | |
316 | ||
317 | /* Event FD commands */ | |
318 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
95194333 | 319 | #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1) |
75018ab6 | 320 | |
233350e5 JR |
321 | #define LTTNG_UST_EVENT_NOTIFIER_SEND_FD _UST_CMD(0xB0) |
322 | #define LTTNG_UST_EVENT_NOTIFIER_CREATE _UST_CMDW(0xB1, struct lttng_ust_event_notifier) | |
323 | ||
75018ab6 JG |
324 | #define LTTNG_UST_ROOT_HANDLE 0 |
325 | ||
326 | struct lttng_ust_obj; | |
327 | ||
328 | union ust_args { | |
329 | struct { | |
330 | void *chan_data; | |
331 | int wakeup_fd; | |
332 | } channel; | |
333 | struct { | |
334 | int shm_fd; | |
335 | int wakeup_fd; | |
336 | } stream; | |
337 | struct { | |
338 | struct lttng_ust_field_iter entry; | |
339 | } field_list; | |
95194333 JG |
340 | struct { |
341 | char *ctxname; | |
342 | } app_context; | |
75018ab6 JG |
343 | }; |
344 | ||
345 | struct lttng_ust_objd_ops { | |
346 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, | |
347 | union ust_args *args, void *owner); | |
348 | int (*release)(int objd); | |
349 | }; | |
350 | ||
351 | /* Create root handle. Always ID 0. */ | |
352 | int lttng_abi_create_root_handle(void); | |
353 | ||
354 | const struct lttng_ust_objd_ops *objd_ops(int id); | |
355 | int lttng_ust_objd_unref(int id, int is_owner); | |
356 | ||
357 | void lttng_ust_abi_exit(void); | |
358 | void lttng_ust_events_exit(void); | |
359 | void lttng_ust_objd_table_owner_cleanup(void *owner); | |
360 | ||
361 | #endif /* LTTNG_UST_ABI_INTERNAL_H */ |