Got Mirror

Blob

Date:: Tue Mar 17 13:12:33 2020 UTC
Message:: allow inflate(3) to consume all mapped data at once in got_inflate_read_mmap()
Actions:: History | Blame | Raw File
1 /*
2  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #include <sys/queue.h>
18 
19 #include <errno.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <sha1.h>
24 #include <zlib.h>
25 #include <time.h>
26 
27 #include "got_error.h"
28 #include "got_object.h"
29 #include "got_path.h"
30 
31 #include "got_lib_inflate.h"
32 
33 #ifndef MIN
34 #define	MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
35 #endif
36 
37 const struct got_error *
38 got_inflate_init(struct got_inflate_buf *zb, uint8_t *outbuf, size_t bufsize)
39 {
40 	const struct got_error *err = NULL;
41 	int zerr;
42 
43 	memset(&zb->z, 0, sizeof(zb->z));
44 
45 	zb->z.zalloc = Z_NULL;
46 	zb->z.zfree = Z_NULL;
47 	zerr = inflateInit(&zb->z);
48 	if (zerr != Z_OK) {
49 		if  (zerr == Z_ERRNO)
50 			return got_error_from_errno("inflateInit");
51 		if  (zerr == Z_MEM_ERROR) {
52 			errno = ENOMEM;
53 			return got_error_from_errno("inflateInit");
54 		}
55 		return got_error(GOT_ERR_DECOMPRESSION);
56 	}
57 
58 	zb->inlen = zb->outlen = bufsize;
59 
60 	zb->inbuf = calloc(1, zb->inlen);
61 	if (zb->inbuf == NULL) {
62 		err = got_error_from_errno("calloc");
63 		goto done;
64 	}
65 
66 	zb->flags = 0;
67 	if (outbuf == NULL) {
68 		zb->outbuf = calloc(1, zb->outlen);
69 		if (zb->outbuf == NULL) {
70 			err = got_error_from_errno("calloc");
71 			goto done;
72 		}
73 		zb->flags |= GOT_INFLATE_F_OWN_OUTBUF;
74 	} else
75 		zb->outbuf = outbuf;
76 
77 done:
78 	if (err)
79 		got_inflate_end(zb);
80 	return err;
81 }
82 
83 const struct got_error *
84 got_inflate_read(struct got_inflate_buf *zb, FILE *f, size_t *outlenp)
85 {
86 	size_t last_total_out = zb->z.total_out;
87 	z_stream *z = &zb->z;
88 	int ret = Z_ERRNO;
89 
90 	z->next_out = zb->outbuf;
91 	z->avail_out = zb->outlen;
92 
93 	*outlenp = 0;
94 	do {
95 		if (z->avail_in == 0) {
96 			size_t n = fread(zb->inbuf, 1, zb->inlen, f);
97 			if (n == 0) {
98 				if (ferror(f))
99 					return got_ferror(f, GOT_ERR_IO);
100 				/* EOF */
101 				ret = Z_STREAM_END;
102 				break;
103 			}
104 			z->next_in = zb->inbuf;
105 			z->avail_in = n;
106 		}
107 		ret = inflate(z, Z_SYNC_FLUSH);
108 	} while (ret == Z_OK && z->avail_out > 0);
109 
110 	if (ret == Z_OK || ret == Z_BUF_ERROR) {
111 		zb->flags |= GOT_INFLATE_F_HAVE_MORE;
112 	} else {
113 		if (ret != Z_STREAM_END)
114 			return got_error(GOT_ERR_DECOMPRESSION);
115 		zb->flags &= ~GOT_INFLATE_F_HAVE_MORE;
116 	}
117 
118 	*outlenp = z->total_out - last_total_out;
119 	return NULL;
120 }
121 
122 const struct got_error *
123 got_inflate_read_fd(struct got_inflate_buf *zb, int fd, size_t *outlenp)
124 {
125 	size_t last_total_out = zb->z.total_out;
126 	z_stream *z = &zb->z;
127 	int ret = Z_ERRNO;
128 
129 	z->next_out = zb->outbuf;
130 	z->avail_out = zb->outlen;
131 
132 	*outlenp = 0;
133 	do {
134 		if (z->avail_in == 0) {
135 			ssize_t n = read(fd, zb->inbuf, zb->inlen);
136 			if (n < 0)
137 				return got_error_from_errno("read");
138 			else if (n == 0) {
139 				/* EOF */
140 				ret = Z_STREAM_END;
141 				break;
142 			}
143 			z->next_in = zb->inbuf;
144 			z->avail_in = n;
145 		}
146 		ret = inflate(z, Z_SYNC_FLUSH);
147 	} while (ret == Z_OK && z->avail_out > 0);
148 
149 	if (ret == Z_OK || ret == Z_BUF_ERROR) {
150 		zb->flags |= GOT_INFLATE_F_HAVE_MORE;
151 	} else {
152 		if (ret != Z_STREAM_END)
153 			return got_error(GOT_ERR_DECOMPRESSION);
154 		zb->flags &= ~GOT_INFLATE_F_HAVE_MORE;
155 	}
156 
157 	*outlenp = z->total_out - last_total_out;
158 	return NULL;
159 }
160 
161 const struct got_error *
162 got_inflate_read_mmap(struct got_inflate_buf *zb, uint8_t *map, size_t offset,
163     size_t len, size_t *outlenp, size_t *consumed)
164 {
165 	size_t last_total_out = zb->z.total_out;
166 	z_stream *z = &zb->z;
167 	int ret = Z_ERRNO;
168 
169 	z->next_out = zb->outbuf;
170 	z->avail_out = zb->outlen;
171 
172 	*outlenp = 0;
173 	*consumed = 0;
174 
175 	do {
176 		size_t last_total_in = zb->z.total_in;
177 		if (z->avail_in == 0) {
178 			if (len == 0) {
179 				/* EOF */
180 				ret = Z_STREAM_END;
181 				break;
182 			}
183 			z->next_in = map + offset + *consumed;
184 			z->avail_in = len - *consumed;
185 		}
186 		ret = inflate(z, Z_SYNC_FLUSH);
187 		*consumed += z->total_in - last_total_in;
188 	} while (ret == Z_OK && z->avail_out > 0);
189 
190 	if (ret == Z_OK || ret == Z_BUF_ERROR) {
191 		zb->flags |= GOT_INFLATE_F_HAVE_MORE;
192 	} else {
193 		if (ret != Z_STREAM_END)
194 			return got_error(GOT_ERR_DECOMPRESSION);
195 		zb->flags &= ~GOT_INFLATE_F_HAVE_MORE;
196 	}
197 
198 	*outlenp = z->total_out - last_total_out;
199 	return NULL;
200 }
201 
202 void
203 got_inflate_end(struct got_inflate_buf *zb)
204 {
205 	free(zb->inbuf);
206 	if (zb->flags & GOT_INFLATE_F_OWN_OUTBUF)
207 		free(zb->outbuf);
208 	inflateEnd(&zb->z);
209 }
210 
211 const struct got_error *
212 got_inflate_to_mem(uint8_t **outbuf, size_t *outlen, FILE *f)
213 {
214 	const struct got_error *err;
215 	size_t avail;
216 	struct got_inflate_buf zb;
217 	void *newbuf;
218 	int nbuf = 1;
219 
220 	*outbuf = malloc(GOT_INFLATE_BUFSIZE);
221 	if (*outbuf == NULL)
222 		return got_error_from_errno("malloc");
223 	err = got_inflate_init(&zb, *outbuf, GOT_INFLATE_BUFSIZE);
224 	if (err)
225 		return err;
226 
227 	*outlen = 0;
228 
229 	do {
230 		err = got_inflate_read(&zb, f, &avail);
231 		if (err)
232 			goto done;
233 		*outlen += avail;
234 		if (zb.flags & GOT_INFLATE_F_HAVE_MORE) {
235 			newbuf = reallocarray(*outbuf, ++nbuf,
236 			   GOT_INFLATE_BUFSIZE);
237 			if (newbuf == NULL) {
238 				err = got_error_from_errno("reallocarray");
239 				free(*outbuf);
240 				*outbuf = NULL;
241 				*outlen = 0;
242 				goto done;
243 			}
244 			*outbuf = newbuf;
245 			zb.outbuf = newbuf + *outlen;
246 			zb.outlen = (nbuf * GOT_INFLATE_BUFSIZE) - *outlen;
247 		}
248 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
249 
250 done:
251 	got_inflate_end(&zb);
252 	return err;
253 }
254 
255 const struct got_error *
256 got_inflate_to_mem_fd(uint8_t **outbuf, size_t *outlen, int infd)
257 {
258 	const struct got_error *err;
259 	size_t avail;
260 	struct got_inflate_buf zb;
261 	void *newbuf;
262 	int nbuf = 1;
263 
264 	*outbuf = malloc(GOT_INFLATE_BUFSIZE);
265 	if (*outbuf == NULL)
266 		return got_error_from_errno("malloc");
267 	err = got_inflate_init(&zb, *outbuf, GOT_INFLATE_BUFSIZE);
268 	if (err)
269 		goto done;
270 
271 	*outlen = 0;
272 
273 	do {
274 		err = got_inflate_read_fd(&zb, infd, &avail);
275 		if (err)
276 			goto done;
277 		*outlen += avail;
278 		if (zb.flags & GOT_INFLATE_F_HAVE_MORE) {
279 			newbuf = reallocarray(*outbuf, ++nbuf,
280 			    GOT_INFLATE_BUFSIZE);
281 			if (newbuf == NULL) {
282 				err = got_error_from_errno("reallocarray");
283 				free(*outbuf);
284 				*outbuf = NULL;
285 				*outlen = 0;
286 				goto done;
287 			}
288 			*outbuf = newbuf;
289 			zb.outbuf = newbuf + *outlen;
290 			zb.outlen = (nbuf * GOT_INFLATE_BUFSIZE) - *outlen;
291 		}
292 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
293 
294 done:
295 	got_inflate_end(&zb);
296 	return err;
297 }
298 
299 const struct got_error *
300 got_inflate_to_mem_mmap(uint8_t **outbuf, size_t *outlen, uint8_t *map,
301     size_t offset, size_t len)
302 {
303 	const struct got_error *err;
304 	size_t avail, consumed;
305 	struct got_inflate_buf zb;
306 	void *newbuf;
307 	int nbuf = 1;
308 
309 	*outbuf = malloc(GOT_INFLATE_BUFSIZE);
310 	if (*outbuf == NULL)
311 		return got_error_from_errno("malloc");
312 	err = got_inflate_init(&zb, *outbuf, GOT_INFLATE_BUFSIZE);
313 	if (err) {
314 		free(*outbuf);
315 		*outbuf = NULL;
316 		return err;
317 	}
318 
319 	*outlen = 0;
320 
321 	do {
322 		err = got_inflate_read_mmap(&zb, map, offset, len, &avail,
323 		    &consumed);
324 		if (err)
325 			goto done;
326 		offset += consumed;
327 		len -= consumed;
328 		*outlen += avail;
329 		if (len == 0)
330 			break;
331 		if (zb.flags & GOT_INFLATE_F_HAVE_MORE) {
332 			newbuf = reallocarray(*outbuf, ++nbuf,
333 			    GOT_INFLATE_BUFSIZE);
334 			if (newbuf == NULL) {
335 				err = got_error_from_errno("reallocarray");
336 				free(*outbuf);
337 				*outbuf = NULL;
338 				*outlen = 0;
339 				goto done;
340 			}
341 			*outbuf = newbuf;
342 			zb.outbuf = newbuf + *outlen;
343 			zb.outlen = (nbuf * GOT_INFLATE_BUFSIZE) - *outlen;
344 		}
345 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
346 done:
347 	got_inflate_end(&zb);
348 	return err;
349 }
350 
351 const struct got_error *
352 got_inflate_to_fd(size_t *outlen, FILE *infile, int outfd)
353 {
354 	const struct got_error *err = NULL;
355 	size_t avail;
356 	struct got_inflate_buf zb;
357 
358 	err = got_inflate_init(&zb, NULL, GOT_INFLATE_BUFSIZE);
359 	if (err)
360 		goto done;
361 
362 	*outlen = 0;
363 
364 	do {
365 		err = got_inflate_read(&zb, infile, &avail);
366 		if (err)
367 			goto done;
368 		if (avail > 0) {
369 			ssize_t n;
370 			n = write(outfd, zb.outbuf, avail);
371 			if (n != avail) {
372 				err = got_error_from_errno("write");
373 				goto done;
374 			}
375 			*outlen += avail;
376 		}
377 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
378 
379 done:
380 	if (err == NULL) {
381 		if (lseek(outfd, SEEK_SET, 0) == -1)
382 			err = got_error_from_errno("lseek");
383 	}
384 	got_inflate_end(&zb);
385 	return err;
386 }
387 
388 const struct got_error *
389 got_inflate_to_file(size_t *outlen, FILE *infile, FILE *outfile)
390 {
391 	const struct got_error *err;
392 	size_t avail;
393 	struct got_inflate_buf zb;
394 
395 	err = got_inflate_init(&zb, NULL, GOT_INFLATE_BUFSIZE);
396 	if (err)
397 		goto done;
398 
399 	*outlen = 0;
400 
401 	do {
402 		err = got_inflate_read(&zb, infile, &avail);
403 		if (err)
404 			goto done;
405 		if (avail > 0) {
406 			size_t n;
407 			n = fwrite(zb.outbuf, avail, 1, outfile);
408 			if (n != 1) {
409 				err = got_ferror(outfile, GOT_ERR_IO);
410 				goto done;
411 			}
412 			*outlen += avail;
413 		}
414 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
415 
416 done:
417 	if (err == NULL)
418 		rewind(outfile);
419 	got_inflate_end(&zb);
420 	return err;
421 }
422 
423 const struct got_error *
424 got_inflate_to_file_fd(size_t *outlen, int infd, FILE *outfile)
425 {
426 	const struct got_error *err;
427 	size_t avail;
428 	struct got_inflate_buf zb;
429 
430 	err = got_inflate_init(&zb, NULL, GOT_INFLATE_BUFSIZE);
431 	if (err)
432 		goto done;
433 
434 	*outlen = 0;
435 
436 	do {
437 		err = got_inflate_read_fd(&zb, infd, &avail);
438 		if (err)
439 			goto done;
440 		if (avail > 0) {
441 			size_t n;
442 			n = fwrite(zb.outbuf, avail, 1, outfile);
443 			if (n != 1) {
444 				err = got_ferror(outfile, GOT_ERR_IO);
445 				goto done;
446 			}
447 			*outlen += avail;
448 		}
449 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
450 
451 done:
452 	if (err == NULL)
453 		rewind(outfile);
454 	got_inflate_end(&zb);
455 	return err;
456 }
457 
458 const struct got_error *
459 got_inflate_to_file_mmap(size_t *outlen, uint8_t *map, size_t offset,
460     size_t len, FILE *outfile)
461 {
462 	const struct got_error *err;
463 	size_t avail;
464 	struct got_inflate_buf zb;
465 	size_t consumed;
466 
467 	err = got_inflate_init(&zb, NULL, GOT_INFLATE_BUFSIZE);
468 	if (err)
469 		goto done;
470 
471 	*outlen = 0;
472 
473 	do {
474 		err = got_inflate_read_mmap(&zb, map, offset, len, &avail,
475 		    &consumed);
476 		if (err)
477 			goto done;
478 		offset += consumed;
479 		len -= consumed;
480 		if (avail > 0) {
481 			size_t n;
482 			n = fwrite(zb.outbuf, avail, 1, outfile);
483 			if (n != 1) {
484 				err = got_ferror(outfile, GOT_ERR_IO);
485 				goto done;
486 			}
487 			*outlen += avail;
488 		}
489 	} while (zb.flags & GOT_INFLATE_F_HAVE_MORE);
490 
491 done:
492 	if (err == NULL)
493 		rewind(outfile);
494 	got_inflate_end(&zb);
495 	return err;
496 }