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