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
, 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 match_ref_pattern(const char *refname
,
246 const struct string_list_item
*item
)
249 if (item
->util
== NULL
) {
250 if (!wildmatch(item
->string
, refname
, 0))
254 if (skip_prefix(refname
, item
->string
, &rest
) &&
255 (!*rest
|| *rest
== '/'))
261 int ref_filter_match(const char *refname
,
262 const struct string_list
*include_patterns
,
263 const struct string_list
*exclude_patterns
)
265 struct string_list_item
*item
;
267 if (exclude_patterns
&& exclude_patterns
->nr
) {
268 for_each_string_list_item(item
, exclude_patterns
) {
269 if (match_ref_pattern(refname
, item
))
274 if (include_patterns
&& include_patterns
->nr
) {
276 for_each_string_list_item(item
, include_patterns
) {
277 if (match_ref_pattern(refname
, item
)) {
289 static int filter_refs(const char *refname
, const struct object_id
*oid
,
290 int flags
, void *data
)
292 struct ref_filter
*filter
= (struct ref_filter
*)data
;
294 if (wildmatch(filter
->pattern
, refname
, 0))
296 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
299 enum peel_status
peel_object(const struct object_id
*name
, struct object_id
*oid
)
301 struct object
*o
= lookup_unknown_object(name
->hash
);
303 if (o
->type
== OBJ_NONE
) {
304 int type
= sha1_object_info(name
->hash
, NULL
);
305 if (type
< 0 || !object_as_type(o
, type
, 0))
309 if (o
->type
!= OBJ_TAG
)
312 o
= deref_tag_noverify(o
);
316 oidcpy(oid
, &o
->oid
);
320 struct warn_if_dangling_data
{
323 const struct string_list
*refnames
;
327 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
328 int flags
, void *cb_data
)
330 struct warn_if_dangling_data
*d
= cb_data
;
331 const char *resolves_to
;
333 if (!(flags
& REF_ISSYMREF
))
336 resolves_to
= resolve_ref_unsafe(refname
, 0, NULL
, NULL
);
339 ? strcmp(resolves_to
, d
->refname
)
340 : !string_list_has_string(d
->refnames
, resolves_to
))) {
344 fprintf(d
->fp
, d
->msg_fmt
, refname
);
349 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
351 struct warn_if_dangling_data data
;
354 data
.refname
= refname
;
355 data
.refnames
= NULL
;
356 data
.msg_fmt
= msg_fmt
;
357 for_each_rawref(warn_if_dangling_symref
, &data
);
360 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
362 struct warn_if_dangling_data data
;
366 data
.refnames
= refnames
;
367 data
.msg_fmt
= msg_fmt
;
368 for_each_rawref(warn_if_dangling_symref
, &data
);
371 int refs_for_each_tag_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
373 return refs_for_each_ref_in(refs
, "refs/tags/", fn
, cb_data
);
376 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
378 return refs_for_each_tag_ref(get_main_ref_store(), fn
, cb_data
);
381 int refs_for_each_branch_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
383 return refs_for_each_ref_in(refs
, "refs/heads/", fn
, cb_data
);
386 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
388 return refs_for_each_branch_ref(get_main_ref_store(), fn
, cb_data
);
391 int refs_for_each_remote_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
393 return refs_for_each_ref_in(refs
, "refs/remotes/", fn
, cb_data
);
396 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
398 return refs_for_each_remote_ref(get_main_ref_store(), fn
, cb_data
);
401 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
403 struct strbuf buf
= STRBUF_INIT
;
405 struct object_id oid
;
408 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
409 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, &oid
, &flag
))
410 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
411 strbuf_release(&buf
);
416 void normalize_glob_ref(struct string_list_item
*item
, const char *prefix
,
419 struct strbuf normalized_pattern
= STRBUF_INIT
;
422 BUG("pattern must not start with '/'");
425 strbuf_addstr(&normalized_pattern
, prefix
);
427 else if (!starts_with(pattern
, "refs/"))
428 strbuf_addstr(&normalized_pattern
, "refs/");
429 strbuf_addstr(&normalized_pattern
, pattern
);
430 strbuf_strip_suffix(&normalized_pattern
, "/");
432 item
->string
= strbuf_detach(&normalized_pattern
, NULL
);
433 item
->util
= has_glob_specials(pattern
) ? NULL
: item
->string
;
434 strbuf_release(&normalized_pattern
);
437 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
438 const char *prefix
, void *cb_data
)
440 struct strbuf real_pattern
= STRBUF_INIT
;
441 struct ref_filter filter
;
444 if (!prefix
&& !starts_with(pattern
, "refs/"))
445 strbuf_addstr(&real_pattern
, "refs/");
447 strbuf_addstr(&real_pattern
, prefix
);
448 strbuf_addstr(&real_pattern
, pattern
);
450 if (!has_glob_specials(pattern
)) {
451 /* Append implied '/' '*' if not present. */
452 strbuf_complete(&real_pattern
, '/');
453 /* No need to check for '*', there is none. */
454 strbuf_addch(&real_pattern
, '*');
457 filter
.pattern
= real_pattern
.buf
;
459 filter
.cb_data
= cb_data
;
460 ret
= for_each_ref(filter_refs
, &filter
);
462 strbuf_release(&real_pattern
);
466 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
468 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
471 const char *prettify_refname(const char *name
)
473 if (skip_prefix(name
, "refs/heads/", &name
) ||
474 skip_prefix(name
, "refs/tags/", &name
) ||
475 skip_prefix(name
, "refs/remotes/", &name
))
480 static const char *ref_rev_parse_rules
[] = {
486 "refs/remotes/%.*s/HEAD",
490 int refname_match(const char *abbrev_name
, const char *full_name
)
493 const int abbrev_name_len
= strlen(abbrev_name
);
495 for (p
= ref_rev_parse_rules
; *p
; p
++) {
496 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
505 * *string and *len will only be substituted, and *string returned (for
506 * later free()ing) if the string passed in is a magic short-hand form
509 static char *substitute_branch_name(const char **string
, int *len
)
511 struct strbuf buf
= STRBUF_INIT
;
512 int ret
= interpret_branch_name(*string
, *len
, &buf
, 0);
516 *string
= strbuf_detach(&buf
, &size
);
518 return (char *)*string
;
524 int dwim_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
526 char *last_branch
= substitute_branch_name(&str
, &len
);
527 int refs_found
= expand_ref(str
, len
, oid
, ref
);
532 int expand_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
536 struct strbuf fullref
= STRBUF_INIT
;
539 for (p
= ref_rev_parse_rules
; *p
; p
++) {
540 struct object_id oid_from_ref
;
541 struct object_id
*this_result
;
544 this_result
= refs_found
? &oid_from_ref
: oid
;
545 strbuf_reset(&fullref
);
546 strbuf_addf(&fullref
, *p
, len
, str
);
547 r
= resolve_ref_unsafe(fullref
.buf
, RESOLVE_REF_READING
,
552 if (!warn_ambiguous_refs
)
554 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
.buf
, "HEAD")) {
555 warning("ignoring dangling symref %s.", fullref
.buf
);
556 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
.buf
, '/')) {
557 warning("ignoring broken ref %s.", fullref
.buf
);
560 strbuf_release(&fullref
);
564 int dwim_log(const char *str
, int len
, struct object_id
*oid
, char **log
)
566 char *last_branch
= substitute_branch_name(&str
, &len
);
569 struct strbuf path
= STRBUF_INIT
;
572 for (p
= ref_rev_parse_rules
; *p
; p
++) {
573 struct object_id hash
;
574 const char *ref
, *it
;
577 strbuf_addf(&path
, *p
, len
, str
);
578 ref
= resolve_ref_unsafe(path
.buf
, RESOLVE_REF_READING
,
582 if (reflog_exists(path
.buf
))
584 else if (strcmp(ref
, path
.buf
) && reflog_exists(ref
))
592 if (!warn_ambiguous_refs
)
595 strbuf_release(&path
);
600 static int is_per_worktree_ref(const char *refname
)
602 return !strcmp(refname
, "HEAD") ||
603 starts_with(refname
, "refs/bisect/");
606 static int is_pseudoref_syntax(const char *refname
)
610 for (c
= refname
; *c
; c
++) {
611 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
618 enum ref_type
ref_type(const char *refname
)
620 if (is_per_worktree_ref(refname
))
621 return REF_TYPE_PER_WORKTREE
;
622 if (is_pseudoref_syntax(refname
))
623 return REF_TYPE_PSEUDOREF
;
624 return REF_TYPE_NORMAL
;
627 long get_files_ref_lock_timeout_ms(void)
629 static int configured
= 0;
631 /* The default timeout is 100 ms: */
632 static int timeout_ms
= 100;
635 git_config_get_int("core.filesreflocktimeout", &timeout_ms
);
642 static int write_pseudoref(const char *pseudoref
, const struct object_id
*oid
,
643 const struct object_id
*old_oid
, struct strbuf
*err
)
645 const char *filename
;
647 struct lock_file lock
= LOCK_INIT
;
648 struct strbuf buf
= STRBUF_INIT
;
654 strbuf_addf(&buf
, "%s\n", oid_to_hex(oid
));
656 filename
= git_path("%s", pseudoref
);
657 fd
= hold_lock_file_for_update_timeout(&lock
, filename
, 0,
658 get_files_ref_lock_timeout_ms());
660 strbuf_addf(err
, "could not open '%s' for writing: %s",
661 filename
, strerror(errno
));
666 struct object_id actual_old_oid
;
668 if (read_ref(pseudoref
, &actual_old_oid
))
669 die("could not read ref '%s'", pseudoref
);
670 if (oidcmp(&actual_old_oid
, old_oid
)) {
671 strbuf_addf(err
, "unexpected sha1 when writing '%s'", pseudoref
);
672 rollback_lock_file(&lock
);
677 if (write_in_full(fd
, buf
.buf
, buf
.len
) < 0) {
678 strbuf_addf(err
, "could not write to '%s'", filename
);
679 rollback_lock_file(&lock
);
683 commit_lock_file(&lock
);
686 strbuf_release(&buf
);
690 static int delete_pseudoref(const char *pseudoref
, const struct object_id
*old_oid
)
692 const char *filename
;
694 filename
= git_path("%s", pseudoref
);
696 if (old_oid
&& !is_null_oid(old_oid
)) {
697 struct lock_file lock
= LOCK_INIT
;
699 struct object_id actual_old_oid
;
701 fd
= hold_lock_file_for_update_timeout(
703 get_files_ref_lock_timeout_ms());
705 error_errno(_("could not open '%s' for writing"),
709 if (read_ref(pseudoref
, &actual_old_oid
))
710 die("could not read ref '%s'", pseudoref
);
711 if (oidcmp(&actual_old_oid
, old_oid
)) {
712 warning("Unexpected sha1 when deleting %s", pseudoref
);
713 rollback_lock_file(&lock
);
718 rollback_lock_file(&lock
);
726 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
728 const struct object_id
*old_oid
,
731 struct ref_transaction
*transaction
;
732 struct strbuf err
= STRBUF_INIT
;
734 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
735 assert(refs
== get_main_ref_store());
736 return delete_pseudoref(refname
, old_oid
);
739 transaction
= ref_store_transaction_begin(refs
, &err
);
741 ref_transaction_delete(transaction
, refname
, old_oid
,
743 ref_transaction_commit(transaction
, &err
)) {
744 error("%s", err
.buf
);
745 ref_transaction_free(transaction
);
746 strbuf_release(&err
);
749 ref_transaction_free(transaction
);
750 strbuf_release(&err
);
754 int delete_ref(const char *msg
, const char *refname
,
755 const struct object_id
*old_oid
, unsigned int flags
)
757 return refs_delete_ref(get_main_ref_store(), msg
, refname
,
761 int copy_reflog_msg(char *buf
, const char *msg
)
768 while ((c
= *msg
++)) {
769 if (wasspace
&& isspace(c
))
771 wasspace
= isspace(c
);
776 while (buf
< cp
&& isspace(cp
[-1]))
782 int should_autocreate_reflog(const char *refname
)
784 switch (log_all_ref_updates
) {
785 case LOG_REFS_ALWAYS
:
787 case LOG_REFS_NORMAL
:
788 return starts_with(refname
, "refs/heads/") ||
789 starts_with(refname
, "refs/remotes/") ||
790 starts_with(refname
, "refs/notes/") ||
791 !strcmp(refname
, "HEAD");
797 int is_branch(const char *refname
)
799 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
802 struct read_ref_at_cb
{
807 struct object_id
*oid
;
810 struct object_id ooid
;
811 struct object_id noid
;
815 timestamp_t
*cutoff_time
;
820 static int read_ref_at_ent(struct object_id
*ooid
, struct object_id
*noid
,
821 const char *email
, timestamp_t timestamp
, int tz
,
822 const char *message
, void *cb_data
)
824 struct read_ref_at_cb
*cb
= cb_data
;
828 cb
->date
= timestamp
;
830 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
832 *cb
->msg
= xstrdup(message
);
834 *cb
->cutoff_time
= timestamp
;
838 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
840 * we have not yet updated cb->[n|o]oid so they still
841 * hold the values for the previous record.
843 if (!is_null_oid(&cb
->ooid
)) {
844 oidcpy(cb
->oid
, noid
);
845 if (oidcmp(&cb
->ooid
, noid
))
846 warning("Log for ref %s has gap after %s.",
847 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
849 else if (cb
->date
== cb
->at_time
)
850 oidcpy(cb
->oid
, noid
);
851 else if (oidcmp(noid
, cb
->oid
))
852 warning("Log for ref %s unexpectedly ended on %s.",
853 cb
->refname
, show_date(cb
->date
, cb
->tz
,
854 DATE_MODE(RFC2822
)));
855 oidcpy(&cb
->ooid
, ooid
);
856 oidcpy(&cb
->noid
, noid
);
860 oidcpy(&cb
->ooid
, ooid
);
861 oidcpy(&cb
->noid
, noid
);
867 static int read_ref_at_ent_oldest(struct object_id
*ooid
, struct object_id
*noid
,
868 const char *email
, timestamp_t timestamp
,
869 int tz
, const char *message
, void *cb_data
)
871 struct read_ref_at_cb
*cb
= cb_data
;
874 *cb
->msg
= xstrdup(message
);
876 *cb
->cutoff_time
= timestamp
;
880 *cb
->cutoff_cnt
= cb
->reccnt
;
881 oidcpy(cb
->oid
, ooid
);
882 if (is_null_oid(cb
->oid
))
883 oidcpy(cb
->oid
, noid
);
884 /* We just want the first entry */
888 int read_ref_at(const char *refname
, unsigned int flags
, timestamp_t at_time
, int cnt
,
889 struct object_id
*oid
, char **msg
,
890 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
892 struct read_ref_at_cb cb
;
894 memset(&cb
, 0, sizeof(cb
));
895 cb
.refname
= refname
;
896 cb
.at_time
= at_time
;
899 cb
.cutoff_time
= cutoff_time
;
900 cb
.cutoff_tz
= cutoff_tz
;
901 cb
.cutoff_cnt
= cutoff_cnt
;
904 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
907 if (flags
& GET_OID_QUIETLY
)
910 die("Log for %s is empty.", refname
);
915 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
920 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
923 struct ref_transaction
*tr
;
926 tr
= xcalloc(1, sizeof(struct ref_transaction
));
927 tr
->ref_store
= refs
;
931 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
933 return ref_store_transaction_begin(get_main_ref_store(), err
);
936 void ref_transaction_free(struct ref_transaction
*transaction
)
943 switch (transaction
->state
) {
944 case REF_TRANSACTION_OPEN
:
945 case REF_TRANSACTION_CLOSED
:
948 case REF_TRANSACTION_PREPARED
:
949 die("BUG: free called on a prepared reference transaction");
952 die("BUG: unexpected reference transaction state");
956 for (i
= 0; i
< transaction
->nr
; i
++) {
957 free(transaction
->updates
[i
]->msg
);
958 free(transaction
->updates
[i
]);
960 free(transaction
->updates
);
964 struct ref_update
*ref_transaction_add_update(
965 struct ref_transaction
*transaction
,
966 const char *refname
, unsigned int flags
,
967 const struct object_id
*new_oid
,
968 const struct object_id
*old_oid
,
971 struct ref_update
*update
;
973 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
974 die("BUG: update called for transaction that is not open");
976 FLEX_ALLOC_STR(update
, refname
, refname
);
977 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
978 transaction
->updates
[transaction
->nr
++] = update
;
980 update
->flags
= flags
;
982 if (flags
& REF_HAVE_NEW
)
983 oidcpy(&update
->new_oid
, new_oid
);
984 if (flags
& REF_HAVE_OLD
)
985 oidcpy(&update
->old_oid
, old_oid
);
986 update
->msg
= xstrdup_or_null(msg
);
990 int ref_transaction_update(struct ref_transaction
*transaction
,
992 const struct object_id
*new_oid
,
993 const struct object_id
*old_oid
,
994 unsigned int flags
, const char *msg
,
999 if ((new_oid
&& !is_null_oid(new_oid
)) ?
1000 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
) :
1001 !refname_is_safe(refname
)) {
1002 strbuf_addf(err
, "refusing to update ref with bad name '%s'",
1007 if (flags
& ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS
)
1008 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags
);
1010 flags
|= (new_oid
? REF_HAVE_NEW
: 0) | (old_oid
? REF_HAVE_OLD
: 0);
1012 ref_transaction_add_update(transaction
, refname
, flags
,
1013 new_oid
, old_oid
, msg
);
1017 int ref_transaction_create(struct ref_transaction
*transaction
,
1018 const char *refname
,
1019 const struct object_id
*new_oid
,
1020 unsigned int flags
, const char *msg
,
1023 if (!new_oid
|| is_null_oid(new_oid
))
1024 die("BUG: create called without valid new_oid");
1025 return ref_transaction_update(transaction
, refname
, new_oid
,
1026 &null_oid
, flags
, msg
, err
);
1029 int ref_transaction_delete(struct ref_transaction
*transaction
,
1030 const char *refname
,
1031 const struct object_id
*old_oid
,
1032 unsigned int flags
, const char *msg
,
1035 if (old_oid
&& is_null_oid(old_oid
))
1036 die("BUG: delete called with old_oid set to zeros");
1037 return ref_transaction_update(transaction
, refname
,
1042 int ref_transaction_verify(struct ref_transaction
*transaction
,
1043 const char *refname
,
1044 const struct object_id
*old_oid
,
1049 die("BUG: verify called with old_oid set to NULL");
1050 return ref_transaction_update(transaction
, refname
,
1055 int refs_update_ref(struct ref_store
*refs
, const char *msg
,
1056 const char *refname
, const struct object_id
*new_oid
,
1057 const struct object_id
*old_oid
, unsigned int flags
,
1058 enum action_on_err onerr
)
1060 struct ref_transaction
*t
= NULL
;
1061 struct strbuf err
= STRBUF_INIT
;
1064 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
1065 assert(refs
== get_main_ref_store());
1066 ret
= write_pseudoref(refname
, new_oid
, old_oid
, &err
);
1068 t
= ref_store_transaction_begin(refs
, &err
);
1070 ref_transaction_update(t
, refname
, new_oid
, old_oid
,
1071 flags
, msg
, &err
) ||
1072 ref_transaction_commit(t
, &err
)) {
1074 ref_transaction_free(t
);
1078 const char *str
= "update_ref failed for ref '%s': %s";
1081 case UPDATE_REFS_MSG_ON_ERR
:
1082 error(str
, refname
, err
.buf
);
1084 case UPDATE_REFS_DIE_ON_ERR
:
1085 die(str
, refname
, err
.buf
);
1087 case UPDATE_REFS_QUIET_ON_ERR
:
1090 strbuf_release(&err
);
1093 strbuf_release(&err
);
1095 ref_transaction_free(t
);
1099 int update_ref(const char *msg
, const char *refname
,
1100 const struct object_id
*new_oid
,
1101 const struct object_id
*old_oid
,
1102 unsigned int flags
, enum action_on_err onerr
)
1104 return refs_update_ref(get_main_ref_store(), msg
, refname
, new_oid
,
1105 old_oid
, flags
, onerr
);
1108 char *shorten_unambiguous_ref(const char *refname
, int strict
)
1111 static char **scanf_fmts
;
1112 static int nr_rules
;
1114 struct strbuf resolved_buf
= STRBUF_INIT
;
1118 * Pre-generate scanf formats from ref_rev_parse_rules[].
1119 * Generate a format suitable for scanf from a
1120 * ref_rev_parse_rules rule by interpolating "%s" at the
1121 * location of the "%.*s".
1123 size_t total_len
= 0;
1126 /* the rule list is NULL terminated, count them first */
1127 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
1128 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1129 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
1131 scanf_fmts
= xmalloc(st_add(st_mult(sizeof(char *), nr_rules
), total_len
));
1134 for (i
= 0; i
< nr_rules
; i
++) {
1135 assert(offset
< total_len
);
1136 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
1137 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
1138 ref_rev_parse_rules
[i
], 2, "%s") + 1;
1142 /* bail out if there are no rules */
1144 return xstrdup(refname
);
1146 /* buffer for scanf result, at most refname must fit */
1147 short_name
= xstrdup(refname
);
1149 /* skip first rule, it will always match */
1150 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
1152 int rules_to_fail
= i
;
1155 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
1158 short_name_len
= strlen(short_name
);
1161 * in strict mode, all (except the matched one) rules
1162 * must fail to resolve to a valid non-ambiguous ref
1165 rules_to_fail
= nr_rules
;
1168 * check if the short name resolves to a valid ref,
1169 * but use only rules prior to the matched one
1171 for (j
= 0; j
< rules_to_fail
; j
++) {
1172 const char *rule
= ref_rev_parse_rules
[j
];
1174 /* skip matched rule */
1179 * the short name is ambiguous, if it resolves
1180 * (with this previous rule) to a valid ref
1181 * read_ref() returns 0 on success
1183 strbuf_reset(&resolved_buf
);
1184 strbuf_addf(&resolved_buf
, rule
,
1185 short_name_len
, short_name
);
1186 if (ref_exists(resolved_buf
.buf
))
1191 * short name is non-ambiguous if all previous rules
1192 * haven't resolved to a valid ref
1194 if (j
== rules_to_fail
) {
1195 strbuf_release(&resolved_buf
);
1200 strbuf_release(&resolved_buf
);
1202 return xstrdup(refname
);
1205 static struct string_list
*hide_refs
;
1207 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
1210 if (!strcmp("transfer.hiderefs", var
) ||
1211 (!parse_config_key(var
, section
, NULL
, NULL
, &key
) &&
1212 !strcmp(key
, "hiderefs"))) {
1217 return config_error_nonbool(var
);
1218 ref
= xstrdup(value
);
1220 while (len
&& ref
[len
- 1] == '/')
1223 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
1224 hide_refs
->strdup_strings
= 1;
1226 string_list_append(hide_refs
, ref
);
1231 int ref_is_hidden(const char *refname
, const char *refname_full
)
1237 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
1238 const char *match
= hide_refs
->items
[i
].string
;
1239 const char *subject
;
1243 if (*match
== '!') {
1248 if (*match
== '^') {
1249 subject
= refname_full
;
1255 /* refname can be NULL when namespaces are used. */
1257 skip_prefix(subject
, match
, &p
) &&
1264 const char *find_descendant_ref(const char *dirname
,
1265 const struct string_list
*extras
,
1266 const struct string_list
*skip
)
1274 * Look at the place where dirname would be inserted into
1275 * extras. If there is an entry at that position that starts
1276 * with dirname (remember, dirname includes the trailing
1277 * slash) and is not in skip, then we have a conflict.
1279 for (pos
= string_list_find_insert_index(extras
, dirname
, 0);
1280 pos
< extras
->nr
; pos
++) {
1281 const char *extra_refname
= extras
->items
[pos
].string
;
1283 if (!starts_with(extra_refname
, dirname
))
1286 if (!skip
|| !string_list_has_string(skip
, extra_refname
))
1287 return extra_refname
;
1292 int refs_rename_ref_available(struct ref_store
*refs
,
1293 const char *old_refname
,
1294 const char *new_refname
)
1296 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1297 struct strbuf err
= STRBUF_INIT
;
1300 string_list_insert(&skip
, old_refname
);
1301 ok
= !refs_verify_refname_available(refs
, new_refname
,
1304 error("%s", err
.buf
);
1306 string_list_clear(&skip
, 0);
1307 strbuf_release(&err
);
1311 int refs_head_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1313 struct object_id oid
;
1316 if (!refs_read_ref_full(refs
, "HEAD", RESOLVE_REF_READING
,
1318 return fn("HEAD", &oid
, flag
, cb_data
);
1323 int head_ref(each_ref_fn fn
, void *cb_data
)
1325 return refs_head_ref(get_main_ref_store(), fn
, cb_data
);
1328 struct ref_iterator
*refs_ref_iterator_begin(
1329 struct ref_store
*refs
,
1330 const char *prefix
, int trim
, int flags
)
1332 struct ref_iterator
*iter
;
1334 if (ref_paranoia
< 0)
1335 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1337 flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1339 iter
= refs
->be
->iterator_begin(refs
, prefix
, flags
);
1342 * `iterator_begin()` already takes care of prefix, but we
1343 * might need to do some trimming:
1346 iter
= prefix_ref_iterator_begin(iter
, "", trim
);
1348 /* Sanity check for subclasses: */
1350 BUG("reference iterator is not ordered");
1356 * Call fn for each reference in the specified submodule for which the
1357 * refname begins with prefix. If trim is non-zero, then trim that
1358 * many characters off the beginning of each refname before passing
1359 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1360 * include broken references in the iteration. If fn ever returns a
1361 * non-zero value, stop the iteration and return that value;
1362 * otherwise, return 0.
1364 static int do_for_each_ref(struct ref_store
*refs
, const char *prefix
,
1365 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1367 struct ref_iterator
*iter
;
1372 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1374 return do_for_each_ref_iterator(iter
, fn
, cb_data
);
1377 int refs_for_each_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1379 return do_for_each_ref(refs
, "", fn
, 0, 0, cb_data
);
1382 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1384 return refs_for_each_ref(get_main_ref_store(), fn
, cb_data
);
1387 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
1388 each_ref_fn fn
, void *cb_data
)
1390 return do_for_each_ref(refs
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1393 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1395 return refs_for_each_ref_in(get_main_ref_store(), prefix
, fn
, cb_data
);
1398 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
1400 unsigned int flag
= 0;
1403 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1404 return do_for_each_ref(get_main_ref_store(),
1405 prefix
, fn
, 0, flag
, cb_data
);
1408 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
1409 each_ref_fn fn
, void *cb_data
,
1410 unsigned int broken
)
1412 unsigned int flag
= 0;
1415 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1416 return do_for_each_ref(refs
, prefix
, fn
, 0, flag
, cb_data
);
1419 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1421 return do_for_each_ref(get_main_ref_store(),
1422 git_replace_ref_base
, fn
,
1423 strlen(git_replace_ref_base
),
1424 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1427 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1429 struct strbuf buf
= STRBUF_INIT
;
1431 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1432 ret
= do_for_each_ref(get_main_ref_store(),
1433 buf
.buf
, fn
, 0, 0, cb_data
);
1434 strbuf_release(&buf
);
1438 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1440 return do_for_each_ref(refs
, "", fn
, 0,
1441 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1444 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1446 return refs_for_each_rawref(get_main_ref_store(), fn
, cb_data
);
1449 int refs_read_raw_ref(struct ref_store
*ref_store
,
1450 const char *refname
, struct object_id
*oid
,
1451 struct strbuf
*referent
, unsigned int *type
)
1453 return ref_store
->be
->read_raw_ref(ref_store
, refname
, oid
, referent
, type
);
1456 /* This function needs to return a meaningful errno on failure */
1457 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
1458 const char *refname
,
1460 struct object_id
*oid
, int *flags
)
1462 static struct strbuf sb_refname
= STRBUF_INIT
;
1463 struct object_id unused_oid
;
1470 flags
= &unused_flags
;
1474 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1475 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1476 !refname_is_safe(refname
)) {
1482 * dwim_ref() uses REF_ISBROKEN to distinguish between
1483 * missing refs and refs that were present but invalid,
1484 * to complain about the latter to stderr.
1486 * We don't know whether the ref exists, so don't set
1489 *flags
|= REF_BAD_NAME
;
1492 for (symref_count
= 0; symref_count
< SYMREF_MAXDEPTH
; symref_count
++) {
1493 unsigned int read_flags
= 0;
1495 if (refs_read_raw_ref(refs
, refname
,
1496 oid
, &sb_refname
, &read_flags
)) {
1497 *flags
|= read_flags
;
1499 /* In reading mode, refs must eventually resolve */
1500 if (resolve_flags
& RESOLVE_REF_READING
)
1504 * Otherwise a missing ref is OK. But the files backend
1505 * may show errors besides ENOENT if there are
1506 * similarly-named refs.
1508 if (errno
!= ENOENT
&&
1514 if (*flags
& REF_BAD_NAME
)
1515 *flags
|= REF_ISBROKEN
;
1519 *flags
|= read_flags
;
1521 if (!(read_flags
& REF_ISSYMREF
)) {
1522 if (*flags
& REF_BAD_NAME
) {
1524 *flags
|= REF_ISBROKEN
;
1529 refname
= sb_refname
.buf
;
1530 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1534 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1535 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1536 !refname_is_safe(refname
)) {
1541 *flags
|= REF_ISBROKEN
| REF_BAD_NAME
;
1549 /* backend functions */
1550 int refs_init_db(struct strbuf
*err
)
1552 struct ref_store
*refs
= get_main_ref_store();
1554 return refs
->be
->init_db(refs
, err
);
1557 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1558 struct object_id
*oid
, int *flags
)
1560 return refs_resolve_ref_unsafe(get_main_ref_store(), refname
,
1561 resolve_flags
, oid
, flags
);
1564 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
1565 struct object_id
*oid
)
1567 struct ref_store
*refs
;
1570 refs
= get_submodule_ref_store(submodule
);
1575 if (!refs_resolve_ref_unsafe(refs
, refname
, 0, oid
, &flags
) ||
1581 struct ref_store_hash_entry
1583 struct hashmap_entry ent
; /* must be the first member! */
1585 struct ref_store
*refs
;
1587 /* NUL-terminated identifier of the ref store: */
1588 char name
[FLEX_ARRAY
];
1591 static int ref_store_hash_cmp(const void *unused_cmp_data
,
1592 const void *entry
, const void *entry_or_key
,
1593 const void *keydata
)
1595 const struct ref_store_hash_entry
*e1
= entry
, *e2
= entry_or_key
;
1596 const char *name
= keydata
? keydata
: e2
->name
;
1598 return strcmp(e1
->name
, name
);
1601 static struct ref_store_hash_entry
*alloc_ref_store_hash_entry(
1602 const char *name
, struct ref_store
*refs
)
1604 struct ref_store_hash_entry
*entry
;
1606 FLEX_ALLOC_STR(entry
, name
, name
);
1607 hashmap_entry_init(entry
, strhash(name
));
1612 /* A pointer to the ref_store for the main repository: */
1613 static struct ref_store
*main_ref_store
;
1615 /* A hashmap of ref_stores, stored by submodule name: */
1616 static struct hashmap submodule_ref_stores
;
1618 /* A hashmap of ref_stores, stored by worktree id: */
1619 static struct hashmap worktree_ref_stores
;
1622 * Look up a ref store by name. If that ref_store hasn't been
1623 * registered yet, return NULL.
1625 static struct ref_store
*lookup_ref_store_map(struct hashmap
*map
,
1628 struct ref_store_hash_entry
*entry
;
1630 if (!map
->tablesize
)
1631 /* It's initialized on demand in register_ref_store(). */
1634 entry
= hashmap_get_from_hash(map
, strhash(name
), name
);
1635 return entry
? entry
->refs
: NULL
;
1639 * Create, record, and return a ref_store instance for the specified
1642 static struct ref_store
*ref_store_init(const char *gitdir
,
1645 const char *be_name
= "files";
1646 struct ref_storage_be
*be
= find_ref_storage_backend(be_name
);
1647 struct ref_store
*refs
;
1650 die("BUG: reference backend %s is unknown", be_name
);
1652 refs
= be
->init(gitdir
, flags
);
1656 struct ref_store
*get_main_ref_store(void)
1659 return main_ref_store
;
1661 main_ref_store
= ref_store_init(get_git_dir(), REF_STORE_ALL_CAPS
);
1662 return main_ref_store
;
1666 * Associate a ref store with a name. It is a fatal error to call this
1667 * function twice for the same name.
1669 static void register_ref_store_map(struct hashmap
*map
,
1671 struct ref_store
*refs
,
1674 if (!map
->tablesize
)
1675 hashmap_init(map
, ref_store_hash_cmp
, NULL
, 0);
1677 if (hashmap_put(map
, alloc_ref_store_hash_entry(name
, refs
)))
1678 die("BUG: %s ref_store '%s' initialized twice", type
, name
);
1681 struct ref_store
*get_submodule_ref_store(const char *submodule
)
1683 struct strbuf submodule_sb
= STRBUF_INIT
;
1684 struct ref_store
*refs
;
1685 char *to_free
= NULL
;
1691 len
= strlen(submodule
);
1692 while (len
&& is_dir_sep(submodule
[len
- 1]))
1698 /* We need to strip off one or more trailing slashes */
1699 submodule
= to_free
= xmemdupz(submodule
, len
);
1701 refs
= lookup_ref_store_map(&submodule_ref_stores
, submodule
);
1705 strbuf_addstr(&submodule_sb
, submodule
);
1706 if (!is_nonbare_repository_dir(&submodule_sb
))
1709 if (submodule_to_gitdir(&submodule_sb
, submodule
))
1712 /* assume that add_submodule_odb() has been called */
1713 refs
= ref_store_init(submodule_sb
.buf
,
1714 REF_STORE_READ
| REF_STORE_ODB
);
1715 register_ref_store_map(&submodule_ref_stores
, "submodule",
1719 strbuf_release(&submodule_sb
);
1725 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
)
1727 struct ref_store
*refs
;
1731 return get_main_ref_store();
1733 id
= wt
->id
? wt
->id
: "/";
1734 refs
= lookup_ref_store_map(&worktree_ref_stores
, id
);
1739 refs
= ref_store_init(git_common_path("worktrees/%s", wt
->id
),
1740 REF_STORE_ALL_CAPS
);
1742 refs
= ref_store_init(get_git_common_dir(),
1743 REF_STORE_ALL_CAPS
);
1746 register_ref_store_map(&worktree_ref_stores
, "worktree",
1751 void base_ref_store_init(struct ref_store
*refs
,
1752 const struct ref_storage_be
*be
)
1757 /* backend functions */
1758 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
)
1760 return refs
->be
->pack_refs(refs
, flags
);
1763 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
1764 struct object_id
*oid
)
1767 struct object_id base
;
1769 if (current_ref_iter
&& current_ref_iter
->refname
== refname
) {
1770 struct object_id peeled
;
1772 if (ref_iterator_peel(current_ref_iter
, &peeled
))
1774 oidcpy(oid
, &peeled
);
1778 if (refs_read_ref_full(refs
, refname
,
1779 RESOLVE_REF_READING
, &base
, &flag
))
1782 return peel_object(&base
, oid
);
1785 int peel_ref(const char *refname
, struct object_id
*oid
)
1787 return refs_peel_ref(get_main_ref_store(), refname
, oid
);
1790 int refs_create_symref(struct ref_store
*refs
,
1791 const char *ref_target
,
1792 const char *refs_heads_master
,
1795 return refs
->be
->create_symref(refs
, ref_target
,
1800 int create_symref(const char *ref_target
, const char *refs_heads_master
,
1803 return refs_create_symref(get_main_ref_store(), ref_target
,
1804 refs_heads_master
, logmsg
);
1807 int ref_update_reject_duplicates(struct string_list
*refnames
,
1810 size_t i
, n
= refnames
->nr
;
1814 for (i
= 1; i
< n
; i
++) {
1815 int cmp
= strcmp(refnames
->items
[i
- 1].string
,
1816 refnames
->items
[i
].string
);
1820 "multiple updates for ref '%s' not allowed.",
1821 refnames
->items
[i
].string
);
1823 } else if (cmp
> 0) {
1824 die("BUG: ref_update_reject_duplicates() received unsorted list");
1830 int ref_transaction_prepare(struct ref_transaction
*transaction
,
1833 struct ref_store
*refs
= transaction
->ref_store
;
1835 switch (transaction
->state
) {
1836 case REF_TRANSACTION_OPEN
:
1839 case REF_TRANSACTION_PREPARED
:
1840 die("BUG: prepare called twice on reference transaction");
1842 case REF_TRANSACTION_CLOSED
:
1843 die("BUG: prepare called on a closed reference transaction");
1846 die("BUG: unexpected reference transaction state");
1850 if (getenv(GIT_QUARANTINE_ENVIRONMENT
)) {
1852 _("ref updates forbidden inside quarantine environment"));
1856 return refs
->be
->transaction_prepare(refs
, transaction
, err
);
1859 int ref_transaction_abort(struct ref_transaction
*transaction
,
1862 struct ref_store
*refs
= transaction
->ref_store
;
1865 switch (transaction
->state
) {
1866 case REF_TRANSACTION_OPEN
:
1867 /* No need to abort explicitly. */
1869 case REF_TRANSACTION_PREPARED
:
1870 ret
= refs
->be
->transaction_abort(refs
, transaction
, err
);
1872 case REF_TRANSACTION_CLOSED
:
1873 die("BUG: abort called on a closed reference transaction");
1876 die("BUG: unexpected reference transaction state");
1880 ref_transaction_free(transaction
);
1884 int ref_transaction_commit(struct ref_transaction
*transaction
,
1887 struct ref_store
*refs
= transaction
->ref_store
;
1890 switch (transaction
->state
) {
1891 case REF_TRANSACTION_OPEN
:
1892 /* Need to prepare first. */
1893 ret
= ref_transaction_prepare(transaction
, err
);
1897 case REF_TRANSACTION_PREPARED
:
1898 /* Fall through to finish. */
1900 case REF_TRANSACTION_CLOSED
:
1901 die("BUG: commit called on a closed reference transaction");
1904 die("BUG: unexpected reference transaction state");
1908 return refs
->be
->transaction_finish(refs
, transaction
, err
);
1911 int refs_verify_refname_available(struct ref_store
*refs
,
1912 const char *refname
,
1913 const struct string_list
*extras
,
1914 const struct string_list
*skip
,
1918 const char *extra_refname
;
1919 struct strbuf dirname
= STRBUF_INIT
;
1920 struct strbuf referent
= STRBUF_INIT
;
1921 struct object_id oid
;
1923 struct ref_iterator
*iter
;
1928 * For the sake of comments in this function, suppose that
1929 * refname is "refs/foo/bar".
1934 strbuf_grow(&dirname
, strlen(refname
) + 1);
1935 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
1936 /* Expand dirname to the new prefix, not including the trailing slash: */
1937 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
1940 * We are still at a leading dir of the refname (e.g.,
1941 * "refs/foo"; if there is a reference with that name,
1942 * it is a conflict, *unless* it is in skip.
1944 if (skip
&& string_list_has_string(skip
, dirname
.buf
))
1947 if (!refs_read_raw_ref(refs
, dirname
.buf
, &oid
, &referent
, &type
)) {
1948 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1949 dirname
.buf
, refname
);
1953 if (extras
&& string_list_has_string(extras
, dirname
.buf
)) {
1954 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1955 refname
, dirname
.buf
);
1961 * We are at the leaf of our refname (e.g., "refs/foo/bar").
1962 * There is no point in searching for a reference with that
1963 * name, because a refname isn't considered to conflict with
1964 * itself. But we still need to check for references whose
1965 * names are in the "refs/foo/bar/" namespace, because they
1968 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
1969 strbuf_addch(&dirname
, '/');
1971 iter
= refs_ref_iterator_begin(refs
, dirname
.buf
, 0,
1972 DO_FOR_EACH_INCLUDE_BROKEN
);
1973 while ((ok
= ref_iterator_advance(iter
)) == ITER_OK
) {
1975 string_list_has_string(skip
, iter
->refname
))
1978 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1979 iter
->refname
, refname
);
1980 ref_iterator_abort(iter
);
1984 if (ok
!= ITER_DONE
)
1985 die("BUG: error while iterating over references");
1987 extra_refname
= find_descendant_ref(dirname
.buf
, extras
, skip
);
1989 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1990 refname
, extra_refname
);
1995 strbuf_release(&referent
);
1996 strbuf_release(&dirname
);
2000 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
2002 struct ref_iterator
*iter
;
2004 iter
= refs
->be
->reflog_iterator_begin(refs
);
2006 return do_for_each_ref_iterator(iter
, fn
, cb_data
);
2009 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
2011 return refs_for_each_reflog(get_main_ref_store(), fn
, cb_data
);
2014 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
2015 const char *refname
,
2016 each_reflog_ent_fn fn
,
2019 return refs
->be
->for_each_reflog_ent_reverse(refs
, refname
,
2023 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
2026 return refs_for_each_reflog_ent_reverse(get_main_ref_store(),
2027 refname
, fn
, cb_data
);
2030 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
2031 each_reflog_ent_fn fn
, void *cb_data
)
2033 return refs
->be
->for_each_reflog_ent(refs
, refname
, fn
, cb_data
);
2036 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
2039 return refs_for_each_reflog_ent(get_main_ref_store(), refname
,
2043 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
)
2045 return refs
->be
->reflog_exists(refs
, refname
);
2048 int reflog_exists(const char *refname
)
2050 return refs_reflog_exists(get_main_ref_store(), refname
);
2053 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
2054 int force_create
, struct strbuf
*err
)
2056 return refs
->be
->create_reflog(refs
, refname
, force_create
, err
);
2059 int safe_create_reflog(const char *refname
, int force_create
,
2062 return refs_create_reflog(get_main_ref_store(), refname
,
2066 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
)
2068 return refs
->be
->delete_reflog(refs
, refname
);
2071 int delete_reflog(const char *refname
)
2073 return refs_delete_reflog(get_main_ref_store(), refname
);
2076 int refs_reflog_expire(struct ref_store
*refs
,
2077 const char *refname
, const struct object_id
*oid
,
2079 reflog_expiry_prepare_fn prepare_fn
,
2080 reflog_expiry_should_prune_fn should_prune_fn
,
2081 reflog_expiry_cleanup_fn cleanup_fn
,
2082 void *policy_cb_data
)
2084 return refs
->be
->reflog_expire(refs
, refname
, oid
, flags
,
2085 prepare_fn
, should_prune_fn
,
2086 cleanup_fn
, policy_cb_data
);
2089 int reflog_expire(const char *refname
, const struct object_id
*oid
,
2091 reflog_expiry_prepare_fn prepare_fn
,
2092 reflog_expiry_should_prune_fn should_prune_fn
,
2093 reflog_expiry_cleanup_fn cleanup_fn
,
2094 void *policy_cb_data
)
2096 return refs_reflog_expire(get_main_ref_store(),
2097 refname
, oid
, flags
,
2098 prepare_fn
, should_prune_fn
,
2099 cleanup_fn
, policy_cb_data
);
2102 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
2105 struct ref_store
*refs
= transaction
->ref_store
;
2107 return refs
->be
->initial_transaction_commit(refs
, transaction
, err
);
2110 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
2111 struct string_list
*refnames
, unsigned int flags
)
2113 return refs
->be
->delete_refs(refs
, msg
, refnames
, flags
);
2116 int delete_refs(const char *msg
, struct string_list
*refnames
,
2119 return refs_delete_refs(get_main_ref_store(), msg
, refnames
, flags
);
2122 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
2123 const char *newref
, const char *logmsg
)
2125 return refs
->be
->rename_ref(refs
, oldref
, newref
, logmsg
);
2128 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2130 return refs_rename_ref(get_main_ref_store(), oldref
, newref
, logmsg
);
2133 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
2134 const char *newref
, const char *logmsg
)
2136 return refs
->be
->copy_ref(refs
, oldref
, newref
, logmsg
);
2139 int copy_existing_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2141 return refs_copy_existing_ref(get_main_ref_store(), oldref
, newref
, logmsg
);