aboutsummaryrefslogtreecommitdiff
path: root/src/image/zlib.c
blob: a42c47e1ba809e8adbb7cf03e83c20fa56ac867a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 * Copyright (C) 2021 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * 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 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., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * You can also choose to distribute this program under the terms of
 * the Unmodified Binary Distribution Licence (as given in the file
 * COPYING.UBDL), provided that you have satisfied its requirements.
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

#include <stdlib.h>
#include <errno.h>
#include <assert.h>
#include <ipxe/deflate.h>
#include <ipxe/uaccess.h>
#include <ipxe/image.h>
#include <ipxe/zlib.h>

/** @file
 *
 * zlib compressed images
 *
 */

/**
 * Extract compressed data to image
 *
 * @v format		Compression format code
 * @v in		Compressed input chunk
 * @v extracted		Extracted image
 * @ret rc		Return status code
 */
int zlib_deflate ( enum deflate_format format, struct deflate_chunk *in,
		   struct image *extracted ) {
	struct deflate *deflate;
	struct deflate_chunk out;
	int rc;

	/* Allocate and initialise decompressor */
	deflate = zalloc ( sizeof ( *deflate ) );
	if ( ! deflate ) {
		rc = -ENOMEM;
		goto err_alloc;
	}

	/* Decompress data, (re)allocating if necessary */
	while ( 1 ) {

		/* (Re)initialise decompressor */
		deflate_init ( deflate, format );

		/* (Re)initialise input chunk */
		in->offset = 0;

		/* Initialise output chunk */
		deflate_chunk_init ( &out, extracted->data, 0, extracted->len );

		/* Decompress data */
		if ( ( rc = deflate_inflate ( deflate, in, &out ) ) != 0 ) {
			DBGC ( extracted, "ZLIB %p could not decompress: %s\n",
			       extracted, strerror ( rc ) );
			goto err_inflate;
		}

		/* Check that decompression is valid */
		if ( ! deflate_finished ( deflate ) ) {
			DBGC ( extracted, "ZLIB %p decompression incomplete\n",
			       extracted );
			rc = -EINVAL;
			goto err_unfinished;
		}

		/* Finish if output image size was correct */
		if ( out.offset == extracted->len )
			break;

		/* Otherwise, resize output image and retry */
		if ( ( rc = image_set_len ( extracted, out.offset ) ) != 0 ) {
			DBGC ( extracted, "ZLIB %p could not resize: %s\n",
			       extracted, strerror ( rc ) );
			goto err_set_size;
		}
	}

	/* Success */
	rc = 0;

 err_set_size:
 err_unfinished:
 err_inflate:
	free ( deflate );
 err_alloc:
	return rc;
}

/**
 * Extract zlib image
 *
 * @v image		Image
 * @v extracted		Extracted image
 * @ret rc		Return status code
 */
static int zlib_extract ( struct image *image, struct image *extracted ) {
	struct deflate_chunk in;
	int rc;

	/* Initialise input chunk */
	deflate_chunk_init ( &in, image->data, 0, image->len );

	/* Decompress image */
	if ( ( rc = zlib_deflate ( DEFLATE_ZLIB, &in, extracted ) ) != 0 )
		return rc;

	return 0;
}

/**
 * Probe zlib image
 *
 * @v image		zlib image
 * @ret rc		Return status code
 */
static int zlib_probe ( struct image *image ) {
	union zlib_magic magic;

	/* Sanity check */
	if ( image->len < sizeof ( magic ) ) {
		DBGC ( image, "ZLIB %p image too short\n", image );
		return -ENOEXEC;
	}

	/* Check magic header */
	copy_from_user ( &magic, image->data, 0, sizeof ( magic ) );
	if ( ! zlib_magic_is_valid ( &magic ) ) {
		DBGC ( image, "ZLIB %p invalid magic data\n", image );
		return -ENOEXEC;
	}

	return 0;
}

/** zlib image type */
struct image_type zlib_image_type __image_type ( PROBE_NORMAL ) = {
	.name = "zlib",
	.probe = zlib_probe,
	.extract = zlib_extract,
	.exec = image_extract_exec,
};