1 /*
2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 /* An open pack file. */
18 struct got_pack {
19 	char *path_packfile;
20 	int fd;
21 	uint8_t *map;
22 	size_t filesize;
23 	struct got_privsep_child *privsep_child;
24 };
25 
26 const struct got_error *got_pack_stop_privsep_child(struct got_pack *);
27 const struct got_error *got_pack_close(struct got_pack *);
28 
29 #define GOT_PACK_PREFIX		"pack-"
30 #define GOT_PACKFILE_SUFFIX	".pack"
31 #define GOT_PACKIDX_SUFFIX		".idx"
32 #define GOT_PACKFILE_NAMELEN	(strlen(GOT_PACK_PREFIX) + \
33 				SHA1_DIGEST_STRING_LENGTH - 1 + \
34 				strlen(GOT_PACKFILE_SUFFIX))
35 #define GOT_PACKIDX_NAMELEN	(strlen(GOT_PACK_PREFIX) + \
36 				SHA1_DIGEST_STRING_LENGTH - 1 + \
37 				strlen(GOT_PACKIDX_SUFFIX))
38 
39 /* See Documentation/technical/pack-format.txt in Git. */
40 
41 struct got_packidx_trailer {
42 	u_int8_t	packfile_sha1[SHA1_DIGEST_LENGTH];
43 	u_int8_t	packidx_sha1[SHA1_DIGEST_LENGTH];
44 } __attribute__((__packed__));
45 
46 struct got_packidx_object_id {
47 	u_int8_t sha1[SHA1_DIGEST_LENGTH];
48 } __attribute__((__packed__));
49 
50 /* Ignore pack index version 1 which is no longer written by Git. */
51 #define GOT_PACKIDX_VERSION 2
52 
53 struct got_packidx_v2_hdr {
54 	uint32_t	*magic;		/* big endian */
55 #define GOT_PACKIDX_V2_MAGIC 0xff744f63	/* "\377t0c" */
56 	uint32_t	*version;
57 
58 	/* 
59 	 * Each entry N in the fanout table contains the number of objects in
60 	 * the packfile whose SHA1 begins with a byte less than or equal to N.
61 	 * The last entry (index 255) contains the number of objects in the
62 	 * pack file whose first SHA1 byte is <= 0xff, and thus records the
63 	 * total number of objects in the pack file. All pointer variables
64 	 * below point to tables with a corresponding number of entries.
65 	 */
66 	uint32_t	*fanout_table;	/* values are big endian */
67 #define GOT_PACKIDX_V2_FANOUT_TABLE_ITEMS (0xff + 1)
68 
69 	/* Sorted SHA1 checksums for each object in the pack file. */
70 	struct got_packidx_object_id *sorted_ids;
71 
72 	/* CRC32 of the packed representation of each object. */
73 	uint32_t	*crc32;
74 
75 	/* Offset into the pack file for each object. */
76 	uint32_t	*offsets;		/* values are big endian */
77 #define GOT_PACKIDX_OFFSET_VAL_MASK		0x7fffffff
78 #define GOT_PACKIDX_OFFSET_VAL_IS_LARGE_IDX	0x80000000
79 
80 	/* Large offsets table is empty for pack files < 2 GB. */
81 	uint64_t	*large_offsets;		/* values are big endian */
82 
83 	struct got_packidx_trailer *trailer;
84 };
85 
86 /* An open pack index file. */
87 struct got_packidx {
88 	char *path_packidx; /* actual on-disk path */
89 	int fd;
90 	uint8_t *map;
91 	size_t len;
92 	size_t nlargeobj;
93 	struct got_packidx_v2_hdr hdr; /* convenient pointers into map */
94 };
95 
96 struct got_packfile_hdr {
97 	uint32_t	signature;
98 #define GOT_PACKFILE_SIGNATURE	0x5041434b	/* 'P' 'A' 'C' 'K' */
99 	uint32_t	version;	/* big endian */
100 #define GOT_PACKFILE_VERSION 2
101 	uint32_t	nobjects;	/* big endian */
102 };
103 
104 struct got_packfile_obj_hdr {
105 	/* 
106 	 * The object size field uses a variable length encoding:
107 	 * size0...sizeN form a 4+7+7+...+7 bit integer, where size0 is the
108 	 * least significant part and sizeN is the most significant part.
109 	 * If the MSB of a size byte is set, an additional size byte follows.
110 	 * Of the 7 remaining bits of size0, the first 3 bits indicate the
111 	 * object's type, and the remaining 4 bits contribute to the size.
112 	 */
113 	uint8_t *size;		/* variable length */
114 #define GOT_PACK_OBJ_SIZE_MORE		0x80
115 #define GOT_PACK_OBJ_SIZE0_TYPE_MASK	0x70 /* See struct got_object->type */
116 #define GOT_PACK_OBJ_SIZE0_TYPE_MASK_SHIFT	4
117 #define GOT_PACK_OBJ_SIZE0_VAL_MASK	0x0f
118 #define GOT_PACK_OBJ_SIZE_VAL_MASK	0x7f
119 };
120 
121 /* If object is not a DELTA type. */
122 struct got_packfile_object_data {
123 	uint8_t *data;	/* compressed */
124 };
125 
126 /* If object is of type	GOT_OBJ_TYPE_REF_DELTA. */
127 struct got_packfile_object_data_ref_delta {
128 	uint8_t sha1[SHA1_DIGEST_LENGTH];
129 	uint8_t *delta_data;		/* compressed */
130 };
131 
132 /* If object is of type GOT_OBJ_TYPE_OFFSET_DELTA. */
133 struct got_packfile_object_data_offset_delta {
134 	/* 
135 	 * This offset is interpreted as a negative offset from
136 	 * the got_packfile_obj_hdr corresponding to this object.
137 	 * The size provided in the header specifies the amount
138 	 * of compressed delta data that follows.
139 	 *
140 	 * This field uses a variable length encoding of N bytes,
141 	 * where the MSB is always set except for the last byte.
142 	 * The value is encoded as a series of N 7 bit integers,
143 	 * which are concatenated, and if N > 1 the value 2^7 +
144 	 * 2^14 + ... + 2^(7 * (n-1)) is added to the result.
145 	 */
146 	uint8_t *offset;	/* variable length */
147 #define GOT_PACK_OBJ_DELTA_OFF_MORE		0x80
148 #define GOT_PACK_OBJ_DELTA_OFF_VAL_MASK		0x7f
149 	uint8_t *delta_data;		/* compressed */
150 };
151 
152 struct got_packfile_obj_data {
153 	union {
154 		struct got_packfile_object_data data;
155 		struct got_packfile_object_data_ref_delta ref_delta;
156 		struct got_packfile_object_data_offset_delta offset_delta;
157 	} __attribute__((__packed__));
158 } __attribute__((__packed__));
159 
160 const struct got_error *got_packidx_init_hdr(struct got_packidx *, int);
161 const struct got_error *got_packidx_open(struct got_packidx **,
162     const char *, int);
163 const struct got_error *got_packidx_close(struct got_packidx *);
164 int got_packidx_get_object_idx(struct got_packidx *, struct got_object_id *);
165 const struct got_error *got_packidx_match_id_str_prefix(
166     struct got_object_id_queue *, struct got_packidx *, const char *);
167 
168 const struct got_error *got_packfile_open_object(struct got_object **,
169     struct got_pack *, struct got_packidx *, int, struct got_object_id *);
170 const struct got_error *got_pack_get_max_delta_object_size(uint64_t *,
171     struct got_object *);
172 const struct got_error *got_packfile_extract_object(struct got_pack *,
173     struct got_object *, FILE *, FILE *, FILE *);
174 const struct got_error *got_packfile_extract_object_to_mem(uint8_t **, size_t *,
175     struct got_object *, struct got_pack *);
176 struct got_pack *got_repo_get_cached_pack(struct got_repository *, const char *);