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