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