/* test harness for bits.h
 *
 * This file is Copyright 2010 by the GPSD project
 * SPDX-License-Identifier: BSD-2-clause
 */

#include "../include/gpsd_config.h"   // must be before all includes

#include <inttypes.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "../include/bits.h"
#include "../include/gps.h"           // for gps_hexdump()

// test array of 640 bits
static unsigned char buf[80];
static signed char sb1, sb2;
static unsigned char ub1, ub2;
static short sw1, sw2;
static unsigned short uw1, uw2;
static int sl1, sl2;
static unsigned int ul1, ul2;
static int64_t sL1, sL2;
static uint64_t uL1, uL2;
static float f1;
static double d1;

static void bedumpall(void)
{
    (void)printf("getsb: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) sb1, (uint64_t) sb2,
                 (uint64_t) getsb(buf, 0), (uint64_t) getsb(buf, 8));
    (void)printf("getub: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) ub1, (uint64_t) ub2,
                 (uint64_t) getub(buf, 0), (uint64_t) getub(buf, 8));
    (void)printf("getbes16: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) sw1, (uint64_t) sw2,
                 (uint64_t) getbes16(buf, 0), (uint64_t) getbes16(buf, 8));
    (void)printf("getbeu16: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) uw1, (uint64_t) uw2,
                 (uint64_t) getbeu16(buf, 0), (uint64_t) getbeu16(buf, 8));
    (void)printf("getbes32: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) sl1, (uint64_t) sl2,
                 (uint64_t) getbes32(buf, 0), (uint64_t) getbes32(buf, 8));
    (void)printf("getbeu32: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) ul1, (uint64_t) ul2,
                 (uint64_t) getbeu32(buf, 0), (uint64_t) getbeu32(buf, 8));
    (void)printf("getbes64: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) sL1, (uint64_t) sL2,
                 (uint64_t) getbes64(buf, 0), (uint64_t) getbes64(buf, 8));
    (void)printf("getbeu64: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) uL1, (uint64_t) uL2,
                 (uint64_t) getbeu64(buf, 0), (uint64_t) getbeu64(buf, 8));
    (void)printf("getbef32: %f %f\n", f1, getbef32((const char *)buf, 24));
    (void)printf("getbed64: %.16f %.16f\n", d1,
                 getbed64((const char *)buf, 16));
}

static void ledumpall(void)
{
    (void)printf("getsb: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) sb1, (uint64_t) sb2,
                 (uint64_t) getsb(buf, 0), (uint64_t) getsb(buf, 8));
    (void)printf("getub: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) ub1, (uint64_t) ub2,
                 (uint64_t) getub(buf, 0), (uint64_t) getub(buf, 8));
    (void)printf("getles16: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) sw1, (uint64_t) sw2,
                 (uint64_t) getles16(buf, 0), (uint64_t) getles16(buf, 8));
    (void)printf("getleu16: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) uw1, (uint64_t) uw2,
                 (uint64_t) getleu16(buf, 0), (uint64_t) getleu16(buf, 8));
    (void)printf("getles32: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) sl1, (uint64_t) sl2,
                 (uint64_t) getles32(buf, 0), (uint64_t) getles32(buf, 8));
    (void)printf("getleu32: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) ul1, (uint64_t) ul2,
                 (uint64_t) getleu32(buf, 0), (uint64_t) getleu32(buf, 8));
    (void)printf("getles64: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                 " %016" PRIx64 "\n",
                 (uint64_t) sL1, (uint64_t) sL2,
                 (uint64_t) getles64(buf, 0), (uint64_t) getles64(buf, 8));
    (void)printf("getleu64: %016" PRIx64 " %016" PRIx64 " %016" PRIx64
                " %016" PRIx64 "\n",
                 (uint64_t) uL1, (uint64_t) uL2,
                 (uint64_t) getleu64(buf, 0), (uint64_t) getleu64(buf, 8));
    (void)printf("getlef32: %f %f\n", f1, getlef32((const char *)buf, 24));
    (void)printf("getled64: %.16f %.16f\n", d1,
                 getled64((const char *)buf, 16));
}

struct unsigned_test
{
    const unsigned char *buf;
    unsigned int start, width;
    uint64_t expected;
    bool le;
    char *description;
};

struct bitmask
{
    int shift;
    unsigned long long mask;
};
static struct bitmask bitmask_tests[] = {
    {0, 0},
    {1, 1},
    {2, 3},
    {3, 7},
    {15, 0x07fff},
    {16, 0x0ffff},
    {31, 0x07fffffff},
    {32, 0x0ffffffffULL},
    {40, 0x0ffffffffffULL},
    {255, 0},     // 255 marks end
};
struct uint2int
{
    unsigned long long uint;
    int bits;
    long long res;
};
static struct uint2int uint2_tests[] = {
    {0, 2, 0},
    {1, 2, 1},
    {2, 2, -2},
    {3, 2, -1},
    {0x1b, 5, -5},
    {5, 5, 5},
    {0x07f, 8, 127},
    {0x080, 8, -128},
    {0x0ff, 8, -1},
    {0x07fff, 16, 32767},
    {0x08000, 16, -32768},
    {0x0ffff, 16, -1},
    {0x07ffff, 20, 524287},
    {0x080000, 20, -524288},
    {0x0fffff, 20, -1},
    {0x07fffffff, 32, 2147483647},
    {0x080000000ULL, 32, -2147483648LL},
    {0x0ffffffffULL, 32, -1},
    {0x07ffffffffULL, 36, 34359738367LL},
    {0x0800000000ULL, 36, -34359738368LL},
    {0x0fffffffffULL, 36, -1},
    {0, 255, 0},     // 255 marks end
};

struct hextest_t
{
    const char *ascii;
    const char *bin;      // a binary string
    size_t binlen;        // length of binary string
};
static struct hextest_t hextests[] = {
    {"000110ff", "\x00\x01\x10\xff", 4},
    {"00010203040506070809", "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09", 10},
    {"00102030405060708090", "\x00\x10\x20\x30\x40\x50\x60\x70\x80\x90", 10},
    {"41426162", "ABab", 4},
    {"54686520517569636b2042726f776e20466f7820"
     "4a756d706564204f76657220546865204c617a79"
     "20446f672773204261636b2e",
     "The Quick Brown Fox Jumped Over The Lazy Dog's Back.", 52},
    {NULL, NULL, 0},
};

struct le16test_t
{
    const unsigned char buf[3];       // 4 bytes to decode
    const int ress;                   // signed result
    const unsigned resu;              // unsigned result
};
static struct le16test_t le16tests[] = {
    {"\x01\x02", 513, 513},
    {"\x00\x80", -32768, 32768},
    {"\x00\x40", 16384, 16384},
    {"\xff\xff", -1, 65535},
    {{0}, 0},
};

struct le32test_t
{
    const unsigned char buf[5];            // 4 bytes to decode
    const long ress;                       // signed result
    const unsigned long resu;              // unsigned result
};
static struct le32test_t le32tests[] = {
    {"\x01\x02\x03\x84", -2080177663L, 2214789633UL},
    {"\x00\x00\x00\x80", -2147483648L, 2147483648UL},
    {"\x00\x00\x00\x40", 1073741824L, 1073741824UL},
    {"\xff\xff\xff\xff", -1, 4294967295UL},
    {{0}, 0},
};

struct le64test_t
{
    const unsigned char buf[9];            // 8 bytes to decode
    const long long ress;                  // signed result
    const unsigned long long resu;         // unsigned result
};
static struct le64test_t le64tests[] = {
    {"\x01\x02\x04\x08\x10\x20\x40\x80",
     -9205322385119247871LL, 9241421688590303745ULL},
    {"\x01\x00\x00\x00\x00\x00\x00\x80",
     -9223372036854775807LL, 9223372036854775809ULL},
    {"\x00\x00\x00\x00\x00\x00\x00\x40",
      4611686018427387904LL, 4611686018427387904ULL},
    {"\xff\xff\xff\xff\xff\xff\xff\xff", -1, 18446744073709551615ULL},
    {{0}, 0, 0},
};

int main(int argc, char *argv[])
{
    int failures = 0;
    bool quiet = (argc > 1) && (strcmp(argv[1], "--quiet") == 0);

    struct unsigned_test *up, unsigned_tests[] = {
        // tests using the big buffer
        {buf, 0,  1,  0,    false, "first bit of first byte"},
        {buf, 0,  8,  0x01, false, "first 8 bits"},
        {buf, 32, 7,  0x02, false, "first seven bits of fifth byte (0x05)"},
        {buf, 56, 12, 0x8f, false, "12 bits crossing 7th to 8th bytes (0x08ff)"},
        {buf, 78, 4,  0xb,  false, "4 bits crossing 8th to 9th byte (0xfefd)"},
        {buf, 1,  56, 0x020406080a0c0eULL,  false, "56 bits, 1 bit in"},
        {buf, 7,  56, 0x81018202830384ULL,  false, "56 bits, 7 bit in"},
        {buf, 9,  56, 0x0406080a0c0e11ULL,  false, "56 bits, 9 bits in"},
        // width 56 max, check consistent fail on 64 bits
        {buf, 0,  64, 0,  false, "64 bits, 0 bit in"},
        {buf, 1,  64, 0,  false, "64 bits, 1 bit in"},
        {buf, 7,  33, 0x102030405ULL,  false, "33 bits, 7 bits in"},
        {buf, 0,  1,  0,    true,  "first bit of first byte"},
        {buf, 0,  8,  0x80, true,  "first 8 bits"},
        {buf, 32, 7,  0x20, true, "first seven bits of fifth byte (0x05)"},
        {buf, 56, 12, 0xf10,true, "12 bits crossing 7th to 8th bytes (0x08ff)"},
        {buf, 78, 4,  0xd,  true, "4 bits crossing 8th to 9th byte (0xfefd)"},
        // sporadic tests based on found bugs
        {(unsigned char *)"\x19\x23\f6",
         7, 2, 2, false, "2 bits crossing 1st to 2nd byte (0x1923)"},
    };
    struct bitmask *bitm = bitmask_tests;
    struct uint2int *uint2 = uint2_tests;
    struct hextest_t *hextest = hextests;
    struct le16test_t *le16test = le16tests;
    struct le32test_t *le32test = le32tests;
    struct le64test_t *le64test = le64tests;
    char hexbuf[BUFSIZ];

    if (!quiet) {
        (void)printf("Testing gps_hexdump()\n");
    }
    for (hextest = hextests; NULL != hextest->ascii; hextest++) {
        int fail;

        (void)gps_hexdump(hexbuf, sizeof(hexbuf),
                          (const unsigned char *)hextest->bin,
                          hextest->binlen);
        fail = strcmp(hexbuf, hextest->ascii);
        if (0 != fail) {
            failures++;
        }
        if (!quiet ||
            fail) {
            char hexbuf2[BUFSIZ];
            char hexbuf3[BUFSIZ];

            (void)printf("gps_hexdump(%s, %zu) got %s s/b %s\n",
                          gps_visibilize(hexbuf2, sizeof(hexbuf2),
                                         hextest->bin,
                                         hextest->binlen),
                          hextest->binlen, hextest->ascii,
                          gps_visibilize(hexbuf3, sizeof(hexbuf3), hexbuf,
                                         strnlen(hexbuf, sizeof(hexbuf))));
        }
    }

    if (!quiet) {
        (void)printf("Testing bitfield extraction\n");
    }

    // test array of 640/232 bits
    memcpy(buf,
        "\x01\x02\x03\x04\x05\x06\x07\x08"
        "\xff\xfe\xfd\xfc\xfb\xfa\xf9\xf8"
        "\x40\x09\x21\xfb\x54\x44\x2d\x18"
        "\x40\x49\x0f\xdb", 29);

    sb1 = getsb(buf, 0);
    sb2 = getsb(buf, 8);
    ub1 = getub(buf, 0);
    ub2 = getub(buf, 8);

    if (!quiet) {
        const unsigned char *sp;

        (void)fputs("Test data:", stdout);
        for (sp = buf; sp < buf + 28; sp++) {
            (void)printf(" %02x", *sp);
        }
        (void)putc('\n', stdout);

        // big-endian test
        printf("Big-endian:\n");
        sw1 = getbes16(buf, 0);
        sw2 = getbes16(buf, 8);
        uw1 = getbeu16(buf, 0);
        uw2 = getbeu16(buf, 8);
        sl1 = getbes32(buf, 0);
        sl2 = getbes32(buf, 8);
        ul1 = getbeu32(buf, 0);
        ul2 = getbeu32(buf, 8);
        sL1 = getbes64(buf, 0);
        sL2 = getbes64(buf, 8);
        uL1 = getbeu64(buf, 0);
        uL2 = getbeu64(buf, 8);
        f1 = getbef32((const char *)buf, 24);
        d1 = getbed64((const char *)buf, 16);
        bedumpall();

        // little-endian test
        printf("Little-endian:\n");
        sw1 = getles16(buf, 0);
        sw2 = getles16(buf, 8);
        uw1 = getleu16(buf, 0);
        uw2 = getleu16(buf, 8);
        sl1 = getles32(buf, 0);
        sl2 = getles32(buf, 8);
        ul1 = getleu32(buf, 0);
        ul2 = getleu32(buf, 8);
        sL1 = getles64(buf, 0);
        sL2 = getles64(buf, 8);
        uL1 = getleu64(buf, 0);
        uL2 = getleu64(buf, 8);
        f1 = getlef32((const char *)buf, 24);
        d1 = getled64((const char *)buf, 16);
        ledumpall();
    }

    if (1 != sb1) {
        printf("getsb(buf, 0) FAILED\n");
    }
    if (-1 != sb2)  {
        printf("getsb(buf, 8) FAILED\n");
    }
    if (1 != ub1) {
        printf("getub(buf, 0) FAILED\n");
    }
    if (0xff != ub2) {
        printf("getub(buf, 8) FAILED\n");
    }

    for (up = unsigned_tests;
         up <
         unsigned_tests + sizeof(unsigned_tests) / sizeof(unsigned_tests[0]);
         up++) {
        uint64_t res = ubits(buf, up->start, up->width, up->le);
        bool success = (res == up->expected);
        if (!success) {
            failures++;
        }
        if (!success ||
            !quiet) {
            (void)printf("ubits(%s, %d, %d, %s) %s should be %" PRIx64
                         ", is %" PRIx64 ": %s\n",
                         gps_hexdump(hexbuf, sizeof(hexbuf),
                                     buf, strnlen((char *)buf, sizeof(buf))),
                         up->start, up->width, up->le ? "true" : "false",
                         up->description, up->expected, res,
                         success ? "succeeded" : "FAILED");
        }
    }


    shiftleft(buf, 28, 30);
    if (!quiet) {
        printf("Left-shifted 30 bits: %s\n",
               gps_hexdump(hexbuf, sizeof(hexbuf), buf, 28));
    }
    /*
     * After the 24-bit shift, the bit array loses its first three bytes:
     * 0x0405060708 = 00000100 00000101 00000110 00000111 00001000
     * By inspection, the results of the 6-bit shift are
     * 00000001 01000001 10000001 11000010 00
     */
#define LASSERT(n, v) if (buf[n] != v) \
              printf("Expected buf[%d] to be %02x, was %02x\n", n, v, buf[n])
    LASSERT(0, 0x01);
    LASSERT(1, 0x41);
    LASSERT(2, 0x81);
    LASSERT(3, 0xc1);
#undef LASSERT


    if (!quiet) {
        (void)printf("Testing BITMASK(N)\n");
    }

    // coverity complains about shift more than 63 bits
    while (64 > bitm->shift) {
        if (bitm->mask != BITMASK(bitm->shift)) {
            failures++;
            printf("BITMASK(0) FAILED, %llu s/b %llu\n",
               bitm->mask, BITMASK(bitm->shift));
        }
        bitm++;
    }

    if (!quiet) {
        (void)printf("Testing UINT2INT(U, N)\n");
    }

    // coverity complains about shift more than 63 bits
    while (64 > uint2->bits) {
        if (uint2->res != UINT2INT(uint2->uint, uint2->bits)) {
            failures++;
            printf("UINT2INT(x%llx, %d) FAILED, %lld s/b %lld\n",
               uint2->uint, uint2->bits,
               uint2->res, UINT2INT(uint2->uint, uint2->bits));
        }
        uint2++;
    }

    // getles16(), getleu16() tests
    while (0 != le16test->ress) {
        if (le16test->ress != getles16(le16test->buf, 0)) {
            failures++;
            printf("getles16(x%02x%02x, 0) FAILED: %d s/b %d\n",
                   le16test->buf[0], le16test->buf[1],
		   getles16(le16test->buf, 0),
		   le16test->ress);
        }
        if (le16test->resu != getleu16(le16test->buf, 0)) {
            failures++;
            printf("getleu16(x%02x%02x, 0) FAILED: %u s/b %u\n",
                   le16test->buf[0], le16test->buf[1],
		   getleu16(le16test->buf, 0),
		   le16test->resu);
        }
        le16test++;
    }

    // getles32(), getleu32() tests
    while (0 != le32test->ress) {
        if (le32test->ress != getles32(le32test->buf, 0)) {
            failures++;
            printf("getles32(x%02x%02x%02x%02x, 0) FAILED: %ld s/b %ld\n",
                   le32test->buf[0], le32test->buf[1],
                   le32test->buf[2], le32test->buf[3],
		   getles32(le32test->buf, 0),
		   le32test->ress);
        }
        if (le32test->resu != getleu32(le32test->buf, 0)) {
            failures++;
            printf("getleu32(x%02x%02x%02x%02x, 0) FAILED: %lu s/b %lu\n",
                   le32test->buf[0], le32test->buf[1],
                   le32test->buf[2], le32test->buf[3],
		   getleu32(le32test->buf, 0),
		   le32test->resu);
        }
        le32test++;
    }

    // getles64(), getleu64() tests
    while (0 != le64test->ress) {
        if (le64test->ress != getles64(le64test->buf, 0)) {
            failures++;
            printf("getles64(x%02x%02x%02x%02x%02x%02x%02x%02x, 0) "
                   "FAILED: %lld s/b %lld\n",
                   le64test->buf[0], le64test->buf[1],
                   le64test->buf[2], le64test->buf[3],
                   le64test->buf[4], le64test->buf[5],
                   le64test->buf[8], le64test->buf[7],
		   getles64(le64test->buf, 0),
		   le64test->ress);
        }
        if (le64test->resu != getleu64(le64test->buf, 0)) {
            failures++;
            printf("getleu64(x%02x%02x%02x%02x%02x%02x%02x%02x, 0) "
                   "FAILED: %llu s/b %llu\n",
                   le64test->buf[0], le64test->buf[1],
                   le64test->buf[2], le64test->buf[3],
                   le64test->buf[4], le64test->buf[5],
                   le64test->buf[8], le64test->buf[7],
		   getleu64(le64test->buf, 0),
		   le64test->resu);
        }
        le64test++;
    }

    exit(failures ? EXIT_FAILURE : EXIT_SUCCESS);

}

// vim: set expandtab shiftwidth=4