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> |
42224349 | 36 | |
f3ed775e DG |
37 | static char *opt_output_path; |
38 | static char *opt_session_name; | |
a4b92340 DG |
39 | static char *opt_url; |
40 | static char *opt_ctrl_url; | |
41 | static char *opt_data_url; | |
42 | static int opt_no_consumer; | |
43 | static int opt_disable_consumer; | |
f3ed775e DG |
44 | |
45 | enum { | |
46 | OPT_HELP = 1, | |
679b4943 | 47 | OPT_LIST_OPTIONS, |
f3ed775e DG |
48 | }; |
49 | ||
50 | static struct poptOption long_options[] = { | |
51 | /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ | |
679b4943 SM |
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}, | |
a4b92340 DG |
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}, | |
f3ed775e DG |
60 | {0, 0, 0, 0, 0, 0, 0} |
61 | }; | |
62 | ||
16de1a24 DG |
63 | /* |
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. | |
66 | */ | |
07424f16 DG |
67 | extern int _lttng_create_session_ext(const char *name, const char *url, |
68 | const char *datetime); | |
69 | ||
f3ed775e DG |
70 | /* |
71 | * usage | |
72 | */ | |
73 | static void usage(FILE *ofp) | |
74 | { | |
a4b92340 | 75 | fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n"); |
f3ed775e | 76 | fprintf(ofp, "\n"); |
a4b92340 DG |
77 | fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n"); |
78 | fprintf(ofp, "\n"); | |
79 | fprintf(ofp, "Options:\n"); | |
f3ed775e | 80 | fprintf(ofp, " -h, --help Show this help\n"); |
1c8d13c8 | 81 | fprintf(ofp, " --list-options Simple listing of options\n"); |
58a97671 | 82 | fprintf(ofp, " -o, --output PATH Specify output path for traces\n"); |
a4b92340 DG |
83 | fprintf(ofp, "\n"); |
84 | fprintf(ofp, "Extended Options:\n"); | |
85 | fprintf(ofp, "\n"); | |
86 | fprintf(ofp, "Using these options, each API call can be controlled individually.\n"); | |
87 | fprintf(ofp, "\n"); | |
88 | fprintf(ofp, " -U, --set-url=URL Set URL destination of the trace data.\n"); | |
00e2e675 | 89 | fprintf(ofp, " It is persistent for the session lifetime.\n"); |
a4b92340 DG |
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"); | |
97 | fprintf(ofp, "\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"); | |
101 | fprintf(ofp, "\n"); | |
102 | fprintf(ofp, "URL format is has followed:\n"); | |
103 | fprintf(ofp, "\n"); | |
104 | fprintf(ofp, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n"); | |
105 | fprintf(ofp, "\n"); | |
106 | fprintf(ofp, " Supported protocols are (proto):\n"); | |
107 | fprintf(ofp, " > file://...\n"); | |
108 | fprintf(ofp, " Local filesystem full path.\n"); | |
109 | fprintf(ofp, "\n"); | |
16de1a24 | 110 | fprintf(ofp, " > net[6]://...\n"); |
a4b92340 DG |
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"); | |
114 | fprintf(ofp, "\n"); | |
115 | fprintf(ofp, " > tcp[4|6]://...\n"); | |
116 | fprintf(ofp, " Can only be used with -C and -D together\n"); | |
117 | fprintf(ofp, "\n"); | |
118 | fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n"); | |
119 | fprintf(ofp, "\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"); | |
f3ed775e DG |
127 | fprintf(ofp, "\n"); |
128 | } | |
129 | ||
00e2e675 | 130 | /* |
a4b92340 | 131 | * For a session name, set the consumer URLs. |
00e2e675 | 132 | */ |
a4b92340 DG |
133 | static int set_consumer_url(const char *session_name, const char *ctrl_url, |
134 | const char *data_url) | |
00e2e675 | 135 | { |
a4b92340 DG |
136 | int ret; |
137 | struct lttng_handle *handle; | |
138 | struct lttng_domain dom; | |
139 | ||
140 | assert(session_name); | |
141 | ||
142 | /* | |
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. | |
146 | */ | |
147 | memset(&dom, 0, sizeof(dom)); | |
148 | ||
149 | handle = lttng_create_handle(session_name, &dom); | |
150 | if (handle == NULL) { | |
151 | ret = CMD_FATAL; | |
152 | goto error; | |
153 | } | |
00e2e675 | 154 | |
a4b92340 DG |
155 | ret = lttng_set_consumer_url(handle, ctrl_url, data_url); |
156 | if (ret < 0) { | |
157 | goto error; | |
00e2e675 DG |
158 | } |
159 | ||
a4b92340 DG |
160 | if (ctrl_url) { |
161 | MSG("Control URL %s set for session %s", ctrl_url, session_name); | |
00e2e675 DG |
162 | } |
163 | ||
a4b92340 DG |
164 | if (data_url) { |
165 | MSG("Data URL %s set for session %s", data_url, session_name); | |
166 | } | |
167 | ||
168 | error: | |
169 | lttng_destroy_handle(handle); | |
170 | return ret; | |
171 | } | |
172 | ||
173 | /* | |
174 | * For a session name, enable the consumer. | |
175 | */ | |
176 | static int enable_consumer(const char *session_name) | |
177 | { | |
178 | int ret; | |
179 | struct lttng_handle *handle; | |
180 | struct lttng_domain dom; | |
181 | ||
182 | assert(session_name); | |
183 | ||
184 | /* | |
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. | |
188 | * | |
189 | * XXX: This '0' value should be a domain enum value. | |
190 | */ | |
191 | memset(&dom, 0, sizeof(dom)); | |
192 | ||
193 | handle = lttng_create_handle(session_name, 0); | |
194 | if (handle == NULL) { | |
195 | ret = CMD_FATAL; | |
196 | goto error; | |
00e2e675 DG |
197 | } |
198 | ||
a4b92340 DG |
199 | ret = lttng_enable_consumer(handle); |
200 | if (ret < 0) { | |
201 | goto error; | |
202 | } | |
203 | ||
204 | MSG("Consumer enabled for session %s", session_name); | |
205 | ||
206 | error: | |
207 | lttng_destroy_handle(handle); | |
208 | return ret; | |
00e2e675 DG |
209 | } |
210 | ||
211 | /* | |
a4b92340 | 212 | * For a session name, disable the consumer. |
00e2e675 | 213 | */ |
a4b92340 | 214 | static int disable_consumer(const char *session_name) |
00e2e675 | 215 | { |
a4b92340 DG |
216 | int ret; |
217 | struct lttng_handle *handle; | |
218 | ||
219 | assert(session_name); | |
220 | ||
221 | /* | |
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. | |
225 | * | |
226 | * XXX: This '0' value should be a domain enum value. | |
227 | */ | |
228 | handle = lttng_create_handle(session_name, 0); | |
229 | if (handle == NULL) { | |
230 | ret = CMD_FATAL; | |
231 | goto error; | |
00e2e675 DG |
232 | } |
233 | ||
a4b92340 DG |
234 | ret = lttng_disable_consumer(handle); |
235 | if (ret < 0) { | |
236 | goto error; | |
237 | } | |
238 | free(handle); | |
00e2e675 | 239 | |
a4b92340 DG |
240 | MSG("Consumer disabled for session %s", session_name); |
241 | ||
242 | error: | |
243 | return ret; | |
00e2e675 DG |
244 | } |
245 | ||
f3ed775e | 246 | /* |
1c8d13c8 TD |
247 | * Create a tracing session. |
248 | * If no name is specified, a default name is generated. | |
f3ed775e | 249 | * |
1c8d13c8 | 250 | * Returns one of the CMD_* result constants. |
f3ed775e | 251 | */ |
a4b92340 | 252 | static int create_session(void) |
f3ed775e | 253 | { |
a4b92340 | 254 | int ret; |
07424f16 | 255 | char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL; |
a4b92340 | 256 | char *alloc_url = NULL, *url = NULL, datetime[16]; |
40b03f52 | 257 | char session_name_date[NAME_MAX], *print_str_url = NULL; |
f3ed775e DG |
258 | time_t rawtime; |
259 | struct tm *timeinfo; | |
260 | ||
d6175221 DG |
261 | /* Get date and time for automatic session name/path */ |
262 | time(&rawtime); | |
263 | timeinfo = localtime(&rawtime); | |
264 | strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo); | |
265 | ||
f3ed775e DG |
266 | /* Auto session name creation */ |
267 | if (opt_session_name == NULL) { | |
07424f16 DG |
268 | ret = snprintf(session_name_date, sizeof(session_name_date), |
269 | DEFAULT_SESSION_NAME "-%s", datetime); | |
d6175221 | 270 | if (ret < 0) { |
07424f16 DG |
271 | PERROR("snprintf session name"); |
272 | goto error; | |
273 | } | |
04965770 | 274 | session_name = session_name_date; |
07424f16 | 275 | DBG("Auto session name set to %s", session_name_date); |
f3ed775e | 276 | } else { |
61b35a5a DG |
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); | |
282 | ret = CMD_ERROR; | |
283 | goto error; | |
284 | } | |
f3ed775e | 285 | session_name = opt_session_name; |
07424f16 DG |
286 | ret = snprintf(session_name_date, sizeof(session_name_date), |
287 | "%s-%s", session_name, datetime); | |
288 | if (ret < 0) { | |
289 | PERROR("snprintf session name"); | |
290 | goto error; | |
291 | } | |
f3ed775e DG |
292 | } |
293 | ||
a4b92340 DG |
294 | if (opt_no_consumer) { |
295 | url = NULL; | |
40b03f52 | 296 | print_str_url = ""; |
a4b92340 | 297 | } else if (opt_output_path != NULL) { |
81b86775 | 298 | traces_path = utils_expand_path(opt_output_path); |
00e2e675 DG |
299 | if (traces_path == NULL) { |
300 | ret = CMD_ERROR; | |
301 | goto error; | |
302 | } | |
303 | ||
a4b92340 DG |
304 | /* Create URL string from the local filesytem path */ |
305 | ret = asprintf(&alloc_url, "file://%s", traces_path); | |
00e2e675 | 306 | if (ret < 0) { |
a4b92340 | 307 | PERROR("asprintf url path"); |
00e2e675 DG |
308 | ret = CMD_FATAL; |
309 | goto error; | |
310 | } | |
a4b92340 DG |
311 | /* URL to use in the lttng_create_session() call */ |
312 | url = alloc_url; | |
40b03f52 | 313 | print_str_url = traces_path; |
a4b92340 DG |
314 | } else if (opt_url) { /* Handling URL (-U opt) */ |
315 | url = opt_url; | |
40b03f52 | 316 | print_str_url = url; |
a4b92340 | 317 | } else if (opt_ctrl_url == NULL && opt_data_url == NULL) { |
00e2e675 | 318 | /* Auto output path */ |
d386b234 | 319 | alloc_path = config_get_default_path(); |
f3ed775e | 320 | if (alloc_path == NULL) { |
d386b234 | 321 | ERR("HOME path not found.\n \ |
00e2e675 | 322 | Please specify an output path using -o, --output PATH"); |
f3ed775e DG |
323 | ret = CMD_FATAL; |
324 | goto error; | |
325 | } | |
d386b234 | 326 | alloc_path = strdup(alloc_path); |
f3ed775e | 327 | |
07424f16 DG |
328 | ret = asprintf(&alloc_url, |
329 | "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s", | |
330 | alloc_path, session_name_date); | |
58a97671 | 331 | if (ret < 0) { |
00e2e675 DG |
332 | PERROR("asprintf trace dir name"); |
333 | ret = CMD_FATAL; | |
58a97671 DG |
334 | goto error; |
335 | } | |
00e2e675 | 336 | |
a4b92340 | 337 | url = alloc_url; |
40b03f52 | 338 | print_str_url = alloc_url + strlen("file://"); |
00e2e675 DG |
339 | } |
340 | ||
07424f16 | 341 | ret = _lttng_create_session_ext(session_name, url, datetime); |
f3ed775e | 342 | if (ret < 0) { |
ae856491 | 343 | /* Don't set ret so lttng can interpret the sessiond error. */ |
42224349 | 344 | switch (-ret) { |
f73fabfd | 345 | case LTTNG_ERR_EXIST_SESS: |
42224349 DG |
346 | WARN("Session %s already exists", session_name); |
347 | break; | |
348 | } | |
f3ed775e DG |
349 | goto error; |
350 | } | |
351 | ||
04965770 | 352 | MSG("Session %s created.", session_name); |
40b03f52 | 353 | MSG("Traces will be written in %s", print_str_url); |
a4b92340 DG |
354 | |
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); | |
358 | if (ret < 0) { | |
359 | goto error; | |
360 | } | |
361 | ||
362 | ret = enable_consumer(session_name); | |
363 | if (ret < 0) { | |
364 | goto error; | |
365 | } | |
366 | } | |
367 | ||
368 | if (opt_disable_consumer && !opt_no_consumer) { | |
369 | ret = disable_consumer(session_name); | |
370 | if (ret < 0) { | |
371 | goto error; | |
372 | } | |
373 | } | |
374 | ||
58a97671 DG |
375 | /* Init lttng session config */ |
376 | ret = config_init(session_name); | |
f3ed775e | 377 | if (ret < 0) { |
27089920 | 378 | ret = CMD_ERROR; |
f3ed775e DG |
379 | goto error; |
380 | } | |
381 | ||
07424f16 | 382 | |
f3ed775e DG |
383 | ret = CMD_SUCCESS; |
384 | ||
385 | error: | |
a4b92340 DG |
386 | if (alloc_url) { |
387 | free(alloc_url); | |
f3ed775e DG |
388 | } |
389 | ||
58a97671 DG |
390 | if (traces_path) { |
391 | free(traces_path); | |
f3ed775e | 392 | } |
87f222b6 | 393 | free(alloc_path); |
a4b92340 DG |
394 | |
395 | if (ret < 0) { | |
396 | ERR("%s", lttng_strerror(ret)); | |
397 | } | |
f3ed775e DG |
398 | return ret; |
399 | } | |
400 | ||
401 | /* | |
74cc1d0f | 402 | * The 'create <options>' first level command |
1c8d13c8 TD |
403 | * |
404 | * Returns one of the CMD_* result constants. | |
f3ed775e DG |
405 | */ |
406 | int cmd_create(int argc, const char **argv) | |
407 | { | |
408 | int opt, ret = CMD_SUCCESS; | |
409 | static poptContext pc; | |
410 | ||
411 | pc = poptGetContext(NULL, argc, argv, long_options, 0); | |
412 | poptReadDefaultConfig(pc, 0); | |
413 | ||
414 | while ((opt = poptGetNextOpt(pc)) != -1) { | |
415 | switch (opt) { | |
416 | case OPT_HELP: | |
27089920 | 417 | usage(stdout); |
f3ed775e | 418 | goto end; |
679b4943 SM |
419 | case OPT_LIST_OPTIONS: |
420 | list_cmd_options(stdout, long_options); | |
679b4943 | 421 | goto end; |
f3ed775e DG |
422 | default: |
423 | usage(stderr); | |
424 | ret = CMD_UNDEFINED; | |
425 | goto end; | |
426 | } | |
427 | } | |
428 | ||
429 | opt_session_name = (char*) poptGetArg(pc); | |
430 | ||
431 | ret = create_session(); | |
432 | ||
433 | end: | |
ca1c3607 | 434 | poptFreeContext(pc); |
f3ed775e DG |
435 | return ret; |
436 | } |