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;
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, "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 if (append_mode == 2) {
161 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
163 show_progress(offset, total_size);
164 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
168 if (offset < sum.flength) {
169 int32 len = (int32)(sum.flength - offset);
171 show_progress(offset, total_size);
172 sum_update(map_ptr(mapbuf, offset, len), len);
175 offset = sum.flength;
176 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
177 rsyserr(FERROR, errno, "lseek of %s returned %.0f, not %.0f",
178 full_fname(fname), (double)j, (double)offset);
179 exit_cleanup(RERR_FILEIO);
183 while ((i = recv_token(f_in, &data)) != 0) {
185 show_progress(offset, total_size);
189 rprintf(FINFO,"data recv %d at %.0f\n",
193 stats.literal_data += i;
194 cleanup_got_literal = 1;
198 if (fd != -1 && write_file(fd,data,i) != i)
199 goto report_write_error;
205 offset2 = i * (OFF_T)sum.blength;
207 if (i == (int)sum.count-1 && sum.remainder != 0)
210 stats.matched_data += len;
214 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
215 i, (long)len, (double)offset2, (double)offset);
219 map = map_ptr(mapbuf,offset2,len);
222 sum_update(map, len);
225 if (updating_basis) {
226 if (offset == offset2 && fd != -1) {
228 if (flush_write_file(fd) < 0)
229 goto report_write_error;
231 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
232 rsyserr(FERROR, errno,
233 "lseek of %s returned %.0f, not %.0f",
235 (double)pos, (double)offset);
236 exit_cleanup(RERR_FILEIO);
241 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
242 goto report_write_error;
246 if (flush_write_file(fd) < 0)
247 goto report_write_error;
249 #ifdef HAVE_FTRUNCATE
250 if (inplace && fd != -1)
251 ftruncate(fd, offset);
255 end_progress(total_size);
257 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
259 rsyserr(FERROR, errno, "write failed on %s",
261 exit_cleanup(RERR_FILEIO);
264 sum_len = sum_end(file_sum1);
269 read_buf(f_in, file_sum2, sum_len);
271 rprintf(FINFO,"got file_sum\n");
272 if (fd != -1 && memcmp(file_sum1, file_sum2, sum_len) != 0)
278 static void discard_receive_data(int f_in, OFF_T length)
280 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
283 static void handle_delayed_updates(char *local_name)
285 char *fname, *partialptr;
288 for (ndx = -1; (ndx = bitbag_next_bit(delayed_bits, ndx)) >= 0; ) {
289 struct file_struct *file = cur_flist->files[ndx];
290 fname = local_name ? local_name : f_name(file, NULL);
291 if ((partialptr = partial_dir_fname(fname)) != NULL) {
292 if (make_backups > 0 && !make_backup(fname))
295 rprintf(FINFO, "renaming %s to %s\n",
298 /* We don't use robust_rename() here because the
299 * partial-dir must be on the same drive. */
300 if (do_rename(partialptr, fname) < 0) {
301 rsyserr(FERROR, errno,
302 "rename failed for %s (from %s)",
303 full_fname(fname), partialptr);
305 if (remove_source_files
306 || (preserve_hard_links && F_IS_HLINKED(file)))
307 send_msg_int(MSG_SUCCESS, ndx);
308 handle_partial_dir(partialptr, PDIR_DELETE);
314 static int get_next_gen_ndx(int fd, int next_gen_ndx, int desired_ndx)
316 while (next_gen_ndx < desired_ndx) {
317 if (next_gen_ndx >= 0) {
319 "(No batched update for%s \"%s\")\n",
320 redoing ? " resend of" : "",
321 f_name(cur_flist->files[next_gen_ndx], NULL));
323 next_gen_ndx = read_int(fd);
324 if (next_gen_ndx == -1) {
326 next_gen_ndx = first_flist->prev->used + first_flist->prev->ndx_start;
328 next_gen_ndx = cur_flist->used;
335 * main routine for receiver process.
337 * Receiver process runs on the same host as the generator process. */
338 int recv_files(int f_in, char *local_name)
340 int next_gen_ndx = -1;
344 char *fname, fbuf[MAXPATHLEN];
345 char xname[MAXPATHLEN];
346 char fnametmp[MAXPATHLEN];
347 char *fnamecmp, *partialptr;
348 char fnamecmpbuf[MAXPATHLEN];
350 struct file_struct *file;
351 struct stats initial_stats;
352 int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
353 enum logcode log_code = log_before_transfer ? FLOG : FINFO;
354 int max_phase = protocol_version >= 29 ? 2 : 1;
355 int dflt_perms = (ACCESSPERMS & ~orig_umask);
357 const char *parent_dirname = "";
362 rprintf(FINFO, "recv_files(%d) starting\n", cur_flist->used);
365 delayed_bits = bitbag_create(cur_flist->used + 1);
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->used + 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, 0);
396 if (ndx - cur_flist->ndx_start >= 0)
397 file = cur_flist->files[ndx - cur_flist->ndx_start];
399 file = dir_flist->files[cur_flist->parent_ndx];
400 fname = local_name ? local_name : f_name(file, fbuf);
403 rprintf(FINFO, "recv_files(%s)\n", fname);
405 #ifdef SUPPORT_XATTRS
406 if (iflags & ITEM_REPORT_XATTR && !dry_run)
407 recv_xattr_request(file, f_in);
410 if (!(iflags & ITEM_TRANSFER)) {
411 maybe_log_item(file, iflags, itemizing, xname);
412 #ifdef SUPPORT_XATTRS
413 if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && !dry_run)
414 set_file_attrs(fname, file, NULL, fname, 0);
420 "got transfer request in phase 2 [%s]\n",
422 exit_cleanup(RERR_PROTOCOL);
425 if (file->flags & FLAG_FILE_SENT) {
426 if (csum_length == SHORT_SUM_LENGTH) {
427 if (keep_partial && !partial_dir)
428 make_backups = -make_backups; /* prevents double backup */
430 sparse_files = -sparse_files;
431 append_mode = -append_mode;
432 csum_length = SUM_LENGTH;
436 if (csum_length != SHORT_SUM_LENGTH) {
437 if (keep_partial && !partial_dir)
438 make_backups = -make_backups;
440 sparse_files = -sparse_files;
441 append_mode = -append_mode;
442 csum_length = SHORT_SUM_LENGTH;
447 stats.current_file_index = ndx;
448 stats.num_transferred_files++;
449 stats.total_transferred_size += F_LENGTH(file);
450 cleanup_got_literal = 0;
452 if (server_filter_list.head
453 && check_filter(&server_filter_list, fname, 0) < 0) {
454 rprintf(FERROR, "attempt to hack rsync failed.\n");
455 exit_cleanup(RERR_PROTOCOL);
458 if (!do_xfers) { /* log the transfer */
459 log_item(FCLIENT, file, &stats, iflags, NULL);
461 discard_receive_data(f_in, F_LENGTH(file));
464 if (write_batch < 0) {
465 log_item(FINFO, file, &stats, iflags, NULL);
467 discard_receive_data(f_in, F_LENGTH(file));
472 next_gen_ndx = get_next_gen_ndx(batch_gen_fd, next_gen_ndx, ndx);
473 if (ndx < next_gen_ndx) {
475 "(Skipping batched update for \"%s\")\n",
477 discard_receive_data(f_in, F_LENGTH(file));
479 send_msg_int(MSG_NO_SEND, ndx);
485 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
487 if (protocol_version >= 29) {
488 switch (fnamecmp_type) {
492 case FNAMECMP_PARTIAL_DIR:
493 fnamecmp = partialptr;
495 case FNAMECMP_BACKUP:
496 fnamecmp = get_backup_name(fname);
500 pathjoin(fnamecmpbuf, MAXPATHLEN,
501 file->dirname, xname);
502 fnamecmp = fnamecmpbuf;
507 if (fnamecmp_type >= basis_dir_cnt) {
509 "invalid basis_dir index: %d.\n",
511 exit_cleanup(RERR_PROTOCOL);
513 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
514 basis_dir[fnamecmp_type], fname);
515 fnamecmp = fnamecmpbuf;
518 if (!fnamecmp || (server_filter_list.head
519 && check_filter(&server_filter_list, fname, 0) < 0))
522 /* Reminder: --inplace && --partial-dir are never
523 * enabled at the same time. */
524 if (inplace && make_backups > 0) {
525 if (!(fnamecmp = get_backup_name(fname)))
527 } else if (partial_dir && partialptr)
528 fnamecmp = partialptr;
533 initial_stats = stats;
536 fd1 = do_open(fnamecmp, O_RDONLY, 0);
538 if (fd1 == -1 && protocol_version < 29) {
539 if (fnamecmp != fname) {
541 fd1 = do_open(fnamecmp, O_RDONLY, 0);
544 if (fd1 == -1 && basis_dir[0]) {
545 /* pre-29 allowed only one alternate basis */
546 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
547 basis_dir[0], fname);
548 fnamecmp = fnamecmpbuf;
549 fd1 = do_open(fnamecmp, O_RDONLY, 0);
552 updating_basis = inplace && fnamecmp == fname;
557 } else if (do_fstat(fd1,&st) != 0) {
558 rsyserr(FERROR, errno, "fstat %s failed",
559 full_fname(fnamecmp));
560 discard_receive_data(f_in, F_LENGTH(file));
563 send_msg_int(MSG_NO_SEND, ndx);
567 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
568 /* this special handling for directories
569 * wouldn't be necessary if robust_rename()
570 * and the underlying robust_unlink could cope
573 rprintf(FERROR,"recv_files: %s is a directory\n",
574 full_fname(fnamecmp));
575 discard_receive_data(f_in, F_LENGTH(file));
578 send_msg_int(MSG_NO_SEND, ndx);
582 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
587 /* If we're not preserving permissions, change the file-list's
588 * mode based on the local permissions and some heuristics. */
589 if (!preserve_perms) {
590 int exists = fd1 != -1;
592 const char *dn = file->dirname ? file->dirname : ".";
593 if (parent_dirname != dn
594 && strcmp(parent_dirname, dn) != 0) {
595 dflt_perms = default_perms_for_dir(dn);
599 file->mode = dest_mode(file->mode, st.st_mode,
603 /* We now check to see if we are writing the file "inplace" */
605 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
607 rsyserr(FERROR, errno, "open %s failed",
609 discard_receive_data(f_in, F_LENGTH(file));
613 send_msg_int(MSG_NO_SEND, ndx);
617 if (!get_tmpname(fnametmp,fname)) {
618 discard_receive_data(f_in, F_LENGTH(file));
622 send_msg_int(MSG_NO_SEND, ndx);
626 /* we initially set the perms without the
627 * setuid/setgid bits to ensure that there is no race
628 * condition. They are then correctly updated after
629 * the lchown. Thanks to snabb@epipe.fi for pointing
630 * this out. We also set it initially without group
631 * access because of a similar race condition. */
632 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
634 /* in most cases parent directories will already exist
635 * because their information should have been previously
636 * transferred, but that may not be the case with -R */
637 if (fd2 == -1 && relative_paths && errno == ENOENT
638 && create_directory_path(fnametmp) == 0) {
639 /* Get back to name with XXXXXX in it. */
640 get_tmpname(fnametmp, fname);
641 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
644 rsyserr(FERROR, errno, "mkstemp %s failed",
645 full_fname(fnametmp));
646 discard_receive_data(f_in, F_LENGTH(file));
650 send_msg_int(MSG_NO_SEND, ndx);
654 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
657 /* log the transfer */
658 if (log_before_transfer)
659 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
660 else if (!am_server && verbose && do_progress)
661 rprintf(FINFO, "%s\n", fname);
664 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
665 fname, fd2, F_LENGTH(file));
667 log_item(log_code, file, &initial_stats, iflags, NULL);
671 if (close(fd2) < 0) {
672 rsyserr(FERROR, errno, "close failed on %s",
673 full_fname(fnametmp));
674 exit_cleanup(RERR_FILEIO);
677 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
678 char *temp_copy_name;
679 if (partialptr == fname)
680 partialptr = temp_copy_name = NULL;
681 else if (*partial_dir == '/')
682 temp_copy_name = NULL;
684 temp_copy_name = partialptr;
685 finish_transfer(fname, fnametmp, fnamecmp,
686 temp_copy_name, file, recv_ok, 1);
687 if (fnamecmp == partialptr) {
688 do_unlink(partialptr);
689 handle_partial_dir(partialptr, PDIR_DELETE);
691 } else if (keep_partial && partialptr
692 && handle_partial_dir(partialptr, PDIR_CREATE)) {
693 finish_transfer(partialptr, fnametmp, fnamecmp, NULL,
694 file, recv_ok, !partial_dir);
695 if (delay_updates && recv_ok) {
696 bitbag_set_bit(delayed_bits, ndx);
707 if (remove_source_files || inc_recurse
708 || (preserve_hard_links && F_IS_HLINKED(file)))
709 send_msg_int(MSG_SUCCESS, ndx);
710 } else if (!recv_ok) {
711 enum logcode msgtype = redoing || read_batch ? FERROR : FINFO;
712 if (msgtype == FERROR || verbose) {
713 char *errstr, *redostr, *keptstr;
714 if (!(keep_partial && partialptr) && !inplace)
715 keptstr = "discarded";
716 else if (partial_dir)
717 keptstr = "put into partial-dir";
719 keptstr = "retained";
720 if (msgtype == FERROR) {
725 redostr = " (will try again)";
728 "%s: %s failed verification -- update %s%s.\n",
729 errstr, fname, keptstr, redostr);
732 send_msg_int(MSG_REDO, ndx);
733 file->flags |= FLAG_FILE_SENT;
734 } else if (inc_recurse)
735 send_msg_int(MSG_NO_SEND, ndx);
738 if (make_backups < 0)
739 make_backups = -make_backups;
741 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
742 handle_delayed_updates(local_name);
745 rprintf(FINFO,"recv_files finished\n");