2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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
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.
21 #include <common/common.h>
22 #include <common/utils.h>
23 #include <common/defaults.h>
24 #include <urcu/rculist.h>
27 #include "lttng-relayd.h"
30 #include "viewer-stream.h"
32 /* Should be called with RCU read-side lock held. */
33 bool stream_get(struct relay_stream
*stream
)
37 pthread_mutex_lock(&stream
->reflock
);
38 if (stream
->ref
.refcount
!= 0) {
40 urcu_ref_get(&stream
->ref
);
42 pthread_mutex_unlock(&stream
->reflock
);
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.
52 struct relay_stream
*stream_get_by_id(uint64_t stream_id
)
54 struct lttng_ht_node_u64
*node
;
55 struct lttng_ht_iter iter
;
56 struct relay_stream
*stream
= NULL
;
59 lttng_ht_lookup(relay_streams_ht
, &stream_id
, &iter
);
60 node
= lttng_ht_iter_get_node_u64(&iter
);
62 DBG("Relay stream %" PRIu64
" not found", stream_id
);
65 stream
= caa_container_of(node
, struct relay_stream
, node
);
66 if (!stream_get(stream
)) {
75 * We keep ownership of path_name and channel_name.
77 struct 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
)
83 struct relay_stream
*stream
= NULL
;
84 struct relay_session
*session
= trace
->session
;
86 stream
= zmalloc(sizeof(struct relay_stream
));
88 PERROR("relay stream zmalloc");
92 stream
->stream_handle
= stream_handle
;
93 stream
->prev_seq
= -1ULL;
94 stream
->last_net_seq_num
= -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
;
107 stream
->indexes_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
108 if (!stream
->indexes_ht
) {
109 ERR("Cannot created indexes_ht");
114 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
,
117 ERR("relay creating output directory");
122 * No need to use run_as API here because whatever we receive,
123 * the relayd uses its own credentials for the stream files.
125 ret
= utils_create_stream_file(stream
->path_name
, stream
->channel_name
,
126 stream
->tracefile_size
, 0, -1, -1, NULL
);
128 ERR("Create output file");
131 stream
->stream_fd
= stream_fd_create(ret
);
132 if (!stream
->stream_fd
) {
134 PERROR("Error closing file %d", ret
);
139 stream
->tfa
= tracefile_array_create(stream
->tracefile_count
);
144 if (stream
->tracefile_size
) {
145 DBG("Tracefile %s/%s_0 created", stream
->path_name
, stream
->channel_name
);
147 DBG("Tracefile %s/%s created", stream
->path_name
, stream
->channel_name
);
150 if (!strncmp(stream
->channel_name
, DEFAULT_METADATA_NAME
, LTTNG_NAME_MAX
)) {
151 stream
->is_metadata
= 1;
154 stream
->in_recv_list
= true;
157 * Add the stream in the recv list of the session. Once the end stream
158 * message is received, all session streams are published.
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
);
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.
169 lttng_ht_add_unique_u64(relay_streams_ht
, &stream
->node
);
170 stream
->in_stream_ht
= true;
172 DBG("Relay new stream added %s with ID %" PRIu64
, stream
->channel_name
,
173 stream
->stream_handle
);
178 if (stream
->stream_fd
) {
179 stream_fd_put(stream
->stream_fd
);
180 stream
->stream_fd
= NULL
;
189 * path_name and channel_name need to be freed explicitly here
190 * because we cannot rely on stream_put().
198 * Called with the session lock held.
200 void stream_publish(struct relay_stream
*stream
)
202 struct relay_session
*session
;
204 pthread_mutex_lock(&stream
->lock
);
205 if (stream
->published
) {
209 session
= stream
->trace
->session
;
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;
216 pthread_mutex_unlock(&session
->recv_list_lock
);
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
);
222 stream
->published
= true;
224 pthread_mutex_unlock(&stream
->lock
);
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.
232 static void stream_unpublish(struct relay_stream
*stream
)
234 if (stream
->in_stream_ht
) {
235 struct lttng_ht_iter iter
;
238 iter
.iter
.node
= &stream
->node
.node
;
239 ret
= lttng_ht_del(relay_streams_ht
, &iter
);
241 stream
->in_stream_ht
= false;
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;
251 static void stream_destroy(struct relay_stream
*stream
)
253 if (stream
->indexes_ht
) {
255 * Calling lttng_ht_destroy in call_rcu worker thread so
256 * we don't hold the RCU read-side lock while calling
259 lttng_ht_destroy(stream
->indexes_ht
);
262 tracefile_array_destroy(stream
->tfa
);
264 free(stream
->path_name
);
265 free(stream
->channel_name
);
269 static void stream_destroy_rcu(struct rcu_head
*rcu_head
)
271 struct relay_stream
*stream
=
272 caa_container_of(rcu_head
, struct relay_stream
, rcu_node
);
274 stream_destroy(stream
);
278 * No need to take stream->lock since this is only called on the final
279 * stream_put which ensures that a single thread may act on the stream.
281 * At that point, the object is also protected by the reflock which
282 * guarantees that no other thread may share ownership of this stream.
284 static void stream_release(struct urcu_ref
*ref
)
286 struct relay_stream
*stream
=
287 caa_container_of(ref
, struct relay_stream
, ref
);
288 struct relay_session
*session
;
290 session
= stream
->trace
->session
;
292 DBG("Releasing stream id %" PRIu64
, stream
->stream_handle
);
294 pthread_mutex_lock(&session
->recv_list_lock
);
295 session
->stream_count
--;
296 if (stream
->in_recv_list
) {
297 cds_list_del_rcu(&stream
->recv_node
);
298 stream
->in_recv_list
= false;
300 pthread_mutex_unlock(&session
->recv_list_lock
);
302 stream_unpublish(stream
);
304 if (stream
->stream_fd
) {
305 stream_fd_put(stream
->stream_fd
);
306 stream
->stream_fd
= NULL
;
308 if (stream
->index_file
) {
309 lttng_index_file_put(stream
->index_file
);
310 stream
->index_file
= NULL
;
313 ctf_trace_put(stream
->trace
);
314 stream
->trace
= NULL
;
317 call_rcu(&stream
->rcu_node
, stream_destroy_rcu
);
320 void stream_put(struct relay_stream
*stream
)
322 DBG("stream put for stream id %" PRIu64
, stream
->stream_handle
);
324 * Ensure existence of stream->reflock for stream unlock.
328 * Stream reflock ensures that concurrent test and update of
329 * stream ref is atomic.
331 pthread_mutex_lock(&stream
->reflock
);
332 assert(stream
->ref
.refcount
!= 0);
334 * Wait until we have processed all the stream packets before
335 * actually putting our last stream reference.
337 DBG("stream put stream id %" PRIu64
" refcount %d",
338 stream
->stream_handle
,
339 (int) stream
->ref
.refcount
);
340 urcu_ref_put(&stream
->ref
, stream_release
);
341 pthread_mutex_unlock(&stream
->reflock
);
345 void try_stream_close(struct relay_stream
*stream
)
347 bool session_aborted
;
348 struct relay_session
*session
= stream
->trace
->session
;
350 DBG("Trying to close stream %" PRIu64
, stream
->stream_handle
);
352 pthread_mutex_lock(&session
->lock
);
353 session_aborted
= session
->aborted
;
354 pthread_mutex_unlock(&session
->lock
);
356 pthread_mutex_lock(&stream
->lock
);
358 * Can be called concurently by connection close and reception of last
361 if (stream
->closed
) {
362 pthread_mutex_unlock(&stream
->lock
);
363 DBG("closing stream %" PRIu64
" aborted since it is already marked as closed", stream
->stream_handle
);
367 stream
->close_requested
= true;
369 if (stream
->last_net_seq_num
== -1ULL) {
371 * Handle connection close without explicit stream close
374 * We can be clever about indexes partially received in
375 * cases where we received the data socket part, but not
376 * the control socket part: since we're currently closing
377 * the stream on behalf of the control socket, we *know*
378 * there won't be any more control information for this
379 * socket. Therefore, we can destroy all indexes for
380 * which we have received only the file descriptor (from
381 * data socket). This takes care of consumerd crashes
382 * between sending the data and control information for
383 * a packet. Since those are sent in that order, we take
384 * care of consumerd crashes.
386 relay_index_close_partial_fd(stream
);
388 * Use the highest net_seq_num we currently have pending
389 * As end of stream indicator. Leave last_net_seq_num
390 * at -1ULL if we cannot find any index.
392 stream
->last_net_seq_num
= relay_index_find_last(stream
);
393 /* Fall-through into the next check. */
396 if (stream
->last_net_seq_num
!= -1ULL &&
397 ((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) < 0
398 && !session_aborted
) {
400 * Don't close since we still have data pending. This
401 * handles cases where an explicit close command has
402 * been received for this stream, and cases where the
403 * connection has been closed, and we are awaiting for
404 * index information from the data socket. It is
405 * therefore expected that all the index fd information
406 * we need has already been received on the control
407 * socket. Matching index information from data socket
408 * should be Expected Soon(TM).
410 * TODO: We should implement a timer to garbage collect
411 * streams after a timeout to be resilient against a
412 * consumerd implementation that would not match this
415 pthread_mutex_unlock(&stream
->lock
);
416 DBG("closing stream %" PRIu64
" aborted since it still has data pending", stream
->stream_handle
);
420 * We received all the indexes we can expect.
422 stream_unpublish(stream
);
423 stream
->closed
= true;
424 /* Relay indexes are only used by the "consumer/sessiond" end. */
425 relay_index_close_all(stream
);
426 pthread_mutex_unlock(&stream
->lock
);
427 DBG("Succeeded in closing stream %" PRIu64
, stream
->stream_handle
);
431 static void print_stream_indexes(struct relay_stream
*stream
)
433 struct lttng_ht_iter iter
;
434 struct relay_index
*index
;
437 cds_lfht_for_each_entry(stream
->indexes_ht
->ht
, &iter
.iter
, index
,
439 DBG("index %p net_seq_num %" PRIu64
" refcount %ld"
440 " stream %" PRIu64
" trace %" PRIu64
444 stream
->ref
.refcount
,
445 index
->stream
->stream_handle
,
446 index
->stream
->trace
->id
,
447 index
->stream
->trace
->session
->id
);
452 void print_relay_streams(void)
454 struct lttng_ht_iter iter
;
455 struct relay_stream
*stream
;
457 if (!relay_streams_ht
) {
462 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
464 if (!stream_get(stream
)) {
467 DBG("stream %p refcount %ld stream %" PRIu64
" trace %" PRIu64
470 stream
->ref
.refcount
,
471 stream
->stream_handle
,
473 stream
->trace
->session
->id
);
474 print_stream_indexes(stream
);
This page took 0.039447 seconds and 4 git commands to generate.