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