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 };
  79
  80 /* Perf counter attributes */
  81 struct lttng_kernel_perf_counter_ctx {
  82         uint32_t type;
  83         uint64_t config;
  84         char name[LTTNG_KERNEL_SYM_NAME_LEN];
  85 } LTTNG_PACKED;
  86
  87 /* Event/Channel context */
  88 #define LTTNG_KERNEL_CONTEXT_PADDING1  16
  89 #define LTTNG_KERNEL_CONTEXT_PADDING2  LTTNG_KERNEL_SYM_NAME_LEN + 32
  90 struct lttng_kernel_context {
  91         enum lttng_kernel_context_type ctx;
  92         char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
  93
  94         union {
  95                 struct lttng_kernel_perf_counter_ctx perf_counter;
  96                 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
  97         } u;
  98 } LTTNG_PACKED;
  99
 100 struct lttng_kernel_kretprobe {
 101         uint64_t addr;
 102
 103         uint64_t offset;
 104         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 105 } LTTNG_PACKED;
 106
 107 /*
 108  * Either addr is used, or symbol_name and offset.
 109  */
 110 struct lttng_kernel_kprobe {
 111         uint64_t addr;
 112
 113         uint64_t offset;
 114         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 115 } LTTNG_PACKED;
 116
 117 struct lttng_kernel_uprobe {
 118         int fd;
 119 } LTTNG_PACKED;
 120
 121 struct lttng_kernel_event_callsite_uprobe {
 122         uint64_t offset;
 123 } LTTNG_PACKED;
 124
 125 struct lttng_kernel_event_callsite {
 126         union {
 127                 struct lttng_kernel_event_callsite_uprobe uprobe;
 128         } u;
 129 } LTTNG_PACKED;
 130
 131 /* Function tracer */
 132 struct lttng_kernel_function {
 133         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 134 } LTTNG_PACKED;
 135
 136 #define LTTNG_KERNEL_EVENT_PADDING1    16
 137 #define LTTNG_KERNEL_EVENT_PADDING2    LTTNG_KERNEL_SYM_NAME_LEN + 32
 138 struct lttng_kernel_event {
 139         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 140         enum lttng_kernel_instrumentation instrumentation;
 141         char padding[LTTNG_KERNEL_EVENT_PADDING1];
 142
 143         /* Per instrumentation type configuration */
 144         union {
 145                 struct lttng_kernel_kretprobe kretprobe;
 146                 struct lttng_kernel_kprobe kprobe;
 147                 struct lttng_kernel_uprobe uprobe;
 148                 struct lttng_kernel_function ftrace;
 149                 char padding[LTTNG_KERNEL_EVENT_PADDING2];
 150         } u;
 151 } LTTNG_PACKED;
 152
 153 struct lttng_kernel_tracer_version {
 154         uint32_t major;
 155         uint32_t minor;
 156         uint32_t patchlevel;
 157 } LTTNG_PACKED;
 158
 159 struct lttng_kernel_tracer_abi_version {
 160         uint32_t major;
 161         uint32_t minor;
 162 } LTTNG_PACKED;
 163
 164 struct lttng_kernel_syscall_mask {
 165         uint32_t len;   /* in bits */
 166         char mask[];
 167 } LTTNG_PACKED;
 168
 169 /*
 170  * kernel channel
 171  */
 172 #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
 173 struct lttng_kernel_channel {
 174         uint64_t subbuf_size;               /* bytes */
 175         uint64_t num_subbuf;                /* power of 2 */
 176         unsigned int switch_timer_interval; /* usec */
 177         unsigned int read_timer_interval;   /* usec */
 178         enum lttng_event_output output;     /* splice, mmap */
 179
 180         int overwrite;                      /* 1: overwrite, 0: discard */
 181         char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
 182 } LTTNG_PACKED;
 183
 184 #define KERNEL_FILTER_BYTECODE_MAX_LEN          65536
 185 struct lttng_kernel_filter_bytecode {
 186         uint32_t len;
 187         uint32_t reloc_offset;
 188         uint64_t seqnum;
 189         char data[0];
 190 } LTTNG_PACKED;
 191
 192 /*
 193  * kernel session name
 194  */
 195 struct lttng_kernel_session_name {
 196         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 197 } LTTNG_PACKED;
 198
 199 /*
 200  * kernel session creation datetime
 201  */
 202 struct lttng_kernel_session_creation_time {
 203         char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 204 } LTTNG_PACKED;
 205
 206 enum lttng_kernel_tracker_type {
 207         LTTNG_KERNEL_TRACKER_UNKNOWN            = -1,
 208
 209         LTTNG_KERNEL_TRACKER_PID                = 0,
 210         LTTNG_KERNEL_TRACKER_VPID               = 1,
 211         LTTNG_KERNEL_TRACKER_UID                = 2,
 212         LTTNG_KERNEL_TRACKER_VUID               = 3,
 213         LTTNG_KERNEL_TRACKER_GID                = 4,
 214         LTTNG_KERNEL_TRACKER_VGID               = 5,
 215 };
 216
 217 struct lttng_kernel_tracker_args {
 218         enum lttng_kernel_tracker_type type;
 219         int32_t id;
 220 };
 221
 222 #endif /* _LTTNG_KERNEL_H */