deflate_test.c File Reference

DEFLATE tests. More...

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <ipxe/deflate.h>
#include <ipxe/test.h>

Go to the source code of this file.

Data Structures
struct	deflate_test
	A DEFLATE test. More...
struct	deflate_test_fragments
	A DEFLATE fragment list. More...

Macros
#define	DATA(...)
	Define inline data.
#define	DEFLATE(name, FORMAT, COMPRESSED, EXPECTED)
	Define a DEFLATE test.
#define	deflate_ok(deflate, test, frags)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	DEFLATE (empty_literal, DEFLATE_RAW, DATA(0x01, 0x00, 0x00, 0xff, 0xff), DATA())
	DEFLATE (literal, DEFLATE_RAW, DATA(0x01, 0x04, 0x00, 0xfb, 0xff, 0x69, 0x50, 0x58, 0x45), DATA(0x69, 0x50, 0x58, 0x45))
	DEFLATE (split_literal, DEFLATE_RAW, DATA(0x00, 0x02, 0x00, 0xfd, 0xff, 0x69, 0x50, 0x01, 0x02, 0x00, 0xfd, 0xff, 0x58, 0x45), DATA(0x69, 0x50, 0x58, 0x45))
	DEFLATE (empty, DEFLATE_RAW, DATA(0x03, 0x00), DATA())
	DEFLATE (hello_world, DEFLATE_RAW, DATA(0xf3, 0x48, 0xcd, 0xc9, 0xc9, 0x57, 0x28, 0xcf, 0x2f, 0xca, 0x49, 0x01, 0x00), DATA(0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64))
	DEFLATE (hello_hello_world, DEFLATE_RAW, DATA(0xf3, 0x48, 0xcd, 0xc9, 0xc9, 0x57, 0xc8, 0x00, 0x93, 0xe5, 0xf9, 0x45, 0x39, 0x29, 0x00), DATA(0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64))
	DEFLATE (rfc_sentence, DEFLATE_RAW, DATA(0x0d, 0xc6, 0xdb, 0x09, 0x00, 0x21, 0x0c, 0x04, 0xc0, 0x56, 0xb6, 0x28, 0x1b, 0x08, 0x79, 0x70, 0x01, 0x35, 0xe2, 0xa6, 0x7f, 0xce, 0xf9, 0x9a, 0xf1, 0x25, 0xc1, 0xe3, 0x9a, 0x91, 0x2a, 0x9d, 0xb5, 0x61, 0x1e, 0xb9, 0x9d, 0x10, 0xcc, 0x22, 0xa7, 0x93, 0xd0, 0x5a, 0xe7, 0xbe, 0xb8, 0xc1, 0xa4, 0x05, 0x51, 0x77, 0x49, 0xff), DATA(0x54, 0x68, 0x69, 0x73, 0x20, 0x73, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x20, 0x64, 0x65, 0x66, 0x69, 0x6e, 0x65, 0x73, 0x20, 0x61, 0x20, 0x6c, 0x6f, 0x73, 0x73, 0x6c, 0x65, 0x73, 0x73, 0x20, 0x63, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73, 0x73, 0x65, 0x64, 0x20, 0x64, 0x61, 0x74, 0x61, 0x20, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74))
	DEFLATE (zlib, DEFLATE_ZLIB, DATA(0x78, 0x01, 0x8b, 0xf2, 0xf1, 0x74, 0x52, 0x70, 0xce, 0xcf, 0x2d, 0x28, 0x4a, 0x2d, 0x2e, 0x4e, 0x4d, 0x51, 0x70, 0x49, 0x2c, 0x49, 0x54, 0x70, 0xcb, 0x2f, 0xca, 0x4d, 0x2c, 0x51, 0x08, 0x2e, 0x48, 0x4d, 0xce, 0x4c, 0xcb, 0x4c, 0x4e, 0x2c, 0xc9, 0xcc, 0xcf, 0x03, 0x00, 0x2c, 0x0e, 0x0e, 0xeb), DATA(0x5a, 0x4c, 0x49, 0x42, 0x20, 0x43, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73, 0x73, 0x65, 0x64, 0x20, 0x44, 0x61, 0x74, 0x61, 0x20, 0x46, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x20, 0x53, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e))
static void	deflate_okx (struct deflate *deflate, struct deflate_test *test, struct deflate_test_fragments *frags, const char *file, unsigned int line)
	Report DEFLATE test result.
static void	deflate_test_exec (void)
	Perform DEFLATE self-test.

Variables
static struct deflate_test_fragments	zlib_fragments []
struct self_test deflate_test	__self_test
	DEFLATE self-test.

Detailed Description

DEFLATE tests.

Definition in file deflate_test.c.

Macro Definition Documentation

DATA

#define DATA

(

...

)

Value:

{ __VA_ARGS__ }

Define inline data.

Definition at line 62 of file deflate_test.c.

DEFLATE

#define DEFLATE	(		name,
			FORMAT,
			COMPRESSED,
			EXPECTED )

Value:

        static const uint8_t name ## _compressed[] = COMPRESSED;     \
        static const uint8_t name ## _expected[] = EXPECTED;         \
        static struct deflate_test name = {                             \
                .format = FORMAT,                                       \
                .compressed = name ## _compressed,                  \
                .compressed_len = sizeof ( name ## _compressed ),   \
                .expected = name ## _expected,                              \
                .expected_len = sizeof ( name ## _expected ),               \
        };

Define a DEFLATE test.

Definition at line 65 of file deflate_test.c.

#define DEFLATE( name, FORMAT, COMPRESSED, EXPECTED )                   \
        static const uint8_t name ## _compressed[] = COMPRESSED;        \
        static const uint8_t name ## _expected[] = EXPECTED;            \
        static struct deflate_test name = {                             \
                .format = FORMAT,                                       \
                .compressed = name ## _compressed,                      \
                .compressed_len = sizeof ( name ## _compressed ),       \
                .expected = name ## _expected,                          \
                .expected_len = sizeof ( name ## _expected ),           \
        };

deflate_ok

#define deflate_ok	(		deflate,
			test,
			frags )

Value:

        deflate_okx ( deflate, test, frags, __FILE__, __LINE__ )

Definition at line 209 of file deflate_test.c.

#define deflate_ok( deflate, test, frags ) \
        deflate_okx ( deflate, test, frags, __FILE__, __LINE__ )

Referenced by deflate_test_exec().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

DEFLATE() [1/8]

DEFLATE	(	empty_literal	,
		DEFLATE_RAW	,
		DATA(0x01, 0x00, 0x00, 0xff, 0xff)	,
		DATA()	)

References DATA, and DEFLATE_RAW.

DEFLATE() [2/8]

DEFLATE	(	literal	,
		DEFLATE_RAW	,
		DATA(0x01, 0x04, 0x00, 0xfb, 0xff, 0x69, 0x50, 0x58, 0x45)	,
		DATA(0x69, 0x50, 0x58, 0x45)	)

References DATA, and DEFLATE_RAW.

DEFLATE() [3/8]

DEFLATE	(	split_literal	,
		DEFLATE_RAW	,
		DATA(0x00, 0x02, 0x00, 0xfd, 0xff, 0x69, 0x50, 0x01, 0x02, 0x00, 0xfd, 0xff, 0x58, 0x45)	,
		DATA(0x69, 0x50, 0x58, 0x45)	)

References DATA, and DEFLATE_RAW.

DEFLATE() [4/8]

DEFLATE	(	empty	,
		DEFLATE_RAW	,
		DATA(0x03, 0x00)	,
		DATA()	)

References DATA, and DEFLATE_RAW.

DEFLATE() [5/8]

DEFLATE	(	hello_world	,
		DEFLATE_RAW	,
		DATA(0xf3, 0x48, 0xcd, 0xc9, 0xc9, 0x57, 0x28, 0xcf, 0x2f, 0xca, 0x49, 0x01, 0x00)	,
		DATA(0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64)	)

References DATA, and DEFLATE_RAW.

DEFLATE() [6/8]

DEFLATE	(	hello_hello_world	,
		DEFLATE_RAW	,
		DATA(0xf3, 0x48, 0xcd, 0xc9, 0xc9, 0x57, 0xc8, 0x00, 0x93, 0xe5, 0xf9, 0x45, 0x39, 0x29, 0x00)	,
		DATA(0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64)	)

References DATA, and DEFLATE_RAW.

DEFLATE() [7/8]

DEFLATE	(	rfc_sentence	,
		DEFLATE_RAW	,
		DATA(0x0d, 0xc6, 0xdb, 0x09, 0x00, 0x21, 0x0c, 0x04, 0xc0, 0x56, 0xb6, 0x28, 0x1b, 0x08, 0x79, 0x70, 0x01, 0x35, 0xe2, 0xa6, 0x7f, 0xce, 0xf9, 0x9a, 0xf1, 0x25, 0xc1, 0xe3, 0x9a, 0x91, 0x2a, 0x9d, 0xb5, 0x61, 0x1e, 0xb9, 0x9d, 0x10, 0xcc, 0x22, 0xa7, 0x93, 0xd0, 0x5a, 0xe7, 0xbe, 0xb8, 0xc1, 0xa4, 0x05, 0x51, 0x77, 0x49, 0xff)	,
		DATA(0x54, 0x68, 0x69, 0x73, 0x20, 0x73, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x20, 0x64, 0x65, 0x66, 0x69, 0x6e, 0x65, 0x73, 0x20, 0x61, 0x20, 0x6c, 0x6f, 0x73, 0x73, 0x6c, 0x65, 0x73, 0x73, 0x20, 0x63, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73, 0x73, 0x65, 0x64, 0x20, 0x64, 0x61, 0x74, 0x61, 0x20, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74)	)

References DATA, and DEFLATE_RAW.

DEFLATE() [8/8]

DEFLATE	(	zlib	,
		DEFLATE_ZLIB	,
		DATA(0x78, 0x01, 0x8b, 0xf2, 0xf1, 0x74, 0x52, 0x70, 0xce, 0xcf, 0x2d, 0x28, 0x4a, 0x2d, 0x2e, 0x4e, 0x4d, 0x51, 0x70, 0x49, 0x2c, 0x49, 0x54, 0x70, 0xcb, 0x2f, 0xca, 0x4d, 0x2c, 0x51, 0x08, 0x2e, 0x48, 0x4d, 0xce, 0x4c, 0xcb, 0x4c, 0x4e, 0x2c, 0xc9, 0xcc, 0xcf, 0x03, 0x00, 0x2c, 0x0e, 0x0e, 0xeb)	,
		DATA(0x5a, 0x4c, 0x49, 0x42, 0x20, 0x43, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73, 0x73, 0x65, 0x64, 0x20, 0x44, 0x61, 0x74, 0x61, 0x20, 0x46, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x20, 0x53, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e)	)

References DATA, and DEFLATE_ZLIB.

deflate_okx()

void deflate_okx ( struct deflate * deflate, struct deflate_test * test, struct deflate_test_fragments * frags, const char * file, unsigned int line )

static

Report DEFLATE test result.

Parameters

deflate	Decompressor
test	Deflate test
frags	Fragment list, or NULL
file	Test code file
line	Test code line

Definition at line 155 of file deflate_test.c.

                                                                {
        uint8_t buf[ test->expected_len ];
        const void *data = test->compressed;
        size_t remaining = test->compressed_len;
        size_t frag_len = -1UL;
        struct deflate_chunk out;
        unsigned int i;
 
        /* Initialise decompressor */
        deflate_init ( deflate, test->format );
 
        /* Initialise output chunk */
        deflate_chunk_init ( &out, buf, 0, sizeof ( buf ) );
 
        /* Process input (in fragments, if applicable) */
        for ( i = 0 ; i < ( sizeof ( frags->len ) /
                            sizeof ( frags->len[0] ) ) ; i++ ) {
 
                /* Initialise input chunk */
                if ( frags )
                        frag_len = frags->len[i];
                if ( frag_len > remaining )
                        frag_len = remaining;
 
                /* Decompress this fragment */
                okx ( deflate_inflate ( deflate, data, frag_len,
                                        &out ) == 0, file, line );
                okx ( deflate->in == ( data + frag_len ), file, line );
                okx ( deflate->end == ( data + frag_len ), file, line );
 
                /* Move to next fragment */
                data += frag_len;
                remaining -= frag_len;
                if ( ! remaining )
                        break;
 
                /* Check that decompression has not terminated early */
                okx ( ! deflate_finished ( deflate ), file, line );
        }
 
        /* Check decompression has terminated as expected */
        okx ( deflate_finished ( deflate ), file, line );
        okx ( deflate->in == ( test->compressed + test->compressed_len ),
              file, line );
        okx ( deflate->end == ( test->compressed + test->compressed_len ),
              file, line );
        okx ( out.offset == test->expected_len, file, line );
        okx ( out.data == buf, file, line );
        okx ( memcmp ( out.data, test->expected, test->expected_len ) == 0,
             file, line );
}

References data, deflate_finished(), deflate_inflate(), deflate_init(), deflate::end, frags, deflate::in, memcmp(), okx, out, and test.

deflate_test_exec()

void deflate_test_exec ( void )

static

Perform DEFLATE self-test.

Definition at line 216 of file deflate_test.c.

                                       {
        struct deflate *deflate;
        unsigned int i;
 
        /* Allocate shared structure */
        deflate = malloc ( sizeof ( *deflate ) );
        ok ( deflate != NULL );
 
        /* Perform self-tests */
        if ( deflate ) {
 
                /* Test as a single pass */
                deflate_ok ( deflate, &empty_literal, NULL );
                deflate_ok ( deflate, &literal, NULL );
                deflate_ok ( deflate, &split_literal, NULL );
                deflate_ok ( deflate, &empty, NULL );
                deflate_ok ( deflate, &hello_world, NULL );
                deflate_ok ( deflate, &hello_hello_world, NULL );
                deflate_ok ( deflate, &rfc_sentence, NULL );
                deflate_ok ( deflate, &zlib, NULL );
 
                /* Test fragmentation */
                for ( i = 0 ; i < ( sizeof ( zlib_fragments ) /
                                    sizeof ( zlib_fragments[0] ) ) ; i++ ) {
                        deflate_ok ( deflate, &zlib, &zlib_fragments[i] );
                }
        }
 
        /* Free shared structure */
        free ( deflate );
}

References deflate_ok, free, malloc(), NULL, ok, and zlib_fragments.

Variable Documentation

zlib_fragments

struct deflate_test_fragments zlib_fragments[]

static

Initial value:

= {
        { { -1UL, } },
        { { 0, 1, 5, -1UL, } },
        { { 0, 0, 1, 0, 0, 1, -1UL } },
        { { 10, 8, 4, 7, 11, -1UL } },
        { { 45, -1UL } },
        { { 48, -1UL } },
}

Definition at line 137 of file deflate_test.c.

                                                        {
        { { -1UL, } },
        { { 0, 1, 5, -1UL, } },
        { { 0, 0, 1, 0, 0, 1, -1UL } },
        { { 10, 8, 4, 7, 11, -1UL } },
        { { 45, -1UL } },
        { { 48, -1UL } },
};

Referenced by deflate_test_exec().

__self_test

struct self_test deflate_test __self_test

Initial value:

= {
        .name = "deflate",
        .exec = deflate_test_exec,
}

DEFLATE self-test.

Definition at line 249 of file deflate_test.c.

                                            {
        .name = "deflate",
        .exec = deflate_test_exec,
};