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