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 * Used as a flag in ref_update::flags when the lockfile needs to be
64 #define REF_NEEDS_COMMIT 0x20
67 * Try to read one refname component from the front of refname.
68 * Return the length of the component found, or -1 if the component is
69 * not legal. It is legal if it is something reasonable to have under
70 * ".git/refs/"; We do not like it if:
72 * - any path component of it begins with ".", or
73 * - it has double dots "..", or
74 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
75 * - it ends with a "/".
76 * - it ends with ".lock"
77 * - it contains a "\" (backslash)
79 static int check_refname_component(const char *refname
, int flags
)
84 for (cp
= refname
; ; cp
++) {
86 unsigned char disp
= refname_disposition
[ch
];
92 return -1; /* Refname contains "..". */
96 return -1; /* Refname contains "@{". */
105 return 0; /* Component has zero length. */
106 if (refname
[0] == '.')
107 return -1; /* Component starts with '.'. */
108 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
109 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
110 return -1; /* Refname ends with ".lock". */
114 int check_refname_format(const char *refname
, int flags
)
116 int component_len
, component_count
= 0;
118 if (!strcmp(refname
, "@"))
119 /* Refname is a single character '@'. */
123 /* We are at the start of a path component. */
124 component_len
= check_refname_component(refname
, flags
);
125 if (component_len
<= 0) {
126 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
128 (refname
[1] == '\0' || refname
[1] == '/')) {
129 /* Accept one wildcard as a full refname component. */
130 flags
&= ~REFNAME_REFSPEC_PATTERN
;
137 if (refname
[component_len
] == '\0')
139 /* Skip to next component. */
140 refname
+= component_len
+ 1;
143 if (refname
[component_len
- 1] == '.')
144 return -1; /* Refname ends with '.'. */
145 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
146 return -1; /* Refname has only one component. */
153 * Information used (along with the information in ref_entry) to
154 * describe a single cached reference. This data structure only
155 * occurs embedded in a union in struct ref_entry, and only when
156 * (ref_entry->flag & REF_DIR) is zero.
160 * The name of the object to which this reference resolves
161 * (which may be a tag object). If REF_ISBROKEN, this is
162 * null. If REF_ISSYMREF, then this is the name of the object
163 * referred to by the last reference in the symlink chain.
165 unsigned char sha1
[20];
168 * If REF_KNOWS_PEELED, then this field holds the peeled value
169 * of this reference, or null if the reference is known not to
170 * be peelable. See the documentation for peel_ref() for an
171 * exact definition of "peelable".
173 unsigned char peeled
[20];
179 * Information used (along with the information in ref_entry) to
180 * describe a level in the hierarchy of references. This data
181 * structure only occurs embedded in a union in struct ref_entry, and
182 * only when (ref_entry.flag & REF_DIR) is set. In that case,
183 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
184 * in the directory have already been read:
186 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
187 * or packed references, already read.
189 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
190 * references that hasn't been read yet (nor has any of its
193 * Entries within a directory are stored within a growable array of
194 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
195 * sorted are sorted by their component name in strcmp() order and the
196 * remaining entries are unsorted.
198 * Loose references are read lazily, one directory at a time. When a
199 * directory of loose references is read, then all of the references
200 * in that directory are stored, and REF_INCOMPLETE stubs are created
201 * for any subdirectories, but the subdirectories themselves are not
202 * read. The reading is triggered by get_ref_dir().
208 * Entries with index 0 <= i < sorted are sorted by name. New
209 * entries are appended to the list unsorted, and are sorted
210 * only when required; thus we avoid the need to sort the list
211 * after the addition of every reference.
215 /* A pointer to the ref_cache that contains this ref_dir. */
216 struct ref_cache
*ref_cache
;
218 struct ref_entry
**entries
;
222 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
223 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
224 * public values; see refs.h.
228 * The field ref_entry->u.value.peeled of this value entry contains
229 * the correct peeled value for the reference, which might be
230 * null_sha1 if the reference is not a tag or if it is broken.
232 #define REF_KNOWS_PEELED 0x10
234 /* ref_entry represents a directory of references */
238 * Entry has not yet been read from disk (used only for REF_DIR
239 * entries representing loose references)
241 #define REF_INCOMPLETE 0x40
244 * A ref_entry represents either a reference or a "subdirectory" of
247 * Each directory in the reference namespace is represented by a
248 * ref_entry with (flags & REF_DIR) set and containing a subdir member
249 * that holds the entries in that directory that have been read so
250 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
251 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
252 * used for loose reference directories.
254 * References are represented by a ref_entry with (flags & REF_DIR)
255 * unset and a value member that describes the reference's value. The
256 * flag member is at the ref_entry level, but it is also needed to
257 * interpret the contents of the value field (in other words, a
258 * ref_value object is not very much use without the enclosing
261 * Reference names cannot end with slash and directories' names are
262 * always stored with a trailing slash (except for the top-level
263 * directory, which is always denoted by ""). This has two nice
264 * consequences: (1) when the entries in each subdir are sorted
265 * lexicographically by name (as they usually are), the references in
266 * a whole tree can be generated in lexicographic order by traversing
267 * the tree in left-to-right, depth-first order; (2) the names of
268 * references and subdirectories cannot conflict, and therefore the
269 * presence of an empty subdirectory does not block the creation of a
270 * similarly-named reference. (The fact that reference names with the
271 * same leading components can conflict *with each other* is a
272 * separate issue that is regulated by is_refname_available().)
274 * Please note that the name field contains the fully-qualified
275 * reference (or subdirectory) name. Space could be saved by only
276 * storing the relative names. But that would require the full names
277 * to be generated on the fly when iterating in do_for_each_ref(), and
278 * would break callback functions, who have always been able to assume
279 * that the name strings that they are passed will not be freed during
283 unsigned char flag
; /* ISSYMREF? ISPACKED? */
285 struct ref_value value
; /* if not (flags&REF_DIR) */
286 struct ref_dir subdir
; /* if (flags&REF_DIR) */
289 * The full name of the reference (e.g., "refs/heads/master")
290 * or the full name of the directory with a trailing slash
291 * (e.g., "refs/heads/"):
293 char name
[FLEX_ARRAY
];
296 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
298 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
301 assert(entry
->flag
& REF_DIR
);
302 dir
= &entry
->u
.subdir
;
303 if (entry
->flag
& REF_INCOMPLETE
) {
304 read_loose_refs(entry
->name
, dir
);
305 entry
->flag
&= ~REF_INCOMPLETE
;
311 * Check if a refname is safe.
312 * For refs that start with "refs/" we consider it safe as long they do
313 * not try to resolve to outside of refs/.
315 * For all other refs we only consider them safe iff they only contain
316 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
319 static int refname_is_safe(const char *refname
)
321 if (starts_with(refname
, "refs/")) {
325 buf
= xmalloc(strlen(refname
) + 1);
327 * Does the refname try to escape refs/?
328 * For example: refs/foo/../bar is safe but refs/foo/../../bar
331 result
= !normalize_path_copy(buf
, refname
+ strlen("refs/"));
336 if (!isupper(*refname
) && *refname
!= '_')
343 static struct ref_entry
*create_ref_entry(const char *refname
,
344 const unsigned char *sha1
, int flag
,
348 struct ref_entry
*ref
;
351 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
352 die("Reference has invalid format: '%s'", refname
);
353 if (!check_name
&& !refname_is_safe(refname
))
354 die("Reference has invalid name: '%s'", refname
);
355 len
= strlen(refname
) + 1;
356 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
357 hashcpy(ref
->u
.value
.sha1
, sha1
);
358 hashclr(ref
->u
.value
.peeled
);
359 memcpy(ref
->name
, refname
, len
);
364 static void clear_ref_dir(struct ref_dir
*dir
);
366 static void free_ref_entry(struct ref_entry
*entry
)
368 if (entry
->flag
& REF_DIR
) {
370 * Do not use get_ref_dir() here, as that might
371 * trigger the reading of loose refs.
373 clear_ref_dir(&entry
->u
.subdir
);
379 * Add a ref_entry to the end of dir (unsorted). Entry is always
380 * stored directly in dir; no recursion into subdirectories is
383 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
385 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
386 dir
->entries
[dir
->nr
++] = entry
;
387 /* optimize for the case that entries are added in order */
389 (dir
->nr
== dir
->sorted
+ 1 &&
390 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
391 dir
->entries
[dir
->nr
- 1]->name
) < 0))
392 dir
->sorted
= dir
->nr
;
396 * Clear and free all entries in dir, recursively.
398 static void clear_ref_dir(struct ref_dir
*dir
)
401 for (i
= 0; i
< dir
->nr
; i
++)
402 free_ref_entry(dir
->entries
[i
]);
404 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
409 * Create a struct ref_entry object for the specified dirname.
410 * dirname is the name of the directory with a trailing slash (e.g.,
411 * "refs/heads/") or "" for the top-level directory.
413 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
414 const char *dirname
, size_t len
,
417 struct ref_entry
*direntry
;
418 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
419 memcpy(direntry
->name
, dirname
, len
);
420 direntry
->name
[len
] = '\0';
421 direntry
->u
.subdir
.ref_cache
= ref_cache
;
422 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
426 static int ref_entry_cmp(const void *a
, const void *b
)
428 struct ref_entry
*one
= *(struct ref_entry
**)a
;
429 struct ref_entry
*two
= *(struct ref_entry
**)b
;
430 return strcmp(one
->name
, two
->name
);
433 static void sort_ref_dir(struct ref_dir
*dir
);
435 struct string_slice
{
440 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
442 const struct string_slice
*key
= key_
;
443 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
444 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
447 return '\0' - (unsigned char)ent
->name
[key
->len
];
451 * Return the index of the entry with the given refname from the
452 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
453 * no such entry is found. dir must already be complete.
455 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
457 struct ref_entry
**r
;
458 struct string_slice key
;
460 if (refname
== NULL
|| !dir
->nr
)
466 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
467 ref_entry_cmp_sslice
);
472 return r
- dir
->entries
;
476 * Search for a directory entry directly within dir (without
477 * recursing). Sort dir if necessary. subdirname must be a directory
478 * name (i.e., end in '/'). If mkdir is set, then create the
479 * directory if it is missing; otherwise, return NULL if the desired
480 * directory cannot be found. dir must already be complete.
482 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
483 const char *subdirname
, size_t len
,
486 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
487 struct ref_entry
*entry
;
488 if (entry_index
== -1) {
492 * Since dir is complete, the absence of a subdir
493 * means that the subdir really doesn't exist;
494 * therefore, create an empty record for it but mark
495 * the record complete.
497 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
498 add_entry_to_dir(dir
, entry
);
500 entry
= dir
->entries
[entry_index
];
502 return get_ref_dir(entry
);
506 * If refname is a reference name, find the ref_dir within the dir
507 * tree that should hold refname. If refname is a directory name
508 * (i.e., ends in '/'), then return that ref_dir itself. dir must
509 * represent the top-level directory and must already be complete.
510 * Sort ref_dirs and recurse into subdirectories as necessary. If
511 * mkdir is set, then create any missing directories; otherwise,
512 * return NULL if the desired directory cannot be found.
514 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
515 const char *refname
, int mkdir
)
518 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
519 size_t dirnamelen
= slash
- refname
+ 1;
520 struct ref_dir
*subdir
;
521 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
533 * Find the value entry with the given name in dir, sorting ref_dirs
534 * and recursing into subdirectories as necessary. If the name is not
535 * found or it corresponds to a directory entry, return NULL.
537 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
540 struct ref_entry
*entry
;
541 dir
= find_containing_dir(dir
, refname
, 0);
544 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
545 if (entry_index
== -1)
547 entry
= dir
->entries
[entry_index
];
548 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
552 * Remove the entry with the given name from dir, recursing into
553 * subdirectories as necessary. If refname is the name of a directory
554 * (i.e., ends with '/'), then remove the directory and its contents.
555 * If the removal was successful, return the number of entries
556 * remaining in the directory entry that contained the deleted entry.
557 * If the name was not found, return -1. Please note that this
558 * function only deletes the entry from the cache; it does not delete
559 * it from the filesystem or ensure that other cache entries (which
560 * might be symbolic references to the removed entry) are updated.
561 * Nor does it remove any containing dir entries that might be made
562 * empty by the removal. dir must represent the top-level directory
563 * and must already be complete.
565 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
567 int refname_len
= strlen(refname
);
569 struct ref_entry
*entry
;
570 int is_dir
= refname
[refname_len
- 1] == '/';
573 * refname represents a reference directory. Remove
574 * the trailing slash; otherwise we will get the
575 * directory *representing* refname rather than the
576 * one *containing* it.
578 char *dirname
= xmemdupz(refname
, refname_len
- 1);
579 dir
= find_containing_dir(dir
, dirname
, 0);
582 dir
= find_containing_dir(dir
, refname
, 0);
586 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
587 if (entry_index
== -1)
589 entry
= dir
->entries
[entry_index
];
591 memmove(&dir
->entries
[entry_index
],
592 &dir
->entries
[entry_index
+ 1],
593 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
596 if (dir
->sorted
> entry_index
)
598 free_ref_entry(entry
);
603 * Add a ref_entry to the ref_dir (unsorted), recursing into
604 * subdirectories as necessary. dir must represent the top-level
605 * directory. Return 0 on success.
607 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
609 dir
= find_containing_dir(dir
, ref
->name
, 1);
612 add_entry_to_dir(dir
, ref
);
617 * Emit a warning and return true iff ref1 and ref2 have the same name
618 * and the same sha1. Die if they have the same name but different
621 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
623 if (strcmp(ref1
->name
, ref2
->name
))
626 /* Duplicate name; make sure that they don't conflict: */
628 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
629 /* This is impossible by construction */
630 die("Reference directory conflict: %s", ref1
->name
);
632 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
633 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
635 warning("Duplicated ref: %s", ref1
->name
);
640 * Sort the entries in dir non-recursively (if they are not already
641 * sorted) and remove any duplicate entries.
643 static void sort_ref_dir(struct ref_dir
*dir
)
646 struct ref_entry
*last
= NULL
;
649 * This check also prevents passing a zero-length array to qsort(),
650 * which is a problem on some platforms.
652 if (dir
->sorted
== dir
->nr
)
655 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
657 /* Remove any duplicates: */
658 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
659 struct ref_entry
*entry
= dir
->entries
[j
];
660 if (last
&& is_dup_ref(last
, entry
))
661 free_ref_entry(entry
);
663 last
= dir
->entries
[i
++] = entry
;
665 dir
->sorted
= dir
->nr
= i
;
668 /* Include broken references in a do_for_each_ref*() iteration: */
669 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
672 * Return true iff the reference described by entry can be resolved to
673 * an object in the database. Emit a warning if the referred-to
674 * object does not exist.
676 static int ref_resolves_to_object(struct ref_entry
*entry
)
678 if (entry
->flag
& REF_ISBROKEN
)
680 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
681 error("%s does not point to a valid object!", entry
->name
);
688 * current_ref is a performance hack: when iterating over references
689 * using the for_each_ref*() functions, current_ref is set to the
690 * current reference's entry before calling the callback function. If
691 * the callback function calls peel_ref(), then peel_ref() first
692 * checks whether the reference to be peeled is the current reference
693 * (it usually is) and if so, returns that reference's peeled version
694 * if it is available. This avoids a refname lookup in a common case.
696 static struct ref_entry
*current_ref
;
698 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
700 struct ref_entry_cb
{
709 * Handle one reference in a do_for_each_ref*()-style iteration,
710 * calling an each_ref_fn for each entry.
712 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
714 struct ref_entry_cb
*data
= cb_data
;
715 struct ref_entry
*old_current_ref
;
718 if (!starts_with(entry
->name
, data
->base
))
721 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
722 !ref_resolves_to_object(entry
))
725 /* Store the old value, in case this is a recursive call: */
726 old_current_ref
= current_ref
;
728 retval
= data
->fn(entry
->name
+ data
->trim
, entry
->u
.value
.sha1
,
729 entry
->flag
, data
->cb_data
);
730 current_ref
= old_current_ref
;
735 * Call fn for each reference in dir that has index in the range
736 * offset <= index < dir->nr. Recurse into subdirectories that are in
737 * that index range, sorting them before iterating. This function
738 * does not sort dir itself; it should be sorted beforehand. fn is
739 * called for all references, including broken ones.
741 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
742 each_ref_entry_fn fn
, void *cb_data
)
745 assert(dir
->sorted
== dir
->nr
);
746 for (i
= offset
; i
< dir
->nr
; i
++) {
747 struct ref_entry
*entry
= dir
->entries
[i
];
749 if (entry
->flag
& REF_DIR
) {
750 struct ref_dir
*subdir
= get_ref_dir(entry
);
751 sort_ref_dir(subdir
);
752 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
754 retval
= fn(entry
, cb_data
);
763 * Call fn for each reference in the union of dir1 and dir2, in order
764 * by refname. Recurse into subdirectories. If a value entry appears
765 * in both dir1 and dir2, then only process the version that is in
766 * dir2. The input dirs must already be sorted, but subdirs will be
767 * sorted as needed. fn is called for all references, including
770 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
771 struct ref_dir
*dir2
,
772 each_ref_entry_fn fn
, void *cb_data
)
777 assert(dir1
->sorted
== dir1
->nr
);
778 assert(dir2
->sorted
== dir2
->nr
);
780 struct ref_entry
*e1
, *e2
;
782 if (i1
== dir1
->nr
) {
783 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
785 if (i2
== dir2
->nr
) {
786 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
788 e1
= dir1
->entries
[i1
];
789 e2
= dir2
->entries
[i2
];
790 cmp
= strcmp(e1
->name
, e2
->name
);
792 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
793 /* Both are directories; descend them in parallel. */
794 struct ref_dir
*subdir1
= get_ref_dir(e1
);
795 struct ref_dir
*subdir2
= get_ref_dir(e2
);
796 sort_ref_dir(subdir1
);
797 sort_ref_dir(subdir2
);
798 retval
= do_for_each_entry_in_dirs(
799 subdir1
, subdir2
, fn
, cb_data
);
802 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
803 /* Both are references; ignore the one from dir1. */
804 retval
= fn(e2
, cb_data
);
808 die("conflict between reference and directory: %s",
820 if (e
->flag
& REF_DIR
) {
821 struct ref_dir
*subdir
= get_ref_dir(e
);
822 sort_ref_dir(subdir
);
823 retval
= do_for_each_entry_in_dir(
824 subdir
, 0, fn
, cb_data
);
826 retval
= fn(e
, cb_data
);
835 * Load all of the refs from the dir into our in-memory cache. The hard work
836 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
837 * through all of the sub-directories. We do not even need to care about
838 * sorting, as traversal order does not matter to us.
840 static void prime_ref_dir(struct ref_dir
*dir
)
843 for (i
= 0; i
< dir
->nr
; i
++) {
844 struct ref_entry
*entry
= dir
->entries
[i
];
845 if (entry
->flag
& REF_DIR
)
846 prime_ref_dir(get_ref_dir(entry
));
850 static int entry_matches(struct ref_entry
*entry
, const struct string_list
*list
)
852 return list
&& string_list_has_string(list
, entry
->name
);
855 struct nonmatching_ref_data
{
856 const struct string_list
*skip
;
857 struct ref_entry
*found
;
860 static int nonmatching_ref_fn(struct ref_entry
*entry
, void *vdata
)
862 struct nonmatching_ref_data
*data
= vdata
;
864 if (entry_matches(entry
, data
->skip
))
871 static void report_refname_conflict(struct ref_entry
*entry
,
874 error("'%s' exists; cannot create '%s'", entry
->name
, refname
);
878 * Return true iff a reference named refname could be created without
879 * conflicting with the name of an existing reference in dir. If
880 * skip is non-NULL, ignore potential conflicts with refs in skip
881 * (e.g., because they are scheduled for deletion in the same
884 * Two reference names conflict if one of them exactly matches the
885 * leading components of the other; e.g., "foo/bar" conflicts with
886 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
889 * skip must be sorted.
891 static int is_refname_available(const char *refname
,
892 const struct string_list
*skip
,
900 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
902 * We are still at a leading dir of the refname; we are
903 * looking for a conflict with a leaf entry.
905 * If we find one, we still must make sure it is
908 pos
= search_ref_dir(dir
, refname
, slash
- refname
);
910 struct ref_entry
*entry
= dir
->entries
[pos
];
911 if (entry_matches(entry
, skip
))
913 report_refname_conflict(entry
, refname
);
919 * Otherwise, we can try to continue our search with
920 * the next component; if we come up empty, we know
921 * there is nothing under this whole prefix.
923 pos
= search_ref_dir(dir
, refname
, slash
+ 1 - refname
);
927 dir
= get_ref_dir(dir
->entries
[pos
]);
931 * We are at the leaf of our refname; we want to
932 * make sure there are no directories which match it.
934 len
= strlen(refname
);
935 dirname
= xmallocz(len
+ 1);
936 sprintf(dirname
, "%s/", refname
);
937 pos
= search_ref_dir(dir
, dirname
, len
+ 1);
942 * We found a directory named "refname". It is a
943 * problem iff it contains any ref that is not
946 struct ref_entry
*entry
= dir
->entries
[pos
];
947 struct ref_dir
*dir
= get_ref_dir(entry
);
948 struct nonmatching_ref_data data
;
952 if (!do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
))
955 report_refname_conflict(data
.found
, refname
);
960 * There is no point in searching for another leaf
961 * node which matches it; such an entry would be the
962 * ref we are looking for, not a conflict.
967 struct packed_ref_cache
{
968 struct ref_entry
*root
;
971 * Count of references to the data structure in this instance,
972 * including the pointer from ref_cache::packed if any. The
973 * data will not be freed as long as the reference count is
976 unsigned int referrers
;
979 * Iff the packed-refs file associated with this instance is
980 * currently locked for writing, this points at the associated
981 * lock (which is owned by somebody else). The referrer count
982 * is also incremented when the file is locked and decremented
983 * when it is unlocked.
985 struct lock_file
*lock
;
987 /* The metadata from when this packed-refs cache was read */
988 struct stat_validity validity
;
992 * Future: need to be in "struct repository"
993 * when doing a full libification.
995 static struct ref_cache
{
996 struct ref_cache
*next
;
997 struct ref_entry
*loose
;
998 struct packed_ref_cache
*packed
;
1000 * The submodule name, or "" for the main repo. We allocate
1001 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1002 * is initialized correctly.
1005 } ref_cache
, *submodule_ref_caches
;
1007 /* Lock used for the main packed-refs file: */
1008 static struct lock_file packlock
;
1011 * Increment the reference count of *packed_refs.
1013 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1015 packed_refs
->referrers
++;
1019 * Decrease the reference count of *packed_refs. If it goes to zero,
1020 * free *packed_refs and return true; otherwise return false.
1022 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1024 if (!--packed_refs
->referrers
) {
1025 free_ref_entry(packed_refs
->root
);
1026 stat_validity_clear(&packed_refs
->validity
);
1034 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1037 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1039 if (packed_refs
->lock
)
1040 die("internal error: packed-ref cache cleared while locked");
1041 refs
->packed
= NULL
;
1042 release_packed_ref_cache(packed_refs
);
1046 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1049 free_ref_entry(refs
->loose
);
1054 static struct ref_cache
*create_ref_cache(const char *submodule
)
1057 struct ref_cache
*refs
;
1060 len
= strlen(submodule
) + 1;
1061 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1062 memcpy(refs
->name
, submodule
, len
);
1067 * Return a pointer to a ref_cache for the specified submodule. For
1068 * the main repository, use submodule==NULL. The returned structure
1069 * will be allocated and initialized but not necessarily populated; it
1070 * should not be freed.
1072 static struct ref_cache
*get_ref_cache(const char *submodule
)
1074 struct ref_cache
*refs
;
1076 if (!submodule
|| !*submodule
)
1079 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1080 if (!strcmp(submodule
, refs
->name
))
1083 refs
= create_ref_cache(submodule
);
1084 refs
->next
= submodule_ref_caches
;
1085 submodule_ref_caches
= refs
;
1089 /* The length of a peeled reference line in packed-refs, including EOL: */
1090 #define PEELED_LINE_LENGTH 42
1093 * The packed-refs header line that we write out. Perhaps other
1094 * traits will be added later. The trailing space is required.
1096 static const char PACKED_REFS_HEADER
[] =
1097 "# pack-refs with: peeled fully-peeled \n";
1100 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1101 * Return a pointer to the refname within the line (null-terminated),
1102 * or NULL if there was a problem.
1104 static const char *parse_ref_line(struct strbuf
*line
, unsigned char *sha1
)
1109 * 42: the answer to everything.
1111 * In this case, it happens to be the answer to
1112 * 40 (length of sha1 hex representation)
1113 * +1 (space in between hex and name)
1114 * +1 (newline at the end of the line)
1116 if (line
->len
<= 42)
1119 if (get_sha1_hex(line
->buf
, sha1
) < 0)
1121 if (!isspace(line
->buf
[40]))
1124 ref
= line
->buf
+ 41;
1128 if (line
->buf
[line
->len
- 1] != '\n')
1130 line
->buf
[--line
->len
] = 0;
1136 * Read f, which is a packed-refs file, into dir.
1138 * A comment line of the form "# pack-refs with: " may contain zero or
1139 * more traits. We interpret the traits as follows:
1143 * Probably no references are peeled. But if the file contains a
1144 * peeled value for a reference, we will use it.
1148 * References under "refs/tags/", if they *can* be peeled, *are*
1149 * peeled in this file. References outside of "refs/tags/" are
1150 * probably not peeled even if they could have been, but if we find
1151 * a peeled value for such a reference we will use it.
1155 * All references in the file that can be peeled are peeled.
1156 * Inversely (and this is more important), any references in the
1157 * file for which no peeled value is recorded is not peelable. This
1158 * trait should typically be written alongside "peeled" for
1159 * compatibility with older clients, but we do not require it
1160 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1162 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1164 struct ref_entry
*last
= NULL
;
1165 struct strbuf line
= STRBUF_INIT
;
1166 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1168 while (strbuf_getwholeline(&line
, f
, '\n') != EOF
) {
1169 unsigned char sha1
[20];
1170 const char *refname
;
1173 if (skip_prefix(line
.buf
, "# pack-refs with:", &traits
)) {
1174 if (strstr(traits
, " fully-peeled "))
1175 peeled
= PEELED_FULLY
;
1176 else if (strstr(traits
, " peeled "))
1177 peeled
= PEELED_TAGS
;
1178 /* perhaps other traits later as well */
1182 refname
= parse_ref_line(&line
, sha1
);
1184 int flag
= REF_ISPACKED
;
1186 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1188 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1190 last
= create_ref_entry(refname
, sha1
, flag
, 0);
1191 if (peeled
== PEELED_FULLY
||
1192 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1193 last
->flag
|= REF_KNOWS_PEELED
;
1198 line
.buf
[0] == '^' &&
1199 line
.len
== PEELED_LINE_LENGTH
&&
1200 line
.buf
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1201 !get_sha1_hex(line
.buf
+ 1, sha1
)) {
1202 hashcpy(last
->u
.value
.peeled
, sha1
);
1204 * Regardless of what the file header said,
1205 * we definitely know the value of *this*
1208 last
->flag
|= REF_KNOWS_PEELED
;
1212 strbuf_release(&line
);
1216 * Get the packed_ref_cache for the specified ref_cache, creating it
1219 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1221 const char *packed_refs_file
;
1224 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1226 packed_refs_file
= git_path("packed-refs");
1229 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1230 clear_packed_ref_cache(refs
);
1232 if (!refs
->packed
) {
1235 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1236 acquire_packed_ref_cache(refs
->packed
);
1237 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1238 f
= fopen(packed_refs_file
, "r");
1240 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1241 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1245 return refs
->packed
;
1248 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1250 return get_ref_dir(packed_ref_cache
->root
);
1253 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1255 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1258 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1260 struct packed_ref_cache
*packed_ref_cache
=
1261 get_packed_ref_cache(&ref_cache
);
1263 if (!packed_ref_cache
->lock
)
1264 die("internal error: packed refs not locked");
1265 add_ref(get_packed_ref_dir(packed_ref_cache
),
1266 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1270 * Read the loose references from the namespace dirname into dir
1271 * (without recursing). dirname must end with '/'. dir must be the
1272 * directory entry corresponding to dirname.
1274 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1276 struct ref_cache
*refs
= dir
->ref_cache
;
1280 int dirnamelen
= strlen(dirname
);
1281 struct strbuf refname
;
1284 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1286 path
= git_path("%s", dirname
);
1292 strbuf_init(&refname
, dirnamelen
+ 257);
1293 strbuf_add(&refname
, dirname
, dirnamelen
);
1295 while ((de
= readdir(d
)) != NULL
) {
1296 unsigned char sha1
[20];
1301 if (de
->d_name
[0] == '.')
1303 if (ends_with(de
->d_name
, ".lock"))
1305 strbuf_addstr(&refname
, de
->d_name
);
1306 refdir
= *refs
->name
1307 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1308 : git_path("%s", refname
.buf
);
1309 if (stat(refdir
, &st
) < 0) {
1310 ; /* silently ignore */
1311 } else if (S_ISDIR(st
.st_mode
)) {
1312 strbuf_addch(&refname
, '/');
1313 add_entry_to_dir(dir
,
1314 create_dir_entry(refs
, refname
.buf
,
1320 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
1322 flag
|= REF_ISBROKEN
;
1324 } else if (read_ref_full(refname
.buf
,
1325 RESOLVE_REF_READING
,
1328 flag
|= REF_ISBROKEN
;
1330 if (check_refname_format(refname
.buf
,
1331 REFNAME_ALLOW_ONELEVEL
)) {
1333 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1335 add_entry_to_dir(dir
,
1336 create_ref_entry(refname
.buf
, sha1
, flag
, 0));
1338 strbuf_setlen(&refname
, dirnamelen
);
1340 strbuf_release(&refname
);
1344 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1348 * Mark the top-level directory complete because we
1349 * are about to read the only subdirectory that can
1352 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1354 * Create an incomplete entry for "refs/":
1356 add_entry_to_dir(get_ref_dir(refs
->loose
),
1357 create_dir_entry(refs
, "refs/", 5, 1));
1359 return get_ref_dir(refs
->loose
);
1362 /* We allow "recursive" symbolic refs. Only within reason, though */
1364 #define MAXREFLEN (1024)
1367 * Called by resolve_gitlink_ref_recursive() after it failed to read
1368 * from the loose refs in ref_cache refs. Find <refname> in the
1369 * packed-refs file for the submodule.
1371 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1372 const char *refname
, unsigned char *sha1
)
1374 struct ref_entry
*ref
;
1375 struct ref_dir
*dir
= get_packed_refs(refs
);
1377 ref
= find_ref(dir
, refname
);
1381 hashcpy(sha1
, ref
->u
.value
.sha1
);
1385 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1386 const char *refname
, unsigned char *sha1
,
1390 char buffer
[128], *p
;
1393 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1396 ? git_path_submodule(refs
->name
, "%s", refname
)
1397 : git_path("%s", refname
);
1398 fd
= open(path
, O_RDONLY
);
1400 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1402 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1406 while (len
&& isspace(buffer
[len
-1]))
1410 /* Was it a detached head or an old-fashioned symlink? */
1411 if (!get_sha1_hex(buffer
, sha1
))
1415 if (strncmp(buffer
, "ref:", 4))
1421 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1424 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1426 int len
= strlen(path
), retval
;
1428 struct ref_cache
*refs
;
1430 while (len
&& path
[len
-1] == '/')
1434 submodule
= xstrndup(path
, len
);
1435 refs
= get_ref_cache(submodule
);
1438 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1443 * Return the ref_entry for the given refname from the packed
1444 * references. If it does not exist, return NULL.
1446 static struct ref_entry
*get_packed_ref(const char *refname
)
1448 return find_ref(get_packed_refs(&ref_cache
), refname
);
1452 * A loose ref file doesn't exist; check for a packed ref. The
1453 * options are forwarded from resolve_safe_unsafe().
1455 static int resolve_missing_loose_ref(const char *refname
,
1457 unsigned char *sha1
,
1460 struct ref_entry
*entry
;
1463 * The loose reference file does not exist; check for a packed
1466 entry
= get_packed_ref(refname
);
1468 hashcpy(sha1
, entry
->u
.value
.sha1
);
1470 *flags
|= REF_ISPACKED
;
1473 /* The reference is not a packed reference, either. */
1474 if (resolve_flags
& RESOLVE_REF_READING
) {
1483 /* This function needs to return a meaningful errno on failure */
1484 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1486 int depth
= MAXDEPTH
;
1489 static char refname_buffer
[256];
1495 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1497 *flags
|= REF_BAD_NAME
;
1499 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1500 !refname_is_safe(refname
)) {
1505 * dwim_ref() uses REF_ISBROKEN to distinguish between
1506 * missing refs and refs that were present but invalid,
1507 * to complain about the latter to stderr.
1509 * We don't know whether the ref exists, so don't set
1515 char path
[PATH_MAX
];
1525 git_snpath(path
, sizeof(path
), "%s", refname
);
1528 * We might have to loop back here to avoid a race
1529 * condition: first we lstat() the file, then we try
1530 * to read it as a link or as a file. But if somebody
1531 * changes the type of the file (file <-> directory
1532 * <-> symlink) between the lstat() and reading, then
1533 * we don't want to report that as an error but rather
1534 * try again starting with the lstat().
1537 if (lstat(path
, &st
) < 0) {
1538 if (errno
!= ENOENT
)
1540 if (resolve_missing_loose_ref(refname
, resolve_flags
,
1546 *flags
|= REF_ISBROKEN
;
1551 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1552 if (S_ISLNK(st
.st_mode
)) {
1553 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1555 if (errno
== ENOENT
|| errno
== EINVAL
)
1556 /* inconsistent with lstat; retry */
1562 if (starts_with(buffer
, "refs/") &&
1563 !check_refname_format(buffer
, 0)) {
1564 strcpy(refname_buffer
, buffer
);
1565 refname
= refname_buffer
;
1567 *flags
|= REF_ISSYMREF
;
1568 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1576 /* Is it a directory? */
1577 if (S_ISDIR(st
.st_mode
)) {
1583 * Anything else, just open it and try to use it as
1586 fd
= open(path
, O_RDONLY
);
1588 if (errno
== ENOENT
)
1589 /* inconsistent with lstat; retry */
1594 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1596 int save_errno
= errno
;
1602 while (len
&& isspace(buffer
[len
-1]))
1607 * Is it a symbolic ref?
1609 if (!starts_with(buffer
, "ref:")) {
1611 * Please note that FETCH_HEAD has a second
1612 * line containing other data.
1614 if (get_sha1_hex(buffer
, sha1
) ||
1615 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1617 *flags
|= REF_ISBROKEN
;
1624 *flags
|= REF_ISBROKEN
;
1629 *flags
|= REF_ISSYMREF
;
1631 while (isspace(*buf
))
1633 refname
= strcpy(refname_buffer
, buf
);
1634 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1638 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1640 *flags
|= REF_ISBROKEN
;
1642 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1643 !refname_is_safe(buf
)) {
1652 char *resolve_refdup(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1654 return xstrdup_or_null(resolve_ref_unsafe(ref
, resolve_flags
, sha1
, flags
));
1657 /* The argument to filter_refs */
1659 const char *pattern
;
1664 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1666 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1671 int read_ref(const char *refname
, unsigned char *sha1
)
1673 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1676 int ref_exists(const char *refname
)
1678 unsigned char sha1
[20];
1679 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1682 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1685 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1686 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1688 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1692 /* object was peeled successfully: */
1696 * object cannot be peeled because the named object (or an
1697 * object referred to by a tag in the peel chain), does not
1702 /* object cannot be peeled because it is not a tag: */
1705 /* ref_entry contains no peeled value because it is a symref: */
1706 PEEL_IS_SYMREF
= -3,
1709 * ref_entry cannot be peeled because it is broken (i.e., the
1710 * symbolic reference cannot even be resolved to an object
1717 * Peel the named object; i.e., if the object is a tag, resolve the
1718 * tag recursively until a non-tag is found. If successful, store the
1719 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1720 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1721 * and leave sha1 unchanged.
1723 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1725 struct object
*o
= lookup_unknown_object(name
);
1727 if (o
->type
== OBJ_NONE
) {
1728 int type
= sha1_object_info(name
, NULL
);
1729 if (type
< 0 || !object_as_type(o
, type
, 0))
1730 return PEEL_INVALID
;
1733 if (o
->type
!= OBJ_TAG
)
1734 return PEEL_NON_TAG
;
1736 o
= deref_tag_noverify(o
);
1738 return PEEL_INVALID
;
1740 hashcpy(sha1
, o
->sha1
);
1745 * Peel the entry (if possible) and return its new peel_status. If
1746 * repeel is true, re-peel the entry even if there is an old peeled
1747 * value that is already stored in it.
1749 * It is OK to call this function with a packed reference entry that
1750 * might be stale and might even refer to an object that has since
1751 * been garbage-collected. In such a case, if the entry has
1752 * REF_KNOWS_PEELED then leave the status unchanged and return
1753 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1755 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1757 enum peel_status status
;
1759 if (entry
->flag
& REF_KNOWS_PEELED
) {
1761 entry
->flag
&= ~REF_KNOWS_PEELED
;
1762 hashclr(entry
->u
.value
.peeled
);
1764 return is_null_sha1(entry
->u
.value
.peeled
) ?
1765 PEEL_NON_TAG
: PEEL_PEELED
;
1768 if (entry
->flag
& REF_ISBROKEN
)
1770 if (entry
->flag
& REF_ISSYMREF
)
1771 return PEEL_IS_SYMREF
;
1773 status
= peel_object(entry
->u
.value
.sha1
, entry
->u
.value
.peeled
);
1774 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1775 entry
->flag
|= REF_KNOWS_PEELED
;
1779 int peel_ref(const char *refname
, unsigned char *sha1
)
1782 unsigned char base
[20];
1784 if (current_ref
&& (current_ref
->name
== refname
1785 || !strcmp(current_ref
->name
, refname
))) {
1786 if (peel_entry(current_ref
, 0))
1788 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1792 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1796 * If the reference is packed, read its ref_entry from the
1797 * cache in the hope that we already know its peeled value.
1798 * We only try this optimization on packed references because
1799 * (a) forcing the filling of the loose reference cache could
1800 * be expensive and (b) loose references anyway usually do not
1801 * have REF_KNOWS_PEELED.
1803 if (flag
& REF_ISPACKED
) {
1804 struct ref_entry
*r
= get_packed_ref(refname
);
1806 if (peel_entry(r
, 0))
1808 hashcpy(sha1
, r
->u
.value
.peeled
);
1813 return peel_object(base
, sha1
);
1816 struct warn_if_dangling_data
{
1818 const char *refname
;
1819 const struct string_list
*refnames
;
1820 const char *msg_fmt
;
1823 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1824 int flags
, void *cb_data
)
1826 struct warn_if_dangling_data
*d
= cb_data
;
1827 const char *resolves_to
;
1828 unsigned char junk
[20];
1830 if (!(flags
& REF_ISSYMREF
))
1833 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
, NULL
);
1836 ? strcmp(resolves_to
, d
->refname
)
1837 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1841 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1846 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1848 struct warn_if_dangling_data data
;
1851 data
.refname
= refname
;
1852 data
.refnames
= NULL
;
1853 data
.msg_fmt
= msg_fmt
;
1854 for_each_rawref(warn_if_dangling_symref
, &data
);
1857 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1859 struct warn_if_dangling_data data
;
1862 data
.refname
= NULL
;
1863 data
.refnames
= refnames
;
1864 data
.msg_fmt
= msg_fmt
;
1865 for_each_rawref(warn_if_dangling_symref
, &data
);
1869 * Call fn for each reference in the specified ref_cache, omitting
1870 * references not in the containing_dir of base. fn is called for all
1871 * references, including broken ones. If fn ever returns a non-zero
1872 * value, stop the iteration and return that value; otherwise, return
1875 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1876 each_ref_entry_fn fn
, void *cb_data
)
1878 struct packed_ref_cache
*packed_ref_cache
;
1879 struct ref_dir
*loose_dir
;
1880 struct ref_dir
*packed_dir
;
1884 * We must make sure that all loose refs are read before accessing the
1885 * packed-refs file; this avoids a race condition in which loose refs
1886 * are migrated to the packed-refs file by a simultaneous process, but
1887 * our in-memory view is from before the migration. get_packed_ref_cache()
1888 * takes care of making sure our view is up to date with what is on
1891 loose_dir
= get_loose_refs(refs
);
1892 if (base
&& *base
) {
1893 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1896 prime_ref_dir(loose_dir
);
1898 packed_ref_cache
= get_packed_ref_cache(refs
);
1899 acquire_packed_ref_cache(packed_ref_cache
);
1900 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1901 if (base
&& *base
) {
1902 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1905 if (packed_dir
&& loose_dir
) {
1906 sort_ref_dir(packed_dir
);
1907 sort_ref_dir(loose_dir
);
1908 retval
= do_for_each_entry_in_dirs(
1909 packed_dir
, loose_dir
, fn
, cb_data
);
1910 } else if (packed_dir
) {
1911 sort_ref_dir(packed_dir
);
1912 retval
= do_for_each_entry_in_dir(
1913 packed_dir
, 0, fn
, cb_data
);
1914 } else if (loose_dir
) {
1915 sort_ref_dir(loose_dir
);
1916 retval
= do_for_each_entry_in_dir(
1917 loose_dir
, 0, fn
, cb_data
);
1920 release_packed_ref_cache(packed_ref_cache
);
1925 * Call fn for each reference in the specified ref_cache for which the
1926 * refname begins with base. If trim is non-zero, then trim that many
1927 * characters off the beginning of each refname before passing the
1928 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1929 * broken references in the iteration. If fn ever returns a non-zero
1930 * value, stop the iteration and return that value; otherwise, return
1933 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
1934 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1936 struct ref_entry_cb data
;
1941 data
.cb_data
= cb_data
;
1943 if (ref_paranoia
< 0)
1944 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1946 data
.flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1948 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
1951 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1953 unsigned char sha1
[20];
1957 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1958 return fn("HEAD", sha1
, 0, cb_data
);
1963 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, sha1
, &flag
))
1964 return fn("HEAD", sha1
, flag
, cb_data
);
1969 int head_ref(each_ref_fn fn
, void *cb_data
)
1971 return do_head_ref(NULL
, fn
, cb_data
);
1974 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1976 return do_head_ref(submodule
, fn
, cb_data
);
1979 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1981 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
1984 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1986 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
1989 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1991 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1994 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
1995 each_ref_fn fn
, void *cb_data
)
1997 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
2000 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
2002 return for_each_ref_in("refs/tags/", fn
, cb_data
);
2005 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2007 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
2010 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
2012 return for_each_ref_in("refs/heads/", fn
, cb_data
);
2015 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2017 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2020 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2022 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2025 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2027 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2030 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2032 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
2035 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2037 struct strbuf buf
= STRBUF_INIT
;
2039 unsigned char sha1
[20];
2042 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2043 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, sha1
, &flag
))
2044 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
2045 strbuf_release(&buf
);
2050 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2052 struct strbuf buf
= STRBUF_INIT
;
2054 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2055 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2056 strbuf_release(&buf
);
2060 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2061 const char *prefix
, void *cb_data
)
2063 struct strbuf real_pattern
= STRBUF_INIT
;
2064 struct ref_filter filter
;
2067 if (!prefix
&& !starts_with(pattern
, "refs/"))
2068 strbuf_addstr(&real_pattern
, "refs/");
2070 strbuf_addstr(&real_pattern
, prefix
);
2071 strbuf_addstr(&real_pattern
, pattern
);
2073 if (!has_glob_specials(pattern
)) {
2074 /* Append implied '/' '*' if not present. */
2075 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2076 strbuf_addch(&real_pattern
, '/');
2077 /* No need to check for '*', there is none. */
2078 strbuf_addch(&real_pattern
, '*');
2081 filter
.pattern
= real_pattern
.buf
;
2083 filter
.cb_data
= cb_data
;
2084 ret
= for_each_ref(filter_refs
, &filter
);
2086 strbuf_release(&real_pattern
);
2090 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2092 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2095 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2097 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2098 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2101 const char *prettify_refname(const char *name
)
2104 starts_with(name
, "refs/heads/") ? 11 :
2105 starts_with(name
, "refs/tags/") ? 10 :
2106 starts_with(name
, "refs/remotes/") ? 13 :
2110 static const char *ref_rev_parse_rules
[] = {
2115 "refs/remotes/%.*s",
2116 "refs/remotes/%.*s/HEAD",
2120 int refname_match(const char *abbrev_name
, const char *full_name
)
2123 const int abbrev_name_len
= strlen(abbrev_name
);
2125 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2126 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2134 static void unlock_ref(struct ref_lock
*lock
)
2136 /* Do not free lock->lk -- atexit() still looks at them */
2138 rollback_lock_file(lock
->lk
);
2139 free(lock
->ref_name
);
2140 free(lock
->orig_ref_name
);
2144 /* This function should make sure errno is meaningful on error */
2145 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
2146 const unsigned char *old_sha1
, int mustexist
)
2148 if (read_ref_full(lock
->ref_name
,
2149 mustexist
? RESOLVE_REF_READING
: 0,
2150 lock
->old_sha1
, NULL
)) {
2151 int save_errno
= errno
;
2152 error("Can't verify ref %s", lock
->ref_name
);
2157 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
2158 error("Ref %s is at %s but expected %s", lock
->ref_name
,
2159 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
2167 static int remove_empty_directories(const char *file
)
2169 /* we want to create a file but there is a directory there;
2170 * if that is an empty directory (or a directory that contains
2171 * only empty directories), remove them.
2174 int result
, save_errno
;
2176 strbuf_init(&path
, 20);
2177 strbuf_addstr(&path
, file
);
2179 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2182 strbuf_release(&path
);
2189 * *string and *len will only be substituted, and *string returned (for
2190 * later free()ing) if the string passed in is a magic short-hand form
2193 static char *substitute_branch_name(const char **string
, int *len
)
2195 struct strbuf buf
= STRBUF_INIT
;
2196 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2200 *string
= strbuf_detach(&buf
, &size
);
2202 return (char *)*string
;
2208 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2210 char *last_branch
= substitute_branch_name(&str
, &len
);
2215 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2216 char fullref
[PATH_MAX
];
2217 unsigned char sha1_from_ref
[20];
2218 unsigned char *this_result
;
2221 this_result
= refs_found
? sha1_from_ref
: sha1
;
2222 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2223 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2224 this_result
, &flag
);
2228 if (!warn_ambiguous_refs
)
2230 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2231 warning("ignoring dangling symref %s.", fullref
);
2232 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2233 warning("ignoring broken ref %s.", fullref
);
2240 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2242 char *last_branch
= substitute_branch_name(&str
, &len
);
2247 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2248 unsigned char hash
[20];
2249 char path
[PATH_MAX
];
2250 const char *ref
, *it
;
2252 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2253 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2257 if (reflog_exists(path
))
2259 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2263 if (!logs_found
++) {
2265 hashcpy(sha1
, hash
);
2267 if (!warn_ambiguous_refs
)
2275 * Locks a ref returning the lock on success and NULL on failure.
2276 * On failure errno is set to something meaningful.
2278 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2279 const unsigned char *old_sha1
,
2280 const struct string_list
*skip
,
2281 unsigned int flags
, int *type_p
)
2284 const char *orig_refname
= refname
;
2285 struct ref_lock
*lock
;
2288 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2289 int resolve_flags
= 0;
2290 int attempts_remaining
= 3;
2292 lock
= xcalloc(1, sizeof(struct ref_lock
));
2296 resolve_flags
|= RESOLVE_REF_READING
;
2297 if (flags
& REF_DELETING
) {
2298 resolve_flags
|= RESOLVE_REF_ALLOW_BAD_NAME
;
2299 if (flags
& REF_NODEREF
)
2300 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2303 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2304 lock
->old_sha1
, &type
);
2305 if (!refname
&& errno
== EISDIR
) {
2306 /* we are trying to lock foo but we used to
2307 * have foo/bar which now does not exist;
2308 * it is normal for the empty directory 'foo'
2311 ref_file
= git_path("%s", orig_refname
);
2312 if (remove_empty_directories(ref_file
)) {
2314 error("there are still refs under '%s'", orig_refname
);
2317 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2318 lock
->old_sha1
, &type
);
2324 error("unable to resolve reference %s: %s",
2325 orig_refname
, strerror(errno
));
2329 * If the ref did not exist and we are creating it, make sure
2330 * there is no existing packed ref whose name begins with our
2331 * refname, nor a packed ref whose name is a proper prefix of
2334 if (is_null_sha1(lock
->old_sha1
) &&
2335 !is_refname_available(refname
, skip
, get_packed_refs(&ref_cache
))) {
2336 last_errno
= ENOTDIR
;
2340 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2343 if (flags
& REF_NODEREF
) {
2344 refname
= orig_refname
;
2345 lflags
|= LOCK_NO_DEREF
;
2347 lock
->ref_name
= xstrdup(refname
);
2348 lock
->orig_ref_name
= xstrdup(orig_refname
);
2349 ref_file
= git_path("%s", refname
);
2352 switch (safe_create_leading_directories(ref_file
)) {
2354 break; /* success */
2356 if (--attempts_remaining
> 0)
2361 error("unable to create directory for %s", ref_file
);
2365 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
2366 if (lock
->lock_fd
< 0) {
2368 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2370 * Maybe somebody just deleted one of the
2371 * directories leading to ref_file. Try
2376 struct strbuf err
= STRBUF_INIT
;
2377 unable_to_lock_message(ref_file
, errno
, &err
);
2378 error("%s", err
.buf
);
2379 strbuf_release(&err
);
2383 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
2392 * Write an entry to the packed-refs file for the specified refname.
2393 * If peeled is non-NULL, write it as the entry's peeled value.
2395 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2396 unsigned char *peeled
)
2398 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2400 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2404 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2406 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2408 enum peel_status peel_status
= peel_entry(entry
, 0);
2410 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2411 error("internal error: %s is not a valid packed reference!",
2413 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.sha1
,
2414 peel_status
== PEEL_PEELED
?
2415 entry
->u
.value
.peeled
: NULL
);
2419 /* This should return a meaningful errno on failure */
2420 int lock_packed_refs(int flags
)
2422 struct packed_ref_cache
*packed_ref_cache
;
2424 if (hold_lock_file_for_update(&packlock
, git_path("packed-refs"), flags
) < 0)
2427 * Get the current packed-refs while holding the lock. If the
2428 * packed-refs file has been modified since we last read it,
2429 * this will automatically invalidate the cache and re-read
2430 * the packed-refs file.
2432 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2433 packed_ref_cache
->lock
= &packlock
;
2434 /* Increment the reference count to prevent it from being freed: */
2435 acquire_packed_ref_cache(packed_ref_cache
);
2440 * Commit the packed refs changes.
2441 * On error we must make sure that errno contains a meaningful value.
2443 int commit_packed_refs(void)
2445 struct packed_ref_cache
*packed_ref_cache
=
2446 get_packed_ref_cache(&ref_cache
);
2451 if (!packed_ref_cache
->lock
)
2452 die("internal error: packed-refs not locked");
2454 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2456 die_errno("unable to fdopen packed-refs descriptor");
2458 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2459 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2460 0, write_packed_entry_fn
, out
);
2462 if (commit_lock_file(packed_ref_cache
->lock
)) {
2466 packed_ref_cache
->lock
= NULL
;
2467 release_packed_ref_cache(packed_ref_cache
);
2472 void rollback_packed_refs(void)
2474 struct packed_ref_cache
*packed_ref_cache
=
2475 get_packed_ref_cache(&ref_cache
);
2477 if (!packed_ref_cache
->lock
)
2478 die("internal error: packed-refs not locked");
2479 rollback_lock_file(packed_ref_cache
->lock
);
2480 packed_ref_cache
->lock
= NULL
;
2481 release_packed_ref_cache(packed_ref_cache
);
2482 clear_packed_ref_cache(&ref_cache
);
2485 struct ref_to_prune
{
2486 struct ref_to_prune
*next
;
2487 unsigned char sha1
[20];
2488 char name
[FLEX_ARRAY
];
2491 struct pack_refs_cb_data
{
2493 struct ref_dir
*packed_refs
;
2494 struct ref_to_prune
*ref_to_prune
;
2498 * An each_ref_entry_fn that is run over loose references only. If
2499 * the loose reference can be packed, add an entry in the packed ref
2500 * cache. If the reference should be pruned, also add it to
2501 * ref_to_prune in the pack_refs_cb_data.
2503 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2505 struct pack_refs_cb_data
*cb
= cb_data
;
2506 enum peel_status peel_status
;
2507 struct ref_entry
*packed_entry
;
2508 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2510 /* ALWAYS pack tags */
2511 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2514 /* Do not pack symbolic or broken refs: */
2515 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2518 /* Add a packed ref cache entry equivalent to the loose entry. */
2519 peel_status
= peel_entry(entry
, 1);
2520 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2521 die("internal error peeling reference %s (%s)",
2522 entry
->name
, sha1_to_hex(entry
->u
.value
.sha1
));
2523 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2525 /* Overwrite existing packed entry with info from loose entry */
2526 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2527 hashcpy(packed_entry
->u
.value
.sha1
, entry
->u
.value
.sha1
);
2529 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.sha1
,
2530 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2531 add_ref(cb
->packed_refs
, packed_entry
);
2533 hashcpy(packed_entry
->u
.value
.peeled
, entry
->u
.value
.peeled
);
2535 /* Schedule the loose reference for pruning if requested. */
2536 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2537 int namelen
= strlen(entry
->name
) + 1;
2538 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2539 hashcpy(n
->sha1
, entry
->u
.value
.sha1
);
2540 strcpy(n
->name
, entry
->name
);
2541 n
->next
= cb
->ref_to_prune
;
2542 cb
->ref_to_prune
= n
;
2548 * Remove empty parents, but spare refs/ and immediate subdirs.
2549 * Note: munges *name.
2551 static void try_remove_empty_parents(char *name
)
2556 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2557 while (*p
&& *p
!= '/')
2559 /* tolerate duplicate slashes; see check_refname_format() */
2563 for (q
= p
; *q
; q
++)
2566 while (q
> p
&& *q
!= '/')
2568 while (q
> p
&& *(q
-1) == '/')
2573 if (rmdir(git_path("%s", name
)))
2578 /* make sure nobody touched the ref, and unlink */
2579 static void prune_ref(struct ref_to_prune
*r
)
2581 struct ref_transaction
*transaction
;
2582 struct strbuf err
= STRBUF_INIT
;
2584 if (check_refname_format(r
->name
, 0))
2587 transaction
= ref_transaction_begin(&err
);
2589 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2590 REF_ISPRUNING
, NULL
, &err
) ||
2591 ref_transaction_commit(transaction
, &err
)) {
2592 ref_transaction_free(transaction
);
2593 error("%s", err
.buf
);
2594 strbuf_release(&err
);
2597 ref_transaction_free(transaction
);
2598 strbuf_release(&err
);
2599 try_remove_empty_parents(r
->name
);
2602 static void prune_refs(struct ref_to_prune
*r
)
2610 int pack_refs(unsigned int flags
)
2612 struct pack_refs_cb_data cbdata
;
2614 memset(&cbdata
, 0, sizeof(cbdata
));
2615 cbdata
.flags
= flags
;
2617 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2618 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2620 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2621 pack_if_possible_fn
, &cbdata
);
2623 if (commit_packed_refs())
2624 die_errno("unable to overwrite old ref-pack file");
2626 prune_refs(cbdata
.ref_to_prune
);
2630 int repack_without_refs(struct string_list
*refnames
, struct strbuf
*err
)
2632 struct ref_dir
*packed
;
2633 struct string_list_item
*refname
;
2634 int ret
, needs_repacking
= 0, removed
= 0;
2638 /* Look for a packed ref */
2639 for_each_string_list_item(refname
, refnames
) {
2640 if (get_packed_ref(refname
->string
)) {
2641 needs_repacking
= 1;
2646 /* Avoid locking if we have nothing to do */
2647 if (!needs_repacking
)
2648 return 0; /* no refname exists in packed refs */
2650 if (lock_packed_refs(0)) {
2651 unable_to_lock_message(git_path("packed-refs"), errno
, err
);
2654 packed
= get_packed_refs(&ref_cache
);
2656 /* Remove refnames from the cache */
2657 for_each_string_list_item(refname
, refnames
)
2658 if (remove_entry(packed
, refname
->string
) != -1)
2662 * All packed entries disappeared while we were
2663 * acquiring the lock.
2665 rollback_packed_refs();
2669 /* Write what remains */
2670 ret
= commit_packed_refs();
2672 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2677 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2681 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2683 * loose. The loose file name is the same as the
2684 * lockfile name, minus ".lock":
2686 char *loose_filename
= get_locked_file_path(lock
->lk
);
2687 int res
= unlink_or_msg(loose_filename
, err
);
2688 free(loose_filename
);
2695 int delete_ref(const char *refname
, const unsigned char *sha1
, unsigned int flags
)
2697 struct ref_transaction
*transaction
;
2698 struct strbuf err
= STRBUF_INIT
;
2700 transaction
= ref_transaction_begin(&err
);
2702 ref_transaction_delete(transaction
, refname
,
2703 (sha1
&& !is_null_sha1(sha1
)) ? sha1
: NULL
,
2704 flags
, NULL
, &err
) ||
2705 ref_transaction_commit(transaction
, &err
)) {
2706 error("%s", err
.buf
);
2707 ref_transaction_free(transaction
);
2708 strbuf_release(&err
);
2711 ref_transaction_free(transaction
);
2712 strbuf_release(&err
);
2717 * People using contrib's git-new-workdir have .git/logs/refs ->
2718 * /some/other/path/.git/logs/refs, and that may live on another device.
2720 * IOW, to avoid cross device rename errors, the temporary renamed log must
2721 * live into logs/refs.
2723 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2725 static int rename_tmp_log(const char *newrefname
)
2727 int attempts_remaining
= 4;
2730 switch (safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
2732 break; /* success */
2734 if (--attempts_remaining
> 0)
2738 error("unable to create directory for %s", newrefname
);
2742 if (rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2743 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2745 * rename(a, b) when b is an existing
2746 * directory ought to result in ISDIR, but
2747 * Solaris 5.8 gives ENOTDIR. Sheesh.
2749 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2750 error("Directory not empty: logs/%s", newrefname
);
2754 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2756 * Maybe another process just deleted one of
2757 * the directories in the path to newrefname.
2758 * Try again from the beginning.
2762 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2763 newrefname
, strerror(errno
));
2770 static int rename_ref_available(const char *oldname
, const char *newname
)
2772 struct string_list skip
= STRING_LIST_INIT_NODUP
;
2775 string_list_insert(&skip
, oldname
);
2776 ret
= is_refname_available(newname
, &skip
, get_packed_refs(&ref_cache
))
2777 && is_refname_available(newname
, &skip
, get_loose_refs(&ref_cache
));
2778 string_list_clear(&skip
, 0);
2782 static int write_ref_to_lockfile(struct ref_lock
*lock
, const unsigned char *sha1
);
2783 static int commit_ref_update(struct ref_lock
*lock
,
2784 const unsigned char *sha1
, const char *logmsg
);
2786 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2788 unsigned char sha1
[20], orig_sha1
[20];
2789 int flag
= 0, logmoved
= 0;
2790 struct ref_lock
*lock
;
2791 struct stat loginfo
;
2792 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2793 const char *symref
= NULL
;
2795 if (log
&& S_ISLNK(loginfo
.st_mode
))
2796 return error("reflog for %s is a symlink", oldrefname
);
2798 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
2800 if (flag
& REF_ISSYMREF
)
2801 return error("refname %s is a symbolic ref, renaming it is not supported",
2804 return error("refname %s not found", oldrefname
);
2806 if (!rename_ref_available(oldrefname
, newrefname
))
2809 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2810 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2811 oldrefname
, strerror(errno
));
2813 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2814 error("unable to delete old %s", oldrefname
);
2818 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
2819 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2820 if (errno
==EISDIR
) {
2821 if (remove_empty_directories(git_path("%s", newrefname
))) {
2822 error("Directory not empty: %s", newrefname
);
2826 error("unable to delete existing %s", newrefname
);
2831 if (log
&& rename_tmp_log(newrefname
))
2836 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, 0, NULL
);
2838 error("unable to lock %s for update", newrefname
);
2841 hashcpy(lock
->old_sha1
, orig_sha1
);
2843 if (write_ref_to_lockfile(lock
, orig_sha1
) ||
2844 commit_ref_update(lock
, orig_sha1
, logmsg
)) {
2845 error("unable to write current sha1 into %s", newrefname
);
2852 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, 0, NULL
);
2854 error("unable to lock %s for rollback", oldrefname
);
2858 flag
= log_all_ref_updates
;
2859 log_all_ref_updates
= 0;
2860 if (write_ref_to_lockfile(lock
, orig_sha1
) ||
2861 commit_ref_update(lock
, orig_sha1
, NULL
))
2862 error("unable to write current sha1 into %s", oldrefname
);
2863 log_all_ref_updates
= flag
;
2866 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
2867 error("unable to restore logfile %s from %s: %s",
2868 oldrefname
, newrefname
, strerror(errno
));
2869 if (!logmoved
&& log
&&
2870 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
2871 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
2872 oldrefname
, strerror(errno
));
2877 static int close_ref(struct ref_lock
*lock
)
2879 if (close_lock_file(lock
->lk
))
2885 static int commit_ref(struct ref_lock
*lock
)
2887 if (commit_lock_file(lock
->lk
))
2894 * copy the reflog message msg to buf, which has been allocated sufficiently
2895 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2896 * because reflog file is one line per entry.
2898 static int copy_msg(char *buf
, const char *msg
)
2905 while ((c
= *msg
++)) {
2906 if (wasspace
&& isspace(c
))
2908 wasspace
= isspace(c
);
2913 while (buf
< cp
&& isspace(cp
[-1]))
2919 /* This function must set a meaningful errno on failure */
2920 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
2922 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
2924 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
2925 if (log_all_ref_updates
&&
2926 (starts_with(refname
, "refs/heads/") ||
2927 starts_with(refname
, "refs/remotes/") ||
2928 starts_with(refname
, "refs/notes/") ||
2929 !strcmp(refname
, "HEAD"))) {
2930 if (safe_create_leading_directories(logfile
) < 0) {
2931 int save_errno
= errno
;
2932 error("unable to create directory for %s", logfile
);
2939 logfd
= open(logfile
, oflags
, 0666);
2941 if (!(oflags
& O_CREAT
) && (errno
== ENOENT
|| errno
== EISDIR
))
2944 if (errno
== EISDIR
) {
2945 if (remove_empty_directories(logfile
)) {
2946 int save_errno
= errno
;
2947 error("There are still logs under '%s'",
2952 logfd
= open(logfile
, oflags
, 0666);
2956 int save_errno
= errno
;
2957 error("Unable to append to %s: %s", logfile
,
2964 adjust_shared_perm(logfile
);
2969 static int log_ref_write_fd(int fd
, const unsigned char *old_sha1
,
2970 const unsigned char *new_sha1
,
2971 const char *committer
, const char *msg
)
2973 int msglen
, written
;
2974 unsigned maxlen
, len
;
2977 msglen
= msg
? strlen(msg
) : 0;
2978 maxlen
= strlen(committer
) + msglen
+ 100;
2979 logrec
= xmalloc(maxlen
);
2980 len
= sprintf(logrec
, "%s %s %s\n",
2981 sha1_to_hex(old_sha1
),
2982 sha1_to_hex(new_sha1
),
2985 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
2987 written
= len
<= maxlen
? write_in_full(fd
, logrec
, len
) : -1;
2995 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
2996 const unsigned char *new_sha1
, const char *msg
)
2998 int logfd
, result
, oflags
= O_APPEND
| O_WRONLY
;
2999 char log_file
[PATH_MAX
];
3001 if (log_all_ref_updates
< 0)
3002 log_all_ref_updates
= !is_bare_repository();
3004 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
3008 logfd
= open(log_file
, oflags
);
3011 result
= log_ref_write_fd(logfd
, old_sha1
, new_sha1
,
3012 git_committer_info(0), msg
);
3014 int save_errno
= errno
;
3016 error("Unable to append to %s", log_file
);
3021 int save_errno
= errno
;
3022 error("Unable to append to %s", log_file
);
3029 int is_branch(const char *refname
)
3031 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3035 * Write sha1 into the open lockfile, then close the lockfile. On
3036 * errors, rollback the lockfile and set errno to reflect the problem.
3038 static int write_ref_to_lockfile(struct ref_lock
*lock
,
3039 const unsigned char *sha1
)
3041 static char term
= '\n';
3044 o
= parse_object(sha1
);
3046 error("Trying to write ref %s with nonexistent object %s",
3047 lock
->ref_name
, sha1_to_hex(sha1
));
3052 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3053 error("Trying to write non-commit object %s to branch %s",
3054 sha1_to_hex(sha1
), lock
->ref_name
);
3059 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
3060 write_in_full(lock
->lock_fd
, &term
, 1) != 1 ||
3061 close_ref(lock
) < 0) {
3062 int save_errno
= errno
;
3063 error("Couldn't write %s", lock
->lk
->filename
.buf
);
3072 * Commit a change to a loose reference that has already been written
3073 * to the loose reference lockfile. Also update the reflogs if
3074 * necessary, using the specified lockmsg (which can be NULL).
3076 static int commit_ref_update(struct ref_lock
*lock
,
3077 const unsigned char *sha1
, const char *logmsg
)
3079 clear_loose_ref_cache(&ref_cache
);
3080 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
3081 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3082 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
3086 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3088 * Special hack: If a branch is updated directly and HEAD
3089 * points to it (may happen on the remote side of a push
3090 * for example) then logically the HEAD reflog should be
3092 * A generic solution implies reverse symref information,
3093 * but finding all symrefs pointing to the given branch
3094 * would be rather costly for this rare event (the direct
3095 * update of a branch) to be worth it. So let's cheat and
3096 * check with HEAD only which should cover 99% of all usage
3097 * scenarios (even 100% of the default ones).
3099 unsigned char head_sha1
[20];
3101 const char *head_ref
;
3102 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3103 head_sha1
, &head_flag
);
3104 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3105 !strcmp(head_ref
, lock
->ref_name
))
3106 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
3108 if (commit_ref(lock
)) {
3109 error("Couldn't set %s", lock
->ref_name
);
3117 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3120 const char *lockpath
;
3122 int fd
, len
, written
;
3123 char *git_HEAD
= git_pathdup("%s", ref_target
);
3124 unsigned char old_sha1
[20], new_sha1
[20];
3126 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3129 if (safe_create_leading_directories(git_HEAD
) < 0)
3130 return error("unable to create directory for %s", git_HEAD
);
3132 #ifndef NO_SYMLINK_HEAD
3133 if (prefer_symlink_refs
) {
3135 if (!symlink(refs_heads_master
, git_HEAD
))
3137 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3141 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3142 if (sizeof(ref
) <= len
) {
3143 error("refname too long: %s", refs_heads_master
);
3144 goto error_free_return
;
3146 lockpath
= mkpath("%s.lock", git_HEAD
);
3147 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3149 error("Unable to open %s for writing", lockpath
);
3150 goto error_free_return
;
3152 written
= write_in_full(fd
, ref
, len
);
3153 if (close(fd
) != 0 || written
!= len
) {
3154 error("Unable to write to %s", lockpath
);
3155 goto error_unlink_return
;
3157 if (rename(lockpath
, git_HEAD
) < 0) {
3158 error("Unable to create %s", git_HEAD
);
3159 goto error_unlink_return
;
3161 if (adjust_shared_perm(git_HEAD
)) {
3162 error("Unable to fix permissions on %s", lockpath
);
3163 error_unlink_return
:
3164 unlink_or_warn(lockpath
);
3170 #ifndef NO_SYMLINK_HEAD
3173 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
3174 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
3180 struct read_ref_at_cb
{
3181 const char *refname
;
3182 unsigned long at_time
;
3185 unsigned char *sha1
;
3188 unsigned char osha1
[20];
3189 unsigned char nsha1
[20];
3193 unsigned long *cutoff_time
;
3198 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3199 const char *email
, unsigned long timestamp
, int tz
,
3200 const char *message
, void *cb_data
)
3202 struct read_ref_at_cb
*cb
= cb_data
;
3206 cb
->date
= timestamp
;
3208 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3210 *cb
->msg
= xstrdup(message
);
3211 if (cb
->cutoff_time
)
3212 *cb
->cutoff_time
= timestamp
;
3214 *cb
->cutoff_tz
= tz
;
3216 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3218 * we have not yet updated cb->[n|o]sha1 so they still
3219 * hold the values for the previous record.
3221 if (!is_null_sha1(cb
->osha1
)) {
3222 hashcpy(cb
->sha1
, nsha1
);
3223 if (hashcmp(cb
->osha1
, nsha1
))
3224 warning("Log for ref %s has gap after %s.",
3225 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_RFC2822
));
3227 else if (cb
->date
== cb
->at_time
)
3228 hashcpy(cb
->sha1
, nsha1
);
3229 else if (hashcmp(nsha1
, cb
->sha1
))
3230 warning("Log for ref %s unexpectedly ended on %s.",
3231 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3233 hashcpy(cb
->osha1
, osha1
);
3234 hashcpy(cb
->nsha1
, nsha1
);
3238 hashcpy(cb
->osha1
, osha1
);
3239 hashcpy(cb
->nsha1
, nsha1
);
3245 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3246 const char *email
, unsigned long timestamp
,
3247 int tz
, const char *message
, void *cb_data
)
3249 struct read_ref_at_cb
*cb
= cb_data
;
3252 *cb
->msg
= xstrdup(message
);
3253 if (cb
->cutoff_time
)
3254 *cb
->cutoff_time
= timestamp
;
3256 *cb
->cutoff_tz
= tz
;
3258 *cb
->cutoff_cnt
= cb
->reccnt
;
3259 hashcpy(cb
->sha1
, osha1
);
3260 if (is_null_sha1(cb
->sha1
))
3261 hashcpy(cb
->sha1
, nsha1
);
3262 /* We just want the first entry */
3266 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3267 unsigned char *sha1
, char **msg
,
3268 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3270 struct read_ref_at_cb cb
;
3272 memset(&cb
, 0, sizeof(cb
));
3273 cb
.refname
= refname
;
3274 cb
.at_time
= at_time
;
3277 cb
.cutoff_time
= cutoff_time
;
3278 cb
.cutoff_tz
= cutoff_tz
;
3279 cb
.cutoff_cnt
= cutoff_cnt
;
3282 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3285 if (flags
& GET_SHA1_QUIETLY
)
3288 die("Log for %s is empty.", refname
);
3293 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3298 int reflog_exists(const char *refname
)
3302 return !lstat(git_path("logs/%s", refname
), &st
) &&
3303 S_ISREG(st
.st_mode
);
3306 int delete_reflog(const char *refname
)
3308 return remove_path(git_path("logs/%s", refname
));
3311 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3313 unsigned char osha1
[20], nsha1
[20];
3314 char *email_end
, *message
;
3315 unsigned long timestamp
;
3318 /* old SP new SP name <email> SP time TAB msg LF */
3319 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3320 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3321 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3322 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3323 email_end
[1] != ' ' ||
3324 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3325 !message
|| message
[0] != ' ' ||
3326 (message
[1] != '+' && message
[1] != '-') ||
3327 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3328 !isdigit(message
[4]) || !isdigit(message
[5]))
3329 return 0; /* corrupt? */
3330 email_end
[1] = '\0';
3331 tz
= strtol(message
+ 1, NULL
, 10);
3332 if (message
[6] != '\t')
3336 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3339 static char *find_beginning_of_line(char *bob
, char *scan
)
3341 while (bob
< scan
&& *(--scan
) != '\n')
3342 ; /* keep scanning backwards */
3344 * Return either beginning of the buffer, or LF at the end of
3345 * the previous line.
3350 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3352 struct strbuf sb
= STRBUF_INIT
;
3355 int ret
= 0, at_tail
= 1;
3357 logfp
= fopen(git_path("logs/%s", refname
), "r");
3361 /* Jump to the end */
3362 if (fseek(logfp
, 0, SEEK_END
) < 0)
3363 return error("cannot seek back reflog for %s: %s",
3364 refname
, strerror(errno
));
3366 while (!ret
&& 0 < pos
) {
3372 /* Fill next block from the end */
3373 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3374 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3375 return error("cannot seek back reflog for %s: %s",
3376 refname
, strerror(errno
));
3377 nread
= fread(buf
, cnt
, 1, logfp
);
3379 return error("cannot read %d bytes from reflog for %s: %s",
3380 cnt
, refname
, strerror(errno
));
3383 scanp
= endp
= buf
+ cnt
;
3384 if (at_tail
&& scanp
[-1] == '\n')
3385 /* Looking at the final LF at the end of the file */
3389 while (buf
< scanp
) {
3391 * terminating LF of the previous line, or the beginning
3396 bp
= find_beginning_of_line(buf
, scanp
);
3400 * The newline is the end of the previous line,
3401 * so we know we have complete line starting
3402 * at (bp + 1). Prefix it onto any prior data
3403 * we collected for the line and process it.
3405 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3408 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3414 * We are at the start of the buffer, and the
3415 * start of the file; there is no previous
3416 * line, and we have everything for this one.
3417 * Process it, and we can end the loop.
3419 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3420 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3427 * We are at the start of the buffer, and there
3428 * is more file to read backwards. Which means
3429 * we are in the middle of a line. Note that we
3430 * may get here even if *bp was a newline; that
3431 * just means we are at the exact end of the
3432 * previous line, rather than some spot in the
3435 * Save away what we have to be combined with
3436 * the data from the next read.
3438 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3445 die("BUG: reverse reflog parser had leftover data");
3448 strbuf_release(&sb
);
3452 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3455 struct strbuf sb
= STRBUF_INIT
;
3458 logfp
= fopen(git_path("logs/%s", refname
), "r");
3462 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3463 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3465 strbuf_release(&sb
);
3469 * Call fn for each reflog in the namespace indicated by name. name
3470 * must be empty or end with '/'. Name will be used as a scratch
3471 * space, but its contents will be restored before return.
3473 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3475 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3478 int oldlen
= name
->len
;
3481 return name
->len
? errno
: 0;
3483 while ((de
= readdir(d
)) != NULL
) {
3486 if (de
->d_name
[0] == '.')
3488 if (ends_with(de
->d_name
, ".lock"))
3490 strbuf_addstr(name
, de
->d_name
);
3491 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3492 ; /* silently ignore */
3494 if (S_ISDIR(st
.st_mode
)) {
3495 strbuf_addch(name
, '/');
3496 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3498 unsigned char sha1
[20];
3499 if (read_ref_full(name
->buf
, 0, sha1
, NULL
))
3500 retval
= error("bad ref for %s", name
->buf
);
3502 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
3507 strbuf_setlen(name
, oldlen
);
3513 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3517 strbuf_init(&name
, PATH_MAX
);
3518 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3519 strbuf_release(&name
);
3524 * Information needed for a single ref update. Set new_sha1 to the new
3525 * value or to null_sha1 to delete the ref. To check the old value
3526 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
3527 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
3528 * not exist before update.
3532 * If (flags & REF_HAVE_NEW), set the reference to this value:
3534 unsigned char new_sha1
[20];
3536 * If (flags & REF_HAVE_OLD), check that the reference
3537 * previously had this value:
3539 unsigned char old_sha1
[20];
3541 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3542 * REF_DELETING, and REF_ISPRUNING:
3545 struct ref_lock
*lock
;
3548 const char refname
[FLEX_ARRAY
];
3552 * Transaction states.
3553 * OPEN: The transaction is in a valid state and can accept new updates.
3554 * An OPEN transaction can be committed.
3555 * CLOSED: A closed transaction is no longer active and no other operations
3556 * than free can be used on it in this state.
3557 * A transaction can either become closed by successfully committing
3558 * an active transaction or if there is a failure while building
3559 * the transaction thus rendering it failed/inactive.
3561 enum ref_transaction_state
{
3562 REF_TRANSACTION_OPEN
= 0,
3563 REF_TRANSACTION_CLOSED
= 1
3567 * Data structure for holding a reference transaction, which can
3568 * consist of checks and updates to multiple references, carried out
3569 * as atomically as possible. This structure is opaque to callers.
3571 struct ref_transaction
{
3572 struct ref_update
**updates
;
3575 enum ref_transaction_state state
;
3578 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
3582 return xcalloc(1, sizeof(struct ref_transaction
));
3585 void ref_transaction_free(struct ref_transaction
*transaction
)
3592 for (i
= 0; i
< transaction
->nr
; i
++) {
3593 free(transaction
->updates
[i
]->msg
);
3594 free(transaction
->updates
[i
]);
3596 free(transaction
->updates
);
3600 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3601 const char *refname
)
3603 size_t len
= strlen(refname
);
3604 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3606 strcpy((char *)update
->refname
, refname
);
3607 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3608 transaction
->updates
[transaction
->nr
++] = update
;
3612 int ref_transaction_update(struct ref_transaction
*transaction
,
3613 const char *refname
,
3614 const unsigned char *new_sha1
,
3615 const unsigned char *old_sha1
,
3616 unsigned int flags
, const char *msg
,
3619 struct ref_update
*update
;
3623 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3624 die("BUG: update called for transaction that is not open");
3626 if (new_sha1
&& !is_null_sha1(new_sha1
) &&
3627 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
3628 strbuf_addf(err
, "refusing to update ref with bad name %s",
3633 update
= add_update(transaction
, refname
);
3635 hashcpy(update
->new_sha1
, new_sha1
);
3636 flags
|= REF_HAVE_NEW
;
3639 hashcpy(update
->old_sha1
, old_sha1
);
3640 flags
|= REF_HAVE_OLD
;
3642 update
->flags
= flags
;
3644 update
->msg
= xstrdup(msg
);
3648 int ref_transaction_create(struct ref_transaction
*transaction
,
3649 const char *refname
,
3650 const unsigned char *new_sha1
,
3651 unsigned int flags
, const char *msg
,
3654 if (!new_sha1
|| is_null_sha1(new_sha1
))
3655 die("BUG: create called without valid new_sha1");
3656 return ref_transaction_update(transaction
, refname
, new_sha1
,
3657 null_sha1
, flags
, msg
, err
);
3660 int ref_transaction_delete(struct ref_transaction
*transaction
,
3661 const char *refname
,
3662 const unsigned char *old_sha1
,
3663 unsigned int flags
, const char *msg
,
3666 if (old_sha1
&& is_null_sha1(old_sha1
))
3667 die("BUG: delete called with old_sha1 set to zeros");
3668 return ref_transaction_update(transaction
, refname
,
3669 null_sha1
, old_sha1
,
3673 int ref_transaction_verify(struct ref_transaction
*transaction
,
3674 const char *refname
,
3675 const unsigned char *old_sha1
,
3680 die("BUG: verify called with old_sha1 set to NULL");
3681 return ref_transaction_update(transaction
, refname
,
3686 int update_ref(const char *msg
, const char *refname
,
3687 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
3688 unsigned int flags
, enum action_on_err onerr
)
3690 struct ref_transaction
*t
;
3691 struct strbuf err
= STRBUF_INIT
;
3693 t
= ref_transaction_begin(&err
);
3695 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
3696 flags
, msg
, &err
) ||
3697 ref_transaction_commit(t
, &err
)) {
3698 const char *str
= "update_ref failed for ref '%s': %s";
3700 ref_transaction_free(t
);
3702 case UPDATE_REFS_MSG_ON_ERR
:
3703 error(str
, refname
, err
.buf
);
3705 case UPDATE_REFS_DIE_ON_ERR
:
3706 die(str
, refname
, err
.buf
);
3708 case UPDATE_REFS_QUIET_ON_ERR
:
3711 strbuf_release(&err
);
3714 strbuf_release(&err
);
3715 ref_transaction_free(t
);
3719 static int ref_update_compare(const void *r1
, const void *r2
)
3721 const struct ref_update
* const *u1
= r1
;
3722 const struct ref_update
* const *u2
= r2
;
3723 return strcmp((*u1
)->refname
, (*u2
)->refname
);
3726 static int ref_update_reject_duplicates(struct ref_update
**updates
, int n
,
3733 for (i
= 1; i
< n
; i
++)
3734 if (!strcmp(updates
[i
- 1]->refname
, updates
[i
]->refname
)) {
3736 "Multiple updates for ref '%s' not allowed.",
3737 updates
[i
]->refname
);
3743 int ref_transaction_commit(struct ref_transaction
*transaction
,
3747 int n
= transaction
->nr
;
3748 struct ref_update
**updates
= transaction
->updates
;
3749 struct string_list refs_to_delete
= STRING_LIST_INIT_NODUP
;
3750 struct string_list_item
*ref_to_delete
;
3754 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3755 die("BUG: commit called for transaction that is not open");
3758 transaction
->state
= REF_TRANSACTION_CLOSED
;
3762 /* Copy, sort, and reject duplicate refs */
3763 qsort(updates
, n
, sizeof(*updates
), ref_update_compare
);
3764 if (ref_update_reject_duplicates(updates
, n
, err
)) {
3765 ret
= TRANSACTION_GENERIC_ERROR
;
3770 * Acquire all locks, verify old values if provided, check
3771 * that new values are valid, and write new values to the
3772 * lockfiles, ready to be activated. Only keep one lockfile
3773 * open at a time to avoid running out of file descriptors.
3775 for (i
= 0; i
< n
; i
++) {
3776 struct ref_update
*update
= updates
[i
];
3778 if ((update
->flags
& REF_HAVE_NEW
) &&
3779 is_null_sha1(update
->new_sha1
))
3780 update
->flags
|= REF_DELETING
;
3781 update
->lock
= lock_ref_sha1_basic(
3783 ((update
->flags
& REF_HAVE_OLD
) ?
3784 update
->old_sha1
: NULL
),
3788 if (!update
->lock
) {
3789 ret
= (errno
== ENOTDIR
)
3790 ? TRANSACTION_NAME_CONFLICT
3791 : TRANSACTION_GENERIC_ERROR
;
3792 strbuf_addf(err
, "Cannot lock the ref '%s'.",
3796 if ((update
->flags
& REF_HAVE_NEW
) &&
3797 !(update
->flags
& REF_DELETING
)) {
3798 int overwriting_symref
= ((update
->type
& REF_ISSYMREF
) &&
3799 (update
->flags
& REF_NODEREF
));
3801 if (!overwriting_symref
&&
3802 !hashcmp(update
->lock
->old_sha1
, update
->new_sha1
)) {
3804 * The reference already has the desired
3805 * value, so we don't need to write it.
3807 } else if (write_ref_to_lockfile(update
->lock
,
3808 update
->new_sha1
)) {
3810 * The lock was freed upon failure of
3811 * write_ref_to_lockfile():
3813 update
->lock
= NULL
;
3814 strbuf_addf(err
, "Cannot update the ref '%s'.",
3816 ret
= TRANSACTION_GENERIC_ERROR
;
3819 update
->flags
|= REF_NEEDS_COMMIT
;
3822 if (!(update
->flags
& REF_NEEDS_COMMIT
)) {
3824 * We didn't have to write anything to the lockfile.
3825 * Close it to free up the file descriptor:
3827 if (close_ref(update
->lock
)) {
3828 strbuf_addf(err
, "Couldn't close %s.lock",
3835 /* Perform updates first so live commits remain referenced */
3836 for (i
= 0; i
< n
; i
++) {
3837 struct ref_update
*update
= updates
[i
];
3839 if (update
->flags
& REF_NEEDS_COMMIT
) {
3840 if (commit_ref_update(update
->lock
,
3841 update
->new_sha1
, update
->msg
)) {
3842 /* freed by commit_ref_update(): */
3843 update
->lock
= NULL
;
3844 strbuf_addf(err
, "Cannot update the ref '%s'.",
3846 ret
= TRANSACTION_GENERIC_ERROR
;
3849 /* freed by commit_ref_update(): */
3850 update
->lock
= NULL
;
3855 /* Perform deletes now that updates are safely completed */
3856 for (i
= 0; i
< n
; i
++) {
3857 struct ref_update
*update
= updates
[i
];
3859 if (update
->flags
& REF_DELETING
) {
3860 if (delete_ref_loose(update
->lock
, update
->type
, err
)) {
3861 ret
= TRANSACTION_GENERIC_ERROR
;
3865 if (!(update
->flags
& REF_ISPRUNING
))
3866 string_list_append(&refs_to_delete
,
3867 update
->lock
->ref_name
);
3871 if (repack_without_refs(&refs_to_delete
, err
)) {
3872 ret
= TRANSACTION_GENERIC_ERROR
;
3875 for_each_string_list_item(ref_to_delete
, &refs_to_delete
)
3876 unlink_or_warn(git_path("logs/%s", ref_to_delete
->string
));
3877 clear_loose_ref_cache(&ref_cache
);
3880 transaction
->state
= REF_TRANSACTION_CLOSED
;
3882 for (i
= 0; i
< n
; i
++)
3883 if (updates
[i
]->lock
)
3884 unlock_ref(updates
[i
]->lock
);
3885 string_list_clear(&refs_to_delete
, 0);
3889 char *shorten_unambiguous_ref(const char *refname
, int strict
)
3892 static char **scanf_fmts
;
3893 static int nr_rules
;
3898 * Pre-generate scanf formats from ref_rev_parse_rules[].
3899 * Generate a format suitable for scanf from a
3900 * ref_rev_parse_rules rule by interpolating "%s" at the
3901 * location of the "%.*s".
3903 size_t total_len
= 0;
3906 /* the rule list is NULL terminated, count them first */
3907 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
3908 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3909 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
3911 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
3914 for (i
= 0; i
< nr_rules
; i
++) {
3915 assert(offset
< total_len
);
3916 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
3917 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
3918 ref_rev_parse_rules
[i
], 2, "%s") + 1;
3922 /* bail out if there are no rules */
3924 return xstrdup(refname
);
3926 /* buffer for scanf result, at most refname must fit */
3927 short_name
= xstrdup(refname
);
3929 /* skip first rule, it will always match */
3930 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
3932 int rules_to_fail
= i
;
3935 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
3938 short_name_len
= strlen(short_name
);
3941 * in strict mode, all (except the matched one) rules
3942 * must fail to resolve to a valid non-ambiguous ref
3945 rules_to_fail
= nr_rules
;
3948 * check if the short name resolves to a valid ref,
3949 * but use only rules prior to the matched one
3951 for (j
= 0; j
< rules_to_fail
; j
++) {
3952 const char *rule
= ref_rev_parse_rules
[j
];
3953 char refname
[PATH_MAX
];
3955 /* skip matched rule */
3960 * the short name is ambiguous, if it resolves
3961 * (with this previous rule) to a valid ref
3962 * read_ref() returns 0 on success
3964 mksnpath(refname
, sizeof(refname
),
3965 rule
, short_name_len
, short_name
);
3966 if (ref_exists(refname
))
3971 * short name is non-ambiguous if all previous rules
3972 * haven't resolved to a valid ref
3974 if (j
== rules_to_fail
)
3979 return xstrdup(refname
);
3982 static struct string_list
*hide_refs
;
3984 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
3986 if (!strcmp("transfer.hiderefs", var
) ||
3987 /* NEEDSWORK: use parse_config_key() once both are merged */
3988 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
3989 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
3994 return config_error_nonbool(var
);
3995 ref
= xstrdup(value
);
3997 while (len
&& ref
[len
- 1] == '/')
4000 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
4001 hide_refs
->strdup_strings
= 1;
4003 string_list_append(hide_refs
, ref
);
4008 int ref_is_hidden(const char *refname
)
4010 struct string_list_item
*item
;
4014 for_each_string_list_item(item
, hide_refs
) {
4016 if (!starts_with(refname
, item
->string
))
4018 len
= strlen(item
->string
);
4019 if (!refname
[len
] || refname
[len
] == '/')
4025 struct expire_reflog_cb
{
4027 reflog_expiry_should_prune_fn
*should_prune_fn
;
4030 unsigned char last_kept_sha1
[20];
4033 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
4034 const char *email
, unsigned long timestamp
, int tz
,
4035 const char *message
, void *cb_data
)
4037 struct expire_reflog_cb
*cb
= cb_data
;
4038 struct expire_reflog_policy_cb
*policy_cb
= cb
->policy_cb
;
4040 if (cb
->flags
& EXPIRE_REFLOGS_REWRITE
)
4041 osha1
= cb
->last_kept_sha1
;
4043 if ((*cb
->should_prune_fn
)(osha1
, nsha1
, email
, timestamp
, tz
,
4044 message
, policy_cb
)) {
4046 printf("would prune %s", message
);
4047 else if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4048 printf("prune %s", message
);
4051 fprintf(cb
->newlog
, "%s %s %s %lu %+05d\t%s",
4052 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
4053 email
, timestamp
, tz
, message
);
4054 hashcpy(cb
->last_kept_sha1
, nsha1
);
4056 if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4057 printf("keep %s", message
);
4062 int reflog_expire(const char *refname
, const unsigned char *sha1
,
4064 reflog_expiry_prepare_fn prepare_fn
,
4065 reflog_expiry_should_prune_fn should_prune_fn
,
4066 reflog_expiry_cleanup_fn cleanup_fn
,
4067 void *policy_cb_data
)
4069 static struct lock_file reflog_lock
;
4070 struct expire_reflog_cb cb
;
4071 struct ref_lock
*lock
;
4076 memset(&cb
, 0, sizeof(cb
));
4078 cb
.policy_cb
= policy_cb_data
;
4079 cb
.should_prune_fn
= should_prune_fn
;
4082 * The reflog file is locked by holding the lock on the
4083 * reference itself, plus we might need to update the
4084 * reference if --updateref was specified:
4086 lock
= lock_ref_sha1_basic(refname
, sha1
, NULL
, 0, &type
);
4088 return error("cannot lock ref '%s'", refname
);
4089 if (!reflog_exists(refname
)) {
4094 log_file
= git_pathdup("logs/%s", refname
);
4095 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4097 * Even though holding $GIT_DIR/logs/$reflog.lock has
4098 * no locking implications, we use the lock_file
4099 * machinery here anyway because it does a lot of the
4100 * work we need, including cleaning up if the program
4101 * exits unexpectedly.
4103 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
4104 struct strbuf err
= STRBUF_INIT
;
4105 unable_to_lock_message(log_file
, errno
, &err
);
4106 error("%s", err
.buf
);
4107 strbuf_release(&err
);
4110 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
4112 error("cannot fdopen %s (%s)",
4113 reflog_lock
.filename
.buf
, strerror(errno
));
4118 (*prepare_fn
)(refname
, sha1
, cb
.policy_cb
);
4119 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
4120 (*cleanup_fn
)(cb
.policy_cb
);
4122 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4124 * It doesn't make sense to adjust a reference pointed
4125 * to by a symbolic ref based on expiring entries in
4126 * the symbolic reference's reflog. Nor can we update
4127 * a reference if there are no remaining reflog
4130 int update
= (flags
& EXPIRE_REFLOGS_UPDATE_REF
) &&
4131 !(type
& REF_ISSYMREF
) &&
4132 !is_null_sha1(cb
.last_kept_sha1
);
4134 if (close_lock_file(&reflog_lock
)) {
4135 status
|= error("couldn't write %s: %s", log_file
,
4137 } else if (update
&&
4138 (write_in_full(lock
->lock_fd
,
4139 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
4140 write_str_in_full(lock
->lock_fd
, "\n") != 1 ||
4141 close_ref(lock
) < 0)) {
4142 status
|= error("couldn't write %s",
4143 lock
->lk
->filename
.buf
);
4144 rollback_lock_file(&reflog_lock
);
4145 } else if (commit_lock_file(&reflog_lock
)) {
4146 status
|= error("unable to commit reflog '%s' (%s)",
4147 log_file
, strerror(errno
));
4148 } else if (update
&& commit_ref(lock
)) {
4149 status
|= error("couldn't set %s", lock
->ref_name
);
4157 rollback_lock_file(&reflog_lock
);