1 /* -*- c-file-style: "linux" -*-
3 rsync -- fast file replication program
5 Copyright (C) 1996-2000 by Andrew Tridgell
6 Copyright (C) Paul Mackerras 1996
7 Copyright (C) 2002 by Martin Pool <mbp@samba.org>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 extern int relative_paths;
29 extern int keep_dirlinks;
30 extern int preserve_links;
32 extern int preserve_devices;
33 extern int preserve_hard_links;
34 extern int preserve_perms;
35 extern int preserve_uid;
36 extern int preserve_gid;
37 extern int preserve_times;
38 extern int omit_dir_times;
39 extern int delete_during;
40 extern int update_only;
41 extern int opt_ignore_existing;
43 extern int make_backups;
44 extern int csum_length;
45 extern int ignore_times;
47 extern OFF_T max_size;
48 extern int io_timeout;
49 extern int protocol_version;
50 extern int always_checksum;
51 extern char *partial_dir;
52 extern char *basis_dir[];
53 extern int compare_dest;
55 extern int whole_file;
56 extern int local_server;
58 extern int read_batch;
59 extern int only_existing;
60 extern int orig_umask;
61 extern int safe_symlinks;
62 extern long block_size; /* "long" because popt can't set an int32. */
64 extern struct filter_list_struct server_filter_list;
66 static int unchanged_attrs(struct file_struct *file, STRUCT_STAT *st)
69 && (st->st_mode & CHMOD_BITS) != (file->mode & CHMOD_BITS))
72 if (am_root && preserve_uid && st->st_uid != file->uid)
75 if (preserve_gid && file->gid != GID_NONE && st->st_gid != file->gid)
81 /* Perform our quick-check heuristic for determining if a file is unchanged. */
82 static int unchanged_file(char *fn, struct file_struct *file, STRUCT_STAT *st)
84 if (st->st_size != file->length)
87 /* if always checksum is set then we use the checksum instead
88 of the file time to determine whether to sync */
89 if (always_checksum && S_ISREG(st->st_mode)) {
90 char sum[MD4_SUM_LENGTH];
91 file_checksum(fn, sum, st->st_size);
92 return memcmp(sum, file->u.sum, protocol_version < 21 ? 2
93 : MD4_SUM_LENGTH) == 0;
102 return cmp_modtime(st->st_mtime, file->modtime) == 0;
107 * set (initialize) the size entries in the per-file sum_struct
108 * calculating dynamic block and checksum sizes.
110 * This is only called from generate_and_send_sums() but is a separate
111 * function to encapsulate the logic.
113 * The block size is a rounded square root of file length.
115 * The checksum size is determined according to:
116 * blocksum_bits = BLOCKSUM_EXP + 2*log2(file_len) - log2(block_len)
117 * provided by Donovan Baarda which gives a probability of rsync
118 * algorithm corrupting data and falling back using the whole md4
121 * This might be made one of several selectable heuristics.
123 static void sum_sizes_sqroot(struct sum_struct *sum, int64 len)
129 blength = block_size;
130 else if (len <= BLOCK_SIZE * BLOCK_SIZE)
131 blength = BLOCK_SIZE;
136 for (c = 1, l = len, cnt = 0; l >>= 2; c <<= 1, cnt++) {}
137 if (cnt >= 31 || c >= MAX_BLOCK_SIZE)
138 blength = MAX_BLOCK_SIZE;
143 if (len < (int64)blength * blength)
146 } while (c >= 8); /* round to multiple of 8 */
147 blength = MAX(blength, BLOCK_SIZE);
151 if (protocol_version < 27) {
152 s2length = csum_length;
153 } else if (csum_length == SUM_LENGTH) {
154 s2length = SUM_LENGTH;
158 int b = BLOCKSUM_BIAS;
159 for (l = len; l >>= 1; b += 2) {}
160 for (c = blength; c >>= 1 && b; b--) {}
161 /* add a bit, subtract rollsum, round up. */
162 s2length = (b + 1 - 32 + 7) / 8; /* --optimize in compiler-- */
163 s2length = MAX(s2length, csum_length);
164 s2length = MIN(s2length, SUM_LENGTH);
168 sum->blength = blength;
169 sum->s2length = s2length;
170 sum->count = (len + (blength - 1)) / blength;
171 sum->remainder = (len % blength);
173 if (sum->count && verbose > 2) {
175 "count=%.0f rem=%ld blength=%ld s2length=%d flength=%.0f\n",
176 (double)sum->count, (long)sum->remainder, (long)sum->blength,
177 sum->s2length, (double)sum->flength);
183 * Generate and send a stream of signatures/checksums that describe a buffer
185 * Generate approximately one checksum every block_len bytes.
187 static void generate_and_send_sums(int fd, OFF_T len, int f_out, int f_copy)
190 struct map_struct *mapbuf;
191 struct sum_struct sum;
194 sum_sizes_sqroot(&sum, len);
197 mapbuf = map_file(fd, len, MAX_MAP_SIZE, sum.blength);
201 write_sum_head(f_out, &sum);
203 for (i = 0; i < sum.count; i++) {
204 int32 n1 = (int32)MIN(len, (OFF_T)sum.blength);
205 char *map = map_ptr(mapbuf, offset, n1);
206 uint32 sum1 = get_checksum1(map, n1);
207 char sum2[SUM_LENGTH];
210 full_write(f_copy, map, n1);
212 get_checksum2(map, n1, sum2);
216 "chunk[%.0f] offset=%.0f len=%ld sum1=%08lx\n",
217 (double)i, (double)offset, (long)n1,
218 (unsigned long)sum1);
220 write_int(f_out, sum1);
221 write_buf(f_out, sum2, sum.s2length);
231 /* Acts on flist->file's ndx'th item, whose name is fname. If a directory,
232 * make sure it exists, and has the right permissions/timestamp info. For
233 * all other non-regular files (symlinks, etc.) we create them here. For
234 * regular files that have changed, we try to find a basis file and then
235 * start sending checksums.
237 * Note that f_out is set to -1 when doing final directory-permission and
238 * modification-time repair. */
239 static void recv_generator(char *fname, struct file_list *flist,
240 struct file_struct *file, int ndx,
241 int f_out, int f_out_name)
243 int fd = -1, f_copy = -1;
244 STRUCT_STAT st, partial_st;
245 struct file_struct *back_file = NULL;
246 int statret, stat_errno;
247 char *fnamecmp, *partialptr, *backupptr = NULL;
248 char fnamecmpbuf[MAXPATHLEN];
255 rprintf(FINFO, "recv_generator(%s,%d)\n",
256 safe_fname(fname), ndx);
259 if (server_filter_list.head
260 && check_filter(&server_filter_list, fname,
261 S_ISDIR(file->mode)) < 0) {
263 rprintf(FINFO, "skipping server-excluded file \"%s\"\n",
273 statret = link_stat(fname, &st,
274 keep_dirlinks && S_ISDIR(file->mode));
278 if (only_existing && statret == -1 && stat_errno == ENOENT) {
279 /* we only want to update existing files */
281 rprintf(FINFO, "not creating new file \"%s\"\n",
287 if (statret == 0 && !preserve_perms
288 && S_ISDIR(st.st_mode) == S_ISDIR(file->mode)) {
289 /* if the file exists already and we aren't perserving
290 * permissions then act as though the remote end sent
291 * us the file permissions we already have */
292 file->mode = (file->mode & ~CHMOD_BITS)
293 | (st.st_mode & CHMOD_BITS);
296 if (S_ISDIR(file->mode)) {
297 /* The file to be received is a directory, so we need
298 * to prepare appropriately. If there is already a
299 * file of that name and it is *not* a directory, then
300 * we need to delete it. If it doesn't exist, then
301 * (perhaps recursively) create it. */
302 if (statret == 0 && !S_ISDIR(st.st_mode)) {
303 delete_file(fname, DEL_TERSE);
306 if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) {
307 if (!relative_paths || errno != ENOENT
308 || create_directory_path(fname, orig_umask) < 0
309 || do_mkdir(fname, file->mode) < 0) {
310 rsyserr(FERROR, errno,
311 "recv_generator: mkdir %s failed",
315 if (set_perms(fname, file, statret ? NULL : &st, 0)
316 && verbose && f_out != -1)
317 rprintf(FINFO, "%s/\n", safe_fname(fname));
318 if (delete_during && f_out != -1 && csum_length != SUM_LENGTH
319 && (file->flags & FLAG_DEL_HERE))
320 delete_in_dir(flist, fname, file);
322 } else if (max_size && file->length > max_size) {
324 rprintf(FINFO, "%s is over max-size\n",
330 if (preserve_links && S_ISLNK(file->mode)) {
332 if (safe_symlinks && unsafe_symlink(file->u.link, fname)) {
335 "ignoring unsafe symlink %s -> \"%s\"\n",
337 safe_fname(file->u.link));
342 int dflag = S_ISDIR(st.st_mode) ? DEL_DIR : 0;
343 char lnk[MAXPATHLEN];
347 && (len = readlink(fname, lnk, MAXPATHLEN-1)) > 0) {
349 /* A link already pointing to the
350 * right place -- no further action
352 if (strcmp(lnk, file->u.link) == 0) {
353 set_perms(fname, file, &st,
358 /* Not the right symlink (or not a symlink), so
360 delete_file(fname, dflag | DEL_TERSE);
362 if (do_symlink(file->u.link,fname) != 0) {
363 rsyserr(FERROR, errno, "symlink %s -> \"%s\" failed",
364 full_fname(fname), safe_fname(file->u.link));
366 set_perms(fname,file,NULL,0);
368 rprintf(FINFO, "%s -> %s\n", safe_fname(fname),
369 safe_fname(file->u.link));
376 if (am_root && preserve_devices && IS_DEVICE(file->mode)) {
378 st.st_mode != file->mode ||
379 st.st_rdev != file->u.rdev) {
380 int dflag = S_ISDIR(st.st_mode) ? DEL_DIR : 0;
381 delete_file(fname, dflag | DEL_TERSE);
383 rprintf(FINFO,"mknod(%s,0%o,0x%x)\n",
385 (int)file->mode, (int)file->u.rdev);
387 if (do_mknod(fname,file->mode,file->u.rdev) != 0) {
388 rsyserr(FERROR, errno, "mknod %s failed",
391 set_perms(fname,file,NULL,0);
393 rprintf(FINFO, "%s\n",
398 set_perms(fname, file, &st, PERMS_REPORT);
403 if (preserve_hard_links && hard_link_check(file, HL_CHECK_MASTER))
406 if (!S_ISREG(file->mode)) {
407 rprintf(FINFO, "skipping non-regular file \"%s\"\n",
413 fnamecmp_type = FNAMECMP_FNAME;
415 if (statret == -1 && basis_dir[0] != NULL) {
416 int fallback_match = -1;
420 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
421 basis_dir[i], fname);
422 if (link_stat(fnamecmpbuf, &st, 0) == 0
423 && S_ISREG(st.st_mode)) {
429 } else if (match_level == 2
430 && !unchanged_attrs(file, &st))
432 if (!unchanged_file(fnamecmpbuf, file, &st))
436 if (!unchanged_attrs(file, &st))
442 } while (basis_dir[++i] != NULL);
444 if (match_level < 3) {
446 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
447 basis_dir[i], fname);
450 if (link_dest && match_level == 3 && !dry_run) {
451 if (do_link(fnamecmpbuf, fname) < 0) {
453 rsyserr(FINFO, errno,
455 full_fname(fnamecmpbuf),
458 fnamecmp = fnamecmpbuf;
464 fnamecmp = fnamecmpbuf;
470 if (statret == 0 && !S_ISREG(st.st_mode)) {
471 int dflag = S_ISDIR(st.st_mode) ? DEL_DIR : 0;
472 if (delete_file(fname, dflag | DEL_TERSE) != 0)
478 if (partial_dir && (partialptr = partial_dir_fname(fname)) != NULL
479 && link_stat(partialptr, &partial_st, 0) == 0
480 && S_ISREG(partial_st.st_mode)) {
482 goto prepare_to_open;
487 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
489 if (stat_errno == ENOENT)
492 rsyserr(FERROR, stat_errno,
493 "recv_generator: failed to stat %s",
499 if (opt_ignore_existing && fnamecmp_type == FNAMECMP_FNAME) {
501 rprintf(FINFO, "%s exists\n", safe_fname(fname));
505 if (update_only && fnamecmp_type == FNAMECMP_FNAME
506 && cmp_modtime(st.st_mtime, file->modtime) > 0) {
508 rprintf(FINFO, "%s is newer\n", safe_fname(fname));
512 if (!compare_dest && fnamecmp_type <= FNAMECMP_BASIS_DIR_HIGH)
514 else if (unchanged_file(fnamecmp, file, &st)) {
515 if (fnamecmp_type == FNAMECMP_FNAME)
516 set_perms(fname, file, &st, PERMS_REPORT);
523 fnamecmp = partialptr;
524 fnamecmp_type = FNAMECMP_PARTIAL_DIR;
528 if (dry_run || whole_file > 0) {
536 fd = do_open(fnamecmp, O_RDONLY, 0);
539 rsyserr(FERROR, errno, "failed to open %s, continuing",
540 full_fname(fnamecmp));
542 /* pretend the file didn't exist */
543 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
549 if (inplace && make_backups) {
550 if (!(backupptr = get_backup_name(fname))) {
554 if (!(back_file = make_file(fname, NULL, NO_FILTERS))) {
556 goto pretend_missing;
558 if (robust_unlink(backupptr) && errno != ENOENT) {
559 rsyserr(FERROR, errno, "unlink %s",
560 full_fname(backupptr));
565 if ((f_copy = do_open(backupptr,
566 O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600)) < 0) {
567 rsyserr(FERROR, errno, "open %s",
568 full_fname(backupptr));
573 fnamecmp_type = FNAMECMP_BACKUP;
577 rprintf(FINFO, "gen mapped %s of size %.0f\n",
578 safe_fname(fnamecmp), (double)st.st_size);
582 rprintf(FINFO, "generating and sending sums for %d\n", ndx);
585 write_int(f_out, ndx);
586 if (protocol_version >= 29 && inplace && !read_batch)
587 write_byte(f_out, fnamecmp_type);
589 write_byte(f_out_name, fnamecmp_type);
591 if (dry_run || read_batch)
595 generate_and_send_sums(fd, st.st_size, f_out, f_copy);
599 set_perms(backupptr, back_file, NULL, 0);
601 rprintf(FINFO, "backed up %s to %s\n",
602 safe_fname(fname), safe_fname(backupptr));
609 write_sum_head(f_out, NULL);
613 void generate_files(int f_out, struct file_list *flist, char *local_name,
618 char fbuf[MAXPATHLEN];
619 int need_retouch_dir_times = preserve_times && !omit_dir_times;
620 int need_retouch_dir_perms = 0;
621 int save_only_existing = only_existing;
622 int save_opt_ignore_existing = opt_ignore_existing;
625 rprintf(FINFO, "generator starting pid=%ld count=%d\n",
626 (long)getpid(), flist->count);
632 ? "delta-transmission disabled for local transfer or --whole-file\n"
633 : "delta transmission enabled\n");
636 /* We expect to just sit around now, so don't exit on a timeout.
637 * If we really get a timeout then the other process should exit. */
640 for (i = 0; i < flist->count; i++) {
641 struct file_struct *file = flist->files[i];
642 struct file_struct copy;
647 /* We need to ensure that any dirs we create have writeable
648 * permissions during the time we are putting files within
649 * them. This is then fixed after the transfer is done. */
650 if (!am_root && S_ISDIR(file->mode) && !(file->mode & S_IWUSR)) {
652 copy.mode |= S_IWUSR; /* user write */
654 need_retouch_dir_perms = 1;
657 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
658 flist, file, i, f_out, f_out_name);
661 delete_in_dir(NULL, NULL, NULL);
664 csum_length = SUM_LENGTH;
665 only_existing = max_size = opt_ignore_existing = 0;
666 update_only = always_checksum = size_only = 0;
670 rprintf(FINFO,"generate_files phase=%d\n",phase);
672 write_int(f_out, -1);
674 /* files can cycle through the system more than once
675 * to catch initial checksum errors */
676 while ((i = get_redo_num()) != -1) {
677 struct file_struct *file = flist->files[i];
678 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
679 flist, file, i, f_out, f_out_name);
683 only_existing = save_only_existing;
684 opt_ignore_existing = save_opt_ignore_existing;
687 rprintf(FINFO,"generate_files phase=%d\n",phase);
689 write_int(f_out, -1);
691 /* Read post-redo-phase MSG_DONE and any prior messages. */
694 if (preserve_hard_links)
697 if ((need_retouch_dir_perms || need_retouch_dir_times)
698 && !list_only && !local_name && !dry_run) {
699 /* Now we need to fix any directory permissions that were
700 * modified during the transfer and/or re-set any tweaked
701 * modified-time values. */
702 for (i = 0; i < flist->count; i++) {
703 struct file_struct *file = flist->files[i];
704 if (!file->basename || !S_ISDIR(file->mode))
706 if (!need_retouch_dir_times && file->mode & S_IWUSR)
708 recv_generator(local_name ? local_name : f_name(file),
709 flist, file, i, -1, -1);
714 rprintf(FINFO,"generate_files finished\n");