lttng-abi.h

   1 #ifndef _LTTNG_ABI_H
   2 #define _LTTNG_ABI_H
   3
   4 /*
   5  * lttng-abi.h
   6  *
   7  * LTTng ABI header
   8  *
   9  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; only
  14  * version 2.1 of the License.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  24  */
  25
  26 #include <linux/fs.h>
  27
  28 /*
  29  * Major/minor version of ABI exposed to lttng tools. Major number
  30  * should be increased when an incompatible ABI change is done.
  31  */
  32 #define LTTNG_MODULES_ABI_MAJOR_VERSION         2
  33 #define LTTNG_MODULES_ABI_MINOR_VERSION         0
  34
  35 #define LTTNG_KERNEL_SYM_NAME_LEN       256
  36
  37 enum lttng_kernel_instrumentation {
  38         LTTNG_KERNEL_TRACEPOINT = 0,
  39         LTTNG_KERNEL_KPROBE     = 1,
  40         LTTNG_KERNEL_FUNCTION   = 2,
  41         LTTNG_KERNEL_KRETPROBE  = 3,
  42         LTTNG_KERNEL_NOOP       = 4,    /* not hooked */
  43         LTTNG_KERNEL_SYSCALL    = 5,
  44 };
  45
  46 /*
  47  * LTTng consumer mode
  48  */
  49 enum lttng_kernel_output {
  50         LTTNG_KERNEL_SPLICE     = 0,
  51         LTTNG_KERNEL_MMAP       = 1,
  52 };
  53
  54 /*
  55  * LTTng DebugFS ABI structures.
  56  */
  57 #define LTTNG_KERNEL_CHANNEL_PADDING    LTTNG_KERNEL_SYM_NAME_LEN + 32
  58 struct lttng_kernel_channel {
  59         uint64_t subbuf_size;                   /* in bytes */
  60         uint64_t num_subbuf;
  61         unsigned int switch_timer_interval;     /* usecs */
  62         unsigned int read_timer_interval;       /* usecs */
  63         enum lttng_kernel_output output;        /* splice, mmap */
  64         int overwrite;                          /* 1: overwrite, 0: discard */
  65         char padding[LTTNG_KERNEL_CHANNEL_PADDING];
  66 } __attribute__((packed));
  67
  68 struct lttng_kernel_kretprobe {
  69         uint64_t addr;
  70
  71         uint64_t offset;
  72         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  73 } __attribute__((packed));
  74
  75 /*
  76  * Either addr is used, or symbol_name and offset.
  77  */
  78 struct lttng_kernel_kprobe {
  79         uint64_t addr;
  80
  81         uint64_t offset;
  82         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  83 } __attribute__((packed));
  84
  85 struct lttng_kernel_function_tracer {
  86         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  87 } __attribute__((packed));
  88
  89 struct lttng_kernel_syscall {
  90         char enable;
  91 } __attribute__((packed));
  92
  93 /*
  94  * For syscall tracing, name = "*" means "enable all".
  95  */
  96 #define LTTNG_KERNEL_EVENT_PADDING1     16
  97 #define LTTNG_KERNEL_EVENT_PADDING2     LTTNG_KERNEL_SYM_NAME_LEN + 32
  98 struct lttng_kernel_event {
  99         char name[LTTNG_KERNEL_SYM_NAME_LEN];   /* event name */
 100         enum lttng_kernel_instrumentation instrumentation;
 101         char padding[LTTNG_KERNEL_EVENT_PADDING1];
 102
 103         /* Per instrumentation type configuration */
 104         union {
 105                 struct lttng_kernel_kretprobe kretprobe;
 106                 struct lttng_kernel_kprobe kprobe;
 107                 struct lttng_kernel_function_tracer ftrace;
 108                 struct lttng_kernel_syscall syscall;
 109                 char padding[LTTNG_KERNEL_EVENT_PADDING2];
 110         } u;
 111 } __attribute__((packed));
 112
 113 struct lttng_kernel_tracer_version {
 114         uint32_t major;
 115         uint32_t minor;
 116         uint32_t patchlevel;
 117 } __attribute__((packed));
 118
 119 struct lttng_kernel_tracer_abi_version {
 120         uint32_t major;
 121         uint32_t minor;
 122 } __attribute__((packed));
 123
 124 enum lttng_kernel_calibrate_type {
 125         LTTNG_KERNEL_CALIBRATE_KRETPROBE,
 126 };
 127
 128 struct lttng_kernel_calibrate {
 129         enum lttng_kernel_calibrate_type type;  /* type (input) */
 130 } __attribute__((packed));
 131
 132 struct lttng_kernel_syscall_mask {
 133         uint32_t len;   /* in bits */
 134         char mask[];
 135 } __attribute__((packed));
 136
 137 enum lttng_kernel_context_type {
 138         LTTNG_KERNEL_CONTEXT_PID                = 0,
 139         LTTNG_KERNEL_CONTEXT_PERF_COUNTER       = 1,
 140         LTTNG_KERNEL_CONTEXT_PROCNAME           = 2,
 141         LTTNG_KERNEL_CONTEXT_PRIO               = 3,
 142         LTTNG_KERNEL_CONTEXT_NICE               = 4,
 143         LTTNG_KERNEL_CONTEXT_VPID               = 5,
 144         LTTNG_KERNEL_CONTEXT_TID                = 6,
 145         LTTNG_KERNEL_CONTEXT_VTID               = 7,
 146         LTTNG_KERNEL_CONTEXT_PPID               = 8,
 147         LTTNG_KERNEL_CONTEXT_VPPID              = 9,
 148         LTTNG_KERNEL_CONTEXT_HOSTNAME           = 10,
 149 };
 150
 151 struct lttng_kernel_perf_counter_ctx {
 152         uint32_t type;
 153         uint64_t config;
 154         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 155 } __attribute__((packed));
 156
 157 #define LTTNG_KERNEL_CONTEXT_PADDING1   16
 158 #define LTTNG_KERNEL_CONTEXT_PADDING2   LTTNG_KERNEL_SYM_NAME_LEN + 32
 159 struct lttng_kernel_context {
 160         enum lttng_kernel_context_type ctx;
 161         char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
 162
 163         union {
 164                 struct lttng_kernel_perf_counter_ctx perf_counter;
 165                 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
 166         } u;
 167 } __attribute__((packed));
 168
 169 /* LTTng file descriptor ioctl */
 170 #define LTTNG_KERNEL_SESSION                    _IO(0xF6, 0x45)
 171 #define LTTNG_KERNEL_TRACER_VERSION             \
 172         _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
 173 #define LTTNG_KERNEL_TRACEPOINT_LIST            _IO(0xF6, 0x47)
 174 #define LTTNG_KERNEL_WAIT_QUIESCENT             _IO(0xF6, 0x48)
 175 #define LTTNG_KERNEL_CALIBRATE                  \
 176         _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
 177 #define LTTNG_KERNEL_SYSCALL_LIST               _IO(0xF6, 0x4A)
 178 #define LTTNG_KERNEL_TRACER_ABI_VERSION         \
 179         _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
 180
 181 /* Session FD ioctl */
 182 #define LTTNG_KERNEL_METADATA                   \
 183         _IOW(0xF6, 0x54, struct lttng_kernel_channel)
 184 #define LTTNG_KERNEL_CHANNEL                    \
 185         _IOW(0xF6, 0x55, struct lttng_kernel_channel)
 186 #define LTTNG_KERNEL_SESSION_START              _IO(0xF6, 0x56)
 187 #define LTTNG_KERNEL_SESSION_STOP               _IO(0xF6, 0x57)
 188 #define LTTNG_KERNEL_SESSION_TRACK_PID          \
 189         _IOR(0xF6, 0x58, int32_t)
 190 #define LTTNG_KERNEL_SESSION_UNTRACK_PID        \
 191         _IOR(0xF6, 0x59, int32_t)
 192 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS  _IO(0xF6, 0x58)
 193
 194 /* Channel FD ioctl */
 195 #define LTTNG_KERNEL_STREAM                     _IO(0xF6, 0x62)
 196 #define LTTNG_KERNEL_EVENT                      \
 197         _IOW(0xF6, 0x63, struct lttng_kernel_event)
 198 #define LTTNG_KERNEL_SYSCALL_MASK               \
 199         _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
 200
 201 /* Event and Channel FD ioctl */
 202 #define LTTNG_KERNEL_CONTEXT                    \
 203         _IOW(0xF6, 0x71, struct lttng_kernel_context)
 204
 205 /* Event, Channel and Session ioctl */
 206 #define LTTNG_KERNEL_ENABLE                     _IO(0xF6, 0x82)
 207 #define LTTNG_KERNEL_DISABLE                    _IO(0xF6, 0x83)
 208
 209 /* LTTng-specific ioctls for the lib ringbuffer */
 210 /* returns the timestamp begin of the current sub-buffer */
 211 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN   _IOR(0xF6, 0x20, uint64_t)
 212 /* returns the timestamp end of the current sub-buffer */
 213 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END     _IOR(0xF6, 0x21, uint64_t)
 214 /* returns the number of events discarded */
 215 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED  _IOR(0xF6, 0x22, uint64_t)
 216 /* returns the packet payload size */
 217 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE      _IOR(0xF6, 0x23, uint64_t)
 218 /* returns the actual packet size */
 219 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE       _IOR(0xF6, 0x24, uint64_t)
 220 /* returns the stream id */
 221 #define LTTNG_RING_BUFFER_GET_STREAM_ID         _IOR(0xF6, 0x25, uint64_t)
 222 /* returns the current timestamp */
 223 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
 224
 225 #ifdef CONFIG_COMPAT
 226 /* returns the timestamp begin of the current sub-buffer */
 227 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
 228         LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
 229 /* returns the timestamp end of the current sub-buffer */
 230 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
 231         LTTNG_RING_BUFFER_GET_TIMESTAMP_END
 232 /* returns the number of events discarded */
 233 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
 234         LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
 235 /* returns the packet payload size */
 236 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
 237         LTTNG_RING_BUFFER_GET_CONTENT_SIZE
 238 /* returns the actual packet size */
 239 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
 240         LTTNG_RING_BUFFER_GET_PACKET_SIZE
 241 /* returns the stream id */
 242 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
 243         LTTNG_RING_BUFFER_GET_STREAM_ID
 244 /* returns the current timestamp */
 245 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
 246         LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
 247 #endif /* CONFIG_COMPAT */
 248
 249 #endif /* _LTTNG_ABI_H */