Merge branch 'fc/remote-helper-refmap'
[git] / refs.c
1 #include "cache.h"
2 #include "refs.h"
3 #include "object.h"
4 #include "tag.h"
5 #include "dir.h"
6 #include "string-list.h"
7
8 /*
9  * Make sure "ref" is something reasonable to have under ".git/refs/";
10  * We do not like it if:
11  *
12  * - any path component of it begins with ".", or
13  * - it has double dots "..", or
14  * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
15  * - it ends with a "/".
16  * - it ends with ".lock"
17  * - it contains a "\" (backslash)
18  */
19
20 /* Return true iff ch is not allowed in reference names. */
21 static inline int bad_ref_char(int ch)
22 {
23         if (((unsigned) ch) <= ' ' || ch == 0x7f ||
24             ch == '~' || ch == '^' || ch == ':' || ch == '\\')
25                 return 1;
26         /* 2.13 Pattern Matching Notation */
27         if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
28                 return 1;
29         return 0;
30 }
31
32 /*
33  * Try to read one refname component from the front of refname.  Return
34  * the length of the component found, or -1 if the component is not
35  * legal.
36  */
37 static int check_refname_component(const char *refname, int flags)
38 {
39         const char *cp;
40         char last = '\0';
41
42         for (cp = refname; ; cp++) {
43                 char ch = *cp;
44                 if (ch == '\0' || ch == '/')
45                         break;
46                 if (bad_ref_char(ch))
47                         return -1; /* Illegal character in refname. */
48                 if (last == '.' && ch == '.')
49                         return -1; /* Refname contains "..". */
50                 if (last == '@' && ch == '{')
51                         return -1; /* Refname contains "@{". */
52                 last = ch;
53         }
54         if (cp == refname)
55                 return 0; /* Component has zero length. */
56         if (refname[0] == '.') {
57                 if (!(flags & REFNAME_DOT_COMPONENT))
58                         return -1; /* Component starts with '.'. */
59                 /*
60                  * Even if leading dots are allowed, don't allow "."
61                  * as a component (".." is prevented by a rule above).
62                  */
63                 if (refname[1] == '\0')
64                         return -1; /* Component equals ".". */
65         }
66         if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
67                 return -1; /* Refname ends with ".lock". */
68         return cp - refname;
69 }
70
71 int check_refname_format(const char *refname, int flags)
72 {
73         int component_len, component_count = 0;
74
75         if (!strcmp(refname, "@"))
76                 /* Refname is a single character '@'. */
77                 return -1;
78
79         while (1) {
80                 /* We are at the start of a path component. */
81                 component_len = check_refname_component(refname, flags);
82                 if (component_len <= 0) {
83                         if ((flags & REFNAME_REFSPEC_PATTERN) &&
84                                         refname[0] == '*' &&
85                                         (refname[1] == '\0' || refname[1] == '/')) {
86                                 /* Accept one wildcard as a full refname component. */
87                                 flags &= ~REFNAME_REFSPEC_PATTERN;
88                                 component_len = 1;
89                         } else {
90                                 return -1;
91                         }
92                 }
93                 component_count++;
94                 if (refname[component_len] == '\0')
95                         break;
96                 /* Skip to next component. */
97                 refname += component_len + 1;
98         }
99
100         if (refname[component_len - 1] == '.')
101                 return -1; /* Refname ends with '.'. */
102         if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
103                 return -1; /* Refname has only one component. */
104         return 0;
105 }
106
107 struct ref_entry;
108
109 /*
110  * Information used (along with the information in ref_entry) to
111  * describe a single cached reference.  This data structure only
112  * occurs embedded in a union in struct ref_entry, and only when
113  * (ref_entry->flag & REF_DIR) is zero.
114  */
115 struct ref_value {
116         /*
117          * The name of the object to which this reference resolves
118          * (which may be a tag object).  If REF_ISBROKEN, this is
119          * null.  If REF_ISSYMREF, then this is the name of the object
120          * referred to by the last reference in the symlink chain.
121          */
122         unsigned char sha1[20];
123
124         /*
125          * If REF_KNOWS_PEELED, then this field holds the peeled value
126          * of this reference, or null if the reference is known not to
127          * be peelable.  See the documentation for peel_ref() for an
128          * exact definition of "peelable".
129          */
130         unsigned char peeled[20];
131 };
132
133 struct ref_cache;
134
135 /*
136  * Information used (along with the information in ref_entry) to
137  * describe a level in the hierarchy of references.  This data
138  * structure only occurs embedded in a union in struct ref_entry, and
139  * only when (ref_entry.flag & REF_DIR) is set.  In that case,
140  * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
141  * in the directory have already been read:
142  *
143  *     (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
144  *         or packed references, already read.
145  *
146  *     (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
147  *         references that hasn't been read yet (nor has any of its
148  *         subdirectories).
149  *
150  * Entries within a directory are stored within a growable array of
151  * pointers to ref_entries (entries, nr, alloc).  Entries 0 <= i <
152  * sorted are sorted by their component name in strcmp() order and the
153  * remaining entries are unsorted.
154  *
155  * Loose references are read lazily, one directory at a time.  When a
156  * directory of loose references is read, then all of the references
157  * in that directory are stored, and REF_INCOMPLETE stubs are created
158  * for any subdirectories, but the subdirectories themselves are not
159  * read.  The reading is triggered by get_ref_dir().
160  */
161 struct ref_dir {
162         int nr, alloc;
163
164         /*
165          * Entries with index 0 <= i < sorted are sorted by name.  New
166          * entries are appended to the list unsorted, and are sorted
167          * only when required; thus we avoid the need to sort the list
168          * after the addition of every reference.
169          */
170         int sorted;
171
172         /* A pointer to the ref_cache that contains this ref_dir. */
173         struct ref_cache *ref_cache;
174
175         struct ref_entry **entries;
176 };
177
178 /*
179  * Bit values for ref_entry::flag.  REF_ISSYMREF=0x01,
180  * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
181  * refs.h.
182  */
183
184 /*
185  * The field ref_entry->u.value.peeled of this value entry contains
186  * the correct peeled value for the reference, which might be
187  * null_sha1 if the reference is not a tag or if it is broken.
188  */
189 #define REF_KNOWS_PEELED 0x08
190
191 /* ref_entry represents a directory of references */
192 #define REF_DIR 0x10
193
194 /*
195  * Entry has not yet been read from disk (used only for REF_DIR
196  * entries representing loose references)
197  */
198 #define REF_INCOMPLETE 0x20
199
200 /*
201  * A ref_entry represents either a reference or a "subdirectory" of
202  * references.
203  *
204  * Each directory in the reference namespace is represented by a
205  * ref_entry with (flags & REF_DIR) set and containing a subdir member
206  * that holds the entries in that directory that have been read so
207  * far.  If (flags & REF_INCOMPLETE) is set, then the directory and
208  * its subdirectories haven't been read yet.  REF_INCOMPLETE is only
209  * used for loose reference directories.
210  *
211  * References are represented by a ref_entry with (flags & REF_DIR)
212  * unset and a value member that describes the reference's value.  The
213  * flag member is at the ref_entry level, but it is also needed to
214  * interpret the contents of the value field (in other words, a
215  * ref_value object is not very much use without the enclosing
216  * ref_entry).
217  *
218  * Reference names cannot end with slash and directories' names are
219  * always stored with a trailing slash (except for the top-level
220  * directory, which is always denoted by "").  This has two nice
221  * consequences: (1) when the entries in each subdir are sorted
222  * lexicographically by name (as they usually are), the references in
223  * a whole tree can be generated in lexicographic order by traversing
224  * the tree in left-to-right, depth-first order; (2) the names of
225  * references and subdirectories cannot conflict, and therefore the
226  * presence of an empty subdirectory does not block the creation of a
227  * similarly-named reference.  (The fact that reference names with the
228  * same leading components can conflict *with each other* is a
229  * separate issue that is regulated by is_refname_available().)
230  *
231  * Please note that the name field contains the fully-qualified
232  * reference (or subdirectory) name.  Space could be saved by only
233  * storing the relative names.  But that would require the full names
234  * to be generated on the fly when iterating in do_for_each_ref(), and
235  * would break callback functions, who have always been able to assume
236  * that the name strings that they are passed will not be freed during
237  * the iteration.
238  */
239 struct ref_entry {
240         unsigned char flag; /* ISSYMREF? ISPACKED? */
241         union {
242                 struct ref_value value; /* if not (flags&REF_DIR) */
243                 struct ref_dir subdir; /* if (flags&REF_DIR) */
244         } u;
245         /*
246          * The full name of the reference (e.g., "refs/heads/master")
247          * or the full name of the directory with a trailing slash
248          * (e.g., "refs/heads/"):
249          */
250         char name[FLEX_ARRAY];
251 };
252
253 static void read_loose_refs(const char *dirname, struct ref_dir *dir);
254
255 static struct ref_dir *get_ref_dir(struct ref_entry *entry)
256 {
257         struct ref_dir *dir;
258         assert(entry->flag & REF_DIR);
259         dir = &entry->u.subdir;
260         if (entry->flag & REF_INCOMPLETE) {
261                 read_loose_refs(entry->name, dir);
262                 entry->flag &= ~REF_INCOMPLETE;
263         }
264         return dir;
265 }
266
267 static struct ref_entry *create_ref_entry(const char *refname,
268                                           const unsigned char *sha1, int flag,
269                                           int check_name)
270 {
271         int len;
272         struct ref_entry *ref;
273
274         if (check_name &&
275             check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
276                 die("Reference has invalid format: '%s'", refname);
277         len = strlen(refname) + 1;
278         ref = xmalloc(sizeof(struct ref_entry) + len);
279         hashcpy(ref->u.value.sha1, sha1);
280         hashclr(ref->u.value.peeled);
281         memcpy(ref->name, refname, len);
282         ref->flag = flag;
283         return ref;
284 }
285
286 static void clear_ref_dir(struct ref_dir *dir);
287
288 static void free_ref_entry(struct ref_entry *entry)
289 {
290         if (entry->flag & REF_DIR) {
291                 /*
292                  * Do not use get_ref_dir() here, as that might
293                  * trigger the reading of loose refs.
294                  */
295                 clear_ref_dir(&entry->u.subdir);
296         }
297         free(entry);
298 }
299
300 /*
301  * Add a ref_entry to the end of dir (unsorted).  Entry is always
302  * stored directly in dir; no recursion into subdirectories is
303  * done.
304  */
305 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
306 {
307         ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
308         dir->entries[dir->nr++] = entry;
309         /* optimize for the case that entries are added in order */
310         if (dir->nr == 1 ||
311             (dir->nr == dir->sorted + 1 &&
312              strcmp(dir->entries[dir->nr - 2]->name,
313                     dir->entries[dir->nr - 1]->name) < 0))
314                 dir->sorted = dir->nr;
315 }
316
317 /*
318  * Clear and free all entries in dir, recursively.
319  */
320 static void clear_ref_dir(struct ref_dir *dir)
321 {
322         int i;
323         for (i = 0; i < dir->nr; i++)
324                 free_ref_entry(dir->entries[i]);
325         free(dir->entries);
326         dir->sorted = dir->nr = dir->alloc = 0;
327         dir->entries = NULL;
328 }
329
330 /*
331  * Create a struct ref_entry object for the specified dirname.
332  * dirname is the name of the directory with a trailing slash (e.g.,
333  * "refs/heads/") or "" for the top-level directory.
334  */
335 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
336                                           const char *dirname, size_t len,
337                                           int incomplete)
338 {
339         struct ref_entry *direntry;
340         direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
341         memcpy(direntry->name, dirname, len);
342         direntry->name[len] = '\0';
343         direntry->u.subdir.ref_cache = ref_cache;
344         direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
345         return direntry;
346 }
347
348 static int ref_entry_cmp(const void *a, const void *b)
349 {
350         struct ref_entry *one = *(struct ref_entry **)a;
351         struct ref_entry *two = *(struct ref_entry **)b;
352         return strcmp(one->name, two->name);
353 }
354
355 static void sort_ref_dir(struct ref_dir *dir);
356
357 struct string_slice {
358         size_t len;
359         const char *str;
360 };
361
362 static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
363 {
364         const struct string_slice *key = key_;
365         const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
366         int cmp = strncmp(key->str, ent->name, key->len);
367         if (cmp)
368                 return cmp;
369         return '\0' - (unsigned char)ent->name[key->len];
370 }
371
372 /*
373  * Return the index of the entry with the given refname from the
374  * ref_dir (non-recursively), sorting dir if necessary.  Return -1 if
375  * no such entry is found.  dir must already be complete.
376  */
377 static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
378 {
379         struct ref_entry **r;
380         struct string_slice key;
381
382         if (refname == NULL || !dir->nr)
383                 return -1;
384
385         sort_ref_dir(dir);
386         key.len = len;
387         key.str = refname;
388         r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
389                     ref_entry_cmp_sslice);
390
391         if (r == NULL)
392                 return -1;
393
394         return r - dir->entries;
395 }
396
397 /*
398  * Search for a directory entry directly within dir (without
399  * recursing).  Sort dir if necessary.  subdirname must be a directory
400  * name (i.e., end in '/').  If mkdir is set, then create the
401  * directory if it is missing; otherwise, return NULL if the desired
402  * directory cannot be found.  dir must already be complete.
403  */
404 static struct ref_dir *search_for_subdir(struct ref_dir *dir,
405                                          const char *subdirname, size_t len,
406                                          int mkdir)
407 {
408         int entry_index = search_ref_dir(dir, subdirname, len);
409         struct ref_entry *entry;
410         if (entry_index == -1) {
411                 if (!mkdir)
412                         return NULL;
413                 /*
414                  * Since dir is complete, the absence of a subdir
415                  * means that the subdir really doesn't exist;
416                  * therefore, create an empty record for it but mark
417                  * the record complete.
418                  */
419                 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
420                 add_entry_to_dir(dir, entry);
421         } else {
422                 entry = dir->entries[entry_index];
423         }
424         return get_ref_dir(entry);
425 }
426
427 /*
428  * If refname is a reference name, find the ref_dir within the dir
429  * tree that should hold refname.  If refname is a directory name
430  * (i.e., ends in '/'), then return that ref_dir itself.  dir must
431  * represent the top-level directory and must already be complete.
432  * Sort ref_dirs and recurse into subdirectories as necessary.  If
433  * mkdir is set, then create any missing directories; otherwise,
434  * return NULL if the desired directory cannot be found.
435  */
436 static struct ref_dir *find_containing_dir(struct ref_dir *dir,
437                                            const char *refname, int mkdir)
438 {
439         const char *slash;
440         for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
441                 size_t dirnamelen = slash - refname + 1;
442                 struct ref_dir *subdir;
443                 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
444                 if (!subdir) {
445                         dir = NULL;
446                         break;
447                 }
448                 dir = subdir;
449         }
450
451         return dir;
452 }
453
454 /*
455  * Find the value entry with the given name in dir, sorting ref_dirs
456  * and recursing into subdirectories as necessary.  If the name is not
457  * found or it corresponds to a directory entry, return NULL.
458  */
459 static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
460 {
461         int entry_index;
462         struct ref_entry *entry;
463         dir = find_containing_dir(dir, refname, 0);
464         if (!dir)
465                 return NULL;
466         entry_index = search_ref_dir(dir, refname, strlen(refname));
467         if (entry_index == -1)
468                 return NULL;
469         entry = dir->entries[entry_index];
470         return (entry->flag & REF_DIR) ? NULL : entry;
471 }
472
473 /*
474  * Remove the entry with the given name from dir, recursing into
475  * subdirectories as necessary.  If refname is the name of a directory
476  * (i.e., ends with '/'), then remove the directory and its contents.
477  * If the removal was successful, return the number of entries
478  * remaining in the directory entry that contained the deleted entry.
479  * If the name was not found, return -1.  Please note that this
480  * function only deletes the entry from the cache; it does not delete
481  * it from the filesystem or ensure that other cache entries (which
482  * might be symbolic references to the removed entry) are updated.
483  * Nor does it remove any containing dir entries that might be made
484  * empty by the removal.  dir must represent the top-level directory
485  * and must already be complete.
486  */
487 static int remove_entry(struct ref_dir *dir, const char *refname)
488 {
489         int refname_len = strlen(refname);
490         int entry_index;
491         struct ref_entry *entry;
492         int is_dir = refname[refname_len - 1] == '/';
493         if (is_dir) {
494                 /*
495                  * refname represents a reference directory.  Remove
496                  * the trailing slash; otherwise we will get the
497                  * directory *representing* refname rather than the
498                  * one *containing* it.
499                  */
500                 char *dirname = xmemdupz(refname, refname_len - 1);
501                 dir = find_containing_dir(dir, dirname, 0);
502                 free(dirname);
503         } else {
504                 dir = find_containing_dir(dir, refname, 0);
505         }
506         if (!dir)
507                 return -1;
508         entry_index = search_ref_dir(dir, refname, refname_len);
509         if (entry_index == -1)
510                 return -1;
511         entry = dir->entries[entry_index];
512
513         memmove(&dir->entries[entry_index],
514                 &dir->entries[entry_index + 1],
515                 (dir->nr - entry_index - 1) * sizeof(*dir->entries)
516                 );
517         dir->nr--;
518         if (dir->sorted > entry_index)
519                 dir->sorted--;
520         free_ref_entry(entry);
521         return dir->nr;
522 }
523
524 /*
525  * Add a ref_entry to the ref_dir (unsorted), recursing into
526  * subdirectories as necessary.  dir must represent the top-level
527  * directory.  Return 0 on success.
528  */
529 static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
530 {
531         dir = find_containing_dir(dir, ref->name, 1);
532         if (!dir)
533                 return -1;
534         add_entry_to_dir(dir, ref);
535         return 0;
536 }
537
538 /*
539  * Emit a warning and return true iff ref1 and ref2 have the same name
540  * and the same sha1.  Die if they have the same name but different
541  * sha1s.
542  */
543 static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
544 {
545         if (strcmp(ref1->name, ref2->name))
546                 return 0;
547
548         /* Duplicate name; make sure that they don't conflict: */
549
550         if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
551                 /* This is impossible by construction */
552                 die("Reference directory conflict: %s", ref1->name);
553
554         if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
555                 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
556
557         warning("Duplicated ref: %s", ref1->name);
558         return 1;
559 }
560
561 /*
562  * Sort the entries in dir non-recursively (if they are not already
563  * sorted) and remove any duplicate entries.
564  */
565 static void sort_ref_dir(struct ref_dir *dir)
566 {
567         int i, j;
568         struct ref_entry *last = NULL;
569
570         /*
571          * This check also prevents passing a zero-length array to qsort(),
572          * which is a problem on some platforms.
573          */
574         if (dir->sorted == dir->nr)
575                 return;
576
577         qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
578
579         /* Remove any duplicates: */
580         for (i = 0, j = 0; j < dir->nr; j++) {
581                 struct ref_entry *entry = dir->entries[j];
582                 if (last && is_dup_ref(last, entry))
583                         free_ref_entry(entry);
584                 else
585                         last = dir->entries[i++] = entry;
586         }
587         dir->sorted = dir->nr = i;
588 }
589
590 /* Include broken references in a do_for_each_ref*() iteration: */
591 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
592
593 /*
594  * Return true iff the reference described by entry can be resolved to
595  * an object in the database.  Emit a warning if the referred-to
596  * object does not exist.
597  */
598 static int ref_resolves_to_object(struct ref_entry *entry)
599 {
600         if (entry->flag & REF_ISBROKEN)
601                 return 0;
602         if (!has_sha1_file(entry->u.value.sha1)) {
603                 error("%s does not point to a valid object!", entry->name);
604                 return 0;
605         }
606         return 1;
607 }
608
609 /*
610  * current_ref is a performance hack: when iterating over references
611  * using the for_each_ref*() functions, current_ref is set to the
612  * current reference's entry before calling the callback function.  If
613  * the callback function calls peel_ref(), then peel_ref() first
614  * checks whether the reference to be peeled is the current reference
615  * (it usually is) and if so, returns that reference's peeled version
616  * if it is available.  This avoids a refname lookup in a common case.
617  */
618 static struct ref_entry *current_ref;
619
620 typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);
621
622 struct ref_entry_cb {
623         const char *base;
624         int trim;
625         int flags;
626         each_ref_fn *fn;
627         void *cb_data;
628 };
629
630 /*
631  * Handle one reference in a do_for_each_ref*()-style iteration,
632  * calling an each_ref_fn for each entry.
633  */
634 static int do_one_ref(struct ref_entry *entry, void *cb_data)
635 {
636         struct ref_entry_cb *data = cb_data;
637         struct ref_entry *old_current_ref;
638         int retval;
639
640         if (!starts_with(entry->name, data->base))
641                 return 0;
642
643         if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
644               !ref_resolves_to_object(entry))
645                 return 0;
646
647         /* Store the old value, in case this is a recursive call: */
648         old_current_ref = current_ref;
649         current_ref = entry;
650         retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
651                           entry->flag, data->cb_data);
652         current_ref = old_current_ref;
653         return retval;
654 }
655
656 /*
657  * Call fn for each reference in dir that has index in the range
658  * offset <= index < dir->nr.  Recurse into subdirectories that are in
659  * that index range, sorting them before iterating.  This function
660  * does not sort dir itself; it should be sorted beforehand.  fn is
661  * called for all references, including broken ones.
662  */
663 static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
664                                     each_ref_entry_fn fn, void *cb_data)
665 {
666         int i;
667         assert(dir->sorted == dir->nr);
668         for (i = offset; i < dir->nr; i++) {
669                 struct ref_entry *entry = dir->entries[i];
670                 int retval;
671                 if (entry->flag & REF_DIR) {
672                         struct ref_dir *subdir = get_ref_dir(entry);
673                         sort_ref_dir(subdir);
674                         retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
675                 } else {
676                         retval = fn(entry, cb_data);
677                 }
678                 if (retval)
679                         return retval;
680         }
681         return 0;
682 }
683
684 /*
685  * Call fn for each reference in the union of dir1 and dir2, in order
686  * by refname.  Recurse into subdirectories.  If a value entry appears
687  * in both dir1 and dir2, then only process the version that is in
688  * dir2.  The input dirs must already be sorted, but subdirs will be
689  * sorted as needed.  fn is called for all references, including
690  * broken ones.
691  */
692 static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
693                                      struct ref_dir *dir2,
694                                      each_ref_entry_fn fn, void *cb_data)
695 {
696         int retval;
697         int i1 = 0, i2 = 0;
698
699         assert(dir1->sorted == dir1->nr);
700         assert(dir2->sorted == dir2->nr);
701         while (1) {
702                 struct ref_entry *e1, *e2;
703                 int cmp;
704                 if (i1 == dir1->nr) {
705                         return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
706                 }
707                 if (i2 == dir2->nr) {
708                         return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
709                 }
710                 e1 = dir1->entries[i1];
711                 e2 = dir2->entries[i2];
712                 cmp = strcmp(e1->name, e2->name);
713                 if (cmp == 0) {
714                         if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
715                                 /* Both are directories; descend them in parallel. */
716                                 struct ref_dir *subdir1 = get_ref_dir(e1);
717                                 struct ref_dir *subdir2 = get_ref_dir(e2);
718                                 sort_ref_dir(subdir1);
719                                 sort_ref_dir(subdir2);
720                                 retval = do_for_each_entry_in_dirs(
721                                                 subdir1, subdir2, fn, cb_data);
722                                 i1++;
723                                 i2++;
724                         } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
725                                 /* Both are references; ignore the one from dir1. */
726                                 retval = fn(e2, cb_data);
727                                 i1++;
728                                 i2++;
729                         } else {
730                                 die("conflict between reference and directory: %s",
731                                     e1->name);
732                         }
733                 } else {
734                         struct ref_entry *e;
735                         if (cmp < 0) {
736                                 e = e1;
737                                 i1++;
738                         } else {
739                                 e = e2;
740                                 i2++;
741                         }
742                         if (e->flag & REF_DIR) {
743                                 struct ref_dir *subdir = get_ref_dir(e);
744                                 sort_ref_dir(subdir);
745                                 retval = do_for_each_entry_in_dir(
746                                                 subdir, 0, fn, cb_data);
747                         } else {
748                                 retval = fn(e, cb_data);
749                         }
750                 }
751                 if (retval)
752                         return retval;
753         }
754 }
755
756 /*
757  * Load all of the refs from the dir into our in-memory cache. The hard work
758  * of loading loose refs is done by get_ref_dir(), so we just need to recurse
759  * through all of the sub-directories. We do not even need to care about
760  * sorting, as traversal order does not matter to us.
761  */
762 static void prime_ref_dir(struct ref_dir *dir)
763 {
764         int i;
765         for (i = 0; i < dir->nr; i++) {
766                 struct ref_entry *entry = dir->entries[i];
767                 if (entry->flag & REF_DIR)
768                         prime_ref_dir(get_ref_dir(entry));
769         }
770 }
771 /*
772  * Return true iff refname1 and refname2 conflict with each other.
773  * Two reference names conflict if one of them exactly matches the
774  * leading components of the other; e.g., "foo/bar" conflicts with
775  * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
776  * "foo/barbados".
777  */
778 static int names_conflict(const char *refname1, const char *refname2)
779 {
780         for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
781                 ;
782         return (*refname1 == '\0' && *refname2 == '/')
783                 || (*refname1 == '/' && *refname2 == '\0');
784 }
785
786 struct name_conflict_cb {
787         const char *refname;
788         const char *oldrefname;
789         const char *conflicting_refname;
790 };
791
792 static int name_conflict_fn(struct ref_entry *entry, void *cb_data)
793 {
794         struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
795         if (data->oldrefname && !strcmp(data->oldrefname, entry->name))
796                 return 0;
797         if (names_conflict(data->refname, entry->name)) {
798                 data->conflicting_refname = entry->name;
799                 return 1;
800         }
801         return 0;
802 }
803
804 /*
805  * Return true iff a reference named refname could be created without
806  * conflicting with the name of an existing reference in dir.  If
807  * oldrefname is non-NULL, ignore potential conflicts with oldrefname
808  * (e.g., because oldrefname is scheduled for deletion in the same
809  * operation).
810  */
811 static int is_refname_available(const char *refname, const char *oldrefname,
812                                 struct ref_dir *dir)
813 {
814         struct name_conflict_cb data;
815         data.refname = refname;
816         data.oldrefname = oldrefname;
817         data.conflicting_refname = NULL;
818
819         sort_ref_dir(dir);
820         if (do_for_each_entry_in_dir(dir, 0, name_conflict_fn, &data)) {
821                 error("'%s' exists; cannot create '%s'",
822                       data.conflicting_refname, refname);
823                 return 0;
824         }
825         return 1;
826 }
827
828 struct packed_ref_cache {
829         struct ref_entry *root;
830
831         /*
832          * Count of references to the data structure in this instance,
833          * including the pointer from ref_cache::packed if any.  The
834          * data will not be freed as long as the reference count is
835          * nonzero.
836          */
837         unsigned int referrers;
838
839         /*
840          * Iff the packed-refs file associated with this instance is
841          * currently locked for writing, this points at the associated
842          * lock (which is owned by somebody else).  The referrer count
843          * is also incremented when the file is locked and decremented
844          * when it is unlocked.
845          */
846         struct lock_file *lock;
847
848         /* The metadata from when this packed-refs cache was read */
849         struct stat_validity validity;
850 };
851
852 /*
853  * Future: need to be in "struct repository"
854  * when doing a full libification.
855  */
856 static struct ref_cache {
857         struct ref_cache *next;
858         struct ref_entry *loose;
859         struct packed_ref_cache *packed;
860         /*
861          * The submodule name, or "" for the main repo.  We allocate
862          * length 1 rather than FLEX_ARRAY so that the main ref_cache
863          * is initialized correctly.
864          */
865         char name[1];
866 } ref_cache, *submodule_ref_caches;
867
868 /* Lock used for the main packed-refs file: */
869 static struct lock_file packlock;
870
871 /*
872  * Increment the reference count of *packed_refs.
873  */
874 static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
875 {
876         packed_refs->referrers++;
877 }
878
879 /*
880  * Decrease the reference count of *packed_refs.  If it goes to zero,
881  * free *packed_refs and return true; otherwise return false.
882  */
883 static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
884 {
885         if (!--packed_refs->referrers) {
886                 free_ref_entry(packed_refs->root);
887                 stat_validity_clear(&packed_refs->validity);
888                 free(packed_refs);
889                 return 1;
890         } else {
891                 return 0;
892         }
893 }
894
895 static void clear_packed_ref_cache(struct ref_cache *refs)
896 {
897         if (refs->packed) {
898                 struct packed_ref_cache *packed_refs = refs->packed;
899
900                 if (packed_refs->lock)
901                         die("internal error: packed-ref cache cleared while locked");
902                 refs->packed = NULL;
903                 release_packed_ref_cache(packed_refs);
904         }
905 }
906
907 static void clear_loose_ref_cache(struct ref_cache *refs)
908 {
909         if (refs->loose) {
910                 free_ref_entry(refs->loose);
911                 refs->loose = NULL;
912         }
913 }
914
915 static struct ref_cache *create_ref_cache(const char *submodule)
916 {
917         int len;
918         struct ref_cache *refs;
919         if (!submodule)
920                 submodule = "";
921         len = strlen(submodule) + 1;
922         refs = xcalloc(1, sizeof(struct ref_cache) + len);
923         memcpy(refs->name, submodule, len);
924         return refs;
925 }
926
927 /*
928  * Return a pointer to a ref_cache for the specified submodule. For
929  * the main repository, use submodule==NULL. The returned structure
930  * will be allocated and initialized but not necessarily populated; it
931  * should not be freed.
932  */
933 static struct ref_cache *get_ref_cache(const char *submodule)
934 {
935         struct ref_cache *refs;
936
937         if (!submodule || !*submodule)
938                 return &ref_cache;
939
940         for (refs = submodule_ref_caches; refs; refs = refs->next)
941                 if (!strcmp(submodule, refs->name))
942                         return refs;
943
944         refs = create_ref_cache(submodule);
945         refs->next = submodule_ref_caches;
946         submodule_ref_caches = refs;
947         return refs;
948 }
949
950 /* The length of a peeled reference line in packed-refs, including EOL: */
951 #define PEELED_LINE_LENGTH 42
952
953 /*
954  * The packed-refs header line that we write out.  Perhaps other
955  * traits will be added later.  The trailing space is required.
956  */
957 static const char PACKED_REFS_HEADER[] =
958         "# pack-refs with: peeled fully-peeled \n";
959
960 /*
961  * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
962  * Return a pointer to the refname within the line (null-terminated),
963  * or NULL if there was a problem.
964  */
965 static const char *parse_ref_line(char *line, unsigned char *sha1)
966 {
967         /*
968          * 42: the answer to everything.
969          *
970          * In this case, it happens to be the answer to
971          *  40 (length of sha1 hex representation)
972          *  +1 (space in between hex and name)
973          *  +1 (newline at the end of the line)
974          */
975         int len = strlen(line) - 42;
976
977         if (len <= 0)
978                 return NULL;
979         if (get_sha1_hex(line, sha1) < 0)
980                 return NULL;
981         if (!isspace(line[40]))
982                 return NULL;
983         line += 41;
984         if (isspace(*line))
985                 return NULL;
986         if (line[len] != '\n')
987                 return NULL;
988         line[len] = 0;
989
990         return line;
991 }
992
993 /*
994  * Read f, which is a packed-refs file, into dir.
995  *
996  * A comment line of the form "# pack-refs with: " may contain zero or
997  * more traits. We interpret the traits as follows:
998  *
999  *   No traits:
1000  *
1001  *      Probably no references are peeled. But if the file contains a
1002  *      peeled value for a reference, we will use it.
1003  *
1004  *   peeled:
1005  *
1006  *      References under "refs/tags/", if they *can* be peeled, *are*
1007  *      peeled in this file. References outside of "refs/tags/" are
1008  *      probably not peeled even if they could have been, but if we find
1009  *      a peeled value for such a reference we will use it.
1010  *
1011  *   fully-peeled:
1012  *
1013  *      All references in the file that can be peeled are peeled.
1014  *      Inversely (and this is more important), any references in the
1015  *      file for which no peeled value is recorded is not peelable. This
1016  *      trait should typically be written alongside "peeled" for
1017  *      compatibility with older clients, but we do not require it
1018  *      (i.e., "peeled" is a no-op if "fully-peeled" is set).
1019  */
1020 static void read_packed_refs(FILE *f, struct ref_dir *dir)
1021 {
1022         struct ref_entry *last = NULL;
1023         char refline[PATH_MAX];
1024         enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1025
1026         while (fgets(refline, sizeof(refline), f)) {
1027                 unsigned char sha1[20];
1028                 const char *refname;
1029                 static const char header[] = "# pack-refs with:";
1030
1031                 if (!strncmp(refline, header, sizeof(header)-1)) {
1032                         const char *traits = refline + sizeof(header) - 1;
1033                         if (strstr(traits, " fully-peeled "))
1034                                 peeled = PEELED_FULLY;
1035                         else if (strstr(traits, " peeled "))
1036                                 peeled = PEELED_TAGS;
1037                         /* perhaps other traits later as well */
1038                         continue;
1039                 }
1040
1041                 refname = parse_ref_line(refline, sha1);
1042                 if (refname) {
1043                         last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
1044                         if (peeled == PEELED_FULLY ||
1045                             (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1046                                 last->flag |= REF_KNOWS_PEELED;
1047                         add_ref(dir, last);
1048                         continue;
1049                 }
1050                 if (last &&
1051                     refline[0] == '^' &&
1052                     strlen(refline) == PEELED_LINE_LENGTH &&
1053                     refline[PEELED_LINE_LENGTH - 1] == '\n' &&
1054                     !get_sha1_hex(refline + 1, sha1)) {
1055                         hashcpy(last->u.value.peeled, sha1);
1056                         /*
1057                          * Regardless of what the file header said,
1058                          * we definitely know the value of *this*
1059                          * reference:
1060                          */
1061                         last->flag |= REF_KNOWS_PEELED;
1062                 }
1063         }
1064 }
1065
1066 /*
1067  * Get the packed_ref_cache for the specified ref_cache, creating it
1068  * if necessary.
1069  */
1070 static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1071 {
1072         const char *packed_refs_file;
1073
1074         if (*refs->name)
1075                 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
1076         else
1077                 packed_refs_file = git_path("packed-refs");
1078
1079         if (refs->packed &&
1080             !stat_validity_check(&refs->packed->validity, packed_refs_file))
1081                 clear_packed_ref_cache(refs);
1082
1083         if (!refs->packed) {
1084                 FILE *f;
1085
1086                 refs->packed = xcalloc(1, sizeof(*refs->packed));
1087                 acquire_packed_ref_cache(refs->packed);
1088                 refs->packed->root = create_dir_entry(refs, "", 0, 0);
1089                 f = fopen(packed_refs_file, "r");
1090                 if (f) {
1091                         stat_validity_update(&refs->packed->validity, fileno(f));
1092                         read_packed_refs(f, get_ref_dir(refs->packed->root));
1093                         fclose(f);
1094                 }
1095         }
1096         return refs->packed;
1097 }
1098
1099 static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1100 {
1101         return get_ref_dir(packed_ref_cache->root);
1102 }
1103
1104 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1105 {
1106         return get_packed_ref_dir(get_packed_ref_cache(refs));
1107 }
1108
1109 void add_packed_ref(const char *refname, const unsigned char *sha1)
1110 {
1111         struct packed_ref_cache *packed_ref_cache =
1112                 get_packed_ref_cache(&ref_cache);
1113
1114         if (!packed_ref_cache->lock)
1115                 die("internal error: packed refs not locked");
1116         add_ref(get_packed_ref_dir(packed_ref_cache),
1117                 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1118 }
1119
1120 /*
1121  * Read the loose references from the namespace dirname into dir
1122  * (without recursing).  dirname must end with '/'.  dir must be the
1123  * directory entry corresponding to dirname.
1124  */
1125 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1126 {
1127         struct ref_cache *refs = dir->ref_cache;
1128         DIR *d;
1129         const char *path;
1130         struct dirent *de;
1131         int dirnamelen = strlen(dirname);
1132         struct strbuf refname;
1133
1134         if (*refs->name)
1135                 path = git_path_submodule(refs->name, "%s", dirname);
1136         else
1137                 path = git_path("%s", dirname);
1138
1139         d = opendir(path);
1140         if (!d)
1141                 return;
1142
1143         strbuf_init(&refname, dirnamelen + 257);
1144         strbuf_add(&refname, dirname, dirnamelen);
1145
1146         while ((de = readdir(d)) != NULL) {
1147                 unsigned char sha1[20];
1148                 struct stat st;
1149                 int flag;
1150                 const char *refdir;
1151
1152                 if (de->d_name[0] == '.')
1153                         continue;
1154                 if (has_extension(de->d_name, ".lock"))
1155                         continue;
1156                 strbuf_addstr(&refname, de->d_name);
1157                 refdir = *refs->name
1158                         ? git_path_submodule(refs->name, "%s", refname.buf)
1159                         : git_path("%s", refname.buf);
1160                 if (stat(refdir, &st) < 0) {
1161                         ; /* silently ignore */
1162                 } else if (S_ISDIR(st.st_mode)) {
1163                         strbuf_addch(&refname, '/');
1164                         add_entry_to_dir(dir,
1165                                          create_dir_entry(refs, refname.buf,
1166                                                           refname.len, 1));
1167                 } else {
1168                         if (*refs->name) {
1169                                 hashclr(sha1);
1170                                 flag = 0;
1171                                 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1172                                         hashclr(sha1);
1173                                         flag |= REF_ISBROKEN;
1174                                 }
1175                         } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
1176                                 hashclr(sha1);
1177                                 flag |= REF_ISBROKEN;
1178                         }
1179                         add_entry_to_dir(dir,
1180                                          create_ref_entry(refname.buf, sha1, flag, 1));
1181                 }
1182                 strbuf_setlen(&refname, dirnamelen);
1183         }
1184         strbuf_release(&refname);
1185         closedir(d);
1186 }
1187
1188 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1189 {
1190         if (!refs->loose) {
1191                 /*
1192                  * Mark the top-level directory complete because we
1193                  * are about to read the only subdirectory that can
1194                  * hold references:
1195                  */
1196                 refs->loose = create_dir_entry(refs, "", 0, 0);
1197                 /*
1198                  * Create an incomplete entry for "refs/":
1199                  */
1200                 add_entry_to_dir(get_ref_dir(refs->loose),
1201                                  create_dir_entry(refs, "refs/", 5, 1));
1202         }
1203         return get_ref_dir(refs->loose);
1204 }
1205
1206 /* We allow "recursive" symbolic refs. Only within reason, though */
1207 #define MAXDEPTH 5
1208 #define MAXREFLEN (1024)
1209
1210 /*
1211  * Called by resolve_gitlink_ref_recursive() after it failed to read
1212  * from the loose refs in ref_cache refs. Find <refname> in the
1213  * packed-refs file for the submodule.
1214  */
1215 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1216                                       const char *refname, unsigned char *sha1)
1217 {
1218         struct ref_entry *ref;
1219         struct ref_dir *dir = get_packed_refs(refs);
1220
1221         ref = find_ref(dir, refname);
1222         if (ref == NULL)
1223                 return -1;
1224
1225         hashcpy(sha1, ref->u.value.sha1);
1226         return 0;
1227 }
1228
1229 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1230                                          const char *refname, unsigned char *sha1,
1231                                          int recursion)
1232 {
1233         int fd, len;
1234         char buffer[128], *p;
1235         char *path;
1236
1237         if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1238                 return -1;
1239         path = *refs->name
1240                 ? git_path_submodule(refs->name, "%s", refname)
1241                 : git_path("%s", refname);
1242         fd = open(path, O_RDONLY);
1243         if (fd < 0)
1244                 return resolve_gitlink_packed_ref(refs, refname, sha1);
1245
1246         len = read(fd, buffer, sizeof(buffer)-1);
1247         close(fd);
1248         if (len < 0)
1249                 return -1;
1250         while (len && isspace(buffer[len-1]))
1251                 len--;
1252         buffer[len] = 0;
1253
1254         /* Was it a detached head or an old-fashioned symlink? */
1255         if (!get_sha1_hex(buffer, sha1))
1256                 return 0;
1257
1258         /* Symref? */
1259         if (strncmp(buffer, "ref:", 4))
1260                 return -1;
1261         p = buffer + 4;
1262         while (isspace(*p))
1263                 p++;
1264
1265         return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1266 }
1267
1268 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1269 {
1270         int len = strlen(path), retval;
1271         char *submodule;
1272         struct ref_cache *refs;
1273
1274         while (len && path[len-1] == '/')
1275                 len--;
1276         if (!len)
1277                 return -1;
1278         submodule = xstrndup(path, len);
1279         refs = get_ref_cache(submodule);
1280         free(submodule);
1281
1282         retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1283         return retval;
1284 }
1285
1286 /*
1287  * Return the ref_entry for the given refname from the packed
1288  * references.  If it does not exist, return NULL.
1289  */
1290 static struct ref_entry *get_packed_ref(const char *refname)
1291 {
1292         return find_ref(get_packed_refs(&ref_cache), refname);
1293 }
1294
1295 /*
1296  * A loose ref file doesn't exist; check for a packed ref.  The
1297  * options are forwarded from resolve_safe_unsafe().
1298  */
1299 static const char *handle_missing_loose_ref(const char *refname,
1300                                             unsigned char *sha1,
1301                                             int reading,
1302                                             int *flag)
1303 {
1304         struct ref_entry *entry;
1305
1306         /*
1307          * The loose reference file does not exist; check for a packed
1308          * reference.
1309          */
1310         entry = get_packed_ref(refname);
1311         if (entry) {
1312                 hashcpy(sha1, entry->u.value.sha1);
1313                 if (flag)
1314                         *flag |= REF_ISPACKED;
1315                 return refname;
1316         }
1317         /* The reference is not a packed reference, either. */
1318         if (reading) {
1319                 return NULL;
1320         } else {
1321                 hashclr(sha1);
1322                 return refname;
1323         }
1324 }
1325
1326 const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1327 {
1328         int depth = MAXDEPTH;
1329         ssize_t len;
1330         char buffer[256];
1331         static char refname_buffer[256];
1332
1333         if (flag)
1334                 *flag = 0;
1335
1336         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1337                 return NULL;
1338
1339         for (;;) {
1340                 char path[PATH_MAX];
1341                 struct stat st;
1342                 char *buf;
1343                 int fd;
1344
1345                 if (--depth < 0)
1346                         return NULL;
1347
1348                 git_snpath(path, sizeof(path), "%s", refname);
1349
1350                 /*
1351                  * We might have to loop back here to avoid a race
1352                  * condition: first we lstat() the file, then we try
1353                  * to read it as a link or as a file.  But if somebody
1354                  * changes the type of the file (file <-> directory
1355                  * <-> symlink) between the lstat() and reading, then
1356                  * we don't want to report that as an error but rather
1357                  * try again starting with the lstat().
1358                  */
1359         stat_ref:
1360                 if (lstat(path, &st) < 0) {
1361                         if (errno == ENOENT)
1362                                 return handle_missing_loose_ref(refname, sha1,
1363                                                                 reading, flag);
1364                         else
1365                                 return NULL;
1366                 }
1367
1368                 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1369                 if (S_ISLNK(st.st_mode)) {
1370                         len = readlink(path, buffer, sizeof(buffer)-1);
1371                         if (len < 0) {
1372                                 if (errno == ENOENT || errno == EINVAL)
1373                                         /* inconsistent with lstat; retry */
1374                                         goto stat_ref;
1375                                 else
1376                                         return NULL;
1377                         }
1378                         buffer[len] = 0;
1379                         if (starts_with(buffer, "refs/") &&
1380                                         !check_refname_format(buffer, 0)) {
1381                                 strcpy(refname_buffer, buffer);
1382                                 refname = refname_buffer;
1383                                 if (flag)
1384                                         *flag |= REF_ISSYMREF;
1385                                 continue;
1386                         }
1387                 }
1388
1389                 /* Is it a directory? */
1390                 if (S_ISDIR(st.st_mode)) {
1391                         errno = EISDIR;
1392                         return NULL;
1393                 }
1394
1395                 /*
1396                  * Anything else, just open it and try to use it as
1397                  * a ref
1398                  */
1399                 fd = open(path, O_RDONLY);
1400                 if (fd < 0) {
1401                         if (errno == ENOENT)
1402                                 /* inconsistent with lstat; retry */
1403                                 goto stat_ref;
1404                         else
1405                                 return NULL;
1406                 }
1407                 len = read_in_full(fd, buffer, sizeof(buffer)-1);
1408                 close(fd);
1409                 if (len < 0)
1410                         return NULL;
1411                 while (len && isspace(buffer[len-1]))
1412                         len--;
1413                 buffer[len] = '\0';
1414
1415                 /*
1416                  * Is it a symbolic ref?
1417                  */
1418                 if (!starts_with(buffer, "ref:")) {
1419                         /*
1420                          * Please note that FETCH_HEAD has a second
1421                          * line containing other data.
1422                          */
1423                         if (get_sha1_hex(buffer, sha1) ||
1424                             (buffer[40] != '\0' && !isspace(buffer[40]))) {
1425                                 if (flag)
1426                                         *flag |= REF_ISBROKEN;
1427                                 return NULL;
1428                         }
1429                         return refname;
1430                 }
1431                 if (flag)
1432                         *flag |= REF_ISSYMREF;
1433                 buf = buffer + 4;
1434                 while (isspace(*buf))
1435                         buf++;
1436                 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1437                         if (flag)
1438                                 *flag |= REF_ISBROKEN;
1439                         return NULL;
1440                 }
1441                 refname = strcpy(refname_buffer, buf);
1442         }
1443 }
1444
1445 char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1446 {
1447         const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1448         return ret ? xstrdup(ret) : NULL;
1449 }
1450
1451 /* The argument to filter_refs */
1452 struct ref_filter {
1453         const char *pattern;
1454         each_ref_fn *fn;
1455         void *cb_data;
1456 };
1457
1458 int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1459 {
1460         if (resolve_ref_unsafe(refname, sha1, reading, flags))
1461                 return 0;
1462         return -1;
1463 }
1464
1465 int read_ref(const char *refname, unsigned char *sha1)
1466 {
1467         return read_ref_full(refname, sha1, 1, NULL);
1468 }
1469
1470 int ref_exists(const char *refname)
1471 {
1472         unsigned char sha1[20];
1473         return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1474 }
1475
1476 static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1477                        void *data)
1478 {
1479         struct ref_filter *filter = (struct ref_filter *)data;
1480         if (wildmatch(filter->pattern, refname, 0, NULL))
1481                 return 0;
1482         return filter->fn(refname, sha1, flags, filter->cb_data);
1483 }
1484
1485 enum peel_status {
1486         /* object was peeled successfully: */
1487         PEEL_PEELED = 0,
1488
1489         /*
1490          * object cannot be peeled because the named object (or an
1491          * object referred to by a tag in the peel chain), does not
1492          * exist.
1493          */
1494         PEEL_INVALID = -1,
1495
1496         /* object cannot be peeled because it is not a tag: */
1497         PEEL_NON_TAG = -2,
1498
1499         /* ref_entry contains no peeled value because it is a symref: */
1500         PEEL_IS_SYMREF = -3,
1501
1502         /*
1503          * ref_entry cannot be peeled because it is broken (i.e., the
1504          * symbolic reference cannot even be resolved to an object
1505          * name):
1506          */
1507         PEEL_BROKEN = -4
1508 };
1509
1510 /*
1511  * Peel the named object; i.e., if the object is a tag, resolve the
1512  * tag recursively until a non-tag is found.  If successful, store the
1513  * result to sha1 and return PEEL_PEELED.  If the object is not a tag
1514  * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1515  * and leave sha1 unchanged.
1516  */
1517 static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1518 {
1519         struct object *o = lookup_unknown_object(name);
1520
1521         if (o->type == OBJ_NONE) {
1522                 int type = sha1_object_info(name, NULL);
1523                 if (type < 0)
1524                         return PEEL_INVALID;
1525                 o->type = type;
1526         }
1527
1528         if (o->type != OBJ_TAG)
1529                 return PEEL_NON_TAG;
1530
1531         o = deref_tag_noverify(o);
1532         if (!o)
1533                 return PEEL_INVALID;
1534
1535         hashcpy(sha1, o->sha1);
1536         return PEEL_PEELED;
1537 }
1538
1539 /*
1540  * Peel the entry (if possible) and return its new peel_status.  If
1541  * repeel is true, re-peel the entry even if there is an old peeled
1542  * value that is already stored in it.
1543  *
1544  * It is OK to call this function with a packed reference entry that
1545  * might be stale and might even refer to an object that has since
1546  * been garbage-collected.  In such a case, if the entry has
1547  * REF_KNOWS_PEELED then leave the status unchanged and return
1548  * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1549  */
1550 static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1551 {
1552         enum peel_status status;
1553
1554         if (entry->flag & REF_KNOWS_PEELED) {
1555                 if (repeel) {
1556                         entry->flag &= ~REF_KNOWS_PEELED;
1557                         hashclr(entry->u.value.peeled);
1558                 } else {
1559                         return is_null_sha1(entry->u.value.peeled) ?
1560                                 PEEL_NON_TAG : PEEL_PEELED;
1561                 }
1562         }
1563         if (entry->flag & REF_ISBROKEN)
1564                 return PEEL_BROKEN;
1565         if (entry->flag & REF_ISSYMREF)
1566                 return PEEL_IS_SYMREF;
1567
1568         status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
1569         if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1570                 entry->flag |= REF_KNOWS_PEELED;
1571         return status;
1572 }
1573
1574 int peel_ref(const char *refname, unsigned char *sha1)
1575 {
1576         int flag;
1577         unsigned char base[20];
1578
1579         if (current_ref && (current_ref->name == refname
1580                             || !strcmp(current_ref->name, refname))) {
1581                 if (peel_entry(current_ref, 0))
1582                         return -1;
1583                 hashcpy(sha1, current_ref->u.value.peeled);
1584                 return 0;
1585         }
1586
1587         if (read_ref_full(refname, base, 1, &flag))
1588                 return -1;
1589
1590         /*
1591          * If the reference is packed, read its ref_entry from the
1592          * cache in the hope that we already know its peeled value.
1593          * We only try this optimization on packed references because
1594          * (a) forcing the filling of the loose reference cache could
1595          * be expensive and (b) loose references anyway usually do not
1596          * have REF_KNOWS_PEELED.
1597          */
1598         if (flag & REF_ISPACKED) {
1599                 struct ref_entry *r = get_packed_ref(refname);
1600                 if (r) {
1601                         if (peel_entry(r, 0))
1602                                 return -1;
1603                         hashcpy(sha1, r->u.value.peeled);
1604                         return 0;
1605                 }
1606         }
1607
1608         return peel_object(base, sha1);
1609 }
1610
1611 struct warn_if_dangling_data {
1612         FILE *fp;
1613         const char *refname;
1614         const struct string_list *refnames;
1615         const char *msg_fmt;
1616 };
1617
1618 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1619                                    int flags, void *cb_data)
1620 {
1621         struct warn_if_dangling_data *d = cb_data;
1622         const char *resolves_to;
1623         unsigned char junk[20];
1624
1625         if (!(flags & REF_ISSYMREF))
1626                 return 0;
1627
1628         resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1629         if (!resolves_to
1630             || (d->refname
1631                 ? strcmp(resolves_to, d->refname)
1632                 : !string_list_has_string(d->refnames, resolves_to))) {
1633                 return 0;
1634         }
1635
1636         fprintf(d->fp, d->msg_fmt, refname);
1637         fputc('\n', d->fp);
1638         return 0;
1639 }
1640
1641 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1642 {
1643         struct warn_if_dangling_data data;
1644
1645         data.fp = fp;
1646         data.refname = refname;
1647         data.refnames = NULL;
1648         data.msg_fmt = msg_fmt;
1649         for_each_rawref(warn_if_dangling_symref, &data);
1650 }
1651
1652 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
1653 {
1654         struct warn_if_dangling_data data;
1655
1656         data.fp = fp;
1657         data.refname = NULL;
1658         data.refnames = refnames;
1659         data.msg_fmt = msg_fmt;
1660         for_each_rawref(warn_if_dangling_symref, &data);
1661 }
1662
1663 /*
1664  * Call fn for each reference in the specified ref_cache, omitting
1665  * references not in the containing_dir of base.  fn is called for all
1666  * references, including broken ones.  If fn ever returns a non-zero
1667  * value, stop the iteration and return that value; otherwise, return
1668  * 0.
1669  */
1670 static int do_for_each_entry(struct ref_cache *refs, const char *base,
1671                              each_ref_entry_fn fn, void *cb_data)
1672 {
1673         struct packed_ref_cache *packed_ref_cache;
1674         struct ref_dir *loose_dir;
1675         struct ref_dir *packed_dir;
1676         int retval = 0;
1677
1678         /*
1679          * We must make sure that all loose refs are read before accessing the
1680          * packed-refs file; this avoids a race condition in which loose refs
1681          * are migrated to the packed-refs file by a simultaneous process, but
1682          * our in-memory view is from before the migration. get_packed_ref_cache()
1683          * takes care of making sure our view is up to date with what is on
1684          * disk.
1685          */
1686         loose_dir = get_loose_refs(refs);
1687         if (base && *base) {
1688                 loose_dir = find_containing_dir(loose_dir, base, 0);
1689         }
1690         if (loose_dir)
1691                 prime_ref_dir(loose_dir);
1692
1693         packed_ref_cache = get_packed_ref_cache(refs);
1694         acquire_packed_ref_cache(packed_ref_cache);
1695         packed_dir = get_packed_ref_dir(packed_ref_cache);
1696         if (base && *base) {
1697                 packed_dir = find_containing_dir(packed_dir, base, 0);
1698         }
1699
1700         if (packed_dir && loose_dir) {
1701                 sort_ref_dir(packed_dir);
1702                 sort_ref_dir(loose_dir);
1703                 retval = do_for_each_entry_in_dirs(
1704                                 packed_dir, loose_dir, fn, cb_data);
1705         } else if (packed_dir) {
1706                 sort_ref_dir(packed_dir);
1707                 retval = do_for_each_entry_in_dir(
1708                                 packed_dir, 0, fn, cb_data);
1709         } else if (loose_dir) {
1710                 sort_ref_dir(loose_dir);
1711                 retval = do_for_each_entry_in_dir(
1712                                 loose_dir, 0, fn, cb_data);
1713         }
1714
1715         release_packed_ref_cache(packed_ref_cache);
1716         return retval;
1717 }
1718
1719 /*
1720  * Call fn for each reference in the specified ref_cache for which the
1721  * refname begins with base.  If trim is non-zero, then trim that many
1722  * characters off the beginning of each refname before passing the
1723  * refname to fn.  flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1724  * broken references in the iteration.  If fn ever returns a non-zero
1725  * value, stop the iteration and return that value; otherwise, return
1726  * 0.
1727  */
1728 static int do_for_each_ref(struct ref_cache *refs, const char *base,
1729                            each_ref_fn fn, int trim, int flags, void *cb_data)
1730 {
1731         struct ref_entry_cb data;
1732         data.base = base;
1733         data.trim = trim;
1734         data.flags = flags;
1735         data.fn = fn;
1736         data.cb_data = cb_data;
1737
1738         return do_for_each_entry(refs, base, do_one_ref, &data);
1739 }
1740
1741 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1742 {
1743         unsigned char sha1[20];
1744         int flag;
1745
1746         if (submodule) {
1747                 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1748                         return fn("HEAD", sha1, 0, cb_data);
1749
1750                 return 0;
1751         }
1752
1753         if (!read_ref_full("HEAD", sha1, 1, &flag))
1754                 return fn("HEAD", sha1, flag, cb_data);
1755
1756         return 0;
1757 }
1758
1759 int head_ref(each_ref_fn fn, void *cb_data)
1760 {
1761         return do_head_ref(NULL, fn, cb_data);
1762 }
1763
1764 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1765 {
1766         return do_head_ref(submodule, fn, cb_data);
1767 }
1768
1769 int for_each_ref(each_ref_fn fn, void *cb_data)
1770 {
1771         return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1772 }
1773
1774 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1775 {
1776         return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1777 }
1778
1779 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1780 {
1781         return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1782 }
1783
1784 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1785                 each_ref_fn fn, void *cb_data)
1786 {
1787         return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1788 }
1789
1790 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1791 {
1792         return for_each_ref_in("refs/tags/", fn, cb_data);
1793 }
1794
1795 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1796 {
1797         return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1798 }
1799
1800 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1801 {
1802         return for_each_ref_in("refs/heads/", fn, cb_data);
1803 }
1804
1805 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1806 {
1807         return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1808 }
1809
1810 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1811 {
1812         return for_each_ref_in("refs/remotes/", fn, cb_data);
1813 }
1814
1815 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1816 {
1817         return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1818 }
1819
1820 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1821 {
1822         return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
1823 }
1824
1825 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1826 {
1827         struct strbuf buf = STRBUF_INIT;
1828         int ret = 0;
1829         unsigned char sha1[20];
1830         int flag;
1831
1832         strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1833         if (!read_ref_full(buf.buf, sha1, 1, &flag))
1834                 ret = fn(buf.buf, sha1, flag, cb_data);
1835         strbuf_release(&buf);
1836
1837         return ret;
1838 }
1839
1840 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1841 {
1842         struct strbuf buf = STRBUF_INIT;
1843         int ret;
1844         strbuf_addf(&buf, "%srefs/", get_git_namespace());
1845         ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
1846         strbuf_release(&buf);
1847         return ret;
1848 }
1849
1850 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1851         const char *prefix, void *cb_data)
1852 {
1853         struct strbuf real_pattern = STRBUF_INIT;
1854         struct ref_filter filter;
1855         int ret;
1856
1857         if (!prefix && !starts_with(pattern, "refs/"))
1858                 strbuf_addstr(&real_pattern, "refs/");
1859         else if (prefix)
1860                 strbuf_addstr(&real_pattern, prefix);
1861         strbuf_addstr(&real_pattern, pattern);
1862
1863         if (!has_glob_specials(pattern)) {
1864                 /* Append implied '/' '*' if not present. */
1865                 if (real_pattern.buf[real_pattern.len - 1] != '/')
1866                         strbuf_addch(&real_pattern, '/');
1867                 /* No need to check for '*', there is none. */
1868                 strbuf_addch(&real_pattern, '*');
1869         }
1870
1871         filter.pattern = real_pattern.buf;
1872         filter.fn = fn;
1873         filter.cb_data = cb_data;
1874         ret = for_each_ref(filter_refs, &filter);
1875
1876         strbuf_release(&real_pattern);
1877         return ret;
1878 }
1879
1880 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1881 {
1882         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1883 }
1884
1885 int for_each_rawref(each_ref_fn fn, void *cb_data)
1886 {
1887         return do_for_each_ref(&ref_cache, "", fn, 0,
1888                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1889 }
1890
1891 const char *prettify_refname(const char *name)
1892 {
1893         return name + (
1894                 starts_with(name, "refs/heads/") ? 11 :
1895                 starts_with(name, "refs/tags/") ? 10 :
1896                 starts_with(name, "refs/remotes/") ? 13 :
1897                 0);
1898 }
1899
1900 static const char *ref_rev_parse_rules[] = {
1901         "%.*s",
1902         "refs/%.*s",
1903         "refs/tags/%.*s",
1904         "refs/heads/%.*s",
1905         "refs/remotes/%.*s",
1906         "refs/remotes/%.*s/HEAD",
1907         NULL
1908 };
1909
1910 int refname_match(const char *abbrev_name, const char *full_name)
1911 {
1912         const char **p;
1913         const int abbrev_name_len = strlen(abbrev_name);
1914
1915         for (p = ref_rev_parse_rules; *p; p++) {
1916                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1917                         return 1;
1918                 }
1919         }
1920
1921         return 0;
1922 }
1923
1924 static struct ref_lock *verify_lock(struct ref_lock *lock,
1925         const unsigned char *old_sha1, int mustexist)
1926 {
1927         if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1928                 error("Can't verify ref %s", lock->ref_name);
1929                 unlock_ref(lock);
1930                 return NULL;
1931         }
1932         if (hashcmp(lock->old_sha1, old_sha1)) {
1933                 error("Ref %s is at %s but expected %s", lock->ref_name,
1934                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1935                 unlock_ref(lock);
1936                 return NULL;
1937         }
1938         return lock;
1939 }
1940
1941 static int remove_empty_directories(const char *file)
1942 {
1943         /* we want to create a file but there is a directory there;
1944          * if that is an empty directory (or a directory that contains
1945          * only empty directories), remove them.
1946          */
1947         struct strbuf path;
1948         int result;
1949
1950         strbuf_init(&path, 20);
1951         strbuf_addstr(&path, file);
1952
1953         result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1954
1955         strbuf_release(&path);
1956
1957         return result;
1958 }
1959
1960 /*
1961  * *string and *len will only be substituted, and *string returned (for
1962  * later free()ing) if the string passed in is a magic short-hand form
1963  * to name a branch.
1964  */
1965 static char *substitute_branch_name(const char **string, int *len)
1966 {
1967         struct strbuf buf = STRBUF_INIT;
1968         int ret = interpret_branch_name(*string, *len, &buf);
1969
1970         if (ret == *len) {
1971                 size_t size;
1972                 *string = strbuf_detach(&buf, &size);
1973                 *len = size;
1974                 return (char *)*string;
1975         }
1976
1977         return NULL;
1978 }
1979
1980 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1981 {
1982         char *last_branch = substitute_branch_name(&str, &len);
1983         const char **p, *r;
1984         int refs_found = 0;
1985
1986         *ref = NULL;
1987         for (p = ref_rev_parse_rules; *p; p++) {
1988                 char fullref[PATH_MAX];
1989                 unsigned char sha1_from_ref[20];
1990                 unsigned char *this_result;
1991                 int flag;
1992
1993                 this_result = refs_found ? sha1_from_ref : sha1;
1994                 mksnpath(fullref, sizeof(fullref), *p, len, str);
1995                 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1996                 if (r) {
1997                         if (!refs_found++)
1998                                 *ref = xstrdup(r);
1999                         if (!warn_ambiguous_refs)
2000                                 break;
2001                 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2002                         warning("ignoring dangling symref %s.", fullref);
2003                 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
2004                         warning("ignoring broken ref %s.", fullref);
2005                 }
2006         }
2007         free(last_branch);
2008         return refs_found;
2009 }
2010
2011 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
2012 {
2013         char *last_branch = substitute_branch_name(&str, &len);
2014         const char **p;
2015         int logs_found = 0;
2016
2017         *log = NULL;
2018         for (p = ref_rev_parse_rules; *p; p++) {
2019                 unsigned char hash[20];
2020                 char path[PATH_MAX];
2021                 const char *ref, *it;
2022
2023                 mksnpath(path, sizeof(path), *p, len, str);
2024                 ref = resolve_ref_unsafe(path, hash, 1, NULL);
2025                 if (!ref)
2026                         continue;
2027                 if (reflog_exists(path))
2028                         it = path;
2029                 else if (strcmp(ref, path) && reflog_exists(ref))
2030                         it = ref;
2031                 else
2032                         continue;
2033                 if (!logs_found++) {
2034                         *log = xstrdup(it);
2035                         hashcpy(sha1, hash);
2036                 }
2037                 if (!warn_ambiguous_refs)
2038                         break;
2039         }
2040         free(last_branch);
2041         return logs_found;
2042 }
2043
2044 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
2045                                             const unsigned char *old_sha1,
2046                                             int flags, int *type_p)
2047 {
2048         char *ref_file;
2049         const char *orig_refname = refname;
2050         struct ref_lock *lock;
2051         int last_errno = 0;
2052         int type, lflags;
2053         int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2054         int missing = 0;
2055         int attempts_remaining = 3;
2056
2057         lock = xcalloc(1, sizeof(struct ref_lock));
2058         lock->lock_fd = -1;
2059
2060         refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
2061         if (!refname && errno == EISDIR) {
2062                 /* we are trying to lock foo but we used to
2063                  * have foo/bar which now does not exist;
2064                  * it is normal for the empty directory 'foo'
2065                  * to remain.
2066                  */
2067                 ref_file = git_path("%s", orig_refname);
2068                 if (remove_empty_directories(ref_file)) {
2069                         last_errno = errno;
2070                         error("there are still refs under '%s'", orig_refname);
2071                         goto error_return;
2072                 }
2073                 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
2074         }
2075         if (type_p)
2076             *type_p = type;
2077         if (!refname) {
2078                 last_errno = errno;
2079                 error("unable to resolve reference %s: %s",
2080                         orig_refname, strerror(errno));
2081                 goto error_return;
2082         }
2083         missing = is_null_sha1(lock->old_sha1);
2084         /* When the ref did not exist and we are creating it,
2085          * make sure there is no existing ref that is packed
2086          * whose name begins with our refname, nor a ref whose
2087          * name is a proper prefix of our refname.
2088          */
2089         if (missing &&
2090              !is_refname_available(refname, NULL, get_packed_refs(&ref_cache))) {
2091                 last_errno = ENOTDIR;
2092                 goto error_return;
2093         }
2094
2095         lock->lk = xcalloc(1, sizeof(struct lock_file));
2096
2097         lflags = 0;
2098         if (flags & REF_NODEREF) {
2099                 refname = orig_refname;
2100                 lflags |= LOCK_NODEREF;
2101         }
2102         lock->ref_name = xstrdup(refname);
2103         lock->orig_ref_name = xstrdup(orig_refname);
2104         ref_file = git_path("%s", refname);
2105         if (missing)
2106                 lock->force_write = 1;
2107         if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
2108                 lock->force_write = 1;
2109
2110  retry:
2111         switch (safe_create_leading_directories(ref_file)) {
2112         case SCLD_OK:
2113                 break; /* success */
2114         case SCLD_VANISHED:
2115                 if (--attempts_remaining > 0)
2116                         goto retry;
2117                 /* fall through */
2118         default:
2119                 last_errno = errno;
2120                 error("unable to create directory for %s", ref_file);
2121                 goto error_return;
2122         }
2123
2124         lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
2125         if (lock->lock_fd < 0) {
2126                 if (errno == ENOENT && --attempts_remaining > 0)
2127                         /*
2128                          * Maybe somebody just deleted one of the
2129                          * directories leading to ref_file.  Try
2130                          * again:
2131                          */
2132                         goto retry;
2133                 else
2134                         unable_to_lock_index_die(ref_file, errno);
2135         }
2136         return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
2137
2138  error_return:
2139         unlock_ref(lock);
2140         errno = last_errno;
2141         return NULL;
2142 }
2143
2144 struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
2145 {
2146         char refpath[PATH_MAX];
2147         if (check_refname_format(refname, 0))
2148                 return NULL;
2149         strcpy(refpath, mkpath("refs/%s", refname));
2150         return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
2151 }
2152
2153 struct ref_lock *lock_any_ref_for_update(const char *refname,
2154                                          const unsigned char *old_sha1,
2155                                          int flags, int *type_p)
2156 {
2157         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
2158                 return NULL;
2159         return lock_ref_sha1_basic(refname, old_sha1, flags, type_p);
2160 }
2161
2162 /*
2163  * Write an entry to the packed-refs file for the specified refname.
2164  * If peeled is non-NULL, write it as the entry's peeled value.
2165  */
2166 static void write_packed_entry(int fd, char *refname, unsigned char *sha1,
2167                                unsigned char *peeled)
2168 {
2169         char line[PATH_MAX + 100];
2170         int len;
2171
2172         len = snprintf(line, sizeof(line), "%s %s\n",
2173                        sha1_to_hex(sha1), refname);
2174         /* this should not happen but just being defensive */
2175         if (len > sizeof(line))
2176                 die("too long a refname '%s'", refname);
2177         write_or_die(fd, line, len);
2178
2179         if (peeled) {
2180                 if (snprintf(line, sizeof(line), "^%s\n",
2181                              sha1_to_hex(peeled)) != PEELED_LINE_LENGTH)
2182                         die("internal error");
2183                 write_or_die(fd, line, PEELED_LINE_LENGTH);
2184         }
2185 }
2186
2187 /*
2188  * An each_ref_entry_fn that writes the entry to a packed-refs file.
2189  */
2190 static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2191 {
2192         int *fd = cb_data;
2193         enum peel_status peel_status = peel_entry(entry, 0);
2194
2195         if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2196                 error("internal error: %s is not a valid packed reference!",
2197                       entry->name);
2198         write_packed_entry(*fd, entry->name, entry->u.value.sha1,
2199                            peel_status == PEEL_PEELED ?
2200                            entry->u.value.peeled : NULL);
2201         return 0;
2202 }
2203
2204 int lock_packed_refs(int flags)
2205 {
2206         struct packed_ref_cache *packed_ref_cache;
2207
2208         if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)
2209                 return -1;
2210         /*
2211          * Get the current packed-refs while holding the lock.  If the
2212          * packed-refs file has been modified since we last read it,
2213          * this will automatically invalidate the cache and re-read
2214          * the packed-refs file.
2215          */
2216         packed_ref_cache = get_packed_ref_cache(&ref_cache);
2217         packed_ref_cache->lock = &packlock;
2218         /* Increment the reference count to prevent it from being freed: */
2219         acquire_packed_ref_cache(packed_ref_cache);
2220         return 0;
2221 }
2222
2223 int commit_packed_refs(void)
2224 {
2225         struct packed_ref_cache *packed_ref_cache =
2226                 get_packed_ref_cache(&ref_cache);
2227         int error = 0;
2228
2229         if (!packed_ref_cache->lock)
2230                 die("internal error: packed-refs not locked");
2231         write_or_die(packed_ref_cache->lock->fd,
2232                      PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
2233
2234         do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2235                                  0, write_packed_entry_fn,
2236                                  &packed_ref_cache->lock->fd);
2237         if (commit_lock_file(packed_ref_cache->lock))
2238                 error = -1;
2239         packed_ref_cache->lock = NULL;
2240         release_packed_ref_cache(packed_ref_cache);
2241         return error;
2242 }
2243
2244 void rollback_packed_refs(void)
2245 {
2246         struct packed_ref_cache *packed_ref_cache =
2247                 get_packed_ref_cache(&ref_cache);
2248
2249         if (!packed_ref_cache->lock)
2250                 die("internal error: packed-refs not locked");
2251         rollback_lock_file(packed_ref_cache->lock);
2252         packed_ref_cache->lock = NULL;
2253         release_packed_ref_cache(packed_ref_cache);
2254         clear_packed_ref_cache(&ref_cache);
2255 }
2256
2257 struct ref_to_prune {
2258         struct ref_to_prune *next;
2259         unsigned char sha1[20];
2260         char name[FLEX_ARRAY];
2261 };
2262
2263 struct pack_refs_cb_data {
2264         unsigned int flags;
2265         struct ref_dir *packed_refs;
2266         struct ref_to_prune *ref_to_prune;
2267 };
2268
2269 /*
2270  * An each_ref_entry_fn that is run over loose references only.  If
2271  * the loose reference can be packed, add an entry in the packed ref
2272  * cache.  If the reference should be pruned, also add it to
2273  * ref_to_prune in the pack_refs_cb_data.
2274  */
2275 static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2276 {
2277         struct pack_refs_cb_data *cb = cb_data;
2278         enum peel_status peel_status;
2279         struct ref_entry *packed_entry;
2280         int is_tag_ref = starts_with(entry->name, "refs/tags/");
2281
2282         /* ALWAYS pack tags */
2283         if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2284                 return 0;
2285
2286         /* Do not pack symbolic or broken refs: */
2287         if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
2288                 return 0;
2289
2290         /* Add a packed ref cache entry equivalent to the loose entry. */
2291         peel_status = peel_entry(entry, 1);
2292         if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2293                 die("internal error peeling reference %s (%s)",
2294                     entry->name, sha1_to_hex(entry->u.value.sha1));
2295         packed_entry = find_ref(cb->packed_refs, entry->name);
2296         if (packed_entry) {
2297                 /* Overwrite existing packed entry with info from loose entry */
2298                 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2299                 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
2300         } else {
2301                 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
2302                                                 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2303                 add_ref(cb->packed_refs, packed_entry);
2304         }
2305         hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
2306
2307         /* Schedule the loose reference for pruning if requested. */
2308         if ((cb->flags & PACK_REFS_PRUNE)) {
2309                 int namelen = strlen(entry->name) + 1;
2310                 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2311                 hashcpy(n->sha1, entry->u.value.sha1);
2312                 strcpy(n->name, entry->name);
2313                 n->next = cb->ref_to_prune;
2314                 cb->ref_to_prune = n;
2315         }
2316         return 0;
2317 }
2318
2319 /*
2320  * Remove empty parents, but spare refs/ and immediate subdirs.
2321  * Note: munges *name.
2322  */
2323 static void try_remove_empty_parents(char *name)
2324 {
2325         char *p, *q;
2326         int i;
2327         p = name;
2328         for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2329                 while (*p && *p != '/')
2330                         p++;
2331                 /* tolerate duplicate slashes; see check_refname_format() */
2332                 while (*p == '/')
2333                         p++;
2334         }
2335         for (q = p; *q; q++)
2336                 ;
2337         while (1) {
2338                 while (q > p && *q != '/')
2339                         q--;
2340                 while (q > p && *(q-1) == '/')
2341                         q--;
2342                 if (q == p)
2343                         break;
2344                 *q = '\0';
2345                 if (rmdir(git_path("%s", name)))
2346                         break;
2347         }
2348 }
2349
2350 /* make sure nobody touched the ref, and unlink */
2351 static void prune_ref(struct ref_to_prune *r)
2352 {
2353         struct ref_lock *lock = lock_ref_sha1(r->name + 5, r->sha1);
2354
2355         if (lock) {
2356                 unlink_or_warn(git_path("%s", r->name));
2357                 unlock_ref(lock);
2358                 try_remove_empty_parents(r->name);
2359         }
2360 }
2361
2362 static void prune_refs(struct ref_to_prune *r)
2363 {
2364         while (r) {
2365                 prune_ref(r);
2366                 r = r->next;
2367         }
2368 }
2369
2370 int pack_refs(unsigned int flags)
2371 {
2372         struct pack_refs_cb_data cbdata;
2373
2374         memset(&cbdata, 0, sizeof(cbdata));
2375         cbdata.flags = flags;
2376
2377         lock_packed_refs(LOCK_DIE_ON_ERROR);
2378         cbdata.packed_refs = get_packed_refs(&ref_cache);
2379
2380         do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2381                                  pack_if_possible_fn, &cbdata);
2382
2383         if (commit_packed_refs())
2384                 die_errno("unable to overwrite old ref-pack file");
2385
2386         prune_refs(cbdata.ref_to_prune);
2387         return 0;
2388 }
2389
2390 /*
2391  * If entry is no longer needed in packed-refs, add it to the string
2392  * list pointed to by cb_data.  Reasons for deleting entries:
2393  *
2394  * - Entry is broken.
2395  * - Entry is overridden by a loose ref.
2396  * - Entry does not point at a valid object.
2397  *
2398  * In the first and third cases, also emit an error message because these
2399  * are indications of repository corruption.
2400  */
2401 static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
2402 {
2403         struct string_list *refs_to_delete = cb_data;
2404
2405         if (entry->flag & REF_ISBROKEN) {
2406                 /* This shouldn't happen to packed refs. */
2407                 error("%s is broken!", entry->name);
2408                 string_list_append(refs_to_delete, entry->name);
2409                 return 0;
2410         }
2411         if (!has_sha1_file(entry->u.value.sha1)) {
2412                 unsigned char sha1[20];
2413                 int flags;
2414
2415                 if (read_ref_full(entry->name, sha1, 0, &flags))
2416                         /* We should at least have found the packed ref. */
2417                         die("Internal error");
2418                 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2419                         /*
2420                          * This packed reference is overridden by a
2421                          * loose reference, so it is OK that its value
2422                          * is no longer valid; for example, it might
2423                          * refer to an object that has been garbage
2424                          * collected.  For this purpose we don't even
2425                          * care whether the loose reference itself is
2426                          * invalid, broken, symbolic, etc.  Silently
2427                          * remove the packed reference.
2428                          */
2429                         string_list_append(refs_to_delete, entry->name);
2430                         return 0;
2431                 }
2432                 /*
2433                  * There is no overriding loose reference, so the fact
2434                  * that this reference doesn't refer to a valid object
2435                  * indicates some kind of repository corruption.
2436                  * Report the problem, then omit the reference from
2437                  * the output.
2438                  */
2439                 error("%s does not point to a valid object!", entry->name);
2440                 string_list_append(refs_to_delete, entry->name);
2441                 return 0;
2442         }
2443
2444         return 0;
2445 }
2446
2447 int repack_without_refs(const char **refnames, int n)
2448 {
2449         struct ref_dir *packed;
2450         struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
2451         struct string_list_item *ref_to_delete;
2452         int i, removed = 0;
2453
2454         /* Look for a packed ref */
2455         for (i = 0; i < n; i++)
2456                 if (get_packed_ref(refnames[i]))
2457                         break;
2458
2459         /* Avoid locking if we have nothing to do */
2460         if (i == n)
2461                 return 0; /* no refname exists in packed refs */
2462
2463         if (lock_packed_refs(0)) {
2464                 unable_to_lock_error(git_path("packed-refs"), errno);
2465                 return error("cannot delete '%s' from packed refs", refnames[i]);
2466         }
2467         packed = get_packed_refs(&ref_cache);
2468
2469         /* Remove refnames from the cache */
2470         for (i = 0; i < n; i++)
2471                 if (remove_entry(packed, refnames[i]) != -1)
2472                         removed = 1;
2473         if (!removed) {
2474                 /*
2475                  * All packed entries disappeared while we were
2476                  * acquiring the lock.
2477                  */
2478                 rollback_packed_refs();
2479                 return 0;
2480         }
2481
2482         /* Remove any other accumulated cruft */
2483         do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
2484         for_each_string_list_item(ref_to_delete, &refs_to_delete) {
2485                 if (remove_entry(packed, ref_to_delete->string) == -1)
2486                         die("internal error");
2487         }
2488
2489         /* Write what remains */
2490         return commit_packed_refs();
2491 }
2492
2493 static int repack_without_ref(const char *refname)
2494 {
2495         return repack_without_refs(&refname, 1);
2496 }
2497
2498 static int delete_ref_loose(struct ref_lock *lock, int flag)
2499 {
2500         if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2501                 /* loose */
2502                 int err, i = strlen(lock->lk->filename) - 5; /* .lock */
2503
2504                 lock->lk->filename[i] = 0;
2505                 err = unlink_or_warn(lock->lk->filename);
2506                 lock->lk->filename[i] = '.';
2507                 if (err && errno != ENOENT)
2508                         return 1;
2509         }
2510         return 0;
2511 }
2512
2513 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
2514 {
2515         struct ref_lock *lock;
2516         int ret = 0, flag = 0;
2517
2518         lock = lock_ref_sha1_basic(refname, sha1, delopt, &flag);
2519         if (!lock)
2520                 return 1;
2521         ret |= delete_ref_loose(lock, flag);
2522
2523         /* removing the loose one could have resurrected an earlier
2524          * packed one.  Also, if it was not loose we need to repack
2525          * without it.
2526          */
2527         ret |= repack_without_ref(lock->ref_name);
2528
2529         unlink_or_warn(git_path("logs/%s", lock->ref_name));
2530         clear_loose_ref_cache(&ref_cache);
2531         unlock_ref(lock);
2532         return ret;
2533 }
2534
2535 /*
2536  * People using contrib's git-new-workdir have .git/logs/refs ->
2537  * /some/other/path/.git/logs/refs, and that may live on another device.
2538  *
2539  * IOW, to avoid cross device rename errors, the temporary renamed log must
2540  * live into logs/refs.
2541  */
2542 #define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
2543
2544 static int rename_tmp_log(const char *newrefname)
2545 {
2546         int attempts_remaining = 4;
2547
2548  retry:
2549         switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {
2550         case SCLD_OK:
2551                 break; /* success */
2552         case SCLD_VANISHED:
2553                 if (--attempts_remaining > 0)
2554                         goto retry;
2555                 /* fall through */
2556         default:
2557                 error("unable to create directory for %s", newrefname);
2558                 return -1;
2559         }
2560
2561         if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2562                 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2563                         /*
2564                          * rename(a, b) when b is an existing
2565                          * directory ought to result in ISDIR, but
2566                          * Solaris 5.8 gives ENOTDIR.  Sheesh.
2567                          */
2568                         if (remove_empty_directories(git_path("logs/%s", newrefname))) {
2569                                 error("Directory not empty: logs/%s", newrefname);
2570                                 return -1;
2571                         }
2572                         goto retry;
2573                 } else if (errno == ENOENT && --attempts_remaining > 0) {
2574                         /*
2575                          * Maybe another process just deleted one of
2576                          * the directories in the path to newrefname.
2577                          * Try again from the beginning.
2578                          */
2579                         goto retry;
2580                 } else {
2581                         error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2582                                 newrefname, strerror(errno));
2583                         return -1;
2584                 }
2585         }
2586         return 0;
2587 }
2588
2589 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2590 {
2591         unsigned char sha1[20], orig_sha1[20];
2592         int flag = 0, logmoved = 0;
2593         struct ref_lock *lock;
2594         struct stat loginfo;
2595         int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
2596         const char *symref = NULL;
2597
2598         if (log && S_ISLNK(loginfo.st_mode))
2599                 return error("reflog for %s is a symlink", oldrefname);
2600
2601         symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
2602         if (flag & REF_ISSYMREF)
2603                 return error("refname %s is a symbolic ref, renaming it is not supported",
2604                         oldrefname);
2605         if (!symref)
2606                 return error("refname %s not found", oldrefname);
2607
2608         if (!is_refname_available(newrefname, oldrefname, get_packed_refs(&ref_cache)))
2609                 return 1;
2610
2611         if (!is_refname_available(newrefname, oldrefname, get_loose_refs(&ref_cache)))
2612                 return 1;
2613
2614         if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2615                 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2616                         oldrefname, strerror(errno));
2617
2618         if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
2619                 error("unable to delete old %s", oldrefname);
2620                 goto rollback;
2621         }
2622
2623         if (!read_ref_full(newrefname, sha1, 1, &flag) &&
2624             delete_ref(newrefname, sha1, REF_NODEREF)) {
2625                 if (errno==EISDIR) {
2626                         if (remove_empty_directories(git_path("%s", newrefname))) {
2627                                 error("Directory not empty: %s", newrefname);
2628                                 goto rollback;
2629                         }
2630                 } else {
2631                         error("unable to delete existing %s", newrefname);
2632                         goto rollback;
2633                 }
2634         }
2635
2636         if (log && rename_tmp_log(newrefname))
2637                 goto rollback;
2638
2639         logmoved = log;
2640
2641         lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
2642         if (!lock) {
2643                 error("unable to lock %s for update", newrefname);
2644                 goto rollback;
2645         }
2646         lock->force_write = 1;
2647         hashcpy(lock->old_sha1, orig_sha1);
2648         if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2649                 error("unable to write current sha1 into %s", newrefname);
2650                 goto rollback;
2651         }
2652
2653         return 0;
2654
2655  rollback:
2656         lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
2657         if (!lock) {
2658                 error("unable to lock %s for rollback", oldrefname);
2659                 goto rollbacklog;
2660         }
2661
2662         lock->force_write = 1;
2663         flag = log_all_ref_updates;
2664         log_all_ref_updates = 0;
2665         if (write_ref_sha1(lock, orig_sha1, NULL))
2666                 error("unable to write current sha1 into %s", oldrefname);
2667         log_all_ref_updates = flag;
2668
2669  rollbacklog:
2670         if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2671                 error("unable to restore logfile %s from %s: %s",
2672                         oldrefname, newrefname, strerror(errno));
2673         if (!logmoved && log &&
2674             rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2675                 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2676                         oldrefname, strerror(errno));
2677
2678         return 1;
2679 }
2680
2681 int close_ref(struct ref_lock *lock)
2682 {
2683         if (close_lock_file(lock->lk))
2684                 return -1;
2685         lock->lock_fd = -1;
2686         return 0;
2687 }
2688
2689 int commit_ref(struct ref_lock *lock)
2690 {
2691         if (commit_lock_file(lock->lk))
2692                 return -1;
2693         lock->lock_fd = -1;
2694         return 0;
2695 }
2696
2697 void unlock_ref(struct ref_lock *lock)
2698 {
2699         /* Do not free lock->lk -- atexit() still looks at them */
2700         if (lock->lk)
2701                 rollback_lock_file(lock->lk);
2702         free(lock->ref_name);
2703         free(lock->orig_ref_name);
2704         free(lock);
2705 }
2706
2707 /*
2708  * copy the reflog message msg to buf, which has been allocated sufficiently
2709  * large, while cleaning up the whitespaces.  Especially, convert LF to space,
2710  * because reflog file is one line per entry.
2711  */
2712 static int copy_msg(char *buf, const char *msg)
2713 {
2714         char *cp = buf;
2715         char c;
2716         int wasspace = 1;
2717
2718         *cp++ = '\t';
2719         while ((c = *msg++)) {
2720                 if (wasspace && isspace(c))
2721                         continue;
2722                 wasspace = isspace(c);
2723                 if (wasspace)
2724                         c = ' ';
2725                 *cp++ = c;
2726         }
2727         while (buf < cp && isspace(cp[-1]))
2728                 cp--;
2729         *cp++ = '\n';
2730         return cp - buf;
2731 }
2732
2733 int log_ref_setup(const char *refname, char *logfile, int bufsize)
2734 {
2735         int logfd, oflags = O_APPEND | O_WRONLY;
2736
2737         git_snpath(logfile, bufsize, "logs/%s", refname);
2738         if (log_all_ref_updates &&
2739             (starts_with(refname, "refs/heads/") ||
2740              starts_with(refname, "refs/remotes/") ||
2741              starts_with(refname, "refs/notes/") ||
2742              !strcmp(refname, "HEAD"))) {
2743                 if (safe_create_leading_directories(logfile) < 0)
2744                         return error("unable to create directory for %s",
2745                                      logfile);
2746                 oflags |= O_CREAT;
2747         }
2748
2749         logfd = open(logfile, oflags, 0666);
2750         if (logfd < 0) {
2751                 if (!(oflags & O_CREAT) && errno == ENOENT)
2752                         return 0;
2753
2754                 if ((oflags & O_CREAT) && errno == EISDIR) {
2755                         if (remove_empty_directories(logfile)) {
2756                                 return error("There are still logs under '%s'",
2757                                              logfile);
2758                         }
2759                         logfd = open(logfile, oflags, 0666);
2760                 }
2761
2762                 if (logfd < 0)
2763                         return error("Unable to append to %s: %s",
2764                                      logfile, strerror(errno));
2765         }
2766
2767         adjust_shared_perm(logfile);
2768         close(logfd);
2769         return 0;
2770 }
2771
2772 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2773                          const unsigned char *new_sha1, const char *msg)
2774 {
2775         int logfd, result, written, oflags = O_APPEND | O_WRONLY;
2776         unsigned maxlen, len;
2777         int msglen;
2778         char log_file[PATH_MAX];
2779         char *logrec;
2780         const char *committer;
2781
2782         if (log_all_ref_updates < 0)
2783                 log_all_ref_updates = !is_bare_repository();
2784
2785         result = log_ref_setup(refname, log_file, sizeof(log_file));
2786         if (result)
2787                 return result;
2788
2789         logfd = open(log_file, oflags);
2790         if (logfd < 0)
2791                 return 0;
2792         msglen = msg ? strlen(msg) : 0;
2793         committer = git_committer_info(0);
2794         maxlen = strlen(committer) + msglen + 100;
2795         logrec = xmalloc(maxlen);
2796         len = sprintf(logrec, "%s %s %s\n",
2797                       sha1_to_hex(old_sha1),
2798                       sha1_to_hex(new_sha1),
2799                       committer);
2800         if (msglen)
2801                 len += copy_msg(logrec + len - 1, msg) - 1;
2802         written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2803         free(logrec);
2804         if (close(logfd) != 0 || written != len)
2805                 return error("Unable to append to %s", log_file);
2806         return 0;
2807 }
2808
2809 static int is_branch(const char *refname)
2810 {
2811         return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
2812 }
2813
2814 int write_ref_sha1(struct ref_lock *lock,
2815         const unsigned char *sha1, const char *logmsg)
2816 {
2817         static char term = '\n';
2818         struct object *o;
2819
2820         if (!lock)
2821                 return -1;
2822         if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2823                 unlock_ref(lock);
2824                 return 0;
2825         }
2826         o = parse_object(sha1);
2827         if (!o) {
2828                 error("Trying to write ref %s with nonexistent object %s",
2829                         lock->ref_name, sha1_to_hex(sha1));
2830                 unlock_ref(lock);
2831                 return -1;
2832         }
2833         if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2834                 error("Trying to write non-commit object %s to branch %s",
2835                         sha1_to_hex(sha1), lock->ref_name);
2836                 unlock_ref(lock);
2837                 return -1;
2838         }
2839         if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2840             write_in_full(lock->lock_fd, &term, 1) != 1
2841                 || close_ref(lock) < 0) {
2842                 error("Couldn't write %s", lock->lk->filename);
2843                 unlock_ref(lock);
2844                 return -1;
2845         }
2846         clear_loose_ref_cache(&ref_cache);
2847         if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2848             (strcmp(lock->ref_name, lock->orig_ref_name) &&
2849              log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2850                 unlock_ref(lock);
2851                 return -1;
2852         }
2853         if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2854                 /*
2855                  * Special hack: If a branch is updated directly and HEAD
2856                  * points to it (may happen on the remote side of a push
2857                  * for example) then logically the HEAD reflog should be
2858                  * updated too.
2859                  * A generic solution implies reverse symref information,
2860                  * but finding all symrefs pointing to the given branch
2861                  * would be rather costly for this rare event (the direct
2862                  * update of a branch) to be worth it.  So let's cheat and
2863                  * check with HEAD only which should cover 99% of all usage
2864                  * scenarios (even 100% of the default ones).
2865                  */
2866                 unsigned char head_sha1[20];
2867                 int head_flag;
2868                 const char *head_ref;
2869                 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2870                 if (head_ref && (head_flag & REF_ISSYMREF) &&
2871                     !strcmp(head_ref, lock->ref_name))
2872                         log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2873         }
2874         if (commit_ref(lock)) {
2875                 error("Couldn't set %s", lock->ref_name);
2876                 unlock_ref(lock);
2877                 return -1;
2878         }
2879         unlock_ref(lock);
2880         return 0;
2881 }
2882
2883 int create_symref(const char *ref_target, const char *refs_heads_master,
2884                   const char *logmsg)
2885 {
2886         const char *lockpath;
2887         char ref[1000];
2888         int fd, len, written;
2889         char *git_HEAD = git_pathdup("%s", ref_target);
2890         unsigned char old_sha1[20], new_sha1[20];
2891
2892         if (logmsg && read_ref(ref_target, old_sha1))
2893                 hashclr(old_sha1);
2894
2895         if (safe_create_leading_directories(git_HEAD) < 0)
2896                 return error("unable to create directory for %s", git_HEAD);
2897
2898 #ifndef NO_SYMLINK_HEAD
2899         if (prefer_symlink_refs) {
2900                 unlink(git_HEAD);
2901                 if (!symlink(refs_heads_master, git_HEAD))
2902                         goto done;
2903                 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2904         }
2905 #endif
2906
2907         len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2908         if (sizeof(ref) <= len) {
2909                 error("refname too long: %s", refs_heads_master);
2910                 goto error_free_return;
2911         }
2912         lockpath = mkpath("%s.lock", git_HEAD);
2913         fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2914         if (fd < 0) {
2915                 error("Unable to open %s for writing", lockpath);
2916                 goto error_free_return;
2917         }
2918         written = write_in_full(fd, ref, len);
2919         if (close(fd) != 0 || written != len) {
2920                 error("Unable to write to %s", lockpath);
2921                 goto error_unlink_return;
2922         }
2923         if (rename(lockpath, git_HEAD) < 0) {
2924                 error("Unable to create %s", git_HEAD);
2925                 goto error_unlink_return;
2926         }
2927         if (adjust_shared_perm(git_HEAD)) {
2928                 error("Unable to fix permissions on %s", lockpath);
2929         error_unlink_return:
2930                 unlink_or_warn(lockpath);
2931         error_free_return:
2932                 free(git_HEAD);
2933                 return -1;
2934         }
2935
2936 #ifndef NO_SYMLINK_HEAD
2937         done:
2938 #endif
2939         if (logmsg && !read_ref(refs_heads_master, new_sha1))
2940                 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2941
2942         free(git_HEAD);
2943         return 0;
2944 }
2945
2946 static char *ref_msg(const char *line, const char *endp)
2947 {
2948         const char *ep;
2949         line += 82;
2950         ep = memchr(line, '\n', endp - line);
2951         if (!ep)
2952                 ep = endp;
2953         return xmemdupz(line, ep - line);
2954 }
2955
2956 int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2957                 unsigned char *sha1, char **msg,
2958                 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2959 {
2960         const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2961         char *tz_c;
2962         int logfd, tz, reccnt = 0;
2963         struct stat st;
2964         unsigned long date;
2965         unsigned char logged_sha1[20];
2966         void *log_mapped;
2967         size_t mapsz;
2968
2969         logfile = git_path("logs/%s", refname);
2970         logfd = open(logfile, O_RDONLY, 0);
2971         if (logfd < 0)
2972                 die_errno("Unable to read log '%s'", logfile);
2973         fstat(logfd, &st);
2974         if (!st.st_size)
2975                 die("Log %s is empty.", logfile);
2976         mapsz = xsize_t(st.st_size);
2977         log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2978         logdata = log_mapped;
2979         close(logfd);
2980
2981         lastrec = NULL;
2982         rec = logend = logdata + st.st_size;
2983         while (logdata < rec) {
2984                 reccnt++;
2985                 if (logdata < rec && *(rec-1) == '\n')
2986                         rec--;
2987                 lastgt = NULL;
2988                 while (logdata < rec && *(rec-1) != '\n') {
2989                         rec--;
2990                         if (*rec == '>')
2991                                 lastgt = rec;
2992                 }
2993                 if (!lastgt)
2994                         die("Log %s is corrupt.", logfile);
2995                 date = strtoul(lastgt + 1, &tz_c, 10);
2996                 if (date <= at_time || cnt == 0) {
2997                         tz = strtoul(tz_c, NULL, 10);
2998                         if (msg)
2999                                 *msg = ref_msg(rec, logend);
3000                         if (cutoff_time)
3001                                 *cutoff_time = date;
3002                         if (cutoff_tz)
3003                                 *cutoff_tz = tz;
3004                         if (cutoff_cnt)
3005                                 *cutoff_cnt = reccnt - 1;
3006                         if (lastrec) {
3007                                 if (get_sha1_hex(lastrec, logged_sha1))
3008                                         die("Log %s is corrupt.", logfile);
3009                                 if (get_sha1_hex(rec + 41, sha1))
3010                                         die("Log %s is corrupt.", logfile);
3011                                 if (hashcmp(logged_sha1, sha1)) {
3012                                         warning("Log %s has gap after %s.",
3013                                                 logfile, show_date(date, tz, DATE_RFC2822));
3014                                 }
3015                         }
3016                         else if (date == at_time) {
3017                                 if (get_sha1_hex(rec + 41, sha1))
3018                                         die("Log %s is corrupt.", logfile);
3019                         }
3020                         else {
3021                                 if (get_sha1_hex(rec + 41, logged_sha1))
3022                                         die("Log %s is corrupt.", logfile);
3023                                 if (hashcmp(logged_sha1, sha1)) {
3024                                         warning("Log %s unexpectedly ended on %s.",
3025                                                 logfile, show_date(date, tz, DATE_RFC2822));
3026                                 }
3027                         }
3028                         munmap(log_mapped, mapsz);
3029                         return 0;
3030                 }
3031                 lastrec = rec;
3032                 if (cnt > 0)
3033                         cnt--;
3034         }
3035
3036         rec = logdata;
3037         while (rec < logend && *rec != '>' && *rec != '\n')
3038                 rec++;
3039         if (rec == logend || *rec == '\n')
3040                 die("Log %s is corrupt.", logfile);
3041         date = strtoul(rec + 1, &tz_c, 10);
3042         tz = strtoul(tz_c, NULL, 10);
3043         if (get_sha1_hex(logdata, sha1))
3044                 die("Log %s is corrupt.", logfile);
3045         if (is_null_sha1(sha1)) {
3046                 if (get_sha1_hex(logdata + 41, sha1))
3047                         die("Log %s is corrupt.", logfile);
3048         }
3049         if (msg)
3050                 *msg = ref_msg(logdata, logend);
3051         munmap(log_mapped, mapsz);
3052
3053         if (cutoff_time)
3054                 *cutoff_time = date;
3055         if (cutoff_tz)
3056                 *cutoff_tz = tz;
3057         if (cutoff_cnt)
3058                 *cutoff_cnt = reccnt;
3059         return 1;
3060 }
3061
3062 int reflog_exists(const char *refname)
3063 {
3064         struct stat st;
3065
3066         return !lstat(git_path("logs/%s", refname), &st) &&
3067                 S_ISREG(st.st_mode);
3068 }
3069
3070 int delete_reflog(const char *refname)
3071 {
3072         return remove_path(git_path("logs/%s", refname));
3073 }
3074
3075 static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
3076 {
3077         unsigned char osha1[20], nsha1[20];
3078         char *email_end, *message;
3079         unsigned long timestamp;
3080         int tz;
3081
3082         /* old SP new SP name <email> SP time TAB msg LF */
3083         if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
3084             get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
3085             get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
3086             !(email_end = strchr(sb->buf + 82, '>')) ||
3087             email_end[1] != ' ' ||
3088             !(timestamp = strtoul(email_end + 2, &message, 10)) ||
3089             !message || message[0] != ' ' ||
3090             (message[1] != '+' && message[1] != '-') ||
3091             !isdigit(message[2]) || !isdigit(message[3]) ||
3092             !isdigit(message[4]) || !isdigit(message[5]))
3093                 return 0; /* corrupt? */
3094         email_end[1] = '\0';
3095         tz = strtol(message + 1, NULL, 10);
3096         if (message[6] != '\t')
3097                 message += 6;
3098         else
3099                 message += 7;
3100         return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
3101 }
3102
3103 static char *find_beginning_of_line(char *bob, char *scan)
3104 {
3105         while (bob < scan && *(--scan) != '\n')
3106                 ; /* keep scanning backwards */
3107         /*
3108          * Return either beginning of the buffer, or LF at the end of
3109          * the previous line.
3110          */
3111         return scan;
3112 }
3113
3114 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3115 {
3116         struct strbuf sb = STRBUF_INIT;
3117         FILE *logfp;
3118         long pos;
3119         int ret = 0, at_tail = 1;
3120
3121         logfp = fopen(git_path("logs/%s", refname), "r");
3122         if (!logfp)
3123                 return -1;
3124
3125         /* Jump to the end */
3126         if (fseek(logfp, 0, SEEK_END) < 0)
3127                 return error("cannot seek back reflog for %s: %s",
3128                              refname, strerror(errno));
3129         pos = ftell(logfp);
3130         while (!ret && 0 < pos) {
3131                 int cnt;
3132                 size_t nread;
3133                 char buf[BUFSIZ];
3134                 char *endp, *scanp;
3135
3136                 /* Fill next block from the end */
3137                 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
3138                 if (fseek(logfp, pos - cnt, SEEK_SET))
3139                         return error("cannot seek back reflog for %s: %s",
3140                                      refname, strerror(errno));
3141                 nread = fread(buf, cnt, 1, logfp);
3142                 if (nread != 1)
3143                         return error("cannot read %d bytes from reflog for %s: %s",
3144                                      cnt, refname, strerror(errno));
3145                 pos -= cnt;
3146
3147                 scanp = endp = buf + cnt;
3148                 if (at_tail && scanp[-1] == '\n')
3149                         /* Looking at the final LF at the end of the file */
3150                         scanp--;
3151                 at_tail = 0;
3152
3153                 while (buf < scanp) {
3154                         /*
3155                          * terminating LF of the previous line, or the beginning
3156                          * of the buffer.
3157                          */
3158                         char *bp;
3159
3160                         bp = find_beginning_of_line(buf, scanp);
3161
3162                         if (*bp != '\n') {
3163                                 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3164                                 if (pos)
3165                                         break; /* need to fill another block */
3166                                 scanp = buf - 1; /* leave loop */
3167                         } else {
3168                                 /*
3169                                  * (bp + 1) thru endp is the beginning of the
3170                                  * current line we have in sb
3171                                  */
3172                                 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
3173                                 scanp = bp;
3174                                 endp = bp + 1;
3175                         }
3176                         ret = show_one_reflog_ent(&sb, fn, cb_data);
3177                         strbuf_reset(&sb);
3178                         if (ret)
3179                                 break;
3180                 }
3181
3182         }
3183         if (!ret && sb.len)
3184                 ret = show_one_reflog_ent(&sb, fn, cb_data);
3185
3186         fclose(logfp);
3187         strbuf_release(&sb);
3188         return ret;
3189 }
3190
3191 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3192 {
3193         FILE *logfp;
3194         struct strbuf sb = STRBUF_INIT;
3195         int ret = 0;
3196
3197         logfp = fopen(git_path("logs/%s", refname), "r");
3198         if (!logfp)
3199                 return -1;
3200
3201         while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
3202                 ret = show_one_reflog_ent(&sb, fn, cb_data);
3203         fclose(logfp);
3204         strbuf_release(&sb);
3205         return ret;
3206 }
3207 /*
3208  * Call fn for each reflog in the namespace indicated by name.  name
3209  * must be empty or end with '/'.  Name will be used as a scratch
3210  * space, but its contents will be restored before return.
3211  */
3212 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
3213 {
3214         DIR *d = opendir(git_path("logs/%s", name->buf));
3215         int retval = 0;
3216         struct dirent *de;
3217         int oldlen = name->len;
3218
3219         if (!d)
3220                 return name->len ? errno : 0;
3221
3222         while ((de = readdir(d)) != NULL) {
3223                 struct stat st;
3224
3225                 if (de->d_name[0] == '.')
3226                         continue;
3227                 if (has_extension(de->d_name, ".lock"))
3228                         continue;
3229                 strbuf_addstr(name, de->d_name);
3230                 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
3231                         ; /* silently ignore */
3232                 } else {
3233                         if (S_ISDIR(st.st_mode)) {
3234                                 strbuf_addch(name, '/');
3235                                 retval = do_for_each_reflog(name, fn, cb_data);
3236                         } else {
3237                                 unsigned char sha1[20];
3238                                 if (read_ref_full(name->buf, sha1, 0, NULL))
3239                                         retval = error("bad ref for %s", name->buf);
3240                                 else
3241                                         retval = fn(name->buf, sha1, 0, cb_data);
3242                         }
3243                         if (retval)
3244                                 break;
3245                 }
3246                 strbuf_setlen(name, oldlen);
3247         }
3248         closedir(d);
3249         return retval;
3250 }
3251
3252 int for_each_reflog(each_ref_fn fn, void *cb_data)
3253 {
3254         int retval;
3255         struct strbuf name;
3256         strbuf_init(&name, PATH_MAX);
3257         retval = do_for_each_reflog(&name, fn, cb_data);
3258         strbuf_release(&name);
3259         return retval;
3260 }
3261
3262 static struct ref_lock *update_ref_lock(const char *refname,
3263                                         const unsigned char *oldval,
3264                                         int flags, int *type_p,
3265                                         enum action_on_err onerr)
3266 {
3267         struct ref_lock *lock;
3268         lock = lock_any_ref_for_update(refname, oldval, flags, type_p);
3269         if (!lock) {
3270                 const char *str = "Cannot lock the ref '%s'.";
3271                 switch (onerr) {
3272                 case UPDATE_REFS_MSG_ON_ERR: error(str, refname); break;
3273                 case UPDATE_REFS_DIE_ON_ERR: die(str, refname); break;
3274                 case UPDATE_REFS_QUIET_ON_ERR: break;
3275                 }
3276         }
3277         return lock;
3278 }
3279
3280 static int update_ref_write(const char *action, const char *refname,
3281                             const unsigned char *sha1, struct ref_lock *lock,
3282                             enum action_on_err onerr)
3283 {
3284         if (write_ref_sha1(lock, sha1, action) < 0) {
3285                 const char *str = "Cannot update the ref '%s'.";
3286                 switch (onerr) {
3287                 case UPDATE_REFS_MSG_ON_ERR: error(str, refname); break;
3288                 case UPDATE_REFS_DIE_ON_ERR: die(str, refname); break;
3289                 case UPDATE_REFS_QUIET_ON_ERR: break;
3290                 }
3291                 return 1;
3292         }
3293         return 0;
3294 }
3295
3296 /**
3297  * Information needed for a single ref update.  Set new_sha1 to the
3298  * new value or to zero to delete the ref.  To check the old value
3299  * while locking the ref, set have_old to 1 and set old_sha1 to the
3300  * value or to zero to ensure the ref does not exist before update.
3301  */
3302 struct ref_update {
3303         unsigned char new_sha1[20];
3304         unsigned char old_sha1[20];
3305         int flags; /* REF_NODEREF? */
3306         int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
3307         struct ref_lock *lock;
3308         int type;
3309         const char refname[FLEX_ARRAY];
3310 };
3311
3312 /*
3313  * Data structure for holding a reference transaction, which can
3314  * consist of checks and updates to multiple references, carried out
3315  * as atomically as possible.  This structure is opaque to callers.
3316  */
3317 struct ref_transaction {
3318         struct ref_update **updates;
3319         size_t alloc;
3320         size_t nr;
3321 };
3322
3323 struct ref_transaction *ref_transaction_begin(void)
3324 {
3325         return xcalloc(1, sizeof(struct ref_transaction));
3326 }
3327
3328 static void ref_transaction_free(struct ref_transaction *transaction)
3329 {
3330         int i;
3331
3332         for (i = 0; i < transaction->nr; i++)
3333                 free(transaction->updates[i]);
3334
3335         free(transaction->updates);
3336         free(transaction);
3337 }
3338
3339 void ref_transaction_rollback(struct ref_transaction *transaction)
3340 {
3341         ref_transaction_free(transaction);
3342 }
3343
3344 static struct ref_update *add_update(struct ref_transaction *transaction,
3345                                      const char *refname)
3346 {
3347         size_t len = strlen(refname);
3348         struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);
3349
3350         strcpy((char *)update->refname, refname);
3351         ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
3352         transaction->updates[transaction->nr++] = update;
3353         return update;
3354 }
3355
3356 void ref_transaction_update(struct ref_transaction *transaction,
3357                             const char *refname,
3358                             unsigned char *new_sha1, unsigned char *old_sha1,
3359                             int flags, int have_old)
3360 {
3361         struct ref_update *update = add_update(transaction, refname);
3362
3363         hashcpy(update->new_sha1, new_sha1);
3364         update->flags = flags;
3365         update->have_old = have_old;
3366         if (have_old)
3367                 hashcpy(update->old_sha1, old_sha1);
3368 }
3369
3370 void ref_transaction_create(struct ref_transaction *transaction,
3371                             const char *refname,
3372                             unsigned char *new_sha1,
3373                             int flags)
3374 {
3375         struct ref_update *update = add_update(transaction, refname);
3376
3377         assert(!is_null_sha1(new_sha1));
3378         hashcpy(update->new_sha1, new_sha1);
3379         hashclr(update->old_sha1);
3380         update->flags = flags;
3381         update->have_old = 1;
3382 }
3383
3384 void ref_transaction_delete(struct ref_transaction *transaction,
3385                             const char *refname,
3386                             unsigned char *old_sha1,
3387                             int flags, int have_old)
3388 {
3389         struct ref_update *update = add_update(transaction, refname);
3390
3391         update->flags = flags;
3392         update->have_old = have_old;
3393         if (have_old) {
3394                 assert(!is_null_sha1(old_sha1));
3395                 hashcpy(update->old_sha1, old_sha1);
3396         }
3397 }
3398
3399 int update_ref(const char *action, const char *refname,
3400                const unsigned char *sha1, const unsigned char *oldval,
3401                int flags, enum action_on_err onerr)
3402 {
3403         struct ref_lock *lock;
3404         lock = update_ref_lock(refname, oldval, flags, NULL, onerr);
3405         if (!lock)
3406                 return 1;
3407         return update_ref_write(action, refname, sha1, lock, onerr);
3408 }
3409
3410 static int ref_update_compare(const void *r1, const void *r2)
3411 {
3412         const struct ref_update * const *u1 = r1;
3413         const struct ref_update * const *u2 = r2;
3414         return strcmp((*u1)->refname, (*u2)->refname);
3415 }
3416
3417 static int ref_update_reject_duplicates(struct ref_update **updates, int n,
3418                                         enum action_on_err onerr)
3419 {
3420         int i;
3421         for (i = 1; i < n; i++)
3422                 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {
3423                         const char *str =
3424                                 "Multiple updates for ref '%s' not allowed.";
3425                         switch (onerr) {
3426                         case UPDATE_REFS_MSG_ON_ERR:
3427                                 error(str, updates[i]->refname); break;
3428                         case UPDATE_REFS_DIE_ON_ERR:
3429                                 die(str, updates[i]->refname); break;
3430                         case UPDATE_REFS_QUIET_ON_ERR:
3431                                 break;
3432                         }
3433                         return 1;
3434                 }
3435         return 0;
3436 }
3437
3438 int ref_transaction_commit(struct ref_transaction *transaction,
3439                            const char *msg, enum action_on_err onerr)
3440 {
3441         int ret = 0, delnum = 0, i;
3442         const char **delnames;
3443         int n = transaction->nr;
3444         struct ref_update **updates = transaction->updates;
3445
3446         if (!n)
3447                 return 0;
3448
3449         /* Allocate work space */
3450         delnames = xmalloc(sizeof(*delnames) * n);
3451
3452         /* Copy, sort, and reject duplicate refs */
3453         qsort(updates, n, sizeof(*updates), ref_update_compare);
3454         ret = ref_update_reject_duplicates(updates, n, onerr);
3455         if (ret)
3456                 goto cleanup;
3457
3458         /* Acquire all locks while verifying old values */
3459         for (i = 0; i < n; i++) {
3460                 struct ref_update *update = updates[i];
3461
3462                 update->lock = update_ref_lock(update->refname,
3463                                                (update->have_old ?
3464                                                 update->old_sha1 : NULL),
3465                                                update->flags,
3466                                                &update->type, onerr);
3467                 if (!update->lock) {
3468                         ret = 1;
3469                         goto cleanup;
3470                 }
3471         }
3472
3473         /* Perform updates first so live commits remain referenced */
3474         for (i = 0; i < n; i++) {
3475                 struct ref_update *update = updates[i];
3476
3477                 if (!is_null_sha1(update->new_sha1)) {
3478                         ret = update_ref_write(msg,
3479                                                update->refname,
3480                                                update->new_sha1,
3481                                                update->lock, onerr);
3482                         update->lock = NULL; /* freed by update_ref_write */
3483                         if (ret)
3484                                 goto cleanup;
3485                 }
3486         }
3487
3488         /* Perform deletes now that updates are safely completed */
3489         for (i = 0; i < n; i++) {
3490                 struct ref_update *update = updates[i];
3491
3492                 if (update->lock) {
3493                         delnames[delnum++] = update->lock->ref_name;
3494                         ret |= delete_ref_loose(update->lock, update->type);
3495                 }
3496         }
3497
3498         ret |= repack_without_refs(delnames, delnum);
3499         for (i = 0; i < delnum; i++)
3500                 unlink_or_warn(git_path("logs/%s", delnames[i]));
3501         clear_loose_ref_cache(&ref_cache);
3502
3503 cleanup:
3504         for (i = 0; i < n; i++)
3505                 if (updates[i]->lock)
3506                         unlock_ref(updates[i]->lock);
3507         free(delnames);
3508         ref_transaction_free(transaction);
3509         return ret;
3510 }
3511
3512 char *shorten_unambiguous_ref(const char *refname, int strict)
3513 {
3514         int i;
3515         static char **scanf_fmts;
3516         static int nr_rules;
3517         char *short_name;
3518
3519         if (!nr_rules) {
3520                 /*
3521                  * Pre-generate scanf formats from ref_rev_parse_rules[].
3522                  * Generate a format suitable for scanf from a
3523                  * ref_rev_parse_rules rule by interpolating "%s" at the
3524                  * location of the "%.*s".
3525                  */
3526                 size_t total_len = 0;
3527                 size_t offset = 0;
3528
3529                 /* the rule list is NULL terminated, count them first */
3530                 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
3531                         /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3532                         total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
3533
3534                 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
3535
3536                 offset = 0;
3537                 for (i = 0; i < nr_rules; i++) {
3538                         assert(offset < total_len);
3539                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
3540                         offset += snprintf(scanf_fmts[i], total_len - offset,
3541                                            ref_rev_parse_rules[i], 2, "%s") + 1;
3542                 }
3543         }
3544
3545         /* bail out if there are no rules */
3546         if (!nr_rules)
3547                 return xstrdup(refname);
3548
3549         /* buffer for scanf result, at most refname must fit */
3550         short_name = xstrdup(refname);
3551
3552         /* skip first rule, it will always match */
3553         for (i = nr_rules - 1; i > 0 ; --i) {
3554                 int j;
3555                 int rules_to_fail = i;
3556                 int short_name_len;
3557
3558                 if (1 != sscanf(refname, scanf_fmts[i], short_name))
3559                         continue;
3560
3561                 short_name_len = strlen(short_name);
3562
3563                 /*
3564                  * in strict mode, all (except the matched one) rules
3565                  * must fail to resolve to a valid non-ambiguous ref
3566                  */
3567                 if (strict)
3568                         rules_to_fail = nr_rules;
3569
3570                 /*
3571                  * check if the short name resolves to a valid ref,
3572                  * but use only rules prior to the matched one
3573                  */
3574                 for (j = 0; j < rules_to_fail; j++) {
3575                         const char *rule = ref_rev_parse_rules[j];
3576                         char refname[PATH_MAX];
3577
3578                         /* skip matched rule */
3579                         if (i == j)
3580                                 continue;
3581
3582                         /*
3583                          * the short name is ambiguous, if it resolves
3584                          * (with this previous rule) to a valid ref
3585                          * read_ref() returns 0 on success
3586                          */
3587                         mksnpath(refname, sizeof(refname),
3588                                  rule, short_name_len, short_name);
3589                         if (ref_exists(refname))
3590                                 break;
3591                 }
3592
3593                 /*
3594                  * short name is non-ambiguous if all previous rules
3595                  * haven't resolved to a valid ref
3596                  */
3597                 if (j == rules_to_fail)
3598                         return short_name;
3599         }
3600
3601         free(short_name);
3602         return xstrdup(refname);
3603 }
3604
3605 static struct string_list *hide_refs;
3606
3607 int parse_hide_refs_config(const char *var, const char *value, const char *section)
3608 {
3609         if (!strcmp("transfer.hiderefs", var) ||
3610             /* NEEDSWORK: use parse_config_key() once both are merged */
3611             (starts_with(var, section) && var[strlen(section)] == '.' &&
3612              !strcmp(var + strlen(section), ".hiderefs"))) {
3613                 char *ref;
3614                 int len;
3615
3616                 if (!value)
3617                         return config_error_nonbool(var);
3618                 ref = xstrdup(value);
3619                 len = strlen(ref);
3620                 while (len && ref[len - 1] == '/')
3621                         ref[--len] = '\0';
3622                 if (!hide_refs) {
3623                         hide_refs = xcalloc(1, sizeof(*hide_refs));
3624                         hide_refs->strdup_strings = 1;
3625                 }
3626                 string_list_append(hide_refs, ref);
3627         }
3628         return 0;
3629 }
3630
3631 int ref_is_hidden(const char *refname)
3632 {
3633         struct string_list_item *item;
3634
3635         if (!hide_refs)
3636                 return 0;
3637         for_each_string_list_item(item, hide_refs) {
3638                 int len;
3639                 if (!starts_with(refname, item->string))
3640                         continue;
3641                 len = strlen(item->string);
3642                 if (!refname[len] || refname[len] == '/')
3643                         return 1;
3644         }
3645         return 0;
3646 }