dynamic-array: fix documentation of lttng_dynamic_pointer_array_get_pointer
[lttng-tools.git] / src / common / lttng-kernel.h
CommitLineData
93128a92
DG
1/*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * David Goulet <david.goulet@polymtl.ca>
5 *
d14d33bf
AM
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
93128a92 9 *
d14d33bf
AM
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
93128a92 14 *
d14d33bf
AM
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
93128a92
DG
18 */
19
20#ifndef _LTTNG_KERNEL_H
21#define _LTTNG_KERNEL_H
22
e848fc76 23#include <stdint.h>
113373e4 24#include <common/macros.h>
0ef03255
FD
25#include <lttng/constant.h>
26#include <lttng/event.h>
e848fc76 27
dbbb3ec5 28#define LTTNG_KERNEL_SYM_NAME_LEN 256
0ef03255 29#define LTTNG_KERNEL_MAX_UPROBE_NUM 32
8ff4109e 30#define LTTNG_KERNEL_SESSION_NAME_LEN 256
e04b2181 31#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
9cb98350 32
7d29a247
DG
33/*
34 * LTTng DebugFS ABI structures.
35 *
36 * This is the kernel ABI copied from lttng-modules tree.
37 */
38
9cb98350 39enum lttng_kernel_instrumentation {
5f822d0a 40 LTTNG_KERNEL_ALL = -1, /* Used within lttng-tools */
e6ddca71
DG
41 LTTNG_KERNEL_TRACEPOINT = 0,
42 LTTNG_KERNEL_KPROBE = 1,
43 LTTNG_KERNEL_FUNCTION = 2,
8f0d098b 44 LTTNG_KERNEL_KRETPROBE = 3,
0133c199 45 LTTNG_KERNEL_NOOP = 4, /* not hooked */
a54bd42d 46 LTTNG_KERNEL_SYSCALL = 5,
1ab8c2ad 47 LTTNG_KERNEL_UPROBE = 6,
e6ddca71
DG
48};
49
7d29a247
DG
50enum lttng_kernel_context_type {
51 LTTNG_KERNEL_CONTEXT_PID = 0,
aa3514e9 52 LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER = 1,
9197c5c4 53 LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
7d29a247
DG
54 LTTNG_KERNEL_CONTEXT_PRIO = 3,
55 LTTNG_KERNEL_CONTEXT_NICE = 4,
56 LTTNG_KERNEL_CONTEXT_VPID = 5,
57 LTTNG_KERNEL_CONTEXT_TID = 6,
58 LTTNG_KERNEL_CONTEXT_VTID = 7,
59 LTTNG_KERNEL_CONTEXT_PPID = 8,
60 LTTNG_KERNEL_CONTEXT_VPPID = 9,
54773d68 61 LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
33e801a9 62 LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
1ae5e83e
JD
63 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
64 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
65 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
66 LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
373148e9
FG
67 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
68 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
40e14884
MJ
69 LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
70 LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
71 LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
72 LTTNG_KERNEL_CONTEXT_NET_NS = 21,
73 LTTNG_KERNEL_CONTEXT_PID_NS = 22,
74 LTTNG_KERNEL_CONTEXT_USER_NS = 23,
75 LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
499cbfa1
MJ
76 LTTNG_KERNEL_CONTEXT_UID = 25,
77 LTTNG_KERNEL_CONTEXT_EUID = 26,
78 LTTNG_KERNEL_CONTEXT_SUID = 27,
79 LTTNG_KERNEL_CONTEXT_GID = 28,
80 LTTNG_KERNEL_CONTEXT_EGID = 29,
81 LTTNG_KERNEL_CONTEXT_SGID = 30,
82 LTTNG_KERNEL_CONTEXT_VUID = 31,
83 LTTNG_KERNEL_CONTEXT_VEUID = 32,
84 LTTNG_KERNEL_CONTEXT_VSUID = 33,
85 LTTNG_KERNEL_CONTEXT_VGID = 34,
86 LTTNG_KERNEL_CONTEXT_VEGID = 35,
87 LTTNG_KERNEL_CONTEXT_VSGID = 36,
7d29a247
DG
88};
89
90/* Perf counter attributes */
91struct lttng_kernel_perf_counter_ctx {
92 uint32_t type;
93 uint64_t config;
dbbb3ec5 94 char name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 95} LTTNG_PACKED;
7d29a247
DG
96
97/* Event/Channel context */
dbbb3ec5
DG
98#define LTTNG_KERNEL_CONTEXT_PADDING1 16
99#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
7d29a247
DG
100struct lttng_kernel_context {
101 enum lttng_kernel_context_type ctx;
dbbb3ec5
DG
102 char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
103
7d29a247
DG
104 union {
105 struct lttng_kernel_perf_counter_ctx perf_counter;
dbbb3ec5 106 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
7d29a247 107 } u;
113373e4 108} LTTNG_PACKED;
9cb98350 109
8f0d098b
MD
110struct lttng_kernel_kretprobe {
111 uint64_t addr;
112
113 uint64_t offset;
dbbb3ec5 114 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 115} LTTNG_PACKED;
8f0d098b 116
93128a92 117/*
7d29a247 118 * Either addr is used, or symbol_name and offset.
93128a92 119 */
7d29a247
DG
120struct lttng_kernel_kprobe {
121 uint64_t addr;
122
123 uint64_t offset;
dbbb3ec5 124 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 125} LTTNG_PACKED;
9cb98350 126
1ab8c2ad
FD
127struct lttng_kernel_uprobe {
128 int fd;
129} LTTNG_PACKED;
130
131struct lttng_kernel_event_callsite_uprobe {
132 uint64_t offset;
133} LTTNG_PACKED;
134
135struct lttng_kernel_event_callsite {
136 union {
137 struct lttng_kernel_event_callsite_uprobe uprobe;
138 } u;
139} LTTNG_PACKED;
140
f05b5f07 141/* Function tracer */
7d29a247 142struct lttng_kernel_function {
dbbb3ec5 143 char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4 144} LTTNG_PACKED;
93128a92 145
dbbb3ec5
DG
146#define LTTNG_KERNEL_EVENT_PADDING1 16
147#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
9cb98350 148struct lttng_kernel_event {
dbbb3ec5 149 char name[LTTNG_KERNEL_SYM_NAME_LEN];
9cb98350 150 enum lttng_kernel_instrumentation instrumentation;
dbbb3ec5
DG
151 char padding[LTTNG_KERNEL_EVENT_PADDING1];
152
9cb98350
JD
153 /* Per instrumentation type configuration */
154 union {
8f0d098b 155 struct lttng_kernel_kretprobe kretprobe;
7d29a247 156 struct lttng_kernel_kprobe kprobe;
1ab8c2ad 157 struct lttng_kernel_uprobe uprobe;
7d29a247 158 struct lttng_kernel_function ftrace;
dbbb3ec5 159 char padding[LTTNG_KERNEL_EVENT_PADDING2];
9cb98350 160 } u;
113373e4 161} LTTNG_PACKED;
93128a92 162
9cb98350 163struct lttng_kernel_tracer_version {
a62a6556
MD
164 uint32_t major;
165 uint32_t minor;
9cb98350 166 uint32_t patchlevel;
113373e4 167} LTTNG_PACKED;
93128a92 168
c052142c
MD
169struct lttng_kernel_tracer_abi_version {
170 uint32_t major;
171 uint32_t minor;
172} LTTNG_PACKED;
173
e80c3634 174struct lttng_kernel_syscall_mask {
46820c8b 175 uint32_t len; /* in bits */
e80c3634
MD
176 char mask[];
177} LTTNG_PACKED;
178
4dbc372b
JD
179/*
180 * kernel channel
181 */
182#define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
183struct lttng_kernel_channel {
184 uint64_t subbuf_size; /* bytes */
185 uint64_t num_subbuf; /* power of 2 */
186 unsigned int switch_timer_interval; /* usec */
187 unsigned int read_timer_interval; /* usec */
188 enum lttng_event_output output; /* splice, mmap */
189
190 int overwrite; /* 1: overwrite, 0: discard */
191 char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
113373e4 192} LTTNG_PACKED;
d0254c7c 193
00a62084
MD
194#define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
195struct lttng_kernel_filter_bytecode {
196 uint32_t len;
197 uint32_t reloc_offset;
198 uint64_t seqnum;
199 char data[0];
200} LTTNG_PACKED;
201
8ff4109e
JR
202/*
203 * kernel session name
204 */
205struct lttng_kernel_session_name {
206 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
207} LTTNG_PACKED;
208
e04b2181
JR
209/*
210 * kernel session creation datetime
211 */
212struct lttng_kernel_session_creation_time {
213 char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
214} LTTNG_PACKED;
215
93128a92 216#endif /* _LTTNG_KERNEL_H */
This page took 0.088257 seconds and 4 git commands to generate.