Blob


1 /*
2 * Copyright (c) 2018, 2019, 2020 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 */
17 #include <sys/types.h>
18 #include <sys/stat.h>
19 #include <sys/queue.h>
20 #include <sys/uio.h>
21 #include <sys/mman.h>
23 #include <fcntl.h>
24 #include <errno.h>
25 #include <stdio.h>
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <limits.h>
30 #include <sha1.h>
31 #include <endian.h>
32 #include <zlib.h>
33 #include <imsg.h>
35 #include "got_error.h"
36 #include "got_object.h"
37 #include "got_opentemp.h"
38 #include "got_path.h"
40 #include "got_lib_sha1.h"
41 #include "got_lib_delta.h"
42 #include "got_lib_delta_cache.h"
43 #include "got_lib_inflate.h"
44 #include "got_lib_object.h"
45 #include "got_lib_object_parse.h"
46 #include "got_lib_privsep.h"
47 #include "got_lib_pack.h"
49 #ifndef nitems
50 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
51 #endif
53 #ifndef MIN
54 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
55 #endif
57 static const struct got_error *
58 verify_fanout_table(uint32_t *fanout_table)
59 {
60 int i;
62 for (i = 0; i < 0xff - 1; i++) {
63 if (be32toh(fanout_table[i]) > be32toh(fanout_table[i + 1]))
64 return got_error(GOT_ERR_BAD_PACKIDX);
65 }
67 return NULL;
68 }
70 const struct got_error *
71 got_packidx_init_hdr(struct got_packidx *p, int verify)
72 {
73 const struct got_error *err = NULL;
74 struct got_packidx_v2_hdr *h;
75 SHA1_CTX ctx;
76 uint8_t sha1[SHA1_DIGEST_LENGTH];
77 size_t nobj, len_fanout, len_ids, offset, remain;
78 ssize_t n;
79 int i;
81 SHA1Init(&ctx);
83 h = &p->hdr;
84 offset = 0;
85 remain = p->len;
87 if (remain < sizeof(*h->magic)) {
88 err = got_error(GOT_ERR_BAD_PACKIDX);
89 goto done;
90 }
91 if (p->map)
92 h->magic = (uint32_t *)(p->map + offset);
93 else {
94 h->magic = malloc(sizeof(*h->magic));
95 if (h->magic == NULL) {
96 err = got_error_from_errno("malloc");
97 goto done;
98 }
99 n = read(p->fd, h->magic, sizeof(*h->magic));
100 if (n < 0) {
101 err = got_error_from_errno("read");
102 goto done;
103 } else if (n != sizeof(*h->magic)) {
104 err = got_error(GOT_ERR_BAD_PACKIDX);
105 goto done;
108 if (betoh32(*h->magic) != GOT_PACKIDX_V2_MAGIC) {
109 err = got_error(GOT_ERR_BAD_PACKIDX);
110 goto done;
112 offset += sizeof(*h->magic);
113 remain -= sizeof(*h->magic);
115 if (verify)
116 SHA1Update(&ctx, (uint8_t *)h->magic, sizeof(*h->magic));
118 if (remain < sizeof(*h->version)) {
119 err = got_error(GOT_ERR_BAD_PACKIDX);
120 goto done;
122 if (p->map)
123 h->version = (uint32_t *)(p->map + offset);
124 else {
125 h->version = malloc(sizeof(*h->version));
126 if (h->version == NULL) {
127 err = got_error_from_errno("malloc");
128 goto done;
130 n = read(p->fd, h->version, sizeof(*h->version));
131 if (n < 0) {
132 err = got_error_from_errno("read");
133 goto done;
134 } else if (n != sizeof(*h->version)) {
135 err = got_error(GOT_ERR_BAD_PACKIDX);
136 goto done;
139 if (betoh32(*h->version) != GOT_PACKIDX_VERSION) {
140 err = got_error(GOT_ERR_BAD_PACKIDX);
141 goto done;
143 offset += sizeof(*h->version);
144 remain -= sizeof(*h->version);
146 if (verify)
147 SHA1Update(&ctx, (uint8_t *)h->version, sizeof(*h->version));
149 len_fanout =
150 sizeof(*h->fanout_table) * GOT_PACKIDX_V2_FANOUT_TABLE_ITEMS;
151 if (remain < len_fanout) {
152 err = got_error(GOT_ERR_BAD_PACKIDX);
153 goto done;
155 if (p->map)
156 h->fanout_table = (uint32_t *)(p->map + offset);
157 else {
158 h->fanout_table = malloc(len_fanout);
159 if (h->fanout_table == NULL) {
160 err = got_error_from_errno("malloc");
161 goto done;
163 n = read(p->fd, h->fanout_table, len_fanout);
164 if (n < 0) {
165 err = got_error_from_errno("read");
166 goto done;
167 } else if (n != len_fanout) {
168 err = got_error(GOT_ERR_BAD_PACKIDX);
169 goto done;
172 err = verify_fanout_table(h->fanout_table);
173 if (err)
174 goto done;
175 if (verify)
176 SHA1Update(&ctx, (uint8_t *)h->fanout_table, len_fanout);
177 offset += len_fanout;
178 remain -= len_fanout;
180 nobj = betoh32(h->fanout_table[0xff]);
181 len_ids = nobj * sizeof(*h->sorted_ids);
182 if (len_ids <= nobj || len_ids > remain) {
183 err = got_error(GOT_ERR_BAD_PACKIDX);
184 goto done;
186 if (p->map)
187 h->sorted_ids =
188 (struct got_packidx_object_id *)((uint8_t*)(p->map + offset));
189 else {
190 h->sorted_ids = malloc(len_ids);
191 if (h->sorted_ids == NULL) {
192 err = got_error(GOT_ERR_BAD_PACKIDX);
193 goto done;
195 n = read(p->fd, h->sorted_ids, len_ids);
196 if (n < 0)
197 err = got_error_from_errno("read");
198 else if (n != len_ids) {
199 err = got_error(GOT_ERR_BAD_PACKIDX);
200 goto done;
203 if (verify)
204 SHA1Update(&ctx, (uint8_t *)h->sorted_ids, len_ids);
205 offset += len_ids;
206 remain -= len_ids;
208 if (remain < nobj * sizeof(*h->crc32)) {
209 err = got_error(GOT_ERR_BAD_PACKIDX);
210 goto done;
212 if (p->map)
213 h->crc32 = (uint32_t *)((uint8_t*)(p->map + offset));
214 else {
215 h->crc32 = malloc(nobj * sizeof(*h->crc32));
216 if (h->crc32 == NULL) {
217 err = got_error_from_errno("malloc");
218 goto done;
220 n = read(p->fd, h->crc32, nobj * sizeof(*h->crc32));
221 if (n < 0)
222 err = got_error_from_errno("read");
223 else if (n != nobj * sizeof(*h->crc32)) {
224 err = got_error(GOT_ERR_BAD_PACKIDX);
225 goto done;
228 if (verify)
229 SHA1Update(&ctx, (uint8_t *)h->crc32, nobj * sizeof(*h->crc32));
230 remain -= nobj * sizeof(*h->crc32);
231 offset += nobj * sizeof(*h->crc32);
233 if (remain < nobj * sizeof(*h->offsets)) {
234 err = got_error(GOT_ERR_BAD_PACKIDX);
235 goto done;
237 if (p->map)
238 h->offsets = (uint32_t *)((uint8_t*)(p->map + offset));
239 else {
240 h->offsets = malloc(nobj * sizeof(*h->offsets));
241 if (h->offsets == NULL) {
242 err = got_error_from_errno("malloc");
243 goto done;
245 n = read(p->fd, h->offsets, nobj * sizeof(*h->offsets));
246 if (n < 0)
247 err = got_error_from_errno("read");
248 else if (n != nobj * sizeof(*h->offsets)) {
249 err = got_error(GOT_ERR_BAD_PACKIDX);
250 goto done;
253 if (verify)
254 SHA1Update(&ctx, (uint8_t *)h->offsets,
255 nobj * sizeof(*h->offsets));
256 remain -= nobj * sizeof(*h->offsets);
257 offset += nobj * sizeof(*h->offsets);
259 /* Large file offsets are contained only in files > 2GB. */
260 for (i = 0; i < nobj; i++) {
261 uint32_t o = betoh32(h->offsets[i]);
262 if (o & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX)
263 p->nlargeobj++;
265 if (p->nlargeobj == 0)
266 goto checksum;
268 if (remain < p->nlargeobj * sizeof(*h->large_offsets)) {
269 err = got_error(GOT_ERR_BAD_PACKIDX);
270 goto done;
272 if (p->map)
273 h->large_offsets = (uint64_t *)((uint8_t*)(p->map + offset));
274 else {
275 h->large_offsets = malloc(p->nlargeobj *
276 sizeof(*h->large_offsets));
277 if (h->large_offsets == NULL) {
278 err = got_error_from_errno("malloc");
279 goto done;
281 n = read(p->fd, h->large_offsets,
282 p->nlargeobj * sizeof(*h->large_offsets));
283 if (n < 0)
284 err = got_error_from_errno("read");
285 else if (n != p->nlargeobj * sizeof(*h->large_offsets)) {
286 err = got_error(GOT_ERR_BAD_PACKIDX);
287 goto done;
290 if (verify)
291 SHA1Update(&ctx, (uint8_t*)h->large_offsets,
292 p->nlargeobj * sizeof(*h->large_offsets));
293 remain -= p->nlargeobj * sizeof(*h->large_offsets);
294 offset += p->nlargeobj * sizeof(*h->large_offsets);
296 checksum:
297 if (remain < sizeof(*h->trailer)) {
298 err = got_error(GOT_ERR_BAD_PACKIDX);
299 goto done;
301 if (p->map)
302 h->trailer =
303 (struct got_packidx_trailer *)((uint8_t*)(p->map + offset));
304 else {
305 h->trailer = malloc(sizeof(*h->trailer));
306 if (h->trailer == NULL) {
307 err = got_error_from_errno("malloc");
308 goto done;
310 n = read(p->fd, h->trailer, sizeof(*h->trailer));
311 if (n < 0)
312 err = got_error_from_errno("read");
313 else if (n != sizeof(*h->trailer)) {
314 err = got_error(GOT_ERR_BAD_PACKIDX);
315 goto done;
318 if (verify) {
319 SHA1Update(&ctx, h->trailer->packfile_sha1, SHA1_DIGEST_LENGTH);
320 SHA1Final(sha1, &ctx);
321 if (memcmp(h->trailer->packidx_sha1, sha1,
322 SHA1_DIGEST_LENGTH) != 0)
323 err = got_error(GOT_ERR_PACKIDX_CSUM);
325 done:
326 return err;
329 const struct got_error *
330 got_packidx_open(struct got_packidx **packidx, const char *path, int verify)
332 const struct got_error *err = NULL;
333 struct got_packidx *p;
334 struct stat sb;
336 *packidx = NULL;
338 p = calloc(1, sizeof(*p));
339 if (p == NULL)
340 return got_error_from_errno("calloc");
342 p->fd = open(path, O_RDONLY | O_NOFOLLOW);
343 if (p->fd == -1) {
344 err = got_error_from_errno2("open", path);
345 free(p);
346 return err;
349 if (fstat(p->fd, &sb) != 0) {
350 err = got_error_from_errno2("fstat", path);
351 close(p->fd);
352 free(p);
353 return err;
355 p->len = sb.st_size;
356 if (p->len < sizeof(p->hdr)) {
357 err = got_error(GOT_ERR_BAD_PACKIDX);
358 close(p->fd);
359 free(p);
360 return err;
363 p->path_packidx = strdup(path);
364 if (p->path_packidx == NULL) {
365 err = got_error_from_errno("strdup");
366 goto done;
369 #ifndef GOT_PACK_NO_MMAP
370 p->map = mmap(NULL, p->len, PROT_READ, MAP_PRIVATE, p->fd, 0);
371 if (p->map == MAP_FAILED) {
372 if (errno != ENOMEM) {
373 err = got_error_from_errno("mmap");
374 goto done;
376 p->map = NULL; /* fall back to read(2) */
378 #endif
380 err = got_packidx_init_hdr(p, verify);
381 done:
382 if (err)
383 got_packidx_close(p);
384 else
385 *packidx = p;
387 return err;
390 const struct got_error *
391 got_packidx_close(struct got_packidx *packidx)
393 const struct got_error *err = NULL;
395 free(packidx->path_packidx);
396 if (packidx->map) {
397 if (munmap(packidx->map, packidx->len) == -1)
398 err = got_error_from_errno("munmap");
399 } else {
400 free(packidx->hdr.magic);
401 free(packidx->hdr.version);
402 free(packidx->hdr.fanout_table);
403 free(packidx->hdr.sorted_ids);
404 free(packidx->hdr.crc32);
405 free(packidx->hdr.offsets);
406 free(packidx->hdr.large_offsets);
407 free(packidx->hdr.trailer);
409 if (close(packidx->fd) != 0 && err == NULL)
410 err = got_error_from_errno("close");
411 free(packidx);
413 return err;
416 static off_t
417 get_object_offset(struct got_packidx *packidx, int idx)
419 uint32_t offset = betoh32(packidx->hdr.offsets[idx]);
420 if (offset & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX) {
421 uint64_t loffset;
422 idx = offset & GOT_PACKIDX_OFFSET_VAL_MASK;
423 if (idx < 0 || idx >= packidx->nlargeobj ||
424 packidx->hdr.large_offsets == NULL)
425 return -1;
426 loffset = betoh64(packidx->hdr.large_offsets[idx]);
427 return (loffset > INT64_MAX ? -1 : (off_t)loffset);
429 return (off_t)(offset & GOT_PACKIDX_OFFSET_VAL_MASK);
432 int
433 got_packidx_get_object_idx_sha1(struct got_packidx *packidx, uint8_t *sha1)
435 u_int8_t id0 = sha1[0];
436 uint32_t totobj = betoh32(packidx->hdr.fanout_table[0xff]);
437 int left = 0, right = totobj - 1;
439 if (id0 > 0)
440 left = betoh32(packidx->hdr.fanout_table[id0 - 1]);
442 while (left <= right) {
443 struct got_packidx_object_id *oid;
444 int i, cmp;
446 i = ((left + right) / 2);
447 oid = &packidx->hdr.sorted_ids[i];
448 cmp = memcmp(sha1, oid->sha1, SHA1_DIGEST_LENGTH);
449 if (cmp == 0)
450 return i;
451 else if (cmp > 0)
452 left = i + 1;
453 else if (cmp < 0)
454 right = i - 1;
457 return -1;
460 int
461 got_packidx_get_object_idx(struct got_packidx *packidx, struct got_object_id *id)
463 return got_packidx_get_object_idx_sha1(packidx, id->sha1);
466 const struct got_error *
467 got_packidx_match_id_str_prefix(struct got_object_id_queue *matched_ids,
468 struct got_packidx *packidx, const char *id_str_prefix)
470 const struct got_error *err = NULL;
471 u_int8_t id0;
472 uint32_t totobj = betoh32(packidx->hdr.fanout_table[0xff]);
473 char hex[3];
474 size_t prefix_len = strlen(id_str_prefix);
475 struct got_packidx_object_id *oid;
476 int i;
478 SIMPLEQ_INIT(matched_ids);
480 if (prefix_len < 2)
481 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
483 hex[0] = id_str_prefix[0];
484 hex[1] = id_str_prefix[1];
485 hex[2] = '\0';
486 if (!got_parse_xdigit(&id0, hex))
487 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
489 i = betoh32(packidx->hdr.fanout_table[id0 - 1]);
490 if (i == 0)
491 return NULL;
493 oid = &packidx->hdr.sorted_ids[i];
494 while (i < totobj && oid->sha1[0] == id0) {
495 char id_str[SHA1_DIGEST_STRING_LENGTH];
496 struct got_object_qid *qid;
497 int cmp;
499 if (!got_sha1_digest_to_str(oid->sha1, id_str, sizeof(id_str)))
500 return got_error(GOT_ERR_NO_SPACE);
502 cmp = strncmp(id_str, id_str_prefix, prefix_len);
503 if (cmp < 0) {
504 oid = &packidx->hdr.sorted_ids[++i];
505 continue;
506 } else if (cmp > 0)
507 break;
509 err = got_object_qid_alloc_partial(&qid);
510 if (err)
511 break;
512 memcpy(qid->id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
513 SIMPLEQ_INSERT_TAIL(matched_ids, qid, entry);
515 oid = &packidx->hdr.sorted_ids[++i];
518 if (err)
519 got_object_id_queue_free(matched_ids);
520 return err;
523 const struct got_error *
524 got_pack_stop_privsep_child(struct got_pack *pack)
526 const struct got_error *err = NULL;
528 if (pack->privsep_child == NULL)
529 return NULL;
531 err = got_privsep_send_stop(pack->privsep_child->imsg_fd);
532 if (err)
533 return err;
534 err = got_privsep_wait_for_child(pack->privsep_child->pid);
535 if (close(pack->privsep_child->imsg_fd) != 0 && err == NULL)
536 err = got_error_from_errno("close");
537 free(pack->privsep_child);
538 pack->privsep_child = NULL;
539 return err;
542 const struct got_error *
543 got_pack_close(struct got_pack *pack)
545 const struct got_error *err = NULL;
547 err = got_pack_stop_privsep_child(pack);
548 if (pack->map && munmap(pack->map, pack->filesize) == -1 && !err)
549 err = got_error_from_errno("munmap");
550 if (pack->fd != -1 && close(pack->fd) != 0 && err == NULL)
551 err = got_error_from_errno("close");
552 pack->fd = -1;
553 free(pack->path_packfile);
554 pack->path_packfile = NULL;
555 pack->filesize = 0;
556 if (pack->delta_cache) {
557 got_delta_cache_free(pack->delta_cache);
558 pack->delta_cache = NULL;
561 return err;
564 const struct got_error *
565 got_pack_parse_object_type_and_size(uint8_t *type, uint64_t *size, size_t *len,
566 struct got_pack *pack, off_t offset)
568 uint8_t t = 0;
569 uint64_t s = 0;
570 uint8_t sizeN;
571 size_t mapoff = 0;
572 int i = 0;
574 *len = 0;
576 if (offset >= pack->filesize)
577 return got_error(GOT_ERR_PACK_OFFSET);
579 if (pack->map) {
580 mapoff = (size_t)offset;
581 } else {
582 if (lseek(pack->fd, offset, SEEK_SET) == -1)
583 return got_error_from_errno("lseek");
586 do {
587 /* We do not support size values which don't fit in 64 bit. */
588 if (i > 9)
589 return got_error(GOT_ERR_NO_SPACE);
591 if (pack->map) {
592 sizeN = *(pack->map + mapoff);
593 mapoff += sizeof(sizeN);
594 } else {
595 ssize_t n = read(pack->fd, &sizeN, sizeof(sizeN));
596 if (n < 0)
597 return got_error_from_errno("read");
598 if (n != sizeof(sizeN))
599 return got_error(GOT_ERR_BAD_PACKFILE);
601 *len += sizeof(sizeN);
603 if (i == 0) {
604 t = (sizeN & GOT_PACK_OBJ_SIZE0_TYPE_MASK) >>
605 GOT_PACK_OBJ_SIZE0_TYPE_MASK_SHIFT;
606 s = (sizeN & GOT_PACK_OBJ_SIZE0_VAL_MASK);
607 } else {
608 size_t shift = 4 + 7 * (i - 1);
609 s |= ((sizeN & GOT_PACK_OBJ_SIZE_VAL_MASK) << shift);
611 i++;
612 } while (sizeN & GOT_PACK_OBJ_SIZE_MORE);
614 *type = t;
615 *size = s;
616 return NULL;
619 static const struct got_error *
620 open_plain_object(struct got_object **obj, struct got_object_id *id,
621 uint8_t type, off_t offset, size_t size, int idx)
623 *obj = calloc(1, sizeof(**obj));
624 if (*obj == NULL)
625 return got_error_from_errno("calloc");
627 (*obj)->type = type;
628 (*obj)->flags = GOT_OBJ_FLAG_PACKED;
629 (*obj)->pack_idx = idx;
630 (*obj)->hdrlen = 0;
631 (*obj)->size = size;
632 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
633 (*obj)->pack_offset = offset;
635 return NULL;
638 static const struct got_error *
639 parse_negative_offset(int64_t *offset, size_t *len, struct got_pack *pack,
640 off_t delta_offset)
642 int64_t o = 0;
643 uint8_t offN;
644 int i = 0;
646 *offset = 0;
647 *len = 0;
649 do {
650 /* We do not support offset values which don't fit in 64 bit. */
651 if (i > 8)
652 return got_error(GOT_ERR_NO_SPACE);
654 if (pack->map) {
655 size_t mapoff;
656 if (delta_offset >= pack->filesize)
657 return got_error(GOT_ERR_PACK_OFFSET);
658 mapoff = (size_t)delta_offset + *len;
659 offN = *(pack->map + mapoff);
660 } else {
661 ssize_t n;
662 n = read(pack->fd, &offN, sizeof(offN));
663 if (n < 0)
664 return got_error_from_errno("read");
665 if (n != sizeof(offN))
666 return got_error(GOT_ERR_BAD_PACKFILE);
668 *len += sizeof(offN);
670 if (i == 0)
671 o = (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
672 else {
673 o++;
674 o <<= 7;
675 o += (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
677 i++;
678 } while (offN & GOT_PACK_OBJ_DELTA_OFF_MORE);
680 *offset = o;
681 return NULL;
684 const struct got_error *
685 got_pack_parse_offset_delta(off_t *base_offset, size_t *len, struct got_pack *pack,
686 off_t offset, int tslen)
688 const struct got_error *err;
689 int64_t negoffset;
690 size_t negofflen;
692 *len = 0;
694 err = parse_negative_offset(&negoffset, &negofflen, pack,
695 offset + tslen);
696 if (err)
697 return err;
699 /* Compute the base object's offset (must be in the same pack file). */
700 *base_offset = (offset - negoffset);
701 if (*base_offset <= 0)
702 return got_error(GOT_ERR_BAD_PACKFILE);
704 *len = negofflen;
705 return NULL;
708 static const struct got_error *
709 read_delta_data(uint8_t **delta_buf, size_t *delta_len,
710 size_t delta_data_offset, struct got_pack *pack)
712 const struct got_error *err = NULL;
714 if (pack->map) {
715 if (delta_data_offset >= pack->filesize)
716 return got_error(GOT_ERR_PACK_OFFSET);
717 err = got_inflate_to_mem_mmap(delta_buf, delta_len,
718 NULL, NULL, pack->map, delta_data_offset,
719 pack->filesize - delta_data_offset);
720 } else {
721 if (lseek(pack->fd, delta_data_offset, SEEK_SET) == -1)
722 return got_error_from_errno("lseek");
723 err = got_inflate_to_mem_fd(delta_buf, delta_len, NULL,
724 NULL, 0, pack->fd);
726 return err;
729 static const struct got_error *
730 add_delta(struct got_delta_chain *deltas, off_t delta_offset, size_t tslen,
731 int delta_type, size_t delta_size, size_t delta_data_offset)
733 struct got_delta *delta;
735 delta = got_delta_open(delta_offset, tslen, delta_type, delta_size,
736 delta_data_offset);
737 if (delta == NULL)
738 return got_error_from_errno("got_delta_open");
739 /* delta is freed in got_object_close() */
740 deltas->nentries++;
741 SIMPLEQ_INSERT_HEAD(&deltas->entries, delta, entry);
742 return NULL;
745 static const struct got_error *
746 resolve_offset_delta(struct got_delta_chain *deltas,
747 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
748 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
751 const struct got_error *err;
752 off_t base_offset;
753 uint8_t base_type;
754 uint64_t base_size;
755 size_t base_tslen;
756 off_t delta_data_offset;
757 size_t consumed;
759 err = got_pack_parse_offset_delta(&base_offset, &consumed, pack,
760 delta_offset, tslen);
761 if (err)
762 return err;
764 delta_data_offset = delta_offset + tslen + consumed;
765 if (delta_data_offset >= pack->filesize)
766 return got_error(GOT_ERR_PACK_OFFSET);
768 if (pack->map == NULL) {
769 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
770 if (delta_data_offset == -1)
771 return got_error_from_errno("lseek");
774 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
775 delta_data_offset);
776 if (err)
777 return err;
779 /* An offset delta must be in the same packfile. */
780 if (base_offset >= pack->filesize)
781 return got_error(GOT_ERR_PACK_OFFSET);
783 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
784 &base_tslen, pack, base_offset);
785 if (err)
786 return err;
788 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
789 base_tslen, base_type, base_size, recursion - 1);
792 static const struct got_error *
793 resolve_ref_delta(struct got_delta_chain *deltas, struct got_packidx *packidx,
794 struct got_pack *pack, off_t delta_offset, size_t tslen, int delta_type,
795 size_t delta_size, unsigned int recursion)
797 const struct got_error *err;
798 struct got_object_id id;
799 int idx;
800 off_t base_offset;
801 uint8_t base_type;
802 uint64_t base_size;
803 size_t base_tslen;
804 off_t delta_data_offset;
806 if (delta_offset + tslen >= pack->filesize)
807 return got_error(GOT_ERR_PACK_OFFSET);
809 if (pack->map) {
810 size_t mapoff = delta_offset + tslen;
811 memcpy(&id, pack->map + mapoff, sizeof(id));
812 mapoff += sizeof(id);
813 delta_data_offset = (off_t)mapoff;
814 } else {
815 ssize_t n;
816 n = read(pack->fd, &id, sizeof(id));
817 if (n < 0)
818 return got_error_from_errno("read");
819 if (n != sizeof(id))
820 return got_error(GOT_ERR_BAD_PACKFILE);
821 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
822 if (delta_data_offset == -1)
823 return got_error_from_errno("lseek");
826 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
827 delta_data_offset);
828 if (err)
829 return err;
831 /* Delta base must be in the same pack file. */
832 idx = got_packidx_get_object_idx(packidx, &id);
833 if (idx == -1)
834 return got_error(GOT_ERR_NO_OBJ);
836 base_offset = get_object_offset(packidx, idx);
837 if (base_offset == (uint64_t)-1)
838 return got_error(GOT_ERR_BAD_PACKIDX);
840 if (base_offset >= pack->filesize)
841 return got_error(GOT_ERR_PACK_OFFSET);
843 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
844 &base_tslen, pack, base_offset);
845 if (err)
846 return err;
848 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
849 base_tslen, base_type, base_size, recursion - 1);
852 const struct got_error *
853 got_pack_resolve_delta_chain(struct got_delta_chain *deltas,
854 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
855 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
857 const struct got_error *err = NULL;
859 if (--recursion == 0)
860 return got_error(GOT_ERR_RECURSION);
862 switch (delta_type) {
863 case GOT_OBJ_TYPE_COMMIT:
864 case GOT_OBJ_TYPE_TREE:
865 case GOT_OBJ_TYPE_BLOB:
866 case GOT_OBJ_TYPE_TAG:
867 /* Plain types are the final delta base. Recursion ends. */
868 err = add_delta(deltas, delta_offset, tslen, delta_type,
869 delta_size, 0);
870 break;
871 case GOT_OBJ_TYPE_OFFSET_DELTA:
872 err = resolve_offset_delta(deltas, packidx, pack,
873 delta_offset, tslen, delta_type, delta_size, recursion - 1);
874 break;
875 case GOT_OBJ_TYPE_REF_DELTA:
876 err = resolve_ref_delta(deltas, packidx, pack,
877 delta_offset, tslen, delta_type, delta_size, recursion - 1);
878 break;
879 default:
880 return got_error(GOT_ERR_OBJ_TYPE);
883 return err;
886 static const struct got_error *
887 open_delta_object(struct got_object **obj, struct got_packidx *packidx,
888 struct got_pack *pack, struct got_object_id *id, off_t offset,
889 size_t tslen, int delta_type, size_t delta_size, int idx)
891 const struct got_error *err = NULL;
892 int resolved_type;
894 *obj = calloc(1, sizeof(**obj));
895 if (*obj == NULL)
896 return got_error_from_errno("calloc");
898 (*obj)->flags = 0;
899 (*obj)->hdrlen = 0;
900 (*obj)->size = 0; /* Not known because deltas aren't applied yet. */
901 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
902 (*obj)->pack_offset = offset + tslen;
904 SIMPLEQ_INIT(&(*obj)->deltas.entries);
905 (*obj)->flags |= GOT_OBJ_FLAG_DELTIFIED;
906 (*obj)->flags |= GOT_OBJ_FLAG_PACKED;
907 (*obj)->pack_idx = idx;
909 err = got_pack_resolve_delta_chain(&(*obj)->deltas, packidx, pack,
910 offset, tslen, delta_type, delta_size,
911 GOT_DELTA_CHAIN_RECURSION_MAX);
912 if (err)
913 goto done;
915 err = got_delta_chain_get_base_type(&resolved_type, &(*obj)->deltas);
916 if (err)
917 goto done;
918 (*obj)->type = resolved_type;
919 done:
920 if (err) {
921 got_object_close(*obj);
922 *obj = NULL;
924 return err;
927 const struct got_error *
928 got_packfile_open_object(struct got_object **obj, struct got_pack *pack,
929 struct got_packidx *packidx, int idx, struct got_object_id *id)
931 const struct got_error *err = NULL;
932 off_t offset;
933 uint8_t type;
934 uint64_t size;
935 size_t tslen;
937 *obj = NULL;
939 offset = get_object_offset(packidx, idx);
940 if (offset == (uint64_t)-1)
941 return got_error(GOT_ERR_BAD_PACKIDX);
943 err = got_pack_parse_object_type_and_size(&type, &size, &tslen,
944 pack, offset);
945 if (err)
946 return err;
948 switch (type) {
949 case GOT_OBJ_TYPE_COMMIT:
950 case GOT_OBJ_TYPE_TREE:
951 case GOT_OBJ_TYPE_BLOB:
952 case GOT_OBJ_TYPE_TAG:
953 err = open_plain_object(obj, id, type, offset + tslen,
954 size, idx);
955 break;
956 case GOT_OBJ_TYPE_OFFSET_DELTA:
957 case GOT_OBJ_TYPE_REF_DELTA:
958 err = open_delta_object(obj, packidx, pack, id, offset,
959 tslen, type, size, idx);
960 break;
961 default:
962 err = got_error(GOT_ERR_OBJ_TYPE);
963 break;
966 return err;
969 const struct got_error *
970 got_pack_get_delta_chain_max_size(uint64_t *max_size, struct got_delta_chain *deltas,
971 struct got_pack *pack)
973 struct got_delta *delta;
974 uint64_t base_size = 0, result_size = 0;
976 *max_size = 0;
977 SIMPLEQ_FOREACH(delta, &deltas->entries, entry) {
978 /* Plain object types are the delta base. */
979 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
980 delta->type != GOT_OBJ_TYPE_TREE &&
981 delta->type != GOT_OBJ_TYPE_BLOB &&
982 delta->type != GOT_OBJ_TYPE_TAG) {
983 const struct got_error *err;
984 uint8_t *delta_buf;
985 size_t delta_len;
986 int cached = 1;
988 got_delta_cache_get(&delta_buf, &delta_len,
989 pack->delta_cache, delta->data_offset);
990 if (delta_buf == NULL) {
991 cached = 0;
992 err = read_delta_data(&delta_buf, &delta_len,
993 delta->data_offset, pack);
994 if (err)
995 return err;
996 err = got_delta_cache_add(pack->delta_cache,
997 delta->data_offset, delta_buf, delta_len);
998 if (err == NULL)
999 cached = 1;
1000 else if (err->code != GOT_ERR_NO_SPACE) {
1001 free(delta_buf);
1002 return err;
1005 err = got_delta_get_sizes(&base_size, &result_size,
1006 delta_buf, delta_len);
1007 if (!cached)
1008 free(delta_buf);
1009 if (err)
1010 return err;
1011 } else
1012 base_size = delta->size;
1013 if (base_size > *max_size)
1014 *max_size = base_size;
1015 if (result_size > *max_size)
1016 *max_size = result_size;
1019 return NULL;
1022 const struct got_error *
1023 got_pack_get_max_delta_object_size(uint64_t *size, struct got_object *obj,
1024 struct got_pack *pack)
1026 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
1027 return got_error(GOT_ERR_OBJ_TYPE);
1029 return got_pack_get_delta_chain_max_size(size, &obj->deltas, pack);
1032 const struct got_error *
1033 got_pack_dump_delta_chain_to_file(size_t *result_size,
1034 struct got_delta_chain *deltas, struct got_pack *pack, FILE *outfile,
1035 FILE *base_file, FILE *accum_file)
1037 const struct got_error *err = NULL;
1038 struct got_delta *delta;
1039 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1040 size_t base_bufsz = 0, accum_size = 0, delta_len;
1041 uint64_t max_size;
1042 int n = 0;
1044 *result_size = 0;
1046 if (SIMPLEQ_EMPTY(&deltas->entries))
1047 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1049 /* We process small enough files entirely in memory for speed. */
1050 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1051 if (err)
1052 return err;
1053 if (max_size < GOT_DELTA_RESULT_SIZE_CACHED_MAX) {
1054 accum_buf = malloc(max_size);
1055 if (accum_buf == NULL)
1056 return got_error_from_errno("malloc");
1057 base_file = NULL;
1058 accum_file = NULL;
1061 /* Deltas are ordered in ascending order. */
1062 SIMPLEQ_FOREACH(delta, &deltas->entries, entry) {
1063 int cached = 1;
1064 if (n == 0) {
1065 size_t mapoff;
1066 off_t delta_data_offset;
1068 /* Plain object types are the delta base. */
1069 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1070 delta->type != GOT_OBJ_TYPE_TREE &&
1071 delta->type != GOT_OBJ_TYPE_BLOB &&
1072 delta->type != GOT_OBJ_TYPE_TAG) {
1073 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1074 goto done;
1077 delta_data_offset = delta->offset + delta->tslen;
1078 if (delta_data_offset >= pack->filesize) {
1079 err = got_error(GOT_ERR_PACK_OFFSET);
1080 goto done;
1082 if (pack->map == NULL) {
1083 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1084 == -1) {
1085 err = got_error_from_errno("lseek");
1086 goto done;
1089 if (base_file) {
1090 if (pack->map) {
1091 mapoff = (size_t)delta_data_offset;
1092 err = got_inflate_to_file_mmap(
1093 &base_bufsz, NULL, NULL, pack->map,
1094 mapoff, pack->filesize - mapoff,
1095 base_file);
1096 } else
1097 err = got_inflate_to_file_fd(
1098 &base_bufsz, NULL, NULL, pack->fd,
1099 base_file);
1100 } else {
1101 if (pack->map) {
1102 mapoff = (size_t)delta_data_offset;
1103 err = got_inflate_to_mem_mmap(&base_buf,
1104 &base_bufsz, NULL, NULL,
1105 pack->map, mapoff,
1106 pack->filesize - mapoff);
1107 } else
1108 err = got_inflate_to_mem_fd(&base_buf,
1109 &base_bufsz, NULL, NULL, max_size,
1110 pack->fd);
1112 if (err)
1113 goto done;
1114 n++;
1115 if (base_file)
1116 rewind(base_file);
1117 continue;
1120 got_delta_cache_get(&delta_buf, &delta_len,
1121 pack->delta_cache, delta->data_offset);
1122 if (delta_buf == NULL) {
1123 cached = 0;
1124 err = read_delta_data(&delta_buf, &delta_len,
1125 delta->data_offset, pack);
1126 if (err)
1127 goto done;
1128 err = got_delta_cache_add(pack->delta_cache,
1129 delta->data_offset, delta_buf, delta_len);
1130 if (err == NULL)
1131 cached = 1;
1132 else if (err->code != GOT_ERR_NO_SPACE) {
1133 free(delta_buf);
1134 goto done;
1137 if (base_buf) {
1138 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1139 delta_buf, delta_len, accum_buf,
1140 &accum_size, max_size);
1141 n++;
1142 } else {
1143 err = got_delta_apply(base_file, delta_buf,
1144 delta_len,
1145 /* Final delta application writes to output file. */
1146 ++n < deltas->nentries ? accum_file : outfile,
1147 &accum_size);
1149 if (!cached)
1150 free(delta_buf);
1151 if (err)
1152 goto done;
1154 if (n < deltas->nentries) {
1155 /* Accumulated delta becomes the new base. */
1156 if (base_buf) {
1157 uint8_t *tmp = accum_buf;
1159 * Base buffer switches roles with accumulation
1160 * buffer. Ensure it can hold the largest
1161 * result in the delta chain. The initial
1162 * allocation might have been smaller.
1164 if (base_bufsz < max_size) {
1165 uint8_t *p;
1166 p = reallocarray(base_buf, 1, max_size);
1167 if (p == NULL) {
1168 err = got_error_from_errno(
1169 "reallocarray");
1170 goto done;
1172 base_buf = p;
1173 base_bufsz = max_size;
1175 accum_buf = base_buf;
1176 base_buf = tmp;
1177 } else {
1178 FILE *tmp = accum_file;
1179 accum_file = base_file;
1180 base_file = tmp;
1181 rewind(base_file);
1182 rewind(accum_file);
1187 done:
1188 free(base_buf);
1189 if (accum_buf) {
1190 size_t len = fwrite(accum_buf, 1, accum_size, outfile);
1191 free(accum_buf);
1192 if (len != accum_size)
1193 err = got_ferror(outfile, GOT_ERR_IO);
1195 rewind(outfile);
1196 if (err == NULL)
1197 *result_size = accum_size;
1198 return err;
1201 const struct got_error *
1202 got_pack_dump_delta_chain_to_mem(uint8_t **outbuf, size_t *outlen,
1203 struct got_delta_chain *deltas, struct got_pack *pack)
1205 const struct got_error *err = NULL;
1206 struct got_delta *delta;
1207 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1208 size_t base_bufsz = 0, accum_size = 0, delta_len;
1209 uint64_t max_size;
1210 int n = 0;
1212 *outbuf = NULL;
1213 *outlen = 0;
1215 if (SIMPLEQ_EMPTY(&deltas->entries))
1216 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1218 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1219 if (err)
1220 return err;
1221 accum_buf = malloc(max_size);
1222 if (accum_buf == NULL)
1223 return got_error_from_errno("malloc");
1225 /* Deltas are ordered in ascending order. */
1226 SIMPLEQ_FOREACH(delta, &deltas->entries, entry) {
1227 int cached = 1;
1228 if (n == 0) {
1229 size_t delta_data_offset;
1231 /* Plain object types are the delta base. */
1232 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1233 delta->type != GOT_OBJ_TYPE_TREE &&
1234 delta->type != GOT_OBJ_TYPE_BLOB &&
1235 delta->type != GOT_OBJ_TYPE_TAG) {
1236 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1237 goto done;
1240 delta_data_offset = delta->offset + delta->tslen;
1241 if (delta_data_offset >= pack->filesize) {
1242 err = got_error(GOT_ERR_PACK_OFFSET);
1243 goto done;
1245 if (pack->map) {
1246 size_t mapoff = (size_t)delta_data_offset;
1247 err = got_inflate_to_mem_mmap(&base_buf,
1248 &base_bufsz, NULL, NULL, pack->map,
1249 mapoff, pack->filesize - mapoff);
1250 } else {
1251 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1252 == -1) {
1253 err = got_error_from_errno("lseek");
1254 goto done;
1256 err = got_inflate_to_mem_fd(&base_buf,
1257 &base_bufsz, NULL, NULL, max_size,
1258 pack->fd);
1260 if (err)
1261 goto done;
1262 n++;
1263 continue;
1266 got_delta_cache_get(&delta_buf, &delta_len,
1267 pack->delta_cache, delta->data_offset);
1268 if (delta_buf == NULL) {
1269 cached = 0;
1270 err = read_delta_data(&delta_buf, &delta_len,
1271 delta->data_offset, pack);
1272 if (err)
1273 goto done;
1274 err = got_delta_cache_add(pack->delta_cache,
1275 delta->data_offset, delta_buf, delta_len);
1276 if (err == NULL)
1277 cached = 1;
1278 else if (err->code != GOT_ERR_NO_SPACE) {
1279 free(delta_buf);
1280 goto done;
1283 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1284 delta_buf, delta_len, accum_buf,
1285 &accum_size, max_size);
1286 if (!cached)
1287 free(delta_buf);
1288 n++;
1289 if (err)
1290 goto done;
1292 if (n < deltas->nentries) {
1293 /* Accumulated delta becomes the new base. */
1294 uint8_t *tmp = accum_buf;
1296 * Base buffer switches roles with accumulation buffer.
1297 * Ensure it can hold the largest result in the delta
1298 * chain. Initial allocation might have been smaller.
1300 if (base_bufsz < max_size) {
1301 uint8_t *p;
1302 p = reallocarray(base_buf, 1, max_size);
1303 if (p == NULL) {
1304 err = got_error_from_errno(
1305 "reallocarray");
1306 goto done;
1308 base_buf = p;
1309 base_bufsz = max_size;
1311 accum_buf = base_buf;
1312 base_buf = tmp;
1316 done:
1317 free(base_buf);
1318 if (err) {
1319 free(accum_buf);
1320 *outbuf = NULL;
1321 *outlen = 0;
1322 } else {
1323 *outbuf = accum_buf;
1324 *outlen = accum_size;
1326 return err;
1329 const struct got_error *
1330 got_packfile_extract_object(struct got_pack *pack, struct got_object *obj,
1331 FILE *outfile, FILE *base_file, FILE *accum_file)
1333 const struct got_error *err = NULL;
1335 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1336 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1338 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1339 if (obj->pack_offset >= pack->filesize)
1340 return got_error(GOT_ERR_PACK_OFFSET);
1342 if (pack->map) {
1343 size_t mapoff = (size_t)obj->pack_offset;
1344 err = got_inflate_to_file_mmap(&obj->size, NULL, NULL,
1345 pack->map, mapoff, pack->filesize - mapoff,
1346 outfile);
1347 } else {
1348 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1349 return got_error_from_errno("lseek");
1350 err = got_inflate_to_file_fd(&obj->size, NULL, NULL,
1351 pack->fd, outfile);
1353 } else
1354 err = got_pack_dump_delta_chain_to_file(&obj->size,
1355 &obj->deltas, pack, outfile, base_file, accum_file);
1357 return err;
1360 const struct got_error *
1361 got_packfile_extract_object_to_mem(uint8_t **buf, size_t *len,
1362 struct got_object *obj, struct got_pack *pack)
1364 const struct got_error *err = NULL;
1366 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1367 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1369 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1370 if (obj->pack_offset >= pack->filesize)
1371 return got_error(GOT_ERR_PACK_OFFSET);
1372 if (pack->map) {
1373 size_t mapoff = (size_t)obj->pack_offset;
1374 err = got_inflate_to_mem_mmap(buf, len, NULL, NULL,
1375 pack->map, mapoff, pack->filesize - mapoff);
1376 } else {
1377 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1378 return got_error_from_errno("lseek");
1379 err = got_inflate_to_mem_fd(buf, len, NULL, NULL,
1380 obj->size, pack->fd);
1382 } else
1383 err = got_pack_dump_delta_chain_to_mem(buf, len, &obj->deltas,
1384 pack);
1386 return err;