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

/*
 * 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 <lttng/location.h>
#include <common/dynamic-buffer.h>
#include <common/buffer-view.h>
#include <common/macros.h>
#include <sys/types.h>
#include <urcu/ref.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * 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);

#ifdef __cplusplus
}
#endif

#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
	11	#include <lttng/location.h>
1e9f1cf8 JG	12	#include <common/dynamic-buffer.h>
1e9f1cf8 JG	13	#include <common/buffer-view.h>
434131e4	14	#include <common/macros.h>
89293443	15	#include <sys/types.h>
d3740619	16	#include <urcu/ref.h>
434131e4	17
7966af57 SM	18	#ifdef __cplusplus
	19	extern "C" {
	20	#endif
	21
d3740619 JR	22	/*
	23	* The public API assumes that trace archive locations are always
	24	* provided as "constant". This means that the user of liblttng-ctl never
	25	* has to destroy a trace archive location. Hence, users of liblttng-ctl
	26	* have no visibility of the reference counting of archive locations.
	27	*/
434131e4	28	struct lttng_trace_archive_location {
d3740619	29	struct urcu_ref ref;
434131e4 JG	30	enum lttng_trace_archive_location_type type;
	31	union {
	32	struct {
	33	char *absolute_path;
	34	} local;
	35	struct {
	36	char *host;
	37	enum lttng_trace_archive_location_relay_protocol_type protocol;
	38	struct {
	39	uint16_t control, data;
	40	} ports;
	41	char *relative_path;
	42	} relay;
	43	} types;
	44	};
	45
1e9f1cf8 JG	46	struct lttng_trace_archive_location_comm {
	47	/* A value from enum lttng_trace_archive_location_type */
	48	int8_t type;
	49	union {
	50	struct {
	51	/* Includes the trailing \0. */
	52	uint32_t absolute_path_len;
	53	} LTTNG_PACKED local;
	54	struct {
	55	/* Includes the trailing \0. */
	56	uint32_t hostname_len;
	57	/*
	58	* A value from
	59	* enum lttng_trace_archive_location_relay_protocol_type.
	60	*/
	61	int8_t protocol;
	62	struct {
	63	uint16_t control, data;
	64	} ports;
	65	/* Includes the trailing \0. */
	66	uint32_t relative_path_len;
	67	} LTTNG_PACKED relay;
	68	} LTTNG_PACKED types;
	69	/*
	70	* Payload is composed of:
	71	* - LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
	72	* - absolute path, including \0
	73	* - LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
	74	* - hostname, including \0
	75	* - relative path, including \0
	76	*/
	77	char payload[];
	78	} LTTNG_PACKED;
	79
	80
434131e4 JG	81	struct lttng_trace_archive_location *lttng_trace_archive_location_local_create(
	82	const char *path);
	83
434131e4 JG	84	struct lttng_trace_archive_location *lttng_trace_archive_location_relay_create(
	85	const char *host,
	86	enum lttng_trace_archive_location_relay_protocol_type protocol,
	87	uint16_t control_port, uint16_t data_port,
	88	const char *relative_path);
	89
1e9f1cf8 JG	90	ssize_t lttng_trace_archive_location_create_from_buffer(
	91	const struct lttng_buffer_view *buffer,
	92	struct lttng_trace_archive_location **location);
	93
1e9f1cf8 JG	94	ssize_t lttng_trace_archive_location_serialize(
	95	const struct lttng_trace_archive_location *location,
	96	struct lttng_dynamic_buffer *buffer);
	97
d3740619 JR	98	void lttng_trace_archive_location_get(
	99	struct lttng_trace_archive_location *location);
	100
d3740619	101	void lttng_trace_archive_location_put(
434131e4 JG	102	struct lttng_trace_archive_location *location);
434131e4 JG	103
7966af57 SM	104	#ifdef __cplusplus
	105	}
	106	#endif
	107
434131e4	108	#endif /* LTTNG_LOCATION_INTERNAL_H */