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 preserve_links;
31 extern int preserve_devices;
32 extern int preserve_hard_links;
33 extern int preserve_perms;
34 extern int preserve_uid;
35 extern int preserve_gid;
36 extern int update_only;
37 extern int opt_ignore_existing;
38 extern int csum_length;
39 extern int ignore_times;
41 extern int io_timeout;
42 extern int protocol_version;
43 extern int always_checksum;
44 extern char *compare_dest;
46 extern int whole_file;
47 extern int local_server;
48 extern int read_batch;
49 extern int write_batch;
51 extern int only_existing;
52 extern int orig_umask;
53 extern int safe_symlinks;
55 extern struct exclude_list_struct server_exclude_list;
58 /* choose whether to skip a particular file */
59 static int skip_file(char *fname, struct file_struct *file, STRUCT_STAT *st)
61 if (st->st_size != file->length) {
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
73 && st->st_gid != file->gid)
77 /* if always checksum is set then we use the checksum instead
78 of the file time to determine whether to sync */
79 if (always_checksum && S_ISREG(st->st_mode)) {
80 char sum[MD4_SUM_LENGTH];
81 char fnamecmpdest[MAXPATHLEN];
83 if (compare_dest != NULL) {
84 if (access(fname, 0) != 0) {
85 pathjoin(fnamecmpdest, sizeof fnamecmpdest,
90 file_checksum(fname,sum,st->st_size);
91 return memcmp(sum, file->u.sum, protocol_version < 21 ? 2
92 : MD4_SUM_LENGTH) == 0;
103 return (cmp_modtime(st->st_mtime,file->modtime) == 0);
108 * NULL sum_struct means we have no checksums
110 void write_sum_head(int f, struct sum_struct *sum)
112 static struct sum_struct null_sum;
117 write_int(f, sum->count);
118 write_int(f, sum->blength);
119 if (protocol_version >= 27)
120 write_int(f, sum->s2length);
121 write_int(f, sum->remainder);
125 * set (initialize) the size entries in the per-file sum_struct
126 * calulating dynamic block ans checksum sizes.
128 * This is only called from generate_and_send_sums() but is a seperate
129 * function to encapsulate the logic.
131 * The block size is a rounded square root of file length.
133 * The checksum size is determined according to:
134 * blocksum_bits = BLOCKSUM_EXP + 2*log2(file_len) - log2(block_len)
135 * provided by Donovan Baarda which gives a probability of rsync
136 * algorithm corrupting data and falling back using the whole md4
139 * This might be made one of several selectable heuristics.
142 static void sum_sizes_sqroot(struct sum_struct *sum, uint64 len)
144 extern unsigned int block_size;
145 unsigned int blength;
151 blength = block_size;
152 } else if (len <= BLOCK_SIZE * BLOCK_SIZE) {
153 blength = BLOCK_SIZE;
163 if (len < (uint64)blength * blength)
166 } while (c >= 8); /* round to multiple of 8 */
167 blength = MAX(blength, BLOCK_SIZE);
170 if (protocol_version < 27) {
171 s2length = csum_length;
172 } else if (csum_length == SUM_LENGTH) {
173 s2length = SUM_LENGTH;
175 int b = BLOCKSUM_BIAS;
181 while (c >>= 1 && b) {
184 s2length = (b + 1 - 32 + 7) / 8; /* add a bit,
187 * --optimize in compiler--
189 s2length = MAX(s2length, csum_length);
190 s2length = MIN(s2length, SUM_LENGTH);
194 sum->blength = blength;
195 sum->s2length = s2length;
196 sum->count = (len + (blength - 1)) / blength;
197 sum->remainder = (len % blength);
199 if (sum->count && verbose > 2) {
200 rprintf(FINFO, "count=%.0f rem=%u blength=%u s2length=%d flength=%.0f\n",
201 (double)sum->count, sum->remainder, sum->blength,
202 sum->s2length, (double)sum->flength);
207 * Perhaps we want to just send an empty checksum set for this file,
208 * which will force the whole thing to be literally transferred.
210 * When do we do this? If the user's explicitly said they
211 * want the whole thing, or if { they haven't explicitly
212 * requested a delta, and it's local but not batch mode.}
215 static BOOL disable_deltas_p(void)
219 if (whole_file == 0 || write_batch || read_batch)
226 * Generate and send a stream of signatures/checksums that describe a buffer
228 * Generate approximately one checksum every block_len bytes.
230 static void generate_and_send_sums(struct map_struct *buf, size_t len, int f_out)
233 struct sum_struct sum;
236 sum_sizes_sqroot(&sum, len);
238 write_sum_head(f_out, &sum);
240 for (i = 0; i < sum.count; i++) {
241 unsigned int n1 = MIN(len, sum.blength);
242 char *map = map_ptr(buf, offset, n1);
243 uint32 sum1 = get_checksum1(map, n1);
244 char sum2[SUM_LENGTH];
246 get_checksum2(map, n1, sum2);
250 "chunk[%.0f] offset=%.0f len=%u sum1=%08lx\n",
251 (double)i, (double)offset, n1,
252 (unsigned long)sum1);
254 write_int(f_out, sum1);
255 write_buf(f_out, sum2, sum.s2length);
264 * Acts on file number @p i from @p flist, whose name is @p fname.
266 * First fixes up permissions, then generates checksums for the file.
268 * @note This comment was added later by mbp who was trying to work it
269 * out. It might be wrong.
271 void recv_generator(char *fname, struct file_struct *file, int i, int f_out)
275 struct map_struct *mapbuf;
278 char fnamecmpbuf[MAXPATHLEN];
284 rprintf(FINFO,"recv_generator(%s,%d)\n",fname,i);
286 if (server_exclude_list.head
287 && check_exclude(&server_exclude_list, fname,
288 S_ISDIR(file->mode)) < 0) {
290 rprintf(FINFO, "skipping server-excluded file \"%s\"\n",
296 statret = link_stat(fname,&st);
298 if (only_existing && statret == -1 && errno == ENOENT) {
299 /* we only want to update existing files */
301 rprintf(FINFO, "not creating new file \"%s\"\n", fname);
307 (S_ISDIR(st.st_mode) == S_ISDIR(file->mode))) {
308 /* if the file exists already and we aren't perserving
309 * permissions then act as though the remote end sent
310 * us the file permissions we already have */
311 file->mode = (file->mode & ~CHMOD_BITS)
312 | (st.st_mode & CHMOD_BITS);
315 if (S_ISDIR(file->mode)) {
316 /* The file to be received is a directory, so we need
317 * to prepare appropriately. If there is already a
318 * file of that name and it is *not* a directory, then
319 * we need to delete it. If it doesn't exist, then
320 * recursively create it. */
322 if (dry_run) return; /* XXXX -- might cause inaccuracies?? -- mbp */
323 if (statret == 0 && !S_ISDIR(st.st_mode)) {
324 if (robust_unlink(fname) != 0) {
325 rsyserr(FERROR, errno,
326 "recv_generator: unlink %s to make room for directory",
332 if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) {
333 if (!(relative_paths && errno == ENOENT
334 && create_directory_path(fname, orig_umask) == 0
335 && do_mkdir(fname, file->mode) == 0)) {
336 rsyserr(FERROR, errno,
337 "recv_generator: mkdir %s failed",
341 /* f_out is set to -1 when doing final directory
342 permission and modification time repair */
343 if (set_perms(fname,file,NULL,0) && verbose && (f_out != -1))
344 rprintf(FINFO,"%s/\n",fname);
348 if (preserve_links && S_ISLNK(file->mode)) {
350 char lnk[MAXPATHLEN];
353 if (safe_symlinks && unsafe_symlink(file->u.link, fname)) {
355 rprintf(FINFO, "ignoring unsafe symlink %s -> \"%s\"\n",
356 full_fname(fname), file->u.link);
361 l = readlink(fname,lnk,MAXPATHLEN-1);
364 /* A link already pointing to the
365 * right place -- no further action
367 if (strcmp(lnk,file->u.link) == 0) {
368 set_perms(fname, file, &st,
373 /* Not a symlink, so delete whatever's
374 * already there and put a new symlink
378 if (do_symlink(file->u.link,fname) != 0) {
379 rsyserr(FERROR, errno, "symlink %s -> \"%s\" failed",
380 full_fname(fname), file->u.link);
382 set_perms(fname,file,NULL,0);
384 rprintf(FINFO,"%s -> %s\n", fname,file->u.link);
392 if (am_root && preserve_devices && IS_DEVICE(file->mode)) {
394 st.st_mode != file->mode ||
395 st.st_rdev != file->u.rdev) {
398 rprintf(FINFO,"mknod(%s,0%o,0x%x)\n",
399 fname,(int)file->mode,(int)file->u.rdev);
401 if (do_mknod(fname,file->mode,file->u.rdev) != 0) {
402 rsyserr(FERROR, errno, "mknod %s failed",
405 set_perms(fname,file,NULL,0);
407 rprintf(FINFO,"%s\n",fname);
410 set_perms(fname, file, &st, PERMS_REPORT);
416 if (preserve_hard_links && hard_link_check(file, HL_CHECK_MASTER))
419 if (!S_ISREG(file->mode)) {
420 rprintf(FINFO, "skipping non-regular file \"%s\"\n",fname);
426 if (statret == -1 && compare_dest != NULL) {
427 /* try the file at compare_dest instead */
428 int saveerrno = errno;
429 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf, compare_dest, fname);
430 statret = link_stat(fnamecmpbuf,&st);
431 if (!S_ISREG(st.st_mode))
436 else if (link_dest && !dry_run) {
437 if (do_link(fnamecmpbuf, fname) != 0) {
439 rsyserr(FINFO, errno, "link %s => %s",
443 fnamecmp = fnamecmpbuf;
447 fnamecmp = fnamecmpbuf;
451 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
453 if (errno == ENOENT) {
455 if (!dry_run) write_sum_head(f_out, NULL);
456 } else if (verbose > 1) {
457 rsyserr(FERROR, errno,
458 "recv_generator: failed to open %s",
464 if (!S_ISREG(st.st_mode)) {
465 if (delete_file(fname) != 0) {
469 /* now pretend the file didn't exist */
470 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
473 if (!dry_run) write_sum_head(f_out, NULL);
477 if (opt_ignore_existing && fnamecmp == fname) {
479 rprintf(FINFO,"%s exists\n",fname);
483 if (update_only && cmp_modtime(st.st_mtime,file->modtime)>0 && fnamecmp == fname) {
485 rprintf(FINFO,"%s is newer\n",fname);
489 if (skip_file(fname, file, &st)) {
490 if (fnamecmp == fname)
491 set_perms(fname, file, &st, PERMS_REPORT);
500 if (disable_deltas_p()) {
502 write_sum_head(f_out, NULL);
507 fd = do_open(fnamecmp, O_RDONLY, 0);
510 rsyserr(FERROR, errno, "failed to open %s, continuing",
511 full_fname(fnamecmp));
512 /* pretend the file didn't exist */
513 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
516 write_sum_head(f_out, NULL);
521 mapbuf = map_file(fd,st.st_size);
526 rprintf(FINFO,"gen mapped %s of size %.0f\n", fnamecmp,
531 rprintf(FINFO, "generating and sending sums for %d\n", i);
534 generate_and_send_sums(mapbuf, st.st_size, f_out);
537 if (mapbuf) unmap_file(mapbuf);
541 void generate_files(int f, struct file_list *flist, char *local_name)
545 char fbuf[MAXPATHLEN];
548 rprintf(FINFO, "generator starting pid=%ld count=%d\n",
549 (long)getpid(), flist->count);
555 ? "delta-transmission disabled for local transfer or --whole-file\n"
556 : "delta transmission enabled\n");
559 /* we expect to just sit around now, so don't exit on a
560 timeout. If we really get a timeout then the other process should
564 for (i = 0; i < flist->count; i++) {
565 struct file_struct *file = flist->files[i];
566 struct file_struct copy;
570 /* we need to ensure that any directories we create have writeable
571 permissions initially so that we can create the files within
572 them. This is then fixed after the files are transferred */
573 if (!am_root && S_ISDIR(file->mode) && !(file->mode & S_IWUSR)) {
575 /* XXX: Could this be causing a problem on SCO? Perhaps their
576 * handling of permissions is strange? */
577 copy.mode |= S_IWUSR; /* user write */
581 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
586 csum_length = SUM_LENGTH;
590 rprintf(FINFO,"generate_files phase=%d\n",phase);
594 /* files can cycle through the system more than once
595 * to catch initial checksum errors */
596 while ((i = get_redo_num()) != -1) {
597 struct file_struct *file = flist->files[i];
598 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
604 rprintf(FINFO,"generate_files phase=%d\n",phase);
608 if (preserve_hard_links)
611 /* now we need to fix any directory permissions that were
612 * modified during the transfer */
613 for (i = 0; i < flist->count; i++) {
614 struct file_struct *file = flist->files[i];
615 if (!file->basename || !S_ISDIR(file->mode)) continue;
616 recv_generator(local_name ? local_name : f_name(file),
621 rprintf(FINFO,"generate_files finished\n");