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.
27 # define _GNU_SOURCE // for syscall (performance monitoring API)
36 #include "libavutil/common.h"
37 #include "libavutil/cpu.h"
38 #include "libavutil/intfloat.h"
39 #include "libavutil/random_seed.h"
45 #if HAVE_SETCONSOLETEXTATTRIBUTE
47 #define COLOR_RED FOREGROUND_RED
48 #define COLOR_GREEN FOREGROUND_GREEN
49 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
53 #define COLOR_YELLOW 3
64 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
65 #include "libavutil/arm/cpu.h"
67 void (*checkasm_checked_call)(void *func, int dummy, ...) = checkasm_checked_call_novfp;
70 /* List of tests to invoke */
76 #if CONFIG_AAC_DECODER
77 { "aacpsdsp", checkasm_check_aacpsdsp },
78 { "sbrdsp", checkasm_check_sbrdsp },
80 #if CONFIG_ALAC_DECODER
81 { "alacdsp", checkasm_check_alacdsp },
84 { "audiodsp", checkasm_check_audiodsp },
87 { "blockdsp", checkasm_check_blockdsp },
90 { "bswapdsp", checkasm_check_bswapdsp },
92 #if CONFIG_DCA_DECODER
93 { "synth_filter", checkasm_check_synth_filter },
95 #if CONFIG_EXR_DECODER
96 { "exrdsp", checkasm_check_exrdsp },
99 { "flacdsp", checkasm_check_flacdsp },
101 #if CONFIG_FMTCONVERT
102 { "fmtconvert", checkasm_check_fmtconvert },
105 { "g722dsp", checkasm_check_g722dsp },
108 { "h264dsp", checkasm_check_h264dsp },
111 { "h264pred", checkasm_check_h264pred },
114 { "h264qpel", checkasm_check_h264qpel },
116 #if CONFIG_HEVC_DECODER
117 { "hevc_add_res", checkasm_check_hevc_add_res },
118 { "hevc_idct", checkasm_check_hevc_idct },
119 { "hevc_sao", checkasm_check_hevc_sao },
121 #if CONFIG_HUFFYUV_DECODER
122 { "huffyuvdsp", checkasm_check_huffyuvdsp },
124 #if CONFIG_JPEG2000_DECODER
125 { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
127 #if CONFIG_HUFFYUVDSP
128 { "llviddsp", checkasm_check_llviddsp },
130 #if CONFIG_LLVIDENCDSP
131 { "llviddspenc", checkasm_check_llviddspenc },
133 #if CONFIG_PIXBLOCKDSP
134 { "pixblockdsp", checkasm_check_pixblockdsp },
136 #if CONFIG_UTVIDEO_DECODER
137 { "utvideodsp", checkasm_check_utvideodsp },
139 #if CONFIG_V210_ENCODER
140 { "v210enc", checkasm_check_v210enc },
143 { "vp8dsp", checkasm_check_vp8dsp },
145 #if CONFIG_VP9_DECODER
146 { "vp9dsp", checkasm_check_vp9dsp },
149 { "videodsp", checkasm_check_videodsp },
153 #if CONFIG_BLEND_FILTER
154 { "vf_blend", checkasm_check_blend },
156 #if CONFIG_COLORSPACE_FILTER
157 { "vf_colorspace", checkasm_check_colorspace },
159 #if CONFIG_HFLIP_FILTER
160 { "vf_hflip", checkasm_check_vf_hflip },
162 #if CONFIG_NLMEANS_FILTER
163 { "vf_nlmeans", checkasm_check_nlmeans },
165 #if CONFIG_THRESHOLD_FILTER
166 { "vf_threshold", checkasm_check_vf_threshold },
170 { "sw_rgb", checkasm_check_sw_rgb },
173 { "fixed_dsp", checkasm_check_fixed_dsp },
174 { "float_dsp", checkasm_check_float_dsp },
179 /* List of cpu flags to check */
180 static const struct {
186 { "ARMV8", "armv8", AV_CPU_FLAG_ARMV8 },
187 { "NEON", "neon", AV_CPU_FLAG_NEON },
189 { "ARMV5TE", "armv5te", AV_CPU_FLAG_ARMV5TE },
190 { "ARMV6", "armv6", AV_CPU_FLAG_ARMV6 },
191 { "ARMV6T2", "armv6t2", AV_CPU_FLAG_ARMV6T2 },
192 { "VFP", "vfp", AV_CPU_FLAG_VFP },
193 { "VFP_VM", "vfp_vm", AV_CPU_FLAG_VFP_VM },
194 { "VFPV3", "vfp3", AV_CPU_FLAG_VFPV3 },
195 { "NEON", "neon", AV_CPU_FLAG_NEON },
197 { "ALTIVEC", "altivec", AV_CPU_FLAG_ALTIVEC },
198 { "VSX", "vsx", AV_CPU_FLAG_VSX },
199 { "POWER8", "power8", AV_CPU_FLAG_POWER8 },
201 { "MMX", "mmx", AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
202 { "MMXEXT", "mmxext", AV_CPU_FLAG_MMXEXT },
203 { "3DNOW", "3dnow", AV_CPU_FLAG_3DNOW },
204 { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
205 { "SSE", "sse", AV_CPU_FLAG_SSE },
206 { "SSE2", "sse2", AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
207 { "SSE3", "sse3", AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
208 { "SSSE3", "ssse3", AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
209 { "SSE4.1", "sse4", AV_CPU_FLAG_SSE4 },
210 { "SSE4.2", "sse42", AV_CPU_FLAG_SSE42 },
211 { "AES-NI", "aesni", AV_CPU_FLAG_AESNI },
212 { "AVX", "avx", AV_CPU_FLAG_AVX },
213 { "XOP", "xop", AV_CPU_FLAG_XOP },
214 { "FMA3", "fma3", AV_CPU_FLAG_FMA3 },
215 { "FMA4", "fma4", AV_CPU_FLAG_FMA4 },
216 { "AVX2", "avx2", AV_CPU_FLAG_AVX2 },
217 { "AVX-512", "avx512", AV_CPU_FLAG_AVX512 },
222 typedef struct CheckasmFuncVersion {
223 struct CheckasmFuncVersion *next;
228 } CheckasmFuncVersion;
230 /* Binary search tree node */
231 typedef struct CheckasmFunc {
232 struct CheckasmFunc *child[2];
233 CheckasmFuncVersion versions;
234 uint8_t color; /* 0 = red, 1 = black */
241 CheckasmFunc *current_func;
242 CheckasmFuncVersion *current_func_ver;
243 const char *current_test_name;
244 const char *bench_pattern;
245 int bench_pattern_len;
254 const char *cpu_flag_name;
255 const char *test_name;
261 /* float compare support code */
262 static int is_negative(union av_intfloat32 u)
267 int float_near_ulp(float a, float b, unsigned max_ulp)
269 union av_intfloat32 x, y;
274 if (is_negative(x) != is_negative(y)) {
275 // handle -0.0 == +0.0
279 if (llabs((int64_t)x.i - y.i) <= max_ulp)
285 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
290 for (i = 0; i < len; i++) {
291 if (!float_near_ulp(a[i], b[i], max_ulp))
297 int float_near_abs_eps(float a, float b, float eps)
299 float abs_diff = fabsf(a - b);
303 fprintf(stderr, "test failed comparing %g with %g (abs diff=%g with EPS=%g)\n", a, b, abs_diff, eps);
308 int float_near_abs_eps_array(const float *a, const float *b, float eps,
313 for (i = 0; i < len; i++) {
314 if (!float_near_abs_eps(a[i], b[i], eps))
320 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
322 return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
325 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
326 unsigned max_ulp, unsigned len)
330 for (i = 0; i < len; i++) {
331 if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
337 int double_near_abs_eps(double a, double b, double eps)
339 double abs_diff = fabs(a - b);
341 return abs_diff < eps;
344 int double_near_abs_eps_array(const double *a, const double *b, double eps,
349 for (i = 0; i < len; i++) {
350 if (!double_near_abs_eps(a[i], b[i], eps))
356 /* Print colored text to stderr if the terminal supports it */
357 static void color_printf(int color, const char *fmt, ...)
359 static int use_color = -1;
362 #if HAVE_SETCONSOLETEXTATTRIBUTE
364 static WORD org_attributes;
367 CONSOLE_SCREEN_BUFFER_INFO con_info;
368 con = GetStdHandle(STD_ERROR_HANDLE);
369 if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
370 org_attributes = con_info.wAttributes;
376 SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
379 const char *term = getenv("TERM");
380 use_color = term && strcmp(term, "dumb") && isatty(2);
383 fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
387 vfprintf(stderr, fmt, arg);
391 #if HAVE_SETCONSOLETEXTATTRIBUTE
392 SetConsoleTextAttribute(con, org_attributes);
394 fprintf(stderr, "\x1b[0m");
399 /* Deallocate a tree */
400 static void destroy_func_tree(CheckasmFunc *f)
403 CheckasmFuncVersion *v = f->versions.next;
405 CheckasmFuncVersion *next = v->next;
410 destroy_func_tree(f->child[0]);
411 destroy_func_tree(f->child[1]);
416 /* Allocate a zero-initialized block, clean up and exit on failure */
417 static void *checkasm_malloc(size_t size)
419 void *ptr = calloc(1, size);
421 fprintf(stderr, "checkasm: malloc failed\n");
422 destroy_func_tree(state.funcs);
428 /* Get the suffix of the specified cpu flag */
429 static const char *cpu_suffix(int cpu)
431 int i = FF_ARRAY_ELEMS(cpus);
434 if (cpu & cpus[i].flag)
435 return cpus[i].suffix;
440 static int cmp_nop(const void *a, const void *b)
442 return *(const uint16_t*)a - *(const uint16_t*)b;
445 /* Measure the overhead of the timing code (in decicycles) */
446 static int measure_nop_time(void)
448 uint16_t nops[10000];
450 av_unused const int sysfd = state.sysfd;
453 for (i = 0; i < 10000; i++) {
459 qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
460 for (i = 2500; i < 7500; i++)
463 return nop_sum / 500;
466 /* Print benchmark results */
467 static void print_benchs(CheckasmFunc *f)
470 print_benchs(f->child[0]);
472 /* Only print functions with at least one assembly version */
473 if (f->versions.cpu || f->versions.next) {
474 CheckasmFuncVersion *v = &f->versions;
476 CheckasmPerf *p = &v->perf;
478 int decicycles = (10*p->cycles/p->iterations - state.nop_time) / 4;
479 printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
481 } while ((v = v->next));
484 print_benchs(f->child[1]);
488 /* ASCIIbetical sort except preserving natural order for numbers */
489 static int cmp_func_names(const char *a, const char *b)
491 const char *start = a;
492 int ascii_diff, digit_diff;
494 for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
495 for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
497 if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
503 /* Perform a tree rotation in the specified direction and return the new root */
504 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
506 CheckasmFunc *r = f->child[dir^1];
507 f->child[dir^1] = r->child[dir];
514 #define is_red(f) ((f) && !(f)->color)
516 /* Balance a left-leaning red-black tree at the specified node */
517 static void balance_tree(CheckasmFunc **root)
519 CheckasmFunc *f = *root;
521 if (is_red(f->child[0]) && is_red(f->child[1])) {
523 f->child[0]->color = f->child[1]->color = 1;
526 if (!is_red(f->child[0]) && is_red(f->child[1]))
527 *root = rotate_tree(f, 0); /* Rotate left */
528 else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
529 *root = rotate_tree(f, 1); /* Rotate right */
532 /* Get a node with the specified name, creating it if it doesn't exist */
533 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
535 CheckasmFunc *f = *root;
538 /* Search the tree for a matching node */
539 int cmp = cmp_func_names(name, f->name);
541 f = get_func(&f->child[cmp > 0], name);
543 /* Rebalance the tree on the way up if a new node was inserted */
544 if (!f->versions.func)
548 /* Allocate and insert a new node into the tree */
549 int name_length = strlen(name);
550 f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
551 memcpy(f->name, name, name_length + 1);
557 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
558 static void check_cpu_flag(const char *name, int flag)
560 int old_cpu_flag = state.cpu_flag;
562 flag |= old_cpu_flag;
563 av_force_cpu_flags(-1);
564 state.cpu_flag = flag & av_get_cpu_flags();
565 av_force_cpu_flags(state.cpu_flag);
567 if (!flag || state.cpu_flag != old_cpu_flag) {
570 state.cpu_flag_name = name;
571 for (i = 0; tests[i].func; i++) {
572 if (state.test_name && strcmp(tests[i].name, state.test_name))
574 state.current_test_name = tests[i].name;
580 /* Print the name of the current CPU flag, but only do it once */
581 static void print_cpu_name(void)
583 if (state.cpu_flag_name) {
584 color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
585 state.cpu_flag_name = NULL;
589 #if CONFIG_LINUX_PERF
590 static int bench_init_linux(void)
592 struct perf_event_attr attr = {
593 .type = PERF_TYPE_HARDWARE,
594 .size = sizeof(struct perf_event_attr),
595 .config = PERF_COUNT_HW_CPU_CYCLES,
596 .disabled = 1, // start counting only on demand
601 printf("benchmarking with Linux Perf Monitoring API\n");
603 state.sysfd = syscall(__NR_perf_event_open, &attr, 0, -1, -1, 0);
604 if (state.sysfd == -1) {
612 static int bench_init_ffmpeg(void)
615 printf("benchmarking with native FFmpeg timers\n");
618 fprintf(stderr, "checkasm: --bench is not supported on your system\n");
623 static int bench_init(void)
625 #if CONFIG_LINUX_PERF
626 int ret = bench_init_linux();
628 int ret = bench_init_ffmpeg();
633 state.nop_time = measure_nop_time();
634 printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
638 static void bench_uninit(void)
640 #if CONFIG_LINUX_PERF
646 int main(int argc, char *argv[])
648 unsigned int seed = av_get_random_seed();
651 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
652 if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
653 checkasm_checked_call = checkasm_checked_call_vfp;
656 if (!tests[0].func || !cpus[0].flag) {
657 fprintf(stderr, "checkasm: no tests to perform\n");
662 if (!strncmp(argv[1], "--bench", 7)) {
663 if (bench_init() < 0)
665 if (argv[1][7] == '=') {
666 state.bench_pattern = argv[1] + 8;
667 state.bench_pattern_len = strlen(state.bench_pattern);
669 state.bench_pattern = "";
670 } else if (!strncmp(argv[1], "--test=", 7)) {
671 state.test_name = argv[1] + 7;
673 seed = strtoul(argv[1], NULL, 10);
680 fprintf(stderr, "checkasm: using random seed %u\n", seed);
681 av_lfg_init(&checkasm_lfg, seed);
683 check_cpu_flag(NULL, 0);
684 for (i = 0; cpus[i].flag; i++)
685 check_cpu_flag(cpus[i].name, cpus[i].flag);
687 if (state.num_failed) {
688 fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
691 fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
692 if (state.bench_pattern) {
693 print_benchs(state.funcs);
697 destroy_func_tree(state.funcs);
702 /* Decide whether or not the specified function needs to be tested and
703 * allocate/initialize data structures if needed. Returns a pointer to a
704 * reference function if the function should be tested, otherwise NULL */
705 void *checkasm_check_func(void *func, const char *name, ...)
709 CheckasmFuncVersion *v;
714 name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
717 if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
720 state.current_func = get_func(&state.funcs, name_buf);
721 state.funcs->color = 1;
722 v = &state.current_func->versions;
725 CheckasmFuncVersion *prev;
727 /* Only test functions that haven't already been tested */
735 } while ((v = v->next));
737 v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
742 v->cpu = state.cpu_flag;
743 state.current_func_ver = v;
751 /* Decide whether or not the current function needs to be benchmarked */
752 int checkasm_bench_func(void)
754 return !state.num_failed && state.bench_pattern &&
755 !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
758 /* Indicate that the current test has failed */
759 void checkasm_fail_func(const char *msg, ...)
761 if (state.current_func_ver->cpu && state.current_func_ver->ok) {
765 fprintf(stderr, " %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
767 vfprintf(stderr, msg, arg);
769 fprintf(stderr, ")\n");
771 state.current_func_ver->ok = 0;
776 /* Get the benchmark context of the current function */
777 CheckasmPerf *checkasm_get_perf_context(void)
779 CheckasmPerf *perf = &state.current_func_ver->perf;
780 memset(perf, 0, sizeof(*perf));
781 perf->sysfd = state.sysfd;
785 /* Print the outcome of all tests performed since the last time this function was called */
786 void checkasm_report(const char *name, ...)
788 static int prev_checked, prev_failed, max_length;
790 if (state.num_checked > prev_checked) {
791 int pad_length = max_length + 4;
795 pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
797 pad_length -= vfprintf(stderr, name, arg);
799 fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
801 if (state.num_failed == prev_failed)
802 color_printf(COLOR_GREEN, "OK");
804 color_printf(COLOR_RED, "FAILED");
805 fprintf(stderr, "]\n");
807 prev_checked = state.num_checked;
808 prev_failed = state.num_failed;
809 } else if (!state.cpu_flag) {
810 /* Calculate the amount of padding required to make the output vertically aligned */
811 int length = strlen(state.current_test_name);
815 length += vsnprintf(NULL, 0, name, arg);
818 if (length > max_length)