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