Re: [PATCH v2 8/9] refs: add peeled object ID to the `ref_update` struct
Karthik Nayak <karthik.188@gmail.com> writes:
> Certain reference backend {packed, reftable}, have the ability to alsoShouldn't it be:
Certain reference backends {packed, reftable} have the ability to alsoShow 46 quoted lines
> store the peeled object ID for a reference pointing to a tag object.
> This has the added benefit that during retrieval of such references, we
> also obtain the peeled object ID without having to use the ODB.
>
> To provide this functionality, each backend independently calls the ODB
> to obtain the peeled OID. To move this functionality to the generic
> layer, there must be support infrastructure to pass in a peeled OID for
> reference updates.
>
> Add a `peeled` field to the `ref_update` structure and modify
> `ref_transaction_add_update()` to receive and copy this object ID to the
> `ref_update` structure. Finally, modify `ref_transaction_update()` to
> peel tag objects and pass the peeled OID to
> `ref_transaction_add_update()`.
>
> Update all callers of these functions with the new function parameters.
> Callers which only add reflog updates, need to only pass in NULL, since
> for reflogs, we don't store peeled OIDs. Reference deletions also only
> need to pass in NULL. For others, pass along the peeled OID if
> available.
>
> In a following commit, we'll modify the backends to use this peeled OID
> instead of parsing it themselves.
>
> Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
> ---
> refs.c | 15 +++++++++++++--
> refs/files-backend.c | 20 ++++++++++++--------
> refs/refs-internal.h | 14 ++++++++++++++
> refs/reftable-backend.c | 6 +++---
> 4 files changed, 42 insertions(+), 13 deletions(-)
>
> diff --git a/refs/refs-internal.h b/refs/refs-internal.h
> index d103387ebf..307dcb277b 100644
> --- a/refs/refs-internal.h
> +++ b/refs/refs-internal.h
> @@ -39,6 +39,13 @@ struct ref_transaction;
> */
> #define REF_LOG_ONLY (1 << 7)
>
> +/*
> + * The reference contains a peeled object ID. This is used when the
> + * new_oid is pointing to a tag object and the reference backend
> + * wants to also store the peeled value for optimized retrieval.
> + */
> +#define REF_HAVE_PEELED (1 << 15)
How did you end up picking this value?
I did some grepping to figure out if it would conflict with anything:
git grep -h '#define REF_' -- '*.h' '*.c' |
awk '/0x/{n=strtonum($3);b=0;while(n>1){n/=2;b++};$3="(1 << "b")"} 1' |
sort -t'<' -k3 -n |
column -t(Yeah I got some help from AI to write the `awk` command)
Resulting in:
#define REF_EXCLUSIONS_INIT { \
#define REF_FILTER_H
#define REF_FILTER_INIT { \
#define REF_FORMAT_INIT { \
#define REF_FORMATTING_STATE_INIT { 0 }
#define REF_NO_DEREF (1 << 0)
#define REF_NORMAL (1u << 0)
#define REF_STATES_INIT { \
#define REF_STORE_ALL_CAPS (REF_STORE_READ | \
#define REF_STORE_CREATE_ON_DISK_IS_WORKTREE (1 << 0)
#define REF_STORE_READ (1 << 0)
#define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
#define REF_BRANCHES (1u << 1)
#define REF_FORCE_CREATE_REFLOG (1 << 1)
#define REF_STORE_WRITE (1 << 1) /* can perform update operations */
#define REF_HAVE_NEW (1 << 2)
#define REF_STORE_ODB (1 << 2) /* has access to object database */
#define REF_TAGS (1u << 2)
#define REF_HAVE_OLD (1 << 3)
#define REF_STORE_MAIN (1 << 3)
#define REF_DIR (1 << 4)
#define REF_IS_PRUNING (1 << 4)
#define REF_DELETING (1 << 5)
#define REF_INCOMPLETE (1 << 5)
#define REF_KNOWS_PEELED (1 << 6)
#define REF_NEEDS_COMMIT (1 << 6)
#define REF_LOG_ONLY (1 << 7)
#define REF_UPDATE_VIA_HEAD (1 << 8)
#define REF_UPDATE_VIA_HEAD (1 << 8)
#define REF_DELETED_RMDIR (1 << 9)
#define REF_SKIP_OID_VERIFICATION (1 << 10)
#define REF_SKIP_REFNAME_VERIFICATION (1 << 11)
#define REF_SKIP_CREATE_REFLOG (1 << 12)
#define REF_LOG_USE_PROVIDED_OIDS (1 << 13)
#define REF_LOG_VIA_SPLIT (1 << 14)
#define REF_HAVE_PEELED (1 << 15)So I guess it makes sense to use `(1 << 15)`.
--
Cheers,
Toon