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