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 * skip is non-NULL, ignore potential conflicts with refs in skip
864 * (e.g., because they are scheduled for deletion in the same
867 * Two reference names conflict if one of them exactly matches the
868 * leading components of the other; e.g., "refs/foo/bar" conflicts
869 * with both "refs/foo" and with "refs/foo/bar/baz" but not with
870 * "refs/foo/bar" or "refs/foo/barbados".
872 * skip must be sorted.
874 static int is_refname_available(const char *refname
,
875 const struct string_list
*skip
,
880 struct strbuf dirname
= STRBUF_INIT
;
883 * For the sake of comments in this function, suppose that
884 * refname is "refs/foo/bar".
887 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
889 * We are still at a leading dir of the refname (e.g.,
890 * "refs/foo"; if there is a reference with that name,
891 * it is a conflict, *unless* it is in skip.
893 pos
= search_ref_dir(dir
, refname
, slash
- refname
);
896 * We found a reference whose name is a proper
897 * prefix of refname; e.g., "refs/foo".
899 struct ref_entry
*entry
= dir
->entries
[pos
];
900 if (skip
&& string_list_has_string(skip
, entry
->name
)) {
902 * The reference we just found, e.g.,
903 * "refs/foo", is also in skip, so it
904 * is not considered a conflict.
905 * Moreover, the fact that "refs/foo"
906 * exists means that there cannot be
907 * any references anywhere under the
908 * "refs/foo/" namespace (because they
909 * would have conflicted with
910 * "refs/foo"). So we can stop looking
911 * now and return true.
915 error("'%s' exists; cannot create '%s'", entry
->name
, refname
);
921 * Otherwise, we can try to continue our search with
922 * the next component. So try to look up the
923 * directory, e.g., "refs/foo/".
925 pos
= search_ref_dir(dir
, refname
, slash
+ 1 - refname
);
928 * There was no directory "refs/foo/", so
929 * there is nothing under this whole prefix,
935 dir
= get_ref_dir(dir
->entries
[pos
]);
939 * We are at the leaf of our refname (e.g., "refs/foo/bar").
940 * There is no point in searching for a reference with that
941 * name, because a refname isn't considered to conflict with
942 * itself. But we still need to check for references whose
943 * names are in the "refs/foo/bar/" namespace, because they
946 strbuf_addstr(&dirname
, refname
);
947 strbuf_addch(&dirname
, '/');
948 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
949 strbuf_release(&dirname
);
953 * We found a directory named "$refname/" (e.g.,
954 * "refs/foo/bar/"). It is a problem iff it contains
955 * any ref that is not in "skip".
957 struct nonmatching_ref_data data
;
958 struct ref_entry
*entry
= dir
->entries
[pos
];
960 dir
= get_ref_dir(entry
);
963 if (!do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
))
966 error("'%s' exists; cannot create '%s'",
967 data
.conflicting_refname
, refname
);
974 struct packed_ref_cache
{
975 struct ref_entry
*root
;
978 * Count of references to the data structure in this instance,
979 * including the pointer from ref_cache::packed if any. The
980 * data will not be freed as long as the reference count is
983 unsigned int referrers
;
986 * Iff the packed-refs file associated with this instance is
987 * currently locked for writing, this points at the associated
988 * lock (which is owned by somebody else). The referrer count
989 * is also incremented when the file is locked and decremented
990 * when it is unlocked.
992 struct lock_file
*lock
;
994 /* The metadata from when this packed-refs cache was read */
995 struct stat_validity validity
;
999 * Future: need to be in "struct repository"
1000 * when doing a full libification.
1002 static struct ref_cache
{
1003 struct ref_cache
*next
;
1004 struct ref_entry
*loose
;
1005 struct packed_ref_cache
*packed
;
1007 * The submodule name, or "" for the main repo. We allocate
1008 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1009 * is initialized correctly.
1012 } ref_cache
, *submodule_ref_caches
;
1014 /* Lock used for the main packed-refs file: */
1015 static struct lock_file packlock
;
1018 * Increment the reference count of *packed_refs.
1020 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1022 packed_refs
->referrers
++;
1026 * Decrease the reference count of *packed_refs. If it goes to zero,
1027 * free *packed_refs and return true; otherwise return false.
1029 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1031 if (!--packed_refs
->referrers
) {
1032 free_ref_entry(packed_refs
->root
);
1033 stat_validity_clear(&packed_refs
->validity
);
1041 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1044 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1046 if (packed_refs
->lock
)
1047 die("internal error: packed-ref cache cleared while locked");
1048 refs
->packed
= NULL
;
1049 release_packed_ref_cache(packed_refs
);
1053 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1056 free_ref_entry(refs
->loose
);
1061 static struct ref_cache
*create_ref_cache(const char *submodule
)
1064 struct ref_cache
*refs
;
1067 len
= strlen(submodule
) + 1;
1068 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1069 memcpy(refs
->name
, submodule
, len
);
1074 * Return a pointer to a ref_cache for the specified submodule. For
1075 * the main repository, use submodule==NULL. The returned structure
1076 * will be allocated and initialized but not necessarily populated; it
1077 * should not be freed.
1079 static struct ref_cache
*get_ref_cache(const char *submodule
)
1081 struct ref_cache
*refs
;
1083 if (!submodule
|| !*submodule
)
1086 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1087 if (!strcmp(submodule
, refs
->name
))
1090 refs
= create_ref_cache(submodule
);
1091 refs
->next
= submodule_ref_caches
;
1092 submodule_ref_caches
= refs
;
1096 /* The length of a peeled reference line in packed-refs, including EOL: */
1097 #define PEELED_LINE_LENGTH 42
1100 * The packed-refs header line that we write out. Perhaps other
1101 * traits will be added later. The trailing space is required.
1103 static const char PACKED_REFS_HEADER
[] =
1104 "# pack-refs with: peeled fully-peeled \n";
1107 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1108 * Return a pointer to the refname within the line (null-terminated),
1109 * or NULL if there was a problem.
1111 static const char *parse_ref_line(struct strbuf
*line
, unsigned char *sha1
)
1116 * 42: the answer to everything.
1118 * In this case, it happens to be the answer to
1119 * 40 (length of sha1 hex representation)
1120 * +1 (space in between hex and name)
1121 * +1 (newline at the end of the line)
1123 if (line
->len
<= 42)
1126 if (get_sha1_hex(line
->buf
, sha1
) < 0)
1128 if (!isspace(line
->buf
[40]))
1131 ref
= line
->buf
+ 41;
1135 if (line
->buf
[line
->len
- 1] != '\n')
1137 line
->buf
[--line
->len
] = 0;
1143 * Read f, which is a packed-refs file, into dir.
1145 * A comment line of the form "# pack-refs with: " may contain zero or
1146 * more traits. We interpret the traits as follows:
1150 * Probably no references are peeled. But if the file contains a
1151 * peeled value for a reference, we will use it.
1155 * References under "refs/tags/", if they *can* be peeled, *are*
1156 * peeled in this file. References outside of "refs/tags/" are
1157 * probably not peeled even if they could have been, but if we find
1158 * a peeled value for such a reference we will use it.
1162 * All references in the file that can be peeled are peeled.
1163 * Inversely (and this is more important), any references in the
1164 * file for which no peeled value is recorded is not peelable. This
1165 * trait should typically be written alongside "peeled" for
1166 * compatibility with older clients, but we do not require it
1167 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1169 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1171 struct ref_entry
*last
= NULL
;
1172 struct strbuf line
= STRBUF_INIT
;
1173 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1175 while (strbuf_getwholeline(&line
, f
, '\n') != EOF
) {
1176 unsigned char sha1
[20];
1177 const char *refname
;
1180 if (skip_prefix(line
.buf
, "# pack-refs with:", &traits
)) {
1181 if (strstr(traits
, " fully-peeled "))
1182 peeled
= PEELED_FULLY
;
1183 else if (strstr(traits
, " peeled "))
1184 peeled
= PEELED_TAGS
;
1185 /* perhaps other traits later as well */
1189 refname
= parse_ref_line(&line
, sha1
);
1191 int flag
= REF_ISPACKED
;
1193 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1195 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1197 last
= create_ref_entry(refname
, sha1
, flag
, 0);
1198 if (peeled
== PEELED_FULLY
||
1199 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1200 last
->flag
|= REF_KNOWS_PEELED
;
1205 line
.buf
[0] == '^' &&
1206 line
.len
== PEELED_LINE_LENGTH
&&
1207 line
.buf
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1208 !get_sha1_hex(line
.buf
+ 1, sha1
)) {
1209 hashcpy(last
->u
.value
.peeled
, sha1
);
1211 * Regardless of what the file header said,
1212 * we definitely know the value of *this*
1215 last
->flag
|= REF_KNOWS_PEELED
;
1219 strbuf_release(&line
);
1223 * Get the packed_ref_cache for the specified ref_cache, creating it
1226 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1228 const char *packed_refs_file
;
1231 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1233 packed_refs_file
= git_path("packed-refs");
1236 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1237 clear_packed_ref_cache(refs
);
1239 if (!refs
->packed
) {
1242 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1243 acquire_packed_ref_cache(refs
->packed
);
1244 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1245 f
= fopen(packed_refs_file
, "r");
1247 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1248 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1252 return refs
->packed
;
1255 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1257 return get_ref_dir(packed_ref_cache
->root
);
1260 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1262 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1265 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1267 struct packed_ref_cache
*packed_ref_cache
=
1268 get_packed_ref_cache(&ref_cache
);
1270 if (!packed_ref_cache
->lock
)
1271 die("internal error: packed refs not locked");
1272 add_ref(get_packed_ref_dir(packed_ref_cache
),
1273 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1277 * Read the loose references from the namespace dirname into dir
1278 * (without recursing). dirname must end with '/'. dir must be the
1279 * directory entry corresponding to dirname.
1281 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1283 struct ref_cache
*refs
= dir
->ref_cache
;
1287 int dirnamelen
= strlen(dirname
);
1288 struct strbuf refname
;
1291 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1293 path
= git_path("%s", dirname
);
1299 strbuf_init(&refname
, dirnamelen
+ 257);
1300 strbuf_add(&refname
, dirname
, dirnamelen
);
1302 while ((de
= readdir(d
)) != NULL
) {
1303 unsigned char sha1
[20];
1308 if (de
->d_name
[0] == '.')
1310 if (ends_with(de
->d_name
, ".lock"))
1312 strbuf_addstr(&refname
, de
->d_name
);
1313 refdir
= *refs
->name
1314 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1315 : git_path("%s", refname
.buf
);
1316 if (stat(refdir
, &st
) < 0) {
1317 ; /* silently ignore */
1318 } else if (S_ISDIR(st
.st_mode
)) {
1319 strbuf_addch(&refname
, '/');
1320 add_entry_to_dir(dir
,
1321 create_dir_entry(refs
, refname
.buf
,
1327 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
1329 flag
|= REF_ISBROKEN
;
1331 } else if (read_ref_full(refname
.buf
,
1332 RESOLVE_REF_READING
,
1335 flag
|= REF_ISBROKEN
;
1337 if (check_refname_format(refname
.buf
,
1338 REFNAME_ALLOW_ONELEVEL
)) {
1340 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1342 add_entry_to_dir(dir
,
1343 create_ref_entry(refname
.buf
, sha1
, flag
, 0));
1345 strbuf_setlen(&refname
, dirnamelen
);
1347 strbuf_release(&refname
);
1351 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1355 * Mark the top-level directory complete because we
1356 * are about to read the only subdirectory that can
1359 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1361 * Create an incomplete entry for "refs/":
1363 add_entry_to_dir(get_ref_dir(refs
->loose
),
1364 create_dir_entry(refs
, "refs/", 5, 1));
1366 return get_ref_dir(refs
->loose
);
1369 /* We allow "recursive" symbolic refs. Only within reason, though */
1371 #define MAXREFLEN (1024)
1374 * Called by resolve_gitlink_ref_recursive() after it failed to read
1375 * from the loose refs in ref_cache refs. Find <refname> in the
1376 * packed-refs file for the submodule.
1378 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1379 const char *refname
, unsigned char *sha1
)
1381 struct ref_entry
*ref
;
1382 struct ref_dir
*dir
= get_packed_refs(refs
);
1384 ref
= find_ref(dir
, refname
);
1388 hashcpy(sha1
, ref
->u
.value
.sha1
);
1392 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1393 const char *refname
, unsigned char *sha1
,
1397 char buffer
[128], *p
;
1400 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1403 ? git_path_submodule(refs
->name
, "%s", refname
)
1404 : git_path("%s", refname
);
1405 fd
= open(path
, O_RDONLY
);
1407 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1409 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1413 while (len
&& isspace(buffer
[len
-1]))
1417 /* Was it a detached head or an old-fashioned symlink? */
1418 if (!get_sha1_hex(buffer
, sha1
))
1422 if (strncmp(buffer
, "ref:", 4))
1428 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1431 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1433 int len
= strlen(path
), retval
;
1435 struct ref_cache
*refs
;
1437 while (len
&& path
[len
-1] == '/')
1441 submodule
= xstrndup(path
, len
);
1442 refs
= get_ref_cache(submodule
);
1445 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1450 * Return the ref_entry for the given refname from the packed
1451 * references. If it does not exist, return NULL.
1453 static struct ref_entry
*get_packed_ref(const char *refname
)
1455 return find_ref(get_packed_refs(&ref_cache
), refname
);
1459 * A loose ref file doesn't exist; check for a packed ref. The
1460 * options are forwarded from resolve_safe_unsafe().
1462 static int resolve_missing_loose_ref(const char *refname
,
1464 unsigned char *sha1
,
1467 struct ref_entry
*entry
;
1470 * The loose reference file does not exist; check for a packed
1473 entry
= get_packed_ref(refname
);
1475 hashcpy(sha1
, entry
->u
.value
.sha1
);
1477 *flags
|= REF_ISPACKED
;
1480 /* The reference is not a packed reference, either. */
1481 if (resolve_flags
& RESOLVE_REF_READING
) {
1490 /* This function needs to return a meaningful errno on failure */
1491 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1493 int depth
= MAXDEPTH
;
1496 static char refname_buffer
[256];
1502 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1504 *flags
|= REF_BAD_NAME
;
1506 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1507 !refname_is_safe(refname
)) {
1512 * dwim_ref() uses REF_ISBROKEN to distinguish between
1513 * missing refs and refs that were present but invalid,
1514 * to complain about the latter to stderr.
1516 * We don't know whether the ref exists, so don't set
1522 char path
[PATH_MAX
];
1532 git_snpath(path
, sizeof(path
), "%s", refname
);
1535 * We might have to loop back here to avoid a race
1536 * condition: first we lstat() the file, then we try
1537 * to read it as a link or as a file. But if somebody
1538 * changes the type of the file (file <-> directory
1539 * <-> symlink) between the lstat() and reading, then
1540 * we don't want to report that as an error but rather
1541 * try again starting with the lstat().
1544 if (lstat(path
, &st
) < 0) {
1545 if (errno
!= ENOENT
)
1547 if (resolve_missing_loose_ref(refname
, resolve_flags
,
1553 *flags
|= REF_ISBROKEN
;
1558 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1559 if (S_ISLNK(st
.st_mode
)) {
1560 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1562 if (errno
== ENOENT
|| errno
== EINVAL
)
1563 /* inconsistent with lstat; retry */
1569 if (starts_with(buffer
, "refs/") &&
1570 !check_refname_format(buffer
, 0)) {
1571 strcpy(refname_buffer
, buffer
);
1572 refname
= refname_buffer
;
1574 *flags
|= REF_ISSYMREF
;
1575 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1583 /* Is it a directory? */
1584 if (S_ISDIR(st
.st_mode
)) {
1590 * Anything else, just open it and try to use it as
1593 fd
= open(path
, O_RDONLY
);
1595 if (errno
== ENOENT
)
1596 /* inconsistent with lstat; retry */
1601 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1603 int save_errno
= errno
;
1609 while (len
&& isspace(buffer
[len
-1]))
1614 * Is it a symbolic ref?
1616 if (!starts_with(buffer
, "ref:")) {
1618 * Please note that FETCH_HEAD has a second
1619 * line containing other data.
1621 if (get_sha1_hex(buffer
, sha1
) ||
1622 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1624 *flags
|= REF_ISBROKEN
;
1631 *flags
|= REF_ISBROKEN
;
1636 *flags
|= REF_ISSYMREF
;
1638 while (isspace(*buf
))
1640 refname
= strcpy(refname_buffer
, buf
);
1641 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1645 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1647 *flags
|= REF_ISBROKEN
;
1649 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1650 !refname_is_safe(buf
)) {
1659 char *resolve_refdup(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1661 return xstrdup_or_null(resolve_ref_unsafe(ref
, resolve_flags
, sha1
, flags
));
1664 /* The argument to filter_refs */
1666 const char *pattern
;
1671 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1673 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1678 int read_ref(const char *refname
, unsigned char *sha1
)
1680 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1683 int ref_exists(const char *refname
)
1685 unsigned char sha1
[20];
1686 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1689 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1692 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1693 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1695 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1699 /* object was peeled successfully: */
1703 * object cannot be peeled because the named object (or an
1704 * object referred to by a tag in the peel chain), does not
1709 /* object cannot be peeled because it is not a tag: */
1712 /* ref_entry contains no peeled value because it is a symref: */
1713 PEEL_IS_SYMREF
= -3,
1716 * ref_entry cannot be peeled because it is broken (i.e., the
1717 * symbolic reference cannot even be resolved to an object
1724 * Peel the named object; i.e., if the object is a tag, resolve the
1725 * tag recursively until a non-tag is found. If successful, store the
1726 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1727 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1728 * and leave sha1 unchanged.
1730 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1732 struct object
*o
= lookup_unknown_object(name
);
1734 if (o
->type
== OBJ_NONE
) {
1735 int type
= sha1_object_info(name
, NULL
);
1736 if (type
< 0 || !object_as_type(o
, type
, 0))
1737 return PEEL_INVALID
;
1740 if (o
->type
!= OBJ_TAG
)
1741 return PEEL_NON_TAG
;
1743 o
= deref_tag_noverify(o
);
1745 return PEEL_INVALID
;
1747 hashcpy(sha1
, o
->sha1
);
1752 * Peel the entry (if possible) and return its new peel_status. If
1753 * repeel is true, re-peel the entry even if there is an old peeled
1754 * value that is already stored in it.
1756 * It is OK to call this function with a packed reference entry that
1757 * might be stale and might even refer to an object that has since
1758 * been garbage-collected. In such a case, if the entry has
1759 * REF_KNOWS_PEELED then leave the status unchanged and return
1760 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1762 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1764 enum peel_status status
;
1766 if (entry
->flag
& REF_KNOWS_PEELED
) {
1768 entry
->flag
&= ~REF_KNOWS_PEELED
;
1769 hashclr(entry
->u
.value
.peeled
);
1771 return is_null_sha1(entry
->u
.value
.peeled
) ?
1772 PEEL_NON_TAG
: PEEL_PEELED
;
1775 if (entry
->flag
& REF_ISBROKEN
)
1777 if (entry
->flag
& REF_ISSYMREF
)
1778 return PEEL_IS_SYMREF
;
1780 status
= peel_object(entry
->u
.value
.sha1
, entry
->u
.value
.peeled
);
1781 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1782 entry
->flag
|= REF_KNOWS_PEELED
;
1786 int peel_ref(const char *refname
, unsigned char *sha1
)
1789 unsigned char base
[20];
1791 if (current_ref
&& (current_ref
->name
== refname
1792 || !strcmp(current_ref
->name
, refname
))) {
1793 if (peel_entry(current_ref
, 0))
1795 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1799 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1803 * If the reference is packed, read its ref_entry from the
1804 * cache in the hope that we already know its peeled value.
1805 * We only try this optimization on packed references because
1806 * (a) forcing the filling of the loose reference cache could
1807 * be expensive and (b) loose references anyway usually do not
1808 * have REF_KNOWS_PEELED.
1810 if (flag
& REF_ISPACKED
) {
1811 struct ref_entry
*r
= get_packed_ref(refname
);
1813 if (peel_entry(r
, 0))
1815 hashcpy(sha1
, r
->u
.value
.peeled
);
1820 return peel_object(base
, sha1
);
1823 struct warn_if_dangling_data
{
1825 const char *refname
;
1826 const struct string_list
*refnames
;
1827 const char *msg_fmt
;
1830 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1831 int flags
, void *cb_data
)
1833 struct warn_if_dangling_data
*d
= cb_data
;
1834 const char *resolves_to
;
1835 unsigned char junk
[20];
1837 if (!(flags
& REF_ISSYMREF
))
1840 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
, NULL
);
1843 ? strcmp(resolves_to
, d
->refname
)
1844 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1848 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1853 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1855 struct warn_if_dangling_data data
;
1858 data
.refname
= refname
;
1859 data
.refnames
= NULL
;
1860 data
.msg_fmt
= msg_fmt
;
1861 for_each_rawref(warn_if_dangling_symref
, &data
);
1864 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1866 struct warn_if_dangling_data data
;
1869 data
.refname
= NULL
;
1870 data
.refnames
= refnames
;
1871 data
.msg_fmt
= msg_fmt
;
1872 for_each_rawref(warn_if_dangling_symref
, &data
);
1876 * Call fn for each reference in the specified ref_cache, omitting
1877 * references not in the containing_dir of base. fn is called for all
1878 * references, including broken ones. If fn ever returns a non-zero
1879 * value, stop the iteration and return that value; otherwise, return
1882 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1883 each_ref_entry_fn fn
, void *cb_data
)
1885 struct packed_ref_cache
*packed_ref_cache
;
1886 struct ref_dir
*loose_dir
;
1887 struct ref_dir
*packed_dir
;
1891 * We must make sure that all loose refs are read before accessing the
1892 * packed-refs file; this avoids a race condition in which loose refs
1893 * are migrated to the packed-refs file by a simultaneous process, but
1894 * our in-memory view is from before the migration. get_packed_ref_cache()
1895 * takes care of making sure our view is up to date with what is on
1898 loose_dir
= get_loose_refs(refs
);
1899 if (base
&& *base
) {
1900 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1903 prime_ref_dir(loose_dir
);
1905 packed_ref_cache
= get_packed_ref_cache(refs
);
1906 acquire_packed_ref_cache(packed_ref_cache
);
1907 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1908 if (base
&& *base
) {
1909 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1912 if (packed_dir
&& loose_dir
) {
1913 sort_ref_dir(packed_dir
);
1914 sort_ref_dir(loose_dir
);
1915 retval
= do_for_each_entry_in_dirs(
1916 packed_dir
, loose_dir
, fn
, cb_data
);
1917 } else if (packed_dir
) {
1918 sort_ref_dir(packed_dir
);
1919 retval
= do_for_each_entry_in_dir(
1920 packed_dir
, 0, fn
, cb_data
);
1921 } else if (loose_dir
) {
1922 sort_ref_dir(loose_dir
);
1923 retval
= do_for_each_entry_in_dir(
1924 loose_dir
, 0, fn
, cb_data
);
1927 release_packed_ref_cache(packed_ref_cache
);
1932 * Call fn for each reference in the specified ref_cache for which the
1933 * refname begins with base. If trim is non-zero, then trim that many
1934 * characters off the beginning of each refname before passing the
1935 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1936 * broken references in the iteration. If fn ever returns a non-zero
1937 * value, stop the iteration and return that value; otherwise, return
1940 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
1941 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1943 struct ref_entry_cb data
;
1948 data
.cb_data
= cb_data
;
1950 if (ref_paranoia
< 0)
1951 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1953 data
.flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1955 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
1958 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1960 unsigned char sha1
[20];
1964 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1965 return fn("HEAD", sha1
, 0, cb_data
);
1970 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, sha1
, &flag
))
1971 return fn("HEAD", sha1
, flag
, cb_data
);
1976 int head_ref(each_ref_fn fn
, void *cb_data
)
1978 return do_head_ref(NULL
, fn
, cb_data
);
1981 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1983 return do_head_ref(submodule
, fn
, cb_data
);
1986 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1988 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
1991 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1993 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
1996 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1998 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
2001 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
2002 each_ref_fn fn
, void *cb_data
)
2004 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
2007 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
2009 return for_each_ref_in("refs/tags/", fn
, cb_data
);
2012 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2014 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
2017 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
2019 return for_each_ref_in("refs/heads/", fn
, cb_data
);
2022 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2024 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2027 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2029 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2032 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2034 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2037 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2039 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
2042 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2044 struct strbuf buf
= STRBUF_INIT
;
2046 unsigned char sha1
[20];
2049 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2050 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, sha1
, &flag
))
2051 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
2052 strbuf_release(&buf
);
2057 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2059 struct strbuf buf
= STRBUF_INIT
;
2061 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2062 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2063 strbuf_release(&buf
);
2067 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2068 const char *prefix
, void *cb_data
)
2070 struct strbuf real_pattern
= STRBUF_INIT
;
2071 struct ref_filter filter
;
2074 if (!prefix
&& !starts_with(pattern
, "refs/"))
2075 strbuf_addstr(&real_pattern
, "refs/");
2077 strbuf_addstr(&real_pattern
, prefix
);
2078 strbuf_addstr(&real_pattern
, pattern
);
2080 if (!has_glob_specials(pattern
)) {
2081 /* Append implied '/' '*' if not present. */
2082 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2083 strbuf_addch(&real_pattern
, '/');
2084 /* No need to check for '*', there is none. */
2085 strbuf_addch(&real_pattern
, '*');
2088 filter
.pattern
= real_pattern
.buf
;
2090 filter
.cb_data
= cb_data
;
2091 ret
= for_each_ref(filter_refs
, &filter
);
2093 strbuf_release(&real_pattern
);
2097 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2099 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2102 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2104 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2105 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2108 const char *prettify_refname(const char *name
)
2111 starts_with(name
, "refs/heads/") ? 11 :
2112 starts_with(name
, "refs/tags/") ? 10 :
2113 starts_with(name
, "refs/remotes/") ? 13 :
2117 static const char *ref_rev_parse_rules
[] = {
2122 "refs/remotes/%.*s",
2123 "refs/remotes/%.*s/HEAD",
2127 int refname_match(const char *abbrev_name
, const char *full_name
)
2130 const int abbrev_name_len
= strlen(abbrev_name
);
2132 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2133 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2141 static void unlock_ref(struct ref_lock
*lock
)
2143 /* Do not free lock->lk -- atexit() still looks at them */
2145 rollback_lock_file(lock
->lk
);
2146 free(lock
->ref_name
);
2147 free(lock
->orig_ref_name
);
2151 /* This function should make sure errno is meaningful on error */
2152 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
2153 const unsigned char *old_sha1
, int mustexist
)
2155 if (read_ref_full(lock
->ref_name
,
2156 mustexist
? RESOLVE_REF_READING
: 0,
2157 lock
->old_sha1
, NULL
)) {
2158 int save_errno
= errno
;
2159 error("Can't verify ref %s", lock
->ref_name
);
2164 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
2165 error("Ref %s is at %s but expected %s", lock
->ref_name
,
2166 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
2174 static int remove_empty_directories(const char *file
)
2176 /* we want to create a file but there is a directory there;
2177 * if that is an empty directory (or a directory that contains
2178 * only empty directories), remove them.
2181 int result
, save_errno
;
2183 strbuf_init(&path
, 20);
2184 strbuf_addstr(&path
, file
);
2186 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2189 strbuf_release(&path
);
2196 * *string and *len will only be substituted, and *string returned (for
2197 * later free()ing) if the string passed in is a magic short-hand form
2200 static char *substitute_branch_name(const char **string
, int *len
)
2202 struct strbuf buf
= STRBUF_INIT
;
2203 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2207 *string
= strbuf_detach(&buf
, &size
);
2209 return (char *)*string
;
2215 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2217 char *last_branch
= substitute_branch_name(&str
, &len
);
2222 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2223 char fullref
[PATH_MAX
];
2224 unsigned char sha1_from_ref
[20];
2225 unsigned char *this_result
;
2228 this_result
= refs_found
? sha1_from_ref
: sha1
;
2229 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2230 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2231 this_result
, &flag
);
2235 if (!warn_ambiguous_refs
)
2237 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2238 warning("ignoring dangling symref %s.", fullref
);
2239 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2240 warning("ignoring broken ref %s.", fullref
);
2247 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2249 char *last_branch
= substitute_branch_name(&str
, &len
);
2254 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2255 unsigned char hash
[20];
2256 char path
[PATH_MAX
];
2257 const char *ref
, *it
;
2259 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2260 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2264 if (reflog_exists(path
))
2266 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2270 if (!logs_found
++) {
2272 hashcpy(sha1
, hash
);
2274 if (!warn_ambiguous_refs
)
2282 * Locks a ref returning the lock on success and NULL on failure.
2283 * On failure errno is set to something meaningful.
2285 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2286 const unsigned char *old_sha1
,
2287 const struct string_list
*skip
,
2288 unsigned int flags
, int *type_p
)
2291 const char *orig_refname
= refname
;
2292 struct ref_lock
*lock
;
2295 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2296 int resolve_flags
= 0;
2297 int attempts_remaining
= 3;
2299 lock
= xcalloc(1, sizeof(struct ref_lock
));
2303 resolve_flags
|= RESOLVE_REF_READING
;
2304 if (flags
& REF_DELETING
) {
2305 resolve_flags
|= RESOLVE_REF_ALLOW_BAD_NAME
;
2306 if (flags
& REF_NODEREF
)
2307 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2310 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2311 lock
->old_sha1
, &type
);
2312 if (!refname
&& errno
== EISDIR
) {
2313 /* we are trying to lock foo but we used to
2314 * have foo/bar which now does not exist;
2315 * it is normal for the empty directory 'foo'
2318 ref_file
= git_path("%s", orig_refname
);
2319 if (remove_empty_directories(ref_file
)) {
2321 error("there are still refs under '%s'", orig_refname
);
2324 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2325 lock
->old_sha1
, &type
);
2331 error("unable to resolve reference %s: %s",
2332 orig_refname
, strerror(errno
));
2336 * If the ref did not exist and we are creating it, make sure
2337 * there is no existing packed ref whose name begins with our
2338 * refname, nor a packed ref whose name is a proper prefix of
2341 if (is_null_sha1(lock
->old_sha1
) &&
2342 !is_refname_available(refname
, skip
, get_packed_refs(&ref_cache
))) {
2343 last_errno
= ENOTDIR
;
2347 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2350 if (flags
& REF_NODEREF
) {
2351 refname
= orig_refname
;
2352 lflags
|= LOCK_NO_DEREF
;
2354 lock
->ref_name
= xstrdup(refname
);
2355 lock
->orig_ref_name
= xstrdup(orig_refname
);
2356 ref_file
= git_path("%s", refname
);
2359 switch (safe_create_leading_directories(ref_file
)) {
2361 break; /* success */
2363 if (--attempts_remaining
> 0)
2368 error("unable to create directory for %s", ref_file
);
2372 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
2373 if (lock
->lock_fd
< 0) {
2375 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2377 * Maybe somebody just deleted one of the
2378 * directories leading to ref_file. Try
2383 struct strbuf err
= STRBUF_INIT
;
2384 unable_to_lock_message(ref_file
, errno
, &err
);
2385 error("%s", err
.buf
);
2386 strbuf_release(&err
);
2390 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
2399 * Write an entry to the packed-refs file for the specified refname.
2400 * If peeled is non-NULL, write it as the entry's peeled value.
2402 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2403 unsigned char *peeled
)
2405 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2407 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2411 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2413 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2415 enum peel_status peel_status
= peel_entry(entry
, 0);
2417 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2418 error("internal error: %s is not a valid packed reference!",
2420 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.sha1
,
2421 peel_status
== PEEL_PEELED
?
2422 entry
->u
.value
.peeled
: NULL
);
2426 /* This should return a meaningful errno on failure */
2427 int lock_packed_refs(int flags
)
2429 struct packed_ref_cache
*packed_ref_cache
;
2431 if (hold_lock_file_for_update(&packlock
, git_path("packed-refs"), flags
) < 0)
2434 * Get the current packed-refs while holding the lock. If the
2435 * packed-refs file has been modified since we last read it,
2436 * this will automatically invalidate the cache and re-read
2437 * the packed-refs file.
2439 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2440 packed_ref_cache
->lock
= &packlock
;
2441 /* Increment the reference count to prevent it from being freed: */
2442 acquire_packed_ref_cache(packed_ref_cache
);
2447 * Commit the packed refs changes.
2448 * On error we must make sure that errno contains a meaningful value.
2450 int commit_packed_refs(void)
2452 struct packed_ref_cache
*packed_ref_cache
=
2453 get_packed_ref_cache(&ref_cache
);
2458 if (!packed_ref_cache
->lock
)
2459 die("internal error: packed-refs not locked");
2461 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2463 die_errno("unable to fdopen packed-refs descriptor");
2465 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2466 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2467 0, write_packed_entry_fn
, out
);
2469 if (commit_lock_file(packed_ref_cache
->lock
)) {
2473 packed_ref_cache
->lock
= NULL
;
2474 release_packed_ref_cache(packed_ref_cache
);
2479 void rollback_packed_refs(void)
2481 struct packed_ref_cache
*packed_ref_cache
=
2482 get_packed_ref_cache(&ref_cache
);
2484 if (!packed_ref_cache
->lock
)
2485 die("internal error: packed-refs not locked");
2486 rollback_lock_file(packed_ref_cache
->lock
);
2487 packed_ref_cache
->lock
= NULL
;
2488 release_packed_ref_cache(packed_ref_cache
);
2489 clear_packed_ref_cache(&ref_cache
);
2492 struct ref_to_prune
{
2493 struct ref_to_prune
*next
;
2494 unsigned char sha1
[20];
2495 char name
[FLEX_ARRAY
];
2498 struct pack_refs_cb_data
{
2500 struct ref_dir
*packed_refs
;
2501 struct ref_to_prune
*ref_to_prune
;
2505 * An each_ref_entry_fn that is run over loose references only. If
2506 * the loose reference can be packed, add an entry in the packed ref
2507 * cache. If the reference should be pruned, also add it to
2508 * ref_to_prune in the pack_refs_cb_data.
2510 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2512 struct pack_refs_cb_data
*cb
= cb_data
;
2513 enum peel_status peel_status
;
2514 struct ref_entry
*packed_entry
;
2515 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2517 /* ALWAYS pack tags */
2518 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2521 /* Do not pack symbolic or broken refs: */
2522 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2525 /* Add a packed ref cache entry equivalent to the loose entry. */
2526 peel_status
= peel_entry(entry
, 1);
2527 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2528 die("internal error peeling reference %s (%s)",
2529 entry
->name
, sha1_to_hex(entry
->u
.value
.sha1
));
2530 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2532 /* Overwrite existing packed entry with info from loose entry */
2533 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2534 hashcpy(packed_entry
->u
.value
.sha1
, entry
->u
.value
.sha1
);
2536 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.sha1
,
2537 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2538 add_ref(cb
->packed_refs
, packed_entry
);
2540 hashcpy(packed_entry
->u
.value
.peeled
, entry
->u
.value
.peeled
);
2542 /* Schedule the loose reference for pruning if requested. */
2543 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2544 int namelen
= strlen(entry
->name
) + 1;
2545 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2546 hashcpy(n
->sha1
, entry
->u
.value
.sha1
);
2547 strcpy(n
->name
, entry
->name
);
2548 n
->next
= cb
->ref_to_prune
;
2549 cb
->ref_to_prune
= n
;
2555 * Remove empty parents, but spare refs/ and immediate subdirs.
2556 * Note: munges *name.
2558 static void try_remove_empty_parents(char *name
)
2563 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2564 while (*p
&& *p
!= '/')
2566 /* tolerate duplicate slashes; see check_refname_format() */
2570 for (q
= p
; *q
; q
++)
2573 while (q
> p
&& *q
!= '/')
2575 while (q
> p
&& *(q
-1) == '/')
2580 if (rmdir(git_path("%s", name
)))
2585 /* make sure nobody touched the ref, and unlink */
2586 static void prune_ref(struct ref_to_prune
*r
)
2588 struct ref_transaction
*transaction
;
2589 struct strbuf err
= STRBUF_INIT
;
2591 if (check_refname_format(r
->name
, 0))
2594 transaction
= ref_transaction_begin(&err
);
2596 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2597 REF_ISPRUNING
, NULL
, &err
) ||
2598 ref_transaction_commit(transaction
, &err
)) {
2599 ref_transaction_free(transaction
);
2600 error("%s", err
.buf
);
2601 strbuf_release(&err
);
2604 ref_transaction_free(transaction
);
2605 strbuf_release(&err
);
2606 try_remove_empty_parents(r
->name
);
2609 static void prune_refs(struct ref_to_prune
*r
)
2617 int pack_refs(unsigned int flags
)
2619 struct pack_refs_cb_data cbdata
;
2621 memset(&cbdata
, 0, sizeof(cbdata
));
2622 cbdata
.flags
= flags
;
2624 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2625 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2627 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2628 pack_if_possible_fn
, &cbdata
);
2630 if (commit_packed_refs())
2631 die_errno("unable to overwrite old ref-pack file");
2633 prune_refs(cbdata
.ref_to_prune
);
2637 int repack_without_refs(struct string_list
*refnames
, struct strbuf
*err
)
2639 struct ref_dir
*packed
;
2640 struct string_list_item
*refname
;
2641 int ret
, needs_repacking
= 0, removed
= 0;
2645 /* Look for a packed ref */
2646 for_each_string_list_item(refname
, refnames
) {
2647 if (get_packed_ref(refname
->string
)) {
2648 needs_repacking
= 1;
2653 /* Avoid locking if we have nothing to do */
2654 if (!needs_repacking
)
2655 return 0; /* no refname exists in packed refs */
2657 if (lock_packed_refs(0)) {
2658 unable_to_lock_message(git_path("packed-refs"), errno
, err
);
2661 packed
= get_packed_refs(&ref_cache
);
2663 /* Remove refnames from the cache */
2664 for_each_string_list_item(refname
, refnames
)
2665 if (remove_entry(packed
, refname
->string
) != -1)
2669 * All packed entries disappeared while we were
2670 * acquiring the lock.
2672 rollback_packed_refs();
2676 /* Write what remains */
2677 ret
= commit_packed_refs();
2679 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2684 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2688 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2690 * loose. The loose file name is the same as the
2691 * lockfile name, minus ".lock":
2693 char *loose_filename
= get_locked_file_path(lock
->lk
);
2694 int res
= unlink_or_msg(loose_filename
, err
);
2695 free(loose_filename
);
2702 int delete_ref(const char *refname
, const unsigned char *sha1
, unsigned int flags
)
2704 struct ref_transaction
*transaction
;
2705 struct strbuf err
= STRBUF_INIT
;
2707 transaction
= ref_transaction_begin(&err
);
2709 ref_transaction_delete(transaction
, refname
,
2710 (sha1
&& !is_null_sha1(sha1
)) ? sha1
: NULL
,
2711 flags
, NULL
, &err
) ||
2712 ref_transaction_commit(transaction
, &err
)) {
2713 error("%s", err
.buf
);
2714 ref_transaction_free(transaction
);
2715 strbuf_release(&err
);
2718 ref_transaction_free(transaction
);
2719 strbuf_release(&err
);
2724 * People using contrib's git-new-workdir have .git/logs/refs ->
2725 * /some/other/path/.git/logs/refs, and that may live on another device.
2727 * IOW, to avoid cross device rename errors, the temporary renamed log must
2728 * live into logs/refs.
2730 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2732 static int rename_tmp_log(const char *newrefname
)
2734 int attempts_remaining
= 4;
2737 switch (safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
2739 break; /* success */
2741 if (--attempts_remaining
> 0)
2745 error("unable to create directory for %s", newrefname
);
2749 if (rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2750 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2752 * rename(a, b) when b is an existing
2753 * directory ought to result in ISDIR, but
2754 * Solaris 5.8 gives ENOTDIR. Sheesh.
2756 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2757 error("Directory not empty: logs/%s", newrefname
);
2761 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2763 * Maybe another process just deleted one of
2764 * the directories in the path to newrefname.
2765 * Try again from the beginning.
2769 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2770 newrefname
, strerror(errno
));
2777 static int rename_ref_available(const char *oldname
, const char *newname
)
2779 struct string_list skip
= STRING_LIST_INIT_NODUP
;
2782 string_list_insert(&skip
, oldname
);
2783 ret
= is_refname_available(newname
, &skip
, get_packed_refs(&ref_cache
))
2784 && is_refname_available(newname
, &skip
, get_loose_refs(&ref_cache
));
2785 string_list_clear(&skip
, 0);
2789 static int write_ref_sha1(struct ref_lock
*lock
, const unsigned char *sha1
,
2790 const char *logmsg
);
2792 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2794 unsigned char sha1
[20], orig_sha1
[20];
2795 int flag
= 0, logmoved
= 0;
2796 struct ref_lock
*lock
;
2797 struct stat loginfo
;
2798 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2799 const char *symref
= NULL
;
2801 if (log
&& S_ISLNK(loginfo
.st_mode
))
2802 return error("reflog for %s is a symlink", oldrefname
);
2804 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
2806 if (flag
& REF_ISSYMREF
)
2807 return error("refname %s is a symbolic ref, renaming it is not supported",
2810 return error("refname %s not found", oldrefname
);
2812 if (!rename_ref_available(oldrefname
, newrefname
))
2815 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2816 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2817 oldrefname
, strerror(errno
));
2819 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2820 error("unable to delete old %s", oldrefname
);
2824 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
2825 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2826 if (errno
==EISDIR
) {
2827 if (remove_empty_directories(git_path("%s", newrefname
))) {
2828 error("Directory not empty: %s", newrefname
);
2832 error("unable to delete existing %s", newrefname
);
2837 if (log
&& rename_tmp_log(newrefname
))
2842 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, 0, NULL
);
2844 error("unable to lock %s for update", newrefname
);
2847 hashcpy(lock
->old_sha1
, orig_sha1
);
2848 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
2849 error("unable to write current sha1 into %s", newrefname
);
2856 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, 0, NULL
);
2858 error("unable to lock %s for rollback", oldrefname
);
2862 flag
= log_all_ref_updates
;
2863 log_all_ref_updates
= 0;
2864 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
2865 error("unable to write current sha1 into %s", oldrefname
);
2866 log_all_ref_updates
= flag
;
2869 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
2870 error("unable to restore logfile %s from %s: %s",
2871 oldrefname
, newrefname
, strerror(errno
));
2872 if (!logmoved
&& log
&&
2873 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
2874 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
2875 oldrefname
, strerror(errno
));
2880 static int close_ref(struct ref_lock
*lock
)
2882 if (close_lock_file(lock
->lk
))
2888 static int commit_ref(struct ref_lock
*lock
)
2890 if (commit_lock_file(lock
->lk
))
2897 * copy the reflog message msg to buf, which has been allocated sufficiently
2898 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2899 * because reflog file is one line per entry.
2901 static int copy_msg(char *buf
, const char *msg
)
2908 while ((c
= *msg
++)) {
2909 if (wasspace
&& isspace(c
))
2911 wasspace
= isspace(c
);
2916 while (buf
< cp
&& isspace(cp
[-1]))
2922 /* This function must set a meaningful errno on failure */
2923 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
2925 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
2927 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
2928 if (log_all_ref_updates
&&
2929 (starts_with(refname
, "refs/heads/") ||
2930 starts_with(refname
, "refs/remotes/") ||
2931 starts_with(refname
, "refs/notes/") ||
2932 !strcmp(refname
, "HEAD"))) {
2933 if (safe_create_leading_directories(logfile
) < 0) {
2934 int save_errno
= errno
;
2935 error("unable to create directory for %s", logfile
);
2942 logfd
= open(logfile
, oflags
, 0666);
2944 if (!(oflags
& O_CREAT
) && (errno
== ENOENT
|| errno
== EISDIR
))
2947 if (errno
== EISDIR
) {
2948 if (remove_empty_directories(logfile
)) {
2949 int save_errno
= errno
;
2950 error("There are still logs under '%s'",
2955 logfd
= open(logfile
, oflags
, 0666);
2959 int save_errno
= errno
;
2960 error("Unable to append to %s: %s", logfile
,
2967 adjust_shared_perm(logfile
);
2972 static int log_ref_write_fd(int fd
, const unsigned char *old_sha1
,
2973 const unsigned char *new_sha1
,
2974 const char *committer
, const char *msg
)
2976 int msglen
, written
;
2977 unsigned maxlen
, len
;
2980 msglen
= msg
? strlen(msg
) : 0;
2981 maxlen
= strlen(committer
) + msglen
+ 100;
2982 logrec
= xmalloc(maxlen
);
2983 len
= sprintf(logrec
, "%s %s %s\n",
2984 sha1_to_hex(old_sha1
),
2985 sha1_to_hex(new_sha1
),
2988 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
2990 written
= len
<= maxlen
? write_in_full(fd
, logrec
, len
) : -1;
2998 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
2999 const unsigned char *new_sha1
, const char *msg
)
3001 int logfd
, result
, oflags
= O_APPEND
| O_WRONLY
;
3002 char log_file
[PATH_MAX
];
3004 if (log_all_ref_updates
< 0)
3005 log_all_ref_updates
= !is_bare_repository();
3007 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
3011 logfd
= open(log_file
, oflags
);
3014 result
= log_ref_write_fd(logfd
, old_sha1
, new_sha1
,
3015 git_committer_info(0), msg
);
3017 int save_errno
= errno
;
3019 error("Unable to append to %s", log_file
);
3024 int save_errno
= errno
;
3025 error("Unable to append to %s", log_file
);
3032 int is_branch(const char *refname
)
3034 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3038 * Write sha1 into the ref specified by the lock. Make sure that errno
3041 static int write_ref_sha1(struct ref_lock
*lock
,
3042 const unsigned char *sha1
, const char *logmsg
)
3044 static char term
= '\n';
3047 o
= parse_object(sha1
);
3049 error("Trying to write ref %s with nonexistent object %s",
3050 lock
->ref_name
, sha1_to_hex(sha1
));
3055 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3056 error("Trying to write non-commit object %s to branch %s",
3057 sha1_to_hex(sha1
), lock
->ref_name
);
3062 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
3063 write_in_full(lock
->lock_fd
, &term
, 1) != 1 ||
3064 close_ref(lock
) < 0) {
3065 int save_errno
= errno
;
3066 error("Couldn't write %s", lock
->lk
->filename
.buf
);
3071 clear_loose_ref_cache(&ref_cache
);
3072 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
3073 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3074 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
3078 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3080 * Special hack: If a branch is updated directly and HEAD
3081 * points to it (may happen on the remote side of a push
3082 * for example) then logically the HEAD reflog should be
3084 * A generic solution implies reverse symref information,
3085 * but finding all symrefs pointing to the given branch
3086 * would be rather costly for this rare event (the direct
3087 * update of a branch) to be worth it. So let's cheat and
3088 * check with HEAD only which should cover 99% of all usage
3089 * scenarios (even 100% of the default ones).
3091 unsigned char head_sha1
[20];
3093 const char *head_ref
;
3094 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3095 head_sha1
, &head_flag
);
3096 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3097 !strcmp(head_ref
, lock
->ref_name
))
3098 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
3100 if (commit_ref(lock
)) {
3101 error("Couldn't set %s", lock
->ref_name
);
3109 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3112 const char *lockpath
;
3114 int fd
, len
, written
;
3115 char *git_HEAD
= git_pathdup("%s", ref_target
);
3116 unsigned char old_sha1
[20], new_sha1
[20];
3118 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3121 if (safe_create_leading_directories(git_HEAD
) < 0)
3122 return error("unable to create directory for %s", git_HEAD
);
3124 #ifndef NO_SYMLINK_HEAD
3125 if (prefer_symlink_refs
) {
3127 if (!symlink(refs_heads_master
, git_HEAD
))
3129 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3133 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3134 if (sizeof(ref
) <= len
) {
3135 error("refname too long: %s", refs_heads_master
);
3136 goto error_free_return
;
3138 lockpath
= mkpath("%s.lock", git_HEAD
);
3139 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3141 error("Unable to open %s for writing", lockpath
);
3142 goto error_free_return
;
3144 written
= write_in_full(fd
, ref
, len
);
3145 if (close(fd
) != 0 || written
!= len
) {
3146 error("Unable to write to %s", lockpath
);
3147 goto error_unlink_return
;
3149 if (rename(lockpath
, git_HEAD
) < 0) {
3150 error("Unable to create %s", git_HEAD
);
3151 goto error_unlink_return
;
3153 if (adjust_shared_perm(git_HEAD
)) {
3154 error("Unable to fix permissions on %s", lockpath
);
3155 error_unlink_return
:
3156 unlink_or_warn(lockpath
);
3162 #ifndef NO_SYMLINK_HEAD
3165 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
3166 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
3172 struct read_ref_at_cb
{
3173 const char *refname
;
3174 unsigned long at_time
;
3177 unsigned char *sha1
;
3180 unsigned char osha1
[20];
3181 unsigned char nsha1
[20];
3185 unsigned long *cutoff_time
;
3190 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3191 const char *email
, unsigned long timestamp
, int tz
,
3192 const char *message
, void *cb_data
)
3194 struct read_ref_at_cb
*cb
= cb_data
;
3198 cb
->date
= timestamp
;
3200 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3202 *cb
->msg
= xstrdup(message
);
3203 if (cb
->cutoff_time
)
3204 *cb
->cutoff_time
= timestamp
;
3206 *cb
->cutoff_tz
= tz
;
3208 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3210 * we have not yet updated cb->[n|o]sha1 so they still
3211 * hold the values for the previous record.
3213 if (!is_null_sha1(cb
->osha1
)) {
3214 hashcpy(cb
->sha1
, nsha1
);
3215 if (hashcmp(cb
->osha1
, nsha1
))
3216 warning("Log for ref %s has gap after %s.",
3217 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_RFC2822
));
3219 else if (cb
->date
== cb
->at_time
)
3220 hashcpy(cb
->sha1
, nsha1
);
3221 else if (hashcmp(nsha1
, cb
->sha1
))
3222 warning("Log for ref %s unexpectedly ended on %s.",
3223 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3225 hashcpy(cb
->osha1
, osha1
);
3226 hashcpy(cb
->nsha1
, nsha1
);
3230 hashcpy(cb
->osha1
, osha1
);
3231 hashcpy(cb
->nsha1
, nsha1
);
3237 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3238 const char *email
, unsigned long timestamp
,
3239 int tz
, const char *message
, void *cb_data
)
3241 struct read_ref_at_cb
*cb
= cb_data
;
3244 *cb
->msg
= xstrdup(message
);
3245 if (cb
->cutoff_time
)
3246 *cb
->cutoff_time
= timestamp
;
3248 *cb
->cutoff_tz
= tz
;
3250 *cb
->cutoff_cnt
= cb
->reccnt
;
3251 hashcpy(cb
->sha1
, osha1
);
3252 if (is_null_sha1(cb
->sha1
))
3253 hashcpy(cb
->sha1
, nsha1
);
3254 /* We just want the first entry */
3258 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3259 unsigned char *sha1
, char **msg
,
3260 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3262 struct read_ref_at_cb cb
;
3264 memset(&cb
, 0, sizeof(cb
));
3265 cb
.refname
= refname
;
3266 cb
.at_time
= at_time
;
3269 cb
.cutoff_time
= cutoff_time
;
3270 cb
.cutoff_tz
= cutoff_tz
;
3271 cb
.cutoff_cnt
= cutoff_cnt
;
3274 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3277 if (flags
& GET_SHA1_QUIETLY
)
3280 die("Log for %s is empty.", refname
);
3285 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3290 int reflog_exists(const char *refname
)
3294 return !lstat(git_path("logs/%s", refname
), &st
) &&
3295 S_ISREG(st
.st_mode
);
3298 int delete_reflog(const char *refname
)
3300 return remove_path(git_path("logs/%s", refname
));
3303 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3305 unsigned char osha1
[20], nsha1
[20];
3306 char *email_end
, *message
;
3307 unsigned long timestamp
;
3310 /* old SP new SP name <email> SP time TAB msg LF */
3311 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3312 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3313 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3314 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3315 email_end
[1] != ' ' ||
3316 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3317 !message
|| message
[0] != ' ' ||
3318 (message
[1] != '+' && message
[1] != '-') ||
3319 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3320 !isdigit(message
[4]) || !isdigit(message
[5]))
3321 return 0; /* corrupt? */
3322 email_end
[1] = '\0';
3323 tz
= strtol(message
+ 1, NULL
, 10);
3324 if (message
[6] != '\t')
3328 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3331 static char *find_beginning_of_line(char *bob
, char *scan
)
3333 while (bob
< scan
&& *(--scan
) != '\n')
3334 ; /* keep scanning backwards */
3336 * Return either beginning of the buffer, or LF at the end of
3337 * the previous line.
3342 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3344 struct strbuf sb
= STRBUF_INIT
;
3347 int ret
= 0, at_tail
= 1;
3349 logfp
= fopen(git_path("logs/%s", refname
), "r");
3353 /* Jump to the end */
3354 if (fseek(logfp
, 0, SEEK_END
) < 0)
3355 return error("cannot seek back reflog for %s: %s",
3356 refname
, strerror(errno
));
3358 while (!ret
&& 0 < pos
) {
3364 /* Fill next block from the end */
3365 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3366 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3367 return error("cannot seek back reflog for %s: %s",
3368 refname
, strerror(errno
));
3369 nread
= fread(buf
, cnt
, 1, logfp
);
3371 return error("cannot read %d bytes from reflog for %s: %s",
3372 cnt
, refname
, strerror(errno
));
3375 scanp
= endp
= buf
+ cnt
;
3376 if (at_tail
&& scanp
[-1] == '\n')
3377 /* Looking at the final LF at the end of the file */
3381 while (buf
< scanp
) {
3383 * terminating LF of the previous line, or the beginning
3388 bp
= find_beginning_of_line(buf
, scanp
);
3392 * The newline is the end of the previous line,
3393 * so we know we have complete line starting
3394 * at (bp + 1). Prefix it onto any prior data
3395 * we collected for the line and process it.
3397 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3400 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3406 * We are at the start of the buffer, and the
3407 * start of the file; there is no previous
3408 * line, and we have everything for this one.
3409 * Process it, and we can end the loop.
3411 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3412 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3419 * We are at the start of the buffer, and there
3420 * is more file to read backwards. Which means
3421 * we are in the middle of a line. Note that we
3422 * may get here even if *bp was a newline; that
3423 * just means we are at the exact end of the
3424 * previous line, rather than some spot in the
3427 * Save away what we have to be combined with
3428 * the data from the next read.
3430 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3437 die("BUG: reverse reflog parser had leftover data");
3440 strbuf_release(&sb
);
3444 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3447 struct strbuf sb
= STRBUF_INIT
;
3450 logfp
= fopen(git_path("logs/%s", refname
), "r");
3454 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3455 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3457 strbuf_release(&sb
);
3461 * Call fn for each reflog in the namespace indicated by name. name
3462 * must be empty or end with '/'. Name will be used as a scratch
3463 * space, but its contents will be restored before return.
3465 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3467 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3470 int oldlen
= name
->len
;
3473 return name
->len
? errno
: 0;
3475 while ((de
= readdir(d
)) != NULL
) {
3478 if (de
->d_name
[0] == '.')
3480 if (ends_with(de
->d_name
, ".lock"))
3482 strbuf_addstr(name
, de
->d_name
);
3483 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3484 ; /* silently ignore */
3486 if (S_ISDIR(st
.st_mode
)) {
3487 strbuf_addch(name
, '/');
3488 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3490 unsigned char sha1
[20];
3491 if (read_ref_full(name
->buf
, 0, sha1
, NULL
))
3492 retval
= error("bad ref for %s", name
->buf
);
3494 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
3499 strbuf_setlen(name
, oldlen
);
3505 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3509 strbuf_init(&name
, PATH_MAX
);
3510 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3511 strbuf_release(&name
);
3516 * Information needed for a single ref update. Set new_sha1 to the new
3517 * value or to null_sha1 to delete the ref. To check the old value
3518 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
3519 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
3520 * not exist before update.
3524 * If (flags & REF_HAVE_NEW), set the reference to this value:
3526 unsigned char new_sha1
[20];
3528 * If (flags & REF_HAVE_OLD), check that the reference
3529 * previously had this value:
3531 unsigned char old_sha1
[20];
3533 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3534 * REF_DELETING, and REF_ISPRUNING:
3537 struct ref_lock
*lock
;
3540 const char refname
[FLEX_ARRAY
];
3544 * Transaction states.
3545 * OPEN: The transaction is in a valid state and can accept new updates.
3546 * An OPEN transaction can be committed.
3547 * CLOSED: A closed transaction is no longer active and no other operations
3548 * than free can be used on it in this state.
3549 * A transaction can either become closed by successfully committing
3550 * an active transaction or if there is a failure while building
3551 * the transaction thus rendering it failed/inactive.
3553 enum ref_transaction_state
{
3554 REF_TRANSACTION_OPEN
= 0,
3555 REF_TRANSACTION_CLOSED
= 1
3559 * Data structure for holding a reference transaction, which can
3560 * consist of checks and updates to multiple references, carried out
3561 * as atomically as possible. This structure is opaque to callers.
3563 struct ref_transaction
{
3564 struct ref_update
**updates
;
3567 enum ref_transaction_state state
;
3570 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
3574 return xcalloc(1, sizeof(struct ref_transaction
));
3577 void ref_transaction_free(struct ref_transaction
*transaction
)
3584 for (i
= 0; i
< transaction
->nr
; i
++) {
3585 free(transaction
->updates
[i
]->msg
);
3586 free(transaction
->updates
[i
]);
3588 free(transaction
->updates
);
3592 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3593 const char *refname
)
3595 size_t len
= strlen(refname
);
3596 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3598 strcpy((char *)update
->refname
, refname
);
3599 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3600 transaction
->updates
[transaction
->nr
++] = update
;
3604 int ref_transaction_update(struct ref_transaction
*transaction
,
3605 const char *refname
,
3606 const unsigned char *new_sha1
,
3607 const unsigned char *old_sha1
,
3608 unsigned int flags
, const char *msg
,
3611 struct ref_update
*update
;
3615 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3616 die("BUG: update called for transaction that is not open");
3618 if (new_sha1
&& !is_null_sha1(new_sha1
) &&
3619 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
3620 strbuf_addf(err
, "refusing to update ref with bad name %s",
3625 update
= add_update(transaction
, refname
);
3627 hashcpy(update
->new_sha1
, new_sha1
);
3628 flags
|= REF_HAVE_NEW
;
3631 hashcpy(update
->old_sha1
, old_sha1
);
3632 flags
|= REF_HAVE_OLD
;
3634 update
->flags
= flags
;
3636 update
->msg
= xstrdup(msg
);
3640 int ref_transaction_create(struct ref_transaction
*transaction
,
3641 const char *refname
,
3642 const unsigned char *new_sha1
,
3643 unsigned int flags
, const char *msg
,
3646 if (!new_sha1
|| is_null_sha1(new_sha1
))
3647 die("BUG: create called without valid new_sha1");
3648 return ref_transaction_update(transaction
, refname
, new_sha1
,
3649 null_sha1
, flags
, msg
, err
);
3652 int ref_transaction_delete(struct ref_transaction
*transaction
,
3653 const char *refname
,
3654 const unsigned char *old_sha1
,
3655 unsigned int flags
, const char *msg
,
3658 if (old_sha1
&& is_null_sha1(old_sha1
))
3659 die("BUG: delete called with old_sha1 set to zeros");
3660 return ref_transaction_update(transaction
, refname
,
3661 null_sha1
, old_sha1
,
3665 int ref_transaction_verify(struct ref_transaction
*transaction
,
3666 const char *refname
,
3667 const unsigned char *old_sha1
,
3672 die("BUG: verify called with old_sha1 set to NULL");
3673 return ref_transaction_update(transaction
, refname
,
3678 int update_ref(const char *msg
, const char *refname
,
3679 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
3680 unsigned int flags
, enum action_on_err onerr
)
3682 struct ref_transaction
*t
;
3683 struct strbuf err
= STRBUF_INIT
;
3685 t
= ref_transaction_begin(&err
);
3687 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
3688 flags
, msg
, &err
) ||
3689 ref_transaction_commit(t
, &err
)) {
3690 const char *str
= "update_ref failed for ref '%s': %s";
3692 ref_transaction_free(t
);
3694 case UPDATE_REFS_MSG_ON_ERR
:
3695 error(str
, refname
, err
.buf
);
3697 case UPDATE_REFS_DIE_ON_ERR
:
3698 die(str
, refname
, err
.buf
);
3700 case UPDATE_REFS_QUIET_ON_ERR
:
3703 strbuf_release(&err
);
3706 strbuf_release(&err
);
3707 ref_transaction_free(t
);
3711 static int ref_update_compare(const void *r1
, const void *r2
)
3713 const struct ref_update
* const *u1
= r1
;
3714 const struct ref_update
* const *u2
= r2
;
3715 return strcmp((*u1
)->refname
, (*u2
)->refname
);
3718 static int ref_update_reject_duplicates(struct ref_update
**updates
, int n
,
3725 for (i
= 1; i
< n
; i
++)
3726 if (!strcmp(updates
[i
- 1]->refname
, updates
[i
]->refname
)) {
3728 "Multiple updates for ref '%s' not allowed.",
3729 updates
[i
]->refname
);
3735 int ref_transaction_commit(struct ref_transaction
*transaction
,
3739 int n
= transaction
->nr
;
3740 struct ref_update
**updates
= transaction
->updates
;
3741 struct string_list refs_to_delete
= STRING_LIST_INIT_NODUP
;
3742 struct string_list_item
*ref_to_delete
;
3746 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3747 die("BUG: commit called for transaction that is not open");
3750 transaction
->state
= REF_TRANSACTION_CLOSED
;
3754 /* Copy, sort, and reject duplicate refs */
3755 qsort(updates
, n
, sizeof(*updates
), ref_update_compare
);
3756 if (ref_update_reject_duplicates(updates
, n
, err
)) {
3757 ret
= TRANSACTION_GENERIC_ERROR
;
3761 /* Acquire all locks while verifying old values */
3762 for (i
= 0; i
< n
; i
++) {
3763 struct ref_update
*update
= updates
[i
];
3764 unsigned int flags
= update
->flags
;
3766 if ((flags
& REF_HAVE_NEW
) && is_null_sha1(update
->new_sha1
))
3767 flags
|= REF_DELETING
;
3768 update
->lock
= lock_ref_sha1_basic(
3770 ((update
->flags
& REF_HAVE_OLD
) ?
3771 update
->old_sha1
: NULL
),
3775 if (!update
->lock
) {
3776 ret
= (errno
== ENOTDIR
)
3777 ? TRANSACTION_NAME_CONFLICT
3778 : TRANSACTION_GENERIC_ERROR
;
3779 strbuf_addf(err
, "Cannot lock the ref '%s'.",
3785 /* Perform updates first so live commits remain referenced */
3786 for (i
= 0; i
< n
; i
++) {
3787 struct ref_update
*update
= updates
[i
];
3788 int flags
= update
->flags
;
3790 if ((flags
& REF_HAVE_NEW
) && !is_null_sha1(update
->new_sha1
)) {
3791 int overwriting_symref
= ((update
->type
& REF_ISSYMREF
) &&
3792 (update
->flags
& REF_NODEREF
));
3794 if (!overwriting_symref
3795 && !hashcmp(update
->lock
->old_sha1
, update
->new_sha1
)) {
3797 * The reference already has the desired
3798 * value, so we don't need to write it.
3800 unlock_ref(update
->lock
);
3801 update
->lock
= NULL
;
3802 } else if (write_ref_sha1(update
->lock
, update
->new_sha1
,
3804 update
->lock
= NULL
; /* freed by write_ref_sha1 */
3805 strbuf_addf(err
, "Cannot update the ref '%s'.",
3807 ret
= TRANSACTION_GENERIC_ERROR
;
3810 /* freed by write_ref_sha1(): */
3811 update
->lock
= NULL
;
3816 /* Perform deletes now that updates are safely completed */
3817 for (i
= 0; i
< n
; i
++) {
3818 struct ref_update
*update
= updates
[i
];
3819 int flags
= update
->flags
;
3821 if ((flags
& REF_HAVE_NEW
) && is_null_sha1(update
->new_sha1
)) {
3822 if (delete_ref_loose(update
->lock
, update
->type
, err
)) {
3823 ret
= TRANSACTION_GENERIC_ERROR
;
3827 if (!(flags
& REF_ISPRUNING
))
3828 string_list_append(&refs_to_delete
,
3829 update
->lock
->ref_name
);
3833 if (repack_without_refs(&refs_to_delete
, err
)) {
3834 ret
= TRANSACTION_GENERIC_ERROR
;
3837 for_each_string_list_item(ref_to_delete
, &refs_to_delete
)
3838 unlink_or_warn(git_path("logs/%s", ref_to_delete
->string
));
3839 clear_loose_ref_cache(&ref_cache
);
3842 transaction
->state
= REF_TRANSACTION_CLOSED
;
3844 for (i
= 0; i
< n
; i
++)
3845 if (updates
[i
]->lock
)
3846 unlock_ref(updates
[i
]->lock
);
3847 string_list_clear(&refs_to_delete
, 0);
3851 char *shorten_unambiguous_ref(const char *refname
, int strict
)
3854 static char **scanf_fmts
;
3855 static int nr_rules
;
3860 * Pre-generate scanf formats from ref_rev_parse_rules[].
3861 * Generate a format suitable for scanf from a
3862 * ref_rev_parse_rules rule by interpolating "%s" at the
3863 * location of the "%.*s".
3865 size_t total_len
= 0;
3868 /* the rule list is NULL terminated, count them first */
3869 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
3870 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3871 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
3873 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
3876 for (i
= 0; i
< nr_rules
; i
++) {
3877 assert(offset
< total_len
);
3878 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
3879 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
3880 ref_rev_parse_rules
[i
], 2, "%s") + 1;
3884 /* bail out if there are no rules */
3886 return xstrdup(refname
);
3888 /* buffer for scanf result, at most refname must fit */
3889 short_name
= xstrdup(refname
);
3891 /* skip first rule, it will always match */
3892 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
3894 int rules_to_fail
= i
;
3897 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
3900 short_name_len
= strlen(short_name
);
3903 * in strict mode, all (except the matched one) rules
3904 * must fail to resolve to a valid non-ambiguous ref
3907 rules_to_fail
= nr_rules
;
3910 * check if the short name resolves to a valid ref,
3911 * but use only rules prior to the matched one
3913 for (j
= 0; j
< rules_to_fail
; j
++) {
3914 const char *rule
= ref_rev_parse_rules
[j
];
3915 char refname
[PATH_MAX
];
3917 /* skip matched rule */
3922 * the short name is ambiguous, if it resolves
3923 * (with this previous rule) to a valid ref
3924 * read_ref() returns 0 on success
3926 mksnpath(refname
, sizeof(refname
),
3927 rule
, short_name_len
, short_name
);
3928 if (ref_exists(refname
))
3933 * short name is non-ambiguous if all previous rules
3934 * haven't resolved to a valid ref
3936 if (j
== rules_to_fail
)
3941 return xstrdup(refname
);
3944 static struct string_list
*hide_refs
;
3946 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
3948 if (!strcmp("transfer.hiderefs", var
) ||
3949 /* NEEDSWORK: use parse_config_key() once both are merged */
3950 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
3951 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
3956 return config_error_nonbool(var
);
3957 ref
= xstrdup(value
);
3959 while (len
&& ref
[len
- 1] == '/')
3962 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
3963 hide_refs
->strdup_strings
= 1;
3965 string_list_append(hide_refs
, ref
);
3970 int ref_is_hidden(const char *refname
)
3972 struct string_list_item
*item
;
3976 for_each_string_list_item(item
, hide_refs
) {
3978 if (!starts_with(refname
, item
->string
))
3980 len
= strlen(item
->string
);
3981 if (!refname
[len
] || refname
[len
] == '/')
3987 struct expire_reflog_cb
{
3989 reflog_expiry_should_prune_fn
*should_prune_fn
;
3992 unsigned char last_kept_sha1
[20];
3995 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
3996 const char *email
, unsigned long timestamp
, int tz
,
3997 const char *message
, void *cb_data
)
3999 struct expire_reflog_cb
*cb
= cb_data
;
4000 struct expire_reflog_policy_cb
*policy_cb
= cb
->policy_cb
;
4002 if (cb
->flags
& EXPIRE_REFLOGS_REWRITE
)
4003 osha1
= cb
->last_kept_sha1
;
4005 if ((*cb
->should_prune_fn
)(osha1
, nsha1
, email
, timestamp
, tz
,
4006 message
, policy_cb
)) {
4008 printf("would prune %s", message
);
4009 else if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4010 printf("prune %s", message
);
4013 fprintf(cb
->newlog
, "%s %s %s %lu %+05d\t%s",
4014 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
4015 email
, timestamp
, tz
, message
);
4016 hashcpy(cb
->last_kept_sha1
, nsha1
);
4018 if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4019 printf("keep %s", message
);
4024 int reflog_expire(const char *refname
, const unsigned char *sha1
,
4026 reflog_expiry_prepare_fn prepare_fn
,
4027 reflog_expiry_should_prune_fn should_prune_fn
,
4028 reflog_expiry_cleanup_fn cleanup_fn
,
4029 void *policy_cb_data
)
4031 static struct lock_file reflog_lock
;
4032 struct expire_reflog_cb cb
;
4033 struct ref_lock
*lock
;
4038 memset(&cb
, 0, sizeof(cb
));
4040 cb
.policy_cb
= policy_cb_data
;
4041 cb
.should_prune_fn
= should_prune_fn
;
4044 * The reflog file is locked by holding the lock on the
4045 * reference itself, plus we might need to update the
4046 * reference if --updateref was specified:
4048 lock
= lock_ref_sha1_basic(refname
, sha1
, NULL
, 0, &type
);
4050 return error("cannot lock ref '%s'", refname
);
4051 if (!reflog_exists(refname
)) {
4056 log_file
= git_pathdup("logs/%s", refname
);
4057 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4059 * Even though holding $GIT_DIR/logs/$reflog.lock has
4060 * no locking implications, we use the lock_file
4061 * machinery here anyway because it does a lot of the
4062 * work we need, including cleaning up if the program
4063 * exits unexpectedly.
4065 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
4066 struct strbuf err
= STRBUF_INIT
;
4067 unable_to_lock_message(log_file
, errno
, &err
);
4068 error("%s", err
.buf
);
4069 strbuf_release(&err
);
4072 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
4074 error("cannot fdopen %s (%s)",
4075 reflog_lock
.filename
.buf
, strerror(errno
));
4080 (*prepare_fn
)(refname
, sha1
, cb
.policy_cb
);
4081 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
4082 (*cleanup_fn
)(cb
.policy_cb
);
4084 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4086 * It doesn't make sense to adjust a reference pointed
4087 * to by a symbolic ref based on expiring entries in
4088 * the symbolic reference's reflog. Nor can we update
4089 * a reference if there are no remaining reflog
4092 int update
= (flags
& EXPIRE_REFLOGS_UPDATE_REF
) &&
4093 !(type
& REF_ISSYMREF
) &&
4094 !is_null_sha1(cb
.last_kept_sha1
);
4096 if (close_lock_file(&reflog_lock
)) {
4097 status
|= error("couldn't write %s: %s", log_file
,
4099 } else if (update
&&
4100 (write_in_full(lock
->lock_fd
,
4101 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
4102 write_str_in_full(lock
->lock_fd
, "\n") != 1 ||
4103 close_ref(lock
) < 0)) {
4104 status
|= error("couldn't write %s",
4105 lock
->lk
->filename
.buf
);
4106 rollback_lock_file(&reflog_lock
);
4107 } else if (commit_lock_file(&reflog_lock
)) {
4108 status
|= error("unable to commit reflog '%s' (%s)",
4109 log_file
, strerror(errno
));
4110 } else if (update
&& commit_ref(lock
)) {
4111 status
|= error("couldn't set %s", lock
->ref_name
);
4119 rollback_lock_file(&reflog_lock
);