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 },
120 #if CONFIG_HUFFYUV_DECODER
121 { "huffyuvdsp", checkasm_check_huffyuvdsp },
123 #if CONFIG_JPEG2000_DECODER
124 { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
126 #if CONFIG_HUFFYUVDSP
127 { "llviddsp", checkasm_check_llviddsp },
129 #if CONFIG_PIXBLOCKDSP
130 { "pixblockdsp", checkasm_check_pixblockdsp },
132 #if CONFIG_UTVIDEO_DECODER
133 { "utvideodsp", checkasm_check_utvideodsp },
135 #if CONFIG_V210_ENCODER
136 { "v210enc", checkasm_check_v210enc },
139 { "vp8dsp", checkasm_check_vp8dsp },
141 #if CONFIG_VP9_DECODER
142 { "vp9dsp", checkasm_check_vp9dsp },
145 { "videodsp", checkasm_check_videodsp },
149 #if CONFIG_BLEND_FILTER
150 { "vf_blend", checkasm_check_blend },
152 #if CONFIG_COLORSPACE_FILTER
153 { "vf_colorspace", checkasm_check_colorspace },
155 #if CONFIG_HFLIP_FILTER
156 { "vf_hflip", checkasm_check_vf_hflip },
158 #if CONFIG_THRESHOLD_FILTER
159 { "vf_threshold", checkasm_check_vf_threshold },
163 { "fixed_dsp", checkasm_check_fixed_dsp },
164 { "float_dsp", checkasm_check_float_dsp },
169 /* List of cpu flags to check */
170 static const struct {
176 { "ARMV8", "armv8", AV_CPU_FLAG_ARMV8 },
177 { "NEON", "neon", AV_CPU_FLAG_NEON },
179 { "ARMV5TE", "armv5te", AV_CPU_FLAG_ARMV5TE },
180 { "ARMV6", "armv6", AV_CPU_FLAG_ARMV6 },
181 { "ARMV6T2", "armv6t2", AV_CPU_FLAG_ARMV6T2 },
182 { "VFP", "vfp", AV_CPU_FLAG_VFP },
183 { "VFP_VM", "vfp_vm", AV_CPU_FLAG_VFP_VM },
184 { "VFPV3", "vfp3", AV_CPU_FLAG_VFPV3 },
185 { "NEON", "neon", AV_CPU_FLAG_NEON },
187 { "ALTIVEC", "altivec", AV_CPU_FLAG_ALTIVEC },
188 { "VSX", "vsx", AV_CPU_FLAG_VSX },
189 { "POWER8", "power8", AV_CPU_FLAG_POWER8 },
191 { "MMX", "mmx", AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
192 { "MMXEXT", "mmxext", AV_CPU_FLAG_MMXEXT },
193 { "3DNOW", "3dnow", AV_CPU_FLAG_3DNOW },
194 { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
195 { "SSE", "sse", AV_CPU_FLAG_SSE },
196 { "SSE2", "sse2", AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
197 { "SSE3", "sse3", AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
198 { "SSSE3", "ssse3", AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
199 { "SSE4.1", "sse4", AV_CPU_FLAG_SSE4 },
200 { "SSE4.2", "sse42", AV_CPU_FLAG_SSE42 },
201 { "AES-NI", "aesni", AV_CPU_FLAG_AESNI },
202 { "AVX", "avx", AV_CPU_FLAG_AVX },
203 { "XOP", "xop", AV_CPU_FLAG_XOP },
204 { "FMA3", "fma3", AV_CPU_FLAG_FMA3 },
205 { "FMA4", "fma4", AV_CPU_FLAG_FMA4 },
206 { "AVX2", "avx2", AV_CPU_FLAG_AVX2 },
211 typedef struct CheckasmFuncVersion {
212 struct CheckasmFuncVersion *next;
217 } CheckasmFuncVersion;
219 /* Binary search tree node */
220 typedef struct CheckasmFunc {
221 struct CheckasmFunc *child[2];
222 CheckasmFuncVersion versions;
223 uint8_t color; /* 0 = red, 1 = black */
230 CheckasmFunc *current_func;
231 CheckasmFuncVersion *current_func_ver;
232 const char *current_test_name;
233 const char *bench_pattern;
234 int bench_pattern_len;
243 const char *cpu_flag_name;
244 const char *test_name;
250 /* float compare support code */
251 static int is_negative(union av_intfloat32 u)
256 int float_near_ulp(float a, float b, unsigned max_ulp)
258 union av_intfloat32 x, y;
263 if (is_negative(x) != is_negative(y)) {
264 // handle -0.0 == +0.0
268 if (llabs((int64_t)x.i - y.i) <= max_ulp)
274 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
279 for (i = 0; i < len; i++) {
280 if (!float_near_ulp(a[i], b[i], max_ulp))
286 int float_near_abs_eps(float a, float b, float eps)
288 float abs_diff = fabsf(a - b);
290 return abs_diff < eps;
293 int float_near_abs_eps_array(const float *a, const float *b, float eps,
298 for (i = 0; i < len; i++) {
299 if (!float_near_abs_eps(a[i], b[i], eps))
305 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
307 return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
310 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
311 unsigned max_ulp, unsigned len)
315 for (i = 0; i < len; i++) {
316 if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
322 int double_near_abs_eps(double a, double b, double eps)
324 double abs_diff = fabs(a - b);
326 return abs_diff < eps;
329 int double_near_abs_eps_array(const double *a, const double *b, double eps,
334 for (i = 0; i < len; i++) {
335 if (!double_near_abs_eps(a[i], b[i], eps))
341 /* Print colored text to stderr if the terminal supports it */
342 static void color_printf(int color, const char *fmt, ...)
344 static int use_color = -1;
347 #if HAVE_SETCONSOLETEXTATTRIBUTE
349 static WORD org_attributes;
352 CONSOLE_SCREEN_BUFFER_INFO con_info;
353 con = GetStdHandle(STD_ERROR_HANDLE);
354 if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
355 org_attributes = con_info.wAttributes;
361 SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
364 const char *term = getenv("TERM");
365 use_color = term && strcmp(term, "dumb") && isatty(2);
368 fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
372 vfprintf(stderr, fmt, arg);
376 #if HAVE_SETCONSOLETEXTATTRIBUTE
377 SetConsoleTextAttribute(con, org_attributes);
379 fprintf(stderr, "\x1b[0m");
384 /* Deallocate a tree */
385 static void destroy_func_tree(CheckasmFunc *f)
388 CheckasmFuncVersion *v = f->versions.next;
390 CheckasmFuncVersion *next = v->next;
395 destroy_func_tree(f->child[0]);
396 destroy_func_tree(f->child[1]);
401 /* Allocate a zero-initialized block, clean up and exit on failure */
402 static void *checkasm_malloc(size_t size)
404 void *ptr = calloc(1, size);
406 fprintf(stderr, "checkasm: malloc failed\n");
407 destroy_func_tree(state.funcs);
413 /* Get the suffix of the specified cpu flag */
414 static const char *cpu_suffix(int cpu)
416 int i = FF_ARRAY_ELEMS(cpus);
419 if (cpu & cpus[i].flag)
420 return cpus[i].suffix;
425 static int cmp_nop(const void *a, const void *b)
427 return *(const uint16_t*)a - *(const uint16_t*)b;
430 /* Measure the overhead of the timing code (in decicycles) */
431 static int measure_nop_time(void)
433 uint16_t nops[10000];
435 av_unused const int sysfd = state.sysfd;
438 for (i = 0; i < 10000; i++) {
444 qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
445 for (i = 2500; i < 7500; i++)
448 return nop_sum / 500;
451 /* Print benchmark results */
452 static void print_benchs(CheckasmFunc *f)
455 print_benchs(f->child[0]);
457 /* Only print functions with at least one assembly version */
458 if (f->versions.cpu || f->versions.next) {
459 CheckasmFuncVersion *v = &f->versions;
461 CheckasmPerf *p = &v->perf;
463 int decicycles = (10*p->cycles/p->iterations - state.nop_time) / 4;
464 printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
466 } while ((v = v->next));
469 print_benchs(f->child[1]);
473 /* ASCIIbetical sort except preserving natural order for numbers */
474 static int cmp_func_names(const char *a, const char *b)
476 const char *start = a;
477 int ascii_diff, digit_diff;
479 for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
480 for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
482 if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
488 /* Perform a tree rotation in the specified direction and return the new root */
489 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
491 CheckasmFunc *r = f->child[dir^1];
492 f->child[dir^1] = r->child[dir];
499 #define is_red(f) ((f) && !(f)->color)
501 /* Balance a left-leaning red-black tree at the specified node */
502 static void balance_tree(CheckasmFunc **root)
504 CheckasmFunc *f = *root;
506 if (is_red(f->child[0]) && is_red(f->child[1])) {
508 f->child[0]->color = f->child[1]->color = 1;
511 if (!is_red(f->child[0]) && is_red(f->child[1]))
512 *root = rotate_tree(f, 0); /* Rotate left */
513 else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
514 *root = rotate_tree(f, 1); /* Rotate right */
517 /* Get a node with the specified name, creating it if it doesn't exist */
518 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
520 CheckasmFunc *f = *root;
523 /* Search the tree for a matching node */
524 int cmp = cmp_func_names(name, f->name);
526 f = get_func(&f->child[cmp > 0], name);
528 /* Rebalance the tree on the way up if a new node was inserted */
529 if (!f->versions.func)
533 /* Allocate and insert a new node into the tree */
534 int name_length = strlen(name);
535 f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
536 memcpy(f->name, name, name_length + 1);
542 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
543 static void check_cpu_flag(const char *name, int flag)
545 int old_cpu_flag = state.cpu_flag;
547 flag |= old_cpu_flag;
548 av_force_cpu_flags(-1);
549 state.cpu_flag = flag & av_get_cpu_flags();
550 av_force_cpu_flags(state.cpu_flag);
552 if (!flag || state.cpu_flag != old_cpu_flag) {
555 state.cpu_flag_name = name;
556 for (i = 0; tests[i].func; i++) {
557 if (state.test_name && strcmp(tests[i].name, state.test_name))
559 state.current_test_name = tests[i].name;
565 /* Print the name of the current CPU flag, but only do it once */
566 static void print_cpu_name(void)
568 if (state.cpu_flag_name) {
569 color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
570 state.cpu_flag_name = NULL;
574 #if CONFIG_LINUX_PERF
575 static int bench_init_linux(void)
577 struct perf_event_attr attr = {
578 .type = PERF_TYPE_HARDWARE,
579 .size = sizeof(struct perf_event_attr),
580 .config = PERF_COUNT_HW_CPU_CYCLES,
581 .disabled = 1, // start counting only on demand
586 printf("benchmarking with Linux Perf Monitoring API\n");
588 state.sysfd = syscall(__NR_perf_event_open, &attr, 0, -1, -1, 0);
589 if (state.sysfd == -1) {
597 static int bench_init_ffmpeg(void)
600 printf("benchmarking with native FFmpeg timers\n");
603 fprintf(stderr, "checkasm: --bench is not supported on your system\n");
608 static int bench_init(void)
610 #if CONFIG_LINUX_PERF
611 int ret = bench_init_linux();
613 int ret = bench_init_ffmpeg();
618 state.nop_time = measure_nop_time();
619 printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
623 static void bench_uninit(void)
625 #if CONFIG_LINUX_PERF
631 int main(int argc, char *argv[])
633 unsigned int seed = av_get_random_seed();
636 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
637 if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
638 checkasm_checked_call = checkasm_checked_call_vfp;
641 if (!tests[0].func || !cpus[0].flag) {
642 fprintf(stderr, "checkasm: no tests to perform\n");
647 if (!strncmp(argv[1], "--bench", 7)) {
648 if (bench_init() < 0)
650 if (argv[1][7] == '=') {
651 state.bench_pattern = argv[1] + 8;
652 state.bench_pattern_len = strlen(state.bench_pattern);
654 state.bench_pattern = "";
655 } else if (!strncmp(argv[1], "--test=", 7)) {
656 state.test_name = argv[1] + 7;
658 seed = strtoul(argv[1], NULL, 10);
665 fprintf(stderr, "checkasm: using random seed %u\n", seed);
666 av_lfg_init(&checkasm_lfg, seed);
668 check_cpu_flag(NULL, 0);
669 for (i = 0; cpus[i].flag; i++)
670 check_cpu_flag(cpus[i].name, cpus[i].flag);
672 if (state.num_failed) {
673 fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
676 fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
677 if (state.bench_pattern) {
678 print_benchs(state.funcs);
682 destroy_func_tree(state.funcs);
687 /* Decide whether or not the specified function needs to be tested and
688 * allocate/initialize data structures if needed. Returns a pointer to a
689 * reference function if the function should be tested, otherwise NULL */
690 void *checkasm_check_func(void *func, const char *name, ...)
694 CheckasmFuncVersion *v;
699 name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
702 if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
705 state.current_func = get_func(&state.funcs, name_buf);
706 state.funcs->color = 1;
707 v = &state.current_func->versions;
710 CheckasmFuncVersion *prev;
712 /* Only test functions that haven't already been tested */
720 } while ((v = v->next));
722 v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
727 v->cpu = state.cpu_flag;
728 state.current_func_ver = v;
736 /* Decide whether or not the current function needs to be benchmarked */
737 int checkasm_bench_func(void)
739 return !state.num_failed && state.bench_pattern &&
740 !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
743 /* Indicate that the current test has failed */
744 void checkasm_fail_func(const char *msg, ...)
746 if (state.current_func_ver->cpu && state.current_func_ver->ok) {
750 fprintf(stderr, " %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
752 vfprintf(stderr, msg, arg);
754 fprintf(stderr, ")\n");
756 state.current_func_ver->ok = 0;
761 /* Get the benchmark context of the current function */
762 CheckasmPerf *checkasm_get_perf_context(void)
764 CheckasmPerf *perf = &state.current_func_ver->perf;
765 memset(perf, 0, sizeof(*perf));
766 perf->sysfd = state.sysfd;
770 /* Print the outcome of all tests performed since the last time this function was called */
771 void checkasm_report(const char *name, ...)
773 static int prev_checked, prev_failed, max_length;
775 if (state.num_checked > prev_checked) {
776 int pad_length = max_length + 4;
780 pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
782 pad_length -= vfprintf(stderr, name, arg);
784 fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
786 if (state.num_failed == prev_failed)
787 color_printf(COLOR_GREEN, "OK");
789 color_printf(COLOR_RED, "FAILED");
790 fprintf(stderr, "]\n");
792 prev_checked = state.num_checked;
793 prev_failed = state.num_failed;
794 } else if (!state.cpu_flag) {
795 /* Calculate the amount of padding required to make the output vertically aligned */
796 int length = strlen(state.current_test_name);
800 length += vsnprintf(NULL, 0, name, arg);
803 if (length > max_length)