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
},
78 { "list-triggers", cmd_list_triggers
},
80 { "metadata", cmd_metadata
},
81 { "regenerate", cmd_regenerate
},
82 { "rotate", cmd_rotate
},
83 { "enable-rotation", cmd_enable_rotation
},
84 { "disable-rotation", cmd_disable_rotation
},
86 { "set-session", cmd_set_session
},
87 { "snapshot", cmd_snapshot
},
88 { "start", cmd_start
},
89 { "status", cmd_status
},
91 { "track", cmd_track
},
92 { "untrack", cmd_untrack
},
93 { "version", cmd_version
},
95 { NULL
, NULL
} /* Array closure */
98 static void version(FILE *ofp
)
100 fprintf(ofp
, "%s (LTTng Trace Control) " VERSION
" - " VERSION_NAME
"%s%s\n",
102 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
,
103 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
107 * Find the MI output type enum from a string. This function is for the support
108 * of machine interface output.
110 static int mi_output_type(const char *output_type
)
114 if (!strncasecmp("xml", output_type
, 3)) {
117 /* Invalid output format */
118 ERR("MI output format not supported");
119 ret
= -LTTNG_ERR_MI_OUTPUT_TYPE
;
128 * List options line by line. This is mostly for bash auto completion and to
129 * avoid difficult parsing.
131 static void list_options(FILE *ofp
)
134 struct option
*option
= NULL
;
136 option
= &long_options
[i
];
137 while (option
->name
!= NULL
) {
138 fprintf(ofp
, "--%s\n", option
->name
);
140 if (isprint(option
->val
)) {
141 fprintf(ofp
, "-%c\n", option
->val
);
145 option
= &long_options
[i
];
152 static void clean_exit(int code
)
161 * Signal handler for the daemon
163 static void sighandler(int sig
)
167 DBG("SIGTERM caught");
168 clean_exit(EXIT_FAILURE
);
171 DBG("Unknown signal %d caught", sig
);
181 * Setup signal handler for SIGCHLD and SIGTERM.
183 static int set_signal_handler(void)
189 if ((ret
= sigemptyset(&sigset
)) < 0) {
190 PERROR("sigemptyset");
194 sa
.sa_handler
= sighandler
;
198 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
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.
213 * If command not found, return -1
214 * else, return function command error code.
216 static int handle_command(int argc
, char **argv
)
219 struct cmd_struct
*cmd
;
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
);
233 while (cmd
->name
!= NULL
) {
235 if (strcmp(argv
[0], cmd
->name
) == 0) {
236 ret
= cmd
->func(argc
, (const char**) argv
);
243 /* Command not found */
250 static bool command_exists(const char *command
)
252 const struct cmd_struct
*cmd
= commands
;
255 while (cmd
->name
!= NULL
) {
256 if (!strcmp(command
, cmd
->name
)) {
267 static void show_basic_help(void)
269 puts("Usage: lttng [--group=GROUP] [--mi=TYPE] [--no-sessiond | --sessiond-path=PATH]");
270 puts(" [--quiet | -v | -vv | -vvv] COMMAND [COMMAND OPTIONS]");
272 puts("Available commands:");
274 puts("Tracing sessions:");
275 puts(" create " CONFIG_CMD_DESCR_CREATE
);
276 puts(" clear " CONFIG_CMD_DESCR_CLEAR
);
277 puts(" destroy " CONFIG_CMD_DESCR_DESTROY
);
278 puts(" load " CONFIG_CMD_DESCR_LOAD
);
279 puts(" regenerate " CONFIG_CMD_DESCR_REGENERATE
);
280 puts(" save " CONFIG_CMD_DESCR_SAVE
);
281 puts(" set-session " CONFIG_CMD_DESCR_SET_SESSION
);
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
);
288 puts("Event rules:");
289 puts(" disable-event " CONFIG_CMD_DESCR_DISABLE_EVENT
);
290 puts(" enable-event " CONFIG_CMD_DESCR_ENABLE_EVENT
);
293 puts(" list " CONFIG_CMD_DESCR_LIST
);
294 puts(" status " CONFIG_CMD_DESCR_STATUS
);
297 puts(" snapshot " CONFIG_CMD_DESCR_SNAPSHOT
);
298 puts(" start " CONFIG_CMD_DESCR_START
);
299 puts(" stop " CONFIG_CMD_DESCR_STOP
);
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
);
306 puts("Resource tracking:");
307 puts(" track " CONFIG_CMD_DESCR_TRACK
);
308 puts(" untrack " CONFIG_CMD_DESCR_UNTRACK
);
310 puts("Miscellaneous:");
311 puts(" help " CONFIG_CMD_DESCR_HELP
);
312 puts(" version " CONFIG_CMD_DESCR_VERSION
);
313 puts(" view " CONFIG_CMD_DESCR_VIEW
);
315 puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with");
316 puts("command COMMAND.");
318 puts("See `man lttng` for more help with the lttng command.");
322 * Parse command line arguments.
324 * Return 0 if OK, else -1
326 static int parse_args(int argc
, char **argv
)
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
);
337 clean_exit(EXIT_FAILURE
);
340 while ((opt
= getopt_long(argc
, argv
, "+Vhnvqg:m:", long_options
, NULL
)) != -1) {
347 ret
= utils_show_help(1, "lttng", help_msg
);
349 ERR("Cannot show --help for `lttng`");
354 /* There is only 3 possible level of verbosity. (-vvv) */
355 if (lttng_opt_verbose
< 3) {
356 lttng_opt_verbose
+= 1;
363 lttng_opt_mi
= mi_output_type(optarg
);
364 if (lttng_opt_mi
< 0) {
370 lttng_set_tracing_group(optarg
);
375 case OPT_SESSION_PATH
:
376 free(opt_sessiond_path
);
377 opt_sessiond_path
= strdup(optarg
);
378 if (!opt_sessiond_path
) {
383 case OPT_RELAYD_PATH
:
384 free(opt_relayd_path
);
385 opt_relayd_path
= strdup(optarg
);
386 if (!opt_relayd_path
) {
391 case OPT_DUMP_OPTIONS
:
392 list_options(stdout
);
395 case OPT_DUMP_COMMANDS
:
396 list_commands(commands
, stdout
);
405 /* If both options are specified, quiet wins */
406 if (lttng_opt_verbose
&& lttng_opt_quiet
) {
407 lttng_opt_verbose
= 0;
410 /* No leftovers, quit */
411 if ((argc
- optind
) == 0) {
417 * Handle leftovers which is a first level command with the trailing
420 ret
= handle_command(argc
- optind
, argv
+ optind
);
426 if (!command_exists(*(argv
+ optind
))) {
427 MSG("lttng: %s is not an lttng command. See 'lttng --help'.",
430 ERR("Unrecognized argument used with \'%s\' command",
435 case CMD_UNSUPPORTED
:
458 int main(int argc
, char *argv
[])
462 progname
= argv
[0] ? argv
[0] : "lttng";
464 ret
= set_signal_handler();
469 ret
= parse_args(argc
, argv
);