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.

208 lines
9.4KB

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