Some basic batch-mode tests.
[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
28 typedef unsigned short tag;
29
30 #define TABLESIZE (1<<16)
31 #define NULL_TAG ((size_t)-1)
32
33 static int false_alarms;
34 static int tag_hits;
35 static int matches;
36 static int64 data_transfer;
37
38 static int total_false_alarms;
39 static int total_tag_hits;
40 static int total_matches;
41
42 extern struct stats stats;
43
44 struct target {
45         tag t;
46         size_t i;
47 };
48
49 static struct target *targets;
50
51 static size_t *tag_table;
52
53 #define gettag2(s1,s2) (((s1) + (s2)) & 0xFFFF)
54 #define gettag(sum) gettag2((sum)&0xFFFF,(sum)>>16)
55
56 static int compare_targets(struct target *t1,struct target *t2)
57 {
58         return (int)t1->t - (int)t2->t;
59 }
60
61
62 static void build_hash_table(struct sum_struct *s)
63 {
64         size_t i;
65
66         if (!tag_table)
67                 tag_table = new_array(size_t, TABLESIZE);
68
69         targets = new_array(struct target, s->count);
70         if (!tag_table || !targets)
71                 out_of_memory("build_hash_table");
72
73         for (i = 0; i < s->count; i++) {
74                 targets[i].i = i;
75                 targets[i].t = gettag(s->sums[i].sum1);
76         }
77
78         qsort(targets,s->count,sizeof(targets[0]),(int (*)())compare_targets);
79
80         for (i = 0; i < TABLESIZE; i++)
81                 tag_table[i] = NULL_TAG;
82
83         for (i = s->count; i-- > 0; )
84                 tag_table[targets[i].t] = i;
85 }
86
87
88 static OFF_T last_match;
89
90
91 /**
92  * Transmit a literal and/or match token.
93  *
94  * This delightfully-named function is called either when we find a
95  * match and need to transmit all the unmatched data leading up to it,
96  * or when we get bored of accumulating literal data and just need to
97  * transmit it.  As a result of this second case, it is called even if
98  * we have not matched at all!
99  *
100  * @param i If >0, the number of a matched token.  If 0, indicates we
101  * have only literal data.
102  **/
103 static void matched(int f,struct sum_struct *s,struct map_struct *buf,
104                     OFF_T offset,int i)
105 {
106         OFF_T n = offset - last_match;
107         OFF_T j;
108
109         if (verbose > 2 && i >= 0)
110                 rprintf(FINFO,"match at %.0f last_match=%.0f j=%d len=%u n=%.0f\n",
111                         (double)offset,(double)last_match,i,s->sums[i].len,(double)n);
112
113         send_token(f,i,buf,last_match,n,i<0?0:s->sums[i].len);
114         data_transfer += n;
115
116         if (i >= 0) {
117                 stats.matched_data += s->sums[i].len;
118                 n += s->sums[i].len;
119         }
120
121         for (j = 0; j < n; j += CHUNK_SIZE) {
122                 int n1 = MIN(CHUNK_SIZE,n-j);
123                 sum_update(map_ptr(buf,last_match+j,n1),n1);
124         }
125
126
127         if (i >= 0)
128                 last_match = offset + s->sums[i].len;
129         else
130                 last_match = offset;
131
132         if (buf && do_progress) {
133                 show_progress(last_match, buf->file_size);
134
135                 if (i == -1)
136                         end_progress(buf->file_size);
137         }
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;
145         unsigned int k;
146         size_t want_i;
147         char sum2[SUM_LENGTH];
148         uint32 s1, s2, sum;
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=%u len=%.0f\n",
157                         s->blength, (double)len);
158         }
159
160         k = MIN(len, 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=%u\n", sum, 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=%u len=%.0f count=%.0f\n",
176                         s->blength, (double)len, (double)s->count);
177         }
178
179         do {
180                 tag t = gettag2(s1,s2);
181                 int done_csum2 = 0;
182                 size_t 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                         unsigned int l;
194                         size_t i = targets[j].i;
195
196                         if (sum != s->sums[i].sum1)
197                                 continue;
198
199                         /* also make sure the two blocks are the same length */
200                         l = MIN((OFF_T)s->blength, len-offset);
201                         if (l != s->sums[i].len)
202                                 continue;
203
204                         /* inplace: ensure chunk's offset is either >= our
205                          * offset or that the data didn't move. */
206                         if (inplace && s->sums[i].offset < offset
207                             && !(s->sums[i].flags & SUMFLG_SAME_OFFSET))
208                                 continue;
209
210                         if (verbose > 3)
211                                 rprintf(FINFO,"potential match at %.0f target=%.0f %.0f sum=%08x\n",
212                                         (double)offset,(double)j,(double)i,sum);
213
214                         if (!done_csum2) {
215                                 map = (schar *)map_ptr(buf,offset,l);
216                                 get_checksum2((char *)map,l,sum2);
217                                 done_csum2 = 1;
218                         }
219
220                         if (memcmp(sum2,s->sums[i].sum2,s->s2length) != 0) {
221                                 false_alarms++;
222                                 continue;
223                         }
224
225                         /* If inplace is enabled, the best possible match is
226                          * one with an identical offset, so we prefer that over
227                          * the following want_i optimization. */
228                         if (inplace) {
229                                 do {
230                                         size_t i2 = targets[j].i;
231                                         if (s->sums[i2].offset != offset)
232                                                 continue;
233                                         if (i2 != i) {
234                                                 if (sum != s->sums[i2].sum1)
235                                                         break;
236                                                 if (memcmp(sum2, s->sums[i2].sum2,
237                                                            s->s2length) != 0)
238                                                         break;
239                                                 i = i2;
240                                         }
241                                         /* This chunk was at the same offset on
242                                          * both the sender and the receiver. */
243                                         s->sums[i].flags |= SUMFLG_SAME_OFFSET;
244                                         goto set_want_i;
245                                 } while (++j < s->count && targets[j].t == t);
246                         }
247
248                         /* we've found a match, but now check to see
249                          * if want_i can hint at a better match. */
250                         if (i != want_i && want_i < s->count
251                             && (!inplace || s->sums[want_i].offset >= offset
252                              || s->sums[want_i].flags & SUMFLG_SAME_OFFSET)
253                             && sum == s->sums[want_i].sum1
254                             && memcmp(sum2, s->sums[want_i].sum2, s->s2length) == 0) {
255                                 /* we've found an adjacent match - the RLL coder
256                                  * will be happy */
257                                 i = want_i;
258                         }
259                     set_want_i:
260                         want_i = i + 1;
261
262                         matched(f,s,buf,offset,i);
263                         offset += s->sums[i].len - 1;
264                         k = MIN(s->blength, len-offset);
265                         map = (schar *)map_ptr(buf, offset, k);
266                         sum = get_checksum1((char *)map, k);
267                         s1 = sum & 0xFFFF;
268                         s2 = sum >> 16;
269                         matches++;
270                         break;
271                 } while (++j < s->count && targets[j].t == t);
272
273         null_tag:
274                 /* Trim off the first byte from the checksum */
275                 map = (schar *)map_ptr(buf, offset, k+1);
276                 s1 -= map[0] + CHAR_OFFSET;
277                 s2 -= k * (map[0]+CHAR_OFFSET);
278
279                 /* Add on the next byte (if there is one) to the checksum */
280                 if (k < (len-offset)) {
281                         s1 += (map[k]+CHAR_OFFSET);
282                         s2 += s1;
283                 } else
284                         --k;
285
286                 /* By matching early we avoid re-reading the
287                    data 3 times in the case where a token
288                    match comes a long way after last
289                    match. The 3 reads are caused by the
290                    running match, the checksum update and the
291                    literal send. */
292                 if (offset > last_match
293                  && offset-last_match >= CHUNK_SIZE+s->blength
294                  && end-offset > CHUNK_SIZE) {
295                         matched(f,s,buf,offset - s->blength, -2);
296                 }
297         } while (++offset < end);
298
299         matched(f,s,buf,len,-1);
300         map_ptr(buf,len-1,1);
301 }
302
303
304 /**
305  * Scan through a origin file, looking for sections that match
306  * checksums from the generator, and transmit either literal or token
307  * data.
308  *
309  * Also calculates the MD4 checksum of the whole file, using the md
310  * accumulator.  This is transmitted with the file as protection
311  * against corruption on the wire.
312  *
313  * @param s Checksums received from the generator.  If <tt>s->count ==
314  * 0</tt>, then there are actually no checksums for this file.
315  *
316  * @param len Length of the file to send.
317  **/
318 void match_sums(int f, struct sum_struct *s, struct map_struct *buf, OFF_T len)
319 {
320         char file_sum[MD4_SUM_LENGTH];
321
322         last_match = 0;
323         false_alarms = 0;
324         tag_hits = 0;
325         matches = 0;
326         data_transfer = 0;
327
328         sum_init(checksum_seed);
329
330         if (len > 0 && s->count>0) {
331                 build_hash_table(s);
332
333                 if (verbose > 2)
334                         rprintf(FINFO,"built hash table\n");
335
336                 hash_search(f,s,buf,len);
337
338                 if (verbose > 2)
339                         rprintf(FINFO,"done hash search\n");
340         } else {
341                 OFF_T j;
342                 /* by doing this in pieces we avoid too many seeks */
343                 for (j = 0; j < len-CHUNK_SIZE; j += CHUNK_SIZE) {
344                         int n1 = MIN(CHUNK_SIZE,(len-CHUNK_SIZE)-j);
345                         matched(f,s,buf,j+n1,-2);
346                 }
347                 matched(f,s,buf,len,-1);
348         }
349
350         sum_end(file_sum);
351         /* If we had a read error, send a bad checksum. */
352         if (buf && buf->status != 0)
353                 file_sum[0]++;
354
355         if (verbose > 2)
356                 rprintf(FINFO,"sending file_sum\n");
357         write_buf(f,file_sum,MD4_SUM_LENGTH);
358
359         if (targets) {
360                 free(targets);
361                 targets=NULL;
362         }
363
364         if (verbose > 2)
365                 rprintf(FINFO, "false_alarms=%d tag_hits=%d matches=%d\n",
366                         false_alarms, tag_hits, matches);
367
368         total_tag_hits += tag_hits;
369         total_false_alarms += false_alarms;
370         total_matches += matches;
371         stats.literal_data += data_transfer;
372 }
373
374 void match_report(void)
375 {
376         if (verbose <= 1)
377                 return;
378
379         rprintf(FINFO,
380                 "total: matches=%d  tag_hits=%d  false_alarms=%d data=%.0f\n",
381                 total_matches,total_tag_hits,
382                 total_false_alarms,
383                 (double)stats.literal_data);
384 }