[U-Boot] [PATCH 1/6] sandbox: add compression tests
Simon Glass
sjg at chromium.org
Wed Aug 14 19:30:39 CEST 2013
Hi Kees,
On Mon, Aug 12, 2013 at 4:48 PM, Kees Cook <keescook at chromium.org> wrote:
> This adds the "test_compression" command when building the sandbox. This
> tests the existing compression and decompression routines for simple
> sanity and for buffer overflow conditions.
>
> Signed-off-by: Kees Cook <keescook at chromium.org>
> ---
> include/configs/sandbox.h | 5 +
> test/Makefile | 1 +
> test/compression.c | 384 +++++++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 390 insertions(+)
> create mode 100644 test/compression.c
>
> diff --git a/include/configs/sandbox.h b/include/configs/sandbox.h
> index 98dd083..b7fe14d 100644
> --- a/include/configs/sandbox.h
> +++ b/include/configs/sandbox.h
> @@ -125,4 +125,9 @@
> "stdout=serial\0" \
> "stderr=serial\0"
>
> +#define CONFIG_GZIP_COMPRESSED
> +#define CONFIG_BZIP2
> +#define CONFIG_LZO
> +#define CONFIG_LZMA
> +
> #endif
> diff --git a/test/Makefile b/test/Makefile
> index 83594f3..ede113d 100644
> --- a/test/Makefile
> +++ b/test/Makefile
> @@ -25,6 +25,7 @@ include $(TOPDIR)/config.mk
> LIB = $(obj)libtest.o
>
> COBJS-$(CONFIG_SANDBOX) += command_ut.o
> +COBJS-$(CONFIG_SANDBOX) += compression.o
>
> COBJS := $(sort $(COBJS-y))
> SRCS := $(COBJS:.o=.c)
> diff --git a/test/compression.c b/test/compression.c
> new file mode 100644
> index 0000000..c78c8e4
> --- /dev/null
> +++ b/test/compression.c
> @@ -0,0 +1,384 @@
> +/*
> + * Copyright (c) 2013, The Chromium Authors
> + *
> + * See file CREDITS for list of people who contributed to this
> + * project.
> + *
> + * This program is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU General Public License as
> + * published by the Free Software Foundation; either version 2 of
> + * the License, or (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> + * MA 02111-1307 USA
I believe we are moving to a new license structure, although I'm not
sure how this affects new patches. See Licenses/README.
> + */
> +
> +#define DEBUG
> +
> +#include <common.h>
> +#include <command.h>
> +#include <malloc.h>
> +
> +#include <u-boot/zlib.h>
> +#include <bzlib.h>
> +
> +#ifdef CONFIG_LZMA
> +#include <lzma/LzmaTypes.h>
> +#include <lzma/LzmaDec.h>
> +#include <lzma/LzmaTools.h>
> +#endif /* CONFIG_LZMA */
> +
> +#ifdef CONFIG_LZO
> +#include <linux/lzo.h>
> +#endif /* CONFIG_LZO */
You shouldn't need these #ifdefs.
> +
> +static const char plain[] =
> + "I am a highly compressable bit of text.\n"
> + "I am a highly compressable bit of text.\n"
> + "I am a highly compressable bit of text.\n"
> + "There are many like me, but this one is mine.\n"
> + "If I were any shorter, there wouldn't be much sense in\n"
> + "compressing me in the first place. At least with lzo, anyway,\n"
> + "which appears to behave poorly in the face of short text\n"
> + "messages.\n";
> +
> +/* bzip2 -c /tmp/plain.txt > /tmp/plain.bz2 */
> +static const char bzip2_compressed[] =
> + "\x42\x5a\x68\x39\x31\x41\x59\x26\x53\x59\xe5\x63\xdd\x09\x00\x00"
> + "\x28\x57\x80\x00\x10\x40\x85\x20\x20\x04\x00\x3f\xef\xdf\xf0\x30"
> + "\x00\xd6\xd0\x34\x91\x89\xa6\xf5\x4d\x19\x1a\x19\x0d\x02\x34\xd4"
> + "\xc9\x00\x34\x34\x00\x02\x48\x41\x35\x4f\xd4\xc6\x88\xd3\x50\x3d"
> + "\x4f\x51\x82\x4f\x88\xc3\x0d\x05\x62\x4f\x91\xa3\x52\x1b\xd0\x52"
> + "\x41\x4a\xa3\x98\xc2\x6b\xca\xa3\x82\xa5\xac\x8b\x15\x99\x68\xad"
> + "\xdf\x29\xd6\xf1\xf7\x5a\x10\xcd\x8c\x26\x61\x94\x95\xfe\x9e\x16"
> + "\x18\x28\x69\xd4\x23\x64\xcc\x2b\xe5\xe8\x5f\x00\xa4\x70\x26\x2c"
> + "\xee\xbd\x59\x6d\x6a\xec\xfc\x31\xda\x59\x0a\x14\x2a\x60\x1c\xf0"
> + "\x04\x86\x73\x9a\xc5\x5b\x87\x3f\x5b\x4c\x93\xe6\xb5\x35\x0d\xa6"
> + "\xb1\x2e\x62\x7b\xab\x67\xe7\x99\x2a\x14\x5e\x9f\x64\xcb\x96\xf4"
> + "\x0d\x65\xd4\x39\xe6\x8b\x7e\xea\x1c\x03\x69\x97\x83\x58\x91\x96"
> + "\xe1\xf0\x9d\xa4\x15\x8b\xb8\xc6\x93\xdc\x3d\xd9\x3c\x22\x55\xef"
> + "\xfb\xbb\x2a\xd3\x87\xa2\x8b\x04\xd9\x19\xf8\xe2\xfd\x4f\xdb\x1a"
> + "\x07\xc8\x60\xa3\x3f\xf8\xbb\x92\x29\xc2\x84\x87\x2b\x1e\xe8\x48";
> +static const unsigned long bzip2_compressed_size = 240;
> +
> +/* lzma -z -c /tmp/plain.txt > /tmp/plain.lzma */
> +static const char lzma_compressed[] =
> + "\x5d\x00\x00\x80\x00\xff\xff\xff\xff\xff\xff\xff\xff\x00\x24\x88"
> + "\x08\x26\xd8\x41\xff\x99\xc8\xcf\x66\x3d\x80\xac\xba\x17\xf1\xc8"
> + "\xb9\xdf\x49\x37\xb1\x68\xa0\x2a\xdd\x63\xd1\xa7\xa3\x66\xf8\x15"
> + "\xef\xa6\x67\x8a\x14\x18\x80\xcb\xc7\xb1\xcb\x84\x6a\xb2\x51\x16"
> + "\xa1\x45\xa0\xd6\x3e\x55\x44\x8a\x5c\xa0\x7c\xe5\xa8\xbd\x04\x57"
> + "\x8f\x24\xfd\xb9\x34\x50\x83\x2f\xf3\x46\x3e\xb9\xb0\x00\x1a\xf5"
> + "\xd3\x86\x7e\x8f\x77\xd1\x5d\x0e\x7c\xe1\xac\xde\xf8\x65\x1f\x4d"
> + "\xce\x7f\xa7\x3d\xaa\xcf\x26\xa7\x58\x69\x1e\x4c\xea\x68\x8a\xe5"
> + "\x89\xd1\xdc\x4d\xc7\xe0\x07\x42\xbf\x0c\x9d\x06\xd7\x51\xa2\x0b"
> + "\x7c\x83\x35\xe1\x85\xdf\xee\xfb\xa3\xee\x2f\x47\x5f\x8b\x70\x2b"
> + "\xe1\x37\xf3\x16\xf6\x27\x54\x8a\x33\x72\x49\xea\x53\x7d\x60\x0b"
> + "\x21\x90\x66\xe7\x9e\x56\x61\x5d\xd8\xdc\x59\xf0\xac\x2f\xd6\x49"
> + "\x6b\x85\x40\x08\x1f\xdf\x26\x25\x3b\x72\x44\xb0\xb8\x21\x2f\xb3"
> + "\xd7\x9b\x24\x30\x78\x26\x44\x07\xc3\x33\xd1\x4d\x03\x1b\xe1\xff"
> + "\xfd\xf5\x50\x8d\xca";
> +static const unsigned long lzma_compressed_size = 229;
> +
> +/* lzop -c /tmp/plain.txt > /tmp/plain.lzo */
> +static const char lzo_compressed[] =
> + "\x89\x4c\x5a\x4f\x00\x0d\x0a\x1a\x0a\x10\x30\x20\x60\x09\x40\x01"
> + "\x05\x03\x00\x00\x09\x00\x00\x81\xb4\x52\x09\x54\xf1\x00\x00\x00"
> + "\x00\x09\x70\x6c\x61\x69\x6e\x2e\x74\x78\x74\x65\xb1\x07\x9c\x00"
> + "\x00\x01\x5e\x00\x00\x01\x0f\xc3\xc7\x7a\xe0\x00\x16\x49\x20\x61"
> + "\x6d\x20\x61\x20\x68\x69\x67\x68\x6c\x79\x20\x63\x6f\x6d\x70\x72"
> + "\x65\x73\x73\x61\x62\x6c\x65\x20\x62\x69\x74\x20\x6f\x66\x20\x74"
> + "\x65\x78\x74\x2e\x0a\x20\x2f\x9c\x00\x00\x22\x54\x68\x65\x72\x65"
> + "\x20\x61\x72\x65\x20\x6d\x61\x6e\x79\x20\x6c\x69\x6b\x65\x20\x6d"
> + "\x65\x2c\x20\x62\x75\x74\x20\x74\x68\x69\x73\x20\x6f\x6e\x65\x20"
> + "\x69\x73\x20\x6d\x69\x6e\x65\x2e\x0a\x49\x66\x20\x49\x20\x77\x84"
> + "\x06\x0a\x6e\x79\x20\x73\x68\x6f\x72\x74\x65\x72\x2c\x20\x74\x90"
> + "\x08\x00\x08\x77\x6f\x75\x6c\x64\x6e\x27\x74\x20\x62\x65\x20\x6d"
> + "\x75\x63\x68\x20\x73\x65\x6e\x73\x65\x20\x69\x6e\x0a\xf8\x19\x02"
> + "\x69\x6e\x67\x20\x6d\x64\x02\x64\x06\x00\x5a\x20\x66\x69\x72\x73"
> + "\x74\x20\x70\x6c\x61\x63\x65\x2e\x20\x41\x74\x20\x6c\x65\x61\x73"
> + "\x74\x20\x77\x69\x74\x68\x20\x6c\x7a\x6f\x2c\x20\x61\x6e\x79\x77"
> + "\x61\x79\x2c\x0a\x77\x68\x69\x63\x68\x20\x61\x70\x70\x65\x61\x72"
> + "\x73\x20\x74\x6f\x20\x62\x65\x68\x61\x76\x65\x20\x70\x6f\x6f\x72"
> + "\x6c\x79\x20\x69\x6e\x20\x74\x68\x65\x20\x66\x61\x63\x65\x20\x6f"
> + "\x66\x20\x73\x68\x6f\x72\x74\x20\x74\x65\x78\x74\x0a\x6d\x65\x73"
> + "\x73\x61\x67\x65\x73\x2e\x0a\x11\x00\x00\x00\x00\x00\x00";
> +static const unsigned long lzo_compressed_size = 334;
> +
> +
> +#define TEST_BUFFER_SIZE 512
> +
> +typedef int (*mutate_func)(void *, unsigned long, void *, unsigned long,
> + unsigned long *);
> +
> +#ifdef CONFIG_GZIP_COMPRESSED
> +static int compress_using_gzip(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + int ret;
> + unsigned long inout_size = out_max;
> +
> + ret = gzip(out, &inout_size, in, in_size);
> + if (out_size)
> + *out_size = inout_size;
> +
> + return ret;
> +}
> +
> +static int uncompress_using_gzip(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + int ret;
> + unsigned long inout_size = in_size;
> +
> + ret = gunzip(out, out_max, in, &inout_size);
> + if (out_size)
> + *out_size = inout_size;
> +
> + return ret;
> +}
> +#endif /* CONFIG_GZIP_COMPRESSED */
> +
> +#ifdef CONFIG_BZIP2
> +static int compress_using_bzip2(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + /* There is no bzip2 compression in u-boot, so fake it. */
> + assert(in_size == strlen(plain));
> + assert(memcmp(plain, in, in_size) == 0);
> +
> + if (bzip2_compressed_size > out_max)
debug() here?
> + return -1;
> +
> + memcpy(out, bzip2_compressed, bzip2_compressed_size);
> + if (out_size)
> + *out_size = bzip2_compressed_size;
> +
> + return 0;
> +}
> +
> +static int uncompress_using_bzip2(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + int ret;
> + unsigned int inout_size = out_max;
> +
> + ret = BZ2_bzBuffToBuffDecompress(out, &inout_size, in, in_size,
> + CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
> + if (out_size)
> + *out_size = inout_size;
> +
> + return (ret != BZ_OK);
> +}
> +#endif /* CONFIG_BZIP2 */
> +
> +#ifdef CONFIG_LZMA
> +static int compress_using_lzma(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + /* There is no lzma compression in u-boot, so fake it. */
> + assert(in_size == strlen(plain));
> + assert(memcmp(plain, in, in_size) == 0);
> +
> + if (lzma_compressed_size > out_max)
debug() here?
> + return -1;
> +
> + memcpy(out, lzma_compressed, lzma_compressed_size);
> + if (out_size)
> + *out_size = lzma_compressed_size;
> +
> + return 0;
> +}
> +
> +static int uncompress_using_lzma(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + int ret;
> + SizeT inout_size = out_max;
> +
> + ret = lzmaBuffToBuffDecompress(out, &inout_size, in, in_size);
> + if (out_size)
> + *out_size = inout_size;
> +
> + return (ret != SZ_OK);
> +}
> +#endif /* CONFIG_LZMA */
> +
> +#ifdef CONFIG_LZO
> +static int compress_using_lzo(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + /* There is no lzo compression in u-boot, so fake it. */
> + assert(in_size == strlen(plain));
> + assert(memcmp(plain, in, in_size) == 0);
> +
> + if (lzo_compressed_size > out_max)
debug() here?
> + return -1;
> +
> + memcpy(out, lzo_compressed, lzo_compressed_size);
> + if (out_size)
> + *out_size = lzo_compressed_size;
> +
> + return 0;
> +}
> +
> +static int uncompress_using_lzo(void *in, unsigned long in_size,
> + void *out, unsigned long out_max,
> + unsigned long *out_size)
> +{
> + int ret;
> + size_t input_size = in_size;
> + size_t output_size = out_max;
> +
> + ret = lzop_decompress(in, input_size, out, &output_size);
> + if (out_size)
> + *out_size = output_size;
> +
> + return (ret != LZO_E_OK);
> +}
> +#endif /* CONFIG_LZO */
> +
> +#define errcheck(statement) if (!(statement)) { \
> + fprintf(stderr, "\tFailed: %s\n", #statement); \
> + ret = 1; \
> + goto out; \
> +}
> +
> +static int run_test(char *name, mutate_func compress, mutate_func uncompress)
> +{
> + ulong orig_size, compressed_size, uncompressed_size;
> + void *orig_buf;
> + void *compressed_buf = NULL;
> + void *uncompressed_buf = NULL;
> + void *compare_buf = NULL;
> + int ret;
> +
> + printf(" testing %s ...\n", name);
> +
> + orig_buf = (void *)plain;
> + orig_size = strlen(orig_buf); /* Trailing NULL not included. */
> + errcheck(orig_size > 0);
> +
> + compressed_size = uncompressed_size = TEST_BUFFER_SIZE;
> + compressed_buf = malloc(compressed_size);
> + errcheck(compressed_buf != NULL);
> + uncompressed_buf = malloc(uncompressed_size);
> + errcheck(uncompressed_buf != NULL);
> + compare_buf = malloc(uncompressed_size);
> + errcheck(compare_buf != NULL);
> +
> + /* Compress works as expected. */
> + printf("\torig_size:%lu\n", orig_size);
> + memset(compressed_buf, 'A', TEST_BUFFER_SIZE);
> + errcheck(compress(orig_buf, orig_size,
> + compressed_buf, compressed_size,
> + &compressed_size) == 0);
> + printf("\tcompressed_size:%lu\n", compressed_size);
> + errcheck(compressed_size > 0);
> + errcheck(compressed_size < orig_size);
> + errcheck(((char *)compressed_buf)[compressed_size-1] != 'A');
> + errcheck(((char *)compressed_buf)[compressed_size] == 'A');
> +
> + /* Uncompresses with space remaining. */
> + errcheck(uncompress(compressed_buf, compressed_size,
> + uncompressed_buf, uncompressed_size,
> + &uncompressed_size) == 0);
> + printf("\tuncompressed_size:%lu\n", uncompressed_size);
> + errcheck(uncompressed_size == orig_size);
> + errcheck(memcmp(orig_buf, uncompressed_buf, orig_size) == 0);
> +
> + /* Uncompresses with exactly the right size output buffer. */
> + memset(uncompressed_buf, 'A', TEST_BUFFER_SIZE);
> + errcheck(uncompress(compressed_buf, compressed_size,
> + uncompressed_buf, orig_size,
> + &uncompressed_size) == 0);
> + errcheck(uncompressed_size == orig_size);
> + errcheck(memcmp(orig_buf, uncompressed_buf, orig_size) == 0);
> + errcheck(((char *)uncompressed_buf)[orig_size] == 'A');
> +
> + /* Make sure compression does not over-run. */
> + memset(compare_buf, 'A', TEST_BUFFER_SIZE);
> + ret = compress(orig_buf, orig_size,
> + compare_buf, compressed_size - 1,
> + NULL);
> + errcheck(((char *)compare_buf)[compressed_size] == 'A');
> + errcheck(ret != 0);
> + printf("\tcompress does not overrun\n");
> +
> + /* Make sure decompression does not over-run. */
> + memset(compare_buf, 'A', TEST_BUFFER_SIZE);
> + ret = uncompress(compressed_buf, compressed_size,
> + compare_buf, uncompressed_size - 1,
> + NULL);
> + errcheck(((char *)compare_buf)[uncompressed_size - 1] == 'A');
> + errcheck(ret != 0);
> + printf("\tuncompress does not overrun\n");
> +
> + /* Got here, everything is fine. */
> + ret = 0;
> +
> +out:
> + printf(" %s: %s\n", name, ret == 0 ? "ok" : "FAILED");
> +
> + free(compare_buf);
> + free(uncompressed_buf);
> + free(compressed_buf);
> +
> + return ret;
> +}
> +
> +
> +static int do_test_compression(cmd_tbl_t *cmdtp, int flag, int argc,
> + char * const argv[])
> +{
> + int err = 0;
> +#ifdef CONFIG_GZIP_COMPRESSED
> + err += run_test("gzip", compress_using_gzip, uncompress_using_gzip);
> +#endif
I notice that this prints a message from the function - is that correct?
testing gzip ...
orig_size:350
compressed_size:206
uncompressed_size:350
Deflate need more space to compress left 350 bytes
^^^ message here
compress does not overrun
Error: inflate() returned -5
uncompress does not overrun
gzip: ok
> +#ifdef CONFIG_BZIP2
> + err += run_test("bzip2", compress_using_bzip2, uncompress_using_bzip2);
> +#endif
> +#ifdef CONFIG_LZMA
> + err += run_test("lzma", compress_using_lzma, uncompress_using_lzma);
> +#endif
> +#ifdef CONFIG_LZO
> + err += run_test("lzo", compress_using_lzo, uncompress_using_lzo);
> +#endif
> +
> + printf("test_compression %s\n", err == 0 ? "ok" : "FAILED");
> +
> + return err;
> +}
> +
> +U_BOOT_CMD(
> + test_compression, 5, 1, do_test_compression,
> + "Basic test of compressors: "
> +#ifdef CONFIG_GZIP_COMPRESSED
> + "gzip "
> +#endif
> +#ifdef CONFIG_BZIP2
> + "bzip2 "
> +#endif
> +#ifdef CONFIG_LZMA
> + "lzma "
> +#endif
> +#ifdef CONFIG_LZO
> + "lzo "
> +#endif
> + ,
> + ""
> +);
> --
> 1.7.9.5
>
Regards,
Simon
More information about the U-Boot
mailing list