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.

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