| 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 | #define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING 32 |
| 182 | struct lttng_kernel_event_notifier { |
| 183 | struct lttng_kernel_event event; |
| 184 | uint64_t error_counter_idx; |
| 185 | |
| 186 | char padding[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING]; |
| 187 | } LTTNG_PACKED; |
| 188 | |
| 189 | enum 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 |
| 196 | struct 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 |
| 205 | struct 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 |
| 211 | struct 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 |
| 217 | struct 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 | |
| 223 | enum lttng_kernel_counter_arithmetic { |
| 224 | LTTNG_KERNEL_COUNTER_ARITHMETIC_MODULAR = 0, |
| 225 | }; |
| 226 | |
| 227 | enum lttng_kernel_counter_bitness { |
| 228 | LTTNG_KERNEL_COUNTER_BITNESS_32 = 0, |
| 229 | LTTNG_KERNEL_COUNTER_BITNESS_64 = 1, |
| 230 | }; |
| 231 | |
| 232 | struct 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 |
| 241 | struct 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 | |
| 251 | struct lttng_kernel_counter_index { |
| 252 | uint32_t number_dimensions; |
| 253 | uint64_t dimension_indexes[LTTNG_KERNEL_COUNTER_DIMENSION_MAX]; |
| 254 | } LTTNG_PACKED; |
| 255 | |
| 256 | struct 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 |
| 263 | struct 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 |
| 271 | struct 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 |
| 278 | struct 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 |
| 284 | struct 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 |
| 290 | struct 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 |
| 301 | struct lttng_kernel_event_notifier_notification { |
| 302 | uint64_t token; |
| 303 | uint16_t capture_buf_size; |
| 304 | char padding[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING]; |
| 305 | } LTTNG_PACKED; |
| 306 | |
| 307 | #define LTTNG_KERNEL_CAPTURE_BYTECODE_MAX_LEN 65536 |
| 308 | struct 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 | |
| 315 | struct lttng_kernel_tracer_version { |
| 316 | uint32_t major; |
| 317 | uint32_t minor; |
| 318 | uint32_t patchlevel; |
| 319 | } LTTNG_PACKED; |
| 320 | |
| 321 | struct lttng_kernel_tracer_abi_version { |
| 322 | uint32_t major; |
| 323 | uint32_t minor; |
| 324 | } LTTNG_PACKED; |
| 325 | |
| 326 | struct lttng_kernel_syscall_mask { |
| 327 | uint32_t len; /* in bits */ |
| 328 | char mask[]; |
| 329 | } LTTNG_PACKED; |
| 330 | |
| 331 | /* |
| 332 | * kernel channel |
| 333 | */ |
| 334 | #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32 |
| 335 | struct 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]; |
| 344 | } LTTNG_PACKED; |
| 345 | |
| 346 | #define KERNEL_FILTER_BYTECODE_MAX_LEN 65536 |
| 347 | struct 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 | |
| 354 | /* |
| 355 | * kernel session name |
| 356 | */ |
| 357 | struct lttng_kernel_session_name { |
| 358 | char name[LTTNG_KERNEL_SESSION_NAME_LEN]; |
| 359 | } LTTNG_PACKED; |
| 360 | |
| 361 | /* |
| 362 | * kernel session creation datetime |
| 363 | */ |
| 364 | struct lttng_kernel_session_creation_time { |
| 365 | char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN]; |
| 366 | } LTTNG_PACKED; |
| 367 | |
| 368 | enum 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 | |
| 379 | struct lttng_kernel_tracker_args { |
| 380 | enum lttng_kernel_tracker_type type; |
| 381 | int32_t id; |
| 382 | }; |
| 383 | |
| 384 | #endif /* _LTTNG_KERNEL_H */ |