*/
#define _GNU_SOURCE
-#include <errno.h>
-#include <fcntl.h>
#include <getopt.h>
-#include <grp.h>
-#include <limits.h>
+#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <sys/stat.h>
-#include <sys/types.h>
-#include <sys/wait.h>
#include <unistd.h>
#include <lttng/lttng.h>
-#include "lttng.h"
+#include "cmd.h"
+#include "conf.h"
#include "lttngerr.h"
/* Variables */
static char *progname;
-static char *session_name;
-static uuid_t current_uuid;
-static int auto_session;
-static int auto_trace;
-
-/* Prototypes */
-static int process_client_opt(void);
-static int process_opt_list_apps(void);
-static int process_opt_list_sessions(void);
-static int process_opt_list_traces(void);
-static int process_opt_create_session(void);
-static int process_kernel_create_trace(void);
-static int process_opt_kernel_event(void);
-static int set_session_uuid(void);
-static void sighandler(int sig);
-static int set_signal_handler(void);
-static int validate_options(void);
-static char *get_cmdline_by_pid(pid_t pid);
-static void set_opt_session_info(void);
-/*
- * start_client
- *
- * Process client request from the command line
- * options. Every tracing action is done by the
- * liblttngctl API.
- */
-static int process_client_opt(void)
+int opt_quiet;
+int opt_verbose;
+static int opt_no_sessiond;
+static char *opt_sessiond_path;
+
+enum {
+ OPT_NO_SESSIOND,
+ OPT_SESSION_PATH,
+};
+
+/* Getopt options. No first level command. */
+static struct option long_options[] = {
+ {"help", 0, NULL, 'h'},
+ {"group", 1, NULL, 'g'},
+ {"verbose", 0, NULL, 'v'},
+ {"quiet", 0, NULL, 'q'},
+ {"no-sessiond", 0, NULL, OPT_NO_SESSIOND},
+ {"sessiond-path", 1, NULL, OPT_SESSION_PATH},
+ {NULL, 0, NULL, 0}
+};
+
+/* First level command */
+static struct cmd_struct commands[] = {
+ { "list", cmd_list},
+ { "create", cmd_create},
+ { "destroy", cmd_destroy},
+ { "add-channel", cmd_add_channel},
+ { "start", cmd_start},
+ { "stop", cmd_stop},
+ { "enable-event", cmd_enable_events},
+ { "disable-event", cmd_disable_events},
+ { NULL, NULL} /* Array closure */
+};
+
+static void usage(FILE *ofp)
{
- int ret;
-
- set_opt_session_info();
-
- if (opt_list_apps) {
- ret = process_opt_list_apps();
- if (ret < 0) {
- goto end;
- }
- goto error;
- }
-
- if (opt_list_session) {
- ret = process_opt_list_sessions();
- if (ret < 0) {
- goto end;
- }
- goto error;
- }
-
- /* Session creation or auto session set on */
- if (auto_session || opt_create_session) {
- DBG("Creating a new session");
- ret = process_opt_create_session();
- if (ret < 0) {
- goto end;
- }
- }
-
- ret = set_session_uuid();
- if (ret < 0) {
- ERR("Session %s not found", opt_session_name);
- goto error;
- }
-
- if (opt_destroy_session) {
- ret = lttng_destroy_session(¤t_uuid);
- if (ret < 0) {
- goto end;
- }
- MSG("Session %s destroyed.", opt_session_name);
- }
-
- if (opt_list_traces) {
- ret = process_opt_list_traces();
- if (ret < 0) {
- goto end;
- }
- }
-
- /*
- * Action on traces (kernel or/and userspace).
- */
-
- if (opt_trace_kernel) {
- if (auto_trace || opt_create_trace) {
- DBG("Creating a kernel trace");
- ret = process_kernel_create_trace();
- if (ret < 0) {
- goto end;
- }
- }
-
- if (opt_event_list != NULL) {
- ret = process_opt_kernel_event();
- } else {
- // Enable all events
- }
-
- goto error;
- }
-
- if (opt_trace_pid != 0) {
- if (auto_trace || opt_create_trace) {
- DBG("Create a userspace trace for pid %d", opt_trace_pid);
- ret = lttng_ust_create_trace(opt_trace_pid);
- if (ret < 0) {
- goto end;
- }
- MSG("Trace created successfully!");
- }
-
- if (auto_trace || opt_start_trace) {
- DBG("Start trace for pid %d", opt_trace_pid);
- ret = lttng_ust_start_trace(opt_trace_pid);
- if (ret < 0) {
- goto end;
- }
- MSG("Trace started successfully!");
- } else if (opt_stop_trace) {
- DBG("Stop trace for pid %d", opt_trace_pid);
- ret = lttng_ust_stop_trace(opt_trace_pid);
- if (ret < 0) {
- goto end;
- }
- MSG("Trace stopped successfully!");
- }
-
- }
-
- return 0;
-
-end:
- ERR("%s", lttng_get_readable_code(ret));
-error: /* fall through */
- return ret;
+ fprintf(ofp, "LTTng Trace Control " VERSION"\n\n");
+ fprintf(ofp, "usage: lttng [options] <command>\n");
+ fprintf(ofp, "\n");
+ fprintf(ofp, "Options:\n");
+ fprintf(ofp, " -h, --help Show this help\n");
+ fprintf(ofp, " -g, --group NAME Unix tracing group name. (default: tracing)\n");
+ fprintf(ofp, " -v, --verbose Verbose mode\n");
+ fprintf(ofp, " -q, --quiet Quiet mode\n");
+ fprintf(ofp, " --no-sessiond Don't spawn a session daemon\n");
+ fprintf(ofp, " --sessiond-path Session daemon full path\n");
+ fprintf(ofp, "\n");
+ fprintf(ofp, "Commands:\n");
+ fprintf(ofp, " add-channel Add channel to tracer\n");
+ fprintf(ofp, " create Create tracing session\n");
+ fprintf(ofp, " destroy Teardown tracing session\n");
+ fprintf(ofp, " enable-event Enable tracing event\n");
+ fprintf(ofp, " disable-event Disable tracing event\n");
+ fprintf(ofp, " list List possible tracing options\n");
+ fprintf(ofp, " start Start tracing\n");
+ fprintf(ofp, " stop Stop tracing\n");
+ fprintf(ofp, " version Show version information\n");
+ fprintf(ofp, "\n");
+ fprintf(ofp, "Please see the lttng(1) man page for full documentation.\n");
+ fprintf(ofp, "See http://lttng.org for updates, bug reports and news.\n");
}
/*
- * process_kernel_create_trace
- *
- * Create a kernel trace.
- */
-static int process_kernel_create_trace(void)
-{
- int ret;
-
- /* Setup kernel session */
- ret = lttng_kernel_create_session();
- if (ret < 0) {
- goto error;
- }
-
- /* Create an empty channel (with no event) */
- ret = lttng_kernel_create_channel();
- if (ret < 0) {
- goto error;
- }
-
- return 0;
-
-error:
- return ret;
-}
-
-/*
- * process_kernel_event
- *
- * Enable kernel event from the command line list given.
- */
-static int process_opt_kernel_event(void)
-{
- int ret;
- char *event_name;
-
- event_name = strtok(opt_event_list, ",");
- while (event_name != NULL) {
- DBG("Enabling kernel event %s", event_name);
- ret = lttng_kernel_enable_event(event_name);
- if (ret < 0) {
- ERR("%s %s", lttng_get_readable_code(ret), event_name);
- } else {
- MSG("Kernel event %s enabled.", event_name);
- }
- /* Next event */
- event_name = strtok(NULL, ",");
- }
-
- return 0;
-}
-
-/*
- * set_opt_session_info
- *
- * Setup session_name, current_uuid, short_str_uuid and
- * long_str_uuid using the command line options.
+ * clean_exit
*/
-static void set_opt_session_info(void)
+static void clean_exit(int code)
{
- if (opt_session_name != NULL) {
- session_name = strndup(opt_session_name, NAME_MAX);
- DBG("Session name set to %s", session_name);
- }
+ DBG("Clean exit");
+ exit(code);
}
/*
- * set_session_uuid
+ * sighandler
*
- * Set current session uuid to the current flow of command(s) using the
- * session_name.
+ * Signal handler for the daemon
*/
-static int set_session_uuid(void)
+static void sighandler(int sig)
{
- int ret, count, i, found = 0;
- struct lttng_session *sessions;
-
- if (!uuid_is_null(current_uuid)) {
- lttng_set_current_session_uuid(¤t_uuid);
- goto end;
- }
-
- count = lttng_list_sessions(&sessions);
- if (count < 0) {
- ret = count;
- goto error;
- }
-
- for (i = 0; i < count; i++) {
- if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
- lttng_set_current_session_uuid(&sessions[i].uuid);
- uuid_copy(current_uuid, sessions[i].uuid);
- found = 1;
+ switch (sig) {
+ case SIGTERM:
+ DBG("SIGTERM catched");
+ clean_exit(EXIT_FAILURE);
break;
- }
- }
-
- free(sessions);
-
- if (!found) {
- return -1;
- }
-
-end:
- DBG("Session UUID set");
- return 0;
-
-error:
- return ret;
-}
-
-/*
- * process_opt_list_traces
- *
- * Get list of all traces for a specific session uuid.
- */
-static int process_opt_list_traces(void)
-{
- int ret, i;
- struct lttng_trace *traces;
-
- ret = lttng_list_traces(¤t_uuid, &traces);
- DBG("Number of traces to list %d", ret);
- if (ret < 0) {
- goto error;
- }
-
- /* No traces */
- if (ret == 0) {
- MSG("No traces found.");
- goto error;
- }
-
- MSG("Userspace traces:");
- for (i = 0; i < ret; i++) {
- if (traces[i].type == USERSPACE) {
- MSG("\t%d) %s (pid: %d): %s",
- i, traces[i].name, traces[i].pid,
- get_cmdline_by_pid(traces[i].pid));
- } else {
+ case SIGCHLD:
+ /* Notify is done */
+ DBG("SIGCHLD catched");
+ break;
+ default:
+ DBG("Unknown signal %d catched", sig);
break;
- }
- }
-
- MSG("Kernel traces:");
- for (;i < ret; i++) {
- if (traces[i].type == KERNEL) {
- MSG("\t%d) %s", i, traces[i].name);
- }
- }
-
- free(traces);
-
-error:
- return ret;
-}
-
-/*
- * process_opt_create_session
- *
- * Create a new session using the name pass
- * to the command line.
- */
-static int process_opt_create_session(void)
-{
- int ret;
- char name[NAME_MAX];
- time_t rawtime;
- struct tm *timeinfo;
-
- /* Auto session name creation */
- if (opt_session_name == NULL) {
- time(&rawtime);
- timeinfo = localtime(&rawtime);
- strftime(name, sizeof(name), "auto-%Y%m%d-%H%M%S", timeinfo);
- session_name = strndup(name, sizeof(name));
- DBG("Auto session name set to %s", session_name);
- }
-
- ret = lttng_create_session(session_name);
- if (ret < 0) {
- goto error;
}
- MSG("Session created: %s", session_name);
-
-error:
- return ret;
+ return;
}
/*
- * process_opt_list_sessions
+ * set_signal_handler
*
- * Get the list of available sessions from
- * the session daemon and print it to user.
+ * Setup signal handler for SIGCHLD and SIGTERM.
*/
-static int process_opt_list_sessions(void)
+static int set_signal_handler(void)
{
- int ret, count, i;
- struct lttng_session *sessions;
-
- count = lttng_list_sessions(&sessions);
- DBG("Session count %d", count);
- if (count < 0) {
- ret = count;
- goto error;
- }
+ int ret = 0;
+ struct sigaction sa;
+ sigset_t sigset;
- MSG("Available sessions (UUIDs):");
- for (i = 0; i < count; i++) {
- MSG(" %d) %s", i+1, sessions[i].name);
+ if ((ret = sigemptyset(&sigset)) < 0) {
+ perror("sigemptyset");
+ goto end;
}
- free(sessions);
- MSG("\nTo select a session, use -s, --session UUID.");
-
- return 0;
-
-error:
- return ret;
-}
-
-/*
- * process_opt_list_apps
- *
- * Get the UST traceable pid list and print
- * them to the user.
- */
-static int process_opt_list_apps(void)
-{
- int i, ret, count;
- pid_t *pids;
- char *cmdline;
-
- count = lttng_ust_list_apps(&pids);
- if (count < 0) {
- ret = count;
- goto error;
+ sa.sa_handler = sighandler;
+ sa.sa_mask = sigset;
+ sa.sa_flags = 0;
+ if ((ret = sigaction(SIGCHLD, &sa, NULL)) < 0) {
+ perror("sigaction");
+ goto end;
}
- MSG("LTTng UST traceable application [name (pid)]:");
- for (i=0; i < count; i++) {
- cmdline = get_cmdline_by_pid(pids[i]);
- if (cmdline == NULL) {
- MSG("\t(not running) (%d)", pids[i]);
- continue;
- }
- MSG("\t%s (%d)", cmdline, pids[i]);
- free(cmdline);
+ if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
+ perror("sigaction");
+ goto end;
}
- /* Allocated by lttng_ust_list_apps() */
- free(pids);
-
- return 0;
-
-error:
+end:
return ret;
}
/*
- * get_cmdline_by_pid
+ * handle_command
*
- * Get command line from /proc for a specific pid.
+ * Handle the full argv list of a first level command. Will find the command
+ * in the global commands array and call the function callback associated.
*
- * On success, return an allocated string pointer pointing to
- * the proc cmdline.
- * On error, return NULL.
+ * If command not found, return -1
+ * else, return function command error code.
*/
-static char *get_cmdline_by_pid(pid_t pid)
+static int handle_command(int argc, char **argv)
{
- int ret;
- FILE *fp;
- char *cmdline = NULL;
- char path[24]; /* Can't go bigger than /proc/65535/cmdline */
+ int i = 0, ret;
+ struct cmd_struct *cmd;
- snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
- fp = fopen(path, "r");
- if (fp == NULL) {
+ if (*argv == NULL) {
+ ret = CMD_SUCCESS;
goto end;
}
- /* Caller must free() *cmdline */
- cmdline = malloc(PATH_MAX);
- ret = fread(cmdline, 1, PATH_MAX, fp);
- fclose(fp);
-
-end:
- return cmdline;
-}
-
-/*
- * validate_options
- *
- * Make sure that all options passed to the command line are compatible with
- * each others.
- *
- * On error, return -1
- * On success, return 0
- */
-static int validate_options(void)
-{
- /* If listing options, jump validation */
- if (opt_list_apps || opt_list_session) {
- goto end;
- }
- /* Conflicting command */
- if (opt_start_trace && opt_stop_trace) {
- ERR("Can't use --start and --stop together.");
- goto error;
- /* If no PID specified and trace_kernel is off */
- } else if ((opt_trace_pid == 0 && !opt_trace_kernel) &&
- (opt_create_trace || opt_start_trace || opt_stop_trace || opt_destroy_trace)) {
- ERR("Please specify for which tracer (-k or -p PID).");
- goto error;
- /* List traces, we need a session name */
- } else if (opt_list_traces && opt_session_name == NULL) {
- ERR("Can't use -t without -s, --session option.");
- goto error;
- /* Can't set event for both kernel and userspace at the same time */
- } else if (opt_event_list != NULL && (opt_trace_kernel && opt_trace_pid)) {
- ERR("Please don't use --event for both kernel and userspace.\nOne at a time to enable events.");
- goto error;
- /* Don't need a trace name for kernel tracig */
- } else if (opt_trace_name != NULL && opt_trace_kernel) {
- ERR("For action on a kernel trace, please don't specify a trace name.");
- goto error;
- } else if (opt_destroy_trace && opt_session_name == NULL) {
- ERR("Please specify a session in order to destroy a trace");
- goto error;
- } else if (opt_create_trace || opt_destroy_trace) {
- /* Both kernel and user-space are denied for these options */
- if (opt_trace_pid != 0 && opt_trace_kernel) {
- ERR("Kernel and user-space trace creation and destruction can't be used together.");
- goto error;
- /* Need a trace name for user-space tracing */
- } else if (opt_trace_name == NULL && opt_trace_pid != 0) {
- ERR("Please specify a trace name for user-space tracing");
- goto error;
+ cmd = &commands[i];
+ while (cmd->func != NULL) {
+ /* Find command */
+ if (strcmp(argv[0], cmd->name) == 0) {
+ ret = cmd->func(argc, (const char**) argv);
+ switch (ret) {
+ case CMD_ERROR:
+ ERR("Command error");
+ break;
+ case CMD_NOT_IMPLEMENTED:
+ ERR("Options not implemented");
+ break;
+ case CMD_UNDEFINED:
+ ERR("Undefined command");
+ break;
+ case CMD_FATAL:
+ ERR("Fatal error");
+ break;
+ }
+ goto end;
}
- } else if (opt_stop_trace && opt_trace_pid != 0 && opt_trace_name == NULL) {
- ERR("Please specify a trace name for user-space tracing");
- goto error;
+ i++;
+ cmd = &commands[i];
}
- /* If start trace, auto start tracing */
- if (opt_start_trace) {
- DBG("Requesting auto tracing");
- auto_trace = 1;
- }
-
- /* If no session, auto create one */
- if (opt_session_name == NULL) {
- DBG("Requesting an auto session creation");
- auto_session = 1;
- }
+ /* Command not found */
+ ret = -1;
end:
- return 0;
-
-error:
- return -1;
+ return ret;
}
/*
int ret = 0;
pid_t pid;
- MSG("Spawning session daemon");
+ MSG("Spawning a session daemon");
pid = fork();
if (pid == 0) {
/*
}
/*
- * check_ltt_sessiond
+ * check_sessiond
*
* Check if the session daemon is available using
* the liblttngctl API for the check. If not, try to
* spawn a daemon.
*/
-static int check_ltt_sessiond(void)
+static int check_sessiond(void)
{
int ret;
char *pathname = NULL, *alloc_pathname = NULL;
- ret = lttng_check_session_daemon();
- if (ret < 0) {
+ ret = lttng_session_daemon_alive();
+ if (ret == 0) { /* not alive */
/* Try command line option path */
if (opt_sessiond_path != NULL) {
ret = access(opt_sessiond_path, F_OK | X_OK);
}
/*
- * set_signal_handler
+ * parse_args
*
- * Setup signal handler for SIGCHLD and SIGTERM.
+ * Parse command line arguments.
+ * Return 0 if OK, else -1
*/
-static int set_signal_handler(void)
+static int parse_args(int argc, char **argv)
{
- int ret = 0;
- struct sigaction sa;
- sigset_t sigset;
+ int opt, ret;
- if ((ret = sigemptyset(&sigset)) < 0) {
- perror("sigemptyset");
- goto end;
+ if (argc < 2) {
+ usage(stderr);
+ clean_exit(EXIT_FAILURE);
}
- sa.sa_handler = sighandler;
- sa.sa_mask = sigset;
- sa.sa_flags = 0;
- if ((ret = sigaction(SIGCHLD, &sa, NULL)) < 0) {
- perror("sigaction");
- goto end;
+ while ((opt = getopt_long(argc, argv, "+hvqg:", long_options, NULL)) != -1) {
+ switch (opt) {
+ case 'h':
+ usage(stderr);
+ goto error;
+ case 'v':
+ opt_verbose = 1;
+ break;
+ case 'q':
+ opt_quiet = 1;
+ break;
+ case 'g':
+ lttng_set_tracing_group(optarg);
+ break;
+ case OPT_NO_SESSIOND:
+ opt_no_sessiond = 1;
+ break;
+ case OPT_SESSION_PATH:
+ opt_sessiond_path = strdup(optarg);
+ break;
+ default:
+ usage(stderr);
+ goto error;
+ }
}
- if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
- perror("sigaction");
- goto end;
+ /* If both options are specified, quiet wins */
+ if (opt_verbose && opt_quiet) {
+ opt_verbose = 0;
}
-end:
- return ret;
-}
-
-/*
- * sighandler
- *
- * Signal handler for the daemon
- */
-static void sighandler(int sig)
-{
- switch (sig) {
- case SIGTERM:
- DBG("SIGTERM catched");
- clean_exit(EXIT_FAILURE);
- break;
- case SIGCHLD:
- /* Notify is done */
- DBG("SIGCHLD catched");
- break;
- default:
- DBG("Unknown signal %d catched", sig);
- break;
+ /* Spawn session daemon if needed */
+ if (opt_no_sessiond == 0 && (check_sessiond() < 0)) {
+ goto error;
}
- return;
-}
+ /* No leftovers, print usage and quit */
+ if ((argc - optind) == 0) {
+ usage(stderr);
+ goto error;
+ }
-/*
- * clean_exit
- */
-void clean_exit(int code)
-{
- DBG("Clean exit");
- if (session_name) {
- free(session_name);
+ /*
+ * Handle leftovers which is a first level command with the trailing
+ * options.
+ */
+ ret = handle_command(argc - optind, argv + optind);
+ if (ret < 0) {
+ if (ret == -1) {
+ usage(stderr);
+ goto error;
+ } else {
+ ERR("%s", lttng_get_readable_code(ret));
+ }
}
- exit(code);
+ return ret;
+
+error:
+ return -1;
}
+
/*
* main
*/
MSG("%c[%d;%dmWelcome back Dr Tracing!%c[%dm\n\n", 27,1,33,27,0);
}
- ret = parse_args(argc, (const char **) argv);
- if (ret < 0) {
- clean_exit(EXIT_FAILURE);
- }
-
- ret = validate_options();
- if (ret < 0) {
- return EXIT_FAILURE;
- }
-
ret = set_signal_handler();
if (ret < 0) {
clean_exit(ret);
}
- if (opt_tracing_group != NULL) {
- DBG("Set tracing group to '%s'", opt_tracing_group);
- lttng_set_tracing_group(opt_tracing_group);
- }
-
- /* If ask for kernel tracing, need root perms */
- if (opt_trace_kernel) {
- DBG("Kernel tracing activated");
- if (getuid() != 0) {
- ERR("%s must be setuid root", progname);
- clean_exit(-EPERM);
- }
- }
-
- /* Check if the lttng session daemon is running.
- * If no, a daemon will be spawned.
- */
- if (opt_no_sessiond == 0 && (check_ltt_sessiond() < 0)) {
- clean_exit(EXIT_FAILURE);
- }
-
- ret = process_client_opt();
- if (ret < 0) {
- clean_exit(ret);
- }
-
- clean_exit(0);
+ ret = parse_args(argc, argv);
+ clean_exit(ret);
return 0;
}
projects / lttng-tools.git / blobdiff