update-ref --stdin: narrow scope of err strbuf
[alt-git.git] / refs.c
blob723557485d9f1ee76482fe3eae3e45b613de2788
1 #include "cache.h"
2 #include "refs.h"
3 #include "object.h"
4 #include "tag.h"
5 #include "dir.h"
6 #include "string-list.h"
8 /*
9 * How to handle various characters in refnames:
10 * 0: An acceptable character for refs
11 * 1: End-of-component
12 * 2: ., look for a preceding . to reject .. in refs
13 * 3: {, look for a preceding @ to reject @{ in refs
14 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
16 static unsigned char refname_disposition[256] = {
17 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
18 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
19 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
20 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
21 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
22 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
23 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
24 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
28 * Used as a flag to ref_transaction_delete when a loose ref is being
29 * pruned.
31 #define REF_ISPRUNING 0x0100
33 * Try to read one refname component from the front of refname.
34 * Return the length of the component found, or -1 if the component is
35 * not legal. It is legal if it is something reasonable to have under
36 * ".git/refs/"; We do not like it if:
38 * - any path component of it begins with ".", or
39 * - it has double dots "..", or
40 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
41 * - it ends with a "/".
42 * - it ends with ".lock"
43 * - it contains a "\" (backslash)
45 static int check_refname_component(const char *refname, int flags)
47 const char *cp;
48 char last = '\0';
50 for (cp = refname; ; cp++) {
51 int ch = *cp & 255;
52 unsigned char disp = refname_disposition[ch];
53 switch (disp) {
54 case 1:
55 goto out;
56 case 2:
57 if (last == '.')
58 return -1; /* Refname contains "..". */
59 break;
60 case 3:
61 if (last == '@')
62 return -1; /* Refname contains "@{". */
63 break;
64 case 4:
65 return -1;
67 last = ch;
69 out:
70 if (cp == refname)
71 return 0; /* Component has zero length. */
72 if (refname[0] == '.') {
73 if (!(flags & REFNAME_DOT_COMPONENT))
74 return -1; /* Component starts with '.'. */
76 * Even if leading dots are allowed, don't allow "."
77 * as a component (".." is prevented by a rule above).
79 if (refname[1] == '\0')
80 return -1; /* Component equals ".". */
82 if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
83 return -1; /* Refname ends with ".lock". */
84 return cp - refname;
87 int check_refname_format(const char *refname, int flags)
89 int component_len, component_count = 0;
91 if (!strcmp(refname, "@"))
92 /* Refname is a single character '@'. */
93 return -1;
95 while (1) {
96 /* We are at the start of a path component. */
97 component_len = check_refname_component(refname, flags);
98 if (component_len <= 0) {
99 if ((flags & REFNAME_REFSPEC_PATTERN) &&
100 refname[0] == '*' &&
101 (refname[1] == '\0' || refname[1] == '/')) {
102 /* Accept one wildcard as a full refname component. */
103 flags &= ~REFNAME_REFSPEC_PATTERN;
104 component_len = 1;
105 } else {
106 return -1;
109 component_count++;
110 if (refname[component_len] == '\0')
111 break;
112 /* Skip to next component. */
113 refname += component_len + 1;
116 if (refname[component_len - 1] == '.')
117 return -1; /* Refname ends with '.'. */
118 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
119 return -1; /* Refname has only one component. */
120 return 0;
123 struct ref_entry;
126 * Information used (along with the information in ref_entry) to
127 * describe a single cached reference. This data structure only
128 * occurs embedded in a union in struct ref_entry, and only when
129 * (ref_entry->flag & REF_DIR) is zero.
131 struct ref_value {
133 * The name of the object to which this reference resolves
134 * (which may be a tag object). If REF_ISBROKEN, this is
135 * null. If REF_ISSYMREF, then this is the name of the object
136 * referred to by the last reference in the symlink chain.
138 unsigned char sha1[20];
141 * If REF_KNOWS_PEELED, then this field holds the peeled value
142 * of this reference, or null if the reference is known not to
143 * be peelable. See the documentation for peel_ref() for an
144 * exact definition of "peelable".
146 unsigned char peeled[20];
149 struct ref_cache;
152 * Information used (along with the information in ref_entry) to
153 * describe a level in the hierarchy of references. This data
154 * structure only occurs embedded in a union in struct ref_entry, and
155 * only when (ref_entry.flag & REF_DIR) is set. In that case,
156 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
157 * in the directory have already been read:
159 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
160 * or packed references, already read.
162 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
163 * references that hasn't been read yet (nor has any of its
164 * subdirectories).
166 * Entries within a directory are stored within a growable array of
167 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
168 * sorted are sorted by their component name in strcmp() order and the
169 * remaining entries are unsorted.
171 * Loose references are read lazily, one directory at a time. When a
172 * directory of loose references is read, then all of the references
173 * in that directory are stored, and REF_INCOMPLETE stubs are created
174 * for any subdirectories, but the subdirectories themselves are not
175 * read. The reading is triggered by get_ref_dir().
177 struct ref_dir {
178 int nr, alloc;
181 * Entries with index 0 <= i < sorted are sorted by name. New
182 * entries are appended to the list unsorted, and are sorted
183 * only when required; thus we avoid the need to sort the list
184 * after the addition of every reference.
186 int sorted;
188 /* A pointer to the ref_cache that contains this ref_dir. */
189 struct ref_cache *ref_cache;
191 struct ref_entry **entries;
195 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
196 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
197 * refs.h.
201 * The field ref_entry->u.value.peeled of this value entry contains
202 * the correct peeled value for the reference, which might be
203 * null_sha1 if the reference is not a tag or if it is broken.
205 #define REF_KNOWS_PEELED 0x08
207 /* ref_entry represents a directory of references */
208 #define REF_DIR 0x10
211 * Entry has not yet been read from disk (used only for REF_DIR
212 * entries representing loose references)
214 #define REF_INCOMPLETE 0x20
217 * A ref_entry represents either a reference or a "subdirectory" of
218 * references.
220 * Each directory in the reference namespace is represented by a
221 * ref_entry with (flags & REF_DIR) set and containing a subdir member
222 * that holds the entries in that directory that have been read so
223 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
224 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
225 * used for loose reference directories.
227 * References are represented by a ref_entry with (flags & REF_DIR)
228 * unset and a value member that describes the reference's value. The
229 * flag member is at the ref_entry level, but it is also needed to
230 * interpret the contents of the value field (in other words, a
231 * ref_value object is not very much use without the enclosing
232 * ref_entry).
234 * Reference names cannot end with slash and directories' names are
235 * always stored with a trailing slash (except for the top-level
236 * directory, which is always denoted by ""). This has two nice
237 * consequences: (1) when the entries in each subdir are sorted
238 * lexicographically by name (as they usually are), the references in
239 * a whole tree can be generated in lexicographic order by traversing
240 * the tree in left-to-right, depth-first order; (2) the names of
241 * references and subdirectories cannot conflict, and therefore the
242 * presence of an empty subdirectory does not block the creation of a
243 * similarly-named reference. (The fact that reference names with the
244 * same leading components can conflict *with each other* is a
245 * separate issue that is regulated by is_refname_available().)
247 * Please note that the name field contains the fully-qualified
248 * reference (or subdirectory) name. Space could be saved by only
249 * storing the relative names. But that would require the full names
250 * to be generated on the fly when iterating in do_for_each_ref(), and
251 * would break callback functions, who have always been able to assume
252 * that the name strings that they are passed will not be freed during
253 * the iteration.
255 struct ref_entry {
256 unsigned char flag; /* ISSYMREF? ISPACKED? */
257 union {
258 struct ref_value value; /* if not (flags&REF_DIR) */
259 struct ref_dir subdir; /* if (flags&REF_DIR) */
260 } u;
262 * The full name of the reference (e.g., "refs/heads/master")
263 * or the full name of the directory with a trailing slash
264 * (e.g., "refs/heads/"):
266 char name[FLEX_ARRAY];
269 static void read_loose_refs(const char *dirname, struct ref_dir *dir);
271 static struct ref_dir *get_ref_dir(struct ref_entry *entry)
273 struct ref_dir *dir;
274 assert(entry->flag & REF_DIR);
275 dir = &entry->u.subdir;
276 if (entry->flag & REF_INCOMPLETE) {
277 read_loose_refs(entry->name, dir);
278 entry->flag &= ~REF_INCOMPLETE;
280 return dir;
283 static struct ref_entry *create_ref_entry(const char *refname,
284 const unsigned char *sha1, int flag,
285 int check_name)
287 int len;
288 struct ref_entry *ref;
290 if (check_name &&
291 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
292 die("Reference has invalid format: '%s'", refname);
293 len = strlen(refname) + 1;
294 ref = xmalloc(sizeof(struct ref_entry) + len);
295 hashcpy(ref->u.value.sha1, sha1);
296 hashclr(ref->u.value.peeled);
297 memcpy(ref->name, refname, len);
298 ref->flag = flag;
299 return ref;
302 static void clear_ref_dir(struct ref_dir *dir);
304 static void free_ref_entry(struct ref_entry *entry)
306 if (entry->flag & REF_DIR) {
308 * Do not use get_ref_dir() here, as that might
309 * trigger the reading of loose refs.
311 clear_ref_dir(&entry->u.subdir);
313 free(entry);
317 * Add a ref_entry to the end of dir (unsorted). Entry is always
318 * stored directly in dir; no recursion into subdirectories is
319 * done.
321 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
323 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
324 dir->entries[dir->nr++] = entry;
325 /* optimize for the case that entries are added in order */
326 if (dir->nr == 1 ||
327 (dir->nr == dir->sorted + 1 &&
328 strcmp(dir->entries[dir->nr - 2]->name,
329 dir->entries[dir->nr - 1]->name) < 0))
330 dir->sorted = dir->nr;
334 * Clear and free all entries in dir, recursively.
336 static void clear_ref_dir(struct ref_dir *dir)
338 int i;
339 for (i = 0; i < dir->nr; i++)
340 free_ref_entry(dir->entries[i]);
341 free(dir->entries);
342 dir->sorted = dir->nr = dir->alloc = 0;
343 dir->entries = NULL;
347 * Create a struct ref_entry object for the specified dirname.
348 * dirname is the name of the directory with a trailing slash (e.g.,
349 * "refs/heads/") or "" for the top-level directory.
351 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
352 const char *dirname, size_t len,
353 int incomplete)
355 struct ref_entry *direntry;
356 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
357 memcpy(direntry->name, dirname, len);
358 direntry->name[len] = '\0';
359 direntry->u.subdir.ref_cache = ref_cache;
360 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
361 return direntry;
364 static int ref_entry_cmp(const void *a, const void *b)
366 struct ref_entry *one = *(struct ref_entry **)a;
367 struct ref_entry *two = *(struct ref_entry **)b;
368 return strcmp(one->name, two->name);
371 static void sort_ref_dir(struct ref_dir *dir);
373 struct string_slice {
374 size_t len;
375 const char *str;
378 static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
380 const struct string_slice *key = key_;
381 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
382 int cmp = strncmp(key->str, ent->name, key->len);
383 if (cmp)
384 return cmp;
385 return '\0' - (unsigned char)ent->name[key->len];
389 * Return the index of the entry with the given refname from the
390 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
391 * no such entry is found. dir must already be complete.
393 static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
395 struct ref_entry **r;
396 struct string_slice key;
398 if (refname == NULL || !dir->nr)
399 return -1;
401 sort_ref_dir(dir);
402 key.len = len;
403 key.str = refname;
404 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
405 ref_entry_cmp_sslice);
407 if (r == NULL)
408 return -1;
410 return r - dir->entries;
414 * Search for a directory entry directly within dir (without
415 * recursing). Sort dir if necessary. subdirname must be a directory
416 * name (i.e., end in '/'). If mkdir is set, then create the
417 * directory if it is missing; otherwise, return NULL if the desired
418 * directory cannot be found. dir must already be complete.
420 static struct ref_dir *search_for_subdir(struct ref_dir *dir,
421 const char *subdirname, size_t len,
422 int mkdir)
424 int entry_index = search_ref_dir(dir, subdirname, len);
425 struct ref_entry *entry;
426 if (entry_index == -1) {
427 if (!mkdir)
428 return NULL;
430 * Since dir is complete, the absence of a subdir
431 * means that the subdir really doesn't exist;
432 * therefore, create an empty record for it but mark
433 * the record complete.
435 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
436 add_entry_to_dir(dir, entry);
437 } else {
438 entry = dir->entries[entry_index];
440 return get_ref_dir(entry);
444 * If refname is a reference name, find the ref_dir within the dir
445 * tree that should hold refname. If refname is a directory name
446 * (i.e., ends in '/'), then return that ref_dir itself. dir must
447 * represent the top-level directory and must already be complete.
448 * Sort ref_dirs and recurse into subdirectories as necessary. If
449 * mkdir is set, then create any missing directories; otherwise,
450 * return NULL if the desired directory cannot be found.
452 static struct ref_dir *find_containing_dir(struct ref_dir *dir,
453 const char *refname, int mkdir)
455 const char *slash;
456 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
457 size_t dirnamelen = slash - refname + 1;
458 struct ref_dir *subdir;
459 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
460 if (!subdir) {
461 dir = NULL;
462 break;
464 dir = subdir;
467 return dir;
471 * Find the value entry with the given name in dir, sorting ref_dirs
472 * and recursing into subdirectories as necessary. If the name is not
473 * found or it corresponds to a directory entry, return NULL.
475 static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
477 int entry_index;
478 struct ref_entry *entry;
479 dir = find_containing_dir(dir, refname, 0);
480 if (!dir)
481 return NULL;
482 entry_index = search_ref_dir(dir, refname, strlen(refname));
483 if (entry_index == -1)
484 return NULL;
485 entry = dir->entries[entry_index];
486 return (entry->flag & REF_DIR) ? NULL : entry;
490 * Remove the entry with the given name from dir, recursing into
491 * subdirectories as necessary. If refname is the name of a directory
492 * (i.e., ends with '/'), then remove the directory and its contents.
493 * If the removal was successful, return the number of entries
494 * remaining in the directory entry that contained the deleted entry.
495 * If the name was not found, return -1. Please note that this
496 * function only deletes the entry from the cache; it does not delete
497 * it from the filesystem or ensure that other cache entries (which
498 * might be symbolic references to the removed entry) are updated.
499 * Nor does it remove any containing dir entries that might be made
500 * empty by the removal. dir must represent the top-level directory
501 * and must already be complete.
503 static int remove_entry(struct ref_dir *dir, const char *refname)
505 int refname_len = strlen(refname);
506 int entry_index;
507 struct ref_entry *entry;
508 int is_dir = refname[refname_len - 1] == '/';
509 if (is_dir) {
511 * refname represents a reference directory. Remove
512 * the trailing slash; otherwise we will get the
513 * directory *representing* refname rather than the
514 * one *containing* it.
516 char *dirname = xmemdupz(refname, refname_len - 1);
517 dir = find_containing_dir(dir, dirname, 0);
518 free(dirname);
519 } else {
520 dir = find_containing_dir(dir, refname, 0);
522 if (!dir)
523 return -1;
524 entry_index = search_ref_dir(dir, refname, refname_len);
525 if (entry_index == -1)
526 return -1;
527 entry = dir->entries[entry_index];
529 memmove(&dir->entries[entry_index],
530 &dir->entries[entry_index + 1],
531 (dir->nr - entry_index - 1) * sizeof(*dir->entries)
533 dir->nr--;
534 if (dir->sorted > entry_index)
535 dir->sorted--;
536 free_ref_entry(entry);
537 return dir->nr;
541 * Add a ref_entry to the ref_dir (unsorted), recursing into
542 * subdirectories as necessary. dir must represent the top-level
543 * directory. Return 0 on success.
545 static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
547 dir = find_containing_dir(dir, ref->name, 1);
548 if (!dir)
549 return -1;
550 add_entry_to_dir(dir, ref);
551 return 0;
555 * Emit a warning and return true iff ref1 and ref2 have the same name
556 * and the same sha1. Die if they have the same name but different
557 * sha1s.
559 static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
561 if (strcmp(ref1->name, ref2->name))
562 return 0;
564 /* Duplicate name; make sure that they don't conflict: */
566 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
567 /* This is impossible by construction */
568 die("Reference directory conflict: %s", ref1->name);
570 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
571 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
573 warning("Duplicated ref: %s", ref1->name);
574 return 1;
578 * Sort the entries in dir non-recursively (if they are not already
579 * sorted) and remove any duplicate entries.
581 static void sort_ref_dir(struct ref_dir *dir)
583 int i, j;
584 struct ref_entry *last = NULL;
587 * This check also prevents passing a zero-length array to qsort(),
588 * which is a problem on some platforms.
590 if (dir->sorted == dir->nr)
591 return;
593 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
595 /* Remove any duplicates: */
596 for (i = 0, j = 0; j < dir->nr; j++) {
597 struct ref_entry *entry = dir->entries[j];
598 if (last && is_dup_ref(last, entry))
599 free_ref_entry(entry);
600 else
601 last = dir->entries[i++] = entry;
603 dir->sorted = dir->nr = i;
606 /* Include broken references in a do_for_each_ref*() iteration: */
607 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
610 * Return true iff the reference described by entry can be resolved to
611 * an object in the database. Emit a warning if the referred-to
612 * object does not exist.
614 static int ref_resolves_to_object(struct ref_entry *entry)
616 if (entry->flag & REF_ISBROKEN)
617 return 0;
618 if (!has_sha1_file(entry->u.value.sha1)) {
619 error("%s does not point to a valid object!", entry->name);
620 return 0;
622 return 1;
626 * current_ref is a performance hack: when iterating over references
627 * using the for_each_ref*() functions, current_ref is set to the
628 * current reference's entry before calling the callback function. If
629 * the callback function calls peel_ref(), then peel_ref() first
630 * checks whether the reference to be peeled is the current reference
631 * (it usually is) and if so, returns that reference's peeled version
632 * if it is available. This avoids a refname lookup in a common case.
634 static struct ref_entry *current_ref;
636 typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);
638 struct ref_entry_cb {
639 const char *base;
640 int trim;
641 int flags;
642 each_ref_fn *fn;
643 void *cb_data;
647 * Handle one reference in a do_for_each_ref*()-style iteration,
648 * calling an each_ref_fn for each entry.
650 static int do_one_ref(struct ref_entry *entry, void *cb_data)
652 struct ref_entry_cb *data = cb_data;
653 struct ref_entry *old_current_ref;
654 int retval;
656 if (!starts_with(entry->name, data->base))
657 return 0;
659 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
660 !ref_resolves_to_object(entry))
661 return 0;
663 /* Store the old value, in case this is a recursive call: */
664 old_current_ref = current_ref;
665 current_ref = entry;
666 retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
667 entry->flag, data->cb_data);
668 current_ref = old_current_ref;
669 return retval;
673 * Call fn for each reference in dir that has index in the range
674 * offset <= index < dir->nr. Recurse into subdirectories that are in
675 * that index range, sorting them before iterating. This function
676 * does not sort dir itself; it should be sorted beforehand. fn is
677 * called for all references, including broken ones.
679 static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
680 each_ref_entry_fn fn, void *cb_data)
682 int i;
683 assert(dir->sorted == dir->nr);
684 for (i = offset; i < dir->nr; i++) {
685 struct ref_entry *entry = dir->entries[i];
686 int retval;
687 if (entry->flag & REF_DIR) {
688 struct ref_dir *subdir = get_ref_dir(entry);
689 sort_ref_dir(subdir);
690 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
691 } else {
692 retval = fn(entry, cb_data);
694 if (retval)
695 return retval;
697 return 0;
701 * Call fn for each reference in the union of dir1 and dir2, in order
702 * by refname. Recurse into subdirectories. If a value entry appears
703 * in both dir1 and dir2, then only process the version that is in
704 * dir2. The input dirs must already be sorted, but subdirs will be
705 * sorted as needed. fn is called for all references, including
706 * broken ones.
708 static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
709 struct ref_dir *dir2,
710 each_ref_entry_fn fn, void *cb_data)
712 int retval;
713 int i1 = 0, i2 = 0;
715 assert(dir1->sorted == dir1->nr);
716 assert(dir2->sorted == dir2->nr);
717 while (1) {
718 struct ref_entry *e1, *e2;
719 int cmp;
720 if (i1 == dir1->nr) {
721 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
723 if (i2 == dir2->nr) {
724 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
726 e1 = dir1->entries[i1];
727 e2 = dir2->entries[i2];
728 cmp = strcmp(e1->name, e2->name);
729 if (cmp == 0) {
730 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
731 /* Both are directories; descend them in parallel. */
732 struct ref_dir *subdir1 = get_ref_dir(e1);
733 struct ref_dir *subdir2 = get_ref_dir(e2);
734 sort_ref_dir(subdir1);
735 sort_ref_dir(subdir2);
736 retval = do_for_each_entry_in_dirs(
737 subdir1, subdir2, fn, cb_data);
738 i1++;
739 i2++;
740 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
741 /* Both are references; ignore the one from dir1. */
742 retval = fn(e2, cb_data);
743 i1++;
744 i2++;
745 } else {
746 die("conflict between reference and directory: %s",
747 e1->name);
749 } else {
750 struct ref_entry *e;
751 if (cmp < 0) {
752 e = e1;
753 i1++;
754 } else {
755 e = e2;
756 i2++;
758 if (e->flag & REF_DIR) {
759 struct ref_dir *subdir = get_ref_dir(e);
760 sort_ref_dir(subdir);
761 retval = do_for_each_entry_in_dir(
762 subdir, 0, fn, cb_data);
763 } else {
764 retval = fn(e, cb_data);
767 if (retval)
768 return retval;
773 * Load all of the refs from the dir into our in-memory cache. The hard work
774 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
775 * through all of the sub-directories. We do not even need to care about
776 * sorting, as traversal order does not matter to us.
778 static void prime_ref_dir(struct ref_dir *dir)
780 int i;
781 for (i = 0; i < dir->nr; i++) {
782 struct ref_entry *entry = dir->entries[i];
783 if (entry->flag & REF_DIR)
784 prime_ref_dir(get_ref_dir(entry));
788 * Return true iff refname1 and refname2 conflict with each other.
789 * Two reference names conflict if one of them exactly matches the
790 * leading components of the other; e.g., "foo/bar" conflicts with
791 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
792 * "foo/barbados".
794 static int names_conflict(const char *refname1, const char *refname2)
796 for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
798 return (*refname1 == '\0' && *refname2 == '/')
799 || (*refname1 == '/' && *refname2 == '\0');
802 struct name_conflict_cb {
803 const char *refname;
804 const char *oldrefname;
805 const char *conflicting_refname;
808 static int name_conflict_fn(struct ref_entry *entry, void *cb_data)
810 struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
811 if (data->oldrefname && !strcmp(data->oldrefname, entry->name))
812 return 0;
813 if (names_conflict(data->refname, entry->name)) {
814 data->conflicting_refname = entry->name;
815 return 1;
817 return 0;
821 * Return true iff a reference named refname could be created without
822 * conflicting with the name of an existing reference in dir. If
823 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
824 * (e.g., because oldrefname is scheduled for deletion in the same
825 * operation).
827 static int is_refname_available(const char *refname, const char *oldrefname,
828 struct ref_dir *dir)
830 struct name_conflict_cb data;
831 data.refname = refname;
832 data.oldrefname = oldrefname;
833 data.conflicting_refname = NULL;
835 sort_ref_dir(dir);
836 if (do_for_each_entry_in_dir(dir, 0, name_conflict_fn, &data)) {
837 error("'%s' exists; cannot create '%s'",
838 data.conflicting_refname, refname);
839 return 0;
841 return 1;
844 struct packed_ref_cache {
845 struct ref_entry *root;
848 * Count of references to the data structure in this instance,
849 * including the pointer from ref_cache::packed if any. The
850 * data will not be freed as long as the reference count is
851 * nonzero.
853 unsigned int referrers;
856 * Iff the packed-refs file associated with this instance is
857 * currently locked for writing, this points at the associated
858 * lock (which is owned by somebody else). The referrer count
859 * is also incremented when the file is locked and decremented
860 * when it is unlocked.
862 struct lock_file *lock;
864 /* The metadata from when this packed-refs cache was read */
865 struct stat_validity validity;
869 * Future: need to be in "struct repository"
870 * when doing a full libification.
872 static struct ref_cache {
873 struct ref_cache *next;
874 struct ref_entry *loose;
875 struct packed_ref_cache *packed;
877 * The submodule name, or "" for the main repo. We allocate
878 * length 1 rather than FLEX_ARRAY so that the main ref_cache
879 * is initialized correctly.
881 char name[1];
882 } ref_cache, *submodule_ref_caches;
884 /* Lock used for the main packed-refs file: */
885 static struct lock_file packlock;
888 * Increment the reference count of *packed_refs.
890 static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
892 packed_refs->referrers++;
896 * Decrease the reference count of *packed_refs. If it goes to zero,
897 * free *packed_refs and return true; otherwise return false.
899 static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
901 if (!--packed_refs->referrers) {
902 free_ref_entry(packed_refs->root);
903 stat_validity_clear(&packed_refs->validity);
904 free(packed_refs);
905 return 1;
906 } else {
907 return 0;
911 static void clear_packed_ref_cache(struct ref_cache *refs)
913 if (refs->packed) {
914 struct packed_ref_cache *packed_refs = refs->packed;
916 if (packed_refs->lock)
917 die("internal error: packed-ref cache cleared while locked");
918 refs->packed = NULL;
919 release_packed_ref_cache(packed_refs);
923 static void clear_loose_ref_cache(struct ref_cache *refs)
925 if (refs->loose) {
926 free_ref_entry(refs->loose);
927 refs->loose = NULL;
931 static struct ref_cache *create_ref_cache(const char *submodule)
933 int len;
934 struct ref_cache *refs;
935 if (!submodule)
936 submodule = "";
937 len = strlen(submodule) + 1;
938 refs = xcalloc(1, sizeof(struct ref_cache) + len);
939 memcpy(refs->name, submodule, len);
940 return refs;
944 * Return a pointer to a ref_cache for the specified submodule. For
945 * the main repository, use submodule==NULL. The returned structure
946 * will be allocated and initialized but not necessarily populated; it
947 * should not be freed.
949 static struct ref_cache *get_ref_cache(const char *submodule)
951 struct ref_cache *refs;
953 if (!submodule || !*submodule)
954 return &ref_cache;
956 for (refs = submodule_ref_caches; refs; refs = refs->next)
957 if (!strcmp(submodule, refs->name))
958 return refs;
960 refs = create_ref_cache(submodule);
961 refs->next = submodule_ref_caches;
962 submodule_ref_caches = refs;
963 return refs;
966 /* The length of a peeled reference line in packed-refs, including EOL: */
967 #define PEELED_LINE_LENGTH 42
970 * The packed-refs header line that we write out. Perhaps other
971 * traits will be added later. The trailing space is required.
973 static const char PACKED_REFS_HEADER[] =
974 "# pack-refs with: peeled fully-peeled \n";
977 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
978 * Return a pointer to the refname within the line (null-terminated),
979 * or NULL if there was a problem.
981 static const char *parse_ref_line(char *line, unsigned char *sha1)
984 * 42: the answer to everything.
986 * In this case, it happens to be the answer to
987 * 40 (length of sha1 hex representation)
988 * +1 (space in between hex and name)
989 * +1 (newline at the end of the line)
991 int len = strlen(line) - 42;
993 if (len <= 0)
994 return NULL;
995 if (get_sha1_hex(line, sha1) < 0)
996 return NULL;
997 if (!isspace(line[40]))
998 return NULL;
999 line += 41;
1000 if (isspace(*line))
1001 return NULL;
1002 if (line[len] != '\n')
1003 return NULL;
1004 line[len] = 0;
1006 return line;
1010 * Read f, which is a packed-refs file, into dir.
1012 * A comment line of the form "# pack-refs with: " may contain zero or
1013 * more traits. We interpret the traits as follows:
1015 * No traits:
1017 * Probably no references are peeled. But if the file contains a
1018 * peeled value for a reference, we will use it.
1020 * peeled:
1022 * References under "refs/tags/", if they *can* be peeled, *are*
1023 * peeled in this file. References outside of "refs/tags/" are
1024 * probably not peeled even if they could have been, but if we find
1025 * a peeled value for such a reference we will use it.
1027 * fully-peeled:
1029 * All references in the file that can be peeled are peeled.
1030 * Inversely (and this is more important), any references in the
1031 * file for which no peeled value is recorded is not peelable. This
1032 * trait should typically be written alongside "peeled" for
1033 * compatibility with older clients, but we do not require it
1034 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1036 static void read_packed_refs(FILE *f, struct ref_dir *dir)
1038 struct ref_entry *last = NULL;
1039 char refline[PATH_MAX];
1040 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1042 while (fgets(refline, sizeof(refline), f)) {
1043 unsigned char sha1[20];
1044 const char *refname;
1045 static const char header[] = "# pack-refs with:";
1047 if (!strncmp(refline, header, sizeof(header)-1)) {
1048 const char *traits = refline + sizeof(header) - 1;
1049 if (strstr(traits, " fully-peeled "))
1050 peeled = PEELED_FULLY;
1051 else if (strstr(traits, " peeled "))
1052 peeled = PEELED_TAGS;
1053 /* perhaps other traits later as well */
1054 continue;
1057 refname = parse_ref_line(refline, sha1);
1058 if (refname) {
1059 last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
1060 if (peeled == PEELED_FULLY ||
1061 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1062 last->flag |= REF_KNOWS_PEELED;
1063 add_ref(dir, last);
1064 continue;
1066 if (last &&
1067 refline[0] == '^' &&
1068 strlen(refline) == PEELED_LINE_LENGTH &&
1069 refline[PEELED_LINE_LENGTH - 1] == '\n' &&
1070 !get_sha1_hex(refline + 1, sha1)) {
1071 hashcpy(last->u.value.peeled, sha1);
1073 * Regardless of what the file header said,
1074 * we definitely know the value of *this*
1075 * reference:
1077 last->flag |= REF_KNOWS_PEELED;
1083 * Get the packed_ref_cache for the specified ref_cache, creating it
1084 * if necessary.
1086 static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1088 const char *packed_refs_file;
1090 if (*refs->name)
1091 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
1092 else
1093 packed_refs_file = git_path("packed-refs");
1095 if (refs->packed &&
1096 !stat_validity_check(&refs->packed->validity, packed_refs_file))
1097 clear_packed_ref_cache(refs);
1099 if (!refs->packed) {
1100 FILE *f;
1102 refs->packed = xcalloc(1, sizeof(*refs->packed));
1103 acquire_packed_ref_cache(refs->packed);
1104 refs->packed->root = create_dir_entry(refs, "", 0, 0);
1105 f = fopen(packed_refs_file, "r");
1106 if (f) {
1107 stat_validity_update(&refs->packed->validity, fileno(f));
1108 read_packed_refs(f, get_ref_dir(refs->packed->root));
1109 fclose(f);
1112 return refs->packed;
1115 static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1117 return get_ref_dir(packed_ref_cache->root);
1120 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1122 return get_packed_ref_dir(get_packed_ref_cache(refs));
1125 void add_packed_ref(const char *refname, const unsigned char *sha1)
1127 struct packed_ref_cache *packed_ref_cache =
1128 get_packed_ref_cache(&ref_cache);
1130 if (!packed_ref_cache->lock)
1131 die("internal error: packed refs not locked");
1132 add_ref(get_packed_ref_dir(packed_ref_cache),
1133 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1137 * Read the loose references from the namespace dirname into dir
1138 * (without recursing). dirname must end with '/'. dir must be the
1139 * directory entry corresponding to dirname.
1141 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1143 struct ref_cache *refs = dir->ref_cache;
1144 DIR *d;
1145 const char *path;
1146 struct dirent *de;
1147 int dirnamelen = strlen(dirname);
1148 struct strbuf refname;
1150 if (*refs->name)
1151 path = git_path_submodule(refs->name, "%s", dirname);
1152 else
1153 path = git_path("%s", dirname);
1155 d = opendir(path);
1156 if (!d)
1157 return;
1159 strbuf_init(&refname, dirnamelen + 257);
1160 strbuf_add(&refname, dirname, dirnamelen);
1162 while ((de = readdir(d)) != NULL) {
1163 unsigned char sha1[20];
1164 struct stat st;
1165 int flag;
1166 const char *refdir;
1168 if (de->d_name[0] == '.')
1169 continue;
1170 if (has_extension(de->d_name, ".lock"))
1171 continue;
1172 strbuf_addstr(&refname, de->d_name);
1173 refdir = *refs->name
1174 ? git_path_submodule(refs->name, "%s", refname.buf)
1175 : git_path("%s", refname.buf);
1176 if (stat(refdir, &st) < 0) {
1177 ; /* silently ignore */
1178 } else if (S_ISDIR(st.st_mode)) {
1179 strbuf_addch(&refname, '/');
1180 add_entry_to_dir(dir,
1181 create_dir_entry(refs, refname.buf,
1182 refname.len, 1));
1183 } else {
1184 if (*refs->name) {
1185 hashclr(sha1);
1186 flag = 0;
1187 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1188 hashclr(sha1);
1189 flag |= REF_ISBROKEN;
1191 } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
1192 hashclr(sha1);
1193 flag |= REF_ISBROKEN;
1195 add_entry_to_dir(dir,
1196 create_ref_entry(refname.buf, sha1, flag, 1));
1198 strbuf_setlen(&refname, dirnamelen);
1200 strbuf_release(&refname);
1201 closedir(d);
1204 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1206 if (!refs->loose) {
1208 * Mark the top-level directory complete because we
1209 * are about to read the only subdirectory that can
1210 * hold references:
1212 refs->loose = create_dir_entry(refs, "", 0, 0);
1214 * Create an incomplete entry for "refs/":
1216 add_entry_to_dir(get_ref_dir(refs->loose),
1217 create_dir_entry(refs, "refs/", 5, 1));
1219 return get_ref_dir(refs->loose);
1222 /* We allow "recursive" symbolic refs. Only within reason, though */
1223 #define MAXDEPTH 5
1224 #define MAXREFLEN (1024)
1227 * Called by resolve_gitlink_ref_recursive() after it failed to read
1228 * from the loose refs in ref_cache refs. Find <refname> in the
1229 * packed-refs file for the submodule.
1231 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1232 const char *refname, unsigned char *sha1)
1234 struct ref_entry *ref;
1235 struct ref_dir *dir = get_packed_refs(refs);
1237 ref = find_ref(dir, refname);
1238 if (ref == NULL)
1239 return -1;
1241 hashcpy(sha1, ref->u.value.sha1);
1242 return 0;
1245 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1246 const char *refname, unsigned char *sha1,
1247 int recursion)
1249 int fd, len;
1250 char buffer[128], *p;
1251 char *path;
1253 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1254 return -1;
1255 path = *refs->name
1256 ? git_path_submodule(refs->name, "%s", refname)
1257 : git_path("%s", refname);
1258 fd = open(path, O_RDONLY);
1259 if (fd < 0)
1260 return resolve_gitlink_packed_ref(refs, refname, sha1);
1262 len = read(fd, buffer, sizeof(buffer)-1);
1263 close(fd);
1264 if (len < 0)
1265 return -1;
1266 while (len && isspace(buffer[len-1]))
1267 len--;
1268 buffer[len] = 0;
1270 /* Was it a detached head or an old-fashioned symlink? */
1271 if (!get_sha1_hex(buffer, sha1))
1272 return 0;
1274 /* Symref? */
1275 if (strncmp(buffer, "ref:", 4))
1276 return -1;
1277 p = buffer + 4;
1278 while (isspace(*p))
1279 p++;
1281 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1284 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1286 int len = strlen(path), retval;
1287 char *submodule;
1288 struct ref_cache *refs;
1290 while (len && path[len-1] == '/')
1291 len--;
1292 if (!len)
1293 return -1;
1294 submodule = xstrndup(path, len);
1295 refs = get_ref_cache(submodule);
1296 free(submodule);
1298 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1299 return retval;
1303 * Return the ref_entry for the given refname from the packed
1304 * references. If it does not exist, return NULL.
1306 static struct ref_entry *get_packed_ref(const char *refname)
1308 return find_ref(get_packed_refs(&ref_cache), refname);
1312 * A loose ref file doesn't exist; check for a packed ref. The
1313 * options are forwarded from resolve_safe_unsafe().
1315 static const char *handle_missing_loose_ref(const char *refname,
1316 unsigned char *sha1,
1317 int reading,
1318 int *flag)
1320 struct ref_entry *entry;
1323 * The loose reference file does not exist; check for a packed
1324 * reference.
1326 entry = get_packed_ref(refname);
1327 if (entry) {
1328 hashcpy(sha1, entry->u.value.sha1);
1329 if (flag)
1330 *flag |= REF_ISPACKED;
1331 return refname;
1333 /* The reference is not a packed reference, either. */
1334 if (reading) {
1335 return NULL;
1336 } else {
1337 hashclr(sha1);
1338 return refname;
1342 /* This function needs to return a meaningful errno on failure */
1343 const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1345 int depth = MAXDEPTH;
1346 ssize_t len;
1347 char buffer[256];
1348 static char refname_buffer[256];
1350 if (flag)
1351 *flag = 0;
1353 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1354 errno = EINVAL;
1355 return NULL;
1358 for (;;) {
1359 char path[PATH_MAX];
1360 struct stat st;
1361 char *buf;
1362 int fd;
1364 if (--depth < 0) {
1365 errno = ELOOP;
1366 return NULL;
1369 git_snpath(path, sizeof(path), "%s", refname);
1372 * We might have to loop back here to avoid a race
1373 * condition: first we lstat() the file, then we try
1374 * to read it as a link or as a file. But if somebody
1375 * changes the type of the file (file <-> directory
1376 * <-> symlink) between the lstat() and reading, then
1377 * we don't want to report that as an error but rather
1378 * try again starting with the lstat().
1380 stat_ref:
1381 if (lstat(path, &st) < 0) {
1382 if (errno == ENOENT)
1383 return handle_missing_loose_ref(refname, sha1,
1384 reading, flag);
1385 else
1386 return NULL;
1389 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1390 if (S_ISLNK(st.st_mode)) {
1391 len = readlink(path, buffer, sizeof(buffer)-1);
1392 if (len < 0) {
1393 if (errno == ENOENT || errno == EINVAL)
1394 /* inconsistent with lstat; retry */
1395 goto stat_ref;
1396 else
1397 return NULL;
1399 buffer[len] = 0;
1400 if (starts_with(buffer, "refs/") &&
1401 !check_refname_format(buffer, 0)) {
1402 strcpy(refname_buffer, buffer);
1403 refname = refname_buffer;
1404 if (flag)
1405 *flag |= REF_ISSYMREF;
1406 continue;
1410 /* Is it a directory? */
1411 if (S_ISDIR(st.st_mode)) {
1412 errno = EISDIR;
1413 return NULL;
1417 * Anything else, just open it and try to use it as
1418 * a ref
1420 fd = open(path, O_RDONLY);
1421 if (fd < 0) {
1422 if (errno == ENOENT)
1423 /* inconsistent with lstat; retry */
1424 goto stat_ref;
1425 else
1426 return NULL;
1428 len = read_in_full(fd, buffer, sizeof(buffer)-1);
1429 if (len < 0) {
1430 int save_errno = errno;
1431 close(fd);
1432 errno = save_errno;
1433 return NULL;
1435 close(fd);
1436 while (len && isspace(buffer[len-1]))
1437 len--;
1438 buffer[len] = '\0';
1441 * Is it a symbolic ref?
1443 if (!starts_with(buffer, "ref:")) {
1445 * Please note that FETCH_HEAD has a second
1446 * line containing other data.
1448 if (get_sha1_hex(buffer, sha1) ||
1449 (buffer[40] != '\0' && !isspace(buffer[40]))) {
1450 if (flag)
1451 *flag |= REF_ISBROKEN;
1452 errno = EINVAL;
1453 return NULL;
1455 return refname;
1457 if (flag)
1458 *flag |= REF_ISSYMREF;
1459 buf = buffer + 4;
1460 while (isspace(*buf))
1461 buf++;
1462 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1463 if (flag)
1464 *flag |= REF_ISBROKEN;
1465 errno = EINVAL;
1466 return NULL;
1468 refname = strcpy(refname_buffer, buf);
1472 char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1474 const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1475 return ret ? xstrdup(ret) : NULL;
1478 /* The argument to filter_refs */
1479 struct ref_filter {
1480 const char *pattern;
1481 each_ref_fn *fn;
1482 void *cb_data;
1485 int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1487 if (resolve_ref_unsafe(refname, sha1, reading, flags))
1488 return 0;
1489 return -1;
1492 int read_ref(const char *refname, unsigned char *sha1)
1494 return read_ref_full(refname, sha1, 1, NULL);
1497 int ref_exists(const char *refname)
1499 unsigned char sha1[20];
1500 return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1503 static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1504 void *data)
1506 struct ref_filter *filter = (struct ref_filter *)data;
1507 if (wildmatch(filter->pattern, refname, 0, NULL))
1508 return 0;
1509 return filter->fn(refname, sha1, flags, filter->cb_data);
1512 enum peel_status {
1513 /* object was peeled successfully: */
1514 PEEL_PEELED = 0,
1517 * object cannot be peeled because the named object (or an
1518 * object referred to by a tag in the peel chain), does not
1519 * exist.
1521 PEEL_INVALID = -1,
1523 /* object cannot be peeled because it is not a tag: */
1524 PEEL_NON_TAG = -2,
1526 /* ref_entry contains no peeled value because it is a symref: */
1527 PEEL_IS_SYMREF = -3,
1530 * ref_entry cannot be peeled because it is broken (i.e., the
1531 * symbolic reference cannot even be resolved to an object
1532 * name):
1534 PEEL_BROKEN = -4
1538 * Peel the named object; i.e., if the object is a tag, resolve the
1539 * tag recursively until a non-tag is found. If successful, store the
1540 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1541 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1542 * and leave sha1 unchanged.
1544 static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1546 struct object *o = lookup_unknown_object(name);
1548 if (o->type == OBJ_NONE) {
1549 int type = sha1_object_info(name, NULL);
1550 if (type < 0)
1551 return PEEL_INVALID;
1552 o->type = type;
1555 if (o->type != OBJ_TAG)
1556 return PEEL_NON_TAG;
1558 o = deref_tag_noverify(o);
1559 if (!o)
1560 return PEEL_INVALID;
1562 hashcpy(sha1, o->sha1);
1563 return PEEL_PEELED;
1567 * Peel the entry (if possible) and return its new peel_status. If
1568 * repeel is true, re-peel the entry even if there is an old peeled
1569 * value that is already stored in it.
1571 * It is OK to call this function with a packed reference entry that
1572 * might be stale and might even refer to an object that has since
1573 * been garbage-collected. In such a case, if the entry has
1574 * REF_KNOWS_PEELED then leave the status unchanged and return
1575 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1577 static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1579 enum peel_status status;
1581 if (entry->flag & REF_KNOWS_PEELED) {
1582 if (repeel) {
1583 entry->flag &= ~REF_KNOWS_PEELED;
1584 hashclr(entry->u.value.peeled);
1585 } else {
1586 return is_null_sha1(entry->u.value.peeled) ?
1587 PEEL_NON_TAG : PEEL_PEELED;
1590 if (entry->flag & REF_ISBROKEN)
1591 return PEEL_BROKEN;
1592 if (entry->flag & REF_ISSYMREF)
1593 return PEEL_IS_SYMREF;
1595 status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
1596 if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1597 entry->flag |= REF_KNOWS_PEELED;
1598 return status;
1601 int peel_ref(const char *refname, unsigned char *sha1)
1603 int flag;
1604 unsigned char base[20];
1606 if (current_ref && (current_ref->name == refname
1607 || !strcmp(current_ref->name, refname))) {
1608 if (peel_entry(current_ref, 0))
1609 return -1;
1610 hashcpy(sha1, current_ref->u.value.peeled);
1611 return 0;
1614 if (read_ref_full(refname, base, 1, &flag))
1615 return -1;
1618 * If the reference is packed, read its ref_entry from the
1619 * cache in the hope that we already know its peeled value.
1620 * We only try this optimization on packed references because
1621 * (a) forcing the filling of the loose reference cache could
1622 * be expensive and (b) loose references anyway usually do not
1623 * have REF_KNOWS_PEELED.
1625 if (flag & REF_ISPACKED) {
1626 struct ref_entry *r = get_packed_ref(refname);
1627 if (r) {
1628 if (peel_entry(r, 0))
1629 return -1;
1630 hashcpy(sha1, r->u.value.peeled);
1631 return 0;
1635 return peel_object(base, sha1);
1638 struct warn_if_dangling_data {
1639 FILE *fp;
1640 const char *refname;
1641 const struct string_list *refnames;
1642 const char *msg_fmt;
1645 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1646 int flags, void *cb_data)
1648 struct warn_if_dangling_data *d = cb_data;
1649 const char *resolves_to;
1650 unsigned char junk[20];
1652 if (!(flags & REF_ISSYMREF))
1653 return 0;
1655 resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1656 if (!resolves_to
1657 || (d->refname
1658 ? strcmp(resolves_to, d->refname)
1659 : !string_list_has_string(d->refnames, resolves_to))) {
1660 return 0;
1663 fprintf(d->fp, d->msg_fmt, refname);
1664 fputc('\n', d->fp);
1665 return 0;
1668 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1670 struct warn_if_dangling_data data;
1672 data.fp = fp;
1673 data.refname = refname;
1674 data.refnames = NULL;
1675 data.msg_fmt = msg_fmt;
1676 for_each_rawref(warn_if_dangling_symref, &data);
1679 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
1681 struct warn_if_dangling_data data;
1683 data.fp = fp;
1684 data.refname = NULL;
1685 data.refnames = refnames;
1686 data.msg_fmt = msg_fmt;
1687 for_each_rawref(warn_if_dangling_symref, &data);
1691 * Call fn for each reference in the specified ref_cache, omitting
1692 * references not in the containing_dir of base. fn is called for all
1693 * references, including broken ones. If fn ever returns a non-zero
1694 * value, stop the iteration and return that value; otherwise, return
1695 * 0.
1697 static int do_for_each_entry(struct ref_cache *refs, const char *base,
1698 each_ref_entry_fn fn, void *cb_data)
1700 struct packed_ref_cache *packed_ref_cache;
1701 struct ref_dir *loose_dir;
1702 struct ref_dir *packed_dir;
1703 int retval = 0;
1706 * We must make sure that all loose refs are read before accessing the
1707 * packed-refs file; this avoids a race condition in which loose refs
1708 * are migrated to the packed-refs file by a simultaneous process, but
1709 * our in-memory view is from before the migration. get_packed_ref_cache()
1710 * takes care of making sure our view is up to date with what is on
1711 * disk.
1713 loose_dir = get_loose_refs(refs);
1714 if (base && *base) {
1715 loose_dir = find_containing_dir(loose_dir, base, 0);
1717 if (loose_dir)
1718 prime_ref_dir(loose_dir);
1720 packed_ref_cache = get_packed_ref_cache(refs);
1721 acquire_packed_ref_cache(packed_ref_cache);
1722 packed_dir = get_packed_ref_dir(packed_ref_cache);
1723 if (base && *base) {
1724 packed_dir = find_containing_dir(packed_dir, base, 0);
1727 if (packed_dir && loose_dir) {
1728 sort_ref_dir(packed_dir);
1729 sort_ref_dir(loose_dir);
1730 retval = do_for_each_entry_in_dirs(
1731 packed_dir, loose_dir, fn, cb_data);
1732 } else if (packed_dir) {
1733 sort_ref_dir(packed_dir);
1734 retval = do_for_each_entry_in_dir(
1735 packed_dir, 0, fn, cb_data);
1736 } else if (loose_dir) {
1737 sort_ref_dir(loose_dir);
1738 retval = do_for_each_entry_in_dir(
1739 loose_dir, 0, fn, cb_data);
1742 release_packed_ref_cache(packed_ref_cache);
1743 return retval;
1747 * Call fn for each reference in the specified ref_cache for which the
1748 * refname begins with base. If trim is non-zero, then trim that many
1749 * characters off the beginning of each refname before passing the
1750 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1751 * broken references in the iteration. If fn ever returns a non-zero
1752 * value, stop the iteration and return that value; otherwise, return
1753 * 0.
1755 static int do_for_each_ref(struct ref_cache *refs, const char *base,
1756 each_ref_fn fn, int trim, int flags, void *cb_data)
1758 struct ref_entry_cb data;
1759 data.base = base;
1760 data.trim = trim;
1761 data.flags = flags;
1762 data.fn = fn;
1763 data.cb_data = cb_data;
1765 return do_for_each_entry(refs, base, do_one_ref, &data);
1768 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1770 unsigned char sha1[20];
1771 int flag;
1773 if (submodule) {
1774 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1775 return fn("HEAD", sha1, 0, cb_data);
1777 return 0;
1780 if (!read_ref_full("HEAD", sha1, 1, &flag))
1781 return fn("HEAD", sha1, flag, cb_data);
1783 return 0;
1786 int head_ref(each_ref_fn fn, void *cb_data)
1788 return do_head_ref(NULL, fn, cb_data);
1791 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1793 return do_head_ref(submodule, fn, cb_data);
1796 int for_each_ref(each_ref_fn fn, void *cb_data)
1798 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1801 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1803 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1806 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1808 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1811 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1812 each_ref_fn fn, void *cb_data)
1814 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1817 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1819 return for_each_ref_in("refs/tags/", fn, cb_data);
1822 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1824 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1827 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1829 return for_each_ref_in("refs/heads/", fn, cb_data);
1832 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1834 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1837 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1839 return for_each_ref_in("refs/remotes/", fn, cb_data);
1842 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1844 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1847 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1849 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
1852 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1854 struct strbuf buf = STRBUF_INIT;
1855 int ret = 0;
1856 unsigned char sha1[20];
1857 int flag;
1859 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1860 if (!read_ref_full(buf.buf, sha1, 1, &flag))
1861 ret = fn(buf.buf, sha1, flag, cb_data);
1862 strbuf_release(&buf);
1864 return ret;
1867 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1869 struct strbuf buf = STRBUF_INIT;
1870 int ret;
1871 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1872 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
1873 strbuf_release(&buf);
1874 return ret;
1877 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1878 const char *prefix, void *cb_data)
1880 struct strbuf real_pattern = STRBUF_INIT;
1881 struct ref_filter filter;
1882 int ret;
1884 if (!prefix && !starts_with(pattern, "refs/"))
1885 strbuf_addstr(&real_pattern, "refs/");
1886 else if (prefix)
1887 strbuf_addstr(&real_pattern, prefix);
1888 strbuf_addstr(&real_pattern, pattern);
1890 if (!has_glob_specials(pattern)) {
1891 /* Append implied '/' '*' if not present. */
1892 if (real_pattern.buf[real_pattern.len - 1] != '/')
1893 strbuf_addch(&real_pattern, '/');
1894 /* No need to check for '*', there is none. */
1895 strbuf_addch(&real_pattern, '*');
1898 filter.pattern = real_pattern.buf;
1899 filter.fn = fn;
1900 filter.cb_data = cb_data;
1901 ret = for_each_ref(filter_refs, &filter);
1903 strbuf_release(&real_pattern);
1904 return ret;
1907 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1909 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1912 int for_each_rawref(each_ref_fn fn, void *cb_data)
1914 return do_for_each_ref(&ref_cache, "", fn, 0,
1915 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1918 const char *prettify_refname(const char *name)
1920 return name + (
1921 starts_with(name, "refs/heads/") ? 11 :
1922 starts_with(name, "refs/tags/") ? 10 :
1923 starts_with(name, "refs/remotes/") ? 13 :
1927 static const char *ref_rev_parse_rules[] = {
1928 "%.*s",
1929 "refs/%.*s",
1930 "refs/tags/%.*s",
1931 "refs/heads/%.*s",
1932 "refs/remotes/%.*s",
1933 "refs/remotes/%.*s/HEAD",
1934 NULL
1937 int refname_match(const char *abbrev_name, const char *full_name)
1939 const char **p;
1940 const int abbrev_name_len = strlen(abbrev_name);
1942 for (p = ref_rev_parse_rules; *p; p++) {
1943 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1944 return 1;
1948 return 0;
1951 /* This function should make sure errno is meaningful on error */
1952 static struct ref_lock *verify_lock(struct ref_lock *lock,
1953 const unsigned char *old_sha1, int mustexist)
1955 if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1956 int save_errno = errno;
1957 error("Can't verify ref %s", lock->ref_name);
1958 unlock_ref(lock);
1959 errno = save_errno;
1960 return NULL;
1962 if (hashcmp(lock->old_sha1, old_sha1)) {
1963 error("Ref %s is at %s but expected %s", lock->ref_name,
1964 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1965 unlock_ref(lock);
1966 errno = EBUSY;
1967 return NULL;
1969 return lock;
1972 static int remove_empty_directories(const char *file)
1974 /* we want to create a file but there is a directory there;
1975 * if that is an empty directory (or a directory that contains
1976 * only empty directories), remove them.
1978 struct strbuf path;
1979 int result, save_errno;
1981 strbuf_init(&path, 20);
1982 strbuf_addstr(&path, file);
1984 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1985 save_errno = errno;
1987 strbuf_release(&path);
1988 errno = save_errno;
1990 return result;
1994 * *string and *len will only be substituted, and *string returned (for
1995 * later free()ing) if the string passed in is a magic short-hand form
1996 * to name a branch.
1998 static char *substitute_branch_name(const char **string, int *len)
2000 struct strbuf buf = STRBUF_INIT;
2001 int ret = interpret_branch_name(*string, *len, &buf);
2003 if (ret == *len) {
2004 size_t size;
2005 *string = strbuf_detach(&buf, &size);
2006 *len = size;
2007 return (char *)*string;
2010 return NULL;
2013 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
2015 char *last_branch = substitute_branch_name(&str, &len);
2016 const char **p, *r;
2017 int refs_found = 0;
2019 *ref = NULL;
2020 for (p = ref_rev_parse_rules; *p; p++) {
2021 char fullref[PATH_MAX];
2022 unsigned char sha1_from_ref[20];
2023 unsigned char *this_result;
2024 int flag;
2026 this_result = refs_found ? sha1_from_ref : sha1;
2027 mksnpath(fullref, sizeof(fullref), *p, len, str);
2028 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
2029 if (r) {
2030 if (!refs_found++)
2031 *ref = xstrdup(r);
2032 if (!warn_ambiguous_refs)
2033 break;
2034 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2035 warning("ignoring dangling symref %s.", fullref);
2036 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
2037 warning("ignoring broken ref %s.", fullref);
2040 free(last_branch);
2041 return refs_found;
2044 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
2046 char *last_branch = substitute_branch_name(&str, &len);
2047 const char **p;
2048 int logs_found = 0;
2050 *log = NULL;
2051 for (p = ref_rev_parse_rules; *p; p++) {
2052 unsigned char hash[20];
2053 char path[PATH_MAX];
2054 const char *ref, *it;
2056 mksnpath(path, sizeof(path), *p, len, str);
2057 ref = resolve_ref_unsafe(path, hash, 1, NULL);
2058 if (!ref)
2059 continue;
2060 if (reflog_exists(path))
2061 it = path;
2062 else if (strcmp(ref, path) && reflog_exists(ref))
2063 it = ref;
2064 else
2065 continue;
2066 if (!logs_found++) {
2067 *log = xstrdup(it);
2068 hashcpy(sha1, hash);
2070 if (!warn_ambiguous_refs)
2071 break;
2073 free(last_branch);
2074 return logs_found;
2078 * Locks a "refs/" ref returning the lock on success and NULL on failure.
2079 * On failure errno is set to something meaningful.
2081 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
2082 const unsigned char *old_sha1,
2083 int flags, int *type_p)
2085 char *ref_file;
2086 const char *orig_refname = refname;
2087 struct ref_lock *lock;
2088 int last_errno = 0;
2089 int type, lflags;
2090 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2091 int missing = 0;
2092 int attempts_remaining = 3;
2094 lock = xcalloc(1, sizeof(struct ref_lock));
2095 lock->lock_fd = -1;
2097 refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
2098 if (!refname && errno == EISDIR) {
2099 /* we are trying to lock foo but we used to
2100 * have foo/bar which now does not exist;
2101 * it is normal for the empty directory 'foo'
2102 * to remain.
2104 ref_file = git_path("%s", orig_refname);
2105 if (remove_empty_directories(ref_file)) {
2106 last_errno = errno;
2107 error("there are still refs under '%s'", orig_refname);
2108 goto error_return;
2110 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
2112 if (type_p)
2113 *type_p = type;
2114 if (!refname) {
2115 last_errno = errno;
2116 error("unable to resolve reference %s: %s",
2117 orig_refname, strerror(errno));
2118 goto error_return;
2120 missing = is_null_sha1(lock->old_sha1);
2121 /* When the ref did not exist and we are creating it,
2122 * make sure there is no existing ref that is packed
2123 * whose name begins with our refname, nor a ref whose
2124 * name is a proper prefix of our refname.
2126 if (missing &&
2127 !is_refname_available(refname, NULL, get_packed_refs(&ref_cache))) {
2128 last_errno = ENOTDIR;
2129 goto error_return;
2132 lock->lk = xcalloc(1, sizeof(struct lock_file));
2134 lflags = 0;
2135 if (flags & REF_NODEREF) {
2136 refname = orig_refname;
2137 lflags |= LOCK_NODEREF;
2139 lock->ref_name = xstrdup(refname);
2140 lock->orig_ref_name = xstrdup(orig_refname);
2141 ref_file = git_path("%s", refname);
2142 if (missing)
2143 lock->force_write = 1;
2144 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
2145 lock->force_write = 1;
2147 retry:
2148 switch (safe_create_leading_directories(ref_file)) {
2149 case SCLD_OK:
2150 break; /* success */
2151 case SCLD_VANISHED:
2152 if (--attempts_remaining > 0)
2153 goto retry;
2154 /* fall through */
2155 default:
2156 last_errno = errno;
2157 error("unable to create directory for %s", ref_file);
2158 goto error_return;
2161 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
2162 if (lock->lock_fd < 0) {
2163 if (errno == ENOENT && --attempts_remaining > 0)
2165 * Maybe somebody just deleted one of the
2166 * directories leading to ref_file. Try
2167 * again:
2169 goto retry;
2170 else
2171 unable_to_lock_index_die(ref_file, errno);
2173 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
2175 error_return:
2176 unlock_ref(lock);
2177 errno = last_errno;
2178 return NULL;
2181 struct ref_lock *lock_any_ref_for_update(const char *refname,
2182 const unsigned char *old_sha1,
2183 int flags, int *type_p)
2185 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
2186 return NULL;
2187 return lock_ref_sha1_basic(refname, old_sha1, flags, type_p);
2191 * Write an entry to the packed-refs file for the specified refname.
2192 * If peeled is non-NULL, write it as the entry's peeled value.
2194 static void write_packed_entry(int fd, char *refname, unsigned char *sha1,
2195 unsigned char *peeled)
2197 char line[PATH_MAX + 100];
2198 int len;
2200 len = snprintf(line, sizeof(line), "%s %s\n",
2201 sha1_to_hex(sha1), refname);
2202 /* this should not happen but just being defensive */
2203 if (len > sizeof(line))
2204 die("too long a refname '%s'", refname);
2205 write_or_die(fd, line, len);
2207 if (peeled) {
2208 if (snprintf(line, sizeof(line), "^%s\n",
2209 sha1_to_hex(peeled)) != PEELED_LINE_LENGTH)
2210 die("internal error");
2211 write_or_die(fd, line, PEELED_LINE_LENGTH);
2216 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2218 static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2220 int *fd = cb_data;
2221 enum peel_status peel_status = peel_entry(entry, 0);
2223 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2224 error("internal error: %s is not a valid packed reference!",
2225 entry->name);
2226 write_packed_entry(*fd, entry->name, entry->u.value.sha1,
2227 peel_status == PEEL_PEELED ?
2228 entry->u.value.peeled : NULL);
2229 return 0;
2232 /* This should return a meaningful errno on failure */
2233 int lock_packed_refs(int flags)
2235 struct packed_ref_cache *packed_ref_cache;
2237 if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)
2238 return -1;
2240 * Get the current packed-refs while holding the lock. If the
2241 * packed-refs file has been modified since we last read it,
2242 * this will automatically invalidate the cache and re-read
2243 * the packed-refs file.
2245 packed_ref_cache = get_packed_ref_cache(&ref_cache);
2246 packed_ref_cache->lock = &packlock;
2247 /* Increment the reference count to prevent it from being freed: */
2248 acquire_packed_ref_cache(packed_ref_cache);
2249 return 0;
2253 * Commit the packed refs changes.
2254 * On error we must make sure that errno contains a meaningful value.
2256 int commit_packed_refs(void)
2258 struct packed_ref_cache *packed_ref_cache =
2259 get_packed_ref_cache(&ref_cache);
2260 int error = 0;
2261 int save_errno = 0;
2263 if (!packed_ref_cache->lock)
2264 die("internal error: packed-refs not locked");
2265 write_or_die(packed_ref_cache->lock->fd,
2266 PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
2268 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2269 0, write_packed_entry_fn,
2270 &packed_ref_cache->lock->fd);
2271 if (commit_lock_file(packed_ref_cache->lock)) {
2272 save_errno = errno;
2273 error = -1;
2275 packed_ref_cache->lock = NULL;
2276 release_packed_ref_cache(packed_ref_cache);
2277 errno = save_errno;
2278 return error;
2281 void rollback_packed_refs(void)
2283 struct packed_ref_cache *packed_ref_cache =
2284 get_packed_ref_cache(&ref_cache);
2286 if (!packed_ref_cache->lock)
2287 die("internal error: packed-refs not locked");
2288 rollback_lock_file(packed_ref_cache->lock);
2289 packed_ref_cache->lock = NULL;
2290 release_packed_ref_cache(packed_ref_cache);
2291 clear_packed_ref_cache(&ref_cache);
2294 struct ref_to_prune {
2295 struct ref_to_prune *next;
2296 unsigned char sha1[20];
2297 char name[FLEX_ARRAY];
2300 struct pack_refs_cb_data {
2301 unsigned int flags;
2302 struct ref_dir *packed_refs;
2303 struct ref_to_prune *ref_to_prune;
2307 * An each_ref_entry_fn that is run over loose references only. If
2308 * the loose reference can be packed, add an entry in the packed ref
2309 * cache. If the reference should be pruned, also add it to
2310 * ref_to_prune in the pack_refs_cb_data.
2312 static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2314 struct pack_refs_cb_data *cb = cb_data;
2315 enum peel_status peel_status;
2316 struct ref_entry *packed_entry;
2317 int is_tag_ref = starts_with(entry->name, "refs/tags/");
2319 /* ALWAYS pack tags */
2320 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2321 return 0;
2323 /* Do not pack symbolic or broken refs: */
2324 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
2325 return 0;
2327 /* Add a packed ref cache entry equivalent to the loose entry. */
2328 peel_status = peel_entry(entry, 1);
2329 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2330 die("internal error peeling reference %s (%s)",
2331 entry->name, sha1_to_hex(entry->u.value.sha1));
2332 packed_entry = find_ref(cb->packed_refs, entry->name);
2333 if (packed_entry) {
2334 /* Overwrite existing packed entry with info from loose entry */
2335 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2336 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
2337 } else {
2338 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
2339 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2340 add_ref(cb->packed_refs, packed_entry);
2342 hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
2344 /* Schedule the loose reference for pruning if requested. */
2345 if ((cb->flags & PACK_REFS_PRUNE)) {
2346 int namelen = strlen(entry->name) + 1;
2347 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2348 hashcpy(n->sha1, entry->u.value.sha1);
2349 strcpy(n->name, entry->name);
2350 n->next = cb->ref_to_prune;
2351 cb->ref_to_prune = n;
2353 return 0;
2357 * Remove empty parents, but spare refs/ and immediate subdirs.
2358 * Note: munges *name.
2360 static void try_remove_empty_parents(char *name)
2362 char *p, *q;
2363 int i;
2364 p = name;
2365 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2366 while (*p && *p != '/')
2367 p++;
2368 /* tolerate duplicate slashes; see check_refname_format() */
2369 while (*p == '/')
2370 p++;
2372 for (q = p; *q; q++)
2374 while (1) {
2375 while (q > p && *q != '/')
2376 q--;
2377 while (q > p && *(q-1) == '/')
2378 q--;
2379 if (q == p)
2380 break;
2381 *q = '\0';
2382 if (rmdir(git_path("%s", name)))
2383 break;
2387 /* make sure nobody touched the ref, and unlink */
2388 static void prune_ref(struct ref_to_prune *r)
2390 struct ref_transaction *transaction;
2391 struct strbuf err = STRBUF_INIT;
2393 if (check_refname_format(r->name + 5, 0))
2394 return;
2396 transaction = ref_transaction_begin(&err);
2397 if (!transaction ||
2398 ref_transaction_delete(transaction, r->name, r->sha1,
2399 REF_ISPRUNING, 1, &err) ||
2400 ref_transaction_commit(transaction, NULL, &err)) {
2401 ref_transaction_free(transaction);
2402 error("%s", err.buf);
2403 strbuf_release(&err);
2404 return;
2406 ref_transaction_free(transaction);
2407 strbuf_release(&err);
2408 try_remove_empty_parents(r->name);
2411 static void prune_refs(struct ref_to_prune *r)
2413 while (r) {
2414 prune_ref(r);
2415 r = r->next;
2419 int pack_refs(unsigned int flags)
2421 struct pack_refs_cb_data cbdata;
2423 memset(&cbdata, 0, sizeof(cbdata));
2424 cbdata.flags = flags;
2426 lock_packed_refs(LOCK_DIE_ON_ERROR);
2427 cbdata.packed_refs = get_packed_refs(&ref_cache);
2429 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2430 pack_if_possible_fn, &cbdata);
2432 if (commit_packed_refs())
2433 die_errno("unable to overwrite old ref-pack file");
2435 prune_refs(cbdata.ref_to_prune);
2436 return 0;
2440 * If entry is no longer needed in packed-refs, add it to the string
2441 * list pointed to by cb_data. Reasons for deleting entries:
2443 * - Entry is broken.
2444 * - Entry is overridden by a loose ref.
2445 * - Entry does not point at a valid object.
2447 * In the first and third cases, also emit an error message because these
2448 * are indications of repository corruption.
2450 static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
2452 struct string_list *refs_to_delete = cb_data;
2454 if (entry->flag & REF_ISBROKEN) {
2455 /* This shouldn't happen to packed refs. */
2456 error("%s is broken!", entry->name);
2457 string_list_append(refs_to_delete, entry->name);
2458 return 0;
2460 if (!has_sha1_file(entry->u.value.sha1)) {
2461 unsigned char sha1[20];
2462 int flags;
2464 if (read_ref_full(entry->name, sha1, 0, &flags))
2465 /* We should at least have found the packed ref. */
2466 die("Internal error");
2467 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2469 * This packed reference is overridden by a
2470 * loose reference, so it is OK that its value
2471 * is no longer valid; for example, it might
2472 * refer to an object that has been garbage
2473 * collected. For this purpose we don't even
2474 * care whether the loose reference itself is
2475 * invalid, broken, symbolic, etc. Silently
2476 * remove the packed reference.
2478 string_list_append(refs_to_delete, entry->name);
2479 return 0;
2482 * There is no overriding loose reference, so the fact
2483 * that this reference doesn't refer to a valid object
2484 * indicates some kind of repository corruption.
2485 * Report the problem, then omit the reference from
2486 * the output.
2488 error("%s does not point to a valid object!", entry->name);
2489 string_list_append(refs_to_delete, entry->name);
2490 return 0;
2493 return 0;
2496 int repack_without_refs(const char **refnames, int n, struct strbuf *err)
2498 struct ref_dir *packed;
2499 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
2500 struct string_list_item *ref_to_delete;
2501 int i, ret, removed = 0;
2503 /* Look for a packed ref */
2504 for (i = 0; i < n; i++)
2505 if (get_packed_ref(refnames[i]))
2506 break;
2508 /* Avoid locking if we have nothing to do */
2509 if (i == n)
2510 return 0; /* no refname exists in packed refs */
2512 if (lock_packed_refs(0)) {
2513 if (err) {
2514 unable_to_lock_message(git_path("packed-refs"), errno,
2515 err);
2516 return -1;
2518 unable_to_lock_error(git_path("packed-refs"), errno);
2519 return error("cannot delete '%s' from packed refs", refnames[i]);
2521 packed = get_packed_refs(&ref_cache);
2523 /* Remove refnames from the cache */
2524 for (i = 0; i < n; i++)
2525 if (remove_entry(packed, refnames[i]) != -1)
2526 removed = 1;
2527 if (!removed) {
2529 * All packed entries disappeared while we were
2530 * acquiring the lock.
2532 rollback_packed_refs();
2533 return 0;
2536 /* Remove any other accumulated cruft */
2537 do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
2538 for_each_string_list_item(ref_to_delete, &refs_to_delete) {
2539 if (remove_entry(packed, ref_to_delete->string) == -1)
2540 die("internal error");
2543 /* Write what remains */
2544 ret = commit_packed_refs();
2545 if (ret && err)
2546 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
2547 strerror(errno));
2548 return ret;
2551 static int delete_ref_loose(struct ref_lock *lock, int flag)
2553 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2554 /* loose */
2555 int err, i = strlen(lock->lk->filename) - 5; /* .lock */
2557 lock->lk->filename[i] = 0;
2558 err = unlink_or_warn(lock->lk->filename);
2559 lock->lk->filename[i] = '.';
2560 if (err && errno != ENOENT)
2561 return 1;
2563 return 0;
2566 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
2568 struct ref_transaction *transaction;
2569 struct strbuf err = STRBUF_INIT;
2571 transaction = ref_transaction_begin(&err);
2572 if (!transaction ||
2573 ref_transaction_delete(transaction, refname, sha1, delopt,
2574 sha1 && !is_null_sha1(sha1), &err) ||
2575 ref_transaction_commit(transaction, NULL, &err)) {
2576 error("%s", err.buf);
2577 ref_transaction_free(transaction);
2578 strbuf_release(&err);
2579 return 1;
2581 ref_transaction_free(transaction);
2582 strbuf_release(&err);
2583 return 0;
2587 * People using contrib's git-new-workdir have .git/logs/refs ->
2588 * /some/other/path/.git/logs/refs, and that may live on another device.
2590 * IOW, to avoid cross device rename errors, the temporary renamed log must
2591 * live into logs/refs.
2593 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2595 static int rename_tmp_log(const char *newrefname)
2597 int attempts_remaining = 4;
2599 retry:
2600 switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {
2601 case SCLD_OK:
2602 break; /* success */
2603 case SCLD_VANISHED:
2604 if (--attempts_remaining > 0)
2605 goto retry;
2606 /* fall through */
2607 default:
2608 error("unable to create directory for %s", newrefname);
2609 return -1;
2612 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2613 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2615 * rename(a, b) when b is an existing
2616 * directory ought to result in ISDIR, but
2617 * Solaris 5.8 gives ENOTDIR. Sheesh.
2619 if (remove_empty_directories(git_path("logs/%s", newrefname))) {
2620 error("Directory not empty: logs/%s", newrefname);
2621 return -1;
2623 goto retry;
2624 } else if (errno == ENOENT && --attempts_remaining > 0) {
2626 * Maybe another process just deleted one of
2627 * the directories in the path to newrefname.
2628 * Try again from the beginning.
2630 goto retry;
2631 } else {
2632 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2633 newrefname, strerror(errno));
2634 return -1;
2637 return 0;
2640 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2642 unsigned char sha1[20], orig_sha1[20];
2643 int flag = 0, logmoved = 0;
2644 struct ref_lock *lock;
2645 struct stat loginfo;
2646 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
2647 const char *symref = NULL;
2649 if (log && S_ISLNK(loginfo.st_mode))
2650 return error("reflog for %s is a symlink", oldrefname);
2652 symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
2653 if (flag & REF_ISSYMREF)
2654 return error("refname %s is a symbolic ref, renaming it is not supported",
2655 oldrefname);
2656 if (!symref)
2657 return error("refname %s not found", oldrefname);
2659 if (!is_refname_available(newrefname, oldrefname, get_packed_refs(&ref_cache)))
2660 return 1;
2662 if (!is_refname_available(newrefname, oldrefname, get_loose_refs(&ref_cache)))
2663 return 1;
2665 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2666 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2667 oldrefname, strerror(errno));
2669 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
2670 error("unable to delete old %s", oldrefname);
2671 goto rollback;
2674 if (!read_ref_full(newrefname, sha1, 1, &flag) &&
2675 delete_ref(newrefname, sha1, REF_NODEREF)) {
2676 if (errno==EISDIR) {
2677 if (remove_empty_directories(git_path("%s", newrefname))) {
2678 error("Directory not empty: %s", newrefname);
2679 goto rollback;
2681 } else {
2682 error("unable to delete existing %s", newrefname);
2683 goto rollback;
2687 if (log && rename_tmp_log(newrefname))
2688 goto rollback;
2690 logmoved = log;
2692 lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
2693 if (!lock) {
2694 error("unable to lock %s for update", newrefname);
2695 goto rollback;
2697 lock->force_write = 1;
2698 hashcpy(lock->old_sha1, orig_sha1);
2699 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2700 error("unable to write current sha1 into %s", newrefname);
2701 goto rollback;
2704 return 0;
2706 rollback:
2707 lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
2708 if (!lock) {
2709 error("unable to lock %s for rollback", oldrefname);
2710 goto rollbacklog;
2713 lock->force_write = 1;
2714 flag = log_all_ref_updates;
2715 log_all_ref_updates = 0;
2716 if (write_ref_sha1(lock, orig_sha1, NULL))
2717 error("unable to write current sha1 into %s", oldrefname);
2718 log_all_ref_updates = flag;
2720 rollbacklog:
2721 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2722 error("unable to restore logfile %s from %s: %s",
2723 oldrefname, newrefname, strerror(errno));
2724 if (!logmoved && log &&
2725 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2726 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2727 oldrefname, strerror(errno));
2729 return 1;
2732 int close_ref(struct ref_lock *lock)
2734 if (close_lock_file(lock->lk))
2735 return -1;
2736 lock->lock_fd = -1;
2737 return 0;
2740 int commit_ref(struct ref_lock *lock)
2742 if (commit_lock_file(lock->lk))
2743 return -1;
2744 lock->lock_fd = -1;
2745 return 0;
2748 void unlock_ref(struct ref_lock *lock)
2750 /* Do not free lock->lk -- atexit() still looks at them */
2751 if (lock->lk)
2752 rollback_lock_file(lock->lk);
2753 free(lock->ref_name);
2754 free(lock->orig_ref_name);
2755 free(lock);
2759 * copy the reflog message msg to buf, which has been allocated sufficiently
2760 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2761 * because reflog file is one line per entry.
2763 static int copy_msg(char *buf, const char *msg)
2765 char *cp = buf;
2766 char c;
2767 int wasspace = 1;
2769 *cp++ = '\t';
2770 while ((c = *msg++)) {
2771 if (wasspace && isspace(c))
2772 continue;
2773 wasspace = isspace(c);
2774 if (wasspace)
2775 c = ' ';
2776 *cp++ = c;
2778 while (buf < cp && isspace(cp[-1]))
2779 cp--;
2780 *cp++ = '\n';
2781 return cp - buf;
2784 /* This function must set a meaningful errno on failure */
2785 int log_ref_setup(const char *refname, char *logfile, int bufsize)
2787 int logfd, oflags = O_APPEND | O_WRONLY;
2789 git_snpath(logfile, bufsize, "logs/%s", refname);
2790 if (log_all_ref_updates &&
2791 (starts_with(refname, "refs/heads/") ||
2792 starts_with(refname, "refs/remotes/") ||
2793 starts_with(refname, "refs/notes/") ||
2794 !strcmp(refname, "HEAD"))) {
2795 if (safe_create_leading_directories(logfile) < 0) {
2796 int save_errno = errno;
2797 error("unable to create directory for %s", logfile);
2798 errno = save_errno;
2799 return -1;
2801 oflags |= O_CREAT;
2804 logfd = open(logfile, oflags, 0666);
2805 if (logfd < 0) {
2806 if (!(oflags & O_CREAT) && errno == ENOENT)
2807 return 0;
2809 if ((oflags & O_CREAT) && errno == EISDIR) {
2810 if (remove_empty_directories(logfile)) {
2811 int save_errno = errno;
2812 error("There are still logs under '%s'",
2813 logfile);
2814 errno = save_errno;
2815 return -1;
2817 logfd = open(logfile, oflags, 0666);
2820 if (logfd < 0) {
2821 int save_errno = errno;
2822 error("Unable to append to %s: %s", logfile,
2823 strerror(errno));
2824 errno = save_errno;
2825 return -1;
2829 adjust_shared_perm(logfile);
2830 close(logfd);
2831 return 0;
2834 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2835 const unsigned char *new_sha1, const char *msg)
2837 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
2838 unsigned maxlen, len;
2839 int msglen;
2840 char log_file[PATH_MAX];
2841 char *logrec;
2842 const char *committer;
2844 if (log_all_ref_updates < 0)
2845 log_all_ref_updates = !is_bare_repository();
2847 result = log_ref_setup(refname, log_file, sizeof(log_file));
2848 if (result)
2849 return result;
2851 logfd = open(log_file, oflags);
2852 if (logfd < 0)
2853 return 0;
2854 msglen = msg ? strlen(msg) : 0;
2855 committer = git_committer_info(0);
2856 maxlen = strlen(committer) + msglen + 100;
2857 logrec = xmalloc(maxlen);
2858 len = sprintf(logrec, "%s %s %s\n",
2859 sha1_to_hex(old_sha1),
2860 sha1_to_hex(new_sha1),
2861 committer);
2862 if (msglen)
2863 len += copy_msg(logrec + len - 1, msg) - 1;
2864 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2865 free(logrec);
2866 if (written != len) {
2867 int save_errno = errno;
2868 close(logfd);
2869 error("Unable to append to %s", log_file);
2870 errno = save_errno;
2871 return -1;
2873 if (close(logfd)) {
2874 int save_errno = errno;
2875 error("Unable to append to %s", log_file);
2876 errno = save_errno;
2877 return -1;
2879 return 0;
2882 static int is_branch(const char *refname)
2884 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
2887 /* This function must return a meaningful errno */
2888 int write_ref_sha1(struct ref_lock *lock,
2889 const unsigned char *sha1, const char *logmsg)
2891 static char term = '\n';
2892 struct object *o;
2894 if (!lock) {
2895 errno = EINVAL;
2896 return -1;
2898 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2899 unlock_ref(lock);
2900 return 0;
2902 o = parse_object(sha1);
2903 if (!o) {
2904 error("Trying to write ref %s with nonexistent object %s",
2905 lock->ref_name, sha1_to_hex(sha1));
2906 unlock_ref(lock);
2907 errno = EINVAL;
2908 return -1;
2910 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2911 error("Trying to write non-commit object %s to branch %s",
2912 sha1_to_hex(sha1), lock->ref_name);
2913 unlock_ref(lock);
2914 errno = EINVAL;
2915 return -1;
2917 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2918 write_in_full(lock->lock_fd, &term, 1) != 1 ||
2919 close_ref(lock) < 0) {
2920 int save_errno = errno;
2921 error("Couldn't write %s", lock->lk->filename);
2922 unlock_ref(lock);
2923 errno = save_errno;
2924 return -1;
2926 clear_loose_ref_cache(&ref_cache);
2927 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2928 (strcmp(lock->ref_name, lock->orig_ref_name) &&
2929 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2930 unlock_ref(lock);
2931 return -1;
2933 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2935 * Special hack: If a branch is updated directly and HEAD
2936 * points to it (may happen on the remote side of a push
2937 * for example) then logically the HEAD reflog should be
2938 * updated too.
2939 * A generic solution implies reverse symref information,
2940 * but finding all symrefs pointing to the given branch
2941 * would be rather costly for this rare event (the direct
2942 * update of a branch) to be worth it. So let's cheat and
2943 * check with HEAD only which should cover 99% of all usage
2944 * scenarios (even 100% of the default ones).
2946 unsigned char head_sha1[20];
2947 int head_flag;
2948 const char *head_ref;
2949 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2950 if (head_ref && (head_flag & REF_ISSYMREF) &&
2951 !strcmp(head_ref, lock->ref_name))
2952 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2954 if (commit_ref(lock)) {
2955 error("Couldn't set %s", lock->ref_name);
2956 unlock_ref(lock);
2957 return -1;
2959 unlock_ref(lock);
2960 return 0;
2963 int create_symref(const char *ref_target, const char *refs_heads_master,
2964 const char *logmsg)
2966 const char *lockpath;
2967 char ref[1000];
2968 int fd, len, written;
2969 char *git_HEAD = git_pathdup("%s", ref_target);
2970 unsigned char old_sha1[20], new_sha1[20];
2972 if (logmsg && read_ref(ref_target, old_sha1))
2973 hashclr(old_sha1);
2975 if (safe_create_leading_directories(git_HEAD) < 0)
2976 return error("unable to create directory for %s", git_HEAD);
2978 #ifndef NO_SYMLINK_HEAD
2979 if (prefer_symlink_refs) {
2980 unlink(git_HEAD);
2981 if (!symlink(refs_heads_master, git_HEAD))
2982 goto done;
2983 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2985 #endif
2987 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2988 if (sizeof(ref) <= len) {
2989 error("refname too long: %s", refs_heads_master);
2990 goto error_free_return;
2992 lockpath = mkpath("%s.lock", git_HEAD);
2993 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2994 if (fd < 0) {
2995 error("Unable to open %s for writing", lockpath);
2996 goto error_free_return;
2998 written = write_in_full(fd, ref, len);
2999 if (close(fd) != 0 || written != len) {
3000 error("Unable to write to %s", lockpath);
3001 goto error_unlink_return;
3003 if (rename(lockpath, git_HEAD) < 0) {
3004 error("Unable to create %s", git_HEAD);
3005 goto error_unlink_return;
3007 if (adjust_shared_perm(git_HEAD)) {
3008 error("Unable to fix permissions on %s", lockpath);
3009 error_unlink_return:
3010 unlink_or_warn(lockpath);
3011 error_free_return:
3012 free(git_HEAD);
3013 return -1;
3016 #ifndef NO_SYMLINK_HEAD
3017 done:
3018 #endif
3019 if (logmsg && !read_ref(refs_heads_master, new_sha1))
3020 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
3022 free(git_HEAD);
3023 return 0;
3026 struct read_ref_at_cb {
3027 const char *refname;
3028 unsigned long at_time;
3029 int cnt;
3030 int reccnt;
3031 unsigned char *sha1;
3032 int found_it;
3034 unsigned char osha1[20];
3035 unsigned char nsha1[20];
3036 int tz;
3037 unsigned long date;
3038 char **msg;
3039 unsigned long *cutoff_time;
3040 int *cutoff_tz;
3041 int *cutoff_cnt;
3044 static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,
3045 const char *email, unsigned long timestamp, int tz,
3046 const char *message, void *cb_data)
3048 struct read_ref_at_cb *cb = cb_data;
3050 cb->reccnt++;
3051 cb->tz = tz;
3052 cb->date = timestamp;
3054 if (timestamp <= cb->at_time || cb->cnt == 0) {
3055 if (cb->msg)
3056 *cb->msg = xstrdup(message);
3057 if (cb->cutoff_time)
3058 *cb->cutoff_time = timestamp;
3059 if (cb->cutoff_tz)
3060 *cb->cutoff_tz = tz;
3061 if (cb->cutoff_cnt)
3062 *cb->cutoff_cnt = cb->reccnt - 1;
3064 * we have not yet updated cb->[n|o]sha1 so they still
3065 * hold the values for the previous record.
3067 if (!is_null_sha1(cb->osha1)) {
3068 hashcpy(cb->sha1, nsha1);
3069 if (hashcmp(cb->osha1, nsha1))
3070 warning("Log for ref %s has gap after %s.",
3071 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));
3073 else if (cb->date == cb->at_time)
3074 hashcpy(cb->sha1, nsha1);
3075 else if (hashcmp(nsha1, cb->sha1))
3076 warning("Log for ref %s unexpectedly ended on %s.",
3077 cb->refname, show_date(cb->date, cb->tz,
3078 DATE_RFC2822));
3079 hashcpy(cb->osha1, osha1);
3080 hashcpy(cb->nsha1, nsha1);
3081 cb->found_it = 1;
3082 return 1;
3084 hashcpy(cb->osha1, osha1);
3085 hashcpy(cb->nsha1, nsha1);
3086 if (cb->cnt > 0)
3087 cb->cnt--;
3088 return 0;
3091 static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,
3092 const char *email, unsigned long timestamp,
3093 int tz, const char *message, void *cb_data)
3095 struct read_ref_at_cb *cb = cb_data;
3097 if (cb->msg)
3098 *cb->msg = xstrdup(message);
3099 if (cb->cutoff_time)
3100 *cb->cutoff_time = timestamp;
3101 if (cb->cutoff_tz)
3102 *cb->cutoff_tz = tz;
3103 if (cb->cutoff_cnt)
3104 *cb->cutoff_cnt = cb->reccnt;
3105 hashcpy(cb->sha1, osha1);
3106 if (is_null_sha1(cb->sha1))
3107 hashcpy(cb->sha1, nsha1);
3108 /* We just want the first entry */
3109 return 1;
3112 int read_ref_at(const char *refname, unsigned long at_time, int cnt,
3113 unsigned char *sha1, char **msg,
3114 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3116 struct read_ref_at_cb cb;
3118 memset(&cb, 0, sizeof(cb));
3119 cb.refname = refname;
3120 cb.at_time = at_time;
3121 cb.cnt = cnt;
3122 cb.msg = msg;
3123 cb.cutoff_time = cutoff_time;
3124 cb.cutoff_tz = cutoff_tz;
3125 cb.cutoff_cnt = cutoff_cnt;
3126 cb.sha1 = sha1;
3128 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
3130 if (!cb.reccnt)
3131 die("Log for %s is empty.", refname);
3132 if (cb.found_it)
3133 return 0;
3135 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3137 return 1;
3140 int reflog_exists(const char *refname)
3142 struct stat st;
3144 return !lstat(git_path("logs/%s", refname), &st) &&
3145 S_ISREG(st.st_mode);
3148 int delete_reflog(const char *refname)
3150 return remove_path(git_path("logs/%s", refname));
3153 static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
3155 unsigned char osha1[20], nsha1[20];
3156 char *email_end, *message;
3157 unsigned long timestamp;
3158 int tz;
3160 /* old SP new SP name <email> SP time TAB msg LF */
3161 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
3162 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
3163 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
3164 !(email_end = strchr(sb->buf + 82, '>')) ||
3165 email_end[1] != ' ' ||
3166 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
3167 !message || message[0] != ' ' ||
3168 (message[1] != '+' && message[1] != '-') ||
3169 !isdigit(message[2]) || !isdigit(message[3]) ||
3170 !isdigit(message[4]) || !isdigit(message[5]))
3171 return 0; /* corrupt? */
3172 email_end[1] = '\0';
3173 tz = strtol(message + 1, NULL, 10);
3174 if (message[6] != '\t')
3175 message += 6;
3176 else
3177 message += 7;
3178 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
3181 static char *find_beginning_of_line(char *bob, char *scan)
3183 while (bob < scan && *(--scan) != '\n')
3184 ; /* keep scanning backwards */
3186 * Return either beginning of the buffer, or LF at the end of
3187 * the previous line.
3189 return scan;
3192 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3194 struct strbuf sb = STRBUF_INIT;
3195 FILE *logfp;
3196 long pos;
3197 int ret = 0, at_tail = 1;
3199 logfp = fopen(git_path("logs/%s", refname), "r");
3200 if (!logfp)
3201 return -1;
3203 /* Jump to the end */
3204 if (fseek(logfp, 0, SEEK_END) < 0)
3205 return error("cannot seek back reflog for %s: %s",
3206 refname, strerror(errno));
3207 pos = ftell(logfp);
3208 while (!ret && 0 < pos) {
3209 int cnt;
3210 size_t nread;
3211 char buf[BUFSIZ];
3212 char *endp, *scanp;
3214 /* Fill next block from the end */
3215 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
3216 if (fseek(logfp, pos - cnt, SEEK_SET))
3217 return error("cannot seek back reflog for %s: %s",
3218 refname, strerror(errno));
3219 nread = fread(buf, cnt, 1, logfp);
3220 if (nread != 1)
3221 return error("cannot read %d bytes from reflog for %s: %s",
3222 cnt, refname, strerror(errno));
3223 pos -= cnt;
3225 scanp = endp = buf + cnt;
3226 if (at_tail && scanp[-1] == '\n')
3227 /* Looking at the final LF at the end of the file */
3228 scanp--;
3229 at_tail = 0;
3231 while (buf < scanp) {
3233 * terminating LF of the previous line, or the beginning
3234 * of the buffer.
3236 char *bp;
3238 bp = find_beginning_of_line(buf, scanp);
3240 if (*bp != '\n') {
3241 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3242 if (pos)
3243 break; /* need to fill another block */
3244 scanp = buf - 1; /* leave loop */
3245 } else {
3247 * (bp + 1) thru endp is the beginning of the
3248 * current line we have in sb
3250 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
3251 scanp = bp;
3252 endp = bp + 1;
3254 ret = show_one_reflog_ent(&sb, fn, cb_data);
3255 strbuf_reset(&sb);
3256 if (ret)
3257 break;
3261 if (!ret && sb.len)
3262 ret = show_one_reflog_ent(&sb, fn, cb_data);
3264 fclose(logfp);
3265 strbuf_release(&sb);
3266 return ret;
3269 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3271 FILE *logfp;
3272 struct strbuf sb = STRBUF_INIT;
3273 int ret = 0;
3275 logfp = fopen(git_path("logs/%s", refname), "r");
3276 if (!logfp)
3277 return -1;
3279 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
3280 ret = show_one_reflog_ent(&sb, fn, cb_data);
3281 fclose(logfp);
3282 strbuf_release(&sb);
3283 return ret;
3286 * Call fn for each reflog in the namespace indicated by name. name
3287 * must be empty or end with '/'. Name will be used as a scratch
3288 * space, but its contents will be restored before return.
3290 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
3292 DIR *d = opendir(git_path("logs/%s", name->buf));
3293 int retval = 0;
3294 struct dirent *de;
3295 int oldlen = name->len;
3297 if (!d)
3298 return name->len ? errno : 0;
3300 while ((de = readdir(d)) != NULL) {
3301 struct stat st;
3303 if (de->d_name[0] == '.')
3304 continue;
3305 if (has_extension(de->d_name, ".lock"))
3306 continue;
3307 strbuf_addstr(name, de->d_name);
3308 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
3309 ; /* silently ignore */
3310 } else {
3311 if (S_ISDIR(st.st_mode)) {
3312 strbuf_addch(name, '/');
3313 retval = do_for_each_reflog(name, fn, cb_data);
3314 } else {
3315 unsigned char sha1[20];
3316 if (read_ref_full(name->buf, sha1, 0, NULL))
3317 retval = error("bad ref for %s", name->buf);
3318 else
3319 retval = fn(name->buf, sha1, 0, cb_data);
3321 if (retval)
3322 break;
3324 strbuf_setlen(name, oldlen);
3326 closedir(d);
3327 return retval;
3330 int for_each_reflog(each_ref_fn fn, void *cb_data)
3332 int retval;
3333 struct strbuf name;
3334 strbuf_init(&name, PATH_MAX);
3335 retval = do_for_each_reflog(&name, fn, cb_data);
3336 strbuf_release(&name);
3337 return retval;
3341 * Information needed for a single ref update. Set new_sha1 to the
3342 * new value or to zero to delete the ref. To check the old value
3343 * while locking the ref, set have_old to 1 and set old_sha1 to the
3344 * value or to zero to ensure the ref does not exist before update.
3346 struct ref_update {
3347 unsigned char new_sha1[20];
3348 unsigned char old_sha1[20];
3349 int flags; /* REF_NODEREF? */
3350 int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
3351 struct ref_lock *lock;
3352 int type;
3353 const char refname[FLEX_ARRAY];
3357 * Transaction states.
3358 * OPEN: The transaction is in a valid state and can accept new updates.
3359 * An OPEN transaction can be committed.
3360 * CLOSED: A closed transaction is no longer active and no other operations
3361 * than free can be used on it in this state.
3362 * A transaction can either become closed by successfully committing
3363 * an active transaction or if there is a failure while building
3364 * the transaction thus rendering it failed/inactive.
3366 enum ref_transaction_state {
3367 REF_TRANSACTION_OPEN = 0,
3368 REF_TRANSACTION_CLOSED = 1
3372 * Data structure for holding a reference transaction, which can
3373 * consist of checks and updates to multiple references, carried out
3374 * as atomically as possible. This structure is opaque to callers.
3376 struct ref_transaction {
3377 struct ref_update **updates;
3378 size_t alloc;
3379 size_t nr;
3380 enum ref_transaction_state state;
3383 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3385 return xcalloc(1, sizeof(struct ref_transaction));
3388 void ref_transaction_free(struct ref_transaction *transaction)
3390 int i;
3392 if (!transaction)
3393 return;
3395 for (i = 0; i < transaction->nr; i++)
3396 free(transaction->updates[i]);
3398 free(transaction->updates);
3399 free(transaction);
3402 static struct ref_update *add_update(struct ref_transaction *transaction,
3403 const char *refname)
3405 size_t len = strlen(refname);
3406 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);
3408 strcpy((char *)update->refname, refname);
3409 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
3410 transaction->updates[transaction->nr++] = update;
3411 return update;
3414 int ref_transaction_update(struct ref_transaction *transaction,
3415 const char *refname,
3416 const unsigned char *new_sha1,
3417 const unsigned char *old_sha1,
3418 int flags, int have_old,
3419 struct strbuf *err)
3421 struct ref_update *update;
3423 if (transaction->state != REF_TRANSACTION_OPEN)
3424 die("BUG: update called for transaction that is not open");
3426 if (have_old && !old_sha1)
3427 die("BUG: have_old is true but old_sha1 is NULL");
3429 update = add_update(transaction, refname);
3430 hashcpy(update->new_sha1, new_sha1);
3431 update->flags = flags;
3432 update->have_old = have_old;
3433 if (have_old)
3434 hashcpy(update->old_sha1, old_sha1);
3435 return 0;
3438 int ref_transaction_create(struct ref_transaction *transaction,
3439 const char *refname,
3440 const unsigned char *new_sha1,
3441 int flags,
3442 struct strbuf *err)
3444 struct ref_update *update;
3446 if (transaction->state != REF_TRANSACTION_OPEN)
3447 die("BUG: create called for transaction that is not open");
3449 if (!new_sha1 || is_null_sha1(new_sha1))
3450 die("BUG: create ref with null new_sha1");
3452 update = add_update(transaction, refname);
3454 hashcpy(update->new_sha1, new_sha1);
3455 hashclr(update->old_sha1);
3456 update->flags = flags;
3457 update->have_old = 1;
3458 return 0;
3461 int ref_transaction_delete(struct ref_transaction *transaction,
3462 const char *refname,
3463 const unsigned char *old_sha1,
3464 int flags, int have_old,
3465 struct strbuf *err)
3467 struct ref_update *update;
3469 if (transaction->state != REF_TRANSACTION_OPEN)
3470 die("BUG: delete called for transaction that is not open");
3472 if (have_old && !old_sha1)
3473 die("BUG: have_old is true but old_sha1 is NULL");
3475 update = add_update(transaction, refname);
3476 update->flags = flags;
3477 update->have_old = have_old;
3478 if (have_old) {
3479 assert(!is_null_sha1(old_sha1));
3480 hashcpy(update->old_sha1, old_sha1);
3482 return 0;
3485 int update_ref(const char *action, const char *refname,
3486 const unsigned char *sha1, const unsigned char *oldval,
3487 int flags, enum action_on_err onerr)
3489 struct ref_transaction *t;
3490 struct strbuf err = STRBUF_INIT;
3492 t = ref_transaction_begin(&err);
3493 if (!t ||
3494 ref_transaction_update(t, refname, sha1, oldval, flags,
3495 !!oldval, &err) ||
3496 ref_transaction_commit(t, action, &err)) {
3497 const char *str = "update_ref failed for ref '%s': %s";
3499 ref_transaction_free(t);
3500 switch (onerr) {
3501 case UPDATE_REFS_MSG_ON_ERR:
3502 error(str, refname, err.buf);
3503 break;
3504 case UPDATE_REFS_DIE_ON_ERR:
3505 die(str, refname, err.buf);
3506 break;
3507 case UPDATE_REFS_QUIET_ON_ERR:
3508 break;
3510 strbuf_release(&err);
3511 return 1;
3513 strbuf_release(&err);
3514 ref_transaction_free(t);
3515 return 0;
3518 static int ref_update_compare(const void *r1, const void *r2)
3520 const struct ref_update * const *u1 = r1;
3521 const struct ref_update * const *u2 = r2;
3522 return strcmp((*u1)->refname, (*u2)->refname);
3525 static int ref_update_reject_duplicates(struct ref_update **updates, int n,
3526 struct strbuf *err)
3528 int i;
3529 for (i = 1; i < n; i++)
3530 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {
3531 const char *str =
3532 "Multiple updates for ref '%s' not allowed.";
3533 if (err)
3534 strbuf_addf(err, str, updates[i]->refname);
3536 return 1;
3538 return 0;
3541 int ref_transaction_commit(struct ref_transaction *transaction,
3542 const char *msg, struct strbuf *err)
3544 int ret = 0, delnum = 0, i;
3545 const char **delnames;
3546 int n = transaction->nr;
3547 struct ref_update **updates = transaction->updates;
3549 if (transaction->state != REF_TRANSACTION_OPEN)
3550 die("BUG: commit called for transaction that is not open");
3552 if (!n) {
3553 transaction->state = REF_TRANSACTION_CLOSED;
3554 return 0;
3557 /* Allocate work space */
3558 delnames = xmalloc(sizeof(*delnames) * n);
3560 /* Copy, sort, and reject duplicate refs */
3561 qsort(updates, n, sizeof(*updates), ref_update_compare);
3562 ret = ref_update_reject_duplicates(updates, n, err);
3563 if (ret)
3564 goto cleanup;
3566 /* Acquire all locks while verifying old values */
3567 for (i = 0; i < n; i++) {
3568 struct ref_update *update = updates[i];
3570 update->lock = lock_any_ref_for_update(update->refname,
3571 (update->have_old ?
3572 update->old_sha1 :
3573 NULL),
3574 update->flags,
3575 &update->type);
3576 if (!update->lock) {
3577 if (err)
3578 strbuf_addf(err, "Cannot lock the ref '%s'.",
3579 update->refname);
3580 ret = 1;
3581 goto cleanup;
3585 /* Perform updates first so live commits remain referenced */
3586 for (i = 0; i < n; i++) {
3587 struct ref_update *update = updates[i];
3589 if (!is_null_sha1(update->new_sha1)) {
3590 ret = write_ref_sha1(update->lock, update->new_sha1,
3591 msg);
3592 update->lock = NULL; /* freed by write_ref_sha1 */
3593 if (ret) {
3594 if (err)
3595 strbuf_addf(err, "Cannot update the ref '%s'.",
3596 update->refname);
3597 goto cleanup;
3602 /* Perform deletes now that updates are safely completed */
3603 for (i = 0; i < n; i++) {
3604 struct ref_update *update = updates[i];
3606 if (update->lock) {
3607 ret |= delete_ref_loose(update->lock, update->type);
3608 if (!(update->flags & REF_ISPRUNING))
3609 delnames[delnum++] = update->lock->ref_name;
3613 ret |= repack_without_refs(delnames, delnum, err);
3614 for (i = 0; i < delnum; i++)
3615 unlink_or_warn(git_path("logs/%s", delnames[i]));
3616 clear_loose_ref_cache(&ref_cache);
3618 cleanup:
3619 transaction->state = REF_TRANSACTION_CLOSED;
3621 for (i = 0; i < n; i++)
3622 if (updates[i]->lock)
3623 unlock_ref(updates[i]->lock);
3624 free(delnames);
3625 return ret;
3628 char *shorten_unambiguous_ref(const char *refname, int strict)
3630 int i;
3631 static char **scanf_fmts;
3632 static int nr_rules;
3633 char *short_name;
3635 if (!nr_rules) {
3637 * Pre-generate scanf formats from ref_rev_parse_rules[].
3638 * Generate a format suitable for scanf from a
3639 * ref_rev_parse_rules rule by interpolating "%s" at the
3640 * location of the "%.*s".
3642 size_t total_len = 0;
3643 size_t offset = 0;
3645 /* the rule list is NULL terminated, count them first */
3646 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
3647 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3648 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
3650 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
3652 offset = 0;
3653 for (i = 0; i < nr_rules; i++) {
3654 assert(offset < total_len);
3655 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
3656 offset += snprintf(scanf_fmts[i], total_len - offset,
3657 ref_rev_parse_rules[i], 2, "%s") + 1;
3661 /* bail out if there are no rules */
3662 if (!nr_rules)
3663 return xstrdup(refname);
3665 /* buffer for scanf result, at most refname must fit */
3666 short_name = xstrdup(refname);
3668 /* skip first rule, it will always match */
3669 for (i = nr_rules - 1; i > 0 ; --i) {
3670 int j;
3671 int rules_to_fail = i;
3672 int short_name_len;
3674 if (1 != sscanf(refname, scanf_fmts[i], short_name))
3675 continue;
3677 short_name_len = strlen(short_name);
3680 * in strict mode, all (except the matched one) rules
3681 * must fail to resolve to a valid non-ambiguous ref
3683 if (strict)
3684 rules_to_fail = nr_rules;
3687 * check if the short name resolves to a valid ref,
3688 * but use only rules prior to the matched one
3690 for (j = 0; j < rules_to_fail; j++) {
3691 const char *rule = ref_rev_parse_rules[j];
3692 char refname[PATH_MAX];
3694 /* skip matched rule */
3695 if (i == j)
3696 continue;
3699 * the short name is ambiguous, if it resolves
3700 * (with this previous rule) to a valid ref
3701 * read_ref() returns 0 on success
3703 mksnpath(refname, sizeof(refname),
3704 rule, short_name_len, short_name);
3705 if (ref_exists(refname))
3706 break;
3710 * short name is non-ambiguous if all previous rules
3711 * haven't resolved to a valid ref
3713 if (j == rules_to_fail)
3714 return short_name;
3717 free(short_name);
3718 return xstrdup(refname);
3721 static struct string_list *hide_refs;
3723 int parse_hide_refs_config(const char *var, const char *value, const char *section)
3725 if (!strcmp("transfer.hiderefs", var) ||
3726 /* NEEDSWORK: use parse_config_key() once both are merged */
3727 (starts_with(var, section) && var[strlen(section)] == '.' &&
3728 !strcmp(var + strlen(section), ".hiderefs"))) {
3729 char *ref;
3730 int len;
3732 if (!value)
3733 return config_error_nonbool(var);
3734 ref = xstrdup(value);
3735 len = strlen(ref);
3736 while (len && ref[len - 1] == '/')
3737 ref[--len] = '\0';
3738 if (!hide_refs) {
3739 hide_refs = xcalloc(1, sizeof(*hide_refs));
3740 hide_refs->strdup_strings = 1;
3742 string_list_append(hide_refs, ref);
3744 return 0;
3747 int ref_is_hidden(const char *refname)
3749 struct string_list_item *item;
3751 if (!hide_refs)
3752 return 0;
3753 for_each_string_list_item(item, hide_refs) {
3754 int len;
3755 if (!starts_with(refname, item->string))
3756 continue;
3757 len = strlen(item->string);
3758 if (!refname[len] || refname[len] == '/')
3759 return 1;
3761 return 0;