8 * Make sure "ref" is something reasonable to have under ".git/refs/";
9 * We do not like it if:
11 * - any path component of it begins with ".", or
12 * - it has double dots "..", or
13 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
14 * - it ends with a "/".
15 * - it ends with ".lock"
16 * - it contains a "\" (backslash)
19 /* Return true iff ch is not allowed in reference names. */
20 static inline int bad_ref_char(int ch
)
22 if (((unsigned) ch
) <= ' ' || ch
== 0x7f ||
23 ch
== '~' || ch
== '^' || ch
== ':' || ch
== '\\')
25 /* 2.13 Pattern Matching Notation */
26 if (ch
== '*' || ch
== '?' || ch
== '[') /* Unsupported */
32 * Try to read one refname component from the front of refname. Return
33 * the length of the component found, or -1 if the component is not
36 static int check_refname_component(const char *refname
, int flags
)
41 for (cp
= refname
; ; cp
++) {
43 if (ch
== '\0' || ch
== '/')
46 return -1; /* Illegal character in refname. */
47 if (last
== '.' && ch
== '.')
48 return -1; /* Refname contains "..". */
49 if (last
== '@' && ch
== '{')
50 return -1; /* Refname contains "@{". */
54 return 0; /* Component has zero length. */
55 if (refname
[0] == '.') {
56 if (!(flags
& REFNAME_DOT_COMPONENT
))
57 return -1; /* Component starts with '.'. */
59 * Even if leading dots are allowed, don't allow "."
60 * as a component (".." is prevented by a rule above).
62 if (refname
[1] == '\0')
63 return -1; /* Component equals ".". */
65 if (cp
- refname
>= 5 && !memcmp(cp
- 5, ".lock", 5))
66 return -1; /* Refname ends with ".lock". */
70 int check_refname_format(const char *refname
, int flags
)
72 int component_len
, component_count
= 0;
75 /* We are at the start of a path component. */
76 component_len
= check_refname_component(refname
, flags
);
77 if (component_len
<= 0) {
78 if ((flags
& REFNAME_REFSPEC_PATTERN
) &&
80 (refname
[1] == '\0' || refname
[1] == '/')) {
81 /* Accept one wildcard as a full refname component. */
82 flags
&= ~REFNAME_REFSPEC_PATTERN
;
89 if (refname
[component_len
] == '\0')
91 /* Skip to next component. */
92 refname
+= component_len
+ 1;
95 if (refname
[component_len
- 1] == '.')
96 return -1; /* Refname ends with '.'. */
97 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
98 return -1; /* Refname has only one component. */
105 unsigned char sha1
[20];
106 unsigned char peeled
[20];
113 * Entries with index 0 <= i < sorted are sorted by name. New
114 * entries are appended to the list unsorted, and are sorted
115 * only when required; thus we avoid the need to sort the list
116 * after the addition of every reference.
120 struct ref_entry
**entries
;
123 /* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
124 #define REF_KNOWS_PEELED 0x08
128 * A ref_entry represents either a reference or a "subdirectory" of
129 * references. Each directory in the reference namespace is
130 * represented by a ref_entry with (flags & REF_DIR) set and
131 * containing a subdir member that holds the entries in that
132 * directory. References are represented by a ref_entry with (flags &
133 * REF_DIR) unset and a value member that describes the reference's
134 * value. The flag member is at the ref_entry level, but it is also
135 * needed to interpret the contents of the value field (in other
136 * words, a ref_value object is not very much use without the
137 * enclosing ref_entry).
139 * Reference names cannot end with slash and directories' names are
140 * always stored with a trailing slash (except for the top-level
141 * directory, which is always denoted by ""). This has two nice
142 * consequences: (1) when the entries in each subdir are sorted
143 * lexicographically by name (as they usually are), the references in
144 * a whole tree can be generated in lexicographic order by traversing
145 * the tree in left-to-right, depth-first order; (2) the names of
146 * references and subdirectories cannot conflict, and therefore the
147 * presence of an empty subdirectory does not block the creation of a
148 * similarly-named reference. (The fact that reference names with the
149 * same leading components can conflict *with each other* is a
150 * separate issue that is regulated by is_refname_available().)
152 * Please note that the name field contains the fully-qualified
153 * reference (or subdirectory) name. Space could be saved by only
154 * storing the relative names. But that would require the full names
155 * to be generated on the fly when iterating in do_for_each_ref(), and
156 * would break callback functions, who have always been able to assume
157 * that the name strings that they are passed will not be freed during
161 unsigned char flag
; /* ISSYMREF? ISPACKED? */
163 struct ref_value value
; /* if not (flags&REF_DIR) */
164 struct ref_dir subdir
; /* if (flags&REF_DIR) */
167 * The full name of the reference (e.g., "refs/heads/master")
168 * or the full name of the directory with a trailing slash
169 * (e.g., "refs/heads/"):
171 char name
[FLEX_ARRAY
];
174 static struct ref_entry
*create_ref_entry(const char *refname
,
175 const unsigned char *sha1
, int flag
,
179 struct ref_entry
*ref
;
182 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
|REFNAME_DOT_COMPONENT
))
183 die("Reference has invalid format: '%s'", refname
);
184 len
= strlen(refname
) + 1;
185 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
186 hashcpy(ref
->u
.value
.sha1
, sha1
);
187 hashclr(ref
->u
.value
.peeled
);
188 memcpy(ref
->name
, refname
, len
);
193 static void clear_ref_dir(struct ref_dir
*dir
);
195 static void free_ref_entry(struct ref_entry
*entry
)
197 if (entry
->flag
& REF_DIR
)
198 clear_ref_dir(&entry
->u
.subdir
);
203 * Add a ref_entry to the end of dir (unsorted). Entry is always
204 * stored directly in dir; no recursion into subdirectories is
207 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
209 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
210 dir
->entries
[dir
->nr
++] = entry
;
214 * Clear and free all entries in dir, recursively.
216 static void clear_ref_dir(struct ref_dir
*dir
)
219 for (i
= 0; i
< dir
->nr
; i
++)
220 free_ref_entry(dir
->entries
[i
]);
222 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
227 * Create a struct ref_entry object for the specified dirname.
228 * dirname is the name of the directory with a trailing slash (e.g.,
229 * "refs/heads/") or "" for the top-level directory.
231 static struct ref_entry
*create_dir_entry(const char *dirname
)
233 struct ref_entry
*direntry
;
234 int len
= strlen(dirname
);
235 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
236 memcpy(direntry
->name
, dirname
, len
+ 1);
237 direntry
->flag
= REF_DIR
;
241 static int ref_entry_cmp(const void *a
, const void *b
)
243 struct ref_entry
*one
= *(struct ref_entry
**)a
;
244 struct ref_entry
*two
= *(struct ref_entry
**)b
;
245 return strcmp(one
->name
, two
->name
);
248 static void sort_ref_dir(struct ref_dir
*dir
);
251 * Return the entry with the given refname from the ref_dir
252 * (non-recursively), sorting dir if necessary. Return NULL if no
253 * such entry is found.
255 static struct ref_entry
*search_ref_dir(struct ref_dir
*dir
, const char *refname
)
257 struct ref_entry
*e
, **r
;
260 if (refname
== NULL
|| !dir
->nr
)
265 len
= strlen(refname
) + 1;
266 e
= xmalloc(sizeof(struct ref_entry
) + len
);
267 memcpy(e
->name
, refname
, len
);
269 r
= bsearch(&e
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
280 * Search for a directory entry directly within dir (without
281 * recursing). Sort dir if necessary. subdirname must be a directory
282 * name (i.e., end in '/'). If mkdir is set, then create the
283 * directory if it is missing; otherwise, return NULL if the desired
284 * directory cannot be found.
286 static struct ref_entry
*search_for_subdir(struct ref_dir
*dir
,
287 const char *subdirname
, int mkdir
)
289 struct ref_entry
*entry
= search_ref_dir(dir
, subdirname
);
293 entry
= create_dir_entry(subdirname
);
294 add_entry_to_dir(dir
, entry
);
296 assert(entry
->flag
& REF_DIR
);
301 * If refname is a reference name, find the ref_dir within the dir
302 * tree that should hold refname. If refname is a directory name
303 * (i.e., ends in '/'), then return that ref_dir itself. dir must
304 * represent the top-level directory. Sort ref_dirs and recurse into
305 * subdirectories as necessary. If mkdir is set, then create any
306 * missing directories; otherwise, return NULL if the desired
307 * directory cannot be found.
309 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
310 const char *refname
, int mkdir
)
312 char *refname_copy
= xstrdup(refname
);
314 struct ref_entry
*entry
;
315 for (slash
= strchr(refname_copy
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
318 entry
= search_for_subdir(dir
, refname_copy
, mkdir
);
322 dir
= &entry
->u
.subdir
;
330 * Find the value entry with the given name in dir, sorting ref_dirs
331 * and recursing into subdirectories as necessary. If the name is not
332 * found or it corresponds to a directory entry, return NULL.
334 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
336 struct ref_entry
*entry
;
337 dir
= find_containing_dir(dir
, refname
, 0);
340 entry
= search_ref_dir(dir
, refname
);
341 return (entry
&& !(entry
->flag
& REF_DIR
)) ? entry
: NULL
;
345 * Add a ref_entry to the ref_dir (unsorted), recursing into
346 * subdirectories as necessary. dir must represent the top-level
347 * directory. Return 0 on success.
349 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
351 dir
= find_containing_dir(dir
, ref
->name
, 1);
354 add_entry_to_dir(dir
, ref
);
359 * Emit a warning and return true iff ref1 and ref2 have the same name
360 * and the same sha1. Die if they have the same name but different
363 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
365 if (strcmp(ref1
->name
, ref2
->name
))
368 /* Duplicate name; make sure that they don't conflict: */
370 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
371 /* This is impossible by construction */
372 die("Reference directory conflict: %s", ref1
->name
);
374 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
375 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
377 warning("Duplicated ref: %s", ref1
->name
);
382 * Sort the entries in dir non-recursively (if they are not already
383 * sorted) and remove any duplicate entries.
385 static void sort_ref_dir(struct ref_dir
*dir
)
388 struct ref_entry
*last
= NULL
;
391 * This check also prevents passing a zero-length array to qsort(),
392 * which is a problem on some platforms.
394 if (dir
->sorted
== dir
->nr
)
397 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
399 /* Remove any duplicates: */
400 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
401 struct ref_entry
*entry
= dir
->entries
[j
];
402 if (last
&& is_dup_ref(last
, entry
))
403 free_ref_entry(entry
);
405 last
= dir
->entries
[i
++] = entry
;
407 dir
->sorted
= dir
->nr
= i
;
410 #define DO_FOR_EACH_INCLUDE_BROKEN 01
412 static struct ref_entry
*current_ref
;
414 static int do_one_ref(const char *base
, each_ref_fn fn
, int trim
,
415 int flags
, void *cb_data
, struct ref_entry
*entry
)
418 if (prefixcmp(entry
->name
, base
))
421 if (!(flags
& DO_FOR_EACH_INCLUDE_BROKEN
)) {
422 if (entry
->flag
& REF_ISBROKEN
)
423 return 0; /* ignore broken refs e.g. dangling symref */
424 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
425 error("%s does not point to a valid object!", entry
->name
);
430 retval
= fn(entry
->name
+ trim
, entry
->u
.value
.sha1
, entry
->flag
, cb_data
);
436 * Call fn for each reference in dir that has index in the range
437 * offset <= index < dir->nr. Recurse into subdirectories that are in
438 * that index range, sorting them before iterating. This function
439 * does not sort dir itself; it should be sorted beforehand.
441 static int do_for_each_ref_in_dir(struct ref_dir
*dir
, int offset
,
443 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
446 assert(dir
->sorted
== dir
->nr
);
447 for (i
= offset
; i
< dir
->nr
; i
++) {
448 struct ref_entry
*entry
= dir
->entries
[i
];
450 if (entry
->flag
& REF_DIR
) {
451 sort_ref_dir(&entry
->u
.subdir
);
452 retval
= do_for_each_ref_in_dir(&entry
->u
.subdir
, 0,
453 base
, fn
, trim
, flags
, cb_data
);
455 retval
= do_one_ref(base
, fn
, trim
, flags
, cb_data
, entry
);
464 * Call fn for each reference in the union of dir1 and dir2, in order
465 * by refname. Recurse into subdirectories. If a value entry appears
466 * in both dir1 and dir2, then only process the version that is in
467 * dir2. The input dirs must already be sorted, but subdirs will be
470 static int do_for_each_ref_in_dirs(struct ref_dir
*dir1
,
471 struct ref_dir
*dir2
,
472 const char *base
, each_ref_fn fn
, int trim
,
473 int flags
, void *cb_data
)
478 assert(dir1
->sorted
== dir1
->nr
);
479 assert(dir2
->sorted
== dir2
->nr
);
481 struct ref_entry
*e1
, *e2
;
483 if (i1
== dir1
->nr
) {
484 return do_for_each_ref_in_dir(dir2
, i2
,
485 base
, fn
, trim
, flags
, cb_data
);
487 if (i2
== dir2
->nr
) {
488 return do_for_each_ref_in_dir(dir1
, i1
,
489 base
, fn
, trim
, flags
, cb_data
);
491 e1
= dir1
->entries
[i1
];
492 e2
= dir2
->entries
[i2
];
493 cmp
= strcmp(e1
->name
, e2
->name
);
495 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
496 /* Both are directories; descend them in parallel. */
497 sort_ref_dir(&e1
->u
.subdir
);
498 sort_ref_dir(&e2
->u
.subdir
);
499 retval
= do_for_each_ref_in_dirs(
500 &e1
->u
.subdir
, &e2
->u
.subdir
,
501 base
, fn
, trim
, flags
, cb_data
);
504 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
505 /* Both are references; ignore the one from dir1. */
506 retval
= do_one_ref(base
, fn
, trim
, flags
, cb_data
, e2
);
510 die("conflict between reference and directory: %s",
522 if (e
->flag
& REF_DIR
) {
523 sort_ref_dir(&e
->u
.subdir
);
524 retval
= do_for_each_ref_in_dir(
526 base
, fn
, trim
, flags
, cb_data
);
528 retval
= do_one_ref(base
, fn
, trim
, flags
, cb_data
, e
);
535 return do_for_each_ref_in_dir(dir1
, i1
,
536 base
, fn
, trim
, flags
, cb_data
);
538 return do_for_each_ref_in_dir(dir2
, i2
,
539 base
, fn
, trim
, flags
, cb_data
);
544 * Return true iff refname1 and refname2 conflict with each other.
545 * Two reference names conflict if one of them exactly matches the
546 * leading components of the other; e.g., "foo/bar" conflicts with
547 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
550 static int names_conflict(const char *refname1
, const char *refname2
)
552 for (; *refname1
&& *refname1
== *refname2
; refname1
++, refname2
++)
554 return (*refname1
== '\0' && *refname2
== '/')
555 || (*refname1
== '/' && *refname2
== '\0');
558 struct name_conflict_cb
{
560 const char *oldrefname
;
561 const char *conflicting_refname
;
564 static int name_conflict_fn(const char *existingrefname
, const unsigned char *sha1
,
565 int flags
, void *cb_data
)
567 struct name_conflict_cb
*data
= (struct name_conflict_cb
*)cb_data
;
568 if (data
->oldrefname
&& !strcmp(data
->oldrefname
, existingrefname
))
570 if (names_conflict(data
->refname
, existingrefname
)) {
571 data
->conflicting_refname
= existingrefname
;
578 * Return true iff a reference named refname could be created without
579 * conflicting with the name of an existing reference in array. If
580 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
581 * (e.g., because oldrefname is scheduled for deletion in the same
584 static int is_refname_available(const char *refname
, const char *oldrefname
,
587 struct name_conflict_cb data
;
588 data
.refname
= refname
;
589 data
.oldrefname
= oldrefname
;
590 data
.conflicting_refname
= NULL
;
593 if (do_for_each_ref_in_dir(dir
, 0, "", name_conflict_fn
,
594 0, DO_FOR_EACH_INCLUDE_BROKEN
,
596 error("'%s' exists; cannot create '%s'",
597 data
.conflicting_refname
, refname
);
604 * Future: need to be in "struct repository"
605 * when doing a full libification.
607 static struct ref_cache
{
608 struct ref_cache
*next
;
611 struct ref_dir loose
;
612 struct ref_dir packed
;
613 /* The submodule name, or "" for the main repo. */
614 char name
[FLEX_ARRAY
];
617 static void clear_packed_ref_cache(struct ref_cache
*refs
)
619 if (refs
->did_packed
)
620 clear_ref_dir(&refs
->packed
);
621 refs
->did_packed
= 0;
624 static void clear_loose_ref_cache(struct ref_cache
*refs
)
627 clear_ref_dir(&refs
->loose
);
631 static struct ref_cache
*create_ref_cache(const char *submodule
)
634 struct ref_cache
*refs
;
637 len
= strlen(submodule
) + 1;
638 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
639 memcpy(refs
->name
, submodule
, len
);
644 * Return a pointer to a ref_cache for the specified submodule. For
645 * the main repository, use submodule==NULL. The returned structure
646 * will be allocated and initialized but not necessarily populated; it
647 * should not be freed.
649 static struct ref_cache
*get_ref_cache(const char *submodule
)
651 struct ref_cache
*refs
= ref_cache
;
655 if (!strcmp(submodule
, refs
->name
))
660 refs
= create_ref_cache(submodule
);
661 refs
->next
= ref_cache
;
666 void invalidate_ref_cache(const char *submodule
)
668 struct ref_cache
*refs
= get_ref_cache(submodule
);
669 clear_packed_ref_cache(refs
);
670 clear_loose_ref_cache(refs
);
674 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
675 * Return a pointer to the refname within the line (null-terminated),
676 * or NULL if there was a problem.
678 static const char *parse_ref_line(char *line
, unsigned char *sha1
)
681 * 42: the answer to everything.
683 * In this case, it happens to be the answer to
684 * 40 (length of sha1 hex representation)
685 * +1 (space in between hex and name)
686 * +1 (newline at the end of the line)
688 int len
= strlen(line
) - 42;
692 if (get_sha1_hex(line
, sha1
) < 0)
694 if (!isspace(line
[40]))
699 if (line
[len
] != '\n')
706 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
708 struct ref_entry
*last
= NULL
;
709 char refline
[PATH_MAX
];
710 int flag
= REF_ISPACKED
;
712 while (fgets(refline
, sizeof(refline
), f
)) {
713 unsigned char sha1
[20];
715 static const char header
[] = "# pack-refs with:";
717 if (!strncmp(refline
, header
, sizeof(header
)-1)) {
718 const char *traits
= refline
+ sizeof(header
) - 1;
719 if (strstr(traits
, " peeled "))
720 flag
|= REF_KNOWS_PEELED
;
721 /* perhaps other traits later as well */
725 refname
= parse_ref_line(refline
, sha1
);
727 last
= create_ref_entry(refname
, sha1
, flag
, 1);
733 strlen(refline
) == 42 &&
734 refline
[41] == '\n' &&
735 !get_sha1_hex(refline
+ 1, sha1
))
736 hashcpy(last
->u
.value
.peeled
, sha1
);
740 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
742 if (!refs
->did_packed
) {
743 const char *packed_refs_file
;
747 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
749 packed_refs_file
= git_path("packed-refs");
750 f
= fopen(packed_refs_file
, "r");
752 read_packed_refs(f
, &refs
->packed
);
755 refs
->did_packed
= 1;
757 return &refs
->packed
;
760 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
762 add_ref(get_packed_refs(get_ref_cache(NULL
)),
763 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
767 * Read the loose references for refs from the namespace dirname.
768 * dirname must end with '/'.
770 static void get_ref_dir(struct ref_cache
*refs
, const char *dirname
,
776 int dirnamelen
= strlen(dirname
);
777 struct strbuf refname
;
780 path
= git_path_submodule(refs
->name
, "%s", dirname
);
782 path
= git_path("%s", dirname
);
788 strbuf_init(&refname
, dirnamelen
+ 257);
789 strbuf_add(&refname
, dirname
, dirnamelen
);
791 while ((de
= readdir(d
)) != NULL
) {
792 unsigned char sha1
[20];
797 if (de
->d_name
[0] == '.')
799 if (has_extension(de
->d_name
, ".lock"))
801 strbuf_addstr(&refname
, de
->d_name
);
803 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
804 : git_path("%s", refname
.buf
);
805 if (stat(refdir
, &st
) < 0) {
806 ; /* silently ignore */
807 } else if (S_ISDIR(st
.st_mode
)) {
808 strbuf_addch(&refname
, '/');
809 get_ref_dir(refs
, refname
.buf
, dir
);
814 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
816 flag
|= REF_ISBROKEN
;
818 } else if (read_ref_full(refname
.buf
, sha1
, 1, &flag
)) {
820 flag
|= REF_ISBROKEN
;
822 add_ref(dir
, create_ref_entry(refname
.buf
, sha1
, flag
, 1));
824 strbuf_setlen(&refname
, dirnamelen
);
826 strbuf_release(&refname
);
830 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
832 if (!refs
->did_loose
) {
833 get_ref_dir(refs
, "refs/", &refs
->loose
);
839 /* We allow "recursive" symbolic refs. Only within reason, though */
841 #define MAXREFLEN (1024)
844 * Called by resolve_gitlink_ref_recursive() after it failed to read
845 * from the loose refs in ref_cache refs. Find <refname> in the
846 * packed-refs file for the submodule.
848 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
849 const char *refname
, unsigned char *sha1
)
851 struct ref_entry
*ref
;
852 struct ref_dir
*dir
= get_packed_refs(refs
);
854 ref
= find_ref(dir
, refname
);
858 memcpy(sha1
, ref
->u
.value
.sha1
, 20);
862 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
863 const char *refname
, unsigned char *sha1
,
867 char buffer
[128], *p
;
870 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
873 ? git_path_submodule(refs
->name
, "%s", refname
)
874 : git_path("%s", refname
);
875 fd
= open(path
, O_RDONLY
);
877 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
879 len
= read(fd
, buffer
, sizeof(buffer
)-1);
883 while (len
&& isspace(buffer
[len
-1]))
887 /* Was it a detached head or an old-fashioned symlink? */
888 if (!get_sha1_hex(buffer
, sha1
))
892 if (strncmp(buffer
, "ref:", 4))
898 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
901 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
903 int len
= strlen(path
), retval
;
905 struct ref_cache
*refs
;
907 while (len
&& path
[len
-1] == '/')
911 submodule
= xstrndup(path
, len
);
912 refs
= get_ref_cache(submodule
);
915 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
920 * Try to read ref from the packed references. On success, set sha1
921 * and return 0; otherwise, return -1.
923 static int get_packed_ref(const char *refname
, unsigned char *sha1
)
925 struct ref_dir
*packed
= get_packed_refs(get_ref_cache(NULL
));
926 struct ref_entry
*entry
= find_ref(packed
, refname
);
928 hashcpy(sha1
, entry
->u
.value
.sha1
);
934 const char *resolve_ref_unsafe(const char *refname
, unsigned char *sha1
, int reading
, int *flag
)
936 int depth
= MAXDEPTH
;
939 static char refname_buffer
[256];
944 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
956 git_snpath(path
, sizeof(path
), "%s", refname
);
958 if (lstat(path
, &st
) < 0) {
962 * The loose reference file does not exist;
963 * check for a packed reference.
965 if (!get_packed_ref(refname
, sha1
)) {
967 *flag
|= REF_ISPACKED
;
970 /* The reference is not a packed reference, either. */
979 /* Follow "normalized" - ie "refs/.." symlinks by hand */
980 if (S_ISLNK(st
.st_mode
)) {
981 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
985 if (!prefixcmp(buffer
, "refs/") &&
986 !check_refname_format(buffer
, 0)) {
987 strcpy(refname_buffer
, buffer
);
988 refname
= refname_buffer
;
990 *flag
|= REF_ISSYMREF
;
995 /* Is it a directory? */
996 if (S_ISDIR(st
.st_mode
)) {
1002 * Anything else, just open it and try to use it as
1005 fd
= open(path
, O_RDONLY
);
1008 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1012 while (len
&& isspace(buffer
[len
-1]))
1017 * Is it a symbolic ref?
1019 if (prefixcmp(buffer
, "ref:"))
1022 *flag
|= REF_ISSYMREF
;
1024 while (isspace(*buf
))
1026 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1028 *flag
|= REF_ISBROKEN
;
1031 refname
= strcpy(refname_buffer
, buf
);
1033 /* Please note that FETCH_HEAD has a second line containing other data. */
1034 if (get_sha1_hex(buffer
, sha1
) || (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1036 *flag
|= REF_ISBROKEN
;
1042 char *resolve_refdup(const char *ref
, unsigned char *sha1
, int reading
, int *flag
)
1044 const char *ret
= resolve_ref_unsafe(ref
, sha1
, reading
, flag
);
1045 return ret
? xstrdup(ret
) : NULL
;
1048 /* The argument to filter_refs */
1050 const char *pattern
;
1055 int read_ref_full(const char *refname
, unsigned char *sha1
, int reading
, int *flags
)
1057 if (resolve_ref_unsafe(refname
, sha1
, reading
, flags
))
1062 int read_ref(const char *refname
, unsigned char *sha1
)
1064 return read_ref_full(refname
, sha1
, 1, NULL
);
1067 int ref_exists(const char *refname
)
1069 unsigned char sha1
[20];
1070 return !!resolve_ref_unsafe(refname
, sha1
, 1, NULL
);
1073 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1076 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1077 if (fnmatch(filter
->pattern
, refname
, 0))
1079 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1082 int peel_ref(const char *refname
, unsigned char *sha1
)
1085 unsigned char base
[20];
1088 if (current_ref
&& (current_ref
->name
== refname
1089 || !strcmp(current_ref
->name
, refname
))) {
1090 if (current_ref
->flag
& REF_KNOWS_PEELED
) {
1091 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1094 hashcpy(base
, current_ref
->u
.value
.sha1
);
1098 if (read_ref_full(refname
, base
, 1, &flag
))
1101 if ((flag
& REF_ISPACKED
)) {
1102 struct ref_dir
*dir
= get_packed_refs(get_ref_cache(NULL
));
1103 struct ref_entry
*r
= find_ref(dir
, refname
);
1105 if (r
!= NULL
&& r
->flag
& REF_KNOWS_PEELED
) {
1106 hashcpy(sha1
, r
->u
.value
.peeled
);
1112 o
= parse_object(base
);
1113 if (o
&& o
->type
== OBJ_TAG
) {
1114 o
= deref_tag(o
, refname
, 0);
1116 hashcpy(sha1
, o
->sha1
);
1123 struct warn_if_dangling_data
{
1125 const char *refname
;
1126 const char *msg_fmt
;
1129 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1130 int flags
, void *cb_data
)
1132 struct warn_if_dangling_data
*d
= cb_data
;
1133 const char *resolves_to
;
1134 unsigned char junk
[20];
1136 if (!(flags
& REF_ISSYMREF
))
1139 resolves_to
= resolve_ref_unsafe(refname
, junk
, 0, NULL
);
1140 if (!resolves_to
|| strcmp(resolves_to
, d
->refname
))
1143 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1147 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1149 struct warn_if_dangling_data data
;
1152 data
.refname
= refname
;
1153 data
.msg_fmt
= msg_fmt
;
1154 for_each_rawref(warn_if_dangling_symref
, &data
);
1157 static int do_for_each_ref(const char *submodule
, const char *base
, each_ref_fn fn
,
1158 int trim
, int flags
, void *cb_data
)
1160 struct ref_cache
*refs
= get_ref_cache(submodule
);
1161 struct ref_dir
*packed_dir
= get_packed_refs(refs
);
1162 struct ref_dir
*loose_dir
= get_loose_refs(refs
);
1165 if (base
&& *base
) {
1166 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1167 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1170 if (packed_dir
&& loose_dir
) {
1171 sort_ref_dir(packed_dir
);
1172 sort_ref_dir(loose_dir
);
1173 retval
= do_for_each_ref_in_dirs(
1174 packed_dir
, loose_dir
,
1175 base
, fn
, trim
, flags
, cb_data
);
1176 } else if (packed_dir
) {
1177 sort_ref_dir(packed_dir
);
1178 retval
= do_for_each_ref_in_dir(
1180 base
, fn
, trim
, flags
, cb_data
);
1181 } else if (loose_dir
) {
1182 sort_ref_dir(loose_dir
);
1183 retval
= do_for_each_ref_in_dir(
1185 base
, fn
, trim
, flags
, cb_data
);
1191 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1193 unsigned char sha1
[20];
1197 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1198 return fn("HEAD", sha1
, 0, cb_data
);
1203 if (!read_ref_full("HEAD", sha1
, 1, &flag
))
1204 return fn("HEAD", sha1
, flag
, cb_data
);
1209 int head_ref(each_ref_fn fn
, void *cb_data
)
1211 return do_head_ref(NULL
, fn
, cb_data
);
1214 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1216 return do_head_ref(submodule
, fn
, cb_data
);
1219 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1221 return do_for_each_ref(NULL
, "", fn
, 0, 0, cb_data
);
1224 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1226 return do_for_each_ref(submodule
, "", fn
, 0, 0, cb_data
);
1229 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1231 return do_for_each_ref(NULL
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1234 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
1235 each_ref_fn fn
, void *cb_data
)
1237 return do_for_each_ref(submodule
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1240 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
1242 return for_each_ref_in("refs/tags/", fn
, cb_data
);
1245 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1247 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
1250 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
1252 return for_each_ref_in("refs/heads/", fn
, cb_data
);
1255 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1257 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
1260 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
1262 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
1265 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1267 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
1270 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1272 return do_for_each_ref(NULL
, "refs/replace/", fn
, 13, 0, cb_data
);
1275 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
1277 struct strbuf buf
= STRBUF_INIT
;
1279 unsigned char sha1
[20];
1282 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
1283 if (!read_ref_full(buf
.buf
, sha1
, 1, &flag
))
1284 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
1285 strbuf_release(&buf
);
1290 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1292 struct strbuf buf
= STRBUF_INIT
;
1294 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1295 ret
= do_for_each_ref(NULL
, buf
.buf
, fn
, 0, 0, cb_data
);
1296 strbuf_release(&buf
);
1300 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
1301 const char *prefix
, void *cb_data
)
1303 struct strbuf real_pattern
= STRBUF_INIT
;
1304 struct ref_filter filter
;
1307 if (!prefix
&& prefixcmp(pattern
, "refs/"))
1308 strbuf_addstr(&real_pattern
, "refs/");
1310 strbuf_addstr(&real_pattern
, prefix
);
1311 strbuf_addstr(&real_pattern
, pattern
);
1313 if (!has_glob_specials(pattern
)) {
1314 /* Append implied '/' '*' if not present. */
1315 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
1316 strbuf_addch(&real_pattern
, '/');
1317 /* No need to check for '*', there is none. */
1318 strbuf_addch(&real_pattern
, '*');
1321 filter
.pattern
= real_pattern
.buf
;
1323 filter
.cb_data
= cb_data
;
1324 ret
= for_each_ref(filter_refs
, &filter
);
1326 strbuf_release(&real_pattern
);
1330 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
1332 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
1335 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1337 return do_for_each_ref(NULL
, "", fn
, 0,
1338 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1341 const char *prettify_refname(const char *name
)
1344 !prefixcmp(name
, "refs/heads/") ? 11 :
1345 !prefixcmp(name
, "refs/tags/") ? 10 :
1346 !prefixcmp(name
, "refs/remotes/") ? 13 :
1350 const char *ref_rev_parse_rules
[] = {
1355 "refs/remotes/%.*s",
1356 "refs/remotes/%.*s/HEAD",
1360 int refname_match(const char *abbrev_name
, const char *full_name
, const char **rules
)
1363 const int abbrev_name_len
= strlen(abbrev_name
);
1365 for (p
= rules
; *p
; p
++) {
1366 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
1374 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
1375 const unsigned char *old_sha1
, int mustexist
)
1377 if (read_ref_full(lock
->ref_name
, lock
->old_sha1
, mustexist
, NULL
)) {
1378 error("Can't verify ref %s", lock
->ref_name
);
1382 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
1383 error("Ref %s is at %s but expected %s", lock
->ref_name
,
1384 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
1391 static int remove_empty_directories(const char *file
)
1393 /* we want to create a file but there is a directory there;
1394 * if that is an empty directory (or a directory that contains
1395 * only empty directories), remove them.
1400 strbuf_init(&path
, 20);
1401 strbuf_addstr(&path
, file
);
1403 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
1405 strbuf_release(&path
);
1411 * *string and *len will only be substituted, and *string returned (for
1412 * later free()ing) if the string passed in is a magic short-hand form
1415 static char *substitute_branch_name(const char **string
, int *len
)
1417 struct strbuf buf
= STRBUF_INIT
;
1418 int ret
= interpret_branch_name(*string
, &buf
);
1422 *string
= strbuf_detach(&buf
, &size
);
1424 return (char *)*string
;
1430 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
1432 char *last_branch
= substitute_branch_name(&str
, &len
);
1437 for (p
= ref_rev_parse_rules
; *p
; p
++) {
1438 char fullref
[PATH_MAX
];
1439 unsigned char sha1_from_ref
[20];
1440 unsigned char *this_result
;
1443 this_result
= refs_found
? sha1_from_ref
: sha1
;
1444 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
1445 r
= resolve_ref_unsafe(fullref
, this_result
, 1, &flag
);
1449 if (!warn_ambiguous_refs
)
1451 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
1452 warning("ignoring dangling symref %s.", fullref
);
1453 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
1454 warning("ignoring broken ref %s.", fullref
);
1461 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
1463 char *last_branch
= substitute_branch_name(&str
, &len
);
1468 for (p
= ref_rev_parse_rules
; *p
; p
++) {
1470 unsigned char hash
[20];
1471 char path
[PATH_MAX
];
1472 const char *ref
, *it
;
1474 mksnpath(path
, sizeof(path
), *p
, len
, str
);
1475 ref
= resolve_ref_unsafe(path
, hash
, 1, NULL
);
1478 if (!stat(git_path("logs/%s", path
), &st
) &&
1479 S_ISREG(st
.st_mode
))
1481 else if (strcmp(ref
, path
) &&
1482 !stat(git_path("logs/%s", ref
), &st
) &&
1483 S_ISREG(st
.st_mode
))
1487 if (!logs_found
++) {
1489 hashcpy(sha1
, hash
);
1491 if (!warn_ambiguous_refs
)
1498 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
1499 const unsigned char *old_sha1
,
1500 int flags
, int *type_p
)
1503 const char *orig_refname
= refname
;
1504 struct ref_lock
*lock
;
1507 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
1510 lock
= xcalloc(1, sizeof(struct ref_lock
));
1513 refname
= resolve_ref_unsafe(refname
, lock
->old_sha1
, mustexist
, &type
);
1514 if (!refname
&& errno
== EISDIR
) {
1515 /* we are trying to lock foo but we used to
1516 * have foo/bar which now does not exist;
1517 * it is normal for the empty directory 'foo'
1520 ref_file
= git_path("%s", orig_refname
);
1521 if (remove_empty_directories(ref_file
)) {
1523 error("there are still refs under '%s'", orig_refname
);
1526 refname
= resolve_ref_unsafe(orig_refname
, lock
->old_sha1
, mustexist
, &type
);
1532 error("unable to resolve reference %s: %s",
1533 orig_refname
, strerror(errno
));
1536 missing
= is_null_sha1(lock
->old_sha1
);
1537 /* When the ref did not exist and we are creating it,
1538 * make sure there is no existing ref that is packed
1539 * whose name begins with our refname, nor a ref whose
1540 * name is a proper prefix of our refname.
1543 !is_refname_available(refname
, NULL
, get_packed_refs(get_ref_cache(NULL
)))) {
1544 last_errno
= ENOTDIR
;
1548 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
1550 lflags
= LOCK_DIE_ON_ERROR
;
1551 if (flags
& REF_NODEREF
) {
1552 refname
= orig_refname
;
1553 lflags
|= LOCK_NODEREF
;
1555 lock
->ref_name
= xstrdup(refname
);
1556 lock
->orig_ref_name
= xstrdup(orig_refname
);
1557 ref_file
= git_path("%s", refname
);
1559 lock
->force_write
= 1;
1560 if ((flags
& REF_NODEREF
) && (type
& REF_ISSYMREF
))
1561 lock
->force_write
= 1;
1563 if (safe_create_leading_directories(ref_file
)) {
1565 error("unable to create directory for %s", ref_file
);
1569 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
1570 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
1578 struct ref_lock
*lock_ref_sha1(const char *refname
, const unsigned char *old_sha1
)
1580 char refpath
[PATH_MAX
];
1581 if (check_refname_format(refname
, 0))
1583 strcpy(refpath
, mkpath("refs/%s", refname
));
1584 return lock_ref_sha1_basic(refpath
, old_sha1
, 0, NULL
);
1587 struct ref_lock
*lock_any_ref_for_update(const char *refname
,
1588 const unsigned char *old_sha1
, int flags
)
1590 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
1592 return lock_ref_sha1_basic(refname
, old_sha1
, flags
, NULL
);
1595 struct repack_without_ref_sb
{
1596 const char *refname
;
1600 static int repack_without_ref_fn(const char *refname
, const unsigned char *sha1
,
1601 int flags
, void *cb_data
)
1603 struct repack_without_ref_sb
*data
= cb_data
;
1604 char line
[PATH_MAX
+ 100];
1607 if (!strcmp(data
->refname
, refname
))
1609 len
= snprintf(line
, sizeof(line
), "%s %s\n",
1610 sha1_to_hex(sha1
), refname
);
1611 /* this should not happen but just being defensive */
1612 if (len
> sizeof(line
))
1613 die("too long a refname '%s'", refname
);
1614 write_or_die(data
->fd
, line
, len
);
1618 static struct lock_file packlock
;
1620 static int repack_without_ref(const char *refname
)
1622 struct repack_without_ref_sb data
;
1623 struct ref_dir
*packed
= get_packed_refs(get_ref_cache(NULL
));
1624 if (find_ref(packed
, refname
) == NULL
)
1626 data
.refname
= refname
;
1627 data
.fd
= hold_lock_file_for_update(&packlock
, git_path("packed-refs"), 0);
1629 unable_to_lock_error(git_path("packed-refs"), errno
);
1630 return error("cannot delete '%s' from packed refs", refname
);
1632 do_for_each_ref_in_dir(packed
, 0, "", repack_without_ref_fn
, 0, 0, &data
);
1633 return commit_lock_file(&packlock
);
1636 int delete_ref(const char *refname
, const unsigned char *sha1
, int delopt
)
1638 struct ref_lock
*lock
;
1639 int err
, i
= 0, ret
= 0, flag
= 0;
1641 lock
= lock_ref_sha1_basic(refname
, sha1
, 0, &flag
);
1644 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
1648 if (!(delopt
& REF_NODEREF
)) {
1649 i
= strlen(lock
->lk
->filename
) - 5; /* .lock */
1650 lock
->lk
->filename
[i
] = 0;
1651 path
= lock
->lk
->filename
;
1653 path
= git_path("%s", refname
);
1655 err
= unlink_or_warn(path
);
1656 if (err
&& errno
!= ENOENT
)
1659 if (!(delopt
& REF_NODEREF
))
1660 lock
->lk
->filename
[i
] = '.';
1662 /* removing the loose one could have resurrected an earlier
1663 * packed one. Also, if it was not loose we need to repack
1666 ret
|= repack_without_ref(refname
);
1668 unlink_or_warn(git_path("logs/%s", lock
->ref_name
));
1669 invalidate_ref_cache(NULL
);
1675 * People using contrib's git-new-workdir have .git/logs/refs ->
1676 * /some/other/path/.git/logs/refs, and that may live on another device.
1678 * IOW, to avoid cross device rename errors, the temporary renamed log must
1679 * live into logs/refs.
1681 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1683 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
1685 unsigned char sha1
[20], orig_sha1
[20];
1686 int flag
= 0, logmoved
= 0;
1687 struct ref_lock
*lock
;
1688 struct stat loginfo
;
1689 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
1690 const char *symref
= NULL
;
1691 struct ref_cache
*refs
= get_ref_cache(NULL
);
1693 if (log
&& S_ISLNK(loginfo
.st_mode
))
1694 return error("reflog for %s is a symlink", oldrefname
);
1696 symref
= resolve_ref_unsafe(oldrefname
, orig_sha1
, 1, &flag
);
1697 if (flag
& REF_ISSYMREF
)
1698 return error("refname %s is a symbolic ref, renaming it is not supported",
1701 return error("refname %s not found", oldrefname
);
1703 if (!is_refname_available(newrefname
, oldrefname
, get_packed_refs(refs
)))
1706 if (!is_refname_available(newrefname
, oldrefname
, get_loose_refs(refs
)))
1709 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
1710 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
1711 oldrefname
, strerror(errno
));
1713 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
1714 error("unable to delete old %s", oldrefname
);
1718 if (!read_ref_full(newrefname
, sha1
, 1, &flag
) &&
1719 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
1720 if (errno
==EISDIR
) {
1721 if (remove_empty_directories(git_path("%s", newrefname
))) {
1722 error("Directory not empty: %s", newrefname
);
1726 error("unable to delete existing %s", newrefname
);
1731 if (log
&& safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
1732 error("unable to create directory for %s", newrefname
);
1737 if (log
&& rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
1738 if (errno
==EISDIR
|| errno
==ENOTDIR
) {
1740 * rename(a, b) when b is an existing
1741 * directory ought to result in ISDIR, but
1742 * Solaris 5.8 gives ENOTDIR. Sheesh.
1744 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
1745 error("Directory not empty: logs/%s", newrefname
);
1750 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
1751 newrefname
, strerror(errno
));
1757 lock
= lock_ref_sha1_basic(newrefname
, NULL
, 0, NULL
);
1759 error("unable to lock %s for update", newrefname
);
1762 lock
->force_write
= 1;
1763 hashcpy(lock
->old_sha1
, orig_sha1
);
1764 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
1765 error("unable to write current sha1 into %s", newrefname
);
1772 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, 0, NULL
);
1774 error("unable to lock %s for rollback", oldrefname
);
1778 lock
->force_write
= 1;
1779 flag
= log_all_ref_updates
;
1780 log_all_ref_updates
= 0;
1781 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
1782 error("unable to write current sha1 into %s", oldrefname
);
1783 log_all_ref_updates
= flag
;
1786 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
1787 error("unable to restore logfile %s from %s: %s",
1788 oldrefname
, newrefname
, strerror(errno
));
1789 if (!logmoved
&& log
&&
1790 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
1791 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
1792 oldrefname
, strerror(errno
));
1797 int close_ref(struct ref_lock
*lock
)
1799 if (close_lock_file(lock
->lk
))
1805 int commit_ref(struct ref_lock
*lock
)
1807 if (commit_lock_file(lock
->lk
))
1813 void unlock_ref(struct ref_lock
*lock
)
1815 /* Do not free lock->lk -- atexit() still looks at them */
1817 rollback_lock_file(lock
->lk
);
1818 free(lock
->ref_name
);
1819 free(lock
->orig_ref_name
);
1824 * copy the reflog message msg to buf, which has been allocated sufficiently
1825 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1826 * because reflog file is one line per entry.
1828 static int copy_msg(char *buf
, const char *msg
)
1835 while ((c
= *msg
++)) {
1836 if (wasspace
&& isspace(c
))
1838 wasspace
= isspace(c
);
1843 while (buf
< cp
&& isspace(cp
[-1]))
1849 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
1851 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
1853 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
1854 if (log_all_ref_updates
&&
1855 (!prefixcmp(refname
, "refs/heads/") ||
1856 !prefixcmp(refname
, "refs/remotes/") ||
1857 !prefixcmp(refname
, "refs/notes/") ||
1858 !strcmp(refname
, "HEAD"))) {
1859 if (safe_create_leading_directories(logfile
) < 0)
1860 return error("unable to create directory for %s",
1865 logfd
= open(logfile
, oflags
, 0666);
1867 if (!(oflags
& O_CREAT
) && errno
== ENOENT
)
1870 if ((oflags
& O_CREAT
) && errno
== EISDIR
) {
1871 if (remove_empty_directories(logfile
)) {
1872 return error("There are still logs under '%s'",
1875 logfd
= open(logfile
, oflags
, 0666);
1879 return error("Unable to append to %s: %s",
1880 logfile
, strerror(errno
));
1883 adjust_shared_perm(logfile
);
1888 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
1889 const unsigned char *new_sha1
, const char *msg
)
1891 int logfd
, result
, written
, oflags
= O_APPEND
| O_WRONLY
;
1892 unsigned maxlen
, len
;
1894 char log_file
[PATH_MAX
];
1896 const char *committer
;
1898 if (log_all_ref_updates
< 0)
1899 log_all_ref_updates
= !is_bare_repository();
1901 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
1905 logfd
= open(log_file
, oflags
);
1908 msglen
= msg
? strlen(msg
) : 0;
1909 committer
= git_committer_info(0);
1910 maxlen
= strlen(committer
) + msglen
+ 100;
1911 logrec
= xmalloc(maxlen
);
1912 len
= sprintf(logrec
, "%s %s %s\n",
1913 sha1_to_hex(old_sha1
),
1914 sha1_to_hex(new_sha1
),
1917 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
1918 written
= len
<= maxlen
? write_in_full(logfd
, logrec
, len
) : -1;
1920 if (close(logfd
) != 0 || written
!= len
)
1921 return error("Unable to append to %s", log_file
);
1925 static int is_branch(const char *refname
)
1927 return !strcmp(refname
, "HEAD") || !prefixcmp(refname
, "refs/heads/");
1930 int write_ref_sha1(struct ref_lock
*lock
,
1931 const unsigned char *sha1
, const char *logmsg
)
1933 static char term
= '\n';
1938 if (!lock
->force_write
&& !hashcmp(lock
->old_sha1
, sha1
)) {
1942 o
= parse_object(sha1
);
1944 error("Trying to write ref %s with nonexistent object %s",
1945 lock
->ref_name
, sha1_to_hex(sha1
));
1949 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
1950 error("Trying to write non-commit object %s to branch %s",
1951 sha1_to_hex(sha1
), lock
->ref_name
);
1955 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
1956 write_in_full(lock
->lock_fd
, &term
, 1) != 1
1957 || close_ref(lock
) < 0) {
1958 error("Couldn't write %s", lock
->lk
->filename
);
1962 clear_loose_ref_cache(get_ref_cache(NULL
));
1963 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
1964 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
1965 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
1969 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
1971 * Special hack: If a branch is updated directly and HEAD
1972 * points to it (may happen on the remote side of a push
1973 * for example) then logically the HEAD reflog should be
1975 * A generic solution implies reverse symref information,
1976 * but finding all symrefs pointing to the given branch
1977 * would be rather costly for this rare event (the direct
1978 * update of a branch) to be worth it. So let's cheat and
1979 * check with HEAD only which should cover 99% of all usage
1980 * scenarios (even 100% of the default ones).
1982 unsigned char head_sha1
[20];
1984 const char *head_ref
;
1985 head_ref
= resolve_ref_unsafe("HEAD", head_sha1
, 1, &head_flag
);
1986 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
1987 !strcmp(head_ref
, lock
->ref_name
))
1988 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
1990 if (commit_ref(lock
)) {
1991 error("Couldn't set %s", lock
->ref_name
);
1999 int create_symref(const char *ref_target
, const char *refs_heads_master
,
2002 const char *lockpath
;
2004 int fd
, len
, written
;
2005 char *git_HEAD
= git_pathdup("%s", ref_target
);
2006 unsigned char old_sha1
[20], new_sha1
[20];
2008 if (logmsg
&& read_ref(ref_target
, old_sha1
))
2011 if (safe_create_leading_directories(git_HEAD
) < 0)
2012 return error("unable to create directory for %s", git_HEAD
);
2014 #ifndef NO_SYMLINK_HEAD
2015 if (prefer_symlink_refs
) {
2017 if (!symlink(refs_heads_master
, git_HEAD
))
2019 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
2023 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
2024 if (sizeof(ref
) <= len
) {
2025 error("refname too long: %s", refs_heads_master
);
2026 goto error_free_return
;
2028 lockpath
= mkpath("%s.lock", git_HEAD
);
2029 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
2031 error("Unable to open %s for writing", lockpath
);
2032 goto error_free_return
;
2034 written
= write_in_full(fd
, ref
, len
);
2035 if (close(fd
) != 0 || written
!= len
) {
2036 error("Unable to write to %s", lockpath
);
2037 goto error_unlink_return
;
2039 if (rename(lockpath
, git_HEAD
) < 0) {
2040 error("Unable to create %s", git_HEAD
);
2041 goto error_unlink_return
;
2043 if (adjust_shared_perm(git_HEAD
)) {
2044 error("Unable to fix permissions on %s", lockpath
);
2045 error_unlink_return
:
2046 unlink_or_warn(lockpath
);
2052 #ifndef NO_SYMLINK_HEAD
2055 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
2056 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
2062 static char *ref_msg(const char *line
, const char *endp
)
2066 ep
= memchr(line
, '\n', endp
- line
);
2069 return xmemdupz(line
, ep
- line
);
2072 int read_ref_at(const char *refname
, unsigned long at_time
, int cnt
,
2073 unsigned char *sha1
, char **msg
,
2074 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
2076 const char *logfile
, *logdata
, *logend
, *rec
, *lastgt
, *lastrec
;
2078 int logfd
, tz
, reccnt
= 0;
2081 unsigned char logged_sha1
[20];
2085 logfile
= git_path("logs/%s", refname
);
2086 logfd
= open(logfile
, O_RDONLY
, 0);
2088 die_errno("Unable to read log '%s'", logfile
);
2091 die("Log %s is empty.", logfile
);
2092 mapsz
= xsize_t(st
.st_size
);
2093 log_mapped
= xmmap(NULL
, mapsz
, PROT_READ
, MAP_PRIVATE
, logfd
, 0);
2094 logdata
= log_mapped
;
2098 rec
= logend
= logdata
+ st
.st_size
;
2099 while (logdata
< rec
) {
2101 if (logdata
< rec
&& *(rec
-1) == '\n')
2104 while (logdata
< rec
&& *(rec
-1) != '\n') {
2110 die("Log %s is corrupt.", logfile
);
2111 date
= strtoul(lastgt
+ 1, &tz_c
, 10);
2112 if (date
<= at_time
|| cnt
== 0) {
2113 tz
= strtoul(tz_c
, NULL
, 10);
2115 *msg
= ref_msg(rec
, logend
);
2117 *cutoff_time
= date
;
2121 *cutoff_cnt
= reccnt
- 1;
2123 if (get_sha1_hex(lastrec
, logged_sha1
))
2124 die("Log %s is corrupt.", logfile
);
2125 if (get_sha1_hex(rec
+ 41, sha1
))
2126 die("Log %s is corrupt.", logfile
);
2127 if (hashcmp(logged_sha1
, sha1
)) {
2128 warning("Log %s has gap after %s.",
2129 logfile
, show_date(date
, tz
, DATE_RFC2822
));
2132 else if (date
== at_time
) {
2133 if (get_sha1_hex(rec
+ 41, sha1
))
2134 die("Log %s is corrupt.", logfile
);
2137 if (get_sha1_hex(rec
+ 41, logged_sha1
))
2138 die("Log %s is corrupt.", logfile
);
2139 if (hashcmp(logged_sha1
, sha1
)) {
2140 warning("Log %s unexpectedly ended on %s.",
2141 logfile
, show_date(date
, tz
, DATE_RFC2822
));
2144 munmap(log_mapped
, mapsz
);
2153 while (rec
< logend
&& *rec
!= '>' && *rec
!= '\n')
2155 if (rec
== logend
|| *rec
== '\n')
2156 die("Log %s is corrupt.", logfile
);
2157 date
= strtoul(rec
+ 1, &tz_c
, 10);
2158 tz
= strtoul(tz_c
, NULL
, 10);
2159 if (get_sha1_hex(logdata
, sha1
))
2160 die("Log %s is corrupt.", logfile
);
2161 if (is_null_sha1(sha1
)) {
2162 if (get_sha1_hex(logdata
+ 41, sha1
))
2163 die("Log %s is corrupt.", logfile
);
2166 *msg
= ref_msg(logdata
, logend
);
2167 munmap(log_mapped
, mapsz
);
2170 *cutoff_time
= date
;
2174 *cutoff_cnt
= reccnt
;
2178 int for_each_recent_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, long ofs
, void *cb_data
)
2180 const char *logfile
;
2182 struct strbuf sb
= STRBUF_INIT
;
2185 logfile
= git_path("logs/%s", refname
);
2186 logfp
= fopen(logfile
, "r");
2191 struct stat statbuf
;
2192 if (fstat(fileno(logfp
), &statbuf
) ||
2193 statbuf
.st_size
< ofs
||
2194 fseek(logfp
, -ofs
, SEEK_END
) ||
2195 strbuf_getwholeline(&sb
, logfp
, '\n')) {
2197 strbuf_release(&sb
);
2202 while (!strbuf_getwholeline(&sb
, logfp
, '\n')) {
2203 unsigned char osha1
[20], nsha1
[20];
2204 char *email_end
, *message
;
2205 unsigned long timestamp
;
2208 /* old SP new SP name <email> SP time TAB msg LF */
2209 if (sb
.len
< 83 || sb
.buf
[sb
.len
- 1] != '\n' ||
2210 get_sha1_hex(sb
.buf
, osha1
) || sb
.buf
[40] != ' ' ||
2211 get_sha1_hex(sb
.buf
+ 41, nsha1
) || sb
.buf
[81] != ' ' ||
2212 !(email_end
= strchr(sb
.buf
+ 82, '>')) ||
2213 email_end
[1] != ' ' ||
2214 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
2215 !message
|| message
[0] != ' ' ||
2216 (message
[1] != '+' && message
[1] != '-') ||
2217 !isdigit(message
[2]) || !isdigit(message
[3]) ||
2218 !isdigit(message
[4]) || !isdigit(message
[5]))
2219 continue; /* corrupt? */
2220 email_end
[1] = '\0';
2221 tz
= strtol(message
+ 1, NULL
, 10);
2222 if (message
[6] != '\t')
2226 ret
= fn(osha1
, nsha1
, sb
.buf
+ 82, timestamp
, tz
, message
,
2232 strbuf_release(&sb
);
2236 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
2238 return for_each_recent_reflog_ent(refname
, fn
, 0, cb_data
);
2241 static int do_for_each_reflog(const char *base
, each_ref_fn fn
, void *cb_data
)
2243 DIR *d
= opendir(git_path("logs/%s", base
));
2248 int baselen
= strlen(base
);
2249 char *log
= xmalloc(baselen
+ 257);
2251 memcpy(log
, base
, baselen
);
2252 if (baselen
&& base
[baselen
-1] != '/')
2253 log
[baselen
++] = '/';
2255 while ((de
= readdir(d
)) != NULL
) {
2259 if (de
->d_name
[0] == '.')
2261 namelen
= strlen(de
->d_name
);
2264 if (has_extension(de
->d_name
, ".lock"))
2266 memcpy(log
+ baselen
, de
->d_name
, namelen
+1);
2267 if (stat(git_path("logs/%s", log
), &st
) < 0)
2269 if (S_ISDIR(st
.st_mode
)) {
2270 retval
= do_for_each_reflog(log
, fn
, cb_data
);
2272 unsigned char sha1
[20];
2273 if (read_ref_full(log
, sha1
, 0, NULL
))
2274 retval
= error("bad ref for %s", log
);
2276 retval
= fn(log
, sha1
, 0, cb_data
);
2289 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
2291 return do_for_each_reflog("", fn
, cb_data
);
2294 int update_ref(const char *action
, const char *refname
,
2295 const unsigned char *sha1
, const unsigned char *oldval
,
2296 int flags
, enum action_on_err onerr
)
2298 static struct ref_lock
*lock
;
2299 lock
= lock_any_ref_for_update(refname
, oldval
, flags
);
2301 const char *str
= "Cannot lock the ref '%s'.";
2303 case MSG_ON_ERR
: error(str
, refname
); break;
2304 case DIE_ON_ERR
: die(str
, refname
); break;
2305 case QUIET_ON_ERR
: break;
2309 if (write_ref_sha1(lock
, sha1
, action
) < 0) {
2310 const char *str
= "Cannot update the ref '%s'.";
2312 case MSG_ON_ERR
: error(str
, refname
); break;
2313 case DIE_ON_ERR
: die(str
, refname
); break;
2314 case QUIET_ON_ERR
: break;
2321 struct ref
*find_ref_by_name(const struct ref
*list
, const char *name
)
2323 for ( ; list
; list
= list
->next
)
2324 if (!strcmp(list
->name
, name
))
2325 return (struct ref
*)list
;
2330 * generate a format suitable for scanf from a ref_rev_parse_rules
2331 * rule, that is replace the "%.*s" spec with a "%s" spec
2333 static void gen_scanf_fmt(char *scanf_fmt
, const char *rule
)
2337 spec
= strstr(rule
, "%.*s");
2338 if (!spec
|| strstr(spec
+ 4, "%.*s"))
2339 die("invalid rule in ref_rev_parse_rules: %s", rule
);
2341 /* copy all until spec */
2342 strncpy(scanf_fmt
, rule
, spec
- rule
);
2343 scanf_fmt
[spec
- rule
] = '\0';
2345 strcat(scanf_fmt
, "%s");
2346 /* copy remaining rule */
2347 strcat(scanf_fmt
, spec
+ 4);
2352 char *shorten_unambiguous_ref(const char *refname
, int strict
)
2355 static char **scanf_fmts
;
2356 static int nr_rules
;
2359 /* pre generate scanf formats from ref_rev_parse_rules[] */
2361 size_t total_len
= 0;
2363 /* the rule list is NULL terminated, count them first */
2364 for (; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
2365 /* no +1 because strlen("%s") < strlen("%.*s") */
2366 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]);
2368 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
2371 for (i
= 0; i
< nr_rules
; i
++) {
2372 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
]
2374 gen_scanf_fmt(scanf_fmts
[i
], ref_rev_parse_rules
[i
]);
2375 total_len
+= strlen(ref_rev_parse_rules
[i
]);
2379 /* bail out if there are no rules */
2381 return xstrdup(refname
);
2383 /* buffer for scanf result, at most refname must fit */
2384 short_name
= xstrdup(refname
);
2386 /* skip first rule, it will always match */
2387 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
2389 int rules_to_fail
= i
;
2392 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
2395 short_name_len
= strlen(short_name
);
2398 * in strict mode, all (except the matched one) rules
2399 * must fail to resolve to a valid non-ambiguous ref
2402 rules_to_fail
= nr_rules
;
2405 * check if the short name resolves to a valid ref,
2406 * but use only rules prior to the matched one
2408 for (j
= 0; j
< rules_to_fail
; j
++) {
2409 const char *rule
= ref_rev_parse_rules
[j
];
2410 char refname
[PATH_MAX
];
2412 /* skip matched rule */
2417 * the short name is ambiguous, if it resolves
2418 * (with this previous rule) to a valid ref
2419 * read_ref() returns 0 on success
2421 mksnpath(refname
, sizeof(refname
),
2422 rule
, short_name_len
, short_name
);
2423 if (ref_exists(refname
))
2428 * short name is non-ambiguous if all previous rules
2429 * haven't resolved to a valid ref
2431 if (j
== rules_to_fail
)
2436 return xstrdup(refname
);