6 #include "string-list.h"
9 * Make sure "ref" is something reasonable to have under ".git/refs/";
10 * We do not like it if:
12 * - any path component of it begins with ".", or
13 * - it has double dots "..", or
14 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
15 * - it ends with a "/".
16 * - it ends with ".lock"
17 * - it contains a "\" (backslash)
20 /* Return true iff ch is not allowed in reference names. */
21 static inline int bad_ref_char(int ch
)
23 if (((unsigned) ch
) <= ' ' || ch
== 0x7f ||
24 ch
== '~' || ch
== '^' || ch
== ':' || ch
== '\\')
26 /* 2.13 Pattern Matching Notation */
27 if (ch
== '*' || ch
== '?' || ch
== '[') /* Unsupported */
33 * Try to read one refname component from the front of refname. Return
34 * the length of the component found, or -1 if the component is not
37 static int check_refname_component(const char *refname
, int flags
)
42 for (cp
= refname
; ; cp
++) {
44 if (ch
== '\0' || ch
== '/')
47 return -1; /* Illegal character in refname. */
48 if (last
== '.' && ch
== '.')
49 return -1; /* Refname contains "..". */
50 if (last
== '@' && ch
== '{')
51 return -1; /* Refname contains "@{". */
55 return 0; /* Component has zero length. */
56 if (refname
[0] == '.') {
57 if (!(flags
& REFNAME_DOT_COMPONENT
))
58 return -1; /* Component starts with '.'. */
60 * Even if leading dots are allowed, don't allow "."
61 * as a component (".." is prevented by a rule above).
63 if (refname
[1] == '\0')
64 return -1; /* Component equals ".". */
66 if (cp
- refname
>= 5 && !memcmp(cp
- 5, ".lock", 5))
67 return -1; /* Refname ends with ".lock". */
71 int check_refname_format(const char *refname
, int flags
)
73 int component_len
, component_count
= 0;
75 if (!strcmp(refname
, "@"))
76 /* Refname is a single character '@'. */
80 /* We are at the start of a path component. */
81 component_len
= check_refname_component(refname
, flags
);
82 if (component_len
<= 0) {
83 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
85 (refname
[1] == '\0' || refname
[1] == '/')) {
86 /* Accept one wildcard as a full refname component. */
87 flags
&= ~REFNAME_REFSPEC_PATTERN
;
94 if (refname
[component_len
] == '\0')
96 /* Skip to next component. */
97 refname
+= component_len
+ 1;
100 if (refname
[component_len
- 1] == '.')
101 return -1; /* Refname ends with '.'. */
102 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
103 return -1; /* Refname has only one component. */
110 * Information used (along with the information in ref_entry) to
111 * describe a single cached reference. This data structure only
112 * occurs embedded in a union in struct ref_entry, and only when
113 * (ref_entry->flag & REF_DIR) is zero.
117 * The name of the object to which this reference resolves
118 * (which may be a tag object). If REF_ISBROKEN, this is
119 * null. If REF_ISSYMREF, then this is the name of the object
120 * referred to by the last reference in the symlink chain.
122 unsigned char sha1
[20];
125 * If REF_KNOWS_PEELED, then this field holds the peeled value
126 * of this reference, or null if the reference is known not to
127 * be peelable. See the documentation for peel_ref() for an
128 * exact definition of "peelable".
130 unsigned char peeled
[20];
136 * Information used (along with the information in ref_entry) to
137 * describe a level in the hierarchy of references. This data
138 * structure only occurs embedded in a union in struct ref_entry, and
139 * only when (ref_entry.flag & REF_DIR) is set. In that case,
140 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
141 * in the directory have already been read:
143 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
144 * or packed references, already read.
146 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
147 * references that hasn't been read yet (nor has any of its
150 * Entries within a directory are stored within a growable array of
151 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
152 * sorted are sorted by their component name in strcmp() order and the
153 * remaining entries are unsorted.
155 * Loose references are read lazily, one directory at a time. When a
156 * directory of loose references is read, then all of the references
157 * in that directory are stored, and REF_INCOMPLETE stubs are created
158 * for any subdirectories, but the subdirectories themselves are not
159 * read. The reading is triggered by get_ref_dir().
165 * Entries with index 0 <= i < sorted are sorted by name. New
166 * entries are appended to the list unsorted, and are sorted
167 * only when required; thus we avoid the need to sort the list
168 * after the addition of every reference.
172 /* A pointer to the ref_cache that contains this ref_dir. */
173 struct ref_cache
*ref_cache
;
175 struct ref_entry
**entries
;
179 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
180 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
185 * The field ref_entry->u.value.peeled of this value entry contains
186 * the correct peeled value for the reference, which might be
187 * null_sha1 if the reference is not a tag or if it is broken.
189 #define REF_KNOWS_PEELED 0x08
191 /* ref_entry represents a directory of references */
195 * Entry has not yet been read from disk (used only for REF_DIR
196 * entries representing loose references)
198 #define REF_INCOMPLETE 0x20
201 * A ref_entry represents either a reference or a "subdirectory" of
204 * Each directory in the reference namespace is represented by a
205 * ref_entry with (flags & REF_DIR) set and containing a subdir member
206 * that holds the entries in that directory that have been read so
207 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
208 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
209 * used for loose reference directories.
211 * References are represented by a ref_entry with (flags & REF_DIR)
212 * unset and a value member that describes the reference's value. The
213 * flag member is at the ref_entry level, but it is also needed to
214 * interpret the contents of the value field (in other words, a
215 * ref_value object is not very much use without the enclosing
218 * Reference names cannot end with slash and directories' names are
219 * always stored with a trailing slash (except for the top-level
220 * directory, which is always denoted by ""). This has two nice
221 * consequences: (1) when the entries in each subdir are sorted
222 * lexicographically by name (as they usually are), the references in
223 * a whole tree can be generated in lexicographic order by traversing
224 * the tree in left-to-right, depth-first order; (2) the names of
225 * references and subdirectories cannot conflict, and therefore the
226 * presence of an empty subdirectory does not block the creation of a
227 * similarly-named reference. (The fact that reference names with the
228 * same leading components can conflict *with each other* is a
229 * separate issue that is regulated by is_refname_available().)
231 * Please note that the name field contains the fully-qualified
232 * reference (or subdirectory) name. Space could be saved by only
233 * storing the relative names. But that would require the full names
234 * to be generated on the fly when iterating in do_for_each_ref(), and
235 * would break callback functions, who have always been able to assume
236 * that the name strings that they are passed will not be freed during
240 unsigned char flag
; /* ISSYMREF? ISPACKED? */
242 struct ref_value value
; /* if not (flags&REF_DIR) */
243 struct ref_dir subdir
; /* if (flags&REF_DIR) */
246 * The full name of the reference (e.g., "refs/heads/master")
247 * or the full name of the directory with a trailing slash
248 * (e.g., "refs/heads/"):
250 char name
[FLEX_ARRAY
];
253 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
);
255 static struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
258 assert(entry
->flag
& REF_DIR
);
259 dir
= &entry
->u
.subdir
;
260 if (entry
->flag
& REF_INCOMPLETE
) {
261 read_loose_refs(entry
->name
, dir
);
262 entry
->flag
&= ~REF_INCOMPLETE
;
267 static struct ref_entry
*create_ref_entry(const char *refname
,
268 const unsigned char *sha1
, int flag
,
272 struct ref_entry
*ref
;
275 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
|REFNAME_DOT_COMPONENT
))
276 die("Reference has invalid format: '%s'", refname
);
277 len
= strlen(refname
) + 1;
278 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
279 hashcpy(ref
->u
.value
.sha1
, sha1
);
280 hashclr(ref
->u
.value
.peeled
);
281 memcpy(ref
->name
, refname
, len
);
286 static void clear_ref_dir(struct ref_dir
*dir
);
288 static void free_ref_entry(struct ref_entry
*entry
)
290 if (entry
->flag
& REF_DIR
) {
292 * Do not use get_ref_dir() here, as that might
293 * trigger the reading of loose refs.
295 clear_ref_dir(&entry
->u
.subdir
);
301 * Add a ref_entry to the end of dir (unsorted). Entry is always
302 * stored directly in dir; no recursion into subdirectories is
305 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
307 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
308 dir
->entries
[dir
->nr
++] = entry
;
309 /* optimize for the case that entries are added in order */
311 (dir
->nr
== dir
->sorted
+ 1 &&
312 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
313 dir
->entries
[dir
->nr
- 1]->name
) < 0))
314 dir
->sorted
= dir
->nr
;
318 * Clear and free all entries in dir, recursively.
320 static void clear_ref_dir(struct ref_dir
*dir
)
323 for (i
= 0; i
< dir
->nr
; i
++)
324 free_ref_entry(dir
->entries
[i
]);
326 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
331 * Create a struct ref_entry object for the specified dirname.
332 * dirname is the name of the directory with a trailing slash (e.g.,
333 * "refs/heads/") or "" for the top-level directory.
335 static struct ref_entry
*create_dir_entry(struct ref_cache
*ref_cache
,
336 const char *dirname
, size_t len
,
339 struct ref_entry
*direntry
;
340 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
341 memcpy(direntry
->name
, dirname
, len
);
342 direntry
->name
[len
] = '\0';
343 direntry
->u
.subdir
.ref_cache
= ref_cache
;
344 direntry
->flag
= REF_DIR
| (incomplete
? REF_INCOMPLETE
: 0);
348 static int ref_entry_cmp(const void *a
, const void *b
)
350 struct ref_entry
*one
= *(struct ref_entry
**)a
;
351 struct ref_entry
*two
= *(struct ref_entry
**)b
;
352 return strcmp(one
->name
, two
->name
);
355 static void sort_ref_dir(struct ref_dir
*dir
);
357 struct string_slice
{
362 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
364 const struct string_slice
*key
= key_
;
365 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
366 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
369 return '\0' - (unsigned char)ent
->name
[key
->len
];
373 * Return the index of the entry with the given refname from the
374 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
375 * no such entry is found. dir must already be complete.
377 static int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
379 struct ref_entry
**r
;
380 struct string_slice key
;
382 if (refname
== NULL
|| !dir
->nr
)
388 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
389 ref_entry_cmp_sslice
);
394 return r
- dir
->entries
;
398 * Search for a directory entry directly within dir (without
399 * recursing). Sort dir if necessary. subdirname must be a directory
400 * name (i.e., end in '/'). If mkdir is set, then create the
401 * directory if it is missing; otherwise, return NULL if the desired
402 * directory cannot be found. dir must already be complete.
404 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
405 const char *subdirname
, size_t len
,
408 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
409 struct ref_entry
*entry
;
410 if (entry_index
== -1) {
414 * Since dir is complete, the absence of a subdir
415 * means that the subdir really doesn't exist;
416 * therefore, create an empty record for it but mark
417 * the record complete.
419 entry
= create_dir_entry(dir
->ref_cache
, subdirname
, len
, 0);
420 add_entry_to_dir(dir
, entry
);
422 entry
= dir
->entries
[entry_index
];
424 return get_ref_dir(entry
);
428 * If refname is a reference name, find the ref_dir within the dir
429 * tree that should hold refname. If refname is a directory name
430 * (i.e., ends in '/'), then return that ref_dir itself. dir must
431 * represent the top-level directory and must already be complete.
432 * Sort ref_dirs and recurse into subdirectories as necessary. If
433 * mkdir is set, then create any missing directories; otherwise,
434 * return NULL if the desired directory cannot be found.
436 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
437 const char *refname
, int mkdir
)
440 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
441 size_t dirnamelen
= slash
- refname
+ 1;
442 struct ref_dir
*subdir
;
443 subdir
= search_for_subdir(dir
, refname
, dirnamelen
, mkdir
);
455 * Find the value entry with the given name in dir, sorting ref_dirs
456 * and recursing into subdirectories as necessary. If the name is not
457 * found or it corresponds to a directory entry, return NULL.
459 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
462 struct ref_entry
*entry
;
463 dir
= find_containing_dir(dir
, refname
, 0);
466 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
467 if (entry_index
== -1)
469 entry
= dir
->entries
[entry_index
];
470 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
474 * Remove the entry with the given name from dir, recursing into
475 * subdirectories as necessary. If refname is the name of a directory
476 * (i.e., ends with '/'), then remove the directory and its contents.
477 * If the removal was successful, return the number of entries
478 * remaining in the directory entry that contained the deleted entry.
479 * If the name was not found, return -1. Please note that this
480 * function only deletes the entry from the cache; it does not delete
481 * it from the filesystem or ensure that other cache entries (which
482 * might be symbolic references to the removed entry) are updated.
483 * Nor does it remove any containing dir entries that might be made
484 * empty by the removal. dir must represent the top-level directory
485 * and must already be complete.
487 static int remove_entry(struct ref_dir
*dir
, const char *refname
)
489 int refname_len
= strlen(refname
);
491 struct ref_entry
*entry
;
492 int is_dir
= refname
[refname_len
- 1] == '/';
495 * refname represents a reference directory. Remove
496 * the trailing slash; otherwise we will get the
497 * directory *representing* refname rather than the
498 * one *containing* it.
500 char *dirname
= xmemdupz(refname
, refname_len
- 1);
501 dir
= find_containing_dir(dir
, dirname
, 0);
504 dir
= find_containing_dir(dir
, refname
, 0);
508 entry_index
= search_ref_dir(dir
, refname
, refname_len
);
509 if (entry_index
== -1)
511 entry
= dir
->entries
[entry_index
];
513 memmove(&dir
->entries
[entry_index
],
514 &dir
->entries
[entry_index
+ 1],
515 (dir
->nr
- entry_index
- 1) * sizeof(*dir
->entries
)
518 if (dir
->sorted
> entry_index
)
520 free_ref_entry(entry
);
525 * Add a ref_entry to the ref_dir (unsorted), recursing into
526 * subdirectories as necessary. dir must represent the top-level
527 * directory. Return 0 on success.
529 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
531 dir
= find_containing_dir(dir
, ref
->name
, 1);
534 add_entry_to_dir(dir
, ref
);
539 * Emit a warning and return true iff ref1 and ref2 have the same name
540 * and the same sha1. Die if they have the same name but different
543 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
545 if (strcmp(ref1
->name
, ref2
->name
))
548 /* Duplicate name; make sure that they don't conflict: */
550 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
551 /* This is impossible by construction */
552 die("Reference directory conflict: %s", ref1
->name
);
554 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
555 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
557 warning("Duplicated ref: %s", ref1
->name
);
562 * Sort the entries in dir non-recursively (if they are not already
563 * sorted) and remove any duplicate entries.
565 static void sort_ref_dir(struct ref_dir
*dir
)
568 struct ref_entry
*last
= NULL
;
571 * This check also prevents passing a zero-length array to qsort(),
572 * which is a problem on some platforms.
574 if (dir
->sorted
== dir
->nr
)
577 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
579 /* Remove any duplicates: */
580 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
581 struct ref_entry
*entry
= dir
->entries
[j
];
582 if (last
&& is_dup_ref(last
, entry
))
583 free_ref_entry(entry
);
585 last
= dir
->entries
[i
++] = entry
;
587 dir
->sorted
= dir
->nr
= i
;
590 /* Include broken references in a do_for_each_ref*() iteration: */
591 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
594 * Return true iff the reference described by entry can be resolved to
595 * an object in the database. Emit a warning if the referred-to
596 * object does not exist.
598 static int ref_resolves_to_object(struct ref_entry
*entry
)
600 if (entry
->flag
& REF_ISBROKEN
)
602 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
603 error("%s does not point to a valid object!", entry
->name
);
610 * current_ref is a performance hack: when iterating over references
611 * using the for_each_ref*() functions, current_ref is set to the
612 * current reference's entry before calling the callback function. If
613 * the callback function calls peel_ref(), then peel_ref() first
614 * checks whether the reference to be peeled is the current reference
615 * (it usually is) and if so, returns that reference's peeled version
616 * if it is available. This avoids a refname lookup in a common case.
618 static struct ref_entry
*current_ref
;
620 typedef int each_ref_entry_fn(struct ref_entry
*entry
, void *cb_data
);
622 struct ref_entry_cb
{
631 * Handle one reference in a do_for_each_ref*()-style iteration,
632 * calling an each_ref_fn for each entry.
634 static int do_one_ref(struct ref_entry
*entry
, void *cb_data
)
636 struct ref_entry_cb
*data
= cb_data
;
638 if (prefixcmp(entry
->name
, data
->base
))
641 if (!(data
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
642 !ref_resolves_to_object(entry
))
646 retval
= data
->fn(entry
->name
+ data
->trim
, entry
->u
.value
.sha1
,
647 entry
->flag
, data
->cb_data
);
653 * Call fn for each reference in dir that has index in the range
654 * offset <= index < dir->nr. Recurse into subdirectories that are in
655 * that index range, sorting them before iterating. This function
656 * does not sort dir itself; it should be sorted beforehand. fn is
657 * called for all references, including broken ones.
659 static int do_for_each_entry_in_dir(struct ref_dir
*dir
, int offset
,
660 each_ref_entry_fn fn
, void *cb_data
)
663 assert(dir
->sorted
== dir
->nr
);
664 for (i
= offset
; i
< dir
->nr
; i
++) {
665 struct ref_entry
*entry
= dir
->entries
[i
];
667 if (entry
->flag
& REF_DIR
) {
668 struct ref_dir
*subdir
= get_ref_dir(entry
);
669 sort_ref_dir(subdir
);
670 retval
= do_for_each_entry_in_dir(subdir
, 0, fn
, cb_data
);
672 retval
= fn(entry
, cb_data
);
681 * Call fn for each reference in the union of dir1 and dir2, in order
682 * by refname. Recurse into subdirectories. If a value entry appears
683 * in both dir1 and dir2, then only process the version that is in
684 * dir2. The input dirs must already be sorted, but subdirs will be
685 * sorted as needed. fn is called for all references, including
688 static int do_for_each_entry_in_dirs(struct ref_dir
*dir1
,
689 struct ref_dir
*dir2
,
690 each_ref_entry_fn fn
, void *cb_data
)
695 assert(dir1
->sorted
== dir1
->nr
);
696 assert(dir2
->sorted
== dir2
->nr
);
698 struct ref_entry
*e1
, *e2
;
700 if (i1
== dir1
->nr
) {
701 return do_for_each_entry_in_dir(dir2
, i2
, fn
, cb_data
);
703 if (i2
== dir2
->nr
) {
704 return do_for_each_entry_in_dir(dir1
, i1
, fn
, cb_data
);
706 e1
= dir1
->entries
[i1
];
707 e2
= dir2
->entries
[i2
];
708 cmp
= strcmp(e1
->name
, e2
->name
);
710 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
711 /* Both are directories; descend them in parallel. */
712 struct ref_dir
*subdir1
= get_ref_dir(e1
);
713 struct ref_dir
*subdir2
= get_ref_dir(e2
);
714 sort_ref_dir(subdir1
);
715 sort_ref_dir(subdir2
);
716 retval
= do_for_each_entry_in_dirs(
717 subdir1
, subdir2
, fn
, cb_data
);
720 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
721 /* Both are references; ignore the one from dir1. */
722 retval
= fn(e2
, cb_data
);
726 die("conflict between reference and directory: %s",
738 if (e
->flag
& REF_DIR
) {
739 struct ref_dir
*subdir
= get_ref_dir(e
);
740 sort_ref_dir(subdir
);
741 retval
= do_for_each_entry_in_dir(
742 subdir
, 0, fn
, cb_data
);
744 retval
= fn(e
, cb_data
);
753 * Return true iff refname1 and refname2 conflict with each other.
754 * Two reference names conflict if one of them exactly matches the
755 * leading components of the other; e.g., "foo/bar" conflicts with
756 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
759 static int names_conflict(const char *refname1
, const char *refname2
)
761 for (; *refname1
&& *refname1
== *refname2
; refname1
++, refname2
++)
763 return (*refname1
== '\0' && *refname2
== '/')
764 || (*refname1
== '/' && *refname2
== '\0');
767 struct name_conflict_cb
{
769 const char *oldrefname
;
770 const char *conflicting_refname
;
773 static int name_conflict_fn(struct ref_entry
*entry
, void *cb_data
)
775 struct name_conflict_cb
*data
= (struct name_conflict_cb
*)cb_data
;
776 if (data
->oldrefname
&& !strcmp(data
->oldrefname
, entry
->name
))
778 if (names_conflict(data
->refname
, entry
->name
)) {
779 data
->conflicting_refname
= entry
->name
;
786 * Return true iff a reference named refname could be created without
787 * conflicting with the name of an existing reference in dir. If
788 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
789 * (e.g., because oldrefname is scheduled for deletion in the same
792 static int is_refname_available(const char *refname
, const char *oldrefname
,
795 struct name_conflict_cb data
;
796 data
.refname
= refname
;
797 data
.oldrefname
= oldrefname
;
798 data
.conflicting_refname
= NULL
;
801 if (do_for_each_entry_in_dir(dir
, 0, name_conflict_fn
, &data
)) {
802 error("'%s' exists; cannot create '%s'",
803 data
.conflicting_refname
, refname
);
809 struct packed_ref_cache
{
810 struct ref_entry
*root
;
813 * Count of references to the data structure in this instance,
814 * including the pointer from ref_cache::packed if any. The
815 * data will not be freed as long as the reference count is
818 unsigned int referrers
;
821 * Iff the packed-refs file associated with this instance is
822 * currently locked for writing, this points at the associated
823 * lock (which is owned by somebody else). The referrer count
824 * is also incremented when the file is locked and decremented
825 * when it is unlocked.
827 struct lock_file
*lock
;
829 /* The metadata from when this packed-refs cache was read */
830 struct stat_validity validity
;
834 * Future: need to be in "struct repository"
835 * when doing a full libification.
837 static struct ref_cache
{
838 struct ref_cache
*next
;
839 struct ref_entry
*loose
;
840 struct packed_ref_cache
*packed
;
842 * The submodule name, or "" for the main repo. We allocate
843 * length 1 rather than FLEX_ARRAY so that the main ref_cache
844 * is initialized correctly.
847 } ref_cache
, *submodule_ref_caches
;
849 /* Lock used for the main packed-refs file: */
850 static struct lock_file packlock
;
853 * Increment the reference count of *packed_refs.
855 static void acquire_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
857 packed_refs
->referrers
++;
861 * Decrease the reference count of *packed_refs. If it goes to zero,
862 * free *packed_refs and return true; otherwise return false.
864 static int release_packed_ref_cache(struct packed_ref_cache
*packed_refs
)
866 if (!--packed_refs
->referrers
) {
867 free_ref_entry(packed_refs
->root
);
868 stat_validity_clear(&packed_refs
->validity
);
876 static void clear_packed_ref_cache(struct ref_cache
*refs
)
879 struct packed_ref_cache
*packed_refs
= refs
->packed
;
881 if (packed_refs
->lock
)
882 die("internal error: packed-ref cache cleared while locked");
884 release_packed_ref_cache(packed_refs
);
888 static void clear_loose_ref_cache(struct ref_cache
*refs
)
891 free_ref_entry(refs
->loose
);
896 static struct ref_cache
*create_ref_cache(const char *submodule
)
899 struct ref_cache
*refs
;
902 len
= strlen(submodule
) + 1;
903 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
904 memcpy(refs
->name
, submodule
, len
);
909 * Return a pointer to a ref_cache for the specified submodule. For
910 * the main repository, use submodule==NULL. The returned structure
911 * will be allocated and initialized but not necessarily populated; it
912 * should not be freed.
914 static struct ref_cache
*get_ref_cache(const char *submodule
)
916 struct ref_cache
*refs
;
918 if (!submodule
|| !*submodule
)
921 for (refs
= submodule_ref_caches
; refs
; refs
= refs
->next
)
922 if (!strcmp(submodule
, refs
->name
))
925 refs
= create_ref_cache(submodule
);
926 refs
->next
= submodule_ref_caches
;
927 submodule_ref_caches
= refs
;
931 void invalidate_ref_cache(const char *submodule
)
933 struct ref_cache
*refs
= get_ref_cache(submodule
);
934 clear_packed_ref_cache(refs
);
935 clear_loose_ref_cache(refs
);
938 /* The length of a peeled reference line in packed-refs, including EOL: */
939 #define PEELED_LINE_LENGTH 42
942 * The packed-refs header line that we write out. Perhaps other
943 * traits will be added later. The trailing space is required.
945 static const char PACKED_REFS_HEADER
[] =
946 "# pack-refs with: peeled fully-peeled \n";
949 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
950 * Return a pointer to the refname within the line (null-terminated),
951 * or NULL if there was a problem.
953 static const char *parse_ref_line(char *line
, unsigned char *sha1
)
956 * 42: the answer to everything.
958 * In this case, it happens to be the answer to
959 * 40 (length of sha1 hex representation)
960 * +1 (space in between hex and name)
961 * +1 (newline at the end of the line)
963 int len
= strlen(line
) - 42;
967 if (get_sha1_hex(line
, sha1
) < 0)
969 if (!isspace(line
[40]))
974 if (line
[len
] != '\n')
982 * Read f, which is a packed-refs file, into dir.
984 * A comment line of the form "# pack-refs with: " may contain zero or
985 * more traits. We interpret the traits as follows:
989 * Probably no references are peeled. But if the file contains a
990 * peeled value for a reference, we will use it.
994 * References under "refs/tags/", if they *can* be peeled, *are*
995 * peeled in this file. References outside of "refs/tags/" are
996 * probably not peeled even if they could have been, but if we find
997 * a peeled value for such a reference we will use it.
1001 * All references in the file that can be peeled are peeled.
1002 * Inversely (and this is more important), any references in the
1003 * file for which no peeled value is recorded is not peelable. This
1004 * trait should typically be written alongside "peeled" for
1005 * compatibility with older clients, but we do not require it
1006 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1008 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
1010 struct ref_entry
*last
= NULL
;
1011 char refline
[PATH_MAX
];
1012 enum { PEELED_NONE
, PEELED_TAGS
, PEELED_FULLY
} peeled
= PEELED_NONE
;
1014 while (fgets(refline
, sizeof(refline
), f
)) {
1015 unsigned char sha1
[20];
1016 const char *refname
;
1017 static const char header
[] = "# pack-refs with:";
1019 if (!strncmp(refline
, header
, sizeof(header
)-1)) {
1020 const char *traits
= refline
+ sizeof(header
) - 1;
1021 if (strstr(traits
, " fully-peeled "))
1022 peeled
= PEELED_FULLY
;
1023 else if (strstr(traits
, " peeled "))
1024 peeled
= PEELED_TAGS
;
1025 /* perhaps other traits later as well */
1029 refname
= parse_ref_line(refline
, sha1
);
1031 last
= create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1);
1032 if (peeled
== PEELED_FULLY
||
1033 (peeled
== PEELED_TAGS
&& !prefixcmp(refname
, "refs/tags/")))
1034 last
->flag
|= REF_KNOWS_PEELED
;
1039 refline
[0] == '^' &&
1040 strlen(refline
) == PEELED_LINE_LENGTH
&&
1041 refline
[PEELED_LINE_LENGTH
- 1] == '\n' &&
1042 !get_sha1_hex(refline
+ 1, sha1
)) {
1043 hashcpy(last
->u
.value
.peeled
, sha1
);
1045 * Regardless of what the file header said,
1046 * we definitely know the value of *this*
1049 last
->flag
|= REF_KNOWS_PEELED
;
1055 * Get the packed_ref_cache for the specified ref_cache, creating it
1058 static struct packed_ref_cache
*get_packed_ref_cache(struct ref_cache
*refs
)
1060 const char *packed_refs_file
;
1063 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
1065 packed_refs_file
= git_path("packed-refs");
1068 !stat_validity_check(&refs
->packed
->validity
, packed_refs_file
))
1069 clear_packed_ref_cache(refs
);
1071 if (!refs
->packed
) {
1074 refs
->packed
= xcalloc(1, sizeof(*refs
->packed
));
1075 acquire_packed_ref_cache(refs
->packed
);
1076 refs
->packed
->root
= create_dir_entry(refs
, "", 0, 0);
1077 f
= fopen(packed_refs_file
, "r");
1079 stat_validity_update(&refs
->packed
->validity
, fileno(f
));
1080 read_packed_refs(f
, get_ref_dir(refs
->packed
->root
));
1084 return refs
->packed
;
1087 static struct ref_dir
*get_packed_ref_dir(struct packed_ref_cache
*packed_ref_cache
)
1089 return get_ref_dir(packed_ref_cache
->root
);
1092 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
1094 return get_packed_ref_dir(get_packed_ref_cache(refs
));
1097 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
1099 struct packed_ref_cache
*packed_ref_cache
=
1100 get_packed_ref_cache(&ref_cache
);
1102 if (!packed_ref_cache
->lock
)
1103 die("internal error: packed refs not locked");
1104 add_ref(get_packed_ref_dir(packed_ref_cache
),
1105 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
1109 * Read the loose references from the namespace dirname into dir
1110 * (without recursing). dirname must end with '/'. dir must be the
1111 * directory entry corresponding to dirname.
1113 static void read_loose_refs(const char *dirname
, struct ref_dir
*dir
)
1115 struct ref_cache
*refs
= dir
->ref_cache
;
1119 int dirnamelen
= strlen(dirname
);
1120 struct strbuf refname
;
1123 path
= git_path_submodule(refs
->name
, "%s", dirname
);
1125 path
= git_path("%s", dirname
);
1131 strbuf_init(&refname
, dirnamelen
+ 257);
1132 strbuf_add(&refname
, dirname
, dirnamelen
);
1134 while ((de
= readdir(d
)) != NULL
) {
1135 unsigned char sha1
[20];
1140 if (de
->d_name
[0] == '.')
1142 if (has_extension(de
->d_name
, ".lock"))
1144 strbuf_addstr(&refname
, de
->d_name
);
1145 refdir
= *refs
->name
1146 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
1147 : git_path("%s", refname
.buf
);
1148 if (stat(refdir
, &st
) < 0) {
1149 ; /* silently ignore */
1150 } else if (S_ISDIR(st
.st_mode
)) {
1151 strbuf_addch(&refname
, '/');
1152 add_entry_to_dir(dir
,
1153 create_dir_entry(refs
, refname
.buf
,
1159 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
1161 flag
|= REF_ISBROKEN
;
1163 } else if (read_ref_full(refname
.buf
, sha1
, 1, &flag
)) {
1165 flag
|= REF_ISBROKEN
;
1167 add_entry_to_dir(dir
,
1168 create_ref_entry(refname
.buf
, sha1
, flag
, 1));
1170 strbuf_setlen(&refname
, dirnamelen
);
1172 strbuf_release(&refname
);
1176 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
1180 * Mark the top-level directory complete because we
1181 * are about to read the only subdirectory that can
1184 refs
->loose
= create_dir_entry(refs
, "", 0, 0);
1186 * Create an incomplete entry for "refs/":
1188 add_entry_to_dir(get_ref_dir(refs
->loose
),
1189 create_dir_entry(refs
, "refs/", 5, 1));
1191 return get_ref_dir(refs
->loose
);
1194 /* We allow "recursive" symbolic refs. Only within reason, though */
1196 #define MAXREFLEN (1024)
1199 * Called by resolve_gitlink_ref_recursive() after it failed to read
1200 * from the loose refs in ref_cache refs. Find <refname> in the
1201 * packed-refs file for the submodule.
1203 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
1204 const char *refname
, unsigned char *sha1
)
1206 struct ref_entry
*ref
;
1207 struct ref_dir
*dir
= get_packed_refs(refs
);
1209 ref
= find_ref(dir
, refname
);
1213 memcpy(sha1
, ref
->u
.value
.sha1
, 20);
1217 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
1218 const char *refname
, unsigned char *sha1
,
1222 char buffer
[128], *p
;
1225 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
1228 ? git_path_submodule(refs
->name
, "%s", refname
)
1229 : git_path("%s", refname
);
1230 fd
= open(path
, O_RDONLY
);
1232 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
1234 len
= read(fd
, buffer
, sizeof(buffer
)-1);
1238 while (len
&& isspace(buffer
[len
-1]))
1242 /* Was it a detached head or an old-fashioned symlink? */
1243 if (!get_sha1_hex(buffer
, sha1
))
1247 if (strncmp(buffer
, "ref:", 4))
1253 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
1256 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
1258 int len
= strlen(path
), retval
;
1260 struct ref_cache
*refs
;
1262 while (len
&& path
[len
-1] == '/')
1266 submodule
= xstrndup(path
, len
);
1267 refs
= get_ref_cache(submodule
);
1270 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
1275 * Return the ref_entry for the given refname from the packed
1276 * references. If it does not exist, return NULL.
1278 static struct ref_entry
*get_packed_ref(const char *refname
)
1280 return find_ref(get_packed_refs(&ref_cache
), refname
);
1283 const char *resolve_ref_unsafe(const char *refname
, unsigned char *sha1
, int reading
, int *flag
)
1285 int depth
= MAXDEPTH
;
1288 static char refname_buffer
[256];
1293 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
1297 char path
[PATH_MAX
];
1305 git_snpath(path
, sizeof(path
), "%s", refname
);
1307 if (lstat(path
, &st
) < 0) {
1308 struct ref_entry
*entry
;
1310 if (errno
!= ENOENT
)
1313 * The loose reference file does not exist;
1314 * check for a packed reference.
1316 entry
= get_packed_ref(refname
);
1318 hashcpy(sha1
, entry
->u
.value
.sha1
);
1320 *flag
|= REF_ISPACKED
;
1323 /* The reference is not a packed reference, either. */
1332 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1333 if (S_ISLNK(st
.st_mode
)) {
1334 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1338 if (!prefixcmp(buffer
, "refs/") &&
1339 !check_refname_format(buffer
, 0)) {
1340 strcpy(refname_buffer
, buffer
);
1341 refname
= refname_buffer
;
1343 *flag
|= REF_ISSYMREF
;
1348 /* Is it a directory? */
1349 if (S_ISDIR(st
.st_mode
)) {
1355 * Anything else, just open it and try to use it as
1358 fd
= open(path
, O_RDONLY
);
1361 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1365 while (len
&& isspace(buffer
[len
-1]))
1370 * Is it a symbolic ref?
1372 if (prefixcmp(buffer
, "ref:"))
1375 *flag
|= REF_ISSYMREF
;
1377 while (isspace(*buf
))
1379 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1381 *flag
|= REF_ISBROKEN
;
1384 refname
= strcpy(refname_buffer
, buf
);
1386 /* Please note that FETCH_HEAD has a second line containing other data. */
1387 if (get_sha1_hex(buffer
, sha1
) || (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1389 *flag
|= REF_ISBROKEN
;
1395 char *resolve_refdup(const char *ref
, unsigned char *sha1
, int reading
, int *flag
)
1397 const char *ret
= resolve_ref_unsafe(ref
, sha1
, reading
, flag
);
1398 return ret
? xstrdup(ret
) : NULL
;
1401 /* The argument to filter_refs */
1403 const char *pattern
;
1408 int read_ref_full(const char *refname
, unsigned char *sha1
, int reading
, int *flags
)
1410 if (resolve_ref_unsafe(refname
, sha1
, reading
, flags
))
1415 int read_ref(const char *refname
, unsigned char *sha1
)
1417 return read_ref_full(refname
, sha1
, 1, NULL
);
1420 int ref_exists(const char *refname
)
1422 unsigned char sha1
[20];
1423 return !!resolve_ref_unsafe(refname
, sha1
, 1, NULL
);
1426 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1429 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1430 if (fnmatch(filter
->pattern
, refname
, 0))
1432 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1436 /* object was peeled successfully: */
1440 * object cannot be peeled because the named object (or an
1441 * object referred to by a tag in the peel chain), does not
1446 /* object cannot be peeled because it is not a tag: */
1449 /* ref_entry contains no peeled value because it is a symref: */
1450 PEEL_IS_SYMREF
= -3,
1453 * ref_entry cannot be peeled because it is broken (i.e., the
1454 * symbolic reference cannot even be resolved to an object
1461 * Peel the named object; i.e., if the object is a tag, resolve the
1462 * tag recursively until a non-tag is found. If successful, store the
1463 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1464 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1465 * and leave sha1 unchanged.
1467 static enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
1469 struct object
*o
= lookup_unknown_object(name
);
1471 if (o
->type
== OBJ_NONE
) {
1472 int type
= sha1_object_info(name
, NULL
);
1474 return PEEL_INVALID
;
1478 if (o
->type
!= OBJ_TAG
)
1479 return PEEL_NON_TAG
;
1481 o
= deref_tag_noverify(o
);
1483 return PEEL_INVALID
;
1485 hashcpy(sha1
, o
->sha1
);
1490 * Peel the entry (if possible) and return its new peel_status. If
1491 * repeel is true, re-peel the entry even if there is an old peeled
1492 * value that is already stored in it.
1494 * It is OK to call this function with a packed reference entry that
1495 * might be stale and might even refer to an object that has since
1496 * been garbage-collected. In such a case, if the entry has
1497 * REF_KNOWS_PEELED then leave the status unchanged and return
1498 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1500 static enum peel_status
peel_entry(struct ref_entry
*entry
, int repeel
)
1502 enum peel_status status
;
1504 if (entry
->flag
& REF_KNOWS_PEELED
) {
1506 entry
->flag
&= ~REF_KNOWS_PEELED
;
1507 hashclr(entry
->u
.value
.peeled
);
1509 return is_null_sha1(entry
->u
.value
.peeled
) ?
1510 PEEL_NON_TAG
: PEEL_PEELED
;
1513 if (entry
->flag
& REF_ISBROKEN
)
1515 if (entry
->flag
& REF_ISSYMREF
)
1516 return PEEL_IS_SYMREF
;
1518 status
= peel_object(entry
->u
.value
.sha1
, entry
->u
.value
.peeled
);
1519 if (status
== PEEL_PEELED
|| status
== PEEL_NON_TAG
)
1520 entry
->flag
|= REF_KNOWS_PEELED
;
1524 int peel_ref(const char *refname
, unsigned char *sha1
)
1527 unsigned char base
[20];
1529 if (current_ref
&& (current_ref
->name
== refname
1530 || !strcmp(current_ref
->name
, refname
))) {
1531 if (peel_entry(current_ref
, 0))
1533 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1537 if (read_ref_full(refname
, base
, 1, &flag
))
1541 * If the reference is packed, read its ref_entry from the
1542 * cache in the hope that we already know its peeled value.
1543 * We only try this optimization on packed references because
1544 * (a) forcing the filling of the loose reference cache could
1545 * be expensive and (b) loose references anyway usually do not
1546 * have REF_KNOWS_PEELED.
1548 if (flag
& REF_ISPACKED
) {
1549 struct ref_entry
*r
= get_packed_ref(refname
);
1551 if (peel_entry(r
, 0))
1553 hashcpy(sha1
, r
->u
.value
.peeled
);
1558 return peel_object(base
, sha1
);
1561 struct warn_if_dangling_data
{
1563 const char *refname
;
1564 const char *msg_fmt
;
1567 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1568 int flags
, void *cb_data
)
1570 struct warn_if_dangling_data
*d
= cb_data
;
1571 const char *resolves_to
;
1572 unsigned char junk
[20];
1574 if (!(flags
& REF_ISSYMREF
))
1577 resolves_to
= resolve_ref_unsafe(refname
, junk
, 0, NULL
);
1578 if (!resolves_to
|| strcmp(resolves_to
, d
->refname
))
1581 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1586 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1588 struct warn_if_dangling_data data
;
1591 data
.refname
= refname
;
1592 data
.msg_fmt
= msg_fmt
;
1593 for_each_rawref(warn_if_dangling_symref
, &data
);
1597 * Call fn for each reference in the specified ref_cache, omitting
1598 * references not in the containing_dir of base. fn is called for all
1599 * references, including broken ones. If fn ever returns a non-zero
1600 * value, stop the iteration and return that value; otherwise, return
1603 static int do_for_each_entry(struct ref_cache
*refs
, const char *base
,
1604 each_ref_entry_fn fn
, void *cb_data
)
1606 struct packed_ref_cache
*packed_ref_cache
= get_packed_ref_cache(refs
);
1607 struct ref_dir
*packed_dir
= get_packed_ref_dir(packed_ref_cache
);
1608 struct ref_dir
*loose_dir
= get_loose_refs(refs
);
1611 acquire_packed_ref_cache(packed_ref_cache
);
1612 if (base
&& *base
) {
1613 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1614 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1617 if (packed_dir
&& loose_dir
) {
1618 sort_ref_dir(packed_dir
);
1619 sort_ref_dir(loose_dir
);
1620 retval
= do_for_each_entry_in_dirs(
1621 packed_dir
, loose_dir
, fn
, cb_data
);
1622 } else if (packed_dir
) {
1623 sort_ref_dir(packed_dir
);
1624 retval
= do_for_each_entry_in_dir(
1625 packed_dir
, 0, fn
, cb_data
);
1626 } else if (loose_dir
) {
1627 sort_ref_dir(loose_dir
);
1628 retval
= do_for_each_entry_in_dir(
1629 loose_dir
, 0, fn
, cb_data
);
1632 release_packed_ref_cache(packed_ref_cache
);
1637 * Call fn for each reference in the specified ref_cache for which the
1638 * refname begins with base. If trim is non-zero, then trim that many
1639 * characters off the beginning of each refname before passing the
1640 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1641 * broken references in the iteration. If fn ever returns a non-zero
1642 * value, stop the iteration and return that value; otherwise, return
1645 static int do_for_each_ref(struct ref_cache
*refs
, const char *base
,
1646 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1648 struct ref_entry_cb data
;
1653 data
.cb_data
= cb_data
;
1655 return do_for_each_entry(refs
, base
, do_one_ref
, &data
);
1658 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1660 unsigned char sha1
[20];
1664 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1665 return fn("HEAD", sha1
, 0, cb_data
);
1670 if (!read_ref_full("HEAD", sha1
, 1, &flag
))
1671 return fn("HEAD", sha1
, flag
, cb_data
);
1676 int head_ref(each_ref_fn fn
, void *cb_data
)
1678 return do_head_ref(NULL
, fn
, cb_data
);
1681 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1683 return do_head_ref(submodule
, fn
, cb_data
);
1686 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1688 return do_for_each_ref(&ref_cache
, "", fn
, 0, 0, cb_data
);
1691 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1693 return do_for_each_ref(get_ref_cache(submodule
), "", fn
, 0, 0, cb_data
);
1696 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1698 return do_for_each_ref(&ref_cache
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1701 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
1702 each_ref_fn fn
, void *cb_data
)
1704 return do_for_each_ref(get_ref_cache(submodule
), prefix
, fn
, strlen(prefix
), 0, cb_data
);
1707 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
1709 return for_each_ref_in("refs/tags/", fn
, cb_data
);
1712 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1714 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
1717 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
1719 return for_each_ref_in("refs/heads/", fn
, cb_data
);
1722 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1724 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
1727 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
1729 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
1732 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1734 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
1737 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1739 return do_for_each_ref(&ref_cache
, "refs/replace/", fn
, 13, 0, cb_data
);
1742 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
1744 struct strbuf buf
= STRBUF_INIT
;
1746 unsigned char sha1
[20];
1749 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
1750 if (!read_ref_full(buf
.buf
, sha1
, 1, &flag
))
1751 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
1752 strbuf_release(&buf
);
1757 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1759 struct strbuf buf
= STRBUF_INIT
;
1761 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1762 ret
= do_for_each_ref(&ref_cache
, buf
.buf
, fn
, 0, 0, cb_data
);
1763 strbuf_release(&buf
);
1767 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
1768 const char *prefix
, void *cb_data
)
1770 struct strbuf real_pattern
= STRBUF_INIT
;
1771 struct ref_filter filter
;
1774 if (!prefix
&& prefixcmp(pattern
, "refs/"))
1775 strbuf_addstr(&real_pattern
, "refs/");
1777 strbuf_addstr(&real_pattern
, prefix
);
1778 strbuf_addstr(&real_pattern
, pattern
);
1780 if (!has_glob_specials(pattern
)) {
1781 /* Append implied '/' '*' if not present. */
1782 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
1783 strbuf_addch(&real_pattern
, '/');
1784 /* No need to check for '*', there is none. */
1785 strbuf_addch(&real_pattern
, '*');
1788 filter
.pattern
= real_pattern
.buf
;
1790 filter
.cb_data
= cb_data
;
1791 ret
= for_each_ref(filter_refs
, &filter
);
1793 strbuf_release(&real_pattern
);
1797 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
1799 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
1802 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1804 return do_for_each_ref(&ref_cache
, "", fn
, 0,
1805 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1808 const char *prettify_refname(const char *name
)
1811 !prefixcmp(name
, "refs/heads/") ? 11 :
1812 !prefixcmp(name
, "refs/tags/") ? 10 :
1813 !prefixcmp(name
, "refs/remotes/") ? 13 :
1817 const char *ref_rev_parse_rules
[] = {
1822 "refs/remotes/%.*s",
1823 "refs/remotes/%.*s/HEAD",
1827 int refname_match(const char *abbrev_name
, const char *full_name
, const char **rules
)
1830 const int abbrev_name_len
= strlen(abbrev_name
);
1832 for (p
= rules
; *p
; p
++) {
1833 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
1841 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
1842 const unsigned char *old_sha1
, int mustexist
)
1844 if (read_ref_full(lock
->ref_name
, lock
->old_sha1
, mustexist
, NULL
)) {
1845 error("Can't verify ref %s", lock
->ref_name
);
1849 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
1850 error("Ref %s is at %s but expected %s", lock
->ref_name
,
1851 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
1858 static int remove_empty_directories(const char *file
)
1860 /* we want to create a file but there is a directory there;
1861 * if that is an empty directory (or a directory that contains
1862 * only empty directories), remove them.
1867 strbuf_init(&path
, 20);
1868 strbuf_addstr(&path
, file
);
1870 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
1872 strbuf_release(&path
);
1878 * *string and *len will only be substituted, and *string returned (for
1879 * later free()ing) if the string passed in is a magic short-hand form
1882 static char *substitute_branch_name(const char **string
, int *len
)
1884 struct strbuf buf
= STRBUF_INIT
;
1885 int ret
= interpret_branch_name(*string
, &buf
);
1889 *string
= strbuf_detach(&buf
, &size
);
1891 return (char *)*string
;
1897 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
1899 char *last_branch
= substitute_branch_name(&str
, &len
);
1904 for (p
= ref_rev_parse_rules
; *p
; p
++) {
1905 char fullref
[PATH_MAX
];
1906 unsigned char sha1_from_ref
[20];
1907 unsigned char *this_result
;
1910 this_result
= refs_found
? sha1_from_ref
: sha1
;
1911 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
1912 r
= resolve_ref_unsafe(fullref
, this_result
, 1, &flag
);
1916 if (!warn_ambiguous_refs
)
1918 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
1919 warning("ignoring dangling symref %s.", fullref
);
1920 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
1921 warning("ignoring broken ref %s.", fullref
);
1928 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
1930 char *last_branch
= substitute_branch_name(&str
, &len
);
1935 for (p
= ref_rev_parse_rules
; *p
; p
++) {
1937 unsigned char hash
[20];
1938 char path
[PATH_MAX
];
1939 const char *ref
, *it
;
1941 mksnpath(path
, sizeof(path
), *p
, len
, str
);
1942 ref
= resolve_ref_unsafe(path
, hash
, 1, NULL
);
1945 if (!stat(git_path("logs/%s", path
), &st
) &&
1946 S_ISREG(st
.st_mode
))
1948 else if (strcmp(ref
, path
) &&
1949 !stat(git_path("logs/%s", ref
), &st
) &&
1950 S_ISREG(st
.st_mode
))
1954 if (!logs_found
++) {
1956 hashcpy(sha1
, hash
);
1958 if (!warn_ambiguous_refs
)
1965 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
1966 const unsigned char *old_sha1
,
1967 int flags
, int *type_p
)
1970 const char *orig_refname
= refname
;
1971 struct ref_lock
*lock
;
1974 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
1977 lock
= xcalloc(1, sizeof(struct ref_lock
));
1980 refname
= resolve_ref_unsafe(refname
, lock
->old_sha1
, mustexist
, &type
);
1981 if (!refname
&& errno
== EISDIR
) {
1982 /* we are trying to lock foo but we used to
1983 * have foo/bar which now does not exist;
1984 * it is normal for the empty directory 'foo'
1987 ref_file
= git_path("%s", orig_refname
);
1988 if (remove_empty_directories(ref_file
)) {
1990 error("there are still refs under '%s'", orig_refname
);
1993 refname
= resolve_ref_unsafe(orig_refname
, lock
->old_sha1
, mustexist
, &type
);
1999 error("unable to resolve reference %s: %s",
2000 orig_refname
, strerror(errno
));
2003 missing
= is_null_sha1(lock
->old_sha1
);
2004 /* When the ref did not exist and we are creating it,
2005 * make sure there is no existing ref that is packed
2006 * whose name begins with our refname, nor a ref whose
2007 * name is a proper prefix of our refname.
2010 !is_refname_available(refname
, NULL
, get_packed_refs(&ref_cache
))) {
2011 last_errno
= ENOTDIR
;
2015 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
2017 lflags
= LOCK_DIE_ON_ERROR
;
2018 if (flags
& REF_NODEREF
) {
2019 refname
= orig_refname
;
2020 lflags
|= LOCK_NODEREF
;
2022 lock
->ref_name
= xstrdup(refname
);
2023 lock
->orig_ref_name
= xstrdup(orig_refname
);
2024 ref_file
= git_path("%s", refname
);
2026 lock
->force_write
= 1;
2027 if ((flags
& REF_NODEREF
) && (type
& REF_ISSYMREF
))
2028 lock
->force_write
= 1;
2030 if (safe_create_leading_directories(ref_file
)) {
2032 error("unable to create directory for %s", ref_file
);
2036 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
2037 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
2045 struct ref_lock
*lock_ref_sha1(const char *refname
, const unsigned char *old_sha1
)
2047 char refpath
[PATH_MAX
];
2048 if (check_refname_format(refname
, 0))
2050 strcpy(refpath
, mkpath("refs/%s", refname
));
2051 return lock_ref_sha1_basic(refpath
, old_sha1
, 0, NULL
);
2054 struct ref_lock
*lock_any_ref_for_update(const char *refname
,
2055 const unsigned char *old_sha1
, int flags
)
2057 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
2059 return lock_ref_sha1_basic(refname
, old_sha1
, flags
, NULL
);
2063 * Write an entry to the packed-refs file for the specified refname.
2064 * If peeled is non-NULL, write it as the entry's peeled value.
2066 static void write_packed_entry(int fd
, char *refname
, unsigned char *sha1
,
2067 unsigned char *peeled
)
2069 char line
[PATH_MAX
+ 100];
2072 len
= snprintf(line
, sizeof(line
), "%s %s\n",
2073 sha1_to_hex(sha1
), refname
);
2074 /* this should not happen but just being defensive */
2075 if (len
> sizeof(line
))
2076 die("too long a refname '%s'", refname
);
2077 write_or_die(fd
, line
, len
);
2080 if (snprintf(line
, sizeof(line
), "^%s\n",
2081 sha1_to_hex(peeled
)) != PEELED_LINE_LENGTH
)
2082 die("internal error");
2083 write_or_die(fd
, line
, PEELED_LINE_LENGTH
);
2088 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2090 static int write_packed_entry_fn(struct ref_entry
*entry
, void *cb_data
)
2093 enum peel_status peel_status
= peel_entry(entry
, 0);
2095 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2096 error("internal error: %s is not a valid packed reference!",
2098 write_packed_entry(*fd
, entry
->name
, entry
->u
.value
.sha1
,
2099 peel_status
== PEEL_PEELED
?
2100 entry
->u
.value
.peeled
: NULL
);
2104 int lock_packed_refs(int flags
)
2106 struct packed_ref_cache
*packed_ref_cache
;
2108 /* Discard the old cache because it might be invalid: */
2109 clear_packed_ref_cache(&ref_cache
);
2110 if (hold_lock_file_for_update(&packlock
, git_path("packed-refs"), flags
) < 0)
2112 /* Read the current packed-refs while holding the lock: */
2113 packed_ref_cache
= get_packed_ref_cache(&ref_cache
);
2114 packed_ref_cache
->lock
= &packlock
;
2115 /* Increment the reference count to prevent it from being freed: */
2116 acquire_packed_ref_cache(packed_ref_cache
);
2120 int commit_packed_refs(void)
2122 struct packed_ref_cache
*packed_ref_cache
=
2123 get_packed_ref_cache(&ref_cache
);
2126 if (!packed_ref_cache
->lock
)
2127 die("internal error: packed-refs not locked");
2128 write_or_die(packed_ref_cache
->lock
->fd
,
2129 PACKED_REFS_HEADER
, strlen(PACKED_REFS_HEADER
));
2131 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache
),
2132 0, write_packed_entry_fn
,
2133 &packed_ref_cache
->lock
->fd
);
2134 if (commit_lock_file(packed_ref_cache
->lock
))
2136 packed_ref_cache
->lock
= NULL
;
2137 release_packed_ref_cache(packed_ref_cache
);
2141 void rollback_packed_refs(void)
2143 struct packed_ref_cache
*packed_ref_cache
=
2144 get_packed_ref_cache(&ref_cache
);
2146 if (!packed_ref_cache
->lock
)
2147 die("internal error: packed-refs not locked");
2148 rollback_lock_file(packed_ref_cache
->lock
);
2149 packed_ref_cache
->lock
= NULL
;
2150 release_packed_ref_cache(packed_ref_cache
);
2151 clear_packed_ref_cache(&ref_cache
);
2154 struct ref_to_prune
{
2155 struct ref_to_prune
*next
;
2156 unsigned char sha1
[20];
2157 char name
[FLEX_ARRAY
];
2160 struct pack_refs_cb_data
{
2162 struct ref_dir
*packed_refs
;
2163 struct ref_to_prune
*ref_to_prune
;
2167 * An each_ref_entry_fn that is run over loose references only. If
2168 * the loose reference can be packed, add an entry in the packed ref
2169 * cache. If the reference should be pruned, also add it to
2170 * ref_to_prune in the pack_refs_cb_data.
2172 static int pack_if_possible_fn(struct ref_entry
*entry
, void *cb_data
)
2174 struct pack_refs_cb_data
*cb
= cb_data
;
2175 enum peel_status peel_status
;
2176 struct ref_entry
*packed_entry
;
2177 int is_tag_ref
= !prefixcmp(entry
->name
, "refs/tags/");
2179 /* ALWAYS pack tags */
2180 if (!(cb
->flags
& PACK_REFS_ALL
) && !is_tag_ref
)
2183 /* Do not pack symbolic or broken refs: */
2184 if ((entry
->flag
& REF_ISSYMREF
) || !ref_resolves_to_object(entry
))
2187 /* Add a packed ref cache entry equivalent to the loose entry. */
2188 peel_status
= peel_entry(entry
, 1);
2189 if (peel_status
!= PEEL_PEELED
&& peel_status
!= PEEL_NON_TAG
)
2190 die("internal error peeling reference %s (%s)",
2191 entry
->name
, sha1_to_hex(entry
->u
.value
.sha1
));
2192 packed_entry
= find_ref(cb
->packed_refs
, entry
->name
);
2194 /* Overwrite existing packed entry with info from loose entry */
2195 packed_entry
->flag
= REF_ISPACKED
| REF_KNOWS_PEELED
;
2196 hashcpy(packed_entry
->u
.value
.sha1
, entry
->u
.value
.sha1
);
2198 packed_entry
= create_ref_entry(entry
->name
, entry
->u
.value
.sha1
,
2199 REF_ISPACKED
| REF_KNOWS_PEELED
, 0);
2200 add_ref(cb
->packed_refs
, packed_entry
);
2202 hashcpy(packed_entry
->u
.value
.peeled
, entry
->u
.value
.peeled
);
2204 /* Schedule the loose reference for pruning if requested. */
2205 if ((cb
->flags
& PACK_REFS_PRUNE
)) {
2206 int namelen
= strlen(entry
->name
) + 1;
2207 struct ref_to_prune
*n
= xcalloc(1, sizeof(*n
) + namelen
);
2208 hashcpy(n
->sha1
, entry
->u
.value
.sha1
);
2209 strcpy(n
->name
, entry
->name
);
2210 n
->next
= cb
->ref_to_prune
;
2211 cb
->ref_to_prune
= n
;
2217 * Remove empty parents, but spare refs/ and immediate subdirs.
2218 * Note: munges *name.
2220 static void try_remove_empty_parents(char *name
)
2225 for (i
= 0; i
< 2; i
++) { /* refs/{heads,tags,...}/ */
2226 while (*p
&& *p
!= '/')
2228 /* tolerate duplicate slashes; see check_refname_format() */
2232 for (q
= p
; *q
; q
++)
2235 while (q
> p
&& *q
!= '/')
2237 while (q
> p
&& *(q
-1) == '/')
2242 if (rmdir(git_path("%s", name
)))
2247 /* make sure nobody touched the ref, and unlink */
2248 static void prune_ref(struct ref_to_prune
*r
)
2250 struct ref_lock
*lock
= lock_ref_sha1(r
->name
+ 5, r
->sha1
);
2253 unlink_or_warn(git_path("%s", r
->name
));
2255 try_remove_empty_parents(r
->name
);
2259 static void prune_refs(struct ref_to_prune
*r
)
2267 int pack_refs(unsigned int flags
)
2269 struct pack_refs_cb_data cbdata
;
2271 memset(&cbdata
, 0, sizeof(cbdata
));
2272 cbdata
.flags
= flags
;
2274 lock_packed_refs(LOCK_DIE_ON_ERROR
);
2275 cbdata
.packed_refs
= get_packed_refs(&ref_cache
);
2277 do_for_each_entry_in_dir(get_loose_refs(&ref_cache
), 0,
2278 pack_if_possible_fn
, &cbdata
);
2280 if (commit_packed_refs())
2281 die_errno("unable to overwrite old ref-pack file");
2283 prune_refs(cbdata
.ref_to_prune
);
2288 * If entry is no longer needed in packed-refs, add it to the string
2289 * list pointed to by cb_data. Reasons for deleting entries:
2291 * - Entry is broken.
2292 * - Entry is overridden by a loose ref.
2293 * - Entry does not point at a valid object.
2295 * In the first and third cases, also emit an error message because these
2296 * are indications of repository corruption.
2298 static int curate_packed_ref_fn(struct ref_entry
*entry
, void *cb_data
)
2300 struct string_list
*refs_to_delete
= cb_data
;
2302 if (entry
->flag
& REF_ISBROKEN
) {
2303 /* This shouldn't happen to packed refs. */
2304 error("%s is broken!", entry
->name
);
2305 string_list_append(refs_to_delete
, entry
->name
);
2308 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
2309 unsigned char sha1
[20];
2312 if (read_ref_full(entry
->name
, sha1
, 0, &flags
))
2313 /* We should at least have found the packed ref. */
2314 die("Internal error");
2315 if ((flags
& REF_ISSYMREF
) || !(flags
& REF_ISPACKED
)) {
2317 * This packed reference is overridden by a
2318 * loose reference, so it is OK that its value
2319 * is no longer valid; for example, it might
2320 * refer to an object that has been garbage
2321 * collected. For this purpose we don't even
2322 * care whether the loose reference itself is
2323 * invalid, broken, symbolic, etc. Silently
2324 * remove the packed reference.
2326 string_list_append(refs_to_delete
, entry
->name
);
2330 * There is no overriding loose reference, so the fact
2331 * that this reference doesn't refer to a valid object
2332 * indicates some kind of repository corruption.
2333 * Report the problem, then omit the reference from
2336 error("%s does not point to a valid object!", entry
->name
);
2337 string_list_append(refs_to_delete
, entry
->name
);
2344 static int repack_without_ref(const char *refname
)
2346 struct ref_dir
*packed
;
2347 struct string_list refs_to_delete
= STRING_LIST_INIT_DUP
;
2348 struct string_list_item
*ref_to_delete
;
2350 if (!get_packed_ref(refname
))
2351 return 0; /* refname does not exist in packed refs */
2353 if (lock_packed_refs(0)) {
2354 unable_to_lock_error(git_path("packed-refs"), errno
);
2355 return error("cannot delete '%s' from packed refs", refname
);
2357 packed
= get_packed_refs(&ref_cache
);
2359 /* Remove refname from the cache: */
2360 if (remove_entry(packed
, refname
) == -1) {
2362 * The packed entry disappeared while we were
2363 * acquiring the lock.
2365 rollback_packed_refs();
2369 /* Remove any other accumulated cruft: */
2370 do_for_each_entry_in_dir(packed
, 0, curate_packed_ref_fn
, &refs_to_delete
);
2371 for_each_string_list_item(ref_to_delete
, &refs_to_delete
) {
2372 if (remove_entry(packed
, ref_to_delete
->string
) == -1)
2373 die("internal error");
2376 /* Write what remains: */
2377 return commit_packed_refs();
2380 int delete_ref(const char *refname
, const unsigned char *sha1
, int delopt
)
2382 struct ref_lock
*lock
;
2383 int err
, i
= 0, ret
= 0, flag
= 0;
2385 lock
= lock_ref_sha1_basic(refname
, sha1
, delopt
, &flag
);
2388 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
2390 i
= strlen(lock
->lk
->filename
) - 5; /* .lock */
2391 lock
->lk
->filename
[i
] = 0;
2392 err
= unlink_or_warn(lock
->lk
->filename
);
2393 if (err
&& errno
!= ENOENT
)
2396 lock
->lk
->filename
[i
] = '.';
2398 /* removing the loose one could have resurrected an earlier
2399 * packed one. Also, if it was not loose we need to repack
2402 ret
|= repack_without_ref(lock
->ref_name
);
2404 unlink_or_warn(git_path("logs/%s", lock
->ref_name
));
2405 clear_loose_ref_cache(&ref_cache
);
2411 * People using contrib's git-new-workdir have .git/logs/refs ->
2412 * /some/other/path/.git/logs/refs, and that may live on another device.
2414 * IOW, to avoid cross device rename errors, the temporary renamed log must
2415 * live into logs/refs.
2417 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2419 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
2421 unsigned char sha1
[20], orig_sha1
[20];
2422 int flag
= 0, logmoved
= 0;
2423 struct ref_lock
*lock
;
2424 struct stat loginfo
;
2425 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
2426 const char *symref
= NULL
;
2428 if (log
&& S_ISLNK(loginfo
.st_mode
))
2429 return error("reflog for %s is a symlink", oldrefname
);
2431 symref
= resolve_ref_unsafe(oldrefname
, orig_sha1
, 1, &flag
);
2432 if (flag
& REF_ISSYMREF
)
2433 return error("refname %s is a symbolic ref, renaming it is not supported",
2436 return error("refname %s not found", oldrefname
);
2438 if (!is_refname_available(newrefname
, oldrefname
, get_packed_refs(&ref_cache
)))
2441 if (!is_refname_available(newrefname
, oldrefname
, get_loose_refs(&ref_cache
)))
2444 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
2445 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
2446 oldrefname
, strerror(errno
));
2448 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
2449 error("unable to delete old %s", oldrefname
);
2453 if (!read_ref_full(newrefname
, sha1
, 1, &flag
) &&
2454 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
2455 if (errno
==EISDIR
) {
2456 if (remove_empty_directories(git_path("%s", newrefname
))) {
2457 error("Directory not empty: %s", newrefname
);
2461 error("unable to delete existing %s", newrefname
);
2466 if (log
&& safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
2467 error("unable to create directory for %s", newrefname
);
2472 if (log
&& rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
2473 if (errno
==EISDIR
|| errno
==ENOTDIR
) {
2475 * rename(a, b) when b is an existing
2476 * directory ought to result in ISDIR, but
2477 * Solaris 5.8 gives ENOTDIR. Sheesh.
2479 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
2480 error("Directory not empty: logs/%s", newrefname
);
2485 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
2486 newrefname
, strerror(errno
));
2492 lock
= lock_ref_sha1_basic(newrefname
, NULL
, 0, NULL
);
2494 error("unable to lock %s for update", newrefname
);
2497 lock
->force_write
= 1;
2498 hashcpy(lock
->old_sha1
, orig_sha1
);
2499 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
2500 error("unable to write current sha1 into %s", newrefname
);
2507 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, 0, NULL
);
2509 error("unable to lock %s for rollback", oldrefname
);
2513 lock
->force_write
= 1;
2514 flag
= log_all_ref_updates
;
2515 log_all_ref_updates
= 0;
2516 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
2517 error("unable to write current sha1 into %s", oldrefname
);
2518 log_all_ref_updates
= flag
;
2521 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
2522 error("unable to restore logfile %s from %s: %s",
2523 oldrefname
, newrefname
, strerror(errno
));
2524 if (!logmoved
&& log
&&
2525 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
2526 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
2527 oldrefname
, strerror(errno
));
2532 int close_ref(struct ref_lock
*lock
)
2534 if (close_lock_file(lock
->lk
))
2540 int commit_ref(struct ref_lock
*lock
)
2542 if (commit_lock_file(lock
->lk
))
2548 void unlock_ref(struct ref_lock
*lock
)
2550 /* Do not free lock->lk -- atexit() still looks at them */
2552 rollback_lock_file(lock
->lk
);
2553 free(lock
->ref_name
);
2554 free(lock
->orig_ref_name
);
2559 * copy the reflog message msg to buf, which has been allocated sufficiently
2560 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2561 * because reflog file is one line per entry.
2563 static int copy_msg(char *buf
, const char *msg
)
2570 while ((c
= *msg
++)) {
2571 if (wasspace
&& isspace(c
))
2573 wasspace
= isspace(c
);
2578 while (buf
< cp
&& isspace(cp
[-1]))
2584 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
2586 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
2588 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
2589 if (log_all_ref_updates
&&
2590 (!prefixcmp(refname
, "refs/heads/") ||
2591 !prefixcmp(refname
, "refs/remotes/") ||
2592 !prefixcmp(refname
, "refs/notes/") ||
2593 !strcmp(refname
, "HEAD"))) {
2594 if (safe_create_leading_directories(logfile
) < 0)
2595 return error("unable to create directory for %s",
2600 logfd
= open(logfile
, oflags
, 0666);
2602 if (!(oflags
& O_CREAT
) && errno
== ENOENT
)
2605 if ((oflags
& O_CREAT
) && errno
== EISDIR
) {
2606 if (remove_empty_directories(logfile
)) {
2607 return error("There are still logs under '%s'",
2610 logfd
= open(logfile
, oflags
, 0666);
2614 return error("Unable to append to %s: %s",
2615 logfile
, strerror(errno
));
2618 adjust_shared_perm(logfile
);
2623 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
2624 const unsigned char *new_sha1
, const char *msg
)
2626 int logfd
, result
, written
, oflags
= O_APPEND
| O_WRONLY
;
2627 unsigned maxlen
, len
;
2629 char log_file
[PATH_MAX
];
2631 const char *committer
;
2633 if (log_all_ref_updates
< 0)
2634 log_all_ref_updates
= !is_bare_repository();
2636 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
2640 logfd
= open(log_file
, oflags
);
2643 msglen
= msg
? strlen(msg
) : 0;
2644 committer
= git_committer_info(0);
2645 maxlen
= strlen(committer
) + msglen
+ 100;
2646 logrec
= xmalloc(maxlen
);
2647 len
= sprintf(logrec
, "%s %s %s\n",
2648 sha1_to_hex(old_sha1
),
2649 sha1_to_hex(new_sha1
),
2652 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
2653 written
= len
<= maxlen
? write_in_full(logfd
, logrec
, len
) : -1;
2655 if (close(logfd
) != 0 || written
!= len
)
2656 return error("Unable to append to %s", log_file
);
2660 static int is_branch(const char *refname
)
2662 return !strcmp(refname
, "HEAD") || !prefixcmp(refname
, "refs/heads/");
2665 int write_ref_sha1(struct ref_lock
*lock
,
2666 const unsigned char *sha1
, const char *logmsg
)
2668 static char term
= '\n';
2673 if (!lock
->force_write
&& !hashcmp(lock
->old_sha1
, sha1
)) {
2677 o
= parse_object(sha1
);
2679 error("Trying to write ref %s with nonexistent object %s",
2680 lock
->ref_name
, sha1_to_hex(sha1
));
2684 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
2685 error("Trying to write non-commit object %s to branch %s",
2686 sha1_to_hex(sha1
), lock
->ref_name
);
2690 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
2691 write_in_full(lock
->lock_fd
, &term
, 1) != 1
2692 || close_ref(lock
) < 0) {
2693 error("Couldn't write %s", lock
->lk
->filename
);
2697 clear_loose_ref_cache(&ref_cache
);
2698 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
2699 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
2700 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
2704 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
2706 * Special hack: If a branch is updated directly and HEAD
2707 * points to it (may happen on the remote side of a push
2708 * for example) then logically the HEAD reflog should be
2710 * A generic solution implies reverse symref information,
2711 * but finding all symrefs pointing to the given branch
2712 * would be rather costly for this rare event (the direct
2713 * update of a branch) to be worth it. So let's cheat and
2714 * check with HEAD only which should cover 99% of all usage
2715 * scenarios (even 100% of the default ones).
2717 unsigned char head_sha1
[20];
2719 const char *head_ref
;
2720 head_ref
= resolve_ref_unsafe("HEAD", head_sha1
, 1, &head_flag
);
2721 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
2722 !strcmp(head_ref
, lock
->ref_name
))
2723 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
2725 if (commit_ref(lock
)) {
2726 error("Couldn't set %s", lock
->ref_name
);
2734 int create_symref(const char *ref_target
, const char *refs_heads_master
,
2737 const char *lockpath
;
2739 int fd
, len
, written
;
2740 char *git_HEAD
= git_pathdup("%s", ref_target
);
2741 unsigned char old_sha1
[20], new_sha1
[20];
2743 if (logmsg
&& read_ref(ref_target
, old_sha1
))
2746 if (safe_create_leading_directories(git_HEAD
) < 0)
2747 return error("unable to create directory for %s", git_HEAD
);
2749 #ifndef NO_SYMLINK_HEAD
2750 if (prefer_symlink_refs
) {
2752 if (!symlink(refs_heads_master
, git_HEAD
))
2754 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
2758 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
2759 if (sizeof(ref
) <= len
) {
2760 error("refname too long: %s", refs_heads_master
);
2761 goto error_free_return
;
2763 lockpath
= mkpath("%s.lock", git_HEAD
);
2764 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
2766 error("Unable to open %s for writing", lockpath
);
2767 goto error_free_return
;
2769 written
= write_in_full(fd
, ref
, len
);
2770 if (close(fd
) != 0 || written
!= len
) {
2771 error("Unable to write to %s", lockpath
);
2772 goto error_unlink_return
;
2774 if (rename(lockpath
, git_HEAD
) < 0) {
2775 error("Unable to create %s", git_HEAD
);
2776 goto error_unlink_return
;
2778 if (adjust_shared_perm(git_HEAD
)) {
2779 error("Unable to fix permissions on %s", lockpath
);
2780 error_unlink_return
:
2781 unlink_or_warn(lockpath
);
2787 #ifndef NO_SYMLINK_HEAD
2790 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
2791 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
2797 static char *ref_msg(const char *line
, const char *endp
)
2801 ep
= memchr(line
, '\n', endp
- line
);
2804 return xmemdupz(line
, ep
- line
);
2807 int read_ref_at(const char *refname
, unsigned long at_time
, int cnt
,
2808 unsigned char *sha1
, char **msg
,
2809 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
2811 const char *logfile
, *logdata
, *logend
, *rec
, *lastgt
, *lastrec
;
2813 int logfd
, tz
, reccnt
= 0;
2816 unsigned char logged_sha1
[20];
2820 logfile
= git_path("logs/%s", refname
);
2821 logfd
= open(logfile
, O_RDONLY
, 0);
2823 die_errno("Unable to read log '%s'", logfile
);
2826 die("Log %s is empty.", logfile
);
2827 mapsz
= xsize_t(st
.st_size
);
2828 log_mapped
= xmmap(NULL
, mapsz
, PROT_READ
, MAP_PRIVATE
, logfd
, 0);
2829 logdata
= log_mapped
;
2833 rec
= logend
= logdata
+ st
.st_size
;
2834 while (logdata
< rec
) {
2836 if (logdata
< rec
&& *(rec
-1) == '\n')
2839 while (logdata
< rec
&& *(rec
-1) != '\n') {
2845 die("Log %s is corrupt.", logfile
);
2846 date
= strtoul(lastgt
+ 1, &tz_c
, 10);
2847 if (date
<= at_time
|| cnt
== 0) {
2848 tz
= strtoul(tz_c
, NULL
, 10);
2850 *msg
= ref_msg(rec
, logend
);
2852 *cutoff_time
= date
;
2856 *cutoff_cnt
= reccnt
- 1;
2858 if (get_sha1_hex(lastrec
, logged_sha1
))
2859 die("Log %s is corrupt.", logfile
);
2860 if (get_sha1_hex(rec
+ 41, sha1
))
2861 die("Log %s is corrupt.", logfile
);
2862 if (hashcmp(logged_sha1
, sha1
)) {
2863 warning("Log %s has gap after %s.",
2864 logfile
, show_date(date
, tz
, DATE_RFC2822
));
2867 else if (date
== at_time
) {
2868 if (get_sha1_hex(rec
+ 41, sha1
))
2869 die("Log %s is corrupt.", logfile
);
2872 if (get_sha1_hex(rec
+ 41, logged_sha1
))
2873 die("Log %s is corrupt.", logfile
);
2874 if (hashcmp(logged_sha1
, sha1
)) {
2875 warning("Log %s unexpectedly ended on %s.",
2876 logfile
, show_date(date
, tz
, DATE_RFC2822
));
2879 munmap(log_mapped
, mapsz
);
2888 while (rec
< logend
&& *rec
!= '>' && *rec
!= '\n')
2890 if (rec
== logend
|| *rec
== '\n')
2891 die("Log %s is corrupt.", logfile
);
2892 date
= strtoul(rec
+ 1, &tz_c
, 10);
2893 tz
= strtoul(tz_c
, NULL
, 10);
2894 if (get_sha1_hex(logdata
, sha1
))
2895 die("Log %s is corrupt.", logfile
);
2896 if (is_null_sha1(sha1
)) {
2897 if (get_sha1_hex(logdata
+ 41, sha1
))
2898 die("Log %s is corrupt.", logfile
);
2901 *msg
= ref_msg(logdata
, logend
);
2902 munmap(log_mapped
, mapsz
);
2905 *cutoff_time
= date
;
2909 *cutoff_cnt
= reccnt
;
2913 static int show_one_reflog_ent(struct strbuf
*sb
, each_reflog_ent_fn fn
, void *cb_data
)
2915 unsigned char osha1
[20], nsha1
[20];
2916 char *email_end
, *message
;
2917 unsigned long timestamp
;
2920 /* old SP new SP name <email> SP time TAB msg LF */
2921 if (sb
->len
< 83 || sb
->buf
[sb
->len
- 1] != '\n' ||
2922 get_sha1_hex(sb
->buf
, osha1
) || sb
->buf
[40] != ' ' ||
2923 get_sha1_hex(sb
->buf
+ 41, nsha1
) || sb
->buf
[81] != ' ' ||
2924 !(email_end
= strchr(sb
->buf
+ 82, '>')) ||
2925 email_end
[1] != ' ' ||
2926 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
2927 !message
|| message
[0] != ' ' ||
2928 (message
[1] != '+' && message
[1] != '-') ||
2929 !isdigit(message
[2]) || !isdigit(message
[3]) ||
2930 !isdigit(message
[4]) || !isdigit(message
[5]))
2931 return 0; /* corrupt? */
2932 email_end
[1] = '\0';
2933 tz
= strtol(message
+ 1, NULL
, 10);
2934 if (message
[6] != '\t')
2938 return fn(osha1
, nsha1
, sb
->buf
+ 82, timestamp
, tz
, message
, cb_data
);
2941 static char *find_beginning_of_line(char *bob
, char *scan
)
2943 while (bob
< scan
&& *(--scan
) != '\n')
2944 ; /* keep scanning backwards */
2946 * Return either beginning of the buffer, or LF at the end of
2947 * the previous line.
2952 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
2954 struct strbuf sb
= STRBUF_INIT
;
2957 int ret
= 0, at_tail
= 1;
2959 logfp
= fopen(git_path("logs/%s", refname
), "r");
2963 /* Jump to the end */
2964 if (fseek(logfp
, 0, SEEK_END
) < 0)
2965 return error("cannot seek back reflog for %s: %s",
2966 refname
, strerror(errno
));
2968 while (!ret
&& 0 < pos
) {
2974 /* Fill next block from the end */
2975 cnt
= (sizeof(buf
) < pos
) ? sizeof(buf
) : pos
;
2976 if (fseek(logfp
, pos
- cnt
, SEEK_SET
))
2977 return error("cannot seek back reflog for %s: %s",
2978 refname
, strerror(errno
));
2979 nread
= fread(buf
, cnt
, 1, logfp
);
2981 return error("cannot read %d bytes from reflog for %s: %s",
2982 cnt
, refname
, strerror(errno
));
2985 scanp
= endp
= buf
+ cnt
;
2986 if (at_tail
&& scanp
[-1] == '\n')
2987 /* Looking at the final LF at the end of the file */
2991 while (buf
< scanp
) {
2993 * terminating LF of the previous line, or the beginning
2998 bp
= find_beginning_of_line(buf
, scanp
);
3001 strbuf_splice(&sb
, 0, 0, buf
, endp
- buf
);
3003 break; /* need to fill another block */
3004 scanp
= buf
- 1; /* leave loop */
3007 * (bp + 1) thru endp is the beginning of the
3008 * current line we have in sb
3010 strbuf_splice(&sb
, 0, 0, bp
+ 1, endp
- (bp
+ 1));
3014 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3022 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3025 strbuf_release(&sb
);
3029 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
3032 struct strbuf sb
= STRBUF_INIT
;
3035 logfp
= fopen(git_path("logs/%s", refname
), "r");
3039 while (!ret
&& !strbuf_getwholeline(&sb
, logfp
, '\n'))
3040 ret
= show_one_reflog_ent(&sb
, fn
, cb_data
);
3042 strbuf_release(&sb
);
3046 * Call fn for each reflog in the namespace indicated by name. name
3047 * must be empty or end with '/'. Name will be used as a scratch
3048 * space, but its contents will be restored before return.
3050 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
3052 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
3055 int oldlen
= name
->len
;
3058 return name
->len
? errno
: 0;
3060 while ((de
= readdir(d
)) != NULL
) {
3063 if (de
->d_name
[0] == '.')
3065 if (has_extension(de
->d_name
, ".lock"))
3067 strbuf_addstr(name
, de
->d_name
);
3068 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
3069 ; /* silently ignore */
3071 if (S_ISDIR(st
.st_mode
)) {
3072 strbuf_addch(name
, '/');
3073 retval
= do_for_each_reflog(name
, fn
, cb_data
);
3075 unsigned char sha1
[20];
3076 if (read_ref_full(name
->buf
, sha1
, 0, NULL
))
3077 retval
= error("bad ref for %s", name
->buf
);
3079 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
3084 strbuf_setlen(name
, oldlen
);
3090 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
3094 strbuf_init(&name
, PATH_MAX
);
3095 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
3096 strbuf_release(&name
);
3100 int update_ref(const char *action
, const char *refname
,
3101 const unsigned char *sha1
, const unsigned char *oldval
,
3102 int flags
, enum action_on_err onerr
)
3104 static struct ref_lock
*lock
;
3105 lock
= lock_any_ref_for_update(refname
, oldval
, flags
);
3107 const char *str
= "Cannot lock the ref '%s'.";
3109 case MSG_ON_ERR
: error(str
, refname
); break;
3110 case DIE_ON_ERR
: die(str
, refname
); break;
3111 case QUIET_ON_ERR
: break;
3115 if (write_ref_sha1(lock
, sha1
, action
) < 0) {
3116 const char *str
= "Cannot update the ref '%s'.";
3118 case MSG_ON_ERR
: error(str
, refname
); break;
3119 case DIE_ON_ERR
: die(str
, refname
); break;
3120 case QUIET_ON_ERR
: break;
3127 struct ref
*find_ref_by_name(const struct ref
*list
, const char *name
)
3129 for ( ; list
; list
= list
->next
)
3130 if (!strcmp(list
->name
, name
))
3131 return (struct ref
*)list
;
3136 * generate a format suitable for scanf from a ref_rev_parse_rules
3137 * rule, that is replace the "%.*s" spec with a "%s" spec
3139 static void gen_scanf_fmt(char *scanf_fmt
, const char *rule
)
3143 spec
= strstr(rule
, "%.*s");
3144 if (!spec
|| strstr(spec
+ 4, "%.*s"))
3145 die("invalid rule in ref_rev_parse_rules: %s", rule
);
3147 /* copy all until spec */
3148 strncpy(scanf_fmt
, rule
, spec
- rule
);
3149 scanf_fmt
[spec
- rule
] = '\0';
3151 strcat(scanf_fmt
, "%s");
3152 /* copy remaining rule */
3153 strcat(scanf_fmt
, spec
+ 4);
3158 char *shorten_unambiguous_ref(const char *refname
, int strict
)
3161 static char **scanf_fmts
;
3162 static int nr_rules
;
3165 /* pre generate scanf formats from ref_rev_parse_rules[] */
3167 size_t total_len
= 0;
3169 /* the rule list is NULL terminated, count them first */
3170 for (; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
3171 /* no +1 because strlen("%s") < strlen("%.*s") */
3172 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]);
3174 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
3177 for (i
= 0; i
< nr_rules
; i
++) {
3178 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
]
3180 gen_scanf_fmt(scanf_fmts
[i
], ref_rev_parse_rules
[i
]);
3181 total_len
+= strlen(ref_rev_parse_rules
[i
]);
3185 /* bail out if there are no rules */
3187 return xstrdup(refname
);
3189 /* buffer for scanf result, at most refname must fit */
3190 short_name
= xstrdup(refname
);
3192 /* skip first rule, it will always match */
3193 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
3195 int rules_to_fail
= i
;
3198 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
3201 short_name_len
= strlen(short_name
);
3204 * in strict mode, all (except the matched one) rules
3205 * must fail to resolve to a valid non-ambiguous ref
3208 rules_to_fail
= nr_rules
;
3211 * check if the short name resolves to a valid ref,
3212 * but use only rules prior to the matched one
3214 for (j
= 0; j
< rules_to_fail
; j
++) {
3215 const char *rule
= ref_rev_parse_rules
[j
];
3216 char refname
[PATH_MAX
];
3218 /* skip matched rule */
3223 * the short name is ambiguous, if it resolves
3224 * (with this previous rule) to a valid ref
3225 * read_ref() returns 0 on success
3227 mksnpath(refname
, sizeof(refname
),
3228 rule
, short_name_len
, short_name
);
3229 if (ref_exists(refname
))
3234 * short name is non-ambiguous if all previous rules
3235 * haven't resolved to a valid ref
3237 if (j
== rules_to_fail
)
3242 return xstrdup(refname
);
3245 static struct string_list
*hide_refs
;
3247 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
3249 if (!strcmp("transfer.hiderefs", var
) ||
3250 /* NEEDSWORK: use parse_config_key() once both are merged */
3251 (!prefixcmp(var
, section
) && var
[strlen(section
)] == '.' &&
3252 !strcmp(var
+ strlen(section
), ".hiderefs"))) {
3257 return config_error_nonbool(var
);
3258 ref
= xstrdup(value
);
3260 while (len
&& ref
[len
- 1] == '/')
3263 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
3264 hide_refs
->strdup_strings
= 1;
3266 string_list_append(hide_refs
, ref
);
3271 int ref_is_hidden(const char *refname
)
3273 struct string_list_item
*item
;
3277 for_each_string_list_item(item
, hide_refs
) {
3279 if (prefixcmp(refname
, item
->string
))
3281 len
= strlen(item
->string
);
3282 if (!refname
[len
] || refname
[len
] == '/')