checkasm: add VP9 loopfilter tests.
[ffmpeg.git] / tests / checkasm / checkasm.c
1 /*
2  * Assembly testing and benchmarking tool
3  * Copyright (c) 2015 Henrik Gramner
4  * Copyright (c) 2008 Loren Merritt
5  *
6  * This file is part of Libav.
7  *
8  * Libav 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.
12  *
13  * Libav 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.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with Libav; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include "checkasm.h"
28 #include "libavutil/common.h"
29 #include "libavutil/cpu.h"
30 #include "libavutil/intfloat.h"
31 #include "libavutil/random_seed.h"
32
33 #if HAVE_IO_H
34 #include <io.h>
35 #endif
36
37 #if HAVE_SETCONSOLETEXTATTRIBUTE
38 #include <windows.h>
39 #define COLOR_RED    FOREGROUND_RED
40 #define COLOR_GREEN  FOREGROUND_GREEN
41 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
42 #else
43 #define COLOR_RED    1
44 #define COLOR_GREEN  2
45 #define COLOR_YELLOW 3
46 #endif
47
48 #if HAVE_UNISTD_H
49 #include <unistd.h>
50 #endif
51
52 #if !HAVE_ISATTY
53 #define isatty(fd) 1
54 #endif
55
56 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
57 #include "libavutil/arm/cpu.h"
58
59 void (*checkasm_checked_call)(void *func, int dummy, ...) = checkasm_checked_call_novfp;
60 #endif
61
62 /* List of tests to invoke */
63 static const struct {
64     const char *name;
65     void (*func)(void);
66 } tests[] = {
67 #if CONFIG_AUDIODSP
68     { "audiodsp", checkasm_check_audiodsp },
69 #endif
70 #if CONFIG_BLOCKDSP
71     { "blockdsp", checkasm_check_blockdsp },
72 #endif
73 #if CONFIG_BSWAPDSP
74     { "bswapdsp", checkasm_check_bswapdsp },
75 #endif
76 #if CONFIG_DCA_DECODER
77     { "dcadsp", checkasm_check_dcadsp },
78     { "synth_filter", checkasm_check_synth_filter },
79 #endif
80 #if CONFIG_FMTCONVERT
81     { "fmtconvert", checkasm_check_fmtconvert },
82 #endif
83 #if CONFIG_H264DSP
84     { "h264dsp", checkasm_check_h264dsp },
85 #endif
86 #if CONFIG_H264PRED
87     { "h264pred", checkasm_check_h264pred },
88 #endif
89 #if CONFIG_H264QPEL
90     { "h264qpel", checkasm_check_h264qpel },
91 #endif
92 #if CONFIG_HEVC_DECODER
93     { "hevc_mc", checkasm_check_hevc_mc },
94     { "hevc_idct", checkasm_check_hevc_idct },
95 #endif
96 #if CONFIG_HUFFYUVDSP
97     { "huffyuvdsp", checkasm_check_huffyuvdsp },
98 #endif
99 #if CONFIG_V210_ENCODER
100     { "v210enc", checkasm_check_v210enc },
101 #endif
102 #if CONFIG_VP8DSP
103     { "vp8dsp", checkasm_check_vp8dsp },
104 #endif
105 #if CONFIG_VP9_DECODER
106     { "vp9dsp", checkasm_check_vp9dsp },
107 #endif
108     { NULL }
109 };
110
111 /* List of cpu flags to check */
112 static const struct {
113     const char *name;
114     const char *suffix;
115     int flag;
116 } cpus[] = {
117 #if   ARCH_AARCH64
118     { "ARMV8",    "armv8",    AV_CPU_FLAG_ARMV8 },
119     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
120 #elif ARCH_ARM
121     { "ARMV5TE",  "armv5te",  AV_CPU_FLAG_ARMV5TE },
122     { "ARMV6",    "armv6",    AV_CPU_FLAG_ARMV6 },
123     { "ARMV6T2",  "armv6t2",  AV_CPU_FLAG_ARMV6T2 },
124     { "VFP",      "vfp",      AV_CPU_FLAG_VFP },
125     { "VFP_VM",   "vfp_vm",   AV_CPU_FLAG_VFP_VM },
126     { "VFPV3",    "vfp3",     AV_CPU_FLAG_VFPV3 },
127     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
128 #elif ARCH_PPC
129     { "ALTIVEC",  "altivec",  AV_CPU_FLAG_ALTIVEC },
130     { "VSX",      "vsx",      AV_CPU_FLAG_VSX },
131     { "POWER8",   "power8",   AV_CPU_FLAG_POWER8 },
132 #elif ARCH_X86
133     { "MMX",      "mmx",      AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
134     { "MMXEXT",   "mmxext",   AV_CPU_FLAG_MMXEXT },
135     { "3DNOW",    "3dnow",    AV_CPU_FLAG_3DNOW },
136     { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
137     { "SSE",      "sse",      AV_CPU_FLAG_SSE },
138     { "SSE2",     "sse2",     AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
139     { "SSE3",     "sse3",     AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
140     { "SSSE3",    "ssse3",    AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
141     { "SSE4.1",   "sse4",     AV_CPU_FLAG_SSE4 },
142     { "SSE4.2",   "sse42",    AV_CPU_FLAG_SSE42 },
143     { "AVX",      "avx",      AV_CPU_FLAG_AVX },
144     { "XOP",      "xop",      AV_CPU_FLAG_XOP },
145     { "FMA3",     "fma3",     AV_CPU_FLAG_FMA3 },
146     { "FMA4",     "fma4",     AV_CPU_FLAG_FMA4 },
147     { "AVX2",     "avx2",     AV_CPU_FLAG_AVX2 },
148 #endif
149     { NULL }
150 };
151
152 typedef struct CheckasmFuncVersion {
153     struct CheckasmFuncVersion *next;
154     void *func;
155     int ok;
156     int cpu;
157     int iterations;
158     uint64_t cycles;
159 } CheckasmFuncVersion;
160
161 /* Binary search tree node */
162 typedef struct CheckasmFunc {
163     struct CheckasmFunc *child[2];
164     CheckasmFuncVersion versions;
165     uint8_t color; /* 0 = red, 1 = black */
166     char name[1];
167 } CheckasmFunc;
168
169 /* Internal state */
170 static struct {
171     CheckasmFunc *funcs;
172     CheckasmFunc *current_func;
173     CheckasmFuncVersion *current_func_ver;
174     const char *current_test_name;
175     const char *bench_pattern;
176     int bench_pattern_len;
177     int num_checked;
178     int num_failed;
179     int nop_time;
180     int cpu_flag;
181     const char *cpu_flag_name;
182 } state;
183
184 /* PRNG state */
185 AVLFG checkasm_lfg;
186
187 /* float compare support code */
188 static int is_negative(union av_intfloat32 u)
189 {
190     return u.i >> 31;
191 }
192
193 int float_near_ulp(float a, float b, unsigned max_ulp)
194 {
195     union av_intfloat32 x, y;
196
197     x.f = a;
198     y.f = b;
199
200     if (is_negative(x) != is_negative(y)) {
201         // handle -0.0 == +0.0
202         return a == b;
203     }
204
205     if (llabs((int64_t)x.i - y.i) <= max_ulp)
206         return 1;
207
208     return 0;
209 }
210
211 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
212                          unsigned len)
213 {
214     unsigned i;
215
216     for (i = 0; i < len; i++) {
217         if (!float_near_ulp(a[i], b[i], max_ulp))
218             return 0;
219     }
220     return 1;
221 }
222
223 int float_near_abs_eps(float a, float b, float eps)
224 {
225     float abs_diff = fabsf(a - b);
226
227     return abs_diff < eps;
228 }
229
230 int float_near_abs_eps_array(const float *a, const float *b, float eps,
231                          unsigned len)
232 {
233     unsigned i;
234
235     for (i = 0; i < len; i++) {
236         if (!float_near_abs_eps(a[i], b[i], eps))
237             return 0;
238     }
239     return 1;
240 }
241
242 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
243 {
244     return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
245 }
246
247 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
248                          unsigned max_ulp, unsigned len)
249 {
250     unsigned i;
251
252     for (i = 0; i < len; i++) {
253         if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
254             return 0;
255     }
256     return 1;
257 }
258
259 /* Print colored text to stderr if the terminal supports it */
260 static void color_printf(int color, const char *fmt, ...)
261 {
262     static int use_color = -1;
263     va_list arg;
264
265 #if HAVE_SETCONSOLETEXTATTRIBUTE
266     static HANDLE con;
267     static WORD org_attributes;
268
269     if (use_color < 0) {
270         CONSOLE_SCREEN_BUFFER_INFO con_info;
271         con = GetStdHandle(STD_ERROR_HANDLE);
272         if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
273             org_attributes = con_info.wAttributes;
274             use_color = 1;
275         } else
276             use_color = 0;
277     }
278     if (use_color)
279         SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
280 #else
281     if (use_color < 0) {
282         const char *term = getenv("TERM");
283         use_color = term && strcmp(term, "dumb") && isatty(2);
284     }
285     if (use_color)
286         fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
287 #endif
288
289     va_start(arg, fmt);
290     vfprintf(stderr, fmt, arg);
291     va_end(arg);
292
293     if (use_color) {
294 #if HAVE_SETCONSOLETEXTATTRIBUTE
295         SetConsoleTextAttribute(con, org_attributes);
296 #else
297         fprintf(stderr, "\x1b[0m");
298 #endif
299     }
300 }
301
302 /* Deallocate a tree */
303 static void destroy_func_tree(CheckasmFunc *f)
304 {
305     if (f) {
306         CheckasmFuncVersion *v = f->versions.next;
307         while (v) {
308             CheckasmFuncVersion *next = v->next;
309             free(v);
310             v = next;
311         }
312
313         destroy_func_tree(f->child[0]);
314         destroy_func_tree(f->child[1]);
315         free(f);
316     }
317 }
318
319 /* Allocate a zero-initialized block, clean up and exit on failure */
320 static void *checkasm_malloc(size_t size)
321 {
322     void *ptr = calloc(1, size);
323     if (!ptr) {
324         fprintf(stderr, "checkasm: malloc failed\n");
325         destroy_func_tree(state.funcs);
326         exit(1);
327     }
328     return ptr;
329 }
330
331 /* Get the suffix of the specified cpu flag */
332 static const char *cpu_suffix(int cpu)
333 {
334     int i = FF_ARRAY_ELEMS(cpus);
335
336     while (--i >= 0)
337         if (cpu & cpus[i].flag)
338             return cpus[i].suffix;
339
340     return "c";
341 }
342
343 #ifdef AV_READ_TIME
344 static int cmp_nop(const void *a, const void *b)
345 {
346     return *(const uint16_t*)a - *(const uint16_t*)b;
347 }
348
349 /* Measure the overhead of the timing code (in decicycles) */
350 static int measure_nop_time(void)
351 {
352     uint16_t nops[10000];
353     int i, nop_sum = 0;
354
355     for (i = 0; i < 10000; i++) {
356         uint64_t t = AV_READ_TIME();
357         nops[i] = AV_READ_TIME() - t;
358     }
359
360     qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
361     for (i = 2500; i < 7500; i++)
362         nop_sum += nops[i];
363
364     return nop_sum / 500;
365 }
366
367 /* Print benchmark results */
368 static void print_benchs(CheckasmFunc *f)
369 {
370     if (f) {
371         print_benchs(f->child[0]);
372
373         /* Only print functions with at least one assembly version */
374         if (f->versions.cpu || f->versions.next) {
375             CheckasmFuncVersion *v = &f->versions;
376             do {
377                 if (v->iterations) {
378                     int decicycles = (10*v->cycles/v->iterations - state.nop_time) / 4;
379                     printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
380                 }
381             } while ((v = v->next));
382         }
383
384         print_benchs(f->child[1]);
385     }
386 }
387 #endif
388
389 /* ASCIIbetical sort except preserving natural order for numbers */
390 static int cmp_func_names(const char *a, const char *b)
391 {
392     const char *start = a;
393     int ascii_diff, digit_diff;
394
395     for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
396     for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
397
398     if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
399         return digit_diff;
400
401     return ascii_diff;
402 }
403
404 /* Perform a tree rotation in the specified direction and return the new root */
405 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
406 {
407     CheckasmFunc *r = f->child[dir^1];
408     f->child[dir^1] = r->child[dir];
409     r->child[dir] = f;
410     r->color = f->color;
411     f->color = 0;
412     return r;
413 }
414
415 #define is_red(f) ((f) && !(f)->color)
416
417 /* Balance a left-leaning red-black tree at the specified node */
418 static void balance_tree(CheckasmFunc **root)
419 {
420     CheckasmFunc *f = *root;
421
422     if (is_red(f->child[0]) && is_red(f->child[1])) {
423         f->color ^= 1;
424         f->child[0]->color = f->child[1]->color = 1;
425     }
426
427     if (!is_red(f->child[0]) && is_red(f->child[1]))
428         *root = rotate_tree(f, 0); /* Rotate left */
429     else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
430         *root = rotate_tree(f, 1); /* Rotate right */
431 }
432
433 /* Get a node with the specified name, creating it if it doesn't exist */
434 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
435 {
436     CheckasmFunc *f = *root;
437
438     if (f) {
439         /* Search the tree for a matching node */
440         int cmp = cmp_func_names(name, f->name);
441         if (cmp) {
442             f = get_func(&f->child[cmp > 0], name);
443
444             /* Rebalance the tree on the way up if a new node was inserted */
445             if (!f->versions.func)
446                 balance_tree(root);
447         }
448     } else {
449         /* Allocate and insert a new node into the tree */
450         int name_length = strlen(name);
451         f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
452         memcpy(f->name, name, name_length + 1);
453     }
454
455     return f;
456 }
457
458 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
459 static void check_cpu_flag(const char *name, int flag)
460 {
461     int old_cpu_flag = state.cpu_flag;
462
463     flag |= old_cpu_flag;
464     av_set_cpu_flags_mask(flag);
465     state.cpu_flag = av_get_cpu_flags();
466
467     if (!flag || state.cpu_flag != old_cpu_flag) {
468         int i;
469
470         state.cpu_flag_name = name;
471         for (i = 0; tests[i].func; i++) {
472             state.current_test_name = tests[i].name;
473             tests[i].func();
474         }
475     }
476 }
477
478 /* Print the name of the current CPU flag, but only do it once */
479 static void print_cpu_name(void)
480 {
481     if (state.cpu_flag_name) {
482         color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
483         state.cpu_flag_name = NULL;
484     }
485 }
486
487 int main(int argc, char *argv[])
488 {
489     unsigned int seed;
490     int i, ret = 0;
491
492 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
493     if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
494         checkasm_checked_call = checkasm_checked_call_vfp;
495 #endif
496
497     if (!tests[0].func || !cpus[0].flag) {
498         fprintf(stderr, "checkasm: no tests to perform\n");
499         return 0;
500     }
501
502     if (argc > 1 && !strncmp(argv[1], "--bench", 7)) {
503 #ifndef AV_READ_TIME
504         fprintf(stderr, "checkasm: --bench is not supported on your system\n");
505         return 1;
506 #endif
507         if (argv[1][7] == '=') {
508             state.bench_pattern = argv[1] + 8;
509             state.bench_pattern_len = strlen(state.bench_pattern);
510         } else
511             state.bench_pattern = "";
512
513         argc--;
514         argv++;
515     }
516
517     seed = (argc > 1) ? strtoul(argv[1], NULL, 10) : av_get_random_seed();
518     fprintf(stderr, "checkasm: using random seed %u\n", seed);
519     av_lfg_init(&checkasm_lfg, seed);
520
521     check_cpu_flag(NULL, 0);
522     for (i = 0; cpus[i].flag; i++)
523         check_cpu_flag(cpus[i].name, cpus[i].flag);
524
525     if (state.num_failed) {
526         fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
527         ret = 1;
528     } else {
529         fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
530 #ifdef AV_READ_TIME
531         if (state.bench_pattern) {
532             state.nop_time = measure_nop_time();
533             printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
534             print_benchs(state.funcs);
535         }
536 #endif
537     }
538
539     destroy_func_tree(state.funcs);
540     return ret;
541 }
542
543 /* Decide whether or not the specified function needs to be tested and
544  * allocate/initialize data structures if needed. Returns a pointer to a
545  * reference function if the function should be tested, otherwise NULL */
546 void *checkasm_check_func(void *func, const char *name, ...)
547 {
548     char name_buf[256];
549     void *ref = func;
550     CheckasmFuncVersion *v;
551     int name_length;
552     va_list arg;
553
554     va_start(arg, name);
555     name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
556     va_end(arg);
557
558     if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
559         return NULL;
560
561     state.current_func = get_func(&state.funcs, name_buf);
562     state.funcs->color = 1;
563     v = &state.current_func->versions;
564
565     if (v->func) {
566         CheckasmFuncVersion *prev;
567         do {
568             /* Only test functions that haven't already been tested */
569             if (v->func == func)
570                 return NULL;
571
572             if (v->ok)
573                 ref = v->func;
574
575             prev = v;
576         } while ((v = v->next));
577
578         v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
579     }
580
581     v->func = func;
582     v->ok = 1;
583     v->cpu = state.cpu_flag;
584     state.current_func_ver = v;
585
586     if (state.cpu_flag)
587         state.num_checked++;
588
589     return ref;
590 }
591
592 /* Decide whether or not the current function needs to be benchmarked */
593 int checkasm_bench_func(void)
594 {
595     return !state.num_failed && state.bench_pattern &&
596            !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
597 }
598
599 /* Indicate that the current test has failed */
600 void checkasm_fail_func(const char *msg, ...)
601 {
602     if (state.current_func_ver->cpu && state.current_func_ver->ok) {
603         va_list arg;
604
605         print_cpu_name();
606         fprintf(stderr, "   %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
607         va_start(arg, msg);
608         vfprintf(stderr, msg, arg);
609         va_end(arg);
610         fprintf(stderr, ")\n");
611
612         state.current_func_ver->ok = 0;
613         state.num_failed++;
614     }
615 }
616
617 /* Update benchmark results of the current function */
618 void checkasm_update_bench(int iterations, uint64_t cycles)
619 {
620     state.current_func_ver->iterations += iterations;
621     state.current_func_ver->cycles += cycles;
622 }
623
624 /* Print the outcome of all tests performed since the last time this function was called */
625 void checkasm_report(const char *name, ...)
626 {
627     static int prev_checked, prev_failed, max_length;
628
629     if (state.num_checked > prev_checked) {
630         int pad_length = max_length + 4;
631         va_list arg;
632
633         print_cpu_name();
634         pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
635         va_start(arg, name);
636         pad_length -= vfprintf(stderr, name, arg);
637         va_end(arg);
638         fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
639
640         if (state.num_failed == prev_failed)
641             color_printf(COLOR_GREEN, "OK");
642         else
643             color_printf(COLOR_RED, "FAILED");
644         fprintf(stderr, "]\n");
645
646         prev_checked = state.num_checked;
647         prev_failed  = state.num_failed;
648     } else if (!state.cpu_flag) {
649         /* Calculate the amount of padding required to make the output vertically aligned */
650         int length = strlen(state.current_test_name);
651         va_list arg;
652
653         va_start(arg, name);
654         length += vsnprintf(NULL, 0, name, arg);
655         va_end(arg);
656
657         if (length > max_length)
658             max_length = length;
659     }
660 }