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>
27 #include <common/compat/time.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 uint32_t opt_live_timer
;
54 #ifdef LTTNG_EMBED_HELP
55 static const char help_msg
[] =
56 #include <lttng-create.1.h>
66 static struct mi_writer
*writer
;
68 static struct poptOption long_options
[] = {
69 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
70 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
71 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
72 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
73 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
74 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
75 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
76 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
77 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
78 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
79 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
80 {"shm-path", 0, POPT_ARG_STRING
, &opt_shm_path
, 0, 0, 0},
85 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
86 * why this declaration exists and used ONLY in for this command.
88 extern int _lttng_create_session_ext(const char *name
, const char *url
,
89 const char *datetime
);
92 * Retrieve the created session and mi output it based on provided argument
93 * This is currently a summary of what was pretty printed and is subject to
96 static int mi_created_session(const char *session_name
)
98 int ret
, i
, count
, found
;
99 struct lttng_session
*sessions
;
101 /* session_name should not be null */
102 assert(session_name
);
105 count
= lttng_list_sessions(&sessions
);
108 ERR("%s", lttng_strerror(ret
));
113 ERR("Error session creation failed: session %s not found", session_name
);
114 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
119 for (i
= 0; i
< count
; i
++) {
120 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
122 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
131 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
143 * For a session name, set the consumer URLs.
145 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
146 const char *data_url
)
149 struct lttng_handle
*handle
;
151 assert(session_name
);
154 * Set handle with the session_name, but no domain. This implies that
155 * the actions taken with this handle apply on the tracing session
156 * rather then the domain-specific session.
158 handle
= lttng_create_handle(session_name
, NULL
);
159 if (handle
== NULL
) {
164 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
170 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
174 MSG("Data URL %s set for session %s", data_url
, session_name
);
178 lttng_destroy_handle(handle
);
182 static int add_snapshot_output(const char *session_name
, const char *ctrl_url
,
183 const char *data_url
)
186 struct lttng_snapshot_output
*output
= NULL
;
188 assert(session_name
);
190 output
= lttng_snapshot_output_create();
197 ret
= lttng_snapshot_output_set_ctrl_url(ctrl_url
, output
);
204 ret
= lttng_snapshot_output_set_data_url(data_url
, output
);
210 /* This call, if successful, populates the id of the output object. */
211 ret
= lttng_snapshot_add_output(session_name
, output
);
217 lttng_snapshot_output_destroy(output
);
223 * Create a tracing session.
224 * If no name is specified, a default name is generated.
226 * Returns one of the CMD_* result constants.
228 static int create_session(void)
231 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
232 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
233 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
236 char shm_path
[PATH_MAX
] = "";
238 /* Get date and time for automatic session name/path */
240 timeinfo
= localtime(&rawtime
);
241 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
243 /* Auto session name creation */
244 if (opt_session_name
== NULL
) {
245 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
246 DEFAULT_SESSION_NAME
"-%s", datetime
);
248 PERROR("snprintf session name");
251 session_name
= session_name_date
;
252 DBG("Auto session name set to %s", session_name_date
);
254 if (strlen(opt_session_name
) > NAME_MAX
) {
255 ERR("Session name too long. Length must be lower or equal to %d",
257 ret
= LTTNG_ERR_SESSION_FAIL
;
261 * Check if the session name begins with "auto-" or is exactly "auto".
262 * Both are reserved for the default session name. See bug #449 to
263 * understand why we need to check both here.
265 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
266 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
267 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
268 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
269 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
270 ERR("%s is a reserved keyword for default session(s)",
271 DEFAULT_SESSION_NAME
);
275 session_name
= opt_session_name
;
276 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
277 "%s-%s", session_name
, datetime
);
279 PERROR("snprintf session name");
284 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
285 ERR("You need both control and data URL.");
290 if (opt_output_path
!= NULL
) {
291 traces_path
= utils_expand_path(opt_output_path
);
292 if (traces_path
== NULL
) {
297 /* Create URL string from the local file system path */
298 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
300 PERROR("asprintf url path");
304 /* URL to use in the lttng_create_session() call */
306 print_str_url
= traces_path
;
307 } else if (opt_url
) { /* Handling URL (-U opt) */
310 } else if (opt_data_url
&& opt_ctrl_url
) {
312 * With both control and data, we'll be setting the consumer URL after
313 * session creation thus use no URL.
316 } else if (!opt_no_output
) {
319 /* Auto output path */
320 tmp_path
= utils_get_home_dir();
321 if (tmp_path
== NULL
) {
322 ERR("HOME path not found.\n \
323 Please specify an output path using -o, --output PATH");
327 alloc_path
= strdup(tmp_path
);
329 PERROR("allocating alloc_path");
333 ret
= asprintf(&alloc_url
,
334 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
335 alloc_path
, session_name_date
);
337 PERROR("asprintf trace dir name");
343 print_str_url
= alloc_url
+ strlen("file://");
345 /* No output means --no-output or --snapshot mode. */
349 /* Use default live URL if NO url is/are found. */
350 if ((opt_live_timer
&& !opt_url
) && (opt_live_timer
&& !opt_data_url
)) {
351 /* Override the url */
355 ret
= asprintf(&alloc_url
, "net://127.0.0.1");
357 PERROR("asprintf default live URL");
365 if (opt_snapshot
&& opt_live_timer
) {
366 ERR("Snapshot and live modes are mutually exclusive.");
372 /* No output by default. */
373 const char *snapshot_url
= NULL
;
377 } else if (!opt_data_url
&& !opt_ctrl_url
) {
378 /* This is the session path that we need to use as output. */
381 ret
= lttng_create_session_snapshot(session_name
, snapshot_url
);
382 } else if (opt_live_timer
) {
383 const char *pathname
;
385 if (opt_relayd_path
) {
386 pathname
= opt_relayd_path
;
388 pathname
= INSTALL_BIN_PATH
"/lttng-relayd";
390 if (!opt_url
&& !opt_data_url
&& !check_relayd() &&
391 spawn_relayd(pathname
, 0) < 0) {
394 ret
= lttng_create_session_live(session_name
, url
, opt_live_timer
);
396 ret
= _lttng_create_session_ext(session_name
, url
, datetime
);
399 /* Don't set ret so lttng can interpret the sessiond error. */
401 case LTTNG_ERR_EXIST_SESS
:
402 WARN("Session %s already exists", session_name
);
410 if (opt_ctrl_url
&& opt_data_url
) {
412 ret
= add_snapshot_output(session_name
, opt_ctrl_url
,
415 /* Setting up control URI (-C or/and -D opt) */
416 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
419 /* Destroy created session because the URL are not valid. */
420 lttng_destroy_session(session_name
);
426 ret
= snprintf(shm_path
, sizeof(shm_path
),
427 "%s/%s", opt_shm_path
, session_name_date
);
429 PERROR("snprintf shm_path");
433 ret
= lttng_set_session_shm_path(session_name
, shm_path
);
435 lttng_destroy_session(session_name
);
440 MSG("Session %s created.", session_name
);
441 if (print_str_url
&& !opt_snapshot
) {
442 MSG("Traces will be written in %s", print_str_url
);
444 if (opt_live_timer
) {
445 MSG("Live timer set to %u usec", opt_live_timer
);
447 } else if (opt_snapshot
) {
449 MSG("Default snapshot output set to: %s", print_str_url
);
451 MSG("Snapshot mode set. Every channel enabled for that session will "
452 "be set to mmap output, and default to overwrite mode.");
455 MSG("Session %s set to shm_path: %s.", session_name
,
461 ret
= mi_created_session(session_name
);
468 /* Init lttng session config */
469 ret
= config_init(session_name
);
483 ERR("%s", lttng_strerror(ret
));
491 * Spawn a session daemon by forking and execv.
493 static int spawn_sessiond(char *pathname
)
498 MSG("Spawning a session daemon");
502 * Spawn session daemon in daemon mode.
504 execlp(pathname
, "lttng-sessiond",
505 "--daemonize", NULL
);
506 /* execlp only returns if error happened */
507 if (errno
== ENOENT
) {
508 ERR("No session daemon found. Use --sessiond-path.");
512 kill(getppid(), SIGTERM
); /* wake parent */
514 } else if (pid
> 0) {
516 * In daemon mode (--daemonize), sessiond only exits when
517 * it's ready to accept commands.
521 pid_t wait_pid_ret
= waitpid(pid
, &status
, 0);
523 if (wait_pid_ret
< 0) {
524 if (errno
== EINTR
) {
532 if (WIFSIGNALED(status
)) {
533 ERR("Session daemon was killed by signal %d",
537 } else if (WIFEXITED(status
)) {
538 DBG("Session daemon terminated normally (exit status: %d)",
539 WEXITSTATUS(status
));
541 if (WEXITSTATUS(status
) != 0) {
542 ERR("Session daemon terminated with an error (exit status: %d)",
543 WEXITSTATUS(status
));
565 * Check if the session daemon is available using
566 * the liblttngctl API for the check. If not, try to
569 static int launch_sessiond(void)
572 char *pathname
= NULL
;
574 ret
= lttng_session_daemon_alive();
576 /* Sessiond is alive, not an error */
581 /* Try command line option path */
582 pathname
= opt_sessiond_path
;
584 /* Try LTTNG_SESSIOND_PATH env variable */
585 if (pathname
== NULL
) {
586 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
589 /* Try with configured path */
590 if (pathname
== NULL
) {
591 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
592 pathname
= CONFIG_SESSIOND_BIN
;
596 /* Try the default path */
597 if (pathname
== NULL
) {
598 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
601 DBG("Session daemon binary path: %s", pathname
);
603 /* Check existence and permissions */
604 ret
= access(pathname
, F_OK
| X_OK
);
606 ERR("No such file or access denied: %s", pathname
);
610 ret
= spawn_sessiond(pathname
);
613 ERR("Problem occurred while launching session daemon (%s)",
620 * The 'create <options>' first level command
622 * Returns one of the CMD_* result constants.
624 int cmd_create(int argc
, const char **argv
)
626 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
627 char *opt_arg
= NULL
;
628 const char *leftover
= NULL
;
629 static poptContext pc
;
631 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
632 poptReadDefaultConfig(pc
, 0);
634 while ((opt
= poptGetNextOpt(pc
)) != -1) {
639 case OPT_LIST_OPTIONS
:
640 list_cmd_options(stdout
, long_options
);
647 opt_arg
= poptGetOptArg(pc
);
649 /* Set up default values. */
650 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
651 DBG("Session live timer interval set to default value %d",
656 if (utils_parse_time_suffix(opt_arg
, &v
) < 0) {
657 ERR("Wrong value for --live parameter: %s", opt_arg
);
662 if (v
!= (uint32_t) v
) {
663 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
669 ERR("Live timer interval must be greater than zero");
674 opt_live_timer
= (uint32_t) v
;
675 DBG("Session live timer interval set to %d", opt_live_timer
);
684 if (opt_no_consumer
) {
685 MSG("The option --no-consumer is obsolete. Use --no-output now.");
690 /* Spawn a session daemon if needed */
691 if (!opt_no_sessiond
) {
692 ret
= launch_sessiond();
699 /* MI initialization */
701 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
703 ret
= -LTTNG_ERR_NOMEM
;
707 /* Open command element */
708 ret
= mi_lttng_writer_command_open(writer
,
709 mi_lttng_element_command_create
);
715 /* Open output element */
716 ret
= mi_lttng_writer_open_element(writer
,
717 mi_lttng_element_command_output
);
723 opt_session_name
= (char*) poptGetArg(pc
);
725 leftover
= poptGetArg(pc
);
727 ERR("Unknown argument: %s", leftover
);
732 command_ret
= create_session();
738 /* Close output element */
739 ret
= mi_lttng_writer_close_element(writer
);
746 ret
= mi_lttng_writer_write_element_bool(writer
,
747 mi_lttng_element_command_success
, success
);
753 /* Command element close */
754 ret
= mi_lttng_writer_command_close(writer
);
763 if (writer
&& mi_lttng_writer_destroy(writer
)) {
764 /* Preserve original error code */
765 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
768 /* Overwrite ret if an error occurred in create_session() */
769 ret
= command_ret
? command_ret
: ret
;