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 clear_cached_refs(struct cached_refs *ca)
176 if (ca->did_loose && ca->loose)
177 free_ref_list(ca->loose);
178 if (ca->did_packed && ca->packed)
179 free_ref_list(ca->packed);
180 ca->loose = ca->packed = NULL;
181 ca->did_loose = ca->did_packed = 0;
184 struct cached_refs *create_cached_refs(void)
186 struct cached_refs *refs;
187 refs = xmalloc(sizeof(struct cached_refs));
188 refs->did_loose = refs->did_packed = 0;
189 refs->loose = refs->packed = NULL;
194 * Return a pointer to a cached_refs for the specified submodule. For
195 * the main repository, use submodule==NULL. The returned structure
196 * will be allocated and initialized but not necessarily populated; it
197 * should not be freed.
199 static struct cached_refs *get_cached_refs(const char *submodule)
203 cached_refs = create_cached_refs();
207 submodule_refs = create_cached_refs();
209 /* For now, don't reuse the refs cache for submodules. */
210 clear_cached_refs(submodule_refs);
211 return submodule_refs;
215 static void invalidate_cached_refs(void)
217 clear_cached_refs(get_cached_refs(NULL));
220 static struct ref_list *read_packed_refs(FILE *f)
222 struct ref_list *list = NULL;
223 struct ref_list *last = NULL;
224 char refline[PATH_MAX];
225 int flag = REF_ISPACKED;
227 while (fgets(refline, sizeof(refline), f)) {
228 unsigned char sha1[20];
230 static const char header[] = "# pack-refs with:";
232 if (!strncmp(refline, header, sizeof(header)-1)) {
233 const char *traits = refline + sizeof(header) - 1;
234 if (strstr(traits, " peeled "))
235 flag |= REF_KNOWS_PEELED;
236 /* perhaps other traits later as well */
240 name = parse_ref_line(refline, sha1);
242 list = add_ref(name, sha1, flag, list, &last);
247 strlen(refline) == 42 &&
248 refline[41] == '\n' &&
249 !get_sha1_hex(refline + 1, sha1))
250 hashcpy(last->peeled, sha1);
252 return sort_ref_list(list);
255 void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
257 extra_refs = add_ref(name, sha1, flag, extra_refs, NULL);
260 void clear_extra_refs(void)
262 free_ref_list(extra_refs);
266 static struct ref_list *get_packed_refs(const char *submodule)
268 struct cached_refs *refs = get_cached_refs(submodule);
270 if (!refs->did_packed) {
271 const char *packed_refs_file;
275 packed_refs_file = git_path_submodule(submodule, "packed-refs");
277 packed_refs_file = git_path("packed-refs");
278 f = fopen(packed_refs_file, "r");
281 refs->packed = read_packed_refs(f);
284 refs->did_packed = 1;
289 static struct ref_list *get_ref_dir(const char *submodule, const char *base,
290 struct ref_list *list)
296 path = git_path_submodule(submodule, "%s", base);
298 path = git_path("%s", base);
305 int baselen = strlen(base);
306 char *ref = xmalloc(baselen + 257);
308 memcpy(ref, base, baselen);
309 if (baselen && base[baselen-1] != '/')
310 ref[baselen++] = '/';
312 while ((de = readdir(dir)) != NULL) {
313 unsigned char sha1[20];
319 if (de->d_name[0] == '.')
321 namelen = strlen(de->d_name);
324 if (has_extension(de->d_name, ".lock"))
326 memcpy(ref + baselen, de->d_name, namelen+1);
328 ? git_path_submodule(submodule, "%s", ref)
329 : git_path("%s", ref);
330 if (stat(refdir, &st) < 0)
332 if (S_ISDIR(st.st_mode)) {
333 list = get_ref_dir(submodule, ref, list);
339 if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
344 if (!resolve_ref(ref, sha1, 1, &flag)) {
348 list = add_ref(ref, sha1, flag, list, NULL);
353 return sort_ref_list(list);
356 struct warn_if_dangling_data {
362 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
363 int flags, void *cb_data)
365 struct warn_if_dangling_data *d = cb_data;
366 const char *resolves_to;
367 unsigned char junk[20];
369 if (!(flags & REF_ISSYMREF))
372 resolves_to = resolve_ref(refname, junk, 0, NULL);
373 if (!resolves_to || strcmp(resolves_to, d->refname))
376 fprintf(d->fp, d->msg_fmt, refname);
380 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
382 struct warn_if_dangling_data data;
385 data.refname = refname;
386 data.msg_fmt = msg_fmt;
387 for_each_rawref(warn_if_dangling_symref, &data);
390 static struct ref_list *get_loose_refs(const char *submodule)
392 struct cached_refs *refs = get_cached_refs(submodule);
394 if (!refs->did_loose) {
395 refs->loose = get_ref_dir(submodule, "refs", NULL);
401 /* We allow "recursive" symbolic refs. Only within reason, though */
403 #define MAXREFLEN (1024)
405 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
408 struct ref_list *packed_refs;
409 struct ref_list *ref;
412 strcpy(name + pathlen, "packed-refs");
413 f = fopen(name, "r");
416 packed_refs = read_packed_refs(f);
421 if (!strcmp(ref->name, refname)) {
423 memcpy(result, ref->sha1, 20);
428 free_ref_list(packed_refs);
432 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
434 int fd, len = strlen(refname);
435 char buffer[128], *p;
437 if (recursion > MAXDEPTH || len > MAXREFLEN)
439 memcpy(name + pathlen, refname, len+1);
440 fd = open(name, O_RDONLY);
442 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
444 len = read(fd, buffer, sizeof(buffer)-1);
448 while (len && isspace(buffer[len-1]))
452 /* Was it a detached head or an old-fashioned symlink? */
453 if (!get_sha1_hex(buffer, result))
457 if (strncmp(buffer, "ref:", 4))
463 return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
466 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
468 int len = strlen(path), retval;
472 while (len && path[len-1] == '/')
476 gitdir = xmalloc(len + MAXREFLEN + 8);
477 memcpy(gitdir, path, len);
478 memcpy(gitdir + len, "/.git", 6);
481 tmp = read_gitfile_gently(gitdir);
485 gitdir = xmalloc(len + MAXREFLEN + 3);
486 memcpy(gitdir, tmp, len);
489 gitdir[++len] = '\0';
490 retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
496 * If the "reading" argument is set, this function finds out what _object_
497 * the ref points at by "reading" the ref. The ref, if it is not symbolic,
498 * has to exist, and if it is symbolic, it has to point at an existing ref,
499 * because the "read" goes through the symref to the ref it points at.
501 * The access that is not "reading" may often be "writing", but does not
502 * have to; it can be merely checking _where it leads to_. If it is a
503 * prelude to "writing" to the ref, a write to a symref that points at
504 * yet-to-be-born ref will create the real ref pointed by the symref.
505 * reading=0 allows the caller to check where such a symref leads to.
507 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
509 int depth = MAXDEPTH;
512 static char ref_buffer[256];
526 git_snpath(path, sizeof(path), "%s", ref);
527 /* Special case: non-existing file. */
528 if (lstat(path, &st) < 0) {
529 struct ref_list *list = get_packed_refs(NULL);
531 if (!strcmp(ref, list->name)) {
532 hashcpy(sha1, list->sha1);
534 *flag |= REF_ISPACKED;
539 if (reading || errno != ENOENT)
545 /* Follow "normalized" - ie "refs/.." symlinks by hand */
546 if (S_ISLNK(st.st_mode)) {
547 len = readlink(path, buffer, sizeof(buffer)-1);
548 if (len >= 5 && !memcmp("refs/", buffer, 5)) {
550 strcpy(ref_buffer, buffer);
553 *flag |= REF_ISSYMREF;
558 /* Is it a directory? */
559 if (S_ISDIR(st.st_mode)) {
565 * Anything else, just open it and try to use it as
568 fd = open(path, O_RDONLY);
571 len = read_in_full(fd, buffer, sizeof(buffer)-1);
575 * Is it a symbolic ref?
577 if (len < 4 || memcmp("ref:", buffer, 4))
581 while (len && isspace(*buf))
583 while (len && isspace(buf[len-1]))
586 memcpy(ref_buffer, buf, len + 1);
589 *flag |= REF_ISSYMREF;
591 if (len < 40 || get_sha1_hex(buffer, sha1))
596 /* The argument to filter_refs */
603 int read_ref(const char *ref, unsigned char *sha1)
605 if (resolve_ref(ref, sha1, 1, NULL))
610 #define DO_FOR_EACH_INCLUDE_BROKEN 01
611 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
612 int flags, void *cb_data, struct ref_list *entry)
614 if (strncmp(base, entry->name, trim))
617 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
618 if (entry->flag & REF_BROKEN)
619 return 0; /* ignore dangling symref */
620 if (!has_sha1_file(entry->sha1)) {
621 error("%s does not point to a valid object!", entry->name);
626 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
629 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
632 struct ref_filter *filter = (struct ref_filter *)data;
633 if (fnmatch(filter->pattern, ref, 0))
635 return filter->fn(ref, sha, flags, filter->cb_data);
638 int peel_ref(const char *ref, unsigned char *sha1)
641 unsigned char base[20];
644 if (current_ref && (current_ref->name == ref
645 || !strcmp(current_ref->name, ref))) {
646 if (current_ref->flag & REF_KNOWS_PEELED) {
647 hashcpy(sha1, current_ref->peeled);
650 hashcpy(base, current_ref->sha1);
654 if (!resolve_ref(ref, base, 1, &flag))
657 if ((flag & REF_ISPACKED)) {
658 struct ref_list *list = get_packed_refs(NULL);
661 if (!strcmp(list->name, ref)) {
662 if (list->flag & REF_KNOWS_PEELED) {
663 hashcpy(sha1, list->peeled);
666 /* older pack-refs did not leave peeled ones */
674 o = parse_object(base);
675 if (o && o->type == OBJ_TAG) {
676 o = deref_tag(o, ref, 0);
678 hashcpy(sha1, o->sha1);
685 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
686 int trim, int flags, void *cb_data)
689 struct ref_list *packed = get_packed_refs(submodule);
690 struct ref_list *loose = get_loose_refs(submodule);
692 struct ref_list *extra;
694 for (extra = extra_refs; extra; extra = extra->next)
695 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
697 while (packed && loose) {
698 struct ref_list *entry;
699 int cmp = strcmp(packed->name, loose->name);
701 packed = packed->next;
709 packed = packed->next;
711 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
716 for (packed = packed ? packed : loose; packed; packed = packed->next) {
717 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
728 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
730 unsigned char sha1[20];
734 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
735 return fn("HEAD", sha1, 0, cb_data);
740 if (resolve_ref("HEAD", sha1, 1, &flag))
741 return fn("HEAD", sha1, flag, cb_data);
746 int head_ref(each_ref_fn fn, void *cb_data)
748 return do_head_ref(NULL, fn, cb_data);
751 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
753 return do_head_ref(submodule, fn, cb_data);
756 int for_each_ref(each_ref_fn fn, void *cb_data)
758 return do_for_each_ref(NULL, "refs/", fn, 0, 0, cb_data);
761 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
763 return do_for_each_ref(submodule, "refs/", fn, 0, 0, cb_data);
766 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
768 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
771 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
772 each_ref_fn fn, void *cb_data)
774 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
777 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
779 return for_each_ref_in("refs/tags/", fn, cb_data);
782 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
784 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
787 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
789 return for_each_ref_in("refs/heads/", fn, cb_data);
792 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
794 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
797 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
799 return for_each_ref_in("refs/remotes/", fn, cb_data);
802 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
804 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
807 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
809 return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
812 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
813 const char *prefix, void *cb_data)
815 struct strbuf real_pattern = STRBUF_INIT;
816 struct ref_filter filter;
819 if (!prefix && prefixcmp(pattern, "refs/"))
820 strbuf_addstr(&real_pattern, "refs/");
822 strbuf_addstr(&real_pattern, prefix);
823 strbuf_addstr(&real_pattern, pattern);
825 if (!has_glob_specials(pattern)) {
826 /* Append implied '/' '*' if not present. */
827 if (real_pattern.buf[real_pattern.len - 1] != '/')
828 strbuf_addch(&real_pattern, '/');
829 /* No need to check for '*', there is none. */
830 strbuf_addch(&real_pattern, '*');
833 filter.pattern = real_pattern.buf;
835 filter.cb_data = cb_data;
836 ret = for_each_ref(filter_refs, &filter);
838 strbuf_release(&real_pattern);
842 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
844 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
847 int for_each_rawref(each_ref_fn fn, void *cb_data)
849 return do_for_each_ref(NULL, "refs/", fn, 0,
850 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
854 * Make sure "ref" is something reasonable to have under ".git/refs/";
855 * We do not like it if:
857 * - any path component of it begins with ".", or
858 * - it has double dots "..", or
859 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
860 * - it ends with a "/".
861 * - it ends with ".lock"
862 * - it contains a "\" (backslash)
865 static inline int bad_ref_char(int ch)
867 if (((unsigned) ch) <= ' ' ||
868 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
870 /* 2.13 Pattern Matching Notation */
871 if (ch == '?' || ch == '[') /* Unsupported */
873 if (ch == '*') /* Supported at the end */
878 int check_ref_format(const char *ref)
880 int ch, level, bad_type, last;
881 int ret = CHECK_REF_FORMAT_OK;
882 const char *cp = ref;
886 while ((ch = *cp++) == '/')
887 ; /* tolerate duplicated slashes */
889 /* should not end with slashes */
890 return CHECK_REF_FORMAT_ERROR;
892 /* we are at the beginning of the path component */
894 return CHECK_REF_FORMAT_ERROR;
895 bad_type = bad_ref_char(ch);
897 if (bad_type == 2 && (!*cp || *cp == '/') &&
898 ret == CHECK_REF_FORMAT_OK)
899 ret = CHECK_REF_FORMAT_WILDCARD;
901 return CHECK_REF_FORMAT_ERROR;
905 /* scan the rest of the path component */
906 while ((ch = *cp++) != 0) {
907 bad_type = bad_ref_char(ch);
909 return CHECK_REF_FORMAT_ERROR;
912 if (last == '.' && ch == '.')
913 return CHECK_REF_FORMAT_ERROR;
914 if (last == '@' && ch == '{')
915 return CHECK_REF_FORMAT_ERROR;
920 if (ref <= cp - 2 && cp[-2] == '.')
921 return CHECK_REF_FORMAT_ERROR;
923 return CHECK_REF_FORMAT_ONELEVEL;
924 if (has_extension(ref, ".lock"))
925 return CHECK_REF_FORMAT_ERROR;
931 const char *prettify_refname(const char *name)
934 !prefixcmp(name, "refs/heads/") ? 11 :
935 !prefixcmp(name, "refs/tags/") ? 10 :
936 !prefixcmp(name, "refs/remotes/") ? 13 :
940 const char *ref_rev_parse_rules[] = {
946 "refs/remotes/%.*s/HEAD",
950 const char *ref_fetch_rules[] = {
957 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
960 const int abbrev_name_len = strlen(abbrev_name);
962 for (p = rules; *p; p++) {
963 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
971 static struct ref_lock *verify_lock(struct ref_lock *lock,
972 const unsigned char *old_sha1, int mustexist)
974 if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
975 error("Can't verify ref %s", lock->ref_name);
979 if (hashcmp(lock->old_sha1, old_sha1)) {
980 error("Ref %s is at %s but expected %s", lock->ref_name,
981 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
988 static int remove_empty_directories(const char *file)
990 /* we want to create a file but there is a directory there;
991 * if that is an empty directory (or a directory that contains
992 * only empty directories), remove them.
997 strbuf_init(&path, 20);
998 strbuf_addstr(&path, file);
1000 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1002 strbuf_release(&path);
1007 static int is_refname_available(const char *ref, const char *oldref,
1008 struct ref_list *list, int quiet)
1010 int namlen = strlen(ref); /* e.g. 'foo/bar' */
1012 /* list->name could be 'foo' or 'foo/bar/baz' */
1013 if (!oldref || strcmp(oldref, list->name)) {
1014 int len = strlen(list->name);
1015 int cmplen = (namlen < len) ? namlen : len;
1016 const char *lead = (namlen < len) ? list->name : ref;
1017 if (!strncmp(ref, list->name, cmplen) &&
1018 lead[cmplen] == '/') {
1020 error("'%s' exists; cannot create '%s'",
1030 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1033 const char *orig_ref = ref;
1034 struct ref_lock *lock;
1037 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1040 lock = xcalloc(1, sizeof(struct ref_lock));
1043 ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
1044 if (!ref && errno == EISDIR) {
1045 /* we are trying to lock foo but we used to
1046 * have foo/bar which now does not exist;
1047 * it is normal for the empty directory 'foo'
1050 ref_file = git_path("%s", orig_ref);
1051 if (remove_empty_directories(ref_file)) {
1053 error("there are still refs under '%s'", orig_ref);
1056 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
1062 error("unable to resolve reference %s: %s",
1063 orig_ref, strerror(errno));
1066 missing = is_null_sha1(lock->old_sha1);
1067 /* When the ref did not exist and we are creating it,
1068 * make sure there is no existing ref that is packed
1069 * whose name begins with our refname, nor a ref whose
1070 * name is a proper prefix of our refname.
1073 !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1074 last_errno = ENOTDIR;
1078 lock->lk = xcalloc(1, sizeof(struct lock_file));
1080 lflags = LOCK_DIE_ON_ERROR;
1081 if (flags & REF_NODEREF) {
1083 lflags |= LOCK_NODEREF;
1085 lock->ref_name = xstrdup(ref);
1086 lock->orig_ref_name = xstrdup(orig_ref);
1087 ref_file = git_path("%s", ref);
1089 lock->force_write = 1;
1090 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1091 lock->force_write = 1;
1093 if (safe_create_leading_directories(ref_file)) {
1095 error("unable to create directory for %s", ref_file);
1099 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1100 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1108 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1110 char refpath[PATH_MAX];
1111 if (check_ref_format(ref))
1113 strcpy(refpath, mkpath("refs/%s", ref));
1114 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1117 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1119 switch (check_ref_format(ref)) {
1123 case CHECK_REF_FORMAT_ONELEVEL:
1124 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1128 static struct lock_file packlock;
1130 static int repack_without_ref(const char *refname)
1132 struct ref_list *list, *packed_ref_list;
1136 packed_ref_list = get_packed_refs(NULL);
1137 for (list = packed_ref_list; list; list = list->next) {
1138 if (!strcmp(refname, list->name)) {
1145 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1147 unable_to_lock_error(git_path("packed-refs"), errno);
1148 return error("cannot delete '%s' from packed refs", refname);
1151 for (list = packed_ref_list; list; list = list->next) {
1152 char line[PATH_MAX + 100];
1155 if (!strcmp(refname, list->name))
1157 len = snprintf(line, sizeof(line), "%s %s\n",
1158 sha1_to_hex(list->sha1), list->name);
1159 /* this should not happen but just being defensive */
1160 if (len > sizeof(line))
1161 die("too long a refname '%s'", list->name);
1162 write_or_die(fd, line, len);
1164 return commit_lock_file(&packlock);
1167 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1169 struct ref_lock *lock;
1170 int err, i = 0, ret = 0, flag = 0;
1172 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1175 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1179 if (!(delopt & REF_NODEREF)) {
1180 i = strlen(lock->lk->filename) - 5; /* .lock */
1181 lock->lk->filename[i] = 0;
1182 path = lock->lk->filename;
1184 path = git_path("%s", refname);
1186 err = unlink_or_warn(path);
1187 if (err && errno != ENOENT)
1190 if (!(delopt & REF_NODEREF))
1191 lock->lk->filename[i] = '.';
1193 /* removing the loose one could have resurrected an earlier
1194 * packed one. Also, if it was not loose we need to repack
1197 ret |= repack_without_ref(refname);
1199 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1200 invalidate_cached_refs();
1206 * People using contrib's git-new-workdir have .git/logs/refs ->
1207 * /some/other/path/.git/logs/refs, and that may live on another device.
1209 * IOW, to avoid cross device rename errors, the temporary renamed log must
1210 * live into logs/refs.
1212 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1214 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1216 static const char renamed_ref[] = "RENAMED-REF";
1217 unsigned char sha1[20], orig_sha1[20];
1218 int flag = 0, logmoved = 0;
1219 struct ref_lock *lock;
1220 struct stat loginfo;
1221 int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1222 const char *symref = NULL;
1224 if (log && S_ISLNK(loginfo.st_mode))
1225 return error("reflog for %s is a symlink", oldref);
1227 symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1228 if (flag & REF_ISSYMREF)
1229 return error("refname %s is a symbolic ref, renaming it is not supported",
1232 return error("refname %s not found", oldref);
1234 if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1237 if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1240 lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1242 return error("unable to lock %s", renamed_ref);
1243 lock->force_write = 1;
1244 if (write_ref_sha1(lock, orig_sha1, logmsg))
1245 return error("unable to save current sha1 in %s", renamed_ref);
1247 if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1248 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1249 oldref, strerror(errno));
1251 if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1252 error("unable to delete old %s", oldref);
1256 if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1257 if (errno==EISDIR) {
1258 if (remove_empty_directories(git_path("%s", newref))) {
1259 error("Directory not empty: %s", newref);
1263 error("unable to delete existing %s", newref);
1268 if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1269 error("unable to create directory for %s", newref);
1274 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1275 if (errno==EISDIR || errno==ENOTDIR) {
1277 * rename(a, b) when b is an existing
1278 * directory ought to result in ISDIR, but
1279 * Solaris 5.8 gives ENOTDIR. Sheesh.
1281 if (remove_empty_directories(git_path("logs/%s", newref))) {
1282 error("Directory not empty: logs/%s", newref);
1287 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1288 newref, strerror(errno));
1294 lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1296 error("unable to lock %s for update", newref);
1299 lock->force_write = 1;
1300 hashcpy(lock->old_sha1, orig_sha1);
1301 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1302 error("unable to write current sha1 into %s", newref);
1309 lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1311 error("unable to lock %s for rollback", oldref);
1315 lock->force_write = 1;
1316 flag = log_all_ref_updates;
1317 log_all_ref_updates = 0;
1318 if (write_ref_sha1(lock, orig_sha1, NULL))
1319 error("unable to write current sha1 into %s", oldref);
1320 log_all_ref_updates = flag;
1323 if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1324 error("unable to restore logfile %s from %s: %s",
1325 oldref, newref, strerror(errno));
1326 if (!logmoved && log &&
1327 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1328 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1329 oldref, strerror(errno));
1334 int close_ref(struct ref_lock *lock)
1336 if (close_lock_file(lock->lk))
1342 int commit_ref(struct ref_lock *lock)
1344 if (commit_lock_file(lock->lk))
1350 void unlock_ref(struct ref_lock *lock)
1352 /* Do not free lock->lk -- atexit() still looks at them */
1354 rollback_lock_file(lock->lk);
1355 free(lock->ref_name);
1356 free(lock->orig_ref_name);
1361 * copy the reflog message msg to buf, which has been allocated sufficiently
1362 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1363 * because reflog file is one line per entry.
1365 static int copy_msg(char *buf, const char *msg)
1372 while ((c = *msg++)) {
1373 if (wasspace && isspace(c))
1375 wasspace = isspace(c);
1380 while (buf < cp && isspace(cp[-1]))
1386 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1388 int logfd, oflags = O_APPEND | O_WRONLY;
1390 git_snpath(logfile, bufsize, "logs/%s", ref_name);
1391 if (log_all_ref_updates &&
1392 (!prefixcmp(ref_name, "refs/heads/") ||
1393 !prefixcmp(ref_name, "refs/remotes/") ||
1394 !prefixcmp(ref_name, "refs/notes/") ||
1395 !strcmp(ref_name, "HEAD"))) {
1396 if (safe_create_leading_directories(logfile) < 0)
1397 return error("unable to create directory for %s",
1402 logfd = open(logfile, oflags, 0666);
1404 if (!(oflags & O_CREAT) && errno == ENOENT)
1407 if ((oflags & O_CREAT) && errno == EISDIR) {
1408 if (remove_empty_directories(logfile)) {
1409 return error("There are still logs under '%s'",
1412 logfd = open(logfile, oflags, 0666);
1416 return error("Unable to append to %s: %s",
1417 logfile, strerror(errno));
1420 adjust_shared_perm(logfile);
1425 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1426 const unsigned char *new_sha1, const char *msg)
1428 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1429 unsigned maxlen, len;
1431 char log_file[PATH_MAX];
1433 const char *committer;
1435 if (log_all_ref_updates < 0)
1436 log_all_ref_updates = !is_bare_repository();
1438 result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1442 logfd = open(log_file, oflags);
1445 msglen = msg ? strlen(msg) : 0;
1446 committer = git_committer_info(0);
1447 maxlen = strlen(committer) + msglen + 100;
1448 logrec = xmalloc(maxlen);
1449 len = sprintf(logrec, "%s %s %s\n",
1450 sha1_to_hex(old_sha1),
1451 sha1_to_hex(new_sha1),
1454 len += copy_msg(logrec + len - 1, msg) - 1;
1455 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1457 if (close(logfd) != 0 || written != len)
1458 return error("Unable to append to %s", log_file);
1462 static int is_branch(const char *refname)
1464 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1467 int write_ref_sha1(struct ref_lock *lock,
1468 const unsigned char *sha1, const char *logmsg)
1470 static char term = '\n';
1475 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1479 o = parse_object(sha1);
1481 error("Trying to write ref %s with nonexistent object %s",
1482 lock->ref_name, sha1_to_hex(sha1));
1486 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1487 error("Trying to write non-commit object %s to branch %s",
1488 sha1_to_hex(sha1), lock->ref_name);
1492 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1493 write_in_full(lock->lock_fd, &term, 1) != 1
1494 || close_ref(lock) < 0) {
1495 error("Couldn't write %s", lock->lk->filename);
1499 invalidate_cached_refs();
1500 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1501 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1502 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1506 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1508 * Special hack: If a branch is updated directly and HEAD
1509 * points to it (may happen on the remote side of a push
1510 * for example) then logically the HEAD reflog should be
1512 * A generic solution implies reverse symref information,
1513 * but finding all symrefs pointing to the given branch
1514 * would be rather costly for this rare event (the direct
1515 * update of a branch) to be worth it. So let's cheat and
1516 * check with HEAD only which should cover 99% of all usage
1517 * scenarios (even 100% of the default ones).
1519 unsigned char head_sha1[20];
1521 const char *head_ref;
1522 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1523 if (head_ref && (head_flag & REF_ISSYMREF) &&
1524 !strcmp(head_ref, lock->ref_name))
1525 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1527 if (commit_ref(lock)) {
1528 error("Couldn't set %s", lock->ref_name);
1536 int create_symref(const char *ref_target, const char *refs_heads_master,
1539 const char *lockpath;
1541 int fd, len, written;
1542 char *git_HEAD = git_pathdup("%s", ref_target);
1543 unsigned char old_sha1[20], new_sha1[20];
1545 if (logmsg && read_ref(ref_target, old_sha1))
1548 if (safe_create_leading_directories(git_HEAD) < 0)
1549 return error("unable to create directory for %s", git_HEAD);
1551 #ifndef NO_SYMLINK_HEAD
1552 if (prefer_symlink_refs) {
1554 if (!symlink(refs_heads_master, git_HEAD))
1556 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1560 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1561 if (sizeof(ref) <= len) {
1562 error("refname too long: %s", refs_heads_master);
1563 goto error_free_return;
1565 lockpath = mkpath("%s.lock", git_HEAD);
1566 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1568 error("Unable to open %s for writing", lockpath);
1569 goto error_free_return;
1571 written = write_in_full(fd, ref, len);
1572 if (close(fd) != 0 || written != len) {
1573 error("Unable to write to %s", lockpath);
1574 goto error_unlink_return;
1576 if (rename(lockpath, git_HEAD) < 0) {
1577 error("Unable to create %s", git_HEAD);
1578 goto error_unlink_return;
1580 if (adjust_shared_perm(git_HEAD)) {
1581 error("Unable to fix permissions on %s", lockpath);
1582 error_unlink_return:
1583 unlink_or_warn(lockpath);
1589 #ifndef NO_SYMLINK_HEAD
1592 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1593 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1599 static char *ref_msg(const char *line, const char *endp)
1603 ep = memchr(line, '\n', endp - line);
1606 return xmemdupz(line, ep - line);
1609 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)
1611 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1613 int logfd, tz, reccnt = 0;
1616 unsigned char logged_sha1[20];
1620 logfile = git_path("logs/%s", ref);
1621 logfd = open(logfile, O_RDONLY, 0);
1623 die_errno("Unable to read log '%s'", logfile);
1626 die("Log %s is empty.", logfile);
1627 mapsz = xsize_t(st.st_size);
1628 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1629 logdata = log_mapped;
1633 rec = logend = logdata + st.st_size;
1634 while (logdata < rec) {
1636 if (logdata < rec && *(rec-1) == '\n')
1639 while (logdata < rec && *(rec-1) != '\n') {
1645 die("Log %s is corrupt.", logfile);
1646 date = strtoul(lastgt + 1, &tz_c, 10);
1647 if (date <= at_time || cnt == 0) {
1648 tz = strtoul(tz_c, NULL, 10);
1650 *msg = ref_msg(rec, logend);
1652 *cutoff_time = date;
1656 *cutoff_cnt = reccnt - 1;
1658 if (get_sha1_hex(lastrec, logged_sha1))
1659 die("Log %s is corrupt.", logfile);
1660 if (get_sha1_hex(rec + 41, sha1))
1661 die("Log %s is corrupt.", logfile);
1662 if (hashcmp(logged_sha1, sha1)) {
1663 warning("Log %s has gap after %s.",
1664 logfile, show_date(date, tz, DATE_RFC2822));
1667 else if (date == at_time) {
1668 if (get_sha1_hex(rec + 41, sha1))
1669 die("Log %s is corrupt.", logfile);
1672 if (get_sha1_hex(rec + 41, logged_sha1))
1673 die("Log %s is corrupt.", logfile);
1674 if (hashcmp(logged_sha1, sha1)) {
1675 warning("Log %s unexpectedly ended on %s.",
1676 logfile, show_date(date, tz, DATE_RFC2822));
1679 munmap(log_mapped, mapsz);
1688 while (rec < logend && *rec != '>' && *rec != '\n')
1690 if (rec == logend || *rec == '\n')
1691 die("Log %s is corrupt.", logfile);
1692 date = strtoul(rec + 1, &tz_c, 10);
1693 tz = strtoul(tz_c, NULL, 10);
1694 if (get_sha1_hex(logdata, sha1))
1695 die("Log %s is corrupt.", logfile);
1696 if (is_null_sha1(sha1)) {
1697 if (get_sha1_hex(logdata + 41, sha1))
1698 die("Log %s is corrupt.", logfile);
1701 *msg = ref_msg(logdata, logend);
1702 munmap(log_mapped, mapsz);
1705 *cutoff_time = date;
1709 *cutoff_cnt = reccnt;
1713 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1715 const char *logfile;
1717 struct strbuf sb = STRBUF_INIT;
1720 logfile = git_path("logs/%s", ref);
1721 logfp = fopen(logfile, "r");
1726 struct stat statbuf;
1727 if (fstat(fileno(logfp), &statbuf) ||
1728 statbuf.st_size < ofs ||
1729 fseek(logfp, -ofs, SEEK_END) ||
1730 strbuf_getwholeline(&sb, logfp, '\n')) {
1732 strbuf_release(&sb);
1737 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1738 unsigned char osha1[20], nsha1[20];
1739 char *email_end, *message;
1740 unsigned long timestamp;
1743 /* old SP new SP name <email> SP time TAB msg LF */
1744 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1745 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1746 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1747 !(email_end = strchr(sb.buf + 82, '>')) ||
1748 email_end[1] != ' ' ||
1749 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1750 !message || message[0] != ' ' ||
1751 (message[1] != '+' && message[1] != '-') ||
1752 !isdigit(message[2]) || !isdigit(message[3]) ||
1753 !isdigit(message[4]) || !isdigit(message[5]))
1754 continue; /* corrupt? */
1755 email_end[1] = '\0';
1756 tz = strtol(message + 1, NULL, 10);
1757 if (message[6] != '\t')
1761 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1767 strbuf_release(&sb);
1771 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1773 return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1776 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1778 DIR *dir = opendir(git_path("logs/%s", base));
1783 int baselen = strlen(base);
1784 char *log = xmalloc(baselen + 257);
1786 memcpy(log, base, baselen);
1787 if (baselen && base[baselen-1] != '/')
1788 log[baselen++] = '/';
1790 while ((de = readdir(dir)) != NULL) {
1794 if (de->d_name[0] == '.')
1796 namelen = strlen(de->d_name);
1799 if (has_extension(de->d_name, ".lock"))
1801 memcpy(log + baselen, de->d_name, namelen+1);
1802 if (stat(git_path("logs/%s", log), &st) < 0)
1804 if (S_ISDIR(st.st_mode)) {
1805 retval = do_for_each_reflog(log, fn, cb_data);
1807 unsigned char sha1[20];
1808 if (!resolve_ref(log, sha1, 0, NULL))
1809 retval = error("bad ref for %s", log);
1811 retval = fn(log, sha1, 0, cb_data);
1824 int for_each_reflog(each_ref_fn fn, void *cb_data)
1826 return do_for_each_reflog("", fn, cb_data);
1829 int update_ref(const char *action, const char *refname,
1830 const unsigned char *sha1, const unsigned char *oldval,
1831 int flags, enum action_on_err onerr)
1833 static struct ref_lock *lock;
1834 lock = lock_any_ref_for_update(refname, oldval, flags);
1836 const char *str = "Cannot lock the ref '%s'.";
1838 case MSG_ON_ERR: error(str, refname); break;
1839 case DIE_ON_ERR: die(str, refname); break;
1840 case QUIET_ON_ERR: break;
1844 if (write_ref_sha1(lock, sha1, action) < 0) {
1845 const char *str = "Cannot update the ref '%s'.";
1847 case MSG_ON_ERR: error(str, refname); break;
1848 case DIE_ON_ERR: die(str, refname); break;
1849 case QUIET_ON_ERR: break;
1856 int ref_exists(char *refname)
1858 unsigned char sha1[20];
1859 return !!resolve_ref(refname, sha1, 1, NULL);
1862 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1864 for ( ; list; list = list->next)
1865 if (!strcmp(list->name, name))
1866 return (struct ref *)list;
1871 * generate a format suitable for scanf from a ref_rev_parse_rules
1872 * rule, that is replace the "%.*s" spec with a "%s" spec
1874 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1878 spec = strstr(rule, "%.*s");
1879 if (!spec || strstr(spec + 4, "%.*s"))
1880 die("invalid rule in ref_rev_parse_rules: %s", rule);
1882 /* copy all until spec */
1883 strncpy(scanf_fmt, rule, spec - rule);
1884 scanf_fmt[spec - rule] = '\0';
1886 strcat(scanf_fmt, "%s");
1887 /* copy remaining rule */
1888 strcat(scanf_fmt, spec + 4);
1893 char *shorten_unambiguous_ref(const char *ref, int strict)
1896 static char **scanf_fmts;
1897 static int nr_rules;
1900 /* pre generate scanf formats from ref_rev_parse_rules[] */
1902 size_t total_len = 0;
1904 /* the rule list is NULL terminated, count them first */
1905 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1906 /* no +1 because strlen("%s") < strlen("%.*s") */
1907 total_len += strlen(ref_rev_parse_rules[nr_rules]);
1909 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1912 for (i = 0; i < nr_rules; i++) {
1913 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1915 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1916 total_len += strlen(ref_rev_parse_rules[i]);
1920 /* bail out if there are no rules */
1922 return xstrdup(ref);
1924 /* buffer for scanf result, at most ref must fit */
1925 short_name = xstrdup(ref);
1927 /* skip first rule, it will always match */
1928 for (i = nr_rules - 1; i > 0 ; --i) {
1930 int rules_to_fail = i;
1933 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1936 short_name_len = strlen(short_name);
1939 * in strict mode, all (except the matched one) rules
1940 * must fail to resolve to a valid non-ambiguous ref
1943 rules_to_fail = nr_rules;
1946 * check if the short name resolves to a valid ref,
1947 * but use only rules prior to the matched one
1949 for (j = 0; j < rules_to_fail; j++) {
1950 const char *rule = ref_rev_parse_rules[j];
1951 unsigned char short_objectname[20];
1952 char refname[PATH_MAX];
1954 /* skip matched rule */
1959 * the short name is ambiguous, if it resolves
1960 * (with this previous rule) to a valid ref
1961 * read_ref() returns 0 on success
1963 mksnpath(refname, sizeof(refname),
1964 rule, short_name_len, short_name);
1965 if (!read_ref(refname, short_objectname))
1970 * short name is non-ambiguous if all previous rules
1971 * haven't resolved to a valid ref
1973 if (j == rules_to_fail)
1978 return xstrdup(ref);