[lttng-tools.git] / src / bin / lttng / commands / create.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 <assert.h>
#include <ctype.h>
#include <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>

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

#include <common/defaults.h>
#include <common/sessiond-comm/sessiond-comm.h>
#include <common/uri.h>
#include <common/utils.h>
#include <lttng/snapshot.h>

static char *opt_output_path;
static char *opt_session_name;
static char *opt_url;
static char *opt_ctrl_url;
static char *opt_data_url;
static int opt_no_consumer;
static int opt_no_output;
static int opt_snapshot;
static unsigned int opt_live_timer;
static int opt_disable_consumer;

enum {
	OPT_HELP = 1,
	OPT_LIST_OPTIONS,
	OPT_LIVE_TIMER,
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
	{"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{"set-url",        'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
	{"ctrl-url",       'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
	{"data-url",       'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0},
	{"no-output",       0, POPT_ARG_VAL, &opt_no_output, 1, 0, 0},
	{"no-consumer",     0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0},
	{"disable-consumer", 0, POPT_ARG_VAL, &opt_disable_consumer, 1, 0, 0},
	{"snapshot",        0, POPT_ARG_VAL, &opt_snapshot, 1, 0, 0},
	{"live",            0, POPT_ARG_INT | POPT_ARGFLAG_OPTIONAL, 0, OPT_LIVE_TIMER, 0, 0},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
 * why this declaration exists and used ONLY in for this command.
 */
extern int _lttng_create_session_ext(const char *name, const char *url,
		const char *datetime, int live_timer);

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\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, "  -o, --output PATH    Specify output path for traces\n");
	fprintf(ofp, "      --no-output      Traces will not be outputted\n");
	fprintf(ofp, "      --snapshot       Set the session in snapshot mode.\n");
	fprintf(ofp, "                       Created in no-output mode and uses the URL,\n");
	fprintf(ofp, "                       if one, as the default snapshot output.\n");
	fprintf(ofp, "                       Every channel will be set in overwrite mode\n");
	fprintf(ofp, "                       and with mmap output (splice not supported).\n");
	fprintf(ofp, "      --live [USEC]    Set the session in live-reading mode.\n");
	fprintf(ofp, "                       The delay parameter in micro-seconds is the\n");
	fprintf(ofp, "                       maximum time the user can wait for the data\n");
	fprintf(ofp, "                       to be flushed. Can be set with a network\n");
	fprintf(ofp, "                       URL (-U or -C/-D) and must have a relayd listening.\n");
	fprintf(ofp, "                       By default, %u is used for the timer and the\n",
											DEFAULT_LTTNG_LIVE_TIMER);
	fprintf(ofp, "                       network URL is set to net://127.0.0.1.\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Extended Options:\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  -U, --set-url=URL    Set URL destination of the trace data.\n");
	fprintf(ofp, "                       It is persistent for the session lifetime.\n");
	fprintf(ofp, "                       This will set both data and control URL.\n");
	fprintf(ofp, "                       You can change it with the enable-consumer cmd\n");
	fprintf(ofp, "  -C, --ctrl-url=URL   Set control path URL. (Must use -D also)\n");
	fprintf(ofp, "  -D, --data-url=URL   Set data path URL. (Must use -C also)\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
	fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
	fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "URL format is has followed:\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  Supported protocols are (proto):\n");
	fprintf(ofp, "  > file://...\n");
	fprintf(ofp, "    Local filesystem full path.\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  > net[6]://...\n");
	fprintf(ofp, "    This will use the default network transport layer which is\n");
	fprintf(ofp, "    TCP for both control (PORT1) and data port (PORT2).\n");
	fprintf(ofp, "    The default ports are respectively 5342 and 5343.\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  > tcp[6]://...\n");
	fprintf(ofp, "    Can only be used with -C and -D together\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Examples:\n");
	fprintf(ofp, "    # lttng create -U net://192.168.1.42\n");
	fprintf(ofp, "    Uses TCP and default ports for the given destination.\n");
	fprintf(ofp, "    # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
	fprintf(ofp, "    Uses TCP, default ports and IPv6.\n");
	fprintf(ofp, "    # lttng create s1 -U net://myhost.com:3229\n");
	fprintf(ofp, "    Set the consumer to the remote HOST on port 3229 for control.\n");
	fprintf(ofp, "\n");
}

/*
 * For a session name, set the consumer URLs.
 */
static int set_consumer_url(const char *session_name, const char *ctrl_url,
		const char *data_url)
{
	int ret;
	struct lttng_handle *handle;
	struct lttng_domain dom;

	assert(session_name);

	/*
	 * Set handle with the session name and the domain set to 0. This means to
	 * the session daemon that the next action applies on the tracing session
	 * rather then the domain specific session.
	 */
	memset(&dom, 0, sizeof(dom));

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

	ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
	if (ret < 0) {
		goto error;
	}

	if (ctrl_url) {
		MSG("Control URL %s set for session %s", ctrl_url, session_name);
	}

	if (data_url) {
		MSG("Data URL %s set for session %s", data_url, session_name);
	}

error:
	lttng_destroy_handle(handle);
	return ret;
}

static int add_snapshot_output(const char *session_name, const char *ctrl_url,
		const char *data_url)
{
	int ret;
	struct lttng_snapshot_output *output = NULL;

	assert(session_name);

	output = lttng_snapshot_output_create();
	if (!output) {
		ret = CMD_FATAL;
		goto error_create;
	}

	if (ctrl_url) {
		ret = lttng_snapshot_output_set_ctrl_url(ctrl_url, output);
		if (ret < 0) {
			goto error;
		}
	}

	if (data_url) {
		ret = lttng_snapshot_output_set_data_url(data_url, output);
		if (ret < 0) {
			goto error;
		}
	}

	/* This call, if successful, populates the id of the output object. */
	ret = lttng_snapshot_add_output(session_name, output);
	if (ret < 0) {
		goto error;
	}

error:
	lttng_snapshot_output_destroy(output);
error_create:
	return ret;
}

/*
 *  Create a tracing session.
 *  If no name is specified, a default name is generated.
 *
 *  Returns one of the CMD_* result constants.
 */
static int create_session(void)
{
	int ret;
	char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL;
	char *alloc_url = NULL, *url = NULL, datetime[16];
	char session_name_date[NAME_MAX + 17], *print_str_url = NULL;
	time_t rawtime;
	struct tm *timeinfo;

	/* Get date and time for automatic session name/path */
	time(&rawtime);
	timeinfo = localtime(&rawtime);
	strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);

	/* Auto session name creation */
	if (opt_session_name == NULL) {
		ret = snprintf(session_name_date, sizeof(session_name_date),
				DEFAULT_SESSION_NAME "-%s", datetime);
		if (ret < 0) {
			PERROR("snprintf session name");
			goto error;
		}
		session_name = session_name_date;
		DBG("Auto session name set to %s", session_name_date);
	} else {
		if (strlen(opt_session_name) > NAME_MAX) {
			ERR("Session name too long. Length must be lower or equal to %d",
					NAME_MAX);
			ret = LTTNG_ERR_SESSION_FAIL;
			goto error;
		}
		/*
		 * Check if the session name begins with "auto-" or is exactly "auto".
		 * Both are reserved for the default session name. See bug #449 to
		 * understand why we need to check both here.
		 */
		if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
					strlen(DEFAULT_SESSION_NAME) + 1) == 0) ||
				(strncmp(opt_session_name, DEFAULT_SESSION_NAME,
					strlen(DEFAULT_SESSION_NAME)) == 0 &&
				strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
			ERR("%s is a reserved keyword for default session(s)",
					DEFAULT_SESSION_NAME);
			ret = CMD_ERROR;
			goto error;
		}
		session_name = opt_session_name;
		ret = snprintf(session_name_date, sizeof(session_name_date),
				"%s-%s", session_name, datetime);
		if (ret < 0) {
			PERROR("snprintf session name");
			goto error;
		}
	}

	if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) {
		ERR("You need both control and data URL.");
		ret = CMD_ERROR;
		goto error;
	}

	if (opt_output_path != NULL) {
		traces_path = utils_expand_path(opt_output_path);
		if (traces_path == NULL) {
			ret = CMD_ERROR;
			goto error;
		}

		/* Create URL string from the local filesytem path */
		ret = asprintf(&alloc_url, "file://%s", traces_path);
		if (ret < 0) {
			PERROR("asprintf url path");
			ret = CMD_FATAL;
			goto error;
		}
		/* URL to use in the lttng_create_session() call */
		url = alloc_url;
		print_str_url = traces_path;
	} else if (opt_url) { /* Handling URL (-U opt) */
		url = opt_url;
		print_str_url = url;
	} else if (opt_data_url && opt_ctrl_url) {
		/*
		 * With both control and data, we'll be setting the consumer URL after
		 * session creation thus use no URL.
		 */
		url = NULL;
	} else if (!opt_no_output) {
		/* Auto output path */
		alloc_path = utils_get_home_dir();
		if (alloc_path == NULL) {
			ERR("HOME path not found.\n \
					Please specify an output path using -o, --output PATH");
			ret = CMD_FATAL;
			goto error;
		}
		alloc_path = strdup(alloc_path);

		ret = asprintf(&alloc_url,
				"file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
				alloc_path, session_name_date);
		if (ret < 0) {
			PERROR("asprintf trace dir name");
			ret = CMD_FATAL;
			goto error;
		}

		url = alloc_url;
		print_str_url = alloc_url + strlen("file://");
	} else {
		/* No output means --no-output or --snapshot mode. */
		url = NULL;
	}

	/* Use default live URL if NO url is/are found. */
	if ((opt_live_timer && !opt_url) && (opt_live_timer && !opt_data_url)) {
		ret = asprintf(&alloc_url, "net://127.0.0.1");
		if (ret < 0) {
			PERROR("asprintf default live URL");
			ret = CMD_FATAL;
			goto error;
		}
		url = alloc_url;
		print_str_url = url;
	}

	if (opt_snapshot && opt_live_timer) {
		ERR("Snapshot and live modes are mutually exclusive.");
		ret = CMD_ERROR;
		goto error;
	}

	if (opt_snapshot) {
		/* No output by default. */
		const char *snapshot_url = NULL;

		if (opt_url) {
			snapshot_url = url;
		} else if (!opt_data_url && !opt_ctrl_url) {
			/* This is the session path that we need to use as output. */
			snapshot_url = url;
		}
		ret = lttng_create_session_snapshot(session_name, snapshot_url);
	} else if (opt_live_timer) {
		const char *pathname;

		if (opt_relayd_path) {
			pathname = opt_relayd_path;
		} else {
			pathname = INSTALL_BIN_PATH "/lttng-relayd";
		}
		if (!check_relayd() && spawn_relayd(pathname, 0) < 0) {
			goto error;
		}
		ret = lttng_create_session_live(session_name, url, opt_live_timer);
	} else {
		ret = _lttng_create_session_ext(session_name, url, datetime, -1);
	}
	if (ret < 0) {
		/* Don't set ret so lttng can interpret the sessiond error. */
		switch (-ret) {
		case LTTNG_ERR_EXIST_SESS:
			WARN("Session %s already exists", session_name);
			break;
		default:
			break;
		}
		goto error;
	}

	if (opt_ctrl_url && opt_data_url) {
		if (opt_snapshot) {
			ret = add_snapshot_output(session_name, opt_ctrl_url,
					opt_data_url);
		} else {
			/* Setting up control URI (-C or/and -D opt) */
			ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
		}
		if (ret < 0) {
			/* Destroy created session because the URL are not valid. */
			lttng_destroy_session(session_name);
			goto error;
		}
	}

	MSG("Session %s created.", session_name);
	if (print_str_url && !opt_snapshot) {
		MSG("Traces will be written in %s", print_str_url);

		if (opt_live_timer) {
			MSG("Live timer set to %u usec", opt_live_timer);
		}
	} else if (opt_snapshot) {
		if (print_str_url) {
			MSG("Default snapshot output set to: %s", print_str_url);
		}
		MSG("Snapshot mode set. Every channel enabled for that session will "
				"be set in overwrite mode and mmap output.");
	}

	/* Init lttng session config */
	ret = config_init(session_name);
	if (ret < 0) {
		ret = CMD_ERROR;
		goto error;
	}

	ret = CMD_SUCCESS;

error:
	free(alloc_url);
	free(traces_path);
	free(alloc_path);

	if (ret < 0) {
		ERR("%s", lttng_strerror(ret));
	}
	return ret;
}

/*
 *  The 'create <options>' first level command
 *
 *  Returns one of the CMD_* result constants.
 */
int cmd_create(int argc, const char **argv)
{
	int opt, ret = CMD_SUCCESS;
	char *opt_arg = NULL;
	static poptContext pc;

	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_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			goto end;
		case OPT_LIVE_TIMER:
		{
			unsigned long v;

			errno = 0;
			opt_arg = poptGetOptArg(pc);
			if (!opt_arg) {
				/* Set up default values. */
				opt_live_timer = (uint32_t) DEFAULT_LTTNG_LIVE_TIMER;
				DBG("Session live timer interval set to default value %d",
						opt_live_timer);
				break;
			}

			v = strtoul(opt_arg, NULL, 0);
			if (errno != 0 || !isdigit(opt_arg[0])) {
				ERR("Wrong value in --live parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			if (v != (uint32_t) v) {
				ERR("32-bit overflow in --live parameter: %s", opt_arg);
				ret = CMD_ERROR;
				goto end;
			}
			opt_live_timer = (uint32_t) v;
			DBG("Session live timer interval set to %d", opt_live_timer);
			break;
		}
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	if (opt_no_consumer) {
		MSG("The option --no-consumer is obsolete. Use --no-output now.");
		ret = CMD_WARNING;
		goto end;
	}

	if (opt_disable_consumer) {
		MSG("The option --disable-consumer is obsolete.");
		ret = CMD_WARNING;
		goto end;
	}

	opt_session_name = (char*) poptGetArg(pc);

	ret = create_session();

end:
	poptFreeContext(pc);
	return ret;
}
Commit	Line	Data
f3ed775e 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.
f3ed775e 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.
f3ed775e DG	16	*/
	17
	18	#define _GNU_SOURCE
a4b92340	19	#include <assert.h>
ecc48a90	20	#include <ctype.h>
f3ed775e DG	21	#include <popt.h>
	22	#include <stdio.h>
	23	#include <stdlib.h>
	24	#include <string.h>
	25	#include <sys/stat.h>
	26	#include <sys/types.h>
	27	#include <time.h>
	28	#include <unistd.h>
	29
c399183f	30	#include "../command.h"
679b4943	31	#include "../utils.h"
f3ed775e	32
00e2e675	33	#include <common/defaults.h>
42224349	34	#include <common/sessiond-comm/sessiond-comm.h>
00e2e675	35	#include <common/uri.h>
81b86775	36	#include <common/utils.h>
16f6f820	37	#include <lttng/snapshot.h>
42224349	38
f3ed775e DG	39	static char *opt_output_path;
f3ed775e DG	40	static char *opt_session_name;
a4b92340 DG	41	static char *opt_url;
	42	static char *opt_ctrl_url;
	43	static char *opt_data_url;
	44	static int opt_no_consumer;
2bba9e53	45	static int opt_no_output;
16f6f820	46	static int opt_snapshot;
ecc48a90	47	static unsigned int opt_live_timer;
a4b92340	48	static int opt_disable_consumer;
f3ed775e DG	49
	50	enum {
	51	OPT_HELP = 1,
679b4943	52	OPT_LIST_OPTIONS,
ecc48a90	53	OPT_LIVE_TIMER,
f3ed775e DG	54	};
	55
	56	static struct poptOption long_options[] = {
	57	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
679b4943 SM	58	{"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
	59	{"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
	60	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
23d14dff DG	61	{"set-url", 'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
	62	{"ctrl-url", 'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
	63	{"data-url", 'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0},
2bba9e53 DG	64	{"no-output", 0, POPT_ARG_VAL, &opt_no_output, 1, 0, 0},
2bba9e53 DG	65	{"no-consumer", 0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0},
a4b92340	66	{"disable-consumer", 0, POPT_ARG_VAL, &opt_disable_consumer, 1, 0, 0},
16f6f820	67	{"snapshot", 0, POPT_ARG_VAL, &opt_snapshot, 1, 0, 0},
d73c5802	68	{"live", 0, POPT_ARG_INT \| POPT_ARGFLAG_OPTIONAL, 0, OPT_LIVE_TIMER, 0, 0},
f3ed775e DG	69	{0, 0, 0, 0, 0, 0, 0}
	70	};
	71
16de1a24 DG	72	/*
	73	* Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
	74	* why this declaration exists and used ONLY in for this command.
	75	*/
07424f16	76	extern int _lttng_create_session_ext(const char name, const char url,
ecc48a90	77	const char *datetime, int live_timer);
07424f16	78
f3ed775e DG	79	/*
	80	* usage
	81	*/
	82	static void usage(FILE *ofp)
	83	{
a4b92340	84	fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n");
f3ed775e	85	fprintf(ofp, "\n");
a4b92340 DG	86	fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
	87	fprintf(ofp, "\n");
	88	fprintf(ofp, "Options:\n");
f3ed775e	89	fprintf(ofp, " -h, --help Show this help\n");
1c8d13c8	90	fprintf(ofp, " --list-options Simple listing of options\n");
58a97671	91	fprintf(ofp, " -o, --output PATH Specify output path for traces\n");
a2d6893b MD	92	fprintf(ofp, " --no-output Traces will not be outputted\n");
a2d6893b MD	93	fprintf(ofp, " --snapshot Set the session in snapshot mode.\n");
16f6f820 DG	94	fprintf(ofp, " Created in no-output mode and uses the URL,\n");
	95	fprintf(ofp, " if one, as the default snapshot output.\n");
	96	fprintf(ofp, " Every channel will be set in overwrite mode\n");
	97	fprintf(ofp, " and with mmap output (splice not supported).\n");
d73c5802	98	fprintf(ofp, " --live [USEC] Set the session in live-reading mode.\n");
ecc48a90 JD	99	fprintf(ofp, " The delay parameter in micro-seconds is the\n");
ecc48a90 JD	100	fprintf(ofp, " maximum time the user can wait for the data\n");
d73c5802 DG	101	fprintf(ofp, " to be flushed. Can be set with a network\n");
	102	fprintf(ofp, " URL (-U or -C/-D) and must have a relayd listening.\n");
	103	fprintf(ofp, " By default, %u is used for the timer and the\n",
	104	DEFAULT_LTTNG_LIVE_TIMER);
	105	fprintf(ofp, " network URL is set to net://127.0.0.1.\n");
a4b92340 DG	106	fprintf(ofp, "\n");
	107	fprintf(ofp, "Extended Options:\n");
	108	fprintf(ofp, "\n");
	109	fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
	110	fprintf(ofp, "\n");
	111	fprintf(ofp, " -U, --set-url=URL Set URL destination of the trace data.\n");
00e2e675	112	fprintf(ofp, " It is persistent for the session lifetime.\n");
a4b92340 DG	113	fprintf(ofp, " This will set both data and control URL.\n");
	114	fprintf(ofp, " You can change it with the enable-consumer cmd\n");
	115	fprintf(ofp, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n");
	116	fprintf(ofp, " -D, --data-url=URL Set data path URL. (Must use -C also)\n");
a4b92340 DG	117	fprintf(ofp, "\n");
	118	fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
	119	fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
	120	fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
	121	fprintf(ofp, "\n");
	122	fprintf(ofp, "URL format is has followed:\n");
	123	fprintf(ofp, "\n");
	124	fprintf(ofp, " proto://[HOST\|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
	125	fprintf(ofp, "\n");
	126	fprintf(ofp, " Supported protocols are (proto):\n");
	127	fprintf(ofp, " > file://...\n");
	128	fprintf(ofp, " Local filesystem full path.\n");
	129	fprintf(ofp, "\n");
16de1a24	130	fprintf(ofp, " > net[6]://...\n");
a4b92340 DG	131	fprintf(ofp, " This will use the default network transport layer which is\n");
	132	fprintf(ofp, " TCP for both control (PORT1) and data port (PORT2).\n");
	133	fprintf(ofp, " The default ports are respectively 5342 and 5343.\n");
	134	fprintf(ofp, "\n");
0ab61906	135	fprintf(ofp, " > tcp[6]://...\n");
a4b92340 DG	136	fprintf(ofp, " Can only be used with -C and -D together\n");
	137	fprintf(ofp, "\n");
	138	fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
	139	fprintf(ofp, "\n");
	140	fprintf(ofp, "Examples:\n");
	141	fprintf(ofp, " # lttng create -U net://192.168.1.42\n");
	142	fprintf(ofp, " Uses TCP and default ports for the given destination.\n");
	143	fprintf(ofp, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
	144	fprintf(ofp, " Uses TCP, default ports and IPv6.\n");
	145	fprintf(ofp, " # lttng create s1 -U net://myhost.com:3229\n");
	146	fprintf(ofp, " Set the consumer to the remote HOST on port 3229 for control.\n");
f3ed775e DG	147	fprintf(ofp, "\n");
	148	}
	149
00e2e675	150	/*
a4b92340	151	* For a session name, set the consumer URLs.
00e2e675	152	*/
a4b92340 DG	153	static int set_consumer_url(const char session_name, const char ctrl_url,
a4b92340 DG	154	const char *data_url)
00e2e675	155	{
a4b92340 DG	156	int ret;
	157	struct lttng_handle *handle;
	158	struct lttng_domain dom;
	159
	160	assert(session_name);
	161
	162	/*
	163	* Set handle with the session name and the domain set to 0. This means to
	164	* the session daemon that the next action applies on the tracing session
	165	* rather then the domain specific session.
	166	*/
	167	memset(&dom, 0, sizeof(dom));
	168
	169	handle = lttng_create_handle(session_name, &dom);
	170	if (handle == NULL) {
	171	ret = CMD_FATAL;
	172	goto error;
	173	}
00e2e675	174
a4b92340 DG	175	ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
	176	if (ret < 0) {
	177	goto error;
00e2e675 DG	178	}
00e2e675 DG	179
a4b92340 DG	180	if (ctrl_url) {
a4b92340 DG	181	MSG("Control URL %s set for session %s", ctrl_url, session_name);
00e2e675 DG	182	}
00e2e675 DG	183
a4b92340 DG	184	if (data_url) {
	185	MSG("Data URL %s set for session %s", data_url, session_name);
	186	}
	187
	188	error:
	189	lttng_destroy_handle(handle);
	190	return ret;
	191	}
	192
16f6f820 DG	193	static int add_snapshot_output(const char session_name, const char ctrl_url,
	194	const char *data_url)
	195	{
	196	int ret;
	197	struct lttng_snapshot_output *output = NULL;
	198
	199	assert(session_name);
	200
	201	output = lttng_snapshot_output_create();
	202	if (!output) {
	203	ret = CMD_FATAL;
	204	goto error_create;
	205	}
	206
	207	if (ctrl_url) {
	208	ret = lttng_snapshot_output_set_ctrl_url(ctrl_url, output);
	209	if (ret < 0) {
	210	goto error;
	211	}
	212	}
	213
	214	if (data_url) {
	215	ret = lttng_snapshot_output_set_data_url(data_url, output);
	216	if (ret < 0) {
	217	goto error;
	218	}
	219	}
	220
	221	/* This call, if successful, populates the id of the output object. */
	222	ret = lttng_snapshot_add_output(session_name, output);
	223	if (ret < 0) {
	224	goto error;
	225	}
	226
	227	error:
	228	lttng_snapshot_output_destroy(output);
	229	error_create:
	230	return ret;
	231	}
	232
f3ed775e	233	/*
1c8d13c8 TD	234	* Create a tracing session.
1c8d13c8 TD	235	* If no name is specified, a default name is generated.
f3ed775e	236	*
1c8d13c8	237	* Returns one of the CMD_* result constants.
f3ed775e	238	*/
a4b92340	239	static int create_session(void)
f3ed775e	240	{
a4b92340	241	int ret;
07424f16	242	char session_name = NULL, traces_path = NULL, *alloc_path = NULL;
a4b92340	243	char alloc_url = NULL, url = NULL, datetime[16];
487b253b	244	char session_name_date[NAME_MAX + 17], *print_str_url = NULL;
f3ed775e DG	245	time_t rawtime;
	246	struct tm *timeinfo;
	247
d6175221 DG	248	/* Get date and time for automatic session name/path */
	249	time(&rawtime);
	250	timeinfo = localtime(&rawtime);
	251	strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
	252
f3ed775e DG	253	/* Auto session name creation */
f3ed775e DG	254	if (opt_session_name == NULL) {
07424f16 DG	255	ret = snprintf(session_name_date, sizeof(session_name_date),
07424f16 DG	256	DEFAULT_SESSION_NAME "-%s", datetime);
d6175221	257	if (ret < 0) {
07424f16 DG	258	PERROR("snprintf session name");
	259	goto error;
	260	}
04965770	261	session_name = session_name_date;
07424f16	262	DBG("Auto session name set to %s", session_name_date);
f3ed775e	263	} else {
487b253b DG	264	if (strlen(opt_session_name) > NAME_MAX) {
	265	ERR("Session name too long. Length must be lower or equal to %d",
	266	NAME_MAX);
	267	ret = LTTNG_ERR_SESSION_FAIL;
	268	goto error;
	269	}
4b861950 DG	270	/*
	271	* Check if the session name begins with "auto-" or is exactly "auto".
	272	* Both are reserved for the default session name. See bug #449 to
	273	* understand why we need to check both here.
	274	*/
	275	if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
	276	strlen(DEFAULT_SESSION_NAME) + 1) == 0) \|\|
	277	(strncmp(opt_session_name, DEFAULT_SESSION_NAME,
61b35a5a	278	strlen(DEFAULT_SESSION_NAME)) == 0 &&
4b861950	279	strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
61b35a5a DG	280	ERR("%s is a reserved keyword for default session(s)",
	281	DEFAULT_SESSION_NAME);
	282	ret = CMD_ERROR;
	283	goto error;
	284	}
f3ed775e	285	session_name = opt_session_name;
07424f16 DG	286	ret = snprintf(session_name_date, sizeof(session_name_date),
	287	"%s-%s", session_name, datetime);
	288	if (ret < 0) {
	289	PERROR("snprintf session name");
	290	goto error;
	291	}
f3ed775e DG	292	}
f3ed775e DG	293
1a241656 DG	294	if ((!opt_ctrl_url && opt_data_url) \|\| (opt_ctrl_url && !opt_data_url)) {
	295	ERR("You need both control and data URL.");
	296	ret = CMD_ERROR;
	297	goto error;
	298	}
	299
785d2d0d	300	if (opt_output_path != NULL) {
81b86775	301	traces_path = utils_expand_path(opt_output_path);
00e2e675 DG	302	if (traces_path == NULL) {
	303	ret = CMD_ERROR;
	304	goto error;
	305	}
	306
a4b92340 DG	307	/* Create URL string from the local filesytem path */
a4b92340 DG	308	ret = asprintf(&alloc_url, "file://%s", traces_path);
00e2e675	309	if (ret < 0) {
a4b92340	310	PERROR("asprintf url path");
00e2e675 DG	311	ret = CMD_FATAL;
	312	goto error;
	313	}
a4b92340 DG	314	/* URL to use in the lttng_create_session() call */
a4b92340 DG	315	url = alloc_url;
40b03f52	316	print_str_url = traces_path;
a4b92340 DG	317	} else if (opt_url) { /* Handling URL (-U opt) */
a4b92340 DG	318	url = opt_url;
40b03f52	319	print_str_url = url;
1a241656 DG	320	} else if (opt_data_url && opt_ctrl_url) {
	321	/*
	322	* With both control and data, we'll be setting the consumer URL after
	323	* session creation thus use no URL.
	324	*/
	325	url = NULL;
2bba9e53	326	} else if (!opt_no_output) {
00e2e675	327	/* Auto output path */
feb0f3e5	328	alloc_path = utils_get_home_dir();
f3ed775e	329	if (alloc_path == NULL) {
d386b234	330	ERR("HOME path not found.\n \
00e2e675	331	Please specify an output path using -o, --output PATH");
f3ed775e DG	332	ret = CMD_FATAL;
	333	goto error;
	334	}
d386b234	335	alloc_path = strdup(alloc_path);
f3ed775e	336
07424f16 DG	337	ret = asprintf(&alloc_url,
	338	"file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
	339	alloc_path, session_name_date);
58a97671	340	if (ret < 0) {
00e2e675 DG	341	PERROR("asprintf trace dir name");
00e2e675 DG	342	ret = CMD_FATAL;
58a97671 DG	343	goto error;
58a97671 DG	344	}
00e2e675	345
a4b92340	346	url = alloc_url;
1a241656	347	print_str_url = alloc_url + strlen("file://");
2bba9e53	348	} else {
16f6f820	349	/* No output means --no-output or --snapshot mode. */
2bba9e53	350	url = NULL;
00e2e675 DG	351	}
00e2e675 DG	352
1a241656	353	/* Use default live URL if NO url is/are found. */
ecc48a90	354	if ((opt_live_timer && !opt_url) && (opt_live_timer && !opt_data_url)) {
d73c5802 DG	355	ret = asprintf(&alloc_url, "net://127.0.0.1");
	356	if (ret < 0) {
	357	PERROR("asprintf default live URL");
	358	ret = CMD_FATAL;
	359	goto error;
	360	}
	361	url = alloc_url;
	362	print_str_url = url;
ecc48a90 JD	363	}
	364
	365	if (opt_snapshot && opt_live_timer) {
	366	ERR("Snapshot and live modes are mutually exclusive.");
	367	ret = CMD_ERROR;
	368	goto error;
	369	}
	370
16f6f820 DG	371	if (opt_snapshot) {
	372	/* No output by default. */
	373	const char *snapshot_url = NULL;
	374
	375	if (opt_url) {
	376	snapshot_url = url;
	377	} else if (!opt_data_url && !opt_ctrl_url) {
	378	/* This is the session path that we need to use as output. */
	379	snapshot_url = url;
	380	}
	381	ret = lttng_create_session_snapshot(session_name, snapshot_url);
ecc48a90	382	} else if (opt_live_timer) {
8960e9cd DG	383	const char *pathname;
	384
	385	if (opt_relayd_path) {
	386	pathname = opt_relayd_path;
	387	} else {
	388	pathname = INSTALL_BIN_PATH "/lttng-relayd";
	389	}
	390	if (!check_relayd() && spawn_relayd(pathname, 0) < 0) {
	391	goto error;
	392	}
ecc48a90	393	ret = lttng_create_session_live(session_name, url, opt_live_timer);
16f6f820	394	} else {
ecc48a90	395	ret = _lttng_create_session_ext(session_name, url, datetime, -1);
16f6f820	396	}
f3ed775e	397	if (ret < 0) {
ae856491	398	/* Don't set ret so lttng can interpret the sessiond error. */
42224349	399	switch (-ret) {
f73fabfd	400	case LTTNG_ERR_EXIST_SESS:
42224349 DG	401	WARN("Session %s already exists", session_name);
42224349 DG	402	break;
60e835ca	403	default:
60e835ca	404	break;
42224349	405	}
f3ed775e DG	406	goto error;
	407	}
	408
0ab61906	409	if (opt_ctrl_url && opt_data_url) {
16f6f820 DG	410	if (opt_snapshot) {
	411	ret = add_snapshot_output(session_name, opt_ctrl_url,
	412	opt_data_url);
	413	} else {
	414	/* Setting up control URI (-C or/and -D opt) */
	415	ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
	416	}
a4b92340	417	if (ret < 0) {
4f50c803 DG	418	/* Destroy created session because the URL are not valid. */
4f50c803 DG	419	lttng_destroy_session(session_name);
a4b92340 DG	420	goto error;
a4b92340 DG	421	}
4f50c803 DG	422	}
	423
	424	MSG("Session %s created.", session_name);
16f6f820	425	if (print_str_url && !opt_snapshot) {
4f50c803	426	MSG("Traces will be written in %s", print_str_url);
d73c5802 DG	427
	428	if (opt_live_timer) {
	429	MSG("Live timer set to %u usec", opt_live_timer);
	430	}
16f6f820 DG	431	} else if (opt_snapshot) {
	432	if (print_str_url) {
	433	MSG("Default snapshot output set to: %s", print_str_url);
	434	}
	435	MSG("Snapshot mode set. Every channel enabled for that session will "
1daafe0d	436	"be set in overwrite mode and mmap output.");
a4b92340 DG	437	}
a4b92340 DG	438
58a97671 DG	439	/* Init lttng session config */
58a97671 DG	440	ret = config_init(session_name);
f3ed775e	441	if (ret < 0) {
27089920	442	ret = CMD_ERROR;
f3ed775e DG	443	goto error;
	444	}
	445
f3ed775e DG	446	ret = CMD_SUCCESS;
	447
	448	error:
0e428499 DG	449	free(alloc_url);
0e428499 DG	450	free(traces_path);
87f222b6	451	free(alloc_path);
a4b92340 DG	452
	453	if (ret < 0) {
	454	ERR("%s", lttng_strerror(ret));
	455	}
f3ed775e DG	456	return ret;
	457	}
	458
	459	/*
74cc1d0f	460	* The 'create <options>' first level command
1c8d13c8 TD	461	*
1c8d13c8 TD	462	* Returns one of the CMD_* result constants.
f3ed775e DG	463	*/
	464	int cmd_create(int argc, const char **argv)
	465	{
	466	int opt, ret = CMD_SUCCESS;
ecc48a90	467	char *opt_arg = NULL;
f3ed775e DG	468	static poptContext pc;
	469
	470	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	471	poptReadDefaultConfig(pc, 0);
	472
	473	while ((opt = poptGetNextOpt(pc)) != -1) {
	474	switch (opt) {
	475	case OPT_HELP:
27089920	476	usage(stdout);
f3ed775e	477	goto end;
679b4943 SM	478	case OPT_LIST_OPTIONS:
679b4943 SM	479	list_cmd_options(stdout, long_options);
679b4943	480	goto end;
ecc48a90 JD	481	case OPT_LIVE_TIMER:
	482	{
	483	unsigned long v;
	484
	485	errno = 0;
	486	opt_arg = poptGetOptArg(pc);
d73c5802 DG	487	if (!opt_arg) {
	488	/* Set up default values. */
	489	opt_live_timer = (uint32_t) DEFAULT_LTTNG_LIVE_TIMER;
	490	DBG("Session live timer interval set to default value %d",
	491	opt_live_timer);
	492	break;
	493	}
	494
ecc48a90 JD	495	v = strtoul(opt_arg, NULL, 0);
	496	if (errno != 0 \|\| !isdigit(opt_arg[0])) {
	497	ERR("Wrong value in --live parameter: %s", opt_arg);
	498	ret = CMD_ERROR;
	499	goto end;
	500	}
	501	if (v != (uint32_t) v) {
	502	ERR("32-bit overflow in --live parameter: %s", opt_arg);
	503	ret = CMD_ERROR;
	504	goto end;
	505	}
	506	opt_live_timer = (uint32_t) v;
	507	DBG("Session live timer interval set to %d", opt_live_timer);
	508	break;
	509	}
f3ed775e DG	510	default:
	511	usage(stderr);
	512	ret = CMD_UNDEFINED;
	513	goto end;
	514	}
	515	}
	516
785d2d0d	517	if (opt_no_consumer) {
2bba9e53	518	MSG("The option --no-consumer is obsolete. Use --no-output now.");
785d2d0d DG	519	ret = CMD_WARNING;
	520	goto end;
	521	}
	522
	523	if (opt_disable_consumer) {
	524	MSG("The option --disable-consumer is obsolete.");
	525	ret = CMD_WARNING;
	526	goto end;
	527	}
	528
f3ed775e DG	529	opt_session_name = (char*) poptGetArg(pc);
	530
	531	ret = create_session();
	532
	533	end:
ca1c3607	534	poptFreeContext(pc);
f3ed775e DG	535	return ret;
f3ed775e DG	536	}