Change the UST event hash table match function
[lttng-tools.git] / src / common / consumer.h
index 6ac781605c7284ecf7319e2b10fa0c3920b441b3..2bcb0db24d88fed6419d21685023bf1dbe0ffccb 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
- * Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *               2012 - David Goulet <dgoulet@efficios.com>
  *
  * 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,
@@ -16,8 +17,8 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#ifndef _LTTNG_CONSUMER_H
-#define _LTTNG_CONSUMER_H
+#ifndef LIB_CONSUMER_H
+#define LIB_CONSUMER_H
 
 #include <limits.h>
 #include <poll.h>
 
 #include <common/hashtable/hashtable.h>
 #include <common/compat/fcntl.h>
-
-/*
- * When the receiving thread dies, we need to have a way to make the polling
- * thread exit eventually. If all FDs hang up (normal case when the
- * lttng-sessiond stops), we can exit cleanly, but if there is a problem and
- * for whatever reason some FDs remain open, the consumer should still exit
- * eventually.
- *
- * If the timeout is reached, it means that during this period no events
- * occurred on the FDs so we need to force an exit. This case should not happen
- * but it is a safety to ensure we won't block the consumer indefinitely.
- *
- * The value of 2 seconds is an arbitrary choice.
- */
-#define LTTNG_CONSUMER_POLL_TIMEOUT 2000
+#include <common/sessiond-comm/sessiond-comm.h>
 
 /* Commands for consumer */
 enum lttng_consumer_command {
@@ -51,6 +38,11 @@ enum lttng_consumer_command {
        LTTNG_CONSUMER_UPDATE_STREAM,
        /* inform the consumer to quit when all fd has hang up */
        LTTNG_CONSUMER_STOP,
+       LTTNG_CONSUMER_ADD_RELAYD_SOCKET,
+       /* Inform the consumer to kill a specific relayd connection */
+       LTTNG_CONSUMER_DESTROY_RELAYD,
+       /* Return to the sessiond if there is data pending for a session */
+       LTTNG_CONSUMER_DATA_PENDING,
 };
 
 /* State of each fd in consumer */
@@ -67,18 +59,28 @@ enum lttng_consumer_type {
        LTTNG_CONSUMER32_UST,
 };
 
+enum consumer_endpoint_status {
+       CONSUMER_ENDPOINT_ACTIVE,
+       CONSUMER_ENDPOINT_INACTIVE,
+};
+
 struct lttng_consumer_channel {
        struct lttng_ht_node_ulong node;
        int key;
        uint64_t max_sb_size; /* the subbuffer size for this channel */
        int refcount; /* Number of streams referencing this channel */
+       /*
+        * The number of streams to receive initially. Used to guarantee that we do
+        * not destroy a channel before receiving all its associated streams.
+        */
+       unsigned int nb_init_streams;
+
        /* For UST */
        int shm_fd;
        int wait_fd;
        void *mmap_base;
        size_t mmap_len;
        struct lttng_ust_shm_handle *handle;
-       int nr_streams;
        int wait_fd_is_copy;
        int cpucount;
 };
@@ -91,7 +93,10 @@ struct lttng_ust_lib_ring_buffer;
  * uniquely a stream.
  */
 struct lttng_consumer_stream {
+       /* HT node used by the data_ht and metadata_ht */
        struct lttng_ht_node_ulong node;
+       /* HT node used in consumer_data.stream_list_ht */
+       struct lttng_ht_node_ulong node_session_id;
        struct lttng_consumer_channel *chan;    /* associated channel */
        /*
         * key is the key used by the session daemon to refer to the
@@ -118,6 +123,66 @@ struct lttng_consumer_stream {
        /* UID/GID of the user owning the session to which stream belongs */
        uid_t uid;
        gid_t gid;
+       /* Network sequence number. Indicating on which relayd socket it goes. */
+       int net_seq_idx;
+       /* Identify if the stream is the metadata */
+       unsigned int metadata_flag;
+       /* Used when the stream is set for network streaming */
+       uint64_t relayd_stream_id;
+       /* Next sequence number to use for trace packet */
+       uint64_t next_net_seq_num;
+       /*
+        * Lock to use the stream FDs since they are used between threads. Using
+        * this lock with network streaming, when using the control mutex of a
+        * consumer_relayd_sock_pair, make sure to acquire this lock BEFORE locking
+        * it and releasing it AFTER the control mutex unlock.
+        */
+       pthread_mutex_t lock;
+       /* Tracing session id */
+       uint64_t session_id;
+       /*
+        * Indicates if the stream end point is still active or not (network
+        * streaming or local file system). The thread "owning" the stream is
+        * handling this status and can be notified of a state change through the
+        * consumer data appropriate pipe.
+        */
+       enum consumer_endpoint_status endpoint_status;
+};
+
+/*
+ * Internal representation of a relayd socket pair.
+ */
+struct consumer_relayd_sock_pair {
+       /* Network sequence number. */
+       int net_seq_idx;
+       /* Number of stream associated with this relayd */
+       unsigned int refcount;
+
+       /*
+        * This flag indicates whether or not we should destroy this object. The
+        * destruction should ONLY occurs when this flag is set and the refcount is
+        * set to zero.
+        */
+       unsigned int destroy_flag;
+
+       /*
+        * Mutex protecting the control socket to avoid out of order packets
+        * between threads sending data to the relayd. Since metadata data is sent
+        * over that socket, at least two sendmsg() are needed (header + data)
+        * creating a race for packets to overlap between threads using it.
+        */
+       pthread_mutex_t ctrl_sock_mutex;
+
+       /* Control socket. Command and metadata are passed over it */
+       struct lttcomm_sock control_sock;
+
+       /*
+        * We don't need a mutex at this point since we only splice or write single
+        * large chunk of data with a header appended at the begining. Moreover,
+        * this socket is for now only used in a single thread.
+        */
+       struct lttcomm_sock data_sock;
+       struct lttng_ht_node_ulong node;
 };
 
 /*
@@ -174,17 +239,19 @@ struct lttng_consumer_local_data {
        char *consumer_command_sock_path;
        /* communication with splice */
        int consumer_thread_pipe[2];
-       /* pipe to wake the poll thread when necessary */
-       int consumer_poll_pipe[2];
+       int consumer_splice_metadata_pipe[2];
+       /* Data stream poll thread pipe. To transfer data stream to the thread */
+       int consumer_data_pipe[2];
        /* to let the signal handler wake up the fd receiver thread */
        int consumer_should_quit[2];
+       /* Metadata poll thread pipe. Transfer metadata stream to it */
+       int consumer_metadata_pipe[2];
 };
 
 /*
  * Library-level data. One instance per process.
  */
 struct lttng_consumer_global_data {
-
        /*
         * At this time, this lock is used to ensure coherence between the count
         * and number of element in the hash table. It's also a protection for
@@ -196,13 +263,12 @@ struct lttng_consumer_global_data {
        pthread_mutex_t lock;
 
        /*
-        * Number of streams in the hash table. Protected by consumer_data.lock.
+        * Number of streams in the data stream hash table declared outside.
+        * Protected by consumer_data.lock.
         */
        int stream_count;
-       /*
-        * Hash tables of streams and channels. Protected by consumer_data.lock.
-        */
-       struct lttng_ht *stream_ht;
+
+       /* Channel hash table protected by consumer_data.lock. */
        struct lttng_ht *channel_ht;
        /*
         * Flag specifying if the local array of FDs needs update in the
@@ -210,8 +276,27 @@ struct lttng_consumer_global_data {
         */
        unsigned int need_update;
        enum lttng_consumer_type type;
+
+       /*
+        * Relayd socket(s) hashtable indexed by network sequence number. Each
+        * stream has an index which associate the right relayd socket to use.
+        */
+       struct lttng_ht *relayd_ht;
+
+       /*
+        * This hash table contains all streams (metadata and data) indexed by
+        * session id. In other words, the ht is indexed by session id and each
+        * bucket contains the list of associated streams.
+        *
+        * This HT uses the "node_session_id" of the consumer stream.
+        */
+       struct lttng_ht *stream_list_ht;
 };
 
+/* Defined in consumer.c and coupled with explanations */
+extern struct lttng_ht *metadata_ht;
+extern struct lttng_ht *data_ht;
+
 /*
  * Init consumer data structures.
  */
@@ -261,10 +346,6 @@ extern void lttng_consumer_sync_trace_file(
  */
 extern int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
 
-extern int consumer_update_poll_array(
-               struct lttng_consumer_local_data *ctx, struct pollfd **pollfd,
-               struct lttng_consumer_stream **local_consumer_streams);
-
 extern struct lttng_consumer_stream *consumer_allocate_stream(
                int channel_key, int stream_key,
                int shm_fd, int wait_fd,
@@ -273,19 +354,32 @@ extern struct lttng_consumer_stream *consumer_allocate_stream(
                enum lttng_event_output output,
                const char *path_name,
                uid_t uid,
-               gid_t gid);
-extern int consumer_add_stream(struct lttng_consumer_stream *stream);
-extern void consumer_del_stream(struct lttng_consumer_stream *stream);
-extern void consumer_change_stream_state(int stream_key,
-               enum lttng_consumer_stream_state state);
+               gid_t gid,
+               int net_index,
+               int metadata_flag,
+               uint64_t session_id,
+               int *alloc_ret);
+extern void consumer_del_stream(struct lttng_consumer_stream *stream,
+               struct lttng_ht *ht);
+extern void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
+               struct lttng_ht *ht);
 extern void consumer_del_channel(struct lttng_consumer_channel *channel);
 extern struct lttng_consumer_channel *consumer_allocate_channel(
                int channel_key,
                int shm_fd, int wait_fd,
                uint64_t mmap_len,
-               uint64_t max_sb_size);
+               uint64_t max_sb_size,
+               unsigned int nb_init_streams);
 int consumer_add_channel(struct lttng_consumer_channel *channel);
 
+/* lttng-relayd consumer command */
+struct consumer_relayd_sock_pair *consumer_allocate_relayd_sock_pair(
+               int net_seq_idx);
+struct consumer_relayd_sock_pair *consumer_find_relayd(int key);
+int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
+               size_t data_size);
+void consumer_steal_stream_key(int key, struct lttng_ht *ht);
+
 extern struct lttng_consumer_local_data *lttng_consumer_create(
                enum lttng_consumer_type type,
                ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
@@ -296,23 +390,32 @@ extern struct lttng_consumer_local_data *lttng_consumer_create(
 extern void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
 extern ssize_t lttng_consumer_on_read_subbuffer_mmap(
                struct lttng_consumer_local_data *ctx,
-               struct lttng_consumer_stream *stream, unsigned long len);
+               struct lttng_consumer_stream *stream, unsigned long len,
+               unsigned long padding);
 extern ssize_t lttng_consumer_on_read_subbuffer_splice(
                struct lttng_consumer_local_data *ctx,
-               struct lttng_consumer_stream *stream, unsigned long len);
+               struct lttng_consumer_stream *stream, unsigned long len,
+               unsigned long padding);
 extern int lttng_consumer_take_snapshot(struct lttng_consumer_local_data *ctx,
                struct lttng_consumer_stream *stream);
 extern int lttng_consumer_get_produced_snapshot(
                struct lttng_consumer_local_data *ctx,
                struct lttng_consumer_stream *stream,
                unsigned long *pos);
-extern void *lttng_consumer_thread_poll_fds(void *data);
-extern void *lttng_consumer_thread_receive_fds(void *data);
+extern void *consumer_thread_metadata_poll(void *data);
+extern void *consumer_thread_data_poll(void *data);
+extern void *consumer_thread_sessiond_poll(void *data);
 extern int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
                int sock, struct pollfd *consumer_sockpoll);
 
 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
                struct lttng_consumer_local_data *ctx);
 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
+int consumer_add_relayd_socket(int net_seq_idx, int sock_type,
+               struct lttng_consumer_local_data *ctx, int sock,
+               struct pollfd *consumer_sockpoll, struct lttcomm_sock *relayd_sock);
+void consumer_flag_relayd_for_destroy(
+               struct consumer_relayd_sock_pair *relayd);
+int consumer_data_pending(uint64_t id);
 
-#endif /* _LTTNG_CONSUMER_H */
+#endif /* LIB_CONSUMER_H */
This page took 0.026028 seconds and 4 git commands to generate.