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;
76 mode_t orig_umask = 0;
77 struct file_list *the_file_list;
79 /* There's probably never more than at most 2 outstanding child processes,
80 * but set it higher, just in case. */
81 #define MAXCHILDPROCS 7
84 # ifdef HAVE_SIGPROCMASK
85 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
87 # define SIGACTMASK(n,h) SIGACTION(n,h)
89 static struct sigaction sigact;
95 } pid_stat_table[MAXCHILDPROCS];
97 static time_t starttime, endtime;
98 static int64 total_read, total_written;
100 static void show_malloc_stats(void);
102 /* Works like waitpid(), but if we already harvested the child pid in our
103 * remember_children(), we succeed instead of returning an error. */
104 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
109 waited_pid = waitpid(pid, status_ptr, flags);
110 } while (waited_pid == -1 && errno == EINTR);
112 if (waited_pid == -1 && errno == ECHILD) {
113 /* Status of requested child no longer available: check to
114 * see if it was processed by remember_children(). */
116 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
117 if (pid == pid_stat_table[cnt].pid) {
118 *status_ptr = pid_stat_table[cnt].status;
119 pid_stat_table[cnt].pid = 0;
128 /* Wait for a process to exit, calling io_flush while waiting. */
129 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
134 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
136 io_flush(FULL_FLUSH);
139 /* TODO: If the child exited on a signal, then log an
140 * appropriate error message. Perhaps we should also accept a
141 * message describing the purpose of the child. Also indicate
142 * this to the caller so that they know something went wrong. */
143 if (waited_pid < 0) {
144 rsyserr(FERROR, errno, "waitpid");
145 *exit_code_ptr = RERR_WAITCHILD;
146 } else if (!WIFEXITED(status)) {
148 if (WCOREDUMP(status))
149 *exit_code_ptr = RERR_CRASHED;
152 if (WIFSIGNALED(status))
153 *exit_code_ptr = RERR_TERMINATED;
155 *exit_code_ptr = RERR_WAITCHILD;
157 *exit_code_ptr = WEXITSTATUS(status);
160 /* This function gets called from all 3 processes. We want the client side
161 * to actually output the text, but the sender is the only process that has
162 * all the stats we need. So, if we're a client sender, we do the report.
163 * If we're a server sender, we write the stats on the supplied fd. If
164 * we're the client receiver we read the stats from the supplied fd and do
165 * the report. All processes might also generate a set of debug stats, if
166 * the verbose level is high enough (this is the only thing that the
167 * generator process and the server receiver ever do here). */
168 static void handle_stats(int f)
170 endtime = time(NULL);
172 /* Cache two stats because the read/write code can change it. */
173 total_read = stats.total_read;
174 total_written = stats.total_written;
176 if (do_stats && verbose > 1) {
177 /* These come out from every process */
186 if (f == -1 || !am_sender)
192 write_longint(f, total_read);
193 write_longint(f, total_written);
194 write_longint(f, stats.total_size);
195 if (protocol_version >= 29) {
196 write_longint(f, stats.flist_buildtime);
197 write_longint(f, stats.flist_xfertime);
203 /* this is the client */
205 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
207 else if (!am_sender) {
208 /* Read the first two in opposite order because the meaning of
209 * read/write swaps when switching from sender to receiver. */
210 total_written = read_longint(f);
211 total_read = read_longint(f);
212 stats.total_size = read_longint(f);
213 if (protocol_version >= 29) {
214 stats.flist_buildtime = read_longint(f);
215 stats.flist_xfertime = read_longint(f);
217 } else if (write_batch) {
218 /* The --read-batch process is going to be a client
219 * receiver, so we need to give it the stats. */
220 write_longint(batch_fd, total_read);
221 write_longint(batch_fd, total_written);
222 write_longint(batch_fd, stats.total_size);
223 if (protocol_version >= 29) {
224 write_longint(batch_fd, stats.flist_buildtime);
225 write_longint(batch_fd, stats.flist_xfertime);
230 static void output_summary(void)
233 rprintf(FCLIENT, "\n");
234 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
235 rprintf(FINFO,"Number of files transferred: %d\n",
236 stats.num_transferred_files);
237 rprintf(FINFO,"Total file size: %s bytes\n",
238 human_num(stats.total_size));
239 rprintf(FINFO,"Total transferred file size: %s bytes\n",
240 human_num(stats.total_transferred_size));
241 rprintf(FINFO,"Literal data: %s bytes\n",
242 human_num(stats.literal_data));
243 rprintf(FINFO,"Matched data: %s bytes\n",
244 human_num(stats.matched_data));
245 rprintf(FINFO,"File list size: %s\n",
246 human_num(stats.flist_size));
247 if (stats.flist_buildtime) {
249 "File list generation time: %.3f seconds\n",
250 (double)stats.flist_buildtime / 1000);
252 "File list transfer time: %.3f seconds\n",
253 (double)stats.flist_xfertime / 1000);
255 rprintf(FINFO,"Total bytes sent: %s\n",
256 human_num(total_written));
257 rprintf(FINFO,"Total bytes received: %s\n",
258 human_num(total_read));
261 if (verbose || do_stats) {
262 rprintf(FCLIENT, "\n");
264 "sent %s bytes received %s bytes %s bytes/sec\n",
265 human_num(total_written), human_num(total_read),
266 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
267 rprintf(FINFO, "total size is %s speedup is %.2f\n",
268 human_num(stats.total_size),
269 (double)stats.total_size / (total_written+total_read));
278 * If our C library can get malloc statistics, then show them to FINFO
280 static void show_malloc_stats(void)
287 rprintf(FCLIENT, "\n");
288 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
289 getpid(), am_server ? "server " : "",
290 am_daemon ? "daemon " : "", who_am_i());
291 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
293 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
295 rprintf(FINFO, " smblks: %10ld\n",
297 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
299 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
301 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
302 (long)mi.arena + mi.hblkhd);
303 rprintf(FINFO, " usmblks: %10ld\n",
305 rprintf(FINFO, " fsmblks: %10ld\n",
307 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
309 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
311 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
313 #endif /* HAVE_MALLINFO */
317 /* Start the remote shell. cmd may be NULL to use the default. */
318 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
319 int *f_in, int *f_out)
322 char *args[MAX_ARGS];
327 if (!read_batch && !local_server) {
328 char *t, *f, in_quote = '\0';
329 char *rsh_env = getenv(RSYNC_RSH_ENV);
338 for (t = f = cmd; *f; f++) {
341 /* Comparison leaves rooms for server_options(). */
342 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
343 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
344 exit_cleanup(RERR_SYNTAX);
347 while (*f != ' ' || in_quote) {
351 "Missing trailing-%c in remote-shell command.\n",
353 exit_cleanup(RERR_SYNTAX);
358 if (*f == '\'' || *f == '"') {
363 if (*f == in_quote && *++f != in_quote) {
373 /* check to see if we've already been given '-l user' in
374 * the remote-shell command */
375 for (i = 0; i < argc-1; i++) {
376 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
381 /* remsh (on HPUX) takes the arguments the other way around */
382 args[argc++] = machine;
383 if (user && !(daemon_over_rsh && dash_l_set)) {
388 if (user && !(daemon_over_rsh && dash_l_set)) {
392 args[argc++] = machine;
395 args[argc++] = rsync_path;
397 if (blocking_io < 0) {
399 if ((cp = strrchr(cmd, '/')) != NULL)
403 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
407 server_options(args,&argc);
409 if (argc >= MAX_ARGS - 2) {
410 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
411 exit_cleanup(RERR_SYNTAX);
417 if (!daemon_over_rsh && path && *path)
423 for (i = 0; i < argc; i++)
424 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
425 rprintf(FCLIENT, "\n");
429 int from_gen_pipe[2];
430 if (fd_pair(from_gen_pipe) < 0) {
431 rsyserr(FERROR, errno, "pipe");
432 exit_cleanup(RERR_IPC);
434 batch_gen_fd = from_gen_pipe[0];
435 *f_out = from_gen_pipe[1];
437 ret = -1; /* no child pid */
438 } else if (local_server) {
439 /* If the user didn't request --[no-]whole-file, force
440 * it on, but only if we're not batch processing. */
441 if (whole_file < 0 && !write_batch)
443 ret = local_child(argc, args, f_in, f_out, child_main);
445 ret = piped_child(args,f_in,f_out);
453 out_of_memory("do_cmd");
454 return 0; /* not reached */
457 /* The receiving side operates in one of two modes:
459 * 1. it receives any number of files into a destination directory,
460 * placing them according to their names in the file-list.
462 * 2. it receives a single file and saves it using the name in the
463 * destination path instead of its file-list name. This requires a
464 * "local name" for writing out the destination file.
466 * So, our task is to figure out what mode/local-name we need.
467 * For mode 1, we change into the destination directory and return NULL.
468 * For mode 2, we change into the directory containing the destination
469 * file (if we aren't already there) and return the local-name. */
470 static char *get_local_name(struct file_list *flist, char *dest_path)
477 rprintf(FINFO, "get_local_name count=%d %s\n",
478 flist->count, NS(dest_path));
481 if (!dest_path || list_only)
484 /* See what currently exists at the destination. */
485 if ((statret = do_stat(dest_path, &st)) == 0) {
486 /* If the destination is a dir, enter it and use mode 1. */
487 if (S_ISDIR(st.st_mode)) {
488 if (!push_dir(dest_path, 0)) {
489 rsyserr(FERROR, errno, "push_dir#1 %s failed",
490 full_fname(dest_path));
491 exit_cleanup(RERR_FILESELECT);
495 if (flist->count > 1) {
497 "ERROR: destination must be a directory when"
498 " copying more than 1 file\n");
499 exit_cleanup(RERR_FILESELECT);
501 /* Caution: flist->count could be 0! */
502 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
504 "ERROR: cannot overwrite non-directory"
505 " with a directory\n");
506 exit_cleanup(RERR_FILESELECT);
508 } else if (errno != ENOENT) {
509 /* If we don't know what's at the destination, fail. */
510 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
511 full_fname(dest_path));
512 exit_cleanup(RERR_FILESELECT);
515 cp = strrchr(dest_path, '/');
517 /* If we need a destination directory because the transfer is not
518 * of a single non-directory or the user has requested one via a
519 * destination path ending in a slash, create one and use mode 1. */
520 if (flist->count > 1 || (cp && !cp[1])) {
521 /* Lop off the final slash (if any). */
527 "ERROR: destination path is not a directory\n");
528 exit_cleanup(RERR_SYNTAX);
531 if (mkdir_defmode(dest_path) != 0) {
532 rsyserr(FERROR, errno, "mkdir %s failed",
533 full_fname(dest_path));
534 exit_cleanup(RERR_FILEIO);
540 rprintf(FINFO, "created directory %s\n", dest_path);
543 /* Indicate that dest dir doesn't really exist. */
547 if (!push_dir(dest_path, dry_run > 1)) {
548 rsyserr(FERROR, errno, "push_dir#2 %s failed",
549 full_fname(dest_path));
550 exit_cleanup(RERR_FILESELECT);
556 /* Otherwise, we are writing a single file, possibly on top of an
557 * existing non-directory. Change to the item's parent directory
558 * (if it has a path component), return the basename of the
559 * destination file as the local name, and use mode 2. */
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);
633 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
635 struct file_list *flist;
639 rprintf(FINFO, "server_sender starting pid=%ld\n",
643 if (am_daemon && lp_write_only(module_id)) {
644 rprintf(FERROR, "ERROR: module is write only\n");
645 exit_cleanup(RERR_SYNTAX);
648 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
650 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
651 remove_source_files == 1 ? "source" : "sent");
652 exit_cleanup(RERR_SYNTAX);
656 if (!relative_paths) {
657 if (!push_dir(dir, 0)) {
658 rsyserr(FERROR, errno, "push_dir#3 %s failed",
660 exit_cleanup(RERR_FILESELECT);
666 if (argc == 0 && (recurse || list_only)) {
672 flist = send_file_list(f_out,argc,argv);
673 if (!flist || flist->count == 0)
675 the_file_list = flist;
677 io_start_buffering_in();
678 io_start_buffering_out();
680 send_files(flist,f_out,f_in);
681 io_flush(FULL_FLUSH);
683 if (protocol_version >= 24)
684 read_final_goodbye(f_in, f_out);
685 io_flush(FULL_FLUSH);
690 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
696 /* The receiving side mustn't obey this, or an existing symlink that
697 * points to an identical file won't be replaced by the referent. */
698 copy_links = copy_dirlinks = 0;
700 #ifdef SUPPORT_HARD_LINKS
701 if (preserve_hard_links)
705 if (fd_pair(error_pipe) < 0) {
706 rsyserr(FERROR, errno, "pipe failed in do_recv");
707 exit_cleanup(RERR_IPC);
710 io_flush(NORMAL_FLUSH);
712 if ((pid = do_fork()) == -1) {
713 rsyserr(FERROR, errno, "fork failed in do_recv");
714 exit_cleanup(RERR_IPC);
718 close(error_pipe[0]);
722 /* we can't let two processes write to the socket at one time */
723 close_multiplexing_out();
725 /* set place to send errors */
726 set_msg_fd_out(error_pipe[1]);
728 recv_files(f_in, flist, local_name);
729 io_flush(FULL_FLUSH);
732 send_msg(MSG_DONE, "", 0);
733 io_flush(FULL_FLUSH);
735 /* Handle any keep-alive packets from the post-processing work
736 * that the generator does. */
737 if (protocol_version >= 29) {
738 kluge_around_eof = -1;
740 /* This should only get stopped via a USR2 signal. */
741 while (read_int(f_in) == flist->count
742 && read_shortint(f_in) == ITEM_IS_NEW) {}
744 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
746 exit_cleanup(RERR_PROTOCOL);
749 /* Finally, we go to sleep until our parent kills us with a
750 * USR2 signal. We sleep for a short time, as on some OSes
751 * a signal won't interrupt a sleep! */
757 close_multiplexing_in();
758 if (write_batch && !am_server)
761 close(error_pipe[1]);
765 io_start_buffering_out();
767 set_msg_fd_in(error_pipe[0]);
769 generate_files(f_out, flist, local_name);
772 io_flush(FULL_FLUSH);
773 if (protocol_version >= 24) {
774 /* send a final goodbye message */
775 write_int(f_out, NDX_DONE);
777 io_flush(FULL_FLUSH);
781 wait_process_with_flush(pid, &exit_code);
785 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
788 struct file_list *flist;
789 char *local_name = NULL;
791 int save_verbose = verbose;
793 if (filesfrom_fd >= 0) {
794 /* We can't mix messages with files-from data on the socket,
795 * so temporarily turn off verbose messages. */
800 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
801 argc, (long)getpid());
804 if (am_daemon && lp_read_only(module_id)) {
805 rprintf(FERROR,"ERROR: module is read only\n");
806 exit_cleanup(RERR_SYNTAX);
814 if (!am_daemon && !push_dir(dir, 0)) {
815 rsyserr(FERROR, errno, "push_dir#4 %s failed",
817 exit_cleanup(RERR_FILESELECT);
821 io_start_buffering_in();
822 recv_filter_list(f_in);
824 if (filesfrom_fd >= 0) {
825 /* We need to send the files-from names to the sender at the
826 * same time that we receive the file-list from them, so we
827 * need the IO routines to automatically write out the names
828 * onto our f_out socket as we read the file-list. This
829 * avoids both deadlock and extra delays/buffers. */
830 io_set_filesfrom_fds(filesfrom_fd, f_out);
834 #ifdef SUPPORT_HARD_LINKS
835 if (preserve_hard_links)
839 flist = recv_file_list(f_in);
840 verbose = save_verbose;
842 rprintf(FERROR,"server_recv: recv_file_list error\n");
843 exit_cleanup(RERR_FILESELECT);
845 the_file_list = flist;
848 local_name = get_local_name(flist,argv[0]);
850 /* Now that we know what our destination directory turned out to be,
851 * we can sanitize the --link-/copy-/compare-dest args correctly. */
852 if (sanitize_paths) {
854 for (dir = basis_dir; *dir; dir++) {
855 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
858 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
863 if (server_filter_list.head) {
865 struct filter_list_struct *elp = &server_filter_list;
867 for (dir = basis_dir; *dir; dir++) {
868 if (check_filter(elp, *dir, 1) < 0)
869 goto options_rejected;
871 if (partial_dir && *partial_dir == '/'
872 && check_filter(elp, partial_dir, 1) < 0) {
875 "Your options have been rejected by the server.\n");
876 exit_cleanup(RERR_SYNTAX);
880 exit_code = do_recv(f_in,f_out,flist,local_name);
881 exit_cleanup(exit_code);
885 int child_main(int argc, char *argv[])
887 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
892 void start_server(int f_in, int f_out, int argc, char *argv[])
894 set_nonblocking(f_in);
895 set_nonblocking(f_out);
897 io_set_sock_fds(f_in, f_out);
898 setup_protocol(f_out, f_in);
899 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
903 if (protocol_version >= 23)
904 io_start_multiplex_out();
907 keep_dirlinks = 0; /* Must be disabled on the sender. */
908 if (need_messages_from_generator)
909 io_start_multiplex_in();
910 recv_filter_list(f_in);
911 do_server_sender(f_in, f_out, argc, argv);
913 do_server_recv(f_in, f_out, argc, argv);
919 * This is called once the connection has been negotiated. It is used
920 * for rsyncd, remote-shell, and local connections.
922 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
924 struct file_list *flist = NULL;
925 int exit_code = 0, exit_code2 = 0;
926 char *local_name = NULL;
928 cleanup_child_pid = pid;
930 set_nonblocking(f_in);
931 set_nonblocking(f_out);
934 io_set_sock_fds(f_in, f_out);
935 setup_protocol(f_out,f_in);
936 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
940 if (protocol_version >= 23 && !read_batch)
941 io_start_multiplex_in();
943 /* We set our stderr file handle to blocking because ssh might have
944 * set it to non-blocking. This can be particularly troublesome if
945 * stderr is a clone of stdout, because ssh would have set our stdout
946 * to non-blocking at the same time (which can easily cause us to lose
947 * output from our print statements). This kluge shouldn't cause ssh
948 * any problems for how we use it. Note also that we delayed setting
949 * this until after the above protocol setup so that we know for sure
950 * that ssh is done twiddling its file descriptors. */
951 set_blocking(STDERR_FILENO);
954 keep_dirlinks = 0; /* Must be disabled on the sender. */
955 io_start_buffering_out();
958 send_filter_list(f_out);
962 if (write_batch && !am_server)
963 start_write_batch(f_out);
964 flist = send_file_list(f_out, argc, argv);
967 rprintf(FINFO,"file list sent\n");
968 the_file_list = flist;
970 io_flush(NORMAL_FLUSH);
971 send_files(flist,f_out,f_in);
972 io_flush(FULL_FLUSH);
974 if (protocol_version >= 24)
975 read_final_goodbye(f_in, f_out);
978 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
979 io_flush(FULL_FLUSH);
980 wait_process_with_flush(pid, &exit_code);
983 io_flush(FULL_FLUSH);
984 exit_cleanup(exit_code);
987 if (need_messages_from_generator && !read_batch)
988 io_start_multiplex_out();
993 send_filter_list(read_batch ? -1 : f_out);
995 if (filesfrom_fd >= 0) {
996 io_set_filesfrom_fds(filesfrom_fd, f_out);
1000 #ifdef SUPPORT_HARD_LINKS
1001 if (preserve_hard_links)
1005 if (write_batch && !am_server)
1006 start_write_batch(f_in);
1007 flist = recv_file_list(f_in);
1008 the_file_list = flist;
1010 if (flist && flist->count > 0) {
1011 local_name = get_local_name(flist, argv[0]);
1015 exit_code2 = do_recv(f_in, f_out, flist, local_name);
1023 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1024 io_flush(FULL_FLUSH);
1025 wait_process_with_flush(pid, &exit_code);
1028 return MAX(exit_code, exit_code2);
1031 static int copy_argv(char *argv[])
1035 for (i = 0; argv[i]; i++) {
1036 if (!(argv[i] = strdup(argv[i]))) {
1037 rprintf (FERROR, "out of memory at %s(%d)\n",
1038 __FILE__, __LINE__);
1048 * Start a client for either type of remote connection. Work out
1049 * whether the arguments request a remote shell or rsyncd connection,
1050 * and call the appropriate connection function, then run_client.
1052 * Calls either start_socket_client (for sockets) or do_cmd and
1053 * client_run (for ssh).
1055 static int start_client(int argc, char *argv[])
1058 char *shell_machine = NULL;
1059 char *shell_path = NULL;
1060 char *shell_user = NULL;
1066 /* Don't clobber argv[] so that ps(1) can still show the right
1068 if ((rc = copy_argv(argv)))
1071 if (!read_batch) { /* for read_batch, NO source is specified */
1072 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1073 if (shell_path) { /* source is remote */
1077 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1079 "The source and destination cannot both be remote.\n");
1080 exit_cleanup(RERR_SYNTAX);
1083 if (filesfrom_host && *filesfrom_host
1084 && strcmp(filesfrom_host, shell_machine) != 0) {
1086 "--files-from hostname is not the same as the transfer hostname\n");
1087 exit_cleanup(RERR_SYNTAX);
1091 return start_socket_client(shell_machine,
1095 daemon_over_rsh = 1;
1099 } else { /* source is local, check dest arg */
1109 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1110 if (shell_path && filesfrom_host && *filesfrom_host
1111 && strcmp(filesfrom_host, shell_machine) != 0) {
1113 "--files-from hostname is not the same as the transfer hostname\n");
1114 exit_cleanup(RERR_SYNTAX);
1116 if (!shell_path) { /* no hostspec found, so src & dest are local */
1118 if (filesfrom_host) {
1120 "--files-from cannot be remote when the transfer is local\n");
1121 exit_cleanup(RERR_SYNTAX);
1123 shell_machine = NULL;
1125 } else if (rsync_port) {
1127 return start_socket_client(shell_machine,
1131 daemon_over_rsh = 1;
1134 } else { /* read_batch */
1136 shell_path = argv[argc-1];
1137 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1138 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1139 exit_cleanup(RERR_SYNTAX);
1143 if (shell_machine) {
1144 p = strrchr(shell_machine,'@');
1147 shell_user = shell_machine;
1148 shell_machine = p+1;
1153 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1154 shell_cmd ? shell_cmd : "",
1155 shell_machine ? shell_machine : "",
1156 shell_user ? shell_user : "",
1157 shell_path ? shell_path : "");
1160 /* for remote source, only single dest arg can remain ... */
1161 if (!am_sender && argc > 1) {
1163 exit_cleanup(RERR_SYNTAX);
1166 /* ... or no dest at all */
1167 if (!am_sender && argc == 0)
1170 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1173 /* if we're running an rsync server on the remote host over a
1174 * remote shell command, we need to do the RSYNCD protocol first */
1175 if (daemon_over_rsh) {
1177 tmpret = start_inband_exchange(shell_user, shell_path,
1183 ret = client_run(f_in, f_out, pid, argc, argv);
1192 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1194 exit_cleanup(RERR_SIGNAL1);
1197 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1203 _exit(RERR_PARTIAL);
1207 RETSIGTYPE remember_children(UNUSED(int val))
1212 /* An empty waitpid() loop was put here by Tridge and we could never
1213 * get him to explain why he put it in, so rather than taking it
1214 * out we're instead saving the child exit statuses for later use.
1215 * The waitpid() loop presumably eliminates all possibility of leaving
1216 * zombie children, maybe that's why he did it. */
1217 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1218 /* save the child's exit status */
1219 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1220 if (pid_stat_table[cnt].pid == 0) {
1221 pid_stat_table[cnt].pid = pid;
1222 pid_stat_table[cnt].status = status;
1228 #ifndef HAVE_SIGACTION
1229 signal(SIGCHLD, remember_children);
1235 * This routine catches signals and tries to send them to gdb.
1237 * Because it's called from inside a signal handler it ought not to
1238 * use too many library routines.
1240 * @todo Perhaps use "screen -X" instead/as well, to help people
1241 * debugging without easy access to X. Perhaps use an environment
1242 * variable, or just call a script?
1244 * @todo The /proc/ magic probably only works on Linux (and
1245 * Solaris?) Can we be more portable?
1247 #ifdef MAINTAINER_MODE
1248 const char *get_panic_action(void)
1250 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1255 return "xterm -display :0 -T Panic -n Panic "
1256 "-e gdb /proc/%d/exe %d";
1261 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1263 * This signal handler is only installed if we were configured with
1264 * --enable-maintainer-mode. Perhaps it should always be on and we
1265 * should just look at the environment variable, but I'm a bit leery
1266 * of a signal sending us into a busy loop.
1268 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1273 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1274 getpid(), getpid());
1276 /* Unless we failed to execute gdb, we allow the process to
1277 * continue. I'm not sure if that's right. */
1278 ret = system(cmd_buf);
1285 int main(int argc,char *argv[])
1288 int orig_argc = argc;
1289 char **orig_argv = argv;
1290 #ifdef HAVE_SIGACTION
1291 # ifdef HAVE_SIGPROCMASK
1294 sigemptyset(&sigmask);
1296 sigact.sa_flags = SA_NOCLDSTOP;
1298 SIGACTMASK(SIGUSR1, sigusr1_handler);
1299 SIGACTMASK(SIGUSR2, sigusr2_handler);
1300 SIGACTMASK(SIGCHLD, remember_children);
1301 #ifdef MAINTAINER_MODE
1302 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1303 SIGACTMASK(SIGFPE, rsync_panic_handler);
1304 SIGACTMASK(SIGABRT, rsync_panic_handler);
1305 SIGACTMASK(SIGBUS, rsync_panic_handler);
1308 starttime = time(NULL);
1309 am_root = (MY_UID() == 0);
1311 memset(&stats, 0, sizeof(stats));
1315 exit_cleanup(RERR_SYNTAX);
1318 /* we set a 0 umask so that correct file permissions can be
1320 orig_umask = umask(0);
1322 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1323 setlocale(LC_CTYPE, "");
1326 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1327 /* FIXME: We ought to call the same error-handling
1328 * code here, rather than relying on getopt. */
1330 exit_cleanup(RERR_SYNTAX);
1333 SIGACTMASK(SIGINT, sig_int);
1334 SIGACTMASK(SIGHUP, sig_int);
1335 SIGACTMASK(SIGTERM, sig_int);
1336 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1337 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1340 /* Ignore SIGPIPE; we consistently check error codes and will
1342 SIGACTION(SIGPIPE, SIG_IGN);
1344 SIGACTION(SIGXFSZ, SIG_IGN);
1347 /* Initialize push_dir here because on some old systems getcwd
1348 * (implemented by forking "pwd" and reading its output) doesn't
1349 * work when there are other child processes. Also, on all systems
1350 * that implement getcwd that way "pwd" can't be found after chroot. */
1355 if ((write_batch || read_batch) && !am_server) {
1357 write_batch_shell_file(orig_argc, orig_argv, argc);
1359 if (read_batch && strcmp(batch_name, "-") == 0)
1360 batch_fd = STDIN_FILENO;
1362 batch_fd = do_open(batch_name,
1363 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1364 : O_RDONLY, S_IRUSR | S_IWUSR);
1367 rsyserr(FERROR, errno, "Batch file %s open error",
1368 full_fname(batch_name));
1369 exit_cleanup(RERR_FILEIO);
1372 read_stream_flags(batch_fd);
1374 if (write_batch < 0)
1377 if (am_daemon && !am_server)
1378 return daemon_main();
1382 exit_cleanup(RERR_SYNTAX);
1386 set_nonblocking(STDIN_FILENO);
1387 set_nonblocking(STDOUT_FILENO);
1389 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1390 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1393 ret = start_client(argc, argv);
1395 exit_cleanup(RERR_STARTCLIENT);