git.sesse.net Git - ffmpeg/blob - tests/checkasm/checkasm.c

   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 <stdarg.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include "checkasm.h"
  28 #include "libavutil/common.h"
  29 #include "libavutil/cpu.h"
  30 #include "libavutil/intfloat.h"
  31 #include "libavutil/random_seed.h"
  32
  33 #if HAVE_IO_H
  34 #include <io.h>
  35 #endif
  36
  37 #if HAVE_SETCONSOLETEXTATTRIBUTE
  38 #include <windows.h>
  39 #define COLOR_RED    FOREGROUND_RED
  40 #define COLOR_GREEN  FOREGROUND_GREEN
  41 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
  42 #else
  43 #define COLOR_RED    1
  44 #define COLOR_GREEN  2
  45 #define COLOR_YELLOW 3
  46 #endif
  47
  48 #if HAVE_UNISTD_H
  49 #include <unistd.h>
  50 #endif
  51
  52 #if !HAVE_ISATTY
  53 #define isatty(fd) 1
  54 #endif
  55
  56 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
  57 #include "libavutil/arm/cpu.h"
  58
  59 void (*checkasm_checked_call)(void *func, int dummy, ...) = checkasm_checked_call_novfp;
  60 #endif
  61
  62 /* List of tests to invoke */
  63 static const struct {
  64     const char *name;
  65     void (*func)(void);
  66 } tests[] = {
  67 #if CONFIG_AVCODEC
  68     #if CONFIG_ALAC_DECODER
  69         { "alacdsp", checkasm_check_alacdsp },
  70     #endif
  71     #if CONFIG_BSWAPDSP
  72         { "bswapdsp", checkasm_check_bswapdsp },
  73     #endif
  74     #if CONFIG_DCA_DECODER
  75         { "dcadsp", checkasm_check_dcadsp },
  76         { "synth_filter", checkasm_check_synth_filter },
  77     #endif
  78     #if CONFIG_FLACDSP
  79         { "flacdsp", checkasm_check_flacdsp },
  80     #endif
  81     #if CONFIG_FMTCONVERT
  82         { "fmtconvert", checkasm_check_fmtconvert },
  83     #endif
  84     #if CONFIG_H264PRED
  85         { "h264pred", checkasm_check_h264pred },
  86     #endif
  87     #if CONFIG_H264QPEL
  88         { "h264qpel", checkasm_check_h264qpel },
  89     #endif
  90     #if CONFIG_JPEG2000_DECODER
  91         { "jpeg2000dsp", checkasm_check_jpeg2000dsp },
  92     #endif
  93     #if CONFIG_PIXBLOCKDSP
  94         { "pixblockdsp", checkasm_check_pixblockdsp },
  95     #endif
  96     #if CONFIG_V210_ENCODER
  97         { "v210enc", checkasm_check_v210enc },
  98     #endif
  99     #if CONFIG_VP9_DECODER
 100         { "vp9dsp", checkasm_check_vp9dsp },
 101     #endif
 102     #if CONFIG_VIDEODSP
 103         { "videodsp", checkasm_check_videodsp },
 104     #endif
 105 #endif
 106     { NULL }
 107 };
 108
 109 /* List of cpu flags to check */
 110 static const struct {
 111     const char *name;
 112     const char *suffix;
 113     int flag;
 114 } cpus[] = {
 115 #if   ARCH_AARCH64
 116     { "ARMV8",    "armv8",    AV_CPU_FLAG_ARMV8 },
 117     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
 118 #elif ARCH_ARM
 119     { "ARMV5TE",  "armv5te",  AV_CPU_FLAG_ARMV5TE },
 120     { "ARMV6",    "armv6",    AV_CPU_FLAG_ARMV6 },
 121     { "ARMV6T2",  "armv6t2",  AV_CPU_FLAG_ARMV6T2 },
 122     { "VFP",      "vfp",      AV_CPU_FLAG_VFP },
 123     { "VFP_VM",   "vfp_vm",   AV_CPU_FLAG_VFP_VM },
 124     { "VFPV3",    "vfp3",     AV_CPU_FLAG_VFPV3 },
 125     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
 126 #elif ARCH_PPC
 127     { "ALTIVEC",  "altivec",  AV_CPU_FLAG_ALTIVEC },
 128     { "VSX",      "vsx",      AV_CPU_FLAG_VSX },
 129     { "POWER8",   "power8",   AV_CPU_FLAG_POWER8 },
 130 #elif ARCH_X86
 131     { "MMX",      "mmx",      AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
 132     { "MMXEXT",   "mmxext",   AV_CPU_FLAG_MMXEXT },
 133     { "3DNOW",    "3dnow",    AV_CPU_FLAG_3DNOW },
 134     { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
 135     { "SSE",      "sse",      AV_CPU_FLAG_SSE },
 136     { "SSE2",     "sse2",     AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
 137     { "SSE3",     "sse3",     AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
 138     { "SSSE3",    "ssse3",    AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
 139     { "SSE4.1",   "sse4",     AV_CPU_FLAG_SSE4 },
 140     { "SSE4.2",   "sse42",    AV_CPU_FLAG_SSE42 },
 141     { "AES-NI",   "aesni",    AV_CPU_FLAG_AESNI },
 142     { "AVX",      "avx",      AV_CPU_FLAG_AVX },
 143     { "XOP",      "xop",      AV_CPU_FLAG_XOP },
 144     { "FMA3",     "fma3",     AV_CPU_FLAG_FMA3 },
 145     { "FMA4",     "fma4",     AV_CPU_FLAG_FMA4 },
 146     { "AVX2",     "avx2",     AV_CPU_FLAG_AVX2 },
 147 #endif
 148     { NULL }
 149 };
 150
 151 typedef struct CheckasmFuncVersion {
 152     struct CheckasmFuncVersion *next;
 153     void *func;
 154     int ok;
 155     int cpu;
 156     int iterations;
 157     uint64_t cycles;
 158 } CheckasmFuncVersion;
 159
 160 /* Binary search tree node */
 161 typedef struct CheckasmFunc {
 162     struct CheckasmFunc *child[2];
 163     CheckasmFuncVersion versions;
 164     uint8_t color; /* 0 = red, 1 = black */
 165     char name[1];
 166 } CheckasmFunc;
 167
 168 /* Internal state */
 169 static struct {
 170     CheckasmFunc *funcs;
 171     CheckasmFunc *current_func;
 172     CheckasmFuncVersion *current_func_ver;
 173     const char *current_test_name;
 174     const char *bench_pattern;
 175     int bench_pattern_len;
 176     int num_checked;
 177     int num_failed;
 178     int nop_time;
 179     int cpu_flag;
 180     const char *cpu_flag_name;
 181 } state;
 182
 183 /* PRNG state */
 184 AVLFG checkasm_lfg;
 185
 186 /* float compare support code */
 187 static int is_negative(union av_intfloat32 u)
 188 {
 189     return u.i >> 31;
 190 }
 191
 192 int float_near_ulp(float a, float b, unsigned max_ulp)
 193 {
 194     union av_intfloat32 x, y;
 195
 196     x.f = a;
 197     y.f = b;
 198
 199     if (is_negative(x) != is_negative(y)) {
 200         // handle -0.0 == +0.0
 201         return a == b;
 202     }
 203
 204     if (abs(x.i - y.i) <= max_ulp)
 205         return 1;
 206
 207     return 0;
 208 }
 209
 210 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
 211                          unsigned len)
 212 {
 213     unsigned i;
 214
 215     for (i = 0; i < len; i++) {
 216         if (!float_near_ulp(a[i], b[i], max_ulp))
 217             return 0;
 218     }
 219     return 1;
 220 }
 221
 222 int float_near_abs_eps(float a, float b, float eps)
 223 {
 224     float abs_diff = fabsf(a - b);
 225
 226     return abs_diff < eps;
 227 }
 228
 229 int float_near_abs_eps_array(const float *a, const float *b, float eps,
 230                          unsigned len)
 231 {
 232     unsigned i;
 233
 234     for (i = 0; i < len; i++) {
 235         if (!float_near_abs_eps(a[i], b[i], eps))
 236             return 0;
 237     }
 238     return 1;
 239 }
 240
 241 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
 242 {
 243     return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
 244 }
 245
 246 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
 247                          unsigned max_ulp, unsigned len)
 248 {
 249     unsigned i;
 250
 251     for (i = 0; i < len; i++) {
 252         if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
 253             return 0;
 254     }
 255     return 1;
 256 }
 257
 258 /* Print colored text to stderr if the terminal supports it */
 259 static void color_printf(int color, const char *fmt, ...)
 260 {
 261     static int use_color = -1;
 262     va_list arg;
 263
 264 #if HAVE_SETCONSOLETEXTATTRIBUTE
 265     static HANDLE con;
 266     static WORD org_attributes;
 267
 268     if (use_color < 0) {
 269         CONSOLE_SCREEN_BUFFER_INFO con_info;
 270         con = GetStdHandle(STD_ERROR_HANDLE);
 271         if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
 272             org_attributes = con_info.wAttributes;
 273             use_color = 1;
 274         } else
 275             use_color = 0;
 276     }
 277     if (use_color)
 278         SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
 279 #else
 280     if (use_color < 0) {
 281         const char *term = getenv("TERM");
 282         use_color = term && strcmp(term, "dumb") && isatty(2);
 283     }
 284     if (use_color)
 285         fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
 286 #endif
 287
 288     va_start(arg, fmt);
 289     vfprintf(stderr, fmt, arg);
 290     va_end(arg);
 291
 292     if (use_color) {
 293 #if HAVE_SETCONSOLETEXTATTRIBUTE
 294         SetConsoleTextAttribute(con, org_attributes);
 295 #else
 296         fprintf(stderr, "\x1b[0m");
 297 #endif
 298     }
 299 }
 300
 301 /* Deallocate a tree */
 302 static void destroy_func_tree(CheckasmFunc *f)
 303 {
 304     if (f) {
 305         CheckasmFuncVersion *v = f->versions.next;
 306         while (v) {
 307             CheckasmFuncVersion *next = v->next;
 308             free(v);
 309             v = next;
 310         }
 311
 312         destroy_func_tree(f->child[0]);
 313         destroy_func_tree(f->child[1]);
 314         free(f);
 315     }
 316 }
 317
 318 /* Allocate a zero-initialized block, clean up and exit on failure */
 319 static void *checkasm_malloc(size_t size)
 320 {
 321     void *ptr = calloc(1, size);
 322     if (!ptr) {
 323         fprintf(stderr, "checkasm: malloc failed\n");
 324         destroy_func_tree(state.funcs);
 325         exit(1);
 326     }
 327     return ptr;
 328 }
 329
 330 /* Get the suffix of the specified cpu flag */
 331 static const char *cpu_suffix(int cpu)
 332 {
 333     int i = FF_ARRAY_ELEMS(cpus);
 334
 335     while (--i >= 0)
 336         if (cpu & cpus[i].flag)
 337             return cpus[i].suffix;
 338
 339     return "c";
 340 }
 341
 342 #ifdef AV_READ_TIME
 343 static int cmp_nop(const void *a, const void *b)
 344 {
 345     return *(const uint16_t*)a - *(const uint16_t*)b;
 346 }
 347
 348 /* Measure the overhead of the timing code (in decicycles) */
 349 static int measure_nop_time(void)
 350 {
 351     uint16_t nops[10000];
 352     int i, nop_sum = 0;
 353
 354     for (i = 0; i < 10000; i++) {
 355         uint64_t t = AV_READ_TIME();
 356         nops[i] = AV_READ_TIME() - t;
 357     }
 358
 359     qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
 360     for (i = 2500; i < 7500; i++)
 361         nop_sum += nops[i];
 362
 363     return nop_sum / 500;
 364 }
 365
 366 /* Print benchmark results */
 367 static void print_benchs(CheckasmFunc *f)
 368 {
 369     if (f) {
 370         print_benchs(f->child[0]);
 371
 372         /* Only print functions with at least one assembly version */
 373         if (f->versions.cpu || f->versions.next) {
 374             CheckasmFuncVersion *v = &f->versions;
 375             do {
 376                 if (v->iterations) {
 377                     int decicycles = (10*v->cycles/v->iterations - state.nop_time) / 4;
 378                     printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
 379                 }
 380             } while ((v = v->next));
 381         }
 382
 383         print_benchs(f->child[1]);
 384     }
 385 }
 386 #endif
 387
 388 /* ASCIIbetical sort except preserving natural order for numbers */
 389 static int cmp_func_names(const char *a, const char *b)
 390 {
 391     const char *start = a;
 392     int ascii_diff, digit_diff;
 393
 394     for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
 395     for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
 396
 397     if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
 398         return digit_diff;
 399
 400     return ascii_diff;
 401 }
 402
 403 /* Perform a tree rotation in the specified direction and return the new root */
 404 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
 405 {
 406     CheckasmFunc *r = f->child[dir^1];
 407     f->child[dir^1] = r->child[dir];
 408     r->child[dir] = f;
 409     r->color = f->color;
 410     f->color = 0;
 411     return r;
 412 }
 413
 414 #define is_red(f) ((f) && !(f)->color)
 415
 416 /* Balance a left-leaning red-black tree at the specified node */
 417 static void balance_tree(CheckasmFunc **root)
 418 {
 419     CheckasmFunc *f = *root;
 420
 421     if (is_red(f->child[0]) && is_red(f->child[1])) {
 422         f->color ^= 1;
 423         f->child[0]->color = f->child[1]->color = 1;
 424     }
 425
 426     if (!is_red(f->child[0]) && is_red(f->child[1]))
 427         *root = rotate_tree(f, 0); /* Rotate left */
 428     else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
 429         *root = rotate_tree(f, 1); /* Rotate right */
 430 }
 431
 432 /* Get a node with the specified name, creating it if it doesn't exist */
 433 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
 434 {
 435     CheckasmFunc *f = *root;
 436
 437     if (f) {
 438         /* Search the tree for a matching node */
 439         int cmp = cmp_func_names(name, f->name);
 440         if (cmp) {
 441             f = get_func(&f->child[cmp > 0], name);
 442
 443             /* Rebalance the tree on the way up if a new node was inserted */
 444             if (!f->versions.func)
 445                 balance_tree(root);
 446         }
 447     } else {
 448         /* Allocate and insert a new node into the tree */
 449         int name_length = strlen(name);
 450         f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
 451         memcpy(f->name, name, name_length + 1);
 452     }
 453
 454     return f;
 455 }
 456
 457 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
 458 static void check_cpu_flag(const char *name, int flag)
 459 {
 460     int old_cpu_flag = state.cpu_flag;
 461
 462     flag |= old_cpu_flag;
 463     av_force_cpu_flags(-1);
 464     state.cpu_flag = flag & av_get_cpu_flags();
 465     av_force_cpu_flags(state.cpu_flag);
 466
 467     if (!flag || state.cpu_flag != old_cpu_flag) {
 468         int i;
 469
 470         state.cpu_flag_name = name;
 471         for (i = 0; tests[i].func; i++) {
 472             state.current_test_name = tests[i].name;
 473             tests[i].func();
 474         }
 475     }
 476 }
 477
 478 /* Print the name of the current CPU flag, but only do it once */
 479 static void print_cpu_name(void)
 480 {
 481     if (state.cpu_flag_name) {
 482         color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
 483         state.cpu_flag_name = NULL;
 484     }
 485 }
 486
 487 int main(int argc, char *argv[])
 488 {
 489     int i, seed, ret = 0;
 490
 491 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
 492     if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
 493         checkasm_checked_call = checkasm_checked_call_vfp;
 494 #endif
 495
 496     if (!tests[0].func || !cpus[0].flag) {
 497         fprintf(stderr, "checkasm: no tests to perform\n");
 498         return 0;
 499     }
 500
 501     if (argc > 1 && !strncmp(argv[1], "--bench", 7)) {
 502 #ifndef AV_READ_TIME
 503         fprintf(stderr, "checkasm: --bench is not supported on your system\n");
 504         return 1;
 505 #endif
 506         if (argv[1][7] == '=') {
 507             state.bench_pattern = argv[1] + 8;
 508             state.bench_pattern_len = strlen(state.bench_pattern);
 509         } else
 510             state.bench_pattern = "";
 511
 512         argc--;
 513         argv++;
 514     }
 515
 516     seed = (argc > 1) ? atoi(argv[1]) : av_get_random_seed();
 517     fprintf(stderr, "checkasm: using random seed %u\n", seed);
 518     av_lfg_init(&checkasm_lfg, seed);
 519
 520     check_cpu_flag(NULL, 0);
 521     for (i = 0; cpus[i].flag; i++)
 522         check_cpu_flag(cpus[i].name, cpus[i].flag);
 523
 524     if (state.num_failed) {
 525         fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
 526         ret = 1;
 527     } else {
 528         fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
 529 #ifdef AV_READ_TIME
 530         if (state.bench_pattern) {
 531             state.nop_time = measure_nop_time();
 532             printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
 533             print_benchs(state.funcs);
 534         }
 535 #endif
 536     }
 537
 538     destroy_func_tree(state.funcs);
 539     return ret;
 540 }
 541
 542 /* Decide whether or not the specified function needs to be tested and
 543  * allocate/initialize data structures if needed. Returns a pointer to a
 544  * reference function if the function should be tested, otherwise NULL */
 545 void *checkasm_check_func(void *func, const char *name, ...)
 546 {
 547     char name_buf[256];
 548     void *ref = func;
 549     CheckasmFuncVersion *v;
 550     int name_length;
 551     va_list arg;
 552
 553     va_start(arg, name);
 554     name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
 555     va_end(arg);
 556
 557     if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
 558         return NULL;
 559
 560     state.current_func = get_func(&state.funcs, name_buf);
 561     state.funcs->color = 1;
 562     v = &state.current_func->versions;
 563
 564     if (v->func) {
 565         CheckasmFuncVersion *prev;
 566         do {
 567             /* Only test functions that haven't already been tested */
 568             if (v->func == func)
 569                 return NULL;
 570
 571             if (v->ok)
 572                 ref = v->func;
 573
 574             prev = v;
 575         } while ((v = v->next));
 576
 577         v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
 578     }
 579
 580     v->func = func;
 581     v->ok = 1;
 582     v->cpu = state.cpu_flag;
 583     state.current_func_ver = v;
 584
 585     if (state.cpu_flag)
 586         state.num_checked++;
 587
 588     return ref;
 589 }
 590
 591 /* Decide whether or not the current function needs to be benchmarked */
 592 int checkasm_bench_func(void)
 593 {
 594     return !state.num_failed && state.bench_pattern &&
 595            !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
 596 }
 597
 598 /* Indicate that the current test has failed */
 599 void checkasm_fail_func(const char *msg, ...)
 600 {
 601     if (state.current_func_ver->cpu && state.current_func_ver->ok) {
 602         va_list arg;
 603
 604         print_cpu_name();
 605         fprintf(stderr, "   %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
 606         va_start(arg, msg);
 607         vfprintf(stderr, msg, arg);
 608         va_end(arg);
 609         fprintf(stderr, ")\n");
 610
 611         state.current_func_ver->ok = 0;
 612         state.num_failed++;
 613     }
 614 }
 615
 616 /* Update benchmark results of the current function */
 617 void checkasm_update_bench(int iterations, uint64_t cycles)
 618 {
 619     state.current_func_ver->iterations += iterations;
 620     state.current_func_ver->cycles += cycles;
 621 }
 622
 623 /* Print the outcome of all tests performed since the last time this function was called */
 624 void checkasm_report(const char *name, ...)
 625 {
 626     static int prev_checked, prev_failed, max_length;
 627
 628     if (state.num_checked > prev_checked) {
 629         int pad_length = max_length + 4;
 630         va_list arg;
 631
 632         print_cpu_name();
 633         pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
 634         va_start(arg, name);
 635         pad_length -= vfprintf(stderr, name, arg);
 636         va_end(arg);
 637         fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
 638
 639         if (state.num_failed == prev_failed)
 640             color_printf(COLOR_GREEN, "OK");
 641         else
 642             color_printf(COLOR_RED, "FAILED");
 643         fprintf(stderr, "]\n");
 644
 645         prev_checked = state.num_checked;
 646         prev_failed  = state.num_failed;
 647     } else if (!state.cpu_flag) {
 648         /* Calculate the amount of padding required to make the output vertically aligned */
 649         int length = strlen(state.current_test_name);
 650         va_list arg;
 651
 652         va_start(arg, name);
 653         length += vsnprintf(NULL, 0, name, arg);
 654         va_end(arg);
 655
 656         if (length > max_length)
 657             max_length = length;
 658     }
 659 }