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