[lttng-tools.git] / lttng / commands / add_channel.c

/*
 * 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
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#define _GNU_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 "cmd.h"
#include "conf.h"
#include "utils.h"

static char *opt_channel_name;
static char *opt_kernel;
static char *opt_cmd_name;
static char *opt_session_name;
static int opt_pid_all;
static int opt_userspace;
static pid_t opt_pid;
static struct lttng_channel chan;

enum {
	OPT_HELP = 1,
	OPT_DISCARD,
	OPT_OVERWRITE,
	OPT_SUBBUF_SIZE,
	OPT_NUM_SUBBUF,
	OPT_SWITCH_TIMER,
	OPT_READ_TIMER,
	OPT_USERSPACE,
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	{"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
	{"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
	{"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
	{"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
	{"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	{"discard",        0,   POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
	{"overwrite",      0,   POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
	{"subbuf_size",    0,   POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
	{"num_subbuf",     0,   POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
	{"switch_timer",   0,   POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
	{"read_timer",     0,   POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng add-channel NAME [options] [channel_options]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  -h, --help               Show this help\n");
	fprintf(ofp, "  -s, --session            Apply on session name\n");
	fprintf(ofp, "  -k, --kernel             Apply on the kernel tracer\n");
	fprintf(ofp, "  -u, --userspace [CMD]    Apply on the user-space tracer\n");
	fprintf(ofp, "      --all                If -u, apply on all traceable apps\n");
	fprintf(ofp, "  -p, --pid PID            If -u, apply on a specific PID\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Channel options:\n");
	fprintf(ofp, "      --discard            Discard event when buffers are full (default)\n");
	fprintf(ofp, "      --overwrite          Flight recorder mode\n");
	fprintf(ofp, "      --subbuf_size        Subbuffer size in bytes (default: 4096)\n");
	fprintf(ofp, "      --num_subbuf         Number of subbufers (default: 2)\n");
	fprintf(ofp, "      --switch_timer       Switch timer interval in usec (default: 0)\n");
	fprintf(ofp, "      --read_timer         Read timer interval in usec (default: 200)\n");
	fprintf(ofp, "\n");
}

/*
 *  add_channel
 *
 *  Adding channel using the lttng API.
 */
static int add_channel(void)
{
	int ret = CMD_SUCCESS;

	if (set_session_name(opt_session_name) < 0) {
		ret = CMD_ERROR;
		goto error;
	}

	/* Copy channel name and normalize it */
	strncpy(chan.name, opt_channel_name, NAME_MAX);
	chan.name[NAME_MAX - 1] = '\0';

	/* Kernel tracer action */
	if (opt_kernel) {
		/* Create kernel channel */
		ret = lttng_kernel_create_channel(&chan);
		if (ret < 0) {
			goto error;
		}
	} else if (opt_userspace) {		/* User-space tracer action */
		/*
		 * TODO: Waiting on lttng UST 2.0
		 */
		if (opt_pid_all) {
		} else if (opt_pid != 0) {
		}
		ret = CMD_NOT_IMPLEMENTED;
		goto error;
	} else {
		ERR("Please specify a tracer (kernel or user-space)");
		goto error;
	}

	MSG("Channel %s created", opt_channel_name);

error:
	return ret;
}

/*
 *  init_channel_config
 *
 *  Default value for channel configuration.
 */
static void init_channel_config(void)
{
	chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
	chan.attr.subbuf_size = DEFAULT_CHANNEL_SUBBUF_SIZE;
	chan.attr.num_subbuf = DEFAULT_CHANNEL_SUBBUF_NUM;
	chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
	chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
	chan.attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
}

/*
 *  cmd_add_channel
 *
 *  Add channel to trace session
 */
int cmd_add_channel(int argc, const char **argv)
{
	int opt, ret;
	static poptContext pc;

	init_channel_config();

	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	poptReadDefaultConfig(pc, 0);

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stderr);
			ret = CMD_SUCCESS;
			goto end;
		case OPT_USERSPACE:
			opt_userspace = 1;
			opt_cmd_name = poptGetOptArg(pc);
			break;
		case OPT_DISCARD:
			chan.attr.overwrite = 0;
			DBG("Channel set to discard");
			break;
		case OPT_OVERWRITE:
			chan.attr.overwrite = 1;
			DBG("Channel set to overwrite");
			break;
		case OPT_SUBBUF_SIZE:
			chan.attr.subbuf_size = atol(poptGetOptArg(pc));
			DBG("Channel subbuf size set to %lu", chan.attr.subbuf_size);
			break;
		case OPT_NUM_SUBBUF:
			chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
			DBG("Channel subbuf num set to %lu", chan.attr.num_subbuf);
			break;
		case OPT_SWITCH_TIMER:
			chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
			DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
			break;
		case OPT_READ_TIMER:
			chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
			DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
			break;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	opt_channel_name = (char*) poptGetArg(pc);
	if (opt_channel_name == NULL) {
		ERR("Missing channel name.\n");
		usage(stderr);
		ret = CMD_SUCCESS;
		goto end;
	}

	ret = add_channel();

end:
	return ret;
}
Commit	Line	Data
f3ed775e DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
	6	* as published by the Free Software Foundation; either version 2
	7	* of the License, or (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*/
	18
	19	#define _GNU_SOURCE
	20	#include <popt.h>
	21	#include <stdio.h>
	22	#include <stdlib.h>
	23	#include <string.h>
	24	#include <sys/stat.h>
	25	#include <sys/types.h>
	26	#include <unistd.h>
	27
	28	#include "cmd.h"
beb8c75a	29	#include "conf.h"
f3ed775e DG	30	#include "utils.h"
	31
	32	static char *opt_channel_name;
	33	static char *opt_kernel;
	34	static char *opt_cmd_name;
5440dc42	35	static char *opt_session_name;
f3ed775e DG	36	static int opt_pid_all;
	37	static int opt_userspace;
	38	static pid_t opt_pid;
	39	static struct lttng_channel chan;
	40
	41	enum {
	42	OPT_HELP = 1,
	43	OPT_DISCARD,
	44	OPT_OVERWRITE,
	45	OPT_SUBBUF_SIZE,
	46	OPT_NUM_SUBBUF,
	47	OPT_SWITCH_TIMER,
	48	OPT_READ_TIMER,
	49	OPT_USERSPACE,
	50	};
	51
	52	static struct poptOption long_options[] = {
	53	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	54	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42	55	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
f3ed775e DG	56	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
	57	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
	58	{"all", 0, POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
	59	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	60	{"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
	61	{"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
	62	{"subbuf_size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
	63	{"num_subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
	64	{"switch_timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
	65	{"read_timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
	66	{0, 0, 0, 0, 0, 0, 0}
	67	};
	68
	69	/*
	70	* usage
	71	*/
	72	static void usage(FILE *ofp)
	73	{
	74	fprintf(ofp, "usage: lttng add-channel NAME [options] [channel_options]\n");
	75	fprintf(ofp, "\n");
	76	fprintf(ofp, " -h, --help Show this help\n");
5440dc42	77	fprintf(ofp, " -s, --session Apply on session name\n");
f3ed775e DG	78	fprintf(ofp, " -k, --kernel Apply on the kernel tracer\n");
	79	fprintf(ofp, " -u, --userspace [CMD] Apply on the user-space tracer\n");
	80	fprintf(ofp, " --all If -u, apply on all traceable apps\n");
	81	fprintf(ofp, " -p, --pid PID If -u, apply on a specific PID\n");
	82	fprintf(ofp, "\n");
	83	fprintf(ofp, "Channel options:\n");
	84	fprintf(ofp, " --discard Discard event when buffers are full (default)\n");
	85	fprintf(ofp, " --overwrite Flight recorder mode\n");
	86	fprintf(ofp, " --subbuf_size Subbuffer size in bytes (default: 4096)\n");
	87	fprintf(ofp, " --num_subbuf Number of subbufers (default: 2)\n");
	88	fprintf(ofp, " --switch_timer Switch timer interval in usec (default: 0)\n");
	89	fprintf(ofp, " --read_timer Read timer interval in usec (default: 200)\n");
	90	fprintf(ofp, "\n");
	91	}
	92
	93	/*
	94	* add_channel
	95	*
	96	* Adding channel using the lttng API.
	97	*/
	98	static int add_channel(void)
	99	{
	100	int ret = CMD_SUCCESS;
	101
5440dc42	102	if (set_session_name(opt_session_name) < 0) {
f3ed775e DG	103	ret = CMD_ERROR;
	104	goto error;
	105	}
	106
	107	/* Copy channel name and normalize it */
	108	strncpy(chan.name, opt_channel_name, NAME_MAX);
	109	chan.name[NAME_MAX - 1] = '\0';
	110
	111	/* Kernel tracer action */
	112	if (opt_kernel) {
	113	/* Create kernel channel */
	114	ret = lttng_kernel_create_channel(&chan);
	115	if (ret < 0) {
	116	goto error;
	117	}
	118	} else if (opt_userspace) { /* User-space tracer action */
	119	/*
	120	* TODO: Waiting on lttng UST 2.0
	121	*/
	122	if (opt_pid_all) {
	123	} else if (opt_pid != 0) {
	124	}
	125	ret = CMD_NOT_IMPLEMENTED;
	126	goto error;
	127	} else {
	128	ERR("Please specify a tracer (kernel or user-space)");
	129	goto error;
	130	}
	131
	132	MSG("Channel %s created", opt_channel_name);
	133
	134	error:
	135	return ret;
	136	}
	137
	138	/*
	139	* init_channel_config
	140	*
	141	* Default value for channel configuration.
	142	*/
	143	static void init_channel_config(void)
	144	{
	145	chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
	146	chan.attr.subbuf_size = DEFAULT_CHANNEL_SUBBUF_SIZE;
	147	chan.attr.num_subbuf = DEFAULT_CHANNEL_SUBBUF_NUM;
	148	chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
	149	chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
7d452e12	150	chan.attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
f3ed775e DG	151	}
	152
	153	/*
	154	* cmd_add_channel
	155	*
	156	* Add channel to trace session
	157	*/
	158	int cmd_add_channel(int argc, const char **argv)
	159	{
	160	int opt, ret;
	161	static poptContext pc;
	162
	163	init_channel_config();
	164
	165	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	166	poptReadDefaultConfig(pc, 0);
	167
	168	while ((opt = poptGetNextOpt(pc)) != -1) {
	169	switch (opt) {
	170	case OPT_HELP:
	171	usage(stderr);
	172	ret = CMD_SUCCESS;
	173	goto end;
	174	case OPT_USERSPACE:
	175	opt_userspace = 1;
	176	opt_cmd_name = poptGetOptArg(pc);
	177	break;
	178	case OPT_DISCARD:
	179	chan.attr.overwrite = 0;
	180	DBG("Channel set to discard");
	181	break;
	182	case OPT_OVERWRITE:
	183	chan.attr.overwrite = 1;
	184	DBG("Channel set to overwrite");
	185	break;
	186	case OPT_SUBBUF_SIZE:
	187	chan.attr.subbuf_size = atol(poptGetOptArg(pc));
	188	DBG("Channel subbuf size set to %lu", chan.attr.subbuf_size);
	189	break;
	190	case OPT_NUM_SUBBUF:
	191	chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
	192	DBG("Channel subbuf num set to %lu", chan.attr.num_subbuf);
	193	break;
	194	case OPT_SWITCH_TIMER:
	195	chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
	196	DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
	197	break;
	198	case OPT_READ_TIMER:
	199	chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
	200	DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
	201	break;
	202	default:
	203	usage(stderr);
	204	ret = CMD_UNDEFINED;
	205	goto end;
	206	}
	207	}
	208
	209	opt_channel_name = (char*) poptGetArg(pc);
	210	if (opt_channel_name == NULL) {
	211	ERR("Missing channel name.\n");
	212	usage(stderr);
	213	ret = CMD_SUCCESS;
	214	goto end;
215	}
216
217	ret = add_channel();
218
219	end:
220	return ret;
221	}