Implement consumer ring buffer position sampling
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
index b98e4f747299c54c652f5b3dd2a83a6237d19979..f6179f31dc5132838516b5c75021d32eeecd6ada 100644 (file)
@@ -6,12 +6,12 @@
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2 only,
  * as published by the Free Software Foundation.
- * 
+ *
  * This program is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  * more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #ifndef _LTTNG_SESSIOND_COMM_H
 #define _LTTNG_SESSIOND_COMM_H
 
-#define _GNU_SOURCE
 #include <limits.h>
 #include <lttng/lttng.h>
 #include <lttng/snapshot-internal.h>
+#include <lttng/save-internal.h>
+#include <lttng/channel-internal.h>
+#include <lttng/trigger/trigger-internal.h>
 #include <common/compat/socket.h>
 #include <common/uri.h>
 #include <common/defaults.h>
@@ -40,7 +42,7 @@
 
 #include "inet.h"
 #include "inet6.h"
-#include "unix.h"
+#include <common/unix.h>
 
 /* Queue size of listen(2) */
 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
 enum lttcomm_sessiond_command {
        /* Tracer command */
        LTTNG_ADD_CONTEXT                   = 0,
-       LTTNG_CALIBRATE                     = 1,
+       /* LTTNG_CALIBRATE used to be here */
        LTTNG_DISABLE_CHANNEL               = 2,
        LTTNG_DISABLE_EVENT                 = 3,
-       LTTNG_DISABLE_ALL_EVENT             = 4,
+       LTTNG_LIST_SYSCALLS                 = 4,
        LTTNG_ENABLE_CHANNEL                = 5,
        LTTNG_ENABLE_EVENT                  = 6,
-       LTTNG_ENABLE_ALL_EVENT              = 7,
+       /* 7 */
        /* Session daemon command */
        LTTNG_CREATE_SESSION                = 8,
        LTTNG_DESTROY_SESSION               = 9,
@@ -80,14 +82,24 @@ enum lttcomm_sessiond_command {
        LTTNG_DISABLE_CONSUMER              = 19,
        LTTNG_ENABLE_CONSUMER               = 20,
        LTTNG_SET_CONSUMER_URI              = 21,
-       LTTNG_ENABLE_EVENT_WITH_FILTER      = 22,
-       LTTNG_HEALTH_CHECK                  = 23,
+       /* 22 */
+       /* 23 */
        LTTNG_DATA_PENDING                  = 24,
        LTTNG_SNAPSHOT_ADD_OUTPUT           = 25,
        LTTNG_SNAPSHOT_DEL_OUTPUT           = 26,
        LTTNG_SNAPSHOT_LIST_OUTPUT          = 27,
        LTTNG_SNAPSHOT_RECORD               = 28,
        LTTNG_CREATE_SESSION_SNAPSHOT       = 29,
+       LTTNG_CREATE_SESSION_LIVE           = 30,
+       LTTNG_SAVE_SESSION                  = 31,
+       LTTNG_TRACK_PID                     = 32,
+       LTTNG_UNTRACK_PID                   = 33,
+       LTTNG_LIST_TRACKER_PIDS             = 34,
+       LTTNG_SET_SESSION_SHM_PATH          = 40,
+       LTTNG_REGENERATE_METADATA           = 41,
+       LTTNG_REGENERATE_STATEDUMP          = 42,
+       LTTNG_REGISTER_TRIGGER              = 43,
+       LTTNG_UNREGISTER_TRIGGER            = 44,
 };
 
 enum lttcomm_relayd_command {
@@ -102,12 +114,22 @@ enum lttcomm_relayd_command {
        RELAYD_QUIESCENT_CONTROL            = 9,
        RELAYD_BEGIN_DATA_PENDING           = 10,
        RELAYD_END_DATA_PENDING             = 11,
+       RELAYD_ADD_INDEX                    = 12,
+       RELAYD_SEND_INDEX                   = 13,
+       RELAYD_CLOSE_INDEX                  = 14,
+       /* Live-reading commands (2.4+). */
+       RELAYD_LIST_SESSIONS                = 15,
+       /* All streams of the channel have been sent to the relayd (2.4+). */
+       RELAYD_STREAMS_SENT                 = 16,
+       /* Ask the relay to reset the metadata trace file (2.8+) */
+       RELAYD_RESET_METADATA               = 17,
 };
 
 /*
  * lttcomm error code.
  */
 enum lttcomm_return_code {
+       LTTCOMM_CONSUMERD_SUCCESS            = 0,   /* Everything went fine. */
        LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
        LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
        LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
@@ -126,6 +148,9 @@ enum lttcomm_return_code {
        LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
        LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
        LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
+       LTTCOMM_CONSUMERD_CHANNEL_FAIL,             /* Channel creation failed. */
+       LTTCOMM_CONSUMERD_CHAN_NOT_FOUND,           /* Channel not found. */
+       LTTCOMM_CONSUMERD_ALREADY_SET,              /* Resource already set. */
 
        /* MUST be last element */
        LTTCOMM_NR,                                             /* Last element */
@@ -202,8 +227,8 @@ struct lttcomm_proto_ops {
        int (*listen) (struct lttcomm_sock *sock, int backlog);
        ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
                        int flags);
-       ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
-                       int flags);
+       ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
+                       size_t len, int flags);
 };
 
 /*
@@ -214,25 +239,50 @@ struct lttcomm_session_msg {
        struct lttng_session session;
        struct lttng_domain domain;
        union {
-               struct {
-                       char channel_name[LTTNG_SYMBOL_NAME_LEN];
-                       char name[NAME_MAX];
-               } LTTNG_PACKED disable;
                /* Event data */
                struct {
                        char channel_name[LTTNG_SYMBOL_NAME_LEN];
-                       struct lttng_event event;
+                       struct lttng_event event LTTNG_PACKED;
+                       /* Length of following filter expression. */
+                       uint32_t expression_len;
                        /* Length of following bytecode for filter. */
                        uint32_t bytecode_len;
+                       /* exclusion data */
+                       uint32_t exclusion_count;
+                       /*
+                        * After this structure, the following variable-length
+                        * items are transmitted:
+                        * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
+                        * - unsigned char filter_expression[expression_len]
+                        * - unsigned char filter_bytecode[bytecode_len]
+                        */
                } LTTNG_PACKED enable;
+               struct {
+                       char channel_name[LTTNG_SYMBOL_NAME_LEN];
+                       struct lttng_event event LTTNG_PACKED;
+                       /* Length of following filter expression. */
+                       uint32_t expression_len;
+                       /* Length of following bytecode for filter. */
+                       uint32_t bytecode_len;
+                       /*
+                        * After this structure, the following variable-length
+                        * items are transmitted:
+                        * - unsigned char filter_expression[expression_len]
+                        * - unsigned char filter_bytecode[bytecode_len]
+                        */
+               } LTTNG_PACKED disable;
                /* Create channel */
                struct {
-                       struct lttng_channel chan;
+                       struct lttng_channel chan LTTNG_PACKED;
+                       /* struct lttng_channel_extended is already packed. */
+                       struct lttng_channel_extended extended;
                } LTTNG_PACKED channel;
                /* Context */
                struct {
                        char channel_name[LTTNG_SYMBOL_NAME_LEN];
-                       struct lttng_event_context ctx;
+                       struct lttng_event_context ctx LTTNG_PACKED;
+                       uint32_t provider_name_len;
+                       uint32_t context_name_len;
                } LTTNG_PACKED context;
                /* Use by register_consumer */
                struct {
@@ -249,12 +299,28 @@ struct lttcomm_session_msg {
                        uint32_t size;
                } LTTNG_PACKED uri;
                struct {
-                       struct lttng_snapshot_output output;
+                       struct lttng_snapshot_output output LTTNG_PACKED;
                } LTTNG_PACKED snapshot_output;
                struct {
                        uint32_t wait;
-                       struct lttng_snapshot_output output;
+                       struct lttng_snapshot_output output LTTNG_PACKED;
                } LTTNG_PACKED snapshot_record;
+               struct {
+                       uint32_t nb_uri;
+                       unsigned int timer_interval;    /* usec */
+               } LTTNG_PACKED session_live;
+               struct {
+                       struct lttng_save_session_attr attr; /* struct already packed */
+               } LTTNG_PACKED save_session;
+               struct {
+                       char shm_path[PATH_MAX];
+               } LTTNG_PACKED set_shm_path;
+               struct {
+                       uint32_t pid;
+               } LTTNG_PACKED pid_tracker;
+               struct {
+                       uint32_t length;
+               } LTTNG_PACKED trigger;
        } u;
 } LTTNG_PACKED;
 
@@ -274,6 +340,49 @@ struct lttng_filter_bytecode {
        char data[0];
 } LTTNG_PACKED;
 
+/*
+ * Event exclusion data. At the end of the structure, there will actually
+ * by zero or more names, where the actual number of names is given by
+ * the 'count' item of the structure.
+ */
+#define LTTNG_EVENT_EXCLUSION_PADDING  32
+struct lttng_event_exclusion {
+       uint32_t count;
+       char padding[LTTNG_EVENT_EXCLUSION_PADDING];
+       char names[0][LTTNG_SYMBOL_NAME_LEN];
+} LTTNG_PACKED;
+
+#define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
+       (&(_exclusion)->names[_i][0])
+
+/*
+ * Event command header.
+ */
+struct lttcomm_event_command_header {
+       /* Number of events */
+       uint32_t nb_events;
+} LTTNG_PACKED;
+
+/*
+ * Event extended info header. This is the structure preceding each
+ * extended info data.
+ */
+struct lttcomm_event_extended_header {
+       /*
+        * Size of filter string immediately following this header.
+        * This size includes the terminal null character.
+        */
+       uint32_t filter_len;
+
+       /*
+        * Number of exclusion names, immediately following the filter
+        * string. Each exclusion name has a fixed length of
+        * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
+        * character.
+        */
+       uint32_t nb_exclusions;
+} LTTNG_PACKED;
+
 /*
  * Data structure for the response from sessiond to the lttng client.
  */
@@ -281,24 +390,14 @@ struct lttcomm_lttng_msg {
        uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
        uint32_t ret_code;      /* enum lttcomm_return_code */
        uint32_t pid;           /* pid_t */
+       uint32_t cmd_header_size;
        uint32_t data_size;
-       /* Contains: trace_name + data */
-       char payload[];
 } LTTNG_PACKED;
 
 struct lttcomm_lttng_output_id {
        uint32_t id;
 } LTTNG_PACKED;
 
-struct lttcomm_health_msg {
-       uint32_t component;
-       uint32_t cmd;
-} LTTNG_PACKED;
-
-struct lttcomm_health_data {
-       uint32_t ret_code;
-} LTTNG_PACKED;
-
 /*
  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
  * to either add a channel, add a stream, update a stream, or stop
@@ -324,6 +423,10 @@ struct lttcomm_consumer_msg {
                        uint32_t tracefile_count; /* number of tracefiles */
                        /* If the channel's streams have to be monitored or not. */
                        uint32_t monitor;
+                       /* timer to check the streams usage in live mode (usec). */
+                       unsigned int live_timer_interval;
+                       /* timer to sample a channel's positions (usec). */
+                       unsigned int monitor_timer_interval;
                } LTTNG_PACKED channel; /* Only used by Kernel. */
                struct {
                        uint64_t stream_key;
@@ -339,6 +442,8 @@ struct lttcomm_consumer_msg {
                        struct lttcomm_relayd_sock sock;
                        /* Tracing session id associated to the relayd. */
                        uint64_t session_id;
+                       /* Relayd session id, only used with control socket. */
+                       uint64_t relayd_session_id;
                } LTTNG_PACKED relayd_sock;
                struct {
                        uint64_t net_seq_idx;
@@ -352,6 +457,8 @@ struct lttcomm_consumer_msg {
                        int32_t overwrite;                      /* 1: overwrite, 0: discard */
                        uint32_t switch_timer_interval;         /* usec */
                        uint32_t read_timer_interval;           /* usec */
+                       unsigned int live_timer_interval;       /* usec */
+                       uint32_t monitor_timer_interval;        /* usec */
                        int32_t output;                         /* splice, mmap */
                        int32_t type;                           /* metadata or per_cpu */
                        uint64_t session_id;                    /* Tracing session id */
@@ -375,6 +482,8 @@ struct lttcomm_consumer_msg {
                         * because the application can be in the tracing for instance.
                         */
                        uint32_t ust_app_uid;
+                       char root_shm_path[PATH_MAX];
+                       char shm_path[PATH_MAX];
                } LTTNG_PACKED ask_channel;
                struct {
                        uint64_t key;
@@ -386,6 +495,7 @@ struct lttcomm_consumer_msg {
                        uint64_t key;   /* Metadata channel key. */
                        uint64_t target_offset; /* Offset in the consumer */
                        uint64_t len;   /* Length of metadata to be received. */
+                       uint64_t version; /* Version of the metadata. */
                } LTTNG_PACKED push_metadata;
                struct {
                        uint64_t key;   /* Metadata channel key. */
@@ -396,6 +506,9 @@ struct lttcomm_consumer_msg {
                struct {
                        uint64_t key;   /* Channel key. */
                } LTTNG_PACKED flush_channel;
+               struct {
+                       uint64_t key;   /* Channel key. */
+               } LTTNG_PACKED clear_quiescent_channel;
                struct {
                        char pathname[PATH_MAX];
                        /* Indicate if the snapshot goes on the relayd or locally. */
@@ -403,20 +516,48 @@ struct lttcomm_consumer_msg {
                        uint32_t metadata;              /* This a metadata snapshot. */
                        uint64_t relayd_id;             /* Relayd id if apply. */
                        uint64_t key;
-                       uint64_t max_stream_size;
+                       uint64_t nb_packets_per_stream;
                } LTTNG_PACKED snapshot_channel;
+               struct {
+                       uint64_t channel_key;
+                       uint64_t net_seq_idx;
+               } LTTNG_PACKED sent_streams;
+               struct {
+                       uint64_t session_id;
+                       uint64_t channel_key;
+               } LTTNG_PACKED discarded_events;
+               struct {
+                       uint64_t session_id;
+                       uint64_t channel_key;
+               } LTTNG_PACKED lost_packets;
+               struct {
+                       uint64_t session_id;
+               } LTTNG_PACKED regenerate_metadata;
        } u;
 } LTTNG_PACKED;
 
+/*
+ * Channel monitoring message returned to the session daemon on every
+ * monitor timer expiration.
+ */
+struct lttcomm_consumer_channel_monitor_msg {
+       /* Key of the sampled channel. */
+       uint64_t key;
+       /*
+        * Lowest and highest usage (bytes) at the moment the sample was taken.
+        */
+       uint64_t lowest, highest;
+} LTTNG_PACKED;
+
 /*
  * Status message returned to the sessiond after a received command.
  */
 struct lttcomm_consumer_status_msg {
-       enum lttng_error_code ret_code;
+       enum lttcomm_return_code ret_code;
 } LTTNG_PACKED;
 
 struct lttcomm_consumer_status_channel {
-       enum lttng_error_code ret_code;
+       enum lttcomm_return_code ret_code;
        uint64_t key;
        unsigned int stream_count;
 } LTTNG_PACKED;
This page took 0.028018 seconds and 4 git commands to generate.