2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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.
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.
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.
26 #include <sys/types.h>
30 #include "../command.h"
33 #include <common/defaults.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35 #include <common/uri.h>
36 #include <common/utils.h>
37 #include <lttng/snapshot.h>
39 static char *opt_output_path
;
40 static char *opt_session_name
;
42 static char *opt_ctrl_url
;
43 static char *opt_data_url
;
44 static int opt_no_consumer
;
45 static int opt_no_output
;
46 static int opt_snapshot
;
47 static unsigned int opt_live_timer
;
48 static int opt_disable_consumer
;
56 static struct poptOption long_options
[] = {
57 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
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
},
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},
64 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
65 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
66 {"disable-consumer", 0, POPT_ARG_VAL
, &opt_disable_consumer
, 1, 0, 0},
67 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
68 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
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.
76 extern int _lttng_create_session_ext(const char *name
, const char *url
,
77 const char *datetime
, int live_timer
);
82 static void usage(FILE *ofp
)
84 fprintf(ofp
, "usage: lttng create [NAME] [OPTIONS] \n");
86 fprintf(ofp
, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
88 fprintf(ofp
, "Options:\n");
89 fprintf(ofp
, " -h, --help Show this help\n");
90 fprintf(ofp
, " --list-options Simple listing of options\n");
91 fprintf(ofp
, " -o, --output PATH Specify output path for traces\n");
92 fprintf(ofp
, " --no-output Traces will not be outputted\n");
93 fprintf(ofp
, " --snapshot Set the session in snapshot mode.\n");
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");
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. 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");
107 fprintf(ofp
, "Extended Options:\n");
109 fprintf(ofp
, "Using these options, each API call can be controlled individually.\n");
111 fprintf(ofp
, " -U, --set-url=URL Set URL destination of the trace data.\n");
112 fprintf(ofp
, " It is persistent for the session lifetime.\n");
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");
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");
122 fprintf(ofp
, "URL format is has followed:\n");
124 fprintf(ofp
, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
126 fprintf(ofp
, " Supported protocols are (proto):\n");
127 fprintf(ofp
, " > file://...\n");
128 fprintf(ofp
, " Local filesystem full path.\n");
130 fprintf(ofp
, " > net[6]://...\n");
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");
135 fprintf(ofp
, " > tcp[6]://...\n");
136 fprintf(ofp
, " Can only be used with -C and -D together\n");
138 fprintf(ofp
, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\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");
151 * For a session name, set the consumer URLs.
153 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
154 const char *data_url
)
157 struct lttng_handle
*handle
;
158 struct lttng_domain dom
;
160 assert(session_name
);
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.
167 memset(&dom
, 0, sizeof(dom
));
169 handle
= lttng_create_handle(session_name
, &dom
);
170 if (handle
== NULL
) {
175 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
181 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
185 MSG("Data URL %s set for session %s", data_url
, session_name
);
189 lttng_destroy_handle(handle
);
193 static int add_snapshot_output(const char *session_name
, const char *ctrl_url
,
194 const char *data_url
)
197 struct lttng_snapshot_output
*output
= NULL
;
199 assert(session_name
);
201 output
= lttng_snapshot_output_create();
208 ret
= lttng_snapshot_output_set_ctrl_url(ctrl_url
, output
);
215 ret
= lttng_snapshot_output_set_data_url(data_url
, output
);
221 /* This call, if successful, populates the id of the output object. */
222 ret
= lttng_snapshot_add_output(session_name
, output
);
228 lttng_snapshot_output_destroy(output
);
234 * Create a tracing session.
235 * If no name is specified, a default name is generated.
237 * Returns one of the CMD_* result constants.
239 static int create_session(void)
242 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
243 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
244 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
248 /* Get date and time for automatic session name/path */
250 timeinfo
= localtime(&rawtime
);
251 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
253 /* Auto session name creation */
254 if (opt_session_name
== NULL
) {
255 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
256 DEFAULT_SESSION_NAME
"-%s", datetime
);
258 PERROR("snprintf session name");
261 session_name
= session_name_date
;
262 DBG("Auto session name set to %s", session_name_date
);
264 if (strlen(opt_session_name
) > NAME_MAX
) {
265 ERR("Session name too long. Length must be lower or equal to %d",
267 ret
= LTTNG_ERR_SESSION_FAIL
;
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.
275 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
276 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
277 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
278 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
279 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
280 ERR("%s is a reserved keyword for default session(s)",
281 DEFAULT_SESSION_NAME
);
285 session_name
= opt_session_name
;
286 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
287 "%s-%s", session_name
, datetime
);
289 PERROR("snprintf session name");
294 if (opt_output_path
!= NULL
) {
295 traces_path
= utils_expand_path(opt_output_path
);
296 if (traces_path
== NULL
) {
301 /* Create URL string from the local filesytem path */
302 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
304 PERROR("asprintf url path");
308 /* URL to use in the lttng_create_session() call */
310 print_str_url
= traces_path
;
311 } else if (opt_url
) { /* Handling URL (-U opt) */
314 } else if (!opt_no_output
) {
315 /* Auto output path */
316 alloc_path
= utils_get_home_dir();
317 if (alloc_path
== NULL
) {
318 ERR("HOME path not found.\n \
319 Please specify an output path using -o, --output PATH");
323 alloc_path
= strdup(alloc_path
);
325 ret
= asprintf(&alloc_url
,
326 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
327 alloc_path
, session_name_date
);
329 PERROR("asprintf trace dir name");
335 if (!opt_data_url
&& !opt_ctrl_url
) {
336 print_str_url
= alloc_url
+ strlen("file://");
339 /* No output means --no-output or --snapshot mode. */
343 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
344 ERR("You need both control and data URL.");
349 if ((opt_live_timer
&& !opt_url
) && (opt_live_timer
&& !opt_data_url
)) {
350 /* Use default live URL if none is found. */
351 ret
= asprintf(&alloc_url
, "net://127.0.0.1");
353 PERROR("asprintf default live URL");
361 if (opt_snapshot
&& opt_live_timer
) {
362 ERR("Snapshot and live modes are mutually exclusive.");
368 /* No output by default. */
369 const char *snapshot_url
= NULL
;
373 } else if (!opt_data_url
&& !opt_ctrl_url
) {
374 /* This is the session path that we need to use as output. */
377 ret
= lttng_create_session_snapshot(session_name
, snapshot_url
);
378 } else if (opt_live_timer
) {
379 const char *pathname
;
381 if (opt_relayd_path
) {
382 pathname
= opt_relayd_path
;
384 pathname
= INSTALL_BIN_PATH
"/lttng-relayd";
386 if (!check_relayd() && spawn_relayd(pathname
, 0) < 0) {
389 ret
= lttng_create_session_live(session_name
, url
, opt_live_timer
);
391 ret
= _lttng_create_session_ext(session_name
, url
, datetime
, -1);
394 /* Don't set ret so lttng can interpret the sessiond error. */
396 case LTTNG_ERR_EXIST_SESS
:
397 WARN("Session %s already exists", session_name
);
405 if (opt_ctrl_url
&& opt_data_url
) {
407 ret
= add_snapshot_output(session_name
, opt_ctrl_url
,
410 /* Setting up control URI (-C or/and -D opt) */
411 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
414 /* Destroy created session because the URL are not valid. */
415 lttng_destroy_session(session_name
);
420 MSG("Session %s created.", session_name
);
421 if (print_str_url
&& !opt_snapshot
) {
422 MSG("Traces will be written in %s", print_str_url
);
424 if (opt_live_timer
) {
425 MSG("Live timer set to %u usec", opt_live_timer
);
427 } else if (opt_snapshot
) {
429 MSG("Default snapshot output set to: %s", print_str_url
);
431 MSG("Snapshot mode set. Every channel enabled for that session will "
432 "be set in overwrite mode and mmap output.");
435 /* Init lttng session config */
436 ret
= config_init(session_name
);
450 ERR("%s", lttng_strerror(ret
));
456 * The 'create <options>' first level command
458 * Returns one of the CMD_* result constants.
460 int cmd_create(int argc
, const char **argv
)
462 int opt
, ret
= CMD_SUCCESS
;
463 char *opt_arg
= NULL
;
464 static poptContext pc
;
466 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
467 poptReadDefaultConfig(pc
, 0);
469 while ((opt
= poptGetNextOpt(pc
)) != -1) {
474 case OPT_LIST_OPTIONS
:
475 list_cmd_options(stdout
, long_options
);
482 opt_arg
= poptGetOptArg(pc
);
484 /* Set up default values. */
485 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
486 DBG("Session live timer interval set to default value %d",
491 v
= strtoul(opt_arg
, NULL
, 0);
492 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
493 ERR("Wrong value in --live parameter: %s", opt_arg
);
497 if (v
!= (uint32_t) v
) {
498 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
502 opt_live_timer
= (uint32_t) v
;
503 DBG("Session live timer interval set to %d", opt_live_timer
);
513 if (opt_no_consumer
) {
514 MSG("The option --no-consumer is obsolete. Use --no-output now.");
519 if (opt_disable_consumer
) {
520 MSG("The option --disable-consumer is obsolete.");
525 opt_session_name
= (char*) poptGetArg(pc
);
527 ret
= create_session();
This page took 0.043948 seconds and 5 git commands to generate.