[lttng-tools.git] / lttng / commands / enable_channels.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; only version 2
 * of the License.
 *
 * 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 <inttypes.h>

#include "../cmd.h"
#include "../conf.h"
#include "../utils.h"

static char *opt_channels;
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 lttng_handle *handle;

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 enable-channel NAME[,NAME2,...] [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%s\n",
		DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
	fprintf(ofp, "      --overwrite          Flight recorder mode%s\n",
		DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
	fprintf(ofp, "      --subbuf-size        Subbuffer size in bytes\n");
	fprintf(ofp, "                               (default: %u, kernel default: %u)\n",
		DEFAULT_CHANNEL_SUBBUF_SIZE,
		DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
	fprintf(ofp, "      --num-subbuf         Number of subbufers\n");
	fprintf(ofp, "                               (default: %u, kernel default: %u)\n",
		DEFAULT_CHANNEL_SUBBUF_NUM,
		DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM);
	fprintf(ofp, "      --switch-timer       Switch timer interval in usec (default: %u)\n",
		DEFAULT_CHANNEL_SWITCH_TIMER);
	fprintf(ofp, "      --read-timer         Read timer interval in usec (default: %u)\n",
		DEFAULT_CHANNEL_READ_TIMER);
	fprintf(ofp, "\n");
}

/*
 * Adding channel using the lttng API.
 */
static int enable_channel(char *session_name)
{
	int ret = CMD_SUCCESS;
	char *channel_name;
	struct lttng_domain dom;

	if (opt_kernel) {
		dom.type = LTTNG_DOMAIN_KERNEL;
	} else if (opt_pid != 0) {
		dom.type = LTTNG_DOMAIN_UST_PID;
		dom.attr.pid = opt_pid;
		DBG("PID %d set to lttng handle", opt_pid);
	} else if (opt_userspace && opt_cmd_name == NULL) {
		dom.type = LTTNG_DOMAIN_UST;
	} else if (opt_userspace && opt_cmd_name != NULL) {
		dom.type = LTTNG_DOMAIN_UST_EXEC_NAME;
		strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX);
	} else {
		ERR("Please specify a tracer (--kernel or --userspace)");
		ret = CMD_NOT_IMPLEMENTED;
		goto error;
	}

	handle = lttng_create_handle(session_name, &dom);
	if (handle == NULL) {
		ret = -1;
		goto error;
	}

	/* Strip channel list (format: chan1,chan2,...) */
	channel_name = strtok(opt_channels, ",");
	while (channel_name != NULL) {
		/* Copy channel name and normalize it */
		strncpy(chan.name, channel_name, NAME_MAX);
		chan.name[NAME_MAX - 1] = '\0';

		DBG("Enabling channel %s", channel_name);

		ret = lttng_enable_channel(handle, &chan);
		if (ret < 0) {
			goto error;
		} else {
			MSG("Channel enabled %s for session %s",
					channel_name, session_name);
		}

		/* Next event */
		channel_name = strtok(NULL, ",");
	}

error:
	lttng_destroy_handle(handle);

	return ret;
}

/*
 * Default value for channel configuration.
 */
static void init_channel_config(void)
{
	if (opt_kernel) {
		/* kernel default */
		chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
		chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
		chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;

		chan.attr.subbuf_size = DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE;
		chan.attr.num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
		chan.attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
	} else {
		/* default behavior, used by UST. */
		chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
		chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
		chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;

		chan.attr.subbuf_size = DEFAULT_UST_CHANNEL_SUBBUF_SIZE;
		chan.attr.num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM;
		chan.attr.output = DEFAULT_CHANNEL_OUTPUT;
	}
}

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

	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 %" PRIu64, chan.attr.subbuf_size);
			break;
		case OPT_NUM_SUBBUF:
			chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
			DBG("Channel subbuf num set to %" PRIu64, 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_channels = (char*) poptGetArg(pc);
	if (opt_channels == NULL) {
		ERR("Missing channel name.\n");
		usage(stderr);
		ret = CMD_SUCCESS;
		goto end;
	}

	if (!opt_session_name) {
		session_name = get_session_name();
		if (session_name == NULL) {
			ret = -1;
			goto end;
		}
	} else {
		session_name = opt_session_name;
	}

	ret = enable_channel(session_name);

end:
	return ret;
}
Commit	Line	Data
d36b8583 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
82a3637f DG	6	* as published by the Free Software Foundation; only version 2
82a3637f DG	7	* of the License.
d36b8583 DG	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>
5a0de755	27	#include <inttypes.h>
d36b8583	28
6e2d116c DG	29	#include "../cmd.h"
	30	#include "../conf.h"
	31	#include "../utils.h"
d36b8583 DG	32
	33	static char *opt_channels;
	34	static char *opt_kernel;
7d29a247	35	static char *opt_cmd_name;
5440dc42	36	static char *opt_session_name;
d36b8583 DG	37	static int opt_pid_all;
	38	static int opt_userspace;
	39	static pid_t opt_pid;
7d29a247	40	static struct lttng_channel chan;
d36b8583 DG	41
	42	enum {
	43	OPT_HELP = 1,
7d29a247 DG	44	OPT_DISCARD,
	45	OPT_OVERWRITE,
	46	OPT_SUBBUF_SIZE,
	47	OPT_NUM_SUBBUF,
	48	OPT_SWITCH_TIMER,
	49	OPT_READ_TIMER,
d36b8583 DG	50	OPT_USERSPACE,
	51	};
	52
cd80958d DG	53	static struct lttng_handle *handle;
cd80958d DG	54
d36b8583 DG	55	static struct poptOption long_options[] = {
	56	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	57	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42	58	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
d36b8583	59	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
7d29a247	60	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
d36b8583 DG	61	{"all", 0, POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
d36b8583 DG	62	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
7d29a247 DG	63	{"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
7d29a247 DG	64	{"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
1b579521 DG	65	{"subbuf-size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
	66	{"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
	67	{"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
	68	{"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
d36b8583 DG	69	{0, 0, 0, 0, 0, 0, 0}
	70	};
	71
	72	/*
	73	* usage
	74	*/
	75	static void usage(FILE *ofp)
	76	{
7d29a247	77	fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n");
d36b8583	78	fprintf(ofp, "\n");
7d29a247	79	fprintf(ofp, " -h, --help Show this help\n");
5440dc42	80	fprintf(ofp, " -s, --session Apply on session name\n");
7d29a247 DG	81	fprintf(ofp, " -k, --kernel Apply on the kernel tracer\n");
	82	fprintf(ofp, " -u, --userspace [CMD] Apply on the user-space tracer\n");
	83	fprintf(ofp, " --all If -u, apply on all traceable apps\n");
	84	fprintf(ofp, " -p, --pid PID If -u, apply on a specific PID\n");
	85	fprintf(ofp, "\n");
	86	fprintf(ofp, "Channel options:\n");
cabd9892 MD	87	fprintf(ofp, " --discard Discard event when buffers are full%s\n",
	88	DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
	89	fprintf(ofp, " --overwrite Flight recorder mode%s\n",
	90	DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
	91	fprintf(ofp, " --subbuf-size Subbuffer size in bytes\n");
	92	fprintf(ofp, " (default: %u, kernel default: %u)\n",
	93	DEFAULT_CHANNEL_SUBBUF_SIZE,
	94	DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
	95	fprintf(ofp, " --num-subbuf Number of subbufers\n");
	96	fprintf(ofp, " (default: %u, kernel default: %u)\n",
	97	DEFAULT_CHANNEL_SUBBUF_NUM,
	98	DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM);
	99	fprintf(ofp, " --switch-timer Switch timer interval in usec (default: %u)\n",
	100	DEFAULT_CHANNEL_SWITCH_TIMER);
	101	fprintf(ofp, " --read-timer Read timer interval in usec (default: %u)\n",
	102	DEFAULT_CHANNEL_READ_TIMER);
d36b8583 DG	103	fprintf(ofp, "\n");
	104	}
	105
	106	/*
0fdd1e2c	107	* Adding channel using the lttng API.
d36b8583	108	*/
cd80958d	109	static int enable_channel(char *session_name)
d36b8583 DG	110	{
	111	int ret = CMD_SUCCESS;
	112	char *channel_name;
7d29a247	113	struct lttng_domain dom;
d36b8583	114
7d29a247 DG	115	if (opt_kernel) {
7d29a247 DG	116	dom.type = LTTNG_DOMAIN_KERNEL;
0fdd1e2c DG	117	} else if (opt_pid != 0) {
	118	dom.type = LTTNG_DOMAIN_UST_PID;
	119	dom.attr.pid = opt_pid;
	120	DBG("PID %d set to lttng handle", opt_pid);
f6a9efaa DG	121	} else if (opt_userspace && opt_cmd_name == NULL) {
	122	dom.type = LTTNG_DOMAIN_UST;
	123	} else if (opt_userspace && opt_cmd_name != NULL) {
	124	dom.type = LTTNG_DOMAIN_UST_EXEC_NAME;
	125	strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX);
0fdd1e2c	126	} else {
a881057e	127	ERR("Please specify a tracer (--kernel or --userspace)");
0fdd1e2c DG	128	ret = CMD_NOT_IMPLEMENTED;
0fdd1e2c DG	129	goto error;
7d29a247 DG	130	}
7d29a247 DG	131
cd80958d DG	132	handle = lttng_create_handle(session_name, &dom);
	133	if (handle == NULL) {
	134	ret = -1;
	135	goto error;
	136	}
	137
0fdd1e2c	138	/* Strip channel list (format: chan1,chan2,...) */
d36b8583 DG	139	channel_name = strtok(opt_channels, ",");
d36b8583 DG	140	while (channel_name != NULL) {
0fdd1e2c DG	141	/* Copy channel name and normalize it */
	142	strncpy(chan.name, channel_name, NAME_MAX);
	143	chan.name[NAME_MAX - 1] = '\0';
	144
	145	DBG("Enabling channel %s", channel_name);
	146
	147	ret = lttng_enable_channel(handle, &chan);
	148	if (ret < 0) {
d36b8583 DG	149	goto error;
d36b8583 DG	150	} else {
0fdd1e2c DG	151	MSG("Channel enabled %s for session %s",
0fdd1e2c DG	152	channel_name, session_name);
d36b8583 DG	153	}
	154
	155	/* Next event */
	156	channel_name = strtok(NULL, ",");
	157	}
	158
	159	error:
cd80958d DG	160	lttng_destroy_handle(handle);
cd80958d DG	161
d36b8583 DG	162	return ret;
	163	}
	164
	165	/*
0fdd1e2c	166	* Default value for channel configuration.
7d29a247 DG	167	*/
	168	static void init_channel_config(void)
	169	{
b389abbe MD	170	if (opt_kernel) {
	171	/* kernel default */
	172	chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
	173	chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
	174	chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
	175
	176	chan.attr.subbuf_size = DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE;
	177	chan.attr.num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
	178	chan.attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
	179	} else {
	180	/* default behavior, used by UST. */
	181	chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
	182	chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
	183	chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
	184
0b0dd29a DG	185	chan.attr.subbuf_size = DEFAULT_UST_CHANNEL_SUBBUF_SIZE;
0b0dd29a DG	186	chan.attr.num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM;
b389abbe MD	187	chan.attr.output = DEFAULT_CHANNEL_OUTPUT;
b389abbe MD	188	}
7d29a247 DG	189	}
	190
	191	/*
0fdd1e2c	192	* Add channel to trace session
d36b8583 DG	193	*/
	194	int cmd_enable_channels(int argc, const char **argv)
	195	{
	196	int opt, ret;
	197	static poptContext pc;
cd80958d	198	char *session_name = NULL;
d36b8583	199
7d29a247 DG	200	init_channel_config();
7d29a247 DG	201
d36b8583 DG	202	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	203	poptReadDefaultConfig(pc, 0);
	204
	205	while ((opt = poptGetNextOpt(pc)) != -1) {
	206	switch (opt) {
	207	case OPT_HELP:
	208	usage(stderr);
	209	ret = CMD_SUCCESS;
	210	goto end;
	211	case OPT_USERSPACE:
	212	opt_userspace = 1;
7d29a247 DG	213	opt_cmd_name = poptGetOptArg(pc);
	214	break;
	215	case OPT_DISCARD:
	216	chan.attr.overwrite = 0;
	217	DBG("Channel set to discard");
	218	break;
	219	case OPT_OVERWRITE:
	220	chan.attr.overwrite = 1;
	221	DBG("Channel set to overwrite");
	222	break;
	223	case OPT_SUBBUF_SIZE:
	224	chan.attr.subbuf_size = atol(poptGetOptArg(pc));
5a0de755	225	DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
7d29a247 DG	226	break;
	227	case OPT_NUM_SUBBUF:
	228	chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
5a0de755	229	DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
7d29a247 DG	230	break;
	231	case OPT_SWITCH_TIMER:
	232	chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
	233	DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
	234	break;
	235	case OPT_READ_TIMER:
	236	chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
	237	DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
d36b8583 DG	238	break;
	239	default:
	240	usage(stderr);
	241	ret = CMD_UNDEFINED;
	242	goto end;
	243	}
	244	}
	245
	246	opt_channels = (char*) poptGetArg(pc);
	247	if (opt_channels == NULL) {
7d29a247	248	ERR("Missing channel name.\n");
d36b8583 DG	249	usage(stderr);
	250	ret = CMD_SUCCESS;
	251	goto end;
	252	}
	253
cd80958d DG	254	if (!opt_session_name) {
	255	session_name = get_session_name();
	256	if (session_name == NULL) {
	257	ret = -1;
	258	goto end;
	259	}
	260	} else {
	261	session_name = opt_session_name;
	262	}
	263
	264	ret = enable_channel(session_name);
d36b8583 DG	265
	266	end:
	267	return ret;
	268	}