57adf71b93
The `hash_size()` function returns the number of bytes used by the hash function. Weirdly enough though, it returns a signed integer for its size even though the size obviously cannot ever be negative. The only case where it could be negative is if the function returned an error when asked for an unknown hash, but we assert(3p) instead. Adjust the type of `hash_size()` to be `uint32_t` and adapt all places that use signed integers for the hash size to follow suit. This also allows us to get rid of a couple asserts that we had which verified that the size was indeed positive, which further stresses the point that this refactoring makes sense. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
111 lines
3.2 KiB
C
111 lines
3.2 KiB
C
/*
|
|
Copyright 2020 Google LLC
|
|
|
|
Use of this source code is governed by a BSD-style
|
|
license that can be found in the LICENSE file or at
|
|
https://developers.google.com/open-source/licenses/bsd
|
|
*/
|
|
|
|
#ifndef REFTABLE_RECORD_H
|
|
#define REFTABLE_RECORD_H
|
|
|
|
#include "reftable-basics.h"
|
|
#include <stdint.h>
|
|
|
|
/*
|
|
* Basic data types
|
|
*
|
|
* Reftables store the state of each ref in struct reftable_ref_record, and they
|
|
* store a sequence of reflog updates in struct reftable_log_record.
|
|
*/
|
|
|
|
/* reftable_ref_record holds a ref database entry target_value */
|
|
struct reftable_ref_record {
|
|
char *refname; /* Name of the ref, malloced. */
|
|
size_t refname_cap;
|
|
uint64_t update_index; /* Logical timestamp at which this value is
|
|
* written */
|
|
|
|
enum {
|
|
/* tombstone to hide deletions from earlier tables */
|
|
REFTABLE_REF_DELETION = 0x0,
|
|
|
|
/* a simple ref */
|
|
REFTABLE_REF_VAL1 = 0x1,
|
|
/* a tag, plus its peeled hash */
|
|
REFTABLE_REF_VAL2 = 0x2,
|
|
|
|
/* a symbolic reference */
|
|
REFTABLE_REF_SYMREF = 0x3,
|
|
#define REFTABLE_NR_REF_VALUETYPES 4
|
|
} value_type;
|
|
union {
|
|
unsigned char val1[REFTABLE_HASH_SIZE_MAX];
|
|
struct {
|
|
unsigned char value[REFTABLE_HASH_SIZE_MAX]; /* first hash */
|
|
unsigned char target_value[REFTABLE_HASH_SIZE_MAX]; /* second hash */
|
|
} val2;
|
|
char *symref; /* referent, malloced 0-terminated string */
|
|
} value;
|
|
};
|
|
|
|
/* Returns the first hash, or NULL if `rec` is not of type
|
|
* REFTABLE_REF_VAL1 or REFTABLE_REF_VAL2. */
|
|
const unsigned char *reftable_ref_record_val1(const struct reftable_ref_record *rec);
|
|
|
|
/* Returns the second hash, or NULL if `rec` is not of type
|
|
* REFTABLE_REF_VAL2. */
|
|
const unsigned char *reftable_ref_record_val2(const struct reftable_ref_record *rec);
|
|
|
|
/* returns whether 'ref' represents a deletion */
|
|
int reftable_ref_record_is_deletion(const struct reftable_ref_record *ref);
|
|
|
|
/* frees and nulls all pointer values inside `ref`. */
|
|
void reftable_ref_record_release(struct reftable_ref_record *ref);
|
|
|
|
/* returns whether two reftable_ref_records are the same. Useful for testing. */
|
|
int reftable_ref_record_equal(const struct reftable_ref_record *a,
|
|
const struct reftable_ref_record *b, uint32_t hash_size);
|
|
|
|
/* reftable_log_record holds a reflog entry */
|
|
struct reftable_log_record {
|
|
char *refname;
|
|
size_t refname_cap;
|
|
uint64_t update_index; /* logical timestamp of a transactional update.
|
|
*/
|
|
|
|
enum {
|
|
/* tombstone to hide deletions from earlier tables */
|
|
REFTABLE_LOG_DELETION = 0x0,
|
|
|
|
/* a simple update */
|
|
REFTABLE_LOG_UPDATE = 0x1,
|
|
#define REFTABLE_NR_LOG_VALUETYPES 2
|
|
} value_type;
|
|
|
|
union {
|
|
struct {
|
|
unsigned char new_hash[REFTABLE_HASH_SIZE_MAX];
|
|
unsigned char old_hash[REFTABLE_HASH_SIZE_MAX];
|
|
char *name;
|
|
char *email;
|
|
uint64_t time;
|
|
int16_t tz_offset;
|
|
char *message;
|
|
size_t message_cap;
|
|
} update;
|
|
} value;
|
|
};
|
|
|
|
/* returns whether 'ref' represents the deletion of a log record. */
|
|
int reftable_log_record_is_deletion(const struct reftable_log_record *log);
|
|
|
|
/* frees and nulls all pointer values. */
|
|
void reftable_log_record_release(struct reftable_log_record *log);
|
|
|
|
/* returns whether two records are equal. Useful for testing. */
|
|
int reftable_log_record_equal(const struct reftable_log_record *a,
|
|
const struct reftable_log_record *b, uint32_t hash_size);
|
|
|
|
#endif
|