[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>

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