usr.sbin/pmc/cmd_pmc_list.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2018, Matthew Macy
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/cpuset.h>
  34 #include <sys/event.h>
  35 #include <sys/queue.h>
  36 #include <sys/socket.h>
  37 #include <sys/stat.h>
  38 #include <sys/sysctl.h>
  39 #include <sys/time.h>
  40 #include <sys/ttycom.h>
  41 #include <sys/user.h>
  42 #include <sys/wait.h>
  43
  44 #include <assert.h>
  45 #include <curses.h>
  46 #include <err.h>
  47 #include <errno.h>
  48 #include <fcntl.h>
  49 #include <getopt.h>
  50 #include <kvm.h>
  51 #include <libgen.h>
  52 #include <limits.h>
  53 #include <locale.h>
  54 #include <math.h>
  55 #include <pmc.h>
  56 #include <pmclog.h>
  57 #include <regex.h>
  58 #include <signal.h>
  59 #include <stdarg.h>
  60 #include <stdint.h>
  61 #include <stdio.h>
  62 #include <stdlib.h>
  63 #include <string.h>
  64 #include <sysexits.h>
  65 #include <unistd.h>
  66
  67 #include <libpmcstat.h>
  68 #include "cmd_pmc.h"
  69
  70
  71 static struct option longopts[] = {
  72         {"long-desc", no_argument, NULL, 'U'},
  73         {"desc", no_argument, NULL, 'u'},
  74         {"full", no_argument, NULL, 'f'},
  75         {NULL, 0, NULL, 0}
  76 };
  77
  78 static void __dead2
  79 usage(void)
  80 {
  81         errx(EX_USAGE,
  82             "\t list events\n"
  83             "\t -u, desc -- short description of event\n"
  84             "\t -U, long-desc -- long description of event\n"
  85             "\t -f, full -- full event details\n"
  86             );
  87 }
  88
  89 int
  90 cmd_pmc_list_events(int argc, char **argv)
  91 {
  92         int do_long_descr, do_descr, do_full;
  93         int option;
  94
  95         do_long_descr = do_descr = do_full = 0;
  96         while ((option = getopt_long(argc, argv, "Uuf", longopts, NULL)) != -1) {
  97                 switch (option) {
  98                 case 'U':
  99                         do_long_descr = 1;
 100                         break;
 101                 case 'u':
 102                         do_descr = 1;
 103                         break;
 104                 case 'f':
 105                         do_full = 1;
 106                         break;
 107                 case '?':
 108                 default:
 109                         usage();
 110                 }
 111         }
 112         argc -= optind;
 113         argv += optind;
 114         if ((do_long_descr | do_descr | do_full) && argc == 0) {
 115                 warnx("event or event substring required when option provided\n");
 116                 usage();
 117         }
 118         if (do_full)
 119                 pmc_pmu_print_counter_full(argc ? argv[0] : NULL);
 120         else if (do_long_descr)
 121                 pmc_pmu_print_counter_desc_long(argv[0]);
 122         else if (do_descr)
 123                 pmc_pmu_print_counter_desc(argv[0]);
 124         else
 125                 pmc_pmu_print_counters(argv[0]);
 126
 127         return (0);
 128 }