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