Fix: unpublish stream on close
[lttng-tools.git] / src / bin / lttng-relayd / stream.c
CommitLineData
2a174661
DG
1/*
2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
9a78c92e 4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
2a174661
DG
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License, version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20#define _GNU_SOURCE
21#include <common/common.h>
9a78c92e
MD
22#include <common/utils.h>
23#include <common/defaults.h>
24#include <urcu/rculist.h>
25#include <sys/stat.h>
2a174661 26
9a78c92e 27#include "lttng-relayd.h"
2a174661
DG
28#include "index.h"
29#include "stream.h"
30#include "viewer-stream.h"
31
9a78c92e
MD
32/* Should be called with RCU read-side lock held. */
33bool stream_get(struct relay_stream *stream)
34{
35 bool has_ref = false;
36
37 pthread_mutex_lock(&stream->reflock);
38 if (stream->ref.refcount != 0) {
39 has_ref = true;
40 urcu_ref_get(&stream->ref);
41 }
42 pthread_mutex_unlock(&stream->reflock);
43
44 return has_ref;
45}
46
2a174661 47/*
9a78c92e
MD
48 * Get stream from stream id from the streams hash table. Return stream
49 * if found else NULL. A stream reference is taken when a stream is
50 * returned. stream_put() must be called on that stream.
2a174661 51 */
9a78c92e 52struct relay_stream *stream_get_by_id(uint64_t stream_id)
2a174661
DG
53{
54 struct lttng_ht_node_u64 *node;
55 struct lttng_ht_iter iter;
56 struct relay_stream *stream = NULL;
57
9a78c92e
MD
58 rcu_read_lock();
59 lttng_ht_lookup(relay_streams_ht, &stream_id, &iter);
2a174661 60 node = lttng_ht_iter_get_node_u64(&iter);
9a78c92e 61 if (!node) {
2a174661
DG
62 DBG("Relay stream %" PRIu64 " not found", stream_id);
63 goto end;
64 }
65 stream = caa_container_of(node, struct relay_stream, node);
9a78c92e
MD
66 if (!stream_get(stream)) {
67 stream = NULL;
68 }
2a174661 69end:
9a78c92e 70 rcu_read_unlock();
2a174661
DG
71 return stream;
72}
73
74/*
9a78c92e 75 * We keep ownership of path_name and channel_name.
2a174661 76 */
9a78c92e
MD
77struct relay_stream *stream_create(struct ctf_trace *trace,
78 uint64_t stream_handle, char *path_name,
79 char *channel_name, uint64_t tracefile_size,
80 uint64_t tracefile_count)
2a174661 81{
9a78c92e
MD
82 int ret;
83 struct relay_stream *stream = NULL;
84 struct relay_session *session = trace->session;
2a174661 85
9a78c92e
MD
86 stream = zmalloc(sizeof(struct relay_stream));
87 if (stream == NULL) {
88 PERROR("relay stream zmalloc");
89 ret = -1;
90 goto error_no_alloc;
91 }
2a174661 92
9a78c92e
MD
93 stream->stream_handle = stream_handle;
94 stream->prev_seq = -1ULL;
95 stream->ctf_stream_id = -1ULL;
96 stream->tracefile_size = tracefile_size;
97 stream->tracefile_count = tracefile_count;
98 stream->path_name = path_name;
99 stream->channel_name = channel_name;
100 lttng_ht_node_init_u64(&stream->node, stream->stream_handle);
101 pthread_mutex_init(&stream->lock, NULL);
102 pthread_mutex_init(&stream->reflock, NULL);
103 urcu_ref_init(&stream->ref);
104 ctf_trace_get(trace);
105 stream->trace = trace;
2a174661 106
9a78c92e
MD
107 stream->indexes_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
108 if (!stream->indexes_ht) {
109 ERR("Cannot created indexes_ht");
110 ret = -1;
111 goto end;
2a174661
DG
112 }
113
9a78c92e
MD
114 ret = utils_mkdir_recursive(stream->path_name, S_IRWXU | S_IRWXG,
115 -1, -1);
116 if (ret < 0) {
117 ERR("relay creating output directory");
118 goto end;
119 }
2a174661 120
9a78c92e
MD
121 /*
122 * No need to use run_as API here because whatever we receive,
123 * the relayd uses its own credentials for the stream files.
124 */
125 ret = utils_create_stream_file(stream->path_name, stream->channel_name,
126 stream->tracefile_size, 0, -1, -1, NULL);
127 if (ret < 0) {
128 ERR("Create output file");
129 goto end;
130 }
131 stream->stream_fd = stream_fd_create(ret);
132 if (!stream->stream_fd) {
133 if (close(ret)) {
134 PERROR("Error closing file %d", ret);
2a174661 135 }
9a78c92e
MD
136 ret = -1;
137 goto end;
2a174661 138 }
c00978f1
MD
139 stream->tfa = tracefile_array_create(stream->tracefile_count);
140 if (!stream->tfa) {
141 ret = -1;
142 goto end;
143 }
9a78c92e
MD
144 if (stream->tracefile_size) {
145 DBG("Tracefile %s/%s_0 created", stream->path_name, stream->channel_name);
146 } else {
147 DBG("Tracefile %s/%s created", stream->path_name, stream->channel_name);
148 }
149
150 if (!strncmp(stream->channel_name, DEFAULT_METADATA_NAME, NAME_MAX)) {
151 stream->is_metadata = 1;
152 }
153
154 stream->in_recv_list = true;
155
156 /*
157 * Add the stream in the recv list of the session. Once the end stream
158 * message is received, all session streams are published.
159 */
160 pthread_mutex_lock(&session->recv_list_lock);
161 cds_list_add_rcu(&stream->recv_node, &session->recv_list);
162 session->stream_count++;
163 pthread_mutex_unlock(&session->recv_list_lock);
164
165 /*
166 * Both in the ctf_trace object and the global stream ht since the data
167 * side of the relayd does not have the concept of session.
168 */
169 lttng_ht_add_unique_u64(relay_streams_ht, &stream->node);
ffc70591 170 stream->in_stream_ht = true;
2a174661 171
9a78c92e
MD
172 DBG("Relay new stream added %s with ID %" PRIu64, stream->channel_name,
173 stream->stream_handle);
174 ret = 0;
175
176end:
177 if (ret) {
178 if (stream->stream_fd) {
179 stream_fd_put(stream->stream_fd);
180 stream->stream_fd = NULL;
2a174661 181 }
9a78c92e
MD
182 stream_put(stream);
183 stream = NULL;
2a174661 184 }
9a78c92e 185 return stream;
2a174661 186
9a78c92e
MD
187error_no_alloc:
188 /*
189 * path_name and channel_name need to be freed explicitly here
190 * because we cannot rely on stream_put().
191 */
192 free(path_name);
193 free(channel_name);
194 return NULL;
195}
196
197/*
198 * Called with the session lock held.
199 */
200void stream_publish(struct relay_stream *stream)
201{
202 struct relay_session *session;
203
204 pthread_mutex_lock(&stream->lock);
205 if (stream->published) {
206 goto unlock;
2a174661
DG
207 }
208
9a78c92e 209 session = stream->trace->session;
2a174661 210
9a78c92e
MD
211 pthread_mutex_lock(&session->recv_list_lock);
212 if (stream->in_recv_list) {
213 cds_list_del_rcu(&stream->recv_node);
214 stream->in_recv_list = false;
215 }
216 pthread_mutex_unlock(&session->recv_list_lock);
2a174661 217
9a78c92e
MD
218 pthread_mutex_lock(&stream->trace->stream_list_lock);
219 cds_list_add_rcu(&stream->stream_node, &stream->trace->stream_list);
220 pthread_mutex_unlock(&stream->trace->stream_list_lock);
2a174661 221
9a78c92e
MD
222 stream->published = true;
223unlock:
2a174661 224 pthread_mutex_unlock(&stream->lock);
2a174661
DG
225}
226
9a78c92e 227/*
ffc70591
MD
228 * Stream must be protected by holding the stream lock or by virtue of being
229 * called from stream_destroy, in which case it is guaranteed to be accessed
230 * from a single thread by the reflock.
9a78c92e
MD
231 */
232static void stream_unpublish(struct relay_stream *stream)
2a174661 233{
ffc70591
MD
234 if (stream->in_stream_ht) {
235 struct lttng_ht_iter iter;
236 int ret;
237
238 iter.iter.node = &stream->node.node;
239 ret = lttng_ht_del(relay_streams_ht, &iter);
240 assert(!ret);
241 stream->in_stream_ht = false;
242 }
243 if (stream->published) {
244 pthread_mutex_lock(&stream->trace->stream_list_lock);
245 cds_list_del_rcu(&stream->stream_node);
246 pthread_mutex_unlock(&stream->trace->stream_list_lock);
247 stream->published = false;
9a78c92e 248 }
9a78c92e
MD
249}
250
251static void stream_destroy(struct relay_stream *stream)
252{
253 if (stream->indexes_ht) {
254 lttng_ht_destroy(stream->indexes_ht);
255 }
c00978f1
MD
256 if (stream->tfa) {
257 tracefile_array_destroy(stream->tfa);
258 }
9a78c92e
MD
259 free(stream->path_name);
260 free(stream->channel_name);
261 free(stream);
262}
263
264static void stream_destroy_rcu(struct rcu_head *rcu_head)
265{
266 struct relay_stream *stream =
267 caa_container_of(rcu_head, struct relay_stream, rcu_node);
268
269 stream_destroy(stream);
270}
271
272/*
273 * No need to take stream->lock since this is only called on the final
274 * stream_put which ensures that a single thread may act on the stream.
275 *
276 * At that point, the object is also protected by the reflock which
277 * guarantees that no other thread may share ownership of this stream.
278 */
279static void stream_release(struct urcu_ref *ref)
280{
281 struct relay_stream *stream =
282 caa_container_of(ref, struct relay_stream, ref);
283 struct relay_session *session;
2a174661 284
9a78c92e
MD
285 session = stream->trace->session;
286
287 DBG("Releasing stream id %" PRIu64, stream->stream_handle);
288
289 pthread_mutex_lock(&session->recv_list_lock);
290 session->stream_count--;
291 if (stream->in_recv_list) {
292 cds_list_del_rcu(&stream->recv_node);
293 stream->in_recv_list = false;
294 }
295 pthread_mutex_unlock(&session->recv_list_lock);
2a174661 296
9a78c92e
MD
297 stream_unpublish(stream);
298
299 if (stream->stream_fd) {
300 stream_fd_put(stream->stream_fd);
301 stream->stream_fd = NULL;
302 }
303 if (stream->index_fd) {
304 stream_fd_put(stream->index_fd);
305 stream->index_fd = NULL;
306 }
307 if (stream->trace) {
308 ctf_trace_put(stream->trace);
309 stream->trace = NULL;
310 }
311
312 call_rcu(&stream->rcu_node, stream_destroy_rcu);
2a174661
DG
313}
314
9a78c92e 315void stream_put(struct relay_stream *stream)
2a174661 316{
9a78c92e
MD
317 DBG("stream put for stream id %" PRIu64, stream->stream_handle);
318 /*
319 * Ensure existence of stream->reflock for stream unlock.
320 */
321 rcu_read_lock();
322 /*
323 * Stream reflock ensures that concurrent test and update of
324 * stream ref is atomic.
325 */
326 pthread_mutex_lock(&stream->reflock);
327 assert(stream->ref.refcount != 0);
328 /*
329 * Wait until we have processed all the stream packets before
330 * actually putting our last stream reference.
331 */
332 DBG("stream put stream id %" PRIu64 " refcount %d",
333 stream->stream_handle,
334 (int) stream->ref.refcount);
335 urcu_ref_put(&stream->ref, stream_release);
336 pthread_mutex_unlock(&stream->reflock);
337 rcu_read_unlock();
338}
339
340void stream_close(struct relay_stream *stream)
341{
342 DBG("closing stream %" PRIu64, stream->stream_handle);
343 pthread_mutex_lock(&stream->lock);
ffc70591 344 stream_unpublish(stream);
64bda0b4 345 stream->closed = true;
9a78c92e
MD
346 relay_index_close_all(stream);
347 pthread_mutex_unlock(&stream->lock);
348 stream_put(stream);
349}
350
351void print_relay_streams(void)
352{
353 struct lttng_ht_iter iter;
354 struct relay_stream *stream;
355
356 rcu_read_lock();
357 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
358 node.node) {
359 if (!stream_get(stream)) {
360 continue;
361 }
362 DBG("stream %p refcount %ld stream %" PRIu64 " trace %" PRIu64
363 " session %" PRIu64,
364 stream,
365 stream->ref.refcount,
366 stream->stream_handle,
367 stream->trace->id,
368 stream->trace->session->id);
369 stream_put(stream);
370 }
371 rcu_read_unlock();
2a174661 372}
This page took 0.042012 seconds and 4 git commands to generate.