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.
27 #include <sys/types.h>
32 #include <common/mi-lttng.h>
34 #include "../command.h"
37 #include <common/defaults.h>
38 #include <common/sessiond-comm/sessiond-comm.h>
39 #include <common/uri.h>
40 #include <common/utils.h>
41 #include <lttng/snapshot.h>
43 static char *opt_output_path
;
44 static char *opt_session_name
;
46 static char *opt_ctrl_url
;
47 static char *opt_data_url
;
48 static char *opt_shm_path
;
49 static int opt_no_consumer
;
50 static int opt_no_output
;
51 static int opt_snapshot
;
52 static unsigned int opt_live_timer
;
60 static struct mi_writer
*writer
;
62 static struct poptOption long_options
[] = {
63 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
64 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
65 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
66 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
67 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
68 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
69 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
70 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
71 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
72 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
73 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
74 {"shm-path", 0, POPT_ARG_STRING
, &opt_shm_path
, 0, 0, 0},
79 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
80 * why this declaration exists and used ONLY in for this command.
82 extern int _lttng_create_session_ext(const char *name
, const char *url
,
83 const char *datetime
, int live_timer
);
88 static void usage(FILE *ofp
)
90 fprintf(ofp
, "usage: lttng create [NAME] [OPTIONS] \n");
92 fprintf(ofp
, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
94 fprintf(ofp
, "Options:\n");
95 fprintf(ofp
, " -h, --help Show this help\n");
96 fprintf(ofp
, " --list-options Simple listing of options\n");
97 fprintf(ofp
, " -o, --output PATH Specify output path for traces\n");
98 fprintf(ofp
, " --no-output Traces will not be outputted\n");
99 fprintf(ofp
, " --snapshot Set the session in snapshot mode.\n");
100 fprintf(ofp
, " Created in no-output mode and uses the URL,\n");
101 fprintf(ofp
, " if one, as the default snapshot output.\n");
102 fprintf(ofp
, " Every channel will be set in overwrite mode\n");
103 fprintf(ofp
, " and with mmap output (splice not supported).\n");
104 fprintf(ofp
, " --live [USEC] Set the session in live-reading mode.\n");
105 fprintf(ofp
, " The delay parameter in micro-seconds is the\n");
106 fprintf(ofp
, " maximum time the user can wait for the data\n");
107 fprintf(ofp
, " to be flushed. Can be set with a network\n");
108 fprintf(ofp
, " URL (-U or -C/-D) and must have a relayd listening.\n");
109 fprintf(ofp
, " By default, %u is used for the timer and the\n",
110 DEFAULT_LTTNG_LIVE_TIMER
);
111 fprintf(ofp
, " network URL is set to net://127.0.0.1.\n");
112 fprintf(ofp
, " --shm-path PATH Path where shared memory holding buffers\n");
113 fprintf(ofp
, " should be created. Useful when used with pramfs\n");
114 fprintf(ofp
, " to extract trace data after crash.\n");
116 fprintf(ofp
, "Extended Options:\n");
118 fprintf(ofp
, "Using these options, each API call can be controlled individually.\n");
120 fprintf(ofp
, " -U, --set-url=URL Set URL destination of the trace data.\n");
121 fprintf(ofp
, " It is persistent for the session lifetime.\n");
122 fprintf(ofp
, " This will set both data and control URL.\n");
123 fprintf(ofp
, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n");
124 fprintf(ofp
, " -D, --data-url=URL Set data path URL. (Must use -C also)\n");
126 fprintf(ofp
, "Please refer to the man page (lttng(1)) for more information on network\n");
127 fprintf(ofp
, "streaming mechanisms and explanation of the control and data port\n");
128 fprintf(ofp
, "You must have a running remote lttng-relayd for network streaming\n");
130 fprintf(ofp
, "URL format is has followed:\n");
132 fprintf(ofp
, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
134 fprintf(ofp
, " Supported protocols are (proto):\n");
135 fprintf(ofp
, " > file://...\n");
136 fprintf(ofp
, " Local filesystem full path.\n");
138 fprintf(ofp
, " > net[6]://...\n");
139 fprintf(ofp
, " This will use the default network transport layer which is\n");
140 fprintf(ofp
, " TCP for both control (PORT1) and data port (PORT2).\n");
141 fprintf(ofp
, " The default ports are respectively 5342 and 5343.\n");
143 fprintf(ofp
, " > tcp[6]://...\n");
144 fprintf(ofp
, " Can only be used with -C and -D together\n");
146 fprintf(ofp
, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
148 fprintf(ofp
, "Examples:\n");
149 fprintf(ofp
, " # lttng create -U net://192.168.1.42\n");
150 fprintf(ofp
, " Uses TCP and default ports for the given destination.\n");
151 fprintf(ofp
, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
152 fprintf(ofp
, " Uses TCP, default ports and IPv6.\n");
153 fprintf(ofp
, " # lttng create s1 -U net://myhost.com:3229\n");
154 fprintf(ofp
, " Set the consumer to the remote HOST on port 3229 for control.\n");
159 * Retrieve the created session and mi output it based on provided argument
160 * This is currently a summary of what was pretty printed and is subject to
163 static int mi_created_session(const char *session_name
)
165 int ret
, i
, count
, found
;
166 struct lttng_session
*sessions
;
168 /* session_name should not be null */
169 assert(session_name
);
172 count
= lttng_list_sessions(&sessions
);
175 ERR("%s", lttng_strerror(ret
));
180 ERR("Error session creation failed: session %s not found", session_name
);
181 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
186 for (i
= 0; i
< count
; i
++) {
187 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
189 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
198 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
210 * For a session name, set the consumer URLs.
212 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
213 const char *data_url
)
216 struct lttng_handle
*handle
;
217 struct lttng_domain dom
;
219 assert(session_name
);
222 * Set handle with the session name and the domain set to 0. This means to
223 * the session daemon that the next action applies on the tracing session
224 * rather then the domain specific session.
226 memset(&dom
, 0, sizeof(dom
));
228 handle
= lttng_create_handle(session_name
, &dom
);
229 if (handle
== NULL
) {
234 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
240 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
244 MSG("Data URL %s set for session %s", data_url
, session_name
);
248 lttng_destroy_handle(handle
);
252 static int add_snapshot_output(const char *session_name
, const char *ctrl_url
,
253 const char *data_url
)
256 struct lttng_snapshot_output
*output
= NULL
;
258 assert(session_name
);
260 output
= lttng_snapshot_output_create();
267 ret
= lttng_snapshot_output_set_ctrl_url(ctrl_url
, output
);
274 ret
= lttng_snapshot_output_set_data_url(data_url
, output
);
280 /* This call, if successful, populates the id of the output object. */
281 ret
= lttng_snapshot_add_output(session_name
, output
);
287 lttng_snapshot_output_destroy(output
);
293 * Create a tracing session.
294 * If no name is specified, a default name is generated.
296 * Returns one of the CMD_* result constants.
298 static int create_session(void)
301 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
302 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
303 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
306 char shm_path
[PATH_MAX
] = "";
308 /* Get date and time for automatic session name/path */
310 timeinfo
= localtime(&rawtime
);
311 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
313 /* Auto session name creation */
314 if (opt_session_name
== NULL
) {
315 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
316 DEFAULT_SESSION_NAME
"-%s", datetime
);
318 PERROR("snprintf session name");
321 session_name
= session_name_date
;
322 DBG("Auto session name set to %s", session_name_date
);
324 if (strlen(opt_session_name
) > NAME_MAX
) {
325 ERR("Session name too long. Length must be lower or equal to %d",
327 ret
= LTTNG_ERR_SESSION_FAIL
;
331 * Check if the session name begins with "auto-" or is exactly "auto".
332 * Both are reserved for the default session name. See bug #449 to
333 * understand why we need to check both here.
335 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
336 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
337 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
338 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
339 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
340 ERR("%s is a reserved keyword for default session(s)",
341 DEFAULT_SESSION_NAME
);
345 session_name
= opt_session_name
;
346 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
347 "%s-%s", session_name
, datetime
);
349 PERROR("snprintf session name");
354 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
355 ERR("You need both control and data URL.");
360 if (opt_output_path
!= NULL
) {
361 traces_path
= utils_expand_path(opt_output_path
);
362 if (traces_path
== NULL
) {
367 /* Create URL string from the local file system path */
368 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
370 PERROR("asprintf url path");
374 /* URL to use in the lttng_create_session() call */
376 print_str_url
= traces_path
;
377 } else if (opt_url
) { /* Handling URL (-U opt) */
380 } else if (opt_data_url
&& opt_ctrl_url
) {
382 * With both control and data, we'll be setting the consumer URL after
383 * session creation thus use no URL.
386 } else if (!opt_no_output
) {
389 /* Auto output path */
390 tmp_path
= utils_get_home_dir();
391 if (tmp_path
== NULL
) {
392 ERR("HOME path not found.\n \
393 Please specify an output path using -o, --output PATH");
397 alloc_path
= strdup(tmp_path
);
399 PERROR("allocating alloc_path");
403 ret
= asprintf(&alloc_url
,
404 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
405 alloc_path
, session_name_date
);
407 PERROR("asprintf trace dir name");
413 print_str_url
= alloc_url
+ strlen("file://");
415 /* No output means --no-output or --snapshot mode. */
419 /* Use default live URL if NO url is/are found. */
420 if ((opt_live_timer
&& !opt_url
) && (opt_live_timer
&& !opt_data_url
)) {
421 ret
= asprintf(&alloc_url
, "net://127.0.0.1");
423 PERROR("asprintf default live URL");
431 if (opt_snapshot
&& opt_live_timer
) {
432 ERR("Snapshot and live modes are mutually exclusive.");
438 /* No output by default. */
439 const char *snapshot_url
= NULL
;
443 } else if (!opt_data_url
&& !opt_ctrl_url
) {
444 /* This is the session path that we need to use as output. */
447 ret
= lttng_create_session_snapshot(session_name
, snapshot_url
);
448 } else if (opt_live_timer
) {
449 const char *pathname
;
451 if (opt_relayd_path
) {
452 pathname
= opt_relayd_path
;
454 pathname
= INSTALL_BIN_PATH
"/lttng-relayd";
456 if (!opt_url
&& !opt_data_url
&& !check_relayd() &&
457 spawn_relayd(pathname
, 0) < 0) {
460 ret
= lttng_create_session_live(session_name
, url
, opt_live_timer
);
462 ret
= _lttng_create_session_ext(session_name
, url
, datetime
, -1);
465 /* Don't set ret so lttng can interpret the sessiond error. */
467 case LTTNG_ERR_EXIST_SESS
:
468 WARN("Session %s already exists", session_name
);
476 if (opt_ctrl_url
&& opt_data_url
) {
478 ret
= add_snapshot_output(session_name
, opt_ctrl_url
,
481 /* Setting up control URI (-C or/and -D opt) */
482 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
485 /* Destroy created session because the URL are not valid. */
486 lttng_destroy_session(session_name
);
492 ret
= snprintf(shm_path
, sizeof(shm_path
),
493 "%s/%s", opt_shm_path
, session_name_date
);
495 PERROR("snprintf shm_path");
499 ret
= lttng_set_session_shm_path(session_name
, shm_path
);
501 lttng_destroy_session(session_name
);
506 MSG("Session %s created.", session_name
);
507 if (print_str_url
&& !opt_snapshot
) {
508 MSG("Traces will be written in %s", print_str_url
);
510 if (opt_live_timer
) {
511 MSG("Live timer set to %u usec", opt_live_timer
);
513 } else if (opt_snapshot
) {
515 MSG("Default snapshot output set to: %s", print_str_url
);
517 MSG("Snapshot mode set. Every channel enabled for that session will "
518 "be set in overwrite mode and mmap output.");
521 MSG("Session %s set to shm_path: %s.", session_name
,
527 ret
= mi_created_session(session_name
);
534 /* Init lttng session config */
535 ret
= config_init(session_name
);
549 ERR("%s", lttng_strerror(ret
));
557 * Spawn a session daemon by forking and execv.
559 static int spawn_sessiond(char *pathname
)
564 MSG("Spawning a session daemon");
565 recv_child_signal
= 0;
569 * Spawn session daemon and tell
570 * it to signal us when ready.
572 execlp(pathname
, "lttng-sessiond", "--sig-parent", "--quiet", NULL
);
573 /* execlp only returns if error happened */
574 if (errno
== ENOENT
) {
575 ERR("No session daemon found. Use --sessiond-path.");
579 kill(getppid(), SIGTERM
); /* wake parent */
581 } else if (pid
> 0) {
584 * Wait for lttng-sessiond to start. We need to use a flag to check if
585 * the signal has been sent to us, because the child can be scheduled
586 * before the parent, and thus send the signal before this check. In
587 * the signal handler, we set the recv_child_signal flag, so anytime we
588 * check it after the fork is fine. Note that sleep() is interrupted
589 * before the 1 second delay as soon as the signal is received, so it
590 * will not cause visible delay for the user.
592 while (!recv_child_signal
) {
596 * The signal handler will nullify sessiond_pid on SIGCHLD
615 * Check if the session daemon is available using
616 * the liblttngctl API for the check. If not, try to
619 static int launch_sessiond(void)
622 char *pathname
= NULL
;
624 ret
= lttng_session_daemon_alive();
626 /* Sessiond is alive, not an error */
631 /* Try command line option path */
632 pathname
= opt_sessiond_path
;
634 /* Try LTTNG_SESSIOND_PATH env variable */
635 if (pathname
== NULL
) {
636 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
639 /* Try with configured path */
640 if (pathname
== NULL
) {
641 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
642 pathname
= CONFIG_SESSIOND_BIN
;
646 /* Try the default path */
647 if (pathname
== NULL
) {
648 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
651 DBG("Session daemon binary path: %s", pathname
);
653 /* Check existence and permissions */
654 ret
= access(pathname
, F_OK
| X_OK
);
656 ERR("No such file or access denied: %s", pathname
);
660 ret
= spawn_sessiond(pathname
);
662 ERR("Problem occurred when starting %s", pathname
);
669 * The 'create <options>' first level command
671 * Returns one of the CMD_* result constants.
673 int cmd_create(int argc
, const char **argv
)
675 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
676 char *opt_arg
= NULL
;
677 static poptContext pc
;
679 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
680 poptReadDefaultConfig(pc
, 0);
682 while ((opt
= poptGetNextOpt(pc
)) != -1) {
687 case OPT_LIST_OPTIONS
:
688 list_cmd_options(stdout
, long_options
);
695 opt_arg
= poptGetOptArg(pc
);
697 /* Set up default values. */
698 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
699 DBG("Session live timer interval set to default value %d",
704 v
= strtoul(opt_arg
, NULL
, 0);
705 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
706 ERR("Wrong value in --live parameter: %s", opt_arg
);
710 if (v
!= (uint32_t) v
) {
711 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
716 ERR("Live timer interval must be greater than zero");
720 opt_live_timer
= (uint32_t) v
;
721 DBG("Session live timer interval set to %d", opt_live_timer
);
731 if (opt_no_consumer
) {
732 MSG("The option --no-consumer is obsolete. Use --no-output now.");
737 /* Spawn a session daemon if needed */
738 if (!opt_no_sessiond
) {
739 ret
= launch_sessiond();
746 /* MI initialization */
748 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
750 ret
= -LTTNG_ERR_NOMEM
;
754 /* Open command element */
755 ret
= mi_lttng_writer_command_open(writer
,
756 mi_lttng_element_command_create
);
762 /* Open output element */
763 ret
= mi_lttng_writer_open_element(writer
,
764 mi_lttng_element_command_output
);
770 opt_session_name
= (char*) poptGetArg(pc
);
772 command_ret
= create_session();
778 /* Close output element */
779 ret
= mi_lttng_writer_close_element(writer
);
786 ret
= mi_lttng_writer_write_element_bool(writer
,
787 mi_lttng_element_command_success
, success
);
793 /* Command element close */
794 ret
= mi_lttng_writer_command_close(writer
);
803 if (writer
&& mi_lttng_writer_destroy(writer
)) {
804 /* Preserve original error code */
805 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
808 /* Overwrite ret if an error occurred in create_session() */
809 ret
= command_ret
? command_ret
: ret
;