lttng-abi.h

   1 /* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1)
   2  *
   3  * lttng-abi.h
   4  *
   5  * LTTng ABI header
   6  *
   7  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  */
   9
  10 #ifndef _LTTNG_ABI_H
  11 #define _LTTNG_ABI_H
  12
  13 #include <linux/fs.h>
  14
  15 /*
  16  * Major/minor version of ABI exposed to lttng tools. Major number
  17  * should be increased when an incompatible ABI change is done.
  18  */
  19 #define LTTNG_MODULES_ABI_MAJOR_VERSION         2
  20 #define LTTNG_MODULES_ABI_MINOR_VERSION         4
  21
  22 #define LTTNG_KERNEL_SYM_NAME_LEN       256
  23 #define LTTNG_KERNEL_SESSION_NAME_LEN   256
  24 #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN  26
  25
  26 enum lttng_kernel_instrumentation {
  27         LTTNG_KERNEL_TRACEPOINT = 0,
  28         LTTNG_KERNEL_KPROBE     = 1,
  29         LTTNG_KERNEL_FUNCTION   = 2,
  30         LTTNG_KERNEL_KRETPROBE  = 3,
  31         LTTNG_KERNEL_NOOP       = 4,    /* not hooked */
  32         LTTNG_KERNEL_SYSCALL    = 5,
  33         LTTNG_KERNEL_UPROBE     = 6,
  34 };
  35
  36 /*
  37  * LTTng consumer mode
  38  */
  39 enum lttng_kernel_output {
  40         LTTNG_KERNEL_SPLICE     = 0,
  41         LTTNG_KERNEL_MMAP       = 1,
  42 };
  43
  44 /*
  45  * LTTng DebugFS ABI structures.
  46  */
  47 #define LTTNG_KERNEL_CHANNEL_PADDING    LTTNG_KERNEL_SYM_NAME_LEN + 32
  48 struct lttng_kernel_channel {
  49         uint64_t subbuf_size;                   /* in bytes */
  50         uint64_t num_subbuf;
  51         unsigned int switch_timer_interval;     /* usecs */
  52         unsigned int read_timer_interval;       /* usecs */
  53         enum lttng_kernel_output output;        /* splice, mmap */
  54         int overwrite;                          /* 1: overwrite, 0: discard */
  55         char padding[LTTNG_KERNEL_CHANNEL_PADDING];
  56 } __attribute__((packed));
  57
  58 struct lttng_kernel_kretprobe {
  59         uint64_t addr;
  60
  61         uint64_t offset;
  62         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  63 } __attribute__((packed));
  64
  65 /*
  66  * Either addr is used, or symbol_name and offset.
  67  */
  68 struct lttng_kernel_kprobe {
  69         uint64_t addr;
  70
  71         uint64_t offset;
  72         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  73 } __attribute__((packed));
  74
  75 struct lttng_kernel_function_tracer {
  76         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  77 } __attribute__((packed));
  78
  79 struct lttng_kernel_uprobe {
  80         int fd;
  81 } __attribute__((packed));
  82
  83 struct lttng_kernel_event_callsite_uprobe {
  84         uint64_t offset;
  85 } __attribute__((packed));
  86
  87 struct lttng_kernel_event_callsite {
  88         union {
  89                 struct lttng_kernel_event_callsite_uprobe uprobe;
  90         } u;
  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_uprobe uprobe;
 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 struct lttng_kernel_session_name {
 125         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 126 } __attribute__((packed));
 127
 128 struct lttng_kernel_session_creation_time {
 129         char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 130 } __attribute__((packed));
 131
 132 enum lttng_kernel_calibrate_type {
 133         LTTNG_KERNEL_CALIBRATE_KRETPROBE,
 134 };
 135
 136 struct lttng_kernel_calibrate {
 137         enum lttng_kernel_calibrate_type type;  /* type (input) */
 138 } __attribute__((packed));
 139
 140 struct lttng_kernel_syscall_mask {
 141         uint32_t len;   /* in bits */
 142         char mask[];
 143 } __attribute__((packed));
 144
 145 enum lttng_kernel_context_type {
 146         LTTNG_KERNEL_CONTEXT_PID                = 0,
 147         LTTNG_KERNEL_CONTEXT_PERF_COUNTER       = 1,
 148         LTTNG_KERNEL_CONTEXT_PROCNAME           = 2,
 149         LTTNG_KERNEL_CONTEXT_PRIO               = 3,
 150         LTTNG_KERNEL_CONTEXT_NICE               = 4,
 151         LTTNG_KERNEL_CONTEXT_VPID               = 5,
 152         LTTNG_KERNEL_CONTEXT_TID                = 6,
 153         LTTNG_KERNEL_CONTEXT_VTID               = 7,
 154         LTTNG_KERNEL_CONTEXT_PPID               = 8,
 155         LTTNG_KERNEL_CONTEXT_VPPID              = 9,
 156         LTTNG_KERNEL_CONTEXT_HOSTNAME           = 10,
 157         LTTNG_KERNEL_CONTEXT_CPU_ID             = 11,
 158         LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE      = 12,
 159         LTTNG_KERNEL_CONTEXT_PREEMPTIBLE        = 13,
 160         LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE    = 14,
 161         LTTNG_KERNEL_CONTEXT_MIGRATABLE         = 15,
 162         LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL   = 16,
 163         LTTNG_KERNEL_CONTEXT_CALLSTACK_USER     = 17,
 164 };
 165
 166 struct lttng_kernel_perf_counter_ctx {
 167         uint32_t type;
 168         uint64_t config;
 169         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 170 } __attribute__((packed));
 171
 172 #define LTTNG_KERNEL_CONTEXT_PADDING1   16
 173 #define LTTNG_KERNEL_CONTEXT_PADDING2   LTTNG_KERNEL_SYM_NAME_LEN + 32
 174 struct lttng_kernel_context {
 175         enum lttng_kernel_context_type ctx;
 176         char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
 177
 178         union {
 179                 struct lttng_kernel_perf_counter_ctx perf_counter;
 180                 char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
 181         } u;
 182 } __attribute__((packed));
 183
 184 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN            65536
 185 struct lttng_kernel_filter_bytecode {
 186         uint32_t len;
 187         uint32_t reloc_offset;
 188         uint64_t seqnum;
 189         char data[0];
 190 } __attribute__((packed));
 191
 192 /* LTTng file descriptor ioctl */
 193 #define LTTNG_KERNEL_SESSION                    _IO(0xF6, 0x45)
 194 #define LTTNG_KERNEL_TRACER_VERSION             \
 195         _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
 196 #define LTTNG_KERNEL_TRACEPOINT_LIST            _IO(0xF6, 0x47)
 197 #define LTTNG_KERNEL_WAIT_QUIESCENT             _IO(0xF6, 0x48)
 198 #define LTTNG_KERNEL_CALIBRATE                  \
 199         _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
 200 #define LTTNG_KERNEL_SYSCALL_LIST               _IO(0xF6, 0x4A)
 201 #define LTTNG_KERNEL_TRACER_ABI_VERSION         \
 202         _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
 203
 204 /* Session FD ioctl */
 205 #define LTTNG_KERNEL_METADATA                   \
 206         _IOW(0xF6, 0x54, struct lttng_kernel_channel)
 207 #define LTTNG_KERNEL_CHANNEL                    \
 208         _IOW(0xF6, 0x55, struct lttng_kernel_channel)
 209 #define LTTNG_KERNEL_SESSION_START              _IO(0xF6, 0x56)
 210 #define LTTNG_KERNEL_SESSION_STOP               _IO(0xF6, 0x57)
 211 #define LTTNG_KERNEL_SESSION_TRACK_PID          \
 212         _IOR(0xF6, 0x58, int32_t)
 213 #define LTTNG_KERNEL_SESSION_UNTRACK_PID        \
 214         _IOR(0xF6, 0x59, int32_t)
 215 /*
 216  * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
 217  * are generating two different ioctl numbers, but this was not done on
 218  * purpose. We should generally try to avoid those duplications.
 219  */
 220 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS  _IO(0xF6, 0x58)
 221 #define LTTNG_KERNEL_SESSION_METADATA_REGEN     _IO(0xF6, 0x59)
 222
 223 /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
 224 #define LTTNG_KERNEL_SESSION_STATEDUMP          _IO(0xF6, 0x5C)
 225 #define LTTNG_KERNEL_SESSION_SET_NAME           \
 226         _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
 227 #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME          \
 228         _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
 229
 230 /* Channel FD ioctl */
 231 #define LTTNG_KERNEL_STREAM                     _IO(0xF6, 0x62)
 232 #define LTTNG_KERNEL_EVENT                      \
 233         _IOW(0xF6, 0x63, struct lttng_kernel_event)
 234 #define LTTNG_KERNEL_SYSCALL_MASK               \
 235         _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
 236
 237 /* Event and Channel FD ioctl */
 238 #define LTTNG_KERNEL_CONTEXT                    \
 239         _IOW(0xF6, 0x71, struct lttng_kernel_context)
 240
 241 /* Event, Channel and Session ioctl */
 242 #define LTTNG_KERNEL_ENABLE                     _IO(0xF6, 0x82)
 243 #define LTTNG_KERNEL_DISABLE                    _IO(0xF6, 0x83)
 244
 245 /* Event FD ioctl */
 246 #define LTTNG_KERNEL_FILTER                     _IO(0xF6, 0x90)
 247 #define LTTNG_KERNEL_ADD_CALLSITE               _IO(0xF6, 0x91)
 248
 249 /*
 250  * LTTng-specific ioctls for the lib ringbuffer.
 251  *
 252  * Operations applying to the current sub-buffer need to occur between
 253  * a get/put or get_next/put_next ioctl pair.
 254  */
 255
 256 /* returns the timestamp begin of the current sub-buffer */
 257 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN   _IOR(0xF6, 0x20, uint64_t)
 258 /* returns the timestamp end of the current sub-buffer */
 259 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END     _IOR(0xF6, 0x21, uint64_t)
 260 /* returns the number of events discarded of the current sub-buffer */
 261 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED  _IOR(0xF6, 0x22, uint64_t)
 262 /* returns the packet payload size of the current sub-buffer */
 263 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE      _IOR(0xF6, 0x23, uint64_t)
 264 /* returns the packet size of the current sub-buffer*/
 265 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE       _IOR(0xF6, 0x24, uint64_t)
 266 /* returns the stream id (invariant for the stream) */
 267 #define LTTNG_RING_BUFFER_GET_STREAM_ID         _IOR(0xF6, 0x25, uint64_t)
 268 /* returns the current timestamp as perceived from the tracer */
 269 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
 270 /* returns the packet sequence number of the current sub-buffer */
 271 #define LTTNG_RING_BUFFER_GET_SEQ_NUM           _IOR(0xF6, 0x27, uint64_t)
 272 /* returns the stream instance id (invariant for the stream) */
 273 #define LTTNG_RING_BUFFER_INSTANCE_ID           _IOR(0xF6, 0x28, uint64_t)
 274
 275 #ifdef CONFIG_COMPAT
 276 /* returns the timestamp begin of the current sub-buffer */
 277 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
 278         LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
 279 /* returns the timestamp end of the current sub-buffer */
 280 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
 281         LTTNG_RING_BUFFER_GET_TIMESTAMP_END
 282 /* returns the number of events discarded of the current sub-buffer */
 283 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
 284         LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
 285 /* returns the packet payload size of the current sub-buffer */
 286 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
 287         LTTNG_RING_BUFFER_GET_CONTENT_SIZE
 288 /* returns the packet size of the current sub-buffer */
 289 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
 290         LTTNG_RING_BUFFER_GET_PACKET_SIZE
 291 /* returns the stream id (invariant for the stream) */
 292 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
 293         LTTNG_RING_BUFFER_GET_STREAM_ID
 294 /* returns the current timestamp as perceived from the tracer */
 295 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
 296         LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
 297 /* returns the packet sequence number of the current sub-buffer */
 298 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM    \
 299         LTTNG_RING_BUFFER_GET_SEQ_NUM
 300 /* returns the stream instance id (invariant for the stream) */
 301 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID    \
 302         LTTNG_RING_BUFFER_INSTANCE_ID
 303 #endif /* CONFIG_COMPAT */
 304
 305 #endif /* _LTTNG_ABI_H */