2 Copyright 2020 Google LLC
4 Use of this source code is governed by a BSD-style
5 license that can be found in the LICENSE file or at
6 https://developers.google.com/open-source/licenses/bsd
9 #ifndef REFTABLE_RECORD_H
10 #define REFTABLE_RECORD_H
18 * Reftables store the state of each ref in struct reftable_ref_record, and they
19 * store a sequence of reflog updates in struct reftable_log_record.
22 /* reftable_ref_record holds a ref database entry target_value */
23 struct reftable_ref_record
{
24 char *refname
; /* Name of the ref, malloced. */
25 uint64_t update_index
; /* Logical timestamp at which this value is
29 /* tombstone to hide deletions from earlier tables */
30 REFTABLE_REF_DELETION
= 0x0,
33 REFTABLE_REF_VAL1
= 0x1,
34 /* a tag, plus its peeled hash */
35 REFTABLE_REF_VAL2
= 0x2,
37 /* a symbolic reference */
38 REFTABLE_REF_SYMREF
= 0x3,
39 #define REFTABLE_NR_REF_VALUETYPES 4
42 unsigned char val1
[GIT_MAX_RAWSZ
];
44 unsigned char value
[GIT_MAX_RAWSZ
]; /* first hash */
45 unsigned char target_value
[GIT_MAX_RAWSZ
]; /* second hash */
47 char *symref
; /* referent, malloced 0-terminated string */
51 /* Returns the first hash, or NULL if `rec` is not of type
52 * REFTABLE_REF_VAL1 or REFTABLE_REF_VAL2. */
53 const unsigned char *reftable_ref_record_val1(const struct reftable_ref_record
*rec
);
55 /* Returns the second hash, or NULL if `rec` is not of type
56 * REFTABLE_REF_VAL2. */
57 const unsigned char *reftable_ref_record_val2(const struct reftable_ref_record
*rec
);
59 /* returns whether 'ref' represents a deletion */
60 int reftable_ref_record_is_deletion(const struct reftable_ref_record
*ref
);
62 /* prints a reftable_ref_record onto stdout. Useful for debugging. */
63 void reftable_ref_record_print(const struct reftable_ref_record
*ref
,
66 /* frees and nulls all pointer values inside `ref`. */
67 void reftable_ref_record_release(struct reftable_ref_record
*ref
);
69 /* returns whether two reftable_ref_records are the same. Useful for testing. */
70 int reftable_ref_record_equal(const struct reftable_ref_record
*a
,
71 const struct reftable_ref_record
*b
, int hash_size
);
73 /* reftable_log_record holds a reflog entry */
74 struct reftable_log_record
{
76 uint64_t update_index
; /* logical timestamp of a transactional update.
80 /* tombstone to hide deletions from earlier tables */
81 REFTABLE_LOG_DELETION
= 0x0,
84 REFTABLE_LOG_UPDATE
= 0x1,
85 #define REFTABLE_NR_LOG_VALUETYPES 2
101 /* returns whether 'ref' represents the deletion of a log record. */
102 int reftable_log_record_is_deletion(const struct reftable_log_record
*log
);
104 /* frees and nulls all pointer values. */
105 void reftable_log_record_release(struct reftable_log_record
*log
);
107 /* returns whether two records are equal. Useful for testing. */
108 int reftable_log_record_equal(const struct reftable_log_record
*a
,
109 const struct reftable_log_record
*b
, int hash_size
);
111 /* dumps a reftable_log_record on stdout, for debugging/testing. */
112 void reftable_log_record_print(struct reftable_log_record
*log
,