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
},
76 { "add-map", cmd_add_map
},
77 { "enable-map", cmd_enable_map
},
78 { "disable-map", cmd_disable_map
},
81 { "list-triggers", cmd_list_triggers
},
83 { "metadata", cmd_metadata
},
84 { "regenerate", cmd_regenerate
},
85 { "remove-trigger", cmd_remove_trigger
},
86 { "rotate", cmd_rotate
},
87 { "enable-rotation", cmd_enable_rotation
},
88 { "disable-rotation", cmd_disable_rotation
},
90 { "set-session", cmd_set_session
},
91 { "snapshot", cmd_snapshot
},
92 { "start", cmd_start
},
93 { "status", cmd_status
},
95 { "track", cmd_track
},
96 { "untrack", cmd_untrack
},
97 { "version", cmd_version
},
99 { "view-map", cmd_view_map
},
100 { NULL
, NULL
} /* Array closure */
103 static void version(FILE *ofp
)
105 fprintf(ofp
, "%s (LTTng Trace Control) " VERSION
" - " VERSION_NAME
"%s%s\n",
107 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
,
108 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
112 * Find the MI output type enum from a string. This function is for the support
113 * of machine interface output.
115 static int mi_output_type(const char *output_type
)
119 if (!strncasecmp("xml", output_type
, 3)) {
122 /* Invalid output format */
123 ERR("MI output format not supported");
124 ret
= -LTTNG_ERR_MI_OUTPUT_TYPE
;
133 * List options line by line. This is mostly for bash auto completion and to
134 * avoid difficult parsing.
136 static void list_options(FILE *ofp
)
139 struct option
*option
= NULL
;
141 option
= &long_options
[i
];
142 while (option
->name
!= NULL
) {
143 fprintf(ofp
, "--%s\n", option
->name
);
145 if (isprint(option
->val
)) {
146 fprintf(ofp
, "-%c\n", option
->val
);
150 option
= &long_options
[i
];
157 static void clean_exit(int code
)
166 * Signal handler for the daemon
168 static void sighandler(int sig
)
172 DBG("SIGTERM caught");
173 clean_exit(EXIT_FAILURE
);
176 DBG("Unknown signal %d caught", sig
);
186 * Setup signal handler for SIGCHLD and SIGTERM.
188 static int set_signal_handler(void)
194 if ((ret
= sigemptyset(&sigset
)) < 0) {
195 PERROR("sigemptyset");
199 sa
.sa_handler
= sighandler
;
203 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
215 * Handle the full argv list of a first level command. Will find the command
216 * in the global commands array and call the function callback associated.
218 * If command not found, return -1
219 * else, return function command error code.
221 static int handle_command(int argc
, char **argv
)
224 struct cmd_struct
*cmd
;
231 /* Special case for help command which needs the commands array */
232 if (strcmp(argv
[0], "help") == 0) {
233 ret
= cmd_help(argc
, (const char**) argv
, commands
);
238 while (cmd
->name
!= NULL
) {
240 if (strcmp(argv
[0], cmd
->name
) == 0) {
241 ret
= cmd
->func(argc
, (const char**) argv
);
248 /* Command not found */
255 static bool command_exists(const char *command
)
257 const struct cmd_struct
*cmd
= commands
;
260 while (cmd
->name
!= NULL
) {
261 if (!strcmp(command
, cmd
->name
)) {
272 static void show_basic_help(void)
274 puts("Usage: lttng [--group=GROUP] [--mi=TYPE] [--no-sessiond | --sessiond-path=PATH]");
275 puts(" [--quiet | -v | -vv | -vvv] COMMAND [COMMAND OPTIONS]");
277 puts("Available commands:");
279 puts("Tracing sessions:");
280 puts(" create " CONFIG_CMD_DESCR_CREATE
);
281 puts(" clear " CONFIG_CMD_DESCR_CLEAR
);
282 puts(" destroy " CONFIG_CMD_DESCR_DESTROY
);
283 puts(" load " CONFIG_CMD_DESCR_LOAD
);
284 puts(" regenerate " CONFIG_CMD_DESCR_REGENERATE
);
285 puts(" save " CONFIG_CMD_DESCR_SAVE
);
286 puts(" set-session " CONFIG_CMD_DESCR_SET_SESSION
);
289 puts(" add-context " CONFIG_CMD_DESCR_ADD_CONTEXT
);
290 puts(" disable-channel " CONFIG_CMD_DESCR_DISABLE_CHANNEL
);
291 puts(" enable-channel " CONFIG_CMD_DESCR_ENABLE_CHANNEL
);
294 puts(" add-map " CONFIG_CMD_DESCR_ADD_MAP
);
295 puts(" remove-map " CONFIG_CMD_DESCR_ADD_MAP
);
297 puts("Event rules:");
298 puts(" disable-event " CONFIG_CMD_DESCR_DISABLE_EVENT
);
299 puts(" enable-event " CONFIG_CMD_DESCR_ENABLE_EVENT
);
302 puts(" list " CONFIG_CMD_DESCR_LIST
);
303 puts(" status " CONFIG_CMD_DESCR_STATUS
);
306 puts(" snapshot " CONFIG_CMD_DESCR_SNAPSHOT
);
307 puts(" start " CONFIG_CMD_DESCR_START
);
308 puts(" stop " CONFIG_CMD_DESCR_STOP
);
310 puts("Tracing session rotation:");
311 puts(" disable-rotation " CONFIG_CMD_DESCR_DISABLE_ROTATION
);
312 puts(" enable-rotation " CONFIG_CMD_DESCR_ENABLE_ROTATION
);
313 puts(" rotate " CONFIG_CMD_DESCR_ROTATE
);
315 puts("Resource tracking:");
316 puts(" track " CONFIG_CMD_DESCR_TRACK
);
317 puts(" untrack " CONFIG_CMD_DESCR_UNTRACK
);
319 puts("Miscellaneous:");
320 puts(" help " CONFIG_CMD_DESCR_HELP
);
321 puts(" version " CONFIG_CMD_DESCR_VERSION
);
322 puts(" view " CONFIG_CMD_DESCR_VIEW
);
324 puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with");
325 puts("command COMMAND.");
327 puts("See `man lttng` for more help with the lttng command.");
331 * Parse command line arguments.
333 * Return 0 if OK, else -1
335 static int parse_args(int argc
, char **argv
)
339 if (lttng_is_setuid_setgid()) {
340 ERR("'%s' is not allowed to be executed as a setuid/setgid binary for security reasons. Aborting.", argv
[0]);
341 clean_exit(EXIT_FAILURE
);
346 clean_exit(EXIT_FAILURE
);
349 while ((opt
= getopt_long(argc
, argv
, "+Vhnvqg:m:", long_options
, NULL
)) != -1) {
356 ret
= utils_show_help(1, "lttng", help_msg
);
358 ERR("Cannot show --help for `lttng`");
363 /* There is only 3 possible level of verbosity. (-vvv) */
364 if (lttng_opt_verbose
< 3) {
365 lttng_opt_verbose
+= 1;
372 lttng_opt_mi
= mi_output_type(optarg
);
373 if (lttng_opt_mi
< 0) {
379 lttng_set_tracing_group(optarg
);
384 case OPT_SESSION_PATH
:
385 free(opt_sessiond_path
);
386 opt_sessiond_path
= strdup(optarg
);
387 if (!opt_sessiond_path
) {
392 case OPT_RELAYD_PATH
:
393 free(opt_relayd_path
);
394 opt_relayd_path
= strdup(optarg
);
395 if (!opt_relayd_path
) {
400 case OPT_DUMP_OPTIONS
:
401 list_options(stdout
);
404 case OPT_DUMP_COMMANDS
:
405 list_commands(commands
, stdout
);
414 /* If both options are specified, quiet wins */
415 if (lttng_opt_verbose
&& lttng_opt_quiet
) {
416 lttng_opt_verbose
= 0;
419 /* No leftovers, quit */
420 if ((argc
- optind
) == 0) {
426 * Handle leftovers which is a first level command with the trailing
429 ret
= handle_command(argc
- optind
, argv
+ optind
);
435 if (!command_exists(*(argv
+ optind
))) {
436 MSG("lttng: %s is not an lttng command. See 'lttng --help'.",
439 ERR("Unrecognized argument used with \'%s\' command",
444 case CMD_UNSUPPORTED
:
467 int main(int argc
, char *argv
[])
471 progname
= argv
[0] ? argv
[0] : "lttng";
473 ret
= set_signal_handler();
478 ret
= parse_args(argc
, argv
);