match.c

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