[babeltrace.git] / formats / lttng-live / lttng-live-plugin.c

/*
 * BabelTrace - LTTng live Output
 *
 * Copyright 2013 Julien Desfossez <jdesfossez@efficios.com>
 *                Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <babeltrace/ctf-text/types.h>
#include <babeltrace/format.h>
#include <babeltrace/babeltrace-internal.h>
#include <inttypes.h>
#include <sys/mman.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <dirent.h>
#include <glib.h>
#include <unistd.h>
#include <stdlib.h>
#include <signal.h>
#include "lttng-live.h"

static volatile int should_quit;

int lttng_live_should_quit(void)
{
	return should_quit;
}

static
void sighandler(int sig)
{
	switch (sig) {
	case SIGTERM:
	case SIGINT:
		should_quit = 1;
		break;
	default:
		break;
	}
}

/*
 * TODO: Eventually, this signal handler setup should be done at the
 * plugin manager level, rather than within this plugin. Beware, we are
 * not cleaning up the signal handler after plugin execution.
 */
static
int setup_sighandler(void)
{
	struct sigaction sa;
	sigset_t sigset;
	int ret;

	if ((ret = sigemptyset(&sigset)) < 0) {
		perror("sigemptyset");
		return ret;
	}
	sa.sa_handler = sighandler;
	sa.sa_mask = sigset;
	sa.sa_flags = 0;
	if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
		perror("sigaction");
		return ret;
	}
	if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
		perror("sigaction");
		return ret;
	}
	return 0;
}

/*
 * hostname parameter needs to hold MAXNAMLEN chars.
 */
static
int parse_url(const char *path, struct lttng_live_ctx *ctx)
{
	char remain[3][MAXNAMLEN];
	int ret = -1, proto, proto_offset = 0;
	size_t path_len = strlen(path);	/* not accounting \0 */

	/*
	 * Since sscanf API does not allow easily checking string length
	 * against a size defined by a macro. Test it beforehand on the
	 * input. We know the output is always <= than the input length.
	 */
	if (path_len >= MAXNAMLEN) {
		goto end;
	}
	ret = sscanf(path, "net%d://", &proto);
	if (ret < 1) {
		proto = 4;
		/* net:// */
		proto_offset = strlen("net://");
	} else {
		/* net4:// or net6:// */
		proto_offset = strlen("netX://");
	}
	if (proto_offset > path_len) {
		goto end;
	}
	/* TODO : parse for IPv6 as well */
	/* Parse the hostname or IP */
	ret = sscanf(&path[proto_offset], "%[a-zA-Z.0-9%-]%s",
		ctx->relay_hostname, remain[0]);
	if (ret == 2) {
		/* Optional port number */
		switch (remain[0][0]) {
		case ':':
			ret = sscanf(remain[0], ":%d%s", &ctx->port, remain[1]);
			/* Optional session ID with port number */
			if (ret == 2) {
				ret = sscanf(remain[1], "/%s", remain[2]);
				/* Accept 0 or 1 (optional) */
				if (ret < 0) {
					goto end;
				}
			} else if (ret == 0) {
				fprintf(stderr, "[error] Missing port number after delimitor ':'\n");
				ret = -1;
				goto end;
			}
			break;
		case '/':
			/* Optional session ID */
			ret = sscanf(remain[0], "/%s", remain[2]);
			/* Accept 0 or 1 (optional) */
			if (ret < 0) {
				goto end;
			}
			break;
		default:
			fprintf(stderr, "[error] wrong delimitor : %c\n",
				remain[0][0]);
			ret = -1;
			goto end;
		}
	}

	if (ctx->port < 0) {
		ctx->port = LTTNG_DEFAULT_NETWORK_VIEWER_PORT;
	}

	if (strlen(remain[2]) == 0) {
		printf_verbose("Connecting to hostname : %s, port : %d, "
				"proto : IPv%d\n",
				ctx->relay_hostname, ctx->port, proto);
		ret = 0;
		goto end;
	}
	ret = sscanf(remain[2], "host/%[a-zA-Z.0-9%-]/%s",
			ctx->traced_hostname, ctx->session_name);
	if (ret != 2) {
		fprintf(stderr, "[error] Format : "
			"net://<hostname>/host/<traced_hostname>/<session_name>\n");
		goto end;
	}

	printf_verbose("Connecting to hostname : %s, port : %d, "
			"traced hostname : %s, session name : %s, "
			"proto : IPv%d\n",
			ctx->relay_hostname, ctx->port, ctx->traced_hostname,
			ctx->session_name, proto);
	ret = 0;

end:
	return ret;
}

static
guint g_uint64p_hash(gconstpointer key)
{
	uint64_t v = *(uint64_t *) key;

	if (sizeof(gconstpointer) == sizeof(uint64_t)) {
		return g_direct_hash((gconstpointer) (unsigned long) v);
	} else {
		return g_direct_hash((gconstpointer) (unsigned long) (v >> 32))
			^ g_direct_hash((gconstpointer) (unsigned long) v);
	}
}

static
gboolean g_uint64p_equal(gconstpointer a, gconstpointer b)
{
	uint64_t va = *(uint64_t *) a;
	uint64_t vb = *(uint64_t *) b;

	if (va != vb)
		return FALSE;
	return TRUE;
}

static int lttng_live_open_trace_read(const char *path)
{
	int ret = 0;
	struct lttng_live_ctx *ctx;

	ctx = g_new0(struct lttng_live_ctx, 1);
	ctx->session = g_new0(struct lttng_live_session, 1);

	/* We need a pointer to the context from the packet_seek function. */
	ctx->session->ctx = ctx;

	/* HT to store the CTF traces. */
	ctx->session->ctf_traces = g_hash_table_new(g_uint64p_hash,
			g_uint64p_equal);
	ctx->port = -1;
	ctx->session_ids = g_array_new(FALSE, TRUE, sizeof(uint64_t));

	ret = parse_url(path, ctx);
	if (ret < 0) {
		goto end_free;
	}
	ret = setup_sighandler();
	if (ret < 0) {
		goto end_free;
	}
	ret = lttng_live_connect_viewer(ctx);
	if (ret < 0) {
		goto end_free;
	}
	printf_verbose("LTTng-live connected to relayd\n");

	ret = lttng_live_establish_connection(ctx);
	if (ret < 0) {
		goto end_free;
	}

	printf_verbose("Listing sessions\n");
	ret = lttng_live_list_sessions(ctx, path);
	if (ret < 0) {
		goto end_free;
	}

	if (ctx->session_ids->len > 0) {
		ret = lttng_live_read(ctx);
	}

end_free:
	g_hash_table_destroy(ctx->session->ctf_traces);
	g_free(ctx->session);
	g_free(ctx->session->streams);
	g_free(ctx);

	if (lttng_live_should_quit()) {
		ret = 0;
	}
	return ret;
}

static
struct bt_trace_descriptor *lttng_live_open_trace(const char *path, int flags,
		void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
			int whence), FILE *metadata_fp)
{
	struct ctf_text_stream_pos *pos;

	switch (flags & O_ACCMODE) {
	case O_RDONLY:
		/* OK */
		break;
	case O_RDWR:
		fprintf(stderr, "[error] lttng live plugin cannot be used as output plugin.\n");
		goto error;
	default:
		fprintf(stderr, "[error] Incorrect open flags.\n");
		goto error;
	}

	pos = g_new0(struct ctf_text_stream_pos, 1);
	pos->parent.rw_table = NULL;
	pos->parent.event_cb = NULL;
	pos->parent.trace = &pos->trace_descriptor;
	if (lttng_live_open_trace_read(path) < 0) {
		goto error;
	}
	return &pos->trace_descriptor;

error:
	return NULL;
}

static
int lttng_live_close_trace(struct bt_trace_descriptor *td)
{
	struct ctf_text_stream_pos *pos =
		container_of(td, struct ctf_text_stream_pos,
			trace_descriptor);
	free(pos);
	return 0;
}

static
struct bt_format lttng_live_format = {
	.open_trace = lttng_live_open_trace,
	.close_trace = lttng_live_close_trace,
};

static
void __attribute__((constructor)) lttng_live_init(void)
{
	int ret;

	lttng_live_format.name = g_quark_from_static_string("lttng-live");
	ret = bt_register_format(&lttng_live_format);
	assert(!ret);
}

static
void __attribute__((destructor)) lttng_live_exit(void)
{
	bt_unregister_format(&lttng_live_format);
}
Commit	Line	Data
4a744367 JD	1	/*
	2	* BabelTrace - LTTng live Output
	3	*
	4	* Copyright 2013 Julien Desfossez <jdesfossez@efficios.com>
	5	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#include <babeltrace/ctf-text/types.h>
	27	#include <babeltrace/format.h>
	28	#include <babeltrace/babeltrace-internal.h>
	29	#include <inttypes.h>
	30	#include <sys/mman.h>
	31	#include <errno.h>
	32	#include <sys/types.h>
	33	#include <sys/stat.h>
	34	#include <fcntl.h>
	35	#include <dirent.h>
	36	#include <glib.h>
	37	#include <unistd.h>
	38	#include <stdlib.h>
8ace20bf	39	#include <signal.h>
c98627ca	40	#include "lttng-live.h"
4a744367	41
8ace20bf MD	42	static volatile int should_quit;
	43
	44	int lttng_live_should_quit(void)
	45	{
	46	return should_quit;
	47	}
	48
	49	static
	50	void sighandler(int sig)
	51	{
	52	switch (sig) {
	53	case SIGTERM:
	54	case SIGINT:
	55	should_quit = 1;
	56	break;
	57	default:
	58	break;
	59	}
	60	}
	61
	62	/*
	63	* TODO: Eventually, this signal handler setup should be done at the
	64	* plugin manager level, rather than within this plugin. Beware, we are
	65	* not cleaning up the signal handler after plugin execution.
	66	*/
	67	static
	68	int setup_sighandler(void)
	69	{
	70	struct sigaction sa;
	71	sigset_t sigset;
	72	int ret;
	73
	74	if ((ret = sigemptyset(&sigset)) < 0) {
	75	perror("sigemptyset");
	76	return ret;
	77	}
	78	sa.sa_handler = sighandler;
	79	sa.sa_mask = sigset;
	80	sa.sa_flags = 0;
	81	if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
	82	perror("sigaction");
	83	return ret;
	84	}
	85	if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
	86	perror("sigaction");
	87	return ret;
	88	}
	89	return 0;
	90	}
	91
e84d6f79	92	/*
0206bb4a	93	* hostname parameter needs to hold MAXNAMLEN chars.
e84d6f79	94	*/
b5a1fa45 JD	95	static
b5a1fa45 JD	96	int parse_url(const char path, struct lttng_live_ctx ctx)
4a744367	97	{
0206bb4a	98	char remain[3][MAXNAMLEN];
e84d6f79	99	int ret = -1, proto, proto_offset = 0;
5fe17d06	100	size_t path_len = strlen(path); /* not accounting \0 */
4a744367	101
e84d6f79 MD	102	/*
	103	* Since sscanf API does not allow easily checking string length
	104	* against a size defined by a macro. Test it beforehand on the
	105	* input. We know the output is always <= than the input length.
	106	*/
0206bb4a	107	if (path_len >= MAXNAMLEN) {
e84d6f79 MD	108	goto end;
	109	}
	110	ret = sscanf(path, "net%d://", &proto);
	111	if (ret < 1) {
4a744367 JD	112	proto = 4;
	113	/* net:// */
	114	proto_offset = strlen("net://");
	115	} else {
	116	/* net4:// or net6:// */
	117	proto_offset = strlen("netX://");
	118	}
e84d6f79 MD	119	if (proto_offset > path_len) {
	120	goto end;
	121	}
4a744367 JD	122	/* TODO : parse for IPv6 as well */
4a744367 JD	123	/* Parse the hostname or IP */
e84d6f79	124	ret = sscanf(&path[proto_offset], "%[a-zA-Z.0-9%-]%s",
b5a1fa45	125	ctx->relay_hostname, remain[0]);
4a744367 JD	126	if (ret == 2) {
4a744367 JD	127	/* Optional port number */
e84d6f79 MD	128	switch (remain[0][0]) {
e84d6f79 MD	129	case ':':
b5a1fa45	130	ret = sscanf(remain[0], ":%d%s", &ctx->port, remain[1]);
4a744367 JD	131	/* Optional session ID with port number */
4a744367 JD	132	if (ret == 2) {
2acdc547	133	ret = sscanf(remain[1], "/%s", remain[2]);
e84d6f79 MD	134	/* Accept 0 or 1 (optional) */
	135	if (ret < 0) {
	136	goto end;
	137	}
9010d19c	138	} else if (ret == 0) {
2a6d197b MD	139	fprintf(stderr, "[error] Missing port number after delimitor ':'\n");
	140	ret = -1;
	141	goto end;
4a744367	142	}
e84d6f79 MD	143	break;
e84d6f79 MD	144	case '/':
4a744367	145	/* Optional session ID */
2acdc547	146	ret = sscanf(remain[0], "/%s", remain[2]);
e84d6f79 MD	147	/* Accept 0 or 1 (optional) */
	148	if (ret < 0) {
	149	goto end;
	150	}
	151	break;
	152	default:
4a744367	153	fprintf(stderr, "[error] wrong delimitor : %c\n",
e84d6f79	154	remain[0][0]);
4a744367 JD	155	ret = -1;
	156	goto end;
	157	}
	158	}
	159
49a4acef	160	if (ctx->port < 0) {
b5a1fa45	161	ctx->port = LTTNG_DEFAULT_NETWORK_VIEWER_PORT;
49a4acef	162	}
4a744367	163
2acdc547	164	if (strlen(remain[2]) == 0) {
4a744367 JD	165	printf_verbose("Connecting to hostname : %s, port : %d, "
4a744367 JD	166	"proto : IPv%d\n",
b5a1fa45	167	ctx->relay_hostname, ctx->port, proto);
2acdc547 JD	168	ret = 0;
	169	goto end;
	170	}
b5a1fa45 JD	171	ret = sscanf(remain[2], "host/%[a-zA-Z.0-9%-]/%s",
	172	ctx->traced_hostname, ctx->session_name);
	173	if (ret != 2) {
	174	fprintf(stderr, "[error] Format : "
	175	"net://<hostname>/host/<traced_hostname>/<session_name>\n");
	176	goto end;
	177	}
2acdc547 JD	178
2acdc547 JD	179	printf_verbose("Connecting to hostname : %s, port : %d, "
b5a1fa45 JD	180	"traced hostname : %s, session name : %s, "
	181	"proto : IPv%d\n",
	182	ctx->relay_hostname, ctx->port, ctx->traced_hostname,
	183	ctx->session_name, proto);
4a744367 JD	184	ret = 0;
	185
	186	end:
	187	return ret;
	188	}
	189
37307240 MD	190	static
	191	guint g_uint64p_hash(gconstpointer key)
	192	{
	193	uint64_t v = (uint64_t ) key;
	194
	195	if (sizeof(gconstpointer) == sizeof(uint64_t)) {
	196	return g_direct_hash((gconstpointer) (unsigned long) v);
	197	} else {
	198	return g_direct_hash((gconstpointer) (unsigned long) (v >> 32))
	199	^ g_direct_hash((gconstpointer) (unsigned long) v);
	200	}
	201	}
	202
	203	static
	204	gboolean g_uint64p_equal(gconstpointer a, gconstpointer b)
	205	{
	206	uint64_t va = (uint64_t ) a;
	207	uint64_t vb = (uint64_t ) b;
	208
	209	if (va != vb)
	210	return FALSE;
	211	return TRUE;
	212	}
	213
4a744367 JD	214	static int lttng_live_open_trace_read(const char *path)
4a744367 JD	215	{
4a744367	216	int ret = 0;
b5a1fa45	217	struct lttng_live_ctx *ctx;
4a744367	218
b5a1fa45 JD	219	ctx = g_new0(struct lttng_live_ctx, 1);
b5a1fa45 JD	220	ctx->session = g_new0(struct lttng_live_session, 1);
3af4fc48	221
4a744367	222	/* We need a pointer to the context from the packet_seek function. */
b5a1fa45	223	ctx->session->ctx = ctx;
4a744367 JD	224
4a744367 JD	225	/* HT to store the CTF traces. */
37307240 MD	226	ctx->session->ctf_traces = g_hash_table_new(g_uint64p_hash,
37307240 MD	227	g_uint64p_equal);
b5a1fa45 JD	228	ctx->port = -1;
b5a1fa45 JD	229	ctx->session_ids = g_array_new(FALSE, TRUE, sizeof(uint64_t));
4a744367	230
b5a1fa45	231	ret = parse_url(path, ctx);
4a744367 JD	232	if (ret < 0) {
	233	goto end_free;
	234	}
8ace20bf MD	235	ret = setup_sighandler();
	236	if (ret < 0) {
	237	goto end_free;
	238	}
b5a1fa45	239	ret = lttng_live_connect_viewer(ctx);
4a744367	240	if (ret < 0) {
4a744367 JD	241	goto end_free;
	242	}
	243	printf_verbose("LTTng-live connected to relayd\n");
	244
b5a1fa45	245	ret = lttng_live_establish_connection(ctx);
4a744367 JD	246	if (ret < 0) {
	247	goto end_free;
	248	}
	249
b5a1fa45 JD	250	printf_verbose("Listing sessions\n");
	251	ret = lttng_live_list_sessions(ctx, path);
	252	if (ret < 0) {
b5a1fa45	253	goto end_free;
4a744367 JD	254	}
4a744367 JD	255
49a4acef	256	if (ctx->session_ids->len > 0) {
28756729	257	ret = lttng_live_read(ctx);
49a4acef	258	}
b5a1fa45	259
4a744367	260	end_free:
b5a1fa45 JD	261	g_hash_table_destroy(ctx->session->ctf_traces);
	262	g_free(ctx->session);
	263	g_free(ctx->session->streams);
	264	g_free(ctx);
8ace20bf MD	265
	266	if (lttng_live_should_quit()) {
	267	ret = 0;
	268	}
4a744367 JD	269	return ret;
	270	}
	271
	272	static
	273	struct bt_trace_descriptor lttng_live_open_trace(const char path, int flags,
	274	void (packet_seek)(struct bt_stream_pos pos, size_t index,
	275	int whence), FILE *metadata_fp)
	276	{
	277	struct ctf_text_stream_pos *pos;
	278
	279	switch (flags & O_ACCMODE) {
	280	case O_RDONLY:
	281	/* OK */
	282	break;
	283	case O_RDWR:
	284	fprintf(stderr, "[error] lttng live plugin cannot be used as output plugin.\n");
	285	goto error;
	286	default:
	287	fprintf(stderr, "[error] Incorrect open flags.\n");
	288	goto error;
	289	}
	290
	291	pos = g_new0(struct ctf_text_stream_pos, 1);
	292	pos->parent.rw_table = NULL;
	293	pos->parent.event_cb = NULL;
	294	pos->parent.trace = &pos->trace_descriptor;
28756729 JG	295	if (lttng_live_open_trace_read(path) < 0) {
	296	goto error;
	297	}
4a744367 JD	298	return &pos->trace_descriptor;
	299
	300	error:
	301	return NULL;
	302	}
	303
	304	static
	305	int lttng_live_close_trace(struct bt_trace_descriptor *td)
	306	{
	307	struct ctf_text_stream_pos *pos =
	308	container_of(td, struct ctf_text_stream_pos,
	309	trace_descriptor);
	310	free(pos);
	311	return 0;
	312	}
	313
	314	static
	315	struct bt_format lttng_live_format = {
	316	.open_trace = lttng_live_open_trace,
	317	.close_trace = lttng_live_close_trace,
	318	};
	319
	320	static
	321	void __attribute__((constructor)) lttng_live_init(void)
	322	{
	323	int ret;
	324
	325	lttng_live_format.name = g_quark_from_static_string("lttng-live");
	326	ret = bt_register_format(&lttng_live_format);
	327	assert(!ret);
	328	}
	329
	330	static
	331	void __attribute__((destructor)) lttng_live_exit(void)
	332	{
	333	bt_unregister_format(&lttng_live_format);
	334	}