[lttng-tools.git] / src / bin / lttng / commands / disable_rotation.c

/*
 * Copyright (C) 2017 Julien Desfossez <jdesfossez@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#define _LGPL_SOURCE
#include <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <inttypes.h>
#include <ctype.h>

#include <common/sessiond-comm/sessiond-comm.h>
#include <common/mi-lttng.h>

#include "../command.h"
#include <lttng/lttng.h>

static char *opt_session_name;
static struct mi_writer *writer;

#ifdef LTTNG_EMBED_HELP
static const char help_msg[] =
#include <lttng-disable-rotation.1.h>
;
#endif

enum {
	OPT_HELP = 1,
	OPT_LIST_OPTIONS,
	OPT_TIMER,
	OPT_SIZE,
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help",        'h',  POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	{"list-options", 0,   POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{"session",     's',  POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
	{"timer",        0,   POPT_ARG_NONE, 0, OPT_TIMER, 0, 0},
	{"size",         0,   POPT_ARG_NONE, 0, OPT_SIZE, 0, 0},
	{0, 0, 0, 0, 0, 0, 0}
};

static const char *schedule_type_str[] = {
	[LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC] = "periodic",
	[LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD] = "size-based",
};

static const struct lttng_rotation_schedule *get_schedule(
		const char *session_name,
		const struct lttng_rotation_schedules *schedules,
		enum lttng_rotation_schedule_type schedule_type)
{
	unsigned int count, i;
	enum lttng_rotation_status status;
	const struct lttng_rotation_schedule *ret = NULL;

	status = lttng_rotation_schedules_get_count(schedules, &count);
	if (status != LTTNG_ROTATION_STATUS_OK) {
		ERR("Unable to determine the number of rotation schedules of session %s",
				session_name);
		goto end;
	}

	for (i = 0; i < count; i++) {
		const struct lttng_rotation_schedule *schedule = NULL;

		schedule = lttng_rotation_schedules_get_at_index(schedules, i);
		if (!schedule) {
			ERR("Unable to retrieve rotation schedule at index %u",
					i);
			goto end;
		}

		if (lttng_rotation_schedule_get_type(schedule) ==
				schedule_type) {
			ret = schedule;
			break;
		}
	}

	if (!ret) {
		ERR("No %s rotation schedule active on session %s",
				schedule_type_str[schedule_type], session_name);
	}
end:
	return ret;
}

static struct lttng_rotation_schedule *create_empty_schedule(
		enum lttng_rotation_schedule_type type)
{
	struct lttng_rotation_schedule *schedule = NULL;

	switch (type) {
	case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
		schedule = lttng_rotation_schedule_periodic_create();
		break;
	case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
		schedule = lttng_rotation_schedule_size_threshold_create();
		break;
	default:
		abort();
	}
	return schedule;
}

static enum cmd_error_code remove_schedule(const char *session_name,
		enum lttng_rotation_schedule_type schedule_type)
{
	enum cmd_error_code cmd_ret;
	int ret;
	const struct lttng_rotation_schedule *schedule = NULL;
	struct lttng_rotation_schedules *schedules = NULL;
	enum lttng_rotation_status status;
	const char *schedule_type_name;
	struct lttng_rotation_schedule *empty_schedule = NULL;

	switch (schedule_type) {
	case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
	case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
		break;
	default:
		ERR("Unknown schedule type");
		abort();
	}

	schedule_type_name = schedule_type_str[schedule_type];

	ret = lttng_session_list_rotation_schedules(session_name, &schedules);
	if (ret != LTTNG_OK) {
		ERR("Failed to list rotation schedules of session %s",
				session_name);
		goto error;
	}

	schedule = get_schedule(session_name, schedules, schedule_type);
	if (!schedule) {
		cmd_ret = CMD_ERROR;
		/*
		 * get_schedule() logs its own errors.
		 * A temporaty schedule is created to serialize an MI rotation
		 * schedule descriptor of the appropriate type that has no
		 * attributes set.
		 */
		empty_schedule = create_empty_schedule(schedule_type);
		if (!empty_schedule) {
			goto error;
		}
		goto skip_removal;
	}

	status = lttng_session_remove_rotation_schedule(session_name, schedule);
	switch (status) {
	case LTTNG_ROTATION_STATUS_OK:
		MSG("Disabled %s rotation on session %s",
				schedule_type_name, session_name);
		cmd_ret = CMD_SUCCESS;
		break;
	case LTTNG_ROTATION_STATUS_SCHEDULE_NOT_SET:
		ERR("No %s rotation schedule set on session %s",
				schedule_type_name,
				session_name);
		cmd_ret = CMD_ERROR;
		break;
	case LTTNG_ROTATION_STATUS_ERROR:
	case LTTNG_ROTATION_STATUS_INVALID:
	default:
		ERR("Failed to disable %s rotation schedule on session %s",
				schedule_type_name, session_name);
		cmd_ret = CMD_ERROR;
		break;
	}

skip_removal:
	if (lttng_opt_mi) {
		ret = mi_lttng_rotation_schedule_result(writer,
				schedule ? schedule : empty_schedule,
				cmd_ret == CMD_SUCCESS);
		if (ret < 0) {
			goto error;
		}
	}

end:
	lttng_rotation_schedules_destroy(schedules);
	lttng_rotation_schedule_destroy(empty_schedule);
	return cmd_ret;
error:
	cmd_ret = CMD_ERROR;
	goto end;
}

/*
 *  cmd_disable_rotation
 *
 *  The 'disable-rotation <options>' first level command
 */
int cmd_disable_rotation(int argc, const char **argv)
{
	int popt_ret, opt, ret = 0;
	enum cmd_error_code cmd_ret = CMD_SUCCESS;
	static poptContext pc;
	char *session_name = NULL;
	bool free_session_name = false;
	bool periodic_rotation = false, size_rotation = false;

	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	popt_ret = poptReadDefaultConfig(pc, 0);
	if (popt_ret) {
		cmd_ret = CMD_ERROR;
		ERR("poptReadDefaultConfig");
		goto end;
	}

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			SHOW_HELP();
			goto end;
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			goto end;
		case OPT_TIMER:
			periodic_rotation = true;
			break;
		case OPT_SIZE:
			size_rotation = true;
			break;
		default:
			cmd_ret = CMD_UNDEFINED;
			goto end;
		}
	}

	if (opt_session_name == NULL) {
		session_name = get_session_name();
		if (session_name == NULL) {
			goto error;
		}
		free_session_name = true;
	} else {
		session_name = opt_session_name;
	}

	/* Mi check */
	if (lttng_opt_mi) {
		writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
		if (!writer) {
			goto error;
		}

		/* Open command element */
		ret = mi_lttng_writer_command_open(writer,
				mi_lttng_element_command_disable_rotation);
		if (ret) {
			goto error;
		}

		/* Open output element */
		ret = mi_lttng_writer_open_element(writer,
				mi_lttng_element_command_output);
		if (ret) {
			goto error;
		}
	}

	if (!periodic_rotation && !size_rotation) {
		ERR("No session rotation schedule type provided.");
		cmd_ret = CMD_ERROR;
		goto close_command;
	}

	if (lttng_opt_mi) {
		ret = mi_lttng_writer_open_element(writer,
				mi_lttng_element_rotation_schedule_results);
		if (ret) {
			goto error;
		}

		ret = mi_lttng_writer_write_element_string(writer,
				mi_lttng_element_session_name,
				session_name);
		if (ret) {
			goto error;
		}
	}

	if (periodic_rotation) {
		/*
		 * Continue processing even on error as multiple schedules can
		 * be specified at once.
		 */
		cmd_ret = remove_schedule(session_name,
				LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC);
	}

	if (size_rotation) {
		enum cmd_error_code tmp_ret;

		/* Don't overwrite cmd_ret if it already indicates an error. */
		tmp_ret = remove_schedule(session_name,
				LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD);
		cmd_ret = cmd_ret ? cmd_ret : tmp_ret;
	}

	if (lttng_opt_mi) {
		/* Close rotation schedule results element */
		ret = mi_lttng_writer_close_element(writer);
		if (ret) {
			goto error;
		}
	}

close_command:
	/* Mi closing */
	if (lttng_opt_mi) {
		/* Close  output element */
		ret = mi_lttng_writer_close_element(writer);
		if (ret) {
			goto error;
		}

		/* Success ? */
		ret = mi_lttng_writer_write_element_bool(writer,
				mi_lttng_element_command_success,
				cmd_ret == CMD_SUCCESS);
		if (ret) {
			goto error;
		}

		/* Command element close */
		ret = mi_lttng_writer_command_close(writer);
		if (ret) {
			goto error;
		}
	}

end:
	(void) mi_lttng_writer_destroy(writer);
	poptFreeContext(pc);
	if (free_session_name) {
		free(session_name);
	}
	return cmd_ret;
error:
	cmd_ret = CMD_ERROR;
	goto end;
}
Commit	Line	Data
259c2674	1	/*
ab5be9fa	2	* Copyright (C) 2017 Julien Desfossez <jdesfossez@efficios.com>
259c2674	3	*
ab5be9fa	4	* SPDX-License-Identifier: GPL-2.0-only
259c2674	5	*
259c2674 JD	6	*/
	7
	8	#define _LGPL_SOURCE
	9	#include <popt.h>
	10	#include <stdio.h>
	11	#include <stdlib.h>
	12	#include <string.h>
	13	#include <sys/stat.h>
	14	#include <sys/types.h>
	15	#include <unistd.h>
	16	#include <inttypes.h>
	17	#include <ctype.h>
	18
	19	#include <common/sessiond-comm/sessiond-comm.h>
	20	#include <common/mi-lttng.h>
	21
	22	#include "../command.h"
050dd639	23	#include <lttng/lttng.h>
259c2674 JD	24
	25	static char *opt_session_name;
	26	static struct mi_writer *writer;
	27
3ae5c539 JD	28	#ifdef LTTNG_EMBED_HELP
	29	static const char help_msg[] =
	30	#include <lttng-disable-rotation.1.h>
	31	;
	32	#endif
	33
259c2674 JD	34	enum {
	35	OPT_HELP = 1,
	36	OPT_LIST_OPTIONS,
	37	OPT_TIMER,
90936dcf	38	OPT_SIZE,
259c2674 JD	39	};
	40
	41	static struct poptOption long_options[] = {
	42	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
66ea93b1 JG	43	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	44	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	45	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
259c2674	46	{"timer", 0, POPT_ARG_NONE, 0, OPT_TIMER, 0, 0},
90936dcf	47	{"size", 0, POPT_ARG_NONE, 0, OPT_SIZE, 0, 0},
259c2674 JD	48	{0, 0, 0, 0, 0, 0, 0}
	49	};
	50
66ea93b1 JG	51	static const char *schedule_type_str[] = {
	52	[LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC] = "periodic",
	53	[LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD] = "size-based",
	54	};
	55
	56	static const struct lttng_rotation_schedule *get_schedule(
	57	const char *session_name,
	58	const struct lttng_rotation_schedules *schedules,
	59	enum lttng_rotation_schedule_type schedule_type)
259c2674	60	{
66ea93b1 JG	61	unsigned int count, i;
	62	enum lttng_rotation_status status;
	63	const struct lttng_rotation_schedule *ret = NULL;
259c2674	64
66ea93b1 JG	65	status = lttng_rotation_schedules_get_count(schedules, &count);
	66	if (status != LTTNG_ROTATION_STATUS_OK) {
	67	ERR("Unable to determine the number of rotation schedules of session %s",
	68	session_name);
	69	goto end;
259c2674 JD	70	}
259c2674 JD	71
66ea93b1 JG	72	for (i = 0; i < count; i++) {
	73	const struct lttng_rotation_schedule *schedule = NULL;
	74
	75	schedule = lttng_rotation_schedules_get_at_index(schedules, i);
	76	if (!schedule) {
	77	ERR("Unable to retrieve rotation schedule at index %u",
	78	i);
	79	goto end;
259c2674	80	}
259c2674	81
66ea93b1 JG	82	if (lttng_rotation_schedule_get_type(schedule) ==
	83	schedule_type) {
	84	ret = schedule;
	85	break;
259c2674 JD	86	}
	87	}
	88
66ea93b1 JG	89	if (!ret) {
	90	ERR("No %s rotation schedule active on session %s",
	91	schedule_type_str[schedule_type], session_name);
259c2674	92	}
66ea93b1 JG	93	end:
	94	return ret;
	95	}
	96
	97	static struct lttng_rotation_schedule *create_empty_schedule(
	98	enum lttng_rotation_schedule_type type)
	99	{
	100	struct lttng_rotation_schedule *schedule = NULL;
	101
	102	switch (type) {
	103	case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
	104	schedule = lttng_rotation_schedule_periodic_create();
	105	break;
	106	case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
	107	schedule = lttng_rotation_schedule_size_threshold_create();
	108	break;
	109	default:
	110	abort();
90936dcf	111	}
66ea93b1 JG	112	return schedule;
66ea93b1 JG	113	}
259c2674	114
66ea93b1 JG	115	static enum cmd_error_code remove_schedule(const char *session_name,
	116	enum lttng_rotation_schedule_type schedule_type)
	117	{
	118	enum cmd_error_code cmd_ret;
	119	int ret;
	120	const struct lttng_rotation_schedule *schedule = NULL;
	121	struct lttng_rotation_schedules *schedules = NULL;
	122	enum lttng_rotation_status status;
	123	const char *schedule_type_name;
	124	struct lttng_rotation_schedule *empty_schedule = NULL;
	125
	126	switch (schedule_type) {
	127	case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
	128	case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
	129	break;
	130	default:
	131	ERR("Unknown schedule type");
	132	abort();
	133	}
	134
	135	schedule_type_name = schedule_type_str[schedule_type];
	136
	137	ret = lttng_session_list_rotation_schedules(session_name, &schedules);
	138	if (ret != LTTNG_OK) {
	139	ERR("Failed to list rotation schedules of session %s",
	140	session_name);
259c2674 JD	141	goto error;
	142	}
	143
66ea93b1 JG	144	schedule = get_schedule(session_name, schedules, schedule_type);
	145	if (!schedule) {
	146	cmd_ret = CMD_ERROR;
	147	/*
	148	* get_schedule() logs its own errors.
	149	* A temporaty schedule is created to serialize an MI rotation
	150	* schedule descriptor of the appropriate type that has no
	151	* attributes set.
	152	*/
	153	empty_schedule = create_empty_schedule(schedule_type);
	154	if (!empty_schedule) {
	155	goto error;
259c2674	156	}
66ea93b1 JG	157	goto skip_removal;
66ea93b1 JG	158	}
259c2674	159
66ea93b1 JG	160	status = lttng_session_remove_rotation_schedule(session_name, schedule);
	161	switch (status) {
	162	case LTTNG_ROTATION_STATUS_OK:
	163	MSG("Disabled %s rotation on session %s",
	164	schedule_type_name, session_name);
	165	cmd_ret = CMD_SUCCESS;
	166	break;
	167	case LTTNG_ROTATION_STATUS_SCHEDULE_NOT_SET:
	168	ERR("No %s rotation schedule set on session %s",
	169	schedule_type_name,
	170	session_name);
	171	cmd_ret = CMD_ERROR;
	172	break;
	173	case LTTNG_ROTATION_STATUS_ERROR:
	174	case LTTNG_ROTATION_STATUS_INVALID:
	175	default:
	176	ERR("Failed to disable %s rotation schedule on session %s",
	177	schedule_type_name, session_name);
	178	cmd_ret = CMD_ERROR;
	179	break;
259c2674 JD	180	}
259c2674 JD	181
66ea93b1 JG	182	skip_removal:
	183	if (lttng_opt_mi) {
	184	ret = mi_lttng_rotation_schedule_result(writer,
	185	schedule ? schedule : empty_schedule,
	186	cmd_ret == CMD_SUCCESS);
	187	if (ret < 0) {
	188	goto error;
	189	}
	190	}
259c2674	191
259c2674	192	end:
66ea93b1 JG	193	lttng_rotation_schedules_destroy(schedules);
	194	lttng_rotation_schedule_destroy(empty_schedule);
	195	return cmd_ret;
	196	error:
	197	cmd_ret = CMD_ERROR;
	198	goto end;
259c2674 JD	199	}
	200
	201	/*
	202	* cmd_disable_rotation
	203	*
66ea93b1	204	* The 'disable-rotation <options>' first level command
259c2674 JD	205	*/
	206	int cmd_disable_rotation(int argc, const char **argv)
	207	{
66ea93b1 JG	208	int popt_ret, opt, ret = 0;
66ea93b1 JG	209	enum cmd_error_code cmd_ret = CMD_SUCCESS;
259c2674 JD	210	static poptContext pc;
	211	char *session_name = NULL;
	212	bool free_session_name = false;
66ea93b1	213	bool periodic_rotation = false, size_rotation = false;
259c2674 JD	214
	215	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	216	popt_ret = poptReadDefaultConfig(pc, 0);
	217	if (popt_ret) {
62140c46	218	cmd_ret = CMD_ERROR;
259c2674 JD	219	ERR("poptReadDefaultConfig");
	220	goto end;
	221	}
	222
	223	while ((opt = poptGetNextOpt(pc)) != -1) {
	224	switch (opt) {
	225	case OPT_HELP:
	226	SHOW_HELP();
	227	goto end;
	228	case OPT_LIST_OPTIONS:
	229	list_cmd_options(stdout, long_options);
	230	goto end;
	231	case OPT_TIMER:
66ea93b1	232	periodic_rotation = true;
259c2674	233	break;
90936dcf	234	case OPT_SIZE:
66ea93b1	235	size_rotation = true;
90936dcf	236	break;
259c2674	237	default:
62140c46	238	cmd_ret = CMD_UNDEFINED;
259c2674 JD	239	goto end;
	240	}
	241	}
	242
	243	if (opt_session_name == NULL) {
	244	session_name = get_session_name();
	245	if (session_name == NULL) {
66ea93b1	246	goto error;
259c2674 JD	247	}
	248	free_session_name = true;
	249	} else {
	250	session_name = opt_session_name;
	251	}
	252
	253	/* Mi check */
	254	if (lttng_opt_mi) {
	255	writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
	256	if (!writer) {
66ea93b1	257	goto error;
259c2674 JD	258	}
	259
	260	/* Open command element */
	261	ret = mi_lttng_writer_command_open(writer,
	262	mi_lttng_element_command_disable_rotation);
	263	if (ret) {
66ea93b1	264	goto error;
259c2674 JD	265	}
	266
	267	/* Open output element */
	268	ret = mi_lttng_writer_open_element(writer,
	269	mi_lttng_element_command_output);
	270	if (ret) {
66ea93b1	271	goto error;
259c2674 JD	272	}
	273	}
	274
66ea93b1 JG	275	if (!periodic_rotation && !size_rotation) {
	276	ERR("No session rotation schedule type provided.");
	277	cmd_ret = CMD_ERROR;
	278	goto close_command;
259c2674 JD	279	}
259c2674 JD	280
66ea93b1 JG	281	if (lttng_opt_mi) {
	282	ret = mi_lttng_writer_open_element(writer,
	283	mi_lttng_element_rotation_schedule_results);
	284	if (ret) {
	285	goto error;
	286	}
	287
	288	ret = mi_lttng_writer_write_element_string(writer,
	289	mi_lttng_element_session_name,
	290	session_name);
	291	if (ret) {
	292	goto error;
	293	}
259c2674 JD	294	}
259c2674 JD	295
66ea93b1 JG	296	if (periodic_rotation) {
	297	/*
	298	* Continue processing even on error as multiple schedules can
	299	* be specified at once.
	300	*/
	301	cmd_ret = remove_schedule(session_name,
	302	LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC);
	303	}
	304
	305	if (size_rotation) {
a14a81cb	306	enum cmd_error_code tmp_ret;
66ea93b1 JG	307
	308	/* Don't overwrite cmd_ret if it already indicates an error. */
	309	tmp_ret = remove_schedule(session_name,
	310	LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD);
	311	cmd_ret = cmd_ret ? cmd_ret : tmp_ret;
	312	}
	313
	314	if (lttng_opt_mi) {
	315	/* Close rotation schedule results element */
	316	ret = mi_lttng_writer_close_element(writer);
	317	if (ret) {
	318	goto error;
	319	}
	320	}
	321
	322	close_command:
259c2674 JD	323	/* Mi closing */
	324	if (lttng_opt_mi) {
	325	/* Close output element */
	326	ret = mi_lttng_writer_close_element(writer);
	327	if (ret) {
66ea93b1	328	goto error;
259c2674 JD	329	}
	330
	331	/* Success ? */
	332	ret = mi_lttng_writer_write_element_bool(writer,
66ea93b1 JG	333	mi_lttng_element_command_success,
66ea93b1 JG	334	cmd_ret == CMD_SUCCESS);
259c2674	335	if (ret) {
66ea93b1	336	goto error;
259c2674 JD	337	}
	338
	339	/* Command element close */
	340	ret = mi_lttng_writer_command_close(writer);
	341	if (ret) {
66ea93b1	342	goto error;
259c2674 JD	343	}
	344	}
	345
	346	end:
66ea93b1	347	(void) mi_lttng_writer_destroy(writer);
259c2674 JD	348	poptFreeContext(pc);
	349	if (free_session_name) {
	350	free(session_name);
	351	}
66ea93b1 JG	352	return cmd_ret;
	353	error:
	354	cmd_ret = CMD_ERROR;
	355	goto end;
259c2674	356	}