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