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