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