src/common/lttng-kernel.h

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