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-2008 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.
28 extern int inc_recurse;
29 extern int log_before_transfer;
30 extern int stdout_format_has_i;
31 extern int logfile_format_has_i;
32 extern int csum_length;
33 extern int read_batch;
34 extern int write_batch;
35 extern int batch_gen_fd;
36 extern int protocol_version;
37 extern int relative_paths;
38 extern int preserve_hard_links;
39 extern int preserve_perms;
40 extern int preserve_xattrs;
41 extern int basis_dir_cnt;
42 extern int make_backups;
43 extern int cleanup_got_literal;
44 extern int remove_source_files;
45 extern int append_mode;
46 extern int sparse_files;
47 extern int keep_partial;
48 extern int checksum_len;
49 extern int checksum_seed;
51 extern int delay_updates;
52 extern mode_t orig_umask;
53 extern struct stats stats;
55 extern char *partial_dir;
56 extern char *basis_dir[MAX_BASIS_DIRS+1];
57 extern char sender_file_sum[MAX_DIGEST_LEN];
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)
136 if (!get_tmpname(fnametmp, fname))
139 /* We initially set the perms without the setuid/setgid bits or group
140 * access to ensure that there is no race condition. They will be
141 * correctly updated after the right owner and group info is set.
142 * (Thanks to snabb@epipe.fi for pointing this out.) */
143 fd = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
146 /* In most cases parent directories will already exist because their
147 * information should have been previously transferred, but that may
148 * not be the case with -R */
149 if (fd == -1 && relative_paths && errno == ENOENT
150 && create_directory_path(fnametmp) == 0) {
151 /* Get back to name with XXXXXX in it. */
152 get_tmpname(fnametmp, fname);
153 fd = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
158 rsyserr(FERROR_XFER, errno, "mkstemp %s failed",
159 full_fname(fnametmp));
166 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
167 const char *fname, int fd, OFF_T total_size)
169 static char file_sum1[MAX_DIGEST_LEN];
170 struct map_struct *mapbuf;
171 struct sum_struct sum;
179 read_sum_head(f_in, &sum);
181 if (fd_r >= 0 && size_r > 0) {
182 int32 read_size = MAX(sum.blength * 2, 16*1024);
183 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
184 if (DEBUG_GTE(DELTASUM, 2)) {
185 rprintf(FINFO, "recv mapped %s of size %s\n",
186 fname_r, big_num(size_r));
191 sum_init(checksum_seed);
193 if (append_mode > 0) {
195 sum.flength = (OFF_T)sum.count * sum.blength;
197 sum.flength -= sum.blength - sum.remainder;
198 if (append_mode == 2) {
199 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
200 if (INFO_GTE(PROGRESS, 1))
201 show_progress(offset, total_size);
202 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
206 if (offset < sum.flength) {
207 int32 len = (int32)(sum.flength - offset);
208 if (INFO_GTE(PROGRESS, 1))
209 show_progress(offset, total_size);
210 sum_update(map_ptr(mapbuf, offset, len), len);
213 offset = sum.flength;
214 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
215 rsyserr(FERROR_XFER, errno, "lseek of %s returned %s, not %s",
216 full_fname(fname), big_num(j), big_num(offset));
217 exit_cleanup(RERR_FILEIO);
221 while ((i = recv_token(f_in, &data)) != 0) {
222 if (INFO_GTE(PROGRESS, 1))
223 show_progress(offset, total_size);
226 if (DEBUG_GTE(DELTASUM, 3)) {
227 rprintf(FINFO,"data recv %d at %s\n",
231 stats.literal_data += i;
232 cleanup_got_literal = 1;
236 if (fd != -1 && write_file(fd,data,i) != i)
237 goto report_write_error;
243 offset2 = i * (OFF_T)sum.blength;
245 if (i == (int)sum.count-1 && sum.remainder != 0)
248 stats.matched_data += len;
250 if (DEBUG_GTE(DELTASUM, 3)) {
252 "chunk[%d] of size %ld at %s offset=%s\n",
253 i, (long)len, big_num(offset2), big_num(offset));
257 map = map_ptr(mapbuf,offset2,len);
260 sum_update(map, len);
263 if (updating_basis_or_equiv) {
264 if (offset == offset2 && fd != -1) {
266 if (flush_write_file(fd) < 0)
267 goto report_write_error;
269 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
270 rsyserr(FERROR_XFER, errno,
271 "lseek of %s returned %s, not %s",
273 big_num(pos), big_num(offset));
274 exit_cleanup(RERR_FILEIO);
279 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
280 goto report_write_error;
284 if (flush_write_file(fd) < 0)
285 goto report_write_error;
287 #ifdef HAVE_FTRUNCATE
288 if (inplace && fd != -1)
289 ftruncate(fd, offset);
292 if (INFO_GTE(PROGRESS, 1))
293 end_progress(total_size);
295 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
297 rsyserr(FERROR_XFER, errno, "write failed on %s",
299 exit_cleanup(RERR_FILEIO);
302 if (sum_end(file_sum1) != checksum_len)
303 overflow_exit("checksum_len"); /* Impossible... */
308 read_buf(f_in, sender_file_sum, checksum_len);
309 if (DEBUG_GTE(DELTASUM, 2))
310 rprintf(FINFO,"got file_sum\n");
311 if (fd != -1 && memcmp(file_sum1, sender_file_sum, checksum_len) != 0)
317 static void discard_receive_data(int f_in, OFF_T length)
319 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
322 static void handle_delayed_updates(char *local_name)
324 char *fname, *partialptr;
327 for (ndx = -1; (ndx = bitbag_next_bit(delayed_bits, ndx)) >= 0; ) {
328 struct file_struct *file = cur_flist->files[ndx];
329 fname = local_name ? local_name : f_name(file, NULL);
330 if ((partialptr = partial_dir_fname(fname)) != NULL) {
331 if (make_backups > 0 && !make_backup(fname))
333 if (DEBUG_GTE(RECV, 1)) {
334 rprintf(FINFO, "renaming %s to %s\n",
337 /* We don't use robust_rename() here because the
338 * partial-dir must be on the same drive. */
339 if (do_rename(partialptr, fname) < 0) {
340 rsyserr(FERROR_XFER, errno,
341 "rename failed for %s (from %s)",
342 full_fname(fname), partialptr);
344 if (remove_source_files
345 || (preserve_hard_links && F_IS_HLINKED(file)))
346 send_msg_int(MSG_SUCCESS, ndx);
347 handle_partial_dir(partialptr, PDIR_DELETE);
353 static void no_batched_update(int ndx, BOOL is_redo)
355 struct file_list *flist = flist_for_ndx(ndx, "no_batched_update");
356 struct file_struct *file = flist->files[ndx - flist->ndx_start];
358 rprintf(FERROR_XFER, "(No batched update for%s \"%s\")\n",
359 is_redo ? " resend of" : "", f_name(file, NULL));
362 send_msg_int(MSG_NO_SEND, ndx);
365 static int we_want_redo(int desired_ndx)
367 static int redo_ndx = -1;
369 while (redo_ndx < desired_ndx) {
371 no_batched_update(redo_ndx, True);
372 if ((redo_ndx = flist_ndx_pop(&batch_redo_list)) < 0)
376 if (redo_ndx == desired_ndx) {
384 static int gen_wants_ndx(int desired_ndx)
386 static int next_ndx = -1;
387 static BOOL got_eof = 0;
392 while (next_ndx < desired_ndx) {
394 no_batched_update(next_ndx, False);
395 if ((next_ndx = read_int(batch_gen_fd)) < 0) {
401 if (next_ndx == desired_ndx) {
410 * main routine for receiver process.
412 * Receiver process runs on the same host as the generator process. */
413 int recv_files(int f_in, char *local_name)
418 char *fname, fbuf[MAXPATHLEN];
419 char xname[MAXPATHLEN];
420 char fnametmp[MAXPATHLEN];
421 char *fnamecmp, *partialptr;
422 char fnamecmpbuf[MAXPATHLEN];
424 struct file_struct *file;
425 struct stats initial_stats;
426 int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
427 enum logcode log_code = log_before_transfer ? FLOG : FINFO;
428 int max_phase = protocol_version >= 29 ? 2 : 1;
429 int dflt_perms = (ACCESSPERMS & ~orig_umask);
431 const char *parent_dirname = "";
435 if (DEBUG_GTE(RECV, 1))
436 rprintf(FINFO, "recv_files(%d) starting\n", cur_flist->used);
439 delayed_bits = bitbag_create(cur_flist->used + 1);
444 /* This call also sets cur_flist. */
445 ndx = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
447 if (ndx == NDX_DONE) {
448 if (!am_server && INFO_GTE(PROGRESS, 2) && cur_flist) {
449 set_current_file_index(NULL, 0);
452 if (inc_recurse && first_flist) {
454 gen_wants_ndx(first_flist->used + first_flist->ndx_start);
455 flist_free(first_flist);
458 } else if (read_batch && first_flist)
459 gen_wants_ndx(first_flist->used);
460 if (++phase > max_phase)
462 if (DEBUG_GTE(RECV, 1))
463 rprintf(FINFO, "recv_files phase=%d\n", phase);
464 if (phase == 2 && delay_updates)
465 handle_delayed_updates(local_name);
466 send_msg(MSG_DONE, "", 0, 0);
470 if (ndx - cur_flist->ndx_start >= 0)
471 file = cur_flist->files[ndx - cur_flist->ndx_start];
473 file = dir_flist->files[cur_flist->parent_ndx];
474 fname = local_name ? local_name : f_name(file, fbuf);
476 if (DEBUG_GTE(RECV, 1))
477 rprintf(FINFO, "recv_files(%s)\n", fname);
479 #ifdef SUPPORT_XATTRS
480 if (iflags & ITEM_REPORT_XATTR && !dry_run)
481 recv_xattr_request(file, f_in);
484 if (!(iflags & ITEM_TRANSFER)) {
485 maybe_log_item(file, iflags, itemizing, xname);
486 #ifdef SUPPORT_XATTRS
487 if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && !dry_run)
488 set_file_attrs(fname, file, NULL, fname, 0);
494 "got transfer request in phase 2 [%s]\n",
496 exit_cleanup(RERR_PROTOCOL);
499 if (file->flags & FLAG_FILE_SENT) {
500 if (csum_length == SHORT_SUM_LENGTH) {
501 if (keep_partial && !partial_dir)
502 make_backups = -make_backups; /* prevents double backup */
504 sparse_files = -sparse_files;
505 append_mode = -append_mode;
506 csum_length = SUM_LENGTH;
510 if (csum_length != SHORT_SUM_LENGTH) {
511 if (keep_partial && !partial_dir)
512 make_backups = -make_backups;
514 sparse_files = -sparse_files;
515 append_mode = -append_mode;
516 csum_length = SHORT_SUM_LENGTH;
521 if (!am_server && INFO_GTE(PROGRESS, 1))
522 set_current_file_index(file, ndx);
523 stats.num_transferred_files++;
524 stats.total_transferred_size += F_LENGTH(file);
526 cleanup_got_literal = 0;
528 if (daemon_filter_list.head
529 && check_filter(&daemon_filter_list, FLOG, fname, 0) < 0) {
530 rprintf(FERROR, "attempt to hack rsync failed.\n");
531 exit_cleanup(RERR_PROTOCOL);
534 if (!do_xfers) { /* log the transfer */
535 log_item(FCLIENT, file, &stats, iflags, NULL);
537 discard_receive_data(f_in, F_LENGTH(file));
540 if (write_batch < 0) {
541 log_item(FCLIENT, file, &stats, iflags, NULL);
543 discard_receive_data(f_in, F_LENGTH(file));
548 if (!(redoing ? we_want_redo(ndx) : gen_wants_ndx(ndx))) {
550 "(Skipping batched update for%s \"%s\")\n",
551 redoing ? " resend of" : "",
553 discard_receive_data(f_in, F_LENGTH(file));
554 file->flags |= FLAG_FILE_SENT;
559 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
561 if (protocol_version >= 29) {
562 switch (fnamecmp_type) {
566 case FNAMECMP_PARTIAL_DIR:
567 fnamecmp = partialptr;
569 case FNAMECMP_BACKUP:
570 fnamecmp = get_backup_name(fname);
574 pathjoin(fnamecmpbuf, MAXPATHLEN,
575 file->dirname, xname);
576 fnamecmp = fnamecmpbuf;
581 if (fnamecmp_type >= basis_dir_cnt) {
583 "invalid basis_dir index: %d.\n",
585 exit_cleanup(RERR_PROTOCOL);
587 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
588 basis_dir[fnamecmp_type], fname);
589 fnamecmp = fnamecmpbuf;
592 if (!fnamecmp || (daemon_filter_list.head
593 && check_filter(&daemon_filter_list, FLOG, fname, 0) < 0)) {
595 fnamecmp_type = FNAMECMP_FNAME;
598 /* Reminder: --inplace && --partial-dir are never
599 * enabled at the same time. */
600 if (inplace && make_backups > 0) {
601 if (!(fnamecmp = get_backup_name(fname)))
604 fnamecmp_type = FNAMECMP_BACKUP;
605 } else if (partial_dir && partialptr)
606 fnamecmp = partialptr;
611 initial_stats = stats;
614 fd1 = do_open(fnamecmp, O_RDONLY, 0);
616 if (fd1 == -1 && protocol_version < 29) {
617 if (fnamecmp != fname) {
619 fd1 = do_open(fnamecmp, O_RDONLY, 0);
622 if (fd1 == -1 && basis_dir[0]) {
623 /* pre-29 allowed only one alternate basis */
624 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
625 basis_dir[0], fname);
626 fnamecmp = fnamecmpbuf;
627 fd1 = do_open(fnamecmp, O_RDONLY, 0);
631 updating_basis_or_equiv = inplace
632 && (fnamecmp == fname || fnamecmp_type == FNAMECMP_BACKUP);
637 } else if (do_fstat(fd1,&st) != 0) {
638 rsyserr(FERROR_XFER, errno, "fstat %s failed",
639 full_fname(fnamecmp));
640 discard_receive_data(f_in, F_LENGTH(file));
643 send_msg_int(MSG_NO_SEND, ndx);
647 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
648 /* this special handling for directories
649 * wouldn't be necessary if robust_rename()
650 * and the underlying robust_unlink could cope
653 rprintf(FERROR_XFER, "recv_files: %s is a directory\n",
654 full_fname(fnamecmp));
655 discard_receive_data(f_in, F_LENGTH(file));
658 send_msg_int(MSG_NO_SEND, ndx);
662 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
667 /* If we're not preserving permissions, change the file-list's
668 * mode based on the local permissions and some heuristics. */
669 if (!preserve_perms) {
670 int exists = fd1 != -1;
672 const char *dn = file->dirname ? file->dirname : ".";
673 if (parent_dirname != dn
674 && strcmp(parent_dirname, dn) != 0) {
675 dflt_perms = default_perms_for_dir(dn);
679 file->mode = dest_mode(file->mode, st.st_mode,
683 /* We now check to see if we are writing the file "inplace" */
685 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
687 rsyserr(FERROR_XFER, errno, "open %s failed",
691 fd2 = open_tmpfile(fnametmp, fname, file);
693 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
697 discard_receive_data(f_in, F_LENGTH(file));
701 send_msg_int(MSG_NO_SEND, ndx);
705 /* log the transfer */
706 if (log_before_transfer)
707 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
708 else if (!am_server && INFO_GTE(NAME, 1) && INFO_EQ(PROGRESS, 1))
709 rprintf(FINFO, "%s\n", fname);
712 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
713 fname, fd2, F_LENGTH(file));
715 log_item(log_code, file, &initial_stats, iflags, NULL);
719 if (close(fd2) < 0) {
720 rsyserr(FERROR, errno, "close failed on %s",
721 full_fname(fnametmp));
722 exit_cleanup(RERR_FILEIO);
725 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
726 if (partialptr == fname)
728 if (!finish_transfer(fname, fnametmp, fnamecmp,
729 partialptr, file, recv_ok, 1))
731 else if (fnamecmp == partialptr) {
732 do_unlink(partialptr);
733 handle_partial_dir(partialptr, PDIR_DELETE);
735 } else if (keep_partial && partialptr) {
736 if (!handle_partial_dir(partialptr, PDIR_CREATE)) {
738 "Unable to create partial-dir for %s -- discarding %s.\n",
739 local_name ? local_name : f_name(file, NULL),
740 recv_ok ? "completed file" : "partial file");
743 } else if (!finish_transfer(partialptr, fnametmp, fnamecmp, NULL,
744 file, recv_ok, !partial_dir))
746 else if (delay_updates && recv_ok) {
747 bitbag_set_bit(delayed_bits, ndx);
757 file->flags |= FLAG_FILE_SENT;
763 if (remove_source_files || inc_recurse
764 || (preserve_hard_links && F_IS_HLINKED(file)))
765 send_msg_int(MSG_SUCCESS, ndx);
768 enum logcode msgtype = redoing ? FERROR_XFER : FWARNING;
769 if (msgtype == FERROR_XFER || INFO_GTE(NAME, 1)) {
770 char *errstr, *redostr, *keptstr;
771 if (!(keep_partial && partialptr) && !inplace)
772 keptstr = "discarded";
773 else if (partial_dir)
774 keptstr = "put into partial-dir";
776 keptstr = "retained";
777 if (msgtype == FERROR_XFER) {
782 redostr = read_batch ? " (may try again)"
783 : " (will try again)";
786 "%s: %s failed verification -- update %s%s.\n",
787 errstr, local_name ? f_name(file, NULL) : fname,
792 flist_ndx_push(&batch_redo_list, ndx);
793 send_msg_int(MSG_REDO, ndx);
794 file->flags |= FLAG_FILE_SENT;
795 } else if (inc_recurse)
796 send_msg_int(MSG_NO_SEND, ndx);
801 send_msg_int(MSG_NO_SEND, ndx);
805 if (make_backups < 0)
806 make_backups = -make_backups;
808 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
809 handle_delayed_updates(local_name);
811 if (DEBUG_GTE(RECV, 1))
812 rprintf(FINFO,"recv_files finished\n");