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