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_dir
*get_ref_dir(struct ref_entry
*entry
)
176 assert(entry
->flag
& REF_DIR
);
177 return &entry
->u
.subdir
;
180 static struct ref_entry
*create_ref_entry(const char *refname
,
181 const unsigned char *sha1
, int flag
,
185 struct ref_entry
*ref
;
188 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
|REFNAME_DOT_COMPONENT
))
189 die("Reference has invalid format: '%s'", refname
);
190 len
= strlen(refname
) + 1;
191 ref
= xmalloc(sizeof(struct ref_entry
) + len
);
192 hashcpy(ref
->u
.value
.sha1
, sha1
);
193 hashclr(ref
->u
.value
.peeled
);
194 memcpy(ref
->name
, refname
, len
);
199 static void clear_ref_dir(struct ref_dir
*dir
);
201 static void free_ref_entry(struct ref_entry
*entry
)
203 if (entry
->flag
& REF_DIR
)
204 clear_ref_dir(get_ref_dir(entry
));
209 * Add a ref_entry to the end of dir (unsorted). Entry is always
210 * stored directly in dir; no recursion into subdirectories is
213 static void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
215 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
216 dir
->entries
[dir
->nr
++] = entry
;
220 * Clear and free all entries in dir, recursively.
222 static void clear_ref_dir(struct ref_dir
*dir
)
225 for (i
= 0; i
< dir
->nr
; i
++)
226 free_ref_entry(dir
->entries
[i
]);
228 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
233 * Create a struct ref_entry object for the specified dirname.
234 * dirname is the name of the directory with a trailing slash (e.g.,
235 * "refs/heads/") or "" for the top-level directory.
237 static struct ref_entry
*create_dir_entry(const char *dirname
)
239 struct ref_entry
*direntry
;
240 int len
= strlen(dirname
);
241 direntry
= xcalloc(1, sizeof(struct ref_entry
) + len
+ 1);
242 memcpy(direntry
->name
, dirname
, len
+ 1);
243 direntry
->flag
= REF_DIR
;
247 static int ref_entry_cmp(const void *a
, const void *b
)
249 struct ref_entry
*one
= *(struct ref_entry
**)a
;
250 struct ref_entry
*two
= *(struct ref_entry
**)b
;
251 return strcmp(one
->name
, two
->name
);
254 static void sort_ref_dir(struct ref_dir
*dir
);
257 * Return the entry with the given refname from the ref_dir
258 * (non-recursively), sorting dir if necessary. Return NULL if no
259 * such entry is found.
261 static struct ref_entry
*search_ref_dir(struct ref_dir
*dir
, const char *refname
)
263 struct ref_entry
*e
, **r
;
266 if (refname
== NULL
|| !dir
->nr
)
271 len
= strlen(refname
) + 1;
272 e
= xmalloc(sizeof(struct ref_entry
) + len
);
273 memcpy(e
->name
, refname
, len
);
275 r
= bsearch(&e
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
286 * Search for a directory entry directly within dir (without
287 * recursing). Sort dir if necessary. subdirname must be a directory
288 * name (i.e., end in '/'). If mkdir is set, then create the
289 * directory if it is missing; otherwise, return NULL if the desired
290 * directory cannot be found.
292 static struct ref_entry
*search_for_subdir(struct ref_dir
*dir
,
293 const char *subdirname
, int mkdir
)
295 struct ref_entry
*entry
= search_ref_dir(dir
, subdirname
);
299 entry
= create_dir_entry(subdirname
);
300 add_entry_to_dir(dir
, entry
);
302 assert(entry
->flag
& REF_DIR
);
307 * If refname is a reference name, find the ref_dir within the dir
308 * tree that should hold refname. If refname is a directory name
309 * (i.e., ends in '/'), then return that ref_dir itself. dir must
310 * represent the top-level directory. Sort ref_dirs and recurse into
311 * subdirectories as necessary. If mkdir is set, then create any
312 * missing directories; otherwise, return NULL if the desired
313 * directory cannot be found.
315 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
316 const char *refname
, int mkdir
)
318 struct strbuf dirname
;
320 strbuf_init(&dirname
, PATH_MAX
);
321 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
322 struct ref_entry
*entry
;
324 refname
+ dirname
.len
,
325 (slash
+ 1) - (refname
+ dirname
.len
));
326 entry
= search_for_subdir(dir
, dirname
.buf
, mkdir
);
329 dir
= get_ref_dir(entry
);
332 strbuf_release(&dirname
);
337 * Find the value entry with the given name in dir, sorting ref_dirs
338 * and recursing into subdirectories as necessary. If the name is not
339 * found or it corresponds to a directory entry, return NULL.
341 static struct ref_entry
*find_ref(struct ref_dir
*dir
, const char *refname
)
343 struct ref_entry
*entry
;
344 dir
= find_containing_dir(dir
, refname
, 0);
347 entry
= search_ref_dir(dir
, refname
);
348 return (entry
&& !(entry
->flag
& REF_DIR
)) ? entry
: NULL
;
352 * Add a ref_entry to the ref_dir (unsorted), recursing into
353 * subdirectories as necessary. dir must represent the top-level
354 * directory. Return 0 on success.
356 static int add_ref(struct ref_dir
*dir
, struct ref_entry
*ref
)
358 dir
= find_containing_dir(dir
, ref
->name
, 1);
361 add_entry_to_dir(dir
, ref
);
366 * Emit a warning and return true iff ref1 and ref2 have the same name
367 * and the same sha1. Die if they have the same name but different
370 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
372 if (strcmp(ref1
->name
, ref2
->name
))
375 /* Duplicate name; make sure that they don't conflict: */
377 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
378 /* This is impossible by construction */
379 die("Reference directory conflict: %s", ref1
->name
);
381 if (hashcmp(ref1
->u
.value
.sha1
, ref2
->u
.value
.sha1
))
382 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
384 warning("Duplicated ref: %s", ref1
->name
);
389 * Sort the entries in dir non-recursively (if they are not already
390 * sorted) and remove any duplicate entries.
392 static void sort_ref_dir(struct ref_dir
*dir
)
395 struct ref_entry
*last
= NULL
;
398 * This check also prevents passing a zero-length array to qsort(),
399 * which is a problem on some platforms.
401 if (dir
->sorted
== dir
->nr
)
404 qsort(dir
->entries
, dir
->nr
, sizeof(*dir
->entries
), ref_entry_cmp
);
406 /* Remove any duplicates: */
407 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
408 struct ref_entry
*entry
= dir
->entries
[j
];
409 if (last
&& is_dup_ref(last
, entry
))
410 free_ref_entry(entry
);
412 last
= dir
->entries
[i
++] = entry
;
414 dir
->sorted
= dir
->nr
= i
;
417 #define DO_FOR_EACH_INCLUDE_BROKEN 01
419 static struct ref_entry
*current_ref
;
421 static int do_one_ref(const char *base
, each_ref_fn fn
, int trim
,
422 int flags
, void *cb_data
, struct ref_entry
*entry
)
425 if (prefixcmp(entry
->name
, base
))
428 if (!(flags
& DO_FOR_EACH_INCLUDE_BROKEN
)) {
429 if (entry
->flag
& REF_ISBROKEN
)
430 return 0; /* ignore broken refs e.g. dangling symref */
431 if (!has_sha1_file(entry
->u
.value
.sha1
)) {
432 error("%s does not point to a valid object!", entry
->name
);
437 retval
= fn(entry
->name
+ trim
, entry
->u
.value
.sha1
, entry
->flag
, cb_data
);
443 * Call fn for each reference in dir that has index in the range
444 * offset <= index < dir->nr. Recurse into subdirectories that are in
445 * that index range, sorting them before iterating. This function
446 * does not sort dir itself; it should be sorted beforehand.
448 static int do_for_each_ref_in_dir(struct ref_dir
*dir
, int offset
,
450 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
453 assert(dir
->sorted
== dir
->nr
);
454 for (i
= offset
; i
< dir
->nr
; i
++) {
455 struct ref_entry
*entry
= dir
->entries
[i
];
457 if (entry
->flag
& REF_DIR
) {
458 struct ref_dir
*subdir
= get_ref_dir(entry
);
459 sort_ref_dir(subdir
);
460 retval
= do_for_each_ref_in_dir(subdir
, 0,
461 base
, fn
, trim
, flags
, cb_data
);
463 retval
= do_one_ref(base
, fn
, trim
, flags
, cb_data
, entry
);
472 * Call fn for each reference in the union of dir1 and dir2, in order
473 * by refname. Recurse into subdirectories. If a value entry appears
474 * in both dir1 and dir2, then only process the version that is in
475 * dir2. The input dirs must already be sorted, but subdirs will be
478 static int do_for_each_ref_in_dirs(struct ref_dir
*dir1
,
479 struct ref_dir
*dir2
,
480 const char *base
, each_ref_fn fn
, int trim
,
481 int flags
, void *cb_data
)
486 assert(dir1
->sorted
== dir1
->nr
);
487 assert(dir2
->sorted
== dir2
->nr
);
489 struct ref_entry
*e1
, *e2
;
491 if (i1
== dir1
->nr
) {
492 return do_for_each_ref_in_dir(dir2
, i2
,
493 base
, fn
, trim
, flags
, cb_data
);
495 if (i2
== dir2
->nr
) {
496 return do_for_each_ref_in_dir(dir1
, i1
,
497 base
, fn
, trim
, flags
, cb_data
);
499 e1
= dir1
->entries
[i1
];
500 e2
= dir2
->entries
[i2
];
501 cmp
= strcmp(e1
->name
, e2
->name
);
503 if ((e1
->flag
& REF_DIR
) && (e2
->flag
& REF_DIR
)) {
504 /* Both are directories; descend them in parallel. */
505 struct ref_dir
*subdir1
= get_ref_dir(e1
);
506 struct ref_dir
*subdir2
= get_ref_dir(e2
);
507 sort_ref_dir(subdir1
);
508 sort_ref_dir(subdir2
);
509 retval
= do_for_each_ref_in_dirs(
511 base
, fn
, trim
, flags
, cb_data
);
514 } else if (!(e1
->flag
& REF_DIR
) && !(e2
->flag
& REF_DIR
)) {
515 /* Both are references; ignore the one from dir1. */
516 retval
= do_one_ref(base
, fn
, trim
, flags
, cb_data
, e2
);
520 die("conflict between reference and directory: %s",
532 if (e
->flag
& REF_DIR
) {
533 struct ref_dir
*subdir
= get_ref_dir(e
);
534 sort_ref_dir(subdir
);
535 retval
= do_for_each_ref_in_dir(
537 base
, fn
, trim
, flags
, cb_data
);
539 retval
= do_one_ref(base
, fn
, trim
, flags
, cb_data
, e
);
546 return do_for_each_ref_in_dir(dir1
, i1
,
547 base
, fn
, trim
, flags
, cb_data
);
549 return do_for_each_ref_in_dir(dir2
, i2
,
550 base
, fn
, trim
, flags
, cb_data
);
555 * Return true iff refname1 and refname2 conflict with each other.
556 * Two reference names conflict if one of them exactly matches the
557 * leading components of the other; e.g., "foo/bar" conflicts with
558 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
561 static int names_conflict(const char *refname1
, const char *refname2
)
563 for (; *refname1
&& *refname1
== *refname2
; refname1
++, refname2
++)
565 return (*refname1
== '\0' && *refname2
== '/')
566 || (*refname1
== '/' && *refname2
== '\0');
569 struct name_conflict_cb
{
571 const char *oldrefname
;
572 const char *conflicting_refname
;
575 static int name_conflict_fn(const char *existingrefname
, const unsigned char *sha1
,
576 int flags
, void *cb_data
)
578 struct name_conflict_cb
*data
= (struct name_conflict_cb
*)cb_data
;
579 if (data
->oldrefname
&& !strcmp(data
->oldrefname
, existingrefname
))
581 if (names_conflict(data
->refname
, existingrefname
)) {
582 data
->conflicting_refname
= existingrefname
;
589 * Return true iff a reference named refname could be created without
590 * conflicting with the name of an existing reference in array. If
591 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
592 * (e.g., because oldrefname is scheduled for deletion in the same
595 static int is_refname_available(const char *refname
, const char *oldrefname
,
598 struct name_conflict_cb data
;
599 data
.refname
= refname
;
600 data
.oldrefname
= oldrefname
;
601 data
.conflicting_refname
= NULL
;
604 if (do_for_each_ref_in_dir(dir
, 0, "", name_conflict_fn
,
605 0, DO_FOR_EACH_INCLUDE_BROKEN
,
607 error("'%s' exists; cannot create '%s'",
608 data
.conflicting_refname
, refname
);
615 * Future: need to be in "struct repository"
616 * when doing a full libification.
618 static struct ref_cache
{
619 struct ref_cache
*next
;
620 struct ref_entry
*loose
;
621 struct ref_entry
*packed
;
622 /* The submodule name, or "" for the main repo. */
623 char name
[FLEX_ARRAY
];
626 static void clear_packed_ref_cache(struct ref_cache
*refs
)
629 free_ref_entry(refs
->packed
);
634 static void clear_loose_ref_cache(struct ref_cache
*refs
)
637 free_ref_entry(refs
->loose
);
642 static struct ref_cache
*create_ref_cache(const char *submodule
)
645 struct ref_cache
*refs
;
648 len
= strlen(submodule
) + 1;
649 refs
= xcalloc(1, sizeof(struct ref_cache
) + len
);
650 memcpy(refs
->name
, submodule
, len
);
655 * Return a pointer to a ref_cache for the specified submodule. For
656 * the main repository, use submodule==NULL. The returned structure
657 * will be allocated and initialized but not necessarily populated; it
658 * should not be freed.
660 static struct ref_cache
*get_ref_cache(const char *submodule
)
662 struct ref_cache
*refs
= ref_cache
;
666 if (!strcmp(submodule
, refs
->name
))
671 refs
= create_ref_cache(submodule
);
672 refs
->next
= ref_cache
;
677 void invalidate_ref_cache(const char *submodule
)
679 struct ref_cache
*refs
= get_ref_cache(submodule
);
680 clear_packed_ref_cache(refs
);
681 clear_loose_ref_cache(refs
);
685 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
686 * Return a pointer to the refname within the line (null-terminated),
687 * or NULL if there was a problem.
689 static const char *parse_ref_line(char *line
, unsigned char *sha1
)
692 * 42: the answer to everything.
694 * In this case, it happens to be the answer to
695 * 40 (length of sha1 hex representation)
696 * +1 (space in between hex and name)
697 * +1 (newline at the end of the line)
699 int len
= strlen(line
) - 42;
703 if (get_sha1_hex(line
, sha1
) < 0)
705 if (!isspace(line
[40]))
710 if (line
[len
] != '\n')
717 static void read_packed_refs(FILE *f
, struct ref_dir
*dir
)
719 struct ref_entry
*last
= NULL
;
720 char refline
[PATH_MAX
];
721 int flag
= REF_ISPACKED
;
723 while (fgets(refline
, sizeof(refline
), f
)) {
724 unsigned char sha1
[20];
726 static const char header
[] = "# pack-refs with:";
728 if (!strncmp(refline
, header
, sizeof(header
)-1)) {
729 const char *traits
= refline
+ sizeof(header
) - 1;
730 if (strstr(traits
, " peeled "))
731 flag
|= REF_KNOWS_PEELED
;
732 /* perhaps other traits later as well */
736 refname
= parse_ref_line(refline
, sha1
);
738 last
= create_ref_entry(refname
, sha1
, flag
, 1);
744 strlen(refline
) == 42 &&
745 refline
[41] == '\n' &&
746 !get_sha1_hex(refline
+ 1, sha1
))
747 hashcpy(last
->u
.value
.peeled
, sha1
);
751 static struct ref_dir
*get_packed_refs(struct ref_cache
*refs
)
754 const char *packed_refs_file
;
757 refs
->packed
= create_dir_entry("");
759 packed_refs_file
= git_path_submodule(refs
->name
, "packed-refs");
761 packed_refs_file
= git_path("packed-refs");
762 f
= fopen(packed_refs_file
, "r");
764 read_packed_refs(f
, get_ref_dir(refs
->packed
));
768 return get_ref_dir(refs
->packed
);
771 void add_packed_ref(const char *refname
, const unsigned char *sha1
)
773 add_ref(get_packed_refs(get_ref_cache(NULL
)),
774 create_ref_entry(refname
, sha1
, REF_ISPACKED
, 1));
778 * Read the loose references for refs from the namespace dirname.
779 * dirname must end with '/'. dir must be the directory entry
780 * corresponding to dirname.
782 static void read_loose_refs(struct ref_cache
*refs
, const char *dirname
,
788 int dirnamelen
= strlen(dirname
);
789 struct strbuf refname
;
792 path
= git_path_submodule(refs
->name
, "%s", dirname
);
794 path
= git_path("%s", dirname
);
800 strbuf_init(&refname
, dirnamelen
+ 257);
801 strbuf_add(&refname
, dirname
, dirnamelen
);
803 while ((de
= readdir(d
)) != NULL
) {
804 unsigned char sha1
[20];
809 if (de
->d_name
[0] == '.')
811 if (has_extension(de
->d_name
, ".lock"))
813 strbuf_addstr(&refname
, de
->d_name
);
815 ? git_path_submodule(refs
->name
, "%s", refname
.buf
)
816 : git_path("%s", refname
.buf
);
817 if (stat(refdir
, &st
) < 0) {
818 ; /* silently ignore */
819 } else if (S_ISDIR(st
.st_mode
)) {
820 strbuf_addch(&refname
, '/');
821 read_loose_refs(refs
, refname
.buf
,
822 get_ref_dir(search_for_subdir(dir
, refname
.buf
, 1)));
827 if (resolve_gitlink_ref(refs
->name
, refname
.buf
, sha1
) < 0) {
829 flag
|= REF_ISBROKEN
;
831 } else if (read_ref_full(refname
.buf
, sha1
, 1, &flag
)) {
833 flag
|= REF_ISBROKEN
;
835 add_entry_to_dir(dir
,
836 create_ref_entry(refname
.buf
, sha1
, flag
, 1));
838 strbuf_setlen(&refname
, dirnamelen
);
840 strbuf_release(&refname
);
844 static struct ref_dir
*get_loose_refs(struct ref_cache
*refs
)
847 refs
->loose
= create_dir_entry("");
848 read_loose_refs(refs
, "refs/",
849 get_ref_dir(search_for_subdir(get_ref_dir(refs
->loose
),
852 return get_ref_dir(refs
->loose
);
855 /* We allow "recursive" symbolic refs. Only within reason, though */
857 #define MAXREFLEN (1024)
860 * Called by resolve_gitlink_ref_recursive() after it failed to read
861 * from the loose refs in ref_cache refs. Find <refname> in the
862 * packed-refs file for the submodule.
864 static int resolve_gitlink_packed_ref(struct ref_cache
*refs
,
865 const char *refname
, unsigned char *sha1
)
867 struct ref_entry
*ref
;
868 struct ref_dir
*dir
= get_packed_refs(refs
);
870 ref
= find_ref(dir
, refname
);
874 memcpy(sha1
, ref
->u
.value
.sha1
, 20);
878 static int resolve_gitlink_ref_recursive(struct ref_cache
*refs
,
879 const char *refname
, unsigned char *sha1
,
883 char buffer
[128], *p
;
886 if (recursion
> MAXDEPTH
|| strlen(refname
) > MAXREFLEN
)
889 ? git_path_submodule(refs
->name
, "%s", refname
)
890 : git_path("%s", refname
);
891 fd
= open(path
, O_RDONLY
);
893 return resolve_gitlink_packed_ref(refs
, refname
, sha1
);
895 len
= read(fd
, buffer
, sizeof(buffer
)-1);
899 while (len
&& isspace(buffer
[len
-1]))
903 /* Was it a detached head or an old-fashioned symlink? */
904 if (!get_sha1_hex(buffer
, sha1
))
908 if (strncmp(buffer
, "ref:", 4))
914 return resolve_gitlink_ref_recursive(refs
, p
, sha1
, recursion
+1);
917 int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
)
919 int len
= strlen(path
), retval
;
921 struct ref_cache
*refs
;
923 while (len
&& path
[len
-1] == '/')
927 submodule
= xstrndup(path
, len
);
928 refs
= get_ref_cache(submodule
);
931 retval
= resolve_gitlink_ref_recursive(refs
, refname
, sha1
, 0);
936 * Try to read ref from the packed references. On success, set sha1
937 * and return 0; otherwise, return -1.
939 static int get_packed_ref(const char *refname
, unsigned char *sha1
)
941 struct ref_dir
*packed
= get_packed_refs(get_ref_cache(NULL
));
942 struct ref_entry
*entry
= find_ref(packed
, refname
);
944 hashcpy(sha1
, entry
->u
.value
.sha1
);
950 const char *resolve_ref_unsafe(const char *refname
, unsigned char *sha1
, int reading
, int *flag
)
952 int depth
= MAXDEPTH
;
955 static char refname_buffer
[256];
960 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
972 git_snpath(path
, sizeof(path
), "%s", refname
);
974 if (lstat(path
, &st
) < 0) {
978 * The loose reference file does not exist;
979 * check for a packed reference.
981 if (!get_packed_ref(refname
, sha1
)) {
983 *flag
|= REF_ISPACKED
;
986 /* The reference is not a packed reference, either. */
995 /* Follow "normalized" - ie "refs/.." symlinks by hand */
996 if (S_ISLNK(st
.st_mode
)) {
997 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
1001 if (!prefixcmp(buffer
, "refs/") &&
1002 !check_refname_format(buffer
, 0)) {
1003 strcpy(refname_buffer
, buffer
);
1004 refname
= refname_buffer
;
1006 *flag
|= REF_ISSYMREF
;
1011 /* Is it a directory? */
1012 if (S_ISDIR(st
.st_mode
)) {
1018 * Anything else, just open it and try to use it as
1021 fd
= open(path
, O_RDONLY
);
1024 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
1028 while (len
&& isspace(buffer
[len
-1]))
1033 * Is it a symbolic ref?
1035 if (prefixcmp(buffer
, "ref:"))
1038 *flag
|= REF_ISSYMREF
;
1040 while (isspace(*buf
))
1042 if (check_refname_format(buf
, REFNAME_ALLOW_ONELEVEL
)) {
1044 *flag
|= REF_ISBROKEN
;
1047 refname
= strcpy(refname_buffer
, buf
);
1049 /* Please note that FETCH_HEAD has a second line containing other data. */
1050 if (get_sha1_hex(buffer
, sha1
) || (buffer
[40] != '\0' && !isspace(buffer
[40]))) {
1052 *flag
|= REF_ISBROKEN
;
1058 char *resolve_refdup(const char *ref
, unsigned char *sha1
, int reading
, int *flag
)
1060 const char *ret
= resolve_ref_unsafe(ref
, sha1
, reading
, flag
);
1061 return ret
? xstrdup(ret
) : NULL
;
1064 /* The argument to filter_refs */
1066 const char *pattern
;
1071 int read_ref_full(const char *refname
, unsigned char *sha1
, int reading
, int *flags
)
1073 if (resolve_ref_unsafe(refname
, sha1
, reading
, flags
))
1078 int read_ref(const char *refname
, unsigned char *sha1
)
1080 return read_ref_full(refname
, sha1
, 1, NULL
);
1083 int ref_exists(const char *refname
)
1085 unsigned char sha1
[20];
1086 return !!resolve_ref_unsafe(refname
, sha1
, 1, NULL
);
1089 static int filter_refs(const char *refname
, const unsigned char *sha1
, int flags
,
1092 struct ref_filter
*filter
= (struct ref_filter
*)data
;
1093 if (fnmatch(filter
->pattern
, refname
, 0))
1095 return filter
->fn(refname
, sha1
, flags
, filter
->cb_data
);
1098 int peel_ref(const char *refname
, unsigned char *sha1
)
1101 unsigned char base
[20];
1104 if (current_ref
&& (current_ref
->name
== refname
1105 || !strcmp(current_ref
->name
, refname
))) {
1106 if (current_ref
->flag
& REF_KNOWS_PEELED
) {
1107 hashcpy(sha1
, current_ref
->u
.value
.peeled
);
1110 hashcpy(base
, current_ref
->u
.value
.sha1
);
1114 if (read_ref_full(refname
, base
, 1, &flag
))
1117 if ((flag
& REF_ISPACKED
)) {
1118 struct ref_dir
*dir
= get_packed_refs(get_ref_cache(NULL
));
1119 struct ref_entry
*r
= find_ref(dir
, refname
);
1121 if (r
!= NULL
&& r
->flag
& REF_KNOWS_PEELED
) {
1122 hashcpy(sha1
, r
->u
.value
.peeled
);
1128 o
= parse_object(base
);
1129 if (o
&& o
->type
== OBJ_TAG
) {
1130 o
= deref_tag(o
, refname
, 0);
1132 hashcpy(sha1
, o
->sha1
);
1139 struct warn_if_dangling_data
{
1141 const char *refname
;
1142 const char *msg_fmt
;
1145 static int warn_if_dangling_symref(const char *refname
, const unsigned char *sha1
,
1146 int flags
, void *cb_data
)
1148 struct warn_if_dangling_data
*d
= cb_data
;
1149 const char *resolves_to
;
1150 unsigned char junk
[20];
1152 if (!(flags
& REF_ISSYMREF
))
1155 resolves_to
= resolve_ref_unsafe(refname
, junk
, 0, NULL
);
1156 if (!resolves_to
|| strcmp(resolves_to
, d
->refname
))
1159 fprintf(d
->fp
, d
->msg_fmt
, refname
);
1163 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
1165 struct warn_if_dangling_data data
;
1168 data
.refname
= refname
;
1169 data
.msg_fmt
= msg_fmt
;
1170 for_each_rawref(warn_if_dangling_symref
, &data
);
1173 static int do_for_each_ref(const char *submodule
, const char *base
, each_ref_fn fn
,
1174 int trim
, int flags
, void *cb_data
)
1176 struct ref_cache
*refs
= get_ref_cache(submodule
);
1177 struct ref_dir
*packed_dir
= get_packed_refs(refs
);
1178 struct ref_dir
*loose_dir
= get_loose_refs(refs
);
1181 if (base
&& *base
) {
1182 packed_dir
= find_containing_dir(packed_dir
, base
, 0);
1183 loose_dir
= find_containing_dir(loose_dir
, base
, 0);
1186 if (packed_dir
&& loose_dir
) {
1187 sort_ref_dir(packed_dir
);
1188 sort_ref_dir(loose_dir
);
1189 retval
= do_for_each_ref_in_dirs(
1190 packed_dir
, loose_dir
,
1191 base
, fn
, trim
, flags
, cb_data
);
1192 } else if (packed_dir
) {
1193 sort_ref_dir(packed_dir
);
1194 retval
= do_for_each_ref_in_dir(
1196 base
, fn
, trim
, flags
, cb_data
);
1197 } else if (loose_dir
) {
1198 sort_ref_dir(loose_dir
);
1199 retval
= do_for_each_ref_in_dir(
1201 base
, fn
, trim
, flags
, cb_data
);
1207 static int do_head_ref(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1209 unsigned char sha1
[20];
1213 if (resolve_gitlink_ref(submodule
, "HEAD", sha1
) == 0)
1214 return fn("HEAD", sha1
, 0, cb_data
);
1219 if (!read_ref_full("HEAD", sha1
, 1, &flag
))
1220 return fn("HEAD", sha1
, flag
, cb_data
);
1225 int head_ref(each_ref_fn fn
, void *cb_data
)
1227 return do_head_ref(NULL
, fn
, cb_data
);
1230 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1232 return do_head_ref(submodule
, fn
, cb_data
);
1235 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1237 return do_for_each_ref(NULL
, "", fn
, 0, 0, cb_data
);
1240 int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1242 return do_for_each_ref(submodule
, "", fn
, 0, 0, cb_data
);
1245 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1247 return do_for_each_ref(NULL
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1250 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
1251 each_ref_fn fn
, void *cb_data
)
1253 return do_for_each_ref(submodule
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1256 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
1258 return for_each_ref_in("refs/tags/", fn
, cb_data
);
1261 int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1263 return for_each_ref_in_submodule(submodule
, "refs/tags/", fn
, cb_data
);
1266 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
1268 return for_each_ref_in("refs/heads/", fn
, cb_data
);
1271 int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1273 return for_each_ref_in_submodule(submodule
, "refs/heads/", fn
, cb_data
);
1276 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
1278 return for_each_ref_in("refs/remotes/", fn
, cb_data
);
1281 int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
)
1283 return for_each_ref_in_submodule(submodule
, "refs/remotes/", fn
, cb_data
);
1286 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1288 return do_for_each_ref(NULL
, "refs/replace/", fn
, 13, 0, cb_data
);
1291 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
1293 struct strbuf buf
= STRBUF_INIT
;
1295 unsigned char sha1
[20];
1298 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
1299 if (!read_ref_full(buf
.buf
, sha1
, 1, &flag
))
1300 ret
= fn(buf
.buf
, sha1
, flag
, cb_data
);
1301 strbuf_release(&buf
);
1306 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1308 struct strbuf buf
= STRBUF_INIT
;
1310 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1311 ret
= do_for_each_ref(NULL
, buf
.buf
, fn
, 0, 0, cb_data
);
1312 strbuf_release(&buf
);
1316 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
1317 const char *prefix
, void *cb_data
)
1319 struct strbuf real_pattern
= STRBUF_INIT
;
1320 struct ref_filter filter
;
1323 if (!prefix
&& prefixcmp(pattern
, "refs/"))
1324 strbuf_addstr(&real_pattern
, "refs/");
1326 strbuf_addstr(&real_pattern
, prefix
);
1327 strbuf_addstr(&real_pattern
, pattern
);
1329 if (!has_glob_specials(pattern
)) {
1330 /* Append implied '/' '*' if not present. */
1331 if (real_pattern
.buf
[real_pattern
.len
- 1] != '/')
1332 strbuf_addch(&real_pattern
, '/');
1333 /* No need to check for '*', there is none. */
1334 strbuf_addch(&real_pattern
, '*');
1337 filter
.pattern
= real_pattern
.buf
;
1339 filter
.cb_data
= cb_data
;
1340 ret
= for_each_ref(filter_refs
, &filter
);
1342 strbuf_release(&real_pattern
);
1346 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
1348 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
1351 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1353 return do_for_each_ref(NULL
, "", fn
, 0,
1354 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1357 const char *prettify_refname(const char *name
)
1360 !prefixcmp(name
, "refs/heads/") ? 11 :
1361 !prefixcmp(name
, "refs/tags/") ? 10 :
1362 !prefixcmp(name
, "refs/remotes/") ? 13 :
1366 const char *ref_rev_parse_rules
[] = {
1371 "refs/remotes/%.*s",
1372 "refs/remotes/%.*s/HEAD",
1376 int refname_match(const char *abbrev_name
, const char *full_name
, const char **rules
)
1379 const int abbrev_name_len
= strlen(abbrev_name
);
1381 for (p
= rules
; *p
; p
++) {
1382 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
1390 static struct ref_lock
*verify_lock(struct ref_lock
*lock
,
1391 const unsigned char *old_sha1
, int mustexist
)
1393 if (read_ref_full(lock
->ref_name
, lock
->old_sha1
, mustexist
, NULL
)) {
1394 error("Can't verify ref %s", lock
->ref_name
);
1398 if (hashcmp(lock
->old_sha1
, old_sha1
)) {
1399 error("Ref %s is at %s but expected %s", lock
->ref_name
,
1400 sha1_to_hex(lock
->old_sha1
), sha1_to_hex(old_sha1
));
1407 static int remove_empty_directories(const char *file
)
1409 /* we want to create a file but there is a directory there;
1410 * if that is an empty directory (or a directory that contains
1411 * only empty directories), remove them.
1416 strbuf_init(&path
, 20);
1417 strbuf_addstr(&path
, file
);
1419 result
= remove_dir_recursively(&path
, REMOVE_DIR_EMPTY_ONLY
);
1421 strbuf_release(&path
);
1427 * *string and *len will only be substituted, and *string returned (for
1428 * later free()ing) if the string passed in is a magic short-hand form
1431 static char *substitute_branch_name(const char **string
, int *len
)
1433 struct strbuf buf
= STRBUF_INIT
;
1434 int ret
= interpret_branch_name(*string
, &buf
);
1438 *string
= strbuf_detach(&buf
, &size
);
1440 return (char *)*string
;
1446 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
1448 char *last_branch
= substitute_branch_name(&str
, &len
);
1453 for (p
= ref_rev_parse_rules
; *p
; p
++) {
1454 char fullref
[PATH_MAX
];
1455 unsigned char sha1_from_ref
[20];
1456 unsigned char *this_result
;
1459 this_result
= refs_found
? sha1_from_ref
: sha1
;
1460 mksnpath(fullref
, sizeof(fullref
), *p
, len
, str
);
1461 r
= resolve_ref_unsafe(fullref
, this_result
, 1, &flag
);
1465 if (!warn_ambiguous_refs
)
1467 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
, "HEAD")) {
1468 warning("ignoring dangling symref %s.", fullref
);
1469 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
, '/')) {
1470 warning("ignoring broken ref %s.", fullref
);
1477 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
1479 char *last_branch
= substitute_branch_name(&str
, &len
);
1484 for (p
= ref_rev_parse_rules
; *p
; p
++) {
1486 unsigned char hash
[20];
1487 char path
[PATH_MAX
];
1488 const char *ref
, *it
;
1490 mksnpath(path
, sizeof(path
), *p
, len
, str
);
1491 ref
= resolve_ref_unsafe(path
, hash
, 1, NULL
);
1494 if (!stat(git_path("logs/%s", path
), &st
) &&
1495 S_ISREG(st
.st_mode
))
1497 else if (strcmp(ref
, path
) &&
1498 !stat(git_path("logs/%s", ref
), &st
) &&
1499 S_ISREG(st
.st_mode
))
1503 if (!logs_found
++) {
1505 hashcpy(sha1
, hash
);
1507 if (!warn_ambiguous_refs
)
1514 static struct ref_lock
*lock_ref_sha1_basic(const char *refname
,
1515 const unsigned char *old_sha1
,
1516 int flags
, int *type_p
)
1519 const char *orig_refname
= refname
;
1520 struct ref_lock
*lock
;
1523 int mustexist
= (old_sha1
&& !is_null_sha1(old_sha1
));
1526 lock
= xcalloc(1, sizeof(struct ref_lock
));
1529 refname
= resolve_ref_unsafe(refname
, lock
->old_sha1
, mustexist
, &type
);
1530 if (!refname
&& errno
== EISDIR
) {
1531 /* we are trying to lock foo but we used to
1532 * have foo/bar which now does not exist;
1533 * it is normal for the empty directory 'foo'
1536 ref_file
= git_path("%s", orig_refname
);
1537 if (remove_empty_directories(ref_file
)) {
1539 error("there are still refs under '%s'", orig_refname
);
1542 refname
= resolve_ref_unsafe(orig_refname
, lock
->old_sha1
, mustexist
, &type
);
1548 error("unable to resolve reference %s: %s",
1549 orig_refname
, strerror(errno
));
1552 missing
= is_null_sha1(lock
->old_sha1
);
1553 /* When the ref did not exist and we are creating it,
1554 * make sure there is no existing ref that is packed
1555 * whose name begins with our refname, nor a ref whose
1556 * name is a proper prefix of our refname.
1559 !is_refname_available(refname
, NULL
, get_packed_refs(get_ref_cache(NULL
)))) {
1560 last_errno
= ENOTDIR
;
1564 lock
->lk
= xcalloc(1, sizeof(struct lock_file
));
1566 lflags
= LOCK_DIE_ON_ERROR
;
1567 if (flags
& REF_NODEREF
) {
1568 refname
= orig_refname
;
1569 lflags
|= LOCK_NODEREF
;
1571 lock
->ref_name
= xstrdup(refname
);
1572 lock
->orig_ref_name
= xstrdup(orig_refname
);
1573 ref_file
= git_path("%s", refname
);
1575 lock
->force_write
= 1;
1576 if ((flags
& REF_NODEREF
) && (type
& REF_ISSYMREF
))
1577 lock
->force_write
= 1;
1579 if (safe_create_leading_directories(ref_file
)) {
1581 error("unable to create directory for %s", ref_file
);
1585 lock
->lock_fd
= hold_lock_file_for_update(lock
->lk
, ref_file
, lflags
);
1586 return old_sha1
? verify_lock(lock
, old_sha1
, mustexist
) : lock
;
1594 struct ref_lock
*lock_ref_sha1(const char *refname
, const unsigned char *old_sha1
)
1596 char refpath
[PATH_MAX
];
1597 if (check_refname_format(refname
, 0))
1599 strcpy(refpath
, mkpath("refs/%s", refname
));
1600 return lock_ref_sha1_basic(refpath
, old_sha1
, 0, NULL
);
1603 struct ref_lock
*lock_any_ref_for_update(const char *refname
,
1604 const unsigned char *old_sha1
, int flags
)
1606 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
))
1608 return lock_ref_sha1_basic(refname
, old_sha1
, flags
, NULL
);
1611 struct repack_without_ref_sb
{
1612 const char *refname
;
1616 static int repack_without_ref_fn(const char *refname
, const unsigned char *sha1
,
1617 int flags
, void *cb_data
)
1619 struct repack_without_ref_sb
*data
= cb_data
;
1620 char line
[PATH_MAX
+ 100];
1623 if (!strcmp(data
->refname
, refname
))
1625 len
= snprintf(line
, sizeof(line
), "%s %s\n",
1626 sha1_to_hex(sha1
), refname
);
1627 /* this should not happen but just being defensive */
1628 if (len
> sizeof(line
))
1629 die("too long a refname '%s'", refname
);
1630 write_or_die(data
->fd
, line
, len
);
1634 static struct lock_file packlock
;
1636 static int repack_without_ref(const char *refname
)
1638 struct repack_without_ref_sb data
;
1639 struct ref_dir
*packed
= get_packed_refs(get_ref_cache(NULL
));
1640 if (find_ref(packed
, refname
) == NULL
)
1642 data
.refname
= refname
;
1643 data
.fd
= hold_lock_file_for_update(&packlock
, git_path("packed-refs"), 0);
1645 unable_to_lock_error(git_path("packed-refs"), errno
);
1646 return error("cannot delete '%s' from packed refs", refname
);
1648 do_for_each_ref_in_dir(packed
, 0, "", repack_without_ref_fn
, 0, 0, &data
);
1649 return commit_lock_file(&packlock
);
1652 int delete_ref(const char *refname
, const unsigned char *sha1
, int delopt
)
1654 struct ref_lock
*lock
;
1655 int err
, i
= 0, ret
= 0, flag
= 0;
1657 lock
= lock_ref_sha1_basic(refname
, sha1
, 0, &flag
);
1660 if (!(flag
& REF_ISPACKED
) || flag
& REF_ISSYMREF
) {
1664 if (!(delopt
& REF_NODEREF
)) {
1665 i
= strlen(lock
->lk
->filename
) - 5; /* .lock */
1666 lock
->lk
->filename
[i
] = 0;
1667 path
= lock
->lk
->filename
;
1669 path
= git_path("%s", refname
);
1671 err
= unlink_or_warn(path
);
1672 if (err
&& errno
!= ENOENT
)
1675 if (!(delopt
& REF_NODEREF
))
1676 lock
->lk
->filename
[i
] = '.';
1678 /* removing the loose one could have resurrected an earlier
1679 * packed one. Also, if it was not loose we need to repack
1682 ret
|= repack_without_ref(refname
);
1684 unlink_or_warn(git_path("logs/%s", lock
->ref_name
));
1685 invalidate_ref_cache(NULL
);
1691 * People using contrib's git-new-workdir have .git/logs/refs ->
1692 * /some/other/path/.git/logs/refs, and that may live on another device.
1694 * IOW, to avoid cross device rename errors, the temporary renamed log must
1695 * live into logs/refs.
1697 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1699 int rename_ref(const char *oldrefname
, const char *newrefname
, const char *logmsg
)
1701 unsigned char sha1
[20], orig_sha1
[20];
1702 int flag
= 0, logmoved
= 0;
1703 struct ref_lock
*lock
;
1704 struct stat loginfo
;
1705 int log
= !lstat(git_path("logs/%s", oldrefname
), &loginfo
);
1706 const char *symref
= NULL
;
1707 struct ref_cache
*refs
= get_ref_cache(NULL
);
1709 if (log
&& S_ISLNK(loginfo
.st_mode
))
1710 return error("reflog for %s is a symlink", oldrefname
);
1712 symref
= resolve_ref_unsafe(oldrefname
, orig_sha1
, 1, &flag
);
1713 if (flag
& REF_ISSYMREF
)
1714 return error("refname %s is a symbolic ref, renaming it is not supported",
1717 return error("refname %s not found", oldrefname
);
1719 if (!is_refname_available(newrefname
, oldrefname
, get_packed_refs(refs
)))
1722 if (!is_refname_available(newrefname
, oldrefname
, get_loose_refs(refs
)))
1725 if (log
&& rename(git_path("logs/%s", oldrefname
), git_path(TMP_RENAMED_LOG
)))
1726 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG
": %s",
1727 oldrefname
, strerror(errno
));
1729 if (delete_ref(oldrefname
, orig_sha1
, REF_NODEREF
)) {
1730 error("unable to delete old %s", oldrefname
);
1734 if (!read_ref_full(newrefname
, sha1
, 1, &flag
) &&
1735 delete_ref(newrefname
, sha1
, REF_NODEREF
)) {
1736 if (errno
==EISDIR
) {
1737 if (remove_empty_directories(git_path("%s", newrefname
))) {
1738 error("Directory not empty: %s", newrefname
);
1742 error("unable to delete existing %s", newrefname
);
1747 if (log
&& safe_create_leading_directories(git_path("logs/%s", newrefname
))) {
1748 error("unable to create directory for %s", newrefname
);
1753 if (log
&& rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", newrefname
))) {
1754 if (errno
==EISDIR
|| errno
==ENOTDIR
) {
1756 * rename(a, b) when b is an existing
1757 * directory ought to result in ISDIR, but
1758 * Solaris 5.8 gives ENOTDIR. Sheesh.
1760 if (remove_empty_directories(git_path("logs/%s", newrefname
))) {
1761 error("Directory not empty: logs/%s", newrefname
);
1766 error("unable to move logfile "TMP_RENAMED_LOG
" to logs/%s: %s",
1767 newrefname
, strerror(errno
));
1773 lock
= lock_ref_sha1_basic(newrefname
, NULL
, 0, NULL
);
1775 error("unable to lock %s for update", newrefname
);
1778 lock
->force_write
= 1;
1779 hashcpy(lock
->old_sha1
, orig_sha1
);
1780 if (write_ref_sha1(lock
, orig_sha1
, logmsg
)) {
1781 error("unable to write current sha1 into %s", newrefname
);
1788 lock
= lock_ref_sha1_basic(oldrefname
, NULL
, 0, NULL
);
1790 error("unable to lock %s for rollback", oldrefname
);
1794 lock
->force_write
= 1;
1795 flag
= log_all_ref_updates
;
1796 log_all_ref_updates
= 0;
1797 if (write_ref_sha1(lock
, orig_sha1
, NULL
))
1798 error("unable to write current sha1 into %s", oldrefname
);
1799 log_all_ref_updates
= flag
;
1802 if (logmoved
&& rename(git_path("logs/%s", newrefname
), git_path("logs/%s", oldrefname
)))
1803 error("unable to restore logfile %s from %s: %s",
1804 oldrefname
, newrefname
, strerror(errno
));
1805 if (!logmoved
&& log
&&
1806 rename(git_path(TMP_RENAMED_LOG
), git_path("logs/%s", oldrefname
)))
1807 error("unable to restore logfile %s from "TMP_RENAMED_LOG
": %s",
1808 oldrefname
, strerror(errno
));
1813 int close_ref(struct ref_lock
*lock
)
1815 if (close_lock_file(lock
->lk
))
1821 int commit_ref(struct ref_lock
*lock
)
1823 if (commit_lock_file(lock
->lk
))
1829 void unlock_ref(struct ref_lock
*lock
)
1831 /* Do not free lock->lk -- atexit() still looks at them */
1833 rollback_lock_file(lock
->lk
);
1834 free(lock
->ref_name
);
1835 free(lock
->orig_ref_name
);
1840 * copy the reflog message msg to buf, which has been allocated sufficiently
1841 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1842 * because reflog file is one line per entry.
1844 static int copy_msg(char *buf
, const char *msg
)
1851 while ((c
= *msg
++)) {
1852 if (wasspace
&& isspace(c
))
1854 wasspace
= isspace(c
);
1859 while (buf
< cp
&& isspace(cp
[-1]))
1865 int log_ref_setup(const char *refname
, char *logfile
, int bufsize
)
1867 int logfd
, oflags
= O_APPEND
| O_WRONLY
;
1869 git_snpath(logfile
, bufsize
, "logs/%s", refname
);
1870 if (log_all_ref_updates
&&
1871 (!prefixcmp(refname
, "refs/heads/") ||
1872 !prefixcmp(refname
, "refs/remotes/") ||
1873 !prefixcmp(refname
, "refs/notes/") ||
1874 !strcmp(refname
, "HEAD"))) {
1875 if (safe_create_leading_directories(logfile
) < 0)
1876 return error("unable to create directory for %s",
1881 logfd
= open(logfile
, oflags
, 0666);
1883 if (!(oflags
& O_CREAT
) && errno
== ENOENT
)
1886 if ((oflags
& O_CREAT
) && errno
== EISDIR
) {
1887 if (remove_empty_directories(logfile
)) {
1888 return error("There are still logs under '%s'",
1891 logfd
= open(logfile
, oflags
, 0666);
1895 return error("Unable to append to %s: %s",
1896 logfile
, strerror(errno
));
1899 adjust_shared_perm(logfile
);
1904 static int log_ref_write(const char *refname
, const unsigned char *old_sha1
,
1905 const unsigned char *new_sha1
, const char *msg
)
1907 int logfd
, result
, written
, oflags
= O_APPEND
| O_WRONLY
;
1908 unsigned maxlen
, len
;
1910 char log_file
[PATH_MAX
];
1912 const char *committer
;
1914 if (log_all_ref_updates
< 0)
1915 log_all_ref_updates
= !is_bare_repository();
1917 result
= log_ref_setup(refname
, log_file
, sizeof(log_file
));
1921 logfd
= open(log_file
, oflags
);
1924 msglen
= msg
? strlen(msg
) : 0;
1925 committer
= git_committer_info(0);
1926 maxlen
= strlen(committer
) + msglen
+ 100;
1927 logrec
= xmalloc(maxlen
);
1928 len
= sprintf(logrec
, "%s %s %s\n",
1929 sha1_to_hex(old_sha1
),
1930 sha1_to_hex(new_sha1
),
1933 len
+= copy_msg(logrec
+ len
- 1, msg
) - 1;
1934 written
= len
<= maxlen
? write_in_full(logfd
, logrec
, len
) : -1;
1936 if (close(logfd
) != 0 || written
!= len
)
1937 return error("Unable to append to %s", log_file
);
1941 static int is_branch(const char *refname
)
1943 return !strcmp(refname
, "HEAD") || !prefixcmp(refname
, "refs/heads/");
1946 int write_ref_sha1(struct ref_lock
*lock
,
1947 const unsigned char *sha1
, const char *logmsg
)
1949 static char term
= '\n';
1954 if (!lock
->force_write
&& !hashcmp(lock
->old_sha1
, sha1
)) {
1958 o
= parse_object(sha1
);
1960 error("Trying to write ref %s with nonexistent object %s",
1961 lock
->ref_name
, sha1_to_hex(sha1
));
1965 if (o
->type
!= OBJ_COMMIT
&& is_branch(lock
->ref_name
)) {
1966 error("Trying to write non-commit object %s to branch %s",
1967 sha1_to_hex(sha1
), lock
->ref_name
);
1971 if (write_in_full(lock
->lock_fd
, sha1_to_hex(sha1
), 40) != 40 ||
1972 write_in_full(lock
->lock_fd
, &term
, 1) != 1
1973 || close_ref(lock
) < 0) {
1974 error("Couldn't write %s", lock
->lk
->filename
);
1978 clear_loose_ref_cache(get_ref_cache(NULL
));
1979 if (log_ref_write(lock
->ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0 ||
1980 (strcmp(lock
->ref_name
, lock
->orig_ref_name
) &&
1981 log_ref_write(lock
->orig_ref_name
, lock
->old_sha1
, sha1
, logmsg
) < 0)) {
1985 if (strcmp(lock
->orig_ref_name
, "HEAD") != 0) {
1987 * Special hack: If a branch is updated directly and HEAD
1988 * points to it (may happen on the remote side of a push
1989 * for example) then logically the HEAD reflog should be
1991 * A generic solution implies reverse symref information,
1992 * but finding all symrefs pointing to the given branch
1993 * would be rather costly for this rare event (the direct
1994 * update of a branch) to be worth it. So let's cheat and
1995 * check with HEAD only which should cover 99% of all usage
1996 * scenarios (even 100% of the default ones).
1998 unsigned char head_sha1
[20];
2000 const char *head_ref
;
2001 head_ref
= resolve_ref_unsafe("HEAD", head_sha1
, 1, &head_flag
);
2002 if (head_ref
&& (head_flag
& REF_ISSYMREF
) &&
2003 !strcmp(head_ref
, lock
->ref_name
))
2004 log_ref_write("HEAD", lock
->old_sha1
, sha1
, logmsg
);
2006 if (commit_ref(lock
)) {
2007 error("Couldn't set %s", lock
->ref_name
);
2015 int create_symref(const char *ref_target
, const char *refs_heads_master
,
2018 const char *lockpath
;
2020 int fd
, len
, written
;
2021 char *git_HEAD
= git_pathdup("%s", ref_target
);
2022 unsigned char old_sha1
[20], new_sha1
[20];
2024 if (logmsg
&& read_ref(ref_target
, old_sha1
))
2027 if (safe_create_leading_directories(git_HEAD
) < 0)
2028 return error("unable to create directory for %s", git_HEAD
);
2030 #ifndef NO_SYMLINK_HEAD
2031 if (prefer_symlink_refs
) {
2033 if (!symlink(refs_heads_master
, git_HEAD
))
2035 fprintf(stderr
, "no symlink - falling back to symbolic ref\n");
2039 len
= snprintf(ref
, sizeof(ref
), "ref: %s\n", refs_heads_master
);
2040 if (sizeof(ref
) <= len
) {
2041 error("refname too long: %s", refs_heads_master
);
2042 goto error_free_return
;
2044 lockpath
= mkpath("%s.lock", git_HEAD
);
2045 fd
= open(lockpath
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
2047 error("Unable to open %s for writing", lockpath
);
2048 goto error_free_return
;
2050 written
= write_in_full(fd
, ref
, len
);
2051 if (close(fd
) != 0 || written
!= len
) {
2052 error("Unable to write to %s", lockpath
);
2053 goto error_unlink_return
;
2055 if (rename(lockpath
, git_HEAD
) < 0) {
2056 error("Unable to create %s", git_HEAD
);
2057 goto error_unlink_return
;
2059 if (adjust_shared_perm(git_HEAD
)) {
2060 error("Unable to fix permissions on %s", lockpath
);
2061 error_unlink_return
:
2062 unlink_or_warn(lockpath
);
2068 #ifndef NO_SYMLINK_HEAD
2071 if (logmsg
&& !read_ref(refs_heads_master
, new_sha1
))
2072 log_ref_write(ref_target
, old_sha1
, new_sha1
, logmsg
);
2078 static char *ref_msg(const char *line
, const char *endp
)
2082 ep
= memchr(line
, '\n', endp
- line
);
2085 return xmemdupz(line
, ep
- line
);
2088 int read_ref_at(const char *refname
, unsigned long at_time
, int cnt
,
2089 unsigned char *sha1
, char **msg
,
2090 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
2092 const char *logfile
, *logdata
, *logend
, *rec
, *lastgt
, *lastrec
;
2094 int logfd
, tz
, reccnt
= 0;
2097 unsigned char logged_sha1
[20];
2101 logfile
= git_path("logs/%s", refname
);
2102 logfd
= open(logfile
, O_RDONLY
, 0);
2104 die_errno("Unable to read log '%s'", logfile
);
2107 die("Log %s is empty.", logfile
);
2108 mapsz
= xsize_t(st
.st_size
);
2109 log_mapped
= xmmap(NULL
, mapsz
, PROT_READ
, MAP_PRIVATE
, logfd
, 0);
2110 logdata
= log_mapped
;
2114 rec
= logend
= logdata
+ st
.st_size
;
2115 while (logdata
< rec
) {
2117 if (logdata
< rec
&& *(rec
-1) == '\n')
2120 while (logdata
< rec
&& *(rec
-1) != '\n') {
2126 die("Log %s is corrupt.", logfile
);
2127 date
= strtoul(lastgt
+ 1, &tz_c
, 10);
2128 if (date
<= at_time
|| cnt
== 0) {
2129 tz
= strtoul(tz_c
, NULL
, 10);
2131 *msg
= ref_msg(rec
, logend
);
2133 *cutoff_time
= date
;
2137 *cutoff_cnt
= reccnt
- 1;
2139 if (get_sha1_hex(lastrec
, logged_sha1
))
2140 die("Log %s is corrupt.", logfile
);
2141 if (get_sha1_hex(rec
+ 41, sha1
))
2142 die("Log %s is corrupt.", logfile
);
2143 if (hashcmp(logged_sha1
, sha1
)) {
2144 warning("Log %s has gap after %s.",
2145 logfile
, show_date(date
, tz
, DATE_RFC2822
));
2148 else if (date
== at_time
) {
2149 if (get_sha1_hex(rec
+ 41, sha1
))
2150 die("Log %s is corrupt.", logfile
);
2153 if (get_sha1_hex(rec
+ 41, logged_sha1
))
2154 die("Log %s is corrupt.", logfile
);
2155 if (hashcmp(logged_sha1
, sha1
)) {
2156 warning("Log %s unexpectedly ended on %s.",
2157 logfile
, show_date(date
, tz
, DATE_RFC2822
));
2160 munmap(log_mapped
, mapsz
);
2169 while (rec
< logend
&& *rec
!= '>' && *rec
!= '\n')
2171 if (rec
== logend
|| *rec
== '\n')
2172 die("Log %s is corrupt.", logfile
);
2173 date
= strtoul(rec
+ 1, &tz_c
, 10);
2174 tz
= strtoul(tz_c
, NULL
, 10);
2175 if (get_sha1_hex(logdata
, sha1
))
2176 die("Log %s is corrupt.", logfile
);
2177 if (is_null_sha1(sha1
)) {
2178 if (get_sha1_hex(logdata
+ 41, sha1
))
2179 die("Log %s is corrupt.", logfile
);
2182 *msg
= ref_msg(logdata
, logend
);
2183 munmap(log_mapped
, mapsz
);
2186 *cutoff_time
= date
;
2190 *cutoff_cnt
= reccnt
;
2194 int for_each_recent_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, long ofs
, void *cb_data
)
2196 const char *logfile
;
2198 struct strbuf sb
= STRBUF_INIT
;
2201 logfile
= git_path("logs/%s", refname
);
2202 logfp
= fopen(logfile
, "r");
2207 struct stat statbuf
;
2208 if (fstat(fileno(logfp
), &statbuf
) ||
2209 statbuf
.st_size
< ofs
||
2210 fseek(logfp
, -ofs
, SEEK_END
) ||
2211 strbuf_getwholeline(&sb
, logfp
, '\n')) {
2213 strbuf_release(&sb
);
2218 while (!strbuf_getwholeline(&sb
, logfp
, '\n')) {
2219 unsigned char osha1
[20], nsha1
[20];
2220 char *email_end
, *message
;
2221 unsigned long timestamp
;
2224 /* old SP new SP name <email> SP time TAB msg LF */
2225 if (sb
.len
< 83 || sb
.buf
[sb
.len
- 1] != '\n' ||
2226 get_sha1_hex(sb
.buf
, osha1
) || sb
.buf
[40] != ' ' ||
2227 get_sha1_hex(sb
.buf
+ 41, nsha1
) || sb
.buf
[81] != ' ' ||
2228 !(email_end
= strchr(sb
.buf
+ 82, '>')) ||
2229 email_end
[1] != ' ' ||
2230 !(timestamp
= strtoul(email_end
+ 2, &message
, 10)) ||
2231 !message
|| message
[0] != ' ' ||
2232 (message
[1] != '+' && message
[1] != '-') ||
2233 !isdigit(message
[2]) || !isdigit(message
[3]) ||
2234 !isdigit(message
[4]) || !isdigit(message
[5]))
2235 continue; /* corrupt? */
2236 email_end
[1] = '\0';
2237 tz
= strtol(message
+ 1, NULL
, 10);
2238 if (message
[6] != '\t')
2242 ret
= fn(osha1
, nsha1
, sb
.buf
+ 82, timestamp
, tz
, message
,
2248 strbuf_release(&sb
);
2252 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
)
2254 return for_each_recent_reflog_ent(refname
, fn
, 0, cb_data
);
2258 * Call fn for each reflog in the namespace indicated by name. name
2259 * must be empty or end with '/'. Name will be used as a scratch
2260 * space, but its contents will be restored before return.
2262 static int do_for_each_reflog(struct strbuf
*name
, each_ref_fn fn
, void *cb_data
)
2264 DIR *d
= opendir(git_path("logs/%s", name
->buf
));
2267 int oldlen
= name
->len
;
2270 return name
->len
? errno
: 0;
2272 while ((de
= readdir(d
)) != NULL
) {
2275 if (de
->d_name
[0] == '.')
2277 if (has_extension(de
->d_name
, ".lock"))
2279 strbuf_addstr(name
, de
->d_name
);
2280 if (stat(git_path("logs/%s", name
->buf
), &st
) < 0) {
2281 ; /* silently ignore */
2283 if (S_ISDIR(st
.st_mode
)) {
2284 strbuf_addch(name
, '/');
2285 retval
= do_for_each_reflog(name
, fn
, cb_data
);
2287 unsigned char sha1
[20];
2288 if (read_ref_full(name
->buf
, sha1
, 0, NULL
))
2289 retval
= error("bad ref for %s", name
->buf
);
2291 retval
= fn(name
->buf
, sha1
, 0, cb_data
);
2296 strbuf_setlen(name
, oldlen
);
2302 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
2306 strbuf_init(&name
, PATH_MAX
);
2307 retval
= do_for_each_reflog(&name
, fn
, cb_data
);
2308 strbuf_release(&name
);
2312 int update_ref(const char *action
, const char *refname
,
2313 const unsigned char *sha1
, const unsigned char *oldval
,
2314 int flags
, enum action_on_err onerr
)
2316 static struct ref_lock
*lock
;
2317 lock
= lock_any_ref_for_update(refname
, oldval
, flags
);
2319 const char *str
= "Cannot lock the ref '%s'.";
2321 case MSG_ON_ERR
: error(str
, refname
); break;
2322 case DIE_ON_ERR
: die(str
, refname
); break;
2323 case QUIET_ON_ERR
: break;
2327 if (write_ref_sha1(lock
, sha1
, action
) < 0) {
2328 const char *str
= "Cannot update the ref '%s'.";
2330 case MSG_ON_ERR
: error(str
, refname
); break;
2331 case DIE_ON_ERR
: die(str
, refname
); break;
2332 case QUIET_ON_ERR
: break;
2339 struct ref
*find_ref_by_name(const struct ref
*list
, const char *name
)
2341 for ( ; list
; list
= list
->next
)
2342 if (!strcmp(list
->name
, name
))
2343 return (struct ref
*)list
;
2348 * generate a format suitable for scanf from a ref_rev_parse_rules
2349 * rule, that is replace the "%.*s" spec with a "%s" spec
2351 static void gen_scanf_fmt(char *scanf_fmt
, const char *rule
)
2355 spec
= strstr(rule
, "%.*s");
2356 if (!spec
|| strstr(spec
+ 4, "%.*s"))
2357 die("invalid rule in ref_rev_parse_rules: %s", rule
);
2359 /* copy all until spec */
2360 strncpy(scanf_fmt
, rule
, spec
- rule
);
2361 scanf_fmt
[spec
- rule
] = '\0';
2363 strcat(scanf_fmt
, "%s");
2364 /* copy remaining rule */
2365 strcat(scanf_fmt
, spec
+ 4);
2370 char *shorten_unambiguous_ref(const char *refname
, int strict
)
2373 static char **scanf_fmts
;
2374 static int nr_rules
;
2377 /* pre generate scanf formats from ref_rev_parse_rules[] */
2379 size_t total_len
= 0;
2381 /* the rule list is NULL terminated, count them first */
2382 for (; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
2383 /* no +1 because strlen("%s") < strlen("%.*s") */
2384 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]);
2386 scanf_fmts
= xmalloc(nr_rules
* sizeof(char *) + total_len
);
2389 for (i
= 0; i
< nr_rules
; i
++) {
2390 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
]
2392 gen_scanf_fmt(scanf_fmts
[i
], ref_rev_parse_rules
[i
]);
2393 total_len
+= strlen(ref_rev_parse_rules
[i
]);
2397 /* bail out if there are no rules */
2399 return xstrdup(refname
);
2401 /* buffer for scanf result, at most refname must fit */
2402 short_name
= xstrdup(refname
);
2404 /* skip first rule, it will always match */
2405 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
2407 int rules_to_fail
= i
;
2410 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
2413 short_name_len
= strlen(short_name
);
2416 * in strict mode, all (except the matched one) rules
2417 * must fail to resolve to a valid non-ambiguous ref
2420 rules_to_fail
= nr_rules
;
2423 * check if the short name resolves to a valid ref,
2424 * but use only rules prior to the matched one
2426 for (j
= 0; j
< rules_to_fail
; j
++) {
2427 const char *rule
= ref_rev_parse_rules
[j
];
2428 char refname
[PATH_MAX
];
2430 /* skip matched rule */
2435 * the short name is ambiguous, if it resolves
2436 * (with this previous rule) to a valid ref
2437 * read_ref() returns 0 on success
2439 mksnpath(refname
, sizeof(refname
),
2440 rule
, short_name_len
, short_name
);
2441 if (ref_exists(refname
))
2446 * short name is non-ambiguous if all previous rules
2447 * haven't resolved to a valid ref
2449 if (j
== rules_to_fail
)
2454 return xstrdup(refname
);