]>
Commit | Line | Data |
---|---|---|
1e4f48d6 | 1 | /* |
0f78b815 WD |
2 | * Block matching used by the file-transfer code. |
3 | * | |
4 | * Copyright (C) 1996 Andrew Tridgell | |
5 | * Copyright (C) 1996 Paul Mackerras | |
9a06b2ed | 6 | * Copyright (C) 2003-2023 Wayne Davison |
0f78b815 WD |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify | |
8e41b68e WD |
9 | * it under the terms of the GNU General Public License as published by |
10 | * the Free Software Foundation; either version 3 of the License, or | |
11 | * (at your option) any later version. | |
0f78b815 WD |
12 | * |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
e7c67065 | 18 | * You should have received a copy of the GNU General Public License along |
4fd842f9 | 19 | * with this program; if not, visit the http://fsf.org website. |
0f78b815 | 20 | */ |
c627d613 AT |
21 | |
22 | #include "rsync.h" | |
5dd14f0c | 23 | #include "inums.h" |
c627d613 | 24 | |
ba582f75 | 25 | extern int checksum_seed; |
6cc11982 | 26 | extern int append_mode; |
7e2711bb WD |
27 | |
28 | extern struct name_num_item *xfer_sum_nni; | |
29 | extern int xfer_sum_len; | |
a36ffd39 WD |
30 | |
31 | int updating_basis_file; | |
886df221 | 32 | char sender_file_sum[MAX_DIGEST_LEN]; |
c627d613 | 33 | |
c627d613 | 34 | static int false_alarms; |
900cfcb5 | 35 | static int hash_hits; |
c627d613 | 36 | static int matches; |
a800434a | 37 | static int64 data_transfer; |
c627d613 | 38 | |
3a6a366f | 39 | static int total_false_alarms; |
900cfcb5 | 40 | static int total_hash_hits; |
3a6a366f | 41 | static int total_matches; |
c627d613 | 42 | |
a800434a | 43 | extern struct stats stats; |
c627d613 | 44 | |
a2c770dc | 45 | #define TRADITIONAL_TABLESIZE (1<<16) |
48cce779 | 46 | |
a2c770dc | 47 | static uint32 tablesize; |
68207537 | 48 | static int32 *hash_table; |
c627d613 | 49 | |
48cce779 WD |
50 | #define SUM2HASH2(s1,s2) (((s1) + (s2)) & 0xFFFF) |
51 | #define SUM2HASH(sum) SUM2HASH2((sum)&0xFFFF,(sum)>>16) | |
c627d613 | 52 | |
a2c770dc | 53 | #define BIG_SUM2HASH(sum) ((sum)%tablesize) |
48cce779 | 54 | |
a2c770dc WD |
55 | static void build_hash_table(struct sum_struct *s) |
56 | { | |
57 | static uint32 alloc_size; | |
58 | int32 i; | |
59 | ||
60 | /* Dynamically calculate the hash table size so that the hash load | |
61 | * for big files is about 80%. A number greater than the traditional | |
62 | * size must be odd or s2 will not be able to span the entire set. */ | |
63 | tablesize = (uint32)(s->count/8) * 10 + 11; | |
64 | if (tablesize < TRADITIONAL_TABLESIZE) | |
65 | tablesize = TRADITIONAL_TABLESIZE; | |
66 | if (tablesize > alloc_size || tablesize < alloc_size - 16*1024) { | |
67 | if (hash_table) | |
68 | free(hash_table); | |
69 | hash_table = new_array(int32, tablesize); | |
a2c770dc | 70 | alloc_size = tablesize; |
d9bca0c3 | 71 | } |
c627d613 | 72 | |
a2c770dc | 73 | memset(hash_table, 0xFF, tablesize * sizeof hash_table[0]); |
4c17cdcb | 74 | |
a2c770dc WD |
75 | if (tablesize == TRADITIONAL_TABLESIZE) { |
76 | for (i = 0; i < s->count; i++) { | |
77 | uint32 t = SUM2HASH(s->sums[i].sum1); | |
78 | s->sums[i].chain = hash_table[t]; | |
79 | hash_table[t] = i; | |
80 | } | |
81 | } else { | |
82 | for (i = 0; i < s->count; i++) { | |
83 | uint32 t = BIG_SUM2HASH(s->sums[i].sum1); | |
84 | s->sums[i].chain = hash_table[t]; | |
85 | hash_table[t] = i; | |
86 | } | |
4c17cdcb | 87 | } |
c627d613 AT |
88 | } |
89 | ||
90 | ||
bcacc18b | 91 | static OFF_T last_match; |
c627d613 AT |
92 | |
93 | ||
58a1c1a2 | 94 | /* Transmit a literal and/or match token. |
f5f95a38 MP |
95 | * |
96 | * This delightfully-named function is called either when we find a | |
97 | * match and need to transmit all the unmatched data leading up to it, | |
98 | * or when we get bored of accumulating literal data and just need to | |
99 | * transmit it. As a result of this second case, it is called even if | |
100 | * we have not matched at all! | |
101 | * | |
58a1c1a2 WD |
102 | * If i >= 0, the number of a matched token. If < 0, indicates we have |
103 | * only literal data. A -1 will send a 0-token-int too, and a -2 sends | |
104 | * only literal data, w/o any token-int. */ | |
e63ff70e | 105 | static void matched(int f, struct sum_struct *s, struct map_struct *buf, OFF_T offset, int32 i) |
c627d613 | 106 | { |
26404276 | 107 | int32 n = (int32)(offset - last_match); /* max value: block_size (int32) */ |
a06b419d WD |
108 | int32 j; |
109 | ||
5a18b34d | 110 | if (DEBUG_GTE(DELTASUM, 2) && i >= 0) { |
a06b419d | 111 | rprintf(FINFO, |
6d56efa6 | 112 | "match at %s last_match=%s j=%d len=%ld n=%ld\n", |
adc2476f | 113 | big_num(offset), big_num(last_match), i, |
a06b419d WD |
114 | (long)s->sums[i].len, (long)n); |
115 | } | |
c627d613 | 116 | |
a06b419d | 117 | send_token(f, i, buf, last_match, n, i < 0 ? 0 : s->sums[i].len); |
e7ebc36c | 118 | data_transfer += n; |
70d794dc | 119 | |
a800434a AT |
120 | if (i >= 0) { |
121 | stats.matched_data += s->sums[i].len; | |
e7ebc36c | 122 | n += s->sums[i].len; |
a800434a | 123 | } |
1e4f48d6 WD |
124 | |
125 | for (j = 0; j < n; j += CHUNK_SIZE) { | |
a06b419d WD |
126 | int32 n1 = MIN(CHUNK_SIZE, n - j); |
127 | sum_update(map_ptr(buf, last_match + j, n1), n1); | |
e7ebc36c | 128 | } |
9e31c482 | 129 | |
0d0e2e93 | 130 | if (i >= 0) |
e7ebc36c | 131 | last_match = offset + s->sums[i].len; |
0d0e2e93 AT |
132 | else |
133 | last_match = offset; | |
eb86d661 | 134 | |
951e826b | 135 | if (buf && INFO_GTE(PROGRESS, 1)) |
4440b8aa | 136 | show_progress(last_match, buf->file_size); |
9e31c482 AT |
137 | } |
138 | ||
139 | ||
c6e7fcb4 | 140 | static void hash_search(int f,struct sum_struct *s, |
da9d12f5 | 141 | struct map_struct *buf, OFF_T len) |
c627d613 | 142 | { |
51b2ff03 | 143 | OFF_T offset, aligned_offset, end; |
4b4bcbe6 | 144 | int32 k, want_i, aligned_i, backup; |
0f599d36 | 145 | char sum2[MAX_DIGEST_LEN]; |
1e4f48d6 | 146 | uint32 s1, s2, sum; |
7560c17a | 147 | int more; |
debb4505 | 148 | schar *map; |
e7ebc36c | 149 | |
a04d77bc WD |
150 | /* want_i is used to encourage adjacent matches, allowing the RLL |
151 | * coding of the output to work more efficiently. */ | |
152 | want_i = 0; | |
923fa978 | 153 | |
5a18b34d | 154 | if (DEBUG_GTE(DELTASUM, 2)) { |
6d56efa6 | 155 | rprintf(FINFO, "hash search b=%ld len=%s\n", |
adc2476f | 156 | (long)s->blength, big_num(len)); |
0e36d9da | 157 | } |
e7ebc36c | 158 | |
a06b419d | 159 | k = (int32)MIN(len, (OFF_T)s->blength); |
1e4f48d6 | 160 | |
0e36d9da | 161 | map = (schar *)map_ptr(buf, 0, k); |
1e4f48d6 | 162 | |
e7ebc36c AT |
163 | sum = get_checksum1((char *)map, k); |
164 | s1 = sum & 0xFFFF; | |
165 | s2 = sum >> 16; | |
5a18b34d | 166 | if (DEBUG_GTE(DELTASUM, 3)) |
a06b419d | 167 | rprintf(FINFO, "sum=%.8x k=%ld\n", sum, (long)k); |
1e4f48d6 | 168 | |
4b4bcbe6 | 169 | offset = aligned_offset = aligned_i = 0; |
1e4f48d6 | 170 | |
e7ebc36c | 171 | end = len + 1 - s->sums[s->count-1].len; |
1e4f48d6 | 172 | |
5a18b34d | 173 | if (DEBUG_GTE(DELTASUM, 3)) { |
6d56efa6 | 174 | rprintf(FINFO, "hash search s->blength=%ld len=%s count=%s\n", |
adc2476f | 175 | (long)s->blength, big_num(len), big_num(s->count)); |
0e36d9da | 176 | } |
1e4f48d6 | 177 | |
e7ebc36c | 178 | do { |
e7ebc36c | 179 | int done_csum2 = 0; |
de941933 WD |
180 | uint32 hash_entry; |
181 | int32 i, *prev; | |
1e4f48d6 | 182 | |
5a18b34d | 183 | if (DEBUG_GTE(DELTASUM, 4)) { |
6d56efa6 | 184 | rprintf(FINFO, "offset=%s sum=%04x%04x\n", |
adc2476f | 185 | big_num(offset), s2 & 0xFFFF, s1 & 0xFFFF); |
48cce779 | 186 | } |
1e4f48d6 | 187 | |
a2c770dc | 188 | if (tablesize == TRADITIONAL_TABLESIZE) { |
de941933 WD |
189 | hash_entry = SUM2HASH2(s1,s2); |
190 | if ((i = hash_table[hash_entry]) < 0) | |
a2c770dc WD |
191 | goto null_hash; |
192 | sum = (s1 & 0xffff) | (s2 << 16); | |
193 | } else { | |
194 | sum = (s1 & 0xffff) | (s2 << 16); | |
de941933 WD |
195 | hash_entry = BIG_SUM2HASH(sum); |
196 | if ((i = hash_table[hash_entry]) < 0) | |
a2c770dc WD |
197 | goto null_hash; |
198 | } | |
de941933 | 199 | prev = &hash_table[hash_entry]; |
900cfcb5 WD |
200 | |
201 | hash_hits++; | |
202 | do { | |
d9bca0c3 | 203 | int32 l; |
1e4f48d6 | 204 | |
de941933 WD |
205 | /* When updating in-place, the chunk's offset must be |
206 | * either >= our offset or identical data at that offset. | |
207 | * Remove any bypassed entries that we can never use. */ | |
208 | if (updating_basis_file && s->sums[i].offset < offset | |
e63ff70e | 209 | && !(s->sums[i].flags & SUMFLG_SAME_OFFSET)) { |
de941933 WD |
210 | *prev = s->sums[i].chain; |
211 | continue; | |
212 | } | |
213 | prev = &s->sums[i].chain; | |
214 | ||
0e36d9da WD |
215 | if (sum != s->sums[i].sum1) |
216 | continue; | |
1e4f48d6 | 217 | |
536541d5 | 218 | /* also make sure the two blocks are the same length */ |
a06b419d | 219 | l = (int32)MIN((OFF_T)s->blength, len-offset); |
0e36d9da WD |
220 | if (l != s->sums[i].len) |
221 | continue; | |
536541d5 | 222 | |
5a18b34d | 223 | if (DEBUG_GTE(DELTASUM, 3)) { |
d9bca0c3 | 224 | rprintf(FINFO, |
6d56efa6 | 225 | "potential match at %s i=%ld sum=%08x\n", |
adc2476f | 226 | big_num(offset), (long)i, sum); |
d9bca0c3 | 227 | } |
1e4f48d6 | 228 | |
e7ebc36c | 229 | if (!done_csum2) { |
debb4505 | 230 | map = (schar *)map_ptr(buf,offset,l); |
e7ebc36c AT |
231 | get_checksum2((char *)map,l,sum2); |
232 | done_csum2 = 1; | |
233 | } | |
1e4f48d6 | 234 | |
fc0257c9 | 235 | if (memcmp(sum2,s->sums[i].sum2,s->s2length) != 0) { |
e7ebc36c AT |
236 | false_alarms++; |
237 | continue; | |
238 | } | |
923fa978 | 239 | |
a36ffd39 | 240 | /* When updating in-place, the best possible match is |
a3221d2a | 241 | * one with an identical offset, so we prefer that over |
51b2ff03 | 242 | * the adjacent want_i optimization. */ |
a36ffd39 | 243 | if (updating_basis_file) { |
8484ddd3 | 244 | /* All the generator's chunks start at blength boundaries. */ |
4b4bcbe6 | 245 | while (aligned_offset < offset) { |
51b2ff03 | 246 | aligned_offset += s->blength; |
4b4bcbe6 WD |
247 | aligned_i++; |
248 | } | |
813d5a25 WD |
249 | if ((offset == aligned_offset |
250 | || (sum == 0 && l == s->blength && aligned_offset + l <= len)) | |
251 | && aligned_i < s->count) { | |
4b4bcbe6 WD |
252 | if (i != aligned_i) { |
253 | if (sum != s->sums[aligned_i].sum1 | |
254 | || l != s->sums[aligned_i].len | |
255 | || memcmp(sum2, s->sums[aligned_i].sum2, s->s2length) != 0) | |
256 | goto check_want_i; | |
257 | i = aligned_i; | |
258 | } | |
259 | if (offset != aligned_offset) { | |
260 | /* We've matched some zeros in a spot that is also zeros | |
261 | * further along in the basis file, if we find zeros ahead | |
262 | * in the sender's file, we'll output enough literal data | |
263 | * to re-align with the basis file, and get back to seeking | |
264 | * instead of writing. */ | |
265 | backup = (int32)(aligned_offset - last_match); | |
266 | if (backup < 0) | |
267 | backup = 0; | |
268 | map = (schar *)map_ptr(buf, aligned_offset - backup, l + backup) | |
269 | + backup; | |
270 | sum = get_checksum1((char *)map, l); | |
271 | if (sum != s->sums[i].sum1) | |
272 | goto check_want_i; | |
273 | get_checksum2((char *)map, l, sum2); | |
274 | if (memcmp(sum2, s->sums[i].sum2, s->s2length) != 0) | |
275 | goto check_want_i; | |
276 | /* OK, we have a re-alignment match. Bump the offset | |
277 | * forward to the new match point. */ | |
278 | offset = aligned_offset; | |
a3221d2a | 279 | } |
4b4bcbe6 WD |
280 | /* This identical chunk is in the same spot in the old and new file. */ |
281 | s->sums[i].flags |= SUMFLG_SAME_OFFSET; | |
282 | want_i = i; | |
d9bca0c3 | 283 | } |
a3221d2a WD |
284 | } |
285 | ||
4b4bcbe6 | 286 | check_want_i: |
923fa978 | 287 | /* we've found a match, but now check to see |
a04d77bc WD |
288 | * if want_i can hint at a better match. */ |
289 | if (i != want_i && want_i < s->count | |
e63ff70e WD |
290 | && (!updating_basis_file || s->sums[want_i].offset >= offset |
291 | || s->sums[want_i].flags & SUMFLG_SAME_OFFSET) | |
292 | && sum == s->sums[want_i].sum1 | |
293 | && memcmp(sum2, s->sums[want_i].sum2, s->s2length) == 0) { | |
5e252dea WD |
294 | /* we've found an adjacent match - the RLL coder |
295 | * will be happy */ | |
a04d77bc | 296 | i = want_i; |
923fa978 | 297 | } |
a04d77bc | 298 | want_i = i + 1; |
1e4f48d6 | 299 | |
e7ebc36c AT |
300 | matched(f,s,buf,offset,i); |
301 | offset += s->sums[i].len - 1; | |
a06b419d | 302 | k = (int32)MIN((OFF_T)s->blength, len-offset); |
0e36d9da | 303 | map = (schar *)map_ptr(buf, offset, k); |
e7ebc36c AT |
304 | sum = get_checksum1((char *)map, k); |
305 | s1 = sum & 0xFFFF; | |
306 | s2 = sum >> 16; | |
307 | matches++; | |
308 | break; | |
900cfcb5 | 309 | } while ((i = s->sums[i].chain) >= 0); |
1e4f48d6 | 310 | |
900cfcb5 | 311 | null_hash: |
26404276 | 312 | backup = (int32)(offset - last_match); |
7560c17a WD |
313 | /* We sometimes read 1 byte prior to last_match... */ |
314 | if (backup < 0) | |
315 | backup = 0; | |
316 | ||
e7ebc36c | 317 | /* Trim off the first byte from the checksum */ |
7560c17a | 318 | more = offset + k < len; |
e63ff70e | 319 | map = (schar *)map_ptr(buf, offset - backup, k + more + backup) + backup; |
e7ebc36c AT |
320 | s1 -= map[0] + CHAR_OFFSET; |
321 | s2 -= k * (map[0]+CHAR_OFFSET); | |
1e4f48d6 | 322 | |
e7ebc36c | 323 | /* Add on the next byte (if there is one) to the checksum */ |
7560c17a WD |
324 | if (more) { |
325 | s1 += map[k] + CHAR_OFFSET; | |
e7ebc36c | 326 | s2 += s1; |
0e36d9da | 327 | } else |
e7ebc36c | 328 | --k; |
45f133b9 | 329 | |
5914bf15 PM |
330 | /* By matching early we avoid re-reading the |
331 | data 3 times in the case where a token | |
332 | match comes a long way after last | |
333 | match. The 3 reads are caused by the | |
334 | running match, the checksum update and the | |
335 | literal send. */ | |
a06b419d WD |
336 | if (backup >= s->blength+CHUNK_SIZE && end-offset > CHUNK_SIZE) |
337 | matched(f, s, buf, offset - s->blength, -2); | |
e7ebc36c | 338 | } while (++offset < end); |
1e4f48d6 | 339 | |
a06b419d WD |
340 | matched(f, s, buf, len, -1); |
341 | map_ptr(buf, len-1, 1); | |
c627d613 AT |
342 | } |
343 | ||
344 | ||
f5f95a38 MP |
345 | /** |
346 | * Scan through a origin file, looking for sections that match | |
347 | * checksums from the generator, and transmit either literal or token | |
348 | * data. | |
349 | * | |
538ba24f MP |
350 | * Also calculates the MD4 checksum of the whole file, using the md |
351 | * accumulator. This is transmitted with the file as protection | |
352 | * against corruption on the wire. | |
353 | * | |
f5f95a38 MP |
354 | * @param s Checksums received from the generator. If <tt>s->count == |
355 | * 0</tt>, then there are actually no checksums for this file. | |
356 | * | |
357 | * @param len Length of the file to send. | |
358 | **/ | |
359 | void match_sums(int f, struct sum_struct *s, struct map_struct *buf, OFF_T len) | |
c627d613 | 360 | { |
e7ebc36c AT |
361 | last_match = 0; |
362 | false_alarms = 0; | |
900cfcb5 | 363 | hash_hits = 0; |
1e4f48d6 WD |
364 | matches = 0; |
365 | data_transfer = 0; | |
e7ebc36c | 366 | |
7e2711bb | 367 | sum_init(xfer_sum_nni, checksum_seed); |
e7ebc36c | 368 | |
edb97721 | 369 | if (append_mode > 0) { |
936fa865 WD |
370 | if (append_mode == 2) { |
371 | OFF_T j = 0; | |
372 | for (j = CHUNK_SIZE; j < s->flength; j += CHUNK_SIZE) { | |
951e826b | 373 | if (buf && INFO_GTE(PROGRESS, 1)) |
936fa865 WD |
374 | show_progress(last_match, buf->file_size); |
375 | sum_update(map_ptr(buf, last_match, CHUNK_SIZE), | |
376 | CHUNK_SIZE); | |
377 | last_match = j; | |
378 | } | |
379 | if (last_match < s->flength) { | |
380 | int32 n = (int32)(s->flength - last_match); | |
951e826b | 381 | if (buf && INFO_GTE(PROGRESS, 1)) |
936fa865 WD |
382 | show_progress(last_match, buf->file_size); |
383 | sum_update(map_ptr(buf, last_match, n), n); | |
384 | } | |
6cc11982 | 385 | } |
936fa865 | 386 | last_match = s->flength; |
6cc11982 WD |
387 | s->count = 0; |
388 | } | |
389 | ||
a06b419d | 390 | if (len > 0 && s->count > 0) { |
a2c770dc WD |
391 | build_hash_table(s); |
392 | ||
5a18b34d | 393 | if (DEBUG_GTE(DELTASUM, 2)) |
a2c770dc WD |
394 | rprintf(FINFO,"built hash table\n"); |
395 | ||
a0456b9c | 396 | hash_search(f, s, buf, len); |
1e4f48d6 | 397 | |
5a18b34d | 398 | if (DEBUG_GTE(DELTASUM, 2)) |
9486289c | 399 | rprintf(FINFO,"done hash search\n"); |
e7ebc36c | 400 | } else { |
eb86d661 AT |
401 | OFF_T j; |
402 | /* by doing this in pieces we avoid too many seeks */ | |
6cc11982 | 403 | for (j = last_match + CHUNK_SIZE; j < len; j += CHUNK_SIZE) |
a06b419d WD |
404 | matched(f, s, buf, j, -2); |
405 | matched(f, s, buf, len, -1); | |
e7ebc36c | 406 | } |
9e31c482 | 407 | |
7e2711bb | 408 | sum_end(sender_file_sum); |
886df221 WD |
409 | |
410 | /* If we had a read error, send a bad checksum. We use all bits | |
411 | * off as long as the checksum doesn't happen to be that, in | |
412 | * which case we turn the last 0 bit into a 1. */ | |
413 | if (buf && buf->status != 0) { | |
414 | int i; | |
7e2711bb WD |
415 | for (i = 0; i < xfer_sum_len && sender_file_sum[i] == 0; i++) {} |
416 | memset(sender_file_sum, 0, xfer_sum_len); | |
417 | if (i == xfer_sum_len) | |
886df221 WD |
418 | sender_file_sum[i-1]++; |
419 | } | |
c627d613 | 420 | |
5a18b34d | 421 | if (DEBUG_GTE(DELTASUM, 2)) |
bc63ae3f | 422 | rprintf(FINFO,"sending file_sum\n"); |
7e2711bb | 423 | write_buf(f, sender_file_sum, xfer_sum_len); |
c627d613 | 424 | |
5a18b34d | 425 | if (DEBUG_GTE(DELTASUM, 2)) { |
900cfcb5 WD |
426 | rprintf(FINFO, "false_alarms=%d hash_hits=%d matches=%d\n", |
427 | false_alarms, hash_hits, matches); | |
886df221 | 428 | } |
1e4f48d6 | 429 | |
900cfcb5 | 430 | total_hash_hits += hash_hits; |
e7ebc36c AT |
431 | total_false_alarms += false_alarms; |
432 | total_matches += matches; | |
a800434a | 433 | stats.literal_data += data_transfer; |
c627d613 AT |
434 | } |
435 | ||
436 | void match_report(void) | |
437 | { | |
5a18b34d | 438 | if (!DEBUG_GTE(DELTASUM, 1)) |
e7ebc36c | 439 | return; |
c627d613 | 440 | |
9486289c | 441 | rprintf(FINFO, |
6d56efa6 | 442 | "total: matches=%d hash_hits=%d false_alarms=%d data=%s\n", |
900cfcb5 | 443 | total_matches, total_hash_hits, total_false_alarms, |
adc2476f | 444 | big_num(stats.literal_data)); |
c627d613 | 445 | } |