[lttng-tools.git] / src / bin / 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, 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.
 */

#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 <assert.h>
#include <ctype.h>

#include "../command.h"
#include "../utils.h"

#include <src/common/sessiond-comm/sessiond-comm.h>
#include <src/common/utils.h>

static char *opt_channels;
static int opt_kernel;
static char *opt_session_name;
static int opt_userspace;
static struct lttng_channel chan;
static char *opt_output;
static int opt_buffer_uid;
static int opt_buffer_pid;
static int opt_buffer_global;

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

static struct lttng_handle *handle;

const char *output_mmap = "mmap";
const char *output_splice = "splice";

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_NONE, 0, OPT_USERSPACE, 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_STRING, 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},
	{"list-options",   0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{"output",         0,   POPT_ARG_STRING, &opt_output, 0, 0, 0},
	{"buffers-uid",    0,	POPT_ARG_VAL, &opt_buffer_uid, 1, 0, 0},
	{"buffers-pid",    0,	POPT_ARG_VAL, &opt_buffer_pid, 1, 0, 0},
	{"buffers-global", 0,	POPT_ARG_VAL, &opt_buffer_global, 1, 0, 0},
	{"tracefile-size", 'C',   POPT_ARG_INT, 0, OPT_TRACEFILE_SIZE, 0, 0},
	{"tracefile-count", 'W',   POPT_ARG_INT, 0, OPT_TRACEFILE_COUNT, 0, 0},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Options:\n");
	fprintf(ofp, "  -h, --help               Show this help\n");
	fprintf(ofp, "      --list-options       Simple listing of options\n");
	fprintf(ofp, "  -s, --session NAME       Apply to session name\n");
	fprintf(ofp, "  -k, --kernel             Apply to the kernel tracer\n");
	fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\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 SIZE   Subbuffer size in bytes {+k,+M,+G}\n");
	fprintf(ofp, "                               (default: %zu, kernel default: %zu)\n",
		default_get_channel_subbuf_size(),
		default_get_kernel_channel_subbuf_size());
	fprintf(ofp, "                               Rounded up to the next power of 2.\n");
	fprintf(ofp, "      --num-subbuf NUM     Number of subbufers\n");
	fprintf(ofp, "                               (default: %u)\n",
		DEFAULT_CHANNEL_SUBBUF_NUM);
	fprintf(ofp, "                               Rounded up to the next power of 2.\n");
	fprintf(ofp, "      --switch-timer USEC  Switch timer interval in usec (default: %u)\n",
		DEFAULT_CHANNEL_SWITCH_TIMER);
	fprintf(ofp, "      --read-timer USEC    Read timer interval in usec (UST default: %u, kernel default: %u)\n",
		DEFAULT_UST_CHANNEL_READ_TIMER, DEFAULT_KERNEL_CHANNEL_READ_TIMER);
	fprintf(ofp, "      --output TYPE        Channel output type (Values: %s, %s)\n",
			output_mmap, output_splice);
	fprintf(ofp, "      --buffers-uid        Use per UID buffer (-u only)\n");
	fprintf(ofp, "      --buffers-pid        Use per PID buffer (-u only)\n");
	fprintf(ofp, "      --buffers-global     Use shared buffer for the whole system (-k only)\n");
	fprintf(ofp, "  -C, --tracefile-size SIZE\n");
	fprintf(ofp, "                           Maximum size of each tracefile within a stream (in bytes).\n");
	fprintf(ofp, "  -W, --tracefile-count COUNT\n");
	fprintf(ofp, "                           Used in conjunction with -C option, this will limit the number\n");
	fprintf(ofp, "                           of files created to the specified count.\n");
	fprintf(ofp, "\n");
}

/*
 * Set default attributes depending on those already defined from the command
 * line.
 */
static void set_default_attr(struct lttng_domain *dom)
{
	struct lttng_channel_attr default_attr;

	/* Set attributes */
	lttng_channel_set_default_attr(dom, &default_attr);

	if (chan.attr.overwrite == -1) {
		chan.attr.overwrite = default_attr.overwrite;
	}
	if (chan.attr.subbuf_size == -1) {
		chan.attr.subbuf_size = default_attr.subbuf_size;
	}
	if (chan.attr.num_subbuf == -1) {
		chan.attr.num_subbuf = default_attr.num_subbuf;
	}
	if (chan.attr.switch_timer_interval == -1) {
		chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
	}
	if (chan.attr.read_timer_interval == -1) {
		chan.attr.read_timer_interval = default_attr.read_timer_interval;
	}
	if (chan.attr.output == -1) {
		chan.attr.output = default_attr.output;
	}
	if (chan.attr.tracefile_count == -1) {
		chan.attr.tracefile_count = default_attr.tracefile_count;
	}
	if (chan.attr.tracefile_size == -1) {
		chan.attr.tracefile_size = default_attr.tracefile_size;
	}
}

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

	memset(&dom, 0, sizeof(dom));

	/* Create lttng domain */
	if (opt_kernel) {
		dom.type = LTTNG_DOMAIN_KERNEL;
		dom.buf_type = LTTNG_BUFFER_GLOBAL;
		if (opt_buffer_uid || opt_buffer_pid) {
			ERR("Buffer type not supported for domain -k");
			ret = CMD_ERROR;
			goto error;
		}
	} else if (opt_userspace) {
		dom.type = LTTNG_DOMAIN_UST;
		if (opt_buffer_uid) {
			dom.buf_type = LTTNG_BUFFER_PER_UID;
		} else {
			if (opt_buffer_global) {
				ERR("Buffer type not supported for domain -u");
				ret = CMD_ERROR;
				goto error;
			}
			dom.buf_type = LTTNG_BUFFER_PER_PID;
		}
	} else {
		ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
		ret = CMD_ERROR;
		goto error;
	}

	set_default_attr(&dom);

	if ((chan.attr.tracefile_size > 0) &&
			(chan.attr.tracefile_size < chan.attr.subbuf_size)) {
		ERR("Tracefile_size must be greater than or equal to subbuf_size "
				"(%" PRIu64 " < %" PRIu64 ")",
				chan.attr.tracefile_size, chan.attr.subbuf_size);
		ret = CMD_ERROR;
		goto error;
	}

	/* Setting channel output */
	if (opt_output) {
		if (!strncmp(output_mmap, opt_output, strlen(output_mmap))) {
			chan.attr.output = LTTNG_EVENT_MMAP;
		} else if (!strncmp(output_splice, opt_output, strlen(output_splice))) {
			chan.attr.output = LTTNG_EVENT_SPLICE;
		} else {
			ERR("Unknown output type %s. Possible values are: %s, %s\n",
					opt_output, output_mmap, output_splice);
			usage(stderr);
			ret = CMD_ERROR;
			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) {
			switch (-ret) {
			case LTTNG_ERR_KERN_CHAN_EXIST:
			case LTTNG_ERR_UST_CHAN_EXIST:
				WARN("Channel %s: %s (session %s)", channel_name,
						lttng_strerror(ret), session_name);
				goto error;
			default:
				ERR("Channel %s: %s (session %s)", channel_name,
						lttng_strerror(ret), session_name);
				break;
			}
			warn = 1;
		} else {
			MSG("%s channel %s enabled for session %s",
					opt_kernel ? "Kernel" : "UST", channel_name,
					session_name);
		}

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

	ret = CMD_SUCCESS;

error:
	if (warn) {
		ret = CMD_WARNING;
	}

	lttng_destroy_handle(handle);

	return ret;
}

/*
 * Default value for channel configuration.
 */
static void init_channel_config(void)
{
	/*
	 * Put -1 everywhere so we can identify those set by the command line and
	 * those needed to be set by the default values.
	 */
	memset(&chan.attr, -1, sizeof(chan.attr));
}

/*
 * Add channel to trace session
 */
int cmd_enable_channels(int argc, const char **argv)
{
	int opt, ret = CMD_SUCCESS;
	static poptContext pc;
	char *session_name = NULL;
	char *opt_arg = 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(stdout);
			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:
		{
			uint64_t rounded_size;
			int order;

			/* Parse the size */
			opt_arg = poptGetOptArg(pc);
			if (utils_parse_size_suffix(opt_arg, &chan.attr.subbuf_size) < 0 || !chan.attr.subbuf_size) {
				ERR("Wrong value in --subbuf-size parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}

			order = get_count_order_u64(chan.attr.subbuf_size);
			assert(order >= 0);
			rounded_size = 1ULL << order;
			if (rounded_size != chan.attr.subbuf_size) {
				WARN("The subbuf size (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
						chan.attr.subbuf_size, rounded_size);
				chan.attr.subbuf_size = rounded_size;
			}

			/* Should now be power of 2 */
			assert(!((chan.attr.subbuf_size - 1) & chan.attr.subbuf_size));

			DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
			break;
		}
		case OPT_NUM_SUBBUF:
		{
			uint64_t rounded_size;
			int order;

			errno = 0;
			opt_arg = poptGetOptArg(pc);
			chan.attr.num_subbuf = strtoull(opt_arg, NULL, 0);
			if (errno != 0 || !chan.attr.num_subbuf || !isdigit(opt_arg[0])) {
				ERR("Wrong value in --num-subbuf parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}

			order = get_count_order_u64(chan.attr.num_subbuf);
			assert(order >= 0);
			rounded_size = 1ULL << order;
			if (rounded_size != chan.attr.num_subbuf) {
				WARN("The number of subbuffers (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
						chan.attr.num_subbuf, rounded_size);
				chan.attr.num_subbuf = rounded_size;
			}

			/* Should now be power of 2 */
			assert(!((chan.attr.num_subbuf - 1) & chan.attr.num_subbuf));

			DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
			break;
		}
		case OPT_SWITCH_TIMER:
		{
			unsigned long v;

			errno = 0;
			opt_arg = poptGetOptArg(pc);
			v = strtoul(opt_arg, NULL, 0);
			if (errno != 0 || !isdigit(opt_arg[0])) {
				ERR("Wrong value in --switch-timer parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			if (v != (uint32_t) v) {
				ERR("32-bit overflow in --switch-timer parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			chan.attr.switch_timer_interval = (uint32_t) v;
			DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
			break;
		}
		case OPT_READ_TIMER:
		{
			unsigned long v;

			errno = 0;
			opt_arg = poptGetOptArg(pc);
			v = strtoul(opt_arg, NULL, 0);
			if (errno != 0 || !isdigit(opt_arg[0])) {
				ERR("Wrong value in --read-timer parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			if (v != (uint32_t) v) {
				ERR("32-bit overflow in --read-timer parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			chan.attr.read_timer_interval = (uint32_t) v;
			DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
			break;
		}
		case OPT_USERSPACE:
			opt_userspace = 1;
			break;
		case OPT_TRACEFILE_SIZE:
			opt_arg = poptGetOptArg(pc);
			if (utils_parse_size_suffix(opt_arg, &chan.attr.tracefile_size) < 0) {
				ERR("Wrong value in --tracefile-size parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			DBG("Maximum tracefile size set to %" PRIu64,
					chan.attr.tracefile_size);
			break;
		case OPT_TRACEFILE_COUNT:
		{
			unsigned long v;

			errno = 0;
			opt_arg = poptGetOptArg(pc);
			v = strtoul(opt_arg, NULL, 0);
			if (errno != 0 || !isdigit(opt_arg[0])) {
				ERR("Wrong value in --tracefile-count parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			if (v != (uint32_t) v) {
				ERR("32-bit overflow in --tracefile-count parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			chan.attr.tracefile_count = (uint32_t) v;
			DBG("Maximum tracefile count set to %" PRIu64,
					chan.attr.tracefile_count);
			break;
		}
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			goto end;
		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_ERROR;
		goto end;
	}

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

	ret = enable_channel(session_name);

end:
	if (!opt_session_name && session_name) {
		free(session_name);
	}
	poptFreeContext(pc);
	return ret;
}
Commit	Line	Data
d36b8583 DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
d14d33bf AM	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.
d36b8583 DG	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	*
d14d33bf AM	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.
d36b8583 DG	16	*/
	17
	18	#define _GNU_SOURCE
	19	#include <popt.h>
	20	#include <stdio.h>
	21	#include <stdlib.h>
	22	#include <string.h>
	23	#include <sys/stat.h>
	24	#include <sys/types.h>
	25	#include <unistd.h>
5a0de755	26	#include <inttypes.h>
1cb514ce MD	27	#include <assert.h>
1cb514ce MD	28	#include <ctype.h>
d36b8583	29
c399183f	30	#include "../command.h"
1cb514ce	31	#include "../utils.h"
d36b8583	32
42224349	33	#include <src/common/sessiond-comm/sessiond-comm.h>
70d0b120	34	#include <src/common/utils.h>
42224349	35
d36b8583	36	static char *opt_channels;
5edd7e09	37	static int opt_kernel;
5440dc42	38	static char *opt_session_name;
d36b8583	39	static int opt_userspace;
d78d6610	40	static struct lttng_channel chan;
a79d84dd	41	static char *opt_output;
7972aab2 DG	42	static int opt_buffer_uid;
	43	static int opt_buffer_pid;
	44	static int opt_buffer_global;
d36b8583 DG	45
	46	enum {
	47	OPT_HELP = 1,
7d29a247 DG	48	OPT_DISCARD,
	49	OPT_OVERWRITE,
	50	OPT_SUBBUF_SIZE,
	51	OPT_NUM_SUBBUF,
	52	OPT_SWITCH_TIMER,
	53	OPT_READ_TIMER,
d36b8583	54	OPT_USERSPACE,
679b4943	55	OPT_LIST_OPTIONS,
1624d5b7 JD	56	OPT_TRACEFILE_SIZE,
1624d5b7 JD	57	OPT_TRACEFILE_COUNT,
d36b8583 DG	58	};
d36b8583 DG	59
cd80958d DG	60	static struct lttng_handle *handle;
cd80958d DG	61
a79d84dd DG	62	const char *output_mmap = "mmap";
	63	const char *output_splice = "splice";
	64
d36b8583 DG	65	static struct poptOption long_options[] = {
	66	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	67	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42	68	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
d36b8583	69	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610	70	{"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
7d29a247 DG	71	{"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
7d29a247 DG	72	{"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
70d0b120	73	{"subbuf-size", 0, POPT_ARG_STRING, 0, OPT_SUBBUF_SIZE, 0, 0},
1b579521 DG	74	{"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
	75	{"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
	76	{"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
679b4943	77	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
a79d84dd	78	{"output", 0, POPT_ARG_STRING, &opt_output, 0, 0, 0},
7972aab2 DG	79	{"buffers-uid", 0, POPT_ARG_VAL, &opt_buffer_uid, 1, 0, 0},
	80	{"buffers-pid", 0, POPT_ARG_VAL, &opt_buffer_pid, 1, 0, 0},
	81	{"buffers-global", 0, POPT_ARG_VAL, &opt_buffer_global, 1, 0, 0},
1624d5b7 JD	82	{"tracefile-size", 'C', POPT_ARG_INT, 0, OPT_TRACEFILE_SIZE, 0, 0},
1624d5b7 JD	83	{"tracefile-count", 'W', POPT_ARG_INT, 0, OPT_TRACEFILE_COUNT, 0, 0},
d36b8583 DG	84	{0, 0, 0, 0, 0, 0, 0}
	85	};
	86
	87	/*
	88	* usage
	89	*/
	90	static void usage(FILE *ofp)
	91	{
32a6298d	92	fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [-u\|-k] [OPTIONS]\n");
d36b8583	93	fprintf(ofp, "\n");
32a6298d	94	fprintf(ofp, "Options:\n");
7d29a247	95	fprintf(ofp, " -h, --help Show this help\n");
679b4943	96	fprintf(ofp, " --list-options Simple listing of options\n");
32a6298d	97	fprintf(ofp, " -s, --session NAME Apply to session name\n");
27221701	98	fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
27221701	99	fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
7d29a247 DG	100	fprintf(ofp, "\n");
7d29a247 DG	101	fprintf(ofp, "Channel options:\n");
cabd9892 MD	102	fprintf(ofp, " --discard Discard event when buffers are full%s\n",
	103	DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
	104	fprintf(ofp, " --overwrite Flight recorder mode%s\n",
	105	DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
70d0b120	106	fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes {+k,+M,+G}\n");
3e230f92 SM	107	fprintf(ofp, " (default: %zu, kernel default: %zu)\n",
	108	default_get_channel_subbuf_size(),
	109	default_get_kernel_channel_subbuf_size());
1cb514ce	110	fprintf(ofp, " Rounded up to the next power of 2.\n");
cc62c0c0	111	fprintf(ofp, " --num-subbuf NUM Number of subbufers\n");
9f778c9a MD	112	fprintf(ofp, " (default: %u)\n",
9f778c9a MD	113	DEFAULT_CHANNEL_SUBBUF_NUM);
1cb514ce	114	fprintf(ofp, " Rounded up to the next power of 2.\n");
cc62c0c0	115	fprintf(ofp, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
cabd9892	116	DEFAULT_CHANNEL_SWITCH_TIMER);
db77f3a3 DG	117	fprintf(ofp, " --read-timer USEC Read timer interval in usec (UST default: %u, kernel default: %u)\n",
db77f3a3 DG	118	DEFAULT_UST_CHANNEL_READ_TIMER, DEFAULT_KERNEL_CHANNEL_READ_TIMER);
a79d84dd DG	119	fprintf(ofp, " --output TYPE Channel output type (Values: %s, %s)\n",
a79d84dd DG	120	output_mmap, output_splice);
7972aab2 DG	121	fprintf(ofp, " --buffers-uid Use per UID buffer (-u only)\n");
	122	fprintf(ofp, " --buffers-pid Use per PID buffer (-u only)\n");
	123	fprintf(ofp, " --buffers-global Use shared buffer for the whole system (-k only)\n");
1624d5b7	124	fprintf(ofp, " -C, --tracefile-size SIZE\n");
e132a0d4	125	fprintf(ofp, " Maximum size of each tracefile within a stream (in bytes).\n");
1624d5b7 JD	126	fprintf(ofp, " -W, --tracefile-count COUNT\n");
	127	fprintf(ofp, " Used in conjunction with -C option, this will limit the number\n");
	128	fprintf(ofp, " of files created to the specified count.\n");
d36b8583 DG	129	fprintf(ofp, "\n");
	130	}
	131
5edd7e09 DG	132	/*
	133	* Set default attributes depending on those already defined from the command
	134	* line.
	135	*/
	136	static void set_default_attr(struct lttng_domain *dom)
	137	{
	138	struct lttng_channel_attr default_attr;
	139
	140	/* Set attributes */
	141	lttng_channel_set_default_attr(dom, &default_attr);
	142
	143	if (chan.attr.overwrite == -1) {
	144	chan.attr.overwrite = default_attr.overwrite;
	145	}
	146	if (chan.attr.subbuf_size == -1) {
	147	chan.attr.subbuf_size = default_attr.subbuf_size;
	148	}
	149	if (chan.attr.num_subbuf == -1) {
	150	chan.attr.num_subbuf = default_attr.num_subbuf;
	151	}
	152	if (chan.attr.switch_timer_interval == -1) {
	153	chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
	154	}
	155	if (chan.attr.read_timer_interval == -1) {
	156	chan.attr.read_timer_interval = default_attr.read_timer_interval;
	157	}
	158	if (chan.attr.output == -1) {
	159	chan.attr.output = default_attr.output;
	160	}
1624d5b7 JD	161	if (chan.attr.tracefile_count == -1) {
	162	chan.attr.tracefile_count = default_attr.tracefile_count;
	163	}
	164	if (chan.attr.tracefile_size == -1) {
	165	chan.attr.tracefile_size = default_attr.tracefile_size;
	166	}
5edd7e09 DG	167	}
5edd7e09 DG	168
d36b8583	169	/*
0fdd1e2c	170	* Adding channel using the lttng API.
d36b8583	171	*/
cd80958d	172	static int enable_channel(char *session_name)
d36b8583	173	{
ae856491	174	int ret = CMD_SUCCESS, warn = 0;
d36b8583	175	char *channel_name;
7d29a247	176	struct lttng_domain dom;
d36b8583	177
441c16a7 MD	178	memset(&dom, 0, sizeof(dom));
441c16a7 MD	179
d78d6610	180	/* Create lttng domain */
7d29a247 DG	181	if (opt_kernel) {
7d29a247 DG	182	dom.type = LTTNG_DOMAIN_KERNEL;
7972aab2	183	dom.buf_type = LTTNG_BUFFER_GLOBAL;
88c5f0d8 DG	184	if (opt_buffer_uid \|\| opt_buffer_pid) {
	185	ERR("Buffer type not supported for domain -k");
	186	ret = CMD_ERROR;
	187	goto error;
	188	}
d78d6610	189	} else if (opt_userspace) {
f6a9efaa	190	dom.type = LTTNG_DOMAIN_UST;
7972aab2 DG	191	if (opt_buffer_uid) {
	192	dom.buf_type = LTTNG_BUFFER_PER_UID;
	193	} else {
88c5f0d8 DG	194	if (opt_buffer_global) {
	195	ERR("Buffer type not supported for domain -u");
	196	ret = CMD_ERROR;
	197	goto error;
	198	}
7972aab2 DG	199	dom.buf_type = LTTNG_BUFFER_PER_PID;
7972aab2 DG	200	}
0fdd1e2c	201	} else {
e14f64a8	202	ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
d16c1a4c	203	ret = CMD_ERROR;
0fdd1e2c	204	goto error;
7d29a247 DG	205	}
7d29a247 DG	206
5edd7e09 DG	207	set_default_attr(&dom);
5edd7e09 DG	208
1624d5b7 JD	209	if ((chan.attr.tracefile_size > 0) &&
	210	(chan.attr.tracefile_size < chan.attr.subbuf_size)) {
	211	ERR("Tracefile_size must be greater than or equal to subbuf_size "
	212	"(%" PRIu64 " < %" PRIu64 ")",
	213	chan.attr.tracefile_size, chan.attr.subbuf_size);
	214	ret = CMD_ERROR;
	215	goto error;
	216	}
	217
a79d84dd DG	218	/* Setting channel output */
	219	if (opt_output) {
	220	if (!strncmp(output_mmap, opt_output, strlen(output_mmap))) {
	221	chan.attr.output = LTTNG_EVENT_MMAP;
	222	} else if (!strncmp(output_splice, opt_output, strlen(output_splice))) {
	223	chan.attr.output = LTTNG_EVENT_SPLICE;
	224	} else {
	225	ERR("Unknown output type %s. Possible values are: %s, %s\n",
	226	opt_output, output_mmap, output_splice);
	227	usage(stderr);
	228	ret = CMD_ERROR;
	229	goto error;
	230	}
	231	}
	232
cd80958d DG	233	handle = lttng_create_handle(session_name, &dom);
	234	if (handle == NULL) {
	235	ret = -1;
	236	goto error;
	237	}
	238
0fdd1e2c	239	/* Strip channel list (format: chan1,chan2,...) */
d36b8583 DG	240	channel_name = strtok(opt_channels, ",");
d36b8583 DG	241	while (channel_name != NULL) {
0fdd1e2c DG	242	/* Copy channel name and normalize it */
	243	strncpy(chan.name, channel_name, NAME_MAX);
	244	chan.name[NAME_MAX - 1] = '\0';
	245
	246	DBG("Enabling channel %s", channel_name);
	247
	248	ret = lttng_enable_channel(handle, &chan);
	249	if (ret < 0) {
42224349	250	switch (-ret) {
f73fabfd DG	251	case LTTNG_ERR_KERN_CHAN_EXIST:
f73fabfd DG	252	case LTTNG_ERR_UST_CHAN_EXIST:
88c5f0d8	253	WARN("Channel %s: %s (session %s)", channel_name,
42224349 DG	254	lttng_strerror(ret), session_name);
	255	goto error;
	256	default:
	257	ERR("Channel %s: %s (session %s)", channel_name,
	258	lttng_strerror(ret), session_name);
	259	break;
	260	}
ae856491	261	warn = 1;
d36b8583	262	} else {
7885e399 DG	263	MSG("%s channel %s enabled for session %s",
	264	opt_kernel ? "Kernel" : "UST", channel_name,
	265	session_name);
d36b8583 DG	266	}
	267
	268	/* Next event */
	269	channel_name = strtok(NULL, ",");
	270	}
	271
ae856491 DG	272	ret = CMD_SUCCESS;
ae856491 DG	273
d36b8583	274	error:
ae856491 DG	275	if (warn) {
	276	ret = CMD_WARNING;
	277	}
	278
cd80958d DG	279	lttng_destroy_handle(handle);
cd80958d DG	280
d36b8583 DG	281	return ret;
	282	}
	283
	284	/*
0fdd1e2c	285	* Default value for channel configuration.
7d29a247 DG	286	*/
	287	static void init_channel_config(void)
	288	{
5edd7e09 DG	289	/*
	290	* Put -1 everywhere so we can identify those set by the command line and
	291	* those needed to be set by the default values.
	292	*/
	293	memset(&chan.attr, -1, sizeof(chan.attr));
7d29a247 DG	294	}
	295
	296	/*
0fdd1e2c	297	* Add channel to trace session
d36b8583 DG	298	*/
	299	int cmd_enable_channels(int argc, const char **argv)
	300	{
ca1c3607	301	int opt, ret = CMD_SUCCESS;
d36b8583	302	static poptContext pc;
cd80958d	303	char *session_name = NULL;
70d0b120	304	char *opt_arg = NULL;
d36b8583	305
7d29a247 DG	306	init_channel_config();
7d29a247 DG	307
d36b8583 DG	308	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	309	poptReadDefaultConfig(pc, 0);
	310
	311	while ((opt = poptGetNextOpt(pc)) != -1) {
	312	switch (opt) {
	313	case OPT_HELP:
ca1c3607	314	usage(stdout);
d36b8583	315	goto end;
7d29a247 DG	316	case OPT_DISCARD:
	317	chan.attr.overwrite = 0;
	318	DBG("Channel set to discard");
	319	break;
	320	case OPT_OVERWRITE:
	321	chan.attr.overwrite = 1;
	322	DBG("Channel set to overwrite");
	323	break;
	324	case OPT_SUBBUF_SIZE:
1cb514ce MD	325	{
	326	uint64_t rounded_size;
	327	int order;
	328
70d0b120 SM	329	/* Parse the size */
70d0b120 SM	330	opt_arg = poptGetOptArg(pc);
1cb514ce MD	331	if (utils_parse_size_suffix(opt_arg, &chan.attr.subbuf_size) < 0 \|\| !chan.attr.subbuf_size) {
1cb514ce MD	332	ERR("Wrong value in --subbuf-size parameter: %s", opt_arg);
70d0b120 SM	333	ret = CMD_ERROR;
	334	goto end;
	335	}
	336
1cb514ce MD	337	order = get_count_order_u64(chan.attr.subbuf_size);
	338	assert(order >= 0);
	339	rounded_size = 1ULL << order;
	340	if (rounded_size != chan.attr.subbuf_size) {
	341	WARN("The subbuf size (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
	342	chan.attr.subbuf_size, rounded_size);
	343	chan.attr.subbuf_size = rounded_size;
70d0b120 SM	344	}
70d0b120 SM	345
1cb514ce MD	346	/* Should now be power of 2 */
	347	assert(!((chan.attr.subbuf_size - 1) & chan.attr.subbuf_size));
	348
5a0de755	349	DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
7d29a247	350	break;
1cb514ce	351	}
7d29a247	352	case OPT_NUM_SUBBUF:
1cb514ce MD	353	{
	354	uint64_t rounded_size;
	355	int order;
	356
16068db5	357	errno = 0;
1cb514ce MD	358	opt_arg = poptGetOptArg(pc);
	359	chan.attr.num_subbuf = strtoull(opt_arg, NULL, 0);
	360	if (errno != 0 \|\| !chan.attr.num_subbuf \|\| !isdigit(opt_arg[0])) {
	361	ERR("Wrong value in --num-subbuf parameter: %s", opt_arg);
16068db5 MD	362	ret = CMD_ERROR;
	363	goto end;
	364	}
	365
1cb514ce MD	366	order = get_count_order_u64(chan.attr.num_subbuf);
	367	assert(order >= 0);
	368	rounded_size = 1ULL << order;
	369	if (rounded_size != chan.attr.num_subbuf) {
	370	WARN("The number of subbuffers (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
	371	chan.attr.num_subbuf, rounded_size);
	372	chan.attr.num_subbuf = rounded_size;
	373	}
	374
	375	/* Should now be power of 2 */
	376	assert(!((chan.attr.num_subbuf - 1) & chan.attr.num_subbuf));
	377
5a0de755	378	DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
7d29a247	379	break;
1cb514ce	380	}
7d29a247	381	case OPT_SWITCH_TIMER:
16068db5 MD	382	{
	383	unsigned long v;
	384
	385	errno = 0;
1cb514ce MD	386	opt_arg = poptGetOptArg(pc);
	387	v = strtoul(opt_arg, NULL, 0);
	388	if (errno != 0 \|\| !isdigit(opt_arg[0])) {
	389	ERR("Wrong value in --switch-timer parameter: %s", opt_arg);
16068db5 MD	390	ret = CMD_ERROR;
	391	goto end;
	392	}
	393	if (v != (uint32_t) v) {
	394	ERR("32-bit overflow in --switch-timer parameter: %s", opt_arg);
	395	ret = CMD_ERROR;
	396	goto end;
	397	}
	398	chan.attr.switch_timer_interval = (uint32_t) v;
7d29a247 DG	399	DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
7d29a247 DG	400	break;
16068db5	401	}
7d29a247	402	case OPT_READ_TIMER:
16068db5 MD	403	{
	404	unsigned long v;
	405
	406	errno = 0;
1cb514ce MD	407	opt_arg = poptGetOptArg(pc);
	408	v = strtoul(opt_arg, NULL, 0);
	409	if (errno != 0 \|\| !isdigit(opt_arg[0])) {
	410	ERR("Wrong value in --read-timer parameter: %s", opt_arg);
16068db5 MD	411	ret = CMD_ERROR;
	412	goto end;
	413	}
	414	if (v != (uint32_t) v) {
	415	ERR("32-bit overflow in --read-timer parameter: %s", opt_arg);
	416	ret = CMD_ERROR;
	417	goto end;
	418	}
	419	chan.attr.read_timer_interval = (uint32_t) v;
7d29a247	420	DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
d36b8583	421	break;
16068db5	422	}
eeac7d46 MD	423	case OPT_USERSPACE:
eeac7d46 MD	424	opt_userspace = 1;
eeac7d46	425	break;
1624d5b7	426	case OPT_TRACEFILE_SIZE:
1cb514ce	427	opt_arg = poptGetOptArg(pc);
16068db5	428	if (utils_parse_size_suffix(opt_arg, &chan.attr.tracefile_size) < 0) {
1cb514ce	429	ERR("Wrong value in --tracefile-size parameter: %s", opt_arg);
16068db5 MD	430	ret = CMD_ERROR;
	431	goto end;
	432	}
1624d5b7 JD	433	DBG("Maximum tracefile size set to %" PRIu64,
	434	chan.attr.tracefile_size);
	435	break;
	436	case OPT_TRACEFILE_COUNT:
16068db5 MD	437	{
	438	unsigned long v;
	439
	440	errno = 0;
1cb514ce MD	441	opt_arg = poptGetOptArg(pc);
	442	v = strtoul(opt_arg, NULL, 0);
	443	if (errno != 0 \|\| !isdigit(opt_arg[0])) {
	444	ERR("Wrong value in --tracefile-count parameter: %s", opt_arg);
16068db5 MD	445	ret = CMD_ERROR;
	446	goto end;
	447	}
	448	if (v != (uint32_t) v) {
	449	ERR("32-bit overflow in --tracefile-count parameter: %s", opt_arg);
	450	ret = CMD_ERROR;
	451	goto end;
	452	}
	453	chan.attr.tracefile_count = (uint32_t) v;
1624d5b7 JD	454	DBG("Maximum tracefile count set to %" PRIu64,
	455	chan.attr.tracefile_count);
	456	break;
16068db5	457	}
679b4943 SM	458	case OPT_LIST_OPTIONS:
679b4943 SM	459	list_cmd_options(stdout, long_options);
679b4943	460	goto end;
d36b8583 DG	461	default:
	462	usage(stderr);
	463	ret = CMD_UNDEFINED;
	464	goto end;
	465	}
	466	}
	467
	468	opt_channels = (char*) poptGetArg(pc);
	469	if (opt_channels == NULL) {
7d29a247	470	ERR("Missing channel name.\n");
d36b8583	471	usage(stderr);
ca1c3607	472	ret = CMD_ERROR;
d36b8583 DG	473	goto end;
	474	}
	475
cd80958d DG	476	if (!opt_session_name) {
	477	session_name = get_session_name();
	478	if (session_name == NULL) {
ca1c3607	479	ret = CMD_ERROR;
cd80958d DG	480	goto end;
	481	}
	482	} else {
	483	session_name = opt_session_name;
	484	}
	485
	486	ret = enable_channel(session_name);
d36b8583 DG	487
d36b8583 DG	488	end:
5853fd43 DG	489	if (!opt_session_name && session_name) {
	490	free(session_name);
	491	}
ca1c3607	492	poptFreeContext(pc);
d36b8583 DG	493	return ret;
d36b8583 DG	494	}