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