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