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 { "audiodsp", checkasm_check_audiodsp },
75 { "blockdsp", checkasm_check_blockdsp },
78 { "bswapdsp", checkasm_check_bswapdsp },
80 #if CONFIG_DCA_DECODER
81 { "synth_filter", checkasm_check_synth_filter },
84 { "flacdsp", checkasm_check_flacdsp },
87 { "fmtconvert", checkasm_check_fmtconvert },
90 { "h264dsp", checkasm_check_h264dsp },
93 { "h264pred", checkasm_check_h264pred },
96 { "h264qpel", checkasm_check_h264qpel },
98 #if CONFIG_HEVC_DECODER
99 { "hevc_add_res", checkasm_check_hevc_add_res },
100 { "hevc_idct", checkasm_check_hevc_idct },
102 #if CONFIG_JPEG2000_DECODER
103 { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
105 #if CONFIG_HUFFYUVDSP
106 { "llviddsp", checkasm_check_llviddsp },
108 #if CONFIG_PIXBLOCKDSP
109 { "pixblockdsp", checkasm_check_pixblockdsp },
111 #if CONFIG_V210_ENCODER
112 { "v210enc", checkasm_check_v210enc },
115 { "vp8dsp", checkasm_check_vp8dsp },
117 #if CONFIG_VP9_DECODER
118 { "vp9dsp", checkasm_check_vp9dsp },
121 { "videodsp", checkasm_check_videodsp },
125 #if CONFIG_BLEND_FILTER
126 { "vf_blend", checkasm_check_blend },
128 #if CONFIG_COLORSPACE_FILTER
129 { "vf_colorspace", checkasm_check_colorspace },
133 { "fixed_dsp", checkasm_check_fixed_dsp },
138 /* List of cpu flags to check */
139 static const struct {
145 { "ARMV8", "armv8", AV_CPU_FLAG_ARMV8 },
146 { "NEON", "neon", AV_CPU_FLAG_NEON },
148 { "ARMV5TE", "armv5te", AV_CPU_FLAG_ARMV5TE },
149 { "ARMV6", "armv6", AV_CPU_FLAG_ARMV6 },
150 { "ARMV6T2", "armv6t2", AV_CPU_FLAG_ARMV6T2 },
151 { "VFP", "vfp", AV_CPU_FLAG_VFP },
152 { "VFP_VM", "vfp_vm", AV_CPU_FLAG_VFP_VM },
153 { "VFPV3", "vfp3", AV_CPU_FLAG_VFPV3 },
154 { "NEON", "neon", AV_CPU_FLAG_NEON },
156 { "ALTIVEC", "altivec", AV_CPU_FLAG_ALTIVEC },
157 { "VSX", "vsx", AV_CPU_FLAG_VSX },
158 { "POWER8", "power8", AV_CPU_FLAG_POWER8 },
160 { "MMX", "mmx", AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
161 { "MMXEXT", "mmxext", AV_CPU_FLAG_MMXEXT },
162 { "3DNOW", "3dnow", AV_CPU_FLAG_3DNOW },
163 { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
164 { "SSE", "sse", AV_CPU_FLAG_SSE },
165 { "SSE2", "sse2", AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
166 { "SSE3", "sse3", AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
167 { "SSSE3", "ssse3", AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
168 { "SSE4.1", "sse4", AV_CPU_FLAG_SSE4 },
169 { "SSE4.2", "sse42", AV_CPU_FLAG_SSE42 },
170 { "AES-NI", "aesni", AV_CPU_FLAG_AESNI },
171 { "AVX", "avx", AV_CPU_FLAG_AVX },
172 { "XOP", "xop", AV_CPU_FLAG_XOP },
173 { "FMA3", "fma3", AV_CPU_FLAG_FMA3 },
174 { "FMA4", "fma4", AV_CPU_FLAG_FMA4 },
175 { "AVX2", "avx2", AV_CPU_FLAG_AVX2 },
180 typedef struct CheckasmFuncVersion {
181 struct CheckasmFuncVersion *next;
187 } CheckasmFuncVersion;
189 /* Binary search tree node */
190 typedef struct CheckasmFunc {
191 struct CheckasmFunc *child[2];
192 CheckasmFuncVersion versions;
193 uint8_t color; /* 0 = red, 1 = black */
200 CheckasmFunc *current_func;
201 CheckasmFuncVersion *current_func_ver;
202 const char *current_test_name;
203 const char *bench_pattern;
204 int bench_pattern_len;
209 const char *cpu_flag_name;
210 const char *test_name;
216 /* float compare support code */
217 static int is_negative(union av_intfloat32 u)
222 int float_near_ulp(float a, float b, unsigned max_ulp)
224 union av_intfloat32 x, y;
229 if (is_negative(x) != is_negative(y)) {
230 // handle -0.0 == +0.0
234 if (llabs((int64_t)x.i - y.i) <= max_ulp)
240 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
245 for (i = 0; i < len; i++) {
246 if (!float_near_ulp(a[i], b[i], max_ulp))
252 int float_near_abs_eps(float a, float b, float eps)
254 float abs_diff = fabsf(a - b);
256 return abs_diff < eps;
259 int float_near_abs_eps_array(const float *a, const float *b, float eps,
264 for (i = 0; i < len; i++) {
265 if (!float_near_abs_eps(a[i], b[i], eps))
271 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
273 return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
276 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
277 unsigned max_ulp, unsigned len)
281 for (i = 0; i < len; i++) {
282 if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
288 /* Print colored text to stderr if the terminal supports it */
289 static void color_printf(int color, const char *fmt, ...)
291 static int use_color = -1;
294 #if HAVE_SETCONSOLETEXTATTRIBUTE
296 static WORD org_attributes;
299 CONSOLE_SCREEN_BUFFER_INFO con_info;
300 con = GetStdHandle(STD_ERROR_HANDLE);
301 if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
302 org_attributes = con_info.wAttributes;
308 SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
311 const char *term = getenv("TERM");
312 use_color = term && strcmp(term, "dumb") && isatty(2);
315 fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
319 vfprintf(stderr, fmt, arg);
323 #if HAVE_SETCONSOLETEXTATTRIBUTE
324 SetConsoleTextAttribute(con, org_attributes);
326 fprintf(stderr, "\x1b[0m");
331 /* Deallocate a tree */
332 static void destroy_func_tree(CheckasmFunc *f)
335 CheckasmFuncVersion *v = f->versions.next;
337 CheckasmFuncVersion *next = v->next;
342 destroy_func_tree(f->child[0]);
343 destroy_func_tree(f->child[1]);
348 /* Allocate a zero-initialized block, clean up and exit on failure */
349 static void *checkasm_malloc(size_t size)
351 void *ptr = calloc(1, size);
353 fprintf(stderr, "checkasm: malloc failed\n");
354 destroy_func_tree(state.funcs);
360 /* Get the suffix of the specified cpu flag */
361 static const char *cpu_suffix(int cpu)
363 int i = FF_ARRAY_ELEMS(cpus);
366 if (cpu & cpus[i].flag)
367 return cpus[i].suffix;
373 static int cmp_nop(const void *a, const void *b)
375 return *(const uint16_t*)a - *(const uint16_t*)b;
378 /* Measure the overhead of the timing code (in decicycles) */
379 static int measure_nop_time(void)
381 uint16_t nops[10000];
384 for (i = 0; i < 10000; i++) {
385 uint64_t t = AV_READ_TIME();
386 nops[i] = AV_READ_TIME() - t;
389 qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
390 for (i = 2500; i < 7500; i++)
393 return nop_sum / 500;
396 /* Print benchmark results */
397 static void print_benchs(CheckasmFunc *f)
400 print_benchs(f->child[0]);
402 /* Only print functions with at least one assembly version */
403 if (f->versions.cpu || f->versions.next) {
404 CheckasmFuncVersion *v = &f->versions;
407 int decicycles = (10*v->cycles/v->iterations - state.nop_time) / 4;
408 printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
410 } while ((v = v->next));
413 print_benchs(f->child[1]);
418 /* ASCIIbetical sort except preserving natural order for numbers */
419 static int cmp_func_names(const char *a, const char *b)
421 const char *start = a;
422 int ascii_diff, digit_diff;
424 for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
425 for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
427 if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
433 /* Perform a tree rotation in the specified direction and return the new root */
434 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
436 CheckasmFunc *r = f->child[dir^1];
437 f->child[dir^1] = r->child[dir];
444 #define is_red(f) ((f) && !(f)->color)
446 /* Balance a left-leaning red-black tree at the specified node */
447 static void balance_tree(CheckasmFunc **root)
449 CheckasmFunc *f = *root;
451 if (is_red(f->child[0]) && is_red(f->child[1])) {
453 f->child[0]->color = f->child[1]->color = 1;
456 if (!is_red(f->child[0]) && is_red(f->child[1]))
457 *root = rotate_tree(f, 0); /* Rotate left */
458 else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
459 *root = rotate_tree(f, 1); /* Rotate right */
462 /* Get a node with the specified name, creating it if it doesn't exist */
463 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
465 CheckasmFunc *f = *root;
468 /* Search the tree for a matching node */
469 int cmp = cmp_func_names(name, f->name);
471 f = get_func(&f->child[cmp > 0], name);
473 /* Rebalance the tree on the way up if a new node was inserted */
474 if (!f->versions.func)
478 /* Allocate and insert a new node into the tree */
479 int name_length = strlen(name);
480 f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
481 memcpy(f->name, name, name_length + 1);
487 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
488 static void check_cpu_flag(const char *name, int flag)
490 int old_cpu_flag = state.cpu_flag;
492 flag |= old_cpu_flag;
493 av_force_cpu_flags(-1);
494 state.cpu_flag = flag & av_get_cpu_flags();
495 av_force_cpu_flags(state.cpu_flag);
497 if (!flag || state.cpu_flag != old_cpu_flag) {
500 state.cpu_flag_name = name;
501 for (i = 0; tests[i].func; i++) {
502 if (state.test_name && strcmp(tests[i].name, state.test_name))
504 state.current_test_name = tests[i].name;
510 /* Print the name of the current CPU flag, but only do it once */
511 static void print_cpu_name(void)
513 if (state.cpu_flag_name) {
514 color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
515 state.cpu_flag_name = NULL;
519 int main(int argc, char *argv[])
521 unsigned int seed = av_get_random_seed();
524 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
525 if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
526 checkasm_checked_call = checkasm_checked_call_vfp;
529 if (!tests[0].func || !cpus[0].flag) {
530 fprintf(stderr, "checkasm: no tests to perform\n");
535 if (!strncmp(argv[1], "--bench", 7)) {
537 fprintf(stderr, "checkasm: --bench is not supported on your system\n");
540 if (argv[1][7] == '=') {
541 state.bench_pattern = argv[1] + 8;
542 state.bench_pattern_len = strlen(state.bench_pattern);
544 state.bench_pattern = "";
545 } else if (!strncmp(argv[1], "--test=", 7)) {
546 state.test_name = argv[1] + 7;
548 seed = strtoul(argv[1], NULL, 10);
555 fprintf(stderr, "checkasm: using random seed %u\n", seed);
556 av_lfg_init(&checkasm_lfg, seed);
558 check_cpu_flag(NULL, 0);
559 for (i = 0; cpus[i].flag; i++)
560 check_cpu_flag(cpus[i].name, cpus[i].flag);
562 if (state.num_failed) {
563 fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
566 fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
568 if (state.bench_pattern) {
569 state.nop_time = measure_nop_time();
570 printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
571 print_benchs(state.funcs);
576 destroy_func_tree(state.funcs);
580 /* Decide whether or not the specified function needs to be tested and
581 * allocate/initialize data structures if needed. Returns a pointer to a
582 * reference function if the function should be tested, otherwise NULL */
583 void *checkasm_check_func(void *func, const char *name, ...)
587 CheckasmFuncVersion *v;
592 name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
595 if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
598 state.current_func = get_func(&state.funcs, name_buf);
599 state.funcs->color = 1;
600 v = &state.current_func->versions;
603 CheckasmFuncVersion *prev;
605 /* Only test functions that haven't already been tested */
613 } while ((v = v->next));
615 v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
620 v->cpu = state.cpu_flag;
621 state.current_func_ver = v;
629 /* Decide whether or not the current function needs to be benchmarked */
630 int checkasm_bench_func(void)
632 return !state.num_failed && state.bench_pattern &&
633 !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
636 /* Indicate that the current test has failed */
637 void checkasm_fail_func(const char *msg, ...)
639 if (state.current_func_ver->cpu && state.current_func_ver->ok) {
643 fprintf(stderr, " %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
645 vfprintf(stderr, msg, arg);
647 fprintf(stderr, ")\n");
649 state.current_func_ver->ok = 0;
654 /* Update benchmark results of the current function */
655 void checkasm_update_bench(int iterations, uint64_t cycles)
657 state.current_func_ver->iterations += iterations;
658 state.current_func_ver->cycles += cycles;
661 /* Print the outcome of all tests performed since the last time this function was called */
662 void checkasm_report(const char *name, ...)
664 static int prev_checked, prev_failed, max_length;
666 if (state.num_checked > prev_checked) {
667 int pad_length = max_length + 4;
671 pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
673 pad_length -= vfprintf(stderr, name, arg);
675 fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
677 if (state.num_failed == prev_failed)
678 color_printf(COLOR_GREEN, "OK");
680 color_printf(COLOR_RED, "FAILED");
681 fprintf(stderr, "]\n");
683 prev_checked = state.num_checked;
684 prev_failed = state.num_failed;
685 } else if (!state.cpu_flag) {
686 /* Calculate the amount of padding required to make the output vertically aligned */
687 int length = strlen(state.current_test_name);
691 length += vsnprintf(NULL, 0, name, arg);
694 if (length > max_length)