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;
39 extern int csum_length;
40 extern int ignore_times;
42 extern int io_timeout;
43 extern int protocol_version;
44 extern int always_checksum;
45 extern char *compare_dest;
47 extern int whole_file;
48 extern int local_server;
49 extern int read_batch;
50 extern int write_batch;
52 extern int only_existing;
53 extern int orig_umask;
54 extern int safe_symlinks;
56 extern struct exclude_list_struct server_exclude_list;
59 /* choose whether to skip a particular file */
60 static int skip_file(char *fname, struct file_struct *file, STRUCT_STAT *st)
62 if (st->st_size != file->length) {
67 && (st->st_mode & CHMOD_BITS) != (file->mode & CHMOD_BITS))
70 if (am_root && preserve_uid && st->st_uid != file->uid)
73 if (preserve_gid && file->gid != GID_NONE
74 && st->st_gid != file->gid)
78 /* if always checksum is set then we use the checksum instead
79 of the file time to determine whether to sync */
80 if (always_checksum && S_ISREG(st->st_mode)) {
81 char sum[MD4_SUM_LENGTH];
82 char fnamecmpdest[MAXPATHLEN];
84 if (compare_dest != NULL) {
85 if (access(fname, 0) != 0) {
86 pathjoin(fnamecmpdest, sizeof fnamecmpdest,
91 file_checksum(fname,sum,st->st_size);
92 return memcmp(sum, file->u.sum, protocol_version < 21 ? 2
93 : MD4_SUM_LENGTH) == 0;
104 return (cmp_modtime(st->st_mtime,file->modtime) == 0);
109 * NULL sum_struct means we have no checksums
111 void write_sum_head(int f, struct sum_struct *sum)
113 static struct sum_struct null_sum;
118 write_int(f, sum->count);
119 write_int(f, sum->blength);
120 if (protocol_version >= 27)
121 write_int(f, sum->s2length);
122 write_int(f, sum->remainder);
126 * set (initialize) the size entries in the per-file sum_struct
127 * calulating dynamic block ans checksum sizes.
129 * This is only called from generate_and_send_sums() but is a seperate
130 * function to encapsulate the logic.
132 * The block size is a rounded square root of file length.
134 * The checksum size is determined according to:
135 * blocksum_bits = BLOCKSUM_EXP + 2*log2(file_len) - log2(block_len)
136 * provided by Donovan Baarda which gives a probability of rsync
137 * algorithm corrupting data and falling back using the whole md4
140 * This might be made one of several selectable heuristics.
143 static void sum_sizes_sqroot(struct sum_struct *sum, uint64 len)
145 extern unsigned int block_size;
146 unsigned int blength;
152 blength = block_size;
153 } else if (len <= BLOCK_SIZE * BLOCK_SIZE) {
154 blength = BLOCK_SIZE;
164 if (len < (uint64)blength * blength)
167 } while (c >= 8); /* round to multiple of 8 */
168 blength = MAX(blength, BLOCK_SIZE);
171 if (protocol_version < 27) {
172 s2length = csum_length;
173 } else if (csum_length == SUM_LENGTH) {
174 s2length = SUM_LENGTH;
176 int b = BLOCKSUM_BIAS;
182 while (c >>= 1 && b) {
185 s2length = (b + 1 - 32 + 7) / 8; /* add a bit,
188 * --optimize in compiler--
190 s2length = MAX(s2length, csum_length);
191 s2length = MIN(s2length, SUM_LENGTH);
195 sum->blength = blength;
196 sum->s2length = s2length;
197 sum->count = (len + (blength - 1)) / blength;
198 sum->remainder = (len % blength);
200 if (sum->count && verbose > 2) {
201 rprintf(FINFO, "count=%.0f rem=%u blength=%u s2length=%d flength=%.0f\n",
202 (double)sum->count, sum->remainder, sum->blength,
203 sum->s2length, (double)sum->flength);
208 * Perhaps we want to just send an empty checksum set for this file,
209 * which will force the whole thing to be literally transferred.
211 * When do we do this? If the user's explicitly said they
212 * want the whole thing, or if { they haven't explicitly
213 * requested a delta, and it's local but not batch mode.}
216 static BOOL disable_deltas_p(void)
220 if (whole_file == 0 || write_batch || read_batch)
227 * Generate and send a stream of signatures/checksums that describe a buffer
229 * Generate approximately one checksum every block_len bytes.
231 static void generate_and_send_sums(struct map_struct *buf, size_t len, int f_out)
234 struct sum_struct sum;
237 sum_sizes_sqroot(&sum, len);
239 write_sum_head(f_out, &sum);
241 for (i = 0; i < sum.count; i++) {
242 unsigned int n1 = MIN(len, sum.blength);
243 char *map = map_ptr(buf, offset, n1);
244 uint32 sum1 = get_checksum1(map, n1);
245 char sum2[SUM_LENGTH];
247 get_checksum2(map, n1, sum2);
251 "chunk[%.0f] offset=%.0f len=%u sum1=%08lx\n",
252 (double)i, (double)offset, n1,
253 (unsigned long)sum1);
255 write_int(f_out, sum1);
256 write_buf(f_out, sum2, sum.s2length);
265 * Acts on file number @p i from @p flist, whose name is @p fname.
267 * First fixes up permissions, then generates checksums for the file.
269 * @note This comment was added later by mbp who was trying to work it
270 * out. It might be wrong.
272 void recv_generator(char *fname, struct file_struct *file, int i, int f_out)
276 struct map_struct *mapbuf;
279 char fnamecmpbuf[MAXPATHLEN];
285 rprintf(FINFO,"recv_generator(%s,%d)\n",fname,i);
287 if (server_exclude_list.head
288 && check_exclude(&server_exclude_list, fname,
289 S_ISDIR(file->mode)) < 0) {
291 rprintf(FINFO, "skipping server-excluded file \"%s\"\n",
297 statret = link_stat(fname,&st);
299 if (only_existing && statret == -1 && errno == ENOENT) {
300 /* we only want to update existing files */
302 rprintf(FINFO, "not creating new file \"%s\"\n", fname);
307 if (statret == 0 && keep_dirlinks
308 && S_ISLNK(st.st_mode) && S_ISDIR(file->mode)) {
310 if (do_stat(fname, &st2) == 0 && S_ISDIR(st2.st_mode))
317 (S_ISDIR(st.st_mode) == S_ISDIR(file->mode))) {
318 /* if the file exists already and we aren't perserving
319 * permissions then act as though the remote end sent
320 * us the file permissions we already have */
321 file->mode = (file->mode & ~CHMOD_BITS)
322 | (st.st_mode & CHMOD_BITS);
325 if (S_ISDIR(file->mode)) {
326 /* The file to be received is a directory, so we need
327 * to prepare appropriately. If there is already a
328 * file of that name and it is *not* a directory, then
329 * we need to delete it. If it doesn't exist, then
330 * recursively create it. */
332 if (dry_run) return; /* XXXX -- might cause inaccuracies?? -- mbp */
333 if (statret == 0 && !S_ISDIR(st.st_mode)) {
334 if (robust_unlink(fname) != 0) {
335 rsyserr(FERROR, errno,
336 "recv_generator: unlink %s to make room for directory",
342 if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) {
343 if (!(relative_paths && errno == ENOENT
344 && create_directory_path(fname, orig_umask) == 0
345 && do_mkdir(fname, file->mode) == 0)) {
346 rsyserr(FERROR, errno,
347 "recv_generator: mkdir %s failed",
351 /* f_out is set to -1 when doing final directory-permission
352 * and modification-time repair. */
353 if (set_perms(fname, file, statret ? NULL : &st, 0)
354 && verbose && f_out != -1)
355 rprintf(FINFO,"%s/\n",fname);
359 if (preserve_links && S_ISLNK(file->mode)) {
361 char lnk[MAXPATHLEN];
364 if (safe_symlinks && unsafe_symlink(file->u.link, fname)) {
366 rprintf(FINFO, "ignoring unsafe symlink %s -> \"%s\"\n",
367 full_fname(fname), file->u.link);
372 l = readlink(fname,lnk,MAXPATHLEN-1);
375 /* A link already pointing to the
376 * right place -- no further action
378 if (strcmp(lnk,file->u.link) == 0) {
379 set_perms(fname, file, &st,
384 /* Not a symlink, so delete whatever's
385 * already there and put a new symlink
389 if (do_symlink(file->u.link,fname) != 0) {
390 rsyserr(FERROR, errno, "symlink %s -> \"%s\" failed",
391 full_fname(fname), file->u.link);
393 set_perms(fname,file,NULL,0);
395 rprintf(FINFO,"%s -> %s\n", fname,file->u.link);
403 if (am_root && preserve_devices && IS_DEVICE(file->mode)) {
405 st.st_mode != file->mode ||
406 st.st_rdev != file->u.rdev) {
409 rprintf(FINFO,"mknod(%s,0%o,0x%x)\n",
410 fname,(int)file->mode,(int)file->u.rdev);
412 if (do_mknod(fname,file->mode,file->u.rdev) != 0) {
413 rsyserr(FERROR, errno, "mknod %s failed",
416 set_perms(fname,file,NULL,0);
418 rprintf(FINFO,"%s\n",fname);
421 set_perms(fname, file, &st, PERMS_REPORT);
427 if (preserve_hard_links && hard_link_check(file, HL_CHECK_MASTER))
430 if (!S_ISREG(file->mode)) {
431 rprintf(FINFO, "skipping non-regular file \"%s\"\n",fname);
437 if (statret == -1 && compare_dest != NULL) {
438 /* try the file at compare_dest instead */
439 int saveerrno = errno;
440 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf, compare_dest, fname);
441 statret = link_stat(fnamecmpbuf,&st);
442 if (!S_ISREG(st.st_mode))
447 else if (link_dest && !dry_run) {
448 if (do_link(fnamecmpbuf, fname) != 0) {
450 rsyserr(FINFO, errno, "link %s => %s",
454 fnamecmp = fnamecmpbuf;
458 fnamecmp = fnamecmpbuf;
462 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
464 if (errno == ENOENT) {
466 if (!dry_run) write_sum_head(f_out, NULL);
467 } else if (verbose > 1) {
468 rsyserr(FERROR, errno,
469 "recv_generator: failed to open %s",
475 if (!S_ISREG(st.st_mode)) {
476 if (delete_file(fname) != 0) {
480 /* now pretend the file didn't exist */
481 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
484 if (!dry_run) write_sum_head(f_out, NULL);
488 if (opt_ignore_existing && fnamecmp == fname) {
490 rprintf(FINFO,"%s exists\n",fname);
494 if (update_only && cmp_modtime(st.st_mtime,file->modtime)>0 && fnamecmp == fname) {
496 rprintf(FINFO,"%s is newer\n",fname);
500 if (skip_file(fname, file, &st)) {
501 if (fnamecmp == fname)
502 set_perms(fname, file, &st, PERMS_REPORT);
511 if (disable_deltas_p()) {
513 write_sum_head(f_out, NULL);
518 fd = do_open(fnamecmp, O_RDONLY, 0);
521 rsyserr(FERROR, errno, "failed to open %s, continuing",
522 full_fname(fnamecmp));
523 /* pretend the file didn't exist */
524 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
527 write_sum_head(f_out, NULL);
532 mapbuf = map_file(fd,st.st_size);
537 rprintf(FINFO,"gen mapped %s of size %.0f\n", fnamecmp,
542 rprintf(FINFO, "generating and sending sums for %d\n", i);
545 generate_and_send_sums(mapbuf, st.st_size, f_out);
548 if (mapbuf) unmap_file(mapbuf);
552 void generate_files(int f, struct file_list *flist, char *local_name)
556 char fbuf[MAXPATHLEN];
559 rprintf(FINFO, "generator starting pid=%ld count=%d\n",
560 (long)getpid(), flist->count);
566 ? "delta-transmission disabled for local transfer or --whole-file\n"
567 : "delta transmission enabled\n");
570 /* we expect to just sit around now, so don't exit on a
571 timeout. If we really get a timeout then the other process should
575 for (i = 0; i < flist->count; i++) {
576 struct file_struct *file = flist->files[i];
577 struct file_struct copy;
581 /* we need to ensure that any directories we create have writeable
582 permissions initially so that we can create the files within
583 them. This is then fixed after the files are transferred */
584 if (!am_root && S_ISDIR(file->mode) && !(file->mode & S_IWUSR)) {
586 /* XXX: Could this be causing a problem on SCO? Perhaps their
587 * handling of permissions is strange? */
588 copy.mode |= S_IWUSR; /* user write */
592 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
597 csum_length = SUM_LENGTH;
601 rprintf(FINFO,"generate_files phase=%d\n",phase);
605 /* files can cycle through the system more than once
606 * to catch initial checksum errors */
607 while ((i = get_redo_num()) != -1) {
608 struct file_struct *file = flist->files[i];
609 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
615 rprintf(FINFO,"generate_files phase=%d\n",phase);
619 if (preserve_hard_links)
622 /* now we need to fix any directory permissions that were
623 * modified during the transfer */
624 for (i = 0; i < flist->count; i++) {
625 struct file_struct *file = flist->files[i];
626 if (!file->basename || !S_ISDIR(file->mode)) continue;
627 recv_generator(local_name ? local_name : f_name(file),
632 rprintf(FINFO,"generate_files finished\n");