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