2 * The backend-independent part of the reference module.
11 #include "refs/refs-internal.h"
12 #include "object-store.h"
15 #include "submodule.h"
17 #include "argv-array.h"
18 #include "repository.h"
21 * List of all available backends
23 static struct ref_storage_be *refs_backends = &refs_be_files;
25 static struct ref_storage_be *find_ref_storage_backend(const char *name)
27 struct ref_storage_be *be;
28 for (be = refs_backends; be; be = be->next)
29 if (!strcmp(be->name, name))
34 int ref_storage_backend_exists(const char *name)
36 return find_ref_storage_backend(name) != NULL;
40 * How to handle various characters in refnames:
41 * 0: An acceptable character for refs
43 * 2: ., look for a preceding . to reject .. in refs
44 * 3: {, look for a preceding @ to reject @{ in refs
45 * 4: A bad character: ASCII control characters, and
46 * ":", "?", "[", "\", "^", "~", SP, or TAB
47 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
49 static unsigned char refname_disposition[256] = {
50 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
51 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
52 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
55 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
56 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
57 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
61 * Try to read one refname component from the front of refname.
62 * Return the length of the component found, or -1 if the component is
63 * not legal. It is legal if it is something reasonable to have under
64 * ".git/refs/"; We do not like it if:
66 * - it begins with ".", or
67 * - it has double dots "..", or
68 * - it has ASCII control characters, or
69 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
70 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
71 * - it ends with a "/", or
72 * - it ends with ".lock", or
73 * - it contains a "@{" portion
75 * When sanitized is not NULL, instead of rejecting the input refname
76 * as an error, try to come up with a usable replacement for the input
79 static int check_refname_component(const char *refname, int *flags,
80 struct strbuf *sanitized)
84 size_t component_start = 0; /* garbage - not a reasonable initial value */
87 component_start = sanitized->len;
89 for (cp = refname; ; cp++) {
91 unsigned char disp = refname_disposition[ch];
93 if (sanitized && disp != 1)
94 strbuf_addch(sanitized, ch);
100 if (last == '.') { /* Refname contains "..". */
102 /* collapse ".." to single "." */
103 strbuf_setlen(sanitized, sanitized->len - 1);
109 if (last == '@') { /* Refname contains "@{". */
111 sanitized->buf[sanitized->len-1] = '-';
119 sanitized->buf[sanitized->len-1] = '-';
124 if (!(*flags & REFNAME_REFSPEC_PATTERN)) {
125 /* refspec can't be a pattern */
127 sanitized->buf[sanitized->len-1] = '-';
133 * Unset the pattern flag so that we only accept
134 * a single asterisk for one side of refspec.
136 *flags &= ~ REFNAME_REFSPEC_PATTERN;
143 return 0; /* Component has zero length. */
145 if (refname[0] == '.') { /* Component starts with '.'. */
147 sanitized->buf[component_start] = '-';
151 if (cp - refname >= LOCK_SUFFIX_LEN &&
152 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) {
155 /* Refname ends with ".lock". */
156 while (strbuf_strip_suffix(sanitized, LOCK_SUFFIX)) {
157 /* try again in case we have .lock.lock */
163 static int check_or_sanitize_refname(const char *refname, int flags,
164 struct strbuf *sanitized)
166 int component_len, component_count = 0;
168 if (!strcmp(refname, "@")) {
169 /* Refname is a single character '@'. */
171 strbuf_addch(sanitized, '-');
177 if (sanitized && sanitized->len)
178 strbuf_complete(sanitized, '/');
180 /* We are at the start of a path component. */
181 component_len = check_refname_component(refname, &flags,
183 if (sanitized && component_len == 0)
184 ; /* OK, omit empty component */
185 else if (component_len <= 0)
189 if (refname[component_len] == '\0')
191 /* Skip to next component. */
192 refname += component_len + 1;
195 if (refname[component_len - 1] == '.') {
196 /* Refname ends with '.'. */
198 ; /* omit ending dot */
202 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
203 return -1; /* Refname has only one component. */
207 int check_refname_format(const char *refname, int flags)
209 return check_or_sanitize_refname(refname, flags, NULL);
212 void sanitize_refname_component(const char *refname, struct strbuf *out)
214 if (check_or_sanitize_refname(refname, REFNAME_ALLOW_ONELEVEL, out))
215 BUG("sanitizing refname '%s' check returned error", refname);
218 int refname_is_safe(const char *refname)
222 if (skip_prefix(refname, "refs/", &rest)) {
225 size_t restlen = strlen(rest);
227 /* rest must not be empty, or start or end with "/" */
228 if (!restlen || *rest == '/' || rest[restlen - 1] == '/')
232 * Does the refname try to escape refs/?
233 * For example: refs/foo/../bar is safe but refs/foo/../../bar
236 buf = xmallocz(restlen);
237 result = !normalize_path_copy(buf, rest) && !strcmp(buf, rest);
243 if (!isupper(*refname) && *refname != '_')
251 * Return true if refname, which has the specified oid and flags, can
252 * be resolved to an object in the database. If the referred-to object
253 * does not exist, emit a warning and return false.
255 int ref_resolves_to_object(const char *refname,
256 const struct object_id *oid,
259 if (flags & REF_ISBROKEN)
261 if (!has_object_file(oid)) {
262 error(_("%s does not point to a valid object!"), refname);
268 char *refs_resolve_refdup(struct ref_store *refs,
269 const char *refname, int resolve_flags,
270 struct object_id *oid, int *flags)
274 result = refs_resolve_ref_unsafe(refs, refname, resolve_flags,
276 return xstrdup_or_null(result);
279 char *resolve_refdup(const char *refname, int resolve_flags,
280 struct object_id *oid, int *flags)
282 return refs_resolve_refdup(get_main_ref_store(the_repository),
283 refname, resolve_flags,
287 /* The argument to filter_refs */
295 int refs_read_ref_full(struct ref_store *refs, const char *refname,
296 int resolve_flags, struct object_id *oid, int *flags)
298 if (refs_resolve_ref_unsafe(refs, refname, resolve_flags, oid, flags))
303 int read_ref_full(const char *refname, int resolve_flags, struct object_id *oid, int *flags)
305 return refs_read_ref_full(get_main_ref_store(the_repository), refname,
306 resolve_flags, oid, flags);
309 int read_ref(const char *refname, struct object_id *oid)
311 return read_ref_full(refname, RESOLVE_REF_READING, oid, NULL);
314 int ref_exists(const char *refname)
316 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, NULL, NULL);
319 static int match_ref_pattern(const char *refname,
320 const struct string_list_item *item)
323 if (item->util == NULL) {
324 if (!wildmatch(item->string, refname, 0))
328 if (skip_prefix(refname, item->string, &rest) &&
329 (!*rest || *rest == '/'))
335 int ref_filter_match(const char *refname,
336 const struct string_list *include_patterns,
337 const struct string_list *exclude_patterns)
339 struct string_list_item *item;
341 if (exclude_patterns && exclude_patterns->nr) {
342 for_each_string_list_item(item, exclude_patterns) {
343 if (match_ref_pattern(refname, item))
348 if (include_patterns && include_patterns->nr) {
350 for_each_string_list_item(item, include_patterns) {
351 if (match_ref_pattern(refname, item)) {
363 static int filter_refs(const char *refname, const struct object_id *oid,
364 int flags, void *data)
366 struct ref_filter *filter = (struct ref_filter *)data;
368 if (wildmatch(filter->pattern, refname, 0))
371 skip_prefix(refname, filter->prefix, &refname);
372 return filter->fn(refname, oid, flags, filter->cb_data);
375 enum peel_status peel_object(const struct object_id *name, struct object_id *oid)
377 struct object *o = lookup_unknown_object(name->hash);
379 if (o->type == OBJ_NONE) {
380 int type = oid_object_info(the_repository, name, NULL);
381 if (type < 0 || !object_as_type(the_repository, o, type, 0))
385 if (o->type != OBJ_TAG)
388 o = deref_tag_noverify(o);
392 oidcpy(oid, &o->oid);
396 struct warn_if_dangling_data {
399 const struct string_list *refnames;
403 static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
404 int flags, void *cb_data)
406 struct warn_if_dangling_data *d = cb_data;
407 const char *resolves_to;
409 if (!(flags & REF_ISSYMREF))
412 resolves_to = resolve_ref_unsafe(refname, 0, NULL, NULL);
415 ? strcmp(resolves_to, d->refname)
416 : !string_list_has_string(d->refnames, resolves_to))) {
420 fprintf(d->fp, d->msg_fmt, refname);
425 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
427 struct warn_if_dangling_data data;
430 data.refname = refname;
431 data.refnames = NULL;
432 data.msg_fmt = msg_fmt;
433 for_each_rawref(warn_if_dangling_symref, &data);
436 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
438 struct warn_if_dangling_data data;
442 data.refnames = refnames;
443 data.msg_fmt = msg_fmt;
444 for_each_rawref(warn_if_dangling_symref, &data);
447 int refs_for_each_tag_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
449 return refs_for_each_ref_in(refs, "refs/tags/", fn, cb_data);
452 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
454 return refs_for_each_tag_ref(get_main_ref_store(the_repository), fn, cb_data);
457 int refs_for_each_branch_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
459 return refs_for_each_ref_in(refs, "refs/heads/", fn, cb_data);
462 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
464 return refs_for_each_branch_ref(get_main_ref_store(the_repository), fn, cb_data);
467 int refs_for_each_remote_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
469 return refs_for_each_ref_in(refs, "refs/remotes/", fn, cb_data);
472 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
474 return refs_for_each_remote_ref(get_main_ref_store(the_repository), fn, cb_data);
477 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
479 struct strbuf buf = STRBUF_INIT;
481 struct object_id oid;
484 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
485 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, &oid, &flag))
486 ret = fn(buf.buf, &oid, flag, cb_data);
487 strbuf_release(&buf);
492 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
495 struct strbuf normalized_pattern = STRBUF_INIT;
498 BUG("pattern must not start with '/'");
501 strbuf_addstr(&normalized_pattern, prefix);
503 else if (!starts_with(pattern, "refs/"))
504 strbuf_addstr(&normalized_pattern, "refs/");
505 strbuf_addstr(&normalized_pattern, pattern);
506 strbuf_strip_suffix(&normalized_pattern, "/");
508 item->string = strbuf_detach(&normalized_pattern, NULL);
509 item->util = has_glob_specials(pattern) ? NULL : item->string;
510 strbuf_release(&normalized_pattern);
513 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
514 const char *prefix, void *cb_data)
516 struct strbuf real_pattern = STRBUF_INIT;
517 struct ref_filter filter;
520 if (!prefix && !starts_with(pattern, "refs/"))
521 strbuf_addstr(&real_pattern, "refs/");
523 strbuf_addstr(&real_pattern, prefix);
524 strbuf_addstr(&real_pattern, pattern);
526 if (!has_glob_specials(pattern)) {
527 /* Append implied '/' '*' if not present. */
528 strbuf_complete(&real_pattern, '/');
529 /* No need to check for '*', there is none. */
530 strbuf_addch(&real_pattern, '*');
533 filter.pattern = real_pattern.buf;
534 filter.prefix = prefix;
536 filter.cb_data = cb_data;
537 ret = for_each_ref(filter_refs, &filter);
539 strbuf_release(&real_pattern);
543 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
545 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
548 const char *prettify_refname(const char *name)
550 if (skip_prefix(name, "refs/heads/", &name) ||
551 skip_prefix(name, "refs/tags/", &name) ||
552 skip_prefix(name, "refs/remotes/", &name))
557 static const char *ref_rev_parse_rules[] = {
563 "refs/remotes/%.*s/HEAD",
567 #define NUM_REV_PARSE_RULES (ARRAY_SIZE(ref_rev_parse_rules) - 1)
570 * Is it possible that the caller meant full_name with abbrev_name?
571 * If so return a non-zero value to signal "yes"; the magnitude of
572 * the returned value gives the precedence used for disambiguation.
574 * If abbrev_name cannot mean full_name, return 0.
576 int refname_match(const char *abbrev_name, const char *full_name)
579 const int abbrev_name_len = strlen(abbrev_name);
580 const int num_rules = NUM_REV_PARSE_RULES;
582 for (p = ref_rev_parse_rules; *p; p++)
583 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name)))
584 return &ref_rev_parse_rules[num_rules] - p;
590 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
591 * the results to 'prefixes'
593 void expand_ref_prefix(struct argv_array *prefixes, const char *prefix)
596 int len = strlen(prefix);
598 for (p = ref_rev_parse_rules; *p; p++)
599 argv_array_pushf(prefixes, *p, len, prefix);
603 * *string and *len will only be substituted, and *string returned (for
604 * later free()ing) if the string passed in is a magic short-hand form
607 static char *substitute_branch_name(const char **string, int *len)
609 struct strbuf buf = STRBUF_INIT;
610 int ret = interpret_branch_name(*string, *len, &buf, 0);
614 *string = strbuf_detach(&buf, &size);
616 return (char *)*string;
622 int dwim_ref(const char *str, int len, struct object_id *oid, char **ref)
624 char *last_branch = substitute_branch_name(&str, &len);
625 int refs_found = expand_ref(str, len, oid, ref);
630 int expand_ref(const char *str, int len, struct object_id *oid, char **ref)
634 struct strbuf fullref = STRBUF_INIT;
637 for (p = ref_rev_parse_rules; *p; p++) {
638 struct object_id oid_from_ref;
639 struct object_id *this_result;
642 this_result = refs_found ? &oid_from_ref : oid;
643 strbuf_reset(&fullref);
644 strbuf_addf(&fullref, *p, len, str);
645 r = resolve_ref_unsafe(fullref.buf, RESOLVE_REF_READING,
650 if (!warn_ambiguous_refs)
652 } else if ((flag & REF_ISSYMREF) && strcmp(fullref.buf, "HEAD")) {
653 warning(_("ignoring dangling symref %s"), fullref.buf);
654 } else if ((flag & REF_ISBROKEN) && strchr(fullref.buf, '/')) {
655 warning(_("ignoring broken ref %s"), fullref.buf);
658 strbuf_release(&fullref);
662 int dwim_log(const char *str, int len, struct object_id *oid, char **log)
664 char *last_branch = substitute_branch_name(&str, &len);
667 struct strbuf path = STRBUF_INIT;
670 for (p = ref_rev_parse_rules; *p; p++) {
671 struct object_id hash;
672 const char *ref, *it;
675 strbuf_addf(&path, *p, len, str);
676 ref = resolve_ref_unsafe(path.buf, RESOLVE_REF_READING,
680 if (reflog_exists(path.buf))
682 else if (strcmp(ref, path.buf) && reflog_exists(ref))
690 if (!warn_ambiguous_refs)
693 strbuf_release(&path);
698 static int is_per_worktree_ref(const char *refname)
700 return !strcmp(refname, "HEAD") ||
701 starts_with(refname, "refs/worktree/") ||
702 starts_with(refname, "refs/bisect/") ||
703 starts_with(refname, "refs/rewritten/");
706 static int is_pseudoref_syntax(const char *refname)
710 for (c = refname; *c; c++) {
711 if (!isupper(*c) && *c != '-' && *c != '_')
718 static int is_main_pseudoref_syntax(const char *refname)
720 return skip_prefix(refname, "main-worktree/", &refname) &&
722 is_pseudoref_syntax(refname);
725 static int is_other_pseudoref_syntax(const char *refname)
727 if (!skip_prefix(refname, "worktrees/", &refname))
729 refname = strchr(refname, '/');
730 if (!refname || !refname[1])
732 return is_pseudoref_syntax(refname + 1);
735 enum ref_type ref_type(const char *refname)
737 if (is_per_worktree_ref(refname))
738 return REF_TYPE_PER_WORKTREE;
739 if (is_pseudoref_syntax(refname))
740 return REF_TYPE_PSEUDOREF;
741 if (is_main_pseudoref_syntax(refname))
742 return REF_TYPE_MAIN_PSEUDOREF;
743 if (is_other_pseudoref_syntax(refname))
744 return REF_TYPE_OTHER_PSEUDOREF;
745 return REF_TYPE_NORMAL;
748 long get_files_ref_lock_timeout_ms(void)
750 static int configured = 0;
752 /* The default timeout is 100 ms: */
753 static int timeout_ms = 100;
756 git_config_get_int("core.filesreflocktimeout", &timeout_ms);
763 static int write_pseudoref(const char *pseudoref, const struct object_id *oid,
764 const struct object_id *old_oid, struct strbuf *err)
766 const char *filename;
768 struct lock_file lock = LOCK_INIT;
769 struct strbuf buf = STRBUF_INIT;
775 strbuf_addf(&buf, "%s\n", oid_to_hex(oid));
777 filename = git_path("%s", pseudoref);
778 fd = hold_lock_file_for_update_timeout(&lock, filename, 0,
779 get_files_ref_lock_timeout_ms());
781 strbuf_addf(err, _("could not open '%s' for writing: %s"),
782 filename, strerror(errno));
787 struct object_id actual_old_oid;
789 if (read_ref(pseudoref, &actual_old_oid)) {
790 if (!is_null_oid(old_oid)) {
791 strbuf_addf(err, _("could not read ref '%s'"),
793 rollback_lock_file(&lock);
796 } else if (is_null_oid(old_oid)) {
797 strbuf_addf(err, _("ref '%s' already exists"),
799 rollback_lock_file(&lock);
801 } else if (!oideq(&actual_old_oid, old_oid)) {
802 strbuf_addf(err, _("unexpected object ID when writing '%s'"),
804 rollback_lock_file(&lock);
809 if (write_in_full(fd, buf.buf, buf.len) < 0) {
810 strbuf_addf(err, _("could not write to '%s'"), filename);
811 rollback_lock_file(&lock);
815 commit_lock_file(&lock);
818 strbuf_release(&buf);
822 static int delete_pseudoref(const char *pseudoref, const struct object_id *old_oid)
824 const char *filename;
826 filename = git_path("%s", pseudoref);
828 if (old_oid && !is_null_oid(old_oid)) {
829 struct lock_file lock = LOCK_INIT;
831 struct object_id actual_old_oid;
833 fd = hold_lock_file_for_update_timeout(
835 get_files_ref_lock_timeout_ms());
837 error_errno(_("could not open '%s' for writing"),
841 if (read_ref(pseudoref, &actual_old_oid))
842 die(_("could not read ref '%s'"), pseudoref);
843 if (!oideq(&actual_old_oid, old_oid)) {
844 error(_("unexpected object ID when deleting '%s'"),
846 rollback_lock_file(&lock);
851 rollback_lock_file(&lock);
859 int refs_delete_ref(struct ref_store *refs, const char *msg,
861 const struct object_id *old_oid,
864 struct ref_transaction *transaction;
865 struct strbuf err = STRBUF_INIT;
867 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
868 assert(refs == get_main_ref_store(the_repository));
869 return delete_pseudoref(refname, old_oid);
872 transaction = ref_store_transaction_begin(refs, &err);
874 ref_transaction_delete(transaction, refname, old_oid,
876 ref_transaction_commit(transaction, &err)) {
877 error("%s", err.buf);
878 ref_transaction_free(transaction);
879 strbuf_release(&err);
882 ref_transaction_free(transaction);
883 strbuf_release(&err);
887 int delete_ref(const char *msg, const char *refname,
888 const struct object_id *old_oid, unsigned int flags)
890 return refs_delete_ref(get_main_ref_store(the_repository), msg, refname,
894 void copy_reflog_msg(struct strbuf *sb, const char *msg)
899 strbuf_addch(sb, '\t');
900 while ((c = *msg++)) {
901 if (wasspace && isspace(c))
903 wasspace = isspace(c);
911 int should_autocreate_reflog(const char *refname)
913 switch (log_all_ref_updates) {
914 case LOG_REFS_ALWAYS:
916 case LOG_REFS_NORMAL:
917 return starts_with(refname, "refs/heads/") ||
918 starts_with(refname, "refs/remotes/") ||
919 starts_with(refname, "refs/notes/") ||
920 !strcmp(refname, "HEAD");
926 int is_branch(const char *refname)
928 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
931 struct read_ref_at_cb {
936 struct object_id *oid;
939 struct object_id ooid;
940 struct object_id noid;
944 timestamp_t *cutoff_time;
949 static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
950 const char *email, timestamp_t timestamp, int tz,
951 const char *message, void *cb_data)
953 struct read_ref_at_cb *cb = cb_data;
957 cb->date = timestamp;
959 if (timestamp <= cb->at_time || cb->cnt == 0) {
961 *cb->msg = xstrdup(message);
963 *cb->cutoff_time = timestamp;
967 *cb->cutoff_cnt = cb->reccnt - 1;
969 * we have not yet updated cb->[n|o]oid so they still
970 * hold the values for the previous record.
972 if (!is_null_oid(&cb->ooid)) {
973 oidcpy(cb->oid, noid);
974 if (!oideq(&cb->ooid, noid))
975 warning(_("log for ref %s has gap after %s"),
976 cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
978 else if (cb->date == cb->at_time)
979 oidcpy(cb->oid, noid);
980 else if (!oideq(noid, cb->oid))
981 warning(_("log for ref %s unexpectedly ended on %s"),
982 cb->refname, show_date(cb->date, cb->tz,
983 DATE_MODE(RFC2822)));
984 oidcpy(&cb->ooid, ooid);
985 oidcpy(&cb->noid, noid);
989 oidcpy(&cb->ooid, ooid);
990 oidcpy(&cb->noid, noid);
996 static int read_ref_at_ent_oldest(struct object_id *ooid, struct object_id *noid,
997 const char *email, timestamp_t timestamp,
998 int tz, const char *message, void *cb_data)
1000 struct read_ref_at_cb *cb = cb_data;
1003 *cb->msg = xstrdup(message);
1004 if (cb->cutoff_time)
1005 *cb->cutoff_time = timestamp;
1007 *cb->cutoff_tz = tz;
1009 *cb->cutoff_cnt = cb->reccnt;
1010 oidcpy(cb->oid, ooid);
1011 if (is_null_oid(cb->oid))
1012 oidcpy(cb->oid, noid);
1013 /* We just want the first entry */
1017 int read_ref_at(const char *refname, unsigned int flags, timestamp_t at_time, int cnt,
1018 struct object_id *oid, char **msg,
1019 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1021 struct read_ref_at_cb cb;
1023 memset(&cb, 0, sizeof(cb));
1024 cb.refname = refname;
1025 cb.at_time = at_time;
1028 cb.cutoff_time = cutoff_time;
1029 cb.cutoff_tz = cutoff_tz;
1030 cb.cutoff_cnt = cutoff_cnt;
1033 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
1036 if (flags & GET_OID_QUIETLY)
1039 die(_("log for %s is empty"), refname);
1044 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
1049 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
1052 struct ref_transaction *tr;
1055 tr = xcalloc(1, sizeof(struct ref_transaction));
1056 tr->ref_store = refs;
1060 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
1062 return ref_store_transaction_begin(get_main_ref_store(the_repository), err);
1065 void ref_transaction_free(struct ref_transaction *transaction)
1072 switch (transaction->state) {
1073 case REF_TRANSACTION_OPEN:
1074 case REF_TRANSACTION_CLOSED:
1077 case REF_TRANSACTION_PREPARED:
1078 BUG("free called on a prepared reference transaction");
1081 BUG("unexpected reference transaction state");
1085 for (i = 0; i < transaction->nr; i++) {
1086 free(transaction->updates[i]->msg);
1087 free(transaction->updates[i]);
1089 free(transaction->updates);
1093 struct ref_update *ref_transaction_add_update(
1094 struct ref_transaction *transaction,
1095 const char *refname, unsigned int flags,
1096 const struct object_id *new_oid,
1097 const struct object_id *old_oid,
1100 struct ref_update *update;
1102 if (transaction->state != REF_TRANSACTION_OPEN)
1103 BUG("update called for transaction that is not open");
1105 FLEX_ALLOC_STR(update, refname, refname);
1106 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
1107 transaction->updates[transaction->nr++] = update;
1109 update->flags = flags;
1111 if (flags & REF_HAVE_NEW)
1112 oidcpy(&update->new_oid, new_oid);
1113 if (flags & REF_HAVE_OLD)
1114 oidcpy(&update->old_oid, old_oid);
1115 update->msg = xstrdup_or_null(msg);
1119 int ref_transaction_update(struct ref_transaction *transaction,
1120 const char *refname,
1121 const struct object_id *new_oid,
1122 const struct object_id *old_oid,
1123 unsigned int flags, const char *msg,
1128 if ((new_oid && !is_null_oid(new_oid)) ?
1129 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL) :
1130 !refname_is_safe(refname)) {
1131 strbuf_addf(err, _("refusing to update ref with bad name '%s'"),
1136 if (flags & ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS)
1137 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags);
1139 flags |= (new_oid ? REF_HAVE_NEW : 0) | (old_oid ? REF_HAVE_OLD : 0);
1141 ref_transaction_add_update(transaction, refname, flags,
1142 new_oid, old_oid, msg);
1146 int ref_transaction_create(struct ref_transaction *transaction,
1147 const char *refname,
1148 const struct object_id *new_oid,
1149 unsigned int flags, const char *msg,
1152 if (!new_oid || is_null_oid(new_oid))
1153 BUG("create called without valid new_oid");
1154 return ref_transaction_update(transaction, refname, new_oid,
1155 &null_oid, flags, msg, err);
1158 int ref_transaction_delete(struct ref_transaction *transaction,
1159 const char *refname,
1160 const struct object_id *old_oid,
1161 unsigned int flags, const char *msg,
1164 if (old_oid && is_null_oid(old_oid))
1165 BUG("delete called with old_oid set to zeros");
1166 return ref_transaction_update(transaction, refname,
1171 int ref_transaction_verify(struct ref_transaction *transaction,
1172 const char *refname,
1173 const struct object_id *old_oid,
1178 BUG("verify called with old_oid set to NULL");
1179 return ref_transaction_update(transaction, refname,
1184 int refs_update_ref(struct ref_store *refs, const char *msg,
1185 const char *refname, const struct object_id *new_oid,
1186 const struct object_id *old_oid, unsigned int flags,
1187 enum action_on_err onerr)
1189 struct ref_transaction *t = NULL;
1190 struct strbuf err = STRBUF_INIT;
1193 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
1194 assert(refs == get_main_ref_store(the_repository));
1195 ret = write_pseudoref(refname, new_oid, old_oid, &err);
1197 t = ref_store_transaction_begin(refs, &err);
1199 ref_transaction_update(t, refname, new_oid, old_oid,
1200 flags, msg, &err) ||
1201 ref_transaction_commit(t, &err)) {
1203 ref_transaction_free(t);
1207 const char *str = _("update_ref failed for ref '%s': %s");
1210 case UPDATE_REFS_MSG_ON_ERR:
1211 error(str, refname, err.buf);
1213 case UPDATE_REFS_DIE_ON_ERR:
1214 die(str, refname, err.buf);
1216 case UPDATE_REFS_QUIET_ON_ERR:
1219 strbuf_release(&err);
1222 strbuf_release(&err);
1224 ref_transaction_free(t);
1228 int update_ref(const char *msg, const char *refname,
1229 const struct object_id *new_oid,
1230 const struct object_id *old_oid,
1231 unsigned int flags, enum action_on_err onerr)
1233 return refs_update_ref(get_main_ref_store(the_repository), msg, refname, new_oid,
1234 old_oid, flags, onerr);
1237 char *shorten_unambiguous_ref(const char *refname, int strict)
1240 static char **scanf_fmts;
1241 static int nr_rules;
1243 struct strbuf resolved_buf = STRBUF_INIT;
1247 * Pre-generate scanf formats from ref_rev_parse_rules[].
1248 * Generate a format suitable for scanf from a
1249 * ref_rev_parse_rules rule by interpolating "%s" at the
1250 * location of the "%.*s".
1252 size_t total_len = 0;
1255 /* the rule list is NULL terminated, count them first */
1256 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
1257 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1258 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
1260 scanf_fmts = xmalloc(st_add(st_mult(sizeof(char *), nr_rules), total_len));
1263 for (i = 0; i < nr_rules; i++) {
1264 assert(offset < total_len);
1265 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
1266 offset += xsnprintf(scanf_fmts[i], total_len - offset,
1267 ref_rev_parse_rules[i], 2, "%s") + 1;
1271 /* bail out if there are no rules */
1273 return xstrdup(refname);
1275 /* buffer for scanf result, at most refname must fit */
1276 short_name = xstrdup(refname);
1278 /* skip first rule, it will always match */
1279 for (i = nr_rules - 1; i > 0 ; --i) {
1281 int rules_to_fail = i;
1284 if (1 != sscanf(refname, scanf_fmts[i], short_name))
1287 short_name_len = strlen(short_name);
1290 * in strict mode, all (except the matched one) rules
1291 * must fail to resolve to a valid non-ambiguous ref
1294 rules_to_fail = nr_rules;
1297 * check if the short name resolves to a valid ref,
1298 * but use only rules prior to the matched one
1300 for (j = 0; j < rules_to_fail; j++) {
1301 const char *rule = ref_rev_parse_rules[j];
1303 /* skip matched rule */
1308 * the short name is ambiguous, if it resolves
1309 * (with this previous rule) to a valid ref
1310 * read_ref() returns 0 on success
1312 strbuf_reset(&resolved_buf);
1313 strbuf_addf(&resolved_buf, rule,
1314 short_name_len, short_name);
1315 if (ref_exists(resolved_buf.buf))
1320 * short name is non-ambiguous if all previous rules
1321 * haven't resolved to a valid ref
1323 if (j == rules_to_fail) {
1324 strbuf_release(&resolved_buf);
1329 strbuf_release(&resolved_buf);
1331 return xstrdup(refname);
1334 static struct string_list *hide_refs;
1336 int parse_hide_refs_config(const char *var, const char *value, const char *section)
1339 if (!strcmp("transfer.hiderefs", var) ||
1340 (!parse_config_key(var, section, NULL, NULL, &key) &&
1341 !strcmp(key, "hiderefs"))) {
1346 return config_error_nonbool(var);
1347 ref = xstrdup(value);
1349 while (len && ref[len - 1] == '/')
1352 hide_refs = xcalloc(1, sizeof(*hide_refs));
1353 hide_refs->strdup_strings = 1;
1355 string_list_append(hide_refs, ref);
1360 int ref_is_hidden(const char *refname, const char *refname_full)
1366 for (i = hide_refs->nr - 1; i >= 0; i--) {
1367 const char *match = hide_refs->items[i].string;
1368 const char *subject;
1372 if (*match == '!') {
1377 if (*match == '^') {
1378 subject = refname_full;
1384 /* refname can be NULL when namespaces are used. */
1386 skip_prefix(subject, match, &p) &&
1393 const char *find_descendant_ref(const char *dirname,
1394 const struct string_list *extras,
1395 const struct string_list *skip)
1403 * Look at the place where dirname would be inserted into
1404 * extras. If there is an entry at that position that starts
1405 * with dirname (remember, dirname includes the trailing
1406 * slash) and is not in skip, then we have a conflict.
1408 for (pos = string_list_find_insert_index(extras, dirname, 0);
1409 pos < extras->nr; pos++) {
1410 const char *extra_refname = extras->items[pos].string;
1412 if (!starts_with(extra_refname, dirname))
1415 if (!skip || !string_list_has_string(skip, extra_refname))
1416 return extra_refname;
1421 int refs_rename_ref_available(struct ref_store *refs,
1422 const char *old_refname,
1423 const char *new_refname)
1425 struct string_list skip = STRING_LIST_INIT_NODUP;
1426 struct strbuf err = STRBUF_INIT;
1429 string_list_insert(&skip, old_refname);
1430 ok = !refs_verify_refname_available(refs, new_refname,
1433 error("%s", err.buf);
1435 string_list_clear(&skip, 0);
1436 strbuf_release(&err);
1440 int refs_head_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1442 struct object_id oid;
1445 if (!refs_read_ref_full(refs, "HEAD", RESOLVE_REF_READING,
1447 return fn("HEAD", &oid, flag, cb_data);
1452 int head_ref(each_ref_fn fn, void *cb_data)
1454 return refs_head_ref(get_main_ref_store(the_repository), fn, cb_data);
1457 struct ref_iterator *refs_ref_iterator_begin(
1458 struct ref_store *refs,
1459 const char *prefix, int trim, int flags)
1461 struct ref_iterator *iter;
1463 if (ref_paranoia < 0)
1464 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
1466 flags |= DO_FOR_EACH_INCLUDE_BROKEN;
1468 iter = refs->be->iterator_begin(refs, prefix, flags);
1471 * `iterator_begin()` already takes care of prefix, but we
1472 * might need to do some trimming:
1475 iter = prefix_ref_iterator_begin(iter, "", trim);
1477 /* Sanity check for subclasses: */
1479 BUG("reference iterator is not ordered");
1485 * Call fn for each reference in the specified submodule for which the
1486 * refname begins with prefix. If trim is non-zero, then trim that
1487 * many characters off the beginning of each refname before passing
1488 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1489 * include broken references in the iteration. If fn ever returns a
1490 * non-zero value, stop the iteration and return that value;
1491 * otherwise, return 0.
1493 static int do_for_each_repo_ref(struct repository *r, const char *prefix,
1494 each_repo_ref_fn fn, int trim, int flags,
1497 struct ref_iterator *iter;
1498 struct ref_store *refs = get_main_ref_store(r);
1503 iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1505 return do_for_each_repo_ref_iterator(r, iter, fn, cb_data);
1508 struct do_for_each_ref_help {
1513 static int do_for_each_ref_helper(struct repository *r,
1514 const char *refname,
1515 const struct object_id *oid,
1519 struct do_for_each_ref_help *hp = cb_data;
1521 return hp->fn(refname, oid, flags, hp->cb_data);
1524 static int do_for_each_ref(struct ref_store *refs, const char *prefix,
1525 each_ref_fn fn, int trim, int flags, void *cb_data)
1527 struct ref_iterator *iter;
1528 struct do_for_each_ref_help hp = { fn, cb_data };
1533 iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1535 return do_for_each_repo_ref_iterator(the_repository, iter,
1536 do_for_each_ref_helper, &hp);
1539 int refs_for_each_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1541 return do_for_each_ref(refs, "", fn, 0, 0, cb_data);
1544 int for_each_ref(each_ref_fn fn, void *cb_data)
1546 return refs_for_each_ref(get_main_ref_store(the_repository), fn, cb_data);
1549 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
1550 each_ref_fn fn, void *cb_data)
1552 return do_for_each_ref(refs, prefix, fn, strlen(prefix), 0, cb_data);
1555 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1557 return refs_for_each_ref_in(get_main_ref_store(the_repository), prefix, fn, cb_data);
1560 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken)
1562 unsigned int flag = 0;
1565 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1566 return do_for_each_ref(get_main_ref_store(the_repository),
1567 prefix, fn, 0, flag, cb_data);
1570 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
1571 each_ref_fn fn, void *cb_data,
1572 unsigned int broken)
1574 unsigned int flag = 0;
1577 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1578 return do_for_each_ref(refs, prefix, fn, 0, flag, cb_data);
1581 int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data)
1583 return do_for_each_repo_ref(r, git_replace_ref_base, fn,
1584 strlen(git_replace_ref_base),
1585 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1588 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1590 struct strbuf buf = STRBUF_INIT;
1592 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1593 ret = do_for_each_ref(get_main_ref_store(the_repository),
1594 buf.buf, fn, 0, 0, cb_data);
1595 strbuf_release(&buf);
1599 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1601 return do_for_each_ref(refs, "", fn, 0,
1602 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1605 int for_each_rawref(each_ref_fn fn, void *cb_data)
1607 return refs_for_each_rawref(get_main_ref_store(the_repository), fn, cb_data);
1610 int refs_read_raw_ref(struct ref_store *ref_store,
1611 const char *refname, struct object_id *oid,
1612 struct strbuf *referent, unsigned int *type)
1614 return ref_store->be->read_raw_ref(ref_store, refname, oid, referent, type);
1617 /* This function needs to return a meaningful errno on failure */
1618 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
1619 const char *refname,
1621 struct object_id *oid, int *flags)
1623 static struct strbuf sb_refname = STRBUF_INIT;
1624 struct object_id unused_oid;
1631 flags = &unused_flags;
1635 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1636 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1637 !refname_is_safe(refname)) {
1643 * dwim_ref() uses REF_ISBROKEN to distinguish between
1644 * missing refs and refs that were present but invalid,
1645 * to complain about the latter to stderr.
1647 * We don't know whether the ref exists, so don't set
1650 *flags |= REF_BAD_NAME;
1653 for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
1654 unsigned int read_flags = 0;
1656 if (refs_read_raw_ref(refs, refname,
1657 oid, &sb_refname, &read_flags)) {
1658 *flags |= read_flags;
1660 /* In reading mode, refs must eventually resolve */
1661 if (resolve_flags & RESOLVE_REF_READING)
1665 * Otherwise a missing ref is OK. But the files backend
1666 * may show errors besides ENOENT if there are
1667 * similarly-named refs.
1669 if (errno != ENOENT &&
1675 if (*flags & REF_BAD_NAME)
1676 *flags |= REF_ISBROKEN;
1680 *flags |= read_flags;
1682 if (!(read_flags & REF_ISSYMREF)) {
1683 if (*flags & REF_BAD_NAME) {
1685 *flags |= REF_ISBROKEN;
1690 refname = sb_refname.buf;
1691 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1695 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1696 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1697 !refname_is_safe(refname)) {
1702 *flags |= REF_ISBROKEN | REF_BAD_NAME;
1710 /* backend functions */
1711 int refs_init_db(struct strbuf *err)
1713 struct ref_store *refs = get_main_ref_store(the_repository);
1715 return refs->be->init_db(refs, err);
1718 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1719 struct object_id *oid, int *flags)
1721 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository), refname,
1722 resolve_flags, oid, flags);
1725 int resolve_gitlink_ref(const char *submodule, const char *refname,
1726 struct object_id *oid)
1728 struct ref_store *refs;
1731 refs = get_submodule_ref_store(submodule);
1736 if (!refs_resolve_ref_unsafe(refs, refname, 0, oid, &flags) ||
1742 struct ref_store_hash_entry
1744 struct hashmap_entry ent; /* must be the first member! */
1746 struct ref_store *refs;
1748 /* NUL-terminated identifier of the ref store: */
1749 char name[FLEX_ARRAY];
1752 static int ref_store_hash_cmp(const void *unused_cmp_data,
1753 const void *entry, const void *entry_or_key,
1754 const void *keydata)
1756 const struct ref_store_hash_entry *e1 = entry, *e2 = entry_or_key;
1757 const char *name = keydata ? keydata : e2->name;
1759 return strcmp(e1->name, name);
1762 static struct ref_store_hash_entry *alloc_ref_store_hash_entry(
1763 const char *name, struct ref_store *refs)
1765 struct ref_store_hash_entry *entry;
1767 FLEX_ALLOC_STR(entry, name, name);
1768 hashmap_entry_init(entry, strhash(name));
1773 /* A hashmap of ref_stores, stored by submodule name: */
1774 static struct hashmap submodule_ref_stores;
1776 /* A hashmap of ref_stores, stored by worktree id: */
1777 static struct hashmap worktree_ref_stores;
1780 * Look up a ref store by name. If that ref_store hasn't been
1781 * registered yet, return NULL.
1783 static struct ref_store *lookup_ref_store_map(struct hashmap *map,
1786 struct ref_store_hash_entry *entry;
1788 if (!map->tablesize)
1789 /* It's initialized on demand in register_ref_store(). */
1792 entry = hashmap_get_from_hash(map, strhash(name), name);
1793 return entry ? entry->refs : NULL;
1797 * Create, record, and return a ref_store instance for the specified
1800 static struct ref_store *ref_store_init(const char *gitdir,
1803 const char *be_name = "files";
1804 struct ref_storage_be *be = find_ref_storage_backend(be_name);
1805 struct ref_store *refs;
1808 BUG("reference backend %s is unknown", be_name);
1810 refs = be->init(gitdir, flags);
1814 struct ref_store *get_main_ref_store(struct repository *r)
1820 BUG("attempting to get main_ref_store outside of repository");
1822 r->refs = ref_store_init(r->gitdir, REF_STORE_ALL_CAPS);
1827 * Associate a ref store with a name. It is a fatal error to call this
1828 * function twice for the same name.
1830 static void register_ref_store_map(struct hashmap *map,
1832 struct ref_store *refs,
1835 if (!map->tablesize)
1836 hashmap_init(map, ref_store_hash_cmp, NULL, 0);
1838 if (hashmap_put(map, alloc_ref_store_hash_entry(name, refs)))
1839 BUG("%s ref_store '%s' initialized twice", type, name);
1842 struct ref_store *get_submodule_ref_store(const char *submodule)
1844 struct strbuf submodule_sb = STRBUF_INIT;
1845 struct ref_store *refs;
1846 char *to_free = NULL;
1852 len = strlen(submodule);
1853 while (len && is_dir_sep(submodule[len - 1]))
1859 /* We need to strip off one or more trailing slashes */
1860 submodule = to_free = xmemdupz(submodule, len);
1862 refs = lookup_ref_store_map(&submodule_ref_stores, submodule);
1866 strbuf_addstr(&submodule_sb, submodule);
1867 if (!is_nonbare_repository_dir(&submodule_sb))
1870 if (submodule_to_gitdir(&submodule_sb, submodule))
1873 /* assume that add_submodule_odb() has been called */
1874 refs = ref_store_init(submodule_sb.buf,
1875 REF_STORE_READ | REF_STORE_ODB);
1876 register_ref_store_map(&submodule_ref_stores, "submodule",
1880 strbuf_release(&submodule_sb);
1886 struct ref_store *get_worktree_ref_store(const struct worktree *wt)
1888 struct ref_store *refs;
1892 return get_main_ref_store(the_repository);
1894 id = wt->id ? wt->id : "/";
1895 refs = lookup_ref_store_map(&worktree_ref_stores, id);
1900 refs = ref_store_init(git_common_path("worktrees/%s", wt->id),
1901 REF_STORE_ALL_CAPS);
1903 refs = ref_store_init(get_git_common_dir(),
1904 REF_STORE_ALL_CAPS);
1907 register_ref_store_map(&worktree_ref_stores, "worktree",
1912 void base_ref_store_init(struct ref_store *refs,
1913 const struct ref_storage_be *be)
1918 /* backend functions */
1919 int refs_pack_refs(struct ref_store *refs, unsigned int flags)
1921 return refs->be->pack_refs(refs, flags);
1924 int refs_peel_ref(struct ref_store *refs, const char *refname,
1925 struct object_id *oid)
1928 struct object_id base;
1930 if (current_ref_iter && current_ref_iter->refname == refname) {
1931 struct object_id peeled;
1933 if (ref_iterator_peel(current_ref_iter, &peeled))
1935 oidcpy(oid, &peeled);
1939 if (refs_read_ref_full(refs, refname,
1940 RESOLVE_REF_READING, &base, &flag))
1943 return peel_object(&base, oid);
1946 int peel_ref(const char *refname, struct object_id *oid)
1948 return refs_peel_ref(get_main_ref_store(the_repository), refname, oid);
1951 int refs_create_symref(struct ref_store *refs,
1952 const char *ref_target,
1953 const char *refs_heads_master,
1956 return refs->be->create_symref(refs, ref_target,
1961 int create_symref(const char *ref_target, const char *refs_heads_master,
1964 return refs_create_symref(get_main_ref_store(the_repository), ref_target,
1965 refs_heads_master, logmsg);
1968 int ref_update_reject_duplicates(struct string_list *refnames,
1971 size_t i, n = refnames->nr;
1975 for (i = 1; i < n; i++) {
1976 int cmp = strcmp(refnames->items[i - 1].string,
1977 refnames->items[i].string);
1981 _("multiple updates for ref '%s' not allowed"),
1982 refnames->items[i].string);
1984 } else if (cmp > 0) {
1985 BUG("ref_update_reject_duplicates() received unsorted list");
1991 int ref_transaction_prepare(struct ref_transaction *transaction,
1994 struct ref_store *refs = transaction->ref_store;
1996 switch (transaction->state) {
1997 case REF_TRANSACTION_OPEN:
2000 case REF_TRANSACTION_PREPARED:
2001 BUG("prepare called twice on reference transaction");
2003 case REF_TRANSACTION_CLOSED:
2004 BUG("prepare called on a closed reference transaction");
2007 BUG("unexpected reference transaction state");
2011 if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
2013 _("ref updates forbidden inside quarantine environment"));
2017 return refs->be->transaction_prepare(refs, transaction, err);
2020 int ref_transaction_abort(struct ref_transaction *transaction,
2023 struct ref_store *refs = transaction->ref_store;
2026 switch (transaction->state) {
2027 case REF_TRANSACTION_OPEN:
2028 /* No need to abort explicitly. */
2030 case REF_TRANSACTION_PREPARED:
2031 ret = refs->be->transaction_abort(refs, transaction, err);
2033 case REF_TRANSACTION_CLOSED:
2034 BUG("abort called on a closed reference transaction");
2037 BUG("unexpected reference transaction state");
2041 ref_transaction_free(transaction);
2045 int ref_transaction_commit(struct ref_transaction *transaction,
2048 struct ref_store *refs = transaction->ref_store;
2051 switch (transaction->state) {
2052 case REF_TRANSACTION_OPEN:
2053 /* Need to prepare first. */
2054 ret = ref_transaction_prepare(transaction, err);
2058 case REF_TRANSACTION_PREPARED:
2059 /* Fall through to finish. */
2061 case REF_TRANSACTION_CLOSED:
2062 BUG("commit called on a closed reference transaction");
2065 BUG("unexpected reference transaction state");
2069 return refs->be->transaction_finish(refs, transaction, err);
2072 int refs_verify_refname_available(struct ref_store *refs,
2073 const char *refname,
2074 const struct string_list *extras,
2075 const struct string_list *skip,
2079 const char *extra_refname;
2080 struct strbuf dirname = STRBUF_INIT;
2081 struct strbuf referent = STRBUF_INIT;
2082 struct object_id oid;
2084 struct ref_iterator *iter;
2089 * For the sake of comments in this function, suppose that
2090 * refname is "refs/foo/bar".
2095 strbuf_grow(&dirname, strlen(refname) + 1);
2096 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
2097 /* Expand dirname to the new prefix, not including the trailing slash: */
2098 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);
2101 * We are still at a leading dir of the refname (e.g.,
2102 * "refs/foo"; if there is a reference with that name,
2103 * it is a conflict, *unless* it is in skip.
2105 if (skip && string_list_has_string(skip, dirname.buf))
2108 if (!refs_read_raw_ref(refs, dirname.buf, &oid, &referent, &type)) {
2109 strbuf_addf(err, _("'%s' exists; cannot create '%s'"),
2110 dirname.buf, refname);
2114 if (extras && string_list_has_string(extras, dirname.buf)) {
2115 strbuf_addf(err, _("cannot process '%s' and '%s' at the same time"),
2116 refname, dirname.buf);
2122 * We are at the leaf of our refname (e.g., "refs/foo/bar").
2123 * There is no point in searching for a reference with that
2124 * name, because a refname isn't considered to conflict with
2125 * itself. But we still need to check for references whose
2126 * names are in the "refs/foo/bar/" namespace, because they
2129 strbuf_addstr(&dirname, refname + dirname.len);
2130 strbuf_addch(&dirname, '/');
2132 iter = refs_ref_iterator_begin(refs, dirname.buf, 0,
2133 DO_FOR_EACH_INCLUDE_BROKEN);
2134 while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
2136 string_list_has_string(skip, iter->refname))
2139 strbuf_addf(err, _("'%s' exists; cannot create '%s'"),
2140 iter->refname, refname);
2141 ref_iterator_abort(iter);
2145 if (ok != ITER_DONE)
2146 BUG("error while iterating over references");
2148 extra_refname = find_descendant_ref(dirname.buf, extras, skip);
2150 strbuf_addf(err, _("cannot process '%s' and '%s' at the same time"),
2151 refname, extra_refname);
2156 strbuf_release(&referent);
2157 strbuf_release(&dirname);
2161 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data)
2163 struct ref_iterator *iter;
2164 struct do_for_each_ref_help hp = { fn, cb_data };
2166 iter = refs->be->reflog_iterator_begin(refs);
2168 return do_for_each_repo_ref_iterator(the_repository, iter,
2169 do_for_each_ref_helper, &hp);
2172 int for_each_reflog(each_ref_fn fn, void *cb_data)
2174 return refs_for_each_reflog(get_main_ref_store(the_repository), fn, cb_data);
2177 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
2178 const char *refname,
2179 each_reflog_ent_fn fn,
2182 return refs->be->for_each_reflog_ent_reverse(refs, refname,
2186 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn,
2189 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository),
2190 refname, fn, cb_data);
2193 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
2194 each_reflog_ent_fn fn, void *cb_data)
2196 return refs->be->for_each_reflog_ent(refs, refname, fn, cb_data);
2199 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn,
2202 return refs_for_each_reflog_ent(get_main_ref_store(the_repository), refname,
2206 int refs_reflog_exists(struct ref_store *refs, const char *refname)
2208 return refs->be->reflog_exists(refs, refname);
2211 int reflog_exists(const char *refname)
2213 return refs_reflog_exists(get_main_ref_store(the_repository), refname);
2216 int refs_create_reflog(struct ref_store *refs, const char *refname,
2217 int force_create, struct strbuf *err)
2219 return refs->be->create_reflog(refs, refname, force_create, err);
2222 int safe_create_reflog(const char *refname, int force_create,
2225 return refs_create_reflog(get_main_ref_store(the_repository), refname,
2229 int refs_delete_reflog(struct ref_store *refs, const char *refname)
2231 return refs->be->delete_reflog(refs, refname);
2234 int delete_reflog(const char *refname)
2236 return refs_delete_reflog(get_main_ref_store(the_repository), refname);
2239 int refs_reflog_expire(struct ref_store *refs,
2240 const char *refname, const struct object_id *oid,
2242 reflog_expiry_prepare_fn prepare_fn,
2243 reflog_expiry_should_prune_fn should_prune_fn,
2244 reflog_expiry_cleanup_fn cleanup_fn,
2245 void *policy_cb_data)
2247 return refs->be->reflog_expire(refs, refname, oid, flags,
2248 prepare_fn, should_prune_fn,
2249 cleanup_fn, policy_cb_data);
2252 int reflog_expire(const char *refname, const struct object_id *oid,
2254 reflog_expiry_prepare_fn prepare_fn,
2255 reflog_expiry_should_prune_fn should_prune_fn,
2256 reflog_expiry_cleanup_fn cleanup_fn,
2257 void *policy_cb_data)
2259 return refs_reflog_expire(get_main_ref_store(the_repository),
2260 refname, oid, flags,
2261 prepare_fn, should_prune_fn,
2262 cleanup_fn, policy_cb_data);
2265 int initial_ref_transaction_commit(struct ref_transaction *transaction,
2268 struct ref_store *refs = transaction->ref_store;
2270 return refs->be->initial_transaction_commit(refs, transaction, err);
2273 int refs_delete_refs(struct ref_store *refs, const char *msg,
2274 struct string_list *refnames, unsigned int flags)
2276 return refs->be->delete_refs(refs, msg, refnames, flags);
2279 int delete_refs(const char *msg, struct string_list *refnames,
2282 return refs_delete_refs(get_main_ref_store(the_repository), msg, refnames, flags);
2285 int refs_rename_ref(struct ref_store *refs, const char *oldref,
2286 const char *newref, const char *logmsg)
2288 return refs->be->rename_ref(refs, oldref, newref, logmsg);
2291 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
2293 return refs_rename_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);
2296 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
2297 const char *newref, const char *logmsg)
2299 return refs->be->copy_ref(refs, oldref, newref, logmsg);
2302 int copy_existing_ref(const char *oldref, const char *newref, const char *logmsg)
2304 return refs_copy_existing_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);