2 * Copyright (C) 2009-2012 the libgit2 contributors
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
10 #include "repository.h"
16 #include <git2/object.h>
21 #define DEFAULT_NESTING_LEVEL 5
22 #define MAX_NESTING_LEVEL 10
25 GIT_PACKREF_HAS_PEEL
= 1,
26 GIT_PACKREF_WAS_LOOSE
= 2
33 char name
[GIT_FLEX_ARRAY
];
36 static int reference_read(
37 git_buf
*file_content
,
39 const char *repo_path
,
44 static int loose_parse_symbolic(git_reference
*ref
, git_buf
*file_content
);
45 static int loose_parse_oid(git_oid
*ref
, git_buf
*file_content
);
46 static int loose_lookup(git_reference
*ref
);
47 static int loose_lookup_to_packfile(struct packref
**ref_out
,
48 git_repository
*repo
, const char *name
);
49 static int loose_write(git_reference
*ref
);
52 static int packed_parse_peel(struct packref
*tag_ref
,
53 const char **buffer_out
, const char *buffer_end
);
54 static int packed_parse_oid(struct packref
**ref_out
,
55 const char **buffer_out
, const char *buffer_end
);
56 static int packed_load(git_repository
*repo
);
57 static int packed_loadloose(git_repository
*repository
);
58 static int packed_write_ref(struct packref
*ref
, git_filebuf
*file
);
59 static int packed_find_peel(git_repository
*repo
, struct packref
*ref
);
60 static int packed_remove_loose(git_repository
*repo
, git_vector
*packing_list
);
61 static int packed_sort(const void *a
, const void *b
);
62 static int packed_lookup(git_reference
*ref
);
63 static int packed_write(git_repository
*repo
);
65 /* internal helpers */
66 static int reference_path_available(git_repository
*repo
,
67 const char *ref
, const char *old_ref
);
68 static int reference_delete(git_reference
*ref
);
69 static int reference_lookup(git_reference
*ref
);
71 void git_reference_free(git_reference
*reference
)
73 if (reference
== NULL
)
76 git__free(reference
->name
);
77 reference
->name
= NULL
;
79 if (reference
->flags
& GIT_REF_SYMBOLIC
) {
80 git__free(reference
->target
.symbolic
);
81 reference
->target
.symbolic
= NULL
;
87 static int reference_alloc(
88 git_reference
**ref_out
,
92 git_reference
*reference
= NULL
;
94 assert(ref_out
&& repo
&& name
);
96 reference
= git__malloc(sizeof(git_reference
));
97 GITERR_CHECK_ALLOC(reference
);
99 memset(reference
, 0x0, sizeof(git_reference
));
100 reference
->owner
= repo
;
102 reference
->name
= git__strdup(name
);
103 GITERR_CHECK_ALLOC(reference
->name
);
105 *ref_out
= reference
;
109 static int reference_read(
110 git_buf
*file_content
,
112 const char *repo_path
,
113 const char *ref_name
,
116 git_buf path
= GIT_BUF_INIT
;
119 assert(file_content
&& repo_path
&& ref_name
);
121 /* Determine the full path of the file */
122 if (git_buf_joinpath(&path
, repo_path
, ref_name
) < 0)
125 result
= git_futils_readbuffer_updated(file_content
, path
.ptr
, mtime
, updated
);
131 static int loose_parse_symbolic(git_reference
*ref
, git_buf
*file_content
)
133 const unsigned int header_len
= (unsigned int)strlen(GIT_SYMREF
);
134 const char *refname_start
;
136 refname_start
= (const char *)file_content
->ptr
;
138 if (git_buf_len(file_content
) < header_len
+ 1) {
139 giterr_set(GITERR_REFERENCE
, "Corrupted loose reference file");
144 * Assume we have already checked for the header
145 * before calling this function
147 refname_start
+= header_len
;
149 ref
->target
.symbolic
= git__strdup(refname_start
);
150 GITERR_CHECK_ALLOC(ref
->target
.symbolic
);
155 static int loose_parse_oid(git_oid
*oid
, git_buf
*file_content
)
157 /* File format: 40 chars (OID) */
158 if (git_buf_len(file_content
) == GIT_OID_HEXSZ
&&
159 git_oid_fromstr(oid
, git_buf_cstr(file_content
)) == 0)
162 giterr_set(GITERR_REFERENCE
, "Corrupted loose reference file");
166 static git_ref_t
loose_guess_rtype(const git_buf
*full_path
)
168 git_buf ref_file
= GIT_BUF_INIT
;
171 type
= GIT_REF_INVALID
;
173 if (git_futils_readbuffer(&ref_file
, full_path
->ptr
) == 0) {
174 if (git__prefixcmp((const char *)(ref_file
.ptr
), GIT_SYMREF
) == 0)
175 type
= GIT_REF_SYMBOLIC
;
180 git_buf_free(&ref_file
);
184 static int loose_lookup(git_reference
*ref
)
187 git_buf ref_file
= GIT_BUF_INIT
;
189 result
= reference_read(&ref_file
, &ref
->mtime
,
190 ref
->owner
->path_repository
, ref
->name
, &updated
);
198 git_buf_rtrim(&ref_file
);
200 if (ref
->flags
& GIT_REF_SYMBOLIC
) {
201 git__free(ref
->target
.symbolic
);
202 ref
->target
.symbolic
= NULL
;
207 if (git__prefixcmp((const char *)(ref_file
.ptr
), GIT_SYMREF
) == 0) {
208 ref
->flags
|= GIT_REF_SYMBOLIC
;
209 result
= loose_parse_symbolic(ref
, &ref_file
);
211 ref
->flags
|= GIT_REF_OID
;
212 result
= loose_parse_oid(&ref
->target
.oid
, &ref_file
);
215 git_buf_free(&ref_file
);
219 static int loose_lookup_to_packfile(
220 struct packref
**ref_out
,
221 git_repository
*repo
,
224 git_buf ref_file
= GIT_BUF_INIT
;
225 struct packref
*ref
= NULL
;
230 if (reference_read(&ref_file
, NULL
, repo
->path_repository
, name
, NULL
) < 0)
233 git_buf_rtrim(&ref_file
);
235 name_len
= strlen(name
);
236 ref
= git__malloc(sizeof(struct packref
) + name_len
+ 1);
237 GITERR_CHECK_ALLOC(ref
);
239 memcpy(ref
->name
, name
, name_len
);
240 ref
->name
[name_len
] = 0;
242 if (loose_parse_oid(&ref
->oid
, &ref_file
) < 0) {
243 git_buf_free(&ref_file
);
248 ref
->flags
= GIT_PACKREF_WAS_LOOSE
;
251 git_buf_free(&ref_file
);
255 static int loose_write(git_reference
*ref
)
257 git_filebuf file
= GIT_FILEBUF_INIT
;
258 git_buf ref_path
= GIT_BUF_INIT
;
261 if (git_buf_joinpath(&ref_path
, ref
->owner
->path_repository
, ref
->name
) < 0)
264 /* Remove a possibly existing empty directory hierarchy
265 * which name would collide with the reference name
267 if (git_path_isdir(git_buf_cstr(&ref_path
)) &&
268 (git_futils_rmdir_r(git_buf_cstr(&ref_path
), GIT_DIRREMOVAL_ONLY_EMPTY_DIRS
) < 0)) {
269 git_buf_free(&ref_path
);
273 if (git_filebuf_open(&file
, ref_path
.ptr
, GIT_FILEBUF_FORCE
) < 0) {
274 git_buf_free(&ref_path
);
278 git_buf_free(&ref_path
);
280 if (ref
->flags
& GIT_REF_OID
) {
281 char oid
[GIT_OID_HEXSZ
+ 1];
283 git_oid_fmt(oid
, &ref
->target
.oid
);
284 oid
[GIT_OID_HEXSZ
] = '\0';
286 git_filebuf_printf(&file
, "%s\n", oid
);
288 } else if (ref
->flags
& GIT_REF_SYMBOLIC
) {
289 git_filebuf_printf(&file
, GIT_SYMREF
"%s\n", ref
->target
.symbolic
);
291 assert(0); /* don't let this happen */
294 if (p_stat(ref_path
.ptr
, &st
) == 0)
295 ref
->mtime
= st
.st_mtime
;
297 return git_filebuf_commit(&file
, GIT_REFS_FILE_MODE
);
300 static int packed_parse_peel(
301 struct packref
*tag_ref
,
302 const char **buffer_out
,
303 const char *buffer_end
)
305 const char *buffer
= *buffer_out
+ 1;
307 assert(buffer
[-1] == '^');
309 /* Ensure it's not the first entry of the file */
313 /* Ensure reference is a tag */
314 if (git__prefixcmp(tag_ref
->name
, GIT_REFS_TAGS_DIR
) != 0)
317 if (buffer
+ GIT_OID_HEXSZ
>= buffer_end
)
320 /* Is this a valid object id? */
321 if (git_oid_fromstr(&tag_ref
->peel
, buffer
) < 0)
324 buffer
= buffer
+ GIT_OID_HEXSZ
;
331 *buffer_out
= buffer
+ 1;
335 giterr_set(GITERR_REFERENCE
, "The packed references file is corrupted");
339 static int packed_parse_oid(
340 struct packref
**ref_out
,
341 const char **buffer_out
,
342 const char *buffer_end
)
344 struct packref
*ref
= NULL
;
346 const char *buffer
= *buffer_out
;
347 const char *refname_begin
, *refname_end
;
352 refname_begin
= (buffer
+ GIT_OID_HEXSZ
+ 1);
353 if (refname_begin
>= buffer_end
|| refname_begin
[-1] != ' ')
356 /* Is this a valid object id? */
357 if (git_oid_fromstr(&id
, buffer
) < 0)
360 refname_end
= memchr(refname_begin
, '\n', buffer_end
- refname_begin
);
361 if (refname_end
== NULL
)
364 if (refname_end
[-1] == '\r')
367 refname_len
= refname_end
- refname_begin
;
369 ref
= git__malloc(sizeof(struct packref
) + refname_len
+ 1);
370 GITERR_CHECK_ALLOC(ref
);
372 memcpy(ref
->name
, refname_begin
, refname_len
);
373 ref
->name
[refname_len
] = 0;
375 git_oid_cpy(&ref
->oid
, &id
);
380 *buffer_out
= refname_end
+ 1;
386 giterr_set(GITERR_REFERENCE
, "The packed references file is corrupted");
390 static int packed_load(git_repository
*repo
)
393 git_buf packfile
= GIT_BUF_INIT
;
394 const char *buffer_start
, *buffer_end
;
395 git_refcache
*ref_cache
= &repo
->references
;
397 /* First we make sure we have allocated the hash table */
398 if (ref_cache
->packfile
== NULL
) {
399 ref_cache
->packfile
= git_strmap_alloc();
400 GITERR_CHECK_ALLOC(ref_cache
->packfile
);
403 result
= reference_read(&packfile
, &ref_cache
->packfile_time
,
404 repo
->path_repository
, GIT_PACKEDREFS_FILE
, &updated
);
407 * If we couldn't find the file, we need to clear the table and
408 * return. On any other error, we return that error. If everything
409 * went fine and the file wasn't updated, then there's nothing new
410 * for us here, so just return. Anything else means we need to
411 * refresh the packed refs.
413 if (result
== GIT_ENOTFOUND
) {
414 git_strmap_clear(ref_cache
->packfile
);
425 * At this point, we want to refresh the packed refs. We already
426 * have the contents in our buffer.
428 git_strmap_clear(ref_cache
->packfile
);
430 buffer_start
= (const char *)packfile
.ptr
;
431 buffer_end
= (const char *)(buffer_start
) + packfile
.size
;
433 while (buffer_start
< buffer_end
&& buffer_start
[0] == '#') {
434 buffer_start
= strchr(buffer_start
, '\n');
435 if (buffer_start
== NULL
)
441 while (buffer_start
< buffer_end
) {
443 struct packref
*ref
= NULL
;
445 if (packed_parse_oid(&ref
, &buffer_start
, buffer_end
) < 0)
448 if (buffer_start
[0] == '^') {
449 if (packed_parse_peel(ref
, &buffer_start
, buffer_end
) < 0)
453 git_strmap_insert(ref_cache
->packfile
, ref
->name
, ref
, err
);
458 git_buf_free(&packfile
);
462 git_strmap_free(ref_cache
->packfile
);
463 ref_cache
->packfile
= NULL
;
464 git_buf_free(&packfile
);
469 struct dirent_list_data
{
470 git_repository
*repo
;
471 size_t repo_path_len
;
472 unsigned int list_flags
;
474 int (*callback
)(const char *, void *);
475 void *callback_payload
;
479 static int _dirent_loose_listall(void *_data
, git_buf
*full_path
)
481 struct dirent_list_data
*data
= (struct dirent_list_data
*)_data
;
482 const char *file_path
= full_path
->ptr
+ data
->repo_path_len
;
484 if (git_path_isdir(full_path
->ptr
) == true)
485 return git_path_direach(full_path
, _dirent_loose_listall
, _data
);
487 /* do not add twice a reference that exists already in the packfile */
488 if ((data
->list_flags
& GIT_REF_PACKED
) != 0 &&
489 git_strmap_exists(data
->repo
->references
.packfile
, file_path
))
492 if (data
->list_flags
!= GIT_REF_LISTALL
) {
493 if ((data
->list_flags
& loose_guess_rtype(full_path
)) == 0)
494 return 0; /* we are filtering out this reference */
497 if (data
->callback(file_path
, data
->callback_payload
))
498 data
->callback_error
= GIT_EUSER
;
500 return data
->callback_error
;
503 static int _dirent_loose_load(void *data
, git_buf
*full_path
)
505 git_repository
*repository
= (git_repository
*)data
;
506 void *old_ref
= NULL
;
508 const char *file_path
;
511 if (git_path_isdir(full_path
->ptr
) == true)
512 return git_path_direach(full_path
, _dirent_loose_load
, repository
);
514 file_path
= full_path
->ptr
+ strlen(repository
->path_repository
);
516 if (loose_lookup_to_packfile(&ref
, repository
, file_path
) < 0)
520 repository
->references
.packfile
, ref
->name
, ref
, old_ref
, err
);
531 * Load all the loose references from the repository
532 * into the in-memory Packfile, and build a vector with
533 * all the references so it can be written back to
536 static int packed_loadloose(git_repository
*repository
)
538 git_buf refs_path
= GIT_BUF_INIT
;
541 /* the packfile must have been previously loaded! */
542 assert(repository
->references
.packfile
);
544 if (git_buf_joinpath(&refs_path
, repository
->path_repository
, GIT_REFS_DIR
) < 0)
548 * Load all the loose files from disk into the Packfile table.
549 * This will overwrite any old packed entries with their
550 * updated loose versions
552 result
= git_path_direach(&refs_path
, _dirent_loose_load
, repository
);
553 git_buf_free(&refs_path
);
559 * Write a single reference into a packfile
561 static int packed_write_ref(struct packref
*ref
, git_filebuf
*file
)
563 char oid
[GIT_OID_HEXSZ
+ 1];
565 git_oid_fmt(oid
, &ref
->oid
);
566 oid
[GIT_OID_HEXSZ
] = 0;
569 * For references that peel to an object in the repo, we must
570 * write the resulting peel on a separate line, e.g.
572 * 6fa8a902cc1d18527e1355773c86721945475d37 refs/tags/libgit2-0.4
573 * ^2ec0cb7959b0bf965d54f95453f5b4b34e8d3100
575 * This obviously only applies to tags.
576 * The required peels have already been loaded into `ref->peel_target`.
578 if (ref
->flags
& GIT_PACKREF_HAS_PEEL
) {
579 char peel
[GIT_OID_HEXSZ
+ 1];
580 git_oid_fmt(peel
, &ref
->peel
);
581 peel
[GIT_OID_HEXSZ
] = 0;
583 if (git_filebuf_printf(file
, "%s %s\n^%s\n", oid
, ref
->name
, peel
) < 0)
586 if (git_filebuf_printf(file
, "%s %s\n", oid
, ref
->name
) < 0)
594 * Find out what object this reference resolves to.
596 * For references that point to a 'big' tag (e.g. an
597 * actual tag object on the repository), we need to
598 * cache on the packfile the OID of the object to
599 * which that 'big tag' is pointing to.
601 static int packed_find_peel(git_repository
*repo
, struct packref
*ref
)
605 if (ref
->flags
& GIT_PACKREF_HAS_PEEL
)
609 * Only applies to tags, i.e. references
610 * in the /refs/tags folder
612 if (git__prefixcmp(ref
->name
, GIT_REFS_TAGS_DIR
) != 0)
616 * Find the tagged object in the repository
618 if (git_object_lookup(&object
, repo
, &ref
->oid
, GIT_OBJ_ANY
) < 0)
622 * If the tagged object is a Tag object, we need to resolve it;
623 * if the ref is actually a 'weak' ref, we don't need to resolve
626 if (git_object_type(object
) == GIT_OBJ_TAG
) {
627 git_tag
*tag
= (git_tag
*)object
;
630 * Find the object pointed at by this tag
632 git_oid_cpy(&ref
->peel
, git_tag_target_oid(tag
));
633 ref
->flags
|= GIT_PACKREF_HAS_PEEL
;
636 * The reference has now cached the resolved OID, and is
637 * marked at such. When written to the packfile, it'll be
638 * accompanied by this resolved oid
642 git_object_free(object
);
647 * Remove all loose references
649 * Once we have successfully written a packfile,
650 * all the loose references that were packed must be
653 * This is a dangerous method; make sure the packfile
654 * is well-written, because we are destructing references
657 static int packed_remove_loose(git_repository
*repo
, git_vector
*packing_list
)
660 git_buf full_path
= GIT_BUF_INIT
;
663 for (i
= 0; i
< packing_list
->length
; ++i
) {
664 struct packref
*ref
= git_vector_get(packing_list
, i
);
666 if ((ref
->flags
& GIT_PACKREF_WAS_LOOSE
) == 0)
669 if (git_buf_joinpath(&full_path
, repo
->path_repository
, ref
->name
) < 0)
670 return -1; /* critical; do not try to recover on oom */
672 if (git_path_exists(full_path
.ptr
) == true && p_unlink(full_path
.ptr
) < 0) {
676 giterr_set(GITERR_REFERENCE
,
677 "Failed to remove loose reference '%s' after packing: %s",
678 full_path
.ptr
, strerror(errno
));
684 * if we fail to remove a single file, this is *not* good,
685 * but we should keep going and remove as many as possible.
686 * After we've removed as many files as possible, we return
687 * the error code anyway.
691 git_buf_free(&full_path
);
692 return failed
? -1 : 0;
695 static int packed_sort(const void *a
, const void *b
)
697 const struct packref
*ref_a
= (const struct packref
*)a
;
698 const struct packref
*ref_b
= (const struct packref
*)b
;
700 return strcmp(ref_a
->name
, ref_b
->name
);
704 * Write all the contents in the in-memory packfile to disk.
706 static int packed_write(git_repository
*repo
)
708 git_filebuf pack_file
= GIT_FILEBUF_INIT
;
710 git_buf pack_file_path
= GIT_BUF_INIT
;
711 git_vector packing_list
;
712 unsigned int total_refs
;
714 assert(repo
&& repo
->references
.packfile
);
717 (unsigned int)git_strmap_num_entries(repo
->references
.packfile
);
719 if (git_vector_init(&packing_list
, total_refs
, packed_sort
) < 0)
722 /* Load all the packfile into a vector */
724 struct packref
*reference
;
726 /* cannot fail: vector already has the right size */
727 git_strmap_foreach_value(repo
->references
.packfile
, reference
, {
728 git_vector_insert(&packing_list
, reference
);
732 /* sort the vector so the entries appear sorted on the packfile */
733 git_vector_sort(&packing_list
);
735 /* Now we can open the file! */
736 if (git_buf_joinpath(&pack_file_path
, repo
->path_repository
, GIT_PACKEDREFS_FILE
) < 0)
739 if (git_filebuf_open(&pack_file
, pack_file_path
.ptr
, 0) < 0)
740 goto cleanup_packfile
;
742 /* Packfiles have a header... apparently
743 * This is in fact not required, but we might as well print it
745 if (git_filebuf_printf(&pack_file
, "%s\n", GIT_PACKEDREFS_HEADER
) < 0)
746 goto cleanup_packfile
;
748 for (i
= 0; i
< packing_list
.length
; ++i
) {
749 struct packref
*ref
= (struct packref
*)git_vector_get(&packing_list
, i
);
751 if (packed_find_peel(repo
, ref
) < 0)
752 goto cleanup_packfile
;
754 if (packed_write_ref(ref
, &pack_file
) < 0)
755 goto cleanup_packfile
;
758 /* if we've written all the references properly, we can commit
759 * the packfile to make the changes effective */
760 if (git_filebuf_commit(&pack_file
, GIT_PACKEDREFS_FILE_MODE
) < 0)
763 /* when and only when the packfile has been properly written,
764 * we can go ahead and remove the loose refs */
765 if (packed_remove_loose(repo
, &packing_list
) < 0)
770 if (p_stat(pack_file_path
.ptr
, &st
) == 0)
771 repo
->references
.packfile_time
= st
.st_mtime
;
774 git_vector_free(&packing_list
);
775 git_buf_free(&pack_file_path
);
781 git_filebuf_cleanup(&pack_file
);
784 git_vector_free(&packing_list
);
785 git_buf_free(&pack_file_path
);
790 struct reference_available_t
{
796 static int _reference_available_cb(const char *ref
, void *data
)
798 struct reference_available_t
*d
;
801 d
= (struct reference_available_t
*)data
;
803 if (!d
->old_ref
|| strcmp(d
->old_ref
, ref
)) {
804 size_t reflen
= strlen(ref
);
805 size_t newlen
= strlen(d
->new_ref
);
806 size_t cmplen
= reflen
< newlen
? reflen
: newlen
;
807 const char *lead
= reflen
< newlen
? d
->new_ref
: ref
;
809 if (!strncmp(d
->new_ref
, ref
, cmplen
) && lead
[cmplen
] == '/') {
818 static int reference_path_available(
819 git_repository
*repo
,
824 struct reference_available_t data
;
827 data
.old_ref
= old_ref
;
830 error
= git_reference_foreach(
831 repo
, GIT_REF_LISTALL
, _reference_available_cb
, (void *)&data
);
835 if (!data
.available
) {
836 giterr_set(GITERR_REFERENCE
,
837 "The path to reference '%s' collides with an existing one", ref
);
844 static int reference_exists(int *exists
, git_repository
*repo
, const char *ref_name
)
846 git_buf ref_path
= GIT_BUF_INIT
;
848 if (packed_load(repo
) < 0)
851 if (git_buf_joinpath(&ref_path
, repo
->path_repository
, ref_name
) < 0)
854 if (git_path_isfile(ref_path
.ptr
) == true ||
855 git_strmap_exists(repo
->references
.packfile
, ref_path
.ptr
))
862 git_buf_free(&ref_path
);
867 * Check if a reference could be written to disk, based on:
869 * - Whether a reference with the same name already exists,
870 * and we are allowing or disallowing overwrites
872 * - Whether the name of the reference would collide with
875 static int reference_can_write(
876 git_repository
*repo
,
878 const char *previous_name
,
881 /* see if the reference shares a path with an existing reference;
882 * if a path is shared, we cannot create the reference, even when forcing */
883 if (reference_path_available(repo
, refname
, previous_name
) < 0)
886 /* check if the reference actually exists, but only if we are not forcing
887 * the rename. If we are forcing, it's OK to overwrite */
891 if (reference_exists(&exists
, repo
, refname
) < 0)
894 /* We cannot proceed if the reference already exists and we're not forcing
895 * the rename; the existing one would be overwritten */
897 giterr_set(GITERR_REFERENCE
,
898 "A reference with that name (%s) already exists", refname
);
903 /* FIXME: if the reference exists and we are forcing, do we really need to
904 * remove the reference first?
908 * - the reference already exists and is loose: not a problem, the file
909 * gets overwritten on disk
911 * - the reference already exists and is packed: we write a new one as
912 * loose, which by all means renders the packed one useless
919 static int packed_lookup(git_reference
*ref
)
921 struct packref
*pack_ref
= NULL
;
922 git_strmap
*packfile_refs
;
925 if (packed_load(ref
->owner
) < 0)
928 /* maybe the packfile hasn't changed at all, so we don't
929 * have to re-lookup the reference */
930 if ((ref
->flags
& GIT_REF_PACKED
) &&
931 ref
->mtime
== ref
->owner
->references
.packfile_time
)
934 if (ref
->flags
& GIT_REF_SYMBOLIC
) {
935 git__free(ref
->target
.symbolic
);
936 ref
->target
.symbolic
= NULL
;
939 /* Look up on the packfile */
940 packfile_refs
= ref
->owner
->references
.packfile
;
941 pos
= git_strmap_lookup_index(packfile_refs
, ref
->name
);
942 if (!git_strmap_valid_index(packfile_refs
, pos
)) {
943 giterr_set(GITERR_REFERENCE
, "Reference '%s' not found", ref
->name
);
944 return GIT_ENOTFOUND
;
947 pack_ref
= git_strmap_value_at(packfile_refs
, pos
);
949 ref
->flags
= GIT_REF_OID
| GIT_REF_PACKED
;
950 ref
->mtime
= ref
->owner
->references
.packfile_time
;
951 git_oid_cpy(&ref
->target
.oid
, &pack_ref
->oid
);
956 static int reference_lookup(git_reference
*ref
)
960 result
= loose_lookup(ref
);
964 /* only try to lookup this reference on the packfile if it
965 * wasn't found on the loose refs; not if there was a critical error */
966 if (result
== GIT_ENOTFOUND
) {
968 result
= packed_lookup(ref
);
973 /* unexpected error; free the reference */
974 git_reference_free(ref
);
979 * Delete a reference.
980 * This is an internal method; the reference is removed
981 * from disk or the packfile, but the pointer is not freed
983 static int reference_delete(git_reference
*ref
)
989 /* If the reference is packed, this is an expensive operation.
990 * We need to reload the packfile, remove the reference from the
991 * packing list, and repack */
992 if (ref
->flags
& GIT_REF_PACKED
) {
993 git_strmap
*packfile_refs
;
994 struct packref
*packref
;
997 /* load the existing packfile */
998 if (packed_load(ref
->owner
) < 0)
1001 packfile_refs
= ref
->owner
->references
.packfile
;
1002 pos
= git_strmap_lookup_index(packfile_refs
, ref
->name
);
1003 if (!git_strmap_valid_index(packfile_refs
, pos
)) {
1004 giterr_set(GITERR_REFERENCE
,
1005 "Reference %s stopped existing in the packfile", ref
->name
);
1009 packref
= git_strmap_value_at(packfile_refs
, pos
);
1010 git_strmap_delete_at(packfile_refs
, pos
);
1013 if (packed_write(ref
->owner
) < 0)
1016 /* If the reference is loose, we can just remove the reference
1017 * from the filesystem */
1019 git_reference
*ref_in_pack
;
1020 git_buf full_path
= GIT_BUF_INIT
;
1022 if (git_buf_joinpath(&full_path
, ref
->owner
->path_repository
, ref
->name
) < 0)
1025 result
= p_unlink(full_path
.ptr
);
1026 git_buf_free(&full_path
); /* done with path at this point */
1029 giterr_set(GITERR_OS
, "Failed to unlink '%s'", full_path
.ptr
);
1033 /* When deleting a loose reference, we have to ensure that an older
1034 * packed version of it doesn't exist */
1035 if (git_reference_lookup(&ref_in_pack
, ref
->owner
, ref
->name
) == 0) {
1036 assert((ref_in_pack
->flags
& GIT_REF_PACKED
) != 0);
1037 return git_reference_delete(ref_in_pack
);
1046 int git_reference_delete(git_reference
*ref
)
1048 int result
= reference_delete(ref
);
1049 git_reference_free(ref
);
1053 int git_reference_lookup(git_reference
**ref_out
,
1054 git_repository
*repo
, const char *name
)
1056 return git_reference_lookup_resolved(ref_out
, repo
, name
, 0);
1059 int git_reference_name_to_oid(
1060 git_oid
*out
, git_repository
*repo
, const char *name
)
1065 if ((error
= git_reference_lookup_resolved(&ref
, repo
, name
, -1)) < 0)
1068 git_oid_cpy(out
, git_reference_oid(ref
));
1069 git_reference_free(ref
);
1073 int git_reference_lookup_resolved(
1074 git_reference
**ref_out
,
1075 git_repository
*repo
,
1079 git_reference
*scan
;
1080 int result
, nesting
;
1082 assert(ref_out
&& repo
&& name
);
1086 if (max_nesting
> MAX_NESTING_LEVEL
)
1087 max_nesting
= MAX_NESTING_LEVEL
;
1088 else if (max_nesting
< 0)
1089 max_nesting
= DEFAULT_NESTING_LEVEL
;
1091 scan
= git__calloc(1, sizeof(git_reference
));
1092 GITERR_CHECK_ALLOC(scan
);
1094 scan
->name
= git__calloc(GIT_REFNAME_MAX
+ 1, sizeof(char));
1095 GITERR_CHECK_ALLOC(scan
->name
);
1097 if ((result
= git_reference__normalize_name(
1101 git_reference_free(scan
);
1105 scan
->target
.symbolic
= git__strdup(scan
->name
);
1106 GITERR_CHECK_ALLOC(scan
->target
.symbolic
);
1109 scan
->flags
= GIT_REF_SYMBOLIC
;
1111 for (nesting
= max_nesting
;
1112 nesting
>= 0 && (scan
->flags
& GIT_REF_SYMBOLIC
) != 0;
1115 if (nesting
!= max_nesting
)
1116 strncpy(scan
->name
, scan
->target
.symbolic
, GIT_REFNAME_MAX
);
1120 if ((result
= reference_lookup(scan
)) < 0)
1121 return result
; /* lookup git_reference_free on scan already */
1124 if ((scan
->flags
& GIT_REF_OID
) == 0 && max_nesting
!= 0) {
1125 giterr_set(GITERR_REFERENCE
,
1126 "Cannot resolve reference (>%u levels deep)", max_nesting
);
1127 git_reference_free(scan
);
1138 git_ref_t
git_reference_type(git_reference
*ref
)
1142 if (ref
->flags
& GIT_REF_OID
)
1145 if (ref
->flags
& GIT_REF_SYMBOLIC
)
1146 return GIT_REF_SYMBOLIC
;
1148 return GIT_REF_INVALID
;
1151 int git_reference_is_packed(git_reference
*ref
)
1154 return !!(ref
->flags
& GIT_REF_PACKED
);
1157 const char *git_reference_name(git_reference
*ref
)
1163 git_repository
*git_reference_owner(git_reference
*ref
)
1169 const git_oid
*git_reference_oid(git_reference
*ref
)
1173 if ((ref
->flags
& GIT_REF_OID
) == 0)
1176 return &ref
->target
.oid
;
1179 const char *git_reference_target(git_reference
*ref
)
1183 if ((ref
->flags
& GIT_REF_SYMBOLIC
) == 0)
1186 return ref
->target
.symbolic
;
1189 int git_reference_create_symbolic(
1190 git_reference
**ref_out
,
1191 git_repository
*repo
,
1196 char normalized
[GIT_REFNAME_MAX
];
1197 git_reference
*ref
= NULL
;
1199 if (git_reference__normalize_name(
1205 if (reference_can_write(repo
, normalized
, NULL
, force
) < 0)
1208 if (reference_alloc(&ref
, repo
, normalized
) < 0)
1211 ref
->flags
|= GIT_REF_SYMBOLIC
;
1213 /* set the target; this will normalize the name automatically
1214 * and write the reference on disk */
1215 if (git_reference_set_target(ref
, target
) < 0) {
1216 git_reference_free(ref
);
1219 if (ref_out
== NULL
) {
1220 git_reference_free(ref
);
1228 int git_reference_create_oid(
1229 git_reference
**ref_out
,
1230 git_repository
*repo
,
1235 git_reference
*ref
= NULL
;
1236 char normalized
[GIT_REFNAME_MAX
];
1238 if (git_reference__normalize_name_oid(
1244 if (reference_can_write(repo
, normalized
, NULL
, force
) < 0)
1247 if (reference_alloc(&ref
, repo
, name
) < 0)
1250 ref
->flags
|= GIT_REF_OID
;
1252 /* set the oid; this will write the reference on disk */
1253 if (git_reference_set_oid(ref
, id
) < 0) {
1254 git_reference_free(ref
);
1258 if (ref_out
== NULL
) {
1259 git_reference_free(ref
);
1267 * Change the OID target of a reference.
1269 * For both loose and packed references, just change
1270 * the oid in memory and (over)write the file in disk.
1272 * We do not repack packed references because of performance
1275 int git_reference_set_oid(git_reference
*ref
, const git_oid
*id
)
1277 git_odb
*odb
= NULL
;
1279 if ((ref
->flags
& GIT_REF_OID
) == 0) {
1280 giterr_set(GITERR_REFERENCE
, "Cannot set OID on symbolic reference");
1286 if (git_repository_odb__weakptr(&odb
, ref
->owner
) < 0)
1289 /* Don't let the user create references to OIDs that
1290 * don't exist in the ODB */
1291 if (!git_odb_exists(odb
, id
)) {
1292 giterr_set(GITERR_REFERENCE
,
1293 "Target OID for the reference doesn't exist on the repository");
1297 /* Update the OID value on `ref` */
1298 git_oid_cpy(&ref
->target
.oid
, id
);
1300 /* Write back to disk */
1301 return loose_write(ref
);
1305 * Change the target of a symbolic reference.
1307 * This is easy because symrefs cannot be inside
1308 * a pack. We just change the target in memory
1309 * and overwrite the file on disk.
1311 int git_reference_set_target(git_reference
*ref
, const char *target
)
1313 char normalized
[GIT_REFNAME_MAX
];
1315 if ((ref
->flags
& GIT_REF_SYMBOLIC
) == 0) {
1316 giterr_set(GITERR_REFERENCE
,
1317 "Cannot set symbolic target on a direct reference");
1321 if (git_reference__normalize_name(
1327 git__free(ref
->target
.symbolic
);
1328 ref
->target
.symbolic
= git__strdup(normalized
);
1329 GITERR_CHECK_ALLOC(ref
->target
.symbolic
);
1331 return loose_write(ref
);
1334 int git_reference_rename(git_reference
*ref
, const char *new_name
, int force
)
1337 unsigned int normalization_flags
;
1338 git_buf aux_path
= GIT_BUF_INIT
;
1339 char normalized
[GIT_REFNAME_MAX
];
1341 const char *head_target
= NULL
;
1342 git_reference
*head
= NULL
;
1344 normalization_flags
= ref
->flags
& GIT_REF_SYMBOLIC
?
1345 GIT_REF_FORMAT_ALLOW_ONELEVEL
1346 : GIT_REF_FORMAT_NORMAL
;
1348 if (git_reference_normalize_name(
1352 normalization_flags
) < 0)
1355 if (reference_can_write(ref
->owner
, normalized
, ref
->name
, force
) < 0)
1358 /* Initialize path now so we won't get an allocation failure once
1359 * we actually start removing things. */
1360 if (git_buf_joinpath(&aux_path
, ref
->owner
->path_repository
, new_name
) < 0)
1364 * Now delete the old ref and remove an possibly existing directory
1365 * named `new_name`. Note that using the internal `reference_delete`
1366 * method deletes the ref from disk but doesn't free the pointer, so
1367 * we can still access the ref's attributes for creating the new one
1369 if (reference_delete(ref
) < 0)
1373 * Finally we can create the new reference.
1375 if (ref
->flags
& GIT_REF_SYMBOLIC
) {
1376 result
= git_reference_create_symbolic(
1377 NULL
, ref
->owner
, new_name
, ref
->target
.symbolic
, force
);
1379 result
= git_reference_create_oid(
1380 NULL
, ref
->owner
, new_name
, &ref
->target
.oid
, force
);
1387 * Check if we have to update HEAD.
1389 if (git_reference_lookup(&head
, ref
->owner
, GIT_HEAD_FILE
) < 0) {
1390 giterr_set(GITERR_REFERENCE
,
1391 "Failed to update HEAD after renaming reference");
1395 head_target
= git_reference_target(head
);
1397 if (head_target
&& !strcmp(head_target
, ref
->name
)) {
1398 git_reference_free(head
);
1401 if (git_reference_create_symbolic(&head
, ref
->owner
, "HEAD", new_name
, 1) < 0) {
1402 giterr_set(GITERR_REFERENCE
,
1403 "Failed to update HEAD after renaming reference");
1409 * Rename the reflog file, if it exists.
1411 if ((git_reference_has_log(ref
)) && (git_reflog_rename(ref
, new_name
) < 0))
1415 * Change the name of the reference given by the user.
1417 git__free(ref
->name
);
1418 ref
->name
= git__strdup(new_name
);
1420 /* The reference is no longer packed */
1421 ref
->flags
&= ~GIT_REF_PACKED
;
1423 git_reference_free(head
);
1424 git_buf_free(&aux_path
);
1428 git_reference_free(head
);
1429 git_buf_free(&aux_path
);
1434 * Try to create the old reference again, ignore failures
1436 if (ref
->flags
& GIT_REF_SYMBOLIC
)
1437 git_reference_create_symbolic(
1438 NULL
, ref
->owner
, ref
->name
, ref
->target
.symbolic
, 0);
1440 git_reference_create_oid(
1441 NULL
, ref
->owner
, ref
->name
, &ref
->target
.oid
, 0);
1443 /* The reference is no longer packed */
1444 ref
->flags
&= ~GIT_REF_PACKED
;
1446 git_buf_free(&aux_path
);
1450 int git_reference_resolve(git_reference
**ref_out
, git_reference
*ref
)
1452 if (ref
->flags
& GIT_REF_OID
)
1453 return git_reference_lookup(ref_out
, ref
->owner
, ref
->name
);
1455 return git_reference_lookup_resolved(ref_out
, ref
->owner
, ref
->target
.symbolic
, -1);
1458 int git_reference_packall(git_repository
*repo
)
1460 if (packed_load(repo
) < 0 || /* load the existing packfile */
1461 packed_loadloose(repo
) < 0 || /* add all the loose refs */
1462 packed_write(repo
) < 0) /* write back to disk */
1468 int git_reference_foreach(
1469 git_repository
*repo
,
1470 unsigned int list_flags
,
1471 int (*callback
)(const char *, void *),
1475 struct dirent_list_data data
;
1476 git_buf refs_path
= GIT_BUF_INIT
;
1478 /* list all the packed references first */
1479 if (list_flags
& GIT_REF_PACKED
) {
1480 const char *ref_name
;
1484 if (packed_load(repo
) < 0)
1487 git_strmap_foreach(repo
->references
.packfile
, ref_name
, ref
, {
1488 if (callback(ref_name
, payload
))
1493 /* now list the loose references, trying not to
1494 * duplicate the ref names already in the packed-refs file */
1496 data
.repo_path_len
= strlen(repo
->path_repository
);
1497 data
.list_flags
= list_flags
;
1499 data
.callback
= callback
;
1500 data
.callback_payload
= payload
;
1501 data
.callback_error
= 0;
1503 if (git_buf_joinpath(&refs_path
, repo
->path_repository
, GIT_REFS_DIR
) < 0)
1506 result
= git_path_direach(&refs_path
, _dirent_loose_listall
, &data
);
1508 git_buf_free(&refs_path
);
1510 return data
.callback_error
? GIT_EUSER
: result
;
1513 static int cb__reflist_add(const char *ref
, void *data
)
1515 return git_vector_insert((git_vector
*)data
, git__strdup(ref
));
1518 int git_reference_list(
1519 git_strarray
*array
,
1520 git_repository
*repo
,
1521 unsigned int list_flags
)
1523 git_vector ref_list
;
1525 assert(array
&& repo
);
1527 array
->strings
= NULL
;
1530 if (git_vector_init(&ref_list
, 8, NULL
) < 0)
1533 if (git_reference_foreach(
1534 repo
, list_flags
, &cb__reflist_add
, (void *)&ref_list
) < 0) {
1535 git_vector_free(&ref_list
);
1539 array
->strings
= (char **)ref_list
.contents
;
1540 array
->count
= ref_list
.length
;
1544 int git_reference_reload(git_reference
*ref
)
1546 return reference_lookup(ref
);
1549 void git_repository__refcache_free(git_refcache
*refs
)
1553 if (refs
->packfile
) {
1554 struct packref
*reference
;
1556 git_strmap_foreach_value(refs
->packfile
, reference
, {
1557 git__free(reference
);
1560 git_strmap_free(refs
->packfile
);
1564 static int is_valid_ref_char(char ch
)
1566 if ((unsigned) ch
<= ' ')
1583 int git_reference_normalize_name(
1589 const char *name_end
, *buffer_out_start
;
1590 const char *current
;
1591 int contains_a_slash
= 0;
1593 assert(name
&& buffer_out
);
1595 if (flags
& GIT_REF_FORMAT_REFSPEC_PATTERN
) {
1596 giterr_set(GITERR_INVALID
, "Unimplemented");
1600 buffer_out_start
= buffer_out
;
1602 name_end
= name
+ strlen(name
);
1604 /* Terminating null byte */
1607 /* A refname can not be empty */
1608 if (name_end
== name
)
1611 /* A refname can not end with a dot or a slash */
1612 if (*(name_end
- 1) == '.' || *(name_end
- 1) == '/')
1615 while (current
< name_end
&& buffer_size
> 0) {
1616 if (!is_valid_ref_char(*current
))
1619 if (buffer_out
> buffer_out_start
) {
1620 char prev
= *(buffer_out
- 1);
1622 /* A refname can not start with a dot nor contain a double dot */
1623 if (*current
== '.' && ((prev
== '.') || (prev
== '/')))
1626 /* '@{' is forbidden within a refname */
1627 if (*current
== '{' && prev
== '@')
1630 /* Prevent multiple slashes from being added to the output */
1631 if (*current
== '/' && prev
== '/') {
1637 if (*current
== '/') {
1638 if (buffer_out
> buffer_out_start
)
1639 contains_a_slash
= 1;
1646 *buffer_out
++ = *current
++;
1650 if (current
< name_end
) {
1653 "The provided buffer is too short to hold the normalization of '%s'", name
);
1657 /* Object id refname have to contain at least one slash, except
1658 * for HEAD in a detached state or MERGE_HEAD if we're in the
1659 * middle of a merge */
1660 if (!(flags
& GIT_REF_FORMAT_ALLOW_ONELEVEL
) &&
1661 !contains_a_slash
&&
1662 strcmp(name
, GIT_HEAD_FILE
) != 0 &&
1663 strcmp(name
, GIT_MERGE_HEAD_FILE
) != 0 &&
1664 strcmp(name
, GIT_FETCH_HEAD_FILE
) != 0)
1667 /* A refname can not end with ".lock" */
1668 if (!git__suffixcmp(name
, GIT_FILELOCK_EXTENSION
))
1678 "The given reference name '%s' is not valid", name
);
1682 int git_reference__normalize_name(
1687 return git_reference_normalize_name(
1691 GIT_REF_FORMAT_ALLOW_ONELEVEL
);
1694 int git_reference__normalize_name_oid(
1699 return git_reference_normalize_name(
1703 GIT_REF_FORMAT_NORMAL
);
1706 #define GIT_REF_TYPEMASK (GIT_REF_OID | GIT_REF_SYMBOLIC)
1708 int git_reference_cmp(git_reference
*ref1
, git_reference
*ref2
)
1710 assert(ref1
&& ref2
);
1712 /* let's put symbolic refs before OIDs */
1713 if ((ref1
->flags
& GIT_REF_TYPEMASK
) != (ref2
->flags
& GIT_REF_TYPEMASK
))
1714 return (ref1
->flags
& GIT_REF_SYMBOLIC
) ? -1 : 1;
1716 if (ref1
->flags
& GIT_REF_SYMBOLIC
)
1717 return strcmp(ref1
->target
.symbolic
, ref2
->target
.symbolic
);
1719 return git_oid_cmp(&ref1
->target
.oid
, &ref2
->target
.oid
);
1722 /* Update the reference named `ref_name` so it points to `oid` */
1723 int git_reference__update(git_repository
*repo
, const git_oid
*oid
, const char *ref_name
)
1728 res
= git_reference_lookup(&ref
, repo
, ref_name
);
1730 /* If we haven't found the reference at all, we assume we need to create
1731 * a new reference and that's it */
1732 if (res
== GIT_ENOTFOUND
) {
1734 return git_reference_create_oid(NULL
, repo
, ref_name
, oid
, 1);
1740 /* If we have found a reference, but it's symbolic, we need to update
1741 * the direct reference it points to */
1742 if (git_reference_type(ref
) == GIT_REF_SYMBOLIC
) {
1744 const char *sym_target
;
1746 /* The target pointed at by this reference */
1747 sym_target
= git_reference_target(ref
);
1749 /* resolve the reference to the target it points to */
1750 res
= git_reference_resolve(&aux
, ref
);
1753 * if the symbolic reference pointed to an inexisting ref,
1754 * this is means we're creating a new branch, for example.
1755 * We need to create a new direct reference with that name
1757 if (res
== GIT_ENOTFOUND
) {
1759 res
= git_reference_create_oid(NULL
, repo
, sym_target
, oid
, 1);
1760 git_reference_free(ref
);
1764 /* free the original symbolic reference now; not before because
1765 * we're using the `sym_target` pointer */
1766 git_reference_free(ref
);
1771 /* store the newly found direct reference in its place */
1775 /* ref is made to point to `oid`: ref is either the original reference,
1776 * or the target of the symbolic reference we've looked up */
1777 res
= git_reference_set_oid(ref
, oid
);
1778 git_reference_free(ref
);
1782 struct glob_cb_data
{
1784 int (*callback
)(const char *, void *);
1788 static int fromglob_cb(const char *reference_name
, void *payload
)
1790 struct glob_cb_data
*data
= (struct glob_cb_data
*)payload
;
1792 if (!p_fnmatch(data
->glob
, reference_name
, 0))
1793 return data
->callback(reference_name
, data
->payload
);
1798 int git_reference_foreach_glob(
1799 git_repository
*repo
,
1801 unsigned int list_flags
,
1803 const char *reference_name
,
1807 struct glob_cb_data data
;
1809 assert(repo
&& glob
&& callback
);
1812 data
.callback
= callback
;
1813 data
.payload
= payload
;
1815 return git_reference_foreach(
1816 repo
, list_flags
, fromglob_cb
, &data
);
1819 int git_reference_has_log(
1822 git_buf path
= GIT_BUF_INIT
;
1827 if (git_buf_join_n(&path
, '/', 3, ref
->owner
->path_repository
, GIT_REFLOG_DIR
, ref
->name
) < 0)
1830 result
= git_path_isfile(git_buf_cstr(&path
));
1831 git_buf_free(&path
);
1836 int git_reference_is_branch(git_reference
*ref
)
1839 return git__prefixcmp(ref
->name
, GIT_REFS_HEADS_DIR
) == 0;
1842 int git_reference_is_remote(git_reference
*ref
)
1845 return git__prefixcmp(ref
->name
, GIT_REFS_REMOTES_DIR
) == 0;
1848 static int peel_error(int error
, git_reference
*ref
, const char* msg
)
1852 "The reference '%s' cannot be peeled - %s", git_reference_name(ref
), msg
);
1856 static int reference_target(git_object
**object
, git_reference
*ref
)
1860 oid
= git_reference_oid(ref
);
1862 return git_object_lookup(object
, git_reference_owner(ref
), oid
, GIT_OBJ_ANY
);
1865 int git_reference_peel(
1866 git_object
**peeled
,
1868 git_otype target_type
)
1870 git_reference
*resolved
= NULL
;
1871 git_object
*target
= NULL
;
1876 if ((error
= git_reference_resolve(&resolved
, ref
)) < 0)
1877 return peel_error(error
, ref
, "Cannot resolve reference");
1879 if ((error
= reference_target(&target
, resolved
)) < 0) {
1880 peel_error(error
, ref
, "Cannot retrieve reference target");
1884 if (target_type
== GIT_OBJ_ANY
&& git_object_type(target
) != GIT_OBJ_TAG
)
1885 error
= git_object__dup(peeled
, target
);
1887 error
= git_object_peel(peeled
, target
, target_type
);
1890 git_object_free(target
);
1891 git_reference_free(resolved
);