Move LTTng-UST buffer ownership from application to consumer
[lttng-tools.git] / src / bin / lttng-sessiond / lttng-ust-abi.h
index c60535d4178845c53677b2b583a31b19f05c754c..4ef04653cc517bebc3ec87890f03bc9dcc975622 100644 (file)
@@ -4,12 +4,9 @@
 /*
  * lttng/ust-abi.h
  *
- * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
  * LTTng-UST ABI header
  *
- * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
- * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+ * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 #include <stdint.h>
+#include <lttng/ust-compiler.h>
 
 #define LTTNG_UST_SYM_NAME_LEN 256
 
+/* Version for comm protocol between sessiond and ust */
 #define LTTNG_UST_COMM_VERSION_MAJOR           2
-#define LTTNG_UST_COMM_VERSION_MINOR           0
+#define LTTNG_UST_COMM_VERSION_MINOR           1
+
+/* Version for ABI between liblttng-ust, sessiond, consumerd */
+#define LTTNG_UST_INTERNAL_MAJOR_VERSION       3
+#define LTTNG_UST_INTERNAL_MINOR_VERSION       0
+#define LTTNG_UST_INTERNAL_PATCHLEVEL_VERSION  0
 
 enum lttng_ust_instrumentation {
        LTTNG_UST_TRACEPOINT            = 0,
@@ -45,32 +57,42 @@ enum lttng_ust_output {
        LTTNG_UST_MMAP          = 0,
 };
 
+enum lttng_ust_chan_type {
+       LTTNG_UST_CHAN_PER_CPU = 0,
+       LTTNG_UST_CHAN_METADATA = 1,
+};
+
 struct lttng_ust_tracer_version {
        uint32_t major;
        uint32_t minor;
        uint32_t patchlevel;
-};
+} LTTNG_PACKED;
 
 #define LTTNG_UST_CHANNEL_PADDING      LTTNG_UST_SYM_NAME_LEN + 32
+/*
+ * Given that the consumerd is limited to 64k file descriptors, we
+ * cannot expect much more than 1MB channel structure size. This size is
+ * depends on the number of streams within a channel, which depends on
+ * the number of possible CPUs on the system.
+ */
+#define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
 struct lttng_ust_channel {
-       int overwrite;                          /* 1: overwrite, 0: discard */
-       uint64_t subbuf_size;                   /* in bytes */
-       uint64_t num_subbuf;
-       unsigned int switch_timer_interval;     /* usecs */
-       unsigned int read_timer_interval;       /* usecs */
-       enum lttng_ust_output output;           /* output mode */
+       uint64_t len;
+       enum lttng_ust_chan_type type;
        char padding[LTTNG_UST_CHANNEL_PADDING];
-};
+       char data[];    /* variable sized data */
+} LTTNG_PACKED;
 
-#define LTTNG_UST_STREAM_PADDING1      16
-#define LTTNG_UST_STREAM_PADDING2      LTTNG_UST_SYM_NAME_LEN + 32
+#define LTTNG_UST_STREAM_PADDING1      LTTNG_UST_SYM_NAME_LEN + 32
 struct lttng_ust_stream {
+       uint64_t len;           /* shm len */
+       uint32_t stream_nr;     /* stream number */
        char padding[LTTNG_UST_STREAM_PADDING1];
-
-       union {
-               char padding[LTTNG_UST_STREAM_PADDING2];
-       } u;
-};
+       /*
+        * shm_fd and wakeup_fd are send over unix socket as file
+        * descriptors after this structure.
+        */
+} LTTNG_PACKED;
 
 #define LTTNG_UST_EVENT_PADDING1       16
 #define LTTNG_UST_EVENT_PADDING2       LTTNG_UST_SYM_NAME_LEN + 32
@@ -86,7 +108,7 @@ struct lttng_ust_event {
        union {
                char padding[LTTNG_UST_EVENT_PADDING2];
        } u;
-};
+} LTTNG_PACKED;
 
 enum lttng_ust_field_type {
        LTTNG_UST_FIELD_OTHER                   = 0,
@@ -96,14 +118,15 @@ enum lttng_ust_field_type {
        LTTNG_UST_FIELD_STRING                  = 4,
 };
 
-#define LTTNG_UST_FIELD_ITER_PADDING           LTTNG_UST_SYM_NAME_LEN + 32
+#define LTTNG_UST_FIELD_ITER_PADDING           LTTNG_UST_SYM_NAME_LEN + 28
 struct lttng_ust_field_iter {
        char event_name[LTTNG_UST_SYM_NAME_LEN];
        char field_name[LTTNG_UST_SYM_NAME_LEN];
        enum lttng_ust_field_type type;
        int loglevel;                           /* event loglevel */
+       int nowrite;
        char padding[LTTNG_UST_FIELD_ITER_PADDING];
-};
+} LTTNG_PACKED;
 
 enum lttng_ust_context_type {
        LTTNG_UST_CONTEXT_VTID                  = 0,
@@ -121,37 +144,56 @@ struct lttng_ust_context {
        union {
                char padding[LTTNG_UST_CONTEXT_PADDING2];
        } u;
-};
+} LTTNG_PACKED;
 
 /*
  * Tracer channel attributes.
  */
 #define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32
 struct lttng_ust_channel_attr {
-       int overwrite;                          /* 1: overwrite, 0: discard */
        uint64_t subbuf_size;                   /* bytes */
        uint64_t num_subbuf;                    /* power of 2 */
+       int overwrite;                          /* 1: overwrite, 0: discard */
        unsigned int switch_timer_interval;     /* usec */
        unsigned int read_timer_interval;       /* usec */
        enum lttng_ust_output output;           /* splice, mmap */
        char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
-};
+} LTTNG_PACKED;
 
 #define LTTNG_UST_TRACEPOINT_ITER_PADDING      16
 struct lttng_ust_tracepoint_iter {
        char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
        int loglevel;
        char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
+} LTTNG_PACKED;
+
+enum lttng_ust_object_type {
+       LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
+       LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
+       LTTNG_UST_OBJECT_TYPE_STREAM = 1,
 };
 
-#define LTTNG_UST_OBJECT_DATA_PADDING          LTTNG_UST_SYM_NAME_LEN + 32
+#define LTTNG_UST_OBJECT_DATA_PADDING1         32
+#define LTTNG_UST_OBJECT_DATA_PADDING2         LTTNG_UST_SYM_NAME_LEN + 32
+
 struct lttng_ust_object_data {
+       enum lttng_ust_object_type type;
        int handle;
-       int shm_fd;
-       int wait_fd;
-       uint64_t memory_map_size;
-       char padding[LTTNG_UST_OBJECT_DATA_PADDING];
-};
+       uint64_t size;
+       char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
+       union {
+               struct {
+                       void *data;
+                       enum lttng_ust_chan_type type;
+               } channel;
+               struct {
+                       int shm_fd;
+                       int wakeup_fd;
+                       uint32_t stream_nr;
+               } stream;
+               char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
+       } u;
+} LTTNG_PACKED;
 
 enum lttng_ust_calibrate_type {
        LTTNG_UST_CALIBRATE_TRACEPOINT,
@@ -166,7 +208,17 @@ struct lttng_ust_calibrate {
        union {
                char padding[LTTNG_UST_CALIBRATE_PADDING2];
        } u;
-};
+} LTTNG_PACKED;
+
+#define FILTER_BYTECODE_MAX_LEN                65536
+#define LTTNG_UST_FILTER_PADDING       32
+struct lttng_ust_filter_bytecode {
+       uint32_t len;
+       uint32_t reloc_offset;
+       uint64_t seqnum;
+       char padding[LTTNG_UST_FILTER_PADDING];
+       char data[0];
+} LTTNG_PACKED;
 
 #define _UST_CMD(minor)                                (minor)
 #define _UST_CMDR(minor, type)                 (minor)
@@ -213,26 +265,29 @@ struct lttng_ust_calibrate {
 #define LTTNG_UST_TRACEPOINT_LIST_GET          _UST_CMD(0x90)
 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET    _UST_CMD(0x91)
 
+/* Event FD commands */
+#define LTTNG_UST_FILTER                       _UST_CMD(0xA0)
+
 #define LTTNG_UST_ROOT_HANDLE  0
 
 struct lttng_ust_obj;
 
 union ust_args {
        struct {
-               int *shm_fd;
-               int *wait_fd;
-               uint64_t *memory_map_size;
+               void *chan_data;
        } channel;
        struct {
-               int *shm_fd;
-               int *wait_fd;
-               uint64_t *memory_map_size;
+               int shm_fd;
+               int wakeup_fd;
        } stream;
+       struct {
+               struct lttng_ust_field_iter entry;
+       } field_list;
 };
 
 struct lttng_ust_objd_ops {
        long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
-               union ust_args *args);
+               union ust_args *args, void *owner);
        int (*release)(int objd);
 };
 
@@ -244,5 +299,6 @@ int lttng_ust_objd_unref(int id);
 
 void lttng_ust_abi_exit(void);
 void lttng_ust_events_exit(void);
+void lttng_ust_objd_table_owner_cleanup(void *owner);
 
 #endif /* _LTTNG_UST_ABI_H */
This page took 0.026234 seconds and 4 git commands to generate.