SoW-2020-0003: Trace Hit Counters
[lttng-tools.git] / src / common / lttng-kernel.h
CommitLineData
93128a92 1/*
ab5be9fa
MJ
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>
93128a92 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
93128a92 7 *
93128a92
DG
8 */
9
10#ifndef _LTTNG_KERNEL_H
11#define _LTTNG_KERNEL_H
12
e848fc76 13#include <stdint.h>
113373e4 14#include <common/macros.h>
0ef03255
FD
15#include <lttng/constant.h>
16#include <lttng/event.h>
e848fc76 17
dbbb3ec5 18#define LTTNG_KERNEL_SYM_NAME_LEN 256
0ef03255 19#define LTTNG_KERNEL_MAX_UPROBE_NUM 32
8ff4109e 20#define LTTNG_KERNEL_SESSION_NAME_LEN 256
e04b2181 21#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
9cb98350 22
7d29a247
DG
23/*
24 * LTTng DebugFS ABI structures.
25 *
26 * This is the kernel ABI copied from lttng-modules tree.
27 */
28
9cb98350 29enum lttng_kernel_instrumentation {
5f822d0a 30 LTTNG_KERNEL_ALL = -1, /* Used within lttng-tools */
e6ddca71
DG
31 LTTNG_KERNEL_TRACEPOINT = 0,
32 LTTNG_KERNEL_KPROBE = 1,
33 LTTNG_KERNEL_FUNCTION = 2,
8f0d098b 34 LTTNG_KERNEL_KRETPROBE = 3,
0133c199 35 LTTNG_KERNEL_NOOP = 4, /* not hooked */
a54bd42d 36 LTTNG_KERNEL_SYSCALL = 5,
1ab8c2ad 37 LTTNG_KERNEL_UPROBE = 6,
e6ddca71
DG
38};
39
7d29a247
DG
40enum lttng_kernel_context_type {
41 LTTNG_KERNEL_CONTEXT_PID = 0,
aa3514e9 42 LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER = 1,
9197c5c4 43 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
7d29a247
DG
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,
54773d68 51 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
33e801a9 52 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
1ae5e83e
JD
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,
373148e9
FG
57 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
58 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
40e14884
MJ
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,
499cbfa1
MJ
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,
d37ac3cd 78 LTTNG_KERNEL_CONTEXT_TIME_NS = 37,
7d29a247
DG
79};
80
81/* Perf counter attributes */
82struct lttng_kernel_perf_counter_ctx {
83 uint32_t type;
84 uint64_t config;
dbbb3ec5 85 char name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 86} LTTNG_PACKED;
7d29a247
DG
87
88/* Event/Channel context */
dbbb3ec5
DG
89#define LTTNG_KERNEL_CONTEXT_PADDING1 16
90#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
7d29a247
DG
91struct lttng_kernel_context {
92 enum lttng_kernel_context_type ctx;
dbbb3ec5
DG
93 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
94
7d29a247
DG
95 union {
96 struct lttng_kernel_perf_counter_ctx perf_counter;
dbbb3ec5 97 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
7d29a247 98 } u;
113373e4 99} LTTNG_PACKED;
9cb98350 100
8f0d098b
MD
101struct lttng_kernel_kretprobe {
102 uint64_t addr;
103
104 uint64_t offset;
dbbb3ec5 105 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 106} LTTNG_PACKED;
8f0d098b 107
93128a92 108/*
7d29a247 109 * Either addr is used, or symbol_name and offset.
93128a92 110 */
7d29a247
DG
111struct lttng_kernel_kprobe {
112 uint64_t addr;
113
114 uint64_t offset;
dbbb3ec5 115 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 116} LTTNG_PACKED;
9cb98350 117
1ab8c2ad
FD
118struct lttng_kernel_uprobe {
119 int fd;
120} LTTNG_PACKED;
121
122struct lttng_kernel_event_callsite_uprobe {
123 uint64_t offset;
124} LTTNG_PACKED;
125
126struct lttng_kernel_event_callsite {
127 union {
128 struct lttng_kernel_event_callsite_uprobe uprobe;
129 } u;
130} LTTNG_PACKED;
131
c863e5a6
FD
132enum lttng_kernel_syscall_entryexit {
133 LTTNG_KERNEL_SYSCALL_ENTRYEXIT = 0,
134 LTTNG_KERNEL_SYSCALL_ENTRY = 1,
135 LTTNG_KERNEL_SYSCALL_EXIT = 2,
136};
137
138enum 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
144enum lttng_kernel_syscall_match {
145 LTTNG_KERNEL_SYSCALL_MATCH_NAME = 0,
146 LTTNG_KERNEL_SYSCALL_MATCH_NR = 1,
147};
148
149struct 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
f05b5f07 157/* Function tracer */
7d29a247 158struct lttng_kernel_function {
dbbb3ec5 159 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 160} LTTNG_PACKED;
93128a92 161
8e49ca12 162#define LTTNG_KERNEL_EVENT_PADDING1 8
dbbb3ec5 163#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
9cb98350 164struct lttng_kernel_event {
dbbb3ec5 165 char name[LTTNG_KERNEL_SYM_NAME_LEN];
9cb98350 166 enum lttng_kernel_instrumentation instrumentation;
8e49ca12 167 uint64_t token;
dbbb3ec5
DG
168 char padding[LTTNG_KERNEL_EVENT_PADDING1];
169
9cb98350
JD
170 /* Per instrumentation type configuration */
171 union {
8f0d098b 172 struct lttng_kernel_kretprobe kretprobe;
7d29a247
DG
173 struct lttng_kernel_kprobe kprobe;
174 struct lttng_kernel_function ftrace;
c863e5a6
FD
175 struct lttng_kernel_uprobe uprobe;
176 struct lttng_kernel_syscall syscall;
dbbb3ec5 177 char padding[LTTNG_KERNEL_EVENT_PADDING2];
9cb98350 178 } u;
113373e4 179} LTTNG_PACKED;
93128a92 180
ebdb334b 181#define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING 32
cfb1c9bc
JR
182struct lttng_kernel_event_notifier {
183 struct lttng_kernel_event event;
ebdb334b
JR
184 uint64_t error_counter_idx;
185
cfb1c9bc
JR
186 char padding[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING];
187} LTTNG_PACKED;
188
ebdb334b
JR
189enum lttng_kernel_key_token_type {
190 LTTNG_KERNEL_KEY_TOKEN_STRING = 0, /* arg: strtab_offset. */
191 LTTNG_KERNEL_KEY_TOKEN_EVENT_NAME = 1, /* no arg. */
192};
193
194#define LTTNG_KERNEL_KEY_ARG_PADDING1 60
195#define LTTNG_KERNEL_KEY_TOKEN_STRING_LEN_MAX 256
196struct lttng_kernel_key_token {
197 uint32_t type; /* enum lttng_kernel_key_token_type */
198 union {
199 uint64_t string_ptr;
200 char padding[LTTNG_KERNEL_KEY_ARG_PADDING1];
201 } arg;
202} LTTNG_PACKED;
203
204#define LTTNG_KERNEL_NR_KEY_TOKEN 4
205struct lttng_kernel_counter_key_dimension {
206 uint32_t nr_key_tokens;
207 struct lttng_kernel_key_token key_tokens[LTTNG_KERNEL_NR_KEY_TOKEN];
208} LTTNG_PACKED;
209
210#define LTTNG_KERNEL_COUNTER_DIMENSION_MAX 4
211struct lttng_kernel_counter_key {
212 uint32_t nr_dimensions;
213 struct lttng_kernel_counter_key_dimension key_dimensions[LTTNG_KERNEL_COUNTER_DIMENSION_MAX];
214} LTTNG_PACKED;
215
216#define LTTNG_KERNEL_COUNTER_EVENT_PADDING1 16
217struct lttng_kernel_counter_event {
218 struct lttng_kernel_event event;
219 struct lttng_kernel_counter_key key;
220 char padding[LTTNG_KERNEL_COUNTER_EVENT_PADDING1];
221} LTTNG_PACKED;
222
223enum lttng_kernel_counter_arithmetic {
224 LTTNG_KERNEL_COUNTER_ARITHMETIC_MODULAR = 0,
225};
226
227enum lttng_kernel_counter_bitness {
228 LTTNG_KERNEL_COUNTER_BITNESS_32 = 0,
229 LTTNG_KERNEL_COUNTER_BITNESS_64 = 1,
230};
231
232struct lttng_kernel_counter_dimension {
233 uint64_t size;
234 uint64_t underflow_index;
235 uint64_t overflow_index;
236 uint8_t has_underflow;
237 uint8_t has_overflow;
238} LTTNG_PACKED;
239
240#define LTTNG_KERNEL_COUNTER_CONF_PADDING1 67
241struct lttng_kernel_counter_conf {
242 uint32_t arithmetic; /* enum lttng_kernel_counter_arithmetic */
243 uint32_t bitness; /* enum lttng_kernel_counter_bitness */
244 uint32_t number_dimensions;
245 int64_t global_sum_step;
246 struct lttng_kernel_counter_dimension dimensions[LTTNG_KERNEL_COUNTER_DIMENSION_MAX];
247 uint8_t coalesce_hits;
248 char padding[LTTNG_KERNEL_COUNTER_CONF_PADDING1];
249} LTTNG_PACKED;
250
251struct lttng_kernel_counter_index {
252 uint32_t number_dimensions;
253 uint64_t dimension_indexes[LTTNG_KERNEL_COUNTER_DIMENSION_MAX];
254} LTTNG_PACKED;
255
256struct lttng_kernel_counter_value {
257 int64_t value;
258 uint8_t underflow;
259 uint8_t overflow;
260} LTTNG_PACKED;
261
262#define LTTNG_KERNEL_COUNTER_READ_PADDING 32
263struct lttng_kernel_counter_read {
264 struct lttng_kernel_counter_index index;
265 int32_t cpu; /* -1 for global counter, >= 0 for specific cpu. */
266 struct lttng_kernel_counter_value value; /* output */
267 char padding[LTTNG_KERNEL_COUNTER_READ_PADDING];
268} LTTNG_PACKED;
269
270#define LTTNG_KERNEL_COUNTER_AGGREGATE_PADDING 32
271struct lttng_kernel_counter_aggregate {
272 struct lttng_kernel_counter_index index;
273 struct lttng_kernel_counter_value value; /* output */
274 char padding[LTTNG_KERNEL_COUNTER_AGGREGATE_PADDING];
275} LTTNG_PACKED;
276
277#define LTTNG_KERNEL_COUNTER_CLEAR_PADDING 32
278struct lttng_kernel_counter_clear {
279 struct lttng_kernel_counter_index index;
280 char padding[LTTNG_KERNEL_COUNTER_CLEAR_PADDING];
281} LTTNG_PACKED;
282
283#define LTTNG_KERNEL_COUNTER_MAP_NR_DESCRIPTORS_PADDING 32
284struct lttng_kernel_counter_map_nr_descriptors {
285 uint64_t nr_descriptors;
286};
287
288#define LTTNG_KERNEL_COUNTER_KEY_LEN 256
289#define LTTNG_KERNEL_COUNTER_MAP_DESCRIPTOR_PADDING 32
290struct lttng_kernel_counter_map_descriptor {
291 uint64_t descriptor_index; /* input. [ 0 .. nr_descriptors - 1 ] */
292 uint32_t dimension; /* outputs */
293 uint64_t array_index;
294 uint64_t user_token;
295 char key[LTTNG_KERNEL_COUNTER_KEY_LEN];
296
297 char padding[LTTNG_KERNEL_COUNTER_MAP_DESCRIPTOR_PADDING];
298} LTTNG_PACKED;
299
300#define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
cfb1c9bc
JR
301struct lttng_kernel_event_notifier_notification {
302 uint64_t token;
ebdb334b 303 uint16_t capture_buf_size;
cfb1c9bc
JR
304 char padding[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING];
305} LTTNG_PACKED;
306
ebdb334b
JR
307#define LTTNG_KERNEL_CAPTURE_BYTECODE_MAX_LEN 65536
308struct lttng_kernel_capture_bytecode {
309 uint32_t len;
310 uint32_t reloc_offset;
311 uint64_t seqnum;
312 char data[0];
313} LTTNG_PACKED;
314
9cb98350 315struct lttng_kernel_tracer_version {
a62a6556
MD
316 uint32_t major;
317 uint32_t minor;
9cb98350 318 uint32_t patchlevel;
113373e4 319} LTTNG_PACKED;
93128a92 320
c052142c
MD
321struct lttng_kernel_tracer_abi_version {
322 uint32_t major;
323 uint32_t minor;
324} LTTNG_PACKED;
325
e80c3634 326struct lttng_kernel_syscall_mask {
46820c8b 327 uint32_t len; /* in bits */
e80c3634
MD
328 char mask[];
329} LTTNG_PACKED;
330
4dbc372b
JD
331/*
332 * kernel channel
333 */
334#define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
335struct lttng_kernel_channel {
336 uint64_t subbuf_size; /* bytes */
337 uint64_t num_subbuf; /* power of 2 */
338 unsigned int switch_timer_interval; /* usec */
339 unsigned int read_timer_interval; /* usec */
340 enum lttng_event_output output; /* splice, mmap */
341
342 int overwrite; /* 1: overwrite, 0: discard */
343 char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
113373e4 344} LTTNG_PACKED;
d0254c7c 345
00a62084
MD
346#define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
347struct lttng_kernel_filter_bytecode {
348 uint32_t len;
349 uint32_t reloc_offset;
350 uint64_t seqnum;
351 char data[0];
352} LTTNG_PACKED;
353
8ff4109e
JR
354/*
355 * kernel session name
356 */
357struct lttng_kernel_session_name {
358 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
359} LTTNG_PACKED;
360
e04b2181
JR
361/*
362 * kernel session creation datetime
363 */
364struct lttng_kernel_session_creation_time {
365 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
366} LTTNG_PACKED;
367
d01c0e56
MD
368enum lttng_kernel_tracker_type {
369 LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
370
371 LTTNG_KERNEL_TRACKER_PID = 0,
372 LTTNG_KERNEL_TRACKER_VPID = 1,
373 LTTNG_KERNEL_TRACKER_UID = 2,
374 LTTNG_KERNEL_TRACKER_VUID = 3,
375 LTTNG_KERNEL_TRACKER_GID = 4,
376 LTTNG_KERNEL_TRACKER_VGID = 5,
377};
378
379struct lttng_kernel_tracker_args {
380 enum lttng_kernel_tracker_type type;
381 int32_t id;
382};
383
93128a92 384#endif /* _LTTNG_KERNEL_H */
This page took 0.097754 seconds and 5 git commands to generate.