src/bin/lttng-sessiond/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
  32 #define lttng_ust_notrace __attribute__((no_instrument_function))
  33 #define LTTNG_PACKED    __attribute__((__packed__))
  34
  35 #ifndef __ust_stringify
  36 #define __ust_stringify1(x)     #x
  37 #define __ust_stringify(x)      __ust_stringify1(x)
  38 #endif /* __ust_stringify */
  39
  40 #define LTTNG_UST_SYM_NAME_LEN                  256
  41 #define LTTNG_UST_ABI_PROCNAME_LEN              16
  42
  43 /* UST comm magic number, used to validate protocol and endianness. */
  44 #define LTTNG_UST_COMM_MAGIC                    0xC57C57C5
  45
  46 /* Version for ABI between liblttng-ust, sessiond, consumerd */
  47 #define LTTNG_UST_ABI_MAJOR_VERSION             5
  48 #define LTTNG_UST_ABI_MINOR_VERSION             0
  49
  50 enum lttng_ust_instrumentation {
  51         LTTNG_UST_TRACEPOINT            = 0,
  52         LTTNG_UST_PROBE                 = 1,
  53         LTTNG_UST_FUNCTION              = 2,
  54 };
  55
  56 enum lttng_ust_loglevel_type {
  57         LTTNG_UST_LOGLEVEL_ALL          = 0,
  58         LTTNG_UST_LOGLEVEL_RANGE        = 1,
  59         LTTNG_UST_LOGLEVEL_SINGLE       = 2,
  60 };
  61
  62 enum lttng_ust_output {
  63         LTTNG_UST_MMAP          = 0,
  64 };
  65
  66 enum lttng_ust_chan_type {
  67         LTTNG_UST_CHAN_PER_CPU = 0,
  68         LTTNG_UST_CHAN_METADATA = 1,
  69 };
  70
  71 struct lttng_ust_tracer_version {
  72         uint32_t major;
  73         uint32_t minor;
  74         uint32_t patchlevel;
  75 } LTTNG_PACKED;
  76
  77 #define LTTNG_UST_CHANNEL_PADDING       (LTTNG_UST_SYM_NAME_LEN + 32)
  78 /*
  79  * Given that the consumerd is limited to 64k file descriptors, we
  80  * cannot expect much more than 1MB channel structure size. This size is
  81  * depends on the number of streams within a channel, which depends on
  82  * the number of possible CPUs on the system.
  83  */
  84 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN  1048576U
  85 struct lttng_ust_channel {
  86         uint64_t len;
  87         enum lttng_ust_chan_type type;
  88         char padding[LTTNG_UST_CHANNEL_PADDING];
  89         char data[];    /* variable sized data */
  90 } LTTNG_PACKED;
  91
  92 #define LTTNG_UST_STREAM_PADDING1       (LTTNG_UST_SYM_NAME_LEN + 32)
  93 struct lttng_ust_stream {
  94         uint64_t len;           /* shm len */
  95         uint32_t stream_nr;     /* stream number */
  96         char padding[LTTNG_UST_STREAM_PADDING1];
  97         /*
  98          * shm_fd and wakeup_fd are send over unix socket as file
  99          * descriptors after this structure.
 100          */
 101 } LTTNG_PACKED;
 102
 103 #define LTTNG_UST_EVENT_PADDING1        16
 104 #define LTTNG_UST_EVENT_PADDING2        (LTTNG_UST_SYM_NAME_LEN + 32)
 105 struct lttng_ust_event {
 106         enum lttng_ust_instrumentation instrumentation;
 107         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
 108
 109         enum lttng_ust_loglevel_type loglevel_type;
 110         int loglevel;   /* value, -1: all */
 111         char padding[LTTNG_UST_EVENT_PADDING1];
 112
 113         /* Per instrumentation type configuration */
 114         union {
 115                 char padding[LTTNG_UST_EVENT_PADDING2];
 116         } u;
 117 } LTTNG_PACKED;
 118
 119 enum lttng_ust_field_type {
 120         LTTNG_UST_FIELD_OTHER                   = 0,
 121         LTTNG_UST_FIELD_INTEGER                 = 1,
 122         LTTNG_UST_FIELD_ENUM                    = 2,
 123         LTTNG_UST_FIELD_FLOAT                   = 3,
 124         LTTNG_UST_FIELD_STRING                  = 4,
 125 };
 126
 127 #define LTTNG_UST_FIELD_ITER_PADDING    (LTTNG_UST_SYM_NAME_LEN + 28)
 128 struct lttng_ust_field_iter {
 129         char event_name[LTTNG_UST_SYM_NAME_LEN];
 130         char field_name[LTTNG_UST_SYM_NAME_LEN];
 131         enum lttng_ust_field_type type;
 132         int loglevel;                           /* event loglevel */
 133         int nowrite;
 134         char padding[LTTNG_UST_FIELD_ITER_PADDING];
 135 } LTTNG_PACKED;
 136
 137 enum lttng_ust_context_type {
 138         LTTNG_UST_CONTEXT_VTID                  = 0,
 139         LTTNG_UST_CONTEXT_VPID                  = 1,
 140         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
 141         LTTNG_UST_CONTEXT_PROCNAME              = 3,
 142         LTTNG_UST_CONTEXT_IP                    = 4,
 143 };
 144
 145 #define LTTNG_UST_CONTEXT_PADDING1      16
 146 #define LTTNG_UST_CONTEXT_PADDING2      (LTTNG_UST_SYM_NAME_LEN + 32)
 147 struct lttng_ust_context {
 148         enum lttng_ust_context_type ctx;
 149         char padding[LTTNG_UST_CONTEXT_PADDING1];
 150
 151         union {
 152                 char padding[LTTNG_UST_CONTEXT_PADDING2];
 153         } u;
 154 } LTTNG_PACKED;
 155
 156 /*
 157  * Tracer channel attributes.
 158  */
 159 #define LTTNG_UST_CHANNEL_ATTR_PADDING  (LTTNG_UST_SYM_NAME_LEN + 32)
 160 struct lttng_ust_channel_attr {
 161         uint64_t subbuf_size;                   /* bytes */
 162         uint64_t num_subbuf;                    /* power of 2 */
 163         int overwrite;                          /* 1: overwrite, 0: discard */
 164         unsigned int switch_timer_interval;     /* usec */
 165         unsigned int read_timer_interval;       /* usec */
 166         enum lttng_ust_output output;           /* splice, mmap */
 167         char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
 168 } LTTNG_PACKED;
 169
 170 #define LTTNG_UST_TRACEPOINT_ITER_PADDING       16
 171 struct lttng_ust_tracepoint_iter {
 172         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
 173         int loglevel;
 174         char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
 175 } LTTNG_PACKED;
 176
 177 enum lttng_ust_object_type {
 178         LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
 179         LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
 180         LTTNG_UST_OBJECT_TYPE_STREAM = 1,
 181         LTTNG_UST_OBJECT_TYPE_EVENT = 2,
 182         LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
 183 };
 184
 185 #define LTTNG_UST_OBJECT_DATA_PADDING1  32
 186 #define LTTNG_UST_OBJECT_DATA_PADDING2  (LTTNG_UST_SYM_NAME_LEN + 32)
 187
 188 struct lttng_ust_object_data {
 189         enum lttng_ust_object_type type;
 190         int handle;
 191         uint64_t size;
 192         char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
 193         union {
 194                 struct {
 195                         void *data;
 196                         enum lttng_ust_chan_type type;
 197                         int wakeup_fd;
 198                 } channel;
 199                 struct {
 200                         int shm_fd;
 201                         int wakeup_fd;
 202                         uint32_t stream_nr;
 203                 } stream;
 204                 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
 205         } u;
 206 } LTTNG_PACKED;
 207
 208 enum lttng_ust_calibrate_type {
 209         LTTNG_UST_CALIBRATE_TRACEPOINT,
 210 };
 211
 212 #define LTTNG_UST_CALIBRATE_PADDING1    16
 213 #define LTTNG_UST_CALIBRATE_PADDING2    (LTTNG_UST_SYM_NAME_LEN + 32)
 214 struct lttng_ust_calibrate {
 215         enum lttng_ust_calibrate_type type;     /* type (input) */
 216         char padding[LTTNG_UST_CALIBRATE_PADDING1];
 217
 218         union {
 219                 char padding[LTTNG_UST_CALIBRATE_PADDING2];
 220         } u;
 221 } LTTNG_PACKED;
 222
 223 #define FILTER_BYTECODE_MAX_LEN         65536
 224 #define LTTNG_UST_FILTER_PADDING        32
 225 struct lttng_ust_filter_bytecode {
 226         uint32_t len;
 227         uint32_t reloc_offset;
 228         uint64_t seqnum;
 229         char padding[LTTNG_UST_FILTER_PADDING];
 230         char data[0];
 231 } LTTNG_PACKED;
 232
 233 #define _UST_CMD(minor)                         (minor)
 234 #define _UST_CMDR(minor, type)                  (minor)
 235 #define _UST_CMDW(minor, type)                  (minor)
 236
 237 /* Handled by object descriptor */
 238 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 239
 240 /* Handled by object cmd */
 241
 242 /* LTTng-UST commands */
 243 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 244 #define LTTNG_UST_TRACER_VERSION                \
 245         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 246 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 247 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 248 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 249 #define LTTNG_UST_TRACEPOINT_FIELD_LIST         _UST_CMD(0x45)
 250
 251 /* Session FD commands */
 252 #define LTTNG_UST_CHANNEL                       \
 253         _UST_CMDW(0x51, struct lttng_ust_channel)
 254 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 255 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 256
 257 /* Channel FD commands */
 258 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 259 #define LTTNG_UST_EVENT                 \
 260         _UST_CMDW(0x61, struct lttng_ust_event)
 261
 262 /* Event and Channel FD commands */
 263 #define LTTNG_UST_CONTEXT                       \
 264         _UST_CMDW(0x70, struct lttng_ust_context)
 265 #define LTTNG_UST_FLUSH_BUFFER                  \
 266         _UST_CMD(0x71)
 267
 268 /* Event, Channel and Session commands */
 269 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 270 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 271
 272 /* Tracepoint list commands */
 273 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 274 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET     _UST_CMD(0x91)
 275
 276 /* Event FD commands */
 277 #define LTTNG_UST_FILTER                        _UST_CMD(0xA0)
 278
 279 #define LTTNG_UST_ROOT_HANDLE   0
 280
 281 struct lttng_ust_obj;
 282
 283 union ust_args {
 284         struct {
 285                 void *chan_data;
 286                 int wakeup_fd;
 287         } channel;
 288         struct {
 289                 int shm_fd;
 290                 int wakeup_fd;
 291         } stream;
 292         struct {
 293                 struct lttng_ust_field_iter entry;
 294         } field_list;
 295 };
 296
 297 struct lttng_ust_objd_ops {
 298         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 299                 union ust_args *args, void *owner);
 300         int (*release)(int objd);
 301 };
 302
 303 /* Create root handle. Always ID 0. */
 304 int lttng_abi_create_root_handle(void);
 305
 306 const struct lttng_ust_objd_ops *objd_ops(int id);
 307 int lttng_ust_objd_unref(int id, int is_owner);
 308
 309 void lttng_ust_abi_exit(void);
 310 void lttng_ust_events_exit(void);
 311 void lttng_ust_objd_table_owner_cleanup(void *owner);
 312
 313 #endif /* _LTTNG_UST_ABI_H */