src/common/lttng-kernel.h

   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 <stdint.h>
  13 #include <common/macros.h>
  14 #include <lttng/constant.h>
  15 #include <lttng/event.h>
  16
  17 #define LTTNG_KERNEL_SYM_NAME_LEN  256
  18 #define LTTNG_KERNEL_MAX_UPROBE_NUM  32
  19 #define LTTNG_KERNEL_SESSION_NAME_LEN   256
  20 #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN  26
  21
  22 /*
  23  * LTTng DebugFS ABI structures.
  24  *
  25  * This is the kernel ABI copied from lttng-modules tree.
  26  */
  27
  28 enum lttng_kernel_instrumentation {
  29         LTTNG_KERNEL_ALL           = -1,   /* Used within lttng-tools */
  30         LTTNG_KERNEL_TRACEPOINT    = 0,
  31         LTTNG_KERNEL_KPROBE        = 1,
  32         LTTNG_KERNEL_FUNCTION      = 2,
  33         LTTNG_KERNEL_KRETPROBE     = 3,
  34         LTTNG_KERNEL_NOOP          = 4,    /* not hooked */
  35         LTTNG_KERNEL_SYSCALL       = 5,
  36         LTTNG_KERNEL_UPROBE        = 6,
  37 };
  38
  39 enum lttng_kernel_context_type {
  40         LTTNG_KERNEL_CONTEXT_PID            = 0,
  41         LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER = 1,
  42         LTTNG_KERNEL_CONTEXT_PROCNAME       = 2,
  43         LTTNG_KERNEL_CONTEXT_PRIO           = 3,
  44         LTTNG_KERNEL_CONTEXT_NICE           = 4,
  45         LTTNG_KERNEL_CONTEXT_VPID           = 5,
  46         LTTNG_KERNEL_CONTEXT_TID            = 6,
  47         LTTNG_KERNEL_CONTEXT_VTID           = 7,
  48         LTTNG_KERNEL_CONTEXT_PPID           = 8,
  49         LTTNG_KERNEL_CONTEXT_VPPID          = 9,
  50         LTTNG_KERNEL_CONTEXT_HOSTNAME       = 10,
  51         LTTNG_KERNEL_CONTEXT_CPU_ID         = 11,
  52         LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE  = 12,
  53         LTTNG_KERNEL_CONTEXT_PREEMPTIBLE    = 13,
  54         LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
  55         LTTNG_KERNEL_CONTEXT_MIGRATABLE     = 15,
  56         LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
  57         LTTNG_KERNEL_CONTEXT_CALLSTACK_USER   = 17,
  58         LTTNG_KERNEL_CONTEXT_CGROUP_NS      = 18,
  59         LTTNG_KERNEL_CONTEXT_IPC_NS         = 19,
  60         LTTNG_KERNEL_CONTEXT_MNT_NS         = 20,
  61         LTTNG_KERNEL_CONTEXT_NET_NS         = 21,
  62         LTTNG_KERNEL_CONTEXT_PID_NS         = 22,
  63         LTTNG_KERNEL_CONTEXT_USER_NS        = 23,
  64         LTTNG_KERNEL_CONTEXT_UTS_NS         = 24,
  65         LTTNG_KERNEL_CONTEXT_UID            = 25,
  66         LTTNG_KERNEL_CONTEXT_EUID           = 26,
  67         LTTNG_KERNEL_CONTEXT_SUID           = 27,
  68         LTTNG_KERNEL_CONTEXT_GID            = 28,
  69         LTTNG_KERNEL_CONTEXT_EGID           = 29,
  70         LTTNG_KERNEL_CONTEXT_SGID           = 30,
  71         LTTNG_KERNEL_CONTEXT_VUID           = 31,
  72         LTTNG_KERNEL_CONTEXT_VEUID          = 32,
  73         LTTNG_KERNEL_CONTEXT_VSUID          = 33,
  74         LTTNG_KERNEL_CONTEXT_VGID           = 34,
  75         LTTNG_KERNEL_CONTEXT_VEGID          = 35,
  76         LTTNG_KERNEL_CONTEXT_VSGID          = 36,
  77 };
  78
  79 /* Perf counter attributes */
  80 struct lttng_kernel_perf_counter_ctx {
  81         uint32_t type;
  82         uint64_t config;
  83         char name[LTTNG_KERNEL_SYM_NAME_LEN];
  84 } LTTNG_PACKED;
  85
  86 /* Event/Channel context */
  87 #define LTTNG_KERNEL_CONTEXT_PADDING1  16
  88 #define LTTNG_KERNEL_CONTEXT_PADDING2  LTTNG_KERNEL_SYM_NAME_LEN + 32
  89 struct lttng_kernel_context {
  90         enum lttng_kernel_context_type ctx;
  91         char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
  92
  93         union {
  94                 struct lttng_kernel_perf_counter_ctx perf_counter;
  95                 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
  96         } u;
  97 } LTTNG_PACKED;
  98
  99 struct lttng_kernel_kretprobe {
 100         uint64_t addr;
 101
 102         uint64_t offset;
 103         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 104 } LTTNG_PACKED;
 105
 106 /*
 107  * Either addr is used, or symbol_name and offset.
 108  */
 109 struct lttng_kernel_kprobe {
 110         uint64_t addr;
 111
 112         uint64_t offset;
 113         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 114 } LTTNG_PACKED;
 115
 116 struct lttng_kernel_uprobe {
 117         int fd;
 118 } LTTNG_PACKED;
 119
 120 struct lttng_kernel_event_callsite_uprobe {
 121         uint64_t offset;
 122 } LTTNG_PACKED;
 123
 124 struct lttng_kernel_event_callsite {
 125         union {
 126                 struct lttng_kernel_event_callsite_uprobe uprobe;
 127         } u;
 128 } LTTNG_PACKED;
 129
 130 /* Function tracer */
 131 struct lttng_kernel_function {
 132         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 133 } LTTNG_PACKED;
 134
 135 #define LTTNG_KERNEL_EVENT_PADDING1    16
 136 #define LTTNG_KERNEL_EVENT_PADDING2    LTTNG_KERNEL_SYM_NAME_LEN + 32
 137 struct lttng_kernel_event {
 138         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 139         enum lttng_kernel_instrumentation instrumentation;
 140         char padding[LTTNG_KERNEL_EVENT_PADDING1];
 141
 142         /* Per instrumentation type configuration */
 143         union {
 144                 struct lttng_kernel_kretprobe kretprobe;
 145                 struct lttng_kernel_kprobe kprobe;
 146                 struct lttng_kernel_uprobe uprobe;
 147                 struct lttng_kernel_function ftrace;
 148                 char padding[LTTNG_KERNEL_EVENT_PADDING2];
 149         } u;
 150 } LTTNG_PACKED;
 151
 152 struct lttng_kernel_tracer_version {
 153         uint32_t major;
 154         uint32_t minor;
 155         uint32_t patchlevel;
 156 } LTTNG_PACKED;
 157
 158 struct lttng_kernel_tracer_abi_version {
 159         uint32_t major;
 160         uint32_t minor;
 161 } LTTNG_PACKED;
 162
 163 struct lttng_kernel_syscall_mask {
 164         uint32_t len;   /* in bits */
 165         char mask[];
 166 } LTTNG_PACKED;
 167
 168 /*
 169  * kernel channel
 170  */
 171 #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
 172 struct lttng_kernel_channel {
 173         uint64_t subbuf_size;               /* bytes */
 174         uint64_t num_subbuf;                /* power of 2 */
 175         unsigned int switch_timer_interval; /* usec */
 176         unsigned int read_timer_interval;   /* usec */
 177         enum lttng_event_output output;     /* splice, mmap */
 178
 179         int overwrite;                      /* 1: overwrite, 0: discard */
 180         char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
 181 } LTTNG_PACKED;
 182
 183 #define KERNEL_FILTER_BYTECODE_MAX_LEN          65536
 184 struct lttng_kernel_filter_bytecode {
 185         uint32_t len;
 186         uint32_t reloc_offset;
 187         uint64_t seqnum;
 188         char data[0];
 189 } LTTNG_PACKED;
 190
 191 /*
 192  * kernel session name
 193  */
 194 struct lttng_kernel_session_name {
 195         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 196 } LTTNG_PACKED;
 197
 198 /*
 199  * kernel session creation datetime
 200  */
 201 struct lttng_kernel_session_creation_time {
 202         char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 203 } LTTNG_PACKED;
 204
 205 enum lttng_kernel_tracker_type {
 206         LTTNG_KERNEL_TRACKER_UNKNOWN            = -1,
 207
 208         LTTNG_KERNEL_TRACKER_PID                = 0,
 209         LTTNG_KERNEL_TRACKER_VPID               = 1,
 210         LTTNG_KERNEL_TRACKER_UID                = 2,
 211         LTTNG_KERNEL_TRACKER_VUID               = 3,
 212         LTTNG_KERNEL_TRACKER_GID                = 4,
 213         LTTNG_KERNEL_TRACKER_VGID               = 5,
 214 };
 215
 216 struct lttng_kernel_tracker_args {
 217         enum lttng_kernel_tracker_type type;
 218         int32_t id;
 219 };
 220
 221 #endif /* _LTTNG_KERNEL_H */