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-2007 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 server_filter_list
;
60 static struct bitbag
*delayed_bits
= NULL
;
61 static int phase
= 0, redoing
= 0;
62 /* We're either updating the basis file or an identical copy: */
63 static int updating_basis_or_equiv
;
66 * get_tmpname() - create a tmp filename for a given filename
68 * If a tmpdir is defined, use that as the directory to
69 * put it in. Otherwise, the tmp filename is in the same
70 * directory as the given name. Note that there may be no
71 * directory at all in the given name!
73 * The tmp filename is basically the given filename with a
74 * dot prepended, and .XXXXXX appended (for mkstemp() to
75 * put its unique gunk in). Take care to not exceed
76 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
77 * the basename basically becomes 8 chars longer. In that
78 * case, the original name is shortened sufficiently to
81 * Of course, there's no real reason for the tmp name to
82 * look like the original, except to satisfy us humans.
83 * As long as it's unique, rsync will work.
86 int get_tmpname(char *fnametmp
, const char *fname
)
88 int maxname
, added
, length
= 0;
92 /* Note: this can't overflow, so the return value is safe */
93 length
= strlcpy(fnametmp
, tmpdir
, MAXPATHLEN
- 2);
94 fnametmp
[length
++] = '/';
97 if ((f
= strrchr(fname
, '/')) != NULL
) {
101 /* copy up to and including the slash */
102 strlcpy(fnametmp
, fname
, length
+ 1);
106 fnametmp
[length
++] = '.';
108 /* The maxname value is bufsize, and includes space for the '\0'.
109 * (Note that NAME_MAX get -8 for the leading '.' above.) */
110 maxname
= MIN(MAXPATHLEN
- 7 - length
, NAME_MAX
- 8);
113 rprintf(FERROR_XFER
, "temporary filename too long: %s\n", fname
);
118 added
= strlcpy(fnametmp
+ length
, f
, maxname
);
119 if (added
>= maxname
)
121 memcpy(fnametmp
+ length
+ added
, ".XXXXXX", 8);
126 /* Opens a temporary file for writing.
127 * Success: Writes name into fnametmp, returns fd.
128 * Failure: Clobbers fnametmp, returns -1.
129 * Calling cleanup_set() is the caller's job. */
130 int open_tmpfile(char *fnametmp
, const char *fname
, struct file_struct
*file
)
134 if (!get_tmpname(fnametmp
, fname
))
137 /* We initially set the perms without the setuid/setgid bits or group
138 * access to ensure that there is no race condition. They will be
139 * correctly updated after the right owner and group info is set.
140 * (Thanks to snabb@epipe.fi for pointing this out.) */
141 fd
= do_mkstemp(fnametmp
, file
->mode
& INITACCESSPERMS
);
144 /* In most cases parent directories will already exist because their
145 * information should have been previously transferred, but that may
146 * not be the case with -R */
147 if (fd
== -1 && relative_paths
&& errno
== ENOENT
148 && create_directory_path(fnametmp
) == 0) {
149 /* Get back to name with XXXXXX in it. */
150 get_tmpname(fnametmp
, fname
);
151 fd
= do_mkstemp(fnametmp
, file
->mode
& INITACCESSPERMS
);
156 rsyserr(FERROR_XFER
, errno
, "mkstemp %s failed",
157 full_fname(fnametmp
));
164 static int receive_data(int f_in
, char *fname_r
, int fd_r
, OFF_T size_r
,
165 const char *fname
, int fd
, OFF_T total_size
)
167 static char file_sum1
[MAX_DIGEST_LEN
];
168 static char file_sum2
[MAX_DIGEST_LEN
];
169 struct map_struct
*mapbuf
;
170 struct sum_struct sum
;
178 read_sum_head(f_in
, &sum
);
180 if (fd_r
>= 0 && size_r
> 0) {
181 int32 read_size
= MAX(sum
.blength
* 2, 16*1024);
182 mapbuf
= map_file(fd_r
, size_r
, read_size
, sum
.blength
);
184 rprintf(FINFO
, "recv mapped %s of size %.0f\n",
185 fname_r
, (double)size_r
);
190 sum_init(checksum_seed
);
192 if (append_mode
> 0) {
194 sum
.flength
= (OFF_T
)sum
.count
* sum
.blength
;
196 sum
.flength
-= sum
.blength
- sum
.remainder
;
197 if (append_mode
== 2) {
198 for (j
= CHUNK_SIZE
; j
< sum
.flength
; j
+= CHUNK_SIZE
) {
200 show_progress(offset
, total_size
);
201 sum_update(map_ptr(mapbuf
, offset
, CHUNK_SIZE
),
205 if (offset
< sum
.flength
) {
206 int32 len
= (int32
)(sum
.flength
- offset
);
208 show_progress(offset
, total_size
);
209 sum_update(map_ptr(mapbuf
, offset
, len
), len
);
212 offset
= sum
.flength
;
213 if (fd
!= -1 && (j
= do_lseek(fd
, offset
, SEEK_SET
)) != offset
) {
214 rsyserr(FERROR_XFER
, errno
, "lseek of %s returned %.0f, not %.0f",
215 full_fname(fname
), (double)j
, (double)offset
);
216 exit_cleanup(RERR_FILEIO
);
220 while ((i
= recv_token(f_in
, &data
)) != 0) {
222 show_progress(offset
, total_size
);
226 rprintf(FINFO
,"data recv %d at %.0f\n",
230 stats
.literal_data
+= i
;
231 cleanup_got_literal
= 1;
235 if (fd
!= -1 && write_file(fd
,data
,i
) != i
)
236 goto report_write_error
;
242 offset2
= i
* (OFF_T
)sum
.blength
;
244 if (i
== (int)sum
.count
-1 && sum
.remainder
!= 0)
247 stats
.matched_data
+= len
;
251 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
252 i
, (long)len
, (double)offset2
, (double)offset
);
256 map
= map_ptr(mapbuf
,offset2
,len
);
259 sum_update(map
, len
);
262 if (updating_basis_or_equiv
) {
263 if (offset
== offset2
&& fd
!= -1) {
265 if (flush_write_file(fd
) < 0)
266 goto report_write_error
;
268 if ((pos
= do_lseek(fd
, len
, SEEK_CUR
)) != offset
) {
269 rsyserr(FERROR_XFER
, errno
,
270 "lseek of %s returned %.0f, not %.0f",
272 (double)pos
, (double)offset
);
273 exit_cleanup(RERR_FILEIO
);
278 if (fd
!= -1 && map
&& write_file(fd
, map
, len
) != (int)len
)
279 goto report_write_error
;
283 if (flush_write_file(fd
) < 0)
284 goto report_write_error
;
286 #ifdef HAVE_FTRUNCATE
287 if (inplace
&& fd
!= -1)
288 ftruncate(fd
, offset
);
292 end_progress(total_size
);
294 if (fd
!= -1 && offset
> 0 && sparse_end(fd
) != 0) {
296 rsyserr(FERROR_XFER
, errno
, "write failed on %s",
298 exit_cleanup(RERR_FILEIO
);
301 sum_len
= sum_end(file_sum1
);
306 read_buf(f_in
, file_sum2
, sum_len
);
308 rprintf(FINFO
,"got file_sum\n");
309 if (fd
!= -1 && memcmp(file_sum1
, file_sum2
, sum_len
) != 0)
315 static void discard_receive_data(int f_in
, OFF_T length
)
317 receive_data(f_in
, NULL
, -1, 0, NULL
, -1, length
);
320 static void handle_delayed_updates(char *local_name
)
322 char *fname
, *partialptr
;
325 for (ndx
= -1; (ndx
= bitbag_next_bit(delayed_bits
, ndx
)) >= 0; ) {
326 struct file_struct
*file
= cur_flist
->files
[ndx
];
327 fname
= local_name
? local_name
: f_name(file
, NULL
);
328 if ((partialptr
= partial_dir_fname(fname
)) != NULL
) {
329 if (make_backups
> 0 && !make_backup(fname
))
332 rprintf(FINFO
, "renaming %s to %s\n",
335 /* We don't use robust_rename() here because the
336 * partial-dir must be on the same drive. */
337 if (do_rename(partialptr
, fname
) < 0) {
338 rsyserr(FERROR_XFER
, errno
,
339 "rename failed for %s (from %s)",
340 full_fname(fname
), partialptr
);
342 if (remove_source_files
343 || (preserve_hard_links
&& F_IS_HLINKED(file
)))
344 send_msg_int(MSG_SUCCESS
, ndx
);
345 handle_partial_dir(partialptr
, PDIR_DELETE
);
351 static int get_next_gen_ndx(int fd
, int next_gen_ndx
, int desired_ndx
)
353 while (next_gen_ndx
< desired_ndx
) {
354 if (next_gen_ndx
>= 0) {
355 struct file_struct
*file
= cur_flist
->files
[next_gen_ndx
];
357 "(No batched update for%s \"%s\")\n",
358 file
->flags
& FLAG_FILE_SENT
? " resend of" : "",
361 next_gen_ndx
= read_int(fd
);
362 if (next_gen_ndx
== -1) {
364 next_gen_ndx
= first_flist
->prev
->used
+ first_flist
->prev
->ndx_start
;
366 next_gen_ndx
= cur_flist
->used
;
373 * main routine for receiver process.
375 * Receiver process runs on the same host as the generator process. */
376 int recv_files(int f_in
, char *local_name
)
378 int next_gen_ndx
= -1;
382 char *fname
, fbuf
[MAXPATHLEN
];
383 char xname
[MAXPATHLEN
];
384 char fnametmp
[MAXPATHLEN
];
385 char *fnamecmp
, *partialptr
;
386 char fnamecmpbuf
[MAXPATHLEN
];
388 struct file_struct
*file
;
389 struct stats initial_stats
;
390 int itemizing
= am_server
? logfile_format_has_i
: stdout_format_has_i
;
391 enum logcode log_code
= log_before_transfer
? FLOG
: FINFO
;
392 int max_phase
= protocol_version
>= 29 ? 2 : 1;
393 int dflt_perms
= (ACCESSPERMS
& ~orig_umask
);
395 const char *parent_dirname
= "";
400 rprintf(FINFO
, "recv_files(%d) starting\n", cur_flist
->used
);
403 delayed_bits
= bitbag_create(cur_flist
->used
+ 1);
408 /* This call also sets cur_flist. */
409 ndx
= read_ndx_and_attrs(f_in
, &iflags
, &fnamecmp_type
,
411 if (ndx
== NDX_DONE
) {
412 if (inc_recurse
&& first_flist
) {
413 flist_free(first_flist
);
417 if (read_batch
&& cur_flist
) {
418 int high
= inc_recurse
419 ? first_flist
->prev
->used
+ first_flist
->prev
->ndx_start
421 get_next_gen_ndx(batch_gen_fd
, next_gen_ndx
, high
);
424 if (++phase
> max_phase
)
427 rprintf(FINFO
, "recv_files phase=%d\n", phase
);
428 if (phase
== 2 && delay_updates
)
429 handle_delayed_updates(local_name
);
430 send_msg(MSG_DONE
, "", 0, 0);
434 if (ndx
- cur_flist
->ndx_start
>= 0)
435 file
= cur_flist
->files
[ndx
- cur_flist
->ndx_start
];
437 file
= dir_flist
->files
[cur_flist
->parent_ndx
];
438 fname
= local_name
? local_name
: f_name(file
, fbuf
);
441 rprintf(FINFO
, "recv_files(%s)\n", fname
);
443 #ifdef SUPPORT_XATTRS
444 if (iflags
& ITEM_REPORT_XATTR
&& !dry_run
)
445 recv_xattr_request(file
, f_in
);
448 if (!(iflags
& ITEM_TRANSFER
)) {
449 maybe_log_item(file
, iflags
, itemizing
, xname
);
450 #ifdef SUPPORT_XATTRS
451 if (preserve_xattrs
&& iflags
& ITEM_REPORT_XATTR
&& !dry_run
)
452 set_file_attrs(fname
, file
, NULL
, fname
, 0);
458 "got transfer request in phase 2 [%s]\n",
460 exit_cleanup(RERR_PROTOCOL
);
463 if (file
->flags
& FLAG_FILE_SENT
) {
464 if (csum_length
== SHORT_SUM_LENGTH
) {
465 if (keep_partial
&& !partial_dir
)
466 make_backups
= -make_backups
; /* prevents double backup */
468 sparse_files
= -sparse_files
;
469 append_mode
= -append_mode
;
470 csum_length
= SUM_LENGTH
;
474 if (csum_length
!= SHORT_SUM_LENGTH
) {
475 if (keep_partial
&& !partial_dir
)
476 make_backups
= -make_backups
;
478 sparse_files
= -sparse_files
;
479 append_mode
= -append_mode
;
480 csum_length
= SHORT_SUM_LENGTH
;
485 if (!am_server
&& do_progress
)
486 set_current_file_index(file
, ndx
);
487 stats
.num_transferred_files
++;
488 stats
.total_transferred_size
+= F_LENGTH(file
);
490 cleanup_got_literal
= 0;
492 if (server_filter_list
.head
493 && check_filter(&server_filter_list
, fname
, 0) < 0) {
494 rprintf(FERROR
, "attempt to hack rsync failed.\n");
495 exit_cleanup(RERR_PROTOCOL
);
498 if (!do_xfers
) { /* log the transfer */
499 log_item(FCLIENT
, file
, &stats
, iflags
, NULL
);
501 discard_receive_data(f_in
, F_LENGTH(file
));
504 if (write_batch
< 0) {
505 log_item(FINFO
, file
, &stats
, iflags
, NULL
);
507 discard_receive_data(f_in
, F_LENGTH(file
));
512 next_gen_ndx
= get_next_gen_ndx(batch_gen_fd
, next_gen_ndx
, ndx
);
513 if (ndx
< next_gen_ndx
) {
515 "(Skipping batched update for \"%s\")\n",
517 discard_receive_data(f_in
, F_LENGTH(file
));
519 send_msg_int(MSG_NO_SEND
, ndx
);
525 partialptr
= partial_dir
? partial_dir_fname(fname
) : fname
;
527 if (protocol_version
>= 29) {
528 switch (fnamecmp_type
) {
532 case FNAMECMP_PARTIAL_DIR
:
533 fnamecmp
= partialptr
;
535 case FNAMECMP_BACKUP
:
536 fnamecmp
= get_backup_name(fname
);
540 pathjoin(fnamecmpbuf
, MAXPATHLEN
,
541 file
->dirname
, xname
);
542 fnamecmp
= fnamecmpbuf
;
547 if (fnamecmp_type
>= basis_dir_cnt
) {
549 "invalid basis_dir index: %d.\n",
551 exit_cleanup(RERR_PROTOCOL
);
553 pathjoin(fnamecmpbuf
, sizeof fnamecmpbuf
,
554 basis_dir
[fnamecmp_type
], fname
);
555 fnamecmp
= fnamecmpbuf
;
558 if (!fnamecmp
|| (server_filter_list
.head
559 && check_filter(&server_filter_list
, fname
, 0) < 0)) {
561 fnamecmp_type
= FNAMECMP_FNAME
;
564 /* Reminder: --inplace && --partial-dir are never
565 * enabled at the same time. */
566 if (inplace
&& make_backups
> 0) {
567 if (!(fnamecmp
= get_backup_name(fname
)))
570 fnamecmp_type
= FNAMECMP_BACKUP
;
571 } else if (partial_dir
&& partialptr
)
572 fnamecmp
= partialptr
;
577 initial_stats
= stats
;
580 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
582 if (fd1
== -1 && protocol_version
< 29) {
583 if (fnamecmp
!= fname
) {
585 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
588 if (fd1
== -1 && basis_dir
[0]) {
589 /* pre-29 allowed only one alternate basis */
590 pathjoin(fnamecmpbuf
, sizeof fnamecmpbuf
,
591 basis_dir
[0], fname
);
592 fnamecmp
= fnamecmpbuf
;
593 fd1
= do_open(fnamecmp
, O_RDONLY
, 0);
597 updating_basis_or_equiv
= inplace
598 && (fnamecmp
== fname
|| fnamecmp_type
== FNAMECMP_BACKUP
);
603 } else if (do_fstat(fd1
,&st
) != 0) {
604 rsyserr(FERROR_XFER
, errno
, "fstat %s failed",
605 full_fname(fnamecmp
));
606 discard_receive_data(f_in
, F_LENGTH(file
));
609 send_msg_int(MSG_NO_SEND
, ndx
);
613 if (fd1
!= -1 && S_ISDIR(st
.st_mode
) && fnamecmp
== fname
) {
614 /* this special handling for directories
615 * wouldn't be necessary if robust_rename()
616 * and the underlying robust_unlink could cope
619 rprintf(FERROR_XFER
, "recv_files: %s is a directory\n",
620 full_fname(fnamecmp
));
621 discard_receive_data(f_in
, F_LENGTH(file
));
624 send_msg_int(MSG_NO_SEND
, ndx
);
628 if (fd1
!= -1 && !S_ISREG(st
.st_mode
)) {
633 /* If we're not preserving permissions, change the file-list's
634 * mode based on the local permissions and some heuristics. */
635 if (!preserve_perms
) {
636 int exists
= fd1
!= -1;
638 const char *dn
= file
->dirname
? file
->dirname
: ".";
639 if (parent_dirname
!= dn
640 && strcmp(parent_dirname
, dn
) != 0) {
641 dflt_perms
= default_perms_for_dir(dn
);
645 file
->mode
= dest_mode(file
->mode
, st
.st_mode
,
649 /* We now check to see if we are writing the file "inplace" */
651 fd2
= do_open(fname
, O_WRONLY
|O_CREAT
, 0600);
653 rsyserr(FERROR_XFER
, errno
, "open %s failed",
657 fd2
= open_tmpfile(fnametmp
, fname
, file
);
659 cleanup_set(fnametmp
, partialptr
, file
, fd1
, fd2
);
663 discard_receive_data(f_in
, F_LENGTH(file
));
667 send_msg_int(MSG_NO_SEND
, ndx
);
671 /* log the transfer */
672 if (log_before_transfer
)
673 log_item(FCLIENT
, file
, &initial_stats
, iflags
, NULL
);
674 else if (!am_server
&& verbose
&& do_progress
)
675 rprintf(FINFO
, "%s\n", fname
);
678 recv_ok
= receive_data(f_in
, fnamecmp
, fd1
, st
.st_size
,
679 fname
, fd2
, F_LENGTH(file
));
681 log_item(log_code
, file
, &initial_stats
, iflags
, NULL
);
685 if (close(fd2
) < 0) {
686 rsyserr(FERROR
, errno
, "close failed on %s",
687 full_fname(fnametmp
));
688 exit_cleanup(RERR_FILEIO
);
691 if ((recv_ok
&& (!delay_updates
|| !partialptr
)) || inplace
) {
692 if (partialptr
== fname
)
694 if (!finish_transfer(fname
, fnametmp
, fnamecmp
,
695 partialptr
, file
, recv_ok
, 1))
697 else if (fnamecmp
== partialptr
) {
698 do_unlink(partialptr
);
699 handle_partial_dir(partialptr
, PDIR_DELETE
);
701 } else if (keep_partial
&& partialptr
702 && handle_partial_dir(partialptr
, PDIR_CREATE
)) {
703 if (!finish_transfer(partialptr
, fnametmp
, fnamecmp
, NULL
,
704 file
, recv_ok
, !partial_dir
))
706 else if (delay_updates
&& recv_ok
) {
707 bitbag_set_bit(delayed_bits
, ndx
);
719 if (remove_source_files
|| inc_recurse
720 || (preserve_hard_links
&& F_IS_HLINKED(file
)))
721 send_msg_int(MSG_SUCCESS
, ndx
);
724 enum logcode msgtype
= redoing
? FERROR_XFER
: FWARNING
;
725 if (msgtype
== FERROR_XFER
|| verbose
) {
726 char *errstr
, *redostr
, *keptstr
;
727 if (!(keep_partial
&& partialptr
) && !inplace
)
728 keptstr
= "discarded";
729 else if (partial_dir
)
730 keptstr
= "put into partial-dir";
732 keptstr
= "retained";
733 if (msgtype
== FERROR_XFER
) {
738 redostr
= read_batch
? " (may try again)"
739 : " (will try again)";
742 "%s: %s failed verification -- update %s%s.\n",
743 errstr
, local_name
? f_name(file
, NULL
) : fname
,
747 send_msg_int(MSG_REDO
, ndx
);
748 file
->flags
|= FLAG_FILE_SENT
;
749 } else if (inc_recurse
)
750 send_msg_int(MSG_NO_SEND
, ndx
);
755 send_msg_int(MSG_NO_SEND
, ndx
);
759 if (make_backups
< 0)
760 make_backups
= -make_backups
;
762 if (phase
== 2 && delay_updates
) /* for protocol_version < 29 */
763 handle_delayed_updates(local_name
);
766 rprintf(FINFO
,"recv_files finished\n");