2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
16 #include <sys/types.h>
17 #include <common/compat/time.h>
22 #include <common/mi-lttng.h>
24 #include "../command.h"
27 #include <common/defaults.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/uri.h>
30 #include <common/utils.h>
31 #include <common/path.h>
32 #include <lttng/lttng.h>
34 static char *opt_output_path
;
35 static char *opt_session_name
;
37 static char *opt_ctrl_url
;
38 static char *opt_data_url
;
39 static char *opt_shm_path
;
40 static int opt_no_consumer
;
41 static int opt_no_output
;
42 static int opt_snapshot
;
43 static uint32_t opt_live_timer
;
45 #ifdef LTTNG_EMBED_HELP
46 static const char help_msg
[] =
47 #include <lttng-create.1.h>
64 static struct mi_writer
*writer
;
65 static struct poptOption long_options
[] = {
66 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
67 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
68 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
69 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
70 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
71 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
72 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
73 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
74 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
75 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
76 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
77 {"shm-path", 0, POPT_ARG_STRING
, &opt_shm_path
, 0, 0, 0},
82 * Retrieve the created session and mi output it based on provided argument
83 * This is currently a summary of what was pretty printed and is subject to
86 static int mi_created_session(const char *session_name
)
88 int ret
, i
, count
, found
;
89 struct lttng_session
*sessions
;
91 /* session_name should not be null */
92 LTTNG_ASSERT(session_name
);
95 count
= lttng_list_sessions(&sessions
);
98 ERR("%s", lttng_strerror(ret
));
103 ERR("Error session creation failed: session %s not found", session_name
);
104 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
109 for (i
= 0; i
< count
; i
++) {
110 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
112 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
121 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
133 struct lttng_session_descriptor
*create_session_descriptor(void)
136 enum output_type output_type
;
137 struct lttng_uri
*uris
= NULL
;
138 struct lttng_session_descriptor
*descriptor
= NULL
;
139 const char *uri_str1
= NULL
, *uri_str2
= NULL
;
140 char local_output_path
[LTTNG_PATH_MAX
] = {};
143 output_type
= OUTPUT_NONE
;
144 } else if (opt_output_path
) {
145 char *expanded_output_path
;
148 output_type
= OUTPUT_LOCAL
;
149 expanded_output_path
= utils_expand_path(opt_output_path
);
150 if (!expanded_output_path
) {
151 ERR("Failed to expand output path.");
154 ret
= lttng_strncpy(local_output_path
, expanded_output_path
,
155 sizeof(local_output_path
));
156 free(expanded_output_path
);
158 ERR("Output path exceeds the maximal supported length (%zu bytes)",
159 sizeof(local_output_path
));
162 } else if (opt_url
|| opt_ctrl_url
) {
165 uri_str1
= opt_ctrl_url
? opt_ctrl_url
: opt_url
;
166 uri_str2
= opt_data_url
;
168 uri_count
= uri_parse_str_urls(uri_str1
, uri_str2
, &uris
);
169 if (uri_count
!= 1 && uri_count
!= 2) {
170 ERR("Unrecognized URL format.");
176 output_type
= OUTPUT_LOCAL
;
177 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
178 ERR("Unrecognized URL format.");
181 ret
= lttng_strncpy(local_output_path
, uris
[0].dst
.path
,
182 sizeof(local_output_path
));
184 ERR("Output path exceeds the maximal supported length (%zu bytes)",
185 sizeof(local_output_path
));
189 output_type
= OUTPUT_NETWORK
;
192 /* Already checked. */
196 output_type
= OUTPUT_UNSPECIFIED
;
200 /* Snapshot session. */
201 switch (output_type
) {
202 case OUTPUT_UNSPECIFIED
:
204 descriptor
= lttng_session_descriptor_snapshot_local_create(
206 output_type
== OUTPUT_LOCAL
?
207 local_output_path
: NULL
);
210 descriptor
= lttng_session_descriptor_snapshot_create(
214 descriptor
= lttng_session_descriptor_snapshot_network_create(
215 opt_session_name
, uri_str1
, uri_str2
);
220 } else if (opt_live_timer
) {
222 if (output_type
!= OUTPUT_UNSPECIFIED
&&
223 output_type
!= OUTPUT_NETWORK
) {
224 ERR("Unsupported output type specified for live session.");
227 descriptor
= lttng_session_descriptor_live_network_create(
228 opt_session_name
, uri_str1
, uri_str2
,
231 /* Regular session. */
232 switch (output_type
) {
233 case OUTPUT_UNSPECIFIED
:
235 descriptor
= lttng_session_descriptor_local_create(
237 output_type
== OUTPUT_LOCAL
?
238 local_output_path
: NULL
);
241 descriptor
= lttng_session_descriptor_create(
245 descriptor
= lttng_session_descriptor_network_create(
246 opt_session_name
, uri_str1
, uri_str2
);
253 ERR("Failed to initialize session creation command.");
256 * Auto-launch the relay daemon when a live session
257 * is created using default URLs.
259 if (!opt_url
&& !opt_ctrl_url
&& !opt_data_url
&&
260 opt_live_timer
&& !check_relayd()) {
262 const char *pathname
= opt_relayd_path
? :
263 INSTALL_BIN_PATH
"/lttng-relayd";
265 ret
= spawn_relayd(pathname
, 0);
267 lttng_session_descriptor_destroy(descriptor
);
278 * Create a tracing session.
279 * If no name is specified, a default name is generated.
281 * Returns one of the CMD_* result constants.
283 static int create_session(void)
286 char shm_path
[LTTNG_PATH_MAX
] = {};
287 struct lttng_session_descriptor
*session_descriptor
= NULL
;
288 enum lttng_session_descriptor_status descriptor_status
;
289 enum lttng_error_code ret_code
;
290 struct lttng_session
*sessions
= NULL
;
291 const struct lttng_session
*created_session
= NULL
;
292 const char *created_session_name
;
294 /* Validate options. */
295 if (opt_session_name
) {
296 if (strlen(opt_session_name
) > NAME_MAX
) {
297 ERR("Session name too long. Length must be lower or equal to %d",
303 * Check if the session name begins with "auto-" or is exactly "auto".
304 * Both are reserved for the default session name. See bug #449 to
305 * understand why we need to check both here.
307 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
308 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
309 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
310 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
311 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
312 ERR("%s is a reserved keyword for default session(s)",
313 DEFAULT_SESSION_NAME
);
319 if (opt_snapshot
&& opt_live_timer
) {
320 ERR("Snapshot and live modes are mutually exclusive.");
325 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
326 ERR("Both control and data URLs must be specified.");
331 session_descriptor
= create_session_descriptor();
332 if (!session_descriptor
) {
336 ret_code
= lttng_create_session_ext(session_descriptor
);
337 if (ret_code
!= LTTNG_OK
) {
338 ERR("%s", lttng_strerror(-ret_code
));
343 descriptor_status
= lttng_session_descriptor_get_session_name(
344 session_descriptor
, &created_session_name
);
345 if (descriptor_status
!= LTTNG_SESSION_DESCRIPTOR_STATUS_OK
) {
346 ERR("Failed to obtain created session name");
351 ret
= lttng_list_sessions(&sessions
);
353 ERR("Failed to fetch properties of created session: %s",
354 lttng_strerror(ret
));
358 for (i
= 0; i
< ret
; i
++) {
359 if (!strcmp(created_session_name
, sessions
[i
].name
)) {
360 created_session
= &sessions
[i
];
364 if (!created_session
) {
365 ERR("Failed to fetch properties of created session");
371 char datetime_suffix
[17] = {};
374 * An auto-generated session name already includes the creation
377 if (opt_session_name
) {
378 uint64_t creation_time
;
380 time_t creation_time_t
;
383 ret_code
= lttng_session_get_creation_time(
386 if (ret_code
!= LTTNG_OK
) {
387 ERR("%s", lttng_strerror(-ret_code
));
391 creation_time_t
= (time_t) creation_time
;
392 timeinfo
= localtime(&creation_time_t
);
394 PERROR("Failed to interpret session creation time");
398 strftime_ret
= strftime(datetime_suffix
,
399 sizeof(datetime_suffix
),
400 "-%Y%m%d-%H%M%S", timeinfo
);
401 if (strftime_ret
== 0) {
402 ERR("Failed to format session creation time.");
408 ret
= snprintf(shm_path
, sizeof(shm_path
),
409 "%s/%s%s", opt_shm_path
, created_session_name
,
411 if (ret
< 0 || ret
>= sizeof(shm_path
)) {
412 ERR("Failed to format the shared memory path.");
416 ret
= lttng_set_session_shm_path(created_session_name
,
419 lttng_destroy_session(created_session_name
);
426 MSG("Snapshot session %s created.", created_session_name
);
427 } else if (opt_live_timer
) {
428 MSG("Live session %s created.", created_session_name
);
430 MSG("Session %s created.", created_session_name
);
433 if (*created_session
->path
&& !opt_snapshot
) {
434 MSG("Traces will be output to %s", created_session
->path
);
436 if (opt_live_timer
) {
437 MSG("Live timer interval set to %u %s", opt_live_timer
,
440 } else if (opt_snapshot
) {
441 struct lttng_snapshot_output_list
*list
;
442 struct lttng_snapshot_output
*iter
;
443 char snapshot_url
[LTTNG_PATH_MAX
] = {};
445 ret
= lttng_snapshot_list_output(created_session_name
, &list
);
447 ERR("Failed to list snapshot outputs.");
452 while ((iter
= lttng_snapshot_output_list_get_next(list
))) {
453 const char *url
= NULL
;
455 url
= lttng_snapshot_output_get_ctrl_url(
457 ret
= lttng_strncpy(snapshot_url
, url
,
458 sizeof(snapshot_url
));
460 snapshot_url
[0] = '\0';
461 ERR("Failed to retrieve snapshot output destination");
465 lttng_snapshot_output_list_destroy(list
);
468 MSG("Default snapshot output set to %s",
471 MSG("Every channel enabled for this session will be set to mmap output and default to overwrite mode.");
474 MSG("Shared memory path set to %s", shm_path
);
479 ret
= mi_created_session(created_session_name
);
486 /* Init lttng session config */
487 ret
= config_init(created_session_name
);
495 lttng_session_descriptor_destroy(session_descriptor
);
503 * Spawn a session daemon by forking and execv.
505 static int spawn_sessiond(const char *pathname
)
510 MSG("Spawning a session daemon");
514 * Spawn session daemon in daemon mode.
516 execlp(pathname
, "lttng-sessiond",
517 "--daemonize", NULL
);
518 /* execlp only returns if error happened */
519 if (errno
== ENOENT
) {
520 ERR("No session daemon found. Use --sessiond-path.");
524 kill(getppid(), SIGTERM
); /* wake parent */
526 } else if (pid
> 0) {
528 * In daemon mode (--daemonize), sessiond only exits when
529 * it's ready to accept commands.
533 pid_t wait_pid_ret
= waitpid(pid
, &status
, 0);
535 if (wait_pid_ret
< 0) {
536 if (errno
== EINTR
) {
544 if (WIFSIGNALED(status
)) {
545 ERR("Session daemon was killed by signal %d",
549 } else if (WIFEXITED(status
)) {
550 DBG("Session daemon terminated normally (exit status: %d)",
551 WEXITSTATUS(status
));
553 if (WEXITSTATUS(status
) != 0) {
554 ERR("Session daemon terminated with an error (exit status: %d)",
555 WEXITSTATUS(status
));
577 * Check if the session daemon is available using
578 * the liblttngctl API for the check. If not, try to
581 static int launch_sessiond(void)
584 const char *pathname
= NULL
;
586 ret
= lttng_session_daemon_alive();
588 /* Sessiond is alive, not an error */
593 /* Try command line option path */
594 pathname
= opt_sessiond_path
;
596 /* Try LTTNG_SESSIOND_PATH env variable */
597 if (pathname
== NULL
) {
598 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
601 /* Try with configured path */
602 if (pathname
== NULL
) {
603 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
604 pathname
= CONFIG_SESSIOND_BIN
;
608 /* Try the default path */
609 if (pathname
== NULL
) {
610 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
613 DBG("Session daemon binary path: %s", pathname
);
615 /* Check existence and permissions */
616 ret
= access(pathname
, F_OK
| X_OK
);
618 ERR("No such file or access denied: %s", pathname
);
622 ret
= spawn_sessiond(pathname
);
625 ERR("Problem occurred while launching session daemon (%s)",
632 int validate_url_option_combination(void)
637 used_count
+= !!opt_url
;
638 used_count
+= !!opt_output_path
;
639 used_count
+= (opt_data_url
|| opt_ctrl_url
);
640 if (used_count
> 1) {
641 ERR("Only one of the --set-url, --ctrl-url/data-url, or --output options may be used at once.");
649 * The 'create <options>' first level command
651 * Returns one of the CMD_* result constants.
653 int cmd_create(int argc
, const char **argv
)
655 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
656 char *opt_arg
= NULL
;
657 const char *leftover
= NULL
;
658 static poptContext pc
;
660 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
661 poptReadDefaultConfig(pc
, 0);
663 while ((opt
= poptGetNextOpt(pc
)) != -1) {
668 case OPT_LIST_OPTIONS
:
669 list_cmd_options(stdout
, long_options
);
676 opt_arg
= poptGetOptArg(pc
);
678 /* Set up default values. */
679 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
680 DBG("Session live timer interval set to default value %d",
685 if (utils_parse_time_suffix(opt_arg
, &v
) < 0) {
686 ERR("Wrong value for --live parameter: %s", opt_arg
);
691 if (v
!= (uint32_t) v
) {
692 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
698 ERR("Live timer interval must be greater than zero");
703 opt_live_timer
= (uint32_t) v
;
704 DBG("Session live timer interval set to %d", opt_live_timer
);
713 if (opt_no_consumer
) {
714 MSG("The option --no-consumer is obsolete. Use --no-output now.");
719 ret
= validate_url_option_combination();
725 /* Spawn a session daemon if needed */
726 if (!opt_no_sessiond
) {
727 ret
= launch_sessiond();
734 /* MI initialization */
736 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
738 ret
= -LTTNG_ERR_NOMEM
;
742 /* Open command element */
743 ret
= mi_lttng_writer_command_open(writer
,
744 mi_lttng_element_command_create
);
750 /* Open output element */
751 ret
= mi_lttng_writer_open_element(writer
,
752 mi_lttng_element_command_output
);
758 opt_session_name
= (char*) poptGetArg(pc
);
760 leftover
= poptGetArg(pc
);
762 ERR("Unknown argument: %s", leftover
);
767 command_ret
= create_session();
773 /* Close output element */
774 ret
= mi_lttng_writer_close_element(writer
);
781 ret
= mi_lttng_writer_write_element_bool(writer
,
782 mi_lttng_element_command_success
, success
);
788 /* Command element close */
789 ret
= mi_lttng_writer_command_close(writer
);
798 if (writer
&& mi_lttng_writer_destroy(writer
)) {
799 /* Preserve original error code */
800 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
803 /* Overwrite ret if an error occurred in create_session() */
804 ret
= command_ret
? command_ret
: ret
;