7 #include "string-list.h"
13 struct object_id old_oid
;
17 * How to handle various characters in refnames:
18 * 0: An acceptable character for refs
20 * 2: ., look for a preceding . to reject .. in refs
21 * 3: {, look for a preceding @ to reject @{ in refs
22 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
24 static unsigned char refname_disposition
[256] = {
25 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
26 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
27 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
28 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
29 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
30 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
31 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
32 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
36 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken
37 * refs (i.e., because the reference is about to be deleted anyway).
39 #define REF_DELETING 0x02
42 * Used as a flag in ref_update::flags when a loose ref is being
45 #define REF_ISPRUNING 0x04
48 * Used as a flag in ref_update::flags when the reference should be
49 * updated to new_sha1.
51 #define REF_HAVE_NEW 0x08
54 * Used as a flag in ref_update::flags when old_sha1 should be
57 #define REF_HAVE_OLD 0x10
60 * Used as a flag in ref_update::flags when the lockfile needs to be
63 #define REF_NEEDS_COMMIT 0x20
66 * Try to read one refname component from the front of refname.
67 * Return the length of the component found, or -1 if the component is
68 * not legal. It is legal if it is something reasonable to have under
69 * ".git/refs/"; We do not like it if:
71 * - any path component of it begins with ".", or
72 * - it has double dots "..", or
73 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
74 * - it ends with a "/".
75 * - it ends with ".lock"
76 * - it contains a "\" (backslash)
78 static int check_refname_component(const char *refname
, int flags
)
83 for (cp
= refname
; ; cp
++) {
85 unsigned char disp
= refname_disposition
[ch
];
91 return -1; /* Refname contains "..". */
95 return -1; /* Refname contains "@{". */
104 return 0; /* Component has zero length. */
105 if (refname
[0] == '.')
106 return -1; /* Component starts with '.'. */
107 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
108 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
109 return -1; /* Refname ends with ".lock". */
113 int check_refname_format(const char *refname
, int flags
)
115 int component_len
, component_count
= 0;
117 if (!strcmp(refname
, "@"))
118 /* Refname is a single character '@'. */
122 /* We are at the start of a path component. */
123 component_len
= check_refname_component(refname
, flags
);
124 if (component_len
<= 0) {
125 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
127 (refname
[1] == '\0' || refname
[1] == '/')) {
128 /* Accept one wildcard as a full refname component. */
129 flags
&= ~REFNAME_REFSPEC_PATTERN
;
136 if (refname
[component_len
] == '\0')
138 /* Skip to next component. */
139 refname
+= component_len
+ 1;
142 if (refname
[component_len
- 1] == '.')
143 return -1; /* Refname ends with '.'. */
144 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
145 return -1; /* Refname has only one component. */
152 * Information used (along with the information in ref_entry) to
153 * describe a single cached reference. This data structure only
154 * occurs embedded in a union in struct ref_entry, and only when
155 * (ref_entry->flag & REF_DIR) is zero.
159 * The name of the object to which this reference resolves
160 * (which may be a tag object). If REF_ISBROKEN, this is
161 * null. If REF_ISSYMREF, then this is the name of the object
162 * referred to by the last reference in the symlink chain.
164 struct object_id oid
;
167 * If REF_KNOWS_PEELED, then this field holds the peeled value
168 * of this reference, or null if the reference is known not to
169 * be peelable. See the documentation for peel_ref() for an
170 * exact definition of "peelable".
172 struct object_id peeled
;
178 * Information used (along with the information in ref_entry) to
179 * describe a level in the hierarchy of references. This data
180 * structure only occurs embedded in a union in struct ref_entry, and
181 * only when (ref_entry.flag & REF_DIR) is set. In that case,
182 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
183 * in the directory have already been read:
185 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
186 * or packed references, already read.
188 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
189 * references that hasn't been read yet (nor has any of its
192 * Entries within a directory are stored within a growable array of
193 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
194 * sorted are sorted by their component name in strcmp() order and the
195 * remaining entries are unsorted.
197 * Loose references are read lazily, one directory at a time. When a
198 * directory of loose references is read, then all of the references
199 * in that directory are stored, and REF_INCOMPLETE stubs are created
200 * for any subdirectories, but the subdirectories themselves are not
201 * read. The reading is triggered by get_ref_dir().
207 * Entries with index 0 <= i < sorted are sorted by name. New
208 * entries are appended to the list unsorted, and are sorted
209 * only when required; thus we avoid the need to sort the list
210 * after the addition of every reference.
214 /* A pointer to the ref_cache that contains this ref_dir. */
215 struct ref_cache
*ref_cache
;
217 struct ref_entry
**entries
;
221 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
222 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
223 * public values; see refs.h.
227 * The field ref_entry->u.value.peeled of this value entry contains
228 * the correct peeled value for the reference, which might be
229 * null_sha1 if the reference is not a tag or if it is broken.
231 #define REF_KNOWS_PEELED 0x10
233 /* ref_entry represents a directory of references */
237 * Entry has not yet been read from disk (used only for REF_DIR
238 * entries representing loose references)
240 #define REF_INCOMPLETE 0x40
243 * A ref_entry represents either a reference or a "subdirectory" of
246 * Each directory in the reference namespace is represented by a
247 * ref_entry with (flags & REF_DIR) set and containing a subdir member
248 * that holds the entries in that directory that have been read so
249 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
250 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
251 * used for loose reference directories.
253 * References are represented by a ref_entry with (flags & REF_DIR)
254 * unset and a value member that describes the reference's value. The
255 * flag member is at the ref_entry level, but it is also needed to
256 * interpret the contents of the value field (in other words, a
257 * ref_value object is not very much use without the enclosing
260 * Reference names cannot end with slash and directories' names are
261 * always stored with a trailing slash (except for the top-level
262 * directory, which is always denoted by ""). This has two nice
263 * consequences: (1) when the entries in each subdir are sorted
264 * lexicographically by name (as they usually are), the references in
265 * a whole tree can be generated in lexicographic order by traversing
266 * the tree in left-to-right, depth-first order; (2) the names of
267 * references and subdirectories cannot conflict, and therefore the
268 * presence of an empty subdirectory does not block the creation of a
269 * similarly-named reference. (The fact that reference names with the
270 * same leading components can conflict *with each other* is a
271 * separate issue that is regulated by verify_refname_available().)
273 * Please note that the name field contains the fully-qualified
274 * reference (or subdirectory) name. Space could be saved by only
275 * storing the relative names. But that would require the full names
276 * to be generated on the fly when iterating in do_for_each_ref(), and
277 * would break callback functions, who have always been able to assume
278 * that the name strings that they are passed will not be freed during
282 unsigned char flag
; /* ISSYMREF? ISPACKED? */
284 struct ref_value value
; /* if not (flags&REF_DIR) */
285 struct ref_dir subdir
; /* if (flags&REF_DIR) */
288 * The full name of the reference (e.g., "refs/heads/master")
289 * or the full name of the directory with a trailing slash
290 * (e.g., "refs/heads/"):
292 char name
[FLEX_ARRAY
];
295 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
297 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
300 assert(entry
->flag
& REF_DIR
);
301 dir
= &entry
->u
.subdir
;
302 if (entry
->flag
& REF_INCOMPLETE
) {
303 read_loose_refs(entry
->name
, dir
);
304 entry
->flag
&= ~REF_INCOMPLETE
;
310 * Check if a refname is safe.
311 * For refs that start with "refs/" we consider it safe as long they do
312 * not try to resolve to outside of refs/.
314 * For all other refs we only consider them safe iff they only contain
315 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
318 static int refname_is_safe(const char *refname
)
320 if (starts_with(refname
, "refs/")) {
324 buf
= xmalloc(strlen(refname
) + 1);
326 * Does the refname try to escape refs/?
327 * For example: refs/foo/../bar is safe but refs/foo/../../bar
330 result
= !normalize_path_copy(buf
, refname
+ strlen("refs/"));
335 if (!isupper(*refname
) && *refname
!= '_')
342 static struct ref_entry
*create_ref_entry(const char *refname
,
343 const unsigned char *sha1
, int flag
,
347 struct ref_entry
*ref
;
350 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
351 die("Reference has invalid format: '%s'", refname
);
352 len
= strlen(refname
) + 1;
353 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
354 hashcpy(ref
->u
.value
.oid
.hash
, sha1
);
355 oidclr(&ref
->u
.value
.peeled
);
356 memcpy(ref
->name
, refname
, len
);
361 static void clear_ref_dir(struct ref_dir
*dir
);
363 static void free_ref_entry(struct ref_entry
*entry
)
365 if (entry
->flag
& REF_DIR
) {
367 * Do not use get_ref_dir() here, as that might
368 * trigger the reading of loose refs.
370 clear_ref_dir(&entry
->u
.subdir
);
376 * Add a ref_entry to the end of dir (unsorted). Entry is always
377 * stored directly in dir; no recursion into subdirectories is
380 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
382 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
383 dir
->entries
[dir
->nr
++] = entry
;
384 /* optimize for the case that entries are added in order */
386 (dir
->nr
== dir
->sorted
+ 1 &&
387 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
388 dir
->entries
[dir
->nr
- 1]->name
) < 0))
389 dir
->sorted
= dir
->nr
;
393 * Clear and free all entries in dir, recursively.
395 static void clear_ref_dir(struct ref_dir
*dir
)
398 for (i
= 0; i
< dir
->nr
; i
++)
399 free_ref_entry(dir
->entries
[i
]);
401 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
406 * Create a struct ref_entry object for the specified dirname.
407 * dirname is the name of the directory with a trailing slash (e.g.,
408 * "refs/heads/") or "" for the top-level directory.
410 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
411 const char *dirname
, size_t len
,
414 struct ref_entry
*direntry
;
415 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
416 memcpy(direntry
->name
, dirname
, len
);
417 direntry
->name
[len
] = '\0';
418 direntry
->u
.subdir
.ref_cache
= ref_cache
;
419 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
423 static int ref_entry_cmp(const void *a
, const void *b
)
425 struct ref_entry
*one
= *(struct ref_entry
**)a
;
426 struct ref_entry
*two
= *(struct ref_entry
**)b
;
427 return strcmp(one
->name
, two
->name
);
430 static void sort_ref_dir(struct ref_dir
*dir
);
432 struct string_slice
{
437 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
439 const struct string_slice
*key
= key_
;
440 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
441 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
444 return '\0' - (unsigned char)ent
->name
[key
->len
];
448 * Return the index of the entry with the given refname from the
449 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
450 * no such entry is found. dir must already be complete.
452 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
454 struct ref_entry
**r
;
455 struct string_slice key
;
457 if (refname
== NULL
|| !dir
->nr
)
463 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
464 ref_entry_cmp_sslice
);
469 return r
- dir
->entries
;
473 * Search for a directory entry directly within dir (without
474 * recursing). Sort dir if necessary. subdirname must be a directory
475 * name (i.e., end in '/'). If mkdir is set, then create the
476 * directory if it is missing; otherwise, return NULL if the desired
477 * directory cannot be found. dir must already be complete.
479 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
480 const char *subdirname
, size_t len
,
483 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
484 struct ref_entry
*entry
;
485 if (entry_index
== -1) {
489 * Since dir is complete, the absence of a subdir
490 * means that the subdir really doesn't exist;
491 * therefore, create an empty record for it but mark
492 * the record complete.
494 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
495 add_entry_to_dir(dir
, entry
);
497 entry
= dir
->entries
[entry_index
];
499 return get_ref_dir(entry
);
503 * If refname is a reference name, find the ref_dir within the dir
504 * tree that should hold refname. If refname is a directory name
505 * (i.e., ends in '/'), then return that ref_dir itself. dir must
506 * represent the top-level directory and must already be complete.
507 * Sort ref_dirs and recurse into subdirectories as necessary. If
508 * mkdir is set, then create any missing directories; otherwise,
509 * return NULL if the desired directory cannot be found.
511 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
512 const char *refname
, int mkdir
)
515 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
516 size_t dirnamelen
= slash
- refname
+ 1;
517 struct ref_dir
*subdir
;
518 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
530 * Find the value entry with the given name in dir, sorting ref_dirs
531 * and recursing into subdirectories as necessary. If the name is not
532 * found or it corresponds to a directory entry, return NULL.
534 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
537 struct ref_entry
*entry
;
538 dir
= find_containing_dir(dir
, refname
, 0);
541 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
542 if (entry_index
== -1)
544 entry
= dir
->entries
[entry_index
];
545 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
549 * Remove the entry with the given name from dir, recursing into
550 * subdirectories as necessary. If refname is the name of a directory
551 * (i.e., ends with '/'), then remove the directory and its contents.
552 * If the removal was successful, return the number of entries
553 * remaining in the directory entry that contained the deleted entry.
554 * If the name was not found, return -1. Please note that this
555 * function only deletes the entry from the cache; it does not delete
556 * it from the filesystem or ensure that other cache entries (which
557 * might be symbolic references to the removed entry) are updated.
558 * Nor does it remove any containing dir entries that might be made
559 * empty by the removal. dir must represent the top-level directory
560 * and must already be complete.
562 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
564 int refname_len
= strlen(refname
);
566 struct ref_entry
*entry
;
567 int is_dir
= refname
[refname_len
- 1] == '/';
570 * refname represents a reference directory. Remove
571 * the trailing slash; otherwise we will get the
572 * directory *representing* refname rather than the
573 * one *containing* it.
575 char *dirname
= xmemdupz(refname
, refname_len
- 1);
576 dir
= find_containing_dir(dir
, dirname
, 0);
579 dir
= find_containing_dir(dir
, refname
, 0);
583 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
584 if (entry_index
== -1)
586 entry
= dir
->entries
[entry_index
];
588 memmove(&dir
->entries
[entry_index
],
589 &dir
->entries
[entry_index
+ 1],
590 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
593 if (dir
->sorted
> entry_index
)
595 free_ref_entry(entry
);
600 * Add a ref_entry to the ref_dir (unsorted), recursing into
601 * subdirectories as necessary. dir must represent the top-level
602 * directory. Return 0 on success.
604 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
606 dir
= find_containing_dir(dir
, ref
->name
, 1);
609 add_entry_to_dir(dir
, ref
);
614 * Emit a warning and return true iff ref1 and ref2 have the same name
615 * and the same sha1. Die if they have the same name but different
618 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
620 if (strcmp(ref1
->name
, ref2
->name
))
623 /* Duplicate name; make sure that they don't conflict: */
625 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
626 /* This is impossible by construction */
627 die("Reference directory conflict: %s", ref1
->name
);
629 if (oidcmp(&ref1
->u
.value
.oid
, &ref2
->u
.value
.oid
))
630 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
632 warning("Duplicated ref: %s", ref1
->name
);
637 * Sort the entries in dir non-recursively (if they are not already
638 * sorted) and remove any duplicate entries.
640 static void sort_ref_dir(struct ref_dir
*dir
)
643 struct ref_entry
*last
= NULL
;
646 * This check also prevents passing a zero-length array to qsort(),
647 * which is a problem on some platforms.
649 if (dir
->sorted
== dir
->nr
)
652 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
654 /* Remove any duplicates: */
655 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
656 struct ref_entry
*entry
= dir
->entries
[j
];
657 if (last
&& is_dup_ref(last
, entry
))
658 free_ref_entry(entry
);
660 last
= dir
->entries
[i
++] = entry
;
662 dir
->sorted
= dir
->nr
= i
;
665 /* Include broken references in a do_for_each_ref*() iteration: */
666 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
669 * Return true iff the reference described by entry can be resolved to
670 * an object in the database. Emit a warning if the referred-to
671 * object does not exist.
673 static int ref_resolves_to_object(struct ref_entry
*entry
)
675 if (entry
->flag
& REF_ISBROKEN
)
677 if (!has_sha1_file(entry
->u
.value
.oid
.hash
)) {
678 error("%s does not point to a valid object!", entry
->name
);
685 * current_ref is a performance hack: when iterating over references
686 * using the for_each_ref*() functions, current_ref is set to the
687 * current reference's entry before calling the callback function. If
688 * the callback function calls peel_ref(), then peel_ref() first
689 * checks whether the reference to be peeled is the current reference
690 * (it usually is) and if so, returns that reference's peeled version
691 * if it is available. This avoids a refname lookup in a common case.
693 static struct ref_entry
*current_ref
;
695 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
697 struct ref_entry_cb
{
706 * Handle one reference in a do_for_each_ref*()-style iteration,
707 * calling an each_ref_fn for each entry.
709 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
711 struct ref_entry_cb
*data
= cb_data
;
712 struct ref_entry
*old_current_ref
;
715 if (!starts_with(entry
->name
, data
->base
))
718 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
719 !ref_resolves_to_object(entry
))
722 /* Store the old value, in case this is a recursive call: */
723 old_current_ref
= current_ref
;
725 retval
= data
->fn(entry
->name
+ data
->trim
, &entry
->u
.value
.oid
,
726 entry
->flag
, data
->cb_data
);
727 current_ref
= old_current_ref
;
732 * Call fn for each reference in dir that has index in the range
733 * offset <= index < dir->nr. Recurse into subdirectories that are in
734 * that index range, sorting them before iterating. This function
735 * does not sort dir itself; it should be sorted beforehand. fn is
736 * called for all references, including broken ones.
738 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
739 each_ref_entry_fn fn
, void *cb_data
)
742 assert(dir
->sorted
== dir
->nr
);
743 for (i
= offset
; i
< dir
->nr
; i
++) {
744 struct ref_entry
*entry
= dir
->entries
[i
];
746 if (entry
->flag
& REF_DIR
) {
747 struct ref_dir
*subdir
= get_ref_dir(entry
);
748 sort_ref_dir(subdir
);
749 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
751 retval
= fn(entry
, cb_data
);
760 * Call fn for each reference in the union of dir1 and dir2, in order
761 * by refname. Recurse into subdirectories. If a value entry appears
762 * in both dir1 and dir2, then only process the version that is in
763 * dir2. The input dirs must already be sorted, but subdirs will be
764 * sorted as needed. fn is called for all references, including
767 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
768 struct ref_dir
*dir2
,
769 each_ref_entry_fn fn
, void *cb_data
)
774 assert(dir1
->sorted
== dir1
->nr
);
775 assert(dir2
->sorted
== dir2
->nr
);
777 struct ref_entry
*e1
, *e2
;
779 if (i1
== dir1
->nr
) {
780 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
782 if (i2
== dir2
->nr
) {
783 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
785 e1
= dir1
->entries
[i1
];
786 e2
= dir2
->entries
[i2
];
787 cmp
= strcmp(e1
->name
, e2
->name
);
789 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
790 /* Both are directories; descend them in parallel. */
791 struct ref_dir
*subdir1
= get_ref_dir(e1
);
792 struct ref_dir
*subdir2
= get_ref_dir(e2
);
793 sort_ref_dir(subdir1
);
794 sort_ref_dir(subdir2
);
795 retval
= do_for_each_entry_in_dirs(
796 subdir1
, subdir2
, fn
, cb_data
);
799 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
800 /* Both are references; ignore the one from dir1. */
801 retval
= fn(e2
, cb_data
);
805 die("conflict between reference and directory: %s",
817 if (e
->flag
& REF_DIR
) {
818 struct ref_dir
*subdir
= get_ref_dir(e
);
819 sort_ref_dir(subdir
);
820 retval
= do_for_each_entry_in_dir(
821 subdir
, 0, fn
, cb_data
);
823 retval
= fn(e
, cb_data
);
832 * Load all of the refs from the dir into our in-memory cache. The hard work
833 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
834 * through all of the sub-directories. We do not even need to care about
835 * sorting, as traversal order does not matter to us.
837 static void prime_ref_dir(struct ref_dir
*dir
)
840 for (i
= 0; i
< dir
->nr
; i
++) {
841 struct ref_entry
*entry
= dir
->entries
[i
];
842 if (entry
->flag
& REF_DIR
)
843 prime_ref_dir(get_ref_dir(entry
));
847 struct nonmatching_ref_data
{
848 const struct string_list
*skip
;
849 const char *conflicting_refname
;
852 static int nonmatching_ref_fn(struct ref_entry
*entry
, void *vdata
)
854 struct nonmatching_ref_data
*data
= vdata
;
856 if (data
->skip
&& string_list_has_string(data
->skip
, entry
->name
))
859 data
->conflicting_refname
= entry
->name
;
864 * Return 0 if a reference named refname could be created without
865 * conflicting with the name of an existing reference in dir.
866 * Otherwise, return a negative value and write an explanation to err.
867 * If extras is non-NULL, it is a list of additional refnames with
868 * which refname is not allowed to conflict. If skip is non-NULL,
869 * ignore potential conflicts with refs in skip (e.g., because they
870 * are scheduled for deletion in the same operation). Behavior is
871 * undefined if the same name is listed in both extras and skip.
873 * Two reference names conflict if one of them exactly matches the
874 * leading components of the other; e.g., "refs/foo/bar" conflicts
875 * with both "refs/foo" and with "refs/foo/bar/baz" but not with
876 * "refs/foo/bar" or "refs/foo/barbados".
878 * extras and skip must be sorted.
880 static int verify_refname_available(const char *refname
,
881 const struct string_list
*extras
,
882 const struct string_list
*skip
,
888 struct strbuf dirname
= STRBUF_INIT
;
892 * For the sake of comments in this function, suppose that
893 * refname is "refs/foo/bar".
898 strbuf_grow(&dirname
, strlen(refname
) + 1);
899 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
900 /* Expand dirname to the new prefix, not including the trailing slash: */
901 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
904 * We are still at a leading dir of the refname (e.g.,
905 * "refs/foo"; if there is a reference with that name,
906 * it is a conflict, *unless* it is in skip.
909 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
911 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
913 * We found a reference whose name is
914 * a proper prefix of refname; e.g.,
915 * "refs/foo", and is not in skip.
917 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
918 dirname
.buf
, refname
);
923 if (extras
&& string_list_has_string(extras
, dirname
.buf
) &&
924 (!skip
|| !string_list_has_string(skip
, dirname
.buf
))) {
925 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
926 refname
, dirname
.buf
);
931 * Otherwise, we can try to continue our search with
932 * the next component. So try to look up the
933 * directory, e.g., "refs/foo/". If we come up empty,
934 * we know there is nothing under this whole prefix,
935 * but even in that case we still have to continue the
936 * search for conflicts with extras.
938 strbuf_addch(&dirname
, '/');
940 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
943 * There was no directory "refs/foo/",
944 * so there is nothing under this
945 * whole prefix. So there is no need
946 * to continue looking for conflicting
947 * references. But we need to continue
948 * looking for conflicting extras.
952 dir
= get_ref_dir(dir
->entries
[pos
]);
958 * We are at the leaf of our refname (e.g., "refs/foo/bar").
959 * There is no point in searching for a reference with that
960 * name, because a refname isn't considered to conflict with
961 * itself. But we still need to check for references whose
962 * names are in the "refs/foo/bar/" namespace, because they
965 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
966 strbuf_addch(&dirname
, '/');
969 pos
= search_ref_dir(dir
, dirname
.buf
, dirname
.len
);
973 * We found a directory named "$refname/"
974 * (e.g., "refs/foo/bar/"). It is a problem
975 * iff it contains any ref that is not in
978 struct nonmatching_ref_data data
;
981 data
.conflicting_refname
= NULL
;
982 dir
= get_ref_dir(dir
->entries
[pos
]);
984 if (do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
)) {
985 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
986 data
.conflicting_refname
, refname
);
994 * Check for entries in extras that start with
995 * "$refname/". We do that by looking for the place
996 * where "$refname/" would be inserted in extras. If
997 * there is an entry at that position that starts with
998 * "$refname/" and is not in skip, then we have a
1001 for (pos
= string_list_find_insert_index(extras
, dirname
.buf
, 0);
1002 pos
< extras
->nr
; pos
++) {
1003 const char *extra_refname
= extras
->items
[pos
].string
;
1005 if (!starts_with(extra_refname
, dirname
.buf
))
1008 if (!skip
|| !string_list_has_string(skip
, extra_refname
)) {
1009 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1010 refname
, extra_refname
);
1016 /* No conflicts were found */
1020 strbuf_release(&dirname
);
1024 struct packed_ref_cache
{
1025 struct ref_entry
*root
;
1028 * Count of references to the data structure in this instance,
1029 * including the pointer from ref_cache::packed if any. The
1030 * data will not be freed as long as the reference count is
1033 unsigned int referrers
;
1036 * Iff the packed-refs file associated with this instance is
1037 * currently locked for writing, this points at the associated
1038 * lock (which is owned by somebody else). The referrer count
1039 * is also incremented when the file is locked and decremented
1040 * when it is unlocked.
1042 struct lock_file
*lock
;
1044 /* The metadata from when this packed-refs cache was read */
1045 struct stat_validity validity
;
1049 * Future: need to be in "struct repository"
1050 * when doing a full libification.
1052 static struct ref_cache
{
1053 struct ref_cache
*next
;
1054 struct ref_entry
*loose
;
1055 struct packed_ref_cache
*packed
;
1057 * The submodule name, or "" for the main repo. We allocate
1058 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1059 * is initialized correctly.
1062 } ref_cache
, *submodule_ref_caches
;
1064 /* Lock used for the main packed-refs file: */
1065 static struct lock_file packlock
;
1068 * Increment the reference count of *packed_refs.
1070 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1072 packed_refs
->referrers
++;
1076 * Decrease the reference count of *packed_refs. If it goes to zero,
1077 * free *packed_refs and return true; otherwise return false.
1079 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1081 if (!--packed_refs
->referrers
) {
1082 free_ref_entry(packed_refs
->root
);
1083 stat_validity_clear(&packed_refs
->validity
);
1091 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1094 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1096 if (packed_refs
->lock
)
1097 die("internal error: packed-ref cache cleared while locked");
1098 refs
->packed
= NULL
;
1099 release_packed_ref_cache(packed_refs
);
1103 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1106 free_ref_entry(refs
->loose
);
1111 static struct ref_cache
*create_ref_cache(const char *submodule
)
1114 struct ref_cache
*refs
;
1117 len
= strlen(submodule
) + 1;
1118 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1119 memcpy(refs
->name
, submodule
, len
);
1124 * Return a pointer to a ref_cache for the specified submodule. For
1125 * the main repository, use submodule==NULL. The returned structure
1126 * will be allocated and initialized but not necessarily populated; it
1127 * should not be freed.
1129 static struct ref_cache
*get_ref_cache(const char *submodule
)
1131 struct ref_cache
*refs
;
1133 if (!submodule
|| !*submodule
)
1136 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1137 if (!strcmp(submodule
, refs
->name
))
1140 refs
= create_ref_cache(submodule
);
1141 refs
->next
= submodule_ref_caches
;
1142 submodule_ref_caches
= refs
;
1146 /* The length of a peeled reference line in packed-refs, including EOL: */
1147 #define PEELED_LINE_LENGTH 42
1150 * The packed-refs header line that we write out. Perhaps other
1151 * traits will be added later. The trailing space is required.
1153 static const char PACKED_REFS_HEADER
[] =
1154 "# pack-refs with: peeled fully-peeled \n";
1157 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1158 * Return a pointer to the refname within the line (null-terminated),
1159 * or NULL if there was a problem.
1161 static const char *parse_ref_line(struct strbuf
*line
, unsigned char *sha1
)
1166 * 42: the answer to everything.
1168 * In this case, it happens to be the answer to
1169 * 40 (length of sha1 hex representation)
1170 * +1 (space in between hex and name)
1171 * +1 (newline at the end of the line)
1173 if (line
->len
<= 42)
1176 if (get_sha1_hex(line
->buf
, sha1
) < 0)
1178 if (!isspace(line
->buf
[40]))
1181 ref
= line
->buf
+ 41;
1185 if (line
->buf
[line
->len
- 1] != '\n')
1187 line
->buf
[--line
->len
] = 0;
1193 * Read f, which is a packed-refs file, into dir.
1195 * A comment line of the form "# pack-refs with: " may contain zero or
1196 * more traits. We interpret the traits as follows:
1200 * Probably no references are peeled. But if the file contains a
1201 * peeled value for a reference, we will use it.
1205 * References under "refs/tags/", if they *can* be peeled, *are*
1206 * peeled in this file. References outside of "refs/tags/" are
1207 * probably not peeled even if they could have been, but if we find
1208 * a peeled value for such a reference we will use it.
1212 * All references in the file that can be peeled are peeled.
1213 * Inversely (and this is more important), any references in the
1214 * file for which no peeled value is recorded is not peelable. This
1215 * trait should typically be written alongside "peeled" for
1216 * compatibility with older clients, but we do not require it
1217 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1219 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1221 struct ref_entry
*last
= NULL
;
1222 struct strbuf line
= STRBUF_INIT
;
1223 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1225 while (strbuf_getwholeline(&line
, f
, '\n') != EOF
) {
1226 unsigned char sha1
[20];
1227 const char *refname
;
1230 if (skip_prefix(line
.buf
, "# pack-refs with:", &traits
)) {
1231 if (strstr(traits
, " fully-peeled "))
1232 peeled
= PEELED_FULLY
;
1233 else if (strstr(traits
, " peeled "))
1234 peeled
= PEELED_TAGS
;
1235 /* perhaps other traits later as well */
1239 refname
= parse_ref_line(&line
, sha1
);
1241 int flag
= REF_ISPACKED
;
1243 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1244 if (!refname_is_safe(refname
))
1245 die("packed refname is dangerous: %s", refname
);
1247 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1249 last
= create_ref_entry(refname
, sha1
, flag
, 0);
1250 if (peeled
== PEELED_FULLY
||
1251 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1252 last
->flag
|= REF_KNOWS_PEELED
;
1257 line
.buf
[0] == '^' &&
1258 line
.len
== PEELED_LINE_LENGTH
&&
1259 line
.buf
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1260 !get_sha1_hex(line
.buf
+ 1, sha1
)) {
1261 hashcpy(last
->u
.value
.peeled
.hash
, sha1
);
1263 * Regardless of what the file header said,
1264 * we definitely know the value of *this*
1267 last
->flag
|= REF_KNOWS_PEELED
;
1271 strbuf_release(&line
);
1275 * Get the packed_ref_cache for the specified ref_cache, creating it
1278 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1280 const char *packed_refs_file
;
1283 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1285 packed_refs_file
= git_path("packed-refs");
1288 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1289 clear_packed_ref_cache(refs
);
1291 if (!refs
->packed
) {
1294 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1295 acquire_packed_ref_cache(refs
->packed
);
1296 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1297 f
= fopen(packed_refs_file
, "r");
1299 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1300 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1304 return refs
->packed
;
1307 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1309 return get_ref_dir(packed_ref_cache
->root
);
1312 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1314 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1317 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1319 struct packed_ref_cache
*packed_ref_cache
=
1320 get_packed_ref_cache(&ref_cache
);
1322 if (!packed_ref_cache
->lock
)
1323 die("internal error: packed refs not locked");
1324 add_ref(get_packed_ref_dir(packed_ref_cache
),
1325 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1329 * Read the loose references from the namespace dirname into dir
1330 * (without recursing). dirname must end with '/'. dir must be the
1331 * directory entry corresponding to dirname.
1333 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1335 struct ref_cache
*refs
= dir
->ref_cache
;
1339 int dirnamelen
= strlen(dirname
);
1340 struct strbuf refname
;
1343 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1345 path
= git_path("%s", dirname
);
1351 strbuf_init(&refname
, dirnamelen
+ 257);
1352 strbuf_add(&refname
, dirname
, dirnamelen
);
1354 while ((de
= readdir(d
)) != NULL
) {
1355 unsigned char sha1
[20];
1360 if (de
->d_name
[0] == '.')
1362 if (ends_with(de
->d_name
, ".lock"))
1364 strbuf_addstr(&refname
, de
->d_name
);
1365 refdir
= *refs
->name
1366 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1367 : git_path("%s", refname
.buf
);
1368 if (stat(refdir
, &st
) < 0) {
1369 ; /* silently ignore */
1370 } else if (S_ISDIR(st
.st_mode
)) {
1371 strbuf_addch(&refname
, '/');
1372 add_entry_to_dir(dir
,
1373 create_dir_entry(refs
, refname
.buf
,
1381 read_ok
= !resolve_gitlink_ref(refs
->name
,
1384 read_ok
= !read_ref_full(refname
.buf
,
1385 RESOLVE_REF_READING
,
1391 flag
|= REF_ISBROKEN
;
1392 } else if (is_null_sha1(sha1
)) {
1394 * It is so astronomically unlikely
1395 * that NULL_SHA1 is the SHA-1 of an
1396 * actual object that we consider its
1397 * appearance in a loose reference
1398 * file to be repo corruption
1399 * (probably due to a software bug).
1401 flag
|= REF_ISBROKEN
;
1404 if (check_refname_format(refname
.buf
,
1405 REFNAME_ALLOW_ONELEVEL
)) {
1406 if (!refname_is_safe(refname
.buf
))
1407 die("loose refname is dangerous: %s", refname
.buf
);
1409 flag
|= REF_BAD_NAME
| REF_ISBROKEN
;
1411 add_entry_to_dir(dir
,
1412 create_ref_entry(refname
.buf
, sha1
, flag
, 0));
1414 strbuf_setlen(&refname
, dirnamelen
);
1416 strbuf_release(&refname
);
1420 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1424 * Mark the top-level directory complete because we
1425 * are about to read the only subdirectory that can
1428 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1430 * Create an incomplete entry for "refs/":
1432 add_entry_to_dir(get_ref_dir(refs
->loose
),
1433 create_dir_entry(refs
, "refs/", 5, 1));
1435 return get_ref_dir(refs
->loose
);
1438 /* We allow "recursive" symbolic refs. Only within reason, though */
1440 #define MAXREFLEN (1024)
1443 * Called by resolve_gitlink_ref_recursive() after it failed to read
1444 * from the loose refs in ref_cache refs. Find <refname> in the
1445 * packed-refs file for the submodule.
1447 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1448 const char *refname
, unsigned char *sha1
)
1450 struct ref_entry
*ref
;
1451 struct ref_dir
*dir
= get_packed_refs(refs
);
1453 ref
= find_ref(dir
, refname
);
1457 hashcpy(sha1
, ref
->u
.value
.oid
.hash
);
1461 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1462 const char *refname
, unsigned char *sha1
,
1466 char buffer
[128], *p
;
1469 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1472 ? git_path_submodule(refs
->name
, "%s", refname
)
1473 : git_path("%s", refname
);
1474 fd
= open(path
, O_RDONLY
);
1476 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1478 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1482 while (len
&& isspace(buffer
[len
-1]))
1486 /* Was it a detached head or an old-fashioned symlink? */
1487 if (!get_sha1_hex(buffer
, sha1
))
1491 if (strncmp(buffer
, "ref:", 4))
1497 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1500 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1502 int len
= strlen(path
), retval
;
1504 struct ref_cache
*refs
;
1506 while (len
&& path
[len
-1] == '/')
1510 submodule
= xstrndup(path
, len
);
1511 refs
= get_ref_cache(submodule
);
1514 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1519 * Return the ref_entry for the given refname from the packed
1520 * references. If it does not exist, return NULL.
1522 static struct ref_entry
*get_packed_ref(const char *refname
)
1524 return find_ref(get_packed_refs(&ref_cache
), refname
);
1528 * A loose ref file doesn't exist; check for a packed ref. The
1529 * options are forwarded from resolve_safe_unsafe().
1531 static int resolve_missing_loose_ref(const char *refname
,
1533 unsigned char *sha1
,
1536 struct ref_entry
*entry
;
1539 * The loose reference file does not exist; check for a packed
1542 entry
= get_packed_ref(refname
);
1544 hashcpy(sha1
, entry
->u
.value
.oid
.hash
);
1546 *flags
|= REF_ISPACKED
;
1549 /* The reference is not a packed reference, either. */
1550 if (resolve_flags
& RESOLVE_REF_READING
) {
1559 /* This function needs to return a meaningful errno on failure */
1560 static const char *resolve_ref_unsafe_1(const char *refname
,
1562 unsigned char *sha1
,
1564 struct strbuf
*sb_path
)
1566 int depth
= MAXDEPTH
;
1569 static char refname_buffer
[256];
1575 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1577 *flags
|= REF_BAD_NAME
;
1579 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1580 !refname_is_safe(refname
)) {
1585 * dwim_ref() uses REF_ISBROKEN to distinguish between
1586 * missing refs and refs that were present but invalid,
1587 * to complain about the latter to stderr.
1589 * We don't know whether the ref exists, so don't set
1605 strbuf_reset(sb_path
);
1606 strbuf_git_path(sb_path
, "%s", refname
);
1607 path
= sb_path
->buf
;
1610 * We might have to loop back here to avoid a race
1611 * condition: first we lstat() the file, then we try
1612 * to read it as a link or as a file. But if somebody
1613 * changes the type of the file (file <-> directory
1614 * <-> symlink) between the lstat() and reading, then
1615 * we don't want to report that as an error but rather
1616 * try again starting with the lstat().
1619 if (lstat(path
, &st
) < 0) {
1620 if (errno
!= ENOENT
)
1622 if (resolve_missing_loose_ref(refname
, resolve_flags
,
1628 *flags
|= REF_ISBROKEN
;
1633 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1634 if (S_ISLNK(st
.st_mode
)) {
1635 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1637 if (errno
== ENOENT
|| errno
== EINVAL
)
1638 /* inconsistent with lstat; retry */
1644 if (starts_with(buffer
, "refs/") &&
1645 !check_refname_format(buffer
, 0)) {
1646 strcpy(refname_buffer
, buffer
);
1647 refname
= refname_buffer
;
1649 *flags
|= REF_ISSYMREF
;
1650 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1658 /* Is it a directory? */
1659 if (S_ISDIR(st
.st_mode
)) {
1665 * Anything else, just open it and try to use it as
1668 fd
= open(path
, O_RDONLY
);
1670 if (errno
== ENOENT
)
1671 /* inconsistent with lstat; retry */
1676 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1678 int save_errno
= errno
;
1684 while (len
&& isspace(buffer
[len
-1]))
1689 * Is it a symbolic ref?
1691 if (!starts_with(buffer
, "ref:")) {
1693 * Please note that FETCH_HEAD has a second
1694 * line containing other data.
1696 if (get_sha1_hex(buffer
, sha1
) ||
1697 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1699 *flags
|= REF_ISBROKEN
;
1706 *flags
|= REF_ISBROKEN
;
1711 *flags
|= REF_ISSYMREF
;
1713 while (isspace(*buf
))
1715 refname
= strcpy(refname_buffer
, buf
);
1716 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1720 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1722 *flags
|= REF_ISBROKEN
;
1724 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1725 !refname_is_safe(buf
)) {
1734 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1735 unsigned char *sha1
, int *flags
)
1737 struct strbuf sb_path
= STRBUF_INIT
;
1738 const char *ret
= resolve_ref_unsafe_1(refname
, resolve_flags
,
1739 sha1
, flags
, &sb_path
);
1740 strbuf_release(&sb_path
);
1744 char *resolve_refdup(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1746 return xstrdup_or_null(resolve_ref_unsafe(ref
, resolve_flags
, sha1
, flags
));
1749 /* The argument to filter_refs */
1751 const char *pattern
;
1756 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1758 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1763 int read_ref(const char *refname
, unsigned char *sha1
)
1765 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1768 int ref_exists(const char *refname
)
1770 unsigned char sha1
[20];
1771 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1774 static int filter_refs(const char *refname
, const struct object_id
*oid
,
1775 int flags
, void *data
)
1777 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1779 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1781 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
1785 /* object was peeled successfully: */
1789 * object cannot be peeled because the named object (or an
1790 * object referred to by a tag in the peel chain), does not
1795 /* object cannot be peeled because it is not a tag: */
1798 /* ref_entry contains no peeled value because it is a symref: */
1799 PEEL_IS_SYMREF
= -3,
1802 * ref_entry cannot be peeled because it is broken (i.e., the
1803 * symbolic reference cannot even be resolved to an object
1810 * Peel the named object; i.e., if the object is a tag, resolve the
1811 * tag recursively until a non-tag is found. If successful, store the
1812 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1813 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1814 * and leave sha1 unchanged.
1816 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1818 struct object
*o
= lookup_unknown_object(name
);
1820 if (o
->type
== OBJ_NONE
) {
1821 int type
= sha1_object_info(name
, NULL
);
1822 if (type
< 0 || !object_as_type(o
, type
, 0))
1823 return PEEL_INVALID
;
1826 if (o
->type
!= OBJ_TAG
)
1827 return PEEL_NON_TAG
;
1829 o
= deref_tag_noverify(o
);
1831 return PEEL_INVALID
;
1833 hashcpy(sha1
, o
->sha1
);
1838 * Peel the entry (if possible) and return its new peel_status. If
1839 * repeel is true, re-peel the entry even if there is an old peeled
1840 * value that is already stored in it.
1842 * It is OK to call this function with a packed reference entry that
1843 * might be stale and might even refer to an object that has since
1844 * been garbage-collected. In such a case, if the entry has
1845 * REF_KNOWS_PEELED then leave the status unchanged and return
1846 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1848 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1850 enum peel_status status
;
1852 if (entry
->flag
& REF_KNOWS_PEELED
) {
1854 entry
->flag
&= ~REF_KNOWS_PEELED
;
1855 oidclr(&entry
->u
.value
.peeled
);
1857 return is_null_oid(&entry
->u
.value
.peeled
) ?
1858 PEEL_NON_TAG
: PEEL_PEELED
;
1861 if (entry
->flag
& REF_ISBROKEN
)
1863 if (entry
->flag
& REF_ISSYMREF
)
1864 return PEEL_IS_SYMREF
;
1866 status
= peel_object(entry
->u
.value
.oid
.hash
, entry
->u
.value
.peeled
.hash
);
1867 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1868 entry
->flag
|= REF_KNOWS_PEELED
;
1872 int peel_ref(const char *refname
, unsigned char *sha1
)
1875 unsigned char base
[20];
1877 if (current_ref
&& (current_ref
->name
== refname
1878 || !strcmp(current_ref
->name
, refname
))) {
1879 if (peel_entry(current_ref
, 0))
1881 hashcpy(sha1
, current_ref
->u
.value
.peeled
.hash
);
1885 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1889 * If the reference is packed, read its ref_entry from the
1890 * cache in the hope that we already know its peeled value.
1891 * We only try this optimization on packed references because
1892 * (a) forcing the filling of the loose reference cache could
1893 * be expensive and (b) loose references anyway usually do not
1894 * have REF_KNOWS_PEELED.
1896 if (flag
& REF_ISPACKED
) {
1897 struct ref_entry
*r
= get_packed_ref(refname
);
1899 if (peel_entry(r
, 0))
1901 hashcpy(sha1
, r
->u
.value
.peeled
.hash
);
1906 return peel_object(base
, sha1
);
1909 struct warn_if_dangling_data
{
1911 const char *refname
;
1912 const struct string_list
*refnames
;
1913 const char *msg_fmt
;
1916 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
1917 int flags
, void *cb_data
)
1919 struct warn_if_dangling_data
*d
= cb_data
;
1920 const char *resolves_to
;
1921 struct object_id junk
;
1923 if (!(flags
& REF_ISSYMREF
))
1926 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
.hash
, NULL
);
1929 ? strcmp(resolves_to
, d
->refname
)
1930 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1934 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1939 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1941 struct warn_if_dangling_data data
;
1944 data
.refname
= refname
;
1945 data
.refnames
= NULL
;
1946 data
.msg_fmt
= msg_fmt
;
1947 for_each_rawref(warn_if_dangling_symref
, &data
);
1950 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1952 struct warn_if_dangling_data data
;
1955 data
.refname
= NULL
;
1956 data
.refnames
= refnames
;
1957 data
.msg_fmt
= msg_fmt
;
1958 for_each_rawref(warn_if_dangling_symref
, &data
);
1962 * Call fn for each reference in the specified ref_cache, omitting
1963 * references not in the containing_dir of base. fn is called for all
1964 * references, including broken ones. If fn ever returns a non-zero
1965 * value, stop the iteration and return that value; otherwise, return
1968 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1969 each_ref_entry_fn fn
, void *cb_data
)
1971 struct packed_ref_cache
*packed_ref_cache
;
1972 struct ref_dir
*loose_dir
;
1973 struct ref_dir
*packed_dir
;
1977 * We must make sure that all loose refs are read before accessing the
1978 * packed-refs file; this avoids a race condition in which loose refs
1979 * are migrated to the packed-refs file by a simultaneous process, but
1980 * our in-memory view is from before the migration. get_packed_ref_cache()
1981 * takes care of making sure our view is up to date with what is on
1984 loose_dir
= get_loose_refs(refs
);
1985 if (base
&& *base
) {
1986 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1989 prime_ref_dir(loose_dir
);
1991 packed_ref_cache
= get_packed_ref_cache(refs
);
1992 acquire_packed_ref_cache(packed_ref_cache
);
1993 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1994 if (base
&& *base
) {
1995 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1998 if (packed_dir
&& loose_dir
) {
1999 sort_ref_dir(packed_dir
);
2000 sort_ref_dir(loose_dir
);
2001 retval
= do_for_each_entry_in_dirs(
2002 packed_dir
, loose_dir
, fn
, cb_data
);
2003 } else if (packed_dir
) {
2004 sort_ref_dir(packed_dir
);
2005 retval
= do_for_each_entry_in_dir(
2006 packed_dir
, 0, fn
, cb_data
);
2007 } else if (loose_dir
) {
2008 sort_ref_dir(loose_dir
);
2009 retval
= do_for_each_entry_in_dir(
2010 loose_dir
, 0, fn
, cb_data
);
2013 release_packed_ref_cache(packed_ref_cache
);
2018 * Call fn for each reference in the specified ref_cache for which the
2019 * refname begins with base. If trim is non-zero, then trim that many
2020 * characters off the beginning of each refname before passing the
2021 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
2022 * broken references in the iteration. If fn ever returns a non-zero
2023 * value, stop the iteration and return that value; otherwise, return
2026 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
2027 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
2029 struct ref_entry_cb data
;
2034 data
.cb_data
= cb_data
;
2036 if (ref_paranoia
< 0)
2037 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
2039 data
.flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
2041 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
2044 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2046 struct object_id oid
;
2050 if (resolve_gitlink_ref(submodule
, "HEAD", oid
.hash
) == 0)
2051 return fn("HEAD", &oid
, 0, cb_data
);
2056 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, oid
.hash
, &flag
))
2057 return fn("HEAD", &oid
, flag
, cb_data
);
2062 int head_ref(each_ref_fn fn
, void *cb_data
)
2064 return do_head_ref(NULL
, fn
, cb_data
);
2067 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2069 return do_head_ref(submodule
, fn
, cb_data
);
2072 int for_each_ref(each_ref_fn fn
, void *cb_data
)
2074 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
2077 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2079 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
2082 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
2084 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
2087 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
2088 each_ref_fn fn
, void *cb_data
)
2090 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
2093 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
2095 return for_each_ref_in("refs/tags/", fn
, cb_data
);
2098 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2100 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
2103 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
2105 return for_each_ref_in("refs/heads/", fn
, cb_data
);
2108 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2110 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2113 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2115 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2118 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2120 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2123 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2125 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
2128 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2130 struct strbuf buf
= STRBUF_INIT
;
2132 struct object_id oid
;
2135 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2136 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, oid
.hash
, &flag
))
2137 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
2138 strbuf_release(&buf
);
2143 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2145 struct strbuf buf
= STRBUF_INIT
;
2147 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2148 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2149 strbuf_release(&buf
);
2153 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2154 const char *prefix
, void *cb_data
)
2156 struct strbuf real_pattern
= STRBUF_INIT
;
2157 struct ref_filter filter
;
2160 if (!prefix
&& !starts_with(pattern
, "refs/"))
2161 strbuf_addstr(&real_pattern
, "refs/");
2163 strbuf_addstr(&real_pattern
, prefix
);
2164 strbuf_addstr(&real_pattern
, pattern
);
2166 if (!has_glob_specials(pattern
)) {
2167 /* Append implied '/' '*' if not present. */
2168 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2169 strbuf_addch(&real_pattern
, '/');
2170 /* No need to check for '*', there is none. */
2171 strbuf_addch(&real_pattern
, '*');
2174 filter
.pattern
= real_pattern
.buf
;
2176 filter
.cb_data
= cb_data
;
2177 ret
= for_each_ref(filter_refs
, &filter
);
2179 strbuf_release(&real_pattern
);
2183 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2185 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2188 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2190 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2191 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2194 const char *prettify_refname(const char *name
)
2197 starts_with(name
, "refs/heads/") ? 11 :
2198 starts_with(name
, "refs/tags/") ? 10 :
2199 starts_with(name
, "refs/remotes/") ? 13 :
2203 static const char *ref_rev_parse_rules
[] = {
2208 "refs/remotes/%.*s",
2209 "refs/remotes/%.*s/HEAD",
2213 int refname_match(const char *abbrev_name
, const char *full_name
)
2216 const int abbrev_name_len
= strlen(abbrev_name
);
2218 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2219 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2227 static void unlock_ref(struct ref_lock
*lock
)
2229 /* Do not free lock->lk -- atexit() still looks at them */
2231 rollback_lock_file(lock
->lk
);
2232 free(lock
->ref_name
);
2233 free(lock
->orig_ref_name
);
2238 * Verify that the reference locked by lock has the value old_sha1.
2239 * Fail if the reference doesn't exist and mustexist is set. Return 0
2240 * on success. On error, write an error message to err, set errno, and
2241 * return a negative value.
2243 static int verify_lock(struct ref_lock
*lock
,
2244 const unsigned char *old_sha1
, int mustexist
,
2249 if (read_ref_full(lock
->ref_name
,
2250 mustexist
? RESOLVE_REF_READING
: 0,
2251 lock
->old_oid
.hash
, NULL
)) {
2252 int save_errno
= errno
;
2253 strbuf_addf(err
, "can't verify ref %s", lock
->ref_name
);
2257 if (hashcmp(lock
->old_oid
.hash
, old_sha1
)) {
2258 strbuf_addf(err
, "ref %s is at %s but expected %s",
2260 sha1_to_hex(lock
->old_oid
.hash
),
2261 sha1_to_hex(old_sha1
));
2268 static int remove_empty_directories(const char *file
)
2270 /* we want to create a file but there is a directory there;
2271 * if that is an empty directory (or a directory that contains
2272 * only empty directories), remove them.
2275 int result
, save_errno
;
2277 strbuf_init(&path
, 20);
2278 strbuf_addstr(&path
, file
);
2280 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2283 strbuf_release(&path
);
2290 * *string and *len will only be substituted, and *string returned (for
2291 * later free()ing) if the string passed in is a magic short-hand form
2294 static char *substitute_branch_name(const char **string
, int *len
)
2296 struct strbuf buf
= STRBUF_INIT
;
2297 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2301 *string
= strbuf_detach(&buf
, &size
);
2303 return (char *)*string
;
2309 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2311 char *last_branch
= substitute_branch_name(&str
, &len
);
2316 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2317 char fullref
[PATH_MAX
];
2318 unsigned char sha1_from_ref
[20];
2319 unsigned char *this_result
;
2322 this_result
= refs_found
? sha1_from_ref
: sha1
;
2323 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2324 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2325 this_result
, &flag
);
2329 if (!warn_ambiguous_refs
)
2331 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2332 warning("ignoring dangling symref %s.", fullref
);
2333 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2334 warning("ignoring broken ref %s.", fullref
);
2341 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2343 char *last_branch
= substitute_branch_name(&str
, &len
);
2348 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2349 unsigned char hash
[20];
2350 char path
[PATH_MAX
];
2351 const char *ref
, *it
;
2353 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2354 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2358 if (reflog_exists(path
))
2360 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2364 if (!logs_found
++) {
2366 hashcpy(sha1
, hash
);
2368 if (!warn_ambiguous_refs
)
2376 * Locks a ref returning the lock on success and NULL on failure.
2377 * On failure errno is set to something meaningful.
2379 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2380 const unsigned char *old_sha1
,
2381 const struct string_list
*extras
,
2382 const struct string_list
*skip
,
2383 unsigned int flags
, int *type_p
,
2386 const char *ref_file
;
2387 const char *orig_refname
= refname
;
2388 struct ref_lock
*lock
;
2391 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2392 int resolve_flags
= 0;
2393 int attempts_remaining
= 3;
2397 lock
= xcalloc(1, sizeof(struct ref_lock
));
2400 resolve_flags
|= RESOLVE_REF_READING
;
2401 if (flags
& REF_DELETING
) {
2402 resolve_flags
|= RESOLVE_REF_ALLOW_BAD_NAME
;
2403 if (flags
& REF_NODEREF
)
2404 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2407 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2408 lock
->old_oid
.hash
, &type
);
2409 if (!refname
&& errno
== EISDIR
) {
2410 /* we are trying to lock foo but we used to
2411 * have foo/bar which now does not exist;
2412 * it is normal for the empty directory 'foo'
2415 ref_file
= git_path("%s", orig_refname
);
2416 if (remove_empty_directories(ref_file
)) {
2419 if (!verify_refname_available(orig_refname
, extras
, skip
,
2420 get_loose_refs(&ref_cache
), err
))
2421 strbuf_addf(err
, "there are still refs under '%s'",
2426 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2427 lock
->old_oid
.hash
, &type
);
2433 if (last_errno
!= ENOTDIR
||
2434 !verify_refname_available(orig_refname
, extras
, skip
,
2435 get_loose_refs(&ref_cache
), err
))
2436 strbuf_addf(err
, "unable to resolve reference %s: %s",
2437 orig_refname
, strerror(last_errno
));
2442 * If the ref did not exist and we are creating it, make sure
2443 * there is no existing packed ref whose name begins with our
2444 * refname, nor a packed ref whose name is a proper prefix of
2447 if (is_null_oid(&lock
->old_oid
) &&
2448 verify_refname_available(refname
, extras
, skip
,
2449 get_packed_refs(&ref_cache
), err
)) {
2450 last_errno
= ENOTDIR
;
2454 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2457 if (flags
& REF_NODEREF
) {
2458 refname
= orig_refname
;
2459 lflags
|= LOCK_NO_DEREF
;
2461 lock
->ref_name
= xstrdup(refname
);
2462 lock
->orig_ref_name
= xstrdup(orig_refname
);
2463 ref_file
= git_path("%s", refname
);
2466 switch (safe_create_leading_directories_const(ref_file
)) {
2468 break; /* success */
2470 if (--attempts_remaining
> 0)
2475 strbuf_addf(err
, "unable to create directory for %s", ref_file
);
2479 if (hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
) < 0) {
2481 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2483 * Maybe somebody just deleted one of the
2484 * directories leading to ref_file. Try
2489 unable_to_lock_message(ref_file
, errno
, err
);
2493 if (old_sha1
&& verify_lock(lock
, old_sha1
, mustexist
, err
)) {
2506 * Write an entry to the packed-refs file for the specified refname.
2507 * If peeled is non-NULL, write it as the entry's peeled value.
2509 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2510 unsigned char *peeled
)
2512 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2514 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2518 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2520 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2522 enum peel_status peel_status
= peel_entry(entry
, 0);
2524 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2525 error("internal error: %s is not a valid packed reference!",
2527 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.oid
.hash
,
2528 peel_status
== PEEL_PEELED
?
2529 entry
->u
.value
.peeled
.hash
: NULL
);
2533 /* This should return a meaningful errno on failure */
2534 int lock_packed_refs(int flags
)
2536 static int timeout_configured
= 0;
2537 static int timeout_value
= 1000;
2539 struct packed_ref_cache
*packed_ref_cache
;
2541 if (!timeout_configured
) {
2542 git_config_get_int("core.packedrefstimeout", &timeout_value
);
2543 timeout_configured
= 1;
2546 if (hold_lock_file_for_update_timeout(
2547 &packlock
, git_path("packed-refs"),
2548 flags
, timeout_value
) < 0)
2551 * Get the current packed-refs while holding the lock. If the
2552 * packed-refs file has been modified since we last read it,
2553 * this will automatically invalidate the cache and re-read
2554 * the packed-refs file.
2556 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2557 packed_ref_cache
->lock
= &packlock
;
2558 /* Increment the reference count to prevent it from being freed: */
2559 acquire_packed_ref_cache(packed_ref_cache
);
2564 * Commit the packed refs changes.
2565 * On error we must make sure that errno contains a meaningful value.
2567 int commit_packed_refs(void)
2569 struct packed_ref_cache
*packed_ref_cache
=
2570 get_packed_ref_cache(&ref_cache
);
2575 if (!packed_ref_cache
->lock
)
2576 die("internal error: packed-refs not locked");
2578 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2580 die_errno("unable to fdopen packed-refs descriptor");
2582 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2583 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2584 0, write_packed_entry_fn
, out
);
2586 if (commit_lock_file(packed_ref_cache
->lock
)) {
2590 packed_ref_cache
->lock
= NULL
;
2591 release_packed_ref_cache(packed_ref_cache
);
2596 void rollback_packed_refs(void)
2598 struct packed_ref_cache
*packed_ref_cache
=
2599 get_packed_ref_cache(&ref_cache
);
2601 if (!packed_ref_cache
->lock
)
2602 die("internal error: packed-refs not locked");
2603 rollback_lock_file(packed_ref_cache
->lock
);
2604 packed_ref_cache
->lock
= NULL
;
2605 release_packed_ref_cache(packed_ref_cache
);
2606 clear_packed_ref_cache(&ref_cache
);
2609 struct ref_to_prune
{
2610 struct ref_to_prune
*next
;
2611 unsigned char sha1
[20];
2612 char name
[FLEX_ARRAY
];
2615 struct pack_refs_cb_data
{
2617 struct ref_dir
*packed_refs
;
2618 struct ref_to_prune
*ref_to_prune
;
2622 * An each_ref_entry_fn that is run over loose references only. If
2623 * the loose reference can be packed, add an entry in the packed ref
2624 * cache. If the reference should be pruned, also add it to
2625 * ref_to_prune in the pack_refs_cb_data.
2627 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2629 struct pack_refs_cb_data
*cb
= cb_data
;
2630 enum peel_status peel_status
;
2631 struct ref_entry
*packed_entry
;
2632 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2634 /* ALWAYS pack tags */
2635 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2638 /* Do not pack symbolic or broken refs: */
2639 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2642 /* Add a packed ref cache entry equivalent to the loose entry. */
2643 peel_status
= peel_entry(entry
, 1);
2644 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2645 die("internal error peeling reference %s (%s)",
2646 entry
->name
, oid_to_hex(&entry
->u
.value
.oid
));
2647 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2649 /* Overwrite existing packed entry with info from loose entry */
2650 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2651 oidcpy(&packed_entry
->u
.value
.oid
, &entry
->u
.value
.oid
);
2653 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.oid
.hash
,
2654 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2655 add_ref(cb
->packed_refs
, packed_entry
);
2657 oidcpy(&packed_entry
->u
.value
.peeled
, &entry
->u
.value
.peeled
);
2659 /* Schedule the loose reference for pruning if requested. */
2660 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2661 int namelen
= strlen(entry
->name
) + 1;
2662 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2663 hashcpy(n
->sha1
, entry
->u
.value
.oid
.hash
);
2664 strcpy(n
->name
, entry
->name
);
2665 n
->next
= cb
->ref_to_prune
;
2666 cb
->ref_to_prune
= n
;
2672 * Remove empty parents, but spare refs/ and immediate subdirs.
2673 * Note: munges *name.
2675 static void try_remove_empty_parents(char *name
)
2680 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2681 while (*p
&& *p
!= '/')
2683 /* tolerate duplicate slashes; see check_refname_format() */
2687 for (q
= p
; *q
; q
++)
2690 while (q
> p
&& *q
!= '/')
2692 while (q
> p
&& *(q
-1) == '/')
2697 if (rmdir(git_path("%s", name
)))
2702 /* make sure nobody touched the ref, and unlink */
2703 static void prune_ref(struct ref_to_prune
*r
)
2705 struct ref_transaction
*transaction
;
2706 struct strbuf err
= STRBUF_INIT
;
2708 if (check_refname_format(r
->name
, 0))
2711 transaction
= ref_transaction_begin(&err
);
2713 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2714 REF_ISPRUNING
, NULL
, &err
) ||
2715 ref_transaction_commit(transaction
, &err
)) {
2716 ref_transaction_free(transaction
);
2717 error("%s", err
.buf
);
2718 strbuf_release(&err
);
2721 ref_transaction_free(transaction
);
2722 strbuf_release(&err
);
2723 try_remove_empty_parents(r
->name
);
2726 static void prune_refs(struct ref_to_prune
*r
)
2734 int pack_refs(unsigned int flags
)
2736 struct pack_refs_cb_data cbdata
;
2738 memset(&cbdata
, 0, sizeof(cbdata
));
2739 cbdata
.flags
= flags
;
2741 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2742 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2744 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2745 pack_if_possible_fn
, &cbdata
);
2747 if (commit_packed_refs())
2748 die_errno("unable to overwrite old ref-pack file");
2750 prune_refs(cbdata
.ref_to_prune
);
2754 int repack_without_refs(struct string_list
*refnames
, struct strbuf
*err
)
2756 struct ref_dir
*packed
;
2757 struct string_list_item
*refname
;
2758 int ret
, needs_repacking
= 0, removed
= 0;
2762 /* Look for a packed ref */
2763 for_each_string_list_item(refname
, refnames
) {
2764 if (get_packed_ref(refname
->string
)) {
2765 needs_repacking
= 1;
2770 /* Avoid locking if we have nothing to do */
2771 if (!needs_repacking
)
2772 return 0; /* no refname exists in packed refs */
2774 if (lock_packed_refs(0)) {
2775 unable_to_lock_message(git_path("packed-refs"), errno
, err
);
2778 packed
= get_packed_refs(&ref_cache
);
2780 /* Remove refnames from the cache */
2781 for_each_string_list_item(refname
, refnames
)
2782 if (remove_entry(packed
, refname
->string
) != -1)
2786 * All packed entries disappeared while we were
2787 * acquiring the lock.
2789 rollback_packed_refs();
2793 /* Write what remains */
2794 ret
= commit_packed_refs();
2796 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2801 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2805 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2807 * loose. The loose file name is the same as the
2808 * lockfile name, minus ".lock":
2810 char *loose_filename
= get_locked_file_path(lock
->lk
);
2811 int res
= unlink_or_msg(loose_filename
, err
);
2812 free(loose_filename
);
2819 int delete_ref(const char *refname
, const unsigned char *sha1
, unsigned int flags
)
2821 struct ref_transaction
*transaction
;
2822 struct strbuf err
= STRBUF_INIT
;
2824 transaction
= ref_transaction_begin(&err
);
2826 ref_transaction_delete(transaction
, refname
,
2827 (sha1
&& !is_null_sha1(sha1
)) ? sha1
: NULL
,
2828 flags
, NULL
, &err
) ||
2829 ref_transaction_commit(transaction
, &err
)) {
2830 error("%s", err
.buf
);
2831 ref_transaction_free(transaction
);
2832 strbuf_release(&err
);
2835 ref_transaction_free(transaction
);
2836 strbuf_release(&err
);
2841 * People using contrib's git-new-workdir have .git/logs/refs ->
2842 * /some/other/path/.git/logs/refs, and that may live on another device.
2844 * IOW, to avoid cross device rename errors, the temporary renamed log must
2845 * live into logs/refs.
2847 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2849 static int rename_tmp_log(const char *newrefname
)
2851 int attempts_remaining
= 4;
2854 switch (safe_create_leading_directories_const(git_path("logs/%s", newrefname
))) {
2856 break; /* success */
2858 if (--attempts_remaining
> 0)
2862 error("unable to create directory for %s", newrefname
);
2866 if (rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2867 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2869 * rename(a, b) when b is an existing
2870 * directory ought to result in ISDIR, but
2871 * Solaris 5.8 gives ENOTDIR. Sheesh.
2873 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2874 error("Directory not empty: logs/%s", newrefname
);
2878 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2880 * Maybe another process just deleted one of
2881 * the directories in the path to newrefname.
2882 * Try again from the beginning.
2886 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2887 newrefname
, strerror(errno
));
2894 static int rename_ref_available(const char *oldname
, const char *newname
)
2896 struct string_list skip
= STRING_LIST_INIT_NODUP
;
2897 struct strbuf err
= STRBUF_INIT
;
2900 string_list_insert(&skip
, oldname
);
2901 ret
= !verify_refname_available(newname
, NULL
, &skip
,
2902 get_packed_refs(&ref_cache
), &err
)
2903 && !verify_refname_available(newname
, NULL
, &skip
,
2904 get_loose_refs(&ref_cache
), &err
);
2906 error("%s", err
.buf
);
2908 string_list_clear(&skip
, 0);
2909 strbuf_release(&err
);
2913 static int write_ref_to_lockfile(struct ref_lock
*lock
,
2914 const unsigned char *sha1
, struct strbuf
*err
);
2915 static int commit_ref_update(struct ref_lock
*lock
,
2916 const unsigned char *sha1
, const char *logmsg
,
2917 struct strbuf
*err
);
2919 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2921 unsigned char sha1
[20], orig_sha1
[20];
2922 int flag
= 0, logmoved
= 0;
2923 struct ref_lock
*lock
;
2924 struct stat loginfo
;
2925 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2926 const char *symref
= NULL
;
2927 struct strbuf err
= STRBUF_INIT
;
2929 if (log
&& S_ISLNK(loginfo
.st_mode
))
2930 return error("reflog for %s is a symlink", oldrefname
);
2932 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
2934 if (flag
& REF_ISSYMREF
)
2935 return error("refname %s is a symbolic ref, renaming it is not supported",
2938 return error("refname %s not found", oldrefname
);
2940 if (!rename_ref_available(oldrefname
, newrefname
))
2943 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2944 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2945 oldrefname
, strerror(errno
));
2947 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2948 error("unable to delete old %s", oldrefname
);
2952 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
2953 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2954 if (errno
==EISDIR
) {
2955 if (remove_empty_directories(git_path("%s", newrefname
))) {
2956 error("Directory not empty: %s", newrefname
);
2960 error("unable to delete existing %s", newrefname
);
2965 if (log
&& rename_tmp_log(newrefname
))
2970 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, NULL
, 0, NULL
, &err
);
2972 error("unable to rename '%s' to '%s': %s", oldrefname
, newrefname
, err
.buf
);
2973 strbuf_release(&err
);
2976 hashcpy(lock
->old_oid
.hash
, orig_sha1
);
2978 if (write_ref_to_lockfile(lock
, orig_sha1
, &err
) ||
2979 commit_ref_update(lock
, orig_sha1
, logmsg
, &err
)) {
2980 error("unable to write current sha1 into %s: %s", newrefname
, err
.buf
);
2981 strbuf_release(&err
);
2988 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, NULL
, 0, NULL
, &err
);
2990 error("unable to lock %s for rollback: %s", oldrefname
, err
.buf
);
2991 strbuf_release(&err
);
2995 flag
= log_all_ref_updates
;
2996 log_all_ref_updates
= 0;
2997 if (write_ref_to_lockfile(lock
, orig_sha1
, &err
) ||
2998 commit_ref_update(lock
, orig_sha1
, NULL
, &err
)) {
2999 error("unable to write current sha1 into %s: %s", oldrefname
, err
.buf
);
3000 strbuf_release(&err
);
3002 log_all_ref_updates
= flag
;
3005 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
3006 error("unable to restore logfile %s from %s: %s",
3007 oldrefname
, newrefname
, strerror(errno
));
3008 if (!logmoved
&& log
&&
3009 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
3010 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
3011 oldrefname
, strerror(errno
));
3016 static int close_ref(struct ref_lock
*lock
)
3018 if (close_lock_file(lock
->lk
))
3023 static int commit_ref(struct ref_lock
*lock
)
3025 if (commit_lock_file(lock
->lk
))
3031 * copy the reflog message msg to buf, which has been allocated sufficiently
3032 * large, while cleaning up the whitespaces. Especially, convert LF to space,
3033 * because reflog file is one line per entry.
3035 static int copy_msg(char *buf
, const char *msg
)
3042 while ((c
= *msg
++)) {
3043 if (wasspace
&& isspace(c
))
3045 wasspace
= isspace(c
);
3050 while (buf
< cp
&& isspace(cp
[-1]))
3056 static int should_autocreate_reflog(const char *refname
)
3058 if (!log_all_ref_updates
)
3060 return starts_with(refname
, "refs/heads/") ||
3061 starts_with(refname
, "refs/remotes/") ||
3062 starts_with(refname
, "refs/notes/") ||
3063 !strcmp(refname
, "HEAD");
3066 /* This function will fill in *err and return -1 on failure */
3067 int log_ref_setup(const char *refname
, struct strbuf
*sb_logfile
, struct strbuf
*err
)
3069 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
3072 strbuf_git_path(sb_logfile
, "logs/%s", refname
);
3073 logfile
= sb_logfile
->buf
;
3074 /* make sure the rest of the function can't change "logfile" */
3076 if (should_autocreate_reflog(refname
)) {
3077 if (safe_create_leading_directories(logfile
) < 0) {
3078 strbuf_addf(err
, "unable to create directory for %s: "
3079 "%s", logfile
, strerror(errno
));
3085 logfd
= open(logfile
, oflags
, 0666);
3087 if (!(oflags
& O_CREAT
) && (errno
== ENOENT
|| errno
== EISDIR
))
3090 if (errno
== EISDIR
) {
3091 if (remove_empty_directories(logfile
)) {
3092 strbuf_addf(err
, "There are still logs under "
3096 logfd
= open(logfile
, oflags
, 0666);
3100 strbuf_addf(err
, "unable to append to %s: %s",
3101 logfile
, strerror(errno
));
3106 adjust_shared_perm(logfile
);
3111 static int log_ref_write_fd(int fd
, const unsigned char *old_sha1
,
3112 const unsigned char *new_sha1
,
3113 const char *committer
, const char *msg
)
3115 int msglen
, written
;
3116 unsigned maxlen
, len
;
3119 msglen
= msg
? strlen(msg
) : 0;
3120 maxlen
= strlen(committer
) + msglen
+ 100;
3121 logrec
= xmalloc(maxlen
);
3122 len
= sprintf(logrec
, "%s %s %s\n",
3123 sha1_to_hex(old_sha1
),
3124 sha1_to_hex(new_sha1
),
3127 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
3129 written
= len
<= maxlen
? write_in_full(fd
, logrec
, len
) : -1;
3137 static int log_ref_write_1(const char *refname
, const unsigned char *old_sha1
,
3138 const unsigned char *new_sha1
, const char *msg
,
3139 struct strbuf
*sb_log_file
, struct strbuf
*err
)
3141 int logfd
, result
, oflags
= O_APPEND
| O_WRONLY
;
3144 if (log_all_ref_updates
< 0)
3145 log_all_ref_updates
= !is_bare_repository();
3147 result
= log_ref_setup(refname
, sb_log_file
, err
);
3151 log_file
= sb_log_file
->buf
;
3152 /* make sure the rest of the function can't change "log_file" */
3155 logfd
= open(log_file
, oflags
);
3158 result
= log_ref_write_fd(logfd
, old_sha1
, new_sha1
,
3159 git_committer_info(0), msg
);
3161 strbuf_addf(err
, "unable to append to %s: %s", log_file
,
3167 strbuf_addf(err
, "unable to append to %s: %s", log_file
,
3174 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
3175 const unsigned char *new_sha1
, const char *msg
,
3178 struct strbuf sb
= STRBUF_INIT
;
3179 int ret
= log_ref_write_1(refname
, old_sha1
, new_sha1
, msg
, &sb
, err
);
3180 strbuf_release(&sb
);
3184 int is_branch(const char *refname
)
3186 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3190 * Write sha1 into the open lockfile, then close the lockfile. On
3191 * errors, rollback the lockfile, fill in *err and
3194 static int write_ref_to_lockfile(struct ref_lock
*lock
,
3195 const unsigned char *sha1
, struct strbuf
*err
)
3197 static char term
= '\n';
3200 o
= parse_object(sha1
);
3203 "Trying to write ref %s with nonexistent object %s",
3204 lock
->ref_name
, sha1_to_hex(sha1
));
3208 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3210 "Trying to write non-commit object %s to branch %s",
3211 sha1_to_hex(sha1
), lock
->ref_name
);
3215 if (write_in_full(lock
->lk
->fd
, sha1_to_hex(sha1
), 40) != 40 ||
3216 write_in_full(lock
->lk
->fd
, &term
, 1) != 1 ||
3217 close_ref(lock
) < 0) {
3219 "Couldn't write %s", lock
->lk
->filename
.buf
);
3227 * Commit a change to a loose reference that has already been written
3228 * to the loose reference lockfile. Also update the reflogs if
3229 * necessary, using the specified lockmsg (which can be NULL).
3231 static int commit_ref_update(struct ref_lock
*lock
,
3232 const unsigned char *sha1
, const char *logmsg
,
3235 clear_loose_ref_cache(&ref_cache
);
3236 if (log_ref_write(lock
->ref_name
, lock
->old_oid
.hash
, sha1
, logmsg
, err
) < 0 ||
3237 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3238 log_ref_write(lock
->orig_ref_name
, lock
->old_oid
.hash
, sha1
, logmsg
, err
) < 0)) {
3239 char *old_msg
= strbuf_detach(err
, NULL
);
3240 strbuf_addf(err
, "Cannot update the ref '%s': %s",
3241 lock
->ref_name
, old_msg
);
3246 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3248 * Special hack: If a branch is updated directly and HEAD
3249 * points to it (may happen on the remote side of a push
3250 * for example) then logically the HEAD reflog should be
3252 * A generic solution implies reverse symref information,
3253 * but finding all symrefs pointing to the given branch
3254 * would be rather costly for this rare event (the direct
3255 * update of a branch) to be worth it. So let's cheat and
3256 * check with HEAD only which should cover 99% of all usage
3257 * scenarios (even 100% of the default ones).
3259 unsigned char head_sha1
[20];
3261 const char *head_ref
;
3262 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3263 head_sha1
, &head_flag
);
3264 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3265 !strcmp(head_ref
, lock
->ref_name
)) {
3266 struct strbuf log_err
= STRBUF_INIT
;
3267 if (log_ref_write("HEAD", lock
->old_oid
.hash
, sha1
,
3268 logmsg
, &log_err
)) {
3269 error("%s", log_err
.buf
);
3270 strbuf_release(&log_err
);
3274 if (commit_ref(lock
)) {
3275 error("Couldn't set %s", lock
->ref_name
);
3284 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3287 const char *lockpath
;
3289 int fd
, len
, written
;
3290 char *git_HEAD
= git_pathdup("%s", ref_target
);
3291 unsigned char old_sha1
[20], new_sha1
[20];
3292 struct strbuf err
= STRBUF_INIT
;
3294 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3297 if (safe_create_leading_directories(git_HEAD
) < 0)
3298 return error("unable to create directory for %s", git_HEAD
);
3300 #ifndef NO_SYMLINK_HEAD
3301 if (prefer_symlink_refs
) {
3303 if (!symlink(refs_heads_master
, git_HEAD
))
3305 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3309 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3310 if (sizeof(ref
) <= len
) {
3311 error("refname too long: %s", refs_heads_master
);
3312 goto error_free_return
;
3314 lockpath
= mkpath("%s.lock", git_HEAD
);
3315 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3317 error("Unable to open %s for writing", lockpath
);
3318 goto error_free_return
;
3320 written
= write_in_full(fd
, ref
, len
);
3321 if (close(fd
) != 0 || written
!= len
) {
3322 error("Unable to write to %s", lockpath
);
3323 goto error_unlink_return
;
3325 if (rename(lockpath
, git_HEAD
) < 0) {
3326 error("Unable to create %s", git_HEAD
);
3327 goto error_unlink_return
;
3329 if (adjust_shared_perm(git_HEAD
)) {
3330 error("Unable to fix permissions on %s", lockpath
);
3331 error_unlink_return
:
3332 unlink_or_warn(lockpath
);
3338 #ifndef NO_SYMLINK_HEAD
3341 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
) &&
3342 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
, &err
)) {
3343 error("%s", err
.buf
);
3344 strbuf_release(&err
);
3351 struct read_ref_at_cb
{
3352 const char *refname
;
3353 unsigned long at_time
;
3356 unsigned char *sha1
;
3359 unsigned char osha1
[20];
3360 unsigned char nsha1
[20];
3364 unsigned long *cutoff_time
;
3369 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3370 const char *email
, unsigned long timestamp
, int tz
,
3371 const char *message
, void *cb_data
)
3373 struct read_ref_at_cb
*cb
= cb_data
;
3377 cb
->date
= timestamp
;
3379 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3381 *cb
->msg
= xstrdup(message
);
3382 if (cb
->cutoff_time
)
3383 *cb
->cutoff_time
= timestamp
;
3385 *cb
->cutoff_tz
= tz
;
3387 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3389 * we have not yet updated cb->[n|o]sha1 so they still
3390 * hold the values for the previous record.
3392 if (!is_null_sha1(cb
->osha1
)) {
3393 hashcpy(cb
->sha1
, nsha1
);
3394 if (hashcmp(cb
->osha1
, nsha1
))
3395 warning("Log for ref %s has gap after %s.",
3396 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_RFC2822
));
3398 else if (cb
->date
== cb
->at_time
)
3399 hashcpy(cb
->sha1
, nsha1
);
3400 else if (hashcmp(nsha1
, cb
->sha1
))
3401 warning("Log for ref %s unexpectedly ended on %s.",
3402 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3404 hashcpy(cb
->osha1
, osha1
);
3405 hashcpy(cb
->nsha1
, nsha1
);
3409 hashcpy(cb
->osha1
, osha1
);
3410 hashcpy(cb
->nsha1
, nsha1
);
3416 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3417 const char *email
, unsigned long timestamp
,
3418 int tz
, const char *message
, void *cb_data
)
3420 struct read_ref_at_cb
*cb
= cb_data
;
3423 *cb
->msg
= xstrdup(message
);
3424 if (cb
->cutoff_time
)
3425 *cb
->cutoff_time
= timestamp
;
3427 *cb
->cutoff_tz
= tz
;
3429 *cb
->cutoff_cnt
= cb
->reccnt
;
3430 hashcpy(cb
->sha1
, osha1
);
3431 if (is_null_sha1(cb
->sha1
))
3432 hashcpy(cb
->sha1
, nsha1
);
3433 /* We just want the first entry */
3437 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3438 unsigned char *sha1
, char **msg
,
3439 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3441 struct read_ref_at_cb cb
;
3443 memset(&cb
, 0, sizeof(cb
));
3444 cb
.refname
= refname
;
3445 cb
.at_time
= at_time
;
3448 cb
.cutoff_time
= cutoff_time
;
3449 cb
.cutoff_tz
= cutoff_tz
;
3450 cb
.cutoff_cnt
= cutoff_cnt
;
3453 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3456 if (flags
& GET_SHA1_QUIETLY
)
3459 die("Log for %s is empty.", refname
);
3464 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3469 int reflog_exists(const char *refname
)
3473 return !lstat(git_path("logs/%s", refname
), &st
) &&
3474 S_ISREG(st
.st_mode
);
3477 int delete_reflog(const char *refname
)
3479 return remove_path(git_path("logs/%s", refname
));
3482 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3484 unsigned char osha1
[20], nsha1
[20];
3485 char *email_end
, *message
;
3486 unsigned long timestamp
;
3489 /* old SP new SP name <email> SP time TAB msg LF */
3490 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3491 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3492 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3493 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3494 email_end
[1] != ' ' ||
3495 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3496 !message
|| message
[0] != ' ' ||
3497 (message
[1] != '+' && message
[1] != '-') ||
3498 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3499 !isdigit(message
[4]) || !isdigit(message
[5]))
3500 return 0; /* corrupt? */
3501 email_end
[1] = '\0';
3502 tz
= strtol(message
+ 1, NULL
, 10);
3503 if (message
[6] != '\t')
3507 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3510 static char *find_beginning_of_line(char *bob
, char *scan
)
3512 while (bob
< scan
&& *(--scan
) != '\n')
3513 ; /* keep scanning backwards */
3515 * Return either beginning of the buffer, or LF at the end of
3516 * the previous line.
3521 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3523 struct strbuf sb
= STRBUF_INIT
;
3526 int ret
= 0, at_tail
= 1;
3528 logfp
= fopen(git_path("logs/%s", refname
), "r");
3532 /* Jump to the end */
3533 if (fseek(logfp
, 0, SEEK_END
) < 0)
3534 return error("cannot seek back reflog for %s: %s",
3535 refname
, strerror(errno
));
3537 while (!ret
&& 0 < pos
) {
3543 /* Fill next block from the end */
3544 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3545 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3546 return error("cannot seek back reflog for %s: %s",
3547 refname
, strerror(errno
));
3548 nread
= fread(buf
, cnt
, 1, logfp
);
3550 return error("cannot read %d bytes from reflog for %s: %s",
3551 cnt
, refname
, strerror(errno
));
3554 scanp
= endp
= buf
+ cnt
;
3555 if (at_tail
&& scanp
[-1] == '\n')
3556 /* Looking at the final LF at the end of the file */
3560 while (buf
< scanp
) {
3562 * terminating LF of the previous line, or the beginning
3567 bp
= find_beginning_of_line(buf
, scanp
);
3571 * The newline is the end of the previous line,
3572 * so we know we have complete line starting
3573 * at (bp + 1). Prefix it onto any prior data
3574 * we collected for the line and process it.
3576 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3579 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3585 * We are at the start of the buffer, and the
3586 * start of the file; there is no previous
3587 * line, and we have everything for this one.
3588 * Process it, and we can end the loop.
3590 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3591 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3598 * We are at the start of the buffer, and there
3599 * is more file to read backwards. Which means
3600 * we are in the middle of a line. Note that we
3601 * may get here even if *bp was a newline; that
3602 * just means we are at the exact end of the
3603 * previous line, rather than some spot in the
3606 * Save away what we have to be combined with
3607 * the data from the next read.
3609 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3616 die("BUG: reverse reflog parser had leftover data");
3619 strbuf_release(&sb
);
3623 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3626 struct strbuf sb
= STRBUF_INIT
;
3629 logfp
= fopen(git_path("logs/%s", refname
), "r");
3633 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3634 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3636 strbuf_release(&sb
);
3640 * Call fn for each reflog in the namespace indicated by name. name
3641 * must be empty or end with '/'. Name will be used as a scratch
3642 * space, but its contents will be restored before return.
3644 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3646 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3649 int oldlen
= name
->len
;
3652 return name
->len
? errno
: 0;
3654 while ((de
= readdir(d
)) != NULL
) {
3657 if (de
->d_name
[0] == '.')
3659 if (ends_with(de
->d_name
, ".lock"))
3661 strbuf_addstr(name
, de
->d_name
);
3662 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3663 ; /* silently ignore */
3665 if (S_ISDIR(st
.st_mode
)) {
3666 strbuf_addch(name
, '/');
3667 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3669 struct object_id oid
;
3671 if (read_ref_full(name
->buf
, 0, oid
.hash
, NULL
))
3672 retval
= error("bad ref for %s", name
->buf
);
3674 retval
= fn(name
->buf
, &oid
, 0, cb_data
);
3679 strbuf_setlen(name
, oldlen
);
3685 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3689 strbuf_init(&name
, PATH_MAX
);
3690 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3691 strbuf_release(&name
);
3696 * Information needed for a single ref update. Set new_sha1 to the new
3697 * value or to null_sha1 to delete the ref. To check the old value
3698 * while the ref is locked, set (flags & REF_HAVE_OLD) and set
3699 * old_sha1 to the old value, or to null_sha1 to ensure the ref does
3700 * not exist before update.
3704 * If (flags & REF_HAVE_NEW), set the reference to this value:
3706 unsigned char new_sha1
[20];
3708 * If (flags & REF_HAVE_OLD), check that the reference
3709 * previously had this value:
3711 unsigned char old_sha1
[20];
3713 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,
3714 * REF_DELETING, and REF_ISPRUNING:
3717 struct ref_lock
*lock
;
3720 const char refname
[FLEX_ARRAY
];
3724 * Transaction states.
3725 * OPEN: The transaction is in a valid state and can accept new updates.
3726 * An OPEN transaction can be committed.
3727 * CLOSED: A closed transaction is no longer active and no other operations
3728 * than free can be used on it in this state.
3729 * A transaction can either become closed by successfully committing
3730 * an active transaction or if there is a failure while building
3731 * the transaction thus rendering it failed/inactive.
3733 enum ref_transaction_state
{
3734 REF_TRANSACTION_OPEN
= 0,
3735 REF_TRANSACTION_CLOSED
= 1
3739 * Data structure for holding a reference transaction, which can
3740 * consist of checks and updates to multiple references, carried out
3741 * as atomically as possible. This structure is opaque to callers.
3743 struct ref_transaction
{
3744 struct ref_update
**updates
;
3747 enum ref_transaction_state state
;
3750 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
3754 return xcalloc(1, sizeof(struct ref_transaction
));
3757 void ref_transaction_free(struct ref_transaction
*transaction
)
3764 for (i
= 0; i
< transaction
->nr
; i
++) {
3765 free(transaction
->updates
[i
]->msg
);
3766 free(transaction
->updates
[i
]);
3768 free(transaction
->updates
);
3772 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3773 const char *refname
)
3775 size_t len
= strlen(refname
);
3776 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3778 strcpy((char *)update
->refname
, refname
);
3779 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3780 transaction
->updates
[transaction
->nr
++] = update
;
3784 int ref_transaction_update(struct ref_transaction
*transaction
,
3785 const char *refname
,
3786 const unsigned char *new_sha1
,
3787 const unsigned char *old_sha1
,
3788 unsigned int flags
, const char *msg
,
3791 struct ref_update
*update
;
3795 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3796 die("BUG: update called for transaction that is not open");
3798 if (new_sha1
&& !is_null_sha1(new_sha1
) &&
3799 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
3800 strbuf_addf(err
, "refusing to update ref with bad name %s",
3805 update
= add_update(transaction
, refname
);
3807 hashcpy(update
->new_sha1
, new_sha1
);
3808 flags
|= REF_HAVE_NEW
;
3811 hashcpy(update
->old_sha1
, old_sha1
);
3812 flags
|= REF_HAVE_OLD
;
3814 update
->flags
= flags
;
3816 update
->msg
= xstrdup(msg
);
3820 int ref_transaction_create(struct ref_transaction
*transaction
,
3821 const char *refname
,
3822 const unsigned char *new_sha1
,
3823 unsigned int flags
, const char *msg
,
3826 if (!new_sha1
|| is_null_sha1(new_sha1
))
3827 die("BUG: create called without valid new_sha1");
3828 return ref_transaction_update(transaction
, refname
, new_sha1
,
3829 null_sha1
, flags
, msg
, err
);
3832 int ref_transaction_delete(struct ref_transaction
*transaction
,
3833 const char *refname
,
3834 const unsigned char *old_sha1
,
3835 unsigned int flags
, const char *msg
,
3838 if (old_sha1
&& is_null_sha1(old_sha1
))
3839 die("BUG: delete called with old_sha1 set to zeros");
3840 return ref_transaction_update(transaction
, refname
,
3841 null_sha1
, old_sha1
,
3845 int ref_transaction_verify(struct ref_transaction
*transaction
,
3846 const char *refname
,
3847 const unsigned char *old_sha1
,
3852 die("BUG: verify called with old_sha1 set to NULL");
3853 return ref_transaction_update(transaction
, refname
,
3858 int update_ref(const char *msg
, const char *refname
,
3859 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
3860 unsigned int flags
, enum action_on_err onerr
)
3862 struct ref_transaction
*t
;
3863 struct strbuf err
= STRBUF_INIT
;
3865 t
= ref_transaction_begin(&err
);
3867 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
3868 flags
, msg
, &err
) ||
3869 ref_transaction_commit(t
, &err
)) {
3870 const char *str
= "update_ref failed for ref '%s': %s";
3872 ref_transaction_free(t
);
3874 case UPDATE_REFS_MSG_ON_ERR
:
3875 error(str
, refname
, err
.buf
);
3877 case UPDATE_REFS_DIE_ON_ERR
:
3878 die(str
, refname
, err
.buf
);
3880 case UPDATE_REFS_QUIET_ON_ERR
:
3883 strbuf_release(&err
);
3886 strbuf_release(&err
);
3887 ref_transaction_free(t
);
3891 static int ref_update_reject_duplicates(struct string_list
*refnames
,
3894 int i
, n
= refnames
->nr
;
3898 for (i
= 1; i
< n
; i
++)
3899 if (!strcmp(refnames
->items
[i
- 1].string
, refnames
->items
[i
].string
)) {
3901 "Multiple updates for ref '%s' not allowed.",
3902 refnames
->items
[i
].string
);
3908 int ref_transaction_commit(struct ref_transaction
*transaction
,
3912 int n
= transaction
->nr
;
3913 struct ref_update
**updates
= transaction
->updates
;
3914 struct string_list refs_to_delete
= STRING_LIST_INIT_NODUP
;
3915 struct string_list_item
*ref_to_delete
;
3916 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
3920 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3921 die("BUG: commit called for transaction that is not open");
3924 transaction
->state
= REF_TRANSACTION_CLOSED
;
3928 /* Fail if a refname appears more than once in the transaction: */
3929 for (i
= 0; i
< n
; i
++)
3930 string_list_append(&affected_refnames
, updates
[i
]->refname
);
3931 string_list_sort(&affected_refnames
);
3932 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
3933 ret
= TRANSACTION_GENERIC_ERROR
;
3938 * Acquire all locks, verify old values if provided, check
3939 * that new values are valid, and write new values to the
3940 * lockfiles, ready to be activated. Only keep one lockfile
3941 * open at a time to avoid running out of file descriptors.
3943 for (i
= 0; i
< n
; i
++) {
3944 struct ref_update
*update
= updates
[i
];
3946 if ((update
->flags
& REF_HAVE_NEW
) &&
3947 is_null_sha1(update
->new_sha1
))
3948 update
->flags
|= REF_DELETING
;
3949 update
->lock
= lock_ref_sha1_basic(
3951 ((update
->flags
& REF_HAVE_OLD
) ?
3952 update
->old_sha1
: NULL
),
3953 &affected_refnames
, NULL
,
3957 if (!update
->lock
) {
3960 ret
= (errno
== ENOTDIR
)
3961 ? TRANSACTION_NAME_CONFLICT
3962 : TRANSACTION_GENERIC_ERROR
;
3963 reason
= strbuf_detach(err
, NULL
);
3964 strbuf_addf(err
, "cannot lock ref '%s': %s",
3965 update
->refname
, reason
);
3969 if ((update
->flags
& REF_HAVE_NEW
) &&
3970 !(update
->flags
& REF_DELETING
)) {
3971 int overwriting_symref
= ((update
->type
& REF_ISSYMREF
) &&
3972 (update
->flags
& REF_NODEREF
));
3974 if (!overwriting_symref
&&
3975 !hashcmp(update
->lock
->old_oid
.hash
, update
->new_sha1
)) {
3977 * The reference already has the desired
3978 * value, so we don't need to write it.
3980 } else if (write_ref_to_lockfile(update
->lock
,
3983 char *write_err
= strbuf_detach(err
, NULL
);
3986 * The lock was freed upon failure of
3987 * write_ref_to_lockfile():
3989 update
->lock
= NULL
;
3991 "cannot update the ref '%s': %s",
3992 update
->refname
, write_err
);
3994 ret
= TRANSACTION_GENERIC_ERROR
;
3997 update
->flags
|= REF_NEEDS_COMMIT
;
4000 if (!(update
->flags
& REF_NEEDS_COMMIT
)) {
4002 * We didn't have to write anything to the lockfile.
4003 * Close it to free up the file descriptor:
4005 if (close_ref(update
->lock
)) {
4006 strbuf_addf(err
, "Couldn't close %s.lock",
4013 /* Perform updates first so live commits remain referenced */
4014 for (i
= 0; i
< n
; i
++) {
4015 struct ref_update
*update
= updates
[i
];
4017 if (update
->flags
& REF_NEEDS_COMMIT
) {
4018 if (commit_ref_update(update
->lock
,
4019 update
->new_sha1
, update
->msg
, err
)) {
4020 /* freed by commit_ref_update(): */
4021 update
->lock
= NULL
;
4022 ret
= TRANSACTION_GENERIC_ERROR
;
4025 /* freed by commit_ref_update(): */
4026 update
->lock
= NULL
;
4031 /* Perform deletes now that updates are safely completed */
4032 for (i
= 0; i
< n
; i
++) {
4033 struct ref_update
*update
= updates
[i
];
4035 if (update
->flags
& REF_DELETING
) {
4036 if (delete_ref_loose(update
->lock
, update
->type
, err
)) {
4037 ret
= TRANSACTION_GENERIC_ERROR
;
4041 if (!(update
->flags
& REF_ISPRUNING
))
4042 string_list_append(&refs_to_delete
,
4043 update
->lock
->ref_name
);
4047 if (repack_without_refs(&refs_to_delete
, err
)) {
4048 ret
= TRANSACTION_GENERIC_ERROR
;
4051 for_each_string_list_item(ref_to_delete
, &refs_to_delete
)
4052 unlink_or_warn(git_path("logs/%s", ref_to_delete
->string
));
4053 clear_loose_ref_cache(&ref_cache
);
4056 transaction
->state
= REF_TRANSACTION_CLOSED
;
4058 for (i
= 0; i
< n
; i
++)
4059 if (updates
[i
]->lock
)
4060 unlock_ref(updates
[i
]->lock
);
4061 string_list_clear(&refs_to_delete
, 0);
4062 string_list_clear(&affected_refnames
, 0);
4066 char *shorten_unambiguous_ref(const char *refname
, int strict
)
4069 static char **scanf_fmts
;
4070 static int nr_rules
;
4075 * Pre-generate scanf formats from ref_rev_parse_rules[].
4076 * Generate a format suitable for scanf from a
4077 * ref_rev_parse_rules rule by interpolating "%s" at the
4078 * location of the "%.*s".
4080 size_t total_len
= 0;
4083 /* the rule list is NULL terminated, count them first */
4084 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
4085 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
4086 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
4088 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
4091 for (i
= 0; i
< nr_rules
; i
++) {
4092 assert(offset
< total_len
);
4093 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
4094 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
4095 ref_rev_parse_rules
[i
], 2, "%s") + 1;
4099 /* bail out if there are no rules */
4101 return xstrdup(refname
);
4103 /* buffer for scanf result, at most refname must fit */
4104 short_name
= xstrdup(refname
);
4106 /* skip first rule, it will always match */
4107 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
4109 int rules_to_fail
= i
;
4112 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
4115 short_name_len
= strlen(short_name
);
4118 * in strict mode, all (except the matched one) rules
4119 * must fail to resolve to a valid non-ambiguous ref
4122 rules_to_fail
= nr_rules
;
4125 * check if the short name resolves to a valid ref,
4126 * but use only rules prior to the matched one
4128 for (j
= 0; j
< rules_to_fail
; j
++) {
4129 const char *rule
= ref_rev_parse_rules
[j
];
4130 char refname
[PATH_MAX
];
4132 /* skip matched rule */
4137 * the short name is ambiguous, if it resolves
4138 * (with this previous rule) to a valid ref
4139 * read_ref() returns 0 on success
4141 mksnpath(refname
, sizeof(refname
),
4142 rule
, short_name_len
, short_name
);
4143 if (ref_exists(refname
))
4148 * short name is non-ambiguous if all previous rules
4149 * haven't resolved to a valid ref
4151 if (j
== rules_to_fail
)
4156 return xstrdup(refname
);
4159 static struct string_list
*hide_refs
;
4161 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
4163 if (!strcmp("transfer.hiderefs", var
) ||
4164 /* NEEDSWORK: use parse_config_key() once both are merged */
4165 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
4166 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
4171 return config_error_nonbool(var
);
4172 ref
= xstrdup(value
);
4174 while (len
&& ref
[len
- 1] == '/')
4177 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
4178 hide_refs
->strdup_strings
= 1;
4180 string_list_append(hide_refs
, ref
);
4185 int ref_is_hidden(const char *refname
)
4187 struct string_list_item
*item
;
4191 for_each_string_list_item(item
, hide_refs
) {
4193 if (!starts_with(refname
, item
->string
))
4195 len
= strlen(item
->string
);
4196 if (!refname
[len
] || refname
[len
] == '/')
4202 struct expire_reflog_cb
{
4204 reflog_expiry_should_prune_fn
*should_prune_fn
;
4207 unsigned char last_kept_sha1
[20];
4210 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
4211 const char *email
, unsigned long timestamp
, int tz
,
4212 const char *message
, void *cb_data
)
4214 struct expire_reflog_cb
*cb
= cb_data
;
4215 struct expire_reflog_policy_cb
*policy_cb
= cb
->policy_cb
;
4217 if (cb
->flags
& EXPIRE_REFLOGS_REWRITE
)
4218 osha1
= cb
->last_kept_sha1
;
4220 if ((*cb
->should_prune_fn
)(osha1
, nsha1
, email
, timestamp
, tz
,
4221 message
, policy_cb
)) {
4223 printf("would prune %s", message
);
4224 else if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4225 printf("prune %s", message
);
4228 fprintf(cb
->newlog
, "%s %s %s %lu %+05d\t%s",
4229 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
4230 email
, timestamp
, tz
, message
);
4231 hashcpy(cb
->last_kept_sha1
, nsha1
);
4233 if (cb
->flags
& EXPIRE_REFLOGS_VERBOSE
)
4234 printf("keep %s", message
);
4239 int reflog_expire(const char *refname
, const unsigned char *sha1
,
4241 reflog_expiry_prepare_fn prepare_fn
,
4242 reflog_expiry_should_prune_fn should_prune_fn
,
4243 reflog_expiry_cleanup_fn cleanup_fn
,
4244 void *policy_cb_data
)
4246 static struct lock_file reflog_lock
;
4247 struct expire_reflog_cb cb
;
4248 struct ref_lock
*lock
;
4252 struct strbuf err
= STRBUF_INIT
;
4254 memset(&cb
, 0, sizeof(cb
));
4256 cb
.policy_cb
= policy_cb_data
;
4257 cb
.should_prune_fn
= should_prune_fn
;
4260 * The reflog file is locked by holding the lock on the
4261 * reference itself, plus we might need to update the
4262 * reference if --updateref was specified:
4264 lock
= lock_ref_sha1_basic(refname
, sha1
, NULL
, NULL
, 0, &type
, &err
);
4266 error("cannot lock ref '%s': %s", refname
, err
.buf
);
4267 strbuf_release(&err
);
4270 if (!reflog_exists(refname
)) {
4275 log_file
= git_pathdup("logs/%s", refname
);
4276 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4278 * Even though holding $GIT_DIR/logs/$reflog.lock has
4279 * no locking implications, we use the lock_file
4280 * machinery here anyway because it does a lot of the
4281 * work we need, including cleaning up if the program
4282 * exits unexpectedly.
4284 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
4285 struct strbuf err
= STRBUF_INIT
;
4286 unable_to_lock_message(log_file
, errno
, &err
);
4287 error("%s", err
.buf
);
4288 strbuf_release(&err
);
4291 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
4293 error("cannot fdopen %s (%s)",
4294 reflog_lock
.filename
.buf
, strerror(errno
));
4299 (*prepare_fn
)(refname
, sha1
, cb
.policy_cb
);
4300 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
4301 (*cleanup_fn
)(cb
.policy_cb
);
4303 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
)) {
4305 * It doesn't make sense to adjust a reference pointed
4306 * to by a symbolic ref based on expiring entries in
4307 * the symbolic reference's reflog. Nor can we update
4308 * a reference if there are no remaining reflog
4311 int update
= (flags
& EXPIRE_REFLOGS_UPDATE_REF
) &&
4312 !(type
& REF_ISSYMREF
) &&
4313 !is_null_sha1(cb
.last_kept_sha1
);
4315 if (close_lock_file(&reflog_lock
)) {
4316 status
|= error("couldn't write %s: %s", log_file
,
4318 } else if (update
&&
4319 (write_in_full(lock
->lk
->fd
,
4320 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
4321 write_str_in_full(lock
->lk
->fd
, "\n") != 1 ||
4322 close_ref(lock
) < 0)) {
4323 status
|= error("couldn't write %s",
4324 lock
->lk
->filename
.buf
);
4325 rollback_lock_file(&reflog_lock
);
4326 } else if (commit_lock_file(&reflog_lock
)) {
4327 status
|= error("unable to commit reflog '%s' (%s)",
4328 log_file
, strerror(errno
));
4329 } else if (update
&& commit_ref(lock
)) {
4330 status
|= error("couldn't set %s", lock
->ref_name
);
4338 rollback_lock_file(&reflog_lock
);