Documentation: add Packfile URIs design doc
[git.git] / csum-file.h
blobf9cbd317fbbce89547a405783fb5cc69e7815efa
1 #ifndef CSUM_FILE_H
2 #define CSUM_FILE_H
4 #include "hash.h"
6 struct progress;
8 /* A SHA1-protected file */
9 struct hashfile {
10 int fd;
11 int check_fd;
12 unsigned int offset;
13 git_hash_ctx ctx;
14 off_t total;
15 struct progress *tp;
16 const char *name;
17 int do_crc;
18 uint32_t crc32;
19 unsigned char buffer[8192];
22 /* Checkpoint */
23 struct hashfile_checkpoint {
24 off_t offset;
25 git_hash_ctx ctx;
28 void hashfile_checkpoint(struct hashfile *, struct hashfile_checkpoint *);
29 int hashfile_truncate(struct hashfile *, struct hashfile_checkpoint *);
31 /* finalize_hashfile flags */
32 #define CSUM_CLOSE 1
33 #define CSUM_FSYNC 2
34 #define CSUM_HASH_IN_STREAM 4
36 struct hashfile *hashfd(int fd, const char *name);
37 struct hashfile *hashfd_check(const char *name);
38 struct hashfile *hashfd_throughput(int fd, const char *name, struct progress *tp);
39 int finalize_hashfile(struct hashfile *, unsigned char *, unsigned int);
40 void hashwrite(struct hashfile *, const void *, unsigned int);
41 void hashflush(struct hashfile *f);
42 void crc32_begin(struct hashfile *);
43 uint32_t crc32_end(struct hashfile *);
46 * Returns the total number of bytes fed to the hashfile so far (including ones
47 * that have not been written out to the descriptor yet).
49 static inline off_t hashfile_total(struct hashfile *f)
51 return f->total + f->offset;
54 static inline void hashwrite_u8(struct hashfile *f, uint8_t data)
56 hashwrite(f, &data, sizeof(data));
59 static inline void hashwrite_be32(struct hashfile *f, uint32_t data)
61 data = htonl(data);
62 hashwrite(f, &data, sizeof(data));
65 #endif