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