worktree: add_worktree: construct worktree-population command locally
[git/debian.git] / refs.c
blob5ed991bd92856bc8b2c5978923a118b8122a6eb5
1 #include "cache.h"
2 #include "lockfile.h"
3 #include "refs.h"
4 #include "object.h"
5 #include "tag.h"
6 #include "dir.h"
7 #include "string-list.h"
9 /*
10 * How to handle various characters in refnames:
11 * 0: An acceptable character for refs
12 * 1: End-of-component
13 * 2: ., look for a preceding . to reject .. in refs
14 * 3: {, look for a preceding @ to reject @{ in refs
15 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
17 static unsigned char refname_disposition[256] = {
18 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
19 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
20 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
21 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 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
24 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
25 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
29 * Used as a flag to ref_transaction_delete when a loose ref is being
30 * pruned.
32 #define REF_ISPRUNING 0x0100
34 * Try to read one refname component from the front of refname.
35 * Return the length of the component found, or -1 if the component is
36 * not legal. It is legal if it is something reasonable to have under
37 * ".git/refs/"; We do not like it if:
39 * - any path component of it begins with ".", or
40 * - it has double dots "..", or
41 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
42 * - it ends with a "/".
43 * - it ends with ".lock"
44 * - it contains a "\" (backslash)
46 static int check_refname_component(const char *refname, int flags)
48 const char *cp;
49 char last = '\0';
51 for (cp = refname; ; cp++) {
52 int ch = *cp & 255;
53 unsigned char disp = refname_disposition[ch];
54 switch (disp) {
55 case 1:
56 goto out;
57 case 2:
58 if (last == '.')
59 return -1; /* Refname contains "..". */
60 break;
61 case 3:
62 if (last == '@')
63 return -1; /* Refname contains "@{". */
64 break;
65 case 4:
66 return -1;
68 last = ch;
70 out:
71 if (cp == refname)
72 return 0; /* Component has zero length. */
73 if (refname[0] == '.')
74 return -1; /* Component starts with '.'. */
75 if (cp - refname >= LOCK_SUFFIX_LEN &&
76 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
77 return -1; /* Refname ends with ".lock". */
78 return cp - refname;
81 int check_refname_format(const char *refname, int flags)
83 int component_len, component_count = 0;
85 if (!strcmp(refname, "@"))
86 /* Refname is a single character '@'. */
87 return -1;
89 while (1) {
90 /* We are at the start of a path component. */
91 component_len = check_refname_component(refname, flags);
92 if (component_len <= 0) {
93 if ((flags & REFNAME_REFSPEC_PATTERN) &&
94 refname[0] == '*' &&
95 (refname[1] == '\0' || refname[1] == '/')) {
96 /* Accept one wildcard as a full refname component. */
97 flags &= ~REFNAME_REFSPEC_PATTERN;
98 component_len = 1;
99 } else {
100 return -1;
103 component_count++;
104 if (refname[component_len] == '\0')
105 break;
106 /* Skip to next component. */
107 refname += component_len + 1;
110 if (refname[component_len - 1] == '.')
111 return -1; /* Refname ends with '.'. */
112 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
113 return -1; /* Refname has only one component. */
114 return 0;
117 struct ref_entry;
120 * Information used (along with the information in ref_entry) to
121 * describe a single cached reference. This data structure only
122 * occurs embedded in a union in struct ref_entry, and only when
123 * (ref_entry->flag & REF_DIR) is zero.
125 struct ref_value {
127 * The name of the object to which this reference resolves
128 * (which may be a tag object). If REF_ISBROKEN, this is
129 * null. If REF_ISSYMREF, then this is the name of the object
130 * referred to by the last reference in the symlink chain.
132 unsigned char sha1[20];
135 * If REF_KNOWS_PEELED, then this field holds the peeled value
136 * of this reference, or null if the reference is known not to
137 * be peelable. See the documentation for peel_ref() for an
138 * exact definition of "peelable".
140 unsigned char peeled[20];
143 struct ref_cache;
146 * Information used (along with the information in ref_entry) to
147 * describe a level in the hierarchy of references. This data
148 * structure only occurs embedded in a union in struct ref_entry, and
149 * only when (ref_entry.flag & REF_DIR) is set. In that case,
150 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
151 * in the directory have already been read:
153 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
154 * or packed references, already read.
156 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
157 * references that hasn't been read yet (nor has any of its
158 * subdirectories).
160 * Entries within a directory are stored within a growable array of
161 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
162 * sorted are sorted by their component name in strcmp() order and the
163 * remaining entries are unsorted.
165 * Loose references are read lazily, one directory at a time. When a
166 * directory of loose references is read, then all of the references
167 * in that directory are stored, and REF_INCOMPLETE stubs are created
168 * for any subdirectories, but the subdirectories themselves are not
169 * read. The reading is triggered by get_ref_dir().
171 struct ref_dir {
172 int nr, alloc;
175 * Entries with index 0 <= i < sorted are sorted by name. New
176 * entries are appended to the list unsorted, and are sorted
177 * only when required; thus we avoid the need to sort the list
178 * after the addition of every reference.
180 int sorted;
182 /* A pointer to the ref_cache that contains this ref_dir. */
183 struct ref_cache *ref_cache;
185 struct ref_entry **entries;
189 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
190 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
191 * public values; see refs.h.
195 * The field ref_entry->u.value.peeled of this value entry contains
196 * the correct peeled value for the reference, which might be
197 * null_sha1 if the reference is not a tag or if it is broken.
199 #define REF_KNOWS_PEELED 0x10
201 /* ref_entry represents a directory of references */
202 #define REF_DIR 0x20
205 * Entry has not yet been read from disk (used only for REF_DIR
206 * entries representing loose references)
208 #define REF_INCOMPLETE 0x40
211 * A ref_entry represents either a reference or a "subdirectory" of
212 * references.
214 * Each directory in the reference namespace is represented by a
215 * ref_entry with (flags & REF_DIR) set and containing a subdir member
216 * that holds the entries in that directory that have been read so
217 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
218 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
219 * used for loose reference directories.
221 * References are represented by a ref_entry with (flags & REF_DIR)
222 * unset and a value member that describes the reference's value. The
223 * flag member is at the ref_entry level, but it is also needed to
224 * interpret the contents of the value field (in other words, a
225 * ref_value object is not very much use without the enclosing
226 * ref_entry).
228 * Reference names cannot end with slash and directories' names are
229 * always stored with a trailing slash (except for the top-level
230 * directory, which is always denoted by ""). This has two nice
231 * consequences: (1) when the entries in each subdir are sorted
232 * lexicographically by name (as they usually are), the references in
233 * a whole tree can be generated in lexicographic order by traversing
234 * the tree in left-to-right, depth-first order; (2) the names of
235 * references and subdirectories cannot conflict, and therefore the
236 * presence of an empty subdirectory does not block the creation of a
237 * similarly-named reference. (The fact that reference names with the
238 * same leading components can conflict *with each other* is a
239 * separate issue that is regulated by is_refname_available().)
241 * Please note that the name field contains the fully-qualified
242 * reference (or subdirectory) name. Space could be saved by only
243 * storing the relative names. But that would require the full names
244 * to be generated on the fly when iterating in do_for_each_ref(), and
245 * would break callback functions, who have always been able to assume
246 * that the name strings that they are passed will not be freed during
247 * the iteration.
249 struct ref_entry {
250 unsigned char flag; /* ISSYMREF? ISPACKED? */
251 union {
252 struct ref_value value; /* if not (flags&REF_DIR) */
253 struct ref_dir subdir; /* if (flags&REF_DIR) */
254 } u;
256 * The full name of the reference (e.g., "refs/heads/master")
257 * or the full name of the directory with a trailing slash
258 * (e.g., "refs/heads/"):
260 char name[FLEX_ARRAY];
263 static void read_loose_refs(const char *dirname, struct ref_dir *dir);
265 static struct ref_dir *get_ref_dir(struct ref_entry *entry)
267 struct ref_dir *dir;
268 assert(entry->flag & REF_DIR);
269 dir = &entry->u.subdir;
270 if (entry->flag & REF_INCOMPLETE) {
271 read_loose_refs(entry->name, dir);
272 entry->flag &= ~REF_INCOMPLETE;
274 return dir;
278 * Check if a refname is safe.
279 * For refs that start with "refs/" we consider it safe as long they do
280 * not try to resolve to outside of refs/.
282 * For all other refs we only consider them safe iff they only contain
283 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
284 * "config").
286 static int refname_is_safe(const char *refname)
288 if (starts_with(refname, "refs/")) {
289 char *buf;
290 int result;
292 buf = xmalloc(strlen(refname) + 1);
294 * Does the refname try to escape refs/?
295 * For example: refs/foo/../bar is safe but refs/foo/../../bar
296 * is not.
298 result = !normalize_path_copy(buf, refname + strlen("refs/"));
299 free(buf);
300 return result;
302 while (*refname) {
303 if (!isupper(*refname) && *refname != '_')
304 return 0;
305 refname++;
307 return 1;
310 static struct ref_entry *create_ref_entry(const char *refname,
311 const unsigned char *sha1, int flag,
312 int check_name)
314 int len;
315 struct ref_entry *ref;
317 if (check_name &&
318 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
319 die("Reference has invalid format: '%s'", refname);
320 if (!check_name && !refname_is_safe(refname))
321 die("Reference has invalid name: '%s'", refname);
322 len = strlen(refname) + 1;
323 ref = xmalloc(sizeof(struct ref_entry) + len);
324 hashcpy(ref->u.value.sha1, sha1);
325 hashclr(ref->u.value.peeled);
326 memcpy(ref->name, refname, len);
327 ref->flag = flag;
328 return ref;
331 static void clear_ref_dir(struct ref_dir *dir);
333 static void free_ref_entry(struct ref_entry *entry)
335 if (entry->flag & REF_DIR) {
337 * Do not use get_ref_dir() here, as that might
338 * trigger the reading of loose refs.
340 clear_ref_dir(&entry->u.subdir);
342 free(entry);
346 * Add a ref_entry to the end of dir (unsorted). Entry is always
347 * stored directly in dir; no recursion into subdirectories is
348 * done.
350 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
352 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
353 dir->entries[dir->nr++] = entry;
354 /* optimize for the case that entries are added in order */
355 if (dir->nr == 1 ||
356 (dir->nr == dir->sorted + 1 &&
357 strcmp(dir->entries[dir->nr - 2]->name,
358 dir->entries[dir->nr - 1]->name) < 0))
359 dir->sorted = dir->nr;
363 * Clear and free all entries in dir, recursively.
365 static void clear_ref_dir(struct ref_dir *dir)
367 int i;
368 for (i = 0; i < dir->nr; i++)
369 free_ref_entry(dir->entries[i]);
370 free(dir->entries);
371 dir->sorted = dir->nr = dir->alloc = 0;
372 dir->entries = NULL;
376 * Create a struct ref_entry object for the specified dirname.
377 * dirname is the name of the directory with a trailing slash (e.g.,
378 * "refs/heads/") or "" for the top-level directory.
380 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
381 const char *dirname, size_t len,
382 int incomplete)
384 struct ref_entry *direntry;
385 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
386 memcpy(direntry->name, dirname, len);
387 direntry->name[len] = '\0';
388 direntry->u.subdir.ref_cache = ref_cache;
389 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
390 return direntry;
393 static int ref_entry_cmp(const void *a, const void *b)
395 struct ref_entry *one = *(struct ref_entry **)a;
396 struct ref_entry *two = *(struct ref_entry **)b;
397 return strcmp(one->name, two->name);
400 static void sort_ref_dir(struct ref_dir *dir);
402 struct string_slice {
403 size_t len;
404 const char *str;
407 static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
409 const struct string_slice *key = key_;
410 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
411 int cmp = strncmp(key->str, ent->name, key->len);
412 if (cmp)
413 return cmp;
414 return '\0' - (unsigned char)ent->name[key->len];
418 * Return the index of the entry with the given refname from the
419 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
420 * no such entry is found. dir must already be complete.
422 static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
424 struct ref_entry **r;
425 struct string_slice key;
427 if (refname == NULL || !dir->nr)
428 return -1;
430 sort_ref_dir(dir);
431 key.len = len;
432 key.str = refname;
433 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
434 ref_entry_cmp_sslice);
436 if (r == NULL)
437 return -1;
439 return r - dir->entries;
443 * Search for a directory entry directly within dir (without
444 * recursing). Sort dir if necessary. subdirname must be a directory
445 * name (i.e., end in '/'). If mkdir is set, then create the
446 * directory if it is missing; otherwise, return NULL if the desired
447 * directory cannot be found. dir must already be complete.
449 static struct ref_dir *search_for_subdir(struct ref_dir *dir,
450 const char *subdirname, size_t len,
451 int mkdir)
453 int entry_index = search_ref_dir(dir, subdirname, len);
454 struct ref_entry *entry;
455 if (entry_index == -1) {
456 if (!mkdir)
457 return NULL;
459 * Since dir is complete, the absence of a subdir
460 * means that the subdir really doesn't exist;
461 * therefore, create an empty record for it but mark
462 * the record complete.
464 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
465 add_entry_to_dir(dir, entry);
466 } else {
467 entry = dir->entries[entry_index];
469 return get_ref_dir(entry);
473 * If refname is a reference name, find the ref_dir within the dir
474 * tree that should hold refname. If refname is a directory name
475 * (i.e., ends in '/'), then return that ref_dir itself. dir must
476 * represent the top-level directory and must already be complete.
477 * Sort ref_dirs and recurse into subdirectories as necessary. If
478 * mkdir is set, then create any missing directories; otherwise,
479 * return NULL if the desired directory cannot be found.
481 static struct ref_dir *find_containing_dir(struct ref_dir *dir,
482 const char *refname, int mkdir)
484 const char *slash;
485 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
486 size_t dirnamelen = slash - refname + 1;
487 struct ref_dir *subdir;
488 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
489 if (!subdir) {
490 dir = NULL;
491 break;
493 dir = subdir;
496 return dir;
500 * Find the value entry with the given name in dir, sorting ref_dirs
501 * and recursing into subdirectories as necessary. If the name is not
502 * found or it corresponds to a directory entry, return NULL.
504 static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
506 int entry_index;
507 struct ref_entry *entry;
508 dir = find_containing_dir(dir, refname, 0);
509 if (!dir)
510 return NULL;
511 entry_index = search_ref_dir(dir, refname, strlen(refname));
512 if (entry_index == -1)
513 return NULL;
514 entry = dir->entries[entry_index];
515 return (entry->flag & REF_DIR) ? NULL : entry;
519 * Remove the entry with the given name from dir, recursing into
520 * subdirectories as necessary. If refname is the name of a directory
521 * (i.e., ends with '/'), then remove the directory and its contents.
522 * If the removal was successful, return the number of entries
523 * remaining in the directory entry that contained the deleted entry.
524 * If the name was not found, return -1. Please note that this
525 * function only deletes the entry from the cache; it does not delete
526 * it from the filesystem or ensure that other cache entries (which
527 * might be symbolic references to the removed entry) are updated.
528 * Nor does it remove any containing dir entries that might be made
529 * empty by the removal. dir must represent the top-level directory
530 * and must already be complete.
532 static int remove_entry(struct ref_dir *dir, const char *refname)
534 int refname_len = strlen(refname);
535 int entry_index;
536 struct ref_entry *entry;
537 int is_dir = refname[refname_len - 1] == '/';
538 if (is_dir) {
540 * refname represents a reference directory. Remove
541 * the trailing slash; otherwise we will get the
542 * directory *representing* refname rather than the
543 * one *containing* it.
545 char *dirname = xmemdupz(refname, refname_len - 1);
546 dir = find_containing_dir(dir, dirname, 0);
547 free(dirname);
548 } else {
549 dir = find_containing_dir(dir, refname, 0);
551 if (!dir)
552 return -1;
553 entry_index = search_ref_dir(dir, refname, refname_len);
554 if (entry_index == -1)
555 return -1;
556 entry = dir->entries[entry_index];
558 memmove(&dir->entries[entry_index],
559 &dir->entries[entry_index + 1],
560 (dir->nr - entry_index - 1) * sizeof(*dir->entries)
562 dir->nr--;
563 if (dir->sorted > entry_index)
564 dir->sorted--;
565 free_ref_entry(entry);
566 return dir->nr;
570 * Add a ref_entry to the ref_dir (unsorted), recursing into
571 * subdirectories as necessary. dir must represent the top-level
572 * directory. Return 0 on success.
574 static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
576 dir = find_containing_dir(dir, ref->name, 1);
577 if (!dir)
578 return -1;
579 add_entry_to_dir(dir, ref);
580 return 0;
584 * Emit a warning and return true iff ref1 and ref2 have the same name
585 * and the same sha1. Die if they have the same name but different
586 * sha1s.
588 static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
590 if (strcmp(ref1->name, ref2->name))
591 return 0;
593 /* Duplicate name; make sure that they don't conflict: */
595 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
596 /* This is impossible by construction */
597 die("Reference directory conflict: %s", ref1->name);
599 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
600 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
602 warning("Duplicated ref: %s", ref1->name);
603 return 1;
607 * Sort the entries in dir non-recursively (if they are not already
608 * sorted) and remove any duplicate entries.
610 static void sort_ref_dir(struct ref_dir *dir)
612 int i, j;
613 struct ref_entry *last = NULL;
616 * This check also prevents passing a zero-length array to qsort(),
617 * which is a problem on some platforms.
619 if (dir->sorted == dir->nr)
620 return;
622 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
624 /* Remove any duplicates: */
625 for (i = 0, j = 0; j < dir->nr; j++) {
626 struct ref_entry *entry = dir->entries[j];
627 if (last && is_dup_ref(last, entry))
628 free_ref_entry(entry);
629 else
630 last = dir->entries[i++] = entry;
632 dir->sorted = dir->nr = i;
635 /* Include broken references in a do_for_each_ref*() iteration: */
636 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
639 * Return true iff the reference described by entry can be resolved to
640 * an object in the database. Emit a warning if the referred-to
641 * object does not exist.
643 static int ref_resolves_to_object(struct ref_entry *entry)
645 if (entry->flag & REF_ISBROKEN)
646 return 0;
647 if (!has_sha1_file(entry->u.value.sha1)) {
648 error("%s does not point to a valid object!", entry->name);
649 return 0;
651 return 1;
655 * current_ref is a performance hack: when iterating over references
656 * using the for_each_ref*() functions, current_ref is set to the
657 * current reference's entry before calling the callback function. If
658 * the callback function calls peel_ref(), then peel_ref() first
659 * checks whether the reference to be peeled is the current reference
660 * (it usually is) and if so, returns that reference's peeled version
661 * if it is available. This avoids a refname lookup in a common case.
663 static struct ref_entry *current_ref;
665 typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);
667 struct ref_entry_cb {
668 const char *base;
669 int trim;
670 int flags;
671 each_ref_fn *fn;
672 void *cb_data;
676 * Handle one reference in a do_for_each_ref*()-style iteration,
677 * calling an each_ref_fn for each entry.
679 static int do_one_ref(struct ref_entry *entry, void *cb_data)
681 struct ref_entry_cb *data = cb_data;
682 struct ref_entry *old_current_ref;
683 int retval;
685 if (!starts_with(entry->name, data->base))
686 return 0;
688 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
689 !ref_resolves_to_object(entry))
690 return 0;
692 /* Store the old value, in case this is a recursive call: */
693 old_current_ref = current_ref;
694 current_ref = entry;
695 retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
696 entry->flag, data->cb_data);
697 current_ref = old_current_ref;
698 return retval;
702 * Call fn for each reference in dir that has index in the range
703 * offset <= index < dir->nr. Recurse into subdirectories that are in
704 * that index range, sorting them before iterating. This function
705 * does not sort dir itself; it should be sorted beforehand. fn is
706 * called for all references, including broken ones.
708 static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
709 each_ref_entry_fn fn, void *cb_data)
711 int i;
712 assert(dir->sorted == dir->nr);
713 for (i = offset; i < dir->nr; i++) {
714 struct ref_entry *entry = dir->entries[i];
715 int retval;
716 if (entry->flag & REF_DIR) {
717 struct ref_dir *subdir = get_ref_dir(entry);
718 sort_ref_dir(subdir);
719 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
720 } else {
721 retval = fn(entry, cb_data);
723 if (retval)
724 return retval;
726 return 0;
730 * Call fn for each reference in the union of dir1 and dir2, in order
731 * by refname. Recurse into subdirectories. If a value entry appears
732 * in both dir1 and dir2, then only process the version that is in
733 * dir2. The input dirs must already be sorted, but subdirs will be
734 * sorted as needed. fn is called for all references, including
735 * broken ones.
737 static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
738 struct ref_dir *dir2,
739 each_ref_entry_fn fn, void *cb_data)
741 int retval;
742 int i1 = 0, i2 = 0;
744 assert(dir1->sorted == dir1->nr);
745 assert(dir2->sorted == dir2->nr);
746 while (1) {
747 struct ref_entry *e1, *e2;
748 int cmp;
749 if (i1 == dir1->nr) {
750 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
752 if (i2 == dir2->nr) {
753 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
755 e1 = dir1->entries[i1];
756 e2 = dir2->entries[i2];
757 cmp = strcmp(e1->name, e2->name);
758 if (cmp == 0) {
759 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
760 /* Both are directories; descend them in parallel. */
761 struct ref_dir *subdir1 = get_ref_dir(e1);
762 struct ref_dir *subdir2 = get_ref_dir(e2);
763 sort_ref_dir(subdir1);
764 sort_ref_dir(subdir2);
765 retval = do_for_each_entry_in_dirs(
766 subdir1, subdir2, fn, cb_data);
767 i1++;
768 i2++;
769 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
770 /* Both are references; ignore the one from dir1. */
771 retval = fn(e2, cb_data);
772 i1++;
773 i2++;
774 } else {
775 die("conflict between reference and directory: %s",
776 e1->name);
778 } else {
779 struct ref_entry *e;
780 if (cmp < 0) {
781 e = e1;
782 i1++;
783 } else {
784 e = e2;
785 i2++;
787 if (e->flag & REF_DIR) {
788 struct ref_dir *subdir = get_ref_dir(e);
789 sort_ref_dir(subdir);
790 retval = do_for_each_entry_in_dir(
791 subdir, 0, fn, cb_data);
792 } else {
793 retval = fn(e, cb_data);
796 if (retval)
797 return retval;
802 * Load all of the refs from the dir into our in-memory cache. The hard work
803 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
804 * through all of the sub-directories. We do not even need to care about
805 * sorting, as traversal order does not matter to us.
807 static void prime_ref_dir(struct ref_dir *dir)
809 int i;
810 for (i = 0; i < dir->nr; i++) {
811 struct ref_entry *entry = dir->entries[i];
812 if (entry->flag & REF_DIR)
813 prime_ref_dir(get_ref_dir(entry));
817 static int entry_matches(struct ref_entry *entry, const struct string_list *list)
819 return list && string_list_has_string(list, entry->name);
822 struct nonmatching_ref_data {
823 const struct string_list *skip;
824 struct ref_entry *found;
827 static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata)
829 struct nonmatching_ref_data *data = vdata;
831 if (entry_matches(entry, data->skip))
832 return 0;
834 data->found = entry;
835 return 1;
838 static void report_refname_conflict(struct ref_entry *entry,
839 const char *refname)
841 error("'%s' exists; cannot create '%s'", entry->name, refname);
845 * Return true iff a reference named refname could be created without
846 * conflicting with the name of an existing reference in dir. If
847 * skip is non-NULL, ignore potential conflicts with refs in skip
848 * (e.g., because they are scheduled for deletion in the same
849 * operation).
851 * Two reference names conflict if one of them exactly matches the
852 * leading components of the other; e.g., "foo/bar" conflicts with
853 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
854 * "foo/barbados".
856 * skip must be sorted.
858 static int is_refname_available(const char *refname,
859 const struct string_list *skip,
860 struct ref_dir *dir)
862 const char *slash;
863 size_t len;
864 int pos;
865 char *dirname;
867 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
869 * We are still at a leading dir of the refname; we are
870 * looking for a conflict with a leaf entry.
872 * If we find one, we still must make sure it is
873 * not in "skip".
875 pos = search_ref_dir(dir, refname, slash - refname);
876 if (pos >= 0) {
877 struct ref_entry *entry = dir->entries[pos];
878 if (entry_matches(entry, skip))
879 return 1;
880 report_refname_conflict(entry, refname);
881 return 0;
886 * Otherwise, we can try to continue our search with
887 * the next component; if we come up empty, we know
888 * there is nothing under this whole prefix.
890 pos = search_ref_dir(dir, refname, slash + 1 - refname);
891 if (pos < 0)
892 return 1;
894 dir = get_ref_dir(dir->entries[pos]);
898 * We are at the leaf of our refname; we want to
899 * make sure there are no directories which match it.
901 len = strlen(refname);
902 dirname = xmallocz(len + 1);
903 sprintf(dirname, "%s/", refname);
904 pos = search_ref_dir(dir, dirname, len + 1);
905 free(dirname);
907 if (pos >= 0) {
909 * We found a directory named "refname". It is a
910 * problem iff it contains any ref that is not
911 * in "skip".
913 struct ref_entry *entry = dir->entries[pos];
914 struct ref_dir *dir = get_ref_dir(entry);
915 struct nonmatching_ref_data data;
917 data.skip = skip;
918 sort_ref_dir(dir);
919 if (!do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data))
920 return 1;
922 report_refname_conflict(data.found, refname);
923 return 0;
927 * There is no point in searching for another leaf
928 * node which matches it; such an entry would be the
929 * ref we are looking for, not a conflict.
931 return 1;
934 struct packed_ref_cache {
935 struct ref_entry *root;
938 * Count of references to the data structure in this instance,
939 * including the pointer from ref_cache::packed if any. The
940 * data will not be freed as long as the reference count is
941 * nonzero.
943 unsigned int referrers;
946 * Iff the packed-refs file associated with this instance is
947 * currently locked for writing, this points at the associated
948 * lock (which is owned by somebody else). The referrer count
949 * is also incremented when the file is locked and decremented
950 * when it is unlocked.
952 struct lock_file *lock;
954 /* The metadata from when this packed-refs cache was read */
955 struct stat_validity validity;
959 * Future: need to be in "struct repository"
960 * when doing a full libification.
962 static struct ref_cache {
963 struct ref_cache *next;
964 struct ref_entry *loose;
965 struct packed_ref_cache *packed;
967 * The submodule name, or "" for the main repo. We allocate
968 * length 1 rather than FLEX_ARRAY so that the main ref_cache
969 * is initialized correctly.
971 char name[1];
972 } ref_cache, *submodule_ref_caches;
974 /* Lock used for the main packed-refs file: */
975 static struct lock_file packlock;
978 * Increment the reference count of *packed_refs.
980 static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
982 packed_refs->referrers++;
986 * Decrease the reference count of *packed_refs. If it goes to zero,
987 * free *packed_refs and return true; otherwise return false.
989 static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
991 if (!--packed_refs->referrers) {
992 free_ref_entry(packed_refs->root);
993 stat_validity_clear(&packed_refs->validity);
994 free(packed_refs);
995 return 1;
996 } else {
997 return 0;
1001 static void clear_packed_ref_cache(struct ref_cache *refs)
1003 if (refs->packed) {
1004 struct packed_ref_cache *packed_refs = refs->packed;
1006 if (packed_refs->lock)
1007 die("internal error: packed-ref cache cleared while locked");
1008 refs->packed = NULL;
1009 release_packed_ref_cache(packed_refs);
1013 static void clear_loose_ref_cache(struct ref_cache *refs)
1015 if (refs->loose) {
1016 free_ref_entry(refs->loose);
1017 refs->loose = NULL;
1021 static struct ref_cache *create_ref_cache(const char *submodule)
1023 int len;
1024 struct ref_cache *refs;
1025 if (!submodule)
1026 submodule = "";
1027 len = strlen(submodule) + 1;
1028 refs = xcalloc(1, sizeof(struct ref_cache) + len);
1029 memcpy(refs->name, submodule, len);
1030 return refs;
1034 * Return a pointer to a ref_cache for the specified submodule. For
1035 * the main repository, use submodule==NULL. The returned structure
1036 * will be allocated and initialized but not necessarily populated; it
1037 * should not be freed.
1039 static struct ref_cache *get_ref_cache(const char *submodule)
1041 struct ref_cache *refs;
1043 if (!submodule || !*submodule)
1044 return &ref_cache;
1046 for (refs = submodule_ref_caches; refs; refs = refs->next)
1047 if (!strcmp(submodule, refs->name))
1048 return refs;
1050 refs = create_ref_cache(submodule);
1051 refs->next = submodule_ref_caches;
1052 submodule_ref_caches = refs;
1053 return refs;
1056 /* The length of a peeled reference line in packed-refs, including EOL: */
1057 #define PEELED_LINE_LENGTH 42
1060 * The packed-refs header line that we write out. Perhaps other
1061 * traits will be added later. The trailing space is required.
1063 static const char PACKED_REFS_HEADER[] =
1064 "# pack-refs with: peeled fully-peeled \n";
1067 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1068 * Return a pointer to the refname within the line (null-terminated),
1069 * or NULL if there was a problem.
1071 static const char *parse_ref_line(char *line, unsigned char *sha1)
1074 * 42: the answer to everything.
1076 * In this case, it happens to be the answer to
1077 * 40 (length of sha1 hex representation)
1078 * +1 (space in between hex and name)
1079 * +1 (newline at the end of the line)
1081 int len = strlen(line) - 42;
1083 if (len <= 0)
1084 return NULL;
1085 if (get_sha1_hex(line, sha1) < 0)
1086 return NULL;
1087 if (!isspace(line[40]))
1088 return NULL;
1089 line += 41;
1090 if (isspace(*line))
1091 return NULL;
1092 if (line[len] != '\n')
1093 return NULL;
1094 line[len] = 0;
1096 return line;
1100 * Read f, which is a packed-refs file, into dir.
1102 * A comment line of the form "# pack-refs with: " may contain zero or
1103 * more traits. We interpret the traits as follows:
1105 * No traits:
1107 * Probably no references are peeled. But if the file contains a
1108 * peeled value for a reference, we will use it.
1110 * peeled:
1112 * References under "refs/tags/", if they *can* be peeled, *are*
1113 * peeled in this file. References outside of "refs/tags/" are
1114 * probably not peeled even if they could have been, but if we find
1115 * a peeled value for such a reference we will use it.
1117 * fully-peeled:
1119 * All references in the file that can be peeled are peeled.
1120 * Inversely (and this is more important), any references in the
1121 * file for which no peeled value is recorded is not peelable. This
1122 * trait should typically be written alongside "peeled" for
1123 * compatibility with older clients, but we do not require it
1124 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1126 static void read_packed_refs(FILE *f, struct ref_dir *dir)
1128 struct ref_entry *last = NULL;
1129 char refline[PATH_MAX];
1130 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1132 while (fgets(refline, sizeof(refline), f)) {
1133 unsigned char sha1[20];
1134 const char *refname;
1135 static const char header[] = "# pack-refs with:";
1137 if (!strncmp(refline, header, sizeof(header)-1)) {
1138 const char *traits = refline + sizeof(header) - 1;
1139 if (strstr(traits, " fully-peeled "))
1140 peeled = PEELED_FULLY;
1141 else if (strstr(traits, " peeled "))
1142 peeled = PEELED_TAGS;
1143 /* perhaps other traits later as well */
1144 continue;
1147 refname = parse_ref_line(refline, sha1);
1148 if (refname) {
1149 int flag = REF_ISPACKED;
1151 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1152 hashclr(sha1);
1153 flag |= REF_BAD_NAME | REF_ISBROKEN;
1155 last = create_ref_entry(refname, sha1, flag, 0);
1156 if (peeled == PEELED_FULLY ||
1157 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1158 last->flag |= REF_KNOWS_PEELED;
1159 add_ref(dir, last);
1160 continue;
1162 if (last &&
1163 refline[0] == '^' &&
1164 strlen(refline) == PEELED_LINE_LENGTH &&
1165 refline[PEELED_LINE_LENGTH - 1] == '\n' &&
1166 !get_sha1_hex(refline + 1, sha1)) {
1167 hashcpy(last->u.value.peeled, sha1);
1169 * Regardless of what the file header said,
1170 * we definitely know the value of *this*
1171 * reference:
1173 last->flag |= REF_KNOWS_PEELED;
1179 * Get the packed_ref_cache for the specified ref_cache, creating it
1180 * if necessary.
1182 static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1184 const char *packed_refs_file;
1186 if (*refs->name)
1187 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
1188 else
1189 packed_refs_file = git_path("packed-refs");
1191 if (refs->packed &&
1192 !stat_validity_check(&refs->packed->validity, packed_refs_file))
1193 clear_packed_ref_cache(refs);
1195 if (!refs->packed) {
1196 FILE *f;
1198 refs->packed = xcalloc(1, sizeof(*refs->packed));
1199 acquire_packed_ref_cache(refs->packed);
1200 refs->packed->root = create_dir_entry(refs, "", 0, 0);
1201 f = fopen(packed_refs_file, "r");
1202 if (f) {
1203 stat_validity_update(&refs->packed->validity, fileno(f));
1204 read_packed_refs(f, get_ref_dir(refs->packed->root));
1205 fclose(f);
1208 return refs->packed;
1211 static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1213 return get_ref_dir(packed_ref_cache->root);
1216 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1218 return get_packed_ref_dir(get_packed_ref_cache(refs));
1221 void add_packed_ref(const char *refname, const unsigned char *sha1)
1223 struct packed_ref_cache *packed_ref_cache =
1224 get_packed_ref_cache(&ref_cache);
1226 if (!packed_ref_cache->lock)
1227 die("internal error: packed refs not locked");
1228 add_ref(get_packed_ref_dir(packed_ref_cache),
1229 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1233 * Read the loose references from the namespace dirname into dir
1234 * (without recursing). dirname must end with '/'. dir must be the
1235 * directory entry corresponding to dirname.
1237 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1239 struct ref_cache *refs = dir->ref_cache;
1240 DIR *d;
1241 const char *path;
1242 struct dirent *de;
1243 int dirnamelen = strlen(dirname);
1244 struct strbuf refname;
1246 if (*refs->name)
1247 path = git_path_submodule(refs->name, "%s", dirname);
1248 else
1249 path = git_path("%s", dirname);
1251 d = opendir(path);
1252 if (!d)
1253 return;
1255 strbuf_init(&refname, dirnamelen + 257);
1256 strbuf_add(&refname, dirname, dirnamelen);
1258 while ((de = readdir(d)) != NULL) {
1259 unsigned char sha1[20];
1260 struct stat st;
1261 int flag;
1262 const char *refdir;
1264 if (de->d_name[0] == '.')
1265 continue;
1266 if (ends_with(de->d_name, ".lock"))
1267 continue;
1268 strbuf_addstr(&refname, de->d_name);
1269 refdir = *refs->name
1270 ? git_path_submodule(refs->name, "%s", refname.buf)
1271 : git_path("%s", refname.buf);
1272 if (stat(refdir, &st) < 0) {
1273 ; /* silently ignore */
1274 } else if (S_ISDIR(st.st_mode)) {
1275 strbuf_addch(&refname, '/');
1276 add_entry_to_dir(dir,
1277 create_dir_entry(refs, refname.buf,
1278 refname.len, 1));
1279 } else {
1280 if (*refs->name) {
1281 hashclr(sha1);
1282 flag = 0;
1283 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1284 hashclr(sha1);
1285 flag |= REF_ISBROKEN;
1287 } else if (read_ref_full(refname.buf,
1288 RESOLVE_REF_READING,
1289 sha1, &flag)) {
1290 hashclr(sha1);
1291 flag |= REF_ISBROKEN;
1293 if (check_refname_format(refname.buf,
1294 REFNAME_ALLOW_ONELEVEL)) {
1295 hashclr(sha1);
1296 flag |= REF_BAD_NAME | REF_ISBROKEN;
1298 add_entry_to_dir(dir,
1299 create_ref_entry(refname.buf, sha1, flag, 0));
1301 strbuf_setlen(&refname, dirnamelen);
1303 strbuf_release(&refname);
1304 closedir(d);
1307 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1309 if (!refs->loose) {
1311 * Mark the top-level directory complete because we
1312 * are about to read the only subdirectory that can
1313 * hold references:
1315 refs->loose = create_dir_entry(refs, "", 0, 0);
1317 * Create an incomplete entry for "refs/":
1319 add_entry_to_dir(get_ref_dir(refs->loose),
1320 create_dir_entry(refs, "refs/", 5, 1));
1322 return get_ref_dir(refs->loose);
1325 /* We allow "recursive" symbolic refs. Only within reason, though */
1326 #define MAXDEPTH 5
1327 #define MAXREFLEN (1024)
1330 * Called by resolve_gitlink_ref_recursive() after it failed to read
1331 * from the loose refs in ref_cache refs. Find <refname> in the
1332 * packed-refs file for the submodule.
1334 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1335 const char *refname, unsigned char *sha1)
1337 struct ref_entry *ref;
1338 struct ref_dir *dir = get_packed_refs(refs);
1340 ref = find_ref(dir, refname);
1341 if (ref == NULL)
1342 return -1;
1344 hashcpy(sha1, ref->u.value.sha1);
1345 return 0;
1348 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1349 const char *refname, unsigned char *sha1,
1350 int recursion)
1352 int fd, len;
1353 char buffer[128], *p;
1354 const char *path;
1356 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1357 return -1;
1358 path = *refs->name
1359 ? git_path_submodule(refs->name, "%s", refname)
1360 : git_path("%s", refname);
1361 fd = open(path, O_RDONLY);
1362 if (fd < 0)
1363 return resolve_gitlink_packed_ref(refs, refname, sha1);
1365 len = read(fd, buffer, sizeof(buffer)-1);
1366 close(fd);
1367 if (len < 0)
1368 return -1;
1369 while (len && isspace(buffer[len-1]))
1370 len--;
1371 buffer[len] = 0;
1373 /* Was it a detached head or an old-fashioned symlink? */
1374 if (!get_sha1_hex(buffer, sha1))
1375 return 0;
1377 /* Symref? */
1378 if (strncmp(buffer, "ref:", 4))
1379 return -1;
1380 p = buffer + 4;
1381 while (isspace(*p))
1382 p++;
1384 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1387 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1389 int len = strlen(path), retval;
1390 char *submodule;
1391 struct ref_cache *refs;
1393 while (len && path[len-1] == '/')
1394 len--;
1395 if (!len)
1396 return -1;
1397 submodule = xstrndup(path, len);
1398 refs = get_ref_cache(submodule);
1399 free(submodule);
1401 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1402 return retval;
1406 * Return the ref_entry for the given refname from the packed
1407 * references. If it does not exist, return NULL.
1409 static struct ref_entry *get_packed_ref(const char *refname)
1411 return find_ref(get_packed_refs(&ref_cache), refname);
1415 * A loose ref file doesn't exist; check for a packed ref. The
1416 * options are forwarded from resolve_safe_unsafe().
1418 static int resolve_missing_loose_ref(const char *refname,
1419 int resolve_flags,
1420 unsigned char *sha1,
1421 int *flags)
1423 struct ref_entry *entry;
1426 * The loose reference file does not exist; check for a packed
1427 * reference.
1429 entry = get_packed_ref(refname);
1430 if (entry) {
1431 hashcpy(sha1, entry->u.value.sha1);
1432 if (flags)
1433 *flags |= REF_ISPACKED;
1434 return 0;
1436 /* The reference is not a packed reference, either. */
1437 if (resolve_flags & RESOLVE_REF_READING) {
1438 errno = ENOENT;
1439 return -1;
1440 } else {
1441 hashclr(sha1);
1442 return 0;
1446 /* This function needs to return a meaningful errno on failure */
1447 static const char *resolve_ref_unsafe_1(const char *refname,
1448 int resolve_flags,
1449 unsigned char *sha1,
1450 int *flags,
1451 struct strbuf *sb_path)
1453 int depth = MAXDEPTH;
1454 ssize_t len;
1455 char buffer[256];
1456 static char refname_buffer[256];
1457 int bad_name = 0;
1459 if (flags)
1460 *flags = 0;
1462 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1463 if (flags)
1464 *flags |= REF_BAD_NAME;
1466 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1467 !refname_is_safe(refname)) {
1468 errno = EINVAL;
1469 return NULL;
1472 * dwim_ref() uses REF_ISBROKEN to distinguish between
1473 * missing refs and refs that were present but invalid,
1474 * to complain about the latter to stderr.
1476 * We don't know whether the ref exists, so don't set
1477 * REF_ISBROKEN yet.
1479 bad_name = 1;
1481 for (;;) {
1482 const char *path;
1483 struct stat st;
1484 char *buf;
1485 int fd;
1487 if (--depth < 0) {
1488 errno = ELOOP;
1489 return NULL;
1492 strbuf_reset(sb_path);
1493 strbuf_git_path(sb_path, "%s", refname);
1494 path = sb_path->buf;
1497 * We might have to loop back here to avoid a race
1498 * condition: first we lstat() the file, then we try
1499 * to read it as a link or as a file. But if somebody
1500 * changes the type of the file (file <-> directory
1501 * <-> symlink) between the lstat() and reading, then
1502 * we don't want to report that as an error but rather
1503 * try again starting with the lstat().
1505 stat_ref:
1506 if (lstat(path, &st) < 0) {
1507 if (errno != ENOENT)
1508 return NULL;
1509 if (resolve_missing_loose_ref(refname, resolve_flags,
1510 sha1, flags))
1511 return NULL;
1512 if (bad_name) {
1513 hashclr(sha1);
1514 if (flags)
1515 *flags |= REF_ISBROKEN;
1517 return refname;
1520 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1521 if (S_ISLNK(st.st_mode)) {
1522 len = readlink(path, buffer, sizeof(buffer)-1);
1523 if (len < 0) {
1524 if (errno == ENOENT || errno == EINVAL)
1525 /* inconsistent with lstat; retry */
1526 goto stat_ref;
1527 else
1528 return NULL;
1530 buffer[len] = 0;
1531 if (starts_with(buffer, "refs/") &&
1532 !check_refname_format(buffer, 0)) {
1533 strcpy(refname_buffer, buffer);
1534 refname = refname_buffer;
1535 if (flags)
1536 *flags |= REF_ISSYMREF;
1537 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1538 hashclr(sha1);
1539 return refname;
1541 continue;
1545 /* Is it a directory? */
1546 if (S_ISDIR(st.st_mode)) {
1547 errno = EISDIR;
1548 return NULL;
1552 * Anything else, just open it and try to use it as
1553 * a ref
1555 fd = open(path, O_RDONLY);
1556 if (fd < 0) {
1557 if (errno == ENOENT)
1558 /* inconsistent with lstat; retry */
1559 goto stat_ref;
1560 else
1561 return NULL;
1563 len = read_in_full(fd, buffer, sizeof(buffer)-1);
1564 if (len < 0) {
1565 int save_errno = errno;
1566 close(fd);
1567 errno = save_errno;
1568 return NULL;
1570 close(fd);
1571 while (len && isspace(buffer[len-1]))
1572 len--;
1573 buffer[len] = '\0';
1576 * Is it a symbolic ref?
1578 if (!starts_with(buffer, "ref:")) {
1580 * Please note that FETCH_HEAD has a second
1581 * line containing other data.
1583 if (get_sha1_hex(buffer, sha1) ||
1584 (buffer[40] != '\0' && !isspace(buffer[40]))) {
1585 if (flags)
1586 *flags |= REF_ISBROKEN;
1587 errno = EINVAL;
1588 return NULL;
1590 if (bad_name) {
1591 hashclr(sha1);
1592 if (flags)
1593 *flags |= REF_ISBROKEN;
1595 return refname;
1597 if (flags)
1598 *flags |= REF_ISSYMREF;
1599 buf = buffer + 4;
1600 while (isspace(*buf))
1601 buf++;
1602 refname = strcpy(refname_buffer, buf);
1603 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1604 hashclr(sha1);
1605 return refname;
1607 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1608 if (flags)
1609 *flags |= REF_ISBROKEN;
1611 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1612 !refname_is_safe(buf)) {
1613 errno = EINVAL;
1614 return NULL;
1616 bad_name = 1;
1621 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1622 unsigned char *sha1, int *flags)
1624 struct strbuf sb_path = STRBUF_INIT;
1625 const char *ret = resolve_ref_unsafe_1(refname, resolve_flags,
1626 sha1, flags, &sb_path);
1627 strbuf_release(&sb_path);
1628 return ret;
1631 char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)
1633 const char *ret = resolve_ref_unsafe(ref, resolve_flags, sha1, flags);
1634 return ret ? xstrdup(ret) : NULL;
1637 /* The argument to filter_refs */
1638 struct ref_filter {
1639 const char *pattern;
1640 each_ref_fn *fn;
1641 void *cb_data;
1644 int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1646 if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
1647 return 0;
1648 return -1;
1651 int read_ref(const char *refname, unsigned char *sha1)
1653 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
1656 int ref_exists(const char *refname)
1658 unsigned char sha1[20];
1659 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
1662 static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1663 void *data)
1665 struct ref_filter *filter = (struct ref_filter *)data;
1666 if (wildmatch(filter->pattern, refname, 0, NULL))
1667 return 0;
1668 return filter->fn(refname, sha1, flags, filter->cb_data);
1671 enum peel_status {
1672 /* object was peeled successfully: */
1673 PEEL_PEELED = 0,
1676 * object cannot be peeled because the named object (or an
1677 * object referred to by a tag in the peel chain), does not
1678 * exist.
1680 PEEL_INVALID = -1,
1682 /* object cannot be peeled because it is not a tag: */
1683 PEEL_NON_TAG = -2,
1685 /* ref_entry contains no peeled value because it is a symref: */
1686 PEEL_IS_SYMREF = -3,
1689 * ref_entry cannot be peeled because it is broken (i.e., the
1690 * symbolic reference cannot even be resolved to an object
1691 * name):
1693 PEEL_BROKEN = -4
1697 * Peel the named object; i.e., if the object is a tag, resolve the
1698 * tag recursively until a non-tag is found. If successful, store the
1699 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1700 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1701 * and leave sha1 unchanged.
1703 static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1705 struct object *o = lookup_unknown_object(name);
1707 if (o->type == OBJ_NONE) {
1708 int type = sha1_object_info(name, NULL);
1709 if (type < 0 || !object_as_type(o, type, 0))
1710 return PEEL_INVALID;
1713 if (o->type != OBJ_TAG)
1714 return PEEL_NON_TAG;
1716 o = deref_tag_noverify(o);
1717 if (!o)
1718 return PEEL_INVALID;
1720 hashcpy(sha1, o->sha1);
1721 return PEEL_PEELED;
1725 * Peel the entry (if possible) and return its new peel_status. If
1726 * repeel is true, re-peel the entry even if there is an old peeled
1727 * value that is already stored in it.
1729 * It is OK to call this function with a packed reference entry that
1730 * might be stale and might even refer to an object that has since
1731 * been garbage-collected. In such a case, if the entry has
1732 * REF_KNOWS_PEELED then leave the status unchanged and return
1733 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1735 static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1737 enum peel_status status;
1739 if (entry->flag & REF_KNOWS_PEELED) {
1740 if (repeel) {
1741 entry->flag &= ~REF_KNOWS_PEELED;
1742 hashclr(entry->u.value.peeled);
1743 } else {
1744 return is_null_sha1(entry->u.value.peeled) ?
1745 PEEL_NON_TAG : PEEL_PEELED;
1748 if (entry->flag & REF_ISBROKEN)
1749 return PEEL_BROKEN;
1750 if (entry->flag & REF_ISSYMREF)
1751 return PEEL_IS_SYMREF;
1753 status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
1754 if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1755 entry->flag |= REF_KNOWS_PEELED;
1756 return status;
1759 int peel_ref(const char *refname, unsigned char *sha1)
1761 int flag;
1762 unsigned char base[20];
1764 if (current_ref && (current_ref->name == refname
1765 || !strcmp(current_ref->name, refname))) {
1766 if (peel_entry(current_ref, 0))
1767 return -1;
1768 hashcpy(sha1, current_ref->u.value.peeled);
1769 return 0;
1772 if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1773 return -1;
1776 * If the reference is packed, read its ref_entry from the
1777 * cache in the hope that we already know its peeled value.
1778 * We only try this optimization on packed references because
1779 * (a) forcing the filling of the loose reference cache could
1780 * be expensive and (b) loose references anyway usually do not
1781 * have REF_KNOWS_PEELED.
1783 if (flag & REF_ISPACKED) {
1784 struct ref_entry *r = get_packed_ref(refname);
1785 if (r) {
1786 if (peel_entry(r, 0))
1787 return -1;
1788 hashcpy(sha1, r->u.value.peeled);
1789 return 0;
1793 return peel_object(base, sha1);
1796 struct warn_if_dangling_data {
1797 FILE *fp;
1798 const char *refname;
1799 const struct string_list *refnames;
1800 const char *msg_fmt;
1803 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1804 int flags, void *cb_data)
1806 struct warn_if_dangling_data *d = cb_data;
1807 const char *resolves_to;
1808 unsigned char junk[20];
1810 if (!(flags & REF_ISSYMREF))
1811 return 0;
1813 resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);
1814 if (!resolves_to
1815 || (d->refname
1816 ? strcmp(resolves_to, d->refname)
1817 : !string_list_has_string(d->refnames, resolves_to))) {
1818 return 0;
1821 fprintf(d->fp, d->msg_fmt, refname);
1822 fputc('\n', d->fp);
1823 return 0;
1826 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1828 struct warn_if_dangling_data data;
1830 data.fp = fp;
1831 data.refname = refname;
1832 data.refnames = NULL;
1833 data.msg_fmt = msg_fmt;
1834 for_each_rawref(warn_if_dangling_symref, &data);
1837 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
1839 struct warn_if_dangling_data data;
1841 data.fp = fp;
1842 data.refname = NULL;
1843 data.refnames = refnames;
1844 data.msg_fmt = msg_fmt;
1845 for_each_rawref(warn_if_dangling_symref, &data);
1849 * Call fn for each reference in the specified ref_cache, omitting
1850 * references not in the containing_dir of base. fn is called for all
1851 * references, including broken ones. If fn ever returns a non-zero
1852 * value, stop the iteration and return that value; otherwise, return
1853 * 0.
1855 static int do_for_each_entry(struct ref_cache *refs, const char *base,
1856 each_ref_entry_fn fn, void *cb_data)
1858 struct packed_ref_cache *packed_ref_cache;
1859 struct ref_dir *loose_dir;
1860 struct ref_dir *packed_dir;
1861 int retval = 0;
1864 * We must make sure that all loose refs are read before accessing the
1865 * packed-refs file; this avoids a race condition in which loose refs
1866 * are migrated to the packed-refs file by a simultaneous process, but
1867 * our in-memory view is from before the migration. get_packed_ref_cache()
1868 * takes care of making sure our view is up to date with what is on
1869 * disk.
1871 loose_dir = get_loose_refs(refs);
1872 if (base && *base) {
1873 loose_dir = find_containing_dir(loose_dir, base, 0);
1875 if (loose_dir)
1876 prime_ref_dir(loose_dir);
1878 packed_ref_cache = get_packed_ref_cache(refs);
1879 acquire_packed_ref_cache(packed_ref_cache);
1880 packed_dir = get_packed_ref_dir(packed_ref_cache);
1881 if (base && *base) {
1882 packed_dir = find_containing_dir(packed_dir, base, 0);
1885 if (packed_dir && loose_dir) {
1886 sort_ref_dir(packed_dir);
1887 sort_ref_dir(loose_dir);
1888 retval = do_for_each_entry_in_dirs(
1889 packed_dir, loose_dir, fn, cb_data);
1890 } else if (packed_dir) {
1891 sort_ref_dir(packed_dir);
1892 retval = do_for_each_entry_in_dir(
1893 packed_dir, 0, fn, cb_data);
1894 } else if (loose_dir) {
1895 sort_ref_dir(loose_dir);
1896 retval = do_for_each_entry_in_dir(
1897 loose_dir, 0, fn, cb_data);
1900 release_packed_ref_cache(packed_ref_cache);
1901 return retval;
1905 * Call fn for each reference in the specified ref_cache for which the
1906 * refname begins with base. If trim is non-zero, then trim that many
1907 * characters off the beginning of each refname before passing the
1908 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1909 * broken references in the iteration. If fn ever returns a non-zero
1910 * value, stop the iteration and return that value; otherwise, return
1911 * 0.
1913 static int do_for_each_ref(struct ref_cache *refs, const char *base,
1914 each_ref_fn fn, int trim, int flags, void *cb_data)
1916 struct ref_entry_cb data;
1917 data.base = base;
1918 data.trim = trim;
1919 data.flags = flags;
1920 data.fn = fn;
1921 data.cb_data = cb_data;
1923 return do_for_each_entry(refs, base, do_one_ref, &data);
1926 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1928 unsigned char sha1[20];
1929 int flag;
1931 if (submodule) {
1932 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1933 return fn("HEAD", sha1, 0, cb_data);
1935 return 0;
1938 if (!read_ref_full("HEAD", RESOLVE_REF_READING, sha1, &flag))
1939 return fn("HEAD", sha1, flag, cb_data);
1941 return 0;
1944 int head_ref(each_ref_fn fn, void *cb_data)
1946 return do_head_ref(NULL, fn, cb_data);
1949 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1951 return do_head_ref(submodule, fn, cb_data);
1954 int for_each_ref(each_ref_fn fn, void *cb_data)
1956 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1959 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1961 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1964 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1966 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1969 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1970 each_ref_fn fn, void *cb_data)
1972 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1975 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1977 return for_each_ref_in("refs/tags/", fn, cb_data);
1980 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1982 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1985 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1987 return for_each_ref_in("refs/heads/", fn, cb_data);
1990 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1992 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1995 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1997 return for_each_ref_in("refs/remotes/", fn, cb_data);
2000 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
2002 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
2005 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
2007 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
2010 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
2012 struct strbuf buf = STRBUF_INIT;
2013 int ret = 0;
2014 unsigned char sha1[20];
2015 int flag;
2017 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
2018 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, sha1, &flag))
2019 ret = fn(buf.buf, sha1, flag, cb_data);
2020 strbuf_release(&buf);
2022 return ret;
2025 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
2027 struct strbuf buf = STRBUF_INIT;
2028 int ret;
2029 strbuf_addf(&buf, "%srefs/", get_git_namespace());
2030 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
2031 strbuf_release(&buf);
2032 return ret;
2035 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
2036 const char *prefix, void *cb_data)
2038 struct strbuf real_pattern = STRBUF_INIT;
2039 struct ref_filter filter;
2040 int ret;
2042 if (!prefix && !starts_with(pattern, "refs/"))
2043 strbuf_addstr(&real_pattern, "refs/");
2044 else if (prefix)
2045 strbuf_addstr(&real_pattern, prefix);
2046 strbuf_addstr(&real_pattern, pattern);
2048 if (!has_glob_specials(pattern)) {
2049 /* Append implied '/' '*' if not present. */
2050 if (real_pattern.buf[real_pattern.len - 1] != '/')
2051 strbuf_addch(&real_pattern, '/');
2052 /* No need to check for '*', there is none. */
2053 strbuf_addch(&real_pattern, '*');
2056 filter.pattern = real_pattern.buf;
2057 filter.fn = fn;
2058 filter.cb_data = cb_data;
2059 ret = for_each_ref(filter_refs, &filter);
2061 strbuf_release(&real_pattern);
2062 return ret;
2065 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
2067 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
2070 int for_each_rawref(each_ref_fn fn, void *cb_data)
2072 return do_for_each_ref(&ref_cache, "", fn, 0,
2073 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
2076 const char *prettify_refname(const char *name)
2078 return name + (
2079 starts_with(name, "refs/heads/") ? 11 :
2080 starts_with(name, "refs/tags/") ? 10 :
2081 starts_with(name, "refs/remotes/") ? 13 :
2085 static const char *ref_rev_parse_rules[] = {
2086 "%.*s",
2087 "refs/%.*s",
2088 "refs/tags/%.*s",
2089 "refs/heads/%.*s",
2090 "refs/remotes/%.*s",
2091 "refs/remotes/%.*s/HEAD",
2092 NULL
2095 int refname_match(const char *abbrev_name, const char *full_name)
2097 const char **p;
2098 const int abbrev_name_len = strlen(abbrev_name);
2100 for (p = ref_rev_parse_rules; *p; p++) {
2101 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
2102 return 1;
2106 return 0;
2109 /* This function should make sure errno is meaningful on error */
2110 static struct ref_lock *verify_lock(struct ref_lock *lock,
2111 const unsigned char *old_sha1, int mustexist)
2113 if (read_ref_full(lock->ref_name,
2114 mustexist ? RESOLVE_REF_READING : 0,
2115 lock->old_sha1, NULL)) {
2116 int save_errno = errno;
2117 error("Can't verify ref %s", lock->ref_name);
2118 unlock_ref(lock);
2119 errno = save_errno;
2120 return NULL;
2122 if (hashcmp(lock->old_sha1, old_sha1)) {
2123 error("Ref %s is at %s but expected %s", lock->ref_name,
2124 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
2125 unlock_ref(lock);
2126 errno = EBUSY;
2127 return NULL;
2129 return lock;
2132 static int remove_empty_directories(const char *file)
2134 /* we want to create a file but there is a directory there;
2135 * if that is an empty directory (or a directory that contains
2136 * only empty directories), remove them.
2138 struct strbuf path;
2139 int result, save_errno;
2141 strbuf_init(&path, 20);
2142 strbuf_addstr(&path, file);
2144 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
2145 save_errno = errno;
2147 strbuf_release(&path);
2148 errno = save_errno;
2150 return result;
2154 * *string and *len will only be substituted, and *string returned (for
2155 * later free()ing) if the string passed in is a magic short-hand form
2156 * to name a branch.
2158 static char *substitute_branch_name(const char **string, int *len)
2160 struct strbuf buf = STRBUF_INIT;
2161 int ret = interpret_branch_name(*string, *len, &buf);
2163 if (ret == *len) {
2164 size_t size;
2165 *string = strbuf_detach(&buf, &size);
2166 *len = size;
2167 return (char *)*string;
2170 return NULL;
2173 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
2175 char *last_branch = substitute_branch_name(&str, &len);
2176 const char **p, *r;
2177 int refs_found = 0;
2179 *ref = NULL;
2180 for (p = ref_rev_parse_rules; *p; p++) {
2181 char fullref[PATH_MAX];
2182 unsigned char sha1_from_ref[20];
2183 unsigned char *this_result;
2184 int flag;
2186 this_result = refs_found ? sha1_from_ref : sha1;
2187 mksnpath(fullref, sizeof(fullref), *p, len, str);
2188 r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
2189 this_result, &flag);
2190 if (r) {
2191 if (!refs_found++)
2192 *ref = xstrdup(r);
2193 if (!warn_ambiguous_refs)
2194 break;
2195 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2196 warning("ignoring dangling symref %s.", fullref);
2197 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
2198 warning("ignoring broken ref %s.", fullref);
2201 free(last_branch);
2202 return refs_found;
2205 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
2207 char *last_branch = substitute_branch_name(&str, &len);
2208 const char **p;
2209 int logs_found = 0;
2211 *log = NULL;
2212 for (p = ref_rev_parse_rules; *p; p++) {
2213 unsigned char hash[20];
2214 char path[PATH_MAX];
2215 const char *ref, *it;
2217 mksnpath(path, sizeof(path), *p, len, str);
2218 ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
2219 hash, NULL);
2220 if (!ref)
2221 continue;
2222 if (reflog_exists(path))
2223 it = path;
2224 else if (strcmp(ref, path) && reflog_exists(ref))
2225 it = ref;
2226 else
2227 continue;
2228 if (!logs_found++) {
2229 *log = xstrdup(it);
2230 hashcpy(sha1, hash);
2232 if (!warn_ambiguous_refs)
2233 break;
2235 free(last_branch);
2236 return logs_found;
2240 * Locks a ref returning the lock on success and NULL on failure.
2241 * On failure errno is set to something meaningful.
2243 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
2244 const unsigned char *old_sha1,
2245 const struct string_list *skip,
2246 int flags, int *type_p)
2248 const char *ref_file;
2249 const char *orig_refname = refname;
2250 struct ref_lock *lock;
2251 int last_errno = 0;
2252 int type, lflags;
2253 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2254 int resolve_flags = 0;
2255 int missing = 0;
2256 int attempts_remaining = 3;
2258 lock = xcalloc(1, sizeof(struct ref_lock));
2259 lock->lock_fd = -1;
2261 if (mustexist)
2262 resolve_flags |= RESOLVE_REF_READING;
2263 if (flags & REF_DELETING) {
2264 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
2265 if (flags & REF_NODEREF)
2266 resolve_flags |= RESOLVE_REF_NO_RECURSE;
2269 refname = resolve_ref_unsafe(refname, resolve_flags,
2270 lock->old_sha1, &type);
2271 if (!refname && errno == EISDIR) {
2272 /* we are trying to lock foo but we used to
2273 * have foo/bar which now does not exist;
2274 * it is normal for the empty directory 'foo'
2275 * to remain.
2277 ref_file = git_path("%s", orig_refname);
2278 if (remove_empty_directories(ref_file)) {
2279 last_errno = errno;
2280 error("there are still refs under '%s'", orig_refname);
2281 goto error_return;
2283 refname = resolve_ref_unsafe(orig_refname, resolve_flags,
2284 lock->old_sha1, &type);
2286 if (type_p)
2287 *type_p = type;
2288 if (!refname) {
2289 last_errno = errno;
2290 error("unable to resolve reference %s: %s",
2291 orig_refname, strerror(errno));
2292 goto error_return;
2294 missing = is_null_sha1(lock->old_sha1);
2295 /* When the ref did not exist and we are creating it,
2296 * make sure there is no existing ref that is packed
2297 * whose name begins with our refname, nor a ref whose
2298 * name is a proper prefix of our refname.
2300 if (missing &&
2301 !is_refname_available(refname, skip, get_packed_refs(&ref_cache))) {
2302 last_errno = ENOTDIR;
2303 goto error_return;
2306 lock->lk = xcalloc(1, sizeof(struct lock_file));
2308 lflags = 0;
2309 if (flags & REF_NODEREF) {
2310 refname = orig_refname;
2311 lflags |= LOCK_NO_DEREF;
2313 lock->ref_name = xstrdup(refname);
2314 lock->orig_ref_name = xstrdup(orig_refname);
2315 ref_file = git_path("%s", refname);
2316 if (missing)
2317 lock->force_write = 1;
2318 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
2319 lock->force_write = 1;
2321 retry:
2322 switch (safe_create_leading_directories_const(ref_file)) {
2323 case SCLD_OK:
2324 break; /* success */
2325 case SCLD_VANISHED:
2326 if (--attempts_remaining > 0)
2327 goto retry;
2328 /* fall through */
2329 default:
2330 last_errno = errno;
2331 error("unable to create directory for %s", ref_file);
2332 goto error_return;
2335 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
2336 if (lock->lock_fd < 0) {
2337 if (errno == ENOENT && --attempts_remaining > 0)
2339 * Maybe somebody just deleted one of the
2340 * directories leading to ref_file. Try
2341 * again:
2343 goto retry;
2344 else
2345 unable_to_lock_die(ref_file, errno);
2347 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
2349 error_return:
2350 unlock_ref(lock);
2351 errno = last_errno;
2352 return NULL;
2355 struct ref_lock *lock_any_ref_for_update(const char *refname,
2356 const unsigned char *old_sha1,
2357 int flags, int *type_p)
2359 return lock_ref_sha1_basic(refname, old_sha1, NULL, flags, type_p);
2363 * Write an entry to the packed-refs file for the specified refname.
2364 * If peeled is non-NULL, write it as the entry's peeled value.
2366 static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2367 unsigned char *peeled)
2369 fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
2370 if (peeled)
2371 fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2375 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2377 static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2379 enum peel_status peel_status = peel_entry(entry, 0);
2381 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2382 error("internal error: %s is not a valid packed reference!",
2383 entry->name);
2384 write_packed_entry(cb_data, entry->name, entry->u.value.sha1,
2385 peel_status == PEEL_PEELED ?
2386 entry->u.value.peeled : NULL);
2387 return 0;
2390 /* This should return a meaningful errno on failure */
2391 int lock_packed_refs(int flags)
2393 struct packed_ref_cache *packed_ref_cache;
2395 if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)
2396 return -1;
2398 * Get the current packed-refs while holding the lock. If the
2399 * packed-refs file has been modified since we last read it,
2400 * this will automatically invalidate the cache and re-read
2401 * the packed-refs file.
2403 packed_ref_cache = get_packed_ref_cache(&ref_cache);
2404 packed_ref_cache->lock = &packlock;
2405 /* Increment the reference count to prevent it from being freed: */
2406 acquire_packed_ref_cache(packed_ref_cache);
2407 return 0;
2411 * Commit the packed refs changes.
2412 * On error we must make sure that errno contains a meaningful value.
2414 int commit_packed_refs(void)
2416 struct packed_ref_cache *packed_ref_cache =
2417 get_packed_ref_cache(&ref_cache);
2418 int error = 0;
2419 int save_errno = 0;
2420 FILE *out;
2422 if (!packed_ref_cache->lock)
2423 die("internal error: packed-refs not locked");
2425 out = fdopen_lock_file(packed_ref_cache->lock, "w");
2426 if (!out)
2427 die_errno("unable to fdopen packed-refs descriptor");
2429 fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2430 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2431 0, write_packed_entry_fn, out);
2433 if (commit_lock_file(packed_ref_cache->lock)) {
2434 save_errno = errno;
2435 error = -1;
2437 packed_ref_cache->lock = NULL;
2438 release_packed_ref_cache(packed_ref_cache);
2439 errno = save_errno;
2440 return error;
2443 void rollback_packed_refs(void)
2445 struct packed_ref_cache *packed_ref_cache =
2446 get_packed_ref_cache(&ref_cache);
2448 if (!packed_ref_cache->lock)
2449 die("internal error: packed-refs not locked");
2450 rollback_lock_file(packed_ref_cache->lock);
2451 packed_ref_cache->lock = NULL;
2452 release_packed_ref_cache(packed_ref_cache);
2453 clear_packed_ref_cache(&ref_cache);
2456 struct ref_to_prune {
2457 struct ref_to_prune *next;
2458 unsigned char sha1[20];
2459 char name[FLEX_ARRAY];
2462 struct pack_refs_cb_data {
2463 unsigned int flags;
2464 struct ref_dir *packed_refs;
2465 struct ref_to_prune *ref_to_prune;
2469 * An each_ref_entry_fn that is run over loose references only. If
2470 * the loose reference can be packed, add an entry in the packed ref
2471 * cache. If the reference should be pruned, also add it to
2472 * ref_to_prune in the pack_refs_cb_data.
2474 static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2476 struct pack_refs_cb_data *cb = cb_data;
2477 enum peel_status peel_status;
2478 struct ref_entry *packed_entry;
2479 int is_tag_ref = starts_with(entry->name, "refs/tags/");
2481 /* ALWAYS pack tags */
2482 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2483 return 0;
2485 /* Do not pack symbolic or broken refs: */
2486 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
2487 return 0;
2489 /* Add a packed ref cache entry equivalent to the loose entry. */
2490 peel_status = peel_entry(entry, 1);
2491 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2492 die("internal error peeling reference %s (%s)",
2493 entry->name, sha1_to_hex(entry->u.value.sha1));
2494 packed_entry = find_ref(cb->packed_refs, entry->name);
2495 if (packed_entry) {
2496 /* Overwrite existing packed entry with info from loose entry */
2497 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2498 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
2499 } else {
2500 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
2501 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2502 add_ref(cb->packed_refs, packed_entry);
2504 hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
2506 /* Schedule the loose reference for pruning if requested. */
2507 if ((cb->flags & PACK_REFS_PRUNE)) {
2508 int namelen = strlen(entry->name) + 1;
2509 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2510 hashcpy(n->sha1, entry->u.value.sha1);
2511 strcpy(n->name, entry->name);
2512 n->next = cb->ref_to_prune;
2513 cb->ref_to_prune = n;
2515 return 0;
2519 * Remove empty parents, but spare refs/ and immediate subdirs.
2520 * Note: munges *name.
2522 static void try_remove_empty_parents(char *name)
2524 char *p, *q;
2525 int i;
2526 p = name;
2527 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2528 while (*p && *p != '/')
2529 p++;
2530 /* tolerate duplicate slashes; see check_refname_format() */
2531 while (*p == '/')
2532 p++;
2534 for (q = p; *q; q++)
2536 while (1) {
2537 while (q > p && *q != '/')
2538 q--;
2539 while (q > p && *(q-1) == '/')
2540 q--;
2541 if (q == p)
2542 break;
2543 *q = '\0';
2544 if (rmdir(git_path("%s", name)))
2545 break;
2549 /* make sure nobody touched the ref, and unlink */
2550 static void prune_ref(struct ref_to_prune *r)
2552 struct ref_transaction *transaction;
2553 struct strbuf err = STRBUF_INIT;
2555 if (check_refname_format(r->name, 0))
2556 return;
2558 transaction = ref_transaction_begin(&err);
2559 if (!transaction ||
2560 ref_transaction_delete(transaction, r->name, r->sha1,
2561 REF_ISPRUNING, 1, NULL, &err) ||
2562 ref_transaction_commit(transaction, &err)) {
2563 ref_transaction_free(transaction);
2564 error("%s", err.buf);
2565 strbuf_release(&err);
2566 return;
2568 ref_transaction_free(transaction);
2569 strbuf_release(&err);
2570 try_remove_empty_parents(r->name);
2573 static void prune_refs(struct ref_to_prune *r)
2575 while (r) {
2576 prune_ref(r);
2577 r = r->next;
2581 int pack_refs(unsigned int flags)
2583 struct pack_refs_cb_data cbdata;
2585 memset(&cbdata, 0, sizeof(cbdata));
2586 cbdata.flags = flags;
2588 lock_packed_refs(LOCK_DIE_ON_ERROR);
2589 cbdata.packed_refs = get_packed_refs(&ref_cache);
2591 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2592 pack_if_possible_fn, &cbdata);
2594 if (commit_packed_refs())
2595 die_errno("unable to overwrite old ref-pack file");
2597 prune_refs(cbdata.ref_to_prune);
2598 return 0;
2602 * If entry is no longer needed in packed-refs, add it to the string
2603 * list pointed to by cb_data. Reasons for deleting entries:
2605 * - Entry is broken.
2606 * - Entry is overridden by a loose ref.
2607 * - Entry does not point at a valid object.
2609 * In the first and third cases, also emit an error message because these
2610 * are indications of repository corruption.
2612 static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
2614 struct string_list *refs_to_delete = cb_data;
2616 if (entry->flag & REF_ISBROKEN) {
2617 /* This shouldn't happen to packed refs. */
2618 error("%s is broken!", entry->name);
2619 string_list_append(refs_to_delete, entry->name);
2620 return 0;
2622 if (!has_sha1_file(entry->u.value.sha1)) {
2623 unsigned char sha1[20];
2624 int flags;
2626 if (read_ref_full(entry->name, 0, sha1, &flags))
2627 /* We should at least have found the packed ref. */
2628 die("Internal error");
2629 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2631 * This packed reference is overridden by a
2632 * loose reference, so it is OK that its value
2633 * is no longer valid; for example, it might
2634 * refer to an object that has been garbage
2635 * collected. For this purpose we don't even
2636 * care whether the loose reference itself is
2637 * invalid, broken, symbolic, etc. Silently
2638 * remove the packed reference.
2640 string_list_append(refs_to_delete, entry->name);
2641 return 0;
2644 * There is no overriding loose reference, so the fact
2645 * that this reference doesn't refer to a valid object
2646 * indicates some kind of repository corruption.
2647 * Report the problem, then omit the reference from
2648 * the output.
2650 error("%s does not point to a valid object!", entry->name);
2651 string_list_append(refs_to_delete, entry->name);
2652 return 0;
2655 return 0;
2658 int repack_without_refs(const char **refnames, int n, struct strbuf *err)
2660 struct ref_dir *packed;
2661 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
2662 struct string_list_item *ref_to_delete;
2663 int i, ret, removed = 0;
2665 assert(err);
2667 /* Look for a packed ref */
2668 for (i = 0; i < n; i++)
2669 if (get_packed_ref(refnames[i]))
2670 break;
2672 /* Avoid locking if we have nothing to do */
2673 if (i == n)
2674 return 0; /* no refname exists in packed refs */
2676 if (lock_packed_refs(0)) {
2677 unable_to_lock_message(git_path("packed-refs"), errno, err);
2678 return -1;
2680 packed = get_packed_refs(&ref_cache);
2682 /* Remove refnames from the cache */
2683 for (i = 0; i < n; i++)
2684 if (remove_entry(packed, refnames[i]) != -1)
2685 removed = 1;
2686 if (!removed) {
2688 * All packed entries disappeared while we were
2689 * acquiring the lock.
2691 rollback_packed_refs();
2692 return 0;
2695 /* Remove any other accumulated cruft */
2696 do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
2697 for_each_string_list_item(ref_to_delete, &refs_to_delete) {
2698 if (remove_entry(packed, ref_to_delete->string) == -1)
2699 die("internal error");
2702 /* Write what remains */
2703 ret = commit_packed_refs();
2704 if (ret)
2705 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
2706 strerror(errno));
2707 return ret;
2710 static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2712 assert(err);
2714 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2716 * loose. The loose file name is the same as the
2717 * lockfile name, minus ".lock":
2719 char *loose_filename = get_locked_file_path(lock->lk);
2720 int res = unlink_or_msg(loose_filename, err);
2721 free(loose_filename);
2722 if (res)
2723 return 1;
2725 return 0;
2728 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
2730 struct ref_transaction *transaction;
2731 struct strbuf err = STRBUF_INIT;
2733 transaction = ref_transaction_begin(&err);
2734 if (!transaction ||
2735 ref_transaction_delete(transaction, refname, sha1, delopt,
2736 sha1 && !is_null_sha1(sha1), NULL, &err) ||
2737 ref_transaction_commit(transaction, &err)) {
2738 error("%s", err.buf);
2739 ref_transaction_free(transaction);
2740 strbuf_release(&err);
2741 return 1;
2743 ref_transaction_free(transaction);
2744 strbuf_release(&err);
2745 return 0;
2749 * People using contrib's git-new-workdir have .git/logs/refs ->
2750 * /some/other/path/.git/logs/refs, and that may live on another device.
2752 * IOW, to avoid cross device rename errors, the temporary renamed log must
2753 * live into logs/refs.
2755 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2757 static int rename_tmp_log(const char *newrefname)
2759 int attempts_remaining = 4;
2761 retry:
2762 switch (safe_create_leading_directories_const(git_path("logs/%s", newrefname))) {
2763 case SCLD_OK:
2764 break; /* success */
2765 case SCLD_VANISHED:
2766 if (--attempts_remaining > 0)
2767 goto retry;
2768 /* fall through */
2769 default:
2770 error("unable to create directory for %s", newrefname);
2771 return -1;
2774 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2775 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2777 * rename(a, b) when b is an existing
2778 * directory ought to result in ISDIR, but
2779 * Solaris 5.8 gives ENOTDIR. Sheesh.
2781 if (remove_empty_directories(git_path("logs/%s", newrefname))) {
2782 error("Directory not empty: logs/%s", newrefname);
2783 return -1;
2785 goto retry;
2786 } else if (errno == ENOENT && --attempts_remaining > 0) {
2788 * Maybe another process just deleted one of
2789 * the directories in the path to newrefname.
2790 * Try again from the beginning.
2792 goto retry;
2793 } else {
2794 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2795 newrefname, strerror(errno));
2796 return -1;
2799 return 0;
2802 static int rename_ref_available(const char *oldname, const char *newname)
2804 struct string_list skip = STRING_LIST_INIT_NODUP;
2805 int ret;
2807 string_list_insert(&skip, oldname);
2808 ret = is_refname_available(newname, &skip, get_packed_refs(&ref_cache))
2809 && is_refname_available(newname, &skip, get_loose_refs(&ref_cache));
2810 string_list_clear(&skip, 0);
2811 return ret;
2814 static int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1,
2815 const char *logmsg);
2817 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2819 unsigned char sha1[20], orig_sha1[20];
2820 int flag = 0, logmoved = 0;
2821 struct ref_lock *lock;
2822 struct stat loginfo;
2823 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
2824 const char *symref = NULL;
2826 if (log && S_ISLNK(loginfo.st_mode))
2827 return error("reflog for %s is a symlink", oldrefname);
2829 symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,
2830 orig_sha1, &flag);
2831 if (flag & REF_ISSYMREF)
2832 return error("refname %s is a symbolic ref, renaming it is not supported",
2833 oldrefname);
2834 if (!symref)
2835 return error("refname %s not found", oldrefname);
2837 if (!rename_ref_available(oldrefname, newrefname))
2838 return 1;
2840 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2841 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2842 oldrefname, strerror(errno));
2844 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
2845 error("unable to delete old %s", oldrefname);
2846 goto rollback;
2849 if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&
2850 delete_ref(newrefname, sha1, REF_NODEREF)) {
2851 if (errno==EISDIR) {
2852 if (remove_empty_directories(git_path("%s", newrefname))) {
2853 error("Directory not empty: %s", newrefname);
2854 goto rollback;
2856 } else {
2857 error("unable to delete existing %s", newrefname);
2858 goto rollback;
2862 if (log && rename_tmp_log(newrefname))
2863 goto rollback;
2865 logmoved = log;
2867 lock = lock_ref_sha1_basic(newrefname, NULL, NULL, 0, NULL);
2868 if (!lock) {
2869 error("unable to lock %s for update", newrefname);
2870 goto rollback;
2872 lock->force_write = 1;
2873 hashcpy(lock->old_sha1, orig_sha1);
2874 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2875 error("unable to write current sha1 into %s", newrefname);
2876 goto rollback;
2879 return 0;
2881 rollback:
2882 lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, 0, NULL);
2883 if (!lock) {
2884 error("unable to lock %s for rollback", oldrefname);
2885 goto rollbacklog;
2888 lock->force_write = 1;
2889 flag = log_all_ref_updates;
2890 log_all_ref_updates = 0;
2891 if (write_ref_sha1(lock, orig_sha1, NULL))
2892 error("unable to write current sha1 into %s", oldrefname);
2893 log_all_ref_updates = flag;
2895 rollbacklog:
2896 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2897 error("unable to restore logfile %s from %s: %s",
2898 oldrefname, newrefname, strerror(errno));
2899 if (!logmoved && log &&
2900 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2901 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2902 oldrefname, strerror(errno));
2904 return 1;
2907 int close_ref(struct ref_lock *lock)
2909 if (close_lock_file(lock->lk))
2910 return -1;
2911 lock->lock_fd = -1;
2912 return 0;
2915 int commit_ref(struct ref_lock *lock)
2917 if (commit_lock_file(lock->lk))
2918 return -1;
2919 lock->lock_fd = -1;
2920 return 0;
2923 void unlock_ref(struct ref_lock *lock)
2925 /* Do not free lock->lk -- atexit() still looks at them */
2926 if (lock->lk)
2927 rollback_lock_file(lock->lk);
2928 free(lock->ref_name);
2929 free(lock->orig_ref_name);
2930 free(lock);
2934 * copy the reflog message msg to buf, which has been allocated sufficiently
2935 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2936 * because reflog file is one line per entry.
2938 static int copy_msg(char *buf, const char *msg)
2940 char *cp = buf;
2941 char c;
2942 int wasspace = 1;
2944 *cp++ = '\t';
2945 while ((c = *msg++)) {
2946 if (wasspace && isspace(c))
2947 continue;
2948 wasspace = isspace(c);
2949 if (wasspace)
2950 c = ' ';
2951 *cp++ = c;
2953 while (buf < cp && isspace(cp[-1]))
2954 cp--;
2955 *cp++ = '\n';
2956 return cp - buf;
2959 /* This function must set a meaningful errno on failure */
2960 int log_ref_setup(const char *refname, struct strbuf *sb_logfile)
2962 int logfd, oflags = O_APPEND | O_WRONLY;
2963 char *logfile;
2965 strbuf_git_path(sb_logfile, "logs/%s", refname);
2966 logfile = sb_logfile->buf;
2967 /* make sure the rest of the function can't change "logfile" */
2968 sb_logfile = NULL;
2969 if (log_all_ref_updates &&
2970 (starts_with(refname, "refs/heads/") ||
2971 starts_with(refname, "refs/remotes/") ||
2972 starts_with(refname, "refs/notes/") ||
2973 !strcmp(refname, "HEAD"))) {
2974 if (safe_create_leading_directories(logfile) < 0) {
2975 int save_errno = errno;
2976 error("unable to create directory for %s", logfile);
2977 errno = save_errno;
2978 return -1;
2980 oflags |= O_CREAT;
2983 logfd = open(logfile, oflags, 0666);
2984 if (logfd < 0) {
2985 if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))
2986 return 0;
2988 if (errno == EISDIR) {
2989 if (remove_empty_directories(logfile)) {
2990 int save_errno = errno;
2991 error("There are still logs under '%s'",
2992 logfile);
2993 errno = save_errno;
2994 return -1;
2996 logfd = open(logfile, oflags, 0666);
2999 if (logfd < 0) {
3000 int save_errno = errno;
3001 error("Unable to append to %s: %s", logfile,
3002 strerror(errno));
3003 errno = save_errno;
3004 return -1;
3008 adjust_shared_perm(logfile);
3009 close(logfd);
3010 return 0;
3013 static int log_ref_write_1(const char *refname, const unsigned char *old_sha1,
3014 const unsigned char *new_sha1, const char *msg,
3015 struct strbuf *sb_log_file)
3017 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
3018 unsigned maxlen, len;
3019 int msglen;
3020 const char *log_file;
3021 char *logrec;
3022 const char *committer;
3024 if (log_all_ref_updates < 0)
3025 log_all_ref_updates = !is_bare_repository();
3027 result = log_ref_setup(refname, sb_log_file);
3028 if (result)
3029 return result;
3030 log_file = sb_log_file->buf;
3031 /* make sure the rest of the function can't change "log_file" */
3032 sb_log_file = NULL;
3034 logfd = open(log_file, oflags);
3035 if (logfd < 0)
3036 return 0;
3037 msglen = msg ? strlen(msg) : 0;
3038 committer = git_committer_info(0);
3039 maxlen = strlen(committer) + msglen + 100;
3040 logrec = xmalloc(maxlen);
3041 len = sprintf(logrec, "%s %s %s\n",
3042 sha1_to_hex(old_sha1),
3043 sha1_to_hex(new_sha1),
3044 committer);
3045 if (msglen)
3046 len += copy_msg(logrec + len - 1, msg) - 1;
3047 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
3048 free(logrec);
3049 if (written != len) {
3050 int save_errno = errno;
3051 close(logfd);
3052 error("Unable to append to %s", log_file);
3053 errno = save_errno;
3054 return -1;
3056 if (close(logfd)) {
3057 int save_errno = errno;
3058 error("Unable to append to %s", log_file);
3059 errno = save_errno;
3060 return -1;
3062 return 0;
3065 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
3066 const unsigned char *new_sha1, const char *msg)
3068 struct strbuf sb = STRBUF_INIT;
3069 int ret = log_ref_write_1(refname, old_sha1, new_sha1, msg, &sb);
3070 strbuf_release(&sb);
3071 return ret;
3074 int is_branch(const char *refname)
3076 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
3080 * Write sha1 into the ref specified by the lock. Make sure that errno
3081 * is sane on error.
3083 static int write_ref_sha1(struct ref_lock *lock,
3084 const unsigned char *sha1, const char *logmsg)
3086 static char term = '\n';
3087 struct object *o;
3089 if (!lock) {
3090 errno = EINVAL;
3091 return -1;
3093 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
3094 unlock_ref(lock);
3095 return 0;
3097 o = parse_object(sha1);
3098 if (!o) {
3099 error("Trying to write ref %s with nonexistent object %s",
3100 lock->ref_name, sha1_to_hex(sha1));
3101 unlock_ref(lock);
3102 errno = EINVAL;
3103 return -1;
3105 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
3106 error("Trying to write non-commit object %s to branch %s",
3107 sha1_to_hex(sha1), lock->ref_name);
3108 unlock_ref(lock);
3109 errno = EINVAL;
3110 return -1;
3112 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
3113 write_in_full(lock->lock_fd, &term, 1) != 1 ||
3114 close_ref(lock) < 0) {
3115 int save_errno = errno;
3116 error("Couldn't write %s", lock->lk->filename.buf);
3117 unlock_ref(lock);
3118 errno = save_errno;
3119 return -1;
3121 clear_loose_ref_cache(&ref_cache);
3122 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
3123 (strcmp(lock->ref_name, lock->orig_ref_name) &&
3124 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
3125 unlock_ref(lock);
3126 return -1;
3128 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
3130 * Special hack: If a branch is updated directly and HEAD
3131 * points to it (may happen on the remote side of a push
3132 * for example) then logically the HEAD reflog should be
3133 * updated too.
3134 * A generic solution implies reverse symref information,
3135 * but finding all symrefs pointing to the given branch
3136 * would be rather costly for this rare event (the direct
3137 * update of a branch) to be worth it. So let's cheat and
3138 * check with HEAD only which should cover 99% of all usage
3139 * scenarios (even 100% of the default ones).
3141 unsigned char head_sha1[20];
3142 int head_flag;
3143 const char *head_ref;
3144 head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
3145 head_sha1, &head_flag);
3146 if (head_ref && (head_flag & REF_ISSYMREF) &&
3147 !strcmp(head_ref, lock->ref_name))
3148 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
3150 if (commit_ref(lock)) {
3151 error("Couldn't set %s", lock->ref_name);
3152 unlock_ref(lock);
3153 return -1;
3155 unlock_ref(lock);
3156 return 0;
3159 int create_symref(const char *ref_target, const char *refs_heads_master,
3160 const char *logmsg)
3162 const char *lockpath;
3163 char ref[1000];
3164 int fd, len, written;
3165 char *git_HEAD = git_pathdup("%s", ref_target);
3166 unsigned char old_sha1[20], new_sha1[20];
3168 if (logmsg && read_ref(ref_target, old_sha1))
3169 hashclr(old_sha1);
3171 if (safe_create_leading_directories(git_HEAD) < 0)
3172 return error("unable to create directory for %s", git_HEAD);
3174 #ifndef NO_SYMLINK_HEAD
3175 if (prefer_symlink_refs) {
3176 unlink(git_HEAD);
3177 if (!symlink(refs_heads_master, git_HEAD))
3178 goto done;
3179 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
3181 #endif
3183 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
3184 if (sizeof(ref) <= len) {
3185 error("refname too long: %s", refs_heads_master);
3186 goto error_free_return;
3188 lockpath = mkpath("%s.lock", git_HEAD);
3189 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
3190 if (fd < 0) {
3191 error("Unable to open %s for writing", lockpath);
3192 goto error_free_return;
3194 written = write_in_full(fd, ref, len);
3195 if (close(fd) != 0 || written != len) {
3196 error("Unable to write to %s", lockpath);
3197 goto error_unlink_return;
3199 if (rename(lockpath, git_HEAD) < 0) {
3200 error("Unable to create %s", git_HEAD);
3201 goto error_unlink_return;
3203 if (adjust_shared_perm(git_HEAD)) {
3204 error("Unable to fix permissions on %s", lockpath);
3205 error_unlink_return:
3206 unlink_or_warn(lockpath);
3207 error_free_return:
3208 free(git_HEAD);
3209 return -1;
3212 #ifndef NO_SYMLINK_HEAD
3213 done:
3214 #endif
3215 if (logmsg && !read_ref(refs_heads_master, new_sha1))
3216 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
3218 free(git_HEAD);
3219 return 0;
3222 struct read_ref_at_cb {
3223 const char *refname;
3224 unsigned long at_time;
3225 int cnt;
3226 int reccnt;
3227 unsigned char *sha1;
3228 int found_it;
3230 unsigned char osha1[20];
3231 unsigned char nsha1[20];
3232 int tz;
3233 unsigned long date;
3234 char **msg;
3235 unsigned long *cutoff_time;
3236 int *cutoff_tz;
3237 int *cutoff_cnt;
3240 static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,
3241 const char *email, unsigned long timestamp, int tz,
3242 const char *message, void *cb_data)
3244 struct read_ref_at_cb *cb = cb_data;
3246 cb->reccnt++;
3247 cb->tz = tz;
3248 cb->date = timestamp;
3250 if (timestamp <= cb->at_time || cb->cnt == 0) {
3251 if (cb->msg)
3252 *cb->msg = xstrdup(message);
3253 if (cb->cutoff_time)
3254 *cb->cutoff_time = timestamp;
3255 if (cb->cutoff_tz)
3256 *cb->cutoff_tz = tz;
3257 if (cb->cutoff_cnt)
3258 *cb->cutoff_cnt = cb->reccnt - 1;
3260 * we have not yet updated cb->[n|o]sha1 so they still
3261 * hold the values for the previous record.
3263 if (!is_null_sha1(cb->osha1)) {
3264 hashcpy(cb->sha1, nsha1);
3265 if (hashcmp(cb->osha1, nsha1))
3266 warning("Log for ref %s has gap after %s.",
3267 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));
3269 else if (cb->date == cb->at_time)
3270 hashcpy(cb->sha1, nsha1);
3271 else if (hashcmp(nsha1, cb->sha1))
3272 warning("Log for ref %s unexpectedly ended on %s.",
3273 cb->refname, show_date(cb->date, cb->tz,
3274 DATE_RFC2822));
3275 hashcpy(cb->osha1, osha1);
3276 hashcpy(cb->nsha1, nsha1);
3277 cb->found_it = 1;
3278 return 1;
3280 hashcpy(cb->osha1, osha1);
3281 hashcpy(cb->nsha1, nsha1);
3282 if (cb->cnt > 0)
3283 cb->cnt--;
3284 return 0;
3287 static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,
3288 const char *email, unsigned long timestamp,
3289 int tz, const char *message, void *cb_data)
3291 struct read_ref_at_cb *cb = cb_data;
3293 if (cb->msg)
3294 *cb->msg = xstrdup(message);
3295 if (cb->cutoff_time)
3296 *cb->cutoff_time = timestamp;
3297 if (cb->cutoff_tz)
3298 *cb->cutoff_tz = tz;
3299 if (cb->cutoff_cnt)
3300 *cb->cutoff_cnt = cb->reccnt;
3301 hashcpy(cb->sha1, osha1);
3302 if (is_null_sha1(cb->sha1))
3303 hashcpy(cb->sha1, nsha1);
3304 /* We just want the first entry */
3305 return 1;
3308 int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
3309 unsigned char *sha1, char **msg,
3310 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3312 struct read_ref_at_cb cb;
3314 memset(&cb, 0, sizeof(cb));
3315 cb.refname = refname;
3316 cb.at_time = at_time;
3317 cb.cnt = cnt;
3318 cb.msg = msg;
3319 cb.cutoff_time = cutoff_time;
3320 cb.cutoff_tz = cutoff_tz;
3321 cb.cutoff_cnt = cutoff_cnt;
3322 cb.sha1 = sha1;
3324 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
3326 if (!cb.reccnt) {
3327 if (flags & GET_SHA1_QUIETLY)
3328 exit(128);
3329 else
3330 die("Log for %s is empty.", refname);
3332 if (cb.found_it)
3333 return 0;
3335 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3337 return 1;
3340 int reflog_exists(const char *refname)
3342 struct stat st;
3344 return !lstat(git_path("logs/%s", refname), &st) &&
3345 S_ISREG(st.st_mode);
3348 int delete_reflog(const char *refname)
3350 return remove_path(git_path("logs/%s", refname));
3353 static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
3355 unsigned char osha1[20], nsha1[20];
3356 char *email_end, *message;
3357 unsigned long timestamp;
3358 int tz;
3360 /* old SP new SP name <email> SP time TAB msg LF */
3361 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
3362 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
3363 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
3364 !(email_end = strchr(sb->buf + 82, '>')) ||
3365 email_end[1] != ' ' ||
3366 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
3367 !message || message[0] != ' ' ||
3368 (message[1] != '+' && message[1] != '-') ||
3369 !isdigit(message[2]) || !isdigit(message[3]) ||
3370 !isdigit(message[4]) || !isdigit(message[5]))
3371 return 0; /* corrupt? */
3372 email_end[1] = '\0';
3373 tz = strtol(message + 1, NULL, 10);
3374 if (message[6] != '\t')
3375 message += 6;
3376 else
3377 message += 7;
3378 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
3381 static char *find_beginning_of_line(char *bob, char *scan)
3383 while (bob < scan && *(--scan) != '\n')
3384 ; /* keep scanning backwards */
3386 * Return either beginning of the buffer, or LF at the end of
3387 * the previous line.
3389 return scan;
3392 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3394 struct strbuf sb = STRBUF_INIT;
3395 FILE *logfp;
3396 long pos;
3397 int ret = 0, at_tail = 1;
3399 logfp = fopen(git_path("logs/%s", refname), "r");
3400 if (!logfp)
3401 return -1;
3403 /* Jump to the end */
3404 if (fseek(logfp, 0, SEEK_END) < 0)
3405 return error("cannot seek back reflog for %s: %s",
3406 refname, strerror(errno));
3407 pos = ftell(logfp);
3408 while (!ret && 0 < pos) {
3409 int cnt;
3410 size_t nread;
3411 char buf[BUFSIZ];
3412 char *endp, *scanp;
3414 /* Fill next block from the end */
3415 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
3416 if (fseek(logfp, pos - cnt, SEEK_SET))
3417 return error("cannot seek back reflog for %s: %s",
3418 refname, strerror(errno));
3419 nread = fread(buf, cnt, 1, logfp);
3420 if (nread != 1)
3421 return error("cannot read %d bytes from reflog for %s: %s",
3422 cnt, refname, strerror(errno));
3423 pos -= cnt;
3425 scanp = endp = buf + cnt;
3426 if (at_tail && scanp[-1] == '\n')
3427 /* Looking at the final LF at the end of the file */
3428 scanp--;
3429 at_tail = 0;
3431 while (buf < scanp) {
3433 * terminating LF of the previous line, or the beginning
3434 * of the buffer.
3436 char *bp;
3438 bp = find_beginning_of_line(buf, scanp);
3440 if (*bp != '\n') {
3441 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3442 if (pos)
3443 break; /* need to fill another block */
3444 scanp = buf - 1; /* leave loop */
3445 } else {
3447 * (bp + 1) thru endp is the beginning of the
3448 * current line we have in sb
3450 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
3451 scanp = bp;
3452 endp = bp + 1;
3454 ret = show_one_reflog_ent(&sb, fn, cb_data);
3455 strbuf_reset(&sb);
3456 if (ret)
3457 break;
3461 if (!ret && sb.len)
3462 ret = show_one_reflog_ent(&sb, fn, cb_data);
3464 fclose(logfp);
3465 strbuf_release(&sb);
3466 return ret;
3469 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3471 FILE *logfp;
3472 struct strbuf sb = STRBUF_INIT;
3473 int ret = 0;
3475 logfp = fopen(git_path("logs/%s", refname), "r");
3476 if (!logfp)
3477 return -1;
3479 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
3480 ret = show_one_reflog_ent(&sb, fn, cb_data);
3481 fclose(logfp);
3482 strbuf_release(&sb);
3483 return ret;
3486 * Call fn for each reflog in the namespace indicated by name. name
3487 * must be empty or end with '/'. Name will be used as a scratch
3488 * space, but its contents will be restored before return.
3490 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
3492 DIR *d = opendir(git_path("logs/%s", name->buf));
3493 int retval = 0;
3494 struct dirent *de;
3495 int oldlen = name->len;
3497 if (!d)
3498 return name->len ? errno : 0;
3500 while ((de = readdir(d)) != NULL) {
3501 struct stat st;
3503 if (de->d_name[0] == '.')
3504 continue;
3505 if (ends_with(de->d_name, ".lock"))
3506 continue;
3507 strbuf_addstr(name, de->d_name);
3508 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
3509 ; /* silently ignore */
3510 } else {
3511 if (S_ISDIR(st.st_mode)) {
3512 strbuf_addch(name, '/');
3513 retval = do_for_each_reflog(name, fn, cb_data);
3514 } else {
3515 unsigned char sha1[20];
3516 if (read_ref_full(name->buf, 0, sha1, NULL))
3517 retval = error("bad ref for %s", name->buf);
3518 else
3519 retval = fn(name->buf, sha1, 0, cb_data);
3521 if (retval)
3522 break;
3524 strbuf_setlen(name, oldlen);
3526 closedir(d);
3527 return retval;
3530 int for_each_reflog(each_ref_fn fn, void *cb_data)
3532 int retval;
3533 struct strbuf name;
3534 strbuf_init(&name, PATH_MAX);
3535 retval = do_for_each_reflog(&name, fn, cb_data);
3536 strbuf_release(&name);
3537 return retval;
3541 * Information needed for a single ref update. Set new_sha1 to the
3542 * new value or to zero to delete the ref. To check the old value
3543 * while locking the ref, set have_old to 1 and set old_sha1 to the
3544 * value or to zero to ensure the ref does not exist before update.
3546 struct ref_update {
3547 unsigned char new_sha1[20];
3548 unsigned char old_sha1[20];
3549 int flags; /* REF_NODEREF? */
3550 int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
3551 struct ref_lock *lock;
3552 int type;
3553 char *msg;
3554 const char refname[FLEX_ARRAY];
3558 * Transaction states.
3559 * OPEN: The transaction is in a valid state and can accept new updates.
3560 * An OPEN transaction can be committed.
3561 * CLOSED: A closed transaction is no longer active and no other operations
3562 * than free can be used on it in this state.
3563 * A transaction can either become closed by successfully committing
3564 * an active transaction or if there is a failure while building
3565 * the transaction thus rendering it failed/inactive.
3567 enum ref_transaction_state {
3568 REF_TRANSACTION_OPEN = 0,
3569 REF_TRANSACTION_CLOSED = 1
3573 * Data structure for holding a reference transaction, which can
3574 * consist of checks and updates to multiple references, carried out
3575 * as atomically as possible. This structure is opaque to callers.
3577 struct ref_transaction {
3578 struct ref_update **updates;
3579 size_t alloc;
3580 size_t nr;
3581 enum ref_transaction_state state;
3584 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3586 assert(err);
3588 return xcalloc(1, sizeof(struct ref_transaction));
3591 void ref_transaction_free(struct ref_transaction *transaction)
3593 int i;
3595 if (!transaction)
3596 return;
3598 for (i = 0; i < transaction->nr; i++) {
3599 free(transaction->updates[i]->msg);
3600 free(transaction->updates[i]);
3602 free(transaction->updates);
3603 free(transaction);
3606 static struct ref_update *add_update(struct ref_transaction *transaction,
3607 const char *refname)
3609 size_t len = strlen(refname);
3610 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);
3612 strcpy((char *)update->refname, refname);
3613 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
3614 transaction->updates[transaction->nr++] = update;
3615 return update;
3618 int ref_transaction_update(struct ref_transaction *transaction,
3619 const char *refname,
3620 const unsigned char *new_sha1,
3621 const unsigned char *old_sha1,
3622 int flags, int have_old, const char *msg,
3623 struct strbuf *err)
3625 struct ref_update *update;
3627 assert(err);
3629 if (transaction->state != REF_TRANSACTION_OPEN)
3630 die("BUG: update called for transaction that is not open");
3632 if (have_old && !old_sha1)
3633 die("BUG: have_old is true but old_sha1 is NULL");
3635 if (!is_null_sha1(new_sha1) &&
3636 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
3637 strbuf_addf(err, "refusing to update ref with bad name %s",
3638 refname);
3639 return -1;
3642 update = add_update(transaction, refname);
3643 hashcpy(update->new_sha1, new_sha1);
3644 update->flags = flags;
3645 update->have_old = have_old;
3646 if (have_old)
3647 hashcpy(update->old_sha1, old_sha1);
3648 if (msg)
3649 update->msg = xstrdup(msg);
3650 return 0;
3653 int ref_transaction_create(struct ref_transaction *transaction,
3654 const char *refname,
3655 const unsigned char *new_sha1,
3656 int flags, const char *msg,
3657 struct strbuf *err)
3659 struct ref_update *update;
3661 assert(err);
3663 if (transaction->state != REF_TRANSACTION_OPEN)
3664 die("BUG: create called for transaction that is not open");
3666 if (!new_sha1 || is_null_sha1(new_sha1))
3667 die("BUG: create ref with null new_sha1");
3669 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
3670 strbuf_addf(err, "refusing to create ref with bad name %s",
3671 refname);
3672 return -1;
3675 update = add_update(transaction, refname);
3677 hashcpy(update->new_sha1, new_sha1);
3678 hashclr(update->old_sha1);
3679 update->flags = flags;
3680 update->have_old = 1;
3681 if (msg)
3682 update->msg = xstrdup(msg);
3683 return 0;
3686 int ref_transaction_delete(struct ref_transaction *transaction,
3687 const char *refname,
3688 const unsigned char *old_sha1,
3689 int flags, int have_old, const char *msg,
3690 struct strbuf *err)
3692 struct ref_update *update;
3694 assert(err);
3696 if (transaction->state != REF_TRANSACTION_OPEN)
3697 die("BUG: delete called for transaction that is not open");
3699 if (have_old && !old_sha1)
3700 die("BUG: have_old is true but old_sha1 is NULL");
3702 update = add_update(transaction, refname);
3703 update->flags = flags;
3704 update->have_old = have_old;
3705 if (have_old) {
3706 assert(!is_null_sha1(old_sha1));
3707 hashcpy(update->old_sha1, old_sha1);
3709 if (msg)
3710 update->msg = xstrdup(msg);
3711 return 0;
3714 int update_ref(const char *action, const char *refname,
3715 const unsigned char *sha1, const unsigned char *oldval,
3716 int flags, enum action_on_err onerr)
3718 struct ref_transaction *t;
3719 struct strbuf err = STRBUF_INIT;
3721 t = ref_transaction_begin(&err);
3722 if (!t ||
3723 ref_transaction_update(t, refname, sha1, oldval, flags,
3724 !!oldval, action, &err) ||
3725 ref_transaction_commit(t, &err)) {
3726 const char *str = "update_ref failed for ref '%s': %s";
3728 ref_transaction_free(t);
3729 switch (onerr) {
3730 case UPDATE_REFS_MSG_ON_ERR:
3731 error(str, refname, err.buf);
3732 break;
3733 case UPDATE_REFS_DIE_ON_ERR:
3734 die(str, refname, err.buf);
3735 break;
3736 case UPDATE_REFS_QUIET_ON_ERR:
3737 break;
3739 strbuf_release(&err);
3740 return 1;
3742 strbuf_release(&err);
3743 ref_transaction_free(t);
3744 return 0;
3747 static int ref_update_compare(const void *r1, const void *r2)
3749 const struct ref_update * const *u1 = r1;
3750 const struct ref_update * const *u2 = r2;
3751 return strcmp((*u1)->refname, (*u2)->refname);
3754 static int ref_update_reject_duplicates(struct ref_update **updates, int n,
3755 struct strbuf *err)
3757 int i;
3759 assert(err);
3761 for (i = 1; i < n; i++)
3762 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {
3763 strbuf_addf(err,
3764 "Multiple updates for ref '%s' not allowed.",
3765 updates[i]->refname);
3766 return 1;
3768 return 0;
3771 int ref_transaction_commit(struct ref_transaction *transaction,
3772 struct strbuf *err)
3774 int ret = 0, delnum = 0, i;
3775 const char **delnames;
3776 int n = transaction->nr;
3777 struct ref_update **updates = transaction->updates;
3779 assert(err);
3781 if (transaction->state != REF_TRANSACTION_OPEN)
3782 die("BUG: commit called for transaction that is not open");
3784 if (!n) {
3785 transaction->state = REF_TRANSACTION_CLOSED;
3786 return 0;
3789 /* Allocate work space */
3790 delnames = xmalloc(sizeof(*delnames) * n);
3792 /* Copy, sort, and reject duplicate refs */
3793 qsort(updates, n, sizeof(*updates), ref_update_compare);
3794 if (ref_update_reject_duplicates(updates, n, err)) {
3795 ret = TRANSACTION_GENERIC_ERROR;
3796 goto cleanup;
3799 /* Acquire all locks while verifying old values */
3800 for (i = 0; i < n; i++) {
3801 struct ref_update *update = updates[i];
3802 int flags = update->flags;
3804 if (is_null_sha1(update->new_sha1))
3805 flags |= REF_DELETING;
3806 update->lock = lock_ref_sha1_basic(update->refname,
3807 (update->have_old ?
3808 update->old_sha1 :
3809 NULL),
3810 NULL,
3811 flags,
3812 &update->type);
3813 if (!update->lock) {
3814 ret = (errno == ENOTDIR)
3815 ? TRANSACTION_NAME_CONFLICT
3816 : TRANSACTION_GENERIC_ERROR;
3817 strbuf_addf(err, "Cannot lock the ref '%s'.",
3818 update->refname);
3819 goto cleanup;
3823 /* Perform updates first so live commits remain referenced */
3824 for (i = 0; i < n; i++) {
3825 struct ref_update *update = updates[i];
3827 if (!is_null_sha1(update->new_sha1)) {
3828 if (write_ref_sha1(update->lock, update->new_sha1,
3829 update->msg)) {
3830 update->lock = NULL; /* freed by write_ref_sha1 */
3831 strbuf_addf(err, "Cannot update the ref '%s'.",
3832 update->refname);
3833 ret = TRANSACTION_GENERIC_ERROR;
3834 goto cleanup;
3836 update->lock = NULL; /* freed by write_ref_sha1 */
3840 /* Perform deletes now that updates are safely completed */
3841 for (i = 0; i < n; i++) {
3842 struct ref_update *update = updates[i];
3844 if (update->lock) {
3845 if (delete_ref_loose(update->lock, update->type, err)) {
3846 ret = TRANSACTION_GENERIC_ERROR;
3847 goto cleanup;
3850 if (!(update->flags & REF_ISPRUNING))
3851 delnames[delnum++] = update->lock->ref_name;
3855 if (repack_without_refs(delnames, delnum, err)) {
3856 ret = TRANSACTION_GENERIC_ERROR;
3857 goto cleanup;
3859 for (i = 0; i < delnum; i++)
3860 unlink_or_warn(git_path("logs/%s", delnames[i]));
3861 clear_loose_ref_cache(&ref_cache);
3863 cleanup:
3864 transaction->state = REF_TRANSACTION_CLOSED;
3866 for (i = 0; i < n; i++)
3867 if (updates[i]->lock)
3868 unlock_ref(updates[i]->lock);
3869 free(delnames);
3870 return ret;
3873 char *shorten_unambiguous_ref(const char *refname, int strict)
3875 int i;
3876 static char **scanf_fmts;
3877 static int nr_rules;
3878 char *short_name;
3880 if (!nr_rules) {
3882 * Pre-generate scanf formats from ref_rev_parse_rules[].
3883 * Generate a format suitable for scanf from a
3884 * ref_rev_parse_rules rule by interpolating "%s" at the
3885 * location of the "%.*s".
3887 size_t total_len = 0;
3888 size_t offset = 0;
3890 /* the rule list is NULL terminated, count them first */
3891 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
3892 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3893 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
3895 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
3897 offset = 0;
3898 for (i = 0; i < nr_rules; i++) {
3899 assert(offset < total_len);
3900 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
3901 offset += snprintf(scanf_fmts[i], total_len - offset,
3902 ref_rev_parse_rules[i], 2, "%s") + 1;
3906 /* bail out if there are no rules */
3907 if (!nr_rules)
3908 return xstrdup(refname);
3910 /* buffer for scanf result, at most refname must fit */
3911 short_name = xstrdup(refname);
3913 /* skip first rule, it will always match */
3914 for (i = nr_rules - 1; i > 0 ; --i) {
3915 int j;
3916 int rules_to_fail = i;
3917 int short_name_len;
3919 if (1 != sscanf(refname, scanf_fmts[i], short_name))
3920 continue;
3922 short_name_len = strlen(short_name);
3925 * in strict mode, all (except the matched one) rules
3926 * must fail to resolve to a valid non-ambiguous ref
3928 if (strict)
3929 rules_to_fail = nr_rules;
3932 * check if the short name resolves to a valid ref,
3933 * but use only rules prior to the matched one
3935 for (j = 0; j < rules_to_fail; j++) {
3936 const char *rule = ref_rev_parse_rules[j];
3937 char refname[PATH_MAX];
3939 /* skip matched rule */
3940 if (i == j)
3941 continue;
3944 * the short name is ambiguous, if it resolves
3945 * (with this previous rule) to a valid ref
3946 * read_ref() returns 0 on success
3948 mksnpath(refname, sizeof(refname),
3949 rule, short_name_len, short_name);
3950 if (ref_exists(refname))
3951 break;
3955 * short name is non-ambiguous if all previous rules
3956 * haven't resolved to a valid ref
3958 if (j == rules_to_fail)
3959 return short_name;
3962 free(short_name);
3963 return xstrdup(refname);
3966 static struct string_list *hide_refs;
3968 int parse_hide_refs_config(const char *var, const char *value, const char *section)
3970 if (!strcmp("transfer.hiderefs", var) ||
3971 /* NEEDSWORK: use parse_config_key() once both are merged */
3972 (starts_with(var, section) && var[strlen(section)] == '.' &&
3973 !strcmp(var + strlen(section), ".hiderefs"))) {
3974 char *ref;
3975 int len;
3977 if (!value)
3978 return config_error_nonbool(var);
3979 ref = xstrdup(value);
3980 len = strlen(ref);
3981 while (len && ref[len - 1] == '/')
3982 ref[--len] = '\0';
3983 if (!hide_refs) {
3984 hide_refs = xcalloc(1, sizeof(*hide_refs));
3985 hide_refs->strdup_strings = 1;
3987 string_list_append(hide_refs, ref);
3989 return 0;
3992 int ref_is_hidden(const char *refname)
3994 struct string_list_item *item;
3996 if (!hide_refs)
3997 return 0;
3998 for_each_string_list_item(item, hide_refs) {
3999 int len;
4000 if (!starts_with(refname, item->string))
4001 continue;
4002 len = strlen(item->string);
4003 if (!refname[len] || refname[len] == '/')
4004 return 1;
4006 return 0;