7 #include "string-list.h"
13 struct object_id old_oid
;
17 * How to handle various characters in refnames:
18 * 0: An acceptable character for refs
20 * 2: ., look for a preceding . to reject .. in refs
21 * 3: {, look for a preceding @ to reject @{ in refs
22 * 4: A bad character: ASCII control characters, and
23 * ":", "?", "[", "\", "^", "~", SP, or TAB
24 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
26 static unsigned char refname_disposition
[256] = {
27 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
28 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
29 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
30 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
31 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
32 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
33 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
34 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
38 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken
39 * refs (i.e., because the reference is about to be deleted anyway).
41 #define REF_DELETING 0x02
44 * Used as a flag in ref_update::flags when a loose ref is being
47 #define REF_ISPRUNING 0x04
50 * Used as a flag in ref_update::flags when the reference should be
51 * updated to new_sha1.
53 #define REF_HAVE_NEW 0x08
56 * Used as a flag in ref_update::flags when old_sha1 should be
59 #define REF_HAVE_OLD 0x10
62 * Used as a flag in ref_update::flags when the lockfile needs to be
65 #define REF_NEEDS_COMMIT 0x20
68 * 0x40 is REF_FORCE_CREATE_REFLOG, so skip it if you're adding a
69 * value to ref_update::flags
73 * Try to read one refname component from the front of refname.
74 * Return the length of the component found, or -1 if the component is
75 * not legal. It is legal if it is something reasonable to have under
76 * ".git/refs/"; We do not like it if:
78 * - any path component of it begins with ".", or
79 * - it has double dots "..", or
80 * - it has ASCII control characters, or
81 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
82 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
83 * - it ends with a "/", or
84 * - it ends with ".lock", or
85 * - it contains a "@{" portion
87 static int check_refname_component(const char *refname
, int *flags
)
92 for (cp
= refname
; ; cp
++) {
94 unsigned char disp
= refname_disposition
[ch
];
100 return -1; /* Refname contains "..". */
104 return -1; /* Refname contains "@{". */
109 if (!(*flags
& REFNAME_REFSPEC_PATTERN
))
110 return -1; /* refspec can't be a pattern */
113 * Unset the pattern flag so that we only accept
114 * a single asterisk for one side of refspec.
116 *flags
&= ~ REFNAME_REFSPEC_PATTERN
;
123 return 0; /* Component has zero length. */
124 if (refname
[0] == '.')
125 return -1; /* Component starts with '.'. */
126 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
127 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
128 return -1; /* Refname ends with ".lock". */
132 int check_refname_format(const char *refname
, int flags
)
134 int component_len
, component_count
= 0;
136 if (!strcmp(refname
, "@"))
137 /* Refname is a single character '@'. */
141 /* We are at the start of a path component. */
142 component_len
= check_refname_component(refname
, &flags
);
143 if (component_len
<= 0)
147 if (refname
[component_len
] == '\0')
149 /* Skip to next component. */
150 refname
+= component_len
+ 1;
153 if (refname
[component_len
- 1] == '.')
154 return -1; /* Refname ends with '.'. */
155 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
156 return -1; /* Refname has only one component. */
163 * Information used (along with the information in ref_entry) to
164 * describe a single cached reference. This data structure only
165 * occurs embedded in a union in struct ref_entry, and only when
166 * (ref_entry->flag & REF_DIR) is zero.
170 * The name of the object to which this reference resolves
171 * (which may be a tag object). If REF_ISBROKEN, this is
172 * null. If REF_ISSYMREF, then this is the name of the object
173 * referred to by the last reference in the symlink chain.
175 struct object_id oid
;
178 * If REF_KNOWS_PEELED, then this field holds the peeled value
179 * of this reference, or null if the reference is known not to
180 * be peelable. See the documentation for peel_ref() for an
181 * exact definition of "peelable".
183 struct object_id peeled
;
189 * Information used (along with the information in ref_entry) to
190 * describe a level in the hierarchy of references. This data
191 * structure only occurs embedded in a union in struct ref_entry, and
192 * only when (ref_entry.flag & REF_DIR) is set. In that case,
193 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
194 * in the directory have already been read:
196 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
197 * or packed references, already read.
199 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
200 * references that hasn't been read yet (nor has any of its
203 * Entries within a directory are stored within a growable array of
204 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
205 * sorted are sorted by their component name in strcmp() order and the
206 * remaining entries are unsorted.
208 * Loose references are read lazily, one directory at a time. When a
209 * directory of loose references is read, then all of the references
210 * in that directory are stored, and REF_INCOMPLETE stubs are created
211 * for any subdirectories, but the subdirectories themselves are not
212 * read. The reading is triggered by get_ref_dir().
218 * Entries with index 0 <= i < sorted are sorted by name. New
219 * entries are appended to the list unsorted, and are sorted
220 * only when required; thus we avoid the need to sort the list
221 * after the addition of every reference.
225 /* A pointer to the ref_cache that contains this ref_dir. */
226 struct ref_cache
*ref_cache
;
228 struct ref_entry
**entries
;
232 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
233 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
234 * public values; see refs.h.
238 * The field ref_entry->u.value.peeled of this value entry contains
239 * the correct peeled value for the reference, which might be
240 * null_sha1 if the reference is not a tag or if it is broken.
242 #define REF_KNOWS_PEELED 0x10
244 /* ref_entry represents a directory of references */
248 * Entry has not yet been read from disk (used only for REF_DIR
249 * entries representing loose references)
251 #define REF_INCOMPLETE 0x40
254 * A ref_entry represents either a reference or a "subdirectory" of
257 * Each directory in the reference namespace is represented by a
258 * ref_entry with (flags & REF_DIR) set and containing a subdir member
259 * that holds the entries in that directory that have been read so
260 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
261 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
262 * used for loose reference directories.
264 * References are represented by a ref_entry with (flags & REF_DIR)
265 * unset and a value member that describes the reference's value. The
266 * flag member is at the ref_entry level, but it is also needed to
267 * interpret the contents of the value field (in other words, a
268 * ref_value object is not very much use without the enclosing
271 * Reference names cannot end with slash and directories' names are
272 * always stored with a trailing slash (except for the top-level
273 * directory, which is always denoted by ""). This has two nice
274 * consequences: (1) when the entries in each subdir are sorted
275 * lexicographically by name (as they usually are), the references in
276 * a whole tree can be generated in lexicographic order by traversing
277 * the tree in left-to-right, depth-first order; (2) the names of
278 * references and subdirectories cannot conflict, and therefore the
279 * presence of an empty subdirectory does not block the creation of a
280 * similarly-named reference. (The fact that reference names with the
281 * same leading components can conflict *with each other* is a
282 * separate issue that is regulated by verify_refname_available().)
284 * Please note that the name field contains the fully-qualified
285 * reference (or subdirectory) name. Space could be saved by only
286 * storing the relative names. But that would require the full names
287 * to be generated on the fly when iterating in do_for_each_ref(), and
288 * would break callback functions, who have always been able to assume
289 * that the name strings that they are passed will not be freed during
293 unsigned char flag
; /* ISSYMREF? ISPACKED? */
295 struct ref_value value
; /* if not (flags&REF_DIR) */
296 struct ref_dir subdir
; /* if (flags&REF_DIR) */
299 * The full name of the reference (e.g., "refs/heads/master")
300 * or the full name of the directory with a trailing slash
301 * (e.g., "refs/heads/"):
303 char name
[FLEX_ARRAY
];
306 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
307 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
);
308 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
309 const char *dirname
, size_t len
,
311 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
);
313 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
316 assert(entry
->flag
& REF_DIR
);
317 dir
= &entry
->u
.subdir
;
318 if (entry
->flag
& REF_INCOMPLETE
) {
319 read_loose_refs(entry
->name
, dir
);
322 * Manually add refs/bisect, which, being
323 * per-worktree, might not appear in the directory
324 * listing for refs/ in the main repo.
326 if (!strcmp(entry
->name
, "refs/")) {
327 int pos
= search_ref_dir(dir
, "refs/bisect/", 12);
329 struct ref_entry
*child_entry
;
330 child_entry
= create_dir_entry(dir
->ref_cache
,
333 add_entry_to_dir(dir
, child_entry
);
334 read_loose_refs("refs/bisect",
335 &child_entry
->u
.subdir
);
338 entry
->flag
&= ~REF_INCOMPLETE
;
344 * Check if a refname is safe.
345 * For refs that start with "refs/" we consider it safe as long they do
346 * not try to resolve to outside of refs/.
348 * For all other refs we only consider them safe iff they only contain
349 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
352 static int refname_is_safe(const char *refname
)
354 if (starts_with(refname
, "refs/")) {
358 buf
= xmalloc(strlen(refname
) + 1);
360 * Does the refname try to escape refs/?
361 * For example: refs/foo/../bar is safe but refs/foo/../../bar
364 result
= !normalize_path_copy(buf
, refname
+ strlen("refs/"));
369 if (!isupper(*refname
) && *refname
!= '_')
376 static struct ref_entry
*create_ref_entry(const char *refname
,
377 const unsigned char *sha1
, int flag
,
381 struct ref_entry
*ref
;
384 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
385 die("Reference has invalid format: '%s'", refname
);
386 len
= strlen(refname
) + 1;
387 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
388 hashcpy(ref
->u
.value
.oid
.hash
, sha1
);
389 oidclr(&ref
->u
.value
.peeled
);
390 memcpy(ref
->name
, refname
, len
);
395 static void clear_ref_dir(struct ref_dir
*dir
);
397 static void free_ref_entry(struct ref_entry
*entry
)
399 if (entry
->flag
& REF_DIR
) {
401 * Do not use get_ref_dir() here, as that might
402 * trigger the reading of loose refs.
404 clear_ref_dir(&entry
->u
.subdir
);
410 * Add a ref_entry to the end of dir (unsorted). Entry is always
411 * stored directly in dir; no recursion into subdirectories is
414 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
416 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
417 dir
->entries
[dir
->nr
++] = entry
;
418 /* optimize for the case that entries are added in order */
420 (dir
->nr
== dir
->sorted
+ 1 &&
421 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
422 dir
->entries
[dir
->nr
- 1]->name
) < 0))
423 dir
->sorted
= dir
->nr
;
427 * Clear and free all entries in dir, recursively.
429 static void clear_ref_dir(struct ref_dir
*dir
)
432 for (i
= 0; i
< dir
->nr
; i
++)
433 free_ref_entry(dir
->entries
[i
]);
435 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
440 * Create a struct ref_entry object for the specified dirname.
441 * dirname is the name of the directory with a trailing slash (e.g.,
442 * "refs/heads/") or "" for the top-level directory.
444 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
445 const char *dirname
, size_t len
,
448 struct ref_entry
*direntry
;
449 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
450 memcpy(direntry
->name
, dirname
, len
);
451 direntry
->name
[len
] = '\0';
452 direntry
->u
.subdir
.ref_cache
= ref_cache
;
453 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
457 static int ref_entry_cmp(const void *a
, const void *b
)
459 struct ref_entry
*one
= *(struct ref_entry
**)a
;
460 struct ref_entry
*two
= *(struct ref_entry
**)b
;
461 return strcmp(one
->name
, two
->name
);
464 static void sort_ref_dir(struct ref_dir
*dir
);
466 struct string_slice
{
471 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
473 const struct string_slice
*key
= key_
;
474 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
475 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
478 return '\0' - (unsigned char)ent
->name
[key
->len
];
482 * Return the index of the entry with the given refname from the
483 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
484 * no such entry is found. dir must already be complete.
486 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
488 struct ref_entry
**r
;
489 struct string_slice key
;
491 if (refname
== NULL
|| !dir
->nr
)
497 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
498 ref_entry_cmp_sslice
);
503 return r
- dir
->entries
;
507 * Search for a directory entry directly within dir (without
508 * recursing). Sort dir if necessary. subdirname must be a directory
509 * name (i.e., end in '/'). If mkdir is set, then create the
510 * directory if it is missing; otherwise, return NULL if the desired
511 * directory cannot be found. dir must already be complete.
513 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
514 const char *subdirname
, size_t len
,
517 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
518 struct ref_entry
*entry
;
519 if (entry_index
== -1) {
523 * Since dir is complete, the absence of a subdir
524 * means that the subdir really doesn't exist;
525 * therefore, create an empty record for it but mark
526 * the record complete.
528 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
529 add_entry_to_dir(dir
, entry
);
531 entry
= dir
->entries
[entry_index
];
533 return get_ref_dir(entry
);
537 * If refname is a reference name, find the ref_dir within the dir
538 * tree that should hold refname. If refname is a directory name
539 * (i.e., ends in '/'), then return that ref_dir itself. dir must
540 * represent the top-level directory and must already be complete.
541 * Sort ref_dirs and recurse into subdirectories as necessary. If
542 * mkdir is set, then create any missing directories; otherwise,
543 * return NULL if the desired directory cannot be found.
545 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
546 const char *refname
, int mkdir
)
549 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
550 size_t dirnamelen
= slash
- refname
+ 1;
551 struct ref_dir
*subdir
;
552 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
564 * Find the value entry with the given name in dir, sorting ref_dirs
565 * and recursing into subdirectories as necessary. If the name is not
566 * found or it corresponds to a directory entry, return NULL.
568 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
571 struct ref_entry
*entry
;
572 dir
= find_containing_dir(dir
, refname
, 0);
575 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
576 if (entry_index
== -1)
578 entry
= dir
->entries
[entry_index
];
579 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
583 * Remove the entry with the given name from dir, recursing into
584 * subdirectories as necessary. If refname is the name of a directory
585 * (i.e., ends with '/'), then remove the directory and its contents.
586 * If the removal was successful, return the number of entries
587 * remaining in the directory entry that contained the deleted entry.
588 * If the name was not found, return -1. Please note that this
589 * function only deletes the entry from the cache; it does not delete
590 * it from the filesystem or ensure that other cache entries (which
591 * might be symbolic references to the removed entry) are updated.
592 * Nor does it remove any containing dir entries that might be made
593 * empty by the removal. dir must represent the top-level directory
594 * and must already be complete.
596 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
598 int refname_len
= strlen(refname
);
600 struct ref_entry
*entry
;
601 int is_dir
= refname
[refname_len
- 1] == '/';
604 * refname represents a reference directory. Remove
605 * the trailing slash; otherwise we will get the
606 * directory *representing* refname rather than the
607 * one *containing* it.
609 char *dirname
= xmemdupz(refname
, refname_len
- 1);
610 dir
= find_containing_dir(dir
, dirname
, 0);
613 dir
= find_containing_dir(dir
, refname
, 0);
617 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
618 if (entry_index
== -1)
620 entry
= dir
->entries
[entry_index
];
622 memmove(&dir
->entries
[entry_index
],
623 &dir
->entries
[entry_index
+ 1],
624 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
627 if (dir
->sorted
> entry_index
)
629 free_ref_entry(entry
);
634 * Add a ref_entry to the ref_dir (unsorted), recursing into
635 * subdirectories as necessary. dir must represent the top-level
636 * directory. Return 0 on success.
638 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
640 dir
= find_containing_dir(dir
, ref
->name
, 1);
643 add_entry_to_dir(dir
, ref
);
648 * Emit a warning and return true iff ref1 and ref2 have the same name
649 * and the same sha1. Die if they have the same name but different
652 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
654 if (strcmp(ref1
->name
, ref2
->name
))
657 /* Duplicate name; make sure that they don't conflict: */
659 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
660 /* This is impossible by construction */
661 die("Reference directory conflict: %s", ref1
->name
);
663 if (oidcmp(&ref1
->u
.value
.oid
, &ref2
->u
.value
.oid
))
664 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
666 warning("Duplicated ref: %s", ref1
->name
);
671 * Sort the entries in dir non-recursively (if they are not already
672 * sorted) and remove any duplicate entries.
674 static void sort_ref_dir(struct ref_dir
*dir
)
677 struct ref_entry
*last
= NULL
;
680 * This check also prevents passing a zero-length array to qsort(),
681 * which is a problem on some platforms.
683 if (dir
->sorted
== dir
->nr
)
686 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
688 /* Remove any duplicates: */
689 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
690 struct ref_entry
*entry
= dir
->entries
[j
];
691 if (last
&& is_dup_ref(last
, entry
))
692 free_ref_entry(entry
);
694 last
= dir
->entries
[i
++] = entry
;
696 dir
->sorted
= dir
->nr
= i
;
699 /* Include broken references in a do_for_each_ref*() iteration: */
700 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
703 * Return true iff the reference described by entry can be resolved to
704 * an object in the database. Emit a warning if the referred-to
705 * object does not exist.
707 static int ref_resolves_to_object(struct ref_entry
*entry
)
709 if (entry
->flag
& REF_ISBROKEN
)
711 if (!has_sha1_file(entry
->u
.value
.oid
.hash
)) {
712 error("%s does not point to a valid object!", entry
->name
);
719 * current_ref is a performance hack: when iterating over references
720 * using the for_each_ref*() functions, current_ref is set to the
721 * current reference's entry before calling the callback function. If
722 * the callback function calls peel_ref(), then peel_ref() first
723 * checks whether the reference to be peeled is the current reference
724 * (it usually is) and if so, returns that reference's peeled version
725 * if it is available. This avoids a refname lookup in a common case.
727 static struct ref_entry
*current_ref
;
729 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
731 struct ref_entry_cb
{
740 * Handle one reference in a do_for_each_ref*()-style iteration,
741 * calling an each_ref_fn for each entry.
743 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
745 struct ref_entry_cb
*data
= cb_data
;
746 struct ref_entry
*old_current_ref
;
749 if (!starts_with(entry
->name
, data
->base
))
752 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
753 !ref_resolves_to_object(entry
))
756 /* Store the old value, in case this is a recursive call: */
757 old_current_ref
= current_ref
;
759 retval
= data
->fn(entry
->name
+ data
->trim
, &entry
->u
.value
.oid
,
760 entry
->flag
, data
->cb_data
);
761 current_ref
= old_current_ref
;
766 * Call fn for each reference in dir that has index in the range
767 * offset <= index < dir->nr. Recurse into subdirectories that are in
768 * that index range, sorting them before iterating. This function
769 * does not sort dir itself; it should be sorted beforehand. fn is
770 * called for all references, including broken ones.
772 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
773 each_ref_entry_fn fn
, void *cb_data
)
776 assert(dir
->sorted
== dir
->nr
);
777 for (i
= offset
; i
< dir
->nr
; i
++) {
778 struct ref_entry
*entry
= dir
->entries
[i
];
780 if (entry
->flag
& REF_DIR
) {
781 struct ref_dir
*subdir
= get_ref_dir(entry
);
782 sort_ref_dir(subdir
);
783 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
785 retval
= fn(entry
, cb_data
);
794 * Call fn for each reference in the union of dir1 and dir2, in order
795 * by refname. Recurse into subdirectories. If a value entry appears
796 * in both dir1 and dir2, then only process the version that is in
797 * dir2. The input dirs must already be sorted, but subdirs will be
798 * sorted as needed. fn is called for all references, including
801 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
802 struct ref_dir
*dir2
,
803 each_ref_entry_fn fn
, void *cb_data
)
808 assert(dir1
->sorted
== dir1
->nr
);
809 assert(dir2
->sorted
== dir2
->nr
);
811 struct ref_entry
*e1
, *e2
;
813 if (i1
== dir1
->nr
) {
814 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
816 if (i2
== dir2
->nr
) {
817 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
819 e1
= dir1
->entries
[i1
];
820 e2
= dir2
->entries
[i2
];
821 cmp
= strcmp(e1
->name
, e2
->name
);
823 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
824 /* Both are directories; descend them in parallel. */
825 struct ref_dir
*subdir1
= get_ref_dir(e1
);
826 struct ref_dir
*subdir2
= get_ref_dir(e2
);
827 sort_ref_dir(subdir1
);
828 sort_ref_dir(subdir2
);
829 retval
= do_for_each_entry_in_dirs(
830 subdir1
, subdir2
, fn
, cb_data
);
833 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
834 /* Both are references; ignore the one from dir1. */
835 retval
= fn(e2
, cb_data
);
839 die("conflict between reference and directory: %s",
851 if (e
->flag
& REF_DIR
) {
852 struct ref_dir
*subdir
= get_ref_dir(e
);
853 sort_ref_dir(subdir
);
854 retval
= do_for_each_entry_in_dir(
855 subdir
, 0, fn
, cb_data
);
857 retval
= fn(e
, cb_data
);
866 * Load all of the refs from the dir into our in-memory cache. The hard work
867 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
868 * through all of the sub-directories. We do not even need to care about
869 * sorting, as traversal order does not matter to us.
871 static void prime_ref_dir(struct ref_dir
*dir
)
874 for (i
= 0; i
< dir
->nr
; i
++) {
875 struct ref_entry
*entry
= dir
->entries
[i
];
876 if (entry
->flag
& REF_DIR
)
877 prime_ref_dir(get_ref_dir(entry
));
881 struct nonmatching_ref_data
{
882 const struct string_list
*skip
;
883 const char *conflicting_refname
;
886 static int nonmatching_ref_fn(struct ref_entry
*entry
, void *vdata
)
888 struct nonmatching_ref_data
*data
= vdata
;
890 if (data
->skip
&& string_list_has_string(data
->skip
, entry
->name
))
893 data
->conflicting_refname
= entry
->name
;
898 * Return 0 if a reference named refname could be created without
899 * conflicting with the name of an existing reference in dir.
900 * Otherwise, return a negative value and write an explanation to err.
901 * If extras is non-NULL, it is a list of additional refnames with
902 * which refname is not allowed to conflict. If skip is non-NULL,
903 * ignore potential conflicts with refs in skip (e.g., because they
904 * are scheduled for deletion in the same operation). Behavior is
905 * undefined if the same name is listed in both extras and skip.
907 * Two reference names conflict if one of them exactly matches the
908 * leading components of the other; e.g., "refs/foo/bar" conflicts
909 * with both "refs/foo" and with "refs/foo/bar/baz" but not with
910 * "refs/foo/bar" or "refs/foo/barbados".
912 * extras and skip must be sorted.
914 static int verify_refname_available(const char *refname
,
915 const struct string_list
*extras
,
916 const struct string_list
*skip
,
922 struct strbuf dirname
= STRBUF_INIT
;
926 * For the sake of comments in this function, suppose that
927 * refname is "refs/foo/bar".
932 strbuf_grow(&dirname
, strlen(refname
) + 1);
933 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
934 /* Expand dirname to the new prefix, not including the trailing slash: */
935 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
938 * We are still at a leading dir of the refname (e.g.,
939 * "refs/foo"; if there is a reference with that name,
940 * it is a conflict, *unless* it is in skip.
943 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
945 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
947 * We found a reference whose name is
948 * a proper prefix of refname; e.g.,
949 * "refs/foo", and is not in skip.
951 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
952 dirname
.buf
, refname
);
957 if (extras
&& string_list_has_string(extras
, dirname
.buf
) &&
958 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
959 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
960 refname
, dirname
.buf
);
965 * Otherwise, we can try to continue our search with
966 * the next component. So try to look up the
967 * directory, e.g., "refs/foo/". If we come up empty,
968 * we know there is nothing under this whole prefix,
969 * but even in that case we still have to continue the
970 * search for conflicts with extras.
972 strbuf_addch(&dirname
, '/');
974 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
977 * There was no directory "refs/foo/",
978 * so there is nothing under this
979 * whole prefix. So there is no need
980 * to continue looking for conflicting
981 * references. But we need to continue
982 * looking for conflicting extras.
986 dir
= get_ref_dir(dir
->entries
[pos
]);
992 * We are at the leaf of our refname (e.g., "refs/foo/bar").
993 * There is no point in searching for a reference with that
994 * name, because a refname isn't considered to conflict with
995 * itself. But we still need to check for references whose
996 * names are in the "refs/foo/bar/" namespace, because they
999 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
1000 strbuf_addch(&dirname
, '/');
1003 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
1007 * We found a directory named "$refname/"
1008 * (e.g., "refs/foo/bar/"). It is a problem
1009 * iff it contains any ref that is not in
1012 struct nonmatching_ref_data data
;
1015 data
.conflicting_refname
= NULL
;
1016 dir
= get_ref_dir(dir
->entries
[pos
]);
1018 if (do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
)) {
1019 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1020 data
.conflicting_refname
, refname
);
1028 * Check for entries in extras that start with
1029 * "$refname/". We do that by looking for the place
1030 * where "$refname/" would be inserted in extras. If
1031 * there is an entry at that position that starts with
1032 * "$refname/" and is not in skip, then we have a
1035 for (pos
= string_list_find_insert_index(extras
, dirname
.buf
, 0);
1036 pos
< extras
->nr
; pos
++) {
1037 const char *extra_refname
= extras
->items
[pos
].string
;
1039 if (!starts_with(extra_refname
, dirname
.buf
))
1042 if (!skip
|| !string_list_has_string(skip
, extra_refname
)) {
1043 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1044 refname
, extra_refname
);
1050 /* No conflicts were found */
1054 strbuf_release(&dirname
);
1058 struct packed_ref_cache
{
1059 struct ref_entry
*root
;
1062 * Count of references to the data structure in this instance,
1063 * including the pointer from ref_cache::packed if any. The
1064 * data will not be freed as long as the reference count is
1067 unsigned int referrers
;
1070 * Iff the packed-refs file associated with this instance is
1071 * currently locked for writing, this points at the associated
1072 * lock (which is owned by somebody else). The referrer count
1073 * is also incremented when the file is locked and decremented
1074 * when it is unlocked.
1076 struct lock_file
*lock
;
1078 /* The metadata from when this packed-refs cache was read */
1079 struct stat_validity validity
;
1083 * Future: need to be in "struct repository"
1084 * when doing a full libification.
1086 static struct ref_cache
{
1087 struct ref_cache
*next
;
1088 struct ref_entry
*loose
;
1089 struct packed_ref_cache
*packed
;
1091 * The submodule name, or "" for the main repo. We allocate
1092 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1093 * is initialized correctly.
1096 } ref_cache
, *submodule_ref_caches
;
1098 /* Lock used for the main packed-refs file: */
1099 static struct lock_file packlock
;
1102 * Increment the reference count of *packed_refs.
1104 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1106 packed_refs
->referrers
++;
1110 * Decrease the reference count of *packed_refs. If it goes to zero,
1111 * free *packed_refs and return true; otherwise return false.
1113 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1115 if (!--packed_refs
->referrers
) {
1116 free_ref_entry(packed_refs
->root
);
1117 stat_validity_clear(&packed_refs
->validity
);
1125 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1128 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1130 if (packed_refs
->lock
)
1131 die("internal error: packed-ref cache cleared while locked");
1132 refs
->packed
= NULL
;
1133 release_packed_ref_cache(packed_refs
);
1137 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1140 free_ref_entry(refs
->loose
);
1145 static struct ref_cache
*create_ref_cache(const char *submodule
)
1148 struct ref_cache
*refs
;
1151 len
= strlen(submodule
) + 1;
1152 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1153 memcpy(refs
->name
, submodule
, len
);
1158 * Return a pointer to a ref_cache for the specified submodule. For
1159 * the main repository, use submodule==NULL. The returned structure
1160 * will be allocated and initialized but not necessarily populated; it
1161 * should not be freed.
1163 static struct ref_cache
*get_ref_cache(const char *submodule
)
1165 struct ref_cache
*refs
;
1167 if (!submodule
|| !*submodule
)
1170 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1171 if (!strcmp(submodule
, refs
->name
))
1174 refs
= create_ref_cache(submodule
);
1175 refs
->next
= submodule_ref_caches
;
1176 submodule_ref_caches
= refs
;
1180 /* The length of a peeled reference line in packed-refs, including EOL: */
1181 #define PEELED_LINE_LENGTH 42
1184 * The packed-refs header line that we write out. Perhaps other
1185 * traits will be added later. The trailing space is required.
1187 static const char PACKED_REFS_HEADER
[] =
1188 "# pack-refs with: peeled fully-peeled \n";
1191 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1192 * Return a pointer to the refname within the line (null-terminated),
1193 * or NULL if there was a problem.
1195 static const char *parse_ref_line(struct strbuf
*line
, unsigned char *sha1
)
1200 * 42: the answer to everything.
1202 * In this case, it happens to be the answer to
1203 * 40 (length of sha1 hex representation)
1204 * +1 (space in between hex and name)
1205 * +1 (newline at the end of the line)
1207 if (line
->len
<= 42)
1210 if (get_sha1_hex(line
->buf
, sha1
) < 0)
1212 if (!isspace(line
->buf
[40]))
1215 ref
= line
->buf
+ 41;
1219 if (line
->buf
[line
->len
- 1] != '\n')
1221 line
->buf
[--line
->len
] = 0;
1227 * Read f, which is a packed-refs file, into dir.
1229 * A comment line of the form "# pack-refs with: " may contain zero or
1230 * more traits. We interpret the traits as follows:
1234 * Probably no references are peeled. But if the file contains a
1235 * peeled value for a reference, we will use it.
1239 * References under "refs/tags/", if they *can* be peeled, *are*
1240 * peeled in this file. References outside of "refs/tags/" are
1241 * probably not peeled even if they could have been, but if we find
1242 * a peeled value for such a reference we will use it.
1246 * All references in the file that can be peeled are peeled.
1247 * Inversely (and this is more important), any references in the
1248 * file for which no peeled value is recorded is not peelable. This
1249 * trait should typically be written alongside "peeled" for
1250 * compatibility with older clients, but we do not require it
1251 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1253 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1255 struct ref_entry
*last
= NULL
;
1256 struct strbuf line
= STRBUF_INIT
;
1257 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1259 while (strbuf_getwholeline(&line
, f
, '\n') != EOF
) {
1260 unsigned char sha1
[20];
1261 const char *refname
;
1264 if (skip_prefix(line
.buf
, "# pack-refs with:", &traits
)) {
1265 if (strstr(traits
, " fully-peeled "))
1266 peeled
= PEELED_FULLY
;
1267 else if (strstr(traits
, " peeled "))
1268 peeled
= PEELED_TAGS
;
1269 /* perhaps other traits later as well */
1273 refname
= parse_ref_line(&line
, sha1
);
1275 int flag
= REF_ISPACKED
;
1277 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1278 if (!refname_is_safe(refname
))
1279 die("packed refname is dangerous: %s", refname
);
1281 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1283 last
= create_ref_entry(refname
, sha1
, flag
, 0);
1284 if (peeled
== PEELED_FULLY
||
1285 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1286 last
->flag
|= REF_KNOWS_PEELED
;
1291 line
.buf
[0] == '^' &&
1292 line
.len
== PEELED_LINE_LENGTH
&&
1293 line
.buf
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1294 !get_sha1_hex(line
.buf
+ 1, sha1
)) {
1295 hashcpy(last
->u
.value
.peeled
.hash
, sha1
);
1297 * Regardless of what the file header said,
1298 * we definitely know the value of *this*
1301 last
->flag
|= REF_KNOWS_PEELED
;
1305 strbuf_release(&line
);
1309 * Get the packed_ref_cache for the specified ref_cache, creating it
1312 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1314 char *packed_refs_file
;
1317 packed_refs_file
= git_pathdup_submodule(refs
->name
, "packed-refs");
1319 packed_refs_file
= git_pathdup("packed-refs");
1322 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1323 clear_packed_ref_cache(refs
);
1325 if (!refs
->packed
) {
1328 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1329 acquire_packed_ref_cache(refs
->packed
);
1330 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1331 f
= fopen(packed_refs_file
, "r");
1333 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1334 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1338 free(packed_refs_file
);
1339 return refs
->packed
;
1342 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1344 return get_ref_dir(packed_ref_cache
->root
);
1347 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1349 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1353 * Add a reference to the in-memory packed reference cache. This may
1354 * only be called while the packed-refs file is locked (see
1355 * lock_packed_refs()). To actually write the packed-refs file, call
1356 * commit_packed_refs().
1358 static void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1360 struct packed_ref_cache
*packed_ref_cache
=
1361 get_packed_ref_cache(&ref_cache
);
1363 if (!packed_ref_cache
->lock
)
1364 die("internal error: packed refs not locked");
1365 add_ref(get_packed_ref_dir(packed_ref_cache
),
1366 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1370 * Read the loose references from the namespace dirname into dir
1371 * (without recursing). dirname must end with '/'. dir must be the
1372 * directory entry corresponding to dirname.
1374 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1376 struct ref_cache
*refs
= dir
->ref_cache
;
1379 int dirnamelen
= strlen(dirname
);
1380 struct strbuf refname
;
1381 struct strbuf path
= STRBUF_INIT
;
1382 size_t path_baselen
;
1385 strbuf_git_path_submodule(&path
, refs
->name
, "%s", dirname
);
1387 strbuf_git_path(&path
, "%s", dirname
);
1388 path_baselen
= path
.len
;
1390 d
= opendir(path
.buf
);
1392 strbuf_release(&path
);
1396 strbuf_init(&refname
, dirnamelen
+ 257);
1397 strbuf_add(&refname
, dirname
, dirnamelen
);
1399 while ((de
= readdir(d
)) != NULL
) {
1400 unsigned char sha1
[20];
1404 if (de
->d_name
[0] == '.')
1406 if (ends_with(de
->d_name
, ".lock"))
1408 strbuf_addstr(&refname
, de
->d_name
);
1409 strbuf_addstr(&path
, de
->d_name
);
1410 if (stat(path
.buf
, &st
) < 0) {
1411 ; /* silently ignore */
1412 } else if (S_ISDIR(st
.st_mode
)) {
1413 strbuf_addch(&refname
, '/');
1414 add_entry_to_dir(dir
,
1415 create_dir_entry(refs
, refname
.buf
,
1423 read_ok
= !resolve_gitlink_ref(refs
->name
,
1426 read_ok
= !read_ref_full(refname
.buf
,
1427 RESOLVE_REF_READING
,
1433 flag
|= REF_ISBROKEN
;
1434 } else if (is_null_sha1(sha1
)) {
1436 * It is so astronomically unlikely
1437 * that NULL_SHA1 is the SHA-1 of an
1438 * actual object that we consider its
1439 * appearance in a loose reference
1440 * file to be repo corruption
1441 * (probably due to a software bug).
1443 flag
|= REF_ISBROKEN
;
1446 if (check_refname_format(refname
.buf
,
1447 REFNAME_ALLOW_ONELEVEL
)) {
1448 if (!refname_is_safe(refname
.buf
))
1449 die("loose refname is dangerous: %s", refname
.buf
);
1451 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1453 add_entry_to_dir(dir
,
1454 create_ref_entry(refname
.buf
, sha1
, flag
, 0));
1456 strbuf_setlen(&refname
, dirnamelen
);
1457 strbuf_setlen(&path
, path_baselen
);
1459 strbuf_release(&refname
);
1460 strbuf_release(&path
);
1464 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1468 * Mark the top-level directory complete because we
1469 * are about to read the only subdirectory that can
1472 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1474 * Create an incomplete entry for "refs/":
1476 add_entry_to_dir(get_ref_dir(refs
->loose
),
1477 create_dir_entry(refs
, "refs/", 5, 1));
1479 return get_ref_dir(refs
->loose
);
1482 /* We allow "recursive" symbolic refs. Only within reason, though */
1484 #define MAXREFLEN (1024)
1487 * Called by resolve_gitlink_ref_recursive() after it failed to read
1488 * from the loose refs in ref_cache refs. Find <refname> in the
1489 * packed-refs file for the submodule.
1491 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1492 const char *refname
, unsigned char *sha1
)
1494 struct ref_entry
*ref
;
1495 struct ref_dir
*dir
= get_packed_refs(refs
);
1497 ref
= find_ref(dir
, refname
);
1501 hashcpy(sha1
, ref
->u
.value
.oid
.hash
);
1505 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1506 const char *refname
, unsigned char *sha1
,
1510 char buffer
[128], *p
;
1513 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1516 ? git_pathdup_submodule(refs
->name
, "%s", refname
)
1517 : git_pathdup("%s", refname
);
1518 fd
= open(path
, O_RDONLY
);
1521 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1523 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1527 while (len
&& isspace(buffer
[len
-1]))
1531 /* Was it a detached head or an old-fashioned symlink? */
1532 if (!get_sha1_hex(buffer
, sha1
))
1536 if (strncmp(buffer
, "ref:", 4))
1542 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1545 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1547 int len
= strlen(path
), retval
;
1549 struct ref_cache
*refs
;
1551 while (len
&& path
[len
-1] == '/')
1555 submodule
= xstrndup(path
, len
);
1556 refs
= get_ref_cache(submodule
);
1559 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1564 * Return the ref_entry for the given refname from the packed
1565 * references. If it does not exist, return NULL.
1567 static struct ref_entry
*get_packed_ref(const char *refname
)
1569 return find_ref(get_packed_refs(&ref_cache
), refname
);
1573 * A loose ref file doesn't exist; check for a packed ref. The
1574 * options are forwarded from resolve_safe_unsafe().
1576 static int resolve_missing_loose_ref(const char *refname
,
1578 unsigned char *sha1
,
1581 struct ref_entry
*entry
;
1584 * The loose reference file does not exist; check for a packed
1587 entry
= get_packed_ref(refname
);
1589 hashcpy(sha1
, entry
->u
.value
.oid
.hash
);
1591 *flags
|= REF_ISPACKED
;
1594 /* The reference is not a packed reference, either. */
1595 if (resolve_flags
& RESOLVE_REF_READING
) {
1604 /* This function needs to return a meaningful errno on failure */
1605 static const char *resolve_ref_unsafe_1(const char *refname
,
1607 unsigned char *sha1
,
1609 struct strbuf
*sb_path
)
1611 int depth
= MAXDEPTH
;
1614 static char refname_buffer
[256];
1620 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1622 *flags
|= REF_BAD_NAME
;
1624 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1625 !refname_is_safe(refname
)) {
1630 * dwim_ref() uses REF_ISBROKEN to distinguish between
1631 * missing refs and refs that were present but invalid,
1632 * to complain about the latter to stderr.
1634 * We don't know whether the ref exists, so don't set
1650 strbuf_reset(sb_path
);
1651 strbuf_git_path(sb_path
, "%s", refname
);
1652 path
= sb_path
->buf
;
1655 * We might have to loop back here to avoid a race
1656 * condition: first we lstat() the file, then we try
1657 * to read it as a link or as a file. But if somebody
1658 * changes the type of the file (file <-> directory
1659 * <-> symlink) between the lstat() and reading, then
1660 * we don't want to report that as an error but rather
1661 * try again starting with the lstat().
1664 if (lstat(path
, &st
) < 0) {
1665 if (errno
!= ENOENT
)
1667 if (resolve_missing_loose_ref(refname
, resolve_flags
,
1673 *flags
|= REF_ISBROKEN
;
1678 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1679 if (S_ISLNK(st
.st_mode
)) {
1680 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1682 if (errno
== ENOENT
|| errno
== EINVAL
)
1683 /* inconsistent with lstat; retry */
1689 if (starts_with(buffer
, "refs/") &&
1690 !check_refname_format(buffer
, 0)) {
1691 strcpy(refname_buffer
, buffer
);
1692 refname
= refname_buffer
;
1694 *flags
|= REF_ISSYMREF
;
1695 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1703 /* Is it a directory? */
1704 if (S_ISDIR(st
.st_mode
)) {
1710 * Anything else, just open it and try to use it as
1713 fd
= open(path
, O_RDONLY
);
1715 if (errno
== ENOENT
)
1716 /* inconsistent with lstat; retry */
1721 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1723 int save_errno
= errno
;
1729 while (len
&& isspace(buffer
[len
-1]))
1734 * Is it a symbolic ref?
1736 if (!starts_with(buffer
, "ref:")) {
1738 * Please note that FETCH_HEAD has a second
1739 * line containing other data.
1741 if (get_sha1_hex(buffer
, sha1
) ||
1742 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1744 *flags
|= REF_ISBROKEN
;
1751 *flags
|= REF_ISBROKEN
;
1756 *flags
|= REF_ISSYMREF
;
1758 while (isspace(*buf
))
1760 refname
= strcpy(refname_buffer
, buf
);
1761 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1765 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1767 *flags
|= REF_ISBROKEN
;
1769 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1770 !refname_is_safe(buf
)) {
1779 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1780 unsigned char *sha1
, int *flags
)
1782 struct strbuf sb_path
= STRBUF_INIT
;
1783 const char *ret
= resolve_ref_unsafe_1(refname
, resolve_flags
,
1784 sha1
, flags
, &sb_path
);
1785 strbuf_release(&sb_path
);
1789 char *resolve_refdup(const char *refname
, int resolve_flags
,
1790 unsigned char *sha1
, int *flags
)
1792 return xstrdup_or_null(resolve_ref_unsafe(refname
, resolve_flags
,
1796 /* The argument to filter_refs */
1798 const char *pattern
;
1803 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1805 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1810 int read_ref(const char *refname
, unsigned char *sha1
)
1812 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1815 int ref_exists(const char *refname
)
1817 unsigned char sha1
[20];
1818 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1821 static int filter_refs(const char *refname
, const struct object_id
*oid
,
1822 int flags
, void *data
)
1824 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1826 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1828 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
1832 /* object was peeled successfully: */
1836 * object cannot be peeled because the named object (or an
1837 * object referred to by a tag in the peel chain), does not
1842 /* object cannot be peeled because it is not a tag: */
1845 /* ref_entry contains no peeled value because it is a symref: */
1846 PEEL_IS_SYMREF
= -3,
1849 * ref_entry cannot be peeled because it is broken (i.e., the
1850 * symbolic reference cannot even be resolved to an object
1857 * Peel the named object; i.e., if the object is a tag, resolve the
1858 * tag recursively until a non-tag is found. If successful, store the
1859 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1860 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1861 * and leave sha1 unchanged.
1863 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1865 struct object
*o
= lookup_unknown_object(name
);
1867 if (o
->type
== OBJ_NONE
) {
1868 int type
= sha1_object_info(name
, NULL
);
1869 if (type
< 0 || !object_as_type(o
, type
, 0))
1870 return PEEL_INVALID
;
1873 if (o
->type
!= OBJ_TAG
)
1874 return PEEL_NON_TAG
;
1876 o
= deref_tag_noverify(o
);
1878 return PEEL_INVALID
;
1880 hashcpy(sha1
, o
->sha1
);
1885 * Peel the entry (if possible) and return its new peel_status. If
1886 * repeel is true, re-peel the entry even if there is an old peeled
1887 * value that is already stored in it.
1889 * It is OK to call this function with a packed reference entry that
1890 * might be stale and might even refer to an object that has since
1891 * been garbage-collected. In such a case, if the entry has
1892 * REF_KNOWS_PEELED then leave the status unchanged and return
1893 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1895 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1897 enum peel_status status
;
1899 if (entry
->flag
& REF_KNOWS_PEELED
) {
1901 entry
->flag
&= ~REF_KNOWS_PEELED
;
1902 oidclr(&entry
->u
.value
.peeled
);
1904 return is_null_oid(&entry
->u
.value
.peeled
) ?
1905 PEEL_NON_TAG
: PEEL_PEELED
;
1908 if (entry
->flag
& REF_ISBROKEN
)
1910 if (entry
->flag
& REF_ISSYMREF
)
1911 return PEEL_IS_SYMREF
;
1913 status
= peel_object(entry
->u
.value
.oid
.hash
, entry
->u
.value
.peeled
.hash
);
1914 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1915 entry
->flag
|= REF_KNOWS_PEELED
;
1919 int peel_ref(const char *refname
, unsigned char *sha1
)
1922 unsigned char base
[20];
1924 if (current_ref
&& (current_ref
->name
== refname
1925 || !strcmp(current_ref
->name
, refname
))) {
1926 if (peel_entry(current_ref
, 0))
1928 hashcpy(sha1
, current_ref
->u
.value
.peeled
.hash
);
1932 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1936 * If the reference is packed, read its ref_entry from the
1937 * cache in the hope that we already know its peeled value.
1938 * We only try this optimization on packed references because
1939 * (a) forcing the filling of the loose reference cache could
1940 * be expensive and (b) loose references anyway usually do not
1941 * have REF_KNOWS_PEELED.
1943 if (flag
& REF_ISPACKED
) {
1944 struct ref_entry
*r
= get_packed_ref(refname
);
1946 if (peel_entry(r
, 0))
1948 hashcpy(sha1
, r
->u
.value
.peeled
.hash
);
1953 return peel_object(base
, sha1
);
1956 struct warn_if_dangling_data
{
1958 const char *refname
;
1959 const struct string_list
*refnames
;
1960 const char *msg_fmt
;
1963 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
1964 int flags
, void *cb_data
)
1966 struct warn_if_dangling_data
*d
= cb_data
;
1967 const char *resolves_to
;
1968 struct object_id junk
;
1970 if (!(flags
& REF_ISSYMREF
))
1973 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
.hash
, NULL
);
1976 ? strcmp(resolves_to
, d
->refname
)
1977 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1981 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1986 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1988 struct warn_if_dangling_data data
;
1991 data
.refname
= refname
;
1992 data
.refnames
= NULL
;
1993 data
.msg_fmt
= msg_fmt
;
1994 for_each_rawref(warn_if_dangling_symref
, &data
);
1997 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1999 struct warn_if_dangling_data data
;
2002 data
.refname
= NULL
;
2003 data
.refnames
= refnames
;
2004 data
.msg_fmt
= msg_fmt
;
2005 for_each_rawref(warn_if_dangling_symref
, &data
);
2009 * Call fn for each reference in the specified ref_cache, omitting
2010 * references not in the containing_dir of base. fn is called for all
2011 * references, including broken ones. If fn ever returns a non-zero
2012 * value, stop the iteration and return that value; otherwise, return
2015 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
2016 each_ref_entry_fn fn
, void *cb_data
)
2018 struct packed_ref_cache
*packed_ref_cache
;
2019 struct ref_dir
*loose_dir
;
2020 struct ref_dir
*packed_dir
;
2024 * We must make sure that all loose refs are read before accessing the
2025 * packed-refs file; this avoids a race condition in which loose refs
2026 * are migrated to the packed-refs file by a simultaneous process, but
2027 * our in-memory view is from before the migration. get_packed_ref_cache()
2028 * takes care of making sure our view is up to date with what is on
2031 loose_dir
= get_loose_refs(refs
);
2032 if (base
&& *base
) {
2033 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
2036 prime_ref_dir(loose_dir
);
2038 packed_ref_cache
= get_packed_ref_cache(refs
);
2039 acquire_packed_ref_cache(packed_ref_cache
);
2040 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
2041 if (base
&& *base
) {
2042 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
2045 if (packed_dir
&& loose_dir
) {
2046 sort_ref_dir(packed_dir
);
2047 sort_ref_dir(loose_dir
);
2048 retval
= do_for_each_entry_in_dirs(
2049 packed_dir
, loose_dir
, fn
, cb_data
);
2050 } else if (packed_dir
) {
2051 sort_ref_dir(packed_dir
);
2052 retval
= do_for_each_entry_in_dir(
2053 packed_dir
, 0, fn
, cb_data
);
2054 } else if (loose_dir
) {
2055 sort_ref_dir(loose_dir
);
2056 retval
= do_for_each_entry_in_dir(
2057 loose_dir
, 0, fn
, cb_data
);
2060 release_packed_ref_cache(packed_ref_cache
);
2065 * Call fn for each reference in the specified ref_cache for which the
2066 * refname begins with base. If trim is non-zero, then trim that many
2067 * characters off the beginning of each refname before passing the
2068 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
2069 * broken references in the iteration. If fn ever returns a non-zero
2070 * value, stop the iteration and return that value; otherwise, return
2073 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
2074 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
2076 struct ref_entry_cb data
;
2081 data
.cb_data
= cb_data
;
2083 if (ref_paranoia
< 0)
2084 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
2086 data
.flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
2088 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
2091 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2093 struct object_id oid
;
2097 if (resolve_gitlink_ref(submodule
, "HEAD", oid
.hash
) == 0)
2098 return fn("HEAD", &oid
, 0, cb_data
);
2103 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, oid
.hash
, &flag
))
2104 return fn("HEAD", &oid
, flag
, cb_data
);
2109 int head_ref(each_ref_fn fn
, void *cb_data
)
2111 return do_head_ref(NULL
, fn
, cb_data
);
2114 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2116 return do_head_ref(submodule
, fn
, cb_data
);
2119 int for_each_ref(each_ref_fn fn
, void *cb_data
)
2121 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
2124 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2126 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
2129 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
2131 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
2134 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
2136 unsigned int flag
= 0;
2139 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
2140 return do_for_each_ref(&ref_cache
, prefix
, fn
, 0, flag
, cb_data
);
2143 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
2144 each_ref_fn fn
, void *cb_data
)
2146 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
2149 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
2151 return for_each_ref_in("refs/tags/", fn
, cb_data
);
2154 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2156 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
2159 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
2161 return for_each_ref_in("refs/heads/", fn
, cb_data
);
2164 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2166 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2169 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2171 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2174 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2176 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2179 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2181 return do_for_each_ref(&ref_cache
, git_replace_ref_base
, fn
,
2182 strlen(git_replace_ref_base
), 0, cb_data
);
2185 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2187 struct strbuf buf
= STRBUF_INIT
;
2189 struct object_id oid
;
2192 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2193 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, oid
.hash
, &flag
))
2194 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
2195 strbuf_release(&buf
);
2200 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2202 struct strbuf buf
= STRBUF_INIT
;
2204 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2205 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2206 strbuf_release(&buf
);
2210 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2211 const char *prefix
, void *cb_data
)
2213 struct strbuf real_pattern
= STRBUF_INIT
;
2214 struct ref_filter filter
;
2217 if (!prefix
&& !starts_with(pattern
, "refs/"))
2218 strbuf_addstr(&real_pattern
, "refs/");
2220 strbuf_addstr(&real_pattern
, prefix
);
2221 strbuf_addstr(&real_pattern
, pattern
);
2223 if (!has_glob_specials(pattern
)) {
2224 /* Append implied '/' '*' if not present. */
2225 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2226 strbuf_addch(&real_pattern
, '/');
2227 /* No need to check for '*', there is none. */
2228 strbuf_addch(&real_pattern
, '*');
2231 filter
.pattern
= real_pattern
.buf
;
2233 filter
.cb_data
= cb_data
;
2234 ret
= for_each_ref(filter_refs
, &filter
);
2236 strbuf_release(&real_pattern
);
2240 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2242 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2245 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2247 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2248 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2251 const char *prettify_refname(const char *name
)
2254 starts_with(name
, "refs/heads/") ? 11 :
2255 starts_with(name
, "refs/tags/") ? 10 :
2256 starts_with(name
, "refs/remotes/") ? 13 :
2260 static const char *ref_rev_parse_rules
[] = {
2265 "refs/remotes/%.*s",
2266 "refs/remotes/%.*s/HEAD",
2270 int refname_match(const char *abbrev_name
, const char *full_name
)
2273 const int abbrev_name_len
= strlen(abbrev_name
);
2275 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2276 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2284 static void unlock_ref(struct ref_lock
*lock
)
2286 /* Do not free lock->lk -- atexit() still looks at them */
2288 rollback_lock_file(lock
->lk
);
2289 free(lock
->ref_name
);
2290 free(lock
->orig_ref_name
);
2295 * Verify that the reference locked by lock has the value old_sha1.
2296 * Fail if the reference doesn't exist and mustexist is set. Return 0
2297 * on success. On error, write an error message to err, set errno, and
2298 * return a negative value.
2300 static int verify_lock(struct ref_lock
*lock
,
2301 const unsigned char *old_sha1
, int mustexist
,
2306 if (read_ref_full(lock
->ref_name
,
2307 mustexist
? RESOLVE_REF_READING
: 0,
2308 lock
->old_oid
.hash
, NULL
)) {
2309 int save_errno
= errno
;
2310 strbuf_addf(err
, "can't verify ref %s", lock
->ref_name
);
2314 if (hashcmp(lock
->old_oid
.hash
, old_sha1
)) {
2315 strbuf_addf(err
, "ref %s is at %s but expected %s",
2317 sha1_to_hex(lock
->old_oid
.hash
),
2318 sha1_to_hex(old_sha1
));
2325 static int remove_empty_directories(struct strbuf
*path
)
2328 * we want to create a file but there is a directory there;
2329 * if that is an empty directory (or a directory that contains
2330 * only empty directories), remove them.
2332 return remove_dir_recursively(path
, REMOVE_DIR_EMPTY_ONLY
);
2336 * *string and *len will only be substituted, and *string returned (for
2337 * later free()ing) if the string passed in is a magic short-hand form
2340 static char *substitute_branch_name(const char **string
, int *len
)
2342 struct strbuf buf
= STRBUF_INIT
;
2343 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2347 *string
= strbuf_detach(&buf
, &size
);
2349 return (char *)*string
;
2355 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2357 char *last_branch
= substitute_branch_name(&str
, &len
);
2362 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2363 char fullref
[PATH_MAX
];
2364 unsigned char sha1_from_ref
[20];
2365 unsigned char *this_result
;
2368 this_result
= refs_found
? sha1_from_ref
: sha1
;
2369 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2370 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2371 this_result
, &flag
);
2375 if (!warn_ambiguous_refs
)
2377 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2378 warning("ignoring dangling symref %s.", fullref
);
2379 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2380 warning("ignoring broken ref %s.", fullref
);
2387 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2389 char *last_branch
= substitute_branch_name(&str
, &len
);
2394 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2395 unsigned char hash
[20];
2396 char path
[PATH_MAX
];
2397 const char *ref
, *it
;
2399 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2400 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2404 if (reflog_exists(path
))
2406 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2410 if (!logs_found
++) {
2412 hashcpy(sha1
, hash
);
2414 if (!warn_ambiguous_refs
)
2422 * Locks a ref returning the lock on success and NULL on failure.
2423 * On failure errno is set to something meaningful.
2425 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2426 const unsigned char *old_sha1
,
2427 const struct string_list
*extras
,
2428 const struct string_list
*skip
,
2429 unsigned int flags
, int *type_p
,
2432 struct strbuf ref_file
= STRBUF_INIT
;
2433 struct strbuf orig_ref_file
= STRBUF_INIT
;
2434 const char *orig_refname
= refname
;
2435 struct ref_lock
*lock
;
2438 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2439 int resolve_flags
= 0;
2440 int attempts_remaining
= 3;
2444 lock
= xcalloc(1, sizeof(struct ref_lock
));
2447 resolve_flags
|= RESOLVE_REF_READING
;
2448 if (flags
& REF_DELETING
) {
2449 resolve_flags
|= RESOLVE_REF_ALLOW_BAD_NAME
;
2450 if (flags
& REF_NODEREF
)
2451 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2454 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2455 lock
->old_oid
.hash
, &type
);
2456 if (!refname
&& errno
== EISDIR
) {
2458 * we are trying to lock foo but we used to
2459 * have foo/bar which now does not exist;
2460 * it is normal for the empty directory 'foo'
2463 strbuf_git_path(&orig_ref_file
, "%s", orig_refname
);
2464 if (remove_empty_directories(&orig_ref_file
)) {
2466 if (!verify_refname_available(orig_refname
, extras
, skip
,
2467 get_loose_refs(&ref_cache
), err
))
2468 strbuf_addf(err
, "there are still refs under '%s'",
2472 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2473 lock
->old_oid
.hash
, &type
);
2479 if (last_errno
!= ENOTDIR
||
2480 !verify_refname_available(orig_refname
, extras
, skip
,
2481 get_loose_refs(&ref_cache
), err
))
2482 strbuf_addf(err
, "unable to resolve reference %s: %s",
2483 orig_refname
, strerror(last_errno
));
2488 * If the ref did not exist and we are creating it, make sure
2489 * there is no existing packed ref whose name begins with our
2490 * refname, nor a packed ref whose name is a proper prefix of
2493 if (is_null_oid(&lock
->old_oid
) &&
2494 verify_refname_available(refname
, extras
, skip
,
2495 get_packed_refs(&ref_cache
), err
)) {
2496 last_errno
= ENOTDIR
;
2500 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2503 if (flags
& REF_NODEREF
) {
2504 refname
= orig_refname
;
2505 lflags
|= LOCK_NO_DEREF
;
2507 lock
->ref_name
= xstrdup(refname
);
2508 lock
->orig_ref_name
= xstrdup(orig_refname
);
2509 strbuf_git_path(&ref_file
, "%s", refname
);
2512 switch (safe_create_leading_directories_const(ref_file
.buf
)) {
2514 break; /* success */
2516 if (--attempts_remaining
> 0)
2521 strbuf_addf(err
, "unable to create directory for %s",
2526 if (hold_lock_file_for_update(lock
->lk
, ref_file
.buf
, lflags
) < 0) {
2528 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2530 * Maybe somebody just deleted one of the
2531 * directories leading to ref_file. Try
2536 unable_to_lock_message(ref_file
.buf
, errno
, err
);
2540 if (old_sha1
&& verify_lock(lock
, old_sha1
, mustexist
, err
)) {
2551 strbuf_release(&ref_file
);
2552 strbuf_release(&orig_ref_file
);
2558 * Write an entry to the packed-refs file for the specified refname.
2559 * If peeled is non-NULL, write it as the entry's peeled value.
2561 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2562 unsigned char *peeled
)
2564 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2566 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2570 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2572 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2574 enum peel_status peel_status
= peel_entry(entry
, 0);
2576 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2577 error("internal error: %s is not a valid packed reference!",
2579 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.oid
.hash
,
2580 peel_status
== PEEL_PEELED
?
2581 entry
->u
.value
.peeled
.hash
: NULL
);
2586 * Lock the packed-refs file for writing. Flags is passed to
2587 * hold_lock_file_for_update(). Return 0 on success. On errors, set
2588 * errno appropriately and return a nonzero value.
2590 static int lock_packed_refs(int flags
)
2592 static int timeout_configured
= 0;
2593 static int timeout_value
= 1000;
2595 struct packed_ref_cache
*packed_ref_cache
;
2597 if (!timeout_configured
) {
2598 git_config_get_int("core.packedrefstimeout", &timeout_value
);
2599 timeout_configured
= 1;
2602 if (hold_lock_file_for_update_timeout(
2603 &packlock
, git_path("packed-refs"),
2604 flags
, timeout_value
) < 0)
2607 * Get the current packed-refs while holding the lock. If the
2608 * packed-refs file has been modified since we last read it,
2609 * this will automatically invalidate the cache and re-read
2610 * the packed-refs file.
2612 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2613 packed_ref_cache
->lock
= &packlock
;
2614 /* Increment the reference count to prevent it from being freed: */
2615 acquire_packed_ref_cache(packed_ref_cache
);
2620 * Write the current version of the packed refs cache from memory to
2621 * disk. The packed-refs file must already be locked for writing (see
2622 * lock_packed_refs()). Return zero on success. On errors, set errno
2623 * and return a nonzero value
2625 static int commit_packed_refs(void)
2627 struct packed_ref_cache
*packed_ref_cache
=
2628 get_packed_ref_cache(&ref_cache
);
2633 if (!packed_ref_cache
->lock
)
2634 die("internal error: packed-refs not locked");
2636 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2638 die_errno("unable to fdopen packed-refs descriptor");
2640 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2641 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2642 0, write_packed_entry_fn
, out
);
2644 if (commit_lock_file(packed_ref_cache
->lock
)) {
2648 packed_ref_cache
->lock
= NULL
;
2649 release_packed_ref_cache(packed_ref_cache
);
2655 * Rollback the lockfile for the packed-refs file, and discard the
2656 * in-memory packed reference cache. (The packed-refs file will be
2657 * read anew if it is needed again after this function is called.)
2659 static void rollback_packed_refs(void)
2661 struct packed_ref_cache
*packed_ref_cache
=
2662 get_packed_ref_cache(&ref_cache
);
2664 if (!packed_ref_cache
->lock
)
2665 die("internal error: packed-refs not locked");
2666 rollback_lock_file(packed_ref_cache
->lock
);
2667 packed_ref_cache
->lock
= NULL
;
2668 release_packed_ref_cache(packed_ref_cache
);
2669 clear_packed_ref_cache(&ref_cache
);
2672 struct ref_to_prune
{
2673 struct ref_to_prune
*next
;
2674 unsigned char sha1
[20];
2675 char name
[FLEX_ARRAY
];
2678 struct pack_refs_cb_data
{
2680 struct ref_dir
*packed_refs
;
2681 struct ref_to_prune
*ref_to_prune
;
2684 static int is_per_worktree_ref(const char *refname
);
2687 * An each_ref_entry_fn that is run over loose references only. If
2688 * the loose reference can be packed, add an entry in the packed ref
2689 * cache. If the reference should be pruned, also add it to
2690 * ref_to_prune in the pack_refs_cb_data.
2692 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2694 struct pack_refs_cb_data
*cb
= cb_data
;
2695 enum peel_status peel_status
;
2696 struct ref_entry
*packed_entry
;
2697 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2699 /* Do not pack per-worktree refs: */
2700 if (is_per_worktree_ref(entry
->name
))
2703 /* ALWAYS pack tags */
2704 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2707 /* Do not pack symbolic or broken refs: */
2708 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2711 /* Add a packed ref cache entry equivalent to the loose entry. */
2712 peel_status
= peel_entry(entry
, 1);
2713 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2714 die("internal error peeling reference %s (%s)",
2715 entry
->name
, oid_to_hex(&entry
->u
.value
.oid
));
2716 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2718 /* Overwrite existing packed entry with info from loose entry */
2719 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2720 oidcpy(&packed_entry
->u
.value
.oid
, &entry
->u
.value
.oid
);
2722 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.oid
.hash
,
2723 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2724 add_ref(cb
->packed_refs
, packed_entry
);
2726 oidcpy(&packed_entry
->u
.value
.peeled
, &entry
->u
.value
.peeled
);
2728 /* Schedule the loose reference for pruning if requested. */
2729 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2730 int namelen
= strlen(entry
->name
) + 1;
2731 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2732 hashcpy(n
->sha1
, entry
->u
.value
.oid
.hash
);
2733 strcpy(n
->name
, entry
->name
);
2734 n
->next
= cb
->ref_to_prune
;
2735 cb
->ref_to_prune
= n
;
2741 * Remove empty parents, but spare refs/ and immediate subdirs.
2742 * Note: munges *name.
2744 static void try_remove_empty_parents(char *name
)
2749 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2750 while (*p
&& *p
!= '/')
2752 /* tolerate duplicate slashes; see check_refname_format() */
2756 for (q
= p
; *q
; q
++)
2759 while (q
> p
&& *q
!= '/')
2761 while (q
> p
&& *(q
-1) == '/')
2766 if (rmdir(git_path("%s", name
)))
2771 /* make sure nobody touched the ref, and unlink */
2772 static void prune_ref(struct ref_to_prune
*r
)
2774 struct ref_transaction
*transaction
;
2775 struct strbuf err
= STRBUF_INIT
;
2777 if (check_refname_format(r
->name
, 0))
2780 transaction
= ref_transaction_begin(&err
);
2782 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2783 REF_ISPRUNING
, NULL
, &err
) ||
2784 ref_transaction_commit(transaction
, &err
)) {
2785 ref_transaction_free(transaction
);
2786 error("%s", err
.buf
);
2787 strbuf_release(&err
);
2790 ref_transaction_free(transaction
);
2791 strbuf_release(&err
);
2792 try_remove_empty_parents(r
->name
);
2795 static void prune_refs(struct ref_to_prune
*r
)
2803 int pack_refs(unsigned int flags
)
2805 struct pack_refs_cb_data cbdata
;
2807 memset(&cbdata
, 0, sizeof(cbdata
));
2808 cbdata
.flags
= flags
;
2810 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2811 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2813 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2814 pack_if_possible_fn
, &cbdata
);
2816 if (commit_packed_refs())
2817 die_errno("unable to overwrite old ref-pack file");
2819 prune_refs(cbdata
.ref_to_prune
);
2824 * Rewrite the packed-refs file, omitting any refs listed in
2825 * 'refnames'. On error, leave packed-refs unchanged, write an error
2826 * message to 'err', and return a nonzero value.
2828 * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
2830 static int repack_without_refs(struct string_list
*refnames
, struct strbuf
*err
)
2832 struct ref_dir
*packed
;
2833 struct string_list_item
*refname
;
2834 int ret
, needs_repacking
= 0, removed
= 0;
2838 /* Look for a packed ref */
2839 for_each_string_list_item(refname
, refnames
) {
2840 if (get_packed_ref(refname
->string
)) {
2841 needs_repacking
= 1;
2846 /* Avoid locking if we have nothing to do */
2847 if (!needs_repacking
)
2848 return 0; /* no refname exists in packed refs */
2850 if (lock_packed_refs(0)) {
2851 unable_to_lock_message(git_path("packed-refs"), errno
, err
);
2854 packed
= get_packed_refs(&ref_cache
);
2856 /* Remove refnames from the cache */
2857 for_each_string_list_item(refname
, refnames
)
2858 if (remove_entry(packed
, refname
->string
) != -1)
2862 * All packed entries disappeared while we were
2863 * acquiring the lock.
2865 rollback_packed_refs();
2869 /* Write what remains */
2870 ret
= commit_packed_refs();
2872 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2877 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2881 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2883 * loose. The loose file name is the same as the
2884 * lockfile name, minus ".lock":
2886 char *loose_filename
= get_locked_file_path(lock
->lk
);
2887 int res
= unlink_or_msg(loose_filename
, err
);
2888 free(loose_filename
);
2895 static int is_per_worktree_ref(const char *refname
)
2897 return !strcmp(refname
, "HEAD") ||
2898 starts_with(refname
, "refs/bisect/");
2901 static int is_pseudoref_syntax(const char *refname
)
2905 for (c
= refname
; *c
; c
++) {
2906 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
2913 enum ref_type
ref_type(const char *refname
)
2915 if (is_per_worktree_ref(refname
))
2916 return REF_TYPE_PER_WORKTREE
;
2917 if (is_pseudoref_syntax(refname
))
2918 return REF_TYPE_PSEUDOREF
;
2919 return REF_TYPE_NORMAL
;
2922 static int write_pseudoref(const char *pseudoref
, const unsigned char *sha1
,
2923 const unsigned char *old_sha1
, struct strbuf
*err
)
2925 const char *filename
;
2927 static struct lock_file lock
;
2928 struct strbuf buf
= STRBUF_INIT
;
2931 strbuf_addf(&buf
, "%s\n", sha1_to_hex(sha1
));
2933 filename
= git_path("%s", pseudoref
);
2934 fd
= hold_lock_file_for_update(&lock
, filename
, LOCK_DIE_ON_ERROR
);
2936 strbuf_addf(err
, "Could not open '%s' for writing: %s",
2937 filename
, strerror(errno
));
2942 unsigned char actual_old_sha1
[20];
2944 if (read_ref(pseudoref
, actual_old_sha1
))
2945 die("could not read ref '%s'", pseudoref
);
2946 if (hashcmp(actual_old_sha1
, old_sha1
)) {
2947 strbuf_addf(err
, "Unexpected sha1 when writing %s", pseudoref
);
2948 rollback_lock_file(&lock
);
2953 if (write_in_full(fd
, buf
.buf
, buf
.len
) != buf
.len
) {
2954 strbuf_addf(err
, "Could not write to '%s'", filename
);
2955 rollback_lock_file(&lock
);
2959 commit_lock_file(&lock
);
2962 strbuf_release(&buf
);
2966 static int delete_pseudoref(const char *pseudoref
, const unsigned char *old_sha1
)
2968 static struct lock_file lock
;
2969 const char *filename
;
2971 filename
= git_path("%s", pseudoref
);
2973 if (old_sha1
&& !is_null_sha1(old_sha1
)) {
2975 unsigned char actual_old_sha1
[20];
2977 fd
= hold_lock_file_for_update(&lock
, filename
,
2980 die_errno(_("Could not open '%s' for writing"), filename
);
2981 if (read_ref(pseudoref
, actual_old_sha1
))
2982 die("could not read ref '%s'", pseudoref
);
2983 if (hashcmp(actual_old_sha1
, old_sha1
)) {
2984 warning("Unexpected sha1 when deleting %s", pseudoref
);
2985 rollback_lock_file(&lock
);
2990 rollback_lock_file(&lock
);
2998 int delete_ref(const char *refname
, const unsigned char *old_sha1
,
3001 struct ref_transaction
*transaction
;
3002 struct strbuf err
= STRBUF_INIT
;
3004 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
)
3005 return delete_pseudoref(refname
, old_sha1
);
3007 transaction
= ref_transaction_begin(&err
);
3009 ref_transaction_delete(transaction
, refname
, old_sha1
,
3010 flags
, NULL
, &err
) ||
3011 ref_transaction_commit(transaction
, &err
)) {
3012 error("%s", err
.buf
);
3013 ref_transaction_free(transaction
);
3014 strbuf_release(&err
);
3017 ref_transaction_free(transaction
);
3018 strbuf_release(&err
);
3022 int delete_refs(struct string_list
*refnames
)
3024 struct strbuf err
= STRBUF_INIT
;
3030 result
= repack_without_refs(refnames
, &err
);
3033 * If we failed to rewrite the packed-refs file, then
3034 * it is unsafe to try to remove loose refs, because
3035 * doing so might expose an obsolete packed value for
3036 * a reference that might even point at an object that
3037 * has been garbage collected.
3039 if (refnames
->nr
== 1)
3040 error(_("could not delete reference %s: %s"),
3041 refnames
->items
[0].string
, err
.buf
);
3043 error(_("could not delete references: %s"), err
.buf
);
3048 for (i
= 0; i
< refnames
->nr
; i
++) {
3049 const char *refname
= refnames
->items
[i
].string
;
3051 if (delete_ref(refname
, NULL
, 0))
3052 result
|= error(_("could not remove reference %s"), refname
);
3056 strbuf_release(&err
);
3061 * People using contrib's git-new-workdir have .git/logs/refs ->
3062 * /some/other/path/.git/logs/refs, and that may live on another device.
3064 * IOW, to avoid cross device rename errors, the temporary renamed log must
3065 * live into logs/refs.
3067 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
3069 static int rename_tmp_log(const char *newrefname
)
3071 int attempts_remaining
= 4;
3072 struct strbuf path
= STRBUF_INIT
;
3076 strbuf_reset(&path
);
3077 strbuf_git_path(&path
, "logs/%s", newrefname
);
3078 switch (safe_create_leading_directories_const(path
.buf
)) {
3080 break; /* success */
3082 if (--attempts_remaining
> 0)
3086 error("unable to create directory for %s", newrefname
);
3090 if (rename(git_path(TMP_RENAMED_LOG
), path
.buf
)) {
3091 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
3093 * rename(a, b) when b is an existing
3094 * directory ought to result in ISDIR, but
3095 * Solaris 5.8 gives ENOTDIR. Sheesh.
3097 if (remove_empty_directories(&path
)) {
3098 error("Directory not empty: logs/%s", newrefname
);
3102 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
3104 * Maybe another process just deleted one of
3105 * the directories in the path to newrefname.
3106 * Try again from the beginning.
3110 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
3111 newrefname
, strerror(errno
));
3117 strbuf_release(&path
);
3121 static int rename_ref_available(const char *oldname
, const char *newname
)
3123 struct string_list skip
= STRING_LIST_INIT_NODUP
;
3124 struct strbuf err
= STRBUF_INIT
;
3127 string_list_insert(&skip
, oldname
);
3128 ret
= !verify_refname_available(newname
, NULL
, &skip
,
3129 get_packed_refs(&ref_cache
), &err
)
3130 && !verify_refname_available(newname
, NULL
, &skip
,
3131 get_loose_refs(&ref_cache
), &err
);
3133 error("%s", err
.buf
);
3135 string_list_clear(&skip
, 0);
3136 strbuf_release(&err
);
3140 static int write_ref_to_lockfile(struct ref_lock
*lock
,
3141 const unsigned char *sha1
, struct strbuf
*err
);
3142 static int commit_ref_update(struct ref_lock
*lock
,
3143 const unsigned char *sha1
, const char *logmsg
,
3144 int flags
, struct strbuf
*err
);
3146 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
3148 unsigned char sha1
[20], orig_sha1
[20];
3149 int flag
= 0, logmoved
= 0;
3150 struct ref_lock
*lock
;
3151 struct stat loginfo
;
3152 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
3153 const char *symref
= NULL
;
3154 struct strbuf err
= STRBUF_INIT
;
3156 if (log
&& S_ISLNK(loginfo
.st_mode
))
3157 return error("reflog for %s is a symlink", oldrefname
);
3159 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
3161 if (flag
& REF_ISSYMREF
)
3162 return error("refname %s is a symbolic ref, renaming it is not supported",
3165 return error("refname %s not found", oldrefname
);
3167 if (!rename_ref_available(oldrefname
, newrefname
))
3170 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
3171 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
3172 oldrefname
, strerror(errno
));
3174 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
3175 error("unable to delete old %s", oldrefname
);
3179 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
3180 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
3181 if (errno
==EISDIR
) {
3182 struct strbuf path
= STRBUF_INIT
;
3185 strbuf_git_path(&path
, "%s", newrefname
);
3186 result
= remove_empty_directories(&path
);
3187 strbuf_release(&path
);
3190 error("Directory not empty: %s", newrefname
);
3194 error("unable to delete existing %s", newrefname
);
3199 if (log
&& rename_tmp_log(newrefname
))
3204 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, NULL
, 0, NULL
, &err
);
3206 error("unable to rename '%s' to '%s': %s", oldrefname
, newrefname
, err
.buf
);
3207 strbuf_release(&err
);
3210 hashcpy(lock
->old_oid
.hash
, orig_sha1
);
3212 if (write_ref_to_lockfile(lock
, orig_sha1
, &err
) ||
3213 commit_ref_update(lock
, orig_sha1
, logmsg
, 0, &err
)) {
3214 error("unable to write current sha1 into %s: %s", newrefname
, err
.buf
);
3215 strbuf_release(&err
);
3222 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, NULL
, 0, NULL
, &err
);
3224 error("unable to lock %s for rollback: %s", oldrefname
, err
.buf
);
3225 strbuf_release(&err
);
3229 flag
= log_all_ref_updates
;
3230 log_all_ref_updates
= 0;
3231 if (write_ref_to_lockfile(lock
, orig_sha1
, &err
) ||
3232 commit_ref_update(lock
, orig_sha1
, NULL
, 0, &err
)) {
3233 error("unable to write current sha1 into %s: %s", oldrefname
, err
.buf
);
3234 strbuf_release(&err
);
3236 log_all_ref_updates
= flag
;
3239 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
3240 error("unable to restore logfile %s from %s: %s",
3241 oldrefname
, newrefname
, strerror(errno
));
3242 if (!logmoved
&& log
&&
3243 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
3244 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
3245 oldrefname
, strerror(errno
));
3250 static int close_ref(struct ref_lock
*lock
)
3252 if (close_lock_file(lock
->lk
))
3257 static int commit_ref(struct ref_lock
*lock
)
3259 if (commit_lock_file(lock
->lk
))
3265 * copy the reflog message msg to buf, which has been allocated sufficiently
3266 * large, while cleaning up the whitespaces. Especially, convert LF to space,
3267 * because reflog file is one line per entry.
3269 static int copy_msg(char *buf
, const char *msg
)
3276 while ((c
= *msg
++)) {
3277 if (wasspace
&& isspace(c
))
3279 wasspace
= isspace(c
);
3284 while (buf
< cp
&& isspace(cp
[-1]))
3290 static int should_autocreate_reflog(const char *refname
)
3292 if (!log_all_ref_updates
)
3294 return starts_with(refname
, "refs/heads/") ||
3295 starts_with(refname
, "refs/remotes/") ||
3296 starts_with(refname
, "refs/notes/") ||
3297 !strcmp(refname
, "HEAD");
3301 * Create a reflog for a ref. If force_create = 0, the reflog will
3302 * only be created for certain refs (those for which
3303 * should_autocreate_reflog returns non-zero. Otherwise, create it
3304 * regardless of the ref name. Fill in *err and return -1 on failure.
3306 static int log_ref_setup(const char *refname
, struct strbuf
*logfile
, struct strbuf
*err
, int force_create
)
3308 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
3310 strbuf_git_path(logfile
, "logs/%s", refname
);
3311 if (force_create
|| should_autocreate_reflog(refname
)) {
3312 if (safe_create_leading_directories(logfile
->buf
) < 0) {
3313 strbuf_addf(err
, "unable to create directory for %s: "
3314 "%s", logfile
->buf
, strerror(errno
));
3320 logfd
= open(logfile
->buf
, oflags
, 0666);
3322 if (!(oflags
& O_CREAT
) && (errno
== ENOENT
|| errno
== EISDIR
))
3325 if (errno
== EISDIR
) {
3326 if (remove_empty_directories(logfile
)) {
3327 strbuf_addf(err
, "There are still logs under "
3328 "'%s'", logfile
->buf
);
3331 logfd
= open(logfile
->buf
, oflags
, 0666);
3335 strbuf_addf(err
, "unable to append to %s: %s",
3336 logfile
->buf
, strerror(errno
));
3341 adjust_shared_perm(logfile
->buf
);
3347 int safe_create_reflog(const char *refname
, int force_create
, struct strbuf
*err
)
3350 struct strbuf sb
= STRBUF_INIT
;
3352 ret
= log_ref_setup(refname
, &sb
, err
, force_create
);
3353 strbuf_release(&sb
);
3357 static int log_ref_write_fd(int fd
, const unsigned char *old_sha1
,
3358 const unsigned char *new_sha1
,
3359 const char *committer
, const char *msg
)
3361 int msglen
, written
;
3362 unsigned maxlen
, len
;
3365 msglen
= msg
? strlen(msg
) : 0;
3366 maxlen
= strlen(committer
) + msglen
+ 100;
3367 logrec
= xmalloc(maxlen
);
3368 len
= sprintf(logrec
, "%s %s %s\n",
3369 sha1_to_hex(old_sha1
),
3370 sha1_to_hex(new_sha1
),
3373 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
3375 written
= len
<= maxlen
? write_in_full(fd
, logrec
, len
) : -1;
3383 static int log_ref_write_1(const char *refname
, const unsigned char *old_sha1
,
3384 const unsigned char *new_sha1
, const char *msg
,
3385 struct strbuf
*logfile
, int flags
,
3388 int logfd
, result
, oflags
= O_APPEND
| O_WRONLY
;
3390 if (log_all_ref_updates
< 0)
3391 log_all_ref_updates
= !is_bare_repository();
3393 result
= log_ref_setup(refname
, logfile
, err
, flags
& REF_FORCE_CREATE_REFLOG
);
3398 logfd
= open(logfile
->buf
, oflags
);
3401 result
= log_ref_write_fd(logfd
, old_sha1
, new_sha1
,
3402 git_committer_info(0), msg
);
3404 strbuf_addf(err
, "unable to append to %s: %s", logfile
->buf
,
3410 strbuf_addf(err
, "unable to append to %s: %s", logfile
->buf
,
3417 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
3418 const unsigned char *new_sha1
, const char *msg
,
3419 int flags
, struct strbuf
*err
)
3421 struct strbuf sb
= STRBUF_INIT
;
3422 int ret
= log_ref_write_1(refname
, old_sha1
, new_sha1
, msg
, &sb
, flags
,
3424 strbuf_release(&sb
);
3428 int is_branch(const char *refname
)
3430 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3434 * Write sha1 into the open lockfile, then close the lockfile. On
3435 * errors, rollback the lockfile, fill in *err and
3438 static int write_ref_to_lockfile(struct ref_lock
*lock
,
3439 const unsigned char *sha1
, struct strbuf
*err
)
3441 static char term
= '\n';
3445 o
= parse_object(sha1
);
3448 "Trying to write ref %s with nonexistent object %s",
3449 lock
->ref_name
, sha1_to_hex(sha1
));
3453 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3455 "Trying to write non-commit object %s to branch %s",
3456 sha1_to_hex(sha1
), lock
->ref_name
);
3460 fd
= get_lock_file_fd(lock
->lk
);
3461 if (write_in_full(fd
, sha1_to_hex(sha1
), 40) != 40 ||
3462 write_in_full(fd
, &term
, 1) != 1 ||
3463 close_ref(lock
) < 0) {
3465 "Couldn't write %s", get_lock_file_path(lock
->lk
));
3473 * Commit a change to a loose reference that has already been written
3474 * to the loose reference lockfile. Also update the reflogs if
3475 * necessary, using the specified lockmsg (which can be NULL).
3477 static int commit_ref_update(struct ref_lock
*lock
,
3478 const unsigned char *sha1
, const char *logmsg
,
3479 int flags
, struct strbuf
*err
)
3481 clear_loose_ref_cache(&ref_cache
);
3482 if (log_ref_write(lock
->ref_name
, lock
->old_oid
.hash
, sha1
, logmsg
, flags
, err
) < 0 ||
3483 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3484 log_ref_write(lock
->orig_ref_name
, lock
->old_oid
.hash
, sha1
, logmsg
, flags
, err
) < 0)) {
3485 char *old_msg
= strbuf_detach(err
, NULL
);
3486 strbuf_addf(err
, "Cannot update the ref '%s': %s",
3487 lock
->ref_name
, old_msg
);
3492 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3494 * Special hack: If a branch is updated directly and HEAD
3495 * points to it (may happen on the remote side of a push
3496 * for example) then logically the HEAD reflog should be
3498 * A generic solution implies reverse symref information,
3499 * but finding all symrefs pointing to the given branch
3500 * would be rather costly for this rare event (the direct
3501 * update of a branch) to be worth it. So let's cheat and
3502 * check with HEAD only which should cover 99% of all usage
3503 * scenarios (even 100% of the default ones).
3505 unsigned char head_sha1
[20];
3507 const char *head_ref
;
3508 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3509 head_sha1
, &head_flag
);
3510 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3511 !strcmp(head_ref
, lock
->ref_name
)) {
3512 struct strbuf log_err
= STRBUF_INIT
;
3513 if (log_ref_write("HEAD", lock
->old_oid
.hash
, sha1
,
3514 logmsg
, 0, &log_err
)) {
3515 error("%s", log_err
.buf
);
3516 strbuf_release(&log_err
);
3520 if (commit_ref(lock
)) {
3521 error("Couldn't set %s", lock
->ref_name
);
3530 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3533 char *lockpath
= NULL
;
3535 int fd
, len
, written
;
3536 char *git_HEAD
= git_pathdup("%s", ref_target
);
3537 unsigned char old_sha1
[20], new_sha1
[20];
3538 struct strbuf err
= STRBUF_INIT
;
3540 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3543 if (safe_create_leading_directories(git_HEAD
) < 0)
3544 return error("unable to create directory for %s", git_HEAD
);
3546 #ifndef NO_SYMLINK_HEAD
3547 if (prefer_symlink_refs
) {
3549 if (!symlink(refs_heads_master
, git_HEAD
))
3551 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3555 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3556 if (sizeof(ref
) <= len
) {
3557 error("refname too long: %s", refs_heads_master
);
3558 goto error_free_return
;
3560 lockpath
= mkpathdup("%s.lock", git_HEAD
);
3561 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3563 error("Unable to open %s for writing", lockpath
);
3564 goto error_free_return
;
3566 written
= write_in_full(fd
, ref
, len
);
3567 if (close(fd
) != 0 || written
!= len
) {
3568 error("Unable to write to %s", lockpath
);
3569 goto error_unlink_return
;
3571 if (rename(lockpath
, git_HEAD
) < 0) {
3572 error("Unable to create %s", git_HEAD
);
3573 goto error_unlink_return
;
3575 if (adjust_shared_perm(git_HEAD
)) {
3576 error("Unable to fix permissions on %s", lockpath
);
3577 error_unlink_return
:
3578 unlink_or_warn(lockpath
);
3586 #ifndef NO_SYMLINK_HEAD
3589 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
) &&
3590 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
, 0, &err
)) {
3591 error("%s", err
.buf
);
3592 strbuf_release(&err
);
3599 struct read_ref_at_cb
{
3600 const char *refname
;
3601 unsigned long at_time
;
3604 unsigned char *sha1
;
3607 unsigned char osha1
[20];
3608 unsigned char nsha1
[20];
3612 unsigned long *cutoff_time
;
3617 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3618 const char *email
, unsigned long timestamp
, int tz
,
3619 const char *message
, void *cb_data
)
3621 struct read_ref_at_cb
*cb
= cb_data
;
3625 cb
->date
= timestamp
;
3627 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3629 *cb
->msg
= xstrdup(message
);
3630 if (cb
->cutoff_time
)
3631 *cb
->cutoff_time
= timestamp
;
3633 *cb
->cutoff_tz
= tz
;
3635 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3637 * we have not yet updated cb->[n|o]sha1 so they still
3638 * hold the values for the previous record.
3640 if (!is_null_sha1(cb
->osha1
)) {
3641 hashcpy(cb
->sha1
, nsha1
);
3642 if (hashcmp(cb
->osha1
, nsha1
))
3643 warning("Log for ref %s has gap after %s.",
3644 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
3646 else if (cb
->date
== cb
->at_time
)
3647 hashcpy(cb
->sha1
, nsha1
);
3648 else if (hashcmp(nsha1
, cb
->sha1
))
3649 warning("Log for ref %s unexpectedly ended on %s.",
3650 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3651 DATE_MODE(RFC2822
)));
3652 hashcpy(cb
->osha1
, osha1
);
3653 hashcpy(cb
->nsha1
, nsha1
);
3657 hashcpy(cb
->osha1
, osha1
);
3658 hashcpy(cb
->nsha1
, nsha1
);
3664 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3665 const char *email
, unsigned long timestamp
,
3666 int tz
, const char *message
, void *cb_data
)
3668 struct read_ref_at_cb
*cb
= cb_data
;
3671 *cb
->msg
= xstrdup(message
);
3672 if (cb
->cutoff_time
)
3673 *cb
->cutoff_time
= timestamp
;
3675 *cb
->cutoff_tz
= tz
;
3677 *cb
->cutoff_cnt
= cb
->reccnt
;
3678 hashcpy(cb
->sha1
, osha1
);
3679 if (is_null_sha1(cb
->sha1
))
3680 hashcpy(cb
->sha1
, nsha1
);
3681 /* We just want the first entry */
3685 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3686 unsigned char *sha1
, char **msg
,
3687 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3689 struct read_ref_at_cb cb
;
3691 memset(&cb
, 0, sizeof(cb
));
3692 cb
.refname
= refname
;
3693 cb
.at_time
= at_time
;
3696 cb
.cutoff_time
= cutoff_time
;
3697 cb
.cutoff_tz
= cutoff_tz
;
3698 cb
.cutoff_cnt
= cutoff_cnt
;
3701 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3704 if (flags
& GET_SHA1_QUIETLY
)
3707 die("Log for %s is empty.", refname
);
3712 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3717 int reflog_exists(const char *refname
)
3721 return !lstat(git_path("logs/%s", refname
), &st
) &&
3722 S_ISREG(st
.st_mode
);
3725 int delete_reflog(const char *refname
)
3727 return remove_path(git_path("logs/%s", refname
));
3730 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3732 unsigned char osha1
[20], nsha1
[20];
3733 char *email_end
, *message
;
3734 unsigned long timestamp
;
3737 /* old SP new SP name <email> SP time TAB msg LF */
3738 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3739 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3740 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3741 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3742 email_end
[1] != ' ' ||
3743 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3744 !message
|| message
[0] != ' ' ||
3745 (message
[1] != '+' && message
[1] != '-') ||
3746 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3747 !isdigit(message
[4]) || !isdigit(message
[5]))
3748 return 0; /* corrupt? */
3749 email_end
[1] = '\0';
3750 tz
= strtol(message
+ 1, NULL
, 10);
3751 if (message
[6] != '\t')
3755 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3758 static char *find_beginning_of_line(char *bob
, char *scan
)
3760 while (bob
< scan
&& *(--scan
) != '\n')
3761 ; /* keep scanning backwards */
3763 * Return either beginning of the buffer, or LF at the end of
3764 * the previous line.
3769 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3771 struct strbuf sb
= STRBUF_INIT
;
3774 int ret
= 0, at_tail
= 1;
3776 logfp
= fopen(git_path("logs/%s", refname
), "r");
3780 /* Jump to the end */
3781 if (fseek(logfp
, 0, SEEK_END
) < 0)
3782 return error("cannot seek back reflog for %s: %s",
3783 refname
, strerror(errno
));
3785 while (!ret
&& 0 < pos
) {
3791 /* Fill next block from the end */
3792 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3793 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3794 return error("cannot seek back reflog for %s: %s",
3795 refname
, strerror(errno
));
3796 nread
= fread(buf
, cnt
, 1, logfp
);
3798 return error("cannot read %d bytes from reflog for %s: %s",
3799 cnt
, refname
, strerror(errno
));
3802 scanp
= endp
= buf
+ cnt
;
3803 if (at_tail
&& scanp
[-1] == '\n')
3804 /* Looking at the final LF at the end of the file */
3808 while (buf
< scanp
) {
3810 * terminating LF of the previous line, or the beginning
3815 bp
= find_beginning_of_line(buf
, scanp
);
3819 * The newline is the end of the previous line,
3820 * so we know we have complete line starting
3821 * at (bp + 1). Prefix it onto any prior data
3822 * we collected for the line and process it.
3824 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3827 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3833 * We are at the start of the buffer, and the
3834 * start of the file; there is no previous
3835 * line, and we have everything for this one.
3836 * Process it, and we can end the loop.
3838 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3839 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3846 * We are at the start of the buffer, and there
3847 * is more file to read backwards. Which means
3848 * we are in the middle of a line. Note that we
3849 * may get here even if *bp was a newline; that
3850 * just means we are at the exact end of the
3851 * previous line, rather than some spot in the
3854 * Save away what we have to be combined with
3855 * the data from the next read.
3857 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3864 die("BUG: reverse reflog parser had leftover data");
3867 strbuf_release(&sb
);
3871 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3874 struct strbuf sb
= STRBUF_INIT
;
3877 logfp
= fopen(git_path("logs/%s", refname
), "r");
3881 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3882 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3884 strbuf_release(&sb
);
3888 * Call fn for each reflog in the namespace indicated by name. name
3889 * must be empty or end with '/'. Name will be used as a scratch
3890 * space, but its contents will be restored before return.
3892 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3894 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3897 int oldlen
= name
->len
;
3900 return name
->len
? errno
: 0;
3902 while ((de
= readdir(d
)) != NULL
) {
3905 if (de
->d_name
[0] == '.')
3907 if (ends_with(de
->d_name
, ".lock"))
3909 strbuf_addstr(name
, de
->d_name
);
3910 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3911 ; /* silently ignore */
3913 if (S_ISDIR(st
.st_mode
)) {
3914 strbuf_addch(name
, '/');
3915 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3917 struct object_id oid
;
3919 if (read_ref_full(name
->buf
, 0, oid
.hash
, NULL
))
3920 retval
= error("bad ref for %s", name
->buf
);
3922 retval
= fn(name
->buf
, &oid
, 0, cb_data
);
3927 strbuf_setlen(name
, oldlen
);
3933 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3937 strbuf_init(&name
, PATH_MAX
);
3938 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3939 strbuf_release(&name
);
3944 * Information needed for a single ref update. Set new_sha1 to the new
3945 * value or to null_sha1 to delete the ref. To check the old value
3946 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
3947 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
3948 * not exist before update.
3952 * If (flags & REF_HAVE_NEW), set the reference to this value:
3954 unsigned char new_sha1
[20];
3956 * If (flags & REF_HAVE_OLD), check that the reference
3957 * previously had this value:
3959 unsigned char old_sha1
[20];
3961 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3962 * REF_DELETING, and REF_ISPRUNING:
3965 struct ref_lock
*lock
;
3968 const char refname
[FLEX_ARRAY
];
3972 * Transaction states.
3973 * OPEN: The transaction is in a valid state and can accept new updates.
3974 * An OPEN transaction can be committed.
3975 * CLOSED: A closed transaction is no longer active and no other operations
3976 * than free can be used on it in this state.
3977 * A transaction can either become closed by successfully committing
3978 * an active transaction or if there is a failure while building
3979 * the transaction thus rendering it failed/inactive.
3981 enum ref_transaction_state
{
3982 REF_TRANSACTION_OPEN
= 0,
3983 REF_TRANSACTION_CLOSED
= 1
3987 * Data structure for holding a reference transaction, which can
3988 * consist of checks and updates to multiple references, carried out
3989 * as atomically as possible. This structure is opaque to callers.
3991 struct ref_transaction
{
3992 struct ref_update
**updates
;
3995 enum ref_transaction_state state
;
3998 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
4002 return xcalloc(1, sizeof(struct ref_transaction
));
4005 void ref_transaction_free(struct ref_transaction
*transaction
)
4012 for (i
= 0; i
< transaction
->nr
; i
++) {
4013 free(transaction
->updates
[i
]->msg
);
4014 free(transaction
->updates
[i
]);
4016 free(transaction
->updates
);
4020 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
4021 const char *refname
)
4023 size_t len
= strlen(refname
);
4024 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
4026 strcpy((char *)update
->refname
, refname
);
4027 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
4028 transaction
->updates
[transaction
->nr
++] = update
;
4032 int ref_transaction_update(struct ref_transaction
*transaction
,
4033 const char *refname
,
4034 const unsigned char *new_sha1
,
4035 const unsigned char *old_sha1
,
4036 unsigned int flags
, const char *msg
,
4039 struct ref_update
*update
;
4043 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
4044 die("BUG: update called for transaction that is not open");
4046 if (new_sha1
&& !is_null_sha1(new_sha1
) &&
4047 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
4048 strbuf_addf(err
, "refusing to update ref with bad name %s",
4053 update
= add_update(transaction
, refname
);
4055 hashcpy(update
->new_sha1
, new_sha1
);
4056 flags
|= REF_HAVE_NEW
;
4059 hashcpy(update
->old_sha1
, old_sha1
);
4060 flags
|= REF_HAVE_OLD
;
4062 update
->flags
= flags
;
4064 update
->msg
= xstrdup(msg
);
4068 int ref_transaction_create(struct ref_transaction
*transaction
,
4069 const char *refname
,
4070 const unsigned char *new_sha1
,
4071 unsigned int flags
, const char *msg
,
4074 if (!new_sha1
|| is_null_sha1(new_sha1
))
4075 die("BUG: create called without valid new_sha1");
4076 return ref_transaction_update(transaction
, refname
, new_sha1
,
4077 null_sha1
, flags
, msg
, err
);
4080 int ref_transaction_delete(struct ref_transaction
*transaction
,
4081 const char *refname
,
4082 const unsigned char *old_sha1
,
4083 unsigned int flags
, const char *msg
,
4086 if (old_sha1
&& is_null_sha1(old_sha1
))
4087 die("BUG: delete called with old_sha1 set to zeros");
4088 return ref_transaction_update(transaction
, refname
,
4089 null_sha1
, old_sha1
,
4093 int ref_transaction_verify(struct ref_transaction
*transaction
,
4094 const char *refname
,
4095 const unsigned char *old_sha1
,
4100 die("BUG: verify called with old_sha1 set to NULL");
4101 return ref_transaction_update(transaction
, refname
,
4106 int update_ref(const char *msg
, const char *refname
,
4107 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
4108 unsigned int flags
, enum action_on_err onerr
)
4110 struct ref_transaction
*t
= NULL
;
4111 struct strbuf err
= STRBUF_INIT
;
4114 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
4115 ret
= write_pseudoref(refname
, new_sha1
, old_sha1
, &err
);
4117 t
= ref_transaction_begin(&err
);
4119 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
4120 flags
, msg
, &err
) ||
4121 ref_transaction_commit(t
, &err
)) {
4123 ref_transaction_free(t
);
4127 const char *str
= "update_ref failed for ref '%s': %s";
4130 case UPDATE_REFS_MSG_ON_ERR
:
4131 error(str
, refname
, err
.buf
);
4133 case UPDATE_REFS_DIE_ON_ERR
:
4134 die(str
, refname
, err
.buf
);
4136 case UPDATE_REFS_QUIET_ON_ERR
:
4139 strbuf_release(&err
);
4142 strbuf_release(&err
);
4144 ref_transaction_free(t
);
4148 static int ref_update_reject_duplicates(struct string_list
*refnames
,
4151 int i
, n
= refnames
->nr
;
4155 for (i
= 1; i
< n
; i
++)
4156 if (!strcmp(refnames
->items
[i
- 1].string
, refnames
->items
[i
].string
)) {
4158 "Multiple updates for ref '%s' not allowed.",
4159 refnames
->items
[i
].string
);
4165 int ref_transaction_commit(struct ref_transaction
*transaction
,
4169 int n
= transaction
->nr
;
4170 struct ref_update
**updates
= transaction
->updates
;
4171 struct string_list refs_to_delete
= STRING_LIST_INIT_NODUP
;
4172 struct string_list_item
*ref_to_delete
;
4173 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
4177 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
4178 die("BUG: commit called for transaction that is not open");
4181 transaction
->state
= REF_TRANSACTION_CLOSED
;
4185 /* Fail if a refname appears more than once in the transaction: */
4186 for (i
= 0; i
< n
; i
++)
4187 string_list_append(&affected_refnames
, updates
[i
]->refname
);
4188 string_list_sort(&affected_refnames
);
4189 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
4190 ret
= TRANSACTION_GENERIC_ERROR
;
4195 * Acquire all locks, verify old values if provided, check
4196 * that new values are valid, and write new values to the
4197 * lockfiles, ready to be activated. Only keep one lockfile
4198 * open at a time to avoid running out of file descriptors.
4200 for (i
= 0; i
< n
; i
++) {
4201 struct ref_update
*update
= updates
[i
];
4203 if ((update
->flags
& REF_HAVE_NEW
) &&
4204 is_null_sha1(update
->new_sha1
))
4205 update
->flags
|= REF_DELETING
;
4206 update
->lock
= lock_ref_sha1_basic(
4208 ((update
->flags
& REF_HAVE_OLD
) ?
4209 update
->old_sha1
: NULL
),
4210 &affected_refnames
, NULL
,
4214 if (!update
->lock
) {
4217 ret
= (errno
== ENOTDIR
)
4218 ? TRANSACTION_NAME_CONFLICT
4219 : TRANSACTION_GENERIC_ERROR
;
4220 reason
= strbuf_detach(err
, NULL
);
4221 strbuf_addf(err
, "cannot lock ref '%s': %s",
4222 update
->refname
, reason
);
4226 if ((update
->flags
& REF_HAVE_NEW
) &&
4227 !(update
->flags
& REF_DELETING
)) {
4228 int overwriting_symref
= ((update
->type
& REF_ISSYMREF
) &&
4229 (update
->flags
& REF_NODEREF
));
4231 if (!overwriting_symref
&&
4232 !hashcmp(update
->lock
->old_oid
.hash
, update
->new_sha1
)) {
4234 * The reference already has the desired
4235 * value, so we don't need to write it.
4237 } else if (write_ref_to_lockfile(update
->lock
,
4240 char *write_err
= strbuf_detach(err
, NULL
);
4243 * The lock was freed upon failure of
4244 * write_ref_to_lockfile():
4246 update
->lock
= NULL
;
4248 "cannot update the ref '%s': %s",
4249 update
->refname
, write_err
);
4251 ret
= TRANSACTION_GENERIC_ERROR
;
4254 update
->flags
|= REF_NEEDS_COMMIT
;
4257 if (!(update
->flags
& REF_NEEDS_COMMIT
)) {
4259 * We didn't have to write anything to the lockfile.
4260 * Close it to free up the file descriptor:
4262 if (close_ref(update
->lock
)) {
4263 strbuf_addf(err
, "Couldn't close %s.lock",
4270 /* Perform updates first so live commits remain referenced */
4271 for (i
= 0; i
< n
; i
++) {
4272 struct ref_update
*update
= updates
[i
];
4274 if (update
->flags
& REF_NEEDS_COMMIT
) {
4275 if (commit_ref_update(update
->lock
,
4276 update
->new_sha1
, update
->msg
,
4277 update
->flags
, err
)) {
4278 /* freed by commit_ref_update(): */
4279 update
->lock
= NULL
;
4280 ret
= TRANSACTION_GENERIC_ERROR
;
4283 /* freed by commit_ref_update(): */
4284 update
->lock
= NULL
;
4289 /* Perform deletes now that updates are safely completed */
4290 for (i
= 0; i
< n
; i
++) {
4291 struct ref_update
*update
= updates
[i
];
4293 if (update
->flags
& REF_DELETING
) {
4294 if (delete_ref_loose(update
->lock
, update
->type
, err
)) {
4295 ret
= TRANSACTION_GENERIC_ERROR
;
4299 if (!(update
->flags
& REF_ISPRUNING
))
4300 string_list_append(&refs_to_delete
,
4301 update
->lock
->ref_name
);
4305 if (repack_without_refs(&refs_to_delete
, err
)) {
4306 ret
= TRANSACTION_GENERIC_ERROR
;
4309 for_each_string_list_item(ref_to_delete
, &refs_to_delete
)
4310 unlink_or_warn(git_path("logs/%s", ref_to_delete
->string
));
4311 clear_loose_ref_cache(&ref_cache
);
4314 transaction
->state
= REF_TRANSACTION_CLOSED
;
4316 for (i
= 0; i
< n
; i
++)
4317 if (updates
[i
]->lock
)
4318 unlock_ref(updates
[i
]->lock
);
4319 string_list_clear(&refs_to_delete
, 0);
4320 string_list_clear(&affected_refnames
, 0);
4324 static int ref_present(const char *refname
,
4325 const struct object_id
*oid
, int flags
, void *cb_data
)
4327 struct string_list
*affected_refnames
= cb_data
;
4329 return string_list_has_string(affected_refnames
, refname
);
4332 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
4335 struct ref_dir
*loose_refs
= get_loose_refs(&ref_cache
);
4336 struct ref_dir
*packed_refs
= get_packed_refs(&ref_cache
);
4338 int n
= transaction
->nr
;
4339 struct ref_update
**updates
= transaction
->updates
;
4340 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
4344 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
4345 die("BUG: commit called for transaction that is not open");
4347 /* Fail if a refname appears more than once in the transaction: */
4348 for (i
= 0; i
< n
; i
++)
4349 string_list_append(&affected_refnames
, updates
[i
]->refname
);
4350 string_list_sort(&affected_refnames
);
4351 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
4352 ret
= TRANSACTION_GENERIC_ERROR
;
4357 * It's really undefined to call this function in an active
4358 * repository or when there are existing references: we are
4359 * only locking and changing packed-refs, so (1) any
4360 * simultaneous processes might try to change a reference at
4361 * the same time we do, and (2) any existing loose versions of
4362 * the references that we are setting would have precedence
4363 * over our values. But some remote helpers create the remote
4364 * "HEAD" and "master" branches before calling this function,
4365 * so here we really only check that none of the references
4366 * that we are creating already exists.
4368 if (for_each_rawref(ref_present
, &affected_refnames
))
4369 die("BUG: initial ref transaction called with existing refs");
4371 for (i
= 0; i
< n
; i
++) {
4372 struct ref_update
*update
= updates
[i
];
4374 if ((update
->flags
& REF_HAVE_OLD
) &&
4375 !is_null_sha1(update
->old_sha1
))
4376 die("BUG: initial ref transaction with old_sha1 set");
4377 if (verify_refname_available(update
->refname
,
4378 &affected_refnames
, NULL
,
4380 verify_refname_available(update
->refname
,
4381 &affected_refnames
, NULL
,
4382 packed_refs
, err
)) {
4383 ret
= TRANSACTION_NAME_CONFLICT
;
4388 if (lock_packed_refs(0)) {
4389 strbuf_addf(err
, "unable to lock packed-refs file: %s",
4391 ret
= TRANSACTION_GENERIC_ERROR
;
4395 for (i
= 0; i
< n
; i
++) {
4396 struct ref_update
*update
= updates
[i
];
4398 if ((update
->flags
& REF_HAVE_NEW
) &&
4399 !is_null_sha1(update
->new_sha1
))
4400 add_packed_ref(update
->refname
, update
->new_sha1
);
4403 if (commit_packed_refs()) {
4404 strbuf_addf(err
, "unable to commit packed-refs file: %s",
4406 ret
= TRANSACTION_GENERIC_ERROR
;
4411 transaction
->state
= REF_TRANSACTION_CLOSED
;
4412 string_list_clear(&affected_refnames
, 0);
4416 char *shorten_unambiguous_ref(const char *refname
, int strict
)
4419 static char **scanf_fmts
;
4420 static int nr_rules
;
4425 * Pre-generate scanf formats from ref_rev_parse_rules[].
4426 * Generate a format suitable for scanf from a
4427 * ref_rev_parse_rules rule by interpolating "%s" at the
4428 * location of the "%.*s".
4430 size_t total_len
= 0;
4433 /* the rule list is NULL terminated, count them first */
4434 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
4435 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
4436 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
4438 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
4441 for (i
= 0; i
< nr_rules
; i
++) {
4442 assert(offset
< total_len
);
4443 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
4444 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
4445 ref_rev_parse_rules
[i
], 2, "%s") + 1;
4449 /* bail out if there are no rules */
4451 return xstrdup(refname
);
4453 /* buffer for scanf result, at most refname must fit */
4454 short_name
= xstrdup(refname
);
4456 /* skip first rule, it will always match */
4457 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
4459 int rules_to_fail
= i
;
4462 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
4465 short_name_len
= strlen(short_name
);
4468 * in strict mode, all (except the matched one) rules
4469 * must fail to resolve to a valid non-ambiguous ref
4472 rules_to_fail
= nr_rules
;
4475 * check if the short name resolves to a valid ref,
4476 * but use only rules prior to the matched one
4478 for (j
= 0; j
< rules_to_fail
; j
++) {
4479 const char *rule
= ref_rev_parse_rules
[j
];
4480 char refname
[PATH_MAX
];
4482 /* skip matched rule */
4487 * the short name is ambiguous, if it resolves
4488 * (with this previous rule) to a valid ref
4489 * read_ref() returns 0 on success
4491 mksnpath(refname
, sizeof(refname
),
4492 rule
, short_name_len
, short_name
);
4493 if (ref_exists(refname
))
4498 * short name is non-ambiguous if all previous rules
4499 * haven't resolved to a valid ref
4501 if (j
== rules_to_fail
)
4506 return xstrdup(refname
);
4509 static struct string_list
*hide_refs
;
4511 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
4513 if (!strcmp("transfer.hiderefs", var
) ||
4514 /* NEEDSWORK: use parse_config_key() once both are merged */
4515 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
4516 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
4521 return config_error_nonbool(var
);
4522 ref
= xstrdup(value
);
4524 while (len
&& ref
[len
- 1] == '/')
4527 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
4528 hide_refs
->strdup_strings
= 1;
4530 string_list_append(hide_refs
, ref
);
4535 int ref_is_hidden(const char *refname
)
4541 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
4542 const char *match
= hide_refs
->items
[i
].string
;
4546 if (*match
== '!') {
4551 if (!starts_with(refname
, match
))
4553 len
= strlen(match
);
4554 if (!refname
[len
] || refname
[len
] == '/')
4560 struct expire_reflog_cb
{
4562 reflog_expiry_should_prune_fn
*should_prune_fn
;
4565 unsigned char last_kept_sha1
[20];
4568 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
4569 const char *email
, unsigned long timestamp
, int tz
,
4570 const char *message
, void *cb_data
)
4572 struct expire_reflog_cb
*cb
= cb_data
;
4573 struct expire_reflog_policy_cb
*policy_cb
= cb
->policy_cb
;
4575 if (cb
->flags
& EXPIRE_REFLOGS_REWRITE
)
4576 osha1
= cb
->last_kept_sha1
;
4578 if ((*cb
->should_prune_fn
)(osha1
, nsha1
, email
, timestamp
, tz
,
4579 message
, policy_cb
)) {
4581 printf("would prune %s", message
);
4582 else if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4583 printf("prune %s", message
);
4586 fprintf(cb
->newlog
, "%s %s %s %lu %+05d\t%s",
4587 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
4588 email
, timestamp
, tz
, message
);
4589 hashcpy(cb
->last_kept_sha1
, nsha1
);
4591 if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4592 printf("keep %s", message
);
4597 int reflog_expire(const char *refname
, const unsigned char *sha1
,
4599 reflog_expiry_prepare_fn prepare_fn
,
4600 reflog_expiry_should_prune_fn should_prune_fn
,
4601 reflog_expiry_cleanup_fn cleanup_fn
,
4602 void *policy_cb_data
)
4604 static struct lock_file reflog_lock
;
4605 struct expire_reflog_cb cb
;
4606 struct ref_lock
*lock
;
4610 struct strbuf err
= STRBUF_INIT
;
4612 memset(&cb
, 0, sizeof(cb
));
4614 cb
.policy_cb
= policy_cb_data
;
4615 cb
.should_prune_fn
= should_prune_fn
;
4618 * The reflog file is locked by holding the lock on the
4619 * reference itself, plus we might need to update the
4620 * reference if --updateref was specified:
4622 lock
= lock_ref_sha1_basic(refname
, sha1
, NULL
, NULL
, 0, &type
, &err
);
4624 error("cannot lock ref '%s': %s", refname
, err
.buf
);
4625 strbuf_release(&err
);
4628 if (!reflog_exists(refname
)) {
4633 log_file
= git_pathdup("logs/%s", refname
);
4634 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4636 * Even though holding $GIT_DIR/logs/$reflog.lock has
4637 * no locking implications, we use the lock_file
4638 * machinery here anyway because it does a lot of the
4639 * work we need, including cleaning up if the program
4640 * exits unexpectedly.
4642 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
4643 struct strbuf err
= STRBUF_INIT
;
4644 unable_to_lock_message(log_file
, errno
, &err
);
4645 error("%s", err
.buf
);
4646 strbuf_release(&err
);
4649 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
4651 error("cannot fdopen %s (%s)",
4652 get_lock_file_path(&reflog_lock
), strerror(errno
));
4657 (*prepare_fn
)(refname
, sha1
, cb
.policy_cb
);
4658 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
4659 (*cleanup_fn
)(cb
.policy_cb
);
4661 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4663 * It doesn't make sense to adjust a reference pointed
4664 * to by a symbolic ref based on expiring entries in
4665 * the symbolic reference's reflog. Nor can we update
4666 * a reference if there are no remaining reflog
4669 int update
= (flags
& EXPIRE_REFLOGS_UPDATE_REF
) &&
4670 !(type
& REF_ISSYMREF
) &&
4671 !is_null_sha1(cb
.last_kept_sha1
);
4673 if (close_lock_file(&reflog_lock
)) {
4674 status
|= error("couldn't write %s: %s", log_file
,
4676 } else if (update
&&
4677 (write_in_full(get_lock_file_fd(lock
->lk
),
4678 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
4679 write_str_in_full(get_lock_file_fd(lock
->lk
), "\n") != 1 ||
4680 close_ref(lock
) < 0)) {
4681 status
|= error("couldn't write %s",
4682 get_lock_file_path(lock
->lk
));
4683 rollback_lock_file(&reflog_lock
);
4684 } else if (commit_lock_file(&reflog_lock
)) {
4685 status
|= error("unable to commit reflog '%s' (%s)",
4686 log_file
, strerror(errno
));
4687 } else if (update
&& commit_ref(lock
)) {
4688 status
|= error("couldn't set %s", lock
->ref_name
);
4696 rollback_lock_file(&reflog_lock
);