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;
320 data.refname = refname;
321 data.msg_fmt = msg_fmt;
322 for_each_rawref(warn_if_dangling_symref, &data);
325 static struct ref_list *get_loose_refs(void)
327 if (!cached_refs.did_loose) {
328 cached_refs.loose = get_ref_dir("refs", NULL);
329 cached_refs.did_loose = 1;
331 return cached_refs.loose;
334 /* We allow "recursive" symbolic refs. Only within reason, though */
336 #define MAXREFLEN (1024)
338 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
341 struct cached_refs refs;
342 struct ref_list *ref;
345 strcpy(name + pathlen, "packed-refs");
346 f = fopen(name, "r");
349 read_packed_refs(f, &refs);
354 if (!strcmp(ref->name, refname)) {
356 memcpy(result, ref->sha1, 20);
361 free_ref_list(refs.packed);
365 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
367 int fd, len = strlen(refname);
368 char buffer[128], *p;
370 if (recursion > MAXDEPTH || len > MAXREFLEN)
372 memcpy(name + pathlen, refname, len+1);
373 fd = open(name, O_RDONLY);
375 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
377 len = read(fd, buffer, sizeof(buffer)-1);
381 while (len && isspace(buffer[len-1]))
385 /* Was it a detached head or an old-fashioned symlink? */
386 if (!get_sha1_hex(buffer, result))
390 if (strncmp(buffer, "ref:", 4))
396 return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
399 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
401 int len = strlen(path), retval;
405 while (len && path[len-1] == '/')
409 gitdir = xmalloc(len + MAXREFLEN + 8);
410 memcpy(gitdir, path, len);
411 memcpy(gitdir + len, "/.git", 6);
414 tmp = read_gitfile_gently(gitdir);
418 gitdir = xmalloc(len + MAXREFLEN + 3);
419 memcpy(gitdir, tmp, len);
422 gitdir[++len] = '\0';
423 retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
429 * If the "reading" argument is set, this function finds out what _object_
430 * the ref points at by "reading" the ref. The ref, if it is not symbolic,
431 * has to exist, and if it is symbolic, it has to point at an existing ref,
432 * because the "read" goes through the symref to the ref it points at.
434 * The access that is not "reading" may often be "writing", but does not
435 * have to; it can be merely checking _where it leads to_. If it is a
436 * prelude to "writing" to the ref, a write to a symref that points at
437 * yet-to-be-born ref will create the real ref pointed by the symref.
438 * reading=0 allows the caller to check where such a symref leads to.
440 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
442 int depth = MAXDEPTH;
445 static char ref_buffer[256];
459 git_snpath(path, sizeof(path), "%s", ref);
460 /* Special case: non-existing file. */
461 if (lstat(path, &st) < 0) {
462 struct ref_list *list = get_packed_refs();
464 if (!strcmp(ref, list->name)) {
465 hashcpy(sha1, list->sha1);
467 *flag |= REF_ISPACKED;
472 if (reading || errno != ENOENT)
478 /* Follow "normalized" - ie "refs/.." symlinks by hand */
479 if (S_ISLNK(st.st_mode)) {
480 len = readlink(path, buffer, sizeof(buffer)-1);
481 if (len >= 5 && !memcmp("refs/", buffer, 5)) {
483 strcpy(ref_buffer, buffer);
486 *flag |= REF_ISSYMREF;
491 /* Is it a directory? */
492 if (S_ISDIR(st.st_mode)) {
498 * Anything else, just open it and try to use it as
501 fd = open(path, O_RDONLY);
504 len = read_in_full(fd, buffer, sizeof(buffer)-1);
508 * Is it a symbolic ref?
510 if (len < 4 || memcmp("ref:", buffer, 4))
514 while (len && isspace(*buf))
516 while (len && isspace(buf[len-1]))
519 memcpy(ref_buffer, buf, len + 1);
522 *flag |= REF_ISSYMREF;
524 if (len < 40 || get_sha1_hex(buffer, sha1))
529 /* The argument to filter_refs */
536 int read_ref(const char *ref, unsigned char *sha1)
538 if (resolve_ref(ref, sha1, 1, NULL))
543 #define DO_FOR_EACH_INCLUDE_BROKEN 01
544 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
545 int flags, void *cb_data, struct ref_list *entry)
547 if (strncmp(base, entry->name, trim))
550 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
551 if (entry->flag & REF_BROKEN)
552 return 0; /* ignore dangling symref */
553 if (!has_sha1_file(entry->sha1)) {
554 error("%s does not point to a valid object!", entry->name);
559 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
562 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
565 struct ref_filter *filter = (struct ref_filter *)data;
566 if (fnmatch(filter->pattern, ref, 0))
568 return filter->fn(ref, sha, flags, filter->cb_data);
571 int peel_ref(const char *ref, unsigned char *sha1)
574 unsigned char base[20];
577 if (current_ref && (current_ref->name == ref
578 || !strcmp(current_ref->name, ref))) {
579 if (current_ref->flag & REF_KNOWS_PEELED) {
580 hashcpy(sha1, current_ref->peeled);
583 hashcpy(base, current_ref->sha1);
587 if (!resolve_ref(ref, base, 1, &flag))
590 if ((flag & REF_ISPACKED)) {
591 struct ref_list *list = get_packed_refs();
594 if (!strcmp(list->name, ref)) {
595 if (list->flag & REF_KNOWS_PEELED) {
596 hashcpy(sha1, list->peeled);
599 /* older pack-refs did not leave peeled ones */
607 o = parse_object(base);
608 if (o && o->type == OBJ_TAG) {
609 o = deref_tag(o, ref, 0);
611 hashcpy(sha1, o->sha1);
618 static int do_for_each_ref(const char *base, each_ref_fn fn, int trim,
619 int flags, void *cb_data)
622 struct ref_list *packed = get_packed_refs();
623 struct ref_list *loose = get_loose_refs();
625 struct ref_list *extra;
627 for (extra = extra_refs; extra; extra = extra->next)
628 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
630 while (packed && loose) {
631 struct ref_list *entry;
632 int cmp = strcmp(packed->name, loose->name);
634 packed = packed->next;
642 packed = packed->next;
644 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
649 for (packed = packed ? packed : loose; packed; packed = packed->next) {
650 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
660 int head_ref(each_ref_fn fn, void *cb_data)
662 unsigned char sha1[20];
665 if (resolve_ref("HEAD", sha1, 1, &flag))
666 return fn("HEAD", sha1, flag, cb_data);
670 int for_each_ref(each_ref_fn fn, void *cb_data)
672 return do_for_each_ref("refs/", fn, 0, 0, cb_data);
675 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
677 return do_for_each_ref(prefix, fn, strlen(prefix), 0, cb_data);
680 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
682 return for_each_ref_in("refs/tags/", fn, cb_data);
685 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
687 return for_each_ref_in("refs/heads/", fn, cb_data);
690 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
692 return for_each_ref_in("refs/remotes/", fn, cb_data);
695 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
697 return do_for_each_ref("refs/replace/", fn, 13, 0, cb_data);
700 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
701 const char *prefix, void *cb_data)
703 struct strbuf real_pattern = STRBUF_INIT;
704 struct ref_filter filter;
707 if (!prefix && prefixcmp(pattern, "refs/"))
708 strbuf_addstr(&real_pattern, "refs/");
710 strbuf_addstr(&real_pattern, prefix);
711 strbuf_addstr(&real_pattern, pattern);
713 if (!has_glob_specials(pattern)) {
714 /* Append implied '/' '*' if not present. */
715 if (real_pattern.buf[real_pattern.len - 1] != '/')
716 strbuf_addch(&real_pattern, '/');
717 /* No need to check for '*', there is none. */
718 strbuf_addch(&real_pattern, '*');
721 filter.pattern = real_pattern.buf;
723 filter.cb_data = cb_data;
724 ret = for_each_ref(filter_refs, &filter);
726 strbuf_release(&real_pattern);
730 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
732 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
735 int for_each_rawref(each_ref_fn fn, void *cb_data)
737 return do_for_each_ref("refs/", fn, 0,
738 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
742 * Make sure "ref" is something reasonable to have under ".git/refs/";
743 * We do not like it if:
745 * - any path component of it begins with ".", or
746 * - it has double dots "..", or
747 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
748 * - it ends with a "/".
749 * - it ends with ".lock"
750 * - it contains a "\" (backslash)
753 static inline int bad_ref_char(int ch)
755 if (((unsigned) ch) <= ' ' ||
756 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
758 /* 2.13 Pattern Matching Notation */
759 if (ch == '?' || ch == '[') /* Unsupported */
761 if (ch == '*') /* Supported at the end */
766 int check_ref_format(const char *ref)
768 int ch, level, bad_type, last;
769 int ret = CHECK_REF_FORMAT_OK;
770 const char *cp = ref;
774 while ((ch = *cp++) == '/')
775 ; /* tolerate duplicated slashes */
777 /* should not end with slashes */
778 return CHECK_REF_FORMAT_ERROR;
780 /* we are at the beginning of the path component */
782 return CHECK_REF_FORMAT_ERROR;
783 bad_type = bad_ref_char(ch);
785 if (bad_type == 2 && (!*cp || *cp == '/') &&
786 ret == CHECK_REF_FORMAT_OK)
787 ret = CHECK_REF_FORMAT_WILDCARD;
789 return CHECK_REF_FORMAT_ERROR;
793 /* scan the rest of the path component */
794 while ((ch = *cp++) != 0) {
795 bad_type = bad_ref_char(ch);
797 return CHECK_REF_FORMAT_ERROR;
800 if (last == '.' && ch == '.')
801 return CHECK_REF_FORMAT_ERROR;
802 if (last == '@' && ch == '{')
803 return CHECK_REF_FORMAT_ERROR;
808 if (ref <= cp - 2 && cp[-2] == '.')
809 return CHECK_REF_FORMAT_ERROR;
811 return CHECK_REF_FORMAT_ONELEVEL;
812 if (has_extension(ref, ".lock"))
813 return CHECK_REF_FORMAT_ERROR;
819 const char *prettify_refname(const char *name)
822 !prefixcmp(name, "refs/heads/") ? 11 :
823 !prefixcmp(name, "refs/tags/") ? 10 :
824 !prefixcmp(name, "refs/remotes/") ? 13 :
828 const char *ref_rev_parse_rules[] = {
834 "refs/remotes/%.*s/HEAD",
838 const char *ref_fetch_rules[] = {
845 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
848 const int abbrev_name_len = strlen(abbrev_name);
850 for (p = rules; *p; p++) {
851 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
859 static struct ref_lock *verify_lock(struct ref_lock *lock,
860 const unsigned char *old_sha1, int mustexist)
862 if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
863 error("Can't verify ref %s", lock->ref_name);
867 if (hashcmp(lock->old_sha1, old_sha1)) {
868 error("Ref %s is at %s but expected %s", lock->ref_name,
869 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
876 static int remove_empty_directories(const char *file)
878 /* we want to create a file but there is a directory there;
879 * if that is an empty directory (or a directory that contains
880 * only empty directories), remove them.
885 strbuf_init(&path, 20);
886 strbuf_addstr(&path, file);
888 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
890 strbuf_release(&path);
895 static int is_refname_available(const char *ref, const char *oldref,
896 struct ref_list *list, int quiet)
898 int namlen = strlen(ref); /* e.g. 'foo/bar' */
900 /* list->name could be 'foo' or 'foo/bar/baz' */
901 if (!oldref || strcmp(oldref, list->name)) {
902 int len = strlen(list->name);
903 int cmplen = (namlen < len) ? namlen : len;
904 const char *lead = (namlen < len) ? list->name : ref;
905 if (!strncmp(ref, list->name, cmplen) &&
906 lead[cmplen] == '/') {
908 error("'%s' exists; cannot create '%s'",
918 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
921 const char *orig_ref = ref;
922 struct ref_lock *lock;
925 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
928 lock = xcalloc(1, sizeof(struct ref_lock));
931 ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
932 if (!ref && errno == EISDIR) {
933 /* we are trying to lock foo but we used to
934 * have foo/bar which now does not exist;
935 * it is normal for the empty directory 'foo'
938 ref_file = git_path("%s", orig_ref);
939 if (remove_empty_directories(ref_file)) {
941 error("there are still refs under '%s'", orig_ref);
944 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
950 error("unable to resolve reference %s: %s",
951 orig_ref, strerror(errno));
954 missing = is_null_sha1(lock->old_sha1);
955 /* When the ref did not exist and we are creating it,
956 * make sure there is no existing ref that is packed
957 * whose name begins with our refname, nor a ref whose
958 * name is a proper prefix of our refname.
961 !is_refname_available(ref, NULL, get_packed_refs(), 0)) {
962 last_errno = ENOTDIR;
966 lock->lk = xcalloc(1, sizeof(struct lock_file));
968 lflags = LOCK_DIE_ON_ERROR;
969 if (flags & REF_NODEREF) {
971 lflags |= LOCK_NODEREF;
973 lock->ref_name = xstrdup(ref);
974 lock->orig_ref_name = xstrdup(orig_ref);
975 ref_file = git_path("%s", ref);
977 lock->force_write = 1;
978 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
979 lock->force_write = 1;
981 if (safe_create_leading_directories(ref_file)) {
983 error("unable to create directory for %s", ref_file);
987 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
988 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
996 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
998 char refpath[PATH_MAX];
999 if (check_ref_format(ref))
1001 strcpy(refpath, mkpath("refs/%s", ref));
1002 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1005 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1007 switch (check_ref_format(ref)) {
1011 case CHECK_REF_FORMAT_ONELEVEL:
1012 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1016 static struct lock_file packlock;
1018 static int repack_without_ref(const char *refname)
1020 struct ref_list *list, *packed_ref_list;
1024 packed_ref_list = get_packed_refs();
1025 for (list = packed_ref_list; list; list = list->next) {
1026 if (!strcmp(refname, list->name)) {
1033 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1035 unable_to_lock_error(git_path("packed-refs"), errno);
1036 return error("cannot delete '%s' from packed refs", refname);
1039 for (list = packed_ref_list; list; list = list->next) {
1040 char line[PATH_MAX + 100];
1043 if (!strcmp(refname, list->name))
1045 len = snprintf(line, sizeof(line), "%s %s\n",
1046 sha1_to_hex(list->sha1), list->name);
1047 /* this should not happen but just being defensive */
1048 if (len > sizeof(line))
1049 die("too long a refname '%s'", list->name);
1050 write_or_die(fd, line, len);
1052 return commit_lock_file(&packlock);
1055 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1057 struct ref_lock *lock;
1058 int err, i = 0, ret = 0, flag = 0;
1060 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1063 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1067 if (!(delopt & REF_NODEREF)) {
1068 i = strlen(lock->lk->filename) - 5; /* .lock */
1069 lock->lk->filename[i] = 0;
1070 path = lock->lk->filename;
1072 path = git_path("%s", refname);
1074 err = unlink_or_warn(path);
1075 if (err && errno != ENOENT)
1078 if (!(delopt & REF_NODEREF))
1079 lock->lk->filename[i] = '.';
1081 /* removing the loose one could have resurrected an earlier
1082 * packed one. Also, if it was not loose we need to repack
1085 ret |= repack_without_ref(refname);
1087 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1088 invalidate_cached_refs();
1094 * People using contrib's git-new-workdir have .git/logs/refs ->
1095 * /some/other/path/.git/logs/refs, and that may live on another device.
1097 * IOW, to avoid cross device rename errors, the temporary renamed log must
1098 * live into logs/refs.
1100 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1102 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1104 static const char renamed_ref[] = "RENAMED-REF";
1105 unsigned char sha1[20], orig_sha1[20];
1106 int flag = 0, logmoved = 0;
1107 struct ref_lock *lock;
1108 struct stat loginfo;
1109 int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1110 const char *symref = NULL;
1112 if (log && S_ISLNK(loginfo.st_mode))
1113 return error("reflog for %s is a symlink", oldref);
1115 symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1116 if (flag & REF_ISSYMREF)
1117 return error("refname %s is a symbolic ref, renaming it is not supported",
1120 return error("refname %s not found", oldref);
1122 if (!is_refname_available(newref, oldref, get_packed_refs(), 0))
1125 if (!is_refname_available(newref, oldref, get_loose_refs(), 0))
1128 lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1130 return error("unable to lock %s", renamed_ref);
1131 lock->force_write = 1;
1132 if (write_ref_sha1(lock, orig_sha1, logmsg))
1133 return error("unable to save current sha1 in %s", renamed_ref);
1135 if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1136 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1137 oldref, strerror(errno));
1139 if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1140 error("unable to delete old %s", oldref);
1144 if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1145 if (errno==EISDIR) {
1146 if (remove_empty_directories(git_path("%s", newref))) {
1147 error("Directory not empty: %s", newref);
1151 error("unable to delete existing %s", newref);
1156 if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1157 error("unable to create directory for %s", newref);
1162 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1163 if (errno==EISDIR || errno==ENOTDIR) {
1165 * rename(a, b) when b is an existing
1166 * directory ought to result in ISDIR, but
1167 * Solaris 5.8 gives ENOTDIR. Sheesh.
1169 if (remove_empty_directories(git_path("logs/%s", newref))) {
1170 error("Directory not empty: logs/%s", newref);
1175 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1176 newref, strerror(errno));
1182 lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1184 error("unable to lock %s for update", newref);
1187 lock->force_write = 1;
1188 hashcpy(lock->old_sha1, orig_sha1);
1189 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1190 error("unable to write current sha1 into %s", newref);
1197 lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1199 error("unable to lock %s for rollback", oldref);
1203 lock->force_write = 1;
1204 flag = log_all_ref_updates;
1205 log_all_ref_updates = 0;
1206 if (write_ref_sha1(lock, orig_sha1, NULL))
1207 error("unable to write current sha1 into %s", oldref);
1208 log_all_ref_updates = flag;
1211 if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1212 error("unable to restore logfile %s from %s: %s",
1213 oldref, newref, strerror(errno));
1214 if (!logmoved && log &&
1215 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1216 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1217 oldref, strerror(errno));
1222 int close_ref(struct ref_lock *lock)
1224 if (close_lock_file(lock->lk))
1230 int commit_ref(struct ref_lock *lock)
1232 if (commit_lock_file(lock->lk))
1238 void unlock_ref(struct ref_lock *lock)
1240 /* Do not free lock->lk -- atexit() still looks at them */
1242 rollback_lock_file(lock->lk);
1243 free(lock->ref_name);
1244 free(lock->orig_ref_name);
1249 * copy the reflog message msg to buf, which has been allocated sufficiently
1250 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1251 * because reflog file is one line per entry.
1253 static int copy_msg(char *buf, const char *msg)
1260 while ((c = *msg++)) {
1261 if (wasspace && isspace(c))
1263 wasspace = isspace(c);
1268 while (buf < cp && isspace(cp[-1]))
1274 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1276 int logfd, oflags = O_APPEND | O_WRONLY;
1278 git_snpath(logfile, bufsize, "logs/%s", ref_name);
1279 if (log_all_ref_updates &&
1280 (!prefixcmp(ref_name, "refs/heads/") ||
1281 !prefixcmp(ref_name, "refs/remotes/") ||
1282 !prefixcmp(ref_name, "refs/notes/") ||
1283 !strcmp(ref_name, "HEAD"))) {
1284 if (safe_create_leading_directories(logfile) < 0)
1285 return error("unable to create directory for %s",
1290 logfd = open(logfile, oflags, 0666);
1292 if (!(oflags & O_CREAT) && errno == ENOENT)
1295 if ((oflags & O_CREAT) && errno == EISDIR) {
1296 if (remove_empty_directories(logfile)) {
1297 return error("There are still logs under '%s'",
1300 logfd = open(logfile, oflags, 0666);
1304 return error("Unable to append to %s: %s",
1305 logfile, strerror(errno));
1308 adjust_shared_perm(logfile);
1313 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1314 const unsigned char *new_sha1, const char *msg)
1316 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1317 unsigned maxlen, len;
1319 char log_file[PATH_MAX];
1321 const char *committer;
1323 if (log_all_ref_updates < 0)
1324 log_all_ref_updates = !is_bare_repository();
1326 result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1330 logfd = open(log_file, oflags);
1333 msglen = msg ? strlen(msg) : 0;
1334 committer = git_committer_info(0);
1335 maxlen = strlen(committer) + msglen + 100;
1336 logrec = xmalloc(maxlen);
1337 len = sprintf(logrec, "%s %s %s\n",
1338 sha1_to_hex(old_sha1),
1339 sha1_to_hex(new_sha1),
1342 len += copy_msg(logrec + len - 1, msg) - 1;
1343 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1345 if (close(logfd) != 0 || written != len)
1346 return error("Unable to append to %s", log_file);
1350 static int is_branch(const char *refname)
1352 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1355 int write_ref_sha1(struct ref_lock *lock,
1356 const unsigned char *sha1, const char *logmsg)
1358 static char term = '\n';
1363 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1367 o = parse_object(sha1);
1369 error("Trying to write ref %s with nonexistant object %s",
1370 lock->ref_name, sha1_to_hex(sha1));
1374 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1375 error("Trying to write non-commit object %s to branch %s",
1376 sha1_to_hex(sha1), lock->ref_name);
1380 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1381 write_in_full(lock->lock_fd, &term, 1) != 1
1382 || close_ref(lock) < 0) {
1383 error("Couldn't write %s", lock->lk->filename);
1387 invalidate_cached_refs();
1388 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1389 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1390 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1394 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1396 * Special hack: If a branch is updated directly and HEAD
1397 * points to it (may happen on the remote side of a push
1398 * for example) then logically the HEAD reflog should be
1400 * A generic solution implies reverse symref information,
1401 * but finding all symrefs pointing to the given branch
1402 * would be rather costly for this rare event (the direct
1403 * update of a branch) to be worth it. So let's cheat and
1404 * check with HEAD only which should cover 99% of all usage
1405 * scenarios (even 100% of the default ones).
1407 unsigned char head_sha1[20];
1409 const char *head_ref;
1410 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1411 if (head_ref && (head_flag & REF_ISSYMREF) &&
1412 !strcmp(head_ref, lock->ref_name))
1413 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1415 if (commit_ref(lock)) {
1416 error("Couldn't set %s", lock->ref_name);
1424 int create_symref(const char *ref_target, const char *refs_heads_master,
1427 const char *lockpath;
1429 int fd, len, written;
1430 char *git_HEAD = git_pathdup("%s", ref_target);
1431 unsigned char old_sha1[20], new_sha1[20];
1433 if (logmsg && read_ref(ref_target, old_sha1))
1436 if (safe_create_leading_directories(git_HEAD) < 0)
1437 return error("unable to create directory for %s", git_HEAD);
1439 #ifndef NO_SYMLINK_HEAD
1440 if (prefer_symlink_refs) {
1442 if (!symlink(refs_heads_master, git_HEAD))
1444 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1448 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1449 if (sizeof(ref) <= len) {
1450 error("refname too long: %s", refs_heads_master);
1451 goto error_free_return;
1453 lockpath = mkpath("%s.lock", git_HEAD);
1454 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1456 error("Unable to open %s for writing", lockpath);
1457 goto error_free_return;
1459 written = write_in_full(fd, ref, len);
1460 if (close(fd) != 0 || written != len) {
1461 error("Unable to write to %s", lockpath);
1462 goto error_unlink_return;
1464 if (rename(lockpath, git_HEAD) < 0) {
1465 error("Unable to create %s", git_HEAD);
1466 goto error_unlink_return;
1468 if (adjust_shared_perm(git_HEAD)) {
1469 error("Unable to fix permissions on %s", lockpath);
1470 error_unlink_return:
1471 unlink_or_warn(lockpath);
1477 #ifndef NO_SYMLINK_HEAD
1480 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1481 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1487 static char *ref_msg(const char *line, const char *endp)
1491 ep = memchr(line, '\n', endp - line);
1494 return xmemdupz(line, ep - line);
1497 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)
1499 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1501 int logfd, tz, reccnt = 0;
1504 unsigned char logged_sha1[20];
1508 logfile = git_path("logs/%s", ref);
1509 logfd = open(logfile, O_RDONLY, 0);
1511 die_errno("Unable to read log '%s'", logfile);
1514 die("Log %s is empty.", logfile);
1515 mapsz = xsize_t(st.st_size);
1516 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1517 logdata = log_mapped;
1521 rec = logend = logdata + st.st_size;
1522 while (logdata < rec) {
1524 if (logdata < rec && *(rec-1) == '\n')
1527 while (logdata < rec && *(rec-1) != '\n') {
1533 die("Log %s is corrupt.", logfile);
1534 date = strtoul(lastgt + 1, &tz_c, 10);
1535 if (date <= at_time || cnt == 0) {
1536 tz = strtoul(tz_c, NULL, 10);
1538 *msg = ref_msg(rec, logend);
1540 *cutoff_time = date;
1544 *cutoff_cnt = reccnt - 1;
1546 if (get_sha1_hex(lastrec, logged_sha1))
1547 die("Log %s is corrupt.", logfile);
1548 if (get_sha1_hex(rec + 41, sha1))
1549 die("Log %s is corrupt.", logfile);
1550 if (hashcmp(logged_sha1, sha1)) {
1551 warning("Log %s has gap after %s.",
1552 logfile, show_date(date, tz, DATE_RFC2822));
1555 else if (date == at_time) {
1556 if (get_sha1_hex(rec + 41, sha1))
1557 die("Log %s is corrupt.", logfile);
1560 if (get_sha1_hex(rec + 41, logged_sha1))
1561 die("Log %s is corrupt.", logfile);
1562 if (hashcmp(logged_sha1, sha1)) {
1563 warning("Log %s unexpectedly ended on %s.",
1564 logfile, show_date(date, tz, DATE_RFC2822));
1567 munmap(log_mapped, mapsz);
1576 while (rec < logend && *rec != '>' && *rec != '\n')
1578 if (rec == logend || *rec == '\n')
1579 die("Log %s is corrupt.", logfile);
1580 date = strtoul(rec + 1, &tz_c, 10);
1581 tz = strtoul(tz_c, NULL, 10);
1582 if (get_sha1_hex(logdata, sha1))
1583 die("Log %s is corrupt.", logfile);
1584 if (is_null_sha1(sha1)) {
1585 if (get_sha1_hex(logdata + 41, sha1))
1586 die("Log %s is corrupt.", logfile);
1589 *msg = ref_msg(logdata, logend);
1590 munmap(log_mapped, mapsz);
1593 *cutoff_time = date;
1597 *cutoff_cnt = reccnt;
1601 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1603 const char *logfile;
1605 struct strbuf sb = STRBUF_INIT;
1608 logfile = git_path("logs/%s", ref);
1609 logfp = fopen(logfile, "r");
1614 struct stat statbuf;
1615 if (fstat(fileno(logfp), &statbuf) ||
1616 statbuf.st_size < ofs ||
1617 fseek(logfp, -ofs, SEEK_END) ||
1618 strbuf_getwholeline(&sb, logfp, '\n')) {
1620 strbuf_release(&sb);
1625 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1626 unsigned char osha1[20], nsha1[20];
1627 char *email_end, *message;
1628 unsigned long timestamp;
1631 /* old SP new SP name <email> SP time TAB msg LF */
1632 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1633 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1634 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1635 !(email_end = strchr(sb.buf + 82, '>')) ||
1636 email_end[1] != ' ' ||
1637 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1638 !message || message[0] != ' ' ||
1639 (message[1] != '+' && message[1] != '-') ||
1640 !isdigit(message[2]) || !isdigit(message[3]) ||
1641 !isdigit(message[4]) || !isdigit(message[5]))
1642 continue; /* corrupt? */
1643 email_end[1] = '\0';
1644 tz = strtol(message + 1, NULL, 10);
1645 if (message[6] != '\t')
1649 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1655 strbuf_release(&sb);
1659 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1661 return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1664 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1666 DIR *dir = opendir(git_path("logs/%s", base));
1671 int baselen = strlen(base);
1672 char *log = xmalloc(baselen + 257);
1674 memcpy(log, base, baselen);
1675 if (baselen && base[baselen-1] != '/')
1676 log[baselen++] = '/';
1678 while ((de = readdir(dir)) != NULL) {
1682 if (de->d_name[0] == '.')
1684 namelen = strlen(de->d_name);
1687 if (has_extension(de->d_name, ".lock"))
1689 memcpy(log + baselen, de->d_name, namelen+1);
1690 if (stat(git_path("logs/%s", log), &st) < 0)
1692 if (S_ISDIR(st.st_mode)) {
1693 retval = do_for_each_reflog(log, fn, cb_data);
1695 unsigned char sha1[20];
1696 if (!resolve_ref(log, sha1, 0, NULL))
1697 retval = error("bad ref for %s", log);
1699 retval = fn(log, sha1, 0, cb_data);
1712 int for_each_reflog(each_ref_fn fn, void *cb_data)
1714 return do_for_each_reflog("", fn, cb_data);
1717 int update_ref(const char *action, const char *refname,
1718 const unsigned char *sha1, const unsigned char *oldval,
1719 int flags, enum action_on_err onerr)
1721 static struct ref_lock *lock;
1722 lock = lock_any_ref_for_update(refname, oldval, flags);
1724 const char *str = "Cannot lock the ref '%s'.";
1726 case MSG_ON_ERR: error(str, refname); break;
1727 case DIE_ON_ERR: die(str, refname); break;
1728 case QUIET_ON_ERR: break;
1732 if (write_ref_sha1(lock, sha1, action) < 0) {
1733 const char *str = "Cannot update the ref '%s'.";
1735 case MSG_ON_ERR: error(str, refname); break;
1736 case DIE_ON_ERR: die(str, refname); break;
1737 case QUIET_ON_ERR: break;
1744 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1746 for ( ; list; list = list->next)
1747 if (!strcmp(list->name, name))
1748 return (struct ref *)list;
1753 * generate a format suitable for scanf from a ref_rev_parse_rules
1754 * rule, that is replace the "%.*s" spec with a "%s" spec
1756 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1760 spec = strstr(rule, "%.*s");
1761 if (!spec || strstr(spec + 4, "%.*s"))
1762 die("invalid rule in ref_rev_parse_rules: %s", rule);
1764 /* copy all until spec */
1765 strncpy(scanf_fmt, rule, spec - rule);
1766 scanf_fmt[spec - rule] = '\0';
1768 strcat(scanf_fmt, "%s");
1769 /* copy remaining rule */
1770 strcat(scanf_fmt, spec + 4);
1775 char *shorten_unambiguous_ref(const char *ref, int strict)
1778 static char **scanf_fmts;
1779 static int nr_rules;
1782 /* pre generate scanf formats from ref_rev_parse_rules[] */
1784 size_t total_len = 0;
1786 /* the rule list is NULL terminated, count them first */
1787 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1788 /* no +1 because strlen("%s") < strlen("%.*s") */
1789 total_len += strlen(ref_rev_parse_rules[nr_rules]);
1791 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1794 for (i = 0; i < nr_rules; i++) {
1795 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1797 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1798 total_len += strlen(ref_rev_parse_rules[i]);
1802 /* bail out if there are no rules */
1804 return xstrdup(ref);
1806 /* buffer for scanf result, at most ref must fit */
1807 short_name = xstrdup(ref);
1809 /* skip first rule, it will always match */
1810 for (i = nr_rules - 1; i > 0 ; --i) {
1812 int rules_to_fail = i;
1815 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1818 short_name_len = strlen(short_name);
1821 * in strict mode, all (except the matched one) rules
1822 * must fail to resolve to a valid non-ambiguous ref
1825 rules_to_fail = nr_rules;
1828 * check if the short name resolves to a valid ref,
1829 * but use only rules prior to the matched one
1831 for (j = 0; j < rules_to_fail; j++) {
1832 const char *rule = ref_rev_parse_rules[j];
1833 unsigned char short_objectname[20];
1834 char refname[PATH_MAX];
1836 /* skip matched rule */
1841 * the short name is ambiguous, if it resolves
1842 * (with this previous rule) to a valid ref
1843 * read_ref() returns 0 on success
1845 mksnpath(refname, sizeof(refname),
1846 rule, short_name_len, short_name);
1847 if (!read_ref(refname, short_objectname))
1852 * short name is non-ambiguous if all previous rules
1853 * haven't resolved to a valid ref
1855 if (j == rules_to_fail)
1860 return xstrdup(ref);