8 * Make sure "ref" is something reasonable to have under ".git/refs/";
9 * We do not like it if:
11 * - any path component of it begins with ".", or
12 * - it has double dots "..", or
13 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
14 * - it ends with a "/".
15 * - it ends with ".lock"
16 * - it contains a "\" (backslash)
19 /* Return true iff ch is not allowed in reference names. */
20 static inline int bad_ref_char(int ch)
22 if (((unsigned) ch) <= ' ' || ch == 0x7f ||
23 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
25 /* 2.13 Pattern Matching Notation */
26 if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
32 * Try to read one refname component from the front of refname. Return
33 * the length of the component found, or -1 if the component is not
36 static int check_refname_component(const char *refname, int flags)
41 for (cp = refname; ; cp++) {
43 if (ch == '\0' || ch == '/')
46 return -1; /* Illegal character in refname. */
47 if (last == '.' && ch == '.')
48 return -1; /* Refname contains "..". */
49 if (last == '@' && ch == '{')
50 return -1; /* Refname contains "@{". */
54 return 0; /* Component has zero length. */
55 if (refname[0] == '.') {
56 if (!(flags & REFNAME_DOT_COMPONENT))
57 return -1; /* Component starts with '.'. */
59 * Even if leading dots are allowed, don't allow "."
60 * as a component (".." is prevented by a rule above).
62 if (refname[1] == '\0')
63 return -1; /* Component equals ".". */
65 if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
66 return -1; /* Refname ends with ".lock". */
70 int check_refname_format(const char *refname, int flags)
72 int component_len, component_count = 0;
75 /* We are at the start of a path component. */
76 component_len = check_refname_component(refname, flags);
77 if (component_len <= 0) {
78 if ((flags & REFNAME_REFSPEC_PATTERN) &&
80 (refname[1] == '\0' || refname[1] == '/')) {
81 /* Accept one wildcard as a full refname component. */
82 flags &= ~REFNAME_REFSPEC_PATTERN;
89 if (refname[component_len] == '\0')
91 /* Skip to next component. */
92 refname += component_len + 1;
95 if (refname[component_len - 1] == '.')
96 return -1; /* Refname ends with '.'. */
97 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
98 return -1; /* Refname has only one component. */
105 * Information used (along with the information in ref_entry) to
106 * describe a single cached reference. This data structure only
107 * occurs embedded in a union in struct ref_entry, and only when
108 * (ref_entry->flag & REF_DIR) is zero.
111 unsigned char sha1[20];
112 unsigned char peeled[20];
118 * Information used (along with the information in ref_entry) to
119 * describe a level in the hierarchy of references. This data
120 * structure only occurs embedded in a union in struct ref_entry, and
121 * only when (ref_entry.flag & REF_DIR) is set. In that case,
122 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
123 * in the directory have already been read:
125 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
126 * or packed references, already read.
128 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
129 * references that hasn't been read yet (nor has any of its
132 * Entries within a directory are stored within a growable array of
133 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
134 * sorted are sorted by their component name in strcmp() order and the
135 * remaining entries are unsorted.
137 * Loose references are read lazily, one directory at a time. When a
138 * directory of loose references is read, then all of the references
139 * in that directory are stored, and REF_INCOMPLETE stubs are created
140 * for any subdirectories, but the subdirectories themselves are not
141 * read. The reading is triggered by get_ref_dir().
147 * Entries with index 0 <= i < sorted are sorted by name. New
148 * entries are appended to the list unsorted, and are sorted
149 * only when required; thus we avoid the need to sort the list
150 * after the addition of every reference.
154 /* A pointer to the ref_cache that contains this ref_dir. */
155 struct ref_cache *ref_cache;
157 struct ref_entry **entries;
160 /* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
161 #define REF_KNOWS_PEELED 0x08
163 /* ref_entry represents a directory of references */
167 * Entry has not yet been read from disk (used only for REF_DIR
168 * entries representing loose references)
170 #define REF_INCOMPLETE 0x20
173 * A ref_entry represents either a reference or a "subdirectory" of
176 * Each directory in the reference namespace is represented by a
177 * ref_entry with (flags & REF_DIR) set and containing a subdir member
178 * that holds the entries in that directory that have been read so
179 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
180 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
181 * used for loose reference directories.
183 * References are represented by a ref_entry with (flags & REF_DIR)
184 * unset and a value member that describes the reference's value. The
185 * flag member is at the ref_entry level, but it is also needed to
186 * interpret the contents of the value field (in other words, a
187 * ref_value object is not very much use without the enclosing
190 * Reference names cannot end with slash and directories' names are
191 * always stored with a trailing slash (except for the top-level
192 * directory, which is always denoted by ""). This has two nice
193 * consequences: (1) when the entries in each subdir are sorted
194 * lexicographically by name (as they usually are), the references in
195 * a whole tree can be generated in lexicographic order by traversing
196 * the tree in left-to-right, depth-first order; (2) the names of
197 * references and subdirectories cannot conflict, and therefore the
198 * presence of an empty subdirectory does not block the creation of a
199 * similarly-named reference. (The fact that reference names with the
200 * same leading components can conflict *with each other* is a
201 * separate issue that is regulated by is_refname_available().)
203 * Please note that the name field contains the fully-qualified
204 * reference (or subdirectory) name. Space could be saved by only
205 * storing the relative names. But that would require the full names
206 * to be generated on the fly when iterating in do_for_each_ref(), and
207 * would break callback functions, who have always been able to assume
208 * that the name strings that they are passed will not be freed during
212 unsigned char flag; /* ISSYMREF? ISPACKED? */
214 struct ref_value value; /* if not (flags&REF_DIR) */
215 struct ref_dir subdir; /* if (flags&REF_DIR) */
218 * The full name of the reference (e.g., "refs/heads/master")
219 * or the full name of the directory with a trailing slash
220 * (e.g., "refs/heads/"):
222 char name[FLEX_ARRAY];
225 static void read_loose_refs(const char *dirname, struct ref_dir *dir);
227 static struct ref_dir *get_ref_dir(struct ref_entry *entry)
230 assert(entry->flag & REF_DIR);
231 dir = &entry->u.subdir;
232 if (entry->flag & REF_INCOMPLETE) {
233 read_loose_refs(entry->name, dir);
234 entry->flag &= ~REF_INCOMPLETE;
239 static struct ref_entry *create_ref_entry(const char *refname,
240 const unsigned char *sha1, int flag,
244 struct ref_entry *ref;
247 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
248 die("Reference has invalid format: '%s'", refname);
249 len = strlen(refname) + 1;
250 ref = xmalloc(sizeof(struct ref_entry) + len);
251 hashcpy(ref->u.value.sha1, sha1);
252 hashclr(ref->u.value.peeled);
253 memcpy(ref->name, refname, len);
258 static void clear_ref_dir(struct ref_dir *dir);
260 static void free_ref_entry(struct ref_entry *entry)
262 if (entry->flag & REF_DIR) {
264 * Do not use get_ref_dir() here, as that might
265 * trigger the reading of loose refs.
267 clear_ref_dir(&entry->u.subdir);
273 * Add a ref_entry to the end of dir (unsorted). Entry is always
274 * stored directly in dir; no recursion into subdirectories is
277 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
279 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
280 dir->entries[dir->nr++] = entry;
281 /* optimize for the case that entries are added in order */
283 (dir->nr == dir->sorted + 1 &&
284 strcmp(dir->entries[dir->nr - 2]->name,
285 dir->entries[dir->nr - 1]->name) < 0))
286 dir->sorted = dir->nr;
290 * Clear and free all entries in dir, recursively.
292 static void clear_ref_dir(struct ref_dir *dir)
295 for (i = 0; i < dir->nr; i++)
296 free_ref_entry(dir->entries[i]);
298 dir->sorted = dir->nr = dir->alloc = 0;
303 * Create a struct ref_entry object for the specified dirname.
304 * dirname is the name of the directory with a trailing slash (e.g.,
305 * "refs/heads/") or "" for the top-level directory.
307 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
308 const char *dirname, int incomplete)
310 struct ref_entry *direntry;
311 int len = strlen(dirname);
312 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
313 memcpy(direntry->name, dirname, len + 1);
314 direntry->u.subdir.ref_cache = ref_cache;
315 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
319 static int ref_entry_cmp(const void *a, const void *b)
321 struct ref_entry *one = *(struct ref_entry **)a;
322 struct ref_entry *two = *(struct ref_entry **)b;
323 return strcmp(one->name, two->name);
326 static void sort_ref_dir(struct ref_dir *dir);
329 * Return the entry with the given refname from the ref_dir
330 * (non-recursively), sorting dir if necessary. Return NULL if no
331 * such entry is found. dir must already be complete.
333 static struct ref_entry *search_ref_dir(struct ref_dir *dir, const char *refname)
335 struct ref_entry *e, **r;
338 if (refname == NULL || !dir->nr)
343 len = strlen(refname) + 1;
344 e = xmalloc(sizeof(struct ref_entry) + len);
345 memcpy(e->name, refname, len);
347 r = bsearch(&e, dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
358 * Search for a directory entry directly within dir (without
359 * recursing). Sort dir if necessary. subdirname must be a directory
360 * name (i.e., end in '/'). If mkdir is set, then create the
361 * directory if it is missing; otherwise, return NULL if the desired
362 * directory cannot be found. dir must already be complete.
364 static struct ref_dir *search_for_subdir(struct ref_dir *dir,
365 const char *subdirname, int mkdir)
367 struct ref_entry *entry = search_ref_dir(dir, subdirname);
372 * Since dir is complete, the absence of a subdir
373 * means that the subdir really doesn't exist;
374 * therefore, create an empty record for it but mark
375 * the record complete.
377 entry = create_dir_entry(dir->ref_cache, subdirname, 0);
378 add_entry_to_dir(dir, entry);
380 return get_ref_dir(entry);
384 * If refname is a reference name, find the ref_dir within the dir
385 * tree that should hold refname. If refname is a directory name
386 * (i.e., ends in '/'), then return that ref_dir itself. dir must
387 * represent the top-level directory and must already be complete.
388 * Sort ref_dirs and recurse into subdirectories as necessary. If
389 * mkdir is set, then create any missing directories; otherwise,
390 * return NULL if the desired directory cannot be found.
392 static struct ref_dir *find_containing_dir(struct ref_dir *dir,
393 const char *refname, int mkdir)
395 struct strbuf dirname;
397 strbuf_init(&dirname, PATH_MAX);
398 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
399 struct ref_dir *subdir;
401 refname + dirname.len,
402 (slash + 1) - (refname + dirname.len));
403 subdir = search_for_subdir(dir, dirname.buf, mkdir);
411 strbuf_release(&dirname);
416 * Find the value entry with the given name in dir, sorting ref_dirs
417 * and recursing into subdirectories as necessary. If the name is not
418 * found or it corresponds to a directory entry, return NULL.
420 static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
422 struct ref_entry *entry;
423 dir = find_containing_dir(dir, refname, 0);
426 entry = search_ref_dir(dir, refname);
427 return (entry && !(entry->flag & REF_DIR)) ? entry : NULL;
431 * Add a ref_entry to the ref_dir (unsorted), recursing into
432 * subdirectories as necessary. dir must represent the top-level
433 * directory. Return 0 on success.
435 static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
437 dir = find_containing_dir(dir, ref->name, 1);
440 add_entry_to_dir(dir, ref);
445 * Emit a warning and return true iff ref1 and ref2 have the same name
446 * and the same sha1. Die if they have the same name but different
449 static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
451 if (strcmp(ref1->name, ref2->name))
454 /* Duplicate name; make sure that they don't conflict: */
456 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
457 /* This is impossible by construction */
458 die("Reference directory conflict: %s", ref1->name);
460 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
461 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
463 warning("Duplicated ref: %s", ref1->name);
468 * Sort the entries in dir non-recursively (if they are not already
469 * sorted) and remove any duplicate entries.
471 static void sort_ref_dir(struct ref_dir *dir)
474 struct ref_entry *last = NULL;
477 * This check also prevents passing a zero-length array to qsort(),
478 * which is a problem on some platforms.
480 if (dir->sorted == dir->nr)
483 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
485 /* Remove any duplicates: */
486 for (i = 0, j = 0; j < dir->nr; j++) {
487 struct ref_entry *entry = dir->entries[j];
488 if (last && is_dup_ref(last, entry))
489 free_ref_entry(entry);
491 last = dir->entries[i++] = entry;
493 dir->sorted = dir->nr = i;
496 #define DO_FOR_EACH_INCLUDE_BROKEN 01
498 static struct ref_entry *current_ref;
500 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
501 int flags, void *cb_data, struct ref_entry *entry)
504 if (prefixcmp(entry->name, base))
507 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
508 if (entry->flag & REF_ISBROKEN)
509 return 0; /* ignore broken refs e.g. dangling symref */
510 if (!has_sha1_file(entry->u.value.sha1)) {
511 error("%s does not point to a valid object!", entry->name);
516 retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
522 * Call fn for each reference in dir that has index in the range
523 * offset <= index < dir->nr. Recurse into subdirectories that are in
524 * that index range, sorting them before iterating. This function
525 * does not sort dir itself; it should be sorted beforehand.
527 static int do_for_each_ref_in_dir(struct ref_dir *dir, int offset,
529 each_ref_fn fn, int trim, int flags, void *cb_data)
532 assert(dir->sorted == dir->nr);
533 for (i = offset; i < dir->nr; i++) {
534 struct ref_entry *entry = dir->entries[i];
536 if (entry->flag & REF_DIR) {
537 struct ref_dir *subdir = get_ref_dir(entry);
538 sort_ref_dir(subdir);
539 retval = do_for_each_ref_in_dir(subdir, 0,
540 base, fn, trim, flags, cb_data);
542 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
551 * Call fn for each reference in the union of dir1 and dir2, in order
552 * by refname. Recurse into subdirectories. If a value entry appears
553 * in both dir1 and dir2, then only process the version that is in
554 * dir2. The input dirs must already be sorted, but subdirs will be
557 static int do_for_each_ref_in_dirs(struct ref_dir *dir1,
558 struct ref_dir *dir2,
559 const char *base, each_ref_fn fn, int trim,
560 int flags, void *cb_data)
565 assert(dir1->sorted == dir1->nr);
566 assert(dir2->sorted == dir2->nr);
568 struct ref_entry *e1, *e2;
570 if (i1 == dir1->nr) {
571 return do_for_each_ref_in_dir(dir2, i2,
572 base, fn, trim, flags, cb_data);
574 if (i2 == dir2->nr) {
575 return do_for_each_ref_in_dir(dir1, i1,
576 base, fn, trim, flags, cb_data);
578 e1 = dir1->entries[i1];
579 e2 = dir2->entries[i2];
580 cmp = strcmp(e1->name, e2->name);
582 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
583 /* Both are directories; descend them in parallel. */
584 struct ref_dir *subdir1 = get_ref_dir(e1);
585 struct ref_dir *subdir2 = get_ref_dir(e2);
586 sort_ref_dir(subdir1);
587 sort_ref_dir(subdir2);
588 retval = do_for_each_ref_in_dirs(
590 base, fn, trim, flags, cb_data);
593 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
594 /* Both are references; ignore the one from dir1. */
595 retval = do_one_ref(base, fn, trim, flags, cb_data, e2);
599 die("conflict between reference and directory: %s",
611 if (e->flag & REF_DIR) {
612 struct ref_dir *subdir = get_ref_dir(e);
613 sort_ref_dir(subdir);
614 retval = do_for_each_ref_in_dir(
616 base, fn, trim, flags, cb_data);
618 retval = do_one_ref(base, fn, trim, flags, cb_data, e);
625 return do_for_each_ref_in_dir(dir1, i1,
626 base, fn, trim, flags, cb_data);
628 return do_for_each_ref_in_dir(dir2, i2,
629 base, fn, trim, flags, cb_data);
634 * Return true iff refname1 and refname2 conflict with each other.
635 * Two reference names conflict if one of them exactly matches the
636 * leading components of the other; e.g., "foo/bar" conflicts with
637 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
640 static int names_conflict(const char *refname1, const char *refname2)
642 for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
644 return (*refname1 == '\0' && *refname2 == '/')
645 || (*refname1 == '/' && *refname2 == '\0');
648 struct name_conflict_cb {
650 const char *oldrefname;
651 const char *conflicting_refname;
654 static int name_conflict_fn(const char *existingrefname, const unsigned char *sha1,
655 int flags, void *cb_data)
657 struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
658 if (data->oldrefname && !strcmp(data->oldrefname, existingrefname))
660 if (names_conflict(data->refname, existingrefname)) {
661 data->conflicting_refname = existingrefname;
668 * Return true iff a reference named refname could be created without
669 * conflicting with the name of an existing reference in array. If
670 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
671 * (e.g., because oldrefname is scheduled for deletion in the same
674 static int is_refname_available(const char *refname, const char *oldrefname,
677 struct name_conflict_cb data;
678 data.refname = refname;
679 data.oldrefname = oldrefname;
680 data.conflicting_refname = NULL;
683 if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
684 0, DO_FOR_EACH_INCLUDE_BROKEN,
686 error("'%s' exists; cannot create '%s'",
687 data.conflicting_refname, refname);
694 * Future: need to be in "struct repository"
695 * when doing a full libification.
697 static struct ref_cache {
698 struct ref_cache *next;
699 struct ref_entry *loose;
700 struct ref_entry *packed;
701 /* The submodule name, or "" for the main repo. */
702 char name[FLEX_ARRAY];
705 static void clear_packed_ref_cache(struct ref_cache *refs)
708 free_ref_entry(refs->packed);
713 static void clear_loose_ref_cache(struct ref_cache *refs)
716 free_ref_entry(refs->loose);
721 static struct ref_cache *create_ref_cache(const char *submodule)
724 struct ref_cache *refs;
727 len = strlen(submodule) + 1;
728 refs = xcalloc(1, sizeof(struct ref_cache) + len);
729 memcpy(refs->name, submodule, len);
734 * Return a pointer to a ref_cache for the specified submodule. For
735 * the main repository, use submodule==NULL. The returned structure
736 * will be allocated and initialized but not necessarily populated; it
737 * should not be freed.
739 static struct ref_cache *get_ref_cache(const char *submodule)
741 struct ref_cache *refs = ref_cache;
745 if (!strcmp(submodule, refs->name))
750 refs = create_ref_cache(submodule);
751 refs->next = ref_cache;
756 void invalidate_ref_cache(const char *submodule)
758 struct ref_cache *refs = get_ref_cache(submodule);
759 clear_packed_ref_cache(refs);
760 clear_loose_ref_cache(refs);
764 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
765 * Return a pointer to the refname within the line (null-terminated),
766 * or NULL if there was a problem.
768 static const char *parse_ref_line(char *line, unsigned char *sha1)
771 * 42: the answer to everything.
773 * In this case, it happens to be the answer to
774 * 40 (length of sha1 hex representation)
775 * +1 (space in between hex and name)
776 * +1 (newline at the end of the line)
778 int len = strlen(line) - 42;
782 if (get_sha1_hex(line, sha1) < 0)
784 if (!isspace(line[40]))
789 if (line[len] != '\n')
796 static void read_packed_refs(FILE *f, struct ref_dir *dir)
798 struct ref_entry *last = NULL;
799 char refline[PATH_MAX];
800 int flag = REF_ISPACKED;
802 while (fgets(refline, sizeof(refline), f)) {
803 unsigned char sha1[20];
805 static const char header[] = "# pack-refs with:";
807 if (!strncmp(refline, header, sizeof(header)-1)) {
808 const char *traits = refline + sizeof(header) - 1;
809 if (strstr(traits, " peeled "))
810 flag |= REF_KNOWS_PEELED;
811 /* perhaps other traits later as well */
815 refname = parse_ref_line(refline, sha1);
817 last = create_ref_entry(refname, sha1, flag, 1);
823 strlen(refline) == 42 &&
824 refline[41] == '\n' &&
825 !get_sha1_hex(refline + 1, sha1))
826 hashcpy(last->u.value.peeled, sha1);
830 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
833 const char *packed_refs_file;
836 refs->packed = create_dir_entry(refs, "", 0);
838 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
840 packed_refs_file = git_path("packed-refs");
841 f = fopen(packed_refs_file, "r");
843 read_packed_refs(f, get_ref_dir(refs->packed));
847 return get_ref_dir(refs->packed);
850 void add_packed_ref(const char *refname, const unsigned char *sha1)
852 add_ref(get_packed_refs(get_ref_cache(NULL)),
853 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
857 * Read the loose references from the namespace dirname into dir
858 * (without recursing). dirname must end with '/'. dir must be the
859 * directory entry corresponding to dirname.
861 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
863 struct ref_cache *refs = dir->ref_cache;
867 int dirnamelen = strlen(dirname);
868 struct strbuf refname;
871 path = git_path_submodule(refs->name, "%s", dirname);
873 path = git_path("%s", dirname);
879 strbuf_init(&refname, dirnamelen + 257);
880 strbuf_add(&refname, dirname, dirnamelen);
882 while ((de = readdir(d)) != NULL) {
883 unsigned char sha1[20];
888 if (de->d_name[0] == '.')
890 if (has_extension(de->d_name, ".lock"))
892 strbuf_addstr(&refname, de->d_name);
894 ? git_path_submodule(refs->name, "%s", refname.buf)
895 : git_path("%s", refname.buf);
896 if (stat(refdir, &st) < 0) {
897 ; /* silently ignore */
898 } else if (S_ISDIR(st.st_mode)) {
899 strbuf_addch(&refname, '/');
900 add_entry_to_dir(dir,
901 create_dir_entry(refs, refname.buf, 1));
906 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
908 flag |= REF_ISBROKEN;
910 } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
912 flag |= REF_ISBROKEN;
914 add_entry_to_dir(dir,
915 create_ref_entry(refname.buf, sha1, flag, 1));
917 strbuf_setlen(&refname, dirnamelen);
919 strbuf_release(&refname);
923 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
927 * Mark the top-level directory complete because we
928 * are about to read the only subdirectory that can
931 refs->loose = create_dir_entry(refs, "", 0);
933 * Create an incomplete entry for "refs/":
935 add_entry_to_dir(get_ref_dir(refs->loose),
936 create_dir_entry(refs, "refs/", 1));
938 return get_ref_dir(refs->loose);
941 /* We allow "recursive" symbolic refs. Only within reason, though */
943 #define MAXREFLEN (1024)
946 * Called by resolve_gitlink_ref_recursive() after it failed to read
947 * from the loose refs in ref_cache refs. Find <refname> in the
948 * packed-refs file for the submodule.
950 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
951 const char *refname, unsigned char *sha1)
953 struct ref_entry *ref;
954 struct ref_dir *dir = get_packed_refs(refs);
956 ref = find_ref(dir, refname);
960 memcpy(sha1, ref->u.value.sha1, 20);
964 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
965 const char *refname, unsigned char *sha1,
969 char buffer[128], *p;
972 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
975 ? git_path_submodule(refs->name, "%s", refname)
976 : git_path("%s", refname);
977 fd = open(path, O_RDONLY);
979 return resolve_gitlink_packed_ref(refs, refname, sha1);
981 len = read(fd, buffer, sizeof(buffer)-1);
985 while (len && isspace(buffer[len-1]))
989 /* Was it a detached head or an old-fashioned symlink? */
990 if (!get_sha1_hex(buffer, sha1))
994 if (strncmp(buffer, "ref:", 4))
1000 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1003 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1005 int len = strlen(path), retval;
1007 struct ref_cache *refs;
1009 while (len && path[len-1] == '/')
1013 submodule = xstrndup(path, len);
1014 refs = get_ref_cache(submodule);
1017 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1022 * Try to read ref from the packed references. On success, set sha1
1023 * and return 0; otherwise, return -1.
1025 static int get_packed_ref(const char *refname, unsigned char *sha1)
1027 struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1028 struct ref_entry *entry = find_ref(packed, refname);
1030 hashcpy(sha1, entry->u.value.sha1);
1036 const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1038 int depth = MAXDEPTH;
1041 static char refname_buffer[256];
1046 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1050 char path[PATH_MAX];
1058 git_snpath(path, sizeof(path), "%s", refname);
1060 if (lstat(path, &st) < 0) {
1061 if (errno != ENOENT)
1064 * The loose reference file does not exist;
1065 * check for a packed reference.
1067 if (!get_packed_ref(refname, sha1)) {
1069 *flag |= REF_ISPACKED;
1072 /* The reference is not a packed reference, either. */
1081 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1082 if (S_ISLNK(st.st_mode)) {
1083 len = readlink(path, buffer, sizeof(buffer)-1);
1087 if (!prefixcmp(buffer, "refs/") &&
1088 !check_refname_format(buffer, 0)) {
1089 strcpy(refname_buffer, buffer);
1090 refname = refname_buffer;
1092 *flag |= REF_ISSYMREF;
1097 /* Is it a directory? */
1098 if (S_ISDIR(st.st_mode)) {
1104 * Anything else, just open it and try to use it as
1107 fd = open(path, O_RDONLY);
1110 len = read_in_full(fd, buffer, sizeof(buffer)-1);
1114 while (len && isspace(buffer[len-1]))
1119 * Is it a symbolic ref?
1121 if (prefixcmp(buffer, "ref:"))
1124 *flag |= REF_ISSYMREF;
1126 while (isspace(*buf))
1128 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1130 *flag |= REF_ISBROKEN;
1133 refname = strcpy(refname_buffer, buf);
1135 /* Please note that FETCH_HEAD has a second line containing other data. */
1136 if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1138 *flag |= REF_ISBROKEN;
1144 char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1146 const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1147 return ret ? xstrdup(ret) : NULL;
1150 /* The argument to filter_refs */
1152 const char *pattern;
1157 int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1159 if (resolve_ref_unsafe(refname, sha1, reading, flags))
1164 int read_ref(const char *refname, unsigned char *sha1)
1166 return read_ref_full(refname, sha1, 1, NULL);
1169 int ref_exists(const char *refname)
1171 unsigned char sha1[20];
1172 return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1175 static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1178 struct ref_filter *filter = (struct ref_filter *)data;
1179 if (fnmatch(filter->pattern, refname, 0))
1181 return filter->fn(refname, sha1, flags, filter->cb_data);
1184 int peel_ref(const char *refname, unsigned char *sha1)
1187 unsigned char base[20];
1190 if (current_ref && (current_ref->name == refname
1191 || !strcmp(current_ref->name, refname))) {
1192 if (current_ref->flag & REF_KNOWS_PEELED) {
1193 hashcpy(sha1, current_ref->u.value.peeled);
1196 hashcpy(base, current_ref->u.value.sha1);
1200 if (read_ref_full(refname, base, 1, &flag))
1203 if ((flag & REF_ISPACKED)) {
1204 struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1205 struct ref_entry *r = find_ref(dir, refname);
1207 if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1208 hashcpy(sha1, r->u.value.peeled);
1214 o = parse_object(base);
1215 if (o && o->type == OBJ_TAG) {
1216 o = deref_tag(o, refname, 0);
1218 hashcpy(sha1, o->sha1);
1225 struct warn_if_dangling_data {
1227 const char *refname;
1228 const char *msg_fmt;
1231 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1232 int flags, void *cb_data)
1234 struct warn_if_dangling_data *d = cb_data;
1235 const char *resolves_to;
1236 unsigned char junk[20];
1238 if (!(flags & REF_ISSYMREF))
1241 resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1242 if (!resolves_to || strcmp(resolves_to, d->refname))
1245 fprintf(d->fp, d->msg_fmt, refname);
1250 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1252 struct warn_if_dangling_data data;
1255 data.refname = refname;
1256 data.msg_fmt = msg_fmt;
1257 for_each_rawref(warn_if_dangling_symref, &data);
1260 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
1261 int trim, int flags, void *cb_data)
1263 struct ref_cache *refs = get_ref_cache(submodule);
1264 struct ref_dir *packed_dir = get_packed_refs(refs);
1265 struct ref_dir *loose_dir = get_loose_refs(refs);
1268 if (base && *base) {
1269 packed_dir = find_containing_dir(packed_dir, base, 0);
1270 loose_dir = find_containing_dir(loose_dir, base, 0);
1273 if (packed_dir && loose_dir) {
1274 sort_ref_dir(packed_dir);
1275 sort_ref_dir(loose_dir);
1276 retval = do_for_each_ref_in_dirs(
1277 packed_dir, loose_dir,
1278 base, fn, trim, flags, cb_data);
1279 } else if (packed_dir) {
1280 sort_ref_dir(packed_dir);
1281 retval = do_for_each_ref_in_dir(
1283 base, fn, trim, flags, cb_data);
1284 } else if (loose_dir) {
1285 sort_ref_dir(loose_dir);
1286 retval = do_for_each_ref_in_dir(
1288 base, fn, trim, flags, cb_data);
1294 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1296 unsigned char sha1[20];
1300 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1301 return fn("HEAD", sha1, 0, cb_data);
1306 if (!read_ref_full("HEAD", sha1, 1, &flag))
1307 return fn("HEAD", sha1, flag, cb_data);
1312 int head_ref(each_ref_fn fn, void *cb_data)
1314 return do_head_ref(NULL, fn, cb_data);
1317 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1319 return do_head_ref(submodule, fn, cb_data);
1322 int for_each_ref(each_ref_fn fn, void *cb_data)
1324 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1327 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1329 return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1332 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1334 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1337 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1338 each_ref_fn fn, void *cb_data)
1340 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1343 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1345 return for_each_ref_in("refs/tags/", fn, cb_data);
1348 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1350 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1353 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1355 return for_each_ref_in("refs/heads/", fn, cb_data);
1358 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1360 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1363 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1365 return for_each_ref_in("refs/remotes/", fn, cb_data);
1368 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1370 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1373 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1375 return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1378 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1380 struct strbuf buf = STRBUF_INIT;
1382 unsigned char sha1[20];
1385 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1386 if (!read_ref_full(buf.buf, sha1, 1, &flag))
1387 ret = fn(buf.buf, sha1, flag, cb_data);
1388 strbuf_release(&buf);
1393 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1395 struct strbuf buf = STRBUF_INIT;
1397 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1398 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
1399 strbuf_release(&buf);
1403 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1404 const char *prefix, void *cb_data)
1406 struct strbuf real_pattern = STRBUF_INIT;
1407 struct ref_filter filter;
1410 if (!prefix && prefixcmp(pattern, "refs/"))
1411 strbuf_addstr(&real_pattern, "refs/");
1413 strbuf_addstr(&real_pattern, prefix);
1414 strbuf_addstr(&real_pattern, pattern);
1416 if (!has_glob_specials(pattern)) {
1417 /* Append implied '/' '*' if not present. */
1418 if (real_pattern.buf[real_pattern.len - 1] != '/')
1419 strbuf_addch(&real_pattern, '/');
1420 /* No need to check for '*', there is none. */
1421 strbuf_addch(&real_pattern, '*');
1424 filter.pattern = real_pattern.buf;
1426 filter.cb_data = cb_data;
1427 ret = for_each_ref(filter_refs, &filter);
1429 strbuf_release(&real_pattern);
1433 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1435 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1438 int for_each_rawref(each_ref_fn fn, void *cb_data)
1440 return do_for_each_ref(NULL, "", fn, 0,
1441 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1444 const char *prettify_refname(const char *name)
1447 !prefixcmp(name, "refs/heads/") ? 11 :
1448 !prefixcmp(name, "refs/tags/") ? 10 :
1449 !prefixcmp(name, "refs/remotes/") ? 13 :
1453 const char *ref_rev_parse_rules[] = {
1458 "refs/remotes/%.*s",
1459 "refs/remotes/%.*s/HEAD",
1463 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1466 const int abbrev_name_len = strlen(abbrev_name);
1468 for (p = rules; *p; p++) {
1469 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1477 static struct ref_lock *verify_lock(struct ref_lock *lock,
1478 const unsigned char *old_sha1, int mustexist)
1480 if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1481 error("Can't verify ref %s", lock->ref_name);
1485 if (hashcmp(lock->old_sha1, old_sha1)) {
1486 error("Ref %s is at %s but expected %s", lock->ref_name,
1487 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1494 static int remove_empty_directories(const char *file)
1496 /* we want to create a file but there is a directory there;
1497 * if that is an empty directory (or a directory that contains
1498 * only empty directories), remove them.
1503 strbuf_init(&path, 20);
1504 strbuf_addstr(&path, file);
1506 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1508 strbuf_release(&path);
1514 * *string and *len will only be substituted, and *string returned (for
1515 * later free()ing) if the string passed in is a magic short-hand form
1518 static char *substitute_branch_name(const char **string, int *len)
1520 struct strbuf buf = STRBUF_INIT;
1521 int ret = interpret_branch_name(*string, &buf);
1525 *string = strbuf_detach(&buf, &size);
1527 return (char *)*string;
1533 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1535 char *last_branch = substitute_branch_name(&str, &len);
1540 for (p = ref_rev_parse_rules; *p; p++) {
1541 char fullref[PATH_MAX];
1542 unsigned char sha1_from_ref[20];
1543 unsigned char *this_result;
1546 this_result = refs_found ? sha1_from_ref : sha1;
1547 mksnpath(fullref, sizeof(fullref), *p, len, str);
1548 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1552 if (!warn_ambiguous_refs)
1554 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1555 warning("ignoring dangling symref %s.", fullref);
1556 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1557 warning("ignoring broken ref %s.", fullref);
1564 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1566 char *last_branch = substitute_branch_name(&str, &len);
1571 for (p = ref_rev_parse_rules; *p; p++) {
1573 unsigned char hash[20];
1574 char path[PATH_MAX];
1575 const char *ref, *it;
1577 mksnpath(path, sizeof(path), *p, len, str);
1578 ref = resolve_ref_unsafe(path, hash, 1, NULL);
1581 if (!stat(git_path("logs/%s", path), &st) &&
1582 S_ISREG(st.st_mode))
1584 else if (strcmp(ref, path) &&
1585 !stat(git_path("logs/%s", ref), &st) &&
1586 S_ISREG(st.st_mode))
1590 if (!logs_found++) {
1592 hashcpy(sha1, hash);
1594 if (!warn_ambiguous_refs)
1601 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1602 const unsigned char *old_sha1,
1603 int flags, int *type_p)
1606 const char *orig_refname = refname;
1607 struct ref_lock *lock;
1610 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1613 lock = xcalloc(1, sizeof(struct ref_lock));
1616 refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1617 if (!refname && errno == EISDIR) {
1618 /* we are trying to lock foo but we used to
1619 * have foo/bar which now does not exist;
1620 * it is normal for the empty directory 'foo'
1623 ref_file = git_path("%s", orig_refname);
1624 if (remove_empty_directories(ref_file)) {
1626 error("there are still refs under '%s'", orig_refname);
1629 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1635 error("unable to resolve reference %s: %s",
1636 orig_refname, strerror(errno));
1639 missing = is_null_sha1(lock->old_sha1);
1640 /* When the ref did not exist and we are creating it,
1641 * make sure there is no existing ref that is packed
1642 * whose name begins with our refname, nor a ref whose
1643 * name is a proper prefix of our refname.
1646 !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1647 last_errno = ENOTDIR;
1651 lock->lk = xcalloc(1, sizeof(struct lock_file));
1653 lflags = LOCK_DIE_ON_ERROR;
1654 if (flags & REF_NODEREF) {
1655 refname = orig_refname;
1656 lflags |= LOCK_NODEREF;
1658 lock->ref_name = xstrdup(refname);
1659 lock->orig_ref_name = xstrdup(orig_refname);
1660 ref_file = git_path("%s", refname);
1662 lock->force_write = 1;
1663 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1664 lock->force_write = 1;
1666 if (safe_create_leading_directories(ref_file)) {
1668 error("unable to create directory for %s", ref_file);
1672 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1673 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1681 struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1683 char refpath[PATH_MAX];
1684 if (check_refname_format(refname, 0))
1686 strcpy(refpath, mkpath("refs/%s", refname));
1687 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1690 struct ref_lock *lock_any_ref_for_update(const char *refname,
1691 const unsigned char *old_sha1, int flags)
1693 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1695 return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1698 struct repack_without_ref_sb {
1699 const char *refname;
1703 static int repack_without_ref_fn(const char *refname, const unsigned char *sha1,
1704 int flags, void *cb_data)
1706 struct repack_without_ref_sb *data = cb_data;
1707 char line[PATH_MAX + 100];
1710 if (!strcmp(data->refname, refname))
1712 len = snprintf(line, sizeof(line), "%s %s\n",
1713 sha1_to_hex(sha1), refname);
1714 /* this should not happen but just being defensive */
1715 if (len > sizeof(line))
1716 die("too long a refname '%s'", refname);
1717 write_or_die(data->fd, line, len);
1721 static struct lock_file packlock;
1723 static int repack_without_ref(const char *refname)
1725 struct repack_without_ref_sb data;
1726 struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1727 if (find_ref(packed, refname) == NULL)
1729 data.refname = refname;
1730 data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1732 unable_to_lock_error(git_path("packed-refs"), errno);
1733 return error("cannot delete '%s' from packed refs", refname);
1735 do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
1736 return commit_lock_file(&packlock);
1739 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1741 struct ref_lock *lock;
1742 int err, i = 0, ret = 0, flag = 0;
1744 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1747 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1751 if (!(delopt & REF_NODEREF)) {
1752 i = strlen(lock->lk->filename) - 5; /* .lock */
1753 lock->lk->filename[i] = 0;
1754 path = lock->lk->filename;
1756 path = git_path("%s", refname);
1758 err = unlink_or_warn(path);
1759 if (err && errno != ENOENT)
1762 if (!(delopt & REF_NODEREF))
1763 lock->lk->filename[i] = '.';
1765 /* removing the loose one could have resurrected an earlier
1766 * packed one. Also, if it was not loose we need to repack
1769 ret |= repack_without_ref(refname);
1771 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1772 invalidate_ref_cache(NULL);
1778 * People using contrib's git-new-workdir have .git/logs/refs ->
1779 * /some/other/path/.git/logs/refs, and that may live on another device.
1781 * IOW, to avoid cross device rename errors, the temporary renamed log must
1782 * live into logs/refs.
1784 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1786 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1788 unsigned char sha1[20], orig_sha1[20];
1789 int flag = 0, logmoved = 0;
1790 struct ref_lock *lock;
1791 struct stat loginfo;
1792 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
1793 const char *symref = NULL;
1794 struct ref_cache *refs = get_ref_cache(NULL);
1796 if (log && S_ISLNK(loginfo.st_mode))
1797 return error("reflog for %s is a symlink", oldrefname);
1799 symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
1800 if (flag & REF_ISSYMREF)
1801 return error("refname %s is a symbolic ref, renaming it is not supported",
1804 return error("refname %s not found", oldrefname);
1806 if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1809 if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1812 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1813 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1814 oldrefname, strerror(errno));
1816 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1817 error("unable to delete old %s", oldrefname);
1821 if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1822 delete_ref(newrefname, sha1, REF_NODEREF)) {
1823 if (errno==EISDIR) {
1824 if (remove_empty_directories(git_path("%s", newrefname))) {
1825 error("Directory not empty: %s", newrefname);
1829 error("unable to delete existing %s", newrefname);
1834 if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1835 error("unable to create directory for %s", newrefname);
1840 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1841 if (errno==EISDIR || errno==ENOTDIR) {
1843 * rename(a, b) when b is an existing
1844 * directory ought to result in ISDIR, but
1845 * Solaris 5.8 gives ENOTDIR. Sheesh.
1847 if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1848 error("Directory not empty: logs/%s", newrefname);
1853 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1854 newrefname, strerror(errno));
1860 lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1862 error("unable to lock %s for update", newrefname);
1865 lock->force_write = 1;
1866 hashcpy(lock->old_sha1, orig_sha1);
1867 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1868 error("unable to write current sha1 into %s", newrefname);
1875 lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1877 error("unable to lock %s for rollback", oldrefname);
1881 lock->force_write = 1;
1882 flag = log_all_ref_updates;
1883 log_all_ref_updates = 0;
1884 if (write_ref_sha1(lock, orig_sha1, NULL))
1885 error("unable to write current sha1 into %s", oldrefname);
1886 log_all_ref_updates = flag;
1889 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1890 error("unable to restore logfile %s from %s: %s",
1891 oldrefname, newrefname, strerror(errno));
1892 if (!logmoved && log &&
1893 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1894 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1895 oldrefname, strerror(errno));
1900 int close_ref(struct ref_lock *lock)
1902 if (close_lock_file(lock->lk))
1908 int commit_ref(struct ref_lock *lock)
1910 if (commit_lock_file(lock->lk))
1916 void unlock_ref(struct ref_lock *lock)
1918 /* Do not free lock->lk -- atexit() still looks at them */
1920 rollback_lock_file(lock->lk);
1921 free(lock->ref_name);
1922 free(lock->orig_ref_name);
1927 * copy the reflog message msg to buf, which has been allocated sufficiently
1928 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1929 * because reflog file is one line per entry.
1931 static int copy_msg(char *buf, const char *msg)
1938 while ((c = *msg++)) {
1939 if (wasspace && isspace(c))
1941 wasspace = isspace(c);
1946 while (buf < cp && isspace(cp[-1]))
1952 int log_ref_setup(const char *refname, char *logfile, int bufsize)
1954 int logfd, oflags = O_APPEND | O_WRONLY;
1956 git_snpath(logfile, bufsize, "logs/%s", refname);
1957 if (log_all_ref_updates &&
1958 (!prefixcmp(refname, "refs/heads/") ||
1959 !prefixcmp(refname, "refs/remotes/") ||
1960 !prefixcmp(refname, "refs/notes/") ||
1961 !strcmp(refname, "HEAD"))) {
1962 if (safe_create_leading_directories(logfile) < 0)
1963 return error("unable to create directory for %s",
1968 logfd = open(logfile, oflags, 0666);
1970 if (!(oflags & O_CREAT) && errno == ENOENT)
1973 if ((oflags & O_CREAT) && errno == EISDIR) {
1974 if (remove_empty_directories(logfile)) {
1975 return error("There are still logs under '%s'",
1978 logfd = open(logfile, oflags, 0666);
1982 return error("Unable to append to %s: %s",
1983 logfile, strerror(errno));
1986 adjust_shared_perm(logfile);
1991 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1992 const unsigned char *new_sha1, const char *msg)
1994 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1995 unsigned maxlen, len;
1997 char log_file[PATH_MAX];
1999 const char *committer;
2001 if (log_all_ref_updates < 0)
2002 log_all_ref_updates = !is_bare_repository();
2004 result = log_ref_setup(refname, log_file, sizeof(log_file));
2008 logfd = open(log_file, oflags);
2011 msglen = msg ? strlen(msg) : 0;
2012 committer = git_committer_info(0);
2013 maxlen = strlen(committer) + msglen + 100;
2014 logrec = xmalloc(maxlen);
2015 len = sprintf(logrec, "%s %s %s\n",
2016 sha1_to_hex(old_sha1),
2017 sha1_to_hex(new_sha1),
2020 len += copy_msg(logrec + len - 1, msg) - 1;
2021 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2023 if (close(logfd) != 0 || written != len)
2024 return error("Unable to append to %s", log_file);
2028 static int is_branch(const char *refname)
2030 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
2033 int write_ref_sha1(struct ref_lock *lock,
2034 const unsigned char *sha1, const char *logmsg)
2036 static char term = '\n';
2041 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2045 o = parse_object(sha1);
2047 error("Trying to write ref %s with nonexistent object %s",
2048 lock->ref_name, sha1_to_hex(sha1));
2052 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2053 error("Trying to write non-commit object %s to branch %s",
2054 sha1_to_hex(sha1), lock->ref_name);
2058 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2059 write_in_full(lock->lock_fd, &term, 1) != 1
2060 || close_ref(lock) < 0) {
2061 error("Couldn't write %s", lock->lk->filename);
2065 clear_loose_ref_cache(get_ref_cache(NULL));
2066 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2067 (strcmp(lock->ref_name, lock->orig_ref_name) &&
2068 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2072 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2074 * Special hack: If a branch is updated directly and HEAD
2075 * points to it (may happen on the remote side of a push
2076 * for example) then logically the HEAD reflog should be
2078 * A generic solution implies reverse symref information,
2079 * but finding all symrefs pointing to the given branch
2080 * would be rather costly for this rare event (the direct
2081 * update of a branch) to be worth it. So let's cheat and
2082 * check with HEAD only which should cover 99% of all usage
2083 * scenarios (even 100% of the default ones).
2085 unsigned char head_sha1[20];
2087 const char *head_ref;
2088 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2089 if (head_ref && (head_flag & REF_ISSYMREF) &&
2090 !strcmp(head_ref, lock->ref_name))
2091 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2093 if (commit_ref(lock)) {
2094 error("Couldn't set %s", lock->ref_name);
2102 int create_symref(const char *ref_target, const char *refs_heads_master,
2105 const char *lockpath;
2107 int fd, len, written;
2108 char *git_HEAD = git_pathdup("%s", ref_target);
2109 unsigned char old_sha1[20], new_sha1[20];
2111 if (logmsg && read_ref(ref_target, old_sha1))
2114 if (safe_create_leading_directories(git_HEAD) < 0)
2115 return error("unable to create directory for %s", git_HEAD);
2117 #ifndef NO_SYMLINK_HEAD
2118 if (prefer_symlink_refs) {
2120 if (!symlink(refs_heads_master, git_HEAD))
2122 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2126 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2127 if (sizeof(ref) <= len) {
2128 error("refname too long: %s", refs_heads_master);
2129 goto error_free_return;
2131 lockpath = mkpath("%s.lock", git_HEAD);
2132 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2134 error("Unable to open %s for writing", lockpath);
2135 goto error_free_return;
2137 written = write_in_full(fd, ref, len);
2138 if (close(fd) != 0 || written != len) {
2139 error("Unable to write to %s", lockpath);
2140 goto error_unlink_return;
2142 if (rename(lockpath, git_HEAD) < 0) {
2143 error("Unable to create %s", git_HEAD);
2144 goto error_unlink_return;
2146 if (adjust_shared_perm(git_HEAD)) {
2147 error("Unable to fix permissions on %s", lockpath);
2148 error_unlink_return:
2149 unlink_or_warn(lockpath);
2155 #ifndef NO_SYMLINK_HEAD
2158 if (logmsg && !read_ref(refs_heads_master, new_sha1))
2159 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2165 static char *ref_msg(const char *line, const char *endp)
2169 ep = memchr(line, '\n', endp - line);
2172 return xmemdupz(line, ep - line);
2175 int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2176 unsigned char *sha1, char **msg,
2177 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2179 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2181 int logfd, tz, reccnt = 0;
2184 unsigned char logged_sha1[20];
2188 logfile = git_path("logs/%s", refname);
2189 logfd = open(logfile, O_RDONLY, 0);
2191 die_errno("Unable to read log '%s'", logfile);
2194 die("Log %s is empty.", logfile);
2195 mapsz = xsize_t(st.st_size);
2196 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2197 logdata = log_mapped;
2201 rec = logend = logdata + st.st_size;
2202 while (logdata < rec) {
2204 if (logdata < rec && *(rec-1) == '\n')
2207 while (logdata < rec && *(rec-1) != '\n') {
2213 die("Log %s is corrupt.", logfile);
2214 date = strtoul(lastgt + 1, &tz_c, 10);
2215 if (date <= at_time || cnt == 0) {
2216 tz = strtoul(tz_c, NULL, 10);
2218 *msg = ref_msg(rec, logend);
2220 *cutoff_time = date;
2224 *cutoff_cnt = reccnt - 1;
2226 if (get_sha1_hex(lastrec, logged_sha1))
2227 die("Log %s is corrupt.", logfile);
2228 if (get_sha1_hex(rec + 41, sha1))
2229 die("Log %s is corrupt.", logfile);
2230 if (hashcmp(logged_sha1, sha1)) {
2231 warning("Log %s has gap after %s.",
2232 logfile, show_date(date, tz, DATE_RFC2822));
2235 else if (date == at_time) {
2236 if (get_sha1_hex(rec + 41, sha1))
2237 die("Log %s is corrupt.", logfile);
2240 if (get_sha1_hex(rec + 41, logged_sha1))
2241 die("Log %s is corrupt.", logfile);
2242 if (hashcmp(logged_sha1, sha1)) {
2243 warning("Log %s unexpectedly ended on %s.",
2244 logfile, show_date(date, tz, DATE_RFC2822));
2247 munmap(log_mapped, mapsz);
2256 while (rec < logend && *rec != '>' && *rec != '\n')
2258 if (rec == logend || *rec == '\n')
2259 die("Log %s is corrupt.", logfile);
2260 date = strtoul(rec + 1, &tz_c, 10);
2261 tz = strtoul(tz_c, NULL, 10);
2262 if (get_sha1_hex(logdata, sha1))
2263 die("Log %s is corrupt.", logfile);
2264 if (is_null_sha1(sha1)) {
2265 if (get_sha1_hex(logdata + 41, sha1))
2266 die("Log %s is corrupt.", logfile);
2269 *msg = ref_msg(logdata, logend);
2270 munmap(log_mapped, mapsz);
2273 *cutoff_time = date;
2277 *cutoff_cnt = reccnt;
2281 int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2283 const char *logfile;
2285 struct strbuf sb = STRBUF_INIT;
2288 logfile = git_path("logs/%s", refname);
2289 logfp = fopen(logfile, "r");
2294 struct stat statbuf;
2295 if (fstat(fileno(logfp), &statbuf) ||
2296 statbuf.st_size < ofs ||
2297 fseek(logfp, -ofs, SEEK_END) ||
2298 strbuf_getwholeline(&sb, logfp, '\n')) {
2300 strbuf_release(&sb);
2305 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2306 unsigned char osha1[20], nsha1[20];
2307 char *email_end, *message;
2308 unsigned long timestamp;
2311 /* old SP new SP name <email> SP time TAB msg LF */
2312 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
2313 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
2314 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
2315 !(email_end = strchr(sb.buf + 82, '>')) ||
2316 email_end[1] != ' ' ||
2317 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
2318 !message || message[0] != ' ' ||
2319 (message[1] != '+' && message[1] != '-') ||
2320 !isdigit(message[2]) || !isdigit(message[3]) ||
2321 !isdigit(message[4]) || !isdigit(message[5]))
2322 continue; /* corrupt? */
2323 email_end[1] = '\0';
2324 tz = strtol(message + 1, NULL, 10);
2325 if (message[6] != '\t')
2329 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
2335 strbuf_release(&sb);
2339 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2341 return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2345 * Call fn for each reflog in the namespace indicated by name. name
2346 * must be empty or end with '/'. Name will be used as a scratch
2347 * space, but its contents will be restored before return.
2349 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
2351 DIR *d = opendir(git_path("logs/%s", name->buf));
2354 int oldlen = name->len;
2357 return name->len ? errno : 0;
2359 while ((de = readdir(d)) != NULL) {
2362 if (de->d_name[0] == '.')
2364 if (has_extension(de->d_name, ".lock"))
2366 strbuf_addstr(name, de->d_name);
2367 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
2368 ; /* silently ignore */
2370 if (S_ISDIR(st.st_mode)) {
2371 strbuf_addch(name, '/');
2372 retval = do_for_each_reflog(name, fn, cb_data);
2374 unsigned char sha1[20];
2375 if (read_ref_full(name->buf, sha1, 0, NULL))
2376 retval = error("bad ref for %s", name->buf);
2378 retval = fn(name->buf, sha1, 0, cb_data);
2383 strbuf_setlen(name, oldlen);
2389 int for_each_reflog(each_ref_fn fn, void *cb_data)
2393 strbuf_init(&name, PATH_MAX);
2394 retval = do_for_each_reflog(&name, fn, cb_data);
2395 strbuf_release(&name);
2399 int update_ref(const char *action, const char *refname,
2400 const unsigned char *sha1, const unsigned char *oldval,
2401 int flags, enum action_on_err onerr)
2403 static struct ref_lock *lock;
2404 lock = lock_any_ref_for_update(refname, oldval, flags);
2406 const char *str = "Cannot lock the ref '%s'.";
2408 case MSG_ON_ERR: error(str, refname); break;
2409 case DIE_ON_ERR: die(str, refname); break;
2410 case QUIET_ON_ERR: break;
2414 if (write_ref_sha1(lock, sha1, action) < 0) {
2415 const char *str = "Cannot update the ref '%s'.";
2417 case MSG_ON_ERR: error(str, refname); break;
2418 case DIE_ON_ERR: die(str, refname); break;
2419 case QUIET_ON_ERR: break;
2426 struct ref *find_ref_by_name(const struct ref *list, const char *name)
2428 for ( ; list; list = list->next)
2429 if (!strcmp(list->name, name))
2430 return (struct ref *)list;
2435 * generate a format suitable for scanf from a ref_rev_parse_rules
2436 * rule, that is replace the "%.*s" spec with a "%s" spec
2438 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2442 spec = strstr(rule, "%.*s");
2443 if (!spec || strstr(spec + 4, "%.*s"))
2444 die("invalid rule in ref_rev_parse_rules: %s", rule);
2446 /* copy all until spec */
2447 strncpy(scanf_fmt, rule, spec - rule);
2448 scanf_fmt[spec - rule] = '\0';
2450 strcat(scanf_fmt, "%s");
2451 /* copy remaining rule */
2452 strcat(scanf_fmt, spec + 4);
2457 char *shorten_unambiguous_ref(const char *refname, int strict)
2460 static char **scanf_fmts;
2461 static int nr_rules;
2464 /* pre generate scanf formats from ref_rev_parse_rules[] */
2466 size_t total_len = 0;
2468 /* the rule list is NULL terminated, count them first */
2469 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2470 /* no +1 because strlen("%s") < strlen("%.*s") */
2471 total_len += strlen(ref_rev_parse_rules[nr_rules]);
2473 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2476 for (i = 0; i < nr_rules; i++) {
2477 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2479 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2480 total_len += strlen(ref_rev_parse_rules[i]);
2484 /* bail out if there are no rules */
2486 return xstrdup(refname);
2488 /* buffer for scanf result, at most refname must fit */
2489 short_name = xstrdup(refname);
2491 /* skip first rule, it will always match */
2492 for (i = nr_rules - 1; i > 0 ; --i) {
2494 int rules_to_fail = i;
2497 if (1 != sscanf(refname, scanf_fmts[i], short_name))
2500 short_name_len = strlen(short_name);
2503 * in strict mode, all (except the matched one) rules
2504 * must fail to resolve to a valid non-ambiguous ref
2507 rules_to_fail = nr_rules;
2510 * check if the short name resolves to a valid ref,
2511 * but use only rules prior to the matched one
2513 for (j = 0; j < rules_to_fail; j++) {
2514 const char *rule = ref_rev_parse_rules[j];
2515 char refname[PATH_MAX];
2517 /* skip matched rule */
2522 * the short name is ambiguous, if it resolves
2523 * (with this previous rule) to a valid ref
2524 * read_ref() returns 0 on success
2526 mksnpath(refname, sizeof(refname),
2527 rule, short_name_len, short_name);
2528 if (ref_exists(refname))
2533 * short name is non-ambiguous if all previous rules
2534 * haven't resolved to a valid ref
2536 if (j == rules_to_fail)
2541 return xstrdup(refname);