Merge commit '105998fb5ca3c343f5c8cb39ce3197f87a5e4d36'
[ffmpeg.git] / tests / checkasm / checkasm.h
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 #ifndef TESTS_CHECKASM_CHECKASM_H
24 #define TESTS_CHECKASM_CHECKASM_H
25
26 #include <stdint.h>
27 #include "config.h"
28 #include "libavutil/avstring.h"
29 #include "libavutil/cpu.h"
30 #include "libavutil/lfg.h"
31 #include "libavutil/timer.h"
32
33 void checkasm_check_alacdsp(void);
34 void checkasm_check_blend(void);
35 void checkasm_check_bswapdsp(void);
36 void checkasm_check_colorspace(void);
37 void checkasm_check_flacdsp(void);
38 void checkasm_check_fmtconvert(void);
39 void checkasm_check_h264dsp(void);
40 void checkasm_check_h264pred(void);
41 void checkasm_check_h264qpel(void);
42 void checkasm_check_jpeg2000dsp(void);
43 void checkasm_check_pixblockdsp(void);
44 void checkasm_check_synth_filter(void);
45 void checkasm_check_v210enc(void);
46 void checkasm_check_vp9dsp(void);
47 void checkasm_check_videodsp(void);
48
49 void *checkasm_check_func(void *func, const char *name, ...) av_printf_format(2, 3);
50 int checkasm_bench_func(void);
51 void checkasm_fail_func(const char *msg, ...) av_printf_format(1, 2);
52 void checkasm_update_bench(int iterations, uint64_t cycles);
53 void checkasm_report(const char *name, ...) av_printf_format(1, 2);
54
55 /* float compare utilities */
56 int float_near_ulp(float a, float b, unsigned max_ulp);
57 int float_near_abs_eps(float a, float b, float eps);
58 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp);
59 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
60                          unsigned len);
61 int float_near_abs_eps_array(const float *a, const float *b, float eps,
62                              unsigned len);
63 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
64                                  unsigned max_ulp, unsigned len);
65
66 extern AVLFG checkasm_lfg;
67 #define rnd() av_lfg_get(&checkasm_lfg)
68
69 static av_unused void *func_ref, *func_new;
70
71 #define BENCH_RUNS 1000 /* Trade-off between accuracy and speed */
72
73 /* Decide whether or not the specified function needs to be tested */
74 #define check_func(func, ...) (func_ref = checkasm_check_func((func_new = func), __VA_ARGS__))
75
76 /* Declare the function prototype. The first argument is the return value, the remaining
77  * arguments are the function parameters. Naming parameters is optional. */
78 #define declare_func(ret, ...) declare_new(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
79 #define declare_func_emms(cpu_flags, ret, ...) declare_new_emms(cpu_flags, ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
80
81 /* Indicate that the current test has failed */
82 #define fail() checkasm_fail_func("%s:%d", av_basename(__FILE__), __LINE__)
83
84 /* Print the test outcome */
85 #define report checkasm_report
86
87 /* Call the reference function */
88 #define call_ref(...) ((func_type *)func_ref)(__VA_ARGS__)
89
90 #if ARCH_X86 && HAVE_YASM
91 /* Verifies that clobbered callee-saved registers are properly saved and restored
92  * and that either no MMX registers are touched or emms is issued */
93 void checkasm_checked_call(void *func, ...);
94 /* Verifies that clobbered callee-saved registers are properly saved and restored
95  * and issues emms for asm functions which are not required to do so */
96 void checkasm_checked_call_emms(void *func, ...);
97
98 #if ARCH_X86_64
99 /* Evil hack: detect incorrect assumptions that 32-bit ints are zero-extended to 64-bit.
100  * This is done by clobbering the stack with junk around the stack pointer and calling the
101  * assembly function through checked_call() with added dummy arguments which forces all
102  * real arguments to be passed on the stack and not in registers. For 32-bit arguments the
103  * upper half of the 64-bit register locations on the stack will now contain junk which will
104  * cause misbehaving functions to either produce incorrect output or segfault. Note that
105  * even though this works extremely well in practice, it's technically not guaranteed
106  * and false negatives is theoretically possible, but there can never be any false positives.
107  */
108 void checkasm_stack_clobber(uint64_t clobber, ...);
109 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
110                               = (void *)checkasm_checked_call;
111 #define declare_new_emms(cpu_flags, ret, ...) \
112     ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__) = \
113         ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms : \
114                                              (void *)checkasm_checked_call;
115 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))
116 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
117                                               CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
118                       checked_call(func_new, 0, 0, 0, 0, 0, __VA_ARGS__))
119 #elif ARCH_X86_32
120 #define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;
121 #define declare_new_emms(cpu_flags, ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = \
122         ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms :        \
123                                              (void *)checkasm_checked_call;
124 #define call_new(...) checked_call(func_new, __VA_ARGS__)
125 #endif
126 #elif ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
127 /* Use a dummy argument, to offset the real parameters by 2, not only 1.
128  * This makes sure that potential 8-byte-alignment of parameters is kept the same
129  * even when the extra parameters have been removed. */
130 void checkasm_checked_call_vfp(void *func, int dummy, ...);
131 void checkasm_checked_call_novfp(void *func, int dummy, ...);
132 extern void (*checkasm_checked_call)(void *func, int dummy, ...);
133 #define declare_new(ret, ...) ret (*checked_call)(void *, int dummy, __VA_ARGS__) = (void *)checkasm_checked_call;
134 #define call_new(...) checked_call(func_new, 0, __VA_ARGS__)
135 #elif ARCH_AARCH64 && !defined(__APPLE__)
136 void checkasm_checked_call(void *func, ...);
137 #define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;
138 #define call_new(...) checked_call(func_new, __VA_ARGS__)
139 #else
140 #define declare_new(ret, ...)
141 #define declare_new_emms(cpu_flags, ret, ...)
142 /* Call the function */
143 #define call_new(...) ((func_type *)func_new)(__VA_ARGS__)
144 #endif
145
146 #ifndef declare_new_emms
147 #define declare_new_emms(cpu_flags, ret, ...) declare_new(ret, __VA_ARGS__)
148 #endif
149
150 /* Benchmark the function */
151 #ifdef AV_READ_TIME
152 #define bench_new(...)\
153     do {\
154         if (checkasm_bench_func()) {\
155             func_type *tfunc = func_new;\
156             uint64_t tsum = 0;\
157             int ti, tcount = 0;\
158             for (ti = 0; ti < BENCH_RUNS; ti++) {\
159                 uint64_t t = AV_READ_TIME();\
160                 tfunc(__VA_ARGS__);\
161                 tfunc(__VA_ARGS__);\
162                 tfunc(__VA_ARGS__);\
163                 tfunc(__VA_ARGS__);\
164                 t = AV_READ_TIME() - t;\
165                 if (t*tcount <= tsum*4 && ti > 0) {\
166                     tsum += t;\
167                     tcount++;\
168                 }\
169             }\
170             checkasm_update_bench(tcount, tsum);\
171         }\
172     } while (0)
173 #else
174 #define bench_new(...) while(0)
175 #endif
176
177 #endif /* TESTS_CHECKASM_CHECKASM_H */