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