src/bin/lttng/commands/list.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; only version 2
   7  * of the License.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <inttypes.h>
  21 #include <popt.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <assert.h>
  26
  27 #include "../command.h"
  28
  29 static int opt_userspace;
  30 static int opt_kernel;
  31 static char *opt_channel;
  32 static int opt_domain;
  33 #if 0
  34 /* Not implemented yet */
  35 static char *opt_cmd_name;
  36 static pid_t opt_pid;
  37 #endif
  38
  39 const char *indent4 = "    ";
  40 const char *indent6 = "      ";
  41 const char *indent8 = "        ";
  42
  43 enum {
  44         OPT_HELP = 1,
  45         OPT_USERSPACE,
  46         OPT_LIST_OPTIONS,
  47 };
  48
  49 static struct lttng_handle *handle;
  50
  51 static struct poptOption long_options[] = {
  52         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  53         {"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  54         {"kernel",    'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  55 #if 0
  56         /* Not implemented yet */
  57         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  58         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  59 #else
  60         {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
  61 #endif
  62         {"channel",   'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
  63         {"domain",    'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
  64         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  65         {0, 0, 0, 0, 0, 0, 0}
  66 };
  67
  68 /*
  69  * usage
  70  */
  71 static void usage(FILE *ofp)
  72 {
  73         fprintf(ofp, "usage: lttng list [SESSION [<OPTIONS>]]\n");
  74         fprintf(ofp, "\n");
  75         fprintf(ofp, "With no arguments, list available tracing session(s)\n");
  76         fprintf(ofp, "\n");
  77         fprintf(ofp, "With -k alone, list available kernel events\n");
  78         fprintf(ofp, "With -u alone, list available userspace events\n");
  79         fprintf(ofp, "\n");
  80         fprintf(ofp, "  -h, --help              Show this help\n");
  81         fprintf(ofp, "      --list-options       Simple listing of options\n");
  82         fprintf(ofp, "  -k, --kernel            Select kernel domain\n");
  83         fprintf(ofp, "  -u, --userspace         Select user-space domain.\n");
  84 #if 0
  85         fprintf(ofp, "  -p, --pid PID           List user-space events by PID\n");
  86 #endif
  87         fprintf(ofp, "\n");
  88         fprintf(ofp, "Options:\n");
  89         fprintf(ofp, "  -c, --channel NAME      List details of a channel\n");
  90         fprintf(ofp, "  -d, --domain            List available domain(s)\n");
  91         fprintf(ofp, "\n");
  92 }
  93
  94 /*
  95  * Get command line from /proc for a specific pid.
  96  *
  97  * On success, return an allocated string pointer to the proc cmdline.
  98  * On error, return NULL.
  99  */
 100 static char *get_cmdline_by_pid(pid_t pid)
 101 {
 102         int ret;
 103         FILE *fp;
 104         char *cmdline = NULL;
 105         char path[24];  /* Can't go bigger than /proc/65535/cmdline */
 106
 107         snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
 108         fp = fopen(path, "r");
 109         if (fp == NULL) {
 110                 goto end;
 111         }
 112
 113         /* Caller must free() *cmdline */
 114         cmdline = malloc(PATH_MAX);
 115         ret = fread(cmdline, 1, PATH_MAX, fp);
 116         if (ret < 0) {
 117                 perror("fread proc list");
 118         }
 119         fclose(fp);
 120
 121 end:
 122         return cmdline;
 123 }
 124
 125 static
 126 const char *active_string(int value)
 127 {
 128         switch (value) {
 129         case 0: return " [inactive]";
 130         case 1: return " [active]";
 131         case -1: return "";
 132         default: return NULL;
 133         }
 134 }
 135
 136 static
 137 const char *enabled_string(int value)
 138 {
 139         switch (value) {
 140         case 0: return " [disabled]";
 141         case 1: return " [enabled]";
 142         case -1: return "";
 143         default: return NULL;
 144         }
 145 }
 146
 147 static
 148 const char *loglevel_string_pre(const char *loglevel)
 149 {
 150         if (loglevel[0] == '\0') {
 151                 return "";
 152         } else {
 153                 return " (loglevel: ";
 154         }
 155 }
 156
 157 static
 158 const char *loglevel_string_post(const char *loglevel)
 159 {
 160         if (loglevel[0] == '\0') {
 161                 return "";
 162         } else {
 163                 return ")";
 164         }
 165 }
 166
 167 /*
 168  * Pretty print single event.
 169  */
 170 static void print_events(struct lttng_event *event)
 171 {
 172         switch (event->type) {
 173         case LTTNG_EVENT_TRACEPOINT:
 174         {
 175                 char ll_value[LTTNG_SYMBOL_NAME_LEN] = "";
 176
 177                 if (event->loglevel[0] != '\0') {
 178                         int ret;
 179
 180                         ret = snprintf(ll_value, LTTNG_SYMBOL_NAME_LEN,
 181                                 " (%lld)", (long long) event->loglevel_value);
 182                         if (ret < 0) {
 183                                 ERR("snprintf error");
 184                         }
 185                 }
 186                 MSG("%s%s%s%s%s%s (type: tracepoint)%s", indent6,
 187                                 event->name,
 188                                 loglevel_string_pre(event->loglevel),
 189                                 event->loglevel,
 190                                 ll_value,
 191                                 loglevel_string_post(event->loglevel),
 192                                 enabled_string(event->enabled));
 193                 break;
 194         }
 195         case LTTNG_EVENT_PROBE:
 196                 MSG("%s%s (type: probe)%s", indent6,
 197                                 event->name, enabled_string(event->enabled));
 198                 if (event->attr.probe.addr != 0) {
 199                         MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
 200                 } else {
 201                         MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
 202                         MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
 203                 }
 204                 break;
 205         case LTTNG_EVENT_FUNCTION:
 206         case LTTNG_EVENT_FUNCTION_ENTRY:
 207                 MSG("%s%s (type: function)%s", indent6,
 208                                 event->name, enabled_string(event->enabled));
 209                 MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
 210                 break;
 211         case LTTNG_EVENT_SYSCALL:
 212                 MSG("%s (type: syscall)%s", indent6,
 213                                 enabled_string(event->enabled));
 214                 break;
 215         case LTTNG_EVENT_NOOP:
 216                 MSG("%s (type: noop)%s", indent6,
 217                                 enabled_string(event->enabled));
 218                 break;
 219         case LTTNG_EVENT_ALL:
 220                 /* We should never have "all" events in list. */
 221                 assert(0);
 222                 break;
 223         }
 224 }
 225
 226 /*
 227  * Ask session daemon for all user space tracepoints available.
 228  */
 229 static int list_ust_events(void)
 230 {
 231         int i, size;
 232         struct lttng_domain domain;
 233         struct lttng_handle *handle;
 234         struct lttng_event *event_list;
 235         pid_t cur_pid = 0;
 236
 237         DBG("Getting UST tracing events");
 238
 239         domain.type = LTTNG_DOMAIN_UST;
 240
 241         handle = lttng_create_handle(NULL, &domain);
 242         if (handle == NULL) {
 243                 goto error;
 244         }
 245
 246         size = lttng_list_tracepoints(handle, &event_list);
 247         if (size < 0) {
 248                 ERR("Unable to list UST events");
 249                 return size;
 250         }
 251
 252         MSG("UST events:\n-------------");
 253
 254         if (size == 0) {
 255                 MSG("None");
 256         }
 257
 258         for (i = 0; i < size; i++) {
 259                 if (cur_pid != event_list[i].pid) {
 260                         cur_pid = event_list[i].pid;
 261                         MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
 262                 }
 263                 print_events(&event_list[i]);
 264         }
 265
 266         MSG("");
 267
 268         free(event_list);
 269
 270         return CMD_SUCCESS;
 271
 272 error:
 273         return -1;
 274 }
 275
 276 /*
 277  * Ask for all trace events in the kernel and pretty print them.
 278  */
 279 static int list_kernel_events(void)
 280 {
 281         int i, size;
 282         struct lttng_domain domain;
 283         struct lttng_handle *handle;
 284         struct lttng_event *event_list;
 285
 286         DBG("Getting kernel tracing events");
 287
 288         domain.type = LTTNG_DOMAIN_KERNEL;
 289
 290         handle = lttng_create_handle(NULL, &domain);
 291         if (handle == NULL) {
 292                 goto error;
 293         }
 294
 295         size = lttng_list_tracepoints(handle, &event_list);
 296         if (size < 0) {
 297                 ERR("Unable to list kernel events");
 298                 return size;
 299         }
 300
 301         MSG("Kernel events:\n-------------");
 302
 303         for (i = 0; i < size; i++) {
 304                 print_events(&event_list[i]);
 305         }
 306
 307         MSG("");
 308
 309         free(event_list);
 310
 311         return CMD_SUCCESS;
 312
 313 error:
 314         return -1;
 315 }
 316
 317 /*
 318  * List events of channel of session and domain.
 319  */
 320 static int list_events(const char *channel_name)
 321 {
 322         int ret, count, i;
 323         struct lttng_event *events = NULL;
 324
 325         count = lttng_list_events(handle, channel_name, &events);
 326         if (count < 0) {
 327                 ret = count;
 328                 goto error;
 329         }
 330
 331         MSG("\n%sEvents:", indent4);
 332         if (count == 0) {
 333                 MSG("%sNone\n", indent6);
 334                 goto end;
 335         }
 336
 337         for (i = 0; i < count; i++) {
 338                 print_events(&events[i]);
 339         }
 340
 341         MSG("");
 342
 343 end:
 344         if (events) {
 345                 free(events);
 346         }
 347         ret = CMD_SUCCESS;
 348
 349 error:
 350         return ret;
 351 }
 352
 353 /*
 354  * Pretty print channel
 355  */
 356 static void print_channel(struct lttng_channel *channel)
 357 {
 358         MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
 359
 360         MSG("%sAttributes:", indent4);
 361         MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
 362         MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
 363         MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
 364         MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
 365         MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
 366         switch (channel->attr.output) {
 367                 case LTTNG_EVENT_SPLICE:
 368                         MSG("%soutput: splice()", indent6);
 369                         break;
 370                 case LTTNG_EVENT_MMAP:
 371                         MSG("%soutput: mmap()", indent6);
 372                         break;
 373         }
 374 }
 375
 376 /*
 377  * List channel(s) of session and domain.
 378  *
 379  * If channel_name is NULL, all channels are listed.
 380  */
 381 static int list_channels(const char *channel_name)
 382 {
 383         int count, i, ret = CMD_SUCCESS;
 384         unsigned int chan_found = 0;
 385         struct lttng_channel *channels = NULL;
 386
 387         DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
 388
 389         count = lttng_list_channels(handle, &channels);
 390         if (count < 0) {
 391                 ret = count;
 392                 goto error_channels;
 393         } else if (count == 0) {
 394                 ERR("Channel %s not found", channel_name);
 395                 goto error;
 396         }
 397
 398         if (channel_name == NULL) {
 399                 MSG("Channels:\n-------------");
 400         }
 401
 402         for (i = 0; i < count; i++) {
 403                 if (channel_name != NULL) {
 404                         if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
 405                                 chan_found = 1;
 406                         } else {
 407                                 continue;
 408                         }
 409                 }
 410                 print_channel(&channels[i]);
 411
 412                 /* Listing events per channel */
 413                 ret = list_events(channels[i].name);
 414                 if (ret < 0) {
 415                         MSG("%s", lttng_strerror(ret));
 416                 }
 417
 418                 if (chan_found) {
 419                         break;
 420                 }
 421         }
 422
 423         if (!chan_found && channel_name != NULL) {
 424                 ERR("Channel %s not found", channel_name);
 425                 goto error;
 426         }
 427
 428         ret = CMD_SUCCESS;
 429
 430 error:
 431         free(channels);
 432
 433 error_channels:
 434         return ret;
 435 }
 436
 437 /*
 438  * List available tracing session. List only basic information.
 439  *
 440  * If session_name is NULL, all sessions are listed.
 441  */
 442 static int list_sessions(const char *session_name)
 443 {
 444         int ret, count, i;
 445         unsigned int session_found = 0;
 446         struct lttng_session *sessions;
 447
 448         count = lttng_list_sessions(&sessions);
 449         DBG("Session count %d", count);
 450         if (count < 0) {
 451                 ret = count;
 452                 goto error;
 453         }
 454
 455         if (session_name == NULL) {
 456                 MSG("Available tracing sessions:");
 457         }
 458
 459         for (i = 0; i < count; i++) {
 460                 if (session_name != NULL) {
 461                         if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
 462                                 session_found = 1;
 463                                 MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
 464                                 MSG("%sTrace path: %s\n", indent4, sessions[i].path);
 465                                 break;
 466                         }
 467                         continue;
 468                 }
 469
 470                 MSG("  %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path, active_string(sessions[i].enabled));
 471
 472                 if (session_found) {
 473                         break;
 474                 }
 475         }
 476
 477         free(sessions);
 478
 479         if (!session_found && session_name != NULL) {
 480                 ERR("Session %s not found", session_name);
 481         }
 482
 483         if (session_name == NULL) {
 484                 MSG("\nUse lttng list <session_name> for more details");
 485         }
 486
 487         return CMD_SUCCESS;
 488
 489 error:
 490         return ret;
 491 }
 492
 493 /*
 494  * List available domain(s) for a session.
 495  */
 496 static int list_domains(const char *session_name)
 497 {
 498         int i, count, ret = CMD_SUCCESS;
 499         struct lttng_domain *domains = NULL;
 500
 501         MSG("Domains:\n-------------");
 502
 503         count = lttng_list_domains(session_name, &domains);
 504         if (count < 0) {
 505                 ret = count;
 506                 goto error;
 507         } else if (count == 0) {
 508                 MSG("  None");
 509                 goto end;
 510         }
 511
 512         for (i = 0; i < count; i++) {
 513                 switch (domains[i].type) {
 514                 case LTTNG_DOMAIN_KERNEL:
 515                         MSG("  - Kernel");
 516                         break;
 517                 case LTTNG_DOMAIN_UST:
 518                         MSG("  - UST global");
 519                         break;
 520                 default:
 521                         break;
 522                 }
 523         }
 524
 525 end:
 526         free(domains);
 527
 528 error:
 529         return ret;
 530 }
 531
 532 /*
 533  * The 'list <options>' first level command
 534  */
 535 int cmd_list(int argc, const char **argv)
 536 {
 537         int opt, i, ret = CMD_SUCCESS;
 538         int nb_domain;
 539         const char *session_name;
 540         static poptContext pc;
 541         struct lttng_domain domain;
 542         struct lttng_domain *domains = NULL;
 543
 544         if (argc < 1) {
 545                 usage(stderr);
 546                 ret = CMD_ERROR;
 547                 goto end;
 548         }
 549
 550         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 551         poptReadDefaultConfig(pc, 0);
 552
 553         while ((opt = poptGetNextOpt(pc)) != -1) {
 554                 switch (opt) {
 555                 case OPT_HELP:
 556                         usage(stdout);
 557                         goto end;
 558                 case OPT_USERSPACE:
 559                         opt_userspace = 1;
 560                         break;
 561                 case OPT_LIST_OPTIONS:
 562                         list_cmd_options(stdout, long_options);
 563                         goto end;
 564                 default:
 565                         usage(stderr);
 566                         ret = CMD_UNDEFINED;
 567                         goto end;
 568                 }
 569         }
 570
 571         /* Get session name (trailing argument) */
 572         session_name = poptGetArg(pc);
 573         DBG2("Session name: %s", session_name);
 574
 575         if (opt_kernel) {
 576                 domain.type = LTTNG_DOMAIN_KERNEL;
 577         } else if (opt_userspace) {
 578                 DBG2("Listing userspace global domain");
 579                 domain.type = LTTNG_DOMAIN_UST;
 580         }
 581
 582         handle = lttng_create_handle(session_name, &domain);
 583         if (handle == NULL) {
 584                 ret = CMD_FATAL;
 585                 goto end;
 586         }
 587
 588         if (session_name == NULL) {
 589                 if (!opt_kernel && !opt_userspace) {
 590                         ret = list_sessions(NULL);
 591                         if (ret < 0) {
 592                                 ret = CMD_ERROR;
 593                                 goto end;
 594                         }
 595                 }
 596                 if (opt_kernel) {
 597                         ret = list_kernel_events();
 598                         if (ret < 0) {
 599                                 ret = CMD_ERROR;
 600                                 goto end;
 601                         }
 602                 }
 603                 if (opt_userspace) {
 604                         ret = list_ust_events();
 605                         if (ret < 0) {
 606                                 ret = CMD_ERROR;
 607                                 goto end;
 608                         }
 609                 }
 610         } else {
 611                 /* List session attributes */
 612                 ret = list_sessions(session_name);
 613                 if (ret < 0) {
 614                         ret = CMD_ERROR;
 615                         goto end;
 616                 }
 617
 618                 /* Domain listing */
 619                 if (opt_domain) {
 620                         ret = list_domains(session_name);
 621                         if (ret < 0) {
 622                                 ret = CMD_ERROR;
 623                         }
 624                         goto end;
 625                 }
 626
 627                 if (opt_kernel) {
 628                         /* Channel listing */
 629                         ret = list_channels(opt_channel);
 630                         if (ret < 0) {
 631                                 ret = CMD_ERROR;
 632                                 goto end;
 633                         }
 634                 } else {
 635                         /* We want all domain(s) */
 636                         nb_domain = lttng_list_domains(session_name, &domains);
 637                         if (nb_domain < 0) {
 638                                 ret = CMD_ERROR;
 639                                 goto end;
 640                         }
 641
 642                         for (i = 0; i < nb_domain; i++) {
 643                                 switch (domains[i].type) {
 644                                 case LTTNG_DOMAIN_KERNEL:
 645                                         MSG("=== Domain: Kernel ===\n");
 646                                         break;
 647                                 case LTTNG_DOMAIN_UST:
 648                                         MSG("=== Domain: UST global ===\n");
 649                                         break;
 650                                 default:
 651                                         MSG("=== Domain: Unimplemented ===\n");
 652                                         break;
 653                                 }
 654
 655                                 /* Clean handle before creating a new one */
 656                                 lttng_destroy_handle(handle);
 657
 658                                 handle = lttng_create_handle(session_name, &domains[i]);
 659                                 if (handle == NULL) {
 660                                         ret = CMD_FATAL;
 661                                         goto end;
 662                                 }
 663
 664                                 ret = list_channels(opt_channel);
 665                                 if (ret < 0) {
 666                                         ret = CMD_ERROR;
 667                                         goto end;
 668                                 }
 669                         }
 670                 }
 671         }
 672
 673 end:
 674         if (domains) {
 675                 free(domains);
 676         }
 677         lttng_destroy_handle(handle);
 678
 679         poptFreeContext(pc);
 680         return ret;
 681 }