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>
20 #define DEFAULT_NESTING_LEVEL 5
21 #define MAX_NESTING_LEVEL 10
24 GIT_PACKREF_HAS_PEEL
= 1,
25 GIT_PACKREF_WAS_LOOSE
= 2
32 char name
[GIT_FLEX_ARRAY
];
35 static int reference_read(
36 git_buf
*file_content
,
38 const char *repo_path
,
43 static int loose_parse_symbolic(git_reference
*ref
, git_buf
*file_content
);
44 static int loose_parse_oid(git_oid
*ref
, git_buf
*file_content
);
45 static int loose_lookup(git_reference
*ref
);
46 static int loose_lookup_to_packfile(struct packref
**ref_out
,
47 git_repository
*repo
, const char *name
);
48 static int loose_write(git_reference
*ref
);
51 static int packed_parse_peel(struct packref
*tag_ref
,
52 const char **buffer_out
, const char *buffer_end
);
53 static int packed_parse_oid(struct packref
**ref_out
,
54 const char **buffer_out
, const char *buffer_end
);
55 static int packed_load(git_repository
*repo
);
56 static int packed_loadloose(git_repository
*repository
);
57 static int packed_write_ref(struct packref
*ref
, git_filebuf
*file
);
58 static int packed_find_peel(git_repository
*repo
, struct packref
*ref
);
59 static int packed_remove_loose(git_repository
*repo
, git_vector
*packing_list
);
60 static int packed_sort(const void *a
, const void *b
);
61 static int packed_lookup(git_reference
*ref
);
62 static int packed_write(git_repository
*repo
);
64 /* internal helpers */
65 static int reference_path_available(git_repository
*repo
,
66 const char *ref
, const char *old_ref
);
67 static int reference_delete(git_reference
*ref
);
68 static int reference_lookup(git_reference
*ref
);
70 /* name normalization */
71 static int normalize_name(char *buffer_out
, size_t out_size
,
72 const char *name
, int is_oid_ref
);
75 void git_reference_free(git_reference
*reference
)
77 if (reference
== NULL
)
80 git__free(reference
->name
);
81 reference
->name
= NULL
;
83 if (reference
->flags
& GIT_REF_SYMBOLIC
) {
84 git__free(reference
->target
.symbolic
);
85 reference
->target
.symbolic
= NULL
;
91 static int reference_alloc(
92 git_reference
**ref_out
,
96 git_reference
*reference
= NULL
;
98 assert(ref_out
&& repo
&& name
);
100 reference
= git__malloc(sizeof(git_reference
));
101 GITERR_CHECK_ALLOC(reference
);
103 memset(reference
, 0x0, sizeof(git_reference
));
104 reference
->owner
= repo
;
106 reference
->name
= git__strdup(name
);
107 GITERR_CHECK_ALLOC(reference
->name
);
109 *ref_out
= reference
;
113 static int reference_read(
114 git_buf
*file_content
,
116 const char *repo_path
,
117 const char *ref_name
,
120 git_buf path
= GIT_BUF_INIT
;
123 assert(file_content
&& repo_path
&& ref_name
);
125 /* Determine the full path of the file */
126 if (git_buf_joinpath(&path
, repo_path
, ref_name
) < 0)
129 result
= git_futils_readbuffer_updated(file_content
, path
.ptr
, mtime
, updated
);
135 static int loose_parse_symbolic(git_reference
*ref
, git_buf
*file_content
)
137 const unsigned int header_len
= (unsigned int)strlen(GIT_SYMREF
);
138 const char *refname_start
;
140 refname_start
= (const char *)file_content
->ptr
;
142 if (git_buf_len(file_content
) < header_len
+ 1) {
143 giterr_set(GITERR_REFERENCE
, "Corrupted loose reference file");
148 * Assume we have already checked for the header
149 * before calling this function
151 refname_start
+= header_len
;
153 ref
->target
.symbolic
= git__strdup(refname_start
);
154 GITERR_CHECK_ALLOC(ref
->target
.symbolic
);
159 static int loose_parse_oid(git_oid
*oid
, git_buf
*file_content
)
161 /* File format: 40 chars (OID) */
162 if (git_buf_len(file_content
) == GIT_OID_HEXSZ
&&
163 git_oid_fromstr(oid
, git_buf_cstr(file_content
)) == 0)
166 giterr_set(GITERR_REFERENCE
, "Corrupted loose reference file");
170 static git_ref_t
loose_guess_rtype(const git_buf
*full_path
)
172 git_buf ref_file
= GIT_BUF_INIT
;
175 type
= GIT_REF_INVALID
;
177 if (git_futils_readbuffer(&ref_file
, full_path
->ptr
) == 0) {
178 if (git__prefixcmp((const char *)(ref_file
.ptr
), GIT_SYMREF
) == 0)
179 type
= GIT_REF_SYMBOLIC
;
184 git_buf_free(&ref_file
);
188 static int loose_lookup(git_reference
*ref
)
191 git_buf ref_file
= GIT_BUF_INIT
;
193 result
= reference_read(&ref_file
, &ref
->mtime
,
194 ref
->owner
->path_repository
, ref
->name
, &updated
);
202 git_buf_rtrim(&ref_file
);
204 if (ref
->flags
& GIT_REF_SYMBOLIC
) {
205 git__free(ref
->target
.symbolic
);
206 ref
->target
.symbolic
= NULL
;
211 if (git__prefixcmp((const char *)(ref_file
.ptr
), GIT_SYMREF
) == 0) {
212 ref
->flags
|= GIT_REF_SYMBOLIC
;
213 result
= loose_parse_symbolic(ref
, &ref_file
);
215 ref
->flags
|= GIT_REF_OID
;
216 result
= loose_parse_oid(&ref
->target
.oid
, &ref_file
);
219 git_buf_free(&ref_file
);
223 static int loose_lookup_to_packfile(
224 struct packref
**ref_out
,
225 git_repository
*repo
,
228 git_buf ref_file
= GIT_BUF_INIT
;
229 struct packref
*ref
= NULL
;
234 if (reference_read(&ref_file
, NULL
, repo
->path_repository
, name
, NULL
) < 0)
237 git_buf_rtrim(&ref_file
);
239 name_len
= strlen(name
);
240 ref
= git__malloc(sizeof(struct packref
) + name_len
+ 1);
241 GITERR_CHECK_ALLOC(ref
);
243 memcpy(ref
->name
, name
, name_len
);
244 ref
->name
[name_len
] = 0;
246 if (loose_parse_oid(&ref
->oid
, &ref_file
) < 0) {
247 git_buf_free(&ref_file
);
252 ref
->flags
= GIT_PACKREF_WAS_LOOSE
;
255 git_buf_free(&ref_file
);
259 static int loose_write(git_reference
*ref
)
261 git_filebuf file
= GIT_FILEBUF_INIT
;
262 git_buf ref_path
= GIT_BUF_INIT
;
265 if (git_buf_joinpath(&ref_path
, ref
->owner
->path_repository
, ref
->name
) < 0)
268 /* Remove a possibly existing empty directory hierarchy
269 * which name would collide with the reference name
271 if (git_path_isdir(git_buf_cstr(&ref_path
)) &&
272 (git_futils_rmdir_r(git_buf_cstr(&ref_path
), GIT_DIRREMOVAL_ONLY_EMPTY_DIRS
) < 0)) {
273 git_buf_free(&ref_path
);
277 if (git_filebuf_open(&file
, ref_path
.ptr
, GIT_FILEBUF_FORCE
) < 0) {
278 git_buf_free(&ref_path
);
282 git_buf_free(&ref_path
);
284 if (ref
->flags
& GIT_REF_OID
) {
285 char oid
[GIT_OID_HEXSZ
+ 1];
287 git_oid_fmt(oid
, &ref
->target
.oid
);
288 oid
[GIT_OID_HEXSZ
] = '\0';
290 git_filebuf_printf(&file
, "%s\n", oid
);
292 } else if (ref
->flags
& GIT_REF_SYMBOLIC
) {
293 git_filebuf_printf(&file
, GIT_SYMREF
"%s\n", ref
->target
.symbolic
);
295 assert(0); /* don't let this happen */
298 if (p_stat(ref_path
.ptr
, &st
) == 0)
299 ref
->mtime
= st
.st_mtime
;
301 return git_filebuf_commit(&file
, GIT_REFS_FILE_MODE
);
304 static int packed_parse_peel(
305 struct packref
*tag_ref
,
306 const char **buffer_out
,
307 const char *buffer_end
)
309 const char *buffer
= *buffer_out
+ 1;
311 assert(buffer
[-1] == '^');
313 /* Ensure it's not the first entry of the file */
317 /* Ensure reference is a tag */
318 if (git__prefixcmp(tag_ref
->name
, GIT_REFS_TAGS_DIR
) != 0)
321 if (buffer
+ GIT_OID_HEXSZ
>= buffer_end
)
324 /* Is this a valid object id? */
325 if (git_oid_fromstr(&tag_ref
->peel
, buffer
) < 0)
328 buffer
= buffer
+ GIT_OID_HEXSZ
;
335 *buffer_out
= buffer
+ 1;
339 giterr_set(GITERR_REFERENCE
, "The packed references file is corrupted");
343 static int packed_parse_oid(
344 struct packref
**ref_out
,
345 const char **buffer_out
,
346 const char *buffer_end
)
348 struct packref
*ref
= NULL
;
350 const char *buffer
= *buffer_out
;
351 const char *refname_begin
, *refname_end
;
356 refname_begin
= (buffer
+ GIT_OID_HEXSZ
+ 1);
357 if (refname_begin
>= buffer_end
|| refname_begin
[-1] != ' ')
360 /* Is this a valid object id? */
361 if (git_oid_fromstr(&id
, buffer
) < 0)
364 refname_end
= memchr(refname_begin
, '\n', buffer_end
- refname_begin
);
365 if (refname_end
== NULL
)
368 if (refname_end
[-1] == '\r')
371 refname_len
= refname_end
- refname_begin
;
373 ref
= git__malloc(sizeof(struct packref
) + refname_len
+ 1);
374 GITERR_CHECK_ALLOC(ref
);
376 memcpy(ref
->name
, refname_begin
, refname_len
);
377 ref
->name
[refname_len
] = 0;
379 git_oid_cpy(&ref
->oid
, &id
);
384 *buffer_out
= refname_end
+ 1;
390 giterr_set(GITERR_REFERENCE
, "The packed references file is corrupted");
394 static int packed_load(git_repository
*repo
)
397 git_buf packfile
= GIT_BUF_INIT
;
398 const char *buffer_start
, *buffer_end
;
399 git_refcache
*ref_cache
= &repo
->references
;
401 /* First we make sure we have allocated the hash table */
402 if (ref_cache
->packfile
== NULL
) {
403 ref_cache
->packfile
= git_strmap_alloc();
404 GITERR_CHECK_ALLOC(ref_cache
->packfile
);
407 result
= reference_read(&packfile
, &ref_cache
->packfile_time
,
408 repo
->path_repository
, GIT_PACKEDREFS_FILE
, &updated
);
411 * If we couldn't find the file, we need to clear the table and
412 * return. On any other error, we return that error. If everything
413 * went fine and the file wasn't updated, then there's nothing new
414 * for us here, so just return. Anything else means we need to
415 * refresh the packed refs.
417 if (result
== GIT_ENOTFOUND
) {
418 git_strmap_clear(ref_cache
->packfile
);
429 * At this point, we want to refresh the packed refs. We already
430 * have the contents in our buffer.
432 git_strmap_clear(ref_cache
->packfile
);
434 buffer_start
= (const char *)packfile
.ptr
;
435 buffer_end
= (const char *)(buffer_start
) + packfile
.size
;
437 while (buffer_start
< buffer_end
&& buffer_start
[0] == '#') {
438 buffer_start
= strchr(buffer_start
, '\n');
439 if (buffer_start
== NULL
)
445 while (buffer_start
< buffer_end
) {
447 struct packref
*ref
= NULL
;
449 if (packed_parse_oid(&ref
, &buffer_start
, buffer_end
) < 0)
452 if (buffer_start
[0] == '^') {
453 if (packed_parse_peel(ref
, &buffer_start
, buffer_end
) < 0)
457 git_strmap_insert(ref_cache
->packfile
, ref
->name
, ref
, err
);
462 git_buf_free(&packfile
);
466 git_strmap_free(ref_cache
->packfile
);
467 ref_cache
->packfile
= NULL
;
468 git_buf_free(&packfile
);
473 struct dirent_list_data
{
474 git_repository
*repo
;
475 size_t repo_path_len
;
476 unsigned int list_flags
;
478 int (*callback
)(const char *, void *);
479 void *callback_payload
;
483 static int _dirent_loose_listall(void *_data
, git_buf
*full_path
)
485 struct dirent_list_data
*data
= (struct dirent_list_data
*)_data
;
486 const char *file_path
= full_path
->ptr
+ data
->repo_path_len
;
488 if (git_path_isdir(full_path
->ptr
) == true)
489 return git_path_direach(full_path
, _dirent_loose_listall
, _data
);
491 /* do not add twice a reference that exists already in the packfile */
492 if ((data
->list_flags
& GIT_REF_PACKED
) != 0 &&
493 git_strmap_exists(data
->repo
->references
.packfile
, file_path
))
496 if (data
->list_flags
!= GIT_REF_LISTALL
) {
497 if ((data
->list_flags
& loose_guess_rtype(full_path
)) == 0)
498 return 0; /* we are filtering out this reference */
501 if (data
->callback(file_path
, data
->callback_payload
))
502 data
->callback_error
= GIT_EUSER
;
504 return data
->callback_error
;
507 static int _dirent_loose_load(void *data
, git_buf
*full_path
)
509 git_repository
*repository
= (git_repository
*)data
;
510 void *old_ref
= NULL
;
512 const char *file_path
;
515 if (git_path_isdir(full_path
->ptr
) == true)
516 return git_path_direach(full_path
, _dirent_loose_load
, repository
);
518 file_path
= full_path
->ptr
+ strlen(repository
->path_repository
);
520 if (loose_lookup_to_packfile(&ref
, repository
, file_path
) < 0)
524 repository
->references
.packfile
, ref
->name
, ref
, old_ref
, err
);
535 * Load all the loose references from the repository
536 * into the in-memory Packfile, and build a vector with
537 * all the references so it can be written back to
540 static int packed_loadloose(git_repository
*repository
)
542 git_buf refs_path
= GIT_BUF_INIT
;
545 /* the packfile must have been previously loaded! */
546 assert(repository
->references
.packfile
);
548 if (git_buf_joinpath(&refs_path
, repository
->path_repository
, GIT_REFS_DIR
) < 0)
552 * Load all the loose files from disk into the Packfile table.
553 * This will overwrite any old packed entries with their
554 * updated loose versions
556 result
= git_path_direach(&refs_path
, _dirent_loose_load
, repository
);
557 git_buf_free(&refs_path
);
563 * Write a single reference into a packfile
565 static int packed_write_ref(struct packref
*ref
, git_filebuf
*file
)
567 char oid
[GIT_OID_HEXSZ
+ 1];
569 git_oid_fmt(oid
, &ref
->oid
);
570 oid
[GIT_OID_HEXSZ
] = 0;
573 * For references that peel to an object in the repo, we must
574 * write the resulting peel on a separate line, e.g.
576 * 6fa8a902cc1d18527e1355773c86721945475d37 refs/tags/libgit2-0.4
577 * ^2ec0cb7959b0bf965d54f95453f5b4b34e8d3100
579 * This obviously only applies to tags.
580 * The required peels have already been loaded into `ref->peel_target`.
582 if (ref
->flags
& GIT_PACKREF_HAS_PEEL
) {
583 char peel
[GIT_OID_HEXSZ
+ 1];
584 git_oid_fmt(peel
, &ref
->peel
);
585 peel
[GIT_OID_HEXSZ
] = 0;
587 if (git_filebuf_printf(file
, "%s %s\n^%s\n", oid
, ref
->name
, peel
) < 0)
590 if (git_filebuf_printf(file
, "%s %s\n", oid
, ref
->name
) < 0)
598 * Find out what object this reference resolves to.
600 * For references that point to a 'big' tag (e.g. an
601 * actual tag object on the repository), we need to
602 * cache on the packfile the OID of the object to
603 * which that 'big tag' is pointing to.
605 static int packed_find_peel(git_repository
*repo
, struct packref
*ref
)
609 if (ref
->flags
& GIT_PACKREF_HAS_PEEL
)
613 * Only applies to tags, i.e. references
614 * in the /refs/tags folder
616 if (git__prefixcmp(ref
->name
, GIT_REFS_TAGS_DIR
) != 0)
620 * Find the tagged object in the repository
622 if (git_object_lookup(&object
, repo
, &ref
->oid
, GIT_OBJ_ANY
) < 0)
626 * If the tagged object is a Tag object, we need to resolve it;
627 * if the ref is actually a 'weak' ref, we don't need to resolve
630 if (git_object_type(object
) == GIT_OBJ_TAG
) {
631 git_tag
*tag
= (git_tag
*)object
;
634 * Find the object pointed at by this tag
636 git_oid_cpy(&ref
->peel
, git_tag_target_oid(tag
));
637 ref
->flags
|= GIT_PACKREF_HAS_PEEL
;
640 * The reference has now cached the resolved OID, and is
641 * marked at such. When written to the packfile, it'll be
642 * accompanied by this resolved oid
646 git_object_free(object
);
651 * Remove all loose references
653 * Once we have successfully written a packfile,
654 * all the loose references that were packed must be
657 * This is a dangerous method; make sure the packfile
658 * is well-written, because we are destructing references
661 static int packed_remove_loose(git_repository
*repo
, git_vector
*packing_list
)
664 git_buf full_path
= GIT_BUF_INIT
;
667 for (i
= 0; i
< packing_list
->length
; ++i
) {
668 struct packref
*ref
= git_vector_get(packing_list
, i
);
670 if ((ref
->flags
& GIT_PACKREF_WAS_LOOSE
) == 0)
673 if (git_buf_joinpath(&full_path
, repo
->path_repository
, ref
->name
) < 0)
674 return -1; /* critical; do not try to recover on oom */
676 if (git_path_exists(full_path
.ptr
) == true && p_unlink(full_path
.ptr
) < 0) {
680 giterr_set(GITERR_REFERENCE
,
681 "Failed to remove loose reference '%s' after packing: %s",
682 full_path
.ptr
, strerror(errno
));
688 * if we fail to remove a single file, this is *not* good,
689 * but we should keep going and remove as many as possible.
690 * After we've removed as many files as possible, we return
691 * the error code anyway.
695 git_buf_free(&full_path
);
696 return failed
? -1 : 0;
699 static int packed_sort(const void *a
, const void *b
)
701 const struct packref
*ref_a
= (const struct packref
*)a
;
702 const struct packref
*ref_b
= (const struct packref
*)b
;
704 return strcmp(ref_a
->name
, ref_b
->name
);
708 * Write all the contents in the in-memory packfile to disk.
710 static int packed_write(git_repository
*repo
)
712 git_filebuf pack_file
= GIT_FILEBUF_INIT
;
714 git_buf pack_file_path
= GIT_BUF_INIT
;
715 git_vector packing_list
;
716 unsigned int total_refs
;
718 assert(repo
&& repo
->references
.packfile
);
721 (unsigned int)git_strmap_num_entries(repo
->references
.packfile
);
723 if (git_vector_init(&packing_list
, total_refs
, packed_sort
) < 0)
726 /* Load all the packfile into a vector */
728 struct packref
*reference
;
730 /* cannot fail: vector already has the right size */
731 git_strmap_foreach_value(repo
->references
.packfile
, reference
, {
732 git_vector_insert(&packing_list
, reference
);
736 /* sort the vector so the entries appear sorted on the packfile */
737 git_vector_sort(&packing_list
);
739 /* Now we can open the file! */
740 if (git_buf_joinpath(&pack_file_path
, repo
->path_repository
, GIT_PACKEDREFS_FILE
) < 0)
743 if (git_filebuf_open(&pack_file
, pack_file_path
.ptr
, 0) < 0)
744 goto cleanup_packfile
;
746 /* Packfiles have a header... apparently
747 * This is in fact not required, but we might as well print it
749 if (git_filebuf_printf(&pack_file
, "%s\n", GIT_PACKEDREFS_HEADER
) < 0)
750 goto cleanup_packfile
;
752 for (i
= 0; i
< packing_list
.length
; ++i
) {
753 struct packref
*ref
= (struct packref
*)git_vector_get(&packing_list
, i
);
755 if (packed_find_peel(repo
, ref
) < 0)
756 goto cleanup_packfile
;
758 if (packed_write_ref(ref
, &pack_file
) < 0)
759 goto cleanup_packfile
;
762 /* if we've written all the references properly, we can commit
763 * the packfile to make the changes effective */
764 if (git_filebuf_commit(&pack_file
, GIT_PACKEDREFS_FILE_MODE
) < 0)
767 /* when and only when the packfile has been properly written,
768 * we can go ahead and remove the loose refs */
769 if (packed_remove_loose(repo
, &packing_list
) < 0)
774 if (p_stat(pack_file_path
.ptr
, &st
) == 0)
775 repo
->references
.packfile_time
= st
.st_mtime
;
778 git_vector_free(&packing_list
);
779 git_buf_free(&pack_file_path
);
785 git_filebuf_cleanup(&pack_file
);
788 git_vector_free(&packing_list
);
789 git_buf_free(&pack_file_path
);
794 struct reference_available_t
{
800 static int _reference_available_cb(const char *ref
, void *data
)
802 struct reference_available_t
*d
;
805 d
= (struct reference_available_t
*)data
;
807 if (!d
->old_ref
|| strcmp(d
->old_ref
, ref
)) {
808 size_t reflen
= strlen(ref
);
809 size_t newlen
= strlen(d
->new_ref
);
810 size_t cmplen
= reflen
< newlen
? reflen
: newlen
;
811 const char *lead
= reflen
< newlen
? d
->new_ref
: ref
;
813 if (!strncmp(d
->new_ref
, ref
, cmplen
) && lead
[cmplen
] == '/') {
822 static int reference_path_available(
823 git_repository
*repo
,
828 struct reference_available_t data
;
831 data
.old_ref
= old_ref
;
834 error
= git_reference_foreach(
835 repo
, GIT_REF_LISTALL
, _reference_available_cb
, (void *)&data
);
839 if (!data
.available
) {
840 giterr_set(GITERR_REFERENCE
,
841 "The path to reference '%s' collides with an existing one", ref
);
848 static int reference_exists(int *exists
, git_repository
*repo
, const char *ref_name
)
850 git_buf ref_path
= GIT_BUF_INIT
;
852 if (packed_load(repo
) < 0)
855 if (git_buf_joinpath(&ref_path
, repo
->path_repository
, ref_name
) < 0)
858 if (git_path_isfile(ref_path
.ptr
) == true ||
859 git_strmap_exists(repo
->references
.packfile
, ref_path
.ptr
))
866 git_buf_free(&ref_path
);
871 * Check if a reference could be written to disk, based on:
873 * - Whether a reference with the same name already exists,
874 * and we are allowing or disallowing overwrites
876 * - Whether the name of the reference would collide with
879 static int reference_can_write(
880 git_repository
*repo
,
882 const char *previous_name
,
885 /* see if the reference shares a path with an existing reference;
886 * if a path is shared, we cannot create the reference, even when forcing */
887 if (reference_path_available(repo
, refname
, previous_name
) < 0)
890 /* check if the reference actually exists, but only if we are not forcing
891 * the rename. If we are forcing, it's OK to overwrite */
895 if (reference_exists(&exists
, repo
, refname
) < 0)
898 /* We cannot proceed if the reference already exists and we're not forcing
899 * the rename; the existing one would be overwritten */
901 giterr_set(GITERR_REFERENCE
,
902 "A reference with that name (%s) already exists", refname
);
907 /* FIXME: if the reference exists and we are forcing, do we really need to
908 * remove the reference first?
912 * - the reference already exists and is loose: not a problem, the file
913 * gets overwritten on disk
915 * - the reference already exists and is packed: we write a new one as
916 * loose, which by all means renders the packed one useless
923 static int packed_lookup(git_reference
*ref
)
925 struct packref
*pack_ref
= NULL
;
926 git_strmap
*packfile_refs
;
929 if (packed_load(ref
->owner
) < 0)
932 /* maybe the packfile hasn't changed at all, so we don't
933 * have to re-lookup the reference */
934 if ((ref
->flags
& GIT_REF_PACKED
) &&
935 ref
->mtime
== ref
->owner
->references
.packfile_time
)
938 if (ref
->flags
& GIT_REF_SYMBOLIC
) {
939 git__free(ref
->target
.symbolic
);
940 ref
->target
.symbolic
= NULL
;
943 /* Look up on the packfile */
944 packfile_refs
= ref
->owner
->references
.packfile
;
945 pos
= git_strmap_lookup_index(packfile_refs
, ref
->name
);
946 if (!git_strmap_valid_index(packfile_refs
, pos
)) {
947 giterr_set(GITERR_REFERENCE
, "Reference '%s' not found", ref
->name
);
948 return GIT_ENOTFOUND
;
951 pack_ref
= git_strmap_value_at(packfile_refs
, pos
);
953 ref
->flags
= GIT_REF_OID
| GIT_REF_PACKED
;
954 ref
->mtime
= ref
->owner
->references
.packfile_time
;
955 git_oid_cpy(&ref
->target
.oid
, &pack_ref
->oid
);
960 static int reference_lookup(git_reference
*ref
)
964 result
= loose_lookup(ref
);
968 /* only try to lookup this reference on the packfile if it
969 * wasn't found on the loose refs; not if there was a critical error */
970 if (result
== GIT_ENOTFOUND
) {
972 result
= packed_lookup(ref
);
977 /* unexpected error; free the reference */
978 git_reference_free(ref
);
983 * Delete a reference.
984 * This is an internal method; the reference is removed
985 * from disk or the packfile, but the pointer is not freed
987 static int reference_delete(git_reference
*ref
)
993 /* If the reference is packed, this is an expensive operation.
994 * We need to reload the packfile, remove the reference from the
995 * packing list, and repack */
996 if (ref
->flags
& GIT_REF_PACKED
) {
997 git_strmap
*packfile_refs
;
998 struct packref
*packref
;
1001 /* load the existing packfile */
1002 if (packed_load(ref
->owner
) < 0)
1005 packfile_refs
= ref
->owner
->references
.packfile
;
1006 pos
= git_strmap_lookup_index(packfile_refs
, ref
->name
);
1007 if (!git_strmap_valid_index(packfile_refs
, pos
)) {
1008 giterr_set(GITERR_REFERENCE
,
1009 "Reference %s stopped existing in the packfile", ref
->name
);
1013 packref
= git_strmap_value_at(packfile_refs
, pos
);
1014 git_strmap_delete_at(packfile_refs
, pos
);
1017 if (packed_write(ref
->owner
) < 0)
1020 /* If the reference is loose, we can just remove the reference
1021 * from the filesystem */
1023 git_reference
*ref_in_pack
;
1024 git_buf full_path
= GIT_BUF_INIT
;
1026 if (git_buf_joinpath(&full_path
, ref
->owner
->path_repository
, ref
->name
) < 0)
1029 result
= p_unlink(full_path
.ptr
);
1030 git_buf_free(&full_path
); /* done with path at this point */
1033 giterr_set(GITERR_OS
, "Failed to unlink '%s'", full_path
.ptr
);
1037 /* When deleting a loose reference, we have to ensure that an older
1038 * packed version of it doesn't exist */
1039 if (git_reference_lookup(&ref_in_pack
, ref
->owner
, ref
->name
) == 0) {
1040 assert((ref_in_pack
->flags
& GIT_REF_PACKED
) != 0);
1041 return git_reference_delete(ref_in_pack
);
1050 int git_reference_delete(git_reference
*ref
)
1052 int result
= reference_delete(ref
);
1053 git_reference_free(ref
);
1057 int git_reference_lookup(git_reference
**ref_out
,
1058 git_repository
*repo
, const char *name
)
1060 return git_reference_lookup_resolved(ref_out
, repo
, name
, 0);
1063 int git_reference_name_to_oid(
1064 git_oid
*out
, git_repository
*repo
, const char *name
)
1069 if ((error
= git_reference_lookup_resolved(&ref
, repo
, name
, -1)) < 0)
1072 git_oid_cpy(out
, git_reference_oid(ref
));
1073 git_reference_free(ref
);
1077 int git_reference_lookup_resolved(
1078 git_reference
**ref_out
,
1079 git_repository
*repo
,
1083 git_reference
*scan
;
1084 int result
, nesting
;
1086 assert(ref_out
&& repo
&& name
);
1090 if (max_nesting
> MAX_NESTING_LEVEL
)
1091 max_nesting
= MAX_NESTING_LEVEL
;
1092 else if (max_nesting
< 0)
1093 max_nesting
= DEFAULT_NESTING_LEVEL
;
1095 scan
= git__calloc(1, sizeof(git_reference
));
1096 GITERR_CHECK_ALLOC(scan
);
1098 scan
->name
= git__calloc(GIT_REFNAME_MAX
+ 1, sizeof(char));
1099 GITERR_CHECK_ALLOC(scan
->name
);
1101 if ((result
= normalize_name(scan
->name
, GIT_REFNAME_MAX
, name
, 0)) < 0) {
1102 git_reference_free(scan
);
1106 scan
->target
.symbolic
= git__strdup(scan
->name
);
1107 GITERR_CHECK_ALLOC(scan
->target
.symbolic
);
1110 scan
->flags
= GIT_REF_SYMBOLIC
;
1112 for (nesting
= max_nesting
;
1113 nesting
>= 0 && (scan
->flags
& GIT_REF_SYMBOLIC
) != 0;
1116 if (nesting
!= max_nesting
)
1117 strncpy(scan
->name
, scan
->target
.symbolic
, GIT_REFNAME_MAX
);
1121 if ((result
= reference_lookup(scan
)) < 0)
1122 return result
; /* lookup git_reference_free on scan already */
1125 if ((scan
->flags
& GIT_REF_OID
) == 0 && max_nesting
!= 0) {
1126 giterr_set(GITERR_REFERENCE
,
1127 "Cannot resolve reference (>%u levels deep)", max_nesting
);
1128 git_reference_free(scan
);
1139 git_ref_t
git_reference_type(git_reference
*ref
)
1143 if (ref
->flags
& GIT_REF_OID
)
1146 if (ref
->flags
& GIT_REF_SYMBOLIC
)
1147 return GIT_REF_SYMBOLIC
;
1149 return GIT_REF_INVALID
;
1152 int git_reference_is_packed(git_reference
*ref
)
1155 return !!(ref
->flags
& GIT_REF_PACKED
);
1158 const char *git_reference_name(git_reference
*ref
)
1164 git_repository
*git_reference_owner(git_reference
*ref
)
1170 const git_oid
*git_reference_oid(git_reference
*ref
)
1174 if ((ref
->flags
& GIT_REF_OID
) == 0)
1177 return &ref
->target
.oid
;
1180 const char *git_reference_target(git_reference
*ref
)
1184 if ((ref
->flags
& GIT_REF_SYMBOLIC
) == 0)
1187 return ref
->target
.symbolic
;
1190 int git_reference_create_symbolic(
1191 git_reference
**ref_out
,
1192 git_repository
*repo
,
1197 char normalized
[GIT_REFNAME_MAX
];
1198 git_reference
*ref
= NULL
;
1200 if (normalize_name(normalized
, sizeof(normalized
), name
, 0) < 0)
1203 if (reference_can_write(repo
, normalized
, NULL
, force
) < 0)
1206 if (reference_alloc(&ref
, repo
, normalized
) < 0)
1209 ref
->flags
|= GIT_REF_SYMBOLIC
;
1211 /* set the target; this will normalize the name automatically
1212 * and write the reference on disk */
1213 if (git_reference_set_target(ref
, target
) < 0) {
1214 git_reference_free(ref
);
1217 if (ref_out
== NULL
) {
1218 git_reference_free(ref
);
1226 int git_reference_create_oid(
1227 git_reference
**ref_out
,
1228 git_repository
*repo
,
1233 git_reference
*ref
= NULL
;
1234 char normalized
[GIT_REFNAME_MAX
];
1236 if (normalize_name(normalized
, sizeof(normalized
), name
, 1) < 0)
1239 if (reference_can_write(repo
, normalized
, NULL
, force
) < 0)
1242 if (reference_alloc(&ref
, repo
, name
) < 0)
1245 ref
->flags
|= GIT_REF_OID
;
1247 /* set the oid; this will write the reference on disk */
1248 if (git_reference_set_oid(ref
, id
) < 0) {
1249 git_reference_free(ref
);
1253 if (ref_out
== NULL
) {
1254 git_reference_free(ref
);
1262 * Change the OID target of a reference.
1264 * For both loose and packed references, just change
1265 * the oid in memory and (over)write the file in disk.
1267 * We do not repack packed references because of performance
1270 int git_reference_set_oid(git_reference
*ref
, const git_oid
*id
)
1272 git_odb
*odb
= NULL
;
1274 if ((ref
->flags
& GIT_REF_OID
) == 0) {
1275 giterr_set(GITERR_REFERENCE
, "Cannot set OID on symbolic reference");
1281 if (git_repository_odb__weakptr(&odb
, ref
->owner
) < 0)
1284 /* Don't let the user create references to OIDs that
1285 * don't exist in the ODB */
1286 if (!git_odb_exists(odb
, id
)) {
1287 giterr_set(GITERR_REFERENCE
,
1288 "Target OID for the reference doesn't exist on the repository");
1292 /* Update the OID value on `ref` */
1293 git_oid_cpy(&ref
->target
.oid
, id
);
1295 /* Write back to disk */
1296 return loose_write(ref
);
1300 * Change the target of a symbolic reference.
1302 * This is easy because symrefs cannot be inside
1303 * a pack. We just change the target in memory
1304 * and overwrite the file on disk.
1306 int git_reference_set_target(git_reference
*ref
, const char *target
)
1308 char normalized
[GIT_REFNAME_MAX
];
1310 if ((ref
->flags
& GIT_REF_SYMBOLIC
) == 0) {
1311 giterr_set(GITERR_REFERENCE
,
1312 "Cannot set symbolic target on a direct reference");
1316 if (normalize_name(normalized
, sizeof(normalized
), target
, 0))
1319 git__free(ref
->target
.symbolic
);
1320 ref
->target
.symbolic
= git__strdup(normalized
);
1321 GITERR_CHECK_ALLOC(ref
->target
.symbolic
);
1323 return loose_write(ref
);
1326 int git_reference_rename(git_reference
*ref
, const char *new_name
, int force
)
1329 git_buf aux_path
= GIT_BUF_INIT
;
1330 char normalized
[GIT_REFNAME_MAX
];
1332 const char *head_target
= NULL
;
1333 git_reference
*head
= NULL
;
1335 if (normalize_name(normalized
, sizeof(normalized
),
1336 new_name
, ref
->flags
& GIT_REF_OID
) < 0)
1339 if (reference_can_write(ref
->owner
, normalized
, ref
->name
, force
) < 0)
1342 /* Initialize path now so we won't get an allocation failure once
1343 * we actually start removing things. */
1344 if (git_buf_joinpath(&aux_path
, ref
->owner
->path_repository
, new_name
) < 0)
1348 * Now delete the old ref and remove an possibly existing directory
1349 * named `new_name`. Note that using the internal `reference_delete`
1350 * method deletes the ref from disk but doesn't free the pointer, so
1351 * we can still access the ref's attributes for creating the new one
1353 if (reference_delete(ref
) < 0)
1357 * Finally we can create the new reference.
1359 if (ref
->flags
& GIT_REF_SYMBOLIC
) {
1360 result
= git_reference_create_symbolic(
1361 NULL
, ref
->owner
, new_name
, ref
->target
.symbolic
, force
);
1363 result
= git_reference_create_oid(
1364 NULL
, ref
->owner
, new_name
, &ref
->target
.oid
, force
);
1371 * Check if we have to update HEAD.
1373 if (git_reference_lookup(&head
, ref
->owner
, GIT_HEAD_FILE
) < 0) {
1374 giterr_set(GITERR_REFERENCE
,
1375 "Failed to update HEAD after renaming reference");
1379 head_target
= git_reference_target(head
);
1381 if (head_target
&& !strcmp(head_target
, ref
->name
)) {
1382 git_reference_free(head
);
1385 if (git_reference_create_symbolic(&head
, ref
->owner
, "HEAD", new_name
, 1) < 0) {
1386 giterr_set(GITERR_REFERENCE
,
1387 "Failed to update HEAD after renaming reference");
1393 * Rename the reflog file, if it exists.
1395 if ((git_reference_has_log(ref
)) && (git_reflog_rename(ref
, new_name
) < 0))
1399 * Change the name of the reference given by the user.
1401 git__free(ref
->name
);
1402 ref
->name
= git__strdup(new_name
);
1404 /* The reference is no longer packed */
1405 ref
->flags
&= ~GIT_REF_PACKED
;
1407 git_reference_free(head
);
1408 git_buf_free(&aux_path
);
1412 git_reference_free(head
);
1413 git_buf_free(&aux_path
);
1418 * Try to create the old reference again, ignore failures
1420 if (ref
->flags
& GIT_REF_SYMBOLIC
)
1421 git_reference_create_symbolic(
1422 NULL
, ref
->owner
, ref
->name
, ref
->target
.symbolic
, 0);
1424 git_reference_create_oid(
1425 NULL
, ref
->owner
, ref
->name
, &ref
->target
.oid
, 0);
1427 /* The reference is no longer packed */
1428 ref
->flags
&= ~GIT_REF_PACKED
;
1430 git_buf_free(&aux_path
);
1434 int git_reference_resolve(git_reference
**ref_out
, git_reference
*ref
)
1436 if (ref
->flags
& GIT_REF_OID
)
1437 return git_reference_lookup(ref_out
, ref
->owner
, ref
->name
);
1439 return git_reference_lookup_resolved(ref_out
, ref
->owner
, ref
->target
.symbolic
, -1);
1442 int git_reference_packall(git_repository
*repo
)
1444 if (packed_load(repo
) < 0 || /* load the existing packfile */
1445 packed_loadloose(repo
) < 0 || /* add all the loose refs */
1446 packed_write(repo
) < 0) /* write back to disk */
1452 int git_reference_foreach(
1453 git_repository
*repo
,
1454 unsigned int list_flags
,
1455 int (*callback
)(const char *, void *),
1459 struct dirent_list_data data
;
1460 git_buf refs_path
= GIT_BUF_INIT
;
1462 /* list all the packed references first */
1463 if (list_flags
& GIT_REF_PACKED
) {
1464 const char *ref_name
;
1468 if (packed_load(repo
) < 0)
1471 git_strmap_foreach(repo
->references
.packfile
, ref_name
, ref
, {
1472 if (callback(ref_name
, payload
))
1477 /* now list the loose references, trying not to
1478 * duplicate the ref names already in the packed-refs file */
1480 data
.repo_path_len
= strlen(repo
->path_repository
);
1481 data
.list_flags
= list_flags
;
1483 data
.callback
= callback
;
1484 data
.callback_payload
= payload
;
1485 data
.callback_error
= 0;
1487 if (git_buf_joinpath(&refs_path
, repo
->path_repository
, GIT_REFS_DIR
) < 0)
1490 result
= git_path_direach(&refs_path
, _dirent_loose_listall
, &data
);
1492 git_buf_free(&refs_path
);
1494 return data
.callback_error
? GIT_EUSER
: result
;
1497 static int cb__reflist_add(const char *ref
, void *data
)
1499 return git_vector_insert((git_vector
*)data
, git__strdup(ref
));
1502 int git_reference_list(
1503 git_strarray
*array
,
1504 git_repository
*repo
,
1505 unsigned int list_flags
)
1507 git_vector ref_list
;
1509 assert(array
&& repo
);
1511 array
->strings
= NULL
;
1514 if (git_vector_init(&ref_list
, 8, NULL
) < 0)
1517 if (git_reference_foreach(
1518 repo
, list_flags
, &cb__reflist_add
, (void *)&ref_list
) < 0) {
1519 git_vector_free(&ref_list
);
1523 array
->strings
= (char **)ref_list
.contents
;
1524 array
->count
= ref_list
.length
;
1528 int git_reference_reload(git_reference
*ref
)
1530 return reference_lookup(ref
);
1533 void git_repository__refcache_free(git_refcache
*refs
)
1537 if (refs
->packfile
) {
1538 struct packref
*reference
;
1540 git_strmap_foreach_value(refs
->packfile
, reference
, {
1541 git__free(reference
);
1544 git_strmap_free(refs
->packfile
);
1548 static int is_valid_ref_char(char ch
)
1550 if ((unsigned) ch
<= ' ')
1567 static int normalize_name(
1573 const char *name_end
, *buffer_out_start
;
1574 const char *current
;
1575 int contains_a_slash
= 0;
1577 assert(name
&& buffer_out
);
1579 buffer_out_start
= buffer_out
;
1581 name_end
= name
+ strlen(name
);
1583 /* Terminating null byte */
1586 /* A refname can not be empty */
1587 if (name_end
== name
)
1590 /* A refname can not end with a dot or a slash */
1591 if (*(name_end
- 1) == '.' || *(name_end
- 1) == '/')
1594 while (current
< name_end
&& out_size
) {
1595 if (!is_valid_ref_char(*current
))
1598 if (buffer_out
> buffer_out_start
) {
1599 char prev
= *(buffer_out
- 1);
1601 /* A refname can not start with a dot nor contain a double dot */
1602 if (*current
== '.' && ((prev
== '.') || (prev
== '/')))
1605 /* '@{' is forbidden within a refname */
1606 if (*current
== '{' && prev
== '@')
1609 /* Prevent multiple slashes from being added to the output */
1610 if (*current
== '/' && prev
== '/') {
1616 if (*current
== '/')
1617 contains_a_slash
= 1;
1619 *buffer_out
++ = *current
++;
1626 /* Object id refname have to contain at least one slash, except
1627 * for HEAD in a detached state or MERGE_HEAD if we're in the
1628 * middle of a merge */
1630 !contains_a_slash
&&
1631 strcmp(name
, GIT_HEAD_FILE
) != 0 &&
1632 strcmp(name
, GIT_MERGE_HEAD_FILE
) != 0 &&
1633 strcmp(name
, GIT_FETCH_HEAD_FILE
) != 0)
1636 /* A refname can not end with ".lock" */
1637 if (!git__suffixcmp(name
, GIT_FILELOCK_EXTENSION
))
1643 * For object id references, name has to start with refs/. Again,
1644 * we need to allow HEAD to be in a detached state.
1646 if (is_oid_ref
&& !(git__prefixcmp(buffer_out_start
, GIT_REFS_DIR
) ||
1647 strcmp(buffer_out_start
, GIT_HEAD_FILE
)))
1653 giterr_set(GITERR_REFERENCE
, "The given reference name is not valid");
1657 int git_reference__normalize_name(
1662 return normalize_name(buffer_out
, out_size
, name
, 0);
1665 int git_reference__normalize_name_oid(
1670 return normalize_name(buffer_out
, out_size
, name
, 1);
1673 #define GIT_REF_TYPEMASK (GIT_REF_OID | GIT_REF_SYMBOLIC)
1675 int git_reference_cmp(git_reference
*ref1
, git_reference
*ref2
)
1677 assert(ref1
&& ref2
);
1679 /* let's put symbolic refs before OIDs */
1680 if ((ref1
->flags
& GIT_REF_TYPEMASK
) != (ref2
->flags
& GIT_REF_TYPEMASK
))
1681 return (ref1
->flags
& GIT_REF_SYMBOLIC
) ? -1 : 1;
1683 if (ref1
->flags
& GIT_REF_SYMBOLIC
)
1684 return strcmp(ref1
->target
.symbolic
, ref2
->target
.symbolic
);
1686 return git_oid_cmp(&ref1
->target
.oid
, &ref2
->target
.oid
);
1689 /* Update the reference named `ref_name` so it points to `oid` */
1690 int git_reference__update(git_repository
*repo
, const git_oid
*oid
, const char *ref_name
)
1695 res
= git_reference_lookup(&ref
, repo
, ref_name
);
1697 /* If we haven't found the reference at all, we assume we need to create
1698 * a new reference and that's it */
1699 if (res
== GIT_ENOTFOUND
) {
1701 return git_reference_create_oid(NULL
, repo
, ref_name
, oid
, 1);
1707 /* If we have found a reference, but it's symbolic, we need to update
1708 * the direct reference it points to */
1709 if (git_reference_type(ref
) == GIT_REF_SYMBOLIC
) {
1711 const char *sym_target
;
1713 /* The target pointed at by this reference */
1714 sym_target
= git_reference_target(ref
);
1716 /* resolve the reference to the target it points to */
1717 res
= git_reference_resolve(&aux
, ref
);
1720 * if the symbolic reference pointed to an inexisting ref,
1721 * this is means we're creating a new branch, for example.
1722 * We need to create a new direct reference with that name
1724 if (res
== GIT_ENOTFOUND
) {
1726 res
= git_reference_create_oid(NULL
, repo
, sym_target
, oid
, 1);
1727 git_reference_free(ref
);
1731 /* free the original symbolic reference now; not before because
1732 * we're using the `sym_target` pointer */
1733 git_reference_free(ref
);
1738 /* store the newly found direct reference in its place */
1742 /* ref is made to point to `oid`: ref is either the original reference,
1743 * or the target of the symbolic reference we've looked up */
1744 res
= git_reference_set_oid(ref
, oid
);
1745 git_reference_free(ref
);
1749 struct glob_cb_data
{
1751 int (*callback
)(const char *, void *);
1755 static int fromglob_cb(const char *reference_name
, void *payload
)
1757 struct glob_cb_data
*data
= (struct glob_cb_data
*)payload
;
1759 if (!p_fnmatch(data
->glob
, reference_name
, 0))
1760 return data
->callback(reference_name
, data
->payload
);
1765 int git_reference_foreach_glob(
1766 git_repository
*repo
,
1768 unsigned int list_flags
,
1770 const char *reference_name
,
1774 struct glob_cb_data data
;
1776 assert(repo
&& glob
&& callback
);
1779 data
.callback
= callback
;
1780 data
.payload
= payload
;
1782 return git_reference_foreach(
1783 repo
, list_flags
, fromglob_cb
, &data
);
1786 int git_reference_has_log(
1789 git_buf path
= GIT_BUF_INIT
;
1794 if (git_buf_join_n(&path
, '/', 3, ref
->owner
->path_repository
, GIT_REFLOG_DIR
, ref
->name
) < 0)
1797 result
= git_path_isfile(git_buf_cstr(&path
));
1798 git_buf_free(&path
);
1803 int git_reference_is_branch(git_reference
*ref
)
1807 return git__prefixcmp(ref
->name
, GIT_REFS_HEADS_DIR
) == 0;