refs.c 110.3 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 13 14 15 16
struct ref_lock {
	char *ref_name;
	char *orig_ref_name;
	struct lock_file *lk;
	unsigned char old_sha1[20];
	int lock_fd;
};

17
/*
18 19
 * How to handle various characters in refnames:
 * 0: An acceptable character for refs
20 21 22 23
 * 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
24 25
 */
static unsigned char refname_disposition[256] = {
26 27 28 29
	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,
30
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
31 32 33
	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
34 35
};

36 37 38 39 40 41
/*
 * 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

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

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

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

60 61 62 63 64
/*
 * 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:
65 66 67 68
 *
 * - any path component of it begins with ".", or
 * - it has double dots "..", or
 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
69 70
 * - it ends with a "/".
 * - it ends with ".lock"
71 72 73 74 75 76 77 78
 * - it contains a "\" (backslash)
 */
static int check_refname_component(const char *refname, int flags)
{
	const char *cp;
	char last = '\0';

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

108
int check_refname_format(const char *refname, int flags)
109 110 111
{
	int component_len, component_count = 0;

F
Felipe Contreras 已提交
112 113 114 115
	if (!strcmp(refname, "@"))
		/* Refname is a single character '@'. */
		return -1;

116 117 118
	while (1) {
		/* We are at the start of a path component. */
		component_len = check_refname_component(refname, flags);
119
		if (component_len <= 0) {
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
			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;
145

146 147 148 149 150 151
/*
 * 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.
 */
152
struct ref_value {
153 154 155 156 157 158
	/*
	 * 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.
	 */
159
	unsigned char sha1[20];
160 161 162 163

	/*
	 * If REF_KNOWS_PEELED, then this field holds the peeled value
	 * of this reference, or null if the reference is known not to
164 165
	 * be peelable.  See the documentation for peel_ref() for an
	 * exact definition of "peelable".
166
	 */
167 168 169
	unsigned char peeled[20];
};

170 171
struct ref_cache;

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
/*
 * 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().
 */
198
struct ref_dir {
199
	int nr, alloc;
200 201 202 203 204 205 206 207 208

	/*
	 * 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;

209 210 211
	/* A pointer to the ref_cache that contains this ref_dir. */
	struct ref_cache *ref_cache;

212
	struct ref_entry **entries;
213 214
};

215 216
/*
 * Bit values for ref_entry::flag.  REF_ISSYMREF=0x01,
217 218
 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
 * public values; see refs.h.
219 220 221 222 223 224 225
 */

/*
 * 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.
 */
226
#define REF_KNOWS_PEELED 0x10
227 228

/* ref_entry represents a directory of references */
229
#define REF_DIR 0x20
230

231 232 233 234
/*
 * Entry has not yet been read from disk (used only for REF_DIR
 * entries representing loose references)
 */
235
#define REF_INCOMPLETE 0x40
236

237 238
/*
 * A ref_entry represents either a reference or a "subdirectory" of
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
 * 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).
254 255 256 257 258 259 260 261 262 263 264 265
 *
 * 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
266
 * separate issue that is regulated by verify_refname_available().)
267 268 269 270 271 272 273 274 275
 *
 * 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.
 */
276 277
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
278
	union {
279 280
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
281
	} u;
282 283 284 285 286
	/*
	 * 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/"):
	 */
287 288
	char name[FLEX_ARRAY];
};
289

290 291
static void read_loose_refs(const char *dirname, struct ref_dir *dir);

292 293
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
294
	struct ref_dir *dir;
295
	assert(entry->flag & REF_DIR);
296 297 298 299 300 301
	dir = &entry->u.subdir;
	if (entry->flag & REF_INCOMPLETE) {
		read_loose_refs(entry->name, dir);
		entry->flag &= ~REF_INCOMPLETE;
	}
	return dir;
302 303
}

304 305 306 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
/*
 * 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;
}

337 338 339
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
340 341
{
	int len;
342
	struct ref_entry *ref;
343

344
	if (check_name &&
345
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
346
		die("Reference has invalid format: '%s'", refname);
347 348
	if (!check_name && !refname_is_safe(refname))
		die("Reference has invalid name: '%s'", refname);
349 350
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
351 352
	hashcpy(ref->u.value.sha1, sha1);
	hashclr(ref->u.value.peeled);
353 354 355 356 357
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

358 359
static void clear_ref_dir(struct ref_dir *dir);

360 361
static void free_ref_entry(struct ref_entry *entry)
{
362 363 364 365 366 367 368
	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);
	}
369 370 371
	free(entry);
}

372 373 374 375 376 377
/*
 * 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)
378
{
379 380
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
381 382 383 384 385 386
	/* 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;
387 388
}

389 390 391
/*
 * Clear and free all entries in dir, recursively.
 */
392
static void clear_ref_dir(struct ref_dir *dir)
393 394
{
	int i;
395 396 397 398 399
	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;
400 401
}

402 403 404 405 406
/*
 * 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.
 */
407
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
408 409
					  const char *dirname, size_t len,
					  int incomplete)
410 411 412
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
413 414
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
415
	direntry->u.subdir.ref_cache = ref_cache;
416
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
417 418 419
	return direntry;
}

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

427
static void sort_ref_dir(struct ref_dir *dir);
428

429 430 431 432 433 434 435
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
436 437 438
	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);
439 440
	if (cmp)
		return cmp;
441
	return '\0' - (unsigned char)ent->name[key->len];
442 443
}

444
/*
445 446 447
 * 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.
448
 */
449
static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
450
{
451 452
	struct ref_entry **r;
	struct string_slice key;
453

454
	if (refname == NULL || !dir->nr)
455
		return -1;
456

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

	if (r == NULL)
464
		return -1;
465

466
	return r - dir->entries;
467 468
}

469 470 471 472 473
/*
 * 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
474
 * directory cannot be found.  dir must already be complete.
475
 */
476
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
477 478
					 const char *subdirname, size_t len,
					 int mkdir)
479
{
480 481 482
	int entry_index = search_ref_dir(dir, subdirname, len);
	struct ref_entry *entry;
	if (entry_index == -1) {
483 484
		if (!mkdir)
			return NULL;
485 486 487 488 489 490
		/*
		 * 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.
		 */
491
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
492
		add_entry_to_dir(dir, entry);
493 494
	} else {
		entry = dir->entries[entry_index];
495
	}
496
	return get_ref_dir(entry);
497 498
}

499 500 501 502
/*
 * 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
503 504 505 506
 * 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.
507 508 509 510
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
511 512
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
513
		size_t dirnamelen = slash - refname + 1;
514
		struct ref_dir *subdir;
515
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
516 517
		if (!subdir) {
			dir = NULL;
518
			break;
519
		}
520
		dir = subdir;
521 522 523 524 525 526 527 528 529 530 531 532
	}

	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)
{
533
	int entry_index;
534 535 536 537
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
538 539 540 541 542
	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;
543 544
}

545 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
/*
 * 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;
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
}

/*
 * 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;
}

610 611 612 613 614 615 616
/*
 * 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)
{
617
	if (strcmp(ref1->name, ref2->name))
618
		return 0;
619 620 621 622 623 624 625 626 627 628 629 630

	/* 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);

	if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
		die("Duplicated ref, and SHA1s don't match: %s", ref1->name);

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

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

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

649
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
650

651 652 653 654 655 656 657
	/* 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;
658
	}
659
	dir->sorted = dir->nr = i;
660
}
661

662 663
/* Include broken references in a do_for_each_ref*() iteration: */
#define DO_FOR_EACH_INCLUDE_BROKEN 0x01
664

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
/*
 * 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;
	if (!has_sha1_file(entry->u.value.sha1)) {
		error("%s does not point to a valid object!", entry->name);
		return 0;
	}
	return 1;
}
680

681 682 683 684 685 686 687 688 689
/*
 * 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.
 */
690
static struct ref_entry *current_ref;
691

692 693 694 695 696 697 698 699 700 701
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;
};

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

712
	if (!starts_with(entry->name, data->base))
713
		return 0;
714

715
	if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
716
	      !ref_resolves_to_object(entry))
717
		return 0;
718

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

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

756
/*
757
 * Call fn for each reference in the union of dir1 and dir2, in order
758 759 760
 * 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
761 762
 * sorted as needed.  fn is called for all references, including
 * broken ones.
763
 */
764 765 766
static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
				     struct ref_dir *dir2,
				     each_ref_entry_fn fn, void *cb_data)
767 768 769 770
{
	int retval;
	int i1 = 0, i2 = 0;

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

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
/*
 * 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 已提交
843 844

struct nonmatching_ref_data {
845
	const struct string_list *skip;
846
	const char *conflicting_refname;
847 848
};

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

853
	if (data->skip && string_list_has_string(data->skip, entry->name))
854
		return 0;
J
Jeff King 已提交
855

856
	data->conflicting_refname = entry->name;
J
Jeff King 已提交
857 858 859
	return 1;
}

860
/*
861 862
 * Return 0 if a reference named refname could be created without
 * conflicting with the name of an existing reference in dir.
863 864 865 866 867 868
 * 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 已提交
869 870
 *
 * Two reference names conflict if one of them exactly matches the
871 872 873
 * 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".
874
 *
875
 * extras and skip must be sorted.
876
 */
877 878 879
static int verify_refname_available(const char *refname,
				    const struct string_list *extras,
				    const struct string_list *skip,
880 881
				    struct ref_dir *dir,
				    struct strbuf *err)
882
{
J
Jeff King 已提交
883 884
	const char *slash;
	int pos;
885
	struct strbuf dirname = STRBUF_INIT;
886
	int ret = -1;
887

888 889 890 891 892
	/*
	 * For the sake of comments in this function, suppose that
	 * refname is "refs/foo/bar".
	 */

893 894
	assert(err);

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

J
Jeff King 已提交
900
		/*
901 902 903
		 * 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 已提交
904
		 */
905 906 907 908
		if (dir) {
			pos = search_ref_dir(dir, dirname.buf, dirname.len);
			if (pos >= 0 &&
			    (!skip || !string_list_has_string(skip, dirname.buf))) {
909
				/*
910 911 912
				 * We found a reference whose name is
				 * a proper prefix of refname; e.g.,
				 * "refs/foo", and is not in skip.
913
				 */
914 915
				strbuf_addf(err, "'%s' exists; cannot create '%s'",
					    dirname.buf, refname);
916
				goto cleanup;
917
			}
J
Jeff King 已提交
918 919
		}

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

		/*
		 * Otherwise, we can try to continue our search with
929
		 * the next component. So try to look up the
930 931 932 933
		 * 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 已提交
934
		 */
935
		strbuf_addch(&dirname, '/');
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
		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]);
			}
951
		}
J
Jeff King 已提交
952 953 954
	}

	/*
955 956 957 958 959 960
	 * 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 已提交
961
	 */
962
	strbuf_addstr(&dirname, refname + dirname.len);
963
	strbuf_addch(&dirname, '/');
J
Jeff King 已提交
964

965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
	if (dir) {
		pos = search_ref_dir(dir, dirname.buf, dirname.len);

		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)) {
982 983
				strbuf_addf(err, "'%s' exists; cannot create '%s'",
					    data.conflicting_refname, refname);
984 985 986 987 988 989
				goto cleanup;
			}
		}
	}

	if (extras) {
J
Jeff King 已提交
990
		/*
991 992 993 994 995 996
		 * 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 已提交
997
		 */
998 999 1000
		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 已提交
1001

1002 1003 1004 1005
			if (!starts_with(extra_refname, dirname.buf))
				break;

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

1013
	/* No conflicts were found */
1014
	ret = 0;
1015 1016 1017 1018

cleanup:
	strbuf_release(&dirname);
	return ret;
1019 1020
}

1021 1022
struct packed_ref_cache {
	struct ref_entry *root;
1023

1024 1025 1026 1027 1028 1029 1030 1031
	/*
	 * 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;

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

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

1045 1046 1047 1048
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
1049 1050
static struct ref_cache {
	struct ref_cache *next;
1051
	struct ref_entry *loose;
1052
	struct packed_ref_cache *packed;
1053 1054 1055 1056 1057 1058 1059
	/*
	 * 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;
1060

1061 1062 1063
/* Lock used for the main packed-refs file: */
static struct lock_file packlock;

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
/*
 * 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);
1080
		stat_validity_clear(&packed_refs->validity);
1081 1082 1083 1084 1085 1086 1087
		free(packed_refs);
		return 1;
	} else {
		return 0;
	}
}

1088
static void clear_packed_ref_cache(struct ref_cache *refs)
1089
{
1090
	if (refs->packed) {
1091 1092 1093
		struct packed_ref_cache *packed_refs = refs->packed;

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

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

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

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

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

	for (refs = submodule_ref_caches; refs; refs = refs->next)
1134 1135 1136
		if (!strcmp(submodule, refs->name))
			return refs;

1137
	refs = create_ref_cache(submodule);
1138 1139
	refs->next = submodule_ref_caches;
	submodule_ref_caches = refs;
1140
	return refs;
1141 1142
}

1143 1144 1145
/* The length of a peeled reference line in packed-refs, including EOL: */
#define PEELED_LINE_LENGTH 42

1146 1147 1148 1149 1150 1151 1152
/*
 * 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";

1153 1154 1155 1156 1157
/*
 * 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.
 */
1158
static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)
1159
{
1160 1161
	const char *ref;

1162 1163 1164 1165 1166 1167 1168 1169
	/*
	 * 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)
	 */
1170
	if (line->len <= 42)
1171
		return NULL;
1172 1173

	if (get_sha1_hex(line->buf, sha1) < 0)
1174
		return NULL;
1175
	if (!isspace(line->buf[40]))
1176
		return NULL;
1177 1178 1179

	ref = line->buf + 41;
	if (isspace(*ref))
1180
		return NULL;
1181 1182

	if (line->buf[line->len - 1] != '\n')
1183
		return NULL;
1184
	line->buf[--line->len] = 0;
1185

1186
	return ref;
1187 1188
}

1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
/*
 * 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).
 */
1216
static void read_packed_refs(FILE *f, struct ref_dir *dir)
1217
{
1218
	struct ref_entry *last = NULL;
1219
	struct strbuf line = STRBUF_INIT;
1220
	enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1221

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

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

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

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

	strbuf_release(&line);
1267 1268
}

1269 1270 1271 1272 1273
/*
 * 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)
1274
{
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
	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);

1286
	if (!refs->packed) {
1287
		FILE *f;
1288

1289
		refs->packed = xcalloc(1, sizeof(*refs->packed));
1290
		acquire_packed_ref_cache(refs->packed);
1291
		refs->packed->root = create_dir_entry(refs, "", 0, 0);
1292
		f = fopen(packed_refs_file, "r");
1293
		if (f) {
1294
			stat_validity_update(&refs->packed->validity, fileno(f));
1295
			read_packed_refs(f, get_ref_dir(refs->packed->root));
1296 1297 1298
			fclose(f);
		}
	}
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
	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));
1310 1311
}

1312 1313
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
1314 1315 1316 1317 1318 1319
	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),
1320
		create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1321 1322
}

1323
/*
1324 1325 1326
 * 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.
1327
 */
1328
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1329
{
1330
	struct ref_cache *refs = dir->ref_cache;
1331
	DIR *d;
1332
	const char *path;
1333
	struct dirent *de;
1334
	int dirnamelen = strlen(dirname);
1335
	struct strbuf refname;
1336

M
Michael Haggerty 已提交
1337
	if (*refs->name)
1338
		path = git_path_submodule(refs->name, "%s", dirname);
1339
	else
1340
		path = git_path("%s", dirname);
1341

1342
	d = opendir(path);
1343 1344 1345
	if (!d)
		return;

1346 1347
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
1348 1349 1350 1351 1352 1353 1354 1355 1356

	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 已提交
1357
		if (ends_with(de->d_name, ".lock"))
1358
			continue;
1359
		strbuf_addstr(&refname, de->d_name);
1360
		refdir = *refs->name
1361 1362 1363 1364 1365
			? 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)) {
1366
			strbuf_addch(&refname, '/');
1367
			add_entry_to_dir(dir,
1368 1369
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
1370
		} else {
M
Michael Haggerty 已提交
1371
			if (*refs->name) {
1372
				hashclr(sha1);
1373
				flag = 0;
1374
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1375
					hashclr(sha1);
1376
					flag |= REF_ISBROKEN;
1377
				}
1378 1379 1380
			} else if (read_ref_full(refname.buf,
						 RESOLVE_REF_READING,
						 sha1, &flag)) {
1381 1382 1383
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
1384 1385 1386 1387 1388
			if (check_refname_format(refname.buf,
						 REFNAME_ALLOW_ONELEVEL)) {
				hashclr(sha1);
				flag |= REF_BAD_NAME | REF_ISBROKEN;
			}
1389
			add_entry_to_dir(dir,
1390
					 create_ref_entry(refname.buf, sha1, flag, 0));
1391
		}
1392
		strbuf_setlen(&refname, dirnamelen);
1393
	}
1394
	strbuf_release(&refname);
1395
	closedir(d);
1396 1397
}

1398
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1399
{
1400
	if (!refs->loose) {
1401 1402 1403 1404 1405
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
1406
		refs->loose = create_dir_entry(refs, "", 0, 0);
1407 1408 1409 1410
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
1411
				 create_dir_entry(refs, "refs/", 5, 1));
1412
	}
1413
	return get_ref_dir(refs->loose);
1414 1415
}

1416 1417
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
1418 1419
#define MAXREFLEN (1024)

1420 1421
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
1422 1423
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
1424
 */
1425
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1426
				      const char *refname, unsigned char *sha1)
1427
{
1428
	struct ref_entry *ref;
1429
	struct ref_dir *dir = get_packed_refs(refs);
1430

1431
	ref = find_ref(dir, refname);
1432 1433 1434
	if (ref == NULL)
		return -1;

S
Sun He 已提交
1435
	hashcpy(sha1, ref->u.value.sha1);
1436
	return 0;
1437 1438
}

1439
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1440
					 const char *refname, unsigned char *sha1,
1441
					 int recursion)
1442
{
1443
	int fd, len;
1444
	char buffer[128], *p;
1445
	char *path;
1446

1447
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1448
		return -1;
1449 1450 1451 1452
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
1453
	if (fd < 0)
1454
		return resolve_gitlink_packed_ref(refs, refname, sha1);
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464

	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? */
1465
	if (!get_sha1_hex(buffer, sha1))
1466 1467 1468 1469 1470 1471 1472 1473 1474
		return 0;

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

1475
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1476 1477
}

1478
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1479 1480
{
	int len = strlen(path), retval;
1481
	char *submodule;
1482
	struct ref_cache *refs;
1483 1484 1485 1486 1487

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1488 1489 1490 1491
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1492
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1493 1494
	return retval;
}
1495

1496
/*
1497 1498
 * Return the ref_entry for the given refname from the packed
 * references.  If it does not exist, return NULL.
1499
 */
1500
static struct ref_entry *get_packed_ref(const char *refname)
1501
{
1502
	return find_ref(get_packed_refs(&ref_cache), refname);
1503 1504
}

1505 1506 1507 1508
/*
 * A loose ref file doesn't exist; check for a packed ref.  The
 * options are forwarded from resolve_safe_unsafe().
 */
1509 1510 1511 1512
static int resolve_missing_loose_ref(const char *refname,
				     int resolve_flags,
				     unsigned char *sha1,
				     int *flags)
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
{
	struct ref_entry *entry;

	/*
	 * The loose reference file does not exist; check for a packed
	 * reference.
	 */
	entry = get_packed_ref(refname);
	if (entry) {
		hashcpy(sha1, entry->u.value.sha1);
1523 1524
		if (flags)
			*flags |= REF_ISPACKED;
1525
		return 0;
1526 1527
	}
	/* The reference is not a packed reference, either. */
1528
	if (resolve_flags & RESOLVE_REF_READING) {
1529 1530
		errno = ENOENT;
		return -1;
1531 1532
	} else {
		hashclr(sha1);
1533
		return 0;
1534 1535 1536
	}
}

1537
/* This function needs to return a meaningful errno on failure */
1538
const char *resolve_ref_unsafe(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1539
{
1540 1541
	int depth = MAXDEPTH;
	ssize_t len;
1542
	char buffer[256];
1543
	static char refname_buffer[256];
1544
	int bad_name = 0;
1545

1546 1547
	if (flags)
		*flags = 0;
1548

1549
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
		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;
1567
	}
1568
	for (;;) {
1569
		char path[PATH_MAX];
1570 1571 1572
		struct stat st;
		char *buf;
		int fd;
1573

1574 1575
		if (--depth < 0) {
			errno = ELOOP;
1576
			return NULL;
1577
		}
1578

1579
		git_snpath(path, sizeof(path), "%s", refname);
1580

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
		/*
		 * 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:
1591
		if (lstat(path, &st) < 0) {
1592 1593 1594 1595
			if (errno != ENOENT)
				return NULL;
			if (resolve_missing_loose_ref(refname, resolve_flags,
						      sha1, flags))
1596
				return NULL;
1597 1598 1599 1600 1601 1602
			if (bad_name) {
				hashclr(sha1);
				if (flags)
					*flags |= REF_ISBROKEN;
			}
			return refname;
1603
		}
1604

1605 1606 1607
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1608 1609 1610 1611 1612 1613 1614
			if (len < 0) {
				if (errno == ENOENT || errno == EINVAL)
					/* inconsistent with lstat; retry */
					goto stat_ref;
				else
					return NULL;
			}
M
Michael Haggerty 已提交
1615
			buffer[len] = 0;
1616
			if (starts_with(buffer, "refs/") &&
1617
					!check_refname_format(buffer, 0)) {
1618 1619
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1620 1621
				if (flags)
					*flags |= REF_ISSYMREF;
1622 1623 1624 1625
				if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
					hashclr(sha1);
					return refname;
				}
1626 1627
				continue;
			}
1628
		}
1629

1630 1631 1632 1633 1634 1635
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1636 1637 1638 1639 1640
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
1641 1642 1643 1644 1645 1646 1647
		if (fd < 0) {
			if (errno == ENOENT)
				/* inconsistent with lstat; retry */
				goto stat_ref;
			else
				return NULL;
		}
1648
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1649 1650 1651 1652
		if (len < 0) {
			int save_errno = errno;
			close(fd);
			errno = save_errno;
1653
			return NULL;
1654 1655
		}
		close(fd);
1656 1657 1658
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1659 1660 1661 1662

		/*
		 * Is it a symbolic ref?
		 */
1663
		if (!starts_with(buffer, "ref:")) {
1664 1665 1666 1667 1668 1669
			/*
			 * Please note that FETCH_HEAD has a second
			 * line containing other data.
			 */
			if (get_sha1_hex(buffer, sha1) ||
			    (buffer[40] != '\0' && !isspace(buffer[40]))) {
1670 1671
				if (flags)
					*flags |= REF_ISBROKEN;
1672
				errno = EINVAL;
1673 1674
				return NULL;
			}
1675 1676 1677 1678 1679
			if (bad_name) {
				hashclr(sha1);
				if (flags)
					*flags |= REF_ISBROKEN;
			}
1680 1681
			return refname;
		}
1682 1683
		if (flags)
			*flags |= REF_ISSYMREF;
1684
		buf = buffer + 4;
1685 1686
		while (isspace(*buf))
			buf++;
1687 1688 1689 1690 1691
		refname = strcpy(refname_buffer, buf);
		if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
			hashclr(sha1);
			return refname;
		}
1692
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1693 1694
			if (flags)
				*flags |= REF_ISBROKEN;
1695 1696 1697 1698 1699 1700 1701

			if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
			    !refname_is_safe(buf)) {
				errno = EINVAL;
				return NULL;
			}
			bad_name = 1;
1702
		}
1703
	}
1704 1705
}

1706
char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)
1707
{
1708
	return xstrdup_or_null(resolve_ref_unsafe(ref, resolve_flags, sha1, flags));
1709 1710
}

I
Ilari Liusvaara 已提交
1711 1712 1713 1714 1715 1716 1717
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1718
int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1719
{
1720
	if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
1721 1722
		return 0;
	return -1;
1723 1724
}

1725
int read_ref(const char *refname, unsigned char *sha1)
1726
{
1727
	return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
1728 1729
}

1730
int ref_exists(const char *refname)
1731
{
1732
	unsigned char sha1[20];
1733
	return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
1734 1735
}

1736
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1737
		       void *data)
I
Ilari Liusvaara 已提交
1738 1739
{
	struct ref_filter *filter = (struct ref_filter *)data;
1740
	if (wildmatch(filter->pattern, refname, 0, NULL))
I
Ilari Liusvaara 已提交
1741
		return 0;
1742
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1743 1744
}

1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
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: */
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
	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
1768 1769
};

1770 1771
/*
 * Peel the named object; i.e., if the object is a tag, resolve the
1772 1773 1774 1775
 * 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.
1776
 */
1777
static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1778 1779 1780 1781 1782
{
	struct object *o = lookup_unknown_object(name);

	if (o->type == OBJ_NONE) {
		int type = sha1_object_info(name, NULL);
1783
		if (type < 0 || !object_as_type(o, type, 0))
1784
			return PEEL_INVALID;
1785 1786 1787
	}

	if (o->type != OBJ_TAG)
1788
		return PEEL_NON_TAG;
1789 1790 1791

	o = deref_tag_noverify(o);
	if (!o)
1792
		return PEEL_INVALID;
1793 1794

	hashcpy(sha1, o->sha1);
1795
	return PEEL_PEELED;
1796 1797
}

1798
/*
1799 1800 1801
 * 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.
1802 1803 1804 1805 1806 1807
 *
 * 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.
1808
 */
1809
static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1810 1811 1812
{
	enum peel_status status;

1813 1814 1815 1816 1817 1818 1819 1820 1821
	if (entry->flag & REF_KNOWS_PEELED) {
		if (repeel) {
			entry->flag &= ~REF_KNOWS_PEELED;
			hashclr(entry->u.value.peeled);
		} else {
			return is_null_sha1(entry->u.value.peeled) ?
				PEEL_NON_TAG : PEEL_PEELED;
		}
	}
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
	if (entry->flag & REF_ISBROKEN)
		return PEEL_BROKEN;
	if (entry->flag & REF_ISSYMREF)
		return PEEL_IS_SYMREF;

	status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
	if (status == PEEL_PEELED || status == PEEL_NON_TAG)
		entry->flag |= REF_KNOWS_PEELED;
	return status;
}

1833
int peel_ref(const char *refname, unsigned char *sha1)
1834 1835 1836 1837
{
	int flag;
	unsigned char base[20];

1838
	if (current_ref && (current_ref->name == refname
1839
			    || !strcmp(current_ref->name, refname))) {
1840
		if (peel_entry(current_ref, 0))
1841 1842 1843
			return -1;
		hashcpy(sha1, current_ref->u.value.peeled);
		return 0;
1844 1845
	}

1846
	if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1847 1848
		return -1;

1849 1850 1851 1852 1853 1854 1855 1856 1857
	/*
	 * 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) {
1858
		struct ref_entry *r = get_packed_ref(refname);
1859
		if (r) {
1860
			if (peel_entry(r, 0))
1861
				return -1;
1862
			hashcpy(sha1, r->u.value.peeled);
1863
			return 0;
1864 1865 1866
		}
	}

1867
	return peel_object(base, sha1);
1868 1869
}

1870 1871 1872
struct warn_if_dangling_data {
	FILE *fp;
	const char *refname;
1873
	const struct string_list *refnames;
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
	const char *msg_fmt;
};

static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
				   int flags, void *cb_data)
{
	struct warn_if_dangling_data *d = cb_data;
	const char *resolves_to;
	unsigned char junk[20];

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

1887
	resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);
1888 1889 1890 1891
	if (!resolves_to
	    || (d->refname
		? strcmp(resolves_to, d->refname)
		: !string_list_has_string(d->refnames, resolves_to))) {
1892
		return 0;
1893
	}
1894 1895

	fprintf(d->fp, d->msg_fmt, refname);
J
Junio C Hamano 已提交
1896
	fputc('\n', d->fp);
1897 1898 1899 1900 1901 1902 1903 1904 1905
	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;
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
	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;
1918 1919 1920 1921
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

1922
/*
1923
 * Call fn for each reference in the specified ref_cache, omitting
1924 1925
 * references not in the containing_dir of base.  fn is called for all
 * references, including broken ones.  If fn ever returns a non-zero
1926 1927 1928
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
1929
static int do_for_each_entry(struct ref_cache *refs, const char *base,
1930
			     each_ref_entry_fn fn, void *cb_data)
1931
{
1932 1933 1934
	struct packed_ref_cache *packed_ref_cache;
	struct ref_dir *loose_dir;
	struct ref_dir *packed_dir;
1935 1936
	int retval = 0;

1937 1938 1939 1940 1941 1942 1943 1944 1945
	/*
	 * 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);
1946 1947 1948
	if (base && *base) {
		loose_dir = find_containing_dir(loose_dir, base, 0);
	}
1949 1950 1951 1952
	if (loose_dir)
		prime_ref_dir(loose_dir);

	packed_ref_cache = get_packed_ref_cache(refs);
1953
	acquire_packed_ref_cache(packed_ref_cache);
1954
	packed_dir = get_packed_ref_dir(packed_ref_cache);
1955 1956 1957 1958 1959 1960 1961
	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);
1962 1963
		retval = do_for_each_entry_in_dirs(
				packed_dir, loose_dir, fn, cb_data);
1964 1965
	} else if (packed_dir) {
		sort_ref_dir(packed_dir);
1966 1967
		retval = do_for_each_entry_in_dir(
				packed_dir, 0, fn, cb_data);
1968 1969
	} else if (loose_dir) {
		sort_ref_dir(loose_dir);
1970 1971
		retval = do_for_each_entry_in_dir(
				loose_dir, 0, fn, cb_data);
1972 1973
	}

1974
	release_packed_ref_cache(packed_ref_cache);
1975
	return retval;
1976 1977
}

1978
/*
1979
 * Call fn for each reference in the specified ref_cache for which the
1980 1981 1982 1983 1984 1985 1986
 * 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.
 */
1987 1988
static int do_for_each_ref(struct ref_cache *refs, const char *base,
			   each_ref_fn fn, int trim, int flags, void *cb_data)
1989 1990 1991 1992 1993 1994 1995 1996
{
	struct ref_entry_cb data;
	data.base = base;
	data.trim = trim;
	data.flags = flags;
	data.fn = fn;
	data.cb_data = cb_data;

1997 1998 1999 2000 2001
	if (ref_paranoia < 0)
		ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
	if (ref_paranoia)
		data.flags |= DO_FOR_EACH_INCLUDE_BROKEN;

2002
	return do_for_each_entry(refs, base, do_one_ref, &data);
2003 2004
}

2005
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
2006 2007
{
	unsigned char sha1[20];
2008 2009
	int flag;

2010 2011 2012 2013 2014 2015 2016
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

2017
	if (!read_ref_full("HEAD", RESOLVE_REF_READING, sha1, &flag))
2018
		return fn("HEAD", sha1, flag, cb_data);
2019

2020
	return 0;
2021 2022
}

2023 2024 2025 2026 2027
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

2028 2029 2030 2031 2032
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

2033
int for_each_ref(each_ref_fn fn, void *cb_data)
2034
{
2035
	return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
2036 2037
}

2038 2039
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
2040
	return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
2041 2042
}

2043 2044
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
2045
	return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
2046 2047
}

2048 2049 2050
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
2051
	return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
2052 2053
}

2054
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
2055
{
2056
	return for_each_ref_in("refs/tags/", fn, cb_data);
2057 2058
}

2059 2060 2061 2062 2063
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);
}

2064
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
2065
{
2066
	return for_each_ref_in("refs/heads/", fn, cb_data);
2067 2068
}

2069 2070 2071 2072 2073
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);
}

2074
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
2075
{
2076
	return for_each_ref_in("refs/remotes/", fn, cb_data);
2077 2078
}

2079 2080 2081 2082 2083
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);
}

2084 2085
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
2086
	return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
2087 2088
}

J
Josh Triplett 已提交
2089 2090 2091 2092 2093 2094 2095 2096
int head_ref_namespaced(each_ref_fn fn, void *cb_data)
{
	struct strbuf buf = STRBUF_INIT;
	int ret = 0;
	unsigned char sha1[20];
	int flag;

	strbuf_addf(&buf, "%sHEAD", get_git_namespace());
2097
	if (!read_ref_full(buf.buf, RESOLVE_REF_READING, sha1, &flag))
J
Josh Triplett 已提交
2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
		ret = fn(buf.buf, sha1, flag, cb_data);
	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());
2109
	ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
J
Josh Triplett 已提交
2110 2111 2112 2113
	strbuf_release(&buf);
	return ret;
}

2114 2115
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
2116 2117 2118 2119 2120
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

2121
	if (!prefix && !starts_with(pattern, "refs/"))
I
Ilari Liusvaara 已提交
2122
		strbuf_addstr(&real_pattern, "refs/");
2123 2124
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
2125 2126
	strbuf_addstr(&real_pattern, pattern);

2127
	if (!has_glob_specials(pattern)) {
2128
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
		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;
}

2144 2145 2146 2147 2148
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);
}

2149 2150
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
2151
	return do_for_each_ref(&ref_cache, "", fn, 0,
2152
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
2153 2154
}

2155
const char *prettify_refname(const char *name)
2156 2157
{
	return name + (
2158 2159 2160
		starts_with(name, "refs/heads/") ? 11 :
		starts_with(name, "refs/tags/") ? 10 :
		starts_with(name, "refs/remotes/") ? 13 :
2161 2162 2163
		0);
}

2164
static const char *ref_rev_parse_rules[] = {
S
Steffen Prohaska 已提交
2165 2166 2167 2168 2169 2170 2171 2172 2173
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

2174
int refname_match(const char *abbrev_name, const char *full_name)
S
Steffen Prohaska 已提交
2175 2176 2177 2178
{
	const char **p;
	const int abbrev_name_len = strlen(abbrev_name);

2179
	for (p = ref_rev_parse_rules; *p; p++) {
S
Steffen Prohaska 已提交
2180 2181 2182 2183 2184 2185 2186 2187
		if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
			return 1;
		}
	}

	return 0;
}

2188 2189 2190 2191 2192 2193 2194 2195 2196 2197
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);
}

2198
/* This function should make sure errno is meaningful on error */
J
Junio C Hamano 已提交
2199
static struct ref_lock *verify_lock(struct ref_lock *lock,
2200 2201
	const unsigned char *old_sha1, int mustexist)
{
2202 2203 2204
	if (read_ref_full(lock->ref_name,
			  mustexist ? RESOLVE_REF_READING : 0,
			  lock->old_sha1, NULL)) {
2205
		int save_errno = errno;
2206
		error("Can't verify ref %s", lock->ref_name);
2207
		unlock_ref(lock);
2208
		errno = save_errno;
2209 2210
		return NULL;
	}
2211
	if (hashcmp(lock->old_sha1, old_sha1)) {
2212
		error("Ref %s is at %s but expected %s", lock->ref_name,
2213 2214
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
2215
		errno = EBUSY;
2216 2217 2218 2219 2220
		return NULL;
	}
	return lock;
}

2221
static int remove_empty_directories(const char *file)
2222 2223 2224 2225 2226
{
	/* 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.
	 */
2227
	struct strbuf path;
2228
	int result, save_errno;
2229

2230 2231 2232
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

2233
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
2234
	save_errno = errno;
2235 2236

	strbuf_release(&path);
2237
	errno = save_errno;
2238 2239

	return result;
2240 2241
}

2242 2243 2244 2245 2246 2247 2248 2249
/*
 * *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;
2250
	int ret = interpret_branch_name(*string, *len, &buf);
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276

	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);
2277 2278
		r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
				       this_result, &flag);
2279 2280 2281 2282 2283
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
2284
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2285
			warning("ignoring dangling symref %s.", fullref);
2286 2287 2288
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306
	}
	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);
2307 2308
		ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
					 hash, NULL);
2309 2310
		if (!ref)
			continue;
2311
		if (reflog_exists(path))
2312
			it = path;
2313
		else if (strcmp(ref, path) && reflog_exists(ref))
2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
			it = ref;
		else
			continue;
		if (!logs_found++) {
			*log = xstrdup(it);
			hashcpy(sha1, hash);
		}
		if (!warn_ambiguous_refs)
			break;
	}
	free(last_branch);
	return logs_found;
}

2328
/*
2329
 * Locks a ref returning the lock on success and NULL on failure.
2330 2331
 * On failure errno is set to something meaningful.
 */
2332 2333
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
2334
					    const struct string_list *extras,
2335
					    const struct string_list *skip,
2336
					    unsigned int flags, int *type_p)
2337
{
2338
	char *ref_file;
2339
	const char *orig_refname = refname;
2340
	struct ref_lock *lock;
2341
	int last_errno = 0;
2342
	int type, lflags;
2343
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2344
	int resolve_flags = 0;
2345
	int attempts_remaining = 3;
2346
	struct strbuf err = STRBUF_INIT;
2347 2348 2349 2350

	lock = xcalloc(1, sizeof(struct ref_lock));
	lock->lock_fd = -1;

2351 2352
	if (mustexist)
		resolve_flags |= RESOLVE_REF_READING;
2353 2354 2355 2356 2357
	if (flags & REF_DELETING) {
		resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
		if (flags & REF_NODEREF)
			resolve_flags |= RESOLVE_REF_NO_RECURSE;
	}
2358 2359 2360

	refname = resolve_ref_unsafe(refname, resolve_flags,
				     lock->old_sha1, &type);
2361
	if (!refname && errno == EISDIR) {
2362 2363 2364 2365 2366
		/* 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.
		 */
2367
		ref_file = git_path("%s", orig_refname);
2368 2369
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
2370
			error("there are still refs under '%s'", orig_refname);
2371 2372
			goto error_return;
		}
2373 2374
		refname = resolve_ref_unsafe(orig_refname, resolve_flags,
					     lock->old_sha1, &type);
2375
	}
2376 2377
	if (type_p)
	    *type_p = type;
2378
	if (!refname) {
2379
		last_errno = errno;
2380
		error("unable to resolve reference %s: %s",
2381
			orig_refname, strerror(errno));
2382
		goto error_return;
2383
	}
2384 2385 2386 2387 2388
	/*
	 * 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.
2389
	 */
2390
	if (is_null_sha1(lock->old_sha1) &&
2391 2392 2393
	    verify_refname_available(refname, extras, skip,
				     get_packed_refs(&ref_cache), &err)) {
		error("%s", err.buf);
2394
		last_errno = ENOTDIR;
2395
		goto error_return;
2396
	}
2397

2398
	lock->lk = xcalloc(1, sizeof(struct lock_file));
2399

2400
	lflags = 0;
2401
	if (flags & REF_NODEREF) {
2402
		refname = orig_refname;
2403
		lflags |= LOCK_NO_DEREF;
2404
	}
2405 2406 2407
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
2408

2409 2410 2411 2412 2413 2414 2415 2416 2417
 retry:
	switch (safe_create_leading_directories(ref_file)) {
	case SCLD_OK:
		break; /* success */
	case SCLD_VANISHED:
		if (--attempts_remaining > 0)
			goto retry;
		/* fall through */
	default:
2418 2419 2420 2421
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
2422

2423
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
2424
	if (lock->lock_fd < 0) {
2425
		last_errno = errno;
2426 2427 2428 2429 2430 2431 2432
		if (errno == ENOENT && --attempts_remaining > 0)
			/*
			 * Maybe somebody just deleted one of the
			 * directories leading to ref_file.  Try
			 * again:
			 */
			goto retry;
2433 2434 2435 2436 2437
		else {
			unable_to_lock_message(ref_file, errno, &err);
			error("%s", err.buf);
			goto error_return;
		}
2438
	}
2439
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
2440 2441 2442

 error_return:
	unlock_ref(lock);
2443
	strbuf_release(&err);
2444 2445
	errno = last_errno;
	return NULL;
2446 2447
}

2448 2449 2450 2451
/*
 * 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.
 */
2452
static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2453
			       unsigned char *peeled)
2454
{
2455 2456 2457
	fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
	if (peeled)
		fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2458 2459
}

2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
/*
 * 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);
2470
	write_packed_entry(cb_data, entry->name, entry->u.value.sha1,
2471 2472 2473 2474 2475
			   peel_status == PEEL_PEELED ?
			   entry->u.value.peeled : NULL);
	return 0;
}

2476
/* This should return a meaningful errno on failure */
2477 2478 2479 2480 2481 2482
int lock_packed_refs(int flags)
{
	struct packed_ref_cache *packed_ref_cache;

	if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)
		return -1;
2483 2484 2485 2486 2487 2488
	/*
	 * 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.
	 */
2489 2490
	packed_ref_cache = get_packed_ref_cache(&ref_cache);
	packed_ref_cache->lock = &packlock;
2491 2492
	/* Increment the reference count to prevent it from being freed: */
	acquire_packed_ref_cache(packed_ref_cache);
2493 2494 2495
	return 0;
}

2496 2497 2498 2499
/*
 * Commit the packed refs changes.
 * On error we must make sure that errno contains a meaningful value.
 */
2500 2501 2502 2503 2504
int commit_packed_refs(void)
{
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);
	int error = 0;
2505
	int save_errno = 0;
2506
	FILE *out;
2507 2508 2509 2510

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

2511
	out = fdopen_lock_file(packed_ref_cache->lock, "w");
2512 2513 2514 2515
	if (!out)
		die_errno("unable to fdopen packed-refs descriptor");

	fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2516
	do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2517 2518
				 0, write_packed_entry_fn, out);

2519 2520
	if (commit_lock_file(packed_ref_cache->lock)) {
		save_errno = errno;
2521
		error = -1;
2522
	}
2523
	packed_ref_cache->lock = NULL;
2524
	release_packed_ref_cache(packed_ref_cache);
2525
	errno = save_errno;
2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
	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;
2538
	release_packed_ref_cache(packed_ref_cache);
2539 2540 2541
	clear_packed_ref_cache(&ref_cache);
}

2542 2543 2544 2545 2546 2547 2548 2549
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;
2550
	struct ref_dir *packed_refs;
2551 2552 2553
	struct ref_to_prune *ref_to_prune;
};

2554 2555 2556 2557 2558 2559 2560
/*
 * 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)
2561 2562
{
	struct pack_refs_cb_data *cb = cb_data;
2563
	enum peel_status peel_status;
2564
	struct ref_entry *packed_entry;
2565
	int is_tag_ref = starts_with(entry->name, "refs/tags/");
2566

2567 2568
	/* ALWAYS pack tags */
	if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2569 2570
		return 0;

2571 2572 2573 2574
	/* Do not pack symbolic or broken refs: */
	if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
		return 0;

2575
	/* Add a packed ref cache entry equivalent to the loose entry. */
2576
	peel_status = peel_entry(entry, 1);
2577
	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2578 2579
		die("internal error peeling reference %s (%s)",
		    entry->name, sha1_to_hex(entry->u.value.sha1));
2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
	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;
		hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
	} else {
		packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
						REF_ISPACKED | REF_KNOWS_PEELED, 0);
		add_ref(cb->packed_refs, packed_entry);
	}
	hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
2591

2592 2593
	/* Schedule the loose reference for pruning if requested. */
	if ((cb->flags & PACK_REFS_PRUNE)) {
2594
		int namelen = strlen(entry->name) + 1;
2595
		struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2596 2597
		hashcpy(n->sha1, entry->u.value.sha1);
		strcpy(n->name, entry->name);
2598 2599 2600
		n->next = cb->ref_to_prune;
		cb->ref_to_prune = n;
	}
2601 2602 2603
	return 0;
}

2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637
/*
 * 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)
{
2638 2639
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
2640

2641
	if (check_refname_format(r->name, 0))
R
Ronnie Sahlberg 已提交
2642
		return;
2643

2644 2645 2646
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
	    ref_transaction_delete(transaction, r->name, r->sha1,
2647
				   REF_ISPRUNING, NULL, &err) ||
2648
	    ref_transaction_commit(transaction, &err)) {
2649 2650 2651 2652
		ref_transaction_free(transaction);
		error("%s", err.buf);
		strbuf_release(&err);
		return;
2653
	}
2654 2655 2656
	ref_transaction_free(transaction);
	strbuf_release(&err);
	try_remove_empty_parents(r->name);
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673
}

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;

2674
	lock_packed_refs(LOCK_DIE_ON_ERROR);
2675
	cbdata.packed_refs = get_packed_refs(&ref_cache);
2676

2677 2678
	do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
				 pack_if_possible_fn, &cbdata);
2679

2680
	if (commit_packed_refs())
2681
		die_errno("unable to overwrite old ref-pack file");
2682

2683 2684 2685 2686
	prune_refs(cbdata.ref_to_prune);
	return 0;
}

2687
int repack_without_refs(struct string_list *refnames, struct strbuf *err)
J
Junio C Hamano 已提交
2688
{
2689
	struct ref_dir *packed;
J
Jeff King 已提交
2690
	struct string_list_item *refname;
2691
	int ret, needs_repacking = 0, removed = 0;
2692

2693 2694
	assert(err);

2695
	/* Look for a packed ref */
2696 2697 2698
	for_each_string_list_item(refname, refnames) {
		if (get_packed_ref(refname->string)) {
			needs_repacking = 1;
2699
			break;
2700 2701
		}
	}
2702

2703
	/* Avoid locking if we have nothing to do */
2704
	if (!needs_repacking)
2705
		return 0; /* no refname exists in packed refs */
2706

2707
	if (lock_packed_refs(0)) {
2708 2709
		unable_to_lock_message(git_path("packed-refs"), errno, err);
		return -1;
2710
	}
2711
	packed = get_packed_refs(&ref_cache);
2712

2713
	/* Remove refnames from the cache */
2714 2715
	for_each_string_list_item(refname, refnames)
		if (remove_entry(packed, refname->string) != -1)
2716 2717
			removed = 1;
	if (!removed) {
2718
		/*
2719
		 * All packed entries disappeared while we were
2720 2721
		 * acquiring the lock.
		 */
2722
		rollback_packed_refs();
2723 2724
		return 0;
	}
2725

2726
	/* Write what remains */
2727
	ret = commit_packed_refs();
2728
	if (ret)
2729 2730 2731
		strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
			    strerror(errno));
	return ret;
J
Junio C Hamano 已提交
2732 2733
}

2734
static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2735
{
2736 2737
	assert(err);

2738
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2739 2740 2741 2742
		/*
		 * loose.  The loose file name is the same as the
		 * lockfile name, minus ".lock":
		 */
2743
		char *loose_filename = get_locked_file_path(lock->lk);
2744
		int res = unlink_or_msg(loose_filename, err);
2745
		free(loose_filename);
2746
		if (res)
2747
			return 1;
J
Junio C Hamano 已提交
2748
	}
2749 2750 2751
	return 0;
}

2752
int delete_ref(const char *refname, const unsigned char *sha1, unsigned int flags)
J
Junio C Hamano 已提交
2753
{
2754 2755
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
J
Junio C Hamano 已提交
2756

2757 2758
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
2759 2760 2761
	    ref_transaction_delete(transaction, refname,
				   (sha1 && !is_null_sha1(sha1)) ? sha1 : NULL,
				   flags, NULL, &err) ||
2762
	    ref_transaction_commit(transaction, &err)) {
2763 2764 2765
		error("%s", err.buf);
		ref_transaction_free(transaction);
		strbuf_release(&err);
J
Junio C Hamano 已提交
2766
		return 1;
2767 2768 2769 2770
	}
	ref_transaction_free(transaction);
	strbuf_release(&err);
	return 0;
2771 2772
}

2773 2774 2775 2776 2777 2778 2779 2780 2781
/*
 * 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"

2782 2783
static int rename_tmp_log(const char *newrefname)
{
2784
	int attempts_remaining = 4;
2785 2786

 retry:
2787 2788 2789 2790 2791 2792 2793 2794
	switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {
	case SCLD_OK:
		break; /* success */
	case SCLD_VANISHED:
		if (--attempts_remaining > 0)
			goto retry;
		/* fall through */
	default:
2795 2796 2797 2798 2799
		error("unable to create directory for %s", newrefname);
		return -1;
	}

	if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2800
		if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2801 2802 2803 2804 2805 2806 2807 2808 2809 2810
			/*
			 * 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;
2811 2812 2813 2814 2815 2816 2817
		} 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;
2818 2819 2820 2821 2822 2823 2824 2825 2826
		} else {
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
				newrefname, strerror(errno));
			return -1;
		}
	}
	return 0;
}

2827 2828 2829
static int rename_ref_available(const char *oldname, const char *newname)
{
	struct string_list skip = STRING_LIST_INIT_NODUP;
2830
	struct strbuf err = STRBUF_INIT;
2831 2832 2833
	int ret;

	string_list_insert(&skip, oldname);
2834
	ret = !verify_refname_available(newname, NULL, &skip,
2835
					get_packed_refs(&ref_cache), &err)
2836
		&& !verify_refname_available(newname, NULL, &skip,
2837 2838 2839 2840
					     get_loose_refs(&ref_cache), &err);
	if (!ret)
		error("%s", err.buf);

2841
	string_list_clear(&skip, 0);
2842
	strbuf_release(&err);
2843 2844 2845
	return ret;
}

2846 2847 2848
static int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1,
			  const char *logmsg);

2849
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2850 2851 2852 2853 2854
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
2855
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
2856
	const char *symref = NULL;
2857

2858
	if (log && S_ISLNK(loginfo.st_mode))
2859
		return error("reflog for %s is a symlink", oldrefname);
2860

2861 2862
	symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,
				    orig_sha1, &flag);
M
Miklos Vajna 已提交
2863
	if (flag & REF_ISSYMREF)
2864
		return error("refname %s is a symbolic ref, renaming it is not supported",
2865
			oldrefname);
M
Miklos Vajna 已提交
2866
	if (!symref)
2867
		return error("refname %s not found", oldrefname);
2868

2869
	if (!rename_ref_available(oldrefname, newrefname))
2870 2871
		return 1;

2872
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2873
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2874
			oldrefname, strerror(errno));
2875

2876 2877
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
2878 2879 2880
		goto rollback;
	}

2881
	if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&
2882
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
2883
		if (errno==EISDIR) {
2884 2885
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
2886 2887 2888
				goto rollback;
			}
		} else {
2889
			error("unable to delete existing %s", newrefname);
2890 2891 2892 2893
			goto rollback;
		}
	}

2894
	if (log && rename_tmp_log(newrefname))
2895 2896 2897 2898
		goto rollback;

	logmoved = log;

2899
	lock = lock_ref_sha1_basic(newrefname, NULL, NULL, NULL, 0, NULL);
2900
	if (!lock) {
2901
		error("unable to lock %s for update", newrefname);
2902 2903 2904
		goto rollback;
	}
	hashcpy(lock->old_sha1, orig_sha1);
2905
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2906
		error("unable to write current sha1 into %s", newrefname);
2907 2908 2909 2910 2911 2912
		goto rollback;
	}

	return 0;

 rollback:
2913
	lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, NULL, 0, NULL);
2914
	if (!lock) {
2915
		error("unable to lock %s for rollback", oldrefname);
2916 2917 2918 2919 2920 2921
		goto rollbacklog;
	}

	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
2922
		error("unable to write current sha1 into %s", oldrefname);
2923 2924 2925
	log_all_ref_updates = flag;

 rollbacklog:
2926
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2927
		error("unable to restore logfile %s from %s: %s",
2928
			oldrefname, newrefname, strerror(errno));
2929
	if (!logmoved && log &&
2930
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2931
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2932
			oldrefname, strerror(errno));
2933 2934 2935 2936

	return 1;
}

2937
static int close_ref(struct ref_lock *lock)
2938 2939 2940 2941 2942 2943 2944
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

2945
static int commit_ref(struct ref_lock *lock)
2946 2947 2948 2949 2950 2951 2952
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978
/*
 * 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;
}

2979
/* This function must set a meaningful errno on failure */
2980
int log_ref_setup(const char *refname, char *logfile, int bufsize)
2981
{
2982
	int logfd, oflags = O_APPEND | O_WRONLY;
2983

2984
	git_snpath(logfile, bufsize, "logs/%s", refname);
2985
	if (log_all_ref_updates &&
2986 2987 2988
	    (starts_with(refname, "refs/heads/") ||
	     starts_with(refname, "refs/remotes/") ||
	     starts_with(refname, "refs/notes/") ||
2989
	     !strcmp(refname, "HEAD"))) {
2990 2991 2992 2993 2994 2995
		if (safe_create_leading_directories(logfile) < 0) {
			int save_errno = errno;
			error("unable to create directory for %s", logfile);
			errno = save_errno;
			return -1;
		}
2996 2997 2998
		oflags |= O_CREAT;
	}

2999
	logfd = open(logfile, oflags, 0666);
3000
	if (logfd < 0) {
3001
		if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))
3002
			return 0;
3003

3004
		if (errno == EISDIR) {
3005
			if (remove_empty_directories(logfile)) {
3006 3007 3008 3009 3010
				int save_errno = errno;
				error("There are still logs under '%s'",
				      logfile);
				errno = save_errno;
				return -1;
3011
			}
3012
			logfd = open(logfile, oflags, 0666);
3013 3014
		}

3015 3016 3017 3018 3019 3020 3021
		if (logfd < 0) {
			int save_errno = errno;
			error("Unable to append to %s: %s", logfile,
			      strerror(errno));
			errno = save_errno;
			return -1;
		}
3022 3023
	}

3024
	adjust_shared_perm(logfile);
3025 3026 3027
	close(logfd);
	return 0;
}
3028

3029 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
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;
}

3055
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
3056 3057
			 const unsigned char *new_sha1, const char *msg)
{
3058
	int logfd, result, oflags = O_APPEND | O_WRONLY;
3059
	char log_file[PATH_MAX];
3060 3061 3062 3063

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

3064
	result = log_ref_setup(refname, log_file, sizeof(log_file));
3065 3066 3067 3068 3069 3070
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
3071 3072 3073
	result = log_ref_write_fd(logfd, old_sha1, new_sha1,
				  git_committer_info(0), msg);
	if (result) {
3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085
		int save_errno = errno;
		close(logfd);
		error("Unable to append to %s", log_file);
		errno = save_errno;
		return -1;
	}
	if (close(logfd)) {
		int save_errno = errno;
		error("Unable to append to %s", log_file);
		errno = save_errno;
		return -1;
	}
3086 3087 3088
	return 0;
}

3089
int is_branch(const char *refname)
3090
{
3091
	return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
3092 3093
}

3094 3095 3096 3097 3098
/*
 * Write sha1 into the ref specified by the lock. Make sure that errno
 * is sane on error.
 */
static int write_ref_sha1(struct ref_lock *lock,
3099 3100 3101
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
3102
	struct object *o;
3103

3104 3105
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
3106
		error("Trying to write ref %s with nonexistent object %s",
3107 3108
			lock->ref_name, sha1_to_hex(sha1));
		unlock_ref(lock);
3109
		errno = EINVAL;
3110 3111 3112 3113 3114 3115
		return -1;
	}
	if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
		error("Trying to write non-commit object %s to branch %s",
			sha1_to_hex(sha1), lock->ref_name);
		unlock_ref(lock);
3116
		errno = EINVAL;
3117 3118
		return -1;
	}
3119
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
3120 3121 3122
	    write_in_full(lock->lock_fd, &term, 1) != 1 ||
	    close_ref(lock) < 0) {
		int save_errno = errno;
3123
		error("Couldn't write %s", lock->lk->filename.buf);
3124
		unlock_ref(lock);
3125
		errno = save_errno;
3126 3127
		return -1;
	}
3128
	clear_loose_ref_cache(&ref_cache);
N
Nicolas Pitre 已提交
3129 3130 3131
	if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
	    (strcmp(lock->ref_name, lock->orig_ref_name) &&
	     log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
3132 3133 3134
		unlock_ref(lock);
		return -1;
	}
3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
	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;
3151 3152
		head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
					      head_sha1, &head_flag);
3153 3154 3155 3156
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
3157
	if (commit_ref(lock)) {
3158
		error("Couldn't set %s", lock->ref_name);
3159 3160 3161 3162 3163
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
3164
}
3165

3166 3167
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
3168 3169 3170 3171
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
3172
	char *git_HEAD = git_pathdup("%s", ref_target);
3173 3174 3175 3176
	unsigned char old_sha1[20], new_sha1[20];

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

3178 3179 3180
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

3181 3182 3183 3184
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
3185
			goto done;
3186 3187 3188 3189 3190 3191 3192
		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);
3193
		goto error_free_return;
3194 3195 3196 3197 3198
	}
	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);
3199
		goto error_free_return;
3200 3201
	}
	written = write_in_full(fd, ref, len);
3202
	if (close(fd) != 0 || written != len) {
3203
		error("Unable to write to %s", lockpath);
3204
		goto error_unlink_return;
3205 3206 3207
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
3208
		goto error_unlink_return;
3209 3210 3211
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
3212
	error_unlink_return:
3213
		unlink_or_warn(lockpath);
3214 3215 3216
	error_free_return:
		free(git_HEAD);
		return -1;
3217
	}
3218

3219
#ifndef NO_SYMLINK_HEAD
3220
	done:
3221
#endif
3222 3223 3224
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

3225
	free(git_HEAD);
3226 3227 3228
	return 0;
}

3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312
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;
3313 3314
}

3315
int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
3316 3317
		unsigned char *sha1, char **msg,
		unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3318
{
3319
	struct read_ref_at_cb cb;
3320

3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332
	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);

3333 3334 3335 3336 3337 3338
	if (!cb.reccnt) {
		if (flags & GET_SHA1_QUIETLY)
			exit(128);
		else
			die("Log for %s is empty.", refname);
	}
3339 3340 3341 3342
	if (cb.found_it)
		return 0;

	for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3343

3344
	return 1;
3345
}
3346

3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359
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));
}

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
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);
}

3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399
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)
3400
{
3401
	struct strbuf sb = STRBUF_INIT;
3402 3403 3404
	FILE *logfp;
	long pos;
	int ret = 0, at_tail = 1;
3405

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

3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
	/* 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 已提交
3427
		if (nread != 1)
3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446
			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);

3447
			if (*bp == '\n') {
3448
				/*
3449 3450 3451 3452
				 * 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.
3453 3454 3455 3456
				 */
				strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
				scanp = bp;
				endp = bp + 1;
3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471
				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;
3472
			}
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487

			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);
3488
				break;
3489
			}
3490
		}
3491

3492
	}
3493
	if (!ret && sb.len)
3494
		die("BUG: reverse reflog parser had leftover data");
3495

3496
	fclose(logfp);
3497
	strbuf_release(&sb);
3498
	return ret;
3499
}
J
Junio C Hamano 已提交
3500

3501
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3502
{
3503 3504 3505 3506 3507 3508 3509
	FILE *logfp;
	struct strbuf sb = STRBUF_INIT;
	int ret = 0;

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

3511 3512 3513 3514 3515 3516
	while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
		ret = show_one_reflog_ent(&sb, fn, cb_data);
	fclose(logfp);
	strbuf_release(&sb);
	return ret;
}
3517 3518 3519 3520 3521 3522
/*
 * 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)
3523
{
3524
	DIR *d = opendir(git_path("logs/%s", name->buf));
3525
	int retval = 0;
3526
	struct dirent *de;
3527
	int oldlen = name->len;
3528

3529
	if (!d)
3530
		return name->len ? errno : 0;
3531

3532 3533
	while ((de = readdir(d)) != NULL) {
		struct stat st;
3534

3535 3536
		if (de->d_name[0] == '.')
			continue;
J
Jeff King 已提交
3537
		if (ends_with(de->d_name, ".lock"))
3538
			continue;
3539 3540 3541
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
3542
		} else {
3543
			if (S_ISDIR(st.st_mode)) {
3544 3545
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
3546 3547
			} else {
				unsigned char sha1[20];
3548
				if (read_ref_full(name->buf, 0, sha1, NULL))
3549
					retval = error("bad ref for %s", name->buf);
3550
				else
3551
					retval = fn(name->buf, sha1, 0, cb_data);
3552 3553 3554 3555
			}
			if (retval)
				break;
		}
3556
		strbuf_setlen(name, oldlen);
3557
	}
3558
	closedir(d);
3559 3560 3561 3562 3563
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
3564 3565 3566 3567 3568 3569
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
3570
}
C
Carlos Rica 已提交
3571

3572
/**
3573 3574 3575 3576 3577
 * 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.
3578 3579
 */
struct ref_update {
3580 3581 3582
	/*
	 * If (flags & REF_HAVE_NEW), set the reference to this value:
	 */
3583
	unsigned char new_sha1[20];
3584 3585 3586 3587
	/*
	 * If (flags & REF_HAVE_OLD), check that the reference
	 * previously had this value:
	 */
3588
	unsigned char old_sha1[20];
3589
	/*
3590
	 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3591 3592 3593
	 * REF_DELETING, and REF_ISPRUNING:
	 */
	unsigned int flags;
3594
	struct ref_lock *lock;
3595
	int type;
3596
	char *msg;
3597
	const char refname[FLEX_ARRAY];
3598 3599
};

3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614
/*
 * 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
};

3615 3616 3617 3618 3619 3620 3621 3622 3623
/*
 * 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;
3624
	enum ref_transaction_state state;
3625 3626
};

3627
struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3628
{
3629 3630
	assert(err);

3631 3632 3633
	return xcalloc(1, sizeof(struct ref_transaction));
}

3634
void ref_transaction_free(struct ref_transaction *transaction)
3635 3636 3637
{
	int i;

3638 3639 3640
	if (!transaction)
		return;

3641 3642
	for (i = 0; i < transaction->nr; i++) {
		free(transaction->updates[i]->msg);
3643
		free(transaction->updates[i]);
3644
	}
3645 3646 3647 3648 3649 3650 3651
	free(transaction->updates);
	free(transaction);
}

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

3655
	strcpy((char *)update->refname, refname);
3656 3657 3658 3659 3660
	ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
	transaction->updates[transaction->nr++] = update;
	return update;
}

3661 3662 3663 3664
int ref_transaction_update(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
			   const unsigned char *old_sha1,
3665
			   unsigned int flags, const char *msg,
3666
			   struct strbuf *err)
3667
{
3668
	struct ref_update *update;
3669

3670 3671
	assert(err);

3672 3673 3674
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: update called for transaction that is not open");

3675
	if (new_sha1 && !is_null_sha1(new_sha1) &&
3676 3677 3678 3679 3680 3681
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
		strbuf_addf(err, "refusing to update ref with bad name %s",
			    refname);
		return -1;
	}

3682
	update = add_update(transaction, refname);
3683 3684 3685 3686
	if (new_sha1) {
		hashcpy(update->new_sha1, new_sha1);
		flags |= REF_HAVE_NEW;
	}
3687
	if (old_sha1) {
3688
		hashcpy(update->old_sha1, old_sha1);
3689 3690 3691
		flags |= REF_HAVE_OLD;
	}
	update->flags = flags;
3692 3693
	if (msg)
		update->msg = xstrdup(msg);
3694
	return 0;
3695 3696
}

3697 3698 3699
int ref_transaction_create(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
3700
			   unsigned int flags, const char *msg,
3701
			   struct strbuf *err)
3702
{
3703 3704
	if (!new_sha1 || is_null_sha1(new_sha1))
		die("BUG: create called without valid new_sha1");
3705
	return ref_transaction_update(transaction, refname, new_sha1,
3706
				      null_sha1, flags, msg, err);
3707 3708
}

3709 3710 3711
int ref_transaction_delete(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *old_sha1,
3712
			   unsigned int flags, const char *msg,
3713
			   struct strbuf *err)
3714
{
3715 3716
	if (old_sha1 && is_null_sha1(old_sha1))
		die("BUG: delete called with old_sha1 set to zeros");
3717
	return ref_transaction_update(transaction, refname,
3718
				      null_sha1, old_sha1,
3719
				      flags, msg, err);
3720 3721
}

3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734
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);
}

3735 3736
int update_ref(const char *msg, const char *refname,
	       const unsigned char *new_sha1, const unsigned char *old_sha1,
3737
	       unsigned int flags, enum action_on_err onerr)
3738
{
3739 3740 3741 3742 3743
	struct ref_transaction *t;
	struct strbuf err = STRBUF_INIT;

	t = ref_transaction_begin(&err);
	if (!t ||
3744 3745
	    ref_transaction_update(t, refname, new_sha1, old_sha1,
				   flags, msg, &err) ||
3746
	    ref_transaction_commit(t, &err)) {
3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760
		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);
3761
		return 1;
3762 3763 3764 3765
	}
	strbuf_release(&err);
	ref_transaction_free(t);
	return 0;
3766 3767
}

3768
static int ref_update_reject_duplicates(struct string_list *refnames,
3769
					struct strbuf *err)
3770
{
3771
	int i, n = refnames->nr;
3772 3773 3774

	assert(err);

3775
	for (i = 1; i < n; i++)
3776
		if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {
3777 3778
			strbuf_addf(err,
				    "Multiple updates for ref '%s' not allowed.",
3779
				    refnames->items[i].string);
3780 3781 3782 3783 3784
			return 1;
		}
	return 0;
}

3785
int ref_transaction_commit(struct ref_transaction *transaction,
3786
			   struct strbuf *err)
3787
{
3788
	int ret = 0, i;
3789
	int n = transaction->nr;
3790
	struct ref_update **updates = transaction->updates;
3791 3792
	struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;
	struct string_list_item *ref_to_delete;
3793
	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
3794

3795 3796
	assert(err);

3797 3798 3799 3800 3801
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: commit called for transaction that is not open");

	if (!n) {
		transaction->state = REF_TRANSACTION_CLOSED;
3802
		return 0;
3803
	}
3804

3805 3806 3807 3808 3809
	/* 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)) {
3810
		ret = TRANSACTION_GENERIC_ERROR;
3811
		goto cleanup;
3812
	}
3813 3814 3815

	/* Acquire all locks while verifying old values */
	for (i = 0; i < n; i++) {
3816
		struct ref_update *update = updates[i];
3817
		unsigned int flags = update->flags;
3818

3819
		if ((flags & REF_HAVE_NEW) && is_null_sha1(update->new_sha1))
3820
			flags |= REF_DELETING;
3821 3822 3823 3824
		update->lock = lock_ref_sha1_basic(
				update->refname,
				((update->flags & REF_HAVE_OLD) ?
				 update->old_sha1 : NULL),
3825
				&affected_refnames, NULL,
3826 3827
				flags,
				&update->type);
3828
		if (!update->lock) {
3829 3830 3831
			ret = (errno == ENOTDIR)
				? TRANSACTION_NAME_CONFLICT
				: TRANSACTION_GENERIC_ERROR;
3832 3833
			strbuf_addf(err, "Cannot lock the ref '%s'.",
				    update->refname);
3834 3835 3836 3837 3838
			goto cleanup;
		}
	}

	/* Perform updates first so live commits remain referenced */
3839 3840
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];
3841
		int flags = update->flags;
3842

3843
		if ((flags & REF_HAVE_NEW) && !is_null_sha1(update->new_sha1)) {
3844 3845 3846 3847 3848 3849 3850 3851 3852
			int overwriting_symref = ((update->type & REF_ISSYMREF) &&
						  (update->flags & REF_NODEREF));

			if (!overwriting_symref
			    && !hashcmp(update->lock->old_sha1, update->new_sha1)) {
				/*
				 * The reference already has the desired
				 * value, so we don't need to write it.
				 */
3853 3854 3855 3856
				unlock_ref(update->lock);
				update->lock = NULL;
			} else if (write_ref_sha1(update->lock, update->new_sha1,
						  update->msg)) {
3857
				update->lock = NULL; /* freed by write_ref_sha1 */
3858 3859
				strbuf_addf(err, "Cannot update the ref '%s'.",
					    update->refname);
3860
				ret = TRANSACTION_GENERIC_ERROR;
3861
				goto cleanup;
3862 3863 3864
			} else {
				/* freed by write_ref_sha1(): */
				update->lock = NULL;
3865
			}
3866
		}
3867
	}
3868 3869

	/* Perform deletes now that updates are safely completed */
3870 3871
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];
3872
		int flags = update->flags;
3873

3874
		if ((flags & REF_HAVE_NEW) && is_null_sha1(update->new_sha1)) {
3875
			if (delete_ref_loose(update->lock, update->type, err)) {
3876
				ret = TRANSACTION_GENERIC_ERROR;
3877 3878
				goto cleanup;
			}
3879

3880
			if (!(flags & REF_ISPRUNING))
3881 3882
				string_list_append(&refs_to_delete,
						   update->lock->ref_name);
3883
		}
3884 3885
	}

3886
	if (repack_without_refs(&refs_to_delete, err)) {
3887
		ret = TRANSACTION_GENERIC_ERROR;
3888 3889
		goto cleanup;
	}
3890 3891
	for_each_string_list_item(ref_to_delete, &refs_to_delete)
		unlink_or_warn(git_path("logs/%s", ref_to_delete->string));
3892 3893 3894
	clear_loose_ref_cache(&ref_cache);

cleanup:
3895 3896
	transaction->state = REF_TRANSACTION_CLOSED;

3897
	for (i = 0; i < n; i++)
3898 3899
		if (updates[i]->lock)
			unlock_ref(updates[i]->lock);
3900
	string_list_clear(&refs_to_delete, 0);
3901
	string_list_clear(&affected_refnames, 0);
3902 3903 3904
	return ret;
}

3905
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
3906 3907 3908 3909 3910 3911 3912
{
	int i;
	static char **scanf_fmts;
	static int nr_rules;
	char *short_name;

	if (!nr_rules) {
3913 3914 3915 3916 3917 3918
		/*
		 * 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 已提交
3919
		size_t total_len = 0;
3920
		size_t offset = 0;
J
Jeff King 已提交
3921 3922

		/* the rule list is NULL terminated, count them first */
J
Jeff King 已提交
3923
		for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
3924 3925
			/* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
			total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
J
Jeff King 已提交
3926 3927 3928

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

3929
		offset = 0;
J
Jeff King 已提交
3930
		for (i = 0; i < nr_rules; i++) {
3931
			assert(offset < total_len);
3932
			scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
3933 3934
			offset += snprintf(scanf_fmts[i], total_len - offset,
					   ref_rev_parse_rules[i], 2, "%s") + 1;
J
Jeff King 已提交
3935 3936 3937 3938 3939
		}
	}

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

3942 3943
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
3944 3945 3946 3947

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

3951
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
3952 3953 3954 3955
			continue;

		short_name_len = strlen(short_name);

3956 3957 3958 3959 3960 3961 3962
		/*
		 * 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 已提交
3963 3964 3965 3966
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
3967
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
3968 3969 3970
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

3971 3972 3973 3974
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
3975 3976 3977 3978 3979 3980 3981
			/*
			 * 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);
3982
			if (ref_exists(refname))
J
Jeff King 已提交
3983 3984 3985 3986 3987 3988 3989
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
3990
		if (j == rules_to_fail)
J
Jeff King 已提交
3991 3992 3993 3994
			return short_name;
	}

	free(short_name);
3995
	return xstrdup(refname);
J
Jeff King 已提交
3996
}
3997 3998 3999 4000 4001 4002 4003

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 */
4004
	    (starts_with(var, section) && var[strlen(section)] == '.' &&
4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031
	     !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;
4032
		if (!starts_with(refname, item->string))
4033 4034 4035 4036 4037 4038 4039
			continue;
		len = strlen(item->string);
		if (!refname[len] || refname[len] == '/')
			return 1;
	}
	return 0;
}
4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066

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) {
4067
			fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",
4068
				sha1_to_hex(osha1), sha1_to_hex(nsha1),
4069
				email, timestamp, tz, message);
4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089
			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;
4090
	int type;
4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101

	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:
	 */
4102
	lock = lock_ref_sha1_basic(refname, sha1, NULL, NULL, 0, &type);
4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138
	if (!lock)
		return error("cannot lock ref '%s'", refname);
	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)) {
4139 4140 4141
		/*
		 * It doesn't make sense to adjust a reference pointed
		 * to by a symbolic ref based on expiring entries in
4142 4143 4144
		 * the symbolic reference's reflog. Nor can we update
		 * a reference if there are no remaining reflog
		 * entries.
4145 4146
		 */
		int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&
4147 4148
			!(type & REF_ISSYMREF) &&
			!is_null_sha1(cb.last_kept_sha1);
4149

4150 4151 4152
		if (close_lock_file(&reflog_lock)) {
			status |= error("couldn't write %s: %s", log_file,
					strerror(errno));
4153
		} else if (update &&
4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
			(write_in_full(lock->lock_fd,
				sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
			 write_str_in_full(lock->lock_fd, "\n") != 1 ||
			 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));
4164
		} else if (update && commit_ref(lock)) {
4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177
			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;
}