]>
Commit | Line | Data |
---|---|---|
c38138cd LT |
1 | /* |
2 | * csum-file.c | |
3 | * | |
4 | * Copyright (C) 2005 Linus Torvalds | |
5 | * | |
6 | * Simple file write infrastructure for writing SHA1-summed | |
7 | * files. Useful when you write a file that you want to be | |
8 | * able to verify hasn't been messed with afterwards. | |
9 | */ | |
10 | #include "cache.h" | |
2a128d63 | 11 | #include "progress.h" |
c38138cd LT |
12 | #include "csum-file.h" |
13 | ||
2ca245f8 DS |
14 | static void verify_buffer_or_die(struct hashfile *f, |
15 | const void *buf, | |
16 | unsigned int count) | |
17 | { | |
18 | ssize_t ret = read_in_full(f->check_fd, f->check_buffer, count); | |
19 | ||
20 | if (ret < 0) | |
21 | die_errno("%s: sha1 file read error", f->name); | |
22 | if (ret != count) | |
23 | die("%s: sha1 file truncated", f->name); | |
24 | if (memcmp(buf, f->check_buffer, count)) | |
25 | die("sha1 file '%s' validation error", f->name); | |
26 | } | |
27 | ||
98a3beab | 28 | static void flush(struct hashfile *f, const void *buf, unsigned int count) |
c38138cd | 29 | { |
2ca245f8 DS |
30 | if (0 <= f->check_fd && count) |
31 | verify_buffer_or_die(f, buf, count); | |
e337a04d | 32 | |
68142e11 DS |
33 | if (write_in_full(f->fd, buf, count) < 0) { |
34 | if (errno == ENOSPC) | |
e1808845 | 35 | die("sha1 file '%s' write error. Out of diskspace", f->name); |
d824cbba | 36 | die_errno("sha1 file '%s' write error", f->name); |
c38138cd | 37 | } |
68142e11 DS |
38 | |
39 | f->total += count; | |
40 | display_throughput(f->tp, f->total); | |
c38138cd LT |
41 | } |
42 | ||
98a3beab | 43 | void hashflush(struct hashfile *f) |
c38138cd LT |
44 | { |
45 | unsigned offset = f->offset; | |
4c81b03e | 46 | |
c38138cd | 47 | if (offset) { |
4d273500 | 48 | the_hash_algo->update_fn(&f->ctx, f->buffer, offset); |
e782e12f | 49 | flush(f, f->buffer, offset); |
f0215369 | 50 | f->offset = 0; |
c38138cd | 51 | } |
838cd346 NP |
52 | } |
53 | ||
2ca245f8 DS |
54 | static void free_hashfile(struct hashfile *f) |
55 | { | |
56 | free(f->buffer); | |
57 | free(f->check_buffer); | |
58 | free(f); | |
59 | } | |
60 | ||
f2af9f5e | 61 | int finalize_hashfile(struct hashfile *f, unsigned char *result, unsigned int flags) |
838cd346 NP |
62 | { |
63 | int fd; | |
64 | ||
98a3beab | 65 | hashflush(f); |
4d273500 | 66 | the_hash_algo->final_fn(f->buffer, &f->ctx); |
ac0463ed NP |
67 | if (result) |
68 | hashcpy(result, f->buffer); | |
cfe83216 | 69 | if (flags & CSUM_HASH_IN_STREAM) |
4d273500 | 70 | flush(f, f->buffer, the_hash_algo->rawsz); |
cfe83216 DS |
71 | if (flags & CSUM_FSYNC) |
72 | fsync_or_die(f->fd, f->name); | |
73 | if (flags & CSUM_CLOSE) { | |
7ba502c4 | 74 | if (close(f->fd)) |
d824cbba | 75 | die_errno("%s: sha1 file error on close", f->name); |
7ba502c4 NP |
76 | fd = 0; |
77 | } else | |
78 | fd = f->fd; | |
e337a04d JH |
79 | if (0 <= f->check_fd) { |
80 | char discard; | |
81 | int cnt = read_in_full(f->check_fd, &discard, 1); | |
82 | if (cnt < 0) | |
83 | die_errno("%s: error when reading the tail of sha1 file", | |
84 | f->name); | |
85 | if (cnt) | |
86 | die("%s: sha1 file has trailing garbage", f->name); | |
87 | if (close(f->check_fd)) | |
88 | die_errno("%s: sha1 file error on close", f->name); | |
89 | } | |
2ca245f8 | 90 | free_hashfile(f); |
7ba502c4 | 91 | return fd; |
c38138cd LT |
92 | } |
93 | ||
98a3beab | 94 | void hashwrite(struct hashfile *f, const void *buf, unsigned int count) |
c38138cd LT |
95 | { |
96 | while (count) { | |
2ca245f8 | 97 | unsigned left = f->buffer_len - f->offset; |
c38138cd | 98 | unsigned nr = count > left ? left : count; |
a8032d12 NP |
99 | |
100 | if (f->do_crc) | |
101 | f->crc32 = crc32(f->crc32, buf, nr); | |
102 | ||
2ca245f8 | 103 | if (nr == f->buffer_len) { |
ddaf1f62 DS |
104 | /* |
105 | * Flush a full batch worth of data directly | |
106 | * from the input, skipping the memcpy() to | |
107 | * the hashfile's buffer. In this block, | |
108 | * f->offset is necessarily zero. | |
109 | */ | |
110 | the_hash_algo->update_fn(&f->ctx, buf, nr); | |
111 | flush(f, buf, nr); | |
a8032d12 | 112 | } else { |
ddaf1f62 DS |
113 | /* |
114 | * Copy to the hashfile's buffer, flushing only | |
115 | * if it became full. | |
116 | */ | |
117 | memcpy(f->buffer + f->offset, buf, nr); | |
118 | f->offset += nr; | |
119 | left -= nr; | |
120 | if (!left) | |
121 | hashflush(f); | |
a8032d12 | 122 | } |
c38138cd | 123 | |
c38138cd | 124 | count -= nr; |
1d7f171c | 125 | buf = (char *) buf + nr; |
c38138cd | 126 | } |
c38138cd LT |
127 | } |
128 | ||
98a3beab | 129 | struct hashfile *hashfd_check(const char *name) |
e337a04d JH |
130 | { |
131 | int sink, check; | |
98a3beab | 132 | struct hashfile *f; |
e337a04d | 133 | |
66e905b7 RS |
134 | sink = xopen("/dev/null", O_WRONLY); |
135 | check = xopen(name, O_RDONLY); | |
98a3beab | 136 | f = hashfd(sink, name); |
e337a04d | 137 | f->check_fd = check; |
2ca245f8 DS |
138 | f->check_buffer = xmalloc(f->buffer_len); |
139 | ||
e337a04d JH |
140 | return f; |
141 | } | |
142 | ||
2ca245f8 DS |
143 | static struct hashfile *hashfd_internal(int fd, const char *name, |
144 | struct progress *tp, | |
145 | size_t buffer_len) | |
4397f014 | 146 | { |
98a3beab | 147 | struct hashfile *f = xmalloc(sizeof(*f)); |
4397f014 | 148 | f->fd = fd; |
e337a04d | 149 | f->check_fd = -1; |
4397f014 | 150 | f->offset = 0; |
218558af | 151 | f->total = 0; |
2a128d63 | 152 | f->tp = tp; |
ec640ed1 | 153 | f->name = name; |
78d1e84f | 154 | f->do_crc = 0; |
4d273500 | 155 | the_hash_algo->init_fn(&f->ctx); |
2ca245f8 DS |
156 | |
157 | f->buffer_len = buffer_len; | |
158 | f->buffer = xmalloc(buffer_len); | |
159 | f->check_buffer = NULL; | |
160 | ||
4397f014 LT |
161 | return f; |
162 | } | |
163 | ||
2ca245f8 DS |
164 | struct hashfile *hashfd(int fd, const char *name) |
165 | { | |
166 | /* | |
167 | * Since we are not going to use a progress meter to | |
168 | * measure the rate of data passing through this hashfile, | |
169 | * use a larger buffer size to reduce fsync() calls. | |
170 | */ | |
171 | return hashfd_internal(fd, name, NULL, 128 * 1024); | |
172 | } | |
173 | ||
174 | struct hashfile *hashfd_throughput(int fd, const char *name, struct progress *tp) | |
175 | { | |
176 | /* | |
177 | * Since we are expecting to report progress of the | |
178 | * write into this hashfile, use a smaller buffer | |
179 | * size so the progress indicators arrive at a more | |
180 | * frequent rate. | |
181 | */ | |
182 | return hashfd_internal(fd, name, tp, 8 * 1024); | |
183 | } | |
184 | ||
98a3beab | 185 | void hashfile_checkpoint(struct hashfile *f, struct hashfile_checkpoint *checkpoint) |
6c526148 | 186 | { |
98a3beab | 187 | hashflush(f); |
6c526148 | 188 | checkpoint->offset = f->total; |
768e30ea | 189 | the_hash_algo->clone_fn(&checkpoint->ctx, &f->ctx); |
6c526148 JH |
190 | } |
191 | ||
98a3beab | 192 | int hashfile_truncate(struct hashfile *f, struct hashfile_checkpoint *checkpoint) |
6c526148 JH |
193 | { |
194 | off_t offset = checkpoint->offset; | |
195 | ||
196 | if (ftruncate(f->fd, offset) || | |
197 | lseek(f->fd, offset, SEEK_SET) != offset) | |
198 | return -1; | |
199 | f->total = offset; | |
200 | f->ctx = checkpoint->ctx; | |
98a3beab | 201 | f->offset = 0; /* hashflush() was called in checkpoint */ |
6c526148 JH |
202 | return 0; |
203 | } | |
204 | ||
98a3beab | 205 | void crc32_begin(struct hashfile *f) |
78d1e84f | 206 | { |
1e4cd68c | 207 | f->crc32 = crc32(0, NULL, 0); |
78d1e84f NP |
208 | f->do_crc = 1; |
209 | } | |
c38138cd | 210 | |
98a3beab | 211 | uint32_t crc32_end(struct hashfile *f) |
78d1e84f NP |
212 | { |
213 | f->do_crc = 0; | |
214 | return f->crc32; | |
215 | } | |
f9221e2c TB |
216 | |
217 | int hashfile_checksum_valid(const unsigned char *data, size_t total_len) | |
218 | { | |
219 | unsigned char got[GIT_MAX_RAWSZ]; | |
220 | git_hash_ctx ctx; | |
221 | size_t data_len = total_len - the_hash_algo->rawsz; | |
222 | ||
223 | if (total_len < the_hash_algo->rawsz) | |
224 | return 0; /* say "too short"? */ | |
225 | ||
226 | the_hash_algo->init_fn(&ctx); | |
227 | the_hash_algo->update_fn(&ctx, data, data_len); | |
228 | the_hash_algo->final_fn(got, &ctx); | |
229 | ||
230 | return hasheq(got, data + data_len); | |
231 | } |