[lttng-tools.git] / src / bin / lttng-relayd / viewer-stream.c

/*
 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
 *                      David Goulet <dgoulet@efficios.com>
 *               2015 - Mathieu Desnoyers <mathieu.desnoyers@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, as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#define _LGPL_SOURCE
#include <common/common.h>
#include <common/compat/string.h>

#include "lttng-relayd.h"
#include "viewer-stream.h"
#include "index-file.h"

static void viewer_stream_destroy(struct relay_viewer_stream *vstream)
{
	free(vstream->path_name);
	free(vstream->channel_name);
	free(vstream);
}

static void viewer_stream_destroy_rcu(struct rcu_head *head)
{
	struct relay_viewer_stream *vstream =
		caa_container_of(head, struct relay_viewer_stream, rcu_node);

	viewer_stream_destroy(vstream);
}

struct relay_viewer_stream *viewer_stream_create(struct relay_stream *stream,
		enum lttng_viewer_seek seek_t)
{
	struct relay_viewer_stream *vstream;

	vstream = zmalloc(sizeof(*vstream));
	if (!vstream) {
		PERROR("relay viewer stream zmalloc");
		goto error;
	}

	vstream->path_name = lttng_strndup(stream->path_name, LTTNG_VIEWER_PATH_MAX);
	if (vstream->path_name == NULL) {
		PERROR("relay viewer path_name alloc");
		goto error;
	}
	vstream->channel_name = lttng_strndup(stream->channel_name,
			LTTNG_VIEWER_NAME_MAX);
	if (vstream->channel_name == NULL) {
		PERROR("relay viewer channel_name alloc");
		goto error;
	}

	if (!stream_get(stream)) {
		ERR("Cannot get stream");
		goto error;
	}
	vstream->stream = stream;

	pthread_mutex_lock(&stream->lock);

	if (stream->is_metadata && stream->trace->viewer_metadata_stream) {
		ERR("Cannot attach viewer metadata stream to trace (busy).");
		goto error_unlock;
	}

	switch (seek_t) {
	case LTTNG_VIEWER_SEEK_BEGINNING:
	{
		uint64_t seq_tail = tracefile_array_get_seq_tail(stream->tfa);

		if (seq_tail == -1ULL) {
			/*
			 * Tail may not be initialized yet. Nonetheless, we know
			 * we want to send the first index once it becomes
			 * available.
			 */
			seq_tail = 0;
		}
		vstream->current_tracefile_id =
			tracefile_array_get_file_index_tail(stream->tfa);
		vstream->index_sent_seqcount = seq_tail;
		break;
	}
	case LTTNG_VIEWER_SEEK_LAST:
		vstream->current_tracefile_id =
			tracefile_array_get_file_index_head(stream->tfa);
		/*
		 * We seek at the very end of each stream, awaiting for
		 * a future packet to eventually come in.
		 *
		 * We don't need to check the head position for -1ULL since the
		 * increment will set it to 0.
		 */
		vstream->index_sent_seqcount =
				tracefile_array_get_seq_head(stream->tfa) + 1;
		break;
	default:
		goto error_unlock;
	}

	/*
	 * If we never received an index for the current stream, delay
	 * the opening of the index, otherwise open it right now.
	 */
	if (stream->index_received_seqcount == 0) {
		vstream->index_file = NULL;
	} else {
		vstream->index_file = relay_index_file_open(vstream->path_name,
				vstream->channel_name,
				stream->tracefile_count,
				vstream->current_tracefile_id);
		if (!vstream->index_file) {
			goto error_unlock;
		}
	}

	if (seek_t == LTTNG_VIEWER_SEEK_LAST && vstream->index_file) {
		int ret;

		ret = relay_index_file_seek_end(vstream->index_file);
		if (ret < 0) {
			goto error_unlock;
		}
	}
	if (stream->is_metadata) {
		rcu_assign_pointer(stream->trace->viewer_metadata_stream,
				vstream);
	}
	pthread_mutex_unlock(&stream->lock);

	/* Globally visible after the add unique. */
	lttng_ht_node_init_u64(&vstream->stream_n, stream->stream_handle);
	urcu_ref_init(&vstream->ref);
	lttng_ht_add_unique_u64(viewer_streams_ht, &vstream->stream_n);

	return vstream;

error_unlock:
	pthread_mutex_unlock(&stream->lock);
error:
	if (vstream) {
		viewer_stream_destroy(vstream);
	}
	return NULL;
}

static void viewer_stream_unpublish(struct relay_viewer_stream *vstream)
{
	int ret;
	struct lttng_ht_iter iter;

	iter.iter.node = &vstream->stream_n.node;
	ret = lttng_ht_del(viewer_streams_ht, &iter);
	assert(!ret);
}

static void viewer_stream_release(struct urcu_ref *ref)
{
	struct relay_viewer_stream *vstream = caa_container_of(ref,
			struct relay_viewer_stream, ref);

	if (vstream->stream->is_metadata) {
		rcu_assign_pointer(vstream->stream->trace->viewer_metadata_stream, NULL);
	}

	viewer_stream_unpublish(vstream);

	if (vstream->stream_fd) {
		stream_fd_put(vstream->stream_fd);
		vstream->stream_fd = NULL;
	}
	if (vstream->index_file) {
		relay_index_file_put(vstream->index_file);
		vstream->index_file = NULL;
	}
	if (vstream->stream) {
		stream_put(vstream->stream);
		vstream->stream = NULL;
	}
	call_rcu(&vstream->rcu_node, viewer_stream_destroy_rcu);
}

/* Must be called with RCU read-side lock held. */
bool viewer_stream_get(struct relay_viewer_stream *vstream)
{
	return urcu_ref_get_unless_zero(&vstream->ref);
}

/*
 * Get viewer stream by id.
 *
 * Return viewer stream if found else NULL.
 */
struct relay_viewer_stream *viewer_stream_get_by_id(uint64_t id)
{
	struct lttng_ht_node_u64 *node;
	struct lttng_ht_iter iter;
	struct relay_viewer_stream *vstream = NULL;

	rcu_read_lock();
	lttng_ht_lookup(viewer_streams_ht, &id, &iter);
	node = lttng_ht_iter_get_node_u64(&iter);
	if (!node) {
		DBG("Relay viewer stream %" PRIu64 " not found", id);
		goto end;
	}
	vstream = caa_container_of(node, struct relay_viewer_stream, stream_n);
	if (!viewer_stream_get(vstream)) {
		vstream = NULL;
	}
end:
	rcu_read_unlock();
	return vstream;
}

void viewer_stream_put(struct relay_viewer_stream *vstream)
{
	rcu_read_lock();
	urcu_ref_put(&vstream->ref, viewer_stream_release);
	rcu_read_unlock();
}

/*
 * Rotate a stream to the next tracefile.
 *
 * Must be called with the rstream lock held.
 * Returns 0 on success, 1 on EOF, a negative value on error.
 */
int viewer_stream_rotate(struct relay_viewer_stream *vstream)
{
	int ret;
	struct relay_stream *stream = vstream->stream;
	uint64_t new_id;

	/* Detect the last tracefile to open. */
	if (stream->index_received_seqcount
			== vstream->index_sent_seqcount
			&& stream->trace->session->connection_closed) {
		ret = 1;
		goto end;
	}

	if (stream->tracefile_count == 0) {
		/* Ignore rotation, there is none to do. */
		ret = 0;
		goto end;
	}

	/*
	 * Try to move to the next file.
	 */
	new_id = (vstream->current_tracefile_id + 1)
			% stream->tracefile_count;
	if (tracefile_array_seq_in_file(stream->tfa, new_id,
			vstream->index_sent_seqcount)) {
		vstream->current_tracefile_id = new_id;
	} else {
		uint64_t seq_tail = tracefile_array_get_seq_tail(stream->tfa);

		/*
		 * This can only be reached on overwrite, which implies there
		 * has been data written at some point, which will have set the
		 * tail.
		 */
		assert(seq_tail != -1ULL);
		/*
		 * We need to resync because we lag behind tail.
		 */
		vstream->current_tracefile_id =
			tracefile_array_get_file_index_tail(stream->tfa);
		vstream->index_sent_seqcount = seq_tail;
	}

	if (vstream->index_file) {
		relay_index_file_put(vstream->index_file);
		vstream->index_file = NULL;
	}
	if (vstream->stream_fd) {
		stream_fd_put(vstream->stream_fd);
		vstream->stream_fd = NULL;
	}

	vstream->index_file = relay_index_file_open(vstream->path_name,
			vstream->channel_name,
			stream->tracefile_count,
			vstream->current_tracefile_id);
	if (!vstream->index_file) {
		ret = -1;
		goto end;
	} else {
		ret = 0;
	}
end:
	return ret;
}

void print_viewer_streams(void)
{
	struct lttng_ht_iter iter;
	struct relay_viewer_stream *vstream;

	if (!viewer_streams_ht) {
		return;
	}

	rcu_read_lock();
	cds_lfht_for_each_entry(viewer_streams_ht->ht, &iter.iter, vstream,
			stream_n.node) {
		if (!viewer_stream_get(vstream)) {
			continue;
		}
		DBG("vstream %p refcount %ld stream %" PRIu64 " trace %" PRIu64
			" session %" PRIu64,
			vstream,
			vstream->ref.refcount,
			vstream->stream->stream_handle,
			vstream->stream->trace->id,
			vstream->stream->trace->session->id);
		viewer_stream_put(vstream);
	}
	rcu_read_unlock();
}
Commit	Line	Data
2f8f53af DG	1	/*
	2	* Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
	3	* David Goulet <dgoulet@efficios.com>
7591bab1	4	* 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
2f8f53af 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
6c1c0768	20	#define _LGPL_SOURCE
2f8f53af	21	#include <common/common.h>
f5436bfc	22	#include <common/compat/string.h>
2f8f53af DG	23
	24	#include "lttng-relayd.h"
	25	#include "viewer-stream.h"
2b508613	26	#include "index-file.h"
2f8f53af	27
7591bab1	28	static void viewer_stream_destroy(struct relay_viewer_stream *vstream)
2f8f53af	29	{
7591bab1 MD	30	free(vstream->path_name);
	31	free(vstream->channel_name);
	32	free(vstream);
2f8f53af DG	33	}
2f8f53af DG	34
7591bab1	35	static void viewer_stream_destroy_rcu(struct rcu_head *head)
2f8f53af	36	{
7591bab1	37	struct relay_viewer_stream *vstream =
2f8f53af DG	38	caa_container_of(head, struct relay_viewer_stream, rcu_node);
2f8f53af DG	39
7591bab1	40	viewer_stream_destroy(vstream);
2f8f53af DG	41	}
	42
	43	struct relay_viewer_stream viewer_stream_create(struct relay_stream stream,
7591bab1	44	enum lttng_viewer_seek seek_t)
2f8f53af DG	45	{
	46	struct relay_viewer_stream *vstream;
	47
2f8f53af DG	48	vstream = zmalloc(sizeof(*vstream));
	49	if (!vstream) {
	50	PERROR("relay viewer stream zmalloc");
	51	goto error;
	52	}
	53
f5436bfc	54	vstream->path_name = lttng_strndup(stream->path_name, LTTNG_VIEWER_PATH_MAX);
b272577e MD	55	if (vstream->path_name == NULL) {
	56	PERROR("relay viewer path_name alloc");
	57	goto error;
	58	}
f5436bfc	59	vstream->channel_name = lttng_strndup(stream->channel_name,
2f8f53af	60	LTTNG_VIEWER_NAME_MAX);
b272577e MD	61	if (vstream->channel_name == NULL) {
	62	PERROR("relay viewer channel_name alloc");
	63	goto error;
	64	}
2f8f53af	65
a44ca2ca MD	66	if (!stream_get(stream)) {
	67	ERR("Cannot get stream");
	68	goto error;
	69	}
	70	vstream->stream = stream;
	71
	72	pthread_mutex_lock(&stream->lock);
	73
	74	if (stream->is_metadata && stream->trace->viewer_metadata_stream) {
	75	ERR("Cannot attach viewer metadata stream to trace (busy).");
	76	goto error_unlock;
	77	}
	78
2f8f53af	79	switch (seek_t) {
c4e361a4	80	case LTTNG_VIEWER_SEEK_BEGINNING:
a44ca2ca MD	81	{
	82	uint64_t seq_tail = tracefile_array_get_seq_tail(stream->tfa);
	83
	84	if (seq_tail == -1ULL) {
	85	/*
	86	* Tail may not be initialized yet. Nonetheless, we know
	87	* we want to send the first index once it becomes
	88	* available.
	89	*/
	90	seq_tail = 0;
	91	}
	92	vstream->current_tracefile_id =
	93	tracefile_array_get_file_index_tail(stream->tfa);
	94	vstream->index_sent_seqcount = seq_tail;
2f8f53af	95	break;
a44ca2ca	96	}
c4e361a4	97	case LTTNG_VIEWER_SEEK_LAST:
a44ca2ca MD	98	vstream->current_tracefile_id =
	99	tracefile_array_get_file_index_head(stream->tfa);
	100	/*
	101	* We seek at the very end of each stream, awaiting for
	102	* a future packet to eventually come in.
	103	*
	104	* We don't need to check the head position for -1ULL since the
	105	* increment will set it to 0.
	106	*/
	107	vstream->index_sent_seqcount =
	108	tracefile_array_get_seq_head(stream->tfa) + 1;
2f8f53af DG	109	break;
2f8f53af DG	110	default:
a44ca2ca	111	goto error_unlock;
2f8f53af	112	}
2f8f53af	113
2f8f53af	114	/*
a44ca2ca MD	115	* If we never received an index for the current stream, delay
a44ca2ca MD	116	* the opening of the index, otherwise open it right now.
2f8f53af	117	*/
a44ca2ca	118	if (stream->index_received_seqcount == 0) {
f8f3885c	119	vstream->index_file = NULL;
2f8f53af	120	} else {
2b508613	121	vstream->index_file = relay_index_file_open(vstream->path_name,
f8f3885c	122	vstream->channel_name,
7591bab1 MD	123	stream->tracefile_count,
7591bab1 MD	124	vstream->current_tracefile_id);
f8f3885c	125	if (!vstream->index_file) {
7591bab1	126	goto error_unlock;
2f8f53af	127	}
2f8f53af DG	128	}
2f8f53af DG	129
f8f3885c	130	if (seek_t == LTTNG_VIEWER_SEEK_LAST && vstream->index_file) {
2b508613	131	int ret;
2f8f53af	132
2b508613 JG	133	ret = relay_index_file_seek_end(vstream->index_file);
2b508613 JG	134	if (ret < 0) {
7591bab1	135	goto error_unlock;
2f8f53af	136	}
7591bab1	137	}
7591bab1 MD	138	if (stream->is_metadata) {
	139	rcu_assign_pointer(stream->trace->viewer_metadata_stream,
	140	vstream);
2f8f53af	141	}
a44ca2ca	142	pthread_mutex_unlock(&stream->lock);
2f8f53af	143
7591bab1 MD	144	/* Globally visible after the add unique. */
7591bab1 MD	145	lttng_ht_node_init_u64(&vstream->stream_n, stream->stream_handle);
7591bab1	146	urcu_ref_init(&vstream->ref);
de9ee3dd	147	lttng_ht_add_unique_u64(viewer_streams_ht, &vstream->stream_n);
7591bab1	148
2f8f53af DG	149	return vstream;
2f8f53af DG	150
7591bab1 MD	151	error_unlock:
7591bab1 MD	152	pthread_mutex_unlock(&stream->lock);
2f8f53af DG	153	error:
2f8f53af DG	154	if (vstream) {
7591bab1	155	viewer_stream_destroy(vstream);
2f8f53af DG	156	}
	157	return NULL;
	158	}
	159
7591bab1	160	static void viewer_stream_unpublish(struct relay_viewer_stream *vstream)
2f8f53af DG	161	{
	162	int ret;
	163	struct lttng_ht_iter iter;
	164
7591bab1	165	iter.iter.node = &vstream->stream_n.node;
2f8f53af DG	166	ret = lttng_ht_del(viewer_streams_ht, &iter);
	167	assert(!ret);
	168	}
	169
7591bab1	170	static void viewer_stream_release(struct urcu_ref *ref)
2f8f53af	171	{
7591bab1 MD	172	struct relay_viewer_stream *vstream = caa_container_of(ref,
7591bab1 MD	173	struct relay_viewer_stream, ref);
2a174661	174
7591bab1 MD	175	if (vstream->stream->is_metadata) {
7591bab1 MD	176	rcu_assign_pointer(vstream->stream->trace->viewer_metadata_stream, NULL);
2a174661	177	}
2f8f53af	178
7591bab1 MD	179	viewer_stream_unpublish(vstream);
	180
	181	if (vstream->stream_fd) {
	182	stream_fd_put(vstream->stream_fd);
	183	vstream->stream_fd = NULL;
2f8f53af	184	}
f8f3885c	185	if (vstream->index_file) {
2b508613	186	relay_index_file_put(vstream->index_file);
f8f3885c	187	vstream->index_file = NULL;
7591bab1 MD	188	}
	189	if (vstream->stream) {
	190	stream_put(vstream->stream);
	191	vstream->stream = NULL;
	192	}
	193	call_rcu(&vstream->rcu_node, viewer_stream_destroy_rcu);
	194	}
	195
	196	/* Must be called with RCU read-side lock held. */
	197	bool viewer_stream_get(struct relay_viewer_stream *vstream)
	198	{
ce4d4083	199	return urcu_ref_get_unless_zero(&vstream->ref);
2f8f53af DG	200	}
	201
	202	/*
7591bab1	203	* Get viewer stream by id.
2f8f53af	204	*
7591bab1	205	* Return viewer stream if found else NULL.
2f8f53af	206	*/
7591bab1	207	struct relay_viewer_stream *viewer_stream_get_by_id(uint64_t id)
2f8f53af DG	208	{
	209	struct lttng_ht_node_u64 *node;
	210	struct lttng_ht_iter iter;
7591bab1	211	struct relay_viewer_stream *vstream = NULL;
2f8f53af	212
7591bab1	213	rcu_read_lock();
2f8f53af DG	214	lttng_ht_lookup(viewer_streams_ht, &id, &iter);
	215	node = lttng_ht_iter_get_node_u64(&iter);
	216	if (!node) {
	217	DBG("Relay viewer stream %" PRIu64 " not found", id);
	218	goto end;
	219	}
7591bab1 MD	220	vstream = caa_container_of(node, struct relay_viewer_stream, stream_n);
	221	if (!viewer_stream_get(vstream)) {
	222	vstream = NULL;
	223	}
2f8f53af	224	end:
7591bab1 MD	225	rcu_read_unlock();
	226	return vstream;
	227	}
	228
	229	void viewer_stream_put(struct relay_viewer_stream *vstream)
	230	{
	231	rcu_read_lock();
7591bab1	232	urcu_ref_put(&vstream->ref, viewer_stream_release);
7591bab1 MD	233	rcu_read_unlock();
	234	}
	235
2f8f53af DG	236	/*
	237	* Rotate a stream to the next tracefile.
	238	*
7591bab1	239	* Must be called with the rstream lock held.
2f8f53af DG	240	* Returns 0 on success, 1 on EOF, a negative value on error.
2f8f53af DG	241	*/
7591bab1	242	int viewer_stream_rotate(struct relay_viewer_stream *vstream)
2f8f53af DG	243	{
2f8f53af DG	244	int ret;
7591bab1	245	struct relay_stream *stream = vstream->stream;
a44ca2ca	246	uint64_t new_id;
2f8f53af	247
7591bab1	248	/* Detect the last tracefile to open. */
a44ca2ca MD	249	if (stream->index_received_seqcount
a44ca2ca MD	250	== vstream->index_sent_seqcount
7591bab1 MD	251	&& stream->trace->session->connection_closed) {
7591bab1 MD	252	ret = 1;
2a174661 DG	253	goto end;
2a174661 DG	254	}
2f8f53af	255
7591bab1 MD	256	if (stream->tracefile_count == 0) {
	257	/* Ignore rotation, there is none to do. */
	258	ret = 0;
2f8f53af DG	259	goto end;
	260	}
	261
a44ca2ca MD	262	/*
	263	* Try to move to the next file.
	264	*/
	265	new_id = (vstream->current_tracefile_id + 1)
	266	% stream->tracefile_count;
	267	if (tracefile_array_seq_in_file(stream->tfa, new_id,
	268	vstream->index_sent_seqcount)) {
	269	vstream->current_tracefile_id = new_id;
2f8f53af	270	} else {
a44ca2ca MD	271	uint64_t seq_tail = tracefile_array_get_seq_tail(stream->tfa);
	272
	273	/*
	274	* This can only be reached on overwrite, which implies there
	275	* has been data written at some point, which will have set the
	276	* tail.
	277	*/
	278	assert(seq_tail != -1ULL);
	279	/*
	280	* We need to resync because we lag behind tail.
	281	*/
7591bab1	282	vstream->current_tracefile_id =
a44ca2ca MD	283	tracefile_array_get_file_index_tail(stream->tfa);
a44ca2ca MD	284	vstream->index_sent_seqcount = seq_tail;
2f8f53af	285	}
2f8f53af	286
f8f3885c	287	if (vstream->index_file) {
2b508613	288	relay_index_file_put(vstream->index_file);
f8f3885c	289	vstream->index_file = NULL;
2f8f53af	290	}
7591bab1 MD	291	if (vstream->stream_fd) {
	292	stream_fd_put(vstream->stream_fd);
	293	vstream->stream_fd = NULL;
2f8f53af	294	}
2f8f53af	295
2b508613	296	vstream->index_file = relay_index_file_open(vstream->path_name,
f8f3885c	297	vstream->channel_name,
7591bab1 MD	298	stream->tracefile_count,
7591bab1 MD	299	vstream->current_tracefile_id);
f8f3885c MD	300	if (!vstream->index_file) {
f8f3885c MD	301	ret = -1;
7591bab1	302	goto end;
7591bab1	303	} else {
f8f3885c	304	ret = 0;
2f8f53af	305	}
2f8f53af	306	end:
2f8f53af DG	307	return ret;
2f8f53af DG	308	}
7591bab1 MD	309
	310	void print_viewer_streams(void)
	311	{
	312	struct lttng_ht_iter iter;
	313	struct relay_viewer_stream *vstream;
	314
ce3f3ba3 JG	315	if (!viewer_streams_ht) {
	316	return;
	317	}
	318
7591bab1 MD	319	rcu_read_lock();
	320	cds_lfht_for_each_entry(viewer_streams_ht->ht, &iter.iter, vstream,
	321	stream_n.node) {
	322	if (!viewer_stream_get(vstream)) {
	323	continue;
	324	}
	325	DBG("vstream %p refcount %ld stream %" PRIu64 " trace %" PRIu64
	326	" session %" PRIu64,
	327	vstream,
	328	vstream->ref.refcount,
	329	vstream->stream->stream_handle,
	330	vstream->stream->trace->id,
	331	vstream->stream->trace->session->id);
	332	viewer_stream_put(vstream);
	333	}
	334	rcu_read_unlock();
	335	}