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 To use this patch, run these commands for a successful build:
24 patch -p1 <patches/detect-renamed.diff
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 @@ -54,6 +54,7 @@ extern int non_perishable_cnt;
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 struct stats stats;
45 @@ -77,6 +78,8 @@ static dev_t tmp_rdev;
46 static struct idev tmp_idev;
47 static char tmp_sum[MD4_SUM_LENGTH];
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(F_SUM(f1), F_SUM(f2), 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 @@ -1411,6 +1452,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)
108 + out_of_memory("recv_file_list");
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 @@ -76,6 +76,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 new_root_dir;
135 @@ -91,18 +92,21 @@ 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 int ignore_perishable = 0;
143 int non_perishable_cnt = 0;
145 static int deletion_count = 0; /* used to implement --max-delete */
146 +static int unexplored_dirs = 1;
147 static int deldelay_size = 0, deldelay_cnt = 0;
148 static char *deldelay_buf = NULL;
149 static int deldelay_fd = -1;
150 static BOOL solo_file = 0;
152 -/* For calling delete_item() and delete_dir_contents(). */
153 +/* For calling delete_item(), delete_dir_contents(), and delete_in_dir(). */
154 +#define DEL_NO_DELETIONS (1<<0)
155 #define DEL_RECURSE (1<<1) /* recurse */
156 #define DEL_DIR_IS_EMPTY (1<<2) /* internal delete_FUNCTIONS use only */
158 @@ -124,11 +128,121 @@ static int is_backup_file(char *fn)
159 return k > 0 && strcmp(fn+k, backup_suffix) == 0;
162 +/* Search for a regular file that matches either (1) the size & modified
163 + * time (plus the basename, if possible) or (2) the size & checksum. If
164 + * we find an exact match down to the dirname, return -1 because we found
165 + * an up-to-date file in the transfer, not a renamed file. */
166 +static int fattr_find(struct file_struct *f, char *fname, alloc_pool_t pool)
168 + int low = the_fattr_list.low, high = the_fattr_list.high;
169 + int mid, ok_match = -1, good_match = -1;
170 + struct file_struct *fmid;
173 + while (low <= high) {
174 + mid = (low + high) / 2;
175 + fmid = the_fattr_list.files[mid];
176 + if (fmid->length != f->length) {
177 + if (fmid->length < f->length)
183 + if (always_checksum) {
185 + if (fmid->modtime == f->modtime
186 + && f_name_cmp(fmid, f) == 0)
187 + return -1; /* assume we can't help */
188 + /* XXX update this to new checksum var idiom! */
189 + F_SUM(f) = pool_alloc(pool, MD4_SUM_LENGTH,
191 + file_checksum(fname, F_SUM(f), f->length);
193 + diff = u_memcmp(F_SUM(fmid), F_SUM(f), checksum_len);
202 + if (fmid->modtime != f->modtime) {
203 + if (fmid->modtime < f->modtime)
211 + diff = u_strcmp(fmid->basename, f->basename);
214 + if (fmid->dirname == f->dirname)
215 + return -1; /* file is up-to-date */
216 + if (!fmid->dirname) {
224 + diff = u_strcmp(fmid->dirname, f->dirname);
226 + return -1; /* file is up-to-date */
234 + return good_match >= 0 ? good_match : ok_match;
237 +static void look_for_rename(struct file_struct *file, char *fname,
240 + struct file_struct *fp;
241 + char *partialptr, *fn;
245 + if ((ndx = fattr_find(file, fname, pool)) < 0)
248 + fp = the_fattr_list.files[ndx];
249 + fn = f_name(fp, NULL);
250 + /* We don't provide an alternate-basis file if there is a basis file. */
251 + if (link_stat(fn, &st, 0) == 0)
253 + if ((partialptr = partial_dir_fname(fn)) == NULL
254 + || !handle_partial_dir(partialptr, PDIR_CREATE))
257 + /* We only use the file if we can hard-link it into our tmp dir. */
258 + if (link(fname, partialptr) == 0) {
260 + rprintf(FINFO, "found renamed: %s => %s\n",
261 + fname, partialptr);
266 + if (errno != EEXIST)
267 + handle_partial_dir(partialptr, PDIR_DELETE);
270 /* Delete a file or directory. If DEL_RECURSE is set in the flags, this will
271 * delete recursively.
273 * Note that fbuf must point to a MAXPATHLEN buffer if the mode indicates it's
274 * a directory! (The buffer is used for recursion, but returned unchanged.)
276 + * Also note: --detect-rename may use this routine with DEL_NO_DELETIONS set!
278 static enum delret delete_item(char *fbuf, int mode, char *replace, int flags)
280 @@ -150,6 +264,8 @@ static enum delret delete_item(char *fbu
282 /* OK: try to delete the directory. */
284 + if (flags & DEL_NO_DELETIONS)
287 if (!replace && max_delete >= 0 && ++deletion_count > max_delete)
289 @@ -196,6 +312,8 @@ static enum delret delete_item(char *fbu
290 * its contents, otherwise just checks for content. Returns DR_SUCCESS or
291 * DR_NOT_EMPTY. Note that fname must point to a MAXPATHLEN buffer! (The
292 * buffer is used for recursion, but returned unchanged.)
294 + * Note: --detect-rename may use this routine with DEL_NO_DELETIONS set!
296 static enum delret delete_dir_contents(char *fname, int flags)
298 @@ -252,6 +370,8 @@ static enum delret delete_dir_contents(c
299 if (S_ISDIR(fp->mode)
300 && delete_dir_contents(fname, flags | DEL_RECURSE) != DR_SUCCESS)
302 + if (detect_renamed && S_ISREG(fp->mode))
303 + look_for_rename(fp, fname, dirlist->file_pool);
304 if (delete_item(fname, fp->mode, NULL, flags) != DR_SUCCESS)
307 @@ -404,15 +524,19 @@ static void do_delayed_deletions(char *d
308 * all the --delete-WHEN options. Note that the fbuf pointer must point to a
309 * MAXPATHLEN buffer with the name of the directory in it (the functions we
310 * call will append names onto the end, but the old dir value will be restored
314 + * Note: --detect-rename may use this routine with DEL_NO_DELETIONS set!
316 static void delete_in_dir(struct file_list *flist, char *fbuf,
317 - struct file_struct *file, STRUCT_STAT *stp)
318 + struct file_struct *file, STRUCT_STAT *stp, int flags)
320 static int min_depth = MAXPATHLEN, cur_depth = -1;
321 static void *filt_array[MAXPATHLEN/2+1];
322 static int already_warned = 0;
323 struct file_list *dirlist;
324 - char delbuf[MAXPATHLEN];
325 + char *p, delbuf[MAXPATHLEN];
326 + unsigned remainder;
330 @@ -426,6 +550,8 @@ static void delete_in_dir(struct file_li
332 rprintf(FINFO, "delete_in_dir(%s)\n", fbuf);
334 + flags |= DEL_RECURSE;
337 maybe_send_keepalive();
339 @@ -433,12 +559,14 @@ static void delete_in_dir(struct file_li
340 return; /* Impossible... */
342 if (io_error && !(lp_ignore_errors(module_id) || ignore_errors)) {
343 - if (already_warned)
344 + if (!already_warned) {
346 + "IO error encountered -- skipping file deletion\n");
347 + already_warned = 1;
349 + if (!detect_renamed)
352 - "IO error encountered -- skipping file deletion\n");
353 - already_warned = 1;
355 + flags |= DEL_NO_DELETIONS;
358 while (cur_depth >= file->dir.depth && cur_depth >= min_depth)
359 @@ -449,6 +577,9 @@ static void delete_in_dir(struct file_li
361 filt_array[cur_depth] = push_local_filters(fbuf, dlen);
363 + if (detect_renamed)
366 if (one_file_system) {
367 if (file->flags & FLAG_TOP_DIR)
368 filesystem_dev = stp->st_dev;
369 @@ -458,6 +589,11 @@ static void delete_in_dir(struct file_li
371 dirlist = get_dirlist(fbuf, dlen, 0);
374 + if (dlen != 1 || *fbuf != '/')
376 + remainder = MAXPATHLEN - (p - fbuf);
378 /* If an item in dirlist is not found in flist, delete it
379 * from the filesystem. */
380 for (i = dirlist->count; i--; ) {
381 @@ -470,16 +606,23 @@ static void delete_in_dir(struct file_li
385 + if (detect_renamed && S_ISREG(fp->mode)) {
386 + strlcpy(p, fp->basename, remainder);
387 + look_for_rename(fp, fbuf, dirlist->file_pool);
389 if (flist_find(flist, fp) < 0) {
391 - if (delete_during == 2) {
392 ++ if (delete_during == 2 && !(flags & DEL_NO_DELETIONS)) {
393 if (!remember_delete(fp, delbuf))
396 - delete_item(delbuf, fp->mode, NULL, DEL_RECURSE);
398 + delete_item(delbuf, fp->mode, NULL, flags);
399 + } else if (detect_renamed && S_ISDIR(fp->mode))
408 @@ -509,9 +652,9 @@ static void do_delete_pass(struct file_l
409 || !S_ISDIR(st.st_mode))
412 - delete_in_dir(flist, fbuf, file, &st);
413 + delete_in_dir(flist, fbuf, file, &st, 0);
415 - delete_in_dir(NULL, NULL, NULL, NULL);
416 + delete_in_dir(NULL, NULL, NULL, NULL, 0);
418 if (do_progress && !am_server)
419 rprintf(FINFO, " \r");
420 @@ -1042,6 +1185,7 @@ static int try_dests_non(struct file_str
424 +static struct bitbag *delayed_bits = NULL;
425 static int phase = 0;
427 /* Acts on the_file_list->file's ndx'th item, whose name is fname. If a dir,
428 @@ -1228,8 +1372,12 @@ static void recv_generator(char *fname,
429 if (real_ret != 0 && one_file_system)
430 real_st.st_dev = filesystem_dev;
431 if (delete_during && f_out != -1 && !phase && dry_run < 2
432 - && (file->flags & FLAG_XFER_DIR))
433 - delete_in_dir(the_file_list, fname, file, &real_st);
434 + && (file->flags & FLAG_XFER_DIR)) {
435 + if (detect_renamed && real_ret != 0)
437 + delete_in_dir(the_file_list, fname, file, &real_st,
438 + delete_during < 0 ? DEL_NO_DELETIONS : 0);
443 @@ -1500,8 +1648,14 @@ static void recv_generator(char *fname,
444 itemizing, code, HL_SKIP))
447 - if (stat_errno == ENOENT)
448 + if (stat_errno == ENOENT) {
449 + if (detect_renamed && unexplored_dirs > 0
451 + bitbag_set_bit(delayed_bits, ndx);
456 rsyserr(FERROR, stat_errno, "recv_generator: failed to stat %s",
459 @@ -1691,6 +1845,12 @@ void generate_files(int f_out, struct fi
460 (long)getpid(), flist->count);
463 + if (detect_renamed) {
464 + delayed_bits = bitbag_create(flist->count);
465 + if (!delete_before && !delete_during)
466 + delete_during = -1;
469 if (delete_before && !local_name && flist->count > 0)
470 do_delete_pass(flist);
471 if (delete_during == 2) {
472 @@ -1701,7 +1861,7 @@ void generate_files(int f_out, struct fi
476 - if (append_mode || whole_file < 0)
477 + if (append_mode || detect_renamed || whole_file < 0)
480 rprintf(FINFO, "delta-transmission %s\n",
481 @@ -1758,7 +1918,23 @@ void generate_files(int f_out, struct fi
483 recv_generator(NULL, NULL, 0, 0, 0, code, -1);
485 - delete_in_dir(NULL, NULL, NULL, NULL);
486 + delete_in_dir(NULL, NULL, NULL, NULL, 0);
488 + if (detect_renamed) {
489 + if (delete_during < 0)
491 + detect_renamed = 0;
493 + for (i = -1; (i = bitbag_next_bit(delayed_bits, i)) >= 0; ) {
494 + struct file_struct *file = flist->files[i];
496 + strlcpy(fbuf, local_name, sizeof fbuf);
498 + f_name(file, fbuf);
499 + recv_generator(fbuf, file, i, itemizing,
500 + maybe_ATTRS_REPORT, code, f_out);
505 csum_length = SUM_LENGTH;
508 @@ -78,6 +78,7 @@ int am_generator = 0;
509 int am_starting_up = 1;
510 int relative_paths = -1;
511 int implied_dirs = 1;
512 +int detect_renamed = 0;
514 int allow_8bit_chars = 0;
515 int force_delete = 0;
516 @@ -343,6 +344,7 @@ void usage(enum logcode F)
517 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
518 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
519 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
520 + rprintf(F," --detect-renamed try to find renamed files to speed up the transfer\n");
521 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
522 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
523 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
524 @@ -497,6 +499,7 @@ static struct poptOption long_options[]
525 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
526 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
527 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
528 + {"detect-renamed", 0, POPT_ARG_NONE, &detect_renamed, 0, 0, 0 },
529 {"fuzzy", 'y', POPT_ARG_NONE, &fuzzy_basis, 0, 0, 0 },
530 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
531 {"compress-level", 0, POPT_ARG_INT, &def_compress_level, 'z', 0, 0 },
532 @@ -1361,7 +1364,7 @@ int parse_arguments(int *argc, const cha
536 - if (delay_updates && !partial_dir)
537 + if ((delay_updates || detect_renamed) && !partial_dir)
538 partial_dir = tmp_partialdir;
541 @@ -1370,6 +1373,7 @@ int parse_arguments(int *argc, const cha
542 snprintf(err_buf, sizeof err_buf,
543 "--%s cannot be used with --%s\n",
544 append_mode ? "append" : "inplace",
545 + detect_renamed ? "detect-renamed" :
546 delay_updates ? "delay-updates" : "partial-dir");
549 @@ -1680,6 +1684,8 @@ void server_options(char **args,int *arg
550 args[ac++] = "--super";
552 args[ac++] = "--size-only";
553 + if (detect_renamed)
554 + args[ac++] = "--detect-renamed";
557 if (modify_window_set) {
560 @@ -364,6 +364,7 @@ to the detailed description below for a
561 --modify-window=NUM compare mod-times with reduced accuracy
562 -T, --temp-dir=DIR create temporary files in directory DIR
563 -y, --fuzzy find similar file for basis if no dest file
564 + --detect-renamed try to find renamed files to speed the xfer
565 --compare-dest=DIR also compare received files relative to DIR
566 --copy-dest=DIR ... and include copies of unchanged files
567 --link-dest=DIR hardlink to files in DIR when unchanged
568 @@ -1272,6 +1273,15 @@ Note that the use of the bf(--delete) op
569 fuzzy-match files, so either use bf(--delete-after) or specify some
570 filename exclusions if you need to prevent this.
572 +dit(bf(--detect-renamed)) This option tells rsync to scan the receiving
573 +side for files that have been renamed, and to use any that are found as
574 +alternate basis files to help speed up the transfer.
575 +By default, alternate-basis files are hard-linked into a directory named
576 +".~tmp~" in each file's destination directory, but if you've specified
577 +the bf(--partial-dir) option, that directory will be used instead. These
578 +potential alternate-basis files will be removed as the transfer progresses.
579 +This option conflicts with bf(--inplace) and bf(--append).
581 dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on
582 the destination machine as an additional hierarchy to compare destination
583 files against doing transfers (if the files are missing in the destination
586 @@ -1027,6 +1027,32 @@ int handle_partial_dir(const char *fname
590 +/* We need to supply our own strcmp function for file list comparisons
591 + * to ensure that signed/unsigned usage is consistent between machines. */
592 +int u_strcmp(const char *p1, const char *p2)
594 + for ( ; *p1; p1++, p2++) {
599 + return (int)*(uchar*)p1 - (int)*(uchar*)p2;
602 +/* We need a memcmp function compares unsigned-byte values. */
603 +int u_memcmp(const void *p1, const void *p2, size_t len)
605 + const uchar *u1 = p1;
606 + const uchar *u2 = p2;
610 + return (int)*u1 - (int)*u2;
617 * Determine if a symlink points outside the current directory tree.
618 * This is considered "unsafe" because e.g. when mirroring somebody