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 * - any path component of 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 static int check_refname_component(const char *refname
, int *flags
)
80 for (cp
= refname
; ; cp
++) {
82 unsigned char disp
= refname_disposition
[ch
];
88 return -1; /* Refname contains "..". */
92 return -1; /* Refname contains "@{". */
97 if (!(*flags
& REFNAME_REFSPEC_PATTERN
))
98 return -1; /* refspec can't be a pattern */
101 * Unset the pattern flag so that we only accept
102 * a single asterisk for one side of refspec.
104 *flags
&= ~ REFNAME_REFSPEC_PATTERN
;
111 return 0; /* Component has zero length. */
112 if (refname
[0] == '.')
113 return -1; /* Component starts with '.'. */
114 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
115 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
116 return -1; /* Refname ends with ".lock". */
120 int check_refname_format(const char *refname
, int flags
)
122 int component_len
, component_count
= 0;
124 if (!strcmp(refname
, "@"))
125 /* Refname is a single character '@'. */
129 /* We are at the start of a path component. */
130 component_len
= check_refname_component(refname
, &flags
);
131 if (component_len
<= 0)
135 if (refname
[component_len
] == '\0')
137 /* Skip to next component. */
138 refname
+= component_len
+ 1;
141 if (refname
[component_len
- 1] == '.')
142 return -1; /* Refname ends with '.'. */
143 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
144 return -1; /* Refname has only one component. */
148 int refname_is_safe(const char *refname
)
152 if (skip_prefix(refname
, "refs/", &rest
)) {
155 size_t restlen
= strlen(rest
);
157 /* rest must not be empty, or start or end with "/" */
158 if (!restlen
|| *rest
== '/' || rest
[restlen
- 1] == '/')
162 * Does the refname try to escape refs/?
163 * For example: refs/foo/../bar is safe but refs/foo/../../bar
166 buf
= xmallocz(restlen
);
167 result
= !normalize_path_copy(buf
, rest
) && !strcmp(buf
, rest
);
173 if (!isupper(*refname
) && *refname
!= '_')
181 * Return true if refname, which has the specified oid and flags, can
182 * be resolved to an object in the database. If the referred-to object
183 * does not exist, emit a warning and return false.
185 int ref_resolves_to_object(const char *refname
,
186 const struct object_id
*oid
,
189 if (flags
& REF_ISBROKEN
)
191 if (!has_object_file(oid
)) {
192 error(_("%s does not point to a valid object!"), refname
);
198 char *refs_resolve_refdup(struct ref_store
*refs
,
199 const char *refname
, int resolve_flags
,
200 struct object_id
*oid
, int *flags
)
204 result
= refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
,
206 return xstrdup_or_null(result
);
209 char *resolve_refdup(const char *refname
, int resolve_flags
,
210 struct object_id
*oid
, int *flags
)
212 return refs_resolve_refdup(get_main_ref_store(the_repository
),
213 refname
, resolve_flags
,
217 /* The argument to filter_refs */
225 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
226 int resolve_flags
, struct object_id
*oid
, int *flags
)
228 if (refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
, oid
, flags
))
233 int read_ref_full(const char *refname
, int resolve_flags
, struct object_id
*oid
, int *flags
)
235 return refs_read_ref_full(get_main_ref_store(the_repository
), refname
,
236 resolve_flags
, oid
, flags
);
239 int read_ref(const char *refname
, struct object_id
*oid
)
241 return read_ref_full(refname
, RESOLVE_REF_READING
, oid
, NULL
);
244 static int refs_ref_exists(struct ref_store
*refs
, const char *refname
)
246 return !!refs_resolve_ref_unsafe(refs
, refname
, RESOLVE_REF_READING
, NULL
, NULL
);
249 int ref_exists(const char *refname
)
251 return refs_ref_exists(get_main_ref_store(the_repository
), refname
);
254 static int match_ref_pattern(const char *refname
,
255 const struct string_list_item
*item
)
258 if (item
->util
== NULL
) {
259 if (!wildmatch(item
->string
, refname
, 0))
263 if (skip_prefix(refname
, item
->string
, &rest
) &&
264 (!*rest
|| *rest
== '/'))
270 int ref_filter_match(const char *refname
,
271 const struct string_list
*include_patterns
,
272 const struct string_list
*exclude_patterns
)
274 struct string_list_item
*item
;
276 if (exclude_patterns
&& exclude_patterns
->nr
) {
277 for_each_string_list_item(item
, exclude_patterns
) {
278 if (match_ref_pattern(refname
, item
))
283 if (include_patterns
&& include_patterns
->nr
) {
285 for_each_string_list_item(item
, include_patterns
) {
286 if (match_ref_pattern(refname
, item
)) {
298 static int filter_refs(const char *refname
, const struct object_id
*oid
,
299 int flags
, void *data
)
301 struct ref_filter
*filter
= (struct ref_filter
*)data
;
303 if (wildmatch(filter
->pattern
, refname
, 0))
306 skip_prefix(refname
, filter
->prefix
, &refname
);
307 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
310 enum peel_status
peel_object(const struct object_id
*name
, struct object_id
*oid
)
312 struct object
*o
= lookup_unknown_object(name
->hash
);
314 if (o
->type
== OBJ_NONE
) {
315 int type
= oid_object_info(the_repository
, name
, NULL
);
316 if (type
< 0 || !object_as_type(the_repository
, o
, type
, 0))
320 if (o
->type
!= OBJ_TAG
)
323 o
= deref_tag_noverify(o
);
327 oidcpy(oid
, &o
->oid
);
331 struct warn_if_dangling_data
{
334 const struct string_list
*refnames
;
338 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
339 int flags
, void *cb_data
)
341 struct warn_if_dangling_data
*d
= cb_data
;
342 const char *resolves_to
;
344 if (!(flags
& REF_ISSYMREF
))
347 resolves_to
= resolve_ref_unsafe(refname
, 0, NULL
, NULL
);
350 ? strcmp(resolves_to
, d
->refname
)
351 : !string_list_has_string(d
->refnames
, resolves_to
))) {
355 fprintf(d
->fp
, d
->msg_fmt
, refname
);
360 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
362 struct warn_if_dangling_data data
;
365 data
.refname
= refname
;
366 data
.refnames
= NULL
;
367 data
.msg_fmt
= msg_fmt
;
368 for_each_rawref(warn_if_dangling_symref
, &data
);
371 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
373 struct warn_if_dangling_data data
;
377 data
.refnames
= refnames
;
378 data
.msg_fmt
= msg_fmt
;
379 for_each_rawref(warn_if_dangling_symref
, &data
);
382 int refs_for_each_tag_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
384 return refs_for_each_ref_in(refs
, "refs/tags/", fn
, cb_data
);
387 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
389 return refs_for_each_tag_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
392 int refs_for_each_branch_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
394 return refs_for_each_ref_in(refs
, "refs/heads/", fn
, cb_data
);
397 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
399 return refs_for_each_branch_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
402 int refs_for_each_remote_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
404 return refs_for_each_ref_in(refs
, "refs/remotes/", fn
, cb_data
);
407 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
409 return refs_for_each_remote_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
412 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
414 struct strbuf buf
= STRBUF_INIT
;
416 struct object_id oid
;
419 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
420 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, &oid
, &flag
))
421 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
422 strbuf_release(&buf
);
427 void normalize_glob_ref(struct string_list_item
*item
, const char *prefix
,
430 struct strbuf normalized_pattern
= STRBUF_INIT
;
433 BUG("pattern must not start with '/'");
436 strbuf_addstr(&normalized_pattern
, prefix
);
438 else if (!starts_with(pattern
, "refs/"))
439 strbuf_addstr(&normalized_pattern
, "refs/");
440 strbuf_addstr(&normalized_pattern
, pattern
);
441 strbuf_strip_suffix(&normalized_pattern
, "/");
443 item
->string
= strbuf_detach(&normalized_pattern
, NULL
);
444 item
->util
= has_glob_specials(pattern
) ? NULL
: item
->string
;
445 strbuf_release(&normalized_pattern
);
448 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
449 const char *prefix
, void *cb_data
)
451 struct strbuf real_pattern
= STRBUF_INIT
;
452 struct ref_filter filter
;
455 if (!prefix
&& !starts_with(pattern
, "refs/"))
456 strbuf_addstr(&real_pattern
, "refs/");
458 strbuf_addstr(&real_pattern
, prefix
);
459 strbuf_addstr(&real_pattern
, pattern
);
461 if (!has_glob_specials(pattern
)) {
462 /* Append implied '/' '*' if not present. */
463 strbuf_complete(&real_pattern
, '/');
464 /* No need to check for '*', there is none. */
465 strbuf_addch(&real_pattern
, '*');
468 filter
.pattern
= real_pattern
.buf
;
469 filter
.prefix
= prefix
;
471 filter
.cb_data
= cb_data
;
472 ret
= for_each_ref(filter_refs
, &filter
);
474 strbuf_release(&real_pattern
);
478 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
480 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
483 const char *prettify_refname(const char *name
)
485 if (skip_prefix(name
, "refs/heads/", &name
) ||
486 skip_prefix(name
, "refs/tags/", &name
) ||
487 skip_prefix(name
, "refs/remotes/", &name
))
492 static const char *ref_rev_parse_rules
[] = {
498 "refs/remotes/%.*s/HEAD",
502 #define NUM_REV_PARSE_RULES (ARRAY_SIZE(ref_rev_parse_rules) - 1)
505 * Is it possible that the caller meant full_name with abbrev_name?
506 * If so return a non-zero value to signal "yes"; the magnitude of
507 * the returned value gives the precedence used for disambiguation.
509 * If abbrev_name cannot mean full_name, return 0.
511 int refname_match(const char *abbrev_name
, const char *full_name
)
514 const int abbrev_name_len
= strlen(abbrev_name
);
515 const int num_rules
= NUM_REV_PARSE_RULES
;
517 for (p
= ref_rev_parse_rules
; *p
; p
++)
518 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
)))
519 return &ref_rev_parse_rules
[num_rules
] - p
;
525 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
526 * the results to 'prefixes'
528 void expand_ref_prefix(struct argv_array
*prefixes
, const char *prefix
)
531 int len
= strlen(prefix
);
533 for (p
= ref_rev_parse_rules
; *p
; p
++)
534 argv_array_pushf(prefixes
, *p
, len
, prefix
);
538 * *string and *len will only be substituted, and *string returned (for
539 * later free()ing) if the string passed in is a magic short-hand form
542 static char *substitute_branch_name(struct repository
*r
,
543 const char **string
, int *len
)
545 struct strbuf buf
= STRBUF_INIT
;
546 int ret
= repo_interpret_branch_name(r
, *string
, *len
, &buf
, 0);
550 *string
= strbuf_detach(&buf
, &size
);
552 return (char *)*string
;
558 int dwim_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
560 char *last_branch
= substitute_branch_name(the_repository
, &str
, &len
);
561 int refs_found
= expand_ref(the_repository
, str
, len
, oid
, ref
);
566 int expand_ref(struct repository
*repo
, const char *str
, int len
,
567 struct object_id
*oid
, char **ref
)
571 struct strbuf fullref
= STRBUF_INIT
;
574 for (p
= ref_rev_parse_rules
; *p
; p
++) {
575 struct object_id oid_from_ref
;
576 struct object_id
*this_result
;
579 this_result
= refs_found
? &oid_from_ref
: oid
;
580 strbuf_reset(&fullref
);
581 strbuf_addf(&fullref
, *p
, len
, str
);
582 r
= refs_resolve_ref_unsafe(get_main_ref_store(repo
),
583 fullref
.buf
, RESOLVE_REF_READING
,
588 if (!warn_ambiguous_refs
)
590 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
.buf
, "HEAD")) {
591 warning(_("ignoring dangling symref %s"), fullref
.buf
);
592 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
.buf
, '/')) {
593 warning(_("ignoring broken ref %s"), fullref
.buf
);
596 strbuf_release(&fullref
);
600 int dwim_log(const char *str
, int len
, struct object_id
*oid
, char **log
)
602 char *last_branch
= substitute_branch_name(the_repository
, &str
, &len
);
605 struct strbuf path
= STRBUF_INIT
;
608 for (p
= ref_rev_parse_rules
; *p
; p
++) {
609 struct object_id hash
;
610 const char *ref
, *it
;
613 strbuf_addf(&path
, *p
, len
, str
);
614 ref
= resolve_ref_unsafe(path
.buf
, RESOLVE_REF_READING
,
618 if (reflog_exists(path
.buf
))
620 else if (strcmp(ref
, path
.buf
) && reflog_exists(ref
))
628 if (!warn_ambiguous_refs
)
631 strbuf_release(&path
);
636 static int is_per_worktree_ref(const char *refname
)
638 return !strcmp(refname
, "HEAD") ||
639 starts_with(refname
, "refs/worktree/") ||
640 starts_with(refname
, "refs/bisect/") ||
641 starts_with(refname
, "refs/rewritten/");
644 static int is_pseudoref_syntax(const char *refname
)
648 for (c
= refname
; *c
; c
++) {
649 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
656 static int is_main_pseudoref_syntax(const char *refname
)
658 return skip_prefix(refname
, "main-worktree/", &refname
) &&
660 is_pseudoref_syntax(refname
);
663 static int is_other_pseudoref_syntax(const char *refname
)
665 if (!skip_prefix(refname
, "worktrees/", &refname
))
667 refname
= strchr(refname
, '/');
668 if (!refname
|| !refname
[1])
670 return is_pseudoref_syntax(refname
+ 1);
673 enum ref_type
ref_type(const char *refname
)
675 if (is_per_worktree_ref(refname
))
676 return REF_TYPE_PER_WORKTREE
;
677 if (is_pseudoref_syntax(refname
))
678 return REF_TYPE_PSEUDOREF
;
679 if (is_main_pseudoref_syntax(refname
))
680 return REF_TYPE_MAIN_PSEUDOREF
;
681 if (is_other_pseudoref_syntax(refname
))
682 return REF_TYPE_OTHER_PSEUDOREF
;
683 return REF_TYPE_NORMAL
;
686 long get_files_ref_lock_timeout_ms(void)
688 static int configured
= 0;
690 /* The default timeout is 100 ms: */
691 static int timeout_ms
= 100;
694 git_config_get_int("core.filesreflocktimeout", &timeout_ms
);
701 static int write_pseudoref(const char *pseudoref
, const struct object_id
*oid
,
702 const struct object_id
*old_oid
, struct strbuf
*err
)
704 const char *filename
;
706 struct lock_file lock
= LOCK_INIT
;
707 struct strbuf buf
= STRBUF_INIT
;
713 strbuf_addf(&buf
, "%s\n", oid_to_hex(oid
));
715 filename
= git_path("%s", pseudoref
);
716 fd
= hold_lock_file_for_update_timeout(&lock
, filename
, 0,
717 get_files_ref_lock_timeout_ms());
719 strbuf_addf(err
, _("could not open '%s' for writing: %s"),
720 filename
, strerror(errno
));
725 struct object_id actual_old_oid
;
727 if (read_ref(pseudoref
, &actual_old_oid
)) {
728 if (!is_null_oid(old_oid
)) {
729 strbuf_addf(err
, _("could not read ref '%s'"),
731 rollback_lock_file(&lock
);
734 } else if (is_null_oid(old_oid
)) {
735 strbuf_addf(err
, _("ref '%s' already exists"),
737 rollback_lock_file(&lock
);
739 } else if (!oideq(&actual_old_oid
, old_oid
)) {
740 strbuf_addf(err
, _("unexpected object ID when writing '%s'"),
742 rollback_lock_file(&lock
);
747 if (write_in_full(fd
, buf
.buf
, buf
.len
) < 0) {
748 strbuf_addf(err
, _("could not write to '%s'"), filename
);
749 rollback_lock_file(&lock
);
753 commit_lock_file(&lock
);
756 strbuf_release(&buf
);
760 static int delete_pseudoref(const char *pseudoref
, const struct object_id
*old_oid
)
762 const char *filename
;
764 filename
= git_path("%s", pseudoref
);
766 if (old_oid
&& !is_null_oid(old_oid
)) {
767 struct lock_file lock
= LOCK_INIT
;
769 struct object_id actual_old_oid
;
771 fd
= hold_lock_file_for_update_timeout(
773 get_files_ref_lock_timeout_ms());
775 error_errno(_("could not open '%s' for writing"),
779 if (read_ref(pseudoref
, &actual_old_oid
))
780 die(_("could not read ref '%s'"), pseudoref
);
781 if (!oideq(&actual_old_oid
, old_oid
)) {
782 error(_("unexpected object ID when deleting '%s'"),
784 rollback_lock_file(&lock
);
789 rollback_lock_file(&lock
);
797 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
799 const struct object_id
*old_oid
,
802 struct ref_transaction
*transaction
;
803 struct strbuf err
= STRBUF_INIT
;
805 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
806 assert(refs
== get_main_ref_store(the_repository
));
807 return delete_pseudoref(refname
, old_oid
);
810 transaction
= ref_store_transaction_begin(refs
, &err
);
812 ref_transaction_delete(transaction
, refname
, old_oid
,
814 ref_transaction_commit(transaction
, &err
)) {
815 error("%s", err
.buf
);
816 ref_transaction_free(transaction
);
817 strbuf_release(&err
);
820 ref_transaction_free(transaction
);
821 strbuf_release(&err
);
825 int delete_ref(const char *msg
, const char *refname
,
826 const struct object_id
*old_oid
, unsigned int flags
)
828 return refs_delete_ref(get_main_ref_store(the_repository
), msg
, refname
,
832 void copy_reflog_msg(struct strbuf
*sb
, const char *msg
)
837 strbuf_addch(sb
, '\t');
838 while ((c
= *msg
++)) {
839 if (wasspace
&& isspace(c
))
841 wasspace
= isspace(c
);
849 int should_autocreate_reflog(const char *refname
)
851 switch (log_all_ref_updates
) {
852 case LOG_REFS_ALWAYS
:
854 case LOG_REFS_NORMAL
:
855 return starts_with(refname
, "refs/heads/") ||
856 starts_with(refname
, "refs/remotes/") ||
857 starts_with(refname
, "refs/notes/") ||
858 !strcmp(refname
, "HEAD");
864 int is_branch(const char *refname
)
866 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
869 struct read_ref_at_cb
{
874 struct object_id
*oid
;
877 struct object_id ooid
;
878 struct object_id noid
;
882 timestamp_t
*cutoff_time
;
887 static int read_ref_at_ent(struct object_id
*ooid
, struct object_id
*noid
,
888 const char *email
, timestamp_t timestamp
, int tz
,
889 const char *message
, void *cb_data
)
891 struct read_ref_at_cb
*cb
= cb_data
;
895 cb
->date
= timestamp
;
897 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
899 *cb
->msg
= xstrdup(message
);
901 *cb
->cutoff_time
= timestamp
;
905 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
907 * we have not yet updated cb->[n|o]oid so they still
908 * hold the values for the previous record.
910 if (!is_null_oid(&cb
->ooid
)) {
911 oidcpy(cb
->oid
, noid
);
912 if (!oideq(&cb
->ooid
, noid
))
913 warning(_("log for ref %s has gap after %s"),
914 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
916 else if (cb
->date
== cb
->at_time
)
917 oidcpy(cb
->oid
, noid
);
918 else if (!oideq(noid
, cb
->oid
))
919 warning(_("log for ref %s unexpectedly ended on %s"),
920 cb
->refname
, show_date(cb
->date
, cb
->tz
,
921 DATE_MODE(RFC2822
)));
922 oidcpy(&cb
->ooid
, ooid
);
923 oidcpy(&cb
->noid
, noid
);
927 oidcpy(&cb
->ooid
, ooid
);
928 oidcpy(&cb
->noid
, noid
);
934 static int read_ref_at_ent_oldest(struct object_id
*ooid
, struct object_id
*noid
,
935 const char *email
, timestamp_t timestamp
,
936 int tz
, const char *message
, void *cb_data
)
938 struct read_ref_at_cb
*cb
= cb_data
;
941 *cb
->msg
= xstrdup(message
);
943 *cb
->cutoff_time
= timestamp
;
947 *cb
->cutoff_cnt
= cb
->reccnt
;
948 oidcpy(cb
->oid
, ooid
);
949 if (is_null_oid(cb
->oid
))
950 oidcpy(cb
->oid
, noid
);
951 /* We just want the first entry */
955 int read_ref_at(const char *refname
, unsigned int flags
, timestamp_t at_time
, int cnt
,
956 struct object_id
*oid
, char **msg
,
957 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
959 struct read_ref_at_cb cb
;
961 memset(&cb
, 0, sizeof(cb
));
962 cb
.refname
= refname
;
963 cb
.at_time
= at_time
;
966 cb
.cutoff_time
= cutoff_time
;
967 cb
.cutoff_tz
= cutoff_tz
;
968 cb
.cutoff_cnt
= cutoff_cnt
;
971 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
974 if (flags
& GET_OID_QUIETLY
)
977 die(_("log for %s is empty"), refname
);
982 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
987 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
990 struct ref_transaction
*tr
;
993 tr
= xcalloc(1, sizeof(struct ref_transaction
));
994 tr
->ref_store
= refs
;
998 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
1000 return ref_store_transaction_begin(get_main_ref_store(the_repository
), err
);
1003 void ref_transaction_free(struct ref_transaction
*transaction
)
1010 switch (transaction
->state
) {
1011 case REF_TRANSACTION_OPEN
:
1012 case REF_TRANSACTION_CLOSED
:
1015 case REF_TRANSACTION_PREPARED
:
1016 BUG("free called on a prepared reference transaction");
1019 BUG("unexpected reference transaction state");
1023 for (i
= 0; i
< transaction
->nr
; i
++) {
1024 free(transaction
->updates
[i
]->msg
);
1025 free(transaction
->updates
[i
]);
1027 free(transaction
->updates
);
1031 struct ref_update
*ref_transaction_add_update(
1032 struct ref_transaction
*transaction
,
1033 const char *refname
, unsigned int flags
,
1034 const struct object_id
*new_oid
,
1035 const struct object_id
*old_oid
,
1038 struct ref_update
*update
;
1040 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
1041 BUG("update called for transaction that is not open");
1043 FLEX_ALLOC_STR(update
, refname
, refname
);
1044 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
1045 transaction
->updates
[transaction
->nr
++] = update
;
1047 update
->flags
= flags
;
1049 if (flags
& REF_HAVE_NEW
)
1050 oidcpy(&update
->new_oid
, new_oid
);
1051 if (flags
& REF_HAVE_OLD
)
1052 oidcpy(&update
->old_oid
, old_oid
);
1053 update
->msg
= xstrdup_or_null(msg
);
1057 int ref_transaction_update(struct ref_transaction
*transaction
,
1058 const char *refname
,
1059 const struct object_id
*new_oid
,
1060 const struct object_id
*old_oid
,
1061 unsigned int flags
, const char *msg
,
1066 if ((new_oid
&& !is_null_oid(new_oid
)) ?
1067 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
) :
1068 !refname_is_safe(refname
)) {
1069 strbuf_addf(err
, _("refusing to update ref with bad name '%s'"),
1074 if (flags
& ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS
)
1075 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags
);
1077 flags
|= (new_oid
? REF_HAVE_NEW
: 0) | (old_oid
? REF_HAVE_OLD
: 0);
1079 ref_transaction_add_update(transaction
, refname
, flags
,
1080 new_oid
, old_oid
, msg
);
1084 int ref_transaction_create(struct ref_transaction
*transaction
,
1085 const char *refname
,
1086 const struct object_id
*new_oid
,
1087 unsigned int flags
, const char *msg
,
1090 if (!new_oid
|| is_null_oid(new_oid
))
1091 BUG("create called without valid new_oid");
1092 return ref_transaction_update(transaction
, refname
, new_oid
,
1093 &null_oid
, flags
, msg
, err
);
1096 int ref_transaction_delete(struct ref_transaction
*transaction
,
1097 const char *refname
,
1098 const struct object_id
*old_oid
,
1099 unsigned int flags
, const char *msg
,
1102 if (old_oid
&& is_null_oid(old_oid
))
1103 BUG("delete called with old_oid set to zeros");
1104 return ref_transaction_update(transaction
, refname
,
1109 int ref_transaction_verify(struct ref_transaction
*transaction
,
1110 const char *refname
,
1111 const struct object_id
*old_oid
,
1116 BUG("verify called with old_oid set to NULL");
1117 return ref_transaction_update(transaction
, refname
,
1122 int refs_update_ref(struct ref_store
*refs
, const char *msg
,
1123 const char *refname
, const struct object_id
*new_oid
,
1124 const struct object_id
*old_oid
, unsigned int flags
,
1125 enum action_on_err onerr
)
1127 struct ref_transaction
*t
= NULL
;
1128 struct strbuf err
= STRBUF_INIT
;
1131 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
1132 assert(refs
== get_main_ref_store(the_repository
));
1133 ret
= write_pseudoref(refname
, new_oid
, old_oid
, &err
);
1135 t
= ref_store_transaction_begin(refs
, &err
);
1137 ref_transaction_update(t
, refname
, new_oid
, old_oid
,
1138 flags
, msg
, &err
) ||
1139 ref_transaction_commit(t
, &err
)) {
1141 ref_transaction_free(t
);
1145 const char *str
= _("update_ref failed for ref '%s': %s");
1148 case UPDATE_REFS_MSG_ON_ERR
:
1149 error(str
, refname
, err
.buf
);
1151 case UPDATE_REFS_DIE_ON_ERR
:
1152 die(str
, refname
, err
.buf
);
1154 case UPDATE_REFS_QUIET_ON_ERR
:
1157 strbuf_release(&err
);
1160 strbuf_release(&err
);
1162 ref_transaction_free(t
);
1166 int update_ref(const char *msg
, const char *refname
,
1167 const struct object_id
*new_oid
,
1168 const struct object_id
*old_oid
,
1169 unsigned int flags
, enum action_on_err onerr
)
1171 return refs_update_ref(get_main_ref_store(the_repository
), msg
, refname
, new_oid
,
1172 old_oid
, flags
, onerr
);
1175 char *refs_shorten_unambiguous_ref(struct ref_store
*refs
,
1176 const char *refname
, int strict
)
1179 static char **scanf_fmts
;
1180 static int nr_rules
;
1182 struct strbuf resolved_buf
= STRBUF_INIT
;
1186 * Pre-generate scanf formats from ref_rev_parse_rules[].
1187 * Generate a format suitable for scanf from a
1188 * ref_rev_parse_rules rule by interpolating "%s" at the
1189 * location of the "%.*s".
1191 size_t total_len
= 0;
1194 /* the rule list is NULL terminated, count them first */
1195 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
1196 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1197 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
1199 scanf_fmts
= xmalloc(st_add(st_mult(sizeof(char *), nr_rules
), total_len
));
1202 for (i
= 0; i
< nr_rules
; i
++) {
1203 assert(offset
< total_len
);
1204 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
1205 offset
+= xsnprintf(scanf_fmts
[i
], total_len
- offset
,
1206 ref_rev_parse_rules
[i
], 2, "%s") + 1;
1210 /* bail out if there are no rules */
1212 return xstrdup(refname
);
1214 /* buffer for scanf result, at most refname must fit */
1215 short_name
= xstrdup(refname
);
1217 /* skip first rule, it will always match */
1218 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
1220 int rules_to_fail
= i
;
1223 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
1226 short_name_len
= strlen(short_name
);
1229 * in strict mode, all (except the matched one) rules
1230 * must fail to resolve to a valid non-ambiguous ref
1233 rules_to_fail
= nr_rules
;
1236 * check if the short name resolves to a valid ref,
1237 * but use only rules prior to the matched one
1239 for (j
= 0; j
< rules_to_fail
; j
++) {
1240 const char *rule
= ref_rev_parse_rules
[j
];
1242 /* skip matched rule */
1247 * the short name is ambiguous, if it resolves
1248 * (with this previous rule) to a valid ref
1249 * read_ref() returns 0 on success
1251 strbuf_reset(&resolved_buf
);
1252 strbuf_addf(&resolved_buf
, rule
,
1253 short_name_len
, short_name
);
1254 if (refs_ref_exists(refs
, resolved_buf
.buf
))
1259 * short name is non-ambiguous if all previous rules
1260 * haven't resolved to a valid ref
1262 if (j
== rules_to_fail
) {
1263 strbuf_release(&resolved_buf
);
1268 strbuf_release(&resolved_buf
);
1270 return xstrdup(refname
);
1273 char *shorten_unambiguous_ref(const char *refname
, int strict
)
1275 return refs_shorten_unambiguous_ref(get_main_ref_store(the_repository
),
1279 static struct string_list
*hide_refs
;
1281 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
1284 if (!strcmp("transfer.hiderefs", var
) ||
1285 (!parse_config_key(var
, section
, NULL
, NULL
, &key
) &&
1286 !strcmp(key
, "hiderefs"))) {
1291 return config_error_nonbool(var
);
1292 ref
= xstrdup(value
);
1294 while (len
&& ref
[len
- 1] == '/')
1297 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
1298 hide_refs
->strdup_strings
= 1;
1300 string_list_append(hide_refs
, ref
);
1305 int ref_is_hidden(const char *refname
, const char *refname_full
)
1311 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
1312 const char *match
= hide_refs
->items
[i
].string
;
1313 const char *subject
;
1317 if (*match
== '!') {
1322 if (*match
== '^') {
1323 subject
= refname_full
;
1329 /* refname can be NULL when namespaces are used. */
1331 skip_prefix(subject
, match
, &p
) &&
1338 const char *find_descendant_ref(const char *dirname
,
1339 const struct string_list
*extras
,
1340 const struct string_list
*skip
)
1348 * Look at the place where dirname would be inserted into
1349 * extras. If there is an entry at that position that starts
1350 * with dirname (remember, dirname includes the trailing
1351 * slash) and is not in skip, then we have a conflict.
1353 for (pos
= string_list_find_insert_index(extras
, dirname
, 0);
1354 pos
< extras
->nr
; pos
++) {
1355 const char *extra_refname
= extras
->items
[pos
].string
;
1357 if (!starts_with(extra_refname
, dirname
))
1360 if (!skip
|| !string_list_has_string(skip
, extra_refname
))
1361 return extra_refname
;
1366 int refs_rename_ref_available(struct ref_store
*refs
,
1367 const char *old_refname
,
1368 const char *new_refname
)
1370 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1371 struct strbuf err
= STRBUF_INIT
;
1374 string_list_insert(&skip
, old_refname
);
1375 ok
= !refs_verify_refname_available(refs
, new_refname
,
1378 error("%s", err
.buf
);
1380 string_list_clear(&skip
, 0);
1381 strbuf_release(&err
);
1385 int refs_head_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1387 struct object_id oid
;
1390 if (!refs_read_ref_full(refs
, "HEAD", RESOLVE_REF_READING
,
1392 return fn("HEAD", &oid
, flag
, cb_data
);
1397 int head_ref(each_ref_fn fn
, void *cb_data
)
1399 return refs_head_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1402 struct ref_iterator
*refs_ref_iterator_begin(
1403 struct ref_store
*refs
,
1404 const char *prefix
, int trim
, int flags
)
1406 struct ref_iterator
*iter
;
1408 if (ref_paranoia
< 0)
1409 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1411 flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1413 iter
= refs
->be
->iterator_begin(refs
, prefix
, flags
);
1416 * `iterator_begin()` already takes care of prefix, but we
1417 * might need to do some trimming:
1420 iter
= prefix_ref_iterator_begin(iter
, "", trim
);
1422 /* Sanity check for subclasses: */
1424 BUG("reference iterator is not ordered");
1430 * Call fn for each reference in the specified submodule for which the
1431 * refname begins with prefix. If trim is non-zero, then trim that
1432 * many characters off the beginning of each refname before passing
1433 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1434 * include broken references in the iteration. If fn ever returns a
1435 * non-zero value, stop the iteration and return that value;
1436 * otherwise, return 0.
1438 static int do_for_each_repo_ref(struct repository
*r
, const char *prefix
,
1439 each_repo_ref_fn fn
, int trim
, int flags
,
1442 struct ref_iterator
*iter
;
1443 struct ref_store
*refs
= get_main_ref_store(r
);
1448 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1450 return do_for_each_repo_ref_iterator(r
, iter
, fn
, cb_data
);
1453 struct do_for_each_ref_help
{
1458 static int do_for_each_ref_helper(struct repository
*r
,
1459 const char *refname
,
1460 const struct object_id
*oid
,
1464 struct do_for_each_ref_help
*hp
= cb_data
;
1466 return hp
->fn(refname
, oid
, flags
, hp
->cb_data
);
1469 static int do_for_each_ref(struct ref_store
*refs
, const char *prefix
,
1470 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1472 struct ref_iterator
*iter
;
1473 struct do_for_each_ref_help hp
= { fn
, cb_data
};
1478 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1480 return do_for_each_repo_ref_iterator(the_repository
, iter
,
1481 do_for_each_ref_helper
, &hp
);
1484 int refs_for_each_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1486 return do_for_each_ref(refs
, "", fn
, 0, 0, cb_data
);
1489 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1491 return refs_for_each_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1494 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
1495 each_ref_fn fn
, void *cb_data
)
1497 return do_for_each_ref(refs
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1500 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1502 return refs_for_each_ref_in(get_main_ref_store(the_repository
), prefix
, fn
, cb_data
);
1505 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
1507 unsigned int flag
= 0;
1510 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1511 return do_for_each_ref(get_main_ref_store(the_repository
),
1512 prefix
, fn
, 0, flag
, cb_data
);
1515 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
1516 each_ref_fn fn
, void *cb_data
,
1517 unsigned int broken
)
1519 unsigned int flag
= 0;
1522 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1523 return do_for_each_ref(refs
, prefix
, fn
, 0, flag
, cb_data
);
1526 int for_each_replace_ref(struct repository
*r
, each_repo_ref_fn fn
, void *cb_data
)
1528 return do_for_each_repo_ref(r
, git_replace_ref_base
, fn
,
1529 strlen(git_replace_ref_base
),
1530 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1533 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1535 struct strbuf buf
= STRBUF_INIT
;
1537 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1538 ret
= do_for_each_ref(get_main_ref_store(the_repository
),
1539 buf
.buf
, fn
, 0, 0, cb_data
);
1540 strbuf_release(&buf
);
1544 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1546 return do_for_each_ref(refs
, "", fn
, 0,
1547 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1550 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1552 return refs_for_each_rawref(get_main_ref_store(the_repository
), fn
, cb_data
);
1555 int refs_read_raw_ref(struct ref_store
*ref_store
,
1556 const char *refname
, struct object_id
*oid
,
1557 struct strbuf
*referent
, unsigned int *type
)
1559 return ref_store
->be
->read_raw_ref(ref_store
, refname
, oid
, referent
, type
);
1562 /* This function needs to return a meaningful errno on failure */
1563 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
1564 const char *refname
,
1566 struct object_id
*oid
, int *flags
)
1568 static struct strbuf sb_refname
= STRBUF_INIT
;
1569 struct object_id unused_oid
;
1576 flags
= &unused_flags
;
1580 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1581 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1582 !refname_is_safe(refname
)) {
1588 * dwim_ref() uses REF_ISBROKEN to distinguish between
1589 * missing refs and refs that were present but invalid,
1590 * to complain about the latter to stderr.
1592 * We don't know whether the ref exists, so don't set
1595 *flags
|= REF_BAD_NAME
;
1598 for (symref_count
= 0; symref_count
< SYMREF_MAXDEPTH
; symref_count
++) {
1599 unsigned int read_flags
= 0;
1601 if (refs_read_raw_ref(refs
, refname
,
1602 oid
, &sb_refname
, &read_flags
)) {
1603 *flags
|= read_flags
;
1605 /* In reading mode, refs must eventually resolve */
1606 if (resolve_flags
& RESOLVE_REF_READING
)
1610 * Otherwise a missing ref is OK. But the files backend
1611 * may show errors besides ENOENT if there are
1612 * similarly-named refs.
1614 if (errno
!= ENOENT
&&
1620 if (*flags
& REF_BAD_NAME
)
1621 *flags
|= REF_ISBROKEN
;
1625 *flags
|= read_flags
;
1627 if (!(read_flags
& REF_ISSYMREF
)) {
1628 if (*flags
& REF_BAD_NAME
) {
1630 *flags
|= REF_ISBROKEN
;
1635 refname
= sb_refname
.buf
;
1636 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1640 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1641 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1642 !refname_is_safe(refname
)) {
1647 *flags
|= REF_ISBROKEN
| REF_BAD_NAME
;
1655 /* backend functions */
1656 int refs_init_db(struct strbuf
*err
)
1658 struct ref_store
*refs
= get_main_ref_store(the_repository
);
1660 return refs
->be
->init_db(refs
, err
);
1663 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1664 struct object_id
*oid
, int *flags
)
1666 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository
), refname
,
1667 resolve_flags
, oid
, flags
);
1670 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
1671 struct object_id
*oid
)
1673 struct ref_store
*refs
;
1676 refs
= get_submodule_ref_store(submodule
);
1681 if (!refs_resolve_ref_unsafe(refs
, refname
, 0, oid
, &flags
) ||
1687 struct ref_store_hash_entry
1689 struct hashmap_entry ent
; /* must be the first member! */
1691 struct ref_store
*refs
;
1693 /* NUL-terminated identifier of the ref store: */
1694 char name
[FLEX_ARRAY
];
1697 static int ref_store_hash_cmp(const void *unused_cmp_data
,
1698 const void *entry
, const void *entry_or_key
,
1699 const void *keydata
)
1701 const struct ref_store_hash_entry
*e1
= entry
, *e2
= entry_or_key
;
1702 const char *name
= keydata
? keydata
: e2
->name
;
1704 return strcmp(e1
->name
, name
);
1707 static struct ref_store_hash_entry
*alloc_ref_store_hash_entry(
1708 const char *name
, struct ref_store
*refs
)
1710 struct ref_store_hash_entry
*entry
;
1712 FLEX_ALLOC_STR(entry
, name
, name
);
1713 hashmap_entry_init(entry
, strhash(name
));
1718 /* A hashmap of ref_stores, stored by submodule name: */
1719 static struct hashmap submodule_ref_stores
;
1721 /* A hashmap of ref_stores, stored by worktree id: */
1722 static struct hashmap worktree_ref_stores
;
1725 * Look up a ref store by name. If that ref_store hasn't been
1726 * registered yet, return NULL.
1728 static struct ref_store
*lookup_ref_store_map(struct hashmap
*map
,
1731 struct ref_store_hash_entry
*entry
;
1733 if (!map
->tablesize
)
1734 /* It's initialized on demand in register_ref_store(). */
1737 entry
= hashmap_get_from_hash(map
, strhash(name
), name
);
1738 return entry
? entry
->refs
: NULL
;
1742 * Create, record, and return a ref_store instance for the specified
1745 static struct ref_store
*ref_store_init(const char *gitdir
,
1748 const char *be_name
= "files";
1749 struct ref_storage_be
*be
= find_ref_storage_backend(be_name
);
1750 struct ref_store
*refs
;
1753 BUG("reference backend %s is unknown", be_name
);
1755 refs
= be
->init(gitdir
, flags
);
1759 struct ref_store
*get_main_ref_store(struct repository
*r
)
1765 BUG("attempting to get main_ref_store outside of repository");
1767 r
->refs
= ref_store_init(r
->gitdir
, REF_STORE_ALL_CAPS
);
1772 * Associate a ref store with a name. It is a fatal error to call this
1773 * function twice for the same name.
1775 static void register_ref_store_map(struct hashmap
*map
,
1777 struct ref_store
*refs
,
1780 if (!map
->tablesize
)
1781 hashmap_init(map
, ref_store_hash_cmp
, NULL
, 0);
1783 if (hashmap_put(map
, alloc_ref_store_hash_entry(name
, refs
)))
1784 BUG("%s ref_store '%s' initialized twice", type
, name
);
1787 struct ref_store
*get_submodule_ref_store(const char *submodule
)
1789 struct strbuf submodule_sb
= STRBUF_INIT
;
1790 struct ref_store
*refs
;
1791 char *to_free
= NULL
;
1797 len
= strlen(submodule
);
1798 while (len
&& is_dir_sep(submodule
[len
- 1]))
1804 /* We need to strip off one or more trailing slashes */
1805 submodule
= to_free
= xmemdupz(submodule
, len
);
1807 refs
= lookup_ref_store_map(&submodule_ref_stores
, submodule
);
1811 strbuf_addstr(&submodule_sb
, submodule
);
1812 if (!is_nonbare_repository_dir(&submodule_sb
))
1815 if (submodule_to_gitdir(&submodule_sb
, submodule
))
1818 /* assume that add_submodule_odb() has been called */
1819 refs
= ref_store_init(submodule_sb
.buf
,
1820 REF_STORE_READ
| REF_STORE_ODB
);
1821 register_ref_store_map(&submodule_ref_stores
, "submodule",
1825 strbuf_release(&submodule_sb
);
1831 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
)
1833 struct ref_store
*refs
;
1837 return get_main_ref_store(the_repository
);
1839 id
= wt
->id
? wt
->id
: "/";
1840 refs
= lookup_ref_store_map(&worktree_ref_stores
, id
);
1845 refs
= ref_store_init(git_common_path("worktrees/%s", wt
->id
),
1846 REF_STORE_ALL_CAPS
);
1848 refs
= ref_store_init(get_git_common_dir(),
1849 REF_STORE_ALL_CAPS
);
1852 register_ref_store_map(&worktree_ref_stores
, "worktree",
1857 void base_ref_store_init(struct ref_store
*refs
,
1858 const struct ref_storage_be
*be
)
1863 /* backend functions */
1864 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
)
1866 return refs
->be
->pack_refs(refs
, flags
);
1869 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
1870 struct object_id
*oid
)
1873 struct object_id base
;
1875 if (current_ref_iter
&& current_ref_iter
->refname
== refname
) {
1876 struct object_id peeled
;
1878 if (ref_iterator_peel(current_ref_iter
, &peeled
))
1880 oidcpy(oid
, &peeled
);
1884 if (refs_read_ref_full(refs
, refname
,
1885 RESOLVE_REF_READING
, &base
, &flag
))
1888 return peel_object(&base
, oid
);
1891 int peel_ref(const char *refname
, struct object_id
*oid
)
1893 return refs_peel_ref(get_main_ref_store(the_repository
), refname
, oid
);
1896 int refs_create_symref(struct ref_store
*refs
,
1897 const char *ref_target
,
1898 const char *refs_heads_master
,
1901 return refs
->be
->create_symref(refs
, ref_target
,
1906 int create_symref(const char *ref_target
, const char *refs_heads_master
,
1909 return refs_create_symref(get_main_ref_store(the_repository
), ref_target
,
1910 refs_heads_master
, logmsg
);
1913 int ref_update_reject_duplicates(struct string_list
*refnames
,
1916 size_t i
, n
= refnames
->nr
;
1920 for (i
= 1; i
< n
; i
++) {
1921 int cmp
= strcmp(refnames
->items
[i
- 1].string
,
1922 refnames
->items
[i
].string
);
1926 _("multiple updates for ref '%s' not allowed"),
1927 refnames
->items
[i
].string
);
1929 } else if (cmp
> 0) {
1930 BUG("ref_update_reject_duplicates() received unsorted list");
1936 int ref_transaction_prepare(struct ref_transaction
*transaction
,
1939 struct ref_store
*refs
= transaction
->ref_store
;
1941 switch (transaction
->state
) {
1942 case REF_TRANSACTION_OPEN
:
1945 case REF_TRANSACTION_PREPARED
:
1946 BUG("prepare called twice on reference transaction");
1948 case REF_TRANSACTION_CLOSED
:
1949 BUG("prepare called on a closed reference transaction");
1952 BUG("unexpected reference transaction state");
1956 if (getenv(GIT_QUARANTINE_ENVIRONMENT
)) {
1958 _("ref updates forbidden inside quarantine environment"));
1962 return refs
->be
->transaction_prepare(refs
, transaction
, err
);
1965 int ref_transaction_abort(struct ref_transaction
*transaction
,
1968 struct ref_store
*refs
= transaction
->ref_store
;
1971 switch (transaction
->state
) {
1972 case REF_TRANSACTION_OPEN
:
1973 /* No need to abort explicitly. */
1975 case REF_TRANSACTION_PREPARED
:
1976 ret
= refs
->be
->transaction_abort(refs
, transaction
, err
);
1978 case REF_TRANSACTION_CLOSED
:
1979 BUG("abort called on a closed reference transaction");
1982 BUG("unexpected reference transaction state");
1986 ref_transaction_free(transaction
);
1990 int ref_transaction_commit(struct ref_transaction
*transaction
,
1993 struct ref_store
*refs
= transaction
->ref_store
;
1996 switch (transaction
->state
) {
1997 case REF_TRANSACTION_OPEN
:
1998 /* Need to prepare first. */
1999 ret
= ref_transaction_prepare(transaction
, err
);
2003 case REF_TRANSACTION_PREPARED
:
2004 /* Fall through to finish. */
2006 case REF_TRANSACTION_CLOSED
:
2007 BUG("commit called on a closed reference transaction");
2010 BUG("unexpected reference transaction state");
2014 return refs
->be
->transaction_finish(refs
, transaction
, err
);
2017 int refs_verify_refname_available(struct ref_store
*refs
,
2018 const char *refname
,
2019 const struct string_list
*extras
,
2020 const struct string_list
*skip
,
2024 const char *extra_refname
;
2025 struct strbuf dirname
= STRBUF_INIT
;
2026 struct strbuf referent
= STRBUF_INIT
;
2027 struct object_id oid
;
2029 struct ref_iterator
*iter
;
2034 * For the sake of comments in this function, suppose that
2035 * refname is "refs/foo/bar".
2040 strbuf_grow(&dirname
, strlen(refname
) + 1);
2041 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
2042 /* Expand dirname to the new prefix, not including the trailing slash: */
2043 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
2046 * We are still at a leading dir of the refname (e.g.,
2047 * "refs/foo"; if there is a reference with that name,
2048 * it is a conflict, *unless* it is in skip.
2050 if (skip
&& string_list_has_string(skip
, dirname
.buf
))
2053 if (!refs_read_raw_ref(refs
, dirname
.buf
, &oid
, &referent
, &type
)) {
2054 strbuf_addf(err
, _("'%s' exists; cannot create '%s'"),
2055 dirname
.buf
, refname
);
2059 if (extras
&& string_list_has_string(extras
, dirname
.buf
)) {
2060 strbuf_addf(err
, _("cannot process '%s' and '%s' at the same time"),
2061 refname
, dirname
.buf
);
2067 * We are at the leaf of our refname (e.g., "refs/foo/bar").
2068 * There is no point in searching for a reference with that
2069 * name, because a refname isn't considered to conflict with
2070 * itself. But we still need to check for references whose
2071 * names are in the "refs/foo/bar/" namespace, because they
2074 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
2075 strbuf_addch(&dirname
, '/');
2077 iter
= refs_ref_iterator_begin(refs
, dirname
.buf
, 0,
2078 DO_FOR_EACH_INCLUDE_BROKEN
);
2079 while ((ok
= ref_iterator_advance(iter
)) == ITER_OK
) {
2081 string_list_has_string(skip
, iter
->refname
))
2084 strbuf_addf(err
, _("'%s' exists; cannot create '%s'"),
2085 iter
->refname
, refname
);
2086 ref_iterator_abort(iter
);
2090 if (ok
!= ITER_DONE
)
2091 BUG("error while iterating over references");
2093 extra_refname
= find_descendant_ref(dirname
.buf
, extras
, skip
);
2095 strbuf_addf(err
, _("cannot process '%s' and '%s' at the same time"),
2096 refname
, extra_refname
);
2101 strbuf_release(&referent
);
2102 strbuf_release(&dirname
);
2106 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
2108 struct ref_iterator
*iter
;
2109 struct do_for_each_ref_help hp
= { fn
, cb_data
};
2111 iter
= refs
->be
->reflog_iterator_begin(refs
);
2113 return do_for_each_repo_ref_iterator(the_repository
, iter
,
2114 do_for_each_ref_helper
, &hp
);
2117 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
2119 return refs_for_each_reflog(get_main_ref_store(the_repository
), fn
, cb_data
);
2122 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
2123 const char *refname
,
2124 each_reflog_ent_fn fn
,
2127 return refs
->be
->for_each_reflog_ent_reverse(refs
, refname
,
2131 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
2134 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository
),
2135 refname
, fn
, cb_data
);
2138 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
2139 each_reflog_ent_fn fn
, void *cb_data
)
2141 return refs
->be
->for_each_reflog_ent(refs
, refname
, fn
, cb_data
);
2144 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
2147 return refs_for_each_reflog_ent(get_main_ref_store(the_repository
), refname
,
2151 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
)
2153 return refs
->be
->reflog_exists(refs
, refname
);
2156 int reflog_exists(const char *refname
)
2158 return refs_reflog_exists(get_main_ref_store(the_repository
), refname
);
2161 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
2162 int force_create
, struct strbuf
*err
)
2164 return refs
->be
->create_reflog(refs
, refname
, force_create
, err
);
2167 int safe_create_reflog(const char *refname
, int force_create
,
2170 return refs_create_reflog(get_main_ref_store(the_repository
), refname
,
2174 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
)
2176 return refs
->be
->delete_reflog(refs
, refname
);
2179 int delete_reflog(const char *refname
)
2181 return refs_delete_reflog(get_main_ref_store(the_repository
), refname
);
2184 int refs_reflog_expire(struct ref_store
*refs
,
2185 const char *refname
, const struct object_id
*oid
,
2187 reflog_expiry_prepare_fn prepare_fn
,
2188 reflog_expiry_should_prune_fn should_prune_fn
,
2189 reflog_expiry_cleanup_fn cleanup_fn
,
2190 void *policy_cb_data
)
2192 return refs
->be
->reflog_expire(refs
, refname
, oid
, flags
,
2193 prepare_fn
, should_prune_fn
,
2194 cleanup_fn
, policy_cb_data
);
2197 int reflog_expire(const char *refname
, const struct object_id
*oid
,
2199 reflog_expiry_prepare_fn prepare_fn
,
2200 reflog_expiry_should_prune_fn should_prune_fn
,
2201 reflog_expiry_cleanup_fn cleanup_fn
,
2202 void *policy_cb_data
)
2204 return refs_reflog_expire(get_main_ref_store(the_repository
),
2205 refname
, oid
, flags
,
2206 prepare_fn
, should_prune_fn
,
2207 cleanup_fn
, policy_cb_data
);
2210 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
2213 struct ref_store
*refs
= transaction
->ref_store
;
2215 return refs
->be
->initial_transaction_commit(refs
, transaction
, err
);
2218 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
2219 struct string_list
*refnames
, unsigned int flags
)
2221 return refs
->be
->delete_refs(refs
, msg
, refnames
, flags
);
2224 int delete_refs(const char *msg
, struct string_list
*refnames
,
2227 return refs_delete_refs(get_main_ref_store(the_repository
), msg
, refnames
, flags
);
2230 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
2231 const char *newref
, const char *logmsg
)
2233 return refs
->be
->rename_ref(refs
, oldref
, newref
, logmsg
);
2236 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2238 return refs_rename_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);
2241 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
2242 const char *newref
, const char *logmsg
)
2244 return refs
->be
->copy_ref(refs
, oldref
, newref
, logmsg
);
2247 int copy_existing_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2249 return refs_copy_existing_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);