Allows --address to be used in client mode.
[rsync.git] / receiver.c
blob53537c38544869c318c7b5158bd6592737a0f9c5
1 /* -*- c-file-style: "linux" -*-
3 Copyright (C) 1996-2000 by Andrew Tridgell
4 Copyright (C) Paul Mackerras 1996
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "rsync.h"
23 extern int verbose;
24 extern int dry_run;
25 extern int am_daemon;
26 extern int am_server;
27 extern int do_progress;
28 extern int log_before_transfer;
29 extern int log_format_has_i;
30 extern int daemon_log_format_has_i;
31 extern int csum_length;
32 extern int read_batch;
33 extern int batch_gen_fd;
34 extern int protocol_version;
35 extern int relative_paths;
36 extern int keep_dirlinks;
37 extern int preserve_hard_links;
38 extern int preserve_perms;
39 extern int io_error;
40 extern int basis_dir_cnt;
41 extern int make_backups;
42 extern int cleanup_got_literal;
43 extern int remove_sent_files;
44 extern int module_id;
45 extern int ignore_errors;
46 extern int orig_umask;
47 extern int keep_partial;
48 extern int checksum_seed;
49 extern int inplace;
50 extern int delay_updates;
51 extern struct stats stats;
52 extern char *log_format;
53 extern char *tmpdir;
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 #define SLOT_SIZE (16*1024) /* Desired size in bytes */
60 #define PER_SLOT_BITS (SLOT_SIZE * 8) /* Number of bits per slot */
61 #define PER_SLOT_INTS (SLOT_SIZE / 4) /* Number of int32s per slot */
63 static uint32 **delayed_bits = NULL;
64 static int delayed_slot_cnt = 0;
65 static int phase = 0;
67 static void init_delayed_bits(int max_ndx)
69 delayed_slot_cnt = (max_ndx + PER_SLOT_BITS - 1) / PER_SLOT_BITS;
71 if (!(delayed_bits = (uint32**)calloc(delayed_slot_cnt, sizeof (uint32*))))
72 out_of_memory("set_delayed_bit");
75 static void set_delayed_bit(int ndx)
77 int slot = ndx / PER_SLOT_BITS;
78 ndx %= PER_SLOT_BITS;
80 if (!delayed_bits[slot]) {
81 if (!(delayed_bits[slot] = (uint32*)calloc(PER_SLOT_INTS, 4)))
82 out_of_memory("set_delayed_bit");
85 delayed_bits[slot][ndx/32] |= 1u << (ndx % 32);
88 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
89 static int next_delayed_bit(int after)
91 uint32 bits, mask;
92 int i, ndx = after + 1;
93 int slot = ndx / PER_SLOT_BITS;
94 ndx %= PER_SLOT_BITS;
96 mask = (1u << (ndx % 32)) - 1;
97 for (i = ndx / 32; slot < delayed_slot_cnt; slot++, i = mask = 0) {
98 if (!delayed_bits[slot])
99 continue;
100 for ( ; i < PER_SLOT_INTS; i++, mask = 0) {
101 if (!(bits = delayed_bits[slot][i] & ~mask))
102 continue;
103 /* The xor magic figures out the lowest enabled bit in
104 * bits, and the switch quickly computes log2(bit). */
105 switch (bits ^ (bits & (bits-1))) {
106 #define LOG2(n) case 1u << n: return slot*PER_SLOT_BITS + i*32 + n
107 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
108 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
109 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
110 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
111 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
112 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
113 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
114 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
116 return -1; /* impossible... */
120 return -1;
125 * get_tmpname() - create a tmp filename for a given filename
127 * If a tmpdir is defined, use that as the directory to
128 * put it in. Otherwise, the tmp filename is in the same
129 * directory as the given name. Note that there may be no
130 * directory at all in the given name!
132 * The tmp filename is basically the given filename with a
133 * dot prepended, and .XXXXXX appended (for mkstemp() to
134 * put its unique gunk in). Take care to not exceed
135 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
136 * the basename basically becomes 8 chars longer. In that
137 * case, the original name is shortened sufficiently to
138 * make it all fit.
140 * Of course, there's no real reason for the tmp name to
141 * look like the original, except to satisfy us humans.
142 * As long as it's unique, rsync will work.
145 static int get_tmpname(char *fnametmp, char *fname)
147 char *f;
148 int length = 0;
149 int maxname;
151 if (tmpdir) {
152 /* Note: this can't overflow, so the return value is safe */
153 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
154 fnametmp[length++] = '/';
155 fnametmp[length] = '\0'; /* always NULL terminated */
158 if ((f = strrchr(fname, '/')) != NULL) {
159 ++f;
160 if (!tmpdir) {
161 length = f - fname;
162 /* copy up to and including the slash */
163 strlcpy(fnametmp, fname, length + 1);
165 } else
166 f = fname;
167 fnametmp[length++] = '.';
168 fnametmp[length] = '\0'; /* always NULL terminated */
170 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
172 if (maxname < 1) {
173 rprintf(FERROR, "temporary filename too long: %s\n",
174 safe_fname(fname));
175 fnametmp[0] = '\0';
176 return 0;
179 strlcpy(fnametmp + length, f, maxname);
180 strcat(fnametmp + length, ".XXXXXX");
182 return 1;
186 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
187 char *fname, int fd, OFF_T total_size)
189 static char file_sum1[MD4_SUM_LENGTH];
190 static char file_sum2[MD4_SUM_LENGTH];
191 struct map_struct *mapbuf;
192 struct sum_struct sum;
193 int32 len;
194 OFF_T offset = 0;
195 OFF_T offset2;
196 char *data;
197 int32 i;
198 char *map = NULL;
200 read_sum_head(f_in, &sum);
202 if (fd_r >= 0 && size_r > 0) {
203 int32 read_size = MAX(sum.blength * 2, 16*1024);
204 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
205 if (verbose > 2) {
206 rprintf(FINFO, "recv mapped %s of size %.0f\n",
207 safe_fname(fname_r), (double)size_r);
209 } else
210 mapbuf = NULL;
212 sum_init(checksum_seed);
214 while ((i = recv_token(f_in, &data)) != 0) {
215 if (do_progress)
216 show_progress(offset, total_size);
218 if (i > 0) {
219 if (verbose > 3) {
220 rprintf(FINFO,"data recv %d at %.0f\n",
221 i,(double)offset);
224 stats.literal_data += i;
225 cleanup_got_literal = 1;
227 sum_update(data, i);
229 if (fd != -1 && write_file(fd,data,i) != i)
230 goto report_write_error;
231 offset += i;
232 continue;
235 i = -(i+1);
236 offset2 = i * (OFF_T)sum.blength;
237 len = sum.blength;
238 if (i == (int)sum.count-1 && sum.remainder != 0)
239 len = sum.remainder;
241 stats.matched_data += len;
243 if (verbose > 3) {
244 rprintf(FINFO,
245 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
246 i, (long)len, (double)offset2, (double)offset);
249 if (mapbuf) {
250 map = map_ptr(mapbuf,offset2,len);
252 see_token(map, len);
253 sum_update(map, len);
256 if (inplace) {
257 if (offset == offset2 && fd != -1) {
258 if (flush_write_file(fd) < 0)
259 goto report_write_error;
260 offset += len;
261 if (do_lseek(fd, len, SEEK_CUR) != offset) {
262 rsyserr(FERROR, errno,
263 "lseek failed on %s",
264 full_fname(fname));
265 exit_cleanup(RERR_FILEIO);
267 continue;
270 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
271 goto report_write_error;
272 offset += len;
275 if (flush_write_file(fd) < 0)
276 goto report_write_error;
278 #ifdef HAVE_FTRUNCATE
279 if (inplace && fd != -1)
280 ftruncate(fd, offset);
281 #endif
283 if (do_progress)
284 end_progress(total_size);
286 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
287 report_write_error:
288 rsyserr(FERROR, errno, "write failed on %s",
289 full_fname(fname));
290 exit_cleanup(RERR_FILEIO);
293 sum_end(file_sum1);
295 if (mapbuf)
296 unmap_file(mapbuf);
298 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
299 if (verbose > 2)
300 rprintf(FINFO,"got file_sum\n");
301 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
302 return 0;
303 return 1;
307 static void discard_receive_data(int f_in, OFF_T length)
309 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
312 static void handle_delayed_updates(struct file_list *flist, char *local_name)
314 char *fname, *partialptr, numbuf[4];
315 int i;
317 for (i = -1; (i = next_delayed_bit(i)) >= 0; ) {
318 struct file_struct *file = flist->files[i];
319 fname = local_name ? local_name : f_name(file);
320 if ((partialptr = partial_dir_fname(fname)) != NULL) {
321 if (make_backups && !make_backup(fname))
322 continue;
323 if (verbose > 2) {
324 rprintf(FINFO, "renaming %s to %s\n",
325 safe_fname(partialptr),
326 safe_fname(fname));
328 if (do_rename(partialptr, fname) < 0) {
329 rsyserr(FERROR, errno,
330 "rename failed for %s (from %s)",
331 full_fname(fname),
332 safe_fname(partialptr));
333 } else {
334 if (remove_sent_files
335 || (preserve_hard_links
336 && file->link_u.links)) {
337 SIVAL(numbuf, 0, i);
338 send_msg(MSG_SUCCESS,numbuf,4);
340 handle_partial_dir(partialptr,
341 PDIR_DELETE);
347 static int get_next_gen_i(int batch_gen_fd, int next_gen_i, int desired_i)
349 while (next_gen_i < desired_i) {
350 if (next_gen_i >= 0) {
351 rprintf(FINFO,
352 "(No batched update for%s \"%s\")\n",
353 phase ? " resend of" : "",
354 safe_fname(f_name(the_file_list->files[next_gen_i])));
356 next_gen_i = read_int(batch_gen_fd);
357 if (next_gen_i == -1)
358 next_gen_i = the_file_list->count;
360 return next_gen_i;
365 * main routine for receiver process.
367 * Receiver process runs on the same host as the generator process. */
368 int recv_files(int f_in, struct file_list *flist, char *local_name)
370 int next_gen_i = -1;
371 int fd1,fd2;
372 STRUCT_STAT st;
373 int iflags, xlen;
374 char *fname, fbuf[MAXPATHLEN];
375 char xname[MAXPATHLEN];
376 char fnametmp[MAXPATHLEN];
377 char *fnamecmp, *partialptr, numbuf[4];
378 char fnamecmpbuf[MAXPATHLEN];
379 uchar fnamecmp_type;
380 struct file_struct *file;
381 struct stats initial_stats;
382 int save_make_backups = make_backups;
383 int itemizing = am_daemon ? daemon_log_format_has_i
384 : !am_server && log_format_has_i;
385 int max_phase = protocol_version >= 29 ? 2 : 1;
386 int i, recv_ok;
388 if (verbose > 2)
389 rprintf(FINFO,"recv_files(%d) starting\n",flist->count);
391 if (flist->hlink_pool) {
392 pool_destroy(flist->hlink_pool);
393 flist->hlink_pool = NULL;
396 if (delay_updates)
397 init_delayed_bits(flist->count);
399 while (1) {
400 cleanup_disable();
402 i = read_int(f_in);
403 if (i == -1) {
404 if (read_batch) {
405 get_next_gen_i(batch_gen_fd, next_gen_i,
406 flist->count);
407 next_gen_i = -1;
409 if (++phase > max_phase)
410 break;
411 csum_length = SUM_LENGTH;
412 if (verbose > 2)
413 rprintf(FINFO, "recv_files phase=%d\n", phase);
414 if (phase == 2 && delay_updates)
415 handle_delayed_updates(flist, local_name);
416 send_msg(MSG_DONE, "", 0);
417 if (keep_partial && !partial_dir)
418 make_backups = 0; /* prevents double backup */
419 continue;
422 iflags = read_item_attrs(f_in, -1, i, &fnamecmp_type,
423 xname, &xlen);
424 if (iflags == ITEM_IS_NEW) /* no-op packet */
425 continue;
427 file = flist->files[i];
428 fname = local_name ? local_name : f_name_to(file, fbuf);
430 if (verbose > 2)
431 rprintf(FINFO, "recv_files(%s)\n", safe_fname(fname));
433 if (!(iflags & ITEM_TRANSFER)) {
434 maybe_log_item(file, iflags, itemizing, xname);
435 continue;
437 if (phase == 2) {
438 rprintf(FERROR,
439 "got transfer request in phase 2 [%s]\n",
440 who_am_i());
441 exit_cleanup(RERR_PROTOCOL);
444 stats.current_file_index = i;
445 stats.num_transferred_files++;
446 stats.total_transferred_size += file->length;
447 cleanup_got_literal = 0;
449 if (server_filter_list.head
450 && check_filter(&server_filter_list, fname, 0) < 0) {
451 rprintf(FERROR, "attempt to hack rsync failed.\n");
452 exit_cleanup(RERR_PROTOCOL);
455 if (dry_run) { /* log the transfer */
456 if (!am_server && log_format)
457 log_item(file, &stats, iflags, NULL);
458 if (read_batch)
459 discard_receive_data(f_in, file->length);
460 continue;
463 if (read_batch) {
464 next_gen_i = get_next_gen_i(batch_gen_fd, next_gen_i, i);
465 if (i < next_gen_i) {
466 rprintf(FINFO, "(Skipping batched update for \"%s\")\n",
467 safe_fname(fname));
468 discard_receive_data(f_in, file->length);
469 continue;
471 next_gen_i = -1;
474 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
476 if (protocol_version >= 29) {
477 switch (fnamecmp_type) {
478 case FNAMECMP_FNAME:
479 fnamecmp = fname;
480 break;
481 case FNAMECMP_PARTIAL_DIR:
482 fnamecmp = partialptr;
483 break;
484 case FNAMECMP_BACKUP:
485 fnamecmp = get_backup_name(fname);
486 break;
487 case FNAMECMP_FUZZY:
488 if (file->dirname) {
489 pathjoin(fnamecmpbuf, MAXPATHLEN,
490 file->dirname, xname);
491 fnamecmp = fnamecmpbuf;
492 } else
493 fnamecmp = xname;
494 break;
495 default:
496 if (fnamecmp_type >= basis_dir_cnt) {
497 rprintf(FERROR,
498 "invalid basis_dir index: %d.\n",
499 fnamecmp_type);
500 exit_cleanup(RERR_PROTOCOL);
502 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
503 basis_dir[fnamecmp_type], fname);
504 fnamecmp = fnamecmpbuf;
505 break;
507 if (!fnamecmp || (server_filter_list.head
508 && check_filter(&server_filter_list, fname, 0) < 0))
509 fnamecmp = fname;
510 } else {
511 /* Reminder: --inplace && --partial-dir are never
512 * enabled at the same time. */
513 if (inplace && make_backups) {
514 if (!(fnamecmp = get_backup_name(fname)))
515 fnamecmp = fname;
516 } else if (partial_dir && partialptr)
517 fnamecmp = partialptr;
518 else
519 fnamecmp = fname;
522 initial_stats = stats;
524 /* open the file */
525 fd1 = do_open(fnamecmp, O_RDONLY, 0);
527 if (fd1 == -1 && protocol_version < 29) {
528 if (fnamecmp != fname) {
529 fnamecmp = fname;
530 fd1 = do_open(fnamecmp, O_RDONLY, 0);
533 if (fd1 == -1 && basis_dir[0]) {
534 /* pre-29 allowed only one alternate basis */
535 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
536 basis_dir[0], fname);
537 fnamecmp = fnamecmpbuf;
538 fd1 = do_open(fnamecmp, O_RDONLY, 0);
542 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
543 rsyserr(FERROR, errno, "fstat %s failed",
544 full_fname(fnamecmp));
545 discard_receive_data(f_in, file->length);
546 close(fd1);
547 continue;
550 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
551 /* this special handling for directories
552 * wouldn't be necessary if robust_rename()
553 * and the underlying robust_unlink could cope
554 * with directories
556 rprintf(FERROR,"recv_files: %s is a directory\n",
557 full_fname(fnamecmp));
558 discard_receive_data(f_in, file->length);
559 close(fd1);
560 continue;
563 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
564 close(fd1);
565 fd1 = -1;
568 if (fd1 != -1 && !preserve_perms) {
569 /* if the file exists already and we aren't preserving
570 * permissions then act as though the remote end sent
571 * us the file permissions we already have */
572 file->mode = st.st_mode;
575 /* We now check to see if we are writing file "inplace" */
576 if (inplace) {
577 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0);
578 if (fd2 == -1) {
579 rsyserr(FERROR, errno, "open %s failed",
580 full_fname(fname));
581 discard_receive_data(f_in, file->length);
582 if (fd1 != -1)
583 close(fd1);
584 continue;
586 } else {
587 if (!get_tmpname(fnametmp,fname)) {
588 discard_receive_data(f_in, file->length);
589 if (fd1 != -1)
590 close(fd1);
591 continue;
594 /* we initially set the perms without the
595 * setuid/setgid bits to ensure that there is no race
596 * condition. They are then correctly updated after
597 * the lchown. Thanks to snabb@epipe.fi for pointing
598 * this out. We also set it initially without group
599 * access because of a similar race condition. */
600 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
602 /* in most cases parent directories will already exist
603 * because their information should have been previously
604 * transferred, but that may not be the case with -R */
605 if (fd2 == -1 && relative_paths && errno == ENOENT
606 && create_directory_path(fnametmp, orig_umask) == 0) {
607 /* Get back to name with XXXXXX in it. */
608 get_tmpname(fnametmp, fname);
609 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
611 if (fd2 == -1) {
612 rsyserr(FERROR, errno, "mkstemp %s failed",
613 full_fname(fnametmp));
614 discard_receive_data(f_in, file->length);
615 if (fd1 != -1)
616 close(fd1);
617 continue;
620 if (partialptr)
621 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
624 /* log the transfer */
625 if (log_before_transfer)
626 log_item(file, &initial_stats, iflags, NULL);
627 else if (!am_server && verbose && do_progress)
628 rprintf(FINFO, "%s\n", safe_fname(fname));
630 /* recv file data */
631 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
632 fname, fd2, file->length);
634 if (!log_before_transfer)
635 log_item(file, &initial_stats, iflags, NULL);
637 if (fd1 != -1)
638 close(fd1);
639 if (close(fd2) < 0) {
640 rsyserr(FERROR, errno, "close failed on %s",
641 full_fname(fnametmp));
642 exit_cleanup(RERR_FILEIO);
645 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
646 finish_transfer(fname, fnametmp, file, recv_ok, 1);
647 if (partialptr != fname && fnamecmp == partialptr) {
648 do_unlink(partialptr);
649 handle_partial_dir(partialptr, PDIR_DELETE);
651 } else if (keep_partial && partialptr
652 && handle_partial_dir(partialptr, PDIR_CREATE)) {
653 finish_transfer(partialptr, fnametmp, file, recv_ok,
654 !partial_dir);
655 if (delay_updates && recv_ok) {
656 set_delayed_bit(i);
657 recv_ok = -1;
659 } else {
660 partialptr = NULL;
661 do_unlink(fnametmp);
664 cleanup_disable();
666 if (recv_ok > 0) {
667 if (remove_sent_files
668 || (preserve_hard_links && file->link_u.links)) {
669 SIVAL(numbuf, 0, i);
670 send_msg(MSG_SUCCESS, numbuf, 4);
672 } else if (!recv_ok) {
673 int msgtype = phase || read_batch ? FERROR : FINFO;
674 if (msgtype == FERROR || verbose) {
675 char *errstr, *redostr, *keptstr;
676 if (!(keep_partial && partialptr) && !inplace)
677 keptstr = "discarded";
678 else if (partial_dir)
679 keptstr = "put into partial-dir";
680 else
681 keptstr = "retained";
682 if (msgtype == FERROR) {
683 errstr = "ERROR";
684 redostr = "";
685 } else {
686 errstr = "WARNING";
687 redostr = " (will try again)";
689 rprintf(msgtype,
690 "%s: %s failed verification -- update %s%s.\n",
691 errstr, safe_fname(fname),
692 keptstr, redostr);
694 if (!phase) {
695 SIVAL(numbuf, 0, i);
696 send_msg(MSG_REDO, numbuf, 4);
700 make_backups = save_make_backups;
702 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
703 handle_delayed_updates(flist, local_name);
705 if (verbose > 2)
706 rprintf(FINFO,"recv_files finished\n");
708 return 0;