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