2 * Assembly testing and benchmarking tool
3 * Copyright (c) 2015 Henrik Gramner
4 * Copyright (c) 2008 Loren Merritt
6 * This file is part of FFmpeg.
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.
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.
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.
28 #include "libavutil/avstring.h"
29 #include "libavutil/lfg.h"
30 #include "libavutil/timer.h"
32 void checkasm_check_bswapdsp(void);
33 void checkasm_check_flacdsp(void);
34 void checkasm_check_h264pred(void);
35 void checkasm_check_h264qpel(void);
36 void checkasm_check_jpeg2000dsp(void);
37 void checkasm_check_v210enc(void);
38 void checkasm_check_vp9dsp(void);
40 void *checkasm_check_func(void *func, const char *name, ...) av_printf_format(2, 3);
41 int checkasm_bench_func(void);
42 void checkasm_fail_func(const char *msg, ...) av_printf_format(1, 2);
43 void checkasm_update_bench(int iterations, uint64_t cycles);
44 void checkasm_report(const char *name, ...) av_printf_format(1, 2);
46 extern AVLFG checkasm_lfg;
47 #define rnd() av_lfg_get(&checkasm_lfg)
49 static av_unused void *func_ref, *func_new;
51 #define BENCH_RUNS 1000 /* Trade-off between accuracy and speed */
53 /* Decide whether or not the specified function needs to be tested */
54 #define check_func(func, ...) (func_ref = checkasm_check_func((func_new = func), __VA_ARGS__))
56 /* Declare the function prototype. The first argument is the return value, the remaining
57 * arguments are the function parameters. Naming parameters is optional. */
58 #define declare_func(ret, ...) declare_new(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
60 /* Indicate that the current test has failed */
61 #define fail() checkasm_fail_func("%s:%d", av_basename(__FILE__), __LINE__)
63 /* Print the test outcome */
64 #define report checkasm_report
66 /* Call the reference function */
67 #define call_ref(...) ((func_type *)func_ref)(__VA_ARGS__)
69 #if ARCH_X86 && HAVE_YASM
70 /* Verifies that clobbered callee-saved registers are properly saved and restored */
71 void checkasm_checked_call(void *func, ...);
74 /* Evil hack: detect incorrect assumptions that 32-bit ints are zero-extended to 64-bit.
75 * This is done by clobbering the stack with junk around the stack pointer and calling the
76 * assembly function through checked_call() with added dummy arguments which forces all
77 * real arguments to be passed on the stack and not in registers. For 32-bit arguments the
78 * upper half of the 64-bit register locations on the stack will now contain junk which will
79 * cause misbehaving functions to either produce incorrect output or segfault. Note that
80 * even though this works extremely well in practice, it's technically not guaranteed
81 * and false negatives is theoretically possible, but there can never be any false positives.
83 void checkasm_stack_clobber(uint64_t clobber, ...);
84 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
85 = (void *)checkasm_checked_call;
86 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))
87 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
88 CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
89 checked_call(func_new, 0, 0, 0, 0, 0, __VA_ARGS__))
91 #define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;
92 #define call_new(...) checked_call(func_new, __VA_ARGS__)
95 #define declare_new(ret, ...)
96 /* Call the function */
97 #define call_new(...) ((func_type *)func_new)(__VA_ARGS__)
100 /* Benchmark the function */
102 #define bench_new(...)\
104 if (checkasm_bench_func()) {\
105 func_type *tfunc = func_new;\
108 for (ti = 0; ti < BENCH_RUNS; ti++) {\
109 uint64_t t = AV_READ_TIME();\
114 t = AV_READ_TIME() - t;\
115 if (t*tcount <= tsum*4 && ti > 0) {\
120 checkasm_update_bench(tcount, tsum);\
124 #define bench_new(...) while(0)