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

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

#include <assert.h>
#include <common/error.h>
#include <common/macros.h>
#include <common/snapshot.h>
#include <common/payload.h>
#include <common/payload-view.h>
#include <lttng/action/action-internal.h>
#include <lttng/action/snapshot-session-internal.h>
#include <lttng/action/snapshot-session.h>
#include <lttng/snapshot.h>
#include <lttng/snapshot-internal.h>
#include <inttypes.h>

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

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_action_snapshot_session_comm {
	/* All string lengths include the trailing \0. */
	uint32_t session_name_len;
	uint32_t snapshot_output_len;

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

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

	return container_of(
			action, struct lttng_action_snapshot_session, parent);
}

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

	return container_of(
			action, struct 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. */
	assert(a->session_name);
	assert(b->session_name);
	if (strcmp(a->session_name, b->session_name)) {
		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 = true;
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;

	assert(action);
	assert(payload);

	size_before_comm = payload->buffer.size;
	size_before_comm = size_before_comm + sizeof(comm);

	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;
	}

	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;
		}

		/* Adjust action length in header. */
		comm_in_payload = (typeof(comm_in_payload))(
				payload->buffer.data + size_before_comm);
		comm_in_payload->snapshot_output_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);
	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 struct lttng_action_snapshot_session_comm *comm;
	const char *variable_data;
	struct lttng_action *action;
	enum lttng_action_status status;
	struct lttng_snapshot_output *snapshot_output = NULL;

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

	comm = (typeof(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 (!snapshot_output_buffer_view.buffer.data) {
			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 = NULL;
	}

	variable_data += comm->snapshot_output_len;
	consumed_len += comm->snapshot_output_len;
	*p_action = action;
	action = NULL;

	goto end;

error:
	consumed_len = -1;

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

	return consumed_len;
}

struct lttng_action *lttng_action_snapshot_session_create(void)
{
	struct lttng_action *action;

	action = zmalloc(sizeof(struct lttng_action_snapshot_session));
	if (!action) {
		goto end;
	}

	lttng_action_init(action, 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);

end:
	return action;
}

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;
}
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
	8	#include <assert.h>
	9	#include <common/error.h>
	10	#include <common/macros.h>
	11	#include <common/snapshot.h>
9e620ea7 JG	12	#include <common/payload.h>
9e620ea7 JG	13	#include <common/payload-view.h>
757c48a2 SM	14	#include <lttng/action/action-internal.h>
	15	#include <lttng/action/snapshot-session-internal.h>
	16	#include <lttng/action/snapshot-session.h>
	17	#include <lttng/snapshot.h>
	18	#include <lttng/snapshot-internal.h>
	19	#include <inttypes.h>
	20
	21	#define IS_SNAPSHOT_SESSION_ACTION(action) \
17182cfd	22	(lttng_action_get_type(action) == LTTNG_ACTION_TYPE_SNAPSHOT_SESSION)
757c48a2 SM	23
	24	struct lttng_action_snapshot_session {
	25	struct lttng_action parent;
	26
	27	/* Owned by this. */
	28	char *session_name;
	29
	30	/*
	31	* When non-NULL, use this custom output when taking the snapshot,
	32	* rather than the session's registered snapshot output.
	33	*
	34	* Owned by this.
	35	*/
	36	struct lttng_snapshot_output *output;
	37	};
	38
	39	struct lttng_action_snapshot_session_comm {
	40	/* All string lengths include the trailing \0. */
	41	uint32_t session_name_len;
	42	uint32_t snapshot_output_len;
	43
	44	/*
	45	* Variable data (all strings are null-terminated):
	46	*
	47	* - session name string
	48	* - snapshot output object
	49	*
	50	*/
	51	char data[];
	52	} LTTNG_PACKED;
	53
	54	static struct lttng_action_snapshot_session *
	55	action_snapshot_session_from_action(struct lttng_action *action)
	56	{
	57	assert(action);
	58
	59	return container_of(
	60	action, struct lttng_action_snapshot_session, parent);
	61	}
	62
	63	static const struct lttng_action_snapshot_session *
	64	action_snapshot_session_from_action_const(const struct lttng_action *action)
	65	{
	66	assert(action);
	67
	68	return container_of(
	69	action, struct lttng_action_snapshot_session, parent);
	70	}
	71
	72	static bool lttng_action_snapshot_session_validate(struct lttng_action *action)
	73	{
	74	bool valid = false;
	75	struct lttng_action_snapshot_session *action_snapshot_session;
	76
	77	if (!action) {
	78	goto end;
	79	}
	80
	81	action_snapshot_session = action_snapshot_session_from_action(action);
	82
	83	/* A non-empty session name is mandatory. */
	84	if (!action_snapshot_session->session_name \|\|
	85	strlen(action_snapshot_session->session_name) == 0) {
	86	goto end;
87	}
88
89	if (action_snapshot_session->output &&
90	!lttng_snapshot_output_validate(action_snapshot_session->output)) {
91	goto end;
92	}
93
94	valid = true;
95	end:
96	return valid;
97	}
98
99	static bool lttng_action_snapshot_session_is_equal(
100	const struct lttng_action _a, const struct lttng_action _b)
101	{
102	bool is_equal = false;
103	const struct lttng_action_snapshot_session a, b;
104
105	a = action_snapshot_session_from_action_const(_a);
106	b = action_snapshot_session_from_action_const(_b);
107
108	/* Action is not valid if this is not true. */
109	assert(a->session_name);
110	assert(b->session_name);
111	if (strcmp(a->session_name, b->session_name)) {
112	goto end;
113	}
114
115	if (a->output && b->output &&
116	!lttng_snapshot_output_is_equal(a->output, b->output)) {
117	goto end;
118	} else if (!!a->output != !!b->output) {
119	goto end;
120	}
121
122	is_equal = true;
123	end:
124	return is_equal;
125	}
126
0c51e8f3	127	static size_t serialize_strlen(const char *str)
757c48a2	128	{
0c51e8f3	129	return str ? strlen(str) + 1 : 0;
757c48a2 SM	130	}
	131
	132	static int lttng_action_snapshot_session_serialize(
	133	struct lttng_action action, struct lttng_payload payload)
	134	{
	135	struct lttng_action_snapshot_session *action_snapshot_session;
	136	struct lttng_action_snapshot_session_comm comm = {};
	137	int ret;
	138	size_t size_before_comm;
	139
	140	assert(action);
	141	assert(payload);
	142
	143	size_before_comm = payload->buffer.size;
	144	size_before_comm = size_before_comm + sizeof(comm);
	145
	146	action_snapshot_session = action_snapshot_session_from_action(action);
	147	comm.session_name_len =
	148	serialize_strlen(action_snapshot_session->session_name);
	149
	150	/* Add header. */
	151	ret = lttng_dynamic_buffer_append(
	152	&payload->buffer, &comm, sizeof(comm));
	153	if (ret) {
	154	goto end;
	155	}
	156
	157	assert(action_snapshot_session->session_name);
	158	DBG("Serializing snapshot session action: session-name: %s",
	159	action_snapshot_session->session_name);
	160
	161	/* Add session name. */
	162	ret = lttng_dynamic_buffer_append(&payload->buffer,
	163	action_snapshot_session->session_name,
	164	comm.session_name_len);
	165	if (ret) {
	166	goto end;
	167	}
	168
	169	/* Serialize the snapshot output object, if any. */
	170	if (action_snapshot_session->output) {
	171	const size_t size_before_output = payload->buffer.size;
	172	struct lttng_action_snapshot_session_comm *comm_in_payload;
	173
	174	ret = lttng_snapshot_output_serialize(
	175	action_snapshot_session->output,
	176	payload);
	177	if (ret) {
	178	goto end;
	179	}
	180
	181	/* Adjust action length in header. */
	182	comm_in_payload = (typeof(comm_in_payload))(
	183	payload->buffer.data + size_before_comm);
	184	comm_in_payload->snapshot_output_len =
	185	payload->buffer.size - size_before_output;
	186	}
	187
	188	end:
	189	return ret;
	190	}
	191
	192	static void lttng_action_snapshot_session_destroy(struct lttng_action *action)
	193	{
194	struct lttng_action_snapshot_session *action_snapshot_session;
195
196	if (!action) {
197	goto end;
198	}
199
200	action_snapshot_session = action_snapshot_session_from_action(action);
201
202	free(action_snapshot_session->session_name);
203	lttng_snapshot_output_destroy(action_snapshot_session->output);
204	free(action_snapshot_session);
205
206	end:
207	return;
208	}
209
210	ssize_t lttng_action_snapshot_session_create_from_payload(
211	struct lttng_payload_view *view,
212	struct lttng_action **p_action)
213	{
214	ssize_t consumed_len;
215	const struct lttng_action_snapshot_session_comm *comm;
216	const char *variable_data;
217	struct lttng_action *action;
218	enum lttng_action_status status;
219	struct lttng_snapshot_output *snapshot_output = NULL;
220
221	action = lttng_action_snapshot_session_create();
222	if (!action) {
223	goto error;
224	}
225
226	comm = (typeof(comm)) view->buffer.data;
227	variable_data = (const char *) &comm->data;
228
229	consumed_len = sizeof(struct lttng_action_snapshot_session_comm);
230
231	if (!lttng_buffer_view_contains_string(
232	&view->buffer, variable_data, comm->session_name_len)) {
233	goto error;
234	}
235
236	status = lttng_action_snapshot_session_set_session_name(
237	action, variable_data);
238	if (status != LTTNG_ACTION_STATUS_OK) {
239	goto error;
240	}
241
242	variable_data += comm->session_name_len;
243	consumed_len += comm->session_name_len;
244
245	/* If there is a snapshot output object, deserialize it. */
246	if (comm->snapshot_output_len > 0) {
247	ssize_t snapshot_output_consumed_len;
248	enum lttng_action_status action_status;
249	struct lttng_payload_view snapshot_output_buffer_view =
250	lttng_payload_view_from_view(view, consumed_len,
251	comm->snapshot_output_len);
252
253	if (!snapshot_output_buffer_view.buffer.data) {
0c51e8f3	254	ERR("Failed to create buffer view for snapshot output.");
757c48a2 SM	255	goto error;
	256	}
	257
	258	snapshot_output_consumed_len =
	259	lttng_snapshot_output_create_from_payload(
	260	&snapshot_output_buffer_view,
	261	&snapshot_output);
	262	if (snapshot_output_consumed_len != comm->snapshot_output_len) {
0c51e8f3	263	ERR("Failed to deserialize snapshot output object: "
757c48a2 SM	264	"consumed-len: %zd, expected-len: %" PRIu32,
	265	snapshot_output_consumed_len,
	266	comm->snapshot_output_len);
	267	goto error;
	268	}
	269
	270	action_status = lttng_action_snapshot_session_set_output(
	271	action, snapshot_output);
	272	if (action_status != LTTNG_ACTION_STATUS_OK) {
	273	goto error;
	274	}
	275
	276	/* Ownership has been transferred to the action. */
	277	snapshot_output = NULL;
	278	}
	279
	280	variable_data += comm->snapshot_output_len;
	281	consumed_len += comm->snapshot_output_len;
	282	*p_action = action;
	283	action = NULL;
	284
	285	goto end;
	286
	287	error:
	288	consumed_len = -1;
	289
	290	end:
	291	lttng_action_snapshot_session_destroy(action);
	292	lttng_snapshot_output_destroy(snapshot_output);
	293
	294	return consumed_len;
	295	}
	296
	297	struct lttng_action *lttng_action_snapshot_session_create(void)
	298	{
	299	struct lttng_action *action;
	300
	301	action = zmalloc(sizeof(struct lttng_action_snapshot_session));
	302	if (!action) {
	303	goto end;
	304	}
	305
	306	lttng_action_init(action, LTTNG_ACTION_TYPE_SNAPSHOT_SESSION,
	307	lttng_action_snapshot_session_validate,
	308	lttng_action_snapshot_session_serialize,
	309	lttng_action_snapshot_session_is_equal,
	310	lttng_action_snapshot_session_destroy);
	311
	312	end:
	313	return action;
	314	}
	315
	316	enum lttng_action_status lttng_action_snapshot_session_set_session_name(
	317	struct lttng_action action, const char session_name)
	318	{
	319	struct lttng_action_snapshot_session *action_snapshot_session;
	320	enum lttng_action_status status;
	321
	322	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !session_name \|\|
	323	strlen(session_name) == 0) {
	324	status = LTTNG_ACTION_STATUS_INVALID;
	325	goto end;
	326	}
	327
328	action_snapshot_session = action_snapshot_session_from_action(action);
329
330	free(action_snapshot_session->session_name);
331
332	action_snapshot_session->session_name = strdup(session_name);
333	if (!action_snapshot_session->session_name) {
334	status = LTTNG_ACTION_STATUS_ERROR;
335	goto end;
336	}
337
338	status = LTTNG_ACTION_STATUS_OK;
339	end:
340	return status;
341	}
342
343	enum lttng_action_status lttng_action_snapshot_session_get_session_name(
344	const struct lttng_action action, const char *session_name)
345	{
346	const struct lttng_action_snapshot_session *action_snapshot_session;
347	enum lttng_action_status status;
348
349	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !session_name) {
350	status = LTTNG_ACTION_STATUS_INVALID;
351	goto end;
352	}
353
354	action_snapshot_session = action_snapshot_session_from_action_const(action);
355
356	if (action_snapshot_session->session_name) {
357	*session_name = action_snapshot_session->session_name;
358	status = LTTNG_ACTION_STATUS_OK;
359	} else {
360	status = LTTNG_ACTION_STATUS_UNSET;
361	}
362
363	end:
364
365	return status;
366	}
367
368	enum lttng_action_status lttng_action_snapshot_session_set_output(
369	struct lttng_action *action,
370	struct lttng_snapshot_output *output)
371	{
372	struct lttng_action_snapshot_session *action_snapshot_session;
373	enum lttng_action_status status;
374
375	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action) \|\| !output) {
376	status = LTTNG_ACTION_STATUS_INVALID;
377	goto end;
378	}
379
380	action_snapshot_session = action_snapshot_session_from_action(action);
381
382	lttng_snapshot_output_destroy(action_snapshot_session->output);
383	action_snapshot_session->output = output;
384
385	status = LTTNG_ACTION_STATUS_OK;
386
387	end:
388	return status;
389	}
390
391	enum lttng_action_status lttng_action_snapshot_session_get_output(
392	const struct lttng_action *action,
393	const struct lttng_snapshot_output **output)
394	{
395	const struct lttng_action_snapshot_session *action_snapshot_session;
396	enum lttng_action_status status;
397
398	if (!action \|\| !IS_SNAPSHOT_SESSION_ACTION(action)\|\| !output) {
399	status = LTTNG_ACTION_STATUS_INVALID;
400	goto end;
401	}
402
403	action_snapshot_session = action_snapshot_session_from_action_const(action);
404
405	if (action_snapshot_session->output) {
406	*output = action_snapshot_session->output;
407	status = LTTNG_ACTION_STATUS_OK;
408	} else {
409	status = LTTNG_ACTION_STATUS_UNSET;
410	}
411
412	end:
413	return status;
414	}