2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
17 #include <sys/types.h>
18 #include <common/compat/time.h>
23 #include <common/mi-lttng.h>
25 #include "../command.h"
28 #include <common/defaults.h>
29 #include <common/sessiond-comm/sessiond-comm.h>
30 #include <common/uri.h>
31 #include <common/utils.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 */
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)
137 enum output_type output_type
;
138 struct lttng_uri
*uris
= NULL
;
139 struct lttng_session_descriptor
*descriptor
= NULL
;
140 const char *uri_str1
= NULL
, *uri_str2
= NULL
;
141 char local_output_path
[LTTNG_PATH_MAX
] = {};
144 output_type
= OUTPUT_NONE
;
145 } else if (opt_output_path
) {
146 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
) {
163 uri_str1
= opt_ctrl_url
? opt_ctrl_url
: opt_url
;
164 uri_str2
= opt_data_url
;
166 uri_count
= uri_parse_str_urls(uri_str1
, uri_str2
, &uris
);
167 if (uri_count
!= 1 && uri_count
!= 2) {
168 ERR("Unrecognized URL format.");
174 output_type
= OUTPUT_LOCAL
;
175 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
176 ERR("Unrecognized URL format.");
179 ret
= lttng_strncpy(local_output_path
, uris
[0].dst
.path
,
180 sizeof(local_output_path
));
182 ERR("Output path exceeds the maximal supported length (%zu bytes)",
183 sizeof(local_output_path
));
187 output_type
= OUTPUT_NETWORK
;
190 /* Already checked. */
194 output_type
= OUTPUT_UNSPECIFIED
;
198 /* Snapshot session. */
199 switch (output_type
) {
200 case OUTPUT_UNSPECIFIED
:
202 descriptor
= lttng_session_descriptor_snapshot_local_create(
204 output_type
== OUTPUT_LOCAL
?
205 local_output_path
: NULL
);
208 descriptor
= lttng_session_descriptor_snapshot_create(
212 descriptor
= lttng_session_descriptor_snapshot_network_create(
213 opt_session_name
, uri_str1
, uri_str2
);
218 } else if (opt_live_timer
) {
220 if (output_type
!= OUTPUT_UNSPECIFIED
&&
221 output_type
!= OUTPUT_NETWORK
) {
222 ERR("Unsupported output type specified for live session.");
225 descriptor
= lttng_session_descriptor_live_network_create(
226 opt_session_name
, uri_str1
, uri_str2
,
229 /* Regular session. */
230 switch (output_type
) {
231 case OUTPUT_UNSPECIFIED
:
233 descriptor
= lttng_session_descriptor_local_create(
235 output_type
== OUTPUT_LOCAL
?
236 local_output_path
: NULL
);
239 descriptor
= lttng_session_descriptor_create(
243 descriptor
= lttng_session_descriptor_network_create(
244 opt_session_name
, uri_str1
, uri_str2
);
251 ERR("Failed to initialize session creation command.");
254 * Auto-launch the relay daemon when a live session
255 * is created using default URLs.
257 if (!opt_url
&& !opt_ctrl_url
&& !opt_data_url
&&
258 opt_live_timer
&& !check_relayd()) {
260 const char *pathname
= opt_relayd_path
? :
261 INSTALL_BIN_PATH
"/lttng-relayd";
263 ret
= spawn_relayd(pathname
, 0);
265 lttng_session_descriptor_destroy(descriptor
);
276 * Create a tracing session.
277 * If no name is specified, a default name is generated.
279 * Returns one of the CMD_* result constants.
281 static int create_session(void)
284 char shm_path
[LTTNG_PATH_MAX
] = {};
285 struct lttng_session_descriptor
*session_descriptor
= NULL
;
286 enum lttng_session_descriptor_status descriptor_status
;
287 enum lttng_error_code ret_code
;
288 struct lttng_session
*sessions
= NULL
;
289 const struct lttng_session
*created_session
= NULL
;
290 const char *created_session_name
;
292 /* Validate options. */
293 if (opt_session_name
) {
294 if (strlen(opt_session_name
) > NAME_MAX
) {
295 ERR("Session name too long. Length must be lower or equal to %d",
301 * Check if the session name begins with "auto-" or is exactly "auto".
302 * Both are reserved for the default session name. See bug #449 to
303 * understand why we need to check both here.
305 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
306 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
307 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
308 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
309 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
310 ERR("%s is a reserved keyword for default session(s)",
311 DEFAULT_SESSION_NAME
);
317 if (opt_snapshot
&& opt_live_timer
) {
318 ERR("Snapshot and live modes are mutually exclusive.");
323 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
324 ERR("Both control and data URLs must be specified.");
329 session_descriptor
= create_session_descriptor();
330 if (!session_descriptor
) {
334 ret_code
= lttng_create_session_ext(session_descriptor
);
335 if (ret_code
!= LTTNG_OK
) {
336 ERR("%s", lttng_strerror(-ret_code
));
341 descriptor_status
= lttng_session_descriptor_get_session_name(
342 session_descriptor
, &created_session_name
);
343 if (descriptor_status
!= LTTNG_SESSION_DESCRIPTOR_STATUS_OK
) {
344 ERR("Failed to obtain created session name");
349 ret
= lttng_list_sessions(&sessions
);
351 ERR("Failed to fetch properties of created session: %s",
352 lttng_strerror(ret
));
356 for (i
= 0; i
< ret
; i
++) {
357 if (!strcmp(created_session_name
, sessions
[i
].name
)) {
358 created_session
= &sessions
[i
];
362 if (!created_session
) {
363 ERR("Failed to fetch properties of created session");
369 char datetime_suffix
[17] = {};
372 * An auto-generated session name already includes the creation
375 if (opt_session_name
) {
376 uint64_t creation_time
;
378 time_t creation_time_t
;
381 ret_code
= lttng_session_get_creation_time(
384 if (ret_code
!= LTTNG_OK
) {
385 ERR("%s", lttng_strerror(-ret_code
));
389 creation_time_t
= (time_t) creation_time
;
390 timeinfo
= localtime(&creation_time_t
);
392 PERROR("Failed to interpret session creation time");
396 strftime_ret
= strftime(datetime_suffix
,
397 sizeof(datetime_suffix
),
398 "-%Y%m%d-%H%M%S", timeinfo
);
399 if (strftime_ret
== 0) {
400 ERR("Failed to format session creation time.");
406 ret
= snprintf(shm_path
, sizeof(shm_path
),
407 "%s/%s%s", opt_shm_path
, created_session_name
,
409 if (ret
< 0 || ret
>= sizeof(shm_path
)) {
410 ERR("Failed to format the shared memory path.");
414 ret
= lttng_set_session_shm_path(created_session_name
,
417 lttng_destroy_session(created_session_name
);
424 MSG("Snapshot session %s created.", created_session_name
);
425 } else if (opt_live_timer
) {
426 MSG("Live session %s created.", created_session_name
);
428 MSG("Session %s created.", created_session_name
);
431 if (*created_session
->path
&& !opt_snapshot
) {
432 MSG("Traces will be output to %s", created_session
->path
);
434 if (opt_live_timer
) {
435 MSG("Live timer interval set to %u %s", opt_live_timer
,
438 } else if (opt_snapshot
) {
439 struct lttng_snapshot_output_list
*list
;
440 struct lttng_snapshot_output
*iter
;
441 char snapshot_url
[LTTNG_PATH_MAX
] = {};
443 ret
= lttng_snapshot_list_output(created_session_name
, &list
);
445 ERR("Failed to list snapshot outputs.");
450 while ((iter
= lttng_snapshot_output_list_get_next(list
))) {
451 const char *url
= NULL
;
453 url
= lttng_snapshot_output_get_ctrl_url(
455 ret
= lttng_strncpy(snapshot_url
, url
,
456 sizeof(snapshot_url
));
458 snapshot_url
[0] = '\0';
459 ERR("Failed to retrieve snapshot output destination");
463 lttng_snapshot_output_list_destroy(list
);
466 MSG("Default snapshot output set to %s",
469 MSG("Every channel enabled for this session will be set to mmap output and default to overwrite mode.");
472 MSG("Shared memory path set to %s", shm_path
);
477 ret
= mi_created_session(created_session_name
);
484 /* Init lttng session config */
485 ret
= config_init(created_session_name
);
493 lttng_session_descriptor_destroy(session_descriptor
);
501 * Spawn a session daemon by forking and execv.
503 static int spawn_sessiond(const char *pathname
)
508 MSG("Spawning a session daemon");
512 * Spawn session daemon in daemon mode.
514 execlp(pathname
, "lttng-sessiond",
515 "--daemonize", NULL
);
516 /* execlp only returns if error happened */
517 if (errno
== ENOENT
) {
518 ERR("No session daemon found. Use --sessiond-path.");
522 kill(getppid(), SIGTERM
); /* wake parent */
524 } else if (pid
> 0) {
526 * In daemon mode (--daemonize), sessiond only exits when
527 * it's ready to accept commands.
531 pid_t wait_pid_ret
= waitpid(pid
, &status
, 0);
533 if (wait_pid_ret
< 0) {
534 if (errno
== EINTR
) {
542 if (WIFSIGNALED(status
)) {
543 ERR("Session daemon was killed by signal %d",
547 } else if (WIFEXITED(status
)) {
548 DBG("Session daemon terminated normally (exit status: %d)",
549 WEXITSTATUS(status
));
551 if (WEXITSTATUS(status
) != 0) {
552 ERR("Session daemon terminated with an error (exit status: %d)",
553 WEXITSTATUS(status
));
575 * Check if the session daemon is available using
576 * the liblttngctl API for the check. If not, try to
579 static int launch_sessiond(void)
582 const char *pathname
= NULL
;
584 ret
= lttng_session_daemon_alive();
586 /* Sessiond is alive, not an error */
591 /* Try command line option path */
592 pathname
= opt_sessiond_path
;
594 /* Try LTTNG_SESSIOND_PATH env variable */
595 if (pathname
== NULL
) {
596 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
599 /* Try with configured path */
600 if (pathname
== NULL
) {
601 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
602 pathname
= CONFIG_SESSIOND_BIN
;
606 /* Try the default path */
607 if (pathname
== NULL
) {
608 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
611 DBG("Session daemon binary path: %s", pathname
);
613 /* Check existence and permissions */
614 ret
= access(pathname
, F_OK
| X_OK
);
616 ERR("No such file or access denied: %s", pathname
);
620 ret
= spawn_sessiond(pathname
);
623 ERR("Problem occurred while launching session daemon (%s)",
630 int validate_url_option_combination(void)
635 used_count
+= !!opt_url
;
636 used_count
+= !!opt_output_path
;
637 used_count
+= (opt_data_url
|| opt_ctrl_url
);
638 if (used_count
> 1) {
639 ERR("Only one of the --set-url, --ctrl-url/data-url, or --output options may be used at once.");
647 * The 'create <options>' first level command
649 * Returns one of the CMD_* result constants.
651 int cmd_create(int argc
, const char **argv
)
653 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
654 char *opt_arg
= NULL
;
655 const char *leftover
= NULL
;
656 static poptContext pc
;
658 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
659 poptReadDefaultConfig(pc
, 0);
661 while ((opt
= poptGetNextOpt(pc
)) != -1) {
666 case OPT_LIST_OPTIONS
:
667 list_cmd_options(stdout
, long_options
);
674 opt_arg
= poptGetOptArg(pc
);
676 /* Set up default values. */
677 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
678 DBG("Session live timer interval set to default value %d",
683 if (utils_parse_time_suffix(opt_arg
, &v
) < 0) {
684 ERR("Wrong value for --live parameter: %s", opt_arg
);
689 if (v
!= (uint32_t) v
) {
690 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
696 ERR("Live timer interval must be greater than zero");
701 opt_live_timer
= (uint32_t) v
;
702 DBG("Session live timer interval set to %d", opt_live_timer
);
711 if (opt_no_consumer
) {
712 MSG("The option --no-consumer is obsolete. Use --no-output now.");
717 ret
= validate_url_option_combination();
723 /* Spawn a session daemon if needed */
724 if (!opt_no_sessiond
) {
725 ret
= launch_sessiond();
732 /* MI initialization */
734 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
736 ret
= -LTTNG_ERR_NOMEM
;
740 /* Open command element */
741 ret
= mi_lttng_writer_command_open(writer
,
742 mi_lttng_element_command_create
);
748 /* Open output element */
749 ret
= mi_lttng_writer_open_element(writer
,
750 mi_lttng_element_command_output
);
756 opt_session_name
= (char*) poptGetArg(pc
);
758 leftover
= poptGetArg(pc
);
760 ERR("Unknown argument: %s", leftover
);
765 command_ret
= create_session();
771 /* Close output element */
772 ret
= mi_lttng_writer_close_element(writer
);
779 ret
= mi_lttng_writer_write_element_bool(writer
,
780 mi_lttng_element_command_success
, success
);
786 /* Command element close */
787 ret
= mi_lttng_writer_command_close(writer
);
796 if (writer
&& mi_lttng_writer_destroy(writer
)) {
797 /* Preserve original error code */
798 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
801 /* Overwrite ret if an error occurred in create_session() */
802 ret
= command_ret
? command_ret
: ret
;