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