Document last supported kernel version for stable-2.11 branch
[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
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 16
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 enum lttng_kernel_instrumentation instrumentation;
126 char padding[LTTNG_KERNEL_EVENT_PADDING1];
127
128 /* Per instrumentation type configuration */
129 union {
130 struct lttng_kernel_kretprobe kretprobe;
131 struct lttng_kernel_kprobe kprobe;
132 struct lttng_kernel_function_tracer ftrace;
133 struct lttng_kernel_uprobe uprobe;
134 struct lttng_kernel_syscall syscall;
135 char padding[LTTNG_KERNEL_EVENT_PADDING2];
136 } u;
137} __attribute__((packed));
138
139struct lttng_kernel_tracer_version {
140 uint32_t major;
141 uint32_t minor;
142 uint32_t patchlevel;
143} __attribute__((packed));
144
145struct lttng_kernel_tracer_abi_version {
146 uint32_t major;
147 uint32_t minor;
148} __attribute__((packed));
149
150struct lttng_kernel_session_name {
151 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
152} __attribute__((packed));
153
154struct lttng_kernel_session_creation_time {
155 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
156} __attribute__((packed));
157
158enum lttng_kernel_calibrate_type {
159 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
160};
161
162struct lttng_kernel_calibrate {
163 enum lttng_kernel_calibrate_type type; /* type (input) */
164} __attribute__((packed));
165
166struct lttng_kernel_syscall_mask {
167 uint32_t len; /* in bits */
168 char mask[];
169} __attribute__((packed));
170
171enum lttng_kernel_context_type {
172 LTTNG_KERNEL_CONTEXT_PID = 0,
173 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
174 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
175 LTTNG_KERNEL_CONTEXT_PRIO = 3,
176 LTTNG_KERNEL_CONTEXT_NICE = 4,
177 LTTNG_KERNEL_CONTEXT_VPID = 5,
178 LTTNG_KERNEL_CONTEXT_TID = 6,
179 LTTNG_KERNEL_CONTEXT_VTID = 7,
180 LTTNG_KERNEL_CONTEXT_PPID = 8,
181 LTTNG_KERNEL_CONTEXT_VPPID = 9,
182 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
183 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
184 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
185 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
186 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
187 LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
188 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
189 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
190};
191
192struct lttng_kernel_perf_counter_ctx {
193 uint32_t type;
194 uint64_t config;
195 char name[LTTNG_KERNEL_SYM_NAME_LEN];
196} __attribute__((packed));
197
198#define LTTNG_KERNEL_CONTEXT_PADDING1 16
199#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
200struct lttng_kernel_context {
201 enum lttng_kernel_context_type ctx;
202 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
203
204 union {
205 struct lttng_kernel_perf_counter_ctx perf_counter;
206 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
207 } u;
208} __attribute__((packed));
209
210#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
211struct lttng_kernel_filter_bytecode {
212 uint32_t len;
213 uint32_t reloc_offset;
214 uint64_t seqnum;
215 char data[0];
216} __attribute__((packed));
217
218/* LTTng file descriptor ioctl */
219#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
220#define LTTNG_KERNEL_TRACER_VERSION \
221 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
222#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
223#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
224#define LTTNG_KERNEL_CALIBRATE \
225 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
226#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
227#define LTTNG_KERNEL_TRACER_ABI_VERSION \
228 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
229
230/* Session FD ioctl */
231#define LTTNG_KERNEL_METADATA \
232 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
233#define LTTNG_KERNEL_CHANNEL \
234 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
235#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
236#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
237#define LTTNG_KERNEL_SESSION_TRACK_PID \
238 _IOR(0xF6, 0x58, int32_t)
239#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
240 _IOR(0xF6, 0x59, int32_t)
241/*
242 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
243 * are generating two different ioctl numbers, but this was not done on
244 * purpose. We should generally try to avoid those duplications.
245 */
246#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
247#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
248
249/* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
250#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
251#define LTTNG_KERNEL_SESSION_SET_NAME \
252 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
253#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
254 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
255
256/* Channel FD ioctl */
257#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
258#define LTTNG_KERNEL_EVENT \
259 _IOW(0xF6, 0x63, struct lttng_kernel_event)
260#define LTTNG_KERNEL_SYSCALL_MASK \
261 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
262
263/* Event and Channel FD ioctl */
264#define LTTNG_KERNEL_CONTEXT \
265 _IOW(0xF6, 0x71, struct lttng_kernel_context)
266
267/* Event, Channel and Session ioctl */
268#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
269#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
270
271/* Event FD ioctl */
272#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
273#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
274
275/*
276 * LTTng-specific ioctls for the lib ringbuffer.
277 *
278 * Operations applying to the current sub-buffer need to occur between
279 * a get/put or get_next/put_next ioctl pair.
280 */
281
282/* returns the timestamp begin of the current sub-buffer */
283#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
284/* returns the timestamp end of the current sub-buffer */
285#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
286/* returns the number of events discarded of the current sub-buffer */
287#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
288/* returns the packet payload size of the current sub-buffer */
289#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
290/* returns the packet size of the current sub-buffer*/
291#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
292/* returns the stream id (invariant for the stream) */
293#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
294/* returns the current timestamp as perceived from the tracer */
295#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
296/* returns the packet sequence number of the current sub-buffer */
297#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
298/* returns the stream instance id (invariant for the stream) */
299#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
300
301#ifdef CONFIG_COMPAT
302/* returns the timestamp begin of the current sub-buffer */
303#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
304 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
305/* returns the timestamp end of the current sub-buffer */
306#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
307 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
308/* returns the number of events discarded of the current sub-buffer */
309#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
310 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
311/* returns the packet payload size of the current sub-buffer */
312#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
313 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
314/* returns the packet size of the current sub-buffer */
315#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
316 LTTNG_RING_BUFFER_GET_PACKET_SIZE
317/* returns the stream id (invariant for the stream) */
318#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
319 LTTNG_RING_BUFFER_GET_STREAM_ID
320/* returns the current timestamp as perceived from the tracer */
321#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
322 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
323/* returns the packet sequence number of the current sub-buffer */
324#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
325 LTTNG_RING_BUFFER_GET_SEQ_NUM
326/* returns the stream instance id (invariant for the stream) */
327#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
328 LTTNG_RING_BUFFER_INSTANCE_ID
329#endif /* CONFIG_COMPAT */
330
331#endif /* _LTTNG_ABI_H */
This page took 0.0241209999999999 seconds and 4 git commands to generate.