[thirdparty/git.git] / csum-file.h

#ifndef CSUM_FILE_H
#define CSUM_FILE_H

#include "hash-ll.h"
#include "write-or-die.h"

struct progress;

/* A SHA1-protected file */
struct hashfile {
	int fd;
	int check_fd;
	unsigned int offset;
	git_hash_ctx ctx;
	off_t total;
	struct progress *tp;
	const char *name;
	int do_crc;
	uint32_t crc32;
	size_t buffer_len;
	unsigned char *buffer;
	unsigned char *check_buffer;

	/**
	 * If non-zero, skip_hash indicates that we should
	 * not actually compute the hash for this hashfile and
	 * instead only use it as a buffered write.
	 */
	int skip_hash;
};

/* Checkpoint */
struct hashfile_checkpoint {
	off_t offset;
	git_hash_ctx ctx;
};

void hashfile_checkpoint(struct hashfile *, struct hashfile_checkpoint *);
int hashfile_truncate(struct hashfile *, struct hashfile_checkpoint *);

/* finalize_hashfile flags */
#define CSUM_CLOSE		1
#define CSUM_FSYNC		2
#define CSUM_HASH_IN_STREAM	4

struct hashfile *hashfd(int fd, const char *name);
struct hashfile *hashfd_check(const char *name);
struct hashfile *hashfd_throughput(int fd, const char *name, struct progress *tp);
int finalize_hashfile(struct hashfile *, unsigned char *, enum fsync_component, unsigned int);
void hashwrite(struct hashfile *, const void *, unsigned int);
void hashflush(struct hashfile *f);
void crc32_begin(struct hashfile *);
uint32_t crc32_end(struct hashfile *);

/* Verify checksum validity while reading. Returns non-zero on success. */
int hashfile_checksum_valid(const unsigned char *data, size_t len);

/*
 * Returns the total number of bytes fed to the hashfile so far (including ones
 * that have not been written out to the descriptor yet).
 */
static inline off_t hashfile_total(struct hashfile *f)
{
	return f->total + f->offset;
}

static inline void hashwrite_u8(struct hashfile *f, uint8_t data)
{
	hashwrite(f, &data, sizeof(data));
}

static inline void hashwrite_be32(struct hashfile *f, uint32_t data)
{
	data = htonl(data);
	hashwrite(f, &data, sizeof(data));
}

static inline size_t hashwrite_be64(struct hashfile *f, uint64_t data)
{
	data = htonll(data);
	hashwrite(f, &data, sizeof(data));
	return sizeof(data);
}

#endif
Commit	Line	Data
	1	#ifndef CSUM_FILE_H
	2	#define CSUM_FILE_H
	3
	4	#include "hash-ll.h"
	5	#include "write-or-die.h"
	6
	7	struct progress;
	8
	9	/* A SHA1-protected file */
	10	struct hashfile {
	11	int fd;
	12	int check_fd;
	13	unsigned int offset;
	14	git_hash_ctx ctx;
	15	off_t total;
	16	struct progress *tp;
	17	const char *name;
	18	int do_crc;
	19	uint32_t crc32;
	20	size_t buffer_len;
	21	unsigned char *buffer;
	22	unsigned char *check_buffer;
	23
	24	/**
	25	* If non-zero, skip_hash indicates that we should
	26	* not actually compute the hash for this hashfile and
	27	* instead only use it as a buffered write.
	28	*/
	29	int skip_hash;
	30	};
	31
	32	/* Checkpoint */
	33	struct hashfile_checkpoint {
	34	off_t offset;
	35	git_hash_ctx ctx;
	36	};
	37
	38	void hashfile_checkpoint(struct hashfile , struct hashfile_checkpoint );
	39	int hashfile_truncate(struct hashfile , struct hashfile_checkpoint );
	40
	41	/* finalize_hashfile flags */
	42	#define CSUM_CLOSE 1
	43	#define CSUM_FSYNC 2
	44	#define CSUM_HASH_IN_STREAM 4
	45
	46	struct hashfile hashfd(int fd, const char name);
	47	struct hashfile hashfd_check(const char name);
	48	struct hashfile hashfd_throughput(int fd, const char name, struct progress *tp);
	49	int finalize_hashfile(struct hashfile , unsigned char , enum fsync_component, unsigned int);
	50	void hashwrite(struct hashfile , const void , unsigned int);
	51	void hashflush(struct hashfile *f);
	52	void crc32_begin(struct hashfile *);
	53	uint32_t crc32_end(struct hashfile *);
	54
	55	/* Verify checksum validity while reading. Returns non-zero on success. */
	56	int hashfile_checksum_valid(const unsigned char *data, size_t len);
	57
	58	/*
	59	* Returns the total number of bytes fed to the hashfile so far (including ones
	60	* that have not been written out to the descriptor yet).
	61	*/
	62	static inline off_t hashfile_total(struct hashfile *f)
	63	{
	64	return f->total + f->offset;
	65	}
	66
	67	static inline void hashwrite_u8(struct hashfile *f, uint8_t data)
	68	{
	69	hashwrite(f, &data, sizeof(data));
	70	}
	71
	72	static inline void hashwrite_be32(struct hashfile *f, uint32_t data)
	73	{
	74	data = htonl(data);
	75	hashwrite(f, &data, sizeof(data));
	76	}
	77
	78	static inline size_t hashwrite_be64(struct hashfile *f, uint64_t data)
	79	{
	80	data = htonll(data);
	81	hashwrite(f, &data, sizeof(data));
	82	return sizeof(data);
	83	}
	84
	85	#endif