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_sent_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;
55 extern int rsync_port;
56 extern int whole_file;
57 extern int read_batch;
58 extern int write_batch;
60 extern int batch_gen_fd;
61 extern int filesfrom_fd;
62 extern pid_t cleanup_child_pid;
63 extern struct stats stats;
64 extern char *filesfrom_host;
65 extern char *basis_dir[];
66 extern char *rsync_path;
67 extern char *shell_cmd;
68 extern char *batch_name;
71 mode_t orig_umask = 0;
72 struct file_list *the_file_list;
74 /* There's probably never more than at most 2 outstanding child processes,
75 * but set it higher, just in case. */
76 #define MAXCHILDPROCS 7
79 # ifdef HAVE_SIGPROCMASK
80 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
82 # define SIGACTMASK(n,h) SIGACTION(n,h)
84 static struct sigaction sigact;
90 } pid_stat_table[MAXCHILDPROCS];
92 static time_t starttime, endtime;
93 static int64 total_read, total_written;
95 static void show_malloc_stats(void);
97 /* Works like waitpid(), but if we already harvested the child pid in our
98 * remember_children(), we succeed instead of returning an error. */
99 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
101 pid_t waited_pid = waitpid(pid, status_ptr, flags);
103 if (waited_pid == -1 && errno == ECHILD) {
104 /* Status of requested child no longer available: check to
105 * see if it was processed by remember_children(). */
107 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
108 if (pid == pid_stat_table[cnt].pid) {
109 *status_ptr = pid_stat_table[cnt].status;
110 pid_stat_table[cnt].pid = 0;
119 /* Wait for a process to exit, calling io_flush while waiting. */
120 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
125 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
127 io_flush(FULL_FLUSH);
130 /* TODO: If the child exited on a signal, then log an
131 * appropriate error message. Perhaps we should also accept a
132 * message describing the purpose of the child. Also indicate
133 * this to the caller so that they know something went wrong. */
134 if (waited_pid < 0) {
135 rsyserr(FERROR, errno, "waitpid");
136 *exit_code_ptr = RERR_WAITCHILD;
137 } else if (!WIFEXITED(status)) {
139 if (WCOREDUMP(status))
140 *exit_code_ptr = RERR_CRASHED;
143 if (WIFSIGNALED(status))
144 *exit_code_ptr = RERR_TERMINATED;
146 *exit_code_ptr = RERR_WAITCHILD;
148 *exit_code_ptr = WEXITSTATUS(status);
151 /* This function gets called from all 3 processes. We want the client side
152 * to actually output the text, but the sender is the only process that has
153 * all the stats we need. So, if we're a client sender, we do the report.
154 * If we're a server sender, we write the stats on the supplied fd. If
155 * we're the client receiver we read the stats from the supplied fd and do
156 * the report. All processes might also generate a set of debug stats, if
157 * the verbose level is high enough (this is the only thing that the
158 * generator process and the server receiver ever do here). */
159 static void handle_stats(int f)
161 endtime = time(NULL);
163 /* Cache two stats because the read/write code can change it. */
164 total_read = stats.total_read;
165 total_written = stats.total_written;
167 if (do_stats && verbose > 1) {
168 /* These come out from every process */
177 log_exit(0, __FILE__, __LINE__);
178 if (f == -1 || !am_sender)
184 write_longint(f, total_read);
185 write_longint(f, total_written);
186 write_longint(f, stats.total_size);
187 if (protocol_version >= 29) {
188 write_longint(f, stats.flist_buildtime);
189 write_longint(f, stats.flist_xfertime);
195 /* this is the client */
197 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
199 else if (!am_sender) {
200 /* Read the first two in opposite order because the meaning of
201 * read/write swaps when switching from sender to receiver. */
202 total_written = read_longint(f);
203 total_read = read_longint(f);
204 stats.total_size = read_longint(f);
205 if (protocol_version >= 29) {
206 stats.flist_buildtime = read_longint(f);
207 stats.flist_xfertime = read_longint(f);
209 } else if (write_batch) {
210 /* The --read-batch process is going to be a client
211 * receiver, so we need to give it the stats. */
212 write_longint(batch_fd, total_read);
213 write_longint(batch_fd, total_written);
214 write_longint(batch_fd, stats.total_size);
215 if (protocol_version >= 29) {
216 write_longint(batch_fd, stats.flist_buildtime);
217 write_longint(batch_fd, stats.flist_xfertime);
222 static void output_summary(void)
225 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
226 rprintf(FINFO,"Number of files transferred: %d\n",
227 stats.num_transferred_files);
228 rprintf(FINFO,"Total file size: %s bytes\n",
229 human_num(stats.total_size));
230 rprintf(FINFO,"Total transferred file size: %s bytes\n",
231 human_num(stats.total_transferred_size));
232 rprintf(FINFO,"Literal data: %s bytes\n",
233 human_num(stats.literal_data));
234 rprintf(FINFO,"Matched data: %s bytes\n",
235 human_num(stats.matched_data));
236 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
237 if (stats.flist_buildtime) {
239 "File list generation time: %.3f seconds\n",
240 (double)stats.flist_buildtime / 1000);
242 "File list transfer time: %.3f seconds\n",
243 (double)stats.flist_xfertime / 1000);
245 rprintf(FINFO,"Total bytes sent: %s\n",
246 human_num(total_written));
247 rprintf(FINFO,"Total bytes received: %s\n",
248 human_num(total_read));
251 if (verbose || do_stats) {
253 "\nsent %s bytes received %s bytes %s bytes/sec\n",
254 human_num(total_written), human_num(total_read),
255 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
256 rprintf(FINFO, "total size is %s speedup is %.2f\n",
257 human_num(stats.total_size),
258 (double)stats.total_size / (total_written+total_read));
267 * If our C library can get malloc statistics, then show them to FINFO
269 static void show_malloc_stats(void)
276 rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
277 getpid(), am_server ? "server " : "",
278 am_daemon ? "daemon " : "", who_am_i());
279 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
281 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
283 rprintf(FINFO, " smblks: %10ld\n",
285 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
287 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
289 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
290 (long)mi.arena + mi.hblkhd);
291 rprintf(FINFO, " usmblks: %10ld\n",
293 rprintf(FINFO, " fsmblks: %10ld\n",
295 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
297 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
299 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
301 #endif /* HAVE_MALLINFO */
305 /* Start the remote shell. cmd may be NULL to use the default. */
306 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
307 int *f_in, int *f_out)
310 char *args[MAX_ARGS];
315 if (!read_batch && !local_server) {
316 char *t, *f, in_quote = '\0';
317 char *rsh_env = getenv(RSYNC_RSH_ENV);
326 for (t = f = cmd; *f; f++) {
329 /* Comparison leaves rooms for server_options(). */
330 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
331 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
332 exit_cleanup(RERR_SYNTAX);
335 while (*f != ' ' || in_quote) {
339 "Missing trailing-%c in remote-shell command.\n",
341 exit_cleanup(RERR_SYNTAX);
346 if (*f == '\'' || *f == '"') {
351 if (*f == in_quote && *++f != in_quote) {
361 /* check to see if we've already been given '-l user' in
362 * the remote-shell command */
363 for (i = 0; i < argc-1; i++) {
364 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
369 /* remsh (on HPUX) takes the arguments the other way around */
370 args[argc++] = machine;
371 if (user && !(daemon_over_rsh && dash_l_set)) {
376 if (user && !(daemon_over_rsh && dash_l_set)) {
380 args[argc++] = machine;
383 args[argc++] = rsync_path;
385 if (blocking_io < 0) {
387 if ((cp = strrchr(cmd, '/')) != NULL)
391 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
395 server_options(args,&argc);
397 if (argc >= MAX_ARGS - 2) {
398 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
399 exit_cleanup(RERR_SYNTAX);
405 if (!daemon_over_rsh && path && *path)
411 for (i = 0; i < argc; i++)
412 rprintf(FINFO, "cmd[%d]=%s ", i, args[i]);
413 rprintf(FINFO, "\n");
417 int from_gen_pipe[2];
418 if (fd_pair(from_gen_pipe) < 0) {
419 rsyserr(FERROR, errno, "pipe");
420 exit_cleanup(RERR_IPC);
422 batch_gen_fd = from_gen_pipe[0];
423 *f_out = from_gen_pipe[1];
425 ret = -1; /* no child pid */
426 } else if (local_server) {
427 /* If the user didn't request --[no-]whole-file, force
428 * it on, but only if we're not batch processing. */
429 if (whole_file < 0 && !write_batch)
431 ret = local_child(argc, args, f_in, f_out, child_main);
433 ret = piped_child(args,f_in,f_out);
441 out_of_memory("do_cmd");
442 return 0; /* not reached */
445 /* The receiving side operates in one of two modes:
447 * 1. it receives any number of files into a destination directory,
448 * placing them according to their names in the file-list.
450 * 2. it receives a single file and saves it using the name in the
451 * destination path instead of its file-list name. This requires a
452 * "local name" for writing out the destination file.
454 * So, our task is to figure out what mode/local-name we need and return
455 * either a NULL for mode 1, or the local-name for mode 2. We also
456 * change directory if there are any path components in dest_path. */
457 static char *get_local_name(struct file_list *flist, char *dest_path)
463 rprintf(FINFO, "get_local_name count=%d %s\n",
464 flist->count, NS(dest_path));
467 if (!dest_path || list_only)
470 /* If the destination path refers to an existing directory, enter
471 * it and use mode 1. If there is something other than a directory
472 * at the destination path, we must be transferring one file
473 * (anything at the destination will be overwritten). */
474 if (safe_stat(dest_path, &st) == 0) {
475 if (S_ISDIR(st.st_mode)) {
477 die_on_unsafe_path(dest_path, 0);
478 if (!push_dir(dest_path)) {
479 rsyserr(FERROR, errno, "push_dir#1 %s failed",
480 full_fname(dest_path));
481 exit_cleanup(RERR_FILESELECT);
485 if (sanitize_paths && S_ISLNK(st.st_mode))
486 die_on_unsafe_path(dest_path, 0);
487 if (flist->count > 1) {
489 "ERROR: destination must be a directory when"
490 " copying more than 1 file\n");
491 exit_cleanup(RERR_FILESELECT);
493 /* Caution: flist->count could be 0! */
494 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
496 "ERROR: cannot overwrite non-directory"
497 " with a directory\n");
498 exit_cleanup(RERR_FILESELECT);
500 } else if (errno != ENOENT) {
501 rsyserr(FERROR, errno, "cannot stat destination %s",
502 full_fname(dest_path));
503 exit_cleanup(RERR_FILESELECT);
506 cp = strrchr(dest_path, '/');
508 /* If the destination path ends in a slash or we are transferring
509 * multiple files, create a directory at the destination path,
510 * enter the new directory, and use mode 1. */
511 if (flist->count > 1 || (cp && !cp[1])) {
512 /* Lop off the final slash (if any). */
516 if (mkdir_defmode(dest_path) != 0) {
517 rsyserr(FERROR, errno, "mkdir %s failed",
518 full_fname(dest_path));
519 exit_cleanup(RERR_FILEIO);
523 rprintf(FINFO, "created directory %s\n", dest_path);
526 /* Indicate that the destination directory doesn't
527 * really exist and return mode 1. */
533 die_on_unsafe_path(dest_path, 0);
534 if (!push_dir(dest_path)) {
535 rsyserr(FERROR, errno, "push_dir#2 %s failed",
536 full_fname(dest_path));
537 exit_cleanup(RERR_FILESELECT);
543 /* Otherwise, we are writing a single file, possibly on top of an
544 * existing non-directory. Change to the item's parent directory
545 * (if it has a path component), return the basename of the
546 * destination file as the local name, and use mode 2. */
555 die_on_unsafe_path(dest_path, 0);
556 if (!push_dir(dest_path)) {
557 rsyserr(FERROR, errno, "push_dir#3 %s failed",
558 full_fname(dest_path));
559 exit_cleanup(RERR_FILESELECT);
567 /* This is only called by the sender. */
568 static void read_final_goodbye(int f_in, int f_out)
572 if (protocol_version < 29)
575 while ((i = read_int(f_in)) == the_file_list->count
576 && read_shortint(f_in) == ITEM_IS_NEW) {
577 /* Forward the keep-alive (no-op) to the receiver. */
578 write_int(f_out, the_file_list->count);
579 write_shortint(f_out, ITEM_IS_NEW);
584 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
586 exit_cleanup(RERR_PROTOCOL);
591 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
593 struct file_list *flist;
597 rprintf(FINFO, "server_sender starting pid=%ld\n",
601 if (am_daemon && lp_write_only(module_id)) {
602 rprintf(FERROR, "ERROR: module is write only\n");
603 exit_cleanup(RERR_SYNTAX);
606 if (am_daemon && lp_read_only(module_id) && remove_sent_files) {
608 "ERROR: --remove-sent-files cannot be used with a read-only module\n");
609 exit_cleanup(RERR_SYNTAX);
613 if (!relative_paths) {
615 die_on_unsafe_path(dir, 0);
616 if (!push_dir(dir)) {
617 rsyserr(FERROR, errno, "push_dir#3 %s failed",
619 exit_cleanup(RERR_FILESELECT);
625 if (argc == 0 && (recurse || list_only)) {
631 flist = send_file_list(f_out,argc,argv);
632 if (!flist || flist->count == 0) {
635 the_file_list = flist;
637 io_start_buffering_in();
638 io_start_buffering_out();
640 send_files(flist,f_out,f_in);
641 io_flush(FULL_FLUSH);
643 if (protocol_version >= 24)
644 read_final_goodbye(f_in, f_out);
645 io_flush(FULL_FLUSH);
650 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
656 /* The receiving side mustn't obey this, or an existing symlink that
657 * points to an identical file won't be replaced by the referent. */
658 copy_links = copy_dirlinks = 0;
660 if (preserve_hard_links)
663 if (fd_pair(error_pipe) < 0) {
664 rsyserr(FERROR, errno, "pipe failed in do_recv");
665 exit_cleanup(RERR_IPC);
668 io_flush(NORMAL_FLUSH);
670 if ((pid = do_fork()) == -1) {
671 rsyserr(FERROR, errno, "fork failed in do_recv");
672 exit_cleanup(RERR_IPC);
676 close(error_pipe[0]);
680 /* we can't let two processes write to the socket at one time */
681 close_multiplexing_out();
683 /* set place to send errors */
684 set_msg_fd_out(error_pipe[1]);
686 recv_files(f_in, flist, local_name);
687 io_flush(FULL_FLUSH);
690 send_msg(MSG_DONE, "", 0);
691 io_flush(FULL_FLUSH);
693 /* Handle any keep-alive packets from the post-processing work
694 * that the generator does. */
695 if (protocol_version >= 29) {
696 kluge_around_eof = -1;
698 /* This should only get stopped via a USR2 signal. */
699 while (read_int(f_in) == flist->count
700 && read_shortint(f_in) == ITEM_IS_NEW) {}
702 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
704 exit_cleanup(RERR_PROTOCOL);
707 /* Finally, we go to sleep until our parent kills us with a
708 * USR2 signal. We sleep for a short time, as on some OSes
709 * a signal won't interrupt a sleep! */
715 close_multiplexing_in();
716 if (write_batch && !am_server)
719 close(error_pipe[1]);
723 io_start_buffering_out();
725 set_msg_fd_in(error_pipe[0]);
727 generate_files(f_out, flist, local_name);
730 io_flush(FULL_FLUSH);
731 if (protocol_version >= 24) {
732 /* send a final goodbye message */
733 write_int(f_out, -1);
735 io_flush(FULL_FLUSH);
739 wait_process_with_flush(pid, &exit_code);
744 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
747 struct file_list *flist;
748 char *local_name = NULL;
750 int save_verbose = verbose;
752 if (filesfrom_fd >= 0) {
753 /* We can't mix messages with files-from data on the socket,
754 * so temporarily turn off verbose messages. */
759 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
760 argc, (long)getpid());
763 if (am_daemon && lp_read_only(module_id)) {
764 rprintf(FERROR,"ERROR: module is read only\n");
765 exit_cleanup(RERR_SYNTAX);
773 if (!am_daemon && !push_dir(dir)) {
774 rsyserr(FERROR, errno, "push_dir#4 %s failed",
776 exit_cleanup(RERR_FILESELECT);
780 io_start_buffering_in();
781 recv_filter_list(f_in);
783 if (filesfrom_fd >= 0) {
784 /* We need to send the files-from names to the sender at the
785 * same time that we receive the file-list from them, so we
786 * need the IO routines to automatically write out the names
787 * onto our f_out socket as we read the file-list. This
788 * avoids both deadlock and extra delays/buffers. */
789 io_set_filesfrom_fds(filesfrom_fd, f_out);
793 flist = recv_file_list(f_in);
794 verbose = save_verbose;
796 rprintf(FERROR,"server_recv: recv_file_list error\n");
797 exit_cleanup(RERR_FILESELECT);
799 the_file_list = flist;
802 local_name = get_local_name(flist,argv[0]);
804 /* Now that we know what our destination directory turned out to be,
805 * we can sanitize the --link-/copy-/compare-dest args correctly. */
806 if (sanitize_paths) {
808 for (dir = basis_dir; *dir; dir++)
809 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
812 exit_code = do_recv(f_in,f_out,flist,local_name);
813 exit_cleanup(exit_code);
817 int child_main(int argc, char *argv[])
819 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
824 void start_server(int f_in, int f_out, int argc, char *argv[])
826 set_nonblocking(f_in);
827 set_nonblocking(f_out);
829 io_set_sock_fds(f_in, f_out);
830 setup_protocol(f_out, f_in);
831 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
835 if (protocol_version >= 23)
836 io_start_multiplex_out();
839 keep_dirlinks = 0; /* Must be disabled on the sender. */
840 if (need_messages_from_generator)
841 io_start_multiplex_in();
843 recv_filter_list(f_in);
844 do_server_sender(f_in, f_out, argc, argv);
846 do_server_recv(f_in, f_out, argc, argv);
853 * This is called once the connection has been negotiated. It is used
854 * for rsyncd, remote-shell, and local connections.
856 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
858 struct file_list *flist = NULL;
859 int exit_code = 0, exit_code2 = 0;
860 char *local_name = NULL;
862 cleanup_child_pid = pid;
864 set_nonblocking(f_in);
865 set_nonblocking(f_out);
868 io_set_sock_fds(f_in, f_out);
869 setup_protocol(f_out,f_in);
870 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
874 if (protocol_version >= 23 && !read_batch)
875 io_start_multiplex_in();
877 /* We set our stderr file handle to blocking because ssh might have
878 * set it to non-blocking. This can be particularly troublesome if
879 * stderr is a clone of stdout, because ssh would have set our stdout
880 * to non-blocking at the same time (which can easily cause us to lose
881 * output from our print statements). This kluge shouldn't cause ssh
882 * any problems for how we use it. Note also that we delayed setting
883 * this until after the above protocol setup so that we know for sure
884 * that ssh is done twiddling its file descriptors. */
885 set_blocking(STDERR_FILENO);
888 keep_dirlinks = 0; /* Must be disabled on the sender. */
889 io_start_buffering_out();
892 send_filter_list(f_out);
896 if (write_batch && !am_server)
897 start_write_batch(f_out);
898 flist = send_file_list(f_out, argc, argv);
901 rprintf(FINFO,"file list sent\n");
902 the_file_list = flist;
904 io_flush(NORMAL_FLUSH);
905 send_files(flist,f_out,f_in);
906 io_flush(FULL_FLUSH);
908 if (protocol_version >= 24)
909 read_final_goodbye(f_in, f_out);
912 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
913 io_flush(FULL_FLUSH);
914 wait_process_with_flush(pid, &exit_code);
917 io_flush(FULL_FLUSH);
918 exit_cleanup(exit_code);
921 if (need_messages_from_generator && !read_batch)
922 io_start_multiplex_out();
927 send_filter_list(read_batch ? -1 : f_out);
929 if (filesfrom_fd >= 0) {
930 io_set_filesfrom_fds(filesfrom_fd, f_out);
934 if (write_batch && !am_server)
935 start_write_batch(f_in);
936 flist = recv_file_list(f_in);
937 the_file_list = flist;
939 if (flist && flist->count > 0) {
940 local_name = get_local_name(flist, argv[0]);
942 exit_code2 = do_recv(f_in, f_out, flist, local_name);
950 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
951 io_flush(FULL_FLUSH);
952 wait_process_with_flush(pid, &exit_code);
955 return MAX(exit_code, exit_code2);
958 static int copy_argv (char *argv[])
962 for (i = 0; argv[i]; i++) {
963 if (!(argv[i] = strdup(argv[i]))) {
964 rprintf (FERROR, "out of memory at %s(%d)\n",
975 * Start a client for either type of remote connection. Work out
976 * whether the arguments request a remote shell or rsyncd connection,
977 * and call the appropriate connection function, then run_client.
979 * Calls either start_socket_client (for sockets) or do_cmd and
980 * client_run (for ssh).
982 static int start_client(int argc, char *argv[])
985 char *shell_machine = NULL;
986 char *shell_path = NULL;
987 char *shell_user = NULL;
993 /* Don't clobber argv[] so that ps(1) can still show the right
995 if ((rc = copy_argv(argv)))
998 if (!read_batch) { /* for read_batch, NO source is specified */
999 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1000 if (shell_path) { /* source is remote */
1004 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1006 "The source and destination cannot both be remote.\n");
1007 exit_cleanup(RERR_SYNTAX);
1010 if (filesfrom_host && *filesfrom_host
1011 && strcmp(filesfrom_host, shell_machine) != 0) {
1013 "--files-from hostname is not the same as the transfer hostname\n");
1014 exit_cleanup(RERR_SYNTAX);
1018 return start_socket_client(shell_machine,
1022 daemon_over_rsh = 1;
1026 } else { /* source is local, check dest arg */
1036 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1037 if (shell_path && filesfrom_host && *filesfrom_host
1038 && strcmp(filesfrom_host, shell_machine) != 0) {
1040 "--files-from hostname is not the same as the transfer hostname\n");
1041 exit_cleanup(RERR_SYNTAX);
1043 if (!shell_path) { /* no hostspec found, so src & dest are local */
1045 if (filesfrom_host) {
1047 "--files-from cannot be remote when the transfer is local\n");
1048 exit_cleanup(RERR_SYNTAX);
1050 shell_machine = NULL;
1052 } else if (rsync_port) {
1054 return start_socket_client(shell_machine,
1058 daemon_over_rsh = 1;
1061 } else { /* read_batch */
1063 shell_path = argv[argc-1];
1064 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1065 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1066 exit_cleanup(RERR_SYNTAX);
1070 if (shell_machine) {
1071 p = strrchr(shell_machine,'@');
1074 shell_user = shell_machine;
1075 shell_machine = p+1;
1080 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1081 shell_cmd ? shell_cmd : "",
1082 shell_machine ? shell_machine : "",
1083 shell_user ? shell_user : "",
1084 shell_path ? shell_path : "");
1087 /* for remote source, only single dest arg can remain ... */
1088 if (!am_sender && argc > 1) {
1090 exit_cleanup(RERR_SYNTAX);
1093 /* ... or no dest at all */
1094 if (!am_sender && argc == 0)
1097 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1100 /* if we're running an rsync server on the remote host over a
1101 * remote shell command, we need to do the RSYNCD protocol first */
1102 if (daemon_over_rsh) {
1104 tmpret = start_inband_exchange(shell_user, shell_path,
1110 ret = client_run(f_in, f_out, pid, argc, argv);
1119 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1121 exit_cleanup(RERR_SIGNAL1);
1124 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1130 _exit(RERR_PARTIAL);
1134 RETSIGTYPE remember_children(UNUSED(int val))
1139 /* An empty waitpid() loop was put here by Tridge and we could never
1140 * get him to explain why he put it in, so rather than taking it
1141 * out we're instead saving the child exit statuses for later use.
1142 * The waitpid() loop presumably eliminates all possibility of leaving
1143 * zombie children, maybe that's why he did it. */
1144 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1145 /* save the child's exit status */
1146 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1147 if (pid_stat_table[cnt].pid == 0) {
1148 pid_stat_table[cnt].pid = pid;
1149 pid_stat_table[cnt].status = status;
1155 #ifndef HAVE_SIGACTION
1156 signal(SIGCHLD, remember_children);
1162 * This routine catches signals and tries to send them to gdb.
1164 * Because it's called from inside a signal handler it ought not to
1165 * use too many library routines.
1167 * @todo Perhaps use "screen -X" instead/as well, to help people
1168 * debugging without easy access to X. Perhaps use an environment
1169 * variable, or just call a script?
1171 * @todo The /proc/ magic probably only works on Linux (and
1172 * Solaris?) Can we be more portable?
1174 #ifdef MAINTAINER_MODE
1175 const char *get_panic_action(void)
1177 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1182 return "xterm -display :0 -T Panic -n Panic "
1183 "-e gdb /proc/%d/exe %d";
1188 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1190 * This signal handler is only installed if we were configured with
1191 * --enable-maintainer-mode. Perhaps it should always be on and we
1192 * should just look at the environment variable, but I'm a bit leery
1193 * of a signal sending us into a busy loop.
1195 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1200 sprintf(cmd_buf, get_panic_action(),
1201 getpid(), getpid());
1203 /* Unless we failed to execute gdb, we allow the process to
1204 * continue. I'm not sure if that's right. */
1205 ret = system(cmd_buf);
1212 int main(int argc,char *argv[])
1215 int orig_argc = argc;
1216 char **orig_argv = argv;
1217 #ifdef HAVE_SIGACTION
1218 # ifdef HAVE_SIGPROCMASK
1221 sigemptyset(&sigmask);
1223 sigact.sa_flags = SA_NOCLDSTOP;
1225 SIGACTMASK(SIGUSR1, sigusr1_handler);
1226 SIGACTMASK(SIGUSR2, sigusr2_handler);
1227 SIGACTMASK(SIGCHLD, remember_children);
1228 #ifdef MAINTAINER_MODE
1229 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1230 SIGACTMASK(SIGFPE, rsync_panic_handler);
1231 SIGACTMASK(SIGABRT, rsync_panic_handler);
1232 SIGACTMASK(SIGBUS, rsync_panic_handler);
1235 starttime = time(NULL);
1236 am_root = (MY_UID() == 0);
1238 memset(&stats, 0, sizeof(stats));
1242 exit_cleanup(RERR_SYNTAX);
1245 /* we set a 0 umask so that correct file permissions can be
1247 orig_umask = umask(0);
1249 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1250 setlocale(LC_CTYPE, "");
1253 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1254 /* FIXME: We ought to call the same error-handling
1255 * code here, rather than relying on getopt. */
1257 exit_cleanup(RERR_SYNTAX);
1260 SIGACTMASK(SIGINT, sig_int);
1261 SIGACTMASK(SIGHUP, sig_int);
1262 SIGACTMASK(SIGTERM, sig_int);
1263 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1264 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1267 /* Ignore SIGPIPE; we consistently check error codes and will
1269 SIGACTION(SIGPIPE, SIG_IGN);
1271 SIGACTION(SIGXFSZ, SIG_IGN);
1274 /* Initialize push_dir here because on some old systems getcwd
1275 * (implemented by forking "pwd" and reading its output) doesn't
1276 * work when there are other child processes. Also, on all systems
1277 * that implement getcwd that way "pwd" can't be found after chroot. */
1282 if ((write_batch || read_batch) && !am_server) {
1284 write_batch_shell_file(orig_argc, orig_argv, argc);
1286 if (read_batch && strcmp(batch_name, "-") == 0)
1287 batch_fd = STDIN_FILENO;
1289 batch_fd = do_open(batch_name,
1290 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1291 : O_RDONLY, S_IRUSR | S_IWUSR);
1294 rsyserr(FERROR, errno, "Batch file %s open error",
1295 full_fname(batch_name));
1296 exit_cleanup(RERR_FILEIO);
1299 read_stream_flags(batch_fd);
1301 if (write_batch < 0)
1304 if (am_daemon && !am_server)
1305 return daemon_main();
1309 exit_cleanup(RERR_SYNTAX);
1313 set_nonblocking(STDIN_FILENO);
1314 set_nonblocking(STDOUT_FILENO);
1316 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1317 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1320 ret = start_client(argc, argv);
1322 exit_cleanup(RERR_STARTCLIENT);