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
);
308 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
311 assert(entry
->flag
& REF_DIR
);
312 dir
= &entry
->u
.subdir
;
313 if (entry
->flag
& REF_INCOMPLETE
) {
314 read_loose_refs(entry
->name
, dir
);
315 entry
->flag
&= ~REF_INCOMPLETE
;
321 * Check if a refname is safe.
322 * For refs that start with "refs/" we consider it safe as long they do
323 * not try to resolve to outside of refs/.
325 * For all other refs we only consider them safe iff they only contain
326 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
329 static int refname_is_safe(const char *refname
)
331 if (starts_with(refname
, "refs/")) {
335 buf
= xmalloc(strlen(refname
) + 1);
337 * Does the refname try to escape refs/?
338 * For example: refs/foo/../bar is safe but refs/foo/../../bar
341 result
= !normalize_path_copy(buf
, refname
+ strlen("refs/"));
346 if (!isupper(*refname
) && *refname
!= '_')
353 static struct ref_entry
*create_ref_entry(const char *refname
,
354 const unsigned char *sha1
, int flag
,
358 struct ref_entry
*ref
;
361 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
362 die("Reference has invalid format: '%s'", refname
);
363 len
= strlen(refname
) + 1;
364 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
365 hashcpy(ref
->u
.value
.oid
.hash
, sha1
);
366 oidclr(&ref
->u
.value
.peeled
);
367 memcpy(ref
->name
, refname
, len
);
372 static void clear_ref_dir(struct ref_dir
*dir
);
374 static void free_ref_entry(struct ref_entry
*entry
)
376 if (entry
->flag
& REF_DIR
) {
378 * Do not use get_ref_dir() here, as that might
379 * trigger the reading of loose refs.
381 clear_ref_dir(&entry
->u
.subdir
);
387 * Add a ref_entry to the end of dir (unsorted). Entry is always
388 * stored directly in dir; no recursion into subdirectories is
391 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
393 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
394 dir
->entries
[dir
->nr
++] = entry
;
395 /* optimize for the case that entries are added in order */
397 (dir
->nr
== dir
->sorted
+ 1 &&
398 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
399 dir
->entries
[dir
->nr
- 1]->name
) < 0))
400 dir
->sorted
= dir
->nr
;
404 * Clear and free all entries in dir, recursively.
406 static void clear_ref_dir(struct ref_dir
*dir
)
409 for (i
= 0; i
< dir
->nr
; i
++)
410 free_ref_entry(dir
->entries
[i
]);
412 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
417 * Create a struct ref_entry object for the specified dirname.
418 * dirname is the name of the directory with a trailing slash (e.g.,
419 * "refs/heads/") or "" for the top-level directory.
421 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
422 const char *dirname
, size_t len
,
425 struct ref_entry
*direntry
;
426 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
427 memcpy(direntry
->name
, dirname
, len
);
428 direntry
->name
[len
] = '\0';
429 direntry
->u
.subdir
.ref_cache
= ref_cache
;
430 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
434 static int ref_entry_cmp(const void *a
, const void *b
)
436 struct ref_entry
*one
= *(struct ref_entry
**)a
;
437 struct ref_entry
*two
= *(struct ref_entry
**)b
;
438 return strcmp(one
->name
, two
->name
);
441 static void sort_ref_dir(struct ref_dir
*dir
);
443 struct string_slice
{
448 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
450 const struct string_slice
*key
= key_
;
451 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
452 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
455 return '\0' - (unsigned char)ent
->name
[key
->len
];
459 * Return the index of the entry with the given refname from the
460 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
461 * no such entry is found. dir must already be complete.
463 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
465 struct ref_entry
**r
;
466 struct string_slice key
;
468 if (refname
== NULL
|| !dir
->nr
)
474 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
475 ref_entry_cmp_sslice
);
480 return r
- dir
->entries
;
484 * Search for a directory entry directly within dir (without
485 * recursing). Sort dir if necessary. subdirname must be a directory
486 * name (i.e., end in '/'). If mkdir is set, then create the
487 * directory if it is missing; otherwise, return NULL if the desired
488 * directory cannot be found. dir must already be complete.
490 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
491 const char *subdirname
, size_t len
,
494 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
495 struct ref_entry
*entry
;
496 if (entry_index
== -1) {
500 * Since dir is complete, the absence of a subdir
501 * means that the subdir really doesn't exist;
502 * therefore, create an empty record for it but mark
503 * the record complete.
505 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
506 add_entry_to_dir(dir
, entry
);
508 entry
= dir
->entries
[entry_index
];
510 return get_ref_dir(entry
);
514 * If refname is a reference name, find the ref_dir within the dir
515 * tree that should hold refname. If refname is a directory name
516 * (i.e., ends in '/'), then return that ref_dir itself. dir must
517 * represent the top-level directory and must already be complete.
518 * Sort ref_dirs and recurse into subdirectories as necessary. If
519 * mkdir is set, then create any missing directories; otherwise,
520 * return NULL if the desired directory cannot be found.
522 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
523 const char *refname
, int mkdir
)
526 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
527 size_t dirnamelen
= slash
- refname
+ 1;
528 struct ref_dir
*subdir
;
529 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
541 * Find the value entry with the given name in dir, sorting ref_dirs
542 * and recursing into subdirectories as necessary. If the name is not
543 * found or it corresponds to a directory entry, return NULL.
545 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
548 struct ref_entry
*entry
;
549 dir
= find_containing_dir(dir
, refname
, 0);
552 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
553 if (entry_index
== -1)
555 entry
= dir
->entries
[entry_index
];
556 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
560 * Remove the entry with the given name from dir, recursing into
561 * subdirectories as necessary. If refname is the name of a directory
562 * (i.e., ends with '/'), then remove the directory and its contents.
563 * If the removal was successful, return the number of entries
564 * remaining in the directory entry that contained the deleted entry.
565 * If the name was not found, return -1. Please note that this
566 * function only deletes the entry from the cache; it does not delete
567 * it from the filesystem or ensure that other cache entries (which
568 * might be symbolic references to the removed entry) are updated.
569 * Nor does it remove any containing dir entries that might be made
570 * empty by the removal. dir must represent the top-level directory
571 * and must already be complete.
573 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
575 int refname_len
= strlen(refname
);
577 struct ref_entry
*entry
;
578 int is_dir
= refname
[refname_len
- 1] == '/';
581 * refname represents a reference directory. Remove
582 * the trailing slash; otherwise we will get the
583 * directory *representing* refname rather than the
584 * one *containing* it.
586 char *dirname
= xmemdupz(refname
, refname_len
- 1);
587 dir
= find_containing_dir(dir
, dirname
, 0);
590 dir
= find_containing_dir(dir
, refname
, 0);
594 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
595 if (entry_index
== -1)
597 entry
= dir
->entries
[entry_index
];
599 memmove(&dir
->entries
[entry_index
],
600 &dir
->entries
[entry_index
+ 1],
601 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
604 if (dir
->sorted
> entry_index
)
606 free_ref_entry(entry
);
611 * Add a ref_entry to the ref_dir (unsorted), recursing into
612 * subdirectories as necessary. dir must represent the top-level
613 * directory. Return 0 on success.
615 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
617 dir
= find_containing_dir(dir
, ref
->name
, 1);
620 add_entry_to_dir(dir
, ref
);
625 * Emit a warning and return true iff ref1 and ref2 have the same name
626 * and the same sha1. Die if they have the same name but different
629 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
631 if (strcmp(ref1
->name
, ref2
->name
))
634 /* Duplicate name; make sure that they don't conflict: */
636 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
637 /* This is impossible by construction */
638 die("Reference directory conflict: %s", ref1
->name
);
640 if (oidcmp(&ref1
->u
.value
.oid
, &ref2
->u
.value
.oid
))
641 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
643 warning("Duplicated ref: %s", ref1
->name
);
648 * Sort the entries in dir non-recursively (if they are not already
649 * sorted) and remove any duplicate entries.
651 static void sort_ref_dir(struct ref_dir
*dir
)
654 struct ref_entry
*last
= NULL
;
657 * This check also prevents passing a zero-length array to qsort(),
658 * which is a problem on some platforms.
660 if (dir
->sorted
== dir
->nr
)
663 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
665 /* Remove any duplicates: */
666 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
667 struct ref_entry
*entry
= dir
->entries
[j
];
668 if (last
&& is_dup_ref(last
, entry
))
669 free_ref_entry(entry
);
671 last
= dir
->entries
[i
++] = entry
;
673 dir
->sorted
= dir
->nr
= i
;
676 /* Include broken references in a do_for_each_ref*() iteration: */
677 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
680 * Return true iff the reference described by entry can be resolved to
681 * an object in the database. Emit a warning if the referred-to
682 * object does not exist.
684 static int ref_resolves_to_object(struct ref_entry
*entry
)
686 if (entry
->flag
& REF_ISBROKEN
)
688 if (!has_sha1_file(entry
->u
.value
.oid
.hash
)) {
689 error("%s does not point to a valid object!", entry
->name
);
696 * current_ref is a performance hack: when iterating over references
697 * using the for_each_ref*() functions, current_ref is set to the
698 * current reference's entry before calling the callback function. If
699 * the callback function calls peel_ref(), then peel_ref() first
700 * checks whether the reference to be peeled is the current reference
701 * (it usually is) and if so, returns that reference's peeled version
702 * if it is available. This avoids a refname lookup in a common case.
704 static struct ref_entry
*current_ref
;
706 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
708 struct ref_entry_cb
{
717 * Handle one reference in a do_for_each_ref*()-style iteration,
718 * calling an each_ref_fn for each entry.
720 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
722 struct ref_entry_cb
*data
= cb_data
;
723 struct ref_entry
*old_current_ref
;
726 if (!starts_with(entry
->name
, data
->base
))
729 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
730 !ref_resolves_to_object(entry
))
733 /* Store the old value, in case this is a recursive call: */
734 old_current_ref
= current_ref
;
736 retval
= data
->fn(entry
->name
+ data
->trim
, &entry
->u
.value
.oid
,
737 entry
->flag
, data
->cb_data
);
738 current_ref
= old_current_ref
;
743 * Call fn for each reference in dir that has index in the range
744 * offset <= index < dir->nr. Recurse into subdirectories that are in
745 * that index range, sorting them before iterating. This function
746 * does not sort dir itself; it should be sorted beforehand. fn is
747 * called for all references, including broken ones.
749 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
750 each_ref_entry_fn fn
, void *cb_data
)
753 assert(dir
->sorted
== dir
->nr
);
754 for (i
= offset
; i
< dir
->nr
; i
++) {
755 struct ref_entry
*entry
= dir
->entries
[i
];
757 if (entry
->flag
& REF_DIR
) {
758 struct ref_dir
*subdir
= get_ref_dir(entry
);
759 sort_ref_dir(subdir
);
760 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
762 retval
= fn(entry
, cb_data
);
771 * Call fn for each reference in the union of dir1 and dir2, in order
772 * by refname. Recurse into subdirectories. If a value entry appears
773 * in both dir1 and dir2, then only process the version that is in
774 * dir2. The input dirs must already be sorted, but subdirs will be
775 * sorted as needed. fn is called for all references, including
778 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
779 struct ref_dir
*dir2
,
780 each_ref_entry_fn fn
, void *cb_data
)
785 assert(dir1
->sorted
== dir1
->nr
);
786 assert(dir2
->sorted
== dir2
->nr
);
788 struct ref_entry
*e1
, *e2
;
790 if (i1
== dir1
->nr
) {
791 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
793 if (i2
== dir2
->nr
) {
794 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
796 e1
= dir1
->entries
[i1
];
797 e2
= dir2
->entries
[i2
];
798 cmp
= strcmp(e1
->name
, e2
->name
);
800 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
801 /* Both are directories; descend them in parallel. */
802 struct ref_dir
*subdir1
= get_ref_dir(e1
);
803 struct ref_dir
*subdir2
= get_ref_dir(e2
);
804 sort_ref_dir(subdir1
);
805 sort_ref_dir(subdir2
);
806 retval
= do_for_each_entry_in_dirs(
807 subdir1
, subdir2
, fn
, cb_data
);
810 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
811 /* Both are references; ignore the one from dir1. */
812 retval
= fn(e2
, cb_data
);
816 die("conflict between reference and directory: %s",
828 if (e
->flag
& REF_DIR
) {
829 struct ref_dir
*subdir
= get_ref_dir(e
);
830 sort_ref_dir(subdir
);
831 retval
= do_for_each_entry_in_dir(
832 subdir
, 0, fn
, cb_data
);
834 retval
= fn(e
, cb_data
);
843 * Load all of the refs from the dir into our in-memory cache. The hard work
844 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
845 * through all of the sub-directories. We do not even need to care about
846 * sorting, as traversal order does not matter to us.
848 static void prime_ref_dir(struct ref_dir
*dir
)
851 for (i
= 0; i
< dir
->nr
; i
++) {
852 struct ref_entry
*entry
= dir
->entries
[i
];
853 if (entry
->flag
& REF_DIR
)
854 prime_ref_dir(get_ref_dir(entry
));
858 struct nonmatching_ref_data
{
859 const struct string_list
*skip
;
860 const char *conflicting_refname
;
863 static int nonmatching_ref_fn(struct ref_entry
*entry
, void *vdata
)
865 struct nonmatching_ref_data
*data
= vdata
;
867 if (data
->skip
&& string_list_has_string(data
->skip
, entry
->name
))
870 data
->conflicting_refname
= entry
->name
;
875 * Return 0 if a reference named refname could be created without
876 * conflicting with the name of an existing reference in dir.
877 * Otherwise, return a negative value and write an explanation to err.
878 * If extras is non-NULL, it is a list of additional refnames with
879 * which refname is not allowed to conflict. If skip is non-NULL,
880 * ignore potential conflicts with refs in skip (e.g., because they
881 * are scheduled for deletion in the same operation). Behavior is
882 * undefined if the same name is listed in both extras and skip.
884 * Two reference names conflict if one of them exactly matches the
885 * leading components of the other; e.g., "refs/foo/bar" conflicts
886 * with both "refs/foo" and with "refs/foo/bar/baz" but not with
887 * "refs/foo/bar" or "refs/foo/barbados".
889 * extras and skip must be sorted.
891 static int verify_refname_available(const char *refname
,
892 const struct string_list
*extras
,
893 const struct string_list
*skip
,
899 struct strbuf dirname
= STRBUF_INIT
;
903 * For the sake of comments in this function, suppose that
904 * refname is "refs/foo/bar".
909 strbuf_grow(&dirname
, strlen(refname
) + 1);
910 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
911 /* Expand dirname to the new prefix, not including the trailing slash: */
912 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
915 * We are still at a leading dir of the refname (e.g.,
916 * "refs/foo"; if there is a reference with that name,
917 * it is a conflict, *unless* it is in skip.
920 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
922 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
924 * We found a reference whose name is
925 * a proper prefix of refname; e.g.,
926 * "refs/foo", and is not in skip.
928 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
929 dirname
.buf
, refname
);
934 if (extras
&& string_list_has_string(extras
, dirname
.buf
) &&
935 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
936 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
937 refname
, dirname
.buf
);
942 * Otherwise, we can try to continue our search with
943 * the next component. So try to look up the
944 * directory, e.g., "refs/foo/". If we come up empty,
945 * we know there is nothing under this whole prefix,
946 * but even in that case we still have to continue the
947 * search for conflicts with extras.
949 strbuf_addch(&dirname
, '/');
951 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
954 * There was no directory "refs/foo/",
955 * so there is nothing under this
956 * whole prefix. So there is no need
957 * to continue looking for conflicting
958 * references. But we need to continue
959 * looking for conflicting extras.
963 dir
= get_ref_dir(dir
->entries
[pos
]);
969 * We are at the leaf of our refname (e.g., "refs/foo/bar").
970 * There is no point in searching for a reference with that
971 * name, because a refname isn't considered to conflict with
972 * itself. But we still need to check for references whose
973 * names are in the "refs/foo/bar/" namespace, because they
976 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
977 strbuf_addch(&dirname
, '/');
980 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
984 * We found a directory named "$refname/"
985 * (e.g., "refs/foo/bar/"). It is a problem
986 * iff it contains any ref that is not in
989 struct nonmatching_ref_data data
;
992 data
.conflicting_refname
= NULL
;
993 dir
= get_ref_dir(dir
->entries
[pos
]);
995 if (do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
)) {
996 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
997 data
.conflicting_refname
, refname
);
1005 * Check for entries in extras that start with
1006 * "$refname/". We do that by looking for the place
1007 * where "$refname/" would be inserted in extras. If
1008 * there is an entry at that position that starts with
1009 * "$refname/" and is not in skip, then we have a
1012 for (pos
= string_list_find_insert_index(extras
, dirname
.buf
, 0);
1013 pos
< extras
->nr
; pos
++) {
1014 const char *extra_refname
= extras
->items
[pos
].string
;
1016 if (!starts_with(extra_refname
, dirname
.buf
))
1019 if (!skip
|| !string_list_has_string(skip
, extra_refname
)) {
1020 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1021 refname
, extra_refname
);
1027 /* No conflicts were found */
1031 strbuf_release(&dirname
);
1035 struct packed_ref_cache
{
1036 struct ref_entry
*root
;
1039 * Count of references to the data structure in this instance,
1040 * including the pointer from ref_cache::packed if any. The
1041 * data will not be freed as long as the reference count is
1044 unsigned int referrers
;
1047 * Iff the packed-refs file associated with this instance is
1048 * currently locked for writing, this points at the associated
1049 * lock (which is owned by somebody else). The referrer count
1050 * is also incremented when the file is locked and decremented
1051 * when it is unlocked.
1053 struct lock_file
*lock
;
1055 /* The metadata from when this packed-refs cache was read */
1056 struct stat_validity validity
;
1060 * Future: need to be in "struct repository"
1061 * when doing a full libification.
1063 static struct ref_cache
{
1064 struct ref_cache
*next
;
1065 struct ref_entry
*loose
;
1066 struct packed_ref_cache
*packed
;
1068 * The submodule name, or "" for the main repo. We allocate
1069 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1070 * is initialized correctly.
1073 } ref_cache
, *submodule_ref_caches
;
1075 /* Lock used for the main packed-refs file: */
1076 static struct lock_file packlock
;
1079 * Increment the reference count of *packed_refs.
1081 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1083 packed_refs
->referrers
++;
1087 * Decrease the reference count of *packed_refs. If it goes to zero,
1088 * free *packed_refs and return true; otherwise return false.
1090 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1092 if (!--packed_refs
->referrers
) {
1093 free_ref_entry(packed_refs
->root
);
1094 stat_validity_clear(&packed_refs
->validity
);
1102 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1105 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1107 if (packed_refs
->lock
)
1108 die("internal error: packed-ref cache cleared while locked");
1109 refs
->packed
= NULL
;
1110 release_packed_ref_cache(packed_refs
);
1114 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1117 free_ref_entry(refs
->loose
);
1122 static struct ref_cache
*create_ref_cache(const char *submodule
)
1125 struct ref_cache
*refs
;
1128 len
= strlen(submodule
) + 1;
1129 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1130 memcpy(refs
->name
, submodule
, len
);
1135 * Return a pointer to a ref_cache for the specified submodule. For
1136 * the main repository, use submodule==NULL. The returned structure
1137 * will be allocated and initialized but not necessarily populated; it
1138 * should not be freed.
1140 static struct ref_cache
*get_ref_cache(const char *submodule
)
1142 struct ref_cache
*refs
;
1144 if (!submodule
|| !*submodule
)
1147 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1148 if (!strcmp(submodule
, refs
->name
))
1151 refs
= create_ref_cache(submodule
);
1152 refs
->next
= submodule_ref_caches
;
1153 submodule_ref_caches
= refs
;
1157 /* The length of a peeled reference line in packed-refs, including EOL: */
1158 #define PEELED_LINE_LENGTH 42
1161 * The packed-refs header line that we write out. Perhaps other
1162 * traits will be added later. The trailing space is required.
1164 static const char PACKED_REFS_HEADER
[] =
1165 "# pack-refs with: peeled fully-peeled \n";
1168 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1169 * Return a pointer to the refname within the line (null-terminated),
1170 * or NULL if there was a problem.
1172 static const char *parse_ref_line(struct strbuf
*line
, unsigned char *sha1
)
1177 * 42: the answer to everything.
1179 * In this case, it happens to be the answer to
1180 * 40 (length of sha1 hex representation)
1181 * +1 (space in between hex and name)
1182 * +1 (newline at the end of the line)
1184 if (line
->len
<= 42)
1187 if (get_sha1_hex(line
->buf
, sha1
) < 0)
1189 if (!isspace(line
->buf
[40]))
1192 ref
= line
->buf
+ 41;
1196 if (line
->buf
[line
->len
- 1] != '\n')
1198 line
->buf
[--line
->len
] = 0;
1204 * Read f, which is a packed-refs file, into dir.
1206 * A comment line of the form "# pack-refs with: " may contain zero or
1207 * more traits. We interpret the traits as follows:
1211 * Probably no references are peeled. But if the file contains a
1212 * peeled value for a reference, we will use it.
1216 * References under "refs/tags/", if they *can* be peeled, *are*
1217 * peeled in this file. References outside of "refs/tags/" are
1218 * probably not peeled even if they could have been, but if we find
1219 * a peeled value for such a reference we will use it.
1223 * All references in the file that can be peeled are peeled.
1224 * Inversely (and this is more important), any references in the
1225 * file for which no peeled value is recorded is not peelable. This
1226 * trait should typically be written alongside "peeled" for
1227 * compatibility with older clients, but we do not require it
1228 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1230 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1232 struct ref_entry
*last
= NULL
;
1233 struct strbuf line
= STRBUF_INIT
;
1234 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1236 while (strbuf_getwholeline(&line
, f
, '\n') != EOF
) {
1237 unsigned char sha1
[20];
1238 const char *refname
;
1241 if (skip_prefix(line
.buf
, "# pack-refs with:", &traits
)) {
1242 if (strstr(traits
, " fully-peeled "))
1243 peeled
= PEELED_FULLY
;
1244 else if (strstr(traits
, " peeled "))
1245 peeled
= PEELED_TAGS
;
1246 /* perhaps other traits later as well */
1250 refname
= parse_ref_line(&line
, sha1
);
1252 int flag
= REF_ISPACKED
;
1254 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1255 if (!refname_is_safe(refname
))
1256 die("packed refname is dangerous: %s", refname
);
1258 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1260 last
= create_ref_entry(refname
, sha1
, flag
, 0);
1261 if (peeled
== PEELED_FULLY
||
1262 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1263 last
->flag
|= REF_KNOWS_PEELED
;
1268 line
.buf
[0] == '^' &&
1269 line
.len
== PEELED_LINE_LENGTH
&&
1270 line
.buf
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1271 !get_sha1_hex(line
.buf
+ 1, sha1
)) {
1272 hashcpy(last
->u
.value
.peeled
.hash
, sha1
);
1274 * Regardless of what the file header said,
1275 * we definitely know the value of *this*
1278 last
->flag
|= REF_KNOWS_PEELED
;
1282 strbuf_release(&line
);
1286 * Get the packed_ref_cache for the specified ref_cache, creating it
1289 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1291 char *packed_refs_file
;
1294 packed_refs_file
= git_pathdup_submodule(refs
->name
, "packed-refs");
1296 packed_refs_file
= git_pathdup("packed-refs");
1299 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1300 clear_packed_ref_cache(refs
);
1302 if (!refs
->packed
) {
1305 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1306 acquire_packed_ref_cache(refs
->packed
);
1307 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1308 f
= fopen(packed_refs_file
, "r");
1310 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1311 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1315 free(packed_refs_file
);
1316 return refs
->packed
;
1319 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1321 return get_ref_dir(packed_ref_cache
->root
);
1324 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1326 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1330 * Add a reference to the in-memory packed reference cache. This may
1331 * only be called while the packed-refs file is locked (see
1332 * lock_packed_refs()). To actually write the packed-refs file, call
1333 * commit_packed_refs().
1335 static void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1337 struct packed_ref_cache
*packed_ref_cache
=
1338 get_packed_ref_cache(&ref_cache
);
1340 if (!packed_ref_cache
->lock
)
1341 die("internal error: packed refs not locked");
1342 add_ref(get_packed_ref_dir(packed_ref_cache
),
1343 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1347 * Read the loose references from the namespace dirname into dir
1348 * (without recursing). dirname must end with '/'. dir must be the
1349 * directory entry corresponding to dirname.
1351 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1353 struct ref_cache
*refs
= dir
->ref_cache
;
1356 int dirnamelen
= strlen(dirname
);
1357 struct strbuf refname
;
1358 struct strbuf path
= STRBUF_INIT
;
1359 size_t path_baselen
;
1362 strbuf_git_path_submodule(&path
, refs
->name
, "%s", dirname
);
1364 strbuf_git_path(&path
, "%s", dirname
);
1365 path_baselen
= path
.len
;
1367 d
= opendir(path
.buf
);
1369 strbuf_release(&path
);
1373 strbuf_init(&refname
, dirnamelen
+ 257);
1374 strbuf_add(&refname
, dirname
, dirnamelen
);
1376 while ((de
= readdir(d
)) != NULL
) {
1377 unsigned char sha1
[20];
1381 if (de
->d_name
[0] == '.')
1383 if (ends_with(de
->d_name
, ".lock"))
1385 strbuf_addstr(&refname
, de
->d_name
);
1386 strbuf_addstr(&path
, de
->d_name
);
1387 if (stat(path
.buf
, &st
) < 0) {
1388 ; /* silently ignore */
1389 } else if (S_ISDIR(st
.st_mode
)) {
1390 strbuf_addch(&refname
, '/');
1391 add_entry_to_dir(dir
,
1392 create_dir_entry(refs
, refname
.buf
,
1400 read_ok
= !resolve_gitlink_ref(refs
->name
,
1403 read_ok
= !read_ref_full(refname
.buf
,
1404 RESOLVE_REF_READING
,
1410 flag
|= REF_ISBROKEN
;
1411 } else if (is_null_sha1(sha1
)) {
1413 * It is so astronomically unlikely
1414 * that NULL_SHA1 is the SHA-1 of an
1415 * actual object that we consider its
1416 * appearance in a loose reference
1417 * file to be repo corruption
1418 * (probably due to a software bug).
1420 flag
|= REF_ISBROKEN
;
1423 if (check_refname_format(refname
.buf
,
1424 REFNAME_ALLOW_ONELEVEL
)) {
1425 if (!refname_is_safe(refname
.buf
))
1426 die("loose refname is dangerous: %s", refname
.buf
);
1428 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1430 add_entry_to_dir(dir
,
1431 create_ref_entry(refname
.buf
, sha1
, flag
, 0));
1433 strbuf_setlen(&refname
, dirnamelen
);
1434 strbuf_setlen(&path
, path_baselen
);
1436 strbuf_release(&refname
);
1437 strbuf_release(&path
);
1441 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1445 * Mark the top-level directory complete because we
1446 * are about to read the only subdirectory that can
1449 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1451 * Create an incomplete entry for "refs/":
1453 add_entry_to_dir(get_ref_dir(refs
->loose
),
1454 create_dir_entry(refs
, "refs/", 5, 1));
1456 return get_ref_dir(refs
->loose
);
1459 /* We allow "recursive" symbolic refs. Only within reason, though */
1461 #define MAXREFLEN (1024)
1464 * Called by resolve_gitlink_ref_recursive() after it failed to read
1465 * from the loose refs in ref_cache refs. Find <refname> in the
1466 * packed-refs file for the submodule.
1468 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1469 const char *refname
, unsigned char *sha1
)
1471 struct ref_entry
*ref
;
1472 struct ref_dir
*dir
= get_packed_refs(refs
);
1474 ref
= find_ref(dir
, refname
);
1478 hashcpy(sha1
, ref
->u
.value
.oid
.hash
);
1482 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1483 const char *refname
, unsigned char *sha1
,
1487 char buffer
[128], *p
;
1490 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1493 ? git_pathdup_submodule(refs
->name
, "%s", refname
)
1494 : git_pathdup("%s", refname
);
1495 fd
= open(path
, O_RDONLY
);
1498 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1500 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1504 while (len
&& isspace(buffer
[len
-1]))
1508 /* Was it a detached head or an old-fashioned symlink? */
1509 if (!get_sha1_hex(buffer
, sha1
))
1513 if (strncmp(buffer
, "ref:", 4))
1519 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1522 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1524 int len
= strlen(path
), retval
;
1526 struct ref_cache
*refs
;
1528 while (len
&& path
[len
-1] == '/')
1532 submodule
= xstrndup(path
, len
);
1533 refs
= get_ref_cache(submodule
);
1536 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1541 * Return the ref_entry for the given refname from the packed
1542 * references. If it does not exist, return NULL.
1544 static struct ref_entry
*get_packed_ref(const char *refname
)
1546 return find_ref(get_packed_refs(&ref_cache
), refname
);
1550 * A loose ref file doesn't exist; check for a packed ref. The
1551 * options are forwarded from resolve_safe_unsafe().
1553 static int resolve_missing_loose_ref(const char *refname
,
1555 unsigned char *sha1
,
1558 struct ref_entry
*entry
;
1561 * The loose reference file does not exist; check for a packed
1564 entry
= get_packed_ref(refname
);
1566 hashcpy(sha1
, entry
->u
.value
.oid
.hash
);
1568 *flags
|= REF_ISPACKED
;
1571 /* The reference is not a packed reference, either. */
1572 if (resolve_flags
& RESOLVE_REF_READING
) {
1581 /* This function needs to return a meaningful errno on failure */
1582 static const char *resolve_ref_unsafe_1(const char *refname
,
1584 unsigned char *sha1
,
1586 struct strbuf
*sb_path
)
1588 int depth
= MAXDEPTH
;
1591 static char refname_buffer
[256];
1597 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1599 *flags
|= REF_BAD_NAME
;
1601 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1602 !refname_is_safe(refname
)) {
1607 * dwim_ref() uses REF_ISBROKEN to distinguish between
1608 * missing refs and refs that were present but invalid,
1609 * to complain about the latter to stderr.
1611 * We don't know whether the ref exists, so don't set
1627 strbuf_reset(sb_path
);
1628 strbuf_git_path(sb_path
, "%s", refname
);
1629 path
= sb_path
->buf
;
1632 * We might have to loop back here to avoid a race
1633 * condition: first we lstat() the file, then we try
1634 * to read it as a link or as a file. But if somebody
1635 * changes the type of the file (file <-> directory
1636 * <-> symlink) between the lstat() and reading, then
1637 * we don't want to report that as an error but rather
1638 * try again starting with the lstat().
1641 if (lstat(path
, &st
) < 0) {
1642 if (errno
!= ENOENT
)
1644 if (resolve_missing_loose_ref(refname
, resolve_flags
,
1650 *flags
|= REF_ISBROKEN
;
1655 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1656 if (S_ISLNK(st
.st_mode
)) {
1657 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1659 if (errno
== ENOENT
|| errno
== EINVAL
)
1660 /* inconsistent with lstat; retry */
1666 if (starts_with(buffer
, "refs/") &&
1667 !check_refname_format(buffer
, 0)) {
1668 strcpy(refname_buffer
, buffer
);
1669 refname
= refname_buffer
;
1671 *flags
|= REF_ISSYMREF
;
1672 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1680 /* Is it a directory? */
1681 if (S_ISDIR(st
.st_mode
)) {
1687 * Anything else, just open it and try to use it as
1690 fd
= open(path
, O_RDONLY
);
1692 if (errno
== ENOENT
)
1693 /* inconsistent with lstat; retry */
1698 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1700 int save_errno
= errno
;
1706 while (len
&& isspace(buffer
[len
-1]))
1711 * Is it a symbolic ref?
1713 if (!starts_with(buffer
, "ref:")) {
1715 * Please note that FETCH_HEAD has a second
1716 * line containing other data.
1718 if (get_sha1_hex(buffer
, sha1
) ||
1719 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1721 *flags
|= REF_ISBROKEN
;
1728 *flags
|= REF_ISBROKEN
;
1733 *flags
|= REF_ISSYMREF
;
1735 while (isspace(*buf
))
1737 refname
= strcpy(refname_buffer
, buf
);
1738 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1742 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1744 *flags
|= REF_ISBROKEN
;
1746 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1747 !refname_is_safe(buf
)) {
1756 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1757 unsigned char *sha1
, int *flags
)
1759 struct strbuf sb_path
= STRBUF_INIT
;
1760 const char *ret
= resolve_ref_unsafe_1(refname
, resolve_flags
,
1761 sha1
, flags
, &sb_path
);
1762 strbuf_release(&sb_path
);
1766 char *resolve_refdup(const char *refname
, int resolve_flags
,
1767 unsigned char *sha1
, int *flags
)
1769 return xstrdup_or_null(resolve_ref_unsafe(refname
, resolve_flags
,
1773 /* The argument to filter_refs */
1775 const char *pattern
;
1780 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1782 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1787 int read_ref(const char *refname
, unsigned char *sha1
)
1789 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1792 int ref_exists(const char *refname
)
1794 unsigned char sha1
[20];
1795 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1798 static int filter_refs(const char *refname
, const struct object_id
*oid
,
1799 int flags
, void *data
)
1801 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1803 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1805 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
1809 /* object was peeled successfully: */
1813 * object cannot be peeled because the named object (or an
1814 * object referred to by a tag in the peel chain), does not
1819 /* object cannot be peeled because it is not a tag: */
1822 /* ref_entry contains no peeled value because it is a symref: */
1823 PEEL_IS_SYMREF
= -3,
1826 * ref_entry cannot be peeled because it is broken (i.e., the
1827 * symbolic reference cannot even be resolved to an object
1834 * Peel the named object; i.e., if the object is a tag, resolve the
1835 * tag recursively until a non-tag is found. If successful, store the
1836 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1837 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1838 * and leave sha1 unchanged.
1840 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1842 struct object
*o
= lookup_unknown_object(name
);
1844 if (o
->type
== OBJ_NONE
) {
1845 int type
= sha1_object_info(name
, NULL
);
1846 if (type
< 0 || !object_as_type(o
, type
, 0))
1847 return PEEL_INVALID
;
1850 if (o
->type
!= OBJ_TAG
)
1851 return PEEL_NON_TAG
;
1853 o
= deref_tag_noverify(o
);
1855 return PEEL_INVALID
;
1857 hashcpy(sha1
, o
->sha1
);
1862 * Peel the entry (if possible) and return its new peel_status. If
1863 * repeel is true, re-peel the entry even if there is an old peeled
1864 * value that is already stored in it.
1866 * It is OK to call this function with a packed reference entry that
1867 * might be stale and might even refer to an object that has since
1868 * been garbage-collected. In such a case, if the entry has
1869 * REF_KNOWS_PEELED then leave the status unchanged and return
1870 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1872 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1874 enum peel_status status
;
1876 if (entry
->flag
& REF_KNOWS_PEELED
) {
1878 entry
->flag
&= ~REF_KNOWS_PEELED
;
1879 oidclr(&entry
->u
.value
.peeled
);
1881 return is_null_oid(&entry
->u
.value
.peeled
) ?
1882 PEEL_NON_TAG
: PEEL_PEELED
;
1885 if (entry
->flag
& REF_ISBROKEN
)
1887 if (entry
->flag
& REF_ISSYMREF
)
1888 return PEEL_IS_SYMREF
;
1890 status
= peel_object(entry
->u
.value
.oid
.hash
, entry
->u
.value
.peeled
.hash
);
1891 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1892 entry
->flag
|= REF_KNOWS_PEELED
;
1896 int peel_ref(const char *refname
, unsigned char *sha1
)
1899 unsigned char base
[20];
1901 if (current_ref
&& (current_ref
->name
== refname
1902 || !strcmp(current_ref
->name
, refname
))) {
1903 if (peel_entry(current_ref
, 0))
1905 hashcpy(sha1
, current_ref
->u
.value
.peeled
.hash
);
1909 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1913 * If the reference is packed, read its ref_entry from the
1914 * cache in the hope that we already know its peeled value.
1915 * We only try this optimization on packed references because
1916 * (a) forcing the filling of the loose reference cache could
1917 * be expensive and (b) loose references anyway usually do not
1918 * have REF_KNOWS_PEELED.
1920 if (flag
& REF_ISPACKED
) {
1921 struct ref_entry
*r
= get_packed_ref(refname
);
1923 if (peel_entry(r
, 0))
1925 hashcpy(sha1
, r
->u
.value
.peeled
.hash
);
1930 return peel_object(base
, sha1
);
1933 struct warn_if_dangling_data
{
1935 const char *refname
;
1936 const struct string_list
*refnames
;
1937 const char *msg_fmt
;
1940 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
1941 int flags
, void *cb_data
)
1943 struct warn_if_dangling_data
*d
= cb_data
;
1944 const char *resolves_to
;
1945 struct object_id junk
;
1947 if (!(flags
& REF_ISSYMREF
))
1950 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
.hash
, NULL
);
1953 ? strcmp(resolves_to
, d
->refname
)
1954 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1958 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1963 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1965 struct warn_if_dangling_data data
;
1968 data
.refname
= refname
;
1969 data
.refnames
= NULL
;
1970 data
.msg_fmt
= msg_fmt
;
1971 for_each_rawref(warn_if_dangling_symref
, &data
);
1974 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1976 struct warn_if_dangling_data data
;
1979 data
.refname
= NULL
;
1980 data
.refnames
= refnames
;
1981 data
.msg_fmt
= msg_fmt
;
1982 for_each_rawref(warn_if_dangling_symref
, &data
);
1986 * Call fn for each reference in the specified ref_cache, omitting
1987 * references not in the containing_dir of base. fn is called for all
1988 * references, including broken ones. If fn ever returns a non-zero
1989 * value, stop the iteration and return that value; otherwise, return
1992 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1993 each_ref_entry_fn fn
, void *cb_data
)
1995 struct packed_ref_cache
*packed_ref_cache
;
1996 struct ref_dir
*loose_dir
;
1997 struct ref_dir
*packed_dir
;
2001 * We must make sure that all loose refs are read before accessing the
2002 * packed-refs file; this avoids a race condition in which loose refs
2003 * are migrated to the packed-refs file by a simultaneous process, but
2004 * our in-memory view is from before the migration. get_packed_ref_cache()
2005 * takes care of making sure our view is up to date with what is on
2008 loose_dir
= get_loose_refs(refs
);
2009 if (base
&& *base
) {
2010 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
2013 prime_ref_dir(loose_dir
);
2015 packed_ref_cache
= get_packed_ref_cache(refs
);
2016 acquire_packed_ref_cache(packed_ref_cache
);
2017 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
2018 if (base
&& *base
) {
2019 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
2022 if (packed_dir
&& loose_dir
) {
2023 sort_ref_dir(packed_dir
);
2024 sort_ref_dir(loose_dir
);
2025 retval
= do_for_each_entry_in_dirs(
2026 packed_dir
, loose_dir
, fn
, cb_data
);
2027 } else if (packed_dir
) {
2028 sort_ref_dir(packed_dir
);
2029 retval
= do_for_each_entry_in_dir(
2030 packed_dir
, 0, fn
, cb_data
);
2031 } else if (loose_dir
) {
2032 sort_ref_dir(loose_dir
);
2033 retval
= do_for_each_entry_in_dir(
2034 loose_dir
, 0, fn
, cb_data
);
2037 release_packed_ref_cache(packed_ref_cache
);
2042 * Call fn for each reference in the specified ref_cache for which the
2043 * refname begins with base. If trim is non-zero, then trim that many
2044 * characters off the beginning of each refname before passing the
2045 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
2046 * broken references in the iteration. If fn ever returns a non-zero
2047 * value, stop the iteration and return that value; otherwise, return
2050 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
2051 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
2053 struct ref_entry_cb data
;
2058 data
.cb_data
= cb_data
;
2060 if (ref_paranoia
< 0)
2061 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
2063 data
.flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
2065 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
2068 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2070 struct object_id oid
;
2074 if (resolve_gitlink_ref(submodule
, "HEAD", oid
.hash
) == 0)
2075 return fn("HEAD", &oid
, 0, cb_data
);
2080 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, oid
.hash
, &flag
))
2081 return fn("HEAD", &oid
, flag
, cb_data
);
2086 int head_ref(each_ref_fn fn
, void *cb_data
)
2088 return do_head_ref(NULL
, fn
, cb_data
);
2091 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2093 return do_head_ref(submodule
, fn
, cb_data
);
2096 int for_each_ref(each_ref_fn fn
, void *cb_data
)
2098 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
2101 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2103 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
2106 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
2108 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
2111 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
2112 each_ref_fn fn
, void *cb_data
)
2114 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
2117 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
2119 return for_each_ref_in("refs/tags/", fn
, cb_data
);
2122 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2124 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
2127 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
2129 return for_each_ref_in("refs/heads/", fn
, cb_data
);
2132 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2134 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2137 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2139 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2142 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2144 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2147 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2149 return do_for_each_ref(&ref_cache
, git_replace_ref_base
, fn
,
2150 strlen(git_replace_ref_base
), 0, cb_data
);
2153 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2155 struct strbuf buf
= STRBUF_INIT
;
2157 struct object_id oid
;
2160 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2161 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, oid
.hash
, &flag
))
2162 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
2163 strbuf_release(&buf
);
2168 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2170 struct strbuf buf
= STRBUF_INIT
;
2172 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2173 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2174 strbuf_release(&buf
);
2178 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2179 const char *prefix
, void *cb_data
)
2181 struct strbuf real_pattern
= STRBUF_INIT
;
2182 struct ref_filter filter
;
2185 if (!prefix
&& !starts_with(pattern
, "refs/"))
2186 strbuf_addstr(&real_pattern
, "refs/");
2188 strbuf_addstr(&real_pattern
, prefix
);
2189 strbuf_addstr(&real_pattern
, pattern
);
2191 if (!has_glob_specials(pattern
)) {
2192 /* Append implied '/' '*' if not present. */
2193 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2194 strbuf_addch(&real_pattern
, '/');
2195 /* No need to check for '*', there is none. */
2196 strbuf_addch(&real_pattern
, '*');
2199 filter
.pattern
= real_pattern
.buf
;
2201 filter
.cb_data
= cb_data
;
2202 ret
= for_each_ref(filter_refs
, &filter
);
2204 strbuf_release(&real_pattern
);
2208 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2210 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2213 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2215 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2216 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2219 const char *prettify_refname(const char *name
)
2222 starts_with(name
, "refs/heads/") ? 11 :
2223 starts_with(name
, "refs/tags/") ? 10 :
2224 starts_with(name
, "refs/remotes/") ? 13 :
2228 static const char *ref_rev_parse_rules
[] = {
2233 "refs/remotes/%.*s",
2234 "refs/remotes/%.*s/HEAD",
2238 int refname_match(const char *abbrev_name
, const char *full_name
)
2241 const int abbrev_name_len
= strlen(abbrev_name
);
2243 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2244 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2252 static void unlock_ref(struct ref_lock
*lock
)
2254 /* Do not free lock->lk -- atexit() still looks at them */
2256 rollback_lock_file(lock
->lk
);
2257 free(lock
->ref_name
);
2258 free(lock
->orig_ref_name
);
2263 * Verify that the reference locked by lock has the value old_sha1.
2264 * Fail if the reference doesn't exist and mustexist is set. Return 0
2265 * on success. On error, write an error message to err, set errno, and
2266 * return a negative value.
2268 static int verify_lock(struct ref_lock
*lock
,
2269 const unsigned char *old_sha1
, int mustexist
,
2274 if (read_ref_full(lock
->ref_name
,
2275 mustexist
? RESOLVE_REF_READING
: 0,
2276 lock
->old_oid
.hash
, NULL
)) {
2277 int save_errno
= errno
;
2278 strbuf_addf(err
, "can't verify ref %s", lock
->ref_name
);
2282 if (hashcmp(lock
->old_oid
.hash
, old_sha1
)) {
2283 strbuf_addf(err
, "ref %s is at %s but expected %s",
2285 sha1_to_hex(lock
->old_oid
.hash
),
2286 sha1_to_hex(old_sha1
));
2293 static int remove_empty_directories(const char *file
)
2295 /* we want to create a file but there is a directory there;
2296 * if that is an empty directory (or a directory that contains
2297 * only empty directories), remove them.
2300 int result
, save_errno
;
2302 strbuf_init(&path
, 20);
2303 strbuf_addstr(&path
, file
);
2305 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2308 strbuf_release(&path
);
2315 * *string and *len will only be substituted, and *string returned (for
2316 * later free()ing) if the string passed in is a magic short-hand form
2319 static char *substitute_branch_name(const char **string
, int *len
)
2321 struct strbuf buf
= STRBUF_INIT
;
2322 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2326 *string
= strbuf_detach(&buf
, &size
);
2328 return (char *)*string
;
2334 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2336 char *last_branch
= substitute_branch_name(&str
, &len
);
2341 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2342 char fullref
[PATH_MAX
];
2343 unsigned char sha1_from_ref
[20];
2344 unsigned char *this_result
;
2347 this_result
= refs_found
? sha1_from_ref
: sha1
;
2348 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2349 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2350 this_result
, &flag
);
2354 if (!warn_ambiguous_refs
)
2356 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2357 warning("ignoring dangling symref %s.", fullref
);
2358 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2359 warning("ignoring broken ref %s.", fullref
);
2366 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2368 char *last_branch
= substitute_branch_name(&str
, &len
);
2373 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2374 unsigned char hash
[20];
2375 char path
[PATH_MAX
];
2376 const char *ref
, *it
;
2378 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2379 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2383 if (reflog_exists(path
))
2385 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2389 if (!logs_found
++) {
2391 hashcpy(sha1
, hash
);
2393 if (!warn_ambiguous_refs
)
2401 * Locks a ref returning the lock on success and NULL on failure.
2402 * On failure errno is set to something meaningful.
2404 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2405 const unsigned char *old_sha1
,
2406 const struct string_list
*extras
,
2407 const struct string_list
*skip
,
2408 unsigned int flags
, int *type_p
,
2411 const char *ref_file
;
2412 const char *orig_refname
= refname
;
2413 struct ref_lock
*lock
;
2416 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2417 int resolve_flags
= 0;
2418 int attempts_remaining
= 3;
2422 lock
= xcalloc(1, sizeof(struct ref_lock
));
2425 resolve_flags
|= RESOLVE_REF_READING
;
2426 if (flags
& REF_DELETING
) {
2427 resolve_flags
|= RESOLVE_REF_ALLOW_BAD_NAME
;
2428 if (flags
& REF_NODEREF
)
2429 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2432 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2433 lock
->old_oid
.hash
, &type
);
2434 if (!refname
&& errno
== EISDIR
) {
2435 /* we are trying to lock foo but we used to
2436 * have foo/bar which now does not exist;
2437 * it is normal for the empty directory 'foo'
2440 ref_file
= git_path("%s", orig_refname
);
2441 if (remove_empty_directories(ref_file
)) {
2444 if (!verify_refname_available(orig_refname
, extras
, skip
,
2445 get_loose_refs(&ref_cache
), err
))
2446 strbuf_addf(err
, "there are still refs under '%s'",
2451 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2452 lock
->old_oid
.hash
, &type
);
2458 if (last_errno
!= ENOTDIR
||
2459 !verify_refname_available(orig_refname
, extras
, skip
,
2460 get_loose_refs(&ref_cache
), err
))
2461 strbuf_addf(err
, "unable to resolve reference %s: %s",
2462 orig_refname
, strerror(last_errno
));
2467 * If the ref did not exist and we are creating it, make sure
2468 * there is no existing packed ref whose name begins with our
2469 * refname, nor a packed ref whose name is a proper prefix of
2472 if (is_null_oid(&lock
->old_oid
) &&
2473 verify_refname_available(refname
, extras
, skip
,
2474 get_packed_refs(&ref_cache
), err
)) {
2475 last_errno
= ENOTDIR
;
2479 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2482 if (flags
& REF_NODEREF
) {
2483 refname
= orig_refname
;
2484 lflags
|= LOCK_NO_DEREF
;
2486 lock
->ref_name
= xstrdup(refname
);
2487 lock
->orig_ref_name
= xstrdup(orig_refname
);
2488 ref_file
= git_path("%s", refname
);
2491 switch (safe_create_leading_directories_const(ref_file
)) {
2493 break; /* success */
2495 if (--attempts_remaining
> 0)
2500 strbuf_addf(err
, "unable to create directory for %s", ref_file
);
2504 if (hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
) < 0) {
2506 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2508 * Maybe somebody just deleted one of the
2509 * directories leading to ref_file. Try
2514 unable_to_lock_message(ref_file
, errno
, err
);
2518 if (old_sha1
&& verify_lock(lock
, old_sha1
, mustexist
, err
)) {
2531 * Write an entry to the packed-refs file for the specified refname.
2532 * If peeled is non-NULL, write it as the entry's peeled value.
2534 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2535 unsigned char *peeled
)
2537 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2539 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2543 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2545 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2547 enum peel_status peel_status
= peel_entry(entry
, 0);
2549 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2550 error("internal error: %s is not a valid packed reference!",
2552 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.oid
.hash
,
2553 peel_status
== PEEL_PEELED
?
2554 entry
->u
.value
.peeled
.hash
: NULL
);
2559 * Lock the packed-refs file for writing. Flags is passed to
2560 * hold_lock_file_for_update(). Return 0 on success. On errors, set
2561 * errno appropriately and return a nonzero value.
2563 static int lock_packed_refs(int flags
)
2565 static int timeout_configured
= 0;
2566 static int timeout_value
= 1000;
2568 struct packed_ref_cache
*packed_ref_cache
;
2570 if (!timeout_configured
) {
2571 git_config_get_int("core.packedrefstimeout", &timeout_value
);
2572 timeout_configured
= 1;
2575 if (hold_lock_file_for_update_timeout(
2576 &packlock
, git_path("packed-refs"),
2577 flags
, timeout_value
) < 0)
2580 * Get the current packed-refs while holding the lock. If the
2581 * packed-refs file has been modified since we last read it,
2582 * this will automatically invalidate the cache and re-read
2583 * the packed-refs file.
2585 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2586 packed_ref_cache
->lock
= &packlock
;
2587 /* Increment the reference count to prevent it from being freed: */
2588 acquire_packed_ref_cache(packed_ref_cache
);
2593 * Write the current version of the packed refs cache from memory to
2594 * disk. The packed-refs file must already be locked for writing (see
2595 * lock_packed_refs()). Return zero on success. On errors, set errno
2596 * and return a nonzero value
2598 static int commit_packed_refs(void)
2600 struct packed_ref_cache
*packed_ref_cache
=
2601 get_packed_ref_cache(&ref_cache
);
2606 if (!packed_ref_cache
->lock
)
2607 die("internal error: packed-refs not locked");
2609 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2611 die_errno("unable to fdopen packed-refs descriptor");
2613 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2614 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2615 0, write_packed_entry_fn
, out
);
2617 if (commit_lock_file(packed_ref_cache
->lock
)) {
2621 packed_ref_cache
->lock
= NULL
;
2622 release_packed_ref_cache(packed_ref_cache
);
2628 * Rollback the lockfile for the packed-refs file, and discard the
2629 * in-memory packed reference cache. (The packed-refs file will be
2630 * read anew if it is needed again after this function is called.)
2632 static void rollback_packed_refs(void)
2634 struct packed_ref_cache
*packed_ref_cache
=
2635 get_packed_ref_cache(&ref_cache
);
2637 if (!packed_ref_cache
->lock
)
2638 die("internal error: packed-refs not locked");
2639 rollback_lock_file(packed_ref_cache
->lock
);
2640 packed_ref_cache
->lock
= NULL
;
2641 release_packed_ref_cache(packed_ref_cache
);
2642 clear_packed_ref_cache(&ref_cache
);
2645 struct ref_to_prune
{
2646 struct ref_to_prune
*next
;
2647 unsigned char sha1
[20];
2648 char name
[FLEX_ARRAY
];
2651 struct pack_refs_cb_data
{
2653 struct ref_dir
*packed_refs
;
2654 struct ref_to_prune
*ref_to_prune
;
2658 * An each_ref_entry_fn that is run over loose references only. If
2659 * the loose reference can be packed, add an entry in the packed ref
2660 * cache. If the reference should be pruned, also add it to
2661 * ref_to_prune in the pack_refs_cb_data.
2663 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2665 struct pack_refs_cb_data
*cb
= cb_data
;
2666 enum peel_status peel_status
;
2667 struct ref_entry
*packed_entry
;
2668 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2670 /* ALWAYS pack tags */
2671 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2674 /* Do not pack symbolic or broken refs: */
2675 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2678 /* Add a packed ref cache entry equivalent to the loose entry. */
2679 peel_status
= peel_entry(entry
, 1);
2680 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2681 die("internal error peeling reference %s (%s)",
2682 entry
->name
, oid_to_hex(&entry
->u
.value
.oid
));
2683 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2685 /* Overwrite existing packed entry with info from loose entry */
2686 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2687 oidcpy(&packed_entry
->u
.value
.oid
, &entry
->u
.value
.oid
);
2689 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.oid
.hash
,
2690 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2691 add_ref(cb
->packed_refs
, packed_entry
);
2693 oidcpy(&packed_entry
->u
.value
.peeled
, &entry
->u
.value
.peeled
);
2695 /* Schedule the loose reference for pruning if requested. */
2696 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2697 int namelen
= strlen(entry
->name
) + 1;
2698 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2699 hashcpy(n
->sha1
, entry
->u
.value
.oid
.hash
);
2700 strcpy(n
->name
, entry
->name
);
2701 n
->next
= cb
->ref_to_prune
;
2702 cb
->ref_to_prune
= n
;
2708 * Remove empty parents, but spare refs/ and immediate subdirs.
2709 * Note: munges *name.
2711 static void try_remove_empty_parents(char *name
)
2716 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2717 while (*p
&& *p
!= '/')
2719 /* tolerate duplicate slashes; see check_refname_format() */
2723 for (q
= p
; *q
; q
++)
2726 while (q
> p
&& *q
!= '/')
2728 while (q
> p
&& *(q
-1) == '/')
2733 if (rmdir(git_path("%s", name
)))
2738 /* make sure nobody touched the ref, and unlink */
2739 static void prune_ref(struct ref_to_prune
*r
)
2741 struct ref_transaction
*transaction
;
2742 struct strbuf err
= STRBUF_INIT
;
2744 if (check_refname_format(r
->name
, 0))
2747 transaction
= ref_transaction_begin(&err
);
2749 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2750 REF_ISPRUNING
, NULL
, &err
) ||
2751 ref_transaction_commit(transaction
, &err
)) {
2752 ref_transaction_free(transaction
);
2753 error("%s", err
.buf
);
2754 strbuf_release(&err
);
2757 ref_transaction_free(transaction
);
2758 strbuf_release(&err
);
2759 try_remove_empty_parents(r
->name
);
2762 static void prune_refs(struct ref_to_prune
*r
)
2770 int pack_refs(unsigned int flags
)
2772 struct pack_refs_cb_data cbdata
;
2774 memset(&cbdata
, 0, sizeof(cbdata
));
2775 cbdata
.flags
= flags
;
2777 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2778 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2780 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2781 pack_if_possible_fn
, &cbdata
);
2783 if (commit_packed_refs())
2784 die_errno("unable to overwrite old ref-pack file");
2786 prune_refs(cbdata
.ref_to_prune
);
2791 * Rewrite the packed-refs file, omitting any refs listed in
2792 * 'refnames'. On error, leave packed-refs unchanged, write an error
2793 * message to 'err', and return a nonzero value.
2795 * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
2797 static int repack_without_refs(struct string_list
*refnames
, struct strbuf
*err
)
2799 struct ref_dir
*packed
;
2800 struct string_list_item
*refname
;
2801 int ret
, needs_repacking
= 0, removed
= 0;
2805 /* Look for a packed ref */
2806 for_each_string_list_item(refname
, refnames
) {
2807 if (get_packed_ref(refname
->string
)) {
2808 needs_repacking
= 1;
2813 /* Avoid locking if we have nothing to do */
2814 if (!needs_repacking
)
2815 return 0; /* no refname exists in packed refs */
2817 if (lock_packed_refs(0)) {
2818 unable_to_lock_message(git_path("packed-refs"), errno
, err
);
2821 packed
= get_packed_refs(&ref_cache
);
2823 /* Remove refnames from the cache */
2824 for_each_string_list_item(refname
, refnames
)
2825 if (remove_entry(packed
, refname
->string
) != -1)
2829 * All packed entries disappeared while we were
2830 * acquiring the lock.
2832 rollback_packed_refs();
2836 /* Write what remains */
2837 ret
= commit_packed_refs();
2839 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2844 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2848 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2850 * loose. The loose file name is the same as the
2851 * lockfile name, minus ".lock":
2853 char *loose_filename
= get_locked_file_path(lock
->lk
);
2854 int res
= unlink_or_msg(loose_filename
, err
);
2855 free(loose_filename
);
2862 int delete_ref(const char *refname
, const unsigned char *old_sha1
,
2865 struct ref_transaction
*transaction
;
2866 struct strbuf err
= STRBUF_INIT
;
2868 transaction
= ref_transaction_begin(&err
);
2870 ref_transaction_delete(transaction
, refname
, old_sha1
,
2871 flags
, NULL
, &err
) ||
2872 ref_transaction_commit(transaction
, &err
)) {
2873 error("%s", err
.buf
);
2874 ref_transaction_free(transaction
);
2875 strbuf_release(&err
);
2878 ref_transaction_free(transaction
);
2879 strbuf_release(&err
);
2883 int delete_refs(struct string_list
*refnames
)
2885 struct strbuf err
= STRBUF_INIT
;
2891 result
= repack_without_refs(refnames
, &err
);
2894 * If we failed to rewrite the packed-refs file, then
2895 * it is unsafe to try to remove loose refs, because
2896 * doing so might expose an obsolete packed value for
2897 * a reference that might even point at an object that
2898 * has been garbage collected.
2900 if (refnames
->nr
== 1)
2901 error(_("could not delete reference %s: %s"),
2902 refnames
->items
[0].string
, err
.buf
);
2904 error(_("could not delete references: %s"), err
.buf
);
2909 for (i
= 0; i
< refnames
->nr
; i
++) {
2910 const char *refname
= refnames
->items
[i
].string
;
2912 if (delete_ref(refname
, NULL
, 0))
2913 result
|= error(_("could not remove reference %s"), refname
);
2917 strbuf_release(&err
);
2922 * People using contrib's git-new-workdir have .git/logs/refs ->
2923 * /some/other/path/.git/logs/refs, and that may live on another device.
2925 * IOW, to avoid cross device rename errors, the temporary renamed log must
2926 * live into logs/refs.
2928 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2930 static int rename_tmp_log(const char *newrefname
)
2932 int attempts_remaining
= 4;
2933 struct strbuf path
= STRBUF_INIT
;
2937 strbuf_reset(&path
);
2938 strbuf_git_path(&path
, "logs/%s", newrefname
);
2939 switch (safe_create_leading_directories_const(path
.buf
)) {
2941 break; /* success */
2943 if (--attempts_remaining
> 0)
2947 error("unable to create directory for %s", newrefname
);
2951 if (rename(git_path(TMP_RENAMED_LOG
), path
.buf
)) {
2952 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2954 * rename(a, b) when b is an existing
2955 * directory ought to result in ISDIR, but
2956 * Solaris 5.8 gives ENOTDIR. Sheesh.
2958 if (remove_empty_directories(path
.buf
)) {
2959 error("Directory not empty: logs/%s", newrefname
);
2963 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2965 * Maybe another process just deleted one of
2966 * the directories in the path to newrefname.
2967 * Try again from the beginning.
2971 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2972 newrefname
, strerror(errno
));
2978 strbuf_release(&path
);
2982 static int rename_ref_available(const char *oldname
, const char *newname
)
2984 struct string_list skip
= STRING_LIST_INIT_NODUP
;
2985 struct strbuf err
= STRBUF_INIT
;
2988 string_list_insert(&skip
, oldname
);
2989 ret
= !verify_refname_available(newname
, NULL
, &skip
,
2990 get_packed_refs(&ref_cache
), &err
)
2991 && !verify_refname_available(newname
, NULL
, &skip
,
2992 get_loose_refs(&ref_cache
), &err
);
2994 error("%s", err
.buf
);
2996 string_list_clear(&skip
, 0);
2997 strbuf_release(&err
);
3001 static int write_ref_to_lockfile(struct ref_lock
*lock
,
3002 const unsigned char *sha1
, struct strbuf
*err
);
3003 static int commit_ref_update(struct ref_lock
*lock
,
3004 const unsigned char *sha1
, const char *logmsg
,
3005 int flags
, struct strbuf
*err
);
3007 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
3009 unsigned char sha1
[20], orig_sha1
[20];
3010 int flag
= 0, logmoved
= 0;
3011 struct ref_lock
*lock
;
3012 struct stat loginfo
;
3013 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
3014 const char *symref
= NULL
;
3015 struct strbuf err
= STRBUF_INIT
;
3017 if (log
&& S_ISLNK(loginfo
.st_mode
))
3018 return error("reflog for %s is a symlink", oldrefname
);
3020 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
3022 if (flag
& REF_ISSYMREF
)
3023 return error("refname %s is a symbolic ref, renaming it is not supported",
3026 return error("refname %s not found", oldrefname
);
3028 if (!rename_ref_available(oldrefname
, newrefname
))
3031 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
3032 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
3033 oldrefname
, strerror(errno
));
3035 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
3036 error("unable to delete old %s", oldrefname
);
3040 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
3041 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
3042 if (errno
==EISDIR
) {
3043 if (remove_empty_directories(git_path("%s", newrefname
))) {
3044 error("Directory not empty: %s", newrefname
);
3048 error("unable to delete existing %s", newrefname
);
3053 if (log
&& rename_tmp_log(newrefname
))
3058 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, NULL
, 0, NULL
, &err
);
3060 error("unable to rename '%s' to '%s': %s", oldrefname
, newrefname
, err
.buf
);
3061 strbuf_release(&err
);
3064 hashcpy(lock
->old_oid
.hash
, orig_sha1
);
3066 if (write_ref_to_lockfile(lock
, orig_sha1
, &err
) ||
3067 commit_ref_update(lock
, orig_sha1
, logmsg
, 0, &err
)) {
3068 error("unable to write current sha1 into %s: %s", newrefname
, err
.buf
);
3069 strbuf_release(&err
);
3076 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, NULL
, 0, NULL
, &err
);
3078 error("unable to lock %s for rollback: %s", oldrefname
, err
.buf
);
3079 strbuf_release(&err
);
3083 flag
= log_all_ref_updates
;
3084 log_all_ref_updates
= 0;
3085 if (write_ref_to_lockfile(lock
, orig_sha1
, &err
) ||
3086 commit_ref_update(lock
, orig_sha1
, NULL
, 0, &err
)) {
3087 error("unable to write current sha1 into %s: %s", oldrefname
, err
.buf
);
3088 strbuf_release(&err
);
3090 log_all_ref_updates
= flag
;
3093 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
3094 error("unable to restore logfile %s from %s: %s",
3095 oldrefname
, newrefname
, strerror(errno
));
3096 if (!logmoved
&& log
&&
3097 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
3098 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
3099 oldrefname
, strerror(errno
));
3104 static int close_ref(struct ref_lock
*lock
)
3106 if (close_lock_file(lock
->lk
))
3111 static int commit_ref(struct ref_lock
*lock
)
3113 if (commit_lock_file(lock
->lk
))
3119 * copy the reflog message msg to buf, which has been allocated sufficiently
3120 * large, while cleaning up the whitespaces. Especially, convert LF to space,
3121 * because reflog file is one line per entry.
3123 static int copy_msg(char *buf
, const char *msg
)
3130 while ((c
= *msg
++)) {
3131 if (wasspace
&& isspace(c
))
3133 wasspace
= isspace(c
);
3138 while (buf
< cp
&& isspace(cp
[-1]))
3144 static int should_autocreate_reflog(const char *refname
)
3146 if (!log_all_ref_updates
)
3148 return starts_with(refname
, "refs/heads/") ||
3149 starts_with(refname
, "refs/remotes/") ||
3150 starts_with(refname
, "refs/notes/") ||
3151 !strcmp(refname
, "HEAD");
3155 * Create a reflog for a ref. If force_create = 0, the reflog will
3156 * only be created for certain refs (those for which
3157 * should_autocreate_reflog returns non-zero. Otherwise, create it
3158 * regardless of the ref name. Fill in *err and return -1 on failure.
3160 static int log_ref_setup(const char *refname
, struct strbuf
*logfile
, struct strbuf
*err
, int force_create
)
3162 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
3164 strbuf_git_path(logfile
, "logs/%s", refname
);
3165 if (force_create
|| should_autocreate_reflog(refname
)) {
3166 if (safe_create_leading_directories(logfile
->buf
) < 0) {
3167 strbuf_addf(err
, "unable to create directory for %s: "
3168 "%s", logfile
->buf
, strerror(errno
));
3174 logfd
= open(logfile
->buf
, oflags
, 0666);
3176 if (!(oflags
& O_CREAT
) && (errno
== ENOENT
|| errno
== EISDIR
))
3179 if (errno
== EISDIR
) {
3180 if (remove_empty_directories(logfile
->buf
)) {
3181 strbuf_addf(err
, "There are still logs under "
3182 "'%s'", logfile
->buf
);
3185 logfd
= open(logfile
->buf
, oflags
, 0666);
3189 strbuf_addf(err
, "unable to append to %s: %s",
3190 logfile
->buf
, strerror(errno
));
3195 adjust_shared_perm(logfile
->buf
);
3201 int safe_create_reflog(const char *refname
, int force_create
, struct strbuf
*err
)
3204 struct strbuf sb
= STRBUF_INIT
;
3206 ret
= log_ref_setup(refname
, &sb
, err
, force_create
);
3207 strbuf_release(&sb
);
3211 static int log_ref_write_fd(int fd
, const unsigned char *old_sha1
,
3212 const unsigned char *new_sha1
,
3213 const char *committer
, const char *msg
)
3215 int msglen
, written
;
3216 unsigned maxlen
, len
;
3219 msglen
= msg
? strlen(msg
) : 0;
3220 maxlen
= strlen(committer
) + msglen
+ 100;
3221 logrec
= xmalloc(maxlen
);
3222 len
= sprintf(logrec
, "%s %s %s\n",
3223 sha1_to_hex(old_sha1
),
3224 sha1_to_hex(new_sha1
),
3227 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
3229 written
= len
<= maxlen
? write_in_full(fd
, logrec
, len
) : -1;
3237 static int log_ref_write_1(const char *refname
, const unsigned char *old_sha1
,
3238 const unsigned char *new_sha1
, const char *msg
,
3239 struct strbuf
*logfile
, int flags
,
3242 int logfd
, result
, oflags
= O_APPEND
| O_WRONLY
;
3244 if (log_all_ref_updates
< 0)
3245 log_all_ref_updates
= !is_bare_repository();
3247 result
= log_ref_setup(refname
, logfile
, err
, flags
& REF_FORCE_CREATE_REFLOG
);
3252 logfd
= open(logfile
->buf
, oflags
);
3255 result
= log_ref_write_fd(logfd
, old_sha1
, new_sha1
,
3256 git_committer_info(0), msg
);
3258 strbuf_addf(err
, "unable to append to %s: %s", logfile
->buf
,
3264 strbuf_addf(err
, "unable to append to %s: %s", logfile
->buf
,
3271 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
3272 const unsigned char *new_sha1
, const char *msg
,
3273 int flags
, struct strbuf
*err
)
3275 struct strbuf sb
= STRBUF_INIT
;
3276 int ret
= log_ref_write_1(refname
, old_sha1
, new_sha1
, msg
, &sb
, flags
,
3278 strbuf_release(&sb
);
3282 int is_branch(const char *refname
)
3284 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3288 * Write sha1 into the open lockfile, then close the lockfile. On
3289 * errors, rollback the lockfile, fill in *err and
3292 static int write_ref_to_lockfile(struct ref_lock
*lock
,
3293 const unsigned char *sha1
, struct strbuf
*err
)
3295 static char term
= '\n';
3298 o
= parse_object(sha1
);
3301 "Trying to write ref %s with nonexistent object %s",
3302 lock
->ref_name
, sha1_to_hex(sha1
));
3306 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3308 "Trying to write non-commit object %s to branch %s",
3309 sha1_to_hex(sha1
), lock
->ref_name
);
3313 if (write_in_full(lock
->lk
->fd
, sha1_to_hex(sha1
), 40) != 40 ||
3314 write_in_full(lock
->lk
->fd
, &term
, 1) != 1 ||
3315 close_ref(lock
) < 0) {
3317 "Couldn't write %s", lock
->lk
->filename
.buf
);
3325 * Commit a change to a loose reference that has already been written
3326 * to the loose reference lockfile. Also update the reflogs if
3327 * necessary, using the specified lockmsg (which can be NULL).
3329 static int commit_ref_update(struct ref_lock
*lock
,
3330 const unsigned char *sha1
, const char *logmsg
,
3331 int flags
, struct strbuf
*err
)
3333 clear_loose_ref_cache(&ref_cache
);
3334 if (log_ref_write(lock
->ref_name
, lock
->old_oid
.hash
, sha1
, logmsg
, flags
, err
) < 0 ||
3335 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3336 log_ref_write(lock
->orig_ref_name
, lock
->old_oid
.hash
, sha1
, logmsg
, flags
, err
) < 0)) {
3337 char *old_msg
= strbuf_detach(err
, NULL
);
3338 strbuf_addf(err
, "Cannot update the ref '%s': %s",
3339 lock
->ref_name
, old_msg
);
3344 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3346 * Special hack: If a branch is updated directly and HEAD
3347 * points to it (may happen on the remote side of a push
3348 * for example) then logically the HEAD reflog should be
3350 * A generic solution implies reverse symref information,
3351 * but finding all symrefs pointing to the given branch
3352 * would be rather costly for this rare event (the direct
3353 * update of a branch) to be worth it. So let's cheat and
3354 * check with HEAD only which should cover 99% of all usage
3355 * scenarios (even 100% of the default ones).
3357 unsigned char head_sha1
[20];
3359 const char *head_ref
;
3360 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3361 head_sha1
, &head_flag
);
3362 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3363 !strcmp(head_ref
, lock
->ref_name
)) {
3364 struct strbuf log_err
= STRBUF_INIT
;
3365 if (log_ref_write("HEAD", lock
->old_oid
.hash
, sha1
,
3366 logmsg
, 0, &log_err
)) {
3367 error("%s", log_err
.buf
);
3368 strbuf_release(&log_err
);
3372 if (commit_ref(lock
)) {
3373 error("Couldn't set %s", lock
->ref_name
);
3382 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3385 char *lockpath
= NULL
;
3387 int fd
, len
, written
;
3388 char *git_HEAD
= git_pathdup("%s", ref_target
);
3389 unsigned char old_sha1
[20], new_sha1
[20];
3390 struct strbuf err
= STRBUF_INIT
;
3392 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3395 if (safe_create_leading_directories(git_HEAD
) < 0)
3396 return error("unable to create directory for %s", git_HEAD
);
3398 #ifndef NO_SYMLINK_HEAD
3399 if (prefer_symlink_refs
) {
3401 if (!symlink(refs_heads_master
, git_HEAD
))
3403 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3407 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3408 if (sizeof(ref
) <= len
) {
3409 error("refname too long: %s", refs_heads_master
);
3410 goto error_free_return
;
3412 lockpath
= mkpathdup("%s.lock", git_HEAD
);
3413 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3415 error("Unable to open %s for writing", lockpath
);
3416 goto error_free_return
;
3418 written
= write_in_full(fd
, ref
, len
);
3419 if (close(fd
) != 0 || written
!= len
) {
3420 error("Unable to write to %s", lockpath
);
3421 goto error_unlink_return
;
3423 if (rename(lockpath
, git_HEAD
) < 0) {
3424 error("Unable to create %s", git_HEAD
);
3425 goto error_unlink_return
;
3427 if (adjust_shared_perm(git_HEAD
)) {
3428 error("Unable to fix permissions on %s", lockpath
);
3429 error_unlink_return
:
3430 unlink_or_warn(lockpath
);
3438 #ifndef NO_SYMLINK_HEAD
3441 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
) &&
3442 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
, 0, &err
)) {
3443 error("%s", err
.buf
);
3444 strbuf_release(&err
);
3451 struct read_ref_at_cb
{
3452 const char *refname
;
3453 unsigned long at_time
;
3456 unsigned char *sha1
;
3459 unsigned char osha1
[20];
3460 unsigned char nsha1
[20];
3464 unsigned long *cutoff_time
;
3469 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3470 const char *email
, unsigned long timestamp
, int tz
,
3471 const char *message
, void *cb_data
)
3473 struct read_ref_at_cb
*cb
= cb_data
;
3477 cb
->date
= timestamp
;
3479 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3481 *cb
->msg
= xstrdup(message
);
3482 if (cb
->cutoff_time
)
3483 *cb
->cutoff_time
= timestamp
;
3485 *cb
->cutoff_tz
= tz
;
3487 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3489 * we have not yet updated cb->[n|o]sha1 so they still
3490 * hold the values for the previous record.
3492 if (!is_null_sha1(cb
->osha1
)) {
3493 hashcpy(cb
->sha1
, nsha1
);
3494 if (hashcmp(cb
->osha1
, nsha1
))
3495 warning("Log for ref %s has gap after %s.",
3496 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
3498 else if (cb
->date
== cb
->at_time
)
3499 hashcpy(cb
->sha1
, nsha1
);
3500 else if (hashcmp(nsha1
, cb
->sha1
))
3501 warning("Log for ref %s unexpectedly ended on %s.",
3502 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3503 DATE_MODE(RFC2822
)));
3504 hashcpy(cb
->osha1
, osha1
);
3505 hashcpy(cb
->nsha1
, nsha1
);
3509 hashcpy(cb
->osha1
, osha1
);
3510 hashcpy(cb
->nsha1
, nsha1
);
3516 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3517 const char *email
, unsigned long timestamp
,
3518 int tz
, const char *message
, void *cb_data
)
3520 struct read_ref_at_cb
*cb
= cb_data
;
3523 *cb
->msg
= xstrdup(message
);
3524 if (cb
->cutoff_time
)
3525 *cb
->cutoff_time
= timestamp
;
3527 *cb
->cutoff_tz
= tz
;
3529 *cb
->cutoff_cnt
= cb
->reccnt
;
3530 hashcpy(cb
->sha1
, osha1
);
3531 if (is_null_sha1(cb
->sha1
))
3532 hashcpy(cb
->sha1
, nsha1
);
3533 /* We just want the first entry */
3537 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3538 unsigned char *sha1
, char **msg
,
3539 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3541 struct read_ref_at_cb cb
;
3543 memset(&cb
, 0, sizeof(cb
));
3544 cb
.refname
= refname
;
3545 cb
.at_time
= at_time
;
3548 cb
.cutoff_time
= cutoff_time
;
3549 cb
.cutoff_tz
= cutoff_tz
;
3550 cb
.cutoff_cnt
= cutoff_cnt
;
3553 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3556 if (flags
& GET_SHA1_QUIETLY
)
3559 die("Log for %s is empty.", refname
);
3564 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3569 int reflog_exists(const char *refname
)
3573 return !lstat(git_path("logs/%s", refname
), &st
) &&
3574 S_ISREG(st
.st_mode
);
3577 int delete_reflog(const char *refname
)
3579 return remove_path(git_path("logs/%s", refname
));
3582 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3584 unsigned char osha1
[20], nsha1
[20];
3585 char *email_end
, *message
;
3586 unsigned long timestamp
;
3589 /* old SP new SP name <email> SP time TAB msg LF */
3590 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3591 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3592 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3593 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3594 email_end
[1] != ' ' ||
3595 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3596 !message
|| message
[0] != ' ' ||
3597 (message
[1] != '+' && message
[1] != '-') ||
3598 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3599 !isdigit(message
[4]) || !isdigit(message
[5]))
3600 return 0; /* corrupt? */
3601 email_end
[1] = '\0';
3602 tz
= strtol(message
+ 1, NULL
, 10);
3603 if (message
[6] != '\t')
3607 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3610 static char *find_beginning_of_line(char *bob
, char *scan
)
3612 while (bob
< scan
&& *(--scan
) != '\n')
3613 ; /* keep scanning backwards */
3615 * Return either beginning of the buffer, or LF at the end of
3616 * the previous line.
3621 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3623 struct strbuf sb
= STRBUF_INIT
;
3626 int ret
= 0, at_tail
= 1;
3628 logfp
= fopen(git_path("logs/%s", refname
), "r");
3632 /* Jump to the end */
3633 if (fseek(logfp
, 0, SEEK_END
) < 0)
3634 return error("cannot seek back reflog for %s: %s",
3635 refname
, strerror(errno
));
3637 while (!ret
&& 0 < pos
) {
3643 /* Fill next block from the end */
3644 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3645 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3646 return error("cannot seek back reflog for %s: %s",
3647 refname
, strerror(errno
));
3648 nread
= fread(buf
, cnt
, 1, logfp
);
3650 return error("cannot read %d bytes from reflog for %s: %s",
3651 cnt
, refname
, strerror(errno
));
3654 scanp
= endp
= buf
+ cnt
;
3655 if (at_tail
&& scanp
[-1] == '\n')
3656 /* Looking at the final LF at the end of the file */
3660 while (buf
< scanp
) {
3662 * terminating LF of the previous line, or the beginning
3667 bp
= find_beginning_of_line(buf
, scanp
);
3671 * The newline is the end of the previous line,
3672 * so we know we have complete line starting
3673 * at (bp + 1). Prefix it onto any prior data
3674 * we collected for the line and process it.
3676 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3679 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3685 * We are at the start of the buffer, and the
3686 * start of the file; there is no previous
3687 * line, and we have everything for this one.
3688 * Process it, and we can end the loop.
3690 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3691 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3698 * We are at the start of the buffer, and there
3699 * is more file to read backwards. Which means
3700 * we are in the middle of a line. Note that we
3701 * may get here even if *bp was a newline; that
3702 * just means we are at the exact end of the
3703 * previous line, rather than some spot in the
3706 * Save away what we have to be combined with
3707 * the data from the next read.
3709 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3716 die("BUG: reverse reflog parser had leftover data");
3719 strbuf_release(&sb
);
3723 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3726 struct strbuf sb
= STRBUF_INIT
;
3729 logfp
= fopen(git_path("logs/%s", refname
), "r");
3733 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3734 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3736 strbuf_release(&sb
);
3740 * Call fn for each reflog in the namespace indicated by name. name
3741 * must be empty or end with '/'. Name will be used as a scratch
3742 * space, but its contents will be restored before return.
3744 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3746 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3749 int oldlen
= name
->len
;
3752 return name
->len
? errno
: 0;
3754 while ((de
= readdir(d
)) != NULL
) {
3757 if (de
->d_name
[0] == '.')
3759 if (ends_with(de
->d_name
, ".lock"))
3761 strbuf_addstr(name
, de
->d_name
);
3762 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3763 ; /* silently ignore */
3765 if (S_ISDIR(st
.st_mode
)) {
3766 strbuf_addch(name
, '/');
3767 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3769 struct object_id oid
;
3771 if (read_ref_full(name
->buf
, 0, oid
.hash
, NULL
))
3772 retval
= error("bad ref for %s", name
->buf
);
3774 retval
= fn(name
->buf
, &oid
, 0, cb_data
);
3779 strbuf_setlen(name
, oldlen
);
3785 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3789 strbuf_init(&name
, PATH_MAX
);
3790 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3791 strbuf_release(&name
);
3796 * Information needed for a single ref update. Set new_sha1 to the new
3797 * value or to null_sha1 to delete the ref. To check the old value
3798 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
3799 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
3800 * not exist before update.
3804 * If (flags & REF_HAVE_NEW), set the reference to this value:
3806 unsigned char new_sha1
[20];
3808 * If (flags & REF_HAVE_OLD), check that the reference
3809 * previously had this value:
3811 unsigned char old_sha1
[20];
3813 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3814 * REF_DELETING, and REF_ISPRUNING:
3817 struct ref_lock
*lock
;
3820 const char refname
[FLEX_ARRAY
];
3824 * Transaction states.
3825 * OPEN: The transaction is in a valid state and can accept new updates.
3826 * An OPEN transaction can be committed.
3827 * CLOSED: A closed transaction is no longer active and no other operations
3828 * than free can be used on it in this state.
3829 * A transaction can either become closed by successfully committing
3830 * an active transaction or if there is a failure while building
3831 * the transaction thus rendering it failed/inactive.
3833 enum ref_transaction_state
{
3834 REF_TRANSACTION_OPEN
= 0,
3835 REF_TRANSACTION_CLOSED
= 1
3839 * Data structure for holding a reference transaction, which can
3840 * consist of checks and updates to multiple references, carried out
3841 * as atomically as possible. This structure is opaque to callers.
3843 struct ref_transaction
{
3844 struct ref_update
**updates
;
3847 enum ref_transaction_state state
;
3850 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
3854 return xcalloc(1, sizeof(struct ref_transaction
));
3857 void ref_transaction_free(struct ref_transaction
*transaction
)
3864 for (i
= 0; i
< transaction
->nr
; i
++) {
3865 free(transaction
->updates
[i
]->msg
);
3866 free(transaction
->updates
[i
]);
3868 free(transaction
->updates
);
3872 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3873 const char *refname
)
3875 size_t len
= strlen(refname
);
3876 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3878 strcpy((char *)update
->refname
, refname
);
3879 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3880 transaction
->updates
[transaction
->nr
++] = update
;
3884 int ref_transaction_update(struct ref_transaction
*transaction
,
3885 const char *refname
,
3886 const unsigned char *new_sha1
,
3887 const unsigned char *old_sha1
,
3888 unsigned int flags
, const char *msg
,
3891 struct ref_update
*update
;
3895 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3896 die("BUG: update called for transaction that is not open");
3898 if (new_sha1
&& !is_null_sha1(new_sha1
) &&
3899 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
3900 strbuf_addf(err
, "refusing to update ref with bad name %s",
3905 update
= add_update(transaction
, refname
);
3907 hashcpy(update
->new_sha1
, new_sha1
);
3908 flags
|= REF_HAVE_NEW
;
3911 hashcpy(update
->old_sha1
, old_sha1
);
3912 flags
|= REF_HAVE_OLD
;
3914 update
->flags
= flags
;
3916 update
->msg
= xstrdup(msg
);
3920 int ref_transaction_create(struct ref_transaction
*transaction
,
3921 const char *refname
,
3922 const unsigned char *new_sha1
,
3923 unsigned int flags
, const char *msg
,
3926 if (!new_sha1
|| is_null_sha1(new_sha1
))
3927 die("BUG: create called without valid new_sha1");
3928 return ref_transaction_update(transaction
, refname
, new_sha1
,
3929 null_sha1
, flags
, msg
, err
);
3932 int ref_transaction_delete(struct ref_transaction
*transaction
,
3933 const char *refname
,
3934 const unsigned char *old_sha1
,
3935 unsigned int flags
, const char *msg
,
3938 if (old_sha1
&& is_null_sha1(old_sha1
))
3939 die("BUG: delete called with old_sha1 set to zeros");
3940 return ref_transaction_update(transaction
, refname
,
3941 null_sha1
, old_sha1
,
3945 int ref_transaction_verify(struct ref_transaction
*transaction
,
3946 const char *refname
,
3947 const unsigned char *old_sha1
,
3952 die("BUG: verify called with old_sha1 set to NULL");
3953 return ref_transaction_update(transaction
, refname
,
3958 int update_ref(const char *msg
, const char *refname
,
3959 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
3960 unsigned int flags
, enum action_on_err onerr
)
3962 struct ref_transaction
*t
;
3963 struct strbuf err
= STRBUF_INIT
;
3965 t
= ref_transaction_begin(&err
);
3967 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
3968 flags
, msg
, &err
) ||
3969 ref_transaction_commit(t
, &err
)) {
3970 const char *str
= "update_ref failed for ref '%s': %s";
3972 ref_transaction_free(t
);
3974 case UPDATE_REFS_MSG_ON_ERR
:
3975 error(str
, refname
, err
.buf
);
3977 case UPDATE_REFS_DIE_ON_ERR
:
3978 die(str
, refname
, err
.buf
);
3980 case UPDATE_REFS_QUIET_ON_ERR
:
3983 strbuf_release(&err
);
3986 strbuf_release(&err
);
3987 ref_transaction_free(t
);
3991 static int ref_update_reject_duplicates(struct string_list
*refnames
,
3994 int i
, n
= refnames
->nr
;
3998 for (i
= 1; i
< n
; i
++)
3999 if (!strcmp(refnames
->items
[i
- 1].string
, refnames
->items
[i
].string
)) {
4001 "Multiple updates for ref '%s' not allowed.",
4002 refnames
->items
[i
].string
);
4008 int ref_transaction_commit(struct ref_transaction
*transaction
,
4012 int n
= transaction
->nr
;
4013 struct ref_update
**updates
= transaction
->updates
;
4014 struct string_list refs_to_delete
= STRING_LIST_INIT_NODUP
;
4015 struct string_list_item
*ref_to_delete
;
4016 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
4020 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
4021 die("BUG: commit called for transaction that is not open");
4024 transaction
->state
= REF_TRANSACTION_CLOSED
;
4028 /* Fail if a refname appears more than once in the transaction: */
4029 for (i
= 0; i
< n
; i
++)
4030 string_list_append(&affected_refnames
, updates
[i
]->refname
);
4031 string_list_sort(&affected_refnames
);
4032 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
4033 ret
= TRANSACTION_GENERIC_ERROR
;
4038 * Acquire all locks, verify old values if provided, check
4039 * that new values are valid, and write new values to the
4040 * lockfiles, ready to be activated. Only keep one lockfile
4041 * open at a time to avoid running out of file descriptors.
4043 for (i
= 0; i
< n
; i
++) {
4044 struct ref_update
*update
= updates
[i
];
4046 if ((update
->flags
& REF_HAVE_NEW
) &&
4047 is_null_sha1(update
->new_sha1
))
4048 update
->flags
|= REF_DELETING
;
4049 update
->lock
= lock_ref_sha1_basic(
4051 ((update
->flags
& REF_HAVE_OLD
) ?
4052 update
->old_sha1
: NULL
),
4053 &affected_refnames
, NULL
,
4057 if (!update
->lock
) {
4060 ret
= (errno
== ENOTDIR
)
4061 ? TRANSACTION_NAME_CONFLICT
4062 : TRANSACTION_GENERIC_ERROR
;
4063 reason
= strbuf_detach(err
, NULL
);
4064 strbuf_addf(err
, "cannot lock ref '%s': %s",
4065 update
->refname
, reason
);
4069 if ((update
->flags
& REF_HAVE_NEW
) &&
4070 !(update
->flags
& REF_DELETING
)) {
4071 int overwriting_symref
= ((update
->type
& REF_ISSYMREF
) &&
4072 (update
->flags
& REF_NODEREF
));
4074 if (!overwriting_symref
&&
4075 !hashcmp(update
->lock
->old_oid
.hash
, update
->new_sha1
)) {
4077 * The reference already has the desired
4078 * value, so we don't need to write it.
4080 } else if (write_ref_to_lockfile(update
->lock
,
4083 char *write_err
= strbuf_detach(err
, NULL
);
4086 * The lock was freed upon failure of
4087 * write_ref_to_lockfile():
4089 update
->lock
= NULL
;
4091 "cannot update the ref '%s': %s",
4092 update
->refname
, write_err
);
4094 ret
= TRANSACTION_GENERIC_ERROR
;
4097 update
->flags
|= REF_NEEDS_COMMIT
;
4100 if (!(update
->flags
& REF_NEEDS_COMMIT
)) {
4102 * We didn't have to write anything to the lockfile.
4103 * Close it to free up the file descriptor:
4105 if (close_ref(update
->lock
)) {
4106 strbuf_addf(err
, "Couldn't close %s.lock",
4113 /* Perform updates first so live commits remain referenced */
4114 for (i
= 0; i
< n
; i
++) {
4115 struct ref_update
*update
= updates
[i
];
4117 if (update
->flags
& REF_NEEDS_COMMIT
) {
4118 if (commit_ref_update(update
->lock
,
4119 update
->new_sha1
, update
->msg
,
4120 update
->flags
, err
)) {
4121 /* freed by commit_ref_update(): */
4122 update
->lock
= NULL
;
4123 ret
= TRANSACTION_GENERIC_ERROR
;
4126 /* freed by commit_ref_update(): */
4127 update
->lock
= NULL
;
4132 /* Perform deletes now that updates are safely completed */
4133 for (i
= 0; i
< n
; i
++) {
4134 struct ref_update
*update
= updates
[i
];
4136 if (update
->flags
& REF_DELETING
) {
4137 if (delete_ref_loose(update
->lock
, update
->type
, err
)) {
4138 ret
= TRANSACTION_GENERIC_ERROR
;
4142 if (!(update
->flags
& REF_ISPRUNING
))
4143 string_list_append(&refs_to_delete
,
4144 update
->lock
->ref_name
);
4148 if (repack_without_refs(&refs_to_delete
, err
)) {
4149 ret
= TRANSACTION_GENERIC_ERROR
;
4152 for_each_string_list_item(ref_to_delete
, &refs_to_delete
)
4153 unlink_or_warn(git_path("logs/%s", ref_to_delete
->string
));
4154 clear_loose_ref_cache(&ref_cache
);
4157 transaction
->state
= REF_TRANSACTION_CLOSED
;
4159 for (i
= 0; i
< n
; i
++)
4160 if (updates
[i
]->lock
)
4161 unlock_ref(updates
[i
]->lock
);
4162 string_list_clear(&refs_to_delete
, 0);
4163 string_list_clear(&affected_refnames
, 0);
4167 static int ref_present(const char *refname
,
4168 const struct object_id
*oid
, int flags
, void *cb_data
)
4170 struct string_list
*affected_refnames
= cb_data
;
4172 return string_list_has_string(affected_refnames
, refname
);
4175 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
4178 struct ref_dir
*loose_refs
= get_loose_refs(&ref_cache
);
4179 struct ref_dir
*packed_refs
= get_packed_refs(&ref_cache
);
4181 int n
= transaction
->nr
;
4182 struct ref_update
**updates
= transaction
->updates
;
4183 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
4187 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
4188 die("BUG: commit called for transaction that is not open");
4190 /* Fail if a refname appears more than once in the transaction: */
4191 for (i
= 0; i
< n
; i
++)
4192 string_list_append(&affected_refnames
, updates
[i
]->refname
);
4193 string_list_sort(&affected_refnames
);
4194 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
4195 ret
= TRANSACTION_GENERIC_ERROR
;
4200 * It's really undefined to call this function in an active
4201 * repository or when there are existing references: we are
4202 * only locking and changing packed-refs, so (1) any
4203 * simultaneous processes might try to change a reference at
4204 * the same time we do, and (2) any existing loose versions of
4205 * the references that we are setting would have precedence
4206 * over our values. But some remote helpers create the remote
4207 * "HEAD" and "master" branches before calling this function,
4208 * so here we really only check that none of the references
4209 * that we are creating already exists.
4211 if (for_each_rawref(ref_present
, &affected_refnames
))
4212 die("BUG: initial ref transaction called with existing refs");
4214 for (i
= 0; i
< n
; i
++) {
4215 struct ref_update
*update
= updates
[i
];
4217 if ((update
->flags
& REF_HAVE_OLD
) &&
4218 !is_null_sha1(update
->old_sha1
))
4219 die("BUG: initial ref transaction with old_sha1 set");
4220 if (verify_refname_available(update
->refname
,
4221 &affected_refnames
, NULL
,
4223 verify_refname_available(update
->refname
,
4224 &affected_refnames
, NULL
,
4225 packed_refs
, err
)) {
4226 ret
= TRANSACTION_NAME_CONFLICT
;
4231 if (lock_packed_refs(0)) {
4232 strbuf_addf(err
, "unable to lock packed-refs file: %s",
4234 ret
= TRANSACTION_GENERIC_ERROR
;
4238 for (i
= 0; i
< n
; i
++) {
4239 struct ref_update
*update
= updates
[i
];
4241 if ((update
->flags
& REF_HAVE_NEW
) &&
4242 !is_null_sha1(update
->new_sha1
))
4243 add_packed_ref(update
->refname
, update
->new_sha1
);
4246 if (commit_packed_refs()) {
4247 strbuf_addf(err
, "unable to commit packed-refs file: %s",
4249 ret
= TRANSACTION_GENERIC_ERROR
;
4254 transaction
->state
= REF_TRANSACTION_CLOSED
;
4255 string_list_clear(&affected_refnames
, 0);
4259 char *shorten_unambiguous_ref(const char *refname
, int strict
)
4262 static char **scanf_fmts
;
4263 static int nr_rules
;
4268 * Pre-generate scanf formats from ref_rev_parse_rules[].
4269 * Generate a format suitable for scanf from a
4270 * ref_rev_parse_rules rule by interpolating "%s" at the
4271 * location of the "%.*s".
4273 size_t total_len
= 0;
4276 /* the rule list is NULL terminated, count them first */
4277 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
4278 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
4279 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
4281 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
4284 for (i
= 0; i
< nr_rules
; i
++) {
4285 assert(offset
< total_len
);
4286 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
4287 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
4288 ref_rev_parse_rules
[i
], 2, "%s") + 1;
4292 /* bail out if there are no rules */
4294 return xstrdup(refname
);
4296 /* buffer for scanf result, at most refname must fit */
4297 short_name
= xstrdup(refname
);
4299 /* skip first rule, it will always match */
4300 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
4302 int rules_to_fail
= i
;
4305 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
4308 short_name_len
= strlen(short_name
);
4311 * in strict mode, all (except the matched one) rules
4312 * must fail to resolve to a valid non-ambiguous ref
4315 rules_to_fail
= nr_rules
;
4318 * check if the short name resolves to a valid ref,
4319 * but use only rules prior to the matched one
4321 for (j
= 0; j
< rules_to_fail
; j
++) {
4322 const char *rule
= ref_rev_parse_rules
[j
];
4323 char refname
[PATH_MAX
];
4325 /* skip matched rule */
4330 * the short name is ambiguous, if it resolves
4331 * (with this previous rule) to a valid ref
4332 * read_ref() returns 0 on success
4334 mksnpath(refname
, sizeof(refname
),
4335 rule
, short_name_len
, short_name
);
4336 if (ref_exists(refname
))
4341 * short name is non-ambiguous if all previous rules
4342 * haven't resolved to a valid ref
4344 if (j
== rules_to_fail
)
4349 return xstrdup(refname
);
4352 static struct string_list
*hide_refs
;
4354 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
4356 if (!strcmp("transfer.hiderefs", var
) ||
4357 /* NEEDSWORK: use parse_config_key() once both are merged */
4358 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
4359 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
4364 return config_error_nonbool(var
);
4365 ref
= xstrdup(value
);
4367 while (len
&& ref
[len
- 1] == '/')
4370 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
4371 hide_refs
->strdup_strings
= 1;
4373 string_list_append(hide_refs
, ref
);
4378 int ref_is_hidden(const char *refname
)
4380 struct string_list_item
*item
;
4384 for_each_string_list_item(item
, hide_refs
) {
4386 if (!starts_with(refname
, item
->string
))
4388 len
= strlen(item
->string
);
4389 if (!refname
[len
] || refname
[len
] == '/')
4395 struct expire_reflog_cb
{
4397 reflog_expiry_should_prune_fn
*should_prune_fn
;
4400 unsigned char last_kept_sha1
[20];
4403 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
4404 const char *email
, unsigned long timestamp
, int tz
,
4405 const char *message
, void *cb_data
)
4407 struct expire_reflog_cb
*cb
= cb_data
;
4408 struct expire_reflog_policy_cb
*policy_cb
= cb
->policy_cb
;
4410 if (cb
->flags
& EXPIRE_REFLOGS_REWRITE
)
4411 osha1
= cb
->last_kept_sha1
;
4413 if ((*cb
->should_prune_fn
)(osha1
, nsha1
, email
, timestamp
, tz
,
4414 message
, policy_cb
)) {
4416 printf("would prune %s", message
);
4417 else if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4418 printf("prune %s", message
);
4421 fprintf(cb
->newlog
, "%s %s %s %lu %+05d\t%s",
4422 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
4423 email
, timestamp
, tz
, message
);
4424 hashcpy(cb
->last_kept_sha1
, nsha1
);
4426 if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4427 printf("keep %s", message
);
4432 int reflog_expire(const char *refname
, const unsigned char *sha1
,
4434 reflog_expiry_prepare_fn prepare_fn
,
4435 reflog_expiry_should_prune_fn should_prune_fn
,
4436 reflog_expiry_cleanup_fn cleanup_fn
,
4437 void *policy_cb_data
)
4439 static struct lock_file reflog_lock
;
4440 struct expire_reflog_cb cb
;
4441 struct ref_lock
*lock
;
4445 struct strbuf err
= STRBUF_INIT
;
4447 memset(&cb
, 0, sizeof(cb
));
4449 cb
.policy_cb
= policy_cb_data
;
4450 cb
.should_prune_fn
= should_prune_fn
;
4453 * The reflog file is locked by holding the lock on the
4454 * reference itself, plus we might need to update the
4455 * reference if --updateref was specified:
4457 lock
= lock_ref_sha1_basic(refname
, sha1
, NULL
, NULL
, 0, &type
, &err
);
4459 error("cannot lock ref '%s': %s", refname
, err
.buf
);
4460 strbuf_release(&err
);
4463 if (!reflog_exists(refname
)) {
4468 log_file
= git_pathdup("logs/%s", refname
);
4469 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4471 * Even though holding $GIT_DIR/logs/$reflog.lock has
4472 * no locking implications, we use the lock_file
4473 * machinery here anyway because it does a lot of the
4474 * work we need, including cleaning up if the program
4475 * exits unexpectedly.
4477 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
4478 struct strbuf err
= STRBUF_INIT
;
4479 unable_to_lock_message(log_file
, errno
, &err
);
4480 error("%s", err
.buf
);
4481 strbuf_release(&err
);
4484 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
4486 error("cannot fdopen %s (%s)",
4487 reflog_lock
.filename
.buf
, strerror(errno
));
4492 (*prepare_fn
)(refname
, sha1
, cb
.policy_cb
);
4493 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
4494 (*cleanup_fn
)(cb
.policy_cb
);
4496 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4498 * It doesn't make sense to adjust a reference pointed
4499 * to by a symbolic ref based on expiring entries in
4500 * the symbolic reference's reflog. Nor can we update
4501 * a reference if there are no remaining reflog
4504 int update
= (flags
& EXPIRE_REFLOGS_UPDATE_REF
) &&
4505 !(type
& REF_ISSYMREF
) &&
4506 !is_null_sha1(cb
.last_kept_sha1
);
4508 if (close_lock_file(&reflog_lock
)) {
4509 status
|= error("couldn't write %s: %s", log_file
,
4511 } else if (update
&&
4512 (write_in_full(lock
->lk
->fd
,
4513 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
4514 write_str_in_full(lock
->lk
->fd
, "\n") != 1 ||
4515 close_ref(lock
) < 0)) {
4516 status
|= error("couldn't write %s",
4517 lock
->lk
->filename
.buf
);
4518 rollback_lock_file(&reflog_lock
);
4519 } else if (commit_lock_file(&reflog_lock
)) {
4520 status
|= error("unable to commit reflog '%s' (%s)",
4521 log_file
, strerror(errno
));
4522 } else if (update
&& commit_ref(lock
)) {
4523 status
|= error("couldn't set %s", lock
->ref_name
);
4531 rollback_lock_file(&reflog_lock
);