inet/inet6 sockets: apply timeout
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
index b94d3fb8d6229300fea7fda8203e4dda1b7fe27d..c52a6caa0575272788797786b373b85ba286bce9 100644 (file)
 #define _GNU_SOURCE
 #include <limits.h>
 #include <lttng/lttng.h>
+#include <lttng/snapshot-internal.h>
 #include <common/compat/socket.h>
 #include <common/uri.h>
+#include <common/defaults.h>
+#include <common/compat/uuid.h>
 
 #include <arpa/inet.h>
 #include <netinet/in.h>
 
 enum lttcomm_sessiond_command {
        /* Tracer command */
-       LTTNG_ADD_CONTEXT,
-       LTTNG_CALIBRATE,
-       LTTNG_DISABLE_CHANNEL,
-       LTTNG_DISABLE_EVENT,
-       LTTNG_DISABLE_ALL_EVENT,
-       LTTNG_ENABLE_CHANNEL,
-       LTTNG_ENABLE_EVENT,
-       LTTNG_ENABLE_ALL_EVENT,
+       LTTNG_ADD_CONTEXT                   = 0,
+       LTTNG_CALIBRATE                     = 1,
+       LTTNG_DISABLE_CHANNEL               = 2,
+       LTTNG_DISABLE_EVENT                 = 3,
+       LTTNG_DISABLE_ALL_EVENT             = 4,
+       LTTNG_ENABLE_CHANNEL                = 5,
+       LTTNG_ENABLE_EVENT                  = 6,
+       LTTNG_ENABLE_ALL_EVENT              = 7,
        /* Session daemon command */
-       LTTNG_CREATE_SESSION,
-       LTTNG_DESTROY_SESSION,
-       LTTNG_LIST_CHANNELS,
-       LTTNG_LIST_DOMAINS,
-       LTTNG_LIST_EVENTS,
-       LTTNG_LIST_SESSIONS,
-       LTTNG_LIST_TRACEPOINTS,
-       LTTNG_REGISTER_CONSUMER,
-       LTTNG_START_TRACE,
-       LTTNG_STOP_TRACE,
-       LTTNG_LIST_TRACEPOINT_FIELDS,
+       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,
-       LTTNG_ENABLE_CONSUMER,
-       LTTNG_SET_CONSUMER_URI,
-       /* Relay daemon */
-       RELAYD_ADD_STREAM,
-       RELAYD_CREATE_SESSION,
-       RELAYD_START_DATA,
-       RELAYD_UPDATE_SYNC_INFO,
-       RELAYD_VERSION,
-       RELAYD_SEND_METADATA,
-       RELAYD_CLOSE_STREAM,
-       RELAYD_DATA_PENDING,
-       RELAYD_QUIESCENT_CONTROL,
-       LTTNG_SET_FILTER,
-       LTTNG_HEALTH_CHECK,
-       LTTNG_DATA_PENDING,
+       LTTNG_DISABLE_CONSUMER              = 19,
+       LTTNG_ENABLE_CONSUMER               = 20,
+       LTTNG_SET_CONSUMER_URI              = 21,
+       LTTNG_ENABLE_EVENT_WITH_FILTER      = 22,
+       LTTNG_HEALTH_CHECK                  = 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,
+};
+
+enum lttcomm_relayd_command {
+       RELAYD_ADD_STREAM                   = 1,
+       RELAYD_CREATE_SESSION               = 2,
+       RELAYD_START_DATA                   = 3,
+       RELAYD_UPDATE_SYNC_INFO             = 4,
+       RELAYD_VERSION                      = 5,
+       RELAYD_SEND_METADATA                = 6,
+       RELAYD_CLOSE_STREAM                 = 7,
+       RELAYD_DATA_PENDING                 = 8,
+       RELAYD_QUIESCENT_CONTROL            = 9,
+       RELAYD_BEGIN_DATA_PENDING           = 10,
+       RELAYD_END_DATA_PENDING             = 11,
 };
 
 /*
@@ -110,6 +122,10 @@ enum lttcomm_return_code {
        LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
        LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
        LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
+       LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
+       LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
+       LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
+       LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
 
        /* MUST be last element */
        LTTCOMM_NR,                                             /* Last element */
@@ -129,20 +145,49 @@ enum lttcomm_sock_domain {
        LTTCOMM_INET6     = 1,
 };
 
+enum lttcomm_metadata_command {
+       LTTCOMM_METADATA_REQUEST = 1,
+};
+
+/*
+ * Commands sent from the consumerd to the sessiond to request if new metadata
+ * is available. This message is used to find the per UID _or_ per PID registry
+ * for the channel key. For per UID lookup, the triplet
+ * bits_per_long/uid/session_id is used. On lookup failure, we search for the
+ * per PID registry indexed by session id ignoring the other values.
+ */
+struct lttcomm_metadata_request_msg {
+       uint64_t session_id; /* Tracing session id */
+       uint64_t session_id_per_pid; /* Tracing session id for per-pid */
+       uint32_t bits_per_long; /* Consumer ABI */
+       uint32_t uid;
+       uint64_t key; /* Metadata channel key. */
+} LTTNG_PACKED;
+
 struct lttcomm_sockaddr {
        enum lttcomm_sock_domain type;
        union {
                struct sockaddr_in sin;
                struct sockaddr_in6 sin6;
        } addr;
-};
+} LTTNG_PACKED;
 
 struct lttcomm_sock {
-       int fd;
+       int32_t fd;
        enum lttcomm_sock_proto proto;
        struct lttcomm_sockaddr sockaddr;
        const struct lttcomm_proto_ops *ops;
-};
+} LTTNG_PACKED;
+
+/*
+ * Relayd sock. Adds the protocol version to use for the communications with
+ * the relayd.
+ */
+struct lttcomm_relayd_sock {
+       struct lttcomm_sock sock;
+       uint32_t major;
+       uint32_t minor;
+} LTTNG_PACKED;
 
 struct lttcomm_net_family {
        int family;
@@ -165,51 +210,53 @@ struct lttcomm_proto_ops {
  * Data structure received from lttng client to session daemon.
  */
 struct lttcomm_session_msg {
-       uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
+       uint32_t cmd_type;      /* enum lttcomm_sessiond_command */
        struct lttng_session session;
        struct lttng_domain domain;
        union {
                struct {
                        char channel_name[LTTNG_SYMBOL_NAME_LEN];
                        char name[NAME_MAX];
-               } disable;
+               } LTTNG_PACKED disable;
                /* Event data */
                struct {
                        char channel_name[LTTNG_SYMBOL_NAME_LEN];
                        struct lttng_event event;
-               } enable;
+                       /* Length of following bytecode for filter. */
+                       uint32_t bytecode_len;
+               } LTTNG_PACKED enable;
                /* Create channel */
                struct {
                        struct lttng_channel chan;
-               } channel;
+               } LTTNG_PACKED channel;
                /* Context */
                struct {
                        char channel_name[LTTNG_SYMBOL_NAME_LEN];
-                       char event_name[LTTNG_SYMBOL_NAME_LEN];
                        struct lttng_event_context ctx;
-               } context;
+               } LTTNG_PACKED context;
                /* Use by register_consumer */
                struct {
                        char path[PATH_MAX];
-               } reg;
+               } LTTNG_PACKED reg;
                /* List */
                struct {
                        char channel_name[LTTNG_SYMBOL_NAME_LEN];
-               } list;
+               } LTTNG_PACKED list;
                struct lttng_calibrate calibrate;
                /* Used by the set_consumer_url and used by create_session also call */
                struct {
                        /* Number of lttng_uri following */
                        uint32_t size;
-               } uri;
+               } LTTNG_PACKED uri;
                struct {
-                       char channel_name[LTTNG_SYMBOL_NAME_LEN];
-                       char event_name[LTTNG_SYMBOL_NAME_LEN];
-                       /* Length of following bytecode */
-                       uint32_t bytecode_len;
-               } filter;
+                       struct lttng_snapshot_output output;
+               } LTTNG_PACKED snapshot_output;
+               struct {
+                       uint32_t wait;
+                       struct lttng_snapshot_output output;
+               } LTTNG_PACKED snapshot_record;
        } u;
-};
+} LTTNG_PACKED;
 
 #define LTTNG_FILTER_MAX_LEN   65536
 
@@ -218,32 +265,39 @@ struct lttcomm_session_msg {
  * bytecode. It is made of tuples: (uint16_t, var. len. string). It
  * starts at reloc_table_offset.
  */
+#define LTTNG_FILTER_PADDING   32
 struct lttng_filter_bytecode {
        uint32_t len;   /* len of data */
        uint32_t reloc_table_offset;
+       uint64_t seqnum;
+       char padding[LTTNG_FILTER_PADDING];
        char data[0];
-};
+} LTTNG_PACKED;
 
 /*
  * Data structure for the response from sessiond to the lttng client.
  */
 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_type;      /* enum lttcomm_sessiond_command */
+       uint32_t ret_code;      /* enum lttcomm_return_code */
+       uint32_t pid;           /* pid_t */
        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
@@ -254,43 +308,111 @@ struct lttcomm_consumer_msg {
        uint32_t cmd_type;      /* enum consumerd_command */
        union {
                struct {
-                       int channel_key;
-                       uint64_t max_sb_size; /* the subbuffer size for this channel */
-                       /* shm_fd and wait_fd are sent as ancillary data */
-                       uint64_t mmap_len;
+                       uint64_t channel_key;
+                       uint64_t session_id;
+                       char pathname[PATH_MAX];
+                       uint32_t uid;
+                       uint32_t gid;
+                       uint64_t relayd_id;
                        /* nb_init_streams is the number of streams open initially. */
-                       unsigned int nb_init_streams;
+                       uint32_t nb_init_streams;
                        char name[LTTNG_SYMBOL_NAME_LEN];
-               } channel;
+                       /* Use splice or mmap to consume this fd */
+                       enum lttng_event_output output;
+                       int type; /* Per cpu or metadata. */
+                       uint64_t tracefile_size; /* bytes */
+                       uint32_t tracefile_count; /* number of tracefiles */
+                       /* If the channel's streams have to be monitored or not. */
+                       uint32_t monitor;
+               } LTTNG_PACKED channel; /* Only used by Kernel. */
                struct {
-                       int channel_key;
-                       int stream_key;
-                       /* shm_fd and wait_fd are sent as ancillary data */
-                       uint32_t state;    /* enum lttcomm_consumer_fd_state */
-                       enum lttng_event_output output; /* use splice or mmap to consume this fd */
-                       uint64_t mmap_len;
-                       uid_t uid;         /* User ID owning the session */
-                       gid_t gid;         /* Group ID owning the session */
-                       char path_name[PATH_MAX];
-                       int net_index;
-                       unsigned int metadata_flag;
-                       char name[LTTNG_SYMBOL_NAME_LEN];  /* Name string of the stream */
-                       uint64_t session_id;   /* Tracing session id of the stream */
-               } stream;
+                       uint64_t stream_key;
+                       uint64_t channel_key;
+                       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;
+               } LTTNG_PACKED stream;  /* Only used by Kernel. */
                struct {
-                       int net_index;
+                       uint64_t net_index;
                        enum lttng_stream_type type;
                        /* Open socket to the relayd */
-                       struct lttcomm_sock sock;
-               } relayd_sock;
+                       struct lttcomm_relayd_sock sock;
+                       /* Tracing session id associated to the relayd. */
+                       uint64_t session_id;
+               } LTTNG_PACKED relayd_sock;
                struct {
                        uint64_t net_seq_idx;
-               } destroy_relayd;
+               } LTTNG_PACKED destroy_relayd;
                struct {
                        uint64_t session_id;
-               } data_pending;
+               } LTTNG_PACKED data_pending;
+               struct {
+                       uint64_t subbuf_size;                   /* bytes */
+                       uint64_t num_subbuf;                    /* power of 2 */
+                       int32_t overwrite;                      /* 1: overwrite, 0: discard */
+                       uint32_t switch_timer_interval;         /* usec */
+                       uint32_t read_timer_interval;           /* usec */
+                       int32_t output;                         /* splice, mmap */
+                       int32_t type;                           /* metadata or per_cpu */
+                       uint64_t session_id;                    /* Tracing session id */
+                       char pathname[PATH_MAX];                /* Channel file path. */
+                       char name[LTTNG_SYMBOL_NAME_LEN];       /* Channel name. */
+                       uint32_t uid;                           /* User ID of the session */
+                       uint32_t gid;                           /* Group ID ot the session */
+                       uint64_t relayd_id;                     /* Relayd id if apply. */
+                       uint64_t key;                           /* Unique channel key. */
+                       unsigned char uuid[UUID_LEN];   /* uuid for ust tracer. */
+                       uint32_t chan_id;                       /* Channel ID on the tracer side. */
+                       uint64_t tracefile_size;        /* bytes */
+                       uint32_t tracefile_count;       /* number of tracefiles */
+                       uint64_t session_id_per_pid;    /* Per-pid session ID. */
+                       /* Tells the consumer if the stream should be or not monitored. */
+                       uint32_t monitor;
+               } LTTNG_PACKED ask_channel;
+               struct {
+                       uint64_t key;
+               } LTTNG_PACKED get_channel;
+               struct {
+                       uint64_t key;
+               } LTTNG_PACKED destroy_channel;
+               struct {
+                       uint64_t key;   /* Metadata channel key. */
+                       uint64_t target_offset; /* Offset in the consumer */
+                       uint64_t len;   /* Length of metadata to be received. */
+               } LTTNG_PACKED push_metadata;
+               struct {
+                       uint64_t key;   /* Metadata channel key. */
+               } LTTNG_PACKED close_metadata;
+               struct {
+                       uint64_t key;   /* Metadata channel key. */
+               } LTTNG_PACKED setup_metadata;
+               struct {
+                       uint64_t key;   /* Channel key. */
+               } LTTNG_PACKED flush_channel;
+               struct {
+                       char pathname[PATH_MAX];
+                       /* Indicate if the snapshot goes on the relayd or locally. */
+                       uint32_t use_relayd;
+                       uint32_t metadata;              /* This a metadata snapshot. */
+                       uint64_t relayd_id;             /* Relayd id if apply. */
+                       uint64_t key;
+                       uint64_t max_stream_size;
+               } LTTNG_PACKED snapshot_channel;
        } u;
-};
+} LTTNG_PACKED;
+
+/*
+ * Status message returned to the sessiond after a received command.
+ */
+struct lttcomm_consumer_status_msg {
+       enum lttng_error_code ret_code;
+} LTTNG_PACKED;
+
+struct lttcomm_consumer_status_channel {
+       enum lttng_error_code ret_code;
+       uint64_t key;
+       unsigned int stream_count;
+} LTTNG_PACKED;
 
 #ifdef HAVE_LIBLTTNG_UST_CTL
 
@@ -309,7 +431,7 @@ struct lttcomm_ust_msg {
                struct lttng_ust_context context;
                struct lttng_ust_tracer_version version;
        } u;
-};
+} LTTNG_PACKED;
 
 /*
  * Data structure for the response from UST to the session daemon.
@@ -323,13 +445,13 @@ struct lttcomm_ust_reply {
        union {
                struct {
                        uint64_t memory_map_size;
-               } channel;
+               } LTTNG_PACKED channel;
                struct {
                        uint64_t memory_map_size;
-               } stream;
+               } LTTNG_PACKED stream;
                struct lttng_ust_tracer_version version;
        } u;
-};
+} LTTNG_PACKED;
 
 #endif /* HAVE_LIBLTTNG_UST_CTL */
 
@@ -348,4 +470,15 @@ extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
                struct lttcomm_sock *src);
 
+/* Relayd socket object. */
+extern 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);
+
+extern void lttcomm_init(void);
+/* Get network timeout, in milliseconds */
+extern unsigned long lttcomm_get_network_timeout(void);
+
 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.028733 seconds and 4 git commands to generate.