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>
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
);
86 * Retrieve the created session and mi output it based on provided argument
87 * This is currently a summary of what was pretty printed and is subject to
90 static int mi_created_session(const char *session_name
)
92 int ret
, i
, count
, found
;
93 struct lttng_session
*sessions
;
95 /* session_name should not be null */
99 count
= lttng_list_sessions(&sessions
);
102 ERR("%s", lttng_strerror(ret
));
107 ERR("Error session creation failed: session %s not found", session_name
);
108 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
113 for (i
= 0; i
< count
; i
++) {
114 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
116 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
125 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
137 * For a session name, set the consumer URLs.
139 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
140 const char *data_url
)
143 struct lttng_handle
*handle
;
144 struct lttng_domain dom
;
146 assert(session_name
);
149 * Set handle with the session name and the domain set to 0. This means to
150 * the session daemon that the next action applies on the tracing session
151 * rather then the domain specific session.
153 memset(&dom
, 0, sizeof(dom
));
155 handle
= lttng_create_handle(session_name
, &dom
);
156 if (handle
== NULL
) {
161 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
167 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
171 MSG("Data URL %s set for session %s", data_url
, session_name
);
175 lttng_destroy_handle(handle
);
179 static int add_snapshot_output(const char *session_name
, const char *ctrl_url
,
180 const char *data_url
)
183 struct lttng_snapshot_output
*output
= NULL
;
185 assert(session_name
);
187 output
= lttng_snapshot_output_create();
194 ret
= lttng_snapshot_output_set_ctrl_url(ctrl_url
, output
);
201 ret
= lttng_snapshot_output_set_data_url(data_url
, output
);
207 /* This call, if successful, populates the id of the output object. */
208 ret
= lttng_snapshot_add_output(session_name
, output
);
214 lttng_snapshot_output_destroy(output
);
220 * Create a tracing session.
221 * If no name is specified, a default name is generated.
223 * Returns one of the CMD_* result constants.
225 static int create_session(void)
228 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
229 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
230 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
233 char shm_path
[PATH_MAX
] = "";
235 /* Get date and time for automatic session name/path */
237 timeinfo
= localtime(&rawtime
);
238 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
240 /* Auto session name creation */
241 if (opt_session_name
== NULL
) {
242 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
243 DEFAULT_SESSION_NAME
"-%s", datetime
);
245 PERROR("snprintf session name");
248 session_name
= session_name_date
;
249 DBG("Auto session name set to %s", session_name_date
);
251 if (strlen(opt_session_name
) > NAME_MAX
) {
252 ERR("Session name too long. Length must be lower or equal to %d",
254 ret
= LTTNG_ERR_SESSION_FAIL
;
258 * Check if the session name begins with "auto-" or is exactly "auto".
259 * Both are reserved for the default session name. See bug #449 to
260 * understand why we need to check both here.
262 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
263 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
264 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
265 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
266 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
267 ERR("%s is a reserved keyword for default session(s)",
268 DEFAULT_SESSION_NAME
);
272 session_name
= opt_session_name
;
273 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
274 "%s-%s", session_name
, datetime
);
276 PERROR("snprintf session name");
281 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
282 ERR("You need both control and data URL.");
287 if (opt_output_path
!= NULL
) {
288 traces_path
= utils_expand_path(opt_output_path
);
289 if (traces_path
== NULL
) {
294 /* Create URL string from the local file system path */
295 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
297 PERROR("asprintf url path");
301 /* URL to use in the lttng_create_session() call */
303 print_str_url
= traces_path
;
304 } else if (opt_url
) { /* Handling URL (-U opt) */
307 } else if (opt_data_url
&& opt_ctrl_url
) {
309 * With both control and data, we'll be setting the consumer URL after
310 * session creation thus use no URL.
313 } else if (!opt_no_output
) {
316 /* Auto output path */
317 tmp_path
= utils_get_home_dir();
318 if (tmp_path
== NULL
) {
319 ERR("HOME path not found.\n \
320 Please specify an output path using -o, --output PATH");
324 alloc_path
= strdup(tmp_path
);
326 PERROR("allocating alloc_path");
330 ret
= asprintf(&alloc_url
,
331 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
332 alloc_path
, session_name_date
);
334 PERROR("asprintf trace dir name");
340 print_str_url
= alloc_url
+ strlen("file://");
342 /* No output means --no-output or --snapshot mode. */
346 /* Use default live URL if NO url is/are found. */
347 if ((opt_live_timer
&& !opt_url
) && (opt_live_timer
&& !opt_data_url
)) {
348 ret
= asprintf(&alloc_url
, "net://127.0.0.1");
350 PERROR("asprintf default live URL");
358 if (opt_snapshot
&& opt_live_timer
) {
359 ERR("Snapshot and live modes are mutually exclusive.");
365 /* No output by default. */
366 const char *snapshot_url
= NULL
;
370 } else if (!opt_data_url
&& !opt_ctrl_url
) {
371 /* This is the session path that we need to use as output. */
374 ret
= lttng_create_session_snapshot(session_name
, snapshot_url
);
375 } else if (opt_live_timer
) {
376 const char *pathname
;
378 if (opt_relayd_path
) {
379 pathname
= opt_relayd_path
;
381 pathname
= INSTALL_BIN_PATH
"/lttng-relayd";
383 if (!opt_url
&& !opt_data_url
&& !check_relayd() &&
384 spawn_relayd(pathname
, 0) < 0) {
387 ret
= lttng_create_session_live(session_name
, url
, opt_live_timer
);
389 ret
= _lttng_create_session_ext(session_name
, url
, datetime
);
392 /* Don't set ret so lttng can interpret the sessiond error. */
394 case LTTNG_ERR_EXIST_SESS
:
395 WARN("Session %s already exists", session_name
);
403 if (opt_ctrl_url
&& opt_data_url
) {
405 ret
= add_snapshot_output(session_name
, opt_ctrl_url
,
408 /* Setting up control URI (-C or/and -D opt) */
409 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
412 /* Destroy created session because the URL are not valid. */
413 lttng_destroy_session(session_name
);
419 ret
= snprintf(shm_path
, sizeof(shm_path
),
420 "%s/%s", opt_shm_path
, session_name_date
);
422 PERROR("snprintf shm_path");
426 ret
= lttng_set_session_shm_path(session_name
, shm_path
);
428 lttng_destroy_session(session_name
);
433 MSG("Session %s created.", session_name
);
434 if (print_str_url
&& !opt_snapshot
) {
435 MSG("Traces will be written in %s", print_str_url
);
437 if (opt_live_timer
) {
438 MSG("Live timer set to %u usec", opt_live_timer
);
440 } else if (opt_snapshot
) {
442 MSG("Default snapshot output set to: %s", print_str_url
);
444 MSG("Snapshot mode set. Every channel enabled for that session will "
445 "be set in overwrite mode and mmap output.");
448 MSG("Session %s set to shm_path: %s.", session_name
,
454 ret
= mi_created_session(session_name
);
461 /* Init lttng session config */
462 ret
= config_init(session_name
);
476 ERR("%s", lttng_strerror(ret
));
484 * Spawn a session daemon by forking and execv.
486 static int spawn_sessiond(char *pathname
)
491 MSG("Spawning a session daemon");
495 * Spawn session daemon in daemon mode.
497 execlp(pathname
, "lttng-sessiond",
498 "--daemonize", NULL
);
499 /* execlp only returns if error happened */
500 if (errno
== ENOENT
) {
501 ERR("No session daemon found. Use --sessiond-path.");
505 kill(getppid(), SIGTERM
); /* wake parent */
507 } else if (pid
> 0) {
509 * In daemon mode (--daemonize), sessiond only exits when
510 * it's ready to accept commands.
514 pid_t wait_pid_ret
= waitpid(pid
, &status
, 0);
516 if (wait_pid_ret
< 0) {
517 if (errno
== EINTR
) {
525 if (WIFSIGNALED(status
)) {
526 ERR("Session daemon was killed by signal %d",
530 } else if (WIFEXITED(status
)) {
531 DBG("Session daemon terminated normally (exit status: %d)",
532 WEXITSTATUS(status
));
534 if (WEXITSTATUS(status
) != 0) {
535 ERR("Session daemon terminated with an error (exit status: %d)",
536 WEXITSTATUS(status
));
558 * Check if the session daemon is available using
559 * the liblttngctl API for the check. If not, try to
562 static int launch_sessiond(void)
565 char *pathname
= NULL
;
567 ret
= lttng_session_daemon_alive();
569 /* Sessiond is alive, not an error */
574 /* Try command line option path */
575 pathname
= opt_sessiond_path
;
577 /* Try LTTNG_SESSIOND_PATH env variable */
578 if (pathname
== NULL
) {
579 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
582 /* Try with configured path */
583 if (pathname
== NULL
) {
584 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
585 pathname
= CONFIG_SESSIOND_BIN
;
589 /* Try the default path */
590 if (pathname
== NULL
) {
591 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
594 DBG("Session daemon binary path: %s", pathname
);
596 /* Check existence and permissions */
597 ret
= access(pathname
, F_OK
| X_OK
);
599 ERR("No such file or access denied: %s", pathname
);
603 ret
= spawn_sessiond(pathname
);
606 ERR("Problem occurred while launching session daemon (%s)",
613 * The 'create <options>' first level command
615 * Returns one of the CMD_* result constants.
617 int cmd_create(int argc
, const char **argv
)
619 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
620 char *opt_arg
= NULL
;
621 static poptContext pc
;
623 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
624 poptReadDefaultConfig(pc
, 0);
626 while ((opt
= poptGetNextOpt(pc
)) != -1) {
631 case OPT_LIST_OPTIONS
:
632 list_cmd_options(stdout
, long_options
);
639 opt_arg
= poptGetOptArg(pc
);
641 /* Set up default values. */
642 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
643 DBG("Session live timer interval set to default value %d",
648 v
= strtoul(opt_arg
, NULL
, 0);
649 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
650 ERR("Wrong value in --live parameter: %s", opt_arg
);
654 if (v
!= (uint32_t) v
) {
655 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
660 ERR("Live timer interval must be greater than zero");
664 opt_live_timer
= (uint32_t) v
;
665 DBG("Session live timer interval set to %d", opt_live_timer
);
674 if (opt_no_consumer
) {
675 MSG("The option --no-consumer is obsolete. Use --no-output now.");
680 /* Spawn a session daemon if needed */
681 if (!opt_no_sessiond
) {
682 ret
= launch_sessiond();
689 /* MI initialization */
691 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
693 ret
= -LTTNG_ERR_NOMEM
;
697 /* Open command element */
698 ret
= mi_lttng_writer_command_open(writer
,
699 mi_lttng_element_command_create
);
705 /* Open output element */
706 ret
= mi_lttng_writer_open_element(writer
,
707 mi_lttng_element_command_output
);
713 opt_session_name
= (char*) poptGetArg(pc
);
715 command_ret
= create_session();
721 /* Close output element */
722 ret
= mi_lttng_writer_close_element(writer
);
729 ret
= mi_lttng_writer_write_element_bool(writer
,
730 mi_lttng_element_command_success
, success
);
736 /* Command element close */
737 ret
= mi_lttng_writer_command_close(writer
);
746 if (writer
&& mi_lttng_writer_destroy(writer
)) {
747 /* Preserve original error code */
748 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
751 /* Overwrite ret if an error occurred in create_session() */
752 ret
= command_ret
? command_ret
: ret
;