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;
56 /* choose whether to skip a particular file */
57 static int skip_file(char *fname, struct file_struct *file, STRUCT_STAT *st)
59 if (st->st_size != file->length) {
64 && (st->st_mode & CHMOD_BITS) != (file->mode & CHMOD_BITS))
67 if (am_root && preserve_uid && st->st_uid != file->uid)
70 if (preserve_gid && file->gid != GID_NONE
71 && st->st_gid != file->gid)
75 /* if always checksum is set then we use the checksum instead
76 of the file time to determine whether to sync */
77 if (always_checksum && S_ISREG(st->st_mode)) {
78 char sum[MD4_SUM_LENGTH];
79 char fnamecmpdest[MAXPATHLEN];
81 if (compare_dest != NULL) {
82 if (access(fname, 0) != 0) {
83 pathjoin(fnamecmpdest, sizeof fnamecmpdest,
88 file_checksum(fname,sum,st->st_size);
89 return memcmp(sum, file->u.sum, protocol_version < 21 ? 2
90 : MD4_SUM_LENGTH) == 0;
101 return (cmp_modtime(st->st_mtime,file->modtime) == 0);
106 * NULL sum_struct means we have no checksums
108 void write_sum_head(int f, struct sum_struct *sum)
110 static struct sum_struct null_sum;
115 write_int(f, sum->count);
116 write_int(f, sum->blength);
117 if (protocol_version >= 27)
118 write_int(f, sum->s2length);
119 write_int(f, sum->remainder);
123 * set (initialize) the size entries in the per-file sum_struct
124 * calulating dynamic block ans checksum sizes.
126 * This is only called from generate_and_send_sums() but is a seperate
127 * function to encapsulate the logic.
129 * The block size is a rounded square root of file length.
131 * The checksum size is determined according to:
132 * blocksum_bits = BLOCKSUM_EXP + 2*log2(file_len) - log2(block_len)
133 * provided by Donovan Baarda which gives a probability of rsync
134 * algorithm corrupting data and falling back using the whole md4
137 * This might be made one of several selectable heuristics.
140 static void sum_sizes_sqroot(struct sum_struct *sum, uint64 len)
142 extern unsigned int block_size;
143 unsigned int blength;
149 blength = block_size;
150 } else if (len <= BLOCK_SIZE * BLOCK_SIZE) {
151 blength = BLOCK_SIZE;
161 if (len < (uint64)blength * blength)
164 } while (c >= 8); /* round to multiple of 8 */
165 blength = MAX(blength, BLOCK_SIZE);
168 if (protocol_version < 27) {
169 s2length = csum_length;
170 } else if (csum_length == SUM_LENGTH) {
171 s2length = SUM_LENGTH;
173 int b = BLOCKSUM_BIAS;
179 while (c >>= 1 && b) {
182 s2length = (b + 1 - 32 + 7) / 8; /* add a bit,
185 * --optimize in compiler--
187 s2length = MAX(s2length, csum_length);
188 s2length = MIN(s2length, SUM_LENGTH);
192 sum->blength = blength;
193 sum->s2length = s2length;
194 sum->count = (len + (blength - 1)) / blength;
195 sum->remainder = (len % blength);
197 if (sum->count && verbose > 2) {
198 rprintf(FINFO, "count=%.0f rem=%u blength=%u s2length=%d flength=%.0f\n",
199 (double)sum->count, sum->remainder, sum->blength,
200 sum->s2length, (double)sum->flength);
205 * Perhaps we want to just send an empty checksum set for this file,
206 * which will force the whole thing to be literally transferred.
208 * When do we do this? If the user's explicitly said they
209 * want the whole thing, or if { they haven't explicitly
210 * requested a delta, and it's local but not batch mode.}
213 static BOOL disable_deltas_p(void)
217 if (whole_file == 0 || write_batch || read_batch)
224 * Generate and send a stream of signatures/checksums that describe a buffer
226 * Generate approximately one checksum every block_len bytes.
228 static void generate_and_send_sums(struct map_struct *buf, size_t len, int f_out)
231 struct sum_struct sum;
234 sum_sizes_sqroot(&sum, len);
236 write_sum_head(f_out, &sum);
238 for (i = 0; i < sum.count; i++) {
239 unsigned int n1 = MIN(len, sum.blength);
240 char *map = map_ptr(buf, offset, n1);
241 uint32 sum1 = get_checksum1(map, n1);
242 char sum2[SUM_LENGTH];
244 get_checksum2(map, n1, sum2);
248 "chunk[%.0f] offset=%.0f len=%u sum1=%08lx\n",
249 (double)i, (double)offset, n1,
250 (unsigned long)sum1);
252 write_int(f_out, sum1);
253 write_buf(f_out, sum2, sum.s2length);
262 * Acts on file number @p i from @p flist, whose name is @p fname.
264 * First fixes up permissions, then generates checksums for the file.
266 * @note This comment was added later by mbp who was trying to work it
267 * out. It might be wrong.
269 void recv_generator(char *fname, struct file_struct *file, int i, int f_out)
273 struct map_struct *mapbuf;
276 char fnamecmpbuf[MAXPATHLEN];
282 rprintf(FINFO,"recv_generator(%s,%d)\n",fname,i);
284 statret = link_stat(fname,&st);
286 if (only_existing && statret == -1 && errno == ENOENT) {
287 /* we only want to update existing files */
288 if (verbose > 1) rprintf(FINFO, "not creating new file \"%s\"\n",fname);
294 (S_ISDIR(st.st_mode) == S_ISDIR(file->mode))) {
295 /* if the file exists already and we aren't perserving
296 * permissions then act as though the remote end sent
297 * us the file permissions we already have */
298 file->mode = (file->mode & ~CHMOD_BITS)
299 | (st.st_mode & CHMOD_BITS);
302 if (S_ISDIR(file->mode)) {
303 /* The file to be received is a directory, so we need
304 * to prepare appropriately. If there is already a
305 * file of that name and it is *not* a directory, then
306 * we need to delete it. If it doesn't exist, then
307 * recursively create it. */
309 if (dry_run) return; /* XXXX -- might cause inaccuracies?? -- mbp */
310 if (statret == 0 && !S_ISDIR(st.st_mode)) {
311 if (robust_unlink(fname) != 0) {
313 "recv_generator: unlink %s to make room for directory: %s\n",
314 full_fname(fname), strerror(errno));
319 if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) {
320 if (!(relative_paths && errno==ENOENT &&
321 create_directory_path(fname, orig_umask)==0 &&
322 do_mkdir(fname,file->mode)==0)) {
323 rprintf(FERROR, "recv_generator: mkdir %s failed: %s\n",
324 full_fname(fname), strerror(errno));
327 /* f_out is set to -1 when doing final directory
328 permission and modification time repair */
329 if (set_perms(fname,file,NULL,0) && verbose && (f_out != -1))
330 rprintf(FINFO,"%s/\n",fname);
334 if (preserve_links && S_ISLNK(file->mode)) {
336 char lnk[MAXPATHLEN];
339 if (safe_symlinks && unsafe_symlink(file->u.link, fname)) {
341 rprintf(FINFO, "ignoring unsafe symlink %s -> \"%s\"\n",
342 full_fname(fname), file->u.link);
347 l = readlink(fname,lnk,MAXPATHLEN-1);
350 /* A link already pointing to the
351 * right place -- no further action
353 if (strcmp(lnk,file->u.link) == 0) {
354 set_perms(fname, file, &st,
359 /* Not a symlink, so delete whatever's
360 * already there and put a new symlink
364 if (do_symlink(file->u.link,fname) != 0) {
365 rprintf(FERROR, "symlink %s -> \"%s\" failed: %s\n",
366 full_fname(fname), file->u.link, strerror(errno));
368 set_perms(fname,file,NULL,0);
370 rprintf(FINFO,"%s -> %s\n", fname,file->u.link);
378 if (am_root && preserve_devices && IS_DEVICE(file->mode)) {
380 st.st_mode != file->mode ||
381 st.st_rdev != file->u.rdev) {
384 rprintf(FINFO,"mknod(%s,0%o,0x%x)\n",
385 fname,(int)file->mode,(int)file->u.rdev);
386 if (do_mknod(fname,file->mode,file->u.rdev) != 0) {
387 rprintf(FERROR, "mknod %s failed: %s\n",
388 full_fname(fname), strerror(errno));
390 set_perms(fname,file,NULL,0);
392 rprintf(FINFO,"%s\n",fname);
395 set_perms(fname, file, &st, PERMS_REPORT);
401 if (preserve_hard_links && hard_link_check(file, HL_CHECK_MASTER))
404 if (!S_ISREG(file->mode)) {
405 rprintf(FINFO, "skipping non-regular file \"%s\"\n",fname);
411 if (statret == -1 && compare_dest != NULL) {
412 /* try the file at compare_dest instead */
413 int saveerrno = errno;
414 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf, compare_dest, fname);
415 statret = link_stat(fnamecmpbuf,&st);
416 if (!S_ISREG(st.st_mode))
421 else if (link_dest && !dry_run) {
422 if (do_link(fnamecmpbuf, fname) != 0) {
424 rprintf(FINFO,"link %s => %s : %s\n",
429 fnamecmp = fnamecmpbuf;
433 fnamecmp = fnamecmpbuf;
437 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
439 if (errno == ENOENT) {
441 if (!dry_run) write_sum_head(f_out, NULL);
442 } else if (verbose > 1) {
444 "recv_generator: failed to open %s: %s\n",
445 full_fname(fname), strerror(errno));
450 if (!S_ISREG(st.st_mode)) {
451 if (delete_file(fname) != 0) {
455 /* now pretend the file didn't exist */
456 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
459 if (!dry_run) write_sum_head(f_out, NULL);
463 if (opt_ignore_existing && fnamecmp == fname) {
465 rprintf(FINFO,"%s exists\n",fname);
469 if (update_only && cmp_modtime(st.st_mtime,file->modtime)>0 && fnamecmp == fname) {
471 rprintf(FINFO,"%s is newer\n",fname);
475 if (skip_file(fname, file, &st)) {
476 if (fnamecmp == fname)
477 set_perms(fname, file, &st, PERMS_REPORT);
486 if (disable_deltas_p()) {
488 write_sum_head(f_out, NULL);
493 fd = do_open(fnamecmp, O_RDONLY, 0);
496 rprintf(FERROR, "failed to open %s, continuing: %s\n",
497 full_fname(fnamecmp), strerror(errno));
498 /* pretend the file didn't exist */
499 if (preserve_hard_links && hard_link_check(file, HL_SKIP))
502 write_sum_head(f_out, NULL);
507 mapbuf = map_file(fd,st.st_size);
512 rprintf(FINFO,"gen mapped %s of size %.0f\n", fnamecmp,
517 rprintf(FINFO, "generating and sending sums for %d\n", i);
520 generate_and_send_sums(mapbuf, st.st_size, f_out);
523 if (mapbuf) unmap_file(mapbuf);
527 void generate_files(int f, struct file_list *flist, char *local_name)
531 char fbuf[MAXPATHLEN];
534 rprintf(FINFO, "generator starting pid=%ld count=%d\n",
535 (long)getpid(), flist->count);
541 ? "delta-transmission disabled for local transfer or --whole-file\n"
542 : "delta transmission enabled\n");
545 /* we expect to just sit around now, so don't exit on a
546 timeout. If we really get a timeout then the other process should
550 for (i = 0; i < flist->count; i++) {
551 struct file_struct *file = flist->files[i];
552 struct file_struct copy;
556 /* we need to ensure that any directories we create have writeable
557 permissions initially so that we can create the files within
558 them. This is then fixed after the files are transferred */
559 if (!am_root && S_ISDIR(file->mode) && !(file->mode & S_IWUSR)) {
561 /* XXX: Could this be causing a problem on SCO? Perhaps their
562 * handling of permissions is strange? */
563 copy.mode |= S_IWUSR; /* user write */
567 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
572 csum_length = SUM_LENGTH;
576 rprintf(FINFO,"generate_files phase=%d\n",phase);
580 /* files can cycle through the system more than once
581 * to catch initial checksum errors */
582 while ((i = get_redo_num()) != -1) {
583 struct file_struct *file = flist->files[i];
584 recv_generator(local_name ? local_name : f_name_to(file, fbuf),
590 rprintf(FINFO,"generate_files phase=%d\n",phase);
594 if (preserve_hard_links)
597 /* now we need to fix any directory permissions that were
598 * modified during the transfer */
599 for (i = 0; i < flist->count; i++) {
600 struct file_struct *file = flist->files[i];
601 if (!file->basename || !S_ISDIR(file->mode)) continue;
602 recv_generator(local_name ? local_name : f_name(file),
607 rprintf(FINFO,"generate_files finished\n");