lttng-abi: Document ioctl numbers reserved by lttng-abi-old.h
[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
7f859fbf 20#define LTTNG_MODULES_ABI_MINOR_VERSION 4
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 */
96ba7208 53 enum lttng_kernel_output 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
43880ee8 93/*
3c997079 94 * For syscall tracing, name = "*" means "enable all".
43880ee8 95 */
8e099bae
MD
96#define LTTNG_KERNEL_EVENT_PADDING1 16
97#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
d6d808f3 98struct lttng_kernel_event {
f8695253 99 char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
d6d808f3 100 enum lttng_kernel_instrumentation instrumentation;
8e099bae
MD
101 char padding[LTTNG_KERNEL_EVENT_PADDING1];
102
d6d808f3
MD
103 /* Per instrumentation type configuration */
104 union {
7371f44c 105 struct lttng_kernel_kretprobe kretprobe;
d6d808f3 106 struct lttng_kernel_kprobe kprobe;
f17701fb 107 struct lttng_kernel_function_tracer ftrace;
149b9a9d 108 struct lttng_kernel_uprobe uprobe;
8e099bae 109 char padding[LTTNG_KERNEL_EVENT_PADDING2];
d6d808f3 110 } u;
1a598612 111} __attribute__((packed));
c099397a 112
80c16bcf 113struct lttng_kernel_tracer_version {
c6c9e10f
MD
114 uint32_t major;
115 uint32_t minor;
80c16bcf 116 uint32_t patchlevel;
1a598612 117} __attribute__((packed));
80c16bcf 118
42cabb80
MD
119struct lttng_kernel_tracer_abi_version {
120 uint32_t major;
121 uint32_t minor;
122} __attribute__((packed));
123
7f859fbf
JR
124struct lttng_kernel_session_name {
125 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
126} __attribute__((packed));
127
1c88f269
JR
128struct lttng_kernel_session_creation_time {
129 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
130} __attribute__((packed));
131
3db41b2c
MD
132enum lttng_kernel_calibrate_type {
133 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
57105fc2
MD
134};
135
3db41b2c
MD
136struct lttng_kernel_calibrate {
137 enum lttng_kernel_calibrate_type type; /* type (input) */
1a598612 138} __attribute__((packed));
57105fc2 139
12e579db
MD
140struct lttng_kernel_syscall_mask {
141 uint32_t len; /* in bits */
142 char mask[];
143} __attribute__((packed));
144
12a313a5 145enum lttng_kernel_context_type {
4c183524
MD
146 LTTNG_KERNEL_CONTEXT_PID = 0,
147 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
a2563e83 148 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
4c183524
MD
149 LTTNG_KERNEL_CONTEXT_PRIO = 3,
150 LTTNG_KERNEL_CONTEXT_NICE = 4,
151 LTTNG_KERNEL_CONTEXT_VPID = 5,
152 LTTNG_KERNEL_CONTEXT_TID = 6,
153 LTTNG_KERNEL_CONTEXT_VTID = 7,
154 LTTNG_KERNEL_CONTEXT_PPID = 8,
155 LTTNG_KERNEL_CONTEXT_VPPID = 9,
975da2c0 156 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
b3699d90 157 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
79150a49
JD
158 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
159 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
160 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
161 LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
2fa2d39a
FG
162 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
163 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
a6cf40a4
MJ
164 LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
165 LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
166 LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
167 LTTNG_KERNEL_CONTEXT_NET_NS = 21,
168 LTTNG_KERNEL_CONTEXT_PID_NS = 22,
169 LTTNG_KERNEL_CONTEXT_USER_NS = 23,
170 LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
dc923e75
MJ
171 LTTNG_KERNEL_CONTEXT_UID = 25,
172 LTTNG_KERNEL_CONTEXT_EUID = 26,
173 LTTNG_KERNEL_CONTEXT_SUID = 27,
174 LTTNG_KERNEL_CONTEXT_GID = 28,
175 LTTNG_KERNEL_CONTEXT_EGID = 29,
176 LTTNG_KERNEL_CONTEXT_SGID = 30,
177 LTTNG_KERNEL_CONTEXT_VUID = 31,
178 LTTNG_KERNEL_CONTEXT_VEUID = 32,
179 LTTNG_KERNEL_CONTEXT_VSUID = 33,
180 LTTNG_KERNEL_CONTEXT_VGID = 34,
181 LTTNG_KERNEL_CONTEXT_VEGID = 35,
182 LTTNG_KERNEL_CONTEXT_VSGID = 36,
8070f5c0
MD
183};
184
185struct lttng_kernel_perf_counter_ctx {
186 uint32_t type;
187 uint64_t config;
f8695253 188 char name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 189} __attribute__((packed));
8070f5c0 190
8e099bae
MD
191#define LTTNG_KERNEL_CONTEXT_PADDING1 16
192#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
8070f5c0 193struct lttng_kernel_context {
12a313a5 194 enum lttng_kernel_context_type ctx;
8e099bae
MD
195 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
196
8070f5c0 197 union {
8070f5c0 198 struct lttng_kernel_perf_counter_ctx perf_counter;
8e099bae 199 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
8070f5c0 200 } u;
1a598612 201} __attribute__((packed));
8070f5c0 202
f127e61e 203#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
07dfc1d0
MD
204struct lttng_kernel_filter_bytecode {
205 uint32_t len;
206 uint32_t reloc_offset;
207 uint64_t seqnum;
208 char data[0];
209} __attribute__((packed));
210
33749530 211/* LTTng file descriptor ioctl */
436f6407 212/* lttng-abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
6dccd6c1 213#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
33749530 214#define LTTNG_KERNEL_TRACER_VERSION \
6dccd6c1
JD
215 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
216#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
217#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
57105fc2 218#define LTTNG_KERNEL_CALIBRATE \
6dccd6c1 219 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
29c956bb 220#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
42cabb80
MD
221#define LTTNG_KERNEL_TRACER_ABI_VERSION \
222 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
33749530
MD
223
224/* Session FD ioctl */
436f6407 225/* lttng-abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
33749530 226#define LTTNG_KERNEL_METADATA \
6dccd6c1 227 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
ab2277d6 228#define LTTNG_KERNEL_CHANNEL \
6dccd6c1
JD
229 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
230#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
231#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
e0130fab
MD
232#define LTTNG_KERNEL_SESSION_TRACK_PID \
233 _IOR(0xF6, 0x58, int32_t)
234#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
235 _IOR(0xF6, 0x59, int32_t)
fe40f016
MD
236/*
237 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
238 * are generating two different ioctl numbers, but this was not done on
239 * purpose. We should generally try to avoid those duplications.
240 */
7e6f9ef6 241#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
9616f0bf 242#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
7f859fbf 243
436f6407 244/* lttng-abi-old.h reserve 0x5A and 0x5B. */
601252cf 245#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
7f859fbf
JR
246#define LTTNG_KERNEL_SESSION_SET_NAME \
247 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
1c88f269
JR
248#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
249 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
33749530
MD
250
251/* Channel FD ioctl */
436f6407 252/* lttng-abi-old.h reserve 0x60 and 0x61. */
6dccd6c1 253#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
ab2277d6 254#define LTTNG_KERNEL_EVENT \
6dccd6c1 255 _IOW(0xF6, 0x63, struct lttng_kernel_event)
12e579db
MD
256#define LTTNG_KERNEL_SYSCALL_MASK \
257 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
57a13317 258
8070f5c0 259/* Event and Channel FD ioctl */
436f6407 260/* lttng-abi-old.h reserve 0x70. */
8070f5c0 261#define LTTNG_KERNEL_CONTEXT \
6dccd6c1 262 _IOW(0xF6, 0x71, struct lttng_kernel_context)
8070f5c0 263
e64957da 264/* Event, Channel and Session ioctl */
436f6407 265/* lttng-abi-old.h reserve 0x80 and 0x81. */
6dccd6c1
JD
266#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
267#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
e64957da 268
07dfc1d0
MD
269/* Event FD ioctl */
270#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
3aed4dca 271#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
07dfc1d0 272
1aca53e1
MD
273/*
274 * LTTng-specific ioctls for the lib ringbuffer.
275 *
276 * Operations applying to the current sub-buffer need to occur between
277 * a get/put or get_next/put_next ioctl pair.
278 */
279
3b731ab1
JD
280/* returns the timestamp begin of the current sub-buffer */
281#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
282/* returns the timestamp end of the current sub-buffer */
283#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
1aca53e1 284/* returns the number of events discarded of the current sub-buffer */
3b731ab1 285#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
1aca53e1 286/* returns the packet payload size of the current sub-buffer */
3b731ab1 287#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
1aca53e1 288/* returns the packet size of the current sub-buffer*/
3b731ab1 289#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
1aca53e1 290/* returns the stream id (invariant for the stream) */
3b731ab1 291#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
1aca53e1 292/* returns the current timestamp as perceived from the tracer */
2348ca17 293#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
1aca53e1 294/* returns the packet sequence number of the current sub-buffer */
5b3cf4f9 295#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
1aca53e1 296/* returns the stream instance id (invariant for the stream) */
5594698f 297#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
3b731ab1
JD
298
299#ifdef CONFIG_COMPAT
300/* returns the timestamp begin of the current sub-buffer */
301#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
302 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
303/* returns the timestamp end of the current sub-buffer */
304#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
305 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
1aca53e1 306/* returns the number of events discarded of the current sub-buffer */
3b731ab1
JD
307#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
308 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
1aca53e1 309/* returns the packet payload size of the current sub-buffer */
3b731ab1
JD
310#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
311 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
1aca53e1 312/* returns the packet size of the current sub-buffer */
3b731ab1
JD
313#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
314 LTTNG_RING_BUFFER_GET_PACKET_SIZE
1aca53e1 315/* returns the stream id (invariant for the stream) */
3b731ab1
JD
316#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
317 LTTNG_RING_BUFFER_GET_STREAM_ID
1aca53e1 318/* returns the current timestamp as perceived from the tracer */
2348ca17
JD
319#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
320 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
1aca53e1 321/* returns the packet sequence number of the current sub-buffer */
5b3cf4f9
JD
322#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
323 LTTNG_RING_BUFFER_GET_SEQ_NUM
1aca53e1 324/* returns the stream instance id (invariant for the stream) */
5594698f
JD
325#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
326 LTTNG_RING_BUFFER_INSTANCE_ID
3b731ab1
JD
327#endif /* CONFIG_COMPAT */
328
e8951e63 329#endif /* _LTTNG_ABI_H */
This page took 0.052056 seconds and 4 git commands to generate.