Commit | Line | Data |
---|---|---|
826d496d MD |
1 | /* |
2 | * Copyright (c) 2011 David Goulet <david.goulet@polymtl.ca> | |
fac6795d DG |
3 | * |
4 | * This program is free software; you can redistribute it and/or modify | |
d14d33bf AM |
5 | * it under the terms of the GNU General Public License, version 2 only, |
6 | * as published by the Free Software Foundation. | |
fac6795d 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 | * | |
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. | |
fac6795d DG |
16 | */ |
17 | ||
6c1c0768 | 18 | #define _LGPL_SOURCE |
fac6795d | 19 | #include <getopt.h> |
f3ed775e | 20 | #include <signal.h> |
fac6795d DG |
21 | #include <stdio.h> |
22 | #include <stdlib.h> | |
23 | #include <string.h> | |
8db8d1dc DG |
24 | #include <sys/types.h> |
25 | #include <sys/wait.h> | |
fac6795d | 26 | #include <unistd.h> |
730389d9 | 27 | #include <ctype.h> |
fac6795d | 28 | |
5b97ec60 | 29 | #include <lttng/lttng.h> |
db758600 | 30 | #include <common/error.h> |
e8fa9fb0 | 31 | #include <common/compat/getenv.h> |
f67353ba | 32 | #include <common/utils.h> |
fac6795d | 33 | |
c399183f | 34 | #include "command.h" |
979d476d | 35 | #include "version.h" |
fac6795d | 36 | |
4fc83d94 PP |
37 | static const char *help_msg = |
38 | #ifdef LTTNG_EMBED_HELP | |
39 | #include <lttng.1.h> | |
40 | #else | |
41 | NULL | |
42 | #endif | |
43 | ; | |
44 | ||
fac6795d DG |
45 | /* Variables */ |
46 | static char *progname; | |
92360082 JG |
47 | int opt_no_sessiond; |
48 | char *opt_sessiond_path; | |
f3ed775e | 49 | |
8960e9cd DG |
50 | char *opt_relayd_path; |
51 | ||
f3ed775e | 52 | enum { |
8960e9cd | 53 | OPT_RELAYD_PATH, |
f3ed775e | 54 | OPT_SESSION_PATH, |
865abf65 SM |
55 | OPT_DUMP_OPTIONS, |
56 | OPT_DUMP_COMMANDS, | |
f3ed775e DG |
57 | }; |
58 | ||
59 | /* Getopt options. No first level command. */ | |
60 | static struct option long_options[] = { | |
70318c38 | 61 | {"version", 0, NULL, 'V'}, |
f3ed775e DG |
62 | {"help", 0, NULL, 'h'}, |
63 | {"group", 1, NULL, 'g'}, | |
64 | {"verbose", 0, NULL, 'v'}, | |
65 | {"quiet", 0, NULL, 'q'}, | |
c7e35b03 | 66 | {"mi", 1, NULL, 'm'}, |
8490ae7b | 67 | {"no-sessiond", 0, NULL, 'n'}, |
f3ed775e | 68 | {"sessiond-path", 1, NULL, OPT_SESSION_PATH}, |
8960e9cd | 69 | {"relayd-path", 1, NULL, OPT_RELAYD_PATH}, |
865abf65 SM |
70 | {"list-options", 0, NULL, OPT_DUMP_OPTIONS}, |
71 | {"list-commands", 0, NULL, OPT_DUMP_COMMANDS}, | |
f3ed775e DG |
72 | {NULL, 0, NULL, 0} |
73 | }; | |
74 | ||
75 | /* First level command */ | |
76 | static struct cmd_struct commands[] = { | |
3ee1477a | 77 | { "add-context", cmd_add_context}, |
f3ed775e | 78 | { "create", cmd_create}, |
7886d670 | 79 | { "clear", cmd_clear}, |
f3ed775e | 80 | { "destroy", cmd_destroy}, |
3ee1477a | 81 | { "disable-channel", cmd_disable_channels}, |
e953ef25 | 82 | { "disable-event", cmd_disable_events}, |
d36b8583 | 83 | { "enable-channel", cmd_enable_channels}, |
3ee1477a PP |
84 | { "enable-event", cmd_enable_events}, |
85 | { "help", NULL}, | |
86 | { "list", cmd_list}, | |
87 | { "load", cmd_load}, | |
88 | { "metadata", cmd_metadata}, | |
7712f784 | 89 | { "regenerate", cmd_regenerate}, |
d68c9a04 | 90 | { "rotate", cmd_rotate}, |
259c2674 JD |
91 | { "enable-rotation", cmd_enable_rotation}, |
92 | { "disable-rotation", cmd_disable_rotation}, | |
3ee1477a | 93 | { "save", cmd_save}, |
3087ef18 | 94 | { "set-session", cmd_set_session}, |
57f272ed | 95 | { "snapshot", cmd_snapshot}, |
3ee1477a PP |
96 | { "start", cmd_start}, |
97 | { "status", cmd_status}, | |
98 | { "stop", cmd_stop}, | |
ccf10263 MD |
99 | { "track", cmd_track}, |
100 | { "untrack", cmd_untrack}, | |
3ee1477a PP |
101 | { "version", cmd_version}, |
102 | { "view", cmd_view}, | |
f3ed775e DG |
103 | { NULL, NULL} /* Array closure */ |
104 | }; | |
105 | ||
70318c38 SS |
106 | static void version(FILE *ofp) |
107 | { | |
4c6ac053 MD |
108 | fprintf(ofp, "%s (LTTng Trace Control) " VERSION" - " VERSION_NAME "%s\n", |
109 | progname, | |
110 | GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION); | |
70318c38 SS |
111 | } |
112 | ||
c7e35b03 JR |
113 | /* |
114 | * Find the MI output type enum from a string. This function is for the support | |
115 | * of machine interface output. | |
116 | */ | |
117 | static int mi_output_type(const char *output_type) | |
118 | { | |
119 | int ret = 0; | |
120 | ||
121 | if (!strncasecmp("xml", output_type, 3)) { | |
122 | ret = LTTNG_MI_XML; | |
123 | } else { | |
124 | /* Invalid output format */ | |
125 | ERR("MI output format not supported"); | |
126 | ret = -LTTNG_ERR_MI_OUTPUT_TYPE; | |
127 | } | |
128 | ||
129 | return ret; | |
130 | } | |
131 | ||
865abf65 SM |
132 | /* |
133 | * list_options | |
134 | * | |
135 | * List options line by line. This is mostly for bash auto completion and to | |
136 | * avoid difficult parsing. | |
137 | */ | |
138 | static void list_options(FILE *ofp) | |
139 | { | |
140 | int i = 0; | |
141 | struct option *option = NULL; | |
142 | ||
143 | option = &long_options[i]; | |
144 | while (option->name != NULL) { | |
145 | fprintf(ofp, "--%s\n", option->name); | |
146 | ||
147 | if (isprint(option->val)) { | |
148 | fprintf(ofp, "-%c\n", option->val); | |
149 | } | |
150 | ||
151 | i++; | |
152 | option = &long_options[i]; | |
153 | } | |
154 | } | |
155 | ||
7442b2ba | 156 | /* |
f3ed775e | 157 | * clean_exit |
96243366 | 158 | */ |
f3ed775e | 159 | static void clean_exit(int code) |
96243366 | 160 | { |
f3ed775e DG |
161 | DBG("Clean exit"); |
162 | exit(code); | |
894be886 | 163 | } |
96243366 | 164 | |
894be886 | 165 | /* |
f3ed775e | 166 | * sighandler |
2ef84c95 | 167 | * |
f3ed775e | 168 | * Signal handler for the daemon |
2ef84c95 | 169 | */ |
f3ed775e | 170 | static void sighandler(int sig) |
2ef84c95 | 171 | { |
f3ed775e DG |
172 | switch (sig) { |
173 | case SIGTERM: | |
99bab54f | 174 | DBG("SIGTERM caught"); |
f3ed775e DG |
175 | clean_exit(EXIT_FAILURE); |
176 | break; | |
f3ed775e | 177 | default: |
99bab54f | 178 | DBG("Unknown signal %d caught", sig); |
f3ed775e | 179 | break; |
2ef84c95 DG |
180 | } |
181 | ||
f3ed775e | 182 | return; |
2ef84c95 DG |
183 | } |
184 | ||
185 | /* | |
f3ed775e | 186 | * set_signal_handler |
894be886 | 187 | * |
f3ed775e | 188 | * Setup signal handler for SIGCHLD and SIGTERM. |
894be886 | 189 | */ |
f3ed775e | 190 | static int set_signal_handler(void) |
894be886 | 191 | { |
f3ed775e DG |
192 | int ret = 0; |
193 | struct sigaction sa; | |
194 | sigset_t sigset; | |
33a2b854 | 195 | |
f3ed775e | 196 | if ((ret = sigemptyset(&sigset)) < 0) { |
6f04ed72 | 197 | PERROR("sigemptyset"); |
33a2b854 DG |
198 | goto end; |
199 | } | |
200 | ||
f3ed775e DG |
201 | sa.sa_handler = sighandler; |
202 | sa.sa_mask = sigset; | |
203 | sa.sa_flags = 0; | |
96243366 | 204 | |
f3ed775e | 205 | if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) { |
6f04ed72 | 206 | PERROR("sigaction"); |
f3ed775e | 207 | goto end; |
894be886 DG |
208 | } |
209 | ||
96243366 | 210 | end: |
57167058 DG |
211 | return ret; |
212 | } | |
213 | ||
fac6795d | 214 | /* |
f3ed775e | 215 | * handle_command |
fac6795d | 216 | * |
f3ed775e DG |
217 | * Handle the full argv list of a first level command. Will find the command |
218 | * in the global commands array and call the function callback associated. | |
1c9f7941 | 219 | * |
f3ed775e DG |
220 | * If command not found, return -1 |
221 | * else, return function command error code. | |
1c9f7941 | 222 | */ |
f3ed775e | 223 | static int handle_command(int argc, char **argv) |
1c9f7941 | 224 | { |
f3ed775e DG |
225 | int i = 0, ret; |
226 | struct cmd_struct *cmd; | |
1c9f7941 | 227 | |
f3ed775e DG |
228 | if (*argv == NULL) { |
229 | ret = CMD_SUCCESS; | |
47b74d63 | 230 | goto end; |
1c9f7941 DG |
231 | } |
232 | ||
960afba4 PP |
233 | /* Special case for help command which needs the commands array */ |
234 | if (strcmp(argv[0], "help") == 0) { | |
235 | ret = cmd_help(argc, (const char**) argv, commands); | |
236 | goto end; | |
237 | } | |
238 | ||
f3ed775e | 239 | cmd = &commands[i]; |
960afba4 | 240 | while (cmd->name != NULL) { |
f3ed775e DG |
241 | /* Find command */ |
242 | if (strcmp(argv[0], cmd->name) == 0) { | |
243 | ret = cmd->func(argc, (const char**) argv); | |
f3ed775e | 244 | goto end; |
894be886 | 245 | } |
f3ed775e DG |
246 | i++; |
247 | cmd = &commands[i]; | |
894be886 DG |
248 | } |
249 | ||
f3ed775e | 250 | /* Command not found */ |
4ce78777 | 251 | ret = CMD_UNDEFINED; |
894be886 DG |
252 | |
253 | end: | |
f3ed775e | 254 | return ret; |
8548ff30 DG |
255 | } |
256 | ||
6047170f JG |
257 | static bool command_exists(const char *command) |
258 | { | |
259 | const struct cmd_struct *cmd = commands; | |
260 | bool exists = false; | |
261 | ||
262 | while (cmd->name != NULL) { | |
263 | if (!strcmp(command, cmd->name)) { | |
264 | exists = true; | |
265 | goto end; | |
266 | } | |
267 | cmd++; | |
268 | } | |
269 | ||
270 | end: | |
271 | return exists; | |
272 | } | |
273 | ||
9fb6c2db PP |
274 | static void show_basic_help(void) |
275 | { | |
276 | puts("Usage: lttng [--group=GROUP] [--mi=TYPE] [--no-sessiond | --sessiond-path=PATH]"); | |
277 | puts(" [--quiet | -v | -vv | -vvv] COMMAND [COMMAND OPTIONS]"); | |
278 | puts(""); | |
279 | puts("Available commands:"); | |
280 | puts(""); | |
281 | puts("Tracing sessions:"); | |
282 | puts(" create " CONFIG_CMD_DESCR_CREATE); | |
7886d670 | 283 | puts(" clear " CONFIG_CMD_DESCR_CLEAR); |
9fb6c2db PP |
284 | puts(" destroy " CONFIG_CMD_DESCR_DESTROY); |
285 | puts(" load " CONFIG_CMD_DESCR_LOAD); | |
faf04ce7 | 286 | puts(" regenerate " CONFIG_CMD_DESCR_REGENERATE); |
9fb6c2db PP |
287 | puts(" save " CONFIG_CMD_DESCR_SAVE); |
288 | puts(" set-session " CONFIG_CMD_DESCR_SET_SESSION); | |
289 | puts(""); | |
290 | puts("Channels:"); | |
291 | puts(" add-context " CONFIG_CMD_DESCR_ADD_CONTEXT); | |
292 | puts(" disable-channel " CONFIG_CMD_DESCR_DISABLE_CHANNEL); | |
293 | puts(" enable-channel " CONFIG_CMD_DESCR_ENABLE_CHANNEL); | |
294 | puts(""); | |
295 | puts("Event rules:"); | |
296 | puts(" disable-event " CONFIG_CMD_DESCR_DISABLE_EVENT); | |
297 | puts(" enable-event " CONFIG_CMD_DESCR_ENABLE_EVENT); | |
298 | puts(""); | |
299 | puts("Status:"); | |
300 | puts(" list " CONFIG_CMD_DESCR_LIST); | |
301 | puts(" status " CONFIG_CMD_DESCR_STATUS); | |
302 | puts(""); | |
303 | puts("Control:"); | |
304 | puts(" snapshot " CONFIG_CMD_DESCR_SNAPSHOT); | |
305 | puts(" start " CONFIG_CMD_DESCR_START); | |
306 | puts(" stop " CONFIG_CMD_DESCR_STOP); | |
307 | puts(""); | |
308 | puts("Resource tracking:"); | |
309 | puts(" track " CONFIG_CMD_DESCR_TRACK); | |
310 | puts(" untrack " CONFIG_CMD_DESCR_UNTRACK); | |
311 | puts(""); | |
312 | puts("Miscellaneous:"); | |
9fb6c2db PP |
313 | puts(" help " CONFIG_CMD_DESCR_HELP); |
314 | puts(" version " CONFIG_CMD_DESCR_VERSION); | |
315 | puts(" view " CONFIG_CMD_DESCR_VIEW); | |
316 | puts(""); | |
317 | puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with"); | |
318 | puts("command COMMAND."); | |
319 | puts(""); | |
320 | puts("See `man lttng` for more help with the lttng command."); | |
321 | } | |
322 | ||
5b8719f5 | 323 | /* |
3183dbb0 | 324 | * Parse command line arguments. |
5b8719f5 | 325 | * |
3183dbb0 | 326 | * Return 0 if OK, else -1 |
5b8719f5 | 327 | */ |
f3ed775e | 328 | static int parse_args(int argc, char **argv) |
5b8719f5 | 329 | { |
f3ed775e | 330 | int opt, ret; |
5b8719f5 | 331 | |
e8fa9fb0 MD |
332 | if (lttng_is_setuid_setgid()) { |
333 | ERR("'%s' is not allowed to be executed as a setuid/setgid binary for security reasons. Aborting.", argv[0]); | |
334 | clean_exit(EXIT_FAILURE); | |
335 | } | |
336 | ||
f3ed775e | 337 | if (argc < 2) { |
9fb6c2db | 338 | show_basic_help(); |
f3ed775e | 339 | clean_exit(EXIT_FAILURE); |
5b8719f5 DG |
340 | } |
341 | ||
c7e35b03 | 342 | while ((opt = getopt_long(argc, argv, "+Vhnvqg:m:", long_options, NULL)) != -1) { |
f3ed775e | 343 | switch (opt) { |
70318c38 SS |
344 | case 'V': |
345 | version(stdout); | |
346 | ret = 0; | |
347 | goto end; | |
f3ed775e | 348 | case 'h': |
4fc83d94 | 349 | ret = utils_show_help(1, "lttng", help_msg); |
f67353ba | 350 | if (ret) { |
4fc83d94 | 351 | ERR("Cannot show --help for `lttng`"); |
f67353ba PP |
352 | perror("exec"); |
353 | } | |
3183dbb0 | 354 | goto end; |
f3ed775e | 355 | case 'v': |
849e5b7b DG |
356 | /* There is only 3 possible level of verbosity. (-vvv) */ |
357 | if (lttng_opt_verbose < 3) { | |
358 | lttng_opt_verbose += 1; | |
359 | } | |
f3ed775e DG |
360 | break; |
361 | case 'q': | |
97e19046 | 362 | lttng_opt_quiet = 1; |
f3ed775e | 363 | break; |
c7e35b03 JR |
364 | case 'm': |
365 | lttng_opt_mi = mi_output_type(optarg); | |
366 | if (lttng_opt_mi < 0) { | |
367 | ret = lttng_opt_mi; | |
368 | goto error; | |
369 | } | |
370 | break; | |
f3ed775e DG |
371 | case 'g': |
372 | lttng_set_tracing_group(optarg); | |
373 | break; | |
8490ae7b | 374 | case 'n': |
f3ed775e DG |
375 | opt_no_sessiond = 1; |
376 | break; | |
377 | case OPT_SESSION_PATH: | |
3ddaa633 | 378 | free(opt_sessiond_path); |
f3ed775e | 379 | opt_sessiond_path = strdup(optarg); |
d7c5d39f MD |
380 | if (!opt_sessiond_path) { |
381 | ret = -1; | |
382 | goto error; | |
383 | } | |
f3ed775e | 384 | break; |
8960e9cd | 385 | case OPT_RELAYD_PATH: |
3ddaa633 | 386 | free(opt_relayd_path); |
8960e9cd | 387 | opt_relayd_path = strdup(optarg); |
d7c5d39f MD |
388 | if (!opt_relayd_path) { |
389 | ret = -1; | |
390 | goto error; | |
391 | } | |
8960e9cd | 392 | break; |
865abf65 SM |
393 | case OPT_DUMP_OPTIONS: |
394 | list_options(stdout); | |
395 | ret = 0; | |
3183dbb0 | 396 | goto end; |
865abf65 | 397 | case OPT_DUMP_COMMANDS: |
3c9bd23c | 398 | list_commands(commands, stdout); |
865abf65 | 399 | ret = 0; |
3183dbb0 | 400 | goto end; |
f3ed775e | 401 | default: |
ae856491 | 402 | ret = 1; |
f3ed775e DG |
403 | goto error; |
404 | } | |
5b8719f5 | 405 | } |
fac6795d | 406 | |
f3ed775e | 407 | /* If both options are specified, quiet wins */ |
97e19046 DG |
408 | if (lttng_opt_verbose && lttng_opt_quiet) { |
409 | lttng_opt_verbose = 0; | |
5b8719f5 DG |
410 | } |
411 | ||
f67353ba | 412 | /* No leftovers, quit */ |
f3ed775e | 413 | if ((argc - optind) == 0) { |
8005f29a | 414 | ret = 1; |
f3ed775e DG |
415 | goto error; |
416 | } | |
7442b2ba | 417 | |
92360082 | 418 | /* |
f3ed775e DG |
419 | * Handle leftovers which is a first level command with the trailing |
420 | * options. | |
421 | */ | |
422 | ret = handle_command(argc - optind, argv + optind); | |
ae856491 DG |
423 | switch (ret) { |
424 | case CMD_WARNING: | |
ae856491 | 425 | case CMD_ERROR: |
ae856491 DG |
426 | break; |
427 | case CMD_UNDEFINED: | |
6047170f JG |
428 | if (!command_exists(*(argv + optind))) { |
429 | MSG("lttng: %s is not an lttng command. See 'lttng --help'.", | |
430 | *(argv + optind)); | |
431 | } else { | |
432 | ERR("Unrecognized argument used with \'%s\' command", | |
433 | *(argv + optind)); | |
434 | } | |
ae856491 DG |
435 | break; |
436 | case CMD_FATAL: | |
4ce78777 | 437 | case CMD_UNSUPPORTED: |
4ce78777 | 438 | break; |
ae856491 | 439 | case -1: |
ae856491 DG |
440 | ret = 1; |
441 | break; | |
442 | case 0: | |
443 | break; | |
444 | default: | |
42224349 DG |
445 | if (ret < 0) { |
446 | ret = -ret; | |
447 | } | |
ae856491 | 448 | break; |
96243366 DG |
449 | } |
450 | ||
3183dbb0 | 451 | end: |
f3ed775e | 452 | error: |
ae856491 | 453 | return ret; |
fac6795d DG |
454 | } |
455 | ||
f3ed775e | 456 | |
fac6795d | 457 | /* |
5b8719f5 | 458 | * main |
fac6795d DG |
459 | */ |
460 | int main(int argc, char *argv[]) | |
461 | { | |
462 | int ret; | |
463 | ||
464 | progname = argv[0] ? argv[0] : "lttng"; | |
465 | ||
5b8719f5 DG |
466 | ret = set_signal_handler(); |
467 | if (ret < 0) { | |
87378cf5 | 468 | clean_exit(ret); |
5b8719f5 DG |
469 | } |
470 | ||
f3ed775e | 471 | ret = parse_args(argc, argv); |
ae856491 DG |
472 | if (ret != 0) { |
473 | clean_exit(ret); | |
1fff1faa | 474 | } |
87378cf5 | 475 | |
fac6795d DG |
476 | return 0; |
477 | } |