Provide an idiomatic c++ interface for action lists

[lttng-tools.git] / include / lttng / action / list-internal.hpp

/*
 * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_ACTION_LIST_INTERNAL_H
#define LTTNG_ACTION_LIST_INTERNAL_H

#include <common/container-wrapper.hpp>
#include <common/exception.hpp>
#include <common/format.hpp>
#include <common/macros.hpp>

#include <lttng/lttng.h>

#include <assert.h>
#include <sys/types.h>

struct lttng_action;
struct lttng_payload_view;
struct mi_writer;
struct mi_lttng_error_query_callbacks;
struct lttng_dynamic_array;
struct lttng_trigger;

/*
 * Create an action list from a payload view.
 *
 * On success, return the number of bytes consumed from `view`, and the created
 * list in `*list`. On failure, return -1.
 */
extern ssize_t lttng_action_list_create_from_payload(struct lttng_payload_view *view,
						     struct lttng_action **list);

extern struct lttng_action *
lttng_action_list_borrow_mutable_at_index(const struct lttng_action *list, unsigned int index);

enum lttng_error_code
lttng_action_list_mi_serialize(const struct lttng_trigger *trigger,
			       const struct lttng_action *action,
			       struct mi_writer *writer,
			       const struct mi_lttng_error_query_callbacks *error_query_callbacks,
			       struct lttng_dynamic_array *action_path_indexes);

namespace lttng {
namespace ctl {
namespace details {
class action_list_operations {
public:
	static lttng_action *get(const lttng_action *list, std::size_t index) noexcept
	{
		return lttng_action_list_borrow_mutable_at_index(list, index);
	}

	static std::size_t size(const lttng_action *list)
	{
		unsigned int count;
		const auto status = lttng_action_list_get_count(list, &count);

		if (status != LTTNG_ACTION_STATUS_OK) {
			LTTNG_THROW_INVALID_ARGUMENT_ERROR(
				"Failed to get action list element count");
		}

		return count;
	}
};

class const_action_list_operations {
public:
	static const lttng_action *get(const lttng_action *list, std::size_t index) noexcept
	{
		return lttng_action_list_get_at_index(list, index);
	}

	static std::size_t size(const lttng_action *list)
	{
		return action_list_operations::size(list);
	}
};
} /* namespace details */

using action_list_view = utils::random_access_container_wrapper<const lttng_action *,
								lttng_action *,
								details::action_list_operations>;

using const_action_list_view =
	utils::random_access_container_wrapper<const lttng_action *,
					       const lttng_action *,
					       details::const_action_list_operations>;

} /* namespace ctl */
} /* namespace lttng */

#endif /* LTTNG_ACTION_LIST_INTERNAL_H */