Got Mirror

Blob

Date:: Sun Oct 16 09:34:56 2022 UTC
Message:: make got_pack_create() write to a file descriptor instead of a stdio FILE The old code required a seekable output file. This conflicts with requirements of future gotd(8), which will write pack file data to network sockets. ok op@
Actions:: History | Blame | Raw File
1 /*
2  * Copyright (c) 2019 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 <zlib.h>
24 #include <time.h>
25 
26 #include "got_error.h"
27 #include "got_object.h"
28 #include "got_path.h"
29 
30 #include "got_lib_deflate.h"
31 
32 #ifndef MIN
33 #define	MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
34 #endif
35 
36 const struct got_error *
37 got_deflate_init(struct got_deflate_buf *zb, uint8_t *outbuf, size_t bufsize)
38 {
39 	const struct got_error *err = NULL;
40 	int zerr;
41 
42 	memset(&zb->z, 0, sizeof(zb->z));
43 
44 	zb->z.zalloc = Z_NULL;
45 	zb->z.zfree = Z_NULL;
46 	zerr = deflateInit(&zb->z, Z_DEFAULT_COMPRESSION);
47 	if (zerr != Z_OK) {
48 		if  (zerr == Z_ERRNO)
49 			return got_error_from_errno("deflateInit");
50 		if  (zerr == Z_MEM_ERROR) {
51 			errno = ENOMEM;
52 			return got_error_from_errno("deflateInit");
53 		}
54 		return got_error(GOT_ERR_COMPRESSION);
55 	}
56 
57 	zb->inlen = zb->outlen = bufsize;
58 
59 	zb->inbuf = calloc(1, zb->inlen);
60 	if (zb->inbuf == NULL) {
61 		err = got_error_from_errno("calloc");
62 		goto done;
63 	}
64 
65 	zb->flags = 0;
66 	if (outbuf == NULL) {
67 		zb->outbuf = calloc(1, zb->outlen);
68 		if (zb->outbuf == NULL) {
69 			err = got_error_from_errno("calloc");
70 			goto done;
71 		}
72 		zb->flags |= GOT_DEFLATE_F_OWN_OUTBUF;
73 	} else
74 		zb->outbuf = outbuf;
75 done:
76 	if (err)
77 		got_deflate_end(zb);
78 	return err;
79 }
80 
81 static void
82 csum_output(struct got_deflate_checksum *csum, const uint8_t *buf, size_t len)
83 {
84 	if (csum->output_crc)
85 		*csum->output_crc = crc32(*csum->output_crc, buf, len);
86 
87 	if (csum->output_sha1)
88 		SHA1Update(csum->output_sha1, buf, len);
89 }
90 
91 const struct got_error *
92 got_deflate_read(struct got_deflate_buf *zb, FILE *f, off_t len,
93     size_t *outlenp, off_t *consumed)
94 {
95 	size_t last_total_out = zb->z.total_out;
96 	z_stream *z = &zb->z;
97 	int ret = Z_ERRNO;
98 
99 	z->next_out = zb->outbuf;
100 	z->avail_out = zb->outlen;
101 
102 	*outlenp = 0;
103 	*consumed = 0;
104 	do {
105 		size_t last_total_in = z->total_in;
106 		if (z->avail_in == 0) {
107 			size_t n = 0;
108 			if (*consumed < len) {
109 				n = fread(zb->inbuf, 1,
110 				    MIN(zb->inlen, len - *consumed), f);
111 			}
112 			if (n == 0) {
113 				if (ferror(f))
114 					return got_ferror(f, GOT_ERR_IO);
115 				/* EOF */
116 				ret = deflate(z, Z_FINISH);
117 				break;
118 			}
119 			z->next_in = zb->inbuf;
120 			z->avail_in = n;
121 		}
122 		ret = deflate(z, Z_NO_FLUSH);
123 		*consumed += z->total_in - last_total_in;
124 	} while (ret == Z_OK && z->avail_out > 0);
125 
126 	if (ret == Z_OK) {
127 		zb->flags |= GOT_DEFLATE_F_HAVE_MORE;
128 	} else {
129 		if (ret != Z_STREAM_END)
130 			return got_error(GOT_ERR_COMPRESSION);
131 		zb->flags &= ~GOT_DEFLATE_F_HAVE_MORE;
132 	}
133 
134 	*outlenp = z->total_out - last_total_out;
135 	return NULL;
136 }
137 
138 static const struct got_error *
139 deflate_read_mmap(struct got_deflate_buf *zb, uint8_t *map, size_t offset,
140     size_t len, size_t *outlenp, size_t *consumed, int flush_on_eof)
141 {
142 	z_stream *z = &zb->z;
143 	size_t last_total_out = z->total_out;
144 	int ret = Z_ERRNO;
145 
146 	z->next_out = zb->outbuf;
147 	z->avail_out = zb->outlen;
148 
149 	*outlenp = 0;
150 	*consumed = 0;
151 	do {
152 		size_t last_total_in = z->total_in;
153 		if (z->avail_in == 0) {
154 			z->next_in = map + offset + *consumed;
155 			if (len - *consumed > UINT_MAX)
156 				z->avail_in = UINT_MAX;
157 			else
158 				z->avail_in = len - *consumed;
159 			if (z->avail_in == 0) {
160 				/* EOF */
161 				if (flush_on_eof)
162 					ret = deflate(z, Z_FINISH);
163 				break;
164 			}
165 		}
166 		ret = deflate(z, Z_NO_FLUSH);
167 		*consumed += z->total_in - last_total_in;
168 	} while (ret == Z_OK && z->avail_out > 0);
169 
170 	if (ret == Z_OK) {
171 		zb->flags |= GOT_DEFLATE_F_HAVE_MORE;
172 	} else {
173 		if (ret != Z_STREAM_END)
174 			return got_error(GOT_ERR_COMPRESSION);
175 		zb->flags &= ~GOT_DEFLATE_F_HAVE_MORE;
176 	}
177 
178 	*outlenp = z->total_out - last_total_out;
179 	return NULL;
180 }
181 
182 const struct got_error *
183 got_deflate_read_mmap(struct got_deflate_buf *zb, uint8_t *map, size_t offset,
184     size_t len, size_t *outlenp, size_t *consumed)
185 {
186 	return deflate_read_mmap(zb, map, offset, len, outlenp, consumed, 1);
187 }
188 
189 const struct got_error *
190 got_deflate_flush(struct got_deflate_buf *zb, FILE *outfile,
191     struct got_deflate_checksum *csum, off_t *outlenp)
192 {
193 	int ret;
194 	size_t n;
195 	z_stream *z = &zb->z;
196 
197 	if (z->avail_in != 0)
198 		return got_error_msg(GOT_ERR_COMPRESSION,
199 		    "cannot flush zb with pending input data");
200 
201 	do {
202 		size_t avail, last_total_out = zb->z.total_out;
203 
204 		z->next_out = zb->outbuf;
205 		z->avail_out = zb->outlen;
206 
207 		ret = deflate(z, Z_FINISH);
208 		if (ret != Z_STREAM_END && ret != Z_OK)
209 			return got_error(GOT_ERR_COMPRESSION);
210 
211 		avail = z->total_out - last_total_out;
212 		if (avail > 0) {
213 			n = fwrite(zb->outbuf, avail, 1, outfile);
214 			if (n != 1)
215 				return got_ferror(outfile, GOT_ERR_IO);
216 			if (csum)
217 				csum_output(csum, zb->outbuf, avail);
218 			if (outlenp)
219 				*outlenp += avail;
220 		}
221 	} while (ret != Z_STREAM_END);
222 
223 	zb->flags &= ~GOT_DEFLATE_F_HAVE_MORE;
224 	return NULL;
225 }
226 
227 void
228 got_deflate_end(struct got_deflate_buf *zb)
229 {
230 	free(zb->inbuf);
231 	if (zb->flags & GOT_DEFLATE_F_OWN_OUTBUF)
232 		free(zb->outbuf);
233 	deflateEnd(&zb->z);
234 }
235 
236 const struct got_error *
237 got_deflate_to_fd(off_t *outlen, FILE *infile, off_t len, int outfd,
238     struct got_deflate_checksum *csum)
239 {
240 	const struct got_error *err;
241 	size_t avail;
242 	off_t consumed;
243 	struct got_deflate_buf zb;
244 
245 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
246 	if (err)
247 		goto done;
248 
249 	*outlen = 0;
250 
251 	do {
252 		err = got_deflate_read(&zb, infile, len, &avail, &consumed);
253 		if (err)
254 			goto done;
255 		len -= consumed;
256 		if (avail > 0) {
257 			ssize_t w;
258 			w = write(outfd, zb.outbuf, avail);
259 			if (w == -1) {
260 				err = got_error_from_errno("write");
261 				goto done;
262 			} else if (w != avail) {
263 				err = got_error(GOT_ERR_IO);
264 				goto done;
265 			}
266 			if (csum)
267 				csum_output(csum, zb.outbuf, avail);
268 			*outlen += avail;
269 		}
270 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
271 
272 done:
273 	got_deflate_end(&zb);
274 	return err;
275 }
276 
277 const struct got_error *
278 got_deflate_to_fd_mmap(off_t *outlen, uint8_t *map, size_t offset,
279     size_t len, int outfd, struct got_deflate_checksum *csum)
280 {
281 	const struct got_error *err;
282 	size_t avail, consumed;
283 	struct got_deflate_buf zb;
284 
285 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
286 	if (err)
287 		goto done;
288 
289 	*outlen = 0;
290 	do {
291 		err = got_deflate_read_mmap(&zb, map, offset, len, &avail,
292 		    &consumed);
293 		if (err)
294 			goto done;
295 		offset += consumed;
296 		len -= consumed;
297 		if (avail > 0) {
298 			ssize_t w;
299 			w = write(outfd, zb.outbuf, avail);
300 			if (w == -1) {
301 				err = got_error_from_errno("write");
302 				goto done;
303 			} else if (w != avail) {
304 				err = got_error(GOT_ERR_IO);
305 				goto done;
306 			}
307 			if (csum)
308 				csum_output(csum, zb.outbuf, avail);
309 			*outlen += avail;
310 		}
311 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
312 
313 done:
314 	got_deflate_end(&zb);
315 	return err;
316 }
317 
318 const struct got_error *
319 got_deflate_to_file(off_t *outlen, FILE *infile, off_t len,
320     FILE *outfile, struct got_deflate_checksum *csum)
321 {
322 	const struct got_error *err;
323 	size_t avail;
324 	off_t consumed;
325 	struct got_deflate_buf zb;
326 
327 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
328 	if (err)
329 		goto done;
330 
331 	*outlen = 0;
332 
333 	do {
334 		err = got_deflate_read(&zb, infile, len, &avail, &consumed);
335 		if (err)
336 			goto done;
337 		len -= consumed;
338 		if (avail > 0) {
339 			size_t n;
340 			n = fwrite(zb.outbuf, avail, 1, outfile);
341 			if (n != 1) {
342 				err = got_ferror(outfile, GOT_ERR_IO);
343 				goto done;
344 			}
345 			if (csum)
346 				csum_output(csum, zb.outbuf, avail);
347 			*outlen += avail;
348 		}
349 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
350 
351 done:
352 	got_deflate_end(&zb);
353 	return err;
354 }
355 
356 const struct got_error *
357 got_deflate_to_file_mmap(off_t *outlen, uint8_t *map, size_t offset,
358     size_t len, FILE *outfile, struct got_deflate_checksum *csum)
359 {
360 	const struct got_error *err;
361 	size_t avail, consumed;
362 	struct got_deflate_buf zb;
363 
364 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
365 	if (err)
366 		goto done;
367 
368 	*outlen = 0;
369 	do {
370 		err = got_deflate_read_mmap(&zb, map, offset, len, &avail,
371 		    &consumed);
372 		if (err)
373 			goto done;
374 		offset += consumed;
375 		len -= consumed;
376 		if (avail > 0) {
377 			size_t n;
378 			n = fwrite(zb.outbuf, avail, 1, outfile);
379 			if (n != 1) {
380 				err = got_ferror(outfile, GOT_ERR_IO);
381 				goto done;
382 			}
383 			if (csum)
384 				csum_output(csum, zb.outbuf, avail);
385 			*outlen += avail;
386 		}
387 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
388 
389 done:
390 	got_deflate_end(&zb);
391 	return err;
392 }
393 
394 const struct got_error *
395 got_deflate_append_to_file_mmap(struct got_deflate_buf *zb, off_t *outlen,
396     uint8_t *map, size_t offset, size_t len, FILE *outfile,
397     struct got_deflate_checksum *csum)
398 {
399 	const struct got_error *err;
400 	size_t avail, consumed;
401 
402 	do {
403 		err = deflate_read_mmap(zb, map, offset, len, &avail,
404 		    &consumed, 0);
405 		if (err)
406 			break;
407 		offset += consumed;
408 		len -= consumed;
409 		if (avail > 0) {
410 			size_t n;
411 			n = fwrite(zb->outbuf, avail, 1, outfile);
412 			if (n != 1) {
413 				err = got_ferror(outfile, GOT_ERR_IO);
414 				break;
415 			}
416 			if (csum)
417 				csum_output(csum, zb->outbuf, avail);
418 			if (outlen)
419 				*outlen += avail;
420 		}
421 	} while ((zb->flags & GOT_DEFLATE_F_HAVE_MORE) && len > 0);
422 
423 	return err;
424 }
425 
426 const struct got_error *
427 got_deflate_to_mem_mmap(uint8_t **outbuf, size_t *outlen,
428     size_t *consumed_total, struct got_deflate_checksum *csum, uint8_t *map,
429     size_t offset, size_t len)
430 {
431 	const struct got_error *err;
432 	size_t avail, consumed;
433 	struct got_deflate_buf zb;
434 	void *newbuf;
435 	size_t nbuf = 1;
436 
437 	if (outbuf) {
438 		*outbuf = malloc(GOT_DEFLATE_BUFSIZE);
439 		if (*outbuf == NULL)
440 			return got_error_from_errno("malloc");
441 		err = got_deflate_init(&zb, *outbuf, GOT_DEFLATE_BUFSIZE);
442 		if (err) {
443 			free(*outbuf);
444 			*outbuf = NULL;
445 			return err;
446 		}
447 	} else {
448 		err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
449 		if (err)
450 			return err;
451 	}
452 
453 	*outlen = 0;
454 	if (consumed_total)
455 		*consumed_total = 0;
456 	do {
457 		err = got_deflate_read_mmap(&zb, map, offset, len, &avail,
458 		    &consumed);
459 		if (err)
460 			goto done;
461 		offset += consumed;
462 		if (consumed_total)
463 			*consumed_total += consumed;
464 		len -= consumed;
465 		if (avail > 0 && csum)
466 			csum_output(csum, zb.outbuf, avail);
467 		*outlen += avail;
468 		if ((zb.flags & GOT_DEFLATE_F_HAVE_MORE) && outbuf != NULL) {
469 			newbuf = reallocarray(*outbuf, ++nbuf,
470 			    GOT_DEFLATE_BUFSIZE);
471 			if (newbuf == NULL) {
472 				err = got_error_from_errno("reallocarray");
473 				free(*outbuf);
474 				*outbuf = NULL;
475 				*outlen = 0;
476 				goto done;
477 			}
478 			*outbuf = newbuf;
479 			zb.outbuf = newbuf + *outlen;
480 			zb.outlen = (nbuf * GOT_DEFLATE_BUFSIZE) - *outlen;
481 		}
482 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
483 done:
484 	got_deflate_end(&zb);
485 	return err;
486 }