2 * The startup routines, including main(), for rsync.
4 * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003-2009 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, visit the http://fsf.org website.
26 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
32 extern int io_timeout;
37 extern int inc_recurse;
38 extern int blocking_io;
39 extern int always_checksum;
40 extern int remove_source_files;
41 extern int output_needs_newline;
42 extern int need_messages_from_generator;
43 extern int kluge_around_eof;
44 extern int got_xfer_error;
45 extern int msgs2stderr;
48 extern int copy_links;
49 extern int copy_dirlinks;
50 extern int copy_unsafe_links;
51 extern int keep_dirlinks;
52 extern int preserve_hard_links;
53 extern int protocol_version;
54 extern int file_total;
57 extern int protect_args;
58 extern int relative_paths;
59 extern int sanitize_paths;
60 extern int curr_dir_depth;
61 extern int curr_dir_len;
63 extern int rsync_port;
64 extern int whole_file;
65 extern int read_batch;
66 extern int write_batch;
69 extern int sock_f_out;
70 extern int filesfrom_fd;
71 extern int connect_timeout;
72 extern int send_msgs_to_gen;
73 extern dev_t filesystem_dev;
74 extern pid_t cleanup_child_pid;
75 extern size_t bwlimit_writemax;
76 extern unsigned int module_dirlen;
77 extern BOOL flist_receiving_enabled;
78 extern BOOL shutting_down;
79 extern struct stats stats;
80 extern char *stdout_format;
81 extern char *logfile_format;
82 extern char *filesfrom_host;
83 extern char *partial_dir;
84 extern char *dest_option;
85 extern char *rsync_path;
86 extern char *shell_cmd;
87 extern char *batch_name;
88 extern char *password_file;
89 extern char *backup_dir;
90 extern char curr_dir[MAXPATHLEN];
91 extern char backup_dir_buf[MAXPATHLEN];
92 extern char *basis_dir[MAX_BASIS_DIRS+1];
93 extern struct file_list *first_flist;
94 extern filter_rule_list daemon_filter_list;
98 int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
99 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
100 int local_server = 0;
101 int daemon_over_rsh = 0;
102 mode_t orig_umask = 0;
103 int batch_gen_fd = -1;
104 int sender_keeps_checksum = 0;
106 /* There's probably never more than at most 2 outstanding child processes,
107 * but set it higher, just in case. */
108 #define MAXCHILDPROCS 7
110 #ifdef HAVE_SIGACTION
111 # ifdef HAVE_SIGPROCMASK
112 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
114 # define SIGACTMASK(n,h) SIGACTION(n,h)
116 static struct sigaction sigact;
122 } pid_stat_table[MAXCHILDPROCS];
124 static time_t starttime, endtime;
125 static int64 total_read, total_written;
127 static void show_malloc_stats(void);
129 /* Works like waitpid(), but if we already harvested the child pid in our
130 * remember_children(), we succeed instead of returning an error. */
131 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
136 waited_pid = waitpid(pid, status_ptr, flags);
137 } while (waited_pid == -1 && errno == EINTR);
139 if (waited_pid == -1 && errno == ECHILD) {
140 /* Status of requested child no longer available: check to
141 * see if it was processed by remember_children(). */
143 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
144 if (pid == pid_stat_table[cnt].pid) {
145 *status_ptr = pid_stat_table[cnt].status;
146 pid_stat_table[cnt].pid = 0;
155 /* Wait for a process to exit, calling io_flush while waiting. */
156 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
161 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
163 io_flush(FULL_FLUSH);
166 /* TODO: If the child exited on a signal, then log an
167 * appropriate error message. Perhaps we should also accept a
168 * message describing the purpose of the child. Also indicate
169 * this to the caller so that they know something went wrong. */
170 if (waited_pid < 0) {
171 rsyserr(FERROR, errno, "waitpid");
172 *exit_code_ptr = RERR_WAITCHILD;
173 } else if (!WIFEXITED(status)) {
175 if (WCOREDUMP(status))
176 *exit_code_ptr = RERR_CRASHED;
179 if (WIFSIGNALED(status))
180 *exit_code_ptr = RERR_TERMINATED;
182 *exit_code_ptr = RERR_WAITCHILD;
184 *exit_code_ptr = WEXITSTATUS(status);
187 void write_del_stats(int f)
190 write_int(f, NDX_DEL_STATS);
192 write_ndx(f, NDX_DEL_STATS);
193 write_varint(f, stats.deleted_files - stats.deleted_dirs
194 - stats.deleted_symlinks - stats.deleted_devices
195 - stats.deleted_specials);
196 write_varint(f, stats.deleted_dirs);
197 write_varint(f, stats.deleted_symlinks);
198 write_varint(f, stats.deleted_devices);
199 write_varint(f, stats.deleted_specials);
202 void read_del_stats(int f)
204 stats.deleted_files = read_varint(f);
205 stats.deleted_files += stats.deleted_dirs = read_varint(f);
206 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
207 stats.deleted_files += stats.deleted_devices = read_varint(f);
208 stats.deleted_files += stats.deleted_specials = read_varint(f);
211 /* This function gets called from all 3 processes. We want the client side
212 * to actually output the text, but the sender is the only process that has
213 * all the stats we need. So, if we're a client sender, we do the report.
214 * If we're a server sender, we write the stats on the supplied fd. If
215 * we're the client receiver we read the stats from the supplied fd and do
216 * the report. All processes might also generate a set of debug stats, if
217 * the verbose level is high enough (this is the only thing that the
218 * generator process and the server receiver ever do here). */
219 static void handle_stats(int f)
221 endtime = time(NULL);
223 /* Cache two stats because the read/write code can change it. */
224 total_read = stats.total_read;
225 total_written = stats.total_written;
227 if (INFO_GTE(STATS, 3)) {
228 /* These come out from every process */
237 if (f == -1 || !am_sender)
243 write_varlong30(f, total_read, 3);
244 write_varlong30(f, total_written, 3);
245 write_varlong30(f, stats.total_size, 3);
246 if (protocol_version >= 29) {
247 write_varlong30(f, stats.flist_buildtime, 3);
248 write_varlong30(f, stats.flist_xfertime, 3);
254 /* this is the client */
256 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
258 else if (!am_sender) {
259 /* Read the first two in opposite order because the meaning of
260 * read/write swaps when switching from sender to receiver. */
261 total_written = read_varlong30(f, 3);
262 total_read = read_varlong30(f, 3);
263 stats.total_size = read_varlong30(f, 3);
264 if (protocol_version >= 29) {
265 stats.flist_buildtime = read_varlong30(f, 3);
266 stats.flist_xfertime = read_varlong30(f, 3);
268 } else if (write_batch) {
269 /* The --read-batch process is going to be a client
270 * receiver, so we need to give it the stats. */
271 write_varlong30(batch_fd, total_read, 3);
272 write_varlong30(batch_fd, total_written, 3);
273 write_varlong30(batch_fd, stats.total_size, 3);
274 if (protocol_version >= 29) {
275 write_varlong30(batch_fd, stats.flist_buildtime, 3);
276 write_varlong30(batch_fd, stats.flist_xfertime, 3);
281 static void output_itemized_counts(const char *prefix, int *counts)
283 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
284 char buf[1024], *pre = " (";
286 int total = counts[0];
288 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
289 for (j = 0; j < 5; j++) {
291 len += snprintf(buf+len, sizeof buf - len - 2,
293 pre, labels[j], comma_num(counts[j]));
300 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
303 static void output_summary(void)
305 if (INFO_GTE(STATS, 2)) {
306 rprintf(FCLIENT, "\n");
307 output_itemized_counts("Number of files", &stats.num_files);
308 if (protocol_version >= 29)
309 output_itemized_counts("Number of created files", &stats.created_files);
310 if (protocol_version >= 31)
311 output_itemized_counts("Number of deleted files", &stats.deleted_files);
312 rprintf(FINFO,"Number of regular files transferred: %s\n",
313 comma_num(stats.xferred_files));
314 rprintf(FINFO,"Total file size: %s bytes\n",
315 human_num(stats.total_size));
316 rprintf(FINFO,"Total transferred file size: %s bytes\n",
317 human_num(stats.total_transferred_size));
318 rprintf(FINFO,"Literal data: %s bytes\n",
319 human_num(stats.literal_data));
320 rprintf(FINFO,"Matched data: %s bytes\n",
321 human_num(stats.matched_data));
322 rprintf(FINFO,"File list size: %s\n",
323 human_num(stats.flist_size));
324 if (stats.flist_buildtime) {
326 "File list generation time: %s seconds\n",
327 comma_dnum((double)stats.flist_buildtime / 1000, 3));
329 "File list transfer time: %s seconds\n",
330 comma_dnum((double)stats.flist_xfertime / 1000, 3));
332 rprintf(FINFO,"Total bytes sent: %s\n",
333 human_num(total_written));
334 rprintf(FINFO,"Total bytes received: %s\n",
335 human_num(total_read));
338 if (INFO_GTE(STATS, 1)) {
339 rprintf(FCLIENT, "\n");
341 "sent %s bytes received %s bytes %s bytes/sec\n",
342 human_num(total_written), human_num(total_read),
343 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
344 rprintf(FINFO, "total size is %s speedup is %s%s\n",
345 human_num(stats.total_size),
346 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
347 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
356 * If our C library can get malloc statistics, then show them to FINFO
358 static void show_malloc_stats(void)
365 rprintf(FCLIENT, "\n");
366 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
367 getpid(), am_server ? "server " : "",
368 am_daemon ? "daemon " : "", who_am_i());
369 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
371 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
373 rprintf(FINFO, " smblks: %10ld\n",
375 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
377 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
379 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
380 (long)mi.arena + mi.hblkhd);
381 rprintf(FINFO, " usmblks: %10ld\n",
383 rprintf(FINFO, " fsmblks: %10ld\n",
385 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
387 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
389 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
391 #endif /* HAVE_MALLINFO */
395 /* Start the remote shell. cmd may be NULL to use the default. */
396 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
397 int *f_in_p, int *f_out_p)
400 char *args[MAX_ARGS], *need_to_free = NULL;
404 if (!read_batch && !local_server) {
405 char *t, *f, in_quote = '\0';
406 char *rsh_env = getenv(RSYNC_RSH_ENV);
411 cmd = need_to_free = strdup(cmd);
415 for (t = f = cmd; *f; f++) {
418 /* Comparison leaves rooms for server_options(). */
419 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
422 while (*f != ' ' || in_quote) {
426 "Missing trailing-%c in remote-shell command.\n",
428 exit_cleanup(RERR_SYNTAX);
433 if (*f == '\'' || *f == '"') {
438 if (*f == in_quote && *++f != in_quote) {
448 /* check to see if we've already been given '-l user' in
449 * the remote-shell command */
450 for (i = 0; i < argc-1; i++) {
451 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
456 /* remsh (on HPUX) takes the arguments the other way around */
457 args[argc++] = machine;
458 if (user && !(daemon_over_rsh && dash_l_set)) {
463 if (user && !(daemon_over_rsh && dash_l_set)) {
467 args[argc++] = machine;
470 args[argc++] = rsync_path;
472 if (blocking_io < 0) {
474 if ((cp = strrchr(cmd, '/')) != NULL)
478 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
482 server_options(args,&argc);
484 if (argc >= MAX_ARGS - 2)
490 if (!daemon_over_rsh) {
491 while (remote_argc > 0) {
492 if (argc >= MAX_ARGS - 1) {
494 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
495 exit_cleanup(RERR_SYNTAX);
497 if (**remote_argv == '-') {
498 if (asprintf(args + argc++, "./%s", *remote_argv++) < 0)
499 out_of_memory("do_cmd");
501 args[argc++] = *remote_argv++;
508 if (DEBUG_GTE(CMD, 2)) {
509 for (i = 0; i < argc; i++)
510 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
511 rprintf(FCLIENT, "\n");
515 int from_gen_pipe[2];
516 set_allow_inc_recurse();
517 if (fd_pair(from_gen_pipe) < 0) {
518 rsyserr(FERROR, errno, "pipe");
519 exit_cleanup(RERR_IPC);
521 batch_gen_fd = from_gen_pipe[0];
522 *f_out_p = from_gen_pipe[1];
524 pid = (pid_t)-1; /* no child pid */
528 } else if (local_server) {
529 /* If the user didn't request --[no-]whole-file, force
530 * it on, but only if we're not batch processing. */
531 if (whole_file < 0 && !write_batch)
533 set_allow_inc_recurse();
534 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
539 pid = piped_child(args, f_in_p, f_out_p);
543 if (protect_args && !daemon_over_rsh)
544 send_protected_args(*f_out_p, args);
553 out_of_memory("do_cmd");
554 return 0; /* not reached */
557 /* The receiving side operates in one of two modes:
559 * 1. it receives any number of files into a destination directory,
560 * placing them according to their names in the file-list.
562 * 2. it receives a single file and saves it using the name in the
563 * destination path instead of its file-list name. This requires a
564 * "local name" for writing out the destination file.
566 * So, our task is to figure out what mode/local-name we need.
567 * For mode 1, we change into the destination directory and return NULL.
568 * For mode 2, we change into the directory containing the destination
569 * file (if we aren't already there) and return the local-name. */
570 static char *get_local_name(struct file_list *flist, char *dest_path)
576 if (DEBUG_GTE(RECV, 1)) {
577 rprintf(FINFO, "get_local_name count=%d %s\n",
578 file_total, NS(dest_path));
581 if (!dest_path || list_only)
584 /* Treat an empty string as a copy into the current directory. */
588 if (daemon_filter_list.head) {
589 char *slash = strrchr(dest_path, '/');
590 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
594 if ((*dest_path != '.' || dest_path[1] != '\0')
595 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
596 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
597 rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
599 exit_cleanup(RERR_FILESELECT);
605 /* See what currently exists at the destination. */
606 if ((statret = do_stat(dest_path, &st)) == 0) {
607 /* If the destination is a dir, enter it and use mode 1. */
608 if (S_ISDIR(st.st_mode)) {
609 if (!change_dir(dest_path, CD_NORMAL)) {
610 rsyserr(FERROR, errno, "change_dir#1 %s failed",
611 full_fname(dest_path));
612 exit_cleanup(RERR_FILESELECT);
614 filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
617 if (file_total > 1) {
619 "ERROR: destination must be a directory when"
620 " copying more than 1 file\n");
621 exit_cleanup(RERR_FILESELECT);
623 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
625 "ERROR: cannot overwrite non-directory"
626 " with a directory\n");
627 exit_cleanup(RERR_FILESELECT);
629 } else if (errno != ENOENT) {
630 /* If we don't know what's at the destination, fail. */
631 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
632 full_fname(dest_path));
633 exit_cleanup(RERR_FILESELECT);
636 cp = strrchr(dest_path, '/');
638 /* If we need a destination directory because the transfer is not
639 * of a single non-directory or the user has requested one via a
640 * destination path ending in a slash, create one and use mode 1. */
641 if (file_total > 1 || (cp && !cp[1])) {
642 /* Lop off the final slash (if any). */
648 "ERROR: destination path is not a directory\n");
649 exit_cleanup(RERR_SYNTAX);
652 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
653 rsyserr(FERROR, errno, "mkdir %s failed",
654 full_fname(dest_path));
655 exit_cleanup(RERR_FILEIO);
658 if (flist->high >= flist->low
659 && strcmp(flist->files[flist->low]->basename, ".") == 0)
660 flist->files[0]->flags |= FLAG_DIR_CREATED;
662 if (INFO_GTE(NAME, 1))
663 rprintf(FINFO, "created directory %s\n", dest_path);
666 /* Indicate that dest dir doesn't really exist. */
670 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
671 rsyserr(FERROR, errno, "change_dir#2 %s failed",
672 full_fname(dest_path));
673 exit_cleanup(RERR_FILESELECT);
679 /* Otherwise, we are writing a single file, possibly on top of an
680 * existing non-directory. Change to the item's parent directory
681 * (if it has a path component), return the basename of the
682 * destination file as the local name, and use mode 2. */
690 if (!change_dir(dest_path, CD_NORMAL)) {
691 rsyserr(FERROR, errno, "change_dir#3 %s failed",
692 full_fname(dest_path));
693 exit_cleanup(RERR_FILESELECT);
700 /* This function checks on our alternate-basis directories. If we're in
701 * dry-run mode and the destination dir does not yet exist, we'll try to
702 * tweak any dest-relative paths to make them work for a dry-run (the
703 * destination dir must be in curr_dir[] when this function is called).
704 * We also warn about any arg that is non-existent or not a directory. */
705 static void check_alt_basis_dirs(void)
708 char **dir_p, *slash = strrchr(curr_dir, '/');
710 for (dir_p = basis_dir; *dir_p; dir_p++) {
711 if (dry_run > 1 && **dir_p != '/') {
712 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
713 char *new = new_array(char, len);
715 out_of_memory("check_alt_basis_dirs");
716 if (slash && strncmp(*dir_p, "../", 3) == 0) {
717 /* We want to remove only one leading "../" prefix for
718 * the directory we couldn't create in dry-run mode:
719 * this ensures that any other ".." references get
720 * evaluated the same as they would for a live copy. */
722 pathjoin(new, len, curr_dir, *dir_p + 3);
725 pathjoin(new, len, curr_dir, *dir_p);
728 if (do_stat(*dir_p, &st) < 0) {
729 rprintf(FWARNING, "%s arg does not exist: %s\n",
730 dest_option, *dir_p);
731 } else if (!S_ISDIR(st.st_mode)) {
732 rprintf(FWARNING, "%s arg is not a dir: %s\n",
733 dest_option, *dir_p);
738 /* This is only called by the sender. */
739 static void read_final_goodbye(int f_in, int f_out)
743 char xname[MAXPATHLEN];
745 shutting_down = True;
747 if (protocol_version < 29)
750 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
751 if (protocol_version >= 31 && i == NDX_DONE) {
753 write_ndx(f_out, NDX_DONE);
755 if (batch_gen_fd >= 0) {
756 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
757 read_del_stats(batch_gen_fd);
759 write_int(f_out, NDX_DONE);
761 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
766 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
768 exit_cleanup(RERR_PROTOCOL);
772 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
774 struct file_list *flist;
777 if (DEBUG_GTE(SEND, 1)) {
778 rprintf(FINFO, "server_sender starting pid=%ld\n",
782 if (am_daemon && lp_write_only(module_id)) {
783 rprintf(FERROR, "ERROR: module is write only\n");
784 exit_cleanup(RERR_SYNTAX);
787 if (am_daemon && read_only && remove_source_files) {
789 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
790 remove_source_files == 1 ? "source" : "sent");
791 exit_cleanup(RERR_SYNTAX);
795 if (!relative_paths) {
796 if (!change_dir(dir, CD_NORMAL)) {
797 rsyserr(FERROR, errno, "change_dir#3 %s failed",
799 exit_cleanup(RERR_FILESELECT);
805 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
811 flist = send_file_list(f_out,argc,argv);
812 if (!flist || flist->used == 0)
815 io_start_buffering_in(f_in);
817 send_files(f_in, f_out);
818 io_flush(FULL_FLUSH);
820 if (protocol_version >= 24)
821 read_final_goodbye(f_in, f_out);
822 io_flush(FULL_FLUSH);
827 static int do_recv(int f_in, int f_out, char *local_name)
833 /* The receiving side mustn't obey this, or an existing symlink that
834 * points to an identical file won't be replaced by the referent. */
835 copy_links = copy_dirlinks = copy_unsafe_links = 0;
837 #ifdef SUPPORT_HARD_LINKS
838 if (preserve_hard_links && !inc_recurse)
839 match_hard_links(first_flist);
842 if (fd_pair(error_pipe) < 0) {
843 rsyserr(FERROR, errno, "pipe failed in do_recv");
844 exit_cleanup(RERR_IPC);
848 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
850 exit_cleanup(RERR_SYNTAX);
852 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
853 else if (INFO_GTE(BACKUP, 1))
854 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
857 io_flush(FULL_FLUSH);
859 if ((pid = do_fork()) == -1) {
860 rsyserr(FERROR, errno, "fork failed in do_recv");
861 exit_cleanup(RERR_IPC);
866 send_msgs_to_gen = am_server;
868 close(error_pipe[0]);
870 /* We can't let two processes write to the socket at one time. */
871 io_end_multiplex_out(MPLX_SWITCHING);
875 f_out = error_pipe[1];
877 bwlimit_writemax = 0; /* receiver doesn't need to do this */
880 io_start_buffering_in(f_in);
881 io_start_multiplex_out(f_out);
883 recv_files(f_in, f_out, local_name);
884 io_flush(FULL_FLUSH);
887 if (output_needs_newline) {
889 output_needs_newline = 0;
892 write_int(f_out, NDX_DONE);
893 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
894 io_flush(FULL_FLUSH);
896 /* Handle any keep-alive packets from the post-processing work
897 * that the generator does. */
898 if (protocol_version >= 29) {
899 kluge_around_eof = -1;
901 /* This should only get stopped via a USR2 signal. */
902 read_final_goodbye(f_in, f_out);
904 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
906 exit_cleanup(RERR_PROTOCOL);
909 /* Finally, we go to sleep until our parent kills us with a
910 * USR2 signal. We sleep for a short time, as on some OSes
911 * a signal won't interrupt a sleep! */
917 flist_receiving_enabled = True;
919 io_end_multiplex_in(MPLX_SWITCHING);
920 if (write_batch && !am_server)
923 close(error_pipe[1]);
927 f_in = error_pipe[0];
929 io_start_buffering_out(f_out);
930 io_start_multiplex_in(f_in);
932 #ifdef SUPPORT_HARD_LINKS
933 if (preserve_hard_links && inc_recurse) {
934 struct file_list *flist;
935 for (flist = first_flist; flist; flist = flist->next)
936 match_hard_links(flist);
940 generate_files(f_out, local_name);
943 io_flush(FULL_FLUSH);
944 shutting_down = True;
945 if (protocol_version >= 24) {
946 /* send a final goodbye message */
947 write_ndx(f_out, NDX_DONE);
949 io_flush(FULL_FLUSH);
952 wait_process_with_flush(pid, &exit_code);
956 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
959 struct file_list *flist;
960 char *local_name = NULL;
963 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
964 /* We can't mix messages with files-from data on the socket,
965 * so temporarily turn off info/debug messages. */
966 negate_output_levels();
971 if (DEBUG_GTE(RECV, 1)) {
972 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
973 argc, (long)getpid());
976 if (am_daemon && read_only) {
977 rprintf(FERROR,"ERROR: module is read only\n");
978 exit_cleanup(RERR_SYNTAX);
986 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
987 rsyserr(FERROR, errno, "change_dir#4 %s failed",
989 exit_cleanup(RERR_FILESELECT);
993 if (protocol_version >= 30)
994 io_start_multiplex_in(f_in);
996 io_start_buffering_in(f_in);
997 recv_filter_list(f_in);
999 if (filesfrom_fd >= 0) {
1000 /* We need to send the files-from names to the sender at the
1001 * same time that we receive the file-list from them, so we
1002 * need the IO routines to automatically write out the names
1003 * onto our f_out socket as we read the file-list. This
1004 * avoids both deadlock and extra delays/buffers. */
1005 start_filesfrom_forwarding(filesfrom_fd);
1009 flist = recv_file_list(f_in);
1011 rprintf(FERROR,"server_recv: recv_file_list error\n");
1012 exit_cleanup(RERR_FILESELECT);
1014 if (inc_recurse && file_total == 1)
1015 recv_additional_file_list(f_in);
1018 negate_output_levels();
1021 local_name = get_local_name(flist,argv[0]);
1023 /* Now that we know what our destination directory turned out to be,
1024 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1025 if (sanitize_paths) {
1027 for (dir_p = basis_dir; *dir_p; dir_p++)
1028 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1030 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1032 check_alt_basis_dirs();
1034 if (daemon_filter_list.head) {
1036 filter_rule_list *elp = &daemon_filter_list;
1038 for (dir_p = basis_dir; *dir_p; dir_p++) {
1041 dir += module_dirlen;
1042 if (check_filter(elp, FLOG, dir, 1) < 0)
1043 goto options_rejected;
1045 if (partial_dir && *partial_dir == '/'
1046 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1049 "Your options have been rejected by the server.\n");
1050 exit_cleanup(RERR_SYNTAX);
1054 exit_code = do_recv(f_in, f_out, local_name);
1055 exit_cleanup(exit_code);
1059 int child_main(int argc, char *argv[])
1061 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1066 void start_server(int f_in, int f_out, int argc, char *argv[])
1068 set_nonblocking(f_in);
1069 set_nonblocking(f_out);
1071 io_set_sock_fds(f_in, f_out);
1072 setup_protocol(f_out, f_in);
1074 if (protocol_version >= 23)
1075 io_start_multiplex_out(f_out);
1076 if (am_daemon && io_timeout && protocol_version >= 31)
1077 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1080 keep_dirlinks = 0; /* Must be disabled on the sender. */
1081 if (need_messages_from_generator)
1082 io_start_multiplex_in(f_in);
1084 io_start_buffering_in(f_in);
1085 recv_filter_list(f_in);
1086 do_server_sender(f_in, f_out, argc, argv);
1088 do_server_recv(f_in, f_out, argc, argv);
1092 /* This is called once the connection has been negotiated. It is used
1093 * for rsyncd, remote-shell, and local connections. */
1094 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1096 struct file_list *flist = NULL;
1097 int exit_code = 0, exit_code2 = 0;
1098 char *local_name = NULL;
1100 cleanup_child_pid = pid;
1102 set_nonblocking(f_in);
1103 set_nonblocking(f_out);
1106 io_set_sock_fds(f_in, f_out);
1107 setup_protocol(f_out,f_in);
1109 /* We set our stderr file handle to blocking because ssh might have
1110 * set it to non-blocking. This can be particularly troublesome if
1111 * stderr is a clone of stdout, because ssh would have set our stdout
1112 * to non-blocking at the same time (which can easily cause us to lose
1113 * output from our print statements). This kluge shouldn't cause ssh
1114 * any problems for how we use it. Note also that we delayed setting
1115 * this until after the above protocol setup so that we know for sure
1116 * that ssh is done twiddling its file descriptors. */
1117 set_blocking(STDERR_FILENO);
1120 keep_dirlinks = 0; /* Must be disabled on the sender. */
1123 && (log_format_has(stdout_format, 'C')
1124 || log_format_has(logfile_format, 'C')))
1125 sender_keeps_checksum = 1;
1127 if (protocol_version >= 30)
1128 io_start_multiplex_out(f_out);
1130 io_start_buffering_out(f_out);
1131 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1132 io_start_multiplex_in(f_in);
1134 io_start_buffering_in(f_in);
1135 send_filter_list(f_out);
1137 filesfrom_fd = f_in;
1139 if (write_batch && !am_server)
1140 start_write_batch(f_out);
1141 flist = send_file_list(f_out, argc, argv);
1142 if (DEBUG_GTE(FLIST, 3))
1143 rprintf(FINFO,"file list sent\n");
1145 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1146 io_start_multiplex_in(f_in);
1148 io_flush(NORMAL_FLUSH);
1149 send_files(f_in, f_out);
1150 io_flush(FULL_FLUSH);
1152 if (protocol_version >= 24)
1153 read_final_goodbye(f_in, f_out);
1155 if (DEBUG_GTE(EXIT, 2))
1156 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1157 io_flush(FULL_FLUSH);
1158 wait_process_with_flush(pid, &exit_code);
1161 io_flush(FULL_FLUSH);
1162 exit_cleanup(exit_code);
1166 if (protocol_version >= 23)
1167 io_start_multiplex_in(f_in);
1168 if (need_messages_from_generator)
1169 io_start_multiplex_out(f_out);
1171 io_start_buffering_out(f_out);
1174 send_filter_list(read_batch ? -1 : f_out);
1176 if (filesfrom_fd >= 0) {
1177 start_filesfrom_forwarding(filesfrom_fd);
1181 if (write_batch && !am_server)
1182 start_write_batch(f_in);
1183 flist = recv_file_list(f_in);
1184 if (inc_recurse && file_total == 1)
1185 recv_additional_file_list(f_in);
1187 if (flist && flist->used > 0) {
1188 local_name = get_local_name(flist, argv[0]);
1190 check_alt_basis_dirs();
1192 exit_code2 = do_recv(f_in, f_out, local_name);
1199 if (DEBUG_GTE(RECV, 1))
1200 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1201 io_flush(FULL_FLUSH);
1202 wait_process_with_flush(pid, &exit_code);
1205 return MAX(exit_code, exit_code2);
1208 static int copy_argv(char *argv[])
1212 for (i = 0; argv[i]; i++) {
1213 if (!(argv[i] = strdup(argv[i]))) {
1214 rprintf (FERROR, "out of memory at %s(%d)\n",
1215 __FILE__, __LINE__);
1224 /* Start a client for either type of remote connection. Work out
1225 * whether the arguments request a remote shell or rsyncd connection,
1226 * and call the appropriate connection function, then run_client.
1228 * Calls either start_socket_client (for sockets) or do_cmd and
1229 * client_run (for ssh). */
1230 static int start_client(int argc, char *argv[])
1232 char *p, *shell_machine = NULL, *shell_user = NULL;
1239 /* Don't clobber argv[] so that ps(1) can still show the right
1241 if ((ret = copy_argv(argv)) != 0)
1244 if (!read_batch) { /* for read_batch, NO source is specified */
1245 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1246 if (path) { /* source is remote */
1253 if (argc == 1 || **argv == ':')
1254 argc = 0; /* no dest arg */
1255 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1257 "The source and destination cannot both be remote.\n");
1258 exit_cleanup(RERR_SYNTAX);
1260 remote_argc--; /* don't count dest */
1263 if (filesfrom_host && *filesfrom_host
1264 && strcmp(filesfrom_host, shell_machine) != 0) {
1266 "--files-from hostname is not the same as the transfer hostname\n");
1267 exit_cleanup(RERR_SYNTAX);
1271 daemon_over_rsh = shell_cmd ? 1 : -1;
1272 } else { /* source is local, check dest arg */
1277 remote_argv = argv + argc;
1279 static char *dotarg[1] = { "." };
1281 remote_argv = dotarg;
1285 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1286 if (path && filesfrom_host && *filesfrom_host
1287 && strcmp(filesfrom_host, shell_machine) != 0) {
1289 "--files-from hostname is not the same as the transfer hostname\n");
1290 exit_cleanup(RERR_SYNTAX);
1292 if (!path) { /* no hostspec found, so src & dest are local */
1294 if (filesfrom_host) {
1296 "--files-from cannot be remote when the transfer is local\n");
1297 exit_cleanup(RERR_SYNTAX);
1299 shell_machine = NULL;
1300 } else { /* hostspec was found, so dest is remote */
1303 daemon_over_rsh = shell_cmd ? 1 : -1;
1306 } else { /* read_batch */
1308 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1309 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1310 exit_cleanup(RERR_SYNTAX);
1312 remote_argv = argv += argc - 1;
1313 remote_argc = argc = 1;
1316 if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1321 int dummy_port = rsync_port;
1323 /* For local source, extra source args must not have hostspec. */
1324 for (i = 1; i < argc; i++) {
1325 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1326 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1327 exit_cleanup(RERR_SYNTAX);
1332 int dummy_port = rsync_port;
1334 /* For remote source, any extra source args must have either
1335 * the same hostname or an empty hostname. */
1336 for (i = 1; i < remote_argc; i++) {
1337 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1339 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1340 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1341 exit_cleanup(RERR_SYNTAX);
1343 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1344 rprintf(FERROR, "All source args must come from the same machine.\n");
1345 exit_cleanup(RERR_SYNTAX);
1347 if (rsync_port != dummy_port) {
1348 if (!rsync_port || !dummy_port)
1349 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1351 rprintf(FERROR, "All source args must use the same port number.\n");
1352 exit_cleanup(RERR_SYNTAX);
1354 if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1356 remote_argv[i] = arg;
1360 if (daemon_over_rsh < 0)
1361 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1363 if (password_file && !daemon_over_rsh) {
1364 rprintf(FERROR, "The --password-file option may only be "
1365 "used when accessing an rsync daemon.\n");
1366 exit_cleanup(RERR_SYNTAX);
1369 if (connect_timeout) {
1370 rprintf(FERROR, "The --contimeout option may only be "
1371 "used when connecting to an rsync daemon.\n");
1372 exit_cleanup(RERR_SYNTAX);
1375 if (shell_machine) {
1376 p = strrchr(shell_machine,'@');
1379 shell_user = shell_machine;
1380 shell_machine = p+1;
1384 if (DEBUG_GTE(CMD, 2)) {
1385 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1386 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1387 NS(remote_argv[0]));
1390 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1393 /* if we're running an rsync server on the remote host over a
1394 * remote shell command, we need to do the RSYNCD protocol first */
1395 if (daemon_over_rsh) {
1397 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1402 ret = client_run(f_in, f_out, pid, argc, argv);
1411 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1413 exit_cleanup(RERR_SIGNAL1);
1416 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1422 _exit(RERR_PARTIAL);
1426 RETSIGTYPE remember_children(UNUSED(int val))
1431 /* An empty waitpid() loop was put here by Tridge and we could never
1432 * get him to explain why he put it in, so rather than taking it
1433 * out we're instead saving the child exit statuses for later use.
1434 * The waitpid() loop presumably eliminates all possibility of leaving
1435 * zombie children, maybe that's why he did it. */
1436 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1437 /* save the child's exit status */
1438 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1439 if (pid_stat_table[cnt].pid == 0) {
1440 pid_stat_table[cnt].pid = pid;
1441 pid_stat_table[cnt].status = status;
1447 #ifndef HAVE_SIGACTION
1448 signal(SIGCHLD, remember_children);
1454 * This routine catches signals and tries to send them to gdb.
1456 * Because it's called from inside a signal handler it ought not to
1457 * use too many library routines.
1459 * @todo Perhaps use "screen -X" instead/as well, to help people
1460 * debugging without easy access to X. Perhaps use an environment
1461 * variable, or just call a script?
1463 * @todo The /proc/ magic probably only works on Linux (and
1464 * Solaris?) Can we be more portable?
1466 #ifdef MAINTAINER_MODE
1467 const char *get_panic_action(void)
1469 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1474 return "xterm -display :0 -T Panic -n Panic "
1475 "-e gdb /proc/%d/exe %d";
1480 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1482 * This signal handler is only installed if we were configured with
1483 * --enable-maintainer-mode. Perhaps it should always be on and we
1484 * should just look at the environment variable, but I'm a bit leery
1485 * of a signal sending us into a busy loop.
1487 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1492 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1493 getpid(), getpid());
1495 /* Unless we failed to execute gdb, we allow the process to
1496 * continue. I'm not sure if that's right. */
1497 ret = system(cmd_buf);
1504 int main(int argc,char *argv[])
1507 int orig_argc = argc;
1508 char **orig_argv = argv;
1509 #ifdef HAVE_SIGACTION
1510 # ifdef HAVE_SIGPROCMASK
1513 sigemptyset(&sigmask);
1515 sigact.sa_flags = SA_NOCLDSTOP;
1517 SIGACTMASK(SIGUSR1, sigusr1_handler);
1518 SIGACTMASK(SIGUSR2, sigusr2_handler);
1519 SIGACTMASK(SIGCHLD, remember_children);
1520 #ifdef MAINTAINER_MODE
1521 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1522 SIGACTMASK(SIGFPE, rsync_panic_handler);
1523 SIGACTMASK(SIGABRT, rsync_panic_handler);
1524 SIGACTMASK(SIGBUS, rsync_panic_handler);
1527 starttime = time(NULL);
1530 am_root = our_uid == 0;
1532 memset(&stats, 0, sizeof(stats));
1536 exit_cleanup(RERR_SYNTAX);
1539 /* Get the umask for use in permission calculations. We no longer set
1540 * it to zero; that is ugly and pointless now that all the callers that
1541 * relied on it have been reeducated to work with default ACLs. */
1542 umask(orig_umask = umask(0));
1544 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1545 setlocale(LC_CTYPE, "");
1548 if (!parse_arguments(&argc, (const char ***) &argv)) {
1549 /* FIXME: We ought to call the same error-handling
1550 * code here, rather than relying on getopt. */
1552 exit_cleanup(RERR_SYNTAX);
1555 SIGACTMASK(SIGINT, sig_int);
1556 SIGACTMASK(SIGHUP, sig_int);
1557 SIGACTMASK(SIGTERM, sig_int);
1558 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1559 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1562 /* Ignore SIGPIPE; we consistently check error codes and will
1564 SIGACTION(SIGPIPE, SIG_IGN);
1566 SIGACTION(SIGXFSZ, SIG_IGN);
1569 /* Initialize change_dir() here because on some old systems getcwd
1570 * (implemented by forking "pwd" and reading its output) doesn't
1571 * work when there are other child processes. Also, on all systems
1572 * that implement getcwd that way "pwd" can't be found after chroot. */
1573 change_dir(NULL, CD_NORMAL);
1577 if ((write_batch || read_batch) && !am_server) {
1579 write_batch_shell_file(orig_argc, orig_argv, argc);
1581 if (read_batch && strcmp(batch_name, "-") == 0)
1582 batch_fd = STDIN_FILENO;
1584 batch_fd = do_open(batch_name,
1585 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1586 : O_RDONLY, S_IRUSR | S_IWUSR);
1589 rsyserr(FERROR, errno, "Batch file %s open error",
1590 full_fname(batch_name));
1591 exit_cleanup(RERR_FILEIO);
1594 read_stream_flags(batch_fd);
1596 write_stream_flags(batch_fd);
1598 if (write_batch < 0)
1605 } else if (am_daemon)
1606 return daemon_main();
1608 if (am_server && protect_args) {
1609 char buf[MAXPATHLEN];
1611 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1612 if (!parse_arguments(&argc, (const char ***) &argv)) {
1614 exit_cleanup(RERR_SYNTAX);
1620 exit_cleanup(RERR_SYNTAX);
1624 set_nonblocking(STDIN_FILENO);
1625 set_nonblocking(STDOUT_FILENO);
1627 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1628 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1631 ret = start_client(argc, argv);
1633 exit_cleanup(RERR_STARTCLIENT);