Set 'stable-2.12' branch in git review config
[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 5
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 LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
191 LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
192 LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
193 LTTNG_KERNEL_CONTEXT_NET_NS = 21,
194 LTTNG_KERNEL_CONTEXT_PID_NS = 22,
195 LTTNG_KERNEL_CONTEXT_USER_NS = 23,
196 LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
197 LTTNG_KERNEL_CONTEXT_UID = 25,
198 LTTNG_KERNEL_CONTEXT_EUID = 26,
199 LTTNG_KERNEL_CONTEXT_SUID = 27,
200 LTTNG_KERNEL_CONTEXT_GID = 28,
201 LTTNG_KERNEL_CONTEXT_EGID = 29,
202 LTTNG_KERNEL_CONTEXT_SGID = 30,
203 LTTNG_KERNEL_CONTEXT_VUID = 31,
204 LTTNG_KERNEL_CONTEXT_VEUID = 32,
205 LTTNG_KERNEL_CONTEXT_VSUID = 33,
206 LTTNG_KERNEL_CONTEXT_VGID = 34,
207 LTTNG_KERNEL_CONTEXT_VEGID = 35,
208 LTTNG_KERNEL_CONTEXT_VSGID = 36,
209};
210
211struct lttng_kernel_perf_counter_ctx {
212 uint32_t type;
213 uint64_t config;
214 char name[LTTNG_KERNEL_SYM_NAME_LEN];
215} __attribute__((packed));
216
217#define LTTNG_KERNEL_CONTEXT_PADDING1 16
218#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
219struct lttng_kernel_context {
220 enum lttng_kernel_context_type ctx;
221 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
222
223 union {
224 struct lttng_kernel_perf_counter_ctx perf_counter;
225 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
226 } u;
227} __attribute__((packed));
228
229#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
230struct lttng_kernel_filter_bytecode {
231 uint32_t len;
232 uint32_t reloc_offset;
233 uint64_t seqnum;
234 char data[0];
235} __attribute__((packed));
236
237enum lttng_kernel_tracker_type {
238 LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
239
240 LTTNG_KERNEL_TRACKER_PID = 0,
241 LTTNG_KERNEL_TRACKER_VPID = 1,
242 LTTNG_KERNEL_TRACKER_UID = 2,
243 LTTNG_KERNEL_TRACKER_VUID = 3,
244 LTTNG_KERNEL_TRACKER_GID = 4,
245 LTTNG_KERNEL_TRACKER_VGID = 5,
246};
247
248struct lttng_kernel_tracker_args {
249 enum lttng_kernel_tracker_type type;
250 int32_t id;
251};
252
253/* LTTng file descriptor ioctl */
254/* lttng-abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
255#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
256#define LTTNG_KERNEL_TRACER_VERSION \
257 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
258#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
259#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
260#define LTTNG_KERNEL_CALIBRATE \
261 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
262#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
263#define LTTNG_KERNEL_TRACER_ABI_VERSION \
264 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
265
266/* Session FD ioctl */
267/* lttng-abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
268#define LTTNG_KERNEL_METADATA \
269 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
270#define LTTNG_KERNEL_CHANNEL \
271 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
272#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
273#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
274#define LTTNG_KERNEL_SESSION_TRACK_PID \
275 _IOR(0xF6, 0x58, int32_t)
276#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
277 _IOR(0xF6, 0x59, int32_t)
278
279/*
280 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
281 * are generating two different ioctl numbers, but this was not done on
282 * purpose. We should generally try to avoid those duplications.
283 */
284#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
285#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
286
287/* lttng-abi-old.h reserve 0x5A and 0x5B. */
288#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
289#define LTTNG_KERNEL_SESSION_SET_NAME \
290 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
291#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
292 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
293
294/* Channel FD ioctl */
295/* lttng-abi-old.h reserve 0x60 and 0x61. */
296#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
297#define LTTNG_KERNEL_EVENT \
298 _IOW(0xF6, 0x63, struct lttng_kernel_event)
299#define LTTNG_KERNEL_SYSCALL_MASK \
300 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
301
302/* Event and Channel FD ioctl */
303/* lttng-abi-old.h reserve 0x70. */
304#define LTTNG_KERNEL_CONTEXT \
305 _IOW(0xF6, 0x71, struct lttng_kernel_context)
306
307/* Event, Channel and Session ioctl */
308/* lttng-abi-old.h reserve 0x80 and 0x81. */
309#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
310#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
311
312/* Event FD ioctl */
313#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
314#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
315
316/* Session FD ioctl (continued) */
317#define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
318 _IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
319#define LTTNG_KERNEL_SESSION_TRACK_ID \
320 _IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
321#define LTTNG_KERNEL_SESSION_UNTRACK_ID \
322 _IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
323
324/*
325 * LTTng-specific ioctls for the lib ringbuffer.
326 *
327 * Operations applying to the current sub-buffer need to occur between
328 * a get/put or get_next/put_next ioctl pair.
329 */
330
331/* returns the timestamp begin of the current sub-buffer */
332#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
333/* returns the timestamp end of the current sub-buffer */
334#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
335/* returns the number of events discarded of the current sub-buffer */
336#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
337/* returns the packet payload size of the current sub-buffer */
338#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
339/* returns the packet size of the current sub-buffer*/
340#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
341/* returns the stream id (invariant for the stream) */
342#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
343/* returns the current timestamp as perceived from the tracer */
344#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
345/* returns the packet sequence number of the current sub-buffer */
346#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
347/* returns the stream instance id (invariant for the stream) */
348#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
349
350#ifdef CONFIG_COMPAT
351/* returns the timestamp begin of the current sub-buffer */
352#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
353 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
354/* returns the timestamp end of the current sub-buffer */
355#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
356 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
357/* returns the number of events discarded of the current sub-buffer */
358#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
359 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
360/* returns the packet payload size of the current sub-buffer */
361#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
362 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
363/* returns the packet size of the current sub-buffer */
364#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
365 LTTNG_RING_BUFFER_GET_PACKET_SIZE
366/* returns the stream id (invariant for the stream) */
367#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
368 LTTNG_RING_BUFFER_GET_STREAM_ID
369/* returns the current timestamp as perceived from the tracer */
370#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
371 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
372/* returns the packet sequence number of the current sub-buffer */
373#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
374 LTTNG_RING_BUFFER_GET_SEQ_NUM
375/* returns the stream instance id (invariant for the stream) */
376#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
377 LTTNG_RING_BUFFER_INSTANCE_ID
378#endif /* CONFIG_COMPAT */
379
380#endif /* _LTTNG_ABI_H */
This page took 0.024853 seconds and 4 git commands to generate.