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