You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

261 lines
11KB

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