commit-graph: not compatible with grafts
[git] / refs.c
1 /*
2  * The backend-independent part of the reference module.
3  */
4
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-store.h"
13 #include "object.h"
14 #include "tag.h"
15 #include "submodule.h"
16 #include "worktree.h"
17 #include "argv-array.h"
18 #include "repository.h"
19
20 /*
21  * List of all available backends
22  */
23 static struct ref_storage_be *refs_backends = &refs_be_files;
24
25 static struct ref_storage_be *find_ref_storage_backend(const char *name)
26 {
27         struct ref_storage_be *be;
28         for (be = refs_backends; be; be = be->next)
29                 if (!strcmp(be->name, name))
30                         return be;
31         return NULL;
32 }
33
34 int ref_storage_backend_exists(const char *name)
35 {
36         return find_ref_storage_backend(name) != NULL;
37 }
38
39 /*
40  * How to handle various characters in refnames:
41  * 0: An acceptable character for refs
42  * 1: End-of-component
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
48  */
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
58 };
59
60 /*
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:
65  *
66  * - any path component of it begins with ".", or
67  * - it has double dots "..", or
68  * - it has ASCII control characters, or
69  * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
70  * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
71  * - it ends with a "/", or
72  * - it ends with ".lock", or
73  * - it contains a "@{" portion
74  */
75 static int check_refname_component(const char *refname, int *flags)
76 {
77         const char *cp;
78         char last = '\0';
79
80         for (cp = refname; ; cp++) {
81                 int ch = *cp & 255;
82                 unsigned char disp = refname_disposition[ch];
83                 switch (disp) {
84                 case 1:
85                         goto out;
86                 case 2:
87                         if (last == '.')
88                                 return -1; /* Refname contains "..". */
89                         break;
90                 case 3:
91                         if (last == '@')
92                                 return -1; /* Refname contains "@{". */
93                         break;
94                 case 4:
95                         return -1;
96                 case 5:
97                         if (!(*flags & REFNAME_REFSPEC_PATTERN))
98                                 return -1; /* refspec can't be a pattern */
99
100                         /*
101                          * Unset the pattern flag so that we only accept
102                          * a single asterisk for one side of refspec.
103                          */
104                         *flags &= ~ REFNAME_REFSPEC_PATTERN;
105                         break;
106                 }
107                 last = ch;
108         }
109 out:
110         if (cp == refname)
111                 return 0; /* Component has zero length. */
112         if (refname[0] == '.')
113                 return -1; /* Component starts with '.'. */
114         if (cp - refname >= LOCK_SUFFIX_LEN &&
115             !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
116                 return -1; /* Refname ends with ".lock". */
117         return cp - refname;
118 }
119
120 int check_refname_format(const char *refname, int flags)
121 {
122         int component_len, component_count = 0;
123
124         if (!strcmp(refname, "@"))
125                 /* Refname is a single character '@'. */
126                 return -1;
127
128         while (1) {
129                 /* We are at the start of a path component. */
130                 component_len = check_refname_component(refname, &flags);
131                 if (component_len <= 0)
132                         return -1;
133
134                 component_count++;
135                 if (refname[component_len] == '\0')
136                         break;
137                 /* Skip to next component. */
138                 refname += component_len + 1;
139         }
140
141         if (refname[component_len - 1] == '.')
142                 return -1; /* Refname ends with '.'. */
143         if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
144                 return -1; /* Refname has only one component. */
145         return 0;
146 }
147
148 int refname_is_safe(const char *refname)
149 {
150         const char *rest;
151
152         if (skip_prefix(refname, "refs/", &rest)) {
153                 char *buf;
154                 int result;
155                 size_t restlen = strlen(rest);
156
157                 /* rest must not be empty, or start or end with "/" */
158                 if (!restlen || *rest == '/' || rest[restlen - 1] == '/')
159                         return 0;
160
161                 /*
162                  * Does the refname try to escape refs/?
163                  * For example: refs/foo/../bar is safe but refs/foo/../../bar
164                  * is not.
165                  */
166                 buf = xmallocz(restlen);
167                 result = !normalize_path_copy(buf, rest) && !strcmp(buf, rest);
168                 free(buf);
169                 return result;
170         }
171
172         do {
173                 if (!isupper(*refname) && *refname != '_')
174                         return 0;
175                 refname++;
176         } while (*refname);
177         return 1;
178 }
179
180 /*
181  * Return true if refname, which has the specified oid and flags, can
182  * be resolved to an object in the database. If the referred-to object
183  * does not exist, emit a warning and return false.
184  */
185 int ref_resolves_to_object(const char *refname,
186                            const struct object_id *oid,
187                            unsigned int flags)
188 {
189         if (flags & REF_ISBROKEN)
190                 return 0;
191         if (!has_sha1_file(oid->hash)) {
192                 error("%s does not point to a valid object!", refname);
193                 return 0;
194         }
195         return 1;
196 }
197
198 char *refs_resolve_refdup(struct ref_store *refs,
199                           const char *refname, int resolve_flags,
200                           struct object_id *oid, int *flags)
201 {
202         const char *result;
203
204         result = refs_resolve_ref_unsafe(refs, refname, resolve_flags,
205                                          oid, flags);
206         return xstrdup_or_null(result);
207 }
208
209 char *resolve_refdup(const char *refname, int resolve_flags,
210                      struct object_id *oid, int *flags)
211 {
212         return refs_resolve_refdup(get_main_ref_store(the_repository),
213                                    refname, resolve_flags,
214                                    oid, flags);
215 }
216
217 /* The argument to filter_refs */
218 struct ref_filter {
219         const char *pattern;
220         each_ref_fn *fn;
221         void *cb_data;
222 };
223
224 int refs_read_ref_full(struct ref_store *refs, const char *refname,
225                        int resolve_flags, struct object_id *oid, int *flags)
226 {
227         if (refs_resolve_ref_unsafe(refs, refname, resolve_flags, oid, flags))
228                 return 0;
229         return -1;
230 }
231
232 int read_ref_full(const char *refname, int resolve_flags, struct object_id *oid, int *flags)
233 {
234         return refs_read_ref_full(get_main_ref_store(the_repository), refname,
235                                   resolve_flags, oid, flags);
236 }
237
238 int read_ref(const char *refname, struct object_id *oid)
239 {
240         return read_ref_full(refname, RESOLVE_REF_READING, oid, NULL);
241 }
242
243 int ref_exists(const char *refname)
244 {
245         return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, NULL, NULL);
246 }
247
248 static int match_ref_pattern(const char *refname,
249                              const struct string_list_item *item)
250 {
251         int matched = 0;
252         if (item->util == NULL) {
253                 if (!wildmatch(item->string, refname, 0))
254                         matched = 1;
255         } else {
256                 const char *rest;
257                 if (skip_prefix(refname, item->string, &rest) &&
258                     (!*rest || *rest == '/'))
259                         matched = 1;
260         }
261         return matched;
262 }
263
264 int ref_filter_match(const char *refname,
265                      const struct string_list *include_patterns,
266                      const struct string_list *exclude_patterns)
267 {
268         struct string_list_item *item;
269
270         if (exclude_patterns && exclude_patterns->nr) {
271                 for_each_string_list_item(item, exclude_patterns) {
272                         if (match_ref_pattern(refname, item))
273                                 return 0;
274                 }
275         }
276
277         if (include_patterns && include_patterns->nr) {
278                 int found = 0;
279                 for_each_string_list_item(item, include_patterns) {
280                         if (match_ref_pattern(refname, item)) {
281                                 found = 1;
282                                 break;
283                         }
284                 }
285
286                 if (!found)
287                         return 0;
288         }
289         return 1;
290 }
291
292 static int filter_refs(const char *refname, const struct object_id *oid,
293                            int flags, void *data)
294 {
295         struct ref_filter *filter = (struct ref_filter *)data;
296
297         if (wildmatch(filter->pattern, refname, 0))
298                 return 0;
299         return filter->fn(refname, oid, flags, filter->cb_data);
300 }
301
302 enum peel_status peel_object(const struct object_id *name, struct object_id *oid)
303 {
304         struct object *o = lookup_unknown_object(name->hash);
305
306         if (o->type == OBJ_NONE) {
307                 int type = oid_object_info(the_repository, name, NULL);
308                 if (type < 0 || !object_as_type(the_repository, o, type, 0))
309                         return PEEL_INVALID;
310         }
311
312         if (o->type != OBJ_TAG)
313                 return PEEL_NON_TAG;
314
315         o = deref_tag_noverify(o);
316         if (!o)
317                 return PEEL_INVALID;
318
319         oidcpy(oid, &o->oid);
320         return PEEL_PEELED;
321 }
322
323 struct warn_if_dangling_data {
324         FILE *fp;
325         const char *refname;
326         const struct string_list *refnames;
327         const char *msg_fmt;
328 };
329
330 static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
331                                    int flags, void *cb_data)
332 {
333         struct warn_if_dangling_data *d = cb_data;
334         const char *resolves_to;
335
336         if (!(flags & REF_ISSYMREF))
337                 return 0;
338
339         resolves_to = resolve_ref_unsafe(refname, 0, NULL, NULL);
340         if (!resolves_to
341             || (d->refname
342                 ? strcmp(resolves_to, d->refname)
343                 : !string_list_has_string(d->refnames, resolves_to))) {
344                 return 0;
345         }
346
347         fprintf(d->fp, d->msg_fmt, refname);
348         fputc('\n', d->fp);
349         return 0;
350 }
351
352 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
353 {
354         struct warn_if_dangling_data data;
355
356         data.fp = fp;
357         data.refname = refname;
358         data.refnames = NULL;
359         data.msg_fmt = msg_fmt;
360         for_each_rawref(warn_if_dangling_symref, &data);
361 }
362
363 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
364 {
365         struct warn_if_dangling_data data;
366
367         data.fp = fp;
368         data.refname = NULL;
369         data.refnames = refnames;
370         data.msg_fmt = msg_fmt;
371         for_each_rawref(warn_if_dangling_symref, &data);
372 }
373
374 int refs_for_each_tag_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
375 {
376         return refs_for_each_ref_in(refs, "refs/tags/", fn, cb_data);
377 }
378
379 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
380 {
381         return refs_for_each_tag_ref(get_main_ref_store(the_repository), fn, cb_data);
382 }
383
384 int refs_for_each_branch_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
385 {
386         return refs_for_each_ref_in(refs, "refs/heads/", fn, cb_data);
387 }
388
389 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
390 {
391         return refs_for_each_branch_ref(get_main_ref_store(the_repository), fn, cb_data);
392 }
393
394 int refs_for_each_remote_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
395 {
396         return refs_for_each_ref_in(refs, "refs/remotes/", fn, cb_data);
397 }
398
399 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
400 {
401         return refs_for_each_remote_ref(get_main_ref_store(the_repository), fn, cb_data);
402 }
403
404 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
405 {
406         struct strbuf buf = STRBUF_INIT;
407         int ret = 0;
408         struct object_id oid;
409         int flag;
410
411         strbuf_addf(&buf, "%sHEAD", get_git_namespace());
412         if (!read_ref_full(buf.buf, RESOLVE_REF_READING, &oid, &flag))
413                 ret = fn(buf.buf, &oid, flag, cb_data);
414         strbuf_release(&buf);
415
416         return ret;
417 }
418
419 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
420                         const char *pattern)
421 {
422         struct strbuf normalized_pattern = STRBUF_INIT;
423
424         if (*pattern == '/')
425                 BUG("pattern must not start with '/'");
426
427         if (prefix) {
428                 strbuf_addstr(&normalized_pattern, prefix);
429         }
430         else if (!starts_with(pattern, "refs/"))
431                 strbuf_addstr(&normalized_pattern, "refs/");
432         strbuf_addstr(&normalized_pattern, pattern);
433         strbuf_strip_suffix(&normalized_pattern, "/");
434
435         item->string = strbuf_detach(&normalized_pattern, NULL);
436         item->util = has_glob_specials(pattern) ? NULL : item->string;
437         strbuf_release(&normalized_pattern);
438 }
439
440 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
441         const char *prefix, void *cb_data)
442 {
443         struct strbuf real_pattern = STRBUF_INIT;
444         struct ref_filter filter;
445         int ret;
446
447         if (!prefix && !starts_with(pattern, "refs/"))
448                 strbuf_addstr(&real_pattern, "refs/");
449         else if (prefix)
450                 strbuf_addstr(&real_pattern, prefix);
451         strbuf_addstr(&real_pattern, pattern);
452
453         if (!has_glob_specials(pattern)) {
454                 /* Append implied '/' '*' if not present. */
455                 strbuf_complete(&real_pattern, '/');
456                 /* No need to check for '*', there is none. */
457                 strbuf_addch(&real_pattern, '*');
458         }
459
460         filter.pattern = real_pattern.buf;
461         filter.fn = fn;
462         filter.cb_data = cb_data;
463         ret = for_each_ref(filter_refs, &filter);
464
465         strbuf_release(&real_pattern);
466         return ret;
467 }
468
469 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
470 {
471         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
472 }
473
474 const char *prettify_refname(const char *name)
475 {
476         if (skip_prefix(name, "refs/heads/", &name) ||
477             skip_prefix(name, "refs/tags/", &name) ||
478             skip_prefix(name, "refs/remotes/", &name))
479                 ; /* nothing */
480         return name;
481 }
482
483 static const char *ref_rev_parse_rules[] = {
484         "%.*s",
485         "refs/%.*s",
486         "refs/tags/%.*s",
487         "refs/heads/%.*s",
488         "refs/remotes/%.*s",
489         "refs/remotes/%.*s/HEAD",
490         NULL
491 };
492
493 int refname_match(const char *abbrev_name, const char *full_name)
494 {
495         const char **p;
496         const int abbrev_name_len = strlen(abbrev_name);
497
498         for (p = ref_rev_parse_rules; *p; p++) {
499                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
500                         return 1;
501                 }
502         }
503
504         return 0;
505 }
506
507 /*
508  * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
509  * the results to 'prefixes'
510  */
511 void expand_ref_prefix(struct argv_array *prefixes, const char *prefix)
512 {
513         const char **p;
514         int len = strlen(prefix);
515
516         for (p = ref_rev_parse_rules; *p; p++)
517                 argv_array_pushf(prefixes, *p, len, prefix);
518 }
519
520 /*
521  * *string and *len will only be substituted, and *string returned (for
522  * later free()ing) if the string passed in is a magic short-hand form
523  * to name a branch.
524  */
525 static char *substitute_branch_name(const char **string, int *len)
526 {
527         struct strbuf buf = STRBUF_INIT;
528         int ret = interpret_branch_name(*string, *len, &buf, 0);
529
530         if (ret == *len) {
531                 size_t size;
532                 *string = strbuf_detach(&buf, &size);
533                 *len = size;
534                 return (char *)*string;
535         }
536
537         return NULL;
538 }
539
540 int dwim_ref(const char *str, int len, struct object_id *oid, char **ref)
541 {
542         char *last_branch = substitute_branch_name(&str, &len);
543         int   refs_found  = expand_ref(str, len, oid, ref);
544         free(last_branch);
545         return refs_found;
546 }
547
548 int expand_ref(const char *str, int len, struct object_id *oid, char **ref)
549 {
550         const char **p, *r;
551         int refs_found = 0;
552         struct strbuf fullref = STRBUF_INIT;
553
554         *ref = NULL;
555         for (p = ref_rev_parse_rules; *p; p++) {
556                 struct object_id oid_from_ref;
557                 struct object_id *this_result;
558                 int flag;
559
560                 this_result = refs_found ? &oid_from_ref : oid;
561                 strbuf_reset(&fullref);
562                 strbuf_addf(&fullref, *p, len, str);
563                 r = resolve_ref_unsafe(fullref.buf, RESOLVE_REF_READING,
564                                        this_result, &flag);
565                 if (r) {
566                         if (!refs_found++)
567                                 *ref = xstrdup(r);
568                         if (!warn_ambiguous_refs)
569                                 break;
570                 } else if ((flag & REF_ISSYMREF) && strcmp(fullref.buf, "HEAD")) {
571                         warning("ignoring dangling symref %s.", fullref.buf);
572                 } else if ((flag & REF_ISBROKEN) && strchr(fullref.buf, '/')) {
573                         warning("ignoring broken ref %s.", fullref.buf);
574                 }
575         }
576         strbuf_release(&fullref);
577         return refs_found;
578 }
579
580 int dwim_log(const char *str, int len, struct object_id *oid, char **log)
581 {
582         char *last_branch = substitute_branch_name(&str, &len);
583         const char **p;
584         int logs_found = 0;
585         struct strbuf path = STRBUF_INIT;
586
587         *log = NULL;
588         for (p = ref_rev_parse_rules; *p; p++) {
589                 struct object_id hash;
590                 const char *ref, *it;
591
592                 strbuf_reset(&path);
593                 strbuf_addf(&path, *p, len, str);
594                 ref = resolve_ref_unsafe(path.buf, RESOLVE_REF_READING,
595                                          &hash, NULL);
596                 if (!ref)
597                         continue;
598                 if (reflog_exists(path.buf))
599                         it = path.buf;
600                 else if (strcmp(ref, path.buf) && reflog_exists(ref))
601                         it = ref;
602                 else
603                         continue;
604                 if (!logs_found++) {
605                         *log = xstrdup(it);
606                         oidcpy(oid, &hash);
607                 }
608                 if (!warn_ambiguous_refs)
609                         break;
610         }
611         strbuf_release(&path);
612         free(last_branch);
613         return logs_found;
614 }
615
616 static int is_per_worktree_ref(const char *refname)
617 {
618         return !strcmp(refname, "HEAD") ||
619                 starts_with(refname, "refs/bisect/") ||
620                 starts_with(refname, "refs/rewritten/");
621 }
622
623 static int is_pseudoref_syntax(const char *refname)
624 {
625         const char *c;
626
627         for (c = refname; *c; c++) {
628                 if (!isupper(*c) && *c != '-' && *c != '_')
629                         return 0;
630         }
631
632         return 1;
633 }
634
635 enum ref_type ref_type(const char *refname)
636 {
637         if (is_per_worktree_ref(refname))
638                 return REF_TYPE_PER_WORKTREE;
639         if (is_pseudoref_syntax(refname))
640                 return REF_TYPE_PSEUDOREF;
641        return REF_TYPE_NORMAL;
642 }
643
644 long get_files_ref_lock_timeout_ms(void)
645 {
646         static int configured = 0;
647
648         /* The default timeout is 100 ms: */
649         static int timeout_ms = 100;
650
651         if (!configured) {
652                 git_config_get_int("core.filesreflocktimeout", &timeout_ms);
653                 configured = 1;
654         }
655
656         return timeout_ms;
657 }
658
659 static int write_pseudoref(const char *pseudoref, const struct object_id *oid,
660                            const struct object_id *old_oid, struct strbuf *err)
661 {
662         const char *filename;
663         int fd;
664         struct lock_file lock = LOCK_INIT;
665         struct strbuf buf = STRBUF_INIT;
666         int ret = -1;
667
668         if (!oid)
669                 return 0;
670
671         strbuf_addf(&buf, "%s\n", oid_to_hex(oid));
672
673         filename = git_path("%s", pseudoref);
674         fd = hold_lock_file_for_update_timeout(&lock, filename, 0,
675                                                get_files_ref_lock_timeout_ms());
676         if (fd < 0) {
677                 strbuf_addf(err, "could not open '%s' for writing: %s",
678                             filename, strerror(errno));
679                 goto done;
680         }
681
682         if (old_oid) {
683                 struct object_id actual_old_oid;
684
685                 if (read_ref(pseudoref, &actual_old_oid)) {
686                         if (!is_null_oid(old_oid)) {
687                                 strbuf_addf(err, "could not read ref '%s'",
688                                             pseudoref);
689                                 rollback_lock_file(&lock);
690                                 goto done;
691                         }
692                 } else if (is_null_oid(old_oid)) {
693                         strbuf_addf(err, "ref '%s' already exists",
694                                     pseudoref);
695                         rollback_lock_file(&lock);
696                         goto done;
697                 } else if (oidcmp(&actual_old_oid, old_oid)) {
698                         strbuf_addf(err, "unexpected object ID when writing '%s'",
699                                     pseudoref);
700                         rollback_lock_file(&lock);
701                         goto done;
702                 }
703         }
704
705         if (write_in_full(fd, buf.buf, buf.len) < 0) {
706                 strbuf_addf(err, "could not write to '%s'", filename);
707                 rollback_lock_file(&lock);
708                 goto done;
709         }
710
711         commit_lock_file(&lock);
712         ret = 0;
713 done:
714         strbuf_release(&buf);
715         return ret;
716 }
717
718 static int delete_pseudoref(const char *pseudoref, const struct object_id *old_oid)
719 {
720         const char *filename;
721
722         filename = git_path("%s", pseudoref);
723
724         if (old_oid && !is_null_oid(old_oid)) {
725                 struct lock_file lock = LOCK_INIT;
726                 int fd;
727                 struct object_id actual_old_oid;
728
729                 fd = hold_lock_file_for_update_timeout(
730                                 &lock, filename, 0,
731                                 get_files_ref_lock_timeout_ms());
732                 if (fd < 0) {
733                         error_errno(_("could not open '%s' for writing"),
734                                     filename);
735                         return -1;
736                 }
737                 if (read_ref(pseudoref, &actual_old_oid))
738                         die("could not read ref '%s'", pseudoref);
739                 if (oidcmp(&actual_old_oid, old_oid)) {
740                         error("unexpected object ID when deleting '%s'",
741                               pseudoref);
742                         rollback_lock_file(&lock);
743                         return -1;
744                 }
745
746                 unlink(filename);
747                 rollback_lock_file(&lock);
748         } else {
749                 unlink(filename);
750         }
751
752         return 0;
753 }
754
755 int refs_delete_ref(struct ref_store *refs, const char *msg,
756                     const char *refname,
757                     const struct object_id *old_oid,
758                     unsigned int flags)
759 {
760         struct ref_transaction *transaction;
761         struct strbuf err = STRBUF_INIT;
762
763         if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
764                 assert(refs == get_main_ref_store(the_repository));
765                 return delete_pseudoref(refname, old_oid);
766         }
767
768         transaction = ref_store_transaction_begin(refs, &err);
769         if (!transaction ||
770             ref_transaction_delete(transaction, refname, old_oid,
771                                    flags, msg, &err) ||
772             ref_transaction_commit(transaction, &err)) {
773                 error("%s", err.buf);
774                 ref_transaction_free(transaction);
775                 strbuf_release(&err);
776                 return 1;
777         }
778         ref_transaction_free(transaction);
779         strbuf_release(&err);
780         return 0;
781 }
782
783 int delete_ref(const char *msg, const char *refname,
784                const struct object_id *old_oid, unsigned int flags)
785 {
786         return refs_delete_ref(get_main_ref_store(the_repository), msg, refname,
787                                old_oid, flags);
788 }
789
790 void copy_reflog_msg(struct strbuf *sb, const char *msg)
791 {
792         char c;
793         int wasspace = 1;
794
795         strbuf_addch(sb, '\t');
796         while ((c = *msg++)) {
797                 if (wasspace && isspace(c))
798                         continue;
799                 wasspace = isspace(c);
800                 if (wasspace)
801                         c = ' ';
802                 strbuf_addch(sb, c);
803         }
804         strbuf_rtrim(sb);
805 }
806
807 int should_autocreate_reflog(const char *refname)
808 {
809         switch (log_all_ref_updates) {
810         case LOG_REFS_ALWAYS:
811                 return 1;
812         case LOG_REFS_NORMAL:
813                 return starts_with(refname, "refs/heads/") ||
814                         starts_with(refname, "refs/remotes/") ||
815                         starts_with(refname, "refs/notes/") ||
816                         !strcmp(refname, "HEAD");
817         default:
818                 return 0;
819         }
820 }
821
822 int is_branch(const char *refname)
823 {
824         return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
825 }
826
827 struct read_ref_at_cb {
828         const char *refname;
829         timestamp_t at_time;
830         int cnt;
831         int reccnt;
832         struct object_id *oid;
833         int found_it;
834
835         struct object_id ooid;
836         struct object_id noid;
837         int tz;
838         timestamp_t date;
839         char **msg;
840         timestamp_t *cutoff_time;
841         int *cutoff_tz;
842         int *cutoff_cnt;
843 };
844
845 static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
846                 const char *email, timestamp_t timestamp, int tz,
847                 const char *message, void *cb_data)
848 {
849         struct read_ref_at_cb *cb = cb_data;
850
851         cb->reccnt++;
852         cb->tz = tz;
853         cb->date = timestamp;
854
855         if (timestamp <= cb->at_time || cb->cnt == 0) {
856                 if (cb->msg)
857                         *cb->msg = xstrdup(message);
858                 if (cb->cutoff_time)
859                         *cb->cutoff_time = timestamp;
860                 if (cb->cutoff_tz)
861                         *cb->cutoff_tz = tz;
862                 if (cb->cutoff_cnt)
863                         *cb->cutoff_cnt = cb->reccnt - 1;
864                 /*
865                  * we have not yet updated cb->[n|o]oid so they still
866                  * hold the values for the previous record.
867                  */
868                 if (!is_null_oid(&cb->ooid)) {
869                         oidcpy(cb->oid, noid);
870                         if (oidcmp(&cb->ooid, noid))
871                                 warning("Log for ref %s has gap after %s.",
872                                         cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
873                 }
874                 else if (cb->date == cb->at_time)
875                         oidcpy(cb->oid, noid);
876                 else if (oidcmp(noid, cb->oid))
877                         warning("Log for ref %s unexpectedly ended on %s.",
878                                 cb->refname, show_date(cb->date, cb->tz,
879                                                        DATE_MODE(RFC2822)));
880                 oidcpy(&cb->ooid, ooid);
881                 oidcpy(&cb->noid, noid);
882                 cb->found_it = 1;
883                 return 1;
884         }
885         oidcpy(&cb->ooid, ooid);
886         oidcpy(&cb->noid, noid);
887         if (cb->cnt > 0)
888                 cb->cnt--;
889         return 0;
890 }
891
892 static int read_ref_at_ent_oldest(struct object_id *ooid, struct object_id *noid,
893                                   const char *email, timestamp_t timestamp,
894                                   int tz, const char *message, void *cb_data)
895 {
896         struct read_ref_at_cb *cb = cb_data;
897
898         if (cb->msg)
899                 *cb->msg = xstrdup(message);
900         if (cb->cutoff_time)
901                 *cb->cutoff_time = timestamp;
902         if (cb->cutoff_tz)
903                 *cb->cutoff_tz = tz;
904         if (cb->cutoff_cnt)
905                 *cb->cutoff_cnt = cb->reccnt;
906         oidcpy(cb->oid, ooid);
907         if (is_null_oid(cb->oid))
908                 oidcpy(cb->oid, noid);
909         /* We just want the first entry */
910         return 1;
911 }
912
913 int read_ref_at(const char *refname, unsigned int flags, timestamp_t at_time, int cnt,
914                 struct object_id *oid, char **msg,
915                 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
916 {
917         struct read_ref_at_cb cb;
918
919         memset(&cb, 0, sizeof(cb));
920         cb.refname = refname;
921         cb.at_time = at_time;
922         cb.cnt = cnt;
923         cb.msg = msg;
924         cb.cutoff_time = cutoff_time;
925         cb.cutoff_tz = cutoff_tz;
926         cb.cutoff_cnt = cutoff_cnt;
927         cb.oid = oid;
928
929         for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
930
931         if (!cb.reccnt) {
932                 if (flags & GET_OID_QUIETLY)
933                         exit(128);
934                 else
935                         die("Log for %s is empty.", refname);
936         }
937         if (cb.found_it)
938                 return 0;
939
940         for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
941
942         return 1;
943 }
944
945 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
946                                                     struct strbuf *err)
947 {
948         struct ref_transaction *tr;
949         assert(err);
950
951         tr = xcalloc(1, sizeof(struct ref_transaction));
952         tr->ref_store = refs;
953         return tr;
954 }
955
956 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
957 {
958         return ref_store_transaction_begin(get_main_ref_store(the_repository), err);
959 }
960
961 void ref_transaction_free(struct ref_transaction *transaction)
962 {
963         size_t i;
964
965         if (!transaction)
966                 return;
967
968         switch (transaction->state) {
969         case REF_TRANSACTION_OPEN:
970         case REF_TRANSACTION_CLOSED:
971                 /* OK */
972                 break;
973         case REF_TRANSACTION_PREPARED:
974                 BUG("free called on a prepared reference transaction");
975                 break;
976         default:
977                 BUG("unexpected reference transaction state");
978                 break;
979         }
980
981         for (i = 0; i < transaction->nr; i++) {
982                 free(transaction->updates[i]->msg);
983                 free(transaction->updates[i]);
984         }
985         free(transaction->updates);
986         free(transaction);
987 }
988
989 struct ref_update *ref_transaction_add_update(
990                 struct ref_transaction *transaction,
991                 const char *refname, unsigned int flags,
992                 const struct object_id *new_oid,
993                 const struct object_id *old_oid,
994                 const char *msg)
995 {
996         struct ref_update *update;
997
998         if (transaction->state != REF_TRANSACTION_OPEN)
999                 BUG("update called for transaction that is not open");
1000
1001         FLEX_ALLOC_STR(update, refname, refname);
1002         ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
1003         transaction->updates[transaction->nr++] = update;
1004
1005         update->flags = flags;
1006
1007         if (flags & REF_HAVE_NEW)
1008                 oidcpy(&update->new_oid, new_oid);
1009         if (flags & REF_HAVE_OLD)
1010                 oidcpy(&update->old_oid, old_oid);
1011         update->msg = xstrdup_or_null(msg);
1012         return update;
1013 }
1014
1015 int ref_transaction_update(struct ref_transaction *transaction,
1016                            const char *refname,
1017                            const struct object_id *new_oid,
1018                            const struct object_id *old_oid,
1019                            unsigned int flags, const char *msg,
1020                            struct strbuf *err)
1021 {
1022         assert(err);
1023
1024         if ((new_oid && !is_null_oid(new_oid)) ?
1025             check_refname_format(refname, REFNAME_ALLOW_ONELEVEL) :
1026             !refname_is_safe(refname)) {
1027                 strbuf_addf(err, "refusing to update ref with bad name '%s'",
1028                             refname);
1029                 return -1;
1030         }
1031
1032         if (flags & ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS)
1033                 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags);
1034
1035         flags |= (new_oid ? REF_HAVE_NEW : 0) | (old_oid ? REF_HAVE_OLD : 0);
1036
1037         ref_transaction_add_update(transaction, refname, flags,
1038                                    new_oid, old_oid, msg);
1039         return 0;
1040 }
1041
1042 int ref_transaction_create(struct ref_transaction *transaction,
1043                            const char *refname,
1044                            const struct object_id *new_oid,
1045                            unsigned int flags, const char *msg,
1046                            struct strbuf *err)
1047 {
1048         if (!new_oid || is_null_oid(new_oid))
1049                 BUG("create called without valid new_oid");
1050         return ref_transaction_update(transaction, refname, new_oid,
1051                                       &null_oid, flags, msg, err);
1052 }
1053
1054 int ref_transaction_delete(struct ref_transaction *transaction,
1055                            const char *refname,
1056                            const struct object_id *old_oid,
1057                            unsigned int flags, const char *msg,
1058                            struct strbuf *err)
1059 {
1060         if (old_oid && is_null_oid(old_oid))
1061                 BUG("delete called with old_oid set to zeros");
1062         return ref_transaction_update(transaction, refname,
1063                                       &null_oid, old_oid,
1064                                       flags, msg, err);
1065 }
1066
1067 int ref_transaction_verify(struct ref_transaction *transaction,
1068                            const char *refname,
1069                            const struct object_id *old_oid,
1070                            unsigned int flags,
1071                            struct strbuf *err)
1072 {
1073         if (!old_oid)
1074                 BUG("verify called with old_oid set to NULL");
1075         return ref_transaction_update(transaction, refname,
1076                                       NULL, old_oid,
1077                                       flags, NULL, err);
1078 }
1079
1080 int refs_update_ref(struct ref_store *refs, const char *msg,
1081                     const char *refname, const struct object_id *new_oid,
1082                     const struct object_id *old_oid, unsigned int flags,
1083                     enum action_on_err onerr)
1084 {
1085         struct ref_transaction *t = NULL;
1086         struct strbuf err = STRBUF_INIT;
1087         int ret = 0;
1088
1089         if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
1090                 assert(refs == get_main_ref_store(the_repository));
1091                 ret = write_pseudoref(refname, new_oid, old_oid, &err);
1092         } else {
1093                 t = ref_store_transaction_begin(refs, &err);
1094                 if (!t ||
1095                     ref_transaction_update(t, refname, new_oid, old_oid,
1096                                            flags, msg, &err) ||
1097                     ref_transaction_commit(t, &err)) {
1098                         ret = 1;
1099                         ref_transaction_free(t);
1100                 }
1101         }
1102         if (ret) {
1103                 const char *str = "update_ref failed for ref '%s': %s";
1104
1105                 switch (onerr) {
1106                 case UPDATE_REFS_MSG_ON_ERR:
1107                         error(str, refname, err.buf);
1108                         break;
1109                 case UPDATE_REFS_DIE_ON_ERR:
1110                         die(str, refname, err.buf);
1111                         break;
1112                 case UPDATE_REFS_QUIET_ON_ERR:
1113                         break;
1114                 }
1115                 strbuf_release(&err);
1116                 return 1;
1117         }
1118         strbuf_release(&err);
1119         if (t)
1120                 ref_transaction_free(t);
1121         return 0;
1122 }
1123
1124 int update_ref(const char *msg, const char *refname,
1125                const struct object_id *new_oid,
1126                const struct object_id *old_oid,
1127                unsigned int flags, enum action_on_err onerr)
1128 {
1129         return refs_update_ref(get_main_ref_store(the_repository), msg, refname, new_oid,
1130                                old_oid, flags, onerr);
1131 }
1132
1133 char *shorten_unambiguous_ref(const char *refname, int strict)
1134 {
1135         int i;
1136         static char **scanf_fmts;
1137         static int nr_rules;
1138         char *short_name;
1139         struct strbuf resolved_buf = STRBUF_INIT;
1140
1141         if (!nr_rules) {
1142                 /*
1143                  * Pre-generate scanf formats from ref_rev_parse_rules[].
1144                  * Generate a format suitable for scanf from a
1145                  * ref_rev_parse_rules rule by interpolating "%s" at the
1146                  * location of the "%.*s".
1147                  */
1148                 size_t total_len = 0;
1149                 size_t offset = 0;
1150
1151                 /* the rule list is NULL terminated, count them first */
1152                 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
1153                         /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1154                         total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
1155
1156                 scanf_fmts = xmalloc(st_add(st_mult(sizeof(char *), nr_rules), total_len));
1157
1158                 offset = 0;
1159                 for (i = 0; i < nr_rules; i++) {
1160                         assert(offset < total_len);
1161                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
1162                         offset += xsnprintf(scanf_fmts[i], total_len - offset,
1163                                             ref_rev_parse_rules[i], 2, "%s") + 1;
1164                 }
1165         }
1166
1167         /* bail out if there are no rules */
1168         if (!nr_rules)
1169                 return xstrdup(refname);
1170
1171         /* buffer for scanf result, at most refname must fit */
1172         short_name = xstrdup(refname);
1173
1174         /* skip first rule, it will always match */
1175         for (i = nr_rules - 1; i > 0 ; --i) {
1176                 int j;
1177                 int rules_to_fail = i;
1178                 int short_name_len;
1179
1180                 if (1 != sscanf(refname, scanf_fmts[i], short_name))
1181                         continue;
1182
1183                 short_name_len = strlen(short_name);
1184
1185                 /*
1186                  * in strict mode, all (except the matched one) rules
1187                  * must fail to resolve to a valid non-ambiguous ref
1188                  */
1189                 if (strict)
1190                         rules_to_fail = nr_rules;
1191
1192                 /*
1193                  * check if the short name resolves to a valid ref,
1194                  * but use only rules prior to the matched one
1195                  */
1196                 for (j = 0; j < rules_to_fail; j++) {
1197                         const char *rule = ref_rev_parse_rules[j];
1198
1199                         /* skip matched rule */
1200                         if (i == j)
1201                                 continue;
1202
1203                         /*
1204                          * the short name is ambiguous, if it resolves
1205                          * (with this previous rule) to a valid ref
1206                          * read_ref() returns 0 on success
1207                          */
1208                         strbuf_reset(&resolved_buf);
1209                         strbuf_addf(&resolved_buf, rule,
1210                                     short_name_len, short_name);
1211                         if (ref_exists(resolved_buf.buf))
1212                                 break;
1213                 }
1214
1215                 /*
1216                  * short name is non-ambiguous if all previous rules
1217                  * haven't resolved to a valid ref
1218                  */
1219                 if (j == rules_to_fail) {
1220                         strbuf_release(&resolved_buf);
1221                         return short_name;
1222                 }
1223         }
1224
1225         strbuf_release(&resolved_buf);
1226         free(short_name);
1227         return xstrdup(refname);
1228 }
1229
1230 static struct string_list *hide_refs;
1231
1232 int parse_hide_refs_config(const char *var, const char *value, const char *section)
1233 {
1234         const char *key;
1235         if (!strcmp("transfer.hiderefs", var) ||
1236             (!parse_config_key(var, section, NULL, NULL, &key) &&
1237              !strcmp(key, "hiderefs"))) {
1238                 char *ref;
1239                 int len;
1240
1241                 if (!value)
1242                         return config_error_nonbool(var);
1243                 ref = xstrdup(value);
1244                 len = strlen(ref);
1245                 while (len && ref[len - 1] == '/')
1246                         ref[--len] = '\0';
1247                 if (!hide_refs) {
1248                         hide_refs = xcalloc(1, sizeof(*hide_refs));
1249                         hide_refs->strdup_strings = 1;
1250                 }
1251                 string_list_append(hide_refs, ref);
1252         }
1253         return 0;
1254 }
1255
1256 int ref_is_hidden(const char *refname, const char *refname_full)
1257 {
1258         int i;
1259
1260         if (!hide_refs)
1261                 return 0;
1262         for (i = hide_refs->nr - 1; i >= 0; i--) {
1263                 const char *match = hide_refs->items[i].string;
1264                 const char *subject;
1265                 int neg = 0;
1266                 const char *p;
1267
1268                 if (*match == '!') {
1269                         neg = 1;
1270                         match++;
1271                 }
1272
1273                 if (*match == '^') {
1274                         subject = refname_full;
1275                         match++;
1276                 } else {
1277                         subject = refname;
1278                 }
1279
1280                 /* refname can be NULL when namespaces are used. */
1281                 if (subject &&
1282                     skip_prefix(subject, match, &p) &&
1283                     (!*p || *p == '/'))
1284                         return !neg;
1285         }
1286         return 0;
1287 }
1288
1289 const char *find_descendant_ref(const char *dirname,
1290                                 const struct string_list *extras,
1291                                 const struct string_list *skip)
1292 {
1293         int pos;
1294
1295         if (!extras)
1296                 return NULL;
1297
1298         /*
1299          * Look at the place where dirname would be inserted into
1300          * extras. If there is an entry at that position that starts
1301          * with dirname (remember, dirname includes the trailing
1302          * slash) and is not in skip, then we have a conflict.
1303          */
1304         for (pos = string_list_find_insert_index(extras, dirname, 0);
1305              pos < extras->nr; pos++) {
1306                 const char *extra_refname = extras->items[pos].string;
1307
1308                 if (!starts_with(extra_refname, dirname))
1309                         break;
1310
1311                 if (!skip || !string_list_has_string(skip, extra_refname))
1312                         return extra_refname;
1313         }
1314         return NULL;
1315 }
1316
1317 int refs_rename_ref_available(struct ref_store *refs,
1318                               const char *old_refname,
1319                               const char *new_refname)
1320 {
1321         struct string_list skip = STRING_LIST_INIT_NODUP;
1322         struct strbuf err = STRBUF_INIT;
1323         int ok;
1324
1325         string_list_insert(&skip, old_refname);
1326         ok = !refs_verify_refname_available(refs, new_refname,
1327                                             NULL, &skip, &err);
1328         if (!ok)
1329                 error("%s", err.buf);
1330
1331         string_list_clear(&skip, 0);
1332         strbuf_release(&err);
1333         return ok;
1334 }
1335
1336 int refs_head_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1337 {
1338         struct object_id oid;
1339         int flag;
1340
1341         if (!refs_read_ref_full(refs, "HEAD", RESOLVE_REF_READING,
1342                                 &oid, &flag))
1343                 return fn("HEAD", &oid, flag, cb_data);
1344
1345         return 0;
1346 }
1347
1348 int head_ref(each_ref_fn fn, void *cb_data)
1349 {
1350         return refs_head_ref(get_main_ref_store(the_repository), fn, cb_data);
1351 }
1352
1353 struct ref_iterator *refs_ref_iterator_begin(
1354                 struct ref_store *refs,
1355                 const char *prefix, int trim, int flags)
1356 {
1357         struct ref_iterator *iter;
1358
1359         if (ref_paranoia < 0)
1360                 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
1361         if (ref_paranoia)
1362                 flags |= DO_FOR_EACH_INCLUDE_BROKEN;
1363
1364         iter = refs->be->iterator_begin(refs, prefix, flags);
1365
1366         /*
1367          * `iterator_begin()` already takes care of prefix, but we
1368          * might need to do some trimming:
1369          */
1370         if (trim)
1371                 iter = prefix_ref_iterator_begin(iter, "", trim);
1372
1373         /* Sanity check for subclasses: */
1374         if (!iter->ordered)
1375                 BUG("reference iterator is not ordered");
1376
1377         return iter;
1378 }
1379
1380 /*
1381  * Call fn for each reference in the specified submodule for which the
1382  * refname begins with prefix. If trim is non-zero, then trim that
1383  * many characters off the beginning of each refname before passing
1384  * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1385  * include broken references in the iteration. If fn ever returns a
1386  * non-zero value, stop the iteration and return that value;
1387  * otherwise, return 0.
1388  */
1389 static int do_for_each_repo_ref(struct repository *r, const char *prefix,
1390                                 each_repo_ref_fn fn, int trim, int flags,
1391                                 void *cb_data)
1392 {
1393         struct ref_iterator *iter;
1394         struct ref_store *refs = get_main_ref_store(r);
1395
1396         if (!refs)
1397                 return 0;
1398
1399         iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1400
1401         return do_for_each_repo_ref_iterator(r, iter, fn, cb_data);
1402 }
1403
1404 struct do_for_each_ref_help {
1405         each_ref_fn *fn;
1406         void *cb_data;
1407 };
1408
1409 static int do_for_each_ref_helper(struct repository *r,
1410                                   const char *refname,
1411                                   const struct object_id *oid,
1412                                   int flags,
1413                                   void *cb_data)
1414 {
1415         struct do_for_each_ref_help *hp = cb_data;
1416
1417         return hp->fn(refname, oid, flags, hp->cb_data);
1418 }
1419
1420 static int do_for_each_ref(struct ref_store *refs, const char *prefix,
1421                            each_ref_fn fn, int trim, int flags, void *cb_data)
1422 {
1423         struct ref_iterator *iter;
1424         struct do_for_each_ref_help hp = { fn, cb_data };
1425
1426         if (!refs)
1427                 return 0;
1428
1429         iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1430
1431         return do_for_each_repo_ref_iterator(the_repository, iter,
1432                                         do_for_each_ref_helper, &hp);
1433 }
1434
1435 int refs_for_each_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1436 {
1437         return do_for_each_ref(refs, "", fn, 0, 0, cb_data);
1438 }
1439
1440 int for_each_ref(each_ref_fn fn, void *cb_data)
1441 {
1442         return refs_for_each_ref(get_main_ref_store(the_repository), fn, cb_data);
1443 }
1444
1445 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
1446                          each_ref_fn fn, void *cb_data)
1447 {
1448         return do_for_each_ref(refs, prefix, fn, strlen(prefix), 0, cb_data);
1449 }
1450
1451 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1452 {
1453         return refs_for_each_ref_in(get_main_ref_store(the_repository), prefix, fn, cb_data);
1454 }
1455
1456 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken)
1457 {
1458         unsigned int flag = 0;
1459
1460         if (broken)
1461                 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1462         return do_for_each_ref(get_main_ref_store(the_repository),
1463                                prefix, fn, 0, flag, cb_data);
1464 }
1465
1466 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
1467                              each_ref_fn fn, void *cb_data,
1468                              unsigned int broken)
1469 {
1470         unsigned int flag = 0;
1471
1472         if (broken)
1473                 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1474         return do_for_each_ref(refs, prefix, fn, 0, flag, cb_data);
1475 }
1476
1477 int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data)
1478 {
1479         return do_for_each_repo_ref(r, git_replace_ref_base, fn,
1480                                     strlen(git_replace_ref_base),
1481                                     DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1482 }
1483
1484 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1485 {
1486         struct strbuf buf = STRBUF_INIT;
1487         int ret;
1488         strbuf_addf(&buf, "%srefs/", get_git_namespace());
1489         ret = do_for_each_ref(get_main_ref_store(the_repository),
1490                               buf.buf, fn, 0, 0, cb_data);
1491         strbuf_release(&buf);
1492         return ret;
1493 }
1494
1495 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1496 {
1497         return do_for_each_ref(refs, "", fn, 0,
1498                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1499 }
1500
1501 int for_each_rawref(each_ref_fn fn, void *cb_data)
1502 {
1503         return refs_for_each_rawref(get_main_ref_store(the_repository), fn, cb_data);
1504 }
1505
1506 int refs_read_raw_ref(struct ref_store *ref_store,
1507                       const char *refname, struct object_id *oid,
1508                       struct strbuf *referent, unsigned int *type)
1509 {
1510         return ref_store->be->read_raw_ref(ref_store, refname, oid, referent, type);
1511 }
1512
1513 /* This function needs to return a meaningful errno on failure */
1514 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
1515                                     const char *refname,
1516                                     int resolve_flags,
1517                                     struct object_id *oid, int *flags)
1518 {
1519         static struct strbuf sb_refname = STRBUF_INIT;
1520         struct object_id unused_oid;
1521         int unused_flags;
1522         int symref_count;
1523
1524         if (!oid)
1525                 oid = &unused_oid;
1526         if (!flags)
1527                 flags = &unused_flags;
1528
1529         *flags = 0;
1530
1531         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1532                 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1533                     !refname_is_safe(refname)) {
1534                         errno = EINVAL;
1535                         return NULL;
1536                 }
1537
1538                 /*
1539                  * dwim_ref() uses REF_ISBROKEN to distinguish between
1540                  * missing refs and refs that were present but invalid,
1541                  * to complain about the latter to stderr.
1542                  *
1543                  * We don't know whether the ref exists, so don't set
1544                  * REF_ISBROKEN yet.
1545                  */
1546                 *flags |= REF_BAD_NAME;
1547         }
1548
1549         for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
1550                 unsigned int read_flags = 0;
1551
1552                 if (refs_read_raw_ref(refs, refname,
1553                                       oid, &sb_refname, &read_flags)) {
1554                         *flags |= read_flags;
1555
1556                         /* In reading mode, refs must eventually resolve */
1557                         if (resolve_flags & RESOLVE_REF_READING)
1558                                 return NULL;
1559
1560                         /*
1561                          * Otherwise a missing ref is OK. But the files backend
1562                          * may show errors besides ENOENT if there are
1563                          * similarly-named refs.
1564                          */
1565                         if (errno != ENOENT &&
1566                             errno != EISDIR &&
1567                             errno != ENOTDIR)
1568                                 return NULL;
1569
1570                         oidclr(oid);
1571                         if (*flags & REF_BAD_NAME)
1572                                 *flags |= REF_ISBROKEN;
1573                         return refname;
1574                 }
1575
1576                 *flags |= read_flags;
1577
1578                 if (!(read_flags & REF_ISSYMREF)) {
1579                         if (*flags & REF_BAD_NAME) {
1580                                 oidclr(oid);
1581                                 *flags |= REF_ISBROKEN;
1582                         }
1583                         return refname;
1584                 }
1585
1586                 refname = sb_refname.buf;
1587                 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1588                         oidclr(oid);
1589                         return refname;
1590                 }
1591                 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1592                         if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1593                             !refname_is_safe(refname)) {
1594                                 errno = EINVAL;
1595                                 return NULL;
1596                         }
1597
1598                         *flags |= REF_ISBROKEN | REF_BAD_NAME;
1599                 }
1600         }
1601
1602         errno = ELOOP;
1603         return NULL;
1604 }
1605
1606 /* backend functions */
1607 int refs_init_db(struct strbuf *err)
1608 {
1609         struct ref_store *refs = get_main_ref_store(the_repository);
1610
1611         return refs->be->init_db(refs, err);
1612 }
1613
1614 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1615                                struct object_id *oid, int *flags)
1616 {
1617         return refs_resolve_ref_unsafe(get_main_ref_store(the_repository), refname,
1618                                        resolve_flags, oid, flags);
1619 }
1620
1621 int resolve_gitlink_ref(const char *submodule, const char *refname,
1622                         struct object_id *oid)
1623 {
1624         struct ref_store *refs;
1625         int flags;
1626
1627         refs = get_submodule_ref_store(submodule);
1628
1629         if (!refs)
1630                 return -1;
1631
1632         if (!refs_resolve_ref_unsafe(refs, refname, 0, oid, &flags) ||
1633             is_null_oid(oid))
1634                 return -1;
1635         return 0;
1636 }
1637
1638 struct ref_store_hash_entry
1639 {
1640         struct hashmap_entry ent; /* must be the first member! */
1641
1642         struct ref_store *refs;
1643
1644         /* NUL-terminated identifier of the ref store: */
1645         char name[FLEX_ARRAY];
1646 };
1647
1648 static int ref_store_hash_cmp(const void *unused_cmp_data,
1649                               const void *entry, const void *entry_or_key,
1650                               const void *keydata)
1651 {
1652         const struct ref_store_hash_entry *e1 = entry, *e2 = entry_or_key;
1653         const char *name = keydata ? keydata : e2->name;
1654
1655         return strcmp(e1->name, name);
1656 }
1657
1658 static struct ref_store_hash_entry *alloc_ref_store_hash_entry(
1659                 const char *name, struct ref_store *refs)
1660 {
1661         struct ref_store_hash_entry *entry;
1662
1663         FLEX_ALLOC_STR(entry, name, name);
1664         hashmap_entry_init(entry, strhash(name));
1665         entry->refs = refs;
1666         return entry;
1667 }
1668
1669 /* A hashmap of ref_stores, stored by submodule name: */
1670 static struct hashmap submodule_ref_stores;
1671
1672 /* A hashmap of ref_stores, stored by worktree id: */
1673 static struct hashmap worktree_ref_stores;
1674
1675 /*
1676  * Look up a ref store by name. If that ref_store hasn't been
1677  * registered yet, return NULL.
1678  */
1679 static struct ref_store *lookup_ref_store_map(struct hashmap *map,
1680                                               const char *name)
1681 {
1682         struct ref_store_hash_entry *entry;
1683
1684         if (!map->tablesize)
1685                 /* It's initialized on demand in register_ref_store(). */
1686                 return NULL;
1687
1688         entry = hashmap_get_from_hash(map, strhash(name), name);
1689         return entry ? entry->refs : NULL;
1690 }
1691
1692 /*
1693  * Create, record, and return a ref_store instance for the specified
1694  * gitdir.
1695  */
1696 static struct ref_store *ref_store_init(const char *gitdir,
1697                                         unsigned int flags)
1698 {
1699         const char *be_name = "files";
1700         struct ref_storage_be *be = find_ref_storage_backend(be_name);
1701         struct ref_store *refs;
1702
1703         if (!be)
1704                 BUG("reference backend %s is unknown", be_name);
1705
1706         refs = be->init(gitdir, flags);
1707         return refs;
1708 }
1709
1710 struct ref_store *get_main_ref_store(struct repository *r)
1711 {
1712         if (r->refs)
1713                 return r->refs;
1714
1715         if (!r->gitdir)
1716                 BUG("attempting to get main_ref_store outside of repository");
1717
1718         r->refs = ref_store_init(r->gitdir, REF_STORE_ALL_CAPS);
1719         return r->refs;
1720 }
1721
1722 /*
1723  * Associate a ref store with a name. It is a fatal error to call this
1724  * function twice for the same name.
1725  */
1726 static void register_ref_store_map(struct hashmap *map,
1727                                    const char *type,
1728                                    struct ref_store *refs,
1729                                    const char *name)
1730 {
1731         if (!map->tablesize)
1732                 hashmap_init(map, ref_store_hash_cmp, NULL, 0);
1733
1734         if (hashmap_put(map, alloc_ref_store_hash_entry(name, refs)))
1735                 BUG("%s ref_store '%s' initialized twice", type, name);
1736 }
1737
1738 struct ref_store *get_submodule_ref_store(const char *submodule)
1739 {
1740         struct strbuf submodule_sb = STRBUF_INIT;
1741         struct ref_store *refs;
1742         char *to_free = NULL;
1743         size_t len;
1744
1745         if (!submodule)
1746                 return NULL;
1747
1748         len = strlen(submodule);
1749         while (len && is_dir_sep(submodule[len - 1]))
1750                 len--;
1751         if (!len)
1752                 return NULL;
1753
1754         if (submodule[len])
1755                 /* We need to strip off one or more trailing slashes */
1756                 submodule = to_free = xmemdupz(submodule, len);
1757
1758         refs = lookup_ref_store_map(&submodule_ref_stores, submodule);
1759         if (refs)
1760                 goto done;
1761
1762         strbuf_addstr(&submodule_sb, submodule);
1763         if (!is_nonbare_repository_dir(&submodule_sb))
1764                 goto done;
1765
1766         if (submodule_to_gitdir(&submodule_sb, submodule))
1767                 goto done;
1768
1769         /* assume that add_submodule_odb() has been called */
1770         refs = ref_store_init(submodule_sb.buf,
1771                               REF_STORE_READ | REF_STORE_ODB);
1772         register_ref_store_map(&submodule_ref_stores, "submodule",
1773                                refs, submodule);
1774
1775 done:
1776         strbuf_release(&submodule_sb);
1777         free(to_free);
1778
1779         return refs;
1780 }
1781
1782 struct ref_store *get_worktree_ref_store(const struct worktree *wt)
1783 {
1784         struct ref_store *refs;
1785         const char *id;
1786
1787         if (wt->is_current)
1788                 return get_main_ref_store(the_repository);
1789
1790         id = wt->id ? wt->id : "/";
1791         refs = lookup_ref_store_map(&worktree_ref_stores, id);
1792         if (refs)
1793                 return refs;
1794
1795         if (wt->id)
1796                 refs = ref_store_init(git_common_path("worktrees/%s", wt->id),
1797                                       REF_STORE_ALL_CAPS);
1798         else
1799                 refs = ref_store_init(get_git_common_dir(),
1800                                       REF_STORE_ALL_CAPS);
1801
1802         if (refs)
1803                 register_ref_store_map(&worktree_ref_stores, "worktree",
1804                                        refs, id);
1805         return refs;
1806 }
1807
1808 void base_ref_store_init(struct ref_store *refs,
1809                          const struct ref_storage_be *be)
1810 {
1811         refs->be = be;
1812 }
1813
1814 /* backend functions */
1815 int refs_pack_refs(struct ref_store *refs, unsigned int flags)
1816 {
1817         return refs->be->pack_refs(refs, flags);
1818 }
1819
1820 int refs_peel_ref(struct ref_store *refs, const char *refname,
1821                   struct object_id *oid)
1822 {
1823         int flag;
1824         struct object_id base;
1825
1826         if (current_ref_iter && current_ref_iter->refname == refname) {
1827                 struct object_id peeled;
1828
1829                 if (ref_iterator_peel(current_ref_iter, &peeled))
1830                         return -1;
1831                 oidcpy(oid, &peeled);
1832                 return 0;
1833         }
1834
1835         if (refs_read_ref_full(refs, refname,
1836                                RESOLVE_REF_READING, &base, &flag))
1837                 return -1;
1838
1839         return peel_object(&base, oid);
1840 }
1841
1842 int peel_ref(const char *refname, struct object_id *oid)
1843 {
1844         return refs_peel_ref(get_main_ref_store(the_repository), refname, oid);
1845 }
1846
1847 int refs_create_symref(struct ref_store *refs,
1848                        const char *ref_target,
1849                        const char *refs_heads_master,
1850                        const char *logmsg)
1851 {
1852         return refs->be->create_symref(refs, ref_target,
1853                                        refs_heads_master,
1854                                        logmsg);
1855 }
1856
1857 int create_symref(const char *ref_target, const char *refs_heads_master,
1858                   const char *logmsg)
1859 {
1860         return refs_create_symref(get_main_ref_store(the_repository), ref_target,
1861                                   refs_heads_master, logmsg);
1862 }
1863
1864 int ref_update_reject_duplicates(struct string_list *refnames,
1865                                  struct strbuf *err)
1866 {
1867         size_t i, n = refnames->nr;
1868
1869         assert(err);
1870
1871         for (i = 1; i < n; i++) {
1872                 int cmp = strcmp(refnames->items[i - 1].string,
1873                                  refnames->items[i].string);
1874
1875                 if (!cmp) {
1876                         strbuf_addf(err,
1877                                     "multiple updates for ref '%s' not allowed.",
1878                                     refnames->items[i].string);
1879                         return 1;
1880                 } else if (cmp > 0) {
1881                         BUG("ref_update_reject_duplicates() received unsorted list");
1882                 }
1883         }
1884         return 0;
1885 }
1886
1887 int ref_transaction_prepare(struct ref_transaction *transaction,
1888                             struct strbuf *err)
1889 {
1890         struct ref_store *refs = transaction->ref_store;
1891
1892         switch (transaction->state) {
1893         case REF_TRANSACTION_OPEN:
1894                 /* Good. */
1895                 break;
1896         case REF_TRANSACTION_PREPARED:
1897                 BUG("prepare called twice on reference transaction");
1898                 break;
1899         case REF_TRANSACTION_CLOSED:
1900                 BUG("prepare called on a closed reference transaction");
1901                 break;
1902         default:
1903                 BUG("unexpected reference transaction state");
1904                 break;
1905         }
1906
1907         if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
1908                 strbuf_addstr(err,
1909                               _("ref updates forbidden inside quarantine environment"));
1910                 return -1;
1911         }
1912
1913         return refs->be->transaction_prepare(refs, transaction, err);
1914 }
1915
1916 int ref_transaction_abort(struct ref_transaction *transaction,
1917                           struct strbuf *err)
1918 {
1919         struct ref_store *refs = transaction->ref_store;
1920         int ret = 0;
1921
1922         switch (transaction->state) {
1923         case REF_TRANSACTION_OPEN:
1924                 /* No need to abort explicitly. */
1925                 break;
1926         case REF_TRANSACTION_PREPARED:
1927                 ret = refs->be->transaction_abort(refs, transaction, err);
1928                 break;
1929         case REF_TRANSACTION_CLOSED:
1930                 BUG("abort called on a closed reference transaction");
1931                 break;
1932         default:
1933                 BUG("unexpected reference transaction state");
1934                 break;
1935         }
1936
1937         ref_transaction_free(transaction);
1938         return ret;
1939 }
1940
1941 int ref_transaction_commit(struct ref_transaction *transaction,
1942                            struct strbuf *err)
1943 {
1944         struct ref_store *refs = transaction->ref_store;
1945         int ret;
1946
1947         switch (transaction->state) {
1948         case REF_TRANSACTION_OPEN:
1949                 /* Need to prepare first. */
1950                 ret = ref_transaction_prepare(transaction, err);
1951                 if (ret)
1952                         return ret;
1953                 break;
1954         case REF_TRANSACTION_PREPARED:
1955                 /* Fall through to finish. */
1956                 break;
1957         case REF_TRANSACTION_CLOSED:
1958                 BUG("commit called on a closed reference transaction");
1959                 break;
1960         default:
1961                 BUG("unexpected reference transaction state");
1962                 break;
1963         }
1964
1965         return refs->be->transaction_finish(refs, transaction, err);
1966 }
1967
1968 int refs_verify_refname_available(struct ref_store *refs,
1969                                   const char *refname,
1970                                   const struct string_list *extras,
1971                                   const struct string_list *skip,
1972                                   struct strbuf *err)
1973 {
1974         const char *slash;
1975         const char *extra_refname;
1976         struct strbuf dirname = STRBUF_INIT;
1977         struct strbuf referent = STRBUF_INIT;
1978         struct object_id oid;
1979         unsigned int type;
1980         struct ref_iterator *iter;
1981         int ok;
1982         int ret = -1;
1983
1984         /*
1985          * For the sake of comments in this function, suppose that
1986          * refname is "refs/foo/bar".
1987          */
1988
1989         assert(err);
1990
1991         strbuf_grow(&dirname, strlen(refname) + 1);
1992         for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
1993                 /* Expand dirname to the new prefix, not including the trailing slash: */
1994                 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);
1995
1996                 /*
1997                  * We are still at a leading dir of the refname (e.g.,
1998                  * "refs/foo"; if there is a reference with that name,
1999                  * it is a conflict, *unless* it is in skip.
2000                  */
2001                 if (skip && string_list_has_string(skip, dirname.buf))
2002                         continue;
2003
2004                 if (!refs_read_raw_ref(refs, dirname.buf, &oid, &referent, &type)) {
2005                         strbuf_addf(err, "'%s' exists; cannot create '%s'",
2006                                     dirname.buf, refname);
2007                         goto cleanup;
2008                 }
2009
2010                 if (extras && string_list_has_string(extras, dirname.buf)) {
2011                         strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
2012                                     refname, dirname.buf);
2013                         goto cleanup;
2014                 }
2015         }
2016
2017         /*
2018          * We are at the leaf of our refname (e.g., "refs/foo/bar").
2019          * There is no point in searching for a reference with that
2020          * name, because a refname isn't considered to conflict with
2021          * itself. But we still need to check for references whose
2022          * names are in the "refs/foo/bar/" namespace, because they
2023          * *do* conflict.
2024          */
2025         strbuf_addstr(&dirname, refname + dirname.len);
2026         strbuf_addch(&dirname, '/');
2027
2028         iter = refs_ref_iterator_begin(refs, dirname.buf, 0,
2029                                        DO_FOR_EACH_INCLUDE_BROKEN);
2030         while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
2031                 if (skip &&
2032                     string_list_has_string(skip, iter->refname))
2033                         continue;
2034
2035                 strbuf_addf(err, "'%s' exists; cannot create '%s'",
2036                             iter->refname, refname);
2037                 ref_iterator_abort(iter);
2038                 goto cleanup;
2039         }
2040
2041         if (ok != ITER_DONE)
2042                 BUG("error while iterating over references");
2043
2044         extra_refname = find_descendant_ref(dirname.buf, extras, skip);
2045         if (extra_refname)
2046                 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
2047                             refname, extra_refname);
2048         else
2049                 ret = 0;
2050
2051 cleanup:
2052         strbuf_release(&referent);
2053         strbuf_release(&dirname);
2054         return ret;
2055 }
2056
2057 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data)
2058 {
2059         struct ref_iterator *iter;
2060         struct do_for_each_ref_help hp = { fn, cb_data };
2061
2062         iter = refs->be->reflog_iterator_begin(refs);
2063
2064         return do_for_each_repo_ref_iterator(the_repository, iter,
2065                                              do_for_each_ref_helper, &hp);
2066 }
2067
2068 int for_each_reflog(each_ref_fn fn, void *cb_data)
2069 {
2070         return refs_for_each_reflog(get_main_ref_store(the_repository), fn, cb_data);
2071 }
2072
2073 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
2074                                      const char *refname,
2075                                      each_reflog_ent_fn fn,
2076                                      void *cb_data)
2077 {
2078         return refs->be->for_each_reflog_ent_reverse(refs, refname,
2079                                                      fn, cb_data);
2080 }
2081
2082 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn,
2083                                 void *cb_data)
2084 {
2085         return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository),
2086                                                 refname, fn, cb_data);
2087 }
2088
2089 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
2090                              each_reflog_ent_fn fn, void *cb_data)
2091 {
2092         return refs->be->for_each_reflog_ent(refs, refname, fn, cb_data);
2093 }
2094
2095 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn,
2096                         void *cb_data)
2097 {
2098         return refs_for_each_reflog_ent(get_main_ref_store(the_repository), refname,
2099                                         fn, cb_data);
2100 }
2101
2102 int refs_reflog_exists(struct ref_store *refs, const char *refname)
2103 {
2104         return refs->be->reflog_exists(refs, refname);
2105 }
2106
2107 int reflog_exists(const char *refname)
2108 {
2109         return refs_reflog_exists(get_main_ref_store(the_repository), refname);
2110 }
2111
2112 int refs_create_reflog(struct ref_store *refs, const char *refname,
2113                        int force_create, struct strbuf *err)
2114 {
2115         return refs->be->create_reflog(refs, refname, force_create, err);
2116 }
2117
2118 int safe_create_reflog(const char *refname, int force_create,
2119                        struct strbuf *err)
2120 {
2121         return refs_create_reflog(get_main_ref_store(the_repository), refname,
2122                                   force_create, err);
2123 }
2124
2125 int refs_delete_reflog(struct ref_store *refs, const char *refname)
2126 {
2127         return refs->be->delete_reflog(refs, refname);
2128 }
2129
2130 int delete_reflog(const char *refname)
2131 {
2132         return refs_delete_reflog(get_main_ref_store(the_repository), refname);
2133 }
2134
2135 int refs_reflog_expire(struct ref_store *refs,
2136                        const char *refname, const struct object_id *oid,
2137                        unsigned int flags,
2138                        reflog_expiry_prepare_fn prepare_fn,
2139                        reflog_expiry_should_prune_fn should_prune_fn,
2140                        reflog_expiry_cleanup_fn cleanup_fn,
2141                        void *policy_cb_data)
2142 {
2143         return refs->be->reflog_expire(refs, refname, oid, flags,
2144                                        prepare_fn, should_prune_fn,
2145                                        cleanup_fn, policy_cb_data);
2146 }
2147
2148 int reflog_expire(const char *refname, const struct object_id *oid,
2149                   unsigned int flags,
2150                   reflog_expiry_prepare_fn prepare_fn,
2151                   reflog_expiry_should_prune_fn should_prune_fn,
2152                   reflog_expiry_cleanup_fn cleanup_fn,
2153                   void *policy_cb_data)
2154 {
2155         return refs_reflog_expire(get_main_ref_store(the_repository),
2156                                   refname, oid, flags,
2157                                   prepare_fn, should_prune_fn,
2158                                   cleanup_fn, policy_cb_data);
2159 }
2160
2161 int initial_ref_transaction_commit(struct ref_transaction *transaction,
2162                                    struct strbuf *err)
2163 {
2164         struct ref_store *refs = transaction->ref_store;
2165
2166         return refs->be->initial_transaction_commit(refs, transaction, err);
2167 }
2168
2169 int refs_delete_refs(struct ref_store *refs, const char *msg,
2170                      struct string_list *refnames, unsigned int flags)
2171 {
2172         return refs->be->delete_refs(refs, msg, refnames, flags);
2173 }
2174
2175 int delete_refs(const char *msg, struct string_list *refnames,
2176                 unsigned int flags)
2177 {
2178         return refs_delete_refs(get_main_ref_store(the_repository), msg, refnames, flags);
2179 }
2180
2181 int refs_rename_ref(struct ref_store *refs, const char *oldref,
2182                     const char *newref, const char *logmsg)
2183 {
2184         return refs->be->rename_ref(refs, oldref, newref, logmsg);
2185 }
2186
2187 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
2188 {
2189         return refs_rename_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);
2190 }
2191
2192 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
2193                     const char *newref, const char *logmsg)
2194 {
2195         return refs->be->copy_ref(refs, oldref, newref, logmsg);
2196 }
2197
2198 int copy_existing_ref(const char *oldref, const char *newref, const char *logmsg)
2199 {
2200         return refs_copy_existing_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);
2201 }