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