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