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