2 * The backend-independent part of the reference module.
11 #include "refs/refs-internal.h"
14 #include "submodule.h"
18 * List of all available backends
20 static struct ref_storage_be
*refs_backends
= &refs_be_files
;
22 static struct ref_storage_be
*find_ref_storage_backend(const char *name
)
24 struct ref_storage_be
*be
;
25 for (be
= refs_backends
; be
; be
= be
->next
)
26 if (!strcmp(be
->name
, name
))
31 int ref_storage_backend_exists(const char *name
)
33 return find_ref_storage_backend(name
) != NULL
;
37 * How to handle various characters in refnames:
38 * 0: An acceptable character for refs
40 * 2: ., look for a preceding . to reject .. in refs
41 * 3: {, look for a preceding @ to reject @{ in refs
42 * 4: A bad character: ASCII control characters, and
43 * ":", "?", "[", "\", "^", "~", SP, or TAB
44 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
46 static unsigned char refname_disposition
[256] = {
47 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
48 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
49 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
50 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
51 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
52 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
58 * Try to read one refname component from the front of refname.
59 * Return the length of the component found, or -1 if the component is
60 * not legal. It is legal if it is something reasonable to have under
61 * ".git/refs/"; We do not like it if:
63 * - any path component of it begins with ".", or
64 * - it has double dots "..", or
65 * - it has ASCII control characters, or
66 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
67 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
68 * - it ends with a "/", or
69 * - it ends with ".lock", or
70 * - it contains a "@{" portion
72 static int check_refname_component(const char *refname
, int *flags
)
77 for (cp
= refname
; ; cp
++) {
79 unsigned char disp
= refname_disposition
[ch
];
85 return -1; /* Refname contains "..". */
89 return -1; /* Refname contains "@{". */
94 if (!(*flags
& REFNAME_REFSPEC_PATTERN
))
95 return -1; /* refspec can't be a pattern */
98 * Unset the pattern flag so that we only accept
99 * a single asterisk for one side of refspec.
101 *flags
&= ~ REFNAME_REFSPEC_PATTERN
;
108 return 0; /* Component has zero length. */
109 if (refname
[0] == '.')
110 return -1; /* Component starts with '.'. */
111 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
112 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
113 return -1; /* Refname ends with ".lock". */
117 int check_refname_format(const char *refname
, int flags
)
119 int component_len
, component_count
= 0;
121 if (!strcmp(refname
, "@"))
122 /* Refname is a single character '@'. */
126 /* We are at the start of a path component. */
127 component_len
= check_refname_component(refname
, &flags
);
128 if (component_len
<= 0)
132 if (refname
[component_len
] == '\0')
134 /* Skip to next component. */
135 refname
+= component_len
+ 1;
138 if (refname
[component_len
- 1] == '.')
139 return -1; /* Refname ends with '.'. */
140 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
141 return -1; /* Refname has only one component. */
145 int refname_is_safe(const char *refname
)
149 if (skip_prefix(refname
, "refs/", &rest
)) {
152 size_t restlen
= strlen(rest
);
154 /* rest must not be empty, or start or end with "/" */
155 if (!restlen
|| *rest
== '/' || rest
[restlen
- 1] == '/')
159 * Does the refname try to escape refs/?
160 * For example: refs/foo/../bar is safe but refs/foo/../../bar
163 buf
= xmallocz(restlen
);
164 result
= !normalize_path_copy(buf
, rest
) && !strcmp(buf
, rest
);
170 if (!isupper(*refname
) && *refname
!= '_')
178 * Return true if refname, which has the specified oid and flags, can
179 * be resolved to an object in the database. If the referred-to object
180 * does not exist, emit a warning and return false.
182 int ref_resolves_to_object(const char *refname
,
183 const struct object_id
*oid
,
186 if (flags
& REF_ISBROKEN
)
188 if (!has_sha1_file(oid
->hash
)) {
189 error("%s does not point to a valid object!", refname
);
195 char *refs_resolve_refdup(struct ref_store
*refs
,
196 const char *refname
, int resolve_flags
,
197 struct object_id
*oid
, int *flags
)
201 result
= refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
,
203 return xstrdup_or_null(result
);
206 char *resolve_refdup(const char *refname
, int resolve_flags
,
207 struct object_id
*oid
, int *flags
)
209 return refs_resolve_refdup(get_main_ref_store(),
210 refname
, resolve_flags
,
214 /* The argument to filter_refs */
221 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
222 int resolve_flags
, struct object_id
*oid
, int *flags
)
224 if (refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
, oid
->hash
, flags
))
229 int read_ref_full(const char *refname
, int resolve_flags
, struct object_id
*oid
, int *flags
)
231 return refs_read_ref_full(get_main_ref_store(), refname
,
232 resolve_flags
, oid
, flags
);
235 int read_ref(const char *refname
, struct object_id
*oid
)
237 return read_ref_full(refname
, RESOLVE_REF_READING
, oid
, NULL
);
240 int ref_exists(const char *refname
)
242 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, NULL
, NULL
);
245 static int filter_refs(const char *refname
, const struct object_id
*oid
,
246 int flags
, void *data
)
248 struct ref_filter
*filter
= (struct ref_filter
*)data
;
250 if (wildmatch(filter
->pattern
, refname
, 0))
252 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
255 enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
257 struct object
*o
= lookup_unknown_object(name
);
259 if (o
->type
== OBJ_NONE
) {
260 int type
= sha1_object_info(name
, NULL
);
261 if (type
< 0 || !object_as_type(o
, type
, 0))
265 if (o
->type
!= OBJ_TAG
)
268 o
= deref_tag_noverify(o
);
272 hashcpy(sha1
, o
->oid
.hash
);
276 struct warn_if_dangling_data
{
279 const struct string_list
*refnames
;
283 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
284 int flags
, void *cb_data
)
286 struct warn_if_dangling_data
*d
= cb_data
;
287 const char *resolves_to
;
289 if (!(flags
& REF_ISSYMREF
))
292 resolves_to
= resolve_ref_unsafe(refname
, 0, NULL
, NULL
);
295 ? strcmp(resolves_to
, d
->refname
)
296 : !string_list_has_string(d
->refnames
, resolves_to
))) {
300 fprintf(d
->fp
, d
->msg_fmt
, refname
);
305 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
307 struct warn_if_dangling_data data
;
310 data
.refname
= refname
;
311 data
.refnames
= NULL
;
312 data
.msg_fmt
= msg_fmt
;
313 for_each_rawref(warn_if_dangling_symref
, &data
);
316 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
318 struct warn_if_dangling_data data
;
322 data
.refnames
= refnames
;
323 data
.msg_fmt
= msg_fmt
;
324 for_each_rawref(warn_if_dangling_symref
, &data
);
327 int refs_for_each_tag_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
329 return refs_for_each_ref_in(refs
, "refs/tags/", fn
, cb_data
);
332 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
334 return refs_for_each_tag_ref(get_main_ref_store(), fn
, cb_data
);
337 int refs_for_each_branch_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
339 return refs_for_each_ref_in(refs
, "refs/heads/", fn
, cb_data
);
342 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
344 return refs_for_each_branch_ref(get_main_ref_store(), fn
, cb_data
);
347 int refs_for_each_remote_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
349 return refs_for_each_ref_in(refs
, "refs/remotes/", fn
, cb_data
);
352 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
354 return refs_for_each_remote_ref(get_main_ref_store(), fn
, cb_data
);
357 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
359 struct strbuf buf
= STRBUF_INIT
;
361 struct object_id oid
;
364 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
365 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, &oid
, &flag
))
366 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
367 strbuf_release(&buf
);
372 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
373 const char *prefix
, void *cb_data
)
375 struct strbuf real_pattern
= STRBUF_INIT
;
376 struct ref_filter filter
;
379 if (!prefix
&& !starts_with(pattern
, "refs/"))
380 strbuf_addstr(&real_pattern
, "refs/");
382 strbuf_addstr(&real_pattern
, prefix
);
383 strbuf_addstr(&real_pattern
, pattern
);
385 if (!has_glob_specials(pattern
)) {
386 /* Append implied '/' '*' if not present. */
387 strbuf_complete(&real_pattern
, '/');
388 /* No need to check for '*', there is none. */
389 strbuf_addch(&real_pattern
, '*');
392 filter
.pattern
= real_pattern
.buf
;
394 filter
.cb_data
= cb_data
;
395 ret
= for_each_ref(filter_refs
, &filter
);
397 strbuf_release(&real_pattern
);
401 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
403 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
406 const char *prettify_refname(const char *name
)
408 if (skip_prefix(name
, "refs/heads/", &name
) ||
409 skip_prefix(name
, "refs/tags/", &name
) ||
410 skip_prefix(name
, "refs/remotes/", &name
))
415 static const char *ref_rev_parse_rules
[] = {
421 "refs/remotes/%.*s/HEAD",
425 int refname_match(const char *abbrev_name
, const char *full_name
)
428 const int abbrev_name_len
= strlen(abbrev_name
);
430 for (p
= ref_rev_parse_rules
; *p
; p
++) {
431 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
440 * *string and *len will only be substituted, and *string returned (for
441 * later free()ing) if the string passed in is a magic short-hand form
444 static char *substitute_branch_name(const char **string
, int *len
)
446 struct strbuf buf
= STRBUF_INIT
;
447 int ret
= interpret_branch_name(*string
, *len
, &buf
, 0);
451 *string
= strbuf_detach(&buf
, &size
);
453 return (char *)*string
;
459 int dwim_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
461 char *last_branch
= substitute_branch_name(&str
, &len
);
462 int refs_found
= expand_ref(str
, len
, oid
, ref
);
467 int expand_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
471 struct strbuf fullref
= STRBUF_INIT
;
474 for (p
= ref_rev_parse_rules
; *p
; p
++) {
475 struct object_id oid_from_ref
;
476 struct object_id
*this_result
;
479 this_result
= refs_found
? &oid_from_ref
: oid
;
480 strbuf_reset(&fullref
);
481 strbuf_addf(&fullref
, *p
, len
, str
);
482 r
= resolve_ref_unsafe(fullref
.buf
, RESOLVE_REF_READING
,
483 this_result
? this_result
->hash
: NULL
,
488 if (!warn_ambiguous_refs
)
490 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
.buf
, "HEAD")) {
491 warning("ignoring dangling symref %s.", fullref
.buf
);
492 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
.buf
, '/')) {
493 warning("ignoring broken ref %s.", fullref
.buf
);
496 strbuf_release(&fullref
);
500 int dwim_log(const char *str
, int len
, struct object_id
*oid
, char **log
)
502 char *last_branch
= substitute_branch_name(&str
, &len
);
505 struct strbuf path
= STRBUF_INIT
;
508 for (p
= ref_rev_parse_rules
; *p
; p
++) {
509 struct object_id hash
;
510 const char *ref
, *it
;
513 strbuf_addf(&path
, *p
, len
, str
);
514 ref
= resolve_ref_unsafe(path
.buf
, RESOLVE_REF_READING
,
518 if (reflog_exists(path
.buf
))
520 else if (strcmp(ref
, path
.buf
) && reflog_exists(ref
))
528 if (!warn_ambiguous_refs
)
531 strbuf_release(&path
);
536 static int is_per_worktree_ref(const char *refname
)
538 return !strcmp(refname
, "HEAD") ||
539 starts_with(refname
, "refs/bisect/");
542 static int is_pseudoref_syntax(const char *refname
)
546 for (c
= refname
; *c
; c
++) {
547 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
554 enum ref_type
ref_type(const char *refname
)
556 if (is_per_worktree_ref(refname
))
557 return REF_TYPE_PER_WORKTREE
;
558 if (is_pseudoref_syntax(refname
))
559 return REF_TYPE_PSEUDOREF
;
560 return REF_TYPE_NORMAL
;
563 long get_files_ref_lock_timeout_ms(void)
565 static int configured
= 0;
567 /* The default timeout is 100 ms: */
568 static int timeout_ms
= 100;
571 git_config_get_int("core.filesreflocktimeout", &timeout_ms
);
578 static int write_pseudoref(const char *pseudoref
, const struct object_id
*oid
,
579 const struct object_id
*old_oid
, struct strbuf
*err
)
581 const char *filename
;
583 static struct lock_file lock
;
584 struct strbuf buf
= STRBUF_INIT
;
590 strbuf_addf(&buf
, "%s\n", oid_to_hex(oid
));
592 filename
= git_path("%s", pseudoref
);
593 fd
= hold_lock_file_for_update_timeout(&lock
, filename
,
595 get_files_ref_lock_timeout_ms());
597 strbuf_addf(err
, "could not open '%s' for writing: %s",
598 filename
, strerror(errno
));
603 struct object_id actual_old_oid
;
605 if (read_ref(pseudoref
, &actual_old_oid
))
606 die("could not read ref '%s'", pseudoref
);
607 if (oidcmp(&actual_old_oid
, old_oid
)) {
608 strbuf_addf(err
, "unexpected sha1 when writing '%s'", pseudoref
);
609 rollback_lock_file(&lock
);
614 if (write_in_full(fd
, buf
.buf
, buf
.len
) < 0) {
615 strbuf_addf(err
, "could not write to '%s'", filename
);
616 rollback_lock_file(&lock
);
620 commit_lock_file(&lock
);
623 strbuf_release(&buf
);
627 static int delete_pseudoref(const char *pseudoref
, const struct object_id
*old_oid
)
629 static struct lock_file lock
;
630 const char *filename
;
632 filename
= git_path("%s", pseudoref
);
634 if (old_oid
&& !is_null_oid(old_oid
)) {
636 struct object_id actual_old_oid
;
638 fd
= hold_lock_file_for_update_timeout(
639 &lock
, filename
, LOCK_DIE_ON_ERROR
,
640 get_files_ref_lock_timeout_ms());
642 die_errno(_("Could not open '%s' for writing"), filename
);
643 if (read_ref(pseudoref
, &actual_old_oid
))
644 die("could not read ref '%s'", pseudoref
);
645 if (oidcmp(&actual_old_oid
, old_oid
)) {
646 warning("Unexpected sha1 when deleting %s", pseudoref
);
647 rollback_lock_file(&lock
);
652 rollback_lock_file(&lock
);
660 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
662 const struct object_id
*old_oid
,
665 struct ref_transaction
*transaction
;
666 struct strbuf err
= STRBUF_INIT
;
668 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
669 assert(refs
== get_main_ref_store());
670 return delete_pseudoref(refname
, old_oid
);
673 transaction
= ref_store_transaction_begin(refs
, &err
);
675 ref_transaction_delete(transaction
, refname
, old_oid
,
677 ref_transaction_commit(transaction
, &err
)) {
678 error("%s", err
.buf
);
679 ref_transaction_free(transaction
);
680 strbuf_release(&err
);
683 ref_transaction_free(transaction
);
684 strbuf_release(&err
);
688 int delete_ref(const char *msg
, const char *refname
,
689 const struct object_id
*old_oid
, unsigned int flags
)
691 return refs_delete_ref(get_main_ref_store(), msg
, refname
,
695 int copy_reflog_msg(char *buf
, const char *msg
)
702 while ((c
= *msg
++)) {
703 if (wasspace
&& isspace(c
))
705 wasspace
= isspace(c
);
710 while (buf
< cp
&& isspace(cp
[-1]))
716 int should_autocreate_reflog(const char *refname
)
718 switch (log_all_ref_updates
) {
719 case LOG_REFS_ALWAYS
:
721 case LOG_REFS_NORMAL
:
722 return starts_with(refname
, "refs/heads/") ||
723 starts_with(refname
, "refs/remotes/") ||
724 starts_with(refname
, "refs/notes/") ||
725 !strcmp(refname
, "HEAD");
731 int is_branch(const char *refname
)
733 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
736 struct read_ref_at_cb
{
744 unsigned char osha1
[20];
745 unsigned char nsha1
[20];
749 timestamp_t
*cutoff_time
;
754 static int read_ref_at_ent(struct object_id
*ooid
, struct object_id
*noid
,
755 const char *email
, timestamp_t timestamp
, int tz
,
756 const char *message
, void *cb_data
)
758 struct read_ref_at_cb
*cb
= cb_data
;
762 cb
->date
= timestamp
;
764 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
766 *cb
->msg
= xstrdup(message
);
768 *cb
->cutoff_time
= timestamp
;
772 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
774 * we have not yet updated cb->[n|o]sha1 so they still
775 * hold the values for the previous record.
777 if (!is_null_sha1(cb
->osha1
)) {
778 hashcpy(cb
->sha1
, noid
->hash
);
779 if (hashcmp(cb
->osha1
, noid
->hash
))
780 warning("Log for ref %s has gap after %s.",
781 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
783 else if (cb
->date
== cb
->at_time
)
784 hashcpy(cb
->sha1
, noid
->hash
);
785 else if (hashcmp(noid
->hash
, cb
->sha1
))
786 warning("Log for ref %s unexpectedly ended on %s.",
787 cb
->refname
, show_date(cb
->date
, cb
->tz
,
788 DATE_MODE(RFC2822
)));
789 hashcpy(cb
->osha1
, ooid
->hash
);
790 hashcpy(cb
->nsha1
, noid
->hash
);
794 hashcpy(cb
->osha1
, ooid
->hash
);
795 hashcpy(cb
->nsha1
, noid
->hash
);
801 static int read_ref_at_ent_oldest(struct object_id
*ooid
, struct object_id
*noid
,
802 const char *email
, timestamp_t timestamp
,
803 int tz
, const char *message
, void *cb_data
)
805 struct read_ref_at_cb
*cb
= cb_data
;
808 *cb
->msg
= xstrdup(message
);
810 *cb
->cutoff_time
= timestamp
;
814 *cb
->cutoff_cnt
= cb
->reccnt
;
815 hashcpy(cb
->sha1
, ooid
->hash
);
816 if (is_null_sha1(cb
->sha1
))
817 hashcpy(cb
->sha1
, noid
->hash
);
818 /* We just want the first entry */
822 int read_ref_at(const char *refname
, unsigned int flags
, timestamp_t at_time
, int cnt
,
823 unsigned char *sha1
, char **msg
,
824 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
826 struct read_ref_at_cb cb
;
828 memset(&cb
, 0, sizeof(cb
));
829 cb
.refname
= refname
;
830 cb
.at_time
= at_time
;
833 cb
.cutoff_time
= cutoff_time
;
834 cb
.cutoff_tz
= cutoff_tz
;
835 cb
.cutoff_cnt
= cutoff_cnt
;
838 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
841 if (flags
& GET_OID_QUIETLY
)
844 die("Log for %s is empty.", refname
);
849 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
854 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
857 struct ref_transaction
*tr
;
860 tr
= xcalloc(1, sizeof(struct ref_transaction
));
861 tr
->ref_store
= refs
;
865 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
867 return ref_store_transaction_begin(get_main_ref_store(), err
);
870 void ref_transaction_free(struct ref_transaction
*transaction
)
877 switch (transaction
->state
) {
878 case REF_TRANSACTION_OPEN
:
879 case REF_TRANSACTION_CLOSED
:
882 case REF_TRANSACTION_PREPARED
:
883 die("BUG: free called on a prepared reference transaction");
886 die("BUG: unexpected reference transaction state");
890 for (i
= 0; i
< transaction
->nr
; i
++) {
891 free(transaction
->updates
[i
]->msg
);
892 free(transaction
->updates
[i
]);
894 free(transaction
->updates
);
898 struct ref_update
*ref_transaction_add_update(
899 struct ref_transaction
*transaction
,
900 const char *refname
, unsigned int flags
,
901 const struct object_id
*new_oid
,
902 const struct object_id
*old_oid
,
905 struct ref_update
*update
;
907 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
908 die("BUG: update called for transaction that is not open");
910 if ((flags
& REF_ISPRUNING
) && !(flags
& REF_NODEREF
))
911 die("BUG: REF_ISPRUNING set without REF_NODEREF");
913 FLEX_ALLOC_STR(update
, refname
, refname
);
914 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
915 transaction
->updates
[transaction
->nr
++] = update
;
917 update
->flags
= flags
;
919 if (flags
& REF_HAVE_NEW
)
920 oidcpy(&update
->new_oid
, new_oid
);
921 if (flags
& REF_HAVE_OLD
)
922 oidcpy(&update
->old_oid
, old_oid
);
923 update
->msg
= xstrdup_or_null(msg
);
927 int ref_transaction_update(struct ref_transaction
*transaction
,
929 const struct object_id
*new_oid
,
930 const struct object_id
*old_oid
,
931 unsigned int flags
, const char *msg
,
936 if ((new_oid
&& !is_null_oid(new_oid
)) ?
937 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
) :
938 !refname_is_safe(refname
)) {
939 strbuf_addf(err
, "refusing to update ref with bad name '%s'",
944 flags
&= REF_TRANSACTION_UPDATE_ALLOWED_FLAGS
;
946 flags
|= (new_oid
? REF_HAVE_NEW
: 0) | (old_oid
? REF_HAVE_OLD
: 0);
948 ref_transaction_add_update(transaction
, refname
, flags
,
949 new_oid
, old_oid
, msg
);
953 int ref_transaction_create(struct ref_transaction
*transaction
,
955 const struct object_id
*new_oid
,
956 unsigned int flags
, const char *msg
,
959 if (!new_oid
|| is_null_oid(new_oid
))
960 die("BUG: create called without valid new_oid");
961 return ref_transaction_update(transaction
, refname
, new_oid
,
962 &null_oid
, flags
, msg
, err
);
965 int ref_transaction_delete(struct ref_transaction
*transaction
,
967 const struct object_id
*old_oid
,
968 unsigned int flags
, const char *msg
,
971 if (old_oid
&& is_null_oid(old_oid
))
972 die("BUG: delete called with old_oid set to zeros");
973 return ref_transaction_update(transaction
, refname
,
978 int ref_transaction_verify(struct ref_transaction
*transaction
,
980 const struct object_id
*old_oid
,
985 die("BUG: verify called with old_oid set to NULL");
986 return ref_transaction_update(transaction
, refname
,
991 int refs_update_ref(struct ref_store
*refs
, const char *msg
,
992 const char *refname
, const struct object_id
*new_oid
,
993 const struct object_id
*old_oid
, unsigned int flags
,
994 enum action_on_err onerr
)
996 struct ref_transaction
*t
= NULL
;
997 struct strbuf err
= STRBUF_INIT
;
1000 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
1001 assert(refs
== get_main_ref_store());
1002 ret
= write_pseudoref(refname
, new_oid
, old_oid
, &err
);
1004 t
= ref_store_transaction_begin(refs
, &err
);
1006 ref_transaction_update(t
, refname
, new_oid
, old_oid
,
1007 flags
, msg
, &err
) ||
1008 ref_transaction_commit(t
, &err
)) {
1010 ref_transaction_free(t
);
1014 const char *str
= "update_ref failed for ref '%s': %s";
1017 case UPDATE_REFS_MSG_ON_ERR
:
1018 error(str
, refname
, err
.buf
);
1020 case UPDATE_REFS_DIE_ON_ERR
:
1021 die(str
, refname
, err
.buf
);
1023 case UPDATE_REFS_QUIET_ON_ERR
:
1026 strbuf_release(&err
);
1029 strbuf_release(&err
);
1031 ref_transaction_free(t
);
1035 int update_ref(const char *msg
, const char *refname
,
1036 const struct object_id
*new_oid
,
1037 const struct object_id
*old_oid
,
1038 unsigned int flags
, enum action_on_err onerr
)
1040 return refs_update_ref(get_main_ref_store(), msg
, refname
, new_oid
,
1041 old_oid
, flags
, onerr
);
1044 char *shorten_unambiguous_ref(const char *refname
, int strict
)
1047 static char **scanf_fmts
;
1048 static int nr_rules
;
1050 struct strbuf resolved_buf
= STRBUF_INIT
;
1054 * Pre-generate scanf formats from ref_rev_parse_rules[].
1055 * Generate a format suitable for scanf from a
1056 * ref_rev_parse_rules rule by interpolating "%s" at the
1057 * location of the "%.*s".
1059 size_t total_len
= 0;
1062 /* the rule list is NULL terminated, count them first */
1063 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
1064 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1065 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
1067 scanf_fmts
= xmalloc(st_add(st_mult(sizeof(char *), nr_rules
), total_len
));
1070 for (i
= 0; i
< nr_rules
; i
++) {
1071 assert(offset
< total_len
);
1072 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
1073 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
1074 ref_rev_parse_rules
[i
], 2, "%s") + 1;
1078 /* bail out if there are no rules */
1080 return xstrdup(refname
);
1082 /* buffer for scanf result, at most refname must fit */
1083 short_name
= xstrdup(refname
);
1085 /* skip first rule, it will always match */
1086 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
1088 int rules_to_fail
= i
;
1091 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
1094 short_name_len
= strlen(short_name
);
1097 * in strict mode, all (except the matched one) rules
1098 * must fail to resolve to a valid non-ambiguous ref
1101 rules_to_fail
= nr_rules
;
1104 * check if the short name resolves to a valid ref,
1105 * but use only rules prior to the matched one
1107 for (j
= 0; j
< rules_to_fail
; j
++) {
1108 const char *rule
= ref_rev_parse_rules
[j
];
1110 /* skip matched rule */
1115 * the short name is ambiguous, if it resolves
1116 * (with this previous rule) to a valid ref
1117 * read_ref() returns 0 on success
1119 strbuf_reset(&resolved_buf
);
1120 strbuf_addf(&resolved_buf
, rule
,
1121 short_name_len
, short_name
);
1122 if (ref_exists(resolved_buf
.buf
))
1127 * short name is non-ambiguous if all previous rules
1128 * haven't resolved to a valid ref
1130 if (j
== rules_to_fail
) {
1131 strbuf_release(&resolved_buf
);
1136 strbuf_release(&resolved_buf
);
1138 return xstrdup(refname
);
1141 static struct string_list
*hide_refs
;
1143 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
1146 if (!strcmp("transfer.hiderefs", var
) ||
1147 (!parse_config_key(var
, section
, NULL
, NULL
, &key
) &&
1148 !strcmp(key
, "hiderefs"))) {
1153 return config_error_nonbool(var
);
1154 ref
= xstrdup(value
);
1156 while (len
&& ref
[len
- 1] == '/')
1159 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
1160 hide_refs
->strdup_strings
= 1;
1162 string_list_append(hide_refs
, ref
);
1167 int ref_is_hidden(const char *refname
, const char *refname_full
)
1173 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
1174 const char *match
= hide_refs
->items
[i
].string
;
1175 const char *subject
;
1179 if (*match
== '!') {
1184 if (*match
== '^') {
1185 subject
= refname_full
;
1191 /* refname can be NULL when namespaces are used. */
1193 skip_prefix(subject
, match
, &p
) &&
1200 const char *find_descendant_ref(const char *dirname
,
1201 const struct string_list
*extras
,
1202 const struct string_list
*skip
)
1210 * Look at the place where dirname would be inserted into
1211 * extras. If there is an entry at that position that starts
1212 * with dirname (remember, dirname includes the trailing
1213 * slash) and is not in skip, then we have a conflict.
1215 for (pos
= string_list_find_insert_index(extras
, dirname
, 0);
1216 pos
< extras
->nr
; pos
++) {
1217 const char *extra_refname
= extras
->items
[pos
].string
;
1219 if (!starts_with(extra_refname
, dirname
))
1222 if (!skip
|| !string_list_has_string(skip
, extra_refname
))
1223 return extra_refname
;
1228 int refs_rename_ref_available(struct ref_store
*refs
,
1229 const char *old_refname
,
1230 const char *new_refname
)
1232 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1233 struct strbuf err
= STRBUF_INIT
;
1236 string_list_insert(&skip
, old_refname
);
1237 ok
= !refs_verify_refname_available(refs
, new_refname
,
1240 error("%s", err
.buf
);
1242 string_list_clear(&skip
, 0);
1243 strbuf_release(&err
);
1247 int refs_head_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1249 struct object_id oid
;
1252 if (!refs_read_ref_full(refs
, "HEAD", RESOLVE_REF_READING
,
1254 return fn("HEAD", &oid
, flag
, cb_data
);
1259 int head_ref(each_ref_fn fn
, void *cb_data
)
1261 return refs_head_ref(get_main_ref_store(), fn
, cb_data
);
1264 struct ref_iterator
*refs_ref_iterator_begin(
1265 struct ref_store
*refs
,
1266 const char *prefix
, int trim
, int flags
)
1268 struct ref_iterator
*iter
;
1270 if (ref_paranoia
< 0)
1271 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1273 flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1275 iter
= refs
->be
->iterator_begin(refs
, prefix
, flags
);
1278 * `iterator_begin()` already takes care of prefix, but we
1279 * might need to do some trimming:
1282 iter
= prefix_ref_iterator_begin(iter
, "", trim
);
1284 /* Sanity check for subclasses: */
1286 BUG("reference iterator is not ordered");
1292 * Call fn for each reference in the specified submodule for which the
1293 * refname begins with prefix. If trim is non-zero, then trim that
1294 * many characters off the beginning of each refname before passing
1295 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1296 * include broken references in the iteration. If fn ever returns a
1297 * non-zero value, stop the iteration and return that value;
1298 * otherwise, return 0.
1300 static int do_for_each_ref(struct ref_store
*refs
, const char *prefix
,
1301 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1303 struct ref_iterator
*iter
;
1308 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1310 return do_for_each_ref_iterator(iter
, fn
, cb_data
);
1313 int refs_for_each_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1315 return do_for_each_ref(refs
, "", fn
, 0, 0, cb_data
);
1318 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1320 return refs_for_each_ref(get_main_ref_store(), fn
, cb_data
);
1323 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
1324 each_ref_fn fn
, void *cb_data
)
1326 return do_for_each_ref(refs
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1329 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1331 return refs_for_each_ref_in(get_main_ref_store(), prefix
, fn
, cb_data
);
1334 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
1336 unsigned int flag
= 0;
1339 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1340 return do_for_each_ref(get_main_ref_store(),
1341 prefix
, fn
, 0, flag
, cb_data
);
1344 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
1345 each_ref_fn fn
, void *cb_data
,
1346 unsigned int broken
)
1348 unsigned int flag
= 0;
1351 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1352 return do_for_each_ref(refs
, prefix
, fn
, 0, flag
, cb_data
);
1355 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1357 return do_for_each_ref(get_main_ref_store(),
1358 git_replace_ref_base
, fn
,
1359 strlen(git_replace_ref_base
),
1360 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1363 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1365 struct strbuf buf
= STRBUF_INIT
;
1367 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1368 ret
= do_for_each_ref(get_main_ref_store(),
1369 buf
.buf
, fn
, 0, 0, cb_data
);
1370 strbuf_release(&buf
);
1374 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1376 return do_for_each_ref(refs
, "", fn
, 0,
1377 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1380 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1382 return refs_for_each_rawref(get_main_ref_store(), fn
, cb_data
);
1385 int refs_read_raw_ref(struct ref_store
*ref_store
,
1386 const char *refname
, unsigned char *sha1
,
1387 struct strbuf
*referent
, unsigned int *type
)
1389 return ref_store
->be
->read_raw_ref(ref_store
, refname
, sha1
, referent
, type
);
1392 /* This function needs to return a meaningful errno on failure */
1393 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
1394 const char *refname
,
1396 unsigned char *sha1
, int *flags
)
1398 static struct strbuf sb_refname
= STRBUF_INIT
;
1399 struct object_id unused_oid
;
1404 sha1
= unused_oid
.hash
;
1406 flags
= &unused_flags
;
1410 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1411 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1412 !refname_is_safe(refname
)) {
1418 * dwim_ref() uses REF_ISBROKEN to distinguish between
1419 * missing refs and refs that were present but invalid,
1420 * to complain about the latter to stderr.
1422 * We don't know whether the ref exists, so don't set
1425 *flags
|= REF_BAD_NAME
;
1428 for (symref_count
= 0; symref_count
< SYMREF_MAXDEPTH
; symref_count
++) {
1429 unsigned int read_flags
= 0;
1431 if (refs_read_raw_ref(refs
, refname
,
1432 sha1
, &sb_refname
, &read_flags
)) {
1433 *flags
|= read_flags
;
1435 /* In reading mode, refs must eventually resolve */
1436 if (resolve_flags
& RESOLVE_REF_READING
)
1440 * Otherwise a missing ref is OK. But the files backend
1441 * may show errors besides ENOENT if there are
1442 * similarly-named refs.
1444 if (errno
!= ENOENT
&&
1450 if (*flags
& REF_BAD_NAME
)
1451 *flags
|= REF_ISBROKEN
;
1455 *flags
|= read_flags
;
1457 if (!(read_flags
& REF_ISSYMREF
)) {
1458 if (*flags
& REF_BAD_NAME
) {
1460 *flags
|= REF_ISBROKEN
;
1465 refname
= sb_refname
.buf
;
1466 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1470 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1471 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1472 !refname_is_safe(refname
)) {
1477 *flags
|= REF_ISBROKEN
| REF_BAD_NAME
;
1485 /* backend functions */
1486 int refs_init_db(struct strbuf
*err
)
1488 struct ref_store
*refs
= get_main_ref_store();
1490 return refs
->be
->init_db(refs
, err
);
1493 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1494 unsigned char *sha1
, int *flags
)
1496 return refs_resolve_ref_unsafe(get_main_ref_store(), refname
,
1497 resolve_flags
, sha1
, flags
);
1500 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
1501 unsigned char *sha1
)
1503 struct ref_store
*refs
;
1506 refs
= get_submodule_ref_store(submodule
);
1511 if (!refs_resolve_ref_unsafe(refs
, refname
, 0, sha1
, &flags
) ||
1517 struct ref_store_hash_entry
1519 struct hashmap_entry ent
; /* must be the first member! */
1521 struct ref_store
*refs
;
1523 /* NUL-terminated identifier of the ref store: */
1524 char name
[FLEX_ARRAY
];
1527 static int ref_store_hash_cmp(const void *unused_cmp_data
,
1528 const void *entry
, const void *entry_or_key
,
1529 const void *keydata
)
1531 const struct ref_store_hash_entry
*e1
= entry
, *e2
= entry_or_key
;
1532 const char *name
= keydata
? keydata
: e2
->name
;
1534 return strcmp(e1
->name
, name
);
1537 static struct ref_store_hash_entry
*alloc_ref_store_hash_entry(
1538 const char *name
, struct ref_store
*refs
)
1540 struct ref_store_hash_entry
*entry
;
1542 FLEX_ALLOC_STR(entry
, name
, name
);
1543 hashmap_entry_init(entry
, strhash(name
));
1548 /* A pointer to the ref_store for the main repository: */
1549 static struct ref_store
*main_ref_store
;
1551 /* A hashmap of ref_stores, stored by submodule name: */
1552 static struct hashmap submodule_ref_stores
;
1554 /* A hashmap of ref_stores, stored by worktree id: */
1555 static struct hashmap worktree_ref_stores
;
1558 * Look up a ref store by name. If that ref_store hasn't been
1559 * registered yet, return NULL.
1561 static struct ref_store
*lookup_ref_store_map(struct hashmap
*map
,
1564 struct ref_store_hash_entry
*entry
;
1566 if (!map
->tablesize
)
1567 /* It's initialized on demand in register_ref_store(). */
1570 entry
= hashmap_get_from_hash(map
, strhash(name
), name
);
1571 return entry
? entry
->refs
: NULL
;
1575 * Create, record, and return a ref_store instance for the specified
1578 static struct ref_store
*ref_store_init(const char *gitdir
,
1581 const char *be_name
= "files";
1582 struct ref_storage_be
*be
= find_ref_storage_backend(be_name
);
1583 struct ref_store
*refs
;
1586 die("BUG: reference backend %s is unknown", be_name
);
1588 refs
= be
->init(gitdir
, flags
);
1592 struct ref_store
*get_main_ref_store(void)
1595 return main_ref_store
;
1597 main_ref_store
= ref_store_init(get_git_dir(), REF_STORE_ALL_CAPS
);
1598 return main_ref_store
;
1602 * Associate a ref store with a name. It is a fatal error to call this
1603 * function twice for the same name.
1605 static void register_ref_store_map(struct hashmap
*map
,
1607 struct ref_store
*refs
,
1610 if (!map
->tablesize
)
1611 hashmap_init(map
, ref_store_hash_cmp
, NULL
, 0);
1613 if (hashmap_put(map
, alloc_ref_store_hash_entry(name
, refs
)))
1614 die("BUG: %s ref_store '%s' initialized twice", type
, name
);
1617 struct ref_store
*get_submodule_ref_store(const char *submodule
)
1619 struct strbuf submodule_sb
= STRBUF_INIT
;
1620 struct ref_store
*refs
;
1621 char *to_free
= NULL
;
1627 len
= strlen(submodule
);
1628 while (len
&& is_dir_sep(submodule
[len
- 1]))
1634 /* We need to strip off one or more trailing slashes */
1635 submodule
= to_free
= xmemdupz(submodule
, len
);
1637 refs
= lookup_ref_store_map(&submodule_ref_stores
, submodule
);
1641 strbuf_addstr(&submodule_sb
, submodule
);
1642 if (!is_nonbare_repository_dir(&submodule_sb
))
1645 if (submodule_to_gitdir(&submodule_sb
, submodule
))
1648 /* assume that add_submodule_odb() has been called */
1649 refs
= ref_store_init(submodule_sb
.buf
,
1650 REF_STORE_READ
| REF_STORE_ODB
);
1651 register_ref_store_map(&submodule_ref_stores
, "submodule",
1655 strbuf_release(&submodule_sb
);
1661 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
)
1663 struct ref_store
*refs
;
1667 return get_main_ref_store();
1669 id
= wt
->id
? wt
->id
: "/";
1670 refs
= lookup_ref_store_map(&worktree_ref_stores
, id
);
1675 refs
= ref_store_init(git_common_path("worktrees/%s", wt
->id
),
1676 REF_STORE_ALL_CAPS
);
1678 refs
= ref_store_init(get_git_common_dir(),
1679 REF_STORE_ALL_CAPS
);
1682 register_ref_store_map(&worktree_ref_stores
, "worktree",
1687 void base_ref_store_init(struct ref_store
*refs
,
1688 const struct ref_storage_be
*be
)
1693 /* backend functions */
1694 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
)
1696 return refs
->be
->pack_refs(refs
, flags
);
1699 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
1700 unsigned char *sha1
)
1703 struct object_id base
;
1705 if (current_ref_iter
&& current_ref_iter
->refname
== refname
) {
1706 struct object_id peeled
;
1708 if (ref_iterator_peel(current_ref_iter
, &peeled
))
1710 hashcpy(sha1
, peeled
.hash
);
1714 if (refs_read_ref_full(refs
, refname
,
1715 RESOLVE_REF_READING
, &base
, &flag
))
1718 return peel_object(base
.hash
, sha1
);
1721 int peel_ref(const char *refname
, unsigned char *sha1
)
1723 return refs_peel_ref(get_main_ref_store(), refname
, sha1
);
1726 int refs_create_symref(struct ref_store
*refs
,
1727 const char *ref_target
,
1728 const char *refs_heads_master
,
1731 return refs
->be
->create_symref(refs
, ref_target
,
1736 int create_symref(const char *ref_target
, const char *refs_heads_master
,
1739 return refs_create_symref(get_main_ref_store(), ref_target
,
1740 refs_heads_master
, logmsg
);
1743 int ref_update_reject_duplicates(struct string_list
*refnames
,
1746 size_t i
, n
= refnames
->nr
;
1750 for (i
= 1; i
< n
; i
++) {
1751 int cmp
= strcmp(refnames
->items
[i
- 1].string
,
1752 refnames
->items
[i
].string
);
1756 "multiple updates for ref '%s' not allowed.",
1757 refnames
->items
[i
].string
);
1759 } else if (cmp
> 0) {
1760 die("BUG: ref_update_reject_duplicates() received unsorted list");
1766 int ref_transaction_prepare(struct ref_transaction
*transaction
,
1769 struct ref_store
*refs
= transaction
->ref_store
;
1771 switch (transaction
->state
) {
1772 case REF_TRANSACTION_OPEN
:
1775 case REF_TRANSACTION_PREPARED
:
1776 die("BUG: prepare called twice on reference transaction");
1778 case REF_TRANSACTION_CLOSED
:
1779 die("BUG: prepare called on a closed reference transaction");
1782 die("BUG: unexpected reference transaction state");
1786 if (getenv(GIT_QUARANTINE_ENVIRONMENT
)) {
1788 _("ref updates forbidden inside quarantine environment"));
1792 return refs
->be
->transaction_prepare(refs
, transaction
, err
);
1795 int ref_transaction_abort(struct ref_transaction
*transaction
,
1798 struct ref_store
*refs
= transaction
->ref_store
;
1801 switch (transaction
->state
) {
1802 case REF_TRANSACTION_OPEN
:
1803 /* No need to abort explicitly. */
1805 case REF_TRANSACTION_PREPARED
:
1806 ret
= refs
->be
->transaction_abort(refs
, transaction
, err
);
1808 case REF_TRANSACTION_CLOSED
:
1809 die("BUG: abort called on a closed reference transaction");
1812 die("BUG: unexpected reference transaction state");
1816 ref_transaction_free(transaction
);
1820 int ref_transaction_commit(struct ref_transaction
*transaction
,
1823 struct ref_store
*refs
= transaction
->ref_store
;
1826 switch (transaction
->state
) {
1827 case REF_TRANSACTION_OPEN
:
1828 /* Need to prepare first. */
1829 ret
= ref_transaction_prepare(transaction
, err
);
1833 case REF_TRANSACTION_PREPARED
:
1834 /* Fall through to finish. */
1836 case REF_TRANSACTION_CLOSED
:
1837 die("BUG: commit called on a closed reference transaction");
1840 die("BUG: unexpected reference transaction state");
1844 return refs
->be
->transaction_finish(refs
, transaction
, err
);
1847 int refs_verify_refname_available(struct ref_store
*refs
,
1848 const char *refname
,
1849 const struct string_list
*extras
,
1850 const struct string_list
*skip
,
1854 const char *extra_refname
;
1855 struct strbuf dirname
= STRBUF_INIT
;
1856 struct strbuf referent
= STRBUF_INIT
;
1857 struct object_id oid
;
1859 struct ref_iterator
*iter
;
1864 * For the sake of comments in this function, suppose that
1865 * refname is "refs/foo/bar".
1870 strbuf_grow(&dirname
, strlen(refname
) + 1);
1871 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
1872 /* Expand dirname to the new prefix, not including the trailing slash: */
1873 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
1876 * We are still at a leading dir of the refname (e.g.,
1877 * "refs/foo"; if there is a reference with that name,
1878 * it is a conflict, *unless* it is in skip.
1880 if (skip
&& string_list_has_string(skip
, dirname
.buf
))
1883 if (!refs_read_raw_ref(refs
, dirname
.buf
, oid
.hash
, &referent
, &type
)) {
1884 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1885 dirname
.buf
, refname
);
1889 if (extras
&& string_list_has_string(extras
, dirname
.buf
)) {
1890 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1891 refname
, dirname
.buf
);
1897 * We are at the leaf of our refname (e.g., "refs/foo/bar").
1898 * There is no point in searching for a reference with that
1899 * name, because a refname isn't considered to conflict with
1900 * itself. But we still need to check for references whose
1901 * names are in the "refs/foo/bar/" namespace, because they
1904 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
1905 strbuf_addch(&dirname
, '/');
1907 iter
= refs_ref_iterator_begin(refs
, dirname
.buf
, 0,
1908 DO_FOR_EACH_INCLUDE_BROKEN
);
1909 while ((ok
= ref_iterator_advance(iter
)) == ITER_OK
) {
1911 string_list_has_string(skip
, iter
->refname
))
1914 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1915 iter
->refname
, refname
);
1916 ref_iterator_abort(iter
);
1920 if (ok
!= ITER_DONE
)
1921 die("BUG: error while iterating over references");
1923 extra_refname
= find_descendant_ref(dirname
.buf
, extras
, skip
);
1925 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1926 refname
, extra_refname
);
1931 strbuf_release(&referent
);
1932 strbuf_release(&dirname
);
1936 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1938 struct ref_iterator
*iter
;
1940 iter
= refs
->be
->reflog_iterator_begin(refs
);
1942 return do_for_each_ref_iterator(iter
, fn
, cb_data
);
1945 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
1947 return refs_for_each_reflog(get_main_ref_store(), fn
, cb_data
);
1950 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
1951 const char *refname
,
1952 each_reflog_ent_fn fn
,
1955 return refs
->be
->for_each_reflog_ent_reverse(refs
, refname
,
1959 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
1962 return refs_for_each_reflog_ent_reverse(get_main_ref_store(),
1963 refname
, fn
, cb_data
);
1966 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
1967 each_reflog_ent_fn fn
, void *cb_data
)
1969 return refs
->be
->for_each_reflog_ent(refs
, refname
, fn
, cb_data
);
1972 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
1975 return refs_for_each_reflog_ent(get_main_ref_store(), refname
,
1979 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
)
1981 return refs
->be
->reflog_exists(refs
, refname
);
1984 int reflog_exists(const char *refname
)
1986 return refs_reflog_exists(get_main_ref_store(), refname
);
1989 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
1990 int force_create
, struct strbuf
*err
)
1992 return refs
->be
->create_reflog(refs
, refname
, force_create
, err
);
1995 int safe_create_reflog(const char *refname
, int force_create
,
1998 return refs_create_reflog(get_main_ref_store(), refname
,
2002 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
)
2004 return refs
->be
->delete_reflog(refs
, refname
);
2007 int delete_reflog(const char *refname
)
2009 return refs_delete_reflog(get_main_ref_store(), refname
);
2012 int refs_reflog_expire(struct ref_store
*refs
,
2013 const char *refname
, const unsigned char *sha1
,
2015 reflog_expiry_prepare_fn prepare_fn
,
2016 reflog_expiry_should_prune_fn should_prune_fn
,
2017 reflog_expiry_cleanup_fn cleanup_fn
,
2018 void *policy_cb_data
)
2020 return refs
->be
->reflog_expire(refs
, refname
, sha1
, flags
,
2021 prepare_fn
, should_prune_fn
,
2022 cleanup_fn
, policy_cb_data
);
2025 int reflog_expire(const char *refname
, const unsigned char *sha1
,
2027 reflog_expiry_prepare_fn prepare_fn
,
2028 reflog_expiry_should_prune_fn should_prune_fn
,
2029 reflog_expiry_cleanup_fn cleanup_fn
,
2030 void *policy_cb_data
)
2032 return refs_reflog_expire(get_main_ref_store(),
2033 refname
, sha1
, flags
,
2034 prepare_fn
, should_prune_fn
,
2035 cleanup_fn
, policy_cb_data
);
2038 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
2041 struct ref_store
*refs
= transaction
->ref_store
;
2043 return refs
->be
->initial_transaction_commit(refs
, transaction
, err
);
2046 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
2047 struct string_list
*refnames
, unsigned int flags
)
2049 return refs
->be
->delete_refs(refs
, msg
, refnames
, flags
);
2052 int delete_refs(const char *msg
, struct string_list
*refnames
,
2055 return refs_delete_refs(get_main_ref_store(), msg
, refnames
, flags
);
2058 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
2059 const char *newref
, const char *logmsg
)
2061 return refs
->be
->rename_ref(refs
, oldref
, newref
, logmsg
);
2064 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2066 return refs_rename_ref(get_main_ref_store(), oldref
, newref
, logmsg
);
2069 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
2070 const char *newref
, const char *logmsg
)
2072 return refs
->be
->copy_ref(refs
, oldref
, newref
, logmsg
);
2075 int copy_existing_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2077 return refs_copy_existing_ref(get_main_ref_store(), oldref
, newref
, logmsg
);