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, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
28 extern int do_progress;
29 extern int incremental;
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 basis_dir_cnt;
42 extern int make_backups;
43 extern int cleanup_got_literal;
44 extern int remove_source_files;
45 extern int append_mode;
46 extern int sparse_files;
47 extern int keep_partial;
48 extern int checksum_seed;
50 extern int delay_updates;
51 extern struct stats stats;
52 extern char *stdout_format;
54 extern char *partial_dir;
55 extern char *basis_dir[];
56 extern struct file_list *cur_flist, *first_flist;
57 extern struct filter_list_struct server_filter_list;
59 static struct bitbag *delayed_bits = NULL;
61 /* We're either updating the basis file or an identical copy: */
62 static int updating_basis;
65 * get_tmpname() - create a tmp filename for a given filename
67 * If a tmpdir is defined, use that as the directory to
68 * put it in. Otherwise, the tmp filename is in the same
69 * directory as the given name. Note that there may be no
70 * directory at all in the given name!
72 * The tmp filename is basically the given filename with a
73 * dot prepended, and .XXXXXX appended (for mkstemp() to
74 * put its unique gunk in). Take care to not exceed
75 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
76 * the basename basically becomes 8 chars longer. In that
77 * case, the original name is shortened sufficiently to
80 * Of course, there's no real reason for the tmp name to
81 * look like the original, except to satisfy us humans.
82 * As long as it's unique, rsync will work.
85 int get_tmpname(char *fnametmp, char *fname)
87 int maxname, added, length = 0;
91 /* Note: this can't overflow, so the return value is safe */
92 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
93 fnametmp[length++] = '/';
96 if ((f = strrchr(fname, '/')) != NULL) {
100 /* copy up to and including the slash */
101 strlcpy(fnametmp, fname, length + 1);
105 fnametmp[length++] = '.';
107 /* The maxname value is bufsize, and includes space for the '\0'.
108 * (Note that NAME_MAX get -8 for the leading '.' above.) */
109 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
112 rprintf(FERROR, "temporary filename too long: %s\n", fname);
117 added = strlcpy(fnametmp + length, f, maxname);
118 if (added >= maxname)
120 memcpy(fnametmp + length + added, ".XXXXXX", 8);
126 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
127 char *fname, int fd, OFF_T total_size)
129 static char file_sum1[MD4_SUM_LENGTH];
130 static char file_sum2[MD4_SUM_LENGTH];
131 struct map_struct *mapbuf;
132 struct sum_struct sum;
140 read_sum_head(f_in, &sum);
142 if (fd_r >= 0 && size_r > 0) {
143 int32 read_size = MAX(sum.blength * 2, 16*1024);
144 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
146 rprintf(FINFO, "recv mapped %s of size %.0f\n",
147 fname_r, (double)size_r);
152 sum_init(checksum_seed);
154 if (append_mode > 0) {
156 sum.flength = (OFF_T)sum.count * sum.blength;
158 sum.flength -= sum.blength - sum.remainder;
159 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
161 show_progress(offset, total_size);
162 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
166 if (offset < sum.flength) {
167 int32 len = (int32)(sum.flength - offset);
169 show_progress(offset, total_size);
170 sum_update(map_ptr(mapbuf, offset, len), len);
171 offset = sum.flength;
173 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
174 rsyserr(FERROR, errno, "lseek of %s returned %.0f, not %.0f",
175 full_fname(fname), (double)j, (double)offset);
176 exit_cleanup(RERR_FILEIO);
180 while ((i = recv_token(f_in, &data)) != 0) {
182 show_progress(offset, total_size);
186 rprintf(FINFO,"data recv %d at %.0f\n",
190 stats.literal_data += i;
191 cleanup_got_literal = 1;
195 if (fd != -1 && write_file(fd,data,i) != i)
196 goto report_write_error;
202 offset2 = i * (OFF_T)sum.blength;
204 if (i == (int)sum.count-1 && sum.remainder != 0)
207 stats.matched_data += len;
211 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
212 i, (long)len, (double)offset2, (double)offset);
216 map = map_ptr(mapbuf,offset2,len);
219 sum_update(map, len);
222 if (updating_basis) {
223 if (offset == offset2 && fd != -1) {
225 if (flush_write_file(fd) < 0)
226 goto report_write_error;
228 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
229 rsyserr(FERROR, errno,
230 "lseek of %s returned %.0f, not %.0f",
232 (double)pos, (double)offset);
233 exit_cleanup(RERR_FILEIO);
238 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
239 goto report_write_error;
243 if (flush_write_file(fd) < 0)
244 goto report_write_error;
246 #ifdef HAVE_FTRUNCATE
247 if (inplace && fd != -1)
248 ftruncate(fd, offset);
252 end_progress(total_size);
254 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
256 rsyserr(FERROR, errno, "write failed on %s",
258 exit_cleanup(RERR_FILEIO);
266 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
268 rprintf(FINFO,"got file_sum\n");
269 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
275 static void discard_receive_data(int f_in, OFF_T length)
277 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
280 static void handle_delayed_updates(char *local_name)
282 char *fname, *partialptr;
285 for (ndx = -1; (ndx = bitbag_next_bit(delayed_bits, ndx)) >= 0; ) {
286 struct file_struct *file = cur_flist->files[ndx];
287 fname = local_name ? local_name : f_name(file, NULL);
288 if ((partialptr = partial_dir_fname(fname)) != NULL) {
289 if (make_backups > 0 && !make_backup(fname))
292 rprintf(FINFO, "renaming %s to %s\n",
295 /* We don't use robust_rename() here because the
296 * partial-dir must be on the same drive. */
297 if (do_rename(partialptr, fname) < 0) {
298 rsyserr(FERROR, errno,
299 "rename failed for %s (from %s)",
300 full_fname(fname), partialptr);
302 if (remove_source_files
303 || (preserve_hard_links && F_IS_HLINKED(file)))
304 send_msg_int(MSG_SUCCESS, ndx);
305 handle_partial_dir(partialptr, PDIR_DELETE);
311 static int get_next_gen_ndx(int fd, int next_gen_ndx, int desired_ndx)
313 while (next_gen_ndx < desired_ndx) {
314 if (next_gen_ndx >= 0) {
316 "(No batched update for%s \"%s\")\n",
317 phase ? " resend of" : "",
318 f_name(cur_flist->files[next_gen_ndx], NULL));
320 next_gen_ndx = read_int(fd);
321 if (next_gen_ndx == -1) {
323 next_gen_ndx = first_flist->prev->count + first_flist->prev->ndx_start;
325 next_gen_ndx = cur_flist->count;
332 * main routine for receiver process.
334 * Receiver process runs on the same host as the generator process. */
335 int recv_files(int f_in, char *local_name)
337 int next_gen_ndx = -1;
341 char *fname, fbuf[MAXPATHLEN];
342 char xname[MAXPATHLEN];
343 char fnametmp[MAXPATHLEN];
344 char *fnamecmp, *partialptr;
345 char fnamecmpbuf[MAXPATHLEN];
347 struct file_struct *file;
348 struct stats initial_stats;
349 int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
350 enum logcode log_code = log_before_transfer ? FLOG : FINFO;
351 int max_phase = protocol_version >= 29 ? 2 : 1;
355 rprintf(FINFO, "recv_files(%d) starting\n", cur_flist->count);
358 delayed_bits = bitbag_create(cur_flist->count + 1);
360 updating_basis = inplace;
365 /* This call also sets cur_flist. */
366 ndx = read_ndx_and_attrs(f_in, -1, &iflags,
367 &fnamecmp_type, xname, &xlen);
368 if (ndx == NDX_DONE) {
369 if (incremental && first_flist) {
370 flist_free(first_flist);
374 if (read_batch && cur_flist) {
375 int high = incremental
376 ? first_flist->prev->count + first_flist->prev->ndx_start
378 get_next_gen_ndx(batch_gen_fd, next_gen_ndx, high);
381 if (++phase > max_phase)
384 rprintf(FINFO, "recv_files phase=%d\n", phase);
385 if (phase == 2 && delay_updates)
386 handle_delayed_updates(local_name);
387 send_msg(MSG_DONE, "", 0);
391 file = cur_flist->files[ndx - cur_flist->ndx_start];
392 fname = local_name ? local_name : f_name(file, fbuf);
395 rprintf(FINFO, "recv_files(%s)\n", fname);
397 if (!(iflags & ITEM_TRANSFER)) {
398 maybe_log_item(file, iflags, itemizing, xname);
403 "got transfer request in phase 2 [%s]\n",
405 exit_cleanup(RERR_PROTOCOL);
408 if (file->flags & FLAG_FILE_SENT) {
409 if (csum_length == SHORT_SUM_LENGTH) {
410 if (keep_partial && !partial_dir)
411 make_backups = -make_backups; /* prevents double backup */
412 append_mode = -append_mode;
413 sparse_files = -sparse_files;
414 csum_length = SUM_LENGTH;
417 if (csum_length != SHORT_SUM_LENGTH) {
418 if (keep_partial && !partial_dir)
419 make_backups = -make_backups;
420 append_mode = -append_mode;
421 sparse_files = -sparse_files;
422 csum_length = SHORT_SUM_LENGTH;
426 stats.current_file_index = ndx;
427 stats.num_transferred_files++;
428 stats.total_transferred_size += F_LENGTH(file);
429 cleanup_got_literal = 0;
431 if (server_filter_list.head
432 && check_filter(&server_filter_list, fname, 0) < 0) {
433 rprintf(FERROR, "attempt to hack rsync failed.\n");
434 exit_cleanup(RERR_PROTOCOL);
437 if (!do_xfers) { /* log the transfer */
438 log_item(FCLIENT, file, &stats, iflags, NULL);
440 discard_receive_data(f_in, F_LENGTH(file));
443 if (write_batch < 0) {
444 log_item(FINFO, file, &stats, iflags, NULL);
446 discard_receive_data(f_in, F_LENGTH(file));
451 next_gen_ndx = get_next_gen_ndx(batch_gen_fd, next_gen_ndx, ndx);
452 if (ndx < next_gen_ndx) {
454 "(Skipping batched update for \"%s\")\n",
456 discard_receive_data(f_in, F_LENGTH(file));
462 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
464 if (protocol_version >= 29) {
465 switch (fnamecmp_type) {
469 case FNAMECMP_PARTIAL_DIR:
470 fnamecmp = partialptr;
472 case FNAMECMP_BACKUP:
473 fnamecmp = get_backup_name(fname);
478 pathjoin(fnamecmpbuf, MAXPATHLEN,
479 file->dirname, xname);
480 fnamecmp = fnamecmpbuf;
486 if (fnamecmp_type >= basis_dir_cnt) {
488 "invalid basis_dir index: %d.\n",
490 exit_cleanup(RERR_PROTOCOL);
492 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
493 basis_dir[fnamecmp_type], fname);
494 fnamecmp = fnamecmpbuf;
497 if (!fnamecmp || (server_filter_list.head
498 && check_filter(&server_filter_list, fname, 0) < 0))
501 /* Reminder: --inplace && --partial-dir are never
502 * enabled at the same time. */
503 if (inplace && make_backups > 0) {
504 if (!(fnamecmp = get_backup_name(fname)))
506 } else if (partial_dir && partialptr)
507 fnamecmp = partialptr;
512 initial_stats = stats;
515 fd1 = do_open(fnamecmp, O_RDONLY, 0);
517 if (fd1 == -1 && protocol_version < 29) {
518 if (fnamecmp != fname) {
520 fd1 = do_open(fnamecmp, O_RDONLY, 0);
523 if (fd1 == -1 && basis_dir[0]) {
524 /* pre-29 allowed only one alternate basis */
525 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
526 basis_dir[0], fname);
527 fnamecmp = fnamecmpbuf;
528 fd1 = do_open(fnamecmp, O_RDONLY, 0);
535 } else if (do_fstat(fd1,&st) != 0) {
536 rsyserr(FERROR, errno, "fstat %s failed",
537 full_fname(fnamecmp));
538 discard_receive_data(f_in, F_LENGTH(file));
543 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
544 /* this special handling for directories
545 * wouldn't be necessary if robust_rename()
546 * and the underlying robust_unlink could cope
549 rprintf(FERROR,"recv_files: %s is a directory\n",
550 full_fname(fnamecmp));
551 discard_receive_data(f_in, F_LENGTH(file));
556 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
561 /* If we're not preserving permissions, change the file-list's
562 * mode based on the local permissions and some heuristics. */
563 if (!preserve_perms) {
564 int exists = fd1 != -1;
565 file->mode = dest_mode(file->mode, st.st_mode, exists);
568 /* We now check to see if we are writing the file "inplace" */
570 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
572 rsyserr(FERROR, errno, "open %s failed",
574 discard_receive_data(f_in, F_LENGTH(file));
580 if (!get_tmpname(fnametmp,fname)) {
581 discard_receive_data(f_in, F_LENGTH(file));
587 /* we initially set the perms without the
588 * setuid/setgid bits to ensure that there is no race
589 * condition. They are then correctly updated after
590 * the lchown. Thanks to snabb@epipe.fi for pointing
591 * this out. We also set it initially without group
592 * access because of a similar race condition. */
593 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
595 /* in most cases parent directories will already exist
596 * because their information should have been previously
597 * transferred, but that may not be the case with -R */
598 if (fd2 == -1 && relative_paths && errno == ENOENT
599 && create_directory_path(fnametmp) == 0) {
600 /* Get back to name with XXXXXX in it. */
601 get_tmpname(fnametmp, fname);
602 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
605 rsyserr(FERROR, errno, "mkstemp %s failed",
606 full_fname(fnametmp));
607 discard_receive_data(f_in, F_LENGTH(file));
613 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
616 /* log the transfer */
617 if (log_before_transfer)
618 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
619 else if (!am_server && verbose && do_progress)
620 rprintf(FINFO, "%s\n", fname);
623 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
624 fname, fd2, F_LENGTH(file));
626 log_item(log_code, file, &initial_stats, iflags, NULL);
630 if (close(fd2) < 0) {
631 rsyserr(FERROR, errno, "close failed on %s",
632 full_fname(fnametmp));
633 exit_cleanup(RERR_FILEIO);
636 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
637 char *temp_copy_name;
638 if (partialptr == fname)
639 partialptr = temp_copy_name = NULL;
640 else if (*partial_dir == '/')
641 temp_copy_name = NULL;
643 temp_copy_name = partialptr;
644 finish_transfer(fname, fnametmp, temp_copy_name,
646 if (fnamecmp == partialptr) {
647 do_unlink(partialptr);
648 handle_partial_dir(partialptr, PDIR_DELETE);
650 } else if (keep_partial && partialptr
651 && handle_partial_dir(partialptr, PDIR_CREATE)) {
652 finish_transfer(partialptr, fnametmp, NULL,
653 file, recv_ok, !partial_dir);
654 if (delay_updates && recv_ok) {
655 bitbag_set_bit(delayed_bits, ndx);
666 if (remove_source_files || incremental
667 || (preserve_hard_links && F_IS_HLINKED(file)))
668 send_msg_int(MSG_SUCCESS, ndx);
669 } else if (!recv_ok) {
670 enum logcode msgtype = phase || read_batch ? FERROR : FINFO;
671 if (msgtype == FERROR || verbose) {
672 char *errstr, *redostr, *keptstr;
673 if (!(keep_partial && partialptr) && !inplace)
674 keptstr = "discarded";
675 else if (partial_dir)
676 keptstr = "put into partial-dir";
678 keptstr = "retained";
679 if (msgtype == FERROR) {
684 redostr = " (will try again)";
687 "%s: %s failed verification -- update %s%s.\n",
688 errstr, fname, keptstr, redostr);
690 if (!phase || incremental) {
691 send_msg_int(MSG_REDO, ndx);
692 file->flags |= FLAG_FILE_SENT;
696 if (make_backups < 0)
697 make_backups = -make_backups;
699 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
700 handle_delayed_updates(local_name);
703 rprintf(FINFO,"recv_files finished\n");