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