refs: wrap the packed refs cache in a level of indirection
[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         int retval;
638         if (prefixcmp(entry->name, data->base))
639                 return 0;
640
641         if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
642               !ref_resolves_to_object(entry))
643                 return 0;
644
645         current_ref = entry;
646         retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
647                           entry->flag, data->cb_data);
648         current_ref = NULL;
649         return retval;
650 }
651
652 /*
653  * Call fn for each reference in dir that has index in the range
654  * offset <= index < dir->nr.  Recurse into subdirectories that are in
655  * that index range, sorting them before iterating.  This function
656  * does not sort dir itself; it should be sorted beforehand.  fn is
657  * called for all references, including broken ones.
658  */
659 static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
660                                     each_ref_entry_fn fn, void *cb_data)
661 {
662         int i;
663         assert(dir->sorted == dir->nr);
664         for (i = offset; i < dir->nr; i++) {
665                 struct ref_entry *entry = dir->entries[i];
666                 int retval;
667                 if (entry->flag & REF_DIR) {
668                         struct ref_dir *subdir = get_ref_dir(entry);
669                         sort_ref_dir(subdir);
670                         retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
671                 } else {
672                         retval = fn(entry, cb_data);
673                 }
674                 if (retval)
675                         return retval;
676         }
677         return 0;
678 }
679
680 /*
681  * Call fn for each reference in the union of dir1 and dir2, in order
682  * by refname.  Recurse into subdirectories.  If a value entry appears
683  * in both dir1 and dir2, then only process the version that is in
684  * dir2.  The input dirs must already be sorted, but subdirs will be
685  * sorted as needed.  fn is called for all references, including
686  * broken ones.
687  */
688 static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
689                                      struct ref_dir *dir2,
690                                      each_ref_entry_fn fn, void *cb_data)
691 {
692         int retval;
693         int i1 = 0, i2 = 0;
694
695         assert(dir1->sorted == dir1->nr);
696         assert(dir2->sorted == dir2->nr);
697         while (1) {
698                 struct ref_entry *e1, *e2;
699                 int cmp;
700                 if (i1 == dir1->nr) {
701                         return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
702                 }
703                 if (i2 == dir2->nr) {
704                         return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
705                 }
706                 e1 = dir1->entries[i1];
707                 e2 = dir2->entries[i2];
708                 cmp = strcmp(e1->name, e2->name);
709                 if (cmp == 0) {
710                         if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
711                                 /* Both are directories; descend them in parallel. */
712                                 struct ref_dir *subdir1 = get_ref_dir(e1);
713                                 struct ref_dir *subdir2 = get_ref_dir(e2);
714                                 sort_ref_dir(subdir1);
715                                 sort_ref_dir(subdir2);
716                                 retval = do_for_each_entry_in_dirs(
717                                                 subdir1, subdir2, fn, cb_data);
718                                 i1++;
719                                 i2++;
720                         } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
721                                 /* Both are references; ignore the one from dir1. */
722                                 retval = fn(e2, cb_data);
723                                 i1++;
724                                 i2++;
725                         } else {
726                                 die("conflict between reference and directory: %s",
727                                     e1->name);
728                         }
729                 } else {
730                         struct ref_entry *e;
731                         if (cmp < 0) {
732                                 e = e1;
733                                 i1++;
734                         } else {
735                                 e = e2;
736                                 i2++;
737                         }
738                         if (e->flag & REF_DIR) {
739                                 struct ref_dir *subdir = get_ref_dir(e);
740                                 sort_ref_dir(subdir);
741                                 retval = do_for_each_entry_in_dir(
742                                                 subdir, 0, fn, cb_data);
743                         } else {
744                                 retval = fn(e, cb_data);
745                         }
746                 }
747                 if (retval)
748                         return retval;
749         }
750 }
751
752 /*
753  * Return true iff refname1 and refname2 conflict with each other.
754  * Two reference names conflict if one of them exactly matches the
755  * leading components of the other; e.g., "foo/bar" conflicts with
756  * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
757  * "foo/barbados".
758  */
759 static int names_conflict(const char *refname1, const char *refname2)
760 {
761         for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
762                 ;
763         return (*refname1 == '\0' && *refname2 == '/')
764                 || (*refname1 == '/' && *refname2 == '\0');
765 }
766
767 struct name_conflict_cb {
768         const char *refname;
769         const char *oldrefname;
770         const char *conflicting_refname;
771 };
772
773 static int name_conflict_fn(struct ref_entry *entry, void *cb_data)
774 {
775         struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
776         if (data->oldrefname && !strcmp(data->oldrefname, entry->name))
777                 return 0;
778         if (names_conflict(data->refname, entry->name)) {
779                 data->conflicting_refname = entry->name;
780                 return 1;
781         }
782         return 0;
783 }
784
785 /*
786  * Return true iff a reference named refname could be created without
787  * conflicting with the name of an existing reference in dir.  If
788  * oldrefname is non-NULL, ignore potential conflicts with oldrefname
789  * (e.g., because oldrefname is scheduled for deletion in the same
790  * operation).
791  */
792 static int is_refname_available(const char *refname, const char *oldrefname,
793                                 struct ref_dir *dir)
794 {
795         struct name_conflict_cb data;
796         data.refname = refname;
797         data.oldrefname = oldrefname;
798         data.conflicting_refname = NULL;
799
800         sort_ref_dir(dir);
801         if (do_for_each_entry_in_dir(dir, 0, name_conflict_fn, &data)) {
802                 error("'%s' exists; cannot create '%s'",
803                       data.conflicting_refname, refname);
804                 return 0;
805         }
806         return 1;
807 }
808
809 struct packed_ref_cache {
810         struct ref_entry *root;
811 };
812
813 /*
814  * Future: need to be in "struct repository"
815  * when doing a full libification.
816  */
817 static struct ref_cache {
818         struct ref_cache *next;
819         struct ref_entry *loose;
820         struct packed_ref_cache *packed;
821         /*
822          * The submodule name, or "" for the main repo.  We allocate
823          * length 1 rather than FLEX_ARRAY so that the main ref_cache
824          * is initialized correctly.
825          */
826         char name[1];
827 } ref_cache, *submodule_ref_caches;
828
829 static void clear_packed_ref_cache(struct ref_cache *refs)
830 {
831         if (refs->packed) {
832                 free_ref_entry(refs->packed->root);
833                 free(refs->packed);
834                 refs->packed = NULL;
835         }
836 }
837
838 static void clear_loose_ref_cache(struct ref_cache *refs)
839 {
840         if (refs->loose) {
841                 free_ref_entry(refs->loose);
842                 refs->loose = NULL;
843         }
844 }
845
846 static struct ref_cache *create_ref_cache(const char *submodule)
847 {
848         int len;
849         struct ref_cache *refs;
850         if (!submodule)
851                 submodule = "";
852         len = strlen(submodule) + 1;
853         refs = xcalloc(1, sizeof(struct ref_cache) + len);
854         memcpy(refs->name, submodule, len);
855         return refs;
856 }
857
858 /*
859  * Return a pointer to a ref_cache for the specified submodule. For
860  * the main repository, use submodule==NULL. The returned structure
861  * will be allocated and initialized but not necessarily populated; it
862  * should not be freed.
863  */
864 static struct ref_cache *get_ref_cache(const char *submodule)
865 {
866         struct ref_cache *refs;
867
868         if (!submodule || !*submodule)
869                 return &ref_cache;
870
871         for (refs = submodule_ref_caches; refs; refs = refs->next)
872                 if (!strcmp(submodule, refs->name))
873                         return refs;
874
875         refs = create_ref_cache(submodule);
876         refs->next = submodule_ref_caches;
877         submodule_ref_caches = refs;
878         return refs;
879 }
880
881 void invalidate_ref_cache(const char *submodule)
882 {
883         struct ref_cache *refs = get_ref_cache(submodule);
884         clear_packed_ref_cache(refs);
885         clear_loose_ref_cache(refs);
886 }
887
888 /* The length of a peeled reference line in packed-refs, including EOL: */
889 #define PEELED_LINE_LENGTH 42
890
891 /*
892  * The packed-refs header line that we write out.  Perhaps other
893  * traits will be added later.  The trailing space is required.
894  */
895 static const char PACKED_REFS_HEADER[] =
896         "# pack-refs with: peeled fully-peeled \n";
897
898 /*
899  * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
900  * Return a pointer to the refname within the line (null-terminated),
901  * or NULL if there was a problem.
902  */
903 static const char *parse_ref_line(char *line, unsigned char *sha1)
904 {
905         /*
906          * 42: the answer to everything.
907          *
908          * In this case, it happens to be the answer to
909          *  40 (length of sha1 hex representation)
910          *  +1 (space in between hex and name)
911          *  +1 (newline at the end of the line)
912          */
913         int len = strlen(line) - 42;
914
915         if (len <= 0)
916                 return NULL;
917         if (get_sha1_hex(line, sha1) < 0)
918                 return NULL;
919         if (!isspace(line[40]))
920                 return NULL;
921         line += 41;
922         if (isspace(*line))
923                 return NULL;
924         if (line[len] != '\n')
925                 return NULL;
926         line[len] = 0;
927
928         return line;
929 }
930
931 /*
932  * Read f, which is a packed-refs file, into dir.
933  *
934  * A comment line of the form "# pack-refs with: " may contain zero or
935  * more traits. We interpret the traits as follows:
936  *
937  *   No traits:
938  *
939  *      Probably no references are peeled. But if the file contains a
940  *      peeled value for a reference, we will use it.
941  *
942  *   peeled:
943  *
944  *      References under "refs/tags/", if they *can* be peeled, *are*
945  *      peeled in this file. References outside of "refs/tags/" are
946  *      probably not peeled even if they could have been, but if we find
947  *      a peeled value for such a reference we will use it.
948  *
949  *   fully-peeled:
950  *
951  *      All references in the file that can be peeled are peeled.
952  *      Inversely (and this is more important), any references in the
953  *      file for which no peeled value is recorded is not peelable. This
954  *      trait should typically be written alongside "peeled" for
955  *      compatibility with older clients, but we do not require it
956  *      (i.e., "peeled" is a no-op if "fully-peeled" is set).
957  */
958 static void read_packed_refs(FILE *f, struct ref_dir *dir)
959 {
960         struct ref_entry *last = NULL;
961         char refline[PATH_MAX];
962         enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
963
964         while (fgets(refline, sizeof(refline), f)) {
965                 unsigned char sha1[20];
966                 const char *refname;
967                 static const char header[] = "# pack-refs with:";
968
969                 if (!strncmp(refline, header, sizeof(header)-1)) {
970                         const char *traits = refline + sizeof(header) - 1;
971                         if (strstr(traits, " fully-peeled "))
972                                 peeled = PEELED_FULLY;
973                         else if (strstr(traits, " peeled "))
974                                 peeled = PEELED_TAGS;
975                         /* perhaps other traits later as well */
976                         continue;
977                 }
978
979                 refname = parse_ref_line(refline, sha1);
980                 if (refname) {
981                         last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
982                         if (peeled == PEELED_FULLY ||
983                             (peeled == PEELED_TAGS && !prefixcmp(refname, "refs/tags/")))
984                                 last->flag |= REF_KNOWS_PEELED;
985                         add_ref(dir, last);
986                         continue;
987                 }
988                 if (last &&
989                     refline[0] == '^' &&
990                     strlen(refline) == PEELED_LINE_LENGTH &&
991                     refline[PEELED_LINE_LENGTH - 1] == '\n' &&
992                     !get_sha1_hex(refline + 1, sha1)) {
993                         hashcpy(last->u.value.peeled, sha1);
994                         /*
995                          * Regardless of what the file header said,
996                          * we definitely know the value of *this*
997                          * reference:
998                          */
999                         last->flag |= REF_KNOWS_PEELED;
1000                 }
1001         }
1002 }
1003
1004 /*
1005  * Get the packed_ref_cache for the specified ref_cache, creating it
1006  * if necessary.
1007  */
1008 static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1009 {
1010         if (!refs->packed) {
1011                 const char *packed_refs_file;
1012                 FILE *f;
1013
1014                 refs->packed = xcalloc(1, sizeof(*refs->packed));
1015                 refs->packed->root = create_dir_entry(refs, "", 0, 0);
1016                 if (*refs->name)
1017                         packed_refs_file = git_path_submodule(refs->name, "packed-refs");
1018                 else
1019                         packed_refs_file = git_path("packed-refs");
1020                 f = fopen(packed_refs_file, "r");
1021                 if (f) {
1022                         read_packed_refs(f, get_ref_dir(refs->packed->root));
1023                         fclose(f);
1024                 }
1025         }
1026         return refs->packed;
1027 }
1028
1029 static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1030 {
1031         return get_ref_dir(packed_ref_cache->root);
1032 }
1033
1034 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1035 {
1036         return get_packed_ref_dir(get_packed_ref_cache(refs));
1037 }
1038
1039 void add_packed_ref(const char *refname, const unsigned char *sha1)
1040 {
1041         add_ref(get_packed_refs(&ref_cache),
1042                 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1043 }
1044
1045 /*
1046  * Read the loose references from the namespace dirname into dir
1047  * (without recursing).  dirname must end with '/'.  dir must be the
1048  * directory entry corresponding to dirname.
1049  */
1050 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1051 {
1052         struct ref_cache *refs = dir->ref_cache;
1053         DIR *d;
1054         const char *path;
1055         struct dirent *de;
1056         int dirnamelen = strlen(dirname);
1057         struct strbuf refname;
1058
1059         if (*refs->name)
1060                 path = git_path_submodule(refs->name, "%s", dirname);
1061         else
1062                 path = git_path("%s", dirname);
1063
1064         d = opendir(path);
1065         if (!d)
1066                 return;
1067
1068         strbuf_init(&refname, dirnamelen + 257);
1069         strbuf_add(&refname, dirname, dirnamelen);
1070
1071         while ((de = readdir(d)) != NULL) {
1072                 unsigned char sha1[20];
1073                 struct stat st;
1074                 int flag;
1075                 const char *refdir;
1076
1077                 if (de->d_name[0] == '.')
1078                         continue;
1079                 if (has_extension(de->d_name, ".lock"))
1080                         continue;
1081                 strbuf_addstr(&refname, de->d_name);
1082                 refdir = *refs->name
1083                         ? git_path_submodule(refs->name, "%s", refname.buf)
1084                         : git_path("%s", refname.buf);
1085                 if (stat(refdir, &st) < 0) {
1086                         ; /* silently ignore */
1087                 } else if (S_ISDIR(st.st_mode)) {
1088                         strbuf_addch(&refname, '/');
1089                         add_entry_to_dir(dir,
1090                                          create_dir_entry(refs, refname.buf,
1091                                                           refname.len, 1));
1092                 } else {
1093                         if (*refs->name) {
1094                                 hashclr(sha1);
1095                                 flag = 0;
1096                                 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1097                                         hashclr(sha1);
1098                                         flag |= REF_ISBROKEN;
1099                                 }
1100                         } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
1101                                 hashclr(sha1);
1102                                 flag |= REF_ISBROKEN;
1103                         }
1104                         add_entry_to_dir(dir,
1105                                          create_ref_entry(refname.buf, sha1, flag, 1));
1106                 }
1107                 strbuf_setlen(&refname, dirnamelen);
1108         }
1109         strbuf_release(&refname);
1110         closedir(d);
1111 }
1112
1113 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1114 {
1115         if (!refs->loose) {
1116                 /*
1117                  * Mark the top-level directory complete because we
1118                  * are about to read the only subdirectory that can
1119                  * hold references:
1120                  */
1121                 refs->loose = create_dir_entry(refs, "", 0, 0);
1122                 /*
1123                  * Create an incomplete entry for "refs/":
1124                  */
1125                 add_entry_to_dir(get_ref_dir(refs->loose),
1126                                  create_dir_entry(refs, "refs/", 5, 1));
1127         }
1128         return get_ref_dir(refs->loose);
1129 }
1130
1131 /* We allow "recursive" symbolic refs. Only within reason, though */
1132 #define MAXDEPTH 5
1133 #define MAXREFLEN (1024)
1134
1135 /*
1136  * Called by resolve_gitlink_ref_recursive() after it failed to read
1137  * from the loose refs in ref_cache refs. Find <refname> in the
1138  * packed-refs file for the submodule.
1139  */
1140 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1141                                       const char *refname, unsigned char *sha1)
1142 {
1143         struct ref_entry *ref;
1144         struct ref_dir *dir = get_packed_refs(refs);
1145
1146         ref = find_ref(dir, refname);
1147         if (ref == NULL)
1148                 return -1;
1149
1150         memcpy(sha1, ref->u.value.sha1, 20);
1151         return 0;
1152 }
1153
1154 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1155                                          const char *refname, unsigned char *sha1,
1156                                          int recursion)
1157 {
1158         int fd, len;
1159         char buffer[128], *p;
1160         char *path;
1161
1162         if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1163                 return -1;
1164         path = *refs->name
1165                 ? git_path_submodule(refs->name, "%s", refname)
1166                 : git_path("%s", refname);
1167         fd = open(path, O_RDONLY);
1168         if (fd < 0)
1169                 return resolve_gitlink_packed_ref(refs, refname, sha1);
1170
1171         len = read(fd, buffer, sizeof(buffer)-1);
1172         close(fd);
1173         if (len < 0)
1174                 return -1;
1175         while (len && isspace(buffer[len-1]))
1176                 len--;
1177         buffer[len] = 0;
1178
1179         /* Was it a detached head or an old-fashioned symlink? */
1180         if (!get_sha1_hex(buffer, sha1))
1181                 return 0;
1182
1183         /* Symref? */
1184         if (strncmp(buffer, "ref:", 4))
1185                 return -1;
1186         p = buffer + 4;
1187         while (isspace(*p))
1188                 p++;
1189
1190         return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1191 }
1192
1193 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1194 {
1195         int len = strlen(path), retval;
1196         char *submodule;
1197         struct ref_cache *refs;
1198
1199         while (len && path[len-1] == '/')
1200                 len--;
1201         if (!len)
1202                 return -1;
1203         submodule = xstrndup(path, len);
1204         refs = get_ref_cache(submodule);
1205         free(submodule);
1206
1207         retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1208         return retval;
1209 }
1210
1211 /*
1212  * Return the ref_entry for the given refname from the packed
1213  * references.  If it does not exist, return NULL.
1214  */
1215 static struct ref_entry *get_packed_ref(const char *refname)
1216 {
1217         return find_ref(get_packed_refs(&ref_cache), refname);
1218 }
1219
1220 const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1221 {
1222         int depth = MAXDEPTH;
1223         ssize_t len;
1224         char buffer[256];
1225         static char refname_buffer[256];
1226
1227         if (flag)
1228                 *flag = 0;
1229
1230         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1231                 return NULL;
1232
1233         for (;;) {
1234                 char path[PATH_MAX];
1235                 struct stat st;
1236                 char *buf;
1237                 int fd;
1238
1239                 if (--depth < 0)
1240                         return NULL;
1241
1242                 git_snpath(path, sizeof(path), "%s", refname);
1243
1244                 if (lstat(path, &st) < 0) {
1245                         struct ref_entry *entry;
1246
1247                         if (errno != ENOENT)
1248                                 return NULL;
1249                         /*
1250                          * The loose reference file does not exist;
1251                          * check for a packed reference.
1252                          */
1253                         entry = get_packed_ref(refname);
1254                         if (entry) {
1255                                 hashcpy(sha1, entry->u.value.sha1);
1256                                 if (flag)
1257                                         *flag |= REF_ISPACKED;
1258                                 return refname;
1259                         }
1260                         /* The reference is not a packed reference, either. */
1261                         if (reading) {
1262                                 return NULL;
1263                         } else {
1264                                 hashclr(sha1);
1265                                 return refname;
1266                         }
1267                 }
1268
1269                 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1270                 if (S_ISLNK(st.st_mode)) {
1271                         len = readlink(path, buffer, sizeof(buffer)-1);
1272                         if (len < 0)
1273                                 return NULL;
1274                         buffer[len] = 0;
1275                         if (!prefixcmp(buffer, "refs/") &&
1276                                         !check_refname_format(buffer, 0)) {
1277                                 strcpy(refname_buffer, buffer);
1278                                 refname = refname_buffer;
1279                                 if (flag)
1280                                         *flag |= REF_ISSYMREF;
1281                                 continue;
1282                         }
1283                 }
1284
1285                 /* Is it a directory? */
1286                 if (S_ISDIR(st.st_mode)) {
1287                         errno = EISDIR;
1288                         return NULL;
1289                 }
1290
1291                 /*
1292                  * Anything else, just open it and try to use it as
1293                  * a ref
1294                  */
1295                 fd = open(path, O_RDONLY);
1296                 if (fd < 0)
1297                         return NULL;
1298                 len = read_in_full(fd, buffer, sizeof(buffer)-1);
1299                 close(fd);
1300                 if (len < 0)
1301                         return NULL;
1302                 while (len && isspace(buffer[len-1]))
1303                         len--;
1304                 buffer[len] = '\0';
1305
1306                 /*
1307                  * Is it a symbolic ref?
1308                  */
1309                 if (prefixcmp(buffer, "ref:"))
1310                         break;
1311                 if (flag)
1312                         *flag |= REF_ISSYMREF;
1313                 buf = buffer + 4;
1314                 while (isspace(*buf))
1315                         buf++;
1316                 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1317                         if (flag)
1318                                 *flag |= REF_ISBROKEN;
1319                         return NULL;
1320                 }
1321                 refname = strcpy(refname_buffer, buf);
1322         }
1323         /* Please note that FETCH_HEAD has a second line containing other data. */
1324         if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1325                 if (flag)
1326                         *flag |= REF_ISBROKEN;
1327                 return NULL;
1328         }
1329         return refname;
1330 }
1331
1332 char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1333 {
1334         const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1335         return ret ? xstrdup(ret) : NULL;
1336 }
1337
1338 /* The argument to filter_refs */
1339 struct ref_filter {
1340         const char *pattern;
1341         each_ref_fn *fn;
1342         void *cb_data;
1343 };
1344
1345 int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1346 {
1347         if (resolve_ref_unsafe(refname, sha1, reading, flags))
1348                 return 0;
1349         return -1;
1350 }
1351
1352 int read_ref(const char *refname, unsigned char *sha1)
1353 {
1354         return read_ref_full(refname, sha1, 1, NULL);
1355 }
1356
1357 int ref_exists(const char *refname)
1358 {
1359         unsigned char sha1[20];
1360         return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1361 }
1362
1363 static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1364                        void *data)
1365 {
1366         struct ref_filter *filter = (struct ref_filter *)data;
1367         if (fnmatch(filter->pattern, refname, 0))
1368                 return 0;
1369         return filter->fn(refname, sha1, flags, filter->cb_data);
1370 }
1371
1372 enum peel_status {
1373         /* object was peeled successfully: */
1374         PEEL_PEELED = 0,
1375
1376         /*
1377          * object cannot be peeled because the named object (or an
1378          * object referred to by a tag in the peel chain), does not
1379          * exist.
1380          */
1381         PEEL_INVALID = -1,
1382
1383         /* object cannot be peeled because it is not a tag: */
1384         PEEL_NON_TAG = -2,
1385
1386         /* ref_entry contains no peeled value because it is a symref: */
1387         PEEL_IS_SYMREF = -3,
1388
1389         /*
1390          * ref_entry cannot be peeled because it is broken (i.e., the
1391          * symbolic reference cannot even be resolved to an object
1392          * name):
1393          */
1394         PEEL_BROKEN = -4
1395 };
1396
1397 /*
1398  * Peel the named object; i.e., if the object is a tag, resolve the
1399  * tag recursively until a non-tag is found.  If successful, store the
1400  * result to sha1 and return PEEL_PEELED.  If the object is not a tag
1401  * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1402  * and leave sha1 unchanged.
1403  */
1404 static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1405 {
1406         struct object *o = lookup_unknown_object(name);
1407
1408         if (o->type == OBJ_NONE) {
1409                 int type = sha1_object_info(name, NULL);
1410                 if (type < 0)
1411                         return PEEL_INVALID;
1412                 o->type = type;
1413         }
1414
1415         if (o->type != OBJ_TAG)
1416                 return PEEL_NON_TAG;
1417
1418         o = deref_tag_noverify(o);
1419         if (!o)
1420                 return PEEL_INVALID;
1421
1422         hashcpy(sha1, o->sha1);
1423         return PEEL_PEELED;
1424 }
1425
1426 /*
1427  * Peel the entry (if possible) and return its new peel_status.  If
1428  * repeel is true, re-peel the entry even if there is an old peeled
1429  * value that is already stored in it.
1430  *
1431  * It is OK to call this function with a packed reference entry that
1432  * might be stale and might even refer to an object that has since
1433  * been garbage-collected.  In such a case, if the entry has
1434  * REF_KNOWS_PEELED then leave the status unchanged and return
1435  * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1436  */
1437 static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1438 {
1439         enum peel_status status;
1440
1441         if (entry->flag & REF_KNOWS_PEELED) {
1442                 if (repeel) {
1443                         entry->flag &= ~REF_KNOWS_PEELED;
1444                         hashclr(entry->u.value.peeled);
1445                 } else {
1446                         return is_null_sha1(entry->u.value.peeled) ?
1447                                 PEEL_NON_TAG : PEEL_PEELED;
1448                 }
1449         }
1450         if (entry->flag & REF_ISBROKEN)
1451                 return PEEL_BROKEN;
1452         if (entry->flag & REF_ISSYMREF)
1453                 return PEEL_IS_SYMREF;
1454
1455         status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
1456         if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1457                 entry->flag |= REF_KNOWS_PEELED;
1458         return status;
1459 }
1460
1461 int peel_ref(const char *refname, unsigned char *sha1)
1462 {
1463         int flag;
1464         unsigned char base[20];
1465
1466         if (current_ref && (current_ref->name == refname
1467                             || !strcmp(current_ref->name, refname))) {
1468                 if (peel_entry(current_ref, 0))
1469                         return -1;
1470                 hashcpy(sha1, current_ref->u.value.peeled);
1471                 return 0;
1472         }
1473
1474         if (read_ref_full(refname, base, 1, &flag))
1475                 return -1;
1476
1477         /*
1478          * If the reference is packed, read its ref_entry from the
1479          * cache in the hope that we already know its peeled value.
1480          * We only try this optimization on packed references because
1481          * (a) forcing the filling of the loose reference cache could
1482          * be expensive and (b) loose references anyway usually do not
1483          * have REF_KNOWS_PEELED.
1484          */
1485         if (flag & REF_ISPACKED) {
1486                 struct ref_entry *r = get_packed_ref(refname);
1487                 if (r) {
1488                         if (peel_entry(r, 0))
1489                                 return -1;
1490                         hashcpy(sha1, r->u.value.peeled);
1491                         return 0;
1492                 }
1493         }
1494
1495         return peel_object(base, sha1);
1496 }
1497
1498 struct warn_if_dangling_data {
1499         FILE *fp;
1500         const char *refname;
1501         const char *msg_fmt;
1502 };
1503
1504 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1505                                    int flags, void *cb_data)
1506 {
1507         struct warn_if_dangling_data *d = cb_data;
1508         const char *resolves_to;
1509         unsigned char junk[20];
1510
1511         if (!(flags & REF_ISSYMREF))
1512                 return 0;
1513
1514         resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1515         if (!resolves_to || strcmp(resolves_to, d->refname))
1516                 return 0;
1517
1518         fprintf(d->fp, d->msg_fmt, refname);
1519         fputc('\n', d->fp);
1520         return 0;
1521 }
1522
1523 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1524 {
1525         struct warn_if_dangling_data data;
1526
1527         data.fp = fp;
1528         data.refname = refname;
1529         data.msg_fmt = msg_fmt;
1530         for_each_rawref(warn_if_dangling_symref, &data);
1531 }
1532
1533 /*
1534  * Call fn for each reference in the specified ref_cache, omitting
1535  * references not in the containing_dir of base.  fn is called for all
1536  * references, including broken ones.  If fn ever returns a non-zero
1537  * value, stop the iteration and return that value; otherwise, return
1538  * 0.
1539  */
1540 static int do_for_each_entry(struct ref_cache *refs, const char *base,
1541                              each_ref_entry_fn fn, void *cb_data)
1542 {
1543         struct ref_dir *packed_dir = get_packed_refs(refs);
1544         struct ref_dir *loose_dir = get_loose_refs(refs);
1545         int retval = 0;
1546
1547         if (base && *base) {
1548                 packed_dir = find_containing_dir(packed_dir, base, 0);
1549                 loose_dir = find_containing_dir(loose_dir, base, 0);
1550         }
1551
1552         if (packed_dir && loose_dir) {
1553                 sort_ref_dir(packed_dir);
1554                 sort_ref_dir(loose_dir);
1555                 retval = do_for_each_entry_in_dirs(
1556                                 packed_dir, loose_dir, fn, cb_data);
1557         } else if (packed_dir) {
1558                 sort_ref_dir(packed_dir);
1559                 retval = do_for_each_entry_in_dir(
1560                                 packed_dir, 0, fn, cb_data);
1561         } else if (loose_dir) {
1562                 sort_ref_dir(loose_dir);
1563                 retval = do_for_each_entry_in_dir(
1564                                 loose_dir, 0, fn, cb_data);
1565         }
1566
1567         return retval;
1568 }
1569
1570 /*
1571  * Call fn for each reference in the specified ref_cache for which the
1572  * refname begins with base.  If trim is non-zero, then trim that many
1573  * characters off the beginning of each refname before passing the
1574  * refname to fn.  flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1575  * broken references in the iteration.  If fn ever returns a non-zero
1576  * value, stop the iteration and return that value; otherwise, return
1577  * 0.
1578  */
1579 static int do_for_each_ref(struct ref_cache *refs, const char *base,
1580                            each_ref_fn fn, int trim, int flags, void *cb_data)
1581 {
1582         struct ref_entry_cb data;
1583         data.base = base;
1584         data.trim = trim;
1585         data.flags = flags;
1586         data.fn = fn;
1587         data.cb_data = cb_data;
1588
1589         return do_for_each_entry(refs, base, do_one_ref, &data);
1590 }
1591
1592 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1593 {
1594         unsigned char sha1[20];
1595         int flag;
1596
1597         if (submodule) {
1598                 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1599                         return fn("HEAD", sha1, 0, cb_data);
1600
1601                 return 0;
1602         }
1603
1604         if (!read_ref_full("HEAD", sha1, 1, &flag))
1605                 return fn("HEAD", sha1, flag, cb_data);
1606
1607         return 0;
1608 }
1609
1610 int head_ref(each_ref_fn fn, void *cb_data)
1611 {
1612         return do_head_ref(NULL, fn, cb_data);
1613 }
1614
1615 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1616 {
1617         return do_head_ref(submodule, fn, cb_data);
1618 }
1619
1620 int for_each_ref(each_ref_fn fn, void *cb_data)
1621 {
1622         return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1623 }
1624
1625 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1626 {
1627         return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1628 }
1629
1630 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1631 {
1632         return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1633 }
1634
1635 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1636                 each_ref_fn fn, void *cb_data)
1637 {
1638         return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1639 }
1640
1641 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1642 {
1643         return for_each_ref_in("refs/tags/", fn, cb_data);
1644 }
1645
1646 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1647 {
1648         return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1649 }
1650
1651 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1652 {
1653         return for_each_ref_in("refs/heads/", fn, cb_data);
1654 }
1655
1656 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1657 {
1658         return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1659 }
1660
1661 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1662 {
1663         return for_each_ref_in("refs/remotes/", fn, cb_data);
1664 }
1665
1666 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1667 {
1668         return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1669 }
1670
1671 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1672 {
1673         return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
1674 }
1675
1676 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1677 {
1678         struct strbuf buf = STRBUF_INIT;
1679         int ret = 0;
1680         unsigned char sha1[20];
1681         int flag;
1682
1683         strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1684         if (!read_ref_full(buf.buf, sha1, 1, &flag))
1685                 ret = fn(buf.buf, sha1, flag, cb_data);
1686         strbuf_release(&buf);
1687
1688         return ret;
1689 }
1690
1691 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1692 {
1693         struct strbuf buf = STRBUF_INIT;
1694         int ret;
1695         strbuf_addf(&buf, "%srefs/", get_git_namespace());
1696         ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
1697         strbuf_release(&buf);
1698         return ret;
1699 }
1700
1701 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1702         const char *prefix, void *cb_data)
1703 {
1704         struct strbuf real_pattern = STRBUF_INIT;
1705         struct ref_filter filter;
1706         int ret;
1707
1708         if (!prefix && prefixcmp(pattern, "refs/"))
1709                 strbuf_addstr(&real_pattern, "refs/");
1710         else if (prefix)
1711                 strbuf_addstr(&real_pattern, prefix);
1712         strbuf_addstr(&real_pattern, pattern);
1713
1714         if (!has_glob_specials(pattern)) {
1715                 /* Append implied '/' '*' if not present. */
1716                 if (real_pattern.buf[real_pattern.len - 1] != '/')
1717                         strbuf_addch(&real_pattern, '/');
1718                 /* No need to check for '*', there is none. */
1719                 strbuf_addch(&real_pattern, '*');
1720         }
1721
1722         filter.pattern = real_pattern.buf;
1723         filter.fn = fn;
1724         filter.cb_data = cb_data;
1725         ret = for_each_ref(filter_refs, &filter);
1726
1727         strbuf_release(&real_pattern);
1728         return ret;
1729 }
1730
1731 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1732 {
1733         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1734 }
1735
1736 int for_each_rawref(each_ref_fn fn, void *cb_data)
1737 {
1738         return do_for_each_ref(&ref_cache, "", fn, 0,
1739                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1740 }
1741
1742 const char *prettify_refname(const char *name)
1743 {
1744         return name + (
1745                 !prefixcmp(name, "refs/heads/") ? 11 :
1746                 !prefixcmp(name, "refs/tags/") ? 10 :
1747                 !prefixcmp(name, "refs/remotes/") ? 13 :
1748                 0);
1749 }
1750
1751 const char *ref_rev_parse_rules[] = {
1752         "%.*s",
1753         "refs/%.*s",
1754         "refs/tags/%.*s",
1755         "refs/heads/%.*s",
1756         "refs/remotes/%.*s",
1757         "refs/remotes/%.*s/HEAD",
1758         NULL
1759 };
1760
1761 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1762 {
1763         const char **p;
1764         const int abbrev_name_len = strlen(abbrev_name);
1765
1766         for (p = rules; *p; p++) {
1767                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1768                         return 1;
1769                 }
1770         }
1771
1772         return 0;
1773 }
1774
1775 static struct ref_lock *verify_lock(struct ref_lock *lock,
1776         const unsigned char *old_sha1, int mustexist)
1777 {
1778         if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1779                 error("Can't verify ref %s", lock->ref_name);
1780                 unlock_ref(lock);
1781                 return NULL;
1782         }
1783         if (hashcmp(lock->old_sha1, old_sha1)) {
1784                 error("Ref %s is at %s but expected %s", lock->ref_name,
1785                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1786                 unlock_ref(lock);
1787                 return NULL;
1788         }
1789         return lock;
1790 }
1791
1792 static int remove_empty_directories(const char *file)
1793 {
1794         /* we want to create a file but there is a directory there;
1795          * if that is an empty directory (or a directory that contains
1796          * only empty directories), remove them.
1797          */
1798         struct strbuf path;
1799         int result;
1800
1801         strbuf_init(&path, 20);
1802         strbuf_addstr(&path, file);
1803
1804         result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1805
1806         strbuf_release(&path);
1807
1808         return result;
1809 }
1810
1811 /*
1812  * *string and *len will only be substituted, and *string returned (for
1813  * later free()ing) if the string passed in is a magic short-hand form
1814  * to name a branch.
1815  */
1816 static char *substitute_branch_name(const char **string, int *len)
1817 {
1818         struct strbuf buf = STRBUF_INIT;
1819         int ret = interpret_branch_name(*string, &buf);
1820
1821         if (ret == *len) {
1822                 size_t size;
1823                 *string = strbuf_detach(&buf, &size);
1824                 *len = size;
1825                 return (char *)*string;
1826         }
1827
1828         return NULL;
1829 }
1830
1831 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1832 {
1833         char *last_branch = substitute_branch_name(&str, &len);
1834         const char **p, *r;
1835         int refs_found = 0;
1836
1837         *ref = NULL;
1838         for (p = ref_rev_parse_rules; *p; p++) {
1839                 char fullref[PATH_MAX];
1840                 unsigned char sha1_from_ref[20];
1841                 unsigned char *this_result;
1842                 int flag;
1843
1844                 this_result = refs_found ? sha1_from_ref : sha1;
1845                 mksnpath(fullref, sizeof(fullref), *p, len, str);
1846                 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1847                 if (r) {
1848                         if (!refs_found++)
1849                                 *ref = xstrdup(r);
1850                         if (!warn_ambiguous_refs)
1851                                 break;
1852                 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1853                         warning("ignoring dangling symref %s.", fullref);
1854                 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1855                         warning("ignoring broken ref %s.", fullref);
1856                 }
1857         }
1858         free(last_branch);
1859         return refs_found;
1860 }
1861
1862 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1863 {
1864         char *last_branch = substitute_branch_name(&str, &len);
1865         const char **p;
1866         int logs_found = 0;
1867
1868         *log = NULL;
1869         for (p = ref_rev_parse_rules; *p; p++) {
1870                 struct stat st;
1871                 unsigned char hash[20];
1872                 char path[PATH_MAX];
1873                 const char *ref, *it;
1874
1875                 mksnpath(path, sizeof(path), *p, len, str);
1876                 ref = resolve_ref_unsafe(path, hash, 1, NULL);
1877                 if (!ref)
1878                         continue;
1879                 if (!stat(git_path("logs/%s", path), &st) &&
1880                     S_ISREG(st.st_mode))
1881                         it = path;
1882                 else if (strcmp(ref, path) &&
1883                          !stat(git_path("logs/%s", ref), &st) &&
1884                          S_ISREG(st.st_mode))
1885                         it = ref;
1886                 else
1887                         continue;
1888                 if (!logs_found++) {
1889                         *log = xstrdup(it);
1890                         hashcpy(sha1, hash);
1891                 }
1892                 if (!warn_ambiguous_refs)
1893                         break;
1894         }
1895         free(last_branch);
1896         return logs_found;
1897 }
1898
1899 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1900                                             const unsigned char *old_sha1,
1901                                             int flags, int *type_p)
1902 {
1903         char *ref_file;
1904         const char *orig_refname = refname;
1905         struct ref_lock *lock;
1906         int last_errno = 0;
1907         int type, lflags;
1908         int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1909         int missing = 0;
1910
1911         lock = xcalloc(1, sizeof(struct ref_lock));
1912         lock->lock_fd = -1;
1913
1914         refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1915         if (!refname && errno == EISDIR) {
1916                 /* we are trying to lock foo but we used to
1917                  * have foo/bar which now does not exist;
1918                  * it is normal for the empty directory 'foo'
1919                  * to remain.
1920                  */
1921                 ref_file = git_path("%s", orig_refname);
1922                 if (remove_empty_directories(ref_file)) {
1923                         last_errno = errno;
1924                         error("there are still refs under '%s'", orig_refname);
1925                         goto error_return;
1926                 }
1927                 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1928         }
1929         if (type_p)
1930             *type_p = type;
1931         if (!refname) {
1932                 last_errno = errno;
1933                 error("unable to resolve reference %s: %s",
1934                         orig_refname, strerror(errno));
1935                 goto error_return;
1936         }
1937         missing = is_null_sha1(lock->old_sha1);
1938         /* When the ref did not exist and we are creating it,
1939          * make sure there is no existing ref that is packed
1940          * whose name begins with our refname, nor a ref whose
1941          * name is a proper prefix of our refname.
1942          */
1943         if (missing &&
1944              !is_refname_available(refname, NULL, get_packed_refs(&ref_cache))) {
1945                 last_errno = ENOTDIR;
1946                 goto error_return;
1947         }
1948
1949         lock->lk = xcalloc(1, sizeof(struct lock_file));
1950
1951         lflags = LOCK_DIE_ON_ERROR;
1952         if (flags & REF_NODEREF) {
1953                 refname = orig_refname;
1954                 lflags |= LOCK_NODEREF;
1955         }
1956         lock->ref_name = xstrdup(refname);
1957         lock->orig_ref_name = xstrdup(orig_refname);
1958         ref_file = git_path("%s", refname);
1959         if (missing)
1960                 lock->force_write = 1;
1961         if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1962                 lock->force_write = 1;
1963
1964         if (safe_create_leading_directories(ref_file)) {
1965                 last_errno = errno;
1966                 error("unable to create directory for %s", ref_file);
1967                 goto error_return;
1968         }
1969
1970         lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1971         return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1972
1973  error_return:
1974         unlock_ref(lock);
1975         errno = last_errno;
1976         return NULL;
1977 }
1978
1979 struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1980 {
1981         char refpath[PATH_MAX];
1982         if (check_refname_format(refname, 0))
1983                 return NULL;
1984         strcpy(refpath, mkpath("refs/%s", refname));
1985         return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1986 }
1987
1988 struct ref_lock *lock_any_ref_for_update(const char *refname,
1989                                          const unsigned char *old_sha1, int flags)
1990 {
1991         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1992                 return NULL;
1993         return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1994 }
1995
1996 /*
1997  * Write an entry to the packed-refs file for the specified refname.
1998  * If peeled is non-NULL, write it as the entry's peeled value.
1999  */
2000 static void write_packed_entry(int fd, char *refname, unsigned char *sha1,
2001                                unsigned char *peeled)
2002 {
2003         char line[PATH_MAX + 100];
2004         int len;
2005
2006         len = snprintf(line, sizeof(line), "%s %s\n",
2007                        sha1_to_hex(sha1), refname);
2008         /* this should not happen but just being defensive */
2009         if (len > sizeof(line))
2010                 die("too long a refname '%s'", refname);
2011         write_or_die(fd, line, len);
2012
2013         if (peeled) {
2014                 if (snprintf(line, sizeof(line), "^%s\n",
2015                              sha1_to_hex(peeled)) != PEELED_LINE_LENGTH)
2016                         die("internal error");
2017                 write_or_die(fd, line, PEELED_LINE_LENGTH);
2018         }
2019 }
2020
2021 /*
2022  * An each_ref_entry_fn that writes the entry to a packed-refs file.
2023  */
2024 static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2025 {
2026         int *fd = cb_data;
2027         enum peel_status peel_status = peel_entry(entry, 0);
2028
2029         if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2030                 error("internal error: %s is not a valid packed reference!",
2031                       entry->name);
2032         write_packed_entry(*fd, entry->name, entry->u.value.sha1,
2033                            peel_status == PEEL_PEELED ?
2034                            entry->u.value.peeled : NULL);
2035         return 0;
2036 }
2037
2038 struct ref_to_prune {
2039         struct ref_to_prune *next;
2040         unsigned char sha1[20];
2041         char name[FLEX_ARRAY];
2042 };
2043
2044 struct pack_refs_cb_data {
2045         unsigned int flags;
2046         struct ref_dir *packed_refs;
2047         struct ref_to_prune *ref_to_prune;
2048 };
2049
2050 /*
2051  * An each_ref_entry_fn that is run over loose references only.  If
2052  * the loose reference can be packed, add an entry in the packed ref
2053  * cache.  If the reference should be pruned, also add it to
2054  * ref_to_prune in the pack_refs_cb_data.
2055  */
2056 static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2057 {
2058         struct pack_refs_cb_data *cb = cb_data;
2059         enum peel_status peel_status;
2060         struct ref_entry *packed_entry;
2061         int is_tag_ref = !prefixcmp(entry->name, "refs/tags/");
2062
2063         /* ALWAYS pack tags */
2064         if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2065                 return 0;
2066
2067         /* Do not pack symbolic or broken refs: */
2068         if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
2069                 return 0;
2070
2071         /* Add a packed ref cache entry equivalent to the loose entry. */
2072         peel_status = peel_entry(entry, 1);
2073         if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2074                 die("internal error peeling reference %s (%s)",
2075                     entry->name, sha1_to_hex(entry->u.value.sha1));
2076         packed_entry = find_ref(cb->packed_refs, entry->name);
2077         if (packed_entry) {
2078                 /* Overwrite existing packed entry with info from loose entry */
2079                 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2080                 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
2081         } else {
2082                 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
2083                                                 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2084                 add_ref(cb->packed_refs, packed_entry);
2085         }
2086         hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
2087
2088         /* Schedule the loose reference for pruning if requested. */
2089         if ((cb->flags & PACK_REFS_PRUNE)) {
2090                 int namelen = strlen(entry->name) + 1;
2091                 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2092                 hashcpy(n->sha1, entry->u.value.sha1);
2093                 strcpy(n->name, entry->name);
2094                 n->next = cb->ref_to_prune;
2095                 cb->ref_to_prune = n;
2096         }
2097         return 0;
2098 }
2099
2100 /*
2101  * Remove empty parents, but spare refs/ and immediate subdirs.
2102  * Note: munges *name.
2103  */
2104 static void try_remove_empty_parents(char *name)
2105 {
2106         char *p, *q;
2107         int i;
2108         p = name;
2109         for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2110                 while (*p && *p != '/')
2111                         p++;
2112                 /* tolerate duplicate slashes; see check_refname_format() */
2113                 while (*p == '/')
2114                         p++;
2115         }
2116         for (q = p; *q; q++)
2117                 ;
2118         while (1) {
2119                 while (q > p && *q != '/')
2120                         q--;
2121                 while (q > p && *(q-1) == '/')
2122                         q--;
2123                 if (q == p)
2124                         break;
2125                 *q = '\0';
2126                 if (rmdir(git_path("%s", name)))
2127                         break;
2128         }
2129 }
2130
2131 /* make sure nobody touched the ref, and unlink */
2132 static void prune_ref(struct ref_to_prune *r)
2133 {
2134         struct ref_lock *lock = lock_ref_sha1(r->name + 5, r->sha1);
2135
2136         if (lock) {
2137                 unlink_or_warn(git_path("%s", r->name));
2138                 unlock_ref(lock);
2139                 try_remove_empty_parents(r->name);
2140         }
2141 }
2142
2143 static void prune_refs(struct ref_to_prune *r)
2144 {
2145         while (r) {
2146                 prune_ref(r);
2147                 r = r->next;
2148         }
2149 }
2150
2151 static struct lock_file packlock;
2152
2153 int pack_refs(unsigned int flags)
2154 {
2155         struct pack_refs_cb_data cbdata;
2156         int fd;
2157
2158         memset(&cbdata, 0, sizeof(cbdata));
2159         cbdata.flags = flags;
2160
2161         fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"),
2162                                        LOCK_DIE_ON_ERROR);
2163         cbdata.packed_refs = get_packed_refs(&ref_cache);
2164
2165         do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2166                                  pack_if_possible_fn, &cbdata);
2167
2168         write_or_die(fd, PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
2169         do_for_each_entry_in_dir(cbdata.packed_refs, 0, write_packed_entry_fn, &fd);
2170
2171         if (commit_lock_file(&packlock) < 0)
2172                 die_errno("unable to overwrite old ref-pack file");
2173         prune_refs(cbdata.ref_to_prune);
2174         return 0;
2175 }
2176
2177 /*
2178  * If entry is no longer needed in packed-refs, add it to the string
2179  * list pointed to by cb_data.  Reasons for deleting entries:
2180  *
2181  * - Entry is broken.
2182  * - Entry is overridden by a loose ref.
2183  * - Entry does not point at a valid object.
2184  *
2185  * In the first and third cases, also emit an error message because these
2186  * are indications of repository corruption.
2187  */
2188 static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
2189 {
2190         struct string_list *refs_to_delete = cb_data;
2191
2192         if (entry->flag & REF_ISBROKEN) {
2193                 /* This shouldn't happen to packed refs. */
2194                 error("%s is broken!", entry->name);
2195                 string_list_append(refs_to_delete, entry->name);
2196                 return 0;
2197         }
2198         if (!has_sha1_file(entry->u.value.sha1)) {
2199                 unsigned char sha1[20];
2200                 int flags;
2201
2202                 if (read_ref_full(entry->name, sha1, 0, &flags))
2203                         /* We should at least have found the packed ref. */
2204                         die("Internal error");
2205                 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2206                         /*
2207                          * This packed reference is overridden by a
2208                          * loose reference, so it is OK that its value
2209                          * is no longer valid; for example, it might
2210                          * refer to an object that has been garbage
2211                          * collected.  For this purpose we don't even
2212                          * care whether the loose reference itself is
2213                          * invalid, broken, symbolic, etc.  Silently
2214                          * remove the packed reference.
2215                          */
2216                         string_list_append(refs_to_delete, entry->name);
2217                         return 0;
2218                 }
2219                 /*
2220                  * There is no overriding loose reference, so the fact
2221                  * that this reference doesn't refer to a valid object
2222                  * indicates some kind of repository corruption.
2223                  * Report the problem, then omit the reference from
2224                  * the output.
2225                  */
2226                 error("%s does not point to a valid object!", entry->name);
2227                 string_list_append(refs_to_delete, entry->name);
2228                 return 0;
2229         }
2230
2231         return 0;
2232 }
2233
2234 static int repack_without_ref(const char *refname)
2235 {
2236         int fd;
2237         struct ref_dir *packed;
2238         struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
2239         struct string_list_item *ref_to_delete;
2240
2241         if (!get_packed_ref(refname))
2242                 return 0; /* refname does not exist in packed refs */
2243
2244         fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
2245         if (fd < 0) {
2246                 unable_to_lock_error(git_path("packed-refs"), errno);
2247                 return error("cannot delete '%s' from packed refs", refname);
2248         }
2249         clear_packed_ref_cache(&ref_cache);
2250         packed = get_packed_refs(&ref_cache);
2251
2252         /* Remove refname from the cache: */
2253         if (remove_entry(packed, refname) == -1) {
2254                 /*
2255                  * The packed entry disappeared while we were
2256                  * acquiring the lock.
2257                  */
2258                 rollback_lock_file(&packlock);
2259                 return 0;
2260         }
2261
2262         /* Remove any other accumulated cruft: */
2263         do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
2264         for_each_string_list_item(ref_to_delete, &refs_to_delete) {
2265                 if (remove_entry(packed, ref_to_delete->string) == -1)
2266                         die("internal error");
2267         }
2268
2269         /* Write what remains: */
2270         write_or_die(fd, PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
2271         do_for_each_entry_in_dir(packed, 0, write_packed_entry_fn, &fd);
2272         return commit_lock_file(&packlock);
2273 }
2274
2275 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
2276 {
2277         struct ref_lock *lock;
2278         int err, i = 0, ret = 0, flag = 0;
2279
2280         lock = lock_ref_sha1_basic(refname, sha1, delopt, &flag);
2281         if (!lock)
2282                 return 1;
2283         if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2284                 /* loose */
2285                 i = strlen(lock->lk->filename) - 5; /* .lock */
2286                 lock->lk->filename[i] = 0;
2287                 err = unlink_or_warn(lock->lk->filename);
2288                 if (err && errno != ENOENT)
2289                         ret = 1;
2290
2291                 lock->lk->filename[i] = '.';
2292         }
2293         /* removing the loose one could have resurrected an earlier
2294          * packed one.  Also, if it was not loose we need to repack
2295          * without it.
2296          */
2297         ret |= repack_without_ref(lock->ref_name);
2298
2299         unlink_or_warn(git_path("logs/%s", lock->ref_name));
2300         clear_loose_ref_cache(&ref_cache);
2301         unlock_ref(lock);
2302         return ret;
2303 }
2304
2305 /*
2306  * People using contrib's git-new-workdir have .git/logs/refs ->
2307  * /some/other/path/.git/logs/refs, and that may live on another device.
2308  *
2309  * IOW, to avoid cross device rename errors, the temporary renamed log must
2310  * live into logs/refs.
2311  */
2312 #define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
2313
2314 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2315 {
2316         unsigned char sha1[20], orig_sha1[20];
2317         int flag = 0, logmoved = 0;
2318         struct ref_lock *lock;
2319         struct stat loginfo;
2320         int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
2321         const char *symref = NULL;
2322
2323         if (log && S_ISLNK(loginfo.st_mode))
2324                 return error("reflog for %s is a symlink", oldrefname);
2325
2326         symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
2327         if (flag & REF_ISSYMREF)
2328                 return error("refname %s is a symbolic ref, renaming it is not supported",
2329                         oldrefname);
2330         if (!symref)
2331                 return error("refname %s not found", oldrefname);
2332
2333         if (!is_refname_available(newrefname, oldrefname, get_packed_refs(&ref_cache)))
2334                 return 1;
2335
2336         if (!is_refname_available(newrefname, oldrefname, get_loose_refs(&ref_cache)))
2337                 return 1;
2338
2339         if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2340                 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2341                         oldrefname, strerror(errno));
2342
2343         if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
2344                 error("unable to delete old %s", oldrefname);
2345                 goto rollback;
2346         }
2347
2348         if (!read_ref_full(newrefname, sha1, 1, &flag) &&
2349             delete_ref(newrefname, sha1, REF_NODEREF)) {
2350                 if (errno==EISDIR) {
2351                         if (remove_empty_directories(git_path("%s", newrefname))) {
2352                                 error("Directory not empty: %s", newrefname);
2353                                 goto rollback;
2354                         }
2355                 } else {
2356                         error("unable to delete existing %s", newrefname);
2357                         goto rollback;
2358                 }
2359         }
2360
2361         if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
2362                 error("unable to create directory for %s", newrefname);
2363                 goto rollback;
2364         }
2365
2366  retry:
2367         if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2368                 if (errno==EISDIR || errno==ENOTDIR) {
2369                         /*
2370                          * rename(a, b) when b is an existing
2371                          * directory ought to result in ISDIR, but
2372                          * Solaris 5.8 gives ENOTDIR.  Sheesh.
2373                          */
2374                         if (remove_empty_directories(git_path("logs/%s", newrefname))) {
2375                                 error("Directory not empty: logs/%s", newrefname);
2376                                 goto rollback;
2377                         }
2378                         goto retry;
2379                 } else {
2380                         error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2381                                 newrefname, strerror(errno));
2382                         goto rollback;
2383                 }
2384         }
2385         logmoved = log;
2386
2387         lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
2388         if (!lock) {
2389                 error("unable to lock %s for update", newrefname);
2390                 goto rollback;
2391         }
2392         lock->force_write = 1;
2393         hashcpy(lock->old_sha1, orig_sha1);
2394         if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2395                 error("unable to write current sha1 into %s", newrefname);
2396                 goto rollback;
2397         }
2398
2399         return 0;
2400
2401  rollback:
2402         lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
2403         if (!lock) {
2404                 error("unable to lock %s for rollback", oldrefname);
2405                 goto rollbacklog;
2406         }
2407
2408         lock->force_write = 1;
2409         flag = log_all_ref_updates;
2410         log_all_ref_updates = 0;
2411         if (write_ref_sha1(lock, orig_sha1, NULL))
2412                 error("unable to write current sha1 into %s", oldrefname);
2413         log_all_ref_updates = flag;
2414
2415  rollbacklog:
2416         if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2417                 error("unable to restore logfile %s from %s: %s",
2418                         oldrefname, newrefname, strerror(errno));
2419         if (!logmoved && log &&
2420             rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2421                 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2422                         oldrefname, strerror(errno));
2423
2424         return 1;
2425 }
2426
2427 int close_ref(struct ref_lock *lock)
2428 {
2429         if (close_lock_file(lock->lk))
2430                 return -1;
2431         lock->lock_fd = -1;
2432         return 0;
2433 }
2434
2435 int commit_ref(struct ref_lock *lock)
2436 {
2437         if (commit_lock_file(lock->lk))
2438                 return -1;
2439         lock->lock_fd = -1;
2440         return 0;
2441 }
2442
2443 void unlock_ref(struct ref_lock *lock)
2444 {
2445         /* Do not free lock->lk -- atexit() still looks at them */
2446         if (lock->lk)
2447                 rollback_lock_file(lock->lk);
2448         free(lock->ref_name);
2449         free(lock->orig_ref_name);
2450         free(lock);
2451 }
2452
2453 /*
2454  * copy the reflog message msg to buf, which has been allocated sufficiently
2455  * large, while cleaning up the whitespaces.  Especially, convert LF to space,
2456  * because reflog file is one line per entry.
2457  */
2458 static int copy_msg(char *buf, const char *msg)
2459 {
2460         char *cp = buf;
2461         char c;
2462         int wasspace = 1;
2463
2464         *cp++ = '\t';
2465         while ((c = *msg++)) {
2466                 if (wasspace && isspace(c))
2467                         continue;
2468                 wasspace = isspace(c);
2469                 if (wasspace)
2470                         c = ' ';
2471                 *cp++ = c;
2472         }
2473         while (buf < cp && isspace(cp[-1]))
2474                 cp--;
2475         *cp++ = '\n';
2476         return cp - buf;
2477 }
2478
2479 int log_ref_setup(const char *refname, char *logfile, int bufsize)
2480 {
2481         int logfd, oflags = O_APPEND | O_WRONLY;
2482
2483         git_snpath(logfile, bufsize, "logs/%s", refname);
2484         if (log_all_ref_updates &&
2485             (!prefixcmp(refname, "refs/heads/") ||
2486              !prefixcmp(refname, "refs/remotes/") ||
2487              !prefixcmp(refname, "refs/notes/") ||
2488              !strcmp(refname, "HEAD"))) {
2489                 if (safe_create_leading_directories(logfile) < 0)
2490                         return error("unable to create directory for %s",
2491                                      logfile);
2492                 oflags |= O_CREAT;
2493         }
2494
2495         logfd = open(logfile, oflags, 0666);
2496         if (logfd < 0) {
2497                 if (!(oflags & O_CREAT) && errno == ENOENT)
2498                         return 0;
2499
2500                 if ((oflags & O_CREAT) && errno == EISDIR) {
2501                         if (remove_empty_directories(logfile)) {
2502                                 return error("There are still logs under '%s'",
2503                                              logfile);
2504                         }
2505                         logfd = open(logfile, oflags, 0666);
2506                 }
2507
2508                 if (logfd < 0)
2509                         return error("Unable to append to %s: %s",
2510                                      logfile, strerror(errno));
2511         }
2512
2513         adjust_shared_perm(logfile);
2514         close(logfd);
2515         return 0;
2516 }
2517
2518 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2519                          const unsigned char *new_sha1, const char *msg)
2520 {
2521         int logfd, result, written, oflags = O_APPEND | O_WRONLY;
2522         unsigned maxlen, len;
2523         int msglen;
2524         char log_file[PATH_MAX];
2525         char *logrec;
2526         const char *committer;
2527
2528         if (log_all_ref_updates < 0)
2529                 log_all_ref_updates = !is_bare_repository();
2530
2531         result = log_ref_setup(refname, log_file, sizeof(log_file));
2532         if (result)
2533                 return result;
2534
2535         logfd = open(log_file, oflags);
2536         if (logfd < 0)
2537                 return 0;
2538         msglen = msg ? strlen(msg) : 0;
2539         committer = git_committer_info(0);
2540         maxlen = strlen(committer) + msglen + 100;
2541         logrec = xmalloc(maxlen);
2542         len = sprintf(logrec, "%s %s %s\n",
2543                       sha1_to_hex(old_sha1),
2544                       sha1_to_hex(new_sha1),
2545                       committer);
2546         if (msglen)
2547                 len += copy_msg(logrec + len - 1, msg) - 1;
2548         written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2549         free(logrec);
2550         if (close(logfd) != 0 || written != len)
2551                 return error("Unable to append to %s", log_file);
2552         return 0;
2553 }
2554
2555 static int is_branch(const char *refname)
2556 {
2557         return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
2558 }
2559
2560 int write_ref_sha1(struct ref_lock *lock,
2561         const unsigned char *sha1, const char *logmsg)
2562 {
2563         static char term = '\n';
2564         struct object *o;
2565
2566         if (!lock)
2567                 return -1;
2568         if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2569                 unlock_ref(lock);
2570                 return 0;
2571         }
2572         o = parse_object(sha1);
2573         if (!o) {
2574                 error("Trying to write ref %s with nonexistent object %s",
2575                         lock->ref_name, sha1_to_hex(sha1));
2576                 unlock_ref(lock);
2577                 return -1;
2578         }
2579         if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2580                 error("Trying to write non-commit object %s to branch %s",
2581                         sha1_to_hex(sha1), lock->ref_name);
2582                 unlock_ref(lock);
2583                 return -1;
2584         }
2585         if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2586             write_in_full(lock->lock_fd, &term, 1) != 1
2587                 || close_ref(lock) < 0) {
2588                 error("Couldn't write %s", lock->lk->filename);
2589                 unlock_ref(lock);
2590                 return -1;
2591         }
2592         clear_loose_ref_cache(&ref_cache);
2593         if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2594             (strcmp(lock->ref_name, lock->orig_ref_name) &&
2595              log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2596                 unlock_ref(lock);
2597                 return -1;
2598         }
2599         if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2600                 /*
2601                  * Special hack: If a branch is updated directly and HEAD
2602                  * points to it (may happen on the remote side of a push
2603                  * for example) then logically the HEAD reflog should be
2604                  * updated too.
2605                  * A generic solution implies reverse symref information,
2606                  * but finding all symrefs pointing to the given branch
2607                  * would be rather costly for this rare event (the direct
2608                  * update of a branch) to be worth it.  So let's cheat and
2609                  * check with HEAD only which should cover 99% of all usage
2610                  * scenarios (even 100% of the default ones).
2611                  */
2612                 unsigned char head_sha1[20];
2613                 int head_flag;
2614                 const char *head_ref;
2615                 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2616                 if (head_ref && (head_flag & REF_ISSYMREF) &&
2617                     !strcmp(head_ref, lock->ref_name))
2618                         log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2619         }
2620         if (commit_ref(lock)) {
2621                 error("Couldn't set %s", lock->ref_name);
2622                 unlock_ref(lock);
2623                 return -1;
2624         }
2625         unlock_ref(lock);
2626         return 0;
2627 }
2628
2629 int create_symref(const char *ref_target, const char *refs_heads_master,
2630                   const char *logmsg)
2631 {
2632         const char *lockpath;
2633         char ref[1000];
2634         int fd, len, written;
2635         char *git_HEAD = git_pathdup("%s", ref_target);
2636         unsigned char old_sha1[20], new_sha1[20];
2637
2638         if (logmsg && read_ref(ref_target, old_sha1))
2639                 hashclr(old_sha1);
2640
2641         if (safe_create_leading_directories(git_HEAD) < 0)
2642                 return error("unable to create directory for %s", git_HEAD);
2643
2644 #ifndef NO_SYMLINK_HEAD
2645         if (prefer_symlink_refs) {
2646                 unlink(git_HEAD);
2647                 if (!symlink(refs_heads_master, git_HEAD))
2648                         goto done;
2649                 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2650         }
2651 #endif
2652
2653         len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2654         if (sizeof(ref) <= len) {
2655                 error("refname too long: %s", refs_heads_master);
2656                 goto error_free_return;
2657         }
2658         lockpath = mkpath("%s.lock", git_HEAD);
2659         fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2660         if (fd < 0) {
2661                 error("Unable to open %s for writing", lockpath);
2662                 goto error_free_return;
2663         }
2664         written = write_in_full(fd, ref, len);
2665         if (close(fd) != 0 || written != len) {
2666                 error("Unable to write to %s", lockpath);
2667                 goto error_unlink_return;
2668         }
2669         if (rename(lockpath, git_HEAD) < 0) {
2670                 error("Unable to create %s", git_HEAD);
2671                 goto error_unlink_return;
2672         }
2673         if (adjust_shared_perm(git_HEAD)) {
2674                 error("Unable to fix permissions on %s", lockpath);
2675         error_unlink_return:
2676                 unlink_or_warn(lockpath);
2677         error_free_return:
2678                 free(git_HEAD);
2679                 return -1;
2680         }
2681
2682 #ifndef NO_SYMLINK_HEAD
2683         done:
2684 #endif
2685         if (logmsg && !read_ref(refs_heads_master, new_sha1))
2686                 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2687
2688         free(git_HEAD);
2689         return 0;
2690 }
2691
2692 static char *ref_msg(const char *line, const char *endp)
2693 {
2694         const char *ep;
2695         line += 82;
2696         ep = memchr(line, '\n', endp - line);
2697         if (!ep)
2698                 ep = endp;
2699         return xmemdupz(line, ep - line);
2700 }
2701
2702 int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2703                 unsigned char *sha1, char **msg,
2704                 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2705 {
2706         const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2707         char *tz_c;
2708         int logfd, tz, reccnt = 0;
2709         struct stat st;
2710         unsigned long date;
2711         unsigned char logged_sha1[20];
2712         void *log_mapped;
2713         size_t mapsz;
2714
2715         logfile = git_path("logs/%s", refname);
2716         logfd = open(logfile, O_RDONLY, 0);
2717         if (logfd < 0)
2718                 die_errno("Unable to read log '%s'", logfile);
2719         fstat(logfd, &st);
2720         if (!st.st_size)
2721                 die("Log %s is empty.", logfile);
2722         mapsz = xsize_t(st.st_size);
2723         log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2724         logdata = log_mapped;
2725         close(logfd);
2726
2727         lastrec = NULL;
2728         rec = logend = logdata + st.st_size;
2729         while (logdata < rec) {
2730                 reccnt++;
2731                 if (logdata < rec && *(rec-1) == '\n')
2732                         rec--;
2733                 lastgt = NULL;
2734                 while (logdata < rec && *(rec-1) != '\n') {
2735                         rec--;
2736                         if (*rec == '>')
2737                                 lastgt = rec;
2738                 }
2739                 if (!lastgt)
2740                         die("Log %s is corrupt.", logfile);
2741                 date = strtoul(lastgt + 1, &tz_c, 10);
2742                 if (date <= at_time || cnt == 0) {
2743                         tz = strtoul(tz_c, NULL, 10);
2744                         if (msg)
2745                                 *msg = ref_msg(rec, logend);
2746                         if (cutoff_time)
2747                                 *cutoff_time = date;
2748                         if (cutoff_tz)
2749                                 *cutoff_tz = tz;
2750                         if (cutoff_cnt)
2751                                 *cutoff_cnt = reccnt - 1;
2752                         if (lastrec) {
2753                                 if (get_sha1_hex(lastrec, logged_sha1))
2754                                         die("Log %s is corrupt.", logfile);
2755                                 if (get_sha1_hex(rec + 41, sha1))
2756                                         die("Log %s is corrupt.", logfile);
2757                                 if (hashcmp(logged_sha1, sha1)) {
2758                                         warning("Log %s has gap after %s.",
2759                                                 logfile, show_date(date, tz, DATE_RFC2822));
2760                                 }
2761                         }
2762                         else if (date == at_time) {
2763                                 if (get_sha1_hex(rec + 41, sha1))
2764                                         die("Log %s is corrupt.", logfile);
2765                         }
2766                         else {
2767                                 if (get_sha1_hex(rec + 41, logged_sha1))
2768                                         die("Log %s is corrupt.", logfile);
2769                                 if (hashcmp(logged_sha1, sha1)) {
2770                                         warning("Log %s unexpectedly ended on %s.",
2771                                                 logfile, show_date(date, tz, DATE_RFC2822));
2772                                 }
2773                         }
2774                         munmap(log_mapped, mapsz);
2775                         return 0;
2776                 }
2777                 lastrec = rec;
2778                 if (cnt > 0)
2779                         cnt--;
2780         }
2781
2782         rec = logdata;
2783         while (rec < logend && *rec != '>' && *rec != '\n')
2784                 rec++;
2785         if (rec == logend || *rec == '\n')
2786                 die("Log %s is corrupt.", logfile);
2787         date = strtoul(rec + 1, &tz_c, 10);
2788         tz = strtoul(tz_c, NULL, 10);
2789         if (get_sha1_hex(logdata, sha1))
2790                 die("Log %s is corrupt.", logfile);
2791         if (is_null_sha1(sha1)) {
2792                 if (get_sha1_hex(logdata + 41, sha1))
2793                         die("Log %s is corrupt.", logfile);
2794         }
2795         if (msg)
2796                 *msg = ref_msg(logdata, logend);
2797         munmap(log_mapped, mapsz);
2798
2799         if (cutoff_time)
2800                 *cutoff_time = date;
2801         if (cutoff_tz)
2802                 *cutoff_tz = tz;
2803         if (cutoff_cnt)
2804                 *cutoff_cnt = reccnt;
2805         return 1;
2806 }
2807
2808 static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
2809 {
2810         unsigned char osha1[20], nsha1[20];
2811         char *email_end, *message;
2812         unsigned long timestamp;
2813         int tz;
2814
2815         /* old SP new SP name <email> SP time TAB msg LF */
2816         if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
2817             get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
2818             get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
2819             !(email_end = strchr(sb->buf + 82, '>')) ||
2820             email_end[1] != ' ' ||
2821             !(timestamp = strtoul(email_end + 2, &message, 10)) ||
2822             !message || message[0] != ' ' ||
2823             (message[1] != '+' && message[1] != '-') ||
2824             !isdigit(message[2]) || !isdigit(message[3]) ||
2825             !isdigit(message[4]) || !isdigit(message[5]))
2826                 return 0; /* corrupt? */
2827         email_end[1] = '\0';
2828         tz = strtol(message + 1, NULL, 10);
2829         if (message[6] != '\t')
2830                 message += 6;
2831         else
2832                 message += 7;
2833         return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
2834 }
2835
2836 static char *find_beginning_of_line(char *bob, char *scan)
2837 {
2838         while (bob < scan && *(--scan) != '\n')
2839                 ; /* keep scanning backwards */
2840         /*
2841          * Return either beginning of the buffer, or LF at the end of
2842          * the previous line.
2843          */
2844         return scan;
2845 }
2846
2847 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2848 {
2849         struct strbuf sb = STRBUF_INIT;
2850         FILE *logfp;
2851         long pos;
2852         int ret = 0, at_tail = 1;
2853
2854         logfp = fopen(git_path("logs/%s", refname), "r");
2855         if (!logfp)
2856                 return -1;
2857
2858         /* Jump to the end */
2859         if (fseek(logfp, 0, SEEK_END) < 0)
2860                 return error("cannot seek back reflog for %s: %s",
2861                              refname, strerror(errno));
2862         pos = ftell(logfp);
2863         while (!ret && 0 < pos) {
2864                 int cnt;
2865                 size_t nread;
2866                 char buf[BUFSIZ];
2867                 char *endp, *scanp;
2868
2869                 /* Fill next block from the end */
2870                 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
2871                 if (fseek(logfp, pos - cnt, SEEK_SET))
2872                         return error("cannot seek back reflog for %s: %s",
2873                                      refname, strerror(errno));
2874                 nread = fread(buf, cnt, 1, logfp);
2875                 if (nread != 1)
2876                         return error("cannot read %d bytes from reflog for %s: %s",
2877                                      cnt, refname, strerror(errno));
2878                 pos -= cnt;
2879
2880                 scanp = endp = buf + cnt;
2881                 if (at_tail && scanp[-1] == '\n')
2882                         /* Looking at the final LF at the end of the file */
2883                         scanp--;
2884                 at_tail = 0;
2885
2886                 while (buf < scanp) {
2887                         /*
2888                          * terminating LF of the previous line, or the beginning
2889                          * of the buffer.
2890                          */
2891                         char *bp;
2892
2893                         bp = find_beginning_of_line(buf, scanp);
2894
2895                         if (*bp != '\n') {
2896                                 strbuf_splice(&sb, 0, 0, buf, endp - buf);
2897                                 if (pos)
2898                                         break; /* need to fill another block */
2899                                 scanp = buf - 1; /* leave loop */
2900                         } else {
2901                                 /*
2902                                  * (bp + 1) thru endp is the beginning of the
2903                                  * current line we have in sb
2904                                  */
2905                                 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
2906                                 scanp = bp;
2907                                 endp = bp + 1;
2908                         }
2909                         ret = show_one_reflog_ent(&sb, fn, cb_data);
2910                         strbuf_reset(&sb);
2911                         if (ret)
2912                                 break;
2913                 }
2914
2915         }
2916         if (!ret && sb.len)
2917                 ret = show_one_reflog_ent(&sb, fn, cb_data);
2918
2919         fclose(logfp);
2920         strbuf_release(&sb);
2921         return ret;
2922 }
2923
2924 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2925 {
2926         FILE *logfp;
2927         struct strbuf sb = STRBUF_INIT;
2928         int ret = 0;
2929
2930         logfp = fopen(git_path("logs/%s", refname), "r");
2931         if (!logfp)
2932                 return -1;
2933
2934         while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
2935                 ret = show_one_reflog_ent(&sb, fn, cb_data);
2936         fclose(logfp);
2937         strbuf_release(&sb);
2938         return ret;
2939 }
2940 /*
2941  * Call fn for each reflog in the namespace indicated by name.  name
2942  * must be empty or end with '/'.  Name will be used as a scratch
2943  * space, but its contents will be restored before return.
2944  */
2945 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
2946 {
2947         DIR *d = opendir(git_path("logs/%s", name->buf));
2948         int retval = 0;
2949         struct dirent *de;
2950         int oldlen = name->len;
2951
2952         if (!d)
2953                 return name->len ? errno : 0;
2954
2955         while ((de = readdir(d)) != NULL) {
2956                 struct stat st;
2957
2958                 if (de->d_name[0] == '.')
2959                         continue;
2960                 if (has_extension(de->d_name, ".lock"))
2961                         continue;
2962                 strbuf_addstr(name, de->d_name);
2963                 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
2964                         ; /* silently ignore */
2965                 } else {
2966                         if (S_ISDIR(st.st_mode)) {
2967                                 strbuf_addch(name, '/');
2968                                 retval = do_for_each_reflog(name, fn, cb_data);
2969                         } else {
2970                                 unsigned char sha1[20];
2971                                 if (read_ref_full(name->buf, sha1, 0, NULL))
2972                                         retval = error("bad ref for %s", name->buf);
2973                                 else
2974                                         retval = fn(name->buf, sha1, 0, cb_data);
2975                         }
2976                         if (retval)
2977                                 break;
2978                 }
2979                 strbuf_setlen(name, oldlen);
2980         }
2981         closedir(d);
2982         return retval;
2983 }
2984
2985 int for_each_reflog(each_ref_fn fn, void *cb_data)
2986 {
2987         int retval;
2988         struct strbuf name;
2989         strbuf_init(&name, PATH_MAX);
2990         retval = do_for_each_reflog(&name, fn, cb_data);
2991         strbuf_release(&name);
2992         return retval;
2993 }
2994
2995 int update_ref(const char *action, const char *refname,
2996                 const unsigned char *sha1, const unsigned char *oldval,
2997                 int flags, enum action_on_err onerr)
2998 {
2999         static struct ref_lock *lock;
3000         lock = lock_any_ref_for_update(refname, oldval, flags);
3001         if (!lock) {
3002                 const char *str = "Cannot lock the ref '%s'.";
3003                 switch (onerr) {
3004                 case MSG_ON_ERR: error(str, refname); break;
3005                 case DIE_ON_ERR: die(str, refname); break;
3006                 case QUIET_ON_ERR: break;
3007                 }
3008                 return 1;
3009         }
3010         if (write_ref_sha1(lock, sha1, action) < 0) {
3011                 const char *str = "Cannot update the ref '%s'.";
3012                 switch (onerr) {
3013                 case MSG_ON_ERR: error(str, refname); break;
3014                 case DIE_ON_ERR: die(str, refname); break;
3015                 case QUIET_ON_ERR: break;
3016                 }
3017                 return 1;
3018         }
3019         return 0;
3020 }
3021
3022 struct ref *find_ref_by_name(const struct ref *list, const char *name)
3023 {
3024         for ( ; list; list = list->next)
3025                 if (!strcmp(list->name, name))
3026                         return (struct ref *)list;
3027         return NULL;
3028 }
3029
3030 /*
3031  * generate a format suitable for scanf from a ref_rev_parse_rules
3032  * rule, that is replace the "%.*s" spec with a "%s" spec
3033  */
3034 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
3035 {
3036         char *spec;
3037
3038         spec = strstr(rule, "%.*s");
3039         if (!spec || strstr(spec + 4, "%.*s"))
3040                 die("invalid rule in ref_rev_parse_rules: %s", rule);
3041
3042         /* copy all until spec */
3043         strncpy(scanf_fmt, rule, spec - rule);
3044         scanf_fmt[spec - rule] = '\0';
3045         /* copy new spec */
3046         strcat(scanf_fmt, "%s");
3047         /* copy remaining rule */
3048         strcat(scanf_fmt, spec + 4);
3049
3050         return;
3051 }
3052
3053 char *shorten_unambiguous_ref(const char *refname, int strict)
3054 {
3055         int i;
3056         static char **scanf_fmts;
3057         static int nr_rules;
3058         char *short_name;
3059
3060         /* pre generate scanf formats from ref_rev_parse_rules[] */
3061         if (!nr_rules) {
3062                 size_t total_len = 0;
3063
3064                 /* the rule list is NULL terminated, count them first */
3065                 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
3066                         /* no +1 because strlen("%s") < strlen("%.*s") */
3067                         total_len += strlen(ref_rev_parse_rules[nr_rules]);
3068
3069                 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
3070
3071                 total_len = 0;
3072                 for (i = 0; i < nr_rules; i++) {
3073                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
3074                                         + total_len;
3075                         gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
3076                         total_len += strlen(ref_rev_parse_rules[i]);
3077                 }
3078         }
3079
3080         /* bail out if there are no rules */
3081         if (!nr_rules)
3082                 return xstrdup(refname);
3083
3084         /* buffer for scanf result, at most refname must fit */
3085         short_name = xstrdup(refname);
3086
3087         /* skip first rule, it will always match */
3088         for (i = nr_rules - 1; i > 0 ; --i) {
3089                 int j;
3090                 int rules_to_fail = i;
3091                 int short_name_len;
3092
3093                 if (1 != sscanf(refname, scanf_fmts[i], short_name))
3094                         continue;
3095
3096                 short_name_len = strlen(short_name);
3097
3098                 /*
3099                  * in strict mode, all (except the matched one) rules
3100                  * must fail to resolve to a valid non-ambiguous ref
3101                  */
3102                 if (strict)
3103                         rules_to_fail = nr_rules;
3104
3105                 /*
3106                  * check if the short name resolves to a valid ref,
3107                  * but use only rules prior to the matched one
3108                  */
3109                 for (j = 0; j < rules_to_fail; j++) {
3110                         const char *rule = ref_rev_parse_rules[j];
3111                         char refname[PATH_MAX];
3112
3113                         /* skip matched rule */
3114                         if (i == j)
3115                                 continue;
3116
3117                         /*
3118                          * the short name is ambiguous, if it resolves
3119                          * (with this previous rule) to a valid ref
3120                          * read_ref() returns 0 on success
3121                          */
3122                         mksnpath(refname, sizeof(refname),
3123                                  rule, short_name_len, short_name);
3124                         if (ref_exists(refname))
3125                                 break;
3126                 }
3127
3128                 /*
3129                  * short name is non-ambiguous if all previous rules
3130                  * haven't resolved to a valid ref
3131                  */
3132                 if (j == rules_to_fail)
3133                         return short_name;
3134         }
3135
3136         free(short_name);
3137         return xstrdup(refname);
3138 }
3139
3140 static struct string_list *hide_refs;
3141
3142 int parse_hide_refs_config(const char *var, const char *value, const char *section)
3143 {
3144         if (!strcmp("transfer.hiderefs", var) ||
3145             /* NEEDSWORK: use parse_config_key() once both are merged */
3146             (!prefixcmp(var, section) && var[strlen(section)] == '.' &&
3147              !strcmp(var + strlen(section), ".hiderefs"))) {
3148                 char *ref;
3149                 int len;
3150
3151                 if (!value)
3152                         return config_error_nonbool(var);
3153                 ref = xstrdup(value);
3154                 len = strlen(ref);
3155                 while (len && ref[len - 1] == '/')
3156                         ref[--len] = '\0';
3157                 if (!hide_refs) {
3158                         hide_refs = xcalloc(1, sizeof(*hide_refs));
3159                         hide_refs->strdup_strings = 1;
3160                 }
3161                 string_list_append(hide_refs, ref);
3162         }
3163         return 0;
3164 }
3165
3166 int ref_is_hidden(const char *refname)
3167 {
3168         struct string_list_item *item;
3169
3170         if (!hide_refs)
3171                 return 0;
3172         for_each_string_list_item(item, hide_refs) {
3173                 int len;
3174                 if (prefixcmp(refname, item->string))
3175                         continue;
3176                 len = strlen(item->string);
3177                 if (!refname[len] || refname[len] == '/')
3178                         return 1;
3179         }
3180         return 0;
3181 }