4 #include "refs/refs-internal.h"
8 #include "string-list.h"
14 struct object_id old_oid;
18 * How to handle various characters in refnames:
19 * 0: An acceptable character for refs
21 * 2: ., look for a preceding . to reject .. in refs
22 * 3: {, look for a preceding @ to reject @{ in refs
23 * 4: A bad character: ASCII control characters, and
24 * ":", "?", "[", "\", "^", "~", SP, or TAB
25 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
27 static unsigned char refname_disposition[256] = {
28 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
29 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
30 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
31 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
32 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
33 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
34 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
35 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
39 * Try to read one refname component from the front of refname.
40 * Return the length of the component found, or -1 if the component is
41 * not legal. It is legal if it is something reasonable to have under
42 * ".git/refs/"; We do not like it if:
44 * - any path component of it begins with ".", or
45 * - it has double dots "..", or
46 * - it has ASCII control characters, or
47 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
48 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
49 * - it ends with a "/", or
50 * - it ends with ".lock", or
51 * - it contains a "@{" portion
53 static int check_refname_component(const char *refname, int *flags)
58 for (cp = refname; ; cp++) {
60 unsigned char disp = refname_disposition[ch];
66 return -1; /* Refname contains "..". */
70 return -1; /* Refname contains "@{". */
75 if (!(*flags & REFNAME_REFSPEC_PATTERN))
76 return -1; /* refspec can't be a pattern */
79 * Unset the pattern flag so that we only accept
80 * a single asterisk for one side of refspec.
82 *flags &= ~ REFNAME_REFSPEC_PATTERN;
89 return 0; /* Component has zero length. */
90 if (refname[0] == '.')
91 return -1; /* Component starts with '.'. */
92 if (cp - refname >= LOCK_SUFFIX_LEN &&
93 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
94 return -1; /* Refname ends with ".lock". */
98 int check_refname_format(const char *refname, int flags)
100 int component_len, component_count = 0;
102 if (!strcmp(refname, "@"))
103 /* Refname is a single character '@'. */
107 /* We are at the start of a path component. */
108 component_len = check_refname_component(refname, &flags);
109 if (component_len <= 0)
113 if (refname[component_len] == '\0')
115 /* Skip to next component. */
116 refname += component_len + 1;
119 if (refname[component_len - 1] == '.')
120 return -1; /* Refname ends with '.'. */
121 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
122 return -1; /* Refname has only one component. */
129 * Information used (along with the information in ref_entry) to
130 * describe a single cached reference. This data structure only
131 * occurs embedded in a union in struct ref_entry, and only when
132 * (ref_entry->flag & REF_DIR) is zero.
136 * The name of the object to which this reference resolves
137 * (which may be a tag object). If REF_ISBROKEN, this is
138 * null. If REF_ISSYMREF, then this is the name of the object
139 * referred to by the last reference in the symlink chain.
141 struct object_id oid;
144 * If REF_KNOWS_PEELED, then this field holds the peeled value
145 * of this reference, or null if the reference is known not to
146 * be peelable. See the documentation for peel_ref() for an
147 * exact definition of "peelable".
149 struct object_id peeled;
155 * Information used (along with the information in ref_entry) to
156 * describe a level in the hierarchy of references. This data
157 * structure only occurs embedded in a union in struct ref_entry, and
158 * only when (ref_entry.flag & REF_DIR) is set. In that case,
159 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
160 * in the directory have already been read:
162 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
163 * or packed references, already read.
165 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
166 * references that hasn't been read yet (nor has any of its
169 * Entries within a directory are stored within a growable array of
170 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
171 * sorted are sorted by their component name in strcmp() order and the
172 * remaining entries are unsorted.
174 * Loose references are read lazily, one directory at a time. When a
175 * directory of loose references is read, then all of the references
176 * in that directory are stored, and REF_INCOMPLETE stubs are created
177 * for any subdirectories, but the subdirectories themselves are not
178 * read. The reading is triggered by get_ref_dir().
184 * Entries with index 0 <= i < sorted are sorted by name. New
185 * entries are appended to the list unsorted, and are sorted
186 * only when required; thus we avoid the need to sort the list
187 * after the addition of every reference.
191 /* A pointer to the ref_cache that contains this ref_dir. */
192 struct ref_cache *ref_cache;
194 struct ref_entry **entries;
198 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
199 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
200 * public values; see refs.h.
204 * The field ref_entry->u.value.peeled of this value entry contains
205 * the correct peeled value for the reference, which might be
206 * null_sha1 if the reference is not a tag or if it is broken.
208 #define REF_KNOWS_PEELED 0x10
210 /* ref_entry represents a directory of references */
214 * Entry has not yet been read from disk (used only for REF_DIR
215 * entries representing loose references)
217 #define REF_INCOMPLETE 0x40
220 * A ref_entry represents either a reference or a "subdirectory" of
223 * Each directory in the reference namespace is represented by a
224 * ref_entry with (flags & REF_DIR) set and containing a subdir member
225 * that holds the entries in that directory that have been read so
226 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
227 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
228 * used for loose reference directories.
230 * References are represented by a ref_entry with (flags & REF_DIR)
231 * unset and a value member that describes the reference's value. The
232 * flag member is at the ref_entry level, but it is also needed to
233 * interpret the contents of the value field (in other words, a
234 * ref_value object is not very much use without the enclosing
237 * Reference names cannot end with slash and directories' names are
238 * always stored with a trailing slash (except for the top-level
239 * directory, which is always denoted by ""). This has two nice
240 * consequences: (1) when the entries in each subdir are sorted
241 * lexicographically by name (as they usually are), the references in
242 * a whole tree can be generated in lexicographic order by traversing
243 * the tree in left-to-right, depth-first order; (2) the names of
244 * references and subdirectories cannot conflict, and therefore the
245 * presence of an empty subdirectory does not block the creation of a
246 * similarly-named reference. (The fact that reference names with the
247 * same leading components can conflict *with each other* is a
248 * separate issue that is regulated by verify_refname_available().)
250 * Please note that the name field contains the fully-qualified
251 * reference (or subdirectory) name. Space could be saved by only
252 * storing the relative names. But that would require the full names
253 * to be generated on the fly when iterating in do_for_each_ref(), and
254 * would break callback functions, who have always been able to assume
255 * that the name strings that they are passed will not be freed during
259 unsigned char flag; /* ISSYMREF? ISPACKED? */
261 struct ref_value value; /* if not (flags&REF_DIR) */
262 struct ref_dir subdir; /* if (flags&REF_DIR) */
265 * The full name of the reference (e.g., "refs/heads/master")
266 * or the full name of the directory with a trailing slash
267 * (e.g., "refs/heads/"):
269 char name[FLEX_ARRAY];
272 static void read_loose_refs(const char *dirname, struct ref_dir *dir);
273 static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len);
274 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
275 const char *dirname, size_t len,
277 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry);
279 static struct ref_dir *get_ref_dir(struct ref_entry *entry)
282 assert(entry->flag & REF_DIR);
283 dir = &entry->u.subdir;
284 if (entry->flag & REF_INCOMPLETE) {
285 read_loose_refs(entry->name, dir);
288 * Manually add refs/bisect, which, being
289 * per-worktree, might not appear in the directory
290 * listing for refs/ in the main repo.
292 if (!strcmp(entry->name, "refs/")) {
293 int pos = search_ref_dir(dir, "refs/bisect/", 12);
295 struct ref_entry *child_entry;
296 child_entry = create_dir_entry(dir->ref_cache,
299 add_entry_to_dir(dir, child_entry);
300 read_loose_refs("refs/bisect",
301 &child_entry->u.subdir);
304 entry->flag &= ~REF_INCOMPLETE;
309 int refname_is_safe(const char *refname)
311 if (starts_with(refname, "refs/")) {
315 buf = xmalloc(strlen(refname) + 1);
317 * Does the refname try to escape refs/?
318 * For example: refs/foo/../bar is safe but refs/foo/../../bar
321 result = !normalize_path_copy(buf, refname + strlen("refs/"));
326 if (!isupper(*refname) && *refname != '_')
333 static struct ref_entry *create_ref_entry(const char *refname,
334 const unsigned char *sha1, int flag,
338 struct ref_entry *ref;
341 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
342 die("Reference has invalid format: '%s'", refname);
343 len = strlen(refname) + 1;
344 ref = xmalloc(sizeof(struct ref_entry) + len);
345 hashcpy(ref->u.value.oid.hash, sha1);
346 oidclr(&ref->u.value.peeled);
347 memcpy(ref->name, refname, len);
352 static void clear_ref_dir(struct ref_dir *dir);
354 static void free_ref_entry(struct ref_entry *entry)
356 if (entry->flag & REF_DIR) {
358 * Do not use get_ref_dir() here, as that might
359 * trigger the reading of loose refs.
361 clear_ref_dir(&entry->u.subdir);
367 * Add a ref_entry to the end of dir (unsorted). Entry is always
368 * stored directly in dir; no recursion into subdirectories is
371 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
373 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
374 dir->entries[dir->nr++] = entry;
375 /* optimize for the case that entries are added in order */
377 (dir->nr == dir->sorted + 1 &&
378 strcmp(dir->entries[dir->nr - 2]->name,
379 dir->entries[dir->nr - 1]->name) < 0))
380 dir->sorted = dir->nr;
384 * Clear and free all entries in dir, recursively.
386 static void clear_ref_dir(struct ref_dir *dir)
389 for (i = 0; i < dir->nr; i++)
390 free_ref_entry(dir->entries[i]);
392 dir->sorted = dir->nr = dir->alloc = 0;
397 * Create a struct ref_entry object for the specified dirname.
398 * dirname is the name of the directory with a trailing slash (e.g.,
399 * "refs/heads/") or "" for the top-level directory.
401 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
402 const char *dirname, size_t len,
405 struct ref_entry *direntry;
406 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
407 memcpy(direntry->name, dirname, len);
408 direntry->name[len] = '\0';
409 direntry->u.subdir.ref_cache = ref_cache;
410 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
414 static int ref_entry_cmp(const void *a, const void *b)
416 struct ref_entry *one = *(struct ref_entry **)a;
417 struct ref_entry *two = *(struct ref_entry **)b;
418 return strcmp(one->name, two->name);
421 static void sort_ref_dir(struct ref_dir *dir);
423 struct string_slice {
428 static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
430 const struct string_slice *key = key_;
431 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
432 int cmp = strncmp(key->str, ent->name, key->len);
435 return '\0' - (unsigned char)ent->name[key->len];
439 * Return the index of the entry with the given refname from the
440 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
441 * no such entry is found. dir must already be complete.
443 static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
445 struct ref_entry **r;
446 struct string_slice key;
448 if (refname == NULL || !dir->nr)
454 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
455 ref_entry_cmp_sslice);
460 return r - dir->entries;
464 * Search for a directory entry directly within dir (without
465 * recursing). Sort dir if necessary. subdirname must be a directory
466 * name (i.e., end in '/'). If mkdir is set, then create the
467 * directory if it is missing; otherwise, return NULL if the desired
468 * directory cannot be found. dir must already be complete.
470 static struct ref_dir *search_for_subdir(struct ref_dir *dir,
471 const char *subdirname, size_t len,
474 int entry_index = search_ref_dir(dir, subdirname, len);
475 struct ref_entry *entry;
476 if (entry_index == -1) {
480 * Since dir is complete, the absence of a subdir
481 * means that the subdir really doesn't exist;
482 * therefore, create an empty record for it but mark
483 * the record complete.
485 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
486 add_entry_to_dir(dir, entry);
488 entry = dir->entries[entry_index];
490 return get_ref_dir(entry);
494 * If refname is a reference name, find the ref_dir within the dir
495 * tree that should hold refname. If refname is a directory name
496 * (i.e., ends in '/'), then return that ref_dir itself. dir must
497 * represent the top-level directory and must already be complete.
498 * Sort ref_dirs and recurse into subdirectories as necessary. If
499 * mkdir is set, then create any missing directories; otherwise,
500 * return NULL if the desired directory cannot be found.
502 static struct ref_dir *find_containing_dir(struct ref_dir *dir,
503 const char *refname, int mkdir)
506 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
507 size_t dirnamelen = slash - refname + 1;
508 struct ref_dir *subdir;
509 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
521 * Find the value entry with the given name in dir, sorting ref_dirs
522 * and recursing into subdirectories as necessary. If the name is not
523 * found or it corresponds to a directory entry, return NULL.
525 static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
528 struct ref_entry *entry;
529 dir = find_containing_dir(dir, refname, 0);
532 entry_index = search_ref_dir(dir, refname, strlen(refname));
533 if (entry_index == -1)
535 entry = dir->entries[entry_index];
536 return (entry->flag & REF_DIR) ? NULL : entry;
540 * Remove the entry with the given name from dir, recursing into
541 * subdirectories as necessary. If refname is the name of a directory
542 * (i.e., ends with '/'), then remove the directory and its contents.
543 * If the removal was successful, return the number of entries
544 * remaining in the directory entry that contained the deleted entry.
545 * If the name was not found, return -1. Please note that this
546 * function only deletes the entry from the cache; it does not delete
547 * it from the filesystem or ensure that other cache entries (which
548 * might be symbolic references to the removed entry) are updated.
549 * Nor does it remove any containing dir entries that might be made
550 * empty by the removal. dir must represent the top-level directory
551 * and must already be complete.
553 static int remove_entry(struct ref_dir *dir, const char *refname)
555 int refname_len = strlen(refname);
557 struct ref_entry *entry;
558 int is_dir = refname[refname_len - 1] == '/';
561 * refname represents a reference directory. Remove
562 * the trailing slash; otherwise we will get the
563 * directory *representing* refname rather than the
564 * one *containing* it.
566 char *dirname = xmemdupz(refname, refname_len - 1);
567 dir = find_containing_dir(dir, dirname, 0);
570 dir = find_containing_dir(dir, refname, 0);
574 entry_index = search_ref_dir(dir, refname, refname_len);
575 if (entry_index == -1)
577 entry = dir->entries[entry_index];
579 memmove(&dir->entries[entry_index],
580 &dir->entries[entry_index + 1],
581 (dir->nr - entry_index - 1) * sizeof(*dir->entries)
584 if (dir->sorted > entry_index)
586 free_ref_entry(entry);
591 * Add a ref_entry to the ref_dir (unsorted), recursing into
592 * subdirectories as necessary. dir must represent the top-level
593 * directory. Return 0 on success.
595 static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
597 dir = find_containing_dir(dir, ref->name, 1);
600 add_entry_to_dir(dir, ref);
605 * Emit a warning and return true iff ref1 and ref2 have the same name
606 * and the same sha1. Die if they have the same name but different
609 static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
611 if (strcmp(ref1->name, ref2->name))
614 /* Duplicate name; make sure that they don't conflict: */
616 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
617 /* This is impossible by construction */
618 die("Reference directory conflict: %s", ref1->name);
620 if (oidcmp(&ref1->u.value.oid, &ref2->u.value.oid))
621 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
623 warning("Duplicated ref: %s", ref1->name);
628 * Sort the entries in dir non-recursively (if they are not already
629 * sorted) and remove any duplicate entries.
631 static void sort_ref_dir(struct ref_dir *dir)
634 struct ref_entry *last = NULL;
637 * This check also prevents passing a zero-length array to qsort(),
638 * which is a problem on some platforms.
640 if (dir->sorted == dir->nr)
643 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
645 /* Remove any duplicates: */
646 for (i = 0, j = 0; j < dir->nr; j++) {
647 struct ref_entry *entry = dir->entries[j];
648 if (last && is_dup_ref(last, entry))
649 free_ref_entry(entry);
651 last = dir->entries[i++] = entry;
653 dir->sorted = dir->nr = i;
656 /* Include broken references in a do_for_each_ref*() iteration: */
657 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
660 * Return true iff the reference described by entry can be resolved to
661 * an object in the database. Emit a warning if the referred-to
662 * object does not exist.
664 static int ref_resolves_to_object(struct ref_entry *entry)
666 if (entry->flag & REF_ISBROKEN)
668 if (!has_sha1_file(entry->u.value.oid.hash)) {
669 error("%s does not point to a valid object!", entry->name);
676 * current_ref is a performance hack: when iterating over references
677 * using the for_each_ref*() functions, current_ref is set to the
678 * current reference's entry before calling the callback function. If
679 * the callback function calls peel_ref(), then peel_ref() first
680 * checks whether the reference to be peeled is the current reference
681 * (it usually is) and if so, returns that reference's peeled version
682 * if it is available. This avoids a refname lookup in a common case.
684 static struct ref_entry *current_ref;
686 typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);
688 struct ref_entry_cb {
697 * Handle one reference in a do_for_each_ref*()-style iteration,
698 * calling an each_ref_fn for each entry.
700 static int do_one_ref(struct ref_entry *entry, void *cb_data)
702 struct ref_entry_cb *data = cb_data;
703 struct ref_entry *old_current_ref;
706 if (!starts_with(entry->name, data->base))
709 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
710 !ref_resolves_to_object(entry))
713 /* Store the old value, in case this is a recursive call: */
714 old_current_ref = current_ref;
716 retval = data->fn(entry->name + data->trim, &entry->u.value.oid,
717 entry->flag, data->cb_data);
718 current_ref = old_current_ref;
723 * Call fn for each reference in dir that has index in the range
724 * offset <= index < dir->nr. Recurse into subdirectories that are in
725 * that index range, sorting them before iterating. This function
726 * does not sort dir itself; it should be sorted beforehand. fn is
727 * called for all references, including broken ones.
729 static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
730 each_ref_entry_fn fn, void *cb_data)
733 assert(dir->sorted == dir->nr);
734 for (i = offset; i < dir->nr; i++) {
735 struct ref_entry *entry = dir->entries[i];
737 if (entry->flag & REF_DIR) {
738 struct ref_dir *subdir = get_ref_dir(entry);
739 sort_ref_dir(subdir);
740 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
742 retval = fn(entry, cb_data);
751 * Call fn for each reference in the union of dir1 and dir2, in order
752 * by refname. Recurse into subdirectories. If a value entry appears
753 * in both dir1 and dir2, then only process the version that is in
754 * dir2. The input dirs must already be sorted, but subdirs will be
755 * sorted as needed. fn is called for all references, including
758 static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
759 struct ref_dir *dir2,
760 each_ref_entry_fn fn, void *cb_data)
765 assert(dir1->sorted == dir1->nr);
766 assert(dir2->sorted == dir2->nr);
768 struct ref_entry *e1, *e2;
770 if (i1 == dir1->nr) {
771 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
773 if (i2 == dir2->nr) {
774 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
776 e1 = dir1->entries[i1];
777 e2 = dir2->entries[i2];
778 cmp = strcmp(e1->name, e2->name);
780 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
781 /* Both are directories; descend them in parallel. */
782 struct ref_dir *subdir1 = get_ref_dir(e1);
783 struct ref_dir *subdir2 = get_ref_dir(e2);
784 sort_ref_dir(subdir1);
785 sort_ref_dir(subdir2);
786 retval = do_for_each_entry_in_dirs(
787 subdir1, subdir2, fn, cb_data);
790 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
791 /* Both are references; ignore the one from dir1. */
792 retval = fn(e2, cb_data);
796 die("conflict between reference and directory: %s",
808 if (e->flag & REF_DIR) {
809 struct ref_dir *subdir = get_ref_dir(e);
810 sort_ref_dir(subdir);
811 retval = do_for_each_entry_in_dir(
812 subdir, 0, fn, cb_data);
814 retval = fn(e, cb_data);
823 * Load all of the refs from the dir into our in-memory cache. The hard work
824 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
825 * through all of the sub-directories. We do not even need to care about
826 * sorting, as traversal order does not matter to us.
828 static void prime_ref_dir(struct ref_dir *dir)
831 for (i = 0; i < dir->nr; i++) {
832 struct ref_entry *entry = dir->entries[i];
833 if (entry->flag & REF_DIR)
834 prime_ref_dir(get_ref_dir(entry));
838 struct nonmatching_ref_data {
839 const struct string_list *skip;
840 const char *conflicting_refname;
843 static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata)
845 struct nonmatching_ref_data *data = vdata;
847 if (data->skip && string_list_has_string(data->skip, entry->name))
850 data->conflicting_refname = entry->name;
855 * Return 0 if a reference named refname could be created without
856 * conflicting with the name of an existing reference in dir.
857 * See verify_refname_available for more information.
859 static int verify_refname_available_dir(const char *refname,
860 const struct string_list *extras,
861 const struct string_list *skip,
867 struct strbuf dirname = STRBUF_INIT;
871 * For the sake of comments in this function, suppose that
872 * refname is "refs/foo/bar".
877 strbuf_grow(&dirname, strlen(refname) + 1);
878 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
879 /* Expand dirname to the new prefix, not including the trailing slash: */
880 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);
883 * We are still at a leading dir of the refname (e.g.,
884 * "refs/foo"; if there is a reference with that name,
885 * it is a conflict, *unless* it is in skip.
888 pos = search_ref_dir(dir, dirname.buf, dirname.len);
890 (!skip || !string_list_has_string(skip, dirname.buf))) {
892 * We found a reference whose name is
893 * a proper prefix of refname; e.g.,
894 * "refs/foo", and is not in skip.
896 strbuf_addf(err, "'%s' exists; cannot create '%s'",
897 dirname.buf, refname);
902 if (extras && string_list_has_string(extras, dirname.buf) &&
903 (!skip || !string_list_has_string(skip, dirname.buf))) {
904 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
905 refname, dirname.buf);
910 * Otherwise, we can try to continue our search with
911 * the next component. So try to look up the
912 * directory, e.g., "refs/foo/". If we come up empty,
913 * we know there is nothing under this whole prefix,
914 * but even in that case we still have to continue the
915 * search for conflicts with extras.
917 strbuf_addch(&dirname, '/');
919 pos = search_ref_dir(dir, dirname.buf, dirname.len);
922 * There was no directory "refs/foo/",
923 * so there is nothing under this
924 * whole prefix. So there is no need
925 * to continue looking for conflicting
926 * references. But we need to continue
927 * looking for conflicting extras.
931 dir = get_ref_dir(dir->entries[pos]);
937 * We are at the leaf of our refname (e.g., "refs/foo/bar").
938 * There is no point in searching for a reference with that
939 * name, because a refname isn't considered to conflict with
940 * itself. But we still need to check for references whose
941 * names are in the "refs/foo/bar/" namespace, because they
944 strbuf_addstr(&dirname, refname + dirname.len);
945 strbuf_addch(&dirname, '/');
948 pos = search_ref_dir(dir, dirname.buf, dirname.len);
952 * We found a directory named "$refname/"
953 * (e.g., "refs/foo/bar/"). It is a problem
954 * iff it contains any ref that is not in
957 struct nonmatching_ref_data data;
960 data.conflicting_refname = NULL;
961 dir = get_ref_dir(dir->entries[pos]);
963 if (do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data)) {
964 strbuf_addf(err, "'%s' exists; cannot create '%s'",
965 data.conflicting_refname, refname);
973 * Check for entries in extras that start with
974 * "$refname/". We do that by looking for the place
975 * where "$refname/" would be inserted in extras. If
976 * there is an entry at that position that starts with
977 * "$refname/" and is not in skip, then we have a
980 for (pos = string_list_find_insert_index(extras, dirname.buf, 0);
981 pos < extras->nr; pos++) {
982 const char *extra_refname = extras->items[pos].string;
984 if (!starts_with(extra_refname, dirname.buf))
987 if (!skip || !string_list_has_string(skip, extra_refname)) {
988 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
989 refname, extra_refname);
995 /* No conflicts were found */
999 strbuf_release(&dirname);
1003 struct packed_ref_cache {
1004 struct ref_entry *root;
1007 * Count of references to the data structure in this instance,
1008 * including the pointer from ref_cache::packed if any. The
1009 * data will not be freed as long as the reference count is
1012 unsigned int referrers;
1015 * Iff the packed-refs file associated with this instance is
1016 * currently locked for writing, this points at the associated
1017 * lock (which is owned by somebody else). The referrer count
1018 * is also incremented when the file is locked and decremented
1019 * when it is unlocked.
1021 struct lock_file *lock;
1023 /* The metadata from when this packed-refs cache was read */
1024 struct stat_validity validity;
1028 * Future: need to be in "struct repository"
1029 * when doing a full libification.
1031 static struct ref_cache {
1032 struct ref_cache *next;
1033 struct ref_entry *loose;
1034 struct packed_ref_cache *packed;
1036 * The submodule name, or "" for the main repo. We allocate
1037 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1038 * is initialized correctly.
1041 } ref_cache, *submodule_ref_caches;
1043 /* Lock used for the main packed-refs file: */
1044 static struct lock_file packlock;
1047 * Increment the reference count of *packed_refs.
1049 static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
1051 packed_refs->referrers++;
1055 * Decrease the reference count of *packed_refs. If it goes to zero,
1056 * free *packed_refs and return true; otherwise return false.
1058 static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
1060 if (!--packed_refs->referrers) {
1061 free_ref_entry(packed_refs->root);
1062 stat_validity_clear(&packed_refs->validity);
1070 static void clear_packed_ref_cache(struct ref_cache *refs)
1073 struct packed_ref_cache *packed_refs = refs->packed;
1075 if (packed_refs->lock)
1076 die("internal error: packed-ref cache cleared while locked");
1077 refs->packed = NULL;
1078 release_packed_ref_cache(packed_refs);
1082 static void clear_loose_ref_cache(struct ref_cache *refs)
1085 free_ref_entry(refs->loose);
1090 static struct ref_cache *create_ref_cache(const char *submodule)
1093 struct ref_cache *refs;
1096 len = strlen(submodule) + 1;
1097 refs = xcalloc(1, sizeof(struct ref_cache) + len);
1098 memcpy(refs->name, submodule, len);
1103 * Return a pointer to a ref_cache for the specified submodule. For
1104 * the main repository, use submodule==NULL. The returned structure
1105 * will be allocated and initialized but not necessarily populated; it
1106 * should not be freed.
1108 static struct ref_cache *get_ref_cache(const char *submodule)
1110 struct ref_cache *refs;
1112 if (!submodule || !*submodule)
1115 for (refs = submodule_ref_caches; refs; refs = refs->next)
1116 if (!strcmp(submodule, refs->name))
1119 refs = create_ref_cache(submodule);
1120 refs->next = submodule_ref_caches;
1121 submodule_ref_caches = refs;
1125 /* The length of a peeled reference line in packed-refs, including EOL: */
1126 #define PEELED_LINE_LENGTH 42
1129 * The packed-refs header line that we write out. Perhaps other
1130 * traits will be added later. The trailing space is required.
1132 static const char PACKED_REFS_HEADER[] =
1133 "# pack-refs with: peeled fully-peeled \n";
1136 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1137 * Return a pointer to the refname within the line (null-terminated),
1138 * or NULL if there was a problem.
1140 static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)
1145 * 42: the answer to everything.
1147 * In this case, it happens to be the answer to
1148 * 40 (length of sha1 hex representation)
1149 * +1 (space in between hex and name)
1150 * +1 (newline at the end of the line)
1152 if (line->len <= 42)
1155 if (get_sha1_hex(line->buf, sha1) < 0)
1157 if (!isspace(line->buf[40]))
1160 ref = line->buf + 41;
1164 if (line->buf[line->len - 1] != '\n')
1166 line->buf[--line->len] = 0;
1172 * Read f, which is a packed-refs file, into dir.
1174 * A comment line of the form "# pack-refs with: " may contain zero or
1175 * more traits. We interpret the traits as follows:
1179 * Probably no references are peeled. But if the file contains a
1180 * peeled value for a reference, we will use it.
1184 * References under "refs/tags/", if they *can* be peeled, *are*
1185 * peeled in this file. References outside of "refs/tags/" are
1186 * probably not peeled even if they could have been, but if we find
1187 * a peeled value for such a reference we will use it.
1191 * All references in the file that can be peeled are peeled.
1192 * Inversely (and this is more important), any references in the
1193 * file for which no peeled value is recorded is not peelable. This
1194 * trait should typically be written alongside "peeled" for
1195 * compatibility with older clients, but we do not require it
1196 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1198 static void read_packed_refs(FILE *f, struct ref_dir *dir)
1200 struct ref_entry *last = NULL;
1201 struct strbuf line = STRBUF_INIT;
1202 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1204 while (strbuf_getwholeline(&line, f, '\n') != EOF) {
1205 unsigned char sha1[20];
1206 const char *refname;
1209 if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {
1210 if (strstr(traits, " fully-peeled "))
1211 peeled = PEELED_FULLY;
1212 else if (strstr(traits, " peeled "))
1213 peeled = PEELED_TAGS;
1214 /* perhaps other traits later as well */
1218 refname = parse_ref_line(&line, sha1);
1220 int flag = REF_ISPACKED;
1222 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1223 if (!refname_is_safe(refname))
1224 die("packed refname is dangerous: %s", refname);
1226 flag |= REF_BAD_NAME | REF_ISBROKEN;
1228 last = create_ref_entry(refname, sha1, flag, 0);
1229 if (peeled == PEELED_FULLY ||
1230 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1231 last->flag |= REF_KNOWS_PEELED;
1236 line.buf[0] == '^' &&
1237 line.len == PEELED_LINE_LENGTH &&
1238 line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&
1239 !get_sha1_hex(line.buf + 1, sha1)) {
1240 hashcpy(last->u.value.peeled.hash, sha1);
1242 * Regardless of what the file header said,
1243 * we definitely know the value of *this*
1246 last->flag |= REF_KNOWS_PEELED;
1250 strbuf_release(&line);
1254 * Get the packed_ref_cache for the specified ref_cache, creating it
1257 static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1259 char *packed_refs_file;
1262 packed_refs_file = git_pathdup_submodule(refs->name, "packed-refs");
1264 packed_refs_file = git_pathdup("packed-refs");
1267 !stat_validity_check(&refs->packed->validity, packed_refs_file))
1268 clear_packed_ref_cache(refs);
1270 if (!refs->packed) {
1273 refs->packed = xcalloc(1, sizeof(*refs->packed));
1274 acquire_packed_ref_cache(refs->packed);
1275 refs->packed->root = create_dir_entry(refs, "", 0, 0);
1276 f = fopen(packed_refs_file, "r");
1278 stat_validity_update(&refs->packed->validity, fileno(f));
1279 read_packed_refs(f, get_ref_dir(refs->packed->root));
1283 free(packed_refs_file);
1284 return refs->packed;
1287 static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1289 return get_ref_dir(packed_ref_cache->root);
1292 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1294 return get_packed_ref_dir(get_packed_ref_cache(refs));
1298 * Add a reference to the in-memory packed reference cache. This may
1299 * only be called while the packed-refs file is locked (see
1300 * lock_packed_refs()). To actually write the packed-refs file, call
1301 * commit_packed_refs().
1303 static void add_packed_ref(const char *refname, const unsigned char *sha1)
1305 struct packed_ref_cache *packed_ref_cache =
1306 get_packed_ref_cache(&ref_cache);
1308 if (!packed_ref_cache->lock)
1309 die("internal error: packed refs not locked");
1310 add_ref(get_packed_ref_dir(packed_ref_cache),
1311 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1315 * Read the loose references from the namespace dirname into dir
1316 * (without recursing). dirname must end with '/'. dir must be the
1317 * directory entry corresponding to dirname.
1319 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1321 struct ref_cache *refs = dir->ref_cache;
1324 int dirnamelen = strlen(dirname);
1325 struct strbuf refname;
1326 struct strbuf path = STRBUF_INIT;
1327 size_t path_baselen;
1330 strbuf_git_path_submodule(&path, refs->name, "%s", dirname);
1332 strbuf_git_path(&path, "%s", dirname);
1333 path_baselen = path.len;
1335 d = opendir(path.buf);
1337 strbuf_release(&path);
1341 strbuf_init(&refname, dirnamelen + 257);
1342 strbuf_add(&refname, dirname, dirnamelen);
1344 while ((de = readdir(d)) != NULL) {
1345 unsigned char sha1[20];
1349 if (de->d_name[0] == '.')
1351 if (ends_with(de->d_name, ".lock"))
1353 strbuf_addstr(&refname, de->d_name);
1354 strbuf_addstr(&path, de->d_name);
1355 if (stat(path.buf, &st) < 0) {
1356 ; /* silently ignore */
1357 } else if (S_ISDIR(st.st_mode)) {
1358 strbuf_addch(&refname, '/');
1359 add_entry_to_dir(dir,
1360 create_dir_entry(refs, refname.buf,
1368 read_ok = !resolve_gitlink_ref(refs->name,
1371 read_ok = !read_ref_full(refname.buf,
1372 RESOLVE_REF_READING,
1378 flag |= REF_ISBROKEN;
1379 } else if (is_null_sha1(sha1)) {
1381 * It is so astronomically unlikely
1382 * that NULL_SHA1 is the SHA-1 of an
1383 * actual object that we consider its
1384 * appearance in a loose reference
1385 * file to be repo corruption
1386 * (probably due to a software bug).
1388 flag |= REF_ISBROKEN;
1391 if (check_refname_format(refname.buf,
1392 REFNAME_ALLOW_ONELEVEL)) {
1393 if (!refname_is_safe(refname.buf))
1394 die("loose refname is dangerous: %s", refname.buf);
1396 flag |= REF_BAD_NAME | REF_ISBROKEN;
1398 add_entry_to_dir(dir,
1399 create_ref_entry(refname.buf, sha1, flag, 0));
1401 strbuf_setlen(&refname, dirnamelen);
1402 strbuf_setlen(&path, path_baselen);
1404 strbuf_release(&refname);
1405 strbuf_release(&path);
1409 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1413 * Mark the top-level directory complete because we
1414 * are about to read the only subdirectory that can
1417 refs->loose = create_dir_entry(refs, "", 0, 0);
1419 * Create an incomplete entry for "refs/":
1421 add_entry_to_dir(get_ref_dir(refs->loose),
1422 create_dir_entry(refs, "refs/", 5, 1));
1424 return get_ref_dir(refs->loose);
1427 /* We allow "recursive" symbolic refs. Only within reason, though */
1429 #define MAXREFLEN (1024)
1432 * Called by resolve_gitlink_ref_recursive() after it failed to read
1433 * from the loose refs in ref_cache refs. Find <refname> in the
1434 * packed-refs file for the submodule.
1436 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1437 const char *refname, unsigned char *sha1)
1439 struct ref_entry *ref;
1440 struct ref_dir *dir = get_packed_refs(refs);
1442 ref = find_ref(dir, refname);
1446 hashcpy(sha1, ref->u.value.oid.hash);
1450 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1451 const char *refname, unsigned char *sha1,
1455 char buffer[128], *p;
1458 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1461 ? git_pathdup_submodule(refs->name, "%s", refname)
1462 : git_pathdup("%s", refname);
1463 fd = open(path, O_RDONLY);
1466 return resolve_gitlink_packed_ref(refs, refname, sha1);
1468 len = read(fd, buffer, sizeof(buffer)-1);
1472 while (len && isspace(buffer[len-1]))
1476 /* Was it a detached head or an old-fashioned symlink? */
1477 if (!get_sha1_hex(buffer, sha1))
1481 if (strncmp(buffer, "ref:", 4))
1487 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1490 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1492 int len = strlen(path), retval;
1494 struct ref_cache *refs;
1496 while (len && path[len-1] == '/')
1500 submodule = xstrndup(path, len);
1501 refs = get_ref_cache(submodule);
1504 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1509 * Return the ref_entry for the given refname from the packed
1510 * references. If it does not exist, return NULL.
1512 static struct ref_entry *get_packed_ref(const char *refname)
1514 return find_ref(get_packed_refs(&ref_cache), refname);
1518 * A loose ref file doesn't exist; check for a packed ref. The
1519 * options are forwarded from resolve_safe_unsafe().
1521 static int resolve_missing_loose_ref(const char *refname,
1523 unsigned char *sha1,
1526 struct ref_entry *entry;
1529 * The loose reference file does not exist; check for a packed
1532 entry = get_packed_ref(refname);
1534 hashcpy(sha1, entry->u.value.oid.hash);
1536 *flags |= REF_ISPACKED;
1539 /* The reference is not a packed reference, either. */
1540 if (resolve_flags & RESOLVE_REF_READING) {
1549 /* This function needs to return a meaningful errno on failure */
1550 static const char *resolve_ref_1(const char *refname,
1552 unsigned char *sha1,
1554 struct strbuf *sb_refname,
1555 struct strbuf *sb_path,
1556 struct strbuf *sb_contents)
1558 int depth = MAXDEPTH;
1564 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1566 *flags |= REF_BAD_NAME;
1568 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1569 !refname_is_safe(refname)) {
1574 * dwim_ref() uses REF_ISBROKEN to distinguish between
1575 * missing refs and refs that were present but invalid,
1576 * to complain about the latter to stderr.
1578 * We don't know whether the ref exists, so don't set
1594 strbuf_reset(sb_path);
1595 strbuf_git_path(sb_path, "%s", refname);
1596 path = sb_path->buf;
1599 * We might have to loop back here to avoid a race
1600 * condition: first we lstat() the file, then we try
1601 * to read it as a link or as a file. But if somebody
1602 * changes the type of the file (file <-> directory
1603 * <-> symlink) between the lstat() and reading, then
1604 * we don't want to report that as an error but rather
1605 * try again starting with the lstat().
1608 if (lstat(path, &st) < 0) {
1609 if (errno != ENOENT)
1611 if (resolve_missing_loose_ref(refname, resolve_flags,
1617 *flags |= REF_ISBROKEN;
1622 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1623 if (S_ISLNK(st.st_mode)) {
1624 strbuf_reset(sb_contents);
1625 if (strbuf_readlink(sb_contents, path, 0) < 0) {
1626 if (errno == ENOENT || errno == EINVAL)
1627 /* inconsistent with lstat; retry */
1632 if (starts_with(sb_contents->buf, "refs/") &&
1633 !check_refname_format(sb_contents->buf, 0)) {
1634 strbuf_swap(sb_refname, sb_contents);
1635 refname = sb_refname->buf;
1637 *flags |= REF_ISSYMREF;
1638 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1646 /* Is it a directory? */
1647 if (S_ISDIR(st.st_mode)) {
1653 * Anything else, just open it and try to use it as
1656 fd = open(path, O_RDONLY);
1658 if (errno == ENOENT)
1659 /* inconsistent with lstat; retry */
1664 strbuf_reset(sb_contents);
1665 if (strbuf_read(sb_contents, fd, 256) < 0) {
1666 int save_errno = errno;
1672 strbuf_rtrim(sb_contents);
1675 * Is it a symbolic ref?
1677 if (!starts_with(sb_contents->buf, "ref:")) {
1679 * Please note that FETCH_HEAD has a second
1680 * line containing other data.
1682 if (get_sha1_hex(sb_contents->buf, sha1) ||
1683 (sb_contents->buf[40] != '\0' && !isspace(sb_contents->buf[40]))) {
1685 *flags |= REF_ISBROKEN;
1692 *flags |= REF_ISBROKEN;
1697 *flags |= REF_ISSYMREF;
1698 buf = sb_contents->buf + 4;
1699 while (isspace(*buf))
1701 strbuf_reset(sb_refname);
1702 strbuf_addstr(sb_refname, buf);
1703 refname = sb_refname->buf;
1704 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1708 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1710 *flags |= REF_ISBROKEN;
1712 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1713 !refname_is_safe(buf)) {
1722 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1723 unsigned char *sha1, int *flags)
1725 static struct strbuf sb_refname = STRBUF_INIT;
1726 struct strbuf sb_contents = STRBUF_INIT;
1727 struct strbuf sb_path = STRBUF_INIT;
1730 ret = resolve_ref_1(refname, resolve_flags, sha1, flags,
1731 &sb_refname, &sb_path, &sb_contents);
1732 strbuf_release(&sb_path);
1733 strbuf_release(&sb_contents);
1737 char *resolve_refdup(const char *refname, int resolve_flags,
1738 unsigned char *sha1, int *flags)
1740 return xstrdup_or_null(resolve_ref_unsafe(refname, resolve_flags,
1744 /* The argument to filter_refs */
1746 const char *pattern;
1751 int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1753 if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
1758 int read_ref(const char *refname, unsigned char *sha1)
1760 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
1763 int ref_exists(const char *refname)
1765 unsigned char sha1[20];
1766 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
1769 static int filter_refs(const char *refname, const struct object_id *oid,
1770 int flags, void *data)
1772 struct ref_filter *filter = (struct ref_filter *)data;
1774 if (wildmatch(filter->pattern, refname, 0, NULL))
1776 return filter->fn(refname, oid, flags, filter->cb_data);
1779 enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1781 struct object *o = lookup_unknown_object(name);
1783 if (o->type == OBJ_NONE) {
1784 int type = sha1_object_info(name, NULL);
1785 if (type < 0 || !object_as_type(o, type, 0))
1786 return PEEL_INVALID;
1789 if (o->type != OBJ_TAG)
1790 return PEEL_NON_TAG;
1792 o = deref_tag_noverify(o);
1794 return PEEL_INVALID;
1796 hashcpy(sha1, o->sha1);
1801 * Peel the entry (if possible) and return its new peel_status. If
1802 * repeel is true, re-peel the entry even if there is an old peeled
1803 * value that is already stored in it.
1805 * It is OK to call this function with a packed reference entry that
1806 * might be stale and might even refer to an object that has since
1807 * been garbage-collected. In such a case, if the entry has
1808 * REF_KNOWS_PEELED then leave the status unchanged and return
1809 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1811 static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1813 enum peel_status status;
1815 if (entry->flag & REF_KNOWS_PEELED) {
1817 entry->flag &= ~REF_KNOWS_PEELED;
1818 oidclr(&entry->u.value.peeled);
1820 return is_null_oid(&entry->u.value.peeled) ?
1821 PEEL_NON_TAG : PEEL_PEELED;
1824 if (entry->flag & REF_ISBROKEN)
1826 if (entry->flag & REF_ISSYMREF)
1827 return PEEL_IS_SYMREF;
1829 status = peel_object(entry->u.value.oid.hash, entry->u.value.peeled.hash);
1830 if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1831 entry->flag |= REF_KNOWS_PEELED;
1835 int peel_ref(const char *refname, unsigned char *sha1)
1838 unsigned char base[20];
1840 if (current_ref && (current_ref->name == refname
1841 || !strcmp(current_ref->name, refname))) {
1842 if (peel_entry(current_ref, 0))
1844 hashcpy(sha1, current_ref->u.value.peeled.hash);
1848 if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1852 * If the reference is packed, read its ref_entry from the
1853 * cache in the hope that we already know its peeled value.
1854 * We only try this optimization on packed references because
1855 * (a) forcing the filling of the loose reference cache could
1856 * be expensive and (b) loose references anyway usually do not
1857 * have REF_KNOWS_PEELED.
1859 if (flag & REF_ISPACKED) {
1860 struct ref_entry *r = get_packed_ref(refname);
1862 if (peel_entry(r, 0))
1864 hashcpy(sha1, r->u.value.peeled.hash);
1869 return peel_object(base, sha1);
1872 struct warn_if_dangling_data {
1874 const char *refname;
1875 const struct string_list *refnames;
1876 const char *msg_fmt;
1879 static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
1880 int flags, void *cb_data)
1882 struct warn_if_dangling_data *d = cb_data;
1883 const char *resolves_to;
1884 struct object_id junk;
1886 if (!(flags & REF_ISSYMREF))
1889 resolves_to = resolve_ref_unsafe(refname, 0, junk.hash, NULL);
1892 ? strcmp(resolves_to, d->refname)
1893 : !string_list_has_string(d->refnames, resolves_to))) {
1897 fprintf(d->fp, d->msg_fmt, refname);
1902 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1904 struct warn_if_dangling_data data;
1907 data.refname = refname;
1908 data.refnames = NULL;
1909 data.msg_fmt = msg_fmt;
1910 for_each_rawref(warn_if_dangling_symref, &data);
1913 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
1915 struct warn_if_dangling_data data;
1918 data.refname = NULL;
1919 data.refnames = refnames;
1920 data.msg_fmt = msg_fmt;
1921 for_each_rawref(warn_if_dangling_symref, &data);
1925 * Call fn for each reference in the specified ref_cache, omitting
1926 * references not in the containing_dir of base. fn is called for all
1927 * references, including broken ones. If fn ever returns a non-zero
1928 * value, stop the iteration and return that value; otherwise, return
1931 static int do_for_each_entry(struct ref_cache *refs, const char *base,
1932 each_ref_entry_fn fn, void *cb_data)
1934 struct packed_ref_cache *packed_ref_cache;
1935 struct ref_dir *loose_dir;
1936 struct ref_dir *packed_dir;
1940 * We must make sure that all loose refs are read before accessing the
1941 * packed-refs file; this avoids a race condition in which loose refs
1942 * are migrated to the packed-refs file by a simultaneous process, but
1943 * our in-memory view is from before the migration. get_packed_ref_cache()
1944 * takes care of making sure our view is up to date with what is on
1947 loose_dir = get_loose_refs(refs);
1948 if (base && *base) {
1949 loose_dir = find_containing_dir(loose_dir, base, 0);
1952 prime_ref_dir(loose_dir);
1954 packed_ref_cache = get_packed_ref_cache(refs);
1955 acquire_packed_ref_cache(packed_ref_cache);
1956 packed_dir = get_packed_ref_dir(packed_ref_cache);
1957 if (base && *base) {
1958 packed_dir = find_containing_dir(packed_dir, base, 0);
1961 if (packed_dir && loose_dir) {
1962 sort_ref_dir(packed_dir);
1963 sort_ref_dir(loose_dir);
1964 retval = do_for_each_entry_in_dirs(
1965 packed_dir, loose_dir, fn, cb_data);
1966 } else if (packed_dir) {
1967 sort_ref_dir(packed_dir);
1968 retval = do_for_each_entry_in_dir(
1969 packed_dir, 0, fn, cb_data);
1970 } else if (loose_dir) {
1971 sort_ref_dir(loose_dir);
1972 retval = do_for_each_entry_in_dir(
1973 loose_dir, 0, fn, cb_data);
1976 release_packed_ref_cache(packed_ref_cache);
1981 * Call fn for each reference in the specified ref_cache for which the
1982 * refname begins with base. If trim is non-zero, then trim that many
1983 * characters off the beginning of each refname before passing the
1984 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1985 * broken references in the iteration. If fn ever returns a non-zero
1986 * value, stop the iteration and return that value; otherwise, return
1989 static int do_for_each_ref(struct ref_cache *refs, const char *base,
1990 each_ref_fn fn, int trim, int flags, void *cb_data)
1992 struct ref_entry_cb data;
1997 data.cb_data = cb_data;
1999 if (ref_paranoia < 0)
2000 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
2002 data.flags |= DO_FOR_EACH_INCLUDE_BROKEN;
2004 return do_for_each_entry(refs, base, do_one_ref, &data);
2007 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
2009 struct object_id oid;
2013 if (resolve_gitlink_ref(submodule, "HEAD", oid.hash) == 0)
2014 return fn("HEAD", &oid, 0, cb_data);
2019 if (!read_ref_full("HEAD", RESOLVE_REF_READING, oid.hash, &flag))
2020 return fn("HEAD", &oid, flag, cb_data);
2025 int head_ref(each_ref_fn fn, void *cb_data)
2027 return do_head_ref(NULL, fn, cb_data);
2030 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
2032 return do_head_ref(submodule, fn, cb_data);
2035 int for_each_ref(each_ref_fn fn, void *cb_data)
2037 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
2040 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
2042 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
2045 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
2047 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
2050 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken)
2052 unsigned int flag = 0;
2055 flag = DO_FOR_EACH_INCLUDE_BROKEN;
2056 return do_for_each_ref(&ref_cache, prefix, fn, 0, flag, cb_data);
2059 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
2060 each_ref_fn fn, void *cb_data)
2062 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
2065 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
2067 return for_each_ref_in("refs/tags/", fn, cb_data);
2070 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
2072 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
2075 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
2077 return for_each_ref_in("refs/heads/", fn, cb_data);
2080 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
2082 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
2085 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
2087 return for_each_ref_in("refs/remotes/", fn, cb_data);
2090 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
2092 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
2095 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
2097 return do_for_each_ref(&ref_cache, git_replace_ref_base, fn,
2098 strlen(git_replace_ref_base), 0, cb_data);
2101 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
2103 struct strbuf buf = STRBUF_INIT;
2105 struct object_id oid;
2108 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
2109 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, oid.hash, &flag))
2110 ret = fn(buf.buf, &oid, flag, cb_data);
2111 strbuf_release(&buf);
2116 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
2118 struct strbuf buf = STRBUF_INIT;
2120 strbuf_addf(&buf, "%srefs/", get_git_namespace());
2121 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
2122 strbuf_release(&buf);
2126 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
2127 const char *prefix, void *cb_data)
2129 struct strbuf real_pattern = STRBUF_INIT;
2130 struct ref_filter filter;
2133 if (!prefix && !starts_with(pattern, "refs/"))
2134 strbuf_addstr(&real_pattern, "refs/");
2136 strbuf_addstr(&real_pattern, prefix);
2137 strbuf_addstr(&real_pattern, pattern);
2139 if (!has_glob_specials(pattern)) {
2140 /* Append implied '/' '*' if not present. */
2141 strbuf_complete(&real_pattern, '/');
2142 /* No need to check for '*', there is none. */
2143 strbuf_addch(&real_pattern, '*');
2146 filter.pattern = real_pattern.buf;
2148 filter.cb_data = cb_data;
2149 ret = for_each_ref(filter_refs, &filter);
2151 strbuf_release(&real_pattern);
2155 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
2157 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
2160 int for_each_rawref(each_ref_fn fn, void *cb_data)
2162 return do_for_each_ref(&ref_cache, "", fn, 0,
2163 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
2166 const char *prettify_refname(const char *name)
2169 starts_with(name, "refs/heads/") ? 11 :
2170 starts_with(name, "refs/tags/") ? 10 :
2171 starts_with(name, "refs/remotes/") ? 13 :
2175 static const char *ref_rev_parse_rules[] = {
2180 "refs/remotes/%.*s",
2181 "refs/remotes/%.*s/HEAD",
2185 int refname_match(const char *abbrev_name, const char *full_name)
2188 const int abbrev_name_len = strlen(abbrev_name);
2190 for (p = ref_rev_parse_rules; *p; p++) {
2191 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
2199 static void unlock_ref(struct ref_lock *lock)
2201 /* Do not free lock->lk -- atexit() still looks at them */
2203 rollback_lock_file(lock->lk);
2204 free(lock->ref_name);
2205 free(lock->orig_ref_name);
2210 * Verify that the reference locked by lock has the value old_sha1.
2211 * Fail if the reference doesn't exist and mustexist is set. Return 0
2212 * on success. On error, write an error message to err, set errno, and
2213 * return a negative value.
2215 static int verify_lock(struct ref_lock *lock,
2216 const unsigned char *old_sha1, int mustexist,
2221 if (read_ref_full(lock->ref_name,
2222 mustexist ? RESOLVE_REF_READING : 0,
2223 lock->old_oid.hash, NULL)) {
2224 int save_errno = errno;
2225 strbuf_addf(err, "can't verify ref %s", lock->ref_name);
2229 if (hashcmp(lock->old_oid.hash, old_sha1)) {
2230 strbuf_addf(err, "ref %s is at %s but expected %s",
2232 sha1_to_hex(lock->old_oid.hash),
2233 sha1_to_hex(old_sha1));
2240 static int remove_empty_directories(struct strbuf *path)
2243 * we want to create a file but there is a directory there;
2244 * if that is an empty directory (or a directory that contains
2245 * only empty directories), remove them.
2247 return remove_dir_recursively(path, REMOVE_DIR_EMPTY_ONLY);
2251 * *string and *len will only be substituted, and *string returned (for
2252 * later free()ing) if the string passed in is a magic short-hand form
2255 static char *substitute_branch_name(const char **string, int *len)
2257 struct strbuf buf = STRBUF_INIT;
2258 int ret = interpret_branch_name(*string, *len, &buf);
2262 *string = strbuf_detach(&buf, &size);
2264 return (char *)*string;
2270 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
2272 char *last_branch = substitute_branch_name(&str, &len);
2277 for (p = ref_rev_parse_rules; *p; p++) {
2278 char fullref[PATH_MAX];
2279 unsigned char sha1_from_ref[20];
2280 unsigned char *this_result;
2283 this_result = refs_found ? sha1_from_ref : sha1;
2284 mksnpath(fullref, sizeof(fullref), *p, len, str);
2285 r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
2286 this_result, &flag);
2290 if (!warn_ambiguous_refs)
2292 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2293 warning("ignoring dangling symref %s.", fullref);
2294 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
2295 warning("ignoring broken ref %s.", fullref);
2302 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
2304 char *last_branch = substitute_branch_name(&str, &len);
2309 for (p = ref_rev_parse_rules; *p; p++) {
2310 unsigned char hash[20];
2311 char path[PATH_MAX];
2312 const char *ref, *it;
2314 mksnpath(path, sizeof(path), *p, len, str);
2315 ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
2319 if (reflog_exists(path))
2321 else if (strcmp(ref, path) && reflog_exists(ref))
2325 if (!logs_found++) {
2327 hashcpy(sha1, hash);
2329 if (!warn_ambiguous_refs)
2337 * Locks a ref returning the lock on success and NULL on failure.
2338 * On failure errno is set to something meaningful.
2340 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
2341 const unsigned char *old_sha1,
2342 const struct string_list *extras,
2343 const struct string_list *skip,
2344 unsigned int flags, int *type_p,
2347 struct strbuf ref_file = STRBUF_INIT;
2348 struct strbuf orig_ref_file = STRBUF_INIT;
2349 const char *orig_refname = refname;
2350 struct ref_lock *lock;
2353 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2354 int resolve_flags = 0;
2355 int attempts_remaining = 3;
2359 lock = xcalloc(1, sizeof(struct ref_lock));
2362 resolve_flags |= RESOLVE_REF_READING;
2363 if (flags & REF_DELETING) {
2364 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
2365 if (flags & REF_NODEREF)
2366 resolve_flags |= RESOLVE_REF_NO_RECURSE;
2369 refname = resolve_ref_unsafe(refname, resolve_flags,
2370 lock->old_oid.hash, &type);
2371 if (!refname && errno == EISDIR) {
2373 * we are trying to lock foo but we used to
2374 * have foo/bar which now does not exist;
2375 * it is normal for the empty directory 'foo'
2378 strbuf_git_path(&orig_ref_file, "%s", orig_refname);
2379 if (remove_empty_directories(&orig_ref_file)) {
2381 if (!verify_refname_available_dir(orig_refname, extras, skip,
2382 get_loose_refs(&ref_cache), err))
2383 strbuf_addf(err, "there are still refs under '%s'",
2387 refname = resolve_ref_unsafe(orig_refname, resolve_flags,
2388 lock->old_oid.hash, &type);
2394 if (last_errno != ENOTDIR ||
2395 !verify_refname_available_dir(orig_refname, extras, skip,
2396 get_loose_refs(&ref_cache), err))
2397 strbuf_addf(err, "unable to resolve reference %s: %s",
2398 orig_refname, strerror(last_errno));
2403 * If the ref did not exist and we are creating it, make sure
2404 * there is no existing packed ref whose name begins with our
2405 * refname, nor a packed ref whose name is a proper prefix of
2408 if (is_null_oid(&lock->old_oid) &&
2409 verify_refname_available_dir(refname, extras, skip,
2410 get_packed_refs(&ref_cache), err)) {
2411 last_errno = ENOTDIR;
2415 lock->lk = xcalloc(1, sizeof(struct lock_file));
2418 if (flags & REF_NODEREF) {
2419 refname = orig_refname;
2420 lflags |= LOCK_NO_DEREF;
2422 lock->ref_name = xstrdup(refname);
2423 lock->orig_ref_name = xstrdup(orig_refname);
2424 strbuf_git_path(&ref_file, "%s", refname);
2427 switch (safe_create_leading_directories_const(ref_file.buf)) {
2429 break; /* success */
2431 if (--attempts_remaining > 0)
2436 strbuf_addf(err, "unable to create directory for %s",
2441 if (hold_lock_file_for_update(lock->lk, ref_file.buf, lflags) < 0) {
2443 if (errno == ENOENT && --attempts_remaining > 0)
2445 * Maybe somebody just deleted one of the
2446 * directories leading to ref_file. Try
2451 unable_to_lock_message(ref_file.buf, errno, err);
2455 if (old_sha1 && verify_lock(lock, old_sha1, mustexist, err)) {
2466 strbuf_release(&ref_file);
2467 strbuf_release(&orig_ref_file);
2473 * Write an entry to the packed-refs file for the specified refname.
2474 * If peeled is non-NULL, write it as the entry's peeled value.
2476 static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2477 unsigned char *peeled)
2479 fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
2481 fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2485 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2487 static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2489 enum peel_status peel_status = peel_entry(entry, 0);
2491 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2492 error("internal error: %s is not a valid packed reference!",
2494 write_packed_entry(cb_data, entry->name, entry->u.value.oid.hash,
2495 peel_status == PEEL_PEELED ?
2496 entry->u.value.peeled.hash : NULL);
2501 * Lock the packed-refs file for writing. Flags is passed to
2502 * hold_lock_file_for_update(). Return 0 on success. On errors, set
2503 * errno appropriately and return a nonzero value.
2505 static int lock_packed_refs(int flags)
2507 static int timeout_configured = 0;
2508 static int timeout_value = 1000;
2510 struct packed_ref_cache *packed_ref_cache;
2512 if (!timeout_configured) {
2513 git_config_get_int("core.packedrefstimeout", &timeout_value);
2514 timeout_configured = 1;
2517 if (hold_lock_file_for_update_timeout(
2518 &packlock, git_path("packed-refs"),
2519 flags, timeout_value) < 0)
2522 * Get the current packed-refs while holding the lock. If the
2523 * packed-refs file has been modified since we last read it,
2524 * this will automatically invalidate the cache and re-read
2525 * the packed-refs file.
2527 packed_ref_cache = get_packed_ref_cache(&ref_cache);
2528 packed_ref_cache->lock = &packlock;
2529 /* Increment the reference count to prevent it from being freed: */
2530 acquire_packed_ref_cache(packed_ref_cache);
2535 * Write the current version of the packed refs cache from memory to
2536 * disk. The packed-refs file must already be locked for writing (see
2537 * lock_packed_refs()). Return zero on success. On errors, set errno
2538 * and return a nonzero value
2540 static int commit_packed_refs(void)
2542 struct packed_ref_cache *packed_ref_cache =
2543 get_packed_ref_cache(&ref_cache);
2548 if (!packed_ref_cache->lock)
2549 die("internal error: packed-refs not locked");
2551 out = fdopen_lock_file(packed_ref_cache->lock, "w");
2553 die_errno("unable to fdopen packed-refs descriptor");
2555 fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2556 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2557 0, write_packed_entry_fn, out);
2559 if (commit_lock_file(packed_ref_cache->lock)) {
2563 packed_ref_cache->lock = NULL;
2564 release_packed_ref_cache(packed_ref_cache);
2570 * Rollback the lockfile for the packed-refs file, and discard the
2571 * in-memory packed reference cache. (The packed-refs file will be
2572 * read anew if it is needed again after this function is called.)
2574 static void rollback_packed_refs(void)
2576 struct packed_ref_cache *packed_ref_cache =
2577 get_packed_ref_cache(&ref_cache);
2579 if (!packed_ref_cache->lock)
2580 die("internal error: packed-refs not locked");
2581 rollback_lock_file(packed_ref_cache->lock);
2582 packed_ref_cache->lock = NULL;
2583 release_packed_ref_cache(packed_ref_cache);
2584 clear_packed_ref_cache(&ref_cache);
2587 struct ref_to_prune {
2588 struct ref_to_prune *next;
2589 unsigned char sha1[20];
2590 char name[FLEX_ARRAY];
2593 struct pack_refs_cb_data {
2595 struct ref_dir *packed_refs;
2596 struct ref_to_prune *ref_to_prune;
2600 * An each_ref_entry_fn that is run over loose references only. If
2601 * the loose reference can be packed, add an entry in the packed ref
2602 * cache. If the reference should be pruned, also add it to
2603 * ref_to_prune in the pack_refs_cb_data.
2605 static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2607 struct pack_refs_cb_data *cb = cb_data;
2608 enum peel_status peel_status;
2609 struct ref_entry *packed_entry;
2610 int is_tag_ref = starts_with(entry->name, "refs/tags/");
2612 /* Do not pack per-worktree refs: */
2613 if (ref_type(entry->name) != REF_TYPE_NORMAL)
2616 /* ALWAYS pack tags */
2617 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2620 /* Do not pack symbolic or broken refs: */
2621 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
2624 /* Add a packed ref cache entry equivalent to the loose entry. */
2625 peel_status = peel_entry(entry, 1);
2626 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2627 die("internal error peeling reference %s (%s)",
2628 entry->name, oid_to_hex(&entry->u.value.oid));
2629 packed_entry = find_ref(cb->packed_refs, entry->name);
2631 /* Overwrite existing packed entry with info from loose entry */
2632 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2633 oidcpy(&packed_entry->u.value.oid, &entry->u.value.oid);
2635 packed_entry = create_ref_entry(entry->name, entry->u.value.oid.hash,
2636 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2637 add_ref(cb->packed_refs, packed_entry);
2639 oidcpy(&packed_entry->u.value.peeled, &entry->u.value.peeled);
2641 /* Schedule the loose reference for pruning if requested. */
2642 if ((cb->flags & PACK_REFS_PRUNE)) {
2643 int namelen = strlen(entry->name) + 1;
2644 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2645 hashcpy(n->sha1, entry->u.value.oid.hash);
2646 memcpy(n->name, entry->name, namelen); /* includes NUL */
2647 n->next = cb->ref_to_prune;
2648 cb->ref_to_prune = n;
2654 * Remove empty parents, but spare refs/ and immediate subdirs.
2655 * Note: munges *name.
2657 static void try_remove_empty_parents(char *name)
2662 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2663 while (*p && *p != '/')
2665 /* tolerate duplicate slashes; see check_refname_format() */
2669 for (q = p; *q; q++)
2672 while (q > p && *q != '/')
2674 while (q > p && *(q-1) == '/')
2679 if (rmdir(git_path("%s", name)))
2684 /* make sure nobody touched the ref, and unlink */
2685 static void prune_ref(struct ref_to_prune *r)
2687 struct ref_transaction *transaction;
2688 struct strbuf err = STRBUF_INIT;
2690 if (check_refname_format(r->name, 0))
2693 transaction = ref_transaction_begin(&err);
2695 ref_transaction_delete(transaction, r->name, r->sha1,
2696 REF_ISPRUNING, NULL, &err) ||
2697 ref_transaction_commit(transaction, &err)) {
2698 ref_transaction_free(transaction);
2699 error("%s", err.buf);
2700 strbuf_release(&err);
2703 ref_transaction_free(transaction);
2704 strbuf_release(&err);
2705 try_remove_empty_parents(r->name);
2708 static void prune_refs(struct ref_to_prune *r)
2716 int pack_refs(unsigned int flags)
2718 struct pack_refs_cb_data cbdata;
2720 memset(&cbdata, 0, sizeof(cbdata));
2721 cbdata.flags = flags;
2723 lock_packed_refs(LOCK_DIE_ON_ERROR);
2724 cbdata.packed_refs = get_packed_refs(&ref_cache);
2726 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2727 pack_if_possible_fn, &cbdata);
2729 if (commit_packed_refs())
2730 die_errno("unable to overwrite old ref-pack file");
2732 prune_refs(cbdata.ref_to_prune);
2737 * Rewrite the packed-refs file, omitting any refs listed in
2738 * 'refnames'. On error, leave packed-refs unchanged, write an error
2739 * message to 'err', and return a nonzero value.
2741 * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
2743 static int repack_without_refs(struct string_list *refnames, struct strbuf *err)
2745 struct ref_dir *packed;
2746 struct string_list_item *refname;
2747 int ret, needs_repacking = 0, removed = 0;
2751 /* Look for a packed ref */
2752 for_each_string_list_item(refname, refnames) {
2753 if (get_packed_ref(refname->string)) {
2754 needs_repacking = 1;
2759 /* Avoid locking if we have nothing to do */
2760 if (!needs_repacking)
2761 return 0; /* no refname exists in packed refs */
2763 if (lock_packed_refs(0)) {
2764 unable_to_lock_message(git_path("packed-refs"), errno, err);
2767 packed = get_packed_refs(&ref_cache);
2769 /* Remove refnames from the cache */
2770 for_each_string_list_item(refname, refnames)
2771 if (remove_entry(packed, refname->string) != -1)
2775 * All packed entries disappeared while we were
2776 * acquiring the lock.
2778 rollback_packed_refs();
2782 /* Write what remains */
2783 ret = commit_packed_refs();
2785 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
2790 static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2794 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2796 * loose. The loose file name is the same as the
2797 * lockfile name, minus ".lock":
2799 char *loose_filename = get_locked_file_path(lock->lk);
2800 int res = unlink_or_msg(loose_filename, err);
2801 free(loose_filename);
2808 static int is_per_worktree_ref(const char *refname)
2810 return !strcmp(refname, "HEAD") ||
2811 starts_with(refname, "refs/bisect/");
2814 static int is_pseudoref_syntax(const char *refname)
2818 for (c = refname; *c; c++) {
2819 if (!isupper(*c) && *c != '-' && *c != '_')
2826 enum ref_type ref_type(const char *refname)
2828 if (is_per_worktree_ref(refname))
2829 return REF_TYPE_PER_WORKTREE;
2830 if (is_pseudoref_syntax(refname))
2831 return REF_TYPE_PSEUDOREF;
2832 return REF_TYPE_NORMAL;
2835 static int write_pseudoref(const char *pseudoref, const unsigned char *sha1,
2836 const unsigned char *old_sha1, struct strbuf *err)
2838 const char *filename;
2840 static struct lock_file lock;
2841 struct strbuf buf = STRBUF_INIT;
2844 strbuf_addf(&buf, "%s\n", sha1_to_hex(sha1));
2846 filename = git_path("%s", pseudoref);
2847 fd = hold_lock_file_for_update(&lock, filename, LOCK_DIE_ON_ERROR);
2849 strbuf_addf(err, "Could not open '%s' for writing: %s",
2850 filename, strerror(errno));
2855 unsigned char actual_old_sha1[20];
2857 if (read_ref(pseudoref, actual_old_sha1))
2858 die("could not read ref '%s'", pseudoref);
2859 if (hashcmp(actual_old_sha1, old_sha1)) {
2860 strbuf_addf(err, "Unexpected sha1 when writing %s", pseudoref);
2861 rollback_lock_file(&lock);
2866 if (write_in_full(fd, buf.buf, buf.len) != buf.len) {
2867 strbuf_addf(err, "Could not write to '%s'", filename);
2868 rollback_lock_file(&lock);
2872 commit_lock_file(&lock);
2875 strbuf_release(&buf);
2879 static int delete_pseudoref(const char *pseudoref, const unsigned char *old_sha1)
2881 static struct lock_file lock;
2882 const char *filename;
2884 filename = git_path("%s", pseudoref);
2886 if (old_sha1 && !is_null_sha1(old_sha1)) {
2888 unsigned char actual_old_sha1[20];
2890 fd = hold_lock_file_for_update(&lock, filename,
2893 die_errno(_("Could not open '%s' for writing"), filename);
2894 if (read_ref(pseudoref, actual_old_sha1))
2895 die("could not read ref '%s'", pseudoref);
2896 if (hashcmp(actual_old_sha1, old_sha1)) {
2897 warning("Unexpected sha1 when deleting %s", pseudoref);
2898 rollback_lock_file(&lock);
2903 rollback_lock_file(&lock);
2911 int delete_ref(const char *refname, const unsigned char *old_sha1,
2914 struct ref_transaction *transaction;
2915 struct strbuf err = STRBUF_INIT;
2917 if (ref_type(refname) == REF_TYPE_PSEUDOREF)
2918 return delete_pseudoref(refname, old_sha1);
2920 transaction = ref_transaction_begin(&err);
2922 ref_transaction_delete(transaction, refname, old_sha1,
2923 flags, NULL, &err) ||
2924 ref_transaction_commit(transaction, &err)) {
2925 error("%s", err.buf);
2926 ref_transaction_free(transaction);
2927 strbuf_release(&err);
2930 ref_transaction_free(transaction);
2931 strbuf_release(&err);
2935 int delete_refs(struct string_list *refnames)
2937 struct strbuf err = STRBUF_INIT;
2943 result = repack_without_refs(refnames, &err);
2946 * If we failed to rewrite the packed-refs file, then
2947 * it is unsafe to try to remove loose refs, because
2948 * doing so might expose an obsolete packed value for
2949 * a reference that might even point at an object that
2950 * has been garbage collected.
2952 if (refnames->nr == 1)
2953 error(_("could not delete reference %s: %s"),
2954 refnames->items[0].string, err.buf);
2956 error(_("could not delete references: %s"), err.buf);
2961 for (i = 0; i < refnames->nr; i++) {
2962 const char *refname = refnames->items[i].string;
2964 if (delete_ref(refname, NULL, 0))
2965 result |= error(_("could not remove reference %s"), refname);
2969 strbuf_release(&err);
2974 * People using contrib's git-new-workdir have .git/logs/refs ->
2975 * /some/other/path/.git/logs/refs, and that may live on another device.
2977 * IOW, to avoid cross device rename errors, the temporary renamed log must
2978 * live into logs/refs.
2980 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2982 static int rename_tmp_log(const char *newrefname)
2984 int attempts_remaining = 4;
2985 struct strbuf path = STRBUF_INIT;
2989 strbuf_reset(&path);
2990 strbuf_git_path(&path, "logs/%s", newrefname);
2991 switch (safe_create_leading_directories_const(path.buf)) {
2993 break; /* success */
2995 if (--attempts_remaining > 0)
2999 error("unable to create directory for %s", newrefname);
3003 if (rename(git_path(TMP_RENAMED_LOG), path.buf)) {
3004 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
3006 * rename(a, b) when b is an existing
3007 * directory ought to result in ISDIR, but
3008 * Solaris 5.8 gives ENOTDIR. Sheesh.
3010 if (remove_empty_directories(&path)) {
3011 error("Directory not empty: logs/%s", newrefname);
3015 } else if (errno == ENOENT && --attempts_remaining > 0) {
3017 * Maybe another process just deleted one of
3018 * the directories in the path to newrefname.
3019 * Try again from the beginning.
3023 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
3024 newrefname, strerror(errno));
3030 strbuf_release(&path);
3034 int verify_refname_available(const char *newname,
3035 struct string_list *extras,
3036 struct string_list *skip,
3039 struct ref_dir *packed_refs = get_packed_refs(&ref_cache);
3040 struct ref_dir *loose_refs = get_loose_refs(&ref_cache);
3042 if (verify_refname_available_dir(newname, extras, skip,
3043 packed_refs, err) ||
3044 verify_refname_available_dir(newname, extras, skip,
3051 static int rename_ref_available(const char *oldname, const char *newname)
3053 struct string_list skip = STRING_LIST_INIT_NODUP;
3054 struct strbuf err = STRBUF_INIT;
3057 string_list_insert(&skip, oldname);
3058 ret = !verify_refname_available(newname, NULL, &skip, &err);
3060 error("%s", err.buf);
3062 string_list_clear(&skip, 0);
3063 strbuf_release(&err);
3067 static int write_ref_to_lockfile(struct ref_lock *lock,
3068 const unsigned char *sha1, struct strbuf *err);
3069 static int commit_ref_update(struct ref_lock *lock,
3070 const unsigned char *sha1, const char *logmsg,
3071 int flags, struct strbuf *err);
3073 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
3075 unsigned char sha1[20], orig_sha1[20];
3076 int flag = 0, logmoved = 0;
3077 struct ref_lock *lock;
3078 struct stat loginfo;
3079 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
3080 const char *symref = NULL;
3081 struct strbuf err = STRBUF_INIT;
3083 if (log && S_ISLNK(loginfo.st_mode))
3084 return error("reflog for %s is a symlink", oldrefname);
3086 symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,
3088 if (flag & REF_ISSYMREF)
3089 return error("refname %s is a symbolic ref, renaming it is not supported",
3092 return error("refname %s not found", oldrefname);
3094 if (!rename_ref_available(oldrefname, newrefname))
3097 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
3098 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
3099 oldrefname, strerror(errno));
3101 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
3102 error("unable to delete old %s", oldrefname);
3106 if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&
3107 delete_ref(newrefname, sha1, REF_NODEREF)) {
3108 if (errno==EISDIR) {
3109 struct strbuf path = STRBUF_INIT;
3112 strbuf_git_path(&path, "%s", newrefname);
3113 result = remove_empty_directories(&path);
3114 strbuf_release(&path);
3117 error("Directory not empty: %s", newrefname);
3121 error("unable to delete existing %s", newrefname);
3126 if (log && rename_tmp_log(newrefname))
3131 lock = lock_ref_sha1_basic(newrefname, NULL, NULL, NULL, 0, NULL, &err);
3133 error("unable to rename '%s' to '%s': %s", oldrefname, newrefname, err.buf);
3134 strbuf_release(&err);
3137 hashcpy(lock->old_oid.hash, orig_sha1);
3139 if (write_ref_to_lockfile(lock, orig_sha1, &err) ||
3140 commit_ref_update(lock, orig_sha1, logmsg, 0, &err)) {
3141 error("unable to write current sha1 into %s: %s", newrefname, err.buf);
3142 strbuf_release(&err);
3149 lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, NULL, 0, NULL, &err);
3151 error("unable to lock %s for rollback: %s", oldrefname, err.buf);
3152 strbuf_release(&err);
3156 flag = log_all_ref_updates;
3157 log_all_ref_updates = 0;
3158 if (write_ref_to_lockfile(lock, orig_sha1, &err) ||
3159 commit_ref_update(lock, orig_sha1, NULL, 0, &err)) {
3160 error("unable to write current sha1 into %s: %s", oldrefname, err.buf);
3161 strbuf_release(&err);
3163 log_all_ref_updates = flag;
3166 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
3167 error("unable to restore logfile %s from %s: %s",
3168 oldrefname, newrefname, strerror(errno));
3169 if (!logmoved && log &&
3170 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
3171 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
3172 oldrefname, strerror(errno));
3177 static int close_ref(struct ref_lock *lock)
3179 if (close_lock_file(lock->lk))
3184 static int commit_ref(struct ref_lock *lock)
3186 if (commit_lock_file(lock->lk))
3191 int copy_reflog_msg(char *buf, const char *msg)
3198 while ((c = *msg++)) {
3199 if (wasspace && isspace(c))
3201 wasspace = isspace(c);
3206 while (buf < cp && isspace(cp[-1]))
3212 int should_autocreate_reflog(const char *refname)
3214 if (!log_all_ref_updates)
3216 return starts_with(refname, "refs/heads/") ||
3217 starts_with(refname, "refs/remotes/") ||
3218 starts_with(refname, "refs/notes/") ||
3219 !strcmp(refname, "HEAD");
3223 * Create a reflog for a ref. If force_create = 0, the reflog will
3224 * only be created for certain refs (those for which
3225 * should_autocreate_reflog returns non-zero. Otherwise, create it
3226 * regardless of the ref name. Fill in *err and return -1 on failure.
3228 static int log_ref_setup(const char *refname, struct strbuf *logfile, struct strbuf *err, int force_create)
3230 int logfd, oflags = O_APPEND | O_WRONLY;
3232 strbuf_git_path(logfile, "logs/%s", refname);
3233 if (force_create || should_autocreate_reflog(refname)) {
3234 if (safe_create_leading_directories(logfile->buf) < 0) {
3235 strbuf_addf(err, "unable to create directory for %s: "
3236 "%s", logfile->buf, strerror(errno));
3242 logfd = open(logfile->buf, oflags, 0666);
3244 if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))
3247 if (errno == EISDIR) {
3248 if (remove_empty_directories(logfile)) {
3249 strbuf_addf(err, "There are still logs under "
3250 "'%s'", logfile->buf);
3253 logfd = open(logfile->buf, oflags, 0666);
3257 strbuf_addf(err, "unable to append to %s: %s",
3258 logfile->buf, strerror(errno));
3263 adjust_shared_perm(logfile->buf);
3269 int safe_create_reflog(const char *refname, int force_create, struct strbuf *err)
3272 struct strbuf sb = STRBUF_INIT;
3274 ret = log_ref_setup(refname, &sb, err, force_create);
3275 strbuf_release(&sb);
3279 static int log_ref_write_fd(int fd, const unsigned char *old_sha1,
3280 const unsigned char *new_sha1,
3281 const char *committer, const char *msg)
3283 int msglen, written;
3284 unsigned maxlen, len;
3287 msglen = msg ? strlen(msg) : 0;
3288 maxlen = strlen(committer) + msglen + 100;
3289 logrec = xmalloc(maxlen);
3290 len = xsnprintf(logrec, maxlen, "%s %s %s\n",
3291 sha1_to_hex(old_sha1),
3292 sha1_to_hex(new_sha1),
3295 len += copy_reflog_msg(logrec + len - 1, msg) - 1;
3297 written = len <= maxlen ? write_in_full(fd, logrec, len) : -1;
3305 static int log_ref_write_1(const char *refname, const unsigned char *old_sha1,
3306 const unsigned char *new_sha1, const char *msg,
3307 struct strbuf *logfile, int flags,
3310 int logfd, result, oflags = O_APPEND | O_WRONLY;
3312 if (log_all_ref_updates < 0)
3313 log_all_ref_updates = !is_bare_repository();
3315 result = log_ref_setup(refname, logfile, err, flags & REF_FORCE_CREATE_REFLOG);
3320 logfd = open(logfile->buf, oflags);
3323 result = log_ref_write_fd(logfd, old_sha1, new_sha1,
3324 git_committer_info(0), msg);
3326 strbuf_addf(err, "unable to append to %s: %s", logfile->buf,
3332 strbuf_addf(err, "unable to append to %s: %s", logfile->buf,
3339 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
3340 const unsigned char *new_sha1, const char *msg,
3341 int flags, struct strbuf *err)
3343 struct strbuf sb = STRBUF_INIT;
3344 int ret = log_ref_write_1(refname, old_sha1, new_sha1, msg, &sb, flags,
3346 strbuf_release(&sb);
3350 int is_branch(const char *refname)
3352 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
3356 * Write sha1 into the open lockfile, then close the lockfile. On
3357 * errors, rollback the lockfile, fill in *err and
3360 static int write_ref_to_lockfile(struct ref_lock *lock,
3361 const unsigned char *sha1, struct strbuf *err)
3363 static char term = '\n';
3367 o = parse_object(sha1);
3370 "Trying to write ref %s with nonexistent object %s",
3371 lock->ref_name, sha1_to_hex(sha1));
3375 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
3377 "Trying to write non-commit object %s to branch %s",
3378 sha1_to_hex(sha1), lock->ref_name);
3382 fd = get_lock_file_fd(lock->lk);
3383 if (write_in_full(fd, sha1_to_hex(sha1), 40) != 40 ||
3384 write_in_full(fd, &term, 1) != 1 ||
3385 close_ref(lock) < 0) {
3387 "Couldn't write %s", get_lock_file_path(lock->lk));
3395 * Commit a change to a loose reference that has already been written
3396 * to the loose reference lockfile. Also update the reflogs if
3397 * necessary, using the specified lockmsg (which can be NULL).
3399 static int commit_ref_update(struct ref_lock *lock,
3400 const unsigned char *sha1, const char *logmsg,
3401 int flags, struct strbuf *err)
3403 clear_loose_ref_cache(&ref_cache);
3404 if (log_ref_write(lock->ref_name, lock->old_oid.hash, sha1, logmsg, flags, err) < 0 ||
3405 (strcmp(lock->ref_name, lock->orig_ref_name) &&
3406 log_ref_write(lock->orig_ref_name, lock->old_oid.hash, sha1, logmsg, flags, err) < 0)) {
3407 char *old_msg = strbuf_detach(err, NULL);
3408 strbuf_addf(err, "Cannot update the ref '%s': %s",
3409 lock->ref_name, old_msg);
3414 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
3416 * Special hack: If a branch is updated directly and HEAD
3417 * points to it (may happen on the remote side of a push
3418 * for example) then logically the HEAD reflog should be
3420 * A generic solution implies reverse symref information,
3421 * but finding all symrefs pointing to the given branch
3422 * would be rather costly for this rare event (the direct
3423 * update of a branch) to be worth it. So let's cheat and
3424 * check with HEAD only which should cover 99% of all usage
3425 * scenarios (even 100% of the default ones).
3427 unsigned char head_sha1[20];
3429 const char *head_ref;
3430 head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
3431 head_sha1, &head_flag);
3432 if (head_ref && (head_flag & REF_ISSYMREF) &&
3433 !strcmp(head_ref, lock->ref_name)) {
3434 struct strbuf log_err = STRBUF_INIT;
3435 if (log_ref_write("HEAD", lock->old_oid.hash, sha1,
3436 logmsg, 0, &log_err)) {
3437 error("%s", log_err.buf);
3438 strbuf_release(&log_err);
3442 if (commit_ref(lock)) {
3443 error("Couldn't set %s", lock->ref_name);
3452 int create_symref(const char *ref_target, const char *refs_heads_master,
3455 char *lockpath = NULL;
3457 int fd, len, written;
3458 char *git_HEAD = git_pathdup("%s", ref_target);
3459 unsigned char old_sha1[20], new_sha1[20];
3460 struct strbuf err = STRBUF_INIT;
3462 if (logmsg && read_ref(ref_target, old_sha1))
3465 if (safe_create_leading_directories(git_HEAD) < 0)
3466 return error("unable to create directory for %s", git_HEAD);
3468 #ifndef NO_SYMLINK_HEAD
3469 if (prefer_symlink_refs) {
3471 if (!symlink(refs_heads_master, git_HEAD))
3473 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
3477 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
3478 if (sizeof(ref) <= len) {
3479 error("refname too long: %s", refs_heads_master);
3480 goto error_free_return;
3482 lockpath = mkpathdup("%s.lock", git_HEAD);
3483 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
3485 error("Unable to open %s for writing", lockpath);
3486 goto error_free_return;
3488 written = write_in_full(fd, ref, len);
3489 if (close(fd) != 0 || written != len) {
3490 error("Unable to write to %s", lockpath);
3491 goto error_unlink_return;
3493 if (rename(lockpath, git_HEAD) < 0) {
3494 error("Unable to create %s", git_HEAD);
3495 goto error_unlink_return;
3497 if (adjust_shared_perm(git_HEAD)) {
3498 error("Unable to fix permissions on %s", lockpath);
3499 error_unlink_return:
3500 unlink_or_warn(lockpath);
3508 #ifndef NO_SYMLINK_HEAD
3511 if (logmsg && !read_ref(refs_heads_master, new_sha1) &&
3512 log_ref_write(ref_target, old_sha1, new_sha1, logmsg, 0, &err)) {
3513 error("%s", err.buf);
3514 strbuf_release(&err);
3521 struct read_ref_at_cb {
3522 const char *refname;
3523 unsigned long at_time;
3526 unsigned char *sha1;
3529 unsigned char osha1[20];
3530 unsigned char nsha1[20];
3534 unsigned long *cutoff_time;
3539 static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,
3540 const char *email, unsigned long timestamp, int tz,
3541 const char *message, void *cb_data)
3543 struct read_ref_at_cb *cb = cb_data;
3547 cb->date = timestamp;
3549 if (timestamp <= cb->at_time || cb->cnt == 0) {
3551 *cb->msg = xstrdup(message);
3552 if (cb->cutoff_time)
3553 *cb->cutoff_time = timestamp;
3555 *cb->cutoff_tz = tz;
3557 *cb->cutoff_cnt = cb->reccnt - 1;
3559 * we have not yet updated cb->[n|o]sha1 so they still
3560 * hold the values for the previous record.
3562 if (!is_null_sha1(cb->osha1)) {
3563 hashcpy(cb->sha1, nsha1);
3564 if (hashcmp(cb->osha1, nsha1))
3565 warning("Log for ref %s has gap after %s.",
3566 cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
3568 else if (cb->date == cb->at_time)
3569 hashcpy(cb->sha1, nsha1);
3570 else if (hashcmp(nsha1, cb->sha1))
3571 warning("Log for ref %s unexpectedly ended on %s.",
3572 cb->refname, show_date(cb->date, cb->tz,
3573 DATE_MODE(RFC2822)));
3574 hashcpy(cb->osha1, osha1);
3575 hashcpy(cb->nsha1, nsha1);
3579 hashcpy(cb->osha1, osha1);
3580 hashcpy(cb->nsha1, nsha1);
3586 static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,
3587 const char *email, unsigned long timestamp,
3588 int tz, const char *message, void *cb_data)
3590 struct read_ref_at_cb *cb = cb_data;
3593 *cb->msg = xstrdup(message);
3594 if (cb->cutoff_time)
3595 *cb->cutoff_time = timestamp;
3597 *cb->cutoff_tz = tz;
3599 *cb->cutoff_cnt = cb->reccnt;
3600 hashcpy(cb->sha1, osha1);
3601 if (is_null_sha1(cb->sha1))
3602 hashcpy(cb->sha1, nsha1);
3603 /* We just want the first entry */
3607 int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
3608 unsigned char *sha1, char **msg,
3609 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3611 struct read_ref_at_cb cb;
3613 memset(&cb, 0, sizeof(cb));
3614 cb.refname = refname;
3615 cb.at_time = at_time;
3618 cb.cutoff_time = cutoff_time;
3619 cb.cutoff_tz = cutoff_tz;
3620 cb.cutoff_cnt = cutoff_cnt;
3623 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
3626 if (flags & GET_SHA1_QUIETLY)
3629 die("Log for %s is empty.", refname);
3634 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3639 int reflog_exists(const char *refname)
3643 return !lstat(git_path("logs/%s", refname), &st) &&
3644 S_ISREG(st.st_mode);
3647 int delete_reflog(const char *refname)
3649 return remove_path(git_path("logs/%s", refname));
3652 static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
3654 unsigned char osha1[20], nsha1[20];
3655 char *email_end, *message;
3656 unsigned long timestamp;
3659 /* old SP new SP name <email> SP time TAB msg LF */
3660 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
3661 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
3662 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
3663 !(email_end = strchr(sb->buf + 82, '>')) ||
3664 email_end[1] != ' ' ||
3665 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
3666 !message || message[0] != ' ' ||
3667 (message[1] != '+' && message[1] != '-') ||
3668 !isdigit(message[2]) || !isdigit(message[3]) ||
3669 !isdigit(message[4]) || !isdigit(message[5]))
3670 return 0; /* corrupt? */
3671 email_end[1] = '\0';
3672 tz = strtol(message + 1, NULL, 10);
3673 if (message[6] != '\t')
3677 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
3680 static char *find_beginning_of_line(char *bob, char *scan)
3682 while (bob < scan && *(--scan) != '\n')
3683 ; /* keep scanning backwards */
3685 * Return either beginning of the buffer, or LF at the end of
3686 * the previous line.
3691 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3693 struct strbuf sb = STRBUF_INIT;
3696 int ret = 0, at_tail = 1;
3698 logfp = fopen(git_path("logs/%s", refname), "r");
3702 /* Jump to the end */
3703 if (fseek(logfp, 0, SEEK_END) < 0)
3704 return error("cannot seek back reflog for %s: %s",
3705 refname, strerror(errno));
3707 while (!ret && 0 < pos) {
3713 /* Fill next block from the end */
3714 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
3715 if (fseek(logfp, pos - cnt, SEEK_SET))
3716 return error("cannot seek back reflog for %s: %s",
3717 refname, strerror(errno));
3718 nread = fread(buf, cnt, 1, logfp);
3720 return error("cannot read %d bytes from reflog for %s: %s",
3721 cnt, refname, strerror(errno));
3724 scanp = endp = buf + cnt;
3725 if (at_tail && scanp[-1] == '\n')
3726 /* Looking at the final LF at the end of the file */
3730 while (buf < scanp) {
3732 * terminating LF of the previous line, or the beginning
3737 bp = find_beginning_of_line(buf, scanp);
3741 * The newline is the end of the previous line,
3742 * so we know we have complete line starting
3743 * at (bp + 1). Prefix it onto any prior data
3744 * we collected for the line and process it.
3746 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
3749 ret = show_one_reflog_ent(&sb, fn, cb_data);
3755 * We are at the start of the buffer, and the
3756 * start of the file; there is no previous
3757 * line, and we have everything for this one.
3758 * Process it, and we can end the loop.
3760 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3761 ret = show_one_reflog_ent(&sb, fn, cb_data);
3768 * We are at the start of the buffer, and there
3769 * is more file to read backwards. Which means
3770 * we are in the middle of a line. Note that we
3771 * may get here even if *bp was a newline; that
3772 * just means we are at the exact end of the
3773 * previous line, rather than some spot in the
3776 * Save away what we have to be combined with
3777 * the data from the next read.
3779 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3786 die("BUG: reverse reflog parser had leftover data");
3789 strbuf_release(&sb);
3793 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3796 struct strbuf sb = STRBUF_INIT;
3799 logfp = fopen(git_path("logs/%s", refname), "r");
3803 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
3804 ret = show_one_reflog_ent(&sb, fn, cb_data);
3806 strbuf_release(&sb);
3810 * Call fn for each reflog in the namespace indicated by name. name
3811 * must be empty or end with '/'. Name will be used as a scratch
3812 * space, but its contents will be restored before return.
3814 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
3816 DIR *d = opendir(git_path("logs/%s", name->buf));
3819 int oldlen = name->len;
3822 return name->len ? errno : 0;
3824 while ((de = readdir(d)) != NULL) {
3827 if (de->d_name[0] == '.')
3829 if (ends_with(de->d_name, ".lock"))
3831 strbuf_addstr(name, de->d_name);
3832 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
3833 ; /* silently ignore */
3835 if (S_ISDIR(st.st_mode)) {
3836 strbuf_addch(name, '/');
3837 retval = do_for_each_reflog(name, fn, cb_data);
3839 struct object_id oid;
3841 if (read_ref_full(name->buf, 0, oid.hash, NULL))
3842 retval = error("bad ref for %s", name->buf);
3844 retval = fn(name->buf, &oid, 0, cb_data);
3849 strbuf_setlen(name, oldlen);
3855 int for_each_reflog(each_ref_fn fn, void *cb_data)
3859 strbuf_init(&name, PATH_MAX);
3860 retval = do_for_each_reflog(&name, fn, cb_data);
3861 strbuf_release(&name);
3865 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3869 return xcalloc(1, sizeof(struct ref_transaction));
3872 void ref_transaction_free(struct ref_transaction *transaction)
3879 for (i = 0; i < transaction->nr; i++) {
3880 free(transaction->updates[i]->msg);
3881 free(transaction->updates[i]);
3883 free(transaction->updates);
3887 static struct ref_update *add_update(struct ref_transaction *transaction,
3888 const char *refname)
3890 size_t len = strlen(refname) + 1;
3891 struct ref_update *update = xcalloc(1, sizeof(*update) + len);
3893 memcpy((char *)update->refname, refname, len); /* includes NUL */
3894 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
3895 transaction->updates[transaction->nr++] = update;
3899 int ref_transaction_update(struct ref_transaction *transaction,
3900 const char *refname,
3901 const unsigned char *new_sha1,
3902 const unsigned char *old_sha1,
3903 unsigned int flags, const char *msg,
3906 struct ref_update *update;
3910 if (transaction->state != REF_TRANSACTION_OPEN)
3911 die("BUG: update called for transaction that is not open");
3913 if (new_sha1 && !is_null_sha1(new_sha1) &&
3914 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
3915 strbuf_addf(err, "refusing to update ref with bad name %s",
3920 update = add_update(transaction, refname);
3922 hashcpy(update->new_sha1, new_sha1);
3923 flags |= REF_HAVE_NEW;
3926 hashcpy(update->old_sha1, old_sha1);
3927 flags |= REF_HAVE_OLD;
3929 update->flags = flags;
3931 update->msg = xstrdup(msg);
3935 int ref_transaction_create(struct ref_transaction *transaction,
3936 const char *refname,
3937 const unsigned char *new_sha1,
3938 unsigned int flags, const char *msg,
3941 if (!new_sha1 || is_null_sha1(new_sha1))
3942 die("BUG: create called without valid new_sha1");
3943 return ref_transaction_update(transaction, refname, new_sha1,
3944 null_sha1, flags, msg, err);
3947 int ref_transaction_delete(struct ref_transaction *transaction,
3948 const char *refname,
3949 const unsigned char *old_sha1,
3950 unsigned int flags, const char *msg,
3953 if (old_sha1 && is_null_sha1(old_sha1))
3954 die("BUG: delete called with old_sha1 set to zeros");
3955 return ref_transaction_update(transaction, refname,
3956 null_sha1, old_sha1,
3960 int ref_transaction_verify(struct ref_transaction *transaction,
3961 const char *refname,
3962 const unsigned char *old_sha1,
3967 die("BUG: verify called with old_sha1 set to NULL");
3968 return ref_transaction_update(transaction, refname,
3973 int update_ref(const char *msg, const char *refname,
3974 const unsigned char *new_sha1, const unsigned char *old_sha1,
3975 unsigned int flags, enum action_on_err onerr)
3977 struct ref_transaction *t = NULL;
3978 struct strbuf err = STRBUF_INIT;
3981 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
3982 ret = write_pseudoref(refname, new_sha1, old_sha1, &err);
3984 t = ref_transaction_begin(&err);
3986 ref_transaction_update(t, refname, new_sha1, old_sha1,
3987 flags, msg, &err) ||
3988 ref_transaction_commit(t, &err)) {
3990 ref_transaction_free(t);
3994 const char *str = "update_ref failed for ref '%s': %s";
3997 case UPDATE_REFS_MSG_ON_ERR:
3998 error(str, refname, err.buf);
4000 case UPDATE_REFS_DIE_ON_ERR:
4001 die(str, refname, err.buf);
4003 case UPDATE_REFS_QUIET_ON_ERR:
4006 strbuf_release(&err);
4009 strbuf_release(&err);
4011 ref_transaction_free(t);
4015 static int ref_update_reject_duplicates(struct string_list *refnames,
4018 int i, n = refnames->nr;
4022 for (i = 1; i < n; i++)
4023 if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {
4025 "Multiple updates for ref '%s' not allowed.",
4026 refnames->items[i].string);
4032 int ref_transaction_commit(struct ref_transaction *transaction,
4036 int n = transaction->nr;
4037 struct ref_update **updates = transaction->updates;
4038 struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;
4039 struct string_list_item *ref_to_delete;
4040 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
4044 if (transaction->state != REF_TRANSACTION_OPEN)
4045 die("BUG: commit called for transaction that is not open");
4048 transaction->state = REF_TRANSACTION_CLOSED;
4052 /* Fail if a refname appears more than once in the transaction: */
4053 for (i = 0; i < n; i++)
4054 string_list_append(&affected_refnames, updates[i]->refname);
4055 string_list_sort(&affected_refnames);
4056 if (ref_update_reject_duplicates(&affected_refnames, err)) {
4057 ret = TRANSACTION_GENERIC_ERROR;
4062 * Acquire all locks, verify old values if provided, check
4063 * that new values are valid, and write new values to the
4064 * lockfiles, ready to be activated. Only keep one lockfile
4065 * open at a time to avoid running out of file descriptors.
4067 for (i = 0; i < n; i++) {
4068 struct ref_update *update = updates[i];
4070 if ((update->flags & REF_HAVE_NEW) &&
4071 is_null_sha1(update->new_sha1))
4072 update->flags |= REF_DELETING;
4073 update->lock = lock_ref_sha1_basic(
4075 ((update->flags & REF_HAVE_OLD) ?
4076 update->old_sha1 : NULL),
4077 &affected_refnames, NULL,
4081 if (!update->lock) {
4084 ret = (errno == ENOTDIR)
4085 ? TRANSACTION_NAME_CONFLICT
4086 : TRANSACTION_GENERIC_ERROR;
4087 reason = strbuf_detach(err, NULL);
4088 strbuf_addf(err, "cannot lock ref '%s': %s",
4089 update->refname, reason);
4093 if ((update->flags & REF_HAVE_NEW) &&
4094 !(update->flags & REF_DELETING)) {
4095 int overwriting_symref = ((update->type & REF_ISSYMREF) &&
4096 (update->flags & REF_NODEREF));
4098 if (!overwriting_symref &&
4099 !hashcmp(update->lock->old_oid.hash, update->new_sha1)) {
4101 * The reference already has the desired
4102 * value, so we don't need to write it.
4104 } else if (write_ref_to_lockfile(update->lock,
4107 char *write_err = strbuf_detach(err, NULL);
4110 * The lock was freed upon failure of
4111 * write_ref_to_lockfile():
4113 update->lock = NULL;
4115 "cannot update the ref '%s': %s",
4116 update->refname, write_err);
4118 ret = TRANSACTION_GENERIC_ERROR;
4121 update->flags |= REF_NEEDS_COMMIT;
4124 if (!(update->flags & REF_NEEDS_COMMIT)) {
4126 * We didn't have to write anything to the lockfile.
4127 * Close it to free up the file descriptor:
4129 if (close_ref(update->lock)) {
4130 strbuf_addf(err, "Couldn't close %s.lock",
4137 /* Perform updates first so live commits remain referenced */
4138 for (i = 0; i < n; i++) {
4139 struct ref_update *update = updates[i];
4141 if (update->flags & REF_NEEDS_COMMIT) {
4142 if (commit_ref_update(update->lock,
4143 update->new_sha1, update->msg,
4144 update->flags, err)) {
4145 /* freed by commit_ref_update(): */
4146 update->lock = NULL;
4147 ret = TRANSACTION_GENERIC_ERROR;
4150 /* freed by commit_ref_update(): */
4151 update->lock = NULL;
4156 /* Perform deletes now that updates are safely completed */
4157 for (i = 0; i < n; i++) {
4158 struct ref_update *update = updates[i];
4160 if (update->flags & REF_DELETING) {
4161 if (delete_ref_loose(update->lock, update->type, err)) {
4162 ret = TRANSACTION_GENERIC_ERROR;
4166 if (!(update->flags & REF_ISPRUNING))
4167 string_list_append(&refs_to_delete,
4168 update->lock->ref_name);
4172 if (repack_without_refs(&refs_to_delete, err)) {
4173 ret = TRANSACTION_GENERIC_ERROR;
4176 for_each_string_list_item(ref_to_delete, &refs_to_delete)
4177 unlink_or_warn(git_path("logs/%s", ref_to_delete->string));
4178 clear_loose_ref_cache(&ref_cache);
4181 transaction->state = REF_TRANSACTION_CLOSED;
4183 for (i = 0; i < n; i++)
4184 if (updates[i]->lock)
4185 unlock_ref(updates[i]->lock);
4186 string_list_clear(&refs_to_delete, 0);
4187 string_list_clear(&affected_refnames, 0);
4191 static int ref_present(const char *refname,
4192 const struct object_id *oid, int flags, void *cb_data)
4194 struct string_list *affected_refnames = cb_data;
4196 return string_list_has_string(affected_refnames, refname);
4199 int initial_ref_transaction_commit(struct ref_transaction *transaction,
4203 int n = transaction->nr;
4204 struct ref_update **updates = transaction->updates;
4205 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
4209 if (transaction->state != REF_TRANSACTION_OPEN)
4210 die("BUG: commit called for transaction that is not open");
4212 /* Fail if a refname appears more than once in the transaction: */
4213 for (i = 0; i < n; i++)
4214 string_list_append(&affected_refnames, updates[i]->refname);
4215 string_list_sort(&affected_refnames);
4216 if (ref_update_reject_duplicates(&affected_refnames, err)) {
4217 ret = TRANSACTION_GENERIC_ERROR;
4222 * It's really undefined to call this function in an active
4223 * repository or when there are existing references: we are
4224 * only locking and changing packed-refs, so (1) any
4225 * simultaneous processes might try to change a reference at
4226 * the same time we do, and (2) any existing loose versions of
4227 * the references that we are setting would have precedence
4228 * over our values. But some remote helpers create the remote
4229 * "HEAD" and "master" branches before calling this function,
4230 * so here we really only check that none of the references
4231 * that we are creating already exists.
4233 if (for_each_rawref(ref_present, &affected_refnames))
4234 die("BUG: initial ref transaction called with existing refs");
4236 for (i = 0; i < n; i++) {
4237 struct ref_update *update = updates[i];
4239 if ((update->flags & REF_HAVE_OLD) &&
4240 !is_null_sha1(update->old_sha1))
4241 die("BUG: initial ref transaction with old_sha1 set");
4242 if (verify_refname_available(update->refname,
4243 &affected_refnames, NULL,
4245 ret = TRANSACTION_NAME_CONFLICT;
4250 if (lock_packed_refs(0)) {
4251 strbuf_addf(err, "unable to lock packed-refs file: %s",
4253 ret = TRANSACTION_GENERIC_ERROR;
4257 for (i = 0; i < n; i++) {
4258 struct ref_update *update = updates[i];
4260 if ((update->flags & REF_HAVE_NEW) &&
4261 !is_null_sha1(update->new_sha1))
4262 add_packed_ref(update->refname, update->new_sha1);
4265 if (commit_packed_refs()) {
4266 strbuf_addf(err, "unable to commit packed-refs file: %s",
4268 ret = TRANSACTION_GENERIC_ERROR;
4273 transaction->state = REF_TRANSACTION_CLOSED;
4274 string_list_clear(&affected_refnames, 0);
4278 char *shorten_unambiguous_ref(const char *refname, int strict)
4281 static char **scanf_fmts;
4282 static int nr_rules;
4287 * Pre-generate scanf formats from ref_rev_parse_rules[].
4288 * Generate a format suitable for scanf from a
4289 * ref_rev_parse_rules rule by interpolating "%s" at the
4290 * location of the "%.*s".
4292 size_t total_len = 0;
4295 /* the rule list is NULL terminated, count them first */
4296 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
4297 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
4298 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
4300 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
4303 for (i = 0; i < nr_rules; i++) {
4304 assert(offset < total_len);
4305 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
4306 offset += snprintf(scanf_fmts[i], total_len - offset,
4307 ref_rev_parse_rules[i], 2, "%s") + 1;
4311 /* bail out if there are no rules */
4313 return xstrdup(refname);
4315 /* buffer for scanf result, at most refname must fit */
4316 short_name = xstrdup(refname);
4318 /* skip first rule, it will always match */
4319 for (i = nr_rules - 1; i > 0 ; --i) {
4321 int rules_to_fail = i;
4324 if (1 != sscanf(refname, scanf_fmts[i], short_name))
4327 short_name_len = strlen(short_name);
4330 * in strict mode, all (except the matched one) rules
4331 * must fail to resolve to a valid non-ambiguous ref
4334 rules_to_fail = nr_rules;
4337 * check if the short name resolves to a valid ref,
4338 * but use only rules prior to the matched one
4340 for (j = 0; j < rules_to_fail; j++) {
4341 const char *rule = ref_rev_parse_rules[j];
4342 char refname[PATH_MAX];
4344 /* skip matched rule */
4349 * the short name is ambiguous, if it resolves
4350 * (with this previous rule) to a valid ref
4351 * read_ref() returns 0 on success
4353 mksnpath(refname, sizeof(refname),
4354 rule, short_name_len, short_name);
4355 if (ref_exists(refname))
4360 * short name is non-ambiguous if all previous rules
4361 * haven't resolved to a valid ref
4363 if (j == rules_to_fail)
4368 return xstrdup(refname);
4371 static struct string_list *hide_refs;
4373 int parse_hide_refs_config(const char *var, const char *value, const char *section)
4375 if (!strcmp("transfer.hiderefs", var) ||
4376 /* NEEDSWORK: use parse_config_key() once both are merged */
4377 (starts_with(var, section) && var[strlen(section)] == '.' &&
4378 !strcmp(var + strlen(section), ".hiderefs"))) {
4383 return config_error_nonbool(var);
4384 ref = xstrdup(value);
4386 while (len && ref[len - 1] == '/')
4389 hide_refs = xcalloc(1, sizeof(*hide_refs));
4390 hide_refs->strdup_strings = 1;
4392 string_list_append(hide_refs, ref);
4397 int ref_is_hidden(const char *refname)
4403 for (i = hide_refs->nr - 1; i >= 0; i--) {
4404 const char *match = hide_refs->items[i].string;
4408 if (*match == '!') {
4413 if (!starts_with(refname, match))
4415 len = strlen(match);
4416 if (!refname[len] || refname[len] == '/')
4422 struct expire_reflog_cb {
4424 reflog_expiry_should_prune_fn *should_prune_fn;
4427 unsigned char last_kept_sha1[20];
4430 static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
4431 const char *email, unsigned long timestamp, int tz,
4432 const char *message, void *cb_data)
4434 struct expire_reflog_cb *cb = cb_data;
4435 struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;
4437 if (cb->flags & EXPIRE_REFLOGS_REWRITE)
4438 osha1 = cb->last_kept_sha1;
4440 if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,
4441 message, policy_cb)) {
4443 printf("would prune %s", message);
4444 else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
4445 printf("prune %s", message);
4448 fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",
4449 sha1_to_hex(osha1), sha1_to_hex(nsha1),
4450 email, timestamp, tz, message);
4451 hashcpy(cb->last_kept_sha1, nsha1);
4453 if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
4454 printf("keep %s", message);
4459 int reflog_expire(const char *refname, const unsigned char *sha1,
4461 reflog_expiry_prepare_fn prepare_fn,
4462 reflog_expiry_should_prune_fn should_prune_fn,
4463 reflog_expiry_cleanup_fn cleanup_fn,
4464 void *policy_cb_data)
4466 static struct lock_file reflog_lock;
4467 struct expire_reflog_cb cb;
4468 struct ref_lock *lock;
4472 struct strbuf err = STRBUF_INIT;
4474 memset(&cb, 0, sizeof(cb));
4476 cb.policy_cb = policy_cb_data;
4477 cb.should_prune_fn = should_prune_fn;
4480 * The reflog file is locked by holding the lock on the
4481 * reference itself, plus we might need to update the
4482 * reference if --updateref was specified:
4484 lock = lock_ref_sha1_basic(refname, sha1, NULL, NULL, 0, &type, &err);
4486 error("cannot lock ref '%s': %s", refname, err.buf);
4487 strbuf_release(&err);
4490 if (!reflog_exists(refname)) {
4495 log_file = git_pathdup("logs/%s", refname);
4496 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
4498 * Even though holding $GIT_DIR/logs/$reflog.lock has
4499 * no locking implications, we use the lock_file
4500 * machinery here anyway because it does a lot of the
4501 * work we need, including cleaning up if the program
4502 * exits unexpectedly.
4504 if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
4505 struct strbuf err = STRBUF_INIT;
4506 unable_to_lock_message(log_file, errno, &err);
4507 error("%s", err.buf);
4508 strbuf_release(&err);
4511 cb.newlog = fdopen_lock_file(&reflog_lock, "w");
4513 error("cannot fdopen %s (%s)",
4514 get_lock_file_path(&reflog_lock), strerror(errno));
4519 (*prepare_fn)(refname, sha1, cb.policy_cb);
4520 for_each_reflog_ent(refname, expire_reflog_ent, &cb);
4521 (*cleanup_fn)(cb.policy_cb);
4523 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
4525 * It doesn't make sense to adjust a reference pointed
4526 * to by a symbolic ref based on expiring entries in
4527 * the symbolic reference's reflog. Nor can we update
4528 * a reference if there are no remaining reflog
4531 int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&
4532 !(type & REF_ISSYMREF) &&
4533 !is_null_sha1(cb.last_kept_sha1);
4535 if (close_lock_file(&reflog_lock)) {
4536 status |= error("couldn't write %s: %s", log_file,
4538 } else if (update &&
4539 (write_in_full(get_lock_file_fd(lock->lk),
4540 sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
4541 write_str_in_full(get_lock_file_fd(lock->lk), "\n") != 1 ||
4542 close_ref(lock) < 0)) {
4543 status |= error("couldn't write %s",
4544 get_lock_file_path(lock->lk));
4545 rollback_lock_file(&reflog_lock);
4546 } else if (commit_lock_file(&reflog_lock)) {
4547 status |= error("unable to commit reflog '%s' (%s)",
4548 log_file, strerror(errno));
4549 } else if (update && commit_ref(lock)) {
4550 status |= error("couldn't set %s", lock->ref_name);
4558 rollback_lock_file(&reflog_lock);