2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
6 * SPDX-License-Identifier: GPL-2.0-only
10 #ifndef _LTTNG_KERNEL_H
11 #define _LTTNG_KERNEL_H
14 #include <common/macros.h>
15 #include <lttng/constant.h>
16 #include <lttng/event.h>
18 #define LTTNG_KERNEL_SYM_NAME_LEN 256
19 #define LTTNG_KERNEL_MAX_UPROBE_NUM 32
20 #define LTTNG_KERNEL_SESSION_NAME_LEN 256
21 #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
24 * LTTng DebugFS ABI structures.
26 * This is the kernel ABI copied from lttng-modules tree.
29 enum lttng_kernel_instrumentation
{
30 LTTNG_KERNEL_ALL
= -1, /* Used within lttng-tools */
31 LTTNG_KERNEL_TRACEPOINT
= 0,
32 LTTNG_KERNEL_KPROBE
= 1,
33 LTTNG_KERNEL_FUNCTION
= 2,
34 LTTNG_KERNEL_KRETPROBE
= 3,
35 LTTNG_KERNEL_NOOP
= 4, /* not hooked */
36 LTTNG_KERNEL_SYSCALL
= 5,
37 LTTNG_KERNEL_UPROBE
= 6,
40 enum lttng_kernel_context_type
{
41 LTTNG_KERNEL_CONTEXT_PID
= 0,
42 LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
= 1,
43 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
44 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
45 LTTNG_KERNEL_CONTEXT_NICE
= 4,
46 LTTNG_KERNEL_CONTEXT_VPID
= 5,
47 LTTNG_KERNEL_CONTEXT_TID
= 6,
48 LTTNG_KERNEL_CONTEXT_VTID
= 7,
49 LTTNG_KERNEL_CONTEXT_PPID
= 8,
50 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
51 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
52 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
53 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
54 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
55 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
56 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
57 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
58 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
59 LTTNG_KERNEL_CONTEXT_CGROUP_NS
= 18,
60 LTTNG_KERNEL_CONTEXT_IPC_NS
= 19,
61 LTTNG_KERNEL_CONTEXT_MNT_NS
= 20,
62 LTTNG_KERNEL_CONTEXT_NET_NS
= 21,
63 LTTNG_KERNEL_CONTEXT_PID_NS
= 22,
64 LTTNG_KERNEL_CONTEXT_USER_NS
= 23,
65 LTTNG_KERNEL_CONTEXT_UTS_NS
= 24,
66 LTTNG_KERNEL_CONTEXT_UID
= 25,
67 LTTNG_KERNEL_CONTEXT_EUID
= 26,
68 LTTNG_KERNEL_CONTEXT_SUID
= 27,
69 LTTNG_KERNEL_CONTEXT_GID
= 28,
70 LTTNG_KERNEL_CONTEXT_EGID
= 29,
71 LTTNG_KERNEL_CONTEXT_SGID
= 30,
72 LTTNG_KERNEL_CONTEXT_VUID
= 31,
73 LTTNG_KERNEL_CONTEXT_VEUID
= 32,
74 LTTNG_KERNEL_CONTEXT_VSUID
= 33,
75 LTTNG_KERNEL_CONTEXT_VGID
= 34,
76 LTTNG_KERNEL_CONTEXT_VEGID
= 35,
77 LTTNG_KERNEL_CONTEXT_VSGID
= 36,
78 LTTNG_KERNEL_CONTEXT_TIME_NS
= 37,
81 /* Perf counter attributes */
82 struct lttng_kernel_perf_counter_ctx
{
85 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
88 /* Event/Channel context */
89 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
90 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
91 struct lttng_kernel_context
{
92 enum lttng_kernel_context_type ctx
;
93 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
96 struct lttng_kernel_perf_counter_ctx perf_counter
;
97 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
101 struct lttng_kernel_kretprobe
{
105 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
109 * Either addr is used, or symbol_name and offset.
111 struct lttng_kernel_kprobe
{
115 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
118 struct lttng_kernel_uprobe
{
122 struct lttng_kernel_event_callsite_uprobe
{
126 struct lttng_kernel_event_callsite
{
128 struct lttng_kernel_event_callsite_uprobe uprobe
;
132 enum lttng_kernel_syscall_entryexit
{
133 LTTNG_KERNEL_SYSCALL_ENTRYEXIT
= 0,
134 LTTNG_KERNEL_SYSCALL_ENTRY
= 1,
135 LTTNG_KERNEL_SYSCALL_EXIT
= 2,
138 enum lttng_kernel_syscall_abi
{
139 LTTNG_KERNEL_SYSCALL_ABI_ALL
= 0,
140 LTTNG_KERNEL_SYSCALL_ABI_NATIVE
= 1,
141 LTTNG_KERNEL_SYSCALL_ABI_COMPAT
= 2,
144 enum lttng_kernel_syscall_match
{
145 LTTNG_KERNEL_SYSCALL_MATCH_NAME
= 0,
146 LTTNG_KERNEL_SYSCALL_MATCH_NR
= 1,
149 struct lttng_kernel_syscall
{
150 uint8_t entryexit
; /* enum lttng_kernel_syscall_entryexit */
151 uint8_t abi
; /* enum lttng_kernel_syscall_abi */
152 uint8_t match
; /* enum lttng_kernel_syscall_match */
154 uint32_t nr
; /* For LTTNG_SYSCALL_MATCH_NR */
157 /* Function tracer */
158 struct lttng_kernel_function
{
159 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
162 #define LTTNG_KERNEL_EVENT_PADDING1 8
163 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
164 struct lttng_kernel_event
{
165 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
166 enum lttng_kernel_instrumentation instrumentation
;
168 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
170 /* Per instrumentation type configuration */
172 struct lttng_kernel_kretprobe kretprobe
;
173 struct lttng_kernel_kprobe kprobe
;
174 struct lttng_kernel_function ftrace
;
175 struct lttng_kernel_uprobe uprobe
;
176 struct lttng_kernel_syscall syscall
;
177 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
181 #define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING 40
182 struct lttng_kernel_event_notifier
{
183 struct lttng_kernel_event event
;
184 char padding
[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING
];
187 #define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
188 struct lttng_kernel_event_notifier_notification
{
190 uint16_t capture_buf_size
;
191 char padding
[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING
];
194 #define LTTNG_KERNEL_CAPTURE_BYTECODE_MAX_LEN 65536
195 struct lttng_kernel_capture_bytecode
{
197 uint32_t reloc_offset
;
202 struct lttng_kernel_tracer_version
{
208 struct lttng_kernel_tracer_abi_version
{
213 struct lttng_kernel_syscall_mask
{
214 uint32_t len
; /* in bits */
221 #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
222 struct lttng_kernel_channel
{
223 uint64_t subbuf_size
; /* bytes */
224 uint64_t num_subbuf
; /* power of 2 */
225 unsigned int switch_timer_interval
; /* usec */
226 unsigned int read_timer_interval
; /* usec */
227 enum lttng_event_output output
; /* splice, mmap */
229 int overwrite
; /* 1: overwrite, 0: discard */
230 char padding
[LTTNG_KERNEL_CHANNEL_PADDING1
];
233 #define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
234 struct lttng_kernel_filter_bytecode
{
236 uint32_t reloc_offset
;
242 * kernel session name
244 struct lttng_kernel_session_name
{
245 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
249 * kernel session creation datetime
251 struct lttng_kernel_session_creation_time
{
252 char iso8601
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
255 enum lttng_kernel_tracker_type
{
256 LTTNG_KERNEL_TRACKER_UNKNOWN
= -1,
258 LTTNG_KERNEL_TRACKER_PID
= 0,
259 LTTNG_KERNEL_TRACKER_VPID
= 1,
260 LTTNG_KERNEL_TRACKER_UID
= 2,
261 LTTNG_KERNEL_TRACKER_VUID
= 3,
262 LTTNG_KERNEL_TRACKER_GID
= 4,
263 LTTNG_KERNEL_TRACKER_VGID
= 5,
266 struct lttng_kernel_tracker_args
{
267 enum lttng_kernel_tracker_type type
;
271 #endif /* _LTTNG_KERNEL_H */