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