pack-objects.c 40.6 KB
Newer Older
Michael Schubert committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Michael Schubert committed
3 4 5 6 7 8 9
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */

#include "pack-objects.h"

10
#include "zstream.h"
Michael Schubert committed
11 12 13 14 15 16
#include "delta.h"
#include "iterator.h"
#include "netops.h"
#include "pack.h"
#include "thread-utils.h"
#include "tree.h"
17
#include "util.h"
18 19
#include "revwalk.h"
#include "commit_list.h"
Michael Schubert committed
20 21 22 23 24 25 26 27 28 29 30

#include "git2/pack.h"
#include "git2/commit.h"
#include "git2/tag.h"
#include "git2/indexer.h"
#include "git2/config.h"

struct unpacked {
	git_pobject *object;
	void *data;
	struct git_delta_index *index;
31
	size_t depth;
Michael Schubert committed
32 33
};

34 35 36 37 38
struct tree_walk_context {
	git_packbuilder *pb;
	git_buf buf;
};

39
struct pack_write_context {
40
	git_indexer *indexer;
41 42 43
	git_transfer_progress *stats;
};

44 45 46 47 48 49
struct walk_object {
	git_oid id;
	unsigned int uninteresting:1,
		seen:1;
};

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
#ifdef GIT_THREADS

#define GIT_PACKBUILDER__MUTEX_OP(pb, mtx, op) do { \
		int result = git_mutex_##op(&(pb)->mtx); \
		assert(!result); \
		GIT_UNUSED(result); \
	} while (0)

#else

#define GIT_PACKBUILDER__MUTEX_OP(pb,mtx,op) GIT_UNUSED(pb)

#endif /* GIT_THREADS */

#define git_packbuilder__cache_lock(pb) GIT_PACKBUILDER__MUTEX_OP(pb, cache_mutex, lock)
#define git_packbuilder__cache_unlock(pb) GIT_PACKBUILDER__MUTEX_OP(pb, cache_mutex, unlock)
#define git_packbuilder__progress_lock(pb) GIT_PACKBUILDER__MUTEX_OP(pb, progress_mutex, lock)
#define git_packbuilder__progress_unlock(pb) GIT_PACKBUILDER__MUTEX_OP(pb, progress_mutex, unlock)

69 70 71
/* The minimal interval between progress updates (in seconds). */
#define MIN_PROGRESS_UPDATE_INTERVAL 0.5

72 73 74
/* Size of the buffer to feed to zlib */
#define COMPRESS_BUFLEN (1024 * 1024)

Michael Schubert committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
static unsigned name_hash(const char *name)
{
	unsigned c, hash = 0;

	if (!name)
		return 0;

	/*
	 * This effectively just creates a sortable number from the
	 * last sixteen non-whitespace characters. Last characters
	 * count "most", so things that end in ".c" sort together.
	 */
	while ((c = *name++) != 0) {
		if (git__isspace(c))
			continue;
		hash = (hash >> 2) + (c << 24);
	}
	return hash;
}

static int packbuilder_config(git_packbuilder *pb)
{
	git_config *config;
98
	int ret = 0;
99
	int64_t val;
Michael Schubert committed
100

101
	if ((ret = git_repository_config_snapshot(&config, pb->repo)) < 0)
102
		return ret;
Michael Schubert committed
103

104 105
#define config_get(KEY,DST,DFLT) do { \
	ret = git_config_get_int64(&val, config, KEY); \
106 107
	if (!ret) { \
		if (!git__is_sizet(val)) { \
108
			git_error_set(GIT_ERROR_CONFIG, \
109 110 111 112 113 114
				"configuration value '%s' is too large", KEY); \
			ret = -1; \
			goto out; \
		} \
		(DST) = (size_t)val; \
	} else if (ret == GIT_ENOTFOUND) { \
115 116 117
	    (DST) = (DFLT); \
	    ret = 0; \
	} else if (ret < 0) goto out; } while (0)
Michael Schubert committed
118 119 120 121 122 123 124 125 126 127 128

	config_get("pack.deltaCacheSize", pb->max_delta_cache_size,
		   GIT_PACK_DELTA_CACHE_SIZE);
	config_get("pack.deltaCacheLimit", pb->cache_max_small_delta_size,
		   GIT_PACK_DELTA_CACHE_LIMIT);
	config_get("pack.deltaCacheSize", pb->big_file_threshold,
		   GIT_PACK_BIG_FILE_THRESHOLD);
	config_get("pack.windowMemory", pb->window_memory_limit, 0);

#undef config_get

129
out:
130 131
	git_config_free(config);

132
	return ret;
Michael Schubert committed
133 134 135 136 137 138 139 140
}

int git_packbuilder_new(git_packbuilder **out, git_repository *repo)
{
	git_packbuilder *pb;

	*out = NULL;

141
	pb = git__calloc(1, sizeof(*pb));
142
	GIT_ERROR_CHECK_ALLOC(pb);
Michael Schubert committed
143

144
	pb->object_ix = git_oidmap_alloc();
145 146
	if (!pb->object_ix)
		goto on_error;
147

148 149 150 151
	pb->walk_objects = git_oidmap_alloc();
	if (!pb->walk_objects)
		goto on_error;

152
	git_pool_init(&pb->object_pool, sizeof(struct walk_object));
153

Michael Schubert committed
154 155 156
	pb->repo = repo;
	pb->nr_threads = 1; /* do not spawn any thread by default */

157
	if (git_hash_ctx_init(&pb->ctx) < 0 ||
158
		git_zstream_init(&pb->zstream, GIT_ZSTREAM_DEFLATE) < 0 ||
159 160
		git_repository_odb(&pb->odb, repo) < 0 ||
		packbuilder_config(pb) < 0)
Michael Schubert committed
161 162
		goto on_error;

163 164 165 166 167
#ifdef GIT_THREADS

	if (git_mutex_init(&pb->cache_mutex) ||
		git_mutex_init(&pb->progress_mutex) ||
		git_cond_init(&pb->progress_cond))
Russell Belfer committed
168
	{
169
		git_error_set(GIT_ERROR_OS, "failed to initialize packbuilder mutex");
Michael Schubert committed
170
		goto on_error;
Russell Belfer committed
171
	}
Michael Schubert committed
172

173 174
#endif

Michael Schubert committed
175 176 177 178
	*out = pb;
	return 0;

on_error:
179
	git_packbuilder_free(pb);
Michael Schubert committed
180 181 182
	return -1;
}

183
unsigned int git_packbuilder_set_threads(git_packbuilder *pb, unsigned int n)
Michael Schubert committed
184 185
{
	assert(pb);
186 187

#ifdef GIT_THREADS
Michael Schubert committed
188
	pb->nr_threads = n;
189 190 191 192 193
#else
	GIT_UNUSED(n);
	assert(1 == pb->nr_threads);
#endif

194
	return pb->nr_threads;
Michael Schubert committed
195 196
}

197 198 199
static void rehash(git_packbuilder *pb)
{
	git_pobject *po;
200
	size_t pos, i;
201 202
	int ret;

203
	git_oidmap_clear(pb->object_ix);
204
	for (i = 0, po = pb->object_list; i < pb->nr_objects; i++, po++) {
205
		pos = git_oidmap_put(pb->object_ix, &po->id, &ret);
206
		git_oidmap_set_value_at(pb->object_ix, pos, po);
207 208 209
	}
}

Michael Schubert committed
210 211 212 213
int git_packbuilder_insert(git_packbuilder *pb, const git_oid *oid,
			   const char *name)
{
	git_pobject *po;
214
	size_t newsize, pos;
215
	int ret;
Michael Schubert committed
216 217 218

	assert(pb && oid);

219 220
	/* If the object already exists in the hash table, then we don't
	 * have any work to do */
221
	if (git_oidmap_exists(pb->object_ix, oid))
Michael Schubert committed
222 223 224
		return 0;

	if (pb->nr_objects >= pb->nr_alloc) {
225 226
		GIT_ERROR_CHECK_ALLOC_ADD(&newsize, pb->nr_alloc, 1024);
		GIT_ERROR_CHECK_ALLOC_MULTIPLY(&newsize, newsize, 3 / 2);
227 228

		if (!git__is_uint32(newsize)) {
229
			git_error_set(GIT_ERROR_NOMEMORY, "packfile too large to fit in memory.");
230 231 232
			return -1;
		}

233
		pb->nr_alloc = newsize;
234

235 236
		pb->object_list = git__reallocarray(pb->object_list,
			pb->nr_alloc, sizeof(*po));
237
		GIT_ERROR_CHECK_ALLOC(pb->object_list);
238
		rehash(pb);
Michael Schubert committed
239 240
	}

241
	po = pb->object_list + pb->nr_objects;
Michael Schubert committed
242 243
	memset(po, 0x0, sizeof(*po));

244 245
	if ((ret = git_odb_read_header(&po->size, &po->type, pb->odb, oid)) < 0)
		return ret;
246 247

	pb->nr_objects++;
Michael Schubert committed
248
	git_oid_cpy(&po->id, oid);
249
	po->hash = name_hash(name);
Michael Schubert committed
250

251
	pos = git_oidmap_put(pb->object_ix, &po->id, &ret);
252
	if (ret < 0) {
253
		git_error_set_oom();
254 255
		return ret;
	}
256
	assert(ret != 0);
257
	git_oidmap_set_value_at(pb->object_ix, pos, po);
Michael Schubert committed
258

259 260
	pb->done = false;

261 262
	if (pb->progress_cb) {
		double current_time = git__timer();
263 264 265
		double elapsed = current_time - pb->last_progress_report_time;

		if (elapsed >= MIN_PROGRESS_UPDATE_INTERVAL) {
266
			pb->last_progress_report_time = current_time;
267

268
			ret = pb->progress_cb(
269
				GIT_PACKBUILDER_ADDING_OBJECTS,
270 271 272
				pb->nr_objects, 0, pb->progress_cb_payload);

			if (ret)
273
				return git_error_set_after_callback(ret);
274 275 276
		}
	}

Michael Schubert committed
277 278 279 280 281 282
	return 0;
}

static int get_delta(void **out, git_odb *odb, git_pobject *po)
{
	git_odb_object *src = NULL, *trg = NULL;
283
	size_t delta_size;
Michael Schubert committed
284
	void *delta_buf;
285
	int error;
Michael Schubert committed
286 287 288 289 290 291 292

	*out = NULL;

	if (git_odb_read(&src, odb, &po->delta->id) < 0 ||
	    git_odb_read(&trg, odb, &po->id) < 0)
		goto on_error;

293 294 295 296 297 298 299
	error = git_delta(&delta_buf, &delta_size,
		git_odb_object_data(src), git_odb_object_size(src),
		git_odb_object_data(trg), git_odb_object_size(trg),
		0);

	if (error < 0 && error != GIT_EBUFS)
		goto on_error;
Michael Schubert committed
300

301
	if (error == GIT_EBUFS || delta_size != po->delta_size) {
302
		git_error_set(GIT_ERROR_INVALID, "delta size changed");
Michael Schubert committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
		goto on_error;
	}

	*out = delta_buf;

	git_odb_object_free(src);
	git_odb_object_free(trg);
	return 0;

on_error:
	git_odb_object_free(src);
	git_odb_object_free(trg);
	return -1;
}

318 319 320 321 322
static int write_object(
	git_packbuilder *pb,
	git_pobject *po,
	int (*write_cb)(void *buf, size_t size, void *cb_data),
	void *cb_data)
Michael Schubert committed
323 324
{
	git_odb_object *obj = NULL;
325
	git_object_t type;
326
	unsigned char hdr[10], *zbuf = NULL;
327
	void *data = NULL;
328 329
	size_t hdr_len, zbuf_len = COMPRESS_BUFLEN, data_len;
	int error;
Michael Schubert committed
330

331 332 333 334 335
	/*
	 * If we have a delta base, let's use the delta to save space.
	 * Otherwise load the whole object. 'data' ends up pointing to
	 * whatever data we want to put into the packfile.
	 */
Michael Schubert committed
336 337
	if (po->delta) {
		if (po->delta_data)
338 339
			data = po->delta_data;
		else if ((error = get_delta(&data, pb->odb, po)) < 0)
340 341 342
				goto done;

		data_len = po->delta_size;
343
		type = GIT_OBJECT_REF_DELTA;
Michael Schubert committed
344
	} else {
345 346
		if ((error = git_odb_read(&obj, pb->odb, &po->id)) < 0)
			goto done;
Michael Schubert committed
347 348

		data = (void *)git_odb_object_data(obj);
349
		data_len = git_odb_object_size(obj);
Michael Schubert committed
350 351 352 353
		type = git_odb_object_type(obj);
	}

	/* Write header */
354
	hdr_len = git_packfile__object_header(hdr, data_len, type);
Michael Schubert committed
355

356 357 358
	if ((error = write_cb(hdr, hdr_len, cb_data)) < 0 ||
		(error = git_hash_update(&pb->ctx, hdr, hdr_len)) < 0)
		goto done;
Michael Schubert committed
359

360
	if (type == GIT_OBJECT_REF_DELTA) {
361 362 363
		if ((error = write_cb(po->delta->id.id, GIT_OID_RAWSZ, cb_data)) < 0 ||
			(error = git_hash_update(&pb->ctx, po->delta->id.id, GIT_OID_RAWSZ)) < 0)
			goto done;
Michael Schubert committed
364 365 366
	}

	/* Write data */
367 368 369 370 371 372 373 374
	if (po->z_delta_size) {
		data_len = po->z_delta_size;

		if ((error = write_cb(data, data_len, cb_data)) < 0 ||
			(error = git_hash_update(&pb->ctx, data, data_len)) < 0)
			goto done;
	} else {
		zbuf = git__malloc(zbuf_len);
375
		GIT_ERROR_CHECK_ALLOC(zbuf);
376

377
		git_zstream_reset(&pb->zstream);
378
		git_zstream_set_input(&pb->zstream, data, data_len);
379

380 381 382 383
		while (!git_zstream_done(&pb->zstream)) {
			if ((error = git_zstream_get_output(zbuf, &zbuf_len, &pb->zstream)) < 0 ||
				(error = write_cb(zbuf, zbuf_len, cb_data)) < 0 ||
				(error = git_hash_update(&pb->ctx, zbuf, zbuf_len)) < 0)
384 385
				goto done;

386
			zbuf_len = COMPRESS_BUFLEN; /* reuse buffer */
387
		}
Michael Schubert committed
388 389
	}

390 391 392 393 394 395 396 397 398
	/*
	 * If po->delta is true, data is a delta and it is our
	 * responsibility to free it (otherwise it's a git_object's
	 * data). We set po->delta_data to NULL in case we got the
	 * data from there instead of get_delta(). If we didn't,
	 * there's no harm.
	 */
	if (po->delta) {
		git__free(data);
399 400
		po->delta_data = NULL;
	}
Michael Schubert committed
401 402 403

	pb->nr_written++;

404 405
done:
	git__free(zbuf);
Michael Schubert committed
406
	git_odb_object_free(obj);
407
	return error;
Michael Schubert committed
408 409 410 411 412 413 414 415 416
}

enum write_one_status {
	WRITE_ONE_SKIP = -1, /* already written */
	WRITE_ONE_BREAK = 0, /* writing this will bust the limit; not written */
	WRITE_ONE_WRITTEN = 1, /* normal */
	WRITE_ONE_RECURSIVE = 2 /* already scheduled to be written */
};

417 418 419 420 421 422
static int write_one(
	enum write_one_status *status,
	git_packbuilder *pb,
	git_pobject *po,
	int (*write_cb)(void *buf, size_t size, void *cb_data),
	void *cb_data)
Michael Schubert committed
423
{
424 425
	int error;

Michael Schubert committed
426 427 428 429 430 431 432 433 434 435
	if (po->recursing) {
		*status = WRITE_ONE_RECURSIVE;
		return 0;
	} else if (po->written) {
		*status = WRITE_ONE_SKIP;
		return 0;
	}

	if (po->delta) {
		po->recursing = 1;
436 437 438 439 440 441

		if ((error = write_one(status, pb, po->delta, write_cb, cb_data)) < 0)
			return error;

		/* we cannot depend on this one */
		if (*status == WRITE_ONE_RECURSIVE)
Michael Schubert committed
442 443 444
			po->delta = NULL;
	}

445
	*status = WRITE_ONE_WRITTEN;
Michael Schubert committed
446 447
	po->written = 1;
	po->recursing = 0;
448 449

	return write_object(pb, po, write_cb, cb_data);
Michael Schubert committed
450 451
}

452 453
GIT_INLINE(void) add_to_write_order(git_pobject **wo, size_t *endp,
	git_pobject *po)
Michael Schubert committed
454 455 456 457 458 459 460
{
	if (po->filled)
		return;
	wo[(*endp)++] = po;
	po->filled = 1;
}

461 462
static void add_descendants_to_write_order(git_pobject **wo, size_t *endp,
	git_pobject *po)
Michael Schubert committed
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
{
	int add_to_order = 1;
	while (po) {
		if (add_to_order) {
			git_pobject *s;
			/* add this node... */
			add_to_write_order(wo, endp, po);
			/* all its siblings... */
			for (s = po->delta_sibling; s; s = s->delta_sibling) {
				add_to_write_order(wo, endp, s);
			}
		}
		/* drop down a level to add left subtree nodes if possible */
		if (po->delta_child) {
			add_to_order = 1;
			po = po->delta_child;
		} else {
			add_to_order = 0;
			/* our sibling might have some children, it is next */
			if (po->delta_sibling) {
				po = po->delta_sibling;
				continue;
			}
			/* go back to our parent node */
			po = po->delta;
			while (po && !po->delta_sibling) {
				/* we're on the right side of a subtree, keep
				 * going up until we can go right again */
				po = po->delta;
			}
			if (!po) {
				/* done- we hit our original root node */
				return;
			}
			/* pass it off to sibling at this level */
			po = po->delta_sibling;
		}
	};
}

503 504
static void add_family_to_write_order(git_pobject **wo, size_t *endp,
	git_pobject *po)
Michael Schubert committed
505 506 507 508 509 510 511 512 513 514 515
{
	git_pobject *root;

	for (root = po; root->delta; root = root->delta)
		; /* nothing */
	add_descendants_to_write_order(wo, endp, root);
}

static int cb_tag_foreach(const char *name, git_oid *oid, void *data)
{
	git_packbuilder *pb = data;
516
	git_pobject *po;
517
	size_t pos;
Michael Schubert committed
518 519 520

	GIT_UNUSED(name);

521
	pos = git_oidmap_lookup_index(pb->object_ix, oid);
522
	if (!git_oidmap_valid_index(pb->object_ix, pos))
523 524
		return 0;

525
	po = git_oidmap_value_at(pb->object_ix, pos);
526 527
	po->tagged = 1;

Michael Schubert committed
528
	/* TODO: peel objects */
529

Michael Schubert committed
530 531 532 533 534
	return 0;
}

static git_pobject **compute_write_order(git_packbuilder *pb)
{
535
	size_t i, wo_end, last_untagged;
536
	git_pobject **wo;
Michael Schubert committed
537

538
	if ((wo = git__mallocarray(pb->nr_objects, sizeof(*wo))) == NULL)
539
		return NULL;
Michael Schubert committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

	for (i = 0; i < pb->nr_objects; i++) {
		git_pobject *po = pb->object_list + i;
		po->tagged = 0;
		po->filled = 0;
		po->delta_child = NULL;
		po->delta_sibling = NULL;
	}

	/*
	 * Fully connect delta_child/delta_sibling network.
	 * Make sure delta_sibling is sorted in the original
	 * recency order.
	 */
	for (i = pb->nr_objects; i > 0;) {
		git_pobject *po = &pb->object_list[--i];
		if (!po->delta)
			continue;
		/* Mark me as the first child */
		po->delta_sibling = po->delta->delta_child;
		po->delta->delta_child = po;
	}

	/*
	 * Mark objects that are at the tip of tags.
	 */
566 567
	if (git_tag_foreach(pb->repo, &cb_tag_foreach, pb) < 0) {
		git__free(wo);
Michael Schubert committed
568
		return NULL;
569
	}
Michael Schubert committed
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

	/*
	 * Give the objects in the original recency order until
	 * we see a tagged tip.
	 */
	for (i = wo_end = 0; i < pb->nr_objects; i++) {
		git_pobject *po = pb->object_list + i;
		if (po->tagged)
			break;
		add_to_write_order(wo, &wo_end, po);
	}
	last_untagged = i;

	/*
	 * Then fill all the tagged tips.
	 */
	for (; i < pb->nr_objects; i++) {
		git_pobject *po = pb->object_list + i;
		if (po->tagged)
			add_to_write_order(wo, &wo_end, po);
	}

	/*
	 * And then all remaining commits and tags.
	 */
	for (i = last_untagged; i < pb->nr_objects; i++) {
		git_pobject *po = pb->object_list + i;
597 598
		if (po->type != GIT_OBJECT_COMMIT &&
		    po->type != GIT_OBJECT_TAG)
Michael Schubert committed
599 600 601 602 603 604 605 606 607
			continue;
		add_to_write_order(wo, &wo_end, po);
	}

	/*
	 * And then all the trees.
	 */
	for (i = last_untagged; i < pb->nr_objects; i++) {
		git_pobject *po = pb->object_list + i;
608
		if (po->type != GIT_OBJECT_TREE)
Michael Schubert committed
609 610 611 612 613 614 615 616 617 618 619 620 621 622
			continue;
		add_to_write_order(wo, &wo_end, po);
	}

	/*
	 * Finally all the rest in really tight order
	 */
	for (i = last_untagged; i < pb->nr_objects; i++) {
		git_pobject *po = pb->object_list + i;
		if (!po->filled)
			add_family_to_write_order(wo, &wo_end, po);
	}

	if (wo_end != pb->nr_objects) {
623
		git__free(wo);
624
		git_error_set(GIT_ERROR_INVALID, "invalid write order");
Michael Schubert committed
625 626 627 628 629 630 631
		return NULL;
	}

	return wo;
}

static int write_pack(git_packbuilder *pb,
632 633
	int (*write_cb)(void *buf, size_t size, void *cb_data),
	void *cb_data)
Michael Schubert committed
634 635 636 637 638
{
	git_pobject **write_order;
	git_pobject *po;
	enum write_one_status status;
	struct git_pack_header ph;
639
	git_oid entry_oid;
640
	size_t i = 0;
641
	int error = 0;
Michael Schubert committed
642 643

	write_order = compute_write_order(pb);
644 645
	if (write_order == NULL)
		return -1;
Michael Schubert committed
646

647
	if (!git__is_uint32(pb->nr_objects)) {
648
		git_error_set(GIT_ERROR_INVALID, "too many objects");
649 650 651
		return -1;
	}

Michael Schubert committed
652 653 654 655 656
	/* Write pack header */
	ph.hdr_signature = htonl(PACK_SIGNATURE);
	ph.hdr_version = htonl(PACK_VERSION);
	ph.hdr_entries = htonl(pb->nr_objects);

657 658
	if ((error = write_cb(&ph, sizeof(ph), cb_data)) < 0 ||
		(error = git_hash_update(&pb->ctx, &ph, sizeof(ph))) < 0)
659
		goto done;
Michael Schubert committed
660 661 662 663 664 665

	pb->nr_remaining = pb->nr_objects;
	do {
		pb->nr_written = 0;
		for ( ; i < pb->nr_objects; ++i) {
			po = write_order[i];
666 667

			if ((error = write_one(&status, pb, po, write_cb, cb_data)) < 0)
668
				goto done;
Michael Schubert committed
669 670 671 672 673
		}

		pb->nr_remaining -= pb->nr_written;
	} while (pb->nr_remaining && i < pb->nr_objects);

674
	if ((error = git_hash_final(&entry_oid, &pb->ctx)) < 0)
675
		goto done;
Michael Schubert committed
676

677
	error = write_cb(entry_oid.id, GIT_OID_RAWSZ, cb_data);
Michael Schubert committed
678

679
done:
680 681 682 683 684 685 686 687 688
	/* if callback cancelled writing, we must still free delta_data */
	for ( ; i < pb->nr_objects; ++i) {
		po = write_order[i];
		if (po->delta_data) {
			git__free(po->delta_data);
			po->delta_data = NULL;
		}
	}

Michael Schubert committed
689
	git__free(write_order);
690
	return error;
Michael Schubert committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
}

static int write_pack_buf(void *buf, size_t size, void *data)
{
	git_buf *b = (git_buf *)data;
	return git_buf_put(b, buf, size);
}

static int type_size_sort(const void *_a, const void *_b)
{
	const git_pobject *a = (git_pobject *)_a;
	const git_pobject *b = (git_pobject *)_b;

	if (a->type > b->type)
		return -1;
	if (a->type < b->type)
		return 1;
	if (a->hash > b->hash)
		return -1;
	if (a->hash < b->hash)
		return 1;
	/*
	 * TODO
	 *
	if (a->preferred_base > b->preferred_base)
		return -1;
	if (a->preferred_base < b->preferred_base)
		return 1;
	*/
	if (a->size > b->size)
		return -1;
	if (a->size < b->size)
		return 1;
	return a < b ? -1 : (a > b); /* newest first */
}

727 728 729 730 731
static int delta_cacheable(
	git_packbuilder *pb,
	size_t src_size,
	size_t trg_size,
	size_t delta_size)
Michael Schubert committed
732
{
733 734 735 736 737 738
	size_t new_size;

	if (git__add_sizet_overflow(&new_size, pb->delta_cache_size, delta_size))
		return 0;

	if (pb->max_delta_cache_size && new_size > pb->max_delta_cache_size)
Michael Schubert committed
739 740 741 742 743 744 745 746 747 748 749 750 751
		return 0;

	if (delta_size < pb->cache_max_small_delta_size)
		return 1;

	/* cache delta, if objects are large enough compared to delta size */
	if ((src_size >> 20) + (trg_size >> 21) > (delta_size >> 10))
		return 1;

	return 0;
}

static int try_delta(git_packbuilder *pb, struct unpacked *trg,
752 753
		     struct unpacked *src, size_t max_depth,
			 size_t *mem_usage, int *ret)
Michael Schubert committed
754 755 756 757
{
	git_pobject *trg_object = trg->object;
	git_pobject *src_object = src->object;
	git_odb_object *obj;
758 759
	size_t trg_size, src_size, delta_size, sizediff, max_size, sz;
	size_t ref_depth;
Michael Schubert committed
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
	void *delta_buf;

	/* Don't bother doing diffs between different types */
	if (trg_object->type != src_object->type) {
		*ret = -1;
		return 0;
	}

	*ret = 0;

	/* TODO: support reuse-delta */

	/* Let's not bust the allowed depth. */
	if (src->depth >= max_depth)
		return 0;

	/* Now some size filtering heuristics. */
777
	trg_size = trg_object->size;
Michael Schubert committed
778 779 780 781 782 783 784 785 786 787 788 789 790
	if (!trg_object->delta) {
		max_size = trg_size/2 - 20;
		ref_depth = 1;
	} else {
		max_size = trg_object->delta_size;
		ref_depth = trg->depth;
	}

	max_size = (uint64_t)max_size * (max_depth - src->depth) /
					(max_depth - ref_depth + 1);
	if (max_size == 0)
		return 0;

791
	src_size = src_object->size;
Michael Schubert committed
792 793 794 795 796 797 798 799 800 801 802
	sizediff = src_size < trg_size ? trg_size - src_size : 0;
	if (sizediff >= max_size)
		return 0;
	if (trg_size < src_size / 32)
		return 0;

	/* Load data if not already done */
	if (!trg->data) {
		if (git_odb_read(&obj, pb->odb, &trg_object->id) < 0)
			return -1;

803
		sz = git_odb_object_size(obj);
Michael Schubert committed
804
		trg->data = git__malloc(sz);
805
		GIT_ERROR_CHECK_ALLOC(trg->data);
Michael Schubert committed
806 807 808 809 810
		memcpy(trg->data, git_odb_object_data(obj), sz);

		git_odb_object_free(obj);

		if (sz != trg_size) {
811
			git_error_set(GIT_ERROR_INVALID,
812
				   "inconsistent target object length");
Michael Schubert committed
813 814 815 816 817 818
			return -1;
		}

		*mem_usage += sz;
	}
	if (!src->data) {
819 820 821 822
		size_t obj_sz;

		if (git_odb_read(&obj, pb->odb, &src_object->id) < 0 ||
			!git__is_ulong(obj_sz = git_odb_object_size(obj)))
Michael Schubert committed
823 824
			return -1;

825
		sz = obj_sz;
Michael Schubert committed
826
		src->data = git__malloc(sz);
827
		GIT_ERROR_CHECK_ALLOC(src->data);
Michael Schubert committed
828 829 830 831 832
		memcpy(src->data, git_odb_object_data(obj), sz);

		git_odb_object_free(obj);

		if (sz != src_size) {
833
			git_error_set(GIT_ERROR_INVALID,
834
				   "inconsistent source object length");
Michael Schubert committed
835 836 837 838 839 840
			return -1;
		}

		*mem_usage += sz;
	}
	if (!src->index) {
841
		if (git_delta_index_init(&src->index, src->data, src_size) < 0)
Michael Schubert committed
842 843
			return 0; /* suboptimal pack - out of memory */

844
		*mem_usage += git_delta_index_size(src->index);
Michael Schubert committed
845 846
	}

847 848
	if (git_delta_create_from_index(&delta_buf, &delta_size, src->index, trg->data, trg_size,
		max_size) < 0)
Michael Schubert committed
849 850 851 852 853 854 855 856 857 858 859
		return 0;

	if (trg_object->delta) {
		/* Prefer only shallower same-sized deltas. */
		if (delta_size == trg_object->delta_size &&
		    src->depth + 1 >= trg->depth) {
			git__free(delta_buf);
			return 0;
		}
	}

860
	git_packbuilder__cache_lock(pb);
Michael Schubert committed
861 862
	if (trg_object->delta_data) {
		git__free(trg_object->delta_data);
863
		assert(pb->delta_cache_size >= trg_object->delta_size);
Michael Schubert committed
864 865 866 867
		pb->delta_cache_size -= trg_object->delta_size;
		trg_object->delta_data = NULL;
	}
	if (delta_cacheable(pb, src_size, trg_size, delta_size)) {
868
		bool overflow = git__add_sizet_overflow(
869
			&pb->delta_cache_size, pb->delta_cache_size, delta_size);
870

871
		git_packbuilder__cache_unlock(pb);
Michael Schubert committed
872

873 874
		if (overflow) {
			git__free(delta_buf);
875
			return -1;
876
		}
877 878

		trg_object->delta_data = git__realloc(delta_buf, delta_size);
879
		GIT_ERROR_CHECK_ALLOC(trg_object->delta_data);
Michael Schubert committed
880 881
	} else {
		/* create delta when writing the pack */
882
		git_packbuilder__cache_unlock(pb);
Michael Schubert committed
883 884 885 886 887 888 889 890 891 892 893
		git__free(delta_buf);
	}

	trg_object->delta = src_object;
	trg_object->delta_size = delta_size;
	trg->depth = src->depth + 1;

	*ret = 1;
	return 0;
}

894
static size_t check_delta_limit(git_pobject *me, size_t n)
Michael Schubert committed
895 896
{
	git_pobject *child = me->delta_child;
897
	size_t m = n;
Michael Schubert committed
898 899

	while (child) {
900
		size_t c = check_delta_limit(child, n + 1);
Michael Schubert committed
901 902 903 904 905 906 907
		if (m < c)
			m = c;
		child = child->delta_sibling;
	}
	return m;
}

908
static size_t free_unpacked(struct unpacked *n)
Michael Schubert committed
909
{
910
	size_t freed_mem = 0;
911

912 913 914 915
	if (n->index) {
		freed_mem += git_delta_index_size(n->index);
		git_delta_index_free(n->index);
	}
Michael Schubert committed
916
	n->index = NULL;
917

Michael Schubert committed
918
	if (n->data) {
919
		freed_mem += n->object->size;
Michael Schubert committed
920 921 922 923 924 925 926 927
		git__free(n->data);
		n->data = NULL;
	}
	n->object = NULL;
	n->depth = 0;
	return freed_mem;
}

928 929
static int report_delta_progress(
	git_packbuilder *pb, uint32_t count, bool force)
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
{
	int ret;

	if (pb->progress_cb) {
		double current_time = git__timer();
		double elapsed = current_time - pb->last_progress_report_time;

		if (force || elapsed >= MIN_PROGRESS_UPDATE_INTERVAL) {
			pb->last_progress_report_time = current_time;

			ret = pb->progress_cb(
				GIT_PACKBUILDER_DELTAFICATION,
				count, pb->nr_objects, pb->progress_cb_payload);

			if (ret)
945
				return git_error_set_after_callback(ret);
946 947 948 949 950 951
		}
	}

	return 0;
}

Michael Schubert committed
952
static int find_deltas(git_packbuilder *pb, git_pobject **list,
953
	size_t *list_size, size_t window, size_t depth)
Michael Schubert committed
954 955 956 957
{
	git_pobject *po;
	git_buf zbuf = GIT_BUF_INIT;
	struct unpacked *array;
958 959 960
	size_t idx = 0, count = 0;
	size_t mem_usage = 0;
	size_t i;
Michael Schubert committed
961 962 963
	int error = -1;

	array = git__calloc(window, sizeof(struct unpacked));
964
	GIT_ERROR_CHECK_ALLOC(array);
Michael Schubert committed
965 966 967

	for (;;) {
		struct unpacked *n = array + idx;
968
		size_t max_depth, j, best_base = SIZE_MAX;
Michael Schubert committed
969

970
		git_packbuilder__progress_lock(pb);
Michael Schubert committed
971
		if (!*list_size) {
972
			git_packbuilder__progress_unlock(pb);
Michael Schubert committed
973 974 975
			break;
		}

976 977 978
		pb->nr_deltified += 1;
		report_delta_progress(pb, pb->nr_deltified, false);

Michael Schubert committed
979 980
		po = *list++;
		(*list_size)--;
981
		git_packbuilder__progress_unlock(pb);
Michael Schubert committed
982 983 984 985 986 987 988

		mem_usage -= free_unpacked(n);
		n->object = po;

		while (pb->window_memory_limit &&
		       mem_usage > pb->window_memory_limit &&
		       count > 1) {
989
			size_t tail = (idx + window - count) % window;
Michael Schubert committed
990 991 992 993 994 995 996 997 998 999 1000
			mem_usage -= free_unpacked(array + tail);
			count--;
		}

		/*
		 * If the current object is at pack edge, take the depth the
		 * objects that depend on the current object into account
		 * otherwise they would become too deep.
		 */
		max_depth = depth;
		if (po->delta_child) {
1001 1002 1003
			size_t delta_limit = check_delta_limit(po, 0);

			if (delta_limit > max_depth)
Michael Schubert committed
1004
				goto next;
1005 1006

			max_depth -= delta_limit;
Michael Schubert committed
1007 1008 1009 1010 1011
		}

		j = window;
		while (--j > 0) {
			int ret;
1012
			size_t other_idx = idx + j;
Michael Schubert committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
			struct unpacked *m;

			if (other_idx >= window)
				other_idx -= window;

			m = array + other_idx;
			if (!m->object)
				break;

			if (try_delta(pb, n, m, max_depth, &mem_usage, &ret) < 0)
				goto on_error;
			if (ret < 0)
				break;
			else if (ret > 0)
				best_base = other_idx;
		}

		/*
		 * If we decided to cache the delta data, then it is best
		 * to compress it right away.  First because we have to do
		 * it anyway, and doing it here while we're threaded will
		 * save a lot of time in the non threaded write phase,
		 * as well as allow for caching more deltas within
		 * the same cache size limit.
		 * ...
		 * But only if not writing to stdout, since in that case
		 * the network is most likely throttling writes anyway,
		 * and therefore it is best to go to the write phase ASAP
		 * instead, as we can afford spending more time compressing
		 * between writes at that moment.
		 */
		if (po->delta_data) {
1045
			if (git_zstream_deflatebuf(&zbuf, po->delta_data, po->delta_size) < 0)
Michael Schubert committed
1046 1047 1048 1049
				goto on_error;

			git__free(po->delta_data);
			po->delta_data = git__malloc(zbuf.size);
1050
			GIT_ERROR_CHECK_ALLOC(po->delta_data);
Michael Schubert committed
1051 1052

			memcpy(po->delta_data, zbuf.ptr, zbuf.size);
1053
			po->z_delta_size = zbuf.size;
Michael Schubert committed
1054 1055
			git_buf_clear(&zbuf);

1056
			git_packbuilder__cache_lock(pb);
Michael Schubert committed
1057 1058
			pb->delta_cache_size -= po->delta_size;
			pb->delta_cache_size += po->z_delta_size;
1059
			git_packbuilder__cache_unlock(pb);
Michael Schubert committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
		}

		/*
		 * If we made n a delta, and if n is already at max
		 * depth, leaving it in the window is pointless.  we
		 * should evict it first.
		 */
		if (po->delta && max_depth <= n->depth)
			continue;

		/*
		 * Move the best delta base up in the window, after the
		 * currently deltified object, to keep it longer.  It will
		 * be the first base object to be attempted next.
		 */
		if (po->delta) {
			struct unpacked swap = array[best_base];
1077 1078
			size_t dist = (window + idx - best_base) % window;
			size_t dst = best_base;
Michael Schubert committed
1079
			while (dist--) {
1080
				size_t src = (dst + 1) % window;
Michael Schubert committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
				array[dst] = array[src];
				dst = src;
			}
			array[dst] = swap;
		}

		next:
		idx++;
		if (count + 1 < window)
			count++;
		if (idx >= window)
			idx = 0;
	}
	error = 0;

on_error:
	for (i = 0; i < window; ++i) {
		git__free(array[i].index);
		git__free(array[i].data);
	}
	git__free(array);
1102
	git_buf_dispose(&zbuf);
Michael Schubert committed
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117

	return error;
}

#ifdef GIT_THREADS

struct thread_params {
	git_thread thread;
	git_packbuilder *pb;

	git_pobject **list;

	git_cond cond;
	git_mutex mutex;

1118 1119
	size_t list_size;
	size_t remaining;
Michael Schubert committed
1120

1121 1122 1123 1124
	size_t window;
	size_t depth;
	size_t working;
	size_t data_ready;
Michael Schubert committed
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
};

static void *threaded_find_deltas(void *arg)
{
	struct thread_params *me = arg;

	while (me->remaining) {
		if (find_deltas(me->pb, me->list, &me->remaining,
				me->window, me->depth) < 0) {
			; /* TODO */
		}

1137
		git_packbuilder__progress_lock(me->pb);
Michael Schubert committed
1138
		me->working = 0;
1139 1140
		git_cond_signal(&me->pb->progress_cond);
		git_packbuilder__progress_unlock(me->pb);
Michael Schubert committed
1141

1142
		if (git_mutex_lock(&me->mutex)) {
1143
			git_error_set(GIT_ERROR_THREAD, "unable to lock packfile condition mutex");
1144 1145 1146 1147 1148 1149
			return NULL;
		}

		while (!me->data_ready)
			git_cond_wait(&me->cond, &me->mutex);

Michael Schubert committed
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
		/*
		 * We must not set ->data_ready before we wait on the
		 * condition because the main thread may have set it to 1
		 * before we get here. In order to be sure that new
		 * work is available if we see 1 in ->data_ready, it
		 * was initialized to 0 before this thread was spawned
		 * and we reset it to 0 right away.
		 */
		me->data_ready = 0;
		git_mutex_unlock(&me->mutex);
	}
	/* leave ->working 1 so that this doesn't get more work assigned */
	return NULL;
}

static int ll_find_deltas(git_packbuilder *pb, git_pobject **list,
1166
			  size_t list_size, size_t window, size_t depth)
Michael Schubert committed
1167 1168
{
	struct thread_params *p;
1169 1170
	size_t i;
	int ret, active_threads = 0;
Michael Schubert committed
1171 1172 1173

	if (!pb->nr_threads)
		pb->nr_threads = git_online_cpus();
1174

Michael Schubert committed
1175 1176 1177 1178 1179
	if (pb->nr_threads <= 1) {
		find_deltas(pb, list, &list_size, window, depth);
		return 0;
	}

1180
	p = git__mallocarray(pb->nr_threads, sizeof(*p));
1181
	GIT_ERROR_CHECK_ALLOC(p);
Michael Schubert committed
1182 1183 1184

	/* Partition the work among the threads */
	for (i = 0; i < pb->nr_threads; ++i) {
1185
		size_t sub_size = list_size / (pb->nr_threads - i);
Michael Schubert committed
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218

		/* don't use too small segments or no deltas will be found */
		if (sub_size < 2*window && i+1 < pb->nr_threads)
			sub_size = 0;

		p[i].pb = pb;
		p[i].window = window;
		p[i].depth = depth;
		p[i].working = 1;
		p[i].data_ready = 0;

		/* try to split chunks on "path" boundaries */
		while (sub_size && sub_size < list_size &&
		       list[sub_size]->hash &&
		       list[sub_size]->hash == list[sub_size-1]->hash)
			sub_size++;

		p[i].list = list;
		p[i].list_size = sub_size;
		p[i].remaining = sub_size;

		list += sub_size;
		list_size -= sub_size;
	}

	/* Start work threads */
	for (i = 0; i < pb->nr_threads; ++i) {
		if (!p[i].list_size)
			continue;

		git_mutex_init(&p[i].mutex);
		git_cond_init(&p[i].cond);

1219
		ret = git_thread_create(&p[i].thread,
Michael Schubert committed
1220 1221
					threaded_find_deltas, &p[i]);
		if (ret) {
1222
			git_error_set(GIT_ERROR_THREAD, "unable to create thread");
Michael Schubert committed
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
			return -1;
		}
		active_threads++;
	}

	/*
	 * Now let's wait for work completion.  Each time a thread is done
	 * with its work, we steal half of the remaining work from the
	 * thread with the largest number of unprocessed objects and give
	 * it to that newly idle thread.  This ensure good load balancing
	 * until the remaining object list segments are simply too short
	 * to be worth splitting anymore.
	 */
	while (active_threads) {
		struct thread_params *target = NULL;
		struct thread_params *victim = NULL;
1239
		size_t sub_size = 0;
Michael Schubert committed
1240

1241 1242 1243 1244 1245
		/* Start by locating a thread that has transitioned its
		 * 'working' flag from 1 -> 0. This indicates that it is
		 * ready to receive more work using our work-stealing
		 * algorithm. */
		git_packbuilder__progress_lock(pb);
Michael Schubert committed
1246 1247 1248 1249 1250 1251
		for (;;) {
			for (i = 0; !target && i < pb->nr_threads; i++)
				if (!p[i].working)
					target = &p[i];
			if (target)
				break;
1252
			git_cond_wait(&pb->progress_cond, &pb->progress_mutex);
Michael Schubert committed
1253 1254
		}

1255 1256 1257
		/* At this point we hold the progress lock and have located
		 * a thread to receive more work. We still need to locate a
		 * thread from which to steal work (the victim). */
Michael Schubert committed
1258 1259 1260 1261
		for (i = 0; i < pb->nr_threads; i++)
			if (p[i].remaining > 2*window &&
			    (!victim || victim->remaining < p[i].remaining))
				victim = &p[i];
1262

Michael Schubert committed
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
		if (victim) {
			sub_size = victim->remaining / 2;
			list = victim->list + victim->list_size - sub_size;
			while (sub_size && list[0]->hash &&
			       list[0]->hash == list[-1]->hash) {
				list++;
				sub_size--;
			}
			if (!sub_size) {
				/*
				 * It is possible for some "paths" to have
				 * so many objects that no hash boundary
				 * might be found.  Let's just steal the
				 * exact half in that case.
				 */
				sub_size = victim->remaining / 2;
				list -= sub_size;
			}
			target->list = list;
			victim->list_size -= sub_size;
			victim->remaining -= sub_size;
		}
		target->list_size = sub_size;
		target->remaining = sub_size;
		target->working = 1;
1288
		git_packbuilder__progress_unlock(pb);
Michael Schubert committed
1289

1290
		if (git_mutex_lock(&target->mutex)) {
1291
			git_error_set(GIT_ERROR_THREAD, "unable to lock packfile condition mutex");
1292 1293 1294 1295
			git__free(p);
			return -1;
		}

Michael Schubert committed
1296 1297 1298 1299 1300
		target->data_ready = 1;
		git_cond_signal(&target->cond);
		git_mutex_unlock(&target->mutex);

		if (!sub_size) {
1301
			git_thread_join(&target->thread, NULL);
Michael Schubert committed
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
			git_cond_free(&target->cond);
			git_mutex_free(&target->mutex);
			active_threads--;
		}
	}

	git__free(p);
	return 0;
}

#else
#define ll_find_deltas(pb, l, ls, w, d) find_deltas(pb, l, &ls, w, d)
#endif

static int prepare_pack(git_packbuilder *pb)
{
	git_pobject **delta_list;
1319
	size_t i, n = 0;
Michael Schubert committed
1320 1321 1322 1323

	if (pb->nr_objects == 0 || pb->done)
		return 0; /* nothing to do */

1324 1325 1326 1327 1328 1329 1330
	/*
	 * Although we do not report progress during deltafication, we
	 * at least report that we are in the deltafication stage
	 */
	if (pb->progress_cb)
			pb->progress_cb(GIT_PACKBUILDER_DELTAFICATION, 0, pb->nr_objects, pb->progress_cb_payload);

1331
	delta_list = git__mallocarray(pb->nr_objects, sizeof(*delta_list));
1332
	GIT_ERROR_CHECK_ALLOC(delta_list);
Michael Schubert committed
1333 1334 1335 1336

	for (i = 0; i < pb->nr_objects; ++i) {
		git_pobject *po = pb->object_list + i;

1337 1338
		/* Make sure the item is within our size limits */
		if (po->size < 50 || po->size > pb->big_file_threshold)
Michael Schubert committed
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
			continue;

		delta_list[n++] = po;
	}

	if (n > 1) {
		git__tsort((void **)delta_list, n, type_size_sort);
		if (ll_find_deltas(pb, delta_list, n,
				   GIT_PACK_WINDOW + 1,
				   GIT_PACK_DEPTH) < 0) {
			git__free(delta_list);
			return -1;
		}
	}

1354 1355
	report_delta_progress(pb, pb->nr_objects, true);

Michael Schubert committed
1356 1357 1358 1359 1360 1361 1362
	pb->done = true;
	git__free(delta_list);
	return 0;
}

#define PREPARE_PACK if (prepare_pack(pb) < 0) { return -1; }

1363 1364 1365 1366 1367 1368
int git_packbuilder_foreach(git_packbuilder *pb, int (*cb)(void *buf, size_t size, void *payload), void *payload)
{
	PREPARE_PACK;
	return write_pack(pb, cb, payload);
}

Michael Schubert committed
1369 1370 1371
int git_packbuilder_write_buf(git_buf *buf, git_packbuilder *pb)
{
	PREPARE_PACK;
1372
	git_buf_sanitize(buf);
Michael Schubert committed
1373 1374 1375
	return write_pack(pb, &write_pack_buf, buf);
}

1376
static int write_cb(void *buf, size_t len, void *payload)
Michael Schubert committed
1377
{
1378
	struct pack_write_context *ctx = payload;
1379
	return git_indexer_append(ctx->indexer, buf, len, ctx->stats);
1380 1381 1382 1383 1384
}

int git_packbuilder_write(
	git_packbuilder *pb,
	const char *path,
1385
	unsigned int mode,
1386
	git_transfer_progress_cb progress_cb,
1387 1388
	void *progress_cb_payload)
{
1389
	git_indexer_options opts = GIT_INDEXER_OPTIONS_INIT;
1390
	git_indexer *indexer;
1391 1392
	git_transfer_progress stats;
	struct pack_write_context ctx;
1393
	int t;
1394

Michael Schubert committed
1395
	PREPARE_PACK;
1396

1397 1398 1399
	opts.progress_cb = progress_cb;
	opts.progress_cb_payload = progress_cb_payload;

1400
	if (git_indexer_new(
1401
		&indexer, path, mode, pb->odb, &opts) < 0)
1402 1403
		return -1;

1404 1405 1406
	if (!git_repository__cvar(&t, pb->repo, GIT_CVAR_FSYNCOBJECTFILES) && t)
		git_indexer__set_fsync(indexer, 1);

1407 1408 1409 1410
	ctx.indexer = indexer;
	ctx.stats = &stats;

	if (git_packbuilder_foreach(pb, write_cb, &ctx) < 0 ||
1411 1412
		git_indexer_commit(indexer, &stats) < 0) {
		git_indexer_free(indexer);
1413 1414 1415
		return -1;
	}

1416 1417
	git_oid_cpy(&pb->pack_oid, git_indexer_hash(indexer));

1418
	git_indexer_free(indexer);
1419
	return 0;
Michael Schubert committed
1420 1421 1422 1423
}

#undef PREPARE_PACK

1424 1425 1426 1427 1428
const git_oid *git_packbuilder_hash(git_packbuilder *pb)
{
	return &pb->pack_oid;
}

1429

1430 1431
static int cb_tree_walk(
	const char *root, const git_tree_entry *entry, void *payload)
Michael Schubert committed
1432
{
1433
	int error;
1434
	struct tree_walk_context *ctx = payload;
Michael Schubert committed
1435

1436
	/* A commit inside a tree represents a submodule commit and should be skipped. */
1437
	if (git_tree_entry_type(entry) == GIT_OBJECT_COMMIT)
1438 1439
		return 0;

1440 1441 1442 1443
	if (!(error = git_buf_sets(&ctx->buf, root)) &&
		!(error = git_buf_puts(&ctx->buf, git_tree_entry_name(entry))))
		error = git_packbuilder_insert(
			ctx->pb, git_tree_entry_id(entry), git_buf_cstr(&ctx->buf));
Michael Schubert committed
1444

1445
	return error;
Michael Schubert committed
1446 1447
}

1448 1449
int git_packbuilder_insert_commit(git_packbuilder *pb, const git_oid *oid)
{
Xavier L committed
1450
	git_commit *commit;
1451

Xavier L committed
1452 1453 1454
	if (git_commit_lookup(&commit, pb->repo, oid) < 0 ||
		git_packbuilder_insert(pb, oid, NULL) < 0)
		return -1;
1455

Xavier L committed
1456 1457
	if (git_packbuilder_insert_tree(pb, git_commit_tree_id(commit)) < 0)
		return -1;
1458

Xavier L committed
1459 1460
	git_commit_free(commit);
	return 0;
1461 1462
}

Michael Schubert committed
1463 1464
int git_packbuilder_insert_tree(git_packbuilder *pb, const git_oid *oid)
{
1465 1466
	int error;
	git_tree *tree = NULL;
1467
	struct tree_walk_context context = { pb, GIT_BUF_INIT };
Michael Schubert committed
1468

1469 1470 1471
	if (!(error = git_tree_lookup(&tree, pb->repo, oid)) &&
	    !(error = git_packbuilder_insert(pb, oid, NULL)))
		error = git_tree_walk(tree, GIT_TREEWALK_PRE, cb_tree_walk, &context);
Michael Schubert committed
1472 1473

	git_tree_free(tree);
1474
	git_buf_dispose(&context.buf);
1475
	return error;
Michael Schubert committed
1476 1477
}

1478 1479 1480 1481 1482 1483 1484
int git_packbuilder_insert_recur(git_packbuilder *pb, const git_oid *id, const char *name)
{
	git_object *obj;
	int error;

	assert(pb && id);

1485
	if ((error = git_object_lookup(&obj, pb->repo, id, GIT_OBJECT_ANY)) < 0)
1486 1487 1488
		return error;

	switch (git_object_type(obj)) {
1489
	case GIT_OBJECT_BLOB:
1490 1491
		error = git_packbuilder_insert(pb, id, name);
		break;
1492
	case GIT_OBJECT_TREE:
1493 1494
		error = git_packbuilder_insert_tree(pb, id);
		break;
1495
	case GIT_OBJECT_COMMIT:
1496 1497
		error = git_packbuilder_insert_commit(pb, id);
		break;
1498
	case GIT_OBJECT_TAG:
1499 1500 1501 1502 1503 1504
		if ((error = git_packbuilder_insert(pb, id, name)) < 0)
			goto cleanup;
		error = git_packbuilder_insert_recur(pb, git_tag_target_id((git_tag *) obj), NULL);
		break;

	default:
1505
		git_error_set(GIT_ERROR_INVALID, "unknown object type");
1506 1507 1508 1509 1510 1511 1512 1513
		error = -1;
	}

cleanup:
	git_object_free(obj);
	return error;
}

1514
size_t git_packbuilder_object_count(git_packbuilder *pb)
1515 1516 1517 1518
{
	return pb->nr_objects;
}

1519
size_t git_packbuilder_written(git_packbuilder *pb)
1520 1521 1522 1523
{
	return pb->nr_written;
}

1524
static int lookup_walk_object(struct walk_object **out, git_packbuilder *pb, const git_oid *id)
1525
{
1526
	struct walk_object *obj;
1527 1528 1529

	obj = git_pool_mallocz(&pb->object_pool, 1);
	if (!obj) {
1530
		git_error_set_oom();
1531 1532 1533 1534 1535 1536 1537 1538 1539
		return -1;
	}

	git_oid_cpy(&obj->id, id);

	*out = obj;
	return 0;
}

1540
static int retrieve_object(struct walk_object **out, git_packbuilder *pb, const git_oid *id)
1541 1542
{
	int error;
1543
	size_t pos;
1544
	struct walk_object *obj;
1545 1546 1547 1548 1549 1550 1551 1552

	pos = git_oidmap_lookup_index(pb->walk_objects, id);
	if (git_oidmap_valid_index(pb->walk_objects, pos)) {
		obj = git_oidmap_value_at(pb->walk_objects, pos);
	} else {
		if ((error = lookup_walk_object(&obj, pb, id)) < 0)
			return error;

1553
		git_oidmap_insert(pb->walk_objects, &obj->id, obj, &error);
1554 1555 1556 1557 1558 1559 1560 1561 1562
	}

	*out = obj;
	return 0;
}

static int mark_blob_uninteresting(git_packbuilder *pb, const git_oid *id)
{
	int error;
1563
	struct walk_object *obj;
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574

	if ((error = retrieve_object(&obj, pb, id)) < 0)
		return error;

	obj->uninteresting = 1;

	return 0;
}

static int mark_tree_uninteresting(git_packbuilder *pb, const git_oid *id)
{
1575
	struct walk_object *obj;
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
	git_tree *tree;
	int error;
	size_t i;

	if ((error = retrieve_object(&obj, pb, id)) < 0)
		return error;

	if (obj->uninteresting)
		return 0;

	obj->uninteresting = 1;

	if ((error = git_tree_lookup(&tree, pb->repo, id)) < 0)
		return error;

	for (i = 0; i < git_tree_entrycount(tree); i++) {
		const git_tree_entry *entry = git_tree_entry_byindex(tree, i);
		const git_oid *entry_id = git_tree_entry_id(entry);
		switch (git_tree_entry_type(entry)) {
1595
		case GIT_OBJECT_TREE:
1596 1597 1598
			if ((error = mark_tree_uninteresting(pb, entry_id)) < 0)
				goto cleanup;
			break;
1599
		case GIT_OBJECT_BLOB:
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
			if ((error = mark_blob_uninteresting(pb, entry_id)) < 0)
				goto cleanup;
			break;
		default:
			/* it's a submodule or something unknown, we don't want it */
			;
		}
	}

cleanup:
	git_tree_free(tree);
	return error;
}

/*
 * Mark the edges of the graph uninteresting. Since we start from a
 * git_revwalk, the commits are already uninteresting, but we need to
 * mark the trees and blobs.
 */
static int mark_edges_uninteresting(git_packbuilder *pb, git_commit_list *commits)
{
	int error;
	git_commit_list *list;
	git_commit *commit;

	for (list = commits; list; list = list->next) {
		if (!list->item->uninteresting)
			continue;

		if ((error = git_commit_lookup(&commit, pb->repo, &list->item->oid)) < 0)
			return error;

		error = mark_tree_uninteresting(pb, git_commit_tree_id(commit));
		git_commit_free(commit);

		if (error < 0)
			return error;
	}

	return 0;
}

int insert_tree(git_packbuilder *pb, git_tree *tree)
{
	size_t i;
	int error;
	git_tree *subtree;
1647
	struct walk_object *obj;
1648 1649 1650 1651 1652
	const char *name;

	if ((error = retrieve_object(&obj, pb, git_tree_id(tree))) < 0)
		return error;

1653
	if (obj->seen || obj->uninteresting)
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
		return 0;

	obj->seen = 1;

	if ((error = git_packbuilder_insert(pb, &obj->id, NULL)))
		return error;

	for (i = 0; i < git_tree_entrycount(tree); i++) {
		const git_tree_entry *entry = git_tree_entry_byindex(tree, i);
		const git_oid *entry_id = git_tree_entry_id(entry);
		switch (git_tree_entry_type(entry)) {
1665
		case GIT_OBJECT_TREE:
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
			if ((error = git_tree_lookup(&subtree, pb->repo, entry_id)) < 0)
				return error;

			error = insert_tree(pb, subtree);
			git_tree_free(subtree);

			if (error < 0)
				return error;

			break;
1676
		case GIT_OBJECT_BLOB:
1677
			if ((error = retrieve_object(&obj, pb, entry_id)) < 0)
1678 1679 1680
				return error;
			if (obj->uninteresting)
				continue;
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
			name = git_tree_entry_name(entry);
			if ((error = git_packbuilder_insert(pb, entry_id, name)) < 0)
				return error;
			break;
		default:
			/* it's a submodule or something unknown, we don't want it */
			;
		}
	}


	return error;
}

1695
int insert_commit(git_packbuilder *pb, struct walk_object *obj)
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724
{
	int error;
	git_commit *commit = NULL;
	git_tree *tree = NULL;

	obj->seen = 1;

	if ((error = git_packbuilder_insert(pb, &obj->id, NULL)) < 0)
		return error;

	if ((error = git_commit_lookup(&commit, pb->repo, &obj->id)) < 0)
		return error;

	if ((error = git_tree_lookup(&tree, pb->repo, git_commit_tree_id(commit))) < 0)
		goto cleanup;

	if ((error = insert_tree(pb, tree)) < 0)
		goto cleanup;

cleanup:
	git_commit_free(commit);
	git_tree_free(tree);
	return error;
}

int git_packbuilder_insert_walk(git_packbuilder *pb, git_revwalk *walk)
{
	int error;
	git_oid id;
1725
	struct walk_object *obj;
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753

	assert(pb && walk);

	if ((error = mark_edges_uninteresting(pb, walk->user_input)) < 0)
		return error;

	/*
	 * TODO: git marks the parents of the edges
	 * uninteresting. This may provide a speed advantage, but does
	 * seem to assume the remote does not have a single-commit
	 * history on the other end.
	 */

	/* walk down each tree up to the blobs and insert them, stopping when uninteresting */
	while ((error = git_revwalk_next(&id, walk)) == 0) {
		if ((error = retrieve_object(&obj, pb, &id)) < 0)
			return error;

		if (obj->seen || obj->uninteresting)
			continue;

		if ((error = insert_commit(pb, obj)) < 0)
			return error;
	}

	if (error == GIT_ITEROVER)
		error = 0;

1754
	return error;
1755 1756
}

1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
int git_packbuilder_set_callbacks(git_packbuilder *pb, git_packbuilder_progress progress_cb, void *progress_cb_payload)
{
	if (!pb)
		return -1;

	pb->progress_cb = progress_cb;
	pb->progress_cb_payload = progress_cb_payload;

	return 0;
}

Michael Schubert committed
1768 1769 1770 1771 1772
void git_packbuilder_free(git_packbuilder *pb)
{
	if (pb == NULL)
		return;

1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
#ifdef GIT_THREADS

	git_mutex_free(&pb->cache_mutex);
	git_mutex_free(&pb->progress_mutex);
	git_cond_free(&pb->progress_cond);

#endif

	if (pb->odb)
		git_odb_free(pb->odb);

	if (pb->object_ix)
		git_oidmap_free(pb->object_ix);

	if (pb->object_list)
		git__free(pb->object_list);

1790 1791 1792
	git_oidmap_free(pb->walk_objects);
	git_pool_clear(&pb->object_pool);

1793
	git_hash_ctx_cleanup(&pb->ctx);
1794
	git_zstream_free(&pb->zstream);
1795

Michael Schubert committed
1796 1797
	git__free(pb);
}