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.
25 #include <sys/types.h>
29 #include "../command.h"
32 #include <common/defaults.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
34 #include <common/uri.h>
35 #include <common/utils.h>
37 static char *opt_output_path
;
38 static char *opt_session_name
;
40 static char *opt_ctrl_url
;
41 static char *opt_data_url
;
42 static int opt_no_consumer
;
43 static int opt_disable_consumer
;
50 static struct poptOption long_options
[] = {
51 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
52 {"help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
53 {"output", 'o', POPT_ARG_STRING
, &opt_output_path
, 0, NULL
, NULL
},
54 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
55 {"set-url", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
56 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
57 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
58 {"no-consumer", 0, POPT_ARG_VAL
, &opt_no_consumer
, 1, 0, 0},
59 {"disable-consumer", 0, POPT_ARG_VAL
, &opt_disable_consumer
, 1, 0, 0},
64 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
65 * why this declaration exists and used ONLY in for this command.
67 extern int _lttng_create_session_ext(const char *name
, const char *url
,
68 const char *datetime
);
73 static void usage(FILE *ofp
)
75 fprintf(ofp
, "usage: lttng create [NAME] [OPTIONS] \n");
77 fprintf(ofp
, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
79 fprintf(ofp
, "Options:\n");
80 fprintf(ofp
, " -h, --help Show this help\n");
81 fprintf(ofp
, " --list-options Simple listing of options\n");
82 fprintf(ofp
, " -o, --output PATH Specify output path for traces\n");
84 fprintf(ofp
, "Extended Options:\n");
86 fprintf(ofp
, "Using these options, each API call can be controlled individually.\n");
88 fprintf(ofp
, " -U, --set-url=URL Set URL destination of the trace data.\n");
89 fprintf(ofp
, " It is persistent for the session lifetime.\n");
90 fprintf(ofp
, " This will set both data and control URL.\n");
91 fprintf(ofp
, " You can change it with the enable-consumer cmd\n");
92 fprintf(ofp
, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n");
93 fprintf(ofp
, " -D, --data-url=URL Set data path URL. (Must use -C also)\n");
94 fprintf(ofp
, " --no-consumer Don't activate a consumer for this session.\n");
95 fprintf(ofp
, " OBSELETE\n");
96 fprintf(ofp
, " --disable-consumer\n");
97 fprintf(ofp
, " Disable consumer for this session.\n");
98 fprintf(ofp
, " OBSELETE\n");
100 fprintf(ofp
, "Please refer to the man page (lttng(1)) for more information on network\n");
101 fprintf(ofp
, "streaming mechanisms and explanation of the control and data port\n");
102 fprintf(ofp
, "You must have a running remote lttng-relayd for network streaming\n");
104 fprintf(ofp
, "URL format is has followed:\n");
106 fprintf(ofp
, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
108 fprintf(ofp
, " Supported protocols are (proto):\n");
109 fprintf(ofp
, " > file://...\n");
110 fprintf(ofp
, " Local filesystem full path.\n");
112 fprintf(ofp
, " > net[6]://...\n");
113 fprintf(ofp
, " This will use the default network transport layer which is\n");
114 fprintf(ofp
, " TCP for both control (PORT1) and data port (PORT2).\n");
115 fprintf(ofp
, " The default ports are respectively 5342 and 5343.\n");
117 fprintf(ofp
, " > tcp[6]://...\n");
118 fprintf(ofp
, " Can only be used with -C and -D together\n");
120 fprintf(ofp
, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
122 fprintf(ofp
, "Examples:\n");
123 fprintf(ofp
, " # lttng create -U net://192.168.1.42\n");
124 fprintf(ofp
, " Uses TCP and default ports for the given destination.\n");
125 fprintf(ofp
, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
126 fprintf(ofp
, " Uses TCP, default ports and IPv6.\n");
127 fprintf(ofp
, " # lttng create s1 -U net://myhost.com:3229\n");
128 fprintf(ofp
, " Set the consumer to the remote HOST on port 3229 for control.\n");
133 * For a session name, set the consumer URLs.
135 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
136 const char *data_url
)
139 struct lttng_handle
*handle
;
140 struct lttng_domain dom
;
142 assert(session_name
);
145 * Set handle with the session name and the domain set to 0. This means to
146 * the session daemon that the next action applies on the tracing session
147 * rather then the domain specific session.
149 memset(&dom
, 0, sizeof(dom
));
151 handle
= lttng_create_handle(session_name
, &dom
);
152 if (handle
== NULL
) {
157 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
163 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
167 MSG("Data URL %s set for session %s", data_url
, session_name
);
171 lttng_destroy_handle(handle
);
176 * Create a tracing session.
177 * If no name is specified, a default name is generated.
179 * Returns one of the CMD_* result constants.
181 static int create_session(void)
184 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
185 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
186 char session_name_date
[NAME_MAX
+ 17], *print_str_url
= NULL
;
190 /* Get date and time for automatic session name/path */
192 timeinfo
= localtime(&rawtime
);
193 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
195 /* Auto session name creation */
196 if (opt_session_name
== NULL
) {
197 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
198 DEFAULT_SESSION_NAME
"-%s", datetime
);
200 PERROR("snprintf session name");
203 session_name
= session_name_date
;
204 DBG("Auto session name set to %s", session_name_date
);
206 if (strlen(opt_session_name
) > NAME_MAX
) {
207 ERR("Session name too long. Length must be lower or equal to %d",
209 ret
= LTTNG_ERR_SESSION_FAIL
;
213 * Check if the session name begins with "auto-" or is exactly "auto".
214 * Both are reserved for the default session name. See bug #449 to
215 * understand why we need to check both here.
217 if ((strncmp(opt_session_name
, DEFAULT_SESSION_NAME
"-",
218 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) ||
219 (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
220 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
221 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
))) {
222 ERR("%s is a reserved keyword for default session(s)",
223 DEFAULT_SESSION_NAME
);
227 session_name
= opt_session_name
;
228 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
229 "%s-%s", session_name
, datetime
);
231 PERROR("snprintf session name");
236 if (opt_output_path
!= NULL
) {
237 traces_path
= utils_expand_path(opt_output_path
);
238 if (traces_path
== NULL
) {
243 /* Create URL string from the local filesytem path */
244 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
246 PERROR("asprintf url path");
250 /* URL to use in the lttng_create_session() call */
252 print_str_url
= traces_path
;
253 } else if (opt_url
) { /* Handling URL (-U opt) */
256 } else if (opt_ctrl_url
== NULL
&& opt_data_url
== NULL
) {
257 /* Auto output path */
258 alloc_path
= config_get_default_path();
259 if (alloc_path
== NULL
) {
260 ERR("HOME path not found.\n \
261 Please specify an output path using -o, --output PATH");
265 alloc_path
= strdup(alloc_path
);
267 ret
= asprintf(&alloc_url
,
268 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
269 alloc_path
, session_name_date
);
271 PERROR("asprintf trace dir name");
277 print_str_url
= alloc_url
+ strlen("file://");
282 ret
= _lttng_create_session_ext(session_name
, url
, datetime
);
284 /* Don't set ret so lttng can interpret the sessiond error. */
286 case LTTNG_ERR_EXIST_SESS
:
287 WARN("Session %s already exists", session_name
);
290 ERR("%s", lttng_strerror(ret
));
296 MSG("Session %s created.", session_name
);
298 MSG("Traces will be written in %s", print_str_url
);
301 if (opt_ctrl_url
&& opt_data_url
) {
302 /* Setting up control URI (-C or/and -D opt) */
303 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
307 } else if ((!opt_ctrl_url
&& opt_data_url
) ||
308 (opt_ctrl_url
&& !opt_data_url
)) {
309 ERR("You need both control and data URL.");
314 /* Init lttng session config */
315 ret
= config_init(session_name
);
330 ERR("%s", lttng_strerror(ret
));
336 * The 'create <options>' first level command
338 * Returns one of the CMD_* result constants.
340 int cmd_create(int argc
, const char **argv
)
342 int opt
, ret
= CMD_SUCCESS
;
343 static poptContext pc
;
345 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
346 poptReadDefaultConfig(pc
, 0);
348 while ((opt
= poptGetNextOpt(pc
)) != -1) {
353 case OPT_LIST_OPTIONS
:
354 list_cmd_options(stdout
, long_options
);
363 if (opt_no_consumer
) {
364 MSG("The option --no-consumer is obsolete.");
369 if (opt_disable_consumer
) {
370 MSG("The option --disable-consumer is obsolete.");
375 opt_session_name
= (char*) poptGetArg(pc
);
377 ret
= create_session();
This page took 0.038583 seconds and 4 git commands to generate.