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  128
  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 };
  33
  34 enum lttng_ust_output {
  35         LTTNG_UST_MMAP          = 0,
  36 };
  37
  38 struct lttng_ust_tracer_version {
  39         uint32_t major;
  40         uint32_t minor;
  41         uint32_t patchlevel;
  42 };
  43
  44 struct lttng_ust_channel {
  45         int overwrite;                          /* 1: overwrite, 0: discard */
  46         uint64_t subbuf_size;                   /* in bytes */
  47         uint64_t num_subbuf;
  48         unsigned int switch_timer_interval;     /* usecs */
  49         unsigned int read_timer_interval;       /* usecs */
  50         enum lttng_ust_output output;           /* output mode */
  51         /* The following fields are used internally within UST. */
  52         int shm_fd;
  53         int wait_fd;
  54         uint64_t memory_map_size;
  55 };
  56
  57 /*
  58  * This structure is only used internally within UST. It is not per-se
  59  * part of the communication between sessiond and UST.
  60  */
  61 struct lttng_ust_stream {
  62         int shm_fd;
  63         int wait_fd;
  64         uint64_t memory_map_size;
  65 };
  66
  67 struct lttng_ust_event {
  68         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
  69         enum lttng_ust_instrumentation instrumentation;
  70         /* Per instrumentation type configuration */
  71         union {
  72         } u;
  73 };
  74
  75 enum lttng_ust_context_type {
  76         LTTNG_UST_CONTEXT_VTID                  = 0,
  77         LTTNG_UST_CONTEXT_VPID                  = 1,
  78         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
  79         LTTNG_UST_CONTEXT_PROCNAME              = 3,
  80 };
  81
  82 struct lttng_ust_context {
  83         enum lttng_ust_context_type ctx;
  84         union {
  85         } u;
  86 };
  87
  88 /*
  89  * Tracer channel attributes.
  90  */
  91 struct lttng_ust_channel_attr {
  92         int overwrite;                          /* 1: overwrite, 0: discard */
  93         uint64_t subbuf_size;                   /* bytes */
  94         uint64_t num_subbuf;                    /* power of 2 */
  95         unsigned int switch_timer_interval;     /* usec */
  96         unsigned int read_timer_interval;       /* usec */
  97         enum lttng_ust_output output;           /* splice, mmap */
  98 };
  99
 100 struct lttng_ust_object_data {
 101         int handle;
 102         int shm_fd;
 103         int wait_fd;
 104         uint64_t memory_map_size;
 105 };
 106
 107 #define _UST_CMD(minor)                         (minor)
 108 #define _UST_CMDR(minor, type)                  (minor)
 109 #define _UST_CMDW(minor, type)                  (minor)
 110
 111 /* Handled by object descriptor */
 112 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 113
 114 /* Handled by object cmd */
 115
 116 /* LTTng-UST commands */
 117 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 118 #define LTTNG_UST_TRACER_VERSION                \
 119         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 120 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 121 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 122 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 123
 124 /* Session FD commands */
 125 #define LTTNG_UST_METADATA                      \
 126         _UST_CMDW(0x50, struct lttng_ust_channel)
 127 #define LTTNG_UST_CHANNEL                       \
 128         _UST_CMDW(0x51, struct lttng_ust_channel)
 129 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 130 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 131
 132 /* Channel FD commands */
 133 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 134 #define LTTNG_UST_EVENT                 \
 135         _UST_CMDW(0x61, struct lttng_ust_event)
 136
 137 /* Event and Channel FD commands */
 138 #define LTTNG_UST_CONTEXT                       \
 139         _UST_CMDW(0x70, struct lttng_ust_context)
 140 #define LTTNG_UST_FLUSH_BUFFER                  \
 141         _UST_CMD(0x71)
 142
 143 /* Event, Channel and Session commands */
 144 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 145 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 146
 147 /* Tracepoint list commands */
 148 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 149
 150 #define LTTNG_UST_ROOT_HANDLE   0
 151
 152 struct lttng_ust_obj;
 153
 154 struct lttng_ust_objd_ops {
 155         long (*cmd)(int objd, unsigned int cmd, unsigned long arg);
 156         int (*release)(int objd);
 157 };
 158
 159 /* Create root handle. Always ID 0. */
 160 int lttng_abi_create_root_handle(void);
 161
 162 const struct lttng_ust_objd_ops *objd_ops(int id);
 163 int lttng_ust_objd_unref(int id);
 164
 165 void lttng_ust_abi_exit(void);
 166 void lttng_ust_events_exit(void);
 167
 168 #endif /* _LTTNG_UST_ABI_H */