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             7
  48 #define LTTNG_UST_ABI_MINOR_VERSION             1
  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         LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER   = 5,
 144         LTTNG_UST_CONTEXT_CPU_ID                = 6,
 145         LTTNG_UST_CONTEXT_APP_CONTEXT           = 7,
 146 };
 147
 148 struct lttng_ust_perf_counter_ctx {
 149         uint32_t type;
 150         uint64_t config;
 151         char name[LTTNG_UST_SYM_NAME_LEN];
 152 } LTTNG_PACKED;
 153
 154 #define LTTNG_UST_CONTEXT_PADDING1      16
 155 #define LTTNG_UST_CONTEXT_PADDING2      (LTTNG_UST_SYM_NAME_LEN + 32)
 156 struct lttng_ust_context {
 157         enum lttng_ust_context_type ctx;
 158         char padding[LTTNG_UST_CONTEXT_PADDING1];
 159
 160         union {
 161                 struct lttng_ust_perf_counter_ctx perf_counter;
 162                 struct {
 163                         /* Includes trailing '\0'. */
 164                         uint32_t provider_name_len;
 165                         uint32_t ctx_name_len;
 166                 } app_ctx;
 167                 char padding[LTTNG_UST_CONTEXT_PADDING2];
 168         } u;
 169 } LTTNG_PACKED;
 170
 171 /*
 172  * Tracer channel attributes.
 173  */
 174 #define LTTNG_UST_CHANNEL_ATTR_PADDING  (LTTNG_UST_SYM_NAME_LEN + 32)
 175 struct lttng_ust_channel_attr {
 176         uint64_t subbuf_size;                   /* bytes, power of 2 */
 177         uint64_t num_subbuf;                    /* power of 2 */
 178         int overwrite;                          /* 1: overwrite, 0: discard */
 179         unsigned int switch_timer_interval;     /* usec */
 180         unsigned int read_timer_interval;       /* usec */
 181         enum lttng_ust_output output;           /* splice, mmap */
 182         char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
 183 } LTTNG_PACKED;
 184
 185 #define LTTNG_UST_TRACEPOINT_ITER_PADDING       16
 186 struct lttng_ust_tracepoint_iter {
 187         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
 188         int loglevel;
 189         char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
 190 } LTTNG_PACKED;
 191
 192 enum lttng_ust_object_type {
 193         LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
 194         LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
 195         LTTNG_UST_OBJECT_TYPE_STREAM = 1,
 196         LTTNG_UST_OBJECT_TYPE_EVENT = 2,
 197         LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
 198 };
 199
 200 #define LTTNG_UST_OBJECT_DATA_PADDING1  32
 201 #define LTTNG_UST_OBJECT_DATA_PADDING2  (LTTNG_UST_SYM_NAME_LEN + 32)
 202
 203 struct lttng_ust_object_data {
 204         enum lttng_ust_object_type type;
 205         int handle;
 206         uint64_t size;
 207         char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
 208         union {
 209                 struct {
 210                         void *data;
 211                         enum lttng_ust_chan_type type;
 212                         int wakeup_fd;
 213                 } channel;
 214                 struct {
 215                         int shm_fd;
 216                         int wakeup_fd;
 217                         uint32_t stream_nr;
 218                 } stream;
 219                 char padding2[LTTNG_UST_OBJECT_DATA_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 LTTNG_UST_EXCLUSION_PADDING     32
 234 struct lttng_ust_event_exclusion {
 235         uint32_t count;
 236         char padding[LTTNG_UST_EXCLUSION_PADDING];
 237         char names[LTTNG_UST_SYM_NAME_LEN][0];
 238 } LTTNG_PACKED;
 239
 240 #define _UST_CMD(minor)                         (minor)
 241 #define _UST_CMDR(minor, type)                  (minor)
 242 #define _UST_CMDW(minor, type)                  (minor)
 243
 244 /* Handled by object descriptor */
 245 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 246
 247 /* Handled by object cmd */
 248
 249 /* LTTng-UST commands */
 250 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 251 #define LTTNG_UST_TRACER_VERSION                \
 252         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 253 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 254 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 255 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 256 #define LTTNG_UST_TRACEPOINT_FIELD_LIST         _UST_CMD(0x45)
 257
 258 /* Session FD commands */
 259 #define LTTNG_UST_CHANNEL                       \
 260         _UST_CMDW(0x51, struct lttng_ust_channel)
 261 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 262 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 263 #define LTTNG_UST_SESSION_STATEDUMP             _UST_CMD(0x54)
 264
 265 /* Channel FD commands */
 266 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 267 #define LTTNG_UST_EVENT                 \
 268         _UST_CMDW(0x61, struct lttng_ust_event)
 269
 270 /* Event and Channel FD commands */
 271 #define LTTNG_UST_CONTEXT                       \
 272         _UST_CMDW(0x70, struct lttng_ust_context)
 273 #define LTTNG_UST_FLUSH_BUFFER                  \
 274         _UST_CMD(0x71)
 275
 276 /* Event, Channel and Session commands */
 277 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 278 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 279
 280 /* Tracepoint list commands */
 281 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 282 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET     _UST_CMD(0x91)
 283
 284 /* Event FD commands */
 285 #define LTTNG_UST_FILTER                        _UST_CMD(0xA0)
 286
 287 #define LTTNG_UST_ROOT_HANDLE   0
 288
 289 struct lttng_ust_obj;
 290
 291 union ust_args {
 292         struct {
 293                 void *chan_data;
 294                 int wakeup_fd;
 295         } channel;
 296         struct {
 297                 int shm_fd;
 298                 int wakeup_fd;
 299         } stream;
 300         struct {
 301                 struct lttng_ust_field_iter entry;
 302         } field_list;
 303 };
 304
 305 struct lttng_ust_objd_ops {
 306         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 307                 union ust_args *args, void *owner);
 308         int (*release)(int objd);
 309 };
 310
 311 /* Create root handle. Always ID 0. */
 312 int lttng_abi_create_root_handle(void);
 313
 314 const struct lttng_ust_objd_ops *objd_ops(int id);
 315 int lttng_ust_objd_unref(int id, int is_owner);
 316
 317 void lttng_ust_abi_exit(void);
 318 void lttng_ust_events_exit(void);
 319 void lttng_ust_objd_table_owner_cleanup(void *owner);
 320
 321 #endif /* _LTTNG_UST_ABI_H */