xref: /lsquic/tests/test_streamgen.c

/* Copyright (c) 2017 - 2021 LiteSpeed Technologies Inc.  See LICENSE. */
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/queue.h>
#ifndef WIN32
#include <sys/time.h>
#endif

#include "lsquic.h"
#include "lsquic_types.h"
#include "lsquic_parse.h"
#include "lsquic_sfcw.h"
#include "lsquic_varint.h"
#include "lsquic_hq.h"
#include "lsquic_hash.h"
#include "lsquic_stream.h"

struct test {
    int             lineno;
    const struct parse_funcs *
                    pf;
    /* Inputs.  These are returned by lsquic_stream_tosend_fin(),
     * lsquic_stream_tosend_read(), and lsquic_stream_tosend_offset().
     */
    int             fin[2];         /* There may be two calls to lsquic_stream_tosend_fin() */
    uint64_t        offset;
    uint32_t        stream_id;
    size_t          avail;          /* Space to write stream frame to */
    size_t          min_sz;         /* Minimum size needed to generate stream frame.  Any
                                     * sizes smaller than this should fail.
                                     */
    size_t          data_sz;
    char            data[0x100];

    /* Output.  This is how we expect the resulting frame to look.
     */
    int             len;            /* Return value of gen_stream_frame() */
    char            out[0x100];
};


static const struct test tests[] = {
    /*
     * Big-endian:
     */
    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 1, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x40 | 0x20 | 0x1C | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x00, 0x0A,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 8 + 2 + 10,
        .min_sz     = 1 + 2 + 8 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 0, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x00 | 0x20 | 0x1C | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x00, 0x0A,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 8 + 2 + 10,
        .min_sz     = 1 + 2 + 8 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 1, 0, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x40 | 0x20 | 0x1C | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x00, 0x00,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 8 + 2,
        .min_sz     = 1 + 2 + 8 + 2,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 1, 0, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x21,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x40 | 0x20 | 0x1C | 0x00,
          0x21,                                             /* Stream ID */
          0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x00, 0x00,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 1 + 8 + 2,
        .min_sz     = 1 + 1 + 8 + 2,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 0, },
        .offset     = 0x77,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x00 | 0x20 | 0x04 | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0x00, 0x77,                                       /* Offset */
          0x00, 0x0A,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 2 + 2 + 10,
        .min_sz     = 1 + 2 + 2 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 0, },
        .offset     = 0x0,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x00 | 0x20 | 0x00 | 0x01,
          0x02, 0x10,                                       /* Stream ID */
                                                            /* Offset */
          0x00, 0x0A,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 0 + 2 + 10,
        .min_sz     = 1 + 2 + 0 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 1, },
        .offset     = 0x0,
        .stream_id  = 0x210,
        .data_sz    = 1,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x40 | 0x20 | 0x00 | 0x01,
          0x02, 0x10,                                       /* Stream ID */
                                                            /* Offset */
          0x00, 0x01,                                       /* Data length */
          '0',
        },
        .len        = 1 + 2 + 0 + 2 + 1,
        .min_sz     = 1 + 2 + 0 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 0, },
        .offset     = 0xFFFFFF,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x00 | 0x20 | 0x08 | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0xFF, 0xFF, 0xFF,                                 /* Offset */
          0x00, 0x0A,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 3 + 2 + 10,
        .min_sz     = 1 + 2 + 3 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 0, },
        .offset     = 0xFFFFFF + 1,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x00 | 0x20 | 0x0C | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0x01, 0x00, 0x00, 0x00,                           /* Offset */
          0x00, 0x0A,                                       /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 4 + 2 + 10,
        .min_sz     = 1 + 2 + 4 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 0, 0, },
        .offset     = 0xFFFFFF + 1,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 10,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x00 | 0x00 | 0x0C | 0x01,
          0x02, 0x10,                                       /* Stream ID */
          0x01, 0x00, 0x00, 0x00,                           /* Offset */
          '0', '1', '2',
        },
        .len        = 1 + 2 + 4 + 0 + 3,
        .min_sz     = 1 + 2 + 4 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_043),
        .fin        = { 1, 0, },
        .offset     = 0xB4,
        .stream_id  = 0x01,
        .data_sz    = 0,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  1      f      d      ooo    ss            1fdoooss */
      /*  TYPE   FIN    DLEN   OLEN   SLEN  */
        { 0x80 | 0x40 | 0x20 | 0x04 | 0x00,
          0x01,                                             /* Stream ID */
          0x00, 0xB4,                                       /* Offset */
          0x00, 0x00,                                       /* Data length */
        },
        .len        = 6,
        .min_sz     = 6,
    },

    /*
     * IETF QUIC Internet-Draft 17:
     */

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_ID27),
        .fin        = { 0, 1, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  TYPE   OFF    DLEN   FIN  */
        { 0x08 | 1<<2 | 1<<1 | 1<<0,
          0x42, 0x10,                                       /* Stream ID */
          0xC8, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x0A,                                             /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 8 + 1 + 10,
        .min_sz     = 1 + 2 + 8 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_ID27),
        .fin        = { 0, 0, },
        .offset     = 0,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  TYPE   OFF    DLEN   FIN  */
        { 0x08 | 0<<2 | 1<<1 | 0<<0,
          0x42, 0x10,                                       /* Stream ID */
          0x0A,                                             /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 0 + 1 + 10,
        .min_sz     = 1 + 2 + 0 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_ID27),
        .fin        = { 0, 0, },
        .offset     = 0,
        .stream_id  = 0x21,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 12,
        .out        =
      /*  TYPE   OFF    DLEN   FIN  */
        { 0x08 | 0<<2 | 0<<1 | 0<<0,
          0x21,                                             /* Stream ID */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 1 + 0 + 0 + 10,
        .min_sz     = 1 + 1 + 0 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_ID27),
        .fin        = { 0, 0, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 10,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  TYPE   OFF    DLEN   FIN  */
        { 0x08 | 1<<2 | 1<<1 | 0<<0,
          0x42, 0x10,                                       /* Stream ID */
          0xC8, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x0A,                                             /* Data length */
          '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        },
        .len        = 1 + 2 + 8 + 1 + 10,
        .min_sz     = 1 + 2 + 8 + 0 + 1,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_ID27),
        .fin        = { 1, 0, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 0,
        .data       = "0123456789",
        .avail      = 11,
        .out        =
      /*  TYPE   OFF    DLEN   FIN  */
        { 0x08 | 1<<2 | 0<<1 | 1<<0,
          0x42, 0x10,                                       /* Stream ID */
          0xC8, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
        },
        .len        = 1 + 2 + 8,
        .min_sz     = 1 + 2 + 8,
    },

    {   .lineno     = __LINE__,
        .pf         = select_pf_by_ver(LSQVER_ID27),
        .fin        = { 1, 0, },
        .offset     = 0x0807060504030201UL,
        .stream_id  = 0x210,
        .data_sz    = 0,
        .data       = "0123456789",
        .avail      = 0x100,
        .out        =
      /*  TYPE   OFF    DLEN   FIN  */
        { 0x08 | 1<<2 | 1<<1 | 1<<0,
          0x42, 0x10,                                       /* Stream ID */
          0xC8, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01,   /* Offset */
          0x00,                                             /* Data length */
        },
        .len        = 1 + 2 + 8 + 1,
        .min_sz     = 1 + 2 + 8,
    },

};


static struct test_ctx {
    const struct test *test;
    int                next_fin;
    lsquic_stream_t    stream;
} test_ctx;


static int
stream_tosend_fin (void *stream)
{
    struct test_ctx *test_ctx2 = stream;
    return test_ctx2->test->fin[ test_ctx2->next_fin++ ];
}


static size_t
stream_tosend_read (void *stream, void *buf, size_t len, int *reached_fin)
{
    struct test_ctx *test_ctx2 = stream;
    if (test_ctx2->test->data_sz < len)
        len = test_ctx2->test->data_sz;
    memcpy(buf, test_ctx2->test->data, len);
    *reached_fin = stream_tosend_fin(stream);
    return len;
}


static size_t
stream_tosend_size (void *stream)
{
    struct test_ctx *test_ctx2 = stream;
    return test_ctx2->test->data_sz;
}


static void
reset_ctx (const struct test *test)
{
    test_ctx.test      = test;
    test_ctx.next_fin  = 0;
    test_ctx.stream.id = test->stream_id;
}


static void
run_test (int i)
{
    const struct test *const test = &tests[i];

    unsigned char out[0x100];
    int len;
    size_t min;

    if (test->len > 0)
    {
        /* Test that all sizes under specified min fail to produce a frame */
        for (min = 0; min < test->min_sz; ++min)
        {
            reset_ctx(test);
            len = test->pf->pf_gen_stream_frame(out, min, test->stream_id,
                        test_ctx.test->offset, stream_tosend_fin(&test_ctx),
                        stream_tosend_size(&test_ctx), stream_tosend_read, &test_ctx);
            assert(len < 0);
        }

        /* Test that it succeeds now: */
        reset_ctx(test);
        len = test->pf->pf_gen_stream_frame(out, min, test->stream_id,
                        test_ctx.test->offset, stream_tosend_fin(&test_ctx),
                        stream_tosend_size(&test_ctx), stream_tosend_read, &test_ctx);
        assert(len == (int) min);
    }

    reset_ctx(test);
    len = test->pf->pf_gen_stream_frame(out, test->avail, test->stream_id,
                    test_ctx.test->offset, stream_tosend_fin(&test_ctx),
                    stream_tosend_size(&test_ctx), stream_tosend_read, &test_ctx);

    if (test->len > 0) {
        /* Check parser operation */
        assert(test->len == len);
        assert(("Generated frame is correct", 0 == memcmp(test->out, out, test->len)));
    }
    else
    {
        assert(("This test should fail", len < 0));
    }
}


int
main (void)
{
    unsigned i;
    for (i = 0; i < sizeof(tests) / sizeof(tests[0]); ++i)
        run_test(i);
    return 0;
}