uprobe: Receive file descriptor from session instead of path to file
[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 3
21
22#define LTTNG_KERNEL_SYM_NAME_LEN 256
23
24enum lttng_kernel_instrumentation {
25 LTTNG_KERNEL_TRACEPOINT = 0,
26 LTTNG_KERNEL_KPROBE = 1,
27 LTTNG_KERNEL_FUNCTION = 2,
28 LTTNG_KERNEL_KRETPROBE = 3,
29 LTTNG_KERNEL_NOOP = 4, /* not hooked */
30 LTTNG_KERNEL_SYSCALL = 5,
31 LTTNG_KERNEL_UPROBE = 6,
32};
33
34/*
35 * LTTng consumer mode
36 */
37enum lttng_kernel_output {
38 LTTNG_KERNEL_SPLICE = 0,
39 LTTNG_KERNEL_MMAP = 1,
40};
41
42/*
43 * LTTng DebugFS ABI structures.
44 */
45#define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
46struct lttng_kernel_channel {
47 uint64_t subbuf_size; /* in bytes */
48 uint64_t num_subbuf;
49 unsigned int switch_timer_interval; /* usecs */
50 unsigned int read_timer_interval; /* usecs */
51 enum lttng_kernel_output output; /* splice, mmap */
52 int overwrite; /* 1: overwrite, 0: discard */
53 char padding[LTTNG_KERNEL_CHANNEL_PADDING];
54} __attribute__((packed));
55
56struct lttng_kernel_kretprobe {
57 uint64_t addr;
58
59 uint64_t offset;
60 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
61} __attribute__((packed));
62
63/*
64 * Either addr is used, or symbol_name and offset.
65 */
66struct lttng_kernel_kprobe {
67 uint64_t addr;
68
69 uint64_t offset;
70 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
71} __attribute__((packed));
72
73struct lttng_kernel_function_tracer {
74 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
75} __attribute__((packed));
76
77struct lttng_kernel_uprobe {
78 int fd;
79 uint64_t offset;
80} __attribute__((packed));
81
82/*
83 * For syscall tracing, name = "*" means "enable all".
84 */
85#define LTTNG_KERNEL_EVENT_PADDING1 16
86#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
87struct lttng_kernel_event {
88 char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
89 enum lttng_kernel_instrumentation instrumentation;
90 char padding[LTTNG_KERNEL_EVENT_PADDING1];
91
92 /* Per instrumentation type configuration */
93 union {
94 struct lttng_kernel_kretprobe kretprobe;
95 struct lttng_kernel_kprobe kprobe;
96 struct lttng_kernel_function_tracer ftrace;
97 struct lttng_kernel_uprobe uprobe;
98 char padding[LTTNG_KERNEL_EVENT_PADDING2];
99 } u;
100} __attribute__((packed));
101
102struct lttng_kernel_tracer_version {
103 uint32_t major;
104 uint32_t minor;
105 uint32_t patchlevel;
106} __attribute__((packed));
107
108struct lttng_kernel_tracer_abi_version {
109 uint32_t major;
110 uint32_t minor;
111} __attribute__((packed));
112
113enum lttng_kernel_calibrate_type {
114 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
115};
116
117struct lttng_kernel_calibrate {
118 enum lttng_kernel_calibrate_type type; /* type (input) */
119} __attribute__((packed));
120
121struct lttng_kernel_syscall_mask {
122 uint32_t len; /* in bits */
123 char mask[];
124} __attribute__((packed));
125
126enum lttng_kernel_context_type {
127 LTTNG_KERNEL_CONTEXT_PID = 0,
128 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
129 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
130 LTTNG_KERNEL_CONTEXT_PRIO = 3,
131 LTTNG_KERNEL_CONTEXT_NICE = 4,
132 LTTNG_KERNEL_CONTEXT_VPID = 5,
133 LTTNG_KERNEL_CONTEXT_TID = 6,
134 LTTNG_KERNEL_CONTEXT_VTID = 7,
135 LTTNG_KERNEL_CONTEXT_PPID = 8,
136 LTTNG_KERNEL_CONTEXT_VPPID = 9,
137 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
138 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
139 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
140 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
141 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
142 LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
143 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
144 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
145};
146
147struct lttng_kernel_perf_counter_ctx {
148 uint32_t type;
149 uint64_t config;
150 char name[LTTNG_KERNEL_SYM_NAME_LEN];
151} __attribute__((packed));
152
153#define LTTNG_KERNEL_CONTEXT_PADDING1 16
154#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
155struct lttng_kernel_context {
156 enum lttng_kernel_context_type ctx;
157 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
158
159 union {
160 struct lttng_kernel_perf_counter_ctx perf_counter;
161 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
162 } u;
163} __attribute__((packed));
164
165#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
166struct lttng_kernel_filter_bytecode {
167 uint32_t len;
168 uint32_t reloc_offset;
169 uint64_t seqnum;
170 char data[0];
171} __attribute__((packed));
172
173/* LTTng file descriptor ioctl */
174#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
175#define LTTNG_KERNEL_TRACER_VERSION \
176 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
177#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
178#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
179#define LTTNG_KERNEL_CALIBRATE \
180 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
181#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
182#define LTTNG_KERNEL_TRACER_ABI_VERSION \
183 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
184
185/* Session FD ioctl */
186#define LTTNG_KERNEL_METADATA \
187 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
188#define LTTNG_KERNEL_CHANNEL \
189 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
190#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
191#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
192#define LTTNG_KERNEL_SESSION_TRACK_PID \
193 _IOR(0xF6, 0x58, int32_t)
194#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
195 _IOR(0xF6, 0x59, int32_t)
196/*
197 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
198 * are generating two different ioctl numbers, but this was not done on
199 * purpose. We should generally try to avoid those duplications.
200 */
201#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
202#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
203/* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
204#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
205
206/* Channel FD ioctl */
207#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
208#define LTTNG_KERNEL_EVENT \
209 _IOW(0xF6, 0x63, struct lttng_kernel_event)
210#define LTTNG_KERNEL_SYSCALL_MASK \
211 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
212
213/* Event and Channel FD ioctl */
214#define LTTNG_KERNEL_CONTEXT \
215 _IOW(0xF6, 0x71, struct lttng_kernel_context)
216
217/* Event, Channel and Session ioctl */
218#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
219#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
220
221/* Event FD ioctl */
222#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
223
224/* LTTng-specific ioctls for the lib ringbuffer */
225/* returns the timestamp begin of the current sub-buffer */
226#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
227/* returns the timestamp end of the current sub-buffer */
228#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
229/* returns the number of events discarded */
230#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
231/* returns the packet payload size */
232#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
233/* returns the actual packet size */
234#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
235/* returns the stream id */
236#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
237/* returns the current timestamp */
238#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
239/* returns the packet sequence number */
240#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
241/* returns the stream instance id */
242#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
243
244#ifdef CONFIG_COMPAT
245/* returns the timestamp begin of the current sub-buffer */
246#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
247 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
248/* returns the timestamp end of the current sub-buffer */
249#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
250 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
251/* returns the number of events discarded */
252#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
253 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
254/* returns the packet payload size */
255#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
256 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
257/* returns the actual packet size */
258#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
259 LTTNG_RING_BUFFER_GET_PACKET_SIZE
260/* returns the stream id */
261#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
262 LTTNG_RING_BUFFER_GET_STREAM_ID
263/* returns the current timestamp */
264#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
265 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
266/* returns the packet sequence number */
267#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
268 LTTNG_RING_BUFFER_GET_SEQ_NUM
269/* returns the stream instance id */
270#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
271 LTTNG_RING_BUFFER_INSTANCE_ID
272#endif /* CONFIG_COMPAT */
273
274#endif /* _LTTNG_ABI_H */
This page took 0.023249 seconds and 4 git commands to generate.