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-2008 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
36 extern int am_generator;
38 extern int inc_recurse;
39 extern int blocking_io;
40 extern int remove_source_files;
41 extern int need_messages_from_generator;
42 extern int kluge_around_eof;
44 extern int got_xfer_error;
46 extern int copy_links;
47 extern int copy_dirlinks;
48 extern int copy_unsafe_links;
49 extern int keep_dirlinks;
50 extern int preserve_hard_links;
51 extern int protocol_version;
52 extern int file_total;
55 extern int protect_args;
56 extern int relative_paths;
57 extern int sanitize_paths;
58 extern int curr_dir_depth;
59 extern int curr_dir_len;
61 extern int rsync_port;
62 extern int whole_file;
63 extern int read_batch;
64 extern int write_batch;
66 extern int filesfrom_fd;
67 extern int connect_timeout;
68 extern pid_t cleanup_child_pid;
69 extern unsigned int module_dirlen;
70 extern struct stats stats;
71 extern char *filesfrom_host;
72 extern char *partial_dir;
73 extern char *dest_option;
74 extern char *basis_dir[];
75 extern char *rsync_path;
76 extern char *shell_cmd;
77 extern char *batch_name;
78 extern char *password_file;
79 extern char curr_dir[MAXPATHLEN];
80 extern struct file_list *first_flist;
81 extern struct filter_list_struct server_filter_list;
85 int daemon_over_rsh = 0;
86 mode_t orig_umask = 0;
87 int batch_gen_fd = -1;
89 /* There's probably never more than at most 2 outstanding child processes,
90 * but set it higher, just in case. */
91 #define MAXCHILDPROCS 7
94 # ifdef HAVE_SIGPROCMASK
95 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
97 # define SIGACTMASK(n,h) SIGACTION(n,h)
99 static struct sigaction sigact;
105 } pid_stat_table[MAXCHILDPROCS];
107 static time_t starttime, endtime;
108 static int64 total_read, total_written;
110 static void show_malloc_stats(void);
112 /* Works like waitpid(), but if we already harvested the child pid in our
113 * remember_children(), we succeed instead of returning an error. */
114 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
119 waited_pid = waitpid(pid, status_ptr, flags);
120 } while (waited_pid == -1 && errno == EINTR);
122 if (waited_pid == -1 && errno == ECHILD) {
123 /* Status of requested child no longer available: check to
124 * see if it was processed by remember_children(). */
126 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
127 if (pid == pid_stat_table[cnt].pid) {
128 *status_ptr = pid_stat_table[cnt].status;
129 pid_stat_table[cnt].pid = 0;
138 /* Wait for a process to exit, calling io_flush while waiting. */
139 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
144 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
146 io_flush(FULL_FLUSH);
149 /* TODO: If the child exited on a signal, then log an
150 * appropriate error message. Perhaps we should also accept a
151 * message describing the purpose of the child. Also indicate
152 * this to the caller so that they know something went wrong. */
153 if (waited_pid < 0) {
154 rsyserr(FERROR, errno, "waitpid");
155 *exit_code_ptr = RERR_WAITCHILD;
156 } else if (!WIFEXITED(status)) {
158 if (WCOREDUMP(status))
159 *exit_code_ptr = RERR_CRASHED;
162 if (WIFSIGNALED(status))
163 *exit_code_ptr = RERR_TERMINATED;
165 *exit_code_ptr = RERR_WAITCHILD;
167 *exit_code_ptr = WEXITSTATUS(status);
170 /* This function gets called from all 3 processes. We want the client side
171 * to actually output the text, but the sender is the only process that has
172 * all the stats we need. So, if we're a client sender, we do the report.
173 * If we're a server sender, we write the stats on the supplied fd. If
174 * we're the client receiver we read the stats from the supplied fd and do
175 * the report. All processes might also generate a set of debug stats, if
176 * the verbose level is high enough (this is the only thing that the
177 * generator process and the server receiver ever do here). */
178 static void handle_stats(int f)
180 endtime = time(NULL);
182 /* Cache two stats because the read/write code can change it. */
183 total_read = stats.total_read;
184 total_written = stats.total_written;
186 if (do_stats && verbose > 1) {
187 /* These come out from every process */
196 if (f == -1 || !am_sender)
202 write_varlong30(f, total_read, 3);
203 write_varlong30(f, total_written, 3);
204 write_varlong30(f, stats.total_size, 3);
205 if (protocol_version >= 29) {
206 write_varlong30(f, stats.flist_buildtime, 3);
207 write_varlong30(f, stats.flist_xfertime, 3);
213 /* this is the client */
215 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
217 else if (!am_sender) {
218 /* Read the first two in opposite order because the meaning of
219 * read/write swaps when switching from sender to receiver. */
220 total_written = read_varlong30(f, 3);
221 total_read = read_varlong30(f, 3);
222 stats.total_size = read_varlong30(f, 3);
223 if (protocol_version >= 29) {
224 stats.flist_buildtime = read_varlong30(f, 3);
225 stats.flist_xfertime = read_varlong30(f, 3);
227 } else if (write_batch) {
228 /* The --read-batch process is going to be a client
229 * receiver, so we need to give it the stats. */
230 write_varlong30(batch_fd, total_read, 3);
231 write_varlong30(batch_fd, total_written, 3);
232 write_varlong30(batch_fd, stats.total_size, 3);
233 if (protocol_version >= 29) {
234 write_varlong30(batch_fd, stats.flist_buildtime, 3);
235 write_varlong30(batch_fd, stats.flist_xfertime, 3);
240 static void output_summary(void)
243 rprintf(FCLIENT, "\n");
244 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
245 rprintf(FINFO,"Number of files transferred: %d\n",
246 stats.num_transferred_files);
247 rprintf(FINFO,"Total file size: %s bytes\n",
248 human_num(stats.total_size));
249 rprintf(FINFO,"Total transferred file size: %s bytes\n",
250 human_num(stats.total_transferred_size));
251 rprintf(FINFO,"Literal data: %s bytes\n",
252 human_num(stats.literal_data));
253 rprintf(FINFO,"Matched data: %s bytes\n",
254 human_num(stats.matched_data));
255 rprintf(FINFO,"File list size: %s\n",
256 human_num(stats.flist_size));
257 if (stats.flist_buildtime) {
259 "File list generation time: %.3f seconds\n",
260 (double)stats.flist_buildtime / 1000);
262 "File list transfer time: %.3f seconds\n",
263 (double)stats.flist_xfertime / 1000);
265 rprintf(FINFO,"Total bytes sent: %s\n",
266 human_num(total_written));
267 rprintf(FINFO,"Total bytes received: %s\n",
268 human_num(total_read));
271 if (verbose || do_stats) {
272 rprintf(FCLIENT, "\n");
274 "sent %s bytes received %s bytes %s bytes/sec\n",
275 human_num(total_written), human_num(total_read),
276 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
277 rprintf(FINFO, "total size is %s speedup is %.2f%s\n",
278 human_num(stats.total_size),
279 (double)stats.total_size / (total_written+total_read),
280 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
289 * If our C library can get malloc statistics, then show them to FINFO
291 static void show_malloc_stats(void)
298 rprintf(FCLIENT, "\n");
299 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
300 getpid(), am_server ? "server " : "",
301 am_daemon ? "daemon " : "", who_am_i());
302 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
304 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
306 rprintf(FINFO, " smblks: %10ld\n",
308 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
310 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
312 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
313 (long)mi.arena + mi.hblkhd);
314 rprintf(FINFO, " usmblks: %10ld\n",
316 rprintf(FINFO, " fsmblks: %10ld\n",
318 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
320 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
322 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
324 #endif /* HAVE_MALLINFO */
328 /* Start the remote shell. cmd may be NULL to use the default. */
329 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
330 int *f_in_p, int *f_out_p)
333 char *args[MAX_ARGS];
337 if (!read_batch && !local_server) {
338 char *t, *f, in_quote = '\0';
339 char *rsh_env = getenv(RSYNC_RSH_ENV);
348 for (t = f = cmd; *f; f++) {
351 /* Comparison leaves rooms for server_options(). */
352 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
355 while (*f != ' ' || in_quote) {
359 "Missing trailing-%c in remote-shell command.\n",
361 exit_cleanup(RERR_SYNTAX);
366 if (*f == '\'' || *f == '"') {
371 if (*f == in_quote && *++f != in_quote) {
381 /* check to see if we've already been given '-l user' in
382 * the remote-shell command */
383 for (i = 0; i < argc-1; i++) {
384 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
389 /* remsh (on HPUX) takes the arguments the other way around */
390 args[argc++] = machine;
391 if (user && !(daemon_over_rsh && dash_l_set)) {
396 if (user && !(daemon_over_rsh && dash_l_set)) {
400 args[argc++] = machine;
403 args[argc++] = rsync_path;
405 if (blocking_io < 0) {
407 if ((cp = strrchr(cmd, '/')) != NULL)
411 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
415 server_options(args,&argc);
417 if (argc >= MAX_ARGS - 2)
423 if (!daemon_over_rsh) {
424 while (remote_argc > 0) {
425 if (argc >= MAX_ARGS - 1) {
427 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
428 exit_cleanup(RERR_SYNTAX);
430 args[argc++] = *remote_argv++;
438 for (i = 0; i < argc; i++)
439 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
440 rprintf(FCLIENT, "\n");
444 int from_gen_pipe[2];
445 set_allow_inc_recurse();
446 if (fd_pair(from_gen_pipe) < 0) {
447 rsyserr(FERROR, errno, "pipe");
448 exit_cleanup(RERR_IPC);
450 batch_gen_fd = from_gen_pipe[0];
451 *f_out_p = from_gen_pipe[1];
453 pid = (pid_t)-1; /* no child pid */
457 } else if (local_server) {
458 /* If the user didn't request --[no-]whole-file, force
459 * it on, but only if we're not batch processing. */
460 if (whole_file < 0 && !write_batch)
462 set_allow_inc_recurse();
463 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
468 pid = piped_child(args, f_in_p, f_out_p);
473 send_protected_args(*f_out_p, args);
479 out_of_memory("do_cmd");
480 return 0; /* not reached */
483 /* The receiving side operates in one of two modes:
485 * 1. it receives any number of files into a destination directory,
486 * placing them according to their names in the file-list.
488 * 2. it receives a single file and saves it using the name in the
489 * destination path instead of its file-list name. This requires a
490 * "local name" for writing out the destination file.
492 * So, our task is to figure out what mode/local-name we need.
493 * For mode 1, we change into the destination directory and return NULL.
494 * For mode 2, we change into the directory containing the destination
495 * file (if we aren't already there) and return the local-name. */
496 static char *get_local_name(struct file_list *flist, char *dest_path)
503 rprintf(FINFO, "get_local_name count=%d %s\n",
504 file_total, NS(dest_path));
507 if (!dest_path || list_only)
510 /* See what currently exists at the destination. */
511 if ((statret = do_stat(dest_path, &st)) == 0) {
512 /* If the destination is a dir, enter it and use mode 1. */
513 if (S_ISDIR(st.st_mode)) {
514 if (!push_dir(dest_path, 0)) {
515 rsyserr(FERROR, errno, "push_dir#1 %s failed",
516 full_fname(dest_path));
517 exit_cleanup(RERR_FILESELECT);
521 if (file_total > 1) {
523 "ERROR: destination must be a directory when"
524 " copying more than 1 file\n");
525 exit_cleanup(RERR_FILESELECT);
527 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
529 "ERROR: cannot overwrite non-directory"
530 " with a directory\n");
531 exit_cleanup(RERR_FILESELECT);
533 } else if (errno != ENOENT) {
534 /* If we don't know what's at the destination, fail. */
535 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
536 full_fname(dest_path));
537 exit_cleanup(RERR_FILESELECT);
540 cp = strrchr(dest_path, '/');
542 /* If we need a destination directory because the transfer is not
543 * of a single non-directory or the user has requested one via a
544 * destination path ending in a slash, create one and use mode 1. */
545 if (file_total > 1 || (cp && !cp[1])) {
546 /* Lop off the final slash (if any). */
552 "ERROR: destination path is not a directory\n");
553 exit_cleanup(RERR_SYNTAX);
556 if (mkdir_defmode(dest_path) != 0) {
557 rsyserr(FERROR, errno, "mkdir %s failed",
558 full_fname(dest_path));
559 exit_cleanup(RERR_FILEIO);
562 if (flist->high >= flist->low
563 && strcmp(flist->files[flist->low]->basename, ".") == 0)
564 flist->files[0]->flags |= FLAG_DIR_CREATED;
567 rprintf(FINFO, "created directory %s\n", dest_path);
570 /* Indicate that dest dir doesn't really exist. */
574 if (!push_dir(dest_path, dry_run > 1)) {
575 rsyserr(FERROR, errno, "push_dir#2 %s failed",
576 full_fname(dest_path));
577 exit_cleanup(RERR_FILESELECT);
583 /* Otherwise, we are writing a single file, possibly on top of an
584 * existing non-directory. Change to the item's parent directory
585 * (if it has a path component), return the basename of the
586 * destination file as the local name, and use mode 2. */
594 if (!push_dir(dest_path, 0)) {
595 rsyserr(FERROR, errno, "push_dir#3 %s failed",
596 full_fname(dest_path));
597 exit_cleanup(RERR_FILESELECT);
604 /* This function checks on our alternate-basis directories. If we're in
605 * dry-run mode and the destination dir does not yet exist, we'll try to
606 * tweak any dest-relative paths to make them work for a dry-run (the
607 * destination dir must be in curr_dir[] when this function is called).
608 * We also warn about any arg that is non-existent or not a directory. */
609 static void check_alt_basis_dirs(void)
612 char **dir_p, *slash = strrchr(curr_dir, '/');
614 for (dir_p = basis_dir; *dir_p; dir_p++) {
615 if (dry_run > 1 && **dir_p != '/') {
616 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
617 char *new = new_array(char, len);
619 out_of_memory("check_alt_basis_dirs");
620 if (slash && strncmp(*dir_p, "../", 3) == 0) {
621 /* We want to remove only one leading "../" prefix for
622 * the directory we couldn't create in dry-run mode:
623 * this ensures that any other ".." references get
624 * evaluated the same as they would for a live copy. */
626 pathjoin(new, len, curr_dir, *dir_p + 3);
629 pathjoin(new, len, curr_dir, *dir_p);
632 if (do_stat(*dir_p, &st) < 0) {
633 rprintf(FWARNING, "%s arg does not exist: %s\n",
634 dest_option, *dir_p);
635 } else if (!S_ISDIR(st.st_mode)) {
636 rprintf(FWARNING, "%s arg is not a dir: %s\n",
637 dest_option, *dir_p);
642 /* This is only called by the sender. */
643 static void read_final_goodbye(int f_in)
647 char xname[MAXPATHLEN];
649 if (protocol_version < 29)
652 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
657 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
659 exit_cleanup(RERR_PROTOCOL);
663 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
665 struct file_list *flist;
669 rprintf(FINFO, "server_sender starting pid=%ld\n",
673 if (am_daemon && lp_write_only(module_id)) {
674 rprintf(FERROR, "ERROR: module is write only\n");
675 exit_cleanup(RERR_SYNTAX);
678 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
680 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
681 remove_source_files == 1 ? "source" : "sent");
682 exit_cleanup(RERR_SYNTAX);
686 if (!relative_paths) {
687 if (!push_dir(dir, 0)) {
688 rsyserr(FERROR, errno, "push_dir#3 %s failed",
690 exit_cleanup(RERR_FILESELECT);
696 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
702 flist = send_file_list(f_out,argc,argv);
703 if (!flist || flist->used == 0)
706 io_start_buffering_in(f_in);
708 send_files(f_in, f_out);
709 io_flush(FULL_FLUSH);
711 if (protocol_version >= 24)
712 read_final_goodbye(f_in);
713 io_flush(FULL_FLUSH);
718 static int do_recv(int f_in, int f_out, char *local_name)
724 /* The receiving side mustn't obey this, or an existing symlink that
725 * points to an identical file won't be replaced by the referent. */
726 copy_links = copy_dirlinks = copy_unsafe_links = 0;
728 #ifdef SUPPORT_HARD_LINKS
729 if (preserve_hard_links && !inc_recurse)
730 match_hard_links(first_flist);
733 if (fd_pair(error_pipe) < 0) {
734 rsyserr(FERROR, errno, "pipe failed in do_recv");
735 exit_cleanup(RERR_IPC);
738 io_flush(NORMAL_FLUSH);
740 if ((pid = do_fork()) == -1) {
741 rsyserr(FERROR, errno, "fork failed in do_recv");
742 exit_cleanup(RERR_IPC);
746 close(error_pipe[0]);
750 /* we can't let two processes write to the socket at one time */
751 io_end_multiplex_out();
753 /* set place to send errors */
754 set_msg_fd_out(error_pipe[1]);
755 io_start_buffering_out(error_pipe[1]);
757 recv_files(f_in, local_name);
758 io_flush(FULL_FLUSH);
761 send_msg(MSG_DONE, "", 1, 0);
762 write_varlong(error_pipe[1], stats.total_read, 3);
763 io_flush(FULL_FLUSH);
765 /* Handle any keep-alive packets from the post-processing work
766 * that the generator does. */
767 if (protocol_version >= 29) {
770 char xname[MAXPATHLEN];
772 kluge_around_eof = -1;
774 /* This should only get stopped via a USR2 signal. */
775 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
778 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
780 exit_cleanup(RERR_PROTOCOL);
783 /* Finally, we go to sleep until our parent kills us with a
784 * USR2 signal. We sleep for a short time, as on some OSes
785 * a signal won't interrupt a sleep! */
792 io_end_multiplex_in();
793 if (write_batch && !am_server)
796 close(error_pipe[1]);
800 io_start_buffering_out(f_out);
802 set_msg_fd_in(error_pipe[0]);
803 io_start_buffering_in(error_pipe[0]);
805 #ifdef SUPPORT_HARD_LINKS
806 if (preserve_hard_links && inc_recurse) {
807 struct file_list *flist;
808 for (flist = first_flist; flist; flist = flist->next)
809 match_hard_links(flist);
813 generate_files(f_out, local_name);
816 io_flush(FULL_FLUSH);
817 if (protocol_version >= 24) {
818 /* send a final goodbye message */
819 write_ndx(f_out, NDX_DONE);
821 io_flush(FULL_FLUSH);
825 wait_process_with_flush(pid, &exit_code);
829 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
832 struct file_list *flist;
833 char *local_name = NULL;
834 int save_verbose = verbose;
836 if (filesfrom_fd >= 0) {
837 /* We can't mix messages with files-from data on the socket,
838 * so temporarily turn off verbose messages. */
843 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
844 argc, (long)getpid());
847 if (am_daemon && lp_read_only(module_id)) {
848 rprintf(FERROR,"ERROR: module is read only\n");
849 exit_cleanup(RERR_SYNTAX);
857 if (!am_daemon && !push_dir(dir, 0)) {
858 rsyserr(FERROR, errno, "push_dir#4 %s failed",
860 exit_cleanup(RERR_FILESELECT);
864 if (protocol_version >= 30)
865 io_start_multiplex_in();
867 io_start_buffering_in(f_in);
868 recv_filter_list(f_in);
870 if (filesfrom_fd >= 0) {
871 /* We need to send the files-from names to the sender at the
872 * same time that we receive the file-list from them, so we
873 * need the IO routines to automatically write out the names
874 * onto our f_out socket as we read the file-list. This
875 * avoids both deadlock and extra delays/buffers. */
876 io_set_filesfrom_fds(filesfrom_fd, f_out);
880 flist = recv_file_list(f_in);
882 rprintf(FERROR,"server_recv: recv_file_list error\n");
883 exit_cleanup(RERR_FILESELECT);
885 if (inc_recurse && file_total == 1)
886 recv_additional_file_list(f_in);
887 verbose = save_verbose;
890 local_name = get_local_name(flist,argv[0]);
892 /* Now that we know what our destination directory turned out to be,
893 * we can sanitize the --link-/copy-/compare-dest args correctly. */
894 if (sanitize_paths) {
896 for (dir_p = basis_dir; *dir_p; dir_p++)
897 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth);
899 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth);
901 check_alt_basis_dirs();
903 if (server_filter_list.head) {
905 struct filter_list_struct *elp = &server_filter_list;
907 for (dir_p = basis_dir; *dir_p; dir_p++) {
910 dir += module_dirlen;
911 if (check_filter(elp, dir, 1) < 0)
912 goto options_rejected;
914 if (partial_dir && *partial_dir == '/'
915 && check_filter(elp, partial_dir + module_dirlen, 1) < 0) {
918 "Your options have been rejected by the server.\n");
919 exit_cleanup(RERR_SYNTAX);
923 exit_code = do_recv(f_in, f_out, local_name);
924 exit_cleanup(exit_code);
928 int child_main(int argc, char *argv[])
930 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
935 void start_server(int f_in, int f_out, int argc, char *argv[])
937 set_nonblocking(f_in);
938 set_nonblocking(f_out);
940 io_set_sock_fds(f_in, f_out);
941 setup_protocol(f_out, f_in);
943 if (protocol_version >= 23)
944 io_start_multiplex_out();
947 keep_dirlinks = 0; /* Must be disabled on the sender. */
948 if (need_messages_from_generator)
949 io_start_multiplex_in();
950 recv_filter_list(f_in);
951 do_server_sender(f_in, f_out, argc, argv);
953 do_server_recv(f_in, f_out, argc, argv);
959 * This is called once the connection has been negotiated. It is used
960 * for rsyncd, remote-shell, and local connections.
962 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
964 struct file_list *flist = NULL;
965 int exit_code = 0, exit_code2 = 0;
966 char *local_name = NULL;
968 cleanup_child_pid = pid;
970 set_nonblocking(f_in);
971 set_nonblocking(f_out);
974 io_set_sock_fds(f_in, f_out);
975 setup_protocol(f_out,f_in);
977 /* We set our stderr file handle to blocking because ssh might have
978 * set it to non-blocking. This can be particularly troublesome if
979 * stderr is a clone of stdout, because ssh would have set our stdout
980 * to non-blocking at the same time (which can easily cause us to lose
981 * output from our print statements). This kluge shouldn't cause ssh
982 * any problems for how we use it. Note also that we delayed setting
983 * this until after the above protocol setup so that we know for sure
984 * that ssh is done twiddling its file descriptors. */
985 set_blocking(STDERR_FILENO);
988 keep_dirlinks = 0; /* Must be disabled on the sender. */
989 if (protocol_version >= 30)
990 io_start_multiplex_out();
992 io_start_buffering_out(f_out);
995 send_filter_list(f_out);
999 if (write_batch && !am_server)
1000 start_write_batch(f_out);
1001 flist = send_file_list(f_out, argc, argv);
1004 rprintf(FINFO,"file list sent\n");
1006 if (protocol_version >= 23)
1007 io_start_multiplex_in();
1009 io_flush(NORMAL_FLUSH);
1010 send_files(f_in, f_out);
1011 io_flush(FULL_FLUSH);
1013 if (protocol_version >= 24)
1014 read_final_goodbye(f_in);
1017 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1018 io_flush(FULL_FLUSH);
1019 wait_process_with_flush(pid, &exit_code);
1022 io_flush(FULL_FLUSH);
1023 exit_cleanup(exit_code);
1027 if (protocol_version >= 23)
1028 io_start_multiplex_in();
1029 if (need_messages_from_generator)
1030 io_start_multiplex_out();
1038 send_filter_list(read_batch ? -1 : f_out);
1040 if (filesfrom_fd >= 0) {
1041 io_set_filesfrom_fds(filesfrom_fd, f_out);
1045 if (write_batch && !am_server)
1046 start_write_batch(f_in);
1047 flist = recv_file_list(f_in);
1048 if (inc_recurse && file_total == 1)
1049 recv_additional_file_list(f_in);
1051 if (flist && flist->used > 0) {
1052 local_name = get_local_name(flist, argv[0]);
1054 check_alt_basis_dirs();
1056 exit_code2 = do_recv(f_in, f_out, local_name);
1064 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1065 io_flush(FULL_FLUSH);
1066 wait_process_with_flush(pid, &exit_code);
1069 return MAX(exit_code, exit_code2);
1072 static int copy_argv(char *argv[])
1076 for (i = 0; argv[i]; i++) {
1077 if (!(argv[i] = strdup(argv[i]))) {
1078 rprintf (FERROR, "out of memory at %s(%d)\n",
1079 __FILE__, __LINE__);
1089 * Start a client for either type of remote connection. Work out
1090 * whether the arguments request a remote shell or rsyncd connection,
1091 * and call the appropriate connection function, then run_client.
1093 * Calls either start_socket_client (for sockets) or do_cmd and
1094 * client_run (for ssh).
1096 static int start_client(int argc, char *argv[])
1098 char *p, *shell_machine = NULL, *shell_user = NULL;
1105 /* Don't clobber argv[] so that ps(1) can still show the right
1107 if ((ret = copy_argv(argv)) != 0)
1110 if (!read_batch) { /* for read_batch, NO source is specified */
1111 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1112 if (path) { /* source is remote */
1119 if (argc == 1 || **argv == ':')
1120 argc = 0; /* no dest arg */
1121 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1123 "The source and destination cannot both be remote.\n");
1124 exit_cleanup(RERR_SYNTAX);
1126 remote_argc--; /* don't count dest */
1129 if (filesfrom_host && *filesfrom_host
1130 && strcmp(filesfrom_host, shell_machine) != 0) {
1132 "--files-from hostname is not the same as the transfer hostname\n");
1133 exit_cleanup(RERR_SYNTAX);
1137 daemon_over_rsh = shell_cmd ? 1 : -1;
1138 } else { /* source is local, check dest arg */
1143 remote_argv = argv + argc;
1145 static char *dotarg[1] = { "." };
1147 remote_argv = dotarg;
1153 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1154 if (path && filesfrom_host && *filesfrom_host
1155 && strcmp(filesfrom_host, shell_machine) != 0) {
1157 "--files-from hostname is not the same as the transfer hostname\n");
1158 exit_cleanup(RERR_SYNTAX);
1160 if (!path) { /* no hostspec found, so src & dest are local */
1162 if (filesfrom_host) {
1164 "--files-from cannot be remote when the transfer is local\n");
1165 exit_cleanup(RERR_SYNTAX);
1167 shell_machine = NULL;
1168 } else { /* hostspec was found, so dest is remote */
1171 daemon_over_rsh = shell_cmd ? 1 : -1;
1174 } else { /* read_batch */
1176 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1177 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1178 exit_cleanup(RERR_SYNTAX);
1180 remote_argv = argv + argc - 1;
1186 int dummy_port = rsync_port;
1188 /* For local source, extra source args must not have hostspec. */
1189 for (i = 1; i < argc; i++) {
1190 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1191 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1192 exit_cleanup(RERR_SYNTAX);
1197 int dummy_port = rsync_port;
1199 /* For remote source, any extra source args must have either
1200 * the same hostname or an empty hostname. */
1201 for (i = 1; i < remote_argc; i++) {
1202 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1204 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1205 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1206 exit_cleanup(RERR_SYNTAX);
1208 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1209 rprintf(FERROR, "All source args must come from the same machine.\n");
1210 exit_cleanup(RERR_SYNTAX);
1212 if (rsync_port != dummy_port) {
1213 if (!rsync_port || !dummy_port)
1214 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1216 rprintf(FERROR, "All source args must use the same port number.\n");
1217 exit_cleanup(RERR_SYNTAX);
1219 remote_argv[i] = arg;
1227 if (daemon_over_rsh < 0)
1228 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1230 if (password_file && !daemon_over_rsh) {
1231 rprintf(FERROR, "The --password-file option may only be "
1232 "used when accessing an rsync daemon.\n");
1233 exit_cleanup(RERR_SYNTAX);
1236 if (connect_timeout) {
1237 rprintf(FERROR, "The --contimeout option may only be "
1238 "used when connecting to an rsync daemon.\n");
1239 exit_cleanup(RERR_SYNTAX);
1242 if (shell_machine) {
1243 p = strrchr(shell_machine,'@');
1246 shell_user = shell_machine;
1247 shell_machine = p+1;
1252 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1253 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1254 remote_argv ? NS(remote_argv[0]) : "");
1257 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1260 /* if we're running an rsync server on the remote host over a
1261 * remote shell command, we need to do the RSYNCD protocol first */
1262 if (daemon_over_rsh) {
1264 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1269 ret = client_run(f_in, f_out, pid, argc, argv);
1278 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1280 exit_cleanup(RERR_SIGNAL1);
1283 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1289 _exit(RERR_PARTIAL);
1293 RETSIGTYPE remember_children(UNUSED(int val))
1298 /* An empty waitpid() loop was put here by Tridge and we could never
1299 * get him to explain why he put it in, so rather than taking it
1300 * out we're instead saving the child exit statuses for later use.
1301 * The waitpid() loop presumably eliminates all possibility of leaving
1302 * zombie children, maybe that's why he did it. */
1303 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1304 /* save the child's exit status */
1305 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1306 if (pid_stat_table[cnt].pid == 0) {
1307 pid_stat_table[cnt].pid = pid;
1308 pid_stat_table[cnt].status = status;
1314 #ifndef HAVE_SIGACTION
1315 signal(SIGCHLD, remember_children);
1321 * This routine catches signals and tries to send them to gdb.
1323 * Because it's called from inside a signal handler it ought not to
1324 * use too many library routines.
1326 * @todo Perhaps use "screen -X" instead/as well, to help people
1327 * debugging without easy access to X. Perhaps use an environment
1328 * variable, or just call a script?
1330 * @todo The /proc/ magic probably only works on Linux (and
1331 * Solaris?) Can we be more portable?
1333 #ifdef MAINTAINER_MODE
1334 const char *get_panic_action(void)
1336 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1341 return "xterm -display :0 -T Panic -n Panic "
1342 "-e gdb /proc/%d/exe %d";
1347 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1349 * This signal handler is only installed if we were configured with
1350 * --enable-maintainer-mode. Perhaps it should always be on and we
1351 * should just look at the environment variable, but I'm a bit leery
1352 * of a signal sending us into a busy loop.
1354 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1359 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1360 getpid(), getpid());
1362 /* Unless we failed to execute gdb, we allow the process to
1363 * continue. I'm not sure if that's right. */
1364 ret = system(cmd_buf);
1371 int main(int argc,char *argv[])
1374 int orig_argc = argc;
1375 char **orig_argv = argv;
1376 #ifdef HAVE_SIGACTION
1377 # ifdef HAVE_SIGPROCMASK
1380 sigemptyset(&sigmask);
1382 sigact.sa_flags = SA_NOCLDSTOP;
1384 SIGACTMASK(SIGUSR1, sigusr1_handler);
1385 SIGACTMASK(SIGUSR2, sigusr2_handler);
1386 SIGACTMASK(SIGCHLD, remember_children);
1387 #ifdef MAINTAINER_MODE
1388 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1389 SIGACTMASK(SIGFPE, rsync_panic_handler);
1390 SIGACTMASK(SIGABRT, rsync_panic_handler);
1391 SIGACTMASK(SIGBUS, rsync_panic_handler);
1394 starttime = time(NULL);
1396 am_root = our_uid == 0;
1398 memset(&stats, 0, sizeof(stats));
1402 exit_cleanup(RERR_SYNTAX);
1405 /* we set a 0 umask so that correct file permissions can be
1407 orig_umask = umask(0);
1409 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1410 setlocale(LC_CTYPE, "");
1413 if (!parse_arguments(&argc, (const char ***) &argv)) {
1414 /* FIXME: We ought to call the same error-handling
1415 * code here, rather than relying on getopt. */
1417 exit_cleanup(RERR_SYNTAX);
1420 SIGACTMASK(SIGINT, sig_int);
1421 SIGACTMASK(SIGHUP, sig_int);
1422 SIGACTMASK(SIGTERM, sig_int);
1423 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1424 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1427 /* Ignore SIGPIPE; we consistently check error codes and will
1429 SIGACTION(SIGPIPE, SIG_IGN);
1431 SIGACTION(SIGXFSZ, SIG_IGN);
1434 /* Initialize push_dir here because on some old systems getcwd
1435 * (implemented by forking "pwd" and reading its output) doesn't
1436 * work when there are other child processes. Also, on all systems
1437 * that implement getcwd that way "pwd" can't be found after chroot. */
1442 if ((write_batch || read_batch) && !am_server) {
1444 write_batch_shell_file(orig_argc, orig_argv, argc);
1446 if (read_batch && strcmp(batch_name, "-") == 0)
1447 batch_fd = STDIN_FILENO;
1449 batch_fd = do_open(batch_name,
1450 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1451 : O_RDONLY, S_IRUSR | S_IWUSR);
1454 rsyserr(FERROR, errno, "Batch file %s open error",
1455 full_fname(batch_name));
1456 exit_cleanup(RERR_FILEIO);
1459 read_stream_flags(batch_fd);
1461 write_stream_flags(batch_fd);
1464 if (write_batch < 0)
1471 } else if (am_daemon)
1472 return daemon_main();
1474 if (am_server && protect_args) {
1475 char buf[MAXPATHLEN];
1477 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1478 if (!parse_arguments(&argc, (const char ***) &argv)) {
1480 exit_cleanup(RERR_SYNTAX);
1486 exit_cleanup(RERR_SYNTAX);
1490 set_nonblocking(STDIN_FILENO);
1491 set_nonblocking(STDOUT_FILENO);
1493 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1494 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1497 ret = start_client(argc, argv);
1499 exit_cleanup(RERR_STARTCLIENT);