[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 <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(u64 expectedsize)
{
	putc('\n');
}

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

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