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