7 /* ISSYMREF=01 and ISPACKED=02 are public interfaces */
8 #define REF_KNOWS_PEELED 04
12 struct ref_list *next;
13 unsigned char flag; /* ISSYMREF? ISPACKED? */
14 unsigned char sha1[20];
15 unsigned char peeled[20];
16 char name[FLEX_ARRAY];
19 static const char *parse_ref_line(char *line, unsigned char *sha1)
22 * 42: the answer to everything.
24 * In this case, it happens to be the answer to
25 * 40 (length of sha1 hex representation)
26 * +1 (space in between hex and name)
27 * +1 (newline at the end of the line)
29 int len = strlen(line) - 42;
33 if (get_sha1_hex(line, sha1) < 0)
35 if (!isspace(line[40]))
40 if (line[len] != '\n')
47 static struct ref_list *add_ref(const char *name, const unsigned char *sha1,
48 int flag, struct ref_list *list,
49 struct ref_list **new_entry)
52 struct ref_list *entry;
54 /* Allocate it and add it in.. */
55 len = strlen(name) + 1;
56 entry = xmalloc(sizeof(struct ref_list) + len);
57 hashcpy(entry->sha1, sha1);
58 hashclr(entry->peeled);
59 memcpy(entry->name, name, len);
67 /* merge sort the ref list */
68 static struct ref_list *sort_ref_list(struct ref_list *list)
70 int psize, qsize, last_merge_count, cmp;
71 struct ref_list *p, *q, *l, *e;
72 struct ref_list *new_list = list;
80 last_merge_count = merge_count;
93 while (psize < k && q->next) {
99 while ((psize > 0) || (qsize > 0 && q)) {
100 if (qsize == 0 || !q) {
104 } else if (psize == 0) {
109 cmp = strcmp(q->name, p->name);
114 } else if (cmp > 0) {
119 if (hashcmp(q->sha1, p->sha1))
120 die("Duplicated ref, and SHA1s don't match: %s",
122 warning("Duplicated ref: %s", q->name);
146 } while ((last_merge_count != merge_count) || (last_merge_count != 1));
152 * Future: need to be in "struct repository"
153 * when doing a full libification.
155 static struct cached_refs {
158 struct ref_list *loose;
159 struct ref_list *packed;
161 static struct ref_list *current_ref;
163 static struct ref_list *extra_refs;
165 static void free_ref_list(struct ref_list *list)
167 struct ref_list *next;
168 for ( ; list; list = next) {
174 static void invalidate_cached_refs(void)
176 struct cached_refs *ca = &cached_refs;
178 if (ca->did_loose && ca->loose)
179 free_ref_list(ca->loose);
180 if (ca->did_packed && ca->packed)
181 free_ref_list(ca->packed);
182 ca->loose = ca->packed = NULL;
183 ca->did_loose = ca->did_packed = 0;
186 static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
188 struct ref_list *list = NULL;
189 struct ref_list *last = NULL;
190 char refline[PATH_MAX];
191 int flag = REF_ISPACKED;
193 while (fgets(refline, sizeof(refline), f)) {
194 unsigned char sha1[20];
196 static const char header[] = "# pack-refs with:";
198 if (!strncmp(refline, header, sizeof(header)-1)) {
199 const char *traits = refline + sizeof(header) - 1;
200 if (strstr(traits, " peeled "))
201 flag |= REF_KNOWS_PEELED;
202 /* perhaps other traits later as well */
206 name = parse_ref_line(refline, sha1);
208 list = add_ref(name, sha1, flag, list, &last);
213 strlen(refline) == 42 &&
214 refline[41] == '\n' &&
215 !get_sha1_hex(refline + 1, sha1))
216 hashcpy(last->peeled, sha1);
218 cached_refs->packed = sort_ref_list(list);
221 void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
223 extra_refs = add_ref(name, sha1, flag, extra_refs, NULL);
226 void clear_extra_refs(void)
228 free_ref_list(extra_refs);
232 static struct ref_list *get_packed_refs(void)
234 if (!cached_refs.did_packed) {
235 FILE *f = fopen(git_path("packed-refs"), "r");
236 cached_refs.packed = NULL;
238 read_packed_refs(f, &cached_refs);
241 cached_refs.did_packed = 1;
243 return cached_refs.packed;
246 static struct ref_list *get_ref_dir(const char *base, struct ref_list *list)
248 DIR *dir = opendir(git_path("%s", base));
252 int baselen = strlen(base);
253 char *ref = xmalloc(baselen + 257);
255 memcpy(ref, base, baselen);
256 if (baselen && base[baselen-1] != '/')
257 ref[baselen++] = '/';
259 while ((de = readdir(dir)) != NULL) {
260 unsigned char sha1[20];
265 if (de->d_name[0] == '.')
267 namelen = strlen(de->d_name);
270 if (has_extension(de->d_name, ".lock"))
272 memcpy(ref + baselen, de->d_name, namelen+1);
273 if (stat(git_path("%s", ref), &st) < 0)
275 if (S_ISDIR(st.st_mode)) {
276 list = get_ref_dir(ref, list);
279 if (!resolve_ref(ref, sha1, 1, &flag)) {
283 list = add_ref(ref, sha1, flag, list, NULL);
288 return sort_ref_list(list);
291 struct warn_if_dangling_data {
297 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
298 int flags, void *cb_data)
300 struct warn_if_dangling_data *d = cb_data;
301 const char *resolves_to;
302 unsigned char junk[20];
304 if (!(flags & REF_ISSYMREF))
307 resolves_to = resolve_ref(refname, junk, 0, NULL);
308 if (!resolves_to || strcmp(resolves_to, d->refname))
311 fprintf(d->fp, d->msg_fmt, refname);
315 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
317 struct warn_if_dangling_data data = { fp, refname, msg_fmt };
318 for_each_rawref(warn_if_dangling_symref, &data);
321 static struct ref_list *get_loose_refs(void)
323 if (!cached_refs.did_loose) {
324 cached_refs.loose = get_ref_dir("refs", NULL);
325 cached_refs.did_loose = 1;
327 return cached_refs.loose;
330 /* We allow "recursive" symbolic refs. Only within reason, though */
332 #define MAXREFLEN (1024)
334 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
337 struct cached_refs refs;
338 struct ref_list *ref;
341 strcpy(name + pathlen, "packed-refs");
342 f = fopen(name, "r");
345 read_packed_refs(f, &refs);
350 if (!strcmp(ref->name, refname)) {
352 memcpy(result, ref->sha1, 20);
357 free_ref_list(refs.packed);
361 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
363 int fd, len = strlen(refname);
364 char buffer[128], *p;
366 if (recursion > MAXDEPTH || len > MAXREFLEN)
368 memcpy(name + pathlen, refname, len+1);
369 fd = open(name, O_RDONLY);
371 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
373 len = read(fd, buffer, sizeof(buffer)-1);
377 while (len && isspace(buffer[len-1]))
381 /* Was it a detached head or an old-fashioned symlink? */
382 if (!get_sha1_hex(buffer, result))
386 if (strncmp(buffer, "ref:", 4))
392 return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
395 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
397 int len = strlen(path), retval;
401 while (len && path[len-1] == '/')
405 gitdir = xmalloc(len + MAXREFLEN + 8);
406 memcpy(gitdir, path, len);
407 memcpy(gitdir + len, "/.git", 6);
410 tmp = read_gitfile_gently(gitdir);
414 gitdir = xmalloc(len + MAXREFLEN + 3);
415 memcpy(gitdir, tmp, len);
418 gitdir[++len] = '\0';
419 retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
425 * If the "reading" argument is set, this function finds out what _object_
426 * the ref points at by "reading" the ref. The ref, if it is not symbolic,
427 * has to exist, and if it is symbolic, it has to point at an existing ref,
428 * because the "read" goes through the symref to the ref it points at.
430 * The access that is not "reading" may often be "writing", but does not
431 * have to; it can be merely checking _where it leads to_. If it is a
432 * prelude to "writing" to the ref, a write to a symref that points at
433 * yet-to-be-born ref will create the real ref pointed by the symref.
434 * reading=0 allows the caller to check where such a symref leads to.
436 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
438 int depth = MAXDEPTH;
441 static char ref_buffer[256];
455 git_snpath(path, sizeof(path), "%s", ref);
456 /* Special case: non-existing file. */
457 if (lstat(path, &st) < 0) {
458 struct ref_list *list = get_packed_refs();
460 if (!strcmp(ref, list->name)) {
461 hashcpy(sha1, list->sha1);
463 *flag |= REF_ISPACKED;
468 if (reading || errno != ENOENT)
474 /* Follow "normalized" - ie "refs/.." symlinks by hand */
475 if (S_ISLNK(st.st_mode)) {
476 len = readlink(path, buffer, sizeof(buffer)-1);
477 if (len >= 5 && !memcmp("refs/", buffer, 5)) {
479 strcpy(ref_buffer, buffer);
482 *flag |= REF_ISSYMREF;
487 /* Is it a directory? */
488 if (S_ISDIR(st.st_mode)) {
494 * Anything else, just open it and try to use it as
497 fd = open(path, O_RDONLY);
500 len = read_in_full(fd, buffer, sizeof(buffer)-1);
504 * Is it a symbolic ref?
506 if (len < 4 || memcmp("ref:", buffer, 4))
510 while (len && isspace(*buf))
512 while (len && isspace(buf[len-1]))
515 memcpy(ref_buffer, buf, len + 1);
518 *flag |= REF_ISSYMREF;
520 if (len < 40 || get_sha1_hex(buffer, sha1))
525 /* The argument to filter_refs */
532 int read_ref(const char *ref, unsigned char *sha1)
534 if (resolve_ref(ref, sha1, 1, NULL))
539 #define DO_FOR_EACH_INCLUDE_BROKEN 01
540 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
541 int flags, void *cb_data, struct ref_list *entry)
543 if (strncmp(base, entry->name, trim))
546 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
547 if (entry->flag & REF_BROKEN)
548 return 0; /* ignore dangling symref */
549 if (!has_sha1_file(entry->sha1)) {
550 error("%s does not point to a valid object!", entry->name);
555 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
558 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
561 struct ref_filter *filter = (struct ref_filter *)data;
562 if (fnmatch(filter->pattern, ref, 0))
564 return filter->fn(ref, sha, flags, filter->cb_data);
567 int peel_ref(const char *ref, unsigned char *sha1)
570 unsigned char base[20];
573 if (current_ref && (current_ref->name == ref
574 || !strcmp(current_ref->name, ref))) {
575 if (current_ref->flag & REF_KNOWS_PEELED) {
576 hashcpy(sha1, current_ref->peeled);
579 hashcpy(base, current_ref->sha1);
583 if (!resolve_ref(ref, base, 1, &flag))
586 if ((flag & REF_ISPACKED)) {
587 struct ref_list *list = get_packed_refs();
590 if (!strcmp(list->name, ref)) {
591 if (list->flag & REF_KNOWS_PEELED) {
592 hashcpy(sha1, list->peeled);
595 /* older pack-refs did not leave peeled ones */
603 o = parse_object(base);
604 if (o && o->type == OBJ_TAG) {
605 o = deref_tag(o, ref, 0);
607 hashcpy(sha1, o->sha1);
614 static int do_for_each_ref(const char *base, each_ref_fn fn, int trim,
615 int flags, void *cb_data)
618 struct ref_list *packed = get_packed_refs();
619 struct ref_list *loose = get_loose_refs();
621 struct ref_list *extra;
623 for (extra = extra_refs; extra; extra = extra->next)
624 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
626 while (packed && loose) {
627 struct ref_list *entry;
628 int cmp = strcmp(packed->name, loose->name);
630 packed = packed->next;
638 packed = packed->next;
640 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
645 for (packed = packed ? packed : loose; packed; packed = packed->next) {
646 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
656 int head_ref(each_ref_fn fn, void *cb_data)
658 unsigned char sha1[20];
661 if (resolve_ref("HEAD", sha1, 1, &flag))
662 return fn("HEAD", sha1, flag, cb_data);
666 int for_each_ref(each_ref_fn fn, void *cb_data)
668 return do_for_each_ref("refs/", fn, 0, 0, cb_data);
671 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
673 return do_for_each_ref(prefix, fn, strlen(prefix), 0, cb_data);
676 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
678 return for_each_ref_in("refs/tags/", fn, cb_data);
681 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
683 return for_each_ref_in("refs/heads/", fn, cb_data);
686 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
688 return for_each_ref_in("refs/remotes/", fn, cb_data);
691 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
693 return do_for_each_ref("refs/replace/", fn, 13, 0, cb_data);
696 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
697 const char *prefix, void *cb_data)
699 struct strbuf real_pattern = STRBUF_INIT;
700 struct ref_filter filter;
703 if (!prefix && prefixcmp(pattern, "refs/"))
704 strbuf_addstr(&real_pattern, "refs/");
706 strbuf_addstr(&real_pattern, prefix);
707 strbuf_addstr(&real_pattern, pattern);
709 if (!has_glob_specials(pattern)) {
710 /* Append implied '/' '*' if not present. */
711 if (real_pattern.buf[real_pattern.len - 1] != '/')
712 strbuf_addch(&real_pattern, '/');
713 /* No need to check for '*', there is none. */
714 strbuf_addch(&real_pattern, '*');
717 filter.pattern = real_pattern.buf;
719 filter.cb_data = cb_data;
720 ret = for_each_ref(filter_refs, &filter);
722 strbuf_release(&real_pattern);
726 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
728 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
731 int for_each_rawref(each_ref_fn fn, void *cb_data)
733 return do_for_each_ref("refs/", fn, 0,
734 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
738 * Make sure "ref" is something reasonable to have under ".git/refs/";
739 * We do not like it if:
741 * - any path component of it begins with ".", or
742 * - it has double dots "..", or
743 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
744 * - it ends with a "/".
745 * - it ends with ".lock"
746 * - it contains a "\" (backslash)
749 static inline int bad_ref_char(int ch)
751 if (((unsigned) ch) <= ' ' ||
752 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
754 /* 2.13 Pattern Matching Notation */
755 if (ch == '?' || ch == '[') /* Unsupported */
757 if (ch == '*') /* Supported at the end */
762 int check_ref_format(const char *ref)
764 int ch, level, bad_type, last;
765 int ret = CHECK_REF_FORMAT_OK;
766 const char *cp = ref;
770 while ((ch = *cp++) == '/')
771 ; /* tolerate duplicated slashes */
773 /* should not end with slashes */
774 return CHECK_REF_FORMAT_ERROR;
776 /* we are at the beginning of the path component */
778 return CHECK_REF_FORMAT_ERROR;
779 bad_type = bad_ref_char(ch);
781 if (bad_type == 2 && (!*cp || *cp == '/') &&
782 ret == CHECK_REF_FORMAT_OK)
783 ret = CHECK_REF_FORMAT_WILDCARD;
785 return CHECK_REF_FORMAT_ERROR;
789 /* scan the rest of the path component */
790 while ((ch = *cp++) != 0) {
791 bad_type = bad_ref_char(ch);
793 return CHECK_REF_FORMAT_ERROR;
796 if (last == '.' && ch == '.')
797 return CHECK_REF_FORMAT_ERROR;
798 if (last == '@' && ch == '{')
799 return CHECK_REF_FORMAT_ERROR;
804 if (ref <= cp - 2 && cp[-2] == '.')
805 return CHECK_REF_FORMAT_ERROR;
807 return CHECK_REF_FORMAT_ONELEVEL;
808 if (has_extension(ref, ".lock"))
809 return CHECK_REF_FORMAT_ERROR;
815 const char *prettify_refname(const char *name)
818 !prefixcmp(name, "refs/heads/") ? 11 :
819 !prefixcmp(name, "refs/tags/") ? 10 :
820 !prefixcmp(name, "refs/remotes/") ? 13 :
824 const char *ref_rev_parse_rules[] = {
830 "refs/remotes/%.*s/HEAD",
834 const char *ref_fetch_rules[] = {
841 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
844 const int abbrev_name_len = strlen(abbrev_name);
846 for (p = rules; *p; p++) {
847 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
855 static struct ref_lock *verify_lock(struct ref_lock *lock,
856 const unsigned char *old_sha1, int mustexist)
858 if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
859 error("Can't verify ref %s", lock->ref_name);
863 if (hashcmp(lock->old_sha1, old_sha1)) {
864 error("Ref %s is at %s but expected %s", lock->ref_name,
865 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
872 static int remove_empty_directories(const char *file)
874 /* we want to create a file but there is a directory there;
875 * if that is an empty directory (or a directory that contains
876 * only empty directories), remove them.
881 strbuf_init(&path, 20);
882 strbuf_addstr(&path, file);
884 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
886 strbuf_release(&path);
891 static int is_refname_available(const char *ref, const char *oldref,
892 struct ref_list *list, int quiet)
894 int namlen = strlen(ref); /* e.g. 'foo/bar' */
896 /* list->name could be 'foo' or 'foo/bar/baz' */
897 if (!oldref || strcmp(oldref, list->name)) {
898 int len = strlen(list->name);
899 int cmplen = (namlen < len) ? namlen : len;
900 const char *lead = (namlen < len) ? list->name : ref;
901 if (!strncmp(ref, list->name, cmplen) &&
902 lead[cmplen] == '/') {
904 error("'%s' exists; cannot create '%s'",
914 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
917 const char *orig_ref = ref;
918 struct ref_lock *lock;
921 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
924 lock = xcalloc(1, sizeof(struct ref_lock));
927 ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
928 if (!ref && errno == EISDIR) {
929 /* we are trying to lock foo but we used to
930 * have foo/bar which now does not exist;
931 * it is normal for the empty directory 'foo'
934 ref_file = git_path("%s", orig_ref);
935 if (remove_empty_directories(ref_file)) {
937 error("there are still refs under '%s'", orig_ref);
940 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
946 error("unable to resolve reference %s: %s",
947 orig_ref, strerror(errno));
950 missing = is_null_sha1(lock->old_sha1);
951 /* When the ref did not exist and we are creating it,
952 * make sure there is no existing ref that is packed
953 * whose name begins with our refname, nor a ref whose
954 * name is a proper prefix of our refname.
957 !is_refname_available(ref, NULL, get_packed_refs(), 0)) {
958 last_errno = ENOTDIR;
962 lock->lk = xcalloc(1, sizeof(struct lock_file));
964 lflags = LOCK_DIE_ON_ERROR;
965 if (flags & REF_NODEREF) {
967 lflags |= LOCK_NODEREF;
969 lock->ref_name = xstrdup(ref);
970 lock->orig_ref_name = xstrdup(orig_ref);
971 ref_file = git_path("%s", ref);
973 lock->force_write = 1;
974 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
975 lock->force_write = 1;
977 if (safe_create_leading_directories(ref_file)) {
979 error("unable to create directory for %s", ref_file);
983 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
984 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
992 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
994 char refpath[PATH_MAX];
995 if (check_ref_format(ref))
997 strcpy(refpath, mkpath("refs/%s", ref));
998 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1001 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1003 switch (check_ref_format(ref)) {
1007 case CHECK_REF_FORMAT_ONELEVEL:
1008 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1012 static struct lock_file packlock;
1014 static int repack_without_ref(const char *refname)
1016 struct ref_list *list, *packed_ref_list;
1020 packed_ref_list = get_packed_refs();
1021 for (list = packed_ref_list; list; list = list->next) {
1022 if (!strcmp(refname, list->name)) {
1029 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1031 unable_to_lock_error(git_path("packed-refs"), errno);
1032 return error("cannot delete '%s' from packed refs", refname);
1035 for (list = packed_ref_list; list; list = list->next) {
1036 char line[PATH_MAX + 100];
1039 if (!strcmp(refname, list->name))
1041 len = snprintf(line, sizeof(line), "%s %s\n",
1042 sha1_to_hex(list->sha1), list->name);
1043 /* this should not happen but just being defensive */
1044 if (len > sizeof(line))
1045 die("too long a refname '%s'", list->name);
1046 write_or_die(fd, line, len);
1048 return commit_lock_file(&packlock);
1051 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1053 struct ref_lock *lock;
1054 int err, i = 0, ret = 0, flag = 0;
1056 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1059 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1063 if (!(delopt & REF_NODEREF)) {
1064 i = strlen(lock->lk->filename) - 5; /* .lock */
1065 lock->lk->filename[i] = 0;
1066 path = lock->lk->filename;
1068 path = git_path("%s", refname);
1070 err = unlink_or_warn(path);
1071 if (err && errno != ENOENT)
1074 if (!(delopt & REF_NODEREF))
1075 lock->lk->filename[i] = '.';
1077 /* removing the loose one could have resurrected an earlier
1078 * packed one. Also, if it was not loose we need to repack
1081 ret |= repack_without_ref(refname);
1083 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1084 invalidate_cached_refs();
1089 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1091 static const char renamed_ref[] = "RENAMED-REF";
1092 unsigned char sha1[20], orig_sha1[20];
1093 int flag = 0, logmoved = 0;
1094 struct ref_lock *lock;
1095 struct stat loginfo;
1096 int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1097 const char *symref = NULL;
1099 if (log && S_ISLNK(loginfo.st_mode))
1100 return error("reflog for %s is a symlink", oldref);
1102 symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1103 if (flag & REF_ISSYMREF)
1104 return error("refname %s is a symbolic ref, renaming it is not supported",
1107 return error("refname %s not found", oldref);
1109 if (!is_refname_available(newref, oldref, get_packed_refs(), 0))
1112 if (!is_refname_available(newref, oldref, get_loose_refs(), 0))
1115 lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1117 return error("unable to lock %s", renamed_ref);
1118 lock->force_write = 1;
1119 if (write_ref_sha1(lock, orig_sha1, logmsg))
1120 return error("unable to save current sha1 in %s", renamed_ref);
1122 if (log && rename(git_path("logs/%s", oldref), git_path("tmp-renamed-log")))
1123 return error("unable to move logfile logs/%s to tmp-renamed-log: %s",
1124 oldref, strerror(errno));
1126 if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1127 error("unable to delete old %s", oldref);
1131 if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1132 if (errno==EISDIR) {
1133 if (remove_empty_directories(git_path("%s", newref))) {
1134 error("Directory not empty: %s", newref);
1138 error("unable to delete existing %s", newref);
1143 if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1144 error("unable to create directory for %s", newref);
1149 if (log && rename(git_path("tmp-renamed-log"), git_path("logs/%s", newref))) {
1150 if (errno==EISDIR || errno==ENOTDIR) {
1152 * rename(a, b) when b is an existing
1153 * directory ought to result in ISDIR, but
1154 * Solaris 5.8 gives ENOTDIR. Sheesh.
1156 if (remove_empty_directories(git_path("logs/%s", newref))) {
1157 error("Directory not empty: logs/%s", newref);
1162 error("unable to move logfile tmp-renamed-log to logs/%s: %s",
1163 newref, strerror(errno));
1169 lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1171 error("unable to lock %s for update", newref);
1174 lock->force_write = 1;
1175 hashcpy(lock->old_sha1, orig_sha1);
1176 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1177 error("unable to write current sha1 into %s", newref);
1184 lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1186 error("unable to lock %s for rollback", oldref);
1190 lock->force_write = 1;
1191 flag = log_all_ref_updates;
1192 log_all_ref_updates = 0;
1193 if (write_ref_sha1(lock, orig_sha1, NULL))
1194 error("unable to write current sha1 into %s", oldref);
1195 log_all_ref_updates = flag;
1198 if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1199 error("unable to restore logfile %s from %s: %s",
1200 oldref, newref, strerror(errno));
1201 if (!logmoved && log &&
1202 rename(git_path("tmp-renamed-log"), git_path("logs/%s", oldref)))
1203 error("unable to restore logfile %s from tmp-renamed-log: %s",
1204 oldref, strerror(errno));
1209 int close_ref(struct ref_lock *lock)
1211 if (close_lock_file(lock->lk))
1217 int commit_ref(struct ref_lock *lock)
1219 if (commit_lock_file(lock->lk))
1225 void unlock_ref(struct ref_lock *lock)
1227 /* Do not free lock->lk -- atexit() still looks at them */
1229 rollback_lock_file(lock->lk);
1230 free(lock->ref_name);
1231 free(lock->orig_ref_name);
1236 * copy the reflog message msg to buf, which has been allocated sufficiently
1237 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1238 * because reflog file is one line per entry.
1240 static int copy_msg(char *buf, const char *msg)
1247 while ((c = *msg++)) {
1248 if (wasspace && isspace(c))
1250 wasspace = isspace(c);
1255 while (buf < cp && isspace(cp[-1]))
1261 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1263 int logfd, oflags = O_APPEND | O_WRONLY;
1265 git_snpath(logfile, bufsize, "logs/%s", ref_name);
1266 if (log_all_ref_updates &&
1267 (!prefixcmp(ref_name, "refs/heads/") ||
1268 !prefixcmp(ref_name, "refs/remotes/") ||
1269 !prefixcmp(ref_name, "refs/notes/") ||
1270 !strcmp(ref_name, "HEAD"))) {
1271 if (safe_create_leading_directories(logfile) < 0)
1272 return error("unable to create directory for %s",
1277 logfd = open(logfile, oflags, 0666);
1279 if (!(oflags & O_CREAT) && errno == ENOENT)
1282 if ((oflags & O_CREAT) && errno == EISDIR) {
1283 if (remove_empty_directories(logfile)) {
1284 return error("There are still logs under '%s'",
1287 logfd = open(logfile, oflags, 0666);
1291 return error("Unable to append to %s: %s",
1292 logfile, strerror(errno));
1295 adjust_shared_perm(logfile);
1300 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1301 const unsigned char *new_sha1, const char *msg)
1303 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1304 unsigned maxlen, len;
1306 char log_file[PATH_MAX];
1308 const char *committer;
1310 if (log_all_ref_updates < 0)
1311 log_all_ref_updates = !is_bare_repository();
1313 result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1317 logfd = open(log_file, oflags);
1320 msglen = msg ? strlen(msg) : 0;
1321 committer = git_committer_info(0);
1322 maxlen = strlen(committer) + msglen + 100;
1323 logrec = xmalloc(maxlen);
1324 len = sprintf(logrec, "%s %s %s\n",
1325 sha1_to_hex(old_sha1),
1326 sha1_to_hex(new_sha1),
1329 len += copy_msg(logrec + len - 1, msg) - 1;
1330 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1332 if (close(logfd) != 0 || written != len)
1333 return error("Unable to append to %s", log_file);
1337 static int is_branch(const char *refname)
1339 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1342 int write_ref_sha1(struct ref_lock *lock,
1343 const unsigned char *sha1, const char *logmsg)
1345 static char term = '\n';
1350 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1354 o = parse_object(sha1);
1356 error("Trying to write ref %s with nonexistant object %s",
1357 lock->ref_name, sha1_to_hex(sha1));
1361 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1362 error("Trying to write non-commit object %s to branch %s",
1363 sha1_to_hex(sha1), lock->ref_name);
1367 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1368 write_in_full(lock->lock_fd, &term, 1) != 1
1369 || close_ref(lock) < 0) {
1370 error("Couldn't write %s", lock->lk->filename);
1374 invalidate_cached_refs();
1375 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1376 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1377 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1381 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1383 * Special hack: If a branch is updated directly and HEAD
1384 * points to it (may happen on the remote side of a push
1385 * for example) then logically the HEAD reflog should be
1387 * A generic solution implies reverse symref information,
1388 * but finding all symrefs pointing to the given branch
1389 * would be rather costly for this rare event (the direct
1390 * update of a branch) to be worth it. So let's cheat and
1391 * check with HEAD only which should cover 99% of all usage
1392 * scenarios (even 100% of the default ones).
1394 unsigned char head_sha1[20];
1396 const char *head_ref;
1397 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1398 if (head_ref && (head_flag & REF_ISSYMREF) &&
1399 !strcmp(head_ref, lock->ref_name))
1400 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1402 if (commit_ref(lock)) {
1403 error("Couldn't set %s", lock->ref_name);
1411 int create_symref(const char *ref_target, const char *refs_heads_master,
1414 const char *lockpath;
1416 int fd, len, written;
1417 char *git_HEAD = git_pathdup("%s", ref_target);
1418 unsigned char old_sha1[20], new_sha1[20];
1420 if (logmsg && read_ref(ref_target, old_sha1))
1423 if (safe_create_leading_directories(git_HEAD) < 0)
1424 return error("unable to create directory for %s", git_HEAD);
1426 #ifndef NO_SYMLINK_HEAD
1427 if (prefer_symlink_refs) {
1429 if (!symlink(refs_heads_master, git_HEAD))
1431 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1435 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1436 if (sizeof(ref) <= len) {
1437 error("refname too long: %s", refs_heads_master);
1438 goto error_free_return;
1440 lockpath = mkpath("%s.lock", git_HEAD);
1441 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1443 error("Unable to open %s for writing", lockpath);
1444 goto error_free_return;
1446 written = write_in_full(fd, ref, len);
1447 if (close(fd) != 0 || written != len) {
1448 error("Unable to write to %s", lockpath);
1449 goto error_unlink_return;
1451 if (rename(lockpath, git_HEAD) < 0) {
1452 error("Unable to create %s", git_HEAD);
1453 goto error_unlink_return;
1455 if (adjust_shared_perm(git_HEAD)) {
1456 error("Unable to fix permissions on %s", lockpath);
1457 error_unlink_return:
1458 unlink_or_warn(lockpath);
1464 #ifndef NO_SYMLINK_HEAD
1467 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1468 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1474 static char *ref_msg(const char *line, const char *endp)
1478 ep = memchr(line, '\n', endp - line);
1481 return xmemdupz(line, ep - line);
1484 int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1486 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1488 int logfd, tz, reccnt = 0;
1491 unsigned char logged_sha1[20];
1495 logfile = git_path("logs/%s", ref);
1496 logfd = open(logfile, O_RDONLY, 0);
1498 die_errno("Unable to read log '%s'", logfile);
1501 die("Log %s is empty.", logfile);
1502 mapsz = xsize_t(st.st_size);
1503 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1504 logdata = log_mapped;
1508 rec = logend = logdata + st.st_size;
1509 while (logdata < rec) {
1511 if (logdata < rec && *(rec-1) == '\n')
1514 while (logdata < rec && *(rec-1) != '\n') {
1520 die("Log %s is corrupt.", logfile);
1521 date = strtoul(lastgt + 1, &tz_c, 10);
1522 if (date <= at_time || cnt == 0) {
1523 tz = strtoul(tz_c, NULL, 10);
1525 *msg = ref_msg(rec, logend);
1527 *cutoff_time = date;
1531 *cutoff_cnt = reccnt - 1;
1533 if (get_sha1_hex(lastrec, logged_sha1))
1534 die("Log %s is corrupt.", logfile);
1535 if (get_sha1_hex(rec + 41, sha1))
1536 die("Log %s is corrupt.", logfile);
1537 if (hashcmp(logged_sha1, sha1)) {
1538 warning("Log %s has gap after %s.",
1539 logfile, show_date(date, tz, DATE_RFC2822));
1542 else if (date == at_time) {
1543 if (get_sha1_hex(rec + 41, sha1))
1544 die("Log %s is corrupt.", logfile);
1547 if (get_sha1_hex(rec + 41, logged_sha1))
1548 die("Log %s is corrupt.", logfile);
1549 if (hashcmp(logged_sha1, sha1)) {
1550 warning("Log %s unexpectedly ended on %s.",
1551 logfile, show_date(date, tz, DATE_RFC2822));
1554 munmap(log_mapped, mapsz);
1563 while (rec < logend && *rec != '>' && *rec != '\n')
1565 if (rec == logend || *rec == '\n')
1566 die("Log %s is corrupt.", logfile);
1567 date = strtoul(rec + 1, &tz_c, 10);
1568 tz = strtoul(tz_c, NULL, 10);
1569 if (get_sha1_hex(logdata, sha1))
1570 die("Log %s is corrupt.", logfile);
1571 if (is_null_sha1(sha1)) {
1572 if (get_sha1_hex(logdata + 41, sha1))
1573 die("Log %s is corrupt.", logfile);
1576 *msg = ref_msg(logdata, logend);
1577 munmap(log_mapped, mapsz);
1580 *cutoff_time = date;
1584 *cutoff_cnt = reccnt;
1588 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1590 const char *logfile;
1592 struct strbuf sb = STRBUF_INIT;
1595 logfile = git_path("logs/%s", ref);
1596 logfp = fopen(logfile, "r");
1601 struct stat statbuf;
1602 if (fstat(fileno(logfp), &statbuf) ||
1603 statbuf.st_size < ofs ||
1604 fseek(logfp, -ofs, SEEK_END) ||
1605 strbuf_getwholeline(&sb, logfp, '\n')) {
1607 strbuf_release(&sb);
1612 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1613 unsigned char osha1[20], nsha1[20];
1614 char *email_end, *message;
1615 unsigned long timestamp;
1618 /* old SP new SP name <email> SP time TAB msg LF */
1619 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1620 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1621 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1622 !(email_end = strchr(sb.buf + 82, '>')) ||
1623 email_end[1] != ' ' ||
1624 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1625 !message || message[0] != ' ' ||
1626 (message[1] != '+' && message[1] != '-') ||
1627 !isdigit(message[2]) || !isdigit(message[3]) ||
1628 !isdigit(message[4]) || !isdigit(message[5]))
1629 continue; /* corrupt? */
1630 email_end[1] = '\0';
1631 tz = strtol(message + 1, NULL, 10);
1632 if (message[6] != '\t')
1636 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1642 strbuf_release(&sb);
1646 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1648 return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1651 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1653 DIR *dir = opendir(git_path("logs/%s", base));
1658 int baselen = strlen(base);
1659 char *log = xmalloc(baselen + 257);
1661 memcpy(log, base, baselen);
1662 if (baselen && base[baselen-1] != '/')
1663 log[baselen++] = '/';
1665 while ((de = readdir(dir)) != NULL) {
1669 if (de->d_name[0] == '.')
1671 namelen = strlen(de->d_name);
1674 if (has_extension(de->d_name, ".lock"))
1676 memcpy(log + baselen, de->d_name, namelen+1);
1677 if (stat(git_path("logs/%s", log), &st) < 0)
1679 if (S_ISDIR(st.st_mode)) {
1680 retval = do_for_each_reflog(log, fn, cb_data);
1682 unsigned char sha1[20];
1683 if (!resolve_ref(log, sha1, 0, NULL))
1684 retval = error("bad ref for %s", log);
1686 retval = fn(log, sha1, 0, cb_data);
1699 int for_each_reflog(each_ref_fn fn, void *cb_data)
1701 return do_for_each_reflog("", fn, cb_data);
1704 int update_ref(const char *action, const char *refname,
1705 const unsigned char *sha1, const unsigned char *oldval,
1706 int flags, enum action_on_err onerr)
1708 static struct ref_lock *lock;
1709 lock = lock_any_ref_for_update(refname, oldval, flags);
1711 const char *str = "Cannot lock the ref '%s'.";
1713 case MSG_ON_ERR: error(str, refname); break;
1714 case DIE_ON_ERR: die(str, refname); break;
1715 case QUIET_ON_ERR: break;
1719 if (write_ref_sha1(lock, sha1, action) < 0) {
1720 const char *str = "Cannot update the ref '%s'.";
1722 case MSG_ON_ERR: error(str, refname); break;
1723 case DIE_ON_ERR: die(str, refname); break;
1724 case QUIET_ON_ERR: break;
1731 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1733 for ( ; list; list = list->next)
1734 if (!strcmp(list->name, name))
1735 return (struct ref *)list;
1740 * generate a format suitable for scanf from a ref_rev_parse_rules
1741 * rule, that is replace the "%.*s" spec with a "%s" spec
1743 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1747 spec = strstr(rule, "%.*s");
1748 if (!spec || strstr(spec + 4, "%.*s"))
1749 die("invalid rule in ref_rev_parse_rules: %s", rule);
1751 /* copy all until spec */
1752 strncpy(scanf_fmt, rule, spec - rule);
1753 scanf_fmt[spec - rule] = '\0';
1755 strcat(scanf_fmt, "%s");
1756 /* copy remaining rule */
1757 strcat(scanf_fmt, spec + 4);
1762 char *shorten_unambiguous_ref(const char *ref, int strict)
1765 static char **scanf_fmts;
1766 static int nr_rules;
1769 /* pre generate scanf formats from ref_rev_parse_rules[] */
1771 size_t total_len = 0;
1773 /* the rule list is NULL terminated, count them first */
1774 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1775 /* no +1 because strlen("%s") < strlen("%.*s") */
1776 total_len += strlen(ref_rev_parse_rules[nr_rules]);
1778 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1781 for (i = 0; i < nr_rules; i++) {
1782 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1784 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1785 total_len += strlen(ref_rev_parse_rules[i]);
1789 /* bail out if there are no rules */
1791 return xstrdup(ref);
1793 /* buffer for scanf result, at most ref must fit */
1794 short_name = xstrdup(ref);
1796 /* skip first rule, it will always match */
1797 for (i = nr_rules - 1; i > 0 ; --i) {
1799 int rules_to_fail = i;
1802 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1805 short_name_len = strlen(short_name);
1808 * in strict mode, all (except the matched one) rules
1809 * must fail to resolve to a valid non-ambiguous ref
1812 rules_to_fail = nr_rules;
1815 * check if the short name resolves to a valid ref,
1816 * but use only rules prior to the matched one
1818 for (j = 0; j < rules_to_fail; j++) {
1819 const char *rule = ref_rev_parse_rules[j];
1820 unsigned char short_objectname[20];
1821 char refname[PATH_MAX];
1823 /* skip matched rule */
1828 * the short name is ambiguous, if it resolves
1829 * (with this previous rule) to a valid ref
1830 * read_ref() returns 0 on success
1832 mksnpath(refname, sizeof(refname),
1833 rule, short_name_len, short_name);
1834 if (!read_ref(refname, short_objectname))
1839 * short name is non-ambiguous if all previous rules
1840 * haven't resolved to a valid ref
1842 if (j == rules_to_fail)
1847 return xstrdup(ref);