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.
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 && ftruncate(fd
, offset
) < 0) {
290 rsyserr(FERROR_XFER
, errno
, "ftruncate failed on %s",
296 end_progress(total_size
);
298 if (fd
!= -1 && offset
> 0 && sparse_end(fd
) != 0) {
300 rsyserr(FERROR_XFER
, errno
, "write failed on %s",
302 exit_cleanup(RERR_FILEIO
);
305 sum_len
= sum_end(file_sum1
);
310 read_buf(f_in
, file_sum2
, sum_len
);
312 rprintf(FINFO
,"got file_sum\n");
313 if (fd
!= -1 && memcmp(file_sum1
, file_sum2
, sum_len
) != 0)
319 static void discard_receive_data(int f_in
, OFF_T length
)
321 receive_data(f_in
, NULL
, -1, 0, NULL
, -1, length
);
324 static void handle_delayed_updates(char *local_name
)
326 char *fname
, *partialptr
;
329 for (ndx
= -1; (ndx
= bitbag_next_bit(delayed_bits
, ndx
)) >= 0; ) {
330 struct file_struct
*file
= cur_flist
->files
[ndx
];
331 fname
= local_name
? local_name
: f_name(file
, NULL
);
332 if ((partialptr
= partial_dir_fname(fname
)) != NULL
) {
333 if (make_backups
> 0 && !make_backup(fname
))
336 rprintf(FINFO
, "renaming %s to %s\n",
339 /* We don't use robust_rename() here because the
340 * partial-dir must be on the same drive. */
341 if (do_rename(partialptr
, fname
) < 0) {
342 rsyserr(FERROR_XFER
, errno
,
343 "rename failed for %s (from %s)",
344 full_fname(fname
), partialptr
);
346 if (remove_source_files
347 || (preserve_hard_links
&& F_IS_HLINKED(file
)))
348 send_msg_int(MSG_SUCCESS
, ndx
);
349 handle_partial_dir(partialptr
, PDIR_DELETE
);
355 static void no_batched_update(int ndx
, BOOL is_redo
)
357 struct file_list
*flist
= flist_for_ndx(ndx
, "no_batched_update");
358 struct file_struct
*file
= flist
->files
[ndx
- flist
->ndx_start
];
360 rprintf(FERROR_XFER
, "(No batched update for%s \"%s\")\n",
361 is_redo
? " resend of" : "", f_name(file
, NULL
));
363 if (inc_recurse
&& !dry_run
)
364 send_msg_int(MSG_NO_SEND
, ndx
);
367 static int we_want_redo(int desired_ndx
)
369 static int redo_ndx
= -1;
371 while (redo_ndx
< desired_ndx
) {
373 no_batched_update(redo_ndx
, True
);
374 if ((redo_ndx
= flist_ndx_pop(&batch_redo_list
)) < 0)
378 if (redo_ndx
== desired_ndx
) {
386 static int gen_wants_ndx(int desired_ndx
)
388 static int next_ndx
= -1;
389 static int done_cnt
= 0;
390 static BOOL got_eof
= False
;
391 int flist_num
= first_flist
->flist_num
;
396 while (next_ndx
< desired_ndx
) {
397 if (inc_recurse
&& flist_num
<= done_cnt
)
400 no_batched_update(next_ndx
, False
);
401 if ((next_ndx
= read_int(batch_gen_fd
)) < 0) {
411 if (next_ndx
== desired_ndx
) {
420 * main routine for receiver process.
422 * Receiver process runs on the same host as the generator process. */
423 int recv_files(int f_in
, char *local_name
)
428 char *fname
, fbuf
[MAXPATHLEN
];
429 char xname
[MAXPATHLEN
];
430 char fnametmp
[MAXPATHLEN
];
431 char *fnamecmp
, *partialptr
;
432 char fnamecmpbuf
[MAXPATHLEN
];
434 struct file_struct
*file
;
435 struct stats initial_stats
;
436 int itemizing
= am_server
? logfile_format_has_i
: stdout_format_has_i
;
437 enum logcode log_code
= log_before_transfer
? FLOG
: FINFO
;
438 int max_phase
= protocol_version
>= 29 ? 2 : 1;
439 int dflt_perms
= (ACCESSPERMS
& ~orig_umask
);
441 const char *parent_dirname
= "";
446 rprintf(FINFO
, "recv_files(%d) starting\n", cur_flist
->used
);
449 delayed_bits
= bitbag_create(cur_flist
->used
+ 1);
454 /* This call also sets cur_flist. */
455 ndx
= read_ndx_and_attrs(f_in
, &iflags
, &fnamecmp_type
,
457 if (ndx
== NDX_DONE
) {
458 if (inc_recurse
&& first_flist
) {
460 gen_wants_ndx(first_flist
->used
+ first_flist
->ndx_start
);
461 flist_free(first_flist
);
464 } else if (read_batch
&& first_flist
)
465 gen_wants_ndx(first_flist
->used
);
466 if (++phase
> max_phase
)
469 rprintf(FINFO
, "recv_files phase=%d\n", phase
);
470 if (phase
== 2 && delay_updates
)
471 handle_delayed_updates(local_name
);
472 send_msg(MSG_DONE
, "", 0, 0);
476 if (ndx
- cur_flist
->ndx_start
>= 0)
477 file
= cur_flist
->files
[ndx
- cur_flist
->ndx_start
];
479 file
= dir_flist
->files
[cur_flist
->parent_ndx
];
480 fname
= local_name
? local_name
: f_name(file
, fbuf
);
483 rprintf(FINFO
, "recv_files(%s)\n", fname
);
485 #ifdef SUPPORT_XATTRS
486 if (iflags
& ITEM_REPORT_XATTR
&& do_xfers
)
487 recv_xattr_request(file
, f_in
);
490 if (!(iflags
& ITEM_TRANSFER
)) {
491 maybe_log_item(file
, iflags
, itemizing
, xname
);
492 #ifdef SUPPORT_XATTRS
493 if (preserve_xattrs
&& iflags
& ITEM_REPORT_XATTR
&& do_xfers
)
494 set_file_attrs(fname
, file
, NULL
, fname
, 0);
500 "got transfer request in phase 2 [%s]\n",
502 exit_cleanup(RERR_PROTOCOL
);
505 if (file
->flags
& FLAG_FILE_SENT
) {
506 if (csum_length
== SHORT_SUM_LENGTH
) {
507 if (keep_partial
&& !partial_dir
)
508 make_backups
= -make_backups
; /* prevents double backup */
510 sparse_files
= -sparse_files
;
511 append_mode
= -append_mode
;
512 csum_length
= SUM_LENGTH
;
516 if (csum_length
!= SHORT_SUM_LENGTH
) {
517 if (keep_partial
&& !partial_dir
)
518 make_backups
= -make_backups
;
520 sparse_files
= -sparse_files
;
521 append_mode
= -append_mode
;
522 csum_length
= SHORT_SUM_LENGTH
;
527 if (!am_server
&& do_progress
)
528 set_current_file_index(file
, ndx
);
529 stats
.num_transferred_files
++;
530 stats
.total_transferred_size
+= F_LENGTH(file
);
532 cleanup_got_literal
= 0;
534 if (daemon_filter_list
.head
535 && check_filter(&daemon_filter_list
, FLOG
, fname
, 0) < 0) {
536 rprintf(FERROR
, "attempt to hack rsync failed.\n");
537 exit_cleanup(RERR_PROTOCOL
);
543 : gen_wants_ndx(ndx
);
546 "(Skipping batched update for%s \"%s\")\n",
547 redoing
? " resend of" : "",
549 discard_receive_data(f_in
, F_LENGTH(file
));
550 file
->flags
|= FLAG_FILE_SENT
;
555 if (!do_xfers
) { /* log the transfer */
556 log_item(FCLIENT
, file
, &stats
, iflags
, NULL
);
558 discard_receive_data(f_in
, F_LENGTH(file
));
561 if (write_batch
< 0) {
562 log_item(FCLIENT
, file
, &stats
, iflags
, NULL
);
564 discard_receive_data(f_in
, F_LENGTH(file
));
568 partialptr
= partial_dir
? partial_dir_fname(fname
) : fname
;
570 if (protocol_version
>= 29) {
571 switch (fnamecmp_type
) {
575 case FNAMECMP_PARTIAL_DIR
:
576 fnamecmp
= partialptr
;
578 case FNAMECMP_BACKUP
:
579 fnamecmp
= get_backup_name(fname
);
583 pathjoin(fnamecmpbuf
, MAXPATHLEN
,
584 file
->dirname
, xname
);
585 fnamecmp
= fnamecmpbuf
;
590 if (fnamecmp_type
>= basis_dir_cnt
) {
592 "invalid basis_dir index: %d.\n",
594 exit_cleanup(RERR_PROTOCOL
);
596 pathjoin(fnamecmpbuf
, sizeof fnamecmpbuf
,
597 basis_dir
[fnamecmp_type
], fname
);
598 fnamecmp
= fnamecmpbuf
;
601 if (!fnamecmp
|| (daemon_filter_list
.head
602 && check_filter(&daemon_filter_list
, FLOG
, fname
, 0) < 0)) {
604 fnamecmp_type
= FNAMECMP_FNAME
;
607 /* Reminder: --inplace && --partial-dir are never
608 * enabled at the same time. */
609 if (inplace
&& make_backups
> 0) {
610 if (!(fnamecmp
= get_backup_name(fname
)))
613 fnamecmp_type
= FNAMECMP_BACKUP
;
614 } else if (partial_dir
&& partialptr
)
615 fnamecmp
= partialptr
;
620 initial_stats
= stats
;
623 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
625 if (fd1
== -1 && protocol_version
< 29) {
626 if (fnamecmp
!= fname
) {
628 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
631 if (fd1
== -1 && basis_dir
[0]) {
632 /* pre-29 allowed only one alternate basis */
633 pathjoin(fnamecmpbuf
, sizeof fnamecmpbuf
,
634 basis_dir
[0], fname
);
635 fnamecmp
= fnamecmpbuf
;
636 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
640 updating_basis_or_equiv
= inplace
641 && (fnamecmp
== fname
|| fnamecmp_type
== FNAMECMP_BACKUP
);
646 } else if (do_fstat(fd1
,&st
) != 0) {
647 rsyserr(FERROR_XFER
, errno
, "fstat %s failed",
648 full_fname(fnamecmp
));
649 discard_receive_data(f_in
, F_LENGTH(file
));
652 send_msg_int(MSG_NO_SEND
, ndx
);
656 if (fd1
!= -1 && S_ISDIR(st
.st_mode
) && fnamecmp
== fname
) {
657 /* this special handling for directories
658 * wouldn't be necessary if robust_rename()
659 * and the underlying robust_unlink could cope
662 rprintf(FERROR_XFER
, "recv_files: %s is a directory\n",
663 full_fname(fnamecmp
));
664 discard_receive_data(f_in
, F_LENGTH(file
));
667 send_msg_int(MSG_NO_SEND
, ndx
);
671 if (fd1
!= -1 && !S_ISREG(st
.st_mode
)) {
676 /* If we're not preserving permissions, change the file-list's
677 * mode based on the local permissions and some heuristics. */
678 if (!preserve_perms
) {
679 int exists
= fd1
!= -1;
681 const char *dn
= file
->dirname
? file
->dirname
: ".";
682 if (parent_dirname
!= dn
683 && strcmp(parent_dirname
, dn
) != 0) {
684 dflt_perms
= default_perms_for_dir(dn
);
688 file
->mode
= dest_mode(file
->mode
, st
.st_mode
,
692 /* We now check to see if we are writing the file "inplace" */
694 fd2
= do_open(fname
, O_WRONLY
|O_CREAT
, 0600);
696 rsyserr(FERROR_XFER
, errno
, "open %s failed",
700 fd2
= open_tmpfile(fnametmp
, fname
, file
);
702 cleanup_set(fnametmp
, partialptr
, file
, fd1
, fd2
);
706 discard_receive_data(f_in
, F_LENGTH(file
));
710 send_msg_int(MSG_NO_SEND
, ndx
);
714 /* log the transfer */
715 if (log_before_transfer
)
716 log_item(FCLIENT
, file
, &initial_stats
, iflags
, NULL
);
717 else if (!am_server
&& verbose
&& do_progress
)
718 rprintf(FINFO
, "%s\n", fname
);
721 recv_ok
= receive_data(f_in
, fnamecmp
, fd1
, st
.st_size
,
722 fname
, fd2
, F_LENGTH(file
));
724 log_item(log_code
, file
, &initial_stats
, iflags
, NULL
);
728 if (close(fd2
) < 0) {
729 rsyserr(FERROR
, errno
, "close failed on %s",
730 full_fname(fnametmp
));
731 exit_cleanup(RERR_FILEIO
);
734 if ((recv_ok
&& (!delay_updates
|| !partialptr
)) || inplace
) {
735 if (partialptr
== fname
)
737 if (!finish_transfer(fname
, fnametmp
, fnamecmp
,
738 partialptr
, file
, recv_ok
, 1))
740 else if (fnamecmp
== partialptr
) {
741 do_unlink(partialptr
);
742 handle_partial_dir(partialptr
, PDIR_DELETE
);
744 } else if (keep_partial
&& partialptr
) {
745 if (!handle_partial_dir(partialptr
, PDIR_CREATE
)) {
747 "Unable to create partial-dir for %s -- discarding %s.\n",
748 local_name
? local_name
: f_name(file
, NULL
),
749 recv_ok
? "completed file" : "partial file");
752 } else if (!finish_transfer(partialptr
, fnametmp
, fnamecmp
, NULL
,
753 file
, recv_ok
, !partial_dir
))
755 else if (delay_updates
&& recv_ok
) {
756 bitbag_set_bit(delayed_bits
, ndx
);
766 file
->flags
|= FLAG_FILE_SENT
;
772 if (remove_source_files
|| inc_recurse
773 || (preserve_hard_links
&& F_IS_HLINKED(file
)))
774 send_msg_int(MSG_SUCCESS
, ndx
);
777 enum logcode msgtype
= redoing
? FERROR_XFER
: FWARNING
;
778 if (msgtype
== FERROR_XFER
|| verbose
) {
779 char *errstr
, *redostr
, *keptstr
;
780 if (!(keep_partial
&& partialptr
) && !inplace
)
781 keptstr
= "discarded";
782 else if (partial_dir
)
783 keptstr
= "put into partial-dir";
785 keptstr
= "retained";
786 if (msgtype
== FERROR_XFER
) {
791 redostr
= read_batch
? " (may try again)"
792 : " (will try again)";
795 "%s: %s failed verification -- update %s%s.\n",
796 errstr
, local_name
? f_name(file
, NULL
) : fname
,
801 flist_ndx_push(&batch_redo_list
, ndx
);
802 send_msg_int(MSG_REDO
, ndx
);
803 file
->flags
|= FLAG_FILE_SENT
;
804 } else if (inc_recurse
)
805 send_msg_int(MSG_NO_SEND
, ndx
);
810 send_msg_int(MSG_NO_SEND
, ndx
);
814 if (make_backups
< 0)
815 make_backups
= -make_backups
;
817 if (phase
== 2 && delay_updates
) /* for protocol_version < 29 */
818 handle_delayed_updates(local_name
);
821 rprintf(FINFO
,"recv_files finished\n");