Fix: relayd vs consumerd compatibility
[lttng-tools.git] / src / bin / lttng-relayd / stream.h
... / ...
CommitLineData
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
34/*
35 * Represents a stream in the relay
36 */
37struct relay_stream {
38 uint64_t stream_handle;
39
40 /*
41 * reflock used to synchronize the closing of this stream.
42 * stream reflock nests inside viewer stream reflock.
43 * stream reflock nests inside index reflock.
44 */
45 pthread_mutex_t reflock;
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 lttng_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 * Counts the number of received indexes. The "tag" associated
74 * with an index is taken before incrementing this seqcount.
75 * Therefore, the sequence tag associated with the last index
76 * received is always index_received_seqcount - 1.
77 */
78 uint64_t index_received_seqcount;
79
80 /*
81 * Tracefile array is an index of the stream trace files,
82 * indexed by position. It allows keeping track of the oldest
83 * available indexes when overwriting trace files in tracefile
84 * rotation.
85 */
86 struct tracefile_array *tfa;
87
88 bool closed; /* Stream is closed. */
89 bool close_requested; /* Close command has been received. */
90
91 /*
92 * Counts number of indexes in indexes_ht. Redundant info.
93 * Protected by stream lock.
94 */
95 int indexes_in_flight;
96 struct lttng_ht *indexes_ht;
97
98 /*
99 * If the stream is inactive, this field is updated with the
100 * live beacon timestamp end, when it is active, this
101 * field == -1ULL.
102 */
103 uint64_t beacon_ts_end;
104
105 /* CTF stream ID, -1ULL when unset (first packet not received yet). */
106 uint64_t ctf_stream_id;
107
108 /* Indicate if the stream was initialized for a data pending command. */
109 bool data_pending_check_done;
110
111 /* Is this stream a metadata stream ? */
112 int32_t is_metadata;
113 /* Amount of metadata received (bytes). */
114 uint64_t metadata_received;
115
116 /*
117 * Member of the stream list in struct ctf_trace.
118 * Updates are protected by the stream_list_lock.
119 * Traversals are protected by RCU.
120 */
121 struct cds_list_head stream_node;
122 /*
123 * Temporary list belonging to the connection until all streams
124 * are received for that connection.
125 * Member of the stream recv list in the connection.
126 * Updates are protected by the stream_recv_list_lock.
127 * Traversals are protected by RCU.
128 */
129 bool in_recv_list;
130 struct cds_list_head recv_node;
131 bool published; /* Protected by session lock. */
132 /*
133 * Node of stream within global stream hash table.
134 */
135 struct lttng_ht_node_u64 node;
136 bool in_stream_ht; /* is stream in stream hash table. */
137 struct rcu_head rcu_node; /* For call_rcu teardown. */
138};
139
140struct relay_stream *stream_create(struct ctf_trace *trace,
141 uint64_t stream_handle, char *path_name,
142 char *channel_name, uint64_t tracefile_size,
143 uint64_t tracefile_count);
144
145struct relay_stream *stream_get_by_id(uint64_t stream_id);
146bool stream_get(struct relay_stream *stream);
147void stream_put(struct relay_stream *stream);
148void try_stream_close(struct relay_stream *stream);
149void stream_publish(struct relay_stream *stream);
150void print_relay_streams(void);
151
152#endif /* _STREAM_H */
This page took 0.0242 seconds and 4 git commands to generate.