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             1
  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_TRIGGER_PADDING1      16
 106 #define LTTNG_UST_TRIGGER_PADDING2      (LTTNG_UST_SYM_NAME_LEN + 32)
 107 struct lttng_ust_trigger {
 108         uint64_t id;
 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         char padding[LTTNG_UST_TRIGGER_PADDING1];
 115
 116         /* Per instrumentation type configuration */
 117         union {
 118                 char padding[LTTNG_UST_TRIGGER_PADDING2];
 119         } u;
 120 } LTTNG_PACKED;
 121
 122 #define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
 123 struct lttng_ust_trigger_notification {
 124         uint64_t id;
 125         char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
 126 } LTTNG_PACKED;
 127
 128 #define LTTNG_UST_EVENT_PADDING1        16
 129 #define LTTNG_UST_EVENT_PADDING2        (LTTNG_UST_SYM_NAME_LEN + 32)
 130 struct lttng_ust_event {
 131         enum lttng_ust_instrumentation instrumentation;
 132         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
 133
 134         enum lttng_ust_loglevel_type loglevel_type;
 135         int loglevel;   /* value, -1: all */
 136         char padding[LTTNG_UST_EVENT_PADDING1];
 137
 138         /* Per instrumentation type configuration */
 139         union {
 140                 char padding[LTTNG_UST_EVENT_PADDING2];
 141         } u;
 142 } LTTNG_PACKED;
 143
 144 enum lttng_ust_field_type {
 145         LTTNG_UST_FIELD_OTHER                   = 0,
 146         LTTNG_UST_FIELD_INTEGER                 = 1,
 147         LTTNG_UST_FIELD_ENUM                    = 2,
 148         LTTNG_UST_FIELD_FLOAT                   = 3,
 149         LTTNG_UST_FIELD_STRING                  = 4,
 150 };
 151
 152 #define LTTNG_UST_FIELD_ITER_PADDING    (LTTNG_UST_SYM_NAME_LEN + 28)
 153 struct lttng_ust_field_iter {
 154         char event_name[LTTNG_UST_SYM_NAME_LEN];
 155         char field_name[LTTNG_UST_SYM_NAME_LEN];
 156         enum lttng_ust_field_type type;
 157         int loglevel;                           /* event loglevel */
 158         int nowrite;
 159         char padding[LTTNG_UST_FIELD_ITER_PADDING];
 160 } LTTNG_PACKED;
 161
 162 enum lttng_ust_context_type {
 163         LTTNG_UST_CONTEXT_VTID                  = 0,
 164         LTTNG_UST_CONTEXT_VPID                  = 1,
 165         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
 166         LTTNG_UST_CONTEXT_PROCNAME              = 3,
 167         LTTNG_UST_CONTEXT_IP                    = 4,
 168         LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER   = 5,
 169         LTTNG_UST_CONTEXT_CPU_ID                = 6,
 170         LTTNG_UST_CONTEXT_APP_CONTEXT           = 7,
 171         LTTNG_UST_CONTEXT_CGROUP_NS             = 8,
 172         LTTNG_UST_CONTEXT_IPC_NS                = 9,
 173         LTTNG_UST_CONTEXT_MNT_NS                = 10,
 174         LTTNG_UST_CONTEXT_NET_NS                = 11,
 175         LTTNG_UST_CONTEXT_PID_NS                = 12,
 176         LTTNG_UST_CONTEXT_USER_NS               = 13,
 177         LTTNG_UST_CONTEXT_UTS_NS                = 14,
 178         LTTNG_UST_CONTEXT_VUID                  = 15,
 179         LTTNG_UST_CONTEXT_VEUID                 = 16,
 180         LTTNG_UST_CONTEXT_VSUID                 = 17,
 181         LTTNG_UST_CONTEXT_VGID                  = 18,
 182         LTTNG_UST_CONTEXT_VEGID                 = 19,
 183         LTTNG_UST_CONTEXT_VSGID                 = 20,
 184 };
 185
 186 struct lttng_ust_perf_counter_ctx {
 187         uint32_t type;
 188         uint64_t config;
 189         char name[LTTNG_UST_SYM_NAME_LEN];
 190 } LTTNG_PACKED;
 191
 192 #define LTTNG_UST_CONTEXT_PADDING1      16
 193 #define LTTNG_UST_CONTEXT_PADDING2      (LTTNG_UST_SYM_NAME_LEN + 32)
 194 struct lttng_ust_context {
 195         enum lttng_ust_context_type ctx;
 196         char padding[LTTNG_UST_CONTEXT_PADDING1];
 197
 198         union {
 199                 struct lttng_ust_perf_counter_ctx perf_counter;
 200                 struct {
 201                         /* Includes trailing '\0'. */
 202                         uint32_t provider_name_len;
 203                         uint32_t ctx_name_len;
 204                 } app_ctx;
 205                 char padding[LTTNG_UST_CONTEXT_PADDING2];
 206         } u;
 207 } LTTNG_PACKED;
 208
 209 /*
 210  * Tracer channel attributes.
 211  */
 212 #define LTTNG_UST_CHANNEL_ATTR_PADDING  (LTTNG_UST_SYM_NAME_LEN + 32)
 213 struct lttng_ust_channel_attr {
 214         uint64_t subbuf_size;                   /* bytes */
 215         uint64_t num_subbuf;                    /* power of 2 */
 216         int overwrite;                          /* 1: overwrite, 0: discard */
 217         unsigned int switch_timer_interval;     /* usec */
 218         unsigned int read_timer_interval;       /* usec */
 219         enum lttng_ust_output output;           /* splice, mmap */
 220         union {
 221                 struct {
 222                         int64_t blocking_timeout;       /* Blocking timeout (usec) */
 223                 } s;
 224                 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
 225         } u;
 226 } LTTNG_PACKED;
 227
 228 #define LTTNG_UST_TRACEPOINT_ITER_PADDING       16
 229 struct lttng_ust_tracepoint_iter {
 230         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
 231         int loglevel;
 232         char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
 233 } LTTNG_PACKED;
 234
 235 enum lttng_ust_object_type {
 236         LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
 237         LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
 238         LTTNG_UST_OBJECT_TYPE_STREAM = 1,
 239         LTTNG_UST_OBJECT_TYPE_EVENT = 2,
 240         LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
 241         LTTNG_UST_OBJECT_TYPE_TRIGGER_GROUP = 4,
 242         LTTNG_UST_OBJECT_TYPE_TRIGGER = 5,
 243 };
 244
 245 #define LTTNG_UST_OBJECT_DATA_PADDING1  32
 246 #define LTTNG_UST_OBJECT_DATA_PADDING2  (LTTNG_UST_SYM_NAME_LEN + 32)
 247
 248 struct lttng_ust_object_data {
 249         enum lttng_ust_object_type type;
 250         int handle;
 251         uint64_t size;
 252         char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
 253         union {
 254                 struct {
 255                         void *data;
 256                         enum lttng_ust_chan_type type;
 257                         int wakeup_fd;
 258                 } channel;
 259                 struct {
 260                         int shm_fd;
 261                         int wakeup_fd;
 262                         uint32_t stream_nr;
 263                 } stream;
 264                 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
 265         } u;
 266 } LTTNG_PACKED;
 267
 268 enum lttng_ust_calibrate_type {
 269         LTTNG_UST_CALIBRATE_TRACEPOINT,
 270 };
 271
 272 #define LTTNG_UST_CALIBRATE_PADDING1    16
 273 #define LTTNG_UST_CALIBRATE_PADDING2    (LTTNG_UST_SYM_NAME_LEN + 32)
 274 struct lttng_ust_calibrate {
 275         enum lttng_ust_calibrate_type type;     /* type (input) */
 276         char padding[LTTNG_UST_CALIBRATE_PADDING1];
 277
 278         union {
 279                 char padding[LTTNG_UST_CALIBRATE_PADDING2];
 280         } u;
 281 } LTTNG_PACKED;
 282
 283 #define FILTER_BYTECODE_MAX_LEN         65536
 284 #define LTTNG_UST_FILTER_PADDING        32
 285 struct lttng_ust_filter_bytecode {
 286         uint32_t len;
 287         uint32_t reloc_offset;
 288         uint64_t seqnum;
 289         char padding[LTTNG_UST_FILTER_PADDING];
 290         char data[0];
 291 } LTTNG_PACKED;
 292
 293 #define LTTNG_UST_EXCLUSION_PADDING     32
 294 struct lttng_ust_event_exclusion {
 295         uint32_t count;
 296         char padding[LTTNG_UST_EXCLUSION_PADDING];
 297         char names[LTTNG_UST_SYM_NAME_LEN][0];
 298 } LTTNG_PACKED;
 299
 300 #define _UST_CMD(minor)                         (minor)
 301 #define _UST_CMDR(minor, type)                  (minor)
 302 #define _UST_CMDW(minor, type)                  (minor)
 303
 304 /* Handled by object descriptor */
 305 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 306
 307 /* Handled by object cmd */
 308
 309 /* LTTng-UST commands */
 310 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 311 #define LTTNG_UST_TRACER_VERSION                \
 312         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 313 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 314 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 315 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 316 #define LTTNG_UST_TRACEPOINT_FIELD_LIST         _UST_CMD(0x45)
 317
 318 /* Session FD commands */
 319 #define LTTNG_UST_CHANNEL                       \
 320         _UST_CMDW(0x51, struct lttng_ust_channel)
 321 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 322 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 323 #define LTTNG_UST_SESSION_STATEDUMP             _UST_CMD(0x54)
 324
 325 /* Channel FD commands */
 326 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 327 #define LTTNG_UST_EVENT                 \
 328         _UST_CMDW(0x61, struct lttng_ust_event)
 329
 330 /* Event and Channel FD commands */
 331 #define LTTNG_UST_CONTEXT                       \
 332         _UST_CMDW(0x70, struct lttng_ust_context)
 333 #define LTTNG_UST_FLUSH_BUFFER                  \
 334         _UST_CMD(0x71)
 335
 336 /* Event, Channel and Session commands */
 337 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 338 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 339
 340 /* Tracepoint list commands */
 341 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 342 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET     _UST_CMD(0x91)
 343
 344 /* Event FD commands */
 345 #define LTTNG_UST_FILTER                        _UST_CMD(0xA0)
 346 #define LTTNG_UST_EXCLUSION                     _UST_CMD(0xA1)
 347
 348 /* Trigger commands */
 349 #define LTTNG_UST_TRIGGER_GROUP_CREATE          _UST_CMD(0xB0)
 350 #define LTTNG_UST_TRIGGER_CREATE                \
 351         _UST_CMDW(0xB1, struct lttng_ust_trigger)
 352
 353 #define LTTNG_UST_ROOT_HANDLE   0
 354
 355 struct lttng_ust_obj;
 356
 357 union ust_args {
 358         struct {
 359                 void *chan_data;
 360                 int wakeup_fd;
 361         } channel;
 362         struct {
 363                 int shm_fd;
 364                 int wakeup_fd;
 365         } stream;
 366         struct {
 367                 struct lttng_ust_field_iter entry;
 368         } field_list;
 369         struct {
 370                 char *ctxname;
 371         } app_context;
 372         struct {
 373                 int trigger_notif_fd;
 374         } trigger_handle;
 375 };
 376
 377 struct lttng_ust_objd_ops {
 378         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 379                 union ust_args *args, void *owner);
 380         int (*release)(int objd);
 381 };
 382
 383 /* Create root handle. Always ID 0. */
 384 int lttng_abi_create_root_handle(void);
 385
 386 const struct lttng_ust_objd_ops *objd_ops(int id);
 387 int lttng_ust_objd_unref(int id, int is_owner);
 388
 389 void lttng_ust_abi_exit(void);
 390 void lttng_ust_events_exit(void);
 391 void lttng_ust_objd_table_owner_cleanup(void *owner);
 392
 393 #endif /* _LTTNG_UST_ABI_H */