7 #include "string-list.h"
13 unsigned char old_sha1
[20];
18 * How to handle various characters in refnames:
19 * 0: An acceptable character for refs
21 * 2: ., look for a preceding . to reject .. in refs
22 * 3: {, look for a preceding @ to reject @{ in refs
23 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
25 static unsigned char refname_disposition
[256] = {
26 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
27 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
28 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
29 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
30 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
31 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
32 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
33 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
37 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken
38 * refs (i.e., because the reference is about to be deleted anyway).
40 #define REF_DELETING 0x02
43 * Used as a flag in ref_update::flags when a loose ref is being
46 #define REF_ISPRUNING 0x04
49 * Used as a flag in ref_update::flags when the reference should be
50 * updated to new_sha1.
52 #define REF_HAVE_NEW 0x08
55 * Used as a flag in ref_update::flags when old_sha1 should be
58 #define REF_HAVE_OLD 0x10
61 * Try to read one refname component from the front of refname.
62 * Return the length of the component found, or -1 if the component is
63 * not legal. It is legal if it is something reasonable to have under
64 * ".git/refs/"; We do not like it if:
66 * - any path component of it begins with ".", or
67 * - it has double dots "..", or
68 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
69 * - it ends with a "/".
70 * - it ends with ".lock"
71 * - it contains a "\" (backslash)
73 static int check_refname_component(const char *refname
, int flags
)
78 for (cp
= refname
; ; cp
++) {
80 unsigned char disp
= refname_disposition
[ch
];
86 return -1; /* Refname contains "..". */
90 return -1; /* Refname contains "@{". */
99 return 0; /* Component has zero length. */
100 if (refname
[0] == '.')
101 return -1; /* Component starts with '.'. */
102 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
103 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
104 return -1; /* Refname ends with ".lock". */
108 int check_refname_format(const char *refname
, int flags
)
110 int component_len
, component_count
= 0;
112 if (!strcmp(refname
, "@"))
113 /* Refname is a single character '@'. */
117 /* We are at the start of a path component. */
118 component_len
= check_refname_component(refname
, flags
);
119 if (component_len
<= 0) {
120 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
122 (refname
[1] == '\0' || refname
[1] == '/')) {
123 /* Accept one wildcard as a full refname component. */
124 flags
&= ~REFNAME_REFSPEC_PATTERN
;
131 if (refname
[component_len
] == '\0')
133 /* Skip to next component. */
134 refname
+= component_len
+ 1;
137 if (refname
[component_len
- 1] == '.')
138 return -1; /* Refname ends with '.'. */
139 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
140 return -1; /* Refname has only one component. */
147 * Information used (along with the information in ref_entry) to
148 * describe a single cached reference. This data structure only
149 * occurs embedded in a union in struct ref_entry, and only when
150 * (ref_entry->flag & REF_DIR) is zero.
154 * The name of the object to which this reference resolves
155 * (which may be a tag object). If REF_ISBROKEN, this is
156 * null. If REF_ISSYMREF, then this is the name of the object
157 * referred to by the last reference in the symlink chain.
159 unsigned char sha1
[20];
162 * If REF_KNOWS_PEELED, then this field holds the peeled value
163 * of this reference, or null if the reference is known not to
164 * be peelable. See the documentation for peel_ref() for an
165 * exact definition of "peelable".
167 unsigned char peeled
[20];
173 * Information used (along with the information in ref_entry) to
174 * describe a level in the hierarchy of references. This data
175 * structure only occurs embedded in a union in struct ref_entry, and
176 * only when (ref_entry.flag & REF_DIR) is set. In that case,
177 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
178 * in the directory have already been read:
180 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
181 * or packed references, already read.
183 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
184 * references that hasn't been read yet (nor has any of its
187 * Entries within a directory are stored within a growable array of
188 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
189 * sorted are sorted by their component name in strcmp() order and the
190 * remaining entries are unsorted.
192 * Loose references are read lazily, one directory at a time. When a
193 * directory of loose references is read, then all of the references
194 * in that directory are stored, and REF_INCOMPLETE stubs are created
195 * for any subdirectories, but the subdirectories themselves are not
196 * read. The reading is triggered by get_ref_dir().
202 * Entries with index 0 <= i < sorted are sorted by name. New
203 * entries are appended to the list unsorted, and are sorted
204 * only when required; thus we avoid the need to sort the list
205 * after the addition of every reference.
209 /* A pointer to the ref_cache that contains this ref_dir. */
210 struct ref_cache
*ref_cache
;
212 struct ref_entry
**entries
;
216 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
217 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
218 * public values; see refs.h.
222 * The field ref_entry->u.value.peeled of this value entry contains
223 * the correct peeled value for the reference, which might be
224 * null_sha1 if the reference is not a tag or if it is broken.
226 #define REF_KNOWS_PEELED 0x10
228 /* ref_entry represents a directory of references */
232 * Entry has not yet been read from disk (used only for REF_DIR
233 * entries representing loose references)
235 #define REF_INCOMPLETE 0x40
238 * A ref_entry represents either a reference or a "subdirectory" of
241 * Each directory in the reference namespace is represented by a
242 * ref_entry with (flags & REF_DIR) set and containing a subdir member
243 * that holds the entries in that directory that have been read so
244 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
245 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
246 * used for loose reference directories.
248 * References are represented by a ref_entry with (flags & REF_DIR)
249 * unset and a value member that describes the reference's value. The
250 * flag member is at the ref_entry level, but it is also needed to
251 * interpret the contents of the value field (in other words, a
252 * ref_value object is not very much use without the enclosing
255 * Reference names cannot end with slash and directories' names are
256 * always stored with a trailing slash (except for the top-level
257 * directory, which is always denoted by ""). This has two nice
258 * consequences: (1) when the entries in each subdir are sorted
259 * lexicographically by name (as they usually are), the references in
260 * a whole tree can be generated in lexicographic order by traversing
261 * the tree in left-to-right, depth-first order; (2) the names of
262 * references and subdirectories cannot conflict, and therefore the
263 * presence of an empty subdirectory does not block the creation of a
264 * similarly-named reference. (The fact that reference names with the
265 * same leading components can conflict *with each other* is a
266 * separate issue that is regulated by is_refname_available().)
268 * Please note that the name field contains the fully-qualified
269 * reference (or subdirectory) name. Space could be saved by only
270 * storing the relative names. But that would require the full names
271 * to be generated on the fly when iterating in do_for_each_ref(), and
272 * would break callback functions, who have always been able to assume
273 * that the name strings that they are passed will not be freed during
277 unsigned char flag
; /* ISSYMREF? ISPACKED? */
279 struct ref_value value
; /* if not (flags&REF_DIR) */
280 struct ref_dir subdir
; /* if (flags&REF_DIR) */
283 * The full name of the reference (e.g., "refs/heads/master")
284 * or the full name of the directory with a trailing slash
285 * (e.g., "refs/heads/"):
287 char name
[FLEX_ARRAY
];
290 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
292 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
295 assert(entry
->flag
& REF_DIR
);
296 dir
= &entry
->u
.subdir
;
297 if (entry
->flag
& REF_INCOMPLETE
) {
298 read_loose_refs(entry
->name
, dir
);
299 entry
->flag
&= ~REF_INCOMPLETE
;
305 * Check if a refname is safe.
306 * For refs that start with "refs/" we consider it safe as long they do
307 * not try to resolve to outside of refs/.
309 * For all other refs we only consider them safe iff they only contain
310 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
313 static int refname_is_safe(const char *refname
)
315 if (starts_with(refname
, "refs/")) {
319 buf
= xmalloc(strlen(refname
) + 1);
321 * Does the refname try to escape refs/?
322 * For example: refs/foo/../bar is safe but refs/foo/../../bar
325 result
= !normalize_path_copy(buf
, refname
+ strlen("refs/"));
330 if (!isupper(*refname
) && *refname
!= '_')
337 static struct ref_entry
*create_ref_entry(const char *refname
,
338 const unsigned char *sha1
, int flag
,
342 struct ref_entry
*ref
;
345 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
346 die("Reference has invalid format: '%s'", refname
);
347 if (!check_name
&& !refname_is_safe(refname
))
348 die("Reference has invalid name: '%s'", refname
);
349 len
= strlen(refname
) + 1;
350 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
351 hashcpy(ref
->u
.value
.sha1
, sha1
);
352 hashclr(ref
->u
.value
.peeled
);
353 memcpy(ref
->name
, refname
, len
);
358 static void clear_ref_dir(struct ref_dir
*dir
);
360 static void free_ref_entry(struct ref_entry
*entry
)
362 if (entry
->flag
& REF_DIR
) {
364 * Do not use get_ref_dir() here, as that might
365 * trigger the reading of loose refs.
367 clear_ref_dir(&entry
->u
.subdir
);
373 * Add a ref_entry to the end of dir (unsorted). Entry is always
374 * stored directly in dir; no recursion into subdirectories is
377 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
379 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
380 dir
->entries
[dir
->nr
++] = entry
;
381 /* optimize for the case that entries are added in order */
383 (dir
->nr
== dir
->sorted
+ 1 &&
384 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
385 dir
->entries
[dir
->nr
- 1]->name
) < 0))
386 dir
->sorted
= dir
->nr
;
390 * Clear and free all entries in dir, recursively.
392 static void clear_ref_dir(struct ref_dir
*dir
)
395 for (i
= 0; i
< dir
->nr
; i
++)
396 free_ref_entry(dir
->entries
[i
]);
398 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
403 * Create a struct ref_entry object for the specified dirname.
404 * dirname is the name of the directory with a trailing slash (e.g.,
405 * "refs/heads/") or "" for the top-level directory.
407 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
408 const char *dirname
, size_t len
,
411 struct ref_entry
*direntry
;
412 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
413 memcpy(direntry
->name
, dirname
, len
);
414 direntry
->name
[len
] = '\0';
415 direntry
->u
.subdir
.ref_cache
= ref_cache
;
416 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
420 static int ref_entry_cmp(const void *a
, const void *b
)
422 struct ref_entry
*one
= *(struct ref_entry
**)a
;
423 struct ref_entry
*two
= *(struct ref_entry
**)b
;
424 return strcmp(one
->name
, two
->name
);
427 static void sort_ref_dir(struct ref_dir
*dir
);
429 struct string_slice
{
434 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
436 const struct string_slice
*key
= key_
;
437 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
438 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
441 return '\0' - (unsigned char)ent
->name
[key
->len
];
445 * Return the index of the entry with the given refname from the
446 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
447 * no such entry is found. dir must already be complete.
449 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
451 struct ref_entry
**r
;
452 struct string_slice key
;
454 if (refname
== NULL
|| !dir
->nr
)
460 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
461 ref_entry_cmp_sslice
);
466 return r
- dir
->entries
;
470 * Search for a directory entry directly within dir (without
471 * recursing). Sort dir if necessary. subdirname must be a directory
472 * name (i.e., end in '/'). If mkdir is set, then create the
473 * directory if it is missing; otherwise, return NULL if the desired
474 * directory cannot be found. dir must already be complete.
476 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
477 const char *subdirname
, size_t len
,
480 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
481 struct ref_entry
*entry
;
482 if (entry_index
== -1) {
486 * Since dir is complete, the absence of a subdir
487 * means that the subdir really doesn't exist;
488 * therefore, create an empty record for it but mark
489 * the record complete.
491 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
492 add_entry_to_dir(dir
, entry
);
494 entry
= dir
->entries
[entry_index
];
496 return get_ref_dir(entry
);
500 * If refname is a reference name, find the ref_dir within the dir
501 * tree that should hold refname. If refname is a directory name
502 * (i.e., ends in '/'), then return that ref_dir itself. dir must
503 * represent the top-level directory and must already be complete.
504 * Sort ref_dirs and recurse into subdirectories as necessary. If
505 * mkdir is set, then create any missing directories; otherwise,
506 * return NULL if the desired directory cannot be found.
508 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
509 const char *refname
, int mkdir
)
512 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
513 size_t dirnamelen
= slash
- refname
+ 1;
514 struct ref_dir
*subdir
;
515 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
527 * Find the value entry with the given name in dir, sorting ref_dirs
528 * and recursing into subdirectories as necessary. If the name is not
529 * found or it corresponds to a directory entry, return NULL.
531 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
534 struct ref_entry
*entry
;
535 dir
= find_containing_dir(dir
, refname
, 0);
538 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
539 if (entry_index
== -1)
541 entry
= dir
->entries
[entry_index
];
542 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
546 * Remove the entry with the given name from dir, recursing into
547 * subdirectories as necessary. If refname is the name of a directory
548 * (i.e., ends with '/'), then remove the directory and its contents.
549 * If the removal was successful, return the number of entries
550 * remaining in the directory entry that contained the deleted entry.
551 * If the name was not found, return -1. Please note that this
552 * function only deletes the entry from the cache; it does not delete
553 * it from the filesystem or ensure that other cache entries (which
554 * might be symbolic references to the removed entry) are updated.
555 * Nor does it remove any containing dir entries that might be made
556 * empty by the removal. dir must represent the top-level directory
557 * and must already be complete.
559 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
561 int refname_len
= strlen(refname
);
563 struct ref_entry
*entry
;
564 int is_dir
= refname
[refname_len
- 1] == '/';
567 * refname represents a reference directory. Remove
568 * the trailing slash; otherwise we will get the
569 * directory *representing* refname rather than the
570 * one *containing* it.
572 char *dirname
= xmemdupz(refname
, refname_len
- 1);
573 dir
= find_containing_dir(dir
, dirname
, 0);
576 dir
= find_containing_dir(dir
, refname
, 0);
580 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
581 if (entry_index
== -1)
583 entry
= dir
->entries
[entry_index
];
585 memmove(&dir
->entries
[entry_index
],
586 &dir
->entries
[entry_index
+ 1],
587 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
590 if (dir
->sorted
> entry_index
)
592 free_ref_entry(entry
);
597 * Add a ref_entry to the ref_dir (unsorted), recursing into
598 * subdirectories as necessary. dir must represent the top-level
599 * directory. Return 0 on success.
601 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
603 dir
= find_containing_dir(dir
, ref
->name
, 1);
606 add_entry_to_dir(dir
, ref
);
611 * Emit a warning and return true iff ref1 and ref2 have the same name
612 * and the same sha1. Die if they have the same name but different
615 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
617 if (strcmp(ref1
->name
, ref2
->name
))
620 /* Duplicate name; make sure that they don't conflict: */
622 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
623 /* This is impossible by construction */
624 die("Reference directory conflict: %s", ref1
->name
);
626 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
627 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
629 warning("Duplicated ref: %s", ref1
->name
);
634 * Sort the entries in dir non-recursively (if they are not already
635 * sorted) and remove any duplicate entries.
637 static void sort_ref_dir(struct ref_dir
*dir
)
640 struct ref_entry
*last
= NULL
;
643 * This check also prevents passing a zero-length array to qsort(),
644 * which is a problem on some platforms.
646 if (dir
->sorted
== dir
->nr
)
649 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
651 /* Remove any duplicates: */
652 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
653 struct ref_entry
*entry
= dir
->entries
[j
];
654 if (last
&& is_dup_ref(last
, entry
))
655 free_ref_entry(entry
);
657 last
= dir
->entries
[i
++] = entry
;
659 dir
->sorted
= dir
->nr
= i
;
662 /* Include broken references in a do_for_each_ref*() iteration: */
663 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
666 * Return true iff the reference described by entry can be resolved to
667 * an object in the database. Emit a warning if the referred-to
668 * object does not exist.
670 static int ref_resolves_to_object(struct ref_entry
*entry
)
672 if (entry
->flag
& REF_ISBROKEN
)
674 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
675 error("%s does not point to a valid object!", entry
->name
);
682 * current_ref is a performance hack: when iterating over references
683 * using the for_each_ref*() functions, current_ref is set to the
684 * current reference's entry before calling the callback function. If
685 * the callback function calls peel_ref(), then peel_ref() first
686 * checks whether the reference to be peeled is the current reference
687 * (it usually is) and if so, returns that reference's peeled version
688 * if it is available. This avoids a refname lookup in a common case.
690 static struct ref_entry
*current_ref
;
692 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
694 struct ref_entry_cb
{
703 * Handle one reference in a do_for_each_ref*()-style iteration,
704 * calling an each_ref_fn for each entry.
706 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
708 struct ref_entry_cb
*data
= cb_data
;
709 struct ref_entry
*old_current_ref
;
712 if (!starts_with(entry
->name
, data
->base
))
715 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
716 !ref_resolves_to_object(entry
))
719 /* Store the old value, in case this is a recursive call: */
720 old_current_ref
= current_ref
;
722 retval
= data
->fn(entry
->name
+ data
->trim
, entry
->u
.value
.sha1
,
723 entry
->flag
, data
->cb_data
);
724 current_ref
= old_current_ref
;
729 * Call fn for each reference in dir that has index in the range
730 * offset <= index < dir->nr. Recurse into subdirectories that are in
731 * that index range, sorting them before iterating. This function
732 * does not sort dir itself; it should be sorted beforehand. fn is
733 * called for all references, including broken ones.
735 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
736 each_ref_entry_fn fn
, void *cb_data
)
739 assert(dir
->sorted
== dir
->nr
);
740 for (i
= offset
; i
< dir
->nr
; i
++) {
741 struct ref_entry
*entry
= dir
->entries
[i
];
743 if (entry
->flag
& REF_DIR
) {
744 struct ref_dir
*subdir
= get_ref_dir(entry
);
745 sort_ref_dir(subdir
);
746 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
748 retval
= fn(entry
, cb_data
);
757 * Call fn for each reference in the union of dir1 and dir2, in order
758 * by refname. Recurse into subdirectories. If a value entry appears
759 * in both dir1 and dir2, then only process the version that is in
760 * dir2. The input dirs must already be sorted, but subdirs will be
761 * sorted as needed. fn is called for all references, including
764 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
765 struct ref_dir
*dir2
,
766 each_ref_entry_fn fn
, void *cb_data
)
771 assert(dir1
->sorted
== dir1
->nr
);
772 assert(dir2
->sorted
== dir2
->nr
);
774 struct ref_entry
*e1
, *e2
;
776 if (i1
== dir1
->nr
) {
777 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
779 if (i2
== dir2
->nr
) {
780 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
782 e1
= dir1
->entries
[i1
];
783 e2
= dir2
->entries
[i2
];
784 cmp
= strcmp(e1
->name
, e2
->name
);
786 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
787 /* Both are directories; descend them in parallel. */
788 struct ref_dir
*subdir1
= get_ref_dir(e1
);
789 struct ref_dir
*subdir2
= get_ref_dir(e2
);
790 sort_ref_dir(subdir1
);
791 sort_ref_dir(subdir2
);
792 retval
= do_for_each_entry_in_dirs(
793 subdir1
, subdir2
, fn
, cb_data
);
796 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
797 /* Both are references; ignore the one from dir1. */
798 retval
= fn(e2
, cb_data
);
802 die("conflict between reference and directory: %s",
814 if (e
->flag
& REF_DIR
) {
815 struct ref_dir
*subdir
= get_ref_dir(e
);
816 sort_ref_dir(subdir
);
817 retval
= do_for_each_entry_in_dir(
818 subdir
, 0, fn
, cb_data
);
820 retval
= fn(e
, cb_data
);
829 * Load all of the refs from the dir into our in-memory cache. The hard work
830 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
831 * through all of the sub-directories. We do not even need to care about
832 * sorting, as traversal order does not matter to us.
834 static void prime_ref_dir(struct ref_dir
*dir
)
837 for (i
= 0; i
< dir
->nr
; i
++) {
838 struct ref_entry
*entry
= dir
->entries
[i
];
839 if (entry
->flag
& REF_DIR
)
840 prime_ref_dir(get_ref_dir(entry
));
844 struct nonmatching_ref_data
{
845 const struct string_list
*skip
;
846 const char *conflicting_refname
;
849 static int nonmatching_ref_fn(struct ref_entry
*entry
, void *vdata
)
851 struct nonmatching_ref_data
*data
= vdata
;
853 if (data
->skip
&& string_list_has_string(data
->skip
, entry
->name
))
856 data
->conflicting_refname
= entry
->name
;
861 * Return true iff a reference named refname could be created without
862 * conflicting with the name of an existing reference in dir. If
863 * extras is non-NULL, it is a list of additional refnames with which
864 * refname is not allowed to conflict. If skip is non-NULL, ignore
865 * potential conflicts with refs in skip (e.g., because they are
866 * scheduled for deletion in the same operation). Behavior is
867 * undefined if the same name is listed in both extras and skip.
869 * Two reference names conflict if one of them exactly matches the
870 * leading components of the other; e.g., "refs/foo/bar" conflicts
871 * with both "refs/foo" and with "refs/foo/bar/baz" but not with
872 * "refs/foo/bar" or "refs/foo/barbados".
874 * extras and skip must be sorted.
876 static int is_refname_available(const char *refname
,
877 const struct string_list
*extras
,
878 const struct string_list
*skip
,
883 struct strbuf dirname
= STRBUF_INIT
;
887 * For the sake of comments in this function, suppose that
888 * refname is "refs/foo/bar".
891 strbuf_grow(&dirname
, strlen(refname
) + 1);
892 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
893 /* Expand dirname to the new prefix, not including the trailing slash: */
894 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
897 * We are still at a leading dir of the refname (e.g.,
898 * "refs/foo"; if there is a reference with that name,
899 * it is a conflict, *unless* it is in skip.
902 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
904 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
906 * We found a reference whose name is
907 * a proper prefix of refname; e.g.,
908 * "refs/foo", and is not in skip.
910 error("'%s' exists; cannot create '%s'",
911 dirname
.buf
, refname
);
916 if (extras
&& string_list_has_string(extras
, dirname
.buf
) &&
917 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
918 error("cannot process '%s' and '%s' at the same time",
919 refname
, dirname
.buf
);
924 * Otherwise, we can try to continue our search with
925 * the next component. So try to look up the
926 * directory, e.g., "refs/foo/". If we come up empty,
927 * we know there is nothing under this whole prefix,
928 * but even in that case we still have to continue the
929 * search for conflicts with extras.
931 strbuf_addch(&dirname
, '/');
933 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
936 * There was no directory "refs/foo/",
937 * so there is nothing under this
938 * whole prefix. So there is no need
939 * to continue looking for conflicting
940 * references. But we need to continue
941 * looking for conflicting extras.
945 dir
= get_ref_dir(dir
->entries
[pos
]);
951 * We are at the leaf of our refname (e.g., "refs/foo/bar").
952 * There is no point in searching for a reference with that
953 * name, because a refname isn't considered to conflict with
954 * itself. But we still need to check for references whose
955 * names are in the "refs/foo/bar/" namespace, because they
958 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
959 strbuf_addch(&dirname
, '/');
962 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
966 * We found a directory named "$refname/"
967 * (e.g., "refs/foo/bar/"). It is a problem
968 * iff it contains any ref that is not in
971 struct nonmatching_ref_data data
;
974 data
.conflicting_refname
= NULL
;
975 dir
= get_ref_dir(dir
->entries
[pos
]);
977 if (do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
)) {
978 error("'%s' exists; cannot create '%s'",
979 data
.conflicting_refname
, refname
);
987 * Check for entries in extras that start with
988 * "$refname/". We do that by looking for the place
989 * where "$refname/" would be inserted in extras. If
990 * there is an entry at that position that starts with
991 * "$refname/" and is not in skip, then we have a
994 for (pos
= string_list_find_insert_index(extras
, dirname
.buf
, 0);
995 pos
< extras
->nr
; pos
++) {
996 const char *extra_refname
= extras
->items
[pos
].string
;
998 if (!starts_with(extra_refname
, dirname
.buf
))
1001 if (!skip
|| !string_list_has_string(skip
, extra_refname
)) {
1002 error("cannot process '%s' and '%s' at the same time",
1003 refname
, extra_refname
);
1009 /* No conflicts were found */
1013 strbuf_release(&dirname
);
1017 struct packed_ref_cache
{
1018 struct ref_entry
*root
;
1021 * Count of references to the data structure in this instance,
1022 * including the pointer from ref_cache::packed if any. The
1023 * data will not be freed as long as the reference count is
1026 unsigned int referrers
;
1029 * Iff the packed-refs file associated with this instance is
1030 * currently locked for writing, this points at the associated
1031 * lock (which is owned by somebody else). The referrer count
1032 * is also incremented when the file is locked and decremented
1033 * when it is unlocked.
1035 struct lock_file
*lock
;
1037 /* The metadata from when this packed-refs cache was read */
1038 struct stat_validity validity
;
1042 * Future: need to be in "struct repository"
1043 * when doing a full libification.
1045 static struct ref_cache
{
1046 struct ref_cache
*next
;
1047 struct ref_entry
*loose
;
1048 struct packed_ref_cache
*packed
;
1050 * The submodule name, or "" for the main repo. We allocate
1051 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1052 * is initialized correctly.
1055 } ref_cache
, *submodule_ref_caches
;
1057 /* Lock used for the main packed-refs file: */
1058 static struct lock_file packlock
;
1061 * Increment the reference count of *packed_refs.
1063 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1065 packed_refs
->referrers
++;
1069 * Decrease the reference count of *packed_refs. If it goes to zero,
1070 * free *packed_refs and return true; otherwise return false.
1072 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1074 if (!--packed_refs
->referrers
) {
1075 free_ref_entry(packed_refs
->root
);
1076 stat_validity_clear(&packed_refs
->validity
);
1084 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1087 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1089 if (packed_refs
->lock
)
1090 die("internal error: packed-ref cache cleared while locked");
1091 refs
->packed
= NULL
;
1092 release_packed_ref_cache(packed_refs
);
1096 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1099 free_ref_entry(refs
->loose
);
1104 static struct ref_cache
*create_ref_cache(const char *submodule
)
1107 struct ref_cache
*refs
;
1110 len
= strlen(submodule
) + 1;
1111 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1112 memcpy(refs
->name
, submodule
, len
);
1117 * Return a pointer to a ref_cache for the specified submodule. For
1118 * the main repository, use submodule==NULL. The returned structure
1119 * will be allocated and initialized but not necessarily populated; it
1120 * should not be freed.
1122 static struct ref_cache
*get_ref_cache(const char *submodule
)
1124 struct ref_cache
*refs
;
1126 if (!submodule
|| !*submodule
)
1129 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1130 if (!strcmp(submodule
, refs
->name
))
1133 refs
= create_ref_cache(submodule
);
1134 refs
->next
= submodule_ref_caches
;
1135 submodule_ref_caches
= refs
;
1139 /* The length of a peeled reference line in packed-refs, including EOL: */
1140 #define PEELED_LINE_LENGTH 42
1143 * The packed-refs header line that we write out. Perhaps other
1144 * traits will be added later. The trailing space is required.
1146 static const char PACKED_REFS_HEADER
[] =
1147 "# pack-refs with: peeled fully-peeled \n";
1150 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1151 * Return a pointer to the refname within the line (null-terminated),
1152 * or NULL if there was a problem.
1154 static const char *parse_ref_line(struct strbuf
*line
, unsigned char *sha1
)
1159 * 42: the answer to everything.
1161 * In this case, it happens to be the answer to
1162 * 40 (length of sha1 hex representation)
1163 * +1 (space in between hex and name)
1164 * +1 (newline at the end of the line)
1166 if (line
->len
<= 42)
1169 if (get_sha1_hex(line
->buf
, sha1
) < 0)
1171 if (!isspace(line
->buf
[40]))
1174 ref
= line
->buf
+ 41;
1178 if (line
->buf
[line
->len
- 1] != '\n')
1180 line
->buf
[--line
->len
] = 0;
1186 * Read f, which is a packed-refs file, into dir.
1188 * A comment line of the form "# pack-refs with: " may contain zero or
1189 * more traits. We interpret the traits as follows:
1193 * Probably no references are peeled. But if the file contains a
1194 * peeled value for a reference, we will use it.
1198 * References under "refs/tags/", if they *can* be peeled, *are*
1199 * peeled in this file. References outside of "refs/tags/" are
1200 * probably not peeled even if they could have been, but if we find
1201 * a peeled value for such a reference we will use it.
1205 * All references in the file that can be peeled are peeled.
1206 * Inversely (and this is more important), any references in the
1207 * file for which no peeled value is recorded is not peelable. This
1208 * trait should typically be written alongside "peeled" for
1209 * compatibility with older clients, but we do not require it
1210 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1212 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1214 struct ref_entry
*last
= NULL
;
1215 struct strbuf line
= STRBUF_INIT
;
1216 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1218 while (strbuf_getwholeline(&line
, f
, '\n') != EOF
) {
1219 unsigned char sha1
[20];
1220 const char *refname
;
1223 if (skip_prefix(line
.buf
, "# pack-refs with:", &traits
)) {
1224 if (strstr(traits
, " fully-peeled "))
1225 peeled
= PEELED_FULLY
;
1226 else if (strstr(traits
, " peeled "))
1227 peeled
= PEELED_TAGS
;
1228 /* perhaps other traits later as well */
1232 refname
= parse_ref_line(&line
, sha1
);
1234 int flag
= REF_ISPACKED
;
1236 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1238 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1240 last
= create_ref_entry(refname
, sha1
, flag
, 0);
1241 if (peeled
== PEELED_FULLY
||
1242 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1243 last
->flag
|= REF_KNOWS_PEELED
;
1248 line
.buf
[0] == '^' &&
1249 line
.len
== PEELED_LINE_LENGTH
&&
1250 line
.buf
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1251 !get_sha1_hex(line
.buf
+ 1, sha1
)) {
1252 hashcpy(last
->u
.value
.peeled
, sha1
);
1254 * Regardless of what the file header said,
1255 * we definitely know the value of *this*
1258 last
->flag
|= REF_KNOWS_PEELED
;
1262 strbuf_release(&line
);
1266 * Get the packed_ref_cache for the specified ref_cache, creating it
1269 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1271 const char *packed_refs_file
;
1274 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1276 packed_refs_file
= git_path("packed-refs");
1279 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1280 clear_packed_ref_cache(refs
);
1282 if (!refs
->packed
) {
1285 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1286 acquire_packed_ref_cache(refs
->packed
);
1287 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1288 f
= fopen(packed_refs_file
, "r");
1290 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1291 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1295 return refs
->packed
;
1298 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1300 return get_ref_dir(packed_ref_cache
->root
);
1303 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1305 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1308 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1310 struct packed_ref_cache
*packed_ref_cache
=
1311 get_packed_ref_cache(&ref_cache
);
1313 if (!packed_ref_cache
->lock
)
1314 die("internal error: packed refs not locked");
1315 add_ref(get_packed_ref_dir(packed_ref_cache
),
1316 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1320 * Read the loose references from the namespace dirname into dir
1321 * (without recursing). dirname must end with '/'. dir must be the
1322 * directory entry corresponding to dirname.
1324 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1326 struct ref_cache
*refs
= dir
->ref_cache
;
1330 int dirnamelen
= strlen(dirname
);
1331 struct strbuf refname
;
1334 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1336 path
= git_path("%s", dirname
);
1342 strbuf_init(&refname
, dirnamelen
+ 257);
1343 strbuf_add(&refname
, dirname
, dirnamelen
);
1345 while ((de
= readdir(d
)) != NULL
) {
1346 unsigned char sha1
[20];
1351 if (de
->d_name
[0] == '.')
1353 if (ends_with(de
->d_name
, ".lock"))
1355 strbuf_addstr(&refname
, de
->d_name
);
1356 refdir
= *refs
->name
1357 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1358 : git_path("%s", refname
.buf
);
1359 if (stat(refdir
, &st
) < 0) {
1360 ; /* silently ignore */
1361 } else if (S_ISDIR(st
.st_mode
)) {
1362 strbuf_addch(&refname
, '/');
1363 add_entry_to_dir(dir
,
1364 create_dir_entry(refs
, refname
.buf
,
1370 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
1372 flag
|= REF_ISBROKEN
;
1374 } else if (read_ref_full(refname
.buf
,
1375 RESOLVE_REF_READING
,
1378 flag
|= REF_ISBROKEN
;
1380 if (check_refname_format(refname
.buf
,
1381 REFNAME_ALLOW_ONELEVEL
)) {
1383 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1385 add_entry_to_dir(dir
,
1386 create_ref_entry(refname
.buf
, sha1
, flag
, 0));
1388 strbuf_setlen(&refname
, dirnamelen
);
1390 strbuf_release(&refname
);
1394 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1398 * Mark the top-level directory complete because we
1399 * are about to read the only subdirectory that can
1402 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1404 * Create an incomplete entry for "refs/":
1406 add_entry_to_dir(get_ref_dir(refs
->loose
),
1407 create_dir_entry(refs
, "refs/", 5, 1));
1409 return get_ref_dir(refs
->loose
);
1412 /* We allow "recursive" symbolic refs. Only within reason, though */
1414 #define MAXREFLEN (1024)
1417 * Called by resolve_gitlink_ref_recursive() after it failed to read
1418 * from the loose refs in ref_cache refs. Find <refname> in the
1419 * packed-refs file for the submodule.
1421 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1422 const char *refname
, unsigned char *sha1
)
1424 struct ref_entry
*ref
;
1425 struct ref_dir
*dir
= get_packed_refs(refs
);
1427 ref
= find_ref(dir
, refname
);
1431 hashcpy(sha1
, ref
->u
.value
.sha1
);
1435 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1436 const char *refname
, unsigned char *sha1
,
1440 char buffer
[128], *p
;
1443 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1446 ? git_path_submodule(refs
->name
, "%s", refname
)
1447 : git_path("%s", refname
);
1448 fd
= open(path
, O_RDONLY
);
1450 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1452 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1456 while (len
&& isspace(buffer
[len
-1]))
1460 /* Was it a detached head or an old-fashioned symlink? */
1461 if (!get_sha1_hex(buffer
, sha1
))
1465 if (strncmp(buffer
, "ref:", 4))
1471 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1474 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1476 int len
= strlen(path
), retval
;
1478 struct ref_cache
*refs
;
1480 while (len
&& path
[len
-1] == '/')
1484 submodule
= xstrndup(path
, len
);
1485 refs
= get_ref_cache(submodule
);
1488 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1493 * Return the ref_entry for the given refname from the packed
1494 * references. If it does not exist, return NULL.
1496 static struct ref_entry
*get_packed_ref(const char *refname
)
1498 return find_ref(get_packed_refs(&ref_cache
), refname
);
1502 * A loose ref file doesn't exist; check for a packed ref. The
1503 * options are forwarded from resolve_safe_unsafe().
1505 static int resolve_missing_loose_ref(const char *refname
,
1507 unsigned char *sha1
,
1510 struct ref_entry
*entry
;
1513 * The loose reference file does not exist; check for a packed
1516 entry
= get_packed_ref(refname
);
1518 hashcpy(sha1
, entry
->u
.value
.sha1
);
1520 *flags
|= REF_ISPACKED
;
1523 /* The reference is not a packed reference, either. */
1524 if (resolve_flags
& RESOLVE_REF_READING
) {
1533 /* This function needs to return a meaningful errno on failure */
1534 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1536 int depth
= MAXDEPTH
;
1539 static char refname_buffer
[256];
1545 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1547 *flags
|= REF_BAD_NAME
;
1549 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1550 !refname_is_safe(refname
)) {
1555 * dwim_ref() uses REF_ISBROKEN to distinguish between
1556 * missing refs and refs that were present but invalid,
1557 * to complain about the latter to stderr.
1559 * We don't know whether the ref exists, so don't set
1565 char path
[PATH_MAX
];
1575 git_snpath(path
, sizeof(path
), "%s", refname
);
1578 * We might have to loop back here to avoid a race
1579 * condition: first we lstat() the file, then we try
1580 * to read it as a link or as a file. But if somebody
1581 * changes the type of the file (file <-> directory
1582 * <-> symlink) between the lstat() and reading, then
1583 * we don't want to report that as an error but rather
1584 * try again starting with the lstat().
1587 if (lstat(path
, &st
) < 0) {
1588 if (errno
!= ENOENT
)
1590 if (resolve_missing_loose_ref(refname
, resolve_flags
,
1596 *flags
|= REF_ISBROKEN
;
1601 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1602 if (S_ISLNK(st
.st_mode
)) {
1603 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1605 if (errno
== ENOENT
|| errno
== EINVAL
)
1606 /* inconsistent with lstat; retry */
1612 if (starts_with(buffer
, "refs/") &&
1613 !check_refname_format(buffer
, 0)) {
1614 strcpy(refname_buffer
, buffer
);
1615 refname
= refname_buffer
;
1617 *flags
|= REF_ISSYMREF
;
1618 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1626 /* Is it a directory? */
1627 if (S_ISDIR(st
.st_mode
)) {
1633 * Anything else, just open it and try to use it as
1636 fd
= open(path
, O_RDONLY
);
1638 if (errno
== ENOENT
)
1639 /* inconsistent with lstat; retry */
1644 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1646 int save_errno
= errno
;
1652 while (len
&& isspace(buffer
[len
-1]))
1657 * Is it a symbolic ref?
1659 if (!starts_with(buffer
, "ref:")) {
1661 * Please note that FETCH_HEAD has a second
1662 * line containing other data.
1664 if (get_sha1_hex(buffer
, sha1
) ||
1665 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1667 *flags
|= REF_ISBROKEN
;
1674 *flags
|= REF_ISBROKEN
;
1679 *flags
|= REF_ISSYMREF
;
1681 while (isspace(*buf
))
1683 refname
= strcpy(refname_buffer
, buf
);
1684 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1688 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1690 *flags
|= REF_ISBROKEN
;
1692 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1693 !refname_is_safe(buf
)) {
1702 char *resolve_refdup(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1704 return xstrdup_or_null(resolve_ref_unsafe(ref
, resolve_flags
, sha1
, flags
));
1707 /* The argument to filter_refs */
1709 const char *pattern
;
1714 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1716 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1721 int read_ref(const char *refname
, unsigned char *sha1
)
1723 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1726 int ref_exists(const char *refname
)
1728 unsigned char sha1
[20];
1729 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1732 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1735 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1736 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1738 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1742 /* object was peeled successfully: */
1746 * object cannot be peeled because the named object (or an
1747 * object referred to by a tag in the peel chain), does not
1752 /* object cannot be peeled because it is not a tag: */
1755 /* ref_entry contains no peeled value because it is a symref: */
1756 PEEL_IS_SYMREF
= -3,
1759 * ref_entry cannot be peeled because it is broken (i.e., the
1760 * symbolic reference cannot even be resolved to an object
1767 * Peel the named object; i.e., if the object is a tag, resolve the
1768 * tag recursively until a non-tag is found. If successful, store the
1769 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1770 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1771 * and leave sha1 unchanged.
1773 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1775 struct object
*o
= lookup_unknown_object(name
);
1777 if (o
->type
== OBJ_NONE
) {
1778 int type
= sha1_object_info(name
, NULL
);
1779 if (type
< 0 || !object_as_type(o
, type
, 0))
1780 return PEEL_INVALID
;
1783 if (o
->type
!= OBJ_TAG
)
1784 return PEEL_NON_TAG
;
1786 o
= deref_tag_noverify(o
);
1788 return PEEL_INVALID
;
1790 hashcpy(sha1
, o
->sha1
);
1795 * Peel the entry (if possible) and return its new peel_status. If
1796 * repeel is true, re-peel the entry even if there is an old peeled
1797 * value that is already stored in it.
1799 * It is OK to call this function with a packed reference entry that
1800 * might be stale and might even refer to an object that has since
1801 * been garbage-collected. In such a case, if the entry has
1802 * REF_KNOWS_PEELED then leave the status unchanged and return
1803 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1805 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1807 enum peel_status status
;
1809 if (entry
->flag
& REF_KNOWS_PEELED
) {
1811 entry
->flag
&= ~REF_KNOWS_PEELED
;
1812 hashclr(entry
->u
.value
.peeled
);
1814 return is_null_sha1(entry
->u
.value
.peeled
) ?
1815 PEEL_NON_TAG
: PEEL_PEELED
;
1818 if (entry
->flag
& REF_ISBROKEN
)
1820 if (entry
->flag
& REF_ISSYMREF
)
1821 return PEEL_IS_SYMREF
;
1823 status
= peel_object(entry
->u
.value
.sha1
, entry
->u
.value
.peeled
);
1824 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1825 entry
->flag
|= REF_KNOWS_PEELED
;
1829 int peel_ref(const char *refname
, unsigned char *sha1
)
1832 unsigned char base
[20];
1834 if (current_ref
&& (current_ref
->name
== refname
1835 || !strcmp(current_ref
->name
, refname
))) {
1836 if (peel_entry(current_ref
, 0))
1838 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1842 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1846 * If the reference is packed, read its ref_entry from the
1847 * cache in the hope that we already know its peeled value.
1848 * We only try this optimization on packed references because
1849 * (a) forcing the filling of the loose reference cache could
1850 * be expensive and (b) loose references anyway usually do not
1851 * have REF_KNOWS_PEELED.
1853 if (flag
& REF_ISPACKED
) {
1854 struct ref_entry
*r
= get_packed_ref(refname
);
1856 if (peel_entry(r
, 0))
1858 hashcpy(sha1
, r
->u
.value
.peeled
);
1863 return peel_object(base
, sha1
);
1866 struct warn_if_dangling_data
{
1868 const char *refname
;
1869 const struct string_list
*refnames
;
1870 const char *msg_fmt
;
1873 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1874 int flags
, void *cb_data
)
1876 struct warn_if_dangling_data
*d
= cb_data
;
1877 const char *resolves_to
;
1878 unsigned char junk
[20];
1880 if (!(flags
& REF_ISSYMREF
))
1883 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
, NULL
);
1886 ? strcmp(resolves_to
, d
->refname
)
1887 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1891 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1896 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1898 struct warn_if_dangling_data data
;
1901 data
.refname
= refname
;
1902 data
.refnames
= NULL
;
1903 data
.msg_fmt
= msg_fmt
;
1904 for_each_rawref(warn_if_dangling_symref
, &data
);
1907 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1909 struct warn_if_dangling_data data
;
1912 data
.refname
= NULL
;
1913 data
.refnames
= refnames
;
1914 data
.msg_fmt
= msg_fmt
;
1915 for_each_rawref(warn_if_dangling_symref
, &data
);
1919 * Call fn for each reference in the specified ref_cache, omitting
1920 * references not in the containing_dir of base. fn is called for all
1921 * references, including broken ones. If fn ever returns a non-zero
1922 * value, stop the iteration and return that value; otherwise, return
1925 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1926 each_ref_entry_fn fn
, void *cb_data
)
1928 struct packed_ref_cache
*packed_ref_cache
;
1929 struct ref_dir
*loose_dir
;
1930 struct ref_dir
*packed_dir
;
1934 * We must make sure that all loose refs are read before accessing the
1935 * packed-refs file; this avoids a race condition in which loose refs
1936 * are migrated to the packed-refs file by a simultaneous process, but
1937 * our in-memory view is from before the migration. get_packed_ref_cache()
1938 * takes care of making sure our view is up to date with what is on
1941 loose_dir
= get_loose_refs(refs
);
1942 if (base
&& *base
) {
1943 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1946 prime_ref_dir(loose_dir
);
1948 packed_ref_cache
= get_packed_ref_cache(refs
);
1949 acquire_packed_ref_cache(packed_ref_cache
);
1950 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1951 if (base
&& *base
) {
1952 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1955 if (packed_dir
&& loose_dir
) {
1956 sort_ref_dir(packed_dir
);
1957 sort_ref_dir(loose_dir
);
1958 retval
= do_for_each_entry_in_dirs(
1959 packed_dir
, loose_dir
, fn
, cb_data
);
1960 } else if (packed_dir
) {
1961 sort_ref_dir(packed_dir
);
1962 retval
= do_for_each_entry_in_dir(
1963 packed_dir
, 0, fn
, cb_data
);
1964 } else if (loose_dir
) {
1965 sort_ref_dir(loose_dir
);
1966 retval
= do_for_each_entry_in_dir(
1967 loose_dir
, 0, fn
, cb_data
);
1970 release_packed_ref_cache(packed_ref_cache
);
1975 * Call fn for each reference in the specified ref_cache for which the
1976 * refname begins with base. If trim is non-zero, then trim that many
1977 * characters off the beginning of each refname before passing the
1978 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1979 * broken references in the iteration. If fn ever returns a non-zero
1980 * value, stop the iteration and return that value; otherwise, return
1983 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
1984 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1986 struct ref_entry_cb data
;
1991 data
.cb_data
= cb_data
;
1993 if (ref_paranoia
< 0)
1994 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1996 data
.flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1998 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
2001 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2003 unsigned char sha1
[20];
2007 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
2008 return fn("HEAD", sha1
, 0, cb_data
);
2013 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, sha1
, &flag
))
2014 return fn("HEAD", sha1
, flag
, cb_data
);
2019 int head_ref(each_ref_fn fn
, void *cb_data
)
2021 return do_head_ref(NULL
, fn
, cb_data
);
2024 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2026 return do_head_ref(submodule
, fn
, cb_data
);
2029 int for_each_ref(each_ref_fn fn
, void *cb_data
)
2031 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
2034 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2036 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
2039 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
2041 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
2044 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
2045 each_ref_fn fn
, void *cb_data
)
2047 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
2050 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
2052 return for_each_ref_in("refs/tags/", fn
, cb_data
);
2055 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2057 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
2060 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
2062 return for_each_ref_in("refs/heads/", fn
, cb_data
);
2065 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2067 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2070 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2072 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2075 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2077 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2080 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2082 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
2085 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2087 struct strbuf buf
= STRBUF_INIT
;
2089 unsigned char sha1
[20];
2092 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2093 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, sha1
, &flag
))
2094 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
2095 strbuf_release(&buf
);
2100 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2102 struct strbuf buf
= STRBUF_INIT
;
2104 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2105 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2106 strbuf_release(&buf
);
2110 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2111 const char *prefix
, void *cb_data
)
2113 struct strbuf real_pattern
= STRBUF_INIT
;
2114 struct ref_filter filter
;
2117 if (!prefix
&& !starts_with(pattern
, "refs/"))
2118 strbuf_addstr(&real_pattern
, "refs/");
2120 strbuf_addstr(&real_pattern
, prefix
);
2121 strbuf_addstr(&real_pattern
, pattern
);
2123 if (!has_glob_specials(pattern
)) {
2124 /* Append implied '/' '*' if not present. */
2125 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2126 strbuf_addch(&real_pattern
, '/');
2127 /* No need to check for '*', there is none. */
2128 strbuf_addch(&real_pattern
, '*');
2131 filter
.pattern
= real_pattern
.buf
;
2133 filter
.cb_data
= cb_data
;
2134 ret
= for_each_ref(filter_refs
, &filter
);
2136 strbuf_release(&real_pattern
);
2140 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2142 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2145 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2147 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2148 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2151 const char *prettify_refname(const char *name
)
2154 starts_with(name
, "refs/heads/") ? 11 :
2155 starts_with(name
, "refs/tags/") ? 10 :
2156 starts_with(name
, "refs/remotes/") ? 13 :
2160 static const char *ref_rev_parse_rules
[] = {
2165 "refs/remotes/%.*s",
2166 "refs/remotes/%.*s/HEAD",
2170 int refname_match(const char *abbrev_name
, const char *full_name
)
2173 const int abbrev_name_len
= strlen(abbrev_name
);
2175 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2176 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2184 static void unlock_ref(struct ref_lock
*lock
)
2186 /* Do not free lock->lk -- atexit() still looks at them */
2188 rollback_lock_file(lock
->lk
);
2189 free(lock
->ref_name
);
2190 free(lock
->orig_ref_name
);
2194 /* This function should make sure errno is meaningful on error */
2195 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
2196 const unsigned char *old_sha1
, int mustexist
)
2198 if (read_ref_full(lock
->ref_name
,
2199 mustexist
? RESOLVE_REF_READING
: 0,
2200 lock
->old_sha1
, NULL
)) {
2201 int save_errno
= errno
;
2202 error("Can't verify ref %s", lock
->ref_name
);
2207 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
2208 error("Ref %s is at %s but expected %s", lock
->ref_name
,
2209 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
2217 static int remove_empty_directories(const char *file
)
2219 /* we want to create a file but there is a directory there;
2220 * if that is an empty directory (or a directory that contains
2221 * only empty directories), remove them.
2224 int result
, save_errno
;
2226 strbuf_init(&path
, 20);
2227 strbuf_addstr(&path
, file
);
2229 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2232 strbuf_release(&path
);
2239 * *string and *len will only be substituted, and *string returned (for
2240 * later free()ing) if the string passed in is a magic short-hand form
2243 static char *substitute_branch_name(const char **string
, int *len
)
2245 struct strbuf buf
= STRBUF_INIT
;
2246 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2250 *string
= strbuf_detach(&buf
, &size
);
2252 return (char *)*string
;
2258 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2260 char *last_branch
= substitute_branch_name(&str
, &len
);
2265 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2266 char fullref
[PATH_MAX
];
2267 unsigned char sha1_from_ref
[20];
2268 unsigned char *this_result
;
2271 this_result
= refs_found
? sha1_from_ref
: sha1
;
2272 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2273 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2274 this_result
, &flag
);
2278 if (!warn_ambiguous_refs
)
2280 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2281 warning("ignoring dangling symref %s.", fullref
);
2282 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2283 warning("ignoring broken ref %s.", fullref
);
2290 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2292 char *last_branch
= substitute_branch_name(&str
, &len
);
2297 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2298 unsigned char hash
[20];
2299 char path
[PATH_MAX
];
2300 const char *ref
, *it
;
2302 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2303 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2307 if (reflog_exists(path
))
2309 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2313 if (!logs_found
++) {
2315 hashcpy(sha1
, hash
);
2317 if (!warn_ambiguous_refs
)
2325 * Locks a ref returning the lock on success and NULL on failure.
2326 * On failure errno is set to something meaningful.
2328 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2329 const unsigned char *old_sha1
,
2330 const struct string_list
*extras
,
2331 const struct string_list
*skip
,
2332 unsigned int flags
, int *type_p
)
2335 const char *orig_refname
= refname
;
2336 struct ref_lock
*lock
;
2339 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2340 int resolve_flags
= 0;
2341 int attempts_remaining
= 3;
2343 lock
= xcalloc(1, sizeof(struct ref_lock
));
2347 resolve_flags
|= RESOLVE_REF_READING
;
2348 if (flags
& REF_DELETING
) {
2349 resolve_flags
|= RESOLVE_REF_ALLOW_BAD_NAME
;
2350 if (flags
& REF_NODEREF
)
2351 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2354 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2355 lock
->old_sha1
, &type
);
2356 if (!refname
&& errno
== EISDIR
) {
2357 /* we are trying to lock foo but we used to
2358 * have foo/bar which now does not exist;
2359 * it is normal for the empty directory 'foo'
2362 ref_file
= git_path("%s", orig_refname
);
2363 if (remove_empty_directories(ref_file
)) {
2365 error("there are still refs under '%s'", orig_refname
);
2368 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2369 lock
->old_sha1
, &type
);
2375 error("unable to resolve reference %s: %s",
2376 orig_refname
, strerror(errno
));
2380 * If the ref did not exist and we are creating it, make sure
2381 * there is no existing packed ref whose name begins with our
2382 * refname, nor a packed ref whose name is a proper prefix of
2385 if (is_null_sha1(lock
->old_sha1
) &&
2386 !is_refname_available(refname
, extras
, skip
, get_packed_refs(&ref_cache
))) {
2387 last_errno
= ENOTDIR
;
2391 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2394 if (flags
& REF_NODEREF
) {
2395 refname
= orig_refname
;
2396 lflags
|= LOCK_NO_DEREF
;
2398 lock
->ref_name
= xstrdup(refname
);
2399 lock
->orig_ref_name
= xstrdup(orig_refname
);
2400 ref_file
= git_path("%s", refname
);
2403 switch (safe_create_leading_directories(ref_file
)) {
2405 break; /* success */
2407 if (--attempts_remaining
> 0)
2412 error("unable to create directory for %s", ref_file
);
2416 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
2417 if (lock
->lock_fd
< 0) {
2419 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2421 * Maybe somebody just deleted one of the
2422 * directories leading to ref_file. Try
2427 struct strbuf err
= STRBUF_INIT
;
2428 unable_to_lock_message(ref_file
, errno
, &err
);
2429 error("%s", err
.buf
);
2430 strbuf_release(&err
);
2434 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
2443 * Write an entry to the packed-refs file for the specified refname.
2444 * If peeled is non-NULL, write it as the entry's peeled value.
2446 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2447 unsigned char *peeled
)
2449 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2451 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2455 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2457 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2459 enum peel_status peel_status
= peel_entry(entry
, 0);
2461 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2462 error("internal error: %s is not a valid packed reference!",
2464 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.sha1
,
2465 peel_status
== PEEL_PEELED
?
2466 entry
->u
.value
.peeled
: NULL
);
2470 /* This should return a meaningful errno on failure */
2471 int lock_packed_refs(int flags
)
2473 struct packed_ref_cache
*packed_ref_cache
;
2475 if (hold_lock_file_for_update(&packlock
, git_path("packed-refs"), flags
) < 0)
2478 * Get the current packed-refs while holding the lock. If the
2479 * packed-refs file has been modified since we last read it,
2480 * this will automatically invalidate the cache and re-read
2481 * the packed-refs file.
2483 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2484 packed_ref_cache
->lock
= &packlock
;
2485 /* Increment the reference count to prevent it from being freed: */
2486 acquire_packed_ref_cache(packed_ref_cache
);
2491 * Commit the packed refs changes.
2492 * On error we must make sure that errno contains a meaningful value.
2494 int commit_packed_refs(void)
2496 struct packed_ref_cache
*packed_ref_cache
=
2497 get_packed_ref_cache(&ref_cache
);
2502 if (!packed_ref_cache
->lock
)
2503 die("internal error: packed-refs not locked");
2505 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2507 die_errno("unable to fdopen packed-refs descriptor");
2509 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2510 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2511 0, write_packed_entry_fn
, out
);
2513 if (commit_lock_file(packed_ref_cache
->lock
)) {
2517 packed_ref_cache
->lock
= NULL
;
2518 release_packed_ref_cache(packed_ref_cache
);
2523 void rollback_packed_refs(void)
2525 struct packed_ref_cache
*packed_ref_cache
=
2526 get_packed_ref_cache(&ref_cache
);
2528 if (!packed_ref_cache
->lock
)
2529 die("internal error: packed-refs not locked");
2530 rollback_lock_file(packed_ref_cache
->lock
);
2531 packed_ref_cache
->lock
= NULL
;
2532 release_packed_ref_cache(packed_ref_cache
);
2533 clear_packed_ref_cache(&ref_cache
);
2536 struct ref_to_prune
{
2537 struct ref_to_prune
*next
;
2538 unsigned char sha1
[20];
2539 char name
[FLEX_ARRAY
];
2542 struct pack_refs_cb_data
{
2544 struct ref_dir
*packed_refs
;
2545 struct ref_to_prune
*ref_to_prune
;
2549 * An each_ref_entry_fn that is run over loose references only. If
2550 * the loose reference can be packed, add an entry in the packed ref
2551 * cache. If the reference should be pruned, also add it to
2552 * ref_to_prune in the pack_refs_cb_data.
2554 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2556 struct pack_refs_cb_data
*cb
= cb_data
;
2557 enum peel_status peel_status
;
2558 struct ref_entry
*packed_entry
;
2559 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2561 /* ALWAYS pack tags */
2562 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2565 /* Do not pack symbolic or broken refs: */
2566 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2569 /* Add a packed ref cache entry equivalent to the loose entry. */
2570 peel_status
= peel_entry(entry
, 1);
2571 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2572 die("internal error peeling reference %s (%s)",
2573 entry
->name
, sha1_to_hex(entry
->u
.value
.sha1
));
2574 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2576 /* Overwrite existing packed entry with info from loose entry */
2577 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2578 hashcpy(packed_entry
->u
.value
.sha1
, entry
->u
.value
.sha1
);
2580 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.sha1
,
2581 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2582 add_ref(cb
->packed_refs
, packed_entry
);
2584 hashcpy(packed_entry
->u
.value
.peeled
, entry
->u
.value
.peeled
);
2586 /* Schedule the loose reference for pruning if requested. */
2587 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2588 int namelen
= strlen(entry
->name
) + 1;
2589 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2590 hashcpy(n
->sha1
, entry
->u
.value
.sha1
);
2591 strcpy(n
->name
, entry
->name
);
2592 n
->next
= cb
->ref_to_prune
;
2593 cb
->ref_to_prune
= n
;
2599 * Remove empty parents, but spare refs/ and immediate subdirs.
2600 * Note: munges *name.
2602 static void try_remove_empty_parents(char *name
)
2607 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2608 while (*p
&& *p
!= '/')
2610 /* tolerate duplicate slashes; see check_refname_format() */
2614 for (q
= p
; *q
; q
++)
2617 while (q
> p
&& *q
!= '/')
2619 while (q
> p
&& *(q
-1) == '/')
2624 if (rmdir(git_path("%s", name
)))
2629 /* make sure nobody touched the ref, and unlink */
2630 static void prune_ref(struct ref_to_prune
*r
)
2632 struct ref_transaction
*transaction
;
2633 struct strbuf err
= STRBUF_INIT
;
2635 if (check_refname_format(r
->name
, 0))
2638 transaction
= ref_transaction_begin(&err
);
2640 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2641 REF_ISPRUNING
, NULL
, &err
) ||
2642 ref_transaction_commit(transaction
, &err
)) {
2643 ref_transaction_free(transaction
);
2644 error("%s", err
.buf
);
2645 strbuf_release(&err
);
2648 ref_transaction_free(transaction
);
2649 strbuf_release(&err
);
2650 try_remove_empty_parents(r
->name
);
2653 static void prune_refs(struct ref_to_prune
*r
)
2661 int pack_refs(unsigned int flags
)
2663 struct pack_refs_cb_data cbdata
;
2665 memset(&cbdata
, 0, sizeof(cbdata
));
2666 cbdata
.flags
= flags
;
2668 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2669 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2671 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2672 pack_if_possible_fn
, &cbdata
);
2674 if (commit_packed_refs())
2675 die_errno("unable to overwrite old ref-pack file");
2677 prune_refs(cbdata
.ref_to_prune
);
2681 int repack_without_refs(struct string_list
*refnames
, struct strbuf
*err
)
2683 struct ref_dir
*packed
;
2684 struct string_list_item
*refname
;
2685 int ret
, needs_repacking
= 0, removed
= 0;
2689 /* Look for a packed ref */
2690 for_each_string_list_item(refname
, refnames
) {
2691 if (get_packed_ref(refname
->string
)) {
2692 needs_repacking
= 1;
2697 /* Avoid locking if we have nothing to do */
2698 if (!needs_repacking
)
2699 return 0; /* no refname exists in packed refs */
2701 if (lock_packed_refs(0)) {
2702 unable_to_lock_message(git_path("packed-refs"), errno
, err
);
2705 packed
= get_packed_refs(&ref_cache
);
2707 /* Remove refnames from the cache */
2708 for_each_string_list_item(refname
, refnames
)
2709 if (remove_entry(packed
, refname
->string
) != -1)
2713 * All packed entries disappeared while we were
2714 * acquiring the lock.
2716 rollback_packed_refs();
2720 /* Write what remains */
2721 ret
= commit_packed_refs();
2723 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2728 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2732 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2734 * loose. The loose file name is the same as the
2735 * lockfile name, minus ".lock":
2737 char *loose_filename
= get_locked_file_path(lock
->lk
);
2738 int res
= unlink_or_msg(loose_filename
, err
);
2739 free(loose_filename
);
2746 int delete_ref(const char *refname
, const unsigned char *sha1
, unsigned int flags
)
2748 struct ref_transaction
*transaction
;
2749 struct strbuf err
= STRBUF_INIT
;
2751 transaction
= ref_transaction_begin(&err
);
2753 ref_transaction_delete(transaction
, refname
,
2754 (sha1
&& !is_null_sha1(sha1
)) ? sha1
: NULL
,
2755 flags
, NULL
, &err
) ||
2756 ref_transaction_commit(transaction
, &err
)) {
2757 error("%s", err
.buf
);
2758 ref_transaction_free(transaction
);
2759 strbuf_release(&err
);
2762 ref_transaction_free(transaction
);
2763 strbuf_release(&err
);
2768 * People using contrib's git-new-workdir have .git/logs/refs ->
2769 * /some/other/path/.git/logs/refs, and that may live on another device.
2771 * IOW, to avoid cross device rename errors, the temporary renamed log must
2772 * live into logs/refs.
2774 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2776 static int rename_tmp_log(const char *newrefname
)
2778 int attempts_remaining
= 4;
2781 switch (safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
2783 break; /* success */
2785 if (--attempts_remaining
> 0)
2789 error("unable to create directory for %s", newrefname
);
2793 if (rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2794 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2796 * rename(a, b) when b is an existing
2797 * directory ought to result in ISDIR, but
2798 * Solaris 5.8 gives ENOTDIR. Sheesh.
2800 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2801 error("Directory not empty: logs/%s", newrefname
);
2805 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2807 * Maybe another process just deleted one of
2808 * the directories in the path to newrefname.
2809 * Try again from the beginning.
2813 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2814 newrefname
, strerror(errno
));
2821 static int rename_ref_available(const char *oldname
, const char *newname
)
2823 struct string_list skip
= STRING_LIST_INIT_NODUP
;
2826 string_list_insert(&skip
, oldname
);
2827 ret
= is_refname_available(newname
, NULL
, &skip
, get_packed_refs(&ref_cache
))
2828 && is_refname_available(newname
, NULL
, &skip
, get_loose_refs(&ref_cache
));
2829 string_list_clear(&skip
, 0);
2833 static int write_ref_sha1(struct ref_lock
*lock
, const unsigned char *sha1
,
2834 const char *logmsg
);
2836 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2838 unsigned char sha1
[20], orig_sha1
[20];
2839 int flag
= 0, logmoved
= 0;
2840 struct ref_lock
*lock
;
2841 struct stat loginfo
;
2842 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2843 const char *symref
= NULL
;
2845 if (log
&& S_ISLNK(loginfo
.st_mode
))
2846 return error("reflog for %s is a symlink", oldrefname
);
2848 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
2850 if (flag
& REF_ISSYMREF
)
2851 return error("refname %s is a symbolic ref, renaming it is not supported",
2854 return error("refname %s not found", oldrefname
);
2856 if (!rename_ref_available(oldrefname
, newrefname
))
2859 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2860 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2861 oldrefname
, strerror(errno
));
2863 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2864 error("unable to delete old %s", oldrefname
);
2868 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
2869 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2870 if (errno
==EISDIR
) {
2871 if (remove_empty_directories(git_path("%s", newrefname
))) {
2872 error("Directory not empty: %s", newrefname
);
2876 error("unable to delete existing %s", newrefname
);
2881 if (log
&& rename_tmp_log(newrefname
))
2886 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, NULL
, 0, NULL
);
2888 error("unable to lock %s for update", newrefname
);
2891 hashcpy(lock
->old_sha1
, orig_sha1
);
2892 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
2893 error("unable to write current sha1 into %s", newrefname
);
2900 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, NULL
, 0, NULL
);
2902 error("unable to lock %s for rollback", oldrefname
);
2906 flag
= log_all_ref_updates
;
2907 log_all_ref_updates
= 0;
2908 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
2909 error("unable to write current sha1 into %s", oldrefname
);
2910 log_all_ref_updates
= flag
;
2913 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
2914 error("unable to restore logfile %s from %s: %s",
2915 oldrefname
, newrefname
, strerror(errno
));
2916 if (!logmoved
&& log
&&
2917 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
2918 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
2919 oldrefname
, strerror(errno
));
2924 static int close_ref(struct ref_lock
*lock
)
2926 if (close_lock_file(lock
->lk
))
2932 static int commit_ref(struct ref_lock
*lock
)
2934 if (commit_lock_file(lock
->lk
))
2941 * copy the reflog message msg to buf, which has been allocated sufficiently
2942 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2943 * because reflog file is one line per entry.
2945 static int copy_msg(char *buf
, const char *msg
)
2952 while ((c
= *msg
++)) {
2953 if (wasspace
&& isspace(c
))
2955 wasspace
= isspace(c
);
2960 while (buf
< cp
&& isspace(cp
[-1]))
2966 /* This function must set a meaningful errno on failure */
2967 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
2969 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
2971 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
2972 if (log_all_ref_updates
&&
2973 (starts_with(refname
, "refs/heads/") ||
2974 starts_with(refname
, "refs/remotes/") ||
2975 starts_with(refname
, "refs/notes/") ||
2976 !strcmp(refname
, "HEAD"))) {
2977 if (safe_create_leading_directories(logfile
) < 0) {
2978 int save_errno
= errno
;
2979 error("unable to create directory for %s", logfile
);
2986 logfd
= open(logfile
, oflags
, 0666);
2988 if (!(oflags
& O_CREAT
) && (errno
== ENOENT
|| errno
== EISDIR
))
2991 if (errno
== EISDIR
) {
2992 if (remove_empty_directories(logfile
)) {
2993 int save_errno
= errno
;
2994 error("There are still logs under '%s'",
2999 logfd
= open(logfile
, oflags
, 0666);
3003 int save_errno
= errno
;
3004 error("Unable to append to %s: %s", logfile
,
3011 adjust_shared_perm(logfile
);
3016 static int log_ref_write_fd(int fd
, const unsigned char *old_sha1
,
3017 const unsigned char *new_sha1
,
3018 const char *committer
, const char *msg
)
3020 int msglen
, written
;
3021 unsigned maxlen
, len
;
3024 msglen
= msg
? strlen(msg
) : 0;
3025 maxlen
= strlen(committer
) + msglen
+ 100;
3026 logrec
= xmalloc(maxlen
);
3027 len
= sprintf(logrec
, "%s %s %s\n",
3028 sha1_to_hex(old_sha1
),
3029 sha1_to_hex(new_sha1
),
3032 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
3034 written
= len
<= maxlen
? write_in_full(fd
, logrec
, len
) : -1;
3042 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
3043 const unsigned char *new_sha1
, const char *msg
)
3045 int logfd
, result
, oflags
= O_APPEND
| O_WRONLY
;
3046 char log_file
[PATH_MAX
];
3048 if (log_all_ref_updates
< 0)
3049 log_all_ref_updates
= !is_bare_repository();
3051 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
3055 logfd
= open(log_file
, oflags
);
3058 result
= log_ref_write_fd(logfd
, old_sha1
, new_sha1
,
3059 git_committer_info(0), msg
);
3061 int save_errno
= errno
;
3063 error("Unable to append to %s", log_file
);
3068 int save_errno
= errno
;
3069 error("Unable to append to %s", log_file
);
3076 int is_branch(const char *refname
)
3078 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3082 * Write sha1 into the ref specified by the lock. Make sure that errno
3085 static int write_ref_sha1(struct ref_lock
*lock
,
3086 const unsigned char *sha1
, const char *logmsg
)
3088 static char term
= '\n';
3091 o
= parse_object(sha1
);
3093 error("Trying to write ref %s with nonexistent object %s",
3094 lock
->ref_name
, sha1_to_hex(sha1
));
3099 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3100 error("Trying to write non-commit object %s to branch %s",
3101 sha1_to_hex(sha1
), lock
->ref_name
);
3106 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
3107 write_in_full(lock
->lock_fd
, &term
, 1) != 1 ||
3108 close_ref(lock
) < 0) {
3109 int save_errno
= errno
;
3110 error("Couldn't write %s", lock
->lk
->filename
.buf
);
3115 clear_loose_ref_cache(&ref_cache
);
3116 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
3117 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3118 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
3122 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3124 * Special hack: If a branch is updated directly and HEAD
3125 * points to it (may happen on the remote side of a push
3126 * for example) then logically the HEAD reflog should be
3128 * A generic solution implies reverse symref information,
3129 * but finding all symrefs pointing to the given branch
3130 * would be rather costly for this rare event (the direct
3131 * update of a branch) to be worth it. So let's cheat and
3132 * check with HEAD only which should cover 99% of all usage
3133 * scenarios (even 100% of the default ones).
3135 unsigned char head_sha1
[20];
3137 const char *head_ref
;
3138 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3139 head_sha1
, &head_flag
);
3140 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3141 !strcmp(head_ref
, lock
->ref_name
))
3142 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
3144 if (commit_ref(lock
)) {
3145 error("Couldn't set %s", lock
->ref_name
);
3153 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3156 const char *lockpath
;
3158 int fd
, len
, written
;
3159 char *git_HEAD
= git_pathdup("%s", ref_target
);
3160 unsigned char old_sha1
[20], new_sha1
[20];
3162 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3165 if (safe_create_leading_directories(git_HEAD
) < 0)
3166 return error("unable to create directory for %s", git_HEAD
);
3168 #ifndef NO_SYMLINK_HEAD
3169 if (prefer_symlink_refs
) {
3171 if (!symlink(refs_heads_master
, git_HEAD
))
3173 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3177 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3178 if (sizeof(ref
) <= len
) {
3179 error("refname too long: %s", refs_heads_master
);
3180 goto error_free_return
;
3182 lockpath
= mkpath("%s.lock", git_HEAD
);
3183 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3185 error("Unable to open %s for writing", lockpath
);
3186 goto error_free_return
;
3188 written
= write_in_full(fd
, ref
, len
);
3189 if (close(fd
) != 0 || written
!= len
) {
3190 error("Unable to write to %s", lockpath
);
3191 goto error_unlink_return
;
3193 if (rename(lockpath
, git_HEAD
) < 0) {
3194 error("Unable to create %s", git_HEAD
);
3195 goto error_unlink_return
;
3197 if (adjust_shared_perm(git_HEAD
)) {
3198 error("Unable to fix permissions on %s", lockpath
);
3199 error_unlink_return
:
3200 unlink_or_warn(lockpath
);
3206 #ifndef NO_SYMLINK_HEAD
3209 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
3210 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
3216 struct read_ref_at_cb
{
3217 const char *refname
;
3218 unsigned long at_time
;
3221 unsigned char *sha1
;
3224 unsigned char osha1
[20];
3225 unsigned char nsha1
[20];
3229 unsigned long *cutoff_time
;
3234 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3235 const char *email
, unsigned long timestamp
, int tz
,
3236 const char *message
, void *cb_data
)
3238 struct read_ref_at_cb
*cb
= cb_data
;
3242 cb
->date
= timestamp
;
3244 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3246 *cb
->msg
= xstrdup(message
);
3247 if (cb
->cutoff_time
)
3248 *cb
->cutoff_time
= timestamp
;
3250 *cb
->cutoff_tz
= tz
;
3252 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3254 * we have not yet updated cb->[n|o]sha1 so they still
3255 * hold the values for the previous record.
3257 if (!is_null_sha1(cb
->osha1
)) {
3258 hashcpy(cb
->sha1
, nsha1
);
3259 if (hashcmp(cb
->osha1
, nsha1
))
3260 warning("Log for ref %s has gap after %s.",
3261 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_RFC2822
));
3263 else if (cb
->date
== cb
->at_time
)
3264 hashcpy(cb
->sha1
, nsha1
);
3265 else if (hashcmp(nsha1
, cb
->sha1
))
3266 warning("Log for ref %s unexpectedly ended on %s.",
3267 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3269 hashcpy(cb
->osha1
, osha1
);
3270 hashcpy(cb
->nsha1
, nsha1
);
3274 hashcpy(cb
->osha1
, osha1
);
3275 hashcpy(cb
->nsha1
, nsha1
);
3281 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3282 const char *email
, unsigned long timestamp
,
3283 int tz
, const char *message
, void *cb_data
)
3285 struct read_ref_at_cb
*cb
= cb_data
;
3288 *cb
->msg
= xstrdup(message
);
3289 if (cb
->cutoff_time
)
3290 *cb
->cutoff_time
= timestamp
;
3292 *cb
->cutoff_tz
= tz
;
3294 *cb
->cutoff_cnt
= cb
->reccnt
;
3295 hashcpy(cb
->sha1
, osha1
);
3296 if (is_null_sha1(cb
->sha1
))
3297 hashcpy(cb
->sha1
, nsha1
);
3298 /* We just want the first entry */
3302 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3303 unsigned char *sha1
, char **msg
,
3304 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3306 struct read_ref_at_cb cb
;
3308 memset(&cb
, 0, sizeof(cb
));
3309 cb
.refname
= refname
;
3310 cb
.at_time
= at_time
;
3313 cb
.cutoff_time
= cutoff_time
;
3314 cb
.cutoff_tz
= cutoff_tz
;
3315 cb
.cutoff_cnt
= cutoff_cnt
;
3318 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3321 if (flags
& GET_SHA1_QUIETLY
)
3324 die("Log for %s is empty.", refname
);
3329 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3334 int reflog_exists(const char *refname
)
3338 return !lstat(git_path("logs/%s", refname
), &st
) &&
3339 S_ISREG(st
.st_mode
);
3342 int delete_reflog(const char *refname
)
3344 return remove_path(git_path("logs/%s", refname
));
3347 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3349 unsigned char osha1
[20], nsha1
[20];
3350 char *email_end
, *message
;
3351 unsigned long timestamp
;
3354 /* old SP new SP name <email> SP time TAB msg LF */
3355 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3356 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3357 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3358 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3359 email_end
[1] != ' ' ||
3360 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3361 !message
|| message
[0] != ' ' ||
3362 (message
[1] != '+' && message
[1] != '-') ||
3363 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3364 !isdigit(message
[4]) || !isdigit(message
[5]))
3365 return 0; /* corrupt? */
3366 email_end
[1] = '\0';
3367 tz
= strtol(message
+ 1, NULL
, 10);
3368 if (message
[6] != '\t')
3372 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3375 static char *find_beginning_of_line(char *bob
, char *scan
)
3377 while (bob
< scan
&& *(--scan
) != '\n')
3378 ; /* keep scanning backwards */
3380 * Return either beginning of the buffer, or LF at the end of
3381 * the previous line.
3386 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3388 struct strbuf sb
= STRBUF_INIT
;
3391 int ret
= 0, at_tail
= 1;
3393 logfp
= fopen(git_path("logs/%s", refname
), "r");
3397 /* Jump to the end */
3398 if (fseek(logfp
, 0, SEEK_END
) < 0)
3399 return error("cannot seek back reflog for %s: %s",
3400 refname
, strerror(errno
));
3402 while (!ret
&& 0 < pos
) {
3408 /* Fill next block from the end */
3409 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3410 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3411 return error("cannot seek back reflog for %s: %s",
3412 refname
, strerror(errno
));
3413 nread
= fread(buf
, cnt
, 1, logfp
);
3415 return error("cannot read %d bytes from reflog for %s: %s",
3416 cnt
, refname
, strerror(errno
));
3419 scanp
= endp
= buf
+ cnt
;
3420 if (at_tail
&& scanp
[-1] == '\n')
3421 /* Looking at the final LF at the end of the file */
3425 while (buf
< scanp
) {
3427 * terminating LF of the previous line, or the beginning
3432 bp
= find_beginning_of_line(buf
, scanp
);
3436 * The newline is the end of the previous line,
3437 * so we know we have complete line starting
3438 * at (bp + 1). Prefix it onto any prior data
3439 * we collected for the line and process it.
3441 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3444 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3450 * We are at the start of the buffer, and the
3451 * start of the file; there is no previous
3452 * line, and we have everything for this one.
3453 * Process it, and we can end the loop.
3455 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3456 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3463 * We are at the start of the buffer, and there
3464 * is more file to read backwards. Which means
3465 * we are in the middle of a line. Note that we
3466 * may get here even if *bp was a newline; that
3467 * just means we are at the exact end of the
3468 * previous line, rather than some spot in the
3471 * Save away what we have to be combined with
3472 * the data from the next read.
3474 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3481 die("BUG: reverse reflog parser had leftover data");
3484 strbuf_release(&sb
);
3488 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3491 struct strbuf sb
= STRBUF_INIT
;
3494 logfp
= fopen(git_path("logs/%s", refname
), "r");
3498 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3499 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3501 strbuf_release(&sb
);
3505 * Call fn for each reflog in the namespace indicated by name. name
3506 * must be empty or end with '/'. Name will be used as a scratch
3507 * space, but its contents will be restored before return.
3509 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3511 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3514 int oldlen
= name
->len
;
3517 return name
->len
? errno
: 0;
3519 while ((de
= readdir(d
)) != NULL
) {
3522 if (de
->d_name
[0] == '.')
3524 if (ends_with(de
->d_name
, ".lock"))
3526 strbuf_addstr(name
, de
->d_name
);
3527 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3528 ; /* silently ignore */
3530 if (S_ISDIR(st
.st_mode
)) {
3531 strbuf_addch(name
, '/');
3532 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3534 unsigned char sha1
[20];
3535 if (read_ref_full(name
->buf
, 0, sha1
, NULL
))
3536 retval
= error("bad ref for %s", name
->buf
);
3538 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
3543 strbuf_setlen(name
, oldlen
);
3549 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3553 strbuf_init(&name
, PATH_MAX
);
3554 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3555 strbuf_release(&name
);
3560 * Information needed for a single ref update. Set new_sha1 to the new
3561 * value or to null_sha1 to delete the ref. To check the old value
3562 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
3563 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
3564 * not exist before update.
3568 * If (flags & REF_HAVE_NEW), set the reference to this value:
3570 unsigned char new_sha1
[20];
3572 * If (flags & REF_HAVE_OLD), check that the reference
3573 * previously had this value:
3575 unsigned char old_sha1
[20];
3577 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3578 * REF_DELETING, and REF_ISPRUNING:
3581 struct ref_lock
*lock
;
3584 const char refname
[FLEX_ARRAY
];
3588 * Transaction states.
3589 * OPEN: The transaction is in a valid state and can accept new updates.
3590 * An OPEN transaction can be committed.
3591 * CLOSED: A closed transaction is no longer active and no other operations
3592 * than free can be used on it in this state.
3593 * A transaction can either become closed by successfully committing
3594 * an active transaction or if there is a failure while building
3595 * the transaction thus rendering it failed/inactive.
3597 enum ref_transaction_state
{
3598 REF_TRANSACTION_OPEN
= 0,
3599 REF_TRANSACTION_CLOSED
= 1
3603 * Data structure for holding a reference transaction, which can
3604 * consist of checks and updates to multiple references, carried out
3605 * as atomically as possible. This structure is opaque to callers.
3607 struct ref_transaction
{
3608 struct ref_update
**updates
;
3611 enum ref_transaction_state state
;
3614 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
3618 return xcalloc(1, sizeof(struct ref_transaction
));
3621 void ref_transaction_free(struct ref_transaction
*transaction
)
3628 for (i
= 0; i
< transaction
->nr
; i
++) {
3629 free(transaction
->updates
[i
]->msg
);
3630 free(transaction
->updates
[i
]);
3632 free(transaction
->updates
);
3636 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3637 const char *refname
)
3639 size_t len
= strlen(refname
);
3640 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3642 strcpy((char *)update
->refname
, refname
);
3643 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3644 transaction
->updates
[transaction
->nr
++] = update
;
3648 int ref_transaction_update(struct ref_transaction
*transaction
,
3649 const char *refname
,
3650 const unsigned char *new_sha1
,
3651 const unsigned char *old_sha1
,
3652 unsigned int flags
, const char *msg
,
3655 struct ref_update
*update
;
3659 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3660 die("BUG: update called for transaction that is not open");
3662 if (new_sha1
&& !is_null_sha1(new_sha1
) &&
3663 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
3664 strbuf_addf(err
, "refusing to update ref with bad name %s",
3669 update
= add_update(transaction
, refname
);
3671 hashcpy(update
->new_sha1
, new_sha1
);
3672 flags
|= REF_HAVE_NEW
;
3675 hashcpy(update
->old_sha1
, old_sha1
);
3676 flags
|= REF_HAVE_OLD
;
3678 update
->flags
= flags
;
3680 update
->msg
= xstrdup(msg
);
3684 int ref_transaction_create(struct ref_transaction
*transaction
,
3685 const char *refname
,
3686 const unsigned char *new_sha1
,
3687 unsigned int flags
, const char *msg
,
3690 if (!new_sha1
|| is_null_sha1(new_sha1
))
3691 die("BUG: create called without valid new_sha1");
3692 return ref_transaction_update(transaction
, refname
, new_sha1
,
3693 null_sha1
, flags
, msg
, err
);
3696 int ref_transaction_delete(struct ref_transaction
*transaction
,
3697 const char *refname
,
3698 const unsigned char *old_sha1
,
3699 unsigned int flags
, const char *msg
,
3702 if (old_sha1
&& is_null_sha1(old_sha1
))
3703 die("BUG: delete called with old_sha1 set to zeros");
3704 return ref_transaction_update(transaction
, refname
,
3705 null_sha1
, old_sha1
,
3709 int ref_transaction_verify(struct ref_transaction
*transaction
,
3710 const char *refname
,
3711 const unsigned char *old_sha1
,
3716 die("BUG: verify called with old_sha1 set to NULL");
3717 return ref_transaction_update(transaction
, refname
,
3722 int update_ref(const char *msg
, const char *refname
,
3723 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
3724 unsigned int flags
, enum action_on_err onerr
)
3726 struct ref_transaction
*t
;
3727 struct strbuf err
= STRBUF_INIT
;
3729 t
= ref_transaction_begin(&err
);
3731 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
3732 flags
, msg
, &err
) ||
3733 ref_transaction_commit(t
, &err
)) {
3734 const char *str
= "update_ref failed for ref '%s': %s";
3736 ref_transaction_free(t
);
3738 case UPDATE_REFS_MSG_ON_ERR
:
3739 error(str
, refname
, err
.buf
);
3741 case UPDATE_REFS_DIE_ON_ERR
:
3742 die(str
, refname
, err
.buf
);
3744 case UPDATE_REFS_QUIET_ON_ERR
:
3747 strbuf_release(&err
);
3750 strbuf_release(&err
);
3751 ref_transaction_free(t
);
3755 static int ref_update_reject_duplicates(struct string_list
*refnames
,
3758 int i
, n
= refnames
->nr
;
3762 for (i
= 1; i
< n
; i
++)
3763 if (!strcmp(refnames
->items
[i
- 1].string
, refnames
->items
[i
].string
)) {
3765 "Multiple updates for ref '%s' not allowed.",
3766 refnames
->items
[i
].string
);
3772 int ref_transaction_commit(struct ref_transaction
*transaction
,
3776 int n
= transaction
->nr
;
3777 struct ref_update
**updates
= transaction
->updates
;
3778 struct string_list refs_to_delete
= STRING_LIST_INIT_NODUP
;
3779 struct string_list_item
*ref_to_delete
;
3780 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
3784 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3785 die("BUG: commit called for transaction that is not open");
3788 transaction
->state
= REF_TRANSACTION_CLOSED
;
3792 /* Fail if a refname appears more than once in the transaction: */
3793 for (i
= 0; i
< n
; i
++)
3794 string_list_append(&affected_refnames
, updates
[i
]->refname
);
3795 string_list_sort(&affected_refnames
);
3796 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
3797 ret
= TRANSACTION_GENERIC_ERROR
;
3801 /* Acquire all locks while verifying old values */
3802 for (i
= 0; i
< n
; i
++) {
3803 struct ref_update
*update
= updates
[i
];
3804 unsigned int flags
= update
->flags
;
3806 if ((flags
& REF_HAVE_NEW
) && is_null_sha1(update
->new_sha1
))
3807 flags
|= REF_DELETING
;
3808 update
->lock
= lock_ref_sha1_basic(
3810 ((update
->flags
& REF_HAVE_OLD
) ?
3811 update
->old_sha1
: NULL
),
3812 &affected_refnames
, NULL
,
3815 if (!update
->lock
) {
3816 ret
= (errno
== ENOTDIR
)
3817 ? TRANSACTION_NAME_CONFLICT
3818 : TRANSACTION_GENERIC_ERROR
;
3819 strbuf_addf(err
, "Cannot lock the ref '%s'.",
3825 /* Perform updates first so live commits remain referenced */
3826 for (i
= 0; i
< n
; i
++) {
3827 struct ref_update
*update
= updates
[i
];
3828 int flags
= update
->flags
;
3830 if ((flags
& REF_HAVE_NEW
) && !is_null_sha1(update
->new_sha1
)) {
3831 int overwriting_symref
= ((update
->type
& REF_ISSYMREF
) &&
3832 (update
->flags
& REF_NODEREF
));
3834 if (!overwriting_symref
3835 && !hashcmp(update
->lock
->old_sha1
, update
->new_sha1
)) {
3837 * The reference already has the desired
3838 * value, so we don't need to write it.
3840 unlock_ref(update
->lock
);
3841 update
->lock
= NULL
;
3842 } else if (write_ref_sha1(update
->lock
, update
->new_sha1
,
3844 update
->lock
= NULL
; /* freed by write_ref_sha1 */
3845 strbuf_addf(err
, "Cannot update the ref '%s'.",
3847 ret
= TRANSACTION_GENERIC_ERROR
;
3850 /* freed by write_ref_sha1(): */
3851 update
->lock
= NULL
;
3856 /* Perform deletes now that updates are safely completed */
3857 for (i
= 0; i
< n
; i
++) {
3858 struct ref_update
*update
= updates
[i
];
3859 int flags
= update
->flags
;
3861 if ((flags
& REF_HAVE_NEW
) && is_null_sha1(update
->new_sha1
)) {
3862 if (delete_ref_loose(update
->lock
, update
->type
, err
)) {
3863 ret
= TRANSACTION_GENERIC_ERROR
;
3867 if (!(flags
& REF_ISPRUNING
))
3868 string_list_append(&refs_to_delete
,
3869 update
->lock
->ref_name
);
3873 if (repack_without_refs(&refs_to_delete
, err
)) {
3874 ret
= TRANSACTION_GENERIC_ERROR
;
3877 for_each_string_list_item(ref_to_delete
, &refs_to_delete
)
3878 unlink_or_warn(git_path("logs/%s", ref_to_delete
->string
));
3879 clear_loose_ref_cache(&ref_cache
);
3882 transaction
->state
= REF_TRANSACTION_CLOSED
;
3884 for (i
= 0; i
< n
; i
++)
3885 if (updates
[i
]->lock
)
3886 unlock_ref(updates
[i
]->lock
);
3887 string_list_clear(&refs_to_delete
, 0);
3888 string_list_clear(&affected_refnames
, 0);
3892 char *shorten_unambiguous_ref(const char *refname
, int strict
)
3895 static char **scanf_fmts
;
3896 static int nr_rules
;
3901 * Pre-generate scanf formats from ref_rev_parse_rules[].
3902 * Generate a format suitable for scanf from a
3903 * ref_rev_parse_rules rule by interpolating "%s" at the
3904 * location of the "%.*s".
3906 size_t total_len
= 0;
3909 /* the rule list is NULL terminated, count them first */
3910 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
3911 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3912 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
3914 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
3917 for (i
= 0; i
< nr_rules
; i
++) {
3918 assert(offset
< total_len
);
3919 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
3920 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
3921 ref_rev_parse_rules
[i
], 2, "%s") + 1;
3925 /* bail out if there are no rules */
3927 return xstrdup(refname
);
3929 /* buffer for scanf result, at most refname must fit */
3930 short_name
= xstrdup(refname
);
3932 /* skip first rule, it will always match */
3933 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
3935 int rules_to_fail
= i
;
3938 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
3941 short_name_len
= strlen(short_name
);
3944 * in strict mode, all (except the matched one) rules
3945 * must fail to resolve to a valid non-ambiguous ref
3948 rules_to_fail
= nr_rules
;
3951 * check if the short name resolves to a valid ref,
3952 * but use only rules prior to the matched one
3954 for (j
= 0; j
< rules_to_fail
; j
++) {
3955 const char *rule
= ref_rev_parse_rules
[j
];
3956 char refname
[PATH_MAX
];
3958 /* skip matched rule */
3963 * the short name is ambiguous, if it resolves
3964 * (with this previous rule) to a valid ref
3965 * read_ref() returns 0 on success
3967 mksnpath(refname
, sizeof(refname
),
3968 rule
, short_name_len
, short_name
);
3969 if (ref_exists(refname
))
3974 * short name is non-ambiguous if all previous rules
3975 * haven't resolved to a valid ref
3977 if (j
== rules_to_fail
)
3982 return xstrdup(refname
);
3985 static struct string_list
*hide_refs
;
3987 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
3989 if (!strcmp("transfer.hiderefs", var
) ||
3990 /* NEEDSWORK: use parse_config_key() once both are merged */
3991 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
3992 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
3997 return config_error_nonbool(var
);
3998 ref
= xstrdup(value
);
4000 while (len
&& ref
[len
- 1] == '/')
4003 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
4004 hide_refs
->strdup_strings
= 1;
4006 string_list_append(hide_refs
, ref
);
4011 int ref_is_hidden(const char *refname
)
4013 struct string_list_item
*item
;
4017 for_each_string_list_item(item
, hide_refs
) {
4019 if (!starts_with(refname
, item
->string
))
4021 len
= strlen(item
->string
);
4022 if (!refname
[len
] || refname
[len
] == '/')
4028 struct expire_reflog_cb
{
4030 reflog_expiry_should_prune_fn
*should_prune_fn
;
4033 unsigned char last_kept_sha1
[20];
4036 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
4037 const char *email
, unsigned long timestamp
, int tz
,
4038 const char *message
, void *cb_data
)
4040 struct expire_reflog_cb
*cb
= cb_data
;
4041 struct expire_reflog_policy_cb
*policy_cb
= cb
->policy_cb
;
4043 if (cb
->flags
& EXPIRE_REFLOGS_REWRITE
)
4044 osha1
= cb
->last_kept_sha1
;
4046 if ((*cb
->should_prune_fn
)(osha1
, nsha1
, email
, timestamp
, tz
,
4047 message
, policy_cb
)) {
4049 printf("would prune %s", message
);
4050 else if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4051 printf("prune %s", message
);
4054 fprintf(cb
->newlog
, "%s %s %s %lu %+05d\t%s",
4055 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
4056 email
, timestamp
, tz
, message
);
4057 hashcpy(cb
->last_kept_sha1
, nsha1
);
4059 if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4060 printf("keep %s", message
);
4065 int reflog_expire(const char *refname
, const unsigned char *sha1
,
4067 reflog_expiry_prepare_fn prepare_fn
,
4068 reflog_expiry_should_prune_fn should_prune_fn
,
4069 reflog_expiry_cleanup_fn cleanup_fn
,
4070 void *policy_cb_data
)
4072 static struct lock_file reflog_lock
;
4073 struct expire_reflog_cb cb
;
4074 struct ref_lock
*lock
;
4079 memset(&cb
, 0, sizeof(cb
));
4081 cb
.policy_cb
= policy_cb_data
;
4082 cb
.should_prune_fn
= should_prune_fn
;
4085 * The reflog file is locked by holding the lock on the
4086 * reference itself, plus we might need to update the
4087 * reference if --updateref was specified:
4089 lock
= lock_ref_sha1_basic(refname
, sha1
, NULL
, NULL
, 0, &type
);
4091 return error("cannot lock ref '%s'", refname
);
4092 if (!reflog_exists(refname
)) {
4097 log_file
= git_pathdup("logs/%s", refname
);
4098 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4100 * Even though holding $GIT_DIR/logs/$reflog.lock has
4101 * no locking implications, we use the lock_file
4102 * machinery here anyway because it does a lot of the
4103 * work we need, including cleaning up if the program
4104 * exits unexpectedly.
4106 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
4107 struct strbuf err
= STRBUF_INIT
;
4108 unable_to_lock_message(log_file
, errno
, &err
);
4109 error("%s", err
.buf
);
4110 strbuf_release(&err
);
4113 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
4115 error("cannot fdopen %s (%s)",
4116 reflog_lock
.filename
.buf
, strerror(errno
));
4121 (*prepare_fn
)(refname
, sha1
, cb
.policy_cb
);
4122 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
4123 (*cleanup_fn
)(cb
.policy_cb
);
4125 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4127 * It doesn't make sense to adjust a reference pointed
4128 * to by a symbolic ref based on expiring entries in
4129 * the symbolic reference's reflog. Nor can we update
4130 * a reference if there are no remaining reflog
4133 int update
= (flags
& EXPIRE_REFLOGS_UPDATE_REF
) &&
4134 !(type
& REF_ISSYMREF
) &&
4135 !is_null_sha1(cb
.last_kept_sha1
);
4137 if (close_lock_file(&reflog_lock
)) {
4138 status
|= error("couldn't write %s: %s", log_file
,
4140 } else if (update
&&
4141 (write_in_full(lock
->lock_fd
,
4142 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
4143 write_str_in_full(lock
->lock_fd
, "\n") != 1 ||
4144 close_ref(lock
) < 0)) {
4145 status
|= error("couldn't write %s",
4146 lock
->lk
->filename
.buf
);
4147 rollback_lock_file(&reflog_lock
);
4148 } else if (commit_lock_file(&reflog_lock
)) {
4149 status
|= error("unable to commit reflog '%s' (%s)",
4150 log_file
, strerror(errno
));
4151 } else if (update
&& commit_ref(lock
)) {
4152 status
|= error("couldn't set %s", lock
->ref_name
);
4160 rollback_lock_file(&reflog_lock
);