3dd866c75eb5fd0707a24606134e970f9c311af3
[lttng-tools.git] / src / common / lttng-kernel.h
1 /*
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>
5 *
6 * SPDX-License-Identifier: GPL-2.0-only
7 *
8 */
9
10 #ifndef _LTTNG_KERNEL_H
11 #define _LTTNG_KERNEL_H
12
13 #include <stdint.h>
14 #include <common/macros.h>
15 #include <lttng/constant.h>
16 #include <lttng/event.h>
17
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
22
23 /*
24 * LTTng DebugFS ABI structures.
25 *
26 * This is the kernel ABI copied from lttng-modules tree.
27 */
28
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,
38 };
39
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,
79 };
80
81 /* Perf counter attributes */
82 struct lttng_kernel_perf_counter_ctx {
83 uint32_t type;
84 uint64_t config;
85 char name[LTTNG_KERNEL_SYM_NAME_LEN];
86 } LTTNG_PACKED;
87
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];
94
95 union {
96 struct lttng_kernel_perf_counter_ctx perf_counter;
97 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
98 } u;
99 } LTTNG_PACKED;
100
101 struct lttng_kernel_kretprobe {
102 uint64_t addr;
103
104 uint64_t offset;
105 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
106 } LTTNG_PACKED;
107
108 /*
109 * Either addr is used, or symbol_name and offset.
110 */
111 struct lttng_kernel_kprobe {
112 uint64_t addr;
113
114 uint64_t offset;
115 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
116 } LTTNG_PACKED;
117
118 struct lttng_kernel_uprobe {
119 int fd;
120 } LTTNG_PACKED;
121
122 struct lttng_kernel_event_callsite_uprobe {
123 uint64_t offset;
124 } LTTNG_PACKED;
125
126 struct lttng_kernel_event_callsite {
127 union {
128 struct lttng_kernel_event_callsite_uprobe uprobe;
129 } u;
130 } LTTNG_PACKED;
131
132 enum lttng_kernel_syscall_entryexit {
133 LTTNG_KERNEL_SYSCALL_ENTRYEXIT = 0,
134 LTTNG_KERNEL_SYSCALL_ENTRY = 1,
135 LTTNG_KERNEL_SYSCALL_EXIT = 2,
136 };
137
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,
142 };
143
144 enum lttng_kernel_syscall_match {
145 LTTNG_KERNEL_SYSCALL_MATCH_NAME = 0,
146 LTTNG_KERNEL_SYSCALL_MATCH_NR = 1,
147 };
148
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 */
153 uint8_t padding;
154 uint32_t nr; /* For LTTNG_SYSCALL_MATCH_NR */
155 } LTTNG_PACKED;
156
157 /* Function tracer */
158 struct lttng_kernel_function {
159 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
160 } LTTNG_PACKED;
161
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;
167 uint64_t token;
168 char padding[LTTNG_KERNEL_EVENT_PADDING1];
169
170 /* Per instrumentation type configuration */
171 union {
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];
178 } u;
179 } LTTNG_PACKED;
180
181 struct lttng_kernel_tracer_version {
182 uint32_t major;
183 uint32_t minor;
184 uint32_t patchlevel;
185 } LTTNG_PACKED;
186
187 struct lttng_kernel_tracer_abi_version {
188 uint32_t major;
189 uint32_t minor;
190 } LTTNG_PACKED;
191
192 struct lttng_kernel_syscall_mask {
193 uint32_t len; /* in bits */
194 char mask[];
195 } LTTNG_PACKED;
196
197 /*
198 * kernel channel
199 */
200 #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
201 struct lttng_kernel_channel {
202 uint64_t subbuf_size; /* bytes */
203 uint64_t num_subbuf; /* power of 2 */
204 unsigned int switch_timer_interval; /* usec */
205 unsigned int read_timer_interval; /* usec */
206 enum lttng_event_output output; /* splice, mmap */
207
208 int overwrite; /* 1: overwrite, 0: discard */
209 char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
210 } LTTNG_PACKED;
211
212 #define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
213 struct lttng_kernel_filter_bytecode {
214 uint32_t len;
215 uint32_t reloc_offset;
216 uint64_t seqnum;
217 char data[0];
218 } LTTNG_PACKED;
219
220 /*
221 * kernel session name
222 */
223 struct lttng_kernel_session_name {
224 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
225 } LTTNG_PACKED;
226
227 /*
228 * kernel session creation datetime
229 */
230 struct lttng_kernel_session_creation_time {
231 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
232 } LTTNG_PACKED;
233
234 enum lttng_kernel_tracker_type {
235 LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
236
237 LTTNG_KERNEL_TRACKER_PID = 0,
238 LTTNG_KERNEL_TRACKER_VPID = 1,
239 LTTNG_KERNEL_TRACKER_UID = 2,
240 LTTNG_KERNEL_TRACKER_VUID = 3,
241 LTTNG_KERNEL_TRACKER_GID = 4,
242 LTTNG_KERNEL_TRACKER_VGID = 5,
243 };
244
245 struct lttng_kernel_tracker_args {
246 enum lttng_kernel_tracker_type type;
247 int32_t id;
248 };
249
250 #endif /* _LTTNG_KERNEL_H */
This page took 0.059054 seconds and 3 git commands to generate.