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