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 static int scan_ch_marker(const char *channel_marker, char **channel,
 173                         char **marker)
 174 {
 175         int result;
 176
 177         *channel = NULL;
 178         *marker = NULL;
 179
 180         result = sscanf(channel_marker, "%a[^/]/%as", channel, marker);
 181         if (result != 2) {
 182                 if (errno) {
 183                         PERROR("Failed to read channel and marker names");
 184                 } else {
 185                         ERR("Failed to parse marker and channel names");
 186                 }
 187                 if (*channel) {
 188                         free(*channel);
 189                 }
 190                 if (*marker) {
 191                         free(*marker);
 192                 }
 193                 return -1;
 194         } else {
 195                 return 0;
 196         }
 197 }
 198
 199 static int scan_ch_and_num(const char *ch_num, char **channel, unsigned int *num)
 200 {
 201         int result;
 202
 203         *channel = NULL;
 204
 205         result = sscanf(ch_num, "%a[^/]/%u", channel, num);
 206         if (result != 2) {
 207                 if (errno) {
 208                         PERROR("Failed to parse channel and number");
 209                 } else {
 210                         ERR("Failed to parse channel and number");
 211                 }
 212                 if (*channel) {
 213                         free(*channel);
 214                 }
 215                 return -1;
 216         }
 217 }
 218
 219 int main(int argc, char *argv[])
 220 {
 221         pid_t *pidit;
 222         int result;
 223         int retval = EXIT_SUCCESS;
 224         char *tmp;
 225         struct ust_opts opts;
 226
 227         progname = argv[0];
 228
 229         if(argc <= 1) {
 230                 fprintf(stderr, "No operation specified.\n");
 231                 usage();
 232                 exit(EXIT_FAILURE);
 233         }
 234
 235         result = parse_opts_long(argc, argv, &opts);
 236         if(result) {
 237                 fprintf(stderr, "\n");
 238                 usage();
 239                 exit(EXIT_FAILURE);
 240         }
 241
 242         if(opts.pids == NULL && opts.cmd != GET_ONLINE_PIDS) {
 243                 fprintf(stderr, "No pid specified.\n");
 244                 usage();
 245                 exit(EXIT_FAILURE);
 246         }
 247         if(opts.cmd == UNKNOWN) {
 248                 fprintf(stderr, "No command specified.\n");
 249                 usage();
 250                 exit(EXIT_FAILURE);
 251         }
 252         if (opts.cmd == GET_ONLINE_PIDS) {
 253                 pid_t *pp = ustcmd_get_online_pids();
 254                 unsigned int i = 0;
 255
 256                 if (pp) {
 257                         while (pp[i] != 0) {
 258                                 printf("%u\n", (unsigned int) pp[i]);
 259                                 ++i;
 260                         }
 261                         free(pp);
 262                 }
 263
 264                 exit(EXIT_SUCCESS);
 265         }
 266
 267         pidit = opts.pids;
 268         struct marker_status *cmsf = NULL;
 269         struct trace_event_status *tes = NULL;
 270         unsigned int i = 0;
 271
 272         while(*pidit != -1) {
 273                 switch (opts.cmd) {
 274                         case CREATE_TRACE:
 275                                 result = ustcmd_create_trace(*pidit);
 276                                 if (result) {
 277                                         ERR("error while trying to create trace with PID %u\n", (unsigned int) *pidit);
 278                                         retval = EXIT_FAILURE;
 279                                         break;
 280                                 }
 281                                 break;
 282
 283                         case START_TRACE:
 284                                 result = ustcmd_start_trace(*pidit);
 285                                 if (result) {
 286                                         ERR("error while trying to for trace with PID %u\n", (unsigned int) *pidit);
 287                                         retval = EXIT_FAILURE;
 288                                         break;
 289                                 }
 290                                 break;
 291
 292                         case STOP_TRACE:
 293                                 result = ustcmd_stop_trace(*pidit);
 294                                 if (result) {
 295                                         ERR("error while trying to stop trace for PID %u\n", (unsigned int) *pidit);
 296                                         retval = EXIT_FAILURE;
 297                                         break;
 298                                 }
 299                                 break;
 300
 301                         case DESTROY_TRACE:
 302                                 result = ustcmd_destroy_trace(*pidit);
 303                                 if (result) {
 304                                         ERR("error while trying to destroy trace with PID %u\n", (unsigned int) *pidit);
 305                                         retval = EXIT_FAILURE;
 306                                         break;
 307                                 }
 308                                 break;
 309
 310                         case LIST_MARKERS:
 311                                 cmsf = NULL;
 312                                 if (ustcmd_get_cmsf(&cmsf, *pidit)) {
 313                                         ERR("error while trying to list markers for PID %u\n", (unsigned int) *pidit);
 314                                         retval = EXIT_FAILURE;
 315                                         break;
 316                                 }
 317                                 i = 0;
 318                                 while (cmsf[i].channel != NULL) {
 319                                         printf("{PID: %u, channel/marker: %s/%s, "
 320                                                 "state: %u, fmt: %s}\n",
 321                                                 (unsigned int) *pidit,
 322                                                 cmsf[i].channel,
 323                                                 cmsf[i].marker,
 324                                                 cmsf[i].state,
 325                                                 cmsf[i].fs);
 326                                         ++i;
 327                                 }
 328                                 ustcmd_free_cmsf(cmsf);
 329                                 break;
 330
 331                         case LIST_TRACE_EVENTS:
 332                                 tes = NULL;
 333                                 if (ustcmd_get_tes(&tes, *pidit)) {
 334                                         ERR("error while trying to list "
 335                                             "trace_events for PID %u\n",
 336                                             (unsigned int) *pidit);
 337                                         break;
 338                                 }
 339                                 i = 0;
 340                                 while (tes[i].name != NULL) {
 341                                         printf("{PID: %u, trace_event: %s}\n",
 342                                                (unsigned int) *pidit,
 343                                                tes[i].name);
 344                                         ++i;
 345                                 }
 346                                 ustcmd_free_tes(tes);
 347
 348                                 break;
 349                         case ENABLE_MARKER:
 350                                 if (opts.regex) {
 351                                         char *channel, *marker;
 352
 353                                         if (scan_ch_marker(opts.regex,
 354                                                            &channel, &marker)) {
 355                                                 retval = EXIT_FAILURE;
 356                                                 break;
 357                                         }
 358                                         if (ustcmd_set_marker_state(channel, marker, 1, *pidit)) {
 359                                                 PERROR("error while trying to enable marker %s with PID %u",
 360                                                        opts.regex, (unsigned int) *pidit);
 361                                                 retval = EXIT_FAILURE;
 362                                         }
 363                                 }
 364
 365                                 break;
 366                         case DISABLE_MARKER:
 367                                 if (opts.regex) {
 368                                         char *channel, *marker;
 369
 370                                         if (scan_ch_marker(opts.regex,
 371                                                            &channel, &marker)) {
 372                                                 retval = EXIT_FAILURE;
 373                                                 break;
 374                                         }
 375                                         if (ustcmd_set_marker_state(channel, marker, 0, *pidit)) {
 376                                                 ERR("error while trying to disable marker %s with PID %u\n",
 377                                                                 opts.regex, (unsigned int) *pidit);
 378                                                 retval = EXIT_FAILURE;
 379                                         }
 380                                 }
 381                                 break;
 382
 383                         case SET_SUBBUF_SIZE:
 384                                 if (opts.regex) {
 385                                         char *channel;
 386                                         unsigned int size;
 387                                         if (scan_ch_and_num(opts.regex, &channel, &size)) {
 388                                                 retval = EXIT_FAILURE;
 389                                                 break;
 390                                         }
 391
 392                                         if (ustcmd_set_subbuf_size(channel, size, *pidit)) {
 393                                                 ERR("error while trying to set the size of subbuffers with PID %u\n",
 394                                                                 (unsigned int) *pidit);
 395                                                 retval = EXIT_FAILURE;
 396                                         }
 397                                 }
 398                                 break;
 399
 400                         case SET_SUBBUF_NUM:
 401                                 if (opts.regex) {
 402                                         char *channel;
 403                                         unsigned int num;
 404                                         if (scan_ch_and_num(opts.regex, &channel, &num)) {
 405                                                 retval = EXIT_FAILURE;
 406                                                 break;
 407                                         }
 408
 409                                         if (num < 2) {
 410                                                 ERR("Subbuffer count should be greater or equal to 2");
 411                                                 retval = EXIT_FAILURE;
 412                                                 break;
 413                                         }
 414                                         if (ustcmd_set_subbuf_num(channel, num, *pidit)) {
 415                                                 ERR("error while trying to set the number of subbuffers with PID %u\n",
 416                                                                 (unsigned int) *pidit);
 417                                                 retval = EXIT_FAILURE;
 418                                         }
 419                                 }
 420                                 break;
 421
 422                         case GET_SUBBUF_SIZE:
 423                                 result = ustcmd_get_subbuf_size(opts.regex, *pidit);
 424                                 if (result == -1) {
 425                                         ERR("error while trying to get_subuf_size with PID %u\n", (unsigned int) *pidit);
 426                                         retval = EXIT_FAILURE;
 427                                         break;
 428                                 }
 429
 430                                 printf("the size of subbufers is %d\n", result);
 431                                 break;
 432
 433                         case GET_SUBBUF_NUM:
 434                                 result = ustcmd_get_subbuf_num(opts.regex, *pidit);
 435                                 if (result == -1) {
 436                                         ERR("error while trying to get_subuf_num with PID %u\n", (unsigned int) *pidit);
 437                                         retval = EXIT_FAILURE;
 438                                         break;
 439                                 }
 440
 441                                 printf("the number of subbufers is %d\n", result);
 442                                 break;
 443
 444                         case ALLOC_TRACE:
 445                                 result = ustcmd_alloc_trace(*pidit);
 446                                 if (result) {
 447                                         ERR("error while trying to alloc trace with PID %u\n", (unsigned int) *pidit);
 448                                         retval = EXIT_FAILURE;
 449                                 }
 450                                 break;
 451
 452                         case GET_SOCK_PATH:
 453                                 result = ustcmd_get_sock_path(&tmp, *pidit);
 454                                 if (result) {
 455                                         ERR("error while trying to get sock path for PID %u\n", (unsigned int) *pidit);
 456                                         retval = EXIT_FAILURE;
 457                                         break;
 458                                 }
 459                                 printf("the socket path is %s\n", tmp);
 460                                 free(tmp);
 461                                 break;
 462
 463                         case SET_SOCK_PATH:
 464                                 result = ustcmd_set_sock_path(opts.regex, *pidit);
 465                                 if (result) {
 466                                         ERR("error while trying to set sock path for PID %u\n", (unsigned int) *pidit);
 467                                         retval = EXIT_FAILURE;
 468                                 }
 469                                 break;
 470
 471                         case FORCE_SWITCH:
 472                                 result = ustcmd_force_switch(*pidit);
 473                                 if (result) {
 474                                         ERR("error while trying to force switch for PID %u\n", (unsigned int) *pidit);
 475                                         retval = EXIT_FAILURE;
 476                                 }
 477                                 break;
 478
 479                         default:
 480                                 ERR("unknown command\n");
 481                                 retval = EXIT_FAILURE;
 482                                 break;
 483                 }
 484
 485                 pidit++;
 486         }
 487
 488         if (opts.pids != NULL) {
 489                 free(opts.pids);
 490         }
 491         if (opts.regex != NULL) {
 492                 free(opts.regex);
 493         }
 494
 495         return retval;
 496 }
 497