lttng-abi: Document ioctl numbers reserved by lttng-abi-old.h
[lttng-modules.git] / lttng-abi.h
... / ...
CommitLineData
1/* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1)
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 4
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 enum lttng_kernel_output 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
93/*
94 * For syscall tracing, name = "*" means "enable all".
95 */
96#define LTTNG_KERNEL_EVENT_PADDING1 16
97#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
98struct lttng_kernel_event {
99 char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
100 enum lttng_kernel_instrumentation instrumentation;
101 char padding[LTTNG_KERNEL_EVENT_PADDING1];
102
103 /* Per instrumentation type configuration */
104 union {
105 struct lttng_kernel_kretprobe kretprobe;
106 struct lttng_kernel_kprobe kprobe;
107 struct lttng_kernel_function_tracer ftrace;
108 struct lttng_kernel_uprobe uprobe;
109 char padding[LTTNG_KERNEL_EVENT_PADDING2];
110 } u;
111} __attribute__((packed));
112
113struct lttng_kernel_tracer_version {
114 uint32_t major;
115 uint32_t minor;
116 uint32_t patchlevel;
117} __attribute__((packed));
118
119struct lttng_kernel_tracer_abi_version {
120 uint32_t major;
121 uint32_t minor;
122} __attribute__((packed));
123
124struct lttng_kernel_session_name {
125 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
126} __attribute__((packed));
127
128struct lttng_kernel_session_creation_time {
129 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
130} __attribute__((packed));
131
132enum lttng_kernel_calibrate_type {
133 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
134};
135
136struct lttng_kernel_calibrate {
137 enum lttng_kernel_calibrate_type type; /* type (input) */
138} __attribute__((packed));
139
140struct lttng_kernel_syscall_mask {
141 uint32_t len; /* in bits */
142 char mask[];
143} __attribute__((packed));
144
145enum lttng_kernel_context_type {
146 LTTNG_KERNEL_CONTEXT_PID = 0,
147 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
148 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
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,
156 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
157 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
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,
162 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
163 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
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,
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,
183};
184
185struct lttng_kernel_perf_counter_ctx {
186 uint32_t type;
187 uint64_t config;
188 char name[LTTNG_KERNEL_SYM_NAME_LEN];
189} __attribute__((packed));
190
191#define LTTNG_KERNEL_CONTEXT_PADDING1 16
192#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
193struct lttng_kernel_context {
194 enum lttng_kernel_context_type ctx;
195 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
196
197 union {
198 struct lttng_kernel_perf_counter_ctx perf_counter;
199 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
200 } u;
201} __attribute__((packed));
202
203#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
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
211/* LTTng file descriptor ioctl */
212/* lttng-abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
213#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
214#define LTTNG_KERNEL_TRACER_VERSION \
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)
218#define LTTNG_KERNEL_CALIBRATE \
219 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
220#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
221#define LTTNG_KERNEL_TRACER_ABI_VERSION \
222 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
223
224/* Session FD ioctl */
225/* lttng-abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
226#define LTTNG_KERNEL_METADATA \
227 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
228#define LTTNG_KERNEL_CHANNEL \
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)
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)
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 */
241#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
242#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
243
244/* lttng-abi-old.h reserve 0x5A and 0x5B. */
245#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
246#define LTTNG_KERNEL_SESSION_SET_NAME \
247 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
248#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
249 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
250
251/* Channel FD ioctl */
252/* lttng-abi-old.h reserve 0x60 and 0x61. */
253#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
254#define LTTNG_KERNEL_EVENT \
255 _IOW(0xF6, 0x63, struct lttng_kernel_event)
256#define LTTNG_KERNEL_SYSCALL_MASK \
257 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
258
259/* Event and Channel FD ioctl */
260/* lttng-abi-old.h reserve 0x70. */
261#define LTTNG_KERNEL_CONTEXT \
262 _IOW(0xF6, 0x71, struct lttng_kernel_context)
263
264/* Event, Channel and Session ioctl */
265/* lttng-abi-old.h reserve 0x80 and 0x81. */
266#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
267#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
268
269/* Event FD ioctl */
270#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
271#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
272
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
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)
284/* returns the number of events discarded of the current sub-buffer */
285#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
286/* returns the packet payload size of the current sub-buffer */
287#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
288/* returns the packet size of the current sub-buffer*/
289#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
290/* returns the stream id (invariant for the stream) */
291#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
292/* returns the current timestamp as perceived from the tracer */
293#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
294/* returns the packet sequence number of the current sub-buffer */
295#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
296/* returns the stream instance id (invariant for the stream) */
297#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
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
306/* returns the number of events discarded of the current sub-buffer */
307#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
308 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
309/* returns the packet payload size of the current sub-buffer */
310#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
311 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
312/* returns the packet size of the current sub-buffer */
313#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
314 LTTNG_RING_BUFFER_GET_PACKET_SIZE
315/* returns the stream id (invariant for the stream) */
316#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
317 LTTNG_RING_BUFFER_GET_STREAM_ID
318/* returns the current timestamp as perceived from the tracer */
319#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
320 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
321/* returns the packet sequence number of the current sub-buffer */
322#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
323 LTTNG_RING_BUFFER_GET_SEQ_NUM
324/* returns the stream instance id (invariant for the stream) */
325#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
326 LTTNG_RING_BUFFER_INSTANCE_ID
327#endif /* CONFIG_COMPAT */
328
329#endif /* _LTTNG_ABI_H */
This page took 0.023534 seconds and 4 git commands to generate.