Merge branch 'js/t5534-rev-parse-gives-multi-line-output-fix'
[git/gitweb.git] / refs.c
blob88658ba76960401e4ab246b597d1212f5b435de1
1 /*
2 * The backend-independent part of the reference module.
3 */
5 #include "cache.h"
6 #include "config.h"
7 #include "hashmap.h"
8 #include "lockfile.h"
9 #include "iterator.h"
10 #include "refs.h"
11 #include "refs/refs-internal.h"
12 #include "object.h"
13 #include "tag.h"
14 #include "submodule.h"
15 #include "worktree.h"
18 * List of all available backends
20 static struct ref_storage_be *refs_backends = &refs_be_files;
22 static struct ref_storage_be *find_ref_storage_backend(const char *name)
24 struct ref_storage_be *be;
25 for (be = refs_backends; be; be = be->next)
26 if (!strcmp(be->name, name))
27 return be;
28 return NULL;
31 int ref_storage_backend_exists(const char *name)
33 return find_ref_storage_backend(name) != NULL;
37 * How to handle various characters in refnames:
38 * 0: An acceptable character for refs
39 * 1: End-of-component
40 * 2: ., look for a preceding . to reject .. in refs
41 * 3: {, look for a preceding @ to reject @{ in refs
42 * 4: A bad character: ASCII control characters, and
43 * ":", "?", "[", "\", "^", "~", SP, or TAB
44 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
46 static unsigned char refname_disposition[256] = {
47 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
48 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
49 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
50 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
51 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
52 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
58 * Try to read one refname component from the front of refname.
59 * Return the length of the component found, or -1 if the component is
60 * not legal. It is legal if it is something reasonable to have under
61 * ".git/refs/"; We do not like it if:
63 * - any path component of it begins with ".", or
64 * - it has double dots "..", or
65 * - it has ASCII control characters, or
66 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
67 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
68 * - it ends with a "/", or
69 * - it ends with ".lock", or
70 * - it contains a "@{" portion
72 static int check_refname_component(const char *refname, int *flags)
74 const char *cp;
75 char last = '\0';
77 for (cp = refname; ; cp++) {
78 int ch = *cp & 255;
79 unsigned char disp = refname_disposition[ch];
80 switch (disp) {
81 case 1:
82 goto out;
83 case 2:
84 if (last == '.')
85 return -1; /* Refname contains "..". */
86 break;
87 case 3:
88 if (last == '@')
89 return -1; /* Refname contains "@{". */
90 break;
91 case 4:
92 return -1;
93 case 5:
94 if (!(*flags & REFNAME_REFSPEC_PATTERN))
95 return -1; /* refspec can't be a pattern */
98 * Unset the pattern flag so that we only accept
99 * a single asterisk for one side of refspec.
101 *flags &= ~ REFNAME_REFSPEC_PATTERN;
102 break;
104 last = ch;
106 out:
107 if (cp == refname)
108 return 0; /* Component has zero length. */
109 if (refname[0] == '.')
110 return -1; /* Component starts with '.'. */
111 if (cp - refname >= LOCK_SUFFIX_LEN &&
112 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
113 return -1; /* Refname ends with ".lock". */
114 return cp - refname;
117 int check_refname_format(const char *refname, int flags)
119 int component_len, component_count = 0;
121 if (!strcmp(refname, "@"))
122 /* Refname is a single character '@'. */
123 return -1;
125 while (1) {
126 /* We are at the start of a path component. */
127 component_len = check_refname_component(refname, &flags);
128 if (component_len <= 0)
129 return -1;
131 component_count++;
132 if (refname[component_len] == '\0')
133 break;
134 /* Skip to next component. */
135 refname += component_len + 1;
138 if (refname[component_len - 1] == '.')
139 return -1; /* Refname ends with '.'. */
140 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
141 return -1; /* Refname has only one component. */
142 return 0;
145 int refname_is_safe(const char *refname)
147 const char *rest;
149 if (skip_prefix(refname, "refs/", &rest)) {
150 char *buf;
151 int result;
152 size_t restlen = strlen(rest);
154 /* rest must not be empty, or start or end with "/" */
155 if (!restlen || *rest == '/' || rest[restlen - 1] == '/')
156 return 0;
159 * Does the refname try to escape refs/?
160 * For example: refs/foo/../bar is safe but refs/foo/../../bar
161 * is not.
163 buf = xmallocz(restlen);
164 result = !normalize_path_copy(buf, rest) && !strcmp(buf, rest);
165 free(buf);
166 return result;
169 do {
170 if (!isupper(*refname) && *refname != '_')
171 return 0;
172 refname++;
173 } while (*refname);
174 return 1;
177 char *refs_resolve_refdup(struct ref_store *refs,
178 const char *refname, int resolve_flags,
179 unsigned char *sha1, int *flags)
181 const char *result;
183 result = refs_resolve_ref_unsafe(refs, refname, resolve_flags,
184 sha1, flags);
185 return xstrdup_or_null(result);
188 char *resolve_refdup(const char *refname, int resolve_flags,
189 unsigned char *sha1, int *flags)
191 return refs_resolve_refdup(get_main_ref_store(),
192 refname, resolve_flags,
193 sha1, flags);
196 /* The argument to filter_refs */
197 struct ref_filter {
198 const char *pattern;
199 each_ref_fn *fn;
200 void *cb_data;
203 int refs_read_ref_full(struct ref_store *refs, const char *refname,
204 int resolve_flags, unsigned char *sha1, int *flags)
206 if (refs_resolve_ref_unsafe(refs, refname, resolve_flags, sha1, flags))
207 return 0;
208 return -1;
211 int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
213 return refs_read_ref_full(get_main_ref_store(), refname,
214 resolve_flags, sha1, flags);
217 int read_ref(const char *refname, unsigned char *sha1)
219 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
222 int ref_exists(const char *refname)
224 unsigned char sha1[20];
225 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
228 static int filter_refs(const char *refname, const struct object_id *oid,
229 int flags, void *data)
231 struct ref_filter *filter = (struct ref_filter *)data;
233 if (wildmatch(filter->pattern, refname, 0, NULL))
234 return 0;
235 return filter->fn(refname, oid, flags, filter->cb_data);
238 enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
240 struct object *o = lookup_unknown_object(name);
242 if (o->type == OBJ_NONE) {
243 int type = sha1_object_info(name, NULL);
244 if (type < 0 || !object_as_type(o, type, 0))
245 return PEEL_INVALID;
248 if (o->type != OBJ_TAG)
249 return PEEL_NON_TAG;
251 o = deref_tag_noverify(o);
252 if (!o)
253 return PEEL_INVALID;
255 hashcpy(sha1, o->oid.hash);
256 return PEEL_PEELED;
259 struct warn_if_dangling_data {
260 FILE *fp;
261 const char *refname;
262 const struct string_list *refnames;
263 const char *msg_fmt;
266 static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
267 int flags, void *cb_data)
269 struct warn_if_dangling_data *d = cb_data;
270 const char *resolves_to;
271 struct object_id junk;
273 if (!(flags & REF_ISSYMREF))
274 return 0;
276 resolves_to = resolve_ref_unsafe(refname, 0, junk.hash, NULL);
277 if (!resolves_to
278 || (d->refname
279 ? strcmp(resolves_to, d->refname)
280 : !string_list_has_string(d->refnames, resolves_to))) {
281 return 0;
284 fprintf(d->fp, d->msg_fmt, refname);
285 fputc('\n', d->fp);
286 return 0;
289 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
291 struct warn_if_dangling_data data;
293 data.fp = fp;
294 data.refname = refname;
295 data.refnames = NULL;
296 data.msg_fmt = msg_fmt;
297 for_each_rawref(warn_if_dangling_symref, &data);
300 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
302 struct warn_if_dangling_data data;
304 data.fp = fp;
305 data.refname = NULL;
306 data.refnames = refnames;
307 data.msg_fmt = msg_fmt;
308 for_each_rawref(warn_if_dangling_symref, &data);
311 int refs_for_each_tag_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
313 return refs_for_each_ref_in(refs, "refs/tags/", fn, cb_data);
316 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
318 return refs_for_each_tag_ref(get_main_ref_store(), fn, cb_data);
321 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
323 return refs_for_each_tag_ref(get_submodule_ref_store(submodule),
324 fn, cb_data);
327 int refs_for_each_branch_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
329 return refs_for_each_ref_in(refs, "refs/heads/", fn, cb_data);
332 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
334 return refs_for_each_branch_ref(get_main_ref_store(), fn, cb_data);
337 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
339 return refs_for_each_branch_ref(get_submodule_ref_store(submodule),
340 fn, cb_data);
343 int refs_for_each_remote_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
345 return refs_for_each_ref_in(refs, "refs/remotes/", fn, cb_data);
348 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
350 return refs_for_each_remote_ref(get_main_ref_store(), fn, cb_data);
353 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
355 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
356 fn, cb_data);
359 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
361 struct strbuf buf = STRBUF_INIT;
362 int ret = 0;
363 struct object_id oid;
364 int flag;
366 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
367 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, oid.hash, &flag))
368 ret = fn(buf.buf, &oid, flag, cb_data);
369 strbuf_release(&buf);
371 return ret;
374 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
375 const char *prefix, void *cb_data)
377 struct strbuf real_pattern = STRBUF_INIT;
378 struct ref_filter filter;
379 int ret;
381 if (!prefix && !starts_with(pattern, "refs/"))
382 strbuf_addstr(&real_pattern, "refs/");
383 else if (prefix)
384 strbuf_addstr(&real_pattern, prefix);
385 strbuf_addstr(&real_pattern, pattern);
387 if (!has_glob_specials(pattern)) {
388 /* Append implied '/' '*' if not present. */
389 strbuf_complete(&real_pattern, '/');
390 /* No need to check for '*', there is none. */
391 strbuf_addch(&real_pattern, '*');
394 filter.pattern = real_pattern.buf;
395 filter.fn = fn;
396 filter.cb_data = cb_data;
397 ret = for_each_ref(filter_refs, &filter);
399 strbuf_release(&real_pattern);
400 return ret;
403 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
405 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
408 const char *prettify_refname(const char *name)
410 if (skip_prefix(name, "refs/heads/", &name) ||
411 skip_prefix(name, "refs/tags/", &name) ||
412 skip_prefix(name, "refs/remotes/", &name))
413 ; /* nothing */
414 return name;
417 static const char *ref_rev_parse_rules[] = {
418 "%.*s",
419 "refs/%.*s",
420 "refs/tags/%.*s",
421 "refs/heads/%.*s",
422 "refs/remotes/%.*s",
423 "refs/remotes/%.*s/HEAD",
424 NULL
427 int refname_match(const char *abbrev_name, const char *full_name)
429 const char **p;
430 const int abbrev_name_len = strlen(abbrev_name);
432 for (p = ref_rev_parse_rules; *p; p++) {
433 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
434 return 1;
438 return 0;
442 * *string and *len will only be substituted, and *string returned (for
443 * later free()ing) if the string passed in is a magic short-hand form
444 * to name a branch.
446 static char *substitute_branch_name(const char **string, int *len)
448 struct strbuf buf = STRBUF_INIT;
449 int ret = interpret_branch_name(*string, *len, &buf, 0);
451 if (ret == *len) {
452 size_t size;
453 *string = strbuf_detach(&buf, &size);
454 *len = size;
455 return (char *)*string;
458 return NULL;
461 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
463 char *last_branch = substitute_branch_name(&str, &len);
464 int refs_found = expand_ref(str, len, sha1, ref);
465 free(last_branch);
466 return refs_found;
469 int expand_ref(const char *str, int len, unsigned char *sha1, char **ref)
471 const char **p, *r;
472 int refs_found = 0;
473 struct strbuf fullref = STRBUF_INIT;
475 *ref = NULL;
476 for (p = ref_rev_parse_rules; *p; p++) {
477 unsigned char sha1_from_ref[20];
478 unsigned char *this_result;
479 int flag;
481 this_result = refs_found ? sha1_from_ref : sha1;
482 strbuf_reset(&fullref);
483 strbuf_addf(&fullref, *p, len, str);
484 r = resolve_ref_unsafe(fullref.buf, RESOLVE_REF_READING,
485 this_result, &flag);
486 if (r) {
487 if (!refs_found++)
488 *ref = xstrdup(r);
489 if (!warn_ambiguous_refs)
490 break;
491 } else if ((flag & REF_ISSYMREF) && strcmp(fullref.buf, "HEAD")) {
492 warning("ignoring dangling symref %s.", fullref.buf);
493 } else if ((flag & REF_ISBROKEN) && strchr(fullref.buf, '/')) {
494 warning("ignoring broken ref %s.", fullref.buf);
497 strbuf_release(&fullref);
498 return refs_found;
501 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
503 char *last_branch = substitute_branch_name(&str, &len);
504 const char **p;
505 int logs_found = 0;
506 struct strbuf path = STRBUF_INIT;
508 *log = NULL;
509 for (p = ref_rev_parse_rules; *p; p++) {
510 unsigned char hash[20];
511 const char *ref, *it;
513 strbuf_reset(&path);
514 strbuf_addf(&path, *p, len, str);
515 ref = resolve_ref_unsafe(path.buf, RESOLVE_REF_READING,
516 hash, NULL);
517 if (!ref)
518 continue;
519 if (reflog_exists(path.buf))
520 it = path.buf;
521 else if (strcmp(ref, path.buf) && reflog_exists(ref))
522 it = ref;
523 else
524 continue;
525 if (!logs_found++) {
526 *log = xstrdup(it);
527 hashcpy(sha1, hash);
529 if (!warn_ambiguous_refs)
530 break;
532 strbuf_release(&path);
533 free(last_branch);
534 return logs_found;
537 static int is_per_worktree_ref(const char *refname)
539 return !strcmp(refname, "HEAD") ||
540 starts_with(refname, "refs/bisect/");
543 static int is_pseudoref_syntax(const char *refname)
545 const char *c;
547 for (c = refname; *c; c++) {
548 if (!isupper(*c) && *c != '-' && *c != '_')
549 return 0;
552 return 1;
555 enum ref_type ref_type(const char *refname)
557 if (is_per_worktree_ref(refname))
558 return REF_TYPE_PER_WORKTREE;
559 if (is_pseudoref_syntax(refname))
560 return REF_TYPE_PSEUDOREF;
561 return REF_TYPE_NORMAL;
564 static int write_pseudoref(const char *pseudoref, const unsigned char *sha1,
565 const unsigned char *old_sha1, struct strbuf *err)
567 const char *filename;
568 int fd;
569 static struct lock_file lock;
570 struct strbuf buf = STRBUF_INIT;
571 int ret = -1;
573 strbuf_addf(&buf, "%s\n", sha1_to_hex(sha1));
575 filename = git_path("%s", pseudoref);
576 fd = hold_lock_file_for_update(&lock, filename, LOCK_DIE_ON_ERROR);
577 if (fd < 0) {
578 strbuf_addf(err, "could not open '%s' for writing: %s",
579 filename, strerror(errno));
580 return -1;
583 if (old_sha1) {
584 unsigned char actual_old_sha1[20];
586 if (read_ref(pseudoref, actual_old_sha1))
587 die("could not read ref '%s'", pseudoref);
588 if (hashcmp(actual_old_sha1, old_sha1)) {
589 strbuf_addf(err, "unexpected sha1 when writing '%s'", pseudoref);
590 rollback_lock_file(&lock);
591 goto done;
595 if (write_in_full(fd, buf.buf, buf.len) != buf.len) {
596 strbuf_addf(err, "could not write to '%s'", filename);
597 rollback_lock_file(&lock);
598 goto done;
601 commit_lock_file(&lock);
602 ret = 0;
603 done:
604 strbuf_release(&buf);
605 return ret;
608 static int delete_pseudoref(const char *pseudoref, const unsigned char *old_sha1)
610 static struct lock_file lock;
611 const char *filename;
613 filename = git_path("%s", pseudoref);
615 if (old_sha1 && !is_null_sha1(old_sha1)) {
616 int fd;
617 unsigned char actual_old_sha1[20];
619 fd = hold_lock_file_for_update(&lock, filename,
620 LOCK_DIE_ON_ERROR);
621 if (fd < 0)
622 die_errno(_("Could not open '%s' for writing"), filename);
623 if (read_ref(pseudoref, actual_old_sha1))
624 die("could not read ref '%s'", pseudoref);
625 if (hashcmp(actual_old_sha1, old_sha1)) {
626 warning("Unexpected sha1 when deleting %s", pseudoref);
627 rollback_lock_file(&lock);
628 return -1;
631 unlink(filename);
632 rollback_lock_file(&lock);
633 } else {
634 unlink(filename);
637 return 0;
640 int refs_delete_ref(struct ref_store *refs, const char *msg,
641 const char *refname,
642 const unsigned char *old_sha1,
643 unsigned int flags)
645 struct ref_transaction *transaction;
646 struct strbuf err = STRBUF_INIT;
648 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
649 assert(refs == get_main_ref_store());
650 return delete_pseudoref(refname, old_sha1);
653 transaction = ref_store_transaction_begin(refs, &err);
654 if (!transaction ||
655 ref_transaction_delete(transaction, refname, old_sha1,
656 flags, msg, &err) ||
657 ref_transaction_commit(transaction, &err)) {
658 error("%s", err.buf);
659 ref_transaction_free(transaction);
660 strbuf_release(&err);
661 return 1;
663 ref_transaction_free(transaction);
664 strbuf_release(&err);
665 return 0;
668 int delete_ref(const char *msg, const char *refname,
669 const unsigned char *old_sha1, unsigned int flags)
671 return refs_delete_ref(get_main_ref_store(), msg, refname,
672 old_sha1, flags);
675 int copy_reflog_msg(char *buf, const char *msg)
677 char *cp = buf;
678 char c;
679 int wasspace = 1;
681 *cp++ = '\t';
682 while ((c = *msg++)) {
683 if (wasspace && isspace(c))
684 continue;
685 wasspace = isspace(c);
686 if (wasspace)
687 c = ' ';
688 *cp++ = c;
690 while (buf < cp && isspace(cp[-1]))
691 cp--;
692 *cp++ = '\n';
693 return cp - buf;
696 int should_autocreate_reflog(const char *refname)
698 switch (log_all_ref_updates) {
699 case LOG_REFS_ALWAYS:
700 return 1;
701 case LOG_REFS_NORMAL:
702 return starts_with(refname, "refs/heads/") ||
703 starts_with(refname, "refs/remotes/") ||
704 starts_with(refname, "refs/notes/") ||
705 !strcmp(refname, "HEAD");
706 default:
707 return 0;
711 int is_branch(const char *refname)
713 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
716 struct read_ref_at_cb {
717 const char *refname;
718 timestamp_t at_time;
719 int cnt;
720 int reccnt;
721 unsigned char *sha1;
722 int found_it;
724 unsigned char osha1[20];
725 unsigned char nsha1[20];
726 int tz;
727 timestamp_t date;
728 char **msg;
729 timestamp_t *cutoff_time;
730 int *cutoff_tz;
731 int *cutoff_cnt;
734 static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
735 const char *email, timestamp_t timestamp, int tz,
736 const char *message, void *cb_data)
738 struct read_ref_at_cb *cb = cb_data;
740 cb->reccnt++;
741 cb->tz = tz;
742 cb->date = timestamp;
744 if (timestamp <= cb->at_time || cb->cnt == 0) {
745 if (cb->msg)
746 *cb->msg = xstrdup(message);
747 if (cb->cutoff_time)
748 *cb->cutoff_time = timestamp;
749 if (cb->cutoff_tz)
750 *cb->cutoff_tz = tz;
751 if (cb->cutoff_cnt)
752 *cb->cutoff_cnt = cb->reccnt - 1;
754 * we have not yet updated cb->[n|o]sha1 so they still
755 * hold the values for the previous record.
757 if (!is_null_sha1(cb->osha1)) {
758 hashcpy(cb->sha1, noid->hash);
759 if (hashcmp(cb->osha1, noid->hash))
760 warning("Log for ref %s has gap after %s.",
761 cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
763 else if (cb->date == cb->at_time)
764 hashcpy(cb->sha1, noid->hash);
765 else if (hashcmp(noid->hash, cb->sha1))
766 warning("Log for ref %s unexpectedly ended on %s.",
767 cb->refname, show_date(cb->date, cb->tz,
768 DATE_MODE(RFC2822)));
769 hashcpy(cb->osha1, ooid->hash);
770 hashcpy(cb->nsha1, noid->hash);
771 cb->found_it = 1;
772 return 1;
774 hashcpy(cb->osha1, ooid->hash);
775 hashcpy(cb->nsha1, noid->hash);
776 if (cb->cnt > 0)
777 cb->cnt--;
778 return 0;
781 static int read_ref_at_ent_oldest(struct object_id *ooid, struct object_id *noid,
782 const char *email, timestamp_t timestamp,
783 int tz, const char *message, void *cb_data)
785 struct read_ref_at_cb *cb = cb_data;
787 if (cb->msg)
788 *cb->msg = xstrdup(message);
789 if (cb->cutoff_time)
790 *cb->cutoff_time = timestamp;
791 if (cb->cutoff_tz)
792 *cb->cutoff_tz = tz;
793 if (cb->cutoff_cnt)
794 *cb->cutoff_cnt = cb->reccnt;
795 hashcpy(cb->sha1, ooid->hash);
796 if (is_null_sha1(cb->sha1))
797 hashcpy(cb->sha1, noid->hash);
798 /* We just want the first entry */
799 return 1;
802 int read_ref_at(const char *refname, unsigned int flags, timestamp_t at_time, int cnt,
803 unsigned char *sha1, char **msg,
804 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
806 struct read_ref_at_cb cb;
808 memset(&cb, 0, sizeof(cb));
809 cb.refname = refname;
810 cb.at_time = at_time;
811 cb.cnt = cnt;
812 cb.msg = msg;
813 cb.cutoff_time = cutoff_time;
814 cb.cutoff_tz = cutoff_tz;
815 cb.cutoff_cnt = cutoff_cnt;
816 cb.sha1 = sha1;
818 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
820 if (!cb.reccnt) {
821 if (flags & GET_SHA1_QUIETLY)
822 exit(128);
823 else
824 die("Log for %s is empty.", refname);
826 if (cb.found_it)
827 return 0;
829 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
831 return 1;
834 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
835 struct strbuf *err)
837 struct ref_transaction *tr;
838 assert(err);
840 tr = xcalloc(1, sizeof(struct ref_transaction));
841 tr->ref_store = refs;
842 return tr;
845 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
847 return ref_store_transaction_begin(get_main_ref_store(), err);
850 void ref_transaction_free(struct ref_transaction *transaction)
852 size_t i;
854 if (!transaction)
855 return;
857 switch (transaction->state) {
858 case REF_TRANSACTION_OPEN:
859 case REF_TRANSACTION_CLOSED:
860 /* OK */
861 break;
862 case REF_TRANSACTION_PREPARED:
863 die("BUG: free called on a prepared reference transaction");
864 break;
865 default:
866 die("BUG: unexpected reference transaction state");
867 break;
870 for (i = 0; i < transaction->nr; i++) {
871 free(transaction->updates[i]->msg);
872 free(transaction->updates[i]);
874 free(transaction->updates);
875 free(transaction);
878 struct ref_update *ref_transaction_add_update(
879 struct ref_transaction *transaction,
880 const char *refname, unsigned int flags,
881 const unsigned char *new_sha1,
882 const unsigned char *old_sha1,
883 const char *msg)
885 struct ref_update *update;
887 if (transaction->state != REF_TRANSACTION_OPEN)
888 die("BUG: update called for transaction that is not open");
890 if ((flags & REF_ISPRUNING) && !(flags & REF_NODEREF))
891 die("BUG: REF_ISPRUNING set without REF_NODEREF");
893 FLEX_ALLOC_STR(update, refname, refname);
894 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
895 transaction->updates[transaction->nr++] = update;
897 update->flags = flags;
899 if (flags & REF_HAVE_NEW)
900 hashcpy(update->new_oid.hash, new_sha1);
901 if (flags & REF_HAVE_OLD)
902 hashcpy(update->old_oid.hash, old_sha1);
903 update->msg = xstrdup_or_null(msg);
904 return update;
907 int ref_transaction_update(struct ref_transaction *transaction,
908 const char *refname,
909 const unsigned char *new_sha1,
910 const unsigned char *old_sha1,
911 unsigned int flags, const char *msg,
912 struct strbuf *err)
914 assert(err);
916 if ((new_sha1 && !is_null_sha1(new_sha1)) ?
917 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL) :
918 !refname_is_safe(refname)) {
919 strbuf_addf(err, "refusing to update ref with bad name '%s'",
920 refname);
921 return -1;
924 flags |= (new_sha1 ? REF_HAVE_NEW : 0) | (old_sha1 ? REF_HAVE_OLD : 0);
926 ref_transaction_add_update(transaction, refname, flags,
927 new_sha1, old_sha1, msg);
928 return 0;
931 int ref_transaction_create(struct ref_transaction *transaction,
932 const char *refname,
933 const unsigned char *new_sha1,
934 unsigned int flags, const char *msg,
935 struct strbuf *err)
937 if (!new_sha1 || is_null_sha1(new_sha1))
938 die("BUG: create called without valid new_sha1");
939 return ref_transaction_update(transaction, refname, new_sha1,
940 null_sha1, flags, msg, err);
943 int ref_transaction_delete(struct ref_transaction *transaction,
944 const char *refname,
945 const unsigned char *old_sha1,
946 unsigned int flags, const char *msg,
947 struct strbuf *err)
949 if (old_sha1 && is_null_sha1(old_sha1))
950 die("BUG: delete called with old_sha1 set to zeros");
951 return ref_transaction_update(transaction, refname,
952 null_sha1, old_sha1,
953 flags, msg, err);
956 int ref_transaction_verify(struct ref_transaction *transaction,
957 const char *refname,
958 const unsigned char *old_sha1,
959 unsigned int flags,
960 struct strbuf *err)
962 if (!old_sha1)
963 die("BUG: verify called with old_sha1 set to NULL");
964 return ref_transaction_update(transaction, refname,
965 NULL, old_sha1,
966 flags, NULL, err);
969 int update_ref_oid(const char *msg, const char *refname,
970 const struct object_id *new_oid, const struct object_id *old_oid,
971 unsigned int flags, enum action_on_err onerr)
973 return update_ref(msg, refname, new_oid ? new_oid->hash : NULL,
974 old_oid ? old_oid->hash : NULL, flags, onerr);
977 int refs_update_ref(struct ref_store *refs, const char *msg,
978 const char *refname, const unsigned char *new_sha1,
979 const unsigned char *old_sha1, unsigned int flags,
980 enum action_on_err onerr)
982 struct ref_transaction *t = NULL;
983 struct strbuf err = STRBUF_INIT;
984 int ret = 0;
986 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
987 assert(refs == get_main_ref_store());
988 ret = write_pseudoref(refname, new_sha1, old_sha1, &err);
989 } else {
990 t = ref_store_transaction_begin(refs, &err);
991 if (!t ||
992 ref_transaction_update(t, refname, new_sha1, old_sha1,
993 flags, msg, &err) ||
994 ref_transaction_commit(t, &err)) {
995 ret = 1;
996 ref_transaction_free(t);
999 if (ret) {
1000 const char *str = "update_ref failed for ref '%s': %s";
1002 switch (onerr) {
1003 case UPDATE_REFS_MSG_ON_ERR:
1004 error(str, refname, err.buf);
1005 break;
1006 case UPDATE_REFS_DIE_ON_ERR:
1007 die(str, refname, err.buf);
1008 break;
1009 case UPDATE_REFS_QUIET_ON_ERR:
1010 break;
1012 strbuf_release(&err);
1013 return 1;
1015 strbuf_release(&err);
1016 if (t)
1017 ref_transaction_free(t);
1018 return 0;
1021 int update_ref(const char *msg, const char *refname,
1022 const unsigned char *new_sha1,
1023 const unsigned char *old_sha1,
1024 unsigned int flags, enum action_on_err onerr)
1026 return refs_update_ref(get_main_ref_store(), msg, refname, new_sha1,
1027 old_sha1, flags, onerr);
1030 char *shorten_unambiguous_ref(const char *refname, int strict)
1032 int i;
1033 static char **scanf_fmts;
1034 static int nr_rules;
1035 char *short_name;
1036 struct strbuf resolved_buf = STRBUF_INIT;
1038 if (!nr_rules) {
1040 * Pre-generate scanf formats from ref_rev_parse_rules[].
1041 * Generate a format suitable for scanf from a
1042 * ref_rev_parse_rules rule by interpolating "%s" at the
1043 * location of the "%.*s".
1045 size_t total_len = 0;
1046 size_t offset = 0;
1048 /* the rule list is NULL terminated, count them first */
1049 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
1050 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1051 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
1053 scanf_fmts = xmalloc(st_add(st_mult(sizeof(char *), nr_rules), total_len));
1055 offset = 0;
1056 for (i = 0; i < nr_rules; i++) {
1057 assert(offset < total_len);
1058 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
1059 offset += snprintf(scanf_fmts[i], total_len - offset,
1060 ref_rev_parse_rules[i], 2, "%s") + 1;
1064 /* bail out if there are no rules */
1065 if (!nr_rules)
1066 return xstrdup(refname);
1068 /* buffer for scanf result, at most refname must fit */
1069 short_name = xstrdup(refname);
1071 /* skip first rule, it will always match */
1072 for (i = nr_rules - 1; i > 0 ; --i) {
1073 int j;
1074 int rules_to_fail = i;
1075 int short_name_len;
1077 if (1 != sscanf(refname, scanf_fmts[i], short_name))
1078 continue;
1080 short_name_len = strlen(short_name);
1083 * in strict mode, all (except the matched one) rules
1084 * must fail to resolve to a valid non-ambiguous ref
1086 if (strict)
1087 rules_to_fail = nr_rules;
1090 * check if the short name resolves to a valid ref,
1091 * but use only rules prior to the matched one
1093 for (j = 0; j < rules_to_fail; j++) {
1094 const char *rule = ref_rev_parse_rules[j];
1096 /* skip matched rule */
1097 if (i == j)
1098 continue;
1101 * the short name is ambiguous, if it resolves
1102 * (with this previous rule) to a valid ref
1103 * read_ref() returns 0 on success
1105 strbuf_reset(&resolved_buf);
1106 strbuf_addf(&resolved_buf, rule,
1107 short_name_len, short_name);
1108 if (ref_exists(resolved_buf.buf))
1109 break;
1113 * short name is non-ambiguous if all previous rules
1114 * haven't resolved to a valid ref
1116 if (j == rules_to_fail) {
1117 strbuf_release(&resolved_buf);
1118 return short_name;
1122 strbuf_release(&resolved_buf);
1123 free(short_name);
1124 return xstrdup(refname);
1127 static struct string_list *hide_refs;
1129 int parse_hide_refs_config(const char *var, const char *value, const char *section)
1131 const char *key;
1132 if (!strcmp("transfer.hiderefs", var) ||
1133 (!parse_config_key(var, section, NULL, NULL, &key) &&
1134 !strcmp(key, "hiderefs"))) {
1135 char *ref;
1136 int len;
1138 if (!value)
1139 return config_error_nonbool(var);
1140 ref = xstrdup(value);
1141 len = strlen(ref);
1142 while (len && ref[len - 1] == '/')
1143 ref[--len] = '\0';
1144 if (!hide_refs) {
1145 hide_refs = xcalloc(1, sizeof(*hide_refs));
1146 hide_refs->strdup_strings = 1;
1148 string_list_append(hide_refs, ref);
1150 return 0;
1153 int ref_is_hidden(const char *refname, const char *refname_full)
1155 int i;
1157 if (!hide_refs)
1158 return 0;
1159 for (i = hide_refs->nr - 1; i >= 0; i--) {
1160 const char *match = hide_refs->items[i].string;
1161 const char *subject;
1162 int neg = 0;
1163 int len;
1165 if (*match == '!') {
1166 neg = 1;
1167 match++;
1170 if (*match == '^') {
1171 subject = refname_full;
1172 match++;
1173 } else {
1174 subject = refname;
1177 /* refname can be NULL when namespaces are used. */
1178 if (!subject || !starts_with(subject, match))
1179 continue;
1180 len = strlen(match);
1181 if (!subject[len] || subject[len] == '/')
1182 return !neg;
1184 return 0;
1187 const char *find_descendant_ref(const char *dirname,
1188 const struct string_list *extras,
1189 const struct string_list *skip)
1191 int pos;
1193 if (!extras)
1194 return NULL;
1197 * Look at the place where dirname would be inserted into
1198 * extras. If there is an entry at that position that starts
1199 * with dirname (remember, dirname includes the trailing
1200 * slash) and is not in skip, then we have a conflict.
1202 for (pos = string_list_find_insert_index(extras, dirname, 0);
1203 pos < extras->nr; pos++) {
1204 const char *extra_refname = extras->items[pos].string;
1206 if (!starts_with(extra_refname, dirname))
1207 break;
1209 if (!skip || !string_list_has_string(skip, extra_refname))
1210 return extra_refname;
1212 return NULL;
1215 int refs_rename_ref_available(struct ref_store *refs,
1216 const char *old_refname,
1217 const char *new_refname)
1219 struct string_list skip = STRING_LIST_INIT_NODUP;
1220 struct strbuf err = STRBUF_INIT;
1221 int ok;
1223 string_list_insert(&skip, old_refname);
1224 ok = !refs_verify_refname_available(refs, new_refname,
1225 NULL, &skip, &err);
1226 if (!ok)
1227 error("%s", err.buf);
1229 string_list_clear(&skip, 0);
1230 strbuf_release(&err);
1231 return ok;
1234 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1236 struct object_id oid;
1237 int flag;
1239 if (submodule) {
1240 if (resolve_gitlink_ref(submodule, "HEAD", oid.hash) == 0)
1241 return fn("HEAD", &oid, 0, cb_data);
1243 return 0;
1246 if (!read_ref_full("HEAD", RESOLVE_REF_READING, oid.hash, &flag))
1247 return fn("HEAD", &oid, flag, cb_data);
1249 return 0;
1252 int head_ref(each_ref_fn fn, void *cb_data)
1254 return head_ref_submodule(NULL, fn, cb_data);
1257 struct ref_iterator *refs_ref_iterator_begin(
1258 struct ref_store *refs,
1259 const char *prefix, int trim, int flags)
1261 struct ref_iterator *iter;
1263 if (ref_paranoia < 0)
1264 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
1265 if (ref_paranoia)
1266 flags |= DO_FOR_EACH_INCLUDE_BROKEN;
1268 iter = refs->be->iterator_begin(refs, prefix, flags);
1271 * `iterator_begin()` already takes care of prefix, but we
1272 * might need to do some trimming:
1274 if (trim)
1275 iter = prefix_ref_iterator_begin(iter, "", trim);
1277 return iter;
1281 * Call fn for each reference in the specified submodule for which the
1282 * refname begins with prefix. If trim is non-zero, then trim that
1283 * many characters off the beginning of each refname before passing
1284 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1285 * include broken references in the iteration. If fn ever returns a
1286 * non-zero value, stop the iteration and return that value;
1287 * otherwise, return 0.
1289 static int do_for_each_ref(struct ref_store *refs, const char *prefix,
1290 each_ref_fn fn, int trim, int flags, void *cb_data)
1292 struct ref_iterator *iter;
1294 if (!refs)
1295 return 0;
1297 iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1299 return do_for_each_ref_iterator(iter, fn, cb_data);
1302 int refs_for_each_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1304 return do_for_each_ref(refs, "", fn, 0, 0, cb_data);
1307 int for_each_ref(each_ref_fn fn, void *cb_data)
1309 return refs_for_each_ref(get_main_ref_store(), fn, cb_data);
1312 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1314 return refs_for_each_ref(get_submodule_ref_store(submodule), fn, cb_data);
1317 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
1318 each_ref_fn fn, void *cb_data)
1320 return do_for_each_ref(refs, prefix, fn, strlen(prefix), 0, cb_data);
1323 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1325 return refs_for_each_ref_in(get_main_ref_store(), prefix, fn, cb_data);
1328 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken)
1330 unsigned int flag = 0;
1332 if (broken)
1333 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1334 return do_for_each_ref(get_main_ref_store(),
1335 prefix, fn, 0, flag, cb_data);
1338 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1339 each_ref_fn fn, void *cb_data)
1341 return refs_for_each_ref_in(get_submodule_ref_store(submodule),
1342 prefix, fn, cb_data);
1345 int for_each_fullref_in_submodule(const char *submodule, const char *prefix,
1346 each_ref_fn fn, void *cb_data,
1347 unsigned int broken)
1349 unsigned int flag = 0;
1351 if (broken)
1352 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1353 return do_for_each_ref(get_submodule_ref_store(submodule),
1354 prefix, fn, 0, flag, cb_data);
1357 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1359 return do_for_each_ref(get_main_ref_store(),
1360 git_replace_ref_base, fn,
1361 strlen(git_replace_ref_base),
1362 0, cb_data);
1365 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1367 struct strbuf buf = STRBUF_INIT;
1368 int ret;
1369 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1370 ret = do_for_each_ref(get_main_ref_store(),
1371 buf.buf, fn, 0, 0, cb_data);
1372 strbuf_release(&buf);
1373 return ret;
1376 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1378 return do_for_each_ref(refs, "", fn, 0,
1379 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1382 int for_each_rawref(each_ref_fn fn, void *cb_data)
1384 return refs_for_each_rawref(get_main_ref_store(), fn, cb_data);
1387 int refs_read_raw_ref(struct ref_store *ref_store,
1388 const char *refname, unsigned char *sha1,
1389 struct strbuf *referent, unsigned int *type)
1391 return ref_store->be->read_raw_ref(ref_store, refname, sha1, referent, type);
1394 /* This function needs to return a meaningful errno on failure */
1395 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
1396 const char *refname,
1397 int resolve_flags,
1398 unsigned char *sha1, int *flags)
1400 static struct strbuf sb_refname = STRBUF_INIT;
1401 int unused_flags;
1402 int symref_count;
1404 if (!flags)
1405 flags = &unused_flags;
1407 *flags = 0;
1409 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1410 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1411 !refname_is_safe(refname)) {
1412 errno = EINVAL;
1413 return NULL;
1417 * dwim_ref() uses REF_ISBROKEN to distinguish between
1418 * missing refs and refs that were present but invalid,
1419 * to complain about the latter to stderr.
1421 * We don't know whether the ref exists, so don't set
1422 * REF_ISBROKEN yet.
1424 *flags |= REF_BAD_NAME;
1427 for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
1428 unsigned int read_flags = 0;
1430 if (refs_read_raw_ref(refs, refname,
1431 sha1, &sb_refname, &read_flags)) {
1432 *flags |= read_flags;
1433 if (errno != ENOENT || (resolve_flags & RESOLVE_REF_READING))
1434 return NULL;
1435 hashclr(sha1);
1436 if (*flags & REF_BAD_NAME)
1437 *flags |= REF_ISBROKEN;
1438 return refname;
1441 *flags |= read_flags;
1443 if (!(read_flags & REF_ISSYMREF)) {
1444 if (*flags & REF_BAD_NAME) {
1445 hashclr(sha1);
1446 *flags |= REF_ISBROKEN;
1448 return refname;
1451 refname = sb_refname.buf;
1452 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1453 hashclr(sha1);
1454 return refname;
1456 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1457 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1458 !refname_is_safe(refname)) {
1459 errno = EINVAL;
1460 return NULL;
1463 *flags |= REF_ISBROKEN | REF_BAD_NAME;
1467 errno = ELOOP;
1468 return NULL;
1471 /* backend functions */
1472 int refs_init_db(struct strbuf *err)
1474 struct ref_store *refs = get_main_ref_store();
1476 return refs->be->init_db(refs, err);
1479 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1480 unsigned char *sha1, int *flags)
1482 return refs_resolve_ref_unsafe(get_main_ref_store(), refname,
1483 resolve_flags, sha1, flags);
1486 int resolve_gitlink_ref(const char *submodule, const char *refname,
1487 unsigned char *sha1)
1489 size_t len = strlen(submodule);
1490 struct ref_store *refs;
1491 int flags;
1493 while (len && submodule[len - 1] == '/')
1494 len--;
1496 if (!len)
1497 return -1;
1499 if (submodule[len]) {
1500 /* We need to strip off one or more trailing slashes */
1501 char *stripped = xmemdupz(submodule, len);
1503 refs = get_submodule_ref_store(stripped);
1504 free(stripped);
1505 } else {
1506 refs = get_submodule_ref_store(submodule);
1509 if (!refs)
1510 return -1;
1512 if (!refs_resolve_ref_unsafe(refs, refname, 0, sha1, &flags) ||
1513 is_null_sha1(sha1))
1514 return -1;
1515 return 0;
1518 struct ref_store_hash_entry
1520 struct hashmap_entry ent; /* must be the first member! */
1522 struct ref_store *refs;
1524 /* NUL-terminated identifier of the ref store: */
1525 char name[FLEX_ARRAY];
1528 static int ref_store_hash_cmp(const void *entry, const void *entry_or_key,
1529 const void *keydata)
1531 const struct ref_store_hash_entry *e1 = entry, *e2 = entry_or_key;
1532 const char *name = keydata ? keydata : e2->name;
1534 return strcmp(e1->name, name);
1537 static struct ref_store_hash_entry *alloc_ref_store_hash_entry(
1538 const char *name, struct ref_store *refs)
1540 struct ref_store_hash_entry *entry;
1542 FLEX_ALLOC_STR(entry, name, name);
1543 hashmap_entry_init(entry, strhash(name));
1544 entry->refs = refs;
1545 return entry;
1548 /* A pointer to the ref_store for the main repository: */
1549 static struct ref_store *main_ref_store;
1551 /* A hashmap of ref_stores, stored by submodule name: */
1552 static struct hashmap submodule_ref_stores;
1554 /* A hashmap of ref_stores, stored by worktree id: */
1555 static struct hashmap worktree_ref_stores;
1558 * Look up a ref store by name. If that ref_store hasn't been
1559 * registered yet, return NULL.
1561 static struct ref_store *lookup_ref_store_map(struct hashmap *map,
1562 const char *name)
1564 struct ref_store_hash_entry *entry;
1566 if (!map->tablesize)
1567 /* It's initialized on demand in register_ref_store(). */
1568 return NULL;
1570 entry = hashmap_get_from_hash(map, strhash(name), name);
1571 return entry ? entry->refs : NULL;
1575 * Create, record, and return a ref_store instance for the specified
1576 * gitdir.
1578 static struct ref_store *ref_store_init(const char *gitdir,
1579 unsigned int flags)
1581 const char *be_name = "files";
1582 struct ref_storage_be *be = find_ref_storage_backend(be_name);
1583 struct ref_store *refs;
1585 if (!be)
1586 die("BUG: reference backend %s is unknown", be_name);
1588 refs = be->init(gitdir, flags);
1589 return refs;
1592 struct ref_store *get_main_ref_store(void)
1594 if (main_ref_store)
1595 return main_ref_store;
1597 main_ref_store = ref_store_init(get_git_dir(), REF_STORE_ALL_CAPS);
1598 return main_ref_store;
1602 * Associate a ref store with a name. It is a fatal error to call this
1603 * function twice for the same name.
1605 static void register_ref_store_map(struct hashmap *map,
1606 const char *type,
1607 struct ref_store *refs,
1608 const char *name)
1610 if (!map->tablesize)
1611 hashmap_init(map, ref_store_hash_cmp, 0);
1613 if (hashmap_put(map, alloc_ref_store_hash_entry(name, refs)))
1614 die("BUG: %s ref_store '%s' initialized twice", type, name);
1617 struct ref_store *get_submodule_ref_store(const char *submodule)
1619 struct strbuf submodule_sb = STRBUF_INIT;
1620 struct ref_store *refs;
1621 int ret;
1623 if (!submodule || !*submodule) {
1625 * FIXME: This case is ideally not allowed. But that
1626 * can't happen until we clean up all the callers.
1628 return get_main_ref_store();
1631 refs = lookup_ref_store_map(&submodule_ref_stores, submodule);
1632 if (refs)
1633 return refs;
1635 strbuf_addstr(&submodule_sb, submodule);
1636 ret = is_nonbare_repository_dir(&submodule_sb);
1637 strbuf_release(&submodule_sb);
1638 if (!ret)
1639 return NULL;
1641 ret = submodule_to_gitdir(&submodule_sb, submodule);
1642 if (ret) {
1643 strbuf_release(&submodule_sb);
1644 return NULL;
1647 /* assume that add_submodule_odb() has been called */
1648 refs = ref_store_init(submodule_sb.buf,
1649 REF_STORE_READ | REF_STORE_ODB);
1650 register_ref_store_map(&submodule_ref_stores, "submodule",
1651 refs, submodule);
1653 strbuf_release(&submodule_sb);
1654 return refs;
1657 struct ref_store *get_worktree_ref_store(const struct worktree *wt)
1659 struct ref_store *refs;
1660 const char *id;
1662 if (wt->is_current)
1663 return get_main_ref_store();
1665 id = wt->id ? wt->id : "/";
1666 refs = lookup_ref_store_map(&worktree_ref_stores, id);
1667 if (refs)
1668 return refs;
1670 if (wt->id)
1671 refs = ref_store_init(git_common_path("worktrees/%s", wt->id),
1672 REF_STORE_ALL_CAPS);
1673 else
1674 refs = ref_store_init(get_git_common_dir(),
1675 REF_STORE_ALL_CAPS);
1677 if (refs)
1678 register_ref_store_map(&worktree_ref_stores, "worktree",
1679 refs, id);
1680 return refs;
1683 void base_ref_store_init(struct ref_store *refs,
1684 const struct ref_storage_be *be)
1686 refs->be = be;
1689 /* backend functions */
1690 int refs_pack_refs(struct ref_store *refs, unsigned int flags)
1692 return refs->be->pack_refs(refs, flags);
1695 int refs_peel_ref(struct ref_store *refs, const char *refname,
1696 unsigned char *sha1)
1698 return refs->be->peel_ref(refs, refname, sha1);
1701 int peel_ref(const char *refname, unsigned char *sha1)
1703 return refs_peel_ref(get_main_ref_store(), refname, sha1);
1706 int refs_create_symref(struct ref_store *refs,
1707 const char *ref_target,
1708 const char *refs_heads_master,
1709 const char *logmsg)
1711 return refs->be->create_symref(refs, ref_target,
1712 refs_heads_master,
1713 logmsg);
1716 int create_symref(const char *ref_target, const char *refs_heads_master,
1717 const char *logmsg)
1719 return refs_create_symref(get_main_ref_store(), ref_target,
1720 refs_heads_master, logmsg);
1723 int ref_update_reject_duplicates(struct string_list *refnames,
1724 struct strbuf *err)
1726 size_t i, n = refnames->nr;
1728 assert(err);
1730 for (i = 1; i < n; i++) {
1731 int cmp = strcmp(refnames->items[i - 1].string,
1732 refnames->items[i].string);
1734 if (!cmp) {
1735 strbuf_addf(err,
1736 "multiple updates for ref '%s' not allowed.",
1737 refnames->items[i].string);
1738 return 1;
1739 } else if (cmp > 0) {
1740 die("BUG: ref_update_reject_duplicates() received unsorted list");
1743 return 0;
1746 int ref_transaction_prepare(struct ref_transaction *transaction,
1747 struct strbuf *err)
1749 struct ref_store *refs = transaction->ref_store;
1751 switch (transaction->state) {
1752 case REF_TRANSACTION_OPEN:
1753 /* Good. */
1754 break;
1755 case REF_TRANSACTION_PREPARED:
1756 die("BUG: prepare called twice on reference transaction");
1757 break;
1758 case REF_TRANSACTION_CLOSED:
1759 die("BUG: prepare called on a closed reference transaction");
1760 break;
1761 default:
1762 die("BUG: unexpected reference transaction state");
1763 break;
1766 if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
1767 strbuf_addstr(err,
1768 _("ref updates forbidden inside quarantine environment"));
1769 return -1;
1772 return refs->be->transaction_prepare(refs, transaction, err);
1775 int ref_transaction_abort(struct ref_transaction *transaction,
1776 struct strbuf *err)
1778 struct ref_store *refs = transaction->ref_store;
1779 int ret = 0;
1781 switch (transaction->state) {
1782 case REF_TRANSACTION_OPEN:
1783 /* No need to abort explicitly. */
1784 break;
1785 case REF_TRANSACTION_PREPARED:
1786 ret = refs->be->transaction_abort(refs, transaction, err);
1787 break;
1788 case REF_TRANSACTION_CLOSED:
1789 die("BUG: abort called on a closed reference transaction");
1790 break;
1791 default:
1792 die("BUG: unexpected reference transaction state");
1793 break;
1796 ref_transaction_free(transaction);
1797 return ret;
1800 int ref_transaction_commit(struct ref_transaction *transaction,
1801 struct strbuf *err)
1803 struct ref_store *refs = transaction->ref_store;
1804 int ret;
1806 switch (transaction->state) {
1807 case REF_TRANSACTION_OPEN:
1808 /* Need to prepare first. */
1809 ret = ref_transaction_prepare(transaction, err);
1810 if (ret)
1811 return ret;
1812 break;
1813 case REF_TRANSACTION_PREPARED:
1814 /* Fall through to finish. */
1815 break;
1816 case REF_TRANSACTION_CLOSED:
1817 die("BUG: commit called on a closed reference transaction");
1818 break;
1819 default:
1820 die("BUG: unexpected reference transaction state");
1821 break;
1824 return refs->be->transaction_finish(refs, transaction, err);
1827 int refs_verify_refname_available(struct ref_store *refs,
1828 const char *refname,
1829 const struct string_list *extras,
1830 const struct string_list *skip,
1831 struct strbuf *err)
1833 const char *slash;
1834 const char *extra_refname;
1835 struct strbuf dirname = STRBUF_INIT;
1836 struct strbuf referent = STRBUF_INIT;
1837 struct object_id oid;
1838 unsigned int type;
1839 struct ref_iterator *iter;
1840 int ok;
1841 int ret = -1;
1844 * For the sake of comments in this function, suppose that
1845 * refname is "refs/foo/bar".
1848 assert(err);
1850 strbuf_grow(&dirname, strlen(refname) + 1);
1851 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
1852 /* Expand dirname to the new prefix, not including the trailing slash: */
1853 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);
1856 * We are still at a leading dir of the refname (e.g.,
1857 * "refs/foo"; if there is a reference with that name,
1858 * it is a conflict, *unless* it is in skip.
1860 if (skip && string_list_has_string(skip, dirname.buf))
1861 continue;
1863 if (!refs_read_raw_ref(refs, dirname.buf, oid.hash, &referent, &type)) {
1864 strbuf_addf(err, "'%s' exists; cannot create '%s'",
1865 dirname.buf, refname);
1866 goto cleanup;
1869 if (extras && string_list_has_string(extras, dirname.buf)) {
1870 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
1871 refname, dirname.buf);
1872 goto cleanup;
1877 * We are at the leaf of our refname (e.g., "refs/foo/bar").
1878 * There is no point in searching for a reference with that
1879 * name, because a refname isn't considered to conflict with
1880 * itself. But we still need to check for references whose
1881 * names are in the "refs/foo/bar/" namespace, because they
1882 * *do* conflict.
1884 strbuf_addstr(&dirname, refname + dirname.len);
1885 strbuf_addch(&dirname, '/');
1887 iter = refs_ref_iterator_begin(refs, dirname.buf, 0,
1888 DO_FOR_EACH_INCLUDE_BROKEN);
1889 while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
1890 if (skip &&
1891 string_list_has_string(skip, iter->refname))
1892 continue;
1894 strbuf_addf(err, "'%s' exists; cannot create '%s'",
1895 iter->refname, refname);
1896 ref_iterator_abort(iter);
1897 goto cleanup;
1900 if (ok != ITER_DONE)
1901 die("BUG: error while iterating over references");
1903 extra_refname = find_descendant_ref(dirname.buf, extras, skip);
1904 if (extra_refname)
1905 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
1906 refname, extra_refname);
1907 else
1908 ret = 0;
1910 cleanup:
1911 strbuf_release(&referent);
1912 strbuf_release(&dirname);
1913 return ret;
1916 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1918 struct ref_iterator *iter;
1920 iter = refs->be->reflog_iterator_begin(refs);
1922 return do_for_each_ref_iterator(iter, fn, cb_data);
1925 int for_each_reflog(each_ref_fn fn, void *cb_data)
1927 return refs_for_each_reflog(get_main_ref_store(), fn, cb_data);
1930 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
1931 const char *refname,
1932 each_reflog_ent_fn fn,
1933 void *cb_data)
1935 return refs->be->for_each_reflog_ent_reverse(refs, refname,
1936 fn, cb_data);
1939 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn,
1940 void *cb_data)
1942 return refs_for_each_reflog_ent_reverse(get_main_ref_store(),
1943 refname, fn, cb_data);
1946 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
1947 each_reflog_ent_fn fn, void *cb_data)
1949 return refs->be->for_each_reflog_ent(refs, refname, fn, cb_data);
1952 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn,
1953 void *cb_data)
1955 return refs_for_each_reflog_ent(get_main_ref_store(), refname,
1956 fn, cb_data);
1959 int refs_reflog_exists(struct ref_store *refs, const char *refname)
1961 return refs->be->reflog_exists(refs, refname);
1964 int reflog_exists(const char *refname)
1966 return refs_reflog_exists(get_main_ref_store(), refname);
1969 int refs_create_reflog(struct ref_store *refs, const char *refname,
1970 int force_create, struct strbuf *err)
1972 return refs->be->create_reflog(refs, refname, force_create, err);
1975 int safe_create_reflog(const char *refname, int force_create,
1976 struct strbuf *err)
1978 return refs_create_reflog(get_main_ref_store(), refname,
1979 force_create, err);
1982 int refs_delete_reflog(struct ref_store *refs, const char *refname)
1984 return refs->be->delete_reflog(refs, refname);
1987 int delete_reflog(const char *refname)
1989 return refs_delete_reflog(get_main_ref_store(), refname);
1992 int refs_reflog_expire(struct ref_store *refs,
1993 const char *refname, const unsigned char *sha1,
1994 unsigned int flags,
1995 reflog_expiry_prepare_fn prepare_fn,
1996 reflog_expiry_should_prune_fn should_prune_fn,
1997 reflog_expiry_cleanup_fn cleanup_fn,
1998 void *policy_cb_data)
2000 return refs->be->reflog_expire(refs, refname, sha1, flags,
2001 prepare_fn, should_prune_fn,
2002 cleanup_fn, policy_cb_data);
2005 int reflog_expire(const char *refname, const unsigned char *sha1,
2006 unsigned int flags,
2007 reflog_expiry_prepare_fn prepare_fn,
2008 reflog_expiry_should_prune_fn should_prune_fn,
2009 reflog_expiry_cleanup_fn cleanup_fn,
2010 void *policy_cb_data)
2012 return refs_reflog_expire(get_main_ref_store(),
2013 refname, sha1, flags,
2014 prepare_fn, should_prune_fn,
2015 cleanup_fn, policy_cb_data);
2018 int initial_ref_transaction_commit(struct ref_transaction *transaction,
2019 struct strbuf *err)
2021 struct ref_store *refs = transaction->ref_store;
2023 return refs->be->initial_transaction_commit(refs, transaction, err);
2026 int refs_delete_refs(struct ref_store *refs, const char *msg,
2027 struct string_list *refnames, unsigned int flags)
2029 return refs->be->delete_refs(refs, msg, refnames, flags);
2032 int delete_refs(const char *msg, struct string_list *refnames,
2033 unsigned int flags)
2035 return refs_delete_refs(get_main_ref_store(), msg, refnames, flags);
2038 int refs_rename_ref(struct ref_store *refs, const char *oldref,
2039 const char *newref, const char *logmsg)
2041 return refs->be->rename_ref(refs, oldref, newref, logmsg);
2044 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
2046 return refs_rename_ref(get_main_ref_store(), oldref, newref, logmsg);