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