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