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