2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
4 * SPDX-License-Identifier: GPL-2.0-only
14 #include <sys/types.h>
19 #include <lttng/lttng.h>
20 #include <common/error.h>
21 #include <common/compat/getenv.h>
22 #include <common/utils.h>
27 static const char *help_msg
=
28 #ifdef LTTNG_EMBED_HELP
36 static const char *progname
;
38 char *opt_sessiond_path
;
40 char *opt_relayd_path
;
49 /* Getopt options. No first level command. */
50 static struct option long_options
[] = {
51 {"version", 0, NULL
, 'V'},
52 {"help", 0, NULL
, 'h'},
53 {"group", 1, NULL
, 'g'},
54 {"verbose", 0, NULL
, 'v'},
55 {"quiet", 0, NULL
, 'q'},
57 {"no-sessiond", 0, NULL
, 'n'},
58 {"sessiond-path", 1, NULL
, OPT_SESSION_PATH
},
59 {"relayd-path", 1, NULL
, OPT_RELAYD_PATH
},
60 {"list-options", 0, NULL
, OPT_DUMP_OPTIONS
},
61 {"list-commands", 0, NULL
, OPT_DUMP_COMMANDS
},
65 /* First level command */
66 static struct cmd_struct commands
[] = {
67 { "add-context", cmd_add_context
},
68 { "add-trigger", cmd_add_trigger
},
69 { "create", cmd_create
},
70 { "clear", cmd_clear
},
71 { "destroy", cmd_destroy
},
72 { "disable-channel", cmd_disable_channels
},
73 { "disable-event", cmd_disable_events
},
74 { "enable-channel", cmd_enable_channels
},
75 { "enable-event", cmd_enable_events
},
79 { "metadata", cmd_metadata
},
80 { "regenerate", cmd_regenerate
},
81 { "rotate", cmd_rotate
},
82 { "enable-rotation", cmd_enable_rotation
},
83 { "disable-rotation", cmd_disable_rotation
},
85 { "set-session", cmd_set_session
},
86 { "snapshot", cmd_snapshot
},
87 { "start", cmd_start
},
88 { "status", cmd_status
},
90 { "track", cmd_track
},
91 { "untrack", cmd_untrack
},
92 { "version", cmd_version
},
94 { NULL
, NULL
} /* Array closure */
97 static void version(FILE *ofp
)
99 fprintf(ofp
, "%s (LTTng Trace Control) " VERSION
" - " VERSION_NAME
"%s%s\n",
101 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
,
102 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
106 * Find the MI output type enum from a string. This function is for the support
107 * of machine interface output.
109 static int mi_output_type(const char *output_type
)
113 if (!strncasecmp("xml", output_type
, 3)) {
116 /* Invalid output format */
117 ERR("MI output format not supported");
118 ret
= -LTTNG_ERR_MI_OUTPUT_TYPE
;
127 * List options line by line. This is mostly for bash auto completion and to
128 * avoid difficult parsing.
130 static void list_options(FILE *ofp
)
133 struct option
*option
= NULL
;
135 option
= &long_options
[i
];
136 while (option
->name
!= NULL
) {
137 fprintf(ofp
, "--%s\n", option
->name
);
139 if (isprint(option
->val
)) {
140 fprintf(ofp
, "-%c\n", option
->val
);
144 option
= &long_options
[i
];
151 static void clean_exit(int code
)
160 * Signal handler for the daemon
162 static void sighandler(int sig
)
166 DBG("SIGTERM caught");
167 clean_exit(EXIT_FAILURE
);
170 DBG("Unknown signal %d caught", sig
);
180 * Setup signal handler for SIGCHLD and SIGTERM.
182 static int set_signal_handler(void)
188 if ((ret
= sigemptyset(&sigset
)) < 0) {
189 PERROR("sigemptyset");
193 sa
.sa_handler
= sighandler
;
197 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
209 * Handle the full argv list of a first level command. Will find the command
210 * in the global commands array and call the function callback associated.
212 * If command not found, return -1
213 * else, return function command error code.
215 static int handle_command(int argc
, char **argv
)
218 struct cmd_struct
*cmd
;
225 /* Special case for help command which needs the commands array */
226 if (strcmp(argv
[0], "help") == 0) {
227 ret
= cmd_help(argc
, (const char**) argv
, commands
);
232 while (cmd
->name
!= NULL
) {
234 if (strcmp(argv
[0], cmd
->name
) == 0) {
235 ret
= cmd
->func(argc
, (const char**) argv
);
242 /* Command not found */
249 static bool command_exists(const char *command
)
251 const struct cmd_struct
*cmd
= commands
;
254 while (cmd
->name
!= NULL
) {
255 if (!strcmp(command
, cmd
->name
)) {
266 static void show_basic_help(void)
268 puts("Usage: lttng [--group=GROUP] [--mi=TYPE] [--no-sessiond | --sessiond-path=PATH]");
269 puts(" [--quiet | -v | -vv | -vvv] COMMAND [COMMAND OPTIONS]");
271 puts("Available commands:");
273 puts("Tracing sessions:");
274 puts(" create " CONFIG_CMD_DESCR_CREATE
);
275 puts(" clear " CONFIG_CMD_DESCR_CLEAR
);
276 puts(" destroy " CONFIG_CMD_DESCR_DESTROY
);
277 puts(" load " CONFIG_CMD_DESCR_LOAD
);
278 puts(" regenerate " CONFIG_CMD_DESCR_REGENERATE
);
279 puts(" save " CONFIG_CMD_DESCR_SAVE
);
280 puts(" set-session " CONFIG_CMD_DESCR_SET_SESSION
);
283 puts(" add-context " CONFIG_CMD_DESCR_ADD_CONTEXT
);
284 puts(" disable-channel " CONFIG_CMD_DESCR_DISABLE_CHANNEL
);
285 puts(" enable-channel " CONFIG_CMD_DESCR_ENABLE_CHANNEL
);
287 puts("Event rules:");
288 puts(" disable-event " CONFIG_CMD_DESCR_DISABLE_EVENT
);
289 puts(" enable-event " CONFIG_CMD_DESCR_ENABLE_EVENT
);
292 puts(" list " CONFIG_CMD_DESCR_LIST
);
293 puts(" status " CONFIG_CMD_DESCR_STATUS
);
296 puts(" snapshot " CONFIG_CMD_DESCR_SNAPSHOT
);
297 puts(" start " CONFIG_CMD_DESCR_START
);
298 puts(" stop " CONFIG_CMD_DESCR_STOP
);
300 puts("Tracing session rotation:");
301 puts(" disable-rotation " CONFIG_CMD_DESCR_DISABLE_ROTATION
);
302 puts(" enable-rotation " CONFIG_CMD_DESCR_ENABLE_ROTATION
);
303 puts(" rotate " CONFIG_CMD_DESCR_ROTATE
);
305 puts("Resource tracking:");
306 puts(" track " CONFIG_CMD_DESCR_TRACK
);
307 puts(" untrack " CONFIG_CMD_DESCR_UNTRACK
);
309 puts("Miscellaneous:");
310 puts(" help " CONFIG_CMD_DESCR_HELP
);
311 puts(" version " CONFIG_CMD_DESCR_VERSION
);
312 puts(" view " CONFIG_CMD_DESCR_VIEW
);
314 puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with");
315 puts("command COMMAND.");
317 puts("See `man lttng` for more help with the lttng command.");
321 * Parse command line arguments.
323 * Return 0 if OK, else -1
325 static int parse_args(int argc
, char **argv
)
329 if (lttng_is_setuid_setgid()) {
330 ERR("'%s' is not allowed to be executed as a setuid/setgid binary for security reasons. Aborting.", argv
[0]);
331 clean_exit(EXIT_FAILURE
);
336 clean_exit(EXIT_FAILURE
);
339 while ((opt
= getopt_long(argc
, argv
, "+Vhnvqg:m:", long_options
, NULL
)) != -1) {
346 ret
= utils_show_help(1, "lttng", help_msg
);
348 ERR("Cannot show --help for `lttng`");
353 /* There is only 3 possible level of verbosity. (-vvv) */
354 if (lttng_opt_verbose
< 3) {
355 lttng_opt_verbose
+= 1;
362 lttng_opt_mi
= mi_output_type(optarg
);
363 if (lttng_opt_mi
< 0) {
369 lttng_set_tracing_group(optarg
);
374 case OPT_SESSION_PATH
:
375 free(opt_sessiond_path
);
376 opt_sessiond_path
= strdup(optarg
);
377 if (!opt_sessiond_path
) {
382 case OPT_RELAYD_PATH
:
383 free(opt_relayd_path
);
384 opt_relayd_path
= strdup(optarg
);
385 if (!opt_relayd_path
) {
390 case OPT_DUMP_OPTIONS
:
391 list_options(stdout
);
394 case OPT_DUMP_COMMANDS
:
395 list_commands(commands
, stdout
);
404 /* If both options are specified, quiet wins */
405 if (lttng_opt_verbose
&& lttng_opt_quiet
) {
406 lttng_opt_verbose
= 0;
409 /* No leftovers, quit */
410 if ((argc
- optind
) == 0) {
416 * Handle leftovers which is a first level command with the trailing
419 ret
= handle_command(argc
- optind
, argv
+ optind
);
425 if (!command_exists(*(argv
+ optind
))) {
426 MSG("lttng: %s is not an lttng command. See 'lttng --help'.",
429 ERR("Unrecognized argument used with \'%s\' command",
434 case CMD_UNSUPPORTED
:
457 int main(int argc
, char *argv
[])
461 progname
= argv
[0] ? argv
[0] : "lttng";
463 ret
= set_signal_handler();
468 ret
= parse_args(argc
, argv
);