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