Migrate tracepoint instrumentation to TP_FIELDS
[lttng-modules.git] / lttng-abi.h
CommitLineData
e8951e63
MD
1#ifndef _LTTNG_ABI_H
2#define _LTTNG_ABI_H
57a13317
MD
3
4/*
e8951e63 5 * lttng-abi.h
57a13317 6 *
80996790 7 * LTTng ABI header
17baffe2 8 *
886d51a3
MD
9 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; only
14 * version 2.1 of the License.
15 *
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
57a13317
MD
24 */
25
26#include <linux/fs.h>
27
42cabb80
MD
28/*
29 * Major/minor version of ABI exposed to lttng tools. Major number
30 * should be increased when an incompatible ABI change is done.
31 */
3c997079 32#define LTTNG_MODULES_ABI_MAJOR_VERSION 2
42cabb80
MD
33#define LTTNG_MODULES_ABI_MINOR_VERSION 0
34
f8695253 35#define LTTNG_KERNEL_SYM_NAME_LEN 256
d6d808f3 36
38d024ae 37enum lttng_kernel_instrumentation {
4c183524
MD
38 LTTNG_KERNEL_TRACEPOINT = 0,
39 LTTNG_KERNEL_KPROBE = 1,
40 LTTNG_KERNEL_FUNCTION = 2,
7371f44c 41 LTTNG_KERNEL_KRETPROBE = 3,
1ec65de1 42 LTTNG_KERNEL_NOOP = 4, /* not hooked */
43880ee8 43 LTTNG_KERNEL_SYSCALL = 5,
57a13317
MD
44};
45
96ba7208
JD
46/*
47 * LTTng consumer mode
48 */
49enum lttng_kernel_output {
50 LTTNG_KERNEL_SPLICE = 0,
51 LTTNG_KERNEL_MMAP = 1,
52};
53
57a13317
MD
54/*
55 * LTTng DebugFS ABI structures.
56 */
8e099bae 57#define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
38d024ae 58struct lttng_kernel_channel {
9e245ead 59 uint64_t subbuf_size; /* in bytes */
80c16bcf 60 uint64_t num_subbuf;
9e245ead
MD
61 unsigned int switch_timer_interval; /* usecs */
62 unsigned int read_timer_interval; /* usecs */
96ba7208 63 enum lttng_kernel_output output; /* splice, mmap */
6dccd6c1 64 int overwrite; /* 1: overwrite, 0: discard */
8e099bae 65 char padding[LTTNG_KERNEL_CHANNEL_PADDING];
1a598612 66} __attribute__((packed));
57a13317 67
7371f44c
MD
68struct lttng_kernel_kretprobe {
69 uint64_t addr;
70
71 uint64_t offset;
f8695253 72 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 73} __attribute__((packed));
7371f44c 74
38d024ae
MD
75/*
76 * Either addr is used, or symbol_name and offset.
77 */
78struct lttng_kernel_kprobe {
80c16bcf 79 uint64_t addr;
38d024ae 80
80c16bcf 81 uint64_t offset;
f8695253 82 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 83} __attribute__((packed));
d6d808f3 84
f17701fb 85struct lttng_kernel_function_tracer {
f8695253 86 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 87} __attribute__((packed));
f17701fb 88
43880ee8 89/*
3c997079 90 * For syscall tracing, name = "*" means "enable all".
43880ee8 91 */
8e099bae
MD
92#define LTTNG_KERNEL_EVENT_PADDING1 16
93#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
d6d808f3 94struct lttng_kernel_event {
f8695253 95 char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
d6d808f3 96 enum lttng_kernel_instrumentation instrumentation;
8e099bae
MD
97 char padding[LTTNG_KERNEL_EVENT_PADDING1];
98
d6d808f3
MD
99 /* Per instrumentation type configuration */
100 union {
7371f44c 101 struct lttng_kernel_kretprobe kretprobe;
d6d808f3 102 struct lttng_kernel_kprobe kprobe;
f17701fb 103 struct lttng_kernel_function_tracer ftrace;
8e099bae 104 char padding[LTTNG_KERNEL_EVENT_PADDING2];
d6d808f3 105 } u;
1a598612 106} __attribute__((packed));
c099397a 107
80c16bcf 108struct lttng_kernel_tracer_version {
c6c9e10f
MD
109 uint32_t major;
110 uint32_t minor;
80c16bcf 111 uint32_t patchlevel;
1a598612 112} __attribute__((packed));
80c16bcf 113
42cabb80
MD
114struct lttng_kernel_tracer_abi_version {
115 uint32_t major;
116 uint32_t minor;
117} __attribute__((packed));
118
3db41b2c
MD
119enum lttng_kernel_calibrate_type {
120 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
57105fc2
MD
121};
122
3db41b2c
MD
123struct lttng_kernel_calibrate {
124 enum lttng_kernel_calibrate_type type; /* type (input) */
1a598612 125} __attribute__((packed));
57105fc2 126
12e579db
MD
127struct lttng_kernel_syscall_mask {
128 uint32_t len; /* in bits */
129 char mask[];
130} __attribute__((packed));
131
12a313a5 132enum lttng_kernel_context_type {
4c183524
MD
133 LTTNG_KERNEL_CONTEXT_PID = 0,
134 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
a2563e83 135 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
4c183524
MD
136 LTTNG_KERNEL_CONTEXT_PRIO = 3,
137 LTTNG_KERNEL_CONTEXT_NICE = 4,
138 LTTNG_KERNEL_CONTEXT_VPID = 5,
139 LTTNG_KERNEL_CONTEXT_TID = 6,
140 LTTNG_KERNEL_CONTEXT_VTID = 7,
141 LTTNG_KERNEL_CONTEXT_PPID = 8,
142 LTTNG_KERNEL_CONTEXT_VPPID = 9,
975da2c0 143 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
8070f5c0
MD
144};
145
146struct lttng_kernel_perf_counter_ctx {
147 uint32_t type;
148 uint64_t config;
f8695253 149 char name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 150} __attribute__((packed));
8070f5c0 151
8e099bae
MD
152#define LTTNG_KERNEL_CONTEXT_PADDING1 16
153#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
8070f5c0 154struct lttng_kernel_context {
12a313a5 155 enum lttng_kernel_context_type ctx;
8e099bae
MD
156 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
157
8070f5c0 158 union {
8070f5c0 159 struct lttng_kernel_perf_counter_ctx perf_counter;
8e099bae 160 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
8070f5c0 161 } u;
1a598612 162} __attribute__((packed));
8070f5c0 163
f127e61e 164#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
07dfc1d0
MD
165struct lttng_kernel_filter_bytecode {
166 uint32_t len;
167 uint32_t reloc_offset;
168 uint64_t seqnum;
169 char data[0];
170} __attribute__((packed));
171
33749530 172/* LTTng file descriptor ioctl */
6dccd6c1 173#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
33749530 174#define LTTNG_KERNEL_TRACER_VERSION \
6dccd6c1
JD
175 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
176#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
177#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
57105fc2 178#define LTTNG_KERNEL_CALIBRATE \
6dccd6c1 179 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
29c956bb 180#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
42cabb80
MD
181#define LTTNG_KERNEL_TRACER_ABI_VERSION \
182 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
33749530
MD
183
184/* Session FD ioctl */
185#define LTTNG_KERNEL_METADATA \
6dccd6c1 186 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
ab2277d6 187#define LTTNG_KERNEL_CHANNEL \
6dccd6c1
JD
188 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
189#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
190#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
e0130fab
MD
191#define LTTNG_KERNEL_SESSION_TRACK_PID \
192 _IOR(0xF6, 0x58, int32_t)
193#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
194 _IOR(0xF6, 0x59, int32_t)
7e6f9ef6 195#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
33749530
MD
196
197/* Channel FD ioctl */
6dccd6c1 198#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
ab2277d6 199#define LTTNG_KERNEL_EVENT \
6dccd6c1 200 _IOW(0xF6, 0x63, struct lttng_kernel_event)
12e579db
MD
201#define LTTNG_KERNEL_SYSCALL_MASK \
202 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
57a13317 203
8070f5c0
MD
204/* Event and Channel FD ioctl */
205#define LTTNG_KERNEL_CONTEXT \
6dccd6c1 206 _IOW(0xF6, 0x71, struct lttng_kernel_context)
8070f5c0 207
e64957da 208/* Event, Channel and Session ioctl */
6dccd6c1
JD
209#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
210#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
e64957da 211
07dfc1d0
MD
212/* Event FD ioctl */
213#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
214
3b731ab1
JD
215/* LTTng-specific ioctls for the lib ringbuffer */
216/* returns the timestamp begin of the current sub-buffer */
217#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
218/* returns the timestamp end of the current sub-buffer */
219#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
220/* returns the number of events discarded */
221#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
222/* returns the packet payload size */
223#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
224/* returns the actual packet size */
225#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
226/* returns the stream id */
227#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
2348ca17
JD
228/* returns the current timestamp */
229#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
3b731ab1
JD
230
231#ifdef CONFIG_COMPAT
232/* returns the timestamp begin of the current sub-buffer */
233#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
234 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
235/* returns the timestamp end of the current sub-buffer */
236#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
237 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
238/* returns the number of events discarded */
239#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
240 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
241/* returns the packet payload size */
242#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
243 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
244/* returns the actual packet size */
245#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
246 LTTNG_RING_BUFFER_GET_PACKET_SIZE
247/* returns the stream id */
248#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
249 LTTNG_RING_BUFFER_GET_STREAM_ID
2348ca17
JD
250/* returns the current timestamp */
251#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
252 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
3b731ab1
JD
253#endif /* CONFIG_COMPAT */
254
e8951e63 255#endif /* _LTTNG_ABI_H */
This page took 0.041564 seconds and 4 git commands to generate.