include/lttng/ust-abi.h

   1 #ifndef _LTTNG_UST_ABI_H
   2 #define _LTTNG_UST_ABI_H
   3
   4 /*
   5  * lttng/ust-abi.h
   6  *
   7  * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * LTTng-UST ABI header
  10  *
  11  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
  12  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
  13  *
  14  * Permission is hereby granted to use or copy this program
  15  * for any purpose,  provided the above notices are retained on all copies.
  16  * Permission to modify the code and to distribute modified code is granted,
  17  * provided the above notices are retained, and a notice that the code was
  18  * modified is included with the above copyright notice.
  19  */
  20
  21 #include <stdint.h>
  22
  23 #define LTTNG_UST_SYM_NAME_LEN  256
  24
  25 #define LTTNG_UST_COMM_VERSION_MAJOR            0
  26 #define LTTNG_UST_COMM_VERSION_MINOR            1
  27
  28 enum lttng_ust_instrumentation {
  29         LTTNG_UST_TRACEPOINT            = 0,
  30         LTTNG_UST_PROBE                 = 1,
  31         LTTNG_UST_FUNCTION              = 2,
  32 };
  33
  34 enum lttng_ust_loglevel_type {
  35         LTTNG_UST_LOGLEVEL              = 0,
  36         LTTNG_UST_LOGLEVEL_ONLY         = 1,
  37 };
  38
  39 enum lttng_ust_output {
  40         LTTNG_UST_MMAP          = 0,
  41 };
  42
  43 struct lttng_ust_tracer_version {
  44         uint32_t major;
  45         uint32_t minor;
  46         uint32_t patchlevel;
  47 };
  48
  49 struct lttng_ust_channel {
  50         int overwrite;                          /* 1: overwrite, 0: discard */
  51         uint64_t subbuf_size;                   /* in bytes */
  52         uint64_t num_subbuf;
  53         unsigned int switch_timer_interval;     /* usecs */
  54         unsigned int read_timer_interval;       /* usecs */
  55         enum lttng_ust_output output;           /* output mode */
  56 };
  57
  58 struct lttng_ust_stream {
  59 };
  60
  61 struct lttng_ust_event {
  62         enum lttng_ust_instrumentation instrumentation;
  63         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
  64
  65         enum lttng_ust_loglevel_type loglevel_type;
  66         char loglevel[LTTNG_UST_SYM_NAME_LEN];  /* loglevel name */
  67
  68         /* Per instrumentation type configuration */
  69         union {
  70         } u;
  71 };
  72
  73 enum lttng_ust_context_type {
  74         LTTNG_UST_CONTEXT_VTID                  = 0,
  75         LTTNG_UST_CONTEXT_VPID                  = 1,
  76         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
  77         LTTNG_UST_CONTEXT_PROCNAME              = 3,
  78 };
  79
  80 struct lttng_ust_context {
  81         enum lttng_ust_context_type ctx;
  82         union {
  83         } u;
  84 };
  85
  86 /*
  87  * Tracer channel attributes.
  88  */
  89 struct lttng_ust_channel_attr {
  90         int overwrite;                          /* 1: overwrite, 0: discard */
  91         uint64_t subbuf_size;                   /* bytes */
  92         uint64_t num_subbuf;                    /* power of 2 */
  93         unsigned int switch_timer_interval;     /* usec */
  94         unsigned int read_timer_interval;       /* usec */
  95         enum lttng_ust_output output;           /* splice, mmap */
  96 };
  97
  98 struct lttng_ust_tracepoint_iter {
  99         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
 100         char loglevel[LTTNG_UST_SYM_NAME_LEN];  /* loglevel */
 101         int64_t loglevel_value;
 102 };
 103
 104 struct lttng_ust_object_data {
 105         int handle;
 106         int shm_fd;
 107         int wait_fd;
 108         uint64_t memory_map_size;
 109 };
 110
 111 enum lttng_ust_calibrate_type {
 112         LTTNG_UST_CALIBRATE_TRACEPOINT,
 113 };
 114
 115 struct lttng_ust_calibrate {
 116         enum lttng_ust_calibrate_type type;     /* type (input) */
 117 };
 118
 119 #define _UST_CMD(minor)                         (minor)
 120 #define _UST_CMDR(minor, type)                  (minor)
 121 #define _UST_CMDW(minor, type)                  (minor)
 122
 123 /* Handled by object descriptor */
 124 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 125
 126 /* Handled by object cmd */
 127
 128 /* LTTng-UST commands */
 129 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 130 #define LTTNG_UST_TRACER_VERSION                \
 131         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 132 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 133 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 134 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 135
 136 /* Session FD commands */
 137 #define LTTNG_UST_METADATA                      \
 138         _UST_CMDW(0x50, struct lttng_ust_channel)
 139 #define LTTNG_UST_CHANNEL                       \
 140         _UST_CMDW(0x51, struct lttng_ust_channel)
 141 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 142 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 143
 144 /* Channel FD commands */
 145 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 146 #define LTTNG_UST_EVENT                 \
 147         _UST_CMDW(0x61, struct lttng_ust_event)
 148
 149 /* Event and Channel FD commands */
 150 #define LTTNG_UST_CONTEXT                       \
 151         _UST_CMDW(0x70, struct lttng_ust_context)
 152 #define LTTNG_UST_FLUSH_BUFFER                  \
 153         _UST_CMD(0x71)
 154
 155 /* Event, Channel and Session commands */
 156 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 157 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 158
 159 /* Tracepoint list commands */
 160 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 161
 162 #define LTTNG_UST_ROOT_HANDLE   0
 163
 164 struct lttng_ust_obj;
 165
 166 union ust_args {
 167         struct {
 168                 int *shm_fd;
 169                 int *wait_fd;
 170                 uint64_t *memory_map_size;
 171         } channel;
 172         struct {
 173                 int *shm_fd;
 174                 int *wait_fd;
 175                 uint64_t *memory_map_size;
 176         } stream;
 177 };
 178
 179 struct lttng_ust_objd_ops {
 180         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 181                 union ust_args *args);
 182         int (*release)(int objd);
 183 };
 184
 185 /* Create root handle. Always ID 0. */
 186 int lttng_abi_create_root_handle(void);
 187
 188 const struct lttng_ust_objd_ops *objd_ops(int id);
 189 int lttng_ust_objd_unref(int id);
 190
 191 void lttng_ust_abi_exit(void);
 192 void lttng_ust_events_exit(void);
 193
 194 #endif /* _LTTNG_UST_ABI_H */