2 efd2a263 2018-01-19 stsp * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 efd2a263 2018-01-19 stsp * Permission to use, copy, modify, and distribute this software for any
5 efd2a263 2018-01-19 stsp * purpose with or without fee is hereby granted, provided that the above
6 efd2a263 2018-01-19 stsp * copyright notice and this permission notice appear in all copies.
8 efd2a263 2018-01-19 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 efd2a263 2018-01-19 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 efd2a263 2018-01-19 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 efd2a263 2018-01-19 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 efd2a263 2018-01-19 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 efd2a263 2018-01-19 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 efd2a263 2018-01-19 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 efd2a263 2018-01-19 stsp #include <sys/queue.h>
19 efd2a263 2018-01-19 stsp #include <stdio.h>
20 96f5e8b3 2018-01-23 stsp #include <stdlib.h>
21 96f5e8b3 2018-01-23 stsp #include <string.h>
22 efd2a263 2018-01-19 stsp #include <zlib.h>
23 efd2a263 2018-01-19 stsp #include <sha1.h>
25 efd2a263 2018-01-19 stsp #include "got_error.h"
26 efd2a263 2018-01-19 stsp #include "got_repository.h"
27 efd2a263 2018-01-19 stsp #include "got_object.h"
29 32cb896c 2018-03-11 stsp #include "got_delta_lib.h"
30 32cb896c 2018-03-11 stsp #include "got_path_lib.h"
31 32cb896c 2018-03-11 stsp #include "got_zbuf_lib.h"
34 885d3e02 2018-01-27 stsp #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
37 c3703302 2018-01-23 stsp struct got_delta *
38 0e22967e 2018-02-11 stsp got_delta_open(const char *path_packfile, off_t offset, size_t tslen,
39 bdd2fbb3 2018-02-11 stsp int type, size_t size, off_t data_offset)
41 c3703302 2018-01-23 stsp struct got_delta *delta;
43 c3703302 2018-01-23 stsp delta = calloc(1, sizeof(*delta));
44 c3703302 2018-01-23 stsp if (delta == NULL)
45 96f5e8b3 2018-01-23 stsp return NULL;
47 c3703302 2018-01-23 stsp delta->path_packfile = strdup(path_packfile);
48 c3703302 2018-01-23 stsp if (delta->path_packfile == NULL) {
49 c3703302 2018-01-23 stsp free(delta);
50 96f5e8b3 2018-01-23 stsp return NULL;
52 c3703302 2018-01-23 stsp delta->type = type;
53 c3703302 2018-01-23 stsp delta->offset = offset;
54 0e22967e 2018-02-11 stsp delta->tslen = tslen;
55 c3703302 2018-01-23 stsp delta->size = size;
56 bdd2fbb3 2018-02-11 stsp delta->data_offset = data_offset;
57 c3703302 2018-01-23 stsp return delta;
61 c3703302 2018-01-23 stsp got_delta_close(struct got_delta *delta)
63 c3703302 2018-01-23 stsp free(delta->path_packfile);
64 c3703302 2018-01-23 stsp free(delta);
68 efd2a263 2018-01-19 stsp const struct got_error *
69 96f5e8b3 2018-01-23 stsp got_delta_chain_get_base_type(int *type, struct got_delta_chain *deltas)
71 c3703302 2018-01-23 stsp struct got_delta *delta;
73 6691714a 2018-01-23 stsp /* The first delta in the chain should represent the base object. */
74 6691714a 2018-01-23 stsp delta = SIMPLEQ_FIRST(&deltas->entries);
75 6691714a 2018-01-23 stsp if (delta->type == GOT_OBJ_TYPE_COMMIT ||
76 6691714a 2018-01-23 stsp delta->type == GOT_OBJ_TYPE_TREE ||
77 6691714a 2018-01-23 stsp delta->type == GOT_OBJ_TYPE_BLOB ||
78 6691714a 2018-01-23 stsp delta->type == GOT_OBJ_TYPE_TAG) {
79 6691714a 2018-01-23 stsp *type = delta->type;
80 6691714a 2018-01-23 stsp return NULL;
83 96f5e8b3 2018-01-23 stsp return got_error(GOT_ERR_BAD_DELTA_CHAIN);
86 885d3e02 2018-01-27 stsp /* Fetch another (required) byte from the delta stream. */
87 885d3e02 2018-01-27 stsp static const struct got_error *
88 885d3e02 2018-01-27 stsp next_delta_byte(const uint8_t **p, size_t *remain)
90 885d3e02 2018-01-27 stsp if (--(*remain) == 0)
91 885d3e02 2018-01-27 stsp return got_error(GOT_ERR_BAD_DELTA);
93 885d3e02 2018-01-27 stsp return NULL;
96 885d3e02 2018-01-27 stsp static const struct got_error *
97 885d3e02 2018-01-27 stsp parse_size(uint64_t *size, const uint8_t **p, size_t *remain)
99 885d3e02 2018-01-27 stsp const struct got_error *err = NULL;
104 885d3e02 2018-01-27 stsp /* We do not support size values which don't fit in 64 bit. */
106 885d3e02 2018-01-27 stsp return got_error(GOT_ERR_NO_SPACE);
108 885d3e02 2018-01-27 stsp if (i == 0)
109 885d3e02 2018-01-27 stsp *size = ((**p) & GOT_DELTA_SIZE_VAL_MASK);
111 885d3e02 2018-01-27 stsp size_t shift = GOT_DELTA_SIZE_SHIFT * i;
112 885d3e02 2018-01-27 stsp *size |= (((**p) & GOT_DELTA_SIZE_VAL_MASK) << shift);
115 885d3e02 2018-01-27 stsp if (((**p) & GOT_DELTA_SIZE_MORE) == 0)
118 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
119 885d3e02 2018-01-27 stsp } while (err == NULL);
121 885d3e02 2018-01-27 stsp return err;
124 885d3e02 2018-01-27 stsp static const struct got_error *
125 885d3e02 2018-01-27 stsp parse_opcode(off_t *offset, size_t *len, const uint8_t **p, size_t *remain)
127 885d3e02 2018-01-27 stsp const struct got_error *err = NULL;
128 885d3e02 2018-01-27 stsp off_t o = 0;
129 885d3e02 2018-01-27 stsp size_t l = 0;
130 885d3e02 2018-01-27 stsp uint8_t opcode = **p;
132 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_OFF1) {
133 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
135 885d3e02 2018-01-27 stsp return err;
136 885d3e02 2018-01-27 stsp o = (off_t)(**p);
138 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_OFF2) {
139 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
141 885d3e02 2018-01-27 stsp return err;
142 885d3e02 2018-01-27 stsp o |= ((off_t)(**p)) << 8;
144 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_OFF3) {
145 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
147 885d3e02 2018-01-27 stsp return err;
148 885d3e02 2018-01-27 stsp o |= ((off_t)(**p)) << 16;
150 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_OFF4) {
151 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
153 885d3e02 2018-01-27 stsp return err;
154 885d3e02 2018-01-27 stsp o |= ((off_t)(**p)) << 24;
157 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_LEN1) {
158 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
160 885d3e02 2018-01-27 stsp return err;
161 885d3e02 2018-01-27 stsp l = (off_t)(**p);
163 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_LEN2) {
164 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
166 885d3e02 2018-01-27 stsp return err;
167 885d3e02 2018-01-27 stsp l |= ((off_t)(**p)) << 8;
169 885d3e02 2018-01-27 stsp if (opcode & GOT_DELTA_COPY_LEN3) {
170 885d3e02 2018-01-27 stsp err = next_delta_byte(p, remain);
172 885d3e02 2018-01-27 stsp return err;
173 885d3e02 2018-01-27 stsp l |= ((off_t)(**p)) << 16;
176 885d3e02 2018-01-27 stsp if (o == 0)
177 885d3e02 2018-01-27 stsp o = GOT_DELTA_COPY_DEFAULT_OFF;
178 885d3e02 2018-01-27 stsp if (l == 0)
179 885d3e02 2018-01-27 stsp l = GOT_DELTA_COPY_DEFAULT_LEN;
181 885d3e02 2018-01-27 stsp *offset = o;
183 885d3e02 2018-01-27 stsp return NULL;
186 885d3e02 2018-01-27 stsp static const struct got_error *
187 885d3e02 2018-01-27 stsp copy_from_base(FILE *base_file, off_t offset, size_t size, FILE *outfile)
189 885d3e02 2018-01-27 stsp if (fseeko(base_file, offset, SEEK_SET) != 0)
190 885d3e02 2018-01-27 stsp return got_error_from_errno();
192 885d3e02 2018-01-27 stsp while (size > 0) {
193 885d3e02 2018-01-27 stsp uint8_t data[2048];
194 885d3e02 2018-01-27 stsp size_t len = MIN(size, sizeof(data));
197 885d3e02 2018-01-27 stsp n = fread(data, len, 1, base_file);
198 885d3e02 2018-01-27 stsp if (n != 1)
199 885d3e02 2018-01-27 stsp return got_ferror(base_file, GOT_ERR_IO);
201 885d3e02 2018-01-27 stsp n = fwrite(data, len, 1, outfile);
202 885d3e02 2018-01-27 stsp if (n != 1)
203 885d3e02 2018-01-27 stsp return got_ferror(outfile, GOT_ERR_IO);
205 885d3e02 2018-01-27 stsp size -= len;
208 885d3e02 2018-01-27 stsp return NULL;
211 885d3e02 2018-01-27 stsp static const struct got_error *
212 885d3e02 2018-01-27 stsp copy_from_delta(const uint8_t **p, size_t *remain, size_t len, FILE *outfile)
216 885d3e02 2018-01-27 stsp if (*remain < len)
217 885d3e02 2018-01-27 stsp return got_error(GOT_ERR_BAD_DELTA);
219 885d3e02 2018-01-27 stsp n = fwrite(*p, len, 1, outfile);
220 885d3e02 2018-01-27 stsp if (n != 1)
221 885d3e02 2018-01-27 stsp return got_ferror(outfile, GOT_ERR_IO);
224 885d3e02 2018-01-27 stsp *remain -= len;
225 885d3e02 2018-01-27 stsp return NULL;
228 22484865 2018-03-13 stsp static const struct got_error *
229 22484865 2018-03-13 stsp parse_delta_sizes(uint64_t *base_size, uint64_t *result_size,
230 22484865 2018-03-13 stsp const uint8_t **p, size_t *remain)
232 22484865 2018-03-13 stsp const struct got_error *err;
234 22484865 2018-03-13 stsp /* Read the two size fields at the beginning of the stream. */
235 22484865 2018-03-13 stsp err = parse_size(base_size, p, remain);
237 22484865 2018-03-13 stsp return err;
238 22484865 2018-03-13 stsp err = next_delta_byte(p, remain);
240 22484865 2018-03-13 stsp return err;
241 22484865 2018-03-13 stsp err = parse_size(result_size, p, remain);
243 22484865 2018-03-13 stsp return err;
245 22484865 2018-03-13 stsp return NULL;
248 885d3e02 2018-01-27 stsp const struct got_error *
249 22484865 2018-03-13 stsp got_delta_get_sizes(uint64_t *base_size, uint64_t *result_size,
250 22484865 2018-03-13 stsp const uint8_t *delta_buf, size_t delta_len)
252 22484865 2018-03-13 stsp size_t remain;
253 22484865 2018-03-13 stsp const uint8_t *p;
255 22484865 2018-03-13 stsp if (delta_len < GOT_DELTA_STREAM_LENGTH_MIN)
256 22484865 2018-03-13 stsp return got_error(GOT_ERR_BAD_DELTA);
258 22484865 2018-03-13 stsp p = delta_buf;
259 22484865 2018-03-13 stsp remain = delta_len;
260 22484865 2018-03-13 stsp return parse_delta_sizes(base_size, result_size, &p, &remain);
263 8628c62d 2018-03-15 stsp const struct got_error *
264 8628c62d 2018-03-15 stsp got_delta_apply_in_mem(uint8_t *base_buf, const uint8_t *delta_buf,
265 8628c62d 2018-03-15 stsp size_t delta_len, uint8_t *outbuf, size_t *outsize)
267 8628c62d 2018-03-15 stsp const struct got_error *err = NULL;
268 8628c62d 2018-03-15 stsp uint64_t base_size, result_size;
269 8628c62d 2018-03-15 stsp size_t remain;
270 8628c62d 2018-03-15 stsp const uint8_t *p;
272 8628c62d 2018-03-15 stsp *outsize= 0;
274 8628c62d 2018-03-15 stsp if (delta_len < GOT_DELTA_STREAM_LENGTH_MIN)
275 8628c62d 2018-03-15 stsp return got_error(GOT_ERR_BAD_DELTA);
277 8628c62d 2018-03-15 stsp p = delta_buf;
278 8628c62d 2018-03-15 stsp remain = delta_len;
279 8628c62d 2018-03-15 stsp err = parse_delta_sizes(&base_size, &result_size, &p, &remain);
281 8628c62d 2018-03-15 stsp return err;
283 8628c62d 2018-03-15 stsp /* Decode and execute copy instructions from the delta stream. */
284 8628c62d 2018-03-15 stsp err = next_delta_byte(&p, &remain);
285 8628c62d 2018-03-15 stsp while (err == NULL && remain > 0) {
286 8628c62d 2018-03-15 stsp if (*p & GOT_DELTA_BASE_COPY) {
287 8628c62d 2018-03-15 stsp off_t offset = 0;
288 8628c62d 2018-03-15 stsp size_t len = 0;
289 8628c62d 2018-03-15 stsp err = parse_opcode(&offset, &len, &p, &remain);
292 8628c62d 2018-03-15 stsp memcpy(outbuf + *outsize, base_buf + offset, len);
293 8628c62d 2018-03-15 stsp if (err == NULL) {
294 8628c62d 2018-03-15 stsp *outsize += len;
295 8628c62d 2018-03-15 stsp if (remain > 0) {
301 8628c62d 2018-03-15 stsp size_t len = (size_t)*p;
302 8628c62d 2018-03-15 stsp if (len == 0) {
303 8628c62d 2018-03-15 stsp err = got_error(GOT_ERR_BAD_DELTA);
306 8628c62d 2018-03-15 stsp err = next_delta_byte(&p, &remain);
309 8628c62d 2018-03-15 stsp if (remain < len)
310 8628c62d 2018-03-15 stsp return got_error(GOT_ERR_BAD_DELTA);
311 8628c62d 2018-03-15 stsp memcpy(outbuf + *outsize, p, len);
313 8628c62d 2018-03-15 stsp remain -= len;
314 8628c62d 2018-03-15 stsp *outsize += len;
318 8628c62d 2018-03-15 stsp if (*outsize != result_size)
319 8628c62d 2018-03-15 stsp err = got_error(GOT_ERR_BAD_DELTA);
320 8628c62d 2018-03-15 stsp return err;
323 22484865 2018-03-13 stsp const struct got_error *
324 0e22967e 2018-02-11 stsp got_delta_apply(FILE *base_file, const uint8_t *delta_buf,
325 885d3e02 2018-01-27 stsp size_t delta_len, FILE *outfile)
327 885d3e02 2018-01-27 stsp const struct got_error *err = NULL;
328 885d3e02 2018-01-27 stsp uint64_t base_size, result_size;
329 885d3e02 2018-01-27 stsp size_t remain, outsize = 0;
330 885d3e02 2018-01-27 stsp const uint8_t *p;
331 39ff877f 2018-03-13 stsp FILE *memstream = NULL;
332 39ff877f 2018-03-13 stsp char *memstream_buf = NULL;
333 39ff877f 2018-03-13 stsp size_t memstream_size = 0;
335 885d3e02 2018-01-27 stsp if (delta_len < GOT_DELTA_STREAM_LENGTH_MIN)
336 885d3e02 2018-01-27 stsp return got_error(GOT_ERR_BAD_DELTA);
338 885d3e02 2018-01-27 stsp p = delta_buf;
339 885d3e02 2018-01-27 stsp remain = delta_len;
340 22484865 2018-03-13 stsp err = parse_delta_sizes(&base_size, &result_size, &p, &remain);
342 885d3e02 2018-01-27 stsp return err;
344 39ff877f 2018-03-13 stsp if (result_size < GOT_DELTA_RESULT_SIZE_CACHED_MAX)
345 39ff877f 2018-03-13 stsp memstream = open_memstream(&memstream_buf, &memstream_size);
347 885d3e02 2018-01-27 stsp /* Decode and execute copy instructions from the delta stream. */
348 885d3e02 2018-01-27 stsp err = next_delta_byte(&p, &remain);
349 06e5fc98 2018-02-11 stsp while (err == NULL && remain > 0) {
350 824801e7 2018-01-27 stsp if (*p & GOT_DELTA_BASE_COPY) {
351 885d3e02 2018-01-27 stsp off_t offset = 0;
352 885d3e02 2018-01-27 stsp size_t len = 0;
353 885d3e02 2018-01-27 stsp err = parse_opcode(&offset, &len, &p, &remain);
356 39ff877f 2018-03-13 stsp err = copy_from_base(base_file, offset, len,
357 39ff877f 2018-03-13 stsp memstream ? memstream : outfile);
358 06e5fc98 2018-02-11 stsp if (err == NULL) {
359 885d3e02 2018-01-27 stsp outsize += len;
360 06e5fc98 2018-02-11 stsp if (remain > 0) {
366 885d3e02 2018-01-27 stsp size_t len = (size_t)*p;
367 885d3e02 2018-01-27 stsp if (len == 0) {
368 885d3e02 2018-01-27 stsp err = got_error(GOT_ERR_BAD_DELTA);
371 885d3e02 2018-01-27 stsp err = next_delta_byte(&p, &remain);
374 39ff877f 2018-03-13 stsp err = copy_from_delta(&p, &remain, len,
375 39ff877f 2018-03-13 stsp memstream ? memstream : outfile);
376 885d3e02 2018-01-27 stsp if (err == NULL)
377 885d3e02 2018-01-27 stsp outsize += len;
381 885d3e02 2018-01-27 stsp if (outsize != result_size)
382 885d3e02 2018-01-27 stsp err = got_error(GOT_ERR_BAD_DELTA);
384 39ff877f 2018-03-13 stsp if (memstream != NULL) {
385 39ff877f 2018-03-13 stsp fclose(memstream);
386 39ff877f 2018-03-13 stsp if (err == NULL) {
388 39ff877f 2018-03-13 stsp n = fwrite(memstream_buf, 1, memstream_size, outfile);
389 39ff877f 2018-03-13 stsp if (n != memstream_size)
390 39ff877f 2018-03-13 stsp err = got_ferror(outfile, GOT_ERR_IO);
392 39ff877f 2018-03-13 stsp free(memstream_buf);
394 885d3e02 2018-01-27 stsp if (err == NULL)
395 885d3e02 2018-01-27 stsp rewind(outfile);
396 885d3e02 2018-01-27 stsp return err;