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