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