6 #include "string-list.h"
9 * How to handle various characters in refnames:
10 * This table is used by both the SIMD and non-SIMD code. It has
11 * some cases that are only useful for the SIMD; these are handled
12 * equivalently to the listed disposition in the non-SIMD code.
13 * 0: An acceptable character for refs
14 * 1: @, look for a following { to reject @{ in refs (SIMD or = 0)
15 * 2: \0: End-of-component and string
16 * 3: /: End-of-component (SIMD or = 2)
17 * 4: ., look for a preceding . to reject .. in refs
18 * 5: {, look for a preceding @ to reject @{ in refs
19 * 6: *, usually a bad character except, once as a wildcard (SIMD or = 7)
20 * 7: A bad character except * (see check_refname_component below)
22 static unsigned char refname_disposition
[256] = {
23 2, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
24 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
25 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 4, 3,
26 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 7,
27 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
28 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 7, 0, 7, 0,
29 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
30 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 7, 7
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 has pattern-matching notation "*", "?", "[", anywhere, or
43 * - it ends with a "/", or
44 * - it ends with ".lock", or
45 * - it contains a "\" (backslash)
47 static int check_refname_component(const char *refname
, int flags
)
52 for (cp
= refname
; ; cp
++) {
54 unsigned char disp
= refname_disposition
[ch
];
56 case 2: /* fall-through */
61 return -1; /* Refname contains "..". */
65 return -1; /* Refname contains "@{". */
67 case 6: /* fall-through */
75 return 0; /* Component has zero length. */
76 if (refname
[0] == '.') {
77 if (!(flags
& REFNAME_DOT_COMPONENT
))
78 return -1; /* Component starts with '.'. */
80 * Even if leading dots are allowed, don't allow "."
81 * as a component (".." is prevented by a rule above).
83 if (refname
[1] == '\0')
84 return -1; /* Component equals ".". */
86 if (cp
- refname
>= 5 && !memcmp(cp
- 5, ".lock", 5))
87 return -1; /* Refname ends with ".lock". */
91 static int check_refname_format_bytewise(const char *refname
, int flags
)
93 int component_len
, component_count
= 0;
95 if (!strcmp(refname
, "@"))
96 /* Refname is a single character '@'. */
100 /* We are at the start of a path component. */
101 component_len
= check_refname_component(refname
, flags
);
102 if (component_len
<= 0) {
103 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
105 (refname
[1] == '\0' || refname
[1] == '/')) {
106 /* Accept one wildcard as a full refname component. */
107 flags
&= ~REFNAME_REFSPEC_PATTERN
;
114 if (refname
[component_len
] == '\0')
116 /* Skip to next component. */
117 refname
+= component_len
+ 1;
120 if (refname
[component_len
- 1] == '.')
121 return -1; /* Refname ends with '.'. */
122 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
123 return -1; /* Refname has only one component. */
127 #if defined(__GNUC__) && defined(__x86_64__)
128 #define SSE_VECTOR_BYTES 16
130 /* Vectorized version of check_refname_format. */
131 int check_refname_format(const char *refname
, int flags
)
133 const char *cp
= refname
;
135 const __m128i dot
= _mm_set1_epi8('.');
136 const __m128i at
= _mm_set1_epi8('@');
137 const __m128i curly
= _mm_set1_epi8('{');
138 const __m128i slash
= _mm_set1_epi8('/');
139 const __m128i zero
= _mm_set1_epi8('\000');
140 const __m128i el
= _mm_set1_epi8('l');
142 /* below '*', all characters are forbidden or rare */
143 const __m128i star_ub
= _mm_set1_epi8('*' + 1);
145 const __m128i colon
= _mm_set1_epi8(':');
146 const __m128i question
= _mm_set1_epi8('?');
148 /* '['..'^' contains 4 characters: 3 forbidden and 1 rare */
149 const __m128i bracket_lb
= _mm_set1_epi8('[' - 1);
150 const __m128i caret_ub
= _mm_set1_epi8('^' + 1);
152 /* '~' and above are forbidden */
153 const __m128i tilde_lb
= _mm_set1_epi8('~' - 1);
155 int component_count
= 0;
156 int orig_flags
= flags
;
158 if (refname
[0] == 0 || refname
[0] == '/') {
159 /* entirely empty ref or initial ref component */
164 * Initial ref component of '.'; below we look for /. so we'll
167 if (refname
[0] == '.') {
168 if (refname
[1] == '/' || refname
[1] == '\0')
170 if (!(flags
& REFNAME_DOT_COMPONENT
))
174 __m128i tmp
, tmp1
, result
;
177 if ((uintptr_t) cp
% PAGE_SIZE
> PAGE_SIZE
- SSE_VECTOR_BYTES
- 1)
179 * End-of-page; fall back to slow method for
182 return check_refname_format_bytewise(refname
, orig_flags
);
184 tmp
= _mm_loadu_si128((__m128i
*)cp
);
185 tmp1
= _mm_loadu_si128((__m128i
*)(cp
+ 1));
188 * This range (note the lt) contains some
189 * permissible-but-rare characters (including all
190 * characters >= 128), which we handle later. It also
193 result
= _mm_cmplt_epi8(tmp
, star_ub
);
195 result
= _mm_or_si128(result
, _mm_cmpeq_epi8(tmp
, question
));
196 result
= _mm_or_si128(result
, _mm_cmpeq_epi8(tmp
, colon
));
198 /* This range contains the permissible ] as bycatch */
199 result
= _mm_or_si128(result
, _mm_and_si128(
200 _mm_cmpgt_epi8(tmp
, bracket_lb
),
201 _mm_cmplt_epi8(tmp
, caret_ub
)));
203 result
= _mm_or_si128(result
, _mm_cmpgt_epi8(tmp
, tilde_lb
));
206 result
= _mm_or_si128(result
, _mm_and_si128(
207 _mm_cmpeq_epi8(tmp
, dot
),
208 _mm_cmpeq_epi8(tmp1
, dot
)));
210 result
= _mm_or_si128(result
, _mm_and_si128(
211 _mm_cmpeq_epi8(tmp
, at
),
212 _mm_cmpeq_epi8(tmp1
, curly
)));
214 result
= _mm_or_si128(result
, _mm_and_si128(
215 _mm_cmpeq_epi8(tmp
, slash
),
216 _mm_cmpeq_epi8(tmp1
, slash
)));
218 result
= _mm_or_si128(result
, _mm_and_si128(
219 _mm_cmpeq_epi8(tmp
, slash
),
220 _mm_cmpeq_epi8(tmp1
, zero
)));
221 /* .l, beginning of .lock */
222 result
= _mm_or_si128(result
, _mm_and_si128(
223 _mm_cmpeq_epi8(tmp
, dot
),
224 _mm_cmpeq_epi8(tmp1
, el
)));
226 * Even though /. is not necessarily an error, we flag
227 * it anyway. If we find it, we'll check if it's valid
228 * and if so we'll advance just past it.
230 result
= _mm_or_si128(result
, _mm_and_si128(
231 _mm_cmpeq_epi8(tmp
, slash
),
232 _mm_cmpeq_epi8(tmp1
, dot
)));
234 mask
= _mm_movemask_epi8(result
);
237 * We've found either end-of-string, or some
238 * probably-bad character or substring.
240 int i
= __builtin_ctz(mask
);
241 switch (refname_disposition
[cp
[i
] & 255]) {
242 case 0: /* fall-through */
245 * bycatch: a good character that's in
246 * one of the ranges of mostly-forbidden
252 if (cp
[i
+ 1] == '{')
257 if (!(flags
& REFNAME_ALLOW_ONELEVEL
)
258 && !component_count
&& !strchr(refname
, '/'))
259 /* Refname has only one component. */
265 * Even if leading dots are allowed, don't
266 * allow "." as a component (".." is
267 * prevented by case 4 below).
269 if (cp
[i
+ 1] == '.') {
270 if (cp
[i
+ 2] == '\0')
272 if (flags
& REFNAME_DOT_COMPONENT
) {
273 /* skip to just after the /. */
278 } else if (cp
[i
+ 1] == '/' || cp
[i
+ 1] == '\0')
282 if (cp
[i
+ 1] == '.' || cp
[i
+ 1] == '\0')
284 /* .lock as end-of-component or end-of-string */
285 if ((!strncmp(cp
+ i
, ".lock", 5))
286 && (cp
[i
+ 5] == '/' || cp
[i
+ 5] == 0))
291 if (((cp
== refname
+ i
) || cp
[i
- 1] == '/')
292 && (cp
[i
+ 1] == '/' || cp
[i
+ 1] == 0))
293 if (flags
& REFNAME_REFSPEC_PATTERN
) {
294 flags
&= ~REFNAME_REFSPEC_PATTERN
;
295 /* restart after the * */
304 cp
+= SSE_VECTOR_BYTES
;
310 int check_refname_format (const char *refname
, int flags
)
312 return check_refname_format_bytewise(refname
, flags
);
320 * Information used (along with the information in ref_entry) to
321 * describe a single cached reference. This data structure only
322 * occurs embedded in a union in struct ref_entry, and only when
323 * (ref_entry->flag & REF_DIR) is zero.
327 * The name of the object to which this reference resolves
328 * (which may be a tag object). If REF_ISBROKEN, this is
329 * null. If REF_ISSYMREF, then this is the name of the object
330 * referred to by the last reference in the symlink chain.
332 unsigned char sha1
[20];
335 * If REF_KNOWS_PEELED, then this field holds the peeled value
336 * of this reference, or null if the reference is known not to
337 * be peelable. See the documentation for peel_ref() for an
338 * exact definition of "peelable".
340 unsigned char peeled
[20];
346 * Information used (along with the information in ref_entry) to
347 * describe a level in the hierarchy of references. This data
348 * structure only occurs embedded in a union in struct ref_entry, and
349 * only when (ref_entry.flag & REF_DIR) is set. In that case,
350 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
351 * in the directory have already been read:
353 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
354 * or packed references, already read.
356 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
357 * references that hasn't been read yet (nor has any of its
360 * Entries within a directory are stored within a growable array of
361 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
362 * sorted are sorted by their component name in strcmp() order and the
363 * remaining entries are unsorted.
365 * Loose references are read lazily, one directory at a time. When a
366 * directory of loose references is read, then all of the references
367 * in that directory are stored, and REF_INCOMPLETE stubs are created
368 * for any subdirectories, but the subdirectories themselves are not
369 * read. The reading is triggered by get_ref_dir().
375 * Entries with index 0 <= i < sorted are sorted by name. New
376 * entries are appended to the list unsorted, and are sorted
377 * only when required; thus we avoid the need to sort the list
378 * after the addition of every reference.
382 /* A pointer to the ref_cache that contains this ref_dir. */
383 struct ref_cache
*ref_cache
;
385 struct ref_entry
**entries
;
389 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
390 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
395 * The field ref_entry->u.value.peeled of this value entry contains
396 * the correct peeled value for the reference, which might be
397 * null_sha1 if the reference is not a tag or if it is broken.
399 #define REF_KNOWS_PEELED 0x08
401 /* ref_entry represents a directory of references */
405 * Entry has not yet been read from disk (used only for REF_DIR
406 * entries representing loose references)
408 #define REF_INCOMPLETE 0x20
411 * A ref_entry represents either a reference or a "subdirectory" of
414 * Each directory in the reference namespace is represented by a
415 * ref_entry with (flags & REF_DIR) set and containing a subdir member
416 * that holds the entries in that directory that have been read so
417 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
418 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
419 * used for loose reference directories.
421 * References are represented by a ref_entry with (flags & REF_DIR)
422 * unset and a value member that describes the reference's value. The
423 * flag member is at the ref_entry level, but it is also needed to
424 * interpret the contents of the value field (in other words, a
425 * ref_value object is not very much use without the enclosing
428 * Reference names cannot end with slash and directories' names are
429 * always stored with a trailing slash (except for the top-level
430 * directory, which is always denoted by ""). This has two nice
431 * consequences: (1) when the entries in each subdir are sorted
432 * lexicographically by name (as they usually are), the references in
433 * a whole tree can be generated in lexicographic order by traversing
434 * the tree in left-to-right, depth-first order; (2) the names of
435 * references and subdirectories cannot conflict, and therefore the
436 * presence of an empty subdirectory does not block the creation of a
437 * similarly-named reference. (The fact that reference names with the
438 * same leading components can conflict *with each other* is a
439 * separate issue that is regulated by is_refname_available().)
441 * Please note that the name field contains the fully-qualified
442 * reference (or subdirectory) name. Space could be saved by only
443 * storing the relative names. But that would require the full names
444 * to be generated on the fly when iterating in do_for_each_ref(), and
445 * would break callback functions, who have always been able to assume
446 * that the name strings that they are passed will not be freed during
450 unsigned char flag
; /* ISSYMREF? ISPACKED? */
452 struct ref_value value
; /* if not (flags&REF_DIR) */
453 struct ref_dir subdir
; /* if (flags&REF_DIR) */
456 * The full name of the reference (e.g., "refs/heads/master")
457 * or the full name of the directory with a trailing slash
458 * (e.g., "refs/heads/"):
460 char name
[FLEX_ARRAY
];
463 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
465 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
468 assert(entry
->flag
& REF_DIR
);
469 dir
= &entry
->u
.subdir
;
470 if (entry
->flag
& REF_INCOMPLETE
) {
471 read_loose_refs(entry
->name
, dir
);
472 entry
->flag
&= ~REF_INCOMPLETE
;
477 static struct ref_entry
*create_ref_entry(const char *refname
,
478 const unsigned char *sha1
, int flag
,
482 struct ref_entry
*ref
;
485 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
|REFNAME_DOT_COMPONENT
))
486 die("Reference has invalid format: '%s'", refname
);
487 len
= strlen(refname
) + 1;
488 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
489 hashcpy(ref
->u
.value
.sha1
, sha1
);
490 hashclr(ref
->u
.value
.peeled
);
491 memcpy(ref
->name
, refname
, len
);
496 static void clear_ref_dir(struct ref_dir
*dir
);
498 static void free_ref_entry(struct ref_entry
*entry
)
500 if (entry
->flag
& REF_DIR
) {
502 * Do not use get_ref_dir() here, as that might
503 * trigger the reading of loose refs.
505 clear_ref_dir(&entry
->u
.subdir
);
511 * Add a ref_entry to the end of dir (unsorted). Entry is always
512 * stored directly in dir; no recursion into subdirectories is
515 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
517 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
518 dir
->entries
[dir
->nr
++] = entry
;
519 /* optimize for the case that entries are added in order */
521 (dir
->nr
== dir
->sorted
+ 1 &&
522 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
523 dir
->entries
[dir
->nr
- 1]->name
) < 0))
524 dir
->sorted
= dir
->nr
;
528 * Clear and free all entries in dir, recursively.
530 static void clear_ref_dir(struct ref_dir
*dir
)
533 for (i
= 0; i
< dir
->nr
; i
++)
534 free_ref_entry(dir
->entries
[i
]);
536 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
541 * Create a struct ref_entry object for the specified dirname.
542 * dirname is the name of the directory with a trailing slash (e.g.,
543 * "refs/heads/") or "" for the top-level directory.
545 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
546 const char *dirname
, size_t len
,
549 struct ref_entry
*direntry
;
550 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
551 memcpy(direntry
->name
, dirname
, len
);
552 direntry
->name
[len
] = '\0';
553 direntry
->u
.subdir
.ref_cache
= ref_cache
;
554 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
558 static int ref_entry_cmp(const void *a
, const void *b
)
560 struct ref_entry
*one
= *(struct ref_entry
**)a
;
561 struct ref_entry
*two
= *(struct ref_entry
**)b
;
562 return strcmp(one
->name
, two
->name
);
565 static void sort_ref_dir(struct ref_dir
*dir
);
567 struct string_slice
{
572 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
574 const struct string_slice
*key
= key_
;
575 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
576 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
579 return '\0' - (unsigned char)ent
->name
[key
->len
];
583 * Return the index of the entry with the given refname from the
584 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
585 * no such entry is found. dir must already be complete.
587 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
589 struct ref_entry
**r
;
590 struct string_slice key
;
592 if (refname
== NULL
|| !dir
->nr
)
598 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
599 ref_entry_cmp_sslice
);
604 return r
- dir
->entries
;
608 * Search for a directory entry directly within dir (without
609 * recursing). Sort dir if necessary. subdirname must be a directory
610 * name (i.e., end in '/'). If mkdir is set, then create the
611 * directory if it is missing; otherwise, return NULL if the desired
612 * directory cannot be found. dir must already be complete.
614 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
615 const char *subdirname
, size_t len
,
618 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
619 struct ref_entry
*entry
;
620 if (entry_index
== -1) {
624 * Since dir is complete, the absence of a subdir
625 * means that the subdir really doesn't exist;
626 * therefore, create an empty record for it but mark
627 * the record complete.
629 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
630 add_entry_to_dir(dir
, entry
);
632 entry
= dir
->entries
[entry_index
];
634 return get_ref_dir(entry
);
638 * If refname is a reference name, find the ref_dir within the dir
639 * tree that should hold refname. If refname is a directory name
640 * (i.e., ends in '/'), then return that ref_dir itself. dir must
641 * represent the top-level directory and must already be complete.
642 * Sort ref_dirs and recurse into subdirectories as necessary. If
643 * mkdir is set, then create any missing directories; otherwise,
644 * return NULL if the desired directory cannot be found.
646 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
647 const char *refname
, int mkdir
)
650 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
651 size_t dirnamelen
= slash
- refname
+ 1;
652 struct ref_dir
*subdir
;
653 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
665 * Find the value entry with the given name in dir, sorting ref_dirs
666 * and recursing into subdirectories as necessary. If the name is not
667 * found or it corresponds to a directory entry, return NULL.
669 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
672 struct ref_entry
*entry
;
673 dir
= find_containing_dir(dir
, refname
, 0);
676 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
677 if (entry_index
== -1)
679 entry
= dir
->entries
[entry_index
];
680 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
684 * Remove the entry with the given name from dir, recursing into
685 * subdirectories as necessary. If refname is the name of a directory
686 * (i.e., ends with '/'), then remove the directory and its contents.
687 * If the removal was successful, return the number of entries
688 * remaining in the directory entry that contained the deleted entry.
689 * If the name was not found, return -1. Please note that this
690 * function only deletes the entry from the cache; it does not delete
691 * it from the filesystem or ensure that other cache entries (which
692 * might be symbolic references to the removed entry) are updated.
693 * Nor does it remove any containing dir entries that might be made
694 * empty by the removal. dir must represent the top-level directory
695 * and must already be complete.
697 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
699 int refname_len
= strlen(refname
);
701 struct ref_entry
*entry
;
702 int is_dir
= refname
[refname_len
- 1] == '/';
705 * refname represents a reference directory. Remove
706 * the trailing slash; otherwise we will get the
707 * directory *representing* refname rather than the
708 * one *containing* it.
710 char *dirname
= xmemdupz(refname
, refname_len
- 1);
711 dir
= find_containing_dir(dir
, dirname
, 0);
714 dir
= find_containing_dir(dir
, refname
, 0);
718 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
719 if (entry_index
== -1)
721 entry
= dir
->entries
[entry_index
];
723 memmove(&dir
->entries
[entry_index
],
724 &dir
->entries
[entry_index
+ 1],
725 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
728 if (dir
->sorted
> entry_index
)
730 free_ref_entry(entry
);
735 * Add a ref_entry to the ref_dir (unsorted), recursing into
736 * subdirectories as necessary. dir must represent the top-level
737 * directory. Return 0 on success.
739 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
741 dir
= find_containing_dir(dir
, ref
->name
, 1);
744 add_entry_to_dir(dir
, ref
);
749 * Emit a warning and return true iff ref1 and ref2 have the same name
750 * and the same sha1. Die if they have the same name but different
753 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
755 if (strcmp(ref1
->name
, ref2
->name
))
758 /* Duplicate name; make sure that they don't conflict: */
760 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
761 /* This is impossible by construction */
762 die("Reference directory conflict: %s", ref1
->name
);
764 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
765 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
767 warning("Duplicated ref: %s", ref1
->name
);
772 * Sort the entries in dir non-recursively (if they are not already
773 * sorted) and remove any duplicate entries.
775 static void sort_ref_dir(struct ref_dir
*dir
)
778 struct ref_entry
*last
= NULL
;
781 * This check also prevents passing a zero-length array to qsort(),
782 * which is a problem on some platforms.
784 if (dir
->sorted
== dir
->nr
)
787 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
789 /* Remove any duplicates: */
790 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
791 struct ref_entry
*entry
= dir
->entries
[j
];
792 if (last
&& is_dup_ref(last
, entry
))
793 free_ref_entry(entry
);
795 last
= dir
->entries
[i
++] = entry
;
797 dir
->sorted
= dir
->nr
= i
;
800 /* Include broken references in a do_for_each_ref*() iteration: */
801 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
804 * Return true iff the reference described by entry can be resolved to
805 * an object in the database. Emit a warning if the referred-to
806 * object does not exist.
808 static int ref_resolves_to_object(struct ref_entry
*entry
)
810 if (entry
->flag
& REF_ISBROKEN
)
812 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
813 error("%s does not point to a valid object!", entry
->name
);
820 * current_ref is a performance hack: when iterating over references
821 * using the for_each_ref*() functions, current_ref is set to the
822 * current reference's entry before calling the callback function. If
823 * the callback function calls peel_ref(), then peel_ref() first
824 * checks whether the reference to be peeled is the current reference
825 * (it usually is) and if so, returns that reference's peeled version
826 * if it is available. This avoids a refname lookup in a common case.
828 static struct ref_entry
*current_ref
;
830 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
832 struct ref_entry_cb
{
841 * Handle one reference in a do_for_each_ref*()-style iteration,
842 * calling an each_ref_fn for each entry.
844 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
846 struct ref_entry_cb
*data
= cb_data
;
847 struct ref_entry
*old_current_ref
;
850 if (!starts_with(entry
->name
, data
->base
))
853 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
854 !ref_resolves_to_object(entry
))
857 /* Store the old value, in case this is a recursive call: */
858 old_current_ref
= current_ref
;
860 retval
= data
->fn(entry
->name
+ data
->trim
, entry
->u
.value
.sha1
,
861 entry
->flag
, data
->cb_data
);
862 current_ref
= old_current_ref
;
867 * Call fn for each reference in dir that has index in the range
868 * offset <= index < dir->nr. Recurse into subdirectories that are in
869 * that index range, sorting them before iterating. This function
870 * does not sort dir itself; it should be sorted beforehand. fn is
871 * called for all references, including broken ones.
873 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
874 each_ref_entry_fn fn
, void *cb_data
)
877 assert(dir
->sorted
== dir
->nr
);
878 for (i
= offset
; i
< dir
->nr
; i
++) {
879 struct ref_entry
*entry
= dir
->entries
[i
];
881 if (entry
->flag
& REF_DIR
) {
882 struct ref_dir
*subdir
= get_ref_dir(entry
);
883 sort_ref_dir(subdir
);
884 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
886 retval
= fn(entry
, cb_data
);
895 * Call fn for each reference in the union of dir1 and dir2, in order
896 * by refname. Recurse into subdirectories. If a value entry appears
897 * in both dir1 and dir2, then only process the version that is in
898 * dir2. The input dirs must already be sorted, but subdirs will be
899 * sorted as needed. fn is called for all references, including
902 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
903 struct ref_dir
*dir2
,
904 each_ref_entry_fn fn
, void *cb_data
)
909 assert(dir1
->sorted
== dir1
->nr
);
910 assert(dir2
->sorted
== dir2
->nr
);
912 struct ref_entry
*e1
, *e2
;
914 if (i1
== dir1
->nr
) {
915 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
917 if (i2
== dir2
->nr
) {
918 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
920 e1
= dir1
->entries
[i1
];
921 e2
= dir2
->entries
[i2
];
922 cmp
= strcmp(e1
->name
, e2
->name
);
924 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
925 /* Both are directories; descend them in parallel. */
926 struct ref_dir
*subdir1
= get_ref_dir(e1
);
927 struct ref_dir
*subdir2
= get_ref_dir(e2
);
928 sort_ref_dir(subdir1
);
929 sort_ref_dir(subdir2
);
930 retval
= do_for_each_entry_in_dirs(
931 subdir1
, subdir2
, fn
, cb_data
);
934 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
935 /* Both are references; ignore the one from dir1. */
936 retval
= fn(e2
, cb_data
);
940 die("conflict between reference and directory: %s",
952 if (e
->flag
& REF_DIR
) {
953 struct ref_dir
*subdir
= get_ref_dir(e
);
954 sort_ref_dir(subdir
);
955 retval
= do_for_each_entry_in_dir(
956 subdir
, 0, fn
, cb_data
);
958 retval
= fn(e
, cb_data
);
967 * Load all of the refs from the dir into our in-memory cache. The hard work
968 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
969 * through all of the sub-directories. We do not even need to care about
970 * sorting, as traversal order does not matter to us.
972 static void prime_ref_dir(struct ref_dir
*dir
)
975 for (i
= 0; i
< dir
->nr
; i
++) {
976 struct ref_entry
*entry
= dir
->entries
[i
];
977 if (entry
->flag
& REF_DIR
)
978 prime_ref_dir(get_ref_dir(entry
));
982 * Return true iff refname1 and refname2 conflict with each other.
983 * Two reference names conflict if one of them exactly matches the
984 * leading components of the other; e.g., "foo/bar" conflicts with
985 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
988 static int names_conflict(const char *refname1
, const char *refname2
)
990 for (; *refname1
&& *refname1
== *refname2
; refname1
++, refname2
++)
992 return (*refname1
== '\0' && *refname2
== '/')
993 || (*refname1
== '/' && *refname2
== '\0');
996 struct name_conflict_cb
{
998 const char *oldrefname
;
999 const char *conflicting_refname
;
1002 static int name_conflict_fn(struct ref_entry
*entry
, void *cb_data
)
1004 struct name_conflict_cb
*data
= (struct name_conflict_cb
*)cb_data
;
1005 if (data
->oldrefname
&& !strcmp(data
->oldrefname
, entry
->name
))
1007 if (names_conflict(data
->refname
, entry
->name
)) {
1008 data
->conflicting_refname
= entry
->name
;
1015 * Return true iff a reference named refname could be created without
1016 * conflicting with the name of an existing reference in dir. If
1017 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
1018 * (e.g., because oldrefname is scheduled for deletion in the same
1021 static int is_refname_available(const char *refname
, const char *oldrefname
,
1022 struct ref_dir
*dir
)
1024 struct name_conflict_cb data
;
1025 data
.refname
= refname
;
1026 data
.oldrefname
= oldrefname
;
1027 data
.conflicting_refname
= NULL
;
1030 if (do_for_each_entry_in_dir(dir
, 0, name_conflict_fn
, &data
)) {
1031 error("'%s' exists; cannot create '%s'",
1032 data
.conflicting_refname
, refname
);
1038 struct packed_ref_cache
{
1039 struct ref_entry
*root
;
1042 * Count of references to the data structure in this instance,
1043 * including the pointer from ref_cache::packed if any. The
1044 * data will not be freed as long as the reference count is
1047 unsigned int referrers
;
1050 * Iff the packed-refs file associated with this instance is
1051 * currently locked for writing, this points at the associated
1052 * lock (which is owned by somebody else). The referrer count
1053 * is also incremented when the file is locked and decremented
1054 * when it is unlocked.
1056 struct lock_file
*lock
;
1058 /* The metadata from when this packed-refs cache was read */
1059 struct stat_validity validity
;
1063 * Future: need to be in "struct repository"
1064 * when doing a full libification.
1066 static struct ref_cache
{
1067 struct ref_cache
*next
;
1068 struct ref_entry
*loose
;
1069 struct packed_ref_cache
*packed
;
1071 * The submodule name, or "" for the main repo. We allocate
1072 * length 1 rather than FLEX_ARRAY so that the main ref_cache
1073 * is initialized correctly.
1076 } ref_cache
, *submodule_ref_caches
;
1078 /* Lock used for the main packed-refs file: */
1079 static struct lock_file packlock
;
1082 * Increment the reference count of *packed_refs.
1084 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1086 packed_refs
->referrers
++;
1090 * Decrease the reference count of *packed_refs. If it goes to zero,
1091 * free *packed_refs and return true; otherwise return false.
1093 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
1095 if (!--packed_refs
->referrers
) {
1096 free_ref_entry(packed_refs
->root
);
1097 stat_validity_clear(&packed_refs
->validity
);
1105 static void clear_packed_ref_cache(struct ref_cache
*refs
)
1108 struct packed_ref_cache
*packed_refs
= refs
->packed
;
1110 if (packed_refs
->lock
)
1111 die("internal error: packed-ref cache cleared while locked");
1112 refs
->packed
= NULL
;
1113 release_packed_ref_cache(packed_refs
);
1117 static void clear_loose_ref_cache(struct ref_cache
*refs
)
1120 free_ref_entry(refs
->loose
);
1125 static struct ref_cache
*create_ref_cache(const char *submodule
)
1128 struct ref_cache
*refs
;
1131 len
= strlen(submodule
) + 1;
1132 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
1133 memcpy(refs
->name
, submodule
, len
);
1138 * Return a pointer to a ref_cache for the specified submodule. For
1139 * the main repository, use submodule==NULL. The returned structure
1140 * will be allocated and initialized but not necessarily populated; it
1141 * should not be freed.
1143 static struct ref_cache
*get_ref_cache(const char *submodule
)
1145 struct ref_cache
*refs
;
1147 if (!submodule
|| !*submodule
)
1150 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
1151 if (!strcmp(submodule
, refs
->name
))
1154 refs
= create_ref_cache(submodule
);
1155 refs
->next
= submodule_ref_caches
;
1156 submodule_ref_caches
= refs
;
1160 /* The length of a peeled reference line in packed-refs, including EOL: */
1161 #define PEELED_LINE_LENGTH 42
1164 * The packed-refs header line that we write out. Perhaps other
1165 * traits will be added later. The trailing space is required.
1167 static const char PACKED_REFS_HEADER
[] =
1168 "# pack-refs with: peeled fully-peeled \n";
1171 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1172 * Return a pointer to the refname within the line (null-terminated),
1173 * or NULL if there was a problem.
1175 static const char *parse_ref_line(char *line
, unsigned char *sha1
)
1178 * 42: the answer to everything.
1180 * In this case, it happens to be the answer to
1181 * 40 (length of sha1 hex representation)
1182 * +1 (space in between hex and name)
1183 * +1 (newline at the end of the line)
1185 int len
= strlen(line
) - 42;
1189 if (get_sha1_hex(line
, sha1
) < 0)
1191 if (!isspace(line
[40]))
1196 if (line
[len
] != '\n')
1204 * Read f, which is a packed-refs file, into dir.
1206 * A comment line of the form "# pack-refs with: " may contain zero or
1207 * more traits. We interpret the traits as follows:
1211 * Probably no references are peeled. But if the file contains a
1212 * peeled value for a reference, we will use it.
1216 * References under "refs/tags/", if they *can* be peeled, *are*
1217 * peeled in this file. References outside of "refs/tags/" are
1218 * probably not peeled even if they could have been, but if we find
1219 * a peeled value for such a reference we will use it.
1223 * All references in the file that can be peeled are peeled.
1224 * Inversely (and this is more important), any references in the
1225 * file for which no peeled value is recorded is not peelable. This
1226 * trait should typically be written alongside "peeled" for
1227 * compatibility with older clients, but we do not require it
1228 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1230 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1232 struct ref_entry
*last
= NULL
;
1233 char refline
[PATH_MAX
];
1234 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1236 while (fgets(refline
, sizeof(refline
), f
)) {
1237 unsigned char sha1
[20];
1238 const char *refname
;
1239 static const char header
[] = "# pack-refs with:";
1241 if (!strncmp(refline
, header
, sizeof(header
)-1)) {
1242 const char *traits
= refline
+ sizeof(header
) - 1;
1243 if (strstr(traits
, " fully-peeled "))
1244 peeled
= PEELED_FULLY
;
1245 else if (strstr(traits
, " peeled "))
1246 peeled
= PEELED_TAGS
;
1247 /* perhaps other traits later as well */
1251 refname
= parse_ref_line(refline
, sha1
);
1253 last
= create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1);
1254 if (peeled
== PEELED_FULLY
||
1255 (peeled
== PEELED_TAGS
&& starts_with(refname
, "refs/tags/")))
1256 last
->flag
|= REF_KNOWS_PEELED
;
1261 refline
[0] == '^' &&
1262 strlen(refline
) == PEELED_LINE_LENGTH
&&
1263 refline
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1264 !get_sha1_hex(refline
+ 1, sha1
)) {
1265 hashcpy(last
->u
.value
.peeled
, sha1
);
1267 * Regardless of what the file header said,
1268 * we definitely know the value of *this*
1271 last
->flag
|= REF_KNOWS_PEELED
;
1277 * Get the packed_ref_cache for the specified ref_cache, creating it
1280 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1282 const char *packed_refs_file
;
1285 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1287 packed_refs_file
= git_path("packed-refs");
1290 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1291 clear_packed_ref_cache(refs
);
1293 if (!refs
->packed
) {
1296 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1297 acquire_packed_ref_cache(refs
->packed
);
1298 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1299 f
= fopen(packed_refs_file
, "r");
1301 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1302 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1306 return refs
->packed
;
1309 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1311 return get_ref_dir(packed_ref_cache
->root
);
1314 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1316 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1319 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1321 struct packed_ref_cache
*packed_ref_cache
=
1322 get_packed_ref_cache(&ref_cache
);
1324 if (!packed_ref_cache
->lock
)
1325 die("internal error: packed refs not locked");
1326 add_ref(get_packed_ref_dir(packed_ref_cache
),
1327 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1331 * Read the loose references from the namespace dirname into dir
1332 * (without recursing). dirname must end with '/'. dir must be the
1333 * directory entry corresponding to dirname.
1335 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1337 struct ref_cache
*refs
= dir
->ref_cache
;
1341 int dirnamelen
= strlen(dirname
);
1342 struct strbuf refname
;
1345 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1347 path
= git_path("%s", dirname
);
1353 strbuf_init(&refname
, dirnamelen
+ 257);
1354 strbuf_add(&refname
, dirname
, dirnamelen
);
1356 while ((de
= readdir(d
)) != NULL
) {
1357 unsigned char sha1
[20];
1362 if (de
->d_name
[0] == '.')
1364 if (has_extension(de
->d_name
, ".lock"))
1366 strbuf_addstr(&refname
, de
->d_name
);
1367 refdir
= *refs
->name
1368 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1369 : git_path("%s", refname
.buf
);
1370 if (stat(refdir
, &st
) < 0) {
1371 ; /* silently ignore */
1372 } else if (S_ISDIR(st
.st_mode
)) {
1373 strbuf_addch(&refname
, '/');
1374 add_entry_to_dir(dir
,
1375 create_dir_entry(refs
, refname
.buf
,
1381 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
1383 flag
|= REF_ISBROKEN
;
1385 } else if (read_ref_full(refname
.buf
, sha1
, 1, &flag
)) {
1387 flag
|= REF_ISBROKEN
;
1389 add_entry_to_dir(dir
,
1390 create_ref_entry(refname
.buf
, sha1
, flag
, 1));
1392 strbuf_setlen(&refname
, dirnamelen
);
1394 strbuf_release(&refname
);
1398 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1402 * Mark the top-level directory complete because we
1403 * are about to read the only subdirectory that can
1406 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1408 * Create an incomplete entry for "refs/":
1410 add_entry_to_dir(get_ref_dir(refs
->loose
),
1411 create_dir_entry(refs
, "refs/", 5, 1));
1413 return get_ref_dir(refs
->loose
);
1416 /* We allow "recursive" symbolic refs. Only within reason, though */
1418 #define MAXREFLEN (1024)
1421 * Called by resolve_gitlink_ref_recursive() after it failed to read
1422 * from the loose refs in ref_cache refs. Find <refname> in the
1423 * packed-refs file for the submodule.
1425 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1426 const char *refname
, unsigned char *sha1
)
1428 struct ref_entry
*ref
;
1429 struct ref_dir
*dir
= get_packed_refs(refs
);
1431 ref
= find_ref(dir
, refname
);
1435 hashcpy(sha1
, ref
->u
.value
.sha1
);
1439 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1440 const char *refname
, unsigned char *sha1
,
1444 char buffer
[128], *p
;
1447 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1450 ? git_path_submodule(refs
->name
, "%s", refname
)
1451 : git_path("%s", refname
);
1452 fd
= open(path
, O_RDONLY
);
1454 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1456 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1460 while (len
&& isspace(buffer
[len
-1]))
1464 /* Was it a detached head or an old-fashioned symlink? */
1465 if (!get_sha1_hex(buffer
, sha1
))
1469 if (strncmp(buffer
, "ref:", 4))
1475 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1478 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1480 int len
= strlen(path
), retval
;
1482 struct ref_cache
*refs
;
1484 while (len
&& path
[len
-1] == '/')
1488 submodule
= xstrndup(path
, len
);
1489 refs
= get_ref_cache(submodule
);
1492 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1497 * Return the ref_entry for the given refname from the packed
1498 * references. If it does not exist, return NULL.
1500 static struct ref_entry
*get_packed_ref(const char *refname
)
1502 return find_ref(get_packed_refs(&ref_cache
), refname
);
1506 * A loose ref file doesn't exist; check for a packed ref. The
1507 * options are forwarded from resolve_safe_unsafe().
1509 static const char *handle_missing_loose_ref(const char *refname
,
1510 unsigned char *sha1
,
1514 struct ref_entry
*entry
;
1517 * The loose reference file does not exist; check for a packed
1520 entry
= get_packed_ref(refname
);
1522 hashcpy(sha1
, entry
->u
.value
.sha1
);
1524 *flag
|= REF_ISPACKED
;
1527 /* The reference is not a packed reference, either. */
1536 const char *resolve_ref_unsafe(const char *refname
, unsigned char *sha1
, int reading
, int *flag
)
1538 int depth
= MAXDEPTH
;
1541 static char refname_buffer
[256];
1546 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
1550 char path
[PATH_MAX
];
1558 git_snpath(path
, sizeof(path
), "%s", refname
);
1561 * We might have to loop back here to avoid a race
1562 * condition: first we lstat() the file, then we try
1563 * to read it as a link or as a file. But if somebody
1564 * changes the type of the file (file <-> directory
1565 * <-> symlink) between the lstat() and reading, then
1566 * we don't want to report that as an error but rather
1567 * try again starting with the lstat().
1570 if (lstat(path
, &st
) < 0) {
1571 if (errno
== ENOENT
)
1572 return handle_missing_loose_ref(refname
, sha1
,
1578 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1579 if (S_ISLNK(st
.st_mode
)) {
1580 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1582 if (errno
== ENOENT
|| errno
== EINVAL
)
1583 /* inconsistent with lstat; retry */
1589 if (starts_with(buffer
, "refs/") &&
1590 !check_refname_format(buffer
, 0)) {
1591 strcpy(refname_buffer
, buffer
);
1592 refname
= refname_buffer
;
1594 *flag
|= REF_ISSYMREF
;
1599 /* Is it a directory? */
1600 if (S_ISDIR(st
.st_mode
)) {
1606 * Anything else, just open it and try to use it as
1609 fd
= open(path
, O_RDONLY
);
1611 if (errno
== ENOENT
)
1612 /* inconsistent with lstat; retry */
1617 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1621 while (len
&& isspace(buffer
[len
-1]))
1626 * Is it a symbolic ref?
1628 if (!starts_with(buffer
, "ref:")) {
1630 * Please note that FETCH_HEAD has a second
1631 * line containing other data.
1633 if (get_sha1_hex(buffer
, sha1
) ||
1634 (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1636 *flag
|= REF_ISBROKEN
;
1642 *flag
|= REF_ISSYMREF
;
1644 while (isspace(*buf
))
1646 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1648 *flag
|= REF_ISBROKEN
;
1651 refname
= strcpy(refname_buffer
, buf
);
1655 char *resolve_refdup(const char *ref
, unsigned char *sha1
, int reading
, int *flag
)
1657 const char *ret
= resolve_ref_unsafe(ref
, sha1
, reading
, flag
);
1658 return ret
? xstrdup(ret
) : NULL
;
1661 /* The argument to filter_refs */
1663 const char *pattern
;
1668 int read_ref_full(const char *refname
, unsigned char *sha1
, int reading
, int *flags
)
1670 if (resolve_ref_unsafe(refname
, sha1
, reading
, flags
))
1675 int read_ref(const char *refname
, unsigned char *sha1
)
1677 return read_ref_full(refname
, sha1
, 1, NULL
);
1680 int ref_exists(const char *refname
)
1682 unsigned char sha1
[20];
1683 return !!resolve_ref_unsafe(refname
, sha1
, 1, NULL
);
1686 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1689 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1690 if (wildmatch(filter
->pattern
, refname
, 0, NULL
))
1692 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1696 /* object was peeled successfully: */
1700 * object cannot be peeled because the named object (or an
1701 * object referred to by a tag in the peel chain), does not
1706 /* object cannot be peeled because it is not a tag: */
1709 /* ref_entry contains no peeled value because it is a symref: */
1710 PEEL_IS_SYMREF
= -3,
1713 * ref_entry cannot be peeled because it is broken (i.e., the
1714 * symbolic reference cannot even be resolved to an object
1721 * Peel the named object; i.e., if the object is a tag, resolve the
1722 * tag recursively until a non-tag is found. If successful, store the
1723 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1724 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1725 * and leave sha1 unchanged.
1727 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1729 struct object
*o
= lookup_unknown_object(name
);
1731 if (o
->type
== OBJ_NONE
) {
1732 int type
= sha1_object_info(name
, NULL
);
1734 return PEEL_INVALID
;
1738 if (o
->type
!= OBJ_TAG
)
1739 return PEEL_NON_TAG
;
1741 o
= deref_tag_noverify(o
);
1743 return PEEL_INVALID
;
1745 hashcpy(sha1
, o
->sha1
);
1750 * Peel the entry (if possible) and return its new peel_status. If
1751 * repeel is true, re-peel the entry even if there is an old peeled
1752 * value that is already stored in it.
1754 * It is OK to call this function with a packed reference entry that
1755 * might be stale and might even refer to an object that has since
1756 * been garbage-collected. In such a case, if the entry has
1757 * REF_KNOWS_PEELED then leave the status unchanged and return
1758 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1760 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1762 enum peel_status status
;
1764 if (entry
->flag
& REF_KNOWS_PEELED
) {
1766 entry
->flag
&= ~REF_KNOWS_PEELED
;
1767 hashclr(entry
->u
.value
.peeled
);
1769 return is_null_sha1(entry
->u
.value
.peeled
) ?
1770 PEEL_NON_TAG
: PEEL_PEELED
;
1773 if (entry
->flag
& REF_ISBROKEN
)
1775 if (entry
->flag
& REF_ISSYMREF
)
1776 return PEEL_IS_SYMREF
;
1778 status
= peel_object(entry
->u
.value
.sha1
, entry
->u
.value
.peeled
);
1779 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1780 entry
->flag
|= REF_KNOWS_PEELED
;
1784 int peel_ref(const char *refname
, unsigned char *sha1
)
1787 unsigned char base
[20];
1789 if (current_ref
&& (current_ref
->name
== refname
1790 || !strcmp(current_ref
->name
, refname
))) {
1791 if (peel_entry(current_ref
, 0))
1793 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1797 if (read_ref_full(refname
, base
, 1, &flag
))
1801 * If the reference is packed, read its ref_entry from the
1802 * cache in the hope that we already know its peeled value.
1803 * We only try this optimization on packed references because
1804 * (a) forcing the filling of the loose reference cache could
1805 * be expensive and (b) loose references anyway usually do not
1806 * have REF_KNOWS_PEELED.
1808 if (flag
& REF_ISPACKED
) {
1809 struct ref_entry
*r
= get_packed_ref(refname
);
1811 if (peel_entry(r
, 0))
1813 hashcpy(sha1
, r
->u
.value
.peeled
);
1818 return peel_object(base
, sha1
);
1821 struct warn_if_dangling_data
{
1823 const char *refname
;
1824 const char *msg_fmt
;
1827 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1828 int flags
, void *cb_data
)
1830 struct warn_if_dangling_data
*d
= cb_data
;
1831 const char *resolves_to
;
1832 unsigned char junk
[20];
1834 if (!(flags
& REF_ISSYMREF
))
1837 resolves_to
= resolve_ref_unsafe(refname
, junk
, 0, NULL
);
1838 if (!resolves_to
|| strcmp(resolves_to
, d
->refname
))
1841 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1846 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1848 struct warn_if_dangling_data data
;
1851 data
.refname
= refname
;
1852 data
.msg_fmt
= msg_fmt
;
1853 for_each_rawref(warn_if_dangling_symref
, &data
);
1857 * Call fn for each reference in the specified ref_cache, omitting
1858 * references not in the containing_dir of base. fn is called for all
1859 * references, including broken ones. If fn ever returns a non-zero
1860 * value, stop the iteration and return that value; otherwise, return
1863 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1864 each_ref_entry_fn fn
, void *cb_data
)
1866 struct packed_ref_cache
*packed_ref_cache
;
1867 struct ref_dir
*loose_dir
;
1868 struct ref_dir
*packed_dir
;
1872 * We must make sure that all loose refs are read before accessing the
1873 * packed-refs file; this avoids a race condition in which loose refs
1874 * are migrated to the packed-refs file by a simultaneous process, but
1875 * our in-memory view is from before the migration. get_packed_ref_cache()
1876 * takes care of making sure our view is up to date with what is on
1879 loose_dir
= get_loose_refs(refs
);
1880 if (base
&& *base
) {
1881 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1884 prime_ref_dir(loose_dir
);
1886 packed_ref_cache
= get_packed_ref_cache(refs
);
1887 acquire_packed_ref_cache(packed_ref_cache
);
1888 packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1889 if (base
&& *base
) {
1890 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1893 if (packed_dir
&& loose_dir
) {
1894 sort_ref_dir(packed_dir
);
1895 sort_ref_dir(loose_dir
);
1896 retval
= do_for_each_entry_in_dirs(
1897 packed_dir
, loose_dir
, fn
, cb_data
);
1898 } else if (packed_dir
) {
1899 sort_ref_dir(packed_dir
);
1900 retval
= do_for_each_entry_in_dir(
1901 packed_dir
, 0, fn
, cb_data
);
1902 } else if (loose_dir
) {
1903 sort_ref_dir(loose_dir
);
1904 retval
= do_for_each_entry_in_dir(
1905 loose_dir
, 0, fn
, cb_data
);
1908 release_packed_ref_cache(packed_ref_cache
);
1913 * Call fn for each reference in the specified ref_cache for which the
1914 * refname begins with base. If trim is non-zero, then trim that many
1915 * characters off the beginning of each refname before passing the
1916 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1917 * broken references in the iteration. If fn ever returns a non-zero
1918 * value, stop the iteration and return that value; otherwise, return
1921 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
1922 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1924 struct ref_entry_cb data
;
1929 data
.cb_data
= cb_data
;
1931 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
1934 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1936 unsigned char sha1
[20];
1940 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1941 return fn("HEAD", sha1
, 0, cb_data
);
1946 if (!read_ref_full("HEAD", sha1
, 1, &flag
))
1947 return fn("HEAD", sha1
, flag
, cb_data
);
1952 int head_ref(each_ref_fn fn
, void *cb_data
)
1954 return do_head_ref(NULL
, fn
, cb_data
);
1957 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1959 return do_head_ref(submodule
, fn
, cb_data
);
1962 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1964 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
1967 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1969 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
1972 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1974 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1977 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
1978 each_ref_fn fn
, void *cb_data
)
1980 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
1983 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
1985 return for_each_ref_in("refs/tags/", fn
, cb_data
);
1988 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1990 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
1993 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
1995 return for_each_ref_in("refs/heads/", fn
, cb_data
);
1998 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2000 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
2003 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
2005 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
2008 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
2010 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
2013 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
2015 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
2018 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
2020 struct strbuf buf
= STRBUF_INIT
;
2022 unsigned char sha1
[20];
2025 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
2026 if (!read_ref_full(buf
.buf
, sha1
, 1, &flag
))
2027 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
2028 strbuf_release(&buf
);
2033 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
2035 struct strbuf buf
= STRBUF_INIT
;
2037 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
2038 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
2039 strbuf_release(&buf
);
2043 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
2044 const char *prefix
, void *cb_data
)
2046 struct strbuf real_pattern
= STRBUF_INIT
;
2047 struct ref_filter filter
;
2050 if (!prefix
&& !starts_with(pattern
, "refs/"))
2051 strbuf_addstr(&real_pattern
, "refs/");
2053 strbuf_addstr(&real_pattern
, prefix
);
2054 strbuf_addstr(&real_pattern
, pattern
);
2056 if (!has_glob_specials(pattern
)) {
2057 /* Append implied '/' '*' if not present. */
2058 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
2059 strbuf_addch(&real_pattern
, '/');
2060 /* No need to check for '*', there is none. */
2061 strbuf_addch(&real_pattern
, '*');
2064 filter
.pattern
= real_pattern
.buf
;
2066 filter
.cb_data
= cb_data
;
2067 ret
= for_each_ref(filter_refs
, &filter
);
2069 strbuf_release(&real_pattern
);
2073 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
2075 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
2078 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
2080 return do_for_each_ref(&ref_cache
, "", fn
, 0,
2081 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
2084 const char *prettify_refname(const char *name
)
2087 starts_with(name
, "refs/heads/") ? 11 :
2088 starts_with(name
, "refs/tags/") ? 10 :
2089 starts_with(name
, "refs/remotes/") ? 13 :
2093 static const char *ref_rev_parse_rules
[] = {
2098 "refs/remotes/%.*s",
2099 "refs/remotes/%.*s/HEAD",
2103 int refname_match(const char *abbrev_name
, const char *full_name
)
2106 const int abbrev_name_len
= strlen(abbrev_name
);
2108 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2109 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
2117 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
2118 const unsigned char *old_sha1
, int mustexist
)
2120 if (read_ref_full(lock
->ref_name
, lock
->old_sha1
, mustexist
, NULL
)) {
2121 error("Can't verify ref %s", lock
->ref_name
);
2125 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
2126 error("Ref %s is at %s but expected %s", lock
->ref_name
,
2127 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
2134 static int remove_empty_directories(const char *file
)
2136 /* we want to create a file but there is a directory there;
2137 * if that is an empty directory (or a directory that contains
2138 * only empty directories), remove them.
2143 strbuf_init(&path
, 20);
2144 strbuf_addstr(&path
, file
);
2146 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
2148 strbuf_release(&path
);
2154 * *string and *len will only be substituted, and *string returned (for
2155 * later free()ing) if the string passed in is a magic short-hand form
2158 static char *substitute_branch_name(const char **string
, int *len
)
2160 struct strbuf buf
= STRBUF_INIT
;
2161 int ret
= interpret_branch_name(*string
, *len
, &buf
);
2165 *string
= strbuf_detach(&buf
, &size
);
2167 return (char *)*string
;
2173 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
2175 char *last_branch
= substitute_branch_name(&str
, &len
);
2180 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2181 char fullref
[PATH_MAX
];
2182 unsigned char sha1_from_ref
[20];
2183 unsigned char *this_result
;
2186 this_result
= refs_found
? sha1_from_ref
: sha1
;
2187 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
2188 r
= resolve_ref_unsafe(fullref
, this_result
, 1, &flag
);
2192 if (!warn_ambiguous_refs
)
2194 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
2195 warning("ignoring dangling symref %s.", fullref
);
2196 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
2197 warning("ignoring broken ref %s.", fullref
);
2204 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
2206 char *last_branch
= substitute_branch_name(&str
, &len
);
2211 for (p
= ref_rev_parse_rules
; *p
; p
++) {
2213 unsigned char hash
[20];
2214 char path
[PATH_MAX
];
2215 const char *ref
, *it
;
2217 mksnpath(path
, sizeof(path
), *p
, len
, str
);
2218 ref
= resolve_ref_unsafe(path
, hash
, 1, NULL
);
2221 if (!stat(git_path("logs/%s", path
), &st
) &&
2222 S_ISREG(st
.st_mode
))
2224 else if (strcmp(ref
, path
) &&
2225 !stat(git_path("logs/%s", ref
), &st
) &&
2226 S_ISREG(st
.st_mode
))
2230 if (!logs_found
++) {
2232 hashcpy(sha1
, hash
);
2234 if (!warn_ambiguous_refs
)
2241 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
2242 const unsigned char *old_sha1
,
2243 int flags
, int *type_p
)
2246 const char *orig_refname
= refname
;
2247 struct ref_lock
*lock
;
2250 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
2252 int attempts_remaining
= 3;
2254 lock
= xcalloc(1, sizeof(struct ref_lock
));
2257 refname
= resolve_ref_unsafe(refname
, lock
->old_sha1
, mustexist
, &type
);
2258 if (!refname
&& errno
== EISDIR
) {
2259 /* we are trying to lock foo but we used to
2260 * have foo/bar which now does not exist;
2261 * it is normal for the empty directory 'foo'
2264 ref_file
= git_path("%s", orig_refname
);
2265 if (remove_empty_directories(ref_file
)) {
2267 error("there are still refs under '%s'", orig_refname
);
2270 refname
= resolve_ref_unsafe(orig_refname
, lock
->old_sha1
, mustexist
, &type
);
2276 error("unable to resolve reference %s: %s",
2277 orig_refname
, strerror(errno
));
2280 missing
= is_null_sha1(lock
->old_sha1
);
2281 /* When the ref did not exist and we are creating it,
2282 * make sure there is no existing ref that is packed
2283 * whose name begins with our refname, nor a ref whose
2284 * name is a proper prefix of our refname.
2287 !is_refname_available(refname
, NULL
, get_packed_refs(&ref_cache
))) {
2288 last_errno
= ENOTDIR
;
2292 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2295 if (flags
& REF_NODEREF
) {
2296 refname
= orig_refname
;
2297 lflags
|= LOCK_NODEREF
;
2299 lock
->ref_name
= xstrdup(refname
);
2300 lock
->orig_ref_name
= xstrdup(orig_refname
);
2301 ref_file
= git_path("%s", refname
);
2303 lock
->force_write
= 1;
2304 if ((flags
& REF_NODEREF
) && (type
& REF_ISSYMREF
))
2305 lock
->force_write
= 1;
2308 switch (safe_create_leading_directories(ref_file
)) {
2310 break; /* success */
2312 if (--attempts_remaining
> 0)
2317 error("unable to create directory for %s", ref_file
);
2321 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
2322 if (lock
->lock_fd
< 0) {
2323 if (errno
== ENOENT
&& --attempts_remaining
> 0)
2325 * Maybe somebody just deleted one of the
2326 * directories leading to ref_file. Try
2331 unable_to_lock_index_die(ref_file
, errno
);
2333 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
2341 struct ref_lock
*lock_ref_sha1(const char *refname
, const unsigned char *old_sha1
)
2343 char refpath
[PATH_MAX
];
2344 if (check_refname_format(refname
, 0))
2346 strcpy(refpath
, mkpath("refs/%s", refname
));
2347 return lock_ref_sha1_basic(refpath
, old_sha1
, 0, NULL
);
2350 struct ref_lock
*lock_any_ref_for_update(const char *refname
,
2351 const unsigned char *old_sha1
,
2352 int flags
, int *type_p
)
2354 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
2356 return lock_ref_sha1_basic(refname
, old_sha1
, flags
, type_p
);
2360 * Write an entry to the packed-refs file for the specified refname.
2361 * If peeled is non-NULL, write it as the entry's peeled value.
2363 static void write_packed_entry(int fd
, char *refname
, unsigned char *sha1
,
2364 unsigned char *peeled
)
2366 char line
[PATH_MAX
+ 100];
2369 len
= snprintf(line
, sizeof(line
), "%s %s\n",
2370 sha1_to_hex(sha1
), refname
);
2371 /* this should not happen but just being defensive */
2372 if (len
> sizeof(line
))
2373 die("too long a refname '%s'", refname
);
2374 write_or_die(fd
, line
, len
);
2377 if (snprintf(line
, sizeof(line
), "^%s\n",
2378 sha1_to_hex(peeled
)) != PEELED_LINE_LENGTH
)
2379 die("internal error");
2380 write_or_die(fd
, line
, PEELED_LINE_LENGTH
);
2385 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2387 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2390 enum peel_status peel_status
= peel_entry(entry
, 0);
2392 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2393 error("internal error: %s is not a valid packed reference!",
2395 write_packed_entry(*fd
, entry
->name
, entry
->u
.value
.sha1
,
2396 peel_status
== PEEL_PEELED
?
2397 entry
->u
.value
.peeled
: NULL
);
2401 int lock_packed_refs(int flags
)
2403 struct packed_ref_cache
*packed_ref_cache
;
2405 if (hold_lock_file_for_update(&packlock
, git_path("packed-refs"), flags
) < 0)
2408 * Get the current packed-refs while holding the lock. If the
2409 * packed-refs file has been modified since we last read it,
2410 * this will automatically invalidate the cache and re-read
2411 * the packed-refs file.
2413 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2414 packed_ref_cache
->lock
= &packlock
;
2415 /* Increment the reference count to prevent it from being freed: */
2416 acquire_packed_ref_cache(packed_ref_cache
);
2420 int commit_packed_refs(void)
2422 struct packed_ref_cache
*packed_ref_cache
=
2423 get_packed_ref_cache(&ref_cache
);
2426 if (!packed_ref_cache
->lock
)
2427 die("internal error: packed-refs not locked");
2428 write_or_die(packed_ref_cache
->lock
->fd
,
2429 PACKED_REFS_HEADER
, strlen(PACKED_REFS_HEADER
));
2431 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2432 0, write_packed_entry_fn
,
2433 &packed_ref_cache
->lock
->fd
);
2434 if (commit_lock_file(packed_ref_cache
->lock
))
2436 packed_ref_cache
->lock
= NULL
;
2437 release_packed_ref_cache(packed_ref_cache
);
2441 void rollback_packed_refs(void)
2443 struct packed_ref_cache
*packed_ref_cache
=
2444 get_packed_ref_cache(&ref_cache
);
2446 if (!packed_ref_cache
->lock
)
2447 die("internal error: packed-refs not locked");
2448 rollback_lock_file(packed_ref_cache
->lock
);
2449 packed_ref_cache
->lock
= NULL
;
2450 release_packed_ref_cache(packed_ref_cache
);
2451 clear_packed_ref_cache(&ref_cache
);
2454 struct ref_to_prune
{
2455 struct ref_to_prune
*next
;
2456 unsigned char sha1
[20];
2457 char name
[FLEX_ARRAY
];
2460 struct pack_refs_cb_data
{
2462 struct ref_dir
*packed_refs
;
2463 struct ref_to_prune
*ref_to_prune
;
2467 * An each_ref_entry_fn that is run over loose references only. If
2468 * the loose reference can be packed, add an entry in the packed ref
2469 * cache. If the reference should be pruned, also add it to
2470 * ref_to_prune in the pack_refs_cb_data.
2472 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2474 struct pack_refs_cb_data
*cb
= cb_data
;
2475 enum peel_status peel_status
;
2476 struct ref_entry
*packed_entry
;
2477 int is_tag_ref
= starts_with(entry
->name
, "refs/tags/");
2479 /* ALWAYS pack tags */
2480 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2483 /* Do not pack symbolic or broken refs: */
2484 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2487 /* Add a packed ref cache entry equivalent to the loose entry. */
2488 peel_status
= peel_entry(entry
, 1);
2489 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2490 die("internal error peeling reference %s (%s)",
2491 entry
->name
, sha1_to_hex(entry
->u
.value
.sha1
));
2492 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2494 /* Overwrite existing packed entry with info from loose entry */
2495 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2496 hashcpy(packed_entry
->u
.value
.sha1
, entry
->u
.value
.sha1
);
2498 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.sha1
,
2499 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2500 add_ref(cb
->packed_refs
, packed_entry
);
2502 hashcpy(packed_entry
->u
.value
.peeled
, entry
->u
.value
.peeled
);
2504 /* Schedule the loose reference for pruning if requested. */
2505 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2506 int namelen
= strlen(entry
->name
) + 1;
2507 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2508 hashcpy(n
->sha1
, entry
->u
.value
.sha1
);
2509 strcpy(n
->name
, entry
->name
);
2510 n
->next
= cb
->ref_to_prune
;
2511 cb
->ref_to_prune
= n
;
2517 * Remove empty parents, but spare refs/ and immediate subdirs.
2518 * Note: munges *name.
2520 static void try_remove_empty_parents(char *name
)
2525 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2526 while (*p
&& *p
!= '/')
2528 /* tolerate duplicate slashes; see check_refname_format() */
2532 for (q
= p
; *q
; q
++)
2535 while (q
> p
&& *q
!= '/')
2537 while (q
> p
&& *(q
-1) == '/')
2542 if (rmdir(git_path("%s", name
)))
2547 /* make sure nobody touched the ref, and unlink */
2548 static void prune_ref(struct ref_to_prune
*r
)
2550 struct ref_lock
*lock
= lock_ref_sha1(r
->name
+ 5, r
->sha1
);
2553 unlink_or_warn(git_path("%s", r
->name
));
2555 try_remove_empty_parents(r
->name
);
2559 static void prune_refs(struct ref_to_prune
*r
)
2567 int pack_refs(unsigned int flags
)
2569 struct pack_refs_cb_data cbdata
;
2571 memset(&cbdata
, 0, sizeof(cbdata
));
2572 cbdata
.flags
= flags
;
2574 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2575 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2577 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2578 pack_if_possible_fn
, &cbdata
);
2580 if (commit_packed_refs())
2581 die_errno("unable to overwrite old ref-pack file");
2583 prune_refs(cbdata
.ref_to_prune
);
2588 * If entry is no longer needed in packed-refs, add it to the string
2589 * list pointed to by cb_data. Reasons for deleting entries:
2591 * - Entry is broken.
2592 * - Entry is overridden by a loose ref.
2593 * - Entry does not point at a valid object.
2595 * In the first and third cases, also emit an error message because these
2596 * are indications of repository corruption.
2598 static int curate_packed_ref_fn(struct ref_entry
*entry
, void *cb_data
)
2600 struct string_list
*refs_to_delete
= cb_data
;
2602 if (entry
->flag
& REF_ISBROKEN
) {
2603 /* This shouldn't happen to packed refs. */
2604 error("%s is broken!", entry
->name
);
2605 string_list_append(refs_to_delete
, entry
->name
);
2608 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
2609 unsigned char sha1
[20];
2612 if (read_ref_full(entry
->name
, sha1
, 0, &flags
))
2613 /* We should at least have found the packed ref. */
2614 die("Internal error");
2615 if ((flags
& REF_ISSYMREF
) || !(flags
& REF_ISPACKED
)) {
2617 * This packed reference is overridden by a
2618 * loose reference, so it is OK that its value
2619 * is no longer valid; for example, it might
2620 * refer to an object that has been garbage
2621 * collected. For this purpose we don't even
2622 * care whether the loose reference itself is
2623 * invalid, broken, symbolic, etc. Silently
2624 * remove the packed reference.
2626 string_list_append(refs_to_delete
, entry
->name
);
2630 * There is no overriding loose reference, so the fact
2631 * that this reference doesn't refer to a valid object
2632 * indicates some kind of repository corruption.
2633 * Report the problem, then omit the reference from
2636 error("%s does not point to a valid object!", entry
->name
);
2637 string_list_append(refs_to_delete
, entry
->name
);
2644 static int repack_without_refs(const char **refnames
, int n
)
2646 struct ref_dir
*packed
;
2647 struct string_list refs_to_delete
= STRING_LIST_INIT_DUP
;
2648 struct string_list_item
*ref_to_delete
;
2651 /* Look for a packed ref */
2652 for (i
= 0; i
< n
; i
++)
2653 if (get_packed_ref(refnames
[i
]))
2656 /* Avoid locking if we have nothing to do */
2658 return 0; /* no refname exists in packed refs */
2660 if (lock_packed_refs(0)) {
2661 unable_to_lock_error(git_path("packed-refs"), errno
);
2662 return error("cannot delete '%s' from packed refs", refnames
[i
]);
2664 packed
= get_packed_refs(&ref_cache
);
2666 /* Remove refnames from the cache */
2667 for (i
= 0; i
< n
; i
++)
2668 if (remove_entry(packed
, refnames
[i
]) != -1)
2672 * All packed entries disappeared while we were
2673 * acquiring the lock.
2675 rollback_packed_refs();
2679 /* Remove any other accumulated cruft */
2680 do_for_each_entry_in_dir(packed
, 0, curate_packed_ref_fn
, &refs_to_delete
);
2681 for_each_string_list_item(ref_to_delete
, &refs_to_delete
) {
2682 if (remove_entry(packed
, ref_to_delete
->string
) == -1)
2683 die("internal error");
2686 /* Write what remains */
2687 return commit_packed_refs();
2690 static int repack_without_ref(const char *refname
)
2692 return repack_without_refs(&refname
, 1);
2695 static int delete_ref_loose(struct ref_lock
*lock
, int flag
)
2697 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2699 int err
, i
= strlen(lock
->lk
->filename
) - 5; /* .lock */
2701 lock
->lk
->filename
[i
] = 0;
2702 err
= unlink_or_warn(lock
->lk
->filename
);
2703 lock
->lk
->filename
[i
] = '.';
2704 if (err
&& errno
!= ENOENT
)
2710 int delete_ref(const char *refname
, const unsigned char *sha1
, int delopt
)
2712 struct ref_lock
*lock
;
2713 int ret
= 0, flag
= 0;
2715 lock
= lock_ref_sha1_basic(refname
, sha1
, delopt
, &flag
);
2718 ret
|= delete_ref_loose(lock
, flag
);
2720 /* removing the loose one could have resurrected an earlier
2721 * packed one. Also, if it was not loose we need to repack
2724 ret
|= repack_without_ref(lock
->ref_name
);
2726 unlink_or_warn(git_path("logs/%s", lock
->ref_name
));
2727 clear_loose_ref_cache(&ref_cache
);
2733 * People using contrib's git-new-workdir have .git/logs/refs ->
2734 * /some/other/path/.git/logs/refs, and that may live on another device.
2736 * IOW, to avoid cross device rename errors, the temporary renamed log must
2737 * live into logs/refs.
2739 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2741 static int rename_tmp_log(const char *newrefname
)
2743 int attempts_remaining
= 4;
2746 switch (safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
2748 break; /* success */
2750 if (--attempts_remaining
> 0)
2754 error("unable to create directory for %s", newrefname
);
2758 if (rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2759 if ((errno
==EISDIR
|| errno
==ENOTDIR
) && --attempts_remaining
> 0) {
2761 * rename(a, b) when b is an existing
2762 * directory ought to result in ISDIR, but
2763 * Solaris 5.8 gives ENOTDIR. Sheesh.
2765 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2766 error("Directory not empty: logs/%s", newrefname
);
2770 } else if (errno
== ENOENT
&& --attempts_remaining
> 0) {
2772 * Maybe another process just deleted one of
2773 * the directories in the path to newrefname.
2774 * Try again from the beginning.
2778 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2779 newrefname
, strerror(errno
));
2786 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2788 unsigned char sha1
[20], orig_sha1
[20];
2789 int flag
= 0, logmoved
= 0;
2790 struct ref_lock
*lock
;
2791 struct stat loginfo
;
2792 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2793 const char *symref
= NULL
;
2795 if (log
&& S_ISLNK(loginfo
.st_mode
))
2796 return error("reflog for %s is a symlink", oldrefname
);
2798 symref
= resolve_ref_unsafe(oldrefname
, orig_sha1
, 1, &flag
);
2799 if (flag
& REF_ISSYMREF
)
2800 return error("refname %s is a symbolic ref, renaming it is not supported",
2803 return error("refname %s not found", oldrefname
);
2805 if (!is_refname_available(newrefname
, oldrefname
, get_packed_refs(&ref_cache
)))
2808 if (!is_refname_available(newrefname
, oldrefname
, get_loose_refs(&ref_cache
)))
2811 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2812 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2813 oldrefname
, strerror(errno
));
2815 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2816 error("unable to delete old %s", oldrefname
);
2820 if (!read_ref_full(newrefname
, sha1
, 1, &flag
) &&
2821 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2822 if (errno
==EISDIR
) {
2823 if (remove_empty_directories(git_path("%s", newrefname
))) {
2824 error("Directory not empty: %s", newrefname
);
2828 error("unable to delete existing %s", newrefname
);
2833 if (log
&& rename_tmp_log(newrefname
))
2838 lock
= lock_ref_sha1_basic(newrefname
, NULL
, 0, NULL
);
2840 error("unable to lock %s for update", newrefname
);
2843 lock
->force_write
= 1;
2844 hashcpy(lock
->old_sha1
, orig_sha1
);
2845 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
2846 error("unable to write current sha1 into %s", newrefname
);
2853 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, 0, NULL
);
2855 error("unable to lock %s for rollback", oldrefname
);
2859 lock
->force_write
= 1;
2860 flag
= log_all_ref_updates
;
2861 log_all_ref_updates
= 0;
2862 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
2863 error("unable to write current sha1 into %s", oldrefname
);
2864 log_all_ref_updates
= flag
;
2867 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
2868 error("unable to restore logfile %s from %s: %s",
2869 oldrefname
, newrefname
, strerror(errno
));
2870 if (!logmoved
&& log
&&
2871 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
2872 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
2873 oldrefname
, strerror(errno
));
2878 int close_ref(struct ref_lock
*lock
)
2880 if (close_lock_file(lock
->lk
))
2886 int commit_ref(struct ref_lock
*lock
)
2888 if (commit_lock_file(lock
->lk
))
2894 void unlock_ref(struct ref_lock
*lock
)
2896 /* Do not free lock->lk -- atexit() still looks at them */
2898 rollback_lock_file(lock
->lk
);
2899 free(lock
->ref_name
);
2900 free(lock
->orig_ref_name
);
2905 * copy the reflog message msg to buf, which has been allocated sufficiently
2906 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2907 * because reflog file is one line per entry.
2909 static int copy_msg(char *buf
, const char *msg
)
2916 while ((c
= *msg
++)) {
2917 if (wasspace
&& isspace(c
))
2919 wasspace
= isspace(c
);
2924 while (buf
< cp
&& isspace(cp
[-1]))
2930 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
2932 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
2934 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
2935 if (log_all_ref_updates
&&
2936 (starts_with(refname
, "refs/heads/") ||
2937 starts_with(refname
, "refs/remotes/") ||
2938 starts_with(refname
, "refs/notes/") ||
2939 !strcmp(refname
, "HEAD"))) {
2940 if (safe_create_leading_directories(logfile
) < 0)
2941 return error("unable to create directory for %s",
2946 logfd
= open(logfile
, oflags
, 0666);
2948 if (!(oflags
& O_CREAT
) && errno
== ENOENT
)
2951 if ((oflags
& O_CREAT
) && errno
== EISDIR
) {
2952 if (remove_empty_directories(logfile
)) {
2953 return error("There are still logs under '%s'",
2956 logfd
= open(logfile
, oflags
, 0666);
2960 return error("Unable to append to %s: %s",
2961 logfile
, strerror(errno
));
2964 adjust_shared_perm(logfile
);
2969 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
2970 const unsigned char *new_sha1
, const char *msg
)
2972 int logfd
, result
, written
, oflags
= O_APPEND
| O_WRONLY
;
2973 unsigned maxlen
, len
;
2975 char log_file
[PATH_MAX
];
2977 const char *committer
;
2979 if (log_all_ref_updates
< 0)
2980 log_all_ref_updates
= !is_bare_repository();
2982 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
2986 logfd
= open(log_file
, oflags
);
2989 msglen
= msg
? strlen(msg
) : 0;
2990 committer
= git_committer_info(0);
2991 maxlen
= strlen(committer
) + msglen
+ 100;
2992 logrec
= xmalloc(maxlen
);
2993 len
= sprintf(logrec
, "%s %s %s\n",
2994 sha1_to_hex(old_sha1
),
2995 sha1_to_hex(new_sha1
),
2998 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
2999 written
= len
<= maxlen
? write_in_full(logfd
, logrec
, len
) : -1;
3001 if (close(logfd
) != 0 || written
!= len
)
3002 return error("Unable to append to %s", log_file
);
3006 static int is_branch(const char *refname
)
3008 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
3011 int write_ref_sha1(struct ref_lock
*lock
,
3012 const unsigned char *sha1
, const char *logmsg
)
3014 static char term
= '\n';
3019 if (!lock
->force_write
&& !hashcmp(lock
->old_sha1
, sha1
)) {
3023 o
= parse_object(sha1
);
3025 error("Trying to write ref %s with nonexistent object %s",
3026 lock
->ref_name
, sha1_to_hex(sha1
));
3030 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
3031 error("Trying to write non-commit object %s to branch %s",
3032 sha1_to_hex(sha1
), lock
->ref_name
);
3036 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
3037 write_in_full(lock
->lock_fd
, &term
, 1) != 1
3038 || close_ref(lock
) < 0) {
3039 error("Couldn't write %s", lock
->lk
->filename
);
3043 clear_loose_ref_cache(&ref_cache
);
3044 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
3045 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
3046 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
3050 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
3052 * Special hack: If a branch is updated directly and HEAD
3053 * points to it (may happen on the remote side of a push
3054 * for example) then logically the HEAD reflog should be
3056 * A generic solution implies reverse symref information,
3057 * but finding all symrefs pointing to the given branch
3058 * would be rather costly for this rare event (the direct
3059 * update of a branch) to be worth it. So let's cheat and
3060 * check with HEAD only which should cover 99% of all usage
3061 * scenarios (even 100% of the default ones).
3063 unsigned char head_sha1
[20];
3065 const char *head_ref
;
3066 head_ref
= resolve_ref_unsafe("HEAD", head_sha1
, 1, &head_flag
);
3067 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
3068 !strcmp(head_ref
, lock
->ref_name
))
3069 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
3071 if (commit_ref(lock
)) {
3072 error("Couldn't set %s", lock
->ref_name
);
3080 int create_symref(const char *ref_target
, const char *refs_heads_master
,
3083 const char *lockpath
;
3085 int fd
, len
, written
;
3086 char *git_HEAD
= git_pathdup("%s", ref_target
);
3087 unsigned char old_sha1
[20], new_sha1
[20];
3089 if (logmsg
&& read_ref(ref_target
, old_sha1
))
3092 if (safe_create_leading_directories(git_HEAD
) < 0)
3093 return error("unable to create directory for %s", git_HEAD
);
3095 #ifndef NO_SYMLINK_HEAD
3096 if (prefer_symlink_refs
) {
3098 if (!symlink(refs_heads_master
, git_HEAD
))
3100 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
3104 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
3105 if (sizeof(ref
) <= len
) {
3106 error("refname too long: %s", refs_heads_master
);
3107 goto error_free_return
;
3109 lockpath
= mkpath("%s.lock", git_HEAD
);
3110 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
3112 error("Unable to open %s for writing", lockpath
);
3113 goto error_free_return
;
3115 written
= write_in_full(fd
, ref
, len
);
3116 if (close(fd
) != 0 || written
!= len
) {
3117 error("Unable to write to %s", lockpath
);
3118 goto error_unlink_return
;
3120 if (rename(lockpath
, git_HEAD
) < 0) {
3121 error("Unable to create %s", git_HEAD
);
3122 goto error_unlink_return
;
3124 if (adjust_shared_perm(git_HEAD
)) {
3125 error("Unable to fix permissions on %s", lockpath
);
3126 error_unlink_return
:
3127 unlink_or_warn(lockpath
);
3133 #ifndef NO_SYMLINK_HEAD
3136 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
3137 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
3143 static char *ref_msg(const char *line
, const char *endp
)
3147 ep
= memchr(line
, '\n', endp
- line
);
3150 return xmemdupz(line
, ep
- line
);
3153 int read_ref_at(const char *refname
, unsigned long at_time
, int cnt
,
3154 unsigned char *sha1
, char **msg
,
3155 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
3157 const char *logfile
, *logdata
, *logend
, *rec
, *lastgt
, *lastrec
;
3159 int logfd
, tz
, reccnt
= 0;
3162 unsigned char logged_sha1
[20];
3166 logfile
= git_path("logs/%s", refname
);
3167 logfd
= open(logfile
, O_RDONLY
, 0);
3169 die_errno("Unable to read log '%s'", logfile
);
3172 die("Log %s is empty.", logfile
);
3173 mapsz
= xsize_t(st
.st_size
);
3174 log_mapped
= xmmap(NULL
, mapsz
, PROT_READ
, MAP_PRIVATE
, logfd
, 0);
3175 logdata
= log_mapped
;
3179 rec
= logend
= logdata
+ st
.st_size
;
3180 while (logdata
< rec
) {
3182 if (logdata
< rec
&& *(rec
-1) == '\n')
3185 while (logdata
< rec
&& *(rec
-1) != '\n') {
3191 die("Log %s is corrupt.", logfile
);
3192 date
= strtoul(lastgt
+ 1, &tz_c
, 10);
3193 if (date
<= at_time
|| cnt
== 0) {
3194 tz
= strtoul(tz_c
, NULL
, 10);
3196 *msg
= ref_msg(rec
, logend
);
3198 *cutoff_time
= date
;
3202 *cutoff_cnt
= reccnt
- 1;
3204 if (get_sha1_hex(lastrec
, logged_sha1
))
3205 die("Log %s is corrupt.", logfile
);
3206 if (get_sha1_hex(rec
+ 41, sha1
))
3207 die("Log %s is corrupt.", logfile
);
3208 if (hashcmp(logged_sha1
, sha1
)) {
3209 warning("Log %s has gap after %s.",
3210 logfile
, show_date(date
, tz
, DATE_RFC2822
));
3213 else if (date
== at_time
) {
3214 if (get_sha1_hex(rec
+ 41, sha1
))
3215 die("Log %s is corrupt.", logfile
);
3218 if (get_sha1_hex(rec
+ 41, logged_sha1
))
3219 die("Log %s is corrupt.", logfile
);
3220 if (hashcmp(logged_sha1
, sha1
)) {
3221 warning("Log %s unexpectedly ended on %s.",
3222 logfile
, show_date(date
, tz
, DATE_RFC2822
));
3225 munmap(log_mapped
, mapsz
);
3234 while (rec
< logend
&& *rec
!= '>' && *rec
!= '\n')
3236 if (rec
== logend
|| *rec
== '\n')
3237 die("Log %s is corrupt.", logfile
);
3238 date
= strtoul(rec
+ 1, &tz_c
, 10);
3239 tz
= strtoul(tz_c
, NULL
, 10);
3240 if (get_sha1_hex(logdata
, sha1
))
3241 die("Log %s is corrupt.", logfile
);
3242 if (is_null_sha1(sha1
)) {
3243 if (get_sha1_hex(logdata
+ 41, sha1
))
3244 die("Log %s is corrupt.", logfile
);
3247 *msg
= ref_msg(logdata
, logend
);
3248 munmap(log_mapped
, mapsz
);
3251 *cutoff_time
= date
;
3255 *cutoff_cnt
= reccnt
;
3259 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
3261 unsigned char osha1
[20], nsha1
[20];
3262 char *email_end
, *message
;
3263 unsigned long timestamp
;
3266 /* old SP new SP name <email> SP time TAB msg LF */
3267 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
3268 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
3269 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
3270 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
3271 email_end
[1] != ' ' ||
3272 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
3273 !message
|| message
[0] != ' ' ||
3274 (message
[1] != '+' && message
[1] != '-') ||
3275 !isdigit(message
[2]) || !isdigit(message
[3]) ||
3276 !isdigit(message
[4]) || !isdigit(message
[5]))
3277 return 0; /* corrupt? */
3278 email_end
[1] = '\0';
3279 tz
= strtol(message
+ 1, NULL
, 10);
3280 if (message
[6] != '\t')
3284 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
3287 static char *find_beginning_of_line(char *bob
, char *scan
)
3289 while (bob
< scan
&& *(--scan
) != '\n')
3290 ; /* keep scanning backwards */
3292 * Return either beginning of the buffer, or LF at the end of
3293 * the previous line.
3298 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3300 struct strbuf sb
= STRBUF_INIT
;
3303 int ret
= 0, at_tail
= 1;
3305 logfp
= fopen(git_path("logs/%s", refname
), "r");
3309 /* Jump to the end */
3310 if (fseek(logfp
, 0, SEEK_END
) < 0)
3311 return error("cannot seek back reflog for %s: %s",
3312 refname
, strerror(errno
));
3314 while (!ret
&& 0 < pos
) {
3320 /* Fill next block from the end */
3321 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
3322 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
3323 return error("cannot seek back reflog for %s: %s",
3324 refname
, strerror(errno
));
3325 nread
= fread(buf
, cnt
, 1, logfp
);
3327 return error("cannot read %d bytes from reflog for %s: %s",
3328 cnt
, refname
, strerror(errno
));
3331 scanp
= endp
= buf
+ cnt
;
3332 if (at_tail
&& scanp
[-1] == '\n')
3333 /* Looking at the final LF at the end of the file */
3337 while (buf
< scanp
) {
3339 * terminating LF of the previous line, or the beginning
3344 bp
= find_beginning_of_line(buf
, scanp
);
3347 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3349 break; /* need to fill another block */
3350 scanp
= buf
- 1; /* leave loop */
3353 * (bp + 1) thru endp is the beginning of the
3354 * current line we have in sb
3356 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3360 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3368 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3371 strbuf_release(&sb
);
3375 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3378 struct strbuf sb
= STRBUF_INIT
;
3381 logfp
= fopen(git_path("logs/%s", refname
), "r");
3385 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3386 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3388 strbuf_release(&sb
);
3392 * Call fn for each reflog in the namespace indicated by name. name
3393 * must be empty or end with '/'. Name will be used as a scratch
3394 * space, but its contents will be restored before return.
3396 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3398 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3401 int oldlen
= name
->len
;
3404 return name
->len
? errno
: 0;
3406 while ((de
= readdir(d
)) != NULL
) {
3409 if (de
->d_name
[0] == '.')
3411 if (has_extension(de
->d_name
, ".lock"))
3413 strbuf_addstr(name
, de
->d_name
);
3414 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3415 ; /* silently ignore */
3417 if (S_ISDIR(st
.st_mode
)) {
3418 strbuf_addch(name
, '/');
3419 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3421 unsigned char sha1
[20];
3422 if (read_ref_full(name
->buf
, sha1
, 0, NULL
))
3423 retval
= error("bad ref for %s", name
->buf
);
3425 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
3430 strbuf_setlen(name
, oldlen
);
3436 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3440 strbuf_init(&name
, PATH_MAX
);
3441 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3442 strbuf_release(&name
);
3446 static struct ref_lock
*update_ref_lock(const char *refname
,
3447 const unsigned char *oldval
,
3448 int flags
, int *type_p
,
3449 enum action_on_err onerr
)
3451 struct ref_lock
*lock
;
3452 lock
= lock_any_ref_for_update(refname
, oldval
, flags
, type_p
);
3454 const char *str
= "Cannot lock the ref '%s'.";
3456 case UPDATE_REFS_MSG_ON_ERR
: error(str
, refname
); break;
3457 case UPDATE_REFS_DIE_ON_ERR
: die(str
, refname
); break;
3458 case UPDATE_REFS_QUIET_ON_ERR
: break;
3464 static int update_ref_write(const char *action
, const char *refname
,
3465 const unsigned char *sha1
, struct ref_lock
*lock
,
3466 enum action_on_err onerr
)
3468 if (write_ref_sha1(lock
, sha1
, action
) < 0) {
3469 const char *str
= "Cannot update the ref '%s'.";
3471 case UPDATE_REFS_MSG_ON_ERR
: error(str
, refname
); break;
3472 case UPDATE_REFS_DIE_ON_ERR
: die(str
, refname
); break;
3473 case UPDATE_REFS_QUIET_ON_ERR
: break;
3481 * Information needed for a single ref update. Set new_sha1 to the
3482 * new value or to zero to delete the ref. To check the old value
3483 * while locking the ref, set have_old to 1 and set old_sha1 to the
3484 * value or to zero to ensure the ref does not exist before update.
3487 unsigned char new_sha1
[20];
3488 unsigned char old_sha1
[20];
3489 int flags
; /* REF_NODEREF? */
3490 int have_old
; /* 1 if old_sha1 is valid, 0 otherwise */
3491 struct ref_lock
*lock
;
3493 const char refname
[FLEX_ARRAY
];
3497 * Data structure for holding a reference transaction, which can
3498 * consist of checks and updates to multiple references, carried out
3499 * as atomically as possible. This structure is opaque to callers.
3501 struct ref_transaction
{
3502 struct ref_update
**updates
;
3507 struct ref_transaction
*ref_transaction_begin(void)
3509 return xcalloc(1, sizeof(struct ref_transaction
));
3512 static void ref_transaction_free(struct ref_transaction
*transaction
)
3516 for (i
= 0; i
< transaction
->nr
; i
++)
3517 free(transaction
->updates
[i
]);
3519 free(transaction
->updates
);
3523 void ref_transaction_rollback(struct ref_transaction
*transaction
)
3525 ref_transaction_free(transaction
);
3528 static struct ref_update
*add_update(struct ref_transaction
*transaction
,
3529 const char *refname
)
3531 size_t len
= strlen(refname
);
3532 struct ref_update
*update
= xcalloc(1, sizeof(*update
) + len
+ 1);
3534 strcpy((char *)update
->refname
, refname
);
3535 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
3536 transaction
->updates
[transaction
->nr
++] = update
;
3540 void ref_transaction_update(struct ref_transaction
*transaction
,
3541 const char *refname
,
3542 unsigned char *new_sha1
, unsigned char *old_sha1
,
3543 int flags
, int have_old
)
3545 struct ref_update
*update
= add_update(transaction
, refname
);
3547 hashcpy(update
->new_sha1
, new_sha1
);
3548 update
->flags
= flags
;
3549 update
->have_old
= have_old
;
3551 hashcpy(update
->old_sha1
, old_sha1
);
3554 void ref_transaction_create(struct ref_transaction
*transaction
,
3555 const char *refname
,
3556 unsigned char *new_sha1
,
3559 struct ref_update
*update
= add_update(transaction
, refname
);
3561 assert(!is_null_sha1(new_sha1
));
3562 hashcpy(update
->new_sha1
, new_sha1
);
3563 hashclr(update
->old_sha1
);
3564 update
->flags
= flags
;
3565 update
->have_old
= 1;
3568 void ref_transaction_delete(struct ref_transaction
*transaction
,
3569 const char *refname
,
3570 unsigned char *old_sha1
,
3571 int flags
, int have_old
)
3573 struct ref_update
*update
= add_update(transaction
, refname
);
3575 update
->flags
= flags
;
3576 update
->have_old
= have_old
;
3578 assert(!is_null_sha1(old_sha1
));
3579 hashcpy(update
->old_sha1
, old_sha1
);
3583 int update_ref(const char *action
, const char *refname
,
3584 const unsigned char *sha1
, const unsigned char *oldval
,
3585 int flags
, enum action_on_err onerr
)
3587 struct ref_lock
*lock
;
3588 lock
= update_ref_lock(refname
, oldval
, flags
, NULL
, onerr
);
3591 return update_ref_write(action
, refname
, sha1
, lock
, onerr
);
3594 static int ref_update_compare(const void *r1
, const void *r2
)
3596 const struct ref_update
* const *u1
= r1
;
3597 const struct ref_update
* const *u2
= r2
;
3598 return strcmp((*u1
)->refname
, (*u2
)->refname
);
3601 static int ref_update_reject_duplicates(struct ref_update
**updates
, int n
,
3602 enum action_on_err onerr
)
3605 for (i
= 1; i
< n
; i
++)
3606 if (!strcmp(updates
[i
- 1]->refname
, updates
[i
]->refname
)) {
3608 "Multiple updates for ref '%s' not allowed.";
3610 case UPDATE_REFS_MSG_ON_ERR
:
3611 error(str
, updates
[i
]->refname
); break;
3612 case UPDATE_REFS_DIE_ON_ERR
:
3613 die(str
, updates
[i
]->refname
); break;
3614 case UPDATE_REFS_QUIET_ON_ERR
:
3622 int ref_transaction_commit(struct ref_transaction
*transaction
,
3623 const char *msg
, enum action_on_err onerr
)
3625 int ret
= 0, delnum
= 0, i
;
3626 const char **delnames
;
3627 int n
= transaction
->nr
;
3628 struct ref_update
**updates
= transaction
->updates
;
3633 /* Allocate work space */
3634 delnames
= xmalloc(sizeof(*delnames
) * n
);
3636 /* Copy, sort, and reject duplicate refs */
3637 qsort(updates
, n
, sizeof(*updates
), ref_update_compare
);
3638 ret
= ref_update_reject_duplicates(updates
, n
, onerr
);
3642 /* Acquire all locks while verifying old values */
3643 for (i
= 0; i
< n
; i
++) {
3644 struct ref_update
*update
= updates
[i
];
3646 update
->lock
= update_ref_lock(update
->refname
,
3648 update
->old_sha1
: NULL
),
3650 &update
->type
, onerr
);
3651 if (!update
->lock
) {
3657 /* Perform updates first so live commits remain referenced */
3658 for (i
= 0; i
< n
; i
++) {
3659 struct ref_update
*update
= updates
[i
];
3661 if (!is_null_sha1(update
->new_sha1
)) {
3662 ret
= update_ref_write(msg
,
3665 update
->lock
, onerr
);
3666 update
->lock
= NULL
; /* freed by update_ref_write */
3672 /* Perform deletes now that updates are safely completed */
3673 for (i
= 0; i
< n
; i
++) {
3674 struct ref_update
*update
= updates
[i
];
3677 delnames
[delnum
++] = update
->lock
->ref_name
;
3678 ret
|= delete_ref_loose(update
->lock
, update
->type
);
3682 ret
|= repack_without_refs(delnames
, delnum
);
3683 for (i
= 0; i
< delnum
; i
++)
3684 unlink_or_warn(git_path("logs/%s", delnames
[i
]));
3685 clear_loose_ref_cache(&ref_cache
);
3688 for (i
= 0; i
< n
; i
++)
3689 if (updates
[i
]->lock
)
3690 unlock_ref(updates
[i
]->lock
);
3692 ref_transaction_free(transaction
);
3696 char *shorten_unambiguous_ref(const char *refname
, int strict
)
3699 static char **scanf_fmts
;
3700 static int nr_rules
;
3705 * Pre-generate scanf formats from ref_rev_parse_rules[].
3706 * Generate a format suitable for scanf from a
3707 * ref_rev_parse_rules rule by interpolating "%s" at the
3708 * location of the "%.*s".
3710 size_t total_len
= 0;
3713 /* the rule list is NULL terminated, count them first */
3714 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
3715 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3716 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
3718 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
3721 for (i
= 0; i
< nr_rules
; i
++) {
3722 assert(offset
< total_len
);
3723 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
3724 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
3725 ref_rev_parse_rules
[i
], 2, "%s") + 1;
3729 /* bail out if there are no rules */
3731 return xstrdup(refname
);
3733 /* buffer for scanf result, at most refname must fit */
3734 short_name
= xstrdup(refname
);
3736 /* skip first rule, it will always match */
3737 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
3739 int rules_to_fail
= i
;
3742 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
3745 short_name_len
= strlen(short_name
);
3748 * in strict mode, all (except the matched one) rules
3749 * must fail to resolve to a valid non-ambiguous ref
3752 rules_to_fail
= nr_rules
;
3755 * check if the short name resolves to a valid ref,
3756 * but use only rules prior to the matched one
3758 for (j
= 0; j
< rules_to_fail
; j
++) {
3759 const char *rule
= ref_rev_parse_rules
[j
];
3760 char refname
[PATH_MAX
];
3762 /* skip matched rule */
3767 * the short name is ambiguous, if it resolves
3768 * (with this previous rule) to a valid ref
3769 * read_ref() returns 0 on success
3771 mksnpath(refname
, sizeof(refname
),
3772 rule
, short_name_len
, short_name
);
3773 if (ref_exists(refname
))
3778 * short name is non-ambiguous if all previous rules
3779 * haven't resolved to a valid ref
3781 if (j
== rules_to_fail
)
3786 return xstrdup(refname
);
3789 static struct string_list
*hide_refs
;
3791 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
3793 if (!strcmp("transfer.hiderefs", var
) ||
3794 /* NEEDSWORK: use parse_config_key() once both are merged */
3795 (starts_with(var
, section
) && var
[strlen(section
)] == '.' &&
3796 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
3801 return config_error_nonbool(var
);
3802 ref
= xstrdup(value
);
3804 while (len
&& ref
[len
- 1] == '/')
3807 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
3808 hide_refs
->strdup_strings
= 1;
3810 string_list_append(hide_refs
, ref
);
3815 int ref_is_hidden(const char *refname
)
3817 struct string_list_item
*item
;
3821 for_each_string_list_item(item
, hide_refs
) {
3823 if (!starts_with(refname
, item
->string
))
3825 len
= strlen(item
->string
);
3826 if (!refname
[len
] || refname
[len
] == '/')