Fix: consumer: snapshot error return code
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
index d436094ff36d0c6a71671d380b34c13e1c106c56..f40db1fddcd402d4569a2d596d2820b521ce9312 100644 (file)
@@ -29,6 +29,9 @@
 #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 <lttng/rotate-internal.h>
 #include <common/compat/socket.h>
 #include <common/uri.h>
 #include <common/defaults.h>
@@ -40,7 +43,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_DISABLE_CHANNEL               = 2,
-       LTTNG_DISABLE_EVENT                 = 3,
-       LTTNG_LIST_SYSCALLS                 = 4,
-       LTTNG_ENABLE_CHANNEL                = 5,
-       LTTNG_ENABLE_EVENT                  = 6,
+       LTTNG_ADD_CONTEXT                     = 0,
+       /* LTTNG_CALIBRATE used to be here */
+       LTTNG_DISABLE_CHANNEL                 = 2,
+       LTTNG_DISABLE_EVENT                   = 3,
+       LTTNG_LIST_SYSCALLS                   = 4,
+       LTTNG_ENABLE_CHANNEL                  = 5,
+       LTTNG_ENABLE_EVENT                    = 6,
        /* 7 */
        /* Session daemon command */
-       LTTNG_CREATE_SESSION                = 8,
-       LTTNG_DESTROY_SESSION               = 9,
-       LTTNG_LIST_CHANNELS                 = 10,
-       LTTNG_LIST_DOMAINS                  = 11,
-       LTTNG_LIST_EVENTS                   = 12,
-       LTTNG_LIST_SESSIONS                 = 13,
-       LTTNG_LIST_TRACEPOINTS              = 14,
-       LTTNG_REGISTER_CONSUMER             = 15,
-       LTTNG_START_TRACE                   = 16,
-       LTTNG_STOP_TRACE                    = 17,
-       LTTNG_LIST_TRACEPOINT_FIELDS        = 18,
+       LTTNG_CREATE_SESSION                  = 8,
+       LTTNG_DESTROY_SESSION                 = 9,
+       LTTNG_LIST_CHANNELS                   = 10,
+       LTTNG_LIST_DOMAINS                    = 11,
+       LTTNG_LIST_EVENTS                     = 12,
+       LTTNG_LIST_SESSIONS                   = 13,
+       LTTNG_LIST_TRACEPOINTS                = 14,
+       LTTNG_REGISTER_CONSUMER               = 15,
+       LTTNG_START_TRACE                     = 16,
+       LTTNG_STOP_TRACE                      = 17,
+       LTTNG_LIST_TRACEPOINT_FIELDS          = 18,
 
        /* Consumer */
-       LTTNG_DISABLE_CONSUMER              = 19,
-       LTTNG_ENABLE_CONSUMER               = 20,
-       LTTNG_SET_CONSUMER_URI              = 21,
+       LTTNG_DISABLE_CONSUMER                = 19,
+       LTTNG_ENABLE_CONSUMER                 = 20,
+       LTTNG_SET_CONSUMER_URI                = 21,
        /* 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_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,
+       LTTNG_ROTATE_SESSION                  = 45,
+       LTTNG_ROTATION_GET_INFO               = 46,
+       LTTNG_ROTATION_SET_SCHEDULE           = 47,
+       LTTNG_SESSION_LIST_ROTATION_SCHEDULES = 48,
 };
 
 enum lttcomm_relayd_command {
@@ -115,6 +126,16 @@ enum lttcomm_relayd_command {
        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,
+       /* Ask the relay to rotate a stream file (2.11+) */
+       RELAYD_ROTATE_STREAM                = 18,
+       /* Rename a chunk after the rotation is completed (2.11+) */
+       RELAYD_ROTATE_RENAME                = 19,
+       /* Check if a chunk has data pending (2.11+) */
+       RELAYD_ROTATE_PENDING               = 20,
+       /* Create a folder on the relayd FS (2.11+) */
+       RELAYD_MKDIR                        = 21,
 };
 
 /*
@@ -142,6 +163,13 @@ enum lttcomm_return_code {
        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. */
+       LTTCOMM_CONSUMERD_ROTATION_FAIL,            /* Rotation has failed. */
+       LTTCOMM_CONSUMERD_ROTATE_RENAME_FAILED,     /* Rotation rename has failed. */
+       LTTCOMM_CONSUMERD_ROTATION_PENDING_LOCAL_FAILED, /* Rotation pending relay failed. */
+       LTTCOMM_CONSUMERD_ROTATION_PENDING_RELAY_FAILED, /* Rotation pending relay failed. */
+       LTTCOMM_CONSUMERD_MKDIR_FAILED,             /* mkdir has failed. */
+       LTTCOMM_CONSUMERD_SNAPSHOT_FAILED,          /* snapshot has failed. */
 
        /* MUST be last element */
        LTTCOMM_NR,                                             /* Last element */
@@ -238,13 +266,15 @@ struct lttcomm_session_msg {
                        uint32_t expression_len;
                        /* Length of following bytecode for filter. */
                        uint32_t bytecode_len;
-                       /* exclusion data */
+                       /* Exclusion count (fixed-size strings). */
                        uint32_t exclusion_count;
+                       /* Userspace probe location size. */
+                       uint32_t userspace_probe_location_len;
                        /*
                         * 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]
+                        * - char filter_expression[expression_len]
                         * - unsigned char filter_bytecode[bytecode_len]
                         */
                } LTTNG_PACKED enable;
@@ -265,6 +295,8 @@ struct lttcomm_session_msg {
                /* Create channel */
                struct {
                        struct lttng_channel chan LTTNG_PACKED;
+                       /* struct lttng_channel_extended is already packed. */
+                       struct lttng_channel_extended extended;
                } LTTNG_PACKED channel;
                /* Context */
                struct {
@@ -307,6 +339,22 @@ struct lttcomm_session_msg {
                struct {
                        uint32_t pid;
                } LTTNG_PACKED pid_tracker;
+               struct {
+                       uint32_t length;
+               } LTTNG_PACKED trigger;
+               struct {
+                       uint64_t rotation_id;
+               } LTTNG_PACKED get_rotation_info;
+               struct {
+                       /* enum lttng_rotation_schedule_type */
+                       uint8_t type;
+                       /*
+                        * If set == 1, set schedule to value, if set == 0,
+                        * clear this schedule type.
+                        */
+                       uint8_t set;
+                       uint64_t value;
+               } LTTNG_PACKED rotation_set_schedule;
        } u;
 } LTTNG_PACKED;
 
@@ -367,14 +415,11 @@ struct lttcomm_event_extended_header {
         * character.
         */
        uint32_t nb_exclusions;
-} LTTNG_PACKED;
 
-/*
- * Channel extended info.
- */
-struct lttcomm_channel_extended {
-       uint64_t discarded_events;
-       uint64_t lost_packets;
+       /*
+        * Size of the event's userspace probe location (if applicable).
+        */
+       uint32_t userspace_probe_location_len;
 } LTTNG_PACKED;
 
 /*
@@ -398,7 +443,7 @@ struct lttcomm_lttng_output_id {
  * operation.
  */
 struct lttcomm_consumer_msg {
-       uint32_t cmd_type;      /* enum consumerd_command */
+       uint32_t cmd_type;      /* enum lttng_consumer_command */
        union {
                struct {
                        uint64_t channel_key;
@@ -419,6 +464,8 @@ struct lttcomm_consumer_msg {
                        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;
@@ -426,6 +473,13 @@ struct lttcomm_consumer_msg {
                        int32_t cpu;    /* On which CPU this stream is assigned. */
                        /* Tells the consumer if the stream should be or not monitored. */
                        uint32_t no_monitor;
+                       /*
+                        * The archive id that was "current" at the time this
+                        * stream was created. This is used to determine
+                        * whether a rotation request was sent before or after
+                        * the creation of a stream.
+                        */
+                       uint64_t trace_archive_id;
                } LTTNG_PACKED stream;  /* Only used by Kernel. */
                struct {
                        uint64_t net_index;
@@ -449,7 +503,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 */
+                       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 */
@@ -473,6 +528,14 @@ struct lttcomm_consumer_msg {
                         * because the application can be in the tracing for instance.
                         */
                        uint32_t ust_app_uid;
+                       int64_t blocking_timeout;
+                       /*
+                        * The archive id that was "current" at the time this
+                        * channel was created. This is used to determine
+                        * whether a rotation request was sent before or after
+                        * the creation of a channel.
+                        */
+                       uint64_t trace_archive_id;
                        char root_shm_path[PATH_MAX];
                        char shm_path[PATH_MAX];
                } LTTNG_PACKED ask_channel;
@@ -486,6 +549,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. */
@@ -496,6 +560,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. */
@@ -504,14 +571,79 @@ struct lttcomm_consumer_msg {
                        uint64_t relayd_id;             /* Relayd id if apply. */
                        uint64_t key;
                        uint64_t nb_packets_per_stream;
+                       /*
+                        * The session's current trace archive id is propagated
+                        * since a snapshot triggers the creation of an
+                        * ephemeral metadata stream.
+                        */
+                       uint64_t trace_archive_id;
                } 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;
+               struct {
+                       char pathname[PATH_MAX];
+                       uint32_t metadata; /* This is a metadata channel. */
+                       uint64_t relayd_id; /* Relayd id if apply. */
+                       uint64_t key;
+                       uint64_t new_chunk_id;
+               } LTTNG_PACKED rotate_channel;
+               struct {
+                       char old_path[LTTNG_PATH_MAX];
+                       char new_path[LTTNG_PATH_MAX];
+                       uint64_t relayd_id; /* Relayd id if apply. */
+                       uint64_t session_id;
+                       uint32_t uid;
+                       uint32_t gid;
+               } LTTNG_PACKED rotate_rename;
+               struct {
+                       uint64_t session_id;
+                       uint64_t chunk_id;
+               } LTTNG_PACKED check_rotation_pending_local;
+               struct {
+                       uint64_t relayd_id;
+                       uint64_t session_id;
+                       uint64_t chunk_id;
+               } LTTNG_PACKED check_rotation_pending_relay;
+               struct {
+                       char path[LTTNG_PATH_MAX];
+                       uint64_t relayd_id; /* Relayd id if apply. */
+                       uint64_t session_id;
+                       uint32_t uid;
+                       uint32_t gid;
+               } LTTNG_PACKED mkdir;
        } 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;
+       /*
+        * Sum of all the consumed positions for a channel.
+        */
+       uint64_t total_consumed;
+} LTTNG_PACKED;
+
 /*
  * Status message returned to the sessiond after a received command.
  */
@@ -566,30 +698,38 @@ struct lttcomm_ust_reply {
 
 #endif /* HAVE_LIBLTTNG_UST_CTL */
 
-extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
+LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 
-extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
+LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
                const char *ip, unsigned int port);
-extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
+LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
                const char *ip, unsigned int port);
 
-extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
-extern int lttcomm_create_sock(struct lttcomm_sock *sock);
-extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
-extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
-extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
-extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
+LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
+LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
+LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
+LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
+LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
+LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
                struct lttcomm_sock *src);
 
 /* Relayd socket object. */
-extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
+LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
                struct lttng_uri *uri, uint32_t major, uint32_t minor);
 
-extern int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
-extern int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
+LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
+LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
+
+LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
+               uint16_t *port);
+/*
+ * Set a port to an lttcomm_sock. This will have no effect is the socket is
+ * already bound.
+ */
+LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
 
-extern void lttcomm_init(void);
+LTTNG_HIDDEN void lttcomm_init(void);
 /* Get network timeout, in milliseconds */
-extern unsigned long lttcomm_get_network_timeout(void);
+LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
 
 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.0290550000000001 seconds and 4 git commands to generate.