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 && HAVE_GETSTDHANDLE
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_qpel", checkasm_check_hevc_qpel },
120 { "hevc_qpel_uni", checkasm_check_hevc_qpel_uni },
121 { "hevc_qpel_uni_w", checkasm_check_hevc_qpel_uni_w },
122 { "hevc_qpel_bi", checkasm_check_hevc_qpel_bi },
123 { "hevc_qpel_bi_w", checkasm_check_hevc_qpel_bi_w },
124 { "hevc_epel", checkasm_check_hevc_epel },
125 { "hevc_epel_uni", checkasm_check_hevc_epel_uni },
126 { "hevc_epel_uni_w", checkasm_check_hevc_epel_uni_w },
127 { "hevc_epel_bi", checkasm_check_hevc_epel_bi },
128 { "hevc_epel_bi_w", checkasm_check_hevc_epel_bi_w },
129 { "hevc_sao", checkasm_check_hevc_sao },
131 #if CONFIG_HUFFYUV_DECODER
132 { "huffyuvdsp", checkasm_check_huffyuvdsp },
134 #if CONFIG_JPEG2000_DECODER
135 { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
137 #if CONFIG_HUFFYUVDSP
138 { "llviddsp", checkasm_check_llviddsp },
140 #if CONFIG_LLVIDENCDSP
141 { "llviddspenc", checkasm_check_llviddspenc },
143 #if CONFIG_OPUS_DECODER
144 { "opusdsp", checkasm_check_opusdsp },
146 #if CONFIG_PIXBLOCKDSP
147 { "pixblockdsp", checkasm_check_pixblockdsp },
149 #if CONFIG_UTVIDEO_DECODER
150 { "utvideodsp", checkasm_check_utvideodsp },
152 #if CONFIG_V210_DECODER
153 { "v210dec", checkasm_check_v210dec },
155 #if CONFIG_V210_ENCODER
156 { "v210enc", checkasm_check_v210enc },
159 { "vp8dsp", checkasm_check_vp8dsp },
161 #if CONFIG_VP9_DECODER
162 { "vp9dsp", checkasm_check_vp9dsp },
165 { "videodsp", checkasm_check_videodsp },
169 #if CONFIG_AFIR_FILTER
170 { "af_afir", checkasm_check_afir },
172 #if CONFIG_BLEND_FILTER
173 { "vf_blend", checkasm_check_blend },
175 #if CONFIG_COLORSPACE_FILTER
176 { "vf_colorspace", checkasm_check_colorspace },
179 { "vf_eq", checkasm_check_vf_eq },
181 #if CONFIG_GBLUR_FILTER
182 { "vf_gblur", checkasm_check_vf_gblur },
184 #if CONFIG_HFLIP_FILTER
185 { "vf_hflip", checkasm_check_vf_hflip },
187 #if CONFIG_NLMEANS_FILTER
188 { "vf_nlmeans", checkasm_check_nlmeans },
190 #if CONFIG_THRESHOLD_FILTER
191 { "vf_threshold", checkasm_check_vf_threshold },
195 { "sw_rgb", checkasm_check_sw_rgb },
196 { "sw_scale", checkasm_check_sw_scale },
199 { "fixed_dsp", checkasm_check_fixed_dsp },
200 { "float_dsp", checkasm_check_float_dsp },
201 { "av_tx", checkasm_check_av_tx },
206 /* List of cpu flags to check */
207 static const struct {
213 { "ARMV8", "armv8", AV_CPU_FLAG_ARMV8 },
214 { "NEON", "neon", AV_CPU_FLAG_NEON },
216 { "ARMV5TE", "armv5te", AV_CPU_FLAG_ARMV5TE },
217 { "ARMV6", "armv6", AV_CPU_FLAG_ARMV6 },
218 { "ARMV6T2", "armv6t2", AV_CPU_FLAG_ARMV6T2 },
219 { "VFP", "vfp", AV_CPU_FLAG_VFP },
220 { "VFP_VM", "vfp_vm", AV_CPU_FLAG_VFP_VM },
221 { "VFPV3", "vfp3", AV_CPU_FLAG_VFPV3 },
222 { "NEON", "neon", AV_CPU_FLAG_NEON },
224 { "ALTIVEC", "altivec", AV_CPU_FLAG_ALTIVEC },
225 { "VSX", "vsx", AV_CPU_FLAG_VSX },
226 { "POWER8", "power8", AV_CPU_FLAG_POWER8 },
228 { "MMI", "mmi", AV_CPU_FLAG_MMI },
229 { "MSA", "msa", AV_CPU_FLAG_MSA },
231 { "MMX", "mmx", AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
232 { "MMXEXT", "mmxext", AV_CPU_FLAG_MMXEXT },
233 { "3DNOW", "3dnow", AV_CPU_FLAG_3DNOW },
234 { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
235 { "SSE", "sse", AV_CPU_FLAG_SSE },
236 { "SSE2", "sse2", AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
237 { "SSE3", "sse3", AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
238 { "SSSE3", "ssse3", AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
239 { "SSE4.1", "sse4", AV_CPU_FLAG_SSE4 },
240 { "SSE4.2", "sse42", AV_CPU_FLAG_SSE42 },
241 { "AES-NI", "aesni", AV_CPU_FLAG_AESNI },
242 { "AVX", "avx", AV_CPU_FLAG_AVX },
243 { "XOP", "xop", AV_CPU_FLAG_XOP },
244 { "FMA3", "fma3", AV_CPU_FLAG_FMA3 },
245 { "FMA4", "fma4", AV_CPU_FLAG_FMA4 },
246 { "AVX2", "avx2", AV_CPU_FLAG_AVX2 },
247 { "AVX-512", "avx512", AV_CPU_FLAG_AVX512 },
252 typedef struct CheckasmFuncVersion {
253 struct CheckasmFuncVersion *next;
258 } CheckasmFuncVersion;
260 /* Binary search tree node */
261 typedef struct CheckasmFunc {
262 struct CheckasmFunc *child[2];
263 CheckasmFuncVersion versions;
264 uint8_t color; /* 0 = red, 1 = black */
271 CheckasmFunc *current_func;
272 CheckasmFuncVersion *current_func_ver;
273 const char *current_test_name;
274 const char *bench_pattern;
275 int bench_pattern_len;
284 const char *cpu_flag_name;
285 const char *test_name;
292 /* float compare support code */
293 static int is_negative(union av_intfloat32 u)
298 int float_near_ulp(float a, float b, unsigned max_ulp)
300 union av_intfloat32 x, y;
305 if (is_negative(x) != is_negative(y)) {
306 // handle -0.0 == +0.0
310 if (llabs((int64_t)x.i - y.i) <= max_ulp)
316 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
321 for (i = 0; i < len; i++) {
322 if (!float_near_ulp(a[i], b[i], max_ulp))
328 int float_near_abs_eps(float a, float b, float eps)
330 float abs_diff = fabsf(a - b);
334 fprintf(stderr, "test failed comparing %g with %g (abs diff=%g with EPS=%g)\n", a, b, abs_diff, eps);
339 int float_near_abs_eps_array(const float *a, const float *b, float eps,
344 for (i = 0; i < len; i++) {
345 if (!float_near_abs_eps(a[i], b[i], eps))
351 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
353 return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
356 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
357 unsigned max_ulp, unsigned len)
361 for (i = 0; i < len; i++) {
362 if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
368 int double_near_abs_eps(double a, double b, double eps)
370 double abs_diff = fabs(a - b);
372 return abs_diff < eps;
375 int double_near_abs_eps_array(const double *a, const double *b, double eps,
380 for (i = 0; i < len; i++) {
381 if (!double_near_abs_eps(a[i], b[i], eps))
387 /* Print colored text to stderr if the terminal supports it */
388 static void color_printf(int color, const char *fmt, ...)
390 static int use_color = -1;
393 #if HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
395 static WORD org_attributes;
398 CONSOLE_SCREEN_BUFFER_INFO con_info;
399 con = GetStdHandle(STD_ERROR_HANDLE);
400 if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
401 org_attributes = con_info.wAttributes;
407 SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
410 const char *term = getenv("TERM");
411 use_color = term && strcmp(term, "dumb") && isatty(2);
414 fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
418 vfprintf(stderr, fmt, arg);
422 #if HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
423 SetConsoleTextAttribute(con, org_attributes);
425 fprintf(stderr, "\x1b[0m");
430 /* Deallocate a tree */
431 static void destroy_func_tree(CheckasmFunc *f)
434 CheckasmFuncVersion *v = f->versions.next;
436 CheckasmFuncVersion *next = v->next;
441 destroy_func_tree(f->child[0]);
442 destroy_func_tree(f->child[1]);
447 /* Allocate a zero-initialized block, clean up and exit on failure */
448 static void *checkasm_malloc(size_t size)
450 void *ptr = calloc(1, size);
452 fprintf(stderr, "checkasm: malloc failed\n");
453 destroy_func_tree(state.funcs);
459 /* Get the suffix of the specified cpu flag */
460 static const char *cpu_suffix(int cpu)
462 int i = FF_ARRAY_ELEMS(cpus);
465 if (cpu & cpus[i].flag)
466 return cpus[i].suffix;
471 static int cmp_nop(const void *a, const void *b)
473 return *(const uint16_t*)a - *(const uint16_t*)b;
476 /* Measure the overhead of the timing code (in decicycles) */
477 static int measure_nop_time(void)
479 uint16_t nops[10000];
481 av_unused const int sysfd = state.sysfd;
484 for (i = 0; i < 10000; i++) {
490 qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
491 for (i = 2500; i < 7500; i++)
494 return nop_sum / 500;
497 /* Print benchmark results */
498 static void print_benchs(CheckasmFunc *f)
501 print_benchs(f->child[0]);
503 /* Only print functions with at least one assembly version */
504 if (f->versions.cpu || f->versions.next) {
505 CheckasmFuncVersion *v = &f->versions;
507 CheckasmPerf *p = &v->perf;
509 int decicycles = (10*p->cycles/p->iterations - state.nop_time) / 4;
510 printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
512 } while ((v = v->next));
515 print_benchs(f->child[1]);
519 /* ASCIIbetical sort except preserving natural order for numbers */
520 static int cmp_func_names(const char *a, const char *b)
522 const char *start = a;
523 int ascii_diff, digit_diff;
525 for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
526 for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
528 if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
534 /* Perform a tree rotation in the specified direction and return the new root */
535 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
537 CheckasmFunc *r = f->child[dir^1];
538 f->child[dir^1] = r->child[dir];
545 #define is_red(f) ((f) && !(f)->color)
547 /* Balance a left-leaning red-black tree at the specified node */
548 static void balance_tree(CheckasmFunc **root)
550 CheckasmFunc *f = *root;
552 if (is_red(f->child[0]) && is_red(f->child[1])) {
554 f->child[0]->color = f->child[1]->color = 1;
557 if (!is_red(f->child[0]) && is_red(f->child[1]))
558 *root = rotate_tree(f, 0); /* Rotate left */
559 else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
560 *root = rotate_tree(f, 1); /* Rotate right */
563 /* Get a node with the specified name, creating it if it doesn't exist */
564 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
566 CheckasmFunc *f = *root;
569 /* Search the tree for a matching node */
570 int cmp = cmp_func_names(name, f->name);
572 f = get_func(&f->child[cmp > 0], name);
574 /* Rebalance the tree on the way up if a new node was inserted */
575 if (!f->versions.func)
579 /* Allocate and insert a new node into the tree */
580 int name_length = strlen(name);
581 f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
582 memcpy(f->name, name, name_length + 1);
588 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
589 static void check_cpu_flag(const char *name, int flag)
591 int old_cpu_flag = state.cpu_flag;
593 flag |= old_cpu_flag;
594 av_force_cpu_flags(-1);
595 state.cpu_flag = flag & av_get_cpu_flags();
596 av_force_cpu_flags(state.cpu_flag);
598 if (!flag || state.cpu_flag != old_cpu_flag) {
601 state.cpu_flag_name = name;
602 for (i = 0; tests[i].func; i++) {
603 if (state.test_name && strcmp(tests[i].name, state.test_name))
605 state.current_test_name = tests[i].name;
611 /* Print the name of the current CPU flag, but only do it once */
612 static void print_cpu_name(void)
614 if (state.cpu_flag_name) {
615 color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
616 state.cpu_flag_name = NULL;
620 #if CONFIG_LINUX_PERF
621 static int bench_init_linux(void)
623 struct perf_event_attr attr = {
624 .type = PERF_TYPE_HARDWARE,
625 .size = sizeof(struct perf_event_attr),
626 .config = PERF_COUNT_HW_CPU_CYCLES,
627 .disabled = 1, // start counting only on demand
632 printf("benchmarking with Linux Perf Monitoring API\n");
634 state.sysfd = syscall(__NR_perf_event_open, &attr, 0, -1, -1, 0);
635 if (state.sysfd == -1) {
643 #if !CONFIG_LINUX_PERF
644 static int bench_init_ffmpeg(void)
647 printf("benchmarking with native FFmpeg timers\n");
650 fprintf(stderr, "checkasm: --bench is not supported on your system\n");
656 static int bench_init(void)
658 #if CONFIG_LINUX_PERF
659 int ret = bench_init_linux();
661 int ret = bench_init_ffmpeg();
666 state.nop_time = measure_nop_time();
667 printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
671 static void bench_uninit(void)
673 #if CONFIG_LINUX_PERF
679 int main(int argc, char *argv[])
681 unsigned int seed = av_get_random_seed();
684 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
685 if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
686 checkasm_checked_call = checkasm_checked_call_vfp;
689 if (!tests[0].func || !cpus[0].flag) {
690 fprintf(stderr, "checkasm: no tests to perform\n");
695 if (!strncmp(argv[1], "--bench", 7)) {
696 if (bench_init() < 0)
698 if (argv[1][7] == '=') {
699 state.bench_pattern = argv[1] + 8;
700 state.bench_pattern_len = strlen(state.bench_pattern);
702 state.bench_pattern = "";
703 } else if (!strncmp(argv[1], "--test=", 7)) {
704 state.test_name = argv[1] + 7;
705 } else if (!strcmp(argv[1], "--verbose") || !strcmp(argv[1], "-v")) {
708 seed = strtoul(argv[1], NULL, 10);
715 fprintf(stderr, "checkasm: using random seed %u\n", seed);
716 av_lfg_init(&checkasm_lfg, seed);
718 check_cpu_flag(NULL, 0);
719 for (i = 0; cpus[i].flag; i++)
720 check_cpu_flag(cpus[i].name, cpus[i].flag);
722 if (state.num_failed) {
723 fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
726 fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
727 if (state.bench_pattern) {
728 print_benchs(state.funcs);
732 destroy_func_tree(state.funcs);
737 /* Decide whether or not the specified function needs to be tested and
738 * allocate/initialize data structures if needed. Returns a pointer to a
739 * reference function if the function should be tested, otherwise NULL */
740 void *checkasm_check_func(void *func, const char *name, ...)
744 CheckasmFuncVersion *v;
749 name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
752 if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
755 state.current_func = get_func(&state.funcs, name_buf);
756 state.funcs->color = 1;
757 v = &state.current_func->versions;
760 CheckasmFuncVersion *prev;
762 /* Only test functions that haven't already been tested */
770 } while ((v = v->next));
772 v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
777 v->cpu = state.cpu_flag;
778 state.current_func_ver = v;
786 /* Decide whether or not the current function needs to be benchmarked */
787 int checkasm_bench_func(void)
789 return !state.num_failed && state.bench_pattern &&
790 !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
793 /* Indicate that the current test has failed */
794 void checkasm_fail_func(const char *msg, ...)
796 if (state.current_func_ver->cpu && state.current_func_ver->ok) {
800 fprintf(stderr, " %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
802 vfprintf(stderr, msg, arg);
804 fprintf(stderr, ")\n");
806 state.current_func_ver->ok = 0;
811 /* Get the benchmark context of the current function */
812 CheckasmPerf *checkasm_get_perf_context(void)
814 CheckasmPerf *perf = &state.current_func_ver->perf;
815 memset(perf, 0, sizeof(*perf));
816 perf->sysfd = state.sysfd;
820 /* Print the outcome of all tests performed since the last time this function was called */
821 void checkasm_report(const char *name, ...)
823 static int prev_checked, prev_failed, max_length;
825 if (state.num_checked > prev_checked) {
826 int pad_length = max_length + 4;
830 pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
832 pad_length -= vfprintf(stderr, name, arg);
834 fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
836 if (state.num_failed == prev_failed)
837 color_printf(COLOR_GREEN, "OK");
839 color_printf(COLOR_RED, "FAILED");
840 fprintf(stderr, "]\n");
842 prev_checked = state.num_checked;
843 prev_failed = state.num_failed;
844 } else if (!state.cpu_flag) {
845 /* Calculate the amount of padding required to make the output vertically aligned */
846 int length = strlen(state.current_test_name);
850 length += vsnprintf(NULL, 0, name, arg);
853 if (length > max_length)
858 #define DEF_CHECKASM_CHECK_FUNC(type, fmt) \
859 int checkasm_check_##type(const char *const file, const int line, \
860 const type *buf1, ptrdiff_t stride1, \
861 const type *buf2, ptrdiff_t stride2, \
862 const int w, int h, const char *const name) \
865 stride1 /= sizeof(*buf1); \
866 stride2 /= sizeof(*buf2); \
867 for (y = 0; y < h; y++) \
868 if (memcmp(&buf1[y*stride1], &buf2[y*stride2], w*sizeof(*buf1))) \
872 checkasm_fail_func("%s:%d", file, line); \
873 if (!state.verbose) \
875 fprintf(stderr, "%s:\n", name); \
877 for (int x = 0; x < w; x++) \
878 fprintf(stderr, " " fmt, buf1[x]); \
879 fprintf(stderr, " "); \
880 for (int x = 0; x < w; x++) \
881 fprintf(stderr, " " fmt, buf2[x]); \
882 fprintf(stderr, " "); \
883 for (int x = 0; x < w; x++) \
884 fprintf(stderr, "%c", buf1[x] != buf2[x] ? 'x' : '.'); \
887 fprintf(stderr, "\n"); \
892 DEF_CHECKASM_CHECK_FUNC(uint8_t, "%02x")
893 DEF_CHECKASM_CHECK_FUNC(uint16_t, "%04x")
894 DEF_CHECKASM_CHECK_FUNC(int16_t, "%6d")
895 DEF_CHECKASM_CHECK_FUNC(int32_t, "%9d")