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.
27 #include <sys/types.h>
33 #include <common/mi-lttng.h>
35 #include "../command.h"
38 #include <common/defaults.h>
39 #include <common/sessiond-comm/sessiond-comm.h>
40 #include <common/uri.h>
41 #include <common/utils.h>
42 #include <lttng/snapshot.h>
44 static char *opt_output_path
;
45 static char *opt_session_name
;
47 static char *opt_ctrl_url
;
48 static char *opt_data_url
;
49 static char *opt_shm_path
;
50 static int opt_no_consumer
;
51 static int opt_no_output
;
52 static int opt_snapshot
;
53 static unsigned int opt_live_timer
;
61 static struct mi_writer
*writer
;
63 static struct poptOption long_options
[] = {
64 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
65 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
66 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
67 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
68 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
69 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
70 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
71 {"no-output", 0, POPT_ARG_VAL
, &opt_no_output
, 1, 0, 0},
72 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
73 {"snapshot", 0, POPT_ARG_VAL
, &opt_snapshot
, 1, 0, 0},
74 {"live", 0, POPT_ARG_INT
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_LIVE_TIMER
, 0, 0},
75 {"shm-path", 0, POPT_ARG_STRING
, &opt_shm_path
, 0, 0, 0},
80 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
81 * why this declaration exists and used ONLY in for this command.
83 extern int _lttng_create_session_ext(const char *name
, const char *url
,
84 const char *datetime
, int live_timer
);
89 static void usage(FILE *ofp
)
91 fprintf(ofp
, "usage: lttng create [NAME] [OPTIONS] \n");
93 fprintf(ofp
, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
95 fprintf(ofp
, "Options:\n");
96 fprintf(ofp
, " -h, --help Show this help\n");
97 fprintf(ofp
, " --list-options Simple listing of options\n");
98 fprintf(ofp
, " -o, --output PATH Specify output path for traces\n");
99 fprintf(ofp
, " --no-output Traces will not be outputted\n");
100 fprintf(ofp
, " --snapshot Set the session in snapshot mode.\n");
101 fprintf(ofp
, " Created in no-output mode and uses the URL,\n");
102 fprintf(ofp
, " if one, as the default snapshot output.\n");
103 fprintf(ofp
, " Every channel will be set in overwrite mode\n");
104 fprintf(ofp
, " and with mmap output (splice not supported).\n");
105 fprintf(ofp
, " --live [USEC] Set the session in live-reading mode.\n");
106 fprintf(ofp
, " The delay parameter in micro-seconds is the\n");
107 fprintf(ofp
, " maximum time the user can wait for the data\n");
108 fprintf(ofp
, " to be flushed. Can be set with a network\n");
109 fprintf(ofp
, " URL (-U or -C/-D) and must have a relayd listening.\n");
110 fprintf(ofp
, " By default, %u is used for the timer and the\n",
111 DEFAULT_LTTNG_LIVE_TIMER
);
112 fprintf(ofp
, " network URL is set to net://127.0.0.1.\n");
113 fprintf(ofp
, " --shm-path PATH Path where shared memory holding buffers\n");
114 fprintf(ofp
, " should be created. Useful when used with pramfs\n");
115 fprintf(ofp
, " to extract trace data after crash.\n");
117 fprintf(ofp
, "Extended Options:\n");
119 fprintf(ofp
, "Using these options, each API call can be controlled individually.\n");
121 fprintf(ofp
, " -U, --set-url=URL Set URL destination of the trace data.\n");
122 fprintf(ofp
, " It is persistent for the session lifetime.\n");
123 fprintf(ofp
, " This will set both data and control URL.\n");
124 fprintf(ofp
, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n");
125 fprintf(ofp
, " -D, --data-url=URL Set data path URL. (Must use -C also)\n");
127 fprintf(ofp
, "Please refer to the man page (lttng(1)) for more information on network\n");
128 fprintf(ofp
, "streaming mechanisms and explanation of the control and data port\n");
129 fprintf(ofp
, "You must have a running remote lttng-relayd for network streaming\n");
131 fprintf(ofp
, "URL format is has followed:\n");
133 fprintf(ofp
, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
135 fprintf(ofp
, " Supported protocols are (proto):\n");
136 fprintf(ofp
, " > file://...\n");
137 fprintf(ofp
, " Local filesystem full path.\n");
139 fprintf(ofp
, " > net[6]://...\n");
140 fprintf(ofp
, " This will use the default network transport layer which is\n");
141 fprintf(ofp
, " TCP for both control (PORT1) and data port (PORT2).\n");
142 fprintf(ofp
, " The default ports are respectively 5342 and 5343.\n");
144 fprintf(ofp
, " > tcp[6]://...\n");
145 fprintf(ofp
, " Can only be used with -C and -D together\n");
147 fprintf(ofp
, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
149 fprintf(ofp
, "Examples:\n");
150 fprintf(ofp
, " # lttng create -U net://192.168.1.42\n");
151 fprintf(ofp
, " Uses TCP and default ports for the given destination.\n");
152 fprintf(ofp
, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
153 fprintf(ofp
, " Uses TCP, default ports and IPv6.\n");
154 fprintf(ofp
, " # lttng create s1 -U net://myhost.com:3229\n");
155 fprintf(ofp
, " Set the consumer to the remote HOST on port 3229 for control.\n");
160 * Retrieve the created session and mi output it based on provided argument
161 * This is currently a summary of what was pretty printed and is subject to
164 static int mi_created_session(const char *session_name
)
166 int ret
, i
, count
, found
;
167 struct lttng_session
*sessions
;
169 /* session_name should not be null */
170 assert(session_name
);
173 count
= lttng_list_sessions(&sessions
);
176 ERR("%s", lttng_strerror(ret
));
181 ERR("Error session creation failed: session %s not found", session_name
);
182 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
187 for (i
= 0; i
< count
; i
++) {
188 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
190 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
199 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
211 * For a session name, set the consumer URLs.
213 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
214 const char *data_url
)
217 struct lttng_handle
*handle
;
218 struct lttng_domain dom
;
220 assert(session_name
);
223 * Set handle with the session name and the domain set to 0. This means to
224 * the session daemon that the next action applies on the tracing session
225 * rather then the domain specific session.
227 memset(&dom
, 0, sizeof(dom
));
229 handle
= lttng_create_handle(session_name
, &dom
);
230 if (handle
== NULL
) {
235 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
241 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
245 MSG("Data URL %s set for session %s", data_url
, session_name
);
249 lttng_destroy_handle(handle
);
253 static int add_snapshot_output(const char *session_name
, const char *ctrl_url
,
254 const char *data_url
)
257 struct lttng_snapshot_output
*output
= NULL
;
259 assert(session_name
);
261 output
= lttng_snapshot_output_create();
268 ret
= lttng_snapshot_output_set_ctrl_url(ctrl_url
, output
);
275 ret
= lttng_snapshot_output_set_data_url(data_url
, output
);
281 /* This call, if successful, populates the id of the output object. */
282 ret
= lttng_snapshot_add_output(session_name
, output
);
288 lttng_snapshot_output_destroy(output
);
294 * Create a tracing session.
295 * If no name is specified, a default name is generated.
297 * Returns one of the CMD_* result constants.
299 static int create_session(void)
302 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
303 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
304 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
307 char shm_path
[PATH_MAX
] = "";
309 /* Get date and time for automatic session name/path */
311 timeinfo
= localtime(&rawtime
);
312 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
314 /* Auto session name creation */
315 if (opt_session_name
== NULL
) {
316 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
317 DEFAULT_SESSION_NAME
"-%s", datetime
);
319 PERROR("snprintf session name");
322 session_name
= session_name_date
;
323 DBG("Auto session name set to %s", session_name_date
);
325 if (strlen(opt_session_name
) > NAME_MAX
) {
326 ERR("Session name too long. Length must be lower or equal to %d",
328 ret
= LTTNG_ERR_SESSION_FAIL
;
332 * Check if the session name begins with "auto-" or is exactly "auto".
333 * Both are reserved for the default session name. See bug #449 to
334 * understand why we need to check both here.
336 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
337 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
338 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
339 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
340 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
341 ERR("%s is a reserved keyword for default session(s)",
342 DEFAULT_SESSION_NAME
);
346 session_name
= opt_session_name
;
347 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
348 "%s-%s", session_name
, datetime
);
350 PERROR("snprintf session name");
355 if ((!opt_ctrl_url
&& opt_data_url
) || (opt_ctrl_url
&& !opt_data_url
)) {
356 ERR("You need both control and data URL.");
361 if (opt_output_path
!= NULL
) {
362 traces_path
= utils_expand_path(opt_output_path
);
363 if (traces_path
== NULL
) {
368 /* Create URL string from the local file system path */
369 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
371 PERROR("asprintf url path");
375 /* URL to use in the lttng_create_session() call */
377 print_str_url
= traces_path
;
378 } else if (opt_url
) { /* Handling URL (-U opt) */
381 } else if (opt_data_url
&& opt_ctrl_url
) {
383 * With both control and data, we'll be setting the consumer URL after
384 * session creation thus use no URL.
387 } else if (!opt_no_output
) {
390 /* Auto output path */
391 tmp_path
= utils_get_home_dir();
392 if (tmp_path
== NULL
) {
393 ERR("HOME path not found.\n \
394 Please specify an output path using -o, --output PATH");
398 alloc_path
= strdup(tmp_path
);
400 PERROR("allocating alloc_path");
404 ret
= asprintf(&alloc_url
,
405 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
406 alloc_path
, session_name_date
);
408 PERROR("asprintf trace dir name");
414 print_str_url
= alloc_url
+ strlen("file://");
416 /* No output means --no-output or --snapshot mode. */
420 /* Use default live URL if NO url is/are found. */
421 if ((opt_live_timer
&& !opt_url
) && (opt_live_timer
&& !opt_data_url
)) {
422 ret
= asprintf(&alloc_url
, "net://127.0.0.1");
424 PERROR("asprintf default live URL");
432 if (opt_snapshot
&& opt_live_timer
) {
433 ERR("Snapshot and live modes are mutually exclusive.");
439 /* No output by default. */
440 const char *snapshot_url
= NULL
;
444 } else if (!opt_data_url
&& !opt_ctrl_url
) {
445 /* This is the session path that we need to use as output. */
448 ret
= lttng_create_session_snapshot(session_name
, snapshot_url
);
449 } else if (opt_live_timer
) {
450 const char *pathname
;
452 if (opt_relayd_path
) {
453 pathname
= opt_relayd_path
;
455 pathname
= INSTALL_BIN_PATH
"/lttng-relayd";
457 if (!opt_url
&& !opt_data_url
&& !check_relayd() &&
458 spawn_relayd(pathname
, 0) < 0) {
461 ret
= lttng_create_session_live(session_name
, url
, opt_live_timer
);
463 ret
= _lttng_create_session_ext(session_name
, url
, datetime
, -1);
466 /* Don't set ret so lttng can interpret the sessiond error. */
468 case LTTNG_ERR_EXIST_SESS
:
469 WARN("Session %s already exists", session_name
);
477 if (opt_ctrl_url
&& opt_data_url
) {
479 ret
= add_snapshot_output(session_name
, opt_ctrl_url
,
482 /* Setting up control URI (-C or/and -D opt) */
483 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
486 /* Destroy created session because the URL are not valid. */
487 lttng_destroy_session(session_name
);
493 ret
= snprintf(shm_path
, sizeof(shm_path
),
494 "%s/%s", opt_shm_path
, session_name_date
);
496 PERROR("snprintf shm_path");
500 ret
= lttng_set_session_shm_path(session_name
, shm_path
);
502 lttng_destroy_session(session_name
);
507 MSG("Session %s created.", session_name
);
508 if (print_str_url
&& !opt_snapshot
) {
509 MSG("Traces will be written in %s", print_str_url
);
511 if (opt_live_timer
) {
512 MSG("Live timer set to %u usec", opt_live_timer
);
514 } else if (opt_snapshot
) {
516 MSG("Default snapshot output set to: %s", print_str_url
);
518 MSG("Snapshot mode set. Every channel enabled for that session will "
519 "be set in overwrite mode and mmap output.");
522 MSG("Session %s set to shm_path: %s.", session_name
,
528 ret
= mi_created_session(session_name
);
535 /* Init lttng session config */
536 ret
= config_init(session_name
);
550 ERR("%s", lttng_strerror(ret
));
558 * Spawn a session daemon by forking and execv.
560 static int spawn_sessiond(char *pathname
)
565 MSG("Spawning a session daemon");
569 * Spawn session daemon in daemon mode.
571 execlp(pathname
, "lttng-sessiond",
572 "--daemonize", NULL
);
573 /* execlp only returns if error happened */
574 if (errno
== ENOENT
) {
575 ERR("No session daemon found. Use --sessiond-path.");
579 kill(getppid(), SIGTERM
); /* wake parent */
581 } else if (pid
> 0) {
585 * In daemon mode (--daemonize), sessiond only exits when
586 * it's ready to accept commands.
589 waitpid(pid
, &status
, 0);
591 if (WIFSIGNALED(status
)) {
592 ERR("Session daemon was killed by signal %d",
596 } else if (WIFEXITED(status
)) {
597 DBG("Session daemon terminated normally (exit status: %d)",
598 WEXITSTATUS(status
));
600 if (WEXITSTATUS(status
) != 0) {
601 ERR("Session daemon terminated with an error (exit status: %d)",
602 WEXITSTATUS(status
));
624 * Check if the session daemon is available using
625 * the liblttngctl API for the check. If not, try to
628 static int launch_sessiond(void)
631 char *pathname
= NULL
;
633 ret
= lttng_session_daemon_alive();
635 /* Sessiond is alive, not an error */
640 /* Try command line option path */
641 pathname
= opt_sessiond_path
;
643 /* Try LTTNG_SESSIOND_PATH env variable */
644 if (pathname
== NULL
) {
645 pathname
= getenv(DEFAULT_SESSIOND_PATH_ENV
);
648 /* Try with configured path */
649 if (pathname
== NULL
) {
650 if (CONFIG_SESSIOND_BIN
[0] != '\0') {
651 pathname
= CONFIG_SESSIOND_BIN
;
655 /* Try the default path */
656 if (pathname
== NULL
) {
657 pathname
= INSTALL_BIN_PATH
"/lttng-sessiond";
660 DBG("Session daemon binary path: %s", pathname
);
662 /* Check existence and permissions */
663 ret
= access(pathname
, F_OK
| X_OK
);
665 ERR("No such file or access denied: %s", pathname
);
669 ret
= spawn_sessiond(pathname
);
672 ERR("Problem occurred while launching session daemon (%s)",
679 * The 'create <options>' first level command
681 * Returns one of the CMD_* result constants.
683 int cmd_create(int argc
, const char **argv
)
685 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
686 char *opt_arg
= NULL
;
687 static poptContext pc
;
689 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
690 poptReadDefaultConfig(pc
, 0);
692 while ((opt
= poptGetNextOpt(pc
)) != -1) {
697 case OPT_LIST_OPTIONS
:
698 list_cmd_options(stdout
, long_options
);
705 opt_arg
= poptGetOptArg(pc
);
707 /* Set up default values. */
708 opt_live_timer
= (uint32_t) DEFAULT_LTTNG_LIVE_TIMER
;
709 DBG("Session live timer interval set to default value %d",
714 v
= strtoul(opt_arg
, NULL
, 0);
715 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
716 ERR("Wrong value in --live parameter: %s", opt_arg
);
720 if (v
!= (uint32_t) v
) {
721 ERR("32-bit overflow in --live parameter: %s", opt_arg
);
726 ERR("Live timer interval must be greater than zero");
730 opt_live_timer
= (uint32_t) v
;
731 DBG("Session live timer interval set to %d", opt_live_timer
);
741 if (opt_no_consumer
) {
742 MSG("The option --no-consumer is obsolete. Use --no-output now.");
747 /* Spawn a session daemon if needed */
748 if (!opt_no_sessiond
) {
749 ret
= launch_sessiond();
756 /* MI initialization */
758 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
760 ret
= -LTTNG_ERR_NOMEM
;
764 /* Open command element */
765 ret
= mi_lttng_writer_command_open(writer
,
766 mi_lttng_element_command_create
);
772 /* Open output element */
773 ret
= mi_lttng_writer_open_element(writer
,
774 mi_lttng_element_command_output
);
780 opt_session_name
= (char*) poptGetArg(pc
);
782 command_ret
= create_session();
788 /* Close output element */
789 ret
= mi_lttng_writer_close_element(writer
);
796 ret
= mi_lttng_writer_write_element_bool(writer
,
797 mi_lttng_element_command_success
, success
);
803 /* Command element close */
804 ret
= mi_lttng_writer_command_close(writer
);
813 if (writer
&& mi_lttng_writer_destroy(writer
)) {
814 /* Preserve original error code */
815 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
818 /* Overwrite ret if an error occurred in create_session() */
819 ret
= command_ret
? command_ret
: ret
;