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