1 /*
2  * Copyright (c) 2020 Ori Bernstein
3  * Copyright (c) 2021 Stefan Sperling <stsp@openbsd.org>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #include <sys/types.h>
19 #include <sys/queue.h>
20 
21 #include <assert.h>
22 #include <endian.h>
23 #include <errno.h>
24 #include <limits.h>
25 #include <stdint.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sha1.h>
30 
31 #include "got_error.h"
32 
33 #include "got_lib_deltify.h"
34 
35 #ifndef MIN
36 #define	MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
37 #endif
38 
39 static uint32_t geartab[] = {
40     0x67ed26b7, 0x32da500c, 0x53d0fee0, 0xce387dc7, 0xcd406d90, 0x2e83a4d4,
41     0x9fc9a38d, 0xb67259dc, 0xca6b1722, 0x6d2ea08c, 0x235cea2e, 0x3149bb5f,
42     0x1beda787, 0x2a6b77d5, 0x2f22d9ac, 0x91fc0544, 0xe413acfa, 0x5a30ff7a,
43     0xad6fdde0, 0x444fd0f5, 0x7ad87864, 0x58c5ff05, 0x8d2ec336, 0x2371f853,
44     0x550f8572, 0x6aa448dd, 0x7c9ddbcf, 0x95221e14, 0x2a82ec33, 0xcbec5a78,
45     0xc6795a0d, 0x243995b7, 0x1c909a2f, 0x4fded51c, 0x635d334b, 0x0e2b9999,
46     0x2702968d, 0x856de1d5, 0x3325d60e, 0xeb6a7502, 0xec2a9844, 0x0905835a,
47     0xa1820375, 0xa4be5cab, 0x96a6c058, 0x2c2ccd70, 0xba40fce3, 0xd794c46b,
48     0x8fbae83e, 0xc3aa7899, 0x3d3ff8ed, 0xa0d42b5b, 0x571c0c97, 0xd2811516,
49     0xf7e7b96c, 0x4fd2fcbd, 0xe2fdec94, 0x282cc436, 0x78e8e95c, 0x80a3b613,
50     0xcfbee20c, 0xd4a32d1c, 0x2a12ff13, 0x6af82936, 0xe5630258, 0x8efa6a98,
51     0x294fb2d1, 0xdeb57086, 0x5f0fddb3, 0xeceda7ce, 0x4c87305f, 0x3a6d3307,
52     0xe22d2942, 0x9d060217, 0x1e42ed02, 0xb6f63b52, 0x4367f39f, 0x055cf262,
53     0x03a461b2, 0x5ef9e382, 0x386bc03a, 0x2a1e79c7, 0xf1a0058b, 0xd4d2dea9,
54     0x56baf37d, 0x5daff6cc, 0xf03a951d, 0xaef7de45, 0xa8f4581e, 0x3960b555,
55     0xffbfff6d, 0xbe702a23, 0x8f5b6d6f, 0x061739fb, 0x98696f47, 0x3fd596d4,
56     0x151eac6b, 0xa9fcc4f5, 0x69181a12, 0x3ac5a107, 0xb5198fe7, 0x96bcb1da,
57     0x1b5ddf8e, 0xc757d650, 0x65865c3a, 0x8fc0a41a, 0x87435536, 0x99eda6f2,
58     0x41874794, 0x29cff4e8, 0xb70efd9a, 0x3103f6e7, 0x84d2453b, 0x15a450bd,
59     0x74f49af1, 0x60f664b1, 0xa1c86935, 0xfdafbce1, 0xe36353e3, 0x5d9ba739,
60     0xbc0559ba, 0x708b0054, 0xd41d808c, 0xb2f31723, 0x9027c41f, 0xf136d165,
61     0xb5374b12, 0x9420a6ac, 0x273958b6, 0xe6c2fad0, 0xebdc1f21, 0xfb33af8b,
62     0xc71c25cd, 0xe9a2d8e5, 0xbeb38a50, 0xbceb7cc2, 0x4e4e73f0, 0xcd6c251d,
63     0xde4c032c, 0x4b04ac30, 0x725b8b21, 0x4eb8c33b, 0x20d07b75, 0x0567aa63,
64     0xb56b2bb7, 0xc1f5fd3a, 0xcafd35ca, 0x470dd4da, 0xfe4f94cd, 0xfb8de424,
65     0xe8dbcf40, 0xfe50a37a, 0x62db5b5d, 0xf32f4ab6, 0x2c4a8a51, 0x18473dc0,
66     0xfe0cbb6e, 0xfe399efd, 0xdf34ecc9, 0x6ccd5055, 0x46097073, 0x139135c2,
67     0x721c76f6, 0x1c6a94b4, 0x6eee014d, 0x8a508e02, 0x3da538f5, 0x280d394f,
68     0x5248a0c4, 0x3ce94c6c, 0x9a71ad3a, 0x8493dd05, 0xe43f0ab6, 0x18e4ed42,
69     0x6c5c0e09, 0x42b06ec9, 0x8d330343, 0xa45b6f59, 0x2a573c0c, 0xd7fd3de6,
70     0xeedeab68, 0x5c84dafc, 0xbbd1b1a8, 0xa3ce1ad1, 0x85b70bed, 0xb6add07f,
71     0xa531309c, 0x8f8ab852, 0x564de332, 0xeac9ed0c, 0x73da402c, 0x3ec52761,
72     0x43af2f4d, 0xd6ff45c8, 0x4c367462, 0xd553bd6a, 0x44724855, 0x3b2aa728,
73     0x56e5eb65, 0xeaf16173, 0x33fa42ff, 0xd714bb5d, 0xfbd0a3b9, 0xaf517134,
74     0x9416c8cd, 0x534cf94f, 0x548947c2, 0x34193569, 0x32f4389a, 0xfe7028bc,
75     0xed73b1ed, 0x9db95770, 0x468e3922, 0x0440c3cd, 0x60059a62, 0x33504562,
76     0x2b229fbd, 0x5174dca5, 0xf7028752, 0xd63c6aa8, 0x31276f38, 0x0646721c,
77     0xb0191da8, 0xe00e6de0, 0x9eac1a6e, 0x9f7628a5, 0xed6c06ea, 0x0bb8af15,
78     0xf119fb12, 0x38693c1c, 0x732bc0fe, 0x84953275, 0xb82ec888, 0x33a4f1b3,
79     0x3099835e, 0x028a8782, 0x5fdd51d7, 0xc6c717b3, 0xb06caf71, 0x17c8c111,
80     0x61bad754, 0x9fd03061, 0xe09df1af, 0x3bc9eb73, 0x85878413, 0x9889aaf2,
81     0x3f5a9e46, 0x42c9f01f, 0x9984a4f4, 0xd5de43cc, 0xd294daed, 0xbecba2d2,
82     0xf1f6e72c, 0x5551128a, 0x83af87e2, 0x6f0342ba,
83 };
84 
85 static uint64_t
86 hashblk(const unsigned char *p, off_t n)
87 {
88 	unsigned char buf[SHA1_DIGEST_LENGTH];
89 	uint64_t h;
90 	SHA1_CTX ctx;
91 	SHA1Init(&ctx);
92 	SHA1Update(&ctx, p, n);
93 	SHA1Final(buf, &ctx);
94 	memcpy(&h, buf, sizeof(h));
95 	return be64toh(h);
96 }
97 
98 static const struct got_error *
99 addblk(struct got_delta_table *dt, FILE *f, off_t file_offset0, off_t len,
100     off_t offset, uint64_t h)
101 {
102 	const struct got_error *err = NULL;
103 	int i;
104 	uint8_t buf[GOT_DELTIFY_MAXCHUNK];
105 	uint8_t buf2[GOT_DELTIFY_MAXCHUNK];
106 	size_t r = 0;
107 
108 	if (len == 0)
109 		return NULL;
110 
111 	i = h % dt->nalloc;
112 	while (dt->blocks[i].len != 0) {
113 		/*
114 		 * Avoid adding duplicate blocks.
115 		 * NB: A matching hash is insufficient for detecting equality.
116 		 * The hash can only detect inequality.
117 		 */
118 		if (len == dt->blocks[i].len && h == dt->blocks[i].hash) {
119 			if (r == 0) {
120 				if (fseeko(f, file_offset0 + offset, SEEK_SET) == -1)
121 					return got_error_from_errno("fseeko");
122 				r = fread(buf, 1, len, f);
123 				if (r != len) {
124 					if (!ferror(f))
125 						return NULL;
126 					return got_ferror(f, GOT_ERR_IO);
127 				}
128 			}
129 			if (fseeko(f, file_offset0 + dt->blocks[i].offset,
130 			    SEEK_SET) == -1)
131 				return got_error_from_errno("fseeko");
132 			if (fread(buf2, 1, len, f) != len)
133 				return got_ferror(f, GOT_ERR_IO);
134 			if (memcmp(buf, buf2, len) == 0)
135 				return NULL;
136 		}
137 
138 		i = (i + 1) % dt->nalloc;
139 	}
140 	assert(dt->blocks[i].len == 0);
141 	dt->blocks[i].len = len;
142 	dt->blocks[i].offset = offset;
143 	dt->blocks[i].hash = h;
144 	dt->nblocks++;
145 	if (dt->nalloc < dt->nblocks + 64) {
146 		struct got_delta_block *db;
147 		size_t old_size = dt->nalloc;
148 		db = dt->blocks;
149 		dt->blocks = calloc(dt->nalloc + 64,
150 		    sizeof(struct got_delta_block));
151 		if (dt->blocks == NULL) {
152 			err = got_error_from_errno("calloc");
153 			dt->blocks = db;
154 			return err;
155 		}
156 		dt->nalloc += 64;
157 		/*
158 		 * Recompute all block positions. Hash-based indices of blocks
159 		 * in the array depend on the allocated length of the array.
160 		 */
161 		dt->nblocks = 0;
162 		for (i = 0; i < old_size; i++) {
163 			if (db[i].len == 0)
164 				continue;
165 			err = addblk(dt, f, file_offset0, db[i].len,
166 			    db[i].offset, db[i].hash);
167 			if (err)
168 				break;
169 		}
170 		free(db);
171 	}
172 
173 	return err;
174 }
175 
176 static const struct got_error *
177 lookupblk(struct got_delta_block **block, struct got_delta_table *dt,
178     unsigned char *p, off_t len, FILE *basefile, off_t basefile_offset0)
179 {
180 	int i;
181 	uint64_t h;
182 	uint8_t buf[GOT_DELTIFY_MAXCHUNK];
183 	size_t r;
184 
185 	*block = NULL;
186 
187 	h = hashblk(p, len);
188 	for (i = h % dt->nalloc; dt->blocks[i].len != 0;
189 	     i = (i + 1) % dt->nalloc) {
190 		if (dt->blocks[i].hash != h ||
191 		    dt->blocks[i].len != len)
192 			continue;
193 		if (fseeko(basefile, basefile_offset0 + dt->blocks[i].offset,
194 		    SEEK_SET) == -1)
195 			return got_error_from_errno("fseeko");
196 		r = fread(buf, 1, len, basefile);
197 		if (r != len)
198 			return got_ferror(basefile, GOT_ERR_IO);
199 		if (memcmp(p, buf, len) == 0) {
200 			*block = &dt->blocks[i];
201 			break;
202 		}
203 	}
204 	return NULL;
205 }
206 
207 static const struct got_error *
208 nextblk(uint8_t *buf, off_t *blocklen, FILE *f)
209 {
210 	uint32_t gh;
211 	const unsigned char *p;
212 	size_t r;
213 	off_t pos = ftello(f);
214 
215 	*blocklen = 0;
216 
217 	r = fread(buf, 1, GOT_DELTIFY_MAXCHUNK, f);
218 	if (r == 0 && ferror(f))
219 		return got_ferror(f, GOT_ERR_IO);
220 	if (r < GOT_DELTIFY_MINCHUNK)
221 		return NULL; /* no more delta-worthy blocks left */
222 
223 	/* Got a deltifiable block. Find the split-point where it ends. */
224 	p = buf + GOT_DELTIFY_MINCHUNK;
225 	gh = 0;
226 	while (p != buf + r) {
227 		gh = (gh << 1) + geartab[*p++];
228 		if ((gh & GOT_DELTIFY_SPLITMASK) == 0)
229 			break;
230 	}
231 
232 	*blocklen = (p - buf);
233 	if (fseeko(f, pos + *blocklen, SEEK_SET) == -1)
234 		return got_error_from_errno("fseeko");
235 
236 	return NULL;
237 }
238 
239 const struct got_error *
240 got_deltify_init(struct got_delta_table **dt, FILE *f, off_t fileoffset,
241     off_t filesize)
242 {
243 	const struct got_error *err = NULL;
244 	uint64_t h;
245 	const off_t offset0 = fileoffset;
246 
247 	*dt = calloc(1, sizeof(**dt));
248 	if (*dt == NULL)
249 		return got_error_from_errno("calloc");
250 
251 	(*dt)->nblocks = 0;
252 	(*dt)->nalloc = 128;
253 	(*dt)->blocks = calloc((*dt)->nalloc, sizeof(struct got_delta_block));
254 	if ((*dt)->blocks == NULL) {
255 		err = got_error_from_errno("calloc");
256 		goto done;
257 	}
258 
259 	if (fseeko(f, fileoffset, SEEK_SET) == -1)
260 		return got_error_from_errno("fseeko");
261 
262 	while (fileoffset < filesize) {
263 		uint8_t buf[GOT_DELTIFY_MAXCHUNK];
264 		off_t blocklen;
265 		err = nextblk(buf, &blocklen, f);
266 		if (err)
267 			goto done;
268 		if (blocklen == 0)
269 			break;
270 		h = hashblk(buf, blocklen);
271 		err = addblk(*dt, f, offset0, blocklen,
272 		    fileoffset - offset0, h);
273 		if (err)
274 			goto done;
275 		fileoffset += blocklen;
276 		if (fseeko(f, fileoffset, SEEK_SET) == -1)
277 			return got_error_from_errno("fseeko");
278 	}
279 done:
280 	if (err) {
281 		free((*dt)->blocks);
282 		free(*dt);
283 		*dt = NULL;
284 	}
285 
286 	return err;
287 }
288 
289 void
290 got_deltify_free(struct got_delta_table *dt)
291 {
292 	if (dt == NULL)
293 		return;
294 	free(dt->blocks);
295 	free(dt);
296 }
297 
298 static const struct got_error *
299 emitdelta(struct got_delta_instruction **deltas, size_t *nalloc, int *ndeltas,
300     const size_t alloc_chunk_size, int copy, off_t offset, off_t len)
301 {
302 	struct got_delta_instruction *d, *p;
303 
304 	if (*nalloc < *ndeltas + alloc_chunk_size) {
305 		p = reallocarray(*deltas, *nalloc + alloc_chunk_size,
306 		    sizeof(struct got_delta_instruction));
307 		if (p == NULL)
308 			return got_error_from_errno("realloc");
309 		*deltas = p;
310 		*nalloc += alloc_chunk_size;
311 	}
312 	*ndeltas += 1;
313 	d = &(*deltas)[*ndeltas - 1];
314 	d->copy = copy;
315 	d->offset = offset;
316 	d->len = len;
317 	return NULL;
318 }
319 
320 static const struct got_error *
321 stretchblk(FILE *basefile, off_t base_offset0, struct got_delta_block *block,
322     FILE *f, off_t filesize, off_t *blocklen)
323 {
324 	uint8_t basebuf[GOT_DELTIFY_MAXCHUNK], buf[GOT_DELTIFY_MAXCHUNK];
325 	size_t base_r, r, i;
326 	int buf_equal = 1;
327 
328 	if (fseeko(basefile, base_offset0 + block->offset + *blocklen,
329 	    SEEK_SET) == -1)
330 		return got_error_from_errno("fseeko");
331 
332 	while (buf_equal && *blocklen < (1 << 24) - 1) {
333 		base_r = fread(basebuf, 1, sizeof(basebuf), basefile);
334 		if (base_r == 0) {
335 			if (ferror(basefile))
336 				return got_ferror(basefile, GOT_ERR_IO);
337 			break;
338 		}
339 		r = fread(buf, 1, sizeof(buf), f);
340 		if (r == 0) {
341 			if (ferror(f))
342 				return got_ferror(f, GOT_ERR_IO);
343 			break;
344 		}
345 		for (i = 0; i < MIN(base_r, r); i++) {
346 			if (buf[i] != basebuf[i]) {
347 				buf_equal = 0;
348 				break;
349 			}
350 			(*blocklen)++;
351 		}
352 	}
353 
354 	return NULL;
355 }
356 
357 const struct got_error *
358 got_deltify(struct got_delta_instruction **deltas, int *ndeltas,
359     FILE *f, off_t fileoffset, off_t filesize,
360     struct got_delta_table *dt, FILE *basefile,
361     off_t basefile_offset0, off_t basefile_size)
362 {
363 	const struct got_error *err = NULL;
364 	const off_t offset0 = fileoffset;
365 	size_t nalloc = 0;
366 	const size_t alloc_chunk_size = 64;
367 
368 	*deltas = NULL;
369 	*ndeltas = 0;
370 
371 	/*
372 	 * offset0 indicates where data to be deltified begins.
373 	 * For example, we want to avoid deltifying a Git object header at
374 	 * the beginning of the file.
375 	 */
376 	if (fseeko(f, offset0, SEEK_SET) == -1)
377 		return got_error_from_errno("fseeko");
378 
379 	*deltas = reallocarray(NULL, alloc_chunk_size,
380 	    sizeof(struct got_delta_instruction));
381 	if (*deltas == NULL)
382 		return got_error_from_errno("reallocarray");
383 	nalloc = alloc_chunk_size;
384 
385 	while (fileoffset < filesize) {
386 		uint8_t buf[GOT_DELTIFY_MAXCHUNK];
387 		off_t blocklen;
388 		struct got_delta_block *block;
389 		err = nextblk(buf, &blocklen, f);
390 		if (err)
391 			break;
392 		if (blocklen == 0) {
393 			/* Source remainder from the file itself. */
394 			if (fileoffset < filesize) {
395 				err = emitdelta(deltas, &nalloc, ndeltas,
396 				    alloc_chunk_size, 0, fileoffset - offset0,
397 				    filesize - fileoffset);
398 			}
399 			break;
400 		}
401 		err = lookupblk(&block, dt, buf, blocklen, basefile,
402 		    basefile_offset0);
403 		if (err)
404 			break;
405 		if (block != NULL) {
406 			/*
407 			 * We have found a matching block in the delta base.
408 			 * Attempt to stretch the block as far as possible and
409 			 * generate a copy instruction.
410 			 */
411 			err = stretchblk(basefile, basefile_offset0, block,
412 			    f, filesize, &blocklen);
413 			if (err)
414 				break;
415 			err = emitdelta(deltas, &nalloc, ndeltas,
416 			    alloc_chunk_size, 1, block->offset, blocklen);
417 			if (err)
418 				break;
419 		} else {
420 			/*
421 			 * No match.
422 			 * This block needs to be sourced from the file itself.
423 			 */
424 			err = emitdelta(deltas, &nalloc, ndeltas,
425 			    alloc_chunk_size, 0, fileoffset - offset0, blocklen);
426 			if (err)
427 				break;
428 		}
429 		fileoffset += blocklen;
430 		if (fseeko(f, fileoffset, SEEK_SET) == -1) {
431 			err = got_error_from_errno("fseeko");
432 			break;
433 		}
434 	}
435 
436 	if (err) {
437 		free(*deltas);
438 		*deltas = NULL;
439 		*ndeltas = 0;
440 	}
441 	return err;
442 }