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>
33 #include <common/mi-lttng.h>
35 #include "../command.h"
38 #include <common/defaults.h>
39 #include <common/sessiond-comm/sessiond-comm.h>
40 #include <common/uri.h>
41 #include <common/utils.h>
42 #include <lttng/snapshot.h>
44 static char *opt_output_path
;
45 static char *opt_session_name
;
47 static char *opt_ctrl_url
;
48 static char *opt_data_url
;
49 static char *opt_shm_path
;
50 static int opt_no_consumer
;
51 static int opt_no_output
;
52 static int opt_snapshot
;
53 static unsigned int opt_live_timer
;
61 static struct mi_writer
*writer
;
63 static struct poptOption long_options
[] = {
64 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
65 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
66 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
67 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
68 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
69 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
70 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
71 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
72 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
73 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
74 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
75 {"shm-path", 0, POPT_ARG_STRING
, &opt_shm_path
, 0, 0, 0},
80 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
81 * why this declaration exists and used ONLY in for this command.
83 extern int _lttng_create_session_ext(const char *name
, const char *url
,
84 const char *datetime
);
89 static void usage(FILE *ofp
)
91 fprintf(ofp
, "usage: lttng create [NAME] [OPTIONS] \n");
93 fprintf(ofp
, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
95 fprintf(ofp
, "Options:\n");
96 fprintf(ofp
, " -h, --help Show this help\n");
97 fprintf(ofp
, " --list-options Simple listing of options\n");
98 fprintf(ofp
, " -o, --output PATH Specify output path for traces\n");
99 fprintf(ofp
, " --no-output Traces will not be outputted\n");
100 fprintf(ofp
, " --snapshot Set the session in snapshot mode.\n");
101 fprintf(ofp
, " Created in no-output mode and uses the URL,\n");
102 fprintf(ofp
, " if one, as the default snapshot output.\n");
103 fprintf(ofp
, " Every channel will be set in overwrite mode\n");
104 fprintf(ofp
, " and with mmap output (splice not supported).\n");
105 fprintf(ofp
, " --live [USEC] Set the session in live-reading mode.\n");
106 fprintf(ofp
, " The delay parameter in micro-seconds is the\n");
107 fprintf(ofp
, " maximum time the user can wait for the data\n");
108 fprintf(ofp
, " to be flushed. Can be set with a network\n");
109 fprintf(ofp
, " URL (-U or -C/-D) and must have a relayd listening.\n");
110 fprintf(ofp
, " By default, %u is used for the timer and the\n",
111 DEFAULT_LTTNG_LIVE_TIMER
);
112 fprintf(ofp
, " network URL is set to net://127.0.0.1.\n");
113 fprintf(ofp
, " --shm-path PATH Path where shared memory holding buffers\n");
114 fprintf(ofp
, " should be created. Useful when used with pramfs\n");
115 fprintf(ofp
, " to extract trace data after crash.\n");
117 fprintf(ofp
, "Extended Options:\n");
119 fprintf(ofp
, "Using these options, each API call can be controlled individually.\n");
121 fprintf(ofp
, " -U, --set-url=URL Set URL destination of the trace data.\n");
122 fprintf(ofp
, " It is persistent for the session lifetime.\n");
123 fprintf(ofp
, " This will set both data and control URL.\n");
124 fprintf(ofp
, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n");
125 fprintf(ofp
, " -D, --data-url=URL Set data path URL. (Must use -C also)\n");
127 fprintf(ofp
, "Please refer to the man page (lttng(1)) for more information on network\n");
128 fprintf(ofp
, "streaming mechanisms and explanation of the control and data port\n");
129 fprintf(ofp
, "You must have a running remote lttng-relayd for network streaming\n");
131 fprintf(ofp
, "URL format is has followed:\n");
133 fprintf(ofp
, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
135 fprintf(ofp
, " Supported protocols are (proto):\n");
136 fprintf(ofp
, " > file://...\n");
137 fprintf(ofp
, " Local filesystem full path.\n");
139 fprintf(ofp
, " > net[6]://...\n");
140 fprintf(ofp
, " This will use the default network transport layer which is\n");
141 fprintf(ofp
, " TCP for both control (PORT1) and data port (PORT2).\n");
142 fprintf(ofp
, " The default ports are respectively 5342 and 5343.\n");
144 fprintf(ofp
, " > tcp[6]://...\n");
145 fprintf(ofp
, " Can only be used with -C and -D together\n");
147 fprintf(ofp
, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
149 fprintf(ofp
, "Examples:\n");
150 fprintf(ofp
, " # lttng create -U net://192.168.1.42\n");
151 fprintf(ofp
, " Uses TCP and default ports for the given destination.\n");
152 fprintf(ofp
, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
153 fprintf(ofp
, " Uses TCP, default ports and IPv6.\n");
154 fprintf(ofp
, " # lttng create s1 -U net://myhost.com:3229\n");
155 fprintf(ofp
, " Set the consumer to the remote HOST on port 3229 for control.\n");
160 * Retrieve the created session and mi output it based on provided argument
161 * This is currently a summary of what was pretty printed and is subject to
164 static int mi_created_session(const char *session_name
)
166 int ret
, i
, count
, found
;
167 struct lttng_session
*sessions
;
169 /* session_name should not be null */
170 assert(session_name
);
173 count
= lttng_list_sessions(&sessions
);
176 ERR("%s", lttng_strerror(ret
));
181 ERR("Error session creation failed: session %s not found", session_name
);
182 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
187 for (i
= 0; i
< count
; i
++) {
188 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
190 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
199 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
211 * For a session name, set the consumer URLs.
213 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
214 const char *data_url
)
217 struct lttng_handle
*handle
;
219 assert(session_name
);
222 * Set handle with the session_name, but no domain. This implies that
223 * the actions taken with this handle apply on the tracing session
224 * rather then the domain-specific session.
226 handle
= lttng_create_handle(session_name
, NULL
);
227 if (handle
== NULL
) {
232 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
238 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
242 MSG("Data URL %s set for session %s", data_url
, session_name
);
246 lttng_destroy_handle(handle
);
250 static int add_snapshot_output(const char *session_name
, const char *ctrl_url
,
251 const char *data_url
)
254 struct lttng_snapshot_output
*output
= NULL
;
256 assert(session_name
);
258 output
= lttng_snapshot_output_create();
265 ret
= lttng_snapshot_output_set_ctrl_url(ctrl_url
, output
);
272 ret
= lttng_snapshot_output_set_data_url(data_url
, output
);
278 /* This call, if successful, populates the id of the output object. */
279 ret
= lttng_snapshot_add_output(session_name
, output
);
285 lttng_snapshot_output_destroy(output
);
291 * Create a tracing session.
292 * If no name is specified, a default name is generated.
294 * Returns one of the CMD_* result constants.
296 static int create_session(void)
299 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
300 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
301 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
304 char shm_path
[PATH_MAX
] = "";
306 /* Get date and time for automatic session name/path */
308 timeinfo
= localtime(&rawtime
);
309 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
311 /* Auto session name creation */
312 if (opt_session_name
== NULL
) {
313 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
314 DEFAULT_SESSION_NAME
"-%s", datetime
);
316 PERROR("snprintf session name");
319 session_name
= session_name_date
;
320 DBG("Auto session name set to %s", session_name_date
);
322 if (strlen(opt_session_name
) > NAME_MAX
) {
323 ERR("Session name too long. Length must be lower or equal to %d",
325 ret
= LTTNG_ERR_SESSION_FAIL
;
329 * Check if the session name begins with "auto-" or is exactly "auto".
330 * Both are reserved for the default session name. See bug #449 to
331 * understand why we need to check both here.
333 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
334 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
335 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
336 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
337 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
338 ERR("%s is a reserved keyword for default session(s)",
339 DEFAULT_SESSION_NAME
);
343 session_name
= opt_session_name
;
344 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
345 "%s-%s", session_name
, datetime
);
347 PERROR("snprintf session name");
352 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
353 ERR("You need both control and data URL.");
358 if (opt_output_path
!= NULL
) {
359 traces_path
= utils_expand_path(opt_output_path
);
360 if (traces_path
== NULL
) {
365 /* Create URL string from the local file system path */
366 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
368 PERROR("asprintf url path");
372 /* URL to use in the lttng_create_session() call */
374 print_str_url
= traces_path
;
375 } else if (opt_url
) { /* Handling URL (-U opt) */
378 } else if (opt_data_url
&& opt_ctrl_url
) {
380 * With both control and data, we'll be setting the consumer URL after
381 * session creation thus use no URL.
384 } else if (!opt_no_output
) {
387 /* Auto output path */
388 tmp_path
= utils_get_home_dir();
389 if (tmp_path
== NULL
) {
390 ERR("HOME path not found.\n \
391 Please specify an output path using -o, --output PATH");
395 alloc_path
= strdup(tmp_path
);
397 PERROR("allocating alloc_path");
401 ret
= asprintf(&alloc_url
,
402 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
403 alloc_path
, session_name_date
);
405 PERROR("asprintf trace dir name");
411 print_str_url
= alloc_url
+ strlen("file://");
413 /* No output means --no-output or --snapshot mode. */
417 /* Use default live URL if NO url is/are found. */
418 if ((opt_live_timer
&& !opt_url
) && (opt_live_timer
&& !opt_data_url
)) {
419 ret
= asprintf(&alloc_url
, "net://127.0.0.1");
421 PERROR("asprintf default live URL");
429 if (opt_snapshot
&& opt_live_timer
) {
430 ERR("Snapshot and live modes are mutually exclusive.");
436 /* No output by default. */
437 const char *snapshot_url
= NULL
;
441 } else if (!opt_data_url
&& !opt_ctrl_url
) {
442 /* This is the session path that we need to use as output. */
445 ret
= lttng_create_session_snapshot(session_name
, snapshot_url
);
446 } else if (opt_live_timer
) {
447 const char *pathname
;
449 if (opt_relayd_path
) {
450 pathname
= opt_relayd_path
;
452 pathname
= INSTALL_BIN_PATH
"/lttng-relayd";
454 if (!opt_url
&& !opt_data_url
&& !check_relayd() &&
455 spawn_relayd(pathname
, 0) < 0) {
458 ret
= lttng_create_session_live(session_name
, url
, opt_live_timer
);
460 ret
= _lttng_create_session_ext(session_name
, url
, datetime
);
463 /* Don't set ret so lttng can interpret the sessiond error. */
465 case LTTNG_ERR_EXIST_SESS
:
466 WARN("Session %s already exists", session_name
);
474 if (opt_ctrl_url
&& opt_data_url
) {
476 ret
= add_snapshot_output(session_name
, opt_ctrl_url
,
479 /* Setting up control URI (-C or/and -D opt) */
480 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
483 /* Destroy created session because the URL are not valid. */
484 lttng_destroy_session(session_name
);
490 ret
= snprintf(shm_path
, sizeof(shm_path
),
491 "%s/%s", opt_shm_path
, session_name_date
);
493 PERROR("snprintf shm_path");
497 ret
= lttng_set_session_shm_path(session_name
, shm_path
);
499 lttng_destroy_session(session_name
);
504 MSG("Session %s created.", session_name
);
505 if (print_str_url
&& !opt_snapshot
) {
506 MSG("Traces will be written in %s", print_str_url
);
508 if (opt_live_timer
) {
509 MSG("Live timer set to %u usec", opt_live_timer
);
511 } else if (opt_snapshot
) {
513 MSG("Default snapshot output set to: %s", print_str_url
);
515 MSG("Snapshot mode set. Every channel enabled for that session will "
516 "be set in overwrite mode and mmap output.");
519 MSG("Session %s set to shm_path: %s.", session_name
,
525 ret
= mi_created_session(session_name
);
532 /* Init lttng session config */
533 ret
= config_init(session_name
);
547 ERR("%s", lttng_strerror(ret
));
555 * Spawn a session daemon by forking and execv.
557 static int spawn_sessiond(char *pathname
)
562 MSG("Spawning a session daemon");
566 * Spawn session daemon in daemon mode.
568 execlp(pathname
, "lttng-sessiond",
569 "--daemonize", NULL
);
570 /* execlp only returns if error happened */
571 if (errno
== ENOENT
) {
572 ERR("No session daemon found. Use --sessiond-path.");
576 kill(getppid(), SIGTERM
); /* wake parent */
578 } else if (pid
> 0) {
580 * In daemon mode (--daemonize), sessiond only exits when
581 * it's ready to accept commands.
585 pid_t wait_pid_ret
= waitpid(pid
, &status
, 0);
587 if (wait_pid_ret
< 0) {
588 if (errno
== EINTR
) {
596 if (WIFSIGNALED(status
)) {
597 ERR("Session daemon was killed by signal %d",
601 } else if (WIFEXITED(status
)) {
602 DBG("Session daemon terminated normally (exit status: %d)",
603 WEXITSTATUS(status
));
605 if (WEXITSTATUS(status
) != 0) {
606 ERR("Session daemon terminated with an error (exit status: %d)",
607 WEXITSTATUS(status
));
629 * Check if the session daemon is available using
630 * the liblttngctl API for the check. If not, try to
633 static int launch_sessiond(void)
636 char *pathname
= NULL
;
638 ret
= lttng_session_daemon_alive();
640 /* Sessiond is alive, not an error */
645 /* Try command line option path */
646 pathname
= opt_sessiond_path
;
648 /* Try LTTNG_SESSIOND_PATH env variable */
649 if (pathname
== NULL
) {
650 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
653 /* Try with configured path */
654 if (pathname
== NULL
) {
655 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
656 pathname
= CONFIG_SESSIOND_BIN
;
660 /* Try the default path */
661 if (pathname
== NULL
) {
662 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
665 DBG("Session daemon binary path: %s", pathname
);
667 /* Check existence and permissions */
668 ret
= access(pathname
, F_OK
| X_OK
);
670 ERR("No such file or access denied: %s", pathname
);
674 ret
= spawn_sessiond(pathname
);
677 ERR("Problem occurred while launching session daemon (%s)",
684 * The 'create <options>' first level command
686 * Returns one of the CMD_* result constants.
688 int cmd_create(int argc
, const char **argv
)
690 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
691 char *opt_arg
= NULL
;
692 static poptContext pc
;
694 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
695 poptReadDefaultConfig(pc
, 0);
697 while ((opt
= poptGetNextOpt(pc
)) != -1) {
702 case OPT_LIST_OPTIONS
:
703 list_cmd_options(stdout
, long_options
);
710 opt_arg
= poptGetOptArg(pc
);
712 /* Set up default values. */
713 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
714 DBG("Session live timer interval set to default value %d",
719 v
= strtoul(opt_arg
, NULL
, 0);
720 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
721 ERR("Wrong value in --live parameter: %s", opt_arg
);
725 if (v
!= (uint32_t) v
) {
726 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
731 ERR("Live timer interval must be greater than zero");
735 opt_live_timer
= (uint32_t) v
;
736 DBG("Session live timer interval set to %d", opt_live_timer
);
746 if (opt_no_consumer
) {
747 MSG("The option --no-consumer is obsolete. Use --no-output now.");
752 /* Spawn a session daemon if needed */
753 if (!opt_no_sessiond
) {
754 ret
= launch_sessiond();
761 /* MI initialization */
763 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
765 ret
= -LTTNG_ERR_NOMEM
;
769 /* Open command element */
770 ret
= mi_lttng_writer_command_open(writer
,
771 mi_lttng_element_command_create
);
777 /* Open output element */
778 ret
= mi_lttng_writer_open_element(writer
,
779 mi_lttng_element_command_output
);
785 opt_session_name
= (char*) poptGetArg(pc
);
787 command_ret
= create_session();
793 /* Close output element */
794 ret
= mi_lttng_writer_close_element(writer
);
801 ret
= mi_lttng_writer_write_element_bool(writer
,
802 mi_lttng_element_command_success
, success
);
808 /* Command element close */
809 ret
= mi_lttng_writer_command_close(writer
);
818 if (writer
&& mi_lttng_writer_destroy(writer
)) {
819 /* Preserve original error code */
820 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
823 /* Overwrite ret if an error occurred in create_session() */
824 ret
= command_ret
? command_ret
: ret
;