FFmpeg: tests/checkasm/checkasm.h Source File

FFmpeg

[フレーム]

checkasm.h

Go to the documentation of this file.

1 /*

2 * Assembly testing and benchmarking tool

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 */

23 #ifndef TESTS_CHECKASM_CHECKASM_H

24 #define TESTS_CHECKASM_CHECKASM_H

26 #include <stdint.h>

27 #include "config.h"

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 #elif CONFIG_MACOS_KPERF

35 #include "libavutil/macos_kperf.h"

36 #endif

38 #include "libavutil/avstring.h"

39 #include "libavutil/cpu.h"

40 #include "libavutil/internal.h"

41 #include "libavutil/lfg.h"

42 #include "libavutil/timer.h"

44 void checkasm_check_aacpsdsp(void);

45 void checkasm_check_afir(void);

46 void checkasm_check_alacdsp(void);

47 void checkasm_check_audiodsp(void);

48 void checkasm_check_av_tx(void);

49 void checkasm_check_blend(void);

50 void checkasm_check_blockdsp(void);

51 void checkasm_check_bswapdsp(void);

52 void checkasm_check_colorspace(void);

53 void checkasm_check_exrdsp(void);

54 void checkasm_check_fixed_dsp(void);

55 void checkasm_check_flacdsp(void);

56 void checkasm_check_float_dsp(void);

57 void checkasm_check_fmtconvert(void);

58 void checkasm_check_g722dsp(void);

59 void checkasm_check_h264dsp(void);

60 void checkasm_check_h264pred(void);

61 void checkasm_check_h264qpel(void);

62 void checkasm_check_hevc_add_res(void);

63 void checkasm_check_hevc_idct(void);

64 void checkasm_check_hevc_pel(void);

65 void checkasm_check_hevc_sao(void);

66 void checkasm_check_huffyuvdsp(void);

67 void checkasm_check_idctdsp(void);

68 void checkasm_check_jpeg2000dsp(void);

69 void checkasm_check_llviddsp(void);

70 void checkasm_check_llviddspenc(void);

71 void checkasm_check_lpc(void);

72 void checkasm_check_motion(void);

73 void checkasm_check_nlmeans(void);

74 void checkasm_check_opusdsp(void);

75 void checkasm_check_pixblockdsp(void);

76 void checkasm_check_sbrdsp(void);

77 void checkasm_check_synth_filter(void);

78 void checkasm_check_sw_gbrp(void);

79 void checkasm_check_sw_rgb(void);

80 void checkasm_check_sw_scale(void);

81 void checkasm_check_utvideodsp(void);

82 void checkasm_check_v210dec(void);

83 void checkasm_check_v210enc(void);

84 void checkasm_check_vc1dsp(void);

85 void checkasm_check_vf_eq(void);

86 void checkasm_check_vf_gblur(void);

87 void checkasm_check_vf_hflip(void);

88 void checkasm_check_vf_threshold(void);

89 void checkasm_check_vf_sobel(void);

90 void checkasm_check_vp8dsp(void);

91 void checkasm_check_vp9dsp(void);

92 void checkasm_check_videodsp(void);

93 void checkasm_check_vorbisdsp(void);

95 struct CheckasmPerf;

97 void *checkasm_check_func(void *func, const char *name, ...) av_printf_format(2, 3);

98 int checkasm_bench_func(void);

99 void checkasm_fail_func(const char *msg, ...) av_printf_format(1, 2);

100 struct CheckasmPerf *checkasm_get_perf_context(void);

101 void checkasm_report(const char *name, ...) av_printf_format(1, 2);

102

103 /* float compare utilities */

104 int float_near_ulp(float a, float b, unsigned max_ulp);

105 int float_near_abs_eps(float a, float b, float eps);

106 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp);

107 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,

108 unsigned len);

109 int float_near_abs_eps_array(const float *a, const float *b, float eps,

110 unsigned len);

111 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,

112 unsigned max_ulp, unsigned len);

113 int double_near_abs_eps(double a, double b, double eps);

114 int double_near_abs_eps_array(const double *a, const double *b, double eps,

115 unsigned len);

116

117 extern AVLFG checkasm_lfg;

118 #define rnd() av_lfg_get(&checkasm_lfg)

119

120 static av_unused void *func_ref, *func_new;

121

122 #define BENCH_RUNS 1000 /* Trade-off between accuracy and speed */

123

124 /* Decide whether or not the specified function needs to be tested */

125 #define check_func(func, ...) (func_ref = checkasm_check_func((func_new = func), __VA_ARGS__))

126

127 /* Declare the function prototype. The first argument is the return value, the remaining

128 * arguments are the function parameters. Naming parameters is optional. */

129 #define declare_func(ret, ...) declare_new(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)

130 #define declare_func_float(ret, ...) declare_new_float(ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)

131 #define declare_func_emms(cpu_flags, ret, ...) declare_new_emms(cpu_flags, ret, __VA_ARGS__) typedef ret func_type(__VA_ARGS__)

132

133 /* Indicate that the current test has failed */

134 #define fail() checkasm_fail_func("%s:%d", av_basename(__FILE__), __LINE__)

135

136 /* Print the test outcome */

137 #define report checkasm_report

138

139 /* Call the reference function */

140 #define call_ref(...) ((func_type *)func_ref)(__VA_ARGS__)

141

142 #if ARCH_X86 && HAVE_X86ASM

143 /* Verifies that clobbered callee-saved registers are properly saved and restored

144 * and that either no MMX registers are touched or emms is issued */

145 void checkasm_checked_call(void *func, ...);

146 /* Verifies that clobbered callee-saved registers are properly saved and restored

147 * and issues emms for asm functions which are not required to do so */

148 void checkasm_checked_call_emms(void *func, ...);

149 /* Verifies that clobbered callee-saved registers are properly saved and restored

150 * but doesn't issue emms. Meant for dsp functions returning float or double */

151 void checkasm_checked_call_float(void *func, ...);

152

153 #if ARCH_X86_64

154 /* Evil hack: detect incorrect assumptions that 32-bit ints are zero-extended to 64-bit.

155 * This is done by clobbering the stack with junk around the stack pointer and calling the

156 * assembly function through checked_call() with added dummy arguments which forces all

157 * real arguments to be passed on the stack and not in registers. For 32-bit arguments the

158 * upper half of the 64-bit register locations on the stack will now contain junk which will

159 * cause misbehaving functions to either produce incorrect output or segfault. Note that

160 * even though this works extremely well in practice, it's technically not guaranteed

161 * and false negatives is theoretically possible, but there can never be any false positives.

162 */

163 void checkasm_stack_clobber(uint64_t clobber, ...);

164 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\

165 = (void *)checkasm_checked_call;

166 #define declare_new_float(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__)\

167 = (void *)checkasm_checked_call_float;

168 #define declare_new_emms(cpu_flags, ret, ...) \

169 ret (*checked_call)(void *, int, int, int, int, int, __VA_ARGS__) = \

170 ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms : \

171 (void *)checkasm_checked_call;

172 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))

173 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\

174 CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\

175 checked_call(func_new, 0, 0, 0, 0, 0, __VA_ARGS__))

176 #elif ARCH_X86_32

177 #define declare_new(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call;

178 #define declare_new_float(ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = (void *)checkasm_checked_call_float;

179 #define declare_new_emms(cpu_flags, ret, ...) ret (*checked_call)(void *, __VA_ARGS__) = \

180 ((cpu_flags) & av_get_cpu_flags()) ? (void *)checkasm_checked_call_emms : \

181 (void *)checkasm_checked_call;

182 #define call_new(...) checked_call(func_new, __VA_ARGS__)

183 #endif

184 #elif ARCH_ARM && HAVE_ARMV5TE_EXTERNAL

185 /* Use a dummy argument, to offset the real parameters by 2, not only 1.

186 * This makes sure that potential 8-byte-alignment of parameters is kept the same

187 * even when the extra parameters have been removed. */

188 void checkasm_checked_call_vfp(void *func, int dummy, ...);

189 void checkasm_checked_call_novfp(void *func, int dummy, ...);

190 extern void (*checkasm_checked_call)(void *func, int dummy, ...);

191 #define declare_new(ret, ...) ret (*checked_call)(void *, int dummy, __VA_ARGS__, \

192 int, int, int, int, int, int, int, int, \

193 int, int, int, int, int, int, int) = (void *)checkasm_checked_call;

194 #define call_new(...) checked_call(func_new, 0, __VA_ARGS__, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0, 0, 0, 0)

195 #elif ARCH_AARCH64 && !defined(__APPLE__)

196 void checkasm_stack_clobber(uint64_t clobber, ...);

197 void checkasm_checked_call(void *func, ...);

198 #define declare_new(ret, ...) ret (*checked_call)(void *, int, int, int, int, int, int, int, __VA_ARGS__,\

199 int, int, int, int, int, int, int, int,\

200 int, int, int, int, int, int, int)\

201 = (void *)checkasm_checked_call;

202 #define CLOB (UINT64_C(0xdeadbeefdeadbeef))

203 #define call_new(...) (checkasm_stack_clobber(CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,\

204 CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB,CLOB),\

205 checked_call(func_new, 0, 0, 0, 0, 0, 0, 0, __VA_ARGS__,\

206 7, 6, 5, 4, 3, 2, 1, 0, 0, 0, 0, 0, 0, 0, 0))

207 #elif ARCH_RISCV

208 void checkasm_set_function(void *);

209 void *checkasm_get_wrapper(void);

210

211 #if (__riscv_xlen == 64) && defined (__riscv_d)

212 #define declare_new(ret, ...) \

213 ret (*checked_call)(__VA_ARGS__) = checkasm_get_wrapper();

214 #define call_new(...) \

215 (checkasm_set_function(func_new), checked_call(__VA_ARGS__))

216 #endif

217 #else

218 #define declare_new(ret, ...)

219 #define declare_new_float(ret, ...)

220 #define declare_new_emms(cpu_flags, ret, ...)

221 /* Call the function */

222 #define call_new(...) ((func_type *)func_new)(__VA_ARGS__)

223 #endif

224

225 #ifndef declare_new_emms

226 #define declare_new_emms(cpu_flags, ret, ...) declare_new(ret, __VA_ARGS__)

227 #endif

228 #ifndef declare_new_float

229 #define declare_new_float(ret, ...) declare_new(ret, __VA_ARGS__)

230 #endif

231

232 typedef struct CheckasmPerf {

233 int sysfd;

234 uint64_t cycles;

235 int iterations;

236 } CheckasmPerf;

237

238 #if defined(AV_READ_TIME) || CONFIG_LINUX_PERF || CONFIG_MACOS_KPERF

239

240 #if CONFIG_LINUX_PERF

241 #define PERF_START(t) do { \

242 ioctl(sysfd, PERF_EVENT_IOC_RESET, 0); \

243 ioctl(sysfd, PERF_EVENT_IOC_ENABLE, 0); \

244 } while (0)

245 #define PERF_STOP(t) do { \

246 int ret; \

247 ioctl(sysfd, PERF_EVENT_IOC_DISABLE, 0); \

248 ret = read(sysfd, &t, sizeof(t)); \

249 (void)ret; \

250 } while (0)

251 #elif CONFIG_MACOS_KPERF

252 #define PERF_START(t) t = ff_kperf_cycles()

253 #define PERF_STOP(t) t = ff_kperf_cycles() - t

254 #else

255 #define PERF_START(t) t = AV_READ_TIME()

256 #define PERF_STOP(t) t = AV_READ_TIME() - t

257 #endif

258

259 /* Benchmark the function */

260 #define bench_new(...)\

261 do {\

262 if (checkasm_bench_func()) {\

263 struct CheckasmPerf *perf = checkasm_get_perf_context();\

264 av_unused const int sysfd = perf->sysfd;\

265 func_type *tfunc = func_new;\

266 uint64_t tsum = 0;\

267 int ti, tcount = 0;\

268 uint64_t t = 0; \

269 for (ti = 0; ti < BENCH_RUNS; ti++) {\

270 PERF_START(t);\

271 tfunc(__VA_ARGS__);\

272 tfunc(__VA_ARGS__);\

273 tfunc(__VA_ARGS__);\

274 tfunc(__VA_ARGS__);\

275 PERF_STOP(t);\

276 if (t*tcount <= tsum*4 && ti > 0) {\

277 tsum += t;\

278 tcount++;\

279 }\

280 }\

281 emms_c();\

282 perf->cycles += t;\

283 perf->iterations++;\

284 }\

285 } while (0)

286 #else

287 #define bench_new(...) while(0)

288 #define PERF_START(t) while(0)

289 #define PERF_STOP(t) while(0)

290 #endif

291

292 #define DECL_CHECKASM_CHECK_FUNC(type) \

293 int checkasm_check_##type(const char *const file, const int line, \

294 const type *const buf1, const ptrdiff_t stride1, \

295 const type *const buf2, const ptrdiff_t stride2, \

296 const int w, const int h, const char *const name)

297

298 DECL_CHECKASM_CHECK_FUNC(uint8_t);

299 DECL_CHECKASM_CHECK_FUNC(uint16_t);

300 DECL_CHECKASM_CHECK_FUNC(uint32_t);

301 DECL_CHECKASM_CHECK_FUNC(int16_t);

302 DECL_CHECKASM_CHECK_FUNC(int32_t);

303

304 #define PASTE(a,b) a ## b

305 #define CONCAT(a,b) PASTE(a,b)

306

307 #define checkasm_check(prefix, ...) CONCAT(checkasm_check_, prefix)(__FILE__, __LINE__, __VA_ARGS__)

308

309 #endif /* TESTS_CHECKASM_CHECKASM_H */

checkasm_check_nlmeans

void checkasm_check_nlmeans(void)

Definition: vf_nlmeans.c:31

func

int(* func)(AVBPrint *dst, const char *in, const char *arg)

Definition: jacosubdec.c:68

checkasm_lfg

AVLFG checkasm_lfg

Definition: checkasm.c:314

checkasm_check_sw_gbrp

void checkasm_check_sw_gbrp(void)

Definition: sw_gbrp.c:401

checkasm_check_vp8dsp

void checkasm_check_vp8dsp(void)

Definition: vp8dsp.c:508

name

it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option name

Definition: writing_filters.txt:88

checkasm_check_videodsp

void checkasm_check_videodsp(void)

Definition: videodsp.c:81

checkasm_check_vf_eq

void checkasm_check_vf_eq(void)

Definition: vf_eq.c:76

checkasm_check_v210dec

void checkasm_check_v210dec(void)

Definition: v210dec.c:47

av_unused

#define av_unused

Definition: attributes.h:131

checkasm_check_hevc_idct

void checkasm_check_hevc_idct(void)

Definition: hevc_idct.c:87

checkasm_check_sw_scale

void checkasm_check_sw_scale(void)

Definition: sw_scale.c:361

checkasm_bench_func

void int checkasm_bench_func(void)

Definition: checkasm.c:817

#define b

Definition: input.c:41

func_ref

static av_unused void * func_ref

Definition: checkasm.h:120

checkasm_check_aacpsdsp

void checkasm_check_aacpsdsp(void)

Definition: aacpsdsp.c:234

checkasm_check_func

void * checkasm_check_func(void *func, const char *name,...) av_printf_format(2

CheckasmPerf::sysfd

int sysfd

Definition: checkasm.h:233

checkasm_check_alacdsp

void checkasm_check_alacdsp(void)

Definition: alacdsp.c:116

checkasm_check_llviddspenc

void checkasm_check_llviddspenc(void)

Definition: llviddspenc.c:104

double_near_abs_eps

int double_near_abs_eps(double a, double b, double eps)

Definition: checkasm.c:392

checkasm_check_h264dsp

void checkasm_check_h264dsp(void)

Definition: h264dsp.c:443

checkasm_check_motion

void checkasm_check_motion(void)

Definition: motion.c:150

func_new

static av_unused void * func_new

Definition: checkasm.h:120

float_near_abs_eps_ulp

int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)

Definition: checkasm.c:375

CheckasmPerf

Definition: checkasm.h:232

dummy

int dummy

Definition: motion.c:65

checkasm_check_vp9dsp

void checkasm_check_vp9dsp(void)

Definition: vp9dsp.c:626

checkasm_check_vf_threshold

void checkasm_check_vf_threshold(void)

Definition: vf_threshold.c:79

checkasm_check_vf_gblur

void checkasm_check_vf_gblur(void)

Definition: vf_gblur.c:81

checkasm_report

void checkasm_report(const char *name,...) av_printf_format(1

checkasm_check_float_dsp

void checkasm_check_float_dsp(void)

Definition: float_dsp.c:282

double_near_abs_eps_array

int double_near_abs_eps_array(const double *a, const double *b, double eps, unsigned len)

Definition: checkasm.c:399

checkasm_check_pixblockdsp

void checkasm_check_pixblockdsp(void)

Definition: pixblockdsp.c:82

checkasm_check_bswapdsp

void checkasm_check_bswapdsp(void)

Definition: bswapdsp.c:60

lfg.h

checkasm_check_sw_rgb

void checkasm_check_sw_rgb(void)

Definition: sw_rgb.c:182

checkasm_check_hevc_sao

void checkasm_check_hevc_sao(void)

Definition: hevc_sao.c:143

checkasm_check_hevc_pel

void checkasm_check_hevc_pel(void)

Definition: hevc_pel.c:534

CheckasmPerf::iterations

int iterations

Definition: checkasm.h:235

checkasm_check_fmtconvert

void checkasm_check_fmtconvert(void)

Definition: fmtconvert.c:46

macos_kperf.h

float_near_abs_eps_array

int float_near_abs_eps_array(const float *a, const float *b, float eps, unsigned len)

Definition: checkasm.c:363

av_printf_format

#define av_printf_format(fmtpos, attrpos)

Definition: attributes.h:161

float_near_abs_eps_array_ulp

int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps, unsigned max_ulp, unsigned len)

Definition: checkasm.c:380

timer.h

checkasm_check_vorbisdsp

void checkasm_check_vorbisdsp(void)

Definition: vorbisdsp.c:78

checkasm_check_vc1dsp

void checkasm_check_vc1dsp(void)

Definition: vc1dsp.c:441

AVLFG

Context structure for the Lagged Fibonacci PRNG.

Definition: lfg.h:33

cpu.h

checkasm_check_llviddsp

void checkasm_check_llviddsp(void)

Definition: llviddsp.c:195

float_near_ulp

void int float_near_ulp(float a, float b, unsigned max_ulp)

Definition: checkasm.c:322

checkasm_check_h264pred

void checkasm_check_h264pred(void)

Definition: h264pred.c:233

The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a

Definition: undefined.txt:41

checkasm_fail_func

void checkasm_fail_func(const char *msg,...) av_printf_format(1

checkasm_check_huffyuvdsp

void checkasm_check_huffyuvdsp(void)

Definition: huffyuvdsp.c:67

CheckasmPerf::cycles

uint64_t cycles

Definition: checkasm.h:234

float_near_abs_eps

int float_near_abs_eps(float a, float b, float eps)

Definition: checkasm.c:352