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