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