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