odb_pack.c 15.6 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
#include <zlib.h>
10
#include "git2/repository.h"
11 12
#include "git2/indexer.h"
#include "git2/sys/odb_backend.h"
13 14 15 16
#include "fileops.h"
#include "hash.h"
#include "odb.h"
#include "delta-apply.h"
17
#include "sha1_lookup.h"
18
#include "mwindow.h"
19
#include "pack.h"
20

21
#include "git2/odb_backend.h"
22

Vicent Marti committed
23 24 25
struct pack_backend {
	git_odb_backend parent;
	git_vector packs;
26
	struct git_pack_file *last_found;
27
	char *pack_folder;
Vicent Marti committed
28 29
};

30 31 32 33 34
struct pack_writepack {
	struct git_odb_writepack parent;
	git_indexer_stream *indexer_stream;
};

Vicent Marti committed
35 36 37
/**
 * The wonderful tale of a Packed Object lookup query
 * ===================================================
Vicent Marti committed
38 39 40
 *	A riveting and epic story of epicness and ASCII
 *			art, presented by yours truly,
 *				Sir Vicent of Marti
Vicent Marti committed
41 42 43 44 45 46 47 48 49 50
 *
 *
 *	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
51
 * |
Vicent Marti committed
52
 *	|-# packfile_load_all
Vicent Marti committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
 *	 | 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
77 78 79 80 81 82 83
 *
 *
 *
 *	Chapter 2: To be, or not to be...
 *	A standard packed `exist` query for an OID
 *	--------------------------------------------------
 *
Vicent Marti committed
84 85 86 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
 * # 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
119 120 121 122 123 124 125 126 127
 *
 *
 *
 *	Chapter 3: The neverending story...
 *	A standard packed `lookup` query for an OID
 *	--------------------------------------------------
 *	TODO
 *
 */
128 129 130 131


/***********************************************************
 *
Vicent Marti committed
132
 * FORWARD DECLARATIONS
133 134 135
 *
 ***********************************************************/

Vicent Marti committed
136
static int packfile_sort__cb(const void *a_, const void *b_);
137

138
static int packfile_load__cb(void *_data, git_buf *path);
139

140
static int pack_entry_find(struct git_pack_entry *e,
141
	struct pack_backend *backend, const git_oid *oid);
142

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

Vicent Marti committed
155 156 157 158 159 160 161


/***********************************************************
 *
 * PACK WINDOW MANAGEMENT
 *
 ***********************************************************/
162

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

Vicent Marti committed
169 170
	/*
	 * Local packs tend to contain objects specific to our
Vicent Marti committed
171
	 * variant of the project than remote ones. In addition,
Vicent Marti committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
	 * 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;
190 191
}

Vicent Marti committed
192

193

194
static int packfile_load__cb(void *_data, git_buf *path)
195
{
196
	struct pack_backend *backend = (struct pack_backend *)_data;
197
	struct git_pack_file *pack;
Vicent Marti committed
198
	int error;
199
	size_t i;
200

201
	if (git__suffixcmp(path->ptr, ".idx") != 0)
202
		return 0; /* not an index */
203

204
	for (i = 0; i < backend->packs.length; ++i) {
205
		struct git_pack_file *p = git_vector_get(&backend->packs, i);
nulltoken committed
206
		if (memcmp(p->pack_name, git_buf_cstr(path), git_buf_len(path) - strlen(".idx")) == 0)
207
			return 0;
208
	}
209

210
	error = git_packfile_alloc(&pack, path->ptr);
211
	if (error == GIT_ENOTFOUND)
212
		/* ignore missing .pack file as git does */
213
		return 0;
214 215
	else if (error < 0)
		return error;
Vicent Marti committed
216

217
	return git_vector_insert(&backend->packs, pack);
218 219
}

220 221 222 223 224
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
225
{
226
	size_t i;
227

228 229
	if (last_found &&
		git_pack_entry_find(e, last_found, oid, GIT_OID_HEXSZ) == 0)
230
		return 0;
231

Vicent Marti committed
232
	for (i = 0; i < backend->packs.length; ++i) {
233
		struct git_pack_file *p;
234

Vicent Marti committed
235
		p = git_vector_get(&backend->packs, i);
236
		if (p == last_found)
Vicent Marti committed
237
			continue;
238

239
		if (git_pack_entry_find(e, p, oid, GIT_OID_HEXSZ) == 0) {
Vicent Marti committed
240
			backend->last_found = p;
241
			return 0;
242
		}
Vicent Marti committed
243 244
	}

245 246 247 248 249
	return -1;
}

static int pack_entry_find(struct git_pack_entry *e, struct pack_backend *backend, const git_oid *oid)
{
250
	struct git_pack_file *last_found = backend->last_found;
251 252 253 254 255

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

256
	if (!pack_entry_find_inner(e, backend, oid, last_found))
257 258
		return 0;

Russell Belfer committed
259
	return git_odb__error_notfound("failed to find pack entry", oid);
Vicent Marti committed
260 261
}

262 263 264 265 266 267
static unsigned pack_entry_find_prefix_inner(
		struct git_pack_entry *e,
		struct pack_backend *backend,
		const git_oid *short_oid,
		size_t len,
		struct git_pack_file *last_found)
268 269
{
	int error;
270
	size_t i;
271
	unsigned found = 0;
272

273 274
	if (last_found) {
		error = git_pack_entry_find(e, last_found, short_oid, len);
275 276 277
		if (error == GIT_EAMBIGUOUS)
			return error;
		if (!error)
278 279 280 281
			found = 1;
	}

	for (i = 0; i < backend->packs.length; ++i) {
282
		struct git_pack_file *p;
283 284

		p = git_vector_get(&backend->packs, i);
285
		if (p == last_found)
286 287
			continue;

288
		error = git_pack_entry_find(e, p, short_oid, len);
289 290 291 292
		if (error == GIT_EAMBIGUOUS)
			return error;
		if (!error) {
			if (++found > 1)
293 294 295 296 297
				break;
			backend->last_found = p;
		}
	}

298 299 300 301 302 303 304 305 306
	return found;
}

static int pack_entry_find_prefix(
	struct git_pack_entry *e,
	struct pack_backend *backend,
	const git_oid *short_oid,
	size_t len)
{
307
	struct git_pack_file *last_found = backend->last_found;
Vicent Marti committed
308
	unsigned int found = pack_entry_find_prefix_inner(e, backend, short_oid, len, last_found);
309

310
	if (!found)
Russell Belfer committed
311
		return git_odb__error_notfound("no matching pack entry for prefix", short_oid);
312 313 314 315
	else if (found > 1)
		return git_odb__error_ambiguous("found multiple pack entries");
	else
		return 0;
316 317
}

Vicent Marti committed
318

319 320 321 322 323 324 325
/***********************************************************
 *
 * PACKED BACKEND PUBLIC API
 *
 * Implement the git_odb_backend API calls
 *
 ***********************************************************/
Vicent Marti committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
static int pack_backend__refresh(git_odb_backend *_backend)
{
	struct pack_backend *backend = (struct pack_backend *)_backend;

	int error;
	struct stat st;
	git_buf path = GIT_BUF_INIT;

	if (backend->pack_folder == NULL)
		return 0;

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

	git_buf_sets(&path, backend->pack_folder);

	/* reload all packs */
	error = git_path_direach(&path, packfile_load__cb, (void *)backend);

	git_buf_free(&path);

	if (error < 0)
		return error;

	git_vector_sort(&backend->packs);
	return 0;
}

354

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

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

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

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

368
static int pack_backend__read(void **buffer_p, size_t *len_p, git_otype *type_p, git_odb_backend *backend, const git_oid *oid)
369
{
370
	struct git_pack_entry e;
Vicent Marti committed
371
	git_rawobj raw;
Vicent Marti committed
372
	int error;
373

374 375 376
	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
377 378 379 380 381

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

382
	return 0;
383 384
}

385
static int pack_backend__read_prefix(
Vicent Marti committed
386 387 388 389 390 391
	git_oid *out_oid,
	void **buffer_p,
	size_t *len_p,
	git_otype *type_p,
	git_odb_backend *backend,
	const git_oid *short_oid,
392
	size_t len)
393
{
394 395
	int error = 0;

396
	if (len < GIT_OID_MINPREFIXLEN)
397
		error = git_odb__error_ambiguous("prefix length too short");
398

399
	else if (len >= GIT_OID_HEXSZ) {
400
		/* We can fall back to regular read method */
401 402
		error = pack_backend__read(buffer_p, len_p, type_p, backend, short_oid);
		if (!error)
403 404
			git_oid_cpy(out_oid, short_oid);
	} else {
405
		struct git_pack_entry e;
406 407
		git_rawobj raw;

408 409 410 411 412 413 414 415 416
		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);
		}
417
	}
418

419
	return error;
420 421
}

422
static int pack_backend__exists(git_odb_backend *backend, const git_oid *oid)
423
{
424
	struct git_pack_entry e;
425
	return pack_entry_find(&e, (struct pack_backend *)backend, oid) == 0;
426 427
}

428
static int pack_backend__foreach(git_odb_backend *_backend, git_odb_foreach_cb cb, void *data)
429
{
430
	int error;
431 432 433 434 435 436 437 438
	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
439
	if ((error = pack_backend__refresh(_backend)) < 0)
440
		return error;
441 442

	git_vector_foreach(&backend->packs, i, p) {
443
		if ((error = git_pack_foreach_entry(p, cb, data)) < 0)
444
			return error;
445
	}
446

447 448 449
	return 0;
}

450 451 452 453 454 455 456 457 458 459 460 461 462 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 503 504 505 506 507 508 509 510
static int pack_backend__writepack_add(struct git_odb_writepack *_writepack, const void *data, size_t size, git_transfer_progress *stats)
{
	struct pack_writepack *writepack = (struct pack_writepack *)_writepack;

	assert(writepack);

	return git_indexer_stream_add(writepack->indexer_stream, data, size, stats);
}

static int pack_backend__writepack_commit(struct git_odb_writepack *_writepack, git_transfer_progress *stats)
{
	struct pack_writepack *writepack = (struct pack_writepack *)_writepack;

	assert(writepack);

	return git_indexer_stream_finalize(writepack->indexer_stream, stats);
}

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

	assert(writepack);

	git_indexer_stream_free(writepack->indexer_stream);
	git__free(writepack);
}

static int pack_backend__writepack(struct git_odb_writepack **out,
	git_odb_backend *_backend,
	git_transfer_progress_callback progress_cb,
	void *progress_payload)
{
	struct pack_backend *backend;
	struct pack_writepack *writepack;

	assert(out && _backend);

	*out = NULL;

	backend = (struct pack_backend *)_backend;

	writepack = git__calloc(1, sizeof(struct pack_writepack));
	GITERR_CHECK_ALLOC(writepack);

	if (git_indexer_stream_new(&writepack->indexer_stream,
		backend->pack_folder, progress_cb, progress_payload) < 0) {
		git__free(writepack);
		return -1;
	}

	writepack->parent.backend = _backend;
	writepack->parent.add = pack_backend__writepack_add;
	writepack->parent.commit = pack_backend__writepack_commit;
	writepack->parent.free = pack_backend__writepack_free;

	*out = (git_odb_writepack *)writepack;

	return 0;
}

511
static void pack_backend__free(git_odb_backend *_backend)
512
{
Vicent Marti committed
513
	struct pack_backend *backend;
514
	size_t i;
515 516 517

	assert(_backend);

Vicent Marti committed
518
	backend = (struct pack_backend *)_backend;
519

Vicent Marti committed
520
	for (i = 0; i < backend->packs.length; ++i) {
521
		struct git_pack_file *p = git_vector_get(&backend->packs, i);
522
		git_packfile_free(p);
Vicent Marti committed
523
	}
524

Vicent Marti committed
525
	git_vector_free(&backend->packs);
526 527
	git__free(backend->pack_folder);
	git__free(backend);
528 529
}

530
static int pack_backend__alloc(struct pack_backend **out, size_t initial_size)
531
{
532 533
	struct pack_backend *backend = git__calloc(1, sizeof(struct pack_backend));
	GITERR_CHECK_ALLOC(backend);
534

535 536
	if (git_vector_init(&backend->packs, initial_size, packfile_sort__cb) < 0) {
		git__free(backend);
537
		return -1;
538
	}
539

540
	backend->parent.version = GIT_ODB_BACKEND_VERSION;
541 542 543

	backend->parent.read = &pack_backend__read;
	backend->parent.read_prefix = &pack_backend__read_prefix;
544
	backend->parent.read_header = &pack_backend__read_header;
545
	backend->parent.exists = &pack_backend__exists;
Vicent Marti committed
546
	backend->parent.refresh = &pack_backend__refresh;
547
	backend->parent.foreach = &pack_backend__foreach;
548
	backend->parent.writepack = &pack_backend__writepack;
549 550
	backend->parent.free = &pack_backend__free;

551
	*out = backend;
552 553 554
	return 0;
}

555
int git_odb_backend_one_pack(git_odb_backend **backend_out, const char *idx)
556
{
557
	struct pack_backend *backend = NULL;
558
	struct git_pack_file *packfile = NULL;
559

560 561
	if (pack_backend__alloc(&backend, 1) < 0)
		return -1;
562

563 564
	if (git_packfile_alloc(&packfile, idx) < 0 ||
		git_vector_insert(&backend->packs, packfile) < 0)
565
	{
566
		pack_backend__free((git_odb_backend *)backend);
567 568
		return -1;
	}
569

570 571 572 573 574 575 576 577 578 579 580 581
	*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
582

583 584 585
	if (!(error = git_buf_joinpath(&path, objects_dir, "pack")) &&
		git_path_isdir(git_buf_cstr(&path)))
	{
586
		backend->pack_folder = git_buf_detach(&path);
587

Vicent Marti committed
588
		error = pack_backend__refresh((git_odb_backend *)backend);
Vicent Marti committed
589
	}
590

591 592 593 594
	if (error < 0) {
		pack_backend__free((git_odb_backend *)backend);
		backend = NULL;
	}
595 596

	*backend_out = (git_odb_backend *)backend;
597 598 599

	git_buf_free(&path);

600
	return error;
601
}