SoW-2020-0002: Trace Hit Counters: Implement key-addressed counters in shared memory...

[deliverable/lttng-ust.git] / include / lttng / ust-abi.h

diff --git a/include/lttng/ust-abi.h b/include/lttng/ust-abi.h
index 8bf77f64bb036106cc055d97fa2d0acb678d55f3..8ec51baf4eaf0c0dcd074f98bb85e0cd5f45c838 100644 (file)
--- a/include/lttng/ust-abi.h
+++ b/include/lttng/ust-abi.h
@@ -103,6 +103,64 @@ struct lttng_ust_stream {
         */
 } LTTNG_PACKED;
 
+#define LTTNG_UST_TRIGGER_PADDING1     16
+#define LTTNG_UST_TRIGGER_PADDING2     (LTTNG_UST_SYM_NAME_LEN + 32)
+struct lttng_ust_trigger {
+       uint64_t id;
+       uint64_t error_counter_index;
+       enum lttng_ust_instrumentation instrumentation;
+       char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
+
+       enum lttng_ust_loglevel_type loglevel_type;
+       int loglevel;   /* value, -1: all */
+       char padding[LTTNG_UST_TRIGGER_PADDING1];
+
+       /* Per instrumentation type configuration */
+       union {
+               char padding[LTTNG_UST_TRIGGER_PADDING2];
+       } u;
+} LTTNG_PACKED;
+
+enum lttng_ust_counter_arithmetic {
+    LTTNG_UST_COUNTER_ARITHMETIC_MODULAR    = 0,
+    LTTNG_UST_COUNTER_ARITHMETIC_SATURATION = 1,
+};
+
+enum lttng_ust_counter_bitness {
+    LTTNG_UST_COUNTER_BITNESS_32BITS = 4,
+    LTTNG_UST_COUNTER_BITNESS_64BITS = 8,
+};
+
+struct lttng_ust_counter_dimension {
+       uint64_t size;
+       uint64_t underflow_index;
+       uint64_t overflow_index;
+       uint8_t has_underflow;
+       uint8_t has_overflow;
+} LTTNG_PACKED;
+
+#define LTTNG_UST_COUNTER_DIMENSION_MAX 8
+struct lttng_ust_counter_conf {
+       uint32_t arithmetic;    /* enum lttng_ust_counter_arithmetic */
+       uint32_t bitness;       /* enum lttng_ust_counter_bitness */
+       uint32_t number_dimensions;
+       int64_t global_sum_step;
+       struct lttng_ust_counter_dimension dimensions[LTTNG_UST_COUNTER_DIMENSION_MAX];
+} LTTNG_PACKED;
+
+struct lttng_ust_counter_value {
+       uint32_t number_dimensions;
+       uint64_t dimension_indexes[LTTNG_UST_COUNTER_DIMENSION_MAX];
+       int64_t value;
+} LTTNG_PACKED;
+
+#define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
+struct lttng_ust_trigger_notification {
+       uint64_t id;
+       uint16_t capture_buf_size;
+       char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
+} LTTNG_PACKED;
+
 #define LTTNG_UST_EVENT_PADDING1       16
 #define LTTNG_UST_EVENT_PADDING2       (LTTNG_UST_SYM_NAME_LEN + 32)
 struct lttng_ust_event {
@@ -119,6 +177,27 @@ struct lttng_ust_event {
        } u;
 } LTTNG_PACKED;
 
+#define LTTNG_UST_COUNTER_PADDING1     (LTTNG_UST_SYM_NAME_LEN + 32)
+#define LTTNG_UST_COUNTER_DATA_MAX_LEN 4096U
+struct lttng_ust_counter {
+       uint64_t len;
+       char padding[LTTNG_UST_COUNTER_PADDING1];
+       char data[];    /* variable sized data */
+} LTTNG_PACKED;
+
+#define LTTNG_UST_COUNTER_GLOBAL_PADDING1      (LTTNG_UST_SYM_NAME_LEN + 32)
+struct lttng_ust_counter_global {
+       uint64_t len;           /* shm len */
+       char padding[LTTNG_UST_COUNTER_GLOBAL_PADDING1];
+} LTTNG_PACKED;
+
+#define LTTNG_UST_COUNTER_CPU_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
+struct lttng_ust_counter_cpu {
+       uint64_t len;           /* shm len */
+       uint32_t cpu_nr;
+       char padding[LTTNG_UST_COUNTER_CPU_PADDING1];
+} LTTNG_PACKED;
+
 enum lttng_ust_field_type {
        LTTNG_UST_FIELD_OTHER                   = 0,
        LTTNG_UST_FIELD_INTEGER                 = 1,
@@ -217,6 +296,11 @@ enum lttng_ust_object_type {
        LTTNG_UST_OBJECT_TYPE_STREAM = 1,
        LTTNG_UST_OBJECT_TYPE_EVENT = 2,
        LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
+       LTTNG_UST_OBJECT_TYPE_TRIGGER_GROUP = 4,
+       LTTNG_UST_OBJECT_TYPE_TRIGGER = 5,
+       LTTNG_UST_OBJECT_TYPE_COUNTER = 6,
+       LTTNG_UST_OBJECT_TYPE_COUNTER_GLOBAL = 7,
+       LTTNG_UST_OBJECT_TYPE_COUNTER_CPU = 8,
 };
 
 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
@@ -238,6 +322,16 @@ struct lttng_ust_object_data {
                        int wakeup_fd;
                        uint32_t stream_nr;
                } stream;
+               struct {
+                       void *data;
+               } counter;
+               struct {
+                       int shm_fd;
+               } counter_global;
+               struct {
+                       int shm_fd;
+                       uint32_t cpu_nr;
+               } counter_cpu;
                char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
        } u;
 } LTTNG_PACKED;
@@ -267,6 +361,16 @@ struct lttng_ust_filter_bytecode {
        char data[0];
 } LTTNG_PACKED;
 
+#define CAPTURE_BYTECODE_MAX_LEN       65536
+#define LTTNG_UST_CAPTURE_PADDING      32
+struct lttng_ust_capture_bytecode {
+       uint32_t len;
+       uint32_t reloc_offset;
+       uint64_t seqnum;
+       char padding[LTTNG_UST_CAPTURE_PADDING];
+       char data[0];
+} LTTNG_PACKED;
+
 #define LTTNG_UST_EXCLUSION_PADDING    32
 struct lttng_ust_event_exclusion {
        uint32_t count;
@@ -322,6 +426,20 @@ struct lttng_ust_event_exclusion {
 #define LTTNG_UST_FILTER                       _UST_CMD(0xA0)
 #define LTTNG_UST_EXCLUSION                    _UST_CMD(0xA1)
 
+/* Trigger commands */
+#define LTTNG_UST_TRIGGER_GROUP_CREATE         _UST_CMD(0xB0)
+#define LTTNG_UST_TRIGGER_CREATE               \
+       _UST_CMDW(0xB1, struct lttng_ust_trigger)
+#define LTTNG_UST_CAPTURE                      _UST_CMD(0xB2)
+
+/* Session and Trigger group FD commands */
+#define LTTNG_UST_COUNTER                      \
+       _UST_CMDW(0xB3, struct lttng_ust_counter)
+#define LTTNG_UST_COUNTER_GLOBAL               \
+       _UST_CMDW(0xB4, struct lttng_ust_counter_global)
+#define LTTNG_UST_COUNTER_CPU                  \
+       _UST_CMDW(0xB5, struct lttng_ust_counter_cpu)
+
 #define LTTNG_UST_ROOT_HANDLE  0
 
 struct lttng_ust_obj;
@@ -341,6 +459,15 @@ union ust_args {
        struct {
                char *ctxname;
        } app_context;
+       struct {
+               int trigger_notif_fd;
+       } trigger_handle;
+       struct {
+               void *counter_data;
+       } counter;
+       struct {
+               int shm_fd;
+       } counter_shm;
 };
 
 struct lttng_ust_objd_ops {