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
29#if CONFIG_LINUX_PERF
30#include <unistd.h> // read(3)
31#include <sys/ioctl.h>
32#include <asm/unistd.h>
33#include <linux/perf_event.h>
34#elif CONFIG_MACOS_KPERF
35#include "libavutil/macos_kperf.h"
36#endif
37
38#include "libavutil/avstring.h"
39#include "libavutil/cpu.h"
40#include "libavutil/internal.h"
41#include "libavutil/lfg.h"
42#include "libavutil/timer.h"
43
44void checkasm_check_aacpsdsp(void);
45void checkasm_check_afir(void);
46void checkasm_check_alacdsp(void);
47void checkasm_check_audiodsp(void);
48void checkasm_check_av_tx(void);
49void checkasm_check_blend(void);
50void checkasm_check_blockdsp(void);
51void checkasm_check_bswapdsp(void);
52void checkasm_check_colorspace(void);
53void checkasm_check_exrdsp(void);
54void checkasm_check_fixed_dsp(void);
55void checkasm_check_flacdsp(void);
56void checkasm_check_float_dsp(void);
57void checkasm_check_fmtconvert(void);
58void checkasm_check_g722dsp(void);
59void checkasm_check_h264dsp(void);
60void checkasm_check_h264pred(void);
61void checkasm_check_h264qpel(void);
62void checkasm_check_hevc_add_res(void);
63void checkasm_check_hevc_idct(void);
64void checkasm_check_hevc_pel(void);
65void checkasm_check_hevc_sao(void);
66void checkasm_check_huffyuvdsp(void);
67void checkasm_check_idctdsp(void);
68void checkasm_check_jpeg2000dsp(void);
69void checkasm_check_llviddsp(void);
70void checkasm_check_llviddspenc(void);
71void checkasm_check_motion(void);
72void checkasm_check_nlmeans(void);
73void checkasm_check_opusdsp(void);
74void checkasm_check_pixblockdsp(void);
75void checkasm_check_sbrdsp(void);
76void checkasm_check_synth_filter(void);
77void checkasm_check_sw_gbrp(void);
78void checkasm_check_sw_rgb(void);
79void checkasm_check_sw_scale(void);
80void checkasm_check_utvideodsp(void);
81void checkasm_check_v210dec(void);
82void checkasm_check_v210enc(void);
83void checkasm_check_vc1dsp(void);
84void checkasm_check_vf_eq(void);
85void checkasm_check_vf_gblur(void);
86void checkasm_check_vf_hflip(void);
87void checkasm_check_vf_threshold(void);
88void checkasm_check_vp8dsp(void);
89void checkasm_check_vp9dsp(void);
90void checkasm_check_videodsp(void);
91
92struct CheckasmPerf;
93
94void *checkasm_check_func(void *func, const char *name, ...) av_printf_format(2, 3);
95int checkasm_bench_func(void);
96void checkasm_fail_func(const char *msg, ...) av_printf_format(1, 2);
97struct CheckasmPerf *checkasm_get_perf_context(void);
98void checkasm_report(const char *name, ...) av_printf_format(1, 2);
99
100/* float compare utilities */
101int float_near_ulp(float a, float b, unsigned max_ulp);
102int float_near_abs_eps(float a, float b, float eps);
103int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp);
104int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
105                         unsigned len);
106int float_near_abs_eps_array(const float *a, const float *b, float eps,
107                             unsigned len);
108int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
109                                 unsigned max_ulp, unsigned len);
110int double_near_abs_eps(double a, double b, double eps);
111int double_near_abs_eps_array(const double *a, const double *b, double eps,
112                              unsigned len);
113
114extern AVLFG checkasm_lfg;
115#define rnd() av_lfg_get(&checkasm_lfg)
116
117static av_unused void *func_ref, *func_new;
118
119#define BENCH_RUNS 1000 /* Trade-off between accuracy and speed */
120
121/* Decide whether or not the specified function needs to be tested */
122#define check_func(func, ...) (func_ref = checkasm_check_func((func_new = func), __VA_ARGS__))
123
124/* Declare the function prototype. The first argument is the return value, the remaining
125 * arguments are the function parameters. Naming parameters is optional. */
126#define declare_func(ret, ...) declare_new(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
127#define declare_func_float(ret, ...) declare_new_float(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
128#define declare_func_emms(cpu_flags, ret, ...) declare_new_emms(cpu_flags, ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
129
130/* Indicate that the current test has failed */
131#define fail() checkasm_fail_func("%s:%d", av_basename(__FILE__), __LINE__)
132
133/* Print the test outcome */
134#define report checkasm_report
135
136/* Call the reference function */
137#define call_ref(...) ((func_type *)func_ref)(__VA_ARGS__)
138
139#if ARCH_X86 && HAVE_X86ASM
140/* Verifies that clobbered callee-saved registers are properly saved and restored
141 * and that either no MMX registers are touched or emms is issued */
142void checkasm_checked_call(void *func, ...);
143/* Verifies that clobbered callee-saved registers are properly saved and restored
144 * and issues emms for asm functions which are not required to do so */
145void checkasm_checked_call_emms(void *func, ...);
146/* Verifies that clobbered callee-saved registers are properly saved and restored
147 * but doesn't issue emms. Meant for dsp functions returning float or double */
148void checkasm_checked_call_float(void *func, ...);
149
150#if ARCH_X86_64
151/* Evil hack: detect incorrect assumptions that 32-bit ints are zero-extended to 64-bit.
152 * This is done by clobbering the stack with junk around the stack pointer and calling the
153 * assembly function through checked_call() with added dummy arguments which forces all
154 * real arguments to be passed on the stack and not in registers. For 32-bit arguments the
155 * upper half of the 64-bit register locations on the stack will now contain junk which will
156 * cause misbehaving functions to either produce incorrect output or segfault. Note that
157 * even though this works extremely well in practice, it's technically not guaranteed
158 * and false negatives is theoretically possible, but there can never be any false positives.
159 */
160void checkasm_stack_clobber(uint64_t clobber, ...);
161#define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
162                              = (void *)checkasm_checked_call;
163#define declare_new_float(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
164                                    = (void *)checkasm_checked_call_float;
165#define declare_new_emms(cpu_flags, ret, ...) \
166    ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__) = \
167        ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms : \
168                                             (void *)checkasm_checked_call;
169#define CLOB (UINT64_C(0xdeadbeefdeadbeef))
170#define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
171                                              CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
172                      checked_call(func_new, 0, 0, 0, 0, 0, __VA_ARGS__))
173#elif ARCH_X86_32
174#define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;
175#define declare_new_float(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call_float;
176#define declare_new_emms(cpu_flags, ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = \
177        ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms :        \
178                                             (void *)checkasm_checked_call;
179#define call_new(...) checked_call(func_new, __VA_ARGS__)
180#endif
181#elif ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
182/* Use a dummy argument, to offset the real parameters by 2, not only 1.
183 * This makes sure that potential 8-byte-alignment of parameters is kept the same
184 * even when the extra parameters have been removed. */
185void checkasm_checked_call_vfp(void *func, int dummy, ...);
186void checkasm_checked_call_novfp(void *func, int dummy, ...);
187extern void (*checkasm_checked_call)(void *func, int dummy, ...);
188#define declare_new(ret, ...) ret (*checked_call)(void *, int dummy, __VA_ARGS__, \
189                                                  int, int, int, int, int, int, int, int, \
190                                                  int, int, int, int, int, int, int) = (void *)checkasm_checked_call;
191#define call_new(...) checked_call(func_new, 0, __VA_ARGS__, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0, 0, 0, 0)
192#elif ARCH_AARCH64 && !defined(__APPLE__)
193void checkasm_stack_clobber(uint64_t clobber, ...);
194void checkasm_checked_call(void *func, ...);
195#define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, int, int, __VA_ARGS__,\
196                                                  int, int, int, int, int, int, int, int,\
197                                                  int, int, int, int, int, int, int)\
198                              = (void *)checkasm_checked_call;
199#define CLOB (UINT64_C(0xdeadbeefdeadbeef))
200#define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
201                                              CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
202                      checked_call(func_new, 0, 0, 0, 0, 0, 0, 0, __VA_ARGS__,\
203                                   7, 6, 5, 4, 3, 2, 1, 0, 0, 0, 0, 0, 0, 0, 0))
204#else
205#define declare_new(ret, ...)
206#define declare_new_float(ret, ...)
207#define declare_new_emms(cpu_flags, ret, ...)
208/* Call the function */
209#define call_new(...) ((func_type *)func_new)(__VA_ARGS__)
210#endif
211
212#ifndef declare_new_emms
213#define declare_new_emms(cpu_flags, ret, ...) declare_new(ret, __VA_ARGS__)
214#endif
215#ifndef declare_new_float
216#define declare_new_float(ret, ...) declare_new(ret, __VA_ARGS__)
217#endif
218
219typedef struct CheckasmPerf {
220    int sysfd;
221    uint64_t cycles;
222    int iterations;
223} CheckasmPerf;
224
225#if defined(AV_READ_TIME) || CONFIG_LINUX_PERF || CONFIG_MACOS_KPERF
226
227#if CONFIG_LINUX_PERF
228#define PERF_START(t) do {                              \
229    ioctl(sysfd, PERF_EVENT_IOC_RESET, 0);              \
230    ioctl(sysfd, PERF_EVENT_IOC_ENABLE, 0);             \
231} while (0)
232#define PERF_STOP(t) do {                               \
233    ioctl(sysfd, PERF_EVENT_IOC_DISABLE, 0);            \
234    read(sysfd, &t, sizeof(t));                         \
235} while (0)
236#elif CONFIG_MACOS_KPERF
237#define PERF_START(t) t = ff_kperf_cycles()
238#define PERF_STOP(t)  t = ff_kperf_cycles() - t
239#else
240#define PERF_START(t) t = AV_READ_TIME()
241#define PERF_STOP(t)  t = AV_READ_TIME() - t
242#endif
243
244/* Benchmark the function */
245#define bench_new(...)\
246    do {\
247        if (checkasm_bench_func()) {\
248            struct CheckasmPerf *perf = checkasm_get_perf_context();\
249            av_unused const int sysfd = perf->sysfd;\
250            func_type *tfunc = func_new;\
251            uint64_t tsum = 0;\
252            int ti, tcount = 0;\
253            uint64_t t = 0; \
254            for (ti = 0; ti < BENCH_RUNS; ti++) {\
255                PERF_START(t);\
256                tfunc(__VA_ARGS__);\
257                tfunc(__VA_ARGS__);\
258                tfunc(__VA_ARGS__);\
259                tfunc(__VA_ARGS__);\
260                PERF_STOP(t);\
261                if (t*tcount <= tsum*4 && ti > 0) {\
262                    tsum += t;\
263                    tcount++;\
264                }\
265            }\
266            emms_c();\
267            perf->cycles += t;\
268            perf->iterations++;\
269        }\
270    } while (0)
271#else
272#define bench_new(...) while(0)
273#define PERF_START(t)  while(0)
274#define PERF_STOP(t)   while(0)
275#endif
276
277#define DECL_CHECKASM_CHECK_FUNC(type) \
278int checkasm_check_##type(const char *const file, const int line, \
279                          const type *const buf1, const ptrdiff_t stride1, \
280                          const type *const buf2, const ptrdiff_t stride2, \
281                          const int w, const int h, const char *const name)
282
283DECL_CHECKASM_CHECK_FUNC(uint8_t);
284DECL_CHECKASM_CHECK_FUNC(uint16_t);
285DECL_CHECKASM_CHECK_FUNC(int16_t);
286DECL_CHECKASM_CHECK_FUNC(int32_t);
287
288#define PASTE(a,b) a ## b
289#define CONCAT(a,b) PASTE(a,b)
290
291#define checkasm_check(prefix, ...) CONCAT(checkasm_check_, prefix)(__FILE__, __LINE__, __VA_ARGS__)
292
293#endif /* TESTS_CHECKASM_CHECKASM_H */
294