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