checkasm: add HEVC 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 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     { "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     uint8_t color; /* 0 = red, 1 = black */
132     char name[1];
133 } CheckasmFunc;
134
135 /* Internal state */
136 static struct {
137     CheckasmFunc *funcs;
138     CheckasmFunc *current_func;
139     CheckasmFuncVersion *current_func_ver;
140     const char *current_test_name;
141     const char *bench_pattern;
142     int bench_pattern_len;
143     int num_checked;
144     int num_failed;
145     int nop_time;
146     int cpu_flag;
147     const char *cpu_flag_name;
148 } state;
149
150 /* PRNG state */
151 AVLFG checkasm_lfg;
152
153 /* Print colored text to stderr if the terminal supports it */
154 static void color_printf(int color, const char *fmt, ...)
155 {
156     static int use_color = -1;
157     va_list arg;
158
159 #if HAVE_SETCONSOLETEXTATTRIBUTE
160     static HANDLE con;
161     static WORD org_attributes;
162
163     if (use_color < 0) {
164         CONSOLE_SCREEN_BUFFER_INFO con_info;
165         con = GetStdHandle(STD_ERROR_HANDLE);
166         if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
167             org_attributes = con_info.wAttributes;
168             use_color = 1;
169         } else
170             use_color = 0;
171     }
172     if (use_color)
173         SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
174 #else
175     if (use_color < 0) {
176         const char *term = getenv("TERM");
177         use_color = term && strcmp(term, "dumb") && isatty(2);
178     }
179     if (use_color)
180         fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
181 #endif
182
183     va_start(arg, fmt);
184     vfprintf(stderr, fmt, arg);
185     va_end(arg);
186
187     if (use_color) {
188 #if HAVE_SETCONSOLETEXTATTRIBUTE
189         SetConsoleTextAttribute(con, org_attributes);
190 #else
191         fprintf(stderr, "\x1b[0m");
192 #endif
193     }
194 }
195
196 /* Deallocate a tree */
197 static void destroy_func_tree(CheckasmFunc *f)
198 {
199     if (f) {
200         CheckasmFuncVersion *v = f->versions.next;
201         while (v) {
202             CheckasmFuncVersion *next = v->next;
203             free(v);
204             v = next;
205         }
206
207         destroy_func_tree(f->child[0]);
208         destroy_func_tree(f->child[1]);
209         free(f);
210     }
211 }
212
213 /* Allocate a zero-initialized block, clean up and exit on failure */
214 static void *checkasm_malloc(size_t size)
215 {
216     void *ptr = calloc(1, size);
217     if (!ptr) {
218         fprintf(stderr, "checkasm: malloc failed\n");
219         destroy_func_tree(state.funcs);
220         exit(1);
221     }
222     return ptr;
223 }
224
225 /* Get the suffix of the specified cpu flag */
226 static const char *cpu_suffix(int cpu)
227 {
228     int i = FF_ARRAY_ELEMS(cpus);
229
230     while (--i >= 0)
231         if (cpu & cpus[i].flag)
232             return cpus[i].suffix;
233
234     return "c";
235 }
236
237 #ifdef AV_READ_TIME
238 static int cmp_nop(const void *a, const void *b)
239 {
240     return *(const uint16_t*)a - *(const uint16_t*)b;
241 }
242
243 /* Measure the overhead of the timing code (in decicycles) */
244 static int measure_nop_time(void)
245 {
246     uint16_t nops[10000];
247     int i, nop_sum = 0;
248
249     for (i = 0; i < 10000; i++) {
250         uint64_t t = AV_READ_TIME();
251         nops[i] = AV_READ_TIME() - t;
252     }
253
254     qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
255     for (i = 2500; i < 7500; i++)
256         nop_sum += nops[i];
257
258     return nop_sum / 500;
259 }
260
261 /* Print benchmark results */
262 static void print_benchs(CheckasmFunc *f)
263 {
264     if (f) {
265         print_benchs(f->child[0]);
266
267         /* Only print functions with at least one assembly version */
268         if (f->versions.cpu || f->versions.next) {
269             CheckasmFuncVersion *v = &f->versions;
270             do {
271                 if (v->iterations) {
272                     int decicycles = (10*v->cycles/v->iterations - state.nop_time) / 4;
273                     printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
274                 }
275             } while ((v = v->next));
276         }
277
278         print_benchs(f->child[1]);
279     }
280 }
281 #endif
282
283 /* ASCIIbetical sort except preserving natural order for numbers */
284 static int cmp_func_names(const char *a, const char *b)
285 {
286     const char *start = a;
287     int ascii_diff, digit_diff;
288
289     for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
290     for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
291
292     if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
293         return digit_diff;
294
295     return ascii_diff;
296 }
297
298 /* Perform a tree rotation in the specified direction and return the new root */
299 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
300 {
301     CheckasmFunc *r = f->child[dir^1];
302     f->child[dir^1] = r->child[dir];
303     r->child[dir] = f;
304     r->color = f->color;
305     f->color = 0;
306     return r;
307 }
308
309 #define is_red(f) ((f) && !(f)->color)
310
311 /* Balance a left-leaning red-black tree at the specified node */
312 static void balance_tree(CheckasmFunc **root)
313 {
314     CheckasmFunc *f = *root;
315
316     if (is_red(f->child[0]) && is_red(f->child[1])) {
317         f->color ^= 1;
318         f->child[0]->color = f->child[1]->color = 1;
319     }
320
321     if (!is_red(f->child[0]) && is_red(f->child[1]))
322         *root = rotate_tree(f, 0); /* Rotate left */
323     else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
324         *root = rotate_tree(f, 1); /* Rotate right */
325 }
326
327 /* Get a node with the specified name, creating it if it doesn't exist */
328 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
329 {
330     CheckasmFunc *f = *root;
331
332     if (f) {
333         /* Search the tree for a matching node */
334         int cmp = cmp_func_names(name, f->name);
335         if (cmp) {
336             f = get_func(&f->child[cmp > 0], name);
337
338             /* Rebalance the tree on the way up if a new node was inserted */
339             if (!f->versions.func)
340                 balance_tree(root);
341         }
342     } else {
343         /* Allocate and insert a new node into the tree */
344         int name_length = strlen(name);
345         f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
346         memcpy(f->name, name, name_length + 1);
347     }
348
349     return f;
350 }
351
352 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
353 static void check_cpu_flag(const char *name, int flag)
354 {
355     int old_cpu_flag = state.cpu_flag;
356
357     flag |= old_cpu_flag;
358     av_set_cpu_flags_mask(flag);
359     state.cpu_flag = av_get_cpu_flags();
360
361     if (!flag || state.cpu_flag != old_cpu_flag) {
362         int i;
363
364         state.cpu_flag_name = name;
365         for (i = 0; tests[i].func; i++) {
366             state.current_test_name = tests[i].name;
367             tests[i].func();
368         }
369     }
370 }
371
372 /* Print the name of the current CPU flag, but only do it once */
373 static void print_cpu_name(void)
374 {
375     if (state.cpu_flag_name) {
376         color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
377         state.cpu_flag_name = NULL;
378     }
379 }
380
381 int main(int argc, char *argv[])
382 {
383     int i, seed, ret = 0;
384
385     if (!tests[0].func || !cpus[0].flag) {
386         fprintf(stderr, "checkasm: no tests to perform\n");
387         return 0;
388     }
389
390     if (argc > 1 && !strncmp(argv[1], "--bench", 7)) {
391 #ifndef AV_READ_TIME
392         fprintf(stderr, "checkasm: --bench is not supported on your system\n");
393         return 1;
394 #endif
395         if (argv[1][7] == '=') {
396             state.bench_pattern = argv[1] + 8;
397             state.bench_pattern_len = strlen(state.bench_pattern);
398         } else
399             state.bench_pattern = "";
400
401         argc--;
402         argv++;
403     }
404
405     seed = (argc > 1) ? atoi(argv[1]) : av_get_random_seed();
406     fprintf(stderr, "checkasm: using random seed %u\n", seed);
407     av_lfg_init(&checkasm_lfg, seed);
408
409     check_cpu_flag(NULL, 0);
410     for (i = 0; cpus[i].flag; i++)
411         check_cpu_flag(cpus[i].name, cpus[i].flag);
412
413     if (state.num_failed) {
414         fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
415         ret = 1;
416     } else {
417         fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
418 #ifdef AV_READ_TIME
419         if (state.bench_pattern) {
420             state.nop_time = measure_nop_time();
421             printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
422             print_benchs(state.funcs);
423         }
424 #endif
425     }
426
427     destroy_func_tree(state.funcs);
428     return ret;
429 }
430
431 /* Decide whether or not the specified function needs to be tested and
432  * allocate/initialize data structures if needed. Returns a pointer to a
433  * reference function if the function should be tested, otherwise NULL */
434 void *checkasm_check_func(void *func, const char *name, ...)
435 {
436     char name_buf[256];
437     void *ref = func;
438     CheckasmFuncVersion *v;
439     int name_length;
440     va_list arg;
441
442     va_start(arg, name);
443     name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
444     va_end(arg);
445
446     if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
447         return NULL;
448
449     state.current_func = get_func(&state.funcs, name_buf);
450     state.funcs->color = 1;
451     v = &state.current_func->versions;
452
453     if (v->func) {
454         CheckasmFuncVersion *prev;
455         do {
456             /* Only test functions that haven't already been tested */
457             if (v->func == func)
458                 return NULL;
459
460             if (v->ok)
461                 ref = v->func;
462
463             prev = v;
464         } while ((v = v->next));
465
466         v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
467     }
468
469     v->func = func;
470     v->ok = 1;
471     v->cpu = state.cpu_flag;
472     state.current_func_ver = v;
473
474     if (state.cpu_flag)
475         state.num_checked++;
476
477     return ref;
478 }
479
480 /* Decide whether or not the current function needs to be benchmarked */
481 int checkasm_bench_func(void)
482 {
483     return !state.num_failed && state.bench_pattern &&
484            !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
485 }
486
487 /* Indicate that the current test has failed */
488 void checkasm_fail_func(const char *msg, ...)
489 {
490     if (state.current_func_ver->cpu && state.current_func_ver->ok) {
491         va_list arg;
492
493         print_cpu_name();
494         fprintf(stderr, "   %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
495         va_start(arg, msg);
496         vfprintf(stderr, msg, arg);
497         va_end(arg);
498         fprintf(stderr, ")\n");
499
500         state.current_func_ver->ok = 0;
501         state.num_failed++;
502     }
503 }
504
505 /* Update benchmark results of the current function */
506 void checkasm_update_bench(int iterations, uint64_t cycles)
507 {
508     state.current_func_ver->iterations += iterations;
509     state.current_func_ver->cycles += cycles;
510 }
511
512 /* Print the outcome of all tests performed since the last time this function was called */
513 void checkasm_report(const char *name, ...)
514 {
515     static int prev_checked, prev_failed, max_length;
516
517     if (state.num_checked > prev_checked) {
518         int pad_length = max_length + 4;
519         va_list arg;
520
521         print_cpu_name();
522         pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
523         va_start(arg, name);
524         pad_length -= vfprintf(stderr, name, arg);
525         va_end(arg);
526         fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
527
528         if (state.num_failed == prev_failed)
529             color_printf(COLOR_GREEN, "OK");
530         else
531             color_printf(COLOR_RED, "FAILED");
532         fprintf(stderr, "]\n");
533
534         prev_checked = state.num_checked;
535         prev_failed  = state.num_failed;
536     } else if (!state.cpu_flag) {
537         /* Calculate the amount of padding required to make the output vertically aligned */
538         int length = strlen(state.current_test_name);
539         va_list arg;
540
541         va_start(arg, name);
542         length += vsnprintf(NULL, 0, name, arg);
543         va_end(arg);
544
545         if (length > max_length)
546             max_length = length;
547     }
548 }