Move to kernel style SPDX license identifiers
[lttng-ust.git] / include / lttng / ust-abi.h
index f76d2a9fa5c6b25c3d99b96a21314eb1ed86d227..1c11f371f6a5ce328ebcef8ef16885e95e5b8cc3 100644 (file)
@@ -1,35 +1,21 @@
-#ifndef _LTTNG_UST_ABI_H
-#define _LTTNG_UST_ABI_H
-
 /*
- * lttng/ust-abi.h
- *
- * LTTng-UST ABI header
- *
- * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * SPDX-License-Identifier: MIT
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
- * 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.
+ * LTTng-UST ABI header
  */
 
+#ifndef _LTTNG_UST_ABI_H
+#define _LTTNG_UST_ABI_H
+
 #include <stdint.h>
 #include <lttng/ust-compiler.h>
 
+#ifndef LTTNG_PACKED
+#error "LTTNG_PACKED should be defined"
+#endif
+
 #ifndef __ust_stringify
 #define __ust_stringify1(x)    #x
 #define __ust_stringify(x)     __ust_stringify1(x)
@@ -42,8 +28,9 @@
 #define LTTNG_UST_COMM_MAGIC                   0xC57C57C5
 
 /* Version for ABI between liblttng-ust, sessiond, consumerd */
-#define LTTNG_UST_ABI_MAJOR_VERSION            7
-#define LTTNG_UST_ABI_MINOR_VERSION            2
+#define LTTNG_UST_ABI_MAJOR_VERSION                    9
+#define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE  8
+#define LTTNG_UST_ABI_MINOR_VERSION            0
 
 enum lttng_ust_instrumentation {
        LTTNG_UST_TRACEPOINT            = 0,
@@ -98,7 +85,41 @@ struct lttng_ust_stream {
         */
 } LTTNG_PACKED;
 
-#define LTTNG_UST_EVENT_PADDING1       16
+
+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_32 = 0,
+       LTTNG_UST_COUNTER_BITNESS_64 = 1,
+};
+
+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_UST_EVENT_PADDING1       8
 #define LTTNG_UST_EVENT_PADDING2       (LTTNG_UST_SYM_NAME_LEN + 32)
 struct lttng_ust_event {
        enum lttng_ust_instrumentation instrumentation;
@@ -106,6 +127,7 @@ struct lttng_ust_event {
 
        enum lttng_ust_loglevel_type loglevel_type;
        int loglevel;   /* value, -1: all */
+       uint64_t token;                         /* User-provided token */
        char padding[LTTNG_UST_EVENT_PADDING1];
 
        /* Per instrumentation type configuration */
@@ -114,6 +136,41 @@ struct lttng_ust_event {
        } u;
 } LTTNG_PACKED;
 
+#define LTTNG_UST_EVENT_NOTIFIER_PADDING       32
+struct lttng_ust_event_notifier {
+       struct lttng_ust_event event;
+       uint64_t error_counter_index;
+       char padding[LTTNG_UST_EVENT_NOTIFIER_PADDING];
+} LTTNG_PACKED;
+
+#define LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
+struct lttng_ust_event_notifier_notification {
+       uint64_t token;
+       uint16_t capture_buf_size;
+       char padding[LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING];
+} 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,
@@ -141,6 +198,20 @@ enum lttng_ust_context_type {
        LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER   = 5,
        LTTNG_UST_CONTEXT_CPU_ID                = 6,
        LTTNG_UST_CONTEXT_APP_CONTEXT           = 7,
+       LTTNG_UST_CONTEXT_CGROUP_NS             = 8,
+       LTTNG_UST_CONTEXT_IPC_NS                = 9,
+       LTTNG_UST_CONTEXT_MNT_NS                = 10,
+       LTTNG_UST_CONTEXT_NET_NS                = 11,
+       LTTNG_UST_CONTEXT_PID_NS                = 12,
+       LTTNG_UST_CONTEXT_USER_NS               = 13,
+       LTTNG_UST_CONTEXT_UTS_NS                = 14,
+       LTTNG_UST_CONTEXT_VUID                  = 15,
+       LTTNG_UST_CONTEXT_VEUID                 = 16,
+       LTTNG_UST_CONTEXT_VSUID                 = 17,
+       LTTNG_UST_CONTEXT_VGID                  = 18,
+       LTTNG_UST_CONTEXT_VEGID                 = 19,
+       LTTNG_UST_CONTEXT_VSGID                 = 20,
+       LTTNG_UST_CONTEXT_TIME_NS               = 21,
 };
 
 struct lttng_ust_perf_counter_ctx {
@@ -177,7 +248,12 @@ struct lttng_ust_channel_attr {
        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];
+       union {
+               struct {
+                       int64_t blocking_timeout;       /* Blocking timeout (usec) */
+               } s;
+               char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
+       } u;
 } LTTNG_PACKED;
 
 #define LTTNG_UST_TRACEPOINT_ITER_PADDING      16
@@ -193,6 +269,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_EVENT_NOTIFIER_GROUP = 4,
+       LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER = 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
@@ -214,6 +295,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;
@@ -243,6 +334,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;
@@ -267,26 +368,27 @@ struct lttng_ust_event_exclusion {
 #define LTTNG_UST_WAIT_QUIESCENT               _UST_CMD(0x43)
 #define LTTNG_UST_REGISTER_DONE                        _UST_CMD(0x44)
 #define LTTNG_UST_TRACEPOINT_FIELD_LIST                _UST_CMD(0x45)
+#define LTTNG_UST_EVENT_NOTIFIER_GROUP_CREATE  _UST_CMD(0x46)
 
-/* Session FD commands */
+/* Session commands */
 #define LTTNG_UST_CHANNEL                      \
        _UST_CMDW(0x51, struct lttng_ust_channel)
 #define LTTNG_UST_SESSION_START                        _UST_CMD(0x52)
 #define LTTNG_UST_SESSION_STOP                 _UST_CMD(0x53)
 #define LTTNG_UST_SESSION_STATEDUMP            _UST_CMD(0x54)
 
-/* Channel FD commands */
+/* Channel commands */
 #define LTTNG_UST_STREAM                       _UST_CMD(0x60)
 #define LTTNG_UST_EVENT                        \
        _UST_CMDW(0x61, struct lttng_ust_event)
 
-/* Event and Channel FD commands */
+/* Event and channel commands */
 #define LTTNG_UST_CONTEXT                      \
        _UST_CMDW(0x70, struct lttng_ust_context)
 #define LTTNG_UST_FLUSH_BUFFER                 \
        _UST_CMD(0x71)
 
-/* Event, Channel and Session commands */
+/* Event, event notifier, channel and session commands */
 #define LTTNG_UST_ENABLE                       _UST_CMD(0x80)
 #define LTTNG_UST_DISABLE                      _UST_CMD(0x81)
 
@@ -294,10 +396,27 @@ struct lttng_ust_event_exclusion {
 #define LTTNG_UST_TRACEPOINT_LIST_GET          _UST_CMD(0x90)
 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET    _UST_CMD(0x91)
 
-/* Event FD commands */
+/* Event and event notifier commands */
 #define LTTNG_UST_FILTER                       _UST_CMD(0xA0)
 #define LTTNG_UST_EXCLUSION                    _UST_CMD(0xA1)
 
+/* Event notifier group commands */
+#define LTTNG_UST_EVENT_NOTIFIER_CREATE                \
+       _UST_CMDW(0xB0, struct lttng_ust_event_notifier)
+
+/* Event notifier commands */
+#define LTTNG_UST_CAPTURE                      _UST_CMD(0xB6)
+
+/* Session and event notifier group commands */
+#define LTTNG_UST_COUNTER                      \
+       _UST_CMDW(0xC0, struct lttng_ust_counter)
+
+/* Counter commands */
+#define LTTNG_UST_COUNTER_GLOBAL               \
+       _UST_CMDW(0xD0, struct lttng_ust_counter_global)
+#define LTTNG_UST_COUNTER_CPU                  \
+       _UST_CMDW(0xD1, struct lttng_ust_counter_cpu)
+
 #define LTTNG_UST_ROOT_HANDLE  0
 
 struct lttng_ust_obj;
@@ -317,6 +436,15 @@ union ust_args {
        struct {
                char *ctxname;
        } app_context;
+       struct {
+               int event_notifier_notif_fd;
+       } event_notifier_handle;
+       struct {
+               void *counter_data;
+       } counter;
+       struct {
+               int shm_fd;
+       } counter_shm;
 };
 
 struct lttng_ust_objd_ops {
This page took 0.026882 seconds and 4 git commands to generate.