Commit | Line | Data |
---|---|---|
629cc356 | 1 | /* |
629cc356 HM |
2 | * builtin-bench.c |
3 | * | |
4157922a | 4 | * General benchmarking collections provided by perf |
629cc356 HM |
5 | * |
6 | * Copyright (C) 2009, Hitoshi Mitake <mitake@dcl.info.waseda.ac.jp> | |
629cc356 HM |
7 | */ |
8 | ||
9 | /* | |
4157922a | 10 | * Available benchmark collection list: |
629cc356 | 11 | * |
4157922a | 12 | * sched ... scheduler and IPC performance |
827f3b49 | 13 | * mem ... memory access performance |
4157922a | 14 | * numa ... NUMA scheduling and MM performance |
a0439711 | 15 | * futex ... Futex performance |
629cc356 | 16 | */ |
629cc356 HM |
17 | #include "perf.h" |
18 | #include "util/util.h" | |
19 | #include "util/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> | |
4157922a | 26 | #include <sys/prctl.h> |
629cc356 | 27 | |
4157922a IM |
28 | typedef int (*bench_fn_t)(int argc, const char **argv, const char *prefix); |
29 | ||
30 | struct bench { | |
31 | const char *name; | |
32 | const char *summary; | |
33 | bench_fn_t fn; | |
629cc356 HM |
34 | }; |
35 | ||
89fe808a | 36 | #ifdef HAVE_LIBNUMA_SUPPORT |
4157922a IM |
37 | static struct bench numa_benchmarks[] = { |
38 | { "mem", "Benchmark for NUMA workloads", bench_numa }, | |
39 | { "all", "Test all NUMA benchmarks", NULL }, | |
40 | { NULL, NULL, NULL } | |
1c13f3c9 | 41 | }; |
79d824e3 | 42 | #endif |
1c13f3c9 | 43 | |
4157922a IM |
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", "Test all scheduler benchmarks", NULL }, | |
48 | { NULL, NULL, NULL } | |
629cc356 HM |
49 | }; |
50 | ||
4157922a IM |
51 | static struct bench mem_benchmarks[] = { |
52 | { "memcpy", "Benchmark for memcpy()", bench_mem_memcpy }, | |
53 | { "memset", "Benchmark for memset() tests", bench_mem_memset }, | |
54 | { "all", "Test all memory benchmarks", NULL }, | |
55 | { NULL, NULL, NULL } | |
827f3b49 HM |
56 | }; |
57 | ||
a0439711 DB |
58 | static struct bench futex_benchmarks[] = { |
59 | { "hash", "Benchmark for futex hash table", bench_futex_hash }, | |
27db7830 | 60 | { "wake", "Benchmark for futex wake calls", bench_futex_wake }, |
d65817b4 | 61 | { "wake-parallel", "Benchmark for parallel futex wake calls", bench_futex_wake_parallel }, |
0fb298cf | 62 | { "requeue", "Benchmark for futex requeue calls", bench_futex_requeue }, |
d2f3f5d2 DB |
63 | /* pi-futexes */ |
64 | { "lock-pi", "Benchmark for futex lock_pi calls", bench_futex_lock_pi }, | |
a0439711 DB |
65 | { "all", "Test all futex benchmarks", NULL }, |
66 | { NULL, NULL, NULL } | |
67 | }; | |
68 | ||
4157922a IM |
69 | struct collection { |
70 | const char *name; | |
71 | const char *summary; | |
72 | struct bench *benchmarks; | |
629cc356 HM |
73 | }; |
74 | ||
4157922a | 75 | static struct collection collections[] = { |
a0439711 | 76 | { "sched", "Scheduler and IPC benchmarks", sched_benchmarks }, |
4157922a | 77 | { "mem", "Memory access benchmarks", mem_benchmarks }, |
89fe808a | 78 | #ifdef HAVE_LIBNUMA_SUPPORT |
4157922a | 79 | { "numa", "NUMA scheduling and MM benchmarks", numa_benchmarks }, |
79d824e3 | 80 | #endif |
a0439711 | 81 | {"futex", "Futex stressing benchmarks", futex_benchmarks }, |
4157922a IM |
82 | { "all", "All benchmarks", NULL }, |
83 | { NULL, NULL, NULL } | |
629cc356 HM |
84 | }; |
85 | ||
4157922a IM |
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) \ | |
6eeefccd | 92 | for (bench = coll->benchmarks; bench && bench->name; bench++) |
4157922a IM |
93 | |
94 | static void dump_benchmarks(struct collection *coll) | |
629cc356 | 95 | { |
4157922a | 96 | struct bench *bench; |
629cc356 | 97 | |
4157922a | 98 | printf("\n # List of available benchmarks for collection '%s':\n\n", coll->name); |
629cc356 | 99 | |
4157922a IM |
100 | for_each_bench(coll, bench) |
101 | printf("%14s: %s\n", bench->name, bench->summary); | |
629cc356 HM |
102 | |
103 | printf("\n"); | |
629cc356 HM |
104 | } |
105 | ||
edb7c60e | 106 | static const char *bench_format_str; |
4157922a IM |
107 | |
108 | /* Output/formatting style, exported to benchmark modules: */ | |
386d7e9e | 109 | int bench_format = BENCH_FORMAT_DEFAULT; |
b6f0629a | 110 | unsigned int bench_repeat = 10; /* default number of times to repeat the run */ |
386d7e9e HM |
111 | |
112 | static const struct option bench_options[] = { | |
4157922a | 113 | OPT_STRING('f', "format", &bench_format_str, "default", "Specify format style"), |
b6f0629a | 114 | OPT_UINTEGER('r', "repeat", &bench_repeat, "Specify amount of times to repeat the run"), |
386d7e9e HM |
115 | OPT_END() |
116 | }; | |
117 | ||
118 | static const char * const bench_usage[] = { | |
4157922a | 119 | "perf bench [<common options>] <collection> <benchmark> [<options>]", |
386d7e9e HM |
120 | NULL |
121 | }; | |
122 | ||
123 | static void print_usage(void) | |
124 | { | |
4157922a | 125 | struct collection *coll; |
386d7e9e HM |
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 | ||
4157922a | 133 | printf(" # List of all available benchmark collections:\n\n"); |
386d7e9e | 134 | |
4157922a IM |
135 | for_each_collection(coll) |
136 | printf("%14s: %s\n", coll->name, coll->summary); | |
386d7e9e HM |
137 | printf("\n"); |
138 | } | |
139 | ||
edb7c60e | 140 | static int bench_str2int(const char *str) |
386d7e9e HM |
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 | ||
4157922a IM |
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, const char *prefix) | |
2044279d | 159 | { |
4157922a IM |
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, prefix); | |
175 | ||
176 | free(name); | |
177 | ||
178 | return ret; | |
179 | } | |
180 | ||
181 | static void run_collection(struct collection *coll) | |
182 | { | |
183 | struct bench *bench; | |
2044279d | 184 | const char *argv[2]; |
2044279d HM |
185 | |
186 | argv[1] = NULL; | |
187 | /* | |
188 | * TODO: | |
4157922a IM |
189 | * |
190 | * Preparing preset parameters for | |
2044279d | 191 | * embedded, ordinary PC, HPC, etc... |
4157922a | 192 | * would be helpful. |
2044279d | 193 | */ |
4157922a IM |
194 | for_each_bench(coll, bench) { |
195 | if (!bench->fn) | |
196 | break; | |
197 | printf("# Running %s/%s benchmark...\n", coll->name, bench->name); | |
9b494ea2 | 198 | fflush(stdout); |
2044279d | 199 | |
4157922a IM |
200 | argv[1] = bench->name; |
201 | run_bench(coll->name, bench->name, bench->fn, 1, argv, NULL); | |
2044279d HM |
202 | printf("\n"); |
203 | } | |
204 | } | |
205 | ||
4157922a | 206 | static void run_all_collections(void) |
2044279d | 207 | { |
4157922a IM |
208 | struct collection *coll; |
209 | ||
210 | for_each_collection(coll) | |
211 | run_collection(coll); | |
2044279d HM |
212 | } |
213 | ||
1d037ca1 | 214 | int cmd_bench(int argc, const char **argv, const char *prefix __maybe_unused) |
629cc356 | 215 | { |
4157922a IM |
216 | struct collection *coll; |
217 | int ret = 0; | |
629cc356 HM |
218 | |
219 | if (argc < 2) { | |
4157922a | 220 | /* No collection specified. */ |
386d7e9e HM |
221 | print_usage(); |
222 | goto end; | |
223 | } | |
629cc356 | 224 | |
386d7e9e HM |
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) { | |
4157922a | 230 | printf("Unknown format descriptor: '%s'\n", bench_format_str); |
386d7e9e HM |
231 | goto end; |
232 | } | |
629cc356 | 233 | |
b6f0629a DB |
234 | if (bench_repeat == 0) { |
235 | printf("Invalid repeat option: Must specify a positive value\n"); | |
236 | goto end; | |
237 | } | |
238 | ||
386d7e9e HM |
239 | if (argc < 1) { |
240 | print_usage(); | |
629cc356 HM |
241 | goto end; |
242 | } | |
243 | ||
2044279d | 244 | if (!strcmp(argv[0], "all")) { |
4157922a | 245 | run_all_collections(); |
2044279d HM |
246 | goto end; |
247 | } | |
248 | ||
4157922a IM |
249 | for_each_collection(coll) { |
250 | struct bench *bench; | |
251 | ||
252 | if (strcmp(coll->name, argv[0])) | |
629cc356 HM |
253 | continue; |
254 | ||
386d7e9e | 255 | if (argc < 2) { |
4157922a IM |
256 | /* No bench specified. */ |
257 | dump_benchmarks(coll); | |
629cc356 HM |
258 | goto end; |
259 | } | |
260 | ||
2044279d | 261 | if (!strcmp(argv[1], "all")) { |
4157922a | 262 | run_collection(coll); |
2044279d HM |
263 | goto end; |
264 | } | |
265 | ||
4157922a IM |
266 | for_each_bench(coll, bench) { |
267 | if (strcmp(bench->name, argv[1])) | |
629cc356 HM |
268 | continue; |
269 | ||
79e295d4 | 270 | if (bench_format == BENCH_FORMAT_DEFAULT) |
4157922a | 271 | printf("# Running '%s/%s' benchmark:\n", coll->name, bench->name); |
9b494ea2 | 272 | fflush(stdout); |
4157922a | 273 | ret = run_bench(coll->name, bench->name, bench->fn, argc-1, argv+1, prefix); |
629cc356 HM |
274 | goto end; |
275 | } | |
276 | ||
386d7e9e | 277 | if (!strcmp(argv[1], "-h") || !strcmp(argv[1], "--help")) { |
4157922a | 278 | dump_benchmarks(coll); |
629cc356 HM |
279 | goto end; |
280 | } | |
281 | ||
4157922a IM |
282 | printf("Unknown benchmark: '%s' for collection '%s'\n", argv[1], argv[0]); |
283 | ret = 1; | |
629cc356 HM |
284 | goto end; |
285 | } | |
286 | ||
4157922a IM |
287 | printf("Unknown collection: '%s'\n", argv[0]); |
288 | ret = 1; | |
629cc356 HM |
289 | |
290 | end: | |
4157922a | 291 | return ret; |
629cc356 | 292 | } |