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>
19 #include <sys/queue.h>
36 #include "got_error.h"
37 #include "got_object.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"
50 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
54 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
57 static const struct got_error *
58 verify_fanout_table(uint32_t *fanout_table)
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);
70 const struct got_error *
71 got_packidx_init_hdr(struct got_packidx *p, int verify, off_t packfile_size)
73 const struct got_error *err = NULL;
74 struct got_packidx_v2_hdr *h;
76 uint8_t sha1[SHA1_DIGEST_LENGTH];
77 size_t nobj, len_fanout, len_ids, offset, remain;
87 if (remain < sizeof(*h->magic)) {
88 err = got_error(GOT_ERR_BAD_PACKIDX);
92 h->magic = (uint32_t *)(p->map + offset);
94 h->magic = malloc(sizeof(*h->magic));
95 if (h->magic == NULL) {
96 err = got_error_from_errno("malloc");
99 n = read(p->fd, h->magic, sizeof(*h->magic));
101 err = got_error_from_errno("read");
103 } else if (n != sizeof(*h->magic)) {
104 err = got_error(GOT_ERR_BAD_PACKIDX);
108 if (*h->magic != htobe32(GOT_PACKIDX_V2_MAGIC)) {
109 err = got_error(GOT_ERR_BAD_PACKIDX);
112 offset += sizeof(*h->magic);
113 remain -= sizeof(*h->magic);
116 SHA1Update(&ctx, (uint8_t *)h->magic, sizeof(*h->magic));
118 if (remain < sizeof(*h->version)) {
119 err = got_error(GOT_ERR_BAD_PACKIDX);
123 h->version = (uint32_t *)(p->map + offset);
125 h->version = malloc(sizeof(*h->version));
126 if (h->version == NULL) {
127 err = got_error_from_errno("malloc");
130 n = read(p->fd, h->version, sizeof(*h->version));
132 err = got_error_from_errno("read");
134 } else if (n != sizeof(*h->version)) {
135 err = got_error(GOT_ERR_BAD_PACKIDX);
139 if (*h->version != htobe32(GOT_PACKIDX_VERSION)) {
140 err = got_error(GOT_ERR_BAD_PACKIDX);
143 offset += sizeof(*h->version);
144 remain -= sizeof(*h->version);
147 SHA1Update(&ctx, (uint8_t *)h->version, sizeof(*h->version));
150 sizeof(*h->fanout_table) * GOT_PACKIDX_V2_FANOUT_TABLE_ITEMS;
151 if (remain < len_fanout) {
152 err = got_error(GOT_ERR_BAD_PACKIDX);
156 h->fanout_table = (uint32_t *)(p->map + offset);
158 h->fanout_table = malloc(len_fanout);
159 if (h->fanout_table == NULL) {
160 err = got_error_from_errno("malloc");
163 n = read(p->fd, h->fanout_table, len_fanout);
165 err = got_error_from_errno("read");
167 } else if (n != len_fanout) {
168 err = got_error(GOT_ERR_BAD_PACKIDX);
172 err = verify_fanout_table(h->fanout_table);
176 SHA1Update(&ctx, (uint8_t *)h->fanout_table, len_fanout);
177 offset += len_fanout;
178 remain -= len_fanout;
180 nobj = be32toh(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);
188 (struct got_packidx_object_id *)((uint8_t*)(p->map + offset));
190 h->sorted_ids = malloc(len_ids);
191 if (h->sorted_ids == NULL) {
192 err = got_error(GOT_ERR_BAD_PACKIDX);
195 n = read(p->fd, h->sorted_ids, len_ids);
197 err = got_error_from_errno("read");
198 else if (n != len_ids) {
199 err = got_error(GOT_ERR_BAD_PACKIDX);
204 SHA1Update(&ctx, (uint8_t *)h->sorted_ids, len_ids);
208 if (remain < nobj * sizeof(*h->crc32)) {
209 err = got_error(GOT_ERR_BAD_PACKIDX);
213 h->crc32 = (uint32_t *)((uint8_t*)(p->map + offset));
215 h->crc32 = malloc(nobj * sizeof(*h->crc32));
216 if (h->crc32 == NULL) {
217 err = got_error_from_errno("malloc");
220 n = read(p->fd, h->crc32, nobj * sizeof(*h->crc32));
222 err = got_error_from_errno("read");
223 else if (n != nobj * sizeof(*h->crc32)) {
224 err = got_error(GOT_ERR_BAD_PACKIDX);
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);
238 h->offsets = (uint32_t *)((uint8_t*)(p->map + offset));
240 h->offsets = malloc(nobj * sizeof(*h->offsets));
241 if (h->offsets == NULL) {
242 err = got_error_from_errno("malloc");
245 n = read(p->fd, h->offsets, nobj * sizeof(*h->offsets));
247 err = got_error_from_errno("read");
248 else if (n != nobj * sizeof(*h->offsets)) {
249 err = got_error(GOT_ERR_BAD_PACKIDX);
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 if (verify || packfile_size > 0x7fffffff) {
261 for (i = 0; i < nobj; i++) {
262 uint32_t o = h->offsets[i];
263 if (o & htobe32(GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX))
267 if (p->nlargeobj == 0)
269 else if (packfile_size <= 0x7fffffff) {
270 err = got_error(GOT_ERR_BAD_PACKIDX);
274 if (remain < p->nlargeobj * sizeof(*h->large_offsets)) {
275 err = got_error(GOT_ERR_BAD_PACKIDX);
279 h->large_offsets = (uint64_t *)((uint8_t*)(p->map + offset));
281 h->large_offsets = malloc(p->nlargeobj *
282 sizeof(*h->large_offsets));
283 if (h->large_offsets == NULL) {
284 err = got_error_from_errno("malloc");
287 n = read(p->fd, h->large_offsets,
288 p->nlargeobj * sizeof(*h->large_offsets));
290 err = got_error_from_errno("read");
291 else if (n != p->nlargeobj * sizeof(*h->large_offsets)) {
292 err = got_error(GOT_ERR_BAD_PACKIDX);
297 SHA1Update(&ctx, (uint8_t*)h->large_offsets,
298 p->nlargeobj * sizeof(*h->large_offsets));
299 remain -= p->nlargeobj * sizeof(*h->large_offsets);
300 offset += p->nlargeobj * sizeof(*h->large_offsets);
303 if (remain < sizeof(*h->trailer)) {
304 err = got_error(GOT_ERR_BAD_PACKIDX);
309 (struct got_packidx_trailer *)((uint8_t*)(p->map + offset));
311 h->trailer = malloc(sizeof(*h->trailer));
312 if (h->trailer == NULL) {
313 err = got_error_from_errno("malloc");
316 n = read(p->fd, h->trailer, sizeof(*h->trailer));
318 err = got_error_from_errno("read");
319 else if (n != sizeof(*h->trailer)) {
320 err = got_error(GOT_ERR_BAD_PACKIDX);
325 SHA1Update(&ctx, h->trailer->packfile_sha1, SHA1_DIGEST_LENGTH);
326 SHA1Final(sha1, &ctx);
327 if (memcmp(h->trailer->packidx_sha1, sha1,
328 SHA1_DIGEST_LENGTH) != 0)
329 err = got_error(GOT_ERR_PACKIDX_CSUM);
335 const struct got_error *
336 got_packidx_open(struct got_packidx **packidx,
337 int dir_fd, const char *relpath, int verify)
339 const struct got_error *err = NULL;
340 struct got_packidx *p = NULL;
342 struct stat idx_sb, pack_sb;
346 err = got_packidx_get_packfile_path(&pack_relpath, relpath);
351 * Ensure that a corresponding pack file exists.
352 * Some Git repositories have this problem. Git seems to ignore
353 * the existence of lonely pack index files but we do not.
355 if (fstatat(dir_fd, pack_relpath, &pack_sb, 0) == -1) {
356 if (errno == ENOENT) {
357 err = got_error_fmt(GOT_ERR_LONELY_PACKIDX,
360 err = got_error_from_errno2("fstatat", pack_relpath);
364 p = calloc(1, sizeof(*p));
366 err = got_error_from_errno("calloc");
370 p->fd = openat(dir_fd, relpath, O_RDONLY | O_NOFOLLOW | O_CLOEXEC);
372 err = got_error_from_errno2("openat", relpath);
376 if (fstat(p->fd, &idx_sb) != 0) {
377 err = got_error_from_errno2("fstat", relpath);
380 p->len = idx_sb.st_size;
381 if (p->len < sizeof(p->hdr)) {
382 err = got_error(GOT_ERR_BAD_PACKIDX);
386 p->path_packidx = strdup(relpath);
387 if (p->path_packidx == NULL) {
388 err = got_error_from_errno("strdup");
392 #ifndef GOT_PACK_NO_MMAP
393 p->map = mmap(NULL, p->len, PROT_READ, MAP_PRIVATE, p->fd, 0);
394 if (p->map == MAP_FAILED) {
395 if (errno != ENOMEM) {
396 err = got_error_from_errno("mmap");
399 p->map = NULL; /* fall back to read(2) */
403 err = got_packidx_init_hdr(p, verify, pack_sb.st_size);
407 got_packidx_close(p);
414 const struct got_error *
415 got_packidx_close(struct got_packidx *packidx)
417 const struct got_error *err = NULL;
419 free(packidx->path_packidx);
421 if (munmap(packidx->map, packidx->len) == -1)
422 err = got_error_from_errno("munmap");
424 free(packidx->hdr.magic);
425 free(packidx->hdr.version);
426 free(packidx->hdr.fanout_table);
427 free(packidx->hdr.sorted_ids);
428 free(packidx->hdr.crc32);
429 free(packidx->hdr.offsets);
430 free(packidx->hdr.large_offsets);
431 free(packidx->hdr.trailer);
433 if (close(packidx->fd) == -1 && err == NULL)
434 err = got_error_from_errno("close");
435 free(packidx->sorted_offsets);
436 free(packidx->sorted_large_offsets);
442 const struct got_error *
443 got_packidx_get_packfile_path(char **path_packfile, const char *path_packidx)
447 /* Packfile path contains ".pack" instead of ".idx", so add one byte. */
448 size = strlen(path_packidx) + 2;
449 if (size < GOT_PACKFILE_NAMELEN + 1)
450 return got_error_path(path_packidx, GOT_ERR_BAD_PATH);
452 *path_packfile = malloc(size);
453 if (*path_packfile == NULL)
454 return got_error_from_errno("malloc");
456 /* Copy up to and excluding ".idx". */
457 if (strlcpy(*path_packfile, path_packidx,
458 size - strlen(GOT_PACKIDX_SUFFIX) - 1) >= size)
459 return got_error(GOT_ERR_NO_SPACE);
461 if (strlcat(*path_packfile, GOT_PACKFILE_SUFFIX, size) >= size)
462 return got_error(GOT_ERR_NO_SPACE);
468 got_packidx_get_object_offset(struct got_packidx *packidx, int idx)
470 uint32_t offset = be32toh(packidx->hdr.offsets[idx]);
471 if (offset & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX) {
473 idx = offset & GOT_PACKIDX_OFFSET_VAL_MASK;
474 if (idx < 0 || idx >= packidx->nlargeobj ||
475 packidx->hdr.large_offsets == NULL)
477 loffset = be64toh(packidx->hdr.large_offsets[idx]);
478 return (loffset > INT64_MAX ? -1 : (off_t)loffset);
480 return (off_t)(offset & GOT_PACKIDX_OFFSET_VAL_MASK);
484 got_packidx_get_object_idx(struct got_packidx *packidx,
485 struct got_object_id *id)
487 u_int8_t id0 = id->sha1[0];
488 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
489 int left = 0, right = totobj - 1;
492 left = be32toh(packidx->hdr.fanout_table[id0 - 1]);
494 while (left <= right) {
495 struct got_packidx_object_id *oid;
498 i = ((left + right) / 2);
499 oid = &packidx->hdr.sorted_ids[i];
500 cmp = memcmp(id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
513 offset_cmp(const void *pa, const void *pb)
515 const struct got_pack_offset_index *a, *b;
517 a = (const struct got_pack_offset_index *)pa;
518 b = (const struct got_pack_offset_index *)pb;
520 if (a->offset < b->offset)
522 else if (a->offset > b->offset)
529 large_offset_cmp(const void *pa, const void *pb)
531 const struct got_pack_large_offset_index *a, *b;
533 a = (const struct got_pack_large_offset_index *)pa;
534 b = (const struct got_pack_large_offset_index *)pb;
536 if (a->offset < b->offset)
538 else if (a->offset > b->offset)
544 static const struct got_error *
545 build_offset_index(struct got_packidx *p)
547 uint32_t nobj = be32toh(p->hdr.fanout_table[0xff]);
548 unsigned int i, j, k;
550 p->sorted_offsets = calloc(nobj - p->nlargeobj,
551 sizeof(p->sorted_offsets[0]));
552 if (p->sorted_offsets == NULL)
553 return got_error_from_errno("calloc");
555 if (p->nlargeobj > 0) {
556 p->sorted_large_offsets = calloc(p->nlargeobj,
557 sizeof(p->sorted_large_offsets[0]));
558 if (p->sorted_large_offsets == NULL)
559 return got_error_from_errno("calloc");
564 for (i = 0; i < nobj; i++) {
565 uint32_t offset = be32toh(p->hdr.offsets[i]);
566 if (offset & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX) {
569 idx = offset & GOT_PACKIDX_OFFSET_VAL_MASK;
570 if (idx >= p->nlargeobj ||
572 p->hdr.large_offsets == NULL)
573 return got_error(GOT_ERR_BAD_PACKIDX);
574 loffset = be64toh(p->hdr.large_offsets[idx]);
575 p->sorted_large_offsets[j].offset = loffset;
576 p->sorted_large_offsets[j].idx = i;
579 p->sorted_offsets[k].offset = offset;
580 p->sorted_offsets[k].idx = i;
584 if (j != p->nlargeobj || k != nobj - p->nlargeobj)
585 return got_error(GOT_ERR_BAD_PACKIDX);
587 qsort(p->sorted_offsets, nobj - p->nlargeobj,
588 sizeof(p->sorted_offsets[0]), offset_cmp);
590 if (p->sorted_large_offsets)
591 qsort(p->sorted_large_offsets, p->nlargeobj,
592 sizeof(p->sorted_large_offsets[0]), large_offset_cmp);
597 const struct got_error *
598 got_packidx_get_offset_idx(int *idx, struct got_packidx *packidx, off_t offset)
600 const struct got_error *err;
601 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
606 if (packidx->sorted_offsets == NULL) {
607 err = build_offset_index(packidx);
612 if (offset >= 0x7fffffff) {
614 left = 0, right = packidx->nlargeobj - 1;
615 while (left <= right) {
616 i = ((left + right) / 2);
617 lo = packidx->sorted_large_offsets[i].offset;
619 *idx = packidx->sorted_large_offsets[i].idx;
621 } else if (offset > lo)
623 else if (offset < lo)
628 left = 0, right = totobj - packidx->nlargeobj - 1;
629 while (left <= right) {
630 i = ((left + right) / 2);
631 o = packidx->sorted_offsets[i].offset;
633 *idx = packidx->sorted_offsets[i].idx;
635 } else if (offset > o)
645 const struct got_error *
646 got_packidx_get_object_id(struct got_object_id *id,
647 struct got_packidx *packidx, int idx)
649 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
650 struct got_packidx_object_id *oid;
652 if (idx < 0 || idx >= totobj)
653 return got_error(GOT_ERR_NO_OBJ);
655 oid = &packidx->hdr.sorted_ids[idx];
656 memcpy(id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
660 const struct got_error *
661 got_packidx_match_id_str_prefix(struct got_object_id_queue *matched_ids,
662 struct got_packidx *packidx, const char *id_str_prefix)
664 const struct got_error *err = NULL;
666 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
668 size_t prefix_len = strlen(id_str_prefix);
669 struct got_packidx_object_id *oid;
672 STAILQ_INIT(matched_ids);
675 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
677 hex[0] = id_str_prefix[0];
678 hex[1] = id_str_prefix[1];
680 if (!got_parse_xdigit(&id0, hex))
681 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
684 i = be32toh(packidx->hdr.fanout_table[id0 - 1]);
685 oid = &packidx->hdr.sorted_ids[i];
686 while (i < totobj && oid->sha1[0] == id0) {
687 char id_str[SHA1_DIGEST_STRING_LENGTH];
688 struct got_object_qid *qid;
691 if (!got_sha1_digest_to_str(oid->sha1, id_str, sizeof(id_str)))
692 return got_error(GOT_ERR_NO_SPACE);
694 cmp = strncmp(id_str, id_str_prefix, prefix_len);
696 oid = &packidx->hdr.sorted_ids[++i];
701 err = got_object_qid_alloc_partial(&qid);
704 memcpy(qid->id.sha1, oid->sha1, SHA1_DIGEST_LENGTH);
705 STAILQ_INSERT_TAIL(matched_ids, qid, entry);
707 oid = &packidx->hdr.sorted_ids[++i];
711 got_object_id_queue_free(matched_ids);
715 static const struct got_error *
716 pack_stop_privsep_child(struct got_pack *pack)
718 const struct got_error *err = NULL;
720 if (pack->privsep_child == NULL)
723 err = got_privsep_send_stop(pack->privsep_child->imsg_fd);
726 err = got_privsep_wait_for_child(pack->privsep_child->pid);
727 if (close(pack->privsep_child->imsg_fd) == -1 && err == NULL)
728 err = got_error_from_errno("close");
729 free(pack->privsep_child->ibuf);
730 free(pack->privsep_child);
731 pack->privsep_child = NULL;
735 const struct got_error *
736 got_pack_close(struct got_pack *pack)
738 const struct got_error *err = NULL;
740 err = pack_stop_privsep_child(pack);
741 if (pack->map && munmap(pack->map, pack->filesize) == -1 && !err)
742 err = got_error_from_errno("munmap");
743 if (pack->fd != -1 && close(pack->fd) == -1 && err == NULL)
744 err = got_error_from_errno("close");
746 free(pack->path_packfile);
747 pack->path_packfile = NULL;
749 if (pack->delta_cache) {
750 got_delta_cache_free(pack->delta_cache);
751 pack->delta_cache = NULL;
757 const struct got_error *
758 got_pack_parse_object_type_and_size(uint8_t *type, uint64_t *size, size_t *len,
759 struct got_pack *pack, off_t offset)
769 if (offset >= pack->filesize)
770 return got_error(GOT_ERR_PACK_OFFSET);
773 mapoff = (size_t)offset;
775 if (lseek(pack->fd, offset, SEEK_SET) == -1)
776 return got_error_from_errno("lseek");
780 /* We do not support size values which don't fit in 64 bit. */
782 return got_error(GOT_ERR_NO_SPACE);
785 if (mapoff + sizeof(sizeN) >= pack->filesize)
786 return got_error(GOT_ERR_BAD_PACKFILE);
787 sizeN = *(pack->map + mapoff);
788 mapoff += sizeof(sizeN);
790 ssize_t n = read(pack->fd, &sizeN, sizeof(sizeN));
792 return got_error_from_errno("read");
793 if (n != sizeof(sizeN))
794 return got_error(GOT_ERR_BAD_PACKFILE);
796 *len += sizeof(sizeN);
799 t = (sizeN & GOT_PACK_OBJ_SIZE0_TYPE_MASK) >>
800 GOT_PACK_OBJ_SIZE0_TYPE_MASK_SHIFT;
801 s = (sizeN & GOT_PACK_OBJ_SIZE0_VAL_MASK);
803 size_t shift = 4 + 7 * (i - 1);
804 s |= ((sizeN & GOT_PACK_OBJ_SIZE_VAL_MASK) << shift);
807 } while (sizeN & GOT_PACK_OBJ_SIZE_MORE);
814 static const struct got_error *
815 open_plain_object(struct got_object **obj, struct got_object_id *id,
816 uint8_t type, off_t offset, size_t size, int idx)
818 *obj = calloc(1, sizeof(**obj));
820 return got_error_from_errno("calloc");
823 (*obj)->flags = GOT_OBJ_FLAG_PACKED;
824 (*obj)->pack_idx = idx;
827 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
828 (*obj)->pack_offset = offset;
833 static const struct got_error *
834 parse_negative_offset(int64_t *offset, size_t *len, struct got_pack *pack,
845 /* We do not support offset values which don't fit in 64 bit. */
847 return got_error(GOT_ERR_NO_SPACE);
851 mapoff = (size_t)delta_offset + *len;
852 if (mapoff + sizeof(offN) >= pack->filesize)
853 return got_error(GOT_ERR_PACK_OFFSET);
854 offN = *(pack->map + mapoff);
857 n = read(pack->fd, &offN, sizeof(offN));
859 return got_error_from_errno("read");
860 if (n != sizeof(offN))
861 return got_error(GOT_ERR_BAD_PACKFILE);
863 *len += sizeof(offN);
866 o = (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
870 o += (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
873 } while (offN & GOT_PACK_OBJ_DELTA_OFF_MORE);
879 const struct got_error *
880 got_pack_parse_offset_delta(off_t *base_offset, size_t *len,
881 struct got_pack *pack, off_t offset, int tslen)
883 const struct got_error *err;
889 err = parse_negative_offset(&negoffset, &negofflen, pack,
894 /* Compute the base object's offset (must be in the same pack file). */
895 *base_offset = (offset - negoffset);
896 if (*base_offset <= 0)
897 return got_error(GOT_ERR_BAD_PACKFILE);
903 static const struct got_error *
904 read_delta_data(uint8_t **delta_buf, size_t *delta_len,
905 size_t *delta_compressed_len, size_t delta_data_offset,
906 struct got_pack *pack)
908 const struct got_error *err = NULL;
912 if (delta_data_offset >= pack->filesize)
913 return got_error(GOT_ERR_PACK_OFFSET);
914 err = got_inflate_to_mem_mmap(delta_buf, delta_len,
915 &consumed, NULL, pack->map, delta_data_offset,
916 pack->filesize - delta_data_offset);
920 if (lseek(pack->fd, delta_data_offset, SEEK_SET) == -1)
921 return got_error_from_errno("lseek");
922 err = got_inflate_to_mem_fd(delta_buf, delta_len,
923 &consumed, NULL, 0, pack->fd);
928 if (delta_compressed_len)
929 *delta_compressed_len = consumed;
934 static const struct got_error *
935 add_delta(struct got_delta_chain *deltas, off_t delta_offset, size_t tslen,
936 int delta_type, size_t delta_size, size_t delta_data_offset)
938 struct got_delta *delta;
940 delta = got_delta_open(delta_offset, tslen, delta_type, delta_size,
943 return got_error_from_errno("got_delta_open");
944 /* delta is freed in got_object_close() */
946 STAILQ_INSERT_HEAD(&deltas->entries, delta, entry);
950 static const struct got_error *
951 resolve_offset_delta(struct got_delta_chain *deltas,
952 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
953 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
956 const struct got_error *err;
961 off_t delta_data_offset;
964 err = got_pack_parse_offset_delta(&base_offset, &consumed, pack,
965 delta_offset, tslen);
969 delta_data_offset = delta_offset + tslen + consumed;
970 if (delta_data_offset >= pack->filesize)
971 return got_error(GOT_ERR_PACK_OFFSET);
973 if (pack->map == NULL) {
974 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
975 if (delta_data_offset == -1)
976 return got_error_from_errno("lseek");
979 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
984 /* An offset delta must be in the same packfile. */
985 if (base_offset >= pack->filesize)
986 return got_error(GOT_ERR_PACK_OFFSET);
988 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
989 &base_tslen, pack, base_offset);
993 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
994 base_tslen, base_type, base_size, recursion - 1);
997 const struct got_error *
998 got_pack_parse_ref_delta(struct got_object_id *id,
999 struct got_pack *pack, off_t delta_offset, int tslen)
1002 size_t mapoff = delta_offset + tslen;
1003 if (mapoff + sizeof(*id) >= pack->filesize)
1004 return got_error(GOT_ERR_PACK_OFFSET);
1005 memcpy(id, pack->map + mapoff, sizeof(*id));
1008 n = read(pack->fd, id, sizeof(*id));
1010 return got_error_from_errno("read");
1011 if (n != sizeof(*id))
1012 return got_error(GOT_ERR_BAD_PACKFILE);
1018 static const struct got_error *
1019 resolve_ref_delta(struct got_delta_chain *deltas, struct got_packidx *packidx,
1020 struct got_pack *pack, off_t delta_offset, size_t tslen, int delta_type,
1021 size_t delta_size, unsigned int recursion)
1023 const struct got_error *err;
1024 struct got_object_id id;
1030 off_t delta_data_offset;
1032 if (delta_offset + tslen >= pack->filesize)
1033 return got_error(GOT_ERR_PACK_OFFSET);
1035 err = got_pack_parse_ref_delta(&id, pack, delta_offset, tslen);
1039 delta_data_offset = delta_offset + tslen + sizeof(id);
1041 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
1042 if (delta_data_offset == -1)
1043 return got_error_from_errno("lseek");
1046 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
1051 /* Delta base must be in the same pack file. */
1052 idx = got_packidx_get_object_idx(packidx, &id);
1054 return got_error(GOT_ERR_NO_OBJ);
1056 base_offset = got_packidx_get_object_offset(packidx, idx);
1057 if (base_offset == (uint64_t)-1)
1058 return got_error(GOT_ERR_BAD_PACKIDX);
1060 if (base_offset >= pack->filesize)
1061 return got_error(GOT_ERR_PACK_OFFSET);
1063 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
1064 &base_tslen, pack, base_offset);
1068 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
1069 base_tslen, base_type, base_size, recursion - 1);
1072 const struct got_error *
1073 got_pack_resolve_delta_chain(struct got_delta_chain *deltas,
1074 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
1075 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
1077 const struct got_error *err = NULL;
1079 if (--recursion == 0)
1080 return got_error(GOT_ERR_RECURSION);
1082 switch (delta_type) {
1083 case GOT_OBJ_TYPE_COMMIT:
1084 case GOT_OBJ_TYPE_TREE:
1085 case GOT_OBJ_TYPE_BLOB:
1086 case GOT_OBJ_TYPE_TAG:
1087 /* Plain types are the final delta base. Recursion ends. */
1088 err = add_delta(deltas, delta_offset, tslen, delta_type,
1091 case GOT_OBJ_TYPE_OFFSET_DELTA:
1092 err = resolve_offset_delta(deltas, packidx, pack,
1093 delta_offset, tslen, delta_type, delta_size, recursion - 1);
1095 case GOT_OBJ_TYPE_REF_DELTA:
1096 err = resolve_ref_delta(deltas, packidx, pack,
1097 delta_offset, tslen, delta_type, delta_size, recursion - 1);
1100 return got_error(GOT_ERR_OBJ_TYPE);
1106 static const struct got_error *
1107 open_delta_object(struct got_object **obj, struct got_packidx *packidx,
1108 struct got_pack *pack, struct got_object_id *id, off_t offset,
1109 size_t tslen, int delta_type, size_t delta_size, int idx)
1111 const struct got_error *err = NULL;
1114 *obj = calloc(1, sizeof(**obj));
1116 return got_error_from_errno("calloc");
1120 (*obj)->size = 0; /* Not known because deltas aren't applied yet. */
1121 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
1122 (*obj)->pack_offset = offset + tslen;
1124 STAILQ_INIT(&(*obj)->deltas.entries);
1125 (*obj)->flags |= GOT_OBJ_FLAG_DELTIFIED;
1126 (*obj)->flags |= GOT_OBJ_FLAG_PACKED;
1127 (*obj)->pack_idx = idx;
1129 err = got_pack_resolve_delta_chain(&(*obj)->deltas, packidx, pack,
1130 offset, tslen, delta_type, delta_size,
1131 GOT_DELTA_CHAIN_RECURSION_MAX);
1135 err = got_delta_chain_get_base_type(&resolved_type, &(*obj)->deltas);
1138 (*obj)->type = resolved_type;
1141 got_object_close(*obj);
1147 const struct got_error *
1148 got_packfile_open_object(struct got_object **obj, struct got_pack *pack,
1149 struct got_packidx *packidx, int idx, struct got_object_id *id)
1151 const struct got_error *err = NULL;
1159 offset = got_packidx_get_object_offset(packidx, idx);
1160 if (offset == (uint64_t)-1)
1161 return got_error(GOT_ERR_BAD_PACKIDX);
1163 err = got_pack_parse_object_type_and_size(&type, &size, &tslen,
1169 case GOT_OBJ_TYPE_COMMIT:
1170 case GOT_OBJ_TYPE_TREE:
1171 case GOT_OBJ_TYPE_BLOB:
1172 case GOT_OBJ_TYPE_TAG:
1173 err = open_plain_object(obj, id, type, offset + tslen,
1176 case GOT_OBJ_TYPE_OFFSET_DELTA:
1177 case GOT_OBJ_TYPE_REF_DELTA:
1178 err = open_delta_object(obj, packidx, pack, id, offset,
1179 tslen, type, size, idx);
1182 err = got_error(GOT_ERR_OBJ_TYPE);
1189 const struct got_error *
1190 got_pack_get_delta_chain_max_size(uint64_t *max_size,
1191 struct got_delta_chain *deltas, struct got_pack *pack)
1193 struct got_delta *delta;
1194 uint64_t base_size = 0, result_size = 0;
1197 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1198 /* Plain object types are the delta base. */
1199 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1200 delta->type != GOT_OBJ_TYPE_TREE &&
1201 delta->type != GOT_OBJ_TYPE_BLOB &&
1202 delta->type != GOT_OBJ_TYPE_TAG) {
1203 const struct got_error *err;
1208 got_delta_cache_get(&delta_buf, &delta_len,
1209 pack->delta_cache, delta->data_offset);
1210 if (delta_buf == NULL) {
1212 err = read_delta_data(&delta_buf, &delta_len,
1213 NULL, delta->data_offset, pack);
1216 err = got_delta_cache_add(pack->delta_cache,
1217 delta->data_offset, delta_buf, delta_len);
1220 else if (err->code != GOT_ERR_NO_SPACE) {
1225 err = got_delta_get_sizes(&base_size, &result_size,
1226 delta_buf, delta_len);
1232 base_size = delta->size;
1233 if (base_size > *max_size)
1234 *max_size = base_size;
1235 if (result_size > *max_size)
1236 *max_size = result_size;
1242 const struct got_error *
1243 got_pack_get_max_delta_object_size(uint64_t *size, struct got_object *obj,
1244 struct got_pack *pack)
1246 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
1247 return got_error(GOT_ERR_OBJ_TYPE);
1249 return got_pack_get_delta_chain_max_size(size, &obj->deltas, pack);
1252 const struct got_error *
1253 got_pack_dump_delta_chain_to_file(size_t *result_size,
1254 struct got_delta_chain *deltas, struct got_pack *pack, FILE *outfile,
1255 FILE *base_file, FILE *accum_file)
1257 const struct got_error *err = NULL;
1258 struct got_delta *delta;
1259 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1260 size_t base_bufsz = 0, accum_size = 0, delta_len;
1266 if (STAILQ_EMPTY(&deltas->entries))
1267 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1269 /* We process small enough files entirely in memory for speed. */
1270 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1273 if (max_size < GOT_DELTA_RESULT_SIZE_CACHED_MAX) {
1274 accum_buf = malloc(max_size);
1275 if (accum_buf == NULL)
1276 return got_error_from_errno("malloc");
1280 if (fseeko(base_file, 0L, SEEK_SET) == -1)
1281 return got_error_from_errno("fseeko");
1282 if (fseeko(accum_file, 0L, SEEK_SET) == -1)
1283 return got_error_from_errno("fseeko");
1286 /* Deltas are ordered in ascending order. */
1287 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1291 off_t delta_data_offset;
1293 /* Plain object types are the delta base. */
1294 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1295 delta->type != GOT_OBJ_TYPE_TREE &&
1296 delta->type != GOT_OBJ_TYPE_BLOB &&
1297 delta->type != GOT_OBJ_TYPE_TAG) {
1298 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1302 delta_data_offset = delta->offset + delta->tslen;
1303 if (delta_data_offset >= pack->filesize) {
1304 err = got_error(GOT_ERR_PACK_OFFSET);
1307 if (pack->map == NULL) {
1308 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1310 err = got_error_from_errno("lseek");
1316 mapoff = (size_t)delta_data_offset;
1317 err = got_inflate_to_file_mmap(
1318 &base_bufsz, NULL, NULL, pack->map,
1319 mapoff, pack->filesize - mapoff,
1322 err = got_inflate_to_file_fd(
1323 &base_bufsz, NULL, NULL, pack->fd,
1327 mapoff = (size_t)delta_data_offset;
1328 err = got_inflate_to_mem_mmap(&base_buf,
1329 &base_bufsz, NULL, NULL,
1331 pack->filesize - mapoff);
1333 err = got_inflate_to_mem_fd(&base_buf,
1334 &base_bufsz, NULL, NULL, max_size,
1345 got_delta_cache_get(&delta_buf, &delta_len,
1346 pack->delta_cache, delta->data_offset);
1347 if (delta_buf == NULL) {
1349 err = read_delta_data(&delta_buf, &delta_len, NULL,
1350 delta->data_offset, pack);
1353 err = got_delta_cache_add(pack->delta_cache,
1354 delta->data_offset, delta_buf, delta_len);
1357 else if (err->code != GOT_ERR_NO_SPACE) {
1363 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1364 delta_buf, delta_len, accum_buf,
1365 &accum_size, max_size);
1368 err = got_delta_apply(base_file, delta_buf,
1370 /* Final delta application writes to output file. */
1371 ++n < deltas->nentries ? accum_file : outfile,
1379 if (n < deltas->nentries) {
1380 /* Accumulated delta becomes the new base. */
1382 uint8_t *tmp = accum_buf;
1384 * Base buffer switches roles with accumulation
1385 * buffer. Ensure it can hold the largest
1386 * result in the delta chain. The initial
1387 * allocation might have been smaller.
1389 if (base_bufsz < max_size) {
1391 p = reallocarray(base_buf, 1, max_size);
1393 err = got_error_from_errno(
1398 base_bufsz = max_size;
1400 accum_buf = base_buf;
1403 FILE *tmp = accum_file;
1404 accum_file = base_file;
1415 size_t len = fwrite(accum_buf, 1, accum_size, outfile);
1417 if (len != accum_size)
1418 err = got_ferror(outfile, GOT_ERR_IO);
1422 *result_size = accum_size;
1426 const struct got_error *
1427 got_pack_dump_delta_chain_to_mem(uint8_t **outbuf, size_t *outlen,
1428 struct got_delta_chain *deltas, struct got_pack *pack)
1430 const struct got_error *err = NULL;
1431 struct got_delta *delta;
1432 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1433 size_t base_bufsz = 0, accum_size = 0, delta_len;
1440 if (STAILQ_EMPTY(&deltas->entries))
1441 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1443 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1446 accum_buf = malloc(max_size);
1447 if (accum_buf == NULL)
1448 return got_error_from_errno("malloc");
1450 /* Deltas are ordered in ascending order. */
1451 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1454 size_t delta_data_offset;
1456 /* Plain object types are the delta base. */
1457 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1458 delta->type != GOT_OBJ_TYPE_TREE &&
1459 delta->type != GOT_OBJ_TYPE_BLOB &&
1460 delta->type != GOT_OBJ_TYPE_TAG) {
1461 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1465 delta_data_offset = delta->offset + delta->tslen;
1466 if (delta_data_offset >= pack->filesize) {
1467 err = got_error(GOT_ERR_PACK_OFFSET);
1471 size_t mapoff = (size_t)delta_data_offset;
1472 err = got_inflate_to_mem_mmap(&base_buf,
1473 &base_bufsz, NULL, NULL, pack->map,
1474 mapoff, pack->filesize - mapoff);
1476 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1478 err = got_error_from_errno("lseek");
1481 err = got_inflate_to_mem_fd(&base_buf,
1482 &base_bufsz, NULL, NULL, max_size,
1491 got_delta_cache_get(&delta_buf, &delta_len,
1492 pack->delta_cache, delta->data_offset);
1493 if (delta_buf == NULL) {
1495 err = read_delta_data(&delta_buf, &delta_len, NULL,
1496 delta->data_offset, pack);
1499 err = got_delta_cache_add(pack->delta_cache,
1500 delta->data_offset, delta_buf, delta_len);
1503 else if (err->code != GOT_ERR_NO_SPACE) {
1508 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1509 delta_buf, delta_len, accum_buf,
1510 &accum_size, max_size);
1517 if (n < deltas->nentries) {
1518 /* Accumulated delta becomes the new base. */
1519 uint8_t *tmp = accum_buf;
1521 * Base buffer switches roles with accumulation buffer.
1522 * Ensure it can hold the largest result in the delta
1523 * chain. Initial allocation might have been smaller.
1525 if (base_bufsz < max_size) {
1527 p = reallocarray(base_buf, 1, max_size);
1529 err = got_error_from_errno(
1534 base_bufsz = max_size;
1536 accum_buf = base_buf;
1548 *outbuf = accum_buf;
1549 *outlen = accum_size;
1554 const struct got_error *
1555 got_packfile_extract_object(struct got_pack *pack, struct got_object *obj,
1556 FILE *outfile, FILE *base_file, FILE *accum_file)
1558 const struct got_error *err = NULL;
1560 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1561 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1563 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1564 if (obj->pack_offset >= pack->filesize)
1565 return got_error(GOT_ERR_PACK_OFFSET);
1568 size_t mapoff = (size_t)obj->pack_offset;
1569 err = got_inflate_to_file_mmap(&obj->size, NULL, NULL,
1570 pack->map, mapoff, pack->filesize - mapoff,
1573 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1574 return got_error_from_errno("lseek");
1575 err = got_inflate_to_file_fd(&obj->size, NULL, NULL,
1579 err = got_pack_dump_delta_chain_to_file(&obj->size,
1580 &obj->deltas, pack, outfile, base_file, accum_file);
1585 const struct got_error *
1586 got_packfile_extract_object_to_mem(uint8_t **buf, size_t *len,
1587 struct got_object *obj, struct got_pack *pack)
1589 const struct got_error *err = NULL;
1591 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1592 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1594 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1595 if (obj->pack_offset >= pack->filesize)
1596 return got_error(GOT_ERR_PACK_OFFSET);
1598 size_t mapoff = (size_t)obj->pack_offset;
1599 err = got_inflate_to_mem_mmap(buf, len, NULL, NULL,
1600 pack->map, mapoff, pack->filesize - mapoff);
1602 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1603 return got_error_from_errno("lseek");
1604 err = got_inflate_to_mem_fd(buf, len, NULL, NULL,
1605 obj->size, pack->fd);
1608 err = got_pack_dump_delta_chain_to_mem(buf, len, &obj->deltas,
1614 static const struct got_error *
1615 read_raw_delta_data(uint8_t **delta_buf, size_t *delta_len,
1616 size_t *delta_len_compressed, uint64_t *base_size, uint64_t *result_size,
1617 off_t delta_data_offset, struct got_pack *pack, struct got_packidx *packidx)
1619 const struct got_error *err = NULL;
1621 /* Validate decompression and obtain the decompressed size. */
1622 err = read_delta_data(delta_buf, delta_len, delta_len_compressed,
1623 delta_data_offset, pack);
1627 /* Read delta base/result sizes from head of delta stream. */
1628 err = got_delta_get_sizes(base_size, result_size,
1629 *delta_buf, *delta_len);
1633 /* Discard decompressed delta and read it again in compressed form. */
1635 *delta_buf = malloc(*delta_len_compressed);
1636 if (*delta_buf == NULL) {
1637 err = got_error_from_errno("malloc");
1641 if (delta_data_offset >= pack->filesize)
1642 err = got_error(GOT_ERR_PACK_OFFSET);
1643 memcpy(*delta_buf, pack->map + delta_data_offset,
1644 *delta_len_compressed);
1647 if (lseek(pack->fd, delta_data_offset, SEEK_SET) == -1) {
1648 err = got_error_from_errno("lseek");
1651 n = read(pack->fd, *delta_buf, *delta_len_compressed);
1653 err = got_error_from_errno("read");
1655 } else if (n != *delta_len_compressed) {
1656 err = got_error(GOT_ERR_IO);
1665 *delta_len_compressed = 0;
1672 const struct got_error *
1673 got_packfile_extract_raw_delta(uint8_t **delta_buf, size_t *delta_size,
1674 size_t *delta_compressed_size, off_t *delta_offset, off_t *base_offset,
1675 struct got_object_id *base_id, uint64_t *base_size, uint64_t *result_size,
1676 struct got_pack *pack, struct got_packidx *packidx, int idx)
1678 const struct got_error *err = NULL;
1682 size_t tslen, delta_hdrlen;
1683 off_t delta_data_offset;
1687 *delta_compressed_size = 0;
1693 offset = got_packidx_get_object_offset(packidx, idx);
1694 if (offset == (uint64_t)-1)
1695 return got_error(GOT_ERR_BAD_PACKIDX);
1697 if (offset >= pack->filesize)
1698 return got_error(GOT_ERR_PACK_OFFSET);
1700 err = got_pack_parse_object_type_and_size(&type, &size, &tslen,
1705 if (tslen + size < tslen || offset + size < size ||
1706 tslen + offset < tslen)
1707 return got_error(GOT_ERR_PACK_OFFSET);
1710 case GOT_OBJ_TYPE_OFFSET_DELTA:
1711 err = got_pack_parse_offset_delta(base_offset, &delta_hdrlen,
1712 pack, offset, tslen);
1716 case GOT_OBJ_TYPE_REF_DELTA:
1717 err = got_pack_parse_ref_delta(base_id, pack, offset, tslen);
1720 delta_hdrlen = SHA1_DIGEST_LENGTH;
1723 return got_error_fmt(GOT_ERR_OBJ_TYPE,
1724 "non-delta object type %d found at offset %llu",
1728 if (tslen + delta_hdrlen < delta_hdrlen ||
1729 offset + delta_hdrlen < delta_hdrlen)
1730 return got_error(GOT_ERR_BAD_DELTA);
1732 delta_data_offset = offset + tslen + delta_hdrlen;
1733 err = read_raw_delta_data(delta_buf, delta_size, delta_compressed_size,
1734 base_size, result_size, delta_data_offset, pack, packidx);
1738 if (*delta_size != size) {
1739 err = got_error(GOT_ERR_BAD_DELTA);
1743 *delta_offset = offset;
1749 *delta_compressed_size = 0;