2 * The backend-independent part of the reference module.
11 #include "refs/refs-internal.h"
12 #include "run-command.h"
13 #include "object-store.h"
16 #include "submodule.h"
18 #include "argv-array.h"
19 #include "repository.h"
23 * List of all available backends
25 static struct ref_storage_be
*refs_backends
= &refs_be_files
;
27 static struct ref_storage_be
*find_ref_storage_backend(const char *name
)
29 struct ref_storage_be
*be
;
30 for (be
= refs_backends
; be
; be
= be
->next
)
31 if (!strcmp(be
->name
, name
))
36 int ref_storage_backend_exists(const char *name
)
38 return find_ref_storage_backend(name
) != NULL
;
42 * How to handle various characters in refnames:
43 * 0: An acceptable character for refs
45 * 2: ., look for a preceding . to reject .. in refs
46 * 3: {, look for a preceding @ to reject @{ in refs
47 * 4: A bad character: ASCII control characters, and
48 * ":", "?", "[", "\", "^", "~", SP, or TAB
49 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
51 static unsigned char refname_disposition
[256] = {
52 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
53 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
54 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
55 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
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, 4, 4, 0, 4, 0,
58 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
59 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
63 * Try to read one refname component from the front of refname.
64 * Return the length of the component found, or -1 if the component is
65 * not legal. It is legal if it is something reasonable to have under
66 * ".git/refs/"; We do not like it if:
68 * - it begins with ".", or
69 * - it has double dots "..", or
70 * - it has ASCII control characters, or
71 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
72 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
73 * - it ends with a "/", or
74 * - it ends with ".lock", or
75 * - it contains a "@{" portion
77 * When sanitized is not NULL, instead of rejecting the input refname
78 * as an error, try to come up with a usable replacement for the input
81 static int check_refname_component(const char *refname
, int *flags
,
82 struct strbuf
*sanitized
)
86 size_t component_start
= 0; /* garbage - not a reasonable initial value */
89 component_start
= sanitized
->len
;
91 for (cp
= refname
; ; cp
++) {
93 unsigned char disp
= refname_disposition
[ch
];
95 if (sanitized
&& disp
!= 1)
96 strbuf_addch(sanitized
, ch
);
102 if (last
== '.') { /* Refname contains "..". */
104 /* collapse ".." to single "." */
105 strbuf_setlen(sanitized
, sanitized
->len
- 1);
111 if (last
== '@') { /* Refname contains "@{". */
113 sanitized
->buf
[sanitized
->len
-1] = '-';
121 sanitized
->buf
[sanitized
->len
-1] = '-';
126 if (!(*flags
& REFNAME_REFSPEC_PATTERN
)) {
127 /* refspec can't be a pattern */
129 sanitized
->buf
[sanitized
->len
-1] = '-';
135 * Unset the pattern flag so that we only accept
136 * a single asterisk for one side of refspec.
138 *flags
&= ~ REFNAME_REFSPEC_PATTERN
;
145 return 0; /* Component has zero length. */
147 if (refname
[0] == '.') { /* Component starts with '.'. */
149 sanitized
->buf
[component_start
] = '-';
153 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
154 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
)) {
157 /* Refname ends with ".lock". */
158 while (strbuf_strip_suffix(sanitized
, LOCK_SUFFIX
)) {
159 /* try again in case we have .lock.lock */
165 static int check_or_sanitize_refname(const char *refname
, int flags
,
166 struct strbuf
*sanitized
)
168 int component_len
, component_count
= 0;
170 if (!strcmp(refname
, "@")) {
171 /* Refname is a single character '@'. */
173 strbuf_addch(sanitized
, '-');
179 if (sanitized
&& sanitized
->len
)
180 strbuf_complete(sanitized
, '/');
182 /* We are at the start of a path component. */
183 component_len
= check_refname_component(refname
, &flags
,
185 if (sanitized
&& component_len
== 0)
186 ; /* OK, omit empty component */
187 else if (component_len
<= 0)
191 if (refname
[component_len
] == '\0')
193 /* Skip to next component. */
194 refname
+= component_len
+ 1;
197 if (refname
[component_len
- 1] == '.') {
198 /* Refname ends with '.'. */
200 ; /* omit ending dot */
204 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
205 return -1; /* Refname has only one component. */
209 int check_refname_format(const char *refname
, int flags
)
211 return check_or_sanitize_refname(refname
, flags
, NULL
);
214 void sanitize_refname_component(const char *refname
, struct strbuf
*out
)
216 if (check_or_sanitize_refname(refname
, REFNAME_ALLOW_ONELEVEL
, out
))
217 BUG("sanitizing refname '%s' check returned error", refname
);
220 int refname_is_safe(const char *refname
)
224 if (skip_prefix(refname
, "refs/", &rest
)) {
227 size_t restlen
= strlen(rest
);
229 /* rest must not be empty, or start or end with "/" */
230 if (!restlen
|| *rest
== '/' || rest
[restlen
- 1] == '/')
234 * Does the refname try to escape refs/?
235 * For example: refs/foo/../bar is safe but refs/foo/../../bar
238 buf
= xmallocz(restlen
);
239 result
= !normalize_path_copy(buf
, rest
) && !strcmp(buf
, rest
);
245 if (!isupper(*refname
) && *refname
!= '_')
253 * Return true if refname, which has the specified oid and flags, can
254 * be resolved to an object in the database. If the referred-to object
255 * does not exist, emit a warning and return false.
257 int ref_resolves_to_object(const char *refname
,
258 const struct object_id
*oid
,
261 if (flags
& REF_ISBROKEN
)
263 if (!has_object_file(oid
)) {
264 error(_("%s does not point to a valid object!"), refname
);
270 char *refs_resolve_refdup(struct ref_store
*refs
,
271 const char *refname
, int resolve_flags
,
272 struct object_id
*oid
, int *flags
)
276 result
= refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
,
278 return xstrdup_or_null(result
);
281 char *resolve_refdup(const char *refname
, int resolve_flags
,
282 struct object_id
*oid
, int *flags
)
284 return refs_resolve_refdup(get_main_ref_store(the_repository
),
285 refname
, resolve_flags
,
289 /* The argument to filter_refs */
297 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
298 int resolve_flags
, struct object_id
*oid
, int *flags
)
300 if (refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
, oid
, flags
))
305 int read_ref_full(const char *refname
, int resolve_flags
, struct object_id
*oid
, int *flags
)
307 return refs_read_ref_full(get_main_ref_store(the_repository
), refname
,
308 resolve_flags
, oid
, flags
);
311 int read_ref(const char *refname
, struct object_id
*oid
)
313 return read_ref_full(refname
, RESOLVE_REF_READING
, oid
, NULL
);
316 static int refs_ref_exists(struct ref_store
*refs
, const char *refname
)
318 return !!refs_resolve_ref_unsafe(refs
, refname
, RESOLVE_REF_READING
, NULL
, NULL
);
321 int ref_exists(const char *refname
)
323 return refs_ref_exists(get_main_ref_store(the_repository
), refname
);
326 static int filter_refs(const char *refname
, const struct object_id
*oid
,
327 int flags
, void *data
)
329 struct ref_filter
*filter
= (struct ref_filter
*)data
;
331 if (wildmatch(filter
->pattern
, refname
, 0))
334 skip_prefix(refname
, filter
->prefix
, &refname
);
335 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
338 enum peel_status
peel_object(const struct object_id
*name
, struct object_id
*oid
)
340 struct object
*o
= lookup_unknown_object(name
);
342 if (o
->type
== OBJ_NONE
) {
343 int type
= oid_object_info(the_repository
, name
, NULL
);
344 if (type
< 0 || !object_as_type(o
, type
, 0))
348 if (o
->type
!= OBJ_TAG
)
351 o
= deref_tag_noverify(o
);
355 oidcpy(oid
, &o
->oid
);
359 struct warn_if_dangling_data
{
362 const struct string_list
*refnames
;
366 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
367 int flags
, void *cb_data
)
369 struct warn_if_dangling_data
*d
= cb_data
;
370 const char *resolves_to
;
372 if (!(flags
& REF_ISSYMREF
))
375 resolves_to
= resolve_ref_unsafe(refname
, 0, NULL
, NULL
);
378 ? strcmp(resolves_to
, d
->refname
)
379 : !string_list_has_string(d
->refnames
, resolves_to
))) {
383 fprintf(d
->fp
, d
->msg_fmt
, refname
);
388 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
390 struct warn_if_dangling_data data
;
393 data
.refname
= refname
;
394 data
.refnames
= NULL
;
395 data
.msg_fmt
= msg_fmt
;
396 for_each_rawref(warn_if_dangling_symref
, &data
);
399 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
401 struct warn_if_dangling_data data
;
405 data
.refnames
= refnames
;
406 data
.msg_fmt
= msg_fmt
;
407 for_each_rawref(warn_if_dangling_symref
, &data
);
410 int refs_for_each_tag_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
412 return refs_for_each_ref_in(refs
, "refs/tags/", fn
, cb_data
);
415 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
417 return refs_for_each_tag_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
420 int refs_for_each_branch_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
422 return refs_for_each_ref_in(refs
, "refs/heads/", fn
, cb_data
);
425 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
427 return refs_for_each_branch_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
430 int refs_for_each_remote_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
432 return refs_for_each_ref_in(refs
, "refs/remotes/", fn
, cb_data
);
435 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
437 return refs_for_each_remote_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
440 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
442 struct strbuf buf
= STRBUF_INIT
;
444 struct object_id oid
;
447 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
448 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, &oid
, &flag
))
449 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
450 strbuf_release(&buf
);
455 void normalize_glob_ref(struct string_list_item
*item
, const char *prefix
,
458 struct strbuf normalized_pattern
= STRBUF_INIT
;
461 BUG("pattern must not start with '/'");
464 strbuf_addstr(&normalized_pattern
, prefix
);
466 else if (!starts_with(pattern
, "refs/"))
467 strbuf_addstr(&normalized_pattern
, "refs/");
468 strbuf_addstr(&normalized_pattern
, pattern
);
469 strbuf_strip_suffix(&normalized_pattern
, "/");
471 item
->string
= strbuf_detach(&normalized_pattern
, NULL
);
472 item
->util
= has_glob_specials(pattern
) ? NULL
: item
->string
;
473 strbuf_release(&normalized_pattern
);
476 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
477 const char *prefix
, void *cb_data
)
479 struct strbuf real_pattern
= STRBUF_INIT
;
480 struct ref_filter filter
;
483 if (!prefix
&& !starts_with(pattern
, "refs/"))
484 strbuf_addstr(&real_pattern
, "refs/");
486 strbuf_addstr(&real_pattern
, prefix
);
487 strbuf_addstr(&real_pattern
, pattern
);
489 if (!has_glob_specials(pattern
)) {
490 /* Append implied '/' '*' if not present. */
491 strbuf_complete(&real_pattern
, '/');
492 /* No need to check for '*', there is none. */
493 strbuf_addch(&real_pattern
, '*');
496 filter
.pattern
= real_pattern
.buf
;
497 filter
.prefix
= prefix
;
499 filter
.cb_data
= cb_data
;
500 ret
= for_each_ref(filter_refs
, &filter
);
502 strbuf_release(&real_pattern
);
506 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
508 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
511 const char *prettify_refname(const char *name
)
513 if (skip_prefix(name
, "refs/heads/", &name
) ||
514 skip_prefix(name
, "refs/tags/", &name
) ||
515 skip_prefix(name
, "refs/remotes/", &name
))
520 static const char *ref_rev_parse_rules
[] = {
526 "refs/remotes/%.*s/HEAD",
530 #define NUM_REV_PARSE_RULES (ARRAY_SIZE(ref_rev_parse_rules) - 1)
533 * Is it possible that the caller meant full_name with abbrev_name?
534 * If so return a non-zero value to signal "yes"; the magnitude of
535 * the returned value gives the precedence used for disambiguation.
537 * If abbrev_name cannot mean full_name, return 0.
539 int refname_match(const char *abbrev_name
, const char *full_name
)
542 const int abbrev_name_len
= strlen(abbrev_name
);
543 const int num_rules
= NUM_REV_PARSE_RULES
;
545 for (p
= ref_rev_parse_rules
; *p
; p
++)
546 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
)))
547 return &ref_rev_parse_rules
[num_rules
] - p
;
553 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
554 * the results to 'prefixes'
556 void expand_ref_prefix(struct argv_array
*prefixes
, const char *prefix
)
559 int len
= strlen(prefix
);
561 for (p
= ref_rev_parse_rules
; *p
; p
++)
562 argv_array_pushf(prefixes
, *p
, len
, prefix
);
565 char *repo_default_branch_name(struct repository
*r
)
567 const char *config_key
= "init.defaultbranch";
568 const char *config_display_key
= "init.defaultBranch";
569 char *ret
= NULL
, *full_ref
;
571 if (repo_config_get_string(r
, config_key
, &ret
) < 0)
572 die(_("could not retrieve `%s`"), config_display_key
);
575 ret
= xstrdup("master");
577 full_ref
= xstrfmt("refs/heads/%s", ret
);
578 if (check_refname_format(full_ref
, 0))
579 die(_("invalid branch name: %s = %s"), config_display_key
, ret
);
585 const char *git_default_branch_name(void)
590 ret
= repo_default_branch_name(the_repository
);
596 * *string and *len will only be substituted, and *string returned (for
597 * later free()ing) if the string passed in is a magic short-hand form
600 static char *substitute_branch_name(struct repository
*r
,
601 const char **string
, int *len
)
603 struct strbuf buf
= STRBUF_INIT
;
604 struct interpret_branch_name_options options
= { 0 } ;
605 int ret
= repo_interpret_branch_name(r
, *string
, *len
, &buf
, &options
);
609 *string
= strbuf_detach(&buf
, &size
);
611 return (char *)*string
;
617 int repo_dwim_ref(struct repository
*r
, const char *str
, int len
,
618 struct object_id
*oid
, char **ref
)
620 char *last_branch
= substitute_branch_name(r
, &str
, &len
);
621 int refs_found
= expand_ref(r
, str
, len
, oid
, ref
);
626 int dwim_ref(const char *str
, int len
, struct object_id
*oid
, char **ref
)
628 return repo_dwim_ref(the_repository
, str
, len
, oid
, ref
);
631 int expand_ref(struct repository
*repo
, const char *str
, int len
,
632 struct object_id
*oid
, char **ref
)
636 struct strbuf fullref
= STRBUF_INIT
;
639 for (p
= ref_rev_parse_rules
; *p
; p
++) {
640 struct object_id oid_from_ref
;
641 struct object_id
*this_result
;
644 this_result
= refs_found
? &oid_from_ref
: oid
;
645 strbuf_reset(&fullref
);
646 strbuf_addf(&fullref
, *p
, len
, str
);
647 r
= refs_resolve_ref_unsafe(get_main_ref_store(repo
),
648 fullref
.buf
, RESOLVE_REF_READING
,
653 if (!warn_ambiguous_refs
)
655 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
.buf
, "HEAD")) {
656 warning(_("ignoring dangling symref %s"), fullref
.buf
);
657 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
.buf
, '/')) {
658 warning(_("ignoring broken ref %s"), fullref
.buf
);
661 strbuf_release(&fullref
);
665 int repo_dwim_log(struct repository
*r
, const char *str
, int len
,
666 struct object_id
*oid
, char **log
)
668 struct ref_store
*refs
= get_main_ref_store(r
);
669 char *last_branch
= substitute_branch_name(r
, &str
, &len
);
672 struct strbuf path
= STRBUF_INIT
;
675 for (p
= ref_rev_parse_rules
; *p
; p
++) {
676 struct object_id hash
;
677 const char *ref
, *it
;
680 strbuf_addf(&path
, *p
, len
, str
);
681 ref
= refs_resolve_ref_unsafe(refs
, path
.buf
,
686 if (refs_reflog_exists(refs
, path
.buf
))
688 else if (strcmp(ref
, path
.buf
) &&
689 refs_reflog_exists(refs
, ref
))
697 if (!warn_ambiguous_refs
)
700 strbuf_release(&path
);
705 int dwim_log(const char *str
, int len
, struct object_id
*oid
, char **log
)
707 return repo_dwim_log(the_repository
, str
, len
, oid
, log
);
710 static int is_per_worktree_ref(const char *refname
)
712 return !strcmp(refname
, "HEAD") ||
713 starts_with(refname
, "refs/worktree/") ||
714 starts_with(refname
, "refs/bisect/") ||
715 starts_with(refname
, "refs/rewritten/");
718 static int is_pseudoref_syntax(const char *refname
)
722 for (c
= refname
; *c
; c
++) {
723 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
730 static int is_main_pseudoref_syntax(const char *refname
)
732 return skip_prefix(refname
, "main-worktree/", &refname
) &&
734 is_pseudoref_syntax(refname
);
737 static int is_other_pseudoref_syntax(const char *refname
)
739 if (!skip_prefix(refname
, "worktrees/", &refname
))
741 refname
= strchr(refname
, '/');
742 if (!refname
|| !refname
[1])
744 return is_pseudoref_syntax(refname
+ 1);
747 enum ref_type
ref_type(const char *refname
)
749 if (is_per_worktree_ref(refname
))
750 return REF_TYPE_PER_WORKTREE
;
751 if (is_pseudoref_syntax(refname
))
752 return REF_TYPE_PSEUDOREF
;
753 if (is_main_pseudoref_syntax(refname
))
754 return REF_TYPE_MAIN_PSEUDOREF
;
755 if (is_other_pseudoref_syntax(refname
))
756 return REF_TYPE_OTHER_PSEUDOREF
;
757 return REF_TYPE_NORMAL
;
760 long get_files_ref_lock_timeout_ms(void)
762 static int configured
= 0;
764 /* The default timeout is 100 ms: */
765 static int timeout_ms
= 100;
768 git_config_get_int("core.filesreflocktimeout", &timeout_ms
);
775 static int write_pseudoref(const char *pseudoref
, const struct object_id
*oid
,
776 const struct object_id
*old_oid
, struct strbuf
*err
)
778 const char *filename
;
780 struct lock_file lock
= LOCK_INIT
;
781 struct strbuf buf
= STRBUF_INIT
;
787 strbuf_addf(&buf
, "%s\n", oid_to_hex(oid
));
789 filename
= git_path("%s", pseudoref
);
790 fd
= hold_lock_file_for_update_timeout(&lock
, filename
, 0,
791 get_files_ref_lock_timeout_ms());
793 strbuf_addf(err
, _("could not open '%s' for writing: %s"),
794 filename
, strerror(errno
));
799 struct object_id actual_old_oid
;
801 if (read_ref(pseudoref
, &actual_old_oid
)) {
802 if (!is_null_oid(old_oid
)) {
803 strbuf_addf(err
, _("could not read ref '%s'"),
805 rollback_lock_file(&lock
);
808 } else if (is_null_oid(old_oid
)) {
809 strbuf_addf(err
, _("ref '%s' already exists"),
811 rollback_lock_file(&lock
);
813 } else if (!oideq(&actual_old_oid
, old_oid
)) {
814 strbuf_addf(err
, _("unexpected object ID when writing '%s'"),
816 rollback_lock_file(&lock
);
821 if (write_in_full(fd
, buf
.buf
, buf
.len
) < 0) {
822 strbuf_addf(err
, _("could not write to '%s'"), filename
);
823 rollback_lock_file(&lock
);
827 commit_lock_file(&lock
);
830 strbuf_release(&buf
);
834 static int delete_pseudoref(const char *pseudoref
, const struct object_id
*old_oid
)
836 const char *filename
;
838 filename
= git_path("%s", pseudoref
);
840 if (old_oid
&& !is_null_oid(old_oid
)) {
841 struct lock_file lock
= LOCK_INIT
;
843 struct object_id actual_old_oid
;
845 fd
= hold_lock_file_for_update_timeout(
847 get_files_ref_lock_timeout_ms());
849 error_errno(_("could not open '%s' for writing"),
853 if (read_ref(pseudoref
, &actual_old_oid
))
854 die(_("could not read ref '%s'"), pseudoref
);
855 if (!oideq(&actual_old_oid
, old_oid
)) {
856 error(_("unexpected object ID when deleting '%s'"),
858 rollback_lock_file(&lock
);
863 rollback_lock_file(&lock
);
871 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
873 const struct object_id
*old_oid
,
876 struct ref_transaction
*transaction
;
877 struct strbuf err
= STRBUF_INIT
;
879 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
880 assert(refs
== get_main_ref_store(the_repository
));
881 return delete_pseudoref(refname
, old_oid
);
884 transaction
= ref_store_transaction_begin(refs
, &err
);
886 ref_transaction_delete(transaction
, refname
, old_oid
,
888 ref_transaction_commit(transaction
, &err
)) {
889 error("%s", err
.buf
);
890 ref_transaction_free(transaction
);
891 strbuf_release(&err
);
894 ref_transaction_free(transaction
);
895 strbuf_release(&err
);
899 int delete_ref(const char *msg
, const char *refname
,
900 const struct object_id
*old_oid
, unsigned int flags
)
902 return refs_delete_ref(get_main_ref_store(the_repository
), msg
, refname
,
906 void copy_reflog_msg(struct strbuf
*sb
, const char *msg
)
911 strbuf_addch(sb
, '\t');
912 while ((c
= *msg
++)) {
913 if (wasspace
&& isspace(c
))
915 wasspace
= isspace(c
);
923 int should_autocreate_reflog(const char *refname
)
925 switch (log_all_ref_updates
) {
926 case LOG_REFS_ALWAYS
:
928 case LOG_REFS_NORMAL
:
929 return starts_with(refname
, "refs/heads/") ||
930 starts_with(refname
, "refs/remotes/") ||
931 starts_with(refname
, "refs/notes/") ||
932 !strcmp(refname
, "HEAD");
938 int is_branch(const char *refname
)
940 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
943 struct read_ref_at_cb
{
948 struct object_id
*oid
;
951 struct object_id ooid
;
952 struct object_id noid
;
956 timestamp_t
*cutoff_time
;
961 static int read_ref_at_ent(struct object_id
*ooid
, struct object_id
*noid
,
962 const char *email
, timestamp_t timestamp
, int tz
,
963 const char *message
, void *cb_data
)
965 struct read_ref_at_cb
*cb
= cb_data
;
969 cb
->date
= timestamp
;
971 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
973 *cb
->msg
= xstrdup(message
);
975 *cb
->cutoff_time
= timestamp
;
979 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
981 * we have not yet updated cb->[n|o]oid so they still
982 * hold the values for the previous record.
984 if (!is_null_oid(&cb
->ooid
)) {
985 oidcpy(cb
->oid
, noid
);
986 if (!oideq(&cb
->ooid
, noid
))
987 warning(_("log for ref %s has gap after %s"),
988 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
990 else if (cb
->date
== cb
->at_time
)
991 oidcpy(cb
->oid
, noid
);
992 else if (!oideq(noid
, cb
->oid
))
993 warning(_("log for ref %s unexpectedly ended on %s"),
994 cb
->refname
, show_date(cb
->date
, cb
->tz
,
995 DATE_MODE(RFC2822
)));
996 oidcpy(&cb
->ooid
, ooid
);
997 oidcpy(&cb
->noid
, noid
);
1001 oidcpy(&cb
->ooid
, ooid
);
1002 oidcpy(&cb
->noid
, noid
);
1008 static int read_ref_at_ent_oldest(struct object_id
*ooid
, struct object_id
*noid
,
1009 const char *email
, timestamp_t timestamp
,
1010 int tz
, const char *message
, void *cb_data
)
1012 struct read_ref_at_cb
*cb
= cb_data
;
1015 *cb
->msg
= xstrdup(message
);
1016 if (cb
->cutoff_time
)
1017 *cb
->cutoff_time
= timestamp
;
1019 *cb
->cutoff_tz
= tz
;
1021 *cb
->cutoff_cnt
= cb
->reccnt
;
1022 oidcpy(cb
->oid
, ooid
);
1023 if (is_null_oid(cb
->oid
))
1024 oidcpy(cb
->oid
, noid
);
1025 /* We just want the first entry */
1029 int read_ref_at(struct ref_store
*refs
, const char *refname
,
1030 unsigned int flags
, timestamp_t at_time
, int cnt
,
1031 struct object_id
*oid
, char **msg
,
1032 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
1034 struct read_ref_at_cb cb
;
1036 memset(&cb
, 0, sizeof(cb
));
1037 cb
.refname
= refname
;
1038 cb
.at_time
= at_time
;
1041 cb
.cutoff_time
= cutoff_time
;
1042 cb
.cutoff_tz
= cutoff_tz
;
1043 cb
.cutoff_cnt
= cutoff_cnt
;
1046 refs_for_each_reflog_ent_reverse(refs
, refname
, read_ref_at_ent
, &cb
);
1049 if (flags
& GET_OID_QUIETLY
)
1052 die(_("log for %s is empty"), refname
);
1057 refs_for_each_reflog_ent(refs
, refname
, read_ref_at_ent_oldest
, &cb
);
1062 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
1065 struct ref_transaction
*tr
;
1068 tr
= xcalloc(1, sizeof(struct ref_transaction
));
1069 tr
->ref_store
= refs
;
1073 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
1075 return ref_store_transaction_begin(get_main_ref_store(the_repository
), err
);
1078 void ref_transaction_free(struct ref_transaction
*transaction
)
1085 switch (transaction
->state
) {
1086 case REF_TRANSACTION_OPEN
:
1087 case REF_TRANSACTION_CLOSED
:
1090 case REF_TRANSACTION_PREPARED
:
1091 BUG("free called on a prepared reference transaction");
1094 BUG("unexpected reference transaction state");
1098 for (i
= 0; i
< transaction
->nr
; i
++) {
1099 free(transaction
->updates
[i
]->msg
);
1100 free(transaction
->updates
[i
]);
1102 free(transaction
->updates
);
1106 struct ref_update
*ref_transaction_add_update(
1107 struct ref_transaction
*transaction
,
1108 const char *refname
, unsigned int flags
,
1109 const struct object_id
*new_oid
,
1110 const struct object_id
*old_oid
,
1113 struct ref_update
*update
;
1115 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
1116 BUG("update called for transaction that is not open");
1118 FLEX_ALLOC_STR(update
, refname
, refname
);
1119 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
1120 transaction
->updates
[transaction
->nr
++] = update
;
1122 update
->flags
= flags
;
1124 if (flags
& REF_HAVE_NEW
)
1125 oidcpy(&update
->new_oid
, new_oid
);
1126 if (flags
& REF_HAVE_OLD
)
1127 oidcpy(&update
->old_oid
, old_oid
);
1128 update
->msg
= xstrdup_or_null(msg
);
1132 int ref_transaction_update(struct ref_transaction
*transaction
,
1133 const char *refname
,
1134 const struct object_id
*new_oid
,
1135 const struct object_id
*old_oid
,
1136 unsigned int flags
, const char *msg
,
1141 if ((new_oid
&& !is_null_oid(new_oid
)) ?
1142 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
) :
1143 !refname_is_safe(refname
)) {
1144 strbuf_addf(err
, _("refusing to update ref with bad name '%s'"),
1149 if (flags
& ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS
)
1150 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags
);
1152 flags
|= (new_oid
? REF_HAVE_NEW
: 0) | (old_oid
? REF_HAVE_OLD
: 0);
1154 ref_transaction_add_update(transaction
, refname
, flags
,
1155 new_oid
, old_oid
, msg
);
1159 int ref_transaction_create(struct ref_transaction
*transaction
,
1160 const char *refname
,
1161 const struct object_id
*new_oid
,
1162 unsigned int flags
, const char *msg
,
1165 if (!new_oid
|| is_null_oid(new_oid
))
1166 BUG("create called without valid new_oid");
1167 return ref_transaction_update(transaction
, refname
, new_oid
,
1168 &null_oid
, flags
, msg
, err
);
1171 int ref_transaction_delete(struct ref_transaction
*transaction
,
1172 const char *refname
,
1173 const struct object_id
*old_oid
,
1174 unsigned int flags
, const char *msg
,
1177 if (old_oid
&& is_null_oid(old_oid
))
1178 BUG("delete called with old_oid set to zeros");
1179 return ref_transaction_update(transaction
, refname
,
1184 int ref_transaction_verify(struct ref_transaction
*transaction
,
1185 const char *refname
,
1186 const struct object_id
*old_oid
,
1191 BUG("verify called with old_oid set to NULL");
1192 return ref_transaction_update(transaction
, refname
,
1197 int refs_update_ref(struct ref_store
*refs
, const char *msg
,
1198 const char *refname
, const struct object_id
*new_oid
,
1199 const struct object_id
*old_oid
, unsigned int flags
,
1200 enum action_on_err onerr
)
1202 struct ref_transaction
*t
= NULL
;
1203 struct strbuf err
= STRBUF_INIT
;
1206 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
1207 assert(refs
== get_main_ref_store(the_repository
));
1208 ret
= write_pseudoref(refname
, new_oid
, old_oid
, &err
);
1210 t
= ref_store_transaction_begin(refs
, &err
);
1212 ref_transaction_update(t
, refname
, new_oid
, old_oid
,
1213 flags
, msg
, &err
) ||
1214 ref_transaction_commit(t
, &err
)) {
1216 ref_transaction_free(t
);
1220 const char *str
= _("update_ref failed for ref '%s': %s");
1223 case UPDATE_REFS_MSG_ON_ERR
:
1224 error(str
, refname
, err
.buf
);
1226 case UPDATE_REFS_DIE_ON_ERR
:
1227 die(str
, refname
, err
.buf
);
1229 case UPDATE_REFS_QUIET_ON_ERR
:
1232 strbuf_release(&err
);
1235 strbuf_release(&err
);
1237 ref_transaction_free(t
);
1241 int update_ref(const char *msg
, const char *refname
,
1242 const struct object_id
*new_oid
,
1243 const struct object_id
*old_oid
,
1244 unsigned int flags
, enum action_on_err onerr
)
1246 return refs_update_ref(get_main_ref_store(the_repository
), msg
, refname
, new_oid
,
1247 old_oid
, flags
, onerr
);
1250 char *refs_shorten_unambiguous_ref(struct ref_store
*refs
,
1251 const char *refname
, int strict
)
1254 static char **scanf_fmts
;
1255 static int nr_rules
;
1257 struct strbuf resolved_buf
= STRBUF_INIT
;
1261 * Pre-generate scanf formats from ref_rev_parse_rules[].
1262 * Generate a format suitable for scanf from a
1263 * ref_rev_parse_rules rule by interpolating "%s" at the
1264 * location of the "%.*s".
1266 size_t total_len
= 0;
1269 /* the rule list is NULL terminated, count them first */
1270 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
1271 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1272 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
1274 scanf_fmts
= xmalloc(st_add(st_mult(sizeof(char *), nr_rules
), total_len
));
1277 for (i
= 0; i
< nr_rules
; i
++) {
1278 assert(offset
< total_len
);
1279 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
1280 offset
+= xsnprintf(scanf_fmts
[i
], total_len
- offset
,
1281 ref_rev_parse_rules
[i
], 2, "%s") + 1;
1285 /* bail out if there are no rules */
1287 return xstrdup(refname
);
1289 /* buffer for scanf result, at most refname must fit */
1290 short_name
= xstrdup(refname
);
1292 /* skip first rule, it will always match */
1293 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
1295 int rules_to_fail
= i
;
1298 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
1301 short_name_len
= strlen(short_name
);
1304 * in strict mode, all (except the matched one) rules
1305 * must fail to resolve to a valid non-ambiguous ref
1308 rules_to_fail
= nr_rules
;
1311 * check if the short name resolves to a valid ref,
1312 * but use only rules prior to the matched one
1314 for (j
= 0; j
< rules_to_fail
; j
++) {
1315 const char *rule
= ref_rev_parse_rules
[j
];
1317 /* skip matched rule */
1322 * the short name is ambiguous, if it resolves
1323 * (with this previous rule) to a valid ref
1324 * read_ref() returns 0 on success
1326 strbuf_reset(&resolved_buf
);
1327 strbuf_addf(&resolved_buf
, rule
,
1328 short_name_len
, short_name
);
1329 if (refs_ref_exists(refs
, resolved_buf
.buf
))
1334 * short name is non-ambiguous if all previous rules
1335 * haven't resolved to a valid ref
1337 if (j
== rules_to_fail
) {
1338 strbuf_release(&resolved_buf
);
1343 strbuf_release(&resolved_buf
);
1345 return xstrdup(refname
);
1348 char *shorten_unambiguous_ref(const char *refname
, int strict
)
1350 return refs_shorten_unambiguous_ref(get_main_ref_store(the_repository
),
1354 static struct string_list
*hide_refs
;
1356 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
1359 if (!strcmp("transfer.hiderefs", var
) ||
1360 (!parse_config_key(var
, section
, NULL
, NULL
, &key
) &&
1361 !strcmp(key
, "hiderefs"))) {
1366 return config_error_nonbool(var
);
1367 ref
= xstrdup(value
);
1369 while (len
&& ref
[len
- 1] == '/')
1372 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
1373 hide_refs
->strdup_strings
= 1;
1375 string_list_append(hide_refs
, ref
);
1380 int ref_is_hidden(const char *refname
, const char *refname_full
)
1386 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
1387 const char *match
= hide_refs
->items
[i
].string
;
1388 const char *subject
;
1392 if (*match
== '!') {
1397 if (*match
== '^') {
1398 subject
= refname_full
;
1404 /* refname can be NULL when namespaces are used. */
1406 skip_prefix(subject
, match
, &p
) &&
1413 const char *find_descendant_ref(const char *dirname
,
1414 const struct string_list
*extras
,
1415 const struct string_list
*skip
)
1423 * Look at the place where dirname would be inserted into
1424 * extras. If there is an entry at that position that starts
1425 * with dirname (remember, dirname includes the trailing
1426 * slash) and is not in skip, then we have a conflict.
1428 for (pos
= string_list_find_insert_index(extras
, dirname
, 0);
1429 pos
< extras
->nr
; pos
++) {
1430 const char *extra_refname
= extras
->items
[pos
].string
;
1432 if (!starts_with(extra_refname
, dirname
))
1435 if (!skip
|| !string_list_has_string(skip
, extra_refname
))
1436 return extra_refname
;
1441 int refs_rename_ref_available(struct ref_store
*refs
,
1442 const char *old_refname
,
1443 const char *new_refname
)
1445 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1446 struct strbuf err
= STRBUF_INIT
;
1449 string_list_insert(&skip
, old_refname
);
1450 ok
= !refs_verify_refname_available(refs
, new_refname
,
1453 error("%s", err
.buf
);
1455 string_list_clear(&skip
, 0);
1456 strbuf_release(&err
);
1460 int refs_head_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1462 struct object_id oid
;
1465 if (!refs_read_ref_full(refs
, "HEAD", RESOLVE_REF_READING
,
1467 return fn("HEAD", &oid
, flag
, cb_data
);
1472 int head_ref(each_ref_fn fn
, void *cb_data
)
1474 return refs_head_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1477 struct ref_iterator
*refs_ref_iterator_begin(
1478 struct ref_store
*refs
,
1479 const char *prefix
, int trim
, int flags
)
1481 struct ref_iterator
*iter
;
1483 if (ref_paranoia
< 0)
1484 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1486 flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1488 iter
= refs
->be
->iterator_begin(refs
, prefix
, flags
);
1491 * `iterator_begin()` already takes care of prefix, but we
1492 * might need to do some trimming:
1495 iter
= prefix_ref_iterator_begin(iter
, "", trim
);
1497 /* Sanity check for subclasses: */
1499 BUG("reference iterator is not ordered");
1505 * Call fn for each reference in the specified submodule for which the
1506 * refname begins with prefix. If trim is non-zero, then trim that
1507 * many characters off the beginning of each refname before passing
1508 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1509 * include broken references in the iteration. If fn ever returns a
1510 * non-zero value, stop the iteration and return that value;
1511 * otherwise, return 0.
1513 static int do_for_each_repo_ref(struct repository
*r
, const char *prefix
,
1514 each_repo_ref_fn fn
, int trim
, int flags
,
1517 struct ref_iterator
*iter
;
1518 struct ref_store
*refs
= get_main_ref_store(r
);
1523 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1525 return do_for_each_repo_ref_iterator(r
, iter
, fn
, cb_data
);
1528 struct do_for_each_ref_help
{
1533 static int do_for_each_ref_helper(struct repository
*r
,
1534 const char *refname
,
1535 const struct object_id
*oid
,
1539 struct do_for_each_ref_help
*hp
= cb_data
;
1541 return hp
->fn(refname
, oid
, flags
, hp
->cb_data
);
1544 static int do_for_each_ref(struct ref_store
*refs
, const char *prefix
,
1545 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1547 struct ref_iterator
*iter
;
1548 struct do_for_each_ref_help hp
= { fn
, cb_data
};
1553 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1555 return do_for_each_repo_ref_iterator(the_repository
, iter
,
1556 do_for_each_ref_helper
, &hp
);
1559 int refs_for_each_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1561 return do_for_each_ref(refs
, "", fn
, 0, 0, cb_data
);
1564 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1566 return refs_for_each_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1569 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
1570 each_ref_fn fn
, void *cb_data
)
1572 return do_for_each_ref(refs
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1575 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1577 return refs_for_each_ref_in(get_main_ref_store(the_repository
), prefix
, fn
, cb_data
);
1580 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
1582 unsigned int flag
= 0;
1585 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1586 return do_for_each_ref(get_main_ref_store(the_repository
),
1587 prefix
, fn
, 0, flag
, cb_data
);
1590 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
1591 each_ref_fn fn
, void *cb_data
,
1592 unsigned int broken
)
1594 unsigned int flag
= 0;
1597 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1598 return do_for_each_ref(refs
, prefix
, fn
, 0, flag
, cb_data
);
1601 int for_each_replace_ref(struct repository
*r
, each_repo_ref_fn fn
, void *cb_data
)
1603 return do_for_each_repo_ref(r
, git_replace_ref_base
, fn
,
1604 strlen(git_replace_ref_base
),
1605 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1608 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1610 struct strbuf buf
= STRBUF_INIT
;
1612 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1613 ret
= do_for_each_ref(get_main_ref_store(the_repository
),
1614 buf
.buf
, fn
, 0, 0, cb_data
);
1615 strbuf_release(&buf
);
1619 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1621 return do_for_each_ref(refs
, "", fn
, 0,
1622 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1625 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1627 return refs_for_each_rawref(get_main_ref_store(the_repository
), fn
, cb_data
);
1630 int refs_read_raw_ref(struct ref_store
*ref_store
,
1631 const char *refname
, struct object_id
*oid
,
1632 struct strbuf
*referent
, unsigned int *type
)
1634 return ref_store
->be
->read_raw_ref(ref_store
, refname
, oid
, referent
, type
);
1637 /* This function needs to return a meaningful errno on failure */
1638 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
1639 const char *refname
,
1641 struct object_id
*oid
, int *flags
)
1643 static struct strbuf sb_refname
= STRBUF_INIT
;
1644 struct object_id unused_oid
;
1651 flags
= &unused_flags
;
1655 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1656 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1657 !refname_is_safe(refname
)) {
1663 * dwim_ref() uses REF_ISBROKEN to distinguish between
1664 * missing refs and refs that were present but invalid,
1665 * to complain about the latter to stderr.
1667 * We don't know whether the ref exists, so don't set
1670 *flags
|= REF_BAD_NAME
;
1673 for (symref_count
= 0; symref_count
< SYMREF_MAXDEPTH
; symref_count
++) {
1674 unsigned int read_flags
= 0;
1676 if (refs_read_raw_ref(refs
, refname
,
1677 oid
, &sb_refname
, &read_flags
)) {
1678 *flags
|= read_flags
;
1680 /* In reading mode, refs must eventually resolve */
1681 if (resolve_flags
& RESOLVE_REF_READING
)
1685 * Otherwise a missing ref is OK. But the files backend
1686 * may show errors besides ENOENT if there are
1687 * similarly-named refs.
1689 if (errno
!= ENOENT
&&
1695 if (*flags
& REF_BAD_NAME
)
1696 *flags
|= REF_ISBROKEN
;
1700 *flags
|= read_flags
;
1702 if (!(read_flags
& REF_ISSYMREF
)) {
1703 if (*flags
& REF_BAD_NAME
) {
1705 *flags
|= REF_ISBROKEN
;
1710 refname
= sb_refname
.buf
;
1711 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1715 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1716 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1717 !refname_is_safe(refname
)) {
1722 *flags
|= REF_ISBROKEN
| REF_BAD_NAME
;
1730 /* backend functions */
1731 int refs_init_db(struct strbuf
*err
)
1733 struct ref_store
*refs
= get_main_ref_store(the_repository
);
1735 return refs
->be
->init_db(refs
, err
);
1738 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1739 struct object_id
*oid
, int *flags
)
1741 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository
), refname
,
1742 resolve_flags
, oid
, flags
);
1745 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
1746 struct object_id
*oid
)
1748 struct ref_store
*refs
;
1751 refs
= get_submodule_ref_store(submodule
);
1756 if (!refs_resolve_ref_unsafe(refs
, refname
, 0, oid
, &flags
) ||
1762 struct ref_store_hash_entry
1764 struct hashmap_entry ent
;
1766 struct ref_store
*refs
;
1768 /* NUL-terminated identifier of the ref store: */
1769 char name
[FLEX_ARRAY
];
1772 static int ref_store_hash_cmp(const void *unused_cmp_data
,
1773 const struct hashmap_entry
*eptr
,
1774 const struct hashmap_entry
*entry_or_key
,
1775 const void *keydata
)
1777 const struct ref_store_hash_entry
*e1
, *e2
;
1780 e1
= container_of(eptr
, const struct ref_store_hash_entry
, ent
);
1781 e2
= container_of(entry_or_key
, const struct ref_store_hash_entry
, ent
);
1782 name
= keydata
? keydata
: e2
->name
;
1784 return strcmp(e1
->name
, name
);
1787 static struct ref_store_hash_entry
*alloc_ref_store_hash_entry(
1788 const char *name
, struct ref_store
*refs
)
1790 struct ref_store_hash_entry
*entry
;
1792 FLEX_ALLOC_STR(entry
, name
, name
);
1793 hashmap_entry_init(&entry
->ent
, strhash(name
));
1798 /* A hashmap of ref_stores, stored by submodule name: */
1799 static struct hashmap submodule_ref_stores
;
1801 /* A hashmap of ref_stores, stored by worktree id: */
1802 static struct hashmap worktree_ref_stores
;
1805 * Look up a ref store by name. If that ref_store hasn't been
1806 * registered yet, return NULL.
1808 static struct ref_store
*lookup_ref_store_map(struct hashmap
*map
,
1811 struct ref_store_hash_entry
*entry
;
1814 if (!map
->tablesize
)
1815 /* It's initialized on demand in register_ref_store(). */
1818 hash
= strhash(name
);
1819 entry
= hashmap_get_entry_from_hash(map
, hash
, name
,
1820 struct ref_store_hash_entry
, ent
);
1821 return entry
? entry
->refs
: NULL
;
1825 * Create, record, and return a ref_store instance for the specified
1828 static struct ref_store
*ref_store_init(const char *gitdir
,
1831 const char *be_name
= "files";
1832 struct ref_storage_be
*be
= find_ref_storage_backend(be_name
);
1833 struct ref_store
*refs
;
1836 BUG("reference backend %s is unknown", be_name
);
1838 refs
= be
->init(gitdir
, flags
);
1842 struct ref_store
*get_main_ref_store(struct repository
*r
)
1844 if (r
->refs_private
)
1845 return r
->refs_private
;
1848 BUG("attempting to get main_ref_store outside of repository");
1850 r
->refs_private
= ref_store_init(r
->gitdir
, REF_STORE_ALL_CAPS
);
1851 return r
->refs_private
;
1855 * Associate a ref store with a name. It is a fatal error to call this
1856 * function twice for the same name.
1858 static void register_ref_store_map(struct hashmap
*map
,
1860 struct ref_store
*refs
,
1863 struct ref_store_hash_entry
*entry
;
1865 if (!map
->tablesize
)
1866 hashmap_init(map
, ref_store_hash_cmp
, NULL
, 0);
1868 entry
= alloc_ref_store_hash_entry(name
, refs
);
1869 if (hashmap_put(map
, &entry
->ent
))
1870 BUG("%s ref_store '%s' initialized twice", type
, name
);
1873 struct ref_store
*get_submodule_ref_store(const char *submodule
)
1875 struct strbuf submodule_sb
= STRBUF_INIT
;
1876 struct ref_store
*refs
;
1877 char *to_free
= NULL
;
1883 len
= strlen(submodule
);
1884 while (len
&& is_dir_sep(submodule
[len
- 1]))
1890 /* We need to strip off one or more trailing slashes */
1891 submodule
= to_free
= xmemdupz(submodule
, len
);
1893 refs
= lookup_ref_store_map(&submodule_ref_stores
, submodule
);
1897 strbuf_addstr(&submodule_sb
, submodule
);
1898 if (!is_nonbare_repository_dir(&submodule_sb
))
1901 if (submodule_to_gitdir(&submodule_sb
, submodule
))
1904 /* assume that add_submodule_odb() has been called */
1905 refs
= ref_store_init(submodule_sb
.buf
,
1906 REF_STORE_READ
| REF_STORE_ODB
);
1907 register_ref_store_map(&submodule_ref_stores
, "submodule",
1911 strbuf_release(&submodule_sb
);
1917 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
)
1919 struct ref_store
*refs
;
1923 return get_main_ref_store(the_repository
);
1925 id
= wt
->id
? wt
->id
: "/";
1926 refs
= lookup_ref_store_map(&worktree_ref_stores
, id
);
1931 refs
= ref_store_init(git_common_path("worktrees/%s", wt
->id
),
1932 REF_STORE_ALL_CAPS
);
1934 refs
= ref_store_init(get_git_common_dir(),
1935 REF_STORE_ALL_CAPS
);
1938 register_ref_store_map(&worktree_ref_stores
, "worktree",
1943 void base_ref_store_init(struct ref_store
*refs
,
1944 const struct ref_storage_be
*be
)
1949 /* backend functions */
1950 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
)
1952 return refs
->be
->pack_refs(refs
, flags
);
1955 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
1956 struct object_id
*oid
)
1959 struct object_id base
;
1961 if (current_ref_iter
&& current_ref_iter
->refname
== refname
) {
1962 struct object_id peeled
;
1964 if (ref_iterator_peel(current_ref_iter
, &peeled
))
1966 oidcpy(oid
, &peeled
);
1970 if (refs_read_ref_full(refs
, refname
,
1971 RESOLVE_REF_READING
, &base
, &flag
))
1974 return peel_object(&base
, oid
);
1977 int peel_ref(const char *refname
, struct object_id
*oid
)
1979 return refs_peel_ref(get_main_ref_store(the_repository
), refname
, oid
);
1982 int refs_create_symref(struct ref_store
*refs
,
1983 const char *ref_target
,
1984 const char *refs_heads_master
,
1987 return refs
->be
->create_symref(refs
, ref_target
,
1992 int create_symref(const char *ref_target
, const char *refs_heads_master
,
1995 return refs_create_symref(get_main_ref_store(the_repository
), ref_target
,
1996 refs_heads_master
, logmsg
);
1999 int ref_update_reject_duplicates(struct string_list
*refnames
,
2002 size_t i
, n
= refnames
->nr
;
2006 for (i
= 1; i
< n
; i
++) {
2007 int cmp
= strcmp(refnames
->items
[i
- 1].string
,
2008 refnames
->items
[i
].string
);
2012 _("multiple updates for ref '%s' not allowed"),
2013 refnames
->items
[i
].string
);
2015 } else if (cmp
> 0) {
2016 BUG("ref_update_reject_duplicates() received unsorted list");
2022 static const char hook_not_found
;
2023 static const char *hook
;
2025 static int run_transaction_hook(struct ref_transaction
*transaction
,
2028 struct child_process proc
= CHILD_PROCESS_INIT
;
2029 struct strbuf buf
= STRBUF_INIT
;
2032 if (hook
== &hook_not_found
)
2035 hook
= find_hook("reference-transaction");
2037 hook
= &hook_not_found
;
2041 argv_array_pushl(&proc
.args
, hook
, state
, NULL
);
2043 proc
.stdout_to_stderr
= 1;
2044 proc
.trace2_hook_name
= "reference-transaction";
2046 ret
= start_command(&proc
);
2050 sigchain_push(SIGPIPE
, SIG_IGN
);
2052 for (i
= 0; i
< transaction
->nr
; i
++) {
2053 struct ref_update
*update
= transaction
->updates
[i
];
2056 strbuf_addf(&buf
, "%s %s %s\n",
2057 oid_to_hex(&update
->old_oid
),
2058 oid_to_hex(&update
->new_oid
),
2061 if (write_in_full(proc
.in
, buf
.buf
, buf
.len
) < 0) {
2069 sigchain_pop(SIGPIPE
);
2070 strbuf_release(&buf
);
2072 ret
|= finish_command(&proc
);
2076 int ref_transaction_prepare(struct ref_transaction
*transaction
,
2079 struct ref_store
*refs
= transaction
->ref_store
;
2082 switch (transaction
->state
) {
2083 case REF_TRANSACTION_OPEN
:
2086 case REF_TRANSACTION_PREPARED
:
2087 BUG("prepare called twice on reference transaction");
2089 case REF_TRANSACTION_CLOSED
:
2090 BUG("prepare called on a closed reference transaction");
2093 BUG("unexpected reference transaction state");
2097 if (getenv(GIT_QUARANTINE_ENVIRONMENT
)) {
2099 _("ref updates forbidden inside quarantine environment"));
2103 ret
= refs
->be
->transaction_prepare(refs
, transaction
, err
);
2107 ret
= run_transaction_hook(transaction
, "prepared");
2109 ref_transaction_abort(transaction
, err
);
2110 die(_("ref updates aborted by hook"));
2116 int ref_transaction_abort(struct ref_transaction
*transaction
,
2119 struct ref_store
*refs
= transaction
->ref_store
;
2122 switch (transaction
->state
) {
2123 case REF_TRANSACTION_OPEN
:
2124 /* No need to abort explicitly. */
2126 case REF_TRANSACTION_PREPARED
:
2127 ret
= refs
->be
->transaction_abort(refs
, transaction
, err
);
2129 case REF_TRANSACTION_CLOSED
:
2130 BUG("abort called on a closed reference transaction");
2133 BUG("unexpected reference transaction state");
2137 run_transaction_hook(transaction
, "aborted");
2139 ref_transaction_free(transaction
);
2143 int ref_transaction_commit(struct ref_transaction
*transaction
,
2146 struct ref_store
*refs
= transaction
->ref_store
;
2149 switch (transaction
->state
) {
2150 case REF_TRANSACTION_OPEN
:
2151 /* Need to prepare first. */
2152 ret
= ref_transaction_prepare(transaction
, err
);
2156 case REF_TRANSACTION_PREPARED
:
2157 /* Fall through to finish. */
2159 case REF_TRANSACTION_CLOSED
:
2160 BUG("commit called on a closed reference transaction");
2163 BUG("unexpected reference transaction state");
2167 ret
= refs
->be
->transaction_finish(refs
, transaction
, err
);
2169 run_transaction_hook(transaction
, "committed");
2173 int refs_verify_refname_available(struct ref_store
*refs
,
2174 const char *refname
,
2175 const struct string_list
*extras
,
2176 const struct string_list
*skip
,
2180 const char *extra_refname
;
2181 struct strbuf dirname
= STRBUF_INIT
;
2182 struct strbuf referent
= STRBUF_INIT
;
2183 struct object_id oid
;
2185 struct ref_iterator
*iter
;
2190 * For the sake of comments in this function, suppose that
2191 * refname is "refs/foo/bar".
2196 strbuf_grow(&dirname
, strlen(refname
) + 1);
2197 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
2198 /* Expand dirname to the new prefix, not including the trailing slash: */
2199 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
2202 * We are still at a leading dir of the refname (e.g.,
2203 * "refs/foo"; if there is a reference with that name,
2204 * it is a conflict, *unless* it is in skip.
2206 if (skip
&& string_list_has_string(skip
, dirname
.buf
))
2209 if (!refs_read_raw_ref(refs
, dirname
.buf
, &oid
, &referent
, &type
)) {
2210 strbuf_addf(err
, _("'%s' exists; cannot create '%s'"),
2211 dirname
.buf
, refname
);
2215 if (extras
&& string_list_has_string(extras
, dirname
.buf
)) {
2216 strbuf_addf(err
, _("cannot process '%s' and '%s' at the same time"),
2217 refname
, dirname
.buf
);
2223 * We are at the leaf of our refname (e.g., "refs/foo/bar").
2224 * There is no point in searching for a reference with that
2225 * name, because a refname isn't considered to conflict with
2226 * itself. But we still need to check for references whose
2227 * names are in the "refs/foo/bar/" namespace, because they
2230 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
2231 strbuf_addch(&dirname
, '/');
2233 iter
= refs_ref_iterator_begin(refs
, dirname
.buf
, 0,
2234 DO_FOR_EACH_INCLUDE_BROKEN
);
2235 while ((ok
= ref_iterator_advance(iter
)) == ITER_OK
) {
2237 string_list_has_string(skip
, iter
->refname
))
2240 strbuf_addf(err
, _("'%s' exists; cannot create '%s'"),
2241 iter
->refname
, refname
);
2242 ref_iterator_abort(iter
);
2246 if (ok
!= ITER_DONE
)
2247 BUG("error while iterating over references");
2249 extra_refname
= find_descendant_ref(dirname
.buf
, extras
, skip
);
2251 strbuf_addf(err
, _("cannot process '%s' and '%s' at the same time"),
2252 refname
, extra_refname
);
2257 strbuf_release(&referent
);
2258 strbuf_release(&dirname
);
2262 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
2264 struct ref_iterator
*iter
;
2265 struct do_for_each_ref_help hp
= { fn
, cb_data
};
2267 iter
= refs
->be
->reflog_iterator_begin(refs
);
2269 return do_for_each_repo_ref_iterator(the_repository
, iter
,
2270 do_for_each_ref_helper
, &hp
);
2273 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
2275 return refs_for_each_reflog(get_main_ref_store(the_repository
), fn
, cb_data
);
2278 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
2279 const char *refname
,
2280 each_reflog_ent_fn fn
,
2283 return refs
->be
->for_each_reflog_ent_reverse(refs
, refname
,
2287 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
2290 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository
),
2291 refname
, fn
, cb_data
);
2294 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
2295 each_reflog_ent_fn fn
, void *cb_data
)
2297 return refs
->be
->for_each_reflog_ent(refs
, refname
, fn
, cb_data
);
2300 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
2303 return refs_for_each_reflog_ent(get_main_ref_store(the_repository
), refname
,
2307 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
)
2309 return refs
->be
->reflog_exists(refs
, refname
);
2312 int reflog_exists(const char *refname
)
2314 return refs_reflog_exists(get_main_ref_store(the_repository
), refname
);
2317 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
2318 int force_create
, struct strbuf
*err
)
2320 return refs
->be
->create_reflog(refs
, refname
, force_create
, err
);
2323 int safe_create_reflog(const char *refname
, int force_create
,
2326 return refs_create_reflog(get_main_ref_store(the_repository
), refname
,
2330 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
)
2332 return refs
->be
->delete_reflog(refs
, refname
);
2335 int delete_reflog(const char *refname
)
2337 return refs_delete_reflog(get_main_ref_store(the_repository
), refname
);
2340 int refs_reflog_expire(struct ref_store
*refs
,
2341 const char *refname
, const struct object_id
*oid
,
2343 reflog_expiry_prepare_fn prepare_fn
,
2344 reflog_expiry_should_prune_fn should_prune_fn
,
2345 reflog_expiry_cleanup_fn cleanup_fn
,
2346 void *policy_cb_data
)
2348 return refs
->be
->reflog_expire(refs
, refname
, oid
, flags
,
2349 prepare_fn
, should_prune_fn
,
2350 cleanup_fn
, policy_cb_data
);
2353 int reflog_expire(const char *refname
, const struct object_id
*oid
,
2355 reflog_expiry_prepare_fn prepare_fn
,
2356 reflog_expiry_should_prune_fn should_prune_fn
,
2357 reflog_expiry_cleanup_fn cleanup_fn
,
2358 void *policy_cb_data
)
2360 return refs_reflog_expire(get_main_ref_store(the_repository
),
2361 refname
, oid
, flags
,
2362 prepare_fn
, should_prune_fn
,
2363 cleanup_fn
, policy_cb_data
);
2366 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
2369 struct ref_store
*refs
= transaction
->ref_store
;
2371 return refs
->be
->initial_transaction_commit(refs
, transaction
, err
);
2374 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
2375 struct string_list
*refnames
, unsigned int flags
)
2377 return refs
->be
->delete_refs(refs
, msg
, refnames
, flags
);
2380 int delete_refs(const char *msg
, struct string_list
*refnames
,
2383 return refs_delete_refs(get_main_ref_store(the_repository
), msg
, refnames
, flags
);
2386 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
2387 const char *newref
, const char *logmsg
)
2389 return refs
->be
->rename_ref(refs
, oldref
, newref
, logmsg
);
2392 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2394 return refs_rename_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);
2397 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
2398 const char *newref
, const char *logmsg
)
2400 return refs
->be
->copy_ref(refs
, oldref
, newref
, logmsg
);
2403 int copy_existing_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2405 return refs_copy_existing_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);