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