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 modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program 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
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <inttypes.h>
  20 #include <popt.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <assert.h>
  25
  26 #include "../command.h"
  27
  28 static int opt_userspace;
  29 static int opt_kernel;
  30 static int opt_jul;
  31 static char *opt_channel;
  32 static int opt_domain;
  33 static int opt_fields;
  34 #if 0
  35 /* Not implemented yet */
  36 static char *opt_cmd_name;
  37 static pid_t opt_pid;
  38 #endif
  39
  40 const char *indent4 = "    ";
  41 const char *indent6 = "      ";
  42 const char *indent8 = "        ";
  43
  44 enum {
  45         OPT_HELP = 1,
  46         OPT_USERSPACE,
  47         OPT_LIST_OPTIONS,
  48 };
  49
  50 static struct lttng_handle *handle;
  51
  52 static struct poptOption long_options[] = {
  53         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  54         {"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  55         {"kernel",    'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  56         {"jul",       'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0},
  57 #if 0
  58         /* Not implemented yet */
  59         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  60         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  61 #else
  62         {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
  63 #endif
  64         {"channel",   'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
  65         {"domain",    'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
  66         {"fields",    'f', POPT_ARG_VAL, &opt_fields, 1, 0, 0},
  67         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  68         {0, 0, 0, 0, 0, 0, 0}
  69 };
  70
  71 /*
  72  * usage
  73  */
  74 static void usage(FILE *ofp)
  75 {
  76         fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
  77         fprintf(ofp, "\n");
  78         fprintf(ofp, "With no arguments, list available tracing session(s)\n");
  79         fprintf(ofp, "\n");
  80         fprintf(ofp, "Without a session, -k lists available kernel events\n");
  81         fprintf(ofp, "Without a session, -u lists available userspace events\n");
  82         fprintf(ofp, "\n");
  83         fprintf(ofp, "  -h, --help              Show this help\n");
  84         fprintf(ofp, "      --list-options      Simple listing of options\n");
  85         fprintf(ofp, "  -k, --kernel            Select kernel domain\n");
  86         fprintf(ofp, "  -u, --userspace         Select user-space domain.\n");
  87         fprintf(ofp, "  -j, --jul               Apply for Java application using JUL\n");
  88         fprintf(ofp, "  -f, --fields            List event fields.\n");
  89 #if 0
  90         fprintf(ofp, "  -p, --pid PID           List user-space events by PID\n");
  91 #endif
  92         fprintf(ofp, "\n");
  93         fprintf(ofp, "Session Options:\n");
  94         fprintf(ofp, "  -c, --channel NAME      List details of a channel\n");
  95         fprintf(ofp, "  -d, --domain            List available domain(s)\n");
  96         fprintf(ofp, "\n");
  97 }
  98
  99 /*
 100  * Get command line from /proc for a specific pid.
 101  *
 102  * On success, return an allocated string pointer to the proc cmdline.
 103  * On error, return NULL.
 104  */
 105 static char *get_cmdline_by_pid(pid_t pid)
 106 {
 107         int ret;
 108         FILE *fp;
 109         char *cmdline = NULL;
 110         char path[24];  /* Can't go bigger than /proc/65535/cmdline */
 111
 112         snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
 113         fp = fopen(path, "r");
 114         if (fp == NULL) {
 115                 goto end;
 116         }
 117
 118         /* Caller must free() *cmdline */
 119         cmdline = malloc(PATH_MAX);
 120         ret = fread(cmdline, 1, PATH_MAX, fp);
 121         if (ret < 0) {
 122                 perror("fread proc list");
 123         }
 124         fclose(fp);
 125
 126 end:
 127         return cmdline;
 128 }
 129
 130 static
 131 const char *active_string(int value)
 132 {
 133         switch (value) {
 134         case 0: return "inactive";
 135         case 1: return "active";
 136         case -1: return "";
 137         default: return NULL;
 138         }
 139 }
 140
 141 static const char *snapshot_string(int value)
 142 {
 143         switch (value) {
 144         case 1:
 145                 return " snapshot";
 146         default:
 147                 return "";
 148         }
 149 }
 150
 151 static
 152 const char *enabled_string(int value)
 153 {
 154         switch (value) {
 155         case 0: return " [disabled]";
 156         case 1: return " [enabled]";
 157         case -1: return "";
 158         default: return NULL;
 159         }
 160 }
 161
 162 static
 163 const char *filter_string(int value)
 164 {
 165         switch (value) {
 166         case 1: return " [with filter]";
 167         default: return "";
 168         }
 169 }
 170
 171 static
 172 const char *exclusion_string(int value)
 173 {
 174         switch (value) {
 175         case 1: return " [has exclusions]";
 176         default: return "";
 177         }
 178 }
 179
 180 static const char *loglevel_string(int value)
 181 {
 182         switch (value) {
 183         case -1:
 184                 return "";
 185         case LTTNG_LOGLEVEL_EMERG:
 186                 return "TRACE_EMERG";
 187         case LTTNG_LOGLEVEL_ALERT:
 188                 return "TRACE_ALERT";
 189         case LTTNG_LOGLEVEL_CRIT:
 190                 return "TRACE_CRIT";
 191         case LTTNG_LOGLEVEL_ERR:
 192                 return "TRACE_ERR";
 193         case LTTNG_LOGLEVEL_WARNING:
 194                 return "TRACE_WARNING";
 195         case LTTNG_LOGLEVEL_NOTICE:
 196                 return "TRACE_NOTICE";
 197         case LTTNG_LOGLEVEL_INFO:
 198                 return "TRACE_INFO";
 199         case LTTNG_LOGLEVEL_DEBUG_SYSTEM:
 200                 return "TRACE_DEBUG_SYSTEM";
 201         case LTTNG_LOGLEVEL_DEBUG_PROGRAM:
 202                 return "TRACE_DEBUG_PROGRAM";
 203         case LTTNG_LOGLEVEL_DEBUG_PROCESS:
 204                 return "TRACE_DEBUG_PROCESS";
 205         case LTTNG_LOGLEVEL_DEBUG_MODULE:
 206                 return "TRACE_DEBUG_MODULE";
 207         case LTTNG_LOGLEVEL_DEBUG_UNIT:
 208                 return "TRACE_DEBUG_UNIT";
 209         case LTTNG_LOGLEVEL_DEBUG_FUNCTION:
 210                 return "TRACE_DEBUG_FUNCTION";
 211         case LTTNG_LOGLEVEL_DEBUG_LINE:
 212                 return "TRACE_DEBUG_LINE";
 213         case LTTNG_LOGLEVEL_DEBUG:
 214                 return "TRACE_DEBUG";
 215         default:
 216                 return "<<UNKNOWN>>";
 217         }
 218 }
 219
 220 static const char *logleveltype_string(enum lttng_loglevel_type value)
 221 {
 222         switch (value) {
 223         case LTTNG_EVENT_LOGLEVEL_ALL:
 224                 return ":";
 225         case LTTNG_EVENT_LOGLEVEL_RANGE:
 226                 return " <=";
 227         case LTTNG_EVENT_LOGLEVEL_SINGLE:
 228                 return " ==";
 229         default:
 230                 return " <<TYPE UNKN>>";
 231         }
 232 }
 233
 234 /*
 235  * Pretty print single event.
 236  */
 237 static void print_events(struct lttng_event *event)
 238 {
 239         switch (event->type) {
 240         case LTTNG_EVENT_TRACEPOINT:
 241         {
 242                 if (event->loglevel != -1) {
 243                         MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
 244                                 indent6,
 245                                 event->name,
 246                                 logleveltype_string(event->loglevel_type),
 247                                 loglevel_string(event->loglevel),
 248                                 event->loglevel,
 249                                 enabled_string(event->enabled),
 250                                 exclusion_string(event->exclusion),
 251                                 filter_string(event->filter));
 252                 } else {
 253                         MSG("%s%s (type: tracepoint)%s%s%s",
 254                                 indent6,
 255                                 event->name,
 256                                 enabled_string(event->enabled),
 257                                 exclusion_string(event->exclusion),
 258                                 filter_string(event->filter));
 259                 }
 260                 break;
 261         }
 262         case LTTNG_EVENT_FUNCTION:
 263                 MSG("%s%s (type: function)%s%s", indent6,
 264                                 event->name, enabled_string(event->enabled),
 265                                 filter_string(event->filter));
 266                 if (event->attr.probe.addr != 0) {
 267                         MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
 268                 } else {
 269                         MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
 270                         MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
 271                 }
 272                 break;
 273         case LTTNG_EVENT_PROBE:
 274                 MSG("%s%s (type: probe)%s%s", indent6,
 275                                 event->name, enabled_string(event->enabled),
 276                                 filter_string(event->filter));
 277                 if (event->attr.probe.addr != 0) {
 278                         MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
 279                 } else {
 280                         MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
 281                         MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
 282                 }
 283                 break;
 284         case LTTNG_EVENT_FUNCTION_ENTRY:
 285                 MSG("%s%s (type: function)%s%s", indent6,
 286                                 event->name, enabled_string(event->enabled),
 287                                 filter_string(event->filter));
 288                 MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
 289                 break;
 290         case LTTNG_EVENT_SYSCALL:
 291                 MSG("%ssyscalls (type: syscall)%s%s", indent6,
 292                                 enabled_string(event->enabled),
 293                                 filter_string(event->filter));
 294                 break;
 295         case LTTNG_EVENT_NOOP:
 296                 MSG("%s (type: noop)%s%s", indent6,
 297                                 enabled_string(event->enabled),
 298                                 filter_string(event->filter));
 299                 break;
 300         case LTTNG_EVENT_ALL:
 301                 /* We should never have "all" events in list. */
 302                 assert(0);
 303                 break;
 304         }
 305 }
 306
 307 static const char *field_type(struct lttng_event_field *field)
 308 {
 309         switch(field->type) {
 310         case LTTNG_EVENT_FIELD_INTEGER:
 311                 return "integer";
 312         case LTTNG_EVENT_FIELD_ENUM:
 313                 return "enum";
 314         case LTTNG_EVENT_FIELD_FLOAT:
 315                 return "float";
 316         case LTTNG_EVENT_FIELD_STRING:
 317                 return "string";
 318         case LTTNG_EVENT_FIELD_OTHER:
 319         default:        /* fall-through */
 320                 return "unknown";
 321         }
 322 }
 323
 324 /*
 325  * Pretty print single event fields.
 326  */
 327 static void print_event_field(struct lttng_event_field *field)
 328 {
 329         if (!field->field_name[0]) {
 330                 return;
 331         }
 332         MSG("%sfield: %s (%s)%s", indent8, field->field_name,
 333                 field_type(field), field->nowrite ? " [no write]" : "");
 334 }
 335
 336 static int list_jul_events(void)
 337 {
 338         int i, size;
 339         struct lttng_domain domain;
 340         struct lttng_handle *handle;
 341         struct lttng_event *event_list;
 342         pid_t cur_pid = 0;
 343         char *cmdline = NULL;
 344
 345         DBG("Getting JUL tracing events");
 346
 347         memset(&domain, 0, sizeof(domain));
 348         domain.type = LTTNG_DOMAIN_JUL;
 349
 350         handle = lttng_create_handle(NULL, &domain);
 351         if (handle == NULL) {
 352                 goto error;
 353         }
 354
 355         size = lttng_list_tracepoints(handle, &event_list);
 356         if (size < 0) {
 357                 ERR("Unable to list JUL events: %s", lttng_strerror(size));
 358                 lttng_destroy_handle(handle);
 359                 return size;
 360         }
 361
 362         MSG("JUL events (Logger name):\n-------------------------");
 363
 364         if (size == 0) {
 365                 MSG("None");
 366         }
 367
 368         for (i = 0; i < size; i++) {
 369                 if (cur_pid != event_list[i].pid) {
 370                         cur_pid = event_list[i].pid;
 371                         cmdline = get_cmdline_by_pid(cur_pid);
 372                         MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
 373                         free(cmdline);
 374                 }
 375                 MSG("%s- %s", indent6, event_list[i].name);
 376         }
 377
 378         MSG("");
 379
 380         free(event_list);
 381         lttng_destroy_handle(handle);
 382
 383         return CMD_SUCCESS;
 384
 385 error:
 386         lttng_destroy_handle(handle);
 387         return -1;
 388 }
 389
 390 /*
 391  * Ask session daemon for all user space tracepoints available.
 392  */
 393 static int list_ust_events(void)
 394 {
 395         int i, size;
 396         struct lttng_domain domain;
 397         struct lttng_handle *handle;
 398         struct lttng_event *event_list;
 399         pid_t cur_pid = 0;
 400         char *cmdline = NULL;
 401
 402         memset(&domain, 0, sizeof(domain));
 403
 404         DBG("Getting UST tracing events");
 405
 406         domain.type = LTTNG_DOMAIN_UST;
 407
 408         handle = lttng_create_handle(NULL, &domain);
 409         if (handle == NULL) {
 410                 goto error;
 411         }
 412
 413         size = lttng_list_tracepoints(handle, &event_list);
 414         if (size < 0) {
 415                 ERR("Unable to list UST events: %s", lttng_strerror(size));
 416                 lttng_destroy_handle(handle);
 417                 return size;
 418         }
 419
 420         MSG("UST events:\n-------------");
 421
 422         if (size == 0) {
 423                 MSG("None");
 424         }
 425
 426         for (i = 0; i < size; i++) {
 427                 if (cur_pid != event_list[i].pid) {
 428                         cur_pid = event_list[i].pid;
 429                         cmdline = get_cmdline_by_pid(cur_pid);
 430                         MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
 431                         free(cmdline);
 432                 }
 433                 print_events(&event_list[i]);
 434         }
 435
 436         MSG("");
 437
 438         free(event_list);
 439         lttng_destroy_handle(handle);
 440
 441         return CMD_SUCCESS;
 442
 443 error:
 444         lttng_destroy_handle(handle);
 445         return -1;
 446 }
 447
 448 /*
 449  * Ask session daemon for all user space tracepoint fields available.
 450  */
 451 static int list_ust_event_fields(void)
 452 {
 453         int i, size;
 454         struct lttng_domain domain;
 455         struct lttng_handle *handle;
 456         struct lttng_event_field *event_field_list;
 457         pid_t cur_pid = 0;
 458         char *cmdline = NULL;
 459
 460         struct lttng_event cur_event;
 461
 462         memset(&domain, 0, sizeof(domain));
 463         memset(&cur_event, 0, sizeof(cur_event));
 464
 465         DBG("Getting UST tracing event fields");
 466
 467         domain.type = LTTNG_DOMAIN_UST;
 468
 469         handle = lttng_create_handle(NULL, &domain);
 470         if (handle == NULL) {
 471                 goto error;
 472         }
 473
 474         size = lttng_list_tracepoint_fields(handle, &event_field_list);
 475         if (size < 0) {
 476                 ERR("Unable to list UST event fields: %s", lttng_strerror(size));
 477                 lttng_destroy_handle(handle);
 478                 return size;
 479         }
 480
 481         MSG("UST events:\n-------------");
 482
 483         if (size == 0) {
 484                 MSG("None");
 485         }
 486
 487         for (i = 0; i < size; i++) {
 488                 if (cur_pid != event_field_list[i].event.pid) {
 489                         cur_pid = event_field_list[i].event.pid;
 490                         cmdline = get_cmdline_by_pid(cur_pid);
 491                         MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
 492                         free(cmdline);
 493                         /* Wipe current event since we are about to print a new PID. */
 494                         memset(&cur_event, 0, sizeof(cur_event));
 495                 }
 496                 if (strcmp(cur_event.name, event_field_list[i].event.name) != 0) {
 497                         print_events(&event_field_list[i].event);
 498                         memcpy(&cur_event, &event_field_list[i].event,
 499                                 sizeof(cur_event));
 500                 }
 501                 print_event_field(&event_field_list[i]);
 502         }
 503
 504         MSG("");
 505
 506         free(event_field_list);
 507         lttng_destroy_handle(handle);
 508
 509         return CMD_SUCCESS;
 510
 511 error:
 512         lttng_destroy_handle(handle);
 513         return -1;
 514 }
 515
 516 /*
 517  * Ask for all trace events in the kernel and pretty print them.
 518  */
 519 static int list_kernel_events(void)
 520 {
 521         int i, size;
 522         struct lttng_domain domain;
 523         struct lttng_handle *handle;
 524         struct lttng_event *event_list;
 525
 526         memset(&domain, 0, sizeof(domain));
 527
 528         DBG("Getting kernel tracing events");
 529
 530         domain.type = LTTNG_DOMAIN_KERNEL;
 531
 532         handle = lttng_create_handle(NULL, &domain);
 533         if (handle == NULL) {
 534                 goto error;
 535         }
 536
 537         size = lttng_list_tracepoints(handle, &event_list);
 538         if (size < 0) {
 539                 ERR("Unable to list kernel events: %s", lttng_strerror(size));
 540                 lttng_destroy_handle(handle);
 541                 return size;
 542         }
 543
 544         MSG("Kernel events:\n-------------");
 545
 546         for (i = 0; i < size; i++) {
 547                 print_events(&event_list[i]);
 548         }
 549
 550         MSG("");
 551
 552         free(event_list);
 553
 554         lttng_destroy_handle(handle);
 555         return CMD_SUCCESS;
 556
 557 error:
 558         lttng_destroy_handle(handle);
 559         return -1;
 560 }
 561
 562 /*
 563  * List JUL events for a specific session using the handle.
 564  *
 565  * Return CMD_SUCCESS on success else a negative value.
 566  */
 567 static int list_session_jul_events(void)
 568 {
 569         int ret, count, i;
 570         struct lttng_event *events = NULL;
 571
 572         count = lttng_list_events(handle, "", &events);
 573         if (count < 0) {
 574                 ret = count;
 575                 ERR("%s", lttng_strerror(ret));
 576                 goto error;
 577         }
 578
 579         MSG("Events (Logger name):\n---------------------");
 580         if (count == 0) {
 581                 MSG("%sNone\n", indent6);
 582                 goto end;
 583         }
 584
 585         for (i = 0; i < count; i++) {
 586                 MSG("%s- %s%s", indent4, events[i].name,
 587                                 enabled_string(events[i].enabled));
 588         }
 589
 590         MSG("");
 591
 592 end:
 593         free(events);
 594         ret = CMD_SUCCESS;
 595
 596 error:
 597         return ret;
 598 }
 599
 600 /*
 601  * List events of channel of session and domain.
 602  */
 603 static int list_events(const char *channel_name)
 604 {
 605         int ret, count, i;
 606         struct lttng_event *events = NULL;
 607
 608         count = lttng_list_events(handle, channel_name, &events);
 609         if (count < 0) {
 610                 ret = count;
 611                 ERR("%s", lttng_strerror(ret));
 612                 goto error;
 613         }
 614
 615         MSG("\n%sEvents:", indent4);
 616         if (count == 0) {
 617                 MSG("%sNone\n", indent6);
 618                 goto end;
 619         }
 620
 621         for (i = 0; i < count; i++) {
 622                 print_events(&events[i]);
 623         }
 624
 625         MSG("");
 626
 627 end:
 628         free(events);
 629         ret = CMD_SUCCESS;
 630
 631 error:
 632         return ret;
 633 }
 634
 635 /*
 636  * Pretty print channel
 637  */
 638 static void print_channel(struct lttng_channel *channel)
 639 {
 640         MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
 641
 642         MSG("%sAttributes:", indent4);
 643         MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
 644         MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
 645         MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
 646         MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
 647         MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
 648         switch (channel->attr.output) {
 649                 case LTTNG_EVENT_SPLICE:
 650                         MSG("%soutput: splice()", indent6);
 651                         break;
 652                 case LTTNG_EVENT_MMAP:
 653                         MSG("%soutput: mmap()", indent6);
 654                         break;
 655         }
 656 }
 657
 658 /*
 659  * List channel(s) of session and domain.
 660  *
 661  * If channel_name is NULL, all channels are listed.
 662  */
 663 static int list_channels(const char *channel_name)
 664 {
 665         int count, i, ret = CMD_SUCCESS;
 666         unsigned int chan_found = 0;
 667         struct lttng_channel *channels = NULL;
 668
 669         DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
 670
 671         count = lttng_list_channels(handle, &channels);
 672         if (count < 0) {
 673                 switch (-count) {
 674                 case LTTNG_ERR_KERN_CHAN_NOT_FOUND:
 675                         ret = CMD_SUCCESS;
 676                         WARN("No kernel channel");
 677                         break;
 678                 default:
 679                         /* We had a real error */
 680                         ret = count;
 681                         ERR("%s", lttng_strerror(ret));
 682                         break;
 683                 }
 684                 goto error_channels;
 685         }
 686
 687         if (channel_name == NULL) {
 688                 MSG("Channels:\n-------------");
 689         }
 690
 691         for (i = 0; i < count; i++) {
 692                 if (channel_name != NULL) {
 693                         if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
 694                                 chan_found = 1;
 695                         } else {
 696                                 continue;
 697                         }
 698                 }
 699                 print_channel(&channels[i]);
 700
 701                 /* Listing events per channel */
 702                 ret = list_events(channels[i].name);
 703                 if (ret < 0) {
 704                         ERR("%s", lttng_strerror(ret));
 705                 }
 706
 707                 if (chan_found) {
 708                         break;
 709                 }
 710         }
 711
 712         if (!chan_found && channel_name != NULL) {
 713                 ERR("Channel %s not found", channel_name);
 714                 goto error;
 715         }
 716
 717         ret = CMD_SUCCESS;
 718
 719 error:
 720         free(channels);
 721
 722 error_channels:
 723         return ret;
 724 }
 725
 726 /*
 727  * List available tracing session. List only basic information.
 728  *
 729  * If session_name is NULL, all sessions are listed.
 730  */
 731 static int list_sessions(const char *session_name)
 732 {
 733         int ret, count, i;
 734         unsigned int session_found = 0;
 735         struct lttng_session *sessions;
 736
 737         count = lttng_list_sessions(&sessions);
 738         DBG("Session count %d", count);
 739         if (count < 0) {
 740                 ret = count;
 741                 ERR("%s", lttng_strerror(ret));
 742                 goto error;
 743         } else if (count == 0) {
 744                 MSG("Currently no available tracing session");
 745                 goto end;
 746         }
 747
 748         if (session_name == NULL) {
 749                 MSG("Available tracing sessions:");
 750         }
 751
 752         for (i = 0; i < count; i++) {
 753                 if (session_name != NULL) {
 754                         if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
 755                                 session_found = 1;
 756                                 MSG("Tracing session %s: [%s%s]", session_name,
 757                                                 active_string(sessions[i].enabled),
 758                                                 snapshot_string(sessions[i].snapshot_mode));
 759                                 MSG("%sTrace path: %s\n", indent4, sessions[i].path);
 760                                 break;
 761                         }
 762                 } else {
 763                         MSG("  %d) %s (%s) [%s%s]", i + 1, sessions[i].name, sessions[i].path,
 764                                         active_string(sessions[i].enabled),
 765                                         snapshot_string(sessions[i].snapshot_mode));
 766                 }
 767         }
 768
 769         free(sessions);
 770
 771         if (!session_found && session_name != NULL) {
 772                 ERR("Session '%s' not found", session_name);
 773                 ret = CMD_ERROR;
 774                 goto error;
 775         }
 776
 777         if (session_name == NULL) {
 778                 MSG("\nUse lttng list <session_name> for more details");
 779         }
 780
 781 end:
 782         return CMD_SUCCESS;
 783
 784 error:
 785         return ret;
 786 }
 787
 788 /*
 789  * List available domain(s) for a session.
 790  */
 791 static int list_domains(const char *session_name)
 792 {
 793         int i, count, ret = CMD_SUCCESS;
 794         struct lttng_domain *domains = NULL;
 795
 796         MSG("Domains:\n-------------");
 797
 798         count = lttng_list_domains(session_name, &domains);
 799         if (count < 0) {
 800                 ret = count;
 801                 ERR("%s", lttng_strerror(ret));
 802                 goto error;
 803         } else if (count == 0) {
 804                 MSG("  None");
 805                 goto end;
 806         }
 807
 808         for (i = 0; i < count; i++) {
 809                 switch (domains[i].type) {
 810                 case LTTNG_DOMAIN_KERNEL:
 811                         MSG("  - Kernel");
 812                         break;
 813                 case LTTNG_DOMAIN_UST:
 814                         MSG("  - UST global");
 815                         break;
 816                 case LTTNG_DOMAIN_JUL:
 817                         MSG("  - JUL (Java Util Logging)");
 818                         break;
 819                 default:
 820                         break;
 821                 }
 822         }
 823
 824 end:
 825         free(domains);
 826
 827 error:
 828         return ret;
 829 }
 830
 831 /*
 832  * The 'list <options>' first level command
 833  */
 834 int cmd_list(int argc, const char **argv)
 835 {
 836         int opt, ret = CMD_SUCCESS;
 837         const char *session_name;
 838         static poptContext pc;
 839         struct lttng_domain domain;
 840         struct lttng_domain *domains = NULL;
 841
 842         memset(&domain, 0, sizeof(domain));
 843
 844         if (argc < 1) {
 845                 usage(stderr);
 846                 ret = CMD_ERROR;
 847                 goto end;
 848         }
 849
 850         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 851         poptReadDefaultConfig(pc, 0);
 852
 853         while ((opt = poptGetNextOpt(pc)) != -1) {
 854                 switch (opt) {
 855                 case OPT_HELP:
 856                         usage(stdout);
 857                         goto end;
 858                 case OPT_USERSPACE:
 859                         opt_userspace = 1;
 860                         break;
 861                 case OPT_LIST_OPTIONS:
 862                         list_cmd_options(stdout, long_options);
 863                         goto end;
 864                 default:
 865                         usage(stderr);
 866                         ret = CMD_UNDEFINED;
 867                         goto end;
 868                 }
 869         }
 870
 871         /* Get session name (trailing argument) */
 872         session_name = poptGetArg(pc);
 873         DBG2("Session name: %s", session_name);
 874
 875         if (opt_kernel) {
 876                 domain.type = LTTNG_DOMAIN_KERNEL;
 877         } else if (opt_userspace) {
 878                 DBG2("Listing userspace global domain");
 879                 domain.type = LTTNG_DOMAIN_UST;
 880         } else if (opt_jul) {
 881                 DBG2("Listing JUL domain");
 882                 domain.type = LTTNG_DOMAIN_JUL;
 883         }
 884
 885         if (opt_kernel || opt_userspace || opt_jul) {
 886                 handle = lttng_create_handle(session_name, &domain);
 887                 if (handle == NULL) {
 888                         ret = CMD_FATAL;
 889                         goto end;
 890                 }
 891         }
 892
 893         if (session_name == NULL) {
 894                 if (!opt_kernel && !opt_userspace && !opt_jul) {
 895                         ret = list_sessions(NULL);
 896                         if (ret != 0) {
 897                                 goto end;
 898                         }
 899                 }
 900                 if (opt_kernel) {
 901                         ret = list_kernel_events();
 902                         if (ret < 0) {
 903                                 ret = CMD_ERROR;
 904                                 goto end;
 905                         }
 906                 }
 907                 if (opt_userspace) {
 908                         if (opt_fields) {
 909                                 ret = list_ust_event_fields();
 910                         } else {
 911                                 ret = list_ust_events();
 912                         }
 913                         if (ret < 0) {
 914                                 ret = CMD_ERROR;
 915                                 goto end;
 916                         }
 917                 }
 918                 if (opt_jul) {
 919                         ret = list_jul_events();
 920                         if (ret < 0) {
 921                                 ret = CMD_ERROR;
 922                                 goto end;
 923                         }
 924                 }
 925         } else {
 926                 /* List session attributes */
 927                 ret = list_sessions(session_name);
 928                 if (ret != 0) {
 929                         goto end;
 930                 }
 931
 932                 /* Domain listing */
 933                 if (opt_domain) {
 934                         ret = list_domains(session_name);
 935                         goto end;
 936                 }
 937
 938                 if (opt_kernel || opt_userspace) {
 939                         /* Channel listing */
 940                         ret = list_channels(opt_channel);
 941                         if (ret < 0) {
 942                                 goto end;
 943                         }
 944                 } else {
 945                         int i, nb_domain;
 946
 947                         /* We want all domain(s) */
 948                         nb_domain = lttng_list_domains(session_name, &domains);
 949                         if (nb_domain < 0) {
 950                                 ret = nb_domain;
 951                                 ERR("%s", lttng_strerror(ret));
 952                                 goto end;
 953                         }
 954
 955                         for (i = 0; i < nb_domain; i++) {
 956                                 switch (domains[i].type) {
 957                                 case LTTNG_DOMAIN_KERNEL:
 958                                         MSG("=== Domain: Kernel ===\n");
 959                                         break;
 960                                 case LTTNG_DOMAIN_UST:
 961                                         MSG("=== Domain: UST global ===\n");
 962                                         MSG("Buffer type: %s\n",
 963                                                         domains[i].buf_type ==
 964                                                         LTTNG_BUFFER_PER_PID ? "per PID" : "per UID");
 965                                         break;
 966                                 case LTTNG_DOMAIN_JUL:
 967                                         MSG("=== Domain: JUL (Java Util Logging) ===\n");
 968                                         break;
 969                                 default:
 970                                         MSG("=== Domain: Unimplemented ===\n");
 971                                         break;
 972                                 }
 973
 974                                 /* Clean handle before creating a new one */
 975                                 if (handle) {
 976                                         lttng_destroy_handle(handle);
 977                                 }
 978
 979                                 handle = lttng_create_handle(session_name, &domains[i]);
 980                                 if (handle == NULL) {
 981                                         ret = CMD_FATAL;
 982                                         goto end;
 983                                 }
 984
 985                                 if (domains[i].type == LTTNG_DOMAIN_JUL) {
 986                                         ret = list_session_jul_events();
 987                                         if (ret < 0) {
 988                                                 goto end;
 989                                         }
 990                                         continue;
 991                                 }
 992
 993                                 ret = list_channels(opt_channel);
 994                                 if (ret < 0) {
 995                                         goto end;
 996                                 }
 997                         }
 998                 }
 999         }
1000
1001 end:
1002         free(domains);
1003         if (handle) {
1004                 lttng_destroy_handle(handle);
1005         }
1006
1007         poptFreeContext(pc);
1008         return ret;
1009 }