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