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
  29 #if CONFIG_LINUX_PERF
  30 #include <unistd.h> // read(3)
  31 #include <sys/ioctl.h>
  32 #include <asm/unistd.h>
  33 #include <linux/perf_event.h>
  34 #endif
  35
  36 #include "libavutil/avstring.h"
  37 #include "libavutil/cpu.h"
  38 #include "libavutil/internal.h"
  39 #include "libavutil/lfg.h"
  40 #include "libavutil/timer.h"
  41
  42 void checkasm_check_aacpsdsp(void);
  43 void checkasm_check_alacdsp(void);
  44 void checkasm_check_audiodsp(void);
  45 void checkasm_check_blend(void);
  46 void checkasm_check_blockdsp(void);
  47 void checkasm_check_bswapdsp(void);
  48 void checkasm_check_colorspace(void);
  49 void checkasm_check_exrdsp(void);
  50 void checkasm_check_fixed_dsp(void);
  51 void checkasm_check_flacdsp(void);
  52 void checkasm_check_float_dsp(void);
  53 void checkasm_check_fmtconvert(void);
  54 void checkasm_check_g722dsp(void);
  55 void checkasm_check_h264dsp(void);
  56 void checkasm_check_h264pred(void);
  57 void checkasm_check_h264qpel(void);
  58 void checkasm_check_hevc_add_res(void);
  59 void checkasm_check_hevc_idct(void);
  60 void checkasm_check_huffyuvdsp(void);
  61 void checkasm_check_jpeg2000dsp(void);
  62 void checkasm_check_llviddsp(void);
  63 void checkasm_check_pixblockdsp(void);
  64 void checkasm_check_sbrdsp(void);
  65 void checkasm_check_synth_filter(void);
  66 void checkasm_check_utvideodsp(void);
  67 void checkasm_check_v210enc(void);
  68 void checkasm_check_vf_threshold(void);
  69 void checkasm_check_vp8dsp(void);
  70 void checkasm_check_vp9dsp(void);
  71 void checkasm_check_videodsp(void);
  72
  73 struct CheckasmPerf;
  74
  75 void *checkasm_check_func(void *func, const char *name, ...) av_printf_format(2, 3);
  76 int checkasm_bench_func(void);
  77 void checkasm_fail_func(const char *msg, ...) av_printf_format(1, 2);
  78 struct CheckasmPerf *checkasm_get_perf_context(void);
  79 void checkasm_report(const char *name, ...) av_printf_format(1, 2);
  80
  81 /* float compare utilities */
  82 int float_near_ulp(float a, float b, unsigned max_ulp);
  83 int float_near_abs_eps(float a, float b, float eps);
  84 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp);
  85 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
  86                          unsigned len);
  87 int float_near_abs_eps_array(const float *a, const float *b, float eps,
  88                              unsigned len);
  89 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
  90                                  unsigned max_ulp, unsigned len);
  91 int double_near_abs_eps(double a, double b, double eps);
  92 int double_near_abs_eps_array(const double *a, const double *b, double eps,
  93                               unsigned len);
  94
  95 extern AVLFG checkasm_lfg;
  96 #define rnd() av_lfg_get(&checkasm_lfg)
  97
  98 static av_unused void *func_ref, *func_new;
  99
 100 #define BENCH_RUNS 1000 /* Trade-off between accuracy and speed */
 101
 102 /* Decide whether or not the specified function needs to be tested */
 103 #define check_func(func, ...) (func_ref = checkasm_check_func((func_new = func), __VA_ARGS__))
 104
 105 /* Declare the function prototype. The first argument is the return value, the remaining
 106  * arguments are the function parameters. Naming parameters is optional. */
 107 #define declare_func(ret, ...) declare_new(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
 108 #define declare_func_float(ret, ...) declare_new_float(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
 109 #define declare_func_emms(cpu_flags, ret, ...) declare_new_emms(cpu_flags, ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)
 110
 111 /* Indicate that the current test has failed */
 112 #define fail() checkasm_fail_func("%s:%d", av_basename(__FILE__), __LINE__)
 113
 114 /* Print the test outcome */
 115 #define report checkasm_report
 116
 117 /* Call the reference function */
 118 #define call_ref(...) ((func_type *)func_ref)(__VA_ARGS__)
 119
 120 #if ARCH_X86 && HAVE_X86ASM
 121 /* Verifies that clobbered callee-saved registers are properly saved and restored
 122  * and that either no MMX registers are touched or emms is issued */
 123 void checkasm_checked_call(void *func, ...);
 124 /* Verifies that clobbered callee-saved registers are properly saved and restored
 125  * and issues emms for asm functions which are not required to do so */
 126 void checkasm_checked_call_emms(void *func, ...);
 127 /* Verifies that clobbered callee-saved registers are properly saved and restored
 128  * but doesn't issue emms. Meant for dsp functions returning float or double */
 129 void checkasm_checked_call_float(void *func, ...);
 130
 131 #if ARCH_X86_64
 132 /* Evil hack: detect incorrect assumptions that 32-bit ints are zero-extended to 64-bit.
 133  * This is done by clobbering the stack with junk around the stack pointer and calling the
 134  * assembly function through checked_call() with added dummy arguments which forces all
 135  * real arguments to be passed on the stack and not in registers. For 32-bit arguments the
 136  * upper half of the 64-bit register locations on the stack will now contain junk which will
 137  * cause misbehaving functions to either produce incorrect output or segfault. Note that
 138  * even though this works extremely well in practice, it's technically not guaranteed
 139  * and false negatives is theoretically possible, but there can never be any false positives.
 140  */
 141 void checkasm_stack_clobber(uint64_t clobber, ...);
 142 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
 143                               = (void *)checkasm_checked_call;
 144 #define declare_new_float(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\
 145                                     = (void *)checkasm_checked_call_float;
 146 #define declare_new_emms(cpu_flags, ret, ...) \
 147     ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__) = \
 148         ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms : \
 149                                              (void *)checkasm_checked_call;
 150 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))
 151 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
 152                                               CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
 153                       checked_call(func_new, 0, 0, 0, 0, 0, __VA_ARGS__))
 154 #elif ARCH_X86_32
 155 #define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;
 156 #define declare_new_float(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call_float;
 157 #define declare_new_emms(cpu_flags, ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = \
 158         ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms :        \
 159                                              (void *)checkasm_checked_call;
 160 #define call_new(...) checked_call(func_new, __VA_ARGS__)
 161 #endif
 162 #elif ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
 163 /* Use a dummy argument, to offset the real parameters by 2, not only 1.
 164  * This makes sure that potential 8-byte-alignment of parameters is kept the same
 165  * even when the extra parameters have been removed. */
 166 void checkasm_checked_call_vfp(void *func, int dummy, ...);
 167 void checkasm_checked_call_novfp(void *func, int dummy, ...);
 168 extern void (*checkasm_checked_call)(void *func, int dummy, ...);
 169 #define declare_new(ret, ...) ret (*checked_call)(void *, int dummy, __VA_ARGS__) = (void *)checkasm_checked_call;
 170 #define call_new(...) checked_call(func_new, 0, __VA_ARGS__)
 171 #elif ARCH_AARCH64 && !defined(__APPLE__)
 172 void checkasm_stack_clobber(uint64_t clobber, ...);
 173 void checkasm_checked_call(void *func, ...);
 174 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, int, int, __VA_ARGS__)\
 175                               = (void *)checkasm_checked_call;
 176 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))
 177 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\
 178                                               CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\
 179                       checked_call(func_new, 0, 0, 0, 0, 0, 0, 0, __VA_ARGS__))
 180 #else
 181 #define declare_new(ret, ...)
 182 #define declare_new_float(ret, ...)
 183 #define declare_new_emms(cpu_flags, ret, ...)
 184 /* Call the function */
 185 #define call_new(...) ((func_type *)func_new)(__VA_ARGS__)
 186 #endif
 187
 188 #ifndef declare_new_emms
 189 #define declare_new_emms(cpu_flags, ret, ...) declare_new(ret, __VA_ARGS__)
 190 #endif
 191 #ifndef declare_new_float
 192 #define declare_new_float(ret, ...) declare_new(ret, __VA_ARGS__)
 193 #endif
 194
 195 typedef struct CheckasmPerf {
 196     int sysfd;
 197     uint64_t cycles;
 198     int iterations;
 199 } CheckasmPerf;
 200
 201 #if defined(AV_READ_TIME) || CONFIG_LINUX_PERF
 202
 203 #if CONFIG_LINUX_PERF
 204 #define PERF_START(t) do {                              \
 205     ioctl(sysfd, PERF_EVENT_IOC_RESET, 0);              \
 206     ioctl(sysfd, PERF_EVENT_IOC_ENABLE, 0);             \
 207 } while (0)
 208 #define PERF_STOP(t) do {                               \
 209     ioctl(sysfd, PERF_EVENT_IOC_DISABLE, 0);            \
 210     read(sysfd, &t, sizeof(t));                         \
 211 } while (0)
 212 #else
 213 #define PERF_START(t) t = AV_READ_TIME()
 214 #define PERF_STOP(t)  t = AV_READ_TIME() - t
 215 #endif
 216
 217 /* Benchmark the function */
 218 #define bench_new(...)\
 219     do {\
 220         if (checkasm_bench_func()) {\
 221             struct CheckasmPerf *perf = checkasm_get_perf_context();\
 222             av_unused const int sysfd = perf->sysfd;\
 223             func_type *tfunc = func_new;\
 224             uint64_t tsum = 0;\
 225             int ti, tcount = 0;\
 226             uint64_t t = 0; \
 227             for (ti = 0; ti < BENCH_RUNS; ti++) {\
 228                 PERF_START(t);\
 229                 tfunc(__VA_ARGS__);\
 230                 tfunc(__VA_ARGS__);\
 231                 tfunc(__VA_ARGS__);\
 232                 tfunc(__VA_ARGS__);\
 233                 PERF_STOP(t);\
 234                 if (t*tcount <= tsum*4 && ti > 0) {\
 235                     tsum += t;\
 236                     tcount++;\
 237                 }\
 238             }\
 239             emms_c();\
 240             perf->cycles += t;\
 241             perf->iterations++;\
 242         }\
 243     } while (0)
 244 #else
 245 #define bench_new(...) while(0)
 246 #define PERF_START(t)  while(0)
 247 #define PERF_STOP(t)   while(0)
 248 #endif
 249
 250 #endif /* TESTS_CHECKASM_CHECKASM_H */