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
23 #include "config.h"
24 #include "config_components.h"
25
26 #if CONFIG_LINUX_PERF
27 # ifndef _GNU_SOURCE
28 # define _GNU_SOURCE // for syscall (performance monitoring API)
29 # endif
30 #endif
31
32 #include <stdarg.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
41
42 #if HAVE_IO_H
43 #include <io.h>
44 #endif
45
46 #if HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
47 #include <windows.h>
48 #define COLOR_RED FOREGROUND_RED
49 #define COLOR_GREEN FOREGROUND_GREEN
50 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
51 #else
54 #define COLOR_YELLOW 3
55 #endif
56
57 #if HAVE_UNISTD_H
58 #include <unistd.h>
59 #endif
60
61 #if !HAVE_ISATTY
63 #endif
64
65 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
67
68 void (*checkasm_checked_call)(
void *
func,
int dummy, ...) = checkasm_checked_call_novfp;
69 #endif
70
71 /* List of tests to invoke */
72 static const struct {
76 #if CONFIG_AVCODEC
77 #if CONFIG_AAC_DECODER
80 #endif
81 #if CONFIG_ALAC_DECODER
83 #endif
84 #if CONFIG_AUDIODSP
86 #endif
87 #if CONFIG_BLOCKDSP
89 #endif
90 #if CONFIG_BSWAPDSP
92 #endif
93 #if CONFIG_DCA_DECODER
95 #endif
96 #if CONFIG_EXR_DECODER
98 #endif
99 #if CONFIG_FLACDSP
101 #endif
102 #if CONFIG_FMTCONVERT
104 #endif
105 #if CONFIG_G722DSP
107 #endif
108 #if CONFIG_H264DSP
110 #endif
111 #if CONFIG_H264PRED
113 #endif
114 #if CONFIG_H264QPEL
116 #endif
117 #if CONFIG_HEVC_DECODER
122 #endif
123 #if CONFIG_HUFFYUV_DECODER
125 #endif
126 #if CONFIG_IDCTDSP
128 #endif
129 #if CONFIG_JPEG2000_DECODER
131 #endif
132 #if CONFIG_HUFFYUVDSP
134 #endif
135 #if CONFIG_LLVIDENCDSP
137 #endif
138 #if CONFIG_ME_CMP
140 #endif
141 #if CONFIG_OPUS_DECODER
143 #endif
144 #if CONFIG_PIXBLOCKDSP
146 #endif
147 #if CONFIG_UTVIDEO_DECODER
149 #endif
150 #if CONFIG_V210_DECODER
152 #endif
153 #if CONFIG_V210_ENCODER
155 #endif
156 #if CONFIG_VC1DSP
158 #endif
159 #if CONFIG_VP8DSP
161 #endif
162 #if CONFIG_VP9_DECODER
164 #endif
165 #if CONFIG_VIDEODSP
167 #endif
168 #endif
169 #if CONFIG_AVFILTER
170 #if CONFIG_AFIR_FILTER
172 #endif
173 #if CONFIG_BLEND_FILTER
175 #endif
176 #if CONFIG_COLORSPACE_FILTER
178 #endif
179 #if CONFIG_EQ_FILTER
181 #endif
182 #if CONFIG_GBLUR_FILTER
184 #endif
185 #if CONFIG_HFLIP_FILTER
187 #endif
188 #if CONFIG_NLMEANS_FILTER
190 #endif
191 #if CONFIG_THRESHOLD_FILTER
193 #endif
194 #endif
195 #if CONFIG_SWSCALE
199 #endif
200 #if CONFIG_AVUTIL
204 #endif
206 };
207
208 /* List of cpu flags to check */
209 static const struct {
214 #if ARCH_AARCH64
217 #elif ARCH_ARM
225 #elif ARCH_PPC
229 #elif ARCH_MIPS
232 #elif ARCH_X86
251 #elif ARCH_LOONGARCH
254 #endif
256 };
257
265
266 /* Binary search tree node */
270 uint8_t
color;
/* 0 = red, 1 = black */
273
274 /* Internal state */
275 static struct {
284
285 /* perf */
288
294
295 /* PRNG state */
297
298 /* float compare support code */
300 {
302 }
303
305 {
307
310
312 // handle -0.0 == +0.0
314 }
315
316 if (llabs((int64_t)x.
i - y.
i) <= max_ulp)
317 return 1;
318
319 return 0;
320 }
321
324 {
326
327 for (
i = 0;
i <
len;
i++) {
329 return 0;
330 }
331 return 1;
332 }
333
335 {
337 if (abs_diff < eps)
338 return 1;
339
340 fprintf(stderr,
"test failed comparing %g with %g (abs diff=%g with EPS=%g)\n",
a,
b, abs_diff, eps);
341
342 return 0;
343 }
344
347 {
349
350 for (
i = 0;
i <
len;
i++) {
352 return 0;
353 }
354 return 1;
355 }
356
358 {
360 }
361
363 unsigned max_ulp,
unsigned len)
364 {
366
367 for (
i = 0;
i <
len;
i++) {
369 return 0;
370 }
371 return 1;
372 }
373
375 {
376 double abs_diff =
fabs(
a -
b);
377
378 return abs_diff < eps;
379 }
380
383 {
385
386 for (
i = 0;
i <
len;
i++) {
388 return 0;
389 }
390 return 1;
391 }
392
393 /* Print colored text to stderr if the terminal supports it */
395 {
398
399 #if HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
400 static HANDLE con;
401 static WORD org_attributes;
402
404 CONSOLE_SCREEN_BUFFER_INFO con_info;
405 con = GetStdHandle(STD_ERROR_HANDLE);
406 if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
407 org_attributes = con_info.wAttributes;
409 } else
411 }
413 SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (
color & 0x0f));
414 #else
416 const char *term = getenv("TERM");
418 }
420 fprintf(stderr,
"\x1b[%d;3%dm", (
color & 0x08) >> 3,
color & 0x07);
421 #endif
422
424 vfprintf(stderr, fmt,
arg);
426
428 #if HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
429 SetConsoleTextAttribute(con, org_attributes);
430 #else
431 fprintf(stderr, "\x1b[0m");
432 #endif
433 }
434 }
435
436 /* Deallocate a tree */
438 {
441 while (v) {
443 free(v);
444 v = next;
445 }
446
450 }
451 }
452
453 /* Allocate a zero-initialized block, clean up and exit on failure */
455 {
456 void *ptr = calloc(1,
size);
457 if (!ptr) {
458 fprintf(stderr, "checkasm: malloc failed\n");
460 exit(1);
461 }
462 return ptr;
463 }
464
465 /* Get the suffix of the specified cpu flag */
467 {
469
472 return cpus[
i].suffix;
473
474 return "c";
475 }
476
478 {
479 return *(
const uint16_t*)
a - *(
const uint16_t*)
b;
480 }
481
482 /* Measure the overhead of the timing code (in decicycles) */
484 {
485 uint16_t nops[10000];
488
489 uint64_t t = 0;
490 for (
i = 0;
i < 10000;
i++) {
494 }
495
496 qsort(nops, 10000,
sizeof(uint16_t),
cmp_nop);
497 for (
i = 2500;
i < 7500;
i++)
499
500 return nop_sum / 500;
501 }
502
503 /* Print benchmark results */
505 {
508
509 /* Only print functions with at least one assembly version */
510 if (
f->versions.cpu ||
f->versions.next) {
512 do {
517 }
518 }
while ((v = v->
next));
519 }
520
522 }
523 }
524
525 /* ASCIIbetical sort except preserving natural order for numbers */
527 {
528 const char *start =
a;
529 int ascii_diff, digit_diff;
530
531 for (; !(ascii_diff = *(
const unsigned char*)
a - *(
const unsigned char*)
b) && *
a;
a++,
b++);
533
535 return digit_diff;
536
537 return ascii_diff;
538 }
539
540 /* Perform a tree rotation in the specified direction and return the new root */
542 {
544 f->child[dir^1] =
r->child[dir];
549 }
550
551 #define is_red(f) ((f) && !(f)->color)
552
553 /* Balance a left-leaning red-black tree at the specified node */
555 {
557
560 f->child[0]->color =
f->child[1]->color = 1;
561 }
562
567 }
568
569 /* Get a node with the specified name, creating it if it doesn't exist */
571 {
573
575 /* Search the tree for a matching node */
579
580 /* Rebalance the tree on the way up if a new node was inserted */
581 if (!
f->versions.func)
583 }
584 } else {
585 /* Allocate and insert a new node into the tree */
586 int name_length = strlen(
name);
588 memcpy(
f->name,
name, name_length + 1);
589 }
590
592 }
593
594 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
596 {
597 int old_cpu_flag =
state.cpu_flag;
598
599 flag |= old_cpu_flag;
603
604 if (!
flag ||
state.cpu_flag != old_cpu_flag) {
606
610 continue;
613 }
614 }
615 }
616
617 /* Print the name of the current CPU flag, but only do it once */
619 {
620 if (
state.cpu_flag_name) {
623 }
624 }
625
626 #if CONFIG_LINUX_PERF
627 static int bench_init_linux(void)
628 {
629 struct perf_event_attr attr = {
630 .type = PERF_TYPE_HARDWARE,
631 .size = sizeof(struct perf_event_attr),
632 .
config = PERF_COUNT_HW_CPU_CYCLES,
633 .disabled = 1, // start counting only on demand
634 .exclude_kernel = 1,
635 .exclude_hv = 1,
636 };
637
638 printf(
"benchmarking with Linux Perf Monitoring API\n");
639
640 state.sysfd = syscall(__NR_perf_event_open, &attr, 0, -1, -1, 0);
641 if (
state.sysfd == -1) {
642 perror("syscall");
643 return -1;
644 }
645 return 0;
646 }
647 #elif CONFIG_MACOS_KPERF
648 static int bench_init_kperf(void)
649 {
651 return 0;
652 }
653 #else
655 {
656 #ifdef AV_READ_TIME
657 printf(
"benchmarking with native FFmpeg timers\n");
658 return 0;
659 #else
660 fprintf(stderr, "checkasm: --bench is not supported on your system\n");
661 return -1;
662 #endif
663 }
664 #endif
665
667 {
668 #if CONFIG_LINUX_PERF
669 int ret = bench_init_linux();
670 #elif CONFIG_MACOS_KPERF
671 int ret = bench_init_kperf();
672 #else
674 #endif
677
680 return 0;
681 }
682
684 {
685 #if CONFIG_LINUX_PERF
688 #endif
689 }
690
691 int main(
int argc,
char *argv[])
692 {
695
696 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
698 checkasm_checked_call = checkasm_checked_call_vfp;
699 #endif
700
702 fprintf(stderr, "checkasm: no tests to perform\n");
703 return 0;
704 }
705
706 while (argc > 1) {
707 if (!strncmp(argv[1], "--bench", 7)) {
709 return 1;
710 if (argv[1][7] == '=') {
711 state.bench_pattern = argv[1] + 8;
712 state.bench_pattern_len = strlen(
state.bench_pattern);
713 } else
714 state.bench_pattern =
"";
715 } else if (!strncmp(argv[1], "--test=", 7)) {
716 state.test_name = argv[1] + 7;
717 } else if (!strcmp(argv[1], "--verbose") || !strcmp(argv[1], "-v")) {
719 } else {
721 }
722
723 argc--;
724 argv++;
725 }
726
727 fprintf(stderr,
"checkasm: using random seed %u\n",
seed);
729
733
734 if (
state.num_failed) {
735 fprintf(stderr,
"checkasm: %d of %d tests have failed\n",
state.num_failed,
state.num_checked);
737 } else {
738 fprintf(stderr,
"checkasm: all %d tests passed\n",
state.num_checked);
739 if (
state.bench_pattern) {
741 }
742 }
743
747 }
748
749 /* Decide whether or not the specified function needs to be tested and
750 * allocate/initialize data structures if needed. Returns a pointer to a
751 * reference function if the function should be tested, otherwise NULL */
753 {
754 char name_buf[256];
757 int name_length;
759
763
764 if (!
func || name_length <= 0 || name_length >=
sizeof(name_buf))
766
768 state.funcs->color = 1;
769 v = &
state.current_func->versions;
770
773 do {
774 /* Only test functions that haven't already been tested */
777
780
781 prev = v;
782 }
while ((v = v->
next));
783
785 }
786
790 state.current_func_ver = v;
791
794
796 }
797
798 /* Decide whether or not the current function needs to be benchmarked */
800 {
801 return !
state.num_failed &&
state.bench_pattern &&
802 !strncmp(
state.current_func->name,
state.bench_pattern,
state.bench_pattern_len);
803 }
804
805 /* Indicate that the current test has failed */
807 {
808 if (
state.current_func_ver->cpu &&
state.current_func_ver->ok) {
810
814 vfprintf(stderr, msg,
arg);
816 fprintf(stderr, ")\n");
817
818 state.current_func_ver->ok = 0;
820 }
821 }
822
823 /* Get the benchmark context of the current function */
825 {
827 memset(perf, 0, sizeof(*perf));
829 return perf;
830 }
831
832 /* Print the outcome of all tests performed since the last time this function was called */
834 {
835 static int prev_checked, prev_failed, max_length;
836
837 if (
state.num_checked > prev_checked) {
838 int pad_length = max_length + 4;
840
842 pad_length -= fprintf(stderr,
" - %s.",
state.current_test_name);
844 pad_length -= vfprintf(stderr,
name,
arg);
846 fprintf(stderr,
"%*c",
FFMAX(pad_length, 0) + 2,
'[');
847
848 if (
state.num_failed == prev_failed)
850 else
852 fprintf(stderr, "]\n");
853
854 prev_checked =
state.num_checked;
855 prev_failed =
state.num_failed;
856 }
else if (!
state.cpu_flag) {
857 /* Calculate the amount of padding required to make the output vertically aligned */
858 int length = strlen(
state.current_test_name);
860
864
865 if (length > max_length)
866 max_length = length;
867 }
868 }
869
870 #define DEF_CHECKASM_CHECK_FUNC(type, fmt) \
871 int checkasm_check_##type(const char *const file, const int line, \
872 const type *buf1, ptrdiff_t stride1, \
873 const type *buf2, ptrdiff_t stride2, \
874 const int w, int h, const char *const name) \
875 { \
876 int y = 0; \
877 stride1 /= sizeof(*buf1); \
878 stride2 /= sizeof(*buf2); \
879 for (y = 0; y < h; y++) \
880 if (memcmp(&buf1[y*stride1], &buf2[y*stride2], w*sizeof(*buf1))) \
881 break; \
882 if (y == h) \
883 return 0; \
884 checkasm_fail_func("%s:%d", file, line); \
885 if (!state.verbose) \
886 return 1; \
887 fprintf(stderr, "%s:\n", name); \
888 while (h--) { \
889 for (int x = 0; x < w; x++) \
890 fprintf(stderr, " " fmt, buf1[x]); \
891 fprintf(stderr, " "); \
892 for (int x = 0; x < w; x++) \
893 fprintf(stderr, " " fmt, buf2[x]); \
894 fprintf(stderr, " "); \
895 for (int x = 0; x < w; x++) \
896 fprintf(stderr, "%c", buf1[x] != buf2[x] ? 'x' : '.'); \
897 buf1 += stride1; \
898 buf2 += stride2; \
899 fprintf(stderr, "\n"); \
900 } \
901 return 1; \
902 }
903