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 };
  69
  70 /* Perf counter attributes */
  71 struct lttng_kernel_perf_counter_ctx {
  72         uint32_t type;
  73         uint64_t config;
  74         char name[LTTNG_KERNEL_SYM_NAME_LEN];
  75 } LTTNG_PACKED;
  76
  77 /* Event/Channel context */
  78 #define LTTNG_KERNEL_CONTEXT_PADDING1  16
  79 #define LTTNG_KERNEL_CONTEXT_PADDING2  LTTNG_KERNEL_SYM_NAME_LEN + 32
  80 struct lttng_kernel_context {
  81         enum lttng_kernel_context_type ctx;
  82         char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
  83
  84         union {
  85                 struct lttng_kernel_perf_counter_ctx perf_counter;
  86                 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
  87         } u;
  88 } LTTNG_PACKED;
  89
  90 struct lttng_kernel_kretprobe {
  91         uint64_t addr;
  92
  93         uint64_t offset;
  94         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  95 } LTTNG_PACKED;
  96
  97 /*
  98  * Either addr is used, or symbol_name and offset.
  99  */
 100 struct lttng_kernel_kprobe {
 101         uint64_t addr;
 102
 103         uint64_t offset;
 104         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 105 } LTTNG_PACKED;
 106
 107 struct lttng_kernel_uprobe {
 108         int fd;
 109 } LTTNG_PACKED;
 110
 111 struct lttng_kernel_event_callsite_uprobe {
 112         uint64_t offset;
 113 } LTTNG_PACKED;
 114
 115 struct lttng_kernel_event_callsite {
 116         union {
 117                 struct lttng_kernel_event_callsite_uprobe uprobe;
 118         } u;
 119 } LTTNG_PACKED;
 120
 121 /* Function tracer */
 122 struct lttng_kernel_function {
 123         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 124 } LTTNG_PACKED;
 125
 126 #define LTTNG_KERNEL_EVENT_PADDING1    16
 127 #define LTTNG_KERNEL_EVENT_PADDING2    LTTNG_KERNEL_SYM_NAME_LEN + 32
 128 struct lttng_kernel_event {
 129         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 130         enum lttng_kernel_instrumentation instrumentation;
 131         char padding[LTTNG_KERNEL_EVENT_PADDING1];
 132
 133         /* Per instrumentation type configuration */
 134         union {
 135                 struct lttng_kernel_kretprobe kretprobe;
 136                 struct lttng_kernel_kprobe kprobe;
 137                 struct lttng_kernel_uprobe uprobe;
 138                 struct lttng_kernel_function ftrace;
 139                 char padding[LTTNG_KERNEL_EVENT_PADDING2];
 140         } u;
 141 } LTTNG_PACKED;
 142
 143 struct lttng_kernel_tracer_version {
 144         uint32_t major;
 145         uint32_t minor;
 146         uint32_t patchlevel;
 147 } LTTNG_PACKED;
 148
 149 struct lttng_kernel_tracer_abi_version {
 150         uint32_t major;
 151         uint32_t minor;
 152 } LTTNG_PACKED;
 153
 154 struct lttng_kernel_syscall_mask {
 155         uint32_t len;   /* in bits */
 156         char mask[];
 157 } LTTNG_PACKED;
 158
 159 /*
 160  * kernel channel
 161  */
 162 #define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
 163 struct lttng_kernel_channel {
 164         uint64_t subbuf_size;               /* bytes */
 165         uint64_t num_subbuf;                /* power of 2 */
 166         unsigned int switch_timer_interval; /* usec */
 167         unsigned int read_timer_interval;   /* usec */
 168         enum lttng_event_output output;     /* splice, mmap */
 169
 170         int overwrite;                      /* 1: overwrite, 0: discard */
 171         char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
 172 } LTTNG_PACKED;
 173
 174 #define KERNEL_FILTER_BYTECODE_MAX_LEN          65536
 175 struct lttng_kernel_filter_bytecode {
 176         uint32_t len;
 177         uint32_t reloc_offset;
 178         uint64_t seqnum;
 179         char data[0];
 180 } LTTNG_PACKED;
 181
 182 /*
 183  * kernel session name
 184  */
 185 struct lttng_kernel_session_name {
 186         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 187 } LTTNG_PACKED;
 188
 189 #endif /* _LTTNG_KERNEL_H */