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 do_progress
;
29 extern int inc_recurse
;
30 extern int log_before_transfer
;
31 extern int stdout_format_has_i
;
32 extern int logfile_format_has_i
;
33 extern int csum_length
;
34 extern int read_batch
;
35 extern int write_batch
;
36 extern int batch_gen_fd
;
37 extern int protocol_version
;
38 extern int relative_paths
;
39 extern int preserve_hard_links
;
40 extern int preserve_perms
;
41 extern int preserve_xattrs
;
42 extern int basis_dir_cnt
;
43 extern int make_backups
;
44 extern int cleanup_got_literal
;
45 extern int remove_source_files
;
46 extern int append_mode
;
47 extern int sparse_files
;
48 extern int keep_partial
;
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
[];
57 extern struct file_list
*cur_flist
, *first_flist
, *dir_flist
;
58 extern struct filter_list_struct daemon_filter_list
;
60 static struct bitbag
*delayed_bits
= NULL
;
61 static int phase
= 0, redoing
= 0;
62 static flist_ndx_list batch_redo_list
;
63 /* We're either updating the basis file or an identical copy: */
64 static int updating_basis_or_equiv
;
67 * get_tmpname() - create a tmp filename for a given filename
69 * If a tmpdir is defined, use that as the directory to
70 * put it in. Otherwise, the tmp filename is in the same
71 * directory as the given name. Note that there may be no
72 * directory at all in the given name!
74 * The tmp filename is basically the given filename with a
75 * dot prepended, and .XXXXXX appended (for mkstemp() to
76 * put its unique gunk in). Take care to not exceed
77 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
78 * the basename basically becomes 8 chars longer. In that
79 * case, the original name is shortened sufficiently to
82 * Of course, there's no real reason for the tmp name to
83 * look like the original, except to satisfy us humans.
84 * As long as it's unique, rsync will work.
87 int get_tmpname(char *fnametmp
, const char *fname
)
89 int maxname
, added
, length
= 0;
93 /* Note: this can't overflow, so the return value is safe */
94 length
= strlcpy(fnametmp
, tmpdir
, MAXPATHLEN
- 2);
95 fnametmp
[length
++] = '/';
98 if ((f
= strrchr(fname
, '/')) != NULL
) {
102 /* copy up to and including the slash */
103 strlcpy(fnametmp
, fname
, length
+ 1);
107 fnametmp
[length
++] = '.';
109 /* The maxname value is bufsize, and includes space for the '\0'.
110 * (Note that NAME_MAX get -8 for the leading '.' above.) */
111 maxname
= MIN(MAXPATHLEN
- 7 - length
, NAME_MAX
- 8);
114 rprintf(FERROR_XFER
, "temporary filename too long: %s\n", fname
);
119 added
= strlcpy(fnametmp
+ length
, f
, maxname
);
120 if (added
>= maxname
)
122 memcpy(fnametmp
+ length
+ added
, ".XXXXXX", 8);
127 /* Opens a temporary file for writing.
128 * Success: Writes name into fnametmp, returns fd.
129 * Failure: Clobbers fnametmp, returns -1.
130 * Calling cleanup_set() is the caller's job. */
131 int open_tmpfile(char *fnametmp
, const char *fname
, struct file_struct
*file
)
135 if (!get_tmpname(fnametmp
, fname
))
138 /* We initially set the perms without the setuid/setgid bits or group
139 * access to ensure that there is no race condition. They will be
140 * correctly updated after the right owner and group info is set.
141 * (Thanks to snabb@epipe.fi for pointing this out.) */
142 fd
= do_mkstemp(fnametmp
, file
->mode
& INITACCESSPERMS
);
145 /* In most cases parent directories will already exist because their
146 * information should have been previously transferred, but that may
147 * not be the case with -R */
148 if (fd
== -1 && relative_paths
&& errno
== ENOENT
149 && create_directory_path(fnametmp
) == 0) {
150 /* Get back to name with XXXXXX in it. */
151 get_tmpname(fnametmp
, fname
);
152 fd
= do_mkstemp(fnametmp
, file
->mode
& INITACCESSPERMS
);
157 rsyserr(FERROR_XFER
, errno
, "mkstemp %s failed",
158 full_fname(fnametmp
));
165 static int receive_data(int f_in
, char *fname_r
, int fd_r
, OFF_T size_r
,
166 const char *fname
, int fd
, OFF_T total_size
)
168 static char file_sum1
[MAX_DIGEST_LEN
];
169 static char file_sum2
[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
);
185 rprintf(FINFO
, "recv mapped %s of size %.0f\n",
186 fname_r
, (double)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
) {
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
);
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 %.0f, not %.0f",
216 full_fname(fname
), (double)j
, (double)offset
);
217 exit_cleanup(RERR_FILEIO
);
221 while ((i
= recv_token(f_in
, &data
)) != 0) {
223 show_progress(offset
, total_size
);
227 rprintf(FINFO
,"data recv %d at %.0f\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
;
252 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
253 i
, (long)len
, (double)offset2
, (double)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 %.0f, not %.0f",
273 (double)pos
, (double)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 if (ftruncate(fd
, offset
) < 0) {
290 rsyserr(FWARNING
, errno
, "ftruncate failed on %s",
297 end_progress(total_size
);
299 if (fd
!= -1 && offset
> 0 && sparse_end(fd
) != 0) {
301 rsyserr(FERROR_XFER
, errno
, "write failed on %s",
303 exit_cleanup(RERR_FILEIO
);
306 sum_len
= sum_end(file_sum1
);
311 read_buf(f_in
, file_sum2
, sum_len
);
313 rprintf(FINFO
,"got file_sum\n");
314 if (fd
!= -1 && memcmp(file_sum1
, file_sum2
, sum_len
) != 0)
320 static void discard_receive_data(int f_in
, OFF_T length
)
322 receive_data(f_in
, NULL
, -1, 0, NULL
, -1, length
);
325 static void handle_delayed_updates(char *local_name
)
327 char *fname
, *partialptr
;
330 for (ndx
= -1; (ndx
= bitbag_next_bit(delayed_bits
, ndx
)) >= 0; ) {
331 struct file_struct
*file
= cur_flist
->files
[ndx
];
332 fname
= local_name
? local_name
: f_name(file
, NULL
);
333 if ((partialptr
= partial_dir_fname(fname
)) != NULL
) {
334 if (make_backups
> 0 && !make_backup(fname
))
337 rprintf(FINFO
, "renaming %s to %s\n",
340 /* We don't use robust_rename() here because the
341 * partial-dir must be on the same drive. */
342 if (do_rename(partialptr
, fname
) < 0) {
343 rsyserr(FERROR_XFER
, errno
,
344 "rename failed for %s (from %s)",
345 full_fname(fname
), partialptr
);
347 if (remove_source_files
348 || (preserve_hard_links
&& F_IS_HLINKED(file
)))
349 send_msg_int(MSG_SUCCESS
, ndx
);
350 handle_partial_dir(partialptr
, PDIR_DELETE
);
356 static void no_batched_update(int ndx
, BOOL is_redo
)
358 struct file_list
*flist
= flist_for_ndx(ndx
, "no_batched_update");
359 struct file_struct
*file
= flist
->files
[ndx
- flist
->ndx_start
];
361 rprintf(FERROR_XFER
, "(No batched update for%s \"%s\")\n",
362 is_redo
? " resend of" : "", f_name(file
, NULL
));
365 send_msg_int(MSG_NO_SEND
, ndx
);
368 static int we_want_redo(int desired_ndx
)
370 static int redo_ndx
= -1;
372 while (redo_ndx
< desired_ndx
) {
374 no_batched_update(redo_ndx
, True
);
375 if ((redo_ndx
= flist_ndx_pop(&batch_redo_list
)) < 0)
379 if (redo_ndx
== desired_ndx
) {
387 static int gen_wants_ndx(int desired_ndx
)
389 static int next_ndx
= -1;
390 static BOOL got_eof
= 0;
395 while (next_ndx
< desired_ndx
) {
397 no_batched_update(next_ndx
, False
);
398 if ((next_ndx
= read_int(batch_gen_fd
)) < 0) {
404 if (next_ndx
== desired_ndx
) {
413 * main routine for receiver process.
415 * Receiver process runs on the same host as the generator process. */
416 int recv_files(int f_in
, char *local_name
)
421 char *fname
, fbuf
[MAXPATHLEN
];
422 char xname
[MAXPATHLEN
];
423 char fnametmp
[MAXPATHLEN
];
424 char *fnamecmp
, *partialptr
;
425 char fnamecmpbuf
[MAXPATHLEN
];
427 struct file_struct
*file
;
428 struct stats initial_stats
;
429 int itemizing
= am_server
? logfile_format_has_i
: stdout_format_has_i
;
430 enum logcode log_code
= log_before_transfer
? FLOG
: FINFO
;
431 int max_phase
= protocol_version
>= 29 ? 2 : 1;
432 int dflt_perms
= (ACCESSPERMS
& ~orig_umask
);
434 const char *parent_dirname
= "";
439 rprintf(FINFO
, "recv_files(%d) starting\n", cur_flist
->used
);
442 delayed_bits
= bitbag_create(cur_flist
->used
+ 1);
447 /* This call also sets cur_flist. */
448 ndx
= read_ndx_and_attrs(f_in
, &iflags
, &fnamecmp_type
,
450 if (ndx
== NDX_DONE
) {
451 if (inc_recurse
&& first_flist
) {
453 gen_wants_ndx(first_flist
->used
+ first_flist
->ndx_start
);
454 flist_free(first_flist
);
457 } else if (read_batch
&& first_flist
)
458 gen_wants_ndx(first_flist
->used
);
459 if (++phase
> max_phase
)
462 rprintf(FINFO
, "recv_files phase=%d\n", phase
);
463 if (phase
== 2 && delay_updates
)
464 handle_delayed_updates(local_name
);
465 send_msg(MSG_DONE
, "", 0, 0);
469 if (ndx
- cur_flist
->ndx_start
>= 0)
470 file
= cur_flist
->files
[ndx
- cur_flist
->ndx_start
];
472 file
= dir_flist
->files
[cur_flist
->parent_ndx
];
473 fname
= local_name
? local_name
: f_name(file
, fbuf
);
476 rprintf(FINFO
, "recv_files(%s)\n", fname
);
478 #ifdef SUPPORT_XATTRS
479 if (iflags
& ITEM_REPORT_XATTR
&& !dry_run
)
480 recv_xattr_request(file
, f_in
);
483 if (!(iflags
& ITEM_TRANSFER
)) {
484 maybe_log_item(file
, iflags
, itemizing
, xname
);
485 #ifdef SUPPORT_XATTRS
486 if (preserve_xattrs
&& iflags
& ITEM_REPORT_XATTR
&& !dry_run
)
487 set_file_attrs(fname
, file
, NULL
, fname
, 0);
493 "got transfer request in phase 2 [%s]\n",
495 exit_cleanup(RERR_PROTOCOL
);
498 if (file
->flags
& FLAG_FILE_SENT
) {
499 if (csum_length
== SHORT_SUM_LENGTH
) {
500 if (keep_partial
&& !partial_dir
)
501 make_backups
= -make_backups
; /* prevents double backup */
503 sparse_files
= -sparse_files
;
504 append_mode
= -append_mode
;
505 csum_length
= SUM_LENGTH
;
509 if (csum_length
!= SHORT_SUM_LENGTH
) {
510 if (keep_partial
&& !partial_dir
)
511 make_backups
= -make_backups
;
513 sparse_files
= -sparse_files
;
514 append_mode
= -append_mode
;
515 csum_length
= SHORT_SUM_LENGTH
;
520 if (!am_server
&& do_progress
)
521 set_current_file_index(file
, ndx
);
522 stats
.num_transferred_files
++;
523 stats
.total_transferred_size
+= F_LENGTH(file
);
525 cleanup_got_literal
= 0;
527 if (daemon_filter_list
.head
528 && check_filter(&daemon_filter_list
, FLOG
, fname
, 0) < 0) {
529 rprintf(FERROR
, "attempt to hack rsync failed.\n");
530 exit_cleanup(RERR_PROTOCOL
);
533 if (!do_xfers
) { /* log the transfer */
534 log_item(FCLIENT
, file
, &stats
, iflags
, NULL
);
536 discard_receive_data(f_in
, F_LENGTH(file
));
539 if (write_batch
< 0) {
540 log_item(FCLIENT
, file
, &stats
, iflags
, NULL
);
542 discard_receive_data(f_in
, F_LENGTH(file
));
547 if (!(redoing
? we_want_redo(ndx
) : gen_wants_ndx(ndx
))) {
549 "(Skipping batched update for%s \"%s\")\n",
550 redoing
? " resend of" : "",
552 discard_receive_data(f_in
, F_LENGTH(file
));
553 file
->flags
|= FLAG_FILE_SENT
;
558 partialptr
= partial_dir
? partial_dir_fname(fname
) : fname
;
560 if (protocol_version
>= 29) {
561 switch (fnamecmp_type
) {
565 case FNAMECMP_PARTIAL_DIR
:
566 fnamecmp
= partialptr
;
568 case FNAMECMP_BACKUP
:
569 fnamecmp
= get_backup_name(fname
);
573 pathjoin(fnamecmpbuf
, MAXPATHLEN
,
574 file
->dirname
, xname
);
575 fnamecmp
= fnamecmpbuf
;
580 if (fnamecmp_type
>= basis_dir_cnt
) {
582 "invalid basis_dir index: %d.\n",
584 exit_cleanup(RERR_PROTOCOL
);
586 pathjoin(fnamecmpbuf
, sizeof fnamecmpbuf
,
587 basis_dir
[fnamecmp_type
], fname
);
588 fnamecmp
= fnamecmpbuf
;
591 if (!fnamecmp
|| (daemon_filter_list
.head
592 && check_filter(&daemon_filter_list
, FLOG
, fname
, 0) < 0)) {
594 fnamecmp_type
= FNAMECMP_FNAME
;
597 /* Reminder: --inplace && --partial-dir are never
598 * enabled at the same time. */
599 if (inplace
&& make_backups
> 0) {
600 if (!(fnamecmp
= get_backup_name(fname
)))
603 fnamecmp_type
= FNAMECMP_BACKUP
;
604 } else if (partial_dir
&& partialptr
)
605 fnamecmp
= partialptr
;
610 initial_stats
= stats
;
613 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
615 if (fd1
== -1 && protocol_version
< 29) {
616 if (fnamecmp
!= fname
) {
618 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
621 if (fd1
== -1 && basis_dir
[0]) {
622 /* pre-29 allowed only one alternate basis */
623 pathjoin(fnamecmpbuf
, sizeof fnamecmpbuf
,
624 basis_dir
[0], fname
);
625 fnamecmp
= fnamecmpbuf
;
626 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
630 updating_basis_or_equiv
= inplace
631 && (fnamecmp
== fname
|| fnamecmp_type
== FNAMECMP_BACKUP
);
636 } else if (do_fstat(fd1
,&st
) != 0) {
637 rsyserr(FERROR_XFER
, errno
, "fstat %s failed",
638 full_fname(fnamecmp
));
639 discard_receive_data(f_in
, F_LENGTH(file
));
642 send_msg_int(MSG_NO_SEND
, ndx
);
646 if (fd1
!= -1 && S_ISDIR(st
.st_mode
) && fnamecmp
== fname
) {
647 /* this special handling for directories
648 * wouldn't be necessary if robust_rename()
649 * and the underlying robust_unlink could cope
652 rprintf(FERROR_XFER
, "recv_files: %s is a directory\n",
653 full_fname(fnamecmp
));
654 discard_receive_data(f_in
, F_LENGTH(file
));
657 send_msg_int(MSG_NO_SEND
, ndx
);
661 if (fd1
!= -1 && !S_ISREG(st
.st_mode
)) {
666 /* If we're not preserving permissions, change the file-list's
667 * mode based on the local permissions and some heuristics. */
668 if (!preserve_perms
) {
669 int exists
= fd1
!= -1;
671 const char *dn
= file
->dirname
? file
->dirname
: ".";
672 if (parent_dirname
!= dn
673 && strcmp(parent_dirname
, dn
) != 0) {
674 dflt_perms
= default_perms_for_dir(dn
);
678 file
->mode
= dest_mode(file
->mode
, st
.st_mode
,
682 /* We now check to see if we are writing the file "inplace" */
684 fd2
= do_open(fname
, O_WRONLY
|O_CREAT
, 0600);
686 rsyserr(FERROR_XFER
, errno
, "open %s failed",
690 fd2
= open_tmpfile(fnametmp
, fname
, file
);
692 cleanup_set(fnametmp
, partialptr
, file
, fd1
, fd2
);
696 discard_receive_data(f_in
, F_LENGTH(file
));
700 send_msg_int(MSG_NO_SEND
, ndx
);
704 /* log the transfer */
705 if (log_before_transfer
)
706 log_item(FCLIENT
, file
, &initial_stats
, iflags
, NULL
);
707 else if (!am_server
&& verbose
&& do_progress
)
708 rprintf(FINFO
, "%s\n", fname
);
711 recv_ok
= receive_data(f_in
, fnamecmp
, fd1
, st
.st_size
,
712 fname
, fd2
, F_LENGTH(file
));
714 log_item(log_code
, file
, &initial_stats
, iflags
, NULL
);
718 if (close(fd2
) < 0) {
719 rsyserr(FERROR
, errno
, "close failed on %s",
720 full_fname(fnametmp
));
721 exit_cleanup(RERR_FILEIO
);
724 if ((recv_ok
&& (!delay_updates
|| !partialptr
)) || inplace
) {
725 if (partialptr
== fname
)
727 if (!finish_transfer(fname
, fnametmp
, fnamecmp
,
728 partialptr
, file
, recv_ok
, 1))
730 else if (fnamecmp
== partialptr
) {
731 do_unlink(partialptr
);
732 handle_partial_dir(partialptr
, PDIR_DELETE
);
734 } else if (keep_partial
&& partialptr
) {
735 if (!handle_partial_dir(partialptr
, PDIR_CREATE
)) {
737 "Unable to create partial-dir for %s -- discarding %s.\n",
738 local_name
? local_name
: f_name(file
, NULL
),
739 recv_ok
? "completed file" : "partial file");
742 } else if (!finish_transfer(partialptr
, fnametmp
, fnamecmp
, NULL
,
743 file
, recv_ok
, !partial_dir
))
745 else if (delay_updates
&& recv_ok
) {
746 bitbag_set_bit(delayed_bits
, ndx
);
756 file
->flags
|= FLAG_FILE_SENT
;
762 if (remove_source_files
|| inc_recurse
763 || (preserve_hard_links
&& F_IS_HLINKED(file
)))
764 send_msg_int(MSG_SUCCESS
, ndx
);
767 enum logcode msgtype
= redoing
? FERROR_XFER
: FWARNING
;
768 if (msgtype
== FERROR_XFER
|| verbose
) {
769 char *errstr
, *redostr
, *keptstr
;
770 if (!(keep_partial
&& partialptr
) && !inplace
)
771 keptstr
= "discarded";
772 else if (partial_dir
)
773 keptstr
= "put into partial-dir";
775 keptstr
= "retained";
776 if (msgtype
== FERROR_XFER
) {
781 redostr
= read_batch
? " (may try again)"
782 : " (will try again)";
785 "%s: %s failed verification -- update %s%s.\n",
786 errstr
, local_name
? f_name(file
, NULL
) : fname
,
791 flist_ndx_push(&batch_redo_list
, ndx
);
792 send_msg_int(MSG_REDO
, ndx
);
793 file
->flags
|= FLAG_FILE_SENT
;
794 } else if (inc_recurse
)
795 send_msg_int(MSG_NO_SEND
, ndx
);
800 send_msg_int(MSG_NO_SEND
, ndx
);
804 if (make_backups
< 0)
805 make_backups
= -make_backups
;
807 if (phase
== 2 && delay_updates
) /* for protocol_version < 29 */
808 handle_delayed_updates(local_name
);
811 rprintf(FINFO
,"recv_files finished\n");