2 * Routines only used by the receiving process.
4 * Copyright (C) 1996-2000 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2003-2009 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
29 extern int do_progress;
30 extern int inc_recurse;
31 extern int log_before_transfer;
32 extern int stdout_format_has_i;
33 extern int logfile_format_has_i;
34 extern int csum_length;
35 extern int read_batch;
36 extern int write_batch;
37 extern int batch_gen_fd;
38 extern int protocol_version;
39 extern int relative_paths;
40 extern int preserve_hard_links;
41 extern int preserve_perms;
42 extern int preserve_xattrs;
43 extern int basis_dir_cnt;
44 extern int make_backups;
45 extern int cleanup_got_literal;
46 extern int remove_source_files;
47 extern int append_mode;
48 extern int sparse_files;
49 extern int keep_partial;
50 extern int checksum_seed;
52 extern int delay_updates;
53 extern mode_t orig_umask;
54 extern struct stats stats;
56 extern char *partial_dir;
57 extern char *basis_dir[MAX_BASIS_DIRS+1];
58 extern struct file_list *cur_flist, *first_flist, *dir_flist;
59 extern struct filter_list_struct daemon_filter_list;
61 static struct bitbag *delayed_bits = NULL;
62 static int phase = 0, redoing = 0;
63 static flist_ndx_list batch_redo_list;
64 /* We're either updating the basis file or an identical copy: */
65 static int updating_basis_or_equiv;
68 * get_tmpname() - create a tmp filename for a given filename
70 * If a tmpdir is defined, use that as the directory to
71 * put it in. Otherwise, the tmp filename is in the same
72 * directory as the given name. Note that there may be no
73 * directory at all in the given name!
75 * The tmp filename is basically the given filename with a
76 * dot prepended, and .XXXXXX appended (for mkstemp() to
77 * put its unique gunk in). Take care to not exceed
78 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
79 * the basename basically becomes 8 chars longer. In that
80 * case, the original name is shortened sufficiently to
83 * Of course, there's no real reason for the tmp name to
84 * look like the original, except to satisfy us humans.
85 * As long as it's unique, rsync will work.
88 int get_tmpname(char *fnametmp, const char *fname)
90 int maxname, added, length = 0;
94 /* Note: this can't overflow, so the return value is safe */
95 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
96 fnametmp[length++] = '/';
99 if ((f = strrchr(fname, '/')) != NULL) {
103 /* copy up to and including the slash */
104 strlcpy(fnametmp, fname, length + 1);
108 fnametmp[length++] = '.';
110 /* The maxname value is bufsize, and includes space for the '\0'.
111 * (Note that NAME_MAX get -8 for the leading '.' above.) */
112 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
115 rprintf(FERROR_XFER, "temporary filename too long: %s\n", fname);
120 added = strlcpy(fnametmp + length, f, maxname);
121 if (added >= maxname)
123 memcpy(fnametmp + length + added, ".XXXXXX", 8);
128 /* Opens a temporary file for writing.
129 * Success: Writes name into fnametmp, returns fd.
130 * Failure: Clobbers fnametmp, returns -1.
131 * Calling cleanup_set() is the caller's job. */
132 int open_tmpfile(char *fnametmp, const char *fname, struct file_struct *file)
137 if (!get_tmpname(fnametmp, fname))
141 /* For --fake-super, the file must be useable by the copying
142 * user, just like it would be for root. */
143 added_perms = S_IRUSR|S_IWUSR;
145 /* For a normal copy, we need to be able to tweak things like xattrs. */
146 added_perms = S_IWUSR;
149 /* We initially set the perms without the setuid/setgid bits or group
150 * access to ensure that there is no race condition. They will be
151 * correctly updated after the right owner and group info is set.
152 * (Thanks to snabb@epipe.fi for pointing this out.) */
153 fd = do_mkstemp(fnametmp, (file->mode|added_perms) & INITACCESSPERMS);
156 /* In most cases parent directories will already exist because their
157 * information should have been previously transferred, but that may
158 * not be the case with -R */
159 if (fd == -1 && relative_paths && errno == ENOENT
160 && create_directory_path(fnametmp) == 0) {
161 /* Get back to name with XXXXXX in it. */
162 get_tmpname(fnametmp, fname);
163 fd = do_mkstemp(fnametmp, (file->mode|added_perms) & INITACCESSPERMS);
168 rsyserr(FERROR_XFER, errno, "mkstemp %s failed",
169 full_fname(fnametmp));
176 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
177 const char *fname, int fd, OFF_T total_size)
179 static char file_sum1[MAX_DIGEST_LEN];
180 static char file_sum2[MAX_DIGEST_LEN];
181 struct map_struct *mapbuf;
182 struct sum_struct sum;
190 read_sum_head(f_in, &sum);
192 if (fd_r >= 0 && size_r > 0) {
193 int32 read_size = MAX(sum.blength * 2, 16*1024);
194 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
196 rprintf(FINFO, "recv mapped %s of size %.0f\n",
197 fname_r, (double)size_r);
202 sum_init(checksum_seed);
204 if (append_mode > 0) {
206 sum.flength = (OFF_T)sum.count * sum.blength;
208 sum.flength -= sum.blength - sum.remainder;
209 if (append_mode == 2) {
210 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
212 show_progress(offset, total_size);
213 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
217 if (offset < sum.flength) {
218 int32 len = (int32)(sum.flength - offset);
220 show_progress(offset, total_size);
221 sum_update(map_ptr(mapbuf, offset, len), len);
224 offset = sum.flength;
225 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
226 rsyserr(FERROR_XFER, errno, "lseek of %s returned %.0f, not %.0f",
227 full_fname(fname), (double)j, (double)offset);
228 exit_cleanup(RERR_FILEIO);
232 while ((i = recv_token(f_in, &data)) != 0) {
234 show_progress(offset, total_size);
238 rprintf(FINFO,"data recv %d at %.0f\n",
242 stats.literal_data += i;
243 cleanup_got_literal = 1;
247 if (fd != -1 && write_file(fd,data,i) != i)
248 goto report_write_error;
254 offset2 = i * (OFF_T)sum.blength;
256 if (i == (int)sum.count-1 && sum.remainder != 0)
259 stats.matched_data += len;
263 "chunk[%d] of size %ld at %.0f offset=%.0f%s\n",
264 i, (long)len, (double)offset2, (double)offset,
265 updating_basis_or_equiv && offset == offset2 ? " (seek)" : "");
269 map = map_ptr(mapbuf,offset2,len);
272 sum_update(map, len);
275 if (updating_basis_or_equiv) {
276 if (offset == offset2 && fd != -1) {
278 if (flush_write_file(fd) < 0)
279 goto report_write_error;
281 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
282 rsyserr(FERROR_XFER, errno,
283 "lseek of %s returned %.0f, not %.0f",
285 (double)pos, (double)offset);
286 exit_cleanup(RERR_FILEIO);
291 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
292 goto report_write_error;
296 if (flush_write_file(fd) < 0)
297 goto report_write_error;
299 #ifdef HAVE_FTRUNCATE
300 if (inplace && fd != -1
301 && ftruncate(fd, offset) < 0) {
302 rsyserr(FERROR_XFER, errno, "ftruncate failed on %s",
308 end_progress(total_size);
310 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
312 rsyserr(FERROR_XFER, errno, "write failed on %s",
314 exit_cleanup(RERR_FILEIO);
317 sum_len = sum_end(file_sum1);
322 read_buf(f_in, file_sum2, sum_len);
324 rprintf(FINFO,"got file_sum\n");
325 if (fd != -1 && memcmp(file_sum1, file_sum2, sum_len) != 0)
331 static void discard_receive_data(int f_in, OFF_T length)
333 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
336 static void handle_delayed_updates(char *local_name)
338 char *fname, *partialptr;
341 for (ndx = -1; (ndx = bitbag_next_bit(delayed_bits, ndx)) >= 0; ) {
342 struct file_struct *file = cur_flist->files[ndx];
343 fname = local_name ? local_name : f_name(file, NULL);
344 if ((partialptr = partial_dir_fname(fname)) != NULL) {
345 if (make_backups > 0 && !make_backup(fname))
348 rprintf(FINFO, "renaming %s to %s\n",
351 /* We don't use robust_rename() here because the
352 * partial-dir must be on the same drive. */
353 if (do_rename(partialptr, fname) < 0) {
354 rsyserr(FERROR_XFER, errno,
355 "rename failed for %s (from %s)",
356 full_fname(fname), partialptr);
358 if (remove_source_files
359 || (preserve_hard_links && F_IS_HLINKED(file)))
360 send_msg_int(MSG_SUCCESS, ndx);
361 handle_partial_dir(partialptr, PDIR_DELETE);
367 static void no_batched_update(int ndx, BOOL is_redo)
369 struct file_list *flist = flist_for_ndx(ndx, "no_batched_update");
370 struct file_struct *file = flist->files[ndx - flist->ndx_start];
372 rprintf(FERROR_XFER, "(No batched update for%s \"%s\")\n",
373 is_redo ? " resend of" : "", f_name(file, NULL));
375 if (inc_recurse && !dry_run)
376 send_msg_int(MSG_NO_SEND, ndx);
379 static int we_want_redo(int desired_ndx)
381 static int redo_ndx = -1;
383 while (redo_ndx < desired_ndx) {
385 no_batched_update(redo_ndx, True);
386 if ((redo_ndx = flist_ndx_pop(&batch_redo_list)) < 0)
390 if (redo_ndx == desired_ndx) {
398 static int gen_wants_ndx(int desired_ndx)
400 static int next_ndx = -1;
401 static int done_cnt = 0;
402 static BOOL got_eof = False;
403 int flist_num = first_flist->flist_num;
408 while (next_ndx < desired_ndx) {
409 if (inc_recurse && flist_num <= done_cnt)
412 no_batched_update(next_ndx, False);
413 if ((next_ndx = read_int(batch_gen_fd)) < 0) {
423 if (next_ndx == desired_ndx) {
432 * main routine for receiver process.
434 * Receiver process runs on the same host as the generator process. */
435 int recv_files(int f_in, char *local_name)
440 char *fname, fbuf[MAXPATHLEN];
441 char xname[MAXPATHLEN];
442 char fnametmp[MAXPATHLEN];
443 char *fnamecmp, *partialptr;
444 char fnamecmpbuf[MAXPATHLEN];
446 struct file_struct *file;
447 struct stats initial_stats;
448 int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
449 enum logcode log_code = log_before_transfer ? FLOG : FINFO;
450 int max_phase = protocol_version >= 29 ? 2 : 1;
451 int dflt_perms = (ACCESSPERMS & ~orig_umask);
453 const char *parent_dirname = "";
458 rprintf(FINFO, "recv_files(%d) starting\n", cur_flist->used);
461 delayed_bits = bitbag_create(cur_flist->used + 1);
466 /* This call also sets cur_flist. */
467 ndx = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
469 if (ndx == NDX_DONE) {
470 if (inc_recurse && first_flist) {
472 gen_wants_ndx(first_flist->used + first_flist->ndx_start);
473 flist_free(first_flist);
476 } else if (read_batch && first_flist)
477 gen_wants_ndx(first_flist->used);
478 if (++phase > max_phase)
481 rprintf(FINFO, "recv_files phase=%d\n", phase);
482 if (phase == 2 && delay_updates)
483 handle_delayed_updates(local_name);
484 send_msg(MSG_DONE, "", 0, 0);
488 if (ndx - cur_flist->ndx_start >= 0)
489 file = cur_flist->files[ndx - cur_flist->ndx_start];
491 file = dir_flist->files[cur_flist->parent_ndx];
492 fname = local_name ? local_name : f_name(file, fbuf);
495 rprintf(FINFO, "recv_files(%s)\n", fname);
497 #ifdef SUPPORT_XATTRS
498 if (iflags & ITEM_REPORT_XATTR && do_xfers)
499 recv_xattr_request(file, f_in);
502 if (!(iflags & ITEM_TRANSFER)) {
503 maybe_log_item(file, iflags, itemizing, xname);
504 #ifdef SUPPORT_XATTRS
505 if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && do_xfers)
506 set_file_attrs(fname, file, NULL, fname, 0);
512 "got transfer request in phase 2 [%s]\n",
514 exit_cleanup(RERR_PROTOCOL);
517 if (file->flags & FLAG_FILE_SENT) {
518 if (csum_length == SHORT_SUM_LENGTH) {
519 if (keep_partial && !partial_dir)
520 make_backups = -make_backups; /* prevents double backup */
522 sparse_files = -sparse_files;
523 append_mode = -append_mode;
524 csum_length = SUM_LENGTH;
528 if (csum_length != SHORT_SUM_LENGTH) {
529 if (keep_partial && !partial_dir)
530 make_backups = -make_backups;
532 sparse_files = -sparse_files;
533 append_mode = -append_mode;
534 csum_length = SHORT_SUM_LENGTH;
539 if (!am_server && do_progress)
540 set_current_file_index(file, ndx);
541 stats.num_transferred_files++;
542 stats.total_transferred_size += F_LENGTH(file);
544 cleanup_got_literal = 0;
546 if (daemon_filter_list.head
547 && check_filter(&daemon_filter_list, FLOG, fname, 0) < 0) {
548 rprintf(FERROR, "attempt to hack rsync failed.\n");
549 exit_cleanup(RERR_PROTOCOL);
555 : gen_wants_ndx(ndx);
558 "(Skipping batched update for%s \"%s\")\n",
559 redoing ? " resend of" : "",
561 discard_receive_data(f_in, F_LENGTH(file));
562 file->flags |= FLAG_FILE_SENT;
567 if (!do_xfers) { /* log the transfer */
568 log_item(FCLIENT, file, &stats, iflags, NULL);
570 discard_receive_data(f_in, F_LENGTH(file));
573 if (write_batch < 0) {
574 log_item(FCLIENT, file, &stats, iflags, NULL);
576 discard_receive_data(f_in, F_LENGTH(file));
580 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
582 if (protocol_version >= 29) {
583 switch (fnamecmp_type) {
587 case FNAMECMP_PARTIAL_DIR:
588 fnamecmp = partialptr;
590 case FNAMECMP_BACKUP:
591 fnamecmp = get_backup_name(fname);
595 pathjoin(fnamecmpbuf, MAXPATHLEN,
596 file->dirname, xname);
597 fnamecmp = fnamecmpbuf;
602 if (fnamecmp_type >= basis_dir_cnt) {
604 "invalid basis_dir index: %d.\n",
606 exit_cleanup(RERR_PROTOCOL);
608 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
609 basis_dir[fnamecmp_type], fname);
610 fnamecmp = fnamecmpbuf;
613 if (!fnamecmp || (daemon_filter_list.head
614 && check_filter(&daemon_filter_list, FLOG, fname, 0) < 0)) {
616 fnamecmp_type = FNAMECMP_FNAME;
619 /* Reminder: --inplace && --partial-dir are never
620 * enabled at the same time. */
621 if (inplace && make_backups > 0) {
622 if (!(fnamecmp = get_backup_name(fname)))
625 fnamecmp_type = FNAMECMP_BACKUP;
626 } else if (partial_dir && partialptr)
627 fnamecmp = partialptr;
632 initial_stats = stats;
635 fd1 = do_open(fnamecmp, O_RDONLY, 0);
637 if (fd1 == -1 && protocol_version < 29) {
638 if (fnamecmp != fname) {
640 fd1 = do_open(fnamecmp, O_RDONLY, 0);
643 if (fd1 == -1 && basis_dir[0]) {
644 /* pre-29 allowed only one alternate basis */
645 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
646 basis_dir[0], fname);
647 fnamecmp = fnamecmpbuf;
648 fd1 = do_open(fnamecmp, O_RDONLY, 0);
652 updating_basis_or_equiv = inplace
653 && (fnamecmp == fname || fnamecmp_type == FNAMECMP_BACKUP);
658 } else if (do_fstat(fd1,&st) != 0) {
659 rsyserr(FERROR_XFER, errno, "fstat %s failed",
660 full_fname(fnamecmp));
661 discard_receive_data(f_in, F_LENGTH(file));
664 send_msg_int(MSG_NO_SEND, ndx);
668 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
669 /* this special handling for directories
670 * wouldn't be necessary if robust_rename()
671 * and the underlying robust_unlink could cope
674 rprintf(FERROR_XFER, "recv_files: %s is a directory\n",
675 full_fname(fnamecmp));
676 discard_receive_data(f_in, F_LENGTH(file));
679 send_msg_int(MSG_NO_SEND, ndx);
683 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
688 /* If we're not preserving permissions, change the file-list's
689 * mode based on the local permissions and some heuristics. */
690 if (!preserve_perms) {
691 int exists = fd1 != -1;
693 const char *dn = file->dirname ? file->dirname : ".";
694 if (parent_dirname != dn
695 && strcmp(parent_dirname, dn) != 0) {
696 dflt_perms = default_perms_for_dir(dn);
700 file->mode = dest_mode(file->mode, st.st_mode,
704 /* We now check to see if we are writing the file "inplace" */
706 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
708 rsyserr(FERROR_XFER, errno, "open %s failed",
712 fd2 = open_tmpfile(fnametmp, fname, file);
714 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
718 discard_receive_data(f_in, F_LENGTH(file));
722 send_msg_int(MSG_NO_SEND, ndx);
726 /* log the transfer */
727 if (log_before_transfer)
728 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
729 else if (!am_server && verbose && do_progress)
730 rprintf(FINFO, "%s\n", fname);
733 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
734 fname, fd2, F_LENGTH(file));
736 log_item(log_code, file, &initial_stats, iflags, NULL);
740 if (close(fd2) < 0) {
741 rsyserr(FERROR, errno, "close failed on %s",
742 full_fname(fnametmp));
743 exit_cleanup(RERR_FILEIO);
746 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
747 if (partialptr == fname)
749 if (!finish_transfer(fname, fnametmp, fnamecmp,
750 partialptr, file, recv_ok, 1))
752 else if (fnamecmp == partialptr) {
753 do_unlink(partialptr);
754 handle_partial_dir(partialptr, PDIR_DELETE);
756 } else if (keep_partial && partialptr) {
757 if (!handle_partial_dir(partialptr, PDIR_CREATE)) {
759 "Unable to create partial-dir for %s -- discarding %s.\n",
760 local_name ? local_name : f_name(file, NULL),
761 recv_ok ? "completed file" : "partial file");
764 } else if (!finish_transfer(partialptr, fnametmp, fnamecmp, NULL,
765 file, recv_ok, !partial_dir))
767 else if (delay_updates && recv_ok) {
768 bitbag_set_bit(delayed_bits, ndx);
778 file->flags |= FLAG_FILE_SENT;
784 if (remove_source_files || inc_recurse
785 || (preserve_hard_links && F_IS_HLINKED(file)))
786 send_msg_int(MSG_SUCCESS, ndx);
789 enum logcode msgtype = redoing ? FERROR_XFER : FWARNING;
790 if (msgtype == FERROR_XFER || verbose) {
791 char *errstr, *redostr, *keptstr;
792 if (!(keep_partial && partialptr) && !inplace)
793 keptstr = "discarded";
794 else if (partial_dir)
795 keptstr = "put into partial-dir";
797 keptstr = "retained";
798 if (msgtype == FERROR_XFER) {
803 redostr = read_batch ? " (may try again)"
804 : " (will try again)";
807 "%s: %s failed verification -- update %s%s.\n",
808 errstr, local_name ? f_name(file, NULL) : fname,
813 flist_ndx_push(&batch_redo_list, ndx);
814 send_msg_int(MSG_REDO, ndx);
815 file->flags |= FLAG_FILE_SENT;
816 } else if (inc_recurse)
817 send_msg_int(MSG_NO_SEND, ndx);
822 send_msg_int(MSG_NO_SEND, ndx);
826 if (make_backups < 0)
827 make_backups = -make_backups;
829 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
830 handle_delayed_updates(local_name);
833 rprintf(FINFO,"recv_files finished\n");