1 #include "../git-compat-util.h"
2 #include "../abspath.h"
3 #include "../chdir-notify.h"
4 #include "../environment.h"
5 #include "../gettext.h"
8 #include "../iterator.h"
10 #include "../lockfile.h"
11 #include "../object.h"
14 #include "../reftable/reftable-stack.h"
15 #include "../reftable/reftable-record.h"
16 #include "../reftable/reftable-error.h"
17 #include "../reftable/reftable-iterator.h"
18 #include "../reftable/reftable-merged.h"
20 #include "../strmap.h"
21 #include "refs-internal.h"
24 * Used as a flag in ref_update::flags when the ref_update was via an
27 #define REF_UPDATE_VIA_HEAD (1 << 8)
29 struct reftable_ref_store
{
30 struct ref_store base
;
33 * The main stack refers to the common dir and thus contains common
34 * refs as well as refs of the main repository.
36 struct reftable_stack
*main_stack
;
38 * The worktree stack refers to the gitdir in case the refdb is opened
39 * via a worktree. It thus contains the per-worktree refs.
41 struct reftable_stack
*worktree_stack
;
43 * Map of worktree stacks by their respective worktree names. The map
44 * is populated lazily when we try to resolve `worktrees/$worktree` refs.
46 struct strmap worktree_stacks
;
47 struct reftable_write_options write_options
;
49 unsigned int store_flags
;
54 * Downcast ref_store to reftable_ref_store. Die if ref_store is not a
55 * reftable_ref_store. required_flags is compared with ref_store's store_flags
56 * to ensure the ref_store has all required capabilities. "caller" is used in
57 * any necessary error messages.
59 static struct reftable_ref_store
*reftable_be_downcast(struct ref_store
*ref_store
,
60 unsigned int required_flags
,
63 struct reftable_ref_store
*refs
;
65 if (ref_store
->be
!= &refs_be_reftable
)
66 BUG("ref_store is type \"%s\" not \"reftables\" in %s",
67 ref_store
->be
->name
, caller
);
69 refs
= (struct reftable_ref_store
*)ref_store
;
71 if ((refs
->store_flags
& required_flags
) != required_flags
)
72 BUG("operation %s requires abilities 0x%x, but only have 0x%x",
73 caller
, required_flags
, refs
->store_flags
);
79 * Some refs are global to the repository (refs/heads/{*}), while others are
80 * local to the worktree (eg. HEAD, refs/bisect/{*}). We solve this by having
81 * multiple separate databases (ie. multiple reftable/ directories), one for
82 * the shared refs, one for the current worktree refs, and one for each
83 * additional worktree. For reading, we merge the view of both the shared and
84 * the current worktree's refs, when necessary.
86 * This function also optionally assigns the rewritten reference name that is
87 * local to the stack. This translation is required when using worktree refs
88 * like `worktrees/$worktree/refs/heads/foo` as worktree stacks will store
89 * those references in their normalized form.
91 static struct reftable_stack
*stack_for(struct reftable_ref_store
*store
,
93 const char **rewritten_ref
)
99 return store
->main_stack
;
101 switch (parse_worktree_ref(refname
, &wtname
, &wtname_len
, rewritten_ref
)) {
102 case REF_WORKTREE_OTHER
: {
103 static struct strbuf wtname_buf
= STRBUF_INIT
;
104 struct strbuf wt_dir
= STRBUF_INIT
;
105 struct reftable_stack
*stack
;
108 * We're using a static buffer here so that we don't need to
109 * allocate the worktree name whenever we look up a reference.
110 * This could be avoided if the strmap interface knew how to
111 * handle keys with a length.
113 strbuf_reset(&wtname_buf
);
114 strbuf_add(&wtname_buf
, wtname
, wtname_len
);
117 * There is an edge case here: when the worktree references the
118 * current worktree, then we set up the stack once via
119 * `worktree_stacks` and once via `worktree_stack`. This is
120 * wasteful, but in the reading case it shouldn't matter. And
121 * in the writing case we would notice that the stack is locked
122 * already and error out when trying to write a reference via
125 stack
= strmap_get(&store
->worktree_stacks
, wtname_buf
.buf
);
127 strbuf_addf(&wt_dir
, "%s/worktrees/%s/reftable",
128 store
->base
.repo
->commondir
, wtname_buf
.buf
);
130 store
->err
= reftable_new_stack(&stack
, wt_dir
.buf
,
131 store
->write_options
);
132 assert(store
->err
!= REFTABLE_API_ERROR
);
133 strmap_put(&store
->worktree_stacks
, wtname_buf
.buf
, stack
);
136 strbuf_release(&wt_dir
);
139 case REF_WORKTREE_CURRENT
:
141 * If there is no worktree stack then we're currently in the
142 * main worktree. We thus return the main stack in that case.
144 if (!store
->worktree_stack
)
145 return store
->main_stack
;
146 return store
->worktree_stack
;
147 case REF_WORKTREE_MAIN
:
148 case REF_WORKTREE_SHARED
:
149 return store
->main_stack
;
151 BUG("unhandled worktree reference type");
155 static int should_write_log(struct ref_store
*refs
, const char *refname
)
157 if (log_all_ref_updates
== LOG_REFS_UNSET
)
158 log_all_ref_updates
= is_bare_repository() ? LOG_REFS_NONE
: LOG_REFS_NORMAL
;
160 switch (log_all_ref_updates
) {
162 return refs_reflog_exists(refs
, refname
);
163 case LOG_REFS_ALWAYS
:
165 case LOG_REFS_NORMAL
:
166 if (should_autocreate_reflog(refname
))
168 return refs_reflog_exists(refs
, refname
);
170 BUG("unhandled core.logAllRefUpdates value %d", log_all_ref_updates
);
174 static void clear_reftable_log_record(struct reftable_log_record
*log
)
176 switch (log
->value_type
) {
177 case REFTABLE_LOG_UPDATE
:
179 * When we write log records, the hashes are owned by the
180 * caller and thus shouldn't be free'd.
182 log
->value
.update
.old_hash
= NULL
;
183 log
->value
.update
.new_hash
= NULL
;
185 case REFTABLE_LOG_DELETION
:
188 reftable_log_record_release(log
);
191 static void fill_reftable_log_record(struct reftable_log_record
*log
)
193 const char *info
= git_committer_info(0);
194 struct ident_split split
= {0};
197 if (split_ident_line(&split
, info
, strlen(info
)))
198 BUG("failed splitting committer info");
200 reftable_log_record_release(log
);
201 log
->value_type
= REFTABLE_LOG_UPDATE
;
202 log
->value
.update
.name
=
203 xstrndup(split
.name_begin
, split
.name_end
- split
.name_begin
);
204 log
->value
.update
.email
=
205 xstrndup(split
.mail_begin
, split
.mail_end
- split
.mail_begin
);
206 log
->value
.update
.time
= atol(split
.date_begin
);
207 if (*split
.tz_begin
== '-') {
211 if (*split
.tz_begin
== '+') {
216 log
->value
.update
.tz_offset
= sign
* atoi(split
.tz_begin
);
219 static int read_ref_without_reload(struct reftable_stack
*stack
,
221 struct object_id
*oid
,
222 struct strbuf
*referent
,
225 struct reftable_ref_record ref
= {0};
228 ret
= reftable_stack_read_ref(stack
, refname
, &ref
);
232 if (ref
.value_type
== REFTABLE_REF_SYMREF
) {
233 strbuf_reset(referent
);
234 strbuf_addstr(referent
, ref
.value
.symref
);
235 *type
|= REF_ISSYMREF
;
236 } else if (reftable_ref_record_val1(&ref
)) {
237 oidread(oid
, reftable_ref_record_val1(&ref
));
239 /* We got a tombstone, which should not happen. */
240 BUG("unhandled reference value type %d", ref
.value_type
);
244 assert(ret
!= REFTABLE_API_ERROR
);
245 reftable_ref_record_release(&ref
);
249 static struct ref_store
*reftable_be_init(struct repository
*repo
,
251 unsigned int store_flags
)
253 struct reftable_ref_store
*refs
= xcalloc(1, sizeof(*refs
));
254 struct strbuf path
= STRBUF_INIT
;
261 base_ref_store_init(&refs
->base
, repo
, gitdir
, &refs_be_reftable
);
262 strmap_init(&refs
->worktree_stacks
);
263 refs
->store_flags
= store_flags
;
264 refs
->write_options
.block_size
= 4096;
265 refs
->write_options
.hash_id
= repo
->hash_algo
->format_id
;
266 refs
->write_options
.default_permissions
= calc_shared_perm(0666 & ~mask
);
269 * Set up the main reftable stack that is hosted in GIT_COMMON_DIR.
270 * This stack contains both the shared and the main worktree refs.
272 * Note that we don't try to resolve the path in case we have a
273 * worktree because `get_common_dir_noenv()` already does it for us.
275 is_worktree
= get_common_dir_noenv(&path
, gitdir
);
278 strbuf_realpath(&path
, gitdir
, 0);
280 strbuf_addstr(&path
, "/reftable");
281 refs
->err
= reftable_new_stack(&refs
->main_stack
, path
.buf
,
282 refs
->write_options
);
287 * If we're in a worktree we also need to set up the worktree reftable
288 * stack that is contained in the per-worktree GIT_DIR.
290 * Ideally, we would also add the stack to our worktree stack map. But
291 * we have no way to figure out the worktree name here and thus can't
296 strbuf_addf(&path
, "%s/reftable", gitdir
);
298 refs
->err
= reftable_new_stack(&refs
->worktree_stack
, path
.buf
,
299 refs
->write_options
);
304 chdir_notify_reparent("reftables-backend $GIT_DIR", &refs
->base
.gitdir
);
307 assert(refs
->err
!= REFTABLE_API_ERROR
);
308 strbuf_release(&path
);
312 static int reftable_be_init_db(struct ref_store
*ref_store
,
314 struct strbuf
*err UNUSED
)
316 struct reftable_ref_store
*refs
=
317 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "init_db");
318 struct strbuf sb
= STRBUF_INIT
;
320 strbuf_addf(&sb
, "%s/reftable", refs
->base
.gitdir
);
321 safe_create_dir(sb
.buf
, 1);
324 strbuf_addf(&sb
, "%s/HEAD", refs
->base
.gitdir
);
325 write_file(sb
.buf
, "ref: refs/heads/.invalid");
326 adjust_shared_perm(sb
.buf
);
329 strbuf_addf(&sb
, "%s/refs", refs
->base
.gitdir
);
330 safe_create_dir(sb
.buf
, 1);
333 strbuf_addf(&sb
, "%s/refs/heads", refs
->base
.gitdir
);
334 write_file(sb
.buf
, "this repository uses the reftable format");
335 adjust_shared_perm(sb
.buf
);
341 struct reftable_ref_iterator
{
342 struct ref_iterator base
;
343 struct reftable_ref_store
*refs
;
344 struct reftable_iterator iter
;
345 struct reftable_ref_record ref
;
346 struct object_id oid
;
354 static int reftable_ref_iterator_advance(struct ref_iterator
*ref_iterator
)
356 struct reftable_ref_iterator
*iter
=
357 (struct reftable_ref_iterator
*)ref_iterator
;
358 struct reftable_ref_store
*refs
= iter
->refs
;
363 iter
->err
= reftable_iterator_next_ref(&iter
->iter
, &iter
->ref
);
368 * The files backend only lists references contained in "refs/" unless
369 * the root refs are to be included. We emulate the same behaviour here.
371 if (!starts_with(iter
->ref
.refname
, "refs/") &&
372 !(iter
->flags
& DO_FOR_EACH_INCLUDE_ROOT_REFS
&&
373 (is_pseudoref(&iter
->refs
->base
, iter
->ref
.refname
) ||
374 is_headref(&iter
->refs
->base
, iter
->ref
.refname
)))) {
378 if (iter
->prefix_len
&&
379 strncmp(iter
->prefix
, iter
->ref
.refname
, iter
->prefix_len
)) {
384 if (iter
->flags
& DO_FOR_EACH_PER_WORKTREE_ONLY
&&
385 parse_worktree_ref(iter
->ref
.refname
, NULL
, NULL
, NULL
) !=
386 REF_WORKTREE_CURRENT
)
389 switch (iter
->ref
.value_type
) {
390 case REFTABLE_REF_VAL1
:
391 oidread(&iter
->oid
, iter
->ref
.value
.val1
);
393 case REFTABLE_REF_VAL2
:
394 oidread(&iter
->oid
, iter
->ref
.value
.val2
.value
);
396 case REFTABLE_REF_SYMREF
:
397 if (!refs_resolve_ref_unsafe(&iter
->refs
->base
, iter
->ref
.refname
,
398 RESOLVE_REF_READING
, &iter
->oid
, &flags
))
402 BUG("unhandled reference value type %d", iter
->ref
.value_type
);
405 if (is_null_oid(&iter
->oid
))
406 flags
|= REF_ISBROKEN
;
408 if (check_refname_format(iter
->ref
.refname
, REFNAME_ALLOW_ONELEVEL
)) {
409 if (!refname_is_safe(iter
->ref
.refname
))
410 die(_("refname is dangerous: %s"), iter
->ref
.refname
);
412 flags
|= REF_BAD_NAME
| REF_ISBROKEN
;
415 if (iter
->flags
& DO_FOR_EACH_OMIT_DANGLING_SYMREFS
&&
416 flags
& REF_ISSYMREF
&&
417 flags
& REF_ISBROKEN
)
420 if (!(iter
->flags
& DO_FOR_EACH_INCLUDE_BROKEN
) &&
421 !ref_resolves_to_object(iter
->ref
.refname
, refs
->base
.repo
,
425 iter
->base
.refname
= iter
->ref
.refname
;
426 iter
->base
.oid
= &iter
->oid
;
427 iter
->base
.flags
= flags
;
433 if (ref_iterator_abort(ref_iterator
) != ITER_DONE
)
439 ref_iterator_abort(ref_iterator
);
446 static int reftable_ref_iterator_peel(struct ref_iterator
*ref_iterator
,
447 struct object_id
*peeled
)
449 struct reftable_ref_iterator
*iter
=
450 (struct reftable_ref_iterator
*)ref_iterator
;
452 if (iter
->ref
.value_type
== REFTABLE_REF_VAL2
) {
453 oidread(peeled
, iter
->ref
.value
.val2
.target_value
);
460 static int reftable_ref_iterator_abort(struct ref_iterator
*ref_iterator
)
462 struct reftable_ref_iterator
*iter
=
463 (struct reftable_ref_iterator
*)ref_iterator
;
464 reftable_ref_record_release(&iter
->ref
);
465 reftable_iterator_destroy(&iter
->iter
);
470 static struct ref_iterator_vtable reftable_ref_iterator_vtable
= {
471 .advance
= reftable_ref_iterator_advance
,
472 .peel
= reftable_ref_iterator_peel
,
473 .abort
= reftable_ref_iterator_abort
476 static struct reftable_ref_iterator
*ref_iterator_for_stack(struct reftable_ref_store
*refs
,
477 struct reftable_stack
*stack
,
481 struct reftable_merged_table
*merged_table
;
482 struct reftable_ref_iterator
*iter
;
485 iter
= xcalloc(1, sizeof(*iter
));
486 base_ref_iterator_init(&iter
->base
, &reftable_ref_iterator_vtable
);
487 iter
->prefix
= prefix
;
488 iter
->prefix_len
= prefix
? strlen(prefix
) : 0;
489 iter
->base
.oid
= &iter
->oid
;
497 ret
= reftable_stack_reload(stack
);
501 merged_table
= reftable_stack_merged_table(stack
);
503 ret
= reftable_merged_table_seek_ref(merged_table
, &iter
->iter
, prefix
);
512 static struct ref_iterator
*reftable_be_iterator_begin(struct ref_store
*ref_store
,
514 const char **exclude_patterns
,
517 struct reftable_ref_iterator
*main_iter
, *worktree_iter
;
518 struct reftable_ref_store
*refs
;
519 unsigned int required_flags
= REF_STORE_READ
;
521 if (!(flags
& DO_FOR_EACH_INCLUDE_BROKEN
))
522 required_flags
|= REF_STORE_ODB
;
523 refs
= reftable_be_downcast(ref_store
, required_flags
, "ref_iterator_begin");
525 main_iter
= ref_iterator_for_stack(refs
, refs
->main_stack
, prefix
, flags
);
528 * The worktree stack is only set when we're in an actual worktree
529 * right now. If we aren't, then we return the common reftable
532 if (!refs
->worktree_stack
)
533 return &main_iter
->base
;
536 * Otherwise we merge both the common and the per-worktree refs into a
539 worktree_iter
= ref_iterator_for_stack(refs
, refs
->worktree_stack
, prefix
, flags
);
540 return merge_ref_iterator_begin(&worktree_iter
->base
, &main_iter
->base
,
541 ref_iterator_select
, NULL
);
544 static int reftable_be_read_raw_ref(struct ref_store
*ref_store
,
546 struct object_id
*oid
,
547 struct strbuf
*referent
,
551 struct reftable_ref_store
*refs
=
552 reftable_be_downcast(ref_store
, REF_STORE_READ
, "read_raw_ref");
553 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
559 ret
= reftable_stack_reload(stack
);
563 ret
= read_ref_without_reload(stack
, refname
, oid
, referent
, type
);
567 *failure_errno
= ENOENT
;
574 static int reftable_be_read_symbolic_ref(struct ref_store
*ref_store
,
576 struct strbuf
*referent
)
578 struct reftable_ref_store
*refs
=
579 reftable_be_downcast(ref_store
, REF_STORE_READ
, "read_symbolic_ref");
580 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
581 struct reftable_ref_record ref
= {0};
584 ret
= reftable_stack_reload(stack
);
588 ret
= reftable_stack_read_ref(stack
, refname
, &ref
);
589 if (ret
== 0 && ref
.value_type
== REFTABLE_REF_SYMREF
)
590 strbuf_addstr(referent
, ref
.value
.symref
);
594 reftable_ref_record_release(&ref
);
599 * Return the refname under which update was originally requested.
601 static const char *original_update_refname(struct ref_update
*update
)
603 while (update
->parent_update
)
604 update
= update
->parent_update
;
605 return update
->refname
;
608 struct reftable_transaction_update
{
609 struct ref_update
*update
;
610 struct object_id current_oid
;
613 struct write_transaction_table_arg
{
614 struct reftable_ref_store
*refs
;
615 struct reftable_stack
*stack
;
616 struct reftable_addition
*addition
;
617 struct reftable_transaction_update
*updates
;
619 size_t updates_alloc
;
620 size_t updates_expected
;
623 struct reftable_transaction_data
{
624 struct write_transaction_table_arg
*args
;
625 size_t args_nr
, args_alloc
;
628 static void free_transaction_data(struct reftable_transaction_data
*tx_data
)
632 for (size_t i
= 0; i
< tx_data
->args_nr
; i
++) {
633 reftable_addition_destroy(tx_data
->args
[i
].addition
);
634 free(tx_data
->args
[i
].updates
);
641 * Prepare transaction update for the given reference update. This will cause
642 * us to lock the corresponding reftable stack for concurrent modification.
644 static int prepare_transaction_update(struct write_transaction_table_arg
**out
,
645 struct reftable_ref_store
*refs
,
646 struct reftable_transaction_data
*tx_data
,
647 struct ref_update
*update
,
650 struct reftable_stack
*stack
= stack_for(refs
, update
->refname
, NULL
);
651 struct write_transaction_table_arg
*arg
= NULL
;
656 * Search for a preexisting stack update. If there is one then we add
657 * the update to it, otherwise we set up a new stack update.
659 for (i
= 0; !arg
&& i
< tx_data
->args_nr
; i
++)
660 if (tx_data
->args
[i
].stack
== stack
)
661 arg
= &tx_data
->args
[i
];
664 struct reftable_addition
*addition
;
666 ret
= reftable_stack_reload(stack
);
670 ret
= reftable_stack_new_addition(&addition
, stack
);
672 if (ret
== REFTABLE_LOCK_ERROR
)
673 strbuf_addstr(err
, "cannot lock references");
677 ALLOC_GROW(tx_data
->args
, tx_data
->args_nr
+ 1,
678 tx_data
->args_alloc
);
679 arg
= &tx_data
->args
[tx_data
->args_nr
++];
682 arg
->addition
= addition
;
685 arg
->updates_alloc
= 0;
686 arg
->updates_expected
= 0;
689 arg
->updates_expected
++;
698 * Queue a reference update for the correct stack. We potentially need to
699 * handle multiple stack updates in a single transaction when it spans across
700 * multiple worktrees.
702 static int queue_transaction_update(struct reftable_ref_store
*refs
,
703 struct reftable_transaction_data
*tx_data
,
704 struct ref_update
*update
,
705 struct object_id
*current_oid
,
708 struct write_transaction_table_arg
*arg
= NULL
;
711 if (update
->backend_data
)
712 BUG("reference update queued more than once");
714 ret
= prepare_transaction_update(&arg
, refs
, tx_data
, update
, err
);
718 ALLOC_GROW(arg
->updates
, arg
->updates_nr
+ 1,
720 arg
->updates
[arg
->updates_nr
].update
= update
;
721 oidcpy(&arg
->updates
[arg
->updates_nr
].current_oid
, current_oid
);
722 update
->backend_data
= &arg
->updates
[arg
->updates_nr
++];
727 static int reftable_be_transaction_prepare(struct ref_store
*ref_store
,
728 struct ref_transaction
*transaction
,
731 struct reftable_ref_store
*refs
=
732 reftable_be_downcast(ref_store
, REF_STORE_WRITE
|REF_STORE_MAIN
, "ref_transaction_prepare");
733 struct strbuf referent
= STRBUF_INIT
, head_referent
= STRBUF_INIT
;
734 struct string_list affected_refnames
= STRING_LIST_INIT_NODUP
;
735 struct reftable_transaction_data
*tx_data
= NULL
;
736 struct object_id head_oid
;
737 unsigned int head_type
= 0;
745 tx_data
= xcalloc(1, sizeof(*tx_data
));
748 * Preprocess all updates. For one we check that there are no duplicate
749 * reference updates in this transaction. Second, we lock all stacks
750 * that will be modified during the transaction.
752 for (i
= 0; i
< transaction
->nr
; i
++) {
753 ret
= prepare_transaction_update(NULL
, refs
, tx_data
,
754 transaction
->updates
[i
], err
);
758 string_list_append(&affected_refnames
,
759 transaction
->updates
[i
]->refname
);
763 * Now that we have counted updates per stack we can preallocate their
764 * arrays. This avoids having to reallocate many times.
766 for (i
= 0; i
< tx_data
->args_nr
; i
++) {
767 CALLOC_ARRAY(tx_data
->args
[i
].updates
, tx_data
->args
[i
].updates_expected
);
768 tx_data
->args
[i
].updates_alloc
= tx_data
->args
[i
].updates_expected
;
772 * Fail if a refname appears more than once in the transaction.
773 * This code is taken from the files backend and is a good candidate to
774 * be moved into the generic layer.
776 string_list_sort(&affected_refnames
);
777 if (ref_update_reject_duplicates(&affected_refnames
, err
)) {
778 ret
= TRANSACTION_GENERIC_ERROR
;
782 ret
= read_ref_without_reload(stack_for(refs
, "HEAD", NULL
), "HEAD", &head_oid
,
783 &head_referent
, &head_type
);
788 for (i
= 0; i
< transaction
->nr
; i
++) {
789 struct ref_update
*u
= transaction
->updates
[i
];
790 struct object_id current_oid
= {0};
791 struct reftable_stack
*stack
;
792 const char *rewritten_ref
;
794 stack
= stack_for(refs
, u
->refname
, &rewritten_ref
);
796 /* Verify that the new object ID is valid. */
797 if ((u
->flags
& REF_HAVE_NEW
) && !is_null_oid(&u
->new_oid
) &&
798 !(u
->flags
& REF_SKIP_OID_VERIFICATION
) &&
799 !(u
->flags
& REF_LOG_ONLY
)) {
800 struct object
*o
= parse_object(refs
->base
.repo
, &u
->new_oid
);
803 _("trying to write ref '%s' with nonexistent object %s"),
804 u
->refname
, oid_to_hex(&u
->new_oid
));
809 if (o
->type
!= OBJ_COMMIT
&& is_branch(u
->refname
)) {
810 strbuf_addf(err
, _("trying to write non-commit object %s to branch '%s'"),
811 oid_to_hex(&u
->new_oid
), u
->refname
);
818 * When we update the reference that HEAD points to we enqueue
819 * a second log-only update for HEAD so that its reflog is
820 * updated accordingly.
822 if (head_type
== REF_ISSYMREF
&&
823 !(u
->flags
& REF_LOG_ONLY
) &&
824 !(u
->flags
& REF_UPDATE_VIA_HEAD
) &&
825 !strcmp(rewritten_ref
, head_referent
.buf
)) {
826 struct ref_update
*new_update
;
829 * First make sure that HEAD is not already in the
830 * transaction. This check is O(lg N) in the transaction
831 * size, but it happens at most once per transaction.
833 if (string_list_has_string(&affected_refnames
, "HEAD")) {
834 /* An entry already existed */
836 _("multiple updates for 'HEAD' (including one "
837 "via its referent '%s') are not allowed"),
839 ret
= TRANSACTION_NAME_CONFLICT
;
843 new_update
= ref_transaction_add_update(
845 u
->flags
| REF_LOG_ONLY
| REF_NO_DEREF
,
846 &u
->new_oid
, &u
->old_oid
, u
->msg
);
847 string_list_insert(&affected_refnames
, new_update
->refname
);
850 ret
= read_ref_without_reload(stack
, rewritten_ref
,
851 ¤t_oid
, &referent
, &u
->type
);
854 if (ret
> 0 && (!(u
->flags
& REF_HAVE_OLD
) || is_null_oid(&u
->old_oid
))) {
856 * The reference does not exist, and we either have no
857 * old object ID or expect the reference to not exist.
858 * We can thus skip below safety checks as well as the
859 * symref splitting. But we do want to verify that
860 * there is no conflicting reference here so that we
861 * can output a proper error message instead of failing
864 ret
= refs_verify_refname_available(ref_store
, u
->refname
,
865 &affected_refnames
, NULL
, err
);
870 * There is no need to write the reference deletion
871 * when the reference in question doesn't exist.
873 if (u
->flags
& REF_HAVE_NEW
&& !is_null_oid(&u
->new_oid
)) {
874 ret
= queue_transaction_update(refs
, tx_data
, u
,
883 /* The reference does not exist, but we expected it to. */
884 strbuf_addf(err
, _("cannot lock ref '%s': "
885 "unable to resolve reference '%s'"),
886 original_update_refname(u
), u
->refname
);
891 if (u
->type
& REF_ISSYMREF
) {
893 * The reftable stack is locked at this point already,
894 * so it is safe to call `refs_resolve_ref_unsafe()`
895 * here without causing races.
897 const char *resolved
= refs_resolve_ref_unsafe(&refs
->base
, u
->refname
, 0,
900 if (u
->flags
& REF_NO_DEREF
) {
901 if (u
->flags
& REF_HAVE_OLD
&& !resolved
) {
902 strbuf_addf(err
, _("cannot lock ref '%s': "
903 "error reading reference"), u
->refname
);
908 struct ref_update
*new_update
;
911 new_flags
= u
->flags
;
912 if (!strcmp(rewritten_ref
, "HEAD"))
913 new_flags
|= REF_UPDATE_VIA_HEAD
;
916 * If we are updating a symref (eg. HEAD), we should also
917 * update the branch that the symref points to.
919 * This is generic functionality, and would be better
920 * done in refs.c, but the current implementation is
921 * intertwined with the locking in files-backend.c.
923 new_update
= ref_transaction_add_update(
924 transaction
, referent
.buf
, new_flags
,
925 &u
->new_oid
, &u
->old_oid
, u
->msg
);
926 new_update
->parent_update
= u
;
929 * Change the symbolic ref update to log only. Also, it
930 * doesn't need to check its old OID value, as that will be
931 * done when new_update is processed.
933 u
->flags
|= REF_LOG_ONLY
| REF_NO_DEREF
;
934 u
->flags
&= ~REF_HAVE_OLD
;
936 if (string_list_has_string(&affected_refnames
, new_update
->refname
)) {
938 _("multiple updates for '%s' (including one "
939 "via symref '%s') are not allowed"),
940 referent
.buf
, u
->refname
);
941 ret
= TRANSACTION_NAME_CONFLICT
;
944 string_list_insert(&affected_refnames
, new_update
->refname
);
949 * Verify that the old object matches our expectations. Note
950 * that the error messages here do not make a lot of sense in
951 * the context of the reftable backend as we never lock
952 * individual refs. But the error messages match what the files
953 * backend returns, which keeps our tests happy.
955 if (u
->flags
& REF_HAVE_OLD
&& !oideq(¤t_oid
, &u
->old_oid
)) {
956 if (is_null_oid(&u
->old_oid
))
957 strbuf_addf(err
, _("cannot lock ref '%s': "
958 "reference already exists"),
959 original_update_refname(u
));
960 else if (is_null_oid(¤t_oid
))
961 strbuf_addf(err
, _("cannot lock ref '%s': "
962 "reference is missing but expected %s"),
963 original_update_refname(u
),
964 oid_to_hex(&u
->old_oid
));
966 strbuf_addf(err
, _("cannot lock ref '%s': "
967 "is at %s but expected %s"),
968 original_update_refname(u
),
969 oid_to_hex(¤t_oid
),
970 oid_to_hex(&u
->old_oid
));
976 * If all of the following conditions are true:
978 * - We're not about to write a symref.
979 * - We're not about to write a log-only entry.
980 * - Old and new object ID are different.
982 * Then we're essentially doing a no-op update that can be
983 * skipped. This is not only for the sake of efficiency, but
984 * also skips writing unneeded reflog entries.
986 if ((u
->type
& REF_ISSYMREF
) ||
987 (u
->flags
& REF_LOG_ONLY
) ||
988 (u
->flags
& REF_HAVE_NEW
&& !oideq(¤t_oid
, &u
->new_oid
))) {
989 ret
= queue_transaction_update(refs
, tx_data
, u
,
996 transaction
->backend_data
= tx_data
;
997 transaction
->state
= REF_TRANSACTION_PREPARED
;
1000 assert(ret
!= REFTABLE_API_ERROR
);
1002 free_transaction_data(tx_data
);
1003 transaction
->state
= REF_TRANSACTION_CLOSED
;
1005 strbuf_addf(err
, _("reftable: transaction prepare: %s"),
1006 reftable_error_str(ret
));
1008 string_list_clear(&affected_refnames
, 0);
1009 strbuf_release(&referent
);
1010 strbuf_release(&head_referent
);
1015 static int reftable_be_transaction_abort(struct ref_store
*ref_store
,
1016 struct ref_transaction
*transaction
,
1019 struct reftable_transaction_data
*tx_data
= transaction
->backend_data
;
1020 free_transaction_data(tx_data
);
1021 transaction
->state
= REF_TRANSACTION_CLOSED
;
1025 static int transaction_update_cmp(const void *a
, const void *b
)
1027 return strcmp(((struct reftable_transaction_update
*)a
)->update
->refname
,
1028 ((struct reftable_transaction_update
*)b
)->update
->refname
);
1031 static int write_transaction_table(struct reftable_writer
*writer
, void *cb_data
)
1033 struct write_transaction_table_arg
*arg
= cb_data
;
1034 struct reftable_merged_table
*mt
=
1035 reftable_stack_merged_table(arg
->stack
);
1036 uint64_t ts
= reftable_stack_next_update_index(arg
->stack
);
1037 struct reftable_log_record
*logs
= NULL
;
1038 size_t logs_nr
= 0, logs_alloc
= 0, i
;
1041 QSORT(arg
->updates
, arg
->updates_nr
, transaction_update_cmp
);
1043 reftable_writer_set_limits(writer
, ts
, ts
);
1045 for (i
= 0; i
< arg
->updates_nr
; i
++) {
1046 struct reftable_transaction_update
*tx_update
= &arg
->updates
[i
];
1047 struct ref_update
*u
= tx_update
->update
;
1050 * Write a reflog entry when updating a ref to point to
1051 * something new in either of the following cases:
1053 * - The reference is about to be deleted. We always want to
1054 * delete the reflog in that case.
1055 * - REF_FORCE_CREATE_REFLOG is set, asking us to always create
1057 * - `core.logAllRefUpdates` tells us to create the reflog for
1060 if (u
->flags
& REF_HAVE_NEW
&& !(u
->type
& REF_ISSYMREF
) && is_null_oid(&u
->new_oid
)) {
1061 struct reftable_log_record log
= {0};
1062 struct reftable_iterator it
= {0};
1065 * When deleting refs we also delete all reflog entries
1066 * with them. While it is not strictly required to
1067 * delete reflogs together with their refs, this
1068 * matches the behaviour of the files backend.
1070 * Unfortunately, we have no better way than to delete
1071 * all reflog entries one by one.
1073 ret
= reftable_merged_table_seek_log(mt
, &it
, u
->refname
);
1075 struct reftable_log_record
*tombstone
;
1077 ret
= reftable_iterator_next_log(&it
, &log
);
1080 if (ret
> 0 || strcmp(log
.refname
, u
->refname
)) {
1085 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1086 tombstone
= &logs
[logs_nr
++];
1087 tombstone
->refname
= xstrdup(u
->refname
);
1088 tombstone
->value_type
= REFTABLE_LOG_DELETION
;
1089 tombstone
->update_index
= log
.update_index
;
1092 reftable_log_record_release(&log
);
1093 reftable_iterator_destroy(&it
);
1097 } else if (u
->flags
& REF_HAVE_NEW
&&
1098 (u
->flags
& REF_FORCE_CREATE_REFLOG
||
1099 should_write_log(&arg
->refs
->base
, u
->refname
))) {
1100 struct reftable_log_record
*log
;
1102 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1103 log
= &logs
[logs_nr
++];
1104 memset(log
, 0, sizeof(*log
));
1106 fill_reftable_log_record(log
);
1107 log
->update_index
= ts
;
1108 log
->refname
= xstrdup(u
->refname
);
1109 log
->value
.update
.new_hash
= u
->new_oid
.hash
;
1110 log
->value
.update
.old_hash
= tx_update
->current_oid
.hash
;
1111 log
->value
.update
.message
=
1112 xstrndup(u
->msg
, arg
->refs
->write_options
.block_size
/ 2);
1115 if (u
->flags
& REF_LOG_ONLY
)
1118 if (u
->flags
& REF_HAVE_NEW
&& is_null_oid(&u
->new_oid
)) {
1119 struct reftable_ref_record ref
= {
1120 .refname
= (char *)u
->refname
,
1122 .value_type
= REFTABLE_REF_DELETION
,
1125 ret
= reftable_writer_add_ref(writer
, &ref
);
1128 } else if (u
->flags
& REF_HAVE_NEW
) {
1129 struct reftable_ref_record ref
= {0};
1130 struct object_id peeled
;
1133 ref
.refname
= (char *)u
->refname
;
1134 ref
.update_index
= ts
;
1136 peel_error
= peel_object(&u
->new_oid
, &peeled
);
1138 ref
.value_type
= REFTABLE_REF_VAL2
;
1139 memcpy(ref
.value
.val2
.target_value
, peeled
.hash
, GIT_MAX_RAWSZ
);
1140 memcpy(ref
.value
.val2
.value
, u
->new_oid
.hash
, GIT_MAX_RAWSZ
);
1141 } else if (!is_null_oid(&u
->new_oid
)) {
1142 ref
.value_type
= REFTABLE_REF_VAL1
;
1143 memcpy(ref
.value
.val1
, u
->new_oid
.hash
, GIT_MAX_RAWSZ
);
1146 ret
= reftable_writer_add_ref(writer
, &ref
);
1153 * Logs are written at the end so that we do not have intermixed ref
1157 ret
= reftable_writer_add_logs(writer
, logs
, logs_nr
);
1163 assert(ret
!= REFTABLE_API_ERROR
);
1164 for (i
= 0; i
< logs_nr
; i
++)
1165 clear_reftable_log_record(&logs
[i
]);
1170 static int reftable_be_transaction_finish(struct ref_store
*ref_store
,
1171 struct ref_transaction
*transaction
,
1174 struct reftable_transaction_data
*tx_data
= transaction
->backend_data
;
1177 for (size_t i
= 0; i
< tx_data
->args_nr
; i
++) {
1178 ret
= reftable_addition_add(tx_data
->args
[i
].addition
,
1179 write_transaction_table
, &tx_data
->args
[i
]);
1183 ret
= reftable_addition_commit(tx_data
->args
[i
].addition
);
1189 assert(ret
!= REFTABLE_API_ERROR
);
1190 free_transaction_data(tx_data
);
1191 transaction
->state
= REF_TRANSACTION_CLOSED
;
1194 strbuf_addf(err
, _("reftable: transaction failure: %s"),
1195 reftable_error_str(ret
));
1201 static int reftable_be_initial_transaction_commit(struct ref_store
*ref_store UNUSED
,
1202 struct ref_transaction
*transaction
,
1205 return ref_transaction_commit(transaction
, err
);
1208 static int reftable_be_pack_refs(struct ref_store
*ref_store
,
1209 struct pack_refs_opts
*opts
)
1211 struct reftable_ref_store
*refs
=
1212 reftable_be_downcast(ref_store
, REF_STORE_WRITE
| REF_STORE_ODB
, "pack_refs");
1213 struct reftable_stack
*stack
;
1219 stack
= refs
->worktree_stack
;
1221 stack
= refs
->main_stack
;
1223 ret
= reftable_stack_compact_all(stack
, NULL
);
1226 ret
= reftable_stack_clean(stack
);
1234 struct write_create_symref_arg
{
1235 struct reftable_ref_store
*refs
;
1236 struct reftable_stack
*stack
;
1237 const char *refname
;
1242 static int write_create_symref_table(struct reftable_writer
*writer
, void *cb_data
)
1244 struct write_create_symref_arg
*create
= cb_data
;
1245 uint64_t ts
= reftable_stack_next_update_index(create
->stack
);
1246 struct reftable_ref_record ref
= {
1247 .refname
= (char *)create
->refname
,
1248 .value_type
= REFTABLE_REF_SYMREF
,
1249 .value
.symref
= (char *)create
->target
,
1252 struct reftable_log_record log
= {0};
1253 struct object_id new_oid
;
1254 struct object_id old_oid
;
1257 reftable_writer_set_limits(writer
, ts
, ts
);
1259 ret
= reftable_writer_add_ref(writer
, &ref
);
1264 * Note that it is important to try and resolve the reference before we
1265 * write the log entry. This is because `should_write_log()` will munge
1266 * `core.logAllRefUpdates`, which is undesirable when we create a new
1267 * repository because it would be written into the config. As HEAD will
1268 * not resolve for new repositories this ordering will ensure that this
1271 if (!create
->logmsg
||
1272 !refs_resolve_ref_unsafe(&create
->refs
->base
, create
->target
,
1273 RESOLVE_REF_READING
, &new_oid
, NULL
) ||
1274 !should_write_log(&create
->refs
->base
, create
->refname
))
1277 fill_reftable_log_record(&log
);
1278 log
.refname
= xstrdup(create
->refname
);
1279 log
.update_index
= ts
;
1280 log
.value
.update
.message
= xstrndup(create
->logmsg
,
1281 create
->refs
->write_options
.block_size
/ 2);
1282 log
.value
.update
.new_hash
= new_oid
.hash
;
1283 if (refs_resolve_ref_unsafe(&create
->refs
->base
, create
->refname
,
1284 RESOLVE_REF_READING
, &old_oid
, NULL
))
1285 log
.value
.update
.old_hash
= old_oid
.hash
;
1287 ret
= reftable_writer_add_log(writer
, &log
);
1288 clear_reftable_log_record(&log
);
1292 static int reftable_be_create_symref(struct ref_store
*ref_store
,
1293 const char *refname
,
1297 struct reftable_ref_store
*refs
=
1298 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "create_symref");
1299 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
1300 struct write_create_symref_arg arg
= {
1313 ret
= reftable_stack_reload(stack
);
1317 ret
= reftable_stack_add(stack
, &write_create_symref_table
, &arg
);
1320 assert(ret
!= REFTABLE_API_ERROR
);
1322 error("unable to write symref for %s: %s", refname
,
1323 reftable_error_str(ret
));
1327 struct write_copy_arg
{
1328 struct reftable_ref_store
*refs
;
1329 struct reftable_stack
*stack
;
1330 const char *oldname
;
1331 const char *newname
;
1336 static int write_copy_table(struct reftable_writer
*writer
, void *cb_data
)
1338 struct write_copy_arg
*arg
= cb_data
;
1339 uint64_t deletion_ts
, creation_ts
;
1340 struct reftable_merged_table
*mt
= reftable_stack_merged_table(arg
->stack
);
1341 struct reftable_ref_record old_ref
= {0}, refs
[2] = {0};
1342 struct reftable_log_record old_log
= {0}, *logs
= NULL
;
1343 struct reftable_iterator it
= {0};
1344 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1345 struct strbuf errbuf
= STRBUF_INIT
;
1346 size_t logs_nr
= 0, logs_alloc
= 0, i
;
1349 if (reftable_stack_read_ref(arg
->stack
, arg
->oldname
, &old_ref
)) {
1350 ret
= error(_("refname %s not found"), arg
->oldname
);
1353 if (old_ref
.value_type
== REFTABLE_REF_SYMREF
) {
1354 ret
= error(_("refname %s is a symbolic ref, copying it is not supported"),
1360 * There's nothing to do in case the old and new name are the same, so
1361 * we exit early in that case.
1363 if (!strcmp(arg
->oldname
, arg
->newname
)) {
1369 * Verify that the new refname is available.
1371 string_list_insert(&skip
, arg
->oldname
);
1372 ret
= refs_verify_refname_available(&arg
->refs
->base
, arg
->newname
,
1373 NULL
, &skip
, &errbuf
);
1375 error("%s", errbuf
.buf
);
1380 * When deleting the old reference we have to use two update indices:
1381 * once to delete the old ref and its reflog, and once to create the
1382 * new ref and its reflog. They need to be staged with two separate
1383 * indices because the new reflog needs to encode both the deletion of
1384 * the old branch and the creation of the new branch, and we cannot do
1385 * two changes to a reflog in a single update.
1387 deletion_ts
= creation_ts
= reftable_stack_next_update_index(arg
->stack
);
1388 if (arg
->delete_old
)
1390 reftable_writer_set_limits(writer
, deletion_ts
, creation_ts
);
1393 * Add the new reference. If this is a rename then we also delete the
1397 refs
[0].refname
= (char *)arg
->newname
;
1398 refs
[0].update_index
= creation_ts
;
1399 if (arg
->delete_old
) {
1400 refs
[1].refname
= (char *)arg
->oldname
;
1401 refs
[1].value_type
= REFTABLE_REF_DELETION
;
1402 refs
[1].update_index
= deletion_ts
;
1404 ret
= reftable_writer_add_refs(writer
, refs
, arg
->delete_old
? 2 : 1);
1409 * When deleting the old branch we need to create a reflog entry on the
1410 * new branch name that indicates that the old branch has been deleted
1411 * and then recreated. This is a tad weird, but matches what the files
1414 if (arg
->delete_old
) {
1415 struct strbuf head_referent
= STRBUF_INIT
;
1416 struct object_id head_oid
;
1417 int append_head_reflog
;
1418 unsigned head_type
= 0;
1420 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1421 memset(&logs
[logs_nr
], 0, sizeof(logs
[logs_nr
]));
1422 fill_reftable_log_record(&logs
[logs_nr
]);
1423 logs
[logs_nr
].refname
= (char *)arg
->newname
;
1424 logs
[logs_nr
].update_index
= deletion_ts
;
1425 logs
[logs_nr
].value
.update
.message
=
1426 xstrndup(arg
->logmsg
, arg
->refs
->write_options
.block_size
/ 2);
1427 logs
[logs_nr
].value
.update
.old_hash
= old_ref
.value
.val1
;
1430 ret
= read_ref_without_reload(arg
->stack
, "HEAD", &head_oid
, &head_referent
, &head_type
);
1433 append_head_reflog
= (head_type
& REF_ISSYMREF
) && !strcmp(head_referent
.buf
, arg
->oldname
);
1434 strbuf_release(&head_referent
);
1437 * The files backend uses `refs_delete_ref()` to delete the old
1438 * branch name, which will append a reflog entry for HEAD in
1439 * case it points to the old branch.
1441 if (append_head_reflog
) {
1442 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1443 logs
[logs_nr
] = logs
[logs_nr
- 1];
1444 logs
[logs_nr
].refname
= "HEAD";
1450 * Create the reflog entry for the newly created branch.
1452 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1453 memset(&logs
[logs_nr
], 0, sizeof(logs
[logs_nr
]));
1454 fill_reftable_log_record(&logs
[logs_nr
]);
1455 logs
[logs_nr
].refname
= (char *)arg
->newname
;
1456 logs
[logs_nr
].update_index
= creation_ts
;
1457 logs
[logs_nr
].value
.update
.message
=
1458 xstrndup(arg
->logmsg
, arg
->refs
->write_options
.block_size
/ 2);
1459 logs
[logs_nr
].value
.update
.new_hash
= old_ref
.value
.val1
;
1463 * In addition to writing the reflog entry for the new branch, we also
1464 * copy over all log entries from the old reflog. Last but not least,
1465 * when renaming we also have to delete all the old reflog entries.
1467 ret
= reftable_merged_table_seek_log(mt
, &it
, arg
->oldname
);
1472 ret
= reftable_iterator_next_log(&it
, &old_log
);
1475 if (ret
> 0 || strcmp(old_log
.refname
, arg
->oldname
)) {
1480 free(old_log
.refname
);
1483 * Copy over the old reflog entry with the new refname.
1485 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1486 logs
[logs_nr
] = old_log
;
1487 logs
[logs_nr
].refname
= (char *)arg
->newname
;
1491 * Delete the old reflog entry in case we are renaming.
1493 if (arg
->delete_old
) {
1494 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1495 memset(&logs
[logs_nr
], 0, sizeof(logs
[logs_nr
]));
1496 logs
[logs_nr
].refname
= (char *)arg
->oldname
;
1497 logs
[logs_nr
].value_type
= REFTABLE_LOG_DELETION
;
1498 logs
[logs_nr
].update_index
= old_log
.update_index
;
1503 * Transfer ownership of the log record we're iterating over to
1504 * the array of log records. Otherwise, the pointers would get
1505 * free'd or reallocated by the iterator.
1507 memset(&old_log
, 0, sizeof(old_log
));
1510 ret
= reftable_writer_add_logs(writer
, logs
, logs_nr
);
1515 assert(ret
!= REFTABLE_API_ERROR
);
1516 reftable_iterator_destroy(&it
);
1517 string_list_clear(&skip
, 0);
1518 strbuf_release(&errbuf
);
1519 for (i
= 0; i
< logs_nr
; i
++) {
1520 if (!strcmp(logs
[i
].refname
, "HEAD"))
1522 if (logs
[i
].value
.update
.old_hash
== old_ref
.value
.val1
)
1523 logs
[i
].value
.update
.old_hash
= NULL
;
1524 if (logs
[i
].value
.update
.new_hash
== old_ref
.value
.val1
)
1525 logs
[i
].value
.update
.new_hash
= NULL
;
1526 logs
[i
].refname
= NULL
;
1527 reftable_log_record_release(&logs
[i
]);
1530 reftable_ref_record_release(&old_ref
);
1531 reftable_log_record_release(&old_log
);
1535 static int reftable_be_rename_ref(struct ref_store
*ref_store
,
1536 const char *oldrefname
,
1537 const char *newrefname
,
1540 struct reftable_ref_store
*refs
=
1541 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "rename_ref");
1542 struct reftable_stack
*stack
= stack_for(refs
, newrefname
, &newrefname
);
1543 struct write_copy_arg arg
= {
1546 .oldname
= oldrefname
,
1547 .newname
= newrefname
,
1557 ret
= reftable_stack_reload(stack
);
1560 ret
= reftable_stack_add(stack
, &write_copy_table
, &arg
);
1563 assert(ret
!= REFTABLE_API_ERROR
);
1567 static int reftable_be_copy_ref(struct ref_store
*ref_store
,
1568 const char *oldrefname
,
1569 const char *newrefname
,
1572 struct reftable_ref_store
*refs
=
1573 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "copy_ref");
1574 struct reftable_stack
*stack
= stack_for(refs
, newrefname
, &newrefname
);
1575 struct write_copy_arg arg
= {
1578 .oldname
= oldrefname
,
1579 .newname
= newrefname
,
1588 ret
= reftable_stack_reload(stack
);
1591 ret
= reftable_stack_add(stack
, &write_copy_table
, &arg
);
1594 assert(ret
!= REFTABLE_API_ERROR
);
1598 struct reftable_reflog_iterator
{
1599 struct ref_iterator base
;
1600 struct reftable_ref_store
*refs
;
1601 struct reftable_iterator iter
;
1602 struct reftable_log_record log
;
1607 static int reftable_reflog_iterator_advance(struct ref_iterator
*ref_iterator
)
1609 struct reftable_reflog_iterator
*iter
=
1610 (struct reftable_reflog_iterator
*)ref_iterator
;
1612 while (!iter
->err
) {
1613 iter
->err
= reftable_iterator_next_log(&iter
->iter
, &iter
->log
);
1618 * We want the refnames that we have reflogs for, so we skip if
1619 * we've already produced this name. This could be faster by
1620 * seeking directly to reflog@update_index==0.
1622 if (iter
->last_name
&& !strcmp(iter
->log
.refname
, iter
->last_name
))
1625 if (check_refname_format(iter
->log
.refname
,
1626 REFNAME_ALLOW_ONELEVEL
))
1629 free(iter
->last_name
);
1630 iter
->last_name
= xstrdup(iter
->log
.refname
);
1631 iter
->base
.refname
= iter
->log
.refname
;
1636 if (iter
->err
> 0) {
1637 if (ref_iterator_abort(ref_iterator
) != ITER_DONE
)
1642 if (iter
->err
< 0) {
1643 ref_iterator_abort(ref_iterator
);
1650 static int reftable_reflog_iterator_peel(struct ref_iterator
*ref_iterator
,
1651 struct object_id
*peeled
)
1653 BUG("reftable reflog iterator cannot be peeled");
1657 static int reftable_reflog_iterator_abort(struct ref_iterator
*ref_iterator
)
1659 struct reftable_reflog_iterator
*iter
=
1660 (struct reftable_reflog_iterator
*)ref_iterator
;
1661 reftable_log_record_release(&iter
->log
);
1662 reftable_iterator_destroy(&iter
->iter
);
1663 free(iter
->last_name
);
1668 static struct ref_iterator_vtable reftable_reflog_iterator_vtable
= {
1669 .advance
= reftable_reflog_iterator_advance
,
1670 .peel
= reftable_reflog_iterator_peel
,
1671 .abort
= reftable_reflog_iterator_abort
1674 static struct reftable_reflog_iterator
*reflog_iterator_for_stack(struct reftable_ref_store
*refs
,
1675 struct reftable_stack
*stack
)
1677 struct reftable_merged_table
*merged_table
;
1678 struct reftable_reflog_iterator
*iter
;
1681 iter
= xcalloc(1, sizeof(*iter
));
1682 base_ref_iterator_init(&iter
->base
, &reftable_reflog_iterator_vtable
);
1689 ret
= reftable_stack_reload(refs
->main_stack
);
1693 merged_table
= reftable_stack_merged_table(stack
);
1695 ret
= reftable_merged_table_seek_log(merged_table
, &iter
->iter
, "");
1704 static struct ref_iterator
*reftable_be_reflog_iterator_begin(struct ref_store
*ref_store
)
1706 struct reftable_ref_store
*refs
=
1707 reftable_be_downcast(ref_store
, REF_STORE_READ
, "reflog_iterator_begin");
1708 struct reftable_reflog_iterator
*main_iter
, *worktree_iter
;
1710 main_iter
= reflog_iterator_for_stack(refs
, refs
->main_stack
);
1711 if (!refs
->worktree_stack
)
1712 return &main_iter
->base
;
1714 worktree_iter
= reflog_iterator_for_stack(refs
, refs
->worktree_stack
);
1716 return merge_ref_iterator_begin(&worktree_iter
->base
, &main_iter
->base
,
1717 ref_iterator_select
, NULL
);
1720 static int yield_log_record(struct reftable_log_record
*log
,
1721 each_reflog_ent_fn fn
,
1724 struct object_id old_oid
, new_oid
;
1725 const char *full_committer
;
1727 oidread(&old_oid
, log
->value
.update
.old_hash
);
1728 oidread(&new_oid
, log
->value
.update
.new_hash
);
1731 * When both the old object ID and the new object ID are null
1732 * then this is the reflog existence marker. The caller must
1733 * not be aware of it.
1735 if (is_null_oid(&old_oid
) && is_null_oid(&new_oid
))
1738 full_committer
= fmt_ident(log
->value
.update
.name
, log
->value
.update
.email
,
1739 WANT_COMMITTER_IDENT
, NULL
, IDENT_NO_DATE
);
1740 return fn(&old_oid
, &new_oid
, full_committer
,
1741 log
->value
.update
.time
, log
->value
.update
.tz_offset
,
1742 log
->value
.update
.message
, cb_data
);
1745 static int reftable_be_for_each_reflog_ent_reverse(struct ref_store
*ref_store
,
1746 const char *refname
,
1747 each_reflog_ent_fn fn
,
1750 struct reftable_ref_store
*refs
=
1751 reftable_be_downcast(ref_store
, REF_STORE_READ
, "for_each_reflog_ent_reverse");
1752 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
1753 struct reftable_merged_table
*mt
= NULL
;
1754 struct reftable_log_record log
= {0};
1755 struct reftable_iterator it
= {0};
1761 mt
= reftable_stack_merged_table(stack
);
1762 ret
= reftable_merged_table_seek_log(mt
, &it
, refname
);
1764 ret
= reftable_iterator_next_log(&it
, &log
);
1767 if (ret
> 0 || strcmp(log
.refname
, refname
)) {
1772 ret
= yield_log_record(&log
, fn
, cb_data
);
1777 reftable_log_record_release(&log
);
1778 reftable_iterator_destroy(&it
);
1782 static int reftable_be_for_each_reflog_ent(struct ref_store
*ref_store
,
1783 const char *refname
,
1784 each_reflog_ent_fn fn
,
1787 struct reftable_ref_store
*refs
=
1788 reftable_be_downcast(ref_store
, REF_STORE_READ
, "for_each_reflog_ent");
1789 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
1790 struct reftable_merged_table
*mt
= NULL
;
1791 struct reftable_log_record
*logs
= NULL
;
1792 struct reftable_iterator it
= {0};
1793 size_t logs_alloc
= 0, logs_nr
= 0, i
;
1799 mt
= reftable_stack_merged_table(stack
);
1800 ret
= reftable_merged_table_seek_log(mt
, &it
, refname
);
1802 struct reftable_log_record log
= {0};
1804 ret
= reftable_iterator_next_log(&it
, &log
);
1807 if (ret
> 0 || strcmp(log
.refname
, refname
)) {
1808 reftable_log_record_release(&log
);
1813 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
1814 logs
[logs_nr
++] = log
;
1817 for (i
= logs_nr
; i
--;) {
1818 ret
= yield_log_record(&logs
[i
], fn
, cb_data
);
1824 reftable_iterator_destroy(&it
);
1825 for (i
= 0; i
< logs_nr
; i
++)
1826 reftable_log_record_release(&logs
[i
]);
1831 static int reftable_be_reflog_exists(struct ref_store
*ref_store
,
1832 const char *refname
)
1834 struct reftable_ref_store
*refs
=
1835 reftable_be_downcast(ref_store
, REF_STORE_READ
, "reflog_exists");
1836 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
1837 struct reftable_merged_table
*mt
= reftable_stack_merged_table(stack
);
1838 struct reftable_log_record log
= {0};
1839 struct reftable_iterator it
= {0};
1846 ret
= reftable_stack_reload(stack
);
1850 ret
= reftable_merged_table_seek_log(mt
, &it
, refname
);
1855 * Check whether we get at least one log record for the given ref name.
1856 * If so, the reflog exists, otherwise it doesn't.
1858 ret
= reftable_iterator_next_log(&it
, &log
);
1866 ret
= strcmp(log
.refname
, refname
) == 0;
1869 reftable_iterator_destroy(&it
);
1870 reftable_log_record_release(&log
);
1876 struct write_reflog_existence_arg
{
1877 struct reftable_ref_store
*refs
;
1878 const char *refname
;
1879 struct reftable_stack
*stack
;
1882 static int write_reflog_existence_table(struct reftable_writer
*writer
,
1885 struct write_reflog_existence_arg
*arg
= cb_data
;
1886 uint64_t ts
= reftable_stack_next_update_index(arg
->stack
);
1887 struct reftable_log_record log
= {0};
1890 ret
= reftable_stack_read_log(arg
->stack
, arg
->refname
, &log
);
1894 reftable_writer_set_limits(writer
, ts
, ts
);
1897 * The existence entry has both old and new object ID set to the the
1898 * null object ID. Our iterators are aware of this and will not present
1899 * them to their callers.
1901 log
.refname
= xstrdup(arg
->refname
);
1902 log
.update_index
= ts
;
1903 log
.value_type
= REFTABLE_LOG_UPDATE
;
1904 ret
= reftable_writer_add_log(writer
, &log
);
1907 assert(ret
!= REFTABLE_API_ERROR
);
1908 reftable_log_record_release(&log
);
1912 static int reftable_be_create_reflog(struct ref_store
*ref_store
,
1913 const char *refname
,
1914 struct strbuf
*errmsg
)
1916 struct reftable_ref_store
*refs
=
1917 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "create_reflog");
1918 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
1919 struct write_reflog_existence_arg arg
= {
1930 ret
= reftable_stack_reload(stack
);
1934 ret
= reftable_stack_add(stack
, &write_reflog_existence_table
, &arg
);
1940 struct write_reflog_delete_arg
{
1941 struct reftable_stack
*stack
;
1942 const char *refname
;
1945 static int write_reflog_delete_table(struct reftable_writer
*writer
, void *cb_data
)
1947 struct write_reflog_delete_arg
*arg
= cb_data
;
1948 struct reftable_merged_table
*mt
=
1949 reftable_stack_merged_table(arg
->stack
);
1950 struct reftable_log_record log
= {0}, tombstone
= {0};
1951 struct reftable_iterator it
= {0};
1952 uint64_t ts
= reftable_stack_next_update_index(arg
->stack
);
1955 reftable_writer_set_limits(writer
, ts
, ts
);
1958 * In order to delete a table we need to delete all reflog entries one
1959 * by one. This is inefficient, but the reftable format does not have a
1960 * better marker right now.
1962 ret
= reftable_merged_table_seek_log(mt
, &it
, arg
->refname
);
1964 ret
= reftable_iterator_next_log(&it
, &log
);
1967 if (ret
> 0 || strcmp(log
.refname
, arg
->refname
)) {
1972 tombstone
.refname
= (char *)arg
->refname
;
1973 tombstone
.value_type
= REFTABLE_LOG_DELETION
;
1974 tombstone
.update_index
= log
.update_index
;
1976 ret
= reftable_writer_add_log(writer
, &tombstone
);
1979 reftable_log_record_release(&log
);
1980 reftable_iterator_destroy(&it
);
1984 static int reftable_be_delete_reflog(struct ref_store
*ref_store
,
1985 const char *refname
)
1987 struct reftable_ref_store
*refs
=
1988 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "delete_reflog");
1989 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
1990 struct write_reflog_delete_arg arg
= {
1996 ret
= reftable_stack_reload(stack
);
1999 ret
= reftable_stack_add(stack
, &write_reflog_delete_table
, &arg
);
2001 assert(ret
!= REFTABLE_API_ERROR
);
2005 struct reflog_expiry_arg
{
2006 struct reftable_stack
*stack
;
2007 struct reftable_log_record
*records
;
2008 struct object_id update_oid
;
2009 const char *refname
;
2013 static int write_reflog_expiry_table(struct reftable_writer
*writer
, void *cb_data
)
2015 struct reflog_expiry_arg
*arg
= cb_data
;
2016 uint64_t ts
= reftable_stack_next_update_index(arg
->stack
);
2017 uint64_t live_records
= 0;
2021 for (i
= 0; i
< arg
->len
; i
++)
2022 if (arg
->records
[i
].value_type
== REFTABLE_LOG_UPDATE
)
2025 reftable_writer_set_limits(writer
, ts
, ts
);
2027 if (!is_null_oid(&arg
->update_oid
)) {
2028 struct reftable_ref_record ref
= {0};
2029 struct object_id peeled
;
2031 ref
.refname
= (char *)arg
->refname
;
2032 ref
.update_index
= ts
;
2034 if (!peel_object(&arg
->update_oid
, &peeled
)) {
2035 ref
.value_type
= REFTABLE_REF_VAL2
;
2036 memcpy(ref
.value
.val2
.target_value
, peeled
.hash
, GIT_MAX_RAWSZ
);
2037 memcpy(ref
.value
.val2
.value
, arg
->update_oid
.hash
, GIT_MAX_RAWSZ
);
2039 ref
.value_type
= REFTABLE_REF_VAL1
;
2040 memcpy(ref
.value
.val1
, arg
->update_oid
.hash
, GIT_MAX_RAWSZ
);
2043 ret
= reftable_writer_add_ref(writer
, &ref
);
2049 * When there are no more entries left in the reflog we empty it
2050 * completely, but write a placeholder reflog entry that indicates that
2051 * the reflog still exists.
2053 if (!live_records
) {
2054 struct reftable_log_record log
= {
2055 .refname
= (char *)arg
->refname
,
2056 .value_type
= REFTABLE_LOG_UPDATE
,
2060 ret
= reftable_writer_add_log(writer
, &log
);
2065 for (i
= 0; i
< arg
->len
; i
++) {
2066 ret
= reftable_writer_add_log(writer
, &arg
->records
[i
]);
2074 static int reftable_be_reflog_expire(struct ref_store
*ref_store
,
2075 const char *refname
,
2077 reflog_expiry_prepare_fn prepare_fn
,
2078 reflog_expiry_should_prune_fn should_prune_fn
,
2079 reflog_expiry_cleanup_fn cleanup_fn
,
2080 void *policy_cb_data
)
2083 * For log expiry, we write tombstones for every single reflog entry
2084 * that is to be expired. This means that the entries are still
2085 * retrievable by delving into the stack, and expiring entries
2086 * paradoxically takes extra memory. This memory is only reclaimed when
2087 * compacting the reftable stack.
2089 * It would be better if the refs backend supported an API that sets a
2090 * criterion for all refs, passing the criterion to pack_refs().
2092 * On the plus side, because we do the expiration per ref, we can easily
2093 * insert the reflog existence dummies.
2095 struct reftable_ref_store
*refs
=
2096 reftable_be_downcast(ref_store
, REF_STORE_WRITE
, "reflog_expire");
2097 struct reftable_stack
*stack
= stack_for(refs
, refname
, &refname
);
2098 struct reftable_merged_table
*mt
= reftable_stack_merged_table(stack
);
2099 struct reftable_log_record
*logs
= NULL
;
2100 struct reftable_log_record
*rewritten
= NULL
;
2101 struct reftable_ref_record ref_record
= {0};
2102 struct reftable_iterator it
= {0};
2103 struct reftable_addition
*add
= NULL
;
2104 struct reflog_expiry_arg arg
= {0};
2105 struct object_id oid
= {0};
2106 uint8_t *last_hash
= NULL
;
2107 size_t logs_nr
= 0, logs_alloc
= 0, i
;
2113 ret
= reftable_stack_reload(stack
);
2117 ret
= reftable_merged_table_seek_log(mt
, &it
, refname
);
2121 ret
= reftable_stack_new_addition(&add
, stack
);
2125 ret
= reftable_stack_read_ref(stack
, refname
, &ref_record
);
2128 if (reftable_ref_record_val1(&ref_record
))
2129 oidread(&oid
, reftable_ref_record_val1(&ref_record
));
2130 prepare_fn(refname
, &oid
, policy_cb_data
);
2133 struct reftable_log_record log
= {0};
2134 struct object_id old_oid
, new_oid
;
2136 ret
= reftable_iterator_next_log(&it
, &log
);
2139 if (ret
> 0 || strcmp(log
.refname
, refname
)) {
2140 reftable_log_record_release(&log
);
2144 oidread(&old_oid
, log
.value
.update
.old_hash
);
2145 oidread(&new_oid
, log
.value
.update
.new_hash
);
2148 * Skip over the reflog existence marker. We will add it back
2149 * in when there are no live reflog records.
2151 if (is_null_oid(&old_oid
) && is_null_oid(&new_oid
)) {
2152 reftable_log_record_release(&log
);
2156 ALLOC_GROW(logs
, logs_nr
+ 1, logs_alloc
);
2157 logs
[logs_nr
++] = log
;
2161 * We need to rewrite all reflog entries according to the pruning
2162 * callback function:
2164 * - If a reflog entry shall be pruned we mark the record for
2167 * - Otherwise we may have to rewrite the chain of reflog entries so
2168 * that gaps created by just-deleted records get backfilled.
2170 CALLOC_ARRAY(rewritten
, logs_nr
);
2171 for (i
= logs_nr
; i
--;) {
2172 struct reftable_log_record
*dest
= &rewritten
[i
];
2173 struct object_id old_oid
, new_oid
;
2176 oidread(&old_oid
, logs
[i
].value
.update
.old_hash
);
2177 oidread(&new_oid
, logs
[i
].value
.update
.new_hash
);
2179 if (should_prune_fn(&old_oid
, &new_oid
, logs
[i
].value
.update
.email
,
2180 (timestamp_t
)logs
[i
].value
.update
.time
,
2181 logs
[i
].value
.update
.tz_offset
,
2182 logs
[i
].value
.update
.message
,
2184 dest
->value_type
= REFTABLE_LOG_DELETION
;
2186 if ((flags
& EXPIRE_REFLOGS_REWRITE
) && last_hash
)
2187 dest
->value
.update
.old_hash
= last_hash
;
2188 last_hash
= logs
[i
].value
.update
.new_hash
;
2192 if (flags
& EXPIRE_REFLOGS_UPDATE_REF
&& last_hash
&&
2193 reftable_ref_record_val1(&ref_record
))
2194 oidread(&arg
.update_oid
, last_hash
);
2196 arg
.records
= rewritten
;
2199 arg
.refname
= refname
,
2201 ret
= reftable_addition_add(add
, &write_reflog_expiry_table
, &arg
);
2206 * Future improvement: we could skip writing records that were
2209 if (!(flags
& EXPIRE_REFLOGS_DRY_RUN
))
2210 ret
= reftable_addition_commit(add
);
2214 cleanup_fn(policy_cb_data
);
2215 assert(ret
!= REFTABLE_API_ERROR
);
2217 reftable_ref_record_release(&ref_record
);
2218 reftable_iterator_destroy(&it
);
2219 reftable_addition_destroy(add
);
2220 for (i
= 0; i
< logs_nr
; i
++)
2221 reftable_log_record_release(&logs
[i
]);
2227 struct ref_storage_be refs_be_reftable
= {
2229 .init
= reftable_be_init
,
2230 .init_db
= reftable_be_init_db
,
2231 .transaction_prepare
= reftable_be_transaction_prepare
,
2232 .transaction_finish
= reftable_be_transaction_finish
,
2233 .transaction_abort
= reftable_be_transaction_abort
,
2234 .initial_transaction_commit
= reftable_be_initial_transaction_commit
,
2236 .pack_refs
= reftable_be_pack_refs
,
2237 .create_symref
= reftable_be_create_symref
,
2238 .rename_ref
= reftable_be_rename_ref
,
2239 .copy_ref
= reftable_be_copy_ref
,
2241 .iterator_begin
= reftable_be_iterator_begin
,
2242 .read_raw_ref
= reftable_be_read_raw_ref
,
2243 .read_symbolic_ref
= reftable_be_read_symbolic_ref
,
2245 .reflog_iterator_begin
= reftable_be_reflog_iterator_begin
,
2246 .for_each_reflog_ent
= reftable_be_for_each_reflog_ent
,
2247 .for_each_reflog_ent_reverse
= reftable_be_for_each_reflog_ent_reverse
,
2248 .reflog_exists
= reftable_be_reflog_exists
,
2249 .create_reflog
= reftable_be_create_reflog
,
2250 .delete_reflog
= reftable_be_delete_reflog
,
2251 .reflog_expire
= reftable_be_reflog_expire
,