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.
29 extern int do_progress;
30 extern int log_before_transfer;
31 extern int log_format_has_i;
32 extern int daemon_log_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_sent_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 *log_format;
54 extern char *partial_dir;
55 extern char *basis_dir[];
56 extern struct file_list *the_file_list;
57 extern struct filter_list_struct server_filter_list;
59 static struct bitbag *delayed_bits = NULL;
64 * get_tmpname() - create a tmp filename for a given filename
66 * If a tmpdir is defined, use that as the directory to
67 * put it in. Otherwise, the tmp filename is in the same
68 * directory as the given name. Note that there may be no
69 * directory at all in the given name!
71 * The tmp filename is basically the given filename with a
72 * dot prepended, and .XXXXXX appended (for mkstemp() to
73 * put its unique gunk in). Take care to not exceed
74 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
75 * the basename basically becomes 8 chars longer. In that
76 * case, the original name is shortened sufficiently to
79 * Of course, there's no real reason for the tmp name to
80 * look like the original, except to satisfy us humans.
81 * As long as it's unique, rsync will work.
84 static int get_tmpname(char *fnametmp, char *fname)
91 /* Note: this can't overflow, so the return value is safe */
92 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
93 fnametmp[length++] = '/';
94 fnametmp[length] = '\0'; /* always NULL terminated */
97 if ((f = strrchr(fname, '/')) != NULL) {
101 /* copy up to and including the slash */
102 strlcpy(fnametmp, fname, length + 1);
106 fnametmp[length++] = '.';
107 fnametmp[length] = '\0'; /* always NULL terminated */
109 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
112 rprintf(FERROR, "temporary filename too long: %s\n", fname);
117 strlcpy(fnametmp + length, f, maxname);
118 strcat(fnametmp + length, ".XXXXXX");
124 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
125 char *fname, int fd, OFF_T total_size)
127 static char file_sum1[MD4_SUM_LENGTH];
128 static char file_sum2[MD4_SUM_LENGTH];
129 struct map_struct *mapbuf;
130 struct sum_struct sum;
138 read_sum_head(f_in, &sum);
140 if (fd_r >= 0 && size_r > 0) {
141 int32 read_size = MAX(sum.blength * 2, 16*1024);
142 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
144 rprintf(FINFO, "recv mapped %s of size %.0f\n",
145 fname_r, (double)size_r);
150 sum_init(checksum_seed);
154 sum.flength = (OFF_T)sum.count * sum.blength;
156 sum.flength -= sum.blength - sum.remainder;
157 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
159 show_progress(offset, total_size);
160 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
164 if (offset < sum.flength) {
165 int32 len = sum.flength - offset;
167 show_progress(offset, total_size);
168 sum_update(map_ptr(mapbuf, offset, len), len);
169 offset = sum.flength;
171 if (fd != -1 && do_lseek(fd, offset, SEEK_SET) != offset) {
172 rsyserr(FERROR, errno, "lseek failed on %s",
174 exit_cleanup(RERR_FILEIO);
178 while ((i = recv_token(f_in, &data)) != 0) {
180 show_progress(offset, total_size);
184 rprintf(FINFO,"data recv %d at %.0f\n",
188 stats.literal_data += i;
189 cleanup_got_literal = 1;
193 if (fd != -1 && write_file(fd,data,i) != i)
194 goto report_write_error;
200 offset2 = i * (OFF_T)sum.blength;
202 if (i == (int)sum.count-1 && sum.remainder != 0)
205 stats.matched_data += len;
209 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
210 i, (long)len, (double)offset2, (double)offset);
214 map = map_ptr(mapbuf,offset2,len);
217 sum_update(map, len);
221 if (offset == offset2 && fd != -1) {
222 if (flush_write_file(fd) < 0)
223 goto report_write_error;
225 if (do_lseek(fd, len, SEEK_CUR) != offset) {
226 rsyserr(FERROR, errno,
227 "lseek failed on %s",
229 exit_cleanup(RERR_FILEIO);
234 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
235 goto report_write_error;
239 if (flush_write_file(fd) < 0)
240 goto report_write_error;
242 #ifdef HAVE_FTRUNCATE
243 if (inplace && fd != -1)
244 ftruncate(fd, offset);
248 end_progress(total_size);
250 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
252 rsyserr(FERROR, errno, "write failed on %s",
254 exit_cleanup(RERR_FILEIO);
262 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
264 rprintf(FINFO,"got file_sum\n");
265 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
271 static void discard_receive_data(int f_in, OFF_T length)
273 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
276 static void handle_delayed_updates(struct file_list *flist, char *local_name)
278 char *fname, *partialptr, numbuf[4];
281 for (i = -1; (i = bitbag_next_bit(delayed_bits, i)) >= 0; ) {
282 struct file_struct *file = flist->files[i];
283 fname = local_name ? local_name : f_name(file, NULL);
284 if ((partialptr = partial_dir_fname(fname)) != NULL) {
285 if (make_backups && !make_backup(fname))
288 rprintf(FINFO, "renaming %s to %s\n",
291 /* We don't use robust_rename() here because the
292 * partial-dir must be on the same drive. */
293 if (do_rename(partialptr, fname) < 0) {
294 rsyserr(FERROR, errno,
295 "rename failed for %s (from %s)",
296 full_fname(fname), partialptr);
298 if (remove_sent_files
299 || (preserve_hard_links
300 && file->link_u.links)) {
302 send_msg(MSG_SUCCESS,numbuf,4);
304 handle_partial_dir(partialptr, PDIR_DELETE);
310 static int get_next_gen_i(int batch_gen_fd, int next_gen_i, int desired_i)
312 while (next_gen_i < desired_i) {
313 if (next_gen_i >= 0) {
315 "(No batched update for%s \"%s\")\n",
316 phase ? " resend of" : "",
317 f_name(the_file_list->files[next_gen_i], NULL));
319 next_gen_i = read_int(batch_gen_fd);
320 if (next_gen_i == -1)
321 next_gen_i = the_file_list->count;
328 * main routine for receiver process.
330 * Receiver process runs on the same host as the generator process. */
331 int recv_files(int f_in, struct file_list *flist, char *local_name)
337 char *fname, fbuf[MAXPATHLEN];
338 char xname[MAXPATHLEN];
339 char fnametmp[MAXPATHLEN];
340 char *fnamecmp, *partialptr, numbuf[4];
341 char fnamecmpbuf[MAXPATHLEN];
343 struct file_struct *file;
344 struct stats initial_stats;
345 int save_make_backups = make_backups;
346 int itemizing = am_daemon ? daemon_log_format_has_i
347 : !am_server && log_format_has_i;
348 int max_phase = protocol_version >= 29 ? 2 : 1;
352 rprintf(FINFO,"recv_files(%d) starting\n",flist->count);
354 if (flist->hlink_pool) {
355 pool_destroy(flist->hlink_pool);
356 flist->hlink_pool = NULL;
360 delayed_bits = bitbag_create(flist->count);
368 get_next_gen_i(batch_gen_fd, next_gen_i,
372 if (++phase > max_phase)
374 csum_length = SUM_LENGTH;
376 rprintf(FINFO, "recv_files phase=%d\n", phase);
377 if (phase == 2 && delay_updates)
378 handle_delayed_updates(flist, local_name);
379 send_msg(MSG_DONE, "", 0);
380 if (keep_partial && !partial_dir)
381 make_backups = 0; /* prevents double backup */
389 iflags = read_item_attrs(f_in, -1, i, &fnamecmp_type,
391 if (iflags == ITEM_IS_NEW) /* no-op packet */
394 file = flist->files[i];
395 fname = local_name ? local_name : f_name(file, fbuf);
398 rprintf(FINFO, "recv_files(%s)\n", fname);
400 if (!(iflags & ITEM_TRANSFER)) {
401 maybe_log_item(file, iflags, itemizing, xname);
406 "got transfer request in phase 2 [%s]\n",
408 exit_cleanup(RERR_PROTOCOL);
411 stats.current_file_index = i;
412 stats.num_transferred_files++;
413 stats.total_transferred_size += file->length;
414 cleanup_got_literal = 0;
416 if (server_filter_list.head
417 && check_filter(&server_filter_list, fname, 0) < 0) {
418 rprintf(FERROR, "attempt to hack rsync failed.\n");
419 exit_cleanup(RERR_PROTOCOL);
422 if (!do_xfers) { /* log the transfer */
423 if (!am_server && log_format)
424 log_item(file, &stats, iflags, NULL);
426 discard_receive_data(f_in, file->length);
429 if (write_batch < 0) {
430 log_item(file, &stats, iflags, NULL);
432 discard_receive_data(f_in, file->length);
437 next_gen_i = get_next_gen_i(batch_gen_fd, next_gen_i, i);
438 if (i < next_gen_i) {
440 "(Skipping batched update for \"%s\")\n",
442 discard_receive_data(f_in, file->length);
448 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
450 if (protocol_version >= 29) {
451 switch (fnamecmp_type) {
455 case FNAMECMP_PARTIAL_DIR:
456 fnamecmp = partialptr;
458 case FNAMECMP_BACKUP:
459 fnamecmp = get_backup_name(fname);
463 pathjoin(fnamecmpbuf, MAXPATHLEN,
464 file->dirname, xname);
465 fnamecmp = fnamecmpbuf;
470 if (fnamecmp_type >= basis_dir_cnt) {
472 "invalid basis_dir index: %d.\n",
474 exit_cleanup(RERR_PROTOCOL);
476 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
477 basis_dir[fnamecmp_type], fname);
478 fnamecmp = fnamecmpbuf;
481 if (!fnamecmp || (server_filter_list.head
482 && check_filter(&server_filter_list, fname, 0) < 0))
485 /* Reminder: --inplace && --partial-dir are never
486 * enabled at the same time. */
487 if (inplace && make_backups) {
488 if (!(fnamecmp = get_backup_name(fname)))
490 } else if (partial_dir && partialptr)
491 fnamecmp = partialptr;
496 initial_stats = stats;
499 fd1 = do_open(fnamecmp, O_RDONLY, 0);
501 if (fd1 == -1 && protocol_version < 29) {
502 if (fnamecmp != fname) {
504 fd1 = do_open(fnamecmp, O_RDONLY, 0);
507 if (fd1 == -1 && basis_dir[0]) {
508 /* pre-29 allowed only one alternate basis */
509 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
510 basis_dir[0], fname);
511 fnamecmp = fnamecmpbuf;
512 fd1 = do_open(fnamecmp, O_RDONLY, 0);
516 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
517 rsyserr(FERROR, errno, "fstat %s failed",
518 full_fname(fnamecmp));
519 discard_receive_data(f_in, file->length);
524 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
525 /* this special handling for directories
526 * wouldn't be necessary if robust_rename()
527 * and the underlying robust_unlink could cope
530 rprintf(FERROR,"recv_files: %s is a directory\n",
531 full_fname(fnamecmp));
532 discard_receive_data(f_in, file->length);
537 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
542 /* If we're not preserving permissions, change the file-list's
543 * mode based on the local permissions and some heuristics. */
544 if (!preserve_perms) {
545 int exists = fd1 != -1;
546 file->mode = dest_mode(file->mode, st.st_mode, exists);
549 /* We now check to see if we are writing file "inplace" */
551 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
553 rsyserr(FERROR, errno, "open %s failed",
555 discard_receive_data(f_in, file->length);
561 if (!get_tmpname(fnametmp,fname)) {
562 discard_receive_data(f_in, file->length);
568 /* we initially set the perms without the
569 * setuid/setgid bits to ensure that there is no race
570 * condition. They are then correctly updated after
571 * the lchown. Thanks to snabb@epipe.fi for pointing
572 * this out. We also set it initially without group
573 * access because of a similar race condition. */
574 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
576 /* in most cases parent directories will already exist
577 * because their information should have been previously
578 * transferred, but that may not be the case with -R */
579 if (fd2 == -1 && relative_paths && errno == ENOENT
580 && create_directory_path(fnametmp) == 0) {
581 /* Get back to name with XXXXXX in it. */
582 get_tmpname(fnametmp, fname);
583 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
586 rsyserr(FERROR, errno, "mkstemp %s failed",
587 full_fname(fnametmp));
588 discard_receive_data(f_in, file->length);
595 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
598 /* log the transfer */
599 if (log_before_transfer)
600 log_item(file, &initial_stats, iflags, NULL);
601 else if (!am_server && verbose && do_progress)
602 rprintf(FINFO, "%s\n", fname);
605 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
606 fname, fd2, file->length);
608 if (!log_before_transfer)
609 log_item(file, &initial_stats, iflags, NULL);
613 if (close(fd2) < 0) {
614 rsyserr(FERROR, errno, "close failed on %s",
615 full_fname(fnametmp));
616 exit_cleanup(RERR_FILEIO);
619 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
620 if (partialptr == fname || *partial_dir == '/')
622 finish_transfer(fname, fnametmp, partialptr,
624 if (fnamecmp == partialptr) {
625 do_unlink(partialptr);
626 handle_partial_dir(partialptr, PDIR_DELETE);
628 } else if (keep_partial && partialptr
629 && handle_partial_dir(partialptr, PDIR_CREATE)) {
630 finish_transfer(partialptr, fnametmp, NULL,
631 file, recv_ok, !partial_dir);
632 if (delay_updates && recv_ok) {
633 bitbag_set_bit(delayed_bits, i);
644 if (remove_sent_files
645 || (preserve_hard_links && file->link_u.links)) {
647 send_msg(MSG_SUCCESS, numbuf, 4);
649 } else if (!recv_ok) {
650 int msgtype = phase || read_batch ? FERROR : FINFO;
651 if (msgtype == FERROR || verbose) {
652 char *errstr, *redostr, *keptstr;
653 if (!(keep_partial && partialptr) && !inplace)
654 keptstr = "discarded";
655 else if (partial_dir)
656 keptstr = "put into partial-dir";
658 keptstr = "retained";
659 if (msgtype == FERROR) {
664 redostr = " (will try again)";
667 "%s: %s failed verification -- update %s%s.\n",
668 errstr, fname, keptstr, redostr);
672 send_msg(MSG_REDO, numbuf, 4);
676 make_backups = save_make_backups;
678 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
679 handle_delayed_updates(flist, local_name);
682 rprintf(FINFO,"recv_files finished\n");