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