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, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
25 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
35 extern int am_generator;
37 extern int blocking_io;
38 extern int remove_source_files;
39 extern int daemon_over_rsh;
40 extern int need_messages_from_generator;
41 extern int kluge_around_eof;
43 extern int log_got_error;
45 extern int copy_links;
46 extern int copy_dirlinks;
47 extern int keep_dirlinks;
48 extern int preserve_hard_links;
49 extern int protocol_version;
51 extern int relative_paths;
52 extern int sanitize_paths;
53 extern int curr_dir_depth;
54 extern int curr_dir_len;
56 extern int rsync_port;
57 extern int whole_file;
58 extern int read_batch;
59 extern int write_batch;
61 extern int batch_gen_fd;
62 extern int filesfrom_fd;
63 extern pid_t cleanup_child_pid;
64 extern struct stats stats;
65 extern char *filesfrom_host;
66 extern char *partial_dir;
67 extern char *basis_dir[];
68 extern char *rsync_path;
69 extern char *shell_cmd;
70 extern char *batch_name;
71 extern char curr_dir[MAXPATHLEN];
72 extern struct filter_list_struct server_filter_list;
75 mode_t orig_umask = 0;
76 struct file_list *the_file_list;
78 /* There's probably never more than at most 2 outstanding child processes,
79 * but set it higher, just in case. */
80 #define MAXCHILDPROCS 7
83 # ifdef HAVE_SIGPROCMASK
84 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
86 # define SIGACTMASK(n,h) SIGACTION(n,h)
88 static struct sigaction sigact;
94 } pid_stat_table[MAXCHILDPROCS];
96 static time_t starttime, endtime;
97 static int64 total_read, total_written;
99 static void show_malloc_stats(void);
101 /* Works like waitpid(), but if we already harvested the child pid in our
102 * remember_children(), we succeed instead of returning an error. */
103 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
105 pid_t waited_pid = waitpid(pid, status_ptr, flags);
107 if (waited_pid == -1 && errno == ECHILD) {
108 /* Status of requested child no longer available: check to
109 * see if it was processed by remember_children(). */
111 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
112 if (pid == pid_stat_table[cnt].pid) {
113 *status_ptr = pid_stat_table[cnt].status;
114 pid_stat_table[cnt].pid = 0;
123 /* Wait for a process to exit, calling io_flush while waiting. */
124 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
129 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
131 io_flush(FULL_FLUSH);
134 /* TODO: If the child exited on a signal, then log an
135 * appropriate error message. Perhaps we should also accept a
136 * message describing the purpose of the child. Also indicate
137 * this to the caller so that they know something went wrong. */
138 if (waited_pid < 0) {
139 rsyserr(FERROR, errno, "waitpid");
140 *exit_code_ptr = RERR_WAITCHILD;
141 } else if (!WIFEXITED(status)) {
143 if (WCOREDUMP(status))
144 *exit_code_ptr = RERR_CRASHED;
147 if (WIFSIGNALED(status))
148 *exit_code_ptr = RERR_TERMINATED;
150 *exit_code_ptr = RERR_WAITCHILD;
152 *exit_code_ptr = WEXITSTATUS(status);
155 /* This function gets called from all 3 processes. We want the client side
156 * to actually output the text, but the sender is the only process that has
157 * all the stats we need. So, if we're a client sender, we do the report.
158 * If we're a server sender, we write the stats on the supplied fd. If
159 * we're the client receiver we read the stats from the supplied fd and do
160 * the report. All processes might also generate a set of debug stats, if
161 * the verbose level is high enough (this is the only thing that the
162 * generator process and the server receiver ever do here). */
163 static void handle_stats(int f)
165 endtime = time(NULL);
167 /* Cache two stats because the read/write code can change it. */
168 total_read = stats.total_read;
169 total_written = stats.total_written;
171 if (do_stats && verbose > 1) {
172 /* These come out from every process */
181 if (f == -1 || !am_sender)
187 write_longint(f, total_read);
188 write_longint(f, total_written);
189 write_longint(f, stats.total_size);
190 if (protocol_version >= 29) {
191 write_longint(f, stats.flist_buildtime);
192 write_longint(f, stats.flist_xfertime);
198 /* this is the client */
200 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
202 else if (!am_sender) {
203 /* Read the first two in opposite order because the meaning of
204 * read/write swaps when switching from sender to receiver. */
205 total_written = read_longint(f);
206 total_read = read_longint(f);
207 stats.total_size = read_longint(f);
208 if (protocol_version >= 29) {
209 stats.flist_buildtime = read_longint(f);
210 stats.flist_xfertime = read_longint(f);
212 } else if (write_batch) {
213 /* The --read-batch process is going to be a client
214 * receiver, so we need to give it the stats. */
215 write_longint(batch_fd, total_read);
216 write_longint(batch_fd, total_written);
217 write_longint(batch_fd, stats.total_size);
218 if (protocol_version >= 29) {
219 write_longint(batch_fd, stats.flist_buildtime);
220 write_longint(batch_fd, stats.flist_xfertime);
225 static void output_summary(void)
228 rprintf(FCLIENT, "\n");
229 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
230 rprintf(FINFO,"Number of files transferred: %d\n",
231 stats.num_transferred_files);
232 rprintf(FINFO,"Total file size: %s bytes\n",
233 human_num(stats.total_size));
234 rprintf(FINFO,"Total transferred file size: %s bytes\n",
235 human_num(stats.total_transferred_size));
236 rprintf(FINFO,"Literal data: %s bytes\n",
237 human_num(stats.literal_data));
238 rprintf(FINFO,"Matched data: %s bytes\n",
239 human_num(stats.matched_data));
240 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
241 if (stats.flist_buildtime) {
243 "File list generation time: %.3f seconds\n",
244 (double)stats.flist_buildtime / 1000);
246 "File list transfer time: %.3f seconds\n",
247 (double)stats.flist_xfertime / 1000);
249 rprintf(FINFO,"Total bytes sent: %s\n",
250 human_num(total_written));
251 rprintf(FINFO,"Total bytes received: %s\n",
252 human_num(total_read));
255 if (verbose || do_stats) {
256 rprintf(FCLIENT, "\n");
258 "sent %s bytes received %s bytes %s bytes/sec\n",
259 human_num(total_written), human_num(total_read),
260 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
261 rprintf(FINFO, "total size is %s speedup is %.2f\n",
262 human_num(stats.total_size),
263 (double)stats.total_size / (total_written+total_read));
272 * If our C library can get malloc statistics, then show them to FINFO
274 static void show_malloc_stats(void)
281 rprintf(FCLIENT, "\n");
282 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
283 getpid(), am_server ? "server " : "",
284 am_daemon ? "daemon " : "", who_am_i());
285 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
287 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
289 rprintf(FINFO, " smblks: %10ld\n",
291 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
293 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
295 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
296 (long)mi.arena + mi.hblkhd);
297 rprintf(FINFO, " usmblks: %10ld\n",
299 rprintf(FINFO, " fsmblks: %10ld\n",
301 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
303 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
305 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
307 #endif /* HAVE_MALLINFO */
311 /* Start the remote shell. cmd may be NULL to use the default. */
312 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
313 int *f_in, int *f_out)
316 char *args[MAX_ARGS];
321 if (!read_batch && !local_server) {
322 char *t, *f, in_quote = '\0';
323 char *rsh_env = getenv(RSYNC_RSH_ENV);
332 for (t = f = cmd; *f; f++) {
335 /* Comparison leaves rooms for server_options(). */
336 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
337 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
338 exit_cleanup(RERR_SYNTAX);
341 while (*f != ' ' || in_quote) {
345 "Missing trailing-%c in remote-shell command.\n",
347 exit_cleanup(RERR_SYNTAX);
352 if (*f == '\'' || *f == '"') {
357 if (*f == in_quote && *++f != in_quote) {
367 /* check to see if we've already been given '-l user' in
368 * the remote-shell command */
369 for (i = 0; i < argc-1; i++) {
370 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
375 /* remsh (on HPUX) takes the arguments the other way around */
376 args[argc++] = machine;
377 if (user && !(daemon_over_rsh && dash_l_set)) {
382 if (user && !(daemon_over_rsh && dash_l_set)) {
386 args[argc++] = machine;
389 args[argc++] = rsync_path;
391 if (blocking_io < 0) {
393 if ((cp = strrchr(cmd, '/')) != NULL)
397 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
401 server_options(args,&argc);
403 if (argc >= MAX_ARGS - 2) {
404 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
405 exit_cleanup(RERR_SYNTAX);
411 if (!daemon_over_rsh && path && *path)
417 for (i = 0; i < argc; i++)
418 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
419 rprintf(FCLIENT, "\n");
423 int from_gen_pipe[2];
424 if (fd_pair(from_gen_pipe) < 0) {
425 rsyserr(FERROR, errno, "pipe");
426 exit_cleanup(RERR_IPC);
428 batch_gen_fd = from_gen_pipe[0];
429 *f_out = from_gen_pipe[1];
431 ret = -1; /* no child pid */
432 } else if (local_server) {
433 /* If the user didn't request --[no-]whole-file, force
434 * it on, but only if we're not batch processing. */
435 if (whole_file < 0 && !write_batch)
437 ret = local_child(argc, args, f_in, f_out, child_main);
439 ret = piped_child(args,f_in,f_out);
447 out_of_memory("do_cmd");
448 return 0; /* not reached */
451 /* The receiving side operates in one of two modes:
453 * 1. it receives any number of files into a destination directory,
454 * placing them according to their names in the file-list.
456 * 2. it receives a single file and saves it using the name in the
457 * destination path instead of its file-list name. This requires a
458 * "local name" for writing out the destination file.
460 * So, our task is to figure out what mode/local-name we need.
461 * For mode 1, we change into the destination directory and return NULL.
462 * For mode 2, we change into the directory containing the destination
463 * file (if we aren't already there) and return the local-name. */
464 static char *get_local_name(struct file_list *flist, char *dest_path)
471 rprintf(FINFO, "get_local_name count=%d %s\n",
472 flist->count, NS(dest_path));
475 if (!dest_path || list_only)
478 /* See what currently exists at the destination. */
479 if ((statret = safe_stat(dest_path, &st)) == 0) {
480 /* If the destination is a dir, enter it and use mode 1. */
481 if (S_ISDIR(st.st_mode)) {
483 die_on_unsafe_path(dest_path, 0);
484 if (!push_dir(dest_path, 0)) {
485 rsyserr(FERROR, errno, "push_dir#1 %s failed",
486 full_fname(dest_path));
487 exit_cleanup(RERR_FILESELECT);
491 if (sanitize_paths && S_ISLNK(st.st_mode))
492 die_on_unsafe_path(dest_path, 0);
493 if (flist->count > 1) {
495 "ERROR: destination must be a directory when"
496 " copying more than 1 file\n");
497 exit_cleanup(RERR_FILESELECT);
499 /* Caution: flist->count could be 0! */
500 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
502 "ERROR: cannot overwrite non-directory"
503 " with a directory\n");
504 exit_cleanup(RERR_FILESELECT);
506 } else if (errno != ENOENT) {
507 /* If we don't know what's at the destination, fail. */
508 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
509 full_fname(dest_path));
510 exit_cleanup(RERR_FILESELECT);
513 cp = strrchr(dest_path, '/');
515 /* If we need a destination directory because the transfer is not
516 * of a single non-directory or the user has requested one via a
517 * destination path ending in a slash, create one and use mode 1. */
518 if (flist->count > 1 || (cp && !cp[1])) {
519 /* Lop off the final slash (if any). */
525 "ERROR: destination path is not a directory\n");
526 exit_cleanup(RERR_SYNTAX);
529 if (mkdir_defmode(dest_path) != 0) {
530 rsyserr(FERROR, errno, "mkdir %s failed",
531 full_fname(dest_path));
532 exit_cleanup(RERR_FILEIO);
536 rprintf(FINFO, "created directory %s\n", dest_path);
539 /* Indicate that dest dir doesn't really exist. */
544 die_on_unsafe_path(dest_path, 0);
545 if (!push_dir(dest_path, dry_run > 1)) {
546 rsyserr(FERROR, errno, "push_dir#2 %s failed",
547 full_fname(dest_path));
548 exit_cleanup(RERR_FILESELECT);
554 /* Otherwise, we are writing a single file, possibly on top of an
555 * existing non-directory. Change to the item's parent directory
556 * (if it has a path component), return the basename of the
557 * destination file as the local name, and use mode 2. */
566 die_on_unsafe_path(dest_path, 0);
567 if (!push_dir(dest_path, 0)) {
568 rsyserr(FERROR, errno, "push_dir#3 %s failed",
569 full_fname(dest_path));
570 exit_cleanup(RERR_FILESELECT);
577 /* Call this if the destination dir (which is assumed to be in curr_dir)
578 * does not yet exist and we can't create it due to being in dry-run
579 * mode. We'll fix dirs that can be relative to the non-existent dir. */
580 static void fix_basis_dirs(void)
582 char **dir, *new, *slash;
588 slash = strrchr(curr_dir, '/');
590 for (dir = basis_dir; *dir; dir++) {
593 len = curr_dir_len + 1 + strlen(*dir) + 1;
594 if (!(new = new_array(char, len)))
595 out_of_memory("fix_basis_dirs");
596 if (slash && strncmp(*dir, "../", 3) == 0) {
597 /* We want to remove only one leading "../" prefix for
598 * the directory we couldn't create in dry-run mode:
599 * this ensures that any other ".." references get
600 * evaluated the same as they would for a live copy. */
602 pathjoin(new, len, curr_dir, *dir + 3);
605 pathjoin(new, len, curr_dir, *dir);
610 /* This is only called by the sender. */
611 static void read_final_goodbye(int f_in, int f_out)
615 if (protocol_version < 29)
618 while ((i = read_int(f_in)) == the_file_list->count
619 && read_shortint(f_in) == ITEM_IS_NEW) {
620 /* Forward the keep-alive (no-op) to the receiver. */
621 write_int(f_out, the_file_list->count);
622 write_shortint(f_out, ITEM_IS_NEW);
627 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
629 exit_cleanup(RERR_PROTOCOL);
634 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
636 struct file_list *flist;
640 rprintf(FINFO, "server_sender starting pid=%ld\n",
644 if (am_daemon && lp_write_only(module_id)) {
645 rprintf(FERROR, "ERROR: module is write only\n");
646 exit_cleanup(RERR_SYNTAX);
649 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
651 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
652 remove_source_files == 1 ? "source" : "sent");
653 exit_cleanup(RERR_SYNTAX);
657 if (!relative_paths) {
659 die_on_unsafe_path(dir, 0);
660 if (!push_dir(dir, 0)) {
661 rsyserr(FERROR, errno, "push_dir#3 %s failed",
663 exit_cleanup(RERR_FILESELECT);
669 if (argc == 0 && (recurse || list_only)) {
675 flist = send_file_list(f_out,argc,argv);
676 if (!flist || flist->count == 0) {
679 the_file_list = flist;
681 io_start_buffering_in();
682 io_start_buffering_out();
684 send_files(flist,f_out,f_in);
685 io_flush(FULL_FLUSH);
687 if (protocol_version >= 24)
688 read_final_goodbye(f_in, f_out);
689 io_flush(FULL_FLUSH);
694 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
700 /* The receiving side mustn't obey this, or an existing symlink that
701 * points to an identical file won't be replaced by the referent. */
702 copy_links = copy_dirlinks = 0;
704 if (preserve_hard_links)
707 if (fd_pair(error_pipe) < 0) {
708 rsyserr(FERROR, errno, "pipe failed in do_recv");
709 exit_cleanup(RERR_IPC);
712 io_flush(NORMAL_FLUSH);
714 if ((pid = do_fork()) == -1) {
715 rsyserr(FERROR, errno, "fork failed in do_recv");
716 exit_cleanup(RERR_IPC);
720 close(error_pipe[0]);
724 /* we can't let two processes write to the socket at one time */
725 close_multiplexing_out();
727 /* set place to send errors */
728 set_msg_fd_out(error_pipe[1]);
730 recv_files(f_in, flist, local_name);
731 io_flush(FULL_FLUSH);
734 send_msg(MSG_DONE, "", 0);
735 io_flush(FULL_FLUSH);
737 /* Handle any keep-alive packets from the post-processing work
738 * that the generator does. */
739 if (protocol_version >= 29) {
740 kluge_around_eof = -1;
742 /* This should only get stopped via a USR2 signal. */
743 while (read_int(f_in) == flist->count
744 && read_shortint(f_in) == ITEM_IS_NEW) {}
746 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
748 exit_cleanup(RERR_PROTOCOL);
751 /* Finally, we go to sleep until our parent kills us with a
752 * USR2 signal. We sleep for a short time, as on some OSes
753 * a signal won't interrupt a sleep! */
759 close_multiplexing_in();
760 if (write_batch && !am_server)
763 close(error_pipe[1]);
767 io_start_buffering_out();
769 set_msg_fd_in(error_pipe[0]);
771 generate_files(f_out, flist, local_name);
774 io_flush(FULL_FLUSH);
775 if (protocol_version >= 24) {
776 /* send a final goodbye message */
777 write_int(f_out, -1);
779 io_flush(FULL_FLUSH);
783 wait_process_with_flush(pid, &exit_code);
788 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
791 struct file_list *flist;
792 char *local_name = NULL;
794 int save_verbose = verbose;
796 if (filesfrom_fd >= 0) {
797 /* We can't mix messages with files-from data on the socket,
798 * so temporarily turn off verbose messages. */
803 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
804 argc, (long)getpid());
807 if (am_daemon && lp_read_only(module_id)) {
808 rprintf(FERROR,"ERROR: module is read only\n");
809 exit_cleanup(RERR_SYNTAX);
817 if (!am_daemon && !push_dir(dir, 0)) {
818 rsyserr(FERROR, errno, "push_dir#4 %s failed",
820 exit_cleanup(RERR_FILESELECT);
824 io_start_buffering_in();
825 recv_filter_list(f_in);
827 if (filesfrom_fd >= 0) {
828 /* We need to send the files-from names to the sender at the
829 * same time that we receive the file-list from them, so we
830 * need the IO routines to automatically write out the names
831 * onto our f_out socket as we read the file-list. This
832 * avoids both deadlock and extra delays/buffers. */
833 io_set_filesfrom_fds(filesfrom_fd, f_out);
837 flist = recv_file_list(f_in);
838 verbose = save_verbose;
840 rprintf(FERROR,"server_recv: recv_file_list error\n");
841 exit_cleanup(RERR_FILESELECT);
843 the_file_list = flist;
846 local_name = get_local_name(flist,argv[0]);
848 /* Now that we know what our destination directory turned out to be,
849 * we can sanitize the --link-/copy-/compare-dest args correctly. */
850 if (sanitize_paths) {
852 for (dir = basis_dir; *dir; dir++) {
853 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
854 die_on_unsafe_path(*dir, 0);
857 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
858 /* A relative path gets this checked at every dir change. */
859 if (*partial_dir == '/')
860 die_on_unsafe_path(partial_dir, 0);
865 if (server_filter_list.head) {
867 struct filter_list_struct *elp = &server_filter_list;
869 for (dir = basis_dir; *dir; dir++) {
870 if (check_filter(elp, *dir, 1) < 0)
871 goto options_rejected;
873 if (partial_dir && *partial_dir == '/'
874 && check_filter(elp, partial_dir, 1) < 0) {
877 "Your options have been rejected by the server.\n");
878 exit_cleanup(RERR_SYNTAX);
882 exit_code = do_recv(f_in,f_out,flist,local_name);
883 exit_cleanup(exit_code);
887 int child_main(int argc, char *argv[])
889 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
894 void start_server(int f_in, int f_out, int argc, char *argv[])
896 set_nonblocking(f_in);
897 set_nonblocking(f_out);
899 io_set_sock_fds(f_in, f_out);
900 setup_protocol(f_out, f_in);
901 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
905 if (protocol_version >= 23)
906 io_start_multiplex_out();
909 keep_dirlinks = 0; /* Must be disabled on the sender. */
910 if (need_messages_from_generator)
911 io_start_multiplex_in();
913 recv_filter_list(f_in);
914 do_server_sender(f_in, f_out, argc, argv);
916 do_server_recv(f_in, f_out, argc, argv);
923 * This is called once the connection has been negotiated. It is used
924 * for rsyncd, remote-shell, and local connections.
926 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
928 struct file_list *flist = NULL;
929 int exit_code = 0, exit_code2 = 0;
930 char *local_name = NULL;
932 cleanup_child_pid = pid;
934 set_nonblocking(f_in);
935 set_nonblocking(f_out);
938 io_set_sock_fds(f_in, f_out);
939 setup_protocol(f_out,f_in);
940 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
944 if (protocol_version >= 23 && !read_batch)
945 io_start_multiplex_in();
947 /* We set our stderr file handle to blocking because ssh might have
948 * set it to non-blocking. This can be particularly troublesome if
949 * stderr is a clone of stdout, because ssh would have set our stdout
950 * to non-blocking at the same time (which can easily cause us to lose
951 * output from our print statements). This kluge shouldn't cause ssh
952 * any problems for how we use it. Note also that we delayed setting
953 * this until after the above protocol setup so that we know for sure
954 * that ssh is done twiddling its file descriptors. */
955 set_blocking(STDERR_FILENO);
958 keep_dirlinks = 0; /* Must be disabled on the sender. */
959 io_start_buffering_out();
962 send_filter_list(f_out);
966 if (write_batch && !am_server)
967 start_write_batch(f_out);
968 flist = send_file_list(f_out, argc, argv);
971 rprintf(FINFO,"file list sent\n");
972 the_file_list = flist;
974 io_flush(NORMAL_FLUSH);
975 send_files(flist,f_out,f_in);
976 io_flush(FULL_FLUSH);
978 if (protocol_version >= 24)
979 read_final_goodbye(f_in, f_out);
982 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
983 io_flush(FULL_FLUSH);
984 wait_process_with_flush(pid, &exit_code);
987 io_flush(FULL_FLUSH);
988 exit_cleanup(exit_code);
991 if (need_messages_from_generator && !read_batch)
992 io_start_multiplex_out();
997 send_filter_list(read_batch ? -1 : f_out);
999 if (filesfrom_fd >= 0) {
1000 io_set_filesfrom_fds(filesfrom_fd, f_out);
1004 if (write_batch && !am_server)
1005 start_write_batch(f_in);
1006 flist = recv_file_list(f_in);
1007 the_file_list = flist;
1009 if (flist && flist->count > 0) {
1010 local_name = get_local_name(flist, argv[0]);
1014 exit_code2 = do_recv(f_in, f_out, flist, local_name);
1022 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1023 io_flush(FULL_FLUSH);
1024 wait_process_with_flush(pid, &exit_code);
1027 return MAX(exit_code, exit_code2);
1030 static int copy_argv (char *argv[])
1034 for (i = 0; argv[i]; i++) {
1035 if (!(argv[i] = strdup(argv[i]))) {
1036 rprintf (FERROR, "out of memory at %s(%d)\n",
1037 __FILE__, __LINE__);
1047 * Start a client for either type of remote connection. Work out
1048 * whether the arguments request a remote shell or rsyncd connection,
1049 * and call the appropriate connection function, then run_client.
1051 * Calls either start_socket_client (for sockets) or do_cmd and
1052 * client_run (for ssh).
1054 static int start_client(int argc, char *argv[])
1057 char *shell_machine = NULL;
1058 char *shell_path = NULL;
1059 char *shell_user = NULL;
1065 /* Don't clobber argv[] so that ps(1) can still show the right
1067 if ((rc = copy_argv(argv)))
1070 if (!read_batch) { /* for read_batch, NO source is specified */
1071 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1072 if (shell_path) { /* source is remote */
1076 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1078 "The source and destination cannot both be remote.\n");
1079 exit_cleanup(RERR_SYNTAX);
1082 if (filesfrom_host && *filesfrom_host
1083 && strcmp(filesfrom_host, shell_machine) != 0) {
1085 "--files-from hostname is not the same as the transfer hostname\n");
1086 exit_cleanup(RERR_SYNTAX);
1090 return start_socket_client(shell_machine,
1094 daemon_over_rsh = 1;
1098 } else { /* source is local, check dest arg */
1108 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1109 if (shell_path && filesfrom_host && *filesfrom_host
1110 && strcmp(filesfrom_host, shell_machine) != 0) {
1112 "--files-from hostname is not the same as the transfer hostname\n");
1113 exit_cleanup(RERR_SYNTAX);
1115 if (!shell_path) { /* no hostspec found, so src & dest are local */
1117 if (filesfrom_host) {
1119 "--files-from cannot be remote when the transfer is local\n");
1120 exit_cleanup(RERR_SYNTAX);
1122 shell_machine = NULL;
1124 } else if (rsync_port) {
1126 return start_socket_client(shell_machine,
1130 daemon_over_rsh = 1;
1133 } else { /* read_batch */
1135 shell_path = argv[argc-1];
1136 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1137 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1138 exit_cleanup(RERR_SYNTAX);
1142 if (shell_machine) {
1143 p = strrchr(shell_machine,'@');
1146 shell_user = shell_machine;
1147 shell_machine = p+1;
1152 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1153 shell_cmd ? shell_cmd : "",
1154 shell_machine ? shell_machine : "",
1155 shell_user ? shell_user : "",
1156 shell_path ? shell_path : "");
1159 /* for remote source, only single dest arg can remain ... */
1160 if (!am_sender && argc > 1) {
1162 exit_cleanup(RERR_SYNTAX);
1165 /* ... or no dest at all */
1166 if (!am_sender && argc == 0)
1169 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1172 /* if we're running an rsync server on the remote host over a
1173 * remote shell command, we need to do the RSYNCD protocol first */
1174 if (daemon_over_rsh) {
1176 tmpret = start_inband_exchange(shell_user, shell_path,
1182 ret = client_run(f_in, f_out, pid, argc, argv);
1191 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1193 exit_cleanup(RERR_SIGNAL1);
1196 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1202 _exit(RERR_PARTIAL);
1206 RETSIGTYPE remember_children(UNUSED(int val))
1211 /* An empty waitpid() loop was put here by Tridge and we could never
1212 * get him to explain why he put it in, so rather than taking it
1213 * out we're instead saving the child exit statuses for later use.
1214 * The waitpid() loop presumably eliminates all possibility of leaving
1215 * zombie children, maybe that's why he did it. */
1216 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1217 /* save the child's exit status */
1218 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1219 if (pid_stat_table[cnt].pid == 0) {
1220 pid_stat_table[cnt].pid = pid;
1221 pid_stat_table[cnt].status = status;
1227 #ifndef HAVE_SIGACTION
1228 signal(SIGCHLD, remember_children);
1234 * This routine catches signals and tries to send them to gdb.
1236 * Because it's called from inside a signal handler it ought not to
1237 * use too many library routines.
1239 * @todo Perhaps use "screen -X" instead/as well, to help people
1240 * debugging without easy access to X. Perhaps use an environment
1241 * variable, or just call a script?
1243 * @todo The /proc/ magic probably only works on Linux (and
1244 * Solaris?) Can we be more portable?
1246 #ifdef MAINTAINER_MODE
1247 const char *get_panic_action(void)
1249 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1254 return "xterm -display :0 -T Panic -n Panic "
1255 "-e gdb /proc/%d/exe %d";
1260 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1262 * This signal handler is only installed if we were configured with
1263 * --enable-maintainer-mode. Perhaps it should always be on and we
1264 * should just look at the environment variable, but I'm a bit leery
1265 * of a signal sending us into a busy loop.
1267 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1272 sprintf(cmd_buf, get_panic_action(),
1273 getpid(), getpid());
1275 /* Unless we failed to execute gdb, we allow the process to
1276 * continue. I'm not sure if that's right. */
1277 ret = system(cmd_buf);
1284 int main(int argc,char *argv[])
1287 int orig_argc = argc;
1288 char **orig_argv = argv;
1289 #ifdef HAVE_SIGACTION
1290 # ifdef HAVE_SIGPROCMASK
1293 sigemptyset(&sigmask);
1295 sigact.sa_flags = SA_NOCLDSTOP;
1297 SIGACTMASK(SIGUSR1, sigusr1_handler);
1298 SIGACTMASK(SIGUSR2, sigusr2_handler);
1299 SIGACTMASK(SIGCHLD, remember_children);
1300 #ifdef MAINTAINER_MODE
1301 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1302 SIGACTMASK(SIGFPE, rsync_panic_handler);
1303 SIGACTMASK(SIGABRT, rsync_panic_handler);
1304 SIGACTMASK(SIGBUS, rsync_panic_handler);
1307 starttime = time(NULL);
1308 am_root = (MY_UID() == 0);
1310 memset(&stats, 0, sizeof(stats));
1314 exit_cleanup(RERR_SYNTAX);
1317 /* we set a 0 umask so that correct file permissions can be
1319 orig_umask = umask(0);
1321 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1322 setlocale(LC_CTYPE, "");
1325 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1326 /* FIXME: We ought to call the same error-handling
1327 * code here, rather than relying on getopt. */
1329 exit_cleanup(RERR_SYNTAX);
1332 SIGACTMASK(SIGINT, sig_int);
1333 SIGACTMASK(SIGHUP, sig_int);
1334 SIGACTMASK(SIGTERM, sig_int);
1335 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1336 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1339 /* Ignore SIGPIPE; we consistently check error codes and will
1341 SIGACTION(SIGPIPE, SIG_IGN);
1343 SIGACTION(SIGXFSZ, SIG_IGN);
1346 /* Initialize push_dir here because on some old systems getcwd
1347 * (implemented by forking "pwd" and reading its output) doesn't
1348 * work when there are other child processes. Also, on all systems
1349 * that implement getcwd that way "pwd" can't be found after chroot. */
1354 if ((write_batch || read_batch) && !am_server) {
1356 write_batch_shell_file(orig_argc, orig_argv, argc);
1358 if (read_batch && strcmp(batch_name, "-") == 0)
1359 batch_fd = STDIN_FILENO;
1361 batch_fd = do_open(batch_name,
1362 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1363 : O_RDONLY, S_IRUSR | S_IWUSR);
1366 rsyserr(FERROR, errno, "Batch file %s open error",
1367 full_fname(batch_name));
1368 exit_cleanup(RERR_FILEIO);
1371 read_stream_flags(batch_fd);
1373 if (write_batch < 0)
1376 if (am_daemon && !am_server)
1377 return daemon_main();
1381 exit_cleanup(RERR_SYNTAX);
1385 set_nonblocking(STDIN_FILENO);
1386 set_nonblocking(STDOUT_FILENO);
1388 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1389 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1392 ret = start_client(argc, argv);
1394 exit_cleanup(RERR_STARTCLIENT);