[lttng-tools.git] / src / common / uri.h

/*
 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef URI_H
#define URI_H

#include <netinet/in.h>
#include <lttng/lttng.h>
#include <common/macros.h>

#if defined(__cplusplus)
extern "C" {
#endif

/* Destination type of lttng URI */
enum lttng_dst_type {
	LTTNG_DST_IPV4                        = 1,
	LTTNG_DST_IPV6                        = 2,
	LTTNG_DST_PATH                        = 3,
};

/* Type of lttng URI where it is a final destination or a hop */
enum lttng_uri_type {
	LTTNG_URI_DST,	/* The URI is a final destination */
	/*
	 * Hops are not supported yet but planned for a future release.
	 *
	 LTTNG_URI_HOP,
	 */
};

/* Communication stream type of a lttng URI */
enum lttng_stream_type {
	LTTNG_STREAM_CONTROL,
	LTTNG_STREAM_DATA,
};

/*
 * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
 * should be ignored.
 */
enum lttng_proto_type {
	LTTNG_PROTO_TYPE_NONE                 = 0,
	LTTNG_TCP                             = 1,
	/*
	 * UDP protocol is not supported for now.
	 *
	 LTTNG_UDP                             = 2,
	 */
};

/*
 * Structure representing an URI supported by lttng.
 */
struct lttng_uri {
	enum lttng_dst_type dtype;
	enum lttng_uri_type utype;
	enum lttng_stream_type stype;
	enum lttng_proto_type proto;
	uint16_t port;
	char subdir[LTTNG_PATH_MAX];
	union {
		char ipv4[INET_ADDRSTRLEN];
		char ipv6[INET6_ADDRSTRLEN];
		char path[LTTNG_PATH_MAX];
	} dst;
} LTTNG_PACKED;

int uri_compare(struct lttng_uri *uri1, struct lttng_uri *uri2);
void uri_free(struct lttng_uri *uri);
ssize_t uri_parse(const char *str_uri, struct lttng_uri **uris);
ssize_t uri_parse_str_urls(const char *ctrl_url, const char *data_url,
		struct lttng_uri **uris);
int uri_to_str_url(struct lttng_uri *uri, char *dst, size_t size);

#if defined(__cplusplus)
}
#endif

#endif /* _LTT_URI_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
	3	*
	4	* SPDX-License-Identifier: GPL-2.0-only
	5	*
	6	*/
	7
	8	#ifndef URI_H
	9	#define URI_H
	10
	11	#include <netinet/in.h>
	12	#include <lttng/lttng.h>
	13	#include <common/macros.h>
	14
	15	#if defined(__cplusplus)
	16	extern "C" {
	17	#endif
	18
	19	/* Destination type of lttng URI */
	20	enum lttng_dst_type {
	21	LTTNG_DST_IPV4 = 1,
	22	LTTNG_DST_IPV6 = 2,
	23	LTTNG_DST_PATH = 3,
	24	};
	25
	26	/* Type of lttng URI where it is a final destination or a hop */
	27	enum lttng_uri_type {
	28	LTTNG_URI_DST, /* The URI is a final destination */
	29	/*
	30	* Hops are not supported yet but planned for a future release.
	31	*
	32	LTTNG_URI_HOP,
	33	*/
	34	};
	35
	36	/* Communication stream type of a lttng URI */
	37	enum lttng_stream_type {
	38	LTTNG_STREAM_CONTROL,
	39	LTTNG_STREAM_DATA,
	40	};
	41
	42	/*
	43	* Protocol type of a lttng URI. The value 0 indicate that the proto_type field
	44	* should be ignored.
	45	*/
	46	enum lttng_proto_type {
	47	LTTNG_PROTO_TYPE_NONE = 0,
	48	LTTNG_TCP = 1,
	49	/*
	50	* UDP protocol is not supported for now.
	51	*
	52	LTTNG_UDP = 2,
	53	*/
	54	};
	55
	56	/*
	57	* Structure representing an URI supported by lttng.
	58	*/
	59	struct lttng_uri {
	60	enum lttng_dst_type dtype;
	61	enum lttng_uri_type utype;
	62	enum lttng_stream_type stype;
	63	enum lttng_proto_type proto;
	64	uint16_t port;
	65	char subdir[LTTNG_PATH_MAX];
	66	union {
	67	char ipv4[INET_ADDRSTRLEN];
	68	char ipv6[INET6_ADDRSTRLEN];
	69	char path[LTTNG_PATH_MAX];
	70	} dst;
	71	} LTTNG_PACKED;
	72
	73	int uri_compare(struct lttng_uri uri1, struct lttng_uri uri2);
	74	void uri_free(struct lttng_uri *uri);
	75	ssize_t uri_parse(const char str_uri, struct lttng_uri *uris);
	76	ssize_t uri_parse_str_urls(const char ctrl_url, const char data_url,
	77	struct lttng_uri **uris);
	78	int uri_to_str_url(struct lttng_uri uri, char dst, size_t size);
	79
	80	#if defined(__cplusplus)
	81	}
	82	#endif
	83
	84	#endif /* _LTT_URI_H */