Commit | Line | Data |
---|---|---|
827f3b49 HM |
1 | /* |
2 | * mem-memcpy.c | |
3 | * | |
13839ec4 | 4 | * Simple memcpy() and memset() benchmarks |
827f3b49 HM |
5 | * |
6 | * Written by Hitoshi Mitake <mitake@dcl.info.waseda.ac.jp> | |
7 | */ | |
827f3b49 HM |
8 | |
9 | #include "../perf.h" | |
10 | #include "../util/util.h" | |
11 | #include "../util/parse-options.h" | |
827f3b49 | 12 | #include "../util/header.h" |
57480d2c | 13 | #include "../util/cloexec.h" |
827f3b49 | 14 | #include "bench.h" |
49ce8fc6 | 15 | #include "mem-memcpy-arch.h" |
5bce1a57 | 16 | #include "mem-memset-arch.h" |
827f3b49 HM |
17 | |
18 | #include <stdio.h> | |
19 | #include <stdlib.h> | |
20 | #include <string.h> | |
21 | #include <sys/time.h> | |
22 | #include <errno.h> | |
23 | ||
24 | #define K 1024 | |
25 | ||
a69b4f74 | 26 | static const char *size_str = "1MB"; |
2f211c84 | 27 | static const char *function_str = "all"; |
b0d22e52 | 28 | static int nr_loops = 1; |
b14f2d35 IM |
29 | static bool use_cycles; |
30 | static int cycles_fd; | |
827f3b49 HM |
31 | |
32 | static const struct option options[] = { | |
b0d22e52 | 33 | OPT_STRING('s', "size", &size_str, "1MB", |
a69b4f74 | 34 | "Specify the size of the memory buffers. " |
13b1fdce IM |
35 | "Available units: B, KB, MB, GB and TB (case insensitive)"), |
36 | ||
2f211c84 IM |
37 | OPT_STRING('f', "function", &function_str, "all", |
38 | "Specify the function to run, \"all\" runs all available functions, \"help\" lists them"), | |
13b1fdce | 39 | |
b0d22e52 IM |
40 | OPT_INTEGER('l', "nr_loops", &nr_loops, |
41 | "Specify the number of loops to run. (default: 1)"), | |
13b1fdce | 42 | |
b14f2d35 IM |
43 | OPT_BOOLEAN('c', "cycles", &use_cycles, |
44 | "Use a cycles event instead of gettimeofday() to measure performance"), | |
13b1fdce | 45 | |
827f3b49 HM |
46 | OPT_END() |
47 | }; | |
48 | ||
49ce8fc6 | 49 | typedef void *(*memcpy_t)(void *, const void *, size_t); |
5bce1a57 | 50 | typedef void *(*memset_t)(void *, int, size_t); |
49ce8fc6 | 51 | |
2f211c84 | 52 | struct function { |
827f3b49 HM |
53 | const char *name; |
54 | const char *desc; | |
308197b9 RV |
55 | union { |
56 | memcpy_t memcpy; | |
5bce1a57 | 57 | memset_t memset; |
308197b9 | 58 | } fn; |
827f3b49 HM |
59 | }; |
60 | ||
17d7a112 | 61 | static struct perf_event_attr cycle_attr = { |
12eac0bf HM |
62 | .type = PERF_TYPE_HARDWARE, |
63 | .config = PERF_COUNT_HW_CPU_CYCLES | |
827f3b49 HM |
64 | }; |
65 | ||
b14f2d35 | 66 | static void init_cycles(void) |
827f3b49 | 67 | { |
b14f2d35 | 68 | cycles_fd = sys_perf_event_open(&cycle_attr, getpid(), -1, -1, perf_event_open_cloexec_flag()); |
12eac0bf | 69 | |
b14f2d35 | 70 | if (cycles_fd < 0 && errno == ENOSYS) |
12eac0bf HM |
71 | die("No CONFIG_PERF_EVENTS=y kernel support configured?\n"); |
72 | else | |
b14f2d35 | 73 | BUG_ON(cycles_fd < 0); |
827f3b49 HM |
74 | } |
75 | ||
b14f2d35 | 76 | static u64 get_cycles(void) |
827f3b49 HM |
77 | { |
78 | int ret; | |
79 | u64 clk; | |
80 | ||
b14f2d35 | 81 | ret = read(cycles_fd, &clk, sizeof(u64)); |
827f3b49 HM |
82 | BUG_ON(ret != sizeof(u64)); |
83 | ||
84 | return clk; | |
85 | } | |
86 | ||
87 | static double timeval2double(struct timeval *ts) | |
88 | { | |
13839ec4 | 89 | return (double)ts->tv_sec + (double)ts->tv_usec / (double)1000000; |
827f3b49 HM |
90 | } |
91 | ||
6db175c7 IM |
92 | #define print_bps(x) do { \ |
93 | if (x < K) \ | |
13b1fdce | 94 | printf(" %14lf bytes/sec\n", x); \ |
6db175c7 | 95 | else if (x < K * K) \ |
13b1fdce | 96 | printf(" %14lfd KB/sec\n", x / K); \ |
6db175c7 | 97 | else if (x < K * K * K) \ |
13b1fdce | 98 | printf(" %14lf MB/sec\n", x / K / K); \ |
6db175c7 | 99 | else \ |
13b1fdce | 100 | printf(" %14lf GB/sec\n", x / K / K / K); \ |
49ce8fc6 HM |
101 | } while (0) |
102 | ||
308197b9 | 103 | struct bench_mem_info { |
2f211c84 IM |
104 | const struct function *functions; |
105 | u64 (*do_cycles)(const struct function *r, size_t size); | |
106 | double (*do_gettimeofday)(const struct function *r, size_t size); | |
308197b9 RV |
107 | const char *const *usage; |
108 | }; | |
109 | ||
2f211c84 | 110 | static void __bench_mem_function(struct bench_mem_info *info, int r_idx, size_t size, double size_total) |
827f3b49 | 111 | { |
2f211c84 | 112 | const struct function *r = &info->functions[r_idx]; |
6db175c7 | 113 | double result_bps = 0.0; |
b14f2d35 | 114 | u64 result_cycles = 0; |
49ce8fc6 | 115 | |
2f211c84 | 116 | printf("# function '%s' (%s)\n", r->name, r->desc); |
827f3b49 | 117 | |
49ce8fc6 | 118 | if (bench_format == BENCH_FORMAT_DEFAULT) |
13b1fdce | 119 | printf("# Copying %s bytes ...\n\n", size_str); |
827f3b49 | 120 | |
b14f2d35 | 121 | if (use_cycles) { |
a69b4f74 | 122 | result_cycles = info->do_cycles(r, size); |
827f3b49 | 123 | } else { |
a69b4f74 | 124 | result_bps = info->do_gettimeofday(r, size); |
827f3b49 HM |
125 | } |
126 | ||
127 | switch (bench_format) { | |
128 | case BENCH_FORMAT_DEFAULT: | |
b14f2d35 | 129 | if (use_cycles) { |
13b1fdce | 130 | printf(" %14lf cycles/byte\n", (double)result_cycles/size_total); |
49ce8fc6 | 131 | } else { |
6db175c7 | 132 | print_bps(result_bps); |
827f3b49 HM |
133 | } |
134 | break; | |
6db175c7 | 135 | |
827f3b49 | 136 | case BENCH_FORMAT_SIMPLE: |
b14f2d35 | 137 | if (use_cycles) { |
a69b4f74 | 138 | printf("%lf\n", (double)result_cycles/size_total); |
49ce8fc6 | 139 | } else { |
6db175c7 | 140 | printf("%lf\n", result_bps); |
49ce8fc6 | 141 | } |
827f3b49 | 142 | break; |
6db175c7 | 143 | |
827f3b49 | 144 | default: |
6db175c7 | 145 | BUG_ON(1); |
827f3b49 HM |
146 | break; |
147 | } | |
515e23f0 BP |
148 | } |
149 | ||
2946f59a | 150 | static int bench_mem_common(int argc, const char **argv, struct bench_mem_info *info) |
515e23f0 BP |
151 | { |
152 | int i; | |
a69b4f74 IM |
153 | size_t size; |
154 | double size_total; | |
515e23f0 | 155 | |
13839ec4 | 156 | argc = parse_options(argc, argv, options, info->usage, 0); |
515e23f0 | 157 | |
b14f2d35 IM |
158 | if (use_cycles) |
159 | init_cycles(); | |
515e23f0 | 160 | |
a69b4f74 | 161 | size = (size_t)perf_atoll((char *)size_str); |
b0d22e52 | 162 | size_total = (double)size * nr_loops; |
515e23f0 | 163 | |
a69b4f74 IM |
164 | if ((s64)size <= 0) { |
165 | fprintf(stderr, "Invalid size:%s\n", size_str); | |
515e23f0 BP |
166 | return 1; |
167 | } | |
168 | ||
2f211c84 IM |
169 | if (!strncmp(function_str, "all", 3)) { |
170 | for (i = 0; info->functions[i].name; i++) | |
171 | __bench_mem_function(info, i, size, size_total); | |
dfecb95c BP |
172 | return 0; |
173 | } | |
174 | ||
2f211c84 IM |
175 | for (i = 0; info->functions[i].name; i++) { |
176 | if (!strcmp(info->functions[i].name, function_str)) | |
515e23f0 BP |
177 | break; |
178 | } | |
2f211c84 IM |
179 | if (!info->functions[i].name) { |
180 | if (strcmp(function_str, "help") && strcmp(function_str, "h")) | |
181 | printf("Unknown function: %s\n", function_str); | |
182 | printf("Available functions:\n"); | |
183 | for (i = 0; info->functions[i].name; i++) { | |
515e23f0 | 184 | printf("\t%s ... %s\n", |
2f211c84 | 185 | info->functions[i].name, info->functions[i].desc); |
515e23f0 BP |
186 | } |
187 | return 1; | |
188 | } | |
189 | ||
2f211c84 | 190 | __bench_mem_function(info, i, size, size_total); |
827f3b49 HM |
191 | |
192 | return 0; | |
193 | } | |
308197b9 | 194 | |
a69b4f74 | 195 | static void memcpy_alloc_mem(void **dst, void **src, size_t size) |
308197b9 | 196 | { |
a69b4f74 | 197 | *dst = zalloc(size); |
308197b9 | 198 | if (!*dst) |
a69b4f74 | 199 | die("memory allocation failed - maybe size is too large?\n"); |
308197b9 | 200 | |
a69b4f74 | 201 | *src = zalloc(size); |
308197b9 | 202 | if (!*src) |
a69b4f74 | 203 | die("memory allocation failed - maybe size is too large?\n"); |
13839ec4 IM |
204 | |
205 | /* Make sure to always prefault zero pages even if MMAP_THRESH is crossed: */ | |
a69b4f74 | 206 | memset(*src, 0, size); |
308197b9 RV |
207 | } |
208 | ||
2f211c84 | 209 | static u64 do_memcpy_cycles(const struct function *r, size_t size) |
308197b9 RV |
210 | { |
211 | u64 cycle_start = 0ULL, cycle_end = 0ULL; | |
212 | void *src = NULL, *dst = NULL; | |
213 | memcpy_t fn = r->fn.memcpy; | |
214 | int i; | |
215 | ||
a69b4f74 | 216 | memcpy_alloc_mem(&dst, &src, size); |
308197b9 | 217 | |
6db175c7 IM |
218 | /* |
219 | * We prefault the freshly allocated memory range here, | |
220 | * to not measure page fault overhead: | |
221 | */ | |
a69b4f74 | 222 | fn(dst, src, size); |
308197b9 | 223 | |
b14f2d35 | 224 | cycle_start = get_cycles(); |
b0d22e52 | 225 | for (i = 0; i < nr_loops; ++i) |
a69b4f74 | 226 | fn(dst, src, size); |
b14f2d35 | 227 | cycle_end = get_cycles(); |
308197b9 RV |
228 | |
229 | free(src); | |
230 | free(dst); | |
231 | return cycle_end - cycle_start; | |
232 | } | |
233 | ||
2f211c84 | 234 | static double do_memcpy_gettimeofday(const struct function *r, size_t size) |
308197b9 RV |
235 | { |
236 | struct timeval tv_start, tv_end, tv_diff; | |
237 | memcpy_t fn = r->fn.memcpy; | |
238 | void *src = NULL, *dst = NULL; | |
239 | int i; | |
240 | ||
a69b4f74 | 241 | memcpy_alloc_mem(&dst, &src, size); |
308197b9 | 242 | |
6db175c7 IM |
243 | /* |
244 | * We prefault the freshly allocated memory range here, | |
245 | * to not measure page fault overhead: | |
246 | */ | |
a69b4f74 | 247 | fn(dst, src, size); |
308197b9 RV |
248 | |
249 | BUG_ON(gettimeofday(&tv_start, NULL)); | |
b0d22e52 | 250 | for (i = 0; i < nr_loops; ++i) |
a69b4f74 | 251 | fn(dst, src, size); |
308197b9 RV |
252 | BUG_ON(gettimeofday(&tv_end, NULL)); |
253 | ||
254 | timersub(&tv_end, &tv_start, &tv_diff); | |
255 | ||
256 | free(src); | |
257 | free(dst); | |
6db175c7 | 258 | |
b0d22e52 | 259 | return (double)(((double)size * nr_loops) / timeval2double(&tv_diff)); |
308197b9 RV |
260 | } |
261 | ||
2f211c84 | 262 | struct function memcpy_functions[] = { |
5dd93304 IM |
263 | { .name = "default", |
264 | .desc = "Default memcpy() provided by glibc", | |
265 | .fn.memcpy = memcpy }, | |
266 | ||
267 | #ifdef HAVE_ARCH_X86_64_SUPPORT | |
268 | # define MEMCPY_FN(_fn, _name, _desc) {.name = _name, .desc = _desc, .fn.memcpy = _fn}, | |
269 | # include "mem-memcpy-x86-64-asm-def.h" | |
270 | # undef MEMCPY_FN | |
271 | #endif | |
272 | ||
273 | { NULL, } | |
274 | }; | |
275 | ||
276 | static const char * const bench_mem_memcpy_usage[] = { | |
277 | "perf bench mem memcpy <options>", | |
278 | NULL | |
279 | }; | |
280 | ||
2946f59a | 281 | int bench_mem_memcpy(int argc, const char **argv, const char *prefix __maybe_unused) |
308197b9 RV |
282 | { |
283 | struct bench_mem_info info = { | |
2f211c84 | 284 | .functions = memcpy_functions, |
b14f2d35 | 285 | .do_cycles = do_memcpy_cycles, |
13839ec4 IM |
286 | .do_gettimeofday = do_memcpy_gettimeofday, |
287 | .usage = bench_mem_memcpy_usage, | |
308197b9 RV |
288 | }; |
289 | ||
2946f59a | 290 | return bench_mem_common(argc, argv, &info); |
308197b9 | 291 | } |
5bce1a57 | 292 | |
a69b4f74 | 293 | static void memset_alloc_mem(void **dst, size_t size) |
5bce1a57 | 294 | { |
a69b4f74 | 295 | *dst = zalloc(size); |
5bce1a57 | 296 | if (!*dst) |
a69b4f74 | 297 | die("memory allocation failed - maybe size is too large?\n"); |
5bce1a57 RV |
298 | } |
299 | ||
2f211c84 | 300 | static u64 do_memset_cycles(const struct function *r, size_t size) |
5bce1a57 RV |
301 | { |
302 | u64 cycle_start = 0ULL, cycle_end = 0ULL; | |
303 | memset_t fn = r->fn.memset; | |
304 | void *dst = NULL; | |
305 | int i; | |
306 | ||
a69b4f74 | 307 | memset_alloc_mem(&dst, size); |
5bce1a57 | 308 | |
6db175c7 IM |
309 | /* |
310 | * We prefault the freshly allocated memory range here, | |
311 | * to not measure page fault overhead: | |
312 | */ | |
a69b4f74 | 313 | fn(dst, -1, size); |
5bce1a57 | 314 | |
b14f2d35 | 315 | cycle_start = get_cycles(); |
b0d22e52 | 316 | for (i = 0; i < nr_loops; ++i) |
a69b4f74 | 317 | fn(dst, i, size); |
b14f2d35 | 318 | cycle_end = get_cycles(); |
5bce1a57 RV |
319 | |
320 | free(dst); | |
321 | return cycle_end - cycle_start; | |
322 | } | |
323 | ||
2f211c84 | 324 | static double do_memset_gettimeofday(const struct function *r, size_t size) |
5bce1a57 RV |
325 | { |
326 | struct timeval tv_start, tv_end, tv_diff; | |
327 | memset_t fn = r->fn.memset; | |
328 | void *dst = NULL; | |
329 | int i; | |
330 | ||
a69b4f74 | 331 | memset_alloc_mem(&dst, size); |
5bce1a57 | 332 | |
6db175c7 IM |
333 | /* |
334 | * We prefault the freshly allocated memory range here, | |
335 | * to not measure page fault overhead: | |
336 | */ | |
a69b4f74 | 337 | fn(dst, -1, size); |
5bce1a57 RV |
338 | |
339 | BUG_ON(gettimeofday(&tv_start, NULL)); | |
b0d22e52 | 340 | for (i = 0; i < nr_loops; ++i) |
a69b4f74 | 341 | fn(dst, i, size); |
5bce1a57 RV |
342 | BUG_ON(gettimeofday(&tv_end, NULL)); |
343 | ||
344 | timersub(&tv_end, &tv_start, &tv_diff); | |
345 | ||
346 | free(dst); | |
b0d22e52 | 347 | return (double)(((double)size * nr_loops) / timeval2double(&tv_diff)); |
5bce1a57 RV |
348 | } |
349 | ||
350 | static const char * const bench_mem_memset_usage[] = { | |
351 | "perf bench mem memset <options>", | |
352 | NULL | |
353 | }; | |
354 | ||
2f211c84 | 355 | static const struct function memset_functions[] = { |
13839ec4 IM |
356 | { .name = "default", |
357 | .desc = "Default memset() provided by glibc", | |
358 | .fn.memset = memset }, | |
5bce1a57 | 359 | |
13839ec4 IM |
360 | #ifdef HAVE_ARCH_X86_64_SUPPORT |
361 | # define MEMSET_FN(_fn, _name, _desc) { .name = _name, .desc = _desc, .fn.memset = _fn }, | |
362 | # include "mem-memset-x86-64-asm-def.h" | |
363 | # undef MEMSET_FN | |
5bce1a57 RV |
364 | #endif |
365 | ||
13839ec4 | 366 | { NULL, } |
5bce1a57 RV |
367 | }; |
368 | ||
13839ec4 | 369 | int bench_mem_memset(int argc, const char **argv, const char *prefix __maybe_unused) |
5bce1a57 RV |
370 | { |
371 | struct bench_mem_info info = { | |
2f211c84 | 372 | .functions = memset_functions, |
b14f2d35 | 373 | .do_cycles = do_memset_cycles, |
13839ec4 IM |
374 | .do_gettimeofday = do_memset_gettimeofday, |
375 | .usage = bench_mem_memset_usage, | |
5bce1a57 RV |
376 | }; |
377 | ||
2946f59a | 378 | return bench_mem_common(argc, argv, &info); |
5bce1a57 | 379 | } |