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