[lttng-tools.git] / src / bin / lttng-relayd / 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 _GNU_SOURCE
#define _LGPL_SOURCE
#include <common/common.h>
#include <common/utils.h>
#include <common/defaults.h>
#include <urcu/rculist.h>
#include <sys/stat.h>

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

/* Should be called with RCU read-side lock held. */
bool stream_get(struct relay_stream *stream)
{
	bool has_ref = false;

	pthread_mutex_lock(&stream->reflock);
	if (stream->ref.refcount != 0) {
		has_ref = true;
		urcu_ref_get(&stream->ref);
	}
	pthread_mutex_unlock(&stream->reflock);

	return has_ref;
}

/*
 * Get stream from stream id from the streams hash table. Return stream
 * if found else NULL. A stream reference is taken when a stream is
 * returned. stream_put() must be called on that stream.
 */
struct relay_stream *stream_get_by_id(uint64_t stream_id)
{
	struct lttng_ht_node_u64 *node;
	struct lttng_ht_iter iter;
	struct relay_stream *stream = NULL;

	rcu_read_lock();
	lttng_ht_lookup(relay_streams_ht, &stream_id, &iter);
	node = lttng_ht_iter_get_node_u64(&iter);
	if (!node) {
		DBG("Relay stream %" PRIu64 " not found", stream_id);
		goto end;
	}
	stream = caa_container_of(node, struct relay_stream, node);
	if (!stream_get(stream)) {
		stream = NULL;
	}
end:
	rcu_read_unlock();
	return stream;
}

/*
 * We keep ownership of path_name and channel_name.
 */
struct relay_stream *stream_create(struct ctf_trace *trace,
	uint64_t stream_handle, char *path_name,
	char *channel_name, uint64_t tracefile_size,
	uint64_t tracefile_count)
{
	int ret;
	struct relay_stream *stream = NULL;
	struct relay_session *session = trace->session;

	stream = zmalloc(sizeof(struct relay_stream));
	if (stream == NULL) {
		PERROR("relay stream zmalloc");
		ret = -1;
		goto error_no_alloc;
	}

	stream->stream_handle = stream_handle;
	stream->prev_seq = -1ULL;
	stream->ctf_stream_id = -1ULL;
	stream->tracefile_size = tracefile_size;
	stream->tracefile_count = tracefile_count;
	stream->path_name = path_name;
	stream->channel_name = channel_name;
	lttng_ht_node_init_u64(&stream->node, stream->stream_handle);
	pthread_mutex_init(&stream->lock, NULL);
	pthread_mutex_init(&stream->reflock, NULL);
	urcu_ref_init(&stream->ref);
	ctf_trace_get(trace);
	stream->trace = trace;

	stream->indexes_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
	if (!stream->indexes_ht) {
		ERR("Cannot created indexes_ht");
		ret = -1;
		goto end;
	}

	ret = utils_mkdir_recursive(stream->path_name, S_IRWXU | S_IRWXG,
			-1, -1);
	if (ret < 0) {
		ERR("relay creating output directory");
		goto end;
	}

	/*
	 * No need to use run_as API here because whatever we receive,
	 * the relayd uses its own credentials for the stream files.
	 */
	ret = utils_create_stream_file(stream->path_name, stream->channel_name,
			stream->tracefile_size, 0, -1, -1, NULL);
	if (ret < 0) {
		ERR("Create output file");
		goto end;
	}
	stream->stream_fd = stream_fd_create(ret);
	if (!stream->stream_fd) {
		if (close(ret)) {
			PERROR("Error closing file %d", ret);
		}
		ret = -1;
		goto end;
	}
	stream->tfa = tracefile_array_create(stream->tracefile_count);
	if (!stream->tfa) {
		ret = -1;
		goto end;
	}
	if (stream->tracefile_size) {
		DBG("Tracefile %s/%s_0 created", stream->path_name, stream->channel_name);
	} else {
		DBG("Tracefile %s/%s created", stream->path_name, stream->channel_name);
	}

	if (!strncmp(stream->channel_name, DEFAULT_METADATA_NAME, NAME_MAX)) {
		stream->is_metadata = 1;
	}

	stream->in_recv_list = true;

	/*
	 * Add the stream in the recv list of the session. Once the end stream
	 * message is received, all session streams are published.
	 */
	pthread_mutex_lock(&session->recv_list_lock);
	cds_list_add_rcu(&stream->recv_node, &session->recv_list);
	session->stream_count++;
	pthread_mutex_unlock(&session->recv_list_lock);

	/*
	 * Both in the ctf_trace object and the global stream ht since the data
	 * side of the relayd does not have the concept of session.
	 */
	lttng_ht_add_unique_u64(relay_streams_ht, &stream->node);

	DBG("Relay new stream added %s with ID %" PRIu64, stream->channel_name,
			stream->stream_handle);
	ret = 0;

end:
	if (ret) {
		if (stream->stream_fd) {
			stream_fd_put(stream->stream_fd);
			stream->stream_fd = NULL;
		}
		stream_put(stream);
		stream = NULL;
	}
	return stream;

error_no_alloc:
	/*
	 * path_name and channel_name need to be freed explicitly here
	 * because we cannot rely on stream_put().
	 */
	free(path_name);
	free(channel_name);
	return NULL;
}

/*
 * Called with the session lock held.
 */
void stream_publish(struct relay_stream *stream)
{
	struct relay_session *session;

	pthread_mutex_lock(&stream->lock);
	if (stream->published) {
		goto unlock;
	}

	session = stream->trace->session;

	pthread_mutex_lock(&session->recv_list_lock);
	if (stream->in_recv_list) {
		cds_list_del_rcu(&stream->recv_node);
		stream->in_recv_list = false;
	}
	pthread_mutex_unlock(&session->recv_list_lock);

	pthread_mutex_lock(&stream->trace->stream_list_lock);
	cds_list_add_rcu(&stream->stream_node, &stream->trace->stream_list);
	pthread_mutex_unlock(&stream->trace->stream_list_lock);

	stream->published = true;
unlock:
	pthread_mutex_unlock(&stream->lock);
}

/*
 * Only called from destroy. No stream lock needed, since there is a
 * single user at this point. This is ensured by having the refcount
 * reaching 0.
 */
static void stream_unpublish(struct relay_stream *stream)
{
	if (!stream->published) {
		return;
	}
	pthread_mutex_lock(&stream->trace->stream_list_lock);
	cds_list_del_rcu(&stream->stream_node);
	pthread_mutex_unlock(&stream->trace->stream_list_lock);

	stream->published = false;
}

static void stream_destroy(struct relay_stream *stream)
{
	if (stream->indexes_ht) {
		lttng_ht_destroy(stream->indexes_ht);
	}
	if (stream->tfa) {
		tracefile_array_destroy(stream->tfa);
	}
	free(stream->path_name);
	free(stream->channel_name);
	free(stream);
}

static void stream_destroy_rcu(struct rcu_head *rcu_head)
{
	struct relay_stream *stream =
		caa_container_of(rcu_head, struct relay_stream, rcu_node);

	stream_destroy(stream);
}

/*
 * No need to take stream->lock since this is only called on the final
 * stream_put which ensures that a single thread may act on the stream.
 *
 * At that point, the object is also protected by the reflock which
 * guarantees that no other thread may share ownership of this stream.
 */
static void stream_release(struct urcu_ref *ref)
{
	struct relay_stream *stream =
		caa_container_of(ref, struct relay_stream, ref);
	struct relay_session *session;
	int ret;
	struct lttng_ht_iter iter;

	session = stream->trace->session;

	DBG("Releasing stream id %" PRIu64, stream->stream_handle);

	pthread_mutex_lock(&session->recv_list_lock);
	session->stream_count--;
	if (stream->in_recv_list) {
		cds_list_del_rcu(&stream->recv_node);
		stream->in_recv_list = false;
	}
	pthread_mutex_unlock(&session->recv_list_lock);

	iter.iter.node = &stream->node.node;
	ret = lttng_ht_del(relay_streams_ht, &iter);
	assert(!ret);

	stream_unpublish(stream);

	if (stream->stream_fd) {
		stream_fd_put(stream->stream_fd);
		stream->stream_fd = NULL;
	}
	if (stream->index_fd) {
		stream_fd_put(stream->index_fd);
		stream->index_fd = NULL;
	}
	if (stream->trace) {
		ctf_trace_put(stream->trace);
		stream->trace = NULL;
	}

	call_rcu(&stream->rcu_node, stream_destroy_rcu);
}

void stream_put(struct relay_stream *stream)
{
	DBG("stream put for stream id %" PRIu64, stream->stream_handle);
	/*
	 * Ensure existence of stream->reflock for stream unlock.
	 */
	rcu_read_lock();
	/*
	 * Stream reflock ensures that concurrent test and update of
	 * stream ref is atomic.
	 */
	pthread_mutex_lock(&stream->reflock);
	assert(stream->ref.refcount != 0);
	/*
	 * Wait until we have processed all the stream packets before
	 * actually putting our last stream reference.
	 */
	DBG("stream put stream id %" PRIu64 " refcount %d",
			stream->stream_handle,
			(int) stream->ref.refcount);
	urcu_ref_put(&stream->ref, stream_release);
	pthread_mutex_unlock(&stream->reflock);
	rcu_read_unlock();
}

void stream_close(struct relay_stream *stream)
{
	DBG("closing stream %" PRIu64, stream->stream_handle);
	pthread_mutex_lock(&stream->lock);
	stream->closed = true;
	relay_index_close_all(stream);
	pthread_mutex_unlock(&stream->lock);
	stream_put(stream);
}

void print_relay_streams(void)
{
	struct lttng_ht_iter iter;
	struct relay_stream *stream;

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