tools/perf/builtin-bench.c

   1 /*
   2  * builtin-bench.c
   3  *
   4  * General benchmarking collections provided by perf
   5  *
   6  * Copyright (C) 2009, Hitoshi Mitake <mitake@dcl.info.waseda.ac.jp>
   7  */
   8
   9 /*
  10  * Available benchmark collection list:
  11  *
  12  *  sched ... scheduler and IPC performance
  13  *  mem   ... memory access performance
  14  *  numa  ... NUMA scheduling and MM performance
  15  *  futex ... Futex performance
  16  */
  17 #include "perf.h"
  18 #include "util/util.h"
  19 #include "util/parse-options.h"
  20 #include "builtin.h"
  21 #include "bench/bench.h"
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <sys/prctl.h>
  27
  28 typedef int (*bench_fn_t)(int argc, const char **argv, const char *prefix);
  29
  30 struct bench {
  31         const char      *name;
  32         const char      *summary;
  33         bench_fn_t      fn;
  34 };
  35
  36 #ifdef HAVE_LIBNUMA_SUPPORT
  37 static struct bench numa_benchmarks[] = {
  38         { "mem",        "Benchmark for NUMA workloads",                 bench_numa              },
  39         { "all",        "Test all NUMA benchmarks",                     NULL                    },
  40         { NULL,         NULL,                                           NULL                    }
  41 };
  42 #endif
  43
  44 static struct bench sched_benchmarks[] = {
  45         { "messaging",  "Benchmark for scheduling and IPC",             bench_sched_messaging   },
  46         { "pipe",       "Benchmark for pipe() between two processes",   bench_sched_pipe        },
  47         { "all",        "Test all scheduler benchmarks",                NULL                    },
  48         { NULL,         NULL,                                           NULL                    }
  49 };
  50
  51 static struct bench mem_benchmarks[] = {
  52         { "memcpy",     "Benchmark for memcpy()",                       bench_mem_memcpy        },
  53         { "memset",     "Benchmark for memset() tests",                 bench_mem_memset        },
  54         { "all",        "Test all memory benchmarks",                   NULL                    },
  55         { NULL,         NULL,                                           NULL                    }
  56 };
  57
  58 static struct bench futex_benchmarks[] = {
  59         { "hash",       "Benchmark for futex hash table",               bench_futex_hash        },
  60         { "wake",       "Benchmark for futex wake calls",               bench_futex_wake        },
  61         { "requeue",    "Benchmark for futex requeue calls",            bench_futex_requeue     },
  62         { "all",        "Test all futex benchmarks",                    NULL                    },
  63         { NULL,         NULL,                                           NULL                    }
  64 };
  65
  66 struct collection {
  67         const char      *name;
  68         const char      *summary;
  69         struct bench    *benchmarks;
  70 };
  71
  72 static struct collection collections[] = {
  73         { "sched",      "Scheduler and IPC benchmarks",                 sched_benchmarks        },
  74         { "mem",        "Memory access benchmarks",                     mem_benchmarks          },
  75 #ifdef HAVE_LIBNUMA_SUPPORT
  76         { "numa",       "NUMA scheduling and MM benchmarks",            numa_benchmarks         },
  77 #endif
  78         {"futex",       "Futex stressing benchmarks",                   futex_benchmarks        },
  79         { "all",        "All benchmarks",                               NULL                    },
  80         { NULL,         NULL,                                           NULL                    }
  81 };
  82
  83 /* Iterate over all benchmark collections: */
  84 #define for_each_collection(coll) \
  85         for (coll = collections; coll->name; coll++)
  86
  87 /* Iterate over all benchmarks within a collection: */
  88 #define for_each_bench(coll, bench) \
  89         for (bench = coll->benchmarks; bench && bench->name; bench++)
  90
  91 static void dump_benchmarks(struct collection *coll)
  92 {
  93         struct bench *bench;
  94
  95         printf("\n        # List of available benchmarks for collection '%s':\n\n", coll->name);
  96
  97         for_each_bench(coll, bench)
  98                 printf("%14s: %s\n", bench->name, bench->summary);
  99
 100         printf("\n");
 101 }
 102
 103 static const char *bench_format_str;
 104
 105 /* Output/formatting style, exported to benchmark modules: */
 106 int bench_format = BENCH_FORMAT_DEFAULT;
 107
 108 static const struct option bench_options[] = {
 109         OPT_STRING('f', "format", &bench_format_str, "default", "Specify format style"),
 110         OPT_END()
 111 };
 112
 113 static const char * const bench_usage[] = {
 114         "perf bench [<common options>] <collection> <benchmark> [<options>]",
 115         NULL
 116 };
 117
 118 static void print_usage(void)
 119 {
 120         struct collection *coll;
 121         int i;
 122
 123         printf("Usage: \n");
 124         for (i = 0; bench_usage[i]; i++)
 125                 printf("\t%s\n", bench_usage[i]);
 126         printf("\n");
 127
 128         printf("        # List of all available benchmark collections:\n\n");
 129
 130         for_each_collection(coll)
 131                 printf("%14s: %s\n", coll->name, coll->summary);
 132         printf("\n");
 133 }
 134
 135 static int bench_str2int(const char *str)
 136 {
 137         if (!str)
 138                 return BENCH_FORMAT_DEFAULT;
 139
 140         if (!strcmp(str, BENCH_FORMAT_DEFAULT_STR))
 141                 return BENCH_FORMAT_DEFAULT;
 142         else if (!strcmp(str, BENCH_FORMAT_SIMPLE_STR))
 143                 return BENCH_FORMAT_SIMPLE;
 144
 145         return BENCH_FORMAT_UNKNOWN;
 146 }
 147
 148 /*
 149  * Run a specific benchmark but first rename the running task's ->comm[]
 150  * to something meaningful:
 151  */
 152 static int run_bench(const char *coll_name, const char *bench_name, bench_fn_t fn,
 153                      int argc, const char **argv, const char *prefix)
 154 {
 155         int size;
 156         char *name;
 157         int ret;
 158
 159         size = strlen(coll_name) + 1 + strlen(bench_name) + 1;
 160
 161         name = zalloc(size);
 162         BUG_ON(!name);
 163
 164         scnprintf(name, size, "%s-%s", coll_name, bench_name);
 165
 166         prctl(PR_SET_NAME, name);
 167         argv[0] = name;
 168
 169         ret = fn(argc, argv, prefix);
 170
 171         free(name);
 172
 173         return ret;
 174 }
 175
 176 static void run_collection(struct collection *coll)
 177 {
 178         struct bench *bench;
 179         const char *argv[2];
 180
 181         argv[1] = NULL;
 182         /*
 183          * TODO:
 184          *
 185          * Preparing preset parameters for
 186          * embedded, ordinary PC, HPC, etc...
 187          * would be helpful.
 188          */
 189         for_each_bench(coll, bench) {
 190                 if (!bench->fn)
 191                         break;
 192                 printf("# Running %s/%s benchmark...\n", coll->name, bench->name);
 193                 fflush(stdout);
 194
 195                 argv[1] = bench->name;
 196                 run_bench(coll->name, bench->name, bench->fn, 1, argv, NULL);
 197                 printf("\n");
 198         }
 199 }
 200
 201 static void run_all_collections(void)
 202 {
 203         struct collection *coll;
 204
 205         for_each_collection(coll)
 206                 run_collection(coll);
 207 }
 208
 209 int cmd_bench(int argc, const char **argv, const char *prefix __maybe_unused)
 210 {
 211         struct collection *coll;
 212         int ret = 0;
 213
 214         if (argc < 2) {
 215                 /* No collection specified. */
 216                 print_usage();
 217                 goto end;
 218         }
 219
 220         argc = parse_options(argc, argv, bench_options, bench_usage,
 221                              PARSE_OPT_STOP_AT_NON_OPTION);
 222
 223         bench_format = bench_str2int(bench_format_str);
 224         if (bench_format == BENCH_FORMAT_UNKNOWN) {
 225                 printf("Unknown format descriptor: '%s'\n", bench_format_str);
 226                 goto end;
 227         }
 228
 229         if (argc < 1) {
 230                 print_usage();
 231                 goto end;
 232         }
 233
 234         if (!strcmp(argv[0], "all")) {
 235                 run_all_collections();
 236                 goto end;
 237         }
 238
 239         for_each_collection(coll) {
 240                 struct bench *bench;
 241
 242                 if (strcmp(coll->name, argv[0]))
 243                         continue;
 244
 245                 if (argc < 2) {
 246                         /* No bench specified. */
 247                         dump_benchmarks(coll);
 248                         goto end;
 249                 }
 250
 251                 if (!strcmp(argv[1], "all")) {
 252                         run_collection(coll);
 253                         goto end;
 254                 }
 255
 256                 for_each_bench(coll, bench) {
 257                         if (strcmp(bench->name, argv[1]))
 258                                 continue;
 259
 260                         if (bench_format == BENCH_FORMAT_DEFAULT)
 261                                 printf("# Running '%s/%s' benchmark:\n", coll->name, bench->name);
 262                         fflush(stdout);
 263                         ret = run_bench(coll->name, bench->name, bench->fn, argc-1, argv+1, prefix);
 264                         goto end;
 265                 }
 266
 267                 if (!strcmp(argv[1], "-h") || !strcmp(argv[1], "--help")) {
 268                         dump_benchmarks(coll);
 269                         goto end;
 270                 }
 271
 272                 printf("Unknown benchmark: '%s' for collection '%s'\n", argv[1], argv[0]);
 273                 ret = 1;
 274                 goto end;
 275         }
 276
 277         printf("Unknown collection: '%s'\n", argv[0]);
 278         ret = 1;
 279
 280 end:
 281         return ret;
 282 }