Add a save command based on the save API to the lttng client
[lttng-tools.git] / src / bin / lttng / lttng.c
CommitLineData
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
18#define _GNU_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>
3bd1e081 27#include <config.h>
730389d9 28#include <ctype.h>
fac6795d 29
5b97ec60 30#include <lttng/lttng.h>
db758600 31#include <common/error.h>
fac6795d 32
c399183f 33#include "command.h"
fac6795d
DG
34
35/* Variables */
36static char *progname;
f3ed775e
DG
37static int opt_no_sessiond;
38static char *opt_sessiond_path;
8db8d1dc 39static pid_t sessiond_pid;
5a532b68 40static volatile int recv_child_signal;
f3ed775e 41
8960e9cd
DG
42char *opt_relayd_path;
43
f3ed775e 44enum {
8960e9cd 45 OPT_RELAYD_PATH,
f3ed775e 46 OPT_SESSION_PATH,
865abf65
SM
47 OPT_DUMP_OPTIONS,
48 OPT_DUMP_COMMANDS,
f3ed775e
DG
49};
50
51/* Getopt options. No first level command. */
52static struct option long_options[] = {
70318c38 53 {"version", 0, NULL, 'V'},
f3ed775e
DG
54 {"help", 0, NULL, 'h'},
55 {"group", 1, NULL, 'g'},
56 {"verbose", 0, NULL, 'v'},
57 {"quiet", 0, NULL, 'q'},
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 */
67static struct cmd_struct commands[] = {
68 { "list", cmd_list},
69 { "create", cmd_create},
70 { "destroy", cmd_destroy},
f3ed775e
DG
71 { "start", cmd_start},
72 { "stop", cmd_stop},
73 { "enable-event", cmd_enable_events},
e953ef25 74 { "disable-event", cmd_disable_events},
d36b8583 75 { "enable-channel", cmd_enable_channels},
26cc6b4e 76 { "disable-channel", cmd_disable_channels},
d65106b1 77 { "add-context", cmd_add_context},
3087ef18 78 { "set-session", cmd_set_session},
eb9cb8b7 79 { "version", cmd_version},
d0254c7c 80 { "calibrate", cmd_calibrate},
0c95f5b2 81 { "view", cmd_view},
57f272ed 82 { "snapshot", cmd_snapshot},
c864d6d7 83 { "save", cmd_save},
9c6bda17
DG
84 { "enable-consumer", cmd_enable_consumer}, /* OBSOLETE */
85 { "disable-consumer", cmd_disable_consumer}, /* OBSOLETE */
f3ed775e
DG
86 { NULL, NULL} /* Array closure */
87};
88
89static void usage(FILE *ofp)
8c0faa1d 90{
c6d4a597 91 fprintf(ofp, "LTTng Trace Control " VERSION" - " VERSION_NAME"\n\n");
32a6298d 92 fprintf(ofp, "usage: lttng [OPTIONS] <COMMAND> [<ARGS>]\n");
f3ed775e
DG
93 fprintf(ofp, "\n");
94 fprintf(ofp, "Options:\n");
70318c38 95 fprintf(ofp, " -V, --version Show version\n");
99bab54f
TD
96 fprintf(ofp, " -h, --help Show this help\n");
97 fprintf(ofp, " --list-options Simple listing of lttng options\n");
98 fprintf(ofp, " --list-commands Simple listing of lttng commands\n");
99 fprintf(ofp, " -v, --verbose Increase verbosity\n");
100 fprintf(ofp, " -q, --quiet Quiet mode\n");
101 fprintf(ofp, " -g, --group NAME Unix tracing group name. (default: tracing)\n");
102 fprintf(ofp, " -n, --no-sessiond Don't spawn a session daemon\n");
103 fprintf(ofp, " --sessiond-path PATH Session daemon full path\n");
8960e9cd 104 fprintf(ofp, " --relayd-path PATH Relayd daemon full path\n");
f3ed775e
DG
105 fprintf(ofp, "\n");
106 fprintf(ofp, "Commands:\n");
00e2e675
DG
107 fprintf(ofp, " add-context Add context to event and/or channel\n");
108 fprintf(ofp, " calibrate Quantify LTTng overhead\n");
109 fprintf(ofp, " create Create tracing session\n");
110 fprintf(ofp, " destroy Tear down tracing session\n");
111 fprintf(ofp, " enable-channel Enable tracing channel\n");
112 fprintf(ofp, " enable-event Enable tracing event\n");
113 fprintf(ofp, " disable-channel Disable tracing channel\n");
114 fprintf(ofp, " disable-event Disable tracing event\n");
00e2e675
DG
115 fprintf(ofp, " list List possible tracing options\n");
116 fprintf(ofp, " set-session Set current session name\n");
57f272ed 117 fprintf(ofp, " snapshot Snapshot buffers of current session name\n");
00e2e675
DG
118 fprintf(ofp, " start Start tracing\n");
119 fprintf(ofp, " stop Stop tracing\n");
120 fprintf(ofp, " version Show version information\n");
121 fprintf(ofp, " view Start trace viewer\n");
c864d6d7 122 fprintf(ofp, " save Save session configuration\n");
f3ed775e 123 fprintf(ofp, "\n");
99bab54f
TD
124 fprintf(ofp, "Each command also has its own -h, --help option.\n");
125 fprintf(ofp, "\n");
f3ed775e
DG
126 fprintf(ofp, "Please see the lttng(1) man page for full documentation.\n");
127 fprintf(ofp, "See http://lttng.org for updates, bug reports and news.\n");
8c0faa1d
DG
128}
129
70318c38
SS
130static void version(FILE *ofp)
131{
132 fprintf(ofp, "%s (LTTng Trace Control) " VERSION" - " VERSION_NAME"\n",
133 progname);
134}
135
865abf65
SM
136/*
137 * list_options
138 *
139 * List options line by line. This is mostly for bash auto completion and to
140 * avoid difficult parsing.
141 */
142static void list_options(FILE *ofp)
143{
144 int i = 0;
145 struct option *option = NULL;
146
147 option = &long_options[i];
148 while (option->name != NULL) {
149 fprintf(ofp, "--%s\n", option->name);
150
151 if (isprint(option->val)) {
152 fprintf(ofp, "-%c\n", option->val);
153 }
154
155 i++;
156 option = &long_options[i];
157 }
158}
159
7442b2ba 160/*
f3ed775e 161 * clean_exit
96243366 162 */
f3ed775e 163static void clean_exit(int code)
96243366 164{
f3ed775e
DG
165 DBG("Clean exit");
166 exit(code);
894be886 167}
96243366 168
894be886 169/*
f3ed775e 170 * sighandler
2ef84c95 171 *
f3ed775e 172 * Signal handler for the daemon
2ef84c95 173 */
f3ed775e 174static void sighandler(int sig)
2ef84c95 175{
8db8d1dc
DG
176 int status;
177
f3ed775e
DG
178 switch (sig) {
179 case SIGTERM:
99bab54f 180 DBG("SIGTERM caught");
f3ed775e
DG
181 clean_exit(EXIT_FAILURE);
182 break;
183 case SIGCHLD:
99bab54f 184 DBG("SIGCHLD caught");
8db8d1dc 185 waitpid(sessiond_pid, &status, 0);
5a532b68 186 recv_child_signal = 1;
8db8d1dc
DG
187 /* Indicate that the session daemon died */
188 sessiond_pid = 0;
189 ERR("Session daemon died (exit status %d)", WEXITSTATUS(status));
190 break;
191 case SIGUSR1:
192 /* Notify is done */
5a532b68 193 recv_child_signal = 1;
99bab54f 194 DBG("SIGUSR1 caught");
f3ed775e
DG
195 break;
196 default:
99bab54f 197 DBG("Unknown signal %d caught", sig);
f3ed775e 198 break;
2ef84c95
DG
199 }
200
f3ed775e 201 return;
2ef84c95
DG
202}
203
204/*
f3ed775e 205 * set_signal_handler
894be886 206 *
f3ed775e 207 * Setup signal handler for SIGCHLD and SIGTERM.
894be886 208 */
f3ed775e 209static int set_signal_handler(void)
894be886 210{
f3ed775e
DG
211 int ret = 0;
212 struct sigaction sa;
213 sigset_t sigset;
33a2b854 214
f3ed775e
DG
215 if ((ret = sigemptyset(&sigset)) < 0) {
216 perror("sigemptyset");
33a2b854
DG
217 goto end;
218 }
219
f3ed775e
DG
220 sa.sa_handler = sighandler;
221 sa.sa_mask = sigset;
222 sa.sa_flags = 0;
8db8d1dc 223 if ((ret = sigaction(SIGUSR1, &sa, NULL)) < 0) {
f3ed775e 224 perror("sigaction");
96243366
DG
225 goto end;
226 }
227
f3ed775e
DG
228 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
229 perror("sigaction");
230 goto end;
894be886
DG
231 }
232
8db8d1dc
DG
233 if ((ret = sigaction(SIGCHLD, &sa, NULL)) < 0) {
234 perror("sigaction");
235 goto end;
236 }
237
96243366 238end:
57167058
DG
239 return ret;
240}
241
fac6795d 242/*
f3ed775e 243 * handle_command
fac6795d 244 *
f3ed775e
DG
245 * Handle the full argv list of a first level command. Will find the command
246 * in the global commands array and call the function callback associated.
1c9f7941 247 *
f3ed775e
DG
248 * If command not found, return -1
249 * else, return function command error code.
1c9f7941 250 */
f3ed775e 251static int handle_command(int argc, char **argv)
1c9f7941 252{
f3ed775e
DG
253 int i = 0, ret;
254 struct cmd_struct *cmd;
1c9f7941 255
f3ed775e
DG
256 if (*argv == NULL) {
257 ret = CMD_SUCCESS;
47b74d63 258 goto end;
1c9f7941
DG
259 }
260
f3ed775e
DG
261 cmd = &commands[i];
262 while (cmd->func != NULL) {
263 /* Find command */
264 if (strcmp(argv[0], cmd->name) == 0) {
265 ret = cmd->func(argc, (const char**) argv);
f3ed775e 266 goto end;
894be886 267 }
f3ed775e
DG
268 i++;
269 cmd = &commands[i];
894be886
DG
270 }
271
f3ed775e 272 /* Command not found */
4ce78777 273 ret = CMD_UNDEFINED;
894be886
DG
274
275end:
f3ed775e 276 return ret;
8548ff30
DG
277}
278
5b8719f5
DG
279/*
280 * spawn_sessiond
281 *
282 * Spawn a session daemon by forking and execv.
283 */
284static int spawn_sessiond(char *pathname)
285{
286 int ret = 0;
287 pid_t pid;
288
f3ed775e 289 MSG("Spawning a session daemon");
5a532b68 290 recv_child_signal = 0;
5b8719f5
DG
291 pid = fork();
292 if (pid == 0) {
5e16da05
MD
293 /*
294 * Spawn session daemon and tell
5b8719f5
DG
295 * it to signal us when ready.
296 */
32258573 297 execlp(pathname, "lttng-sessiond", "--sig-parent", "--quiet", NULL);
5e16da05
MD
298 /* execlp only returns if error happened */
299 if (errno == ENOENT) {
300 ERR("No session daemon found. Use --sessiond-path.");
301 } else {
302 perror("execlp");
5b8719f5 303 }
5a532b68 304 kill(getppid(), SIGTERM); /* wake parent */
5e16da05 305 exit(EXIT_FAILURE);
5b8719f5 306 } else if (pid > 0) {
8db8d1dc 307 sessiond_pid = pid;
5a532b68 308 /*
af87c45a
DG
309 * Wait for lttng-sessiond to start. We need to use a flag to check if
310 * the signal has been sent to us, because the child can be scheduled
311 * before the parent, and thus send the signal before this check. In
312 * the signal handler, we set the recv_child_signal flag, so anytime we
313 * check it after the fork is fine. Note that sleep() is interrupted
314 * before the 1 second delay as soon as the signal is received, so it
315 * will not cause visible delay for the user.
5a532b68
MD
316 */
317 while (!recv_child_signal) {
318 sleep(1);
319 }
af87c45a
DG
320 /*
321 * The signal handler will nullify sessiond_pid on SIGCHLD
322 */
8db8d1dc
DG
323 if (!sessiond_pid) {
324 exit(EXIT_FAILURE);
325 }
5b8719f5
DG
326 goto end;
327 } else {
328 perror("fork");
329 ret = -1;
330 goto end;
331 }
332
333end:
334 return ret;
335}
336
fac6795d 337/*
f3ed775e 338 * check_sessiond
fac6795d
DG
339 *
340 * Check if the session daemon is available using
5b8719f5
DG
341 * the liblttngctl API for the check. If not, try to
342 * spawn a daemon.
fac6795d 343 */
f3ed775e 344static int check_sessiond(void)
fac6795d
DG
345{
346 int ret;
b8ec3da8 347 char *pathname = NULL;
fac6795d 348
947308c4
DG
349 ret = lttng_session_daemon_alive();
350 if (ret == 0) { /* not alive */
5b8719f5 351 /* Try command line option path */
b8ec3da8
SM
352 pathname = opt_sessiond_path;
353
354 /* Try LTTNG_SESSIOND_PATH env variable */
355 if (pathname == NULL) {
bbccc3d2 356 pathname = getenv(DEFAULT_SESSIOND_PATH_ENV);
5b8719f5
DG
357 }
358
b8ec3da8 359 /* Try with configured path */
5b8719f5 360 if (pathname == NULL) {
b8ec3da8
SM
361 if (CONFIG_SESSIOND_BIN[0] != '\0') {
362 pathname = CONFIG_SESSIOND_BIN;
5b8719f5 363 }
b8ec3da8
SM
364 }
365
366 /* Let's rock and roll while trying the default path */
367 if (pathname == NULL) {
368 pathname = INSTALL_BIN_PATH "/lttng-sessiond";
369 }
370
371 DBG("Session daemon at: %s", pathname);
372
373 /* Check existence and permissions */
374 ret = access(pathname, F_OK | X_OK);
375 if (ret < 0) {
376 ERR("No such file or access denied: %s", pathname);
377 goto end;
5b8719f5
DG
378 }
379
380 ret = spawn_sessiond(pathname);
5b8719f5 381 if (ret < 0) {
3183dbb0 382 ERR("Problem occurred when starting %s", pathname);
5b8719f5 383 }
c2a79a67 384 }
5b8719f5 385end:
fac6795d
DG
386 return ret;
387}
388
bcfa8a05 389/*
679b4943
SM
390 * Check args for specific options that *must* not trigger a session daemon
391 * execution.
392 *
393 * Return 1 if match else 0.
bcfa8a05 394 */
679b4943 395static int check_args_no_sessiond(int argc, char **argv)
bcfa8a05
DG
396{
397 int i;
398
399 for (i = 0; i < argc; i++) {
ba2926ef
MD
400 if ((strncmp(argv[i], "-h", sizeof("-h")) == 0) ||
401 strncmp(argv[i], "--h", sizeof("--h")) == 0 ||
3183dbb0 402 strncmp(argv[i], "--list-options", sizeof("--list-options")) == 0 ||
4747a49b 403 strncmp(argv[i], "--list-commands", sizeof("--list-commands")) == 0 ||
0c95f5b2
DG
404 strncmp(argv[i], "version", sizeof("version")) == 0 ||
405 strncmp(argv[i], "view", sizeof("view")) == 0) {
bcfa8a05
DG
406 return 1;
407 }
408 }
409
410 return 0;
411}
412
5b8719f5 413/*
3183dbb0 414 * Parse command line arguments.
5b8719f5 415 *
3183dbb0 416 * Return 0 if OK, else -1
5b8719f5 417 */
f3ed775e 418static int parse_args(int argc, char **argv)
5b8719f5 419{
f3ed775e 420 int opt, ret;
5b8719f5 421
f3ed775e
DG
422 if (argc < 2) {
423 usage(stderr);
424 clean_exit(EXIT_FAILURE);
5b8719f5
DG
425 }
426
70318c38 427 while ((opt = getopt_long(argc, argv, "+Vhnvqg:", long_options, NULL)) != -1) {
f3ed775e 428 switch (opt) {
70318c38
SS
429 case 'V':
430 version(stdout);
431 ret = 0;
432 goto end;
f3ed775e 433 case 'h':
3183dbb0 434 usage(stdout);
ae856491 435 ret = 0;
3183dbb0 436 goto end;
f3ed775e 437 case 'v':
97e19046 438 lttng_opt_verbose += 1;
f3ed775e
DG
439 break;
440 case 'q':
97e19046 441 lttng_opt_quiet = 1;
f3ed775e
DG
442 break;
443 case 'g':
444 lttng_set_tracing_group(optarg);
445 break;
8490ae7b 446 case 'n':
f3ed775e
DG
447 opt_no_sessiond = 1;
448 break;
449 case OPT_SESSION_PATH:
450 opt_sessiond_path = strdup(optarg);
451 break;
8960e9cd
DG
452 case OPT_RELAYD_PATH:
453 opt_relayd_path = strdup(optarg);
454 break;
865abf65
SM
455 case OPT_DUMP_OPTIONS:
456 list_options(stdout);
457 ret = 0;
3183dbb0 458 goto end;
865abf65 459 case OPT_DUMP_COMMANDS:
3c9bd23c 460 list_commands(commands, stdout);
865abf65 461 ret = 0;
3183dbb0 462 goto end;
f3ed775e
DG
463 default:
464 usage(stderr);
ae856491 465 ret = 1;
f3ed775e
DG
466 goto error;
467 }
5b8719f5 468 }
fac6795d 469
f3ed775e 470 /* If both options are specified, quiet wins */
97e19046
DG
471 if (lttng_opt_verbose && lttng_opt_quiet) {
472 lttng_opt_verbose = 0;
5b8719f5
DG
473 }
474
f3ed775e 475 /* Spawn session daemon if needed */
679b4943 476 if (opt_no_sessiond == 0 && check_args_no_sessiond(argc, argv) == 0 &&
bcfa8a05 477 (check_sessiond() < 0)) {
8005f29a 478 ret = 1;
f3ed775e 479 goto error;
5b8719f5
DG
480 }
481
f3ed775e
DG
482 /* No leftovers, print usage and quit */
483 if ((argc - optind) == 0) {
484 usage(stderr);
8005f29a 485 ret = 1;
f3ed775e
DG
486 goto error;
487 }
7442b2ba 488
f3ed775e
DG
489 /*
490 * Handle leftovers which is a first level command with the trailing
491 * options.
492 */
493 ret = handle_command(argc - optind, argv + optind);
ae856491
DG
494 switch (ret) {
495 case CMD_WARNING:
496 WARN("Some command(s) went wrong");
497 break;
498 case CMD_ERROR:
499 ERR("Command error");
500 break;
501 case CMD_UNDEFINED:
502 ERR("Undefined command");
503 break;
504 case CMD_FATAL:
505 ERR("Fatal error");
506 break;
4ce78777
DG
507 case CMD_UNSUPPORTED:
508 ERR("Unsupported command");
509 break;
ae856491
DG
510 case -1:
511 usage(stderr);
512 ret = 1;
513 break;
514 case 0:
515 break;
516 default:
42224349
DG
517 if (ret < 0) {
518 ret = -ret;
519 }
ae856491 520 break;
96243366
DG
521 }
522
3183dbb0 523end:
f3ed775e 524error:
ae856491 525 return ret;
fac6795d
DG
526}
527
f3ed775e 528
fac6795d 529/*
5b8719f5 530 * main
fac6795d
DG
531 */
532int main(int argc, char *argv[])
533{
534 int ret;
cbbb813a 535 char *user;
fac6795d
DG
536
537 progname = argv[0] ? argv[0] : "lttng";
538
99bab54f 539 /* For Mathieu Desnoyers a.k.a. Dr. Tracing */
cbbb813a
DG
540 user = getenv("USER");
541 if (user != NULL && ((strncmp(progname, "drtrace", 7) == 0 ||
542 strncmp("compudj", user, 7) == 0))) {
4666e71c 543 MSG("%c[%d;%dmWelcome back Dr Tracing!%c[%dm\n", 27,1,33,27,0);
fac6795d 544 }
cbbb813a 545 /* Thanks Mathieu */
fac6795d 546
5b8719f5
DG
547 ret = set_signal_handler();
548 if (ret < 0) {
87378cf5 549 clean_exit(ret);
5b8719f5
DG
550 }
551
f3ed775e 552 ret = parse_args(argc, argv);
ae856491
DG
553 if (ret != 0) {
554 clean_exit(ret);
1fff1faa 555 }
87378cf5 556
fac6795d
DG
557 return 0;
558}
This page took 0.108748 seconds and 4 git commands to generate.