]> git.ipfire.org Git - thirdparty/git.git/blame - refs/files-backend.c
for_each_reflog(): reimplement using iterators
[thirdparty/git.git] / refs / files-backend.c
CommitLineData
7bd9bcf3
MH
1#include "../cache.h"
2#include "../refs.h"
3#include "refs-internal.h"
3bc581b9 4#include "../iterator.h"
2880d16f 5#include "../dir-iterator.h"
7bd9bcf3
MH
6#include "../lockfile.h"
7#include "../object.h"
8#include "../dir.h"
9
10struct ref_lock {
11 char *ref_name;
7bd9bcf3
MH
12 struct lock_file *lk;
13 struct object_id old_oid;
14};
15
16struct 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 */
24struct 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
42struct ref_cache;
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 */
70struct 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 ref_cache that contains this ref_dir. */
82 struct ref_cache *ref_cache;
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 */
148struct 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
162static void read_loose_refs(const char *dirname, struct ref_dir *dir);
163static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len);
164static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
165 const char *dirname, size_t len,
166 int incomplete);
167static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry);
168
169static 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_cache,
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
199static struct ref_entry *create_ref_entry(const char *refname,
200 const unsigned char *sha1, int flag,
201 int check_name)
202{
7bd9bcf3
MH
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);
96ffc06f 208 FLEX_ALLOC_STR(ref, name, refname);
7bd9bcf3
MH
209 hashcpy(ref->u.value.oid.hash, sha1);
210 oidclr(&ref->u.value.peeled);
7bd9bcf3
MH
211 ref->flag = flag;
212 return ref;
213}
214
215static void clear_ref_dir(struct ref_dir *dir);
216
217static 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 */
234static 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 */
249static 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 */
264static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
265 const char *dirname, size_t len,
266 int incomplete)
267{
268 struct ref_entry *direntry;
96ffc06f 269 FLEX_ALLOC_MEM(direntry, name, dirname, len);
7bd9bcf3
MH
270 direntry->u.subdir.ref_cache = ref_cache;
271 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
272 return direntry;
273}
274
275static 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
282static void sort_ref_dir(struct ref_dir *dir);
283
284struct string_slice {
285 size_t len;
286 const char *str;
287};
288
289static 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 */
304static 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 */
331static 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_cache, 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 */
363static 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 */
386static 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 */
414static 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 */
456static 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 */
470static 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 */
492static 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
7bd9bcf3 517/*
a8739244
MH
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.
7bd9bcf3 521 */
a8739244
MH
522static int ref_resolves_to_object(const char *refname,
523 const struct object_id *oid,
524 unsigned int flags)
7bd9bcf3 525{
a8739244 526 if (flags & REF_ISBROKEN)
7bd9bcf3 527 return 0;
a8739244
MH
528 if (!has_sha1_file(oid->hash)) {
529 error("%s does not point to a valid object!", refname);
7bd9bcf3
MH
530 return 0;
531 }
532 return 1;
533}
534
a8739244
MH
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 */
540static 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
7bd9bcf3
MH
546typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);
547
7bd9bcf3
MH
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 */
555static 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
7bd9bcf3
MH
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 */
582static 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
3bc581b9
MH
592/*
593 * A level in the reference hierarchy that is currently being iterated
594 * through.
595 */
596struct 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 */
616struct 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
640static 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
681static enum peel_status peel_entry(struct ref_entry *entry, int repeel);
682
683static 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
704static 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
714static 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
720static 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
7bd9bcf3
MH
739struct nonmatching_ref_data {
740 const struct string_list *skip;
741 const char *conflicting_refname;
742};
743
744static 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 */
760static 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;
0845122c 767 const char *extra_refname;
7bd9bcf3
MH
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
0845122c
DT
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;
7bd9bcf3
MH
879
880cleanup:
881 strbuf_release(&dirname);
882 return ret;
883}
884
885struct 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 ref_cache::packed if any. The
891 * data will not be freed as long as the reference count is
892 * 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 */
913static struct ref_cache {
914 struct ref_cache *next;
915 struct ref_entry *loose;
916 struct packed_ref_cache *packed;
917 /*
918 * The submodule name, or "" for the main repo. We allocate
919 * length 1 rather than FLEX_ARRAY so that the main ref_cache
920 * is initialized correctly.
921 */
922 char name[1];
923} ref_cache, *submodule_ref_caches;
924
925/* Lock used for the main packed-refs file: */
926static struct lock_file packlock;
927
928/*
929 * Increment the reference count of *packed_refs.
930 */
931static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
932{
933 packed_refs->referrers++;
934}
935
936/*
937 * Decrease the reference count of *packed_refs. If it goes to zero,
938 * free *packed_refs and return true; otherwise return false.
939 */
940static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
941{
942 if (!--packed_refs->referrers) {
943 free_ref_entry(packed_refs->root);
944 stat_validity_clear(&packed_refs->validity);
945 free(packed_refs);
946 return 1;
947 } else {
948 return 0;
949 }
950}
951
952static void clear_packed_ref_cache(struct ref_cache *refs)
953{
954 if (refs->packed) {
955 struct packed_ref_cache *packed_refs = refs->packed;
956
957 if (packed_refs->lock)
958 die("internal error: packed-ref cache cleared while locked");
959 refs->packed = NULL;
960 release_packed_ref_cache(packed_refs);
961 }
962}
963
964static void clear_loose_ref_cache(struct ref_cache *refs)
965{
966 if (refs->loose) {
967 free_ref_entry(refs->loose);
968 refs->loose = NULL;
969 }
970}
971
a2d5156c
JK
972/*
973 * Create a new submodule ref cache and add it to the internal
974 * set of caches.
975 */
7bd9bcf3
MH
976static struct ref_cache *create_ref_cache(const char *submodule)
977{
7bd9bcf3
MH
978 struct ref_cache *refs;
979 if (!submodule)
980 submodule = "";
96ffc06f 981 FLEX_ALLOC_STR(refs, name, submodule);
a2d5156c
JK
982 refs->next = submodule_ref_caches;
983 submodule_ref_caches = refs;
7bd9bcf3
MH
984 return refs;
985}
986
a2d5156c 987static struct ref_cache *lookup_ref_cache(const char *submodule)
7bd9bcf3
MH
988{
989 struct ref_cache *refs;
990
991 if (!submodule || !*submodule)
992 return &ref_cache;
993
994 for (refs = submodule_ref_caches; refs; refs = refs->next)
995 if (!strcmp(submodule, refs->name))
996 return refs;
a2d5156c
JK
997 return NULL;
998}
7bd9bcf3 999
a2d5156c
JK
1000/*
1001 * Return a pointer to a ref_cache for the specified submodule. For
2eed2780
MH
1002 * the main repository, use submodule==NULL; such a call cannot fail.
1003 * For a submodule, the submodule must exist and be a nonbare
1004 * repository, otherwise return NULL.
1005 *
1006 * The returned structure will be allocated and initialized but not
1007 * necessarily populated; it should not be freed.
a2d5156c
JK
1008 */
1009static struct ref_cache *get_ref_cache(const char *submodule)
1010{
1011 struct ref_cache *refs = lookup_ref_cache(submodule);
2eed2780
MH
1012
1013 if (!refs) {
1014 struct strbuf submodule_sb = STRBUF_INIT;
1015
1016 strbuf_addstr(&submodule_sb, submodule);
1017 if (is_nonbare_repository_dir(&submodule_sb))
1018 refs = create_ref_cache(submodule);
1019 strbuf_release(&submodule_sb);
1020 }
1021
7bd9bcf3
MH
1022 return refs;
1023}
1024
1025/* The length of a peeled reference line in packed-refs, including EOL: */
1026#define PEELED_LINE_LENGTH 42
1027
1028/*
1029 * The packed-refs header line that we write out. Perhaps other
1030 * traits will be added later. The trailing space is required.
1031 */
1032static const char PACKED_REFS_HEADER[] =
1033 "# pack-refs with: peeled fully-peeled \n";
1034
1035/*
1036 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
1037 * Return a pointer to the refname within the line (null-terminated),
1038 * or NULL if there was a problem.
1039 */
1040static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)
1041{
1042 const char *ref;
1043
1044 /*
1045 * 42: the answer to everything.
1046 *
1047 * In this case, it happens to be the answer to
1048 * 40 (length of sha1 hex representation)
1049 * +1 (space in between hex and name)
1050 * +1 (newline at the end of the line)
1051 */
1052 if (line->len <= 42)
1053 return NULL;
1054
1055 if (get_sha1_hex(line->buf, sha1) < 0)
1056 return NULL;
1057 if (!isspace(line->buf[40]))
1058 return NULL;
1059
1060 ref = line->buf + 41;
1061 if (isspace(*ref))
1062 return NULL;
1063
1064 if (line->buf[line->len - 1] != '\n')
1065 return NULL;
1066 line->buf[--line->len] = 0;
1067
1068 return ref;
1069}
1070
1071/*
1072 * Read f, which is a packed-refs file, into dir.
1073 *
1074 * A comment line of the form "# pack-refs with: " may contain zero or
1075 * more traits. We interpret the traits as follows:
1076 *
1077 * No traits:
1078 *
1079 * Probably no references are peeled. But if the file contains a
1080 * peeled value for a reference, we will use it.
1081 *
1082 * peeled:
1083 *
1084 * References under "refs/tags/", if they *can* be peeled, *are*
1085 * peeled in this file. References outside of "refs/tags/" are
1086 * probably not peeled even if they could have been, but if we find
1087 * a peeled value for such a reference we will use it.
1088 *
1089 * fully-peeled:
1090 *
1091 * All references in the file that can be peeled are peeled.
1092 * Inversely (and this is more important), any references in the
1093 * file for which no peeled value is recorded is not peelable. This
1094 * trait should typically be written alongside "peeled" for
1095 * compatibility with older clients, but we do not require it
1096 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1097 */
1098static void read_packed_refs(FILE *f, struct ref_dir *dir)
1099{
1100 struct ref_entry *last = NULL;
1101 struct strbuf line = STRBUF_INIT;
1102 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1103
1104 while (strbuf_getwholeline(&line, f, '\n') != EOF) {
1105 unsigned char sha1[20];
1106 const char *refname;
1107 const char *traits;
1108
1109 if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {
1110 if (strstr(traits, " fully-peeled "))
1111 peeled = PEELED_FULLY;
1112 else if (strstr(traits, " peeled "))
1113 peeled = PEELED_TAGS;
1114 /* perhaps other traits later as well */
1115 continue;
1116 }
1117
1118 refname = parse_ref_line(&line, sha1);
1119 if (refname) {
1120 int flag = REF_ISPACKED;
1121
1122 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1123 if (!refname_is_safe(refname))
1124 die("packed refname is dangerous: %s", refname);
1125 hashclr(sha1);
1126 flag |= REF_BAD_NAME | REF_ISBROKEN;
1127 }
1128 last = create_ref_entry(refname, sha1, flag, 0);
1129 if (peeled == PEELED_FULLY ||
1130 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1131 last->flag |= REF_KNOWS_PEELED;
1132 add_ref(dir, last);
1133 continue;
1134 }
1135 if (last &&
1136 line.buf[0] == '^' &&
1137 line.len == PEELED_LINE_LENGTH &&
1138 line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&
1139 !get_sha1_hex(line.buf + 1, sha1)) {
1140 hashcpy(last->u.value.peeled.hash, sha1);
1141 /*
1142 * Regardless of what the file header said,
1143 * we definitely know the value of *this*
1144 * reference:
1145 */
1146 last->flag |= REF_KNOWS_PEELED;
1147 }
1148 }
1149
1150 strbuf_release(&line);
1151}
1152
1153/*
1154 * Get the packed_ref_cache for the specified ref_cache, creating it
1155 * if necessary.
1156 */
1157static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1158{
1159 char *packed_refs_file;
1160
1161 if (*refs->name)
1162 packed_refs_file = git_pathdup_submodule(refs->name, "packed-refs");
1163 else
1164 packed_refs_file = git_pathdup("packed-refs");
1165
1166 if (refs->packed &&
1167 !stat_validity_check(&refs->packed->validity, packed_refs_file))
1168 clear_packed_ref_cache(refs);
1169
1170 if (!refs->packed) {
1171 FILE *f;
1172
1173 refs->packed = xcalloc(1, sizeof(*refs->packed));
1174 acquire_packed_ref_cache(refs->packed);
1175 refs->packed->root = create_dir_entry(refs, "", 0, 0);
1176 f = fopen(packed_refs_file, "r");
1177 if (f) {
1178 stat_validity_update(&refs->packed->validity, fileno(f));
1179 read_packed_refs(f, get_ref_dir(refs->packed->root));
1180 fclose(f);
1181 }
1182 }
1183 free(packed_refs_file);
1184 return refs->packed;
1185}
1186
1187static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1188{
1189 return get_ref_dir(packed_ref_cache->root);
1190}
1191
1192static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1193{
1194 return get_packed_ref_dir(get_packed_ref_cache(refs));
1195}
1196
1197/*
1198 * Add a reference to the in-memory packed reference cache. This may
1199 * only be called while the packed-refs file is locked (see
1200 * lock_packed_refs()). To actually write the packed-refs file, call
1201 * commit_packed_refs().
1202 */
1203static void add_packed_ref(const char *refname, const unsigned char *sha1)
1204{
1205 struct packed_ref_cache *packed_ref_cache =
1206 get_packed_ref_cache(&ref_cache);
1207
1208 if (!packed_ref_cache->lock)
1209 die("internal error: packed refs not locked");
1210 add_ref(get_packed_ref_dir(packed_ref_cache),
1211 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1212}
1213
1214/*
1215 * Read the loose references from the namespace dirname into dir
1216 * (without recursing). dirname must end with '/'. dir must be the
1217 * directory entry corresponding to dirname.
1218 */
1219static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1220{
1221 struct ref_cache *refs = dir->ref_cache;
1222 DIR *d;
1223 struct dirent *de;
1224 int dirnamelen = strlen(dirname);
1225 struct strbuf refname;
1226 struct strbuf path = STRBUF_INIT;
1227 size_t path_baselen;
1228
1229 if (*refs->name)
1230 strbuf_git_path_submodule(&path, refs->name, "%s", dirname);
1231 else
1232 strbuf_git_path(&path, "%s", dirname);
1233 path_baselen = path.len;
1234
1235 d = opendir(path.buf);
1236 if (!d) {
1237 strbuf_release(&path);
1238 return;
1239 }
1240
1241 strbuf_init(&refname, dirnamelen + 257);
1242 strbuf_add(&refname, dirname, dirnamelen);
1243
1244 while ((de = readdir(d)) != NULL) {
1245 unsigned char sha1[20];
1246 struct stat st;
1247 int flag;
1248
1249 if (de->d_name[0] == '.')
1250 continue;
1251 if (ends_with(de->d_name, ".lock"))
1252 continue;
1253 strbuf_addstr(&refname, de->d_name);
1254 strbuf_addstr(&path, de->d_name);
1255 if (stat(path.buf, &st) < 0) {
1256 ; /* silently ignore */
1257 } else if (S_ISDIR(st.st_mode)) {
1258 strbuf_addch(&refname, '/');
1259 add_entry_to_dir(dir,
1260 create_dir_entry(refs, refname.buf,
1261 refname.len, 1));
1262 } else {
1263 int read_ok;
1264
1265 if (*refs->name) {
1266 hashclr(sha1);
1267 flag = 0;
1268 read_ok = !resolve_gitlink_ref(refs->name,
1269 refname.buf, sha1);
1270 } else {
1271 read_ok = !read_ref_full(refname.buf,
1272 RESOLVE_REF_READING,
1273 sha1, &flag);
1274 }
1275
1276 if (!read_ok) {
1277 hashclr(sha1);
1278 flag |= REF_ISBROKEN;
1279 } else if (is_null_sha1(sha1)) {
1280 /*
1281 * It is so astronomically unlikely
1282 * that NULL_SHA1 is the SHA-1 of an
1283 * actual object that we consider its
1284 * appearance in a loose reference
1285 * file to be repo corruption
1286 * (probably due to a software bug).
1287 */
1288 flag |= REF_ISBROKEN;
1289 }
1290
1291 if (check_refname_format(refname.buf,
1292 REFNAME_ALLOW_ONELEVEL)) {
1293 if (!refname_is_safe(refname.buf))
1294 die("loose refname is dangerous: %s", refname.buf);
1295 hashclr(sha1);
1296 flag |= REF_BAD_NAME | REF_ISBROKEN;
1297 }
1298 add_entry_to_dir(dir,
1299 create_ref_entry(refname.buf, sha1, flag, 0));
1300 }
1301 strbuf_setlen(&refname, dirnamelen);
1302 strbuf_setlen(&path, path_baselen);
1303 }
1304 strbuf_release(&refname);
1305 strbuf_release(&path);
1306 closedir(d);
1307}
1308
1309static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1310{
1311 if (!refs->loose) {
1312 /*
1313 * Mark the top-level directory complete because we
1314 * are about to read the only subdirectory that can
1315 * hold references:
1316 */
1317 refs->loose = create_dir_entry(refs, "", 0, 0);
1318 /*
1319 * Create an incomplete entry for "refs/":
1320 */
1321 add_entry_to_dir(get_ref_dir(refs->loose),
1322 create_dir_entry(refs, "refs/", 5, 1));
1323 }
1324 return get_ref_dir(refs->loose);
1325}
1326
7bd9bcf3
MH
1327#define MAXREFLEN (1024)
1328
1329/*
1330 * Called by resolve_gitlink_ref_recursive() after it failed to read
1331 * from the loose refs in ref_cache refs. Find <refname> in the
1332 * packed-refs file for the submodule.
1333 */
1334static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1335 const char *refname, unsigned char *sha1)
1336{
1337 struct ref_entry *ref;
1338 struct ref_dir *dir = get_packed_refs(refs);
1339
1340 ref = find_ref(dir, refname);
1341 if (ref == NULL)
1342 return -1;
1343
1344 hashcpy(sha1, ref->u.value.oid.hash);
1345 return 0;
1346}
1347
1348static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1349 const char *refname, unsigned char *sha1,
1350 int recursion)
1351{
1352 int fd, len;
1353 char buffer[128], *p;
1354 char *path;
1355
2d0663b2 1356 if (recursion > SYMREF_MAXDEPTH || strlen(refname) > MAXREFLEN)
7bd9bcf3
MH
1357 return -1;
1358 path = *refs->name
1359 ? git_pathdup_submodule(refs->name, "%s", refname)
1360 : git_pathdup("%s", refname);
1361 fd = open(path, O_RDONLY);
1362 free(path);
1363 if (fd < 0)
1364 return resolve_gitlink_packed_ref(refs, refname, sha1);
1365
1366 len = read(fd, buffer, sizeof(buffer)-1);
1367 close(fd);
1368 if (len < 0)
1369 return -1;
1370 while (len && isspace(buffer[len-1]))
1371 len--;
1372 buffer[len] = 0;
1373
1374 /* Was it a detached head or an old-fashioned symlink? */
1375 if (!get_sha1_hex(buffer, sha1))
1376 return 0;
1377
1378 /* Symref? */
1379 if (strncmp(buffer, "ref:", 4))
1380 return -1;
1381 p = buffer + 4;
1382 while (isspace(*p))
1383 p++;
1384
1385 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1386}
1387
1388int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1389{
1390 int len = strlen(path), retval;
a2d5156c 1391 struct strbuf submodule = STRBUF_INIT;
7bd9bcf3
MH
1392 struct ref_cache *refs;
1393
1394 while (len && path[len-1] == '/')
1395 len--;
1396 if (!len)
1397 return -1;
a2d5156c
JK
1398
1399 strbuf_add(&submodule, path, len);
2eed2780 1400 refs = get_ref_cache(submodule.buf);
a2d5156c 1401 if (!refs) {
2eed2780
MH
1402 strbuf_release(&submodule);
1403 return -1;
a2d5156c
JK
1404 }
1405 strbuf_release(&submodule);
7bd9bcf3
MH
1406
1407 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1408 return retval;
1409}
1410
1411/*
1412 * Return the ref_entry for the given refname from the packed
1413 * references. If it does not exist, return NULL.
1414 */
1415static struct ref_entry *get_packed_ref(const char *refname)
1416{
1417 return find_ref(get_packed_refs(&ref_cache), refname);
1418}
1419
1420/*
419c6f4c 1421 * A loose ref file doesn't exist; check for a packed ref.
7bd9bcf3
MH
1422 */
1423static int resolve_missing_loose_ref(const char *refname,
7bd9bcf3 1424 unsigned char *sha1,
89e82389 1425 unsigned int *flags)
7bd9bcf3
MH
1426{
1427 struct ref_entry *entry;
1428
1429 /*
1430 * The loose reference file does not exist; check for a packed
1431 * reference.
1432 */
1433 entry = get_packed_ref(refname);
1434 if (entry) {
1435 hashcpy(sha1, entry->u.value.oid.hash);
a70a93b7 1436 *flags |= REF_ISPACKED;
7bd9bcf3
MH
1437 return 0;
1438 }
419c6f4c
MH
1439 /* refname is not a packed reference. */
1440 return -1;
7bd9bcf3
MH
1441}
1442
2d0663b2 1443int read_raw_ref(const char *refname, unsigned char *sha1,
92b38093 1444 struct strbuf *referent, unsigned int *type)
7bd9bcf3 1445{
42a38cf7
MH
1446 struct strbuf sb_contents = STRBUF_INIT;
1447 struct strbuf sb_path = STRBUF_INIT;
7048653a
DT
1448 const char *path;
1449 const char *buf;
1450 struct stat st;
1451 int fd;
42a38cf7
MH
1452 int ret = -1;
1453 int save_errno;
7bd9bcf3 1454
fa96ea1b 1455 *type = 0;
42a38cf7
MH
1456 strbuf_reset(&sb_path);
1457 strbuf_git_path(&sb_path, "%s", refname);
1458 path = sb_path.buf;
7bd9bcf3 1459
7048653a
DT
1460stat_ref:
1461 /*
1462 * We might have to loop back here to avoid a race
1463 * condition: first we lstat() the file, then we try
1464 * to read it as a link or as a file. But if somebody
1465 * changes the type of the file (file <-> directory
1466 * <-> symlink) between the lstat() and reading, then
1467 * we don't want to report that as an error but rather
1468 * try again starting with the lstat().
1469 */
7bd9bcf3 1470
7048653a
DT
1471 if (lstat(path, &st) < 0) {
1472 if (errno != ENOENT)
42a38cf7 1473 goto out;
3a0b6b9a 1474 if (resolve_missing_loose_ref(refname, sha1, type)) {
7048653a 1475 errno = ENOENT;
42a38cf7 1476 goto out;
7bd9bcf3 1477 }
42a38cf7
MH
1478 ret = 0;
1479 goto out;
7bd9bcf3 1480 }
7bd9bcf3 1481
7048653a
DT
1482 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1483 if (S_ISLNK(st.st_mode)) {
42a38cf7
MH
1484 strbuf_reset(&sb_contents);
1485 if (strbuf_readlink(&sb_contents, path, 0) < 0) {
7048653a 1486 if (errno == ENOENT || errno == EINVAL)
7bd9bcf3
MH
1487 /* inconsistent with lstat; retry */
1488 goto stat_ref;
1489 else
42a38cf7 1490 goto out;
7bd9bcf3 1491 }
42a38cf7
MH
1492 if (starts_with(sb_contents.buf, "refs/") &&
1493 !check_refname_format(sb_contents.buf, 0)) {
92b38093 1494 strbuf_swap(&sb_contents, referent);
3a0b6b9a 1495 *type |= REF_ISSYMREF;
42a38cf7
MH
1496 ret = 0;
1497 goto out;
7bd9bcf3 1498 }
7048653a 1499 }
7bd9bcf3 1500
7048653a
DT
1501 /* Is it a directory? */
1502 if (S_ISDIR(st.st_mode)) {
e167a567
MH
1503 /*
1504 * Even though there is a directory where the loose
1505 * ref is supposed to be, there could still be a
1506 * packed ref:
1507 */
3a0b6b9a 1508 if (resolve_missing_loose_ref(refname, sha1, type)) {
e167a567
MH
1509 errno = EISDIR;
1510 goto out;
1511 }
1512 ret = 0;
42a38cf7 1513 goto out;
7048653a
DT
1514 }
1515
1516 /*
1517 * Anything else, just open it and try to use it as
1518 * a ref
1519 */
1520 fd = open(path, O_RDONLY);
1521 if (fd < 0) {
1522 if (errno == ENOENT)
1523 /* inconsistent with lstat; retry */
1524 goto stat_ref;
1525 else
42a38cf7 1526 goto out;
7048653a 1527 }
42a38cf7
MH
1528 strbuf_reset(&sb_contents);
1529 if (strbuf_read(&sb_contents, fd, 256) < 0) {
7048653a
DT
1530 int save_errno = errno;
1531 close(fd);
1532 errno = save_errno;
42a38cf7 1533 goto out;
7048653a
DT
1534 }
1535 close(fd);
42a38cf7
MH
1536 strbuf_rtrim(&sb_contents);
1537 buf = sb_contents.buf;
7048653a
DT
1538 if (starts_with(buf, "ref:")) {
1539 buf += 4;
7bd9bcf3
MH
1540 while (isspace(*buf))
1541 buf++;
7048653a 1542
92b38093
MH
1543 strbuf_reset(referent);
1544 strbuf_addstr(referent, buf);
3a0b6b9a 1545 *type |= REF_ISSYMREF;
42a38cf7
MH
1546 ret = 0;
1547 goto out;
7bd9bcf3 1548 }
7bd9bcf3 1549
7048653a
DT
1550 /*
1551 * Please note that FETCH_HEAD has additional
1552 * data after the sha.
1553 */
1554 if (get_sha1_hex(buf, sha1) ||
1555 (buf[40] != '\0' && !isspace(buf[40]))) {
3a0b6b9a 1556 *type |= REF_ISBROKEN;
7048653a 1557 errno = EINVAL;
42a38cf7 1558 goto out;
7048653a
DT
1559 }
1560
42a38cf7 1561 ret = 0;
7bd9bcf3 1562
42a38cf7
MH
1563out:
1564 save_errno = errno;
7bd9bcf3
MH
1565 strbuf_release(&sb_path);
1566 strbuf_release(&sb_contents);
42a38cf7 1567 errno = save_errno;
7bd9bcf3
MH
1568 return ret;
1569}
1570
8415d247
MH
1571static void unlock_ref(struct ref_lock *lock)
1572{
1573 /* Do not free lock->lk -- atexit() still looks at them */
1574 if (lock->lk)
1575 rollback_lock_file(lock->lk);
1576 free(lock->ref_name);
8415d247
MH
1577 free(lock);
1578}
1579
92b1551b
MH
1580/*
1581 * Lock refname, without following symrefs, and set *lock_p to point
1582 * at a newly-allocated lock object. Fill in lock->old_oid, referent,
1583 * and type similarly to read_raw_ref().
1584 *
1585 * The caller must verify that refname is a "safe" reference name (in
1586 * the sense of refname_is_safe()) before calling this function.
1587 *
1588 * If the reference doesn't already exist, verify that refname doesn't
1589 * have a D/F conflict with any existing references. extras and skip
1590 * are passed to verify_refname_available_dir() for this check.
1591 *
1592 * If mustexist is not set and the reference is not found or is
1593 * broken, lock the reference anyway but clear sha1.
1594 *
1595 * Return 0 on success. On failure, write an error message to err and
1596 * return TRANSACTION_NAME_CONFLICT or TRANSACTION_GENERIC_ERROR.
1597 *
1598 * Implementation note: This function is basically
1599 *
1600 * lock reference
1601 * read_raw_ref()
1602 *
1603 * but it includes a lot more code to
1604 * - Deal with possible races with other processes
1605 * - Avoid calling verify_refname_available_dir() when it can be
1606 * avoided, namely if we were successfully able to read the ref
1607 * - Generate informative error messages in the case of failure
1608 */
1609static int lock_raw_ref(const char *refname, int mustexist,
1610 const struct string_list *extras,
1611 const struct string_list *skip,
1612 struct ref_lock **lock_p,
1613 struct strbuf *referent,
1614 unsigned int *type,
1615 struct strbuf *err)
1616{
1617 struct ref_lock *lock;
1618 struct strbuf ref_file = STRBUF_INIT;
1619 int attempts_remaining = 3;
1620 int ret = TRANSACTION_GENERIC_ERROR;
1621
1622 assert(err);
1623 *type = 0;
1624
1625 /* First lock the file so it can't change out from under us. */
1626
1627 *lock_p = lock = xcalloc(1, sizeof(*lock));
1628
1629 lock->ref_name = xstrdup(refname);
92b1551b
MH
1630 strbuf_git_path(&ref_file, "%s", refname);
1631
1632retry:
1633 switch (safe_create_leading_directories(ref_file.buf)) {
1634 case SCLD_OK:
1635 break; /* success */
1636 case SCLD_EXISTS:
1637 /*
1638 * Suppose refname is "refs/foo/bar". We just failed
1639 * to create the containing directory, "refs/foo",
1640 * because there was a non-directory in the way. This
1641 * indicates a D/F conflict, probably because of
1642 * another reference such as "refs/foo". There is no
1643 * reason to expect this error to be transitory.
1644 */
1645 if (verify_refname_available(refname, extras, skip, err)) {
1646 if (mustexist) {
1647 /*
1648 * To the user the relevant error is
1649 * that the "mustexist" reference is
1650 * missing:
1651 */
1652 strbuf_reset(err);
1653 strbuf_addf(err, "unable to resolve reference '%s'",
1654 refname);
1655 } else {
1656 /*
1657 * The error message set by
1658 * verify_refname_available_dir() is OK.
1659 */
1660 ret = TRANSACTION_NAME_CONFLICT;
1661 }
1662 } else {
1663 /*
1664 * The file that is in the way isn't a loose
1665 * reference. Report it as a low-level
1666 * failure.
1667 */
1668 strbuf_addf(err, "unable to create lock file %s.lock; "
1669 "non-directory in the way",
1670 ref_file.buf);
1671 }
1672 goto error_return;
1673 case SCLD_VANISHED:
1674 /* Maybe another process was tidying up. Try again. */
1675 if (--attempts_remaining > 0)
1676 goto retry;
1677 /* fall through */
1678 default:
1679 strbuf_addf(err, "unable to create directory for %s",
1680 ref_file.buf);
1681 goto error_return;
1682 }
1683
1684 if (!lock->lk)
1685 lock->lk = xcalloc(1, sizeof(struct lock_file));
1686
1687 if (hold_lock_file_for_update(lock->lk, ref_file.buf, LOCK_NO_DEREF) < 0) {
1688 if (errno == ENOENT && --attempts_remaining > 0) {
1689 /*
1690 * Maybe somebody just deleted one of the
1691 * directories leading to ref_file. Try
1692 * again:
1693 */
1694 goto retry;
1695 } else {
1696 unable_to_lock_message(ref_file.buf, errno, err);
1697 goto error_return;
1698 }
1699 }
1700
1701 /*
1702 * Now we hold the lock and can read the reference without
1703 * fear that its value will change.
1704 */
1705
1706 if (read_raw_ref(refname, lock->old_oid.hash, referent, type)) {
1707 if (errno == ENOENT) {
1708 if (mustexist) {
1709 /* Garden variety missing reference. */
1710 strbuf_addf(err, "unable to resolve reference '%s'",
1711 refname);
1712 goto error_return;
1713 } else {
1714 /*
1715 * Reference is missing, but that's OK. We
1716 * know that there is not a conflict with
1717 * another loose reference because
1718 * (supposing that we are trying to lock
1719 * reference "refs/foo/bar"):
1720 *
1721 * - We were successfully able to create
1722 * the lockfile refs/foo/bar.lock, so we
1723 * know there cannot be a loose reference
1724 * named "refs/foo".
1725 *
1726 * - We got ENOENT and not EISDIR, so we
1727 * know that there cannot be a loose
1728 * reference named "refs/foo/bar/baz".
1729 */
1730 }
1731 } else if (errno == EISDIR) {
1732 /*
1733 * There is a directory in the way. It might have
1734 * contained references that have been deleted. If
1735 * we don't require that the reference already
1736 * exists, try to remove the directory so that it
1737 * doesn't cause trouble when we want to rename the
1738 * lockfile into place later.
1739 */
1740 if (mustexist) {
1741 /* Garden variety missing reference. */
1742 strbuf_addf(err, "unable to resolve reference '%s'",
1743 refname);
1744 goto error_return;
1745 } else if (remove_dir_recursively(&ref_file,
1746 REMOVE_DIR_EMPTY_ONLY)) {
1747 if (verify_refname_available_dir(
1748 refname, extras, skip,
1749 get_loose_refs(&ref_cache),
1750 err)) {
1751 /*
1752 * The error message set by
1753 * verify_refname_available() is OK.
1754 */
1755 ret = TRANSACTION_NAME_CONFLICT;
1756 goto error_return;
1757 } else {
1758 /*
1759 * We can't delete the directory,
1760 * but we also don't know of any
1761 * references that it should
1762 * contain.
1763 */
1764 strbuf_addf(err, "there is a non-empty directory '%s' "
1765 "blocking reference '%s'",
1766 ref_file.buf, refname);
1767 goto error_return;
1768 }
1769 }
1770 } else if (errno == EINVAL && (*type & REF_ISBROKEN)) {
1771 strbuf_addf(err, "unable to resolve reference '%s': "
1772 "reference broken", refname);
1773 goto error_return;
1774 } else {
1775 strbuf_addf(err, "unable to resolve reference '%s': %s",
1776 refname, strerror(errno));
1777 goto error_return;
1778 }
1779
1780 /*
1781 * If the ref did not exist and we are creating it,
1782 * make sure there is no existing packed ref whose
1783 * name begins with our refname, nor a packed ref
1784 * whose name is a proper prefix of our refname.
1785 */
1786 if (verify_refname_available_dir(
1787 refname, extras, skip,
1788 get_packed_refs(&ref_cache),
1789 err)) {
1790 goto error_return;
1791 }
1792 }
1793
1794 ret = 0;
1795 goto out;
1796
1797error_return:
1798 unlock_ref(lock);
1799 *lock_p = NULL;
1800
1801out:
1802 strbuf_release(&ref_file);
1803 return ret;
1804}
1805
7bd9bcf3
MH
1806/*
1807 * Peel the entry (if possible) and return its new peel_status. If
1808 * repeel is true, re-peel the entry even if there is an old peeled
1809 * value that is already stored in it.
1810 *
1811 * It is OK to call this function with a packed reference entry that
1812 * might be stale and might even refer to an object that has since
1813 * been garbage-collected. In such a case, if the entry has
1814 * REF_KNOWS_PEELED then leave the status unchanged and return
1815 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1816 */
1817static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1818{
1819 enum peel_status status;
1820
1821 if (entry->flag & REF_KNOWS_PEELED) {
1822 if (repeel) {
1823 entry->flag &= ~REF_KNOWS_PEELED;
1824 oidclr(&entry->u.value.peeled);
1825 } else {
1826 return is_null_oid(&entry->u.value.peeled) ?
1827 PEEL_NON_TAG : PEEL_PEELED;
1828 }
1829 }
1830 if (entry->flag & REF_ISBROKEN)
1831 return PEEL_BROKEN;
1832 if (entry->flag & REF_ISSYMREF)
1833 return PEEL_IS_SYMREF;
1834
1835 status = peel_object(entry->u.value.oid.hash, entry->u.value.peeled.hash);
1836 if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1837 entry->flag |= REF_KNOWS_PEELED;
1838 return status;
1839}
1840
1841int peel_ref(const char *refname, unsigned char *sha1)
1842{
1843 int flag;
1844 unsigned char base[20];
1845
4c4de895
MH
1846 if (current_ref_iter && current_ref_iter->refname == refname) {
1847 struct object_id peeled;
1848
1849 if (ref_iterator_peel(current_ref_iter, &peeled))
7bd9bcf3 1850 return -1;
4c4de895 1851 hashcpy(sha1, peeled.hash);
7bd9bcf3
MH
1852 return 0;
1853 }
1854
1855 if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1856 return -1;
1857
1858 /*
1859 * If the reference is packed, read its ref_entry from the
1860 * cache in the hope that we already know its peeled value.
1861 * We only try this optimization on packed references because
1862 * (a) forcing the filling of the loose reference cache could
1863 * be expensive and (b) loose references anyway usually do not
1864 * have REF_KNOWS_PEELED.
1865 */
1866 if (flag & REF_ISPACKED) {
1867 struct ref_entry *r = get_packed_ref(refname);
1868 if (r) {
1869 if (peel_entry(r, 0))
1870 return -1;
1871 hashcpy(sha1, r->u.value.peeled.hash);
1872 return 0;
1873 }
1874 }
1875
1876 return peel_object(base, sha1);
1877}
1878
3bc581b9
MH
1879struct files_ref_iterator {
1880 struct ref_iterator base;
1881
1882 struct packed_ref_cache *packed_ref_cache;
1883 struct ref_iterator *iter0;
1884 unsigned int flags;
1885};
1886
1887static int files_ref_iterator_advance(struct ref_iterator *ref_iterator)
1888{
1889 struct files_ref_iterator *iter =
1890 (struct files_ref_iterator *)ref_iterator;
1891 int ok;
1892
1893 while ((ok = ref_iterator_advance(iter->iter0)) == ITER_OK) {
1894 if (!(iter->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
1895 !ref_resolves_to_object(iter->iter0->refname,
1896 iter->iter0->oid,
1897 iter->iter0->flags))
1898 continue;
1899
1900 iter->base.refname = iter->iter0->refname;
1901 iter->base.oid = iter->iter0->oid;
1902 iter->base.flags = iter->iter0->flags;
1903 return ITER_OK;
1904 }
1905
1906 iter->iter0 = NULL;
1907 if (ref_iterator_abort(ref_iterator) != ITER_DONE)
1908 ok = ITER_ERROR;
1909
1910 return ok;
1911}
1912
1913static int files_ref_iterator_peel(struct ref_iterator *ref_iterator,
1914 struct object_id *peeled)
1915{
1916 struct files_ref_iterator *iter =
1917 (struct files_ref_iterator *)ref_iterator;
1918
1919 return ref_iterator_peel(iter->iter0, peeled);
1920}
1921
1922static int files_ref_iterator_abort(struct ref_iterator *ref_iterator)
1923{
1924 struct files_ref_iterator *iter =
1925 (struct files_ref_iterator *)ref_iterator;
1926 int ok = ITER_DONE;
1927
1928 if (iter->iter0)
1929 ok = ref_iterator_abort(iter->iter0);
1930
1931 release_packed_ref_cache(iter->packed_ref_cache);
1932 base_ref_iterator_free(ref_iterator);
1933 return ok;
1934}
1935
1936static struct ref_iterator_vtable files_ref_iterator_vtable = {
1937 files_ref_iterator_advance,
1938 files_ref_iterator_peel,
1939 files_ref_iterator_abort
1940};
1941
1942struct ref_iterator *files_ref_iterator_begin(
1943 const char *submodule,
1944 const char *prefix, unsigned int flags)
1945{
1946 struct ref_cache *refs = get_ref_cache(submodule);
1947 struct ref_dir *loose_dir, *packed_dir;
1948 struct ref_iterator *loose_iter, *packed_iter;
1949 struct files_ref_iterator *iter;
1950 struct ref_iterator *ref_iterator;
1951
1952 if (!refs)
1953 return empty_ref_iterator_begin();
1954
1955 if (ref_paranoia < 0)
1956 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
1957 if (ref_paranoia)
1958 flags |= DO_FOR_EACH_INCLUDE_BROKEN;
1959
1960 iter = xcalloc(1, sizeof(*iter));
1961 ref_iterator = &iter->base;
1962 base_ref_iterator_init(ref_iterator, &files_ref_iterator_vtable);
1963
1964 /*
1965 * We must make sure that all loose refs are read before
1966 * accessing the packed-refs file; this avoids a race
1967 * condition if loose refs are migrated to the packed-refs
1968 * file by a simultaneous process, but our in-memory view is
1969 * from before the migration. We ensure this as follows:
1970 * First, we call prime_ref_dir(), which pre-reads the loose
1971 * references for the subtree into the cache. (If they've
1972 * already been read, that's OK; we only need to guarantee
1973 * that they're read before the packed refs, not *how much*
1974 * before.) After that, we call get_packed_ref_cache(), which
1975 * internally checks whether the packed-ref cache is up to
1976 * date with what is on disk, and re-reads it if not.
1977 */
1978
1979 loose_dir = get_loose_refs(refs);
1980
1981 if (prefix && *prefix)
1982 loose_dir = find_containing_dir(loose_dir, prefix, 0);
1983
1984 if (loose_dir) {
1985 prime_ref_dir(loose_dir);
1986 loose_iter = cache_ref_iterator_begin(loose_dir);
1987 } else {
1988 /* There's nothing to iterate over. */
1989 loose_iter = empty_ref_iterator_begin();
1990 }
1991
1992 iter->packed_ref_cache = get_packed_ref_cache(refs);
1993 acquire_packed_ref_cache(iter->packed_ref_cache);
1994 packed_dir = get_packed_ref_dir(iter->packed_ref_cache);
1995
1996 if (prefix && *prefix)
1997 packed_dir = find_containing_dir(packed_dir, prefix, 0);
1998
1999 if (packed_dir) {
2000 packed_iter = cache_ref_iterator_begin(packed_dir);
2001 } else {
2002 /* There's nothing to iterate over. */
2003 packed_iter = empty_ref_iterator_begin();
2004 }
2005
2006 iter->iter0 = overlay_ref_iterator_begin(loose_iter, packed_iter);
2007 iter->flags = flags;
2008
2009 return ref_iterator;
2010}
2011
7bd9bcf3
MH
2012/*
2013 * Verify that the reference locked by lock has the value old_sha1.
2014 * Fail if the reference doesn't exist and mustexist is set. Return 0
2015 * on success. On error, write an error message to err, set errno, and
2016 * return a negative value.
2017 */
2018static int verify_lock(struct ref_lock *lock,
2019 const unsigned char *old_sha1, int mustexist,
2020 struct strbuf *err)
2021{
2022 assert(err);
2023
2024 if (read_ref_full(lock->ref_name,
2025 mustexist ? RESOLVE_REF_READING : 0,
2026 lock->old_oid.hash, NULL)) {
6294dcb4
JK
2027 if (old_sha1) {
2028 int save_errno = errno;
0568c8e9 2029 strbuf_addf(err, "can't verify ref '%s'", lock->ref_name);
6294dcb4
JK
2030 errno = save_errno;
2031 return -1;
2032 } else {
2033 hashclr(lock->old_oid.hash);
2034 return 0;
2035 }
7bd9bcf3 2036 }
6294dcb4 2037 if (old_sha1 && hashcmp(lock->old_oid.hash, old_sha1)) {
0568c8e9 2038 strbuf_addf(err, "ref '%s' is at %s but expected %s",
7bd9bcf3
MH
2039 lock->ref_name,
2040 sha1_to_hex(lock->old_oid.hash),
2041 sha1_to_hex(old_sha1));
2042 errno = EBUSY;
2043 return -1;
2044 }
2045 return 0;
2046}
2047
2048static int remove_empty_directories(struct strbuf *path)
2049{
2050 /*
2051 * we want to create a file but there is a directory there;
2052 * if that is an empty directory (or a directory that contains
2053 * only empty directories), remove them.
2054 */
2055 return remove_dir_recursively(path, REMOVE_DIR_EMPTY_ONLY);
2056}
2057
2058/*
2059 * Locks a ref returning the lock on success and NULL on failure.
2060 * On failure errno is set to something meaningful.
2061 */
2062static struct ref_lock *lock_ref_sha1_basic(const char *refname,
2063 const unsigned char *old_sha1,
2064 const struct string_list *extras,
2065 const struct string_list *skip,
bcb497d0 2066 unsigned int flags, int *type,
7bd9bcf3
MH
2067 struct strbuf *err)
2068{
2069 struct strbuf ref_file = STRBUF_INIT;
7bd9bcf3
MH
2070 struct ref_lock *lock;
2071 int last_errno = 0;
7a418f3a 2072 int lflags = LOCK_NO_DEREF;
7bd9bcf3 2073 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
7a418f3a 2074 int resolve_flags = RESOLVE_REF_NO_RECURSE;
7bd9bcf3 2075 int attempts_remaining = 3;
7a418f3a 2076 int resolved;
7bd9bcf3
MH
2077
2078 assert(err);
2079
2080 lock = xcalloc(1, sizeof(struct ref_lock));
2081
2082 if (mustexist)
2083 resolve_flags |= RESOLVE_REF_READING;
2859dcd4 2084 if (flags & REF_DELETING)
7bd9bcf3 2085 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
7bd9bcf3 2086
7a418f3a
MH
2087 strbuf_git_path(&ref_file, "%s", refname);
2088 resolved = !!resolve_ref_unsafe(refname, resolve_flags,
2089 lock->old_oid.hash, type);
2090 if (!resolved && errno == EISDIR) {
7bd9bcf3
MH
2091 /*
2092 * we are trying to lock foo but we used to
2093 * have foo/bar which now does not exist;
2094 * it is normal for the empty directory 'foo'
2095 * to remain.
2096 */
7a418f3a 2097 if (remove_empty_directories(&ref_file)) {
7bd9bcf3 2098 last_errno = errno;
7a418f3a 2099 if (!verify_refname_available_dir(refname, extras, skip,
7bd9bcf3
MH
2100 get_loose_refs(&ref_cache), err))
2101 strbuf_addf(err, "there are still refs under '%s'",
7a418f3a 2102 refname);
7bd9bcf3
MH
2103 goto error_return;
2104 }
7a418f3a
MH
2105 resolved = !!resolve_ref_unsafe(refname, resolve_flags,
2106 lock->old_oid.hash, type);
7bd9bcf3 2107 }
7a418f3a 2108 if (!resolved) {
7bd9bcf3
MH
2109 last_errno = errno;
2110 if (last_errno != ENOTDIR ||
7a418f3a 2111 !verify_refname_available_dir(refname, extras, skip,
7bd9bcf3 2112 get_loose_refs(&ref_cache), err))
0568c8e9 2113 strbuf_addf(err, "unable to resolve reference '%s': %s",
7a418f3a 2114 refname, strerror(last_errno));
7bd9bcf3
MH
2115
2116 goto error_return;
2117 }
2859dcd4 2118
7bd9bcf3
MH
2119 /*
2120 * If the ref did not exist and we are creating it, make sure
2121 * there is no existing packed ref whose name begins with our
2122 * refname, nor a packed ref whose name is a proper prefix of
2123 * our refname.
2124 */
2125 if (is_null_oid(&lock->old_oid) &&
2126 verify_refname_available_dir(refname, extras, skip,
2127 get_packed_refs(&ref_cache), err)) {
2128 last_errno = ENOTDIR;
2129 goto error_return;
2130 }
2131
2132 lock->lk = xcalloc(1, sizeof(struct lock_file));
2133
7bd9bcf3 2134 lock->ref_name = xstrdup(refname);
7bd9bcf3
MH
2135
2136 retry:
2137 switch (safe_create_leading_directories_const(ref_file.buf)) {
2138 case SCLD_OK:
2139 break; /* success */
2140 case SCLD_VANISHED:
2141 if (--attempts_remaining > 0)
2142 goto retry;
2143 /* fall through */
2144 default:
2145 last_errno = errno;
0568c8e9 2146 strbuf_addf(err, "unable to create directory for '%s'",
7bd9bcf3
MH
2147 ref_file.buf);
2148 goto error_return;
2149 }
2150
2151 if (hold_lock_file_for_update(lock->lk, ref_file.buf, lflags) < 0) {
2152 last_errno = errno;
2153 if (errno == ENOENT && --attempts_remaining > 0)
2154 /*
2155 * Maybe somebody just deleted one of the
2156 * directories leading to ref_file. Try
2157 * again:
2158 */
2159 goto retry;
2160 else {
2161 unable_to_lock_message(ref_file.buf, errno, err);
2162 goto error_return;
2163 }
2164 }
6294dcb4 2165 if (verify_lock(lock, old_sha1, mustexist, err)) {
7bd9bcf3
MH
2166 last_errno = errno;
2167 goto error_return;
2168 }
2169 goto out;
2170
2171 error_return:
2172 unlock_ref(lock);
2173 lock = NULL;
2174
2175 out:
2176 strbuf_release(&ref_file);
7bd9bcf3
MH
2177 errno = last_errno;
2178 return lock;
2179}
2180
2181/*
2182 * Write an entry to the packed-refs file for the specified refname.
2183 * If peeled is non-NULL, write it as the entry's peeled value.
2184 */
2185static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2186 unsigned char *peeled)
2187{
2188 fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
2189 if (peeled)
2190 fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2191}
2192
2193/*
2194 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2195 */
2196static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2197{
2198 enum peel_status peel_status = peel_entry(entry, 0);
2199
2200 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2201 error("internal error: %s is not a valid packed reference!",
2202 entry->name);
2203 write_packed_entry(cb_data, entry->name, entry->u.value.oid.hash,
2204 peel_status == PEEL_PEELED ?
2205 entry->u.value.peeled.hash : NULL);
2206 return 0;
2207}
2208
2209/*
2210 * Lock the packed-refs file for writing. Flags is passed to
2211 * hold_lock_file_for_update(). Return 0 on success. On errors, set
2212 * errno appropriately and return a nonzero value.
2213 */
2214static int lock_packed_refs(int flags)
2215{
2216 static int timeout_configured = 0;
2217 static int timeout_value = 1000;
2218
2219 struct packed_ref_cache *packed_ref_cache;
2220
2221 if (!timeout_configured) {
2222 git_config_get_int("core.packedrefstimeout", &timeout_value);
2223 timeout_configured = 1;
2224 }
2225
2226 if (hold_lock_file_for_update_timeout(
2227 &packlock, git_path("packed-refs"),
2228 flags, timeout_value) < 0)
2229 return -1;
2230 /*
2231 * Get the current packed-refs while holding the lock. If the
2232 * packed-refs file has been modified since we last read it,
2233 * this will automatically invalidate the cache and re-read
2234 * the packed-refs file.
2235 */
2236 packed_ref_cache = get_packed_ref_cache(&ref_cache);
2237 packed_ref_cache->lock = &packlock;
2238 /* Increment the reference count to prevent it from being freed: */
2239 acquire_packed_ref_cache(packed_ref_cache);
2240 return 0;
2241}
2242
2243/*
2244 * Write the current version of the packed refs cache from memory to
2245 * disk. The packed-refs file must already be locked for writing (see
2246 * lock_packed_refs()). Return zero on success. On errors, set errno
2247 * and return a nonzero value
2248 */
2249static int commit_packed_refs(void)
2250{
2251 struct packed_ref_cache *packed_ref_cache =
2252 get_packed_ref_cache(&ref_cache);
2253 int error = 0;
2254 int save_errno = 0;
2255 FILE *out;
2256
2257 if (!packed_ref_cache->lock)
2258 die("internal error: packed-refs not locked");
2259
2260 out = fdopen_lock_file(packed_ref_cache->lock, "w");
2261 if (!out)
2262 die_errno("unable to fdopen packed-refs descriptor");
2263
2264 fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2265 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2266 0, write_packed_entry_fn, out);
2267
2268 if (commit_lock_file(packed_ref_cache->lock)) {
2269 save_errno = errno;
2270 error = -1;
2271 }
2272 packed_ref_cache->lock = NULL;
2273 release_packed_ref_cache(packed_ref_cache);
2274 errno = save_errno;
2275 return error;
2276}
2277
2278/*
2279 * Rollback the lockfile for the packed-refs file, and discard the
2280 * in-memory packed reference cache. (The packed-refs file will be
2281 * read anew if it is needed again after this function is called.)
2282 */
2283static void rollback_packed_refs(void)
2284{
2285 struct packed_ref_cache *packed_ref_cache =
2286 get_packed_ref_cache(&ref_cache);
2287
2288 if (!packed_ref_cache->lock)
2289 die("internal error: packed-refs not locked");
2290 rollback_lock_file(packed_ref_cache->lock);
2291 packed_ref_cache->lock = NULL;
2292 release_packed_ref_cache(packed_ref_cache);
2293 clear_packed_ref_cache(&ref_cache);
2294}
2295
2296struct ref_to_prune {
2297 struct ref_to_prune *next;
2298 unsigned char sha1[20];
2299 char name[FLEX_ARRAY];
2300};
2301
2302struct pack_refs_cb_data {
2303 unsigned int flags;
2304 struct ref_dir *packed_refs;
2305 struct ref_to_prune *ref_to_prune;
2306};
2307
2308/*
2309 * An each_ref_entry_fn that is run over loose references only. If
2310 * the loose reference can be packed, add an entry in the packed ref
2311 * cache. If the reference should be pruned, also add it to
2312 * ref_to_prune in the pack_refs_cb_data.
2313 */
2314static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2315{
2316 struct pack_refs_cb_data *cb = cb_data;
2317 enum peel_status peel_status;
2318 struct ref_entry *packed_entry;
2319 int is_tag_ref = starts_with(entry->name, "refs/tags/");
2320
2321 /* Do not pack per-worktree refs: */
2322 if (ref_type(entry->name) != REF_TYPE_NORMAL)
2323 return 0;
2324
2325 /* ALWAYS pack tags */
2326 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2327 return 0;
2328
2329 /* Do not pack symbolic or broken refs: */
ffeef642 2330 if ((entry->flag & REF_ISSYMREF) || !entry_resolves_to_object(entry))
7bd9bcf3
MH
2331 return 0;
2332
2333 /* Add a packed ref cache entry equivalent to the loose entry. */
2334 peel_status = peel_entry(entry, 1);
2335 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2336 die("internal error peeling reference %s (%s)",
2337 entry->name, oid_to_hex(&entry->u.value.oid));
2338 packed_entry = find_ref(cb->packed_refs, entry->name);
2339 if (packed_entry) {
2340 /* Overwrite existing packed entry with info from loose entry */
2341 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2342 oidcpy(&packed_entry->u.value.oid, &entry->u.value.oid);
2343 } else {
2344 packed_entry = create_ref_entry(entry->name, entry->u.value.oid.hash,
2345 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2346 add_ref(cb->packed_refs, packed_entry);
2347 }
2348 oidcpy(&packed_entry->u.value.peeled, &entry->u.value.peeled);
2349
2350 /* Schedule the loose reference for pruning if requested. */
2351 if ((cb->flags & PACK_REFS_PRUNE)) {
96ffc06f
JK
2352 struct ref_to_prune *n;
2353 FLEX_ALLOC_STR(n, name, entry->name);
7bd9bcf3 2354 hashcpy(n->sha1, entry->u.value.oid.hash);
7bd9bcf3
MH
2355 n->next = cb->ref_to_prune;
2356 cb->ref_to_prune = n;
2357 }
2358 return 0;
2359}
2360
2361/*
2362 * Remove empty parents, but spare refs/ and immediate subdirs.
2363 * Note: munges *name.
2364 */
2365static void try_remove_empty_parents(char *name)
2366{
2367 char *p, *q;
2368 int i;
2369 p = name;
2370 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2371 while (*p && *p != '/')
2372 p++;
2373 /* tolerate duplicate slashes; see check_refname_format() */
2374 while (*p == '/')
2375 p++;
2376 }
2377 for (q = p; *q; q++)
2378 ;
2379 while (1) {
2380 while (q > p && *q != '/')
2381 q--;
2382 while (q > p && *(q-1) == '/')
2383 q--;
2384 if (q == p)
2385 break;
2386 *q = '\0';
2387 if (rmdir(git_path("%s", name)))
2388 break;
2389 }
2390}
2391
2392/* make sure nobody touched the ref, and unlink */
2393static void prune_ref(struct ref_to_prune *r)
2394{
2395 struct ref_transaction *transaction;
2396 struct strbuf err = STRBUF_INIT;
2397
2398 if (check_refname_format(r->name, 0))
2399 return;
2400
2401 transaction = ref_transaction_begin(&err);
2402 if (!transaction ||
2403 ref_transaction_delete(transaction, r->name, r->sha1,
c52ce248 2404 REF_ISPRUNING | REF_NODEREF, NULL, &err) ||
7bd9bcf3
MH
2405 ref_transaction_commit(transaction, &err)) {
2406 ref_transaction_free(transaction);
2407 error("%s", err.buf);
2408 strbuf_release(&err);
2409 return;
2410 }
2411 ref_transaction_free(transaction);
2412 strbuf_release(&err);
2413 try_remove_empty_parents(r->name);
2414}
2415
2416static void prune_refs(struct ref_to_prune *r)
2417{
2418 while (r) {
2419 prune_ref(r);
2420 r = r->next;
2421 }
2422}
2423
2424int pack_refs(unsigned int flags)
2425{
2426 struct pack_refs_cb_data cbdata;
2427
2428 memset(&cbdata, 0, sizeof(cbdata));
2429 cbdata.flags = flags;
2430
2431 lock_packed_refs(LOCK_DIE_ON_ERROR);
2432 cbdata.packed_refs = get_packed_refs(&ref_cache);
2433
2434 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2435 pack_if_possible_fn, &cbdata);
2436
2437 if (commit_packed_refs())
2438 die_errno("unable to overwrite old ref-pack file");
2439
2440 prune_refs(cbdata.ref_to_prune);
2441 return 0;
2442}
2443
2444/*
2445 * Rewrite the packed-refs file, omitting any refs listed in
2446 * 'refnames'. On error, leave packed-refs unchanged, write an error
2447 * message to 'err', and return a nonzero value.
2448 *
2449 * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
2450 */
2451static int repack_without_refs(struct string_list *refnames, struct strbuf *err)
2452{
2453 struct ref_dir *packed;
2454 struct string_list_item *refname;
2455 int ret, needs_repacking = 0, removed = 0;
2456
2457 assert(err);
2458
2459 /* Look for a packed ref */
2460 for_each_string_list_item(refname, refnames) {
2461 if (get_packed_ref(refname->string)) {
2462 needs_repacking = 1;
2463 break;
2464 }
2465 }
2466
2467 /* Avoid locking if we have nothing to do */
2468 if (!needs_repacking)
2469 return 0; /* no refname exists in packed refs */
2470
2471 if (lock_packed_refs(0)) {
2472 unable_to_lock_message(git_path("packed-refs"), errno, err);
2473 return -1;
2474 }
2475 packed = get_packed_refs(&ref_cache);
2476
2477 /* Remove refnames from the cache */
2478 for_each_string_list_item(refname, refnames)
2479 if (remove_entry(packed, refname->string) != -1)
2480 removed = 1;
2481 if (!removed) {
2482 /*
2483 * All packed entries disappeared while we were
2484 * acquiring the lock.
2485 */
2486 rollback_packed_refs();
2487 return 0;
2488 }
2489
2490 /* Write what remains */
2491 ret = commit_packed_refs();
2492 if (ret)
2493 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
2494 strerror(errno));
2495 return ret;
2496}
2497
2498static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2499{
2500 assert(err);
2501
2502 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2503 /*
2504 * loose. The loose file name is the same as the
2505 * lockfile name, minus ".lock":
2506 */
2507 char *loose_filename = get_locked_file_path(lock->lk);
2508 int res = unlink_or_msg(loose_filename, err);
2509 free(loose_filename);
2510 if (res)
2511 return 1;
2512 }
2513 return 0;
2514}
2515
c5f04ddd 2516int delete_refs(struct string_list *refnames, unsigned int flags)
7bd9bcf3
MH
2517{
2518 struct strbuf err = STRBUF_INIT;
2519 int i, result = 0;
2520
2521 if (!refnames->nr)
2522 return 0;
2523
2524 result = repack_without_refs(refnames, &err);
2525 if (result) {
2526 /*
2527 * If we failed to rewrite the packed-refs file, then
2528 * it is unsafe to try to remove loose refs, because
2529 * doing so might expose an obsolete packed value for
2530 * a reference that might even point at an object that
2531 * has been garbage collected.
2532 */
2533 if (refnames->nr == 1)
2534 error(_("could not delete reference %s: %s"),
2535 refnames->items[0].string, err.buf);
2536 else
2537 error(_("could not delete references: %s"), err.buf);
2538
2539 goto out;
2540 }
2541
2542 for (i = 0; i < refnames->nr; i++) {
2543 const char *refname = refnames->items[i].string;
2544
c5f04ddd 2545 if (delete_ref(refname, NULL, flags))
7bd9bcf3
MH
2546 result |= error(_("could not remove reference %s"), refname);
2547 }
2548
2549out:
2550 strbuf_release(&err);
2551 return result;
2552}
2553
2554/*
2555 * People using contrib's git-new-workdir have .git/logs/refs ->
2556 * /some/other/path/.git/logs/refs, and that may live on another device.
2557 *
2558 * IOW, to avoid cross device rename errors, the temporary renamed log must
2559 * live into logs/refs.
2560 */
2561#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2562
2563static int rename_tmp_log(const char *newrefname)
2564{
2565 int attempts_remaining = 4;
2566 struct strbuf path = STRBUF_INIT;
2567 int ret = -1;
2568
2569 retry:
2570 strbuf_reset(&path);
2571 strbuf_git_path(&path, "logs/%s", newrefname);
2572 switch (safe_create_leading_directories_const(path.buf)) {
2573 case SCLD_OK:
2574 break; /* success */
2575 case SCLD_VANISHED:
2576 if (--attempts_remaining > 0)
2577 goto retry;
2578 /* fall through */
2579 default:
2580 error("unable to create directory for %s", newrefname);
2581 goto out;
2582 }
2583
2584 if (rename(git_path(TMP_RENAMED_LOG), path.buf)) {
2585 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2586 /*
2587 * rename(a, b) when b is an existing
2588 * directory ought to result in ISDIR, but
2589 * Solaris 5.8 gives ENOTDIR. Sheesh.
2590 */
2591 if (remove_empty_directories(&path)) {
2592 error("Directory not empty: logs/%s", newrefname);
2593 goto out;
2594 }
2595 goto retry;
2596 } else if (errno == ENOENT && --attempts_remaining > 0) {
2597 /*
2598 * Maybe another process just deleted one of
2599 * the directories in the path to newrefname.
2600 * Try again from the beginning.
2601 */
2602 goto retry;
2603 } else {
2604 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2605 newrefname, strerror(errno));
2606 goto out;
2607 }
2608 }
2609 ret = 0;
2610out:
2611 strbuf_release(&path);
2612 return ret;
2613}
2614
2615int verify_refname_available(const char *newname,
3a8af7be
MH
2616 const struct string_list *extras,
2617 const struct string_list *skip,
7bd9bcf3
MH
2618 struct strbuf *err)
2619{
2620 struct ref_dir *packed_refs = get_packed_refs(&ref_cache);
2621 struct ref_dir *loose_refs = get_loose_refs(&ref_cache);
2622
2623 if (verify_refname_available_dir(newname, extras, skip,
2624 packed_refs, err) ||
2625 verify_refname_available_dir(newname, extras, skip,
2626 loose_refs, err))
2627 return -1;
2628
2629 return 0;
2630}
2631
7bd9bcf3
MH
2632static int write_ref_to_lockfile(struct ref_lock *lock,
2633 const unsigned char *sha1, struct strbuf *err);
2634static int commit_ref_update(struct ref_lock *lock,
2635 const unsigned char *sha1, const char *logmsg,
5d9b2de4 2636 struct strbuf *err);
7bd9bcf3
MH
2637
2638int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2639{
2640 unsigned char sha1[20], orig_sha1[20];
2641 int flag = 0, logmoved = 0;
2642 struct ref_lock *lock;
2643 struct stat loginfo;
2644 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
7bd9bcf3
MH
2645 struct strbuf err = STRBUF_INIT;
2646
2647 if (log && S_ISLNK(loginfo.st_mode))
2648 return error("reflog for %s is a symlink", oldrefname);
2649
12fd3496
DT
2650 if (!resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING | RESOLVE_REF_NO_RECURSE,
2651 orig_sha1, &flag))
e711b1af
MH
2652 return error("refname %s not found", oldrefname);
2653
7bd9bcf3
MH
2654 if (flag & REF_ISSYMREF)
2655 return error("refname %s is a symbolic ref, renaming it is not supported",
2656 oldrefname);
7bd9bcf3
MH
2657 if (!rename_ref_available(oldrefname, newrefname))
2658 return 1;
2659
2660 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2661 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2662 oldrefname, strerror(errno));
2663
2664 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
2665 error("unable to delete old %s", oldrefname);
2666 goto rollback;
2667 }
2668
12fd3496
DT
2669 /*
2670 * Since we are doing a shallow lookup, sha1 is not the
2671 * correct value to pass to delete_ref as old_sha1. But that
2672 * doesn't matter, because an old_sha1 check wouldn't add to
2673 * the safety anyway; we want to delete the reference whatever
2674 * its current value.
2675 */
2676 if (!read_ref_full(newrefname, RESOLVE_REF_READING | RESOLVE_REF_NO_RECURSE,
2677 sha1, NULL) &&
2678 delete_ref(newrefname, NULL, REF_NODEREF)) {
7bd9bcf3
MH
2679 if (errno==EISDIR) {
2680 struct strbuf path = STRBUF_INIT;
2681 int result;
2682
2683 strbuf_git_path(&path, "%s", newrefname);
2684 result = remove_empty_directories(&path);
2685 strbuf_release(&path);
2686
2687 if (result) {
2688 error("Directory not empty: %s", newrefname);
2689 goto rollback;
2690 }
2691 } else {
2692 error("unable to delete existing %s", newrefname);
2693 goto rollback;
2694 }
2695 }
2696
2697 if (log && rename_tmp_log(newrefname))
2698 goto rollback;
2699
2700 logmoved = log;
2701
12fd3496
DT
2702 lock = lock_ref_sha1_basic(newrefname, NULL, NULL, NULL, REF_NODEREF,
2703 NULL, &err);
7bd9bcf3
MH
2704 if (!lock) {
2705 error("unable to rename '%s' to '%s': %s", oldrefname, newrefname, err.buf);
2706 strbuf_release(&err);
2707 goto rollback;
2708 }
2709 hashcpy(lock->old_oid.hash, orig_sha1);
2710
2711 if (write_ref_to_lockfile(lock, orig_sha1, &err) ||
5d9b2de4 2712 commit_ref_update(lock, orig_sha1, logmsg, &err)) {
7bd9bcf3
MH
2713 error("unable to write current sha1 into %s: %s", newrefname, err.buf);
2714 strbuf_release(&err);
2715 goto rollback;
2716 }
2717
2718 return 0;
2719
2720 rollback:
12fd3496
DT
2721 lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, NULL, REF_NODEREF,
2722 NULL, &err);
7bd9bcf3
MH
2723 if (!lock) {
2724 error("unable to lock %s for rollback: %s", oldrefname, err.buf);
2725 strbuf_release(&err);
2726 goto rollbacklog;
2727 }
2728
2729 flag = log_all_ref_updates;
2730 log_all_ref_updates = 0;
2731 if (write_ref_to_lockfile(lock, orig_sha1, &err) ||
5d9b2de4 2732 commit_ref_update(lock, orig_sha1, NULL, &err)) {
7bd9bcf3
MH
2733 error("unable to write current sha1 into %s: %s", oldrefname, err.buf);
2734 strbuf_release(&err);
2735 }
2736 log_all_ref_updates = flag;
2737
2738 rollbacklog:
2739 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2740 error("unable to restore logfile %s from %s: %s",
2741 oldrefname, newrefname, strerror(errno));
2742 if (!logmoved && log &&
2743 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2744 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2745 oldrefname, strerror(errno));
2746
2747 return 1;
2748}
2749
2750static int close_ref(struct ref_lock *lock)
2751{
2752 if (close_lock_file(lock->lk))
2753 return -1;
2754 return 0;
2755}
2756
2757static int commit_ref(struct ref_lock *lock)
2758{
5387c0d8
MH
2759 char *path = get_locked_file_path(lock->lk);
2760 struct stat st;
2761
2762 if (!lstat(path, &st) && S_ISDIR(st.st_mode)) {
2763 /*
2764 * There is a directory at the path we want to rename
2765 * the lockfile to. Hopefully it is empty; try to
2766 * delete it.
2767 */
2768 size_t len = strlen(path);
2769 struct strbuf sb_path = STRBUF_INIT;
2770
2771 strbuf_attach(&sb_path, path, len, len);
2772
2773 /*
2774 * If this fails, commit_lock_file() will also fail
2775 * and will report the problem.
2776 */
2777 remove_empty_directories(&sb_path);
2778 strbuf_release(&sb_path);
2779 } else {
2780 free(path);
2781 }
2782
7bd9bcf3
MH
2783 if (commit_lock_file(lock->lk))
2784 return -1;
2785 return 0;
2786}
2787
2788/*
2789 * Create a reflog for a ref. If force_create = 0, the reflog will
2790 * only be created for certain refs (those for which
2791 * should_autocreate_reflog returns non-zero. Otherwise, create it
2792 * regardless of the ref name. Fill in *err and return -1 on failure.
2793 */
2794static int log_ref_setup(const char *refname, struct strbuf *logfile, struct strbuf *err, int force_create)
2795{
2796 int logfd, oflags = O_APPEND | O_WRONLY;
2797
2798 strbuf_git_path(logfile, "logs/%s", refname);
2799 if (force_create || should_autocreate_reflog(refname)) {
2800 if (safe_create_leading_directories(logfile->buf) < 0) {
0568c8e9 2801 strbuf_addf(err, "unable to create directory for '%s': "
7bd9bcf3
MH
2802 "%s", logfile->buf, strerror(errno));
2803 return -1;
2804 }
2805 oflags |= O_CREAT;
2806 }
2807
2808 logfd = open(logfile->buf, oflags, 0666);
2809 if (logfd < 0) {
2810 if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))
2811 return 0;
2812
2813 if (errno == EISDIR) {
2814 if (remove_empty_directories(logfile)) {
0568c8e9 2815 strbuf_addf(err, "there are still logs under "
7bd9bcf3
MH
2816 "'%s'", logfile->buf);
2817 return -1;
2818 }
2819 logfd = open(logfile->buf, oflags, 0666);
2820 }
2821
2822 if (logfd < 0) {
0568c8e9 2823 strbuf_addf(err, "unable to append to '%s': %s",
7bd9bcf3
MH
2824 logfile->buf, strerror(errno));
2825 return -1;
2826 }
2827 }
2828
2829 adjust_shared_perm(logfile->buf);
2830 close(logfd);
2831 return 0;
2832}
2833
2834
2835int safe_create_reflog(const char *refname, int force_create, struct strbuf *err)
2836{
2837 int ret;
2838 struct strbuf sb = STRBUF_INIT;
2839
2840 ret = log_ref_setup(refname, &sb, err, force_create);
2841 strbuf_release(&sb);
2842 return ret;
2843}
2844
2845static int log_ref_write_fd(int fd, const unsigned char *old_sha1,
2846 const unsigned char *new_sha1,
2847 const char *committer, const char *msg)
2848{
2849 int msglen, written;
2850 unsigned maxlen, len;
2851 char *logrec;
2852
2853 msglen = msg ? strlen(msg) : 0;
2854 maxlen = strlen(committer) + msglen + 100;
2855 logrec = xmalloc(maxlen);
2856 len = xsnprintf(logrec, maxlen, "%s %s %s\n",
2857 sha1_to_hex(old_sha1),
2858 sha1_to_hex(new_sha1),
2859 committer);
2860 if (msglen)
2861 len += copy_reflog_msg(logrec + len - 1, msg) - 1;
2862
2863 written = len <= maxlen ? write_in_full(fd, logrec, len) : -1;
2864 free(logrec);
2865 if (written != len)
2866 return -1;
2867
2868 return 0;
2869}
2870
2871static int log_ref_write_1(const char *refname, const unsigned char *old_sha1,
2872 const unsigned char *new_sha1, const char *msg,
2873 struct strbuf *logfile, int flags,
2874 struct strbuf *err)
2875{
2876 int logfd, result, oflags = O_APPEND | O_WRONLY;
2877
2878 if (log_all_ref_updates < 0)
2879 log_all_ref_updates = !is_bare_repository();
2880
2881 result = log_ref_setup(refname, logfile, err, flags & REF_FORCE_CREATE_REFLOG);
2882
2883 if (result)
2884 return result;
2885
2886 logfd = open(logfile->buf, oflags);
2887 if (logfd < 0)
2888 return 0;
2889 result = log_ref_write_fd(logfd, old_sha1, new_sha1,
2890 git_committer_info(0), msg);
2891 if (result) {
0568c8e9 2892 strbuf_addf(err, "unable to append to '%s': %s", logfile->buf,
7bd9bcf3
MH
2893 strerror(errno));
2894 close(logfd);
2895 return -1;
2896 }
2897 if (close(logfd)) {
0568c8e9 2898 strbuf_addf(err, "unable to append to '%s': %s", logfile->buf,
7bd9bcf3
MH
2899 strerror(errno));
2900 return -1;
2901 }
2902 return 0;
2903}
2904
2905static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2906 const unsigned char *new_sha1, const char *msg,
2907 int flags, struct strbuf *err)
5f3c3a4e
DT
2908{
2909 return files_log_ref_write(refname, old_sha1, new_sha1, msg, flags,
2910 err);
2911}
2912
2913int files_log_ref_write(const char *refname, const unsigned char *old_sha1,
2914 const unsigned char *new_sha1, const char *msg,
2915 int flags, struct strbuf *err)
7bd9bcf3
MH
2916{
2917 struct strbuf sb = STRBUF_INIT;
2918 int ret = log_ref_write_1(refname, old_sha1, new_sha1, msg, &sb, flags,
2919 err);
2920 strbuf_release(&sb);
2921 return ret;
2922}
2923
2924/*
2925 * Write sha1 into the open lockfile, then close the lockfile. On
2926 * errors, rollback the lockfile, fill in *err and
2927 * return -1.
2928 */
2929static int write_ref_to_lockfile(struct ref_lock *lock,
2930 const unsigned char *sha1, struct strbuf *err)
2931{
2932 static char term = '\n';
2933 struct object *o;
2934 int fd;
2935
2936 o = parse_object(sha1);
2937 if (!o) {
2938 strbuf_addf(err,
0568c8e9 2939 "trying to write ref '%s' with nonexistent object %s",
7bd9bcf3
MH
2940 lock->ref_name, sha1_to_hex(sha1));
2941 unlock_ref(lock);
2942 return -1;
2943 }
2944 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2945 strbuf_addf(err,
0568c8e9 2946 "trying to write non-commit object %s to branch '%s'",
7bd9bcf3
MH
2947 sha1_to_hex(sha1), lock->ref_name);
2948 unlock_ref(lock);
2949 return -1;
2950 }
2951 fd = get_lock_file_fd(lock->lk);
2952 if (write_in_full(fd, sha1_to_hex(sha1), 40) != 40 ||
2953 write_in_full(fd, &term, 1) != 1 ||
2954 close_ref(lock) < 0) {
2955 strbuf_addf(err,
0568c8e9 2956 "couldn't write '%s'", get_lock_file_path(lock->lk));
7bd9bcf3
MH
2957 unlock_ref(lock);
2958 return -1;
2959 }
2960 return 0;
2961}
2962
2963/*
2964 * Commit a change to a loose reference that has already been written
2965 * to the loose reference lockfile. Also update the reflogs if
2966 * necessary, using the specified lockmsg (which can be NULL).
2967 */
2968static int commit_ref_update(struct ref_lock *lock,
2969 const unsigned char *sha1, const char *logmsg,
5d9b2de4 2970 struct strbuf *err)
7bd9bcf3
MH
2971{
2972 clear_loose_ref_cache(&ref_cache);
7a418f3a 2973 if (log_ref_write(lock->ref_name, lock->old_oid.hash, sha1, logmsg, 0, err)) {
7bd9bcf3 2974 char *old_msg = strbuf_detach(err, NULL);
0568c8e9 2975 strbuf_addf(err, "cannot update the ref '%s': %s",
7bd9bcf3
MH
2976 lock->ref_name, old_msg);
2977 free(old_msg);
2978 unlock_ref(lock);
2979 return -1;
2980 }
7a418f3a
MH
2981
2982 if (strcmp(lock->ref_name, "HEAD") != 0) {
7bd9bcf3
MH
2983 /*
2984 * Special hack: If a branch is updated directly and HEAD
2985 * points to it (may happen on the remote side of a push
2986 * for example) then logically the HEAD reflog should be
2987 * updated too.
2988 * A generic solution implies reverse symref information,
2989 * but finding all symrefs pointing to the given branch
2990 * would be rather costly for this rare event (the direct
2991 * update of a branch) to be worth it. So let's cheat and
2992 * check with HEAD only which should cover 99% of all usage
2993 * scenarios (even 100% of the default ones).
2994 */
2995 unsigned char head_sha1[20];
2996 int head_flag;
2997 const char *head_ref;
7a418f3a 2998
7bd9bcf3
MH
2999 head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
3000 head_sha1, &head_flag);
3001 if (head_ref && (head_flag & REF_ISSYMREF) &&
3002 !strcmp(head_ref, lock->ref_name)) {
3003 struct strbuf log_err = STRBUF_INIT;
3004 if (log_ref_write("HEAD", lock->old_oid.hash, sha1,
3005 logmsg, 0, &log_err)) {
3006 error("%s", log_err.buf);
3007 strbuf_release(&log_err);
3008 }
3009 }
3010 }
7a418f3a 3011
5d9b2de4 3012 if (commit_ref(lock)) {
0568c8e9 3013 strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
7bd9bcf3
MH
3014 unlock_ref(lock);
3015 return -1;
3016 }
3017
3018 unlock_ref(lock);
3019 return 0;
3020}
3021
370e5ad6 3022static int create_ref_symlink(struct ref_lock *lock, const char *target)
7bd9bcf3 3023{
370e5ad6 3024 int ret = -1;
7bd9bcf3 3025#ifndef NO_SYMLINK_HEAD
370e5ad6
JK
3026 char *ref_path = get_locked_file_path(lock->lk);
3027 unlink(ref_path);
3028 ret = symlink(target, ref_path);
3029 free(ref_path);
3030
3031 if (ret)
7bd9bcf3 3032 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
7bd9bcf3 3033#endif
370e5ad6
JK
3034 return ret;
3035}
7bd9bcf3 3036
370e5ad6
JK
3037static void update_symref_reflog(struct ref_lock *lock, const char *refname,
3038 const char *target, const char *logmsg)
3039{
3040 struct strbuf err = STRBUF_INIT;
3041 unsigned char new_sha1[20];
b9badadd 3042 if (logmsg && !read_ref(target, new_sha1) &&
370e5ad6 3043 log_ref_write(refname, lock->old_oid.hash, new_sha1, logmsg, 0, &err)) {
7bd9bcf3
MH
3044 error("%s", err.buf);
3045 strbuf_release(&err);
3046 }
370e5ad6 3047}
7bd9bcf3 3048
370e5ad6
JK
3049static int create_symref_locked(struct ref_lock *lock, const char *refname,
3050 const char *target, const char *logmsg)
3051{
3052 if (prefer_symlink_refs && !create_ref_symlink(lock, target)) {
3053 update_symref_reflog(lock, refname, target, logmsg);
3054 return 0;
3055 }
3056
3057 if (!fdopen_lock_file(lock->lk, "w"))
3058 return error("unable to fdopen %s: %s",
3059 lock->lk->tempfile.filename.buf, strerror(errno));
3060
396da8f7
JK
3061 update_symref_reflog(lock, refname, target, logmsg);
3062
370e5ad6
JK
3063 /* no error check; commit_ref will check ferror */
3064 fprintf(lock->lk->tempfile.fp, "ref: %s\n", target);
3065 if (commit_ref(lock) < 0)
3066 return error("unable to write symref for %s: %s", refname,
3067 strerror(errno));
7bd9bcf3
MH
3068 return 0;
3069}
3070
370e5ad6
JK
3071int create_symref(const char *refname, const char *target, const char *logmsg)
3072{
3073 struct strbuf err = STRBUF_INIT;
3074 struct ref_lock *lock;
3075 int ret;
3076
3077 lock = lock_ref_sha1_basic(refname, NULL, NULL, NULL, REF_NODEREF, NULL,
3078 &err);
3079 if (!lock) {
3080 error("%s", err.buf);
3081 strbuf_release(&err);
3082 return -1;
3083 }
3084
3085 ret = create_symref_locked(lock, refname, target, logmsg);
3086 unlock_ref(lock);
3087 return ret;
3088}
3089
2233066e
KY
3090int set_worktree_head_symref(const char *gitdir, const char *target)
3091{
3092 static struct lock_file head_lock;
3093 struct ref_lock *lock;
2233066e
KY
3094 struct strbuf head_path = STRBUF_INIT;
3095 const char *head_rel;
3096 int ret;
3097
3098 strbuf_addf(&head_path, "%s/HEAD", absolute_path(gitdir));
3099 if (hold_lock_file_for_update(&head_lock, head_path.buf,
3100 LOCK_NO_DEREF) < 0) {
18eb3a9c
KY
3101 struct strbuf err = STRBUF_INIT;
3102 unable_to_lock_message(head_path.buf, errno, &err);
2233066e
KY
3103 error("%s", err.buf);
3104 strbuf_release(&err);
3105 strbuf_release(&head_path);
3106 return -1;
3107 }
3108
3109 /* head_rel will be "HEAD" for the main tree, "worktrees/wt/HEAD" for
3110 linked trees */
3111 head_rel = remove_leading_path(head_path.buf,
3112 absolute_path(get_git_common_dir()));
3113 /* to make use of create_symref_locked(), initialize ref_lock */
3114 lock = xcalloc(1, sizeof(struct ref_lock));
3115 lock->lk = &head_lock;
3116 lock->ref_name = xstrdup(head_rel);
2233066e
KY
3117
3118 ret = create_symref_locked(lock, head_rel, target, NULL);
3119
3120 unlock_ref(lock); /* will free lock */
3121 strbuf_release(&head_path);
3122 return ret;
3123}
3124
7bd9bcf3
MH
3125int reflog_exists(const char *refname)
3126{
3127 struct stat st;
3128
3129 return !lstat(git_path("logs/%s", refname), &st) &&
3130 S_ISREG(st.st_mode);
3131}
3132
3133int delete_reflog(const char *refname)
3134{
3135 return remove_path(git_path("logs/%s", refname));
3136}
3137
3138static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
3139{
3140 unsigned char osha1[20], nsha1[20];
3141 char *email_end, *message;
3142 unsigned long timestamp;
3143 int tz;
3144
3145 /* old SP new SP name <email> SP time TAB msg LF */
3146 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
3147 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
3148 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
3149 !(email_end = strchr(sb->buf + 82, '>')) ||
3150 email_end[1] != ' ' ||
3151 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
3152 !message || message[0] != ' ' ||
3153 (message[1] != '+' && message[1] != '-') ||
3154 !isdigit(message[2]) || !isdigit(message[3]) ||
3155 !isdigit(message[4]) || !isdigit(message[5]))
3156 return 0; /* corrupt? */
3157 email_end[1] = '\0';
3158 tz = strtol(message + 1, NULL, 10);
3159 if (message[6] != '\t')
3160 message += 6;
3161 else
3162 message += 7;
3163 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
3164}
3165
3166static char *find_beginning_of_line(char *bob, char *scan)
3167{
3168 while (bob < scan && *(--scan) != '\n')
3169 ; /* keep scanning backwards */
3170 /*
3171 * Return either beginning of the buffer, or LF at the end of
3172 * the previous line.
3173 */
3174 return scan;
3175}
3176
3177int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3178{
3179 struct strbuf sb = STRBUF_INIT;
3180 FILE *logfp;
3181 long pos;
3182 int ret = 0, at_tail = 1;
3183
3184 logfp = fopen(git_path("logs/%s", refname), "r");
3185 if (!logfp)
3186 return -1;
3187
3188 /* Jump to the end */
3189 if (fseek(logfp, 0, SEEK_END) < 0)
3190 return error("cannot seek back reflog for %s: %s",
3191 refname, strerror(errno));
3192 pos = ftell(logfp);
3193 while (!ret && 0 < pos) {
3194 int cnt;
3195 size_t nread;
3196 char buf[BUFSIZ];
3197 char *endp, *scanp;
3198
3199 /* Fill next block from the end */
3200 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
3201 if (fseek(logfp, pos - cnt, SEEK_SET))
3202 return error("cannot seek back reflog for %s: %s",
3203 refname, strerror(errno));
3204 nread = fread(buf, cnt, 1, logfp);
3205 if (nread != 1)
3206 return error("cannot read %d bytes from reflog for %s: %s",
3207 cnt, refname, strerror(errno));
3208 pos -= cnt;
3209
3210 scanp = endp = buf + cnt;
3211 if (at_tail && scanp[-1] == '\n')
3212 /* Looking at the final LF at the end of the file */
3213 scanp--;
3214 at_tail = 0;
3215
3216 while (buf < scanp) {
3217 /*
3218 * terminating LF of the previous line, or the beginning
3219 * of the buffer.
3220 */
3221 char *bp;
3222
3223 bp = find_beginning_of_line(buf, scanp);
3224
3225 if (*bp == '\n') {
3226 /*
3227 * The newline is the end of the previous line,
3228 * so we know we have complete line starting
3229 * at (bp + 1). Prefix it onto any prior data
3230 * we collected for the line and process it.
3231 */
3232 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
3233 scanp = bp;
3234 endp = bp + 1;
3235 ret = show_one_reflog_ent(&sb, fn, cb_data);
3236 strbuf_reset(&sb);
3237 if (ret)
3238 break;
3239 } else if (!pos) {
3240 /*
3241 * We are at the start of the buffer, and the
3242 * start of the file; there is no previous
3243 * line, and we have everything for this one.
3244 * Process it, and we can end the loop.
3245 */
3246 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3247 ret = show_one_reflog_ent(&sb, fn, cb_data);
3248 strbuf_reset(&sb);
3249 break;
3250 }
3251
3252 if (bp == buf) {
3253 /*
3254 * We are at the start of the buffer, and there
3255 * is more file to read backwards. Which means
3256 * we are in the middle of a line. Note that we
3257 * may get here even if *bp was a newline; that
3258 * just means we are at the exact end of the
3259 * previous line, rather than some spot in the
3260 * middle.
3261 *
3262 * Save away what we have to be combined with
3263 * the data from the next read.
3264 */
3265 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3266 break;
3267 }
3268 }
3269
3270 }
3271 if (!ret && sb.len)
3272 die("BUG: reverse reflog parser had leftover data");
3273
3274 fclose(logfp);
3275 strbuf_release(&sb);
3276 return ret;
3277}
3278
3279int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3280{
3281 FILE *logfp;
3282 struct strbuf sb = STRBUF_INIT;
3283 int ret = 0;
3284
3285 logfp = fopen(git_path("logs/%s", refname), "r");
3286 if (!logfp)
3287 return -1;
3288
3289 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
3290 ret = show_one_reflog_ent(&sb, fn, cb_data);
3291 fclose(logfp);
3292 strbuf_release(&sb);
3293 return ret;
3294}
7bd9bcf3 3295
2880d16f
MH
3296struct files_reflog_iterator {
3297 struct ref_iterator base;
7bd9bcf3 3298
2880d16f
MH
3299 struct dir_iterator *dir_iterator;
3300 struct object_id oid;
3301};
7bd9bcf3 3302
2880d16f
MH
3303static int files_reflog_iterator_advance(struct ref_iterator *ref_iterator)
3304{
3305 struct files_reflog_iterator *iter =
3306 (struct files_reflog_iterator *)ref_iterator;
3307 struct dir_iterator *diter = iter->dir_iterator;
3308 int ok;
3309
3310 while ((ok = dir_iterator_advance(diter)) == ITER_OK) {
3311 int flags;
3312
3313 if (!S_ISREG(diter->st.st_mode))
7bd9bcf3 3314 continue;
2880d16f
MH
3315 if (diter->basename[0] == '.')
3316 continue;
3317 if (ends_with(diter->basename, ".lock"))
7bd9bcf3 3318 continue;
7bd9bcf3 3319
2880d16f
MH
3320 if (read_ref_full(diter->relative_path, 0,
3321 iter->oid.hash, &flags)) {
3322 error("bad ref for %s", diter->path.buf);
3323 continue;
7bd9bcf3 3324 }
2880d16f
MH
3325
3326 iter->base.refname = diter->relative_path;
3327 iter->base.oid = &iter->oid;
3328 iter->base.flags = flags;
3329 return ITER_OK;
7bd9bcf3 3330 }
2880d16f
MH
3331
3332 iter->dir_iterator = NULL;
3333 if (ref_iterator_abort(ref_iterator) == ITER_ERROR)
3334 ok = ITER_ERROR;
3335 return ok;
3336}
3337
3338static int files_reflog_iterator_peel(struct ref_iterator *ref_iterator,
3339 struct object_id *peeled)
3340{
3341 die("BUG: ref_iterator_peel() called for reflog_iterator");
3342}
3343
3344static int files_reflog_iterator_abort(struct ref_iterator *ref_iterator)
3345{
3346 struct files_reflog_iterator *iter =
3347 (struct files_reflog_iterator *)ref_iterator;
3348 int ok = ITER_DONE;
3349
3350 if (iter->dir_iterator)
3351 ok = dir_iterator_abort(iter->dir_iterator);
3352
3353 base_ref_iterator_free(ref_iterator);
3354 return ok;
3355}
3356
3357static struct ref_iterator_vtable files_reflog_iterator_vtable = {
3358 files_reflog_iterator_advance,
3359 files_reflog_iterator_peel,
3360 files_reflog_iterator_abort
3361};
3362
3363struct ref_iterator *files_reflog_iterator_begin(void)
3364{
3365 struct files_reflog_iterator *iter = xcalloc(1, sizeof(*iter));
3366 struct ref_iterator *ref_iterator = &iter->base;
3367
3368 base_ref_iterator_init(ref_iterator, &files_reflog_iterator_vtable);
3369 iter->dir_iterator = dir_iterator_begin(git_path("logs"));
3370 return ref_iterator;
7bd9bcf3
MH
3371}
3372
3373int for_each_reflog(each_ref_fn fn, void *cb_data)
3374{
2880d16f
MH
3375 return do_for_each_ref_iterator(files_reflog_iterator_begin(),
3376 fn, cb_data);
7bd9bcf3
MH
3377}
3378
3379static int ref_update_reject_duplicates(struct string_list *refnames,
3380 struct strbuf *err)
3381{
3382 int i, n = refnames->nr;
3383
3384 assert(err);
3385
3386 for (i = 1; i < n; i++)
3387 if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {
3388 strbuf_addf(err,
0568c8e9 3389 "multiple updates for ref '%s' not allowed.",
7bd9bcf3
MH
3390 refnames->items[i].string);
3391 return 1;
3392 }
3393 return 0;
3394}
3395
165056b2 3396/*
92b1551b
MH
3397 * If update is a direct update of head_ref (the reference pointed to
3398 * by HEAD), then add an extra REF_LOG_ONLY update for HEAD.
3399 */
3400static int split_head_update(struct ref_update *update,
3401 struct ref_transaction *transaction,
3402 const char *head_ref,
3403 struct string_list *affected_refnames,
3404 struct strbuf *err)
3405{
3406 struct string_list_item *item;
3407 struct ref_update *new_update;
3408
3409 if ((update->flags & REF_LOG_ONLY) ||
3410 (update->flags & REF_ISPRUNING) ||
3411 (update->flags & REF_UPDATE_VIA_HEAD))
3412 return 0;
3413
3414 if (strcmp(update->refname, head_ref))
3415 return 0;
3416
3417 /*
3418 * First make sure that HEAD is not already in the
3419 * transaction. This insertion is O(N) in the transaction
3420 * size, but it happens at most once per transaction.
3421 */
3422 item = string_list_insert(affected_refnames, "HEAD");
3423 if (item->util) {
3424 /* An entry already existed */
3425 strbuf_addf(err,
3426 "multiple updates for 'HEAD' (including one "
3427 "via its referent '%s') are not allowed",
3428 update->refname);
3429 return TRANSACTION_NAME_CONFLICT;
3430 }
3431
3432 new_update = ref_transaction_add_update(
3433 transaction, "HEAD",
3434 update->flags | REF_LOG_ONLY | REF_NODEREF,
3435 update->new_sha1, update->old_sha1,
3436 update->msg);
3437
3438 item->util = new_update;
3439
3440 return 0;
3441}
3442
3443/*
3444 * update is for a symref that points at referent and doesn't have
3445 * REF_NODEREF set. Split it into two updates:
3446 * - The original update, but with REF_LOG_ONLY and REF_NODEREF set
3447 * - A new, separate update for the referent reference
3448 * Note that the new update will itself be subject to splitting when
3449 * the iteration gets to it.
3450 */
3451static int split_symref_update(struct ref_update *update,
3452 const char *referent,
3453 struct ref_transaction *transaction,
3454 struct string_list *affected_refnames,
3455 struct strbuf *err)
3456{
3457 struct string_list_item *item;
3458 struct ref_update *new_update;
3459 unsigned int new_flags;
3460
3461 /*
3462 * First make sure that referent is not already in the
3463 * transaction. This insertion is O(N) in the transaction
3464 * size, but it happens at most once per symref in a
3465 * transaction.
3466 */
3467 item = string_list_insert(affected_refnames, referent);
3468 if (item->util) {
3469 /* An entry already existed */
3470 strbuf_addf(err,
3471 "multiple updates for '%s' (including one "
3472 "via symref '%s') are not allowed",
3473 referent, update->refname);
3474 return TRANSACTION_NAME_CONFLICT;
3475 }
3476
3477 new_flags = update->flags;
3478 if (!strcmp(update->refname, "HEAD")) {
3479 /*
3480 * Record that the new update came via HEAD, so that
3481 * when we process it, split_head_update() doesn't try
3482 * to add another reflog update for HEAD. Note that
3483 * this bit will be propagated if the new_update
3484 * itself needs to be split.
3485 */
3486 new_flags |= REF_UPDATE_VIA_HEAD;
3487 }
3488
3489 new_update = ref_transaction_add_update(
3490 transaction, referent, new_flags,
3491 update->new_sha1, update->old_sha1,
3492 update->msg);
3493
6e30b2f6
MH
3494 new_update->parent_update = update;
3495
3496 /*
3497 * Change the symbolic ref update to log only. Also, it
3498 * doesn't need to check its old SHA-1 value, as that will be
3499 * done when new_update is processed.
3500 */
92b1551b 3501 update->flags |= REF_LOG_ONLY | REF_NODEREF;
6e30b2f6 3502 update->flags &= ~REF_HAVE_OLD;
92b1551b
MH
3503
3504 item->util = new_update;
3505
3506 return 0;
3507}
3508
6e30b2f6
MH
3509/*
3510 * Return the refname under which update was originally requested.
3511 */
3512static const char *original_update_refname(struct ref_update *update)
3513{
3514 while (update->parent_update)
3515 update = update->parent_update;
3516
3517 return update->refname;
3518}
3519
92b1551b
MH
3520/*
3521 * Prepare for carrying out update:
3522 * - Lock the reference referred to by update.
3523 * - Read the reference under lock.
3524 * - Check that its old SHA-1 value (if specified) is correct, and in
3525 * any case record it in update->lock->old_oid for later use when
3526 * writing the reflog.
3527 * - If it is a symref update without REF_NODEREF, split it up into a
3528 * REF_LOG_ONLY update of the symref and add a separate update for
3529 * the referent to transaction.
3530 * - If it is an update of head_ref, add a corresponding REF_LOG_ONLY
3531 * update of HEAD.
165056b2
MH
3532 */
3533static int lock_ref_for_update(struct ref_update *update,
3534 struct ref_transaction *transaction,
92b1551b 3535 const char *head_ref,
165056b2
MH
3536 struct string_list *affected_refnames,
3537 struct strbuf *err)
3538{
92b1551b
MH
3539 struct strbuf referent = STRBUF_INIT;
3540 int mustexist = (update->flags & REF_HAVE_OLD) &&
3541 !is_null_sha1(update->old_sha1);
165056b2 3542 int ret;
92b1551b 3543 struct ref_lock *lock;
165056b2 3544
92b1551b 3545 if ((update->flags & REF_HAVE_NEW) && is_null_sha1(update->new_sha1))
165056b2 3546 update->flags |= REF_DELETING;
92b1551b
MH
3547
3548 if (head_ref) {
3549 ret = split_head_update(update, transaction, head_ref,
3550 affected_refnames, err);
3551 if (ret)
3552 return ret;
3553 }
3554
3555 ret = lock_raw_ref(update->refname, mustexist,
3556 affected_refnames, NULL,
3557 &update->lock, &referent,
3558 &update->type, err);
3559
3560 if (ret) {
165056b2
MH
3561 char *reason;
3562
165056b2
MH
3563 reason = strbuf_detach(err, NULL);
3564 strbuf_addf(err, "cannot lock ref '%s': %s",
3565 update->refname, reason);
3566 free(reason);
3567 return ret;
3568 }
92b1551b
MH
3569
3570 lock = update->lock;
3571
8169d0d0 3572 if (update->type & REF_ISSYMREF) {
6e30b2f6
MH
3573 if (update->flags & REF_NODEREF) {
3574 /*
3575 * We won't be reading the referent as part of
3576 * the transaction, so we have to read it here
3577 * to record and possibly check old_sha1:
3578 */
3579 if (read_ref_full(update->refname,
3580 mustexist ? RESOLVE_REF_READING : 0,
3581 lock->old_oid.hash, NULL)) {
3582 if (update->flags & REF_HAVE_OLD) {
3583 strbuf_addf(err, "cannot lock ref '%s': "
3584 "can't resolve old value",
3585 update->refname);
3586 return TRANSACTION_GENERIC_ERROR;
3587 } else {
3588 hashclr(lock->old_oid.hash);
3589 }
3590 }
3591 if ((update->flags & REF_HAVE_OLD) &&
3592 hashcmp(lock->old_oid.hash, update->old_sha1)) {
3593 strbuf_addf(err, "cannot lock ref '%s': "
3594 "is at %s but expected %s",
3595 update->refname,
3596 sha1_to_hex(lock->old_oid.hash),
3597 sha1_to_hex(update->old_sha1));
8169d0d0 3598 return TRANSACTION_GENERIC_ERROR;
8169d0d0 3599 }
92b1551b 3600
6e30b2f6
MH
3601 } else {
3602 /*
3603 * Create a new update for the reference this
3604 * symref is pointing at. Also, we will record
3605 * and verify old_sha1 for this update as part
3606 * of processing the split-off update, so we
3607 * don't have to do it here.
3608 */
92b1551b
MH
3609 ret = split_symref_update(update, referent.buf, transaction,
3610 affected_refnames, err);
3611 if (ret)
3612 return ret;
3613 }
6e30b2f6
MH
3614 } else {
3615 struct ref_update *parent_update;
8169d0d0 3616
6e30b2f6
MH
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 oidcpy(&parent_update->lock->old_oid, &lock->old_oid);
3626 }
3627
3628 if ((update->flags & REF_HAVE_OLD) &&
3629 hashcmp(lock->old_oid.hash, update->old_sha1)) {
3630 if (is_null_sha1(update->old_sha1))
3631 strbuf_addf(err, "cannot lock ref '%s': reference already exists",
3632 original_update_refname(update));
3633 else
3634 strbuf_addf(err, "cannot lock ref '%s': is at %s but expected %s",
3635 original_update_refname(update),
3636 sha1_to_hex(lock->old_oid.hash),
3637 sha1_to_hex(update->old_sha1));
3638
3639 return TRANSACTION_GENERIC_ERROR;
3640 }
92b1551b
MH
3641 }
3642
165056b2
MH
3643 if ((update->flags & REF_HAVE_NEW) &&
3644 !(update->flags & REF_DELETING) &&
3645 !(update->flags & REF_LOG_ONLY)) {
92b1551b
MH
3646 if (!(update->type & REF_ISSYMREF) &&
3647 !hashcmp(lock->old_oid.hash, update->new_sha1)) {
165056b2
MH
3648 /*
3649 * The reference already has the desired
3650 * value, so we don't need to write it.
3651 */
92b1551b 3652 } else if (write_ref_to_lockfile(lock, update->new_sha1,
165056b2
MH
3653 err)) {
3654 char *write_err = strbuf_detach(err, NULL);
3655
3656 /*
3657 * The lock was freed upon failure of
3658 * write_ref_to_lockfile():
3659 */
3660 update->lock = NULL;
3661 strbuf_addf(err,
3662 "cannot update the ref '%s': %s",
3663 update->refname, write_err);
3664 free(write_err);
3665 return TRANSACTION_GENERIC_ERROR;
3666 } else {
3667 update->flags |= REF_NEEDS_COMMIT;
3668 }
3669 }
3670 if (!(update->flags & REF_NEEDS_COMMIT)) {
3671 /*
3672 * We didn't call write_ref_to_lockfile(), so
3673 * the lockfile is still open. Close it to
3674 * free up the file descriptor:
3675 */
92b1551b 3676 if (close_ref(lock)) {
165056b2
MH
3677 strbuf_addf(err, "couldn't close '%s.lock'",
3678 update->refname);
3679 return TRANSACTION_GENERIC_ERROR;
3680 }
3681 }
3682 return 0;
3683}
3684
7bd9bcf3
MH
3685int ref_transaction_commit(struct ref_transaction *transaction,
3686 struct strbuf *err)
3687{
3688 int ret = 0, i;
7bd9bcf3
MH
3689 struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;
3690 struct string_list_item *ref_to_delete;
3691 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
92b1551b
MH
3692 char *head_ref = NULL;
3693 int head_type;
3694 struct object_id head_oid;
7bd9bcf3
MH
3695
3696 assert(err);
3697
3698 if (transaction->state != REF_TRANSACTION_OPEN)
3699 die("BUG: commit called for transaction that is not open");
3700
efe47281 3701 if (!transaction->nr) {
7bd9bcf3
MH
3702 transaction->state = REF_TRANSACTION_CLOSED;
3703 return 0;
3704 }
3705
92b1551b
MH
3706 /*
3707 * Fail if a refname appears more than once in the
3708 * transaction. (If we end up splitting up any updates using
3709 * split_symref_update() or split_head_update(), those
3710 * functions will check that the new updates don't have the
3711 * same refname as any existing ones.)
3712 */
3713 for (i = 0; i < transaction->nr; i++) {
3714 struct ref_update *update = transaction->updates[i];
3715 struct string_list_item *item =
3716 string_list_append(&affected_refnames, update->refname);
3717
3718 /*
3719 * We store a pointer to update in item->util, but at
3720 * the moment we never use the value of this field
3721 * except to check whether it is non-NULL.
3722 */
3723 item->util = update;
3724 }
7bd9bcf3
MH
3725 string_list_sort(&affected_refnames);
3726 if (ref_update_reject_duplicates(&affected_refnames, err)) {
3727 ret = TRANSACTION_GENERIC_ERROR;
3728 goto cleanup;
3729 }
3730
92b1551b
MH
3731 /*
3732 * Special hack: If a branch is updated directly and HEAD
3733 * points to it (may happen on the remote side of a push
3734 * for example) then logically the HEAD reflog should be
3735 * updated too.
3736 *
3737 * A generic solution would require reverse symref lookups,
3738 * but finding all symrefs pointing to a given branch would be
3739 * rather costly for this rare event (the direct update of a
3740 * branch) to be worth it. So let's cheat and check with HEAD
3741 * only, which should cover 99% of all usage scenarios (even
3742 * 100% of the default ones).
3743 *
3744 * So if HEAD is a symbolic reference, then record the name of
3745 * the reference that it points to. If we see an update of
3746 * head_ref within the transaction, then split_head_update()
3747 * arranges for the reflog of HEAD to be updated, too.
3748 */
3749 head_ref = resolve_refdup("HEAD", RESOLVE_REF_NO_RECURSE,
3750 head_oid.hash, &head_type);
3751
3752 if (head_ref && !(head_type & REF_ISSYMREF)) {
3753 free(head_ref);
3754 head_ref = NULL;
3755 }
3756
7bd9bcf3
MH
3757 /*
3758 * Acquire all locks, verify old values if provided, check
3759 * that new values are valid, and write new values to the
3760 * lockfiles, ready to be activated. Only keep one lockfile
3761 * open at a time to avoid running out of file descriptors.
3762 */
efe47281
MH
3763 for (i = 0; i < transaction->nr; i++) {
3764 struct ref_update *update = transaction->updates[i];
7bd9bcf3 3765
92b1551b 3766 ret = lock_ref_for_update(update, transaction, head_ref,
165056b2
MH
3767 &affected_refnames, err);
3768 if (ret)
7bd9bcf3 3769 goto cleanup;
7bd9bcf3
MH
3770 }
3771
3772 /* Perform updates first so live commits remain referenced */
efe47281
MH
3773 for (i = 0; i < transaction->nr; i++) {
3774 struct ref_update *update = transaction->updates[i];
92b1551b 3775 struct ref_lock *lock = update->lock;
7bd9bcf3 3776
d99aa884
DT
3777 if (update->flags & REF_NEEDS_COMMIT ||
3778 update->flags & REF_LOG_ONLY) {
92b1551b
MH
3779 if (log_ref_write(lock->ref_name, lock->old_oid.hash,
3780 update->new_sha1,
3781 update->msg, update->flags, err)) {
3782 char *old_msg = strbuf_detach(err, NULL);
3783
3784 strbuf_addf(err, "cannot update the ref '%s': %s",
3785 lock->ref_name, old_msg);
3786 free(old_msg);
3787 unlock_ref(lock);
7bd9bcf3
MH
3788 update->lock = NULL;
3789 ret = TRANSACTION_GENERIC_ERROR;
3790 goto cleanup;
92b1551b
MH
3791 }
3792 }
3793 if (update->flags & REF_NEEDS_COMMIT) {
3794 clear_loose_ref_cache(&ref_cache);
3795 if (commit_ref(lock)) {
3796 strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
3797 unlock_ref(lock);
7bd9bcf3 3798 update->lock = NULL;
92b1551b
MH
3799 ret = TRANSACTION_GENERIC_ERROR;
3800 goto cleanup;
7bd9bcf3
MH
3801 }
3802 }
3803 }
7bd9bcf3 3804 /* Perform deletes now that updates are safely completed */
efe47281
MH
3805 for (i = 0; i < transaction->nr; i++) {
3806 struct ref_update *update = transaction->updates[i];
7bd9bcf3 3807
d99aa884
DT
3808 if (update->flags & REF_DELETING &&
3809 !(update->flags & REF_LOG_ONLY)) {
7bd9bcf3
MH
3810 if (delete_ref_loose(update->lock, update->type, err)) {
3811 ret = TRANSACTION_GENERIC_ERROR;
3812 goto cleanup;
3813 }
3814
3815 if (!(update->flags & REF_ISPRUNING))
3816 string_list_append(&refs_to_delete,
3817 update->lock->ref_name);
3818 }
3819 }
3820
3821 if (repack_without_refs(&refs_to_delete, err)) {
3822 ret = TRANSACTION_GENERIC_ERROR;
3823 goto cleanup;
3824 }
3825 for_each_string_list_item(ref_to_delete, &refs_to_delete)
3826 unlink_or_warn(git_path("logs/%s", ref_to_delete->string));
3827 clear_loose_ref_cache(&ref_cache);
3828
3829cleanup:
3830 transaction->state = REF_TRANSACTION_CLOSED;
3831
efe47281
MH
3832 for (i = 0; i < transaction->nr; i++)
3833 if (transaction->updates[i]->lock)
3834 unlock_ref(transaction->updates[i]->lock);
7bd9bcf3 3835 string_list_clear(&refs_to_delete, 0);
92b1551b 3836 free(head_ref);
7bd9bcf3 3837 string_list_clear(&affected_refnames, 0);
92b1551b 3838
7bd9bcf3
MH
3839 return ret;
3840}
3841
3842static int ref_present(const char *refname,
3843 const struct object_id *oid, int flags, void *cb_data)
3844{
3845 struct string_list *affected_refnames = cb_data;
3846
3847 return string_list_has_string(affected_refnames, refname);
3848}
3849
3850int initial_ref_transaction_commit(struct ref_transaction *transaction,
3851 struct strbuf *err)
3852{
3853 int ret = 0, i;
7bd9bcf3
MH
3854 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
3855
3856 assert(err);
3857
3858 if (transaction->state != REF_TRANSACTION_OPEN)
3859 die("BUG: commit called for transaction that is not open");
3860
3861 /* Fail if a refname appears more than once in the transaction: */
efe47281
MH
3862 for (i = 0; i < transaction->nr; i++)
3863 string_list_append(&affected_refnames,
3864 transaction->updates[i]->refname);
7bd9bcf3
MH
3865 string_list_sort(&affected_refnames);
3866 if (ref_update_reject_duplicates(&affected_refnames, err)) {
3867 ret = TRANSACTION_GENERIC_ERROR;
3868 goto cleanup;
3869 }
3870
3871 /*
3872 * It's really undefined to call this function in an active
3873 * repository or when there are existing references: we are
3874 * only locking and changing packed-refs, so (1) any
3875 * simultaneous processes might try to change a reference at
3876 * the same time we do, and (2) any existing loose versions of
3877 * the references that we are setting would have precedence
3878 * over our values. But some remote helpers create the remote
3879 * "HEAD" and "master" branches before calling this function,
3880 * so here we really only check that none of the references
3881 * that we are creating already exists.
3882 */
3883 if (for_each_rawref(ref_present, &affected_refnames))
3884 die("BUG: initial ref transaction called with existing refs");
3885
efe47281
MH
3886 for (i = 0; i < transaction->nr; i++) {
3887 struct ref_update *update = transaction->updates[i];
7bd9bcf3
MH
3888
3889 if ((update->flags & REF_HAVE_OLD) &&
3890 !is_null_sha1(update->old_sha1))
3891 die("BUG: initial ref transaction with old_sha1 set");
3892 if (verify_refname_available(update->refname,
3893 &affected_refnames, NULL,
3894 err)) {
3895 ret = TRANSACTION_NAME_CONFLICT;
3896 goto cleanup;
3897 }
3898 }
3899
3900 if (lock_packed_refs(0)) {
3901 strbuf_addf(err, "unable to lock packed-refs file: %s",
3902 strerror(errno));
3903 ret = TRANSACTION_GENERIC_ERROR;
3904 goto cleanup;
3905 }
3906
efe47281
MH
3907 for (i = 0; i < transaction->nr; i++) {
3908 struct ref_update *update = transaction->updates[i];
7bd9bcf3
MH
3909
3910 if ((update->flags & REF_HAVE_NEW) &&
3911 !is_null_sha1(update->new_sha1))
3912 add_packed_ref(update->refname, update->new_sha1);
3913 }
3914
3915 if (commit_packed_refs()) {
3916 strbuf_addf(err, "unable to commit packed-refs file: %s",
3917 strerror(errno));
3918 ret = TRANSACTION_GENERIC_ERROR;
3919 goto cleanup;
3920 }
3921
3922cleanup:
3923 transaction->state = REF_TRANSACTION_CLOSED;
3924 string_list_clear(&affected_refnames, 0);
3925 return ret;
3926}
3927
3928struct expire_reflog_cb {
3929 unsigned int flags;
3930 reflog_expiry_should_prune_fn *should_prune_fn;
3931 void *policy_cb;
3932 FILE *newlog;
3933 unsigned char last_kept_sha1[20];
3934};
3935
3936static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
3937 const char *email, unsigned long timestamp, int tz,
3938 const char *message, void *cb_data)
3939{
3940 struct expire_reflog_cb *cb = cb_data;
3941 struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;
3942
3943 if (cb->flags & EXPIRE_REFLOGS_REWRITE)
3944 osha1 = cb->last_kept_sha1;
3945
3946 if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,
3947 message, policy_cb)) {
3948 if (!cb->newlog)
3949 printf("would prune %s", message);
3950 else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
3951 printf("prune %s", message);
3952 } else {
3953 if (cb->newlog) {
3954 fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",
3955 sha1_to_hex(osha1), sha1_to_hex(nsha1),
3956 email, timestamp, tz, message);
3957 hashcpy(cb->last_kept_sha1, nsha1);
3958 }
3959 if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
3960 printf("keep %s", message);
3961 }
3962 return 0;
3963}
3964
3965int reflog_expire(const char *refname, const unsigned char *sha1,
3966 unsigned int flags,
3967 reflog_expiry_prepare_fn prepare_fn,
3968 reflog_expiry_should_prune_fn should_prune_fn,
3969 reflog_expiry_cleanup_fn cleanup_fn,
3970 void *policy_cb_data)
3971{
3972 static struct lock_file reflog_lock;
3973 struct expire_reflog_cb cb;
3974 struct ref_lock *lock;
3975 char *log_file;
3976 int status = 0;
3977 int type;
3978 struct strbuf err = STRBUF_INIT;
3979
3980 memset(&cb, 0, sizeof(cb));
3981 cb.flags = flags;
3982 cb.policy_cb = policy_cb_data;
3983 cb.should_prune_fn = should_prune_fn;
3984
3985 /*
3986 * The reflog file is locked by holding the lock on the
3987 * reference itself, plus we might need to update the
3988 * reference if --updateref was specified:
3989 */
41d796ed
DT
3990 lock = lock_ref_sha1_basic(refname, sha1, NULL, NULL, REF_NODEREF,
3991 &type, &err);
7bd9bcf3
MH
3992 if (!lock) {
3993 error("cannot lock ref '%s': %s", refname, err.buf);
3994 strbuf_release(&err);
3995 return -1;
3996 }
3997 if (!reflog_exists(refname)) {
3998 unlock_ref(lock);
3999 return 0;
4000 }
4001
4002 log_file = git_pathdup("logs/%s", refname);
4003 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
4004 /*
4005 * Even though holding $GIT_DIR/logs/$reflog.lock has
4006 * no locking implications, we use the lock_file
4007 * machinery here anyway because it does a lot of the
4008 * work we need, including cleaning up if the program
4009 * exits unexpectedly.
4010 */
4011 if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
4012 struct strbuf err = STRBUF_INIT;
4013 unable_to_lock_message(log_file, errno, &err);
4014 error("%s", err.buf);
4015 strbuf_release(&err);
4016 goto failure;
4017 }
4018 cb.newlog = fdopen_lock_file(&reflog_lock, "w");
4019 if (!cb.newlog) {
4020 error("cannot fdopen %s (%s)",
4021 get_lock_file_path(&reflog_lock), strerror(errno));
4022 goto failure;
4023 }
4024 }
4025
4026 (*prepare_fn)(refname, sha1, cb.policy_cb);
4027 for_each_reflog_ent(refname, expire_reflog_ent, &cb);
4028 (*cleanup_fn)(cb.policy_cb);
4029
4030 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
4031 /*
4032 * It doesn't make sense to adjust a reference pointed
4033 * to by a symbolic ref based on expiring entries in
4034 * the symbolic reference's reflog. Nor can we update
4035 * a reference if there are no remaining reflog
4036 * entries.
4037 */
4038 int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&
4039 !(type & REF_ISSYMREF) &&
4040 !is_null_sha1(cb.last_kept_sha1);
4041
4042 if (close_lock_file(&reflog_lock)) {
4043 status |= error("couldn't write %s: %s", log_file,
4044 strerror(errno));
4045 } else if (update &&
4046 (write_in_full(get_lock_file_fd(lock->lk),
4047 sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
4048 write_str_in_full(get_lock_file_fd(lock->lk), "\n") != 1 ||
4049 close_ref(lock) < 0)) {
4050 status |= error("couldn't write %s",
4051 get_lock_file_path(lock->lk));
4052 rollback_lock_file(&reflog_lock);
4053 } else if (commit_lock_file(&reflog_lock)) {
e0048d3e 4054 status |= error("unable to write reflog '%s' (%s)",
7bd9bcf3
MH
4055 log_file, strerror(errno));
4056 } else if (update && commit_ref(lock)) {
4057 status |= error("couldn't set %s", lock->ref_name);
4058 }
4059 }
4060 free(log_file);
4061 unlock_ref(lock);
4062 return status;
4063
4064 failure:
4065 rollback_lock_file(&reflog_lock);
4066 free(log_file);
4067 unlock_ref(lock);
4068 return -1;
4069}