refs.c 114.6 KB
Newer Older
D
Daniel Barkalow 已提交
1
#include "cache.h"
2
#include "lockfile.h"
3
#include "refs.h"
4 5
#include "object.h"
#include "tag.h"
6
#include "dir.h"
7
#include "string-list.h"
D
Daniel Barkalow 已提交
8

9 10 11 12
struct ref_lock {
	char *ref_name;
	char *orig_ref_name;
	struct lock_file *lk;
13
	struct object_id old_oid;
14 15
};

16
/*
17 18
 * How to handle various characters in refnames:
 * 0: An acceptable character for refs
19 20 21 22
 * 1: End-of-component
 * 2: ., look for a preceding . to reject .. in refs
 * 3: {, look for a preceding @ to reject @{ in refs
 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
23 24
 */
static unsigned char refname_disposition[256] = {
25 26 27 28
	1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
	4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
	4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
29
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
30 31 32
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
33 34
};

35 36 37 38 39 40
/*
 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken
 * refs (i.e., because the reference is about to be deleted anyway).
 */
#define REF_DELETING	0x02

41
/*
42
 * Used as a flag in ref_update::flags when a loose ref is being
43 44
 * pruned.
 */
45 46
#define REF_ISPRUNING	0x04

47 48 49 50 51 52
/*
 * Used as a flag in ref_update::flags when the reference should be
 * updated to new_sha1.
 */
#define REF_HAVE_NEW	0x08

53 54 55 56
/*
 * Used as a flag in ref_update::flags when old_sha1 should be
 * checked.
 */
57
#define REF_HAVE_OLD	0x10
58

59 60 61 62 63 64
/*
 * Used as a flag in ref_update::flags when the lockfile needs to be
 * committed.
 */
#define REF_NEEDS_COMMIT 0x20

65 66 67 68 69
/*
 * Try to read one refname component from the front of refname.
 * Return the length of the component found, or -1 if the component is
 * not legal.  It is legal if it is something reasonable to have under
 * ".git/refs/"; We do not like it if:
70 71 72 73
 *
 * - any path component of it begins with ".", or
 * - it has double dots "..", or
 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
74 75
 * - it ends with a "/".
 * - it ends with ".lock"
76 77 78 79 80 81 82 83
 * - it contains a "\" (backslash)
 */
static int check_refname_component(const char *refname, int flags)
{
	const char *cp;
	char last = '\0';

	for (cp = refname; ; cp++) {
84 85 86
		int ch = *cp & 255;
		unsigned char disp = refname_disposition[ch];
		switch (disp) {
87
		case 1:
88
			goto out;
89
		case 2:
90 91 92
			if (last == '.')
				return -1; /* Refname contains "..". */
			break;
93
		case 3:
94 95
			if (last == '@')
				return -1; /* Refname contains "@{". */
96
			break;
97
		case 4:
98 99
			return -1;
		}
100 101
		last = ch;
	}
102
out:
103
	if (cp == refname)
104
		return 0; /* Component has zero length. */
105 106
	if (refname[0] == '.')
		return -1; /* Component starts with '.'. */
107 108
	if (cp - refname >= LOCK_SUFFIX_LEN &&
	    !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
109 110 111 112
		return -1; /* Refname ends with ".lock". */
	return cp - refname;
}

113
int check_refname_format(const char *refname, int flags)
114 115 116
{
	int component_len, component_count = 0;

F
Felipe Contreras 已提交
117 118 119 120
	if (!strcmp(refname, "@"))
		/* Refname is a single character '@'. */
		return -1;

121 122 123
	while (1) {
		/* We are at the start of a path component. */
		component_len = check_refname_component(refname, flags);
124
		if (component_len <= 0) {
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
			if ((flags & REFNAME_REFSPEC_PATTERN) &&
					refname[0] == '*' &&
					(refname[1] == '\0' || refname[1] == '/')) {
				/* Accept one wildcard as a full refname component. */
				flags &= ~REFNAME_REFSPEC_PATTERN;
				component_len = 1;
			} else {
				return -1;
			}
		}
		component_count++;
		if (refname[component_len] == '\0')
			break;
		/* Skip to next component. */
		refname += component_len + 1;
	}

	if (refname[component_len - 1] == '.')
		return -1; /* Refname ends with '.'. */
	if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
		return -1; /* Refname has only one component. */
	return 0;
}

struct ref_entry;
150

151 152 153 154 155 156
/*
 * Information used (along with the information in ref_entry) to
 * describe a single cached reference.  This data structure only
 * occurs embedded in a union in struct ref_entry, and only when
 * (ref_entry->flag & REF_DIR) is zero.
 */
157
struct ref_value {
158 159 160 161 162 163
	/*
	 * The name of the object to which this reference resolves
	 * (which may be a tag object).  If REF_ISBROKEN, this is
	 * null.  If REF_ISSYMREF, then this is the name of the object
	 * referred to by the last reference in the symlink chain.
	 */
164
	struct object_id oid;
165 166 167 168

	/*
	 * If REF_KNOWS_PEELED, then this field holds the peeled value
	 * of this reference, or null if the reference is known not to
169 170
	 * be peelable.  See the documentation for peel_ref() for an
	 * exact definition of "peelable".
171
	 */
172
	struct object_id peeled;
173 174
};

175 176
struct ref_cache;

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
/*
 * Information used (along with the information in ref_entry) to
 * describe a level in the hierarchy of references.  This data
 * structure only occurs embedded in a union in struct ref_entry, and
 * only when (ref_entry.flag & REF_DIR) is set.  In that case,
 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
 * in the directory have already been read:
 *
 *     (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
 *         or packed references, already read.
 *
 *     (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
 *         references that hasn't been read yet (nor has any of its
 *         subdirectories).
 *
 * Entries within a directory are stored within a growable array of
 * pointers to ref_entries (entries, nr, alloc).  Entries 0 <= i <
 * sorted are sorted by their component name in strcmp() order and the
 * remaining entries are unsorted.
 *
 * Loose references are read lazily, one directory at a time.  When a
 * directory of loose references is read, then all of the references
 * in that directory are stored, and REF_INCOMPLETE stubs are created
 * for any subdirectories, but the subdirectories themselves are not
 * read.  The reading is triggered by get_ref_dir().
 */
203
struct ref_dir {
204
	int nr, alloc;
205 206 207 208 209 210 211 212 213

	/*
	 * Entries with index 0 <= i < sorted are sorted by name.  New
	 * entries are appended to the list unsorted, and are sorted
	 * only when required; thus we avoid the need to sort the list
	 * after the addition of every reference.
	 */
	int sorted;

214 215 216
	/* A pointer to the ref_cache that contains this ref_dir. */
	struct ref_cache *ref_cache;

217
	struct ref_entry **entries;
218 219
};

220 221
/*
 * Bit values for ref_entry::flag.  REF_ISSYMREF=0x01,
222 223
 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
 * public values; see refs.h.
224 225 226 227 228 229 230
 */

/*
 * The field ref_entry->u.value.peeled of this value entry contains
 * the correct peeled value for the reference, which might be
 * null_sha1 if the reference is not a tag or if it is broken.
 */
231
#define REF_KNOWS_PEELED 0x10
232 233

/* ref_entry represents a directory of references */
234
#define REF_DIR 0x20
235

236 237 238 239
/*
 * Entry has not yet been read from disk (used only for REF_DIR
 * entries representing loose references)
 */
240
#define REF_INCOMPLETE 0x40
241

242 243
/*
 * A ref_entry represents either a reference or a "subdirectory" of
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
 * references.
 *
 * Each directory in the reference namespace is represented by a
 * ref_entry with (flags & REF_DIR) set and containing a subdir member
 * that holds the entries in that directory that have been read so
 * far.  If (flags & REF_INCOMPLETE) is set, then the directory and
 * its subdirectories haven't been read yet.  REF_INCOMPLETE is only
 * used for loose reference directories.
 *
 * References are represented by a ref_entry with (flags & REF_DIR)
 * unset and a value member that describes the reference's value.  The
 * flag member is at the ref_entry level, but it is also needed to
 * interpret the contents of the value field (in other words, a
 * ref_value object is not very much use without the enclosing
 * ref_entry).
259 260 261 262 263 264 265 266 267 268 269 270
 *
 * Reference names cannot end with slash and directories' names are
 * always stored with a trailing slash (except for the top-level
 * directory, which is always denoted by "").  This has two nice
 * consequences: (1) when the entries in each subdir are sorted
 * lexicographically by name (as they usually are), the references in
 * a whole tree can be generated in lexicographic order by traversing
 * the tree in left-to-right, depth-first order; (2) the names of
 * references and subdirectories cannot conflict, and therefore the
 * presence of an empty subdirectory does not block the creation of a
 * similarly-named reference.  (The fact that reference names with the
 * same leading components can conflict *with each other* is a
271
 * separate issue that is regulated by verify_refname_available().)
272 273 274 275 276 277 278 279 280
 *
 * Please note that the name field contains the fully-qualified
 * reference (or subdirectory) name.  Space could be saved by only
 * storing the relative names.  But that would require the full names
 * to be generated on the fly when iterating in do_for_each_ref(), and
 * would break callback functions, who have always been able to assume
 * that the name strings that they are passed will not be freed during
 * the iteration.
 */
281 282
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
283
	union {
284 285
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
286
	} u;
287 288 289 290 291
	/*
	 * The full name of the reference (e.g., "refs/heads/master")
	 * or the full name of the directory with a trailing slash
	 * (e.g., "refs/heads/"):
	 */
292 293
	char name[FLEX_ARRAY];
};
294

295 296
static void read_loose_refs(const char *dirname, struct ref_dir *dir);

297 298
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
299
	struct ref_dir *dir;
300
	assert(entry->flag & REF_DIR);
301 302 303 304 305 306
	dir = &entry->u.subdir;
	if (entry->flag & REF_INCOMPLETE) {
		read_loose_refs(entry->name, dir);
		entry->flag &= ~REF_INCOMPLETE;
	}
	return dir;
307 308
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
/*
 * Check if a refname is safe.
 * For refs that start with "refs/" we consider it safe as long they do
 * not try to resolve to outside of refs/.
 *
 * For all other refs we only consider them safe iff they only contain
 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
 * "config").
 */
static int refname_is_safe(const char *refname)
{
	if (starts_with(refname, "refs/")) {
		char *buf;
		int result;

		buf = xmalloc(strlen(refname) + 1);
		/*
		 * Does the refname try to escape refs/?
		 * For example: refs/foo/../bar is safe but refs/foo/../../bar
		 * is not.
		 */
		result = !normalize_path_copy(buf, refname + strlen("refs/"));
		free(buf);
		return result;
	}
	while (*refname) {
		if (!isupper(*refname) && *refname != '_')
			return 0;
		refname++;
	}
	return 1;
}

342 343 344
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
345 346
{
	int len;
347
	struct ref_entry *ref;
348

349
	if (check_name &&
350
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
351
		die("Reference has invalid format: '%s'", refname);
352 353
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
354 355
	hashcpy(ref->u.value.oid.hash, sha1);
	oidclr(&ref->u.value.peeled);
356 357 358 359 360
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

361 362
static void clear_ref_dir(struct ref_dir *dir);

363 364
static void free_ref_entry(struct ref_entry *entry)
{
365 366 367 368 369 370 371
	if (entry->flag & REF_DIR) {
		/*
		 * Do not use get_ref_dir() here, as that might
		 * trigger the reading of loose refs.
		 */
		clear_ref_dir(&entry->u.subdir);
	}
372 373 374
	free(entry);
}

375 376 377 378 379 380
/*
 * Add a ref_entry to the end of dir (unsorted).  Entry is always
 * stored directly in dir; no recursion into subdirectories is
 * done.
 */
static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
381
{
382 383
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
384 385 386 387 388 389
	/* optimize for the case that entries are added in order */
	if (dir->nr == 1 ||
	    (dir->nr == dir->sorted + 1 &&
	     strcmp(dir->entries[dir->nr - 2]->name,
		    dir->entries[dir->nr - 1]->name) < 0))
		dir->sorted = dir->nr;
390 391
}

392 393 394
/*
 * Clear and free all entries in dir, recursively.
 */
395
static void clear_ref_dir(struct ref_dir *dir)
396 397
{
	int i;
398 399 400 401 402
	for (i = 0; i < dir->nr; i++)
		free_ref_entry(dir->entries[i]);
	free(dir->entries);
	dir->sorted = dir->nr = dir->alloc = 0;
	dir->entries = NULL;
403 404
}

405 406 407 408 409
/*
 * Create a struct ref_entry object for the specified dirname.
 * dirname is the name of the directory with a trailing slash (e.g.,
 * "refs/heads/") or "" for the top-level directory.
 */
410
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
411 412
					  const char *dirname, size_t len,
					  int incomplete)
413 414 415
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
416 417
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
418
	direntry->u.subdir.ref_cache = ref_cache;
419
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
420 421 422
	return direntry;
}

423
static int ref_entry_cmp(const void *a, const void *b)
424
{
425 426 427 428
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
429

430
static void sort_ref_dir(struct ref_dir *dir);
431

432 433 434 435 436 437 438
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
439 440 441
	const struct string_slice *key = key_;
	const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
	int cmp = strncmp(key->str, ent->name, key->len);
442 443
	if (cmp)
		return cmp;
444
	return '\0' - (unsigned char)ent->name[key->len];
445 446
}

447
/*
448 449 450
 * Return the index of the entry with the given refname from the
 * ref_dir (non-recursively), sorting dir if necessary.  Return -1 if
 * no such entry is found.  dir must already be complete.
451
 */
452
static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
453
{
454 455
	struct ref_entry **r;
	struct string_slice key;
456

457
	if (refname == NULL || !dir->nr)
458
		return -1;
459

460
	sort_ref_dir(dir);
461 462 463 464
	key.len = len;
	key.str = refname;
	r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
		    ref_entry_cmp_sslice);
465 466

	if (r == NULL)
467
		return -1;
468

469
	return r - dir->entries;
470 471
}

472 473 474 475 476
/*
 * Search for a directory entry directly within dir (without
 * recursing).  Sort dir if necessary.  subdirname must be a directory
 * name (i.e., end in '/').  If mkdir is set, then create the
 * directory if it is missing; otherwise, return NULL if the desired
477
 * directory cannot be found.  dir must already be complete.
478
 */
479
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
480 481
					 const char *subdirname, size_t len,
					 int mkdir)
482
{
483 484 485
	int entry_index = search_ref_dir(dir, subdirname, len);
	struct ref_entry *entry;
	if (entry_index == -1) {
486 487
		if (!mkdir)
			return NULL;
488 489 490 491 492 493
		/*
		 * Since dir is complete, the absence of a subdir
		 * means that the subdir really doesn't exist;
		 * therefore, create an empty record for it but mark
		 * the record complete.
		 */
494
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
495
		add_entry_to_dir(dir, entry);
496 497
	} else {
		entry = dir->entries[entry_index];
498
	}
499
	return get_ref_dir(entry);
500 501
}

502 503 504 505
/*
 * If refname is a reference name, find the ref_dir within the dir
 * tree that should hold refname.  If refname is a directory name
 * (i.e., ends in '/'), then return that ref_dir itself.  dir must
506 507 508 509
 * represent the top-level directory and must already be complete.
 * Sort ref_dirs and recurse into subdirectories as necessary.  If
 * mkdir is set, then create any missing directories; otherwise,
 * return NULL if the desired directory cannot be found.
510 511 512 513
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
514 515
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
516
		size_t dirnamelen = slash - refname + 1;
517
		struct ref_dir *subdir;
518
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
519 520
		if (!subdir) {
			dir = NULL;
521
			break;
522
		}
523
		dir = subdir;
524 525 526 527 528 529 530 531 532 533 534 535
	}

	return dir;
}

/*
 * Find the value entry with the given name in dir, sorting ref_dirs
 * and recursing into subdirectories as necessary.  If the name is not
 * found or it corresponds to a directory entry, return NULL.
 */
static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
{
536
	int entry_index;
537 538 539 540
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
541 542 543 544 545
	entry_index = search_ref_dir(dir, refname, strlen(refname));
	if (entry_index == -1)
		return NULL;
	entry = dir->entries[entry_index];
	return (entry->flag & REF_DIR) ? NULL : entry;
546 547
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 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
/*
 * Remove the entry with the given name from dir, recursing into
 * subdirectories as necessary.  If refname is the name of a directory
 * (i.e., ends with '/'), then remove the directory and its contents.
 * If the removal was successful, return the number of entries
 * remaining in the directory entry that contained the deleted entry.
 * If the name was not found, return -1.  Please note that this
 * function only deletes the entry from the cache; it does not delete
 * it from the filesystem or ensure that other cache entries (which
 * might be symbolic references to the removed entry) are updated.
 * Nor does it remove any containing dir entries that might be made
 * empty by the removal.  dir must represent the top-level directory
 * and must already be complete.
 */
static int remove_entry(struct ref_dir *dir, const char *refname)
{
	int refname_len = strlen(refname);
	int entry_index;
	struct ref_entry *entry;
	int is_dir = refname[refname_len - 1] == '/';
	if (is_dir) {
		/*
		 * refname represents a reference directory.  Remove
		 * the trailing slash; otherwise we will get the
		 * directory *representing* refname rather than the
		 * one *containing* it.
		 */
		char *dirname = xmemdupz(refname, refname_len - 1);
		dir = find_containing_dir(dir, dirname, 0);
		free(dirname);
	} else {
		dir = find_containing_dir(dir, refname, 0);
	}
	if (!dir)
		return -1;
	entry_index = search_ref_dir(dir, refname, refname_len);
	if (entry_index == -1)
		return -1;
	entry = dir->entries[entry_index];

	memmove(&dir->entries[entry_index],
		&dir->entries[entry_index + 1],
		(dir->nr - entry_index - 1) * sizeof(*dir->entries)
		);
	dir->nr--;
	if (dir->sorted > entry_index)
		dir->sorted--;
	free_ref_entry(entry);
	return dir->nr;
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
}

/*
 * Add a ref_entry to the ref_dir (unsorted), recursing into
 * subdirectories as necessary.  dir must represent the top-level
 * directory.  Return 0 on success.
 */
static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
{
	dir = find_containing_dir(dir, ref->name, 1);
	if (!dir)
		return -1;
	add_entry_to_dir(dir, ref);
	return 0;
}

613 614 615 616 617 618 619
/*
 * Emit a warning and return true iff ref1 and ref2 have the same name
 * and the same sha1.  Die if they have the same name but different
 * sha1s.
 */
static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
{
620
	if (strcmp(ref1->name, ref2->name))
621
		return 0;
622 623 624 625 626 627 628

	/* Duplicate name; make sure that they don't conflict: */

	if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
		/* This is impossible by construction */
		die("Reference directory conflict: %s", ref1->name);

629
	if (oidcmp(&ref1->u.value.oid, &ref2->u.value.oid))
630 631 632 633
		die("Duplicated ref, and SHA1s don't match: %s", ref1->name);

	warning("Duplicated ref: %s", ref1->name);
	return 1;
634 635
}

636
/*
637 638
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
639
 */
640
static void sort_ref_dir(struct ref_dir *dir)
641
{
642
	int i, j;
643
	struct ref_entry *last = NULL;
644

645 646 647 648
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
649
	if (dir->sorted == dir->nr)
650
		return;
651

652
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
653

654 655 656 657 658 659 660
	/* Remove any duplicates: */
	for (i = 0, j = 0; j < dir->nr; j++) {
		struct ref_entry *entry = dir->entries[j];
		if (last && is_dup_ref(last, entry))
			free_ref_entry(entry);
		else
			last = dir->entries[i++] = entry;
661
	}
662
	dir->sorted = dir->nr = i;
663
}
664

665 666
/* Include broken references in a do_for_each_ref*() iteration: */
#define DO_FOR_EACH_INCLUDE_BROKEN 0x01
667

668 669 670 671 672 673 674 675 676
/*
 * Return true iff the reference described by entry can be resolved to
 * an object in the database.  Emit a warning if the referred-to
 * object does not exist.
 */
static int ref_resolves_to_object(struct ref_entry *entry)
{
	if (entry->flag & REF_ISBROKEN)
		return 0;
677
	if (!has_sha1_file(entry->u.value.oid.hash)) {
678 679 680 681 682
		error("%s does not point to a valid object!", entry->name);
		return 0;
	}
	return 1;
}
683

684 685 686 687 688 689 690 691 692
/*
 * current_ref is a performance hack: when iterating over references
 * using the for_each_ref*() functions, current_ref is set to the
 * current reference's entry before calling the callback function.  If
 * the callback function calls peel_ref(), then peel_ref() first
 * checks whether the reference to be peeled is the current reference
 * (it usually is) and if so, returns that reference's peeled version
 * if it is available.  This avoids a refname lookup in a common case.
 */
693
static struct ref_entry *current_ref;
694

695 696 697 698 699 700 701 702 703 704
typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);

struct ref_entry_cb {
	const char *base;
	int trim;
	int flags;
	each_ref_fn *fn;
	void *cb_data;
};

705
/*
706 707
 * Handle one reference in a do_for_each_ref*()-style iteration,
 * calling an each_ref_fn for each entry.
708
 */
709
static int do_one_ref(struct ref_entry *entry, void *cb_data)
710
{
711
	struct ref_entry_cb *data = cb_data;
712
	struct ref_entry *old_current_ref;
713
	int retval;
714

715
	if (!starts_with(entry->name, data->base))
716
		return 0;
717

718
	if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
719
	      !ref_resolves_to_object(entry))
720
		return 0;
721

722 723
	/* Store the old value, in case this is a recursive call: */
	old_current_ref = current_ref;
724
	current_ref = entry;
725
	retval = data->fn(entry->name + data->trim, &entry->u.value.oid,
726
			  entry->flag, data->cb_data);
727
	current_ref = old_current_ref;
728
	return retval;
729
}
730

731
/*
732
 * Call fn for each reference in dir that has index in the range
733 734
 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 * that index range, sorting them before iterating.  This function
735 736
 * does not sort dir itself; it should be sorted beforehand.  fn is
 * called for all references, including broken ones.
737
 */
738 739
static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
				    each_ref_entry_fn fn, void *cb_data)
740 741
{
	int i;
742 743
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
744 745 746
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
747 748
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
749
			retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
750
		} else {
751
			retval = fn(entry, cb_data);
752
		}
753 754 755 756 757 758
		if (retval)
			return retval;
	}
	return 0;
}

759
/*
760
 * Call fn for each reference in the union of dir1 and dir2, in order
761 762 763
 * by refname.  Recurse into subdirectories.  If a value entry appears
 * in both dir1 and dir2, then only process the version that is in
 * dir2.  The input dirs must already be sorted, but subdirs will be
764 765
 * sorted as needed.  fn is called for all references, including
 * broken ones.
766
 */
767 768 769
static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
				     struct ref_dir *dir2,
				     each_ref_entry_fn fn, void *cb_data)
770 771 772 773
{
	int retval;
	int i1 = 0, i2 = 0;

774 775
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
776 777 778 779
	while (1) {
		struct ref_entry *e1, *e2;
		int cmp;
		if (i1 == dir1->nr) {
780
			return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
781 782
		}
		if (i2 == dir2->nr) {
783
			return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
784 785 786 787 788 789 790
		}
		e1 = dir1->entries[i1];
		e2 = dir2->entries[i2];
		cmp = strcmp(e1->name, e2->name);
		if (cmp == 0) {
			if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
				/* Both are directories; descend them in parallel. */
791 792 793 794
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
795 796
				retval = do_for_each_entry_in_dirs(
						subdir1, subdir2, fn, cb_data);
797 798 799 800
				i1++;
				i2++;
			} else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
				/* Both are references; ignore the one from dir1. */
801
				retval = fn(e2, cb_data);
802 803 804 805 806 807
				i1++;
				i2++;
			} else {
				die("conflict between reference and directory: %s",
				    e1->name);
			}
808
		} else {
809 810 811
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
812
				i1++;
813 814 815 816 817
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
818 819
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
820 821
				retval = do_for_each_entry_in_dir(
						subdir, 0, fn, cb_data);
822
			} else {
823
				retval = fn(e, cb_data);
824 825 826 827 828 829 830
			}
		}
		if (retval)
			return retval;
	}
}

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
/*
 * Load all of the refs from the dir into our in-memory cache. The hard work
 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
 * through all of the sub-directories. We do not even need to care about
 * sorting, as traversal order does not matter to us.
 */
static void prime_ref_dir(struct ref_dir *dir)
{
	int i;
	for (i = 0; i < dir->nr; i++) {
		struct ref_entry *entry = dir->entries[i];
		if (entry->flag & REF_DIR)
			prime_ref_dir(get_ref_dir(entry));
	}
}
J
Jeff King 已提交
846 847

struct nonmatching_ref_data {
848
	const struct string_list *skip;
849
	const char *conflicting_refname;
850 851
};

J
Jeff King 已提交
852
static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata)
853
{
J
Jeff King 已提交
854 855
	struct nonmatching_ref_data *data = vdata;

856
	if (data->skip && string_list_has_string(data->skip, entry->name))
857
		return 0;
J
Jeff King 已提交
858

859
	data->conflicting_refname = entry->name;
J
Jeff King 已提交
860 861 862
	return 1;
}

863
/*
864 865
 * Return 0 if a reference named refname could be created without
 * conflicting with the name of an existing reference in dir.
866 867 868 869 870 871
 * Otherwise, return a negative value and write an explanation to err.
 * If extras is non-NULL, it is a list of additional refnames with
 * which refname is not allowed to conflict. If skip is non-NULL,
 * ignore potential conflicts with refs in skip (e.g., because they
 * are scheduled for deletion in the same operation). Behavior is
 * undefined if the same name is listed in both extras and skip.
J
Jeff King 已提交
872 873
 *
 * Two reference names conflict if one of them exactly matches the
874 875 876
 * leading components of the other; e.g., "refs/foo/bar" conflicts
 * with both "refs/foo" and with "refs/foo/bar/baz" but not with
 * "refs/foo/bar" or "refs/foo/barbados".
877
 *
878
 * extras and skip must be sorted.
879
 */
880 881 882
static int verify_refname_available(const char *refname,
				    const struct string_list *extras,
				    const struct string_list *skip,
883 884
				    struct ref_dir *dir,
				    struct strbuf *err)
885
{
J
Jeff King 已提交
886 887
	const char *slash;
	int pos;
888
	struct strbuf dirname = STRBUF_INIT;
889
	int ret = -1;
890

891 892 893 894
	/*
	 * For the sake of comments in this function, suppose that
	 * refname is "refs/foo/bar".
	 */
895

896 897
	assert(err);

898
	strbuf_grow(&dirname, strlen(refname) + 1);
J
Jeff King 已提交
899
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
900 901 902
		/* Expand dirname to the new prefix, not including the trailing slash: */
		strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);

J
Jeff King 已提交
903
		/*
904 905 906
		 * We are still at a leading dir of the refname (e.g.,
		 * "refs/foo"; if there is a reference with that name,
		 * it is a conflict, *unless* it is in skip.
J
Jeff King 已提交
907
		 */
908 909 910 911
		if (dir) {
			pos = search_ref_dir(dir, dirname.buf, dirname.len);
			if (pos >= 0 &&
			    (!skip || !string_list_has_string(skip, dirname.buf))) {
912
				/*
913 914 915
				 * We found a reference whose name is
				 * a proper prefix of refname; e.g.,
				 * "refs/foo", and is not in skip.
916
				 */
917 918
				strbuf_addf(err, "'%s' exists; cannot create '%s'",
					    dirname.buf, refname);
919
				goto cleanup;
920
			}
J
Jeff King 已提交
921 922
		}

923 924
		if (extras && string_list_has_string(extras, dirname.buf) &&
		    (!skip || !string_list_has_string(skip, dirname.buf))) {
925 926
			strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
				    refname, dirname.buf);
927 928
			goto cleanup;
		}
J
Jeff King 已提交
929 930 931

		/*
		 * Otherwise, we can try to continue our search with
932
		 * the next component. So try to look up the
933 934 935 936
		 * directory, e.g., "refs/foo/". If we come up empty,
		 * we know there is nothing under this whole prefix,
		 * but even in that case we still have to continue the
		 * search for conflicts with extras.
J
Jeff King 已提交
937
		 */
938
		strbuf_addch(&dirname, '/');
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
		if (dir) {
			pos = search_ref_dir(dir, dirname.buf, dirname.len);
			if (pos < 0) {
				/*
				 * There was no directory "refs/foo/",
				 * so there is nothing under this
				 * whole prefix. So there is no need
				 * to continue looking for conflicting
				 * references. But we need to continue
				 * looking for conflicting extras.
				 */
				dir = NULL;
			} else {
				dir = get_ref_dir(dir->entries[pos]);
			}
954
		}
J
Jeff King 已提交
955 956 957
	}

	/*
958 959 960 961 962 963
	 * We are at the leaf of our refname (e.g., "refs/foo/bar").
	 * There is no point in searching for a reference with that
	 * name, because a refname isn't considered to conflict with
	 * itself. But we still need to check for references whose
	 * names are in the "refs/foo/bar/" namespace, because they
	 * *do* conflict.
J
Jeff King 已提交
964
	 */
965
	strbuf_addstr(&dirname, refname + dirname.len);
966
	strbuf_addch(&dirname, '/');
J
Jeff King 已提交
967

968 969
	if (dir) {
		pos = search_ref_dir(dir, dirname.buf, dirname.len);
J
Jeff King 已提交
970

971 972 973 974 975 976 977 978 979 980 981 982 983 984
		if (pos >= 0) {
			/*
			 * We found a directory named "$refname/"
			 * (e.g., "refs/foo/bar/"). It is a problem
			 * iff it contains any ref that is not in
			 * "skip".
			 */
			struct nonmatching_ref_data data;

			data.skip = skip;
			data.conflicting_refname = NULL;
			dir = get_ref_dir(dir->entries[pos]);
			sort_ref_dir(dir);
			if (do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data)) {
985 986
				strbuf_addf(err, "'%s' exists; cannot create '%s'",
					    data.conflicting_refname, refname);
987 988 989 990 991 992
				goto cleanup;
			}
		}
	}

	if (extras) {
J
Jeff King 已提交
993
		/*
994 995 996 997 998 999
		 * Check for entries in extras that start with
		 * "$refname/". We do that by looking for the place
		 * where "$refname/" would be inserted in extras. If
		 * there is an entry at that position that starts with
		 * "$refname/" and is not in skip, then we have a
		 * conflict.
J
Jeff King 已提交
1000
		 */
1001 1002 1003
		for (pos = string_list_find_insert_index(extras, dirname.buf, 0);
		     pos < extras->nr; pos++) {
			const char *extra_refname = extras->items[pos].string;
J
Jeff King 已提交
1004

1005 1006
			if (!starts_with(extra_refname, dirname.buf))
				break;
J
Jeff King 已提交
1007

1008
			if (!skip || !string_list_has_string(skip, extra_refname)) {
1009 1010
				strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
					    refname, extra_refname);
1011 1012 1013
				goto cleanup;
			}
		}
1014
	}
J
Jeff King 已提交
1015

1016
	/* No conflicts were found */
1017
	ret = 0;
1018 1019 1020 1021

cleanup:
	strbuf_release(&dirname);
	return ret;
1022 1023
}

1024 1025
struct packed_ref_cache {
	struct ref_entry *root;
1026

1027 1028 1029 1030 1031 1032 1033 1034
	/*
	 * Count of references to the data structure in this instance,
	 * including the pointer from ref_cache::packed if any.  The
	 * data will not be freed as long as the reference count is
	 * nonzero.
	 */
	unsigned int referrers;

1035 1036 1037
	/*
	 * Iff the packed-refs file associated with this instance is
	 * currently locked for writing, this points at the associated
1038 1039 1040
	 * lock (which is owned by somebody else).  The referrer count
	 * is also incremented when the file is locked and decremented
	 * when it is unlocked.
1041 1042
	 */
	struct lock_file *lock;
1043 1044 1045

	/* The metadata from when this packed-refs cache was read */
	struct stat_validity validity;
1046 1047
};

1048 1049 1050 1051
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
1052 1053
static struct ref_cache {
	struct ref_cache *next;
1054
	struct ref_entry *loose;
1055
	struct packed_ref_cache *packed;
1056 1057 1058 1059 1060 1061 1062
	/*
	 * The submodule name, or "" for the main repo.  We allocate
	 * length 1 rather than FLEX_ARRAY so that the main ref_cache
	 * is initialized correctly.
	 */
	char name[1];
} ref_cache, *submodule_ref_caches;
1063

1064 1065 1066
/* Lock used for the main packed-refs file: */
static struct lock_file packlock;

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
/*
 * Increment the reference count of *packed_refs.
 */
static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
{
	packed_refs->referrers++;
}

/*
 * Decrease the reference count of *packed_refs.  If it goes to zero,
 * free *packed_refs and return true; otherwise return false.
 */
static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
{
	if (!--packed_refs->referrers) {
		free_ref_entry(packed_refs->root);
1083
		stat_validity_clear(&packed_refs->validity);
1084 1085 1086 1087 1088 1089 1090
		free(packed_refs);
		return 1;
	} else {
		return 0;
	}
}

1091
static void clear_packed_ref_cache(struct ref_cache *refs)
1092
{
1093
	if (refs->packed) {
1094 1095 1096
		struct packed_ref_cache *packed_refs = refs->packed;

		if (packed_refs->lock)
1097
			die("internal error: packed-ref cache cleared while locked");
1098
		refs->packed = NULL;
1099
		release_packed_ref_cache(packed_refs);
1100
	}
1101
}
1102

1103 1104
static void clear_loose_ref_cache(struct ref_cache *refs)
{
1105 1106 1107 1108
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
1109 1110
}

1111
static struct ref_cache *create_ref_cache(const char *submodule)
1112
{
1113
	int len;
1114
	struct ref_cache *refs;
1115 1116 1117
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
1118
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
1119
	memcpy(refs->name, submodule, len);
1120 1121 1122
	return refs;
}

1123
/*
1124
 * Return a pointer to a ref_cache for the specified submodule. For
1125 1126 1127 1128
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
1129
static struct ref_cache *get_ref_cache(const char *submodule)
1130
{
1131 1132 1133 1134 1135 1136
	struct ref_cache *refs;

	if (!submodule || !*submodule)
		return &ref_cache;

	for (refs = submodule_ref_caches; refs; refs = refs->next)
1137 1138 1139
		if (!strcmp(submodule, refs->name))
			return refs;

1140
	refs = create_ref_cache(submodule);
1141 1142
	refs->next = submodule_ref_caches;
	submodule_ref_caches = refs;
1143
	return refs;
1144 1145
}

1146 1147 1148
/* The length of a peeled reference line in packed-refs, including EOL: */
#define PEELED_LINE_LENGTH 42

1149 1150 1151 1152 1153 1154 1155
/*
 * The packed-refs header line that we write out.  Perhaps other
 * traits will be added later.  The trailing space is required.
 */
static const char PACKED_REFS_HEADER[] =
	"# pack-refs with: peeled fully-peeled \n";

1156 1157 1158 1159 1160
/*
 * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
 * Return a pointer to the refname within the line (null-terminated),
 * or NULL if there was a problem.
 */
1161
static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)
1162
{
1163 1164
	const char *ref;

1165 1166 1167 1168 1169 1170 1171 1172
	/*
	 * 42: the answer to everything.
	 *
	 * In this case, it happens to be the answer to
	 *  40 (length of sha1 hex representation)
	 *  +1 (space in between hex and name)
	 *  +1 (newline at the end of the line)
	 */
1173
	if (line->len <= 42)
1174
		return NULL;
1175 1176

	if (get_sha1_hex(line->buf, sha1) < 0)
1177
		return NULL;
1178
	if (!isspace(line->buf[40]))
1179
		return NULL;
1180 1181 1182

	ref = line->buf + 41;
	if (isspace(*ref))
1183
		return NULL;
1184 1185

	if (line->buf[line->len - 1] != '\n')
1186
		return NULL;
1187
	line->buf[--line->len] = 0;
1188

1189
	return ref;
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
/*
 * Read f, which is a packed-refs file, into dir.
 *
 * A comment line of the form "# pack-refs with: " may contain zero or
 * more traits. We interpret the traits as follows:
 *
 *   No traits:
 *
 *      Probably no references are peeled. But if the file contains a
 *      peeled value for a reference, we will use it.
 *
 *   peeled:
 *
 *      References under "refs/tags/", if they *can* be peeled, *are*
 *      peeled in this file. References outside of "refs/tags/" are
 *      probably not peeled even if they could have been, but if we find
 *      a peeled value for such a reference we will use it.
 *
 *   fully-peeled:
 *
 *      All references in the file that can be peeled are peeled.
 *      Inversely (and this is more important), any references in the
 *      file for which no peeled value is recorded is not peelable. This
 *      trait should typically be written alongside "peeled" for
 *      compatibility with older clients, but we do not require it
 *      (i.e., "peeled" is a no-op if "fully-peeled" is set).
 */
1219
static void read_packed_refs(FILE *f, struct ref_dir *dir)
1220
{
1221
	struct ref_entry *last = NULL;
1222
	struct strbuf line = STRBUF_INIT;
1223
	enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1224

1225
	while (strbuf_getwholeline(&line, f, '\n') != EOF) {
1226
		unsigned char sha1[20];
1227
		const char *refname;
1228
		const char *traits;
1229

1230
		if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {
1231 1232 1233 1234
			if (strstr(traits, " fully-peeled "))
				peeled = PEELED_FULLY;
			else if (strstr(traits, " peeled "))
				peeled = PEELED_TAGS;
1235 1236 1237 1238
			/* perhaps other traits later as well */
			continue;
		}

1239
		refname = parse_ref_line(&line, sha1);
1240
		if (refname) {
1241 1242 1243
			int flag = REF_ISPACKED;

			if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1244 1245
				if (!refname_is_safe(refname))
					die("packed refname is dangerous: %s", refname);
1246 1247 1248 1249
				hashclr(sha1);
				flag |= REF_BAD_NAME | REF_ISBROKEN;
			}
			last = create_ref_entry(refname, sha1, flag, 0);
1250
			if (peeled == PEELED_FULLY ||
1251
			    (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1252
				last->flag |= REF_KNOWS_PEELED;
1253
			add_ref(dir, last);
1254 1255 1256
			continue;
		}
		if (last &&
1257 1258 1259 1260
		    line.buf[0] == '^' &&
		    line.len == PEELED_LINE_LENGTH &&
		    line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&
		    !get_sha1_hex(line.buf + 1, sha1)) {
1261
			hashcpy(last->u.value.peeled.hash, sha1);
1262 1263 1264 1265 1266 1267 1268
			/*
			 * Regardless of what the file header said,
			 * we definitely know the value of *this*
			 * reference:
			 */
			last->flag |= REF_KNOWS_PEELED;
		}
1269
	}
1270 1271

	strbuf_release(&line);
1272 1273
}

1274 1275 1276 1277 1278
/*
 * Get the packed_ref_cache for the specified ref_cache, creating it
 * if necessary.
 */
static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1279
{
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
	const char *packed_refs_file;

	if (*refs->name)
		packed_refs_file = git_path_submodule(refs->name, "packed-refs");
	else
		packed_refs_file = git_path("packed-refs");

	if (refs->packed &&
	    !stat_validity_check(&refs->packed->validity, packed_refs_file))
		clear_packed_ref_cache(refs);

1291
	if (!refs->packed) {
1292
		FILE *f;
1293

1294
		refs->packed = xcalloc(1, sizeof(*refs->packed));
1295
		acquire_packed_ref_cache(refs->packed);
1296
		refs->packed->root = create_dir_entry(refs, "", 0, 0);
1297
		f = fopen(packed_refs_file, "r");
1298
		if (f) {
1299
			stat_validity_update(&refs->packed->validity, fileno(f));
1300
			read_packed_refs(f, get_ref_dir(refs->packed->root));
1301 1302 1303
			fclose(f);
		}
	}
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
	return refs->packed;
}

static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
{
	return get_ref_dir(packed_ref_cache->root);
}

static struct ref_dir *get_packed_refs(struct ref_cache *refs)
{
	return get_packed_ref_dir(get_packed_ref_cache(refs));
1315 1316
}

1317 1318
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
1319 1320 1321 1322 1323 1324
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);

	if (!packed_ref_cache->lock)
		die("internal error: packed refs not locked");
	add_ref(get_packed_ref_dir(packed_ref_cache),
1325
		create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1326 1327
}

1328
/*
1329 1330 1331
 * Read the loose references from the namespace dirname into dir
 * (without recursing).  dirname must end with '/'.  dir must be the
 * directory entry corresponding to dirname.
1332
 */
1333
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1334
{
1335
	struct ref_cache *refs = dir->ref_cache;
1336
	DIR *d;
1337
	const char *path;
1338
	struct dirent *de;
1339
	int dirnamelen = strlen(dirname);
1340
	struct strbuf refname;
1341

M
Michael Haggerty 已提交
1342
	if (*refs->name)
1343
		path = git_path_submodule(refs->name, "%s", dirname);
1344
	else
1345
		path = git_path("%s", dirname);
1346

1347
	d = opendir(path);
1348 1349 1350
	if (!d)
		return;

1351 1352
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
1353 1354 1355 1356 1357 1358 1359 1360 1361

	while ((de = readdir(d)) != NULL) {
		unsigned char sha1[20];
		struct stat st;
		int flag;
		const char *refdir;

		if (de->d_name[0] == '.')
			continue;
J
Jeff King 已提交
1362
		if (ends_with(de->d_name, ".lock"))
1363
			continue;
1364
		strbuf_addstr(&refname, de->d_name);
1365
		refdir = *refs->name
1366 1367 1368 1369 1370
			? git_path_submodule(refs->name, "%s", refname.buf)
			: git_path("%s", refname.buf);
		if (stat(refdir, &st) < 0) {
			; /* silently ignore */
		} else if (S_ISDIR(st.st_mode)) {
1371
			strbuf_addch(&refname, '/');
1372
			add_entry_to_dir(dir,
1373 1374
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
1375
		} else {
1376 1377
			int read_ok;

M
Michael Haggerty 已提交
1378
			if (*refs->name) {
1379
				hashclr(sha1);
1380
				flag = 0;
1381 1382 1383 1384 1385 1386 1387 1388 1389
				read_ok = !resolve_gitlink_ref(refs->name,
							       refname.buf, sha1);
			} else {
				read_ok = !read_ref_full(refname.buf,
							 RESOLVE_REF_READING,
							 sha1, &flag);
			}

			if (!read_ok) {
1390 1391
				hashclr(sha1);
				flag |= REF_ISBROKEN;
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
			} else if (is_null_sha1(sha1)) {
				/*
				 * It is so astronomically unlikely
				 * that NULL_SHA1 is the SHA-1 of an
				 * actual object that we consider its
				 * appearance in a loose reference
				 * file to be repo corruption
				 * (probably due to a software bug).
				 */
				flag |= REF_ISBROKEN;
1402
			}
1403

1404 1405
			if (check_refname_format(refname.buf,
						 REFNAME_ALLOW_ONELEVEL)) {
1406 1407
				if (!refname_is_safe(refname.buf))
					die("loose refname is dangerous: %s", refname.buf);
1408 1409 1410
				hashclr(sha1);
				flag |= REF_BAD_NAME | REF_ISBROKEN;
			}
1411
			add_entry_to_dir(dir,
1412
					 create_ref_entry(refname.buf, sha1, flag, 0));
1413
		}
1414
		strbuf_setlen(&refname, dirnamelen);
1415
	}
1416
	strbuf_release(&refname);
1417
	closedir(d);
1418 1419
}

1420
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1421
{
1422
	if (!refs->loose) {
1423 1424 1425 1426 1427
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
1428
		refs->loose = create_dir_entry(refs, "", 0, 0);
1429 1430 1431 1432
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
1433
				 create_dir_entry(refs, "refs/", 5, 1));
1434
	}
1435
	return get_ref_dir(refs->loose);
1436 1437
}

1438 1439
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
1440 1441
#define MAXREFLEN (1024)

1442 1443
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
1444 1445
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
1446
 */
1447
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1448
				      const char *refname, unsigned char *sha1)
1449
{
1450
	struct ref_entry *ref;
1451
	struct ref_dir *dir = get_packed_refs(refs);
1452

1453
	ref = find_ref(dir, refname);
1454 1455 1456
	if (ref == NULL)
		return -1;

1457
	hashcpy(sha1, ref->u.value.oid.hash);
1458
	return 0;
1459 1460
}

1461
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1462
					 const char *refname, unsigned char *sha1,
1463
					 int recursion)
1464
{
1465
	int fd, len;
1466
	char buffer[128], *p;
1467
	const char *path;
1468

1469
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1470
		return -1;
1471 1472 1473 1474
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
1475
	if (fd < 0)
1476
		return resolve_gitlink_packed_ref(refs, refname, sha1);
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

	len = read(fd, buffer, sizeof(buffer)-1);
	close(fd);
	if (len < 0)
		return -1;
	while (len && isspace(buffer[len-1]))
		len--;
	buffer[len] = 0;

	/* Was it a detached head or an old-fashioned symlink? */
1487
	if (!get_sha1_hex(buffer, sha1))
1488 1489 1490 1491 1492 1493 1494 1495 1496
		return 0;

	/* Symref? */
	if (strncmp(buffer, "ref:", 4))
		return -1;
	p = buffer + 4;
	while (isspace(*p))
		p++;

1497
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1498 1499
}

1500
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1501 1502
{
	int len = strlen(path), retval;
1503
	char *submodule;
1504
	struct ref_cache *refs;
1505 1506 1507 1508 1509

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1510 1511 1512 1513
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1514
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1515 1516
	return retval;
}
1517

1518
/*
1519 1520
 * Return the ref_entry for the given refname from the packed
 * references.  If it does not exist, return NULL.
1521
 */
1522
static struct ref_entry *get_packed_ref(const char *refname)
1523
{
1524
	return find_ref(get_packed_refs(&ref_cache), refname);
1525 1526
}

1527 1528 1529 1530
/*
 * A loose ref file doesn't exist; check for a packed ref.  The
 * options are forwarded from resolve_safe_unsafe().
 */
1531 1532 1533 1534
static int resolve_missing_loose_ref(const char *refname,
				     int resolve_flags,
				     unsigned char *sha1,
				     int *flags)
1535 1536 1537 1538 1539 1540 1541 1542 1543
{
	struct ref_entry *entry;

	/*
	 * The loose reference file does not exist; check for a packed
	 * reference.
	 */
	entry = get_packed_ref(refname);
	if (entry) {
1544
		hashcpy(sha1, entry->u.value.oid.hash);
1545 1546
		if (flags)
			*flags |= REF_ISPACKED;
1547
		return 0;
1548 1549
	}
	/* The reference is not a packed reference, either. */
1550
	if (resolve_flags & RESOLVE_REF_READING) {
1551 1552
		errno = ENOENT;
		return -1;
1553 1554
	} else {
		hashclr(sha1);
1555
		return 0;
1556 1557 1558
	}
}

1559
/* This function needs to return a meaningful errno on failure */
1560 1561 1562 1563 1564
static const char *resolve_ref_unsafe_1(const char *refname,
					int resolve_flags,
					unsigned char *sha1,
					int *flags,
					struct strbuf *sb_path)
1565
{
1566 1567
	int depth = MAXDEPTH;
	ssize_t len;
1568
	char buffer[256];
1569
	static char refname_buffer[256];
1570
	int bad_name = 0;
1571

1572 1573
	if (flags)
		*flags = 0;
1574

1575
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
		if (flags)
			*flags |= REF_BAD_NAME;

		if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
		    !refname_is_safe(refname)) {
			errno = EINVAL;
			return NULL;
		}
		/*
		 * dwim_ref() uses REF_ISBROKEN to distinguish between
		 * missing refs and refs that were present but invalid,
		 * to complain about the latter to stderr.
		 *
		 * We don't know whether the ref exists, so don't set
		 * REF_ISBROKEN yet.
		 */
		bad_name = 1;
1593
	}
1594
	for (;;) {
1595
		const char *path;
1596 1597 1598
		struct stat st;
		char *buf;
		int fd;
1599

1600 1601
		if (--depth < 0) {
			errno = ELOOP;
1602
			return NULL;
1603
		}
1604

1605 1606 1607
		strbuf_reset(sb_path);
		strbuf_git_path(sb_path, "%s", refname);
		path = sb_path->buf;
1608

1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
		/*
		 * We might have to loop back here to avoid a race
		 * condition: first we lstat() the file, then we try
		 * to read it as a link or as a file.  But if somebody
		 * changes the type of the file (file <-> directory
		 * <-> symlink) between the lstat() and reading, then
		 * we don't want to report that as an error but rather
		 * try again starting with the lstat().
		 */
	stat_ref:
1619
		if (lstat(path, &st) < 0) {
1620 1621 1622 1623
			if (errno != ENOENT)
				return NULL;
			if (resolve_missing_loose_ref(refname, resolve_flags,
						      sha1, flags))
1624
				return NULL;
1625 1626 1627 1628 1629 1630
			if (bad_name) {
				hashclr(sha1);
				if (flags)
					*flags |= REF_ISBROKEN;
			}
			return refname;
1631
		}
1632

1633 1634 1635
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1636 1637 1638 1639 1640 1641 1642
			if (len < 0) {
				if (errno == ENOENT || errno == EINVAL)
					/* inconsistent with lstat; retry */
					goto stat_ref;
				else
					return NULL;
			}
M
Michael Haggerty 已提交
1643
			buffer[len] = 0;
1644
			if (starts_with(buffer, "refs/") &&
1645
					!check_refname_format(buffer, 0)) {
1646 1647
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1648 1649
				if (flags)
					*flags |= REF_ISSYMREF;
1650 1651 1652 1653
				if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
					hashclr(sha1);
					return refname;
				}
1654 1655
				continue;
			}
1656
		}
1657

1658 1659 1660 1661 1662 1663
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1664 1665 1666 1667 1668
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
1669 1670 1671 1672 1673 1674 1675
		if (fd < 0) {
			if (errno == ENOENT)
				/* inconsistent with lstat; retry */
				goto stat_ref;
			else
				return NULL;
		}
1676
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1677 1678 1679 1680
		if (len < 0) {
			int save_errno = errno;
			close(fd);
			errno = save_errno;
1681
			return NULL;
1682 1683
		}
		close(fd);
1684 1685 1686
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1687 1688 1689 1690

		/*
		 * Is it a symbolic ref?
		 */
1691
		if (!starts_with(buffer, "ref:")) {
1692 1693 1694 1695 1696 1697
			/*
			 * Please note that FETCH_HEAD has a second
			 * line containing other data.
			 */
			if (get_sha1_hex(buffer, sha1) ||
			    (buffer[40] != '\0' && !isspace(buffer[40]))) {
1698 1699
				if (flags)
					*flags |= REF_ISBROKEN;
1700
				errno = EINVAL;
1701 1702
				return NULL;
			}
1703 1704 1705 1706 1707
			if (bad_name) {
				hashclr(sha1);
				if (flags)
					*flags |= REF_ISBROKEN;
			}
1708 1709
			return refname;
		}
1710 1711
		if (flags)
			*flags |= REF_ISSYMREF;
1712
		buf = buffer + 4;
1713 1714
		while (isspace(*buf))
			buf++;
1715 1716 1717 1718 1719
		refname = strcpy(refname_buffer, buf);
		if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
			hashclr(sha1);
			return refname;
		}
1720
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1721 1722
			if (flags)
				*flags |= REF_ISBROKEN;
1723 1724 1725 1726 1727 1728 1729

			if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
			    !refname_is_safe(buf)) {
				errno = EINVAL;
				return NULL;
			}
			bad_name = 1;
1730
		}
1731
	}
1732 1733
}

1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
			       unsigned char *sha1, int *flags)
{
	struct strbuf sb_path = STRBUF_INIT;
	const char *ret = resolve_ref_unsafe_1(refname, resolve_flags,
					       sha1, flags, &sb_path);
	strbuf_release(&sb_path);
	return ret;
}

1744
char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)
1745
{
1746
	return xstrdup_or_null(resolve_ref_unsafe(ref, resolve_flags, sha1, flags));
1747 1748
}

I
Ilari Liusvaara 已提交
1749 1750 1751 1752 1753 1754 1755
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1756
int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1757
{
1758
	if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
1759 1760
		return 0;
	return -1;
1761 1762
}

1763
int read_ref(const char *refname, unsigned char *sha1)
1764
{
1765
	return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
1766 1767
}

1768
int ref_exists(const char *refname)
1769
{
1770
	unsigned char sha1[20];
1771
	return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
1772 1773
}

1774
static int filter_refs(const char *refname, const struct object_id *oid,
1775
			   int flags, void *data)
I
Ilari Liusvaara 已提交
1776 1777
{
	struct ref_filter *filter = (struct ref_filter *)data;
1778

1779
	if (wildmatch(filter->pattern, refname, 0, NULL))
I
Ilari Liusvaara 已提交
1780
		return 0;
1781
	return filter->fn(refname, oid, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1782 1783
}

1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
enum peel_status {
	/* object was peeled successfully: */
	PEEL_PEELED = 0,

	/*
	 * object cannot be peeled because the named object (or an
	 * object referred to by a tag in the peel chain), does not
	 * exist.
	 */
	PEEL_INVALID = -1,

	/* object cannot be peeled because it is not a tag: */
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
	PEEL_NON_TAG = -2,

	/* ref_entry contains no peeled value because it is a symref: */
	PEEL_IS_SYMREF = -3,

	/*
	 * ref_entry cannot be peeled because it is broken (i.e., the
	 * symbolic reference cannot even be resolved to an object
	 * name):
	 */
	PEEL_BROKEN = -4
1807 1808
};

1809 1810
/*
 * Peel the named object; i.e., if the object is a tag, resolve the
1811 1812 1813 1814
 * tag recursively until a non-tag is found.  If successful, store the
 * result to sha1 and return PEEL_PEELED.  If the object is not a tag
 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
 * and leave sha1 unchanged.
1815
 */
1816
static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1817 1818 1819 1820 1821
{
	struct object *o = lookup_unknown_object(name);

	if (o->type == OBJ_NONE) {
		int type = sha1_object_info(name, NULL);
1822
		if (type < 0 || !object_as_type(o, type, 0))
1823
			return PEEL_INVALID;
1824 1825 1826
	}

	if (o->type != OBJ_TAG)
1827
		return PEEL_NON_TAG;
1828 1829 1830

	o = deref_tag_noverify(o);
	if (!o)
1831
		return PEEL_INVALID;
1832 1833

	hashcpy(sha1, o->sha1);
1834
	return PEEL_PEELED;
1835 1836
}

1837
/*
1838 1839 1840
 * Peel the entry (if possible) and return its new peel_status.  If
 * repeel is true, re-peel the entry even if there is an old peeled
 * value that is already stored in it.
1841 1842 1843 1844 1845 1846
 *
 * It is OK to call this function with a packed reference entry that
 * might be stale and might even refer to an object that has since
 * been garbage-collected.  In such a case, if the entry has
 * REF_KNOWS_PEELED then leave the status unchanged and return
 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1847
 */
1848
static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1849 1850 1851
{
	enum peel_status status;

1852 1853 1854
	if (entry->flag & REF_KNOWS_PEELED) {
		if (repeel) {
			entry->flag &= ~REF_KNOWS_PEELED;
1855
			oidclr(&entry->u.value.peeled);
1856
		} else {
1857
			return is_null_oid(&entry->u.value.peeled) ?
1858 1859 1860
				PEEL_NON_TAG : PEEL_PEELED;
		}
	}
1861 1862 1863 1864 1865
	if (entry->flag & REF_ISBROKEN)
		return PEEL_BROKEN;
	if (entry->flag & REF_ISSYMREF)
		return PEEL_IS_SYMREF;

1866
	status = peel_object(entry->u.value.oid.hash, entry->u.value.peeled.hash);
1867 1868 1869 1870 1871
	if (status == PEEL_PEELED || status == PEEL_NON_TAG)
		entry->flag |= REF_KNOWS_PEELED;
	return status;
}

1872
int peel_ref(const char *refname, unsigned char *sha1)
1873 1874 1875 1876
{
	int flag;
	unsigned char base[20];

1877
	if (current_ref && (current_ref->name == refname
1878
			    || !strcmp(current_ref->name, refname))) {
1879
		if (peel_entry(current_ref, 0))
1880
			return -1;
1881
		hashcpy(sha1, current_ref->u.value.peeled.hash);
1882
		return 0;
1883 1884
	}

1885
	if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1886 1887
		return -1;

1888 1889 1890 1891 1892 1893 1894 1895 1896
	/*
	 * If the reference is packed, read its ref_entry from the
	 * cache in the hope that we already know its peeled value.
	 * We only try this optimization on packed references because
	 * (a) forcing the filling of the loose reference cache could
	 * be expensive and (b) loose references anyway usually do not
	 * have REF_KNOWS_PEELED.
	 */
	if (flag & REF_ISPACKED) {
1897
		struct ref_entry *r = get_packed_ref(refname);
1898
		if (r) {
1899
			if (peel_entry(r, 0))
1900
				return -1;
1901
			hashcpy(sha1, r->u.value.peeled.hash);
1902
			return 0;
1903 1904 1905
		}
	}

1906
	return peel_object(base, sha1);
1907 1908
}

1909 1910 1911
struct warn_if_dangling_data {
	FILE *fp;
	const char *refname;
1912
	const struct string_list *refnames;
1913 1914 1915
	const char *msg_fmt;
};

1916
static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
1917 1918 1919 1920
				   int flags, void *cb_data)
{
	struct warn_if_dangling_data *d = cb_data;
	const char *resolves_to;
1921
	struct object_id junk;
1922 1923 1924 1925

	if (!(flags & REF_ISSYMREF))
		return 0;

1926
	resolves_to = resolve_ref_unsafe(refname, 0, junk.hash, NULL);
1927 1928 1929 1930
	if (!resolves_to
	    || (d->refname
		? strcmp(resolves_to, d->refname)
		: !string_list_has_string(d->refnames, resolves_to))) {
1931
		return 0;
1932
	}
1933 1934

	fprintf(d->fp, d->msg_fmt, refname);
J
Junio C Hamano 已提交
1935
	fputc('\n', d->fp);
1936 1937 1938 1939 1940 1941 1942 1943 1944
	return 0;
}

void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
{
	struct warn_if_dangling_data data;

	data.fp = fp;
	data.refname = refname;
1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
	data.refnames = NULL;
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
{
	struct warn_if_dangling_data data;

	data.fp = fp;
	data.refname = NULL;
	data.refnames = refnames;
1957 1958 1959 1960
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

1961
/*
1962
 * Call fn for each reference in the specified ref_cache, omitting
1963 1964
 * references not in the containing_dir of base.  fn is called for all
 * references, including broken ones.  If fn ever returns a non-zero
1965 1966 1967
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
1968
static int do_for_each_entry(struct ref_cache *refs, const char *base,
1969
			     each_ref_entry_fn fn, void *cb_data)
1970
{
1971 1972 1973
	struct packed_ref_cache *packed_ref_cache;
	struct ref_dir *loose_dir;
	struct ref_dir *packed_dir;
1974 1975
	int retval = 0;

1976 1977 1978 1979 1980 1981 1982 1983 1984
	/*
	 * We must make sure that all loose refs are read before accessing the
	 * packed-refs file; this avoids a race condition in which loose refs
	 * are migrated to the packed-refs file by a simultaneous process, but
	 * our in-memory view is from before the migration. get_packed_ref_cache()
	 * takes care of making sure our view is up to date with what is on
	 * disk.
	 */
	loose_dir = get_loose_refs(refs);
1985 1986 1987
	if (base && *base) {
		loose_dir = find_containing_dir(loose_dir, base, 0);
	}
1988 1989 1990 1991
	if (loose_dir)
		prime_ref_dir(loose_dir);

	packed_ref_cache = get_packed_ref_cache(refs);
1992
	acquire_packed_ref_cache(packed_ref_cache);
1993
	packed_dir = get_packed_ref_dir(packed_ref_cache);
1994 1995 1996 1997 1998 1999 2000
	if (base && *base) {
		packed_dir = find_containing_dir(packed_dir, base, 0);
	}

	if (packed_dir && loose_dir) {
		sort_ref_dir(packed_dir);
		sort_ref_dir(loose_dir);
2001 2002
		retval = do_for_each_entry_in_dirs(
				packed_dir, loose_dir, fn, cb_data);
2003 2004
	} else if (packed_dir) {
		sort_ref_dir(packed_dir);
2005 2006
		retval = do_for_each_entry_in_dir(
				packed_dir, 0, fn, cb_data);
2007 2008
	} else if (loose_dir) {
		sort_ref_dir(loose_dir);
2009 2010
		retval = do_for_each_entry_in_dir(
				loose_dir, 0, fn, cb_data);
2011 2012
	}

2013
	release_packed_ref_cache(packed_ref_cache);
2014
	return retval;
2015 2016
}

2017
/*
2018
 * Call fn for each reference in the specified ref_cache for which the
2019 2020 2021 2022 2023 2024 2025
 * refname begins with base.  If trim is non-zero, then trim that many
 * characters off the beginning of each refname before passing the
 * refname to fn.  flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
 * broken references in the iteration.  If fn ever returns a non-zero
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
2026 2027
static int do_for_each_ref(struct ref_cache *refs, const char *base,
			   each_ref_fn fn, int trim, int flags, void *cb_data)
2028 2029 2030 2031 2032 2033 2034 2035
{
	struct ref_entry_cb data;
	data.base = base;
	data.trim = trim;
	data.flags = flags;
	data.fn = fn;
	data.cb_data = cb_data;

2036 2037 2038 2039 2040
	if (ref_paranoia < 0)
		ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
	if (ref_paranoia)
		data.flags |= DO_FOR_EACH_INCLUDE_BROKEN;

2041
	return do_for_each_entry(refs, base, do_one_ref, &data);
2042 2043
}

2044
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
2045
{
2046
	struct object_id oid;
2047 2048
	int flag;

2049
	if (submodule) {
2050 2051
		if (resolve_gitlink_ref(submodule, "HEAD", oid.hash) == 0)
			return fn("HEAD", &oid, 0, cb_data);
2052 2053 2054 2055

		return 0;
	}

2056 2057
	if (!read_ref_full("HEAD", RESOLVE_REF_READING, oid.hash, &flag))
		return fn("HEAD", &oid, flag, cb_data);
2058

2059
	return 0;
2060 2061
}

2062 2063 2064 2065 2066
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

2067 2068 2069 2070 2071
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

2072
int for_each_ref(each_ref_fn fn, void *cb_data)
2073
{
2074
	return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
2075 2076
}

2077 2078
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
2079
	return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
2080 2081
}

2082 2083
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
2084
	return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
2085 2086
}

2087 2088 2089
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
2090
	return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
2091 2092
}

2093
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
2094
{
2095
	return for_each_ref_in("refs/tags/", fn, cb_data);
2096 2097
}

2098 2099 2100 2101 2102
int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
}

2103
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
2104
{
2105
	return for_each_ref_in("refs/heads/", fn, cb_data);
2106 2107
}

2108 2109 2110 2111 2112
int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
}

2113
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
2114
{
2115
	return for_each_ref_in("refs/remotes/", fn, cb_data);
2116 2117
}

2118 2119 2120 2121 2122
int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
}

2123 2124
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
2125
	return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
2126 2127
}

J
Josh Triplett 已提交
2128 2129 2130 2131
int head_ref_namespaced(each_ref_fn fn, void *cb_data)
{
	struct strbuf buf = STRBUF_INIT;
	int ret = 0;
2132
	struct object_id oid;
J
Josh Triplett 已提交
2133 2134 2135
	int flag;

	strbuf_addf(&buf, "%sHEAD", get_git_namespace());
2136 2137
	if (!read_ref_full(buf.buf, RESOLVE_REF_READING, oid.hash, &flag))
		ret = fn(buf.buf, &oid, flag, cb_data);
J
Josh Triplett 已提交
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
	strbuf_release(&buf);

	return ret;
}

int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
{
	struct strbuf buf = STRBUF_INIT;
	int ret;
	strbuf_addf(&buf, "%srefs/", get_git_namespace());
2148
	ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
J
Josh Triplett 已提交
2149 2150 2151 2152
	strbuf_release(&buf);
	return ret;
}

2153 2154
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
2155 2156 2157 2158 2159
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

2160
	if (!prefix && !starts_with(pattern, "refs/"))
I
Ilari Liusvaara 已提交
2161
		strbuf_addstr(&real_pattern, "refs/");
2162 2163
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
2164 2165
	strbuf_addstr(&real_pattern, pattern);

2166
	if (!has_glob_specials(pattern)) {
2167
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182
		if (real_pattern.buf[real_pattern.len - 1] != '/')
			strbuf_addch(&real_pattern, '/');
		/* No need to check for '*', there is none. */
		strbuf_addch(&real_pattern, '*');
	}

	filter.pattern = real_pattern.buf;
	filter.fn = fn;
	filter.cb_data = cb_data;
	ret = for_each_ref(filter_refs, &filter);

	strbuf_release(&real_pattern);
	return ret;
}

2183 2184 2185 2186 2187
int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
{
	return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
}

2188 2189
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
2190
	return do_for_each_ref(&ref_cache, "", fn, 0,
2191
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
2192 2193
}

2194
const char *prettify_refname(const char *name)
2195 2196
{
	return name + (
2197 2198 2199
		starts_with(name, "refs/heads/") ? 11 :
		starts_with(name, "refs/tags/") ? 10 :
		starts_with(name, "refs/remotes/") ? 13 :
2200 2201 2202
		0);
}

2203
static const char *ref_rev_parse_rules[] = {
S
Steffen Prohaska 已提交
2204 2205 2206 2207 2208 2209 2210 2211 2212
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

2213
int refname_match(const char *abbrev_name, const char *full_name)
S
Steffen Prohaska 已提交
2214 2215 2216 2217
{
	const char **p;
	const int abbrev_name_len = strlen(abbrev_name);

2218
	for (p = ref_rev_parse_rules; *p; p++) {
S
Steffen Prohaska 已提交
2219 2220 2221 2222 2223 2224 2225 2226
		if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
			return 1;
		}
	}

	return 0;
}

2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
static void unlock_ref(struct ref_lock *lock)
{
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
	free(lock->ref_name);
	free(lock->orig_ref_name);
	free(lock);
}

2237 2238 2239
/*
 * Verify that the reference locked by lock has the value old_sha1.
 * Fail if the reference doesn't exist and mustexist is set. Return 0
2240 2241
 * on success. On error, write an error message to err, set errno, and
 * return a negative value.
2242 2243
 */
static int verify_lock(struct ref_lock *lock,
2244 2245
		       const unsigned char *old_sha1, int mustexist,
		       struct strbuf *err)
2246
{
2247 2248
	assert(err);

2249 2250
	if (read_ref_full(lock->ref_name,
			  mustexist ? RESOLVE_REF_READING : 0,
2251
			  lock->old_oid.hash, NULL)) {
2252
		int save_errno = errno;
2253
		strbuf_addf(err, "can't verify ref %s", lock->ref_name);
2254
		errno = save_errno;
2255
		return -1;
2256
	}
2257
	if (hashcmp(lock->old_oid.hash, old_sha1)) {
2258
		strbuf_addf(err, "ref %s is at %s but expected %s",
2259
			    lock->ref_name,
2260
			    sha1_to_hex(lock->old_oid.hash),
2261
			    sha1_to_hex(old_sha1));
2262
		errno = EBUSY;
2263
		return -1;
2264
	}
2265
	return 0;
2266 2267
}

2268
static int remove_empty_directories(const char *file)
2269 2270 2271 2272 2273
{
	/* we want to create a file but there is a directory there;
	 * if that is an empty directory (or a directory that contains
	 * only empty directories), remove them.
	 */
2274
	struct strbuf path;
2275
	int result, save_errno;
2276

2277 2278 2279
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

2280
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
2281
	save_errno = errno;
2282 2283

	strbuf_release(&path);
2284
	errno = save_errno;
2285 2286

	return result;
2287 2288
}

2289 2290 2291 2292 2293 2294 2295 2296
/*
 * *string and *len will only be substituted, and *string returned (for
 * later free()ing) if the string passed in is a magic short-hand form
 * to name a branch.
 */
static char *substitute_branch_name(const char **string, int *len)
{
	struct strbuf buf = STRBUF_INIT;
2297
	int ret = interpret_branch_name(*string, *len, &buf);
2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323

	if (ret == *len) {
		size_t size;
		*string = strbuf_detach(&buf, &size);
		*len = size;
		return (char *)*string;
	}

	return NULL;
}

int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
{
	char *last_branch = substitute_branch_name(&str, &len);
	const char **p, *r;
	int refs_found = 0;

	*ref = NULL;
	for (p = ref_rev_parse_rules; *p; p++) {
		char fullref[PATH_MAX];
		unsigned char sha1_from_ref[20];
		unsigned char *this_result;
		int flag;

		this_result = refs_found ? sha1_from_ref : sha1;
		mksnpath(fullref, sizeof(fullref), *p, len, str);
2324 2325
		r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
				       this_result, &flag);
2326 2327 2328 2329 2330
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
2331
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2332
			warning("ignoring dangling symref %s.", fullref);
2333 2334 2335
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353
	}
	free(last_branch);
	return refs_found;
}

int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
{
	char *last_branch = substitute_branch_name(&str, &len);
	const char **p;
	int logs_found = 0;

	*log = NULL;
	for (p = ref_rev_parse_rules; *p; p++) {
		unsigned char hash[20];
		char path[PATH_MAX];
		const char *ref, *it;

		mksnpath(path, sizeof(path), *p, len, str);
2354 2355
		ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
					 hash, NULL);
2356 2357
		if (!ref)
			continue;
2358
		if (reflog_exists(path))
2359
			it = path;
2360
		else if (strcmp(ref, path) && reflog_exists(ref))
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374
			it = ref;
		else
			continue;
		if (!logs_found++) {
			*log = xstrdup(it);
			hashcpy(sha1, hash);
		}
		if (!warn_ambiguous_refs)
			break;
	}
	free(last_branch);
	return logs_found;
}

2375
/*
2376
 * Locks a ref returning the lock on success and NULL on failure.
2377 2378
 * On failure errno is set to something meaningful.
 */
2379 2380
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
2381
					    const struct string_list *extras,
2382
					    const struct string_list *skip,
2383 2384
					    unsigned int flags, int *type_p,
					    struct strbuf *err)
2385
{
2386
	const char *ref_file;
2387
	const char *orig_refname = refname;
2388
	struct ref_lock *lock;
2389
	int last_errno = 0;
2390
	int type, lflags;
2391
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2392
	int resolve_flags = 0;
2393
	int attempts_remaining = 3;
2394

2395
	assert(err);
2396 2397 2398

	lock = xcalloc(1, sizeof(struct ref_lock));

2399 2400
	if (mustexist)
		resolve_flags |= RESOLVE_REF_READING;
2401 2402 2403 2404 2405
	if (flags & REF_DELETING) {
		resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
		if (flags & REF_NODEREF)
			resolve_flags |= RESOLVE_REF_NO_RECURSE;
	}
2406 2407

	refname = resolve_ref_unsafe(refname, resolve_flags,
2408
				     lock->old_oid.hash, &type);
2409
	if (!refname && errno == EISDIR) {
2410 2411 2412 2413 2414
		/* we are trying to lock foo but we used to
		 * have foo/bar which now does not exist;
		 * it is normal for the empty directory 'foo'
		 * to remain.
		 */
2415
		ref_file = git_path("%s", orig_refname);
2416 2417
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
2418 2419 2420 2421 2422 2423

			if (!verify_refname_available(orig_refname, extras, skip,
						      get_loose_refs(&ref_cache), err))
				strbuf_addf(err, "there are still refs under '%s'",
					    orig_refname);

2424 2425
			goto error_return;
		}
2426
		refname = resolve_ref_unsafe(orig_refname, resolve_flags,
2427
					     lock->old_oid.hash, &type);
2428
	}
2429 2430
	if (type_p)
	    *type_p = type;
2431
	if (!refname) {
2432
		last_errno = errno;
2433 2434 2435 2436 2437 2438
		if (last_errno != ENOTDIR ||
		    !verify_refname_available(orig_refname, extras, skip,
					      get_loose_refs(&ref_cache), err))
			strbuf_addf(err, "unable to resolve reference %s: %s",
				    orig_refname, strerror(last_errno));

2439
		goto error_return;
2440
	}
2441 2442 2443 2444 2445
	/*
	 * If the ref did not exist and we are creating it, make sure
	 * there is no existing packed ref whose name begins with our
	 * refname, nor a packed ref whose name is a proper prefix of
	 * our refname.
2446
	 */
2447
	if (is_null_oid(&lock->old_oid) &&
2448
	    verify_refname_available(refname, extras, skip,
2449
				     get_packed_refs(&ref_cache), err)) {
2450
		last_errno = ENOTDIR;
2451
		goto error_return;
2452
	}
2453

2454
	lock->lk = xcalloc(1, sizeof(struct lock_file));
2455

2456
	lflags = 0;
2457
	if (flags & REF_NODEREF) {
2458
		refname = orig_refname;
2459
		lflags |= LOCK_NO_DEREF;
2460
	}
2461 2462 2463
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
2464

2465
 retry:
2466
	switch (safe_create_leading_directories_const(ref_file)) {
2467 2468 2469 2470 2471 2472 2473
	case SCLD_OK:
		break; /* success */
	case SCLD_VANISHED:
		if (--attempts_remaining > 0)
			goto retry;
		/* fall through */
	default:
2474
		last_errno = errno;
2475
		strbuf_addf(err, "unable to create directory for %s", ref_file);
2476 2477
		goto error_return;
	}
2478

2479
	if (hold_lock_file_for_update(lock->lk, ref_file, lflags) < 0) {
2480
		last_errno = errno;
2481 2482 2483 2484 2485 2486 2487
		if (errno == ENOENT && --attempts_remaining > 0)
			/*
			 * Maybe somebody just deleted one of the
			 * directories leading to ref_file.  Try
			 * again:
			 */
			goto retry;
2488
		else {
2489
			unable_to_lock_message(ref_file, errno, err);
2490 2491
			goto error_return;
		}
2492
	}
2493
	if (old_sha1 && verify_lock(lock, old_sha1, mustexist, err)) {
2494 2495 2496
		last_errno = errno;
		goto error_return;
	}
2497
	return lock;
2498 2499 2500 2501 2502

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
2503 2504
}

2505 2506 2507 2508
/*
 * Write an entry to the packed-refs file for the specified refname.
 * If peeled is non-NULL, write it as the entry's peeled value.
 */
2509
static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2510
			       unsigned char *peeled)
2511
{
2512 2513 2514
	fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
	if (peeled)
		fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2515 2516
}

2517 2518 2519 2520 2521 2522 2523 2524 2525 2526
/*
 * An each_ref_entry_fn that writes the entry to a packed-refs file.
 */
static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
{
	enum peel_status peel_status = peel_entry(entry, 0);

	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
		error("internal error: %s is not a valid packed reference!",
		      entry->name);
2527
	write_packed_entry(cb_data, entry->name, entry->u.value.oid.hash,
2528
			   peel_status == PEEL_PEELED ?
2529
			   entry->u.value.peeled.hash : NULL);
2530 2531 2532
	return 0;
}

2533
/* This should return a meaningful errno on failure */
2534 2535
int lock_packed_refs(int flags)
{
2536 2537 2538
	static int timeout_configured = 0;
	static int timeout_value = 1000;

2539 2540
	struct packed_ref_cache *packed_ref_cache;

2541 2542 2543 2544 2545 2546 2547 2548
	if (!timeout_configured) {
		git_config_get_int("core.packedrefstimeout", &timeout_value);
		timeout_configured = 1;
	}

	if (hold_lock_file_for_update_timeout(
			    &packlock, git_path("packed-refs"),
			    flags, timeout_value) < 0)
2549
		return -1;
2550 2551 2552 2553 2554 2555
	/*
	 * Get the current packed-refs while holding the lock.  If the
	 * packed-refs file has been modified since we last read it,
	 * this will automatically invalidate the cache and re-read
	 * the packed-refs file.
	 */
2556 2557
	packed_ref_cache = get_packed_ref_cache(&ref_cache);
	packed_ref_cache->lock = &packlock;
2558 2559
	/* Increment the reference count to prevent it from being freed: */
	acquire_packed_ref_cache(packed_ref_cache);
2560 2561 2562
	return 0;
}

2563 2564 2565 2566
/*
 * Commit the packed refs changes.
 * On error we must make sure that errno contains a meaningful value.
 */
2567 2568 2569 2570 2571
int commit_packed_refs(void)
{
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);
	int error = 0;
2572
	int save_errno = 0;
2573
	FILE *out;
2574 2575 2576 2577

	if (!packed_ref_cache->lock)
		die("internal error: packed-refs not locked");

2578
	out = fdopen_lock_file(packed_ref_cache->lock, "w");
2579 2580 2581 2582
	if (!out)
		die_errno("unable to fdopen packed-refs descriptor");

	fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2583
	do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2584 2585
				 0, write_packed_entry_fn, out);

2586 2587
	if (commit_lock_file(packed_ref_cache->lock)) {
		save_errno = errno;
2588
		error = -1;
2589
	}
2590
	packed_ref_cache->lock = NULL;
2591
	release_packed_ref_cache(packed_ref_cache);
2592
	errno = save_errno;
2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604
	return error;
}

void rollback_packed_refs(void)
{
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);

	if (!packed_ref_cache->lock)
		die("internal error: packed-refs not locked");
	rollback_lock_file(packed_ref_cache->lock);
	packed_ref_cache->lock = NULL;
2605
	release_packed_ref_cache(packed_ref_cache);
2606 2607 2608
	clear_packed_ref_cache(&ref_cache);
}

2609 2610 2611 2612 2613 2614 2615 2616
struct ref_to_prune {
	struct ref_to_prune *next;
	unsigned char sha1[20];
	char name[FLEX_ARRAY];
};

struct pack_refs_cb_data {
	unsigned int flags;
2617
	struct ref_dir *packed_refs;
2618 2619 2620
	struct ref_to_prune *ref_to_prune;
};

2621 2622 2623 2624 2625 2626 2627
/*
 * An each_ref_entry_fn that is run over loose references only.  If
 * the loose reference can be packed, add an entry in the packed ref
 * cache.  If the reference should be pruned, also add it to
 * ref_to_prune in the pack_refs_cb_data.
 */
static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2628 2629
{
	struct pack_refs_cb_data *cb = cb_data;
2630
	enum peel_status peel_status;
2631
	struct ref_entry *packed_entry;
2632
	int is_tag_ref = starts_with(entry->name, "refs/tags/");
2633

2634 2635
	/* ALWAYS pack tags */
	if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2636 2637
		return 0;

2638 2639 2640 2641
	/* Do not pack symbolic or broken refs: */
	if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
		return 0;

2642
	/* Add a packed ref cache entry equivalent to the loose entry. */
2643
	peel_status = peel_entry(entry, 1);
2644
	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2645
		die("internal error peeling reference %s (%s)",
2646
		    entry->name, oid_to_hex(&entry->u.value.oid));
2647 2648 2649 2650
	packed_entry = find_ref(cb->packed_refs, entry->name);
	if (packed_entry) {
		/* Overwrite existing packed entry with info from loose entry */
		packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2651
		oidcpy(&packed_entry->u.value.oid, &entry->u.value.oid);
2652
	} else {
2653
		packed_entry = create_ref_entry(entry->name, entry->u.value.oid.hash,
2654 2655 2656
						REF_ISPACKED | REF_KNOWS_PEELED, 0);
		add_ref(cb->packed_refs, packed_entry);
	}
2657
	oidcpy(&packed_entry->u.value.peeled, &entry->u.value.peeled);
2658

2659 2660
	/* Schedule the loose reference for pruning if requested. */
	if ((cb->flags & PACK_REFS_PRUNE)) {
2661
		int namelen = strlen(entry->name) + 1;
2662
		struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2663
		hashcpy(n->sha1, entry->u.value.oid.hash);
2664
		strcpy(n->name, entry->name);
2665 2666 2667
		n->next = cb->ref_to_prune;
		cb->ref_to_prune = n;
	}
2668 2669 2670
	return 0;
}

2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704
/*
 * Remove empty parents, but spare refs/ and immediate subdirs.
 * Note: munges *name.
 */
static void try_remove_empty_parents(char *name)
{
	char *p, *q;
	int i;
	p = name;
	for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
		while (*p && *p != '/')
			p++;
		/* tolerate duplicate slashes; see check_refname_format() */
		while (*p == '/')
			p++;
	}
	for (q = p; *q; q++)
		;
	while (1) {
		while (q > p && *q != '/')
			q--;
		while (q > p && *(q-1) == '/')
			q--;
		if (q == p)
			break;
		*q = '\0';
		if (rmdir(git_path("%s", name)))
			break;
	}
}

/* make sure nobody touched the ref, and unlink */
static void prune_ref(struct ref_to_prune *r)
{
2705 2706
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
2707

2708
	if (check_refname_format(r->name, 0))
R
Ronnie Sahlberg 已提交
2709
		return;
2710

2711 2712 2713
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
	    ref_transaction_delete(transaction, r->name, r->sha1,
2714
				   REF_ISPRUNING, NULL, &err) ||
2715
	    ref_transaction_commit(transaction, &err)) {
2716 2717 2718 2719
		ref_transaction_free(transaction);
		error("%s", err.buf);
		strbuf_release(&err);
		return;
2720
	}
2721 2722 2723
	ref_transaction_free(transaction);
	strbuf_release(&err);
	try_remove_empty_parents(r->name);
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740
}

static void prune_refs(struct ref_to_prune *r)
{
	while (r) {
		prune_ref(r);
		r = r->next;
	}
}

int pack_refs(unsigned int flags)
{
	struct pack_refs_cb_data cbdata;

	memset(&cbdata, 0, sizeof(cbdata));
	cbdata.flags = flags;

2741
	lock_packed_refs(LOCK_DIE_ON_ERROR);
2742
	cbdata.packed_refs = get_packed_refs(&ref_cache);
2743

2744 2745
	do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
				 pack_if_possible_fn, &cbdata);
2746

2747
	if (commit_packed_refs())
2748
		die_errno("unable to overwrite old ref-pack file");
2749

2750 2751 2752 2753
	prune_refs(cbdata.ref_to_prune);
	return 0;
}

2754
int repack_without_refs(struct string_list *refnames, struct strbuf *err)
J
Junio C Hamano 已提交
2755
{
2756
	struct ref_dir *packed;
J
Jeff King 已提交
2757
	struct string_list_item *refname;
2758
	int ret, needs_repacking = 0, removed = 0;
2759

2760 2761
	assert(err);

2762
	/* Look for a packed ref */
2763 2764 2765
	for_each_string_list_item(refname, refnames) {
		if (get_packed_ref(refname->string)) {
			needs_repacking = 1;
2766
			break;
2767 2768
		}
	}
2769

2770
	/* Avoid locking if we have nothing to do */
2771
	if (!needs_repacking)
2772
		return 0; /* no refname exists in packed refs */
2773

2774
	if (lock_packed_refs(0)) {
2775 2776
		unable_to_lock_message(git_path("packed-refs"), errno, err);
		return -1;
2777
	}
2778
	packed = get_packed_refs(&ref_cache);
2779

2780
	/* Remove refnames from the cache */
2781 2782
	for_each_string_list_item(refname, refnames)
		if (remove_entry(packed, refname->string) != -1)
2783 2784
			removed = 1;
	if (!removed) {
2785
		/*
2786
		 * All packed entries disappeared while we were
2787 2788
		 * acquiring the lock.
		 */
2789
		rollback_packed_refs();
2790 2791
		return 0;
	}
2792

2793
	/* Write what remains */
2794
	ret = commit_packed_refs();
2795
	if (ret)
2796 2797 2798
		strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
			    strerror(errno));
	return ret;
J
Junio C Hamano 已提交
2799 2800
}

2801
static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2802
{
2803 2804
	assert(err);

2805
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2806 2807 2808 2809
		/*
		 * loose.  The loose file name is the same as the
		 * lockfile name, minus ".lock":
		 */
2810
		char *loose_filename = get_locked_file_path(lock->lk);
2811
		int res = unlink_or_msg(loose_filename, err);
2812
		free(loose_filename);
2813
		if (res)
2814
			return 1;
J
Junio C Hamano 已提交
2815
	}
2816 2817 2818
	return 0;
}

2819
int delete_ref(const char *refname, const unsigned char *sha1, unsigned int flags)
J
Junio C Hamano 已提交
2820
{
2821 2822
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
J
Junio C Hamano 已提交
2823

2824 2825
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
2826 2827 2828
	    ref_transaction_delete(transaction, refname,
				   (sha1 && !is_null_sha1(sha1)) ? sha1 : NULL,
				   flags, NULL, &err) ||
2829
	    ref_transaction_commit(transaction, &err)) {
2830 2831 2832
		error("%s", err.buf);
		ref_transaction_free(transaction);
		strbuf_release(&err);
J
Junio C Hamano 已提交
2833
		return 1;
2834 2835 2836 2837
	}
	ref_transaction_free(transaction);
	strbuf_release(&err);
	return 0;
2838 2839
}

2840 2841 2842 2843 2844 2845 2846 2847 2848
/*
 * People using contrib's git-new-workdir have .git/logs/refs ->
 * /some/other/path/.git/logs/refs, and that may live on another device.
 *
 * IOW, to avoid cross device rename errors, the temporary renamed log must
 * live into logs/refs.
 */
#define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"

2849 2850
static int rename_tmp_log(const char *newrefname)
{
2851
	int attempts_remaining = 4;
2852 2853

 retry:
2854
	switch (safe_create_leading_directories_const(git_path("logs/%s", newrefname))) {
2855 2856 2857 2858 2859 2860 2861
	case SCLD_OK:
		break; /* success */
	case SCLD_VANISHED:
		if (--attempts_remaining > 0)
			goto retry;
		/* fall through */
	default:
2862 2863 2864 2865 2866
		error("unable to create directory for %s", newrefname);
		return -1;
	}

	if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2867
		if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877
			/*
			 * rename(a, b) when b is an existing
			 * directory ought to result in ISDIR, but
			 * Solaris 5.8 gives ENOTDIR.  Sheesh.
			 */
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
				return -1;
			}
			goto retry;
2878 2879 2880 2881 2882 2883 2884
		} else if (errno == ENOENT && --attempts_remaining > 0) {
			/*
			 * Maybe another process just deleted one of
			 * the directories in the path to newrefname.
			 * Try again from the beginning.
			 */
			goto retry;
2885 2886 2887 2888 2889 2890 2891 2892 2893
		} else {
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
				newrefname, strerror(errno));
			return -1;
		}
	}
	return 0;
}

2894 2895 2896
static int rename_ref_available(const char *oldname, const char *newname)
{
	struct string_list skip = STRING_LIST_INIT_NODUP;
2897
	struct strbuf err = STRBUF_INIT;
2898 2899 2900
	int ret;

	string_list_insert(&skip, oldname);
2901
	ret = !verify_refname_available(newname, NULL, &skip,
2902
					get_packed_refs(&ref_cache), &err)
2903
		&& !verify_refname_available(newname, NULL, &skip,
2904 2905 2906 2907
					     get_loose_refs(&ref_cache), &err);
	if (!ret)
		error("%s", err.buf);

2908
	string_list_clear(&skip, 0);
2909
	strbuf_release(&err);
2910 2911 2912
	return ret;
}

2913 2914
static int write_ref_to_lockfile(struct ref_lock *lock,
				 const unsigned char *sha1, struct strbuf *err);
2915
static int commit_ref_update(struct ref_lock *lock,
2916 2917
			     const unsigned char *sha1, const char *logmsg,
			     struct strbuf *err);
2918

2919
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2920 2921 2922 2923 2924
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
2925
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
2926
	const char *symref = NULL;
2927
	struct strbuf err = STRBUF_INIT;
2928

2929
	if (log && S_ISLNK(loginfo.st_mode))
2930
		return error("reflog for %s is a symlink", oldrefname);
2931

2932 2933
	symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,
				    orig_sha1, &flag);
M
Miklos Vajna 已提交
2934
	if (flag & REF_ISSYMREF)
2935
		return error("refname %s is a symbolic ref, renaming it is not supported",
2936
			oldrefname);
M
Miklos Vajna 已提交
2937
	if (!symref)
2938
		return error("refname %s not found", oldrefname);
2939

2940
	if (!rename_ref_available(oldrefname, newrefname))
2941 2942
		return 1;

2943
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2944
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2945
			oldrefname, strerror(errno));
2946

2947 2948
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
2949 2950 2951
		goto rollback;
	}

2952
	if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&
2953
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
2954
		if (errno==EISDIR) {
2955 2956
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
2957 2958 2959
				goto rollback;
			}
		} else {
2960
			error("unable to delete existing %s", newrefname);
2961 2962 2963 2964
			goto rollback;
		}
	}

2965
	if (log && rename_tmp_log(newrefname))
2966 2967 2968 2969
		goto rollback;

	logmoved = log;

2970
	lock = lock_ref_sha1_basic(newrefname, NULL, NULL, NULL, 0, NULL, &err);
2971
	if (!lock) {
2972
		error("unable to rename '%s' to '%s': %s", oldrefname, newrefname, err.buf);
2973
		strbuf_release(&err);
2974 2975
		goto rollback;
	}
2976
	hashcpy(lock->old_oid.hash, orig_sha1);
2977

2978 2979 2980 2981
	if (write_ref_to_lockfile(lock, orig_sha1, &err) ||
	    commit_ref_update(lock, orig_sha1, logmsg, &err)) {
		error("unable to write current sha1 into %s: %s", newrefname, err.buf);
		strbuf_release(&err);
2982 2983 2984 2985 2986 2987
		goto rollback;
	}

	return 0;

 rollback:
2988
	lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, NULL, 0, NULL, &err);
2989
	if (!lock) {
2990
		error("unable to lock %s for rollback: %s", oldrefname, err.buf);
2991
		strbuf_release(&err);
2992 2993 2994 2995 2996
		goto rollbacklog;
	}

	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
2997 2998 2999 3000 3001
	if (write_ref_to_lockfile(lock, orig_sha1, &err) ||
	    commit_ref_update(lock, orig_sha1, NULL, &err)) {
		error("unable to write current sha1 into %s: %s", oldrefname, err.buf);
		strbuf_release(&err);
	}
3002 3003 3004
	log_all_ref_updates = flag;

 rollbacklog:
3005
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
3006
		error("unable to restore logfile %s from %s: %s",
3007
			oldrefname, newrefname, strerror(errno));
3008
	if (!logmoved && log &&
3009
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
3010
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
3011
			oldrefname, strerror(errno));
3012 3013 3014 3015

	return 1;
}

3016
static int close_ref(struct ref_lock *lock)
3017 3018 3019 3020 3021 3022
{
	if (close_lock_file(lock->lk))
		return -1;
	return 0;
}

3023
static int commit_ref(struct ref_lock *lock)
3024 3025 3026 3027 3028 3029
{
	if (commit_lock_file(lock->lk))
		return -1;
	return 0;
}

3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055
/*
 * copy the reflog message msg to buf, which has been allocated sufficiently
 * large, while cleaning up the whitespaces.  Especially, convert LF to space,
 * because reflog file is one line per entry.
 */
static int copy_msg(char *buf, const char *msg)
{
	char *cp = buf;
	char c;
	int wasspace = 1;

	*cp++ = '\t';
	while ((c = *msg++)) {
		if (wasspace && isspace(c))
			continue;
		wasspace = isspace(c);
		if (wasspace)
			c = ' ';
		*cp++ = c;
	}
	while (buf < cp && isspace(cp[-1]))
		cp--;
	*cp++ = '\n';
	return cp - buf;
}

3056 3057
/* This function will fill in *err and return -1 on failure */
int log_ref_setup(const char *refname, struct strbuf *sb_logfile, struct strbuf *err)
3058
{
3059
	int logfd, oflags = O_APPEND | O_WRONLY;
3060
	char *logfile;
3061

3062 3063 3064 3065
	strbuf_git_path(sb_logfile, "logs/%s", refname);
	logfile = sb_logfile->buf;
	/* make sure the rest of the function can't change "logfile" */
	sb_logfile = NULL;
3066
	if (log_all_ref_updates &&
3067 3068 3069
	    (starts_with(refname, "refs/heads/") ||
	     starts_with(refname, "refs/remotes/") ||
	     starts_with(refname, "refs/notes/") ||
3070
	     !strcmp(refname, "HEAD"))) {
3071
		if (safe_create_leading_directories(logfile) < 0) {
3072 3073
			strbuf_addf(err, "unable to create directory for %s: "
				    "%s", logfile, strerror(errno));
3074 3075
			return -1;
		}
3076 3077 3078
		oflags |= O_CREAT;
	}

3079
	logfd = open(logfile, oflags, 0666);
3080
	if (logfd < 0) {
3081
		if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))
3082
			return 0;
3083

3084
		if (errno == EISDIR) {
3085
			if (remove_empty_directories(logfile)) {
3086 3087
				strbuf_addf(err, "There are still logs under "
					    "'%s'", logfile);
3088
				return -1;
3089
			}
3090
			logfd = open(logfile, oflags, 0666);
3091 3092
		}

3093
		if (logfd < 0) {
3094 3095
			strbuf_addf(err, "unable to append to %s: %s",
				    logfile, strerror(errno));
3096 3097
			return -1;
		}
3098 3099
	}

3100
	adjust_shared_perm(logfile);
3101 3102 3103
	close(logfd);
	return 0;
}
3104

3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
static int log_ref_write_fd(int fd, const unsigned char *old_sha1,
			    const unsigned char *new_sha1,
			    const char *committer, const char *msg)
{
	int msglen, written;
	unsigned maxlen, len;
	char *logrec;

	msglen = msg ? strlen(msg) : 0;
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
		      committer);
	if (msglen)
		len += copy_msg(logrec + len - 1, msg) - 1;

	written = len <= maxlen ? write_in_full(fd, logrec, len) : -1;
	free(logrec);
	if (written != len)
		return -1;

	return 0;
}

3131 3132
static int log_ref_write_1(const char *refname, const unsigned char *old_sha1,
			   const unsigned char *new_sha1, const char *msg,
3133
			   struct strbuf *sb_log_file, struct strbuf *err)
3134
{
3135
	int logfd, result, oflags = O_APPEND | O_WRONLY;
3136
	char *log_file;
3137 3138 3139 3140

	if (log_all_ref_updates < 0)
		log_all_ref_updates = !is_bare_repository();

3141 3142
	result = log_ref_setup(refname, sb_log_file, err);

3143 3144
	if (result)
		return result;
3145 3146 3147
	log_file = sb_log_file->buf;
	/* make sure the rest of the function can't change "log_file" */
	sb_log_file = NULL;
3148 3149 3150 3151

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
3152 3153 3154
	result = log_ref_write_fd(logfd, old_sha1, new_sha1,
				  git_committer_info(0), msg);
	if (result) {
3155 3156
		strbuf_addf(err, "unable to append to %s: %s", log_file,
			    strerror(errno));
3157 3158 3159 3160
		close(logfd);
		return -1;
	}
	if (close(logfd)) {
3161 3162
		strbuf_addf(err, "unable to append to %s: %s", log_file,
			    strerror(errno));
3163 3164
		return -1;
	}
3165 3166 3167
	return 0;
}

3168
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
3169 3170
			 const unsigned char *new_sha1, const char *msg,
			 struct strbuf *err)
3171 3172
{
	struct strbuf sb = STRBUF_INIT;
3173
	int ret = log_ref_write_1(refname, old_sha1, new_sha1, msg, &sb, err);
3174 3175 3176 3177
	strbuf_release(&sb);
	return ret;
}

3178
int is_branch(const char *refname)
3179
{
3180
	return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
3181 3182
}

3183
/*
3184
 * Write sha1 into the open lockfile, then close the lockfile. On
3185 3186
 * errors, rollback the lockfile, fill in *err and
 * return -1.
3187
 */
3188
static int write_ref_to_lockfile(struct ref_lock *lock,
3189
				 const unsigned char *sha1, struct strbuf *err)
3190 3191
{
	static char term = '\n';
3192
	struct object *o;
3193

3194 3195
	o = parse_object(sha1);
	if (!o) {
3196 3197 3198
		strbuf_addf(err,
			    "Trying to write ref %s with nonexistent object %s",
			    lock->ref_name, sha1_to_hex(sha1));
3199 3200 3201 3202
		unlock_ref(lock);
		return -1;
	}
	if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
3203 3204 3205
		strbuf_addf(err,
			    "Trying to write non-commit object %s to branch %s",
			    sha1_to_hex(sha1), lock->ref_name);
3206 3207 3208
		unlock_ref(lock);
		return -1;
	}
3209 3210
	if (write_in_full(lock->lk->fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lk->fd, &term, 1) != 1 ||
3211
	    close_ref(lock) < 0) {
3212 3213
		strbuf_addf(err,
			    "Couldn't write %s", lock->lk->filename.buf);
3214 3215 3216
		unlock_ref(lock);
		return -1;
	}
3217 3218 3219 3220
	return 0;
}

/*
3221 3222 3223
 * Commit a change to a loose reference that has already been written
 * to the loose reference lockfile. Also update the reflogs if
 * necessary, using the specified lockmsg (which can be NULL).
3224
 */
3225
static int commit_ref_update(struct ref_lock *lock,
3226 3227
			     const unsigned char *sha1, const char *logmsg,
			     struct strbuf *err)
3228
{
3229
	clear_loose_ref_cache(&ref_cache);
3230
	if (log_ref_write(lock->ref_name, lock->old_oid.hash, sha1, logmsg, err) < 0 ||
N
Nicolas Pitre 已提交
3231
	    (strcmp(lock->ref_name, lock->orig_ref_name) &&
3232 3233 3234 3235 3236
	     log_ref_write(lock->orig_ref_name, lock->old_oid.hash, sha1, logmsg, err) < 0)) {
		char *old_msg = strbuf_detach(err, NULL);
		strbuf_addf(err, "Cannot update the ref '%s': %s",
			    lock->ref_name, old_msg);
		free(old_msg);
3237 3238 3239
		unlock_ref(lock);
		return -1;
	}
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255
	if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
		/*
		 * Special hack: If a branch is updated directly and HEAD
		 * points to it (may happen on the remote side of a push
		 * for example) then logically the HEAD reflog should be
		 * updated too.
		 * A generic solution implies reverse symref information,
		 * but finding all symrefs pointing to the given branch
		 * would be rather costly for this rare event (the direct
		 * update of a branch) to be worth it.  So let's cheat and
		 * check with HEAD only which should cover 99% of all usage
		 * scenarios (even 100% of the default ones).
		 */
		unsigned char head_sha1[20];
		int head_flag;
		const char *head_ref;
3256 3257
		head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
					      head_sha1, &head_flag);
3258
		if (head_ref && (head_flag & REF_ISSYMREF) &&
3259 3260 3261 3262 3263 3264 3265 3266
		    !strcmp(head_ref, lock->ref_name)) {
			struct strbuf log_err = STRBUF_INIT;
			if (log_ref_write("HEAD", lock->old_oid.hash, sha1,
					  logmsg, &log_err)) {
				error("%s", log_err.buf);
				strbuf_release(&log_err);
			}
		}
3267
	}
3268
	if (commit_ref(lock)) {
3269
		error("Couldn't set %s", lock->ref_name);
3270 3271 3272
		unlock_ref(lock);
		return -1;
	}
3273

3274 3275
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
3276
}
3277

3278 3279
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
3280 3281 3282 3283
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
3284
	char *git_HEAD = git_pathdup("%s", ref_target);
3285
	unsigned char old_sha1[20], new_sha1[20];
3286
	struct strbuf err = STRBUF_INIT;
3287 3288 3289

	if (logmsg && read_ref(ref_target, old_sha1))
		hashclr(old_sha1);
3290

3291 3292 3293
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

3294 3295 3296 3297
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
3298
			goto done;
3299 3300 3301 3302 3303 3304 3305
		fprintf(stderr, "no symlink - falling back to symbolic ref\n");
	}
#endif

	len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
	if (sizeof(ref) <= len) {
		error("refname too long: %s", refs_heads_master);
3306
		goto error_free_return;
3307 3308 3309 3310 3311
	}
	lockpath = mkpath("%s.lock", git_HEAD);
	fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
	if (fd < 0) {
		error("Unable to open %s for writing", lockpath);
3312
		goto error_free_return;
3313 3314
	}
	written = write_in_full(fd, ref, len);
3315
	if (close(fd) != 0 || written != len) {
3316
		error("Unable to write to %s", lockpath);
3317
		goto error_unlink_return;
3318 3319 3320
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
3321
		goto error_unlink_return;
3322 3323 3324
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
3325
	error_unlink_return:
3326
		unlink_or_warn(lockpath);
3327 3328 3329
	error_free_return:
		free(git_HEAD);
		return -1;
3330
	}
3331

3332
#ifndef NO_SYMLINK_HEAD
3333
	done:
3334
#endif
3335 3336 3337 3338 3339
	if (logmsg && !read_ref(refs_heads_master, new_sha1) &&
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg, &err)) {
		error("%s", err.buf);
		strbuf_release(&err);
	}
3340

3341
	free(git_HEAD);
3342 3343 3344
	return 0;
}

3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428
struct read_ref_at_cb {
	const char *refname;
	unsigned long at_time;
	int cnt;
	int reccnt;
	unsigned char *sha1;
	int found_it;

	unsigned char osha1[20];
	unsigned char nsha1[20];
	int tz;
	unsigned long date;
	char **msg;
	unsigned long *cutoff_time;
	int *cutoff_tz;
	int *cutoff_cnt;
};

static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,
		const char *email, unsigned long timestamp, int tz,
		const char *message, void *cb_data)
{
	struct read_ref_at_cb *cb = cb_data;

	cb->reccnt++;
	cb->tz = tz;
	cb->date = timestamp;

	if (timestamp <= cb->at_time || cb->cnt == 0) {
		if (cb->msg)
			*cb->msg = xstrdup(message);
		if (cb->cutoff_time)
			*cb->cutoff_time = timestamp;
		if (cb->cutoff_tz)
			*cb->cutoff_tz = tz;
		if (cb->cutoff_cnt)
			*cb->cutoff_cnt = cb->reccnt - 1;
		/*
		 * we have not yet updated cb->[n|o]sha1 so they still
		 * hold the values for the previous record.
		 */
		if (!is_null_sha1(cb->osha1)) {
			hashcpy(cb->sha1, nsha1);
			if (hashcmp(cb->osha1, nsha1))
				warning("Log for ref %s has gap after %s.",
					cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));
		}
		else if (cb->date == cb->at_time)
			hashcpy(cb->sha1, nsha1);
		else if (hashcmp(nsha1, cb->sha1))
			warning("Log for ref %s unexpectedly ended on %s.",
				cb->refname, show_date(cb->date, cb->tz,
						   DATE_RFC2822));
		hashcpy(cb->osha1, osha1);
		hashcpy(cb->nsha1, nsha1);
		cb->found_it = 1;
		return 1;
	}
	hashcpy(cb->osha1, osha1);
	hashcpy(cb->nsha1, nsha1);
	if (cb->cnt > 0)
		cb->cnt--;
	return 0;
}

static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,
				  const char *email, unsigned long timestamp,
				  int tz, const char *message, void *cb_data)
{
	struct read_ref_at_cb *cb = cb_data;

	if (cb->msg)
		*cb->msg = xstrdup(message);
	if (cb->cutoff_time)
		*cb->cutoff_time = timestamp;
	if (cb->cutoff_tz)
		*cb->cutoff_tz = tz;
	if (cb->cutoff_cnt)
		*cb->cutoff_cnt = cb->reccnt;
	hashcpy(cb->sha1, osha1);
	if (is_null_sha1(cb->sha1))
		hashcpy(cb->sha1, nsha1);
	/* We just want the first entry */
	return 1;
3429 3430
}

3431
int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
3432 3433
		unsigned char *sha1, char **msg,
		unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3434
{
3435
	struct read_ref_at_cb cb;
3436

3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448
	memset(&cb, 0, sizeof(cb));
	cb.refname = refname;
	cb.at_time = at_time;
	cb.cnt = cnt;
	cb.msg = msg;
	cb.cutoff_time = cutoff_time;
	cb.cutoff_tz = cutoff_tz;
	cb.cutoff_cnt = cutoff_cnt;
	cb.sha1 = sha1;

	for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);

3449 3450 3451 3452 3453 3454
	if (!cb.reccnt) {
		if (flags & GET_SHA1_QUIETLY)
			exit(128);
		else
			die("Log for %s is empty.", refname);
	}
3455 3456 3457 3458
	if (cb.found_it)
		return 0;

	for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3459

3460
	return 1;
3461
}
3462

3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475
int reflog_exists(const char *refname)
{
	struct stat st;

	return !lstat(git_path("logs/%s", refname), &st) &&
		S_ISREG(st.st_mode);
}

int delete_reflog(const char *refname)
{
	return remove_path(git_path("logs/%s", refname));
}

3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503
static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
{
	unsigned char osha1[20], nsha1[20];
	char *email_end, *message;
	unsigned long timestamp;
	int tz;

	/* old SP new SP name <email> SP time TAB msg LF */
	if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
	    get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
	    get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
	    !(email_end = strchr(sb->buf + 82, '>')) ||
	    email_end[1] != ' ' ||
	    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
	    !message || message[0] != ' ' ||
	    (message[1] != '+' && message[1] != '-') ||
	    !isdigit(message[2]) || !isdigit(message[3]) ||
	    !isdigit(message[4]) || !isdigit(message[5]))
		return 0; /* corrupt? */
	email_end[1] = '\0';
	tz = strtol(message + 1, NULL, 10);
	if (message[6] != '\t')
		message += 6;
	else
		message += 7;
	return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
}

3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515
static char *find_beginning_of_line(char *bob, char *scan)
{
	while (bob < scan && *(--scan) != '\n')
		; /* keep scanning backwards */
	/*
	 * Return either beginning of the buffer, or LF at the end of
	 * the previous line.
	 */
	return scan;
}

int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3516
{
3517
	struct strbuf sb = STRBUF_INIT;
3518 3519 3520
	FILE *logfp;
	long pos;
	int ret = 0, at_tail = 1;
3521

3522
	logfp = fopen(git_path("logs/%s", refname), "r");
3523
	if (!logfp)
3524
		return -1;
3525

3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542
	/* Jump to the end */
	if (fseek(logfp, 0, SEEK_END) < 0)
		return error("cannot seek back reflog for %s: %s",
			     refname, strerror(errno));
	pos = ftell(logfp);
	while (!ret && 0 < pos) {
		int cnt;
		size_t nread;
		char buf[BUFSIZ];
		char *endp, *scanp;

		/* Fill next block from the end */
		cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
		if (fseek(logfp, pos - cnt, SEEK_SET))
			return error("cannot seek back reflog for %s: %s",
				     refname, strerror(errno));
		nread = fread(buf, cnt, 1, logfp);
J
John Keeping 已提交
3543
		if (nread != 1)
3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562
			return error("cannot read %d bytes from reflog for %s: %s",
				     cnt, refname, strerror(errno));
		pos -= cnt;

		scanp = endp = buf + cnt;
		if (at_tail && scanp[-1] == '\n')
			/* Looking at the final LF at the end of the file */
			scanp--;
		at_tail = 0;

		while (buf < scanp) {
			/*
			 * terminating LF of the previous line, or the beginning
			 * of the buffer.
			 */
			char *bp;

			bp = find_beginning_of_line(buf, scanp);

3563
			if (*bp == '\n') {
3564
				/*
3565 3566 3567 3568
				 * The newline is the end of the previous line,
				 * so we know we have complete line starting
				 * at (bp + 1). Prefix it onto any prior data
				 * we collected for the line and process it.
3569 3570 3571 3572
				 */
				strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
				scanp = bp;
				endp = bp + 1;
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587
				ret = show_one_reflog_ent(&sb, fn, cb_data);
				strbuf_reset(&sb);
				if (ret)
					break;
			} else if (!pos) {
				/*
				 * We are at the start of the buffer, and the
				 * start of the file; there is no previous
				 * line, and we have everything for this one.
				 * Process it, and we can end the loop.
				 */
				strbuf_splice(&sb, 0, 0, buf, endp - buf);
				ret = show_one_reflog_ent(&sb, fn, cb_data);
				strbuf_reset(&sb);
				break;
3588
			}
3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603

			if (bp == buf) {
				/*
				 * We are at the start of the buffer, and there
				 * is more file to read backwards. Which means
				 * we are in the middle of a line. Note that we
				 * may get here even if *bp was a newline; that
				 * just means we are at the exact end of the
				 * previous line, rather than some spot in the
				 * middle.
				 *
				 * Save away what we have to be combined with
				 * the data from the next read.
				 */
				strbuf_splice(&sb, 0, 0, buf, endp - buf);
3604
				break;
3605
			}
3606
		}
3607

3608
	}
3609
	if (!ret && sb.len)
3610
		die("BUG: reverse reflog parser had leftover data");
3611

3612
	fclose(logfp);
3613
	strbuf_release(&sb);
3614
	return ret;
3615
}
J
Junio C Hamano 已提交
3616

3617
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3618
{
3619 3620 3621 3622 3623 3624 3625
	FILE *logfp;
	struct strbuf sb = STRBUF_INIT;
	int ret = 0;

	logfp = fopen(git_path("logs/%s", refname), "r");
	if (!logfp)
		return -1;
3626

3627 3628 3629 3630 3631 3632
	while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
		ret = show_one_reflog_ent(&sb, fn, cb_data);
	fclose(logfp);
	strbuf_release(&sb);
	return ret;
}
3633 3634 3635 3636 3637 3638
/*
 * Call fn for each reflog in the namespace indicated by name.  name
 * must be empty or end with '/'.  Name will be used as a scratch
 * space, but its contents will be restored before return.
 */
static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
3639
{
3640
	DIR *d = opendir(git_path("logs/%s", name->buf));
3641
	int retval = 0;
3642
	struct dirent *de;
3643
	int oldlen = name->len;
3644

3645
	if (!d)
3646
		return name->len ? errno : 0;
3647

3648 3649
	while ((de = readdir(d)) != NULL) {
		struct stat st;
3650

3651 3652
		if (de->d_name[0] == '.')
			continue;
J
Jeff King 已提交
3653
		if (ends_with(de->d_name, ".lock"))
3654
			continue;
3655 3656 3657
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
3658
		} else {
3659
			if (S_ISDIR(st.st_mode)) {
3660 3661
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
3662
			} else {
3663 3664 3665
				struct object_id oid;

				if (read_ref_full(name->buf, 0, oid.hash, NULL))
3666
					retval = error("bad ref for %s", name->buf);
3667
				else
3668
					retval = fn(name->buf, &oid, 0, cb_data);
3669 3670 3671 3672
			}
			if (retval)
				break;
		}
3673
		strbuf_setlen(name, oldlen);
3674
	}
3675
	closedir(d);
3676 3677 3678 3679 3680
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
3681 3682 3683 3684 3685 3686
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
3687
}
C
Carlos Rica 已提交
3688

3689
/**
3690 3691 3692 3693 3694
 * Information needed for a single ref update. Set new_sha1 to the new
 * value or to null_sha1 to delete the ref. To check the old value
 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
 * not exist before update.
3695 3696
 */
struct ref_update {
3697 3698 3699
	/*
	 * If (flags & REF_HAVE_NEW), set the reference to this value:
	 */
3700
	unsigned char new_sha1[20];
3701 3702 3703 3704
	/*
	 * If (flags & REF_HAVE_OLD), check that the reference
	 * previously had this value:
	 */
3705
	unsigned char old_sha1[20];
3706
	/*
3707
	 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3708 3709 3710
	 * REF_DELETING, and REF_ISPRUNING:
	 */
	unsigned int flags;
3711
	struct ref_lock *lock;
3712
	int type;
3713
	char *msg;
3714
	const char refname[FLEX_ARRAY];
3715 3716
};

3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731
/*
 * Transaction states.
 * OPEN:   The transaction is in a valid state and can accept new updates.
 *         An OPEN transaction can be committed.
 * CLOSED: A closed transaction is no longer active and no other operations
 *         than free can be used on it in this state.
 *         A transaction can either become closed by successfully committing
 *         an active transaction or if there is a failure while building
 *         the transaction thus rendering it failed/inactive.
 */
enum ref_transaction_state {
	REF_TRANSACTION_OPEN   = 0,
	REF_TRANSACTION_CLOSED = 1
};

3732 3733 3734 3735 3736 3737 3738 3739 3740
/*
 * Data structure for holding a reference transaction, which can
 * consist of checks and updates to multiple references, carried out
 * as atomically as possible.  This structure is opaque to callers.
 */
struct ref_transaction {
	struct ref_update **updates;
	size_t alloc;
	size_t nr;
3741
	enum ref_transaction_state state;
3742 3743
};

3744
struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3745
{
3746 3747
	assert(err);

3748 3749 3750
	return xcalloc(1, sizeof(struct ref_transaction));
}

3751
void ref_transaction_free(struct ref_transaction *transaction)
3752 3753 3754
{
	int i;

3755 3756 3757
	if (!transaction)
		return;

3758 3759
	for (i = 0; i < transaction->nr; i++) {
		free(transaction->updates[i]->msg);
3760
		free(transaction->updates[i]);
3761
	}
3762 3763 3764 3765 3766 3767 3768
	free(transaction->updates);
	free(transaction);
}

static struct ref_update *add_update(struct ref_transaction *transaction,
				     const char *refname)
{
3769 3770
	size_t len = strlen(refname);
	struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);
3771

3772
	strcpy((char *)update->refname, refname);
3773 3774 3775 3776 3777
	ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
	transaction->updates[transaction->nr++] = update;
	return update;
}

3778 3779 3780 3781
int ref_transaction_update(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
			   const unsigned char *old_sha1,
3782
			   unsigned int flags, const char *msg,
3783
			   struct strbuf *err)
3784
{
3785
	struct ref_update *update;
3786

3787 3788
	assert(err);

3789 3790 3791
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: update called for transaction that is not open");

3792
	if (new_sha1 && !is_null_sha1(new_sha1) &&
3793 3794 3795 3796 3797 3798
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
		strbuf_addf(err, "refusing to update ref with bad name %s",
			    refname);
		return -1;
	}

3799
	update = add_update(transaction, refname);
3800 3801 3802 3803
	if (new_sha1) {
		hashcpy(update->new_sha1, new_sha1);
		flags |= REF_HAVE_NEW;
	}
3804
	if (old_sha1) {
3805
		hashcpy(update->old_sha1, old_sha1);
3806 3807 3808
		flags |= REF_HAVE_OLD;
	}
	update->flags = flags;
3809 3810
	if (msg)
		update->msg = xstrdup(msg);
3811
	return 0;
3812 3813
}

3814 3815 3816
int ref_transaction_create(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
3817
			   unsigned int flags, const char *msg,
3818
			   struct strbuf *err)
3819
{
3820 3821
	if (!new_sha1 || is_null_sha1(new_sha1))
		die("BUG: create called without valid new_sha1");
3822
	return ref_transaction_update(transaction, refname, new_sha1,
3823
				      null_sha1, flags, msg, err);
3824 3825
}

3826 3827 3828
int ref_transaction_delete(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *old_sha1,
3829
			   unsigned int flags, const char *msg,
3830
			   struct strbuf *err)
3831
{
3832 3833
	if (old_sha1 && is_null_sha1(old_sha1))
		die("BUG: delete called with old_sha1 set to zeros");
3834
	return ref_transaction_update(transaction, refname,
3835
				      null_sha1, old_sha1,
3836
				      flags, msg, err);
3837 3838
}

3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
int ref_transaction_verify(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *old_sha1,
			   unsigned int flags,
			   struct strbuf *err)
{
	if (!old_sha1)
		die("BUG: verify called with old_sha1 set to NULL");
	return ref_transaction_update(transaction, refname,
				      NULL, old_sha1,
				      flags, NULL, err);
}

3852 3853
int update_ref(const char *msg, const char *refname,
	       const unsigned char *new_sha1, const unsigned char *old_sha1,
3854
	       unsigned int flags, enum action_on_err onerr)
3855
{
3856 3857 3858 3859 3860
	struct ref_transaction *t;
	struct strbuf err = STRBUF_INIT;

	t = ref_transaction_begin(&err);
	if (!t ||
3861 3862
	    ref_transaction_update(t, refname, new_sha1, old_sha1,
				   flags, msg, &err) ||
3863
	    ref_transaction_commit(t, &err)) {
3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877
		const char *str = "update_ref failed for ref '%s': %s";

		ref_transaction_free(t);
		switch (onerr) {
		case UPDATE_REFS_MSG_ON_ERR:
			error(str, refname, err.buf);
			break;
		case UPDATE_REFS_DIE_ON_ERR:
			die(str, refname, err.buf);
			break;
		case UPDATE_REFS_QUIET_ON_ERR:
			break;
		}
		strbuf_release(&err);
3878
		return 1;
3879 3880 3881 3882
	}
	strbuf_release(&err);
	ref_transaction_free(t);
	return 0;
3883 3884
}

3885
static int ref_update_reject_duplicates(struct string_list *refnames,
3886
					struct strbuf *err)
3887
{
3888
	int i, n = refnames->nr;
3889 3890 3891

	assert(err);

3892
	for (i = 1; i < n; i++)
3893
		if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {
3894 3895
			strbuf_addf(err,
				    "Multiple updates for ref '%s' not allowed.",
3896
				    refnames->items[i].string);
3897 3898 3899 3900 3901
			return 1;
		}
	return 0;
}

3902
int ref_transaction_commit(struct ref_transaction *transaction,
3903
			   struct strbuf *err)
3904
{
3905
	int ret = 0, i;
3906
	int n = transaction->nr;
3907
	struct ref_update **updates = transaction->updates;
3908 3909
	struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;
	struct string_list_item *ref_to_delete;
3910
	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
3911

3912 3913
	assert(err);

3914 3915 3916 3917 3918
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: commit called for transaction that is not open");

	if (!n) {
		transaction->state = REF_TRANSACTION_CLOSED;
3919
		return 0;
3920
	}
3921

3922 3923 3924 3925 3926
	/* Fail if a refname appears more than once in the transaction: */
	for (i = 0; i < n; i++)
		string_list_append(&affected_refnames, updates[i]->refname);
	string_list_sort(&affected_refnames);
	if (ref_update_reject_duplicates(&affected_refnames, err)) {
3927
		ret = TRANSACTION_GENERIC_ERROR;
3928
		goto cleanup;
3929
	}
3930

3931 3932 3933 3934 3935 3936
	/*
	 * Acquire all locks, verify old values if provided, check
	 * that new values are valid, and write new values to the
	 * lockfiles, ready to be activated. Only keep one lockfile
	 * open at a time to avoid running out of file descriptors.
	 */
3937
	for (i = 0; i < n; i++) {
3938 3939
		struct ref_update *update = updates[i];

3940 3941 3942
		if ((update->flags & REF_HAVE_NEW) &&
		    is_null_sha1(update->new_sha1))
			update->flags |= REF_DELETING;
3943 3944 3945 3946
		update->lock = lock_ref_sha1_basic(
				update->refname,
				((update->flags & REF_HAVE_OLD) ?
				 update->old_sha1 : NULL),
3947
				&affected_refnames, NULL,
3948
				update->flags,
3949 3950
				&update->type,
				err);
3951
		if (!update->lock) {
3952 3953
			char *reason;

3954 3955 3956
			ret = (errno == ENOTDIR)
				? TRANSACTION_NAME_CONFLICT
				: TRANSACTION_GENERIC_ERROR;
3957
			reason = strbuf_detach(err, NULL);
3958
			strbuf_addf(err, "cannot lock ref '%s': %s",
3959 3960
				    update->refname, reason);
			free(reason);
3961 3962
			goto cleanup;
		}
3963 3964
		if ((update->flags & REF_HAVE_NEW) &&
		    !(update->flags & REF_DELETING)) {
3965 3966 3967
			int overwriting_symref = ((update->type & REF_ISSYMREF) &&
						  (update->flags & REF_NODEREF));

3968
			if (!overwriting_symref &&
3969
			    !hashcmp(update->lock->old_oid.hash, update->new_sha1)) {
3970 3971 3972 3973
				/*
				 * The reference already has the desired
				 * value, so we don't need to write it.
				 */
3974
			} else if (write_ref_to_lockfile(update->lock,
3975 3976 3977 3978
							 update->new_sha1,
							 err)) {
				char *write_err = strbuf_detach(err, NULL);

3979 3980 3981 3982 3983
				/*
				 * The lock was freed upon failure of
				 * write_ref_to_lockfile():
				 */
				update->lock = NULL;
3984 3985 3986 3987
				strbuf_addf(err,
					    "cannot update the ref '%s': %s",
					    update->refname, write_err);
				free(write_err);
3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012
				ret = TRANSACTION_GENERIC_ERROR;
				goto cleanup;
			} else {
				update->flags |= REF_NEEDS_COMMIT;
			}
		}
		if (!(update->flags & REF_NEEDS_COMMIT)) {
			/*
			 * We didn't have to write anything to the lockfile.
			 * Close it to free up the file descriptor:
			 */
			if (close_ref(update->lock)) {
				strbuf_addf(err, "Couldn't close %s.lock",
					    update->refname);
				goto cleanup;
			}
		}
	}

	/* Perform updates first so live commits remain referenced */
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];

		if (update->flags & REF_NEEDS_COMMIT) {
			if (commit_ref_update(update->lock,
4013
					      update->new_sha1, update->msg, err)) {
4014
				/* freed by commit_ref_update(): */
4015
				update->lock = NULL;
4016
				ret = TRANSACTION_GENERIC_ERROR;
4017
				goto cleanup;
4018
			} else {
4019
				/* freed by commit_ref_update(): */
4020
				update->lock = NULL;
4021
			}
4022
		}
4023
	}
4024 4025

	/* Perform deletes now that updates are safely completed */
4026 4027 4028
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];

4029
		if (update->flags & REF_DELETING) {
4030
			if (delete_ref_loose(update->lock, update->type, err)) {
4031
				ret = TRANSACTION_GENERIC_ERROR;
4032 4033
				goto cleanup;
			}
4034

4035
			if (!(update->flags & REF_ISPRUNING))
4036 4037
				string_list_append(&refs_to_delete,
						   update->lock->ref_name);
4038
		}
4039 4040
	}

4041
	if (repack_without_refs(&refs_to_delete, err)) {
4042
		ret = TRANSACTION_GENERIC_ERROR;
4043 4044
		goto cleanup;
	}
4045 4046
	for_each_string_list_item(ref_to_delete, &refs_to_delete)
		unlink_or_warn(git_path("logs/%s", ref_to_delete->string));
4047 4048 4049
	clear_loose_ref_cache(&ref_cache);

cleanup:
4050 4051
	transaction->state = REF_TRANSACTION_CLOSED;

4052
	for (i = 0; i < n; i++)
4053 4054
		if (updates[i]->lock)
			unlock_ref(updates[i]->lock);
4055
	string_list_clear(&refs_to_delete, 0);
4056
	string_list_clear(&affected_refnames, 0);
4057 4058 4059
	return ret;
}

4060
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
4061 4062 4063 4064 4065 4066 4067
{
	int i;
	static char **scanf_fmts;
	static int nr_rules;
	char *short_name;

	if (!nr_rules) {
4068 4069 4070 4071 4072 4073
		/*
		 * Pre-generate scanf formats from ref_rev_parse_rules[].
		 * Generate a format suitable for scanf from a
		 * ref_rev_parse_rules rule by interpolating "%s" at the
		 * location of the "%.*s".
		 */
J
Jeff King 已提交
4074
		size_t total_len = 0;
4075
		size_t offset = 0;
J
Jeff King 已提交
4076 4077

		/* the rule list is NULL terminated, count them first */
J
Jeff King 已提交
4078
		for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
4079 4080
			/* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
			total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
J
Jeff King 已提交
4081 4082 4083

		scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);

4084
		offset = 0;
J
Jeff King 已提交
4085
		for (i = 0; i < nr_rules; i++) {
4086
			assert(offset < total_len);
4087
			scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
4088 4089
			offset += snprintf(scanf_fmts[i], total_len - offset,
					   ref_rev_parse_rules[i], 2, "%s") + 1;
J
Jeff King 已提交
4090 4091 4092 4093 4094
		}
	}

	/* bail out if there are no rules */
	if (!nr_rules)
4095
		return xstrdup(refname);
J
Jeff King 已提交
4096

4097 4098
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
4099 4100 4101 4102

	/* skip first rule, it will always match */
	for (i = nr_rules - 1; i > 0 ; --i) {
		int j;
4103
		int rules_to_fail = i;
J
Jeff King 已提交
4104 4105
		int short_name_len;

4106
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
4107 4108 4109 4110
			continue;

		short_name_len = strlen(short_name);

4111 4112 4113 4114 4115 4116 4117
		/*
		 * in strict mode, all (except the matched one) rules
		 * must fail to resolve to a valid non-ambiguous ref
		 */
		if (strict)
			rules_to_fail = nr_rules;

J
Jeff King 已提交
4118 4119 4120 4121
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
4122
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
4123 4124 4125
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

4126 4127 4128 4129
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
4130 4131 4132 4133 4134 4135 4136
			/*
			 * the short name is ambiguous, if it resolves
			 * (with this previous rule) to a valid ref
			 * read_ref() returns 0 on success
			 */
			mksnpath(refname, sizeof(refname),
				 rule, short_name_len, short_name);
4137
			if (ref_exists(refname))
J
Jeff King 已提交
4138 4139 4140 4141 4142 4143 4144
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
4145
		if (j == rules_to_fail)
J
Jeff King 已提交
4146 4147 4148 4149
			return short_name;
	}

	free(short_name);
4150
	return xstrdup(refname);
J
Jeff King 已提交
4151
}
4152 4153 4154 4155 4156 4157 4158

static struct string_list *hide_refs;

int parse_hide_refs_config(const char *var, const char *value, const char *section)
{
	if (!strcmp("transfer.hiderefs", var) ||
	    /* NEEDSWORK: use parse_config_key() once both are merged */
4159
	    (starts_with(var, section) && var[strlen(section)] == '.' &&
4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186
	     !strcmp(var + strlen(section), ".hiderefs"))) {
		char *ref;
		int len;

		if (!value)
			return config_error_nonbool(var);
		ref = xstrdup(value);
		len = strlen(ref);
		while (len && ref[len - 1] == '/')
			ref[--len] = '\0';
		if (!hide_refs) {
			hide_refs = xcalloc(1, sizeof(*hide_refs));
			hide_refs->strdup_strings = 1;
		}
		string_list_append(hide_refs, ref);
	}
	return 0;
}

int ref_is_hidden(const char *refname)
{
	struct string_list_item *item;

	if (!hide_refs)
		return 0;
	for_each_string_list_item(item, hide_refs) {
		int len;
4187
		if (!starts_with(refname, item->string))
4188 4189 4190 4191 4192 4193 4194
			continue;
		len = strlen(item->string);
		if (!refname[len] || refname[len] == '/')
			return 1;
	}
	return 0;
}
4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221

struct expire_reflog_cb {
	unsigned int flags;
	reflog_expiry_should_prune_fn *should_prune_fn;
	void *policy_cb;
	FILE *newlog;
	unsigned char last_kept_sha1[20];
};

static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
			     const char *email, unsigned long timestamp, int tz,
			     const char *message, void *cb_data)
{
	struct expire_reflog_cb *cb = cb_data;
	struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;

	if (cb->flags & EXPIRE_REFLOGS_REWRITE)
		osha1 = cb->last_kept_sha1;

	if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,
				   message, policy_cb)) {
		if (!cb->newlog)
			printf("would prune %s", message);
		else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
			printf("prune %s", message);
	} else {
		if (cb->newlog) {
4222
			fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",
4223
				sha1_to_hex(osha1), sha1_to_hex(nsha1),
4224
				email, timestamp, tz, message);
4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244
			hashcpy(cb->last_kept_sha1, nsha1);
		}
		if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
			printf("keep %s", message);
	}
	return 0;
}

int reflog_expire(const char *refname, const unsigned char *sha1,
		 unsigned int flags,
		 reflog_expiry_prepare_fn prepare_fn,
		 reflog_expiry_should_prune_fn should_prune_fn,
		 reflog_expiry_cleanup_fn cleanup_fn,
		 void *policy_cb_data)
{
	static struct lock_file reflog_lock;
	struct expire_reflog_cb cb;
	struct ref_lock *lock;
	char *log_file;
	int status = 0;
4245
	int type;
4246
	struct strbuf err = STRBUF_INIT;
4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257

	memset(&cb, 0, sizeof(cb));
	cb.flags = flags;
	cb.policy_cb = policy_cb_data;
	cb.should_prune_fn = should_prune_fn;

	/*
	 * The reflog file is locked by holding the lock on the
	 * reference itself, plus we might need to update the
	 * reference if --updateref was specified:
	 */
4258 4259
	lock = lock_ref_sha1_basic(refname, sha1, NULL, NULL, 0, &type, &err);
	if (!lock) {
4260
		error("cannot lock ref '%s': %s", refname, err.buf);
4261
		strbuf_release(&err);
4262
		return -1;
4263
	}
4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297
	if (!reflog_exists(refname)) {
		unlock_ref(lock);
		return 0;
	}

	log_file = git_pathdup("logs/%s", refname);
	if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
		/*
		 * Even though holding $GIT_DIR/logs/$reflog.lock has
		 * no locking implications, we use the lock_file
		 * machinery here anyway because it does a lot of the
		 * work we need, including cleaning up if the program
		 * exits unexpectedly.
		 */
		if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
			struct strbuf err = STRBUF_INIT;
			unable_to_lock_message(log_file, errno, &err);
			error("%s", err.buf);
			strbuf_release(&err);
			goto failure;
		}
		cb.newlog = fdopen_lock_file(&reflog_lock, "w");
		if (!cb.newlog) {
			error("cannot fdopen %s (%s)",
			      reflog_lock.filename.buf, strerror(errno));
			goto failure;
		}
	}

	(*prepare_fn)(refname, sha1, cb.policy_cb);
	for_each_reflog_ent(refname, expire_reflog_ent, &cb);
	(*cleanup_fn)(cb.policy_cb);

	if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
4298 4299 4300
		/*
		 * It doesn't make sense to adjust a reference pointed
		 * to by a symbolic ref based on expiring entries in
4301 4302 4303
		 * the symbolic reference's reflog. Nor can we update
		 * a reference if there are no remaining reflog
		 * entries.
4304 4305
		 */
		int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&
4306 4307
			!(type & REF_ISSYMREF) &&
			!is_null_sha1(cb.last_kept_sha1);
4308

4309 4310 4311
		if (close_lock_file(&reflog_lock)) {
			status |= error("couldn't write %s: %s", log_file,
					strerror(errno));
4312
		} else if (update &&
4313
			   (write_in_full(lock->lk->fd,
4314
				sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
4315
			 write_str_in_full(lock->lk->fd, "\n") != 1 ||
4316 4317 4318 4319 4320 4321 4322
			 close_ref(lock) < 0)) {
			status |= error("couldn't write %s",
					lock->lk->filename.buf);
			rollback_lock_file(&reflog_lock);
		} else if (commit_lock_file(&reflog_lock)) {
			status |= error("unable to commit reflog '%s' (%s)",
					log_file, strerror(errno));
4323
		} else if (update && commit_ref(lock)) {
4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336
			status |= error("couldn't set %s", lock->ref_name);
		}
	}
	free(log_file);
	unlock_ref(lock);
	return status;

 failure:
	rollback_lock_file(&reflog_lock);
	free(log_file);
	unlock_ref(lock);
	return -1;
}