Use an int32 for the each block-size variable.
[rsync.git] / match.c
1 /*
2    Copyright (C) Andrew Tridgell 1996
3    Copyright (C) Paul Mackerras 1996
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include "rsync.h"
21
22 extern int verbose;
23 extern int am_server;
24 extern int do_progress;
25 extern int checksum_seed;
26 extern int inplace;
27 extern int make_backups;
28
29 typedef unsigned short tag;
30
31 #define TABLESIZE (1<<16)
32 #define NULL_TAG ((size_t)-1)
33
34 static int false_alarms;
35 static int tag_hits;
36 static int matches;
37 static int64 data_transfer;
38
39 static int total_false_alarms;
40 static int total_tag_hits;
41 static int total_matches;
42
43 extern struct stats stats;
44
45 struct target {
46         tag t;
47         size_t i;
48 };
49
50 static struct target *targets;
51
52 static size_t *tag_table;
53
54 #define gettag2(s1,s2) (((s1) + (s2)) & 0xFFFF)
55 #define gettag(sum) gettag2((sum)&0xFFFF,(sum)>>16)
56
57 static int compare_targets(struct target *t1,struct target *t2)
58 {
59         return (int)t1->t - (int)t2->t;
60 }
61
62
63 static void build_hash_table(struct sum_struct *s)
64 {
65         size_t i;
66
67         if (!tag_table)
68                 tag_table = new_array(size_t, TABLESIZE);
69
70         targets = new_array(struct target, s->count);
71         if (!tag_table || !targets)
72                 out_of_memory("build_hash_table");
73
74         for (i = 0; i < s->count; i++) {
75                 targets[i].i = i;
76                 targets[i].t = gettag(s->sums[i].sum1);
77         }
78
79         qsort(targets,s->count,sizeof(targets[0]),(int (*)())compare_targets);
80
81         for (i = 0; i < TABLESIZE; i++)
82                 tag_table[i] = NULL_TAG;
83
84         for (i = s->count; i-- > 0; )
85                 tag_table[targets[i].t] = i;
86 }
87
88
89 static OFF_T last_match;
90
91
92 /**
93  * Transmit a literal and/or match token.
94  *
95  * This delightfully-named function is called either when we find a
96  * match and need to transmit all the unmatched data leading up to it,
97  * or when we get bored of accumulating literal data and just need to
98  * transmit it.  As a result of this second case, it is called even if
99  * we have not matched at all!
100  *
101  * @param i If >0, the number of a matched token.  If 0, indicates we
102  * have only literal data.
103  **/
104 static void matched(int f, struct sum_struct *s, struct map_struct *buf,
105                     OFF_T offset, int i)
106 {
107         int32 n = offset - last_match; /* max value: block_size (int32) */
108         int32 j;
109
110         if (verbose > 2 && i >= 0) {
111                 rprintf(FINFO,
112                         "match at %.0f last_match=%.0f j=%d len=%ld n=%ld\n",
113                         (double)offset, (double)last_match, i,
114                         (long)s->sums[i].len, (long)n);
115         }
116
117         send_token(f, i, buf, last_match, n, i < 0 ? 0 : s->sums[i].len);
118         data_transfer += n;
119
120         if (i >= 0) {
121                 stats.matched_data += s->sums[i].len;
122                 n += s->sums[i].len;
123         }
124
125         for (j = 0; j < n; j += CHUNK_SIZE) {
126                 int32 n1 = MIN(CHUNK_SIZE, n - j);
127                 sum_update(map_ptr(buf, last_match + j, n1), n1);
128         }
129
130
131         if (i >= 0)
132                 last_match = offset + s->sums[i].len;
133         else
134                 last_match = offset;
135
136         if (buf && do_progress) {
137                 show_progress(last_match, buf->file_size);
138
139                 if (i == -1)
140                         end_progress(buf->file_size);
141         }
142 }
143
144
145 static void hash_search(int f,struct sum_struct *s,
146                         struct map_struct *buf, OFF_T len)
147 {
148         OFF_T offset, end, backup;
149         int32 k;
150         size_t want_i;
151         char sum2[SUM_LENGTH];
152         uint32 s1, s2, sum;
153         int more;
154         schar *map;
155
156         /* want_i is used to encourage adjacent matches, allowing the RLL
157          * coding of the output to work more efficiently. */
158         want_i = 0;
159
160         if (verbose > 2) {
161                 rprintf(FINFO, "hash search b=%ld len=%.0f\n",
162                         (long)s->blength, (double)len);
163         }
164
165         k = (int32)MIN(len, (OFF_T)s->blength);
166
167         map = (schar *)map_ptr(buf, 0, k);
168
169         sum = get_checksum1((char *)map, k);
170         s1 = sum & 0xFFFF;
171         s2 = sum >> 16;
172         if (verbose > 3)
173                 rprintf(FINFO, "sum=%.8x k=%ld\n", sum, (long)k);
174
175         offset = 0;
176
177         end = len + 1 - s->sums[s->count-1].len;
178
179         if (verbose > 3) {
180                 rprintf(FINFO, "hash search s->blength=%ld len=%.0f count=%.0f\n",
181                         (long)s->blength, (double)len, (double)s->count);
182         }
183
184         do {
185                 tag t = gettag2(s1,s2);
186                 int done_csum2 = 0;
187                 size_t j = tag_table[t];
188
189                 if (verbose > 4)
190                         rprintf(FINFO,"offset=%.0f sum=%08x\n",(double)offset,sum);
191
192                 if (j == NULL_TAG)
193                         goto null_tag;
194
195                 sum = (s1 & 0xffff) | (s2 << 16);
196                 tag_hits++;
197                 do {
198                         int32 l;
199                         size_t i = targets[j].i;
200
201                         if (sum != s->sums[i].sum1)
202                                 continue;
203
204                         /* also make sure the two blocks are the same length */
205                         l = (int32)MIN((OFF_T)s->blength, len-offset);
206                         if (l != s->sums[i].len)
207                                 continue;
208
209                         /* inplace: ensure chunk's offset is either >= our
210                          * offset or that the data didn't move. */
211                         if (inplace && !make_backups && s->sums[i].offset < offset
212                             && !(s->sums[i].flags & SUMFLG_SAME_OFFSET))
213                                 continue;
214
215                         if (verbose > 3)
216                                 rprintf(FINFO,"potential match at %.0f target=%.0f %.0f sum=%08x\n",
217                                         (double)offset,(double)j,(double)i,sum);
218
219                         if (!done_csum2) {
220                                 map = (schar *)map_ptr(buf,offset,l);
221                                 get_checksum2((char *)map,l,sum2);
222                                 done_csum2 = 1;
223                         }
224
225                         if (memcmp(sum2,s->sums[i].sum2,s->s2length) != 0) {
226                                 false_alarms++;
227                                 continue;
228                         }
229
230                         /* If inplace is enabled, the best possible match is
231                          * one with an identical offset, so we prefer that over
232                          * the following want_i optimization. */
233                         if (inplace && !make_backups) {
234                                 do {
235                                         size_t i2 = targets[j].i;
236                                         if (s->sums[i2].offset != offset)
237                                                 continue;
238                                         if (i2 != i) {
239                                                 if (sum != s->sums[i2].sum1)
240                                                         break;
241                                                 if (memcmp(sum2, s->sums[i2].sum2,
242                                                            s->s2length) != 0)
243                                                         break;
244                                                 i = i2;
245                                         }
246                                         /* This chunk was at the same offset on
247                                          * both the sender and the receiver. */
248                                         s->sums[i].flags |= SUMFLG_SAME_OFFSET;
249                                         goto set_want_i;
250                                 } while (++j < s->count && targets[j].t == t);
251                         }
252
253                         /* we've found a match, but now check to see
254                          * if want_i can hint at a better match. */
255                         if (i != want_i && want_i < s->count
256                             && (!inplace || make_backups || s->sums[want_i].offset >= offset
257                              || s->sums[want_i].flags & SUMFLG_SAME_OFFSET)
258                             && sum == s->sums[want_i].sum1
259                             && memcmp(sum2, s->sums[want_i].sum2, s->s2length) == 0) {
260                                 /* we've found an adjacent match - the RLL coder
261                                  * will be happy */
262                                 i = want_i;
263                         }
264                     set_want_i:
265                         want_i = i + 1;
266
267                         matched(f,s,buf,offset,i);
268                         offset += s->sums[i].len - 1;
269                         k = (int32)MIN((OFF_T)s->blength, len-offset);
270                         map = (schar *)map_ptr(buf, offset, k);
271                         sum = get_checksum1((char *)map, k);
272                         s1 = sum & 0xFFFF;
273                         s2 = sum >> 16;
274                         matches++;
275                         break;
276                 } while (++j < s->count && targets[j].t == t);
277
278         null_tag:
279                 backup = offset - last_match;
280                 /* We sometimes read 1 byte prior to last_match... */
281                 if (backup < 0)
282                         backup = 0;
283
284                 /* Trim off the first byte from the checksum */
285                 more = offset + k < len;
286                 map = (schar *)map_ptr(buf, offset - backup, k + more + backup)
287                     + backup;
288                 s1 -= map[0] + CHAR_OFFSET;
289                 s2 -= k * (map[0]+CHAR_OFFSET);
290
291                 /* Add on the next byte (if there is one) to the checksum */
292                 if (more) {
293                         s1 += map[k] + CHAR_OFFSET;
294                         s2 += s1;
295                 } else
296                         --k;
297
298                 /* By matching early we avoid re-reading the
299                    data 3 times in the case where a token
300                    match comes a long way after last
301                    match. The 3 reads are caused by the
302                    running match, the checksum update and the
303                    literal send. */
304                 if (backup >= s->blength+CHUNK_SIZE && end-offset > CHUNK_SIZE)
305                         matched(f, s, buf, offset - s->blength, -2);
306         } while (++offset < end);
307
308         matched(f, s, buf, len, -1);
309         map_ptr(buf, len-1, 1);
310 }
311
312
313 /**
314  * Scan through a origin file, looking for sections that match
315  * checksums from the generator, and transmit either literal or token
316  * data.
317  *
318  * Also calculates the MD4 checksum of the whole file, using the md
319  * accumulator.  This is transmitted with the file as protection
320  * against corruption on the wire.
321  *
322  * @param s Checksums received from the generator.  If <tt>s->count ==
323  * 0</tt>, then there are actually no checksums for this file.
324  *
325  * @param len Length of the file to send.
326  **/
327 void match_sums(int f, struct sum_struct *s, struct map_struct *buf, OFF_T len)
328 {
329         char file_sum[MD4_SUM_LENGTH];
330
331         last_match = 0;
332         false_alarms = 0;
333         tag_hits = 0;
334         matches = 0;
335         data_transfer = 0;
336
337         sum_init(checksum_seed);
338
339         if (len > 0 && s->count > 0) {
340                 build_hash_table(s);
341
342                 if (verbose > 2)
343                         rprintf(FINFO,"built hash table\n");
344
345                 hash_search(f,s,buf,len);
346
347                 if (verbose > 2)
348                         rprintf(FINFO,"done hash search\n");
349         } else {
350                 OFF_T j;
351                 /* by doing this in pieces we avoid too many seeks */
352                 for (j = CHUNK_SIZE; j < len; j += CHUNK_SIZE)
353                         matched(f, s, buf, j, -2);
354                 matched(f, s, buf, len, -1);
355         }
356
357         sum_end(file_sum);
358         /* If we had a read error, send a bad checksum. */
359         if (buf && buf->status != 0)
360                 file_sum[0]++;
361
362         if (verbose > 2)
363                 rprintf(FINFO,"sending file_sum\n");
364         write_buf(f,file_sum,MD4_SUM_LENGTH);
365
366         if (targets) {
367                 free(targets);
368                 targets=NULL;
369         }
370
371         if (verbose > 2)
372                 rprintf(FINFO, "false_alarms=%d tag_hits=%d matches=%d\n",
373                         false_alarms, tag_hits, matches);
374
375         total_tag_hits += tag_hits;
376         total_false_alarms += false_alarms;
377         total_matches += matches;
378         stats.literal_data += data_transfer;
379 }
380
381 void match_report(void)
382 {
383         if (verbose <= 1)
384                 return;
385
386         rprintf(FINFO,
387                 "total: matches=%d  tag_hits=%d  false_alarms=%d data=%.0f\n",
388                 total_matches,total_tag_hits,
389                 total_false_alarms,
390                 (double)stats.literal_data);
391 }