[lttng-tools.git] / src / common / actions / snapshot-session.cpp

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

#include <common/error.hpp>
#include <common/macros.hpp>
#include <common/mi-lttng.hpp>
#include <common/payload-view.hpp>
#include <common/payload.hpp>
#include <common/snapshot.hpp>

#include <lttng/action/action-internal.hpp>
#include <lttng/action/rate-policy-internal.hpp>
#include <lttng/action/rate-policy.h>
#include <lttng/action/snapshot-session-internal.hpp>
#include <lttng/action/snapshot-session.h>
#include <lttng/snapshot-internal.hpp>
#include <lttng/snapshot.h>

#include <inttypes.h>

#define IS_SNAPSHOT_SESSION_ACTION(action) \
	(lttng_action_get_type(action) == LTTNG_ACTION_TYPE_SNAPSHOT_SESSION)

namespace {
struct lttng_action_snapshot_session {
	struct lttng_action parent;

	/* Owned by this. */
	char *session_name;

	/*
	 * When non-NULL, use this custom output when taking the snapshot,
	 * rather than the session's registered snapshot output.
	 *
	 * Owned by this.
	 */
	struct lttng_snapshot_output *output;
	struct lttng_rate_policy *policy;
};

struct lttng_action_snapshot_session_comm {
	/* All string lengths include the trailing \0. */
	uint32_t session_name_len;
	uint32_t snapshot_output_len;
	uint32_t rate_policy_len;

	/*
	 * Variable data (all strings are null-terminated):
	 *
	 *  - session name string
	 *  - snapshot output object
	 *  - policy object
	 */
	char data[];
} LTTNG_PACKED;
} /* namespace */

static const struct lttng_rate_policy *
lttng_action_snapshot_session_internal_get_rate_policy(const struct lttng_action *action);

static struct lttng_action_snapshot_session *
action_snapshot_session_from_action(struct lttng_action *action)
{
	LTTNG_ASSERT(action);

	return lttng::utils::container_of(action, &lttng_action_snapshot_session::parent);
}

static const struct lttng_action_snapshot_session *
action_snapshot_session_from_action_const(const struct lttng_action *action)
{
	LTTNG_ASSERT(action);

	return lttng::utils::container_of(action, &lttng_action_snapshot_session::parent);
}

static bool lttng_action_snapshot_session_validate(struct lttng_action *action)
{
	bool valid = false;
	struct lttng_action_snapshot_session *action_snapshot_session;

	if (!action) {
		goto end;
	}

	action_snapshot_session = action_snapshot_session_from_action(action);

	/* A non-empty session name is mandatory. */
	if (!action_snapshot_session->session_name ||
	    strlen(action_snapshot_session->session_name) == 0) {
		goto end;
	}

	if (action_snapshot_session->output &&
	    !lttng_snapshot_output_validate(action_snapshot_session->output)) {
		goto end;
	}

	valid = true;
end:
	return valid;
}

static bool lttng_action_snapshot_session_is_equal(const struct lttng_action *_a,
						   const struct lttng_action *_b)
{
	bool is_equal = false;
	const struct lttng_action_snapshot_session *a, *b;

	a = action_snapshot_session_from_action_const(_a);
	b = action_snapshot_session_from_action_const(_b);

	/* Action is not valid if this is not true. */
	LTTNG_ASSERT(a->session_name);
	LTTNG_ASSERT(b->session_name);
	if (strcmp(a->session_name, b->session_name) != 0) {
		goto end;
	}

	if (a->output && b->output && !lttng_snapshot_output_is_equal(a->output, b->output)) {
		goto end;
	} else if (!!a->output != !!b->output) {
		goto end;
	}

	is_equal = lttng_rate_policy_is_equal(a->policy, b->policy);
end:
	return is_equal;
}

static size_t serialize_strlen(const char *str)
{
	return str ? strlen(str) + 1 : 0;
}

static int lttng_action_snapshot_session_serialize(struct lttng_action *action,
						   struct lttng_payload *payload)
{
	struct lttng_action_snapshot_session *action_snapshot_session;
	struct lttng_action_snapshot_session_comm comm = {};
	int ret;
	size_t size_before_comm;

	LTTNG_ASSERT(action);
	LTTNG_ASSERT(payload);

	size_before_comm = payload->buffer.size;

	action_snapshot_session = action_snapshot_session_from_action(action);
	comm.session_name_len = serialize_strlen(action_snapshot_session->session_name);

	/* Add header. */
	ret = lttng_dynamic_buffer_append(&payload->buffer, &comm, sizeof(comm));
	if (ret) {
		goto end;
	}

	LTTNG_ASSERT(action_snapshot_session->session_name);
	DBG("Serializing snapshot session action: session-name: %s",
	    action_snapshot_session->session_name);

	/* Add session name. */
	ret = lttng_dynamic_buffer_append(
		&payload->buffer, action_snapshot_session->session_name, comm.session_name_len);
	if (ret) {
		goto end;
	}

	/* Serialize the snapshot output object, if any. */
	if (action_snapshot_session->output) {
		const size_t size_before_output = payload->buffer.size;
		struct lttng_action_snapshot_session_comm *comm_in_payload;

		ret = lttng_snapshot_output_serialize(action_snapshot_session->output, payload);
		if (ret) {
			goto end;
		}

		comm_in_payload =
			(typeof(comm_in_payload)) (payload->buffer.data + size_before_comm);
		/* Adjust action length in header. */
		comm_in_payload->snapshot_output_len = payload->buffer.size - size_before_output;
	}

	/* Serialize the rate policy. */
	{
		const size_t size_before_output = payload->buffer.size;
		struct lttng_action_snapshot_session_comm *comm_in_payload;

		ret = lttng_rate_policy_serialize(action_snapshot_session->policy, payload);
		if (ret) {
			ret = -1;
			goto end;
		}

		comm_in_payload =
			(typeof(comm_in_payload)) (payload->buffer.data + size_before_comm);
		/* Adjust rate policy length in header. */
		comm_in_payload->rate_policy_len = payload->buffer.size - size_before_output;
	}

end:
	return ret;
}

static void lttng_action_snapshot_session_destroy(struct lttng_action *action)
{
	struct lttng_action_snapshot_session *action_snapshot_session;

	if (!action) {
		goto end;
	}

	action_snapshot_session = action_snapshot_session_from_action(action);

	free(action_snapshot_session->session_name);
	lttng_snapshot_output_destroy(action_snapshot_session->output);
	lttng_rate_policy_destroy(action_snapshot_session->policy);
	free(action_snapshot_session);

end:
	return;
}

ssize_t lttng_action_snapshot_session_create_from_payload(struct lttng_payload_view *view,
							  struct lttng_action **p_action)
{
	ssize_t consumed_len;
	const char *variable_data;
	struct lttng_action *action;
	enum lttng_action_status status;
	struct lttng_snapshot_output *snapshot_output = nullptr;
	struct lttng_rate_policy *policy = nullptr;
	const struct lttng_action_snapshot_session_comm *comm;
	const struct lttng_payload_view snapshot_session_comm_view =
		lttng_payload_view_from_view(view, 0, sizeof(*comm));

	action = lttng_action_snapshot_session_create();
	if (!action) {
		goto error;
	}

	if (!lttng_payload_view_is_valid(&snapshot_session_comm_view)) {
		/* Payload not large enough to contain the header. */
		goto error;
	}

	comm = (typeof(comm)) snapshot_session_comm_view.buffer.data;
	variable_data = (const char *) &comm->data;

	consumed_len = sizeof(struct lttng_action_snapshot_session_comm);

	if (!lttng_buffer_view_contains_string(
		    &view->buffer, variable_data, comm->session_name_len)) {
		goto error;
	}

	status = lttng_action_snapshot_session_set_session_name(action, variable_data);
	if (status != LTTNG_ACTION_STATUS_OK) {
		goto error;
	}

	variable_data += comm->session_name_len;
	consumed_len += comm->session_name_len;

	/* If there is a snapshot output object, deserialize it. */
	if (comm->snapshot_output_len > 0) {
		ssize_t snapshot_output_consumed_len;
		enum lttng_action_status action_status;
		struct lttng_payload_view snapshot_output_buffer_view =
			lttng_payload_view_from_view(view, consumed_len, comm->snapshot_output_len);

		if (!lttng_payload_view_is_valid(&snapshot_output_buffer_view)) {
			ERR("Failed to create buffer view for snapshot output.");
			goto error;
		}

		snapshot_output_consumed_len = lttng_snapshot_output_create_from_payload(
			&snapshot_output_buffer_view, &snapshot_output);
		if (snapshot_output_consumed_len != comm->snapshot_output_len) {
			ERR("Failed to deserialize snapshot output object: "
			    "consumed-len: %zd, expected-len: %" PRIu32,
			    snapshot_output_consumed_len,
			    comm->snapshot_output_len);
			goto error;
		}

		action_status = lttng_action_snapshot_session_set_output(action, snapshot_output);
		if (action_status != LTTNG_ACTION_STATUS_OK) {
			goto error;
		}

		/* Ownership has been transferred to the action. */
		snapshot_output = nullptr;
	}

	variable_data += comm->snapshot_output_len;
	consumed_len += comm->snapshot_output_len;

	/* Rate policy. */
	if (comm->rate_policy_len <= 0) {
		ERR("Rate policy should be present.");
		goto error;
	}
	{
		ssize_t rate_policy_consumed_len;
		struct lttng_payload_view policy_view =
			lttng_payload_view_from_view(view, consumed_len, comm->rate_policy_len);

		if (!lttng_payload_view_is_valid(&policy_view)) {
			ERR("Failed to create buffer view for rate policy.");
			goto error;
		}

		rate_policy_consumed_len =
			lttng_rate_policy_create_from_payload(&policy_view, &policy);
		if (rate_policy_consumed_len < 0) {
			goto error;
		}

		if (rate_policy_consumed_len != comm->rate_policy_len) {
			ERR("Failed to deserialize rate policy object: "
			    "consumed-len: %zd, expected-len: %" PRIu32,
			    rate_policy_consumed_len,
			    comm->rate_policy_len);
			goto error;
		}

		status = lttng_action_snapshot_session_set_rate_policy(action, policy);
		if (status != LTTNG_ACTION_STATUS_OK) {
			goto error;
		}
	}

	variable_data += comm->rate_policy_len;
	consumed_len += comm->rate_policy_len;

	*p_action = action;
	action = nullptr;

	goto end;

error:
	consumed_len = -1;

end:
	lttng_rate_policy_destroy(policy);
	lttng_action_snapshot_session_destroy(action);
	lttng_snapshot_output_destroy(snapshot_output);

	return consumed_len;
}

static enum lttng_error_code
lttng_action_snapshot_session_mi_serialize(const struct lttng_action *action,
					   struct mi_writer *writer)
{
	int ret;
	enum lttng_error_code ret_code;
	enum lttng_action_status status;
	const char *session_name = nullptr;
	const struct lttng_snapshot_output *output = nullptr;
	const struct lttng_rate_policy *policy = nullptr;

	LTTNG_ASSERT(action);
	LTTNG_ASSERT(IS_SNAPSHOT_SESSION_ACTION(action));

	status = lttng_action_snapshot_session_get_session_name(action, &session_name);
	LTTNG_ASSERT(status == LTTNG_ACTION_STATUS_OK);
	LTTNG_ASSERT(session_name != nullptr);

	status = lttng_action_snapshot_session_get_rate_policy(action, &policy);
	LTTNG_ASSERT(status == LTTNG_ACTION_STATUS_OK);
	LTTNG_ASSERT(policy != nullptr);

	/* Open action snapshot session element. */
	ret = mi_lttng_writer_open_element(writer, mi_lttng_element_action_snapshot_session);
	if (ret) {
		goto mi_error;
	}

	/* Session name. */
	ret = mi_lttng_writer_write_element_string(
		writer, mi_lttng_element_session_name, session_name);
	if (ret) {
		goto mi_error;
	}

	/* Output if any. */
	status = lttng_action_snapshot_session_get_output(action, &output);
	if (status == LTTNG_ACTION_STATUS_OK) {
		LTTNG_ASSERT(output != nullptr);
		ret_code = lttng_snapshot_output_mi_serialize(output, writer);
		if (ret_code != LTTNG_OK) {
			goto end;
		}
	} else if (status != LTTNG_ACTION_STATUS_UNSET) {
		/* This should not happen at this point. */
		abort();
	}

	/* Rate policy. */
	ret_code = lttng_rate_policy_mi_serialize(policy, writer);
	if (ret_code != LTTNG_OK) {
		goto end;
	}

	/* Close action_snapshot_session element. */
	ret = mi_lttng_writer_close_element(writer);
	if (ret) {
		goto mi_error;
	}

	ret_code = LTTNG_OK;
	goto end;

mi_error:
	ret_code = LTTNG_ERR_MI_IO_FAIL;
end:
	return ret_code;
}

struct lttng_action *lttng_action_snapshot_session_create(void)
{
	struct lttng_action_snapshot_session *action_snapshot = nullptr;
	struct lttng_rate_policy *policy = nullptr;
	enum lttng_action_status status;

	/* Create a every N = 1 rate policy. */
	policy = lttng_rate_policy_every_n_create(1);
	if (!policy) {
		goto end;
	}

	action_snapshot = zmalloc<lttng_action_snapshot_session>();
	if (!action_snapshot) {
		goto end;
	}

	lttng_action_init(&action_snapshot->parent,
			  LTTNG_ACTION_TYPE_SNAPSHOT_SESSION,
			  lttng_action_snapshot_session_validate,
			  lttng_action_snapshot_session_serialize,
			  lttng_action_snapshot_session_is_equal,
			  lttng_action_snapshot_session_destroy,
			  lttng_action_snapshot_session_internal_get_rate_policy,
			  lttng_action_generic_add_error_query_results,
			  lttng_action_snapshot_session_mi_serialize);

	status = lttng_action_snapshot_session_set_rate_policy(&action_snapshot->parent, policy);
	if (status != LTTNG_ACTION_STATUS_OK) {
		lttng_action_destroy(&action_snapshot->parent);
		action_snapshot = nullptr;
		goto end;
	}

end:
	lttng_rate_policy_destroy(policy);
	return action_snapshot ? &action_snapshot->parent : nullptr;
}

enum lttng_action_status lttng_action_snapshot_session_set_session_name(struct lttng_action *action,
									const char *session_name)
{
	struct lttng_action_snapshot_session *action_snapshot_session;
	enum lttng_action_status status;

	if (!action || !IS_SNAPSHOT_SESSION_ACTION(action) || !session_name ||
	    strlen(session_name) == 0) {
		status = LTTNG_ACTION_STATUS_INVALID;
		goto end;
	}

	action_snapshot_session = action_snapshot_session_from_action(action);

	free(action_snapshot_session->session_name);

	action_snapshot_session->session_name = strdup(session_name);
	if (!action_snapshot_session->session_name) {
		status = LTTNG_ACTION_STATUS_ERROR;
		goto end;
	}

	status = LTTNG_ACTION_STATUS_OK;
end:
	return status;
}

enum lttng_action_status
lttng_action_snapshot_session_get_session_name(const struct lttng_action *action,
					       const char **session_name)
{
	const struct lttng_action_snapshot_session *action_snapshot_session;
	enum lttng_action_status status;

	if (!action || !IS_SNAPSHOT_SESSION_ACTION(action) || !session_name) {
		status = LTTNG_ACTION_STATUS_INVALID;
		goto end;
	}

	action_snapshot_session = action_snapshot_session_from_action_const(action);

	if (action_snapshot_session->session_name) {
		*session_name = action_snapshot_session->session_name;
		status = LTTNG_ACTION_STATUS_OK;
	} else {
		status = LTTNG_ACTION_STATUS_UNSET;
	}

end:

	return status;
}

enum lttng_action_status
lttng_action_snapshot_session_set_output(struct lttng_action *action,
					 struct lttng_snapshot_output *output)
{
	struct lttng_action_snapshot_session *action_snapshot_session;
	enum lttng_action_status status;

	if (!action || !IS_SNAPSHOT_SESSION_ACTION(action) || !output) {
		status = LTTNG_ACTION_STATUS_INVALID;
		goto end;
	}

	action_snapshot_session = action_snapshot_session_from_action(action);

	lttng_snapshot_output_destroy(action_snapshot_session->output);
	action_snapshot_session->output = output;

	status = LTTNG_ACTION_STATUS_OK;

end:
	return status;
}

enum lttng_action_status
lttng_action_snapshot_session_get_output(const struct lttng_action *action,
					 const struct lttng_snapshot_output **output)
{
	const struct lttng_action_snapshot_session *action_snapshot_session;
	enum lttng_action_status status;

	if (!action || !IS_SNAPSHOT_SESSION_ACTION(action) || !output) {
		status = LTTNG_ACTION_STATUS_INVALID;
		goto end;
	}

	action_snapshot_session = action_snapshot_session_from_action_const(action);

	if (action_snapshot_session->output) {
		*output = action_snapshot_session->output;
		status = LTTNG_ACTION_STATUS_OK;
	} else {
		status = LTTNG_ACTION_STATUS_UNSET;
	}

end:
	return status;
}

enum lttng_action_status
lttng_action_snapshot_session_set_rate_policy(struct lttng_action *action,
					      const struct lttng_rate_policy *policy)
{
	enum lttng_action_status status;
	struct lttng_action_snapshot_session *snapshot_session_action;
	struct lttng_rate_policy *copy = nullptr;

	if (!action || !policy || !IS_SNAPSHOT_SESSION_ACTION(action)) {
		status = LTTNG_ACTION_STATUS_INVALID;
		goto end;
	}

	copy = lttng_rate_policy_copy(policy);
	if (!copy) {
		status = LTTNG_ACTION_STATUS_ERROR;
		goto end;
	}

	snapshot_session_action = action_snapshot_session_from_action(action);

	/* Free the previous rate policy .*/
	lttng_rate_policy_destroy(snapshot_session_action->policy);

	/* Assign the policy. */
	snapshot_session_action->policy = copy;
	status = LTTNG_ACTION_STATUS_OK;
	copy = nullptr;

end:
	lttng_rate_policy_destroy(copy);
	return status;
}

enum lttng_action_status
lttng_action_snapshot_session_get_rate_policy(const struct lttng_action *action,
					      const struct lttng_rate_policy **policy)
{
	enum lttng_action_status status;
	const struct lttng_action_snapshot_session *snapshot_session_action;

	if (!action || !policy || !IS_SNAPSHOT_SESSION_ACTION(action)) {
		status = LTTNG_ACTION_STATUS_INVALID;
		goto end;
	}

	snapshot_session_action = action_snapshot_session_from_action_const(action);

	*policy = snapshot_session_action->policy;
	status = LTTNG_ACTION_STATUS_OK;
end:
	return status;
}

static const struct lttng_rate_policy *
lttng_action_snapshot_session_internal_get_rate_policy(const struct lttng_action *action)
{
	const struct lttng_action_snapshot_session *_action;
	_action = action_snapshot_session_from_action_const(action);

	return _action->policy;
}
Commit	Line	Data
757c48a2 SM	1	/*
	2	* Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
c9e313bc SM	8	#include <common/error.hpp>
	9	#include <common/macros.hpp>
	10	#include <common/mi-lttng.hpp>
	11	#include <common/payload-view.hpp>
	12	#include <common/payload.hpp>
	13	#include <common/snapshot.hpp>
28ab034a	14
c9e313bc SM	15	#include <lttng/action/action-internal.hpp>
c9e313bc SM	16	#include <lttng/action/rate-policy-internal.hpp>
7f4d5b07	17	#include <lttng/action/rate-policy.h>
c9e313bc	18	#include <lttng/action/snapshot-session-internal.hpp>
757c48a2	19	#include <lttng/action/snapshot-session.h>
c9e313bc	20	#include <lttng/snapshot-internal.hpp>
d35c7a38	21	#include <lttng/snapshot.h>
757c48a2	22
28ab034a JG	23	#include <inttypes.h>
28ab034a JG	24
757c48a2	25	#define IS_SNAPSHOT_SESSION_ACTION(action) \
17182cfd	26	(lttng_action_get_type(action) == LTTNG_ACTION_TYPE_SNAPSHOT_SESSION)
757c48a2	27
f1494934	28	namespace {
757c48a2 SM	29	struct lttng_action_snapshot_session {
	30	struct lttng_action parent;
	31
	32	/* Owned by this. */
	33	char *session_name;
	34
	35	/*
	36	* When non-NULL, use this custom output when taking the snapshot,
	37	* rather than the session's registered snapshot output.
	38	*
	39	* Owned by this.
	40	*/
	41	struct lttng_snapshot_output *output;
7f4d5b07	42	struct lttng_rate_policy *policy;
757c48a2 SM	43	};
	44
	45	struct lttng_action_snapshot_session_comm {
	46	/* All string lengths include the trailing \0. */
	47	uint32_t session_name_len;
	48	uint32_t snapshot_output_len;
7f4d5b07	49	uint32_t rate_policy_len;
757c48a2 SM	50
	51	/*
	52	* Variable data (all strings are null-terminated):
	53	*
	54	* - session name string
	55	* - snapshot output object
d35c7a38	56	* - policy object
757c48a2 SM	57	*/
	58	char data[];
	59	} LTTNG_PACKED;
f1494934	60	} /* namespace */
757c48a2	61
7f4d5b07	62	static const struct lttng_rate_policy *
28ab034a	63	lttng_action_snapshot_session_internal_get_rate_policy(const struct lttng_action *action);
2d57482c	64
757c48a2 SM	65	static struct lttng_action_snapshot_session *
	66	action_snapshot_session_from_action(struct lttng_action *action)
	67	{
a0377dfe	68	LTTNG_ASSERT(action);
757c48a2	69
28ab034a	70	return lttng::utils::container_of(action, &lttng_action_snapshot_session::parent);
757c48a2 SM	71	}
	72
	73	static const struct lttng_action_snapshot_session *
	74	action_snapshot_session_from_action_const(const struct lttng_action *action)
	75	{
a0377dfe	76	LTTNG_ASSERT(action);
757c48a2	77
28ab034a	78	return lttng::utils::container_of(action, &lttng_action_snapshot_session::parent);
757c48a2 SM	79	}
	80
	81	static bool lttng_action_snapshot_session_validate(struct lttng_action *action)
	82	{
	83	bool valid = false;
	84	struct lttng_action_snapshot_session *action_snapshot_session;
	85
	86	if (!action) {
	87	goto end;
	88	}
	89
	90	action_snapshot_session = action_snapshot_session_from_action(action);
	91
	92	/* A non-empty session name is mandatory. */
	93	if (!action_snapshot_session->session_name \|\|
28ab034a	94	strlen(action_snapshot_session->session_name) == 0) {
757c48a2 SM	95	goto end;
	96	}
	97
	98	if (action_snapshot_session->output &&
28ab034a	99	!lttng_snapshot_output_validate(action_snapshot_session->output)) {
757c48a2 SM	100	goto end;
	101	}
	102
	103	valid = true;
	104	end:
	105	return valid;
	106	}
	107
28ab034a JG	108	static bool lttng_action_snapshot_session_is_equal(const struct lttng_action *_a,
28ab034a JG	109	const struct lttng_action *_b)
757c48a2 SM	110	{
	111	bool is_equal = false;
	112	const struct lttng_action_snapshot_session a, b;
	113
	114	a = action_snapshot_session_from_action_const(_a);
	115	b = action_snapshot_session_from_action_const(_b);
	116
	117	/* Action is not valid if this is not true. */
a0377dfe FD	118	LTTNG_ASSERT(a->session_name);
a0377dfe FD	119	LTTNG_ASSERT(b->session_name);
5c7248cd	120	if (strcmp(a->session_name, b->session_name) != 0) {
757c48a2 SM	121	goto end;
	122	}
	123
28ab034a	124	if (a->output && b->output && !lttng_snapshot_output_is_equal(a->output, b->output)) {
757c48a2 SM	125	goto end;
	126	} else if (!!a->output != !!b->output) {
	127	goto end;
	128	}
	129
7f4d5b07	130	is_equal = lttng_rate_policy_is_equal(a->policy, b->policy);
757c48a2 SM	131	end:
	132	return is_equal;
	133	}
	134
0c51e8f3	135	static size_t serialize_strlen(const char *str)
757c48a2	136	{
0c51e8f3	137	return str ? strlen(str) + 1 : 0;
757c48a2 SM	138	}
757c48a2 SM	139
28ab034a JG	140	static int lttng_action_snapshot_session_serialize(struct lttng_action *action,
28ab034a JG	141	struct lttng_payload *payload)
757c48a2 SM	142	{
	143	struct lttng_action_snapshot_session *action_snapshot_session;
	144	struct lttng_action_snapshot_session_comm comm = {};
	145	int ret;
	146	size_t size_before_comm;
	147
a0377dfe FD	148	LTTNG_ASSERT(action);
a0377dfe FD	149	LTTNG_ASSERT(payload);
757c48a2 SM	150
757c48a2 SM	151	size_before_comm = payload->buffer.size;
757c48a2 SM	152
757c48a2 SM	153	action_snapshot_session = action_snapshot_session_from_action(action);
28ab034a	154	comm.session_name_len = serialize_strlen(action_snapshot_session->session_name);
757c48a2 SM	155
757c48a2 SM	156	/* Add header. */
28ab034a	157	ret = lttng_dynamic_buffer_append(&payload->buffer, &comm, sizeof(comm));
757c48a2 SM	158	if (ret) {
	159	goto end;
	160	}
	161
a0377dfe	162	LTTNG_ASSERT(action_snapshot_session->session_name);
757c48a2	163	DBG("Serializing snapshot session action: session-name: %s",
28ab034a	164	action_snapshot_session->session_name);
757c48a2 SM	165
757c48a2 SM	166	/* Add session name. */
28ab034a JG	167	ret = lttng_dynamic_buffer_append(
28ab034a JG	168	&payload->buffer, action_snapshot_session->session_name, comm.session_name_len);
757c48a2 SM	169	if (ret) {
	170	goto end;
	171	}
	172
	173	/* Serialize the snapshot output object, if any. */
	174	if (action_snapshot_session->output) {
	175	const size_t size_before_output = payload->buffer.size;
	176	struct lttng_action_snapshot_session_comm *comm_in_payload;
	177
28ab034a	178	ret = lttng_snapshot_output_serialize(action_snapshot_session->output, payload);
757c48a2 SM	179	if (ret) {
	180	goto end;
	181	}
	182
28ab034a JG	183	comm_in_payload =
28ab034a JG	184	(typeof(comm_in_payload)) (payload->buffer.data + size_before_comm);
d35c7a38	185	/* Adjust action length in header. */
28ab034a	186	comm_in_payload->snapshot_output_len = payload->buffer.size - size_before_output;
757c48a2 SM	187	}
757c48a2 SM	188
7f4d5b07	189	/* Serialize the rate policy. */
d35c7a38 JR	190	{
	191	const size_t size_before_output = payload->buffer.size;
	192	struct lttng_action_snapshot_session_comm *comm_in_payload;
	193
28ab034a	194	ret = lttng_rate_policy_serialize(action_snapshot_session->policy, payload);
d35c7a38 JR	195	if (ret) {
	196	ret = -1;
	197	goto end;
	198	}
	199
28ab034a JG	200	comm_in_payload =
28ab034a JG	201	(typeof(comm_in_payload)) (payload->buffer.data + size_before_comm);
7f4d5b07	202	/* Adjust rate policy length in header. */
28ab034a	203	comm_in_payload->rate_policy_len = payload->buffer.size - size_before_output;
d35c7a38 JR	204	}
d35c7a38 JR	205
757c48a2 SM	206	end:
	207	return ret;
	208	}
	209
	210	static void lttng_action_snapshot_session_destroy(struct lttng_action *action)
	211	{
	212	struct lttng_action_snapshot_session *action_snapshot_session;
	213
	214	if (!action) {
	215	goto end;
	216	}
	217
	218	action_snapshot_session = action_snapshot_session_from_action(action);
	219
	220	free(action_snapshot_session->session_name);
	221	lttng_snapshot_output_destroy(action_snapshot_session->output);
7f4d5b07	222	lttng_rate_policy_destroy(action_snapshot_session->policy);
757c48a2 SM	223	free(action_snapshot_session);
	224
	225	end:
	226	return;
	227	}
	228
28ab034a JG	229	ssize_t lttng_action_snapshot_session_create_from_payload(struct lttng_payload_view *view,
28ab034a JG	230	struct lttng_action **p_action)
757c48a2 SM	231	{
757c48a2 SM	232	ssize_t consumed_len;
757c48a2 SM	233	const char *variable_data;
	234	struct lttng_action *action;
	235	enum lttng_action_status status;
cd9adb8b JG	236	struct lttng_snapshot_output *snapshot_output = nullptr;
cd9adb8b JG	237	struct lttng_rate_policy *policy = nullptr;
3e6e0df2 JG	238	const struct lttng_action_snapshot_session_comm *comm;
3e6e0df2 JG	239	const struct lttng_payload_view snapshot_session_comm_view =
28ab034a	240	lttng_payload_view_from_view(view, 0, sizeof(*comm));
757c48a2 SM	241
	242	action = lttng_action_snapshot_session_create();
	243	if (!action) {
	244	goto error;
	245	}
	246
3e6e0df2 JG	247	if (!lttng_payload_view_is_valid(&snapshot_session_comm_view)) {
	248	/* Payload not large enough to contain the header. */
	249	goto error;
	250	}
	251
	252	comm = (typeof(comm)) snapshot_session_comm_view.buffer.data;
757c48a2 SM	253	variable_data = (const char *) &comm->data;
	254
	255	consumed_len = sizeof(struct lttng_action_snapshot_session_comm);
	256
	257	if (!lttng_buffer_view_contains_string(
28ab034a	258	&view->buffer, variable_data, comm->session_name_len)) {
757c48a2 SM	259	goto error;
	260	}
	261
28ab034a	262	status = lttng_action_snapshot_session_set_session_name(action, variable_data);
757c48a2 SM	263	if (status != LTTNG_ACTION_STATUS_OK) {
	264	goto error;
	265	}
	266
	267	variable_data += comm->session_name_len;
	268	consumed_len += comm->session_name_len;
	269
	270	/* If there is a snapshot output object, deserialize it. */
	271	if (comm->snapshot_output_len > 0) {
	272	ssize_t snapshot_output_consumed_len;
	273	enum lttng_action_status action_status;
	274	struct lttng_payload_view snapshot_output_buffer_view =
28ab034a	275	lttng_payload_view_from_view(view, consumed_len, comm->snapshot_output_len);
757c48a2	276
3e6e0df2	277	if (!lttng_payload_view_is_valid(&snapshot_output_buffer_view)) {
0c51e8f3	278	ERR("Failed to create buffer view for snapshot output.");
757c48a2 SM	279	goto error;
	280	}
	281
28ab034a JG	282	snapshot_output_consumed_len = lttng_snapshot_output_create_from_payload(
28ab034a JG	283	&snapshot_output_buffer_view, &snapshot_output);
757c48a2	284	if (snapshot_output_consumed_len != comm->snapshot_output_len) {
0c51e8f3	285	ERR("Failed to deserialize snapshot output object: "
28ab034a JG	286	"consumed-len: %zd, expected-len: %" PRIu32,
	287	snapshot_output_consumed_len,
	288	comm->snapshot_output_len);
757c48a2 SM	289	goto error;
	290	}
	291
28ab034a	292	action_status = lttng_action_snapshot_session_set_output(action, snapshot_output);
757c48a2 SM	293	if (action_status != LTTNG_ACTION_STATUS_OK) {
	294	goto error;
	295	}
	296
	297	/* Ownership has been transferred to the action. */
cd9adb8b	298	snapshot_output = nullptr;
757c48a2 SM	299	}
	300
	301	variable_data += comm->snapshot_output_len;
	302	consumed_len += comm->snapshot_output_len;
d35c7a38	303
7f4d5b07 JR	304	/* Rate policy. */
	305	if (comm->rate_policy_len <= 0) {
	306	ERR("Rate policy should be present.");
d35c7a38 JR	307	goto error;
	308	}
	309	{
7f4d5b07	310	ssize_t rate_policy_consumed_len;
d35c7a38	311	struct lttng_payload_view policy_view =
28ab034a	312	lttng_payload_view_from_view(view, consumed_len, comm->rate_policy_len);
d35c7a38 JR	313
d35c7a38 JR	314	if (!lttng_payload_view_is_valid(&policy_view)) {
7f4d5b07	315	ERR("Failed to create buffer view for rate policy.");
d35c7a38 JR	316	goto error;
	317	}
	318
7f4d5b07	319	rate_policy_consumed_len =
28ab034a	320	lttng_rate_policy_create_from_payload(&policy_view, &policy);
7f4d5b07	321	if (rate_policy_consumed_len < 0) {
d35c7a38 JR	322	goto error;
	323	}
	324
7f4d5b07 JR	325	if (rate_policy_consumed_len != comm->rate_policy_len) {
7f4d5b07 JR	326	ERR("Failed to deserialize rate policy object: "
d35c7a38	327	"consumed-len: %zd, expected-len: %" PRIu32,
28ab034a JG	328	rate_policy_consumed_len,
28ab034a JG	329	comm->rate_policy_len);
d35c7a38 JR	330	goto error;
	331	}
	332
28ab034a	333	status = lttng_action_snapshot_session_set_rate_policy(action, policy);
d35c7a38 JR	334	if (status != LTTNG_ACTION_STATUS_OK) {
	335	goto error;
	336	}
	337	}
	338
7f4d5b07 JR	339	variable_data += comm->rate_policy_len;
7f4d5b07 JR	340	consumed_len += comm->rate_policy_len;
d35c7a38	341
757c48a2	342	*p_action = action;
cd9adb8b	343	action = nullptr;
757c48a2 SM	344
	345	goto end;
	346
	347	error:
	348	consumed_len = -1;
	349
	350	end:
7f4d5b07	351	lttng_rate_policy_destroy(policy);
757c48a2 SM	352	lttng_action_snapshot_session_destroy(action);
	353	lttng_snapshot_output_destroy(snapshot_output);
	354
	355	return consumed_len;
	356	}
	357
28ab034a JG	358	static enum lttng_error_code
	359	lttng_action_snapshot_session_mi_serialize(const struct lttng_action *action,
	360	struct mi_writer *writer)
6a751b95 JR	361	{
	362	int ret;
	363	enum lttng_error_code ret_code;
	364	enum lttng_action_status status;
cd9adb8b JG	365	const char *session_name = nullptr;
	366	const struct lttng_snapshot_output *output = nullptr;
	367	const struct lttng_rate_policy *policy = nullptr;
6a751b95	368
a0377dfe FD	369	LTTNG_ASSERT(action);
a0377dfe FD	370	LTTNG_ASSERT(IS_SNAPSHOT_SESSION_ACTION(action));
6a751b95	371
28ab034a	372	status = lttng_action_snapshot_session_get_session_name(action, &session_name);
a0377dfe	373	LTTNG_ASSERT(status == LTTNG_ACTION_STATUS_OK);
cd9adb8b	374	LTTNG_ASSERT(session_name != nullptr);
6a751b95 JR	375
6a751b95 JR	376	status = lttng_action_snapshot_session_get_rate_policy(action, &policy);
a0377dfe	377	LTTNG_ASSERT(status == LTTNG_ACTION_STATUS_OK);
cd9adb8b	378	LTTNG_ASSERT(policy != nullptr);
6a751b95 JR	379
6a751b95 JR	380	/* Open action snapshot session element. */
28ab034a	381	ret = mi_lttng_writer_open_element(writer, mi_lttng_element_action_snapshot_session);
6a751b95 JR	382	if (ret) {
	383	goto mi_error;
	384	}
	385
	386	/* Session name. */
	387	ret = mi_lttng_writer_write_element_string(
28ab034a	388	writer, mi_lttng_element_session_name, session_name);
6a751b95 JR	389	if (ret) {
	390	goto mi_error;
	391	}
	392
	393	/* Output if any. */
	394	status = lttng_action_snapshot_session_get_output(action, &output);
	395	if (status == LTTNG_ACTION_STATUS_OK) {
cd9adb8b	396	LTTNG_ASSERT(output != nullptr);
6a751b95 JR	397	ret_code = lttng_snapshot_output_mi_serialize(output, writer);
	398	if (ret_code != LTTNG_OK) {
	399	goto end;
	400	}
	401	} else if (status != LTTNG_ACTION_STATUS_UNSET) {
	402	/* This should not happen at this point. */
	403	abort();
	404	}
	405
	406	/* Rate policy. */
	407	ret_code = lttng_rate_policy_mi_serialize(policy, writer);
	408	if (ret_code != LTTNG_OK) {
	409	goto end;
	410	}
	411
	412	/* Close action_snapshot_session element. */
	413	ret = mi_lttng_writer_close_element(writer);
	414	if (ret) {
	415	goto mi_error;
	416	}
	417
	418	ret_code = LTTNG_OK;
	419	goto end;
	420
	421	mi_error:
	422	ret_code = LTTNG_ERR_MI_IO_FAIL;
	423	end:
	424	return ret_code;
	425	}
	426
757c48a2 SM	427	struct lttng_action *lttng_action_snapshot_session_create(void)
757c48a2 SM	428	{
cd9adb8b JG	429	struct lttng_action_snapshot_session *action_snapshot = nullptr;
cd9adb8b JG	430	struct lttng_rate_policy *policy = nullptr;
d35c7a38 JR	431	enum lttng_action_status status;
d35c7a38 JR	432
7f4d5b07 JR	433	/* Create a every N = 1 rate policy. */
7f4d5b07 JR	434	policy = lttng_rate_policy_every_n_create(1);
d35c7a38 JR	435	if (!policy) {
	436	goto end;
	437	}
757c48a2	438
64803277 SM	439	action_snapshot = zmalloc<lttng_action_snapshot_session>();
64803277 SM	440	if (!action_snapshot) {
757c48a2 SM	441	goto end;
	442	}
	443
64803277	444	lttng_action_init(&action_snapshot->parent,
28ab034a JG	445	LTTNG_ACTION_TYPE_SNAPSHOT_SESSION,
	446	lttng_action_snapshot_session_validate,
	447	lttng_action_snapshot_session_serialize,
	448	lttng_action_snapshot_session_is_equal,
	449	lttng_action_snapshot_session_destroy,
	450	lttng_action_snapshot_session_internal_get_rate_policy,
	451	lttng_action_generic_add_error_query_results,
	452	lttng_action_snapshot_session_mi_serialize);
	453
	454	status = lttng_action_snapshot_session_set_rate_policy(&action_snapshot->parent, policy);
d35c7a38	455	if (status != LTTNG_ACTION_STATUS_OK) {
64803277	456	lttng_action_destroy(&action_snapshot->parent);
cd9adb8b	457	action_snapshot = nullptr;
d35c7a38 JR	458	goto end;
	459	}
	460
757c48a2	461	end:
7f4d5b07	462	lttng_rate_policy_destroy(policy);
64803277	463	return action_snapshot ? &action_snapshot->parent : nullptr;
757c48a2 SM	464	}
757c48a2 SM	465
28ab034a JG	466	enum lttng_action_status lttng_action_snapshot_session_set_session_name(struct lttng_action *action,
28ab034a JG	467	const char *session_name)
757c48a2 SM	468	{
	469	struct lttng_action_snapshot_session *action_snapshot_session;
	470	enum lttng_action_status status;
	471
	472	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !session_name \|\|
28ab034a	473	strlen(session_name) == 0) {
757c48a2 SM	474	status = LTTNG_ACTION_STATUS_INVALID;
	475	goto end;
	476	}
	477
	478	action_snapshot_session = action_snapshot_session_from_action(action);
	479
	480	free(action_snapshot_session->session_name);
	481
	482	action_snapshot_session->session_name = strdup(session_name);
	483	if (!action_snapshot_session->session_name) {
	484	status = LTTNG_ACTION_STATUS_ERROR;
	485	goto end;
	486	}
	487
	488	status = LTTNG_ACTION_STATUS_OK;
	489	end:
	490	return status;
	491	}
	492
28ab034a JG	493	enum lttng_action_status
	494	lttng_action_snapshot_session_get_session_name(const struct lttng_action *action,
	495	const char **session_name)
757c48a2 SM	496	{
	497	const struct lttng_action_snapshot_session *action_snapshot_session;
	498	enum lttng_action_status status;
	499
	500	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !session_name) {
	501	status = LTTNG_ACTION_STATUS_INVALID;
	502	goto end;
	503	}
	504
	505	action_snapshot_session = action_snapshot_session_from_action_const(action);
	506
	507	if (action_snapshot_session->session_name) {
	508	*session_name = action_snapshot_session->session_name;
	509	status = LTTNG_ACTION_STATUS_OK;
	510	} else {
	511	status = LTTNG_ACTION_STATUS_UNSET;
	512	}
	513
	514	end:
	515
	516	return status;
	517	}
	518
28ab034a JG	519	enum lttng_action_status
	520	lttng_action_snapshot_session_set_output(struct lttng_action *action,
	521	struct lttng_snapshot_output *output)
757c48a2 SM	522	{
	523	struct lttng_action_snapshot_session *action_snapshot_session;
	524	enum lttng_action_status status;
	525
	526	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !output) {
	527	status = LTTNG_ACTION_STATUS_INVALID;
	528	goto end;
	529	}
	530
	531	action_snapshot_session = action_snapshot_session_from_action(action);
	532
	533	lttng_snapshot_output_destroy(action_snapshot_session->output);
	534	action_snapshot_session->output = output;
	535
	536	status = LTTNG_ACTION_STATUS_OK;
	537
	538	end:
	539	return status;
	540	}
	541
28ab034a JG	542	enum lttng_action_status
	543	lttng_action_snapshot_session_get_output(const struct lttng_action *action,
	544	const struct lttng_snapshot_output **output)
757c48a2 SM	545	{
	546	const struct lttng_action_snapshot_session *action_snapshot_session;
	547	enum lttng_action_status status;
	548
28ab034a	549	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !output) {
757c48a2 SM	550	status = LTTNG_ACTION_STATUS_INVALID;
	551	goto end;
	552	}
	553
	554	action_snapshot_session = action_snapshot_session_from_action_const(action);
	555
	556	if (action_snapshot_session->output) {
	557	*output = action_snapshot_session->output;
	558	status = LTTNG_ACTION_STATUS_OK;
	559	} else {
	560	status = LTTNG_ACTION_STATUS_UNSET;
	561	}
	562
	563	end:
	564	return status;
	565	}
d35c7a38	566
28ab034a JG	567	enum lttng_action_status
	568	lttng_action_snapshot_session_set_rate_policy(struct lttng_action *action,
	569	const struct lttng_rate_policy *policy)
d35c7a38 JR	570	{
	571	enum lttng_action_status status;
	572	struct lttng_action_snapshot_session *snapshot_session_action;
cd9adb8b	573	struct lttng_rate_policy *copy = nullptr;
d35c7a38 JR	574
	575	if (!action \|\| !policy \|\| !IS_SNAPSHOT_SESSION_ACTION(action)) {
	576	status = LTTNG_ACTION_STATUS_INVALID;
	577	goto end;
	578	}
	579
7f4d5b07	580	copy = lttng_rate_policy_copy(policy);
d35c7a38 JR	581	if (!copy) {
	582	status = LTTNG_ACTION_STATUS_ERROR;
	583	goto end;
	584	}
	585
	586	snapshot_session_action = action_snapshot_session_from_action(action);
	587
7f4d5b07 JR	588	/* Free the previous rate policy .*/
7f4d5b07 JR	589	lttng_rate_policy_destroy(snapshot_session_action->policy);
d35c7a38 JR	590
	591	/* Assign the policy. */
	592	snapshot_session_action->policy = copy;
	593	status = LTTNG_ACTION_STATUS_OK;
cd9adb8b	594	copy = nullptr;
d35c7a38 JR	595
d35c7a38 JR	596	end:
7f4d5b07	597	lttng_rate_policy_destroy(copy);
d35c7a38 JR	598	return status;
	599	}
	600
28ab034a JG	601	enum lttng_action_status
	602	lttng_action_snapshot_session_get_rate_policy(const struct lttng_action *action,
	603	const struct lttng_rate_policy **policy)
d35c7a38 JR	604	{
	605	enum lttng_action_status status;
	606	const struct lttng_action_snapshot_session *snapshot_session_action;
	607
	608	if (!action \|\| !policy \|\| !IS_SNAPSHOT_SESSION_ACTION(action)) {
	609	status = LTTNG_ACTION_STATUS_INVALID;
	610	goto end;
	611	}
	612
28ab034a	613	snapshot_session_action = action_snapshot_session_from_action_const(action);
d35c7a38 JR	614
	615	*policy = snapshot_session_action->policy;
	616	status = LTTNG_ACTION_STATUS_OK;
	617	end:
	618	return status;
	619	}
2d57482c	620
7f4d5b07	621	static const struct lttng_rate_policy *
28ab034a	622	lttng_action_snapshot_session_internal_get_rate_policy(const struct lttng_action *action)
2d57482c JR	623	{
	624	const struct lttng_action_snapshot_session *_action;
	625	_action = action_snapshot_session_from_action_const(action);
	626
	627	return _action->policy;
	628	}