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 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 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 59 static 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 67 static 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 79 static 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 87 static struct bench internals_benchmarks[] = { 88 { "synthesize", "Benchmark perf event synthesis", bench_synthesize }, 89 { "kallsyms-parse", "Benchmark kallsyms parsing", bench_kallsyms_parse }, 90 { NULL, NULL, NULL } 91 }; 92 93 struct collection { 94 const char *name; 95 const char *summary; 96 struct bench *benchmarks; 97 }; 98 99 static struct collection collections[] = { 100 { "sched", "Scheduler and IPC benchmarks", sched_benchmarks }, 101 { "syscall", "System call benchmarks", syscall_benchmarks }, 102 { "mem", "Memory access benchmarks", mem_benchmarks }, 103 #ifdef HAVE_LIBNUMA_SUPPORT 104 { "numa", "NUMA scheduling and MM benchmarks", numa_benchmarks }, 105 #endif 106 {"futex", "Futex stressing benchmarks", futex_benchmarks }, 107 #ifdef HAVE_EVENTFD_SUPPORT 108 {"epoll", "Epoll stressing benchmarks", epoll_benchmarks }, 109 #endif 110 { "internals", "Perf-internals benchmarks", internals_benchmarks }, 111 { "all", "All benchmarks", NULL }, 112 { NULL, NULL, NULL } 113 }; 114 115 /* Iterate over all benchmark collections: */ 116 #define for_each_collection(coll) \ 117 for (coll = collections; coll->name; coll++) 118 119 /* Iterate over all benchmarks within a collection: */ 120 #define for_each_bench(coll, bench) \ 121 for (bench = coll->benchmarks; bench && bench->name; bench++) 122 123 static void dump_benchmarks(struct collection *coll) 124 { 125 struct bench *bench; 126 127 printf("\n # List of available benchmarks for collection '%s':\n\n", coll->name); 128 129 for_each_bench(coll, bench) 130 printf("%14s: %s\n", bench->name, bench->summary); 131 132 printf("\n"); 133 } 134 135 static const char *bench_format_str; 136 137 /* Output/formatting style, exported to benchmark modules: */ 138 int bench_format = BENCH_FORMAT_DEFAULT; 139 unsigned int bench_repeat = 10; /* default number of times to repeat the run */ 140 141 static const struct option bench_options[] = { 142 OPT_STRING('f', "format", &bench_format_str, "default|simple", "Specify the output formatting style"), 143 OPT_UINTEGER('r', "repeat", &bench_repeat, "Specify amount of times to repeat the run"), 144 OPT_END() 145 }; 146 147 static const char * const bench_usage[] = { 148 "perf bench [<common options>] <collection> <benchmark> [<options>]", 149 NULL 150 }; 151 152 static void print_usage(void) 153 { 154 struct collection *coll; 155 int i; 156 157 printf("Usage: \n"); 158 for (i = 0; bench_usage[i]; i++) 159 printf("\t%s\n", bench_usage[i]); 160 printf("\n"); 161 162 printf(" # List of all available benchmark collections:\n\n"); 163 164 for_each_collection(coll) 165 printf("%14s: %s\n", coll->name, coll->summary); 166 printf("\n"); 167 } 168 169 static int bench_str2int(const char *str) 170 { 171 if (!str) 172 return BENCH_FORMAT_DEFAULT; 173 174 if (!strcmp(str, BENCH_FORMAT_DEFAULT_STR)) 175 return BENCH_FORMAT_DEFAULT; 176 else if (!strcmp(str, BENCH_FORMAT_SIMPLE_STR)) 177 return BENCH_FORMAT_SIMPLE; 178 179 return BENCH_FORMAT_UNKNOWN; 180 } 181 182 /* 183 * Run a specific benchmark but first rename the running task's ->comm[] 184 * to something meaningful: 185 */ 186 static int run_bench(const char *coll_name, const char *bench_name, bench_fn_t fn, 187 int argc, const char **argv) 188 { 189 int size; 190 char *name; 191 int ret; 192 193 size = strlen(coll_name) + 1 + strlen(bench_name) + 1; 194 195 name = zalloc(size); 196 BUG_ON(!name); 197 198 scnprintf(name, size, "%s-%s", coll_name, bench_name); 199 200 prctl(PR_SET_NAME, name); 201 argv[0] = name; 202 203 ret = fn(argc, argv); 204 205 free(name); 206 207 return ret; 208 } 209 210 static void run_collection(struct collection *coll) 211 { 212 struct bench *bench; 213 const char *argv[2]; 214 215 argv[1] = NULL; 216 /* 217 * TODO: 218 * 219 * Preparing preset parameters for 220 * embedded, ordinary PC, HPC, etc... 221 * would be helpful. 222 */ 223 for_each_bench(coll, bench) { 224 if (!bench->fn) 225 break; 226 printf("# Running %s/%s benchmark...\n", coll->name, bench->name); 227 fflush(stdout); 228 229 argv[1] = bench->name; 230 run_bench(coll->name, bench->name, bench->fn, 1, argv); 231 printf("\n"); 232 } 233 } 234 235 static void run_all_collections(void) 236 { 237 struct collection *coll; 238 239 for_each_collection(coll) 240 run_collection(coll); 241 } 242 243 int cmd_bench(int argc, const char **argv) 244 { 245 struct collection *coll; 246 int ret = 0; 247 248 if (argc < 2) { 249 /* No collection specified. */ 250 print_usage(); 251 goto end; 252 } 253 254 argc = parse_options(argc, argv, bench_options, bench_usage, 255 PARSE_OPT_STOP_AT_NON_OPTION); 256 257 bench_format = bench_str2int(bench_format_str); 258 if (bench_format == BENCH_FORMAT_UNKNOWN) { 259 printf("Unknown format descriptor: '%s'\n", bench_format_str); 260 goto end; 261 } 262 263 if (bench_repeat == 0) { 264 printf("Invalid repeat option: Must specify a positive value\n"); 265 goto end; 266 } 267 268 if (argc < 1) { 269 print_usage(); 270 goto end; 271 } 272 273 if (!strcmp(argv[0], "all")) { 274 run_all_collections(); 275 goto end; 276 } 277 278 for_each_collection(coll) { 279 struct bench *bench; 280 281 if (strcmp(coll->name, argv[0])) 282 continue; 283 284 if (argc < 2) { 285 /* No bench specified. */ 286 dump_benchmarks(coll); 287 goto end; 288 } 289 290 if (!strcmp(argv[1], "all")) { 291 run_collection(coll); 292 goto end; 293 } 294 295 for_each_bench(coll, bench) { 296 if (strcmp(bench->name, argv[1])) 297 continue; 298 299 if (bench_format == BENCH_FORMAT_DEFAULT) 300 printf("# Running '%s/%s' benchmark:\n", coll->name, bench->name); 301 fflush(stdout); 302 ret = run_bench(coll->name, bench->name, bench->fn, argc-1, argv+1); 303 goto end; 304 } 305 306 if (!strcmp(argv[1], "-h") || !strcmp(argv[1], "--help")) { 307 dump_benchmarks(coll); 308 goto end; 309 } 310 311 printf("Unknown benchmark: '%s' for collection '%s'\n", argv[1], argv[0]); 312 ret = 1; 313 goto end; 314 } 315 316 printf("Unknown collection: '%s'\n", argv[0]); 317 ret = 1; 318 319 end: 320 return ret; 321 } 322