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  * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * LTTng-UST ABI header
  10  *
  11  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
  12  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
  13  *
  14  * Permission is hereby granted to use or copy this program
  15  * for any purpose,  provided the above notices are retained on all copies.
  16  * Permission to modify the code and to distribute modified code is granted,
  17  * provided the above notices are retained, and a notice that the code was
  18  * modified is included with the above copyright notice.
  19  */
  20
  21 #include <stdint.h>
  22
  23 #define LTTNG_UST_SYM_NAME_LEN  256
  24
  25 #define LTTNG_UST_COMM_VERSION_MAJOR            0
  26 #define LTTNG_UST_COMM_VERSION_MINOR            1
  27
  28 enum lttng_ust_instrumentation {
  29         LTTNG_UST_TRACEPOINT            = 0,
  30         LTTNG_UST_PROBE                 = 1,
  31         LTTNG_UST_FUNCTION              = 2,
  32         LTTNG_UST_TRACEPOINT_LOGLEVEL   = 3,
  33 };
  34
  35 enum lttng_ust_output {
  36         LTTNG_UST_MMAP          = 0,
  37 };
  38
  39 struct lttng_ust_tracer_version {
  40         uint32_t major;
  41         uint32_t minor;
  42         uint32_t patchlevel;
  43 };
  44
  45 struct lttng_ust_channel {
  46         int overwrite;                          /* 1: overwrite, 0: discard */
  47         uint64_t subbuf_size;                   /* in bytes */
  48         uint64_t num_subbuf;
  49         unsigned int switch_timer_interval;     /* usecs */
  50         unsigned int read_timer_interval;       /* usecs */
  51         enum lttng_ust_output output;           /* output mode */
  52 };
  53
  54 struct lttng_ust_stream {
  55 };
  56
  57 struct lttng_ust_event {
  58         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
  59         enum lttng_ust_instrumentation instrumentation;
  60         /* Per instrumentation type configuration */
  61         union {
  62         } u;
  63 };
  64
  65 enum lttng_ust_context_type {
  66         LTTNG_UST_CONTEXT_VTID                  = 0,
  67         LTTNG_UST_CONTEXT_VPID                  = 1,
  68         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
  69         LTTNG_UST_CONTEXT_PROCNAME              = 3,
  70 };
  71
  72 struct lttng_ust_context {
  73         enum lttng_ust_context_type ctx;
  74         union {
  75         } u;
  76 };
  77
  78 /*
  79  * Tracer channel attributes.
  80  */
  81 struct lttng_ust_channel_attr {
  82         int overwrite;                          /* 1: overwrite, 0: discard */
  83         uint64_t subbuf_size;                   /* bytes */
  84         uint64_t num_subbuf;                    /* power of 2 */
  85         unsigned int switch_timer_interval;     /* usec */
  86         unsigned int read_timer_interval;       /* usec */
  87         enum lttng_ust_output output;           /* splice, mmap */
  88 };
  89
  90 struct lttng_ust_tracepoint_iter {
  91         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
  92         char loglevel[LTTNG_UST_SYM_NAME_LEN];  /* loglevel */
  93         int64_t loglevel_value;
  94 };
  95
  96 struct lttng_ust_object_data {
  97         int handle;
  98         int shm_fd;
  99         int wait_fd;
 100         uint64_t memory_map_size;
 101 };
 102
 103 #define _UST_CMD(minor)                         (minor)
 104 #define _UST_CMDR(minor, type)                  (minor)
 105 #define _UST_CMDW(minor, type)                  (minor)
 106
 107 /* Handled by object descriptor */
 108 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 109
 110 /* Handled by object cmd */
 111
 112 /* LTTng-UST commands */
 113 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 114 #define LTTNG_UST_TRACER_VERSION                \
 115         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 116 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 117 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 118 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 119
 120 /* Session FD commands */
 121 #define LTTNG_UST_METADATA                      \
 122         _UST_CMDW(0x50, struct lttng_ust_channel)
 123 #define LTTNG_UST_CHANNEL                       \
 124         _UST_CMDW(0x51, struct lttng_ust_channel)
 125 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 126 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 127
 128 /* Channel FD commands */
 129 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 130 #define LTTNG_UST_EVENT                 \
 131         _UST_CMDW(0x61, struct lttng_ust_event)
 132
 133 /* Event and Channel FD commands */
 134 #define LTTNG_UST_CONTEXT                       \
 135         _UST_CMDW(0x70, struct lttng_ust_context)
 136 #define LTTNG_UST_FLUSH_BUFFER                  \
 137         _UST_CMD(0x71)
 138
 139 /* Event, Channel and Session commands */
 140 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 141 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 142
 143 /* Tracepoint list commands */
 144 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 145
 146 #define LTTNG_UST_ROOT_HANDLE   0
 147
 148 struct lttng_ust_obj;
 149
 150 union ust_args {
 151         struct {
 152                 int *shm_fd;
 153                 int *wait_fd;
 154                 uint64_t *memory_map_size;
 155         } channel;
 156         struct {
 157                 int *shm_fd;
 158                 int *wait_fd;
 159                 uint64_t *memory_map_size;
 160         } stream;
 161 };
 162
 163 struct lttng_ust_objd_ops {
 164         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 165                 union ust_args *args);
 166         int (*release)(int objd);
 167 };
 168
 169 /* Create root handle. Always ID 0. */
 170 int lttng_abi_create_root_handle(void);
 171
 172 const struct lttng_ust_objd_ops *objd_ops(int id);
 173 int lttng_ust_objd_unref(int id);
 174
 175 void lttng_ust_abi_exit(void);
 176 void lttng_ust_events_exit(void);
 177
 178 #endif /* _LTTNG_UST_ABI_H */