checkasm: Use a self-balancing tree
[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 CHECKASM_H
24 #define CHECKASM_H
25
26 #include <stdint.h>
27 #include "config.h"
28 #include "libavutil/avstring.h"
29 #include "libavutil/lfg.h"
30 #include "libavutil/timer.h"
31
32 void checkasm_check_bswapdsp(void);
33 void checkasm_check_h264pred(void);
34 void checkasm_check_h264qpel(void);
35 void checkasm_check_v210enc(void);
36
37 void *checkasm_check_func(void *func, const char *name, ...) av_printf_format(2, 3);
38 int checkasm_bench_func(void);
39 void checkasm_fail_func(const char *msg, ...) av_printf_format(1, 2);
40 void checkasm_update_bench(int iterations, uint64_t cycles);
41 void checkasm_report(const char *name, ...) av_printf_format(1, 2);
42
43 extern AVLFG checkasm_lfg;
44 #define rnd() av_lfg_get(&checkasm_lfg)
45
46 static av_unused void *func_ref, *func_new;
47
48 #define BENCH_RUNS 1000 /* Trade-off between accuracy and speed */
49
50 /* Decide whether or not the specified function needs to be tested */
51 #define check_func(func, ...) (func_ref = checkasm_check_func((func_new = func), __VA_ARGS__))
52
53 /* Declare the function prototype. The first argument is the return value, the remaining
54  * arguments are the function parameters. Naming parameters is optional. */
55 #define declare_func(ret, ...) declare_new(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
56
57 /* Indicate that the current test has failed */
58 #define fail() checkasm_fail_func("%s:%d", av_basename(__FILE__), __LINE__)
59
60 /* Print the test outcome */
61 #define report checkasm_report
62
63 /* Call the reference function */
64 #define call_ref(...) ((func_type *)func_ref)(__VA_ARGS__)
65
66 #if ARCH_X86 && HAVE_YASM
67 /* Verifies that clobbered callee-saved registers are properly saved and restored */
68 void checkasm_checked_call(void *func, ...);
69
70 #if ARCH_X86_64
71 /* Evil hack: detect incorrect assumptions that 32-bit ints are zero-extended to 64-bit.
72  * This is done by clobbering the stack with junk around the stack pointer and calling the
73  * assembly function through checked_call() with added dummy arguments which forces all
74  * real arguments to be passed on the stack and not in registers. For 32-bit arguments the
75  * upper half of the 64-bit register locations on the stack will now contain junk which will
76  * cause misbehaving functions to either produce incorrect output or segfault. Note that
77  * even though this works extremely well in practice, it's technically not guaranteed
78  * and false negatives is theoretically possible, but there can never be any false positives.
79  */
80 void checkasm_stack_clobber(uint64_t clobber, ...);
81 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
82                               = (void *)checkasm_checked_call;
83 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))
84 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
85                                               CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
86                       checked_call(func_new, 0, 0, 0, 0, 0, __VA_ARGS__))
87 #elif ARCH_X86_32
88 #define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;
89 #define call_new(...) checked_call(func_new, __VA_ARGS__)
90 #endif
91 #else
92 #define declare_new(ret, ...)
93 /* Call the function */
94 #define call_new(...) ((func_type *)func_new)(__VA_ARGS__)
95 #endif
96
97 /* Benchmark the function */
98 #ifdef AV_READ_TIME
99 #define bench_new(...)\
100     do {\
101         if (checkasm_bench_func()) {\
102             func_type *tfunc = func_new;\
103             uint64_t tsum = 0;\
104             int ti, tcount = 0;\
105             for (ti = 0; ti < BENCH_RUNS; ti++) {\
106                 uint64_t t = AV_READ_TIME();\
107                 tfunc(__VA_ARGS__);\
108                 tfunc(__VA_ARGS__);\
109                 tfunc(__VA_ARGS__);\
110                 tfunc(__VA_ARGS__);\
111                 t = AV_READ_TIME() - t;\
112                 if (t*tcount <= tsum*4 && ti > 0) {\
113                     tsum += t;\
114                     tcount++;\
115                 }\
116             }\
117             checkasm_update_bench(tcount, tsum);\
118         }\
119     } while (0)
120 #else
121 #define bench_new(...) while(0)
122 #endif
123
124 #endif