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