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