ustctl/ustctl.c

   1 /* Copyright (C) 2009  Pierre-Marc Fournier
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library 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 GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <stdio.h>
  20 #include <unistd.h>
  21 #include <getopt.h>
  22 #include <stdlib.h>
  23 #include <fcntl.h>
  24
  25 #include "ust/ustcmd.h"
  26 #include "usterr.h"
  27
  28 enum command {
  29         CREATE_TRACE=1000,
  30         ALLOC_TRACE,
  31         START_TRACE,
  32         STOP_TRACE,
  33         DESTROY_TRACE,
  34         LIST_MARKERS,
  35         LIST_TRACE_EVENTS,
  36         ENABLE_MARKER,
  37         DISABLE_MARKER,
  38         GET_ONLINE_PIDS,
  39         SET_SUBBUF_SIZE,
  40         SET_SUBBUF_NUM,
  41         GET_SUBBUF_SIZE,
  42         GET_SUBBUF_NUM,
  43         GET_SOCK_PATH,
  44         SET_SOCK_PATH,
  45         FORCE_SWITCH,
  46         UNKNOWN
  47 };
  48
  49 struct ust_opts {
  50         enum command cmd;
  51         pid_t *pids;
  52         char *regex;
  53 };
  54
  55 char *progname = NULL;
  56
  57 void usage(void)
  58 {
  59         fprintf(stderr, "usage: %s COMMAND PIDs...\n", progname);
  60         fprintf(stderr, "\nControl the tracing of a process that supports LTTng Userspace Tracing.\n\
  61 \n\
  62 Commands:\n\
  63     --create-trace\t\t\tCreate trace\n\
  64     --alloc-trace\t\t\tAlloc trace\n\
  65     --start-trace\t\t\tStart tracing\n\
  66     --stop-trace\t\t\tStop tracing\n\
  67     --destroy-trace\t\t\tDestroy the trace\n\
  68     --set-subbuf-size \"CHANNEL/bytes\"\tSet the size of subbuffers per channel\n\
  69     --set-subbuf-num \"CHANNEL/n\"\tSet the number of subbuffers per channel\n\
  70     --set-sock-path\t\t\tSet the path of the daemon socket\n\
  71     --get-subbuf-size \"CHANNEL\"\t\tGet the size of subbuffers per channel\n\
  72     --get-subbuf-num \"CHANNEL\"\t\tGet the number of subbuffers per channel\n\
  73     --get-sock-path\t\t\tGet the path of the daemon socket\n\
  74     --enable-marker \"CHANNEL/MARKER\"\tEnable a marker\n\
  75     --disable-marker \"CHANNEL/MARKER\"\tDisable a marker\n\
  76     --list-markers\t\t\tList the markers of the process, their\n\t\t\t\t\t  state and format string\n\
  77     --list-trace-events\t\t\tList the trace-events of the process\n\
  78     --force-switch\t\t\tForce a subbuffer switch\n\
  79 \
  80 ");
  81 }
  82
  83 int parse_opts_long(int argc, char **argv, struct ust_opts *opts)
  84 {
  85         int c;
  86
  87         opts->pids = NULL;
  88         opts->regex = NULL;
  89
  90         while (1) {
  91                 int option_index = 0;
  92                 static struct option long_options[] = {
  93                         { "create-trace", 0, 0, CREATE_TRACE },
  94                         { "alloc-trace", 0, 0, ALLOC_TRACE },
  95                         { "start-trace", 0, 0, START_TRACE },
  96                         { "stop-trace", 0, 0, STOP_TRACE },
  97                         { "destroy-trace", 0, 0, DESTROY_TRACE },
  98                         { "list-markers", 0, 0, LIST_MARKERS },
  99                         { "list-trace-events", 0, 0, LIST_TRACE_EVENTS},
 100                         { "enable-marker", 1, 0, ENABLE_MARKER },
 101                         { "disable-marker", 1, 0, DISABLE_MARKER },
 102                         { "help", 0, 0, 'h' },
 103                         { "online-pids", 0, 0, GET_ONLINE_PIDS },
 104                         { "set-subbuf-size", 1, 0, SET_SUBBUF_SIZE },
 105                         { "set-subbuf-num", 1, 0, SET_SUBBUF_NUM },
 106                         { "get-subbuf-size", 1, 0, GET_SUBBUF_SIZE },
 107                         { "get-subbuf-num", 1, 0, GET_SUBBUF_NUM },
 108                         { "get-sock-path", 0, 0, GET_SOCK_PATH },
 109                         { "set-sock-path", 1, 0, SET_SOCK_PATH },
 110                         { "force-switch", 0, 0, FORCE_SWITCH },
 111                         { 0, 0, 0, 0 }
 112                 };
 113
 114                 c = getopt_long(argc, argv, "h", long_options, &option_index);
 115                 if (c == -1)
 116                         break;
 117
 118                 if(c >= 1000)
 119                         opts->cmd = c;
 120
 121                 switch (c) {
 122                 case 0:
 123                         printf("option %s", long_options[option_index].name);
 124                         if (optarg)
 125                                 printf(" with arg %s", optarg);
 126                         printf("\n");
 127                         break;
 128
 129                 case ENABLE_MARKER:
 130                 case DISABLE_MARKER:
 131                 case SET_SUBBUF_SIZE:
 132                 case SET_SUBBUF_NUM:
 133                 case GET_SUBBUF_SIZE:
 134                 case GET_SUBBUF_NUM:
 135                 case SET_SOCK_PATH:
 136                         opts->regex = strdup(optarg);
 137                         break;
 138
 139                 case 'h':
 140                         usage();
 141                         exit(0);
 142
 143                 case '?':
 144                         fprintf(stderr, "Invalid argument\n\n");
 145                         usage();
 146                         exit(1);
 147                 }
 148         }
 149
 150         if (argc - optind > 0 && opts->cmd != GET_ONLINE_PIDS) {
 151                 int i;
 152                 int pididx=0;
 153                 opts->pids = zmalloc((argc-optind+1) * sizeof(pid_t));
 154
 155                 for(i=optind; i<argc; i++) {
 156                         /* don't take any chances, use a long long */
 157                         long long tmp;
 158                         char *endptr;
 159                         tmp = strtoull(argv[i], &endptr, 10);
 160                         if(*endptr != '\0') {
 161                                 ERR("The pid \"%s\" is invalid.", argv[i]);
 162                                 return 1;
 163                         }
 164                         opts->pids[pididx++] = (pid_t) tmp;
 165                 }
 166                 opts->pids[pididx] = -1;
 167         }
 168
 169         return 0;
 170 }
 171
 172 int main(int argc, char *argv[])
 173 {
 174         pid_t *pidit;
 175         int result;
 176         int retval = EXIT_SUCCESS;
 177         char *tmp;
 178         struct ust_opts opts;
 179
 180         progname = argv[0];
 181
 182         if(argc <= 1) {
 183                 fprintf(stderr, "No operation specified.\n");
 184                 usage();
 185                 exit(EXIT_FAILURE);
 186         }
 187
 188         result = parse_opts_long(argc, argv, &opts);
 189         if(result) {
 190                 fprintf(stderr, "\n");
 191                 usage();
 192                 exit(EXIT_FAILURE);
 193         }
 194
 195         if(opts.pids == NULL && opts.cmd != GET_ONLINE_PIDS) {
 196                 fprintf(stderr, "No pid specified.\n");
 197                 usage();
 198                 exit(EXIT_FAILURE);
 199         }
 200         if(opts.cmd == UNKNOWN) {
 201                 fprintf(stderr, "No command specified.\n");
 202                 usage();
 203                 exit(EXIT_FAILURE);
 204         }
 205         if (opts.cmd == GET_ONLINE_PIDS) {
 206                 pid_t *pp = ustcmd_get_online_pids();
 207                 unsigned int i = 0;
 208
 209                 if (pp) {
 210                         while (pp[i] != 0) {
 211                                 printf("%u\n", (unsigned int) pp[i]);
 212                                 ++i;
 213                         }
 214                         free(pp);
 215                 }
 216
 217                 exit(EXIT_SUCCESS);
 218         }
 219
 220         pidit = opts.pids;
 221         struct marker_status *cmsf = NULL;
 222         struct trace_event_status *tes = NULL;
 223         unsigned int i = 0;
 224
 225         while(*pidit != -1) {
 226                 switch (opts.cmd) {
 227                         case CREATE_TRACE:
 228                                 result = ustcmd_create_trace(*pidit);
 229                                 if (result) {
 230                                         ERR("error while trying to create trace with PID %u\n", (unsigned int) *pidit);
 231                                         retval = EXIT_FAILURE;
 232                                         break;
 233                                 }
 234                                 break;
 235
 236                         case START_TRACE:
 237                                 result = ustcmd_start_trace(*pidit);
 238                                 if (result) {
 239                                         ERR("error while trying to for trace with PID %u\n", (unsigned int) *pidit);
 240                                         retval = EXIT_FAILURE;
 241                                         break;
 242                                 }
 243                                 break;
 244
 245                         case STOP_TRACE:
 246                                 result = ustcmd_stop_trace(*pidit);
 247                                 if (result) {
 248                                         ERR("error while trying to stop trace for PID %u\n", (unsigned int) *pidit);
 249                                         retval = EXIT_FAILURE;
 250                                         break;
 251                                 }
 252                                 break;
 253
 254                         case DESTROY_TRACE:
 255                                 result = ustcmd_destroy_trace(*pidit);
 256                                 if (result) {
 257                                         ERR("error while trying to destroy trace with PID %u\n", (unsigned int) *pidit);
 258                                         retval = EXIT_FAILURE;
 259                                         break;
 260                                 }
 261                                 break;
 262
 263                         case LIST_MARKERS:
 264                                 cmsf = NULL;
 265                                 if (ustcmd_get_cmsf(&cmsf, *pidit)) {
 266                                         ERR("error while trying to list markers for PID %u\n", (unsigned int) *pidit);
 267                                         retval = EXIT_FAILURE;
 268                                         break;
 269                                 }
 270                                 i = 0;
 271                                 while (cmsf[i].channel != NULL) {
 272                                         printf("{PID: %u, channel/marker: %s/%s, "
 273                                                 "state: %u, fmt: %s}\n",
 274                                                 (unsigned int) *pidit,
 275                                                 cmsf[i].channel,
 276                                                 cmsf[i].marker,
 277                                                 cmsf[i].state,
 278                                                 cmsf[i].fs);
 279                                         ++i;
 280                                 }
 281                                 ustcmd_free_cmsf(cmsf);
 282                                 break;
 283
 284                         case LIST_TRACE_EVENTS:
 285                                 tes = NULL;
 286                                 if (ustcmd_get_tes(&tes, *pidit)) {
 287                                         ERR("error while trying to list "
 288                                             "trace_events for PID %u\n",
 289                                             (unsigned int) *pidit);
 290                                         break;
 291                                 }
 292                                 i = 0;
 293                                 while (tes[i].name != NULL) {
 294                                         printf("{PID: %u, trace_event: %s}\n",
 295                                                (unsigned int) *pidit,
 296                                                tes[i].name);
 297                                         ++i;
 298                                 }
 299                                 ustcmd_free_tes(tes);
 300
 301                                 break;
 302                         case ENABLE_MARKER:
 303                                 if (opts.regex) {
 304                                         if (ustcmd_set_marker_state(opts.regex, 1, *pidit)) {
 305                                                 ERR("error while trying to enable marker %s with PID %u\n",
 306                                                                 opts.regex, (unsigned int) *pidit);
 307                                                 retval = EXIT_FAILURE;
 308                                         }
 309                                 }
 310                                 break;
 311                         case DISABLE_MARKER:
 312                                 if (opts.regex) {
 313                                         if (ustcmd_set_marker_state(opts.regex, 0, *pidit)) {
 314                                                 ERR("error while trying to disable marker %s with PID %u\n",
 315                                                                 opts.regex, (unsigned int) *pidit);
 316                                                 retval = EXIT_FAILURE;
 317                                         }
 318                                 }
 319                                 break;
 320
 321                         case SET_SUBBUF_SIZE:
 322                                 if (opts.regex) {
 323                                         if (ustcmd_set_subbuf_size(opts.regex, *pidit)) {
 324                                                 ERR("error while trying to set the size of subbuffers with PID %u\n",
 325                                                                 (unsigned int) *pidit);
 326                                                 retval = EXIT_FAILURE;
 327                                         }
 328                                 }
 329                                 break;
 330
 331                         case SET_SUBBUF_NUM:
 332                                 if (opts.regex) {
 333                                         if (ustcmd_set_subbuf_num(opts.regex, *pidit)) {
 334                                                 ERR("error while trying to set the number of subbuffers with PID %u\n",
 335                                                                 (unsigned int) *pidit);
 336                                                 retval = EXIT_FAILURE;
 337                                         }
 338                                 }
 339                                 break;
 340
 341                         case GET_SUBBUF_SIZE:
 342                                 result = ustcmd_get_subbuf_size(opts.regex, *pidit);
 343                                 if (result == -1) {
 344                                         ERR("error while trying to get_subuf_size with PID %u\n", (unsigned int) *pidit);
 345                                         retval = EXIT_FAILURE;
 346                                         break;
 347                                 }
 348
 349                                 printf("the size of subbufers is %d\n", result);
 350                                 break;
 351
 352                         case GET_SUBBUF_NUM:
 353                                 result = ustcmd_get_subbuf_num(opts.regex, *pidit);
 354                                 if (result == -1) {
 355                                         ERR("error while trying to get_subuf_num with PID %u\n", (unsigned int) *pidit);
 356                                         retval = EXIT_FAILURE;
 357                                         break;
 358                                 }
 359
 360                                 printf("the number of subbufers is %d\n", result);
 361                                 break;
 362
 363                         case ALLOC_TRACE:
 364                                 result = ustcmd_alloc_trace(*pidit);
 365                                 if (result) {
 366                                         ERR("error while trying to alloc trace with PID %u\n", (unsigned int) *pidit);
 367                                         retval = EXIT_FAILURE;
 368                                 }
 369                                 break;
 370
 371                         case GET_SOCK_PATH:
 372                                 result = ustcmd_get_sock_path(&tmp, *pidit);
 373                                 if (result) {
 374                                         ERR("error while trying to get sock path for PID %u\n", (unsigned int) *pidit);
 375                                         retval = EXIT_FAILURE;
 376                                         break;
 377                                 }
 378                                 printf("the socket path is %s\n", tmp);
 379                                 free(tmp);
 380                                 break;
 381
 382                         case SET_SOCK_PATH:
 383                                 result = ustcmd_set_sock_path(opts.regex, *pidit);
 384                                 if (result) {
 385                                         ERR("error while trying to set sock path for PID %u\n", (unsigned int) *pidit);
 386                                         retval = EXIT_FAILURE;
 387                                 }
 388                                 break;
 389
 390                         case FORCE_SWITCH:
 391                                 result = ustcmd_force_switch(*pidit);
 392                                 if (result) {
 393                                         ERR("error while trying to force switch for PID %u\n", (unsigned int) *pidit);
 394                                         retval = EXIT_FAILURE;
 395                                 }
 396                                 break;
 397
 398                         default:
 399                                 ERR("unknown command\n");
 400                                 retval = EXIT_FAILURE;
 401                                 break;
 402                 }
 403
 404                 pidit++;
 405         }
 406
 407         if (opts.pids != NULL) {
 408                 free(opts.pids);
 409         }
 410         if (opts.regex != NULL) {
 411                 free(opts.regex);
 412         }
 413
 414         return retval;
 415 }
 416