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

#include "common.h"
9

10
#include <zlib.h>
11
#include "git2/repository.h"
12 13
#include "git2/indexer.h"
#include "git2/sys/odb_backend.h"
14
#include "futils.h"
15 16
#include "hash.h"
#include "odb.h"
17
#include "delta.h"
18
#include "mwindow.h"
19
#include "pack.h"
20

21
#include "git2/odb_backend.h"
22

23 24 25
/* re-freshen pack files no more than every 2 seconds */
#define FRESHEN_FREQUENCY 2

Vicent Marti committed
26 27 28
struct pack_backend {
	git_odb_backend parent;
	git_vector packs;
29
	struct git_pack_file *last_found;
30
	char *pack_folder;
Vicent Marti committed
31 32
};

33 34
struct pack_writepack {
	struct git_odb_writepack parent;
35
	git_indexer *indexer;
36 37
};

Vicent Marti committed
38 39 40
/**
 * The wonderful tale of a Packed Object lookup query
 * ===================================================
Vicent Marti committed
41 42 43
 *	A riveting and epic story of epicness and ASCII
 *			art, presented by yours truly,
 *				Sir Vicent of Marti
Vicent Marti committed
44 45 46 47 48 49 50 51 52 53
 *
 *
 *	Chapter 1: Once upon a time...
 *	Initialization of the Pack Backend
 *	--------------------------------------------------
 *
 *	# git_odb_backend_pack
 *	| Creates the pack backend structure, initializes the
 *	| callback pointers to our default read() and exist() methods,
 *	| and tries to preload all the known packfiles in the ODB.
Vicent Marti committed
54
 * |
Vicent Marti committed
55
 *	|-# packfile_load_all
Vicent Marti committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
 *	 | Tries to find the `pack` folder, if it exists. ODBs without
 *	 | a pack folder are ignored altogether. If there's a `pack` folder
 *	 | we run a `dirent` callback through every file in the pack folder
 *	 | to find our packfiles. The packfiles are then sorted according
 *	 | to a sorting callback.
 * 	 |
 *	 |-# packfile_load__cb
 *	 | | This callback is called from `dirent` with every single file
 *	 | | inside the pack folder. We find the packs by actually locating
 *	 | | their index (ends in ".idx"). From that index, we verify that
 *	 | | the corresponding packfile exists and is valid, and if so, we
 *	| | add it to the pack list.
 *	 | |
 *	 | |-# packfile_check
 *	 |		Make sure that there's a packfile to back this index, and store
 *	 |		some very basic information regarding the packfile itself,
 *	 |		such as the full path, the size, and the modification time.
 *	 |		We don't actually open the packfile to check for internal consistency.
 *	|
 *	|-# packfile_sort__cb
 *		Sort all the preloaded packs according to some specific criteria:
 *		we prioritize the "newer" packs because it's more likely they
 *		contain the objects we are looking for, and we prioritize local
 *		packs over remote ones.
Vicent Marti committed
80 81 82 83 84 85 86
 *
 *
 *
 *	Chapter 2: To be, or not to be...
 *	A standard packed `exist` query for an OID
 *	--------------------------------------------------
 *
Vicent Marti committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
 * # pack_backend__exists
 * | Check if the given SHA1 oid exists in any of the packs
 * | that have been loaded for our ODB.
 * |
 * |-# pack_entry_find
 *	| Iterate through all the packs that have been preloaded
 *	| (starting by the pack where the latest object was found)
 *	| to try to find the OID in one of them.
 *	|
 *	|-# pack_entry_find1
 *		| Check the index of an individual pack to see if the SHA1
 *		| OID can be found. If we can find the offset to that SHA1
 *		| inside of the index, that means the object is contained
 *		| inside of the packfile and we can stop searching.
 *		| Before returning, we verify that the packfile behing the
 *		| index we are searching still exists on disk.
 *		|
 *		|-# pack_entry_find_offset
 *		| | Mmap the actual index file to disk if it hasn't been opened
 *		| | yet, and run a binary search through it to find the OID.
 *		| | See <http://book.git-scm.com/7_the_packfile.html> for specifics
 *		| | on the Packfile Index format and how do we find entries in it.
 *		| |
 *		| |-# pack_index_open
 *		|	| Guess the name of the index based on the full path to the
 *		|	| packfile, open it and verify its contents. Only if the index
 *		|	| has not been opened already.
 *		|	|
 *		|	|-# pack_index_check
 *		|		Mmap the index file and do a quick run through the header
 *		|		to guess the index version (right now we support v1 and v2),
 *		|		and to verify that the size of the index makes sense.
 *		|
 *		|-# packfile_open
 *			See `packfile_open` in Chapter 3
Vicent Marti committed
122 123 124 125 126 127 128 129 130
 *
 *
 *
 *	Chapter 3: The neverending story...
 *	A standard packed `lookup` query for an OID
 *	--------------------------------------------------
 *	TODO
 *
 */
131 132 133 134


/***********************************************************
 *
Vicent Marti committed
135
 * FORWARD DECLARATIONS
136 137 138
 *
 ***********************************************************/

Vicent Marti committed
139
static int packfile_sort__cb(const void *a_, const void *b_);
140

141
static int packfile_load__cb(void *_data, git_buf *path);
142

143
static int pack_entry_find(struct git_pack_entry *e,
144
	struct pack_backend *backend, const git_oid *oid);
145

146 147
/* Can find the offset of an object given
 * a prefix of an identifier.
148
 * Sets GIT_EAMBIGUOUS if short oid is ambiguous.
149 150
 * This method assumes that len is between
 * GIT_OID_MINPREFIXLEN and GIT_OID_HEXSZ.
151
 */
152 153 154 155
static int pack_entry_find_prefix(
	struct git_pack_entry *e,
	struct pack_backend *backend,
	const git_oid *short_oid,
156
	size_t len);
157

Vicent Marti committed
158 159 160 161 162 163 164


/***********************************************************
 *
 * PACK WINDOW MANAGEMENT
 *
 ***********************************************************/
165

Vicent Marti committed
166
static int packfile_sort__cb(const void *a_, const void *b_)
167
{
168 169
	const struct git_pack_file *a = a_;
	const struct git_pack_file *b = b_;
Vicent Marti committed
170
	int st;
171

Vicent Marti committed
172 173
	/*
	 * Local packs tend to contain objects specific to our
Vicent Marti committed
174
	 * variant of the project than remote ones. In addition,
Vicent Marti committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
	 * remote ones could be on a network mounted filesystem.
	 * Favor local ones for these reasons.
	 */
	st = a->pack_local - b->pack_local;
	if (st)
		return -st;

	/*
	 * Younger packs tend to contain more recent objects,
	 * and more recent objects tend to get accessed more
	 * often.
	 */
	if (a->mtime < b->mtime)
		return 1;
	else if (a->mtime == b->mtime)
		return 0;

	return -1;
193 194
}

Vicent Marti committed
195

196
static int packfile_load__cb(void *data, git_buf *path)
197
{
198
	struct pack_backend *backend = data;
199
	struct git_pack_file *pack;
200 201
	const char *path_str = git_buf_cstr(path);
	size_t i, cmp_len = git_buf_len(path);
Vicent Marti committed
202
	int error;
203

204
	if (cmp_len <= strlen(".idx") || git__suffixcmp(path_str, ".idx") != 0)
205
		return 0; /* not an index */
206

207 208
	cmp_len -= strlen(".idx");

209
	for (i = 0; i < backend->packs.length; ++i) {
210
		struct git_pack_file *p = git_vector_get(&backend->packs, i);
211

bisho committed
212
		if (strncmp(p->pack_name, path_str, cmp_len) == 0)
213
			return 0;
214
	}
215

216
	error = git_mwindow_get_pack(&pack, path->ptr);
217 218 219

	/* ignore missing .pack file as git does */
	if (error == GIT_ENOTFOUND) {
220
		git_error_clear();
221
		return 0;
222 223 224 225 226
	}

	if (!error)
		error = git_vector_insert(&backend->packs, pack);

227
	return error;
Vicent Marti committed
228

229 230
}

231 232 233 234 235
static int pack_entry_find_inner(
	struct git_pack_entry *e,
	struct pack_backend *backend,
	const git_oid *oid,
	struct git_pack_file *last_found)
Vicent Marti committed
236
{
237
	size_t i;
238

239 240
	if (last_found &&
		git_pack_entry_find(e, last_found, oid, GIT_OID_HEXSZ) == 0)
241
		return 0;
242

Vicent Marti committed
243
	for (i = 0; i < backend->packs.length; ++i) {
244
		struct git_pack_file *p;
245

Vicent Marti committed
246
		p = git_vector_get(&backend->packs, i);
247
		if (p == last_found)
Vicent Marti committed
248
			continue;
249

250
		if (git_pack_entry_find(e, p, oid, GIT_OID_HEXSZ) == 0) {
Vicent Marti committed
251
			backend->last_found = p;
252
			return 0;
253
		}
Vicent Marti committed
254 255
	}

256 257 258 259 260
	return -1;
}

static int pack_entry_find(struct git_pack_entry *e, struct pack_backend *backend, const git_oid *oid)
{
261
	struct git_pack_file *last_found = backend->last_found;
262 263 264 265 266

	if (backend->last_found &&
		git_pack_entry_find(e, backend->last_found, oid, GIT_OID_HEXSZ) == 0)
		return 0;

267
	if (!pack_entry_find_inner(e, backend, oid, last_found))
268 269
		return 0;

270 271
	return git_odb__error_notfound(
		"failed to find pack entry", oid, GIT_OID_HEXSZ);
Vicent Marti committed
272 273
}

274 275 276 277 278
static int pack_entry_find_prefix(
	struct git_pack_entry *e,
	struct pack_backend *backend,
	const git_oid *short_oid,
	size_t len)
279 280
{
	int error;
281
	size_t i;
282 283 284
	git_oid found_full_oid = {{0}};
	bool found = false;
	struct git_pack_file *last_found = backend->last_found;
285

286 287
	if (last_found) {
		error = git_pack_entry_find(e, last_found, short_oid, len);
288 289
		if (error == GIT_EAMBIGUOUS)
			return error;
290 291 292 293
		if (!error) {
			git_oid_cpy(&found_full_oid, &e->sha1);
			found = true;
		}
294 295 296
	}

	for (i = 0; i < backend->packs.length; ++i) {
297
		struct git_pack_file *p;
298 299

		p = git_vector_get(&backend->packs, i);
300
		if (p == last_found)
301 302
			continue;

303
		error = git_pack_entry_find(e, p, short_oid, len);
304 305 306
		if (error == GIT_EAMBIGUOUS)
			return error;
		if (!error) {
307 308 309 310
			if (found && git_oid_cmp(&e->sha1, &found_full_oid))
				return git_odb__error_ambiguous("found multiple pack entries");
			git_oid_cpy(&found_full_oid, &e->sha1);
			found = true;
311 312 313 314
			backend->last_found = p;
		}
	}

315
	if (!found)
316 317
		return git_odb__error_notfound("no matching pack entry for prefix",
			short_oid, len);
318 319
	else
		return 0;
320 321
}

Vicent Marti committed
322

323 324 325 326 327 328 329
/***********************************************************
 *
 * PACKED BACKEND PUBLIC API
 *
 * Implement the git_odb_backend API calls
 *
 ***********************************************************/
330
static int pack_backend__refresh(git_odb_backend *backend_)
Vicent Marti committed
331 332 333 334
{
	int error;
	struct stat st;
	git_buf path = GIT_BUF_INIT;
335
	struct pack_backend *backend = (struct pack_backend *)backend_;
Vicent Marti committed
336

337
	if (backend->pack_folder == NULL)
Vicent Marti committed
338 339
		return 0;

340
	if (p_stat(backend->pack_folder, &st) < 0 || !S_ISDIR(st.st_mode))
341
		return git_odb__error_notfound("failed to refresh packfiles", NULL, 0);
Vicent Marti committed
342

343
	git_buf_sets(&path, backend->pack_folder);
Vicent Marti committed
344 345

	/* reload all packs */
346
	error = git_path_direach(&path, 0, packfile_load__cb, backend);
Vicent Marti committed
347

348
	git_buf_dispose(&path);
349
	git_vector_sort(&backend->packs);
Vicent Marti committed
350

351
	return error;
Vicent Marti committed
352 353
}

354
static int pack_backend__read_header(
355
	size_t *len_p, git_object_t *type_p,
nulltoken committed
356
	struct git_odb_backend *backend, const git_oid *oid)
357
{
358 359
	struct git_pack_entry e;
	int error;
360

361
	assert(len_p && type_p && backend && oid);
362

363 364
	if ((error = pack_entry_find(&e, (struct pack_backend *)backend, oid)) < 0)
		return error;
365

366
	return git_packfile_resolve_header(len_p, type_p, e.p, e.offset);
367 368
}

369 370 371 372
static int pack_backend__freshen(
	git_odb_backend *backend, const git_oid *oid)
{
	struct git_pack_entry e;
373
	time_t now;
374 375 376 377 378
	int error;

	if ((error = pack_entry_find(&e, (struct pack_backend *)backend, oid)) < 0)
		return error;

379 380 381 382 383 384 385 386 387 388
	now = time(NULL);

	if (e.p->last_freshen > now - FRESHEN_FREQUENCY)
		return 0;

	if ((error = git_futils_touch(e.p->pack_name, &now)) < 0)
		return error;

	e.p->last_freshen = now;
	return 0;
389 390
}

391
static int pack_backend__read(
392
	void **buffer_p, size_t *len_p, git_object_t *type_p,
nulltoken committed
393
	git_odb_backend *backend, const git_oid *oid)
394
{
395
	struct git_pack_entry e;
396
	git_rawobj raw = {NULL};
Vicent Marti committed
397
	int error;
398

399 400 401
	if ((error = pack_entry_find(&e, (struct pack_backend *)backend, oid)) < 0 ||
		(error = git_packfile_unpack(&raw, e.p, &e.offset)) < 0)
		return error;
Vicent Marti committed
402 403 404 405 406

	*buffer_p = raw.data;
	*len_p = raw.len;
	*type_p = raw.type;

407
	return 0;
408 409
}

410
static int pack_backend__read_prefix(
Vicent Marti committed
411 412 413
	git_oid *out_oid,
	void **buffer_p,
	size_t *len_p,
414
	git_object_t *type_p,
Vicent Marti committed
415 416
	git_odb_backend *backend,
	const git_oid *short_oid,
417
	size_t len)
418
{
419 420
	int error = 0;

421
	if (len < GIT_OID_MINPREFIXLEN)
422
		error = git_odb__error_ambiguous("prefix length too short");
423

424
	else if (len >= GIT_OID_HEXSZ) {
425
		/* We can fall back to regular read method */
426 427
		error = pack_backend__read(buffer_p, len_p, type_p, backend, short_oid);
		if (!error)
428 429
			git_oid_cpy(out_oid, short_oid);
	} else {
430
		struct git_pack_entry e;
431
		git_rawobj raw = {NULL};
432

433 434 435 436 437 438 439 440 441
		if ((error = pack_entry_find_prefix(
				&e, (struct pack_backend *)backend, short_oid, len)) == 0 &&
			(error = git_packfile_unpack(&raw, e.p, &e.offset)) == 0)
		{
			*buffer_p = raw.data;
			*len_p = raw.len;
			*type_p = raw.type;
			git_oid_cpy(out_oid, &e.sha1);
		}
442
	}
443

444
	return error;
445 446
}

447
static int pack_backend__exists(git_odb_backend *backend, const git_oid *oid)
448
{
449
	struct git_pack_entry e;
450
	return pack_entry_find(&e, (struct pack_backend *)backend, oid) == 0;
451 452
}

453 454 455 456 457 458 459 460 461 462 463 464
static int pack_backend__exists_prefix(
	git_oid *out, git_odb_backend *backend, const git_oid *short_id, size_t len)
{
	int error;
	struct pack_backend *pb = (struct pack_backend *)backend;
	struct git_pack_entry e = {0};

	error = pack_entry_find_prefix(&e, pb, short_id, len);
	git_oid_cpy(out, &e.sha1);
	return error;
}

465
static int pack_backend__foreach(git_odb_backend *_backend, git_odb_foreach_cb cb, void *data)
466
{
467
	int error;
468 469 470 471 472 473 474 475
	struct git_pack_file *p;
	struct pack_backend *backend;
	unsigned int i;

	assert(_backend && cb);
	backend = (struct pack_backend *)_backend;

	/* Make sure we know about the packfiles */
Vicent Marti committed
476
	if ((error = pack_backend__refresh(_backend)) < 0)
477
		return error;
478 479

	git_vector_foreach(&backend->packs, i, p) {
480
		if ((error = git_pack_foreach_entry(p, cb, data)) != 0)
481
			return error;
482
	}
483

484 485 486
	return 0;
}

487
static int pack_backend__writepack_append(struct git_odb_writepack *_writepack, const void *data, size_t size, git_indexer_progress *stats)
488 489 490 491 492
{
	struct pack_writepack *writepack = (struct pack_writepack *)_writepack;

	assert(writepack);

493
	return git_indexer_append(writepack->indexer, data, size, stats);
494 495
}

496
static int pack_backend__writepack_commit(struct git_odb_writepack *_writepack, git_indexer_progress *stats)
497 498 499 500 501
{
	struct pack_writepack *writepack = (struct pack_writepack *)_writepack;

	assert(writepack);

502
	return git_indexer_commit(writepack->indexer, stats);
503 504 505 506 507 508 509 510
}

static void pack_backend__writepack_free(struct git_odb_writepack *_writepack)
{
	struct pack_writepack *writepack = (struct pack_writepack *)_writepack;

	assert(writepack);

511
	git_indexer_free(writepack->indexer);
512 513 514 515 516
	git__free(writepack);
}

static int pack_backend__writepack(struct git_odb_writepack **out,
	git_odb_backend *_backend,
517
        git_odb *odb,
518
	git_indexer_progress_cb progress_cb,
519 520
	void *progress_payload)
{
521
	git_indexer_options opts = GIT_INDEXER_OPTIONS_INIT;
522 523 524 525 526 527 528
	struct pack_backend *backend;
	struct pack_writepack *writepack;

	assert(out && _backend);

	*out = NULL;

529 530 531
	opts.progress_cb = progress_cb;
	opts.progress_cb_payload = progress_payload;

532 533 534
	backend = (struct pack_backend *)_backend;

	writepack = git__calloc(1, sizeof(struct pack_writepack));
535
	GIT_ERROR_CHECK_ALLOC(writepack);
536

537
	if (git_indexer_new(&writepack->indexer,
538
		backend->pack_folder, 0, odb, &opts) < 0) {
539 540 541 542 543
		git__free(writepack);
		return -1;
	}

	writepack->parent.backend = _backend;
544
	writepack->parent.append = pack_backend__writepack_append;
545 546 547 548 549 550 551 552
	writepack->parent.commit = pack_backend__writepack_commit;
	writepack->parent.free = pack_backend__writepack_free;

	*out = (git_odb_writepack *)writepack;

	return 0;
}

553
static void pack_backend__free(git_odb_backend *_backend)
554
{
Vicent Marti committed
555
	struct pack_backend *backend;
556
	size_t i;
557 558 559

	assert(_backend);

Vicent Marti committed
560
	backend = (struct pack_backend *)_backend;
561

Vicent Marti committed
562
	for (i = 0; i < backend->packs.length; ++i) {
563
		struct git_pack_file *p = git_vector_get(&backend->packs, i);
564
		git_mwindow_put_pack(p);
Vicent Marti committed
565
	}
566

Vicent Marti committed
567
	git_vector_free(&backend->packs);
568 569
	git__free(backend->pack_folder);
	git__free(backend);
570 571
}

572
static int pack_backend__alloc(struct pack_backend **out, size_t initial_size)
573
{
574
	struct pack_backend *backend = git__calloc(1, sizeof(struct pack_backend));
575
	GIT_ERROR_CHECK_ALLOC(backend);
576

577 578
	if (git_vector_init(&backend->packs, initial_size, packfile_sort__cb) < 0) {
		git__free(backend);
579
		return -1;
580
	}
581

582
	backend->parent.version = GIT_ODB_BACKEND_VERSION;
583 584 585

	backend->parent.read = &pack_backend__read;
	backend->parent.read_prefix = &pack_backend__read_prefix;
586
	backend->parent.read_header = &pack_backend__read_header;
587
	backend->parent.exists = &pack_backend__exists;
588
	backend->parent.exists_prefix = &pack_backend__exists_prefix;
Vicent Marti committed
589
	backend->parent.refresh = &pack_backend__refresh;
590
	backend->parent.foreach = &pack_backend__foreach;
591
	backend->parent.writepack = &pack_backend__writepack;
592
	backend->parent.freshen = &pack_backend__freshen;
593 594
	backend->parent.free = &pack_backend__free;

595
	*out = backend;
596 597 598
	return 0;
}

599
int git_odb_backend_one_pack(git_odb_backend **backend_out, const char *idx)
600
{
601
	struct pack_backend *backend = NULL;
602
	struct git_pack_file *packfile = NULL;
603

604 605
	if (pack_backend__alloc(&backend, 1) < 0)
		return -1;
606

607
	if (git_mwindow_get_pack(&packfile, idx) < 0 ||
608
		git_vector_insert(&backend->packs, packfile) < 0)
609
	{
610
		pack_backend__free((git_odb_backend *)backend);
611 612
		return -1;
	}
613

614 615 616 617 618 619 620 621 622 623 624 625
	*backend_out = (git_odb_backend *)backend;
	return 0;
}

int git_odb_backend_pack(git_odb_backend **backend_out, const char *objects_dir)
{
	int error = 0;
	struct pack_backend *backend = NULL;
	git_buf path = GIT_BUF_INIT;

	if (pack_backend__alloc(&backend, 8) < 0)
		return -1;
Vicent Marti committed
626

627 628 629
	if (!(error = git_buf_joinpath(&path, objects_dir, "pack")) &&
		git_path_isdir(git_buf_cstr(&path)))
	{
630
		backend->pack_folder = git_buf_detach(&path);
Vicent Marti committed
631
		error = pack_backend__refresh((git_odb_backend *)backend);
Vicent Marti committed
632
	}
633

634 635 636 637
	if (error < 0) {
		pack_backend__free((git_odb_backend *)backend);
		backend = NULL;
	}
638 639

	*backend_out = (git_odb_backend *)backend;
640

641
	git_buf_dispose(&path);
642

643
	return error;
644
}