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  * LTTng-UST ABI header
   8  *
   9  * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <stdint.h>
  31 #include <lttng/ust-compiler.h>
  32
  33 #ifndef __ust_stringify
  34 #define __ust_stringify1(x)     #x
  35 #define __ust_stringify(x)      __ust_stringify1(x)
  36 #endif /* __ust_stringify */
  37
  38 #define LTTNG_UST_SYM_NAME_LEN                  256
  39 #define LTTNG_UST_ABI_PROCNAME_LEN              16
  40
  41 /* UST comm magic number, used to validate protocol and endianness. */
  42 #define LTTNG_UST_COMM_MAGIC                    0xC57C57C5
  43
  44 /* Version for ABI between liblttng-ust, sessiond, consumerd */
  45 #define LTTNG_UST_ABI_MAJOR_VERSION             4
  46 #define LTTNG_UST_ABI_MINOR_VERSION             0
  47
  48 enum lttng_ust_instrumentation {
  49         LTTNG_UST_TRACEPOINT            = 0,
  50         LTTNG_UST_PROBE                 = 1,
  51         LTTNG_UST_FUNCTION              = 2,
  52 };
  53
  54 enum lttng_ust_loglevel_type {
  55         LTTNG_UST_LOGLEVEL_ALL          = 0,
  56         LTTNG_UST_LOGLEVEL_RANGE        = 1,
  57         LTTNG_UST_LOGLEVEL_SINGLE       = 2,
  58 };
  59
  60 enum lttng_ust_output {
  61         LTTNG_UST_MMAP          = 0,
  62 };
  63
  64 enum lttng_ust_chan_type {
  65         LTTNG_UST_CHAN_PER_CPU = 0,
  66         LTTNG_UST_CHAN_METADATA = 1,
  67 };
  68
  69 struct lttng_ust_tracer_version {
  70         uint32_t major;
  71         uint32_t minor;
  72         uint32_t patchlevel;
  73 } LTTNG_PACKED;
  74
  75 #define LTTNG_UST_CHANNEL_PADDING       (LTTNG_UST_SYM_NAME_LEN + 32)
  76 /*
  77  * Given that the consumerd is limited to 64k file descriptors, we
  78  * cannot expect much more than 1MB channel structure size. This size is
  79  * depends on the number of streams within a channel, which depends on
  80  * the number of possible CPUs on the system.
  81  */
  82 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN  1048576U
  83 struct lttng_ust_channel {
  84         uint64_t len;
  85         enum lttng_ust_chan_type type;
  86         char padding[LTTNG_UST_CHANNEL_PADDING];
  87         char data[];    /* variable sized data */
  88 } LTTNG_PACKED;
  89
  90 #define LTTNG_UST_STREAM_PADDING1       (LTTNG_UST_SYM_NAME_LEN + 32)
  91 struct lttng_ust_stream {
  92         uint64_t len;           /* shm len */
  93         uint32_t stream_nr;     /* stream number */
  94         char padding[LTTNG_UST_STREAM_PADDING1];
  95         /*
  96          * shm_fd and wakeup_fd are send over unix socket as file
  97          * descriptors after this structure.
  98          */
  99 } LTTNG_PACKED;
 100
 101 #define LTTNG_UST_EVENT_PADDING1        16
 102 #define LTTNG_UST_EVENT_PADDING2        (LTTNG_UST_SYM_NAME_LEN + 32)
 103 struct lttng_ust_event {
 104         enum lttng_ust_instrumentation instrumentation;
 105         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
 106
 107         enum lttng_ust_loglevel_type loglevel_type;
 108         int loglevel;   /* value, -1: all */
 109         char padding[LTTNG_UST_EVENT_PADDING1];
 110
 111         /* Per instrumentation type configuration */
 112         union {
 113                 char padding[LTTNG_UST_EVENT_PADDING2];
 114         } u;
 115 } LTTNG_PACKED;
 116
 117 enum lttng_ust_field_type {
 118         LTTNG_UST_FIELD_OTHER                   = 0,
 119         LTTNG_UST_FIELD_INTEGER                 = 1,
 120         LTTNG_UST_FIELD_ENUM                    = 2,
 121         LTTNG_UST_FIELD_FLOAT                   = 3,
 122         LTTNG_UST_FIELD_STRING                  = 4,
 123 };
 124
 125 #define LTTNG_UST_FIELD_ITER_PADDING    (LTTNG_UST_SYM_NAME_LEN + 28)
 126 struct lttng_ust_field_iter {
 127         char event_name[LTTNG_UST_SYM_NAME_LEN];
 128         char field_name[LTTNG_UST_SYM_NAME_LEN];
 129         enum lttng_ust_field_type type;
 130         int loglevel;                           /* event loglevel */
 131         int nowrite;
 132         char padding[LTTNG_UST_FIELD_ITER_PADDING];
 133 } LTTNG_PACKED;
 134
 135 enum lttng_ust_context_type {
 136         LTTNG_UST_CONTEXT_VTID                  = 0,
 137         LTTNG_UST_CONTEXT_VPID                  = 1,
 138         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
 139         LTTNG_UST_CONTEXT_PROCNAME              = 3,
 140 };
 141
 142 #define LTTNG_UST_CONTEXT_PADDING1      16
 143 #define LTTNG_UST_CONTEXT_PADDING2      (LTTNG_UST_SYM_NAME_LEN + 32)
 144 struct lttng_ust_context {
 145         enum lttng_ust_context_type ctx;
 146         char padding[LTTNG_UST_CONTEXT_PADDING1];
 147
 148         union {
 149                 char padding[LTTNG_UST_CONTEXT_PADDING2];
 150         } u;
 151 } LTTNG_PACKED;
 152
 153 /*
 154  * Tracer channel attributes.
 155  */
 156 #define LTTNG_UST_CHANNEL_ATTR_PADDING  (LTTNG_UST_SYM_NAME_LEN + 32)
 157 struct lttng_ust_channel_attr {
 158         uint64_t subbuf_size;                   /* bytes */
 159         uint64_t num_subbuf;                    /* power of 2 */
 160         int overwrite;                          /* 1: overwrite, 0: discard */
 161         unsigned int switch_timer_interval;     /* usec */
 162         unsigned int read_timer_interval;       /* usec */
 163         enum lttng_ust_output output;           /* splice, mmap */
 164         char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
 165 } LTTNG_PACKED;
 166
 167 #define LTTNG_UST_TRACEPOINT_ITER_PADDING       16
 168 struct lttng_ust_tracepoint_iter {
 169         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
 170         int loglevel;
 171         char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
 172 } LTTNG_PACKED;
 173
 174 enum lttng_ust_object_type {
 175         LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
 176         LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
 177         LTTNG_UST_OBJECT_TYPE_STREAM = 1,
 178         LTTNG_UST_OBJECT_TYPE_EVENT = 2,
 179         LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
 180 };
 181
 182 #define LTTNG_UST_OBJECT_DATA_PADDING1  32
 183 #define LTTNG_UST_OBJECT_DATA_PADDING2  (LTTNG_UST_SYM_NAME_LEN + 32)
 184
 185 struct lttng_ust_object_data {
 186         enum lttng_ust_object_type type;
 187         int handle;
 188         uint64_t size;
 189         char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
 190         union {
 191                 struct {
 192                         void *data;
 193                         enum lttng_ust_chan_type type;
 194                         int wakeup_fd;
 195                 } channel;
 196                 struct {
 197                         int shm_fd;
 198                         int wakeup_fd;
 199                         uint32_t stream_nr;
 200                 } stream;
 201                 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
 202         } u;
 203 } LTTNG_PACKED;
 204
 205 enum lttng_ust_calibrate_type {
 206         LTTNG_UST_CALIBRATE_TRACEPOINT,
 207 };
 208
 209 #define LTTNG_UST_CALIBRATE_PADDING1    16
 210 #define LTTNG_UST_CALIBRATE_PADDING2    (LTTNG_UST_SYM_NAME_LEN + 32)
 211 struct lttng_ust_calibrate {
 212         enum lttng_ust_calibrate_type type;     /* type (input) */
 213         char padding[LTTNG_UST_CALIBRATE_PADDING1];
 214
 215         union {
 216                 char padding[LTTNG_UST_CALIBRATE_PADDING2];
 217         } u;
 218 } LTTNG_PACKED;
 219
 220 #define FILTER_BYTECODE_MAX_LEN         65536
 221 #define LTTNG_UST_FILTER_PADDING        32
 222 struct lttng_ust_filter_bytecode {
 223         uint32_t len;
 224         uint32_t reloc_offset;
 225         uint64_t seqnum;
 226         char padding[LTTNG_UST_FILTER_PADDING];
 227         char data[0];
 228 } LTTNG_PACKED;
 229
 230 #define _UST_CMD(minor)                         (minor)
 231 #define _UST_CMDR(minor, type)                  (minor)
 232 #define _UST_CMDW(minor, type)                  (minor)
 233
 234 /* Handled by object descriptor */
 235 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 236
 237 /* Handled by object cmd */
 238
 239 /* LTTng-UST commands */
 240 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 241 #define LTTNG_UST_TRACER_VERSION                \
 242         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 243 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 244 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 245 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 246 #define LTTNG_UST_TRACEPOINT_FIELD_LIST         _UST_CMD(0x45)
 247
 248 /* Session FD commands */
 249 #define LTTNG_UST_CHANNEL                       \
 250         _UST_CMDW(0x51, struct lttng_ust_channel)
 251 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 252 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 253
 254 /* Channel FD commands */
 255 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 256 #define LTTNG_UST_EVENT                 \
 257         _UST_CMDW(0x61, struct lttng_ust_event)
 258
 259 /* Event and Channel FD commands */
 260 #define LTTNG_UST_CONTEXT                       \
 261         _UST_CMDW(0x70, struct lttng_ust_context)
 262 #define LTTNG_UST_FLUSH_BUFFER                  \
 263         _UST_CMD(0x71)
 264
 265 /* Event, Channel and Session commands */
 266 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 267 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 268
 269 /* Tracepoint list commands */
 270 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 271 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET     _UST_CMD(0x91)
 272
 273 /* Event FD commands */
 274 #define LTTNG_UST_FILTER                        _UST_CMD(0xA0)
 275
 276 #define LTTNG_UST_ROOT_HANDLE   0
 277
 278 struct lttng_ust_obj;
 279
 280 union ust_args {
 281         struct {
 282                 void *chan_data;
 283                 int wakeup_fd;
 284         } channel;
 285         struct {
 286                 int shm_fd;
 287                 int wakeup_fd;
 288         } stream;
 289         struct {
 290                 struct lttng_ust_field_iter entry;
 291         } field_list;
 292 };
 293
 294 struct lttng_ust_objd_ops {
 295         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 296                 union ust_args *args, void *owner);
 297         int (*release)(int objd);
 298 };
 299
 300 /* Create root handle. Always ID 0. */
 301 int lttng_abi_create_root_handle(void);
 302
 303 const struct lttng_ust_objd_ops *objd_ops(int id);
 304 int lttng_ust_objd_unref(int id, int is_owner);
 305
 306 void lttng_ust_abi_exit(void);
 307 void lttng_ust_events_exit(void);
 308 void lttng_ust_objd_table_owner_cleanup(void *owner);
 309
 310 #endif /* _LTTNG_UST_ABI_H */