[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, 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. Requires a network URL (-U or -C/-D)\n");
	fprintf(ofp, "                       and a lttng-relayd listening.\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_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_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;
		if (!opt_data_url && !opt_ctrl_url) {
			print_str_url = alloc_url + strlen("file://");
		}
	} else {
		/* No output means --no-output or --snapshot mode. */
		url = NULL;
	}

	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_live_timer && !opt_url) && (opt_live_timer && !opt_data_url)) {
		ERR("You need a network URL (-U or -C/-D) to use live tracing.");
		ret = CMD_ERROR;
		goto error;
	}

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