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