]> git.sesse.net Git - ffmpeg/blob - tests/checkasm/checkasm.c
Merge commit '41cf3e3b1ca375962951fde1b90a03b16197d205'
[ffmpeg] / 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 "config.h"
24
25 #if CONFIG_LINUX_PERF
26 # ifndef _GNU_SOURCE
27 #  define _GNU_SOURCE // for syscall (performance monitoring API)
28 # endif
29 #endif
30
31 #include <stdarg.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include "checkasm.h"
36 #include "libavutil/common.h"
37 #include "libavutil/cpu.h"
38 #include "libavutil/intfloat.h"
39 #include "libavutil/random_seed.h"
40
41 #if HAVE_IO_H
42 #include <io.h>
43 #endif
44
45 #if HAVE_SETCONSOLETEXTATTRIBUTE
46 #include <windows.h>
47 #define COLOR_RED    FOREGROUND_RED
48 #define COLOR_GREEN  FOREGROUND_GREEN
49 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
50 #else
51 #define COLOR_RED    1
52 #define COLOR_GREEN  2
53 #define COLOR_YELLOW 3
54 #endif
55
56 #if HAVE_UNISTD_H
57 #include <unistd.h>
58 #endif
59
60 #if !HAVE_ISATTY
61 #define isatty(fd) 1
62 #endif
63
64 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
65 #include "libavutil/arm/cpu.h"
66
67 void (*checkasm_checked_call)(void *func, int dummy, ...) = checkasm_checked_call_novfp;
68 #endif
69
70 /* List of tests to invoke */
71 static const struct {
72     const char *name;
73     void (*func)(void);
74 } tests[] = {
75 #if CONFIG_AVCODEC
76     #if CONFIG_AAC_DECODER
77         { "aacpsdsp", checkasm_check_aacpsdsp },
78         { "sbrdsp",   checkasm_check_sbrdsp },
79     #endif
80     #if CONFIG_ALAC_DECODER
81         { "alacdsp", checkasm_check_alacdsp },
82     #endif
83     #if CONFIG_AUDIODSP
84         { "audiodsp", checkasm_check_audiodsp },
85     #endif
86     #if CONFIG_BLOCKDSP
87         { "blockdsp", checkasm_check_blockdsp },
88     #endif
89     #if CONFIG_BSWAPDSP
90         { "bswapdsp", checkasm_check_bswapdsp },
91     #endif
92     #if CONFIG_DCA_DECODER
93         { "synth_filter", checkasm_check_synth_filter },
94     #endif
95     #if CONFIG_EXR_DECODER
96         { "exrdsp", checkasm_check_exrdsp },
97     #endif
98     #if CONFIG_FLACDSP
99         { "flacdsp", checkasm_check_flacdsp },
100     #endif
101     #if CONFIG_FMTCONVERT
102         { "fmtconvert", checkasm_check_fmtconvert },
103     #endif
104     #if CONFIG_G722DSP
105         { "g722dsp", checkasm_check_g722dsp },
106     #endif
107     #if CONFIG_H264DSP
108         { "h264dsp", checkasm_check_h264dsp },
109     #endif
110     #if CONFIG_H264PRED
111         { "h264pred", checkasm_check_h264pred },
112     #endif
113     #if CONFIG_H264QPEL
114         { "h264qpel", checkasm_check_h264qpel },
115     #endif
116     #if CONFIG_HEVC_DECODER
117         { "hevc_add_res", checkasm_check_hevc_add_res },
118         { "hevc_idct", checkasm_check_hevc_idct },
119         { "hevc_sao", checkasm_check_hevc_sao },
120     #endif
121     #if CONFIG_HUFFYUV_DECODER
122         { "huffyuvdsp", checkasm_check_huffyuvdsp },
123     #endif
124     #if CONFIG_JPEG2000_DECODER
125         { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
126     #endif
127     #if CONFIG_HUFFYUVDSP
128         { "llviddsp", checkasm_check_llviddsp },
129     #endif
130     #if CONFIG_LLVIDENCDSP
131         { "llviddspenc", checkasm_check_llviddspenc },
132     #endif
133     #if CONFIG_PIXBLOCKDSP
134         { "pixblockdsp", checkasm_check_pixblockdsp },
135     #endif
136     #if CONFIG_UTVIDEO_DECODER
137         { "utvideodsp", checkasm_check_utvideodsp },
138     #endif
139     #if CONFIG_V210_ENCODER
140         { "v210enc", checkasm_check_v210enc },
141     #endif
142     #if CONFIG_VP8DSP
143         { "vp8dsp", checkasm_check_vp8dsp },
144     #endif
145     #if CONFIG_VP9_DECODER
146         { "vp9dsp", checkasm_check_vp9dsp },
147     #endif
148     #if CONFIG_VIDEODSP
149         { "videodsp", checkasm_check_videodsp },
150     #endif
151 #endif
152 #if CONFIG_AVFILTER
153     #if CONFIG_AFIR_FILTER
154         { "af_afir", checkasm_check_afir },
155     #endif
156     #if CONFIG_BLEND_FILTER
157         { "vf_blend", checkasm_check_blend },
158     #endif
159     #if CONFIG_COLORSPACE_FILTER
160         { "vf_colorspace", checkasm_check_colorspace },
161     #endif
162     #if CONFIG_HFLIP_FILTER
163         { "vf_hflip", checkasm_check_vf_hflip },
164     #endif
165     #if CONFIG_NLMEANS_FILTER
166         { "vf_nlmeans", checkasm_check_nlmeans },
167     #endif
168     #if CONFIG_THRESHOLD_FILTER
169         { "vf_threshold", checkasm_check_vf_threshold },
170     #endif
171 #endif
172 #if CONFIG_SWSCALE
173     { "sw_rgb", checkasm_check_sw_rgb },
174 #endif
175 #if CONFIG_AVUTIL
176         { "fixed_dsp", checkasm_check_fixed_dsp },
177         { "float_dsp", checkasm_check_float_dsp },
178 #endif
179     { NULL }
180 };
181
182 /* List of cpu flags to check */
183 static const struct {
184     const char *name;
185     const char *suffix;
186     int flag;
187 } cpus[] = {
188 #if   ARCH_AARCH64
189     { "ARMV8",    "armv8",    AV_CPU_FLAG_ARMV8 },
190     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
191 #elif ARCH_ARM
192     { "ARMV5TE",  "armv5te",  AV_CPU_FLAG_ARMV5TE },
193     { "ARMV6",    "armv6",    AV_CPU_FLAG_ARMV6 },
194     { "ARMV6T2",  "armv6t2",  AV_CPU_FLAG_ARMV6T2 },
195     { "VFP",      "vfp",      AV_CPU_FLAG_VFP },
196     { "VFP_VM",   "vfp_vm",   AV_CPU_FLAG_VFP_VM },
197     { "VFPV3",    "vfp3",     AV_CPU_FLAG_VFPV3 },
198     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
199 #elif ARCH_PPC
200     { "ALTIVEC",  "altivec",  AV_CPU_FLAG_ALTIVEC },
201     { "VSX",      "vsx",      AV_CPU_FLAG_VSX },
202     { "POWER8",   "power8",   AV_CPU_FLAG_POWER8 },
203 #elif ARCH_X86
204     { "MMX",      "mmx",      AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
205     { "MMXEXT",   "mmxext",   AV_CPU_FLAG_MMXEXT },
206     { "3DNOW",    "3dnow",    AV_CPU_FLAG_3DNOW },
207     { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
208     { "SSE",      "sse",      AV_CPU_FLAG_SSE },
209     { "SSE2",     "sse2",     AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
210     { "SSE3",     "sse3",     AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
211     { "SSSE3",    "ssse3",    AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
212     { "SSE4.1",   "sse4",     AV_CPU_FLAG_SSE4 },
213     { "SSE4.2",   "sse42",    AV_CPU_FLAG_SSE42 },
214     { "AES-NI",   "aesni",    AV_CPU_FLAG_AESNI },
215     { "AVX",      "avx",      AV_CPU_FLAG_AVX },
216     { "XOP",      "xop",      AV_CPU_FLAG_XOP },
217     { "FMA3",     "fma3",     AV_CPU_FLAG_FMA3 },
218     { "FMA4",     "fma4",     AV_CPU_FLAG_FMA4 },
219     { "AVX2",     "avx2",     AV_CPU_FLAG_AVX2 },
220     { "AVX-512",  "avx512",   AV_CPU_FLAG_AVX512 },
221 #endif
222     { NULL }
223 };
224
225 typedef struct CheckasmFuncVersion {
226     struct CheckasmFuncVersion *next;
227     void *func;
228     int ok;
229     int cpu;
230     CheckasmPerf perf;
231 } CheckasmFuncVersion;
232
233 /* Binary search tree node */
234 typedef struct CheckasmFunc {
235     struct CheckasmFunc *child[2];
236     CheckasmFuncVersion versions;
237     uint8_t color; /* 0 = red, 1 = black */
238     char name[1];
239 } CheckasmFunc;
240
241 /* Internal state */
242 static struct {
243     CheckasmFunc *funcs;
244     CheckasmFunc *current_func;
245     CheckasmFuncVersion *current_func_ver;
246     const char *current_test_name;
247     const char *bench_pattern;
248     int bench_pattern_len;
249     int num_checked;
250     int num_failed;
251
252     /* perf */
253     int nop_time;
254     int sysfd;
255
256     int cpu_flag;
257     const char *cpu_flag_name;
258     const char *test_name;
259 } state;
260
261 /* PRNG state */
262 AVLFG checkasm_lfg;
263
264 /* float compare support code */
265 static int is_negative(union av_intfloat32 u)
266 {
267     return u.i >> 31;
268 }
269
270 int float_near_ulp(float a, float b, unsigned max_ulp)
271 {
272     union av_intfloat32 x, y;
273
274     x.f = a;
275     y.f = b;
276
277     if (is_negative(x) != is_negative(y)) {
278         // handle -0.0 == +0.0
279         return a == b;
280     }
281
282     if (llabs((int64_t)x.i - y.i) <= max_ulp)
283         return 1;
284
285     return 0;
286 }
287
288 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
289                          unsigned len)
290 {
291     unsigned i;
292
293     for (i = 0; i < len; i++) {
294         if (!float_near_ulp(a[i], b[i], max_ulp))
295             return 0;
296     }
297     return 1;
298 }
299
300 int float_near_abs_eps(float a, float b, float eps)
301 {
302     float abs_diff = fabsf(a - b);
303     if (abs_diff < eps)
304         return 1;
305
306     fprintf(stderr, "test failed comparing %g with %g (abs diff=%g with EPS=%g)\n", a, b, abs_diff, eps);
307
308     return 0;
309 }
310
311 int float_near_abs_eps_array(const float *a, const float *b, float eps,
312                          unsigned len)
313 {
314     unsigned i;
315
316     for (i = 0; i < len; i++) {
317         if (!float_near_abs_eps(a[i], b[i], eps))
318             return 0;
319     }
320     return 1;
321 }
322
323 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
324 {
325     return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
326 }
327
328 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
329                          unsigned max_ulp, unsigned len)
330 {
331     unsigned i;
332
333     for (i = 0; i < len; i++) {
334         if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
335             return 0;
336     }
337     return 1;
338 }
339
340 int double_near_abs_eps(double a, double b, double eps)
341 {
342     double abs_diff = fabs(a - b);
343
344     return abs_diff < eps;
345 }
346
347 int double_near_abs_eps_array(const double *a, const double *b, double eps,
348                               unsigned len)
349 {
350     unsigned i;
351
352     for (i = 0; i < len; i++) {
353         if (!double_near_abs_eps(a[i], b[i], eps))
354             return 0;
355     }
356     return 1;
357 }
358
359 /* Print colored text to stderr if the terminal supports it */
360 static void color_printf(int color, const char *fmt, ...)
361 {
362     static int use_color = -1;
363     va_list arg;
364
365 #if HAVE_SETCONSOLETEXTATTRIBUTE
366     static HANDLE con;
367     static WORD org_attributes;
368
369     if (use_color < 0) {
370         CONSOLE_SCREEN_BUFFER_INFO con_info;
371         con = GetStdHandle(STD_ERROR_HANDLE);
372         if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
373             org_attributes = con_info.wAttributes;
374             use_color = 1;
375         } else
376             use_color = 0;
377     }
378     if (use_color)
379         SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
380 #else
381     if (use_color < 0) {
382         const char *term = getenv("TERM");
383         use_color = term && strcmp(term, "dumb") && isatty(2);
384     }
385     if (use_color)
386         fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
387 #endif
388
389     va_start(arg, fmt);
390     vfprintf(stderr, fmt, arg);
391     va_end(arg);
392
393     if (use_color) {
394 #if HAVE_SETCONSOLETEXTATTRIBUTE
395         SetConsoleTextAttribute(con, org_attributes);
396 #else
397         fprintf(stderr, "\x1b[0m");
398 #endif
399     }
400 }
401
402 /* Deallocate a tree */
403 static void destroy_func_tree(CheckasmFunc *f)
404 {
405     if (f) {
406         CheckasmFuncVersion *v = f->versions.next;
407         while (v) {
408             CheckasmFuncVersion *next = v->next;
409             free(v);
410             v = next;
411         }
412
413         destroy_func_tree(f->child[0]);
414         destroy_func_tree(f->child[1]);
415         free(f);
416     }
417 }
418
419 /* Allocate a zero-initialized block, clean up and exit on failure */
420 static void *checkasm_malloc(size_t size)
421 {
422     void *ptr = calloc(1, size);
423     if (!ptr) {
424         fprintf(stderr, "checkasm: malloc failed\n");
425         destroy_func_tree(state.funcs);
426         exit(1);
427     }
428     return ptr;
429 }
430
431 /* Get the suffix of the specified cpu flag */
432 static const char *cpu_suffix(int cpu)
433 {
434     int i = FF_ARRAY_ELEMS(cpus);
435
436     while (--i >= 0)
437         if (cpu & cpus[i].flag)
438             return cpus[i].suffix;
439
440     return "c";
441 }
442
443 static int cmp_nop(const void *a, const void *b)
444 {
445     return *(const uint16_t*)a - *(const uint16_t*)b;
446 }
447
448 /* Measure the overhead of the timing code (in decicycles) */
449 static int measure_nop_time(void)
450 {
451     uint16_t nops[10000];
452     int i, nop_sum = 0;
453     av_unused const int sysfd = state.sysfd;
454
455     uint64_t t = 0;
456     for (i = 0; i < 10000; i++) {
457         PERF_START(t);
458         PERF_STOP(t);
459         nops[i] = t;
460     }
461
462     qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
463     for (i = 2500; i < 7500; i++)
464         nop_sum += nops[i];
465
466     return nop_sum / 500;
467 }
468
469 /* Print benchmark results */
470 static void print_benchs(CheckasmFunc *f)
471 {
472     if (f) {
473         print_benchs(f->child[0]);
474
475         /* Only print functions with at least one assembly version */
476         if (f->versions.cpu || f->versions.next) {
477             CheckasmFuncVersion *v = &f->versions;
478             do {
479                 CheckasmPerf *p = &v->perf;
480                 if (p->iterations) {
481                     int decicycles = (10*p->cycles/p->iterations - state.nop_time) / 4;
482                     printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
483                 }
484             } while ((v = v->next));
485         }
486
487         print_benchs(f->child[1]);
488     }
489 }
490
491 /* ASCIIbetical sort except preserving natural order for numbers */
492 static int cmp_func_names(const char *a, const char *b)
493 {
494     const char *start = a;
495     int ascii_diff, digit_diff;
496
497     for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
498     for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
499
500     if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
501         return digit_diff;
502
503     return ascii_diff;
504 }
505
506 /* Perform a tree rotation in the specified direction and return the new root */
507 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
508 {
509     CheckasmFunc *r = f->child[dir^1];
510     f->child[dir^1] = r->child[dir];
511     r->child[dir] = f;
512     r->color = f->color;
513     f->color = 0;
514     return r;
515 }
516
517 #define is_red(f) ((f) && !(f)->color)
518
519 /* Balance a left-leaning red-black tree at the specified node */
520 static void balance_tree(CheckasmFunc **root)
521 {
522     CheckasmFunc *f = *root;
523
524     if (is_red(f->child[0]) && is_red(f->child[1])) {
525         f->color ^= 1;
526         f->child[0]->color = f->child[1]->color = 1;
527     }
528
529     if (!is_red(f->child[0]) && is_red(f->child[1]))
530         *root = rotate_tree(f, 0); /* Rotate left */
531     else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
532         *root = rotate_tree(f, 1); /* Rotate right */
533 }
534
535 /* Get a node with the specified name, creating it if it doesn't exist */
536 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
537 {
538     CheckasmFunc *f = *root;
539
540     if (f) {
541         /* Search the tree for a matching node */
542         int cmp = cmp_func_names(name, f->name);
543         if (cmp) {
544             f = get_func(&f->child[cmp > 0], name);
545
546             /* Rebalance the tree on the way up if a new node was inserted */
547             if (!f->versions.func)
548                 balance_tree(root);
549         }
550     } else {
551         /* Allocate and insert a new node into the tree */
552         int name_length = strlen(name);
553         f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
554         memcpy(f->name, name, name_length + 1);
555     }
556
557     return f;
558 }
559
560 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
561 static void check_cpu_flag(const char *name, int flag)
562 {
563     int old_cpu_flag = state.cpu_flag;
564
565     flag |= old_cpu_flag;
566     av_force_cpu_flags(-1);
567     state.cpu_flag = flag & av_get_cpu_flags();
568     av_force_cpu_flags(state.cpu_flag);
569
570     if (!flag || state.cpu_flag != old_cpu_flag) {
571         int i;
572
573         state.cpu_flag_name = name;
574         for (i = 0; tests[i].func; i++) {
575             if (state.test_name && strcmp(tests[i].name, state.test_name))
576                 continue;
577             state.current_test_name = tests[i].name;
578             tests[i].func();
579         }
580     }
581 }
582
583 /* Print the name of the current CPU flag, but only do it once */
584 static void print_cpu_name(void)
585 {
586     if (state.cpu_flag_name) {
587         color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
588         state.cpu_flag_name = NULL;
589     }
590 }
591
592 #if CONFIG_LINUX_PERF
593 static int bench_init_linux(void)
594 {
595     struct perf_event_attr attr = {
596         .type           = PERF_TYPE_HARDWARE,
597         .size           = sizeof(struct perf_event_attr),
598         .config         = PERF_COUNT_HW_CPU_CYCLES,
599         .disabled       = 1, // start counting only on demand
600         .exclude_kernel = 1,
601         .exclude_hv     = 1,
602     };
603
604     printf("benchmarking with Linux Perf Monitoring API\n");
605
606     state.sysfd = syscall(__NR_perf_event_open, &attr, 0, -1, -1, 0);
607     if (state.sysfd == -1) {
608         perror("syscall");
609         return -1;
610     }
611     return 0;
612 }
613 #endif
614
615 #if !CONFIG_LINUX_PERF
616 static int bench_init_ffmpeg(void)
617 {
618 #ifdef AV_READ_TIME
619     printf("benchmarking with native FFmpeg timers\n");
620     return 0;
621 #else
622     fprintf(stderr, "checkasm: --bench is not supported on your system\n");
623     return -1;
624 #endif
625 }
626 #endif
627
628 static int bench_init(void)
629 {
630 #if CONFIG_LINUX_PERF
631     int ret = bench_init_linux();
632 #else
633     int ret = bench_init_ffmpeg();
634 #endif
635     if (ret < 0)
636         return ret;
637
638     state.nop_time = measure_nop_time();
639     printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
640     return 0;
641 }
642
643 static void bench_uninit(void)
644 {
645 #if CONFIG_LINUX_PERF
646     if (state.sysfd > 0)
647         close(state.sysfd);
648 #endif
649 }
650
651 int main(int argc, char *argv[])
652 {
653     unsigned int seed = av_get_random_seed();
654     int i, ret = 0;
655
656 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
657     if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
658         checkasm_checked_call = checkasm_checked_call_vfp;
659 #endif
660
661     if (!tests[0].func || !cpus[0].flag) {
662         fprintf(stderr, "checkasm: no tests to perform\n");
663         return 0;
664     }
665
666     while (argc > 1) {
667         if (!strncmp(argv[1], "--bench", 7)) {
668             if (bench_init() < 0)
669                 return 1;
670             if (argv[1][7] == '=') {
671                 state.bench_pattern = argv[1] + 8;
672                 state.bench_pattern_len = strlen(state.bench_pattern);
673             } else
674                 state.bench_pattern = "";
675         } else if (!strncmp(argv[1], "--test=", 7)) {
676             state.test_name = argv[1] + 7;
677         } else {
678             seed = strtoul(argv[1], NULL, 10);
679         }
680
681         argc--;
682         argv++;
683     }
684
685     fprintf(stderr, "checkasm: using random seed %u\n", seed);
686     av_lfg_init(&checkasm_lfg, seed);
687
688     check_cpu_flag(NULL, 0);
689     for (i = 0; cpus[i].flag; i++)
690         check_cpu_flag(cpus[i].name, cpus[i].flag);
691
692     if (state.num_failed) {
693         fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
694         ret = 1;
695     } else {
696         fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
697         if (state.bench_pattern) {
698             print_benchs(state.funcs);
699         }
700     }
701
702     destroy_func_tree(state.funcs);
703     bench_uninit();
704     return ret;
705 }
706
707 /* Decide whether or not the specified function needs to be tested and
708  * allocate/initialize data structures if needed. Returns a pointer to a
709  * reference function if the function should be tested, otherwise NULL */
710 void *checkasm_check_func(void *func, const char *name, ...)
711 {
712     char name_buf[256];
713     void *ref = func;
714     CheckasmFuncVersion *v;
715     int name_length;
716     va_list arg;
717
718     va_start(arg, name);
719     name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
720     va_end(arg);
721
722     if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
723         return NULL;
724
725     state.current_func = get_func(&state.funcs, name_buf);
726     state.funcs->color = 1;
727     v = &state.current_func->versions;
728
729     if (v->func) {
730         CheckasmFuncVersion *prev;
731         do {
732             /* Only test functions that haven't already been tested */
733             if (v->func == func)
734                 return NULL;
735
736             if (v->ok)
737                 ref = v->func;
738
739             prev = v;
740         } while ((v = v->next));
741
742         v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
743     }
744
745     v->func = func;
746     v->ok = 1;
747     v->cpu = state.cpu_flag;
748     state.current_func_ver = v;
749
750     if (state.cpu_flag)
751         state.num_checked++;
752
753     return ref;
754 }
755
756 /* Decide whether or not the current function needs to be benchmarked */
757 int checkasm_bench_func(void)
758 {
759     return !state.num_failed && state.bench_pattern &&
760            !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
761 }
762
763 /* Indicate that the current test has failed */
764 void checkasm_fail_func(const char *msg, ...)
765 {
766     if (state.current_func_ver->cpu && state.current_func_ver->ok) {
767         va_list arg;
768
769         print_cpu_name();
770         fprintf(stderr, "   %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
771         va_start(arg, msg);
772         vfprintf(stderr, msg, arg);
773         va_end(arg);
774         fprintf(stderr, ")\n");
775
776         state.current_func_ver->ok = 0;
777         state.num_failed++;
778     }
779 }
780
781 /* Get the benchmark context of the current function */
782 CheckasmPerf *checkasm_get_perf_context(void)
783 {
784     CheckasmPerf *perf = &state.current_func_ver->perf;
785     memset(perf, 0, sizeof(*perf));
786     perf->sysfd = state.sysfd;
787     return perf;
788 }
789
790 /* Print the outcome of all tests performed since the last time this function was called */
791 void checkasm_report(const char *name, ...)
792 {
793     static int prev_checked, prev_failed, max_length;
794
795     if (state.num_checked > prev_checked) {
796         int pad_length = max_length + 4;
797         va_list arg;
798
799         print_cpu_name();
800         pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
801         va_start(arg, name);
802         pad_length -= vfprintf(stderr, name, arg);
803         va_end(arg);
804         fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
805
806         if (state.num_failed == prev_failed)
807             color_printf(COLOR_GREEN, "OK");
808         else
809             color_printf(COLOR_RED, "FAILED");
810         fprintf(stderr, "]\n");
811
812         prev_checked = state.num_checked;
813         prev_failed  = state.num_failed;
814     } else if (!state.cpu_flag) {
815         /* Calculate the amount of padding required to make the output vertically aligned */
816         int length = strlen(state.current_test_name);
817         va_list arg;
818
819         va_start(arg, name);
820         length += vsnprintf(NULL, 0, name, arg);
821         va_end(arg);
822
823         if (length > max_length)
824             max_length = length;
825     }
826 }