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;
160 } cached_refs, submodule_refs;
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(const char *submodule)
234 const char *packed_refs_file;
235 struct cached_refs *refs;
238 packed_refs_file = git_path_submodule(submodule, "packed-refs");
239 refs = &submodule_refs;
240 free_ref_list(refs->packed);
242 packed_refs_file = git_path("packed-refs");
246 if (!refs->did_packed || submodule) {
247 FILE *f = fopen(packed_refs_file, "r");
250 read_packed_refs(f, refs);
253 refs->did_packed = 1;
258 static struct ref_list *get_ref_dir(const char *submodule, const char *base,
259 struct ref_list *list)
265 path = git_path_submodule(submodule, "%s", base);
267 path = git_path("%s", base);
274 int baselen = strlen(base);
275 char *ref = xmalloc(baselen + 257);
277 memcpy(ref, base, baselen);
278 if (baselen && base[baselen-1] != '/')
279 ref[baselen++] = '/';
281 while ((de = readdir(dir)) != NULL) {
282 unsigned char sha1[20];
288 if (de->d_name[0] == '.')
290 namelen = strlen(de->d_name);
293 if (has_extension(de->d_name, ".lock"))
295 memcpy(ref + baselen, de->d_name, namelen+1);
297 ? git_path_submodule(submodule, "%s", ref)
298 : git_path("%s", ref);
299 if (stat(refdir, &st) < 0)
301 if (S_ISDIR(st.st_mode)) {
302 list = get_ref_dir(submodule, ref, list);
308 if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
313 if (!resolve_ref(ref, sha1, 1, &flag)) {
317 list = add_ref(ref, sha1, flag, list, NULL);
322 return sort_ref_list(list);
325 struct warn_if_dangling_data {
331 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
332 int flags, void *cb_data)
334 struct warn_if_dangling_data *d = cb_data;
335 const char *resolves_to;
336 unsigned char junk[20];
338 if (!(flags & REF_ISSYMREF))
341 resolves_to = resolve_ref(refname, junk, 0, NULL);
342 if (!resolves_to || strcmp(resolves_to, d->refname))
345 fprintf(d->fp, d->msg_fmt, refname);
349 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
351 struct warn_if_dangling_data data;
354 data.refname = refname;
355 data.msg_fmt = msg_fmt;
356 for_each_rawref(warn_if_dangling_symref, &data);
359 static struct ref_list *get_loose_refs(const char *submodule)
362 free_ref_list(submodule_refs.loose);
363 submodule_refs.loose = get_ref_dir(submodule, "refs", NULL);
364 return submodule_refs.loose;
367 if (!cached_refs.did_loose) {
368 cached_refs.loose = get_ref_dir(NULL, "refs", NULL);
369 cached_refs.did_loose = 1;
371 return cached_refs.loose;
374 /* We allow "recursive" symbolic refs. Only within reason, though */
376 #define MAXREFLEN (1024)
378 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
381 struct cached_refs refs;
382 struct ref_list *ref;
385 strcpy(name + pathlen, "packed-refs");
386 f = fopen(name, "r");
389 read_packed_refs(f, &refs);
394 if (!strcmp(ref->name, refname)) {
396 memcpy(result, ref->sha1, 20);
401 free_ref_list(refs.packed);
405 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
407 int fd, len = strlen(refname);
408 char buffer[128], *p;
410 if (recursion > MAXDEPTH || len > MAXREFLEN)
412 memcpy(name + pathlen, refname, len+1);
413 fd = open(name, O_RDONLY);
415 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
417 len = read(fd, buffer, sizeof(buffer)-1);
421 while (len && isspace(buffer[len-1]))
425 /* Was it a detached head or an old-fashioned symlink? */
426 if (!get_sha1_hex(buffer, result))
430 if (strncmp(buffer, "ref:", 4))
436 return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
439 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
441 int len = strlen(path), retval;
445 while (len && path[len-1] == '/')
449 gitdir = xmalloc(len + MAXREFLEN + 8);
450 memcpy(gitdir, path, len);
451 memcpy(gitdir + len, "/.git", 6);
454 tmp = read_gitfile(gitdir);
458 gitdir = xmalloc(len + MAXREFLEN + 3);
459 memcpy(gitdir, tmp, len);
462 gitdir[++len] = '\0';
463 retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
469 * If the "reading" argument is set, this function finds out what _object_
470 * the ref points at by "reading" the ref. The ref, if it is not symbolic,
471 * has to exist, and if it is symbolic, it has to point at an existing ref,
472 * because the "read" goes through the symref to the ref it points at.
474 * The access that is not "reading" may often be "writing", but does not
475 * have to; it can be merely checking _where it leads to_. If it is a
476 * prelude to "writing" to the ref, a write to a symref that points at
477 * yet-to-be-born ref will create the real ref pointed by the symref.
478 * reading=0 allows the caller to check where such a symref leads to.
480 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
482 int depth = MAXDEPTH;
485 static char ref_buffer[256];
499 git_snpath(path, sizeof(path), "%s", ref);
500 /* Special case: non-existing file. */
501 if (lstat(path, &st) < 0) {
502 struct ref_list *list = get_packed_refs(NULL);
504 if (!strcmp(ref, list->name)) {
505 hashcpy(sha1, list->sha1);
507 *flag |= REF_ISPACKED;
512 if (reading || errno != ENOENT)
518 /* Follow "normalized" - ie "refs/.." symlinks by hand */
519 if (S_ISLNK(st.st_mode)) {
520 len = readlink(path, buffer, sizeof(buffer)-1);
521 if (len >= 5 && !memcmp("refs/", buffer, 5)) {
523 strcpy(ref_buffer, buffer);
526 *flag |= REF_ISSYMREF;
531 /* Is it a directory? */
532 if (S_ISDIR(st.st_mode)) {
538 * Anything else, just open it and try to use it as
541 fd = open(path, O_RDONLY);
544 len = read_in_full(fd, buffer, sizeof(buffer)-1);
548 * Is it a symbolic ref?
550 if (len < 4 || memcmp("ref:", buffer, 4))
554 while (len && isspace(*buf))
556 while (len && isspace(buf[len-1]))
559 memcpy(ref_buffer, buf, len + 1);
562 *flag |= REF_ISSYMREF;
564 if (len < 40 || get_sha1_hex(buffer, sha1))
569 /* The argument to filter_refs */
576 int read_ref(const char *ref, unsigned char *sha1)
578 if (resolve_ref(ref, sha1, 1, NULL))
583 #define DO_FOR_EACH_INCLUDE_BROKEN 01
584 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
585 int flags, void *cb_data, struct ref_list *entry)
587 if (prefixcmp(entry->name, base))
590 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
591 if (entry->flag & REF_BROKEN)
592 return 0; /* ignore dangling symref */
593 if (!has_sha1_file(entry->sha1)) {
594 error("%s does not point to a valid object!", entry->name);
599 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
602 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
605 struct ref_filter *filter = (struct ref_filter *)data;
606 if (fnmatch(filter->pattern, ref, 0))
608 return filter->fn(ref, sha, flags, filter->cb_data);
611 int peel_ref(const char *ref, unsigned char *sha1)
614 unsigned char base[20];
617 if (current_ref && (current_ref->name == ref
618 || !strcmp(current_ref->name, ref))) {
619 if (current_ref->flag & REF_KNOWS_PEELED) {
620 hashcpy(sha1, current_ref->peeled);
623 hashcpy(base, current_ref->sha1);
627 if (!resolve_ref(ref, base, 1, &flag))
630 if ((flag & REF_ISPACKED)) {
631 struct ref_list *list = get_packed_refs(NULL);
634 if (!strcmp(list->name, ref)) {
635 if (list->flag & REF_KNOWS_PEELED) {
636 hashcpy(sha1, list->peeled);
639 /* older pack-refs did not leave peeled ones */
647 o = parse_object(base);
648 if (o && o->type == OBJ_TAG) {
649 o = deref_tag(o, ref, 0);
651 hashcpy(sha1, o->sha1);
658 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
659 int trim, int flags, void *cb_data)
662 struct ref_list *packed = get_packed_refs(submodule);
663 struct ref_list *loose = get_loose_refs(submodule);
665 struct ref_list *extra;
667 for (extra = extra_refs; extra; extra = extra->next)
668 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
670 while (packed && loose) {
671 struct ref_list *entry;
672 int cmp = strcmp(packed->name, loose->name);
674 packed = packed->next;
682 packed = packed->next;
684 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
689 for (packed = packed ? packed : loose; packed; packed = packed->next) {
690 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
701 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
703 unsigned char sha1[20];
707 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
708 return fn("HEAD", sha1, 0, cb_data);
713 if (resolve_ref("HEAD", sha1, 1, &flag))
714 return fn("HEAD", sha1, flag, cb_data);
719 int head_ref(each_ref_fn fn, void *cb_data)
721 return do_head_ref(NULL, fn, cb_data);
724 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
726 return do_head_ref(submodule, fn, cb_data);
729 int for_each_ref(each_ref_fn fn, void *cb_data)
731 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
734 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
736 return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
739 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
741 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
744 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
745 each_ref_fn fn, void *cb_data)
747 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
750 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
752 return for_each_ref_in("refs/tags/", fn, cb_data);
755 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
757 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
760 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
762 return for_each_ref_in("refs/heads/", fn, cb_data);
765 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
767 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
770 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
772 return for_each_ref_in("refs/remotes/", fn, cb_data);
775 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
777 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
780 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
782 return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
785 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
787 struct strbuf buf = STRBUF_INIT;
789 unsigned char sha1[20];
792 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
793 if (resolve_ref(buf.buf, sha1, 1, &flag))
794 ret = fn(buf.buf, sha1, flag, cb_data);
795 strbuf_release(&buf);
800 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
802 struct strbuf buf = STRBUF_INIT;
804 strbuf_addf(&buf, "%srefs/", get_git_namespace());
805 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
806 strbuf_release(&buf);
810 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
811 const char *prefix, void *cb_data)
813 struct strbuf real_pattern = STRBUF_INIT;
814 struct ref_filter filter;
817 if (!prefix && prefixcmp(pattern, "refs/"))
818 strbuf_addstr(&real_pattern, "refs/");
820 strbuf_addstr(&real_pattern, prefix);
821 strbuf_addstr(&real_pattern, pattern);
823 if (!has_glob_specials(pattern)) {
824 /* Append implied '/' '*' if not present. */
825 if (real_pattern.buf[real_pattern.len - 1] != '/')
826 strbuf_addch(&real_pattern, '/');
827 /* No need to check for '*', there is none. */
828 strbuf_addch(&real_pattern, '*');
831 filter.pattern = real_pattern.buf;
833 filter.cb_data = cb_data;
834 ret = for_each_ref(filter_refs, &filter);
836 strbuf_release(&real_pattern);
840 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
842 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
845 int for_each_rawref(each_ref_fn fn, void *cb_data)
847 return do_for_each_ref(NULL, "", fn, 0,
848 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
852 * Make sure "ref" is something reasonable to have under ".git/refs/";
853 * We do not like it if:
855 * - any path component of it begins with ".", or
856 * - it has double dots "..", or
857 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
858 * - it ends with a "/".
859 * - it ends with ".lock"
860 * - it contains a "\" (backslash)
863 static inline int bad_ref_char(int ch)
865 if (((unsigned) ch) <= ' ' || ch == 0x7f ||
866 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
868 /* 2.13 Pattern Matching Notation */
869 if (ch == '?' || ch == '[') /* Unsupported */
871 if (ch == '*') /* Supported at the end */
876 int check_ref_format(const char *ref)
878 int ch, level, bad_type, last;
879 int ret = CHECK_REF_FORMAT_OK;
880 const char *cp = ref;
884 while ((ch = *cp++) == '/')
885 ; /* tolerate duplicated slashes */
887 /* should not end with slashes */
888 return CHECK_REF_FORMAT_ERROR;
890 /* we are at the beginning of the path component */
892 return CHECK_REF_FORMAT_ERROR;
893 bad_type = bad_ref_char(ch);
895 if (bad_type == 2 && (!*cp || *cp == '/') &&
896 ret == CHECK_REF_FORMAT_OK)
897 ret = CHECK_REF_FORMAT_WILDCARD;
899 return CHECK_REF_FORMAT_ERROR;
903 /* scan the rest of the path component */
904 while ((ch = *cp++) != 0) {
905 bad_type = bad_ref_char(ch);
907 return CHECK_REF_FORMAT_ERROR;
910 if (last == '.' && ch == '.')
911 return CHECK_REF_FORMAT_ERROR;
912 if (last == '@' && ch == '{')
913 return CHECK_REF_FORMAT_ERROR;
918 if (ref <= cp - 2 && cp[-2] == '.')
919 return CHECK_REF_FORMAT_ERROR;
921 return CHECK_REF_FORMAT_ONELEVEL;
922 if (has_extension(ref, ".lock"))
923 return CHECK_REF_FORMAT_ERROR;
929 const char *prettify_refname(const char *name)
932 !prefixcmp(name, "refs/heads/") ? 11 :
933 !prefixcmp(name, "refs/tags/") ? 10 :
934 !prefixcmp(name, "refs/remotes/") ? 13 :
938 const char *ref_rev_parse_rules[] = {
944 "refs/remotes/%.*s/HEAD",
948 const char *ref_fetch_rules[] = {
955 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
958 const int abbrev_name_len = strlen(abbrev_name);
960 for (p = rules; *p; p++) {
961 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
969 static struct ref_lock *verify_lock(struct ref_lock *lock,
970 const unsigned char *old_sha1, int mustexist)
972 if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
973 error("Can't verify ref %s", lock->ref_name);
977 if (hashcmp(lock->old_sha1, old_sha1)) {
978 error("Ref %s is at %s but expected %s", lock->ref_name,
979 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
986 static int remove_empty_directories(const char *file)
988 /* we want to create a file but there is a directory there;
989 * if that is an empty directory (or a directory that contains
990 * only empty directories), remove them.
995 strbuf_init(&path, 20);
996 strbuf_addstr(&path, file);
998 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1000 strbuf_release(&path);
1005 static int is_refname_available(const char *ref, const char *oldref,
1006 struct ref_list *list, int quiet)
1008 int namlen = strlen(ref); /* e.g. 'foo/bar' */
1010 /* list->name could be 'foo' or 'foo/bar/baz' */
1011 if (!oldref || strcmp(oldref, list->name)) {
1012 int len = strlen(list->name);
1013 int cmplen = (namlen < len) ? namlen : len;
1014 const char *lead = (namlen < len) ? list->name : ref;
1015 if (!strncmp(ref, list->name, cmplen) &&
1016 lead[cmplen] == '/') {
1018 error("'%s' exists; cannot create '%s'",
1028 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1031 const char *orig_ref = ref;
1032 struct ref_lock *lock;
1035 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1038 lock = xcalloc(1, sizeof(struct ref_lock));
1041 ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
1042 if (!ref && errno == EISDIR) {
1043 /* we are trying to lock foo but we used to
1044 * have foo/bar which now does not exist;
1045 * it is normal for the empty directory 'foo'
1048 ref_file = git_path("%s", orig_ref);
1049 if (remove_empty_directories(ref_file)) {
1051 error("there are still refs under '%s'", orig_ref);
1054 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
1060 error("unable to resolve reference %s: %s",
1061 orig_ref, strerror(errno));
1064 missing = is_null_sha1(lock->old_sha1);
1065 /* When the ref did not exist and we are creating it,
1066 * make sure there is no existing ref that is packed
1067 * whose name begins with our refname, nor a ref whose
1068 * name is a proper prefix of our refname.
1071 !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1072 last_errno = ENOTDIR;
1076 lock->lk = xcalloc(1, sizeof(struct lock_file));
1078 lflags = LOCK_DIE_ON_ERROR;
1079 if (flags & REF_NODEREF) {
1081 lflags |= LOCK_NODEREF;
1083 lock->ref_name = xstrdup(ref);
1084 lock->orig_ref_name = xstrdup(orig_ref);
1085 ref_file = git_path("%s", ref);
1087 lock->force_write = 1;
1088 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1089 lock->force_write = 1;
1091 if (safe_create_leading_directories(ref_file)) {
1093 error("unable to create directory for %s", ref_file);
1097 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1098 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1106 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1108 char refpath[PATH_MAX];
1109 if (check_ref_format(ref))
1111 strcpy(refpath, mkpath("refs/%s", ref));
1112 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1115 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1117 switch (check_ref_format(ref)) {
1121 case CHECK_REF_FORMAT_ONELEVEL:
1122 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1126 static struct lock_file packlock;
1128 static int repack_without_ref(const char *refname)
1130 struct ref_list *list, *packed_ref_list;
1134 packed_ref_list = get_packed_refs(NULL);
1135 for (list = packed_ref_list; list; list = list->next) {
1136 if (!strcmp(refname, list->name)) {
1143 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1145 unable_to_lock_error(git_path("packed-refs"), errno);
1146 return error("cannot delete '%s' from packed refs", refname);
1149 for (list = packed_ref_list; list; list = list->next) {
1150 char line[PATH_MAX + 100];
1153 if (!strcmp(refname, list->name))
1155 len = snprintf(line, sizeof(line), "%s %s\n",
1156 sha1_to_hex(list->sha1), list->name);
1157 /* this should not happen but just being defensive */
1158 if (len > sizeof(line))
1159 die("too long a refname '%s'", list->name);
1160 write_or_die(fd, line, len);
1162 return commit_lock_file(&packlock);
1165 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1167 struct ref_lock *lock;
1168 int err, i = 0, ret = 0, flag = 0;
1170 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1173 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1177 if (!(delopt & REF_NODEREF)) {
1178 i = strlen(lock->lk->filename) - 5; /* .lock */
1179 lock->lk->filename[i] = 0;
1180 path = lock->lk->filename;
1182 path = git_path("%s", refname);
1184 err = unlink_or_warn(path);
1185 if (err && errno != ENOENT)
1188 if (!(delopt & REF_NODEREF))
1189 lock->lk->filename[i] = '.';
1191 /* removing the loose one could have resurrected an earlier
1192 * packed one. Also, if it was not loose we need to repack
1195 ret |= repack_without_ref(refname);
1197 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1198 invalidate_cached_refs();
1204 * People using contrib's git-new-workdir have .git/logs/refs ->
1205 * /some/other/path/.git/logs/refs, and that may live on another device.
1207 * IOW, to avoid cross device rename errors, the temporary renamed log must
1208 * live into logs/refs.
1210 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1212 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1214 static const char renamed_ref[] = "RENAMED-REF";
1215 unsigned char sha1[20], orig_sha1[20];
1216 int flag = 0, logmoved = 0;
1217 struct ref_lock *lock;
1218 struct stat loginfo;
1219 int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1220 const char *symref = NULL;
1222 if (log && S_ISLNK(loginfo.st_mode))
1223 return error("reflog for %s is a symlink", oldref);
1225 symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1226 if (flag & REF_ISSYMREF)
1227 return error("refname %s is a symbolic ref, renaming it is not supported",
1230 return error("refname %s not found", oldref);
1232 if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1235 if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1238 lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1240 return error("unable to lock %s", renamed_ref);
1241 lock->force_write = 1;
1242 if (write_ref_sha1(lock, orig_sha1, logmsg))
1243 return error("unable to save current sha1 in %s", renamed_ref);
1245 if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1246 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1247 oldref, strerror(errno));
1249 if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1250 error("unable to delete old %s", oldref);
1254 if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1255 if (errno==EISDIR) {
1256 if (remove_empty_directories(git_path("%s", newref))) {
1257 error("Directory not empty: %s", newref);
1261 error("unable to delete existing %s", newref);
1266 if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1267 error("unable to create directory for %s", newref);
1272 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1273 if (errno==EISDIR || errno==ENOTDIR) {
1275 * rename(a, b) when b is an existing
1276 * directory ought to result in ISDIR, but
1277 * Solaris 5.8 gives ENOTDIR. Sheesh.
1279 if (remove_empty_directories(git_path("logs/%s", newref))) {
1280 error("Directory not empty: logs/%s", newref);
1285 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1286 newref, strerror(errno));
1292 lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1294 error("unable to lock %s for update", newref);
1297 lock->force_write = 1;
1298 hashcpy(lock->old_sha1, orig_sha1);
1299 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1300 error("unable to write current sha1 into %s", newref);
1307 lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1309 error("unable to lock %s for rollback", oldref);
1313 lock->force_write = 1;
1314 flag = log_all_ref_updates;
1315 log_all_ref_updates = 0;
1316 if (write_ref_sha1(lock, orig_sha1, NULL))
1317 error("unable to write current sha1 into %s", oldref);
1318 log_all_ref_updates = flag;
1321 if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1322 error("unable to restore logfile %s from %s: %s",
1323 oldref, newref, strerror(errno));
1324 if (!logmoved && log &&
1325 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1326 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1327 oldref, strerror(errno));
1332 int close_ref(struct ref_lock *lock)
1334 if (close_lock_file(lock->lk))
1340 int commit_ref(struct ref_lock *lock)
1342 if (commit_lock_file(lock->lk))
1348 void unlock_ref(struct ref_lock *lock)
1350 /* Do not free lock->lk -- atexit() still looks at them */
1352 rollback_lock_file(lock->lk);
1353 free(lock->ref_name);
1354 free(lock->orig_ref_name);
1359 * copy the reflog message msg to buf, which has been allocated sufficiently
1360 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1361 * because reflog file is one line per entry.
1363 static int copy_msg(char *buf, const char *msg)
1370 while ((c = *msg++)) {
1371 if (wasspace && isspace(c))
1373 wasspace = isspace(c);
1378 while (buf < cp && isspace(cp[-1]))
1384 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1386 int logfd, oflags = O_APPEND | O_WRONLY;
1388 git_snpath(logfile, bufsize, "logs/%s", ref_name);
1389 if (log_all_ref_updates &&
1390 (!prefixcmp(ref_name, "refs/heads/") ||
1391 !prefixcmp(ref_name, "refs/remotes/") ||
1392 !prefixcmp(ref_name, "refs/notes/") ||
1393 !strcmp(ref_name, "HEAD"))) {
1394 if (safe_create_leading_directories(logfile) < 0)
1395 return error("unable to create directory for %s",
1400 logfd = open(logfile, oflags, 0666);
1402 if (!(oflags & O_CREAT) && errno == ENOENT)
1405 if ((oflags & O_CREAT) && errno == EISDIR) {
1406 if (remove_empty_directories(logfile)) {
1407 return error("There are still logs under '%s'",
1410 logfd = open(logfile, oflags, 0666);
1414 return error("Unable to append to %s: %s",
1415 logfile, strerror(errno));
1418 adjust_shared_perm(logfile);
1423 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1424 const unsigned char *new_sha1, const char *msg)
1426 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1427 unsigned maxlen, len;
1429 char log_file[PATH_MAX];
1431 const char *committer;
1433 if (log_all_ref_updates < 0)
1434 log_all_ref_updates = !is_bare_repository();
1436 result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1440 logfd = open(log_file, oflags);
1443 msglen = msg ? strlen(msg) : 0;
1444 committer = git_committer_info(0);
1445 maxlen = strlen(committer) + msglen + 100;
1446 logrec = xmalloc(maxlen);
1447 len = sprintf(logrec, "%s %s %s\n",
1448 sha1_to_hex(old_sha1),
1449 sha1_to_hex(new_sha1),
1452 len += copy_msg(logrec + len - 1, msg) - 1;
1453 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1455 if (close(logfd) != 0 || written != len)
1456 return error("Unable to append to %s", log_file);
1460 static int is_branch(const char *refname)
1462 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1465 int write_ref_sha1(struct ref_lock *lock,
1466 const unsigned char *sha1, const char *logmsg)
1468 static char term = '\n';
1473 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1477 o = parse_object(sha1);
1479 error("Trying to write ref %s with nonexistent object %s",
1480 lock->ref_name, sha1_to_hex(sha1));
1484 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1485 error("Trying to write non-commit object %s to branch %s",
1486 sha1_to_hex(sha1), lock->ref_name);
1490 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1491 write_in_full(lock->lock_fd, &term, 1) != 1
1492 || close_ref(lock) < 0) {
1493 error("Couldn't write %s", lock->lk->filename);
1497 invalidate_cached_refs();
1498 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1499 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1500 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1504 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1506 * Special hack: If a branch is updated directly and HEAD
1507 * points to it (may happen on the remote side of a push
1508 * for example) then logically the HEAD reflog should be
1510 * A generic solution implies reverse symref information,
1511 * but finding all symrefs pointing to the given branch
1512 * would be rather costly for this rare event (the direct
1513 * update of a branch) to be worth it. So let's cheat and
1514 * check with HEAD only which should cover 99% of all usage
1515 * scenarios (even 100% of the default ones).
1517 unsigned char head_sha1[20];
1519 const char *head_ref;
1520 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1521 if (head_ref && (head_flag & REF_ISSYMREF) &&
1522 !strcmp(head_ref, lock->ref_name))
1523 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1525 if (commit_ref(lock)) {
1526 error("Couldn't set %s", lock->ref_name);
1534 int create_symref(const char *ref_target, const char *refs_heads_master,
1537 const char *lockpath;
1539 int fd, len, written;
1540 char *git_HEAD = git_pathdup("%s", ref_target);
1541 unsigned char old_sha1[20], new_sha1[20];
1543 if (logmsg && read_ref(ref_target, old_sha1))
1546 if (safe_create_leading_directories(git_HEAD) < 0)
1547 return error("unable to create directory for %s", git_HEAD);
1549 #ifndef NO_SYMLINK_HEAD
1550 if (prefer_symlink_refs) {
1552 if (!symlink(refs_heads_master, git_HEAD))
1554 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1558 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1559 if (sizeof(ref) <= len) {
1560 error("refname too long: %s", refs_heads_master);
1561 goto error_free_return;
1563 lockpath = mkpath("%s.lock", git_HEAD);
1564 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1566 error("Unable to open %s for writing", lockpath);
1567 goto error_free_return;
1569 written = write_in_full(fd, ref, len);
1570 if (close(fd) != 0 || written != len) {
1571 error("Unable to write to %s", lockpath);
1572 goto error_unlink_return;
1574 if (rename(lockpath, git_HEAD) < 0) {
1575 error("Unable to create %s", git_HEAD);
1576 goto error_unlink_return;
1578 if (adjust_shared_perm(git_HEAD)) {
1579 error("Unable to fix permissions on %s", lockpath);
1580 error_unlink_return:
1581 unlink_or_warn(lockpath);
1587 #ifndef NO_SYMLINK_HEAD
1590 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1591 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1597 static char *ref_msg(const char *line, const char *endp)
1601 ep = memchr(line, '\n', endp - line);
1604 return xmemdupz(line, ep - line);
1607 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)
1609 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1611 int logfd, tz, reccnt = 0;
1614 unsigned char logged_sha1[20];
1618 logfile = git_path("logs/%s", ref);
1619 logfd = open(logfile, O_RDONLY, 0);
1621 die_errno("Unable to read log '%s'", logfile);
1624 die("Log %s is empty.", logfile);
1625 mapsz = xsize_t(st.st_size);
1626 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1627 logdata = log_mapped;
1631 rec = logend = logdata + st.st_size;
1632 while (logdata < rec) {
1634 if (logdata < rec && *(rec-1) == '\n')
1637 while (logdata < rec && *(rec-1) != '\n') {
1643 die("Log %s is corrupt.", logfile);
1644 date = strtoul(lastgt + 1, &tz_c, 10);
1645 if (date <= at_time || cnt == 0) {
1646 tz = strtoul(tz_c, NULL, 10);
1648 *msg = ref_msg(rec, logend);
1650 *cutoff_time = date;
1654 *cutoff_cnt = reccnt - 1;
1656 if (get_sha1_hex(lastrec, logged_sha1))
1657 die("Log %s is corrupt.", logfile);
1658 if (get_sha1_hex(rec + 41, sha1))
1659 die("Log %s is corrupt.", logfile);
1660 if (hashcmp(logged_sha1, sha1)) {
1661 warning("Log %s has gap after %s.",
1662 logfile, show_date(date, tz, DATE_RFC2822));
1665 else if (date == at_time) {
1666 if (get_sha1_hex(rec + 41, sha1))
1667 die("Log %s is corrupt.", logfile);
1670 if (get_sha1_hex(rec + 41, logged_sha1))
1671 die("Log %s is corrupt.", logfile);
1672 if (hashcmp(logged_sha1, sha1)) {
1673 warning("Log %s unexpectedly ended on %s.",
1674 logfile, show_date(date, tz, DATE_RFC2822));
1677 munmap(log_mapped, mapsz);
1686 while (rec < logend && *rec != '>' && *rec != '\n')
1688 if (rec == logend || *rec == '\n')
1689 die("Log %s is corrupt.", logfile);
1690 date = strtoul(rec + 1, &tz_c, 10);
1691 tz = strtoul(tz_c, NULL, 10);
1692 if (get_sha1_hex(logdata, sha1))
1693 die("Log %s is corrupt.", logfile);
1694 if (is_null_sha1(sha1)) {
1695 if (get_sha1_hex(logdata + 41, sha1))
1696 die("Log %s is corrupt.", logfile);
1699 *msg = ref_msg(logdata, logend);
1700 munmap(log_mapped, mapsz);
1703 *cutoff_time = date;
1707 *cutoff_cnt = reccnt;
1711 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1713 const char *logfile;
1715 struct strbuf sb = STRBUF_INIT;
1718 logfile = git_path("logs/%s", ref);
1719 logfp = fopen(logfile, "r");
1724 struct stat statbuf;
1725 if (fstat(fileno(logfp), &statbuf) ||
1726 statbuf.st_size < ofs ||
1727 fseek(logfp, -ofs, SEEK_END) ||
1728 strbuf_getwholeline(&sb, logfp, '\n')) {
1730 strbuf_release(&sb);
1735 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1736 unsigned char osha1[20], nsha1[20];
1737 char *email_end, *message;
1738 unsigned long timestamp;
1741 /* old SP new SP name <email> SP time TAB msg LF */
1742 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1743 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1744 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1745 !(email_end = strchr(sb.buf + 82, '>')) ||
1746 email_end[1] != ' ' ||
1747 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1748 !message || message[0] != ' ' ||
1749 (message[1] != '+' && message[1] != '-') ||
1750 !isdigit(message[2]) || !isdigit(message[3]) ||
1751 !isdigit(message[4]) || !isdigit(message[5]))
1752 continue; /* corrupt? */
1753 email_end[1] = '\0';
1754 tz = strtol(message + 1, NULL, 10);
1755 if (message[6] != '\t')
1759 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1765 strbuf_release(&sb);
1769 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1771 return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1774 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1776 DIR *dir = opendir(git_path("logs/%s", base));
1781 int baselen = strlen(base);
1782 char *log = xmalloc(baselen + 257);
1784 memcpy(log, base, baselen);
1785 if (baselen && base[baselen-1] != '/')
1786 log[baselen++] = '/';
1788 while ((de = readdir(dir)) != NULL) {
1792 if (de->d_name[0] == '.')
1794 namelen = strlen(de->d_name);
1797 if (has_extension(de->d_name, ".lock"))
1799 memcpy(log + baselen, de->d_name, namelen+1);
1800 if (stat(git_path("logs/%s", log), &st) < 0)
1802 if (S_ISDIR(st.st_mode)) {
1803 retval = do_for_each_reflog(log, fn, cb_data);
1805 unsigned char sha1[20];
1806 if (!resolve_ref(log, sha1, 0, NULL))
1807 retval = error("bad ref for %s", log);
1809 retval = fn(log, sha1, 0, cb_data);
1822 int for_each_reflog(each_ref_fn fn, void *cb_data)
1824 return do_for_each_reflog("", fn, cb_data);
1827 int update_ref(const char *action, const char *refname,
1828 const unsigned char *sha1, const unsigned char *oldval,
1829 int flags, enum action_on_err onerr)
1831 static struct ref_lock *lock;
1832 lock = lock_any_ref_for_update(refname, oldval, flags);
1834 const char *str = "Cannot lock the ref '%s'.";
1836 case MSG_ON_ERR: error(str, refname); break;
1837 case DIE_ON_ERR: die(str, refname); break;
1838 case QUIET_ON_ERR: break;
1842 if (write_ref_sha1(lock, sha1, action) < 0) {
1843 const char *str = "Cannot update the ref '%s'.";
1845 case MSG_ON_ERR: error(str, refname); break;
1846 case DIE_ON_ERR: die(str, refname); break;
1847 case QUIET_ON_ERR: break;
1854 int ref_exists(char *refname)
1856 unsigned char sha1[20];
1857 return !!resolve_ref(refname, sha1, 1, NULL);
1860 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1862 for ( ; list; list = list->next)
1863 if (!strcmp(list->name, name))
1864 return (struct ref *)list;
1869 * generate a format suitable for scanf from a ref_rev_parse_rules
1870 * rule, that is replace the "%.*s" spec with a "%s" spec
1872 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1876 spec = strstr(rule, "%.*s");
1877 if (!spec || strstr(spec + 4, "%.*s"))
1878 die("invalid rule in ref_rev_parse_rules: %s", rule);
1880 /* copy all until spec */
1881 strncpy(scanf_fmt, rule, spec - rule);
1882 scanf_fmt[spec - rule] = '\0';
1884 strcat(scanf_fmt, "%s");
1885 /* copy remaining rule */
1886 strcat(scanf_fmt, spec + 4);
1891 char *shorten_unambiguous_ref(const char *ref, int strict)
1894 static char **scanf_fmts;
1895 static int nr_rules;
1898 /* pre generate scanf formats from ref_rev_parse_rules[] */
1900 size_t total_len = 0;
1902 /* the rule list is NULL terminated, count them first */
1903 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1904 /* no +1 because strlen("%s") < strlen("%.*s") */
1905 total_len += strlen(ref_rev_parse_rules[nr_rules]);
1907 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1910 for (i = 0; i < nr_rules; i++) {
1911 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1913 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1914 total_len += strlen(ref_rev_parse_rules[i]);
1918 /* bail out if there are no rules */
1920 return xstrdup(ref);
1922 /* buffer for scanf result, at most ref must fit */
1923 short_name = xstrdup(ref);
1925 /* skip first rule, it will always match */
1926 for (i = nr_rules - 1; i > 0 ; --i) {
1928 int rules_to_fail = i;
1931 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1934 short_name_len = strlen(short_name);
1937 * in strict mode, all (except the matched one) rules
1938 * must fail to resolve to a valid non-ambiguous ref
1941 rules_to_fail = nr_rules;
1944 * check if the short name resolves to a valid ref,
1945 * but use only rules prior to the matched one
1947 for (j = 0; j < rules_to_fail; j++) {
1948 const char *rule = ref_rev_parse_rules[j];
1949 unsigned char short_objectname[20];
1950 char refname[PATH_MAX];
1952 /* skip matched rule */
1957 * the short name is ambiguous, if it resolves
1958 * (with this previous rule) to a valid ref
1959 * read_ref() returns 0 on success
1961 mksnpath(refname, sizeof(refname),
1962 rule, short_name_len, short_name);
1963 if (!read_ref(refname, short_objectname))
1968 * short name is non-ambiguous if all previous rules
1969 * haven't resolved to a valid ref
1971 if (j == rules_to_fail)
1976 return xstrdup(ref);