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
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/snapshot.h>
33 #include <lttng/session-descriptor.h>
35 static char *opt_output_path
;
36 static char *opt_session_name
;
38 static char *opt_ctrl_url
;
39 static char *opt_data_url
;
40 static char *opt_shm_path
;
41 static int opt_no_consumer
;
42 static int opt_no_output
;
43 static int opt_snapshot
;
44 static uint32_t opt_live_timer
;
46 #ifdef LTTNG_EMBED_HELP
47 static const char help_msg
[] =
48 #include <lttng-create.1.h>
65 static struct mi_writer
*writer
;
66 static struct poptOption long_options
[] = {
67 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
68 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
69 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
70 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
71 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
72 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
73 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
74 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
75 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
76 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
77 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
78 {"shm-path", 0, POPT_ARG_STRING
, &opt_shm_path
, 0, 0, 0},
83 * Retrieve the created session and mi output it based on provided argument
84 * This is currently a summary of what was pretty printed and is subject to
87 static int mi_created_session(const char *session_name
)
89 int ret
, i
, count
, found
;
90 struct lttng_session
*sessions
;
92 /* session_name should not be null */
96 count
= lttng_list_sessions(&sessions
);
99 ERR("%s", lttng_strerror(ret
));
104 ERR("Error session creation failed: session %s not found", session_name
);
105 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
110 for (i
= 0; i
< count
; i
++) {
111 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
113 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
122 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
134 struct lttng_session_descriptor
*create_session_descriptor(void)
138 enum output_type output_type
;
139 struct lttng_uri
*uris
= NULL
;
140 struct lttng_session_descriptor
*descriptor
= NULL
;
141 const char *uri_str1
= NULL
, *uri_str2
= NULL
;
142 char local_output_path
[LTTNG_PATH_MAX
] = {};
145 output_type
= OUTPUT_NONE
;
146 } else if (opt_output_path
) {
147 char *expanded_output_path
;
149 output_type
= OUTPUT_LOCAL
;
150 expanded_output_path
= utils_expand_path(opt_output_path
);
151 if (!expanded_output_path
) {
152 ERR("Failed to expand output path.");
155 ret
= lttng_strncpy(local_output_path
, expanded_output_path
,
156 sizeof(local_output_path
));
157 free(expanded_output_path
);
159 ERR("Output path exceeds the maximal supported length (%zu bytes)",
160 sizeof(local_output_path
));
163 } else if (opt_url
|| opt_ctrl_url
) {
164 uri_str1
= opt_ctrl_url
? opt_ctrl_url
: opt_url
;
165 uri_str2
= opt_data_url
;
167 uri_count
= uri_parse_str_urls(uri_str1
, uri_str2
, &uris
);
168 if (uri_count
!= 1 && uri_count
!= 2) {
169 ERR("Unrecognized URL format.");
175 output_type
= OUTPUT_LOCAL
;
176 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
177 ERR("Unrecognized URL format.");
180 ret
= lttng_strncpy(local_output_path
, uris
[0].dst
.path
,
181 sizeof(local_output_path
));
183 ERR("Output path exceeds the maximal supported length (%zu bytes)",
184 sizeof(local_output_path
));
188 output_type
= OUTPUT_NETWORK
;
191 /* Already checked. */
195 output_type
= OUTPUT_UNSPECIFIED
;
199 /* Snapshot session. */
200 switch (output_type
) {
201 case OUTPUT_UNSPECIFIED
:
203 descriptor
= lttng_session_descriptor_snapshot_local_create(
205 output_type
== OUTPUT_LOCAL
?
206 local_output_path
: NULL
);
209 descriptor
= lttng_session_descriptor_snapshot_create(
213 descriptor
= lttng_session_descriptor_snapshot_network_create(
214 opt_session_name
, uri_str1
, uri_str2
);
219 } else if (opt_live_timer
) {
221 if (output_type
!= OUTPUT_UNSPECIFIED
&&
222 output_type
!= OUTPUT_NETWORK
) {
223 ERR("Unsupported output type specified for live session.");
226 descriptor
= lttng_session_descriptor_live_network_create(
227 opt_session_name
, uri_str1
, uri_str2
,
230 /* Regular session. */
231 switch (output_type
) {
232 case OUTPUT_UNSPECIFIED
:
234 descriptor
= lttng_session_descriptor_local_create(
236 output_type
== OUTPUT_LOCAL
?
237 local_output_path
: NULL
);
240 descriptor
= lttng_session_descriptor_create(
244 descriptor
= lttng_session_descriptor_network_create(
245 opt_session_name
, uri_str1
, uri_str2
);
252 ERR("Failed to initialize session creation command.");
255 * Auto-launch the relay daemon when a live session
256 * is created using default URLs.
258 if (!opt_url
&& !opt_ctrl_url
&& !opt_data_url
&&
259 opt_live_timer
&& !check_relayd()) {
261 const char *pathname
= opt_relayd_path
? :
262 INSTALL_BIN_PATH
"/lttng-relayd";
264 ret
= spawn_relayd(pathname
, 0);
266 lttng_session_descriptor_destroy(descriptor
);
277 * Create a tracing session.
278 * If no name is specified, a default name is generated.
280 * Returns one of the CMD_* result constants.
282 static int create_session(void)
285 char shm_path
[LTTNG_PATH_MAX
] = {};
286 struct lttng_session_descriptor
*session_descriptor
= NULL
;
287 enum lttng_session_descriptor_status descriptor_status
;
288 enum lttng_error_code ret_code
;
289 struct lttng_session
*sessions
= NULL
;
290 const struct lttng_session
*created_session
= NULL
;
291 const char *created_session_name
;
293 /* Validate options. */
294 if (opt_session_name
) {
295 if (strlen(opt_session_name
) > NAME_MAX
) {
296 ERR("Session name too long. Length must be lower or equal to %d",
302 * Check if the session name begins with "auto-" or is exactly "auto".
303 * Both are reserved for the default session name. See bug #449 to
304 * understand why we need to check both here.
306 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
307 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
308 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
309 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
310 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
311 ERR("%s is a reserved keyword for default session(s)",
312 DEFAULT_SESSION_NAME
);
318 if (opt_snapshot
&& opt_live_timer
) {
319 ERR("Snapshot and live modes are mutually exclusive.");
324 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
325 ERR("Both control and data URLs must be specified.");
330 session_descriptor
= create_session_descriptor();
331 if (!session_descriptor
) {
335 ret_code
= lttng_create_session_ext(session_descriptor
);
336 if (ret_code
!= LTTNG_OK
) {
337 ERR("%s", lttng_strerror(-ret_code
));
342 descriptor_status
= lttng_session_descriptor_get_session_name(
343 session_descriptor
, &created_session_name
);
344 if (descriptor_status
!= LTTNG_SESSION_DESCRIPTOR_STATUS_OK
) {
345 ERR("Failed to obtain created session name");
350 ret
= lttng_list_sessions(&sessions
);
352 ERR("Failed to fetch properties of created session: %s",
353 lttng_strerror(ret
));
357 for (i
= 0; i
< ret
; i
++) {
358 if (!strcmp(created_session_name
, sessions
[i
].name
)) {
359 created_session
= &sessions
[i
];
363 if (!created_session
) {
364 ERR("Failed to fetch properties of created session");
370 char datetime_suffix
[17] = {};
373 * An auto-generated session name already includes the creation
376 if (opt_session_name
) {
377 uint64_t creation_time
;
379 time_t creation_time_t
;
382 ret_code
= lttng_session_get_creation_time(
385 if (ret_code
!= LTTNG_OK
) {
386 ERR("%s", lttng_strerror(-ret_code
));
390 creation_time_t
= (time_t) creation_time
;
391 timeinfo
= localtime(&creation_time_t
);
393 PERROR("Failed to interpret session creation time");
397 strftime_ret
= strftime(datetime_suffix
,
398 sizeof(datetime_suffix
),
399 "-%Y%m%d-%H%M%S", timeinfo
);
400 if (strftime_ret
== 0) {
401 ERR("Failed to format session creation time.");
407 ret
= snprintf(shm_path
, sizeof(shm_path
),
408 "%s/%s%s", opt_shm_path
, created_session_name
,
410 if (ret
< 0 || ret
>= sizeof(shm_path
)) {
411 ERR("Failed to format the shared memory path.");
415 ret
= lttng_set_session_shm_path(created_session_name
,
418 lttng_destroy_session(created_session_name
);
425 MSG("Snapshot session %s created.", created_session_name
);
426 } else if (opt_live_timer
) {
427 MSG("Live session %s created.", created_session_name
);
429 MSG("Session %s created.", created_session_name
);
432 if (*created_session
->path
&& !opt_snapshot
) {
433 MSG("Traces will be output to %s", created_session
->path
);
435 if (opt_live_timer
) {
436 MSG("Live timer interval set to %u %s", opt_live_timer
,
439 } else if (opt_snapshot
) {
440 struct lttng_snapshot_output_list
*list
;
441 struct lttng_snapshot_output
*iter
;
442 char snapshot_url
[LTTNG_PATH_MAX
] = {};
444 ret
= lttng_snapshot_list_output(created_session_name
, &list
);
446 ERR("Failed to list snapshot outputs.");
451 while ((iter
= lttng_snapshot_output_list_get_next(list
))) {
452 const char *url
= NULL
;
454 url
= lttng_snapshot_output_get_ctrl_url(
456 ret
= lttng_strncpy(snapshot_url
, url
,
457 sizeof(snapshot_url
));
459 snapshot_url
[0] = '\0';
460 ERR("Failed to retrieve snapshot output destination");
464 lttng_snapshot_output_list_destroy(list
);
467 MSG("Default snapshot output set to %s",
470 MSG("Every channel enabled for this session will be set to mmap output and default to overwrite mode.");
473 MSG("Shared memory path set to %s", shm_path
);
478 ret
= mi_created_session(created_session_name
);
485 /* Init lttng session config */
486 ret
= config_init(created_session_name
);
494 lttng_session_descriptor_destroy(session_descriptor
);
502 * Spawn a session daemon by forking and execv.
504 static int spawn_sessiond(const char *pathname
)
509 MSG("Spawning a session daemon");
513 * Spawn session daemon in daemon mode.
515 execlp(pathname
, "lttng-sessiond",
516 "--daemonize", NULL
);
517 /* execlp only returns if error happened */
518 if (errno
== ENOENT
) {
519 ERR("No session daemon found. Use --sessiond-path.");
523 kill(getppid(), SIGTERM
); /* wake parent */
525 } else if (pid
> 0) {
527 * In daemon mode (--daemonize), sessiond only exits when
528 * it's ready to accept commands.
532 pid_t wait_pid_ret
= waitpid(pid
, &status
, 0);
534 if (wait_pid_ret
< 0) {
535 if (errno
== EINTR
) {
543 if (WIFSIGNALED(status
)) {
544 ERR("Session daemon was killed by signal %d",
548 } else if (WIFEXITED(status
)) {
549 DBG("Session daemon terminated normally (exit status: %d)",
550 WEXITSTATUS(status
));
552 if (WEXITSTATUS(status
) != 0) {
553 ERR("Session daemon terminated with an error (exit status: %d)",
554 WEXITSTATUS(status
));
576 * Check if the session daemon is available using
577 * the liblttngctl API for the check. If not, try to
580 static int launch_sessiond(void)
583 const char *pathname
= NULL
;
585 ret
= lttng_session_daemon_alive();
587 /* Sessiond is alive, not an error */
592 /* Try command line option path */
593 pathname
= opt_sessiond_path
;
595 /* Try LTTNG_SESSIOND_PATH env variable */
596 if (pathname
== NULL
) {
597 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
600 /* Try with configured path */
601 if (pathname
== NULL
) {
602 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
603 pathname
= CONFIG_SESSIOND_BIN
;
607 /* Try the default path */
608 if (pathname
== NULL
) {
609 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
612 DBG("Session daemon binary path: %s", pathname
);
614 /* Check existence and permissions */
615 ret
= access(pathname
, F_OK
| X_OK
);
617 ERR("No such file or access denied: %s", pathname
);
621 ret
= spawn_sessiond(pathname
);
624 ERR("Problem occurred while launching session daemon (%s)",
631 int validate_url_option_combination(void)
636 used_count
+= !!opt_url
;
637 used_count
+= !!opt_output_path
;
638 used_count
+= (opt_data_url
|| opt_ctrl_url
);
639 if (used_count
> 1) {
640 ERR("Only one of the --set-url, --ctrl-url/data-url, or --output options may be used at once.");
648 * The 'create <options>' first level command
650 * Returns one of the CMD_* result constants.
652 int cmd_create(int argc
, const char **argv
)
654 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
655 char *opt_arg
= NULL
;
656 const char *leftover
= NULL
;
657 static poptContext pc
;
659 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
660 poptReadDefaultConfig(pc
, 0);
662 while ((opt
= poptGetNextOpt(pc
)) != -1) {
667 case OPT_LIST_OPTIONS
:
668 list_cmd_options(stdout
, long_options
);
675 opt_arg
= poptGetOptArg(pc
);
677 /* Set up default values. */
678 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
679 DBG("Session live timer interval set to default value %d",
684 if (utils_parse_time_suffix(opt_arg
, &v
) < 0) {
685 ERR("Wrong value for --live parameter: %s", opt_arg
);
690 if (v
!= (uint32_t) v
) {
691 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
697 ERR("Live timer interval must be greater than zero");
702 opt_live_timer
= (uint32_t) v
;
703 DBG("Session live timer interval set to %d", opt_live_timer
);
712 if (opt_no_consumer
) {
713 MSG("The option --no-consumer is obsolete. Use --no-output now.");
718 ret
= validate_url_option_combination();
724 /* Spawn a session daemon if needed */
725 if (!opt_no_sessiond
) {
726 ret
= launch_sessiond();
733 /* MI initialization */
735 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
737 ret
= -LTTNG_ERR_NOMEM
;
741 /* Open command element */
742 ret
= mi_lttng_writer_command_open(writer
,
743 mi_lttng_element_command_create
);
749 /* Open output element */
750 ret
= mi_lttng_writer_open_element(writer
,
751 mi_lttng_element_command_output
);
757 opt_session_name
= (char*) poptGetArg(pc
);
759 leftover
= poptGetArg(pc
);
761 ERR("Unknown argument: %s", leftover
);
766 command_ret
= create_session();
772 /* Close output element */
773 ret
= mi_lttng_writer_close_element(writer
);
780 ret
= mi_lttng_writer_write_element_bool(writer
,
781 mi_lttng_element_command_success
, success
);
787 /* Command element close */
788 ret
= mi_lttng_writer_command_close(writer
);
797 if (writer
&& mi_lttng_writer_destroy(writer
)) {
798 /* Preserve original error code */
799 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
802 /* Overwrite ret if an error occurred in create_session() */
803 ret
= command_ret
? command_ret
: ret
;