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 <unistd.h>
33 #include <zlib.h>
34 #include <imsg.h>
36 #include "got_error.h"
37 #include "got_object.h"
38 #include "got_opentemp.h"
39 #include "got_path.h"
41 #include "got_lib_sha1.h"
42 #include "got_lib_delta.h"
43 #include "got_lib_delta_cache.h"
44 #include "got_lib_inflate.h"
45 #include "got_lib_object.h"
46 #include "got_lib_object_parse.h"
47 #include "got_lib_privsep.h"
48 #include "got_lib_pack.h"
50 #ifndef nitems
51 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
52 #endif
54 #ifndef MIN
55 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
56 #endif
58 static const struct got_error *
59 verify_fanout_table(uint32_t *fanout_table)
60 {
61 int i;
63 for (i = 0; i < 0xff - 1; i++) {
64 if (be32toh(fanout_table[i]) > be32toh(fanout_table[i + 1]))
65 return got_error(GOT_ERR_BAD_PACKIDX);
66 }
68 return NULL;
69 }
71 const struct got_error *
72 got_packidx_init_hdr(struct got_packidx *p, int verify)
73 {
74 const struct got_error *err = NULL;
75 struct got_packidx_v2_hdr *h;
76 SHA1_CTX ctx;
77 uint8_t sha1[SHA1_DIGEST_LENGTH];
78 size_t nobj, len_fanout, len_ids, offset, remain;
79 ssize_t n;
80 int i;
82 SHA1Init(&ctx);
84 h = &p->hdr;
85 offset = 0;
86 remain = p->len;
88 if (remain < sizeof(*h->magic)) {
89 err = got_error(GOT_ERR_BAD_PACKIDX);
90 goto done;
91 }
92 if (p->map)
93 h->magic = (uint32_t *)(p->map + offset);
94 else {
95 h->magic = malloc(sizeof(*h->magic));
96 if (h->magic == NULL) {
97 err = got_error_from_errno("malloc");
98 goto done;
99 }
100 n = read(p->fd, h->magic, sizeof(*h->magic));
101 if (n < 0) {
102 err = got_error_from_errno("read");
103 goto done;
104 } else if (n != sizeof(*h->magic)) {
105 err = got_error(GOT_ERR_BAD_PACKIDX);
106 goto done;
109 if (*h->magic != htobe32(GOT_PACKIDX_V2_MAGIC)) {
110 err = got_error(GOT_ERR_BAD_PACKIDX);
111 goto done;
113 offset += sizeof(*h->magic);
114 remain -= sizeof(*h->magic);
116 if (verify)
117 SHA1Update(&ctx, (uint8_t *)h->magic, sizeof(*h->magic));
119 if (remain < sizeof(*h->version)) {
120 err = got_error(GOT_ERR_BAD_PACKIDX);
121 goto done;
123 if (p->map)
124 h->version = (uint32_t *)(p->map + offset);
125 else {
126 h->version = malloc(sizeof(*h->version));
127 if (h->version == NULL) {
128 err = got_error_from_errno("malloc");
129 goto done;
131 n = read(p->fd, h->version, sizeof(*h->version));
132 if (n < 0) {
133 err = got_error_from_errno("read");
134 goto done;
135 } else if (n != sizeof(*h->version)) {
136 err = got_error(GOT_ERR_BAD_PACKIDX);
137 goto done;
140 if (*h->version != htobe32(GOT_PACKIDX_VERSION)) {
141 err = got_error(GOT_ERR_BAD_PACKIDX);
142 goto done;
144 offset += sizeof(*h->version);
145 remain -= sizeof(*h->version);
147 if (verify)
148 SHA1Update(&ctx, (uint8_t *)h->version, sizeof(*h->version));
150 len_fanout =
151 sizeof(*h->fanout_table) * GOT_PACKIDX_V2_FANOUT_TABLE_ITEMS;
152 if (remain < len_fanout) {
153 err = got_error(GOT_ERR_BAD_PACKIDX);
154 goto done;
156 if (p->map)
157 h->fanout_table = (uint32_t *)(p->map + offset);
158 else {
159 h->fanout_table = malloc(len_fanout);
160 if (h->fanout_table == NULL) {
161 err = got_error_from_errno("malloc");
162 goto done;
164 n = read(p->fd, h->fanout_table, len_fanout);
165 if (n < 0) {
166 err = got_error_from_errno("read");
167 goto done;
168 } else if (n != len_fanout) {
169 err = got_error(GOT_ERR_BAD_PACKIDX);
170 goto done;
173 err = verify_fanout_table(h->fanout_table);
174 if (err)
175 goto done;
176 if (verify)
177 SHA1Update(&ctx, (uint8_t *)h->fanout_table, len_fanout);
178 offset += len_fanout;
179 remain -= len_fanout;
181 nobj = be32toh(h->fanout_table[0xff]);
182 len_ids = nobj * sizeof(*h->sorted_ids);
183 if (len_ids <= nobj || len_ids > remain) {
184 err = got_error(GOT_ERR_BAD_PACKIDX);
185 goto done;
187 if (p->map)
188 h->sorted_ids =
189 (struct got_packidx_object_id *)((uint8_t*)(p->map + offset));
190 else {
191 h->sorted_ids = malloc(len_ids);
192 if (h->sorted_ids == NULL) {
193 err = got_error(GOT_ERR_BAD_PACKIDX);
194 goto done;
196 n = read(p->fd, h->sorted_ids, len_ids);
197 if (n < 0)
198 err = got_error_from_errno("read");
199 else if (n != len_ids) {
200 err = got_error(GOT_ERR_BAD_PACKIDX);
201 goto done;
204 if (verify)
205 SHA1Update(&ctx, (uint8_t *)h->sorted_ids, len_ids);
206 offset += len_ids;
207 remain -= len_ids;
209 if (remain < nobj * sizeof(*h->crc32)) {
210 err = got_error(GOT_ERR_BAD_PACKIDX);
211 goto done;
213 if (p->map)
214 h->crc32 = (uint32_t *)((uint8_t*)(p->map + offset));
215 else {
216 h->crc32 = malloc(nobj * sizeof(*h->crc32));
217 if (h->crc32 == NULL) {
218 err = got_error_from_errno("malloc");
219 goto done;
221 n = read(p->fd, h->crc32, nobj * sizeof(*h->crc32));
222 if (n < 0)
223 err = got_error_from_errno("read");
224 else if (n != nobj * sizeof(*h->crc32)) {
225 err = got_error(GOT_ERR_BAD_PACKIDX);
226 goto done;
229 if (verify)
230 SHA1Update(&ctx, (uint8_t *)h->crc32, nobj * sizeof(*h->crc32));
231 remain -= nobj * sizeof(*h->crc32);
232 offset += nobj * sizeof(*h->crc32);
234 if (remain < nobj * sizeof(*h->offsets)) {
235 err = got_error(GOT_ERR_BAD_PACKIDX);
236 goto done;
238 if (p->map)
239 h->offsets = (uint32_t *)((uint8_t*)(p->map + offset));
240 else {
241 h->offsets = malloc(nobj * sizeof(*h->offsets));
242 if (h->offsets == NULL) {
243 err = got_error_from_errno("malloc");
244 goto done;
246 n = read(p->fd, h->offsets, nobj * sizeof(*h->offsets));
247 if (n < 0)
248 err = got_error_from_errno("read");
249 else if (n != nobj * sizeof(*h->offsets)) {
250 err = got_error(GOT_ERR_BAD_PACKIDX);
251 goto done;
254 if (verify)
255 SHA1Update(&ctx, (uint8_t *)h->offsets,
256 nobj * sizeof(*h->offsets));
257 remain -= nobj * sizeof(*h->offsets);
258 offset += nobj * sizeof(*h->offsets);
260 /* Large file offsets are contained only in files > 2GB. */
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))
264 p->nlargeobj++;
266 if (p->nlargeobj == 0)
267 goto checksum;
269 if (remain < p->nlargeobj * sizeof(*h->large_offsets)) {
270 err = got_error(GOT_ERR_BAD_PACKIDX);
271 goto done;
273 if (p->map)
274 h->large_offsets = (uint64_t *)((uint8_t*)(p->map + offset));
275 else {
276 h->large_offsets = malloc(p->nlargeobj *
277 sizeof(*h->large_offsets));
278 if (h->large_offsets == NULL) {
279 err = got_error_from_errno("malloc");
280 goto done;
282 n = read(p->fd, h->large_offsets,
283 p->nlargeobj * sizeof(*h->large_offsets));
284 if (n < 0)
285 err = got_error_from_errno("read");
286 else if (n != p->nlargeobj * sizeof(*h->large_offsets)) {
287 err = got_error(GOT_ERR_BAD_PACKIDX);
288 goto done;
291 if (verify)
292 SHA1Update(&ctx, (uint8_t*)h->large_offsets,
293 p->nlargeobj * sizeof(*h->large_offsets));
294 remain -= p->nlargeobj * sizeof(*h->large_offsets);
295 offset += p->nlargeobj * sizeof(*h->large_offsets);
297 checksum:
298 if (remain < sizeof(*h->trailer)) {
299 err = got_error(GOT_ERR_BAD_PACKIDX);
300 goto done;
302 if (p->map)
303 h->trailer =
304 (struct got_packidx_trailer *)((uint8_t*)(p->map + offset));
305 else {
306 h->trailer = malloc(sizeof(*h->trailer));
307 if (h->trailer == NULL) {
308 err = got_error_from_errno("malloc");
309 goto done;
311 n = read(p->fd, h->trailer, sizeof(*h->trailer));
312 if (n < 0)
313 err = got_error_from_errno("read");
314 else if (n != sizeof(*h->trailer)) {
315 err = got_error(GOT_ERR_BAD_PACKIDX);
316 goto done;
319 if (verify) {
320 SHA1Update(&ctx, h->trailer->packfile_sha1, SHA1_DIGEST_LENGTH);
321 SHA1Final(sha1, &ctx);
322 if (memcmp(h->trailer->packidx_sha1, sha1,
323 SHA1_DIGEST_LENGTH) != 0)
324 err = got_error(GOT_ERR_PACKIDX_CSUM);
326 done:
327 return err;
330 const struct got_error *
331 got_packidx_open(struct got_packidx **packidx,
332 int dir_fd, const char *relpath, int verify)
334 const struct got_error *err = NULL;
335 struct got_packidx *p;
336 struct stat sb;
338 *packidx = NULL;
340 p = calloc(1, sizeof(*p));
341 if (p == NULL)
342 return got_error_from_errno("calloc");
344 p->fd = openat(dir_fd, relpath, O_RDONLY | O_NOFOLLOW);
345 if (p->fd == -1) {
346 err = got_error_from_errno2("openat", relpath);
347 free(p);
348 return err;
351 if (fstat(p->fd, &sb) != 0) {
352 err = got_error_from_errno2("fstat", relpath);
353 close(p->fd);
354 free(p);
355 return err;
357 p->len = sb.st_size;
358 if (p->len < sizeof(p->hdr)) {
359 err = got_error(GOT_ERR_BAD_PACKIDX);
360 close(p->fd);
361 free(p);
362 return err;
365 p->path_packidx = strdup(relpath);
366 if (p->path_packidx == NULL) {
367 err = got_error_from_errno("strdup");
368 goto done;
371 #ifndef GOT_PACK_NO_MMAP
372 p->map = mmap(NULL, p->len, PROT_READ, MAP_PRIVATE, p->fd, 0);
373 if (p->map == MAP_FAILED) {
374 if (errno != ENOMEM) {
375 err = got_error_from_errno("mmap");
376 goto done;
378 p->map = NULL; /* fall back to read(2) */
380 #endif
382 err = got_packidx_init_hdr(p, verify);
383 done:
384 if (err)
385 got_packidx_close(p);
386 else
387 *packidx = p;
389 return err;
392 const struct got_error *
393 got_packidx_close(struct got_packidx *packidx)
395 const struct got_error *err = NULL;
397 free(packidx->path_packidx);
398 if (packidx->map) {
399 if (munmap(packidx->map, packidx->len) == -1)
400 err = got_error_from_errno("munmap");
401 } else {
402 free(packidx->hdr.magic);
403 free(packidx->hdr.version);
404 free(packidx->hdr.fanout_table);
405 free(packidx->hdr.sorted_ids);
406 free(packidx->hdr.crc32);
407 free(packidx->hdr.offsets);
408 free(packidx->hdr.large_offsets);
409 free(packidx->hdr.trailer);
411 if (close(packidx->fd) == -1 && err == NULL)
412 err = got_error_from_errno("close");
413 free(packidx);
415 return err;
418 const struct got_error *
419 got_packidx_get_packfile_path(char **path_packfile, struct got_packidx *packidx)
421 size_t size;
423 /* Packfile path contains ".pack" instead of ".idx", so add one byte. */
424 size = strlen(packidx->path_packidx) + 2;
425 if (size < GOT_PACKFILE_NAMELEN + 1)
426 return got_error_path(packidx->path_packidx, GOT_ERR_BAD_PATH);
428 *path_packfile = malloc(size);
429 if (*path_packfile == NULL)
430 return got_error_from_errno("malloc");
432 /* Copy up to and excluding ".idx". */
433 if (strlcpy(*path_packfile, packidx->path_packidx,
434 size - strlen(GOT_PACKIDX_SUFFIX) - 1) >= size)
435 return got_error(GOT_ERR_NO_SPACE);
437 if (strlcat(*path_packfile, GOT_PACKFILE_SUFFIX, size) >= size)
438 return got_error(GOT_ERR_NO_SPACE);
440 return NULL;
443 off_t
444 got_packidx_get_object_offset(struct got_packidx *packidx, int idx)
446 uint32_t offset = be32toh(packidx->hdr.offsets[idx]);
447 if (offset & GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX) {
448 uint64_t loffset;
449 idx = offset & GOT_PACKIDX_OFFSET_VAL_MASK;
450 if (idx < 0 || idx >= packidx->nlargeobj ||
451 packidx->hdr.large_offsets == NULL)
452 return -1;
453 loffset = be64toh(packidx->hdr.large_offsets[idx]);
454 return (loffset > INT64_MAX ? -1 : (off_t)loffset);
456 return (off_t)(offset & GOT_PACKIDX_OFFSET_VAL_MASK);
459 int
460 got_packidx_get_object_idx(struct got_packidx *packidx, struct got_object_id *id)
462 u_int8_t id0 = id->sha1[0];
463 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
464 int left = 0, right = totobj - 1;
466 if (id0 > 0)
467 left = be32toh(packidx->hdr.fanout_table[id0 - 1]);
469 while (left <= right) {
470 struct got_packidx_object_id *oid;
471 int i, cmp;
473 i = ((left + right) / 2);
474 oid = &packidx->hdr.sorted_ids[i];
475 cmp = memcmp(id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
476 if (cmp == 0)
477 return i;
478 else if (cmp > 0)
479 left = i + 1;
480 else if (cmp < 0)
481 right = i - 1;
484 return -1;
487 const struct got_error *
488 got_packidx_match_id_str_prefix(struct got_object_id_queue *matched_ids,
489 struct got_packidx *packidx, const char *id_str_prefix)
491 const struct got_error *err = NULL;
492 u_int8_t id0;
493 uint32_t totobj = be32toh(packidx->hdr.fanout_table[0xff]);
494 char hex[3];
495 size_t prefix_len = strlen(id_str_prefix);
496 struct got_packidx_object_id *oid;
497 uint32_t i;
499 STAILQ_INIT(matched_ids);
501 if (prefix_len < 2)
502 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
504 hex[0] = id_str_prefix[0];
505 hex[1] = id_str_prefix[1];
506 hex[2] = '\0';
507 if (!got_parse_xdigit(&id0, hex))
508 return got_error_path(id_str_prefix, GOT_ERR_BAD_OBJ_ID_STR);
510 i = be32toh(packidx->hdr.fanout_table[id0 - 1]);
511 oid = &packidx->hdr.sorted_ids[i];
512 while (i < totobj && oid->sha1[0] == id0) {
513 char id_str[SHA1_DIGEST_STRING_LENGTH];
514 struct got_object_qid *qid;
515 int cmp;
517 if (!got_sha1_digest_to_str(oid->sha1, id_str, sizeof(id_str)))
518 return got_error(GOT_ERR_NO_SPACE);
520 cmp = strncmp(id_str, id_str_prefix, prefix_len);
521 if (cmp < 0) {
522 oid = &packidx->hdr.sorted_ids[++i];
523 continue;
524 } else if (cmp > 0)
525 break;
527 err = got_object_qid_alloc_partial(&qid);
528 if (err)
529 break;
530 memcpy(qid->id->sha1, oid->sha1, SHA1_DIGEST_LENGTH);
531 STAILQ_INSERT_TAIL(matched_ids, qid, entry);
533 oid = &packidx->hdr.sorted_ids[++i];
536 if (err)
537 got_object_id_queue_free(matched_ids);
538 return err;
541 static const struct got_error *
542 pack_stop_privsep_child(struct got_pack *pack)
544 const struct got_error *err = NULL;
546 if (pack->privsep_child == NULL)
547 return NULL;
549 err = got_privsep_send_stop(pack->privsep_child->imsg_fd);
550 if (err)
551 return err;
552 err = got_privsep_wait_for_child(pack->privsep_child->pid);
553 if (close(pack->privsep_child->imsg_fd) == -1 && err == NULL)
554 err = got_error_from_errno("close");
555 imsg_clear(pack->privsep_child->ibuf);
556 free(pack->privsep_child->ibuf);
557 free(pack->privsep_child);
558 pack->privsep_child = NULL;
559 return err;
562 const struct got_error *
563 got_pack_close(struct got_pack *pack)
565 const struct got_error *err = NULL;
567 err = pack_stop_privsep_child(pack);
568 if (pack->map && munmap(pack->map, pack->filesize) == -1 && !err)
569 err = got_error_from_errno("munmap");
570 if (pack->fd != -1 && close(pack->fd) == -1 && err == NULL)
571 err = got_error_from_errno("close");
572 pack->fd = -1;
573 free(pack->path_packfile);
574 pack->path_packfile = NULL;
575 pack->filesize = 0;
576 if (pack->delta_cache) {
577 got_delta_cache_free(pack->delta_cache);
578 pack->delta_cache = NULL;
581 return err;
584 const struct got_error *
585 got_pack_parse_object_type_and_size(uint8_t *type, uint64_t *size, size_t *len,
586 struct got_pack *pack, off_t offset)
588 uint8_t t = 0;
589 uint64_t s = 0;
590 uint8_t sizeN;
591 size_t mapoff = 0;
592 int i = 0;
594 *len = 0;
596 if (offset >= pack->filesize)
597 return got_error(GOT_ERR_PACK_OFFSET);
599 if (pack->map) {
600 mapoff = (size_t)offset;
601 } else {
602 if (lseek(pack->fd, offset, SEEK_SET) == -1)
603 return got_error_from_errno("lseek");
606 do {
607 /* We do not support size values which don't fit in 64 bit. */
608 if (i > 9)
609 return got_error(GOT_ERR_NO_SPACE);
611 if (pack->map) {
612 sizeN = *(pack->map + mapoff);
613 mapoff += sizeof(sizeN);
614 } else {
615 ssize_t n = read(pack->fd, &sizeN, sizeof(sizeN));
616 if (n < 0)
617 return got_error_from_errno("read");
618 if (n != sizeof(sizeN))
619 return got_error(GOT_ERR_BAD_PACKFILE);
621 *len += sizeof(sizeN);
623 if (i == 0) {
624 t = (sizeN & GOT_PACK_OBJ_SIZE0_TYPE_MASK) >>
625 GOT_PACK_OBJ_SIZE0_TYPE_MASK_SHIFT;
626 s = (sizeN & GOT_PACK_OBJ_SIZE0_VAL_MASK);
627 } else {
628 size_t shift = 4 + 7 * (i - 1);
629 s |= ((sizeN & GOT_PACK_OBJ_SIZE_VAL_MASK) << shift);
631 i++;
632 } while (sizeN & GOT_PACK_OBJ_SIZE_MORE);
634 *type = t;
635 *size = s;
636 return NULL;
639 static const struct got_error *
640 open_plain_object(struct got_object **obj, struct got_object_id *id,
641 uint8_t type, off_t offset, size_t size, int idx)
643 *obj = calloc(1, sizeof(**obj));
644 if (*obj == NULL)
645 return got_error_from_errno("calloc");
647 (*obj)->type = type;
648 (*obj)->flags = GOT_OBJ_FLAG_PACKED;
649 (*obj)->pack_idx = idx;
650 (*obj)->hdrlen = 0;
651 (*obj)->size = size;
652 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
653 (*obj)->pack_offset = offset;
655 return NULL;
658 static const struct got_error *
659 parse_negative_offset(int64_t *offset, size_t *len, struct got_pack *pack,
660 off_t delta_offset)
662 int64_t o = 0;
663 uint8_t offN;
664 int i = 0;
666 *offset = 0;
667 *len = 0;
669 do {
670 /* We do not support offset values which don't fit in 64 bit. */
671 if (i > 8)
672 return got_error(GOT_ERR_NO_SPACE);
674 if (pack->map) {
675 size_t mapoff;
676 if (delta_offset >= pack->filesize)
677 return got_error(GOT_ERR_PACK_OFFSET);
678 mapoff = (size_t)delta_offset + *len;
679 offN = *(pack->map + mapoff);
680 } else {
681 ssize_t n;
682 n = read(pack->fd, &offN, sizeof(offN));
683 if (n < 0)
684 return got_error_from_errno("read");
685 if (n != sizeof(offN))
686 return got_error(GOT_ERR_BAD_PACKFILE);
688 *len += sizeof(offN);
690 if (i == 0)
691 o = (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
692 else {
693 o++;
694 o <<= 7;
695 o += (offN & GOT_PACK_OBJ_DELTA_OFF_VAL_MASK);
697 i++;
698 } while (offN & GOT_PACK_OBJ_DELTA_OFF_MORE);
700 *offset = o;
701 return NULL;
704 const struct got_error *
705 got_pack_parse_offset_delta(off_t *base_offset, size_t *len, struct got_pack *pack,
706 off_t offset, int tslen)
708 const struct got_error *err;
709 int64_t negoffset;
710 size_t negofflen;
712 *len = 0;
714 err = parse_negative_offset(&negoffset, &negofflen, pack,
715 offset + tslen);
716 if (err)
717 return err;
719 /* Compute the base object's offset (must be in the same pack file). */
720 *base_offset = (offset - negoffset);
721 if (*base_offset <= 0)
722 return got_error(GOT_ERR_BAD_PACKFILE);
724 *len = negofflen;
725 return NULL;
728 static const struct got_error *
729 read_delta_data(uint8_t **delta_buf, size_t *delta_len,
730 size_t delta_data_offset, struct got_pack *pack)
732 const struct got_error *err = NULL;
734 if (pack->map) {
735 if (delta_data_offset >= pack->filesize)
736 return got_error(GOT_ERR_PACK_OFFSET);
737 err = got_inflate_to_mem_mmap(delta_buf, delta_len,
738 NULL, NULL, pack->map, delta_data_offset,
739 pack->filesize - delta_data_offset);
740 } else {
741 if (lseek(pack->fd, delta_data_offset, SEEK_SET) == -1)
742 return got_error_from_errno("lseek");
743 err = got_inflate_to_mem_fd(delta_buf, delta_len, NULL,
744 NULL, 0, pack->fd);
746 return err;
749 static const struct got_error *
750 add_delta(struct got_delta_chain *deltas, off_t delta_offset, size_t tslen,
751 int delta_type, size_t delta_size, size_t delta_data_offset)
753 struct got_delta *delta;
755 delta = got_delta_open(delta_offset, tslen, delta_type, delta_size,
756 delta_data_offset);
757 if (delta == NULL)
758 return got_error_from_errno("got_delta_open");
759 /* delta is freed in got_object_close() */
760 deltas->nentries++;
761 STAILQ_INSERT_HEAD(&deltas->entries, delta, entry);
762 return NULL;
765 static const struct got_error *
766 resolve_offset_delta(struct got_delta_chain *deltas,
767 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
768 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
771 const struct got_error *err;
772 off_t base_offset;
773 uint8_t base_type;
774 uint64_t base_size;
775 size_t base_tslen;
776 off_t delta_data_offset;
777 size_t consumed;
779 err = got_pack_parse_offset_delta(&base_offset, &consumed, pack,
780 delta_offset, tslen);
781 if (err)
782 return err;
784 delta_data_offset = delta_offset + tslen + consumed;
785 if (delta_data_offset >= pack->filesize)
786 return got_error(GOT_ERR_PACK_OFFSET);
788 if (pack->map == NULL) {
789 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
790 if (delta_data_offset == -1)
791 return got_error_from_errno("lseek");
794 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
795 delta_data_offset);
796 if (err)
797 return err;
799 /* An offset delta must be in the same packfile. */
800 if (base_offset >= pack->filesize)
801 return got_error(GOT_ERR_PACK_OFFSET);
803 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
804 &base_tslen, pack, base_offset);
805 if (err)
806 return err;
808 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
809 base_tslen, base_type, base_size, recursion - 1);
812 const struct got_error *
813 got_pack_parse_ref_delta(struct got_object_id *id,
814 struct got_pack *pack, off_t delta_offset, int tslen)
816 if (pack->map) {
817 size_t mapoff = delta_offset + tslen;
818 memcpy(id, pack->map + mapoff, sizeof(*id));
819 } else {
820 ssize_t n;
821 n = read(pack->fd, id, sizeof(*id));
822 if (n < 0)
823 return got_error_from_errno("read");
824 if (n != sizeof(*id))
825 return got_error(GOT_ERR_BAD_PACKFILE);
828 return NULL;
831 static const struct got_error *
832 resolve_ref_delta(struct got_delta_chain *deltas, struct got_packidx *packidx,
833 struct got_pack *pack, off_t delta_offset, size_t tslen, int delta_type,
834 size_t delta_size, unsigned int recursion)
836 const struct got_error *err;
837 struct got_object_id id;
838 int idx;
839 off_t base_offset;
840 uint8_t base_type;
841 uint64_t base_size;
842 size_t base_tslen;
843 off_t delta_data_offset;
845 if (delta_offset + tslen >= pack->filesize)
846 return got_error(GOT_ERR_PACK_OFFSET);
848 err = got_pack_parse_ref_delta(&id, pack, delta_offset, tslen);
849 if (err)
850 return err;
851 if (pack->map) {
852 delta_data_offset = delta_offset + tslen + sizeof(id);
853 } else {
854 delta_data_offset = lseek(pack->fd, 0, SEEK_CUR);
855 if (delta_data_offset == -1)
856 return got_error_from_errno("lseek");
859 err = add_delta(deltas, delta_offset, tslen, delta_type, delta_size,
860 delta_data_offset);
861 if (err)
862 return err;
864 /* Delta base must be in the same pack file. */
865 idx = got_packidx_get_object_idx(packidx, &id);
866 if (idx == -1)
867 return got_error(GOT_ERR_NO_OBJ);
869 base_offset = got_packidx_get_object_offset(packidx, idx);
870 if (base_offset == (uint64_t)-1)
871 return got_error(GOT_ERR_BAD_PACKIDX);
873 if (base_offset >= pack->filesize)
874 return got_error(GOT_ERR_PACK_OFFSET);
876 err = got_pack_parse_object_type_and_size(&base_type, &base_size,
877 &base_tslen, pack, base_offset);
878 if (err)
879 return err;
881 return got_pack_resolve_delta_chain(deltas, packidx, pack, base_offset,
882 base_tslen, base_type, base_size, recursion - 1);
885 const struct got_error *
886 got_pack_resolve_delta_chain(struct got_delta_chain *deltas,
887 struct got_packidx *packidx, struct got_pack *pack, off_t delta_offset,
888 size_t tslen, int delta_type, size_t delta_size, unsigned int recursion)
890 const struct got_error *err = NULL;
892 if (--recursion == 0)
893 return got_error(GOT_ERR_RECURSION);
895 switch (delta_type) {
896 case GOT_OBJ_TYPE_COMMIT:
897 case GOT_OBJ_TYPE_TREE:
898 case GOT_OBJ_TYPE_BLOB:
899 case GOT_OBJ_TYPE_TAG:
900 /* Plain types are the final delta base. Recursion ends. */
901 err = add_delta(deltas, delta_offset, tslen, delta_type,
902 delta_size, 0);
903 break;
904 case GOT_OBJ_TYPE_OFFSET_DELTA:
905 err = resolve_offset_delta(deltas, packidx, pack,
906 delta_offset, tslen, delta_type, delta_size, recursion - 1);
907 break;
908 case GOT_OBJ_TYPE_REF_DELTA:
909 err = resolve_ref_delta(deltas, packidx, pack,
910 delta_offset, tslen, delta_type, delta_size, recursion - 1);
911 break;
912 default:
913 return got_error(GOT_ERR_OBJ_TYPE);
916 return err;
919 static const struct got_error *
920 open_delta_object(struct got_object **obj, struct got_packidx *packidx,
921 struct got_pack *pack, struct got_object_id *id, off_t offset,
922 size_t tslen, int delta_type, size_t delta_size, int idx)
924 const struct got_error *err = NULL;
925 int resolved_type;
927 *obj = calloc(1, sizeof(**obj));
928 if (*obj == NULL)
929 return got_error_from_errno("calloc");
931 (*obj)->flags = 0;
932 (*obj)->hdrlen = 0;
933 (*obj)->size = 0; /* Not known because deltas aren't applied yet. */
934 memcpy(&(*obj)->id, id, sizeof((*obj)->id));
935 (*obj)->pack_offset = offset + tslen;
937 STAILQ_INIT(&(*obj)->deltas.entries);
938 (*obj)->flags |= GOT_OBJ_FLAG_DELTIFIED;
939 (*obj)->flags |= GOT_OBJ_FLAG_PACKED;
940 (*obj)->pack_idx = idx;
942 err = got_pack_resolve_delta_chain(&(*obj)->deltas, packidx, pack,
943 offset, tslen, delta_type, delta_size,
944 GOT_DELTA_CHAIN_RECURSION_MAX);
945 if (err)
946 goto done;
948 err = got_delta_chain_get_base_type(&resolved_type, &(*obj)->deltas);
949 if (err)
950 goto done;
951 (*obj)->type = resolved_type;
952 done:
953 if (err) {
954 got_object_close(*obj);
955 *obj = NULL;
957 return err;
960 const struct got_error *
961 got_packfile_open_object(struct got_object **obj, struct got_pack *pack,
962 struct got_packidx *packidx, int idx, struct got_object_id *id)
964 const struct got_error *err = NULL;
965 off_t offset;
966 uint8_t type;
967 uint64_t size;
968 size_t tslen;
970 *obj = NULL;
972 offset = got_packidx_get_object_offset(packidx, idx);
973 if (offset == (uint64_t)-1)
974 return got_error(GOT_ERR_BAD_PACKIDX);
976 err = got_pack_parse_object_type_and_size(&type, &size, &tslen,
977 pack, offset);
978 if (err)
979 return err;
981 switch (type) {
982 case GOT_OBJ_TYPE_COMMIT:
983 case GOT_OBJ_TYPE_TREE:
984 case GOT_OBJ_TYPE_BLOB:
985 case GOT_OBJ_TYPE_TAG:
986 err = open_plain_object(obj, id, type, offset + tslen,
987 size, idx);
988 break;
989 case GOT_OBJ_TYPE_OFFSET_DELTA:
990 case GOT_OBJ_TYPE_REF_DELTA:
991 err = open_delta_object(obj, packidx, pack, id, offset,
992 tslen, type, size, idx);
993 break;
994 default:
995 err = got_error(GOT_ERR_OBJ_TYPE);
996 break;
999 return err;
1002 const struct got_error *
1003 got_pack_get_delta_chain_max_size(uint64_t *max_size, struct got_delta_chain *deltas,
1004 struct got_pack *pack)
1006 struct got_delta *delta;
1007 uint64_t base_size = 0, result_size = 0;
1009 *max_size = 0;
1010 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1011 /* Plain object types are the delta base. */
1012 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1013 delta->type != GOT_OBJ_TYPE_TREE &&
1014 delta->type != GOT_OBJ_TYPE_BLOB &&
1015 delta->type != GOT_OBJ_TYPE_TAG) {
1016 const struct got_error *err;
1017 uint8_t *delta_buf;
1018 size_t delta_len;
1019 int cached = 1;
1021 got_delta_cache_get(&delta_buf, &delta_len,
1022 pack->delta_cache, delta->data_offset);
1023 if (delta_buf == NULL) {
1024 cached = 0;
1025 err = read_delta_data(&delta_buf, &delta_len,
1026 delta->data_offset, pack);
1027 if (err)
1028 return err;
1029 err = got_delta_cache_add(pack->delta_cache,
1030 delta->data_offset, delta_buf, delta_len);
1031 if (err == NULL)
1032 cached = 1;
1033 else if (err->code != GOT_ERR_NO_SPACE) {
1034 free(delta_buf);
1035 return err;
1038 err = got_delta_get_sizes(&base_size, &result_size,
1039 delta_buf, delta_len);
1040 if (!cached)
1041 free(delta_buf);
1042 if (err)
1043 return err;
1044 } else
1045 base_size = delta->size;
1046 if (base_size > *max_size)
1047 *max_size = base_size;
1048 if (result_size > *max_size)
1049 *max_size = result_size;
1052 return NULL;
1055 const struct got_error *
1056 got_pack_get_max_delta_object_size(uint64_t *size, struct got_object *obj,
1057 struct got_pack *pack)
1059 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
1060 return got_error(GOT_ERR_OBJ_TYPE);
1062 return got_pack_get_delta_chain_max_size(size, &obj->deltas, pack);
1065 const struct got_error *
1066 got_pack_dump_delta_chain_to_file(size_t *result_size,
1067 struct got_delta_chain *deltas, struct got_pack *pack, FILE *outfile,
1068 FILE *base_file, FILE *accum_file)
1070 const struct got_error *err = NULL;
1071 struct got_delta *delta;
1072 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1073 size_t base_bufsz = 0, accum_size = 0, delta_len;
1074 uint64_t max_size;
1075 int n = 0;
1077 *result_size = 0;
1079 if (STAILQ_EMPTY(&deltas->entries))
1080 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1082 /* We process small enough files entirely in memory for speed. */
1083 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1084 if (err)
1085 return err;
1086 if (max_size < GOT_DELTA_RESULT_SIZE_CACHED_MAX) {
1087 accum_buf = malloc(max_size);
1088 if (accum_buf == NULL)
1089 return got_error_from_errno("malloc");
1090 base_file = NULL;
1091 accum_file = NULL;
1094 /* Deltas are ordered in ascending order. */
1095 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1096 int cached = 1;
1097 if (n == 0) {
1098 size_t mapoff;
1099 off_t delta_data_offset;
1101 /* Plain object types are the delta base. */
1102 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1103 delta->type != GOT_OBJ_TYPE_TREE &&
1104 delta->type != GOT_OBJ_TYPE_BLOB &&
1105 delta->type != GOT_OBJ_TYPE_TAG) {
1106 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1107 goto done;
1110 delta_data_offset = delta->offset + delta->tslen;
1111 if (delta_data_offset >= pack->filesize) {
1112 err = got_error(GOT_ERR_PACK_OFFSET);
1113 goto done;
1115 if (pack->map == NULL) {
1116 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1117 == -1) {
1118 err = got_error_from_errno("lseek");
1119 goto done;
1122 if (base_file) {
1123 if (pack->map) {
1124 mapoff = (size_t)delta_data_offset;
1125 err = got_inflate_to_file_mmap(
1126 &base_bufsz, NULL, NULL, pack->map,
1127 mapoff, pack->filesize - mapoff,
1128 base_file);
1129 } else
1130 err = got_inflate_to_file_fd(
1131 &base_bufsz, NULL, NULL, pack->fd,
1132 base_file);
1133 } else {
1134 if (pack->map) {
1135 mapoff = (size_t)delta_data_offset;
1136 err = got_inflate_to_mem_mmap(&base_buf,
1137 &base_bufsz, NULL, NULL,
1138 pack->map, mapoff,
1139 pack->filesize - mapoff);
1140 } else
1141 err = got_inflate_to_mem_fd(&base_buf,
1142 &base_bufsz, NULL, NULL, max_size,
1143 pack->fd);
1145 if (err)
1146 goto done;
1147 n++;
1148 if (base_file)
1149 rewind(base_file);
1150 continue;
1153 got_delta_cache_get(&delta_buf, &delta_len,
1154 pack->delta_cache, delta->data_offset);
1155 if (delta_buf == NULL) {
1156 cached = 0;
1157 err = read_delta_data(&delta_buf, &delta_len,
1158 delta->data_offset, pack);
1159 if (err)
1160 goto done;
1161 err = got_delta_cache_add(pack->delta_cache,
1162 delta->data_offset, delta_buf, delta_len);
1163 if (err == NULL)
1164 cached = 1;
1165 else if (err->code != GOT_ERR_NO_SPACE) {
1166 free(delta_buf);
1167 goto done;
1170 if (base_buf) {
1171 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1172 delta_buf, delta_len, accum_buf,
1173 &accum_size, max_size);
1174 n++;
1175 } else {
1176 err = got_delta_apply(base_file, delta_buf,
1177 delta_len,
1178 /* Final delta application writes to output file. */
1179 ++n < deltas->nentries ? accum_file : outfile,
1180 &accum_size);
1182 if (!cached)
1183 free(delta_buf);
1184 if (err)
1185 goto done;
1187 if (n < deltas->nentries) {
1188 /* Accumulated delta becomes the new base. */
1189 if (base_buf) {
1190 uint8_t *tmp = accum_buf;
1192 * Base buffer switches roles with accumulation
1193 * buffer. Ensure it can hold the largest
1194 * result in the delta chain. The initial
1195 * allocation might have been smaller.
1197 if (base_bufsz < max_size) {
1198 uint8_t *p;
1199 p = reallocarray(base_buf, 1, max_size);
1200 if (p == NULL) {
1201 err = got_error_from_errno(
1202 "reallocarray");
1203 goto done;
1205 base_buf = p;
1206 base_bufsz = max_size;
1208 accum_buf = base_buf;
1209 base_buf = tmp;
1210 } else {
1211 FILE *tmp = accum_file;
1212 accum_file = base_file;
1213 base_file = tmp;
1214 rewind(base_file);
1215 rewind(accum_file);
1220 done:
1221 free(base_buf);
1222 if (accum_buf) {
1223 size_t len = fwrite(accum_buf, 1, accum_size, outfile);
1224 free(accum_buf);
1225 if (len != accum_size)
1226 err = got_ferror(outfile, GOT_ERR_IO);
1228 rewind(outfile);
1229 if (err == NULL)
1230 *result_size = accum_size;
1231 return err;
1234 const struct got_error *
1235 got_pack_dump_delta_chain_to_mem(uint8_t **outbuf, size_t *outlen,
1236 struct got_delta_chain *deltas, struct got_pack *pack)
1238 const struct got_error *err = NULL;
1239 struct got_delta *delta;
1240 uint8_t *base_buf = NULL, *accum_buf = NULL, *delta_buf;
1241 size_t base_bufsz = 0, accum_size = 0, delta_len;
1242 uint64_t max_size;
1243 int n = 0;
1245 *outbuf = NULL;
1246 *outlen = 0;
1248 if (STAILQ_EMPTY(&deltas->entries))
1249 return got_error(GOT_ERR_BAD_DELTA_CHAIN);
1251 err = got_pack_get_delta_chain_max_size(&max_size, deltas, pack);
1252 if (err)
1253 return err;
1254 accum_buf = malloc(max_size);
1255 if (accum_buf == NULL)
1256 return got_error_from_errno("malloc");
1258 /* Deltas are ordered in ascending order. */
1259 STAILQ_FOREACH(delta, &deltas->entries, entry) {
1260 int cached = 1;
1261 if (n == 0) {
1262 size_t delta_data_offset;
1264 /* Plain object types are the delta base. */
1265 if (delta->type != GOT_OBJ_TYPE_COMMIT &&
1266 delta->type != GOT_OBJ_TYPE_TREE &&
1267 delta->type != GOT_OBJ_TYPE_BLOB &&
1268 delta->type != GOT_OBJ_TYPE_TAG) {
1269 err = got_error(GOT_ERR_BAD_DELTA_CHAIN);
1270 goto done;
1273 delta_data_offset = delta->offset + delta->tslen;
1274 if (delta_data_offset >= pack->filesize) {
1275 err = got_error(GOT_ERR_PACK_OFFSET);
1276 goto done;
1278 if (pack->map) {
1279 size_t mapoff = (size_t)delta_data_offset;
1280 err = got_inflate_to_mem_mmap(&base_buf,
1281 &base_bufsz, NULL, NULL, pack->map,
1282 mapoff, pack->filesize - mapoff);
1283 } else {
1284 if (lseek(pack->fd, delta_data_offset, SEEK_SET)
1285 == -1) {
1286 err = got_error_from_errno("lseek");
1287 goto done;
1289 err = got_inflate_to_mem_fd(&base_buf,
1290 &base_bufsz, NULL, NULL, max_size,
1291 pack->fd);
1293 if (err)
1294 goto done;
1295 n++;
1296 continue;
1299 got_delta_cache_get(&delta_buf, &delta_len,
1300 pack->delta_cache, delta->data_offset);
1301 if (delta_buf == NULL) {
1302 cached = 0;
1303 err = read_delta_data(&delta_buf, &delta_len,
1304 delta->data_offset, pack);
1305 if (err)
1306 goto done;
1307 err = got_delta_cache_add(pack->delta_cache,
1308 delta->data_offset, delta_buf, delta_len);
1309 if (err == NULL)
1310 cached = 1;
1311 else if (err->code != GOT_ERR_NO_SPACE) {
1312 free(delta_buf);
1313 goto done;
1316 err = got_delta_apply_in_mem(base_buf, base_bufsz,
1317 delta_buf, delta_len, accum_buf,
1318 &accum_size, max_size);
1319 if (!cached)
1320 free(delta_buf);
1321 n++;
1322 if (err)
1323 goto done;
1325 if (n < deltas->nentries) {
1326 /* Accumulated delta becomes the new base. */
1327 uint8_t *tmp = accum_buf;
1329 * Base buffer switches roles with accumulation buffer.
1330 * Ensure it can hold the largest result in the delta
1331 * chain. Initial allocation might have been smaller.
1333 if (base_bufsz < max_size) {
1334 uint8_t *p;
1335 p = reallocarray(base_buf, 1, max_size);
1336 if (p == NULL) {
1337 err = got_error_from_errno(
1338 "reallocarray");
1339 goto done;
1341 base_buf = p;
1342 base_bufsz = max_size;
1344 accum_buf = base_buf;
1345 base_buf = tmp;
1349 done:
1350 free(base_buf);
1351 if (err) {
1352 free(accum_buf);
1353 *outbuf = NULL;
1354 *outlen = 0;
1355 } else {
1356 *outbuf = accum_buf;
1357 *outlen = accum_size;
1359 return err;
1362 const struct got_error *
1363 got_packfile_extract_object(struct got_pack *pack, struct got_object *obj,
1364 FILE *outfile, FILE *base_file, FILE *accum_file)
1366 const struct got_error *err = NULL;
1368 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1369 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1371 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1372 if (obj->pack_offset >= pack->filesize)
1373 return got_error(GOT_ERR_PACK_OFFSET);
1375 if (pack->map) {
1376 size_t mapoff = (size_t)obj->pack_offset;
1377 err = got_inflate_to_file_mmap(&obj->size, NULL, NULL,
1378 pack->map, mapoff, pack->filesize - mapoff,
1379 outfile);
1380 } else {
1381 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1382 return got_error_from_errno("lseek");
1383 err = got_inflate_to_file_fd(&obj->size, NULL, NULL,
1384 pack->fd, outfile);
1386 } else
1387 err = got_pack_dump_delta_chain_to_file(&obj->size,
1388 &obj->deltas, pack, outfile, base_file, accum_file);
1390 return err;
1393 const struct got_error *
1394 got_packfile_extract_object_to_mem(uint8_t **buf, size_t *len,
1395 struct got_object *obj, struct got_pack *pack)
1397 const struct got_error *err = NULL;
1399 if ((obj->flags & GOT_OBJ_FLAG_PACKED) == 0)
1400 return got_error(GOT_ERR_OBJ_NOT_PACKED);
1402 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0) {
1403 if (obj->pack_offset >= pack->filesize)
1404 return got_error(GOT_ERR_PACK_OFFSET);
1405 if (pack->map) {
1406 size_t mapoff = (size_t)obj->pack_offset;
1407 err = got_inflate_to_mem_mmap(buf, len, NULL, NULL,
1408 pack->map, mapoff, pack->filesize - mapoff);
1409 } else {
1410 if (lseek(pack->fd, obj->pack_offset, SEEK_SET) == -1)
1411 return got_error_from_errno("lseek");
1412 err = got_inflate_to_mem_fd(buf, len, NULL, NULL,
1413 obj->size, pack->fd);
1415 } else
1416 err = got_pack_dump_delta_chain_to_mem(buf, len, &obj->deltas,
1417 pack);
1419 return err;