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