Add token to `struct lttng_kernel_event`
[lttng-modules.git] / include / lttng / abi.h
... / ...
CommitLineData
1/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
2 *
3 * lttng/abi.h
4 *
5 * LTTng ABI header
6 *
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 */
9
10#ifndef _LTTNG_ABI_H
11#define _LTTNG_ABI_H
12
13#include <linux/fs.h>
14
15/*
16 * Major/minor version of ABI exposed to lttng tools. Major number
17 * should be increased when an incompatible ABI change is done.
18 */
19#define LTTNG_MODULES_ABI_MAJOR_VERSION 2
20#define LTTNG_MODULES_ABI_MINOR_VERSION 5
21
22#define LTTNG_KERNEL_SYM_NAME_LEN 256
23#define LTTNG_KERNEL_SESSION_NAME_LEN 256
24#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
25
26enum lttng_kernel_instrumentation {
27 LTTNG_KERNEL_TRACEPOINT = 0,
28 LTTNG_KERNEL_KPROBE = 1,
29 LTTNG_KERNEL_FUNCTION = 2,
30 LTTNG_KERNEL_KRETPROBE = 3,
31 LTTNG_KERNEL_NOOP = 4, /* not hooked */
32 LTTNG_KERNEL_SYSCALL = 5,
33 LTTNG_KERNEL_UPROBE = 6,
34};
35
36/*
37 * LTTng consumer mode
38 */
39enum lttng_kernel_output {
40 LTTNG_KERNEL_SPLICE = 0,
41 LTTNG_KERNEL_MMAP = 1,
42};
43
44/*
45 * LTTng DebugFS ABI structures.
46 */
47#define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
48struct lttng_kernel_channel {
49 uint64_t subbuf_size; /* in bytes */
50 uint64_t num_subbuf;
51 unsigned int switch_timer_interval; /* usecs */
52 unsigned int read_timer_interval; /* usecs */
53 uint32_t output; /* enum lttng_kernel_output (splice, mmap) */
54 int overwrite; /* 1: overwrite, 0: discard */
55 char padding[LTTNG_KERNEL_CHANNEL_PADDING];
56} __attribute__((packed));
57
58struct lttng_kernel_kretprobe {
59 uint64_t addr;
60
61 uint64_t offset;
62 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
63} __attribute__((packed));
64
65/*
66 * Either addr is used, or symbol_name and offset.
67 */
68struct lttng_kernel_kprobe {
69 uint64_t addr;
70
71 uint64_t offset;
72 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
73} __attribute__((packed));
74
75struct lttng_kernel_function_tracer {
76 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
77} __attribute__((packed));
78
79struct lttng_kernel_uprobe {
80 int fd;
81} __attribute__((packed));
82
83struct lttng_kernel_event_callsite_uprobe {
84 uint64_t offset;
85} __attribute__((packed));
86
87struct lttng_kernel_event_callsite {
88 union {
89 struct lttng_kernel_event_callsite_uprobe uprobe;
90 } u;
91} __attribute__((packed));
92
93enum lttng_kernel_syscall_entryexit {
94 LTTNG_KERNEL_SYSCALL_ENTRYEXIT = 0,
95 LTTNG_KERNEL_SYSCALL_ENTRY = 1, /* Not implemented. */
96 LTTNG_KERNEL_SYSCALL_EXIT = 2, /* Not implemented. */
97};
98
99enum lttng_kernel_syscall_abi {
100 LTTNG_KERNEL_SYSCALL_ABI_ALL = 0,
101 LTTNG_KERNEL_SYSCALL_ABI_NATIVE = 1, /* Not implemented. */
102 LTTNG_KERNEL_SYSCALL_ABI_COMPAT = 2, /* Not implemented. */
103};
104
105enum lttng_kernel_syscall_match {
106 LTTNG_SYSCALL_MATCH_NAME = 0,
107 LTTNG_SYSCALL_MATCH_NR = 1, /* Not implemented. */
108};
109
110struct lttng_kernel_syscall {
111 uint8_t entryexit; /* enum lttng_kernel_syscall_entryexit */
112 uint8_t abi; /* enum lttng_kernel_syscall_abi */
113 uint8_t match; /* enum lttng_kernel_syscall_match */
114 uint8_t padding;
115 uint32_t nr; /* For LTTNG_SYSCALL_MATCH_NR */
116} __attribute__((packed));
117
118/*
119 * For syscall tracing, name = "*" means "enable all".
120 */
121#define LTTNG_KERNEL_EVENT_PADDING1 8
122#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
123struct lttng_kernel_event {
124 char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
125 uint32_t instrumentation; /* enum lttng_kernel_instrumentation */
126 uint64_t token; /* User-provided token */
127 char padding[LTTNG_KERNEL_EVENT_PADDING1];
128
129 /* Per instrumentation type configuration */
130 union {
131 struct lttng_kernel_kretprobe kretprobe;
132 struct lttng_kernel_kprobe kprobe;
133 struct lttng_kernel_function_tracer ftrace;
134 struct lttng_kernel_uprobe uprobe;
135 struct lttng_kernel_syscall syscall;
136 char padding[LTTNG_KERNEL_EVENT_PADDING2];
137 } u;
138} __attribute__((packed));
139
140struct lttng_kernel_tracer_version {
141 uint32_t major;
142 uint32_t minor;
143 uint32_t patchlevel;
144} __attribute__((packed));
145
146struct lttng_kernel_tracer_abi_version {
147 uint32_t major;
148 uint32_t minor;
149} __attribute__((packed));
150
151struct lttng_kernel_session_name {
152 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
153} __attribute__((packed));
154
155struct lttng_kernel_session_creation_time {
156 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
157} __attribute__((packed));
158
159enum lttng_kernel_calibrate_type {
160 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
161};
162
163struct lttng_kernel_calibrate {
164 uint32_t type; /* enum lttng_kernel_calibrate_type (input) */
165} __attribute__((packed));
166
167struct lttng_kernel_syscall_mask {
168 uint32_t len; /* in bits */
169 char mask[];
170} __attribute__((packed));
171
172enum lttng_kernel_context_type {
173 LTTNG_KERNEL_CONTEXT_PID = 0,
174 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
175 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
176 LTTNG_KERNEL_CONTEXT_PRIO = 3,
177 LTTNG_KERNEL_CONTEXT_NICE = 4,
178 LTTNG_KERNEL_CONTEXT_VPID = 5,
179 LTTNG_KERNEL_CONTEXT_TID = 6,
180 LTTNG_KERNEL_CONTEXT_VTID = 7,
181 LTTNG_KERNEL_CONTEXT_PPID = 8,
182 LTTNG_KERNEL_CONTEXT_VPPID = 9,
183 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
184 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
185 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
186 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
187 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
188 LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
189 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
190 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
191 LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
192 LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
193 LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
194 LTTNG_KERNEL_CONTEXT_NET_NS = 21,
195 LTTNG_KERNEL_CONTEXT_PID_NS = 22,
196 LTTNG_KERNEL_CONTEXT_USER_NS = 23,
197 LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
198 LTTNG_KERNEL_CONTEXT_UID = 25,
199 LTTNG_KERNEL_CONTEXT_EUID = 26,
200 LTTNG_KERNEL_CONTEXT_SUID = 27,
201 LTTNG_KERNEL_CONTEXT_GID = 28,
202 LTTNG_KERNEL_CONTEXT_EGID = 29,
203 LTTNG_KERNEL_CONTEXT_SGID = 30,
204 LTTNG_KERNEL_CONTEXT_VUID = 31,
205 LTTNG_KERNEL_CONTEXT_VEUID = 32,
206 LTTNG_KERNEL_CONTEXT_VSUID = 33,
207 LTTNG_KERNEL_CONTEXT_VGID = 34,
208 LTTNG_KERNEL_CONTEXT_VEGID = 35,
209 LTTNG_KERNEL_CONTEXT_VSGID = 36,
210 LTTNG_KERNEL_CONTEXT_TIME_NS = 37,
211};
212
213struct lttng_kernel_perf_counter_ctx {
214 uint32_t type;
215 uint64_t config;
216 char name[LTTNG_KERNEL_SYM_NAME_LEN];
217} __attribute__((packed));
218
219#define LTTNG_KERNEL_CONTEXT_PADDING1 16
220#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
221struct lttng_kernel_context {
222 uint32_t ctx; /*enum lttng_kernel_context_type */
223 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
224
225 union {
226 struct lttng_kernel_perf_counter_ctx perf_counter;
227 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
228 } u;
229} __attribute__((packed));
230
231#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
232struct lttng_kernel_filter_bytecode {
233 uint32_t len;
234 uint32_t reloc_offset;
235 uint64_t seqnum;
236 char data[0];
237} __attribute__((packed));
238
239enum lttng_kernel_tracker_type {
240 LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
241
242 LTTNG_KERNEL_TRACKER_PID = 0,
243 LTTNG_KERNEL_TRACKER_VPID = 1,
244 LTTNG_KERNEL_TRACKER_UID = 2,
245 LTTNG_KERNEL_TRACKER_VUID = 3,
246 LTTNG_KERNEL_TRACKER_GID = 4,
247 LTTNG_KERNEL_TRACKER_VGID = 5,
248};
249
250struct lttng_kernel_tracker_args {
251 uint32_t type; /* enum lttng_kernel_tracker_type */
252 int32_t id;
253};
254
255/* LTTng file descriptor ioctl */
256/* lttng/abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
257#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
258#define LTTNG_KERNEL_TRACER_VERSION \
259 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
260#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
261#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
262#define LTTNG_KERNEL_CALIBRATE \
263 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
264#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
265#define LTTNG_KERNEL_TRACER_ABI_VERSION \
266 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
267
268/* Session FD ioctl */
269/* lttng/abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
270#define LTTNG_KERNEL_METADATA \
271 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
272#define LTTNG_KERNEL_CHANNEL \
273 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
274#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
275#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
276#define LTTNG_KERNEL_SESSION_TRACK_PID \
277 _IOR(0xF6, 0x58, int32_t)
278#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
279 _IOR(0xF6, 0x59, int32_t)
280
281/*
282 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
283 * are generating two different ioctl numbers, but this was not done on
284 * purpose. We should generally try to avoid those duplications.
285 */
286#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
287#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
288
289/* lttng/abi-old.h reserve 0x5A and 0x5B. */
290#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
291#define LTTNG_KERNEL_SESSION_SET_NAME \
292 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
293#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
294 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
295
296/* Channel FD ioctl */
297/* lttng/abi-old.h reserve 0x60 and 0x61. */
298#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
299#define LTTNG_KERNEL_EVENT \
300 _IOW(0xF6, 0x63, struct lttng_kernel_event)
301#define LTTNG_KERNEL_SYSCALL_MASK \
302 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
303
304/* Event and Channel FD ioctl */
305/* lttng/abi-old.h reserve 0x70. */
306#define LTTNG_KERNEL_CONTEXT \
307 _IOW(0xF6, 0x71, struct lttng_kernel_context)
308
309/* Event, Channel and Session ioctl */
310/* lttng/abi-old.h reserve 0x80 and 0x81. */
311#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
312#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
313
314/* Event FD ioctl */
315#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
316#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
317
318/* Session FD ioctl (continued) */
319#define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
320 _IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
321#define LTTNG_KERNEL_SESSION_TRACK_ID \
322 _IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
323#define LTTNG_KERNEL_SESSION_UNTRACK_ID \
324 _IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
325
326/*
327 * LTTng-specific ioctls for the lib ringbuffer.
328 *
329 * Operations applying to the current sub-buffer need to occur between
330 * a get/put or get_next/put_next ioctl pair.
331 */
332
333/* returns the timestamp begin of the current sub-buffer */
334#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
335/* returns the timestamp end of the current sub-buffer */
336#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
337/* returns the number of events discarded of the current sub-buffer */
338#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
339/* returns the packet payload size of the current sub-buffer */
340#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
341/* returns the packet size of the current sub-buffer*/
342#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
343/* returns the stream id (invariant for the stream) */
344#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
345/* returns the current timestamp as perceived from the tracer */
346#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
347/* returns the packet sequence number of the current sub-buffer */
348#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
349/* returns the stream instance id (invariant for the stream) */
350#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
351
352#ifdef CONFIG_COMPAT
353/* returns the timestamp begin of the current sub-buffer */
354#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
355 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
356/* returns the timestamp end of the current sub-buffer */
357#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
358 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
359/* returns the number of events discarded of the current sub-buffer */
360#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
361 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
362/* returns the packet payload size of the current sub-buffer */
363#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
364 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
365/* returns the packet size of the current sub-buffer */
366#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
367 LTTNG_RING_BUFFER_GET_PACKET_SIZE
368/* returns the stream id (invariant for the stream) */
369#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
370 LTTNG_RING_BUFFER_GET_STREAM_ID
371/* returns the current timestamp as perceived from the tracer */
372#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
373 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
374/* returns the packet sequence number of the current sub-buffer */
375#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
376 LTTNG_RING_BUFFER_GET_SEQ_NUM
377/* returns the stream instance id (invariant for the stream) */
378#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
379 LTTNG_RING_BUFFER_INSTANCE_ID
380#endif /* CONFIG_COMPAT */
381
382#endif /* _LTTNG_ABI_H */
This page took 0.060128 seconds and 4 git commands to generate.