refs.c 101.8 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
 * How to handle various characters in refnames:
 * 0: An acceptable character for refs
12 13 14 15
 * 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
16 17
 */
static unsigned char refname_disposition[256] = {
18 19 20 21
	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,
22
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
23 24 25
	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
26 27
};

28 29 30 31 32
/*
 * Used as a flag to ref_transaction_delete when a loose ref is being
 * pruned.
 */
#define REF_ISPRUNING	0x0100
33 34 35 36 37
/*
 * 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:
38 39 40 41
 *
 * - any path component of it begins with ".", or
 * - it has double dots "..", or
 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
42 43
 * - it ends with a "/".
 * - it ends with ".lock"
44 45 46 47 48 49 50 51
 * - it contains a "\" (backslash)
 */
static int check_refname_component(const char *refname, int flags)
{
	const char *cp;
	char last = '\0';

	for (cp = refname; ; cp++) {
52 53 54
		int ch = *cp & 255;
		unsigned char disp = refname_disposition[ch];
		switch (disp) {
55
		case 1:
56
			goto out;
57
		case 2:
58 59 60
			if (last == '.')
				return -1; /* Refname contains "..". */
			break;
61
		case 3:
62 63
			if (last == '@')
				return -1; /* Refname contains "@{". */
64
			break;
65
		case 4:
66 67
			return -1;
		}
68 69
		last = ch;
	}
70
out:
71
	if (cp == refname)
72
		return 0; /* Component has zero length. */
73 74
	if (refname[0] == '.')
		return -1; /* Component starts with '.'. */
75 76
	if (cp - refname >= LOCK_SUFFIX_LEN &&
	    !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
77 78 79 80
		return -1; /* Refname ends with ".lock". */
	return cp - refname;
}

81
int check_refname_format(const char *refname, int flags)
82 83 84
{
	int component_len, component_count = 0;

F
Felipe Contreras 已提交
85 86 87 88
	if (!strcmp(refname, "@"))
		/* Refname is a single character '@'. */
		return -1;

89 90 91
	while (1) {
		/* We are at the start of a path component. */
		component_len = check_refname_component(refname, flags);
92
		if (component_len <= 0) {
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
			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;
118

119 120 121 122 123 124
/*
 * 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.
 */
125
struct ref_value {
126 127 128 129 130 131
	/*
	 * 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.
	 */
132
	unsigned char sha1[20];
133 134 135 136

	/*
	 * If REF_KNOWS_PEELED, then this field holds the peeled value
	 * of this reference, or null if the reference is known not to
137 138
	 * be peelable.  See the documentation for peel_ref() for an
	 * exact definition of "peelable".
139
	 */
140 141 142
	unsigned char peeled[20];
};

143 144
struct ref_cache;

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
/*
 * 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().
 */
171
struct ref_dir {
172
	int nr, alloc;
173 174 175 176 177 178 179 180 181

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

182 183 184
	/* A pointer to the ref_cache that contains this ref_dir. */
	struct ref_cache *ref_cache;

185
	struct ref_entry **entries;
186 187
};

188 189 190 191 192 193 194 195 196 197 198
/*
 * Bit values for ref_entry::flag.  REF_ISSYMREF=0x01,
 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
 * refs.h.
 */

/*
 * 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.
 */
199
#define REF_KNOWS_PEELED 0x08
200 201

/* ref_entry represents a directory of references */
202
#define REF_DIR 0x10
203

204 205 206 207 208 209
/*
 * Entry has not yet been read from disk (used only for REF_DIR
 * entries representing loose references)
 */
#define REF_INCOMPLETE 0x20

210 211
/*
 * A ref_entry represents either a reference or a "subdirectory" of
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
 * 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).
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
 *
 * 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
 * separate issue that is regulated by is_refname_available().)
 *
 * 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.
 */
249 250
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
251
	union {
252 253
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
254
	} u;
255 256 257 258 259
	/*
	 * 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/"):
	 */
260 261
	char name[FLEX_ARRAY];
};
262

263 264
static void read_loose_refs(const char *dirname, struct ref_dir *dir);

265 266
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
267
	struct ref_dir *dir;
268
	assert(entry->flag & REF_DIR);
269 270 271 272 273 274
	dir = &entry->u.subdir;
	if (entry->flag & REF_INCOMPLETE) {
		read_loose_refs(entry->name, dir);
		entry->flag &= ~REF_INCOMPLETE;
	}
	return dir;
275 276
}

277 278 279
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
280 281
{
	int len;
282
	struct ref_entry *ref;
283

284
	if (check_name &&
285
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
286
		die("Reference has invalid format: '%s'", refname);
287 288
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
289 290
	hashcpy(ref->u.value.sha1, sha1);
	hashclr(ref->u.value.peeled);
291 292 293 294 295
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

296 297
static void clear_ref_dir(struct ref_dir *dir);

298 299
static void free_ref_entry(struct ref_entry *entry)
{
300 301 302 303 304 305 306
	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);
	}
307 308 309
	free(entry);
}

310 311 312 313 314 315
/*
 * 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)
316
{
317 318
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
319 320 321 322 323 324
	/* 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;
325 326
}

327 328 329
/*
 * Clear and free all entries in dir, recursively.
 */
330
static void clear_ref_dir(struct ref_dir *dir)
331 332
{
	int i;
333 334 335 336 337
	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;
338 339
}

340 341 342 343 344
/*
 * 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.
 */
345
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
346 347
					  const char *dirname, size_t len,
					  int incomplete)
348 349 350
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
351 352
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
353
	direntry->u.subdir.ref_cache = ref_cache;
354
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
355 356 357
	return direntry;
}

358
static int ref_entry_cmp(const void *a, const void *b)
359
{
360 361 362 363
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
364

365
static void sort_ref_dir(struct ref_dir *dir);
366

367 368 369 370 371 372 373
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
374 375 376
	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);
377 378
	if (cmp)
		return cmp;
379
	return '\0' - (unsigned char)ent->name[key->len];
380 381
}

382
/*
383 384 385
 * 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.
386
 */
387
static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
388
{
389 390
	struct ref_entry **r;
	struct string_slice key;
391

392
	if (refname == NULL || !dir->nr)
393
		return -1;
394

395
	sort_ref_dir(dir);
396 397 398 399
	key.len = len;
	key.str = refname;
	r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
		    ref_entry_cmp_sslice);
400 401

	if (r == NULL)
402
		return -1;
403

404
	return r - dir->entries;
405 406
}

407 408 409 410 411
/*
 * 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
412
 * directory cannot be found.  dir must already be complete.
413
 */
414
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
415 416
					 const char *subdirname, size_t len,
					 int mkdir)
417
{
418 419 420
	int entry_index = search_ref_dir(dir, subdirname, len);
	struct ref_entry *entry;
	if (entry_index == -1) {
421 422
		if (!mkdir)
			return NULL;
423 424 425 426 427 428
		/*
		 * 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.
		 */
429
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
430
		add_entry_to_dir(dir, entry);
431 432
	} else {
		entry = dir->entries[entry_index];
433
	}
434
	return get_ref_dir(entry);
435 436
}

437 438 439 440
/*
 * 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
441 442 443 444
 * 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.
445 446 447 448
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
449 450
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
451
		size_t dirnamelen = slash - refname + 1;
452
		struct ref_dir *subdir;
453
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
454 455
		if (!subdir) {
			dir = NULL;
456
			break;
457
		}
458
		dir = subdir;
459 460 461 462 463 464 465 466 467 468 469 470
	}

	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)
{
471
	int entry_index;
472 473 474 475
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
476 477 478 479 480
	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;
481 482
}

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
/*
 * 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;
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
}

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

548 549 550 551 552 553 554
/*
 * 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)
{
555
	if (strcmp(ref1->name, ref2->name))
556
		return 0;
557 558 559 560 561 562 563 564 565 566 567 568

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

571
/*
572 573
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
574
 */
575
static void sort_ref_dir(struct ref_dir *dir)
576
{
577
	int i, j;
578
	struct ref_entry *last = NULL;
579

580 581 582 583
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
584
	if (dir->sorted == dir->nr)
585
		return;
586

587
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
588

589 590 591 592 593 594 595
	/* 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;
596
	}
597
	dir->sorted = dir->nr = i;
598
}
599

600 601
/* Include broken references in a do_for_each_ref*() iteration: */
#define DO_FOR_EACH_INCLUDE_BROKEN 0x01
602

603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
/*
 * 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;
}
618

619 620 621 622 623 624 625 626 627
/*
 * 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.
 */
628
static struct ref_entry *current_ref;
629

630 631 632 633 634 635 636 637 638 639
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;
};

640
/*
641 642
 * Handle one reference in a do_for_each_ref*()-style iteration,
 * calling an each_ref_fn for each entry.
643
 */
644
static int do_one_ref(struct ref_entry *entry, void *cb_data)
645
{
646
	struct ref_entry_cb *data = cb_data;
647
	struct ref_entry *old_current_ref;
648
	int retval;
649

650
	if (!starts_with(entry->name, data->base))
651
		return 0;
652

653
	if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
654
	      !ref_resolves_to_object(entry))
655
		return 0;
656

657 658
	/* Store the old value, in case this is a recursive call: */
	old_current_ref = current_ref;
659
	current_ref = entry;
660 661
	retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
			  entry->flag, data->cb_data);
662
	current_ref = old_current_ref;
663
	return retval;
664
}
665

666
/*
667
 * Call fn for each reference in dir that has index in the range
668 669
 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 * that index range, sorting them before iterating.  This function
670 671
 * does not sort dir itself; it should be sorted beforehand.  fn is
 * called for all references, including broken ones.
672
 */
673 674
static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
				    each_ref_entry_fn fn, void *cb_data)
675 676
{
	int i;
677 678
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
679 680 681
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
682 683
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
684
			retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
685
		} else {
686
			retval = fn(entry, cb_data);
687
		}
688 689 690 691 692 693
		if (retval)
			return retval;
	}
	return 0;
}

694
/*
695
 * Call fn for each reference in the union of dir1 and dir2, in order
696 697 698
 * 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
699 700
 * sorted as needed.  fn is called for all references, including
 * broken ones.
701
 */
702 703 704
static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
				     struct ref_dir *dir2,
				     each_ref_entry_fn fn, void *cb_data)
705 706 707 708
{
	int retval;
	int i1 = 0, i2 = 0;

709 710
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
711 712 713 714
	while (1) {
		struct ref_entry *e1, *e2;
		int cmp;
		if (i1 == dir1->nr) {
715
			return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
716 717
		}
		if (i2 == dir2->nr) {
718
			return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
719 720 721 722 723 724 725
		}
		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. */
726 727 728 729
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
730 731
				retval = do_for_each_entry_in_dirs(
						subdir1, subdir2, fn, cb_data);
732 733 734 735
				i1++;
				i2++;
			} else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
				/* Both are references; ignore the one from dir1. */
736
				retval = fn(e2, cb_data);
737 738 739 740 741 742
				i1++;
				i2++;
			} else {
				die("conflict between reference and directory: %s",
				    e1->name);
			}
743
		} else {
744 745 746
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
747
				i1++;
748 749 750 751 752
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
753 754
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
755 756
				retval = do_for_each_entry_in_dir(
						subdir, 0, fn, cb_data);
757
			} else {
758
				retval = fn(e, cb_data);
759 760 761 762 763 764 765
			}
		}
		if (retval)
			return retval;
	}
}

766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
/*
 * 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 已提交
781

782
static int entry_matches(struct ref_entry *entry, const struct string_list *list)
783
{
784
	return list && string_list_has_string(list, entry->name);
785 786
}

J
Jeff King 已提交
787
struct nonmatching_ref_data {
788
	const struct string_list *skip;
J
Jeff King 已提交
789
	struct ref_entry *found;
790 791
};

J
Jeff King 已提交
792
static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata)
793
{
J
Jeff King 已提交
794 795 796
	struct nonmatching_ref_data *data = vdata;

	if (entry_matches(entry, data->skip))
797
		return 0;
J
Jeff King 已提交
798 799 800 801 802 803 804 805 806

	data->found = entry;
	return 1;
}

static void report_refname_conflict(struct ref_entry *entry,
				    const char *refname)
{
	error("'%s' exists; cannot create '%s'", entry->name, refname);
807 808
}

809 810
/*
 * Return true iff a reference named refname could be created without
811
 * conflicting with the name of an existing reference in dir.  If
812 813
 * skip is non-NULL, ignore potential conflicts with refs in skip
 * (e.g., because they are scheduled for deletion in the same
814
 * operation).
J
Jeff King 已提交
815 816 817 818 819
 *
 * Two reference names conflict if one of them exactly matches the
 * leading components of the other; e.g., "foo/bar" conflicts with
 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
 * "foo/barbados".
820 821
 *
 * skip must be sorted.
822
 */
823 824
static int is_refname_available(const char *refname,
				const struct string_list *skip,
825
				struct ref_dir *dir)
826
{
J
Jeff King 已提交
827 828 829 830
	const char *slash;
	size_t len;
	int pos;
	char *dirname;
831

J
Jeff King 已提交
832 833 834 835 836 837
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
		/*
		 * We are still at a leading dir of the refname; we are
		 * looking for a conflict with a leaf entry.
		 *
		 * If we find one, we still must make sure it is
838
		 * not in "skip".
J
Jeff King 已提交
839 840 841 842
		 */
		pos = search_ref_dir(dir, refname, slash - refname);
		if (pos >= 0) {
			struct ref_entry *entry = dir->entries[pos];
843
			if (entry_matches(entry, skip))
J
Jeff King 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
				return 1;
			report_refname_conflict(entry, refname);
			return 0;
		}


		/*
		 * Otherwise, we can try to continue our search with
		 * the next component; if we come up empty, we know
		 * there is nothing under this whole prefix.
		 */
		pos = search_ref_dir(dir, refname, slash + 1 - refname);
		if (pos < 0)
			return 1;

		dir = get_ref_dir(dir->entries[pos]);
	}

	/*
	 * We are at the leaf of our refname; we want to
	 * make sure there are no directories which match it.
	 */
	len = strlen(refname);
	dirname = xmallocz(len + 1);
	sprintf(dirname, "%s/", refname);
	pos = search_ref_dir(dir, dirname, len + 1);
	free(dirname);

	if (pos >= 0) {
		/*
		 * We found a directory named "refname". It is a
		 * problem iff it contains any ref that is not
876
		 * in "skip".
J
Jeff King 已提交
877 878 879 880 881
		 */
		struct ref_entry *entry = dir->entries[pos];
		struct ref_dir *dir = get_ref_dir(entry);
		struct nonmatching_ref_data data;

882
		data.skip = skip;
J
Jeff King 已提交
883 884 885 886 887
		sort_ref_dir(dir);
		if (!do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data))
			return 1;

		report_refname_conflict(data.found, refname);
888
		return 0;
889
	}
J
Jeff King 已提交
890 891 892 893 894 895

	/*
	 * There is no point in searching for another leaf
	 * node which matches it; such an entry would be the
	 * ref we are looking for, not a conflict.
	 */
896
	return 1;
897 898
}

899 900
struct packed_ref_cache {
	struct ref_entry *root;
901

902 903 904 905 906 907 908 909
	/*
	 * 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;

910 911 912
	/*
	 * Iff the packed-refs file associated with this instance is
	 * currently locked for writing, this points at the associated
913 914 915
	 * lock (which is owned by somebody else).  The referrer count
	 * is also incremented when the file is locked and decremented
	 * when it is unlocked.
916 917
	 */
	struct lock_file *lock;
918 919 920

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

923 924 925 926
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
927 928
static struct ref_cache {
	struct ref_cache *next;
929
	struct ref_entry *loose;
930
	struct packed_ref_cache *packed;
931 932 933 934 935 936 937
	/*
	 * 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;
938

939 940 941
/* Lock used for the main packed-refs file: */
static struct lock_file packlock;

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
/*
 * 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);
958
		stat_validity_clear(&packed_refs->validity);
959 960 961 962 963 964 965
		free(packed_refs);
		return 1;
	} else {
		return 0;
	}
}

966
static void clear_packed_ref_cache(struct ref_cache *refs)
967
{
968
	if (refs->packed) {
969 970 971
		struct packed_ref_cache *packed_refs = refs->packed;

		if (packed_refs->lock)
972
			die("internal error: packed-ref cache cleared while locked");
973
		refs->packed = NULL;
974
		release_packed_ref_cache(packed_refs);
975
	}
976
}
977

978 979
static void clear_loose_ref_cache(struct ref_cache *refs)
{
980 981 982 983
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
984 985
}

986
static struct ref_cache *create_ref_cache(const char *submodule)
987
{
988
	int len;
989
	struct ref_cache *refs;
990 991 992
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
993
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
994
	memcpy(refs->name, submodule, len);
995 996 997
	return refs;
}

998
/*
999
 * Return a pointer to a ref_cache for the specified submodule. For
1000 1001 1002 1003
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
1004
static struct ref_cache *get_ref_cache(const char *submodule)
1005
{
1006 1007 1008 1009 1010 1011
	struct ref_cache *refs;

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

	for (refs = submodule_ref_caches; refs; refs = refs->next)
1012 1013 1014
		if (!strcmp(submodule, refs->name))
			return refs;

1015
	refs = create_ref_cache(submodule);
1016 1017
	refs->next = submodule_ref_caches;
	submodule_ref_caches = refs;
1018
	return refs;
1019 1020
}

1021 1022 1023
/* The length of a peeled reference line in packed-refs, including EOL: */
#define PEELED_LINE_LENGTH 42

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

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
/*
 * 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.
 */
static const char *parse_ref_line(char *line, unsigned char *sha1)
{
	/*
	 * 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)
	 */
	int len = strlen(line) - 42;

	if (len <= 0)
		return NULL;
	if (get_sha1_hex(line, sha1) < 0)
		return NULL;
	if (!isspace(line[40]))
		return NULL;
	line += 41;
	if (isspace(*line))
		return NULL;
	if (line[len] != '\n')
		return NULL;
	line[len] = 0;

	return line;
}

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
/*
 * 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).
 */
1091
static void read_packed_refs(FILE *f, struct ref_dir *dir)
1092
{
1093
	struct ref_entry *last = NULL;
1094
	char refline[PATH_MAX];
1095
	enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1096 1097 1098

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
1099
		const char *refname;
1100 1101 1102 1103
		static const char header[] = "# pack-refs with:";

		if (!strncmp(refline, header, sizeof(header)-1)) {
			const char *traits = refline + sizeof(header) - 1;
1104 1105 1106 1107
			if (strstr(traits, " fully-peeled "))
				peeled = PEELED_FULLY;
			else if (strstr(traits, " peeled "))
				peeled = PEELED_TAGS;
1108 1109 1110 1111
			/* perhaps other traits later as well */
			continue;
		}

1112 1113
		refname = parse_ref_line(refline, sha1);
		if (refname) {
1114 1115
			last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
			if (peeled == PEELED_FULLY ||
1116
			    (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1117
				last->flag |= REF_KNOWS_PEELED;
1118
			add_ref(dir, last);
1119 1120 1121 1122
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
1123 1124
		    strlen(refline) == PEELED_LINE_LENGTH &&
		    refline[PEELED_LINE_LENGTH - 1] == '\n' &&
1125
		    !get_sha1_hex(refline + 1, sha1)) {
1126
			hashcpy(last->u.value.peeled, sha1);
1127 1128 1129 1130 1131 1132 1133
			/*
			 * Regardless of what the file header said,
			 * we definitely know the value of *this*
			 * reference:
			 */
			last->flag |= REF_KNOWS_PEELED;
		}
1134 1135 1136
	}
}

1137 1138 1139 1140 1141
/*
 * 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)
1142
{
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
	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);

1154
	if (!refs->packed) {
1155
		FILE *f;
1156

1157
		refs->packed = xcalloc(1, sizeof(*refs->packed));
1158
		acquire_packed_ref_cache(refs->packed);
1159
		refs->packed->root = create_dir_entry(refs, "", 0, 0);
1160
		f = fopen(packed_refs_file, "r");
1161
		if (f) {
1162
			stat_validity_update(&refs->packed->validity, fileno(f));
1163
			read_packed_refs(f, get_ref_dir(refs->packed->root));
1164 1165 1166
			fclose(f);
		}
	}
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
	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));
1178 1179
}

1180 1181
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
1182 1183 1184 1185 1186 1187
	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),
1188
		create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1189 1190
}

1191
/*
1192 1193 1194
 * 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.
1195
 */
1196
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1197
{
1198
	struct ref_cache *refs = dir->ref_cache;
1199
	DIR *d;
1200
	const char *path;
1201
	struct dirent *de;
1202
	int dirnamelen = strlen(dirname);
1203
	struct strbuf refname;
1204

M
Michael Haggerty 已提交
1205
	if (*refs->name)
1206
		path = git_path_submodule(refs->name, "%s", dirname);
1207
	else
1208
		path = git_path("%s", dirname);
1209

1210
	d = opendir(path);
1211 1212 1213
	if (!d)
		return;

1214 1215
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
1216 1217 1218 1219 1220 1221 1222 1223 1224

	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 已提交
1225
		if (ends_with(de->d_name, ".lock"))
1226
			continue;
1227
		strbuf_addstr(&refname, de->d_name);
1228
		refdir = *refs->name
1229 1230 1231 1232 1233
			? 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)) {
1234
			strbuf_addch(&refname, '/');
1235
			add_entry_to_dir(dir,
1236 1237
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
1238
		} else {
M
Michael Haggerty 已提交
1239
			if (*refs->name) {
1240
				hashclr(sha1);
1241
				flag = 0;
1242
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1243
					hashclr(sha1);
1244
					flag |= REF_ISBROKEN;
1245
				}
1246 1247 1248
			} else if (read_ref_full(refname.buf,
						 RESOLVE_REF_READING,
						 sha1, &flag)) {
1249 1250 1251
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
1252 1253
			add_entry_to_dir(dir,
					 create_ref_entry(refname.buf, sha1, flag, 1));
1254
		}
1255
		strbuf_setlen(&refname, dirnamelen);
1256
	}
1257
	strbuf_release(&refname);
1258
	closedir(d);
1259 1260
}

1261
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1262
{
1263
	if (!refs->loose) {
1264 1265 1266 1267 1268
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
1269
		refs->loose = create_dir_entry(refs, "", 0, 0);
1270 1271 1272 1273
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
1274
				 create_dir_entry(refs, "refs/", 5, 1));
1275
	}
1276
	return get_ref_dir(refs->loose);
1277 1278
}

1279 1280
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
1281 1282
#define MAXREFLEN (1024)

1283 1284
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
1285 1286
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
1287
 */
1288
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1289
				      const char *refname, unsigned char *sha1)
1290
{
1291
	struct ref_entry *ref;
1292
	struct ref_dir *dir = get_packed_refs(refs);
1293

1294
	ref = find_ref(dir, refname);
1295 1296 1297
	if (ref == NULL)
		return -1;

S
Sun He 已提交
1298
	hashcpy(sha1, ref->u.value.sha1);
1299
	return 0;
1300 1301
}

1302
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1303
					 const char *refname, unsigned char *sha1,
1304
					 int recursion)
1305
{
1306
	int fd, len;
1307
	char buffer[128], *p;
1308
	char *path;
1309

1310
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1311
		return -1;
1312 1313 1314 1315
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
1316
	if (fd < 0)
1317
		return resolve_gitlink_packed_ref(refs, refname, sha1);
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

	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? */
1328
	if (!get_sha1_hex(buffer, sha1))
1329 1330 1331 1332 1333 1334 1335 1336 1337
		return 0;

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

1338
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1339 1340
}

1341
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1342 1343
{
	int len = strlen(path), retval;
1344
	char *submodule;
1345
	struct ref_cache *refs;
1346 1347 1348 1349 1350

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1351 1352 1353 1354
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1355
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1356 1357
	return retval;
}
1358

1359
/*
1360 1361
 * Return the ref_entry for the given refname from the packed
 * references.  If it does not exist, return NULL.
1362
 */
1363
static struct ref_entry *get_packed_ref(const char *refname)
1364
{
1365
	return find_ref(get_packed_refs(&ref_cache), refname);
1366 1367
}

1368 1369 1370 1371 1372
/*
 * A loose ref file doesn't exist; check for a packed ref.  The
 * options are forwarded from resolve_safe_unsafe().
 */
static const char *handle_missing_loose_ref(const char *refname,
1373
					    int resolve_flags,
1374
					    unsigned char *sha1,
1375
					    int *flags)
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
{
	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);
1386 1387
		if (flags)
			*flags |= REF_ISPACKED;
1388 1389 1390
		return refname;
	}
	/* The reference is not a packed reference, either. */
1391
	if (resolve_flags & RESOLVE_REF_READING) {
1392 1393 1394 1395 1396 1397 1398
		return NULL;
	} else {
		hashclr(sha1);
		return refname;
	}
}

1399
/* This function needs to return a meaningful errno on failure */
1400
const char *resolve_ref_unsafe(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1401
{
1402 1403
	int depth = MAXDEPTH;
	ssize_t len;
1404
	char buffer[256];
1405
	static char refname_buffer[256];
1406

1407 1408
	if (flags)
		*flags = 0;
1409

1410 1411
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
		errno = EINVAL;
1412
		return NULL;
1413
	}
1414
	for (;;) {
1415
		char path[PATH_MAX];
1416 1417 1418
		struct stat st;
		char *buf;
		int fd;
1419

1420 1421
		if (--depth < 0) {
			errno = ELOOP;
1422
			return NULL;
1423
		}
1424

1425
		git_snpath(path, sizeof(path), "%s", refname);
1426

1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
		/*
		 * 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:
1437
		if (lstat(path, &st) < 0) {
1438
			if (errno == ENOENT)
1439 1440
				return handle_missing_loose_ref(refname,
						resolve_flags, sha1, flags);
1441
			else
1442 1443
				return NULL;
		}
1444

1445 1446 1447
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1448 1449 1450 1451 1452 1453 1454
			if (len < 0) {
				if (errno == ENOENT || errno == EINVAL)
					/* inconsistent with lstat; retry */
					goto stat_ref;
				else
					return NULL;
			}
M
Michael Haggerty 已提交
1455
			buffer[len] = 0;
1456
			if (starts_with(buffer, "refs/") &&
1457
					!check_refname_format(buffer, 0)) {
1458 1459
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1460 1461
				if (flags)
					*flags |= REF_ISSYMREF;
1462 1463 1464 1465
				if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
					hashclr(sha1);
					return refname;
				}
1466 1467
				continue;
			}
1468
		}
1469

1470 1471 1472 1473 1474 1475
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1476 1477 1478 1479 1480
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
1481 1482 1483 1484 1485 1486 1487
		if (fd < 0) {
			if (errno == ENOENT)
				/* inconsistent with lstat; retry */
				goto stat_ref;
			else
				return NULL;
		}
1488
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1489 1490 1491 1492
		if (len < 0) {
			int save_errno = errno;
			close(fd);
			errno = save_errno;
1493
			return NULL;
1494 1495
		}
		close(fd);
1496 1497 1498
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1499 1500 1501 1502

		/*
		 * Is it a symbolic ref?
		 */
1503
		if (!starts_with(buffer, "ref:")) {
1504 1505 1506 1507 1508 1509
			/*
			 * Please note that FETCH_HEAD has a second
			 * line containing other data.
			 */
			if (get_sha1_hex(buffer, sha1) ||
			    (buffer[40] != '\0' && !isspace(buffer[40]))) {
1510 1511
				if (flags)
					*flags |= REF_ISBROKEN;
1512
				errno = EINVAL;
1513 1514 1515 1516
				return NULL;
			}
			return refname;
		}
1517 1518
		if (flags)
			*flags |= REF_ISSYMREF;
1519
		buf = buffer + 4;
1520 1521
		while (isspace(*buf))
			buf++;
1522 1523 1524 1525 1526
		refname = strcpy(refname_buffer, buf);
		if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
			hashclr(sha1);
			return refname;
		}
1527
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1528 1529
			if (flags)
				*flags |= REF_ISBROKEN;
1530
			errno = EINVAL;
1531 1532
			return NULL;
		}
1533
	}
1534 1535
}

1536
char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)
1537
{
1538
	const char *ret = resolve_ref_unsafe(ref, resolve_flags, sha1, flags);
1539 1540 1541
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1542 1543 1544 1545 1546 1547 1548
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1549
int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1550
{
1551
	if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
1552 1553
		return 0;
	return -1;
1554 1555
}

1556
int read_ref(const char *refname, unsigned char *sha1)
1557
{
1558
	return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
1559 1560
}

1561
int ref_exists(const char *refname)
1562
{
1563
	unsigned char sha1[20];
1564
	return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
1565 1566
}

1567
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1568
		       void *data)
I
Ilari Liusvaara 已提交
1569 1570
{
	struct ref_filter *filter = (struct ref_filter *)data;
1571
	if (wildmatch(filter->pattern, refname, 0, NULL))
I
Ilari Liusvaara 已提交
1572
		return 0;
1573
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1574 1575
}

1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
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: */
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
	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
1599 1600
};

1601 1602
/*
 * Peel the named object; i.e., if the object is a tag, resolve the
1603 1604 1605 1606
 * 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.
1607
 */
1608
static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1609 1610 1611 1612 1613
{
	struct object *o = lookup_unknown_object(name);

	if (o->type == OBJ_NONE) {
		int type = sha1_object_info(name, NULL);
1614
		if (type < 0 || !object_as_type(o, type, 0))
1615
			return PEEL_INVALID;
1616 1617 1618
	}

	if (o->type != OBJ_TAG)
1619
		return PEEL_NON_TAG;
1620 1621 1622

	o = deref_tag_noverify(o);
	if (!o)
1623
		return PEEL_INVALID;
1624 1625

	hashcpy(sha1, o->sha1);
1626
	return PEEL_PEELED;
1627 1628
}

1629
/*
1630 1631 1632
 * 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.
1633 1634 1635 1636 1637 1638
 *
 * 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.
1639
 */
1640
static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1641 1642 1643
{
	enum peel_status status;

1644 1645 1646 1647 1648 1649 1650 1651 1652
	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;
		}
	}
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
	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;
}

1664
int peel_ref(const char *refname, unsigned char *sha1)
1665 1666 1667 1668
{
	int flag;
	unsigned char base[20];

1669
	if (current_ref && (current_ref->name == refname
1670
			    || !strcmp(current_ref->name, refname))) {
1671
		if (peel_entry(current_ref, 0))
1672 1673 1674
			return -1;
		hashcpy(sha1, current_ref->u.value.peeled);
		return 0;
1675 1676
	}

1677
	if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1678 1679
		return -1;

1680 1681 1682 1683 1684 1685 1686 1687 1688
	/*
	 * 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) {
1689
		struct ref_entry *r = get_packed_ref(refname);
1690
		if (r) {
1691
			if (peel_entry(r, 0))
1692
				return -1;
1693
			hashcpy(sha1, r->u.value.peeled);
1694
			return 0;
1695 1696 1697
		}
	}

1698
	return peel_object(base, sha1);
1699 1700
}

1701 1702 1703
struct warn_if_dangling_data {
	FILE *fp;
	const char *refname;
1704
	const struct string_list *refnames;
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
	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;

1718
	resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);
1719 1720 1721 1722
	if (!resolves_to
	    || (d->refname
		? strcmp(resolves_to, d->refname)
		: !string_list_has_string(d->refnames, resolves_to))) {
1723
		return 0;
1724
	}
1725 1726

	fprintf(d->fp, d->msg_fmt, refname);
J
Junio C Hamano 已提交
1727
	fputc('\n', d->fp);
1728 1729 1730 1731 1732 1733 1734 1735 1736
	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;
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
	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;
1749 1750 1751 1752
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

1753
/*
1754
 * Call fn for each reference in the specified ref_cache, omitting
1755 1756
 * references not in the containing_dir of base.  fn is called for all
 * references, including broken ones.  If fn ever returns a non-zero
1757 1758 1759
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
1760
static int do_for_each_entry(struct ref_cache *refs, const char *base,
1761
			     each_ref_entry_fn fn, void *cb_data)
1762
{
1763 1764 1765
	struct packed_ref_cache *packed_ref_cache;
	struct ref_dir *loose_dir;
	struct ref_dir *packed_dir;
1766 1767
	int retval = 0;

1768 1769 1770 1771 1772 1773 1774 1775 1776
	/*
	 * 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);
1777 1778 1779
	if (base && *base) {
		loose_dir = find_containing_dir(loose_dir, base, 0);
	}
1780 1781 1782 1783
	if (loose_dir)
		prime_ref_dir(loose_dir);

	packed_ref_cache = get_packed_ref_cache(refs);
1784
	acquire_packed_ref_cache(packed_ref_cache);
1785
	packed_dir = get_packed_ref_dir(packed_ref_cache);
1786 1787 1788 1789 1790 1791 1792
	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);
1793 1794
		retval = do_for_each_entry_in_dirs(
				packed_dir, loose_dir, fn, cb_data);
1795 1796
	} else if (packed_dir) {
		sort_ref_dir(packed_dir);
1797 1798
		retval = do_for_each_entry_in_dir(
				packed_dir, 0, fn, cb_data);
1799 1800
	} else if (loose_dir) {
		sort_ref_dir(loose_dir);
1801 1802
		retval = do_for_each_entry_in_dir(
				loose_dir, 0, fn, cb_data);
1803 1804
	}

1805
	release_packed_ref_cache(packed_ref_cache);
1806
	return retval;
1807 1808
}

1809
/*
1810
 * Call fn for each reference in the specified ref_cache for which the
1811 1812 1813 1814 1815 1816 1817
 * 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.
 */
1818 1819
static int do_for_each_ref(struct ref_cache *refs, const char *base,
			   each_ref_fn fn, int trim, int flags, void *cb_data)
1820 1821 1822 1823 1824 1825 1826 1827
{
	struct ref_entry_cb data;
	data.base = base;
	data.trim = trim;
	data.flags = flags;
	data.fn = fn;
	data.cb_data = cb_data;

1828
	return do_for_each_entry(refs, base, do_one_ref, &data);
1829 1830
}

1831
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1832 1833
{
	unsigned char sha1[20];
1834 1835
	int flag;

1836 1837 1838 1839 1840 1841 1842
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1843
	if (!read_ref_full("HEAD", RESOLVE_REF_READING, sha1, &flag))
1844
		return fn("HEAD", sha1, flag, cb_data);
1845

1846
	return 0;
1847 1848
}

1849 1850 1851 1852 1853
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1854 1855 1856 1857 1858
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1859
int for_each_ref(each_ref_fn fn, void *cb_data)
1860
{
1861
	return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1862 1863
}

1864 1865
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1866
	return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1867 1868
}

1869 1870
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1871
	return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1872 1873
}

1874 1875 1876
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
1877
	return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1878 1879
}

1880
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1881
{
1882
	return for_each_ref_in("refs/tags/", fn, cb_data);
1883 1884
}

1885 1886 1887 1888 1889
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);
}

1890
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1891
{
1892
	return for_each_ref_in("refs/heads/", fn, cb_data);
1893 1894
}

1895 1896 1897 1898 1899
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);
}

1900
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1901
{
1902
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1903 1904
}

1905 1906 1907 1908 1909
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);
}

1910 1911
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1912
	return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
1913 1914
}

J
Josh Triplett 已提交
1915 1916 1917 1918 1919 1920 1921 1922
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());
1923
	if (!read_ref_full(buf.buf, RESOLVE_REF_READING, sha1, &flag))
J
Josh Triplett 已提交
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934
		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());
1935
	ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
J
Josh Triplett 已提交
1936 1937 1938 1939
	strbuf_release(&buf);
	return ret;
}

1940 1941
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1942 1943 1944 1945 1946
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1947
	if (!prefix && !starts_with(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1948
		strbuf_addstr(&real_pattern, "refs/");
1949 1950
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1951 1952
	strbuf_addstr(&real_pattern, pattern);

1953
	if (!has_glob_specials(pattern)) {
1954
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
		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;
}

1970 1971 1972 1973 1974
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);
}

1975 1976
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
1977
	return do_for_each_ref(&ref_cache, "", fn, 0,
1978
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1979 1980
}

1981
const char *prettify_refname(const char *name)
1982 1983
{
	return name + (
1984 1985 1986
		starts_with(name, "refs/heads/") ? 11 :
		starts_with(name, "refs/tags/") ? 10 :
		starts_with(name, "refs/remotes/") ? 13 :
1987 1988 1989
		0);
}

1990
static const char *ref_rev_parse_rules[] = {
S
Steffen Prohaska 已提交
1991 1992 1993 1994 1995 1996 1997 1998 1999
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

2000
int refname_match(const char *abbrev_name, const char *full_name)
S
Steffen Prohaska 已提交
2001 2002 2003 2004
{
	const char **p;
	const int abbrev_name_len = strlen(abbrev_name);

2005
	for (p = ref_rev_parse_rules; *p; p++) {
S
Steffen Prohaska 已提交
2006 2007 2008 2009 2010 2011 2012 2013
		if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
			return 1;
		}
	}

	return 0;
}

2014
/* This function should make sure errno is meaningful on error */
J
Junio C Hamano 已提交
2015
static struct ref_lock *verify_lock(struct ref_lock *lock,
2016 2017
	const unsigned char *old_sha1, int mustexist)
{
2018 2019 2020
	if (read_ref_full(lock->ref_name,
			  mustexist ? RESOLVE_REF_READING : 0,
			  lock->old_sha1, NULL)) {
2021
		int save_errno = errno;
2022
		error("Can't verify ref %s", lock->ref_name);
2023
		unlock_ref(lock);
2024
		errno = save_errno;
2025 2026
		return NULL;
	}
2027
	if (hashcmp(lock->old_sha1, old_sha1)) {
2028
		error("Ref %s is at %s but expected %s", lock->ref_name,
2029 2030
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
2031
		errno = EBUSY;
2032 2033 2034 2035 2036
		return NULL;
	}
	return lock;
}

2037
static int remove_empty_directories(const char *file)
2038 2039 2040 2041 2042
{
	/* 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.
	 */
2043
	struct strbuf path;
2044
	int result, save_errno;
2045

2046 2047 2048
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

2049
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
2050
	save_errno = errno;
2051 2052

	strbuf_release(&path);
2053
	errno = save_errno;
2054 2055

	return result;
2056 2057
}

2058 2059 2060 2061 2062 2063 2064 2065
/*
 * *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;
2066
	int ret = interpret_branch_name(*string, *len, &buf);
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092

	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);
2093 2094
		r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
				       this_result, &flag);
2095 2096 2097 2098 2099
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
2100
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2101
			warning("ignoring dangling symref %s.", fullref);
2102 2103 2104
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122
	}
	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);
2123 2124
		ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
					 hash, NULL);
2125 2126
		if (!ref)
			continue;
2127
		if (reflog_exists(path))
2128
			it = path;
2129
		else if (strcmp(ref, path) && reflog_exists(ref))
2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
			it = ref;
		else
			continue;
		if (!logs_found++) {
			*log = xstrdup(it);
			hashcpy(sha1, hash);
		}
		if (!warn_ambiguous_refs)
			break;
	}
	free(last_branch);
	return logs_found;
}

2144
/*
2145
 * Locks a ref returning the lock on success and NULL on failure.
2146 2147
 * On failure errno is set to something meaningful.
 */
2148 2149
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
2150
					    const struct string_list *skip,
2151
					    int flags, int *type_p)
2152
{
2153
	char *ref_file;
2154
	const char *orig_refname = refname;
2155
	struct ref_lock *lock;
2156
	int last_errno = 0;
2157
	int type, lflags;
2158
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2159
	int resolve_flags = 0;
2160
	int missing = 0;
2161
	int attempts_remaining = 3;
2162

2163 2164 2165 2166 2167
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
		errno = EINVAL;
		return NULL;
	}

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

2171 2172
	if (mustexist)
		resolve_flags |= RESOLVE_REF_READING;
2173 2174
	if (flags & REF_NODEREF && flags & REF_DELETING)
		resolve_flags |= RESOLVE_REF_NO_RECURSE;
2175 2176 2177

	refname = resolve_ref_unsafe(refname, resolve_flags,
				     lock->old_sha1, &type);
2178
	if (!refname && errno == EISDIR) {
2179 2180 2181 2182 2183
		/* 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.
		 */
2184
		ref_file = git_path("%s", orig_refname);
2185 2186
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
2187
			error("there are still refs under '%s'", orig_refname);
2188 2189
			goto error_return;
		}
2190 2191
		refname = resolve_ref_unsafe(orig_refname, resolve_flags,
					     lock->old_sha1, &type);
2192
	}
2193 2194
	if (type_p)
	    *type_p = type;
2195
	if (!refname) {
2196
		last_errno = errno;
2197
		error("unable to resolve reference %s: %s",
2198
			orig_refname, strerror(errno));
2199
		goto error_return;
2200
	}
2201
	missing = is_null_sha1(lock->old_sha1);
2202 2203 2204 2205 2206
	/* When the ref did not exist and we are creating it,
	 * make sure there is no existing ref that is packed
	 * whose name begins with our refname, nor a ref whose
	 * name is a proper prefix of our refname.
	 */
2207
	if (missing &&
2208
	     !is_refname_available(refname, skip, get_packed_refs(&ref_cache))) {
2209
		last_errno = ENOTDIR;
2210
		goto error_return;
2211
	}
2212

2213
	lock->lk = xcalloc(1, sizeof(struct lock_file));
2214

2215
	lflags = 0;
2216
	if (flags & REF_NODEREF) {
2217
		refname = orig_refname;
2218
		lflags |= LOCK_NO_DEREF;
2219
	}
2220 2221 2222
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
2223
	if (missing)
2224 2225 2226
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
2227

2228 2229 2230 2231 2232 2233 2234 2235 2236
 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:
2237 2238 2239 2240
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
2241

2242
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
2243 2244 2245 2246 2247 2248 2249 2250 2251
	if (lock->lock_fd < 0) {
		if (errno == ENOENT && --attempts_remaining > 0)
			/*
			 * Maybe somebody just deleted one of the
			 * directories leading to ref_file.  Try
			 * again:
			 */
			goto retry;
		else
2252
			unable_to_lock_die(ref_file, errno);
2253
	}
2254
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
2255 2256 2257 2258 2259

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
2260 2261
}

2262
struct ref_lock *lock_any_ref_for_update(const char *refname,
2263 2264
					 const unsigned char *old_sha1,
					 int flags, int *type_p)
2265
{
2266
	return lock_ref_sha1_basic(refname, old_sha1, NULL, flags, type_p);
J
Junio C Hamano 已提交
2267 2268
}

2269 2270 2271 2272
/*
 * 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.
 */
2273
static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2274
			       unsigned char *peeled)
2275
{
2276 2277 2278
	fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
	if (peeled)
		fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2279 2280
}

2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
/*
 * 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);
2291
	write_packed_entry(cb_data, entry->name, entry->u.value.sha1,
2292 2293 2294 2295 2296
			   peel_status == PEEL_PEELED ?
			   entry->u.value.peeled : NULL);
	return 0;
}

2297
/* This should return a meaningful errno on failure */
2298 2299 2300 2301 2302 2303
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;
2304 2305 2306 2307 2308 2309
	/*
	 * 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.
	 */
2310 2311
	packed_ref_cache = get_packed_ref_cache(&ref_cache);
	packed_ref_cache->lock = &packlock;
2312 2313
	/* Increment the reference count to prevent it from being freed: */
	acquire_packed_ref_cache(packed_ref_cache);
2314 2315 2316
	return 0;
}

2317 2318 2319 2320
/*
 * Commit the packed refs changes.
 * On error we must make sure that errno contains a meaningful value.
 */
2321 2322 2323 2324 2325
int commit_packed_refs(void)
{
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);
	int error = 0;
2326
	int save_errno = 0;
2327
	FILE *out;
2328 2329 2330 2331

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

2332
	out = fdopen_lock_file(packed_ref_cache->lock, "w");
2333 2334 2335 2336
	if (!out)
		die_errno("unable to fdopen packed-refs descriptor");

	fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2337
	do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2338 2339
				 0, write_packed_entry_fn, out);

2340 2341
	if (commit_lock_file(packed_ref_cache->lock)) {
		save_errno = errno;
2342
		error = -1;
2343
	}
2344
	packed_ref_cache->lock = NULL;
2345
	release_packed_ref_cache(packed_ref_cache);
2346
	errno = save_errno;
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358
	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;
2359
	release_packed_ref_cache(packed_ref_cache);
2360 2361 2362
	clear_packed_ref_cache(&ref_cache);
}

2363 2364 2365 2366 2367 2368 2369 2370
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;
2371
	struct ref_dir *packed_refs;
2372 2373 2374
	struct ref_to_prune *ref_to_prune;
};

2375 2376 2377 2378 2379 2380 2381
/*
 * 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)
2382 2383
{
	struct pack_refs_cb_data *cb = cb_data;
2384
	enum peel_status peel_status;
2385
	struct ref_entry *packed_entry;
2386
	int is_tag_ref = starts_with(entry->name, "refs/tags/");
2387

2388 2389
	/* ALWAYS pack tags */
	if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2390 2391
		return 0;

2392 2393 2394 2395
	/* Do not pack symbolic or broken refs: */
	if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
		return 0;

2396
	/* Add a packed ref cache entry equivalent to the loose entry. */
2397
	peel_status = peel_entry(entry, 1);
2398
	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2399 2400
		die("internal error peeling reference %s (%s)",
		    entry->name, sha1_to_hex(entry->u.value.sha1));
2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411
	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);
2412

2413 2414
	/* Schedule the loose reference for pruning if requested. */
	if ((cb->flags & PACK_REFS_PRUNE)) {
2415
		int namelen = strlen(entry->name) + 1;
2416
		struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2417 2418
		hashcpy(n->sha1, entry->u.value.sha1);
		strcpy(n->name, entry->name);
2419 2420 2421
		n->next = cb->ref_to_prune;
		cb->ref_to_prune = n;
	}
2422 2423 2424
	return 0;
}

2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
/*
 * 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)
{
2459 2460
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
2461

2462
	if (check_refname_format(r->name, 0))
R
Ronnie Sahlberg 已提交
2463
		return;
2464

2465 2466 2467
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
	    ref_transaction_delete(transaction, r->name, r->sha1,
2468 2469
				   REF_ISPRUNING, 1, NULL, &err) ||
	    ref_transaction_commit(transaction, &err)) {
2470 2471 2472 2473
		ref_transaction_free(transaction);
		error("%s", err.buf);
		strbuf_release(&err);
		return;
2474
	}
2475 2476 2477
	ref_transaction_free(transaction);
	strbuf_release(&err);
	try_remove_empty_parents(r->name);
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
}

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;

2495
	lock_packed_refs(LOCK_DIE_ON_ERROR);
2496
	cbdata.packed_refs = get_packed_refs(&ref_cache);
2497

2498 2499
	do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
				 pack_if_possible_fn, &cbdata);
2500

2501
	if (commit_packed_refs())
2502
		die_errno("unable to overwrite old ref-pack file");
2503

2504 2505 2506 2507
	prune_refs(cbdata.ref_to_prune);
	return 0;
}

2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
/*
 * If entry is no longer needed in packed-refs, add it to the string
 * list pointed to by cb_data.  Reasons for deleting entries:
 *
 * - Entry is broken.
 * - Entry is overridden by a loose ref.
 * - Entry does not point at a valid object.
 *
 * In the first and third cases, also emit an error message because these
 * are indications of repository corruption.
 */
static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
J
Junio C Hamano 已提交
2520
{
2521
	struct string_list *refs_to_delete = cb_data;
2522

2523 2524 2525
	if (entry->flag & REF_ISBROKEN) {
		/* This shouldn't happen to packed refs. */
		error("%s is broken!", entry->name);
2526
		string_list_append(refs_to_delete, entry->name);
J
Junio C Hamano 已提交
2527
		return 0;
2528 2529 2530 2531 2532
	}
	if (!has_sha1_file(entry->u.value.sha1)) {
		unsigned char sha1[20];
		int flags;

2533
		if (read_ref_full(entry->name, 0, sha1, &flags))
2534 2535
			/* We should at least have found the packed ref. */
			die("Internal error");
2536
		if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2537 2538 2539 2540 2541 2542 2543 2544
			/*
			 * This packed reference is overridden by a
			 * loose reference, so it is OK that its value
			 * is no longer valid; for example, it might
			 * refer to an object that has been garbage
			 * collected.  For this purpose we don't even
			 * care whether the loose reference itself is
			 * invalid, broken, symbolic, etc.  Silently
2545
			 * remove the packed reference.
2546
			 */
2547
			string_list_append(refs_to_delete, entry->name);
2548
			return 0;
2549
		}
2550 2551 2552 2553 2554 2555 2556 2557
		/*
		 * There is no overriding loose reference, so the fact
		 * that this reference doesn't refer to a valid object
		 * indicates some kind of repository corruption.
		 * Report the problem, then omit the reference from
		 * the output.
		 */
		error("%s does not point to a valid object!", entry->name);
2558
		string_list_append(refs_to_delete, entry->name);
2559 2560 2561
		return 0;
	}

2562 2563 2564
	return 0;
}

2565
int repack_without_refs(const char **refnames, int n, struct strbuf *err)
J
Junio C Hamano 已提交
2566
{
2567
	struct ref_dir *packed;
2568 2569
	struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
	struct string_list_item *ref_to_delete;
2570
	int i, ret, removed = 0;
2571 2572 2573 2574 2575

	/* Look for a packed ref */
	for (i = 0; i < n; i++)
		if (get_packed_ref(refnames[i]))
			break;
2576

2577 2578 2579
	/* Avoid locking if we have nothing to do */
	if (i == n)
		return 0; /* no refname exists in packed refs */
2580

2581
	if (lock_packed_refs(0)) {
2582 2583 2584 2585 2586
		if (err) {
			unable_to_lock_message(git_path("packed-refs"), errno,
					       err);
			return -1;
		}
2587
		unable_to_lock_error(git_path("packed-refs"), errno);
2588
		return error("cannot delete '%s' from packed refs", refnames[i]);
2589
	}
2590
	packed = get_packed_refs(&ref_cache);
2591

2592 2593 2594 2595 2596
	/* Remove refnames from the cache */
	for (i = 0; i < n; i++)
		if (remove_entry(packed, refnames[i]) != -1)
			removed = 1;
	if (!removed) {
2597
		/*
2598
		 * All packed entries disappeared while we were
2599 2600
		 * acquiring the lock.
		 */
2601
		rollback_packed_refs();
2602 2603
		return 0;
	}
2604

2605
	/* Remove any other accumulated cruft */
2606 2607 2608 2609 2610 2611
	do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
	for_each_string_list_item(ref_to_delete, &refs_to_delete) {
		if (remove_entry(packed, ref_to_delete->string) == -1)
			die("internal error");
	}

2612
	/* Write what remains */
2613 2614 2615 2616 2617
	ret = commit_packed_refs();
	if (ret && err)
		strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
			    strerror(errno));
	return ret;
J
Junio C Hamano 已提交
2618 2619
}

2620
static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2621
{
2622
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2623 2624 2625 2626
		/*
		 * loose.  The loose file name is the same as the
		 * lockfile name, minus ".lock":
		 */
2627
		char *loose_filename = get_locked_file_path(lock->lk);
2628
		int res = unlink_or_msg(loose_filename, err);
2629
		free(loose_filename);
2630
		if (res)
2631
			return 1;
J
Junio C Hamano 已提交
2632
	}
2633 2634 2635
	return 0;
}

M
Miklos Vajna 已提交
2636
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
2637
{
2638 2639
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
J
Junio C Hamano 已提交
2640

2641 2642 2643
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
	    ref_transaction_delete(transaction, refname, sha1, delopt,
2644 2645
				   sha1 && !is_null_sha1(sha1), NULL, &err) ||
	    ref_transaction_commit(transaction, &err)) {
2646 2647 2648
		error("%s", err.buf);
		ref_transaction_free(transaction);
		strbuf_release(&err);
J
Junio C Hamano 已提交
2649
		return 1;
2650 2651 2652 2653
	}
	ref_transaction_free(transaction);
	strbuf_release(&err);
	return 0;
2654 2655
}

2656 2657 2658 2659 2660 2661 2662 2663 2664
/*
 * 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"

2665 2666
static int rename_tmp_log(const char *newrefname)
{
2667
	int attempts_remaining = 4;
2668 2669

 retry:
2670 2671 2672 2673 2674 2675 2676 2677
	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:
2678 2679 2680 2681 2682
		error("unable to create directory for %s", newrefname);
		return -1;
	}

	if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2683
		if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2684 2685 2686 2687 2688 2689 2690 2691 2692 2693
			/*
			 * 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;
2694 2695 2696 2697 2698 2699 2700
		} 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;
2701 2702 2703 2704 2705 2706 2707 2708 2709
		} else {
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
				newrefname, strerror(errno));
			return -1;
		}
	}
	return 0;
}

2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721
static int rename_ref_available(const char *oldname, const char *newname)
{
	struct string_list skip = STRING_LIST_INIT_NODUP;
	int ret;

	string_list_insert(&skip, oldname);
	ret = is_refname_available(newname, &skip, get_packed_refs(&ref_cache))
	    && is_refname_available(newname, &skip, get_loose_refs(&ref_cache));
	string_list_clear(&skip, 0);
	return ret;
}

2722 2723 2724
static int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1,
			  const char *logmsg);

2725
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2726 2727 2728 2729 2730
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
2731
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
2732
	const char *symref = NULL;
2733

2734
	if (log && S_ISLNK(loginfo.st_mode))
2735
		return error("reflog for %s is a symlink", oldrefname);
2736

2737 2738
	symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,
				    orig_sha1, &flag);
M
Miklos Vajna 已提交
2739
	if (flag & REF_ISSYMREF)
2740
		return error("refname %s is a symbolic ref, renaming it is not supported",
2741
			oldrefname);
M
Miklos Vajna 已提交
2742
	if (!symref)
2743
		return error("refname %s not found", oldrefname);
2744

2745
	if (!rename_ref_available(oldrefname, newrefname))
2746 2747
		return 1;

2748
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2749
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2750
			oldrefname, strerror(errno));
2751

2752 2753
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
2754 2755 2756
		goto rollback;
	}

2757
	if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&
2758
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
2759
		if (errno==EISDIR) {
2760 2761
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
2762 2763 2764
				goto rollback;
			}
		} else {
2765
			error("unable to delete existing %s", newrefname);
2766 2767 2768 2769
			goto rollback;
		}
	}

2770
	if (log && rename_tmp_log(newrefname))
2771 2772 2773 2774
		goto rollback;

	logmoved = log;

2775
	lock = lock_ref_sha1_basic(newrefname, NULL, NULL, 0, NULL);
2776
	if (!lock) {
2777
		error("unable to lock %s for update", newrefname);
2778 2779 2780 2781
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
2782
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2783
		error("unable to write current sha1 into %s", newrefname);
2784 2785 2786 2787 2788 2789
		goto rollback;
	}

	return 0;

 rollback:
2790
	lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, 0, NULL);
2791
	if (!lock) {
2792
		error("unable to lock %s for rollback", oldrefname);
2793 2794 2795 2796 2797 2798 2799
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
2800
		error("unable to write current sha1 into %s", oldrefname);
2801 2802 2803
	log_all_ref_updates = flag;

 rollbacklog:
2804
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2805
		error("unable to restore logfile %s from %s: %s",
2806
			oldrefname, newrefname, strerror(errno));
2807
	if (!logmoved && log &&
2808
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2809
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2810
			oldrefname, strerror(errno));
2811 2812 2813 2814

	return 1;
}

2815
int close_ref(struct ref_lock *lock)
2816 2817 2818 2819 2820 2821 2822
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

2823
int commit_ref(struct ref_lock *lock)
2824 2825 2826 2827 2828 2829 2830
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
2831
void unlock_ref(struct ref_lock *lock)
2832
{
B
Brandon Casey 已提交
2833 2834 2835
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
2836
	free(lock->ref_name);
2837
	free(lock->orig_ref_name);
2838 2839 2840
	free(lock);
}

2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866
/*
 * 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;
}

2867
/* This function must set a meaningful errno on failure */
2868
int log_ref_setup(const char *refname, char *logfile, int bufsize)
2869
{
2870
	int logfd, oflags = O_APPEND | O_WRONLY;
2871

2872
	git_snpath(logfile, bufsize, "logs/%s", refname);
2873
	if (log_all_ref_updates &&
2874 2875 2876
	    (starts_with(refname, "refs/heads/") ||
	     starts_with(refname, "refs/remotes/") ||
	     starts_with(refname, "refs/notes/") ||
2877
	     !strcmp(refname, "HEAD"))) {
2878 2879 2880 2881 2882 2883
		if (safe_create_leading_directories(logfile) < 0) {
			int save_errno = errno;
			error("unable to create directory for %s", logfile);
			errno = save_errno;
			return -1;
		}
2884 2885 2886
		oflags |= O_CREAT;
	}

2887
	logfd = open(logfile, oflags, 0666);
2888
	if (logfd < 0) {
J
Junio C Hamano 已提交
2889
		if (!(oflags & O_CREAT) && errno == ENOENT)
2890
			return 0;
2891 2892

		if ((oflags & O_CREAT) && errno == EISDIR) {
2893
			if (remove_empty_directories(logfile)) {
2894 2895 2896 2897 2898
				int save_errno = errno;
				error("There are still logs under '%s'",
				      logfile);
				errno = save_errno;
				return -1;
2899
			}
2900
			logfd = open(logfile, oflags, 0666);
2901 2902
		}

2903 2904 2905 2906 2907 2908 2909
		if (logfd < 0) {
			int save_errno = errno;
			error("Unable to append to %s: %s", logfile,
			      strerror(errno));
			errno = save_errno;
			return -1;
		}
2910 2911
	}

2912
	adjust_shared_perm(logfile);
2913 2914 2915
	close(logfd);
	return 0;
}
2916

2917
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2918 2919 2920 2921 2922
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
2923
	char log_file[PATH_MAX];
2924 2925 2926 2927 2928 2929
	char *logrec;
	const char *committer;

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

2930
	result = log_ref_setup(refname, log_file, sizeof(log_file));
2931 2932 2933 2934 2935 2936
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
2937
	msglen = msg ? strlen(msg) : 0;
2938
	committer = git_committer_info(0);
2939 2940 2941
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
2942 2943
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
2944 2945
		      committer);
	if (msglen)
2946
		len += copy_msg(logrec + len - 1, msg) - 1;
2947
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2948
	free(logrec);
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961
	if (written != len) {
		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;
	}
2962 2963 2964
	return 0;
}

2965
int is_branch(const char *refname)
2966
{
2967
	return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
2968 2969
}

2970 2971 2972 2973 2974
/*
 * 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,
2975 2976 2977
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
2978
	struct object *o;
2979

2980 2981
	if (!lock) {
		errno = EINVAL;
D
Daniel Barkalow 已提交
2982
		return -1;
2983
	}
2984
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2985 2986
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
2987
	}
2988 2989
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
2990
		error("Trying to write ref %s with nonexistent object %s",
2991 2992
			lock->ref_name, sha1_to_hex(sha1));
		unlock_ref(lock);
2993
		errno = EINVAL;
2994 2995 2996 2997 2998 2999
		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);
3000
		errno = EINVAL;
3001 3002
		return -1;
	}
3003
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
3004 3005 3006
	    write_in_full(lock->lock_fd, &term, 1) != 1 ||
	    close_ref(lock) < 0) {
		int save_errno = errno;
3007
		error("Couldn't write %s", lock->lk->filename.buf);
3008
		unlock_ref(lock);
3009
		errno = save_errno;
3010 3011
		return -1;
	}
3012
	clear_loose_ref_cache(&ref_cache);
N
Nicolas Pitre 已提交
3013 3014 3015
	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)) {
3016 3017 3018
		unlock_ref(lock);
		return -1;
	}
3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034
	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;
3035 3036
		head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
					      head_sha1, &head_flag);
3037 3038 3039 3040
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
3041
	if (commit_ref(lock)) {
3042
		error("Couldn't set %s", lock->ref_name);
3043 3044 3045 3046 3047
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
3048
}
3049

3050 3051
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
3052 3053 3054 3055
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
3056
	char *git_HEAD = git_pathdup("%s", ref_target);
3057 3058 3059 3060
	unsigned char old_sha1[20], new_sha1[20];

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

3062 3063 3064
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

3065 3066 3067 3068
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
3069
			goto done;
3070 3071 3072 3073 3074 3075 3076
		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);
3077
		goto error_free_return;
3078 3079 3080 3081 3082
	}
	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);
3083
		goto error_free_return;
3084 3085
	}
	written = write_in_full(fd, ref, len);
3086
	if (close(fd) != 0 || written != len) {
3087
		error("Unable to write to %s", lockpath);
3088
		goto error_unlink_return;
3089 3090 3091
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
3092
		goto error_unlink_return;
3093 3094 3095
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
3096
	error_unlink_return:
3097
		unlink_or_warn(lockpath);
3098 3099 3100
	error_free_return:
		free(git_HEAD);
		return -1;
3101
	}
3102

3103
#ifndef NO_SYMLINK_HEAD
3104
	done:
3105
#endif
3106 3107 3108
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

3109
	free(git_HEAD);
3110 3111 3112
	return 0;
}

3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196
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;
3197 3198
}

3199
int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
3200 3201
		unsigned char *sha1, char **msg,
		unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3202
{
3203
	struct read_ref_at_cb cb;
3204

3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216
	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);

3217 3218 3219 3220 3221 3222
	if (!cb.reccnt) {
		if (flags & GET_SHA1_QUIETLY)
			exit(128);
		else
			die("Log for %s is empty.", refname);
	}
3223 3224 3225 3226
	if (cb.found_it)
		return 0;

	for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3227

3228
	return 1;
3229
}
3230

3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243
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));
}

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

3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283
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)
3284
{
3285
	struct strbuf sb = STRBUF_INIT;
3286 3287 3288
	FILE *logfp;
	long pos;
	int ret = 0, at_tail = 1;
3289

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

3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310
	/* 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 已提交
3311
		if (nread != 1)
3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348
			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);

			if (*bp != '\n') {
				strbuf_splice(&sb, 0, 0, buf, endp - buf);
				if (pos)
					break; /* need to fill another block */
				scanp = buf - 1; /* leave loop */
			} else {
				/*
				 * (bp + 1) thru endp is the beginning of the
				 * current line we have in sb
				 */
				strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
				scanp = bp;
				endp = bp + 1;
			}
			ret = show_one_reflog_ent(&sb, fn, cb_data);
			strbuf_reset(&sb);
			if (ret)
				break;
3349
		}
3350

3351
	}
3352
	if (!ret && sb.len)
3353
		ret = show_one_reflog_ent(&sb, fn, cb_data);
3354

3355
	fclose(logfp);
3356
	strbuf_release(&sb);
3357
	return ret;
3358
}
J
Junio C Hamano 已提交
3359

3360
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3361
{
3362 3363 3364 3365 3366 3367 3368
	FILE *logfp;
	struct strbuf sb = STRBUF_INIT;
	int ret = 0;

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

3370 3371 3372 3373 3374 3375
	while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
		ret = show_one_reflog_ent(&sb, fn, cb_data);
	fclose(logfp);
	strbuf_release(&sb);
	return ret;
}
3376 3377 3378 3379 3380 3381
/*
 * 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)
3382
{
3383
	DIR *d = opendir(git_path("logs/%s", name->buf));
3384
	int retval = 0;
3385
	struct dirent *de;
3386
	int oldlen = name->len;
3387

3388
	if (!d)
3389
		return name->len ? errno : 0;
3390

3391 3392
	while ((de = readdir(d)) != NULL) {
		struct stat st;
3393

3394 3395
		if (de->d_name[0] == '.')
			continue;
J
Jeff King 已提交
3396
		if (ends_with(de->d_name, ".lock"))
3397
			continue;
3398 3399 3400
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
3401
		} else {
3402
			if (S_ISDIR(st.st_mode)) {
3403 3404
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
3405 3406
			} else {
				unsigned char sha1[20];
3407
				if (read_ref_full(name->buf, 0, sha1, NULL))
3408
					retval = error("bad ref for %s", name->buf);
3409
				else
3410
					retval = fn(name->buf, sha1, 0, cb_data);
3411 3412 3413 3414
			}
			if (retval)
				break;
		}
3415
		strbuf_setlen(name, oldlen);
3416
	}
3417
	closedir(d);
3418 3419 3420 3421 3422
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
3423 3424 3425 3426 3427 3428
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
3429
}
C
Carlos Rica 已提交
3430

3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441
/**
 * Information needed for a single ref update.  Set new_sha1 to the
 * new value or to zero to delete the ref.  To check the old value
 * while locking the ref, set have_old to 1 and set old_sha1 to the
 * value or to zero to ensure the ref does not exist before update.
 */
struct ref_update {
	unsigned char new_sha1[20];
	unsigned char old_sha1[20];
	int flags; /* REF_NODEREF? */
	int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
3442
	struct ref_lock *lock;
3443
	int type;
3444
	char *msg;
3445
	const char refname[FLEX_ARRAY];
3446 3447
};

3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462
/*
 * 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
};

3463 3464 3465 3466 3467 3468 3469 3470 3471
/*
 * 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;
3472
	enum ref_transaction_state state;
3473 3474
};

3475
struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3476 3477 3478 3479
{
	return xcalloc(1, sizeof(struct ref_transaction));
}

3480
void ref_transaction_free(struct ref_transaction *transaction)
3481 3482 3483
{
	int i;

3484 3485 3486
	if (!transaction)
		return;

3487 3488
	for (i = 0; i < transaction->nr; i++) {
		free(transaction->updates[i]->msg);
3489
		free(transaction->updates[i]);
3490
	}
3491 3492 3493 3494 3495 3496 3497
	free(transaction->updates);
	free(transaction);
}

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

3501
	strcpy((char *)update->refname, refname);
3502 3503 3504 3505 3506
	ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
	transaction->updates[transaction->nr++] = update;
	return update;
}

3507 3508 3509 3510
int ref_transaction_update(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
			   const unsigned char *old_sha1,
3511
			   int flags, int have_old, const char *msg,
3512
			   struct strbuf *err)
3513
{
3514
	struct ref_update *update;
3515

3516 3517 3518
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: update called for transaction that is not open");

3519 3520
	if (have_old && !old_sha1)
		die("BUG: have_old is true but old_sha1 is NULL");
3521

3522
	update = add_update(transaction, refname);
3523 3524 3525 3526 3527
	hashcpy(update->new_sha1, new_sha1);
	update->flags = flags;
	update->have_old = have_old;
	if (have_old)
		hashcpy(update->old_sha1, old_sha1);
3528 3529
	if (msg)
		update->msg = xstrdup(msg);
3530
	return 0;
3531 3532
}

3533 3534 3535
int ref_transaction_create(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
3536
			   int flags, const char *msg,
3537
			   struct strbuf *err)
3538
{
3539 3540
	struct ref_update *update;

3541 3542 3543
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: create called for transaction that is not open");

3544 3545 3546 3547
	if (!new_sha1 || is_null_sha1(new_sha1))
		die("BUG: create ref with null new_sha1");

	update = add_update(transaction, refname);
3548 3549 3550 3551 3552

	hashcpy(update->new_sha1, new_sha1);
	hashclr(update->old_sha1);
	update->flags = flags;
	update->have_old = 1;
3553 3554
	if (msg)
		update->msg = xstrdup(msg);
3555
	return 0;
3556 3557
}

3558 3559 3560
int ref_transaction_delete(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *old_sha1,
3561
			   int flags, int have_old, const char *msg,
3562
			   struct strbuf *err)
3563
{
3564
	struct ref_update *update;
3565

3566 3567 3568
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: delete called for transaction that is not open");

3569 3570 3571 3572
	if (have_old && !old_sha1)
		die("BUG: have_old is true but old_sha1 is NULL");

	update = add_update(transaction, refname);
3573 3574 3575 3576 3577 3578
	update->flags = flags;
	update->have_old = have_old;
	if (have_old) {
		assert(!is_null_sha1(old_sha1));
		hashcpy(update->old_sha1, old_sha1);
	}
3579 3580
	if (msg)
		update->msg = xstrdup(msg);
3581
	return 0;
3582 3583
}

3584 3585 3586 3587
int update_ref(const char *action, const char *refname,
	       const unsigned char *sha1, const unsigned char *oldval,
	       int flags, enum action_on_err onerr)
{
3588 3589 3590 3591 3592 3593
	struct ref_transaction *t;
	struct strbuf err = STRBUF_INIT;

	t = ref_transaction_begin(&err);
	if (!t ||
	    ref_transaction_update(t, refname, sha1, oldval, flags,
3594 3595
				   !!oldval, action, &err) ||
	    ref_transaction_commit(t, &err)) {
3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609
		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);
3610
		return 1;
3611 3612 3613 3614
	}
	strbuf_release(&err);
	ref_transaction_free(t);
	return 0;
3615 3616
}

3617 3618 3619 3620
static int ref_update_compare(const void *r1, const void *r2)
{
	const struct ref_update * const *u1 = r1;
	const struct ref_update * const *u2 = r2;
3621
	return strcmp((*u1)->refname, (*u2)->refname);
3622 3623 3624
}

static int ref_update_reject_duplicates(struct ref_update **updates, int n,
3625
					struct strbuf *err)
3626 3627 3628
{
	int i;
	for (i = 1; i < n; i++)
3629
		if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {
3630 3631
			const char *str =
				"Multiple updates for ref '%s' not allowed.";
3632 3633 3634
			if (err)
				strbuf_addf(err, str, updates[i]->refname);

3635 3636 3637 3638 3639
			return 1;
		}
	return 0;
}

3640
int ref_transaction_commit(struct ref_transaction *transaction,
3641
			   struct strbuf *err)
3642 3643 3644
{
	int ret = 0, delnum = 0, i;
	const char **delnames;
3645
	int n = transaction->nr;
3646
	struct ref_update **updates = transaction->updates;
3647

3648 3649 3650 3651 3652
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: commit called for transaction that is not open");

	if (!n) {
		transaction->state = REF_TRANSACTION_CLOSED;
3653
		return 0;
3654
	}
3655 3656 3657 3658 3659 3660

	/* Allocate work space */
	delnames = xmalloc(sizeof(*delnames) * n);

	/* Copy, sort, and reject duplicate refs */
	qsort(updates, n, sizeof(*updates), ref_update_compare);
3661 3662
	if (ref_update_reject_duplicates(updates, n, err)) {
		ret = TRANSACTION_GENERIC_ERROR;
3663
		goto cleanup;
3664
	}
3665 3666 3667

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

3671 3672
		if (is_null_sha1(update->new_sha1))
			flags |= REF_DELETING;
3673 3674 3675 3676
		update->lock = lock_ref_sha1_basic(update->refname,
						   (update->have_old ?
						    update->old_sha1 :
						    NULL),
3677
						   NULL,
3678
						   flags,
3679
						   &update->type);
3680
		if (!update->lock) {
3681 3682 3683
			ret = (errno == ENOTDIR)
				? TRANSACTION_NAME_CONFLICT
				: TRANSACTION_GENERIC_ERROR;
3684 3685 3686
			if (err)
				strbuf_addf(err, "Cannot lock the ref '%s'.",
					    update->refname);
3687 3688 3689 3690 3691
			goto cleanup;
		}
	}

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

		if (!is_null_sha1(update->new_sha1)) {
3696 3697 3698
			if (write_ref_sha1(update->lock, update->new_sha1,
					   update->msg)) {
				update->lock = NULL; /* freed by write_ref_sha1 */
3699 3700 3701
				if (err)
					strbuf_addf(err, "Cannot update the ref '%s'.",
						    update->refname);
3702
				ret = TRANSACTION_GENERIC_ERROR;
3703
				goto cleanup;
3704
			}
3705
			update->lock = NULL; /* freed by write_ref_sha1 */
3706
		}
3707
	}
3708 3709

	/* Perform deletes now that updates are safely completed */
3710 3711 3712 3713
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];

		if (update->lock) {
3714 3715 3716
			if (delete_ref_loose(update->lock, update->type, err))
				ret = TRANSACTION_GENERIC_ERROR;

3717 3718
			if (!(update->flags & REF_ISPRUNING))
				delnames[delnum++] = update->lock->ref_name;
3719
		}
3720 3721
	}

3722 3723
	if (repack_without_refs(delnames, delnum, err))
		ret = TRANSACTION_GENERIC_ERROR;
3724 3725 3726 3727 3728
	for (i = 0; i < delnum; i++)
		unlink_or_warn(git_path("logs/%s", delnames[i]));
	clear_loose_ref_cache(&ref_cache);

cleanup:
3729 3730
	transaction->state = REF_TRANSACTION_CLOSED;

3731
	for (i = 0; i < n; i++)
3732 3733
		if (updates[i]->lock)
			unlock_ref(updates[i]->lock);
3734
	free(delnames);
3735 3736 3737
	return ret;
}

3738
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
3739 3740 3741 3742 3743 3744 3745
{
	int i;
	static char **scanf_fmts;
	static int nr_rules;
	char *short_name;

	if (!nr_rules) {
3746 3747 3748 3749 3750 3751
		/*
		 * 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 已提交
3752
		size_t total_len = 0;
3753
		size_t offset = 0;
J
Jeff King 已提交
3754 3755

		/* the rule list is NULL terminated, count them first */
J
Jeff King 已提交
3756
		for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
3757 3758
			/* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
			total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
J
Jeff King 已提交
3759 3760 3761

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

3762
		offset = 0;
J
Jeff King 已提交
3763
		for (i = 0; i < nr_rules; i++) {
3764
			assert(offset < total_len);
3765
			scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
3766 3767
			offset += snprintf(scanf_fmts[i], total_len - offset,
					   ref_rev_parse_rules[i], 2, "%s") + 1;
J
Jeff King 已提交
3768 3769 3770 3771 3772
		}
	}

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

3775 3776
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
3777 3778 3779 3780

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

3784
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
3785 3786 3787 3788
			continue;

		short_name_len = strlen(short_name);

3789 3790 3791 3792 3793 3794 3795
		/*
		 * 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 已提交
3796 3797 3798 3799
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
3800
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
3801 3802 3803
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

3804 3805 3806 3807
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
3808 3809 3810 3811 3812 3813 3814
			/*
			 * 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);
3815
			if (ref_exists(refname))
J
Jeff King 已提交
3816 3817 3818 3819 3820 3821 3822
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
3823
		if (j == rules_to_fail)
J
Jeff King 已提交
3824 3825 3826 3827
			return short_name;
	}

	free(short_name);
3828
	return xstrdup(refname);
J
Jeff King 已提交
3829
}
3830 3831 3832 3833 3834 3835 3836

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 */
3837
	    (starts_with(var, section) && var[strlen(section)] == '.' &&
3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864
	     !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;
3865
		if (!starts_with(refname, item->string))
3866 3867 3868 3869 3870 3871 3872
			continue;
		len = strlen(item->string);
		if (!refname[len] || refname[len] == '/')
			return 1;
	}
	return 0;
}