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