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 }, |
0fb298cf | 61 | { "requeue", "Benchmark for futex requeue calls", bench_futex_requeue }, |
a0439711 DB |
62 | { "all", "Test all futex benchmarks", NULL }, |
63 | { NULL, NULL, NULL } | |
64 | }; | |
65 | ||
4157922a IM |
66 | struct collection { |
67 | const char *name; | |
68 | const char *summary; | |
69 | struct bench *benchmarks; | |
629cc356 HM |
70 | }; |
71 | ||
4157922a | 72 | static struct collection collections[] = { |
a0439711 | 73 | { "sched", "Scheduler and IPC benchmarks", sched_benchmarks }, |
4157922a | 74 | { "mem", "Memory access benchmarks", mem_benchmarks }, |
89fe808a | 75 | #ifdef HAVE_LIBNUMA_SUPPORT |
4157922a | 76 | { "numa", "NUMA scheduling and MM benchmarks", numa_benchmarks }, |
79d824e3 | 77 | #endif |
a0439711 | 78 | {"futex", "Futex stressing benchmarks", futex_benchmarks }, |
4157922a IM |
79 | { "all", "All benchmarks", NULL }, |
80 | { NULL, NULL, NULL } | |
629cc356 HM |
81 | }; |
82 | ||
4157922a IM |
83 | /* Iterate over all benchmark collections: */ |
84 | #define for_each_collection(coll) \ | |
85 | for (coll = collections; coll->name; coll++) | |
86 | ||
87 | /* Iterate over all benchmarks within a collection: */ | |
88 | #define for_each_bench(coll, bench) \ | |
6eeefccd | 89 | for (bench = coll->benchmarks; bench && bench->name; bench++) |
4157922a IM |
90 | |
91 | static void dump_benchmarks(struct collection *coll) | |
629cc356 | 92 | { |
4157922a | 93 | struct bench *bench; |
629cc356 | 94 | |
4157922a | 95 | printf("\n # List of available benchmarks for collection '%s':\n\n", coll->name); |
629cc356 | 96 | |
4157922a IM |
97 | for_each_bench(coll, bench) |
98 | printf("%14s: %s\n", bench->name, bench->summary); | |
629cc356 HM |
99 | |
100 | printf("\n"); | |
629cc356 HM |
101 | } |
102 | ||
edb7c60e | 103 | static const char *bench_format_str; |
4157922a IM |
104 | |
105 | /* Output/formatting style, exported to benchmark modules: */ | |
386d7e9e | 106 | int bench_format = BENCH_FORMAT_DEFAULT; |
b6f0629a | 107 | unsigned int bench_repeat = 10; /* default number of times to repeat the run */ |
386d7e9e HM |
108 | |
109 | static const struct option bench_options[] = { | |
4157922a | 110 | OPT_STRING('f', "format", &bench_format_str, "default", "Specify format style"), |
b6f0629a | 111 | OPT_UINTEGER('r', "repeat", &bench_repeat, "Specify amount of times to repeat the run"), |
386d7e9e HM |
112 | OPT_END() |
113 | }; | |
114 | ||
115 | static const char * const bench_usage[] = { | |
4157922a | 116 | "perf bench [<common options>] <collection> <benchmark> [<options>]", |
386d7e9e HM |
117 | NULL |
118 | }; | |
119 | ||
120 | static void print_usage(void) | |
121 | { | |
4157922a | 122 | struct collection *coll; |
386d7e9e HM |
123 | int i; |
124 | ||
125 | printf("Usage: \n"); | |
126 | for (i = 0; bench_usage[i]; i++) | |
127 | printf("\t%s\n", bench_usage[i]); | |
128 | printf("\n"); | |
129 | ||
4157922a | 130 | printf(" # List of all available benchmark collections:\n\n"); |
386d7e9e | 131 | |
4157922a IM |
132 | for_each_collection(coll) |
133 | printf("%14s: %s\n", coll->name, coll->summary); | |
386d7e9e HM |
134 | printf("\n"); |
135 | } | |
136 | ||
edb7c60e | 137 | static int bench_str2int(const char *str) |
386d7e9e HM |
138 | { |
139 | if (!str) | |
140 | return BENCH_FORMAT_DEFAULT; | |
141 | ||
142 | if (!strcmp(str, BENCH_FORMAT_DEFAULT_STR)) | |
143 | return BENCH_FORMAT_DEFAULT; | |
144 | else if (!strcmp(str, BENCH_FORMAT_SIMPLE_STR)) | |
145 | return BENCH_FORMAT_SIMPLE; | |
146 | ||
147 | return BENCH_FORMAT_UNKNOWN; | |
148 | } | |
149 | ||
4157922a IM |
150 | /* |
151 | * Run a specific benchmark but first rename the running task's ->comm[] | |
152 | * to something meaningful: | |
153 | */ | |
154 | static int run_bench(const char *coll_name, const char *bench_name, bench_fn_t fn, | |
155 | int argc, const char **argv, const char *prefix) | |
2044279d | 156 | { |
4157922a IM |
157 | int size; |
158 | char *name; | |
159 | int ret; | |
160 | ||
161 | size = strlen(coll_name) + 1 + strlen(bench_name) + 1; | |
162 | ||
163 | name = zalloc(size); | |
164 | BUG_ON(!name); | |
165 | ||
166 | scnprintf(name, size, "%s-%s", coll_name, bench_name); | |
167 | ||
168 | prctl(PR_SET_NAME, name); | |
169 | argv[0] = name; | |
170 | ||
171 | ret = fn(argc, argv, prefix); | |
172 | ||
173 | free(name); | |
174 | ||
175 | return ret; | |
176 | } | |
177 | ||
178 | static void run_collection(struct collection *coll) | |
179 | { | |
180 | struct bench *bench; | |
2044279d | 181 | const char *argv[2]; |
2044279d HM |
182 | |
183 | argv[1] = NULL; | |
184 | /* | |
185 | * TODO: | |
4157922a IM |
186 | * |
187 | * Preparing preset parameters for | |
2044279d | 188 | * embedded, ordinary PC, HPC, etc... |
4157922a | 189 | * would be helpful. |
2044279d | 190 | */ |
4157922a IM |
191 | for_each_bench(coll, bench) { |
192 | if (!bench->fn) | |
193 | break; | |
194 | printf("# Running %s/%s benchmark...\n", coll->name, bench->name); | |
9b494ea2 | 195 | fflush(stdout); |
2044279d | 196 | |
4157922a IM |
197 | argv[1] = bench->name; |
198 | run_bench(coll->name, bench->name, bench->fn, 1, argv, NULL); | |
2044279d HM |
199 | printf("\n"); |
200 | } | |
201 | } | |
202 | ||
4157922a | 203 | static void run_all_collections(void) |
2044279d | 204 | { |
4157922a IM |
205 | struct collection *coll; |
206 | ||
207 | for_each_collection(coll) | |
208 | run_collection(coll); | |
2044279d HM |
209 | } |
210 | ||
1d037ca1 | 211 | int cmd_bench(int argc, const char **argv, const char *prefix __maybe_unused) |
629cc356 | 212 | { |
4157922a IM |
213 | struct collection *coll; |
214 | int ret = 0; | |
629cc356 HM |
215 | |
216 | if (argc < 2) { | |
4157922a | 217 | /* No collection specified. */ |
386d7e9e HM |
218 | print_usage(); |
219 | goto end; | |
220 | } | |
629cc356 | 221 | |
386d7e9e HM |
222 | argc = parse_options(argc, argv, bench_options, bench_usage, |
223 | PARSE_OPT_STOP_AT_NON_OPTION); | |
224 | ||
225 | bench_format = bench_str2int(bench_format_str); | |
226 | if (bench_format == BENCH_FORMAT_UNKNOWN) { | |
4157922a | 227 | printf("Unknown format descriptor: '%s'\n", bench_format_str); |
386d7e9e HM |
228 | goto end; |
229 | } | |
629cc356 | 230 | |
b6f0629a DB |
231 | if (bench_repeat == 0) { |
232 | printf("Invalid repeat option: Must specify a positive value\n"); | |
233 | goto end; | |
234 | } | |
235 | ||
386d7e9e HM |
236 | if (argc < 1) { |
237 | print_usage(); | |
629cc356 HM |
238 | goto end; |
239 | } | |
240 | ||
2044279d | 241 | if (!strcmp(argv[0], "all")) { |
4157922a | 242 | run_all_collections(); |
2044279d HM |
243 | goto end; |
244 | } | |
245 | ||
4157922a IM |
246 | for_each_collection(coll) { |
247 | struct bench *bench; | |
248 | ||
249 | if (strcmp(coll->name, argv[0])) | |
629cc356 HM |
250 | continue; |
251 | ||
386d7e9e | 252 | if (argc < 2) { |
4157922a IM |
253 | /* No bench specified. */ |
254 | dump_benchmarks(coll); | |
629cc356 HM |
255 | goto end; |
256 | } | |
257 | ||
2044279d | 258 | if (!strcmp(argv[1], "all")) { |
4157922a | 259 | run_collection(coll); |
2044279d HM |
260 | goto end; |
261 | } | |
262 | ||
4157922a IM |
263 | for_each_bench(coll, bench) { |
264 | if (strcmp(bench->name, argv[1])) | |
629cc356 HM |
265 | continue; |
266 | ||
79e295d4 | 267 | if (bench_format == BENCH_FORMAT_DEFAULT) |
4157922a | 268 | printf("# Running '%s/%s' benchmark:\n", coll->name, bench->name); |
9b494ea2 | 269 | fflush(stdout); |
4157922a | 270 | ret = run_bench(coll->name, bench->name, bench->fn, argc-1, argv+1, prefix); |
629cc356 HM |
271 | goto end; |
272 | } | |
273 | ||
386d7e9e | 274 | if (!strcmp(argv[1], "-h") || !strcmp(argv[1], "--help")) { |
4157922a | 275 | dump_benchmarks(coll); |
629cc356 HM |
276 | goto end; |
277 | } | |
278 | ||
4157922a IM |
279 | printf("Unknown benchmark: '%s' for collection '%s'\n", argv[1], argv[0]); |
280 | ret = 1; | |
629cc356 HM |
281 | goto end; |
282 | } | |
283 | ||
4157922a IM |
284 | printf("Unknown collection: '%s'\n", argv[0]); |
285 | ret = 1; | |
629cc356 HM |
286 | |
287 | end: | |
4157922a | 288 | return ret; |
629cc356 | 289 | } |