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 #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN  26
  32
  33 /*
  34  * LTTng DebugFS ABI structures.
  35  *
  36  * This is the kernel ABI copied from lttng-modules tree.
  37  */
  38
  39 enum lttng_kernel_instrumentation {
  40         LTTNG_KERNEL_ALL           = -1,   /* Used within lttng-tools */
  41         LTTNG_KERNEL_TRACEPOINT    = 0,
  42         LTTNG_KERNEL_KPROBE        = 1,
  43         LTTNG_KERNEL_FUNCTION      = 2,
  44         LTTNG_KERNEL_KRETPROBE     = 3,
  45         LTTNG_KERNEL_NOOP          = 4,    /* not hooked */
  46         LTTNG_KERNEL_SYSCALL       = 5,
  47         LTTNG_KERNEL_UPROBE        = 6,
  48 };
  49
  50 enum lttng_kernel_context_type {
  51         LTTNG_KERNEL_CONTEXT_PID            = 0,
  52         LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER = 1,
  53         LTTNG_KERNEL_CONTEXT_PROCNAME       = 2,
  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,
  61         LTTNG_KERNEL_CONTEXT_HOSTNAME       = 10,
  62         LTTNG_KERNEL_CONTEXT_CPU_ID         = 11,
  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,
  67         LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
  68         LTTNG_KERNEL_CONTEXT_CALLSTACK_USER   = 17,
  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,
  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,
  88 };
  89
  90 /* Perf counter attributes */
  91 struct lttng_kernel_perf_counter_ctx {
  92         uint32_t type;
  93         uint64_t config;
  94         char name[LTTNG_KERNEL_SYM_NAME_LEN];
  95 } LTTNG_PACKED;
  96
  97 /* Event/Channel context */
  98 #define LTTNG_KERNEL_CONTEXT_PADDING1  16
  99 #define LTTNG_KERNEL_CONTEXT_PADDING2  LTTNG_KERNEL_SYM_NAME_LEN + 32
 100 struct lttng_kernel_context {
 101         enum lttng_kernel_context_type ctx;
 102         char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
 103
 104         union {
 105                 struct lttng_kernel_perf_counter_ctx perf_counter;
 106                 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
 107         } u;
 108 } LTTNG_PACKED;
 109
 110 struct lttng_kernel_kretprobe {
 111         uint64_t addr;
 112
 113         uint64_t offset;
 114         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 115 } LTTNG_PACKED;
 116
 117 /*
 118  * Either addr is used, or symbol_name and offset.
 119  */
 120 struct lttng_kernel_kprobe {
 121         uint64_t addr;
 122
 123         uint64_t offset;
 124         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 125 } LTTNG_PACKED;
 126
 127 struct lttng_kernel_uprobe {
 128         int fd;
 129 } LTTNG_PACKED;
 130
 131 struct lttng_kernel_event_callsite_uprobe {
 132         uint64_t offset;
 133 } LTTNG_PACKED;
 134
 135 struct lttng_kernel_event_callsite {
 136         union {
 137                 struct lttng_kernel_event_callsite_uprobe uprobe;
 138         } u;
 139 } LTTNG_PACKED;
 140
 141 /* Function tracer */
 142 struct lttng_kernel_function {
 143         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 144 } LTTNG_PACKED;
 145
 146 #define LTTNG_KERNEL_EVENT_PADDING1    16
 147 #define LTTNG_KERNEL_EVENT_PADDING2    LTTNG_KERNEL_SYM_NAME_LEN + 32
 148 struct lttng_kernel_event {
 149         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 150         enum lttng_kernel_instrumentation instrumentation;
 151         char padding[LTTNG_KERNEL_EVENT_PADDING1];
 152
 153         /* Per instrumentation type configuration */
 154         union {
 155                 struct lttng_kernel_kretprobe kretprobe;
 156                 struct lttng_kernel_kprobe kprobe;
 157                 struct lttng_kernel_uprobe uprobe;
 158                 struct lttng_kernel_function ftrace;
 159                 char padding[LTTNG_KERNEL_EVENT_PADDING2];
 160         } u;
 161 } LTTNG_PACKED;
 162
 163 struct lttng_kernel_tracer_version {
 164         uint32_t major;
 165         uint32_t minor;
 166         uint32_t patchlevel;
 167 } LTTNG_PACKED;
 168
 169 struct lttng_kernel_tracer_abi_version {
 170         uint32_t major;
 171         uint32_t minor;
 172 } LTTNG_PACKED;
 173
 174 struct lttng_kernel_syscall_mask {
 175         uint32_t len;   /* in bits */
 176         char mask[];
 177 } LTTNG_PACKED;
 178
 179 /*
 180  * kernel channel
 181  */
 182 #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
 183 struct 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];
 192 } LTTNG_PACKED;
 193
 194 #define KERNEL_FILTER_BYTECODE_MAX_LEN          65536
 195 struct 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
 202 /*
 203  * kernel session name
 204  */
 205 struct lttng_kernel_session_name {
 206         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 207 } LTTNG_PACKED;
 208
 209 /*
 210  * kernel session creation datetime
 211  */
 212 struct lttng_kernel_session_creation_time {
 213         char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 214 } LTTNG_PACKED;
 215
 216 #endif /* _LTTNG_KERNEL_H */