7 #include "string-list.h"
10 * How to handle various characters in refnames:
11 * 0: An acceptable character for refs
13 * 2: ., look for a preceding . to reject .. in refs
14 * 3: {, look for a preceding @ to reject @{ in refs
15 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
17 static unsigned char refname_disposition
[256] = {
18 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
19 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
20 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
21 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
22 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
23 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
24 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
25 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
29 * Used as a flag to ref_transaction_delete when a loose ref is being
32 #define REF_ISPRUNING 0x0100
34 * Try to read one refname component from the front of refname.
35 * Return the length of the component found, or -1 if the component is
36 * not legal. It is legal if it is something reasonable to have under
37 * ".git/refs/"; We do not like it if:
39 * - any path component of it begins with ".", or
40 * - it has double dots "..", or
41 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
42 * - it ends with a "/".
43 * - it ends with ".lock"
44 * - it contains a "\" (backslash)
46 static int check_refname_component(const char *refname
, int flags
)
51 for (cp
= refname
; ; cp
++) {
53 unsigned char disp
= refname_disposition
[ch
];
59 return -1; /* Refname contains "..". */
63 return -1; /* Refname contains "@{". */
72 return 0; /* Component has zero length. */
73 if (refname
[0] == '.') {
74 if (!(flags
& REFNAME_DOT_COMPONENT
))
75 return -1; /* Component starts with '.'. */
77 * Even if leading dots are allowed, don't allow "."
78 * as a component (".." is prevented by a rule above).
80 if (refname
[1] == '\0')
81 return -1; /* Component equals ".". */
83 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
84 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
85 return -1; /* Refname ends with ".lock". */
89 int check_refname_format(const char *refname
, int flags
)
91 int component_len
, component_count
= 0;
93 if (!strcmp(refname
, "@"))
94 /* Refname is a single character '@'. */
98 /* We are at the start of a path component. */
99 component_len
= check_refname_component(refname
, flags
);
100 if (component_len
<= 0) {
101 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
103 (refname
[1] == '\0' || refname
[1] == '/')) {
104 /* Accept one wildcard as a full refname component. */
105 flags
&= ~REFNAME_REFSPEC_PATTERN
;
112 if (refname
[component_len
] == '\0')
114 /* Skip to next component. */
115 refname
+= component_len
+ 1;
118 if (refname
[component_len
- 1] == '.')
119 return -1; /* Refname ends with '.'. */
120 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
121 return -1; /* Refname has only one component. */
128 * Information used (along with the information in ref_entry) to
129 * describe a single cached reference. This data structure only
130 * occurs embedded in a union in struct ref_entry, and only when
131 * (ref_entry->flag & REF_DIR) is zero.
135 * The name of the object to which this reference resolves
136 * (which may be a tag object). If REF_ISBROKEN, this is
137 * null. If REF_ISSYMREF, then this is the name of the object
138 * referred to by the last reference in the symlink chain.
140 unsigned char sha1
[20];
143 * If REF_KNOWS_PEELED, then this field holds the peeled value
144 * of this reference, or null if the reference is known not to
145 * be peelable. See the documentation for peel_ref() for an
146 * exact definition of "peelable".
148 unsigned char peeled
[20];
154 * Information used (along with the information in ref_entry) to
155 * describe a level in the hierarchy of references. This data
156 * structure only occurs embedded in a union in struct ref_entry, and
157 * only when (ref_entry.flag & REF_DIR) is set. In that case,
158 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
159 * in the directory have already been read:
161 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
162 * or packed references, already read.
164 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
165 * references that hasn't been read yet (nor has any of its
168 * Entries within a directory are stored within a growable array of
169 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
170 * sorted are sorted by their component name in strcmp() order and the
171 * remaining entries are unsorted.
173 * Loose references are read lazily, one directory at a time. When a
174 * directory of loose references is read, then all of the references
175 * in that directory are stored, and REF_INCOMPLETE stubs are created
176 * for any subdirectories, but the subdirectories themselves are not
177 * read. The reading is triggered by get_ref_dir().
183 * Entries with index 0 <= i < sorted are sorted by name. New
184 * entries are appended to the list unsorted, and are sorted
185 * only when required; thus we avoid the need to sort the list
186 * after the addition of every reference.
190 /* A pointer to the ref_cache that contains this ref_dir. */
191 struct ref_cache
*ref_cache
;
193 struct ref_entry
**entries
;
197 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
198 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
203 * The field ref_entry->u.value.peeled of this value entry contains
204 * the correct peeled value for the reference, which might be
205 * null_sha1 if the reference is not a tag or if it is broken.
207 #define REF_KNOWS_PEELED 0x08
209 /* ref_entry represents a directory of references */
213 * Entry has not yet been read from disk (used only for REF_DIR
214 * entries representing loose references)
216 #define REF_INCOMPLETE 0x20
219 * A ref_entry represents either a reference or a "subdirectory" of
222 * Each directory in the reference namespace is represented by a
223 * ref_entry with (flags & REF_DIR) set and containing a subdir member
224 * that holds the entries in that directory that have been read so
225 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
226 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
227 * used for loose reference directories.
229 * References are represented by a ref_entry with (flags & REF_DIR)
230 * unset and a value member that describes the reference's value. The
231 * flag member is at the ref_entry level, but it is also needed to
232 * interpret the contents of the value field (in other words, a
233 * ref_value object is not very much use without the enclosing
236 * Reference names cannot end with slash and directories' names are
237 * always stored with a trailing slash (except for the top-level
238 * directory, which is always denoted by ""). This has two nice
239 * consequences: (1) when the entries in each subdir are sorted
240 * lexicographically by name (as they usually are), the references in
241 * a whole tree can be generated in lexicographic order by traversing
242 * the tree in left-to-right, depth-first order; (2) the names of
243 * references and subdirectories cannot conflict, and therefore the
244 * presence of an empty subdirectory does not block the creation of a
245 * similarly-named reference. (The fact that reference names with the
246 * same leading components can conflict *with each other* is a
247 * separate issue that is regulated by is_refname_available().)
249 * Please note that the name field contains the fully-qualified
250 * reference (or subdirectory) name. Space could be saved by only
251 * storing the relative names. But that would require the full names
252 * to be generated on the fly when iterating in do_for_each_ref(), and
253 * would break callback functions, who have always been able to assume
254 * that the name strings that they are passed will not be freed during
258 unsigned char flag
; /* ISSYMREF? ISPACKED? */
260 struct ref_value value
; /* if not (flags&REF_DIR) */
261 struct ref_dir subdir
; /* if (flags&REF_DIR) */
264 * The full name of the reference (e.g., "refs/heads/master")
265 * or the full name of the directory with a trailing slash
266 * (e.g., "refs/heads/"):
268 char name
[FLEX_ARRAY
];
271 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
273 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
276 assert(entry
->flag
& REF_DIR
);
277 dir
= &entry
->u
.subdir
;
278 if (entry
->flag
& REF_INCOMPLETE
) {
279 read_loose_refs(entry
->name
, dir
);
280 entry
->flag
&= ~REF_INCOMPLETE
;
285 static struct ref_entry
*create_ref_entry(const char *refname
,
286 const unsigned char *sha1
, int flag
,
290 struct ref_entry
*ref
;
293 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
|REFNAME_DOT_COMPONENT
))
294 die("Reference has invalid format: '%s'", refname
);
295 len
= strlen(refname
) + 1;
296 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
297 hashcpy(ref
->u
.value
.sha1
, sha1
);
298 hashclr(ref
->u
.value
.peeled
);
299 memcpy(ref
->name
, refname
, len
);
304 static void clear_ref_dir(struct ref_dir
*dir
);
306 static void free_ref_entry(struct ref_entry
*entry
)
308 if (entry
->flag
& REF_DIR
) {
310 * Do not use get_ref_dir() here, as that might
311 * trigger the reading of loose refs.
313 clear_ref_dir(&entry
->u
.subdir
);
319 * Add a ref_entry to the end of dir (unsorted). Entry is always
320 * stored directly in dir; no recursion into subdirectories is
323 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
325 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
326 dir
->entries
[dir
->nr
++] = entry
;
327 /* optimize for the case that entries are added in order */
329 (dir
->nr
== dir
->sorted
+ 1 &&
330 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
331 dir
->entries
[dir
->nr
- 1]->name
) < 0))
332 dir
->sorted
= dir
->nr
;
336 * Clear and free all entries in dir, recursively.
338 static void clear_ref_dir(struct ref_dir
*dir
)
341 for (i
= 0; i
< dir
->nr
; i
++)
342 free_ref_entry(dir
->entries
[i
]);
344 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
349 * Create a struct ref_entry object for the specified dirname.
350 * dirname is the name of the directory with a trailing slash (e.g.,
351 * "refs/heads/") or "" for the top-level directory.
353 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
354 const char *dirname
, size_t len
,
357 struct ref_entry
*direntry
;
358 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
359 memcpy(direntry
->name
, dirname
, len
);
360 direntry
->name
[len
] = '\0';
361 direntry
->u
.subdir
.ref_cache
= ref_cache
;
362 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
366 static int ref_entry_cmp(const void *a
, const void *b
)
368 struct ref_entry
*one
= *(struct ref_entry
**)a
;
369 struct ref_entry
*two
= *(struct ref_entry
**)b
;
370 return strcmp(one
->name
, two
->name
);
373 static void sort_ref_dir(struct ref_dir
*dir
);
375 struct string_slice
{
380 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
382 const struct string_slice
*key
= key_
;
383 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
384 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
387 return '\0' - (unsigned char)ent
->name
[key
->len
];
391 * Return the index of the entry with the given refname from the
392 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
393 * no such entry is found. dir must already be complete.
395 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
397 struct ref_entry
**r
;
398 struct string_slice key
;
400 if (refname
== NULL
|| !dir
->nr
)
406 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
407 ref_entry_cmp_sslice
);
412 return r
- dir
->entries
;
416 * Search for a directory entry directly within dir (without
417 * recursing). Sort dir if necessary. subdirname must be a directory
418 * name (i.e., end in '/'). If mkdir is set, then create the
419 * directory if it is missing; otherwise, return NULL if the desired
420 * directory cannot be found. dir must already be complete.
422 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
423 const char *subdirname
, size_t len
,
426 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
427 struct ref_entry
*entry
;
428 if (entry_index
== -1) {
432 * Since dir is complete, the absence of a subdir
433 * means that the subdir really doesn't exist;
434 * therefore, create an empty record for it but mark
435 * the record complete.
437 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
438 add_entry_to_dir(dir
, entry
);
440 entry
= dir
->entries
[entry_index
];
442 return get_ref_dir(entry
);
446 * If refname is a reference name, find the ref_dir within the dir
447 * tree that should hold refname. If refname is a directory name
448 * (i.e., ends in '/'), then return that ref_dir itself. dir must
449 * represent the top-level directory and must already be complete.
450 * Sort ref_dirs and recurse into subdirectories as necessary. If
451 * mkdir is set, then create any missing directories; otherwise,
452 * return NULL if the desired directory cannot be found.
454 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
455 const char *refname
, int mkdir
)
458 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
459 size_t dirnamelen
= slash
- refname
+ 1;
460 struct ref_dir
*subdir
;
461 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
473 * Find the value entry with the given name in dir, sorting ref_dirs
474 * and recursing into subdirectories as necessary. If the name is not
475 * found or it corresponds to a directory entry, return NULL.
477 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
480 struct ref_entry
*entry
;
481 dir
= find_containing_dir(dir
, refname
, 0);
484 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
485 if (entry_index
== -1)
487 entry
= dir
->entries
[entry_index
];
488 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
492 * Remove the entry with the given name from dir, recursing into
493 * subdirectories as necessary. If refname is the name of a directory
494 * (i.e., ends with '/'), then remove the directory and its contents.
495 * If the removal was successful, return the number of entries
496 * remaining in the directory entry that contained the deleted entry.
497 * If the name was not found, return -1. Please note that this
498 * function only deletes the entry from the cache; it does not delete
499 * it from the filesystem or ensure that other cache entries (which
500 * might be symbolic references to the removed entry) are updated.
501 * Nor does it remove any containing dir entries that might be made
502 * empty by the removal. dir must represent the top-level directory
503 * and must already be complete.
505 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
507 int refname_len
= strlen(refname
);
509 struct ref_entry
*entry
;
510 int is_dir
= refname
[refname_len
- 1] == '/';
513 * refname represents a reference directory. Remove
514 * the trailing slash; otherwise we will get the
515 * directory *representing* refname rather than the
516 * one *containing* it.
518 char *dirname
= xmemdupz(refname
, refname_len
- 1);
519 dir
= find_containing_dir(dir
, dirname
, 0);
522 dir
= find_containing_dir(dir
, refname
, 0);
526 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
527 if (entry_index
== -1)
529 entry
= dir
->entries
[entry_index
];
531 memmove(&dir
->entries
[entry_index
],
532 &dir
->entries
[entry_index
+ 1],
533 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
536 if (dir
->sorted
> entry_index
)
538 free_ref_entry(entry
);
543 * Add a ref_entry to the ref_dir (unsorted), recursing into
544 * subdirectories as necessary. dir must represent the top-level
545 * directory. Return 0 on success.
547 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
549 dir
= find_containing_dir(dir
, ref
->name
, 1);
552 add_entry_to_dir(dir
, ref
);
557 * Emit a warning and return true iff ref1 and ref2 have the same name
558 * and the same sha1. Die if they have the same name but different
561 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
563 if (strcmp(ref1
->name
, ref2
->name
))
566 /* Duplicate name; make sure that they don't conflict: */
568 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
569 /* This is impossible by construction */
570 die("Reference directory conflict: %s", ref1
->name
);
572 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
573 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
575 warning("Duplicated ref: %s", ref1
->name
);
580 * Sort the entries in dir non-recursively (if they are not already
581 * sorted) and remove any duplicate entries.
583 static void sort_ref_dir(struct ref_dir
*dir
)
586 struct ref_entry
*last
= NULL
;
589 * This check also prevents passing a zero-length array to qsort(),
590 * which is a problem on some platforms.
592 if (dir
->sorted
== dir
->nr
)
595 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
597 /* Remove any duplicates: */
598 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
599 struct ref_entry
*entry
= dir
->entries
[j
];
600 if (last
&& is_dup_ref(last
, entry
))
601 free_ref_entry(entry
);
603 last
= dir
->entries
[i
++] = entry
;
605 dir
->sorted
= dir
->nr
= i
;
608 /* Include broken references in a do_for_each_ref*() iteration: */
609 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
612 * Return true iff the reference described by entry can be resolved to
613 * an object in the database. Emit a warning if the referred-to
614 * object does not exist.
616 static int ref_resolves_to_object(struct ref_entry
*entry
)
618 if (entry
->flag
& REF_ISBROKEN
)
620 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
621 error("%s does not point to a valid object!", entry
->name
);
628 * current_ref is a performance hack: when iterating over references
629 * using the for_each_ref*() functions, current_ref is set to the
630 * current reference's entry before calling the callback function. If
631 * the callback function calls peel_ref(), then peel_ref() first
632 * checks whether the reference to be peeled is the current reference
633 * (it usually is) and if so, returns that reference's peeled version
634 * if it is available. This avoids a refname lookup in a common case.
636 static struct ref_entry
*current_ref
;
638 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
640 struct ref_entry_cb
{
649 * Handle one reference in a do_for_each_ref*()-style iteration,
650 * calling an each_ref_fn for each entry.
652 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
654 struct ref_entry_cb
*data
= cb_data
;
655 struct ref_entry
*old_current_ref
;
658 if (!starts_with(entry
->name
, data
->base
))
661 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
662 !ref_resolves_to_object(entry
))
665 /* Store the old value, in case this is a recursive call: */
666 old_current_ref
= current_ref
;
668 retval
= data
->fn(entry
->name
+ data
->trim
, entry
->u
.value
.sha1
,
669 entry
->flag
, data
->cb_data
);
670 current_ref
= old_current_ref
;
675 * Call fn for each reference in dir that has index in the range
676 * offset <= index < dir->nr. Recurse into subdirectories that are in
677 * that index range, sorting them before iterating. This function
678 * does not sort dir itself; it should be sorted beforehand. fn is
679 * called for all references, including broken ones.
681 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
682 each_ref_entry_fn fn
, void *cb_data
)
685 assert(dir
->sorted
== dir
->nr
);
686 for (i
= offset
; i
< dir
->nr
; i
++) {
687 struct ref_entry
*entry
= dir
->entries
[i
];
689 if (entry
->flag
& REF_DIR
) {
690 struct ref_dir
*subdir
= get_ref_dir(entry
);
691 sort_ref_dir(subdir
);
692 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
694 retval
= fn(entry
, cb_data
);
703 * Call fn for each reference in the union of dir1 and dir2, in order
704 * by refname. Recurse into subdirectories. If a value entry appears
705 * in both dir1 and dir2, then only process the version that is in
706 * dir2. The input dirs must already be sorted, but subdirs will be
707 * sorted as needed. fn is called for all references, including
710 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
711 struct ref_dir
*dir2
,
712 each_ref_entry_fn fn
, void *cb_data
)
717 assert(dir1
->sorted
== dir1
->nr
);
718 assert(dir2
->sorted
== dir2
->nr
);
720 struct ref_entry
*e1
, *e2
;
722 if (i1
== dir1
->nr
) {
723 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
725 if (i2
== dir2
->nr
) {
726 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
728 e1
= dir1
->entries
[i1
];
729 e2
= dir2
->entries
[i2
];
730 cmp
= strcmp(e1
->name
, e2
->name
);
732 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
733 /* Both are directories; descend them in parallel. */
734 struct ref_dir
*subdir1
= get_ref_dir(e1
);
735 struct ref_dir
*subdir2
= get_ref_dir(e2
);
736 sort_ref_dir(subdir1
);
737 sort_ref_dir(subdir2
);
738 retval
= do_for_each_entry_in_dirs(
739 subdir1
, subdir2
, fn
, cb_data
);
742 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
743 /* Both are references; ignore the one from dir1. */
744 retval
= fn(e2
, cb_data
);
748 die("conflict between reference and directory: %s",
760 if (e
->flag
& REF_DIR
) {
761 struct ref_dir
*subdir
= get_ref_dir(e
);
762 sort_ref_dir(subdir
);
763 retval
= do_for_each_entry_in_dir(
764 subdir
, 0, fn
, cb_data
);
766 retval
= fn(e
, cb_data
);
775 * Load all of the refs from the dir into our in-memory cache. The hard work
776 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
777 * through all of the sub-directories. We do not even need to care about
778 * sorting, as traversal order does not matter to us.
780 static void prime_ref_dir(struct ref_dir
*dir
)
783 for (i
= 0; i
< dir
->nr
; i
++) {
784 struct ref_entry
*entry
= dir
->entries
[i
];
785 if (entry
->flag
& REF_DIR
)
786 prime_ref_dir(get_ref_dir(entry
));
790 static int entry_matches(struct ref_entry
*entry
, const struct string_list
*list
)
792 return list
&& string_list_has_string(list
, entry
->name
);
795 struct nonmatching_ref_data
{
796 const struct string_list
*skip
;
797 struct ref_entry
*found
;
800 static int nonmatching_ref_fn(struct ref_entry
*entry
, void *vdata
)
802 struct nonmatching_ref_data
*data
= vdata
;
804 if (entry_matches(entry
, data
->skip
))
811 static void report_refname_conflict(struct ref_entry
*entry
,
814 error("'%s' exists; cannot create '%s'", entry
->name
, refname
);
818 * Return true iff a reference named refname could be created without
819 * conflicting with the name of an existing reference in dir. If
820 * skip is non-NULL, ignore potential conflicts with refs in skip
821 * (e.g., because they are scheduled for deletion in the same
824 * Two reference names conflict if one of them exactly matches the
825 * leading components of the other; e.g., "foo/bar" conflicts with
826 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
829 * skip must be sorted.
831 static int is_refname_available(const char *refname
,
832 const struct string_list
*skip
,
840 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
842 * We are still at a leading dir of the refname; we are
843 * looking for a conflict with a leaf entry.
845 * If we find one, we still must make sure it is
848 pos
= search_ref_dir(dir
, refname
, slash
- refname
);
850 struct ref_entry
*entry
= dir
->entries
[pos
];
851 if (entry_matches(entry
, skip
))
853 report_refname_conflict(entry
, refname
);
859 * Otherwise, we can try to continue our search with
860 * the next component; if we come up empty, we know
861 * there is nothing under this whole prefix.
863 pos
= search_ref_dir(dir
, refname
, slash
+ 1 - refname
);
867 dir
= get_ref_dir(dir
->entries
[pos
]);
871 * We are at the leaf of our refname; we want to
872 * make sure there are no directories which match it.
874 len
= strlen(refname
);
875 dirname
= xmallocz(len
+ 1);
876 sprintf(dirname
, "%s/", refname
);
877 pos
= search_ref_dir(dir
, dirname
, len
+ 1);
882 * We found a directory named "refname". It is a
883 * problem iff it contains any ref that is not
886 struct ref_entry
*entry
= dir
->entries
[pos
];
887 struct ref_dir
*dir
= get_ref_dir(entry
);
888 struct nonmatching_ref_data data
;
892 if (!do_for_each_entry_in_dir(dir
, 0, nonmatching_ref_fn
, &data
))
895 report_refname_conflict(data
.found
, refname
);
900 * There is no point in searching for another leaf
901 * node which matches it; such an entry would be the
902 * ref we are looking for, not a conflict.
907 struct packed_ref_cache
{
908 struct ref_entry
*root
;
911 * Count of references to the data structure in this instance,
912 * including the pointer from ref_cache::packed if any. The
913 * data will not be freed as long as the reference count is
916 unsigned int referrers
;
919 * Iff the packed-refs file associated with this instance is
920 * currently locked for writing, this points at the associated
921 * lock (which is owned by somebody else). The referrer count
922 * is also incremented when the file is locked and decremented
923 * when it is unlocked.
925 struct lock_file
*lock
;
927 /* The metadata from when this packed-refs cache was read */
928 struct stat_validity validity
;
932 * Future: need to be in "struct repository"
933 * when doing a full libification.
935 static struct ref_cache
{
936 struct ref_cache
*next
;
937 struct ref_entry
*loose
;
938 struct packed_ref_cache
*packed
;
940 * The submodule name, or "" for the main repo. We allocate
941 * length 1 rather than FLEX_ARRAY so that the main ref_cache
942 * is initialized correctly.
945 } ref_cache
, *submodule_ref_caches
;
947 /* Lock used for the main packed-refs file: */
948 static struct lock_file packlock
;
951 * Increment the reference count of *packed_refs.
953 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
955 packed_refs
->referrers
++;
959 * Decrease the reference count of *packed_refs. If it goes to zero,
960 * free *packed_refs and return true; otherwise return false.
962 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
964 if (!--packed_refs
->referrers
) {
965 free_ref_entry(packed_refs
->root
);
966 stat_validity_clear(&packed_refs
->validity
);
974 static void clear_packed_ref_cache(struct ref_cache
*refs
)
977 struct packed_ref_cache
*packed_refs
= refs
->packed
;
979 if (packed_refs
->lock
)
980 die("internal error: packed-ref cache cleared while locked");
982 release_packed_ref_cache(packed_refs
);
986 static void clear_loose_ref_cache(struct ref_cache
*refs
)
989 free_ref_entry(refs
->loose
);
994 static struct ref_cache
*create_ref_cache(const char *submodule
)
997 struct ref_cache
*refs
;
1000 len
= strlen(submodule
) + 1;
1001 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1002 memcpy(refs
->name
, submodule
, len
);
1007 * Return a pointer to a ref_cache for the specified submodule. For
1008 * the main repository, use submodule==NULL. The returned structure
1009 * will be allocated and initialized but not necessarily populated; it
1010 * should not be freed.
1012 static struct ref_cache
*get_ref_cache(const char *submodule
)
1014 struct ref_cache
*refs
;
1016 if (!submodule
|| !*submodule
)
1019 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1020 if (!strcmp(submodule
, refs
->name
))
1023 refs
= create_ref_cache(submodule
);
1024 refs
->next
= submodule_ref_caches
;
1025 submodule_ref_caches
= refs
;
1029 /* The length of a peeled reference line in packed-refs, including EOL: */
1030 #define PEELED_LINE_LENGTH 42
1033 * The packed-refs header line that we write out. Perhaps other
1034 * traits will be added later. The trailing space is required.
1036 static const char PACKED_REFS_HEADER
[] =
1037 "# pack-refs with: peeled fully-peeled \n";
1040 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1041 * Return a pointer to the refname within the line (null-terminated),
1042 * or NULL if there was a problem.
1044 static const char *parse_ref_line(char *line
, unsigned char *sha1
)
1047 * 42: the answer to everything.
1049 * In this case, it happens to be the answer to
1050 * 40 (length of sha1 hex representation)
1051 * +1 (space in between hex and name)
1052 * +1 (newline at the end of the line)
1054 int len
= strlen(line
) - 42;
1058 if (get_sha1_hex(line
, sha1
) < 0)
1060 if (!isspace(line
[40]))
1065 if (line
[len
] != '\n')
1073 * Read f, which is a packed-refs file, into dir.
1075 * A comment line of the form "# pack-refs with: " may contain zero or
1076 * more traits. We interpret the traits as follows:
1080 * Probably no references are peeled. But if the file contains a
1081 * peeled value for a reference, we will use it.
1085 * References under "refs/tags/", if they *can* be peeled, *are*
1086 * peeled in this file. References outside of "refs/tags/" are
1087 * probably not peeled even if they could have been, but if we find
1088 * a peeled value for such a reference we will use it.
1092 * All references in the file that can be peeled are peeled.
1093 * Inversely (and this is more important), any references in the
1094 * file for which no peeled value is recorded is not peelable. This
1095 * trait should typically be written alongside "peeled" for
1096 * compatibility with older clients, but we do not require it
1097 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1099 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1101 struct ref_entry
*last
= NULL
;
1102 char refline
[PATH_MAX
];
1103 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1105 while (fgets(refline
, sizeof(refline
), f
)) {
1106 unsigned char sha1
[20];
1107 const char *refname
;
1108 static const char header
[] = "# pack-refs with:";
1110 if (!strncmp(refline
, header
, sizeof(header
)-1)) {
1111 const char *traits
= refline
+ sizeof(header
) - 1;
1112 if (strstr(traits
, " fully-peeled "))
1113 peeled
= PEELED_FULLY
;
1114 else if (strstr(traits
, " peeled "))
1115 peeled
= PEELED_TAGS
;
1116 /* perhaps other traits later as well */
1120 refname
= parse_ref_line(refline
, sha1
);
1122 last
= create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1);
1123 if (peeled
== PEELED_FULLY
||
1124 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1125 last
->flag
|= REF_KNOWS_PEELED
;
1130 refline
[0] == '^' &&
1131 strlen(refline
) == PEELED_LINE_LENGTH
&&
1132 refline
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1133 !get_sha1_hex(refline
+ 1, sha1
)) {
1134 hashcpy(last
->u
.value
.peeled
, sha1
);
1136 * Regardless of what the file header said,
1137 * we definitely know the value of *this*
1140 last
->flag
|= REF_KNOWS_PEELED
;
1146 * Get the packed_ref_cache for the specified ref_cache, creating it
1149 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1151 const char *packed_refs_file
;
1154 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1156 packed_refs_file
= git_path("packed-refs");
1159 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1160 clear_packed_ref_cache(refs
);
1162 if (!refs
->packed
) {
1165 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1166 acquire_packed_ref_cache(refs
->packed
);
1167 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1168 f
= fopen(packed_refs_file
, "r");
1170 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1171 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1175 return refs
->packed
;
1178 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1180 return get_ref_dir(packed_ref_cache
->root
);
1183 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1185 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1188 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1190 struct packed_ref_cache
*packed_ref_cache
=
1191 get_packed_ref_cache(&ref_cache
);
1193 if (!packed_ref_cache
->lock
)
1194 die("internal error: packed refs not locked");
1195 add_ref(get_packed_ref_dir(packed_ref_cache
),
1196 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1200 * Read the loose references from the namespace dirname into dir
1201 * (without recursing). dirname must end with '/'. dir must be the
1202 * directory entry corresponding to dirname.
1204 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1206 struct ref_cache
*refs
= dir
->ref_cache
;
1210 int dirnamelen
= strlen(dirname
);
1211 struct strbuf refname
;
1214 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1216 path
= git_path("%s", dirname
);
1222 strbuf_init(&refname
, dirnamelen
+ 257);
1223 strbuf_add(&refname
, dirname
, dirnamelen
);
1225 while ((de
= readdir(d
)) != NULL
) {
1226 unsigned char sha1
[20];
1231 if (de
->d_name
[0] == '.')
1233 if (ends_with(de
->d_name
, ".lock"))
1235 strbuf_addstr(&refname
, de
->d_name
);
1236 refdir
= *refs
->name
1237 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1238 : git_path("%s", refname
.buf
);
1239 if (stat(refdir
, &st
) < 0) {
1240 ; /* silently ignore */
1241 } else if (S_ISDIR(st
.st_mode
)) {
1242 strbuf_addch(&refname
, '/');
1243 add_entry_to_dir(dir
,
1244 create_dir_entry(refs
, refname
.buf
,
1250 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
1252 flag
|= REF_ISBROKEN
;
1254 } else if (read_ref_full(refname
.buf
,
1255 RESOLVE_REF_READING
,
1258 flag
|= REF_ISBROKEN
;
1260 add_entry_to_dir(dir
,
1261 create_ref_entry(refname
.buf
, sha1
, flag
, 1));
1263 strbuf_setlen(&refname
, dirnamelen
);
1265 strbuf_release(&refname
);
1269 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1273 * Mark the top-level directory complete because we
1274 * are about to read the only subdirectory that can
1277 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1279 * Create an incomplete entry for "refs/":
1281 add_entry_to_dir(get_ref_dir(refs
->loose
),
1282 create_dir_entry(refs
, "refs/", 5, 1));
1284 return get_ref_dir(refs
->loose
);
1287 /* We allow "recursive" symbolic refs. Only within reason, though */
1289 #define MAXREFLEN (1024)
1292 * Called by resolve_gitlink_ref_recursive() after it failed to read
1293 * from the loose refs in ref_cache refs. Find <refname> in the
1294 * packed-refs file for the submodule.
1296 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1297 const char *refname
, unsigned char *sha1
)
1299 struct ref_entry
*ref
;
1300 struct ref_dir
*dir
= get_packed_refs(refs
);
1302 ref
= find_ref(dir
, refname
);
1306 hashcpy(sha1
, ref
->u
.value
.sha1
);
1310 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1311 const char *refname
, unsigned char *sha1
,
1315 char buffer
[128], *p
;
1318 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1321 ? git_path_submodule(refs
->name
, "%s", refname
)
1322 : git_path("%s", refname
);
1323 fd
= open(path
, O_RDONLY
);
1325 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1327 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1331 while (len
&& isspace(buffer
[len
-1]))
1335 /* Was it a detached head or an old-fashioned symlink? */
1336 if (!get_sha1_hex(buffer
, sha1
))
1340 if (strncmp(buffer
, "ref:", 4))
1346 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1349 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1351 int len
= strlen(path
), retval
;
1353 struct ref_cache
*refs
;
1355 while (len
&& path
[len
-1] == '/')
1359 submodule
= xstrndup(path
, len
);
1360 refs
= get_ref_cache(submodule
);
1363 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1368 * Return the ref_entry for the given refname from the packed
1369 * references. If it does not exist, return NULL.
1371 static struct ref_entry
*get_packed_ref(const char *refname
)
1373 return find_ref(get_packed_refs(&ref_cache
), refname
);
1377 * A loose ref file doesn't exist; check for a packed ref. The
1378 * options are forwarded from resolve_safe_unsafe().
1380 static const char *handle_missing_loose_ref(const char *refname
,
1382 unsigned char *sha1
,
1385 struct ref_entry
*entry
;
1388 * The loose reference file does not exist; check for a packed
1391 entry
= get_packed_ref(refname
);
1393 hashcpy(sha1
, entry
->u
.value
.sha1
);
1395 *flags
|= REF_ISPACKED
;
1398 /* The reference is not a packed reference, either. */
1399 if (resolve_flags
& RESOLVE_REF_READING
) {
1407 /* This function needs to return a meaningful errno on failure */
1408 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1410 int depth
= MAXDEPTH
;
1413 static char refname_buffer
[256];
1418 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1423 char path
[PATH_MAX
];
1433 git_snpath(path
, sizeof(path
), "%s", refname
);
1436 * We might have to loop back here to avoid a race
1437 * condition: first we lstat() the file, then we try
1438 * to read it as a link or as a file. But if somebody
1439 * changes the type of the file (file <-> directory
1440 * <-> symlink) between the lstat() and reading, then
1441 * we don't want to report that as an error but rather
1442 * try again starting with the lstat().
1445 if (lstat(path
, &st
) < 0) {
1446 if (errno
== ENOENT
)
1447 return handle_missing_loose_ref(refname
,
1448 resolve_flags
, sha1
, flags
);
1453 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1454 if (S_ISLNK(st
.st_mode
)) {
1455 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1457 if (errno
== ENOENT
|| errno
== EINVAL
)
1458 /* inconsistent with lstat; retry */
1464 if (starts_with(buffer
, "refs/") &&
1465 !check_refname_format(buffer
, 0)) {
1466 strcpy(refname_buffer
, buffer
);
1467 refname
= refname_buffer
;
1469 *flags
|= REF_ISSYMREF
;
1470 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1478 /* Is it a directory? */
1479 if (S_ISDIR(st
.st_mode
)) {
1485 * Anything else, just open it and try to use it as
1488 fd
= open(path
, O_RDONLY
);
1490 if (errno
== ENOENT
)
1491 /* inconsistent with lstat; retry */
1496 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1498 int save_errno
= errno
;
1504 while (len
&& isspace(buffer
[len
-1]))
1509 * Is it a symbolic ref?
1511 if (!starts_with(buffer
, "ref:")) {
1513 * Please note that FETCH_HEAD has a second
1514 * line containing other data.
1516 if (get_sha1_hex(buffer
, sha1
) ||
1517 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1519 *flags
|= REF_ISBROKEN
;
1526 *flags
|= REF_ISSYMREF
;
1528 while (isspace(*buf
))
1530 refname
= strcpy(refname_buffer
, buf
);
1531 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1535 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1537 *flags
|= REF_ISBROKEN
;
1544 char *resolve_refdup(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1546 const char *ret
= resolve_ref_unsafe(ref
, resolve_flags
, sha1
, flags
);
1547 return ret
? xstrdup(ret
) : NULL
;
1550 /* The argument to filter_refs */
1552 const char *pattern
;
1557 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
1559 if (resolve_ref_unsafe(refname
, resolve_flags
, sha1
, flags
))
1564 int read_ref(const char *refname
, unsigned char *sha1
)
1566 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1569 int ref_exists(const char *refname
)
1571 unsigned char sha1
[20];
1572 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
1575 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1578 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1579 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1581 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1585 /* object was peeled successfully: */
1589 * object cannot be peeled because the named object (or an
1590 * object referred to by a tag in the peel chain), does not
1595 /* object cannot be peeled because it is not a tag: */
1598 /* ref_entry contains no peeled value because it is a symref: */
1599 PEEL_IS_SYMREF
= -3,
1602 * ref_entry cannot be peeled because it is broken (i.e., the
1603 * symbolic reference cannot even be resolved to an object
1610 * Peel the named object; i.e., if the object is a tag, resolve the
1611 * tag recursively until a non-tag is found. If successful, store the
1612 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1613 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1614 * and leave sha1 unchanged.
1616 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1618 struct object
*o
= lookup_unknown_object(name
);
1620 if (o
->type
== OBJ_NONE
) {
1621 int type
= sha1_object_info(name
, NULL
);
1622 if (type
< 0 || !object_as_type(o
, type
, 0))
1623 return PEEL_INVALID
;
1626 if (o
->type
!= OBJ_TAG
)
1627 return PEEL_NON_TAG
;
1629 o
= deref_tag_noverify(o
);
1631 return PEEL_INVALID
;
1633 hashcpy(sha1
, o
->sha1
);
1638 * Peel the entry (if possible) and return its new peel_status. If
1639 * repeel is true, re-peel the entry even if there is an old peeled
1640 * value that is already stored in it.
1642 * It is OK to call this function with a packed reference entry that
1643 * might be stale and might even refer to an object that has since
1644 * been garbage-collected. In such a case, if the entry has
1645 * REF_KNOWS_PEELED then leave the status unchanged and return
1646 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1648 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1650 enum peel_status status
;
1652 if (entry
->flag
& REF_KNOWS_PEELED
) {
1654 entry
->flag
&= ~REF_KNOWS_PEELED
;
1655 hashclr(entry
->u
.value
.peeled
);
1657 return is_null_sha1(entry
->u
.value
.peeled
) ?
1658 PEEL_NON_TAG
: PEEL_PEELED
;
1661 if (entry
->flag
& REF_ISBROKEN
)
1663 if (entry
->flag
& REF_ISSYMREF
)
1664 return PEEL_IS_SYMREF
;
1666 status
= peel_object(entry
->u
.value
.sha1
, entry
->u
.value
.peeled
);
1667 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1668 entry
->flag
|= REF_KNOWS_PEELED
;
1672 int peel_ref(const char *refname
, unsigned char *sha1
)
1675 unsigned char base
[20];
1677 if (current_ref
&& (current_ref
->name
== refname
1678 || !strcmp(current_ref
->name
, refname
))) {
1679 if (peel_entry(current_ref
, 0))
1681 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1685 if (read_ref_full(refname
, RESOLVE_REF_READING
, base
, &flag
))
1689 * If the reference is packed, read its ref_entry from the
1690 * cache in the hope that we already know its peeled value.
1691 * We only try this optimization on packed references because
1692 * (a) forcing the filling of the loose reference cache could
1693 * be expensive and (b) loose references anyway usually do not
1694 * have REF_KNOWS_PEELED.
1696 if (flag
& REF_ISPACKED
) {
1697 struct ref_entry
*r
= get_packed_ref(refname
);
1699 if (peel_entry(r
, 0))
1701 hashcpy(sha1
, r
->u
.value
.peeled
);
1706 return peel_object(base
, sha1
);
1709 struct warn_if_dangling_data
{
1711 const char *refname
;
1712 const struct string_list
*refnames
;
1713 const char *msg_fmt
;
1716 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1717 int flags
, void *cb_data
)
1719 struct warn_if_dangling_data
*d
= cb_data
;
1720 const char *resolves_to
;
1721 unsigned char junk
[20];
1723 if (!(flags
& REF_ISSYMREF
))
1726 resolves_to
= resolve_ref_unsafe(refname
, 0, junk
, NULL
);
1729 ? strcmp(resolves_to
, d
->refname
)
1730 : !string_list_has_string(d
->refnames
, resolves_to
))) {
1734 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1739 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1741 struct warn_if_dangling_data data
;
1744 data
.refname
= refname
;
1745 data
.refnames
= NULL
;
1746 data
.msg_fmt
= msg_fmt
;
1747 for_each_rawref(warn_if_dangling_symref
, &data
);
1750 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
1752 struct warn_if_dangling_data data
;
1755 data
.refname
= NULL
;
1756 data
.refnames
= refnames
;
1757 data
.msg_fmt
= msg_fmt
;
1758 for_each_rawref(warn_if_dangling_symref
, &data
);
1762 * Call fn for each reference in the specified ref_cache, omitting
1763 * references not in the containing_dir of base. fn is called for all
1764 * references, including broken ones. If fn ever returns a non-zero
1765 * value, stop the iteration and return that value; otherwise, return
1768 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1769 each_ref_entry_fn fn
, void *cb_data
)
1771 struct packed_ref_cache
*packed_ref_cache
;
1772 struct ref_dir
*loose_dir
;
1773 struct ref_dir
*packed_dir
;
1777 * We must make sure that all loose refs are read before accessing the
1778 * packed-refs file; this avoids a race condition in which loose refs
1779 * are migrated to the packed-refs file by a simultaneous process, but
1780 * our in-memory view is from before the migration. get_packed_ref_cache()
1781 * takes care of making sure our view is up to date with what is on
1784 loose_dir
= get_loose_refs(refs
);
1785 if (base
&& *base
) {
1786 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1789 prime_ref_dir(loose_dir
);
1791 packed_ref_cache
= get_packed_ref_cache(refs
);
1792 acquire_packed_ref_cache(packed_ref_cache
);
1793 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1794 if (base
&& *base
) {
1795 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1798 if (packed_dir
&& loose_dir
) {
1799 sort_ref_dir(packed_dir
);
1800 sort_ref_dir(loose_dir
);
1801 retval
= do_for_each_entry_in_dirs(
1802 packed_dir
, loose_dir
, fn
, cb_data
);
1803 } else if (packed_dir
) {
1804 sort_ref_dir(packed_dir
);
1805 retval
= do_for_each_entry_in_dir(
1806 packed_dir
, 0, fn
, cb_data
);
1807 } else if (loose_dir
) {
1808 sort_ref_dir(loose_dir
);
1809 retval
= do_for_each_entry_in_dir(
1810 loose_dir
, 0, fn
, cb_data
);
1813 release_packed_ref_cache(packed_ref_cache
);
1818 * Call fn for each reference in the specified ref_cache for which the
1819 * refname begins with base. If trim is non-zero, then trim that many
1820 * characters off the beginning of each refname before passing the
1821 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1822 * broken references in the iteration. If fn ever returns a non-zero
1823 * value, stop the iteration and return that value; otherwise, return
1826 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
1827 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1829 struct ref_entry_cb data
;
1834 data
.cb_data
= cb_data
;
1836 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
1839 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1841 unsigned char sha1
[20];
1845 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1846 return fn("HEAD", sha1
, 0, cb_data
);
1851 if (!read_ref_full("HEAD", RESOLVE_REF_READING
, sha1
, &flag
))
1852 return fn("HEAD", sha1
, flag
, cb_data
);
1857 int head_ref(each_ref_fn fn
, void *cb_data
)
1859 return do_head_ref(NULL
, fn
, cb_data
);
1862 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1864 return do_head_ref(submodule
, fn
, cb_data
);
1867 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1869 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
1872 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1874 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
1877 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1879 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1882 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
1883 each_ref_fn fn
, void *cb_data
)
1885 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
1888 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
1890 return for_each_ref_in("refs/tags/", fn
, cb_data
);
1893 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1895 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
1898 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
1900 return for_each_ref_in("refs/heads/", fn
, cb_data
);
1903 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1905 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
1908 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
1910 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
1913 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1915 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
1918 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1920 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
1923 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
1925 struct strbuf buf
= STRBUF_INIT
;
1927 unsigned char sha1
[20];
1930 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
1931 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, sha1
, &flag
))
1932 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
1933 strbuf_release(&buf
);
1938 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1940 struct strbuf buf
= STRBUF_INIT
;
1942 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1943 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
1944 strbuf_release(&buf
);
1948 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
1949 const char *prefix
, void *cb_data
)
1951 struct strbuf real_pattern
= STRBUF_INIT
;
1952 struct ref_filter filter
;
1955 if (!prefix
&& !starts_with(pattern
, "refs/"))
1956 strbuf_addstr(&real_pattern
, "refs/");
1958 strbuf_addstr(&real_pattern
, prefix
);
1959 strbuf_addstr(&real_pattern
, pattern
);
1961 if (!has_glob_specials(pattern
)) {
1962 /* Append implied '/' '*' if not present. */
1963 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
1964 strbuf_addch(&real_pattern
, '/');
1965 /* No need to check for '*', there is none. */
1966 strbuf_addch(&real_pattern
, '*');
1969 filter
.pattern
= real_pattern
.buf
;
1971 filter
.cb_data
= cb_data
;
1972 ret
= for_each_ref(filter_refs
, &filter
);
1974 strbuf_release(&real_pattern
);
1978 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
1980 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
1983 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1985 return do_for_each_ref(&ref_cache
, "", fn
, 0,
1986 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1989 const char *prettify_refname(const char *name
)
1992 starts_with(name
, "refs/heads/") ? 11 :
1993 starts_with(name
, "refs/tags/") ? 10 :
1994 starts_with(name
, "refs/remotes/") ? 13 :
1998 static const char *ref_rev_parse_rules
[] = {
2003 "refs/remotes/%.*s",
2004 "refs/remotes/%.*s/HEAD",
2008 int refname_match(const char *abbrev_name
, const char *full_name
)
2011 const int abbrev_name_len
= strlen(abbrev_name
);
2013 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2014 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2022 /* This function should make sure errno is meaningful on error */
2023 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
2024 const unsigned char *old_sha1
, int mustexist
)
2026 if (read_ref_full(lock
->ref_name
,
2027 mustexist
? RESOLVE_REF_READING
: 0,
2028 lock
->old_sha1
, NULL
)) {
2029 int save_errno
= errno
;
2030 error("Can't verify ref %s", lock
->ref_name
);
2035 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
2036 error("Ref %s is at %s but expected %s", lock
->ref_name
,
2037 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
2045 static int remove_empty_directories(const char *file
)
2047 /* we want to create a file but there is a directory there;
2048 * if that is an empty directory (or a directory that contains
2049 * only empty directories), remove them.
2052 int result
, save_errno
;
2054 strbuf_init(&path
, 20);
2055 strbuf_addstr(&path
, file
);
2057 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2060 strbuf_release(&path
);
2067 * *string and *len will only be substituted, and *string returned (for
2068 * later free()ing) if the string passed in is a magic short-hand form
2071 static char *substitute_branch_name(const char **string
, int *len
)
2073 struct strbuf buf
= STRBUF_INIT
;
2074 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2078 *string
= strbuf_detach(&buf
, &size
);
2080 return (char *)*string
;
2086 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2088 char *last_branch
= substitute_branch_name(&str
, &len
);
2093 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2094 char fullref
[PATH_MAX
];
2095 unsigned char sha1_from_ref
[20];
2096 unsigned char *this_result
;
2099 this_result
= refs_found
? sha1_from_ref
: sha1
;
2100 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2101 r
= resolve_ref_unsafe(fullref
, RESOLVE_REF_READING
,
2102 this_result
, &flag
);
2106 if (!warn_ambiguous_refs
)
2108 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2109 warning("ignoring dangling symref %s.", fullref
);
2110 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2111 warning("ignoring broken ref %s.", fullref
);
2118 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2120 char *last_branch
= substitute_branch_name(&str
, &len
);
2125 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2126 unsigned char hash
[20];
2127 char path
[PATH_MAX
];
2128 const char *ref
, *it
;
2130 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2131 ref
= resolve_ref_unsafe(path
, RESOLVE_REF_READING
,
2135 if (reflog_exists(path
))
2137 else if (strcmp(ref
, path
) && reflog_exists(ref
))
2141 if (!logs_found
++) {
2143 hashcpy(sha1
, hash
);
2145 if (!warn_ambiguous_refs
)
2153 * Locks a ref returning the lock on success and NULL on failure.
2154 * On failure errno is set to something meaningful.
2156 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2157 const unsigned char *old_sha1
,
2158 const struct string_list
*skip
,
2159 int flags
, int *type_p
)
2162 const char *orig_refname
= refname
;
2163 struct ref_lock
*lock
;
2166 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2167 int resolve_flags
= 0;
2169 int attempts_remaining
= 3;
2171 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
2176 lock
= xcalloc(1, sizeof(struct ref_lock
));
2180 resolve_flags
|= RESOLVE_REF_READING
;
2181 if (flags
& REF_NODEREF
&& flags
& REF_DELETING
)
2182 resolve_flags
|= RESOLVE_REF_NO_RECURSE
;
2184 refname
= resolve_ref_unsafe(refname
, resolve_flags
,
2185 lock
->old_sha1
, &type
);
2186 if (!refname
&& errno
== EISDIR
) {
2187 /* we are trying to lock foo but we used to
2188 * have foo/bar which now does not exist;
2189 * it is normal for the empty directory 'foo'
2192 ref_file
= git_path("%s", orig_refname
);
2193 if (remove_empty_directories(ref_file
)) {
2195 error("there are still refs under '%s'", orig_refname
);
2198 refname
= resolve_ref_unsafe(orig_refname
, resolve_flags
,
2199 lock
->old_sha1
, &type
);
2205 error("unable to resolve reference %s: %s",
2206 orig_refname
, strerror(errno
));
2209 missing
= is_null_sha1(lock
->old_sha1
);
2210 /* When the ref did not exist and we are creating it,
2211 * make sure there is no existing ref that is packed
2212 * whose name begins with our refname, nor a ref whose
2213 * name is a proper prefix of our refname.
2216 !is_refname_available(refname
, skip
, get_packed_refs(&ref_cache
))) {
2217 last_errno
= ENOTDIR
;
2221 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2224 if (flags
& REF_NODEREF
) {
2225 refname
= orig_refname
;
2226 lflags
|= LOCK_NO_DEREF
;
2228 lock
->ref_name
= xstrdup(refname
);
2229 lock
->orig_ref_name
= xstrdup(orig_refname
);
2230 ref_file
= git_path("%s", refname
);
2232 lock
->force_write
= 1;
2233 if ((flags
& REF_NODEREF
) && (type
& REF_ISSYMREF
))
2234 lock
->force_write
= 1;
2237 switch (safe_create_leading_directories(ref_file
)) {
2239 break; /* success */
2241 if (--attempts_remaining
> 0)
2246 error("unable to create directory for %s", ref_file
);
2250 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
2251 if (lock
->lock_fd
< 0) {
2252 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2254 * Maybe somebody just deleted one of the
2255 * directories leading to ref_file. Try
2260 unable_to_lock_die(ref_file
, errno
);
2262 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
2270 struct ref_lock
*lock_any_ref_for_update(const char *refname
,
2271 const unsigned char *old_sha1
,
2272 int flags
, int *type_p
)
2274 return lock_ref_sha1_basic(refname
, old_sha1
, NULL
, flags
, type_p
);
2278 * Write an entry to the packed-refs file for the specified refname.
2279 * If peeled is non-NULL, write it as the entry's peeled value.
2281 static void write_packed_entry(FILE *fh
, char *refname
, unsigned char *sha1
,
2282 unsigned char *peeled
)
2284 fprintf_or_die(fh
, "%s %s\n", sha1_to_hex(sha1
), refname
);
2286 fprintf_or_die(fh
, "^%s\n", sha1_to_hex(peeled
));
2290 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2292 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2294 enum peel_status peel_status
= peel_entry(entry
, 0);
2296 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2297 error("internal error: %s is not a valid packed reference!",
2299 write_packed_entry(cb_data
, entry
->name
, entry
->u
.value
.sha1
,
2300 peel_status
== PEEL_PEELED
?
2301 entry
->u
.value
.peeled
: NULL
);
2305 /* This should return a meaningful errno on failure */
2306 int lock_packed_refs(int flags
)
2308 struct packed_ref_cache
*packed_ref_cache
;
2310 if (hold_lock_file_for_update(&packlock
, git_path("packed-refs"), flags
) < 0)
2313 * Get the current packed-refs while holding the lock. If the
2314 * packed-refs file has been modified since we last read it,
2315 * this will automatically invalidate the cache and re-read
2316 * the packed-refs file.
2318 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2319 packed_ref_cache
->lock
= &packlock
;
2320 /* Increment the reference count to prevent it from being freed: */
2321 acquire_packed_ref_cache(packed_ref_cache
);
2326 * Commit the packed refs changes.
2327 * On error we must make sure that errno contains a meaningful value.
2329 int commit_packed_refs(void)
2331 struct packed_ref_cache
*packed_ref_cache
=
2332 get_packed_ref_cache(&ref_cache
);
2337 if (!packed_ref_cache
->lock
)
2338 die("internal error: packed-refs not locked");
2340 out
= fdopen_lock_file(packed_ref_cache
->lock
, "w");
2342 die_errno("unable to fdopen packed-refs descriptor");
2344 fprintf_or_die(out
, "%s", PACKED_REFS_HEADER
);
2345 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2346 0, write_packed_entry_fn
, out
);
2348 if (commit_lock_file(packed_ref_cache
->lock
)) {
2352 packed_ref_cache
->lock
= NULL
;
2353 release_packed_ref_cache(packed_ref_cache
);
2358 void rollback_packed_refs(void)
2360 struct packed_ref_cache
*packed_ref_cache
=
2361 get_packed_ref_cache(&ref_cache
);
2363 if (!packed_ref_cache
->lock
)
2364 die("internal error: packed-refs not locked");
2365 rollback_lock_file(packed_ref_cache
->lock
);
2366 packed_ref_cache
->lock
= NULL
;
2367 release_packed_ref_cache(packed_ref_cache
);
2368 clear_packed_ref_cache(&ref_cache
);
2371 struct ref_to_prune
{
2372 struct ref_to_prune
*next
;
2373 unsigned char sha1
[20];
2374 char name
[FLEX_ARRAY
];
2377 struct pack_refs_cb_data
{
2379 struct ref_dir
*packed_refs
;
2380 struct ref_to_prune
*ref_to_prune
;
2384 * An each_ref_entry_fn that is run over loose references only. If
2385 * the loose reference can be packed, add an entry in the packed ref
2386 * cache. If the reference should be pruned, also add it to
2387 * ref_to_prune in the pack_refs_cb_data.
2389 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2391 struct pack_refs_cb_data
*cb
= cb_data
;
2392 enum peel_status peel_status
;
2393 struct ref_entry
*packed_entry
;
2394 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2396 /* ALWAYS pack tags */
2397 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2400 /* Do not pack symbolic or broken refs: */
2401 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2404 /* Add a packed ref cache entry equivalent to the loose entry. */
2405 peel_status
= peel_entry(entry
, 1);
2406 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2407 die("internal error peeling reference %s (%s)",
2408 entry
->name
, sha1_to_hex(entry
->u
.value
.sha1
));
2409 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2411 /* Overwrite existing packed entry with info from loose entry */
2412 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2413 hashcpy(packed_entry
->u
.value
.sha1
, entry
->u
.value
.sha1
);
2415 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.sha1
,
2416 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2417 add_ref(cb
->packed_refs
, packed_entry
);
2419 hashcpy(packed_entry
->u
.value
.peeled
, entry
->u
.value
.peeled
);
2421 /* Schedule the loose reference for pruning if requested. */
2422 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2423 int namelen
= strlen(entry
->name
) + 1;
2424 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2425 hashcpy(n
->sha1
, entry
->u
.value
.sha1
);
2426 strcpy(n
->name
, entry
->name
);
2427 n
->next
= cb
->ref_to_prune
;
2428 cb
->ref_to_prune
= n
;
2434 * Remove empty parents, but spare refs/ and immediate subdirs.
2435 * Note: munges *name.
2437 static void try_remove_empty_parents(char *name
)
2442 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2443 while (*p
&& *p
!= '/')
2445 /* tolerate duplicate slashes; see check_refname_format() */
2449 for (q
= p
; *q
; q
++)
2452 while (q
> p
&& *q
!= '/')
2454 while (q
> p
&& *(q
-1) == '/')
2459 if (rmdir(git_path("%s", name
)))
2464 /* make sure nobody touched the ref, and unlink */
2465 static void prune_ref(struct ref_to_prune
*r
)
2467 struct ref_transaction
*transaction
;
2468 struct strbuf err
= STRBUF_INIT
;
2470 if (check_refname_format(r
->name
, 0))
2473 transaction
= ref_transaction_begin(&err
);
2475 ref_transaction_delete(transaction
, r
->name
, r
->sha1
,
2476 REF_ISPRUNING
, 1, NULL
, &err
) ||
2477 ref_transaction_commit(transaction
, &err
)) {
2478 ref_transaction_free(transaction
);
2479 error("%s", err
.buf
);
2480 strbuf_release(&err
);
2483 ref_transaction_free(transaction
);
2484 strbuf_release(&err
);
2485 try_remove_empty_parents(r
->name
);
2488 static void prune_refs(struct ref_to_prune
*r
)
2496 int pack_refs(unsigned int flags
)
2498 struct pack_refs_cb_data cbdata
;
2500 memset(&cbdata
, 0, sizeof(cbdata
));
2501 cbdata
.flags
= flags
;
2503 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2504 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2506 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2507 pack_if_possible_fn
, &cbdata
);
2509 if (commit_packed_refs())
2510 die_errno("unable to overwrite old ref-pack file");
2512 prune_refs(cbdata
.ref_to_prune
);
2517 * If entry is no longer needed in packed-refs, add it to the string
2518 * list pointed to by cb_data. Reasons for deleting entries:
2520 * - Entry is broken.
2521 * - Entry is overridden by a loose ref.
2522 * - Entry does not point at a valid object.
2524 * In the first and third cases, also emit an error message because these
2525 * are indications of repository corruption.
2527 static int curate_packed_ref_fn(struct ref_entry
*entry
, void *cb_data
)
2529 struct string_list
*refs_to_delete
= cb_data
;
2531 if (entry
->flag
& REF_ISBROKEN
) {
2532 /* This shouldn't happen to packed refs. */
2533 error("%s is broken!", entry
->name
);
2534 string_list_append(refs_to_delete
, entry
->name
);
2537 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
2538 unsigned char sha1
[20];
2541 if (read_ref_full(entry
->name
, 0, sha1
, &flags
))
2542 /* We should at least have found the packed ref. */
2543 die("Internal error");
2544 if ((flags
& REF_ISSYMREF
) || !(flags
& REF_ISPACKED
)) {
2546 * This packed reference is overridden by a
2547 * loose reference, so it is OK that its value
2548 * is no longer valid; for example, it might
2549 * refer to an object that has been garbage
2550 * collected. For this purpose we don't even
2551 * care whether the loose reference itself is
2552 * invalid, broken, symbolic, etc. Silently
2553 * remove the packed reference.
2555 string_list_append(refs_to_delete
, entry
->name
);
2559 * There is no overriding loose reference, so the fact
2560 * that this reference doesn't refer to a valid object
2561 * indicates some kind of repository corruption.
2562 * Report the problem, then omit the reference from
2565 error("%s does not point to a valid object!", entry
->name
);
2566 string_list_append(refs_to_delete
, entry
->name
);
2573 int repack_without_refs(const char **refnames
, int n
, struct strbuf
*err
)
2575 struct ref_dir
*packed
;
2576 struct string_list refs_to_delete
= STRING_LIST_INIT_DUP
;
2577 struct string_list_item
*ref_to_delete
;
2578 int i
, ret
, removed
= 0;
2580 /* Look for a packed ref */
2581 for (i
= 0; i
< n
; i
++)
2582 if (get_packed_ref(refnames
[i
]))
2585 /* Avoid locking if we have nothing to do */
2587 return 0; /* no refname exists in packed refs */
2589 if (lock_packed_refs(0)) {
2591 unable_to_lock_message(git_path("packed-refs"), errno
,
2595 unable_to_lock_error(git_path("packed-refs"), errno
);
2596 return error("cannot delete '%s' from packed refs", refnames
[i
]);
2598 packed
= get_packed_refs(&ref_cache
);
2600 /* Remove refnames from the cache */
2601 for (i
= 0; i
< n
; i
++)
2602 if (remove_entry(packed
, refnames
[i
]) != -1)
2606 * All packed entries disappeared while we were
2607 * acquiring the lock.
2609 rollback_packed_refs();
2613 /* Remove any other accumulated cruft */
2614 do_for_each_entry_in_dir(packed
, 0, curate_packed_ref_fn
, &refs_to_delete
);
2615 for_each_string_list_item(ref_to_delete
, &refs_to_delete
) {
2616 if (remove_entry(packed
, ref_to_delete
->string
) == -1)
2617 die("internal error");
2620 /* Write what remains */
2621 ret
= commit_packed_refs();
2623 strbuf_addf(err
, "unable to overwrite old ref-pack file: %s",
2628 static int delete_ref_loose(struct ref_lock
*lock
, int flag
, struct strbuf
*err
)
2630 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2632 * loose. The loose file name is the same as the
2633 * lockfile name, minus ".lock":
2635 char *loose_filename
= get_locked_file_path(lock
->lk
);
2636 int res
= unlink_or_msg(loose_filename
, err
);
2637 free(loose_filename
);
2644 int delete_ref(const char *refname
, const unsigned char *sha1
, int delopt
)
2646 struct ref_transaction
*transaction
;
2647 struct strbuf err
= STRBUF_INIT
;
2649 transaction
= ref_transaction_begin(&err
);
2651 ref_transaction_delete(transaction
, refname
, sha1
, delopt
,
2652 sha1
&& !is_null_sha1(sha1
), NULL
, &err
) ||
2653 ref_transaction_commit(transaction
, &err
)) {
2654 error("%s", err
.buf
);
2655 ref_transaction_free(transaction
);
2656 strbuf_release(&err
);
2659 ref_transaction_free(transaction
);
2660 strbuf_release(&err
);
2665 * People using contrib's git-new-workdir have .git/logs/refs ->
2666 * /some/other/path/.git/logs/refs, and that may live on another device.
2668 * IOW, to avoid cross device rename errors, the temporary renamed log must
2669 * live into logs/refs.
2671 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2673 static int rename_tmp_log(const char *newrefname
)
2675 int attempts_remaining
= 4;
2678 switch (safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
2680 break; /* success */
2682 if (--attempts_remaining
> 0)
2686 error("unable to create directory for %s", newrefname
);
2690 if (rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2691 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2693 * rename(a, b) when b is an existing
2694 * directory ought to result in ISDIR, but
2695 * Solaris 5.8 gives ENOTDIR. Sheesh.
2697 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2698 error("Directory not empty: logs/%s", newrefname
);
2702 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2704 * Maybe another process just deleted one of
2705 * the directories in the path to newrefname.
2706 * Try again from the beginning.
2710 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2711 newrefname
, strerror(errno
));
2718 static int rename_ref_available(const char *oldname
, const char *newname
)
2720 struct string_list skip
= STRING_LIST_INIT_NODUP
;
2723 string_list_insert(&skip
, oldname
);
2724 ret
= is_refname_available(newname
, &skip
, get_packed_refs(&ref_cache
))
2725 && is_refname_available(newname
, &skip
, get_loose_refs(&ref_cache
));
2726 string_list_clear(&skip
, 0);
2730 static int write_ref_sha1(struct ref_lock
*lock
, const unsigned char *sha1
,
2731 const char *logmsg
);
2733 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2735 unsigned char sha1
[20], orig_sha1
[20];
2736 int flag
= 0, logmoved
= 0;
2737 struct ref_lock
*lock
;
2738 struct stat loginfo
;
2739 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2740 const char *symref
= NULL
;
2742 if (log
&& S_ISLNK(loginfo
.st_mode
))
2743 return error("reflog for %s is a symlink", oldrefname
);
2745 symref
= resolve_ref_unsafe(oldrefname
, RESOLVE_REF_READING
,
2747 if (flag
& REF_ISSYMREF
)
2748 return error("refname %s is a symbolic ref, renaming it is not supported",
2751 return error("refname %s not found", oldrefname
);
2753 if (!rename_ref_available(oldrefname
, newrefname
))
2756 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2757 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2758 oldrefname
, strerror(errno
));
2760 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2761 error("unable to delete old %s", oldrefname
);
2765 if (!read_ref_full(newrefname
, RESOLVE_REF_READING
, sha1
, NULL
) &&
2766 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2767 if (errno
==EISDIR
) {
2768 if (remove_empty_directories(git_path("%s", newrefname
))) {
2769 error("Directory not empty: %s", newrefname
);
2773 error("unable to delete existing %s", newrefname
);
2778 if (log
&& rename_tmp_log(newrefname
))
2783 lock
= lock_ref_sha1_basic(newrefname
, NULL
, NULL
, 0, NULL
);
2785 error("unable to lock %s for update", newrefname
);
2788 lock
->force_write
= 1;
2789 hashcpy(lock
->old_sha1
, orig_sha1
);
2790 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
2791 error("unable to write current sha1 into %s", newrefname
);
2798 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, NULL
, 0, NULL
);
2800 error("unable to lock %s for rollback", oldrefname
);
2804 lock
->force_write
= 1;
2805 flag
= log_all_ref_updates
;
2806 log_all_ref_updates
= 0;
2807 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
2808 error("unable to write current sha1 into %s", oldrefname
);
2809 log_all_ref_updates
= flag
;
2812 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
2813 error("unable to restore logfile %s from %s: %s",
2814 oldrefname
, newrefname
, strerror(errno
));
2815 if (!logmoved
&& log
&&
2816 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
2817 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
2818 oldrefname
, strerror(errno
));
2823 int close_ref(struct ref_lock
*lock
)
2825 if (close_lock_file(lock
->lk
))
2831 int commit_ref(struct ref_lock
*lock
)
2833 if (commit_lock_file(lock
->lk
))
2839 void unlock_ref(struct ref_lock
*lock
)
2841 /* Do not free lock->lk -- atexit() still looks at them */
2843 rollback_lock_file(lock
->lk
);
2844 free(lock
->ref_name
);
2845 free(lock
->orig_ref_name
);
2850 * copy the reflog message msg to buf, which has been allocated sufficiently
2851 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2852 * because reflog file is one line per entry.
2854 static int copy_msg(char *buf
, const char *msg
)
2861 while ((c
= *msg
++)) {
2862 if (wasspace
&& isspace(c
))
2864 wasspace
= isspace(c
);
2869 while (buf
< cp
&& isspace(cp
[-1]))
2875 /* This function must set a meaningful errno on failure */
2876 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
2878 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
2880 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
2881 if (log_all_ref_updates
&&
2882 (starts_with(refname
, "refs/heads/") ||
2883 starts_with(refname
, "refs/remotes/") ||
2884 starts_with(refname
, "refs/notes/") ||
2885 !strcmp(refname
, "HEAD"))) {
2886 if (safe_create_leading_directories(logfile
) < 0) {
2887 int save_errno
= errno
;
2888 error("unable to create directory for %s", logfile
);
2895 logfd
= open(logfile
, oflags
, 0666);
2897 if (!(oflags
& O_CREAT
) && errno
== ENOENT
)
2900 if ((oflags
& O_CREAT
) && errno
== EISDIR
) {
2901 if (remove_empty_directories(logfile
)) {
2902 int save_errno
= errno
;
2903 error("There are still logs under '%s'",
2908 logfd
= open(logfile
, oflags
, 0666);
2912 int save_errno
= errno
;
2913 error("Unable to append to %s: %s", logfile
,
2920 adjust_shared_perm(logfile
);
2925 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
2926 const unsigned char *new_sha1
, const char *msg
)
2928 int logfd
, result
, written
, oflags
= O_APPEND
| O_WRONLY
;
2929 unsigned maxlen
, len
;
2931 char log_file
[PATH_MAX
];
2933 const char *committer
;
2935 if (log_all_ref_updates
< 0)
2936 log_all_ref_updates
= !is_bare_repository();
2938 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
2942 logfd
= open(log_file
, oflags
);
2945 msglen
= msg
? strlen(msg
) : 0;
2946 committer
= git_committer_info(0);
2947 maxlen
= strlen(committer
) + msglen
+ 100;
2948 logrec
= xmalloc(maxlen
);
2949 len
= sprintf(logrec
, "%s %s %s\n",
2950 sha1_to_hex(old_sha1
),
2951 sha1_to_hex(new_sha1
),
2954 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
2955 written
= len
<= maxlen
? write_in_full(logfd
, logrec
, len
) : -1;
2957 if (written
!= len
) {
2958 int save_errno
= errno
;
2960 error("Unable to append to %s", log_file
);
2965 int save_errno
= errno
;
2966 error("Unable to append to %s", log_file
);
2973 int is_branch(const char *refname
)
2975 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
2979 * Write sha1 into the ref specified by the lock. Make sure that errno
2982 static int write_ref_sha1(struct ref_lock
*lock
,
2983 const unsigned char *sha1
, const char *logmsg
)
2985 static char term
= '\n';
2992 if (!lock
->force_write
&& !hashcmp(lock
->old_sha1
, sha1
)) {
2996 o
= parse_object(sha1
);
2998 error("Trying to write ref %s with nonexistent object %s",
2999 lock
->ref_name
, sha1_to_hex(sha1
));
3004 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3005 error("Trying to write non-commit object %s to branch %s",
3006 sha1_to_hex(sha1
), lock
->ref_name
);
3011 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
3012 write_in_full(lock
->lock_fd
, &term
, 1) != 1 ||
3013 close_ref(lock
) < 0) {
3014 int save_errno
= errno
;
3015 error("Couldn't write %s", lock
->lk
->filename
.buf
);
3020 clear_loose_ref_cache(&ref_cache
);
3021 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
3022 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3023 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
3027 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3029 * Special hack: If a branch is updated directly and HEAD
3030 * points to it (may happen on the remote side of a push
3031 * for example) then logically the HEAD reflog should be
3033 * A generic solution implies reverse symref information,
3034 * but finding all symrefs pointing to the given branch
3035 * would be rather costly for this rare event (the direct
3036 * update of a branch) to be worth it. So let's cheat and
3037 * check with HEAD only which should cover 99% of all usage
3038 * scenarios (even 100% of the default ones).
3040 unsigned char head_sha1
[20];
3042 const char *head_ref
;
3043 head_ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
3044 head_sha1
, &head_flag
);
3045 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3046 !strcmp(head_ref
, lock
->ref_name
))
3047 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
3049 if (commit_ref(lock
)) {
3050 error("Couldn't set %s", lock
->ref_name
);
3058 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3061 const char *lockpath
;
3063 int fd
, len
, written
;
3064 char *git_HEAD
= git_pathdup("%s", ref_target
);
3065 unsigned char old_sha1
[20], new_sha1
[20];
3067 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3070 if (safe_create_leading_directories(git_HEAD
) < 0)
3071 return error("unable to create directory for %s", git_HEAD
);
3073 #ifndef NO_SYMLINK_HEAD
3074 if (prefer_symlink_refs
) {
3076 if (!symlink(refs_heads_master
, git_HEAD
))
3078 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3082 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3083 if (sizeof(ref
) <= len
) {
3084 error("refname too long: %s", refs_heads_master
);
3085 goto error_free_return
;
3087 lockpath
= mkpath("%s.lock", git_HEAD
);
3088 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3090 error("Unable to open %s for writing", lockpath
);
3091 goto error_free_return
;
3093 written
= write_in_full(fd
, ref
, len
);
3094 if (close(fd
) != 0 || written
!= len
) {
3095 error("Unable to write to %s", lockpath
);
3096 goto error_unlink_return
;
3098 if (rename(lockpath
, git_HEAD
) < 0) {
3099 error("Unable to create %s", git_HEAD
);
3100 goto error_unlink_return
;
3102 if (adjust_shared_perm(git_HEAD
)) {
3103 error("Unable to fix permissions on %s", lockpath
);
3104 error_unlink_return
:
3105 unlink_or_warn(lockpath
);
3111 #ifndef NO_SYMLINK_HEAD
3114 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
3115 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
3121 struct read_ref_at_cb
{
3122 const char *refname
;
3123 unsigned long at_time
;
3126 unsigned char *sha1
;
3129 unsigned char osha1
[20];
3130 unsigned char nsha1
[20];
3134 unsigned long *cutoff_time
;
3139 static int read_ref_at_ent(unsigned char *osha1
, unsigned char *nsha1
,
3140 const char *email
, unsigned long timestamp
, int tz
,
3141 const char *message
, void *cb_data
)
3143 struct read_ref_at_cb
*cb
= cb_data
;
3147 cb
->date
= timestamp
;
3149 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
3151 *cb
->msg
= xstrdup(message
);
3152 if (cb
->cutoff_time
)
3153 *cb
->cutoff_time
= timestamp
;
3155 *cb
->cutoff_tz
= tz
;
3157 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
3159 * we have not yet updated cb->[n|o]sha1 so they still
3160 * hold the values for the previous record.
3162 if (!is_null_sha1(cb
->osha1
)) {
3163 hashcpy(cb
->sha1
, nsha1
);
3164 if (hashcmp(cb
->osha1
, nsha1
))
3165 warning("Log for ref %s has gap after %s.",
3166 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_RFC2822
));
3168 else if (cb
->date
== cb
->at_time
)
3169 hashcpy(cb
->sha1
, nsha1
);
3170 else if (hashcmp(nsha1
, cb
->sha1
))
3171 warning("Log for ref %s unexpectedly ended on %s.",
3172 cb
->refname
, show_date(cb
->date
, cb
->tz
,
3174 hashcpy(cb
->osha1
, osha1
);
3175 hashcpy(cb
->nsha1
, nsha1
);
3179 hashcpy(cb
->osha1
, osha1
);
3180 hashcpy(cb
->nsha1
, nsha1
);
3186 static int read_ref_at_ent_oldest(unsigned char *osha1
, unsigned char *nsha1
,
3187 const char *email
, unsigned long timestamp
,
3188 int tz
, const char *message
, void *cb_data
)
3190 struct read_ref_at_cb
*cb
= cb_data
;
3193 *cb
->msg
= xstrdup(message
);
3194 if (cb
->cutoff_time
)
3195 *cb
->cutoff_time
= timestamp
;
3197 *cb
->cutoff_tz
= tz
;
3199 *cb
->cutoff_cnt
= cb
->reccnt
;
3200 hashcpy(cb
->sha1
, osha1
);
3201 if (is_null_sha1(cb
->sha1
))
3202 hashcpy(cb
->sha1
, nsha1
);
3203 /* We just want the first entry */
3207 int read_ref_at(const char *refname
, unsigned int flags
, unsigned long at_time
, int cnt
,
3208 unsigned char *sha1
, char **msg
,
3209 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3211 struct read_ref_at_cb cb
;
3213 memset(&cb
, 0, sizeof(cb
));
3214 cb
.refname
= refname
;
3215 cb
.at_time
= at_time
;
3218 cb
.cutoff_time
= cutoff_time
;
3219 cb
.cutoff_tz
= cutoff_tz
;
3220 cb
.cutoff_cnt
= cutoff_cnt
;
3223 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
3226 if (flags
& GET_SHA1_QUIETLY
)
3229 die("Log for %s is empty.", refname
);
3234 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
3239 int reflog_exists(const char *refname
)
3243 return !lstat(git_path("logs/%s", refname
), &st
) &&
3244 S_ISREG(st
.st_mode
);
3247 int delete_reflog(const char *refname
)
3249 return remove_path(git_path("logs/%s", refname
));
3252 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3254 unsigned char osha1
[20], nsha1
[20];
3255 char *email_end
, *message
;
3256 unsigned long timestamp
;
3259 /* old SP new SP name <email> SP time TAB msg LF */
3260 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3261 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3262 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3263 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3264 email_end
[1] != ' ' ||
3265 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3266 !message
|| message
[0] != ' ' ||
3267 (message
[1] != '+' && message
[1] != '-') ||
3268 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3269 !isdigit(message
[4]) || !isdigit(message
[5]))
3270 return 0; /* corrupt? */
3271 email_end
[1] = '\0';
3272 tz
= strtol(message
+ 1, NULL
, 10);
3273 if (message
[6] != '\t')
3277 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3280 static char *find_beginning_of_line(char *bob
, char *scan
)
3282 while (bob
< scan
&& *(--scan
) != '\n')
3283 ; /* keep scanning backwards */
3285 * Return either beginning of the buffer, or LF at the end of
3286 * the previous line.
3291 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3293 struct strbuf sb
= STRBUF_INIT
;
3296 int ret
= 0, at_tail
= 1;
3298 logfp
= fopen(git_path("logs/%s", refname
), "r");
3302 /* Jump to the end */
3303 if (fseek(logfp
, 0, SEEK_END
) < 0)
3304 return error("cannot seek back reflog for %s: %s",
3305 refname
, strerror(errno
));
3307 while (!ret
&& 0 < pos
) {
3313 /* Fill next block from the end */
3314 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3315 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3316 return error("cannot seek back reflog for %s: %s",
3317 refname
, strerror(errno
));
3318 nread
= fread(buf
, cnt
, 1, logfp
);
3320 return error("cannot read %d bytes from reflog for %s: %s",
3321 cnt
, refname
, strerror(errno
));
3324 scanp
= endp
= buf
+ cnt
;
3325 if (at_tail
&& scanp
[-1] == '\n')
3326 /* Looking at the final LF at the end of the file */
3330 while (buf
< scanp
) {
3332 * terminating LF of the previous line, or the beginning
3337 bp
= find_beginning_of_line(buf
, scanp
);
3340 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3342 break; /* need to fill another block */
3343 scanp
= buf
- 1; /* leave loop */
3346 * (bp + 1) thru endp is the beginning of the
3347 * current line we have in sb
3349 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3353 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3361 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3364 strbuf_release(&sb
);
3368 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3371 struct strbuf sb
= STRBUF_INIT
;
3374 logfp
= fopen(git_path("logs/%s", refname
), "r");
3378 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3379 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3381 strbuf_release(&sb
);
3385 * Call fn for each reflog in the namespace indicated by name. name
3386 * must be empty or end with '/'. Name will be used as a scratch
3387 * space, but its contents will be restored before return.
3389 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3391 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3394 int oldlen
= name
->len
;
3397 return name
->len
? errno
: 0;
3399 while ((de
= readdir(d
)) != NULL
) {
3402 if (de
->d_name
[0] == '.')
3404 if (ends_with(de
->d_name
, ".lock"))
3406 strbuf_addstr(name
, de
->d_name
);
3407 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3408 ; /* silently ignore */
3410 if (S_ISDIR(st
.st_mode
)) {
3411 strbuf_addch(name
, '/');
3412 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3414 unsigned char sha1
[20];
3415 if (read_ref_full(name
->buf
, 0, sha1
, NULL
))
3416 retval
= error("bad ref for %s", name
->buf
);
3418 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
3423 strbuf_setlen(name
, oldlen
);
3429 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3433 strbuf_init(&name
, PATH_MAX
);
3434 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3435 strbuf_release(&name
);
3440 * Information needed for a single ref update. Set new_sha1 to the
3441 * new value or to zero to delete the ref. To check the old value
3442 * while locking the ref, set have_old to 1 and set old_sha1 to the
3443 * value or to zero to ensure the ref does not exist before update.
3446 unsigned char new_sha1
[20];
3447 unsigned char old_sha1
[20];
3448 int flags
; /* REF_NODEREF? */
3449 int have_old
; /* 1 if old_sha1 is valid, 0 otherwise */
3450 struct ref_lock
*lock
;
3453 const char refname
[FLEX_ARRAY
];
3457 * Transaction states.
3458 * OPEN: The transaction is in a valid state and can accept new updates.
3459 * An OPEN transaction can be committed.
3460 * CLOSED: A closed transaction is no longer active and no other operations
3461 * than free can be used on it in this state.
3462 * A transaction can either become closed by successfully committing
3463 * an active transaction or if there is a failure while building
3464 * the transaction thus rendering it failed/inactive.
3466 enum ref_transaction_state
{
3467 REF_TRANSACTION_OPEN
= 0,
3468 REF_TRANSACTION_CLOSED
= 1
3472 * Data structure for holding a reference transaction, which can
3473 * consist of checks and updates to multiple references, carried out
3474 * as atomically as possible. This structure is opaque to callers.
3476 struct ref_transaction
{
3477 struct ref_update
**updates
;
3480 enum ref_transaction_state state
;
3483 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
3485 return xcalloc(1, sizeof(struct ref_transaction
));
3488 void ref_transaction_free(struct ref_transaction
*transaction
)
3495 for (i
= 0; i
< transaction
->nr
; i
++) {
3496 free(transaction
->updates
[i
]->msg
);
3497 free(transaction
->updates
[i
]);
3499 free(transaction
->updates
);
3503 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3504 const char *refname
)
3506 size_t len
= strlen(refname
);
3507 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3509 strcpy((char *)update
->refname
, refname
);
3510 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3511 transaction
->updates
[transaction
->nr
++] = update
;
3515 int ref_transaction_update(struct ref_transaction
*transaction
,
3516 const char *refname
,
3517 const unsigned char *new_sha1
,
3518 const unsigned char *old_sha1
,
3519 int flags
, int have_old
, const char *msg
,
3522 struct ref_update
*update
;
3524 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3525 die("BUG: update called for transaction that is not open");
3527 if (have_old
&& !old_sha1
)
3528 die("BUG: have_old is true but old_sha1 is NULL");
3530 update
= add_update(transaction
, refname
);
3531 hashcpy(update
->new_sha1
, new_sha1
);
3532 update
->flags
= flags
;
3533 update
->have_old
= have_old
;
3535 hashcpy(update
->old_sha1
, old_sha1
);
3537 update
->msg
= xstrdup(msg
);
3541 int ref_transaction_create(struct ref_transaction
*transaction
,
3542 const char *refname
,
3543 const unsigned char *new_sha1
,
3544 int flags
, const char *msg
,
3547 struct ref_update
*update
;
3549 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3550 die("BUG: create called for transaction that is not open");
3552 if (!new_sha1
|| is_null_sha1(new_sha1
))
3553 die("BUG: create ref with null new_sha1");
3555 update
= add_update(transaction
, refname
);
3557 hashcpy(update
->new_sha1
, new_sha1
);
3558 hashclr(update
->old_sha1
);
3559 update
->flags
= flags
;
3560 update
->have_old
= 1;
3562 update
->msg
= xstrdup(msg
);
3566 int ref_transaction_delete(struct ref_transaction
*transaction
,
3567 const char *refname
,
3568 const unsigned char *old_sha1
,
3569 int flags
, int have_old
, const char *msg
,
3572 struct ref_update
*update
;
3574 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3575 die("BUG: delete called for transaction that is not open");
3577 if (have_old
&& !old_sha1
)
3578 die("BUG: have_old is true but old_sha1 is NULL");
3580 update
= add_update(transaction
, refname
);
3581 update
->flags
= flags
;
3582 update
->have_old
= have_old
;
3584 assert(!is_null_sha1(old_sha1
));
3585 hashcpy(update
->old_sha1
, old_sha1
);
3588 update
->msg
= xstrdup(msg
);
3592 int update_ref(const char *action
, const char *refname
,
3593 const unsigned char *sha1
, const unsigned char *oldval
,
3594 int flags
, enum action_on_err onerr
)
3596 struct ref_transaction
*t
;
3597 struct strbuf err
= STRBUF_INIT
;
3599 t
= ref_transaction_begin(&err
);
3601 ref_transaction_update(t
, refname
, sha1
, oldval
, flags
,
3602 !!oldval
, action
, &err
) ||
3603 ref_transaction_commit(t
, &err
)) {
3604 const char *str
= "update_ref failed for ref '%s': %s";
3606 ref_transaction_free(t
);
3608 case UPDATE_REFS_MSG_ON_ERR
:
3609 error(str
, refname
, err
.buf
);
3611 case UPDATE_REFS_DIE_ON_ERR
:
3612 die(str
, refname
, err
.buf
);
3614 case UPDATE_REFS_QUIET_ON_ERR
:
3617 strbuf_release(&err
);
3620 strbuf_release(&err
);
3621 ref_transaction_free(t
);
3625 static int ref_update_compare(const void *r1
, const void *r2
)
3627 const struct ref_update
* const *u1
= r1
;
3628 const struct ref_update
* const *u2
= r2
;
3629 return strcmp((*u1
)->refname
, (*u2
)->refname
);
3632 static int ref_update_reject_duplicates(struct ref_update
**updates
, int n
,
3636 for (i
= 1; i
< n
; i
++)
3637 if (!strcmp(updates
[i
- 1]->refname
, updates
[i
]->refname
)) {
3639 "Multiple updates for ref '%s' not allowed.";
3641 strbuf_addf(err
, str
, updates
[i
]->refname
);
3648 int ref_transaction_commit(struct ref_transaction
*transaction
,
3651 int ret
= 0, delnum
= 0, i
;
3652 const char **delnames
;
3653 int n
= transaction
->nr
;
3654 struct ref_update
**updates
= transaction
->updates
;
3656 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
3657 die("BUG: commit called for transaction that is not open");
3660 transaction
->state
= REF_TRANSACTION_CLOSED
;
3664 /* Allocate work space */
3665 delnames
= xmalloc(sizeof(*delnames
) * n
);
3667 /* Copy, sort, and reject duplicate refs */
3668 qsort(updates
, n
, sizeof(*updates
), ref_update_compare
);
3669 if (ref_update_reject_duplicates(updates
, n
, err
)) {
3670 ret
= TRANSACTION_GENERIC_ERROR
;
3674 /* Acquire all locks while verifying old values */
3675 for (i
= 0; i
< n
; i
++) {
3676 struct ref_update
*update
= updates
[i
];
3677 int flags
= update
->flags
;
3679 if (is_null_sha1(update
->new_sha1
))
3680 flags
|= REF_DELETING
;
3681 update
->lock
= lock_ref_sha1_basic(update
->refname
,
3688 if (!update
->lock
) {
3689 ret
= (errno
== ENOTDIR
)
3690 ? TRANSACTION_NAME_CONFLICT
3691 : TRANSACTION_GENERIC_ERROR
;
3693 strbuf_addf(err
, "Cannot lock the ref '%s'.",
3699 /* Perform updates first so live commits remain referenced */
3700 for (i
= 0; i
< n
; i
++) {
3701 struct ref_update
*update
= updates
[i
];
3703 if (!is_null_sha1(update
->new_sha1
)) {
3704 if (write_ref_sha1(update
->lock
, update
->new_sha1
,
3706 update
->lock
= NULL
; /* freed by write_ref_sha1 */
3708 strbuf_addf(err
, "Cannot update the ref '%s'.",
3710 ret
= TRANSACTION_GENERIC_ERROR
;
3713 update
->lock
= NULL
; /* freed by write_ref_sha1 */
3717 /* Perform deletes now that updates are safely completed */
3718 for (i
= 0; i
< n
; i
++) {
3719 struct ref_update
*update
= updates
[i
];
3722 if (delete_ref_loose(update
->lock
, update
->type
, err
))
3723 ret
= TRANSACTION_GENERIC_ERROR
;
3725 if (!(update
->flags
& REF_ISPRUNING
))
3726 delnames
[delnum
++] = update
->lock
->ref_name
;
3730 if (repack_without_refs(delnames
, delnum
, err
))
3731 ret
= TRANSACTION_GENERIC_ERROR
;
3732 for (i
= 0; i
< delnum
; i
++)
3733 unlink_or_warn(git_path("logs/%s", delnames
[i
]));
3734 clear_loose_ref_cache(&ref_cache
);
3737 transaction
->state
= REF_TRANSACTION_CLOSED
;
3739 for (i
= 0; i
< n
; i
++)
3740 if (updates
[i
]->lock
)
3741 unlock_ref(updates
[i
]->lock
);
3746 char *shorten_unambiguous_ref(const char *refname
, int strict
)
3749 static char **scanf_fmts
;
3750 static int nr_rules
;
3755 * Pre-generate scanf formats from ref_rev_parse_rules[].
3756 * Generate a format suitable for scanf from a
3757 * ref_rev_parse_rules rule by interpolating "%s" at the
3758 * location of the "%.*s".
3760 size_t total_len
= 0;
3763 /* the rule list is NULL terminated, count them first */
3764 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
3765 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3766 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
3768 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
3771 for (i
= 0; i
< nr_rules
; i
++) {
3772 assert(offset
< total_len
);
3773 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
3774 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
3775 ref_rev_parse_rules
[i
], 2, "%s") + 1;
3779 /* bail out if there are no rules */
3781 return xstrdup(refname
);
3783 /* buffer for scanf result, at most refname must fit */
3784 short_name
= xstrdup(refname
);
3786 /* skip first rule, it will always match */
3787 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
3789 int rules_to_fail
= i
;
3792 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
3795 short_name_len
= strlen(short_name
);
3798 * in strict mode, all (except the matched one) rules
3799 * must fail to resolve to a valid non-ambiguous ref
3802 rules_to_fail
= nr_rules
;
3805 * check if the short name resolves to a valid ref,
3806 * but use only rules prior to the matched one
3808 for (j
= 0; j
< rules_to_fail
; j
++) {
3809 const char *rule
= ref_rev_parse_rules
[j
];
3810 char refname
[PATH_MAX
];
3812 /* skip matched rule */
3817 * the short name is ambiguous, if it resolves
3818 * (with this previous rule) to a valid ref
3819 * read_ref() returns 0 on success
3821 mksnpath(refname
, sizeof(refname
),
3822 rule
, short_name_len
, short_name
);
3823 if (ref_exists(refname
))
3828 * short name is non-ambiguous if all previous rules
3829 * haven't resolved to a valid ref
3831 if (j
== rules_to_fail
)
3836 return xstrdup(refname
);
3839 static struct string_list
*hide_refs
;
3841 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
3843 if (!strcmp("transfer.hiderefs", var
) ||
3844 /* NEEDSWORK: use parse_config_key() once both are merged */
3845 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
3846 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
3851 return config_error_nonbool(var
);
3852 ref
= xstrdup(value
);
3854 while (len
&& ref
[len
- 1] == '/')
3857 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
3858 hide_refs
->strdup_strings
= 1;
3860 string_list_append(hide_refs
, ref
);
3865 int ref_is_hidden(const char *refname
)
3867 struct string_list_item
*item
;
3871 for_each_string_list_item(item
, hide_refs
) {
3873 if (!starts_with(refname
, item
->string
))
3875 len
= strlen(item
->string
);
3876 if (!refname
[len
] || refname
[len
] == '/')