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