Commit | Line | Data |
---|---|---|
826d496d | 1 | /* |
21cf9b6b | 2 | * Copyright (C) 2011 EfficiOS Inc. |
fac6795d | 3 | * |
ab5be9fa | 4 | * SPDX-License-Identifier: GPL-2.0-only |
fac6795d | 5 | * |
fac6795d DG |
6 | */ |
7 | ||
6c1c0768 | 8 | #define _LGPL_SOURCE |
28ab034a JG |
9 | #include "command.hpp" |
10 | #include "version.hpp" | |
11 | ||
12 | #include <common/compat/getenv.hpp> | |
13 | #include <common/error.hpp> | |
14 | #include <common/utils.hpp> | |
15 | ||
16 | #include <lttng/lttng.h> | |
17 | ||
18 | #include <ctype.h> | |
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> |
fac6795d | 27 | |
4fc83d94 PP |
28 | static const char *help_msg = |
29 | #ifdef LTTNG_EMBED_HELP | |
30 | #include <lttng.1.h> | |
31 | #else | |
cd9adb8b | 32 | nullptr |
4fc83d94 | 33 | #endif |
28ab034a | 34 | ; |
4fc83d94 | 35 | |
fac6795d | 36 | /* Variables */ |
b53d4e59 | 37 | static const char *progname; |
92360082 JG |
38 | int opt_no_sessiond; |
39 | char *opt_sessiond_path; | |
f3ed775e | 40 | |
8960e9cd DG |
41 | char *opt_relayd_path; |
42 | ||
f3ed775e | 43 | enum { |
8960e9cd | 44 | OPT_RELAYD_PATH, |
f3ed775e | 45 | OPT_SESSION_PATH, |
865abf65 SM |
46 | OPT_DUMP_OPTIONS, |
47 | OPT_DUMP_COMMANDS, | |
f3ed775e DG |
48 | }; |
49 | ||
50 | /* Getopt options. No first level command. */ | |
cd9adb8b JG |
51 | static struct option long_options[] = { { "version", 0, nullptr, 'V' }, |
52 | { "help", 0, nullptr, 'h' }, | |
53 | { "group", 1, nullptr, 'g' }, | |
54 | { "verbose", 0, nullptr, 'v' }, | |
55 | { "quiet", 0, nullptr, 'q' }, | |
56 | { "mi", 1, nullptr, 'm' }, | |
57 | { "no-sessiond", 0, nullptr, 'n' }, | |
58 | { "sessiond-path", 1, nullptr, OPT_SESSION_PATH }, | |
59 | { "relayd-path", 1, nullptr, OPT_RELAYD_PATH }, | |
60 | { "list-options", 0, nullptr, OPT_DUMP_OPTIONS }, | |
61 | { "list-commands", 0, nullptr, OPT_DUMP_COMMANDS }, | |
62 | { nullptr, 0, nullptr, 0 } }; | |
f3ed775e DG |
63 | |
64 | /* First level command */ | |
28ab034a JG |
65 | static struct cmd_struct commands[] = { |
66 | { "add-context", cmd_add_context }, | |
67 | { "add-trigger", cmd_add_trigger }, | |
68 | { "create", cmd_create }, | |
69 | { "clear", cmd_clear }, | |
70 | { "destroy", cmd_destroy }, | |
71 | { "disable-channel", cmd_disable_channels }, | |
72 | { "disable-event", cmd_disable_events }, | |
73 | { "enable-channel", cmd_enable_channels }, | |
74 | { "enable-event", cmd_enable_events }, | |
cd9adb8b | 75 | { "help", nullptr }, |
28ab034a JG |
76 | { "list", cmd_list }, |
77 | { "list-triggers", cmd_list_triggers }, | |
78 | { "load", cmd_load }, | |
79 | { "metadata", cmd_metadata }, | |
80 | { "regenerate", cmd_regenerate }, | |
81 | { "remove-trigger", cmd_remove_trigger }, | |
82 | { "rotate", cmd_rotate }, | |
83 | { "enable-rotation", cmd_enable_rotation }, | |
84 | { "disable-rotation", cmd_disable_rotation }, | |
85 | { "save", cmd_save }, | |
86 | { "set-session", cmd_set_session }, | |
87 | { "snapshot", cmd_snapshot }, | |
88 | { "start", cmd_start }, | |
89 | { "status", cmd_status }, | |
90 | { "stop", cmd_stop }, | |
91 | { "track", cmd_track }, | |
92 | { "untrack", cmd_untrack }, | |
93 | { "version", cmd_version }, | |
94 | { "view", cmd_view }, | |
cd9adb8b | 95 | { nullptr, nullptr } /* Array closure */ |
f3ed775e DG |
96 | }; |
97 | ||
70318c38 SS |
98 | static void version(FILE *ofp) |
99 | { | |
28ab034a JG |
100 | fprintf(ofp, |
101 | "%s (LTTng Trace Control) " VERSION " - " VERSION_NAME "%s%s\n", | |
102 | progname, | |
103 | GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION, | |
104 | EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME); | |
70318c38 SS |
105 | } |
106 | ||
c7e35b03 JR |
107 | /* |
108 | * Find the MI output type enum from a string. This function is for the support | |
109 | * of machine interface output. | |
110 | */ | |
111 | static int mi_output_type(const char *output_type) | |
112 | { | |
113 | int ret = 0; | |
114 | ||
115 | if (!strncasecmp("xml", output_type, 3)) { | |
116 | ret = LTTNG_MI_XML; | |
117 | } else { | |
118 | /* Invalid output format */ | |
119 | ERR("MI output format not supported"); | |
120 | ret = -LTTNG_ERR_MI_OUTPUT_TYPE; | |
121 | } | |
122 | ||
123 | return ret; | |
124 | } | |
125 | ||
865abf65 SM |
126 | /* |
127 | * list_options | |
128 | * | |
129 | * List options line by line. This is mostly for bash auto completion and to | |
130 | * avoid difficult parsing. | |
131 | */ | |
132 | static void list_options(FILE *ofp) | |
133 | { | |
134 | int i = 0; | |
cd9adb8b | 135 | struct option *option = nullptr; |
865abf65 SM |
136 | |
137 | option = &long_options[i]; | |
cd9adb8b | 138 | while (option->name != nullptr) { |
865abf65 SM |
139 | fprintf(ofp, "--%s\n", option->name); |
140 | ||
141 | if (isprint(option->val)) { | |
142 | fprintf(ofp, "-%c\n", option->val); | |
143 | } | |
144 | ||
145 | i++; | |
146 | option = &long_options[i]; | |
147 | } | |
148 | } | |
149 | ||
7442b2ba | 150 | /* |
f3ed775e | 151 | * clean_exit |
96243366 | 152 | */ |
28ab034a | 153 | __attribute__((noreturn)) static void clean_exit(int code) |
96243366 | 154 | { |
f3ed775e DG |
155 | DBG("Clean exit"); |
156 | exit(code); | |
894be886 | 157 | } |
96243366 | 158 | |
894be886 | 159 | /* |
f3ed775e | 160 | * sighandler |
2ef84c95 | 161 | * |
f3ed775e | 162 | * Signal handler for the daemon |
2ef84c95 | 163 | */ |
f3ed775e | 164 | static void sighandler(int sig) |
2ef84c95 | 165 | { |
f3ed775e | 166 | switch (sig) { |
28ab034a JG |
167 | case SIGTERM: |
168 | DBG("SIGTERM caught"); | |
169 | clean_exit(EXIT_FAILURE); | |
170 | break; | |
171 | default: | |
172 | DBG("Unknown signal %d caught", sig); | |
173 | break; | |
2ef84c95 DG |
174 | } |
175 | ||
f3ed775e | 176 | return; |
2ef84c95 DG |
177 | } |
178 | ||
179 | /* | |
f3ed775e | 180 | * set_signal_handler |
894be886 | 181 | * |
f3ed775e | 182 | * Setup signal handler for SIGCHLD and SIGTERM. |
894be886 | 183 | */ |
cd9adb8b | 184 | static int set_signal_handler() |
894be886 | 185 | { |
f3ed775e DG |
186 | int ret = 0; |
187 | struct sigaction sa; | |
188 | sigset_t sigset; | |
33a2b854 | 189 | |
f3ed775e | 190 | if ((ret = sigemptyset(&sigset)) < 0) { |
6f04ed72 | 191 | PERROR("sigemptyset"); |
33a2b854 DG |
192 | goto end; |
193 | } | |
194 | ||
f3ed775e DG |
195 | sa.sa_handler = sighandler; |
196 | sa.sa_mask = sigset; | |
197 | sa.sa_flags = 0; | |
96243366 | 198 | |
cd9adb8b | 199 | if ((ret = sigaction(SIGTERM, &sa, nullptr)) < 0) { |
6f04ed72 | 200 | PERROR("sigaction"); |
f3ed775e | 201 | goto end; |
894be886 DG |
202 | } |
203 | ||
96243366 | 204 | end: |
57167058 DG |
205 | return ret; |
206 | } | |
207 | ||
fac6795d | 208 | /* |
f3ed775e | 209 | * handle_command |
fac6795d | 210 | * |
f3ed775e DG |
211 | * Handle the full argv list of a first level command. Will find the command |
212 | * in the global commands array and call the function callback associated. | |
1c9f7941 | 213 | * |
f3ed775e DG |
214 | * If command not found, return -1 |
215 | * else, return function command error code. | |
1c9f7941 | 216 | */ |
f3ed775e | 217 | static int handle_command(int argc, char **argv) |
1c9f7941 | 218 | { |
f3ed775e DG |
219 | int i = 0, ret; |
220 | struct cmd_struct *cmd; | |
1c9f7941 | 221 | |
cd9adb8b | 222 | if (*argv == nullptr) { |
f3ed775e | 223 | ret = CMD_SUCCESS; |
47b74d63 | 224 | goto end; |
1c9f7941 DG |
225 | } |
226 | ||
960afba4 PP |
227 | /* Special case for help command which needs the commands array */ |
228 | if (strcmp(argv[0], "help") == 0) { | |
28ab034a | 229 | ret = cmd_help(argc, (const char **) argv, commands); |
960afba4 PP |
230 | goto end; |
231 | } | |
232 | ||
f3ed775e | 233 | cmd = &commands[i]; |
cd9adb8b | 234 | while (cmd->name != nullptr) { |
f3ed775e DG |
235 | /* Find command */ |
236 | if (strcmp(argv[0], cmd->name) == 0) { | |
8884bbc1 JG |
237 | try { |
238 | ret = cmd->func(argc, (const char **) argv); | |
239 | } catch (const std::exception& e) { | |
240 | ERR_FMT("{}", e.what()); | |
241 | ret = CMD_ERROR; | |
242 | } | |
243 | ||
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 | ||
cd9adb8b | 262 | while (cmd->name != nullptr) { |
6047170f JG |
263 | if (!strcmp(command, cmd->name)) { |
264 | exists = true; | |
265 | goto end; | |
266 | } | |
267 | cmd++; | |
268 | } | |
269 | ||
270 | end: | |
271 | return exists; | |
272 | } | |
273 | ||
cd9adb8b | 274 | static void show_basic_help() |
9fb6c2db PP |
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(""); | |
e9711845 | 281 | puts("Recording sessions:"); |
9fb6c2db | 282 | puts(" create " CONFIG_CMD_DESCR_CREATE); |
511ed4e2 | 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(""); | |
484b2a0c | 295 | puts("Recording event rules:"); |
9fb6c2db PP |
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(""); | |
e9711845 | 308 | puts("Recording session rotation:"); |
77927271 JG |
309 | puts(" disable-rotation " CONFIG_CMD_DESCR_DISABLE_ROTATION); |
310 | puts(" enable-rotation " CONFIG_CMD_DESCR_ENABLE_ROTATION); | |
311 | puts(" rotate " CONFIG_CMD_DESCR_ROTATE); | |
312 | puts(""); | |
9fb6c2db PP |
313 | puts("Resource tracking:"); |
314 | puts(" track " CONFIG_CMD_DESCR_TRACK); | |
315 | puts(" untrack " CONFIG_CMD_DESCR_UNTRACK); | |
316 | puts(""); | |
484b2a0c PP |
317 | puts("Triggers:"); |
318 | puts(" add-trigger " CONFIG_CMD_DESCR_ADD_TRIGGER); | |
319 | puts(" remove-trigger " CONFIG_CMD_DESCR_REMOVE_TRIGGER); | |
320 | puts(" list-triggers " CONFIG_CMD_DESCR_LIST_TRIGGERS); | |
321 | puts(""); | |
9fb6c2db | 322 | puts("Miscellaneous:"); |
9fb6c2db PP |
323 | puts(" help " CONFIG_CMD_DESCR_HELP); |
324 | puts(" version " CONFIG_CMD_DESCR_VERSION); | |
325 | puts(" view " CONFIG_CMD_DESCR_VIEW); | |
326 | puts(""); | |
327 | puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with"); | |
328 | puts("command COMMAND."); | |
329 | puts(""); | |
330 | puts("See `man lttng` for more help with the lttng command."); | |
331 | } | |
332 | ||
5b8719f5 | 333 | /* |
3183dbb0 | 334 | * Parse command line arguments. |
5b8719f5 | 335 | * |
3183dbb0 | 336 | * Return 0 if OK, else -1 |
5b8719f5 | 337 | */ |
f3ed775e | 338 | static int parse_args(int argc, char **argv) |
5b8719f5 | 339 | { |
f3ed775e | 340 | int opt, ret; |
5b8719f5 | 341 | |
e8fa9fb0 | 342 | if (lttng_is_setuid_setgid()) { |
28ab034a JG |
343 | ERR("'%s' is not allowed to be executed as a setuid/setgid binary for security reasons. Aborting.", |
344 | argv[0]); | |
e8fa9fb0 MD |
345 | clean_exit(EXIT_FAILURE); |
346 | } | |
347 | ||
f3ed775e | 348 | if (argc < 2) { |
9fb6c2db | 349 | show_basic_help(); |
f3ed775e | 350 | clean_exit(EXIT_FAILURE); |
5b8719f5 DG |
351 | } |
352 | ||
cd9adb8b | 353 | while ((opt = getopt_long(argc, argv, "+Vhnvqg:m:", long_options, nullptr)) != -1) { |
f3ed775e | 354 | switch (opt) { |
70318c38 SS |
355 | case 'V': |
356 | version(stdout); | |
357 | ret = 0; | |
358 | goto end; | |
f3ed775e | 359 | case 'h': |
4fc83d94 | 360 | ret = utils_show_help(1, "lttng", help_msg); |
f67353ba | 361 | if (ret) { |
4fc83d94 | 362 | ERR("Cannot show --help for `lttng`"); |
f67353ba PP |
363 | perror("exec"); |
364 | } | |
3183dbb0 | 365 | goto end; |
f3ed775e | 366 | case 'v': |
849e5b7b DG |
367 | /* There is only 3 possible level of verbosity. (-vvv) */ |
368 | if (lttng_opt_verbose < 3) { | |
369 | lttng_opt_verbose += 1; | |
370 | } | |
f3ed775e DG |
371 | break; |
372 | case 'q': | |
97e19046 | 373 | lttng_opt_quiet = 1; |
f3ed775e | 374 | break; |
c7e35b03 JR |
375 | case 'm': |
376 | lttng_opt_mi = mi_output_type(optarg); | |
377 | if (lttng_opt_mi < 0) { | |
378 | ret = lttng_opt_mi; | |
379 | goto error; | |
380 | } | |
381 | break; | |
f3ed775e DG |
382 | case 'g': |
383 | lttng_set_tracing_group(optarg); | |
384 | break; | |
8490ae7b | 385 | case 'n': |
f3ed775e DG |
386 | opt_no_sessiond = 1; |
387 | break; | |
388 | case OPT_SESSION_PATH: | |
3ddaa633 | 389 | free(opt_sessiond_path); |
f3ed775e | 390 | opt_sessiond_path = strdup(optarg); |
d7c5d39f MD |
391 | if (!opt_sessiond_path) { |
392 | ret = -1; | |
393 | goto error; | |
394 | } | |
f3ed775e | 395 | break; |
8960e9cd | 396 | case OPT_RELAYD_PATH: |
3ddaa633 | 397 | free(opt_relayd_path); |
8960e9cd | 398 | opt_relayd_path = strdup(optarg); |
d7c5d39f MD |
399 | if (!opt_relayd_path) { |
400 | ret = -1; | |
401 | goto error; | |
402 | } | |
8960e9cd | 403 | break; |
865abf65 SM |
404 | case OPT_DUMP_OPTIONS: |
405 | list_options(stdout); | |
406 | ret = 0; | |
3183dbb0 | 407 | goto end; |
865abf65 | 408 | case OPT_DUMP_COMMANDS: |
3c9bd23c | 409 | list_commands(commands, stdout); |
865abf65 | 410 | ret = 0; |
3183dbb0 | 411 | goto end; |
f3ed775e | 412 | default: |
ae856491 | 413 | ret = 1; |
f3ed775e DG |
414 | goto error; |
415 | } | |
5b8719f5 | 416 | } |
fac6795d | 417 | |
f3ed775e | 418 | /* If both options are specified, quiet wins */ |
97e19046 DG |
419 | if (lttng_opt_verbose && lttng_opt_quiet) { |
420 | lttng_opt_verbose = 0; | |
5b8719f5 DG |
421 | } |
422 | ||
f67353ba | 423 | /* No leftovers, quit */ |
f3ed775e | 424 | if ((argc - optind) == 0) { |
8005f29a | 425 | ret = 1; |
f3ed775e DG |
426 | goto error; |
427 | } | |
7442b2ba | 428 | |
92360082 | 429 | /* |
f3ed775e DG |
430 | * Handle leftovers which is a first level command with the trailing |
431 | * options. | |
432 | */ | |
433 | ret = handle_command(argc - optind, argv + optind); | |
ae856491 DG |
434 | switch (ret) { |
435 | case CMD_WARNING: | |
ae856491 | 436 | case CMD_ERROR: |
ae856491 DG |
437 | break; |
438 | case CMD_UNDEFINED: | |
6047170f JG |
439 | if (!command_exists(*(argv + optind))) { |
440 | MSG("lttng: %s is not an lttng command. See 'lttng --help'.", | |
28ab034a | 441 | *(argv + optind)); |
6047170f | 442 | } else { |
28ab034a | 443 | ERR("Unrecognized argument used with \'%s\' command", *(argv + optind)); |
6047170f | 444 | } |
ae856491 DG |
445 | break; |
446 | case CMD_FATAL: | |
4ce78777 | 447 | case CMD_UNSUPPORTED: |
4ce78777 | 448 | break; |
ae856491 | 449 | case -1: |
ae856491 DG |
450 | ret = 1; |
451 | break; | |
452 | case 0: | |
453 | break; | |
454 | default: | |
42224349 DG |
455 | if (ret < 0) { |
456 | ret = -ret; | |
457 | } | |
ae856491 | 458 | break; |
96243366 DG |
459 | } |
460 | ||
3183dbb0 | 461 | end: |
f3ed775e | 462 | error: |
ae856491 | 463 | return ret; |
fac6795d DG |
464 | } |
465 | ||
466 | /* | |
5b8719f5 | 467 | * main |
fac6795d | 468 | */ |
d5ed3e6f | 469 | static int _main(int argc, char *argv[]) |
fac6795d DG |
470 | { |
471 | int ret; | |
472 | ||
473 | progname = argv[0] ? argv[0] : "lttng"; | |
474 | ||
5b8719f5 DG |
475 | ret = set_signal_handler(); |
476 | if (ret < 0) { | |
87378cf5 | 477 | clean_exit(ret); |
5b8719f5 DG |
478 | } |
479 | ||
f3ed775e | 480 | ret = parse_args(argc, argv); |
ae856491 DG |
481 | if (ret != 0) { |
482 | clean_exit(ret); | |
1fff1faa | 483 | } |
87378cf5 | 484 | |
fac6795d DG |
485 | return 0; |
486 | } | |
d5ed3e6f JG |
487 | |
488 | int main(int argc, char **argv) | |
489 | { | |
490 | try { | |
491 | return _main(argc, argv); | |
492 | } catch (const std::exception& e) { | |
ae26b182 | 493 | ERR_FMT("Unhandled exception caught by client: {}", e.what()); |
d5ed3e6f JG |
494 | abort(); |
495 | } | |
496 | } |