src/bin/lttng-relayd/stream.h

   1 #ifndef _STREAM_H
   2 #define _STREAM_H
   3
   4 /*
   5  * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
   6  *                      David Goulet <dgoulet@efficios.com>
   7  *               2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License, version 2 only, as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  16  * more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along with
  19  * this program; if not, write to the Free Software Foundation, Inc., 51
  20  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #include <limits.h>
  24 #include <inttypes.h>
  25 #include <pthread.h>
  26 #include <urcu/list.h>
  27
  28 #include <common/hashtable/hashtable.h>
  29
  30 #include "session.h"
  31 #include "stream-fd.h"
  32 #include "tracefile-array.h"
  33 #include "index-file.h"
  34
  35 struct relay_stream_chunk_id {
  36         bool is_set;
  37         uint64_t value;
  38 };
  39
  40 /*
  41  * Represents a stream in the relay
  42  */
  43 struct relay_stream {
  44         uint64_t stream_handle;
  45
  46         struct urcu_ref ref;
  47         /* Back reference to trace. Protected by refcount on trace object. */
  48         struct ctf_trace *trace;
  49
  50         /*
  51          * To protect from concurrent read/update. The viewer stream
  52          * lock nests inside the stream lock. The stream lock nests
  53          * inside the ctf_trace lock.
  54          */
  55         pthread_mutex_t lock;
  56         uint64_t prev_seq;              /* previous data sequence number encountered. */
  57         uint64_t last_net_seq_num;      /* seq num to encounter before closing. */
  58
  59         /* FD on which to write the stream data. */
  60         struct stream_fd *stream_fd;
  61         /* index file on which to write the index data. */
  62         struct relay_index_file *index_file;
  63
  64         char *path_name;
  65         char *channel_name;
  66
  67         /* On-disk circular buffer of tracefiles. */
  68         uint64_t tracefile_size;
  69         uint64_t tracefile_size_current;
  70         uint64_t tracefile_count;
  71
  72         /*
  73          * Position in the tracefile where we have the full index also on disk.
  74          */
  75         uint64_t pos_after_last_complete_data_index;
  76
  77         /*
  78          * Counts the number of received indexes. The "tag" associated
  79          * with an index is taken before incrementing this seqcount.
  80          * Therefore, the sequence tag associated with the last index
  81          * received is always index_received_seqcount - 1.
  82          */
  83         uint64_t index_received_seqcount;
  84
  85         /*
  86          * Tracefile array is an index of the stream trace files,
  87          * indexed by position. It allows keeping track of the oldest
  88          * available indexes when overwriting trace files in tracefile
  89          * rotation.
  90          */
  91         struct tracefile_array *tfa;
  92
  93         bool closed;            /* Stream is closed. */
  94         bool close_requested;   /* Close command has been received. */
  95
  96         /*
  97          * Counts number of indexes in indexes_ht. Redundant info.
  98          * Protected by stream lock.
  99          */
 100         int indexes_in_flight;
 101         struct lttng_ht *indexes_ht;
 102
 103         /*
 104          * If the stream is inactive, this field is updated with the
 105          * live beacon timestamp end, when it is active, this
 106          * field == -1ULL.
 107          */
 108         uint64_t beacon_ts_end;
 109
 110         /* CTF stream ID, -1ULL when unset (first packet not received yet). */
 111         uint64_t ctf_stream_id;
 112
 113         /* Indicate if the stream was initialized for a data pending command. */
 114         bool data_pending_check_done;
 115
 116         /* Is this stream a metadata stream ? */
 117         int32_t is_metadata;
 118         /* Amount of metadata received (bytes). */
 119         uint64_t metadata_received;
 120
 121         /*
 122          * Member of the stream list in struct ctf_trace.
 123          * Updates are protected by the stream_list_lock.
 124          * Traversals are protected by RCU.
 125          */
 126         struct cds_list_head stream_node;
 127         /*
 128          * Temporary list belonging to the connection until all streams
 129          * are received for that connection.
 130          * Member of the stream recv list in the connection.
 131          * Updates are protected by the stream_recv_list_lock.
 132          * Traversals are protected by RCU.
 133          */
 134         bool in_recv_list;
 135         struct cds_list_head recv_node;
 136         bool published; /* Protected by session lock. */
 137         /*
 138          * Node of stream within global stream hash table.
 139          */
 140         struct lttng_ht_node_u64 node;
 141         bool in_stream_ht;              /* is stream in stream hash table. */
 142         struct rcu_head rcu_node;       /* For call_rcu teardown. */
 143         /*
 144          * When we have written the data and index corresponding to this
 145          * seq_num, rotate the tracefile (session rotation). The path_name is
 146          * already up-to-date.
 147          * This is set to -1ULL when no rotation is pending.
 148          *
 149          * Always access with stream lock held.
 150          */
 151         uint64_t rotate_at_seq_num;
 152         /*
 153          * This is the id of the chunk where we are writing to if no rotation is
 154          * pending (rotate_at_seq_num == -1ULL). If a rotation is pending, this
 155          * is the chunk_id we will have after the rotation. It must be updated
 156          * atomically with rotate_at_seq_num.
 157          *
 158          * Always access with stream lock held.
 159          *
 160          * This attribute is not set if the stream is created by a pre-2.11
 161          * consumer.
 162          */
 163         struct relay_stream_chunk_id current_chunk_id;
 164 };
 165
 166 struct relay_stream *stream_create(struct ctf_trace *trace,
 167         uint64_t stream_handle, char *path_name,
 168         char *channel_name, uint64_t tracefile_size,
 169         uint64_t tracefile_count, const struct relay_stream_chunk_id *chunk_id);
 170
 171 struct relay_stream *stream_get_by_id(uint64_t stream_id);
 172 bool stream_get(struct relay_stream *stream);
 173 void stream_put(struct relay_stream *stream);
 174 void try_stream_close(struct relay_stream *stream);
 175 void stream_publish(struct relay_stream *stream);
 176 void print_relay_streams(void);
 177
 178 #endif /* _STREAM_H */