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