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 log_before_transfer;
30 extern int stdout_format_has_i;
31 extern int logfile_format_has_i;
32 extern int csum_length;
33 extern int read_batch;
34 extern int write_batch;
35 extern int batch_gen_fd;
36 extern int protocol_version;
37 extern int relative_paths;
38 extern int preserve_hard_links;
39 extern int preserve_perms;
40 extern int basis_dir_cnt;
41 extern int make_backups;
42 extern int cleanup_got_literal;
43 extern int remove_source_files;
44 extern int append_mode;
45 extern int sparse_files;
46 extern int keep_partial;
47 extern int checksum_seed;
49 extern int delay_updates;
50 extern struct stats stats;
51 extern char *stdout_format;
53 extern char *partial_dir;
54 extern char *basis_dir[];
55 extern struct file_list *the_file_list;
56 extern struct filter_list_struct server_filter_list;
58 static struct bitbag *delayed_bits = NULL;
60 /* We're either updating the basis file or an identical copy: */
61 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 static int get_tmpname(char *fnametmp, char *fname)
92 /* Note: this can't overflow, so the return value is safe */
93 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
94 fnametmp[length++] = '/';
95 fnametmp[length] = '\0'; /* always NULL terminated */
98 if ((f = strrchr(fname, '/')) != NULL) {
102 /* copy up to and including the slash */
103 strlcpy(fnametmp, fname, length + 1);
107 fnametmp[length++] = '.';
108 fnametmp[length] = '\0'; /* always NULL terminated */
110 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
113 rprintf(FERROR, "temporary filename too long: %s\n", fname);
118 strlcpy(fnametmp + length, f, maxname);
119 strcat(fnametmp + length, ".XXXXXX");
125 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
126 char *fname, int fd, OFF_T total_size)
128 static char file_sum1[MD4_SUM_LENGTH];
129 static char file_sum2[MD4_SUM_LENGTH];
130 struct map_struct *mapbuf;
131 struct sum_struct sum;
139 read_sum_head(f_in, &sum);
141 if (fd_r >= 0 && size_r > 0) {
142 int32 read_size = MAX(sum.blength * 2, 16*1024);
143 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
145 rprintf(FINFO, "recv mapped %s of size %.0f\n",
146 fname_r, (double)size_r);
151 sum_init(checksum_seed);
155 sum.flength = (OFF_T)sum.count * sum.blength;
157 sum.flength -= sum.blength - sum.remainder;
158 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
160 show_progress(offset, total_size);
161 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
165 if (offset < sum.flength) {
166 int32 len = sum.flength - offset;
168 show_progress(offset, total_size);
169 sum_update(map_ptr(mapbuf, offset, len), len);
170 offset = sum.flength;
172 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
173 rsyserr(FERROR, errno, "lseek of %s returned %.0f, not %.0f",
174 full_fname(fname), (double)j, (double)offset);
175 exit_cleanup(RERR_FILEIO);
179 while ((i = recv_token(f_in, &data)) != 0) {
181 show_progress(offset, total_size);
185 rprintf(FINFO,"data recv %d at %.0f\n",
189 stats.literal_data += i;
190 cleanup_got_literal = 1;
194 if (fd != -1 && write_file(fd,data,i) != i)
195 goto report_write_error;
201 offset2 = i * (OFF_T)sum.blength;
203 if (i == (int)sum.count-1 && sum.remainder != 0)
206 stats.matched_data += len;
210 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
211 i, (long)len, (double)offset2, (double)offset);
215 map = map_ptr(mapbuf,offset2,len);
218 sum_update(map, len);
221 if (updating_basis) {
222 if (offset == offset2 && fd != -1) {
224 if (flush_write_file(fd) < 0)
225 goto report_write_error;
227 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
228 rsyserr(FERROR, errno,
229 "lseek of %s returned %.0f, not %.0f",
231 (double)pos, (double)offset);
232 exit_cleanup(RERR_FILEIO);
237 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
238 goto report_write_error;
242 if (flush_write_file(fd) < 0)
243 goto report_write_error;
245 #ifdef HAVE_FTRUNCATE
246 if (inplace && fd != -1)
247 ftruncate(fd, offset);
251 end_progress(total_size);
253 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
255 rsyserr(FERROR, errno, "write failed on %s",
257 exit_cleanup(RERR_FILEIO);
265 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
267 rprintf(FINFO,"got file_sum\n");
268 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
274 static void discard_receive_data(int f_in, OFF_T length)
276 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
279 static void handle_delayed_updates(struct file_list *flist, char *local_name)
281 char *fname, *partialptr, numbuf[4];
284 for (i = -1; (i = bitbag_next_bit(delayed_bits, i)) >= 0; ) {
285 struct file_struct *file = flist->files[i];
286 fname = local_name ? local_name : f_name(file, NULL);
287 if ((partialptr = partial_dir_fname(fname)) != NULL) {
288 if (make_backups && !make_backup(fname))
291 rprintf(FINFO, "renaming %s to %s\n",
294 /* We don't use robust_rename() here because the
295 * partial-dir must be on the same drive. */
296 if (do_rename(partialptr, fname) < 0) {
297 rsyserr(FERROR, errno,
298 "rename failed for %s (from %s)",
299 full_fname(fname), partialptr);
301 if (remove_source_files
302 || (preserve_hard_links
303 && file->link_u.links)) {
305 send_msg(MSG_SUCCESS,numbuf,4);
307 handle_partial_dir(partialptr, PDIR_DELETE);
313 static int get_next_gen_i(int batch_gen_fd, int next_gen_i, int desired_i)
315 while (next_gen_i < desired_i) {
316 if (next_gen_i >= 0) {
318 "(No batched update for%s \"%s\")\n",
319 phase ? " resend of" : "",
320 f_name(the_file_list->files[next_gen_i], NULL));
322 next_gen_i = read_int(batch_gen_fd);
323 if (next_gen_i == -1)
324 next_gen_i = the_file_list->count;
331 * main routine for receiver process.
333 * Receiver process runs on the same host as the generator process. */
334 int recv_files(int f_in, struct file_list *flist, char *local_name)
340 char *fname, fbuf[MAXPATHLEN];
341 char xname[MAXPATHLEN];
342 char fnametmp[MAXPATHLEN];
343 char *fnamecmp, *partialptr, numbuf[4];
344 char fnamecmpbuf[MAXPATHLEN];
346 struct file_struct *file;
347 struct stats initial_stats;
348 int save_make_backups = make_backups;
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",flist->count);
357 if (flist->hlink_pool) {
358 pool_destroy(flist->hlink_pool);
359 flist->hlink_pool = NULL;
363 delayed_bits = bitbag_create(flist->count);
365 updating_basis = inplace;
373 get_next_gen_i(batch_gen_fd, next_gen_i,
377 if (++phase > max_phase)
379 csum_length = SUM_LENGTH;
381 rprintf(FINFO, "recv_files phase=%d\n", phase);
382 if (phase == 2 && delay_updates)
383 handle_delayed_updates(flist, local_name);
384 send_msg(MSG_DONE, "", 0);
385 if (keep_partial && !partial_dir)
386 make_backups = 0; /* prevents double backup */
394 iflags = read_item_attrs(f_in, -1, i, &fnamecmp_type,
396 if (iflags == ITEM_IS_NEW) /* no-op packet */
399 file = flist->files[i];
400 fname = local_name ? local_name : f_name(file, fbuf);
403 rprintf(FINFO, "recv_files(%s)\n", fname);
405 if (!(iflags & ITEM_TRANSFER)) {
406 maybe_log_item(file, iflags, itemizing, xname);
411 "got transfer request in phase 2 [%s]\n",
413 exit_cleanup(RERR_PROTOCOL);
416 stats.current_file_index = i;
417 stats.num_transferred_files++;
418 stats.total_transferred_size += file->length;
419 cleanup_got_literal = 0;
421 if (server_filter_list.head
422 && check_filter(&server_filter_list, fname, 0) < 0) {
423 rprintf(FERROR, "attempt to hack rsync failed.\n");
424 exit_cleanup(RERR_PROTOCOL);
427 if (!do_xfers) { /* log the transfer */
428 log_item(FCLIENT, file, &stats, iflags, NULL);
430 discard_receive_data(f_in, file->length);
433 if (write_batch < 0) {
434 log_item(FINFO, file, &stats, iflags, NULL);
436 discard_receive_data(f_in, file->length);
441 next_gen_i = get_next_gen_i(batch_gen_fd, next_gen_i, i);
442 if (i < next_gen_i) {
444 "(Skipping batched update for \"%s\")\n",
446 discard_receive_data(f_in, file->length);
452 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
454 if (protocol_version >= 29) {
455 switch (fnamecmp_type) {
459 case FNAMECMP_PARTIAL_DIR:
460 fnamecmp = partialptr;
462 case FNAMECMP_BACKUP:
463 fnamecmp = get_backup_name(fname);
468 pathjoin(fnamecmpbuf, MAXPATHLEN,
469 file->dirname, xname);
470 fnamecmp = fnamecmpbuf;
476 if (fnamecmp_type >= basis_dir_cnt) {
478 "invalid basis_dir index: %d.\n",
480 exit_cleanup(RERR_PROTOCOL);
482 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
483 basis_dir[fnamecmp_type], fname);
484 fnamecmp = fnamecmpbuf;
487 if (!fnamecmp || (server_filter_list.head
488 && check_filter(&server_filter_list, fname, 0) < 0))
491 /* Reminder: --inplace && --partial-dir are never
492 * enabled at the same time. */
493 if (inplace && make_backups) {
494 if (!(fnamecmp = get_backup_name(fname)))
496 } else if (partial_dir && partialptr)
497 fnamecmp = partialptr;
502 initial_stats = stats;
505 fd1 = do_open(fnamecmp, O_RDONLY, 0);
507 if (fd1 == -1 && protocol_version < 29) {
508 if (fnamecmp != fname) {
510 fd1 = do_open(fnamecmp, O_RDONLY, 0);
513 if (fd1 == -1 && basis_dir[0]) {
514 /* pre-29 allowed only one alternate basis */
515 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
516 basis_dir[0], fname);
517 fnamecmp = fnamecmpbuf;
518 fd1 = do_open(fnamecmp, O_RDONLY, 0);
522 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
523 rsyserr(FERROR, errno, "fstat %s failed",
524 full_fname(fnamecmp));
525 discard_receive_data(f_in, file->length);
530 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
531 /* this special handling for directories
532 * wouldn't be necessary if robust_rename()
533 * and the underlying robust_unlink could cope
536 rprintf(FERROR,"recv_files: %s is a directory\n",
537 full_fname(fnamecmp));
538 discard_receive_data(f_in, file->length);
543 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
548 /* If we're not preserving permissions, change the file-list's
549 * mode based on the local permissions and some heuristics. */
550 if (!preserve_perms) {
551 int exists = fd1 != -1;
552 file->mode = dest_mode(file->mode, st.st_mode, exists);
555 /* We now check to see if we are writing the file "inplace" */
557 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
559 rsyserr(FERROR, errno, "open %s failed",
561 discard_receive_data(f_in, file->length);
567 if (!get_tmpname(fnametmp,fname)) {
568 discard_receive_data(f_in, file->length);
574 /* we initially set the perms without the
575 * setuid/setgid bits to ensure that there is no race
576 * condition. They are then correctly updated after
577 * the lchown. Thanks to snabb@epipe.fi for pointing
578 * this out. We also set it initially without group
579 * access because of a similar race condition. */
580 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
582 /* in most cases parent directories will already exist
583 * because their information should have been previously
584 * transferred, but that may not be the case with -R */
585 if (fd2 == -1 && relative_paths && errno == ENOENT
586 && create_directory_path(fnametmp) == 0) {
587 /* Get back to name with XXXXXX in it. */
588 get_tmpname(fnametmp, fname);
589 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
592 rsyserr(FERROR, errno, "mkstemp %s failed",
593 full_fname(fnametmp));
594 discard_receive_data(f_in, file->length);
600 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
603 /* log the transfer */
604 if (log_before_transfer)
605 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
606 else if (!am_server && verbose && do_progress)
607 rprintf(FINFO, "%s\n", fname);
610 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
611 fname, fd2, file->length);
613 log_item(log_code, file, &initial_stats, iflags, NULL);
617 if (close(fd2) < 0) {
618 rsyserr(FERROR, errno, "close failed on %s",
619 full_fname(fnametmp));
620 exit_cleanup(RERR_FILEIO);
623 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
624 char *temp_copy_name;
625 if (partialptr == fname)
626 partialptr = temp_copy_name = NULL;
627 else if (*partial_dir == '/')
628 temp_copy_name = NULL;
630 temp_copy_name = partialptr;
631 finish_transfer(fname, fnametmp, temp_copy_name,
633 if (fnamecmp == partialptr) {
634 do_unlink(partialptr);
635 handle_partial_dir(partialptr, PDIR_DELETE);
637 } else if (keep_partial && partialptr
638 && handle_partial_dir(partialptr, PDIR_CREATE)) {
639 finish_transfer(partialptr, fnametmp, NULL,
640 file, recv_ok, !partial_dir);
641 if (delay_updates && recv_ok) {
642 bitbag_set_bit(delayed_bits, i);
653 if (remove_source_files
654 || (preserve_hard_links && file->link_u.links)) {
656 send_msg(MSG_SUCCESS, numbuf, 4);
658 } else if (!recv_ok) {
659 int msgtype = phase || read_batch ? FERROR : FINFO;
660 if (msgtype == FERROR || verbose) {
661 char *errstr, *redostr, *keptstr;
662 if (!(keep_partial && partialptr) && !inplace)
663 keptstr = "discarded";
664 else if (partial_dir)
665 keptstr = "put into partial-dir";
667 keptstr = "retained";
668 if (msgtype == FERROR) {
673 redostr = " (will try again)";
676 "%s: %s failed verification -- update %s%s.\n",
677 errstr, fname, keptstr, redostr);
681 send_msg(MSG_REDO, numbuf, 4);
685 make_backups = save_make_backups;
687 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
688 handle_delayed_updates(flist, local_name);
691 rprintf(FINFO,"recv_files finished\n");