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