tools/perf/builtin-list.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * builtin-list.c
   4  *
   5  * Builtin list command: list all event types
   6  *
   7  * Copyright (C) 2009, Thomas Gleixner <tglx@linutronix.de>
   8  * Copyright (C) 2008-2009, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
   9  * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
  10  */
  11 #include "builtin.h"
  12
  13 #include "perf.h"
  14
  15 #include "util/parse-events.h"
  16 #include "util/cache.h"
  17 #include "util/pmu.h"
  18 #include "util/debug.h"
  19 #include <subcmd/parse-options.h>
  20
  21 static bool desc_flag = true;
  22 static bool details_flag;
  23
  24 int cmd_list(int argc, const char **argv)
  25 {
  26         int i;
  27         bool raw_dump = false;
  28         bool long_desc_flag = false;
  29         struct option list_options[] = {
  30                 OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
  31                 OPT_BOOLEAN('d', "desc", &desc_flag,
  32                             "Print extra event descriptions. --no-desc to not print."),
  33                 OPT_BOOLEAN('v', "long-desc", &long_desc_flag,
  34                             "Print longer event descriptions."),
  35                 OPT_BOOLEAN(0, "details", &details_flag,
  36                             "Print information on the perf event names and expressions used internally by events."),
  37                 OPT_INCR(0, "debug", &verbose,
  38                              "Enable debugging output"),
  39                 OPT_END()
  40         };
  41         const char * const list_usage[] = {
  42                 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|event_glob]",
  43                 NULL
  44         };
  45
  46         set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
  47
  48         argc = parse_options(argc, argv, list_options, list_usage,
  49                              PARSE_OPT_STOP_AT_NON_OPTION);
  50
  51         setup_pager();
  52
  53         if (!raw_dump && pager_in_use())
  54                 printf("\nList of pre-defined events (to be used in -e):\n\n");
  55
  56         if (argc == 0) {
  57                 print_events(NULL, raw_dump, !desc_flag, long_desc_flag,
  58                                 details_flag);
  59                 return 0;
  60         }
  61
  62         for (i = 0; i < argc; ++i) {
  63                 char *sep, *s;
  64
  65                 if (strcmp(argv[i], "tracepoint") == 0)
  66                         print_tracepoint_events(NULL, NULL, raw_dump);
  67                 else if (strcmp(argv[i], "hw") == 0 ||
  68                          strcmp(argv[i], "hardware") == 0)
  69                         print_symbol_events(NULL, PERF_TYPE_HARDWARE,
  70                                         event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
  71                 else if (strcmp(argv[i], "sw") == 0 ||
  72                          strcmp(argv[i], "software") == 0)
  73                         print_symbol_events(NULL, PERF_TYPE_SOFTWARE,
  74                                         event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
  75                 else if (strcmp(argv[i], "cache") == 0 ||
  76                          strcmp(argv[i], "hwcache") == 0)
  77                         print_hwcache_events(NULL, raw_dump);
  78                 else if (strcmp(argv[i], "pmu") == 0)
  79                         print_pmu_events(NULL, raw_dump, !desc_flag,
  80                                                 long_desc_flag, details_flag);
  81                 else if (strcmp(argv[i], "sdt") == 0)
  82                         print_sdt_events(NULL, NULL, raw_dump);
  83                 else if ((sep = strchr(argv[i], ':')) != NULL) {
  84                         int sep_idx;
  85
  86                         if (sep == NULL) {
  87                                 print_events(argv[i], raw_dump, !desc_flag,
  88                                                         long_desc_flag,
  89                                                         details_flag);
  90                                 continue;
  91                         }
  92                         sep_idx = sep - argv[i];
  93                         s = strdup(argv[i]);
  94                         if (s == NULL)
  95                                 return -1;
  96
  97                         s[sep_idx] = '\0';
  98                         print_tracepoint_events(s, s + sep_idx + 1, raw_dump);
  99                         print_sdt_events(s, s + sep_idx + 1, raw_dump);
 100                         free(s);
 101                 } else {
 102                         if (asprintf(&s, "*%s*", argv[i]) < 0) {
 103                                 printf("Critical: Not enough memory! Trying to continue...\n");
 104                                 continue;
 105                         }
 106                         print_symbol_events(s, PERF_TYPE_HARDWARE,
 107                                             event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
 108                         print_symbol_events(s, PERF_TYPE_SOFTWARE,
 109                                             event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
 110                         print_hwcache_events(s, raw_dump);
 111                         print_pmu_events(s, raw_dump, !desc_flag,
 112                                                 long_desc_flag,
 113                                                 details_flag);
 114                         print_tracepoint_events(NULL, s, raw_dump);
 115                         print_sdt_events(NULL, s, raw_dump);
 116                         free(s);
 117                 }
 118         }
 119         return 0;
 120 }