[J-u-boot.git] / lib / gunzip.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000-2006
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 */

#include <common.h>
#include <blk.h>
#include <command.h>
#include <console.h>
#include <div64.h>
#include <gzip.h>
#include <image.h>
#include <malloc.h>
#include <memalign.h>
#include <u-boot/crc.h>
#include <watchdog.h>
#include <u-boot/zlib.h>

#define HEADER0			'\x1f'
#define HEADER1			'\x8b'
#define	ZALLOC_ALIGNMENT	16
#define HEAD_CRC		2
#define EXTRA_FIELD		4
#define ORIG_NAME		8
#define COMMENT			0x10
#define RESERVED		0xe0
#define DEFLATED		8

void *gzalloc(void *x, unsigned items, unsigned size)
{
	void *p;

	size *= items;
	size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1);

	p = malloc (size);

	return (p);
}

void gzfree(void *x, void *addr, unsigned nb)
{
	free (addr);
}

int gzip_parse_header(const unsigned char *src, unsigned long len)
{
	int i, flags;

	/* skip header */
	i = 10;
	flags = src[3];
	if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
		puts ("Error: Bad gzipped data\n");
		return (-1);
	}
	if ((flags & EXTRA_FIELD) != 0)
		i = 12 + src[10] + (src[11] << 8);
	if ((flags & ORIG_NAME) != 0)
		while (src[i++] != 0)
			;
	if ((flags & COMMENT) != 0)
		while (src[i++] != 0)
			;
	if ((flags & HEAD_CRC) != 0)
		i += 2;
	if (i >= len) {
		puts ("Error: gunzip out of data in header\n");
		return (-1);
	}
	return i;
}

int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp)
{
	int offset = gzip_parse_header(src, *lenp);

	if (offset < 0)
		return offset;

	return zunzip(dst, dstlen, src, lenp, 1, offset);
}

#ifdef CONFIG_CMD_UNZIP
__weak
void gzwrite_progress_init(ulong expectedsize)
{
	putc('\n');
}

__weak
void gzwrite_progress(int iteration,
		     ulong bytes_written,
		     ulong total_bytes)
{
	if (0 == (iteration & 3))
		printf("%lu/%lu\r", bytes_written, total_bytes);
}

__weak
void gzwrite_progress_finish(int returnval,
			     ulong bytes_written,
			     ulong total_bytes,
			     u32 expected_crc,
			     u32 calculated_crc)
{
	if (0 == returnval) {
		printf("\n\t%lu bytes, crc 0x%08x\n",
		       total_bytes, calculated_crc);
	} else {
		printf("\n\tuncompressed %lu of %lu\n"
		       "\tcrcs == 0x%08x/0x%08x\n",
		       bytes_written, total_bytes,
		       expected_crc, calculated_crc);
	}
}

int gzwrite(unsigned char *src, int len,
	    struct blk_desc *dev,
	    unsigned long szwritebuf,
	    ulong startoffs,
	    ulong szexpected)
{
	int i, flags;
	z_stream s;
	int r = 0;
	unsigned char *writebuf;
	unsigned crc = 0;
	ulong totalfilled = 0;
	lbaint_t blksperbuf, outblock;
	u32 expected_crc;
	u32 payload_size;
	int iteration = 0;

	if (!szwritebuf ||
	    (szwritebuf % dev->blksz) ||
	    (szwritebuf < dev->blksz)) {
		printf("%s: size %lu not a multiple of %lu\n",
		       __func__, szwritebuf, dev->blksz);
		return -1;
	}

	if (startoffs & (dev->blksz-1)) {
		printf("%s: start offset %lu not a multiple of %lu\n",
		       __func__, startoffs, dev->blksz);
		return -1;
	}

	blksperbuf = szwritebuf / dev->blksz;
	outblock = lldiv(startoffs, dev->blksz);

	/* skip header */
	i = 10;
	flags = src[3];
	if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
		puts("Error: Bad gzipped data\n");
		return -1;
	}
	if ((flags & EXTRA_FIELD) != 0)
		i = 12 + src[10] + (src[11] << 8);
	if ((flags & ORIG_NAME) != 0)
		while (src[i++] != 0)
			;
	if ((flags & COMMENT) != 0)
		while (src[i++] != 0)
			;
	if ((flags & HEAD_CRC) != 0)
		i += 2;

	if (i >= len-8) {
		puts("Error: gunzip out of data in header");
		return -1;
	}

	payload_size = len - i - 8;

	memcpy(&expected_crc, src + len - 8, sizeof(expected_crc));
	expected_crc = le32_to_cpu(expected_crc);
	u32 szuncompressed;
	memcpy(&szuncompressed, src + len - 4, sizeof(szuncompressed));
	if (szexpected == 0) {
		szexpected = le32_to_cpu(szuncompressed);
	} else if (szuncompressed != (u32)szexpected) {
		printf("size of %lx doesn't match trailer low bits %x\n",
		       szexpected, szuncompressed);
		return -1;
	}
	if (lldiv(szexpected, dev->blksz) > (dev->lba - outblock)) {
		printf("%s: uncompressed size %lu exceeds device size\n",
		       __func__, szexpected);
		return -1;
	}

	gzwrite_progress_init(szexpected);

	s.zalloc = gzalloc;
	s.zfree = gzfree;

	r = inflateInit2(&s, -MAX_WBITS);
	if (r != Z_OK) {
		printf("Error: inflateInit2() returned %d\n", r);
		return -1;
	}

	s.next_in = src + i;
	s.avail_in = payload_size+8;
	writebuf = (unsigned char *)malloc_cache_aligned(szwritebuf);

	/* decompress until deflate stream ends or end of file */
	do {
		if (s.avail_in == 0) {
			printf("%s: weird termination with result %d\n",
			       __func__, r);
			break;
		}

		/* run inflate() on input until output buffer not full */
		do {
			unsigned long blocks_written;
			int numfilled;
			lbaint_t writeblocks;

			s.avail_out = szwritebuf;
			s.next_out = writebuf;
			r = inflate(&s, Z_SYNC_FLUSH);
			if ((r != Z_OK) &&
			    (r != Z_STREAM_END)) {
				printf("Error: inflate() returned %d\n", r);
				goto out;
			}
			numfilled = szwritebuf - s.avail_out;
			crc = crc32(crc, writebuf, numfilled);
			totalfilled += numfilled;
			if (numfilled < szwritebuf) {
				writeblocks = (numfilled+dev->blksz-1)
						/ dev->blksz;
				memset(writebuf+numfilled, 0,
				       dev->blksz-(numfilled%dev->blksz));
			} else {
				writeblocks = blksperbuf;
			}

			gzwrite_progress(iteration++,
					 totalfilled,
					 szexpected);
			blocks_written = blk_dwrite(dev, outblock,
						    writeblocks, writebuf);
			outblock += blocks_written;
			if (ctrlc()) {
				puts("abort\n");
				goto out;
			}
			WATCHDOG_RESET();
		} while (s.avail_out == 0);
		/* done when inflate() says it's done */
	} while (r != Z_STREAM_END);

	if ((szexpected != totalfilled) ||
	    (crc != expected_crc))
		r = -1;
	else
		r = 0;

out:
	gzwrite_progress_finish(r, totalfilled, szexpected,
				expected_crc, crc);
	free(writebuf);
	inflateEnd(&s);

	return r;
}
#endif

/*
 * Uncompress blocks compressed with zlib without headers
 */
int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
						int stoponerr, int offset)
{
	z_stream s;
	int err = 0;
	int r;

	s.zalloc = gzalloc;
	s.zfree = gzfree;

	r = inflateInit2(&s, -MAX_WBITS);
	if (r != Z_OK) {
		printf("Error: inflateInit2() returned %d\n", r);
		return -1;
	}
	s.next_in = src + offset;
	s.avail_in = *lenp - offset;
	s.next_out = dst;
	s.avail_out = dstlen;
	do {
		r = inflate(&s, Z_FINISH);
		if (stoponerr == 1 && r != Z_STREAM_END &&
		    (s.avail_in == 0 || s.avail_out == 0 || r != Z_BUF_ERROR)) {
			printf("Error: inflate() returned %d\n", r);
			err = -1;
			break;
		}
	} while (r == Z_BUF_ERROR);
	*lenp = s.next_out - (unsigned char *) dst;
	inflateEnd(&s);

	return err;
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
321359f2 MB	2	/*
	3	* (C) Copyright 2000-2006
	4	* Wolfgang Denk, DENX Software Engineering, [email protected].
321359f2 MB	5	*/
	6
	7	#include <common.h>
e6f6f9e6	8	#include <blk.h>
321359f2	9	#include <command.h>
24b852a7	10	#include <console.h>
0c670fc1 SG	11	#include <div64.h>
0c670fc1 SG	12	#include <gzip.h>
321359f2 MB	13	#include <image.h>
321359f2 MB	14	#include <malloc.h>
d025021e	15	#include <memalign.h>
3db71108	16	#include <u-boot/crc.h>
0c670fc1	17	#include <watchdog.h>
a31e091a	18	#include <u-boot/zlib.h>
321359f2	19
918e9ebb EN	20	#define HEADER0 '\x1f'
918e9ebb EN	21	#define HEADER1 '\x8b'
321359f2 MB	22	#define ZALLOC_ALIGNMENT 16
	23	#define HEAD_CRC 2
	24	#define EXTRA_FIELD 4
	25	#define ORIG_NAME 8
	26	#define COMMENT 0x10
	27	#define RESERVED 0xe0
	28	#define DEFLATED 8
	29
e3ed0575	30	void gzalloc(void x, unsigned items, unsigned size)
321359f2 MB	31	{
	32	void *p;
	33
	34	size *= items;
	35	size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1);
	36
	37	p = malloc (size);
	38
	39	return (p);
	40	}
	41
e3ed0575	42	void gzfree(void x, void addr, unsigned nb)
321359f2 MB	43	{
	44	free (addr);
	45	}
	46
376ddf9d	47	int gzip_parse_header(const unsigned char *src, unsigned long len)
321359f2	48	{
35f6a943	49	int i, flags;
321359f2 MB	50
	51	/* skip header */
	52	i = 10;
	53	flags = src[3];
	54	if (src[2] != DEFLATED \|\| (flags & RESERVED) != 0) {
	55	puts ("Error: Bad gzipped data\n");
	56	return (-1);
	57	}
	58	if ((flags & EXTRA_FIELD) != 0)
	59	i = 12 + src[10] + (src[11] << 8);
	60	if ((flags & ORIG_NAME) != 0)
	61	while (src[i++] != 0)
	62	;
	63	if ((flags & COMMENT) != 0)
	64	while (src[i++] != 0)
	65	;
	66	if ((flags & HEAD_CRC) != 0)
	67	i += 2;
376ddf9d	68	if (i >= len) {
321359f2 MB	69	puts ("Error: gunzip out of data in header\n");
	70	return (-1);
	71	}
376ddf9d JJH	72	return i;
	73	}
	74
	75	int gunzip(void dst, int dstlen, unsigned char src, unsigned long *lenp)
	76	{
	77	int offset = gzip_parse_header(src, *lenp);
	78
	79	if (offset < 0)
	80	return offset;
321359f2	81
376ddf9d	82	return zunzip(dst, dstlen, src, lenp, 1, offset);
35f6a943 RR	83	}
35f6a943 RR	84
1811b7d3	85	#ifdef CONFIG_CMD_UNZIP
918e9ebb	86	__weak
5a4f10d7	87	void gzwrite_progress_init(ulong expectedsize)
918e9ebb EN	88	{
	89	putc('\n');
	90	}
	91
	92	__weak
	93	void gzwrite_progress(int iteration,
5a4f10d7 SG	94	ulong bytes_written,
5a4f10d7 SG	95	ulong total_bytes)
918e9ebb EN	96	{
918e9ebb EN	97	if (0 == (iteration & 3))
5a4f10d7	98	printf("%lu/%lu\r", bytes_written, total_bytes);
918e9ebb EN	99	}
	100
	101	__weak
	102	void gzwrite_progress_finish(int returnval,
5a4f10d7 SG	103	ulong bytes_written,
5a4f10d7 SG	104	ulong total_bytes,
918e9ebb EN	105	u32 expected_crc,
	106	u32 calculated_crc)
	107	{
	108	if (0 == returnval) {
5a4f10d7	109	printf("\n\t%lu bytes, crc 0x%08x\n",
918e9ebb EN	110	total_bytes, calculated_crc);
918e9ebb EN	111	} else {
5a4f10d7	112	printf("\n\tuncompressed %lu of %lu\n"
918e9ebb EN	113	"\tcrcs == 0x%08x/0x%08x\n",
	114	bytes_written, total_bytes,
	115	expected_crc, calculated_crc);
	116	}
	117	}
	118
	119	int gzwrite(unsigned char *src, int len,
4101f687	120	struct blk_desc *dev,
918e9ebb	121	unsigned long szwritebuf,
5a4f10d7 SG	122	ulong startoffs,
5a4f10d7 SG	123	ulong szexpected)
918e9ebb EN	124	{
	125	int i, flags;
	126	z_stream s;
	127	int r = 0;
	128	unsigned char *writebuf;
	129	unsigned crc = 0;
5a4f10d7	130	ulong totalfilled = 0;
918e9ebb EN	131	lbaint_t blksperbuf, outblock;
	132	u32 expected_crc;
	133	u32 payload_size;
	134	int iteration = 0;
	135
	136	if (!szwritebuf \|\|
	137	(szwritebuf % dev->blksz) \|\|
	138	(szwritebuf < dev->blksz)) {
	139	printf("%s: size %lu not a multiple of %lu\n",
	140	__func__, szwritebuf, dev->blksz);
	141	return -1;
	142	}
	143
	144	if (startoffs & (dev->blksz-1)) {
5a4f10d7	145	printf("%s: start offset %lu not a multiple of %lu\n",
918e9ebb EN	146	__func__, startoffs, dev->blksz);
	147	return -1;
	148	}
	149
	150	blksperbuf = szwritebuf / dev->blksz;
	151	outblock = lldiv(startoffs, dev->blksz);
	152
	153	/* skip header */
	154	i = 10;
	155	flags = src[3];
	156	if (src[2] != DEFLATED \|\| (flags & RESERVED) != 0) {
	157	puts("Error: Bad gzipped data\n");
	158	return -1;
	159	}
	160	if ((flags & EXTRA_FIELD) != 0)
	161	i = 12 + src[10] + (src[11] << 8);
	162	if ((flags & ORIG_NAME) != 0)
	163	while (src[i++] != 0)
	164	;
	165	if ((flags & COMMENT) != 0)
	166	while (src[i++] != 0)
	167	;
	168	if ((flags & HEAD_CRC) != 0)
	169	i += 2;
	170
	171	if (i >= len-8) {
	172	puts("Error: gunzip out of data in header");
	173	return -1;
	174	}
	175
	176	payload_size = len - i - 8;
	177
	178	memcpy(&expected_crc, src + len - 8, sizeof(expected_crc));
	179	expected_crc = le32_to_cpu(expected_crc);
	180	u32 szuncompressed;
	181	memcpy(&szuncompressed, src + len - 4, sizeof(szuncompressed));
	182	if (szexpected == 0) {
	183	szexpected = le32_to_cpu(szuncompressed);
	184	} else if (szuncompressed != (u32)szexpected) {
5a4f10d7	185	printf("size of %lx doesn't match trailer low bits %x\n",
918e9ebb EN	186	szexpected, szuncompressed);
	187	return -1;
	188	}
	189	if (lldiv(szexpected, dev->blksz) > (dev->lba - outblock)) {
5a4f10d7	190	printf("%s: uncompressed size %lu exceeds device size\n",
918e9ebb EN	191	__func__, szexpected);
	192	return -1;
	193	}
	194
	195	gzwrite_progress_init(szexpected);
	196
	197	s.zalloc = gzalloc;
	198	s.zfree = gzfree;
	199
	200	r = inflateInit2(&s, -MAX_WBITS);
	201	if (r != Z_OK) {
	202	printf("Error: inflateInit2() returned %d\n", r);
	203	return -1;
	204	}
	205
	206	s.next_in = src + i;
	207	s.avail_in = payload_size+8;
d025021e	208	writebuf = (unsigned char *)malloc_cache_aligned(szwritebuf);
918e9ebb EN	209
	210	/* decompress until deflate stream ends or end of file */
	211	do {
	212	if (s.avail_in == 0) {
	213	printf("%s: weird termination with result %d\n",
	214	__func__, r);
	215	break;
	216	}
	217
	218	/* run inflate() on input until output buffer not full */
	219	do {
	220	unsigned long blocks_written;
	221	int numfilled;
	222	lbaint_t writeblocks;
	223
	224	s.avail_out = szwritebuf;
	225	s.next_out = writebuf;
	226	r = inflate(&s, Z_SYNC_FLUSH);
	227	if ((r != Z_OK) &&
	228	(r != Z_STREAM_END)) {
	229	printf("Error: inflate() returned %d\n", r);
	230	goto out;
	231	}
	232	numfilled = szwritebuf - s.avail_out;
	233	crc = crc32(crc, writebuf, numfilled);
	234	totalfilled += numfilled;
	235	if (numfilled < szwritebuf) {
	236	writeblocks = (numfilled+dev->blksz-1)
	237	/ dev->blksz;
	238	memset(writebuf+numfilled, 0,
	239	dev->blksz-(numfilled%dev->blksz));
	240	} else {
	241	writeblocks = blksperbuf;
	242	}
	243
	244	gzwrite_progress(iteration++,
	245	totalfilled,
	246	szexpected);
6a3bf3e5 EN	247	blocks_written = blk_dwrite(dev, outblock,
6a3bf3e5 EN	248	writeblocks, writebuf);
918e9ebb EN	249	outblock += blocks_written;
	250	if (ctrlc()) {
	251	puts("abort\n");
	252	goto out;
	253	}
	254	WATCHDOG_RESET();
	255	} while (s.avail_out == 0);
	256	/* done when inflate() says it's done */
	257	} while (r != Z_STREAM_END);
	258
	259	if ((szexpected != totalfilled) \|\|
	260	(crc != expected_crc))
	261	r = -1;
	262	else
	263	r = 0;
	264
	265	out:
	266	gzwrite_progress_finish(r, totalfilled, szexpected,
	267	expected_crc, crc);
	268	free(writebuf);
	269	inflateEnd(&s);
	270
	271	return r;
	272	}
1811b7d3	273	#endif
918e9ebb	274
35f6a943 RR	275	/*
	276	* Uncompress blocks compressed with zlib without headers
	277	*/
	278	int zunzip(void dst, int dstlen, unsigned char src, unsigned long *lenp,
	279	int stoponerr, int offset)
	280	{
	281	z_stream s;
9c55c54f	282	int err = 0;
35f6a943 RR	283	int r;
35f6a943 RR	284
e3ed0575 MF	285	s.zalloc = gzalloc;
e3ed0575 MF	286	s.zfree = gzfree;
321359f2 MB	287
	288	r = inflateInit2(&s, -MAX_WBITS);
	289	if (r != Z_OK) {
918e9ebb	290	printf("Error: inflateInit2() returned %d\n", r);
35f6a943	291	return -1;
321359f2	292	}
35f6a943 RR	293	s.next_in = src + offset;
35f6a943 RR	294	s.avail_in = *lenp - offset;
321359f2 MB	295	s.next_out = dst;
321359f2 MB	296	s.avail_out = dstlen;
f039ada5 CR	297	do {
f039ada5 CR	298	r = inflate(&s, Z_FINISH);
b75650d8	299	if (stoponerr == 1 && r != Z_STREAM_END &&
19346657	300	(s.avail_in == 0 \|\| s.avail_out == 0 \|\| r != Z_BUF_ERROR)) {
f039ada5	301	printf("Error: inflate() returned %d\n", r);
9c55c54f SG	302	err = -1;
9c55c54f SG	303	break;
f039ada5	304	}
f039ada5	305	} while (r == Z_BUF_ERROR);
321359f2 MB	306	lenp = s.next_out - (unsigned char ) dst;
	307	inflateEnd(&s);
	308
9c55c54f	309	return err;
321359f2	310	}