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