X-Git-Url: http://git.lttng.org/?p=ust.git;a=blobdiff_plain;f=ustctl%2Fustctl.c;h=18f7d307caa64477a7105814a65cf1a8d211ed96;hp=48aa758d076519d09103639b3355da602e332e95;hb=HEAD;hpb=72098143aa5d995802b411e152b89ad252dd37ca diff --git a/ustctl/ustctl.c b/ustctl/ustctl.c index 48aa758..18f7d30 100644 --- a/ustctl/ustctl.c +++ b/ustctl/ustctl.c @@ -1,4 +1,5 @@ /* Copyright (C) 2009 Pierre-Marc Fournier + * Copyright (C) 2011 Ericsson AB, Nils Carlson * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -22,9 +23,32 @@ #include #include -#include "ust/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[], --help[=] " + "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, @@ -35,463 +59,214 @@ enum command { 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, - FORCE_SWITCH, - 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\ - --list-trace-events\t\t\tList the trace-events of the process\n\ - --force-switch\t\t\tForce a subbuffer switch\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 }, - { "list-trace-events", 0, 0, LIST_TRACE_EVENTS}, - { "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 }, - { "force-switch", 0, 0, FORCE_SWITCH }, - { 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 = zmalloc((argc-optind+1) * sizeof(pid_t)); - - for(i=optind; ipids[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; } -static int scan_ch_marker(const char *channel_marker, char **channel, - char **marker) +static int list_trace_events(int argc, char *argv[]) { - int result; + struct trace_event_status *tes = NULL; + int i, sock; - *channel = NULL; - *marker = NULL; + sock = parse_and_connect_pid(argv[1]); - result = sscanf(channel_marker, "%a[^/]/%as", channel, marker); - if (result != 2) { - if (errno) { - PERROR("Failed to read channel and marker names"); - } else { - ERR("Failed to parse marker and channel names"); - } - if (*channel) { - free(*channel); - } - if (*marker) { - free(*marker); - } + if (ustctl_get_tes(sock, &tes)) { + ERR("error while trying to list " + "trace_events for PID %s\n", + argv[1]); return -1; - } else { - return 0; } + i = 0; + for (i = 0; tes[i].name; i++) { + printf("{PID: %s, trace_event: %s}\n", + argv[1], + tes[i].name); + } + ustctl_free_tes(tes); + + return 0; } -static int scan_ch_and_num(const char *ch_num, char **channel, unsigned int *num) +static int set_sock_path(int argc, char *argv[]) { - int result; + int sock; - *channel = NULL; + sock = parse_and_connect_pid(argv[1]); - result = sscanf(ch_num, "%a[^/]/%u", channel, num); - if (result != 2) { - if (errno) { - PERROR("Failed to parse channel and number"); - } else { - ERR("Failed to parse channel and number"); - } - if (*channel) { - free(*channel); - } + if (ustctl_set_sock_path(sock, argv[2])) { + ERR("error while trying to set sock path for PID %s\n", argv[1]); return -1; } + + return 0; } -int main(int argc, char *argv[]) +static int get_sock_path(int argc, char *argv[]) { - pid_t *pidit; - int result; - int retval = EXIT_SUCCESS; - char *tmp; - struct ust_opts opts; + int sock; + char *sock_path; - progname = argv[0]; - - if(argc <= 1) { - fprintf(stderr, "No operation specified.\n"); - usage(); - exit(EXIT_FAILURE); - } + sock = parse_and_connect_pid(argv[1]); - result = parse_opts_long(argc, argv, &opts); - if(result) { - fprintf(stderr, "\n"); - usage(); - exit(EXIT_FAILURE); + 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); - if(opts.pids == NULL && opts.cmd != GET_ONLINE_PIDS) { - fprintf(stderr, "No pid specified.\n"); - usage(); - exit(EXIT_FAILURE); - } - if(opts.cmd == UNKNOWN) { - fprintf(stderr, "No command specified.\n"); - usage(); - exit(EXIT_FAILURE); - } - if (opts.cmd == GET_ONLINE_PIDS) { - pid_t *pp = ustcmd_get_online_pids(); - unsigned int i = 0; + return 0; +} - if (pp) { - while (pp[i] != 0) { - printf("%u\n", (unsigned int) pp[i]); - ++i; - } - free(pp); - } +static int list_pids(int argc, char *argv[]) +{ + pid_t *pid_list; + int i; - exit(EXIT_SUCCESS); + pid_list = ustctl_get_online_pids(); + if (!pid_list) { + return -1; } - pidit = opts.pids; - struct marker_status *cmsf = NULL; - struct trace_event_status *tes = NULL; - unsigned int i = 0; - - 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); - retval = EXIT_FAILURE; - 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); - retval = EXIT_FAILURE; - 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); - retval = EXIT_FAILURE; - 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); - retval = EXIT_FAILURE; - break; - } - break; - - case LIST_MARKERS: - cmsf = NULL; - if (ustcmd_get_cmsf(&cmsf, *pidit)) { - ERR("error while trying to list markers for PID %u\n", (unsigned int) *pidit); - retval = EXIT_FAILURE; - break; - } - 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 LIST_TRACE_EVENTS: - tes = NULL; - if (ustcmd_get_tes(&tes, *pidit)) { - ERR("error while trying to list " - "trace_events for PID %u\n", - (unsigned int) *pidit); - break; - } - i = 0; - while (tes[i].name != NULL) { - printf("{PID: %u, trace_event: %s}\n", - (unsigned int) *pidit, - tes[i].name); - ++i; - } - ustcmd_free_tes(tes); - - break; - case ENABLE_MARKER: - if (opts.regex) { - char *channel, *marker; - - if (scan_ch_marker(opts.regex, - &channel, &marker)) { - retval = EXIT_FAILURE; - break; - } - if (ustcmd_set_marker_state(channel, marker, 1, *pidit)) { - PERROR("error while trying to enable marker %s with PID %u", - opts.regex, (unsigned int) *pidit); - retval = EXIT_FAILURE; - } - } - - break; - case DISABLE_MARKER: - if (opts.regex) { - char *channel, *marker; - - if (scan_ch_marker(opts.regex, - &channel, &marker)) { - retval = EXIT_FAILURE; - break; - } - if (ustcmd_set_marker_state(channel, marker, 0, *pidit)) { - ERR("error while trying to disable marker %s with PID %u\n", - opts.regex, (unsigned int) *pidit); - retval = EXIT_FAILURE; - } - } - break; - - case SET_SUBBUF_SIZE: - if (opts.regex) { - char *channel; - unsigned int size; - if (scan_ch_and_num(opts.regex, &channel, &size)) { - retval = EXIT_FAILURE; - break; - } - - if (ustcmd_set_subbuf_size(channel, size, *pidit)) { - ERR("error while trying to set the size of subbuffers with PID %u\n", - (unsigned int) *pidit); - retval = EXIT_FAILURE; - } - } - break; - - case SET_SUBBUF_NUM: - if (opts.regex) { - char *channel; - unsigned int num; - if (scan_ch_and_num(opts.regex, &channel, &num)) { - retval = EXIT_FAILURE; - break; - } - - if (num < 2) { - ERR("Subbuffer count should be greater or equal to 2"); - retval = EXIT_FAILURE; - break; - } - if (ustcmd_set_subbuf_num(channel, num, *pidit)) { - ERR("error while trying to set the number of subbuffers with PID %u\n", - (unsigned int) *pidit); - retval = EXIT_FAILURE; - } - } - break; - - 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); - retval = EXIT_FAILURE; - break; - } - - printf("the size of subbufers is %d\n", result); - break; - - 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); - retval = EXIT_FAILURE; - break; - } - - printf("the number of subbufers is %d\n", result); - break; - - case ALLOC_TRACE: - result = ustcmd_alloc_trace(*pidit); - if (result) { - ERR("error while trying to alloc trace with PID %u\n", (unsigned int) *pidit); - retval = EXIT_FAILURE; - } - break; - - 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); - retval = EXIT_FAILURE; - break; - } - printf("the socket path is %s\n", tmp); - free(tmp); - break; - - 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); - retval = EXIT_FAILURE; - } - break; - - case FORCE_SWITCH: - result = ustcmd_force_switch(*pidit); - if (result) { - ERR("error while trying to force switch for PID %u\n", (unsigned int) *pidit); - retval = EXIT_FAILURE; - } - break; - - default: - ERR("unknown command\n"); - retval = EXIT_FAILURE; - break; - } - - pidit++; + for (i = 0; pid_list[i]; i++) { + printf("%ld\n", (long)pid_list[i]); } - if (opts.pids != NULL) { - free(opts.pids); - } - if (opts.regex != NULL) { - free(opts.regex); - } + free(pid_list); - return retval; + 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 \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 \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 \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, + }, +};