lttng-abi.h

   1 #ifndef _LTTNG_ABI_H
   2 #define _LTTNG_ABI_H
   3
   4 /*
   5  * lttng-abi.h
   6  *
   7  * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * LTTng ABI header
  10  *
  11  * Dual LGPL v2.1/GPL v2 license.
  12  */
  13
  14 #include <linux/fs.h>
  15
  16 #define LTTNG_KERNEL_SYM_NAME_LEN       256
  17
  18 enum lttng_kernel_instrumentation {
  19         LTTNG_KERNEL_TRACEPOINT = 0,
  20         LTTNG_KERNEL_KPROBE     = 1,
  21         LTTNG_KERNEL_FUNCTION   = 2,
  22         LTTNG_KERNEL_KRETPROBE  = 3,
  23         LTTNG_KERNEL_NOOP       = 4,    /* not hooked */
  24         LTTNG_KERNEL_SYSCALL    = 5,
  25 };
  26
  27 /*
  28  * LTTng consumer mode
  29  */
  30 enum lttng_kernel_output {
  31         LTTNG_KERNEL_SPLICE     = 0,
  32         LTTNG_KERNEL_MMAP       = 1,
  33 };
  34
  35 /*
  36  * LTTng DebugFS ABI structures.
  37  */
  38 struct lttng_kernel_channel {
  39         int overwrite;                          /* 1: overwrite, 0: discard */
  40         uint64_t subbuf_size;                   /* in bytes */
  41         uint64_t num_subbuf;
  42         unsigned int switch_timer_interval;     /* usecs */
  43         unsigned int read_timer_interval;       /* usecs */
  44         enum lttng_kernel_output output;        /* splice, mmap */
  45 };
  46
  47 struct lttng_kernel_kretprobe {
  48         uint64_t addr;
  49
  50         uint64_t offset;
  51         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  52 };
  53
  54 /*
  55  * Either addr is used, or symbol_name and offset.
  56  */
  57 struct lttng_kernel_kprobe {
  58         uint64_t addr;
  59
  60         uint64_t offset;
  61         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  62 };
  63
  64 struct lttng_kernel_function_tracer {
  65         char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
  66 };
  67
  68 /*
  69  * For syscall tracing, name = '\0' means "enable all".
  70  */
  71 struct lttng_kernel_event {
  72         char name[LTTNG_KERNEL_SYM_NAME_LEN];   /* event name */
  73         enum lttng_kernel_instrumentation instrumentation;
  74         /* Per instrumentation type configuration */
  75         union {
  76                 struct lttng_kernel_kretprobe kretprobe;
  77                 struct lttng_kernel_kprobe kprobe;
  78                 struct lttng_kernel_function_tracer ftrace;
  79         } u;
  80 };
  81
  82 struct lttng_kernel_tracer_version {
  83         uint32_t version;
  84         uint32_t patchlevel;
  85         uint32_t sublevel;
  86 };
  87
  88 enum lttng_kernel_calibrate_type {
  89         LTTNG_KERNEL_CALIBRATE_KRETPROBE,
  90 };
  91
  92 struct lttng_kernel_calibrate {
  93         enum lttng_kernel_calibrate_type type;  /* type (input) */
  94 };
  95
  96 enum lttng_kernel_context_type {
  97         LTTNG_KERNEL_CONTEXT_PID                = 0,
  98         LTTNG_KERNEL_CONTEXT_PERF_COUNTER       = 1,
  99         LTTNG_KERNEL_CONTEXT_PROCNAME           = 2,
 100         LTTNG_KERNEL_CONTEXT_PRIO               = 3,
 101         LTTNG_KERNEL_CONTEXT_NICE               = 4,
 102         LTTNG_KERNEL_CONTEXT_VPID               = 5,
 103         LTTNG_KERNEL_CONTEXT_TID                = 6,
 104         LTTNG_KERNEL_CONTEXT_VTID               = 7,
 105         LTTNG_KERNEL_CONTEXT_PPID               = 8,
 106         LTTNG_KERNEL_CONTEXT_VPPID              = 9,
 107 };
 108
 109 struct lttng_kernel_perf_counter_ctx {
 110         uint32_t type;
 111         uint64_t config;
 112         char name[LTTNG_KERNEL_SYM_NAME_LEN];
 113 };
 114
 115 struct lttng_kernel_context {
 116         enum lttng_kernel_context_type ctx;
 117         union {
 118                 struct lttng_kernel_perf_counter_ctx perf_counter;
 119         } u;
 120 };
 121
 122 /* LTTng file descriptor ioctl */
 123 #define LTTNG_KERNEL_SESSION                    _IO(0xF6, 0x40)
 124 #define LTTNG_KERNEL_TRACER_VERSION             \
 125         _IOR(0xF6, 0x41, struct lttng_kernel_tracer_version)
 126 #define LTTNG_KERNEL_TRACEPOINT_LIST            _IO(0xF6, 0x42)
 127 #define LTTNG_KERNEL_WAIT_QUIESCENT             _IO(0xF6, 0x43)
 128 #define LTTNG_KERNEL_CALIBRATE                  \
 129         _IOWR(0xF6, 0x44, struct lttng_kernel_calibrate)
 130
 131 /* Session FD ioctl */
 132 #define LTTNG_KERNEL_METADATA                   \
 133         _IOW(0xF6, 0x50, struct lttng_kernel_channel)
 134 #define LTTNG_KERNEL_CHANNEL                    \
 135         _IOW(0xF6, 0x51, struct lttng_kernel_channel)
 136 #define LTTNG_KERNEL_SESSION_START              _IO(0xF6, 0x52)
 137 #define LTTNG_KERNEL_SESSION_STOP               _IO(0xF6, 0x53)
 138
 139 /* Channel FD ioctl */
 140 #define LTTNG_KERNEL_STREAM                     _IO(0xF6, 0x60)
 141 #define LTTNG_KERNEL_EVENT                      \
 142         _IOW(0xF6, 0x61, struct lttng_kernel_event)
 143
 144 /* Event and Channel FD ioctl */
 145 #define LTTNG_KERNEL_CONTEXT                    \
 146         _IOW(0xF6, 0x70, struct lttng_kernel_context)
 147
 148 /* Event, Channel and Session ioctl */
 149 #define LTTNG_KERNEL_ENABLE                     _IO(0xF6, 0x80)
 150 #define LTTNG_KERNEL_DISABLE                    _IO(0xF6, 0x81)
 151
 152 #endif /* _LTTNG_ABI_H */