Code

9dc25c3984236a7d661cb4d58d6ef619ebac0f3a
[git.git] / refs.c
1 #include "cache.h"
2 #include "refs.h"
3 #include "object.h"
4 #include "tag.h"
5 #include "dir.h"
7 /* ISSYMREF=01 and ISPACKED=02 are public interfaces */
8 #define REF_KNOWS_PEELED 04
9 #define REF_BROKEN 010
11 struct ref_list {
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];
17 };
19 static const char *parse_ref_line(char *line, unsigned char *sha1)
20 {
21         /*
22          * 42: the answer to everything.
23          *
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)
28          */
29         int len = strlen(line) - 42;
31         if (len <= 0)
32                 return NULL;
33         if (get_sha1_hex(line, sha1) < 0)
34                 return NULL;
35         if (!isspace(line[40]))
36                 return NULL;
37         line += 41;
38         if (isspace(*line))
39                 return NULL;
40         if (line[len] != '\n')
41                 return NULL;
42         line[len] = 0;
44         return line;
45 }
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)
50 {
51         int len;
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);
60         entry->flag = flag;
61         entry->next = list;
62         if (new_entry)
63                 *new_entry = entry;
64         return entry;
65 }
67 /* merge sort the ref list */
68 static struct ref_list *sort_ref_list(struct ref_list *list)
69 {
70         int psize, qsize, last_merge_count, cmp;
71         struct ref_list *p, *q, *l, *e;
72         struct ref_list *new_list = list;
73         int k = 1;
74         int merge_count = 0;
76         if (!list)
77                 return list;
79         do {
80                 last_merge_count = merge_count;
81                 merge_count = 0;
83                 psize = 0;
85                 p = new_list;
86                 q = new_list;
87                 new_list = NULL;
88                 l = NULL;
90                 while (p) {
91                         merge_count++;
93                         while (psize < k && q->next) {
94                                 q = q->next;
95                                 psize++;
96                         }
97                         qsize = k;
99                         while ((psize > 0) || (qsize > 0 && q)) {
100                                 if (qsize == 0 || !q) {
101                                         e = p;
102                                         p = p->next;
103                                         psize--;
104                                 } else if (psize == 0) {
105                                         e = q;
106                                         q = q->next;
107                                         qsize--;
108                                 } else {
109                                         cmp = strcmp(q->name, p->name);
110                                         if (cmp < 0) {
111                                                 e = q;
112                                                 q = q->next;
113                                                 qsize--;
114                                         } else if (cmp > 0) {
115                                                 e = p;
116                                                 p = p->next;
117                                                 psize--;
118                                         } else {
119                                                 if (hashcmp(q->sha1, p->sha1))
120                                                         die("Duplicated ref, and SHA1s don't match: %s",
121                                                             q->name);
122                                                 warning("Duplicated ref: %s", q->name);
123                                                 e = q;
124                                                 q = q->next;
125                                                 qsize--;
126                                                 free(e);
127                                                 e = p;
128                                                 p = p->next;
129                                                 psize--;
130                                         }
131                                 }
133                                 e->next = NULL;
135                                 if (l)
136                                         l->next = e;
137                                 if (!new_list)
138                                         new_list = e;
139                                 l = e;
140                         }
142                         p = q;
143                 };
145                 k = k * 2;
146         } while ((last_merge_count != merge_count) || (last_merge_count != 1));
148         return new_list;
151 /*
152  * Future: need to be in "struct repository"
153  * when doing a full libification.
154  */
155 static struct cached_refs {
156         char did_loose;
157         char did_packed;
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) {
169                 next = list->next;
170                 free(list);
171         }
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 static void invalidate_cached_refs(void)
186         clear_cached_refs(&cached_refs);
189 static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
191         struct ref_list *list = NULL;
192         struct ref_list *last = NULL;
193         char refline[PATH_MAX];
194         int flag = REF_ISPACKED;
196         while (fgets(refline, sizeof(refline), f)) {
197                 unsigned char sha1[20];
198                 const char *name;
199                 static const char header[] = "# pack-refs with:";
201                 if (!strncmp(refline, header, sizeof(header)-1)) {
202                         const char *traits = refline + sizeof(header) - 1;
203                         if (strstr(traits, " peeled "))
204                                 flag |= REF_KNOWS_PEELED;
205                         /* perhaps other traits later as well */
206                         continue;
207                 }
209                 name = parse_ref_line(refline, sha1);
210                 if (name) {
211                         list = add_ref(name, sha1, flag, list, &last);
212                         continue;
213                 }
214                 if (last &&
215                     refline[0] == '^' &&
216                     strlen(refline) == 42 &&
217                     refline[41] == '\n' &&
218                     !get_sha1_hex(refline + 1, sha1))
219                         hashcpy(last->peeled, sha1);
220         }
221         cached_refs->packed = sort_ref_list(list);
224 void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
226         extra_refs = add_ref(name, sha1, flag, extra_refs, NULL);
229 void clear_extra_refs(void)
231         free_ref_list(extra_refs);
232         extra_refs = NULL;
235 static struct ref_list *get_packed_refs(const char *submodule)
237         const char *packed_refs_file;
238         struct cached_refs *refs;
240         if (submodule) {
241                 packed_refs_file = git_path_submodule(submodule, "packed-refs");
242                 refs = &submodule_refs;
243                 free_ref_list(refs->packed);
244         } else {
245                 packed_refs_file = git_path("packed-refs");
246                 refs = &cached_refs;
247         }
249         if (!refs->did_packed || submodule) {
250                 FILE *f = fopen(packed_refs_file, "r");
251                 refs->packed = NULL;
252                 if (f) {
253                         read_packed_refs(f, refs);
254                         fclose(f);
255                 }
256                 refs->did_packed = 1;
257         }
258         return refs->packed;
261 static struct ref_list *get_ref_dir(const char *submodule, const char *base,
262                                     struct ref_list *list)
264         DIR *dir;
265         const char *path;
267         if (submodule)
268                 path = git_path_submodule(submodule, "%s", base);
269         else
270                 path = git_path("%s", base);
273         dir = opendir(path);
275         if (dir) {
276                 struct dirent *de;
277                 int baselen = strlen(base);
278                 char *ref = xmalloc(baselen + 257);
280                 memcpy(ref, base, baselen);
281                 if (baselen && base[baselen-1] != '/')
282                         ref[baselen++] = '/';
284                 while ((de = readdir(dir)) != NULL) {
285                         unsigned char sha1[20];
286                         struct stat st;
287                         int flag;
288                         int namelen;
289                         const char *refdir;
291                         if (de->d_name[0] == '.')
292                                 continue;
293                         namelen = strlen(de->d_name);
294                         if (namelen > 255)
295                                 continue;
296                         if (has_extension(de->d_name, ".lock"))
297                                 continue;
298                         memcpy(ref + baselen, de->d_name, namelen+1);
299                         refdir = submodule
300                                 ? git_path_submodule(submodule, "%s", ref)
301                                 : git_path("%s", ref);
302                         if (stat(refdir, &st) < 0)
303                                 continue;
304                         if (S_ISDIR(st.st_mode)) {
305                                 list = get_ref_dir(submodule, ref, list);
306                                 continue;
307                         }
308                         if (submodule) {
309                                 hashclr(sha1);
310                                 flag = 0;
311                                 if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
312                                         hashclr(sha1);
313                                         flag |= REF_BROKEN;
314                                 }
315                         } else
316                                 if (!resolve_ref(ref, sha1, 1, &flag)) {
317                                         hashclr(sha1);
318                                         flag |= REF_BROKEN;
319                                 }
320                         list = add_ref(ref, sha1, flag, list, NULL);
321                 }
322                 free(ref);
323                 closedir(dir);
324         }
325         return sort_ref_list(list);
328 struct warn_if_dangling_data {
329         FILE *fp;
330         const char *refname;
331         const char *msg_fmt;
332 };
334 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
335                                    int flags, void *cb_data)
337         struct warn_if_dangling_data *d = cb_data;
338         const char *resolves_to;
339         unsigned char junk[20];
341         if (!(flags & REF_ISSYMREF))
342                 return 0;
344         resolves_to = resolve_ref(refname, junk, 0, NULL);
345         if (!resolves_to || strcmp(resolves_to, d->refname))
346                 return 0;
348         fprintf(d->fp, d->msg_fmt, refname);
349         return 0;
352 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
354         struct warn_if_dangling_data data;
356         data.fp = fp;
357         data.refname = refname;
358         data.msg_fmt = msg_fmt;
359         for_each_rawref(warn_if_dangling_symref, &data);
362 static struct ref_list *get_loose_refs(const char *submodule)
364         if (submodule) {
365                 free_ref_list(submodule_refs.loose);
366                 submodule_refs.loose = get_ref_dir(submodule, "refs", NULL);
367                 return submodule_refs.loose;
368         }
370         if (!cached_refs.did_loose) {
371                 cached_refs.loose = get_ref_dir(NULL, "refs", NULL);
372                 cached_refs.did_loose = 1;
373         }
374         return cached_refs.loose;
377 /* We allow "recursive" symbolic refs. Only within reason, though */
378 #define MAXDEPTH 5
379 #define MAXREFLEN (1024)
381 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
383         FILE *f;
384         struct cached_refs refs;
385         struct ref_list *ref;
386         int retval;
388         strcpy(name + pathlen, "packed-refs");
389         f = fopen(name, "r");
390         if (!f)
391                 return -1;
392         read_packed_refs(f, &refs);
393         fclose(f);
394         ref = refs.packed;
395         retval = -1;
396         while (ref) {
397                 if (!strcmp(ref->name, refname)) {
398                         retval = 0;
399                         memcpy(result, ref->sha1, 20);
400                         break;
401                 }
402                 ref = ref->next;
403         }
404         free_ref_list(refs.packed);
405         return retval;
408 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
410         int fd, len = strlen(refname);
411         char buffer[128], *p;
413         if (recursion > MAXDEPTH || len > MAXREFLEN)
414                 return -1;
415         memcpy(name + pathlen, refname, len+1);
416         fd = open(name, O_RDONLY);
417         if (fd < 0)
418                 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
420         len = read(fd, buffer, sizeof(buffer)-1);
421         close(fd);
422         if (len < 0)
423                 return -1;
424         while (len && isspace(buffer[len-1]))
425                 len--;
426         buffer[len] = 0;
428         /* Was it a detached head or an old-fashioned symlink? */
429         if (!get_sha1_hex(buffer, result))
430                 return 0;
432         /* Symref? */
433         if (strncmp(buffer, "ref:", 4))
434                 return -1;
435         p = buffer + 4;
436         while (isspace(*p))
437                 p++;
439         return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
442 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
444         int len = strlen(path), retval;
445         char *gitdir;
446         const char *tmp;
448         while (len && path[len-1] == '/')
449                 len--;
450         if (!len)
451                 return -1;
452         gitdir = xmalloc(len + MAXREFLEN + 8);
453         memcpy(gitdir, path, len);
454         memcpy(gitdir + len, "/.git", 6);
455         len += 5;
457         tmp = read_gitfile_gently(gitdir);
458         if (tmp) {
459                 free(gitdir);
460                 len = strlen(tmp);
461                 gitdir = xmalloc(len + MAXREFLEN + 3);
462                 memcpy(gitdir, tmp, len);
463         }
464         gitdir[len] = '/';
465         gitdir[++len] = '\0';
466         retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
467         free(gitdir);
468         return retval;
471 /*
472  * If the "reading" argument is set, this function finds out what _object_
473  * the ref points at by "reading" the ref.  The ref, if it is not symbolic,
474  * has to exist, and if it is symbolic, it has to point at an existing ref,
475  * because the "read" goes through the symref to the ref it points at.
476  *
477  * The access that is not "reading" may often be "writing", but does not
478  * have to; it can be merely checking _where it leads to_. If it is a
479  * prelude to "writing" to the ref, a write to a symref that points at
480  * yet-to-be-born ref will create the real ref pointed by the symref.
481  * reading=0 allows the caller to check where such a symref leads to.
482  */
483 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
485         int depth = MAXDEPTH;
486         ssize_t len;
487         char buffer[256];
488         static char ref_buffer[256];
490         if (flag)
491                 *flag = 0;
493         for (;;) {
494                 char path[PATH_MAX];
495                 struct stat st;
496                 char *buf;
497                 int fd;
499                 if (--depth < 0)
500                         return NULL;
502                 git_snpath(path, sizeof(path), "%s", ref);
503                 /* Special case: non-existing file. */
504                 if (lstat(path, &st) < 0) {
505                         struct ref_list *list = get_packed_refs(NULL);
506                         while (list) {
507                                 if (!strcmp(ref, list->name)) {
508                                         hashcpy(sha1, list->sha1);
509                                         if (flag)
510                                                 *flag |= REF_ISPACKED;
511                                         return ref;
512                                 }
513                                 list = list->next;
514                         }
515                         if (reading || errno != ENOENT)
516                                 return NULL;
517                         hashclr(sha1);
518                         return ref;
519                 }
521                 /* Follow "normalized" - ie "refs/.." symlinks by hand */
522                 if (S_ISLNK(st.st_mode)) {
523                         len = readlink(path, buffer, sizeof(buffer)-1);
524                         if (len >= 5 && !memcmp("refs/", buffer, 5)) {
525                                 buffer[len] = 0;
526                                 strcpy(ref_buffer, buffer);
527                                 ref = ref_buffer;
528                                 if (flag)
529                                         *flag |= REF_ISSYMREF;
530                                 continue;
531                         }
532                 }
534                 /* Is it a directory? */
535                 if (S_ISDIR(st.st_mode)) {
536                         errno = EISDIR;
537                         return NULL;
538                 }
540                 /*
541                  * Anything else, just open it and try to use it as
542                  * a ref
543                  */
544                 fd = open(path, O_RDONLY);
545                 if (fd < 0)
546                         return NULL;
547                 len = read_in_full(fd, buffer, sizeof(buffer)-1);
548                 close(fd);
550                 /*
551                  * Is it a symbolic ref?
552                  */
553                 if (len < 4 || memcmp("ref:", buffer, 4))
554                         break;
555                 buf = buffer + 4;
556                 len -= 4;
557                 while (len && isspace(*buf))
558                         buf++, len--;
559                 while (len && isspace(buf[len-1]))
560                         len--;
561                 buf[len] = 0;
562                 memcpy(ref_buffer, buf, len + 1);
563                 ref = ref_buffer;
564                 if (flag)
565                         *flag |= REF_ISSYMREF;
566         }
567         if (len < 40 || get_sha1_hex(buffer, sha1))
568                 return NULL;
569         return ref;
572 /* The argument to filter_refs */
573 struct ref_filter {
574         const char *pattern;
575         each_ref_fn *fn;
576         void *cb_data;
577 };
579 int read_ref(const char *ref, unsigned char *sha1)
581         if (resolve_ref(ref, sha1, 1, NULL))
582                 return 0;
583         return -1;
586 #define DO_FOR_EACH_INCLUDE_BROKEN 01
587 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
588                       int flags, void *cb_data, struct ref_list *entry)
590         if (strncmp(base, entry->name, trim))
591                 return 0;
593         if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
594                 if (entry->flag & REF_BROKEN)
595                         return 0; /* ignore dangling symref */
596                 if (!has_sha1_file(entry->sha1)) {
597                         error("%s does not point to a valid object!", entry->name);
598                         return 0;
599                 }
600         }
601         current_ref = entry;
602         return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
605 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
606         void *data)
608         struct ref_filter *filter = (struct ref_filter *)data;
609         if (fnmatch(filter->pattern, ref, 0))
610                 return 0;
611         return filter->fn(ref, sha, flags, filter->cb_data);
614 int peel_ref(const char *ref, unsigned char *sha1)
616         int flag;
617         unsigned char base[20];
618         struct object *o;
620         if (current_ref && (current_ref->name == ref
621                 || !strcmp(current_ref->name, ref))) {
622                 if (current_ref->flag & REF_KNOWS_PEELED) {
623                         hashcpy(sha1, current_ref->peeled);
624                         return 0;
625                 }
626                 hashcpy(base, current_ref->sha1);
627                 goto fallback;
628         }
630         if (!resolve_ref(ref, base, 1, &flag))
631                 return -1;
633         if ((flag & REF_ISPACKED)) {
634                 struct ref_list *list = get_packed_refs(NULL);
636                 while (list) {
637                         if (!strcmp(list->name, ref)) {
638                                 if (list->flag & REF_KNOWS_PEELED) {
639                                         hashcpy(sha1, list->peeled);
640                                         return 0;
641                                 }
642                                 /* older pack-refs did not leave peeled ones */
643                                 break;
644                         }
645                         list = list->next;
646                 }
647         }
649 fallback:
650         o = parse_object(base);
651         if (o && o->type == OBJ_TAG) {
652                 o = deref_tag(o, ref, 0);
653                 if (o) {
654                         hashcpy(sha1, o->sha1);
655                         return 0;
656                 }
657         }
658         return -1;
661 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
662                            int trim, int flags, void *cb_data)
664         int retval = 0;
665         struct ref_list *packed = get_packed_refs(submodule);
666         struct ref_list *loose = get_loose_refs(submodule);
668         struct ref_list *extra;
670         for (extra = extra_refs; extra; extra = extra->next)
671                 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
673         while (packed && loose) {
674                 struct ref_list *entry;
675                 int cmp = strcmp(packed->name, loose->name);
676                 if (!cmp) {
677                         packed = packed->next;
678                         continue;
679                 }
680                 if (cmp > 0) {
681                         entry = loose;
682                         loose = loose->next;
683                 } else {
684                         entry = packed;
685                         packed = packed->next;
686                 }
687                 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
688                 if (retval)
689                         goto end_each;
690         }
692         for (packed = packed ? packed : loose; packed; packed = packed->next) {
693                 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
694                 if (retval)
695                         goto end_each;
696         }
698 end_each:
699         current_ref = NULL;
700         return retval;
704 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
706         unsigned char sha1[20];
707         int flag;
709         if (submodule) {
710                 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
711                         return fn("HEAD", sha1, 0, cb_data);
713                 return 0;
714         }
716         if (resolve_ref("HEAD", sha1, 1, &flag))
717                 return fn("HEAD", sha1, flag, cb_data);
719         return 0;
722 int head_ref(each_ref_fn fn, void *cb_data)
724         return do_head_ref(NULL, fn, cb_data);
727 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
729         return do_head_ref(submodule, fn, cb_data);
732 int for_each_ref(each_ref_fn fn, void *cb_data)
734         return do_for_each_ref(NULL, "refs/", fn, 0, 0, cb_data);
737 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
739         return do_for_each_ref(submodule, "refs/", fn, 0, 0, cb_data);
742 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
744         return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
747 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
748                 each_ref_fn fn, void *cb_data)
750         return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
753 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
755         return for_each_ref_in("refs/tags/", fn, cb_data);
758 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
760         return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
763 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
765         return for_each_ref_in("refs/heads/", fn, cb_data);
768 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
770         return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
773 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
775         return for_each_ref_in("refs/remotes/", fn, cb_data);
778 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
780         return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
783 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
785         return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
788 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
789         const char *prefix, void *cb_data)
791         struct strbuf real_pattern = STRBUF_INIT;
792         struct ref_filter filter;
793         int ret;
795         if (!prefix && prefixcmp(pattern, "refs/"))
796                 strbuf_addstr(&real_pattern, "refs/");
797         else if (prefix)
798                 strbuf_addstr(&real_pattern, prefix);
799         strbuf_addstr(&real_pattern, pattern);
801         if (!has_glob_specials(pattern)) {
802                 /* Append implied '/' '*' if not present. */
803                 if (real_pattern.buf[real_pattern.len - 1] != '/')
804                         strbuf_addch(&real_pattern, '/');
805                 /* No need to check for '*', there is none. */
806                 strbuf_addch(&real_pattern, '*');
807         }
809         filter.pattern = real_pattern.buf;
810         filter.fn = fn;
811         filter.cb_data = cb_data;
812         ret = for_each_ref(filter_refs, &filter);
814         strbuf_release(&real_pattern);
815         return ret;
818 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
820         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
823 int for_each_rawref(each_ref_fn fn, void *cb_data)
825         return do_for_each_ref(NULL, "refs/", fn, 0,
826                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
829 /*
830  * Make sure "ref" is something reasonable to have under ".git/refs/";
831  * We do not like it if:
832  *
833  * - any path component of it begins with ".", or
834  * - it has double dots "..", or
835  * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
836  * - it ends with a "/".
837  * - it ends with ".lock"
838  * - it contains a "\" (backslash)
839  */
841 static inline int bad_ref_char(int ch)
843         if (((unsigned) ch) <= ' ' ||
844             ch == '~' || ch == '^' || ch == ':' || ch == '\\')
845                 return 1;
846         /* 2.13 Pattern Matching Notation */
847         if (ch == '?' || ch == '[') /* Unsupported */
848                 return 1;
849         if (ch == '*') /* Supported at the end */
850                 return 2;
851         return 0;
854 int check_ref_format(const char *ref)
856         int ch, level, bad_type, last;
857         int ret = CHECK_REF_FORMAT_OK;
858         const char *cp = ref;
860         level = 0;
861         while (1) {
862                 while ((ch = *cp++) == '/')
863                         ; /* tolerate duplicated slashes */
864                 if (!ch)
865                         /* should not end with slashes */
866                         return CHECK_REF_FORMAT_ERROR;
868                 /* we are at the beginning of the path component */
869                 if (ch == '.')
870                         return CHECK_REF_FORMAT_ERROR;
871                 bad_type = bad_ref_char(ch);
872                 if (bad_type) {
873                         if (bad_type == 2 && (!*cp || *cp == '/') &&
874                             ret == CHECK_REF_FORMAT_OK)
875                                 ret = CHECK_REF_FORMAT_WILDCARD;
876                         else
877                                 return CHECK_REF_FORMAT_ERROR;
878                 }
880                 last = ch;
881                 /* scan the rest of the path component */
882                 while ((ch = *cp++) != 0) {
883                         bad_type = bad_ref_char(ch);
884                         if (bad_type)
885                                 return CHECK_REF_FORMAT_ERROR;
886                         if (ch == '/')
887                                 break;
888                         if (last == '.' && ch == '.')
889                                 return CHECK_REF_FORMAT_ERROR;
890                         if (last == '@' && ch == '{')
891                                 return CHECK_REF_FORMAT_ERROR;
892                         last = ch;
893                 }
894                 level++;
895                 if (!ch) {
896                         if (ref <= cp - 2 && cp[-2] == '.')
897                                 return CHECK_REF_FORMAT_ERROR;
898                         if (level < 2)
899                                 return CHECK_REF_FORMAT_ONELEVEL;
900                         if (has_extension(ref, ".lock"))
901                                 return CHECK_REF_FORMAT_ERROR;
902                         return ret;
903                 }
904         }
907 const char *prettify_refname(const char *name)
909         return name + (
910                 !prefixcmp(name, "refs/heads/") ? 11 :
911                 !prefixcmp(name, "refs/tags/") ? 10 :
912                 !prefixcmp(name, "refs/remotes/") ? 13 :
913                 0);
916 const char *ref_rev_parse_rules[] = {
917         "%.*s",
918         "refs/%.*s",
919         "refs/tags/%.*s",
920         "refs/heads/%.*s",
921         "refs/remotes/%.*s",
922         "refs/remotes/%.*s/HEAD",
923         NULL
924 };
926 const char *ref_fetch_rules[] = {
927         "%.*s",
928         "refs/%.*s",
929         "refs/heads/%.*s",
930         NULL
931 };
933 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
935         const char **p;
936         const int abbrev_name_len = strlen(abbrev_name);
938         for (p = rules; *p; p++) {
939                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
940                         return 1;
941                 }
942         }
944         return 0;
947 static struct ref_lock *verify_lock(struct ref_lock *lock,
948         const unsigned char *old_sha1, int mustexist)
950         if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
951                 error("Can't verify ref %s", lock->ref_name);
952                 unlock_ref(lock);
953                 return NULL;
954         }
955         if (hashcmp(lock->old_sha1, old_sha1)) {
956                 error("Ref %s is at %s but expected %s", lock->ref_name,
957                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
958                 unlock_ref(lock);
959                 return NULL;
960         }
961         return lock;
964 static int remove_empty_directories(const char *file)
966         /* we want to create a file but there is a directory there;
967          * if that is an empty directory (or a directory that contains
968          * only empty directories), remove them.
969          */
970         struct strbuf path;
971         int result;
973         strbuf_init(&path, 20);
974         strbuf_addstr(&path, file);
976         result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
978         strbuf_release(&path);
980         return result;
983 static int is_refname_available(const char *ref, const char *oldref,
984                                 struct ref_list *list, int quiet)
986         int namlen = strlen(ref); /* e.g. 'foo/bar' */
987         while (list) {
988                 /* list->name could be 'foo' or 'foo/bar/baz' */
989                 if (!oldref || strcmp(oldref, list->name)) {
990                         int len = strlen(list->name);
991                         int cmplen = (namlen < len) ? namlen : len;
992                         const char *lead = (namlen < len) ? list->name : ref;
993                         if (!strncmp(ref, list->name, cmplen) &&
994                             lead[cmplen] == '/') {
995                                 if (!quiet)
996                                         error("'%s' exists; cannot create '%s'",
997                                               list->name, ref);
998                                 return 0;
999                         }
1000                 }
1001                 list = list->next;
1002         }
1003         return 1;
1006 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1008         char *ref_file;
1009         const char *orig_ref = ref;
1010         struct ref_lock *lock;
1011         int last_errno = 0;
1012         int type, lflags;
1013         int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1014         int missing = 0;
1016         lock = xcalloc(1, sizeof(struct ref_lock));
1017         lock->lock_fd = -1;
1019         ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
1020         if (!ref && errno == EISDIR) {
1021                 /* we are trying to lock foo but we used to
1022                  * have foo/bar which now does not exist;
1023                  * it is normal for the empty directory 'foo'
1024                  * to remain.
1025                  */
1026                 ref_file = git_path("%s", orig_ref);
1027                 if (remove_empty_directories(ref_file)) {
1028                         last_errno = errno;
1029                         error("there are still refs under '%s'", orig_ref);
1030                         goto error_return;
1031                 }
1032                 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
1033         }
1034         if (type_p)
1035             *type_p = type;
1036         if (!ref) {
1037                 last_errno = errno;
1038                 error("unable to resolve reference %s: %s",
1039                         orig_ref, strerror(errno));
1040                 goto error_return;
1041         }
1042         missing = is_null_sha1(lock->old_sha1);
1043         /* When the ref did not exist and we are creating it,
1044          * make sure there is no existing ref that is packed
1045          * whose name begins with our refname, nor a ref whose
1046          * name is a proper prefix of our refname.
1047          */
1048         if (missing &&
1049              !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1050                 last_errno = ENOTDIR;
1051                 goto error_return;
1052         }
1054         lock->lk = xcalloc(1, sizeof(struct lock_file));
1056         lflags = LOCK_DIE_ON_ERROR;
1057         if (flags & REF_NODEREF) {
1058                 ref = orig_ref;
1059                 lflags |= LOCK_NODEREF;
1060         }
1061         lock->ref_name = xstrdup(ref);
1062         lock->orig_ref_name = xstrdup(orig_ref);
1063         ref_file = git_path("%s", ref);
1064         if (missing)
1065                 lock->force_write = 1;
1066         if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1067                 lock->force_write = 1;
1069         if (safe_create_leading_directories(ref_file)) {
1070                 last_errno = errno;
1071                 error("unable to create directory for %s", ref_file);
1072                 goto error_return;
1073         }
1075         lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1076         return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1078  error_return:
1079         unlock_ref(lock);
1080         errno = last_errno;
1081         return NULL;
1084 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1086         char refpath[PATH_MAX];
1087         if (check_ref_format(ref))
1088                 return NULL;
1089         strcpy(refpath, mkpath("refs/%s", ref));
1090         return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1093 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1095         switch (check_ref_format(ref)) {
1096         default:
1097                 return NULL;
1098         case 0:
1099         case CHECK_REF_FORMAT_ONELEVEL:
1100                 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1101         }
1104 static struct lock_file packlock;
1106 static int repack_without_ref(const char *refname)
1108         struct ref_list *list, *packed_ref_list;
1109         int fd;
1110         int found = 0;
1112         packed_ref_list = get_packed_refs(NULL);
1113         for (list = packed_ref_list; list; list = list->next) {
1114                 if (!strcmp(refname, list->name)) {
1115                         found = 1;
1116                         break;
1117                 }
1118         }
1119         if (!found)
1120                 return 0;
1121         fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1122         if (fd < 0) {
1123                 unable_to_lock_error(git_path("packed-refs"), errno);
1124                 return error("cannot delete '%s' from packed refs", refname);
1125         }
1127         for (list = packed_ref_list; list; list = list->next) {
1128                 char line[PATH_MAX + 100];
1129                 int len;
1131                 if (!strcmp(refname, list->name))
1132                         continue;
1133                 len = snprintf(line, sizeof(line), "%s %s\n",
1134                                sha1_to_hex(list->sha1), list->name);
1135                 /* this should not happen but just being defensive */
1136                 if (len > sizeof(line))
1137                         die("too long a refname '%s'", list->name);
1138                 write_or_die(fd, line, len);
1139         }
1140         return commit_lock_file(&packlock);
1143 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1145         struct ref_lock *lock;
1146         int err, i = 0, ret = 0, flag = 0;
1148         lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1149         if (!lock)
1150                 return 1;
1151         if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1152                 /* loose */
1153                 const char *path;
1155                 if (!(delopt & REF_NODEREF)) {
1156                         i = strlen(lock->lk->filename) - 5; /* .lock */
1157                         lock->lk->filename[i] = 0;
1158                         path = lock->lk->filename;
1159                 } else {
1160                         path = git_path("%s", refname);
1161                 }
1162                 err = unlink_or_warn(path);
1163                 if (err && errno != ENOENT)
1164                         ret = 1;
1166                 if (!(delopt & REF_NODEREF))
1167                         lock->lk->filename[i] = '.';
1168         }
1169         /* removing the loose one could have resurrected an earlier
1170          * packed one.  Also, if it was not loose we need to repack
1171          * without it.
1172          */
1173         ret |= repack_without_ref(refname);
1175         unlink_or_warn(git_path("logs/%s", lock->ref_name));
1176         invalidate_cached_refs();
1177         unlock_ref(lock);
1178         return ret;
1181 /*
1182  * People using contrib's git-new-workdir have .git/logs/refs ->
1183  * /some/other/path/.git/logs/refs, and that may live on another device.
1184  *
1185  * IOW, to avoid cross device rename errors, the temporary renamed log must
1186  * live into logs/refs.
1187  */
1188 #define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1190 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1192         static const char renamed_ref[] = "RENAMED-REF";
1193         unsigned char sha1[20], orig_sha1[20];
1194         int flag = 0, logmoved = 0;
1195         struct ref_lock *lock;
1196         struct stat loginfo;
1197         int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1198         const char *symref = NULL;
1200         if (log && S_ISLNK(loginfo.st_mode))
1201                 return error("reflog for %s is a symlink", oldref);
1203         symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1204         if (flag & REF_ISSYMREF)
1205                 return error("refname %s is a symbolic ref, renaming it is not supported",
1206                         oldref);
1207         if (!symref)
1208                 return error("refname %s not found", oldref);
1210         if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1211                 return 1;
1213         if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1214                 return 1;
1216         lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1217         if (!lock)
1218                 return error("unable to lock %s", renamed_ref);
1219         lock->force_write = 1;
1220         if (write_ref_sha1(lock, orig_sha1, logmsg))
1221                 return error("unable to save current sha1 in %s", renamed_ref);
1223         if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1224                 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1225                         oldref, strerror(errno));
1227         if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1228                 error("unable to delete old %s", oldref);
1229                 goto rollback;
1230         }
1232         if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1233                 if (errno==EISDIR) {
1234                         if (remove_empty_directories(git_path("%s", newref))) {
1235                                 error("Directory not empty: %s", newref);
1236                                 goto rollback;
1237                         }
1238                 } else {
1239                         error("unable to delete existing %s", newref);
1240                         goto rollback;
1241                 }
1242         }
1244         if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1245                 error("unable to create directory for %s", newref);
1246                 goto rollback;
1247         }
1249  retry:
1250         if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1251                 if (errno==EISDIR || errno==ENOTDIR) {
1252                         /*
1253                          * rename(a, b) when b is an existing
1254                          * directory ought to result in ISDIR, but
1255                          * Solaris 5.8 gives ENOTDIR.  Sheesh.
1256                          */
1257                         if (remove_empty_directories(git_path("logs/%s", newref))) {
1258                                 error("Directory not empty: logs/%s", newref);
1259                                 goto rollback;
1260                         }
1261                         goto retry;
1262                 } else {
1263                         error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1264                                 newref, strerror(errno));
1265                         goto rollback;
1266                 }
1267         }
1268         logmoved = log;
1270         lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1271         if (!lock) {
1272                 error("unable to lock %s for update", newref);
1273                 goto rollback;
1274         }
1275         lock->force_write = 1;
1276         hashcpy(lock->old_sha1, orig_sha1);
1277         if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1278                 error("unable to write current sha1 into %s", newref);
1279                 goto rollback;
1280         }
1282         return 0;
1284  rollback:
1285         lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1286         if (!lock) {
1287                 error("unable to lock %s for rollback", oldref);
1288                 goto rollbacklog;
1289         }
1291         lock->force_write = 1;
1292         flag = log_all_ref_updates;
1293         log_all_ref_updates = 0;
1294         if (write_ref_sha1(lock, orig_sha1, NULL))
1295                 error("unable to write current sha1 into %s", oldref);
1296         log_all_ref_updates = flag;
1298  rollbacklog:
1299         if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1300                 error("unable to restore logfile %s from %s: %s",
1301                         oldref, newref, strerror(errno));
1302         if (!logmoved && log &&
1303             rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1304                 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1305                         oldref, strerror(errno));
1307         return 1;
1310 int close_ref(struct ref_lock *lock)
1312         if (close_lock_file(lock->lk))
1313                 return -1;
1314         lock->lock_fd = -1;
1315         return 0;
1318 int commit_ref(struct ref_lock *lock)
1320         if (commit_lock_file(lock->lk))
1321                 return -1;
1322         lock->lock_fd = -1;
1323         return 0;
1326 void unlock_ref(struct ref_lock *lock)
1328         /* Do not free lock->lk -- atexit() still looks at them */
1329         if (lock->lk)
1330                 rollback_lock_file(lock->lk);
1331         free(lock->ref_name);
1332         free(lock->orig_ref_name);
1333         free(lock);
1336 /*
1337  * copy the reflog message msg to buf, which has been allocated sufficiently
1338  * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1339  * because reflog file is one line per entry.
1340  */
1341 static int copy_msg(char *buf, const char *msg)
1343         char *cp = buf;
1344         char c;
1345         int wasspace = 1;
1347         *cp++ = '\t';
1348         while ((c = *msg++)) {
1349                 if (wasspace && isspace(c))
1350                         continue;
1351                 wasspace = isspace(c);
1352                 if (wasspace)
1353                         c = ' ';
1354                 *cp++ = c;
1355         }
1356         while (buf < cp && isspace(cp[-1]))
1357                 cp--;
1358         *cp++ = '\n';
1359         return cp - buf;
1362 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1364         int logfd, oflags = O_APPEND | O_WRONLY;
1366         git_snpath(logfile, bufsize, "logs/%s", ref_name);
1367         if (log_all_ref_updates &&
1368             (!prefixcmp(ref_name, "refs/heads/") ||
1369              !prefixcmp(ref_name, "refs/remotes/") ||
1370              !prefixcmp(ref_name, "refs/notes/") ||
1371              !strcmp(ref_name, "HEAD"))) {
1372                 if (safe_create_leading_directories(logfile) < 0)
1373                         return error("unable to create directory for %s",
1374                                      logfile);
1375                 oflags |= O_CREAT;
1376         }
1378         logfd = open(logfile, oflags, 0666);
1379         if (logfd < 0) {
1380                 if (!(oflags & O_CREAT) && errno == ENOENT)
1381                         return 0;
1383                 if ((oflags & O_CREAT) && errno == EISDIR) {
1384                         if (remove_empty_directories(logfile)) {
1385                                 return error("There are still logs under '%s'",
1386                                              logfile);
1387                         }
1388                         logfd = open(logfile, oflags, 0666);
1389                 }
1391                 if (logfd < 0)
1392                         return error("Unable to append to %s: %s",
1393                                      logfile, strerror(errno));
1394         }
1396         adjust_shared_perm(logfile);
1397         close(logfd);
1398         return 0;
1401 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1402                          const unsigned char *new_sha1, const char *msg)
1404         int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1405         unsigned maxlen, len;
1406         int msglen;
1407         char log_file[PATH_MAX];
1408         char *logrec;
1409         const char *committer;
1411         if (log_all_ref_updates < 0)
1412                 log_all_ref_updates = !is_bare_repository();
1414         result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1415         if (result)
1416                 return result;
1418         logfd = open(log_file, oflags);
1419         if (logfd < 0)
1420                 return 0;
1421         msglen = msg ? strlen(msg) : 0;
1422         committer = git_committer_info(0);
1423         maxlen = strlen(committer) + msglen + 100;
1424         logrec = xmalloc(maxlen);
1425         len = sprintf(logrec, "%s %s %s\n",
1426                       sha1_to_hex(old_sha1),
1427                       sha1_to_hex(new_sha1),
1428                       committer);
1429         if (msglen)
1430                 len += copy_msg(logrec + len - 1, msg) - 1;
1431         written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1432         free(logrec);
1433         if (close(logfd) != 0 || written != len)
1434                 return error("Unable to append to %s", log_file);
1435         return 0;
1438 static int is_branch(const char *refname)
1440         return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1443 int write_ref_sha1(struct ref_lock *lock,
1444         const unsigned char *sha1, const char *logmsg)
1446         static char term = '\n';
1447         struct object *o;
1449         if (!lock)
1450                 return -1;
1451         if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1452                 unlock_ref(lock);
1453                 return 0;
1454         }
1455         o = parse_object(sha1);
1456         if (!o) {
1457                 error("Trying to write ref %s with nonexistent object %s",
1458                         lock->ref_name, sha1_to_hex(sha1));
1459                 unlock_ref(lock);
1460                 return -1;
1461         }
1462         if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1463                 error("Trying to write non-commit object %s to branch %s",
1464                         sha1_to_hex(sha1), lock->ref_name);
1465                 unlock_ref(lock);
1466                 return -1;
1467         }
1468         if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1469             write_in_full(lock->lock_fd, &term, 1) != 1
1470                 || close_ref(lock) < 0) {
1471                 error("Couldn't write %s", lock->lk->filename);
1472                 unlock_ref(lock);
1473                 return -1;
1474         }
1475         invalidate_cached_refs();
1476         if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1477             (strcmp(lock->ref_name, lock->orig_ref_name) &&
1478              log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1479                 unlock_ref(lock);
1480                 return -1;
1481         }
1482         if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1483                 /*
1484                  * Special hack: If a branch is updated directly and HEAD
1485                  * points to it (may happen on the remote side of a push
1486                  * for example) then logically the HEAD reflog should be
1487                  * updated too.
1488                  * A generic solution implies reverse symref information,
1489                  * but finding all symrefs pointing to the given branch
1490                  * would be rather costly for this rare event (the direct
1491                  * update of a branch) to be worth it.  So let's cheat and
1492                  * check with HEAD only which should cover 99% of all usage
1493                  * scenarios (even 100% of the default ones).
1494                  */
1495                 unsigned char head_sha1[20];
1496                 int head_flag;
1497                 const char *head_ref;
1498                 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1499                 if (head_ref && (head_flag & REF_ISSYMREF) &&
1500                     !strcmp(head_ref, lock->ref_name))
1501                         log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1502         }
1503         if (commit_ref(lock)) {
1504                 error("Couldn't set %s", lock->ref_name);
1505                 unlock_ref(lock);
1506                 return -1;
1507         }
1508         unlock_ref(lock);
1509         return 0;
1512 int create_symref(const char *ref_target, const char *refs_heads_master,
1513                   const char *logmsg)
1515         const char *lockpath;
1516         char ref[1000];
1517         int fd, len, written;
1518         char *git_HEAD = git_pathdup("%s", ref_target);
1519         unsigned char old_sha1[20], new_sha1[20];
1521         if (logmsg && read_ref(ref_target, old_sha1))
1522                 hashclr(old_sha1);
1524         if (safe_create_leading_directories(git_HEAD) < 0)
1525                 return error("unable to create directory for %s", git_HEAD);
1527 #ifndef NO_SYMLINK_HEAD
1528         if (prefer_symlink_refs) {
1529                 unlink(git_HEAD);
1530                 if (!symlink(refs_heads_master, git_HEAD))
1531                         goto done;
1532                 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1533         }
1534 #endif
1536         len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1537         if (sizeof(ref) <= len) {
1538                 error("refname too long: %s", refs_heads_master);
1539                 goto error_free_return;
1540         }
1541         lockpath = mkpath("%s.lock", git_HEAD);
1542         fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1543         if (fd < 0) {
1544                 error("Unable to open %s for writing", lockpath);
1545                 goto error_free_return;
1546         }
1547         written = write_in_full(fd, ref, len);
1548         if (close(fd) != 0 || written != len) {
1549                 error("Unable to write to %s", lockpath);
1550                 goto error_unlink_return;
1551         }
1552         if (rename(lockpath, git_HEAD) < 0) {
1553                 error("Unable to create %s", git_HEAD);
1554                 goto error_unlink_return;
1555         }
1556         if (adjust_shared_perm(git_HEAD)) {
1557                 error("Unable to fix permissions on %s", lockpath);
1558         error_unlink_return:
1559                 unlink_or_warn(lockpath);
1560         error_free_return:
1561                 free(git_HEAD);
1562                 return -1;
1563         }
1565 #ifndef NO_SYMLINK_HEAD
1566         done:
1567 #endif
1568         if (logmsg && !read_ref(refs_heads_master, new_sha1))
1569                 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1571         free(git_HEAD);
1572         return 0;
1575 static char *ref_msg(const char *line, const char *endp)
1577         const char *ep;
1578         line += 82;
1579         ep = memchr(line, '\n', endp - line);
1580         if (!ep)
1581                 ep = endp;
1582         return xmemdupz(line, ep - line);
1585 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)
1587         const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1588         char *tz_c;
1589         int logfd, tz, reccnt = 0;
1590         struct stat st;
1591         unsigned long date;
1592         unsigned char logged_sha1[20];
1593         void *log_mapped;
1594         size_t mapsz;
1596         logfile = git_path("logs/%s", ref);
1597         logfd = open(logfile, O_RDONLY, 0);
1598         if (logfd < 0)
1599                 die_errno("Unable to read log '%s'", logfile);
1600         fstat(logfd, &st);
1601         if (!st.st_size)
1602                 die("Log %s is empty.", logfile);
1603         mapsz = xsize_t(st.st_size);
1604         log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1605         logdata = log_mapped;
1606         close(logfd);
1608         lastrec = NULL;
1609         rec = logend = logdata + st.st_size;
1610         while (logdata < rec) {
1611                 reccnt++;
1612                 if (logdata < rec && *(rec-1) == '\n')
1613                         rec--;
1614                 lastgt = NULL;
1615                 while (logdata < rec && *(rec-1) != '\n') {
1616                         rec--;
1617                         if (*rec == '>')
1618                                 lastgt = rec;
1619                 }
1620                 if (!lastgt)
1621                         die("Log %s is corrupt.", logfile);
1622                 date = strtoul(lastgt + 1, &tz_c, 10);
1623                 if (date <= at_time || cnt == 0) {
1624                         tz = strtoul(tz_c, NULL, 10);
1625                         if (msg)
1626                                 *msg = ref_msg(rec, logend);
1627                         if (cutoff_time)
1628                                 *cutoff_time = date;
1629                         if (cutoff_tz)
1630                                 *cutoff_tz = tz;
1631                         if (cutoff_cnt)
1632                                 *cutoff_cnt = reccnt - 1;
1633                         if (lastrec) {
1634                                 if (get_sha1_hex(lastrec, logged_sha1))
1635                                         die("Log %s is corrupt.", logfile);
1636                                 if (get_sha1_hex(rec + 41, sha1))
1637                                         die("Log %s is corrupt.", logfile);
1638                                 if (hashcmp(logged_sha1, sha1)) {
1639                                         warning("Log %s has gap after %s.",
1640                                                 logfile, show_date(date, tz, DATE_RFC2822));
1641                                 }
1642                         }
1643                         else if (date == at_time) {
1644                                 if (get_sha1_hex(rec + 41, sha1))
1645                                         die("Log %s is corrupt.", logfile);
1646                         }
1647                         else {
1648                                 if (get_sha1_hex(rec + 41, logged_sha1))
1649                                         die("Log %s is corrupt.", logfile);
1650                                 if (hashcmp(logged_sha1, sha1)) {
1651                                         warning("Log %s unexpectedly ended on %s.",
1652                                                 logfile, show_date(date, tz, DATE_RFC2822));
1653                                 }
1654                         }
1655                         munmap(log_mapped, mapsz);
1656                         return 0;
1657                 }
1658                 lastrec = rec;
1659                 if (cnt > 0)
1660                         cnt--;
1661         }
1663         rec = logdata;
1664         while (rec < logend && *rec != '>' && *rec != '\n')
1665                 rec++;
1666         if (rec == logend || *rec == '\n')
1667                 die("Log %s is corrupt.", logfile);
1668         date = strtoul(rec + 1, &tz_c, 10);
1669         tz = strtoul(tz_c, NULL, 10);
1670         if (get_sha1_hex(logdata, sha1))
1671                 die("Log %s is corrupt.", logfile);
1672         if (is_null_sha1(sha1)) {
1673                 if (get_sha1_hex(logdata + 41, sha1))
1674                         die("Log %s is corrupt.", logfile);
1675         }
1676         if (msg)
1677                 *msg = ref_msg(logdata, logend);
1678         munmap(log_mapped, mapsz);
1680         if (cutoff_time)
1681                 *cutoff_time = date;
1682         if (cutoff_tz)
1683                 *cutoff_tz = tz;
1684         if (cutoff_cnt)
1685                 *cutoff_cnt = reccnt;
1686         return 1;
1689 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1691         const char *logfile;
1692         FILE *logfp;
1693         struct strbuf sb = STRBUF_INIT;
1694         int ret = 0;
1696         logfile = git_path("logs/%s", ref);
1697         logfp = fopen(logfile, "r");
1698         if (!logfp)
1699                 return -1;
1701         if (ofs) {
1702                 struct stat statbuf;
1703                 if (fstat(fileno(logfp), &statbuf) ||
1704                     statbuf.st_size < ofs ||
1705                     fseek(logfp, -ofs, SEEK_END) ||
1706                     strbuf_getwholeline(&sb, logfp, '\n')) {
1707                         fclose(logfp);
1708                         strbuf_release(&sb);
1709                         return -1;
1710                 }
1711         }
1713         while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1714                 unsigned char osha1[20], nsha1[20];
1715                 char *email_end, *message;
1716                 unsigned long timestamp;
1717                 int tz;
1719                 /* old SP new SP name <email> SP time TAB msg LF */
1720                 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1721                     get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1722                     get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1723                     !(email_end = strchr(sb.buf + 82, '>')) ||
1724                     email_end[1] != ' ' ||
1725                     !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1726                     !message || message[0] != ' ' ||
1727                     (message[1] != '+' && message[1] != '-') ||
1728                     !isdigit(message[2]) || !isdigit(message[3]) ||
1729                     !isdigit(message[4]) || !isdigit(message[5]))
1730                         continue; /* corrupt? */
1731                 email_end[1] = '\0';
1732                 tz = strtol(message + 1, NULL, 10);
1733                 if (message[6] != '\t')
1734                         message += 6;
1735                 else
1736                         message += 7;
1737                 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1738                          cb_data);
1739                 if (ret)
1740                         break;
1741         }
1742         fclose(logfp);
1743         strbuf_release(&sb);
1744         return ret;
1747 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1749         return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1752 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1754         DIR *dir = opendir(git_path("logs/%s", base));
1755         int retval = 0;
1757         if (dir) {
1758                 struct dirent *de;
1759                 int baselen = strlen(base);
1760                 char *log = xmalloc(baselen + 257);
1762                 memcpy(log, base, baselen);
1763                 if (baselen && base[baselen-1] != '/')
1764                         log[baselen++] = '/';
1766                 while ((de = readdir(dir)) != NULL) {
1767                         struct stat st;
1768                         int namelen;
1770                         if (de->d_name[0] == '.')
1771                                 continue;
1772                         namelen = strlen(de->d_name);
1773                         if (namelen > 255)
1774                                 continue;
1775                         if (has_extension(de->d_name, ".lock"))
1776                                 continue;
1777                         memcpy(log + baselen, de->d_name, namelen+1);
1778                         if (stat(git_path("logs/%s", log), &st) < 0)
1779                                 continue;
1780                         if (S_ISDIR(st.st_mode)) {
1781                                 retval = do_for_each_reflog(log, fn, cb_data);
1782                         } else {
1783                                 unsigned char sha1[20];
1784                                 if (!resolve_ref(log, sha1, 0, NULL))
1785                                         retval = error("bad ref for %s", log);
1786                                 else
1787                                         retval = fn(log, sha1, 0, cb_data);
1788                         }
1789                         if (retval)
1790                                 break;
1791                 }
1792                 free(log);
1793                 closedir(dir);
1794         }
1795         else if (*base)
1796                 return errno;
1797         return retval;
1800 int for_each_reflog(each_ref_fn fn, void *cb_data)
1802         return do_for_each_reflog("", fn, cb_data);
1805 int update_ref(const char *action, const char *refname,
1806                 const unsigned char *sha1, const unsigned char *oldval,
1807                 int flags, enum action_on_err onerr)
1809         static struct ref_lock *lock;
1810         lock = lock_any_ref_for_update(refname, oldval, flags);
1811         if (!lock) {
1812                 const char *str = "Cannot lock the ref '%s'.";
1813                 switch (onerr) {
1814                 case MSG_ON_ERR: error(str, refname); break;
1815                 case DIE_ON_ERR: die(str, refname); break;
1816                 case QUIET_ON_ERR: break;
1817                 }
1818                 return 1;
1819         }
1820         if (write_ref_sha1(lock, sha1, action) < 0) {
1821                 const char *str = "Cannot update the ref '%s'.";
1822                 switch (onerr) {
1823                 case MSG_ON_ERR: error(str, refname); break;
1824                 case DIE_ON_ERR: die(str, refname); break;
1825                 case QUIET_ON_ERR: break;
1826                 }
1827                 return 1;
1828         }
1829         return 0;
1832 int ref_exists(char *refname)
1834         unsigned char sha1[20];
1835         return !!resolve_ref(refname, sha1, 1, NULL);
1838 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1840         for ( ; list; list = list->next)
1841                 if (!strcmp(list->name, name))
1842                         return (struct ref *)list;
1843         return NULL;
1846 /*
1847  * generate a format suitable for scanf from a ref_rev_parse_rules
1848  * rule, that is replace the "%.*s" spec with a "%s" spec
1849  */
1850 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1852         char *spec;
1854         spec = strstr(rule, "%.*s");
1855         if (!spec || strstr(spec + 4, "%.*s"))
1856                 die("invalid rule in ref_rev_parse_rules: %s", rule);
1858         /* copy all until spec */
1859         strncpy(scanf_fmt, rule, spec - rule);
1860         scanf_fmt[spec - rule] = '\0';
1861         /* copy new spec */
1862         strcat(scanf_fmt, "%s");
1863         /* copy remaining rule */
1864         strcat(scanf_fmt, spec + 4);
1866         return;
1869 char *shorten_unambiguous_ref(const char *ref, int strict)
1871         int i;
1872         static char **scanf_fmts;
1873         static int nr_rules;
1874         char *short_name;
1876         /* pre generate scanf formats from ref_rev_parse_rules[] */
1877         if (!nr_rules) {
1878                 size_t total_len = 0;
1880                 /* the rule list is NULL terminated, count them first */
1881                 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1882                         /* no +1 because strlen("%s") < strlen("%.*s") */
1883                         total_len += strlen(ref_rev_parse_rules[nr_rules]);
1885                 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1887                 total_len = 0;
1888                 for (i = 0; i < nr_rules; i++) {
1889                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1890                                         + total_len;
1891                         gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1892                         total_len += strlen(ref_rev_parse_rules[i]);
1893                 }
1894         }
1896         /* bail out if there are no rules */
1897         if (!nr_rules)
1898                 return xstrdup(ref);
1900         /* buffer for scanf result, at most ref must fit */
1901         short_name = xstrdup(ref);
1903         /* skip first rule, it will always match */
1904         for (i = nr_rules - 1; i > 0 ; --i) {
1905                 int j;
1906                 int rules_to_fail = i;
1907                 int short_name_len;
1909                 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1910                         continue;
1912                 short_name_len = strlen(short_name);
1914                 /*
1915                  * in strict mode, all (except the matched one) rules
1916                  * must fail to resolve to a valid non-ambiguous ref
1917                  */
1918                 if (strict)
1919                         rules_to_fail = nr_rules;
1921                 /*
1922                  * check if the short name resolves to a valid ref,
1923                  * but use only rules prior to the matched one
1924                  */
1925                 for (j = 0; j < rules_to_fail; j++) {
1926                         const char *rule = ref_rev_parse_rules[j];
1927                         unsigned char short_objectname[20];
1928                         char refname[PATH_MAX];
1930                         /* skip matched rule */
1931                         if (i == j)
1932                                 continue;
1934                         /*
1935                          * the short name is ambiguous, if it resolves
1936                          * (with this previous rule) to a valid ref
1937                          * read_ref() returns 0 on success
1938                          */
1939                         mksnpath(refname, sizeof(refname),
1940                                  rule, short_name_len, short_name);
1941                         if (!read_ref(refname, short_objectname))
1942                                 break;
1943                 }
1945                 /*
1946                  * short name is non-ambiguous if all previous rules
1947                  * haven't resolved to a valid ref
1948                  */
1949                 if (j == rules_to_fail)
1950                         return short_name;
1951         }
1953         free(short_name);
1954         return xstrdup(ref);