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 *partial_dir;
66 extern char *basis_dir[];
67 extern char *rsync_path;
68 extern char *shell_cmd;
69 extern char *batch_name;
70 extern struct filter_list_struct server_filter_list;
73 mode_t orig_umask = 0;
74 struct file_list *the_file_list;
76 /* There's probably never more than at most 2 outstanding child processes,
77 * but set it higher, just in case. */
78 #define MAXCHILDPROCS 7
81 # ifdef HAVE_SIGPROCMASK
82 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
84 # define SIGACTMASK(n,h) SIGACTION(n,h)
86 static struct sigaction sigact;
92 } pid_stat_table[MAXCHILDPROCS];
94 static time_t starttime, endtime;
95 static int64 total_read, total_written;
97 static void show_malloc_stats(void);
99 /* Works like waitpid(), but if we already harvested the child pid in our
100 * remember_children(), we succeed instead of returning an error. */
101 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
103 pid_t waited_pid = waitpid(pid, status_ptr, flags);
105 if (waited_pid == -1 && errno == ECHILD) {
106 /* Status of requested child no longer available: check to
107 * see if it was processed by remember_children(). */
109 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
110 if (pid == pid_stat_table[cnt].pid) {
111 *status_ptr = pid_stat_table[cnt].status;
112 pid_stat_table[cnt].pid = 0;
121 /* Wait for a process to exit, calling io_flush while waiting. */
122 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
127 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
129 io_flush(FULL_FLUSH);
132 /* TODO: If the child exited on a signal, then log an
133 * appropriate error message. Perhaps we should also accept a
134 * message describing the purpose of the child. Also indicate
135 * this to the caller so that they know something went wrong. */
136 if (waited_pid < 0) {
137 rsyserr(FERROR, errno, "waitpid");
138 *exit_code_ptr = RERR_WAITCHILD;
139 } else if (!WIFEXITED(status)) {
141 if (WCOREDUMP(status))
142 *exit_code_ptr = RERR_CRASHED;
145 if (WIFSIGNALED(status))
146 *exit_code_ptr = RERR_TERMINATED;
148 *exit_code_ptr = RERR_WAITCHILD;
150 *exit_code_ptr = WEXITSTATUS(status);
153 /* This function gets called from all 3 processes. We want the client side
154 * to actually output the text, but the sender is the only process that has
155 * all the stats we need. So, if we're a client sender, we do the report.
156 * If we're a server sender, we write the stats on the supplied fd. If
157 * we're the client receiver we read the stats from the supplied fd and do
158 * the report. All processes might also generate a set of debug stats, if
159 * the verbose level is high enough (this is the only thing that the
160 * generator process and the server receiver ever do here). */
161 static void handle_stats(int f)
163 endtime = time(NULL);
165 /* Cache two stats because the read/write code can change it. */
166 total_read = stats.total_read;
167 total_written = stats.total_written;
169 if (do_stats && verbose > 1) {
170 /* These come out from every process */
179 if (f == -1 || !am_sender)
185 write_longint(f, total_read);
186 write_longint(f, total_written);
187 write_longint(f, stats.total_size);
188 if (protocol_version >= 29) {
189 write_longint(f, stats.flist_buildtime);
190 write_longint(f, stats.flist_xfertime);
196 /* this is the client */
198 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
200 else if (!am_sender) {
201 /* Read the first two in opposite order because the meaning of
202 * read/write swaps when switching from sender to receiver. */
203 total_written = read_longint(f);
204 total_read = read_longint(f);
205 stats.total_size = read_longint(f);
206 if (protocol_version >= 29) {
207 stats.flist_buildtime = read_longint(f);
208 stats.flist_xfertime = read_longint(f);
210 } else if (write_batch) {
211 /* The --read-batch process is going to be a client
212 * receiver, so we need to give it the stats. */
213 write_longint(batch_fd, total_read);
214 write_longint(batch_fd, total_written);
215 write_longint(batch_fd, stats.total_size);
216 if (protocol_version >= 29) {
217 write_longint(batch_fd, stats.flist_buildtime);
218 write_longint(batch_fd, stats.flist_xfertime);
223 static void output_summary(void)
226 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
227 rprintf(FINFO,"Number of files transferred: %d\n",
228 stats.num_transferred_files);
229 rprintf(FINFO,"Total file size: %s bytes\n",
230 human_num(stats.total_size));
231 rprintf(FINFO,"Total transferred file size: %s bytes\n",
232 human_num(stats.total_transferred_size));
233 rprintf(FINFO,"Literal data: %s bytes\n",
234 human_num(stats.literal_data));
235 rprintf(FINFO,"Matched data: %s bytes\n",
236 human_num(stats.matched_data));
237 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
238 if (stats.flist_buildtime) {
240 "File list generation time: %.3f seconds\n",
241 (double)stats.flist_buildtime / 1000);
243 "File list transfer time: %.3f seconds\n",
244 (double)stats.flist_xfertime / 1000);
246 rprintf(FINFO,"Total bytes sent: %s\n",
247 human_num(total_written));
248 rprintf(FINFO,"Total bytes received: %s\n",
249 human_num(total_read));
252 if (verbose || do_stats) {
254 "\nsent %s bytes received %s bytes %s bytes/sec\n",
255 human_num(total_written), human_num(total_read),
256 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
257 rprintf(FINFO, "total size is %s speedup is %.2f\n",
258 human_num(stats.total_size),
259 (double)stats.total_size / (total_written+total_read));
268 * If our C library can get malloc statistics, then show them to FINFO
270 static void show_malloc_stats(void)
277 rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
278 getpid(), am_server ? "server " : "",
279 am_daemon ? "daemon " : "", who_am_i());
280 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
282 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
284 rprintf(FINFO, " smblks: %10ld\n",
286 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
288 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
290 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
291 (long)mi.arena + mi.hblkhd);
292 rprintf(FINFO, " usmblks: %10ld\n",
294 rprintf(FINFO, " fsmblks: %10ld\n",
296 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
298 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
300 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
302 #endif /* HAVE_MALLINFO */
306 /* Start the remote shell. cmd may be NULL to use the default. */
307 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
308 int *f_in, int *f_out)
311 char *args[MAX_ARGS];
316 if (!read_batch && !local_server) {
317 char *t, *f, in_quote = '\0';
318 char *rsh_env = getenv(RSYNC_RSH_ENV);
327 for (t = f = cmd; *f; f++) {
330 /* Comparison leaves rooms for server_options(). */
331 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
332 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
333 exit_cleanup(RERR_SYNTAX);
336 while (*f != ' ' || in_quote) {
340 "Missing trailing-%c in remote-shell command.\n",
342 exit_cleanup(RERR_SYNTAX);
347 if (*f == '\'' || *f == '"') {
352 if (*f == in_quote && *++f != in_quote) {
362 /* check to see if we've already been given '-l user' in
363 * the remote-shell command */
364 for (i = 0; i < argc-1; i++) {
365 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
370 /* remsh (on HPUX) takes the arguments the other way around */
371 args[argc++] = machine;
372 if (user && !(daemon_over_rsh && dash_l_set)) {
377 if (user && !(daemon_over_rsh && dash_l_set)) {
381 args[argc++] = machine;
384 args[argc++] = rsync_path;
386 if (blocking_io < 0) {
388 if ((cp = strrchr(cmd, '/')) != NULL)
392 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
396 server_options(args,&argc);
398 if (argc >= MAX_ARGS - 2) {
399 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
400 exit_cleanup(RERR_SYNTAX);
406 if (!daemon_over_rsh && path && *path)
412 for (i = 0; i < argc; i++)
413 rprintf(FINFO, "cmd[%d]=%s ", i, args[i]);
414 rprintf(FINFO, "\n");
418 int from_gen_pipe[2];
419 if (fd_pair(from_gen_pipe) < 0) {
420 rsyserr(FERROR, errno, "pipe");
421 exit_cleanup(RERR_IPC);
423 batch_gen_fd = from_gen_pipe[0];
424 *f_out = from_gen_pipe[1];
426 ret = -1; /* no child pid */
427 } else if (local_server) {
428 /* If the user didn't request --[no-]whole-file, force
429 * it on, but only if we're not batch processing. */
430 if (whole_file < 0 && !write_batch)
432 ret = local_child(argc, args, f_in, f_out, child_main);
434 ret = piped_child(args,f_in,f_out);
442 out_of_memory("do_cmd");
443 return 0; /* not reached */
446 /* The receiving side operates in one of two modes:
448 * 1. it receives any number of files into a destination directory,
449 * placing them according to their names in the file-list.
451 * 2. it receives a single file and saves it using the name in the
452 * destination path instead of its file-list name. This requires a
453 * "local name" for writing out the destination file.
455 * So, our task is to figure out what mode/local-name we need and return
456 * either a NULL for mode 1, or the local-name for mode 2. We also
457 * change directory if there are any path components in dest_path. */
458 static char *get_local_name(struct file_list *flist, char *dest_path)
464 rprintf(FINFO, "get_local_name count=%d %s\n",
465 flist->count, NS(dest_path));
468 if (!dest_path || list_only)
471 /* If the destination path refers to an existing directory, enter
472 * it and use mode 1. If there is something other than a directory
473 * at the destination path, we must be transferring one file
474 * (anything at the destination will be overwritten). */
475 if (safe_stat(dest_path, &st) == 0) {
476 if (S_ISDIR(st.st_mode)) {
478 die_on_unsafe_path(dest_path, 0);
479 if (!push_dir(dest_path)) {
480 rsyserr(FERROR, errno, "push_dir#1 %s failed",
481 full_fname(dest_path));
482 exit_cleanup(RERR_FILESELECT);
486 if (sanitize_paths && S_ISLNK(st.st_mode))
487 die_on_unsafe_path(dest_path, 0);
488 if (flist->count > 1) {
490 "ERROR: destination must be a directory when"
491 " copying more than 1 file\n");
492 exit_cleanup(RERR_FILESELECT);
494 /* Caution: flist->count could be 0! */
495 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
497 "ERROR: cannot overwrite non-directory"
498 " with a directory\n");
499 exit_cleanup(RERR_FILESELECT);
501 } else if (errno != ENOENT) {
502 rsyserr(FERROR, errno, "cannot stat destination %s",
503 full_fname(dest_path));
504 exit_cleanup(RERR_FILESELECT);
507 cp = strrchr(dest_path, '/');
509 /* If the destination path ends in a slash or we are transferring
510 * multiple files, create a directory at the destination path,
511 * enter the new directory, and use mode 1. */
512 if (flist->count > 1 || (cp && !cp[1])) {
513 /* Lop off the final slash (if any). */
517 if (mkdir_defmode(dest_path) != 0) {
518 rsyserr(FERROR, errno, "mkdir %s failed",
519 full_fname(dest_path));
520 exit_cleanup(RERR_FILEIO);
524 rprintf(FINFO, "created directory %s\n", dest_path);
527 /* Indicate that the destination directory doesn't
528 * really exist and return mode 1. */
534 die_on_unsafe_path(dest_path, 0);
535 if (!push_dir(dest_path)) {
536 rsyserr(FERROR, errno, "push_dir#2 %s failed",
537 full_fname(dest_path));
538 exit_cleanup(RERR_FILESELECT);
544 /* Otherwise, we are writing a single file, possibly on top of an
545 * existing non-directory. Change to the item's parent directory
546 * (if it has a path component), return the basename of the
547 * destination file as the local name, and use mode 2. */
556 die_on_unsafe_path(dest_path, 0);
557 if (!push_dir(dest_path)) {
558 rsyserr(FERROR, errno, "push_dir#3 %s failed",
559 full_fname(dest_path));
560 exit_cleanup(RERR_FILESELECT);
568 /* This is only called by the sender. */
569 static void read_final_goodbye(int f_in, int f_out)
573 if (protocol_version < 29)
576 while ((i = read_int(f_in)) == the_file_list->count
577 && read_shortint(f_in) == ITEM_IS_NEW) {
578 /* Forward the keep-alive (no-op) to the receiver. */
579 write_int(f_out, the_file_list->count);
580 write_shortint(f_out, ITEM_IS_NEW);
585 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
587 exit_cleanup(RERR_PROTOCOL);
592 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
594 struct file_list *flist;
598 rprintf(FINFO, "server_sender starting pid=%ld\n",
602 if (am_daemon && lp_write_only(module_id)) {
603 rprintf(FERROR, "ERROR: module is write only\n");
604 exit_cleanup(RERR_SYNTAX);
607 if (am_daemon && lp_read_only(module_id) && remove_sent_files) {
609 "ERROR: --remove-sent-files cannot be used with a read-only module\n");
610 exit_cleanup(RERR_SYNTAX);
614 if (!relative_paths) {
616 die_on_unsafe_path(dir, 0);
617 if (!push_dir(dir)) {
618 rsyserr(FERROR, errno, "push_dir#3 %s failed",
620 exit_cleanup(RERR_FILESELECT);
626 if (argc == 0 && (recurse || list_only)) {
632 flist = send_file_list(f_out,argc,argv);
633 if (!flist || flist->count == 0) {
636 the_file_list = flist;
638 io_start_buffering_in();
639 io_start_buffering_out();
641 send_files(flist,f_out,f_in);
642 io_flush(FULL_FLUSH);
644 if (protocol_version >= 24)
645 read_final_goodbye(f_in, f_out);
646 io_flush(FULL_FLUSH);
651 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
657 /* The receiving side mustn't obey this, or an existing symlink that
658 * points to an identical file won't be replaced by the referent. */
659 copy_links = copy_dirlinks = 0;
661 if (preserve_hard_links)
664 if (fd_pair(error_pipe) < 0) {
665 rsyserr(FERROR, errno, "pipe failed in do_recv");
666 exit_cleanup(RERR_IPC);
669 io_flush(NORMAL_FLUSH);
671 if ((pid = do_fork()) == -1) {
672 rsyserr(FERROR, errno, "fork failed in do_recv");
673 exit_cleanup(RERR_IPC);
677 close(error_pipe[0]);
681 /* we can't let two processes write to the socket at one time */
682 close_multiplexing_out();
684 /* set place to send errors */
685 set_msg_fd_out(error_pipe[1]);
687 recv_files(f_in, flist, local_name);
688 io_flush(FULL_FLUSH);
691 send_msg(MSG_DONE, "", 0);
692 io_flush(FULL_FLUSH);
694 /* Handle any keep-alive packets from the post-processing work
695 * that the generator does. */
696 if (protocol_version >= 29) {
697 kluge_around_eof = -1;
699 /* This should only get stopped via a USR2 signal. */
700 while (read_int(f_in) == flist->count
701 && read_shortint(f_in) == ITEM_IS_NEW) {}
703 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
705 exit_cleanup(RERR_PROTOCOL);
708 /* Finally, we go to sleep until our parent kills us with a
709 * USR2 signal. We sleep for a short time, as on some OSes
710 * a signal won't interrupt a sleep! */
716 close_multiplexing_in();
717 if (write_batch && !am_server)
720 close(error_pipe[1]);
724 io_start_buffering_out();
726 set_msg_fd_in(error_pipe[0]);
728 generate_files(f_out, flist, local_name);
731 io_flush(FULL_FLUSH);
732 if (protocol_version >= 24) {
733 /* send a final goodbye message */
734 write_int(f_out, -1);
736 io_flush(FULL_FLUSH);
740 wait_process_with_flush(pid, &exit_code);
745 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
748 struct file_list *flist;
749 char *local_name = NULL;
751 int save_verbose = verbose;
753 if (filesfrom_fd >= 0) {
754 /* We can't mix messages with files-from data on the socket,
755 * so temporarily turn off verbose messages. */
760 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
761 argc, (long)getpid());
764 if (am_daemon && lp_read_only(module_id)) {
765 rprintf(FERROR,"ERROR: module is read only\n");
766 exit_cleanup(RERR_SYNTAX);
774 if (!am_daemon && !push_dir(dir)) {
775 rsyserr(FERROR, errno, "push_dir#4 %s failed",
777 exit_cleanup(RERR_FILESELECT);
781 io_start_buffering_in();
782 recv_filter_list(f_in);
784 if (filesfrom_fd >= 0) {
785 /* We need to send the files-from names to the sender at the
786 * same time that we receive the file-list from them, so we
787 * need the IO routines to automatically write out the names
788 * onto our f_out socket as we read the file-list. This
789 * avoids both deadlock and extra delays/buffers. */
790 io_set_filesfrom_fds(filesfrom_fd, f_out);
794 flist = recv_file_list(f_in);
795 verbose = save_verbose;
797 rprintf(FERROR,"server_recv: recv_file_list error\n");
798 exit_cleanup(RERR_FILESELECT);
800 the_file_list = flist;
803 local_name = get_local_name(flist,argv[0]);
805 /* Now that we know what our destination directory turned out to be,
806 * we can sanitize the --link-/copy-/compare-dest args correctly. */
807 if (sanitize_paths) {
809 for (dir = basis_dir; *dir; dir++) {
810 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
811 die_on_unsafe_path(*dir, 0);
814 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
815 /* A relative path gets this checked at every dir change. */
816 if (*partial_dir == '/')
817 die_on_unsafe_path(partial_dir, 0);
820 if (server_filter_list.head) {
822 struct filter_list_struct *elp = &server_filter_list;
824 for (dir = basis_dir; *dir; dir++) {
825 if (check_filter(elp, *dir, 1) < 0)
826 goto options_rejected;
828 if (partial_dir && *partial_dir == '/'
829 && check_filter(elp, partial_dir, 1) < 0) {
832 "Your options have been rejected by the server.\n");
833 exit_cleanup(RERR_SYNTAX);
837 exit_code = do_recv(f_in,f_out,flist,local_name);
838 exit_cleanup(exit_code);
842 int child_main(int argc, char *argv[])
844 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
849 void start_server(int f_in, int f_out, int argc, char *argv[])
851 set_nonblocking(f_in);
852 set_nonblocking(f_out);
854 io_set_sock_fds(f_in, f_out);
855 setup_protocol(f_out, f_in);
856 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
860 if (protocol_version >= 23)
861 io_start_multiplex_out();
864 keep_dirlinks = 0; /* Must be disabled on the sender. */
865 if (need_messages_from_generator)
866 io_start_multiplex_in();
868 recv_filter_list(f_in);
869 do_server_sender(f_in, f_out, argc, argv);
871 do_server_recv(f_in, f_out, argc, argv);
878 * This is called once the connection has been negotiated. It is used
879 * for rsyncd, remote-shell, and local connections.
881 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
883 struct file_list *flist = NULL;
884 int exit_code = 0, exit_code2 = 0;
885 char *local_name = NULL;
887 cleanup_child_pid = pid;
889 set_nonblocking(f_in);
890 set_nonblocking(f_out);
893 io_set_sock_fds(f_in, f_out);
894 setup_protocol(f_out,f_in);
895 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
899 if (protocol_version >= 23 && !read_batch)
900 io_start_multiplex_in();
902 /* We set our stderr file handle to blocking because ssh might have
903 * set it to non-blocking. This can be particularly troublesome if
904 * stderr is a clone of stdout, because ssh would have set our stdout
905 * to non-blocking at the same time (which can easily cause us to lose
906 * output from our print statements). This kluge shouldn't cause ssh
907 * any problems for how we use it. Note also that we delayed setting
908 * this until after the above protocol setup so that we know for sure
909 * that ssh is done twiddling its file descriptors. */
910 set_blocking(STDERR_FILENO);
913 keep_dirlinks = 0; /* Must be disabled on the sender. */
914 io_start_buffering_out();
917 send_filter_list(f_out);
921 if (write_batch && !am_server)
922 start_write_batch(f_out);
923 flist = send_file_list(f_out, argc, argv);
926 rprintf(FINFO,"file list sent\n");
927 the_file_list = flist;
929 io_flush(NORMAL_FLUSH);
930 send_files(flist,f_out,f_in);
931 io_flush(FULL_FLUSH);
933 if (protocol_version >= 24)
934 read_final_goodbye(f_in, f_out);
937 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
938 io_flush(FULL_FLUSH);
939 wait_process_with_flush(pid, &exit_code);
942 io_flush(FULL_FLUSH);
943 exit_cleanup(exit_code);
946 if (need_messages_from_generator && !read_batch)
947 io_start_multiplex_out();
952 send_filter_list(read_batch ? -1 : f_out);
954 if (filesfrom_fd >= 0) {
955 io_set_filesfrom_fds(filesfrom_fd, f_out);
959 if (write_batch && !am_server)
960 start_write_batch(f_in);
961 flist = recv_file_list(f_in);
962 the_file_list = flist;
964 if (flist && flist->count > 0) {
965 local_name = get_local_name(flist, argv[0]);
967 exit_code2 = do_recv(f_in, f_out, flist, local_name);
975 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
976 io_flush(FULL_FLUSH);
977 wait_process_with_flush(pid, &exit_code);
980 return MAX(exit_code, exit_code2);
983 static int copy_argv (char *argv[])
987 for (i = 0; argv[i]; i++) {
988 if (!(argv[i] = strdup(argv[i]))) {
989 rprintf (FERROR, "out of memory at %s(%d)\n",
1000 * Start a client for either type of remote connection. Work out
1001 * whether the arguments request a remote shell or rsyncd connection,
1002 * and call the appropriate connection function, then run_client.
1004 * Calls either start_socket_client (for sockets) or do_cmd and
1005 * client_run (for ssh).
1007 static int start_client(int argc, char *argv[])
1010 char *shell_machine = NULL;
1011 char *shell_path = NULL;
1012 char *shell_user = NULL;
1018 /* Don't clobber argv[] so that ps(1) can still show the right
1020 if ((rc = copy_argv(argv)))
1023 if (!read_batch) { /* for read_batch, NO source is specified */
1024 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1025 if (shell_path) { /* source is remote */
1029 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1031 "The source and destination cannot both be remote.\n");
1032 exit_cleanup(RERR_SYNTAX);
1035 if (filesfrom_host && *filesfrom_host
1036 && strcmp(filesfrom_host, shell_machine) != 0) {
1038 "--files-from hostname is not the same as the transfer hostname\n");
1039 exit_cleanup(RERR_SYNTAX);
1043 return start_socket_client(shell_machine,
1047 daemon_over_rsh = 1;
1051 } else { /* source is local, check dest arg */
1061 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1062 if (shell_path && filesfrom_host && *filesfrom_host
1063 && strcmp(filesfrom_host, shell_machine) != 0) {
1065 "--files-from hostname is not the same as the transfer hostname\n");
1066 exit_cleanup(RERR_SYNTAX);
1068 if (!shell_path) { /* no hostspec found, so src & dest are local */
1070 if (filesfrom_host) {
1072 "--files-from cannot be remote when the transfer is local\n");
1073 exit_cleanup(RERR_SYNTAX);
1075 shell_machine = NULL;
1077 } else if (rsync_port) {
1079 return start_socket_client(shell_machine,
1083 daemon_over_rsh = 1;
1086 } else { /* read_batch */
1088 shell_path = argv[argc-1];
1089 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1090 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1091 exit_cleanup(RERR_SYNTAX);
1095 if (shell_machine) {
1096 p = strrchr(shell_machine,'@');
1099 shell_user = shell_machine;
1100 shell_machine = p+1;
1105 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1106 shell_cmd ? shell_cmd : "",
1107 shell_machine ? shell_machine : "",
1108 shell_user ? shell_user : "",
1109 shell_path ? shell_path : "");
1112 /* for remote source, only single dest arg can remain ... */
1113 if (!am_sender && argc > 1) {
1115 exit_cleanup(RERR_SYNTAX);
1118 /* ... or no dest at all */
1119 if (!am_sender && argc == 0)
1122 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1125 /* if we're running an rsync server on the remote host over a
1126 * remote shell command, we need to do the RSYNCD protocol first */
1127 if (daemon_over_rsh) {
1129 tmpret = start_inband_exchange(shell_user, shell_path,
1135 ret = client_run(f_in, f_out, pid, argc, argv);
1144 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1146 exit_cleanup(RERR_SIGNAL1);
1149 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1155 _exit(RERR_PARTIAL);
1159 RETSIGTYPE remember_children(UNUSED(int val))
1164 /* An empty waitpid() loop was put here by Tridge and we could never
1165 * get him to explain why he put it in, so rather than taking it
1166 * out we're instead saving the child exit statuses for later use.
1167 * The waitpid() loop presumably eliminates all possibility of leaving
1168 * zombie children, maybe that's why he did it. */
1169 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1170 /* save the child's exit status */
1171 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1172 if (pid_stat_table[cnt].pid == 0) {
1173 pid_stat_table[cnt].pid = pid;
1174 pid_stat_table[cnt].status = status;
1180 #ifndef HAVE_SIGACTION
1181 signal(SIGCHLD, remember_children);
1187 * This routine catches signals and tries to send them to gdb.
1189 * Because it's called from inside a signal handler it ought not to
1190 * use too many library routines.
1192 * @todo Perhaps use "screen -X" instead/as well, to help people
1193 * debugging without easy access to X. Perhaps use an environment
1194 * variable, or just call a script?
1196 * @todo The /proc/ magic probably only works on Linux (and
1197 * Solaris?) Can we be more portable?
1199 #ifdef MAINTAINER_MODE
1200 const char *get_panic_action(void)
1202 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1207 return "xterm -display :0 -T Panic -n Panic "
1208 "-e gdb /proc/%d/exe %d";
1213 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1215 * This signal handler is only installed if we were configured with
1216 * --enable-maintainer-mode. Perhaps it should always be on and we
1217 * should just look at the environment variable, but I'm a bit leery
1218 * of a signal sending us into a busy loop.
1220 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1225 sprintf(cmd_buf, get_panic_action(),
1226 getpid(), getpid());
1228 /* Unless we failed to execute gdb, we allow the process to
1229 * continue. I'm not sure if that's right. */
1230 ret = system(cmd_buf);
1237 int main(int argc,char *argv[])
1240 int orig_argc = argc;
1241 char **orig_argv = argv;
1242 #ifdef HAVE_SIGACTION
1243 # ifdef HAVE_SIGPROCMASK
1246 sigemptyset(&sigmask);
1248 sigact.sa_flags = SA_NOCLDSTOP;
1250 SIGACTMASK(SIGUSR1, sigusr1_handler);
1251 SIGACTMASK(SIGUSR2, sigusr2_handler);
1252 SIGACTMASK(SIGCHLD, remember_children);
1253 #ifdef MAINTAINER_MODE
1254 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1255 SIGACTMASK(SIGFPE, rsync_panic_handler);
1256 SIGACTMASK(SIGABRT, rsync_panic_handler);
1257 SIGACTMASK(SIGBUS, rsync_panic_handler);
1260 starttime = time(NULL);
1261 am_root = (MY_UID() == 0);
1263 memset(&stats, 0, sizeof(stats));
1267 exit_cleanup(RERR_SYNTAX);
1270 /* we set a 0 umask so that correct file permissions can be
1272 orig_umask = umask(0);
1274 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1275 setlocale(LC_CTYPE, "");
1278 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1279 /* FIXME: We ought to call the same error-handling
1280 * code here, rather than relying on getopt. */
1282 exit_cleanup(RERR_SYNTAX);
1285 SIGACTMASK(SIGINT, sig_int);
1286 SIGACTMASK(SIGHUP, sig_int);
1287 SIGACTMASK(SIGTERM, sig_int);
1288 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1289 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1292 /* Ignore SIGPIPE; we consistently check error codes and will
1294 SIGACTION(SIGPIPE, SIG_IGN);
1296 SIGACTION(SIGXFSZ, SIG_IGN);
1299 /* Initialize push_dir here because on some old systems getcwd
1300 * (implemented by forking "pwd" and reading its output) doesn't
1301 * work when there are other child processes. Also, on all systems
1302 * that implement getcwd that way "pwd" can't be found after chroot. */
1307 if ((write_batch || read_batch) && !am_server) {
1309 write_batch_shell_file(orig_argc, orig_argv, argc);
1311 if (read_batch && strcmp(batch_name, "-") == 0)
1312 batch_fd = STDIN_FILENO;
1314 batch_fd = do_open(batch_name,
1315 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1316 : O_RDONLY, S_IRUSR | S_IWUSR);
1319 rsyserr(FERROR, errno, "Batch file %s open error",
1320 full_fname(batch_name));
1321 exit_cleanup(RERR_FILEIO);
1324 read_stream_flags(batch_fd);
1326 if (write_batch < 0)
1329 if (am_daemon && !am_server)
1330 return daemon_main();
1334 exit_cleanup(RERR_SYNTAX);
1338 set_nonblocking(STDIN_FILENO);
1339 set_nonblocking(STDOUT_FILENO);
1341 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1342 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1345 ret = start_client(argc, argv);
1347 exit_cleanup(RERR_STARTCLIENT);