Add metadata env fields
[lttng-modules.git] / lttng-abi.h
CommitLineData
9f36eaed
MJ
1/* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1)
2 *
e8951e63 3 * lttng-abi.h
57a13317 4 *
80996790 5 * LTTng ABI header
17baffe2 6 *
886d51a3 7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
57a13317
MD
8 */
9
9f36eaed
MJ
10#ifndef _LTTNG_ABI_H
11#define _LTTNG_ABI_H
12
57a13317
MD
13#include <linux/fs.h>
14
42cabb80
MD
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 */
3c997079 19#define LTTNG_MODULES_ABI_MAJOR_VERSION 2
7f859fbf 20#define LTTNG_MODULES_ABI_MINOR_VERSION 4
42cabb80 21
f8695253 22#define LTTNG_KERNEL_SYM_NAME_LEN 256
7f859fbf 23#define LTTNG_KERNEL_SESSION_NAME_LEN 256
d6d808f3 24
38d024ae 25enum lttng_kernel_instrumentation {
4c183524
MD
26 LTTNG_KERNEL_TRACEPOINT = 0,
27 LTTNG_KERNEL_KPROBE = 1,
28 LTTNG_KERNEL_FUNCTION = 2,
7371f44c 29 LTTNG_KERNEL_KRETPROBE = 3,
1ec65de1 30 LTTNG_KERNEL_NOOP = 4, /* not hooked */
43880ee8 31 LTTNG_KERNEL_SYSCALL = 5,
149b9a9d 32 LTTNG_KERNEL_UPROBE = 6,
57a13317
MD
33};
34
96ba7208
JD
35/*
36 * LTTng consumer mode
37 */
38enum lttng_kernel_output {
39 LTTNG_KERNEL_SPLICE = 0,
40 LTTNG_KERNEL_MMAP = 1,
41};
42
57a13317
MD
43/*
44 * LTTng DebugFS ABI structures.
45 */
8e099bae 46#define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
38d024ae 47struct lttng_kernel_channel {
9e245ead 48 uint64_t subbuf_size; /* in bytes */
80c16bcf 49 uint64_t num_subbuf;
9e245ead
MD
50 unsigned int switch_timer_interval; /* usecs */
51 unsigned int read_timer_interval; /* usecs */
96ba7208 52 enum lttng_kernel_output output; /* splice, mmap */
6dccd6c1 53 int overwrite; /* 1: overwrite, 0: discard */
8e099bae 54 char padding[LTTNG_KERNEL_CHANNEL_PADDING];
1a598612 55} __attribute__((packed));
57a13317 56
7371f44c
MD
57struct lttng_kernel_kretprobe {
58 uint64_t addr;
59
60 uint64_t offset;
f8695253 61 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 62} __attribute__((packed));
7371f44c 63
38d024ae
MD
64/*
65 * Either addr is used, or symbol_name and offset.
66 */
67struct lttng_kernel_kprobe {
80c16bcf 68 uint64_t addr;
38d024ae 69
80c16bcf 70 uint64_t offset;
f8695253 71 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 72} __attribute__((packed));
d6d808f3 73
f17701fb 74struct lttng_kernel_function_tracer {
f8695253 75 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 76} __attribute__((packed));
f17701fb 77
149b9a9d 78struct lttng_kernel_uprobe {
56377c91 79 int fd;
3aed4dca
FD
80} __attribute__((packed));
81
82struct lttng_kernel_event_callsite_uprobe {
149b9a9d
YB
83 uint64_t offset;
84} __attribute__((packed));
85
3aed4dca
FD
86struct lttng_kernel_event_callsite {
87 union {
88 struct lttng_kernel_event_callsite_uprobe uprobe;
89 } u;
90} __attribute__((packed));
91
43880ee8 92/*
3c997079 93 * For syscall tracing, name = "*" means "enable all".
43880ee8 94 */
8e099bae
MD
95#define LTTNG_KERNEL_EVENT_PADDING1 16
96#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
d6d808f3 97struct lttng_kernel_event {
f8695253 98 char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
d6d808f3 99 enum lttng_kernel_instrumentation instrumentation;
8e099bae
MD
100 char padding[LTTNG_KERNEL_EVENT_PADDING1];
101
d6d808f3
MD
102 /* Per instrumentation type configuration */
103 union {
7371f44c 104 struct lttng_kernel_kretprobe kretprobe;
d6d808f3 105 struct lttng_kernel_kprobe kprobe;
f17701fb 106 struct lttng_kernel_function_tracer ftrace;
149b9a9d 107 struct lttng_kernel_uprobe uprobe;
8e099bae 108 char padding[LTTNG_KERNEL_EVENT_PADDING2];
d6d808f3 109 } u;
1a598612 110} __attribute__((packed));
c099397a 111
80c16bcf 112struct lttng_kernel_tracer_version {
c6c9e10f
MD
113 uint32_t major;
114 uint32_t minor;
80c16bcf 115 uint32_t patchlevel;
1a598612 116} __attribute__((packed));
80c16bcf 117
42cabb80
MD
118struct lttng_kernel_tracer_abi_version {
119 uint32_t major;
120 uint32_t minor;
121} __attribute__((packed));
122
7f859fbf
JR
123struct lttng_kernel_session_name {
124 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
125} __attribute__((packed));
126
3db41b2c
MD
127enum lttng_kernel_calibrate_type {
128 LTTNG_KERNEL_CALIBRATE_KRETPROBE,
57105fc2
MD
129};
130
3db41b2c
MD
131struct lttng_kernel_calibrate {
132 enum lttng_kernel_calibrate_type type; /* type (input) */
1a598612 133} __attribute__((packed));
57105fc2 134
12e579db
MD
135struct lttng_kernel_syscall_mask {
136 uint32_t len; /* in bits */
137 char mask[];
138} __attribute__((packed));
139
12a313a5 140enum lttng_kernel_context_type {
4c183524
MD
141 LTTNG_KERNEL_CONTEXT_PID = 0,
142 LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
a2563e83 143 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
4c183524
MD
144 LTTNG_KERNEL_CONTEXT_PRIO = 3,
145 LTTNG_KERNEL_CONTEXT_NICE = 4,
146 LTTNG_KERNEL_CONTEXT_VPID = 5,
147 LTTNG_KERNEL_CONTEXT_TID = 6,
148 LTTNG_KERNEL_CONTEXT_VTID = 7,
149 LTTNG_KERNEL_CONTEXT_PPID = 8,
150 LTTNG_KERNEL_CONTEXT_VPPID = 9,
975da2c0 151 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
b3699d90 152 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
79150a49
JD
153 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
154 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
155 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
156 LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
2fa2d39a
FG
157 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
158 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
8070f5c0
MD
159};
160
161struct lttng_kernel_perf_counter_ctx {
162 uint32_t type;
163 uint64_t config;
f8695253 164 char name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612 165} __attribute__((packed));
8070f5c0 166
8e099bae
MD
167#define LTTNG_KERNEL_CONTEXT_PADDING1 16
168#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
8070f5c0 169struct lttng_kernel_context {
12a313a5 170 enum lttng_kernel_context_type ctx;
8e099bae
MD
171 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
172
8070f5c0 173 union {
8070f5c0 174 struct lttng_kernel_perf_counter_ctx perf_counter;
8e099bae 175 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
8070f5c0 176 } u;
1a598612 177} __attribute__((packed));
8070f5c0 178
f127e61e 179#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
07dfc1d0
MD
180struct lttng_kernel_filter_bytecode {
181 uint32_t len;
182 uint32_t reloc_offset;
183 uint64_t seqnum;
184 char data[0];
185} __attribute__((packed));
186
33749530 187/* LTTng file descriptor ioctl */
6dccd6c1 188#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
33749530 189#define LTTNG_KERNEL_TRACER_VERSION \
6dccd6c1
JD
190 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
191#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
192#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
57105fc2 193#define LTTNG_KERNEL_CALIBRATE \
6dccd6c1 194 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
29c956bb 195#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
42cabb80
MD
196#define LTTNG_KERNEL_TRACER_ABI_VERSION \
197 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
33749530
MD
198
199/* Session FD ioctl */
200#define LTTNG_KERNEL_METADATA \
6dccd6c1 201 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
ab2277d6 202#define LTTNG_KERNEL_CHANNEL \
6dccd6c1
JD
203 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
204#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
205#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
e0130fab
MD
206#define LTTNG_KERNEL_SESSION_TRACK_PID \
207 _IOR(0xF6, 0x58, int32_t)
208#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
209 _IOR(0xF6, 0x59, int32_t)
fe40f016
MD
210/*
211 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
212 * are generating two different ioctl numbers, but this was not done on
213 * purpose. We should generally try to avoid those duplications.
214 */
7e6f9ef6 215#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
9616f0bf 216#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
7f859fbf 217
601252cf
MD
218/* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
219#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
7f859fbf
JR
220#define LTTNG_KERNEL_SESSION_SET_NAME \
221 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
33749530
MD
222
223/* Channel FD ioctl */
6dccd6c1 224#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
ab2277d6 225#define LTTNG_KERNEL_EVENT \
6dccd6c1 226 _IOW(0xF6, 0x63, struct lttng_kernel_event)
12e579db
MD
227#define LTTNG_KERNEL_SYSCALL_MASK \
228 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
57a13317 229
8070f5c0
MD
230/* Event and Channel FD ioctl */
231#define LTTNG_KERNEL_CONTEXT \
6dccd6c1 232 _IOW(0xF6, 0x71, struct lttng_kernel_context)
8070f5c0 233
e64957da 234/* Event, Channel and Session ioctl */
6dccd6c1
JD
235#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
236#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
e64957da 237
07dfc1d0
MD
238/* Event FD ioctl */
239#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
3aed4dca 240#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
07dfc1d0 241
1aca53e1
MD
242/*
243 * LTTng-specific ioctls for the lib ringbuffer.
244 *
245 * Operations applying to the current sub-buffer need to occur between
246 * a get/put or get_next/put_next ioctl pair.
247 */
248
3b731ab1
JD
249/* returns the timestamp begin of the current sub-buffer */
250#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
251/* returns the timestamp end of the current sub-buffer */
252#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
1aca53e1 253/* returns the number of events discarded of the current sub-buffer */
3b731ab1 254#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
1aca53e1 255/* returns the packet payload size of the current sub-buffer */
3b731ab1 256#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
1aca53e1 257/* returns the packet size of the current sub-buffer*/
3b731ab1 258#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
1aca53e1 259/* returns the stream id (invariant for the stream) */
3b731ab1 260#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
1aca53e1 261/* returns the current timestamp as perceived from the tracer */
2348ca17 262#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
1aca53e1 263/* returns the packet sequence number of the current sub-buffer */
5b3cf4f9 264#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
1aca53e1 265/* returns the stream instance id (invariant for the stream) */
5594698f 266#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
3b731ab1
JD
267
268#ifdef CONFIG_COMPAT
269/* returns the timestamp begin of the current sub-buffer */
270#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
271 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
272/* returns the timestamp end of the current sub-buffer */
273#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
274 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
1aca53e1 275/* returns the number of events discarded of the current sub-buffer */
3b731ab1
JD
276#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
277 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
1aca53e1 278/* returns the packet payload size of the current sub-buffer */
3b731ab1
JD
279#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
280 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
1aca53e1 281/* returns the packet size of the current sub-buffer */
3b731ab1
JD
282#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
283 LTTNG_RING_BUFFER_GET_PACKET_SIZE
1aca53e1 284/* returns the stream id (invariant for the stream) */
3b731ab1
JD
285#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
286 LTTNG_RING_BUFFER_GET_STREAM_ID
1aca53e1 287/* returns the current timestamp as perceived from the tracer */
2348ca17
JD
288#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
289 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
1aca53e1 290/* returns the packet sequence number of the current sub-buffer */
5b3cf4f9
JD
291#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
292 LTTNG_RING_BUFFER_GET_SEQ_NUM
1aca53e1 293/* returns the stream instance id (invariant for the stream) */
5594698f
JD
294#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
295 LTTNG_RING_BUFFER_INSTANCE_ID
3b731ab1
JD
296#endif /* CONFIG_COMPAT */
297
e8951e63 298#endif /* _LTTNG_ABI_H */
This page took 0.049116 seconds and 4 git commands to generate.