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