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