2 * Assembly testing and benchmarking tool
3 * Copyright (c) 2015 Henrik Gramner
4 * Copyright (c) 2008 Loren Merritt
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 #include "libavutil/common.h"
29 #include "libavutil/cpu.h"
30 #include "libavutil/intfloat.h"
31 #include "libavutil/random_seed.h"
37 #if HAVE_SETCONSOLETEXTATTRIBUTE
39 #define COLOR_RED FOREGROUND_RED
40 #define COLOR_GREEN FOREGROUND_GREEN
41 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
45 #define COLOR_YELLOW 3
56 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
57 #include "libavutil/arm/cpu.h"
59 void (*checkasm_checked_call)(void *func, int dummy, ...) = checkasm_checked_call_novfp;
62 /* List of tests to invoke */
68 #if CONFIG_ALAC_DECODER
69 { "alacdsp", checkasm_check_alacdsp },
72 { "bswapdsp", checkasm_check_bswapdsp },
74 #if CONFIG_DCA_DECODER
75 { "dcadsp", checkasm_check_dcadsp },
76 { "synth_filter", checkasm_check_synth_filter },
79 { "flacdsp", checkasm_check_flacdsp },
82 { "fmtconvert", checkasm_check_fmtconvert },
85 { "h264pred", checkasm_check_h264pred },
88 { "h264qpel", checkasm_check_h264qpel },
90 #if CONFIG_JPEG2000_DECODER
91 { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
93 #if CONFIG_PIXBLOCKDSP
94 { "pixblockdsp", checkasm_check_pixblockdsp },
96 #if CONFIG_V210_ENCODER
97 { "v210enc", checkasm_check_v210enc },
99 #if CONFIG_VP9_DECODER
100 { "vp9dsp", checkasm_check_vp9dsp },
103 { "videodsp", checkasm_check_videodsp },
109 /* List of cpu flags to check */
110 static const struct {
116 { "ARMV8", "armv8", AV_CPU_FLAG_ARMV8 },
117 { "NEON", "neon", AV_CPU_FLAG_NEON },
119 { "ARMV5TE", "armv5te", AV_CPU_FLAG_ARMV5TE },
120 { "ARMV6", "armv6", AV_CPU_FLAG_ARMV6 },
121 { "ARMV6T2", "armv6t2", AV_CPU_FLAG_ARMV6T2 },
122 { "VFP", "vfp", AV_CPU_FLAG_VFP },
123 { "VFP_VM", "vfp_vm", AV_CPU_FLAG_VFP_VM },
124 { "VFPV3", "vfp3", AV_CPU_FLAG_VFPV3 },
125 { "NEON", "neon", AV_CPU_FLAG_NEON },
127 { "ALTIVEC", "altivec", AV_CPU_FLAG_ALTIVEC },
128 { "VSX", "vsx", AV_CPU_FLAG_VSX },
129 { "POWER8", "power8", AV_CPU_FLAG_POWER8 },
131 { "MMX", "mmx", AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
132 { "MMXEXT", "mmxext", AV_CPU_FLAG_MMXEXT },
133 { "3DNOW", "3dnow", AV_CPU_FLAG_3DNOW },
134 { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
135 { "SSE", "sse", AV_CPU_FLAG_SSE },
136 { "SSE2", "sse2", AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
137 { "SSE3", "sse3", AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
138 { "SSSE3", "ssse3", AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
139 { "SSE4.1", "sse4", AV_CPU_FLAG_SSE4 },
140 { "SSE4.2", "sse42", AV_CPU_FLAG_SSE42 },
141 { "AES-NI", "aesni", AV_CPU_FLAG_AESNI },
142 { "AVX", "avx", AV_CPU_FLAG_AVX },
143 { "XOP", "xop", AV_CPU_FLAG_XOP },
144 { "FMA3", "fma3", AV_CPU_FLAG_FMA3 },
145 { "FMA4", "fma4", AV_CPU_FLAG_FMA4 },
146 { "AVX2", "avx2", AV_CPU_FLAG_AVX2 },
151 typedef struct CheckasmFuncVersion {
152 struct CheckasmFuncVersion *next;
158 } CheckasmFuncVersion;
160 /* Binary search tree node */
161 typedef struct CheckasmFunc {
162 struct CheckasmFunc *child[2];
163 CheckasmFuncVersion versions;
164 uint8_t color; /* 0 = red, 1 = black */
171 CheckasmFunc *current_func;
172 CheckasmFuncVersion *current_func_ver;
173 const char *current_test_name;
174 const char *bench_pattern;
175 int bench_pattern_len;
180 const char *cpu_flag_name;
186 /* float compare support code */
187 static int is_negative(union av_intfloat32 u)
192 int float_near_ulp(float a, float b, unsigned max_ulp)
194 union av_intfloat32 x, y;
199 if (is_negative(x) != is_negative(y)) {
200 // handle -0.0 == +0.0
204 if (abs(x.i - y.i) <= max_ulp)
210 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
215 for (i = 0; i < len; i++) {
216 if (!float_near_ulp(a[i], b[i], max_ulp))
222 int float_near_abs_eps(float a, float b, float eps)
224 float abs_diff = fabsf(a - b);
226 return abs_diff < eps;
229 int float_near_abs_eps_array(const float *a, const float *b, float eps,
234 for (i = 0; i < len; i++) {
235 if (!float_near_abs_eps(a[i], b[i], eps))
241 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
243 return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
246 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
247 unsigned max_ulp, unsigned len)
251 for (i = 0; i < len; i++) {
252 if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
258 /* Print colored text to stderr if the terminal supports it */
259 static void color_printf(int color, const char *fmt, ...)
261 static int use_color = -1;
264 #if HAVE_SETCONSOLETEXTATTRIBUTE
266 static WORD org_attributes;
269 CONSOLE_SCREEN_BUFFER_INFO con_info;
270 con = GetStdHandle(STD_ERROR_HANDLE);
271 if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
272 org_attributes = con_info.wAttributes;
278 SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
281 const char *term = getenv("TERM");
282 use_color = term && strcmp(term, "dumb") && isatty(2);
285 fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
289 vfprintf(stderr, fmt, arg);
293 #if HAVE_SETCONSOLETEXTATTRIBUTE
294 SetConsoleTextAttribute(con, org_attributes);
296 fprintf(stderr, "\x1b[0m");
301 /* Deallocate a tree */
302 static void destroy_func_tree(CheckasmFunc *f)
305 CheckasmFuncVersion *v = f->versions.next;
307 CheckasmFuncVersion *next = v->next;
312 destroy_func_tree(f->child[0]);
313 destroy_func_tree(f->child[1]);
318 /* Allocate a zero-initialized block, clean up and exit on failure */
319 static void *checkasm_malloc(size_t size)
321 void *ptr = calloc(1, size);
323 fprintf(stderr, "checkasm: malloc failed\n");
324 destroy_func_tree(state.funcs);
330 /* Get the suffix of the specified cpu flag */
331 static const char *cpu_suffix(int cpu)
333 int i = FF_ARRAY_ELEMS(cpus);
336 if (cpu & cpus[i].flag)
337 return cpus[i].suffix;
343 static int cmp_nop(const void *a, const void *b)
345 return *(const uint16_t*)a - *(const uint16_t*)b;
348 /* Measure the overhead of the timing code (in decicycles) */
349 static int measure_nop_time(void)
351 uint16_t nops[10000];
354 for (i = 0; i < 10000; i++) {
355 uint64_t t = AV_READ_TIME();
356 nops[i] = AV_READ_TIME() - t;
359 qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
360 for (i = 2500; i < 7500; i++)
363 return nop_sum / 500;
366 /* Print benchmark results */
367 static void print_benchs(CheckasmFunc *f)
370 print_benchs(f->child[0]);
372 /* Only print functions with at least one assembly version */
373 if (f->versions.cpu || f->versions.next) {
374 CheckasmFuncVersion *v = &f->versions;
377 int decicycles = (10*v->cycles/v->iterations - state.nop_time) / 4;
378 printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
380 } while ((v = v->next));
383 print_benchs(f->child[1]);
388 /* ASCIIbetical sort except preserving natural order for numbers */
389 static int cmp_func_names(const char *a, const char *b)
391 const char *start = a;
392 int ascii_diff, digit_diff;
394 for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
395 for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
397 if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
403 /* Perform a tree rotation in the specified direction and return the new root */
404 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
406 CheckasmFunc *r = f->child[dir^1];
407 f->child[dir^1] = r->child[dir];
414 #define is_red(f) ((f) && !(f)->color)
416 /* Balance a left-leaning red-black tree at the specified node */
417 static void balance_tree(CheckasmFunc **root)
419 CheckasmFunc *f = *root;
421 if (is_red(f->child[0]) && is_red(f->child[1])) {
423 f->child[0]->color = f->child[1]->color = 1;
426 if (!is_red(f->child[0]) && is_red(f->child[1]))
427 *root = rotate_tree(f, 0); /* Rotate left */
428 else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
429 *root = rotate_tree(f, 1); /* Rotate right */
432 /* Get a node with the specified name, creating it if it doesn't exist */
433 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
435 CheckasmFunc *f = *root;
438 /* Search the tree for a matching node */
439 int cmp = cmp_func_names(name, f->name);
441 f = get_func(&f->child[cmp > 0], name);
443 /* Rebalance the tree on the way up if a new node was inserted */
444 if (!f->versions.func)
448 /* Allocate and insert a new node into the tree */
449 int name_length = strlen(name);
450 f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
451 memcpy(f->name, name, name_length + 1);
457 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
458 static void check_cpu_flag(const char *name, int flag)
460 int old_cpu_flag = state.cpu_flag;
462 flag |= old_cpu_flag;
463 av_force_cpu_flags(-1);
464 state.cpu_flag = flag & av_get_cpu_flags();
465 av_force_cpu_flags(state.cpu_flag);
467 if (!flag || state.cpu_flag != old_cpu_flag) {
470 state.cpu_flag_name = name;
471 for (i = 0; tests[i].func; i++) {
472 state.current_test_name = tests[i].name;
478 /* Print the name of the current CPU flag, but only do it once */
479 static void print_cpu_name(void)
481 if (state.cpu_flag_name) {
482 color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
483 state.cpu_flag_name = NULL;
487 int main(int argc, char *argv[])
489 int i, seed, ret = 0;
491 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
492 if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
493 checkasm_checked_call = checkasm_checked_call_vfp;
496 if (!tests[0].func || !cpus[0].flag) {
497 fprintf(stderr, "checkasm: no tests to perform\n");
501 if (argc > 1 && !strncmp(argv[1], "--bench", 7)) {
503 fprintf(stderr, "checkasm: --bench is not supported on your system\n");
506 if (argv[1][7] == '=') {
507 state.bench_pattern = argv[1] + 8;
508 state.bench_pattern_len = strlen(state.bench_pattern);
510 state.bench_pattern = "";
516 seed = (argc > 1) ? atoi(argv[1]) : av_get_random_seed();
517 fprintf(stderr, "checkasm: using random seed %u\n", seed);
518 av_lfg_init(&checkasm_lfg, seed);
520 check_cpu_flag(NULL, 0);
521 for (i = 0; cpus[i].flag; i++)
522 check_cpu_flag(cpus[i].name, cpus[i].flag);
524 if (state.num_failed) {
525 fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
528 fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
530 if (state.bench_pattern) {
531 state.nop_time = measure_nop_time();
532 printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
533 print_benchs(state.funcs);
538 destroy_func_tree(state.funcs);
542 /* Decide whether or not the specified function needs to be tested and
543 * allocate/initialize data structures if needed. Returns a pointer to a
544 * reference function if the function should be tested, otherwise NULL */
545 void *checkasm_check_func(void *func, const char *name, ...)
549 CheckasmFuncVersion *v;
554 name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
557 if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
560 state.current_func = get_func(&state.funcs, name_buf);
561 state.funcs->color = 1;
562 v = &state.current_func->versions;
565 CheckasmFuncVersion *prev;
567 /* Only test functions that haven't already been tested */
575 } while ((v = v->next));
577 v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
582 v->cpu = state.cpu_flag;
583 state.current_func_ver = v;
591 /* Decide whether or not the current function needs to be benchmarked */
592 int checkasm_bench_func(void)
594 return !state.num_failed && state.bench_pattern &&
595 !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
598 /* Indicate that the current test has failed */
599 void checkasm_fail_func(const char *msg, ...)
601 if (state.current_func_ver->cpu && state.current_func_ver->ok) {
605 fprintf(stderr, " %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
607 vfprintf(stderr, msg, arg);
609 fprintf(stderr, ")\n");
611 state.current_func_ver->ok = 0;
616 /* Update benchmark results of the current function */
617 void checkasm_update_bench(int iterations, uint64_t cycles)
619 state.current_func_ver->iterations += iterations;
620 state.current_func_ver->cycles += cycles;
623 /* Print the outcome of all tests performed since the last time this function was called */
624 void checkasm_report(const char *name, ...)
626 static int prev_checked, prev_failed, max_length;
628 if (state.num_checked > prev_checked) {
629 int pad_length = max_length + 4;
633 pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
635 pad_length -= vfprintf(stderr, name, arg);
637 fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
639 if (state.num_failed == prev_failed)
640 color_printf(COLOR_GREEN, "OK");
642 color_printf(COLOR_RED, "FAILED");
643 fprintf(stderr, "]\n");
645 prev_checked = state.num_checked;
646 prev_failed = state.num_failed;
647 } else if (!state.cpu_flag) {
648 /* Calculate the amount of padding required to make the output vertically aligned */
649 int length = strlen(state.current_test_name);
653 length += vsnprintf(NULL, 0, name, arg);
656 if (length > max_length)