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