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-uri", 'U', POPT_ARG_STRING
, &opt_url
, 0, 0, 0},
56 {"ctrl-uri", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
57 {"data-uri", '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
, " --disable-consumer\n");
96 fprintf(ofp
, " Disable consumer for this session.\n");
98 fprintf(ofp
, "Please refer to the man page (lttng(1)) for more information on network\n");
99 fprintf(ofp
, "streaming mechanisms and explanation of the control and data port\n");
100 fprintf(ofp
, "You must have a running remote lttng-relayd for network streaming\n");
102 fprintf(ofp
, "URL format is has followed:\n");
104 fprintf(ofp
, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
106 fprintf(ofp
, " Supported protocols are (proto):\n");
107 fprintf(ofp
, " > file://...\n");
108 fprintf(ofp
, " Local filesystem full path.\n");
110 fprintf(ofp
, " > net[6]://...\n");
111 fprintf(ofp
, " This will use the default network transport layer which is\n");
112 fprintf(ofp
, " TCP for both control (PORT1) and data port (PORT2).\n");
113 fprintf(ofp
, " The default ports are respectively 5342 and 5343.\n");
115 fprintf(ofp
, " > tcp[4|6]://...\n");
116 fprintf(ofp
, " Can only be used with -C and -D together\n");
118 fprintf(ofp
, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
120 fprintf(ofp
, "Examples:\n");
121 fprintf(ofp
, " # lttng create -U net://192.168.1.42\n");
122 fprintf(ofp
, " Uses TCP and default ports for the given destination.\n");
123 fprintf(ofp
, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
124 fprintf(ofp
, " Uses TCP, default ports and IPv6.\n");
125 fprintf(ofp
, " # lttng create s1 -U net://myhost.com:3229\n");
126 fprintf(ofp
, " Set the consumer to the remote HOST on port 3229 for control.\n");
131 * For a session name, set the consumer URLs.
133 static int set_consumer_url(const char *session_name
, const char *ctrl_url
,
134 const char *data_url
)
137 struct lttng_handle
*handle
;
138 struct lttng_domain dom
;
140 assert(session_name
);
143 * Set handle with the session name and the domain set to 0. This means to
144 * the session daemon that the next action applies on the tracing session
145 * rather then the domain specific session.
147 memset(&dom
, 0, sizeof(dom
));
149 handle
= lttng_create_handle(session_name
, &dom
);
150 if (handle
== NULL
) {
155 ret
= lttng_set_consumer_url(handle
, ctrl_url
, data_url
);
161 MSG("Control URL %s set for session %s", ctrl_url
, session_name
);
165 MSG("Data URL %s set for session %s", data_url
, session_name
);
169 lttng_destroy_handle(handle
);
174 * For a session name, enable the consumer.
176 static int enable_consumer(const char *session_name
)
179 struct lttng_handle
*handle
;
180 struct lttng_domain dom
;
182 assert(session_name
);
185 * Set handle with the session name and the domain set to 0. This means to
186 * the session daemon that the next action applies on the tracing session
187 * rather then the domain specific session.
189 * XXX: This '0' value should be a domain enum value.
191 memset(&dom
, 0, sizeof(dom
));
193 handle
= lttng_create_handle(session_name
, 0);
194 if (handle
== NULL
) {
199 ret
= lttng_enable_consumer(handle
);
204 MSG("Consumer enabled for session %s", session_name
);
207 lttng_destroy_handle(handle
);
212 * For a session name, disable the consumer.
214 static int disable_consumer(const char *session_name
)
217 struct lttng_handle
*handle
;
219 assert(session_name
);
222 * Set handle with the session name and the domain set to 0. This means to
223 * the session daemon that the next action applies on the tracing session
224 * rather then the domain specific session.
226 * XXX: This '0' value should be a domain enum value.
228 handle
= lttng_create_handle(session_name
, 0);
229 if (handle
== NULL
) {
234 ret
= lttng_disable_consumer(handle
);
240 MSG("Consumer disabled for session %s", session_name
);
247 * Create a tracing session.
248 * If no name is specified, a default name is generated.
250 * Returns one of the CMD_* result constants.
252 static int create_session(void)
255 char *session_name
= NULL
, *traces_path
= NULL
, *alloc_path
= NULL
;
256 char *alloc_url
= NULL
, *url
= NULL
, datetime
[16];
257 char session_name_date
[NAME_MAX
], *print_str_url
= NULL
;
261 /* Get date and time for automatic session name/path */
263 timeinfo
= localtime(&rawtime
);
264 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
266 /* Auto session name creation */
267 if (opt_session_name
== NULL
) {
268 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
269 DEFAULT_SESSION_NAME
"-%s", datetime
);
271 PERROR("snprintf session name");
274 session_name
= session_name_date
;
275 DBG("Auto session name set to %s", session_name_date
);
277 if (strncmp(opt_session_name
, DEFAULT_SESSION_NAME
,
278 strlen(DEFAULT_SESSION_NAME
)) == 0 &&
279 strlen(opt_session_name
) == strlen(DEFAULT_SESSION_NAME
)) {
280 ERR("%s is a reserved keyword for default session(s)",
281 DEFAULT_SESSION_NAME
);
285 session_name
= opt_session_name
;
286 ret
= snprintf(session_name_date
, sizeof(session_name_date
),
287 "%s-%s", session_name
, datetime
);
289 PERROR("snprintf session name");
294 if (opt_no_consumer
) {
297 } else if (opt_output_path
!= NULL
) {
298 traces_path
= utils_expand_path(opt_output_path
);
299 if (traces_path
== NULL
) {
304 /* Create URL string from the local filesytem path */
305 ret
= asprintf(&alloc_url
, "file://%s", traces_path
);
307 PERROR("asprintf url path");
311 /* URL to use in the lttng_create_session() call */
313 print_str_url
= traces_path
;
314 } else if (opt_url
) { /* Handling URL (-U opt) */
317 } else if (opt_ctrl_url
== NULL
&& opt_data_url
== NULL
) {
318 /* Auto output path */
319 alloc_path
= config_get_default_path();
320 if (alloc_path
== NULL
) {
321 ERR("HOME path not found.\n \
322 Please specify an output path using -o, --output PATH");
326 alloc_path
= strdup(alloc_path
);
328 ret
= asprintf(&alloc_url
,
329 "file://%s/" DEFAULT_TRACE_DIR_NAME
"/%s",
330 alloc_path
, session_name_date
);
332 PERROR("asprintf trace dir name");
338 print_str_url
= alloc_url
+ strlen("file://");
341 ret
= _lttng_create_session_ext(session_name
, url
, datetime
);
343 /* Don't set ret so lttng can interpret the sessiond error. */
345 case LTTNG_ERR_EXIST_SESS
:
346 WARN("Session %s already exists", session_name
);
352 MSG("Session %s created.", session_name
);
353 MSG("Traces will be written in %s", print_str_url
);
355 if (opt_ctrl_url
|| opt_data_url
) {
356 /* Setting up control URI (-C or/and -D opt) */
357 ret
= set_consumer_url(session_name
, opt_ctrl_url
, opt_data_url
);
362 ret
= enable_consumer(session_name
);
368 if (opt_disable_consumer
&& !opt_no_consumer
) {
369 ret
= disable_consumer(session_name
);
375 /* Init lttng session config */
376 ret
= config_init(session_name
);
396 ERR("%s", lttng_strerror(ret
));
402 * The 'create <options>' first level command
404 * Returns one of the CMD_* result constants.
406 int cmd_create(int argc
, const char **argv
)
408 int opt
, ret
= CMD_SUCCESS
;
409 static poptContext pc
;
411 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
412 poptReadDefaultConfig(pc
, 0);
414 while ((opt
= poptGetNextOpt(pc
)) != -1) {
419 case OPT_LIST_OPTIONS
:
420 list_cmd_options(stdout
, long_options
);
429 opt_session_name
= (char*) poptGetArg(pc
);
431 ret
= create_session();
This page took 0.042095 seconds and 6 git commands to generate.