[lttng-tools.git] / include / lttng / session-descriptor-internal.h

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

#ifndef LTTNG_SESSION_DESCRIPTOR_INTERNAL_H
#define LTTNG_SESSION_DESCRIPTOR_INTERNAL_H

#include <lttng/session-descriptor.h>
#include <lttng/lttng-error.h>
#include <common/uri.h>
#include <common/dynamic-buffer.h>
#include <common/buffer-view.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Note that these enums are used as part of the lttnctl protocol. */
enum lttng_session_descriptor_type {
	LTTNG_SESSION_DESCRIPTOR_TYPE_UNKNOWN = -1,
	/*
	 * The output type determines whether this is a no-output, local,
	 * or networked tracing session.
	 */
	LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR = 1,
	LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT = 2,
	LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE = 3,
};

enum lttng_session_descriptor_output_type {
	LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE = 0,
	LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL = 1,
	LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK = 2,
};

ssize_t lttng_session_descriptor_create_from_buffer(
		const struct lttng_buffer_view *view,
		struct lttng_session_descriptor **descriptor);

int lttng_session_descriptor_serialize(
		const struct lttng_session_descriptor *descriptor,
		struct lttng_dynamic_buffer *buffer);

enum lttng_session_descriptor_type
lttng_session_descriptor_get_type(
		const struct lttng_session_descriptor *descriptor);

enum lttng_session_descriptor_output_type
lttng_session_descriptor_get_output_type(
		const struct lttng_session_descriptor *descriptor);

void lttng_session_descriptor_get_local_output_uri(
		const struct lttng_session_descriptor *descriptor,
		struct lttng_uri *local_uri);

void lttng_session_descriptor_get_network_output_uris(
		const struct lttng_session_descriptor *descriptor,
		struct lttng_uri *control,
		struct lttng_uri *data);

unsigned long long
lttng_session_descriptor_live_get_timer_interval(
		const struct lttng_session_descriptor *descriptor);

int lttng_session_descriptor_set_session_name(
		struct lttng_session_descriptor *descriptor,
		const char *name);

bool lttng_session_descriptor_is_output_destination_initialized(
		const struct lttng_session_descriptor *descriptor);

bool lttng_session_descriptor_has_output_directory(
		const struct lttng_session_descriptor *descriptor);

enum lttng_error_code lttng_session_descriptor_set_default_output(
		struct lttng_session_descriptor *descriptor,
		time_t *session_creation_time,
		const char *absolute_home_path);

int lttng_session_descriptor_assign(
		struct lttng_session_descriptor *dst_descriptor,
		const struct lttng_session_descriptor *src_descriptor);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_SESSION_DESCRIPTOR_INTERNAL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_SESSION_DESCRIPTOR_INTERNAL_H
	9	#define LTTNG_SESSION_DESCRIPTOR_INTERNAL_H
	10
	11	#include <lttng/session-descriptor.h>
	12	#include <lttng/lttng-error.h>
	13	#include <common/uri.h>
	14	#include <common/dynamic-buffer.h>
	15	#include <common/buffer-view.h>
	16	#include <stdbool.h>
	17
	18	#ifdef __cplusplus
	19	extern "C" {
	20	#endif
	21
	22	/* Note that these enums are used as part of the lttnctl protocol. */
	23	enum lttng_session_descriptor_type {
	24	LTTNG_SESSION_DESCRIPTOR_TYPE_UNKNOWN = -1,
	25	/*
	26	* The output type determines whether this is a no-output, local,
	27	* or networked tracing session.
	28	*/
	29	LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR = 1,
	30	LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT = 2,
	31	LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE = 3,
	32	};
	33
	34	enum lttng_session_descriptor_output_type {
	35	LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE = 0,
	36	LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL = 1,
	37	LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK = 2,
	38	};
	39
	40	ssize_t lttng_session_descriptor_create_from_buffer(
	41	const struct lttng_buffer_view *view,
	42	struct lttng_session_descriptor **descriptor);
	43
	44	int lttng_session_descriptor_serialize(
	45	const struct lttng_session_descriptor *descriptor,
	46	struct lttng_dynamic_buffer *buffer);
	47
	48	enum lttng_session_descriptor_type
	49	lttng_session_descriptor_get_type(
	50	const struct lttng_session_descriptor *descriptor);
	51
	52	enum lttng_session_descriptor_output_type
	53	lttng_session_descriptor_get_output_type(
	54	const struct lttng_session_descriptor *descriptor);
	55
	56	void lttng_session_descriptor_get_local_output_uri(
	57	const struct lttng_session_descriptor *descriptor,
	58	struct lttng_uri *local_uri);
	59
	60	void lttng_session_descriptor_get_network_output_uris(
	61	const struct lttng_session_descriptor *descriptor,
	62	struct lttng_uri *control,
	63	struct lttng_uri *data);
	64
	65	unsigned long long
	66	lttng_session_descriptor_live_get_timer_interval(
	67	const struct lttng_session_descriptor *descriptor);
	68
	69	int lttng_session_descriptor_set_session_name(
	70	struct lttng_session_descriptor *descriptor,
	71	const char *name);
	72
	73	bool lttng_session_descriptor_is_output_destination_initialized(
	74	const struct lttng_session_descriptor *descriptor);
	75
	76	bool lttng_session_descriptor_has_output_directory(
	77	const struct lttng_session_descriptor *descriptor);
	78
	79	enum lttng_error_code lttng_session_descriptor_set_default_output(
	80	struct lttng_session_descriptor *descriptor,
	81	time_t *session_creation_time,
	82	const char *absolute_home_path);
	83
	84	int lttng_session_descriptor_assign(
	85	struct lttng_session_descriptor *dst_descriptor,
	86	const struct lttng_session_descriptor *src_descriptor);
	87
	88	#ifdef __cplusplus
	89	}
	90	#endif
	91
	92	#endif /* LTTNG_SESSION_DESCRIPTOR_INTERNAL_H */