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