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 version 2 as
10 * published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
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;
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;
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, 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, "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);
127 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
128 const char *fname, int fd, OFF_T total_size)
130 static char file_sum1[MAX_DIGEST_LEN];
131 static char file_sum2[MAX_DIGEST_LEN];
132 struct map_struct *mapbuf;
133 struct sum_struct sum;
141 read_sum_head(f_in, &sum);
143 if (fd_r >= 0 && size_r > 0) {
144 int32 read_size = MAX(sum.blength * 2, 16*1024);
145 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
147 rprintf(FINFO, "recv mapped %s of size %.0f\n",
148 fname_r, (double)size_r);
153 sum_init(checksum_seed);
155 if (append_mode > 0) {
157 sum.flength = (OFF_T)sum.count * sum.blength;
159 sum.flength -= sum.blength - sum.remainder;
160 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
162 show_progress(offset, total_size);
163 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
167 if (offset < sum.flength) {
168 int32 len = (int32)(sum.flength - offset);
170 show_progress(offset, total_size);
171 sum_update(map_ptr(mapbuf, offset, len), len);
172 offset = sum.flength;
174 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
175 rsyserr(FERROR, errno, "lseek of %s returned %.0f, not %.0f",
176 full_fname(fname), (double)j, (double)offset);
177 exit_cleanup(RERR_FILEIO);
181 while ((i = recv_token(f_in, &data)) != 0) {
183 show_progress(offset, total_size);
187 rprintf(FINFO,"data recv %d at %.0f\n",
191 stats.literal_data += i;
192 cleanup_got_literal = 1;
196 if (fd != -1 && write_file(fd,data,i) != i)
197 goto report_write_error;
203 offset2 = i * (OFF_T)sum.blength;
205 if (i == (int)sum.count-1 && sum.remainder != 0)
208 stats.matched_data += len;
212 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
213 i, (long)len, (double)offset2, (double)offset);
217 map = map_ptr(mapbuf,offset2,len);
220 sum_update(map, len);
223 if (updating_basis) {
224 if (offset == offset2 && fd != -1) {
226 if (flush_write_file(fd) < 0)
227 goto report_write_error;
229 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
230 rsyserr(FERROR, errno,
231 "lseek of %s returned %.0f, not %.0f",
233 (double)pos, (double)offset);
234 exit_cleanup(RERR_FILEIO);
239 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
240 goto report_write_error;
244 if (flush_write_file(fd) < 0)
245 goto report_write_error;
247 #ifdef HAVE_FTRUNCATE
248 if (inplace && fd != -1)
249 ftruncate(fd, offset);
253 end_progress(total_size);
255 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
257 rsyserr(FERROR, errno, "write failed on %s",
259 exit_cleanup(RERR_FILEIO);
262 sum_len = sum_end(file_sum1);
267 read_buf(f_in, file_sum2, sum_len);
269 rprintf(FINFO,"got file_sum\n");
270 if (fd != -1 && memcmp(file_sum1, file_sum2, sum_len) != 0)
276 static void discard_receive_data(int f_in, OFF_T length)
278 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
281 static void handle_delayed_updates(char *local_name)
283 char *fname, *partialptr;
286 for (ndx = -1; (ndx = bitbag_next_bit(delayed_bits, ndx)) >= 0; ) {
287 struct file_struct *file = cur_flist->files[ndx];
288 fname = local_name ? local_name : f_name(file, NULL);
289 if ((partialptr = partial_dir_fname(fname)) != NULL) {
290 if (make_backups > 0 && !make_backup(fname))
293 rprintf(FINFO, "renaming %s to %s\n",
296 /* We don't use robust_rename() here because the
297 * partial-dir must be on the same drive. */
298 if (do_rename(partialptr, fname) < 0) {
299 rsyserr(FERROR, errno,
300 "rename failed for %s (from %s)",
301 full_fname(fname), partialptr);
303 if (remove_source_files
304 || (preserve_hard_links && F_IS_HLINKED(file)))
305 send_msg_int(MSG_SUCCESS, ndx);
306 handle_partial_dir(partialptr, PDIR_DELETE);
312 static int get_next_gen_ndx(int fd, int next_gen_ndx, int desired_ndx)
314 while (next_gen_ndx < desired_ndx) {
315 if (next_gen_ndx >= 0) {
317 "(No batched update for%s \"%s\")\n",
318 redoing ? " resend of" : "",
319 f_name(cur_flist->files[next_gen_ndx], NULL));
321 next_gen_ndx = read_int(fd);
322 if (next_gen_ndx == -1) {
324 next_gen_ndx = first_flist->prev->count + first_flist->prev->ndx_start;
326 next_gen_ndx = cur_flist->count;
333 * main routine for receiver process.
335 * Receiver process runs on the same host as the generator process. */
336 int recv_files(int f_in, char *local_name)
338 int next_gen_ndx = -1;
342 char *fname, fbuf[MAXPATHLEN];
343 char xname[MAXPATHLEN];
344 char fnametmp[MAXPATHLEN];
345 char *fnamecmp, *partialptr;
346 char fnamecmpbuf[MAXPATHLEN];
348 struct file_struct *file;
349 struct stats initial_stats;
350 int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
351 enum logcode log_code = log_before_transfer ? FLOG : FINFO;
352 int max_phase = protocol_version >= 29 ? 2 : 1;
353 int dflt_perms = (ACCESSPERMS & ~orig_umask);
355 const char *parent_dirname = "";
360 rprintf(FINFO, "recv_files(%d) starting\n", cur_flist->count);
363 delayed_bits = bitbag_create(cur_flist->count + 1);
365 updating_basis = inplace;
370 /* This call also sets cur_flist. */
371 ndx = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
373 if (ndx == NDX_DONE) {
374 if (inc_recurse && first_flist) {
375 flist_free(first_flist);
379 if (read_batch && cur_flist) {
380 int high = inc_recurse
381 ? first_flist->prev->count + first_flist->prev->ndx_start
383 get_next_gen_ndx(batch_gen_fd, next_gen_ndx, high);
386 if (++phase > max_phase)
389 rprintf(FINFO, "recv_files phase=%d\n", phase);
390 if (phase == 2 && delay_updates)
391 handle_delayed_updates(local_name);
392 send_msg(MSG_DONE, "", 0);
396 file = cur_flist->files[ndx - cur_flist->ndx_start];
397 fname = local_name ? local_name : f_name(file, fbuf);
400 rprintf(FINFO, "recv_files(%s)\n", fname);
402 #ifdef SUPPORT_XATTRS
403 if (iflags & ITEM_REPORT_XATTR && !dry_run)
404 recv_xattr_request(file, f_in);
407 if (!(iflags & ITEM_TRANSFER)) {
408 maybe_log_item(file, iflags, itemizing, xname);
409 #ifdef SUPPORT_XATTRS
410 if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && !dry_run)
411 set_file_attrs(fname, file, NULL, fname, 0);
417 "got transfer request in phase 2 [%s]\n",
419 exit_cleanup(RERR_PROTOCOL);
422 if (file->flags & FLAG_FILE_SENT) {
423 if (csum_length == SHORT_SUM_LENGTH) {
424 if (keep_partial && !partial_dir)
425 make_backups = -make_backups; /* prevents double backup */
426 append_mode = -append_mode;
427 sparse_files = -sparse_files;
428 csum_length = SUM_LENGTH;
432 if (csum_length != SHORT_SUM_LENGTH) {
433 if (keep_partial && !partial_dir)
434 make_backups = -make_backups;
435 append_mode = -append_mode;
436 sparse_files = -sparse_files;
437 csum_length = SHORT_SUM_LENGTH;
442 stats.current_file_index = ndx;
443 stats.num_transferred_files++;
444 stats.total_transferred_size += F_LENGTH(file);
445 cleanup_got_literal = 0;
447 if (server_filter_list.head
448 && check_filter(&server_filter_list, fname, 0) < 0) {
449 rprintf(FERROR, "attempt to hack rsync failed.\n");
450 exit_cleanup(RERR_PROTOCOL);
453 if (!do_xfers) { /* log the transfer */
454 log_item(FCLIENT, file, &stats, iflags, NULL);
456 discard_receive_data(f_in, F_LENGTH(file));
459 if (write_batch < 0) {
460 log_item(FINFO, file, &stats, iflags, NULL);
462 discard_receive_data(f_in, F_LENGTH(file));
467 next_gen_ndx = get_next_gen_ndx(batch_gen_fd, next_gen_ndx, ndx);
468 if (ndx < next_gen_ndx) {
470 "(Skipping batched update for \"%s\")\n",
472 discard_receive_data(f_in, F_LENGTH(file));
478 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
480 if (protocol_version >= 29) {
481 switch (fnamecmp_type) {
485 case FNAMECMP_PARTIAL_DIR:
486 fnamecmp = partialptr;
488 case FNAMECMP_BACKUP:
489 fnamecmp = get_backup_name(fname);
494 pathjoin(fnamecmpbuf, MAXPATHLEN,
495 file->dirname, xname);
496 fnamecmp = fnamecmpbuf;
502 if (fnamecmp_type >= basis_dir_cnt) {
504 "invalid basis_dir index: %d.\n",
506 exit_cleanup(RERR_PROTOCOL);
508 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
509 basis_dir[fnamecmp_type], fname);
510 fnamecmp = fnamecmpbuf;
513 if (!fnamecmp || (server_filter_list.head
514 && check_filter(&server_filter_list, fname, 0) < 0))
517 /* Reminder: --inplace && --partial-dir are never
518 * enabled at the same time. */
519 if (inplace && make_backups > 0) {
520 if (!(fnamecmp = get_backup_name(fname)))
522 } else if (partial_dir && partialptr)
523 fnamecmp = partialptr;
528 initial_stats = stats;
531 fd1 = do_open(fnamecmp, O_RDONLY, 0);
533 if (fd1 == -1 && protocol_version < 29) {
534 if (fnamecmp != fname) {
536 fd1 = do_open(fnamecmp, O_RDONLY, 0);
539 if (fd1 == -1 && basis_dir[0]) {
540 /* pre-29 allowed only one alternate basis */
541 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
542 basis_dir[0], fname);
543 fnamecmp = fnamecmpbuf;
544 fd1 = do_open(fnamecmp, O_RDONLY, 0);
551 } else if (do_fstat(fd1,&st) != 0) {
552 rsyserr(FERROR, errno, "fstat %s failed",
553 full_fname(fnamecmp));
554 discard_receive_data(f_in, F_LENGTH(file));
559 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
560 /* this special handling for directories
561 * wouldn't be necessary if robust_rename()
562 * and the underlying robust_unlink could cope
565 rprintf(FERROR,"recv_files: %s is a directory\n",
566 full_fname(fnamecmp));
567 discard_receive_data(f_in, F_LENGTH(file));
572 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
577 /* If we're not preserving permissions, change the file-list's
578 * mode based on the local permissions and some heuristics. */
579 if (!preserve_perms) {
580 int exists = fd1 != -1;
582 const char *dn = file->dirname ? file->dirname : ".";
583 if (parent_dirname != dn
584 && strcmp(parent_dirname, dn) != 0) {
585 dflt_perms = default_perms_for_dir(dn);
589 file->mode = dest_mode(file->mode, st.st_mode,
593 /* We now check to see if we are writing the file "inplace" */
595 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
597 rsyserr(FERROR, errno, "open %s failed",
599 discard_receive_data(f_in, F_LENGTH(file));
605 if (!get_tmpname(fnametmp,fname)) {
606 discard_receive_data(f_in, F_LENGTH(file));
612 /* we initially set the perms without the
613 * setuid/setgid bits to ensure that there is no race
614 * condition. They are then correctly updated after
615 * the lchown. Thanks to snabb@epipe.fi for pointing
616 * this out. We also set it initially without group
617 * access because of a similar race condition. */
618 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
620 /* in most cases parent directories will already exist
621 * because their information should have been previously
622 * transferred, but that may not be the case with -R */
623 if (fd2 == -1 && relative_paths && errno == ENOENT
624 && create_directory_path(fnametmp) == 0) {
625 /* Get back to name with XXXXXX in it. */
626 get_tmpname(fnametmp, fname);
627 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
630 rsyserr(FERROR, errno, "mkstemp %s failed",
631 full_fname(fnametmp));
632 discard_receive_data(f_in, F_LENGTH(file));
638 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
641 /* log the transfer */
642 if (log_before_transfer)
643 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
644 else if (!am_server && verbose && do_progress)
645 rprintf(FINFO, "%s\n", fname);
648 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
649 fname, fd2, F_LENGTH(file));
651 log_item(log_code, file, &initial_stats, iflags, NULL);
655 if (close(fd2) < 0) {
656 rsyserr(FERROR, errno, "close failed on %s",
657 full_fname(fnametmp));
658 exit_cleanup(RERR_FILEIO);
661 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
662 char *temp_copy_name;
663 if (partialptr == fname)
664 partialptr = temp_copy_name = NULL;
665 else if (*partial_dir == '/')
666 temp_copy_name = NULL;
668 temp_copy_name = partialptr;
669 finish_transfer(fname, fnametmp, fnamecmp,
670 temp_copy_name, file, recv_ok, 1);
671 if (fnamecmp == partialptr) {
672 do_unlink(partialptr);
673 handle_partial_dir(partialptr, PDIR_DELETE);
675 } else if (keep_partial && partialptr
676 && handle_partial_dir(partialptr, PDIR_CREATE)) {
677 finish_transfer(partialptr, fnametmp, fnamecmp, NULL,
678 file, recv_ok, !partial_dir);
679 if (delay_updates && recv_ok) {
680 bitbag_set_bit(delayed_bits, ndx);
691 if (remove_source_files || inc_recurse
692 || (preserve_hard_links && F_IS_HLINKED(file)))
693 send_msg_int(MSG_SUCCESS, ndx);
694 } else if (!recv_ok) {
695 enum logcode msgtype = redoing || read_batch ? FERROR : FINFO;
696 if (msgtype == FERROR || verbose) {
697 char *errstr, *redostr, *keptstr;
698 if (!(keep_partial && partialptr) && !inplace)
699 keptstr = "discarded";
700 else if (partial_dir)
701 keptstr = "put into partial-dir";
703 keptstr = "retained";
704 if (msgtype == FERROR) {
709 redostr = " (will try again)";
712 "%s: %s failed verification -- update %s%s.\n",
713 errstr, fname, keptstr, redostr);
716 send_msg_int(MSG_REDO, ndx);
717 file->flags |= FLAG_FILE_SENT;
718 } else if (inc_recurse)
719 send_msg_int(MSG_NO_SEND, ndx);
722 if (make_backups < 0)
723 make_backups = -make_backups;
725 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
726 handle_delayed_updates(local_name);
729 rprintf(FINFO,"recv_files finished\n");