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         2
  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 /*
  90  * For syscall tracing, name = "*" means "enable all".
  91  */
  92 #define LTTNG_KERNEL_EVENT_PADDING1     16
  93 #define LTTNG_KERNEL_EVENT_PADDING2     LTTNG_KERNEL_SYM_NAME_LEN + 32
  94 struct lttng_kernel_event {
  95         char name[LTTNG_KERNEL_SYM_NAME_LEN];   /* event name */
  96         enum lttng_kernel_instrumentation instrumentation;
  97         char padding[LTTNG_KERNEL_EVENT_PADDING1];
  98
  99         /* Per instrumentation type configuration */
 100         union {
 101                 struct lttng_kernel_kretprobe kretprobe;
 102                 struct lttng_kernel_kprobe kprobe;
 103                 struct lttng_kernel_function_tracer ftrace;
 104                 char padding[LTTNG_KERNEL_EVENT_PADDING2];
 105         } u;
 106 } __attribute__((packed));
 107
 108 struct lttng_kernel_tracer_version {
 109         uint32_t major;
 110         uint32_t minor;
 111         uint32_t patchlevel;
 112 } __attribute__((packed));
 113
 114 struct lttng_kernel_tracer_abi_version {
 115         uint32_t major;
 116         uint32_t minor;
 117 } __attribute__((packed));
 118
 119 enum lttng_kernel_calibrate_type {
 120         LTTNG_KERNEL_CALIBRATE_KRETPROBE,
 121 };
 122
 123 struct lttng_kernel_calibrate {
 124         enum lttng_kernel_calibrate_type type;  /* type (input) */
 125 } __attribute__((packed));
 126
 127 struct lttng_kernel_syscall_mask {
 128         uint32_t len;   /* in bits */
 129         char mask[];
 130 } __attribute__((packed));
 131
 132 enum lttng_kernel_context_type {
 133         LTTNG_KERNEL_CONTEXT_PID                = 0,
 134         LTTNG_KERNEL_CONTEXT_PERF_COUNTER       = 1,
 135         LTTNG_KERNEL_CONTEXT_PROCNAME           = 2,
 136         LTTNG_KERNEL_CONTEXT_PRIO               = 3,
 137         LTTNG_KERNEL_CONTEXT_NICE               = 4,
 138         LTTNG_KERNEL_CONTEXT_VPID               = 5,
 139         LTTNG_KERNEL_CONTEXT_TID                = 6,
 140         LTTNG_KERNEL_CONTEXT_VTID               = 7,
 141         LTTNG_KERNEL_CONTEXT_PPID               = 8,
 142         LTTNG_KERNEL_CONTEXT_VPPID              = 9,
 143         LTTNG_KERNEL_CONTEXT_HOSTNAME           = 10,
 144         LTTNG_KERNEL_CONTEXT_CPU_ID             = 11,
 145         LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE      = 12,
 146         LTTNG_KERNEL_CONTEXT_PREEMPTIBLE        = 13,
 147         LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE    = 14,
 148         LTTNG_KERNEL_CONTEXT_MIGRATABLE         = 15,
 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 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN            65536
 170 struct lttng_kernel_filter_bytecode {
 171         uint32_t len;
 172         uint32_t reloc_offset;
 173         uint64_t seqnum;
 174         char data[0];
 175 } __attribute__((packed));
 176
 177 enum lttng_kernel_tracker_type {
 178         LTTNG_KERNEL_TRACKER_UNKNOWN            = -1,
 179
 180         LTTNG_KERNEL_TRACKER_PID                = 0,
 181         LTTNG_KERNEL_TRACKER_VPID               = 1,
 182         LTTNG_KERNEL_TRACKER_UID                = 2,
 183         LTTNG_KERNEL_TRACKER_VUID               = 3,
 184         LTTNG_KERNEL_TRACKER_GID                = 4,
 185         LTTNG_KERNEL_TRACKER_VGID               = 5,
 186 };
 187
 188 struct lttng_kernel_tracker_args {
 189         enum lttng_kernel_tracker_type type;
 190         int32_t id;
 191 };
 192
 193 /* LTTng file descriptor ioctl */
 194 #define LTTNG_KERNEL_SESSION                    _IO(0xF6, 0x45)
 195 #define LTTNG_KERNEL_TRACER_VERSION             \
 196         _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
 197 #define LTTNG_KERNEL_TRACEPOINT_LIST            _IO(0xF6, 0x47)
 198 #define LTTNG_KERNEL_WAIT_QUIESCENT             _IO(0xF6, 0x48)
 199 #define LTTNG_KERNEL_CALIBRATE                  \
 200         _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
 201 #define LTTNG_KERNEL_SYSCALL_LIST               _IO(0xF6, 0x4A)
 202 #define LTTNG_KERNEL_TRACER_ABI_VERSION         \
 203         _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
 204
 205 /* Session FD ioctl */
 206 #define LTTNG_KERNEL_METADATA                   \
 207         _IOW(0xF6, 0x54, struct lttng_kernel_channel)
 208 #define LTTNG_KERNEL_CHANNEL                    \
 209         _IOW(0xF6, 0x55, struct lttng_kernel_channel)
 210 #define LTTNG_KERNEL_SESSION_START              _IO(0xF6, 0x56)
 211 #define LTTNG_KERNEL_SESSION_STOP               _IO(0xF6, 0x57)
 212 #define LTTNG_KERNEL_SESSION_TRACK_PID          \
 213         _IOR(0xF6, 0x58, int32_t)
 214 #define LTTNG_KERNEL_SESSION_UNTRACK_PID        \
 215         _IOR(0xF6, 0x59, int32_t)
 216
 217 /*
 218  * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
 219  * are generating two different ioctl numbers, but this was not done on
 220  * purpose. We should generally try to avoid those duplications.
 221  */
 222 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS  _IO(0xF6, 0x58)
 223 #define LTTNG_KERNEL_SESSION_METADATA_REGEN     _IO(0xF6, 0x59)
 224 /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
 225 #define LTTNG_KERNEL_SESSION_STATEDUMP          _IO(0xF6, 0x5C)
 226 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS   \
 227         _IOR(0xF6, 0x5D, struct lttng_kernel_tracker_args)
 228 #define LTTNG_KERNEL_SESSION_TRACK_ID           \
 229         _IOR(0xF6, 0x5E, struct lttng_kernel_tracker_args)
 230 #define LTTNG_KERNEL_SESSION_UNTRACK_ID         \
 231         _IOR(0xF6, 0x5F, struct lttng_kernel_tracker_args)
 232
 233 /* Channel FD ioctl */
 234 #define LTTNG_KERNEL_STREAM                     _IO(0xF6, 0x62)
 235 #define LTTNG_KERNEL_EVENT                      \
 236         _IOW(0xF6, 0x63, struct lttng_kernel_event)
 237 #define LTTNG_KERNEL_SYSCALL_MASK               \
 238         _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
 239
 240 /* Event and Channel FD ioctl */
 241 #define LTTNG_KERNEL_CONTEXT                    \
 242         _IOW(0xF6, 0x71, struct lttng_kernel_context)
 243
 244 /* Event, Channel and Session ioctl */
 245 #define LTTNG_KERNEL_ENABLE                     _IO(0xF6, 0x82)
 246 #define LTTNG_KERNEL_DISABLE                    _IO(0xF6, 0x83)
 247
 248 /* Event FD ioctl */
 249 #define LTTNG_KERNEL_FILTER                     _IO(0xF6, 0x90)
 250
 251 /* LTTng-specific ioctls for the lib ringbuffer */
 252 /* returns the timestamp begin of the current sub-buffer */
 253 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN   _IOR(0xF6, 0x20, uint64_t)
 254 /* returns the timestamp end of the current sub-buffer */
 255 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END     _IOR(0xF6, 0x21, uint64_t)
 256 /* returns the number of events discarded */
 257 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED  _IOR(0xF6, 0x22, uint64_t)
 258 /* returns the packet payload size */
 259 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE      _IOR(0xF6, 0x23, uint64_t)
 260 /* returns the actual packet size */
 261 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE       _IOR(0xF6, 0x24, uint64_t)
 262 /* returns the stream id */
 263 #define LTTNG_RING_BUFFER_GET_STREAM_ID         _IOR(0xF6, 0x25, uint64_t)
 264 /* returns the current timestamp */
 265 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
 266 /* returns the packet sequence number */
 267 #define LTTNG_RING_BUFFER_GET_SEQ_NUM           _IOR(0xF6, 0x27, uint64_t)
 268 /* returns the stream instance id */
 269 #define LTTNG_RING_BUFFER_INSTANCE_ID           _IOR(0xF6, 0x28, uint64_t)
 270
 271 #ifdef CONFIG_COMPAT
 272 /* returns the timestamp begin of the current sub-buffer */
 273 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
 274         LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
 275 /* returns the timestamp end of the current sub-buffer */
 276 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
 277         LTTNG_RING_BUFFER_GET_TIMESTAMP_END
 278 /* returns the number of events discarded */
 279 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
 280         LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
 281 /* returns the packet payload size */
 282 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
 283         LTTNG_RING_BUFFER_GET_CONTENT_SIZE
 284 /* returns the actual packet size */
 285 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
 286         LTTNG_RING_BUFFER_GET_PACKET_SIZE
 287 /* returns the stream id */
 288 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
 289         LTTNG_RING_BUFFER_GET_STREAM_ID
 290 /* returns the current timestamp */
 291 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
 292         LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
 293 /* returns the packet sequence number */
 294 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM    \
 295         LTTNG_RING_BUFFER_GET_SEQ_NUM
 296 /* returns the stream instance id */
 297 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID    \
 298         LTTNG_RING_BUFFER_INSTANCE_ID
 299 #endif /* CONFIG_COMPAT */
 300
 301 #endif /* _LTTNG_ABI_H */