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