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