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 | ||
63 | /* | |
64 | * usage | |
65 | */ | |
66 | static void usage(FILE *ofp) | |
67 | { | |
a4b92340 | 68 | fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n"); |
f3ed775e | 69 | fprintf(ofp, "\n"); |
a4b92340 DG |
70 | fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n"); |
71 | fprintf(ofp, "\n"); | |
72 | fprintf(ofp, "Options:\n"); | |
f3ed775e | 73 | fprintf(ofp, " -h, --help Show this help\n"); |
1c8d13c8 | 74 | fprintf(ofp, " --list-options Simple listing of options\n"); |
58a97671 | 75 | fprintf(ofp, " -o, --output PATH Specify output path for traces\n"); |
a4b92340 DG |
76 | fprintf(ofp, "\n"); |
77 | fprintf(ofp, "Extended Options:\n"); | |
78 | fprintf(ofp, "\n"); | |
79 | fprintf(ofp, "Using these options, each API call can be controlled individually.\n"); | |
80 | fprintf(ofp, "\n"); | |
81 | fprintf(ofp, " -U, --set-url=URL Set URL destination of the trace data.\n"); | |
00e2e675 | 82 | fprintf(ofp, " It is persistent for the session lifetime.\n"); |
a4b92340 DG |
83 | fprintf(ofp, " This will set both data and control URL.\n"); |
84 | fprintf(ofp, " You can change it with the enable-consumer cmd\n"); | |
85 | fprintf(ofp, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n"); | |
86 | fprintf(ofp, " -D, --data-url=URL Set data path URL. (Must use -C also)\n"); | |
87 | fprintf(ofp, " --no-consumer Don't activate a consumer for this session.\n"); | |
88 | fprintf(ofp, " --disable-consumer\n"); | |
89 | fprintf(ofp, " Disable consumer for this session.\n"); | |
90 | fprintf(ofp, "\n"); | |
91 | fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n"); | |
92 | fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n"); | |
93 | fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n"); | |
94 | fprintf(ofp, "\n"); | |
95 | fprintf(ofp, "URL format is has followed:\n"); | |
96 | fprintf(ofp, "\n"); | |
97 | fprintf(ofp, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n"); | |
98 | fprintf(ofp, "\n"); | |
99 | fprintf(ofp, " Supported protocols are (proto):\n"); | |
100 | fprintf(ofp, " > file://...\n"); | |
101 | fprintf(ofp, " Local filesystem full path.\n"); | |
102 | fprintf(ofp, "\n"); | |
103 | fprintf(ofp, " > net[4|6]://...\n"); | |
104 | fprintf(ofp, " This will use the default network transport layer which is\n"); | |
105 | fprintf(ofp, " TCP for both control (PORT1) and data port (PORT2).\n"); | |
106 | fprintf(ofp, " The default ports are respectively 5342 and 5343.\n"); | |
107 | fprintf(ofp, "\n"); | |
108 | fprintf(ofp, " > tcp[4|6]://...\n"); | |
109 | fprintf(ofp, " Can only be used with -C and -D together\n"); | |
110 | fprintf(ofp, "\n"); | |
111 | fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n"); | |
112 | fprintf(ofp, "\n"); | |
113 | fprintf(ofp, "Examples:\n"); | |
114 | fprintf(ofp, " # lttng create -U net://192.168.1.42\n"); | |
115 | fprintf(ofp, " Uses TCP and default ports for the given destination.\n"); | |
116 | fprintf(ofp, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n"); | |
117 | fprintf(ofp, " Uses TCP, default ports and IPv6.\n"); | |
118 | fprintf(ofp, " # lttng create s1 -U net://myhost.com:3229\n"); | |
119 | fprintf(ofp, " Set the consumer to the remote HOST on port 3229 for control.\n"); | |
f3ed775e DG |
120 | fprintf(ofp, "\n"); |
121 | } | |
122 | ||
00e2e675 | 123 | /* |
a4b92340 | 124 | * For a session name, set the consumer URLs. |
00e2e675 | 125 | */ |
a4b92340 DG |
126 | static int set_consumer_url(const char *session_name, const char *ctrl_url, |
127 | const char *data_url) | |
00e2e675 | 128 | { |
a4b92340 DG |
129 | int ret; |
130 | struct lttng_handle *handle; | |
131 | struct lttng_domain dom; | |
132 | ||
133 | assert(session_name); | |
134 | ||
135 | /* | |
136 | * Set handle with the session name and the domain set to 0. This means to | |
137 | * the session daemon that the next action applies on the tracing session | |
138 | * rather then the domain specific session. | |
139 | */ | |
140 | memset(&dom, 0, sizeof(dom)); | |
141 | ||
142 | handle = lttng_create_handle(session_name, &dom); | |
143 | if (handle == NULL) { | |
144 | ret = CMD_FATAL; | |
145 | goto error; | |
146 | } | |
00e2e675 | 147 | |
a4b92340 DG |
148 | ret = lttng_set_consumer_url(handle, ctrl_url, data_url); |
149 | if (ret < 0) { | |
150 | goto error; | |
00e2e675 DG |
151 | } |
152 | ||
a4b92340 DG |
153 | if (ctrl_url) { |
154 | MSG("Control URL %s set for session %s", ctrl_url, session_name); | |
00e2e675 DG |
155 | } |
156 | ||
a4b92340 DG |
157 | if (data_url) { |
158 | MSG("Data URL %s set for session %s", data_url, session_name); | |
159 | } | |
160 | ||
161 | error: | |
162 | lttng_destroy_handle(handle); | |
163 | return ret; | |
164 | } | |
165 | ||
166 | /* | |
167 | * For a session name, enable the consumer. | |
168 | */ | |
169 | static int enable_consumer(const char *session_name) | |
170 | { | |
171 | int ret; | |
172 | struct lttng_handle *handle; | |
173 | struct lttng_domain dom; | |
174 | ||
175 | assert(session_name); | |
176 | ||
177 | /* | |
178 | * Set handle with the session name and the domain set to 0. This means to | |
179 | * the session daemon that the next action applies on the tracing session | |
180 | * rather then the domain specific session. | |
181 | * | |
182 | * XXX: This '0' value should be a domain enum value. | |
183 | */ | |
184 | memset(&dom, 0, sizeof(dom)); | |
185 | ||
186 | handle = lttng_create_handle(session_name, 0); | |
187 | if (handle == NULL) { | |
188 | ret = CMD_FATAL; | |
189 | goto error; | |
00e2e675 DG |
190 | } |
191 | ||
a4b92340 DG |
192 | ret = lttng_enable_consumer(handle); |
193 | if (ret < 0) { | |
194 | goto error; | |
195 | } | |
196 | ||
197 | MSG("Consumer enabled for session %s", session_name); | |
198 | ||
199 | error: | |
200 | lttng_destroy_handle(handle); | |
201 | return ret; | |
00e2e675 DG |
202 | } |
203 | ||
204 | /* | |
a4b92340 | 205 | * For a session name, disable the consumer. |
00e2e675 | 206 | */ |
a4b92340 | 207 | static int disable_consumer(const char *session_name) |
00e2e675 | 208 | { |
a4b92340 DG |
209 | int ret; |
210 | struct lttng_handle *handle; | |
211 | ||
212 | assert(session_name); | |
213 | ||
214 | /* | |
215 | * Set handle with the session name and the domain set to 0. This means to | |
216 | * the session daemon that the next action applies on the tracing session | |
217 | * rather then the domain specific session. | |
218 | * | |
219 | * XXX: This '0' value should be a domain enum value. | |
220 | */ | |
221 | handle = lttng_create_handle(session_name, 0); | |
222 | if (handle == NULL) { | |
223 | ret = CMD_FATAL; | |
224 | goto error; | |
00e2e675 DG |
225 | } |
226 | ||
a4b92340 DG |
227 | ret = lttng_disable_consumer(handle); |
228 | if (ret < 0) { | |
229 | goto error; | |
230 | } | |
231 | free(handle); | |
00e2e675 | 232 | |
a4b92340 DG |
233 | MSG("Consumer disabled for session %s", session_name); |
234 | ||
235 | error: | |
236 | return ret; | |
00e2e675 DG |
237 | } |
238 | ||
f3ed775e | 239 | /* |
1c8d13c8 TD |
240 | * Create a tracing session. |
241 | * If no name is specified, a default name is generated. | |
f3ed775e | 242 | * |
1c8d13c8 | 243 | * Returns one of the CMD_* result constants. |
f3ed775e | 244 | */ |
a4b92340 | 245 | static int create_session(void) |
f3ed775e | 246 | { |
a4b92340 | 247 | int ret; |
58a97671 | 248 | char *session_name, *traces_path = NULL, *alloc_path = NULL; |
a4b92340 | 249 | char *alloc_url = NULL, *url = NULL, datetime[16]; |
f3ed775e DG |
250 | time_t rawtime; |
251 | struct tm *timeinfo; | |
252 | ||
d6175221 DG |
253 | /* Get date and time for automatic session name/path */ |
254 | time(&rawtime); | |
255 | timeinfo = localtime(&rawtime); | |
256 | strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo); | |
257 | ||
f3ed775e DG |
258 | /* Auto session name creation */ |
259 | if (opt_session_name == NULL) { | |
a4b92340 | 260 | ret = asprintf(&session_name, DEFAULT_SESSION_NAME "%s", datetime); |
d6175221 | 261 | if (ret < 0) { |
a4b92340 | 262 | PERROR("asprintf session name"); |
d6175221 DG |
263 | goto error; |
264 | } | |
f3ed775e DG |
265 | DBG("Auto session name set to %s", session_name); |
266 | } else { | |
267 | session_name = opt_session_name; | |
268 | } | |
269 | ||
a4b92340 DG |
270 | if (opt_no_consumer) { |
271 | url = NULL; | |
272 | } else if (opt_output_path != NULL) { | |
81b86775 | 273 | traces_path = utils_expand_path(opt_output_path); |
00e2e675 DG |
274 | if (traces_path == NULL) { |
275 | ret = CMD_ERROR; | |
276 | goto error; | |
277 | } | |
278 | ||
a4b92340 DG |
279 | /* Create URL string from the local filesytem path */ |
280 | ret = asprintf(&alloc_url, "file://%s", traces_path); | |
00e2e675 | 281 | if (ret < 0) { |
a4b92340 | 282 | PERROR("asprintf url path"); |
00e2e675 DG |
283 | ret = CMD_FATAL; |
284 | goto error; | |
285 | } | |
a4b92340 DG |
286 | /* URL to use in the lttng_create_session() call */ |
287 | url = alloc_url; | |
288 | MSG("Trace(s) output set to %s", traces_path); | |
289 | } else if (opt_url) { /* Handling URL (-U opt) */ | |
290 | url = opt_url; | |
291 | MSG("Trace(s) output set to %s", url); | |
292 | } else if (opt_ctrl_url == NULL && opt_data_url == NULL) { | |
00e2e675 | 293 | /* Auto output path */ |
d386b234 | 294 | alloc_path = config_get_default_path(); |
f3ed775e | 295 | if (alloc_path == NULL) { |
d386b234 | 296 | ERR("HOME path not found.\n \ |
00e2e675 | 297 | Please specify an output path using -o, --output PATH"); |
f3ed775e DG |
298 | ret = CMD_FATAL; |
299 | goto error; | |
300 | } | |
d386b234 | 301 | alloc_path = strdup(alloc_path); |
f3ed775e | 302 | |
a4b92340 DG |
303 | ret = asprintf(&alloc_url, "file://%s/" DEFAULT_TRACE_DIR_NAME, |
304 | alloc_path); | |
58a97671 | 305 | if (ret < 0) { |
00e2e675 DG |
306 | PERROR("asprintf trace dir name"); |
307 | ret = CMD_FATAL; | |
58a97671 DG |
308 | goto error; |
309 | } | |
00e2e675 | 310 | |
a4b92340 DG |
311 | url = alloc_url; |
312 | MSG("Trace(s) output set to %s", alloc_url + strlen("file://")); | |
00e2e675 DG |
313 | } |
314 | ||
a4b92340 | 315 | ret = lttng_create_session(session_name, url); |
f3ed775e | 316 | if (ret < 0) { |
ae856491 | 317 | /* Don't set ret so lttng can interpret the sessiond error. */ |
42224349 DG |
318 | switch (-ret) { |
319 | case LTTCOMM_EXIST_SESS: | |
320 | WARN("Session %s already exists", session_name); | |
321 | break; | |
322 | } | |
f3ed775e DG |
323 | goto error; |
324 | } | |
325 | ||
a4b92340 DG |
326 | if (opt_session_name == NULL) { |
327 | MSG("Session created with default name %s", session_name); | |
328 | } else { | |
329 | MSG("Session %s created.", session_name); | |
330 | } | |
331 | ||
332 | if (opt_ctrl_url || opt_data_url) { | |
333 | /* Setting up control URI (-C or/and -D opt) */ | |
334 | ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url); | |
335 | if (ret < 0) { | |
336 | goto error; | |
337 | } | |
338 | ||
339 | ret = enable_consumer(session_name); | |
340 | if (ret < 0) { | |
341 | goto error; | |
342 | } | |
343 | } | |
344 | ||
345 | if (opt_disable_consumer && !opt_no_consumer) { | |
346 | ret = disable_consumer(session_name); | |
347 | if (ret < 0) { | |
348 | goto error; | |
349 | } | |
350 | } | |
351 | ||
58a97671 DG |
352 | /* Init lttng session config */ |
353 | ret = config_init(session_name); | |
f3ed775e | 354 | if (ret < 0) { |
27089920 | 355 | ret = CMD_ERROR; |
f3ed775e DG |
356 | goto error; |
357 | } | |
358 | ||
f3ed775e DG |
359 | ret = CMD_SUCCESS; |
360 | ||
361 | error: | |
54bd3caf TD |
362 | if (opt_session_name == NULL) { |
363 | free(session_name); | |
364 | } | |
365 | ||
a4b92340 DG |
366 | if (alloc_url) { |
367 | free(alloc_url); | |
f3ed775e DG |
368 | } |
369 | ||
58a97671 DG |
370 | if (traces_path) { |
371 | free(traces_path); | |
f3ed775e | 372 | } |
a4b92340 DG |
373 | |
374 | if (ret < 0) { | |
375 | ERR("%s", lttng_strerror(ret)); | |
376 | } | |
f3ed775e DG |
377 | return ret; |
378 | } | |
379 | ||
380 | /* | |
74cc1d0f | 381 | * The 'create <options>' first level command |
1c8d13c8 TD |
382 | * |
383 | * Returns one of the CMD_* result constants. | |
f3ed775e DG |
384 | */ |
385 | int cmd_create(int argc, const char **argv) | |
386 | { | |
387 | int opt, ret = CMD_SUCCESS; | |
388 | static poptContext pc; | |
389 | ||
390 | pc = poptGetContext(NULL, argc, argv, long_options, 0); | |
391 | poptReadDefaultConfig(pc, 0); | |
392 | ||
393 | while ((opt = poptGetNextOpt(pc)) != -1) { | |
394 | switch (opt) { | |
395 | case OPT_HELP: | |
27089920 | 396 | usage(stdout); |
f3ed775e | 397 | goto end; |
679b4943 SM |
398 | case OPT_LIST_OPTIONS: |
399 | list_cmd_options(stdout, long_options); | |
679b4943 | 400 | goto end; |
f3ed775e DG |
401 | default: |
402 | usage(stderr); | |
403 | ret = CMD_UNDEFINED; | |
404 | goto end; | |
405 | } | |
406 | } | |
407 | ||
408 | opt_session_name = (char*) poptGetArg(pc); | |
409 | ||
410 | ret = create_session(); | |
411 | ||
412 | end: | |
ca1c3607 | 413 | poptFreeContext(pc); |
f3ed775e DG |
414 | return ret; |
415 | } |