Commit | Line | Data |
---|---|---|
f3ed775e DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
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. | |
f3ed775e DG |
7 | * |
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. | |
12 | * | |
d14d33bf AM |
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. | |
f3ed775e DG |
16 | */ |
17 | ||
18 | #define _GNU_SOURCE | |
a4b92340 | 19 | #include <assert.h> |
f3ed775e DG |
20 | #include <popt.h> |
21 | #include <stdio.h> | |
22 | #include <stdlib.h> | |
23 | #include <string.h> | |
24 | #include <sys/stat.h> | |
25 | #include <sys/types.h> | |
26 | #include <time.h> | |
27 | #include <unistd.h> | |
28 | ||
c399183f | 29 | #include "../command.h" |
679b4943 | 30 | #include "../utils.h" |
f3ed775e | 31 | |
00e2e675 | 32 | #include <common/defaults.h> |
42224349 | 33 | #include <common/sessiond-comm/sessiond-comm.h> |
00e2e675 | 34 | #include <common/uri.h> |
81b86775 | 35 | #include <common/utils.h> |
16f6f820 | 36 | #include <lttng/snapshot.h> |
42224349 | 37 | |
f3ed775e DG |
38 | static char *opt_output_path; |
39 | static char *opt_session_name; | |
a4b92340 DG |
40 | static char *opt_url; |
41 | static char *opt_ctrl_url; | |
42 | static char *opt_data_url; | |
43 | static int opt_no_consumer; | |
2bba9e53 | 44 | static int opt_no_output; |
16f6f820 | 45 | static int opt_snapshot; |
a4b92340 | 46 | static int opt_disable_consumer; |
f3ed775e DG |
47 | |
48 | enum { | |
49 | OPT_HELP = 1, | |
679b4943 | 50 | OPT_LIST_OPTIONS, |
f3ed775e DG |
51 | }; |
52 | ||
53 | static struct poptOption long_options[] = { | |
54 | /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ | |
679b4943 SM |
55 | {"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL}, |
56 | {"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL}, | |
57 | {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL}, | |
23d14dff DG |
58 | {"set-url", 'U', POPT_ARG_STRING, &opt_url, 0, 0, 0}, |
59 | {"ctrl-url", 'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0}, | |
60 | {"data-url", 'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0}, | |
2bba9e53 DG |
61 | {"no-output", 0, POPT_ARG_VAL, &opt_no_output, 1, 0, 0}, |
62 | {"no-consumer", 0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0}, | |
a4b92340 | 63 | {"disable-consumer", 0, POPT_ARG_VAL, &opt_disable_consumer, 1, 0, 0}, |
16f6f820 | 64 | {"snapshot", 0, POPT_ARG_VAL, &opt_snapshot, 1, 0, 0}, |
f3ed775e DG |
65 | {0, 0, 0, 0, 0, 0, 0} |
66 | }; | |
67 | ||
16de1a24 DG |
68 | /* |
69 | * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on | |
70 | * why this declaration exists and used ONLY in for this command. | |
71 | */ | |
07424f16 DG |
72 | extern int _lttng_create_session_ext(const char *name, const char *url, |
73 | const char *datetime); | |
74 | ||
f3ed775e DG |
75 | /* |
76 | * usage | |
77 | */ | |
78 | static void usage(FILE *ofp) | |
79 | { | |
a4b92340 | 80 | fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n"); |
f3ed775e | 81 | fprintf(ofp, "\n"); |
a4b92340 DG |
82 | fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n"); |
83 | fprintf(ofp, "\n"); | |
84 | fprintf(ofp, "Options:\n"); | |
f3ed775e | 85 | fprintf(ofp, " -h, --help Show this help\n"); |
1c8d13c8 | 86 | fprintf(ofp, " --list-options Simple listing of options\n"); |
58a97671 | 87 | fprintf(ofp, " -o, --output PATH Specify output path for traces\n"); |
2bba9e53 | 88 | fprintf(ofp, " --no-output Traces will not be outputed\n"); |
16f6f820 DG |
89 | fprintf(ofp, " --snasphot Set the session in snapshot mode.\n"); |
90 | fprintf(ofp, " Created in no-output mode and uses the URL,\n"); | |
91 | fprintf(ofp, " if one, as the default snapshot output.\n"); | |
92 | fprintf(ofp, " Every channel will be set in overwrite mode\n"); | |
93 | fprintf(ofp, " and with mmap output (splice not supported).\n"); | |
a4b92340 DG |
94 | fprintf(ofp, "\n"); |
95 | fprintf(ofp, "Extended Options:\n"); | |
96 | fprintf(ofp, "\n"); | |
97 | fprintf(ofp, "Using these options, each API call can be controlled individually.\n"); | |
98 | fprintf(ofp, "\n"); | |
99 | fprintf(ofp, " -U, --set-url=URL Set URL destination of the trace data.\n"); | |
00e2e675 | 100 | fprintf(ofp, " It is persistent for the session lifetime.\n"); |
a4b92340 DG |
101 | fprintf(ofp, " This will set both data and control URL.\n"); |
102 | fprintf(ofp, " You can change it with the enable-consumer cmd\n"); | |
103 | fprintf(ofp, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n"); | |
104 | fprintf(ofp, " -D, --data-url=URL Set data path URL. (Must use -C also)\n"); | |
a4b92340 DG |
105 | fprintf(ofp, "\n"); |
106 | fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n"); | |
107 | fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n"); | |
108 | fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n"); | |
109 | fprintf(ofp, "\n"); | |
110 | fprintf(ofp, "URL format is has followed:\n"); | |
111 | fprintf(ofp, "\n"); | |
112 | fprintf(ofp, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n"); | |
113 | fprintf(ofp, "\n"); | |
114 | fprintf(ofp, " Supported protocols are (proto):\n"); | |
115 | fprintf(ofp, " > file://...\n"); | |
116 | fprintf(ofp, " Local filesystem full path.\n"); | |
117 | fprintf(ofp, "\n"); | |
16de1a24 | 118 | fprintf(ofp, " > net[6]://...\n"); |
a4b92340 DG |
119 | fprintf(ofp, " This will use the default network transport layer which is\n"); |
120 | fprintf(ofp, " TCP for both control (PORT1) and data port (PORT2).\n"); | |
121 | fprintf(ofp, " The default ports are respectively 5342 and 5343.\n"); | |
122 | fprintf(ofp, "\n"); | |
0ab61906 | 123 | fprintf(ofp, " > tcp[6]://...\n"); |
a4b92340 DG |
124 | fprintf(ofp, " Can only be used with -C and -D together\n"); |
125 | fprintf(ofp, "\n"); | |
126 | fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n"); | |
127 | fprintf(ofp, "\n"); | |
128 | fprintf(ofp, "Examples:\n"); | |
129 | fprintf(ofp, " # lttng create -U net://192.168.1.42\n"); | |
130 | fprintf(ofp, " Uses TCP and default ports for the given destination.\n"); | |
131 | fprintf(ofp, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n"); | |
132 | fprintf(ofp, " Uses TCP, default ports and IPv6.\n"); | |
133 | fprintf(ofp, " # lttng create s1 -U net://myhost.com:3229\n"); | |
134 | fprintf(ofp, " Set the consumer to the remote HOST on port 3229 for control.\n"); | |
f3ed775e DG |
135 | fprintf(ofp, "\n"); |
136 | } | |
137 | ||
00e2e675 | 138 | /* |
a4b92340 | 139 | * For a session name, set the consumer URLs. |
00e2e675 | 140 | */ |
a4b92340 DG |
141 | static int set_consumer_url(const char *session_name, const char *ctrl_url, |
142 | const char *data_url) | |
00e2e675 | 143 | { |
a4b92340 DG |
144 | int ret; |
145 | struct lttng_handle *handle; | |
146 | struct lttng_domain dom; | |
147 | ||
148 | assert(session_name); | |
149 | ||
150 | /* | |
151 | * Set handle with the session name and the domain set to 0. This means to | |
152 | * the session daemon that the next action applies on the tracing session | |
153 | * rather then the domain specific session. | |
154 | */ | |
155 | memset(&dom, 0, sizeof(dom)); | |
156 | ||
157 | handle = lttng_create_handle(session_name, &dom); | |
158 | if (handle == NULL) { | |
159 | ret = CMD_FATAL; | |
160 | goto error; | |
161 | } | |
00e2e675 | 162 | |
a4b92340 DG |
163 | ret = lttng_set_consumer_url(handle, ctrl_url, data_url); |
164 | if (ret < 0) { | |
165 | goto error; | |
00e2e675 DG |
166 | } |
167 | ||
a4b92340 DG |
168 | if (ctrl_url) { |
169 | MSG("Control URL %s set for session %s", ctrl_url, session_name); | |
00e2e675 DG |
170 | } |
171 | ||
a4b92340 DG |
172 | if (data_url) { |
173 | MSG("Data URL %s set for session %s", data_url, session_name); | |
174 | } | |
175 | ||
176 | error: | |
177 | lttng_destroy_handle(handle); | |
178 | return ret; | |
179 | } | |
180 | ||
16f6f820 DG |
181 | static int add_snapshot_output(const char *session_name, const char *ctrl_url, |
182 | const char *data_url) | |
183 | { | |
184 | int ret; | |
185 | struct lttng_snapshot_output *output = NULL; | |
186 | ||
187 | assert(session_name); | |
188 | ||
189 | output = lttng_snapshot_output_create(); | |
190 | if (!output) { | |
191 | ret = CMD_FATAL; | |
192 | goto error_create; | |
193 | } | |
194 | ||
195 | if (ctrl_url) { | |
196 | ret = lttng_snapshot_output_set_ctrl_url(ctrl_url, output); | |
197 | if (ret < 0) { | |
198 | goto error; | |
199 | } | |
200 | } | |
201 | ||
202 | if (data_url) { | |
203 | ret = lttng_snapshot_output_set_data_url(data_url, output); | |
204 | if (ret < 0) { | |
205 | goto error; | |
206 | } | |
207 | } | |
208 | ||
209 | /* This call, if successful, populates the id of the output object. */ | |
210 | ret = lttng_snapshot_add_output(session_name, output); | |
211 | if (ret < 0) { | |
212 | goto error; | |
213 | } | |
214 | ||
215 | error: | |
216 | lttng_snapshot_output_destroy(output); | |
217 | error_create: | |
218 | return ret; | |
219 | } | |
220 | ||
f3ed775e | 221 | /* |
1c8d13c8 TD |
222 | * Create a tracing session. |
223 | * If no name is specified, a default name is generated. | |
f3ed775e | 224 | * |
1c8d13c8 | 225 | * Returns one of the CMD_* result constants. |
f3ed775e | 226 | */ |
a4b92340 | 227 | static int create_session(void) |
f3ed775e | 228 | { |
a4b92340 | 229 | int ret; |
07424f16 | 230 | char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL; |
a4b92340 | 231 | char *alloc_url = NULL, *url = NULL, datetime[16]; |
487b253b | 232 | char session_name_date[NAME_MAX + 17], *print_str_url = NULL; |
f3ed775e DG |
233 | time_t rawtime; |
234 | struct tm *timeinfo; | |
235 | ||
d6175221 DG |
236 | /* Get date and time for automatic session name/path */ |
237 | time(&rawtime); | |
238 | timeinfo = localtime(&rawtime); | |
239 | strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo); | |
240 | ||
f3ed775e DG |
241 | /* Auto session name creation */ |
242 | if (opt_session_name == NULL) { | |
07424f16 DG |
243 | ret = snprintf(session_name_date, sizeof(session_name_date), |
244 | DEFAULT_SESSION_NAME "-%s", datetime); | |
d6175221 | 245 | if (ret < 0) { |
07424f16 DG |
246 | PERROR("snprintf session name"); |
247 | goto error; | |
248 | } | |
04965770 | 249 | session_name = session_name_date; |
07424f16 | 250 | DBG("Auto session name set to %s", session_name_date); |
f3ed775e | 251 | } else { |
487b253b DG |
252 | if (strlen(opt_session_name) > NAME_MAX) { |
253 | ERR("Session name too long. Length must be lower or equal to %d", | |
254 | NAME_MAX); | |
255 | ret = LTTNG_ERR_SESSION_FAIL; | |
256 | goto error; | |
257 | } | |
4b861950 DG |
258 | /* |
259 | * Check if the session name begins with "auto-" or is exactly "auto". | |
260 | * Both are reserved for the default session name. See bug #449 to | |
261 | * understand why we need to check both here. | |
262 | */ | |
263 | if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-", | |
264 | strlen(DEFAULT_SESSION_NAME) + 1) == 0) || | |
265 | (strncmp(opt_session_name, DEFAULT_SESSION_NAME, | |
61b35a5a | 266 | strlen(DEFAULT_SESSION_NAME)) == 0 && |
4b861950 | 267 | strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) { |
61b35a5a DG |
268 | ERR("%s is a reserved keyword for default session(s)", |
269 | DEFAULT_SESSION_NAME); | |
270 | ret = CMD_ERROR; | |
271 | goto error; | |
272 | } | |
f3ed775e | 273 | session_name = opt_session_name; |
07424f16 DG |
274 | ret = snprintf(session_name_date, sizeof(session_name_date), |
275 | "%s-%s", session_name, datetime); | |
276 | if (ret < 0) { | |
277 | PERROR("snprintf session name"); | |
278 | goto error; | |
279 | } | |
f3ed775e DG |
280 | } |
281 | ||
785d2d0d | 282 | if (opt_output_path != NULL) { |
81b86775 | 283 | traces_path = utils_expand_path(opt_output_path); |
00e2e675 DG |
284 | if (traces_path == NULL) { |
285 | ret = CMD_ERROR; | |
286 | goto error; | |
287 | } | |
288 | ||
a4b92340 DG |
289 | /* Create URL string from the local filesytem path */ |
290 | ret = asprintf(&alloc_url, "file://%s", traces_path); | |
00e2e675 | 291 | if (ret < 0) { |
a4b92340 | 292 | PERROR("asprintf url path"); |
00e2e675 DG |
293 | ret = CMD_FATAL; |
294 | goto error; | |
295 | } | |
a4b92340 DG |
296 | /* URL to use in the lttng_create_session() call */ |
297 | url = alloc_url; | |
40b03f52 | 298 | print_str_url = traces_path; |
a4b92340 DG |
299 | } else if (opt_url) { /* Handling URL (-U opt) */ |
300 | url = opt_url; | |
40b03f52 | 301 | print_str_url = url; |
2bba9e53 | 302 | } else if (!opt_no_output) { |
00e2e675 | 303 | /* Auto output path */ |
feb0f3e5 | 304 | alloc_path = utils_get_home_dir(); |
f3ed775e | 305 | if (alloc_path == NULL) { |
d386b234 | 306 | ERR("HOME path not found.\n \ |
00e2e675 | 307 | Please specify an output path using -o, --output PATH"); |
f3ed775e DG |
308 | ret = CMD_FATAL; |
309 | goto error; | |
310 | } | |
d386b234 | 311 | alloc_path = strdup(alloc_path); |
f3ed775e | 312 | |
07424f16 DG |
313 | ret = asprintf(&alloc_url, |
314 | "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s", | |
315 | alloc_path, session_name_date); | |
58a97671 | 316 | if (ret < 0) { |
00e2e675 DG |
317 | PERROR("asprintf trace dir name"); |
318 | ret = CMD_FATAL; | |
58a97671 DG |
319 | goto error; |
320 | } | |
00e2e675 | 321 | |
a4b92340 | 322 | url = alloc_url; |
4f50c803 DG |
323 | if (!opt_data_url && !opt_ctrl_url) { |
324 | print_str_url = alloc_url + strlen("file://"); | |
325 | } | |
2bba9e53 | 326 | } else { |
16f6f820 | 327 | /* No output means --no-output or --snapshot mode. */ |
2bba9e53 | 328 | url = NULL; |
00e2e675 DG |
329 | } |
330 | ||
4f50c803 DG |
331 | if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) { |
332 | ERR("You need both control and data URL."); | |
333 | ret = CMD_ERROR; | |
334 | goto error; | |
335 | } | |
785d2d0d | 336 | |
16f6f820 DG |
337 | if (opt_snapshot) { |
338 | /* No output by default. */ | |
339 | const char *snapshot_url = NULL; | |
340 | ||
341 | if (opt_url) { | |
342 | snapshot_url = url; | |
343 | } else if (!opt_data_url && !opt_ctrl_url) { | |
344 | /* This is the session path that we need to use as output. */ | |
345 | snapshot_url = url; | |
346 | } | |
347 | ret = lttng_create_session_snapshot(session_name, snapshot_url); | |
348 | } else { | |
349 | ret = _lttng_create_session_ext(session_name, url, datetime); | |
350 | } | |
f3ed775e | 351 | if (ret < 0) { |
ae856491 | 352 | /* Don't set ret so lttng can interpret the sessiond error. */ |
42224349 | 353 | switch (-ret) { |
f73fabfd | 354 | case LTTNG_ERR_EXIST_SESS: |
42224349 DG |
355 | WARN("Session %s already exists", session_name); |
356 | break; | |
60e835ca | 357 | default: |
60e835ca | 358 | break; |
42224349 | 359 | } |
f3ed775e DG |
360 | goto error; |
361 | } | |
362 | ||
0ab61906 | 363 | if (opt_ctrl_url && opt_data_url) { |
16f6f820 DG |
364 | if (opt_snapshot) { |
365 | ret = add_snapshot_output(session_name, opt_ctrl_url, | |
366 | opt_data_url); | |
367 | } else { | |
368 | /* Setting up control URI (-C or/and -D opt) */ | |
369 | ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url); | |
370 | } | |
a4b92340 | 371 | if (ret < 0) { |
4f50c803 DG |
372 | /* Destroy created session because the URL are not valid. */ |
373 | lttng_destroy_session(session_name); | |
a4b92340 DG |
374 | goto error; |
375 | } | |
4f50c803 DG |
376 | } |
377 | ||
378 | MSG("Session %s created.", session_name); | |
16f6f820 | 379 | if (print_str_url && !opt_snapshot) { |
4f50c803 | 380 | MSG("Traces will be written in %s", print_str_url); |
16f6f820 DG |
381 | } else if (opt_snapshot) { |
382 | if (print_str_url) { | |
383 | MSG("Default snapshot output set to: %s", print_str_url); | |
384 | } | |
385 | MSG("Snapshot mode set. Every channel enabled for that session will " | |
386 | "be set in overwrite mode and mmap output"); | |
a4b92340 DG |
387 | } |
388 | ||
58a97671 DG |
389 | /* Init lttng session config */ |
390 | ret = config_init(session_name); | |
f3ed775e | 391 | if (ret < 0) { |
27089920 | 392 | ret = CMD_ERROR; |
f3ed775e DG |
393 | goto error; |
394 | } | |
395 | ||
f3ed775e DG |
396 | ret = CMD_SUCCESS; |
397 | ||
398 | error: | |
0e428499 DG |
399 | free(alloc_url); |
400 | free(traces_path); | |
87f222b6 | 401 | free(alloc_path); |
a4b92340 DG |
402 | |
403 | if (ret < 0) { | |
404 | ERR("%s", lttng_strerror(ret)); | |
405 | } | |
f3ed775e DG |
406 | return ret; |
407 | } | |
408 | ||
409 | /* | |
74cc1d0f | 410 | * The 'create <options>' first level command |
1c8d13c8 TD |
411 | * |
412 | * Returns one of the CMD_* result constants. | |
f3ed775e DG |
413 | */ |
414 | int cmd_create(int argc, const char **argv) | |
415 | { | |
416 | int opt, ret = CMD_SUCCESS; | |
417 | static poptContext pc; | |
418 | ||
419 | pc = poptGetContext(NULL, argc, argv, long_options, 0); | |
420 | poptReadDefaultConfig(pc, 0); | |
421 | ||
422 | while ((opt = poptGetNextOpt(pc)) != -1) { | |
423 | switch (opt) { | |
424 | case OPT_HELP: | |
27089920 | 425 | usage(stdout); |
f3ed775e | 426 | goto end; |
679b4943 SM |
427 | case OPT_LIST_OPTIONS: |
428 | list_cmd_options(stdout, long_options); | |
679b4943 | 429 | goto end; |
f3ed775e DG |
430 | default: |
431 | usage(stderr); | |
432 | ret = CMD_UNDEFINED; | |
433 | goto end; | |
434 | } | |
435 | } | |
436 | ||
785d2d0d | 437 | if (opt_no_consumer) { |
2bba9e53 | 438 | MSG("The option --no-consumer is obsolete. Use --no-output now."); |
785d2d0d DG |
439 | ret = CMD_WARNING; |
440 | goto end; | |
441 | } | |
442 | ||
443 | if (opt_disable_consumer) { | |
444 | MSG("The option --disable-consumer is obsolete."); | |
445 | ret = CMD_WARNING; | |
446 | goto end; | |
447 | } | |
448 | ||
f3ed775e DG |
449 | opt_session_name = (char*) poptGetArg(pc); |
450 | ||
451 | ret = create_session(); | |
452 | ||
453 | end: | |
ca1c3607 | 454 | poptFreeContext(pc); |
f3ed775e DG |
455 | return ret; |
456 | } |