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