Fixed one synopsis line to make the DEST arg optional.
[rsync.git] / receiver.c
blobabe1f663c7dc2a43085a75cde7e9f0c2cb28ac35
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 do_xfers;
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 write_batch;
34 extern int batch_gen_fd;
35 extern int protocol_version;
36 extern int relative_paths;
37 extern int keep_dirlinks;
38 extern int preserve_hard_links;
39 extern int preserve_perms;
40 extern int io_error;
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 module_id;
46 extern int ignore_errors;
47 extern int orig_umask;
48 extern int keep_partial;
49 extern int checksum_seed;
50 extern int inplace;
51 extern int delay_updates;
52 extern struct stats stats;
53 extern char *log_format;
54 extern char *tmpdir;
55 extern char *partial_dir;
56 extern char *basis_dir[];
57 extern struct file_list *the_file_list;
58 extern struct filter_list_struct server_filter_list;
60 #define SLOT_SIZE (16*1024) /* Desired size in bytes */
61 #define PER_SLOT_BITS (SLOT_SIZE * 8) /* Number of bits per slot */
62 #define PER_SLOT_INTS (SLOT_SIZE / 4) /* Number of int32s per slot */
64 static uint32 **delayed_bits = NULL;
65 static int delayed_slot_cnt = 0;
66 static int phase = 0;
68 static void init_delayed_bits(int max_ndx)
70 delayed_slot_cnt = (max_ndx + PER_SLOT_BITS - 1) / PER_SLOT_BITS;
72 if (!(delayed_bits = (uint32**)calloc(delayed_slot_cnt, sizeof (uint32*))))
73 out_of_memory("set_delayed_bit");
76 static void set_delayed_bit(int ndx)
78 int slot = ndx / PER_SLOT_BITS;
79 ndx %= PER_SLOT_BITS;
81 if (!delayed_bits[slot]) {
82 if (!(delayed_bits[slot] = (uint32*)calloc(PER_SLOT_INTS, 4)))
83 out_of_memory("set_delayed_bit");
86 delayed_bits[slot][ndx/32] |= 1u << (ndx % 32);
89 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
90 static int next_delayed_bit(int after)
92 uint32 bits, mask;
93 int i, ndx = after + 1;
94 int slot = ndx / PER_SLOT_BITS;
95 ndx %= PER_SLOT_BITS;
97 mask = (1u << (ndx % 32)) - 1;
98 for (i = ndx / 32; slot < delayed_slot_cnt; slot++, i = mask = 0) {
99 if (!delayed_bits[slot])
100 continue;
101 for ( ; i < PER_SLOT_INTS; i++, mask = 0) {
102 if (!(bits = delayed_bits[slot][i] & ~mask))
103 continue;
104 /* The xor magic figures out the lowest enabled bit in
105 * bits, and the switch quickly computes log2(bit). */
106 switch (bits ^ (bits & (bits-1))) {
107 #define LOG2(n) case 1u << n: return slot*PER_SLOT_BITS + i*32 + n
108 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
109 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
110 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
111 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
112 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
113 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
114 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
115 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
117 return -1; /* impossible... */
121 return -1;
126 * get_tmpname() - create a tmp filename for a given filename
128 * If a tmpdir is defined, use that as the directory to
129 * put it in. Otherwise, the tmp filename is in the same
130 * directory as the given name. Note that there may be no
131 * directory at all in the given name!
133 * The tmp filename is basically the given filename with a
134 * dot prepended, and .XXXXXX appended (for mkstemp() to
135 * put its unique gunk in). Take care to not exceed
136 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
137 * the basename basically becomes 8 chars longer. In that
138 * case, the original name is shortened sufficiently to
139 * make it all fit.
141 * Of course, there's no real reason for the tmp name to
142 * look like the original, except to satisfy us humans.
143 * As long as it's unique, rsync will work.
146 static int get_tmpname(char *fnametmp, char *fname)
148 char *f;
149 int length = 0;
150 int maxname;
152 if (tmpdir) {
153 /* Note: this can't overflow, so the return value is safe */
154 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
155 fnametmp[length++] = '/';
156 fnametmp[length] = '\0'; /* always NULL terminated */
159 if ((f = strrchr(fname, '/')) != NULL) {
160 ++f;
161 if (!tmpdir) {
162 length = f - fname;
163 /* copy up to and including the slash */
164 strlcpy(fnametmp, fname, length + 1);
166 } else
167 f = fname;
168 fnametmp[length++] = '.';
169 fnametmp[length] = '\0'; /* always NULL terminated */
171 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
173 if (maxname < 1) {
174 rprintf(FERROR, "temporary filename too long: %s\n",
175 safe_fname(fname));
176 fnametmp[0] = '\0';
177 return 0;
180 strlcpy(fnametmp + length, f, maxname);
181 strcat(fnametmp + length, ".XXXXXX");
183 return 1;
187 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
188 char *fname, int fd, OFF_T total_size)
190 static char file_sum1[MD4_SUM_LENGTH];
191 static char file_sum2[MD4_SUM_LENGTH];
192 struct map_struct *mapbuf;
193 struct sum_struct sum;
194 int32 len;
195 OFF_T offset = 0;
196 OFF_T offset2;
197 char *data;
198 int32 i;
199 char *map = NULL;
201 read_sum_head(f_in, &sum);
203 if (fd_r >= 0 && size_r > 0) {
204 int32 read_size = MAX(sum.blength * 2, 16*1024);
205 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
206 if (verbose > 2) {
207 rprintf(FINFO, "recv mapped %s of size %.0f\n",
208 safe_fname(fname_r), (double)size_r);
210 } else
211 mapbuf = NULL;
213 sum_init(checksum_seed);
215 while ((i = recv_token(f_in, &data)) != 0) {
216 if (do_progress)
217 show_progress(offset, total_size);
219 if (i > 0) {
220 if (verbose > 3) {
221 rprintf(FINFO,"data recv %d at %.0f\n",
222 i,(double)offset);
225 stats.literal_data += i;
226 cleanup_got_literal = 1;
228 sum_update(data, i);
230 if (fd != -1 && write_file(fd,data,i) != i)
231 goto report_write_error;
232 offset += i;
233 continue;
236 i = -(i+1);
237 offset2 = i * (OFF_T)sum.blength;
238 len = sum.blength;
239 if (i == (int)sum.count-1 && sum.remainder != 0)
240 len = sum.remainder;
242 stats.matched_data += len;
244 if (verbose > 3) {
245 rprintf(FINFO,
246 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
247 i, (long)len, (double)offset2, (double)offset);
250 if (mapbuf) {
251 map = map_ptr(mapbuf,offset2,len);
253 see_token(map, len);
254 sum_update(map, len);
257 if (inplace) {
258 if (offset == offset2 && fd != -1) {
259 if (flush_write_file(fd) < 0)
260 goto report_write_error;
261 offset += len;
262 if (do_lseek(fd, len, SEEK_CUR) != offset) {
263 rsyserr(FERROR, errno,
264 "lseek failed on %s",
265 full_fname(fname));
266 exit_cleanup(RERR_FILEIO);
268 continue;
271 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
272 goto report_write_error;
273 offset += len;
276 if (flush_write_file(fd) < 0)
277 goto report_write_error;
279 #ifdef HAVE_FTRUNCATE
280 if (inplace && fd != -1)
281 ftruncate(fd, offset);
282 #endif
284 if (do_progress)
285 end_progress(total_size);
287 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
288 report_write_error:
289 rsyserr(FERROR, errno, "write failed on %s",
290 full_fname(fname));
291 exit_cleanup(RERR_FILEIO);
294 sum_end(file_sum1);
296 if (mapbuf)
297 unmap_file(mapbuf);
299 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
300 if (verbose > 2)
301 rprintf(FINFO,"got file_sum\n");
302 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
303 return 0;
304 return 1;
308 static void discard_receive_data(int f_in, OFF_T length)
310 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
313 static void handle_delayed_updates(struct file_list *flist, char *local_name)
315 char *fname, *partialptr, numbuf[4];
316 int i;
318 for (i = -1; (i = next_delayed_bit(i)) >= 0; ) {
319 struct file_struct *file = flist->files[i];
320 fname = local_name ? local_name : f_name(file);
321 if ((partialptr = partial_dir_fname(fname)) != NULL) {
322 if (make_backups && !make_backup(fname))
323 continue;
324 if (verbose > 2) {
325 rprintf(FINFO, "renaming %s to %s\n",
326 safe_fname(partialptr),
327 safe_fname(fname));
329 if (do_rename(partialptr, fname) < 0) {
330 rsyserr(FERROR, errno,
331 "rename failed for %s (from %s)",
332 full_fname(fname),
333 safe_fname(partialptr));
334 } else {
335 if (remove_sent_files
336 || (preserve_hard_links
337 && file->link_u.links)) {
338 SIVAL(numbuf, 0, i);
339 send_msg(MSG_SUCCESS,numbuf,4);
341 handle_partial_dir(partialptr,
342 PDIR_DELETE);
348 static int get_next_gen_i(int batch_gen_fd, int next_gen_i, int desired_i)
350 while (next_gen_i < desired_i) {
351 if (next_gen_i >= 0) {
352 rprintf(FINFO,
353 "(No batched update for%s \"%s\")\n",
354 phase ? " resend of" : "",
355 safe_fname(f_name(the_file_list->files[next_gen_i])));
357 next_gen_i = read_int(batch_gen_fd);
358 if (next_gen_i == -1)
359 next_gen_i = the_file_list->count;
361 return next_gen_i;
366 * main routine for receiver process.
368 * Receiver process runs on the same host as the generator process. */
369 int recv_files(int f_in, struct file_list *flist, char *local_name)
371 int next_gen_i = -1;
372 int fd1,fd2;
373 STRUCT_STAT st;
374 int iflags, xlen;
375 char *fname, fbuf[MAXPATHLEN];
376 char xname[MAXPATHLEN];
377 char fnametmp[MAXPATHLEN];
378 char *fnamecmp, *partialptr, numbuf[4];
379 char fnamecmpbuf[MAXPATHLEN];
380 uchar fnamecmp_type;
381 struct file_struct *file;
382 struct stats initial_stats;
383 int save_make_backups = make_backups;
384 int itemizing = am_daemon ? daemon_log_format_has_i
385 : !am_server && log_format_has_i;
386 int max_phase = protocol_version >= 29 ? 2 : 1;
387 int i, recv_ok;
389 if (verbose > 2)
390 rprintf(FINFO,"recv_files(%d) starting\n",flist->count);
392 if (flist->hlink_pool) {
393 pool_destroy(flist->hlink_pool);
394 flist->hlink_pool = NULL;
397 if (delay_updates)
398 init_delayed_bits(flist->count);
400 while (1) {
401 cleanup_disable();
403 i = read_int(f_in);
404 if (i == -1) {
405 if (read_batch) {
406 get_next_gen_i(batch_gen_fd, next_gen_i,
407 flist->count);
408 next_gen_i = -1;
410 if (++phase > max_phase)
411 break;
412 csum_length = SUM_LENGTH;
413 if (verbose > 2)
414 rprintf(FINFO, "recv_files phase=%d\n", phase);
415 if (phase == 2 && delay_updates)
416 handle_delayed_updates(flist, local_name);
417 send_msg(MSG_DONE, "", 0);
418 if (keep_partial && !partial_dir)
419 make_backups = 0; /* prevents double backup */
420 continue;
423 iflags = read_item_attrs(f_in, -1, i, &fnamecmp_type,
424 xname, &xlen);
425 if (iflags == ITEM_IS_NEW) /* no-op packet */
426 continue;
428 file = flist->files[i];
429 fname = local_name ? local_name : f_name_to(file, fbuf);
431 if (verbose > 2)
432 rprintf(FINFO, "recv_files(%s)\n", safe_fname(fname));
434 if (!(iflags & ITEM_TRANSFER)) {
435 maybe_log_item(file, iflags, itemizing, xname);
436 continue;
438 if (phase == 2) {
439 rprintf(FERROR,
440 "got transfer request in phase 2 [%s]\n",
441 who_am_i());
442 exit_cleanup(RERR_PROTOCOL);
445 stats.current_file_index = i;
446 stats.num_transferred_files++;
447 stats.total_transferred_size += file->length;
448 cleanup_got_literal = 0;
450 if (server_filter_list.head
451 && check_filter(&server_filter_list, fname, 0) < 0) {
452 rprintf(FERROR, "attempt to hack rsync failed.\n");
453 exit_cleanup(RERR_PROTOCOL);
456 if (!do_xfers) { /* log the transfer */
457 if (!am_server && log_format)
458 log_item(file, &stats, iflags, NULL);
459 if (read_batch)
460 discard_receive_data(f_in, file->length);
461 continue;
463 if (write_batch < 0) {
464 log_item(file, &stats, iflags, NULL);
465 if (!am_server)
466 discard_receive_data(f_in, file->length);
467 continue;
470 if (read_batch) {
471 next_gen_i = get_next_gen_i(batch_gen_fd, next_gen_i, i);
472 if (i < next_gen_i) {
473 rprintf(FINFO, "(Skipping batched update for \"%s\")\n",
474 safe_fname(fname));
475 discard_receive_data(f_in, file->length);
476 continue;
478 next_gen_i = -1;
481 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
483 if (protocol_version >= 29) {
484 switch (fnamecmp_type) {
485 case FNAMECMP_FNAME:
486 fnamecmp = fname;
487 break;
488 case FNAMECMP_PARTIAL_DIR:
489 fnamecmp = partialptr;
490 break;
491 case FNAMECMP_BACKUP:
492 fnamecmp = get_backup_name(fname);
493 break;
494 case FNAMECMP_FUZZY:
495 if (file->dirname) {
496 pathjoin(fnamecmpbuf, MAXPATHLEN,
497 file->dirname, xname);
498 fnamecmp = fnamecmpbuf;
499 } else
500 fnamecmp = xname;
501 break;
502 default:
503 if (fnamecmp_type >= basis_dir_cnt) {
504 rprintf(FERROR,
505 "invalid basis_dir index: %d.\n",
506 fnamecmp_type);
507 exit_cleanup(RERR_PROTOCOL);
509 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
510 basis_dir[fnamecmp_type], fname);
511 fnamecmp = fnamecmpbuf;
512 break;
514 if (!fnamecmp || (server_filter_list.head
515 && check_filter(&server_filter_list, fname, 0) < 0))
516 fnamecmp = fname;
517 } else {
518 /* Reminder: --inplace && --partial-dir are never
519 * enabled at the same time. */
520 if (inplace && make_backups) {
521 if (!(fnamecmp = get_backup_name(fname)))
522 fnamecmp = fname;
523 } else if (partial_dir && partialptr)
524 fnamecmp = partialptr;
525 else
526 fnamecmp = fname;
529 initial_stats = stats;
531 /* open the file */
532 fd1 = do_open(fnamecmp, O_RDONLY, 0);
534 if (fd1 == -1 && protocol_version < 29) {
535 if (fnamecmp != fname) {
536 fnamecmp = fname;
537 fd1 = do_open(fnamecmp, O_RDONLY, 0);
540 if (fd1 == -1 && basis_dir[0]) {
541 /* pre-29 allowed only one alternate basis */
542 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
543 basis_dir[0], fname);
544 fnamecmp = fnamecmpbuf;
545 fd1 = do_open(fnamecmp, O_RDONLY, 0);
549 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
550 rsyserr(FERROR, errno, "fstat %s failed",
551 full_fname(fnamecmp));
552 discard_receive_data(f_in, file->length);
553 close(fd1);
554 continue;
557 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
558 /* this special handling for directories
559 * wouldn't be necessary if robust_rename()
560 * and the underlying robust_unlink could cope
561 * with directories
563 rprintf(FERROR,"recv_files: %s is a directory\n",
564 full_fname(fnamecmp));
565 discard_receive_data(f_in, file->length);
566 close(fd1);
567 continue;
570 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
571 close(fd1);
572 fd1 = -1;
575 if (fd1 != -1 && !preserve_perms) {
576 /* if the file exists already and we aren't preserving
577 * permissions then act as though the remote end sent
578 * us the file permissions we already have */
579 file->mode = st.st_mode;
582 /* We now check to see if we are writing file "inplace" */
583 if (inplace) {
584 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0);
585 if (fd2 == -1) {
586 rsyserr(FERROR, errno, "open %s failed",
587 full_fname(fname));
588 discard_receive_data(f_in, file->length);
589 if (fd1 != -1)
590 close(fd1);
591 continue;
593 } else {
594 if (!get_tmpname(fnametmp,fname)) {
595 discard_receive_data(f_in, file->length);
596 if (fd1 != -1)
597 close(fd1);
598 continue;
601 /* we initially set the perms without the
602 * setuid/setgid bits to ensure that there is no race
603 * condition. They are then correctly updated after
604 * the lchown. Thanks to snabb@epipe.fi for pointing
605 * this out. We also set it initially without group
606 * access because of a similar race condition. */
607 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
609 /* in most cases parent directories will already exist
610 * because their information should have been previously
611 * transferred, but that may not be the case with -R */
612 if (fd2 == -1 && relative_paths && errno == ENOENT
613 && create_directory_path(fnametmp, orig_umask) == 0) {
614 /* Get back to name with XXXXXX in it. */
615 get_tmpname(fnametmp, fname);
616 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
618 if (fd2 == -1) {
619 rsyserr(FERROR, errno, "mkstemp %s failed",
620 full_fname(fnametmp));
621 discard_receive_data(f_in, file->length);
622 if (fd1 != -1)
623 close(fd1);
624 continue;
627 if (partialptr)
628 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
631 /* log the transfer */
632 if (log_before_transfer)
633 log_item(file, &initial_stats, iflags, NULL);
634 else if (!am_server && verbose && do_progress)
635 rprintf(FINFO, "%s\n", safe_fname(fname));
637 /* recv file data */
638 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
639 fname, fd2, file->length);
641 if (!log_before_transfer)
642 log_item(file, &initial_stats, iflags, NULL);
644 if (fd1 != -1)
645 close(fd1);
646 if (close(fd2) < 0) {
647 rsyserr(FERROR, errno, "close failed on %s",
648 full_fname(fnametmp));
649 exit_cleanup(RERR_FILEIO);
652 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
653 finish_transfer(fname, fnametmp, file, recv_ok, 1);
654 if (partialptr != fname && fnamecmp == partialptr) {
655 do_unlink(partialptr);
656 handle_partial_dir(partialptr, PDIR_DELETE);
658 } else if (keep_partial && partialptr
659 && handle_partial_dir(partialptr, PDIR_CREATE)) {
660 finish_transfer(partialptr, fnametmp, file, recv_ok,
661 !partial_dir);
662 if (delay_updates && recv_ok) {
663 set_delayed_bit(i);
664 recv_ok = -1;
666 } else {
667 partialptr = NULL;
668 do_unlink(fnametmp);
671 cleanup_disable();
673 if (recv_ok > 0) {
674 if (remove_sent_files
675 || (preserve_hard_links && file->link_u.links)) {
676 SIVAL(numbuf, 0, i);
677 send_msg(MSG_SUCCESS, numbuf, 4);
679 } else if (!recv_ok) {
680 int msgtype = phase || read_batch ? FERROR : FINFO;
681 if (msgtype == FERROR || verbose) {
682 char *errstr, *redostr, *keptstr;
683 if (!(keep_partial && partialptr) && !inplace)
684 keptstr = "discarded";
685 else if (partial_dir)
686 keptstr = "put into partial-dir";
687 else
688 keptstr = "retained";
689 if (msgtype == FERROR) {
690 errstr = "ERROR";
691 redostr = "";
692 } else {
693 errstr = "WARNING";
694 redostr = " (will try again)";
696 rprintf(msgtype,
697 "%s: %s failed verification -- update %s%s.\n",
698 errstr, safe_fname(fname),
699 keptstr, redostr);
701 if (!phase) {
702 SIVAL(numbuf, 0, i);
703 send_msg(MSG_REDO, numbuf, 4);
707 make_backups = save_make_backups;
709 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
710 handle_delayed_updates(flist, local_name);
712 if (verbose > 2)
713 rprintf(FINFO,"recv_files finished\n");
715 return 0;