9 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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
29 * Major/minor version of ABI exposed to lttng tools. Major number
30 * should be increased when an incompatible ABI change is done.
32 #define LTTNG_MODULES_ABI_MAJOR_VERSION 1
33 #define LTTNG_MODULES_ABI_MINOR_VERSION 0
35 #define LTTNG_KERNEL_SYM_NAME_LEN 256
37 enum lttng_kernel_instrumentation
{
38 LTTNG_KERNEL_TRACEPOINT
= 0,
39 LTTNG_KERNEL_KPROBE
= 1,
40 LTTNG_KERNEL_FUNCTION
= 2,
41 LTTNG_KERNEL_KRETPROBE
= 3,
42 LTTNG_KERNEL_NOOP
= 4, /* not hooked */
43 LTTNG_KERNEL_SYSCALL
= 5,
49 enum lttng_kernel_output
{
50 LTTNG_KERNEL_SPLICE
= 0,
51 LTTNG_KERNEL_MMAP
= 1,
55 * LTTng DebugFS ABI structures.
57 #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
58 struct lttng_kernel_channel
{
59 uint64_t subbuf_size
; /* in bytes */
61 unsigned int switch_timer_interval
; /* usecs */
62 unsigned int read_timer_interval
; /* usecs */
63 enum lttng_kernel_output output
; /* splice, mmap */
64 int overwrite
; /* 1: overwrite, 0: discard */
65 char padding
[LTTNG_KERNEL_CHANNEL_PADDING
];
66 } __attribute__((packed
));
68 struct lttng_kernel_kretprobe
{
72 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
73 } __attribute__((packed
));
76 * Either addr is used, or symbol_name and offset.
78 struct lttng_kernel_kprobe
{
82 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
83 } __attribute__((packed
));
85 struct lttng_kernel_function_tracer
{
86 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
87 } __attribute__((packed
));
89 struct lttng_kernel_syscall
{
91 } __attribute__((packed
));
94 * For syscall tracing, name = '\0' means "enable all".
96 #define LTTNG_KERNEL_EVENT_PADDING1 16
97 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
98 struct lttng_kernel_event
{
99 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
100 enum lttng_kernel_instrumentation instrumentation
;
101 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
103 /* Per instrumentation type configuration */
105 struct lttng_kernel_kretprobe kretprobe
;
106 struct lttng_kernel_kprobe kprobe
;
107 struct lttng_kernel_function_tracer ftrace
;
108 struct lttng_kernel_syscall syscall
;
109 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
111 } __attribute__((packed
));
113 struct lttng_kernel_tracer_version
{
117 } __attribute__((packed
));
119 struct lttng_kernel_tracer_abi_version
{
122 } __attribute__((packed
));
124 enum lttng_kernel_calibrate_type
{
125 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
128 struct lttng_kernel_calibrate
{
129 enum lttng_kernel_calibrate_type type
; /* type (input) */
130 } __attribute__((packed
));
132 struct lttng_kernel_syscall_mask
{
133 uint32_t len
; /* in bits */
135 } __attribute__((packed
));
137 enum lttng_kernel_context_type
{
138 LTTNG_KERNEL_CONTEXT_PID
= 0,
139 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
140 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
141 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
142 LTTNG_KERNEL_CONTEXT_NICE
= 4,
143 LTTNG_KERNEL_CONTEXT_VPID
= 5,
144 LTTNG_KERNEL_CONTEXT_TID
= 6,
145 LTTNG_KERNEL_CONTEXT_VTID
= 7,
146 LTTNG_KERNEL_CONTEXT_PPID
= 8,
147 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
148 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
151 struct lttng_kernel_perf_counter_ctx
{
154 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
155 } __attribute__((packed
));
157 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
158 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
159 struct lttng_kernel_context
{
160 enum lttng_kernel_context_type ctx
;
161 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
164 struct lttng_kernel_perf_counter_ctx perf_counter
;
165 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
167 } __attribute__((packed
));
169 /* LTTng file descriptor ioctl */
170 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
171 #define LTTNG_KERNEL_TRACER_VERSION \
172 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
173 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
174 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
175 #define LTTNG_KERNEL_CALIBRATE \
176 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
177 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
178 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
179 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
181 /* Session FD ioctl */
182 #define LTTNG_KERNEL_METADATA \
183 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
184 #define LTTNG_KERNEL_CHANNEL \
185 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
186 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
187 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
189 /* Channel FD ioctl */
190 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
191 #define LTTNG_KERNEL_EVENT \
192 _IOW(0xF6, 0x63, struct lttng_kernel_event)
193 #define LTTNG_KERNEL_SYSCALL_MASK \
194 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
196 /* Event and Channel FD ioctl */
197 #define LTTNG_KERNEL_CONTEXT \
198 _IOW(0xF6, 0x71, struct lttng_kernel_context)
200 /* Event, Channel and Session ioctl */
201 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
202 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
204 /* LTTng-specific ioctls for the lib ringbuffer */
205 /* returns the timestamp begin of the current sub-buffer */
206 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
207 /* returns the timestamp end of the current sub-buffer */
208 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
209 /* returns the number of events discarded */
210 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
211 /* returns the packet payload size */
212 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
213 /* returns the actual packet size */
214 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
215 /* returns the stream id */
216 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
217 /* returns the current timestamp */
218 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
221 /* returns the timestamp begin of the current sub-buffer */
222 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
223 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
224 /* returns the timestamp end of the current sub-buffer */
225 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
226 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
227 /* returns the number of events discarded */
228 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
229 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
230 /* returns the packet payload size */
231 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
232 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
233 /* returns the actual packet size */
234 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
235 LTTNG_RING_BUFFER_GET_PACKET_SIZE
236 /* returns the stream id */
237 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
238 LTTNG_RING_BUFFER_GET_STREAM_ID
239 /* returns the current timestamp */
240 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
241 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
242 #endif /* CONFIG_COMPAT */
244 #endif /* _LTTNG_ABI_H */