Import CStringView from the Babeltrace tree
[lttng-tools.git] / src / common / lttng-kernel.hpp
... / ...
CommitLineData
1/*
2 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
3 * Copyright (C) 2011 EfficiOS Inc.
4 *
5 * SPDX-License-Identifier: GPL-2.0-only
6 *
7 */
8
9#ifndef _LTTNG_KERNEL_H
10#define _LTTNG_KERNEL_H
11
12#include <common/compiler.hpp>
13#include <common/macros.hpp>
14
15#include <lttng/constant.h>
16#include <lttng/event.h>
17
18#include <stdint.h>
19
20#define LTTNG_KERNEL_ABI_SYM_NAME_LEN 256
21#define LTTNG_KERNEL_ABI_MAX_UPROBE_NUM 32
22#define LTTNG_KERNEL_ABI_SESSION_NAME_LEN 256
23#define LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN 26
24
25/*
26 * LTTng DebugFS ABI structures.
27 *
28 * This is the kernel ABI copied from lttng-modules tree.
29 */
30
31enum lttng_kernel_abi_instrumentation {
32 LTTNG_KERNEL_ABI_ALL = -1, /* Used within lttng-tools */
33 LTTNG_KERNEL_ABI_TRACEPOINT = 0,
34 LTTNG_KERNEL_ABI_KPROBE = 1,
35 LTTNG_KERNEL_ABI_FUNCTION = 2,
36 LTTNG_KERNEL_ABI_KRETPROBE = 3,
37 LTTNG_KERNEL_ABI_NOOP = 4, /* not hooked */
38 LTTNG_KERNEL_ABI_SYSCALL = 5,
39 LTTNG_KERNEL_ABI_UPROBE = 6,
40};
41
42enum lttng_kernel_abi_context_type {
43 LTTNG_KERNEL_ABI_CONTEXT_PID = 0,
44 LTTNG_KERNEL_ABI_CONTEXT_PERF_CPU_COUNTER = 1,
45 LTTNG_KERNEL_ABI_CONTEXT_PROCNAME = 2,
46 LTTNG_KERNEL_ABI_CONTEXT_PRIO = 3,
47 LTTNG_KERNEL_ABI_CONTEXT_NICE = 4,
48 LTTNG_KERNEL_ABI_CONTEXT_VPID = 5,
49 LTTNG_KERNEL_ABI_CONTEXT_TID = 6,
50 LTTNG_KERNEL_ABI_CONTEXT_VTID = 7,
51 LTTNG_KERNEL_ABI_CONTEXT_PPID = 8,
52 LTTNG_KERNEL_ABI_CONTEXT_VPPID = 9,
53 LTTNG_KERNEL_ABI_CONTEXT_HOSTNAME = 10,
54 LTTNG_KERNEL_ABI_CONTEXT_CPU_ID = 11,
55 LTTNG_KERNEL_ABI_CONTEXT_INTERRUPTIBLE = 12,
56 LTTNG_KERNEL_ABI_CONTEXT_PREEMPTIBLE = 13,
57 LTTNG_KERNEL_ABI_CONTEXT_NEED_RESCHEDULE = 14,
58 LTTNG_KERNEL_ABI_CONTEXT_MIGRATABLE = 15,
59 LTTNG_KERNEL_ABI_CONTEXT_CALLSTACK_KERNEL = 16,
60 LTTNG_KERNEL_ABI_CONTEXT_CALLSTACK_USER = 17,
61 LTTNG_KERNEL_ABI_CONTEXT_CGROUP_NS = 18,
62 LTTNG_KERNEL_ABI_CONTEXT_IPC_NS = 19,
63 LTTNG_KERNEL_ABI_CONTEXT_MNT_NS = 20,
64 LTTNG_KERNEL_ABI_CONTEXT_NET_NS = 21,
65 LTTNG_KERNEL_ABI_CONTEXT_PID_NS = 22,
66 LTTNG_KERNEL_ABI_CONTEXT_USER_NS = 23,
67 LTTNG_KERNEL_ABI_CONTEXT_UTS_NS = 24,
68 LTTNG_KERNEL_ABI_CONTEXT_UID = 25,
69 LTTNG_KERNEL_ABI_CONTEXT_EUID = 26,
70 LTTNG_KERNEL_ABI_CONTEXT_SUID = 27,
71 LTTNG_KERNEL_ABI_CONTEXT_GID = 28,
72 LTTNG_KERNEL_ABI_CONTEXT_EGID = 29,
73 LTTNG_KERNEL_ABI_CONTEXT_SGID = 30,
74 LTTNG_KERNEL_ABI_CONTEXT_VUID = 31,
75 LTTNG_KERNEL_ABI_CONTEXT_VEUID = 32,
76 LTTNG_KERNEL_ABI_CONTEXT_VSUID = 33,
77 LTTNG_KERNEL_ABI_CONTEXT_VGID = 34,
78 LTTNG_KERNEL_ABI_CONTEXT_VEGID = 35,
79 LTTNG_KERNEL_ABI_CONTEXT_VSGID = 36,
80 LTTNG_KERNEL_ABI_CONTEXT_TIME_NS = 37,
81};
82
83/* Perf counter attributes */
84struct lttng_kernel_abi_perf_counter_ctx {
85 uint32_t type;
86 uint64_t config;
87 char name[LTTNG_KERNEL_ABI_SYM_NAME_LEN];
88} LTTNG_PACKED;
89
90/* Event/Channel context */
91#define LTTNG_KERNEL_ABI_CONTEXT_PADDING1 16
92#define LTTNG_KERNEL_ABI_CONTEXT_PADDING2 ((LTTNG_KERNEL_ABI_SYM_NAME_LEN + 32))
93struct lttng_kernel_abi_context {
94 enum lttng_kernel_abi_context_type ctx;
95 char padding[LTTNG_KERNEL_ABI_CONTEXT_PADDING1];
96
97 union {
98 struct lttng_kernel_abi_perf_counter_ctx perf_counter;
99 char padding[LTTNG_KERNEL_ABI_CONTEXT_PADDING2];
100 } u;
101} LTTNG_PACKED;
102
103struct lttng_kernel_abi_kretprobe {
104 uint64_t addr;
105
106 uint64_t offset;
107 char symbol_name[LTTNG_KERNEL_ABI_SYM_NAME_LEN];
108} LTTNG_PACKED;
109
110/*
111 * Either addr is used, or symbol_name and offset.
112 */
113struct lttng_kernel_abi_kprobe {
114 uint64_t addr;
115
116 uint64_t offset;
117 char symbol_name[LTTNG_KERNEL_ABI_SYM_NAME_LEN];
118} LTTNG_PACKED;
119
120struct lttng_kernel_abi_uprobe {
121 int fd;
122} LTTNG_PACKED;
123
124struct lttng_kernel_abi_event_callsite_uprobe {
125 uint64_t offset;
126} LTTNG_PACKED;
127
128struct lttng_kernel_abi_event_callsite {
129 union {
130 struct lttng_kernel_abi_event_callsite_uprobe uprobe;
131 } u;
132} LTTNG_PACKED;
133
134enum lttng_kernel_abi_syscall_entryexit {
135 LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT = 0,
136 LTTNG_KERNEL_ABI_SYSCALL_ENTRY = 1,
137 LTTNG_KERNEL_ABI_SYSCALL_EXIT = 2,
138};
139
140enum lttng_kernel_abi_syscall_abi {
141 LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL = 0,
142 LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE = 1,
143 LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT = 2,
144};
145
146enum lttng_kernel_abi_syscall_match {
147 LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME = 0,
148 LTTNG_KERNEL_ABI_SYSCALL_MATCH_NR = 1,
149};
150
151struct lttng_kernel_abi_syscall {
152 uint8_t entryexit; /* enum lttng_kernel_abi_syscall_entryexit */
153 uint8_t abi; /* enum lttng_kernel_abi_syscall_abi */
154 uint8_t match; /* enum lttng_kernel_abi_syscall_match */
155 uint8_t padding;
156 uint32_t nr; /* For LTTNG_SYSCALL_MATCH_NR */
157} LTTNG_PACKED;
158
159/* Function tracer */
160struct lttng_kernel_abi_function {
161 char symbol_name[LTTNG_KERNEL_ABI_SYM_NAME_LEN];
162} LTTNG_PACKED;
163
164#define LTTNG_KERNEL_ABI_EVENT_PADDING1 8
165#define LTTNG_KERNEL_ABI_EVENT_PADDING2 ((LTTNG_KERNEL_ABI_SYM_NAME_LEN + 32))
166struct lttng_kernel_abi_event {
167 char name[LTTNG_KERNEL_ABI_SYM_NAME_LEN];
168 enum lttng_kernel_abi_instrumentation instrumentation;
169 uint64_t token;
170 char padding[LTTNG_KERNEL_ABI_EVENT_PADDING1];
171
172 /* Per instrumentation type configuration */
173 union {
174 struct lttng_kernel_abi_kretprobe kretprobe;
175 struct lttng_kernel_abi_kprobe kprobe;
176 struct lttng_kernel_abi_function ftrace;
177 struct lttng_kernel_abi_uprobe uprobe;
178 struct lttng_kernel_abi_syscall syscall;
179 char padding[LTTNG_KERNEL_ABI_EVENT_PADDING2];
180 } u;
181} LTTNG_PACKED;
182
183#define LTTNG_KERNEL_ABI_EVENT_NOTIFIER_PADDING 32
184struct lttng_kernel_abi_event_notifier {
185 struct lttng_kernel_abi_event event;
186 uint64_t error_counter_idx;
187
188 char padding[LTTNG_KERNEL_ABI_EVENT_NOTIFIER_PADDING];
189} LTTNG_PACKED;
190
191#define LTTNG_KERNEL_ABI_COUNTER_DIMENSION_MAX 4
192
193enum lttng_kernel_abi_counter_arithmetic {
194 LTTNG_KERNEL_ABI_COUNTER_ARITHMETIC_MODULAR = 0,
195};
196
197enum lttng_kernel_abi_counter_bitness {
198 LTTNG_KERNEL_ABI_COUNTER_BITNESS_32 = 0,
199 LTTNG_KERNEL_ABI_COUNTER_BITNESS_64 = 1,
200};
201
202struct lttng_kernel_abi_counter_dimension {
203 uint64_t size;
204 uint64_t underflow_index;
205 uint64_t overflow_index;
206 uint8_t has_underflow;
207 uint8_t has_overflow;
208} LTTNG_PACKED;
209
210#define LTTNG_KERNEL_ABI_COUNTER_CONF_PADDING1 67
211struct lttng_kernel_abi_counter_conf {
212 uint32_t arithmetic; /* enum lttng_kernel_abi_counter_arithmetic */
213 uint32_t bitness; /* enum lttng_kernel_abi_counter_bitness */
214 uint32_t number_dimensions;
215 int64_t global_sum_step;
216 struct lttng_kernel_abi_counter_dimension dimensions[LTTNG_KERNEL_ABI_COUNTER_DIMENSION_MAX];
217 uint8_t coalesce_hits;
218 char padding[LTTNG_KERNEL_ABI_COUNTER_CONF_PADDING1];
219} LTTNG_PACKED;
220
221struct lttng_kernel_abi_counter_index {
222 uint32_t number_dimensions;
223 uint64_t dimension_indexes[LTTNG_KERNEL_ABI_COUNTER_DIMENSION_MAX];
224} LTTNG_PACKED;
225
226struct lttng_kernel_abi_counter_value {
227 int64_t value;
228 uint8_t underflow;
229 uint8_t overflow;
230} LTTNG_PACKED;
231
232#define LTTNG_KERNEL_ABI_COUNTER_READ_PADDING 32
233struct lttng_kernel_abi_counter_read {
234 struct lttng_kernel_abi_counter_index index;
235 int32_t cpu; /* -1 for global counter, >= 0 for specific cpu. */
236 struct lttng_kernel_abi_counter_value value; /* output */
237 char padding[LTTNG_KERNEL_ABI_COUNTER_READ_PADDING];
238} LTTNG_PACKED;
239
240#define LTTNG_KERNEL_ABI_COUNTER_AGGREGATE_PADDING 32
241struct lttng_kernel_abi_counter_aggregate {
242 struct lttng_kernel_abi_counter_index index;
243 struct lttng_kernel_abi_counter_value value; /* output */
244 char padding[LTTNG_KERNEL_ABI_COUNTER_AGGREGATE_PADDING];
245} LTTNG_PACKED;
246
247#define LTTNG_KERNEL_ABI_COUNTER_CLEAR_PADDING 32
248struct lttng_kernel_abi_counter_clear {
249 struct lttng_kernel_abi_counter_index index;
250 char padding[LTTNG_KERNEL_ABI_COUNTER_CLEAR_PADDING];
251} LTTNG_PACKED;
252
253#define LTTNG_KERNEL_ABI_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
254struct lttng_kernel_abi_event_notifier_notification {
255 uint64_t token;
256 uint16_t capture_buf_size;
257 char padding[LTTNG_KERNEL_ABI_EVENT_NOTIFIER_NOTIFICATION_PADDING];
258} LTTNG_PACKED;
259
260#define LTTNG_KERNEL_ABI_CAPTURE_BYTECODE_MAX_LEN 65536
261struct lttng_kernel_abi_capture_bytecode {
262 uint32_t len;
263 uint32_t reloc_offset;
264 uint64_t seqnum;
265 char data[0];
266} LTTNG_PACKED;
267
268struct lttng_kernel_abi_tracer_version {
269 uint32_t major;
270 uint32_t minor;
271 uint32_t patchlevel;
272} LTTNG_PACKED;
273
274struct lttng_kernel_abi_tracer_abi_version {
275 uint32_t major;
276 uint32_t minor;
277} LTTNG_PACKED;
278
279struct lttng_kernel_abi_syscall_mask {
280 uint32_t len; /* in bits */
281 char mask[LTTNG_FLEXIBLE_ARRAY_MEMBER_LENGTH];
282} LTTNG_PACKED;
283
284/*
285 * kernel channel
286 */
287#define LTTNG_KERNEL_ABI_CHANNEL_PADDING1 ((LTTNG_SYMBOL_NAME_LEN + 32))
288struct lttng_kernel_abi_channel {
289 uint64_t subbuf_size; /* bytes */
290 uint64_t num_subbuf; /* power of 2 */
291 unsigned int switch_timer_interval; /* usec */
292 unsigned int read_timer_interval; /* usec */
293 enum lttng_event_output output; /* splice, mmap */
294
295 int overwrite; /* 1: overwrite, 0: discard */
296 char padding[LTTNG_KERNEL_ABI_CHANNEL_PADDING1];
297} LTTNG_PACKED;
298
299#define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
300struct lttng_kernel_abi_filter_bytecode {
301 uint32_t len;
302 uint32_t reloc_offset;
303 uint64_t seqnum;
304 char data[0];
305} LTTNG_PACKED;
306
307/*
308 * kernel session name
309 */
310struct lttng_kernel_abi_session_name {
311 char name[LTTNG_KERNEL_ABI_SESSION_NAME_LEN];
312} LTTNG_PACKED;
313
314/*
315 * kernel session creation datetime
316 */
317struct lttng_kernel_abi_session_creation_time {
318 char iso8601[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN];
319} LTTNG_PACKED;
320
321enum lttng_kernel_abi_tracker_type {
322 LTTNG_KERNEL_ABI_TRACKER_UNKNOWN = -1,
323
324 LTTNG_KERNEL_ABI_TRACKER_PID = 0,
325 LTTNG_KERNEL_ABI_TRACKER_VPID = 1,
326 LTTNG_KERNEL_ABI_TRACKER_UID = 2,
327 LTTNG_KERNEL_ABI_TRACKER_VUID = 3,
328 LTTNG_KERNEL_ABI_TRACKER_GID = 4,
329 LTTNG_KERNEL_ABI_TRACKER_VGID = 5,
330};
331
332struct lttng_kernel_abi_tracker_args {
333 enum lttng_kernel_abi_tracker_type type;
334 int32_t id;
335};
336
337#endif /* _LTTNG_KERNEL_H */
This page took 0.022718 seconds and 4 git commands to generate.