[lttng-tools.git] / src / bin / lttng / command.h

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LTTNG_CMD_H
#define _LTTNG_CMD_H

#include <lttng/lttng.h>
#include <common/common.h>
#include <common/defaults.h>

#include "conf.h"
#include "utils.h"

#define DECL_COMMAND(_name) \
	extern int cmd_##_name(int, const char **)

#define SHOW_HELP() 							\
	do {								\
		ret = show_cmd_man_page(argv[0]);			\
									\
		if (ret) {						\
			ERR("Cannot view man page lttng-%s(1)", argv[0]); \
			perror("exec");					\
		}							\
	} while (0)

enum cmd_error_code {
	CMD_SUCCESS = 0,
	CMD_ERROR,
	CMD_UNDEFINED,
	CMD_FATAL,
	CMD_WARNING,
	CMD_UNSUPPORTED,
};

struct cmd_struct {
	const char *name;
	int (*func)(int argc, const char **argv);
};

DECL_COMMAND(list);
DECL_COMMAND(status);
DECL_COMMAND(create);
DECL_COMMAND(destroy);
DECL_COMMAND(start);
DECL_COMMAND(stop);
DECL_COMMAND(enable_events);
DECL_COMMAND(disable_events);
DECL_COMMAND(enable_channels);
DECL_COMMAND(disable_channels);
DECL_COMMAND(add_context);
DECL_COMMAND(set_session);
DECL_COMMAND(version);
DECL_COMMAND(calibrate);
DECL_COMMAND(view);
DECL_COMMAND(enable_consumer);
DECL_COMMAND(disable_consumer);
DECL_COMMAND(snapshot);
DECL_COMMAND(save);
DECL_COMMAND(load);
DECL_COMMAND(track);
DECL_COMMAND(untrack);
DECL_COMMAND(metadata);

#endif /* _LTTNG_CMD_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License, version 2 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along
	14	* with this program; if not, write to the Free Software Foundation, Inc.,
	15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#ifndef _LTTNG_CMD_H
	19	#define _LTTNG_CMD_H
	20
	21	#include <lttng/lttng.h>
	22	#include <common/common.h>
	23	#include <common/defaults.h>
	24
	25	#include "conf.h"
	26	#include "utils.h"
	27
	28	#define DECL_COMMAND(_name) \
	29	extern int cmd_##_name(int, const char **)
	30
	31	#define SHOW_HELP() \
	32	do { \
	33	ret = show_cmd_man_page(argv[0]); \
	34	\
	35	if (ret) { \
	36	ERR("Cannot view man page lttng-%s(1)", argv[0]); \
	37	perror("exec"); \
	38	} \
	39	} while (0)
	40
	41	enum cmd_error_code {
	42	CMD_SUCCESS = 0,
	43	CMD_ERROR,
	44	CMD_UNDEFINED,
	45	CMD_FATAL,
	46	CMD_WARNING,
	47	CMD_UNSUPPORTED,
	48	};
	49
	50	struct cmd_struct {
	51	const char *name;
	52	int (func)(int argc, const char *argv);
	53	};
	54
	55	DECL_COMMAND(list);
	56	DECL_COMMAND(status);
	57	DECL_COMMAND(create);
	58	DECL_COMMAND(destroy);
	59	DECL_COMMAND(start);
	60	DECL_COMMAND(stop);
	61	DECL_COMMAND(enable_events);
	62	DECL_COMMAND(disable_events);
	63	DECL_COMMAND(enable_channels);
	64	DECL_COMMAND(disable_channels);
	65	DECL_COMMAND(add_context);
	66	DECL_COMMAND(set_session);
	67	DECL_COMMAND(version);
	68	DECL_COMMAND(calibrate);
	69	DECL_COMMAND(view);
	70	DECL_COMMAND(enable_consumer);
	71	DECL_COMMAND(disable_consumer);
	72	DECL_COMMAND(snapshot);
	73	DECL_COMMAND(save);
	74	DECL_COMMAND(load);
	75	DECL_COMMAND(track);
	76	DECL_COMMAND(untrack);
	77	DECL_COMMAND(metadata);
	78
	79	#endif /* _LTTNG_CMD_H */