2 * The backend-independent part of the reference module.
11 #include "refs/refs-internal.h"
12 #include "object-store.h"
15 #include "submodule.h"
17 #include "argv-array.h"
18 #include "repository.h"
21 * List of all available backends
23 static struct ref_storage_be
*refs_backends
= &refs_be_files
;
25 static struct ref_storage_be
*find_ref_storage_backend(const char *name
)
27 struct ref_storage_be
*be
;
28 for (be
= refs_backends
; be
; be
= be
->next
)
29 if (!strcmp(be
->name
, name
))
34 int ref_storage_backend_exists(const char *name
)
36 return find_ref_storage_backend(name
) != NULL
;
40 * How to handle various characters in refnames:
41 * 0: An acceptable character for refs
43 * 2: ., look for a preceding . to reject .. in refs
44 * 3: {, look for a preceding @ to reject @{ in refs
45 * 4: A bad character: ASCII control characters, and
46 * ":", "?", "[", "\", "^", "~", SP, or TAB
47 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
49 static unsigned char refname_disposition
[256] = {
50 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
51 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
52 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
55 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
56 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
57 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
61 * Try to read one refname component from the front of refname.
62 * Return the length of the component found, or -1 if the component is
63 * not legal. It is legal if it is something reasonable to have under
64 * ".git/refs/"; We do not like it if:
66 * - it begins with ".", or
67 * - it has double dots "..", or
68 * - it has ASCII control characters, or
69 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
70 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
71 * - it ends with a "/", or
72 * - it ends with ".lock", or
73 * - it contains a "@{" portion
75 * When sanitized is not NULL, instead of rejecting the input refname
76 * as an error, try to come up with a usable replacement for the input
79 static int check_refname_component(const char *refname
, int *flags
,
80 struct strbuf
*sanitized
)
84 size_t component_start
= 0; /* garbage - not a reasonable initial value */
87 component_start
= sanitized
->len
;
89 for (cp
= refname
; ; cp
++) {
91 unsigned char disp
= refname_disposition
[ch
];
93 if (sanitized
&& disp
!= 1)
94 strbuf_addch(sanitized
, ch
);
100 if (last
== '.') { /* Refname contains "..". */
102 /* collapse ".." to single "." */
103 strbuf_setlen(sanitized
, sanitized
->len
- 1);
109 if (last
== '@') { /* Refname contains "@{". */
111 sanitized
->buf
[sanitized
->len
-1] = '-';
119 sanitized
->buf
[sanitized
->len
-1] = '-';
124 if (!(*flags
& REFNAME_REFSPEC_PATTERN
)) {
125 /* refspec can't be a pattern */
127 sanitized
->buf
[sanitized
->len
-1] = '-';
133 * Unset the pattern flag so that we only accept
134 * a single asterisk for one side of refspec.
136 *flags
&= ~ REFNAME_REFSPEC_PATTERN
;
143 return 0; /* Component has zero length. */
145 if (refname
[0] == '.') { /* Component starts with '.'. */
147 sanitized
->buf
[component_start
] = '-';
151 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
152 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
)) {
155 /* Refname ends with ".lock". */
156 while (strbuf_strip_suffix(sanitized
, LOCK_SUFFIX
)) {
157 /* try again in case we have .lock.lock */
163 static int check_or_sanitize_refname(const char *refname
, int flags
,
164 struct strbuf
*sanitized
)
166 int component_len
, component_count
= 0;
168 if (!strcmp(refname
, "@")) {
169 /* Refname is a single character '@'. */
171 strbuf_addch(sanitized
, '-');
177 if (sanitized
&& sanitized
->len
)
178 strbuf_complete(sanitized
, '/');
180 /* We are at the start of a path component. */
181 component_len
= check_refname_component(refname
, &flags
,
183 if (sanitized
&& component_len
== 0)
184 ; /* OK, omit empty component */
185 else if (component_len
<= 0)
189 if (refname
[component_len
] == '\0')
191 /* Skip to next component. */
192 refname
+= component_len
+ 1;
195 if (refname
[component_len
- 1] == '.') {
196 /* Refname ends with '.'. */
198 ; /* omit ending dot */
202 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
203 return -1; /* Refname has only one component. */
207 int check_refname_format(const char *refname
, int flags
)
209 return check_or_sanitize_refname(refname
, flags
, NULL
);
212 void sanitize_refname_component(const char *refname
, struct strbuf
*out
)
214 if (check_or_sanitize_refname(refname
, REFNAME_ALLOW_ONELEVEL
, out
))
215 BUG("sanitizing refname '%s' check returned error", refname
);
218 int refname_is_safe(const char *refname
)
222 if (skip_prefix(refname
, "refs/", &rest
)) {
225 size_t restlen
= strlen(rest
);
227 /* rest must not be empty, or start or end with "/" */
228 if (!restlen
|| *rest
== '/' || rest
[restlen
- 1] == '/')
232 * Does the refname try to escape refs/?
233 * For example: refs/foo/../bar is safe but refs/foo/../../bar
236 buf
= xmallocz(restlen
);
237 result
= !normalize_path_copy(buf
, rest
) && !strcmp(buf
, rest
);
243 if (!isupper(*refname
) && *refname
!= '_')
251 * Return true if refname, which has the specified oid and flags, can
252 * be resolved to an object in the database. If the referred-to object
253 * does not exist, emit a warning and return false.
255 int ref_resolves_to_object(const char *refname
,
256 const struct object_id
*oid
,
259 if (flags
& REF_ISBROKEN
)
261 if (!has_object_file(oid
)) {
262 error(_("%s does not point to a valid object!"), refname
);
268 char *refs_resolve_refdup(struct ref_store
*refs
,
269 const char *refname
, int resolve_flags
,
270 struct object_id
*oid
, int *flags
)
274 result
= refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
,
276 return xstrdup_or_null(result
);
279 char *resolve_refdup(const char *refname
, int resolve_flags
,
280 struct object_id
*oid
, int *flags
)
282 return refs_resolve_refdup(get_main_ref_store(the_repository
),
283 refname
, resolve_flags
,
287 /* The argument to filter_refs */
295 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
296 int resolve_flags
, struct object_id
*oid
, int *flags
)
298 if (refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
, oid
, flags
))
303 int read_ref_full(const char *refname
, int resolve_flags
, struct object_id
*oid
, int *flags
)
305 return refs_read_ref_full(get_main_ref_store(the_repository
), refname
,
306 resolve_flags
, oid
, flags
);
309 int read_ref(const char *refname
, struct object_id
*oid
)
311 return read_ref_full(refname
, RESOLVE_REF_READING
, oid
, NULL
);
314 static int refs_ref_exists(struct ref_store
*refs
, const char *refname
)
316 return !!refs_resolve_ref_unsafe(refs
, refname
, RESOLVE_REF_READING
, NULL
, NULL
);
319 int ref_exists(const char *refname
)
321 return refs_ref_exists(get_main_ref_store(the_repository
), refname
);
324 static int filter_refs(const char *refname
, const struct object_id
*oid
,
325 int flags
, void *data
)
327 struct ref_filter
*filter
= (struct ref_filter
*)data
;
329 if (wildmatch(filter
->pattern
, refname
, 0))
332 skip_prefix(refname
, filter
->prefix
, &refname
);
333 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
336 enum peel_status
peel_object(const struct object_id
*name
, struct object_id
*oid
)
338 struct object
*o
= lookup_unknown_object(name
);
340 if (o
->type
== OBJ_NONE
) {
341 int type
= oid_object_info(the_repository
, name
, NULL
);
342 if (type
< 0 || !object_as_type(the_repository
, o
, type
, 0))
346 if (o
->type
!= OBJ_TAG
)
349 o
= deref_tag_noverify(o
);
353 oidcpy(oid
, &o
->oid
);
357 struct warn_if_dangling_data
{
360 const struct string_list
*refnames
;
364 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
365 int flags
, void *cb_data
)
367 struct warn_if_dangling_data
*d
= cb_data
;
368 const char *resolves_to
;
370 if (!(flags
& REF_ISSYMREF
))
373 resolves_to
= resolve_ref_unsafe(refname
, 0, NULL
, NULL
);
376 ? strcmp(resolves_to
, d
->refname
)
377 : !string_list_has_string(d
->refnames
, resolves_to
))) {
381 fprintf(d
->fp
, d
->msg_fmt
, refname
);
386 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
388 struct warn_if_dangling_data data
;
391 data
.refname
= refname
;
392 data
.refnames
= NULL
;
393 data
.msg_fmt
= msg_fmt
;
394 for_each_rawref(warn_if_dangling_symref
, &data
);
397 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
399 struct warn_if_dangling_data data
;
403 data
.refnames
= refnames
;
404 data
.msg_fmt
= msg_fmt
;
405 for_each_rawref(warn_if_dangling_symref
, &data
);
408 int refs_for_each_tag_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
410 return refs_for_each_ref_in(refs
, "refs/tags/", fn
, cb_data
);
413 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
415 return refs_for_each_tag_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
418 int refs_for_each_branch_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
420 return refs_for_each_ref_in(refs
, "refs/heads/", fn
, cb_data
);
423 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
425 return refs_for_each_branch_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
428 int refs_for_each_remote_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
430 return refs_for_each_ref_in(refs
, "refs/remotes/", fn
, cb_data
);
433 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
435 return refs_for_each_remote_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
438 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
440 struct strbuf buf
= STRBUF_INIT
;
442 struct object_id oid
;
445 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
446 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, &oid
, &flag
))
447 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
448 strbuf_release(&buf
);
453 void normalize_glob_ref(struct string_list_item
*item
, const char *prefix
,
456 struct strbuf normalized_pattern
= STRBUF_INIT
;
459 BUG("pattern must not start with '/'");
462 strbuf_addstr(&normalized_pattern
, prefix
);
464 else if (!starts_with(pattern
, "refs/"))
465 strbuf_addstr(&normalized_pattern
, "refs/");
466 strbuf_addstr(&normalized_pattern
, pattern
);
467 strbuf_strip_suffix(&normalized_pattern
, "/");
469 item
->string
= strbuf_detach(&normalized_pattern
, NULL
);
470 item
->util
= has_glob_specials(pattern
) ? NULL
: item
->string
;
471 strbuf_release(&normalized_pattern
);
474 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
475 const char *prefix
, void *cb_data
)
477 struct strbuf real_pattern
= STRBUF_INIT
;
478 struct ref_filter filter
;
481 if (!prefix
&& !starts_with(pattern
, "refs/"))
482 strbuf_addstr(&real_pattern
, "refs/");
484 strbuf_addstr(&real_pattern
, prefix
);
485 strbuf_addstr(&real_pattern
, pattern
);
487 if (!has_glob_specials(pattern
)) {
488 /* Append implied '/' '*' if not present. */
489 strbuf_complete(&real_pattern
, '/');
490 /* No need to check for '*', there is none. */
491 strbuf_addch(&real_pattern
, '*');
494 filter
.pattern
= real_pattern
.buf
;
495 filter
.prefix
= prefix
;
497 filter
.cb_data
= cb_data
;
498 ret
= for_each_ref(filter_refs
, &filter
);
500 strbuf_release(&real_pattern
);
504 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
506 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
509 const char *prettify_refname(const char *name
)
511 if (skip_prefix(name
, "refs/heads/", &name
) ||
512 skip_prefix(name
, "refs/tags/", &name
) ||
513 skip_prefix(name
, "refs/remotes/", &name
))
518 static const char *ref_rev_parse_rules
[] = {
524 "refs/remotes/%.*s/HEAD",
528 #define NUM_REV_PARSE_RULES (ARRAY_SIZE(ref_rev_parse_rules) - 1)
531 * Is it possible that the caller meant full_name with abbrev_name?
532 * If so return a non-zero value to signal "yes"; the magnitude of
533 * the returned value gives the precedence used for disambiguation.
535 * If abbrev_name cannot mean full_name, return 0.
537 int refname_match(const char *abbrev_name
, const char *full_name
)
540 const int abbrev_name_len
= strlen(abbrev_name
);
541 const int num_rules
= NUM_REV_PARSE_RULES
;
543 for (p
= ref_rev_parse_rules
; *p
; p
++)
544 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
)))
545 return &ref_rev_parse_rules
[num_rules
] - p
;
551 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
552 * the results to 'prefixes'
554 void expand_ref_prefix(struct argv_array
*prefixes
, const char *prefix
)
557 int len
= strlen(prefix
);
559 for (p
= ref_rev_parse_rules
; *p
; p
++)
560 argv_array_pushf(prefixes
, *p
, len
, prefix
);
563 char *repo_default_branch_name(struct repository
*r
)
565 const char *config_key
= "init.defaultbranch";
566 const char *config_display_key
= "init.defaultBranch";
567 char *ret
= NULL
, *full_ref
;
569 if (repo_config_get_string(r
, config_key
, &ret
) < 0)
570 die(_("could not retrieve `%s`"), config_display_key
);
573 ret
= xstrdup("master");
575 full_ref
= xstrfmt("refs/heads/%s", ret
);
576 if (check_refname_format(full_ref
, 0))
577 die(_("invalid branch name: %s = %s"), config_display_key
, ret
);
583 const char *git_default_branch_name(void)
588 ret
= repo_default_branch_name(the_repository
);
594 * *string and *len will only be substituted, and *string returned (for
595 * later free()ing) if the string passed in is a magic short-hand form
598 static char *substitute_branch_name(struct repository
*r
,
599 const char **string
, int *len
)
601 struct strbuf buf
= STRBUF_INIT
;
602 int ret
= repo_interpret_branch_name(r
, *string
, *len
, &buf
, 0);
606 *string
= strbuf_detach(&buf
, &size
);
608 return (char *)*string
;
614 int repo_dwim_ref(struct repository
*r
, const char *str
, int len
,
615 struct object_id
*oid
, char **ref
)
617 char *last_branch
= substitute_branch_name(r
, &str
, &len
);
618 int refs_found
= expand_ref(r
, str
, len
, oid
, ref
);
623 int dwim_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
625 return repo_dwim_ref(the_repository
, str
, len
, oid
, ref
);
628 int expand_ref(struct repository
*repo
, const char *str
, int len
,
629 struct object_id
*oid
, char **ref
)
633 struct strbuf fullref
= STRBUF_INIT
;
636 for (p
= ref_rev_parse_rules
; *p
; p
++) {
637 struct object_id oid_from_ref
;
638 struct object_id
*this_result
;
641 this_result
= refs_found
? &oid_from_ref
: oid
;
642 strbuf_reset(&fullref
);
643 strbuf_addf(&fullref
, *p
, len
, str
);
644 r
= refs_resolve_ref_unsafe(get_main_ref_store(repo
),
645 fullref
.buf
, RESOLVE_REF_READING
,
650 if (!warn_ambiguous_refs
)
652 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
.buf
, "HEAD")) {
653 warning(_("ignoring dangling symref %s"), fullref
.buf
);
654 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
.buf
, '/')) {
655 warning(_("ignoring broken ref %s"), fullref
.buf
);
658 strbuf_release(&fullref
);
662 int repo_dwim_log(struct repository
*r
, const char *str
, int len
,
663 struct object_id
*oid
, char **log
)
665 struct ref_store
*refs
= get_main_ref_store(r
);
666 char *last_branch
= substitute_branch_name(r
, &str
, &len
);
669 struct strbuf path
= STRBUF_INIT
;
672 for (p
= ref_rev_parse_rules
; *p
; p
++) {
673 struct object_id hash
;
674 const char *ref
, *it
;
677 strbuf_addf(&path
, *p
, len
, str
);
678 ref
= refs_resolve_ref_unsafe(refs
, path
.buf
,
683 if (refs_reflog_exists(refs
, path
.buf
))
685 else if (strcmp(ref
, path
.buf
) &&
686 refs_reflog_exists(refs
, ref
))
694 if (!warn_ambiguous_refs
)
697 strbuf_release(&path
);
702 int dwim_log(const char *str
, int len
, struct object_id
*oid
, char **log
)
704 return repo_dwim_log(the_repository
, str
, len
, oid
, log
);
707 static int is_per_worktree_ref(const char *refname
)
709 return !strcmp(refname
, "HEAD") ||
710 starts_with(refname
, "refs/worktree/") ||
711 starts_with(refname
, "refs/bisect/") ||
712 starts_with(refname
, "refs/rewritten/");
715 static int is_pseudoref_syntax(const char *refname
)
719 for (c
= refname
; *c
; c
++) {
720 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
727 static int is_main_pseudoref_syntax(const char *refname
)
729 return skip_prefix(refname
, "main-worktree/", &refname
) &&
731 is_pseudoref_syntax(refname
);
734 static int is_other_pseudoref_syntax(const char *refname
)
736 if (!skip_prefix(refname
, "worktrees/", &refname
))
738 refname
= strchr(refname
, '/');
739 if (!refname
|| !refname
[1])
741 return is_pseudoref_syntax(refname
+ 1);
744 enum ref_type
ref_type(const char *refname
)
746 if (is_per_worktree_ref(refname
))
747 return REF_TYPE_PER_WORKTREE
;
748 if (is_pseudoref_syntax(refname
))
749 return REF_TYPE_PSEUDOREF
;
750 if (is_main_pseudoref_syntax(refname
))
751 return REF_TYPE_MAIN_PSEUDOREF
;
752 if (is_other_pseudoref_syntax(refname
))
753 return REF_TYPE_OTHER_PSEUDOREF
;
754 return REF_TYPE_NORMAL
;
757 long get_files_ref_lock_timeout_ms(void)
759 static int configured
= 0;
761 /* The default timeout is 100 ms: */
762 static int timeout_ms
= 100;
765 git_config_get_int("core.filesreflocktimeout", &timeout_ms
);
772 static int write_pseudoref(const char *pseudoref
, const struct object_id
*oid
,
773 const struct object_id
*old_oid
, struct strbuf
*err
)
775 const char *filename
;
777 struct lock_file lock
= LOCK_INIT
;
778 struct strbuf buf
= STRBUF_INIT
;
784 strbuf_addf(&buf
, "%s\n", oid_to_hex(oid
));
786 filename
= git_path("%s", pseudoref
);
787 fd
= hold_lock_file_for_update_timeout(&lock
, filename
, 0,
788 get_files_ref_lock_timeout_ms());
790 strbuf_addf(err
, _("could not open '%s' for writing: %s"),
791 filename
, strerror(errno
));
796 struct object_id actual_old_oid
;
798 if (read_ref(pseudoref
, &actual_old_oid
)) {
799 if (!is_null_oid(old_oid
)) {
800 strbuf_addf(err
, _("could not read ref '%s'"),
802 rollback_lock_file(&lock
);
805 } else if (is_null_oid(old_oid
)) {
806 strbuf_addf(err
, _("ref '%s' already exists"),
808 rollback_lock_file(&lock
);
810 } else if (!oideq(&actual_old_oid
, old_oid
)) {
811 strbuf_addf(err
, _("unexpected object ID when writing '%s'"),
813 rollback_lock_file(&lock
);
818 if (write_in_full(fd
, buf
.buf
, buf
.len
) < 0) {
819 strbuf_addf(err
, _("could not write to '%s'"), filename
);
820 rollback_lock_file(&lock
);
824 commit_lock_file(&lock
);
827 strbuf_release(&buf
);
831 static int delete_pseudoref(const char *pseudoref
, const struct object_id
*old_oid
)
833 const char *filename
;
835 filename
= git_path("%s", pseudoref
);
837 if (old_oid
&& !is_null_oid(old_oid
)) {
838 struct lock_file lock
= LOCK_INIT
;
840 struct object_id actual_old_oid
;
842 fd
= hold_lock_file_for_update_timeout(
844 get_files_ref_lock_timeout_ms());
846 error_errno(_("could not open '%s' for writing"),
850 if (read_ref(pseudoref
, &actual_old_oid
))
851 die(_("could not read ref '%s'"), pseudoref
);
852 if (!oideq(&actual_old_oid
, old_oid
)) {
853 error(_("unexpected object ID when deleting '%s'"),
855 rollback_lock_file(&lock
);
860 rollback_lock_file(&lock
);
868 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
870 const struct object_id
*old_oid
,
873 struct ref_transaction
*transaction
;
874 struct strbuf err
= STRBUF_INIT
;
876 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
877 assert(refs
== get_main_ref_store(the_repository
));
878 return delete_pseudoref(refname
, old_oid
);
881 transaction
= ref_store_transaction_begin(refs
, &err
);
883 ref_transaction_delete(transaction
, refname
, old_oid
,
885 ref_transaction_commit(transaction
, &err
)) {
886 error("%s", err
.buf
);
887 ref_transaction_free(transaction
);
888 strbuf_release(&err
);
891 ref_transaction_free(transaction
);
892 strbuf_release(&err
);
896 int delete_ref(const char *msg
, const char *refname
,
897 const struct object_id
*old_oid
, unsigned int flags
)
899 return refs_delete_ref(get_main_ref_store(the_repository
), msg
, refname
,
903 void copy_reflog_msg(struct strbuf
*sb
, const char *msg
)
908 strbuf_addch(sb
, '\t');
909 while ((c
= *msg
++)) {
910 if (wasspace
&& isspace(c
))
912 wasspace
= isspace(c
);
920 int should_autocreate_reflog(const char *refname
)
922 switch (log_all_ref_updates
) {
923 case LOG_REFS_ALWAYS
:
925 case LOG_REFS_NORMAL
:
926 return starts_with(refname
, "refs/heads/") ||
927 starts_with(refname
, "refs/remotes/") ||
928 starts_with(refname
, "refs/notes/") ||
929 !strcmp(refname
, "HEAD");
935 int is_branch(const char *refname
)
937 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
940 struct read_ref_at_cb
{
945 struct object_id
*oid
;
948 struct object_id ooid
;
949 struct object_id noid
;
953 timestamp_t
*cutoff_time
;
958 static int read_ref_at_ent(struct object_id
*ooid
, struct object_id
*noid
,
959 const char *email
, timestamp_t timestamp
, int tz
,
960 const char *message
, void *cb_data
)
962 struct read_ref_at_cb
*cb
= cb_data
;
966 cb
->date
= timestamp
;
968 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
970 *cb
->msg
= xstrdup(message
);
972 *cb
->cutoff_time
= timestamp
;
976 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
978 * we have not yet updated cb->[n|o]oid so they still
979 * hold the values for the previous record.
981 if (!is_null_oid(&cb
->ooid
)) {
982 oidcpy(cb
->oid
, noid
);
983 if (!oideq(&cb
->ooid
, noid
))
984 warning(_("log for ref %s has gap after %s"),
985 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
987 else if (cb
->date
== cb
->at_time
)
988 oidcpy(cb
->oid
, noid
);
989 else if (!oideq(noid
, cb
->oid
))
990 warning(_("log for ref %s unexpectedly ended on %s"),
991 cb
->refname
, show_date(cb
->date
, cb
->tz
,
992 DATE_MODE(RFC2822
)));
993 oidcpy(&cb
->ooid
, ooid
);
994 oidcpy(&cb
->noid
, noid
);
998 oidcpy(&cb
->ooid
, ooid
);
999 oidcpy(&cb
->noid
, noid
);
1005 static int read_ref_at_ent_oldest(struct object_id
*ooid
, struct object_id
*noid
,
1006 const char *email
, timestamp_t timestamp
,
1007 int tz
, const char *message
, void *cb_data
)
1009 struct read_ref_at_cb
*cb
= cb_data
;
1012 *cb
->msg
= xstrdup(message
);
1013 if (cb
->cutoff_time
)
1014 *cb
->cutoff_time
= timestamp
;
1016 *cb
->cutoff_tz
= tz
;
1018 *cb
->cutoff_cnt
= cb
->reccnt
;
1019 oidcpy(cb
->oid
, ooid
);
1020 if (is_null_oid(cb
->oid
))
1021 oidcpy(cb
->oid
, noid
);
1022 /* We just want the first entry */
1026 int read_ref_at(struct ref_store
*refs
, const char *refname
,
1027 unsigned int flags
, timestamp_t at_time
, int cnt
,
1028 struct object_id
*oid
, char **msg
,
1029 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
1031 struct read_ref_at_cb cb
;
1033 memset(&cb
, 0, sizeof(cb
));
1034 cb
.refname
= refname
;
1035 cb
.at_time
= at_time
;
1038 cb
.cutoff_time
= cutoff_time
;
1039 cb
.cutoff_tz
= cutoff_tz
;
1040 cb
.cutoff_cnt
= cutoff_cnt
;
1043 refs_for_each_reflog_ent_reverse(refs
, refname
, read_ref_at_ent
, &cb
);
1046 if (flags
& GET_OID_QUIETLY
)
1049 die(_("log for %s is empty"), refname
);
1054 refs_for_each_reflog_ent(refs
, refname
, read_ref_at_ent_oldest
, &cb
);
1059 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
1062 struct ref_transaction
*tr
;
1065 tr
= xcalloc(1, sizeof(struct ref_transaction
));
1066 tr
->ref_store
= refs
;
1070 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
1072 return ref_store_transaction_begin(get_main_ref_store(the_repository
), err
);
1075 void ref_transaction_free(struct ref_transaction
*transaction
)
1082 switch (transaction
->state
) {
1083 case REF_TRANSACTION_OPEN
:
1084 case REF_TRANSACTION_CLOSED
:
1087 case REF_TRANSACTION_PREPARED
:
1088 BUG("free called on a prepared reference transaction");
1091 BUG("unexpected reference transaction state");
1095 for (i
= 0; i
< transaction
->nr
; i
++) {
1096 free(transaction
->updates
[i
]->msg
);
1097 free(transaction
->updates
[i
]);
1099 free(transaction
->updates
);
1103 struct ref_update
*ref_transaction_add_update(
1104 struct ref_transaction
*transaction
,
1105 const char *refname
, unsigned int flags
,
1106 const struct object_id
*new_oid
,
1107 const struct object_id
*old_oid
,
1110 struct ref_update
*update
;
1112 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
1113 BUG("update called for transaction that is not open");
1115 FLEX_ALLOC_STR(update
, refname
, refname
);
1116 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
1117 transaction
->updates
[transaction
->nr
++] = update
;
1119 update
->flags
= flags
;
1121 if (flags
& REF_HAVE_NEW
)
1122 oidcpy(&update
->new_oid
, new_oid
);
1123 if (flags
& REF_HAVE_OLD
)
1124 oidcpy(&update
->old_oid
, old_oid
);
1125 update
->msg
= xstrdup_or_null(msg
);
1129 int ref_transaction_update(struct ref_transaction
*transaction
,
1130 const char *refname
,
1131 const struct object_id
*new_oid
,
1132 const struct object_id
*old_oid
,
1133 unsigned int flags
, const char *msg
,
1138 if ((new_oid
&& !is_null_oid(new_oid
)) ?
1139 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
) :
1140 !refname_is_safe(refname
)) {
1141 strbuf_addf(err
, _("refusing to update ref with bad name '%s'"),
1146 if (flags
& ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS
)
1147 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags
);
1149 flags
|= (new_oid
? REF_HAVE_NEW
: 0) | (old_oid
? REF_HAVE_OLD
: 0);
1151 ref_transaction_add_update(transaction
, refname
, flags
,
1152 new_oid
, old_oid
, msg
);
1156 int ref_transaction_create(struct ref_transaction
*transaction
,
1157 const char *refname
,
1158 const struct object_id
*new_oid
,
1159 unsigned int flags
, const char *msg
,
1162 if (!new_oid
|| is_null_oid(new_oid
))
1163 BUG("create called without valid new_oid");
1164 return ref_transaction_update(transaction
, refname
, new_oid
,
1165 &null_oid
, flags
, msg
, err
);
1168 int ref_transaction_delete(struct ref_transaction
*transaction
,
1169 const char *refname
,
1170 const struct object_id
*old_oid
,
1171 unsigned int flags
, const char *msg
,
1174 if (old_oid
&& is_null_oid(old_oid
))
1175 BUG("delete called with old_oid set to zeros");
1176 return ref_transaction_update(transaction
, refname
,
1181 int ref_transaction_verify(struct ref_transaction
*transaction
,
1182 const char *refname
,
1183 const struct object_id
*old_oid
,
1188 BUG("verify called with old_oid set to NULL");
1189 return ref_transaction_update(transaction
, refname
,
1194 int refs_update_ref(struct ref_store
*refs
, const char *msg
,
1195 const char *refname
, const struct object_id
*new_oid
,
1196 const struct object_id
*old_oid
, unsigned int flags
,
1197 enum action_on_err onerr
)
1199 struct ref_transaction
*t
= NULL
;
1200 struct strbuf err
= STRBUF_INIT
;
1203 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
1204 assert(refs
== get_main_ref_store(the_repository
));
1205 ret
= write_pseudoref(refname
, new_oid
, old_oid
, &err
);
1207 t
= ref_store_transaction_begin(refs
, &err
);
1209 ref_transaction_update(t
, refname
, new_oid
, old_oid
,
1210 flags
, msg
, &err
) ||
1211 ref_transaction_commit(t
, &err
)) {
1213 ref_transaction_free(t
);
1217 const char *str
= _("update_ref failed for ref '%s': %s");
1220 case UPDATE_REFS_MSG_ON_ERR
:
1221 error(str
, refname
, err
.buf
);
1223 case UPDATE_REFS_DIE_ON_ERR
:
1224 die(str
, refname
, err
.buf
);
1226 case UPDATE_REFS_QUIET_ON_ERR
:
1229 strbuf_release(&err
);
1232 strbuf_release(&err
);
1234 ref_transaction_free(t
);
1238 int update_ref(const char *msg
, const char *refname
,
1239 const struct object_id
*new_oid
,
1240 const struct object_id
*old_oid
,
1241 unsigned int flags
, enum action_on_err onerr
)
1243 return refs_update_ref(get_main_ref_store(the_repository
), msg
, refname
, new_oid
,
1244 old_oid
, flags
, onerr
);
1247 char *refs_shorten_unambiguous_ref(struct ref_store
*refs
,
1248 const char *refname
, int strict
)
1251 static char **scanf_fmts
;
1252 static int nr_rules
;
1254 struct strbuf resolved_buf
= STRBUF_INIT
;
1258 * Pre-generate scanf formats from ref_rev_parse_rules[].
1259 * Generate a format suitable for scanf from a
1260 * ref_rev_parse_rules rule by interpolating "%s" at the
1261 * location of the "%.*s".
1263 size_t total_len
= 0;
1266 /* the rule list is NULL terminated, count them first */
1267 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
1268 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1269 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
1271 scanf_fmts
= xmalloc(st_add(st_mult(sizeof(char *), nr_rules
), total_len
));
1274 for (i
= 0; i
< nr_rules
; i
++) {
1275 assert(offset
< total_len
);
1276 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
1277 offset
+= xsnprintf(scanf_fmts
[i
], total_len
- offset
,
1278 ref_rev_parse_rules
[i
], 2, "%s") + 1;
1282 /* bail out if there are no rules */
1284 return xstrdup(refname
);
1286 /* buffer for scanf result, at most refname must fit */
1287 short_name
= xstrdup(refname
);
1289 /* skip first rule, it will always match */
1290 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
1292 int rules_to_fail
= i
;
1295 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
1298 short_name_len
= strlen(short_name
);
1301 * in strict mode, all (except the matched one) rules
1302 * must fail to resolve to a valid non-ambiguous ref
1305 rules_to_fail
= nr_rules
;
1308 * check if the short name resolves to a valid ref,
1309 * but use only rules prior to the matched one
1311 for (j
= 0; j
< rules_to_fail
; j
++) {
1312 const char *rule
= ref_rev_parse_rules
[j
];
1314 /* skip matched rule */
1319 * the short name is ambiguous, if it resolves
1320 * (with this previous rule) to a valid ref
1321 * read_ref() returns 0 on success
1323 strbuf_reset(&resolved_buf
);
1324 strbuf_addf(&resolved_buf
, rule
,
1325 short_name_len
, short_name
);
1326 if (refs_ref_exists(refs
, resolved_buf
.buf
))
1331 * short name is non-ambiguous if all previous rules
1332 * haven't resolved to a valid ref
1334 if (j
== rules_to_fail
) {
1335 strbuf_release(&resolved_buf
);
1340 strbuf_release(&resolved_buf
);
1342 return xstrdup(refname
);
1345 char *shorten_unambiguous_ref(const char *refname
, int strict
)
1347 return refs_shorten_unambiguous_ref(get_main_ref_store(the_repository
),
1351 static struct string_list
*hide_refs
;
1353 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
1356 if (!strcmp("transfer.hiderefs", var
) ||
1357 (!parse_config_key(var
, section
, NULL
, NULL
, &key
) &&
1358 !strcmp(key
, "hiderefs"))) {
1363 return config_error_nonbool(var
);
1364 ref
= xstrdup(value
);
1366 while (len
&& ref
[len
- 1] == '/')
1369 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
1370 hide_refs
->strdup_strings
= 1;
1372 string_list_append(hide_refs
, ref
);
1377 int ref_is_hidden(const char *refname
, const char *refname_full
)
1383 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
1384 const char *match
= hide_refs
->items
[i
].string
;
1385 const char *subject
;
1389 if (*match
== '!') {
1394 if (*match
== '^') {
1395 subject
= refname_full
;
1401 /* refname can be NULL when namespaces are used. */
1403 skip_prefix(subject
, match
, &p
) &&
1410 const char *find_descendant_ref(const char *dirname
,
1411 const struct string_list
*extras
,
1412 const struct string_list
*skip
)
1420 * Look at the place where dirname would be inserted into
1421 * extras. If there is an entry at that position that starts
1422 * with dirname (remember, dirname includes the trailing
1423 * slash) and is not in skip, then we have a conflict.
1425 for (pos
= string_list_find_insert_index(extras
, dirname
, 0);
1426 pos
< extras
->nr
; pos
++) {
1427 const char *extra_refname
= extras
->items
[pos
].string
;
1429 if (!starts_with(extra_refname
, dirname
))
1432 if (!skip
|| !string_list_has_string(skip
, extra_refname
))
1433 return extra_refname
;
1438 int refs_rename_ref_available(struct ref_store
*refs
,
1439 const char *old_refname
,
1440 const char *new_refname
)
1442 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1443 struct strbuf err
= STRBUF_INIT
;
1446 string_list_insert(&skip
, old_refname
);
1447 ok
= !refs_verify_refname_available(refs
, new_refname
,
1450 error("%s", err
.buf
);
1452 string_list_clear(&skip
, 0);
1453 strbuf_release(&err
);
1457 int refs_head_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1459 struct object_id oid
;
1462 if (!refs_read_ref_full(refs
, "HEAD", RESOLVE_REF_READING
,
1464 return fn("HEAD", &oid
, flag
, cb_data
);
1469 int head_ref(each_ref_fn fn
, void *cb_data
)
1471 return refs_head_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1474 struct ref_iterator
*refs_ref_iterator_begin(
1475 struct ref_store
*refs
,
1476 const char *prefix
, int trim
, int flags
)
1478 struct ref_iterator
*iter
;
1480 if (ref_paranoia
< 0)
1481 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1483 flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1485 iter
= refs
->be
->iterator_begin(refs
, prefix
, flags
);
1488 * `iterator_begin()` already takes care of prefix, but we
1489 * might need to do some trimming:
1492 iter
= prefix_ref_iterator_begin(iter
, "", trim
);
1494 /* Sanity check for subclasses: */
1496 BUG("reference iterator is not ordered");
1502 * Call fn for each reference in the specified submodule for which the
1503 * refname begins with prefix. If trim is non-zero, then trim that
1504 * many characters off the beginning of each refname before passing
1505 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1506 * include broken references in the iteration. If fn ever returns a
1507 * non-zero value, stop the iteration and return that value;
1508 * otherwise, return 0.
1510 static int do_for_each_repo_ref(struct repository
*r
, const char *prefix
,
1511 each_repo_ref_fn fn
, int trim
, int flags
,
1514 struct ref_iterator
*iter
;
1515 struct ref_store
*refs
= get_main_ref_store(r
);
1520 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1522 return do_for_each_repo_ref_iterator(r
, iter
, fn
, cb_data
);
1525 struct do_for_each_ref_help
{
1530 static int do_for_each_ref_helper(struct repository
*r
,
1531 const char *refname
,
1532 const struct object_id
*oid
,
1536 struct do_for_each_ref_help
*hp
= cb_data
;
1538 return hp
->fn(refname
, oid
, flags
, hp
->cb_data
);
1541 static int do_for_each_ref(struct ref_store
*refs
, const char *prefix
,
1542 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1544 struct ref_iterator
*iter
;
1545 struct do_for_each_ref_help hp
= { fn
, cb_data
};
1550 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1552 return do_for_each_repo_ref_iterator(the_repository
, iter
,
1553 do_for_each_ref_helper
, &hp
);
1556 int refs_for_each_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1558 return do_for_each_ref(refs
, "", fn
, 0, 0, cb_data
);
1561 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1563 return refs_for_each_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1566 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
1567 each_ref_fn fn
, void *cb_data
)
1569 return do_for_each_ref(refs
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1572 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1574 return refs_for_each_ref_in(get_main_ref_store(the_repository
), prefix
, fn
, cb_data
);
1577 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
1579 unsigned int flag
= 0;
1582 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1583 return do_for_each_ref(get_main_ref_store(the_repository
),
1584 prefix
, fn
, 0, flag
, cb_data
);
1587 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
1588 each_ref_fn fn
, void *cb_data
,
1589 unsigned int broken
)
1591 unsigned int flag
= 0;
1594 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1595 return do_for_each_ref(refs
, prefix
, fn
, 0, flag
, cb_data
);
1598 int for_each_replace_ref(struct repository
*r
, each_repo_ref_fn fn
, void *cb_data
)
1600 return do_for_each_repo_ref(r
, git_replace_ref_base
, fn
,
1601 strlen(git_replace_ref_base
),
1602 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1605 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1607 struct strbuf buf
= STRBUF_INIT
;
1609 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1610 ret
= do_for_each_ref(get_main_ref_store(the_repository
),
1611 buf
.buf
, fn
, 0, 0, cb_data
);
1612 strbuf_release(&buf
);
1616 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1618 return do_for_each_ref(refs
, "", fn
, 0,
1619 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1622 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1624 return refs_for_each_rawref(get_main_ref_store(the_repository
), fn
, cb_data
);
1627 int refs_read_raw_ref(struct ref_store
*ref_store
,
1628 const char *refname
, struct object_id
*oid
,
1629 struct strbuf
*referent
, unsigned int *type
)
1631 return ref_store
->be
->read_raw_ref(ref_store
, refname
, oid
, referent
, type
);
1634 /* This function needs to return a meaningful errno on failure */
1635 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
1636 const char *refname
,
1638 struct object_id
*oid
, int *flags
)
1640 static struct strbuf sb_refname
= STRBUF_INIT
;
1641 struct object_id unused_oid
;
1648 flags
= &unused_flags
;
1652 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1653 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1654 !refname_is_safe(refname
)) {
1660 * dwim_ref() uses REF_ISBROKEN to distinguish between
1661 * missing refs and refs that were present but invalid,
1662 * to complain about the latter to stderr.
1664 * We don't know whether the ref exists, so don't set
1667 *flags
|= REF_BAD_NAME
;
1670 for (symref_count
= 0; symref_count
< SYMREF_MAXDEPTH
; symref_count
++) {
1671 unsigned int read_flags
= 0;
1673 if (refs_read_raw_ref(refs
, refname
,
1674 oid
, &sb_refname
, &read_flags
)) {
1675 *flags
|= read_flags
;
1677 /* In reading mode, refs must eventually resolve */
1678 if (resolve_flags
& RESOLVE_REF_READING
)
1682 * Otherwise a missing ref is OK. But the files backend
1683 * may show errors besides ENOENT if there are
1684 * similarly-named refs.
1686 if (errno
!= ENOENT
&&
1692 if (*flags
& REF_BAD_NAME
)
1693 *flags
|= REF_ISBROKEN
;
1697 *flags
|= read_flags
;
1699 if (!(read_flags
& REF_ISSYMREF
)) {
1700 if (*flags
& REF_BAD_NAME
) {
1702 *flags
|= REF_ISBROKEN
;
1707 refname
= sb_refname
.buf
;
1708 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1712 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1713 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1714 !refname_is_safe(refname
)) {
1719 *flags
|= REF_ISBROKEN
| REF_BAD_NAME
;
1727 /* backend functions */
1728 int refs_init_db(struct strbuf
*err
)
1730 struct ref_store
*refs
= get_main_ref_store(the_repository
);
1732 return refs
->be
->init_db(refs
, err
);
1735 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1736 struct object_id
*oid
, int *flags
)
1738 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository
), refname
,
1739 resolve_flags
, oid
, flags
);
1742 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
1743 struct object_id
*oid
)
1745 struct ref_store
*refs
;
1748 refs
= get_submodule_ref_store(submodule
);
1753 if (!refs_resolve_ref_unsafe(refs
, refname
, 0, oid
, &flags
) ||
1759 struct ref_store_hash_entry
1761 struct hashmap_entry ent
;
1763 struct ref_store
*refs
;
1765 /* NUL-terminated identifier of the ref store: */
1766 char name
[FLEX_ARRAY
];
1769 static int ref_store_hash_cmp(const void *unused_cmp_data
,
1770 const struct hashmap_entry
*eptr
,
1771 const struct hashmap_entry
*entry_or_key
,
1772 const void *keydata
)
1774 const struct ref_store_hash_entry
*e1
, *e2
;
1777 e1
= container_of(eptr
, const struct ref_store_hash_entry
, ent
);
1778 e2
= container_of(entry_or_key
, const struct ref_store_hash_entry
, ent
);
1779 name
= keydata
? keydata
: e2
->name
;
1781 return strcmp(e1
->name
, name
);
1784 static struct ref_store_hash_entry
*alloc_ref_store_hash_entry(
1785 const char *name
, struct ref_store
*refs
)
1787 struct ref_store_hash_entry
*entry
;
1789 FLEX_ALLOC_STR(entry
, name
, name
);
1790 hashmap_entry_init(&entry
->ent
, strhash(name
));
1795 /* A hashmap of ref_stores, stored by submodule name: */
1796 static struct hashmap submodule_ref_stores
;
1798 /* A hashmap of ref_stores, stored by worktree id: */
1799 static struct hashmap worktree_ref_stores
;
1802 * Look up a ref store by name. If that ref_store hasn't been
1803 * registered yet, return NULL.
1805 static struct ref_store
*lookup_ref_store_map(struct hashmap
*map
,
1808 struct ref_store_hash_entry
*entry
;
1811 if (!map
->tablesize
)
1812 /* It's initialized on demand in register_ref_store(). */
1815 hash
= strhash(name
);
1816 entry
= hashmap_get_entry_from_hash(map
, hash
, name
,
1817 struct ref_store_hash_entry
, ent
);
1818 return entry
? entry
->refs
: NULL
;
1822 * Create, record, and return a ref_store instance for the specified
1825 static struct ref_store
*ref_store_init(const char *gitdir
,
1828 const char *be_name
= "files";
1829 struct ref_storage_be
*be
= find_ref_storage_backend(be_name
);
1830 struct ref_store
*refs
;
1833 BUG("reference backend %s is unknown", be_name
);
1835 refs
= be
->init(gitdir
, flags
);
1839 struct ref_store
*get_main_ref_store(struct repository
*r
)
1841 if (r
->refs_private
)
1842 return r
->refs_private
;
1845 BUG("attempting to get main_ref_store outside of repository");
1847 r
->refs_private
= ref_store_init(r
->gitdir
, REF_STORE_ALL_CAPS
);
1848 return r
->refs_private
;
1852 * Associate a ref store with a name. It is a fatal error to call this
1853 * function twice for the same name.
1855 static void register_ref_store_map(struct hashmap
*map
,
1857 struct ref_store
*refs
,
1860 struct ref_store_hash_entry
*entry
;
1862 if (!map
->tablesize
)
1863 hashmap_init(map
, ref_store_hash_cmp
, NULL
, 0);
1865 entry
= alloc_ref_store_hash_entry(name
, refs
);
1866 if (hashmap_put(map
, &entry
->ent
))
1867 BUG("%s ref_store '%s' initialized twice", type
, name
);
1870 struct ref_store
*get_submodule_ref_store(const char *submodule
)
1872 struct strbuf submodule_sb
= STRBUF_INIT
;
1873 struct ref_store
*refs
;
1874 char *to_free
= NULL
;
1880 len
= strlen(submodule
);
1881 while (len
&& is_dir_sep(submodule
[len
- 1]))
1887 /* We need to strip off one or more trailing slashes */
1888 submodule
= to_free
= xmemdupz(submodule
, len
);
1890 refs
= lookup_ref_store_map(&submodule_ref_stores
, submodule
);
1894 strbuf_addstr(&submodule_sb
, submodule
);
1895 if (!is_nonbare_repository_dir(&submodule_sb
))
1898 if (submodule_to_gitdir(&submodule_sb
, submodule
))
1901 /* assume that add_submodule_odb() has been called */
1902 refs
= ref_store_init(submodule_sb
.buf
,
1903 REF_STORE_READ
| REF_STORE_ODB
);
1904 register_ref_store_map(&submodule_ref_stores
, "submodule",
1908 strbuf_release(&submodule_sb
);
1914 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
)
1916 struct ref_store
*refs
;
1920 return get_main_ref_store(the_repository
);
1922 id
= wt
->id
? wt
->id
: "/";
1923 refs
= lookup_ref_store_map(&worktree_ref_stores
, id
);
1928 refs
= ref_store_init(git_common_path("worktrees/%s", wt
->id
),
1929 REF_STORE_ALL_CAPS
);
1931 refs
= ref_store_init(get_git_common_dir(),
1932 REF_STORE_ALL_CAPS
);
1935 register_ref_store_map(&worktree_ref_stores
, "worktree",
1940 void base_ref_store_init(struct ref_store
*refs
,
1941 const struct ref_storage_be
*be
)
1946 /* backend functions */
1947 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
)
1949 return refs
->be
->pack_refs(refs
, flags
);
1952 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
1953 struct object_id
*oid
)
1956 struct object_id base
;
1958 if (current_ref_iter
&& current_ref_iter
->refname
== refname
) {
1959 struct object_id peeled
;
1961 if (ref_iterator_peel(current_ref_iter
, &peeled
))
1963 oidcpy(oid
, &peeled
);
1967 if (refs_read_ref_full(refs
, refname
,
1968 RESOLVE_REF_READING
, &base
, &flag
))
1971 return peel_object(&base
, oid
);
1974 int peel_ref(const char *refname
, struct object_id
*oid
)
1976 return refs_peel_ref(get_main_ref_store(the_repository
), refname
, oid
);
1979 int refs_create_symref(struct ref_store
*refs
,
1980 const char *ref_target
,
1981 const char *refs_heads_master
,
1984 return refs
->be
->create_symref(refs
, ref_target
,
1989 int create_symref(const char *ref_target
, const char *refs_heads_master
,
1992 return refs_create_symref(get_main_ref_store(the_repository
), ref_target
,
1993 refs_heads_master
, logmsg
);
1996 int ref_update_reject_duplicates(struct string_list
*refnames
,
1999 size_t i
, n
= refnames
->nr
;
2003 for (i
= 1; i
< n
; i
++) {
2004 int cmp
= strcmp(refnames
->items
[i
- 1].string
,
2005 refnames
->items
[i
].string
);
2009 _("multiple updates for ref '%s' not allowed"),
2010 refnames
->items
[i
].string
);
2012 } else if (cmp
> 0) {
2013 BUG("ref_update_reject_duplicates() received unsorted list");
2019 int ref_transaction_prepare(struct ref_transaction
*transaction
,
2022 struct ref_store
*refs
= transaction
->ref_store
;
2024 switch (transaction
->state
) {
2025 case REF_TRANSACTION_OPEN
:
2028 case REF_TRANSACTION_PREPARED
:
2029 BUG("prepare called twice on reference transaction");
2031 case REF_TRANSACTION_CLOSED
:
2032 BUG("prepare called on a closed reference transaction");
2035 BUG("unexpected reference transaction state");
2039 if (getenv(GIT_QUARANTINE_ENVIRONMENT
)) {
2041 _("ref updates forbidden inside quarantine environment"));
2045 return refs
->be
->transaction_prepare(refs
, transaction
, err
);
2048 int ref_transaction_abort(struct ref_transaction
*transaction
,
2051 struct ref_store
*refs
= transaction
->ref_store
;
2054 switch (transaction
->state
) {
2055 case REF_TRANSACTION_OPEN
:
2056 /* No need to abort explicitly. */
2058 case REF_TRANSACTION_PREPARED
:
2059 ret
= refs
->be
->transaction_abort(refs
, transaction
, err
);
2061 case REF_TRANSACTION_CLOSED
:
2062 BUG("abort called on a closed reference transaction");
2065 BUG("unexpected reference transaction state");
2069 ref_transaction_free(transaction
);
2073 int ref_transaction_commit(struct ref_transaction
*transaction
,
2076 struct ref_store
*refs
= transaction
->ref_store
;
2079 switch (transaction
->state
) {
2080 case REF_TRANSACTION_OPEN
:
2081 /* Need to prepare first. */
2082 ret
= ref_transaction_prepare(transaction
, err
);
2086 case REF_TRANSACTION_PREPARED
:
2087 /* Fall through to finish. */
2089 case REF_TRANSACTION_CLOSED
:
2090 BUG("commit called on a closed reference transaction");
2093 BUG("unexpected reference transaction state");
2097 return refs
->be
->transaction_finish(refs
, transaction
, err
);
2100 int refs_verify_refname_available(struct ref_store
*refs
,
2101 const char *refname
,
2102 const struct string_list
*extras
,
2103 const struct string_list
*skip
,
2107 const char *extra_refname
;
2108 struct strbuf dirname
= STRBUF_INIT
;
2109 struct strbuf referent
= STRBUF_INIT
;
2110 struct object_id oid
;
2112 struct ref_iterator
*iter
;
2117 * For the sake of comments in this function, suppose that
2118 * refname is "refs/foo/bar".
2123 strbuf_grow(&dirname
, strlen(refname
) + 1);
2124 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
2125 /* Expand dirname to the new prefix, not including the trailing slash: */
2126 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
2129 * We are still at a leading dir of the refname (e.g.,
2130 * "refs/foo"; if there is a reference with that name,
2131 * it is a conflict, *unless* it is in skip.
2133 if (skip
&& string_list_has_string(skip
, dirname
.buf
))
2136 if (!refs_read_raw_ref(refs
, dirname
.buf
, &oid
, &referent
, &type
)) {
2137 strbuf_addf(err
, _("'%s' exists; cannot create '%s'"),
2138 dirname
.buf
, refname
);
2142 if (extras
&& string_list_has_string(extras
, dirname
.buf
)) {
2143 strbuf_addf(err
, _("cannot process '%s' and '%s' at the same time"),
2144 refname
, dirname
.buf
);
2150 * We are at the leaf of our refname (e.g., "refs/foo/bar").
2151 * There is no point in searching for a reference with that
2152 * name, because a refname isn't considered to conflict with
2153 * itself. But we still need to check for references whose
2154 * names are in the "refs/foo/bar/" namespace, because they
2157 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
2158 strbuf_addch(&dirname
, '/');
2160 iter
= refs_ref_iterator_begin(refs
, dirname
.buf
, 0,
2161 DO_FOR_EACH_INCLUDE_BROKEN
);
2162 while ((ok
= ref_iterator_advance(iter
)) == ITER_OK
) {
2164 string_list_has_string(skip
, iter
->refname
))
2167 strbuf_addf(err
, _("'%s' exists; cannot create '%s'"),
2168 iter
->refname
, refname
);
2169 ref_iterator_abort(iter
);
2173 if (ok
!= ITER_DONE
)
2174 BUG("error while iterating over references");
2176 extra_refname
= find_descendant_ref(dirname
.buf
, extras
, skip
);
2178 strbuf_addf(err
, _("cannot process '%s' and '%s' at the same time"),
2179 refname
, extra_refname
);
2184 strbuf_release(&referent
);
2185 strbuf_release(&dirname
);
2189 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
2191 struct ref_iterator
*iter
;
2192 struct do_for_each_ref_help hp
= { fn
, cb_data
};
2194 iter
= refs
->be
->reflog_iterator_begin(refs
);
2196 return do_for_each_repo_ref_iterator(the_repository
, iter
,
2197 do_for_each_ref_helper
, &hp
);
2200 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
2202 return refs_for_each_reflog(get_main_ref_store(the_repository
), fn
, cb_data
);
2205 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
2206 const char *refname
,
2207 each_reflog_ent_fn fn
,
2210 return refs
->be
->for_each_reflog_ent_reverse(refs
, refname
,
2214 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
2217 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository
),
2218 refname
, fn
, cb_data
);
2221 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
2222 each_reflog_ent_fn fn
, void *cb_data
)
2224 return refs
->be
->for_each_reflog_ent(refs
, refname
, fn
, cb_data
);
2227 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
2230 return refs_for_each_reflog_ent(get_main_ref_store(the_repository
), refname
,
2234 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
)
2236 return refs
->be
->reflog_exists(refs
, refname
);
2239 int reflog_exists(const char *refname
)
2241 return refs_reflog_exists(get_main_ref_store(the_repository
), refname
);
2244 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
2245 int force_create
, struct strbuf
*err
)
2247 return refs
->be
->create_reflog(refs
, refname
, force_create
, err
);
2250 int safe_create_reflog(const char *refname
, int force_create
,
2253 return refs_create_reflog(get_main_ref_store(the_repository
), refname
,
2257 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
)
2259 return refs
->be
->delete_reflog(refs
, refname
);
2262 int delete_reflog(const char *refname
)
2264 return refs_delete_reflog(get_main_ref_store(the_repository
), refname
);
2267 int refs_reflog_expire(struct ref_store
*refs
,
2268 const char *refname
, const struct object_id
*oid
,
2270 reflog_expiry_prepare_fn prepare_fn
,
2271 reflog_expiry_should_prune_fn should_prune_fn
,
2272 reflog_expiry_cleanup_fn cleanup_fn
,
2273 void *policy_cb_data
)
2275 return refs
->be
->reflog_expire(refs
, refname
, oid
, flags
,
2276 prepare_fn
, should_prune_fn
,
2277 cleanup_fn
, policy_cb_data
);
2280 int reflog_expire(const char *refname
, const struct object_id
*oid
,
2282 reflog_expiry_prepare_fn prepare_fn
,
2283 reflog_expiry_should_prune_fn should_prune_fn
,
2284 reflog_expiry_cleanup_fn cleanup_fn
,
2285 void *policy_cb_data
)
2287 return refs_reflog_expire(get_main_ref_store(the_repository
),
2288 refname
, oid
, flags
,
2289 prepare_fn
, should_prune_fn
,
2290 cleanup_fn
, policy_cb_data
);
2293 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
2296 struct ref_store
*refs
= transaction
->ref_store
;
2298 return refs
->be
->initial_transaction_commit(refs
, transaction
, err
);
2301 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
2302 struct string_list
*refnames
, unsigned int flags
)
2304 return refs
->be
->delete_refs(refs
, msg
, refnames
, flags
);
2307 int delete_refs(const char *msg
, struct string_list
*refnames
,
2310 return refs_delete_refs(get_main_ref_store(the_repository
), msg
, refnames
, flags
);
2313 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
2314 const char *newref
, const char *logmsg
)
2316 return refs
->be
->rename_ref(refs
, oldref
, newref
, logmsg
);
2319 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2321 return refs_rename_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);
2324 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
2325 const char *newref
, const char *logmsg
)
2327 return refs
->be
->copy_ref(refs
, oldref
, newref
, logmsg
);
2330 int copy_existing_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2332 return refs_copy_existing_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);