2 * Copyright (c) 2018, 2019, 2020 Stefan Sperling <stsp@openbsd.org>
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.
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.
17 #include <sys/types.h>
32 #include "got_error.h"
33 #include "got_object.h"
36 #include "got_lib_sha1.h"
37 #include "got_lib_delta.h"
38 #include "got_lib_delta_cache.h"
39 #include "got_lib_inflate.h"
40 #include "got_lib_object.h"
41 #include "got_lib_object_parse.h"
42 #include "got_lib_privsep.h"
43 #include "got_lib_pack.h"
46 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
50 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
53 static const struct got_error *
54 verify_fanout_table(uint32_t *fanout_table)
58 for (i = 0; i < 0xff - 1; i++) {
59 if (be32toh(fanout_table[i]) > be32toh(fanout_table[i + 1]))
60 return got_error(GOT_ERR_BAD_PACKIDX);
66 const struct got_error *
67 got_packidx_init_hdr(struct got_packidx *p, int verify, off_t packfile_size)
69 const struct got_error *err = NULL;
70 struct got_packidx_v2_hdr *h;
72 uint8_t sha1[SHA1_DIGEST_LENGTH];
73 size_t nobj, len_fanout, len_ids, offset, remain;
83 if (remain < sizeof(*h->magic)) {
84 err = got_error(GOT_ERR_BAD_PACKIDX);
88 h->magic = (uint32_t *)(p->map + offset);
90 h->magic = malloc(sizeof(*h->magic));
91 if (h->magic == NULL) {
92 err = got_error_from_errno("malloc");
95 n = read(p->fd, h->magic, sizeof(*h->magic));
97 err = got_error_from_errno("read");
99 } else if (n != sizeof(*h->magic)) {
100 err = got_error(GOT_ERR_BAD_PACKIDX);
104 if (*h->magic != htobe32(GOT_PACKIDX_V2_MAGIC)) {
105 err = got_error(GOT_ERR_BAD_PACKIDX);
108 offset += sizeof(*h->magic);
109 remain -= sizeof(*h->magic);
112 SHA1Update(&ctx, (uint8_t *)h->magic, sizeof(*h->magic));
114 if (remain < sizeof(*h->version)) {
115 err = got_error(GOT_ERR_BAD_PACKIDX);
119 h->version = (uint32_t *)(p->map + offset);
121 h->version = malloc(sizeof(*h->version));
122 if (h->version == NULL) {
123 err = got_error_from_errno("malloc");
126 n = read(p->fd, h->version, sizeof(*h->version));
128 err = got_error_from_errno("read");
130 } else if (n != sizeof(*h->version)) {
131 err = got_error(GOT_ERR_BAD_PACKIDX);
135 if (*h->version != htobe32(GOT_PACKIDX_VERSION)) {
136 err = got_error(GOT_ERR_BAD_PACKIDX);
139 offset += sizeof(*h->version);
140 remain -= sizeof(*h->version);
143 SHA1Update(&ctx, (uint8_t *)h->version, sizeof(*h->version));
146 sizeof(*h->fanout_table) * GOT_PACKIDX_V2_FANOUT_TABLE_ITEMS;
147 if (remain < len_fanout) {
148 err = got_error(GOT_ERR_BAD_PACKIDX);
152 h->fanout_table = (uint32_t *)(p->map + offset);
154 h->fanout_table = malloc(len_fanout);
155 if (h->fanout_table == NULL) {
156 err = got_error_from_errno("malloc");
159 n = read(p->fd, h->fanout_table, len_fanout);
161 err = got_error_from_errno("read");
163 } else if (n != len_fanout) {
164 err = got_error(GOT_ERR_BAD_PACKIDX);
168 err = verify_fanout_table(h->fanout_table);
172 SHA1Update(&ctx, (uint8_t *)h->fanout_table, len_fanout);
173 offset += len_fanout;
174 remain -= len_fanout;
176 nobj = be32toh(h->fanout_table[0xff]);
177 len_ids = nobj * sizeof(*h->sorted_ids);
178 if (len_ids <= nobj || len_ids > remain) {
179 err = got_error(GOT_ERR_BAD_PACKIDX);
184 (struct got_packidx_object_id *)((uint8_t*)(p->map + offset));
186 h->sorted_ids = malloc(len_ids);
187 if (h->sorted_ids == NULL) {
188 err = got_error(GOT_ERR_BAD_PACKIDX);
191 n = read(p->fd, h->sorted_ids, len_ids);
193 err = got_error_from_errno("read");
194 else if (n != len_ids) {
195 err = got_error(GOT_ERR_BAD_PACKIDX);
200 SHA1Update(&ctx, (uint8_t *)h->sorted_ids, len_ids);
204 if (remain < nobj * sizeof(*h->crc32)) {
205 err = got_error(GOT_ERR_BAD_PACKIDX);
209 h->crc32 = (uint32_t *)((uint8_t*)(p->map + offset));
211 h->crc32 = malloc(nobj * sizeof(*h->crc32));
212 if (h->crc32 == NULL) {
213 err = got_error_from_errno("malloc");
216 n = read(p->fd, h->crc32, nobj * sizeof(*h->crc32));
218 err = got_error_from_errno("read");
219 else if (n != nobj * sizeof(*h->crc32)) {
220 err = got_error(GOT_ERR_BAD_PACKIDX);
225 SHA1Update(&ctx, (uint8_t *)h->crc32, nobj * sizeof(*h->crc32));
226 remain -= nobj * sizeof(*h->crc32);
227 offset += nobj * sizeof(*h->crc32);
229 if (remain < nobj * sizeof(*h->offsets)) {
230 err = got_error(GOT_ERR_BAD_PACKIDX);
234 h->offsets = (uint32_t *)((uint8_t*)(p->map + offset));
236 h->offsets = malloc(nobj * sizeof(*h->offsets));
237 if (h->offsets == NULL) {
238 err = got_error_from_errno("malloc");
241 n = read(p->fd, h->offsets, nobj * sizeof(*h->offsets));
243 err = got_error_from_errno("read");
244 else if (n != nobj * sizeof(*h->offsets)) {
245 err = got_error(GOT_ERR_BAD_PACKIDX);
250 SHA1Update(&ctx, (uint8_t *)h->offsets,
251 nobj * sizeof(*h->offsets));
252 remain -= nobj * sizeof(*h->offsets);
253 offset += nobj * sizeof(*h->offsets);
255 /* Large file offsets are contained only in files > 2GB. */
256 if (verify || packfile_size > 0x7fffffff) {
257 for (i = 0; i < nobj; i++) {
258 uint32_t o = h->offsets[i];
259 if (o & htobe32(GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX))
263 if (p->nlargeobj == 0)
265 else if (packfile_size <= 0x7fffffff) {
266 err = got_error(GOT_ERR_BAD_PACKIDX);
270 if (remain < p->nlargeobj * sizeof(*h->large_offsets)) {
271 err = got_error(GOT_ERR_BAD_PACKIDX);
275 h->large_offsets = (uint64_t *)((uint8_t*)(p->map + offset));
277 h->large_offsets = malloc(p->nlargeobj *
278 sizeof(*h->large_offsets));
279 if (h->large_offsets == NULL) {
280 err = got_error_from_errno("malloc");
283 n = read(p->fd, h->large_offsets,
284 p->nlargeobj * sizeof(*h->large_offsets));
286 err = got_error_from_errno("read");
287 else if (n != p->nlargeobj * sizeof(*h->large_offsets)) {
288 err = got_error(GOT_ERR_BAD_PACKIDX);
293 SHA1Update(&ctx, (uint8_t*)h->large_offsets,
294 p->nlargeobj * sizeof(*h->large_offsets));
295 remain -= p->nlargeobj * sizeof(*h->large_offsets);
296 offset += p->nlargeobj * sizeof(*h->large_offsets);
299 if (remain < sizeof(*h->trailer)) {
300 err = got_error(GOT_ERR_BAD_PACKIDX);
305 (struct got_packidx_trailer *)((uint8_t*)(p->map + offset));
307 h->trailer = malloc(sizeof(*h->trailer));
308 if (h->trailer == NULL) {
309 err = got_error_from_errno("malloc");
312 n = read(p->fd, h->trailer, sizeof(*h->trailer));
314 err = got_error_from_errno("read");
315 else if (n != sizeof(*h->trailer)) {
316 err = got_error(GOT_ERR_BAD_PACKIDX);
321 SHA1Update(&ctx, h->trailer->packfile_sha1, SHA1_DIGEST_LENGTH);
322 SHA1Final(sha1, &ctx);
323 if (memcmp(h->trailer->packidx_sha1, sha1,
324 SHA1_DIGEST_LENGTH) != 0)
325 err = got_error(GOT_ERR_PACKIDX_CSUM);
331 const struct got_error *
332 got_packidx_open(struct got_packidx **packidx,
333 int dir_fd, const char *relpath, int verify)
335 const struct got_error *err = NULL;
336 struct got_packidx *p = NULL;
338 struct stat idx_sb, pack_sb;
342 err = got_packidx_get_packfile_path(&pack_relpath, relpath);
347 * Ensure that a corresponding pack file exists.
348 * Some Git repositories have this problem. Git seems to ignore
349 * the existence of lonely pack index files but we do not.
351 if (fstatat(dir_fd, pack_relpath, &pack_sb, 0) == -1) {
352 if (errno == ENOENT) {
353 err = got_error_fmt(GOT_ERR_LONELY_PACKIDX,
356 err = got_error_from_errno2("fstatat", pack_relpath);
360 p = calloc(1, sizeof(*p));
362 err = got_error_from_errno("calloc");
366 p->fd = openat(dir_fd, relpath, O_RDONLY | O_NOFOLLOW | O_CLOEXEC);
368 err = got_error_from_errno2("openat", relpath);
372 if (fstat(p->fd, &idx_sb) != 0) {
373 err = got_error_from_errno2("fstat", relpath);
376 p->len = idx_sb.st_size;
377 if (p->len < sizeof(p->hdr)) {
378 err = got_error(GOT_ERR_BAD_PACKIDX);
382 p->path_packidx = strdup(relpath);
383 if (p->path_packidx == NULL) {
384 err = got_error_from_errno("strdup");
388 #ifndef GOT_PACK_NO_MMAP
389 p->map = mmap(NULL, p->len, PROT_READ, MAP_PRIVATE, p->fd, 0);
390 if (p->map == MAP_FAILED) {
391 if (errno != ENOMEM) {
392 err = got_error_from_errno("mmap");
395 p->map = NULL; /* fall back to read(2) */
399 err = got_packidx_init_hdr(p, verify, pack_sb.st_size);
403 got_packidx_close(p);
410 const struct got_error *
411 got_packidx_close(struct got_packidx *packidx)
413 const struct got_error *err = NULL;
415 free(packidx->path_packidx);
417 if (munmap(packidx->map, packidx->len) == -1)
418 err = got_error_from_errno("munmap");
420 free(packidx->hdr.magic);
421 free(packidx->hdr.version);
422 free(packidx->hdr.fanout_table);
423 free(packidx->hdr.sorted_ids);
424 free(packidx->hdr.crc32);
425 free(packidx->hdr.offsets);
426 free(packidx->hdr.large_offsets);
427 free(packidx->hdr.trailer);
429 if (close(packidx->fd) == -1 && err == NULL)
430 err = got_error_from_errno("close");
431 free(packidx->sorted_offsets);
432 free(packidx->sorted_large_offsets);
438 const struct got_error *
439 got_packidx_get_packfile_path(char **path_packfile, const char *path_packidx)
443 /* Packfile path contains ".pack" instead of ".idx", so add one byte. */
444 size = strlen(path_packidx) + 2;
445 if (size < GOT_PACKFILE_NAMELEN + 1)
446 return got_error_path(path_packidx, GOT_ERR_BAD_PATH);
448 *path_packfile = malloc(size);
449 if (*path_packfile == NULL)
450 return got_error_from_errno("malloc");
452 /* Copy up to and excluding ".idx". */
453 if (strlcpy(*path_packfile, path_packidx,
454 size - strlen(GOT_PACKIDX_SUFFIX) - 1) >= size)
455 return got_error(GOT_ERR_NO_SPACE);
457 if (strlcat(*path_packfile, GOT_PACKFILE_SUFFIX, size) >= size)
458 return got_error(GOT_ERR_NO_SPACE);
464 got_packidx_get_object_offset(struct got_packidx *packidx, int idx)
466 uint32_t offset = be32toh(packidx->hdr.offsets[idx]);
467 if (offset & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX) {
469 idx = offset & GOT_PACKIDX_OFFSET_VAL_MASK;
470 if (idx < 0 || idx >= packidx->nlargeobj ||
471 packidx->hdr.large_offsets == NULL)
473 loffset = be64toh(packidx->hdr.large_offsets[idx]);
474 return (loffset > INT64_MAX ? -1 : (off_t)loffset);
476 return (off_t)(offset & GOT_PACKIDX_OFFSET_VAL_MASK);
480 got_packidx_get_object_idx(struct got_packidx *packidx,
481 struct got_object_id *id)
483 u_int8_t id0 = id->sha1[0];
484 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
485 int left = 0, right = totobj - 1;
488 left = be32toh(packidx->hdr.fanout_table[id0 - 1]);
490 while (left <= right) {
491 struct got_packidx_object_id *oid;
494 i = ((left + right) / 2);
495 oid = &packidx->hdr.sorted_ids[i];
496 cmp = memcmp(id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
509 offset_cmp(const void *pa, const void *pb)
511 const struct got_pack_offset_index *a, *b;
513 a = (const struct got_pack_offset_index *)pa;
514 b = (const struct got_pack_offset_index *)pb;
516 if (a->offset < b->offset)
518 else if (a->offset > b->offset)
525 large_offset_cmp(const void *pa, const void *pb)
527 const struct got_pack_large_offset_index *a, *b;
529 a = (const struct got_pack_large_offset_index *)pa;
530 b = (const struct got_pack_large_offset_index *)pb;
532 if (a->offset < b->offset)
534 else if (a->offset > b->offset)
540 static const struct got_error *
541 build_offset_index(struct got_packidx *p)
543 uint32_t nobj = be32toh(p->hdr.fanout_table[0xff]);
544 unsigned int i, j, k;
546 p->sorted_offsets = calloc(nobj - p->nlargeobj,
547 sizeof(p->sorted_offsets[0]));
548 if (p->sorted_offsets == NULL)
549 return got_error_from_errno("calloc");
551 if (p->nlargeobj > 0) {
552 p->sorted_large_offsets = calloc(p->nlargeobj,
553 sizeof(p->sorted_large_offsets[0]));
554 if (p->sorted_large_offsets == NULL)
555 return got_error_from_errno("calloc");
560 for (i = 0; i < nobj; i++) {
561 uint32_t offset = be32toh(p->hdr.offsets[i]);
562 if (offset & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX) {
565 idx = offset & GOT_PACKIDX_OFFSET_VAL_MASK;
566 if (idx >= p->nlargeobj ||
568 p->hdr.large_offsets == NULL)
569 return got_error(GOT_ERR_BAD_PACKIDX);
570 loffset = be64toh(p->hdr.large_offsets[idx]);
571 p->sorted_large_offsets[j].offset = loffset;
572 p->sorted_large_offsets[j].idx = i;
575 p->sorted_offsets[k].offset = offset;
576 p->sorted_offsets[k].idx = i;
580 if (j != p->nlargeobj || k != nobj - p->nlargeobj)
581 return got_error(GOT_ERR_BAD_PACKIDX);
583 qsort(p->sorted_offsets, nobj - p->nlargeobj,
584 sizeof(p->sorted_offsets[0]), offset_cmp);
586 if (p->sorted_large_offsets)
587 qsort(p->sorted_large_offsets, p->nlargeobj,
588 sizeof(p->sorted_large_offsets[0]), large_offset_cmp);
593 const struct got_error *
594 got_packidx_get_offset_idx(int *idx, struct got_packidx *packidx, off_t offset)
596 const struct got_error *err;
597 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
602 if (packidx->sorted_offsets == NULL) {
603 err = build_offset_index(packidx);
608 if (offset >= 0x7fffffff) {
610 left = 0, right = packidx->nlargeobj - 1;
611 while (left <= right) {
612 i = ((left + right) / 2);
613 lo = packidx->sorted_large_offsets[i].offset;
615 *idx = packidx->sorted_large_offsets[i].idx;
617 } else if (offset > lo)
619 else if (offset < lo)
624 left = 0, right = totobj - packidx->nlargeobj - 1;
625 while (left <= right) {
626 i = ((left + right) / 2);
627 o = packidx->sorted_offsets[i].offset;
629 *idx = packidx->sorted_offsets[i].idx;
631 } else if (offset > o)
641 const struct got_error *
642 got_packidx_get_object_id(struct got_object_id *id,
643 struct got_packidx *packidx, int idx)
645 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
646 struct got_packidx_object_id *oid;
648 if (idx < 0 || idx >= totobj)
649 return got_error(GOT_ERR_NO_OBJ);
651 oid = &packidx->hdr.sorted_ids[idx];
652 memcpy(id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
656 const struct got_error *
657 got_packidx_match_id_str_prefix(struct got_object_id_queue *matched_ids,
658 struct got_packidx *packidx, const char *id_str_prefix)
660 const struct got_error *err = NULL;
662 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
664 size_t prefix_len = strlen(id_str_prefix);
665 struct got_packidx_object_id *oid;
668 STAILQ_INIT(matched_ids);
671 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
673 hex[0] = id_str_prefix[0];
674 hex[1] = id_str_prefix[1];
676 if (!got_parse_xdigit(&id0, hex))
677 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
680 i = be32toh(packidx->hdr.fanout_table[id0 - 1]);
681 oid = &packidx->hdr.sorted_ids[i];
682 while (i < totobj && oid->sha1[0] == id0) {
683 char id_str[SHA1_DIGEST_STRING_LENGTH];
684 struct got_object_qid *qid;
687 if (!got_sha1_digest_to_str(oid->sha1, id_str, sizeof(id_str)))
688 return got_error(GOT_ERR_NO_SPACE);
690 cmp = strncmp(id_str, id_str_prefix, prefix_len);
692 oid = &packidx->hdr.sorted_ids[++i];
697 err = got_object_qid_alloc_partial(&qid);
700 memcpy(qid->id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
701 STAILQ_INSERT_TAIL(matched_ids, qid, entry);
703 oid = &packidx->hdr.sorted_ids[++i];
707 got_object_id_queue_free(matched_ids);
711 static const struct got_error *
712 pack_stop_privsep_child(struct got_pack *pack)
714 const struct got_error *err = NULL;
716 if (pack->privsep_child == NULL)
719 err = got_privsep_send_stop(pack->privsep_child->imsg_fd);
722 err = got_privsep_wait_for_child(pack->privsep_child->pid);
723 if (close(pack->privsep_child->imsg_fd) == -1 && err == NULL)
724 err = got_error_from_errno("close");
725 free(pack->privsep_child->ibuf);
726 free(pack->privsep_child);
727 pack->privsep_child = NULL;
731 const struct got_error *
732 got_pack_close(struct got_pack *pack)
734 const struct got_error *err = NULL;
736 err = pack_stop_privsep_child(pack);
737 if (pack->map && munmap(pack->map, pack->filesize) == -1 && !err)
738 err = got_error_from_errno("munmap");
739 if (pack->fd != -1 && close(pack->fd) == -1 && err == NULL)
740 err = got_error_from_errno("close");
742 free(pack->path_packfile);
743 pack->path_packfile = NULL;
745 if (pack->delta_cache) {
746 got_delta_cache_free(pack->delta_cache);
747 pack->delta_cache = NULL;
753 const struct got_error *
754 got_pack_parse_object_type_and_size(uint8_t *type, uint64_t *size, size_t *len,
755 struct got_pack *pack, off_t offset)
765 if (offset >= pack->filesize)
766 return got_error(GOT_ERR_PACK_OFFSET);
769 mapoff = (size_t)offset;
771 if (lseek(pack->fd, offset, SEEK_SET) == -1)
772 return got_error_from_errno("lseek");
776 /* We do not support size values which don't fit in 64 bit. */
778 return got_error(GOT_ERR_NO_SPACE);
781 if (mapoff + sizeof(sizeN) >= pack->filesize)
782 return got_error(GOT_ERR_BAD_PACKFILE);
783 sizeN = *(pack->map + mapoff);
784 mapoff += sizeof(sizeN);
786 ssize_t n = read(pack->fd, &sizeN, sizeof(sizeN));
788 return got_error_from_errno("read");
789 if (n != sizeof(sizeN))
790 return got_error(GOT_ERR_BAD_PACKFILE);
792 *len += sizeof(sizeN);
795 t = (sizeN & GOT_PACK_OBJ_SIZE0_TYPE_MASK) >>
796 GOT_PACK_OBJ_SIZE0_TYPE_MASK_SHIFT;
797 s = (sizeN & GOT_PACK_OBJ_SIZE0_VAL_MASK);
799 size_t shift = 4 + 7 * (i - 1);
800 s |= ((sizeN & GOT_PACK_OBJ_SIZE_VAL_MASK) << shift);
803 } while (sizeN & GOT_PACK_OBJ_SIZE_MORE);
810 static const struct got_error *
811 open_plain_object(struct got_object **obj, struct got_object_id *id,
812 uint8_t type, off_t offset, size_t size, int idx)
814 *obj = calloc(1, sizeof(**obj));
816 return got_error_from_errno("calloc");
819 (*obj)->flags = GOT_OBJ_FLAG_PACKED;
820 (*obj)->pack_idx = idx;
823 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
824 (*obj)->pack_offset = offset;
829 static const struct got_error *
830 parse_negative_offset(int64_t *offset, size_t *len, struct got_pack *pack,
841 /* We do not support offset values which don't fit in 64 bit. */
843 return got_error(GOT_ERR_NO_SPACE);
847 mapoff = (size_t)delta_offset + *len;
848 if (mapoff + sizeof(offN) >= pack->filesize)
849 return got_error(GOT_ERR_PACK_OFFSET);
850 offN = *(pack->map + mapoff);
853 n = read(pack->fd, &offN, sizeof(offN));
855 return got_error_from_errno("read");
856 if (n != sizeof(offN))
857 return got_error(GOT_ERR_BAD_PACKFILE);
859 *len += sizeof(offN);
862 o = (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
866 o += (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
869 } while (offN & GOT_PACK_OBJ_DELTA_OFF_MORE);
875 const struct got_error *
876 got_pack_parse_offset_delta(off_t *base_offset, size_t *len,
877 struct got_pack *pack, off_t offset, int tslen)
879 const struct got_error *err;
885 err = parse_negative_offset(&negoffset, &negofflen, pack,
890 /* Compute the base object's offset (must be in the same pack file). */
891 *base_offset = (offset - negoffset);
892 if (*base_offset <= 0)
893 return got_error(GOT_ERR_BAD_PACKFILE);
899 static const struct got_error *
900 read_delta_data(uint8_t **delta_buf, size_t *delta_len,
901 size_t delta_data_offset, struct got_pack *pack)
903 const struct got_error *err = NULL;
906 if (delta_data_offset >= pack->filesize)
907 return got_error(GOT_ERR_PACK_OFFSET);
908 err = got_inflate_to_mem_mmap(delta_buf, delta_len,
909 NULL, NULL, pack->map, delta_data_offset,
910 pack->filesize - delta_data_offset);
912 if (lseek(pack->fd, delta_data_offset, SEEK_SET) == -1)
913 return got_error_from_errno("lseek");
914 err = got_inflate_to_mem_fd(delta_buf, delta_len, NULL,
920 static const struct got_error *
921 add_delta(struct got_delta_chain *deltas, off_t delta_offset, size_t tslen,
922 int delta_type, size_t delta_size, size_t delta_data_offset)
924 struct got_delta *delta;
926 delta = got_delta_open(delta_offset, tslen, delta_type, delta_size,
929 return got_error_from_errno("got_delta_open");
930 /* delta is freed in got_object_close() */
932 STAILQ_INSERT_HEAD(&deltas->entries, delta, entry);
936 static const struct got_error *
937 resolve_offset_delta(struct got_delta_chain *deltas,
938 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
939 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
942 const struct got_error *err;
947 off_t delta_data_offset;
950 err = got_pack_parse_offset_delta(&base_offset, &consumed, pack,
951 delta_offset, tslen);
955 delta_data_offset = delta_offset + tslen + consumed;
956 if (delta_data_offset >= pack->filesize)
957 return got_error(GOT_ERR_PACK_OFFSET);
959 if (pack->map == NULL) {
960 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
961 if (delta_data_offset == -1)
962 return got_error_from_errno("lseek");
965 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
970 /* An offset delta must be in the same packfile. */
971 if (base_offset >= pack->filesize)
972 return got_error(GOT_ERR_PACK_OFFSET);
974 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
975 &base_tslen, pack, base_offset);
979 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
980 base_tslen, base_type, base_size, recursion - 1);
983 const struct got_error *
984 got_pack_parse_ref_delta(struct got_object_id *id,
985 struct got_pack *pack, off_t delta_offset, int tslen)
988 size_t mapoff = delta_offset + tslen;
989 if (mapoff + sizeof(*id) >= pack->filesize)
990 return got_error(GOT_ERR_PACK_OFFSET);
991 memcpy(id, pack->map + mapoff, sizeof(*id));
994 n = read(pack->fd, id, sizeof(*id));
996 return got_error_from_errno("read");
997 if (n != sizeof(*id))
998 return got_error(GOT_ERR_BAD_PACKFILE);
1004 static const struct got_error *
1005 resolve_ref_delta(struct got_delta_chain *deltas, struct got_packidx *packidx,
1006 struct got_pack *pack, off_t delta_offset, size_t tslen, int delta_type,
1007 size_t delta_size, unsigned int recursion)
1009 const struct got_error *err;
1010 struct got_object_id id;
1016 off_t delta_data_offset;
1018 if (delta_offset + tslen >= pack->filesize)
1019 return got_error(GOT_ERR_PACK_OFFSET);
1021 err = got_pack_parse_ref_delta(&id, pack, delta_offset, tslen);
1025 delta_data_offset = delta_offset + tslen + sizeof(id);
1027 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
1028 if (delta_data_offset == -1)
1029 return got_error_from_errno("lseek");
1032 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
1037 /* Delta base must be in the same pack file. */
1038 idx = got_packidx_get_object_idx(packidx, &id);
1040 return got_error(GOT_ERR_NO_OBJ);
1042 base_offset = got_packidx_get_object_offset(packidx, idx);
1043 if (base_offset == (uint64_t)-1)
1044 return got_error(GOT_ERR_BAD_PACKIDX);
1046 if (base_offset >= pack->filesize)
1047 return got_error(GOT_ERR_PACK_OFFSET);
1049 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
1050 &base_tslen, pack, base_offset);
1054 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
1055 base_tslen, base_type, base_size, recursion - 1);
1058 const struct got_error *
1059 got_pack_resolve_delta_chain(struct got_delta_chain *deltas,
1060 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
1061 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
1063 const struct got_error *err = NULL;
1065 if (--recursion == 0)
1066 return got_error(GOT_ERR_RECURSION);
1068 switch (delta_type) {
1069 case GOT_OBJ_TYPE_COMMIT:
1070 case GOT_OBJ_TYPE_TREE:
1071 case GOT_OBJ_TYPE_BLOB:
1072 case GOT_OBJ_TYPE_TAG:
1073 /* Plain types are the final delta base. Recursion ends. */
1074 err = add_delta(deltas, delta_offset, tslen, delta_type,
1077 case GOT_OBJ_TYPE_OFFSET_DELTA:
1078 err = resolve_offset_delta(deltas, packidx, pack,
1079 delta_offset, tslen, delta_type, delta_size, recursion - 1);
1081 case GOT_OBJ_TYPE_REF_DELTA:
1082 err = resolve_ref_delta(deltas, packidx, pack,
1083 delta_offset, tslen, delta_type, delta_size, recursion - 1);
1086 return got_error(GOT_ERR_OBJ_TYPE);
1092 static const struct got_error *
1093 open_delta_object(struct got_object **obj, struct got_packidx *packidx,
1094 struct got_pack *pack, struct got_object_id *id, off_t offset,
1095 size_t tslen, int delta_type, size_t delta_size, int idx)
1097 const struct got_error *err = NULL;
1100 *obj = calloc(1, sizeof(**obj));
1102 return got_error_from_errno("calloc");
1106 (*obj)->size = 0; /* Not known because deltas aren't applied yet. */
1107 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
1108 (*obj)->pack_offset = offset + tslen;
1110 STAILQ_INIT(&(*obj)->deltas.entries);
1111 (*obj)->flags |= GOT_OBJ_FLAG_DELTIFIED;
1112 (*obj)->flags |= GOT_OBJ_FLAG_PACKED;
1113 (*obj)->pack_idx = idx;
1115 err = got_pack_resolve_delta_chain(&(*obj)->deltas, packidx, pack,
1116 offset, tslen, delta_type, delta_size,
1117 GOT_DELTA_CHAIN_RECURSION_MAX);
1121 err = got_delta_chain_get_base_type(&resolved_type, &(*obj)->deltas);
1124 (*obj)->type = resolved_type;
1127 got_object_close(*obj);
1133 const struct got_error *
1134 got_packfile_open_object(struct got_object **obj, struct got_pack *pack,
1135 struct got_packidx *packidx, int idx, struct got_object_id *id)
1137 const struct got_error *err = NULL;
1145 offset = got_packidx_get_object_offset(packidx, idx);
1146 if (offset == (uint64_t)-1)
1147 return got_error(GOT_ERR_BAD_PACKIDX);
1149 err = got_pack_parse_object_type_and_size(&type, &size, &tslen,
1155 case GOT_OBJ_TYPE_COMMIT:
1156 case GOT_OBJ_TYPE_TREE:
1157 case GOT_OBJ_TYPE_BLOB:
1158 case GOT_OBJ_TYPE_TAG:
1159 err = open_plain_object(obj, id, type, offset + tslen,
1162 case GOT_OBJ_TYPE_OFFSET_DELTA:
1163 case GOT_OBJ_TYPE_REF_DELTA:
1164 err = open_delta_object(obj, packidx, pack, id, offset,
1165 tslen, type, size, idx);
1168 err = got_error(GOT_ERR_OBJ_TYPE);
1175 const struct got_error *
1176 got_pack_get_delta_chain_max_size(uint64_t *max_size,
1177 struct got_delta_chain *deltas, struct got_pack *pack)
1179 struct got_delta *delta;
1180 uint64_t base_size = 0, result_size = 0;
1183 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1184 /* Plain object types are the delta base. */
1185 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1186 delta->type != GOT_OBJ_TYPE_TREE &&
1187 delta->type != GOT_OBJ_TYPE_BLOB &&
1188 delta->type != GOT_OBJ_TYPE_TAG) {
1189 const struct got_error *err;
1194 got_delta_cache_get(&delta_buf, &delta_len,
1195 pack->delta_cache, delta->data_offset);
1196 if (delta_buf == NULL) {
1198 err = read_delta_data(&delta_buf, &delta_len,
1199 delta->data_offset, pack);
1202 err = got_delta_cache_add(pack->delta_cache,
1203 delta->data_offset, delta_buf, delta_len);
1206 else if (err->code != GOT_ERR_NO_SPACE) {
1211 err = got_delta_get_sizes(&base_size, &result_size,
1212 delta_buf, delta_len);
1218 base_size = delta->size;
1219 if (base_size > *max_size)
1220 *max_size = base_size;
1221 if (result_size > *max_size)
1222 *max_size = result_size;
1228 const struct got_error *
1229 got_pack_get_max_delta_object_size(uint64_t *size, struct got_object *obj,
1230 struct got_pack *pack)
1232 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
1233 return got_error(GOT_ERR_OBJ_TYPE);
1235 return got_pack_get_delta_chain_max_size(size, &obj->deltas, pack);
1238 const struct got_error *
1239 got_pack_dump_delta_chain_to_file(size_t *result_size,
1240 struct got_delta_chain *deltas, struct got_pack *pack, FILE *outfile,
1241 FILE *base_file, FILE *accum_file)
1243 const struct got_error *err = NULL;
1244 struct got_delta *delta;
1245 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1246 size_t base_bufsz = 0, accum_size = 0, delta_len;
1252 if (STAILQ_EMPTY(&deltas->entries))
1253 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1255 /* We process small enough files entirely in memory for speed. */
1256 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1259 if (max_size < GOT_DELTA_RESULT_SIZE_CACHED_MAX) {
1260 accum_buf = malloc(max_size);
1261 if (accum_buf == NULL)
1262 return got_error_from_errno("malloc");
1266 if (fseeko(base_file, 0L, SEEK_SET) == -1)
1267 return got_error_from_errno("fseeko");
1268 if (fseeko(accum_file, 0L, SEEK_SET) == -1)
1269 return got_error_from_errno("fseeko");
1272 /* Deltas are ordered in ascending order. */
1273 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1277 off_t delta_data_offset;
1279 /* Plain object types are the delta base. */
1280 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1281 delta->type != GOT_OBJ_TYPE_TREE &&
1282 delta->type != GOT_OBJ_TYPE_BLOB &&
1283 delta->type != GOT_OBJ_TYPE_TAG) {
1284 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1288 delta_data_offset = delta->offset + delta->tslen;
1289 if (delta_data_offset >= pack->filesize) {
1290 err = got_error(GOT_ERR_PACK_OFFSET);
1293 if (pack->map == NULL) {
1294 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1296 err = got_error_from_errno("lseek");
1302 mapoff = (size_t)delta_data_offset;
1303 err = got_inflate_to_file_mmap(
1304 &base_bufsz, NULL, NULL, pack->map,
1305 mapoff, pack->filesize - mapoff,
1308 err = got_inflate_to_file_fd(
1309 &base_bufsz, NULL, NULL, pack->fd,
1313 mapoff = (size_t)delta_data_offset;
1314 err = got_inflate_to_mem_mmap(&base_buf,
1315 &base_bufsz, NULL, NULL,
1317 pack->filesize - mapoff);
1319 err = got_inflate_to_mem_fd(&base_buf,
1320 &base_bufsz, NULL, NULL, max_size,
1331 got_delta_cache_get(&delta_buf, &delta_len,
1332 pack->delta_cache, delta->data_offset);
1333 if (delta_buf == NULL) {
1335 err = read_delta_data(&delta_buf, &delta_len,
1336 delta->data_offset, pack);
1339 err = got_delta_cache_add(pack->delta_cache,
1340 delta->data_offset, delta_buf, delta_len);
1343 else if (err->code != GOT_ERR_NO_SPACE) {
1349 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1350 delta_buf, delta_len, accum_buf,
1351 &accum_size, max_size);
1354 err = got_delta_apply(base_file, delta_buf,
1356 /* Final delta application writes to output file. */
1357 ++n < deltas->nentries ? accum_file : outfile,
1365 if (n < deltas->nentries) {
1366 /* Accumulated delta becomes the new base. */
1368 uint8_t *tmp = accum_buf;
1370 * Base buffer switches roles with accumulation
1371 * buffer. Ensure it can hold the largest
1372 * result in the delta chain. The initial
1373 * allocation might have been smaller.
1375 if (base_bufsz < max_size) {
1377 p = reallocarray(base_buf, 1, max_size);
1379 err = got_error_from_errno(
1384 base_bufsz = max_size;
1386 accum_buf = base_buf;
1389 FILE *tmp = accum_file;
1390 accum_file = base_file;
1401 size_t len = fwrite(accum_buf, 1, accum_size, outfile);
1403 if (len != accum_size)
1404 err = got_ferror(outfile, GOT_ERR_IO);
1408 *result_size = accum_size;
1412 const struct got_error *
1413 got_pack_dump_delta_chain_to_mem(uint8_t **outbuf, size_t *outlen,
1414 struct got_delta_chain *deltas, struct got_pack *pack)
1416 const struct got_error *err = NULL;
1417 struct got_delta *delta;
1418 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1419 size_t base_bufsz = 0, accum_size = 0, delta_len;
1426 if (STAILQ_EMPTY(&deltas->entries))
1427 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1429 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1432 accum_buf = malloc(max_size);
1433 if (accum_buf == NULL)
1434 return got_error_from_errno("malloc");
1436 /* Deltas are ordered in ascending order. */
1437 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1440 size_t delta_data_offset;
1442 /* Plain object types are the delta base. */
1443 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1444 delta->type != GOT_OBJ_TYPE_TREE &&
1445 delta->type != GOT_OBJ_TYPE_BLOB &&
1446 delta->type != GOT_OBJ_TYPE_TAG) {
1447 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1451 delta_data_offset = delta->offset + delta->tslen;
1452 if (delta_data_offset >= pack->filesize) {
1453 err = got_error(GOT_ERR_PACK_OFFSET);
1457 size_t mapoff = (size_t)delta_data_offset;
1458 err = got_inflate_to_mem_mmap(&base_buf,
1459 &base_bufsz, NULL, NULL, pack->map,
1460 mapoff, pack->filesize - mapoff);
1462 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1464 err = got_error_from_errno("lseek");
1467 err = got_inflate_to_mem_fd(&base_buf,
1468 &base_bufsz, NULL, NULL, max_size,
1477 got_delta_cache_get(&delta_buf, &delta_len,
1478 pack->delta_cache, delta->data_offset);
1479 if (delta_buf == NULL) {
1481 err = read_delta_data(&delta_buf, &delta_len,
1482 delta->data_offset, pack);
1485 err = got_delta_cache_add(pack->delta_cache,
1486 delta->data_offset, delta_buf, delta_len);
1489 else if (err->code != GOT_ERR_NO_SPACE) {
1494 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1495 delta_buf, delta_len, accum_buf,
1496 &accum_size, max_size);
1503 if (n < deltas->nentries) {
1504 /* Accumulated delta becomes the new base. */
1505 uint8_t *tmp = accum_buf;
1507 * Base buffer switches roles with accumulation buffer.
1508 * Ensure it can hold the largest result in the delta
1509 * chain. Initial allocation might have been smaller.
1511 if (base_bufsz < max_size) {
1513 p = reallocarray(base_buf, 1, max_size);
1515 err = got_error_from_errno(
1520 base_bufsz = max_size;
1522 accum_buf = base_buf;
1534 *outbuf = accum_buf;
1535 *outlen = accum_size;
1540 const struct got_error *
1541 got_packfile_extract_object(struct got_pack *pack, struct got_object *obj,
1542 FILE *outfile, FILE *base_file, FILE *accum_file)
1544 const struct got_error *err = NULL;
1546 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1547 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1549 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1550 if (obj->pack_offset >= pack->filesize)
1551 return got_error(GOT_ERR_PACK_OFFSET);
1554 size_t mapoff = (size_t)obj->pack_offset;
1555 err = got_inflate_to_file_mmap(&obj->size, NULL, NULL,
1556 pack->map, mapoff, pack->filesize - mapoff,
1559 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1560 return got_error_from_errno("lseek");
1561 err = got_inflate_to_file_fd(&obj->size, NULL, NULL,
1565 err = got_pack_dump_delta_chain_to_file(&obj->size,
1566 &obj->deltas, pack, outfile, base_file, accum_file);
1571 const struct got_error *
1572 got_packfile_extract_object_to_mem(uint8_t **buf, size_t *len,
1573 struct got_object *obj, struct got_pack *pack)
1575 const struct got_error *err = NULL;
1577 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1578 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1580 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1581 if (obj->pack_offset >= pack->filesize)
1582 return got_error(GOT_ERR_PACK_OFFSET);
1584 size_t mapoff = (size_t)obj->pack_offset;
1585 err = got_inflate_to_mem_mmap(buf, len, NULL, NULL,
1586 pack->map, mapoff, pack->filesize - mapoff);
1588 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1589 return got_error_from_errno("lseek");
1590 err = got_inflate_to_mem_fd(buf, len, NULL, NULL,
1591 obj->size, pack->fd);
1594 err = got_pack_dump_delta_chain_to_mem(buf, len, &obj->deltas,
1600 const struct got_error *
1601 got_packfile_extract_raw_delta(uint8_t **delta_buf, size_t *delta_size,
1602 off_t *delta_offset, off_t *base_offset, struct got_object_id *base_id,
1603 uint64_t *base_size, uint64_t *result_size, struct got_pack *pack,
1604 struct got_packidx *packidx, int idx)
1606 const struct got_error *err = NULL;
1610 size_t tslen, delta_hdrlen;
1619 offset = got_packidx_get_object_offset(packidx, idx);
1620 if (offset == (uint64_t)-1)
1621 return got_error(GOT_ERR_BAD_PACKIDX);
1623 if (offset >= pack->filesize)
1624 return got_error(GOT_ERR_PACK_OFFSET);
1626 err = got_pack_parse_object_type_and_size(&type, &size, &tslen,
1631 if (tslen + size < tslen || offset + size < size ||
1632 tslen + offset < tslen)
1633 return got_error(GOT_ERR_PACK_OFFSET);
1636 case GOT_OBJ_TYPE_OFFSET_DELTA:
1637 err = got_pack_parse_offset_delta(base_offset, &delta_hdrlen,
1638 pack, offset, tslen);
1642 case GOT_OBJ_TYPE_REF_DELTA:
1643 err = got_pack_parse_ref_delta(base_id, pack, offset, tslen);
1646 delta_hdrlen = SHA1_DIGEST_LENGTH;
1649 return got_error_fmt(GOT_ERR_OBJ_TYPE,
1650 "non-delta object type %d found at offset %llu",
1654 if (tslen + delta_hdrlen < delta_hdrlen ||
1655 offset + delta_hdrlen < delta_hdrlen)
1656 return got_error(GOT_ERR_BAD_DELTA);
1658 err = read_delta_data(delta_buf, delta_size,
1659 offset + tslen + delta_hdrlen, pack);
1663 if (*delta_size != size) {
1664 err = got_error(GOT_ERR_BAD_DELTA);
1668 err = got_delta_get_sizes(base_size, result_size, *delta_buf, size);
1672 *delta_offset = offset;