[lttng-tools.git] / include / lttng / location-internal.hpp

/*
 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_LOCATION_INTERNAL_H
#define LTTNG_LOCATION_INTERNAL_H

#include <common/buffer-view.hpp>
#include <common/dynamic-buffer.hpp>
#include <common/macros.hpp>

#include <lttng/location.h>

#include <sys/types.h>
#include <urcu/ref.h>

/*
 * The public API assumes that trace archive locations are always
 * provided as "constant". This means that the user of liblttng-ctl never
 * has to destroy a trace archive location. Hence, users of liblttng-ctl
 * have no visibility of the reference counting of archive locations.
 */
struct lttng_trace_archive_location {
	struct urcu_ref ref;
	enum lttng_trace_archive_location_type type;
	union {
		struct {
			char *absolute_path;
		} local;
		struct {
			char *host;
			enum lttng_trace_archive_location_relay_protocol_type protocol;
			struct {
				uint16_t control, data;
			} ports;
			char *relative_path;
		} relay;
	} types;
};

struct lttng_trace_archive_location_comm {
	/* A value from enum lttng_trace_archive_location_type */
	int8_t type;
	union {
		struct {
			/* Includes the trailing \0. */
			uint32_t absolute_path_len;
		} LTTNG_PACKED local;
		struct {
			/* Includes the trailing \0. */
			uint32_t hostname_len;
			/*
			 * A value from
			 * enum lttng_trace_archive_location_relay_protocol_type.
			 */
			int8_t protocol;
			struct {
				uint16_t control, data;
			} ports;
			/* Includes the trailing \0. */
			uint32_t relative_path_len;
		} LTTNG_PACKED relay;
	} LTTNG_PACKED types;
	/*
	 * Payload is composed of:
	 * - LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
	 *   - absolute path, including \0
	 * - LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
	 *   - hostname, including \0
	 *   - relative path, including \0
	 */
	char payload[];
} LTTNG_PACKED;

struct lttng_trace_archive_location *lttng_trace_archive_location_local_create(const char *path);

struct lttng_trace_archive_location *lttng_trace_archive_location_relay_create(
	const char *host,
	enum lttng_trace_archive_location_relay_protocol_type protocol,
	uint16_t control_port,
	uint16_t data_port,
	const char *relative_path);

ssize_t
lttng_trace_archive_location_create_from_buffer(const struct lttng_buffer_view *buffer,
						struct lttng_trace_archive_location **location);

ssize_t lttng_trace_archive_location_serialize(const struct lttng_trace_archive_location *location,
					       struct lttng_dynamic_buffer *buffer);

void lttng_trace_archive_location_get(struct lttng_trace_archive_location *location);

void lttng_trace_archive_location_put(struct lttng_trace_archive_location *location);

#endif /* LTTNG_LOCATION_INTERNAL_H */
Commit	Line	Data
434131e4	1	/*
ab5be9fa	2	* Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
434131e4	3	*
ab5be9fa	4	* SPDX-License-Identifier: LGPL-2.1-only
434131e4	5	*
434131e4 JG	6	*/
	7
	8	#ifndef LTTNG_LOCATION_INTERNAL_H
	9	#define LTTNG_LOCATION_INTERNAL_H
	10
c9e313bc	11	#include <common/buffer-view.hpp>
28f23191	12	#include <common/dynamic-buffer.hpp>
c9e313bc	13	#include <common/macros.hpp>
28f23191 JG	14
	15	#include <lttng/location.h>
	16
89293443	17	#include <sys/types.h>
d3740619	18	#include <urcu/ref.h>
434131e4	19
d3740619 JR	20	/*
	21	* The public API assumes that trace archive locations are always
	22	* provided as "constant". This means that the user of liblttng-ctl never
	23	* has to destroy a trace archive location. Hence, users of liblttng-ctl
	24	* have no visibility of the reference counting of archive locations.
	25	*/
434131e4	26	struct lttng_trace_archive_location {
d3740619	27	struct urcu_ref ref;
434131e4 JG	28	enum lttng_trace_archive_location_type type;
	29	union {
	30	struct {
	31	char *absolute_path;
	32	} local;
	33	struct {
	34	char *host;
	35	enum lttng_trace_archive_location_relay_protocol_type protocol;
	36	struct {
	37	uint16_t control, data;
	38	} ports;
	39	char *relative_path;
	40	} relay;
	41	} types;
	42	};
	43
1e9f1cf8 JG	44	struct lttng_trace_archive_location_comm {
	45	/* A value from enum lttng_trace_archive_location_type */
	46	int8_t type;
	47	union {
	48	struct {
	49	/* Includes the trailing \0. */
	50	uint32_t absolute_path_len;
	51	} LTTNG_PACKED local;
	52	struct {
	53	/* Includes the trailing \0. */
	54	uint32_t hostname_len;
	55	/*
	56	* A value from
	57	* enum lttng_trace_archive_location_relay_protocol_type.
	58	*/
	59	int8_t protocol;
	60	struct {
	61	uint16_t control, data;
	62	} ports;
	63	/* Includes the trailing \0. */
	64	uint32_t relative_path_len;
	65	} LTTNG_PACKED relay;
	66	} LTTNG_PACKED types;
	67	/*
	68	* Payload is composed of:
	69	* - LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
	70	* - absolute path, including \0
	71	* - LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
	72	* - hostname, including \0
	73	* - relative path, including \0
	74	*/
	75	char payload[];
	76	} LTTNG_PACKED;
	77
28f23191	78	struct lttng_trace_archive_location lttng_trace_archive_location_local_create(const char path);
434131e4	79
434131e4	80	struct lttng_trace_archive_location *lttng_trace_archive_location_relay_create(
28f23191 JG	81	const char *host,
	82	enum lttng_trace_archive_location_relay_protocol_type protocol,
	83	uint16_t control_port,
	84	uint16_t data_port,
	85	const char *relative_path);
434131e4	86
28f23191 JG	87	ssize_t
	88	lttng_trace_archive_location_create_from_buffer(const struct lttng_buffer_view *buffer,
	89	struct lttng_trace_archive_location **location);
1e9f1cf8	90
28f23191 JG	91	ssize_t lttng_trace_archive_location_serialize(const struct lttng_trace_archive_location *location,
28f23191 JG	92	struct lttng_dynamic_buffer *buffer);
1e9f1cf8	93
28f23191	94	void lttng_trace_archive_location_get(struct lttng_trace_archive_location *location);
d3740619	95
28f23191	96	void lttng_trace_archive_location_put(struct lttng_trace_archive_location *location);
434131e4 JG	97
434131e4 JG	98	#endif /* LTTNG_LOCATION_INTERNAL_H */