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