Preparing for release of 2.6.6pre1
[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
27 int updating_basis_file;
28
29 typedef unsigned short tag;
30
31 #define TABLESIZE (1<<16)
32 #define NULL_TAG (-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         int32 i;
48 };
49
50 static struct target *targets;
51
52 static int32 *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         int32 i;
66
67         if (!tag_table)
68                 tag_table = new_array(int32, 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, int32 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
140
141 static void hash_search(int f,struct sum_struct *s,
142                         struct map_struct *buf, OFF_T len)
143 {
144         OFF_T offset, end, backup;
145         int32 k, want_i;
146         char sum2[SUM_LENGTH];
147         uint32 s1, s2, sum;
148         int more;
149         schar *map;
150
151         /* want_i is used to encourage adjacent matches, allowing the RLL
152          * coding of the output to work more efficiently. */
153         want_i = 0;
154
155         if (verbose > 2) {
156                 rprintf(FINFO, "hash search b=%ld len=%.0f\n",
157                         (long)s->blength, (double)len);
158         }
159
160         k = (int32)MIN(len, (OFF_T)s->blength);
161
162         map = (schar *)map_ptr(buf, 0, k);
163
164         sum = get_checksum1((char *)map, k);
165         s1 = sum & 0xFFFF;
166         s2 = sum >> 16;
167         if (verbose > 3)
168                 rprintf(FINFO, "sum=%.8x k=%ld\n", sum, (long)k);
169
170         offset = 0;
171
172         end = len + 1 - s->sums[s->count-1].len;
173
174         if (verbose > 3) {
175                 rprintf(FINFO, "hash search s->blength=%ld len=%.0f count=%.0f\n",
176                         (long)s->blength, (double)len, (double)s->count);
177         }
178
179         do {
180                 tag t = gettag2(s1,s2);
181                 int done_csum2 = 0;
182                 int32 j = tag_table[t];
183
184                 if (verbose > 4)
185                         rprintf(FINFO,"offset=%.0f sum=%08x\n",(double)offset,sum);
186
187                 if (j == NULL_TAG)
188                         goto null_tag;
189
190                 sum = (s1 & 0xffff) | (s2 << 16);
191                 tag_hits++;
192                 do {
193                         int32 l, i = targets[j].i;
194
195                         if (sum != s->sums[i].sum1)
196                                 continue;
197
198                         /* also make sure the two blocks are the same length */
199                         l = (int32)MIN((OFF_T)s->blength, len-offset);
200                         if (l != s->sums[i].len)
201                                 continue;
202
203                         /* in-place: ensure chunk's offset is either >= our
204                          * offset or that the data didn't move. */
205                         if (updating_basis_file && s->sums[i].offset < offset
206                             && !(s->sums[i].flags & SUMFLG_SAME_OFFSET))
207                                 continue;
208
209                         if (verbose > 3)
210                                 rprintf(FINFO,"potential match at %.0f target=%.0f %.0f sum=%08x\n",
211                                         (double)offset,(double)j,(double)i,sum);
212
213                         if (!done_csum2) {
214                                 map = (schar *)map_ptr(buf,offset,l);
215                                 get_checksum2((char *)map,l,sum2);
216                                 done_csum2 = 1;
217                         }
218
219                         if (memcmp(sum2,s->sums[i].sum2,s->s2length) != 0) {
220                                 false_alarms++;
221                                 continue;
222                         }
223
224                         /* When updating in-place, the best possible match is
225                          * one with an identical offset, so we prefer that over
226                          * the following want_i optimization. */
227                         if (updating_basis_file) {
228                                 do {
229                                         int32 i2 = targets[j].i;
230                                         if (s->sums[i2].offset != offset)
231                                                 continue;
232                                         if (i2 != i) {
233                                                 if (sum != s->sums[i2].sum1)
234                                                         break;
235                                                 if (memcmp(sum2, s->sums[i2].sum2,
236                                                            s->s2length) != 0)
237                                                         break;
238                                                 i = i2;
239                                         }
240                                         /* This chunk was at the same offset on
241                                          * both the sender and the receiver. */
242                                         s->sums[i].flags |= SUMFLG_SAME_OFFSET;
243                                         goto set_want_i;
244                                 } while (++j < s->count && targets[j].t == t);
245                         }
246
247                         /* we've found a match, but now check to see
248                          * if want_i can hint at a better match. */
249                         if (i != want_i && want_i < s->count
250                             && (!updating_basis_file || s->sums[want_i].offset >= offset
251                              || s->sums[want_i].flags & SUMFLG_SAME_OFFSET)
252                             && sum == s->sums[want_i].sum1
253                             && memcmp(sum2, s->sums[want_i].sum2, s->s2length) == 0) {
254                                 /* we've found an adjacent match - the RLL coder
255                                  * will be happy */
256                                 i = want_i;
257                         }
258                     set_want_i:
259                         want_i = i + 1;
260
261                         matched(f,s,buf,offset,i);
262                         offset += s->sums[i].len - 1;
263                         k = (int32)MIN((OFF_T)s->blength, len-offset);
264                         map = (schar *)map_ptr(buf, offset, k);
265                         sum = get_checksum1((char *)map, k);
266                         s1 = sum & 0xFFFF;
267                         s2 = sum >> 16;
268                         matches++;
269                         break;
270                 } while (++j < s->count && targets[j].t == t);
271
272         null_tag:
273                 backup = offset - last_match;
274                 /* We sometimes read 1 byte prior to last_match... */
275                 if (backup < 0)
276                         backup = 0;
277
278                 /* Trim off the first byte from the checksum */
279                 more = offset + k < len;
280                 map = (schar *)map_ptr(buf, offset - backup, k + more + backup)
281                     + backup;
282                 s1 -= map[0] + CHAR_OFFSET;
283                 s2 -= k * (map[0]+CHAR_OFFSET);
284
285                 /* Add on the next byte (if there is one) to the checksum */
286                 if (more) {
287                         s1 += map[k] + CHAR_OFFSET;
288                         s2 += s1;
289                 } else
290                         --k;
291
292                 /* By matching early we avoid re-reading the
293                    data 3 times in the case where a token
294                    match comes a long way after last
295                    match. The 3 reads are caused by the
296                    running match, the checksum update and the
297                    literal send. */
298                 if (backup >= s->blength+CHUNK_SIZE && end-offset > CHUNK_SIZE)
299                         matched(f, s, buf, offset - s->blength, -2);
300         } while (++offset < end);
301
302         matched(f, s, buf, len, -1);
303         map_ptr(buf, len-1, 1);
304 }
305
306
307 /**
308  * Scan through a origin file, looking for sections that match
309  * checksums from the generator, and transmit either literal or token
310  * data.
311  *
312  * Also calculates the MD4 checksum of the whole file, using the md
313  * accumulator.  This is transmitted with the file as protection
314  * against corruption on the wire.
315  *
316  * @param s Checksums received from the generator.  If <tt>s->count ==
317  * 0</tt>, then there are actually no checksums for this file.
318  *
319  * @param len Length of the file to send.
320  **/
321 void match_sums(int f, struct sum_struct *s, struct map_struct *buf, OFF_T len)
322 {
323         char file_sum[MD4_SUM_LENGTH];
324
325         last_match = 0;
326         false_alarms = 0;
327         tag_hits = 0;
328         matches = 0;
329         data_transfer = 0;
330
331         sum_init(checksum_seed);
332
333         if (len > 0 && s->count > 0) {
334                 build_hash_table(s);
335
336                 if (verbose > 2)
337                         rprintf(FINFO,"built hash table\n");
338
339                 hash_search(f,s,buf,len);
340
341                 if (verbose > 2)
342                         rprintf(FINFO,"done hash search\n");
343         } else {
344                 OFF_T j;
345                 /* by doing this in pieces we avoid too many seeks */
346                 for (j = CHUNK_SIZE; j < len; j += CHUNK_SIZE)
347                         matched(f, s, buf, j, -2);
348                 matched(f, s, buf, len, -1);
349         }
350
351         sum_end(file_sum);
352         /* If we had a read error, send a bad checksum. */
353         if (buf && buf->status != 0)
354                 file_sum[0]++;
355
356         if (verbose > 2)
357                 rprintf(FINFO,"sending file_sum\n");
358         write_buf(f,file_sum,MD4_SUM_LENGTH);
359
360         if (targets) {
361                 free(targets);
362                 targets=NULL;
363         }
364
365         if (verbose > 2)
366                 rprintf(FINFO, "false_alarms=%d tag_hits=%d matches=%d\n",
367                         false_alarms, tag_hits, matches);
368
369         total_tag_hits += tag_hits;
370         total_false_alarms += false_alarms;
371         total_matches += matches;
372         stats.literal_data += data_transfer;
373 }
374
375 void match_report(void)
376 {
377         if (verbose <= 1)
378                 return;
379
380         rprintf(FINFO,
381                 "total: matches=%d  tag_hits=%d  false_alarms=%d data=%.0f\n",
382                 total_matches,total_tag_hits,
383                 total_false_alarms,
384                 (double)stats.literal_data);
385 }