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