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