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