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.

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