1 This patch adds the --detect-renamed option which makes rsync notice files
2 that either (1) match in size & modify-time (plus the basename, if possible)
3 or (2) match in size & checksum (when --checksum was also specified) and use
4 each match as an alternate basis file to speed up the transfer.
6 The algorithm attempts to scan the receiving-side's files in an efficient
7 manner. If --delete[-before] is enabled, we'll take advantage of the
8 pre-transfer delete pass to prepare any alternate-basis-file matches we
9 might find. If --delete-before is not enabled, rsync does the rename scan
10 during the regular file-sending scan (scanning each directory right before
11 the generator starts updating files from that dir). In this latter mode,
12 rsync might delay the updating of a file (if no alternate-basis match was
13 yet found) until the full scan of the receiving side is complete, at which
14 point any delayed files are processed.
16 I chose to hard-link the alternate-basis files into a ".~tmp~" subdir that
17 takes advantage of rsync's pre-existing partial-dir logic. This uses less
18 memory than trying to keep track of the matches internally, and also allows
19 any deletions or file-updates to occur normally without interfering with
20 these alternate-basis discoveries.
22 After applying this patch, run these commands for a successful build:
25 ./configure (optional if already run)
30 We need to never return a match from fattr_find() that has a basis
31 file. This will ensure that we don't try to give a renamed file to
32 a file that can't use it, while missing out on giving it to a file
37 @@ -55,6 +55,7 @@ extern int implied_dirs;
38 extern int prune_empty_dirs;
39 extern int copy_links;
40 extern int copy_unsafe_links;
41 +extern int detect_renamed;
42 extern int protocol_version;
43 extern int sanitize_paths;
44 extern const char *io_write_phase;
45 @@ -73,6 +74,8 @@ int checksum_len;
46 dev_t filesystem_dev; /* used to implement -x */
47 unsigned int file_struct_len;
49 +struct file_list the_fattr_list;
51 static char empty_sum[MD4_SUM_LENGTH];
52 static int flist_count_offset;
54 @@ -259,6 +262,44 @@ static mode_t from_wire_mode(int mode)
58 +static int fattr_compare(struct file_struct **file1, struct file_struct **file2)
60 + struct file_struct *f1 = *file1;
61 + struct file_struct *f2 = *file2;
64 + if (!f1->basename || !S_ISREG(f1->mode) || !f1->length) {
65 + if (!f2->basename || !S_ISREG(f2->mode) || !f2->length)
69 + if (!f2->basename || !S_ISREG(f2->mode) || !f2->length)
72 + /* Don't use diff for values that are longer than an int. */
73 + if (f1->length != f2->length)
74 + return f1->length < f2->length ? -1 : 1;
76 + if (always_checksum) {
77 + diff = u_memcmp(f1->u.sum, f2->u.sum, checksum_len);
80 + } else if (f1->modtime != f2->modtime)
81 + return f1->modtime < f2->modtime ? -1 : 1;
83 + diff = u_strcmp(f1->basename, f2->basename);
87 + if (f1->dirname == f2->dirname)
93 + return u_strcmp(f1->dirname, f2->dirname);
96 static void send_directory(int f, struct file_list *flist,
99 @@ -1387,6 +1428,25 @@ struct file_list *recv_file_list(int f)
101 clean_flist(flist, relative_paths, 1);
103 + if (detect_renamed) {
104 + int j = flist->count;
105 + the_fattr_list.count = j;
106 + the_fattr_list.files = new_array(struct file_struct *, j);
107 + if (!the_fattr_list.files)
109 + memcpy(the_fattr_list.files, flist->files,
110 + j * sizeof (struct file_struct *));
111 + qsort(the_fattr_list.files, j,
112 + sizeof the_fattr_list.files[0], (int (*)())fattr_compare);
113 + the_fattr_list.low = 0;
115 + struct file_struct *fp = the_fattr_list.files[j];
116 + if (fp->basename && S_ISREG(fp->mode) && fp->length)
119 + the_fattr_list.high = j;
123 recv_uid_list(f, flist);
127 @@ -77,6 +77,7 @@ extern char *basis_dir[];
128 extern int compare_dest;
129 extern int copy_dest;
130 extern int link_dest;
131 +extern int detect_renamed;
132 extern int whole_file;
133 extern int list_only;
134 extern int read_batch;
135 @@ -91,14 +92,17 @@ extern char *backup_dir;
136 extern char *backup_suffix;
137 extern int backup_suffix_len;
138 extern struct file_list *the_file_list;
139 +extern struct file_list the_fattr_list;
140 extern struct filter_list_struct server_filter_list;
142 static int deletion_count = 0; /* used to implement --max-delete */
143 +static int unexplored_dirs = 1;
144 static int can_link_symlinks = 1; /* start out optimistic */
145 static int can_link_devices = 1;
147 -/* For calling delete_file() */
148 +/* For calling delete_item() and delete_in_dir() */
149 #define DEL_FORCE_RECURSE (1<<1) /* recurse even w/o --force */
150 +#define DEL_NO_DELETIONS (1<<2)
151 #define DEL_TERSE (1<<3)
154 @@ -108,12 +112,120 @@ static int is_backup_file(char *fn)
155 return k > 0 && strcmp(fn+k, backup_suffix) == 0;
158 +/* Search for a regular file that matches either (1) the size & modified
159 + * time (plus the basename, if possible) or (2) the size & checksum. If
160 + * we find an exact match down to the dirname, return -1 because we found
161 + * an up-to-date file in the transfer, not a renamed file. */
162 +static int fattr_find(struct file_struct *f, char *fname, alloc_pool_t pool)
164 + int low = the_fattr_list.low, high = the_fattr_list.high;
165 + int mid, ok_match = -1, good_match = -1;
166 + struct file_struct *fmid;
169 + while (low <= high) {
170 + mid = (low + high) / 2;
171 + fmid = the_fattr_list.files[mid];
172 + if (fmid->length != f->length) {
173 + if (fmid->length < f->length)
179 + if (always_checksum) {
181 + if (fmid->modtime == f->modtime
182 + && f_name_cmp(fmid, f) == 0)
183 + return -1; /* assume we can't help */
184 + f->u.sum = pool_alloc(pool, MD4_SUM_LENGTH,
186 + file_checksum(fname, f->u.sum, f->length);
188 + diff = u_memcmp(fmid->u.sum, f->u.sum, checksum_len);
197 + if (fmid->modtime != f->modtime) {
198 + if (fmid->modtime < f->modtime)
206 + diff = u_strcmp(fmid->basename, f->basename);
209 + if (fmid->dirname == f->dirname)
210 + return -1; /* file is up-to-date */
211 + if (!fmid->dirname) {
219 + diff = u_strcmp(fmid->dirname, f->dirname);
221 + return -1; /* file is up-to-date */
229 + return good_match >= 0 ? good_match : ok_match;
232 +static void look_for_rename(struct file_struct *file, char *fname,
235 + struct file_struct *fp;
236 + char *partialptr, *fn;
240 + if ((ndx = fattr_find(file, fname, pool)) < 0)
243 + fp = the_fattr_list.files[ndx];
244 + fn = f_name(fp, NULL);
245 + /* We don't provide an alternate-basis file if there is a basis file. */
246 + if (link_stat(fn, &st, 0) == 0)
248 + if ((partialptr = partial_dir_fname(fn)) == NULL
249 + || !handle_partial_dir(partialptr, PDIR_CREATE))
252 + /* We only use the file if we can hard-link it into our tmp dir. */
253 + if (link(fname, partialptr) == 0) {
255 + rprintf(FINFO, "found renamed: %s => %s\n",
256 + fname, partialptr);
261 + if (errno != EEXIST)
262 + handle_partial_dir(partialptr, PDIR_DELETE);
265 /* Delete a file or directory. If DEL_FORCE_RECURSE is set in the flags, or if
266 * force_delete is set, this will delete recursively.
268 * Note that fname must point to a MAXPATHLEN buffer if the mode indicates it's
269 * a directory! (The buffer is used for recursion, but returned unchanged.)
271 + * Also Note: --detect-rename may use this routine with DEL_NO_DELETIONS set!
273 static int delete_item(char *fname, int mode, int flags)
275 @@ -124,6 +236,8 @@ static int delete_item(char *fname, int
278 if (!S_ISDIR(mode)) {
279 + if (flags & DEL_NO_DELETIONS)
281 if (max_delete && ++deletion_count > max_delete)
283 if (make_backups && (backup_dir || !is_backup_file(fname)))
284 @@ -146,6 +260,7 @@ static int delete_item(char *fname, int
286 zap_dir = flags & DEL_FORCE_RECURSE || force_delete;
287 if ((max_delete && ++deletion_count > max_delete)
288 + || flags & DEL_NO_DELETIONS
289 || (dry_run && zap_dir)) {
292 @@ -188,6 +303,8 @@ static int delete_item(char *fname, int
295 strlcpy(p, fp->basename, remainder);
296 + if (detect_renamed && S_ISREG(fp->mode))
297 + look_for_rename(fp, fname, dirlist->file_pool);
298 delete_item(fname, fp->mode, flags & ~DEL_TERSE);
301 @@ -196,7 +313,8 @@ static int delete_item(char *fname, int
303 pop_local_filters(save_filters);
305 - if (max_delete && ++deletion_count > max_delete)
306 + if (flags & DEL_NO_DELETIONS
307 + || (max_delete && ++deletion_count > max_delete))
310 if (do_rmdir(fname) == 0) {
311 @@ -216,15 +334,19 @@ static int delete_item(char *fname, int
312 * all the --delete-WHEN options. Note that the fbuf pointer must point to a
313 * MAXPATHLEN buffer with the name of the directory in it (the functions we
314 * call will append names onto the end, but the old dir value will be restored
318 + * Note: --detect-rename may use this routine with DEL_NO_DELETIONS set!
320 static void delete_in_dir(struct file_list *flist, char *fbuf,
321 - struct file_struct *file, STRUCT_STAT *stp)
322 + struct file_struct *file, STRUCT_STAT *stp, int flags)
324 static int min_depth = MAXPATHLEN, cur_depth = -1;
325 static void *filt_array[MAXPATHLEN/2+1];
326 static int already_warned = 0;
327 struct file_list *dirlist;
328 - char delbuf[MAXPATHLEN];
329 + char *p, delbuf[MAXPATHLEN];
330 + unsigned remainder;
334 @@ -238,6 +360,8 @@ static void delete_in_dir(struct file_li
336 rprintf(FINFO, "delete_in_dir(%s)\n", fbuf);
338 + flags |= DEL_FORCE_RECURSE;
341 maybe_send_keepalive();
343 @@ -245,12 +369,14 @@ static void delete_in_dir(struct file_li
344 return; /* Impossible... */
346 if (io_error && !(lp_ignore_errors(module_id) || ignore_errors)) {
347 - if (already_warned)
348 + if (!already_warned) {
350 + "IO error encountered -- skipping file deletion\n");
351 + already_warned = 1;
353 + if (!detect_renamed)
356 - "IO error encountered -- skipping file deletion\n");
357 - already_warned = 1;
359 + flags |= DEL_NO_DELETIONS;
362 while (cur_depth >= file->dir.depth && cur_depth >= min_depth)
363 @@ -261,6 +387,9 @@ static void delete_in_dir(struct file_li
365 filt_array[cur_depth] = push_local_filters(fbuf, dlen);
367 + if (detect_renamed)
370 if (one_file_system) {
371 if (file->flags & FLAG_TOP_DIR)
372 filesystem_dev = stp->st_dev;
373 @@ -270,18 +399,30 @@ static void delete_in_dir(struct file_li
375 dirlist = get_dirlist(fbuf, dlen, 0);
378 + if (dlen != 1 || *fbuf != '/')
380 + remainder = MAXPATHLEN - (p - fbuf);
382 /* If an item in dirlist is not found in flist, delete it
383 * from the filesystem. */
384 for (i = dirlist->count; i--; ) {
385 struct file_struct *fp = dirlist->files[i];
386 if (!fp->basename || fp->flags & FLAG_MOUNT_POINT)
388 + if (detect_renamed && S_ISREG(fp->mode)) {
389 + strlcpy(p, fp->basename, remainder);
390 + look_for_rename(fp, fbuf, dirlist->file_pool);
392 if (flist_find(flist, fp) < 0) {
394 - delete_item(delbuf, fp->mode, DEL_FORCE_RECURSE);
396 + delete_item(delbuf, fp->mode, flags);
397 + } else if (detect_renamed && S_ISDIR(fp->mode))
406 @@ -311,9 +452,9 @@ static void do_delete_pass(struct file_l
407 || !S_ISDIR(st.st_mode))
410 - delete_in_dir(flist, fbuf, file, &st);
411 + delete_in_dir(flist, fbuf, file, &st, 0);
413 - delete_in_dir(NULL, NULL, NULL, NULL);
414 + delete_in_dir(NULL, NULL, NULL, NULL, 0);
416 if (do_progress && !am_server)
417 rprintf(FINFO, " \r");
418 @@ -752,6 +893,7 @@ static int try_dests_non(struct file_str
422 +static struct bitbag *delayed_bits = NULL;
423 static int phase = 0;
425 /* Acts on the_file_list->file's ndx'th item, whose name is fname. If a dir,
426 @@ -906,8 +1048,12 @@ static void recv_generator(char *fname,
427 && verbose && code && f_out != -1)
428 rprintf(code, "%s/\n", fname);
429 if (delete_during && f_out != -1 && !phase && dry_run < 2
430 - && (file->flags & FLAG_DEL_HERE))
431 - delete_in_dir(the_file_list, fname, file, &st);
432 + && (file->flags & FLAG_DEL_HERE)) {
433 + if (detect_renamed && statret != 0)
435 + delete_in_dir(the_file_list, fname, file, &st,
436 + delete_during < 0 ? DEL_NO_DELETIONS : 0);
441 @@ -1145,8 +1291,14 @@ static void recv_generator(char *fname,
442 && hard_link_check(file, ndx, fname, statret, &st,
443 itemizing, code, HL_SKIP))
445 - if (stat_errno == ENOENT)
446 + if (stat_errno == ENOENT) {
447 + if (detect_renamed && unexplored_dirs > 0
449 + bitbag_set_bit(delayed_bits, ndx);
454 rsyserr(FERROR, stat_errno, "recv_generator: failed to stat %s",
457 @@ -1323,11 +1475,17 @@ void generate_files(int f_out, struct fi
458 (long)getpid(), flist->count);
461 + if (detect_renamed) {
462 + delayed_bits = bitbag_create(flist->count);
463 + if (!delete_before && !delete_during)
464 + delete_during = -1;
467 if (delete_before && !local_name && flist->count > 0)
468 do_delete_pass(flist);
471 - if (append_mode || whole_file < 0)
472 + if (append_mode || detect_renamed || whole_file < 0)
475 rprintf(FINFO, "delta-transmission %s\n",
476 @@ -1382,7 +1540,23 @@ void generate_files(int f_out, struct fi
478 recv_generator(NULL, NULL, 0, 0, 0, code, -1);
480 - delete_in_dir(NULL, NULL, NULL, NULL);
481 + delete_in_dir(NULL, NULL, NULL, NULL, 0);
483 + if (detect_renamed) {
484 + if (delete_during < 0)
486 + detect_renamed = 0;
488 + for (i = -1; (i = bitbag_next_bit(delayed_bits, i)) >= 0; ) {
489 + struct file_struct *file = flist->files[i];
491 + strlcpy(fbuf, local_name, sizeof fbuf);
493 + f_name(file, fbuf);
494 + recv_generator(fbuf, file, i, itemizing,
495 + maybe_ATTRS_REPORT, code, f_out);
500 csum_length = SUM_LENGTH;
503 @@ -78,6 +78,7 @@ int am_generator = 0;
504 int am_starting_up = 1;
505 int relative_paths = -1;
506 int implied_dirs = 1;
507 +int detect_renamed = 0;
509 int allow_8bit_chars = 0;
510 int force_delete = 0;
511 @@ -336,6 +337,7 @@ void usage(enum logcode F)
512 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
513 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
514 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
515 + rprintf(F," --detect-renamed try to find renamed files to speed up the transfer\n");
516 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
517 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
518 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
519 @@ -483,6 +485,7 @@ static struct poptOption long_options[]
520 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
521 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
522 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
523 + {"detect-renamed", 0, POPT_ARG_NONE, &detect_renamed, 0, 0, 0 },
524 {"fuzzy", 'y', POPT_ARG_NONE, &fuzzy_basis, 0, 0, 0 },
525 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
526 {"compress-level", 0, POPT_ARG_INT, &def_compress_level, 'z', 0, 0 },
527 @@ -1343,7 +1346,7 @@ int parse_arguments(int *argc, const cha
531 - if (delay_updates && !partial_dir)
532 + if ((delay_updates || detect_renamed) && !partial_dir)
533 partial_dir = tmp_partialdir;
536 @@ -1352,6 +1355,7 @@ int parse_arguments(int *argc, const cha
537 snprintf(err_buf, sizeof err_buf,
538 "--%s cannot be used with --%s\n",
539 append_mode ? "append" : "inplace",
540 + detect_renamed ? "detect-renamed" :
541 delay_updates ? "delay-updates" : "partial-dir");
544 @@ -1654,6 +1658,8 @@ void server_options(char **args,int *arg
545 args[ac++] = "--super";
547 args[ac++] = "--size-only";
548 + if (detect_renamed)
549 + args[ac++] = "--detect-renamed";
552 if (modify_window_set) {
555 @@ -362,6 +362,7 @@ to the detailed description below for a
556 --modify-window=NUM compare mod-times with reduced accuracy
557 -T, --temp-dir=DIR create temporary files in directory DIR
558 -y, --fuzzy find similar file for basis if no dest file
559 + --detect-renamed try to find renamed files to speed the xfer
560 --compare-dest=DIR also compare received files relative to DIR
561 --copy-dest=DIR ... and include copies of unchanged files
562 --link-dest=DIR hardlink to files in DIR when unchanged
563 @@ -1240,6 +1241,15 @@ Note that the use of the bf(--delete) op
564 fuzzy-match files, so either use bf(--delete-after) or specify some
565 filename exclusions if you need to prevent this.
567 +dit(bf(--detect-renamed)) This option tells rsync to scan the receiving
568 +side for files that have been renamed, and to use any that are found as
569 +alternate basis files to help speed up the transfer.
570 +By default, alternate-basis files are hard-linked into a directory named
571 +".~tmp~" in each file's destination directory, but if you've specified
572 +the bf(--partial-dir) option, that directory will be used instead. These
573 +potential alternate-basis files will be removed as the transfer progresses.
574 +This option conflicts with bf(--inplace) and bf(--append).
576 dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on
577 the destination machine as an additional hierarchy to compare destination
578 files against doing transfers (if the files are missing in the destination
581 @@ -1013,6 +1013,32 @@ int handle_partial_dir(const char *fname
585 +/* We need to supply our own strcmp function for file list comparisons
586 + * to ensure that signed/unsigned usage is consistent between machines. */
587 +int u_strcmp(const char *p1, const char *p2)
589 + for ( ; *p1; p1++, p2++) {
594 + return (int)*(uchar*)p1 - (int)*(uchar*)p2;
597 +/* We need a memcmp function compares unsigned-byte values. */
598 +int u_memcmp(const void *p1, const void *p2, size_t len)
600 + const uchar *u1 = p1;
601 + const uchar *u2 = p2;
605 + return (int)*u1 - (int)*u2;
612 * Determine if a symlink points outside the current directory tree.
613 * This is considered "unsafe" because e.g. when mirroring somebody