CLI: Add lttng_trace_format_descriptor to lttng_session_extended

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

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

#ifndef LTTNG_SESSION_INTERNAL_H
#define LTTNG_SESSION_INTERNAL_H

#include <common/buffer-view.hpp>
#include <common/macros.hpp>
#include <common/optional.hpp>
#include <lttng/constant.h>
#include <lttng/lttng-error.h>
#include <lttng/trace-format-descriptor-internal.hpp>

struct lttng_session;
struct lttng_payload_view;

struct lttng_session_extended {
	LTTNG_OPTIONAL(uint64_t) creation_time;
	/*
	 * This is done this way to satisfy the API memory restriction for lttng_session on listing.
	 * The caller must be able to simply call free on the return object and all memory be freed.
	 */
	struct lttng_buffer_view serialized_trace_format_descriptor;
};

struct lttng_session_comm {
	uint32_t name_len;
	uint32_t path_len;
	uint8_t enabled;
	uint32_t snapshot_mode;
	uint32_t live_timer_interval;
	uint32_t trace_format_descriptor_len;
	/* lttng_session_extended data */
	LTTNG_OPTIONAL(uint64_t) LTTNG_PACKED creation_time;
	/*
	 * Dynamic payload:
	 *   - name[name_len]
	 *   - path[path_len]
	 *   - trace_format_descriptor
	 */
	char payload[];
} LTTNG_PACKED;

int lttng_session_serialize(const struct lttng_session *session, struct lttng_payload *payload);

ssize_t lttng_session_create_from_payload(
		struct lttng_payload_view *view, struct lttng_session **out_session);

enum lttng_error_code lttng_sessions_create_and_flatten_from_payload(
		struct lttng_payload_view *view,
		unsigned int count,
		struct lttng_session **sessions);

#endif /* LTTNG_SESSION_INTERNAL_H */