/* Copyright (C) 2009 Pierre-Marc Fournier
+ * Copyright (C) 2011 Ericsson AB, Nils Carlson <nils.carlson@ericsson.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
#include <stdlib.h>
#include <fcntl.h>
-#include "ustcomm.h"
-#include "ustcmd.h"
+#include "ust/ustctl.h"
#include "usterr.h"
+#include "cli.h"
+#include "scanning_functions.h"
+void usage(const char *process_name)
+{
+ fprintf(stderr, "Usage: %s COMMAND [ARGS]...\n", process_name);
+ fprintf(stderr,
+ "Control tracing within a process that supports UST,\n"
+ " the Userspace Tracing libary\n"
+ "Options:\n"
+ " -h[<cmd>], --help[=<cmd>] "
+ "help, for a command if provided\n"
+ " -l, --list "
+ "short list of commands\n"
+ " -e, --extended-list "
+ "extented list of commands with help\n"
+ "Commands:\n");
+ list_cli_cmds(CLI_DESCRIPTIVE_LIST);
+}
+
+/*
+ * Provide backward compatibility for scripts that make use of the
+ * --commands in ustctl version <= 0.11
+ */
enum command {
CREATE_TRACE=1000,
ALLOC_TRACE,
STOP_TRACE,
DESTROY_TRACE,
LIST_MARKERS,
+ LIST_TRACE_EVENTS,
ENABLE_MARKER,
DISABLE_MARKER,
- GET_ONLINE_PIDS,
- SET_SUBBUF_SIZE,
- SET_SUBBUF_NUM,
- GET_SUBBUF_SIZE,
- GET_SUBBUF_NUM,
- GET_SOCK_PATH,
- SET_SOCK_PATH,
- UNKNOWN
-};
-
-struct ust_opts {
- enum command cmd;
- pid_t *pids;
- char *regex;
};
-char *progname = NULL;
-
-void usage(void)
+struct option options[] =
{
- fprintf(stderr, "usage: %s COMMAND PIDs...\n", progname);
- fprintf(stderr, "\nControl the tracing of a process that supports LTTng Userspace Tracing.\n\
-\n\
-Commands:\n\
- --create-trace\t\t\tCreate trace\n\
- --alloc-trace\t\t\tAlloc trace\n\
- --start-trace\t\t\tStart tracing\n\
- --stop-trace\t\t\tStop tracing\n\
- --destroy-trace\t\t\tDestroy the trace\n\
- --set-subbuf-size \"CHANNEL/bytes\"\tSet the size of subbuffers per channel\n\
- --set-subbuf-num \"CHANNEL/n\"\tSet the number of subbuffers per channel\n\
- --set-sock-path\t\t\tSet the path of the daemon socket\n\
- --get-subbuf-size \"CHANNEL\"\t\tGet the size of subbuffers per channel\n\
- --get-subbuf-num \"CHANNEL\"\t\tGet the number of subbuffers per channel\n\
- --get-sock-path\t\t\tGet the path of the daemon socket\n\
- --enable-marker \"CHANNEL/MARKER\"\tEnable a marker\n\
- --disable-marker \"CHANNEL/MARKER\"\tDisable a marker\n\
- --list-markers\t\t\tList the markers of the process, their\n\t\t\t\t\t state and format string\n\
-\
-");
-}
+ { "create-trace", 0, 0, CREATE_TRACE },
+ { "alloc-trace", 0, 0, ALLOC_TRACE },
+ { "start-trace", 0, 0, START_TRACE },
+ { "stop-trace", 0, 0, STOP_TRACE },
+ { "destroy-trace", 0, 0, DESTROY_TRACE },
+ { "list-markers", 0, 0, LIST_MARKERS },
+ { "list-trace-events", 0, 0, LIST_TRACE_EVENTS},
+ { "enable-marker", 0, 0, ENABLE_MARKER },
+ { "disable-marker", 0, 0, DISABLE_MARKER },
+ {"help", 2, NULL, 'h'},
+ {"list", 0, NULL, 'l'},
+ {"extended-list", 0, NULL, 'e'},
+ {NULL, 0, NULL, 0},
+};
-int parse_opts_long(int argc, char **argv, struct ust_opts *opts)
+int main(int argc, char *argv[])
{
- int c;
-
- opts->pids = NULL;
- opts->regex = NULL;
+ struct cli_cmd *cli_cmd;
+ char **args = argv;
+ int opt;
+ int i;
- while (1) {
- int option_index = 0;
- static struct option long_options[] = {
- { "create-trace", 0, 0, CREATE_TRACE },
- { "alloc-trace", 0, 0, ALLOC_TRACE },
- { "start-trace", 0, 0, START_TRACE },
- { "stop-trace", 0, 0, STOP_TRACE },
- { "destroy-trace", 0, 0, DESTROY_TRACE },
- { "list-markers", 0, 0, LIST_MARKERS },
- { "enable-marker", 1, 0, ENABLE_MARKER },
- { "disable-marker", 1, 0, DISABLE_MARKER },
- { "help", 0, 0, 'h' },
- { "online-pids", 0, 0, GET_ONLINE_PIDS },
- { "set-subbuf-size", 1, 0, SET_SUBBUF_SIZE },
- { "set-subbuf-num", 1, 0, SET_SUBBUF_NUM },
- { "get-subbuf-size", 1, 0, GET_SUBBUF_SIZE },
- { "get-subbuf-num", 1, 0, GET_SUBBUF_NUM },
- { "get-sock-path", 0, 0, GET_SOCK_PATH },
- { "set-sock-path", 1, 0, SET_SOCK_PATH },
- { 0, 0, 0, 0 }
- };
+ if(argc <= 1) {
+ fprintf(stderr, "No operation specified.\n");
+ usage(argv[0]);
+ exit(EXIT_FAILURE);
+ }
- c = getopt_long(argc, argv, "h", long_options, &option_index);
- if (c == -1)
+ while ((opt = getopt_long(argc, argv, "+h::le",
+ options, NULL)) != -1) {
+ switch (opt) {
+ case 'h':
+ if (!optarg) {
+ usage(argv[0]);
+ } else {
+ if (cli_print_help(optarg)) {
+ fprintf(stderr, "No such command %s\n",
+ optarg);
+ }
+ }
+ exit(EXIT_FAILURE);
break;
-
- if(c >= 1000)
- opts->cmd = c;
-
- switch (c) {
- case 0:
- printf("option %s", long_options[option_index].name);
- if (optarg)
- printf(" with arg %s", optarg);
- printf("\n");
+ case 'l':
+ list_cli_cmds(CLI_SIMPLE_LIST);
+ exit(EXIT_FAILURE);
break;
-
+ case 'e':
+ list_cli_cmds(CLI_EXTENDED_LIST);
+ exit(EXIT_FAILURE);
+ case LIST_MARKERS:
+ case LIST_TRACE_EVENTS:
+ case CREATE_TRACE:
+ case ALLOC_TRACE:
+ case START_TRACE:
+ case STOP_TRACE:
+ case DESTROY_TRACE:
case ENABLE_MARKER:
case DISABLE_MARKER:
- case SET_SUBBUF_SIZE:
- case SET_SUBBUF_NUM:
- case GET_SUBBUF_SIZE:
- case GET_SUBBUF_NUM:
- case SET_SOCK_PATH:
- opts->regex = strdup(optarg);
+ args = (char **)malloc(sizeof(char *) * (argc + 3));
+ optind--;
+ args[optind] = strdup(&argv[optind][2]);
+ for (i = optind + 1; i < argc; i++) {
+ args[i] = argv[i];
+ }
+ if (opt >= CREATE_TRACE && opt <= DESTROY_TRACE) {
+ args[argc] = strdup("auto");
+ argc++;
+ }
+ if (opt >= ENABLE_MARKER && opt <= DISABLE_MARKER) {
+ args[argc] = args[argc - 2];
+ args[argc - 2] = args[argc - 1];
+ args[argc - 1] = strdup("auto");
+ argc++;
+ }
+ args[argc] = NULL;
+ goto do_cli;
+ default:
+ fprintf(stderr, "Unknown option\n");
break;
-
- case 'h':
- usage();
- exit(0);
-
- case '?':
- fprintf(stderr, "Invalid argument\n\n");
- usage();
- exit(1);
}
}
- if (argc - optind > 0 && opts->cmd != GET_ONLINE_PIDS) {
- int i;
- int pididx=0;
- opts->pids = malloc((argc-optind+1) * sizeof(pid_t));
-
- for(i=optind; i<argc; i++) {
- /* don't take any chances, use a long long */
- long long tmp;
- char *endptr;
- tmp = strtoull(argv[i], &endptr, 10);
- if(*endptr != '\0') {
- ERR("The pid \"%s\" is invalid.", argv[i]);
- return 1;
- }
- opts->pids[pididx++] = (pid_t) tmp;
- }
- opts->pids[pididx] = -1;
+do_cli:
+ cli_cmd = find_cli_cmd(args[optind]);
+ if (!cli_cmd) {
+ fprintf(stderr, "No such command %s\n",
+ args[optind]);
+ exit(EXIT_FAILURE);
}
+ cli_dispatch_cmd(cli_cmd, argc - optind, &args[optind]);
+
return 0;
}
-int main(int argc, char *argv[])
+static int list_trace_events(int argc, char *argv[])
{
- pid_t *pidit;
- int result;
- char *tmp;
- struct ust_opts opts;
-
- progname = argv[0];
-
- if(argc <= 1) {
- fprintf(stderr, "No operation specified.\n");
- usage();
- exit(EXIT_FAILURE);
- }
+ struct trace_event_status *tes = NULL;
+ int i, sock;
- result = parse_opts_long(argc, argv, &opts);
- if(result) {
- fprintf(stderr, "\n");
- usage();
- exit(EXIT_FAILURE);
- }
+ sock = parse_and_connect_pid(argv[1]);
- if(opts.pids == NULL && opts.cmd != GET_ONLINE_PIDS) {
- fprintf(stderr, "No pid specified.\n");
- usage();
- exit(EXIT_FAILURE);
+ if (ustctl_get_tes(sock, &tes)) {
+ ERR("error while trying to list "
+ "trace_events for PID %s\n",
+ argv[1]);
+ return -1;
}
- if(opts.cmd == UNKNOWN) {
- fprintf(stderr, "No command specified.\n");
- usage();
- exit(EXIT_FAILURE);
+ i = 0;
+ for (i = 0; tes[i].name; i++) {
+ printf("{PID: %s, trace_event: %s}\n",
+ argv[1],
+ tes[i].name);
}
- if (opts.cmd == GET_ONLINE_PIDS) {
- pid_t *pp = ustcmd_get_online_pids();
- unsigned int i = 0;
-
- if (pp) {
- while (pp[i] != 0) {
- printf("%u\n", (unsigned int) pp[i]);
- ++i;
- }
- free(pp);
- }
+ ustctl_free_tes(tes);
- exit(EXIT_SUCCESS);
- }
-
- pidit = opts.pids;
- struct marker_status *cmsf = NULL;
-
- while(*pidit != -1) {
- switch (opts.cmd) {
- case CREATE_TRACE:
- result = ustcmd_create_trace(*pidit);
- if (result) {
- ERR("error while trying to create trace with PID %u\n", (unsigned int) *pidit);
- break;
- }
- break;
-
- case START_TRACE:
- result = ustcmd_start_trace(*pidit);
- if (result) {
- ERR("error while trying to for trace with PID %u\n", (unsigned int) *pidit);
- break;
- }
- break;
-
- case STOP_TRACE:
- result = ustcmd_stop_trace(*pidit);
- if (result) {
- ERR("error while trying to stop trace for PID %u\n", (unsigned int) *pidit);
- break;
- }
- break;
-
- case DESTROY_TRACE:
- result = ustcmd_destroy_trace(*pidit);
- if (result) {
- ERR("error while trying to destroy trace with PID %u\n", (unsigned int) *pidit);
- break;
- }
- break;
-
- case LIST_MARKERS:
- cmsf = NULL;
- if (ustcmd_get_cmsf(&cmsf, *pidit)) {
- fprintf(stderr,
- "error while trying to list markers for"
- " PID %u\n", (unsigned int) *pidit);
- break;
- }
- unsigned int i = 0;
- while (cmsf[i].channel != NULL) {
- printf("{PID: %u, channel/marker: %s/%s, "
- "state: %u, fmt: %s}\n",
- (unsigned int) *pidit,
- cmsf[i].channel,
- cmsf[i].marker,
- cmsf[i].state,
- cmsf[i].fs);
- ++i;
- }
- ustcmd_free_cmsf(cmsf);
- break;
-
- case ENABLE_MARKER:
- if(opts.regex)
- ustcmd_set_marker_state(opts.regex, 1, *pidit);
- break;
- case DISABLE_MARKER:
- if(opts.regex)
- ustcmd_set_marker_state(opts.regex, 0, *pidit);
- break;
-
- case SET_SUBBUF_SIZE:
- ustcmd_set_subbuf_size(opts.regex, *pidit);
- break;
+ return 0;
+}
- case SET_SUBBUF_NUM:
- ustcmd_set_subbuf_num(opts.regex, *pidit);
- break;
+static int set_sock_path(int argc, char *argv[])
+{
+ int sock;
- case GET_SUBBUF_SIZE:
- result = ustcmd_get_subbuf_size(opts.regex, *pidit);
- if (result == -1) {
- ERR("error while trying to get_subuf_size with PID %u\n", (unsigned int) *pidit);
- break;
- }
+ sock = parse_and_connect_pid(argv[1]);
- printf("the size of subbufers is %d\n", result);
- break;
+ if (ustctl_set_sock_path(sock, argv[2])) {
+ ERR("error while trying to set sock path for PID %s\n", argv[1]);
+ return -1;
+ }
- case GET_SUBBUF_NUM:
- result = ustcmd_get_subbuf_num(opts.regex, *pidit);
- if (result == -1) {
- ERR("error while trying to get_subuf_num with PID %u\n", (unsigned int) *pidit);
- break;
- }
+ return 0;
+}
- printf("the number of subbufers is %d\n", result);
- break;
+static int get_sock_path(int argc, char *argv[])
+{
+ int sock;
+ char *sock_path;
- case ALLOC_TRACE:
- result = ustcmd_alloc_trace(*pidit);
- if (result) {
- ERR("error while trying to alloc trace with PID %u\n", (unsigned int) *pidit);
- break;
- }
- break;
+ sock = parse_and_connect_pid(argv[1]);
- case GET_SOCK_PATH:
- result = ustcmd_get_sock_path(&tmp, *pidit);
- if (result) {
- ERR("error while trying to get sock path for PID %u\n", (unsigned int) *pidit);
- break;
- }
- printf("the socket path is %s\n", tmp);
- free(tmp);
- break;
+ if (ustctl_get_sock_path(sock, &sock_path)) {
+ ERR("error while trying to get sock path for PID %s\n", argv[1]);
+ return -1;
+ }
+ printf("The socket path is %s\n", sock_path);
+ free(sock_path);
- case SET_SOCK_PATH:
- result = ustcmd_set_sock_path(opts.regex, *pidit);
- if (result) {
- ERR("error while trying to set sock path for PID %u\n", (unsigned int) *pidit);
- }
- break;
+ return 0;
+}
- default:
- ERR("unknown command\n");
- break;
- }
+static int list_pids(int argc, char *argv[])
+{
+ pid_t *pid_list;
+ int i;
- pidit++;
+ pid_list = ustctl_get_online_pids();
+ if (!pid_list) {
+ return -1;
}
- if (opts.pids != NULL) {
- free(opts.pids);
- }
- if (opts.regex != NULL) {
- free(opts.regex);
+ for (i = 0; pid_list[i]; i++) {
+ printf("%ld\n", (long)pid_list[i]);
}
+ free(pid_list);
+
return 0;
}
+struct cli_cmd __cli_cmds general_cmds[] = {
+ {
+ .name = "list-trace-events",
+ .description = "List trace-events for a given pid",
+ .help_text = "list-trace-events <pid>\n"
+ "List the trace-events in a process\n",
+ .function = list_trace_events,
+ .desired_args = 1,
+ .desired_args_op = CLI_EQ,
+ },
+ {
+ .name = "set-sock-path",
+ .description = "Set the path to the consumer daemon socket",
+ .help_text = "set-sock-path <pid> <sock-path>\n"
+ "Set the path to the consumer daemon socket\n",
+ .function = set_sock_path,
+ .desired_args = 2,
+ .desired_args_op = CLI_EQ,
+ },
+ {
+ .name = "get-sock-path",
+ .description = "Get the path to the consumer daemon socket",
+ .help_text = "get-sock-path <pid>\n"
+ "Get the path to the consumer daemon socket\n",
+ .function = get_sock_path,
+ .desired_args = 1,
+ .desired_args_op = CLI_EQ,
+ },
+ {
+ .name = "list-pids",
+ .description = "List traceable pids",
+ .help_text = "list-pids\n"
+ "List the traceable pids for the current user\n",
+ .function = list_pids,
+ .desired_args = 0,
+ .desired_args_op = CLI_EQ,
+ },
+};
projects / ust.git / blobdiff