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