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 [OPTIONS] [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, "Without a session, -k lists available kernel events\n");
  78         fprintf(ofp, "Without a session, -u lists 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, "Session 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(int loglevel)
 149 {
 150         if (loglevel == -1) {
 151                 return "";
 152         } else {
 153                 return " (loglevel: ";
 154         }
 155 }
 156
 157 static
 158 const char *loglevel_string_post(int loglevel)
 159 {
 160         if (loglevel == -1) {
 161                 return "";
 162         } else {
 163                 return ")";
 164         }
 165 }
 166
 167 static const char *loglevel_string(int value)
 168 {
 169         switch (value) {
 170         case -1: return "";
 171         case 0: return "TRACE_EMERG";
 172         case 1: return "TRACE_ALERT";
 173         case 2: return "TRACE_CRIT";
 174         case 3: return "TRACE_ERR";
 175         case 4: return "TRACE_WARNING";
 176         case 5: return "TRACE_NOTICE";
 177         case 6: return "TRACE_INFO";
 178         case 7: return "TRACE_SYSTEM";
 179         case 8: return "TRACE_PROGRAM";
 180         case 9: return "TRACE_PROCESS";
 181         case 10: return "TRACE_MODULE";
 182         case 11: return "TRACE_UNIT";
 183         case 12: return "TRACE_FUNCTION";
 184         case 13: return "TRACE_DEFAULT";
 185         case 14: return "TRACE_VERBOSE";
 186         case 15: return "TRACE_DEBUG";
 187         default: return "<<UNKNOWN>>";
 188         }
 189 }
 190
 191 /*
 192  * Pretty print single event.
 193  */
 194 static void print_events(struct lttng_event *event)
 195 {
 196         switch (event->type) {
 197         case LTTNG_EVENT_TRACEPOINT:
 198         {
 199                 MSG("%s%s%s%s%s (type: tracepoint)%s", indent6,
 200                                 event->name,
 201                                 loglevel_string_pre(event->loglevel),
 202                                 loglevel_string(event->loglevel),
 203                                 loglevel_string_post(event->loglevel),
 204                                 enabled_string(event->enabled));
 205                 break;
 206         }
 207         case LTTNG_EVENT_PROBE:
 208                 MSG("%s%s (type: probe)%s", indent6,
 209                                 event->name, enabled_string(event->enabled));
 210                 if (event->attr.probe.addr != 0) {
 211                         MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
 212                 } else {
 213                         MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
 214                         MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
 215                 }
 216                 break;
 217         case LTTNG_EVENT_FUNCTION:
 218         case LTTNG_EVENT_FUNCTION_ENTRY:
 219                 MSG("%s%s (type: function)%s", indent6,
 220                                 event->name, enabled_string(event->enabled));
 221                 MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
 222                 break;
 223         case LTTNG_EVENT_SYSCALL:
 224                 MSG("%s (type: syscall)%s", indent6,
 225                                 enabled_string(event->enabled));
 226                 break;
 227         case LTTNG_EVENT_NOOP:
 228                 MSG("%s (type: noop)%s", indent6,
 229                                 enabled_string(event->enabled));
 230                 break;
 231         case LTTNG_EVENT_ALL:
 232                 /* We should never have "all" events in list. */
 233                 assert(0);
 234                 break;
 235         }
 236 }
 237
 238 /*
 239  * Ask session daemon for all user space tracepoints available.
 240  */
 241 static int list_ust_events(void)
 242 {
 243         int i, size;
 244         struct lttng_domain domain;
 245         struct lttng_handle *handle;
 246         struct lttng_event *event_list;
 247         pid_t cur_pid = 0;
 248
 249         memset(&domain, 0, sizeof(domain));
 250
 251         DBG("Getting UST tracing events");
 252
 253         domain.type = LTTNG_DOMAIN_UST;
 254
 255         handle = lttng_create_handle(NULL, &domain);
 256         if (handle == NULL) {
 257                 goto error;
 258         }
 259
 260         size = lttng_list_tracepoints(handle, &event_list);
 261         if (size < 0) {
 262                 ERR("Unable to list UST events");
 263                 return size;
 264         }
 265
 266         MSG("UST events:\n-------------");
 267
 268         if (size == 0) {
 269                 MSG("None");
 270         }
 271
 272         for (i = 0; i < size; i++) {
 273                 if (cur_pid != event_list[i].pid) {
 274                         cur_pid = event_list[i].pid;
 275                         MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
 276                 }
 277                 print_events(&event_list[i]);
 278         }
 279
 280         MSG("");
 281
 282         free(event_list);
 283
 284         return CMD_SUCCESS;
 285
 286 error:
 287         return -1;
 288 }
 289
 290 /*
 291  * Ask for all trace events in the kernel and pretty print them.
 292  */
 293 static int list_kernel_events(void)
 294 {
 295         int i, size;
 296         struct lttng_domain domain;
 297         struct lttng_handle *handle;
 298         struct lttng_event *event_list;
 299
 300         memset(&domain, 0, sizeof(domain));
 301
 302         DBG("Getting kernel tracing events");
 303
 304         domain.type = LTTNG_DOMAIN_KERNEL;
 305
 306         handle = lttng_create_handle(NULL, &domain);
 307         if (handle == NULL) {
 308                 goto error;
 309         }
 310
 311         size = lttng_list_tracepoints(handle, &event_list);
 312         if (size < 0) {
 313                 ERR("Unable to list kernel events");
 314                 return size;
 315         }
 316
 317         MSG("Kernel events:\n-------------");
 318
 319         for (i = 0; i < size; i++) {
 320                 print_events(&event_list[i]);
 321         }
 322
 323         MSG("");
 324
 325         free(event_list);
 326
 327         return CMD_SUCCESS;
 328
 329 error:
 330         return -1;
 331 }
 332
 333 /*
 334  * List events of channel of session and domain.
 335  */
 336 static int list_events(const char *channel_name)
 337 {
 338         int ret, count, i;
 339         struct lttng_event *events = NULL;
 340
 341         count = lttng_list_events(handle, channel_name, &events);
 342         if (count < 0) {
 343                 ret = count;
 344                 goto error;
 345         }
 346
 347         MSG("\n%sEvents:", indent4);
 348         if (count == 0) {
 349                 MSG("%sNone\n", indent6);
 350                 goto end;
 351         }
 352
 353         for (i = 0; i < count; i++) {
 354                 print_events(&events[i]);
 355         }
 356
 357         MSG("");
 358
 359 end:
 360         if (events) {
 361                 free(events);
 362         }
 363         ret = CMD_SUCCESS;
 364
 365 error:
 366         return ret;
 367 }
 368
 369 /*
 370  * Pretty print channel
 371  */
 372 static void print_channel(struct lttng_channel *channel)
 373 {
 374         MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
 375
 376         MSG("%sAttributes:", indent4);
 377         MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
 378         MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
 379         MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
 380         MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
 381         MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
 382         switch (channel->attr.output) {
 383                 case LTTNG_EVENT_SPLICE:
 384                         MSG("%soutput: splice()", indent6);
 385                         break;
 386                 case LTTNG_EVENT_MMAP:
 387                         MSG("%soutput: mmap()", indent6);
 388                         break;
 389         }
 390 }
 391
 392 /*
 393  * List channel(s) of session and domain.
 394  *
 395  * If channel_name is NULL, all channels are listed.
 396  */
 397 static int list_channels(const char *channel_name)
 398 {
 399         int count, i, ret = CMD_SUCCESS;
 400         unsigned int chan_found = 0;
 401         struct lttng_channel *channels = NULL;
 402
 403         DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
 404
 405         count = lttng_list_channels(handle, &channels);
 406         if (count < 0) {
 407                 ret = count;
 408                 goto error_channels;
 409         } else if (count == 0) {
 410                 ERR("Channel %s not found", channel_name);
 411                 goto error;
 412         }
 413
 414         if (channel_name == NULL) {
 415                 MSG("Channels:\n-------------");
 416         }
 417
 418         for (i = 0; i < count; i++) {
 419                 if (channel_name != NULL) {
 420                         if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
 421                                 chan_found = 1;
 422                         } else {
 423                                 continue;
 424                         }
 425                 }
 426                 print_channel(&channels[i]);
 427
 428                 /* Listing events per channel */
 429                 ret = list_events(channels[i].name);
 430                 if (ret < 0) {
 431                         MSG("%s", lttng_strerror(ret));
 432                 }
 433
 434                 if (chan_found) {
 435                         break;
 436                 }
 437         }
 438
 439         if (!chan_found && channel_name != NULL) {
 440                 ERR("Channel %s not found", channel_name);
 441                 goto error;
 442         }
 443
 444         ret = CMD_SUCCESS;
 445
 446 error:
 447         free(channels);
 448
 449 error_channels:
 450         return ret;
 451 }
 452
 453 /*
 454  * List available tracing session. List only basic information.
 455  *
 456  * If session_name is NULL, all sessions are listed.
 457  */
 458 static int list_sessions(const char *session_name)
 459 {
 460         int ret, count, i;
 461         unsigned int session_found = 0;
 462         struct lttng_session *sessions;
 463
 464         count = lttng_list_sessions(&sessions);
 465         DBG("Session count %d", count);
 466         if (count < 0) {
 467                 ret = count;
 468                 goto error;
 469         }
 470
 471         if (session_name == NULL) {
 472                 MSG("Available tracing sessions:");
 473         }
 474
 475         for (i = 0; i < count; i++) {
 476                 if (session_name != NULL) {
 477                         if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
 478                                 session_found = 1;
 479                                 MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
 480                                 MSG("%sTrace path: %s\n", indent4, sessions[i].path);
 481                                 break;
 482                         }
 483                         continue;
 484                 }
 485
 486                 MSG("  %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path,
 487                                 active_string(sessions[i].enabled));
 488
 489                 if (session_found) {
 490                         break;
 491                 }
 492         }
 493
 494         free(sessions);
 495
 496         if (!session_found && session_name != NULL) {
 497                 ERR("Session '%s' not found", session_name);
 498                 ret = CMD_ERROR;
 499                 goto error;
 500         }
 501
 502         if (session_name == NULL) {
 503                 MSG("\nUse lttng list <session_name> for more details");
 504         }
 505
 506         return CMD_SUCCESS;
 507
 508 error:
 509         return ret;
 510 }
 511
 512 /*
 513  * List available domain(s) for a session.
 514  */
 515 static int list_domains(const char *session_name)
 516 {
 517         int i, count, ret = CMD_SUCCESS;
 518         struct lttng_domain *domains = NULL;
 519
 520         MSG("Domains:\n-------------");
 521
 522         count = lttng_list_domains(session_name, &domains);
 523         if (count < 0) {
 524                 ret = count;
 525                 goto error;
 526         } else if (count == 0) {
 527                 MSG("  None");
 528                 goto end;
 529         }
 530
 531         for (i = 0; i < count; i++) {
 532                 switch (domains[i].type) {
 533                 case LTTNG_DOMAIN_KERNEL:
 534                         MSG("  - Kernel");
 535                         break;
 536                 case LTTNG_DOMAIN_UST:
 537                         MSG("  - UST global");
 538                         break;
 539                 default:
 540                         break;
 541                 }
 542         }
 543
 544 end:
 545         free(domains);
 546
 547 error:
 548         return ret;
 549 }
 550
 551 /*
 552  * The 'list <options>' first level command
 553  */
 554 int cmd_list(int argc, const char **argv)
 555 {
 556         int opt, i, ret = CMD_SUCCESS;
 557         int nb_domain;
 558         const char *session_name;
 559         static poptContext pc;
 560         struct lttng_domain domain;
 561         struct lttng_domain *domains = NULL;
 562
 563         memset(&domain, 0, sizeof(domain));
 564
 565         if (argc < 1) {
 566                 usage(stderr);
 567                 ret = CMD_ERROR;
 568                 goto end;
 569         }
 570
 571         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 572         poptReadDefaultConfig(pc, 0);
 573
 574         while ((opt = poptGetNextOpt(pc)) != -1) {
 575                 switch (opt) {
 576                 case OPT_HELP:
 577                         usage(stdout);
 578                         goto end;
 579                 case OPT_USERSPACE:
 580                         opt_userspace = 1;
 581                         break;
 582                 case OPT_LIST_OPTIONS:
 583                         list_cmd_options(stdout, long_options);
 584                         goto end;
 585                 default:
 586                         usage(stderr);
 587                         ret = CMD_UNDEFINED;
 588                         goto end;
 589                 }
 590         }
 591
 592         /* Get session name (trailing argument) */
 593         session_name = poptGetArg(pc);
 594         DBG2("Session name: %s", session_name);
 595
 596         if (opt_kernel) {
 597                 domain.type = LTTNG_DOMAIN_KERNEL;
 598         } else if (opt_userspace) {
 599                 DBG2("Listing userspace global domain");
 600                 domain.type = LTTNG_DOMAIN_UST;
 601         } else {
 602                 usage(stderr);
 603                 ret = CMD_UNDEFINED;
 604                 goto end;
 605         }
 606
 607         handle = lttng_create_handle(session_name, &domain);
 608         if (handle == NULL) {
 609                 ret = CMD_FATAL;
 610                 goto end;
 611         }
 612
 613         if (session_name == NULL) {
 614                 if (!opt_kernel && !opt_userspace) {
 615                         ret = list_sessions(NULL);
 616                         if (ret != 0) {
 617                                 goto end;
 618                         }
 619                 }
 620                 if (opt_kernel) {
 621                         ret = list_kernel_events();
 622                         if (ret < 0) {
 623                                 goto end;
 624                         }
 625                 }
 626                 if (opt_userspace) {
 627                         ret = list_ust_events();
 628                         if (ret < 0) {
 629                                 goto end;
 630                         }
 631                 }
 632         } else {
 633                 /* List session attributes */
 634                 ret = list_sessions(session_name);
 635                 if (ret != 0) {
 636                         goto end;
 637                 }
 638
 639                 /* Domain listing */
 640                 if (opt_domain) {
 641                         ret = list_domains(session_name);
 642                         goto end;
 643                 }
 644
 645                 if (opt_kernel) {
 646                         /* Channel listing */
 647                         ret = list_channels(opt_channel);
 648                         if (ret < 0) {
 649                                 goto end;
 650                         }
 651                 } else {
 652                         /* We want all domain(s) */
 653                         nb_domain = lttng_list_domains(session_name, &domains);
 654                         if (nb_domain < 0) {
 655                                 ret = nb_domain;
 656                                 goto end;
 657                         }
 658
 659                         for (i = 0; i < nb_domain; i++) {
 660                                 switch (domains[i].type) {
 661                                 case LTTNG_DOMAIN_KERNEL:
 662                                         MSG("=== Domain: Kernel ===\n");
 663                                         break;
 664                                 case LTTNG_DOMAIN_UST:
 665                                         MSG("=== Domain: UST global ===\n");
 666                                         break;
 667                                 default:
 668                                         MSG("=== Domain: Unimplemented ===\n");
 669                                         break;
 670                                 }
 671
 672                                 /* Clean handle before creating a new one */
 673                                 lttng_destroy_handle(handle);
 674
 675                                 handle = lttng_create_handle(session_name, &domains[i]);
 676                                 if (handle == NULL) {
 677                                         ret = CMD_FATAL;
 678                                         goto end;
 679                                 }
 680
 681                                 ret = list_channels(opt_channel);
 682                                 if (ret < 0) {
 683                                         goto end;
 684                                 }
 685                         }
 686                 }
 687         }
 688
 689 end:
 690         if (domains) {
 691                 free(domains);
 692         }
 693         lttng_destroy_handle(handle);
 694
 695         poptFreeContext(pc);
 696         return ret;
 697 }