Propagate trace format to relayd on session creation

[deliverable/lttng-tools.git] / include / lttng / trace-format-descriptor-internal.hpp

/*
 * Copyright (C) 2022 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_TRACE_FORMAT_DESCRIPTOR_INTERNAL_HPP
#define LTTNG_TRACE_FORMAT_DESCRIPTOR_INTERNAL_HPP

#include <bits/stdint-uintn.h>
#include <common/config/session-config.hpp>
#include <common/dynamic-array.hpp>
#include <common/macros.hpp>
#include <common/optional.hpp>
#include <common/sessiond-comm/relayd.hpp>
#include <cstdint>
#include <functional>
#include <lttng/lttng.h>
#include <lttng/trace-format-descriptor.h>
#include <memory>
#include <pthread.h>
#include <sys/types.h>
#include <unordered_map>
#include <urcu/ref.h>

struct lttng_payload;
struct lttng_payload_view;
struct mi_writer;

struct lttng_trace_format_descriptor_comm {
	uint8_t type;
};

namespace lttng {
class trace_format_descriptor {
public:
	using uptr = std::unique_ptr<trace_format_descriptor>;
	using sptr = std::shared_ptr<trace_format_descriptor>;
	using csptr = std::shared_ptr<const trace_format_descriptor>;
	explicit trace_format_descriptor(enum lttng_trace_format_descriptor_type type) : _type(type)
	{
	}

	virtual ~trace_format_descriptor();
	virtual uptr clone() const = 0; // Virtual constructor (copying)

	enum lttng_trace_format_descriptor_type type() const
	{
		return _type;
	}

	enum relayd_trace_format relayd_type() const
	{
		switch (_type) {
		case LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_1:
			return RELAYD_TRACE_FORMAT_CTF_1;
		case LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_2:
			return RELAYD_TRACE_FORMAT_CTF_2;
		default:
			/* TODO/FIXME: throw??? */
			abort();
		}
	}
	virtual lttng_error_code mi_serialize(mi_writer *writer) const final;
	virtual lttng_error_code config_serialize(config_writer *writer) const final;
	virtual int serialize(lttng_payload *payload) const;
	static ssize_t create_from_payload(lttng_payload_view *view, uptr& descriptor);

	friend bool operator==(
			trace_format_descriptor const& lhs, trace_format_descriptor const& rhs)
	{
		if (lhs.type() != rhs.type()) {
			return false;
		}
		return lhs.equal_to(rhs);
	}

	friend bool operator!=(
			trace_format_descriptor const& lhs, trace_format_descriptor const& rhs)
	{
		return !(lhs == rhs);
	}

protected:
	using DeserializerFunction =
			std::function<ssize_t(lttng_payload_view *view, uptr& descriptor)>;
	using deserializer_map =
			std::unordered_map<lttng_trace_format_descriptor_type, DeserializerFunction>;

	static deserializer_map _deserializer_map;
	virtual bool equal_to(trace_format_descriptor const& rhs) const = 0;

private:
	enum lttng_trace_format_descriptor_type _type = LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_UNKNOWN;

	virtual lttng_error_code subtype_mi_serialize(mi_writer *writer) const = 0;
	virtual lttng_error_code subtype_config_serialize(config_writer *writer) const = 0;
};

class trace_format_descriptor_ctf1 : public trace_format_descriptor {
public:
	trace_format_descriptor_ctf1() :
		trace_format_descriptor(LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_1)
	{
	} // Default constructor.

	trace_format_descriptor_ctf1(trace_format_descriptor_ctf1 const&) :
		trace_format_descriptor_ctf1()
	{
	} // Copy constructor

	uptr clone() const
	{
		return uptr(new trace_format_descriptor_ctf1(*this));
	}

	uint64_t getMajor() const
	{
		return _major;
	}
	uint64_t getMinor() const
	{
		return _minor;
	}

protected:
	static ssize_t deserialize(lttng_payload_view *view, uptr& descriptor);
	bool equal_to(trace_format_descriptor const& rhs) const override;

private:
	lttng_error_code subtype_mi_serialize(mi_writer *writer) const override;
	lttng_error_code subtype_config_serialize(config_writer *writer) const override;

	const uint64_t _major = 1;
	const uint64_t _minor = 8;
};

class trace_format_descriptor_ctf2 : public trace_format_descriptor {
public:
	trace_format_descriptor_ctf2() :
		trace_format_descriptor(LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_2)
	{
	}

	trace_format_descriptor_ctf2(trace_format_descriptor_ctf2 const&) :
		trace_format_descriptor_ctf2()
	{
	} // Copy constructor

	uptr clone() const
	{
		return uptr(new trace_format_descriptor_ctf2(*this));
	}

	uint64_t getMajor() const
	{
		return _major;
	}
	uint64_t getMinor() const
	{
		return _minor;
	}

protected:
	static ssize_t deserialize(lttng_payload_view *view, uptr& descriptor);
	bool equal_to(trace_format_descriptor const& rhs) const override;

private:
	lttng_error_code subtype_mi_serialize(mi_writer *writer) const override;
	lttng_error_code subtype_config_serialize(config_writer *writer) const override;
	const uint64_t _major = 2;
	const uint64_t _minor = 0;
};
} // namespace lttng

#endif /* LTTNG_TRACE_FORMAT_DESCRIPTOR_INTERNAL_HPP */