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 update_only;
38 extern int opt_ignore_existing;
40 extern int make_backups;
41 extern int csum_length;
42 extern int ignore_times;
44 extern OFF_T max_size;
45 extern int io_timeout;
46 extern int protocol_version;
47 extern int always_checksum;
48 extern char *partial_dir;
49 extern char *basis_dir[];
52 extern int whole_file;
53 extern int local_server;
55 extern int read_batch;
56 extern int only_existing;
57 extern int orig_umask;
58 extern int safe_symlinks;
59 extern long block_size; /* "long" because popt can't set an int32. */
61 extern struct exclude_list_struct server_exclude_list;
63 static int unchanged_attrs(struct file_struct *file, STRUCT_STAT *st)
66 && (st->st_mode & CHMOD_BITS) != (file->mode & CHMOD_BITS))
69 if (am_root && preserve_uid && st->st_uid != file->uid)
72 if (preserve_gid && file->gid != GID_NONE && st->st_gid != file->gid)
78 /* Perform our quick-check heuristic for determining if a file is unchanged. */
79 static int unchanged_file(char *fn, struct file_struct *file, STRUCT_STAT *st)
81 if (st->st_size != file->length)
84 /* if always checksum is set then we use the checksum instead
85 of the file time to determine whether to sync */
86 if (always_checksum && S_ISREG(st->st_mode)) {
87 char sum[MD4_SUM_LENGTH];
88 file_checksum(fn, sum, st->st_size);
89 return memcmp(sum, file->u.sum, protocol_version < 21 ? 2
90 : MD4_SUM_LENGTH) == 0;
99 return cmp_modtime(st->st_mtime, file->modtime) == 0;
104 * NULL sum_struct means we have no checksums
106 void write_sum_head(int f, struct sum_struct *sum)
108 static struct sum_struct null_sum;
113 write_int(f, sum->count);
114 write_int(f, sum->blength);
115 if (protocol_version >= 27)
116 write_int(f, sum->s2length);
117 write_int(f, sum->remainder);
121 * set (initialize) the size entries in the per-file sum_struct
122 * calculating dynamic block and checksum sizes.
124 * This is only called from generate_and_send_sums() but is a separate
125 * function to encapsulate the logic.
127 * The block size is a rounded square root of file length.
129 * The checksum size is determined according to:
130 * blocksum_bits = BLOCKSUM_EXP + 2*log2(file_len) - log2(block_len)
131 * provided by Donovan Baarda which gives a probability of rsync
132 * algorithm corrupting data and falling back using the whole md4
135 * This might be made one of several selectable heuristics.
137 static void sum_sizes_sqroot(struct sum_struct *sum, uint64 len)
143 blength = block_size;
144 else if (len <= BLOCK_SIZE * BLOCK_SIZE)
145 blength = BLOCK_SIZE;
149 for (c = 1, l = len; l >>= 2; c <<= 1) {
155 if (len < (uint64)blength * blength)
158 } while (c >= 8); /* round to multiple of 8 */
159 blength = MAX(blength, BLOCK_SIZE);
162 if (protocol_version < 27) {
163 s2length = csum_length;
164 } else if (csum_length == SUM_LENGTH) {
165 s2length = SUM_LENGTH;
169 int b = BLOCKSUM_BIAS;
170 for (l = len; l >>= 1; b += 2) {}
171 for (c = blength; c >>= 1 && b; b--) {}
172 /* add a bit, subtract rollsum, round up. */
173 s2length = (b + 1 - 32 + 7) / 8; /* --optimize in compiler-- */
174 s2length = MAX(s2length, csum_length);
175 s2length = MIN(s2length, SUM_LENGTH);
179 sum->blength = blength;
180 sum->s2length = s2length;
181 sum->count = (len + (blength - 1)) / blength;
182 sum->remainder = (len % blength);
184 if (sum->count && verbose > 2) {
186 "count=%.0f rem=%ld blength=%ld s2length=%d flength=%.0f\n",
187 (double)sum->count, (long)sum->remainder, (long)sum->blength,
188 sum->s2length, (double)sum->flength);
194 * Generate and send a stream of signatures/checksums that describe a buffer
196 * Generate approximately one checksum every block_len bytes.
198 static void generate_and_send_sums(int fd, OFF_T len, int f_out, int f_copy)
201 struct map_struct *mapbuf;
202 struct sum_struct sum;
205 sum_sizes_sqroot(&sum, len);
208 mapbuf = map_file(fd, len, MAX_MAP_SIZE, sum.blength);
212 write_sum_head(f_out, &sum);
214 for (i = 0; i < sum.count; i++) {
215 int32 n1 = (int32)MIN(len, (OFF_T)sum.blength);
216 char *map = map_ptr(mapbuf, offset, n1);
217 uint32 sum1 = get_checksum1(map, n1);
218 char sum2[SUM_LENGTH];
221 full_write(f_copy, map, n1);
223 get_checksum2(map, n1, sum2);
227 "chunk[%.0f] offset=%.0f len=%ld sum1=%08lx\n",
228 (double)i, (double)offset, (long)n1,
229 (unsigned long)sum1);
231 write_int(f_out, sum1);
232 write_buf(f_out, sum2, sum.s2length);
244 * Acts on file number @p i from @p flist, whose name is @p fname.
246 * First fixes up permissions, then generates checksums for the file.
248 * @note This comment was added later by mbp who was trying to work it
249 * out. It might be wrong.
251 static void recv_generator(char *fname, struct file_struct *file, int i,
252 int f_out, int f_out_name)
254 int fd = -1, f_copy = -1;
255 STRUCT_STAT st, partial_st;
256 struct file_struct *back_file = NULL;
257 int statret, stat_errno;
258 char *fnamecmp, *partialptr, *backupptr = NULL;
259 char fnamecmpbuf[MAXPATHLEN];
266 rprintf(FINFO, "recv_generator(%s,%d)\n", safe_fname(fname), i);
268 if (server_exclude_list.head
269 && check_exclude(&server_exclude_list, fname,
270 S_ISDIR(file->mode)) < 0) {
272 rprintf(FINFO, "skipping server-excluded file \"%s\"\n",
282 statret = link_stat(fname, &st,
283 keep_dirlinks && S_ISDIR(file->mode));
287 if (only_existing && statret == -1 && stat_errno == ENOENT) {
288 /* we only want to update existing files */
290 rprintf(FINFO, "not creating new file \"%s\"\n",
296 if (statret == 0 && !preserve_perms
297 && S_ISDIR(st.st_mode) == S_ISDIR(file->mode)) {
298 /* if the file exists already and we aren't perserving
299 * permissions then act as though the remote end sent
300 * us the file permissions we already have */
301 file->mode = (file->mode & ~CHMOD_BITS)
302 | (st.st_mode & CHMOD_BITS);
305 if (S_ISDIR(file->mode)) {
306 /* The file to be received is a directory, so we need
307 * to prepare appropriately. If there is already a
308 * file of that name and it is *not* a directory, then
309 * we need to delete it. If it doesn't exist, then
310 * recursively create it. */
313 return; /* TODO: causes inaccuracies -- fix */
314 if (statret == 0 && !S_ISDIR(st.st_mode)) {
315 if (robust_unlink(fname) != 0) {
316 rsyserr(FERROR, errno,
317 "recv_generator: unlink %s to make room for directory",
323 if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) {
324 if (!(relative_paths && errno == ENOENT
325 && create_directory_path(fname, orig_umask) == 0
326 && do_mkdir(fname, file->mode) == 0)) {
327 rsyserr(FERROR, errno,
328 "recv_generator: mkdir %s failed",
332 /* f_out is set to -1 when doing final directory-permission
333 * and modification-time repair. */
334 if (set_perms(fname, file, statret ? NULL : &st, 0)
335 && verbose && f_out != -1)
336 rprintf(FINFO, "%s/\n", safe_fname(fname));
338 } else if (max_size && file->length > max_size) {
340 rprintf(FINFO, "%s is over max-size\n", fname);
344 if (preserve_links && S_ISLNK(file->mode)) {
346 char lnk[MAXPATHLEN];
349 if (safe_symlinks && unsafe_symlink(file->u.link, fname)) {
351 rprintf(FINFO, "ignoring unsafe symlink %s -> \"%s\"\n",
352 full_fname(fname), file->u.link);
357 l = readlink(fname,lnk,MAXPATHLEN-1);
360 /* A link already pointing to the
361 * right place -- no further action
363 if (strcmp(lnk,file->u.link) == 0) {
364 set_perms(fname, file, &st,
369 /* Not a symlink, so delete whatever's
370 * already there and put a new symlink
374 if (do_symlink(file->u.link,fname) != 0) {
375 rsyserr(FERROR, errno, "symlink %s -> \"%s\" failed",
376 full_fname(fname), safe_fname(file->u.link));
378 set_perms(fname,file,NULL,0);
380 rprintf(FINFO, "%s -> %s\n", safe_fname(fname),
381 safe_fname(file->u.link));
388 if (am_root && preserve_devices && IS_DEVICE(file->mode)) {
390 st.st_mode != file->mode ||
391 st.st_rdev != file->u.rdev) {
394 rprintf(FINFO,"mknod(%s,0%o,0x%x)\n",
396 (int)file->mode, (int)file->u.rdev);
398 if (do_mknod(fname,file->mode,file->u.rdev) != 0) {
399 rsyserr(FERROR, errno, "mknod %s failed",
402 set_perms(fname,file,NULL,0);
404 rprintf(FINFO, "%s\n",
409 set_perms(fname, file, &st, PERMS_REPORT);
414 if (preserve_hard_links && hard_link_check(file, HL_CHECK_MASTER))
417 if (!S_ISREG(file->mode)) {
418 rprintf(FINFO, "skipping non-regular file \"%s\"\n",
424 fnamecmp_type = FNAMECMP_FNAME;
426 if (statret == -1 && basis_dir[0] != NULL) {
427 int fallback_match = -1;
431 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
432 basis_dir[i], fname);
433 if (link_stat(fnamecmpbuf, &st, 0) == 0
434 && S_ISREG(st.st_mode)) {
440 } else if (match_level == 2
441 && !unchanged_attrs(file, &st))
443 if (!unchanged_file(fnamecmpbuf, file, &st))
447 if (!unchanged_attrs(file, &st))
453 } while (basis_dir[++i] != NULL);
455 if (match_level < 3) {
457 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
458 basis_dir[i], fname);
461 if (link_dest && match_level == 3 && !dry_run) {
462 if (do_link(fnamecmpbuf, fname) < 0) {
464 rsyserr(FINFO, errno,
469 fnamecmp = fnamecmpbuf;
470 fnamecmp_type = FNAMECMP_BASIS_DIR + i;
475 fnamecmp = fnamecmpbuf;
476 fnamecmp_type = FNAMECMP_BASIS_DIR + i;
481 if (statret == 0 && !S_ISREG(st.st_mode)) {
482 if (delete_file(fname) != 0)
488 if (partial_dir && (partialptr = partial_dir_fname(fname))
489 && link_stat(partialptr, &partial_st, 0) == 0
490 && S_ISREG(partial_st.st_mode)) {
492 goto prepare_to_open;
497 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
499 if (stat_errno == ENOENT)
502 rsyserr(FERROR, stat_errno,
503 "recv_generator: failed to stat %s",
509 if (opt_ignore_existing && fnamecmp_type == FNAMECMP_FNAME) {
511 rprintf(FINFO, "%s exists\n", safe_fname(fname));
515 if (update_only && fnamecmp_type == FNAMECMP_FNAME
516 && cmp_modtime(st.st_mtime, file->modtime) > 0) {
518 rprintf(FINFO, "%s is newer\n", safe_fname(fname));
522 if ((link_dest || copy_dest) && fnamecmp_type != FNAMECMP_FNAME)
524 else if (unchanged_file(fnamecmp, file, &st)) {
525 if (fnamecmp_type == FNAMECMP_FNAME)
526 set_perms(fname, file, &st, PERMS_REPORT);
531 if (dry_run || whole_file > 0) {
540 fnamecmp = partialptr;
541 fnamecmp_type = FNAMECMP_PARTIAL_DIR;
545 fd = do_open(fnamecmp, O_RDONLY, 0);
548 rsyserr(FERROR, errno, "failed to open %s, continuing",
549 full_fname(fnamecmp));
551 /* pretend the file didn't exist */
552 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
558 if (inplace && make_backups) {
559 if (!(backupptr = get_backup_name(fname))) {
563 if (!(back_file = make_file(fname, NULL, NO_EXCLUDES))) {
565 goto pretend_missing;
567 if (robust_unlink(backupptr) && errno != ENOENT) {
568 rsyserr(FERROR, errno, "unlink %s",
569 full_fname(backupptr));
574 if ((f_copy = do_open(backupptr,
575 O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600)) < 0) {
576 rsyserr(FERROR, errno, "open %s",
577 full_fname(backupptr));
582 fnamecmp_type = FNAMECMP_BACKUP;
586 rprintf(FINFO, "gen mapped %s of size %.0f\n",
587 safe_fname(fnamecmp), (double)st.st_size);
591 rprintf(FINFO, "generating and sending sums for %d\n", i);
596 write_byte(f_out_name, fnamecmp_type);
598 if (dry_run || read_batch)
602 generate_and_send_sums(fd, st.st_size, f_out, f_copy);
606 set_perms(backupptr, back_file, NULL, 0);
608 rprintf(FINFO, "backed up %s to %s\n",
616 write_sum_head(f_out, NULL);
620 void generate_files(int f_out, struct file_list *flist, char *local_name,
625 char fbuf[MAXPATHLEN];
628 rprintf(FINFO, "generator starting pid=%ld count=%d\n",
629 (long)getpid(), flist->count);
635 ? "delta-transmission disabled for local transfer or --whole-file\n"
636 : "delta transmission enabled\n");
639 /* we expect to just sit around now, so don't exit on a
640 timeout. If we really get a timeout then the other process should
644 for (i = 0; i < flist->count; i++) {
645 struct file_struct *file = flist->files[i];
646 struct file_struct copy;
650 /* we need to ensure that any directories we create have writeable
651 permissions initially so that we can create the files within
652 them. This is then fixed after the files are transferred */
653 if (!am_root && S_ISDIR(file->mode) && !(file->mode & S_IWUSR)) {
655 /* XXX: Could this be causing a problem on SCO? Perhaps their
656 * handling of permissions is strange? */
657 copy.mode |= S_IWUSR; /* user write */
661 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
662 file, i, f_out, f_out_name);
666 csum_length = SUM_LENGTH;
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 file, i, f_out, f_out_name);
684 rprintf(FINFO,"generate_files phase=%d\n",phase);
686 write_int(f_out, -1);
688 /* Read post-redo-phase MSG_DONE and any prior messages. */
691 if (preserve_hard_links)
694 /* now we need to fix any directory permissions that were
695 * modified during the transfer */
696 for (i = 0; i < flist->count; i++) {
697 struct file_struct *file = flist->files[i];
698 if (!file->basename || !S_ISDIR(file->mode))
700 recv_generator(local_name ? local_name : f_name(file),
705 rprintf(FINFO,"generate_files finished\n");