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)
106 pid_t waited_pid = waitpid(pid, status_ptr, flags);
108 if (waited_pid == -1 && errno == ECHILD) {
109 /* Status of requested child no longer available: check to
110 * see if it was processed by remember_children(). */
112 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
113 if (pid == pid_stat_table[cnt].pid) {
114 *status_ptr = pid_stat_table[cnt].status;
115 pid_stat_table[cnt].pid = 0;
124 /* Wait for a process to exit, calling io_flush while waiting. */
125 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
130 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
132 io_flush(FULL_FLUSH);
135 /* TODO: If the child exited on a signal, then log an
136 * appropriate error message. Perhaps we should also accept a
137 * message describing the purpose of the child. Also indicate
138 * this to the caller so that they know something went wrong. */
139 if (waited_pid < 0) {
140 rsyserr(FERROR, errno, "waitpid");
141 *exit_code_ptr = RERR_WAITCHILD;
142 } else if (!WIFEXITED(status)) {
144 if (WCOREDUMP(status))
145 *exit_code_ptr = RERR_CRASHED;
148 if (WIFSIGNALED(status))
149 *exit_code_ptr = RERR_TERMINATED;
151 *exit_code_ptr = RERR_WAITCHILD;
153 *exit_code_ptr = WEXITSTATUS(status);
156 /* This function gets called from all 3 processes. We want the client side
157 * to actually output the text, but the sender is the only process that has
158 * all the stats we need. So, if we're a client sender, we do the report.
159 * If we're a server sender, we write the stats on the supplied fd. If
160 * we're the client receiver we read the stats from the supplied fd and do
161 * the report. All processes might also generate a set of debug stats, if
162 * the verbose level is high enough (this is the only thing that the
163 * generator process and the server receiver ever do here). */
164 static void handle_stats(int f)
166 endtime = time(NULL);
168 /* Cache two stats because the read/write code can change it. */
169 total_read = stats.total_read;
170 total_written = stats.total_written;
172 if (do_stats && verbose > 1) {
173 /* These come out from every process */
182 if (f == -1 || !am_sender)
188 write_longint(f, total_read);
189 write_longint(f, total_written);
190 write_longint(f, stats.total_size);
191 if (protocol_version >= 29) {
192 write_longint(f, stats.flist_buildtime);
193 write_longint(f, stats.flist_xfertime);
199 /* this is the client */
201 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
203 else if (!am_sender) {
204 /* Read the first two in opposite order because the meaning of
205 * read/write swaps when switching from sender to receiver. */
206 total_written = read_longint(f);
207 total_read = read_longint(f);
208 stats.total_size = read_longint(f);
209 if (protocol_version >= 29) {
210 stats.flist_buildtime = read_longint(f);
211 stats.flist_xfertime = read_longint(f);
213 } else if (write_batch) {
214 /* The --read-batch process is going to be a client
215 * receiver, so we need to give it the stats. */
216 write_longint(batch_fd, total_read);
217 write_longint(batch_fd, total_written);
218 write_longint(batch_fd, stats.total_size);
219 if (protocol_version >= 29) {
220 write_longint(batch_fd, stats.flist_buildtime);
221 write_longint(batch_fd, stats.flist_xfertime);
226 static void output_summary(void)
229 rprintf(FCLIENT, "\n");
230 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
231 rprintf(FINFO,"Number of files transferred: %d\n",
232 stats.num_transferred_files);
233 rprintf(FINFO,"Total file size: %s bytes\n",
234 human_num(stats.total_size));
235 rprintf(FINFO,"Total transferred file size: %s bytes\n",
236 human_num(stats.total_transferred_size));
237 rprintf(FINFO,"Literal data: %s bytes\n",
238 human_num(stats.literal_data));
239 rprintf(FINFO,"Matched data: %s bytes\n",
240 human_num(stats.matched_data));
241 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
242 if (stats.flist_buildtime) {
244 "File list generation time: %.3f seconds\n",
245 (double)stats.flist_buildtime / 1000);
247 "File list transfer time: %.3f seconds\n",
248 (double)stats.flist_xfertime / 1000);
250 rprintf(FINFO,"Total bytes sent: %s\n",
251 human_num(total_written));
252 rprintf(FINFO,"Total bytes received: %s\n",
253 human_num(total_read));
256 if (verbose || do_stats) {
257 rprintf(FCLIENT, "\n");
259 "sent %s bytes received %s bytes %s bytes/sec\n",
260 human_num(total_written), human_num(total_read),
261 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
262 rprintf(FINFO, "total size is %s speedup is %.2f\n",
263 human_num(stats.total_size),
264 (double)stats.total_size / (total_written+total_read));
273 * If our C library can get malloc statistics, then show them to FINFO
275 static void show_malloc_stats(void)
282 rprintf(FCLIENT, "\n");
283 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
284 getpid(), am_server ? "server " : "",
285 am_daemon ? "daemon " : "", who_am_i());
286 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
288 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
290 rprintf(FINFO, " smblks: %10ld\n",
292 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
294 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
296 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
297 (long)mi.arena + mi.hblkhd);
298 rprintf(FINFO, " usmblks: %10ld\n",
300 rprintf(FINFO, " fsmblks: %10ld\n",
302 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
304 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
306 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
308 #endif /* HAVE_MALLINFO */
312 /* Start the remote shell. cmd may be NULL to use the default. */
313 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
314 int *f_in, int *f_out)
317 char *args[MAX_ARGS];
322 if (!read_batch && !local_server) {
323 char *t, *f, in_quote = '\0';
324 char *rsh_env = getenv(RSYNC_RSH_ENV);
333 for (t = f = cmd; *f; f++) {
336 /* Comparison leaves rooms for server_options(). */
337 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
338 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
339 exit_cleanup(RERR_SYNTAX);
342 while (*f != ' ' || in_quote) {
346 "Missing trailing-%c in remote-shell command.\n",
348 exit_cleanup(RERR_SYNTAX);
353 if (*f == '\'' || *f == '"') {
358 if (*f == in_quote && *++f != in_quote) {
368 /* check to see if we've already been given '-l user' in
369 * the remote-shell command */
370 for (i = 0; i < argc-1; i++) {
371 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
376 /* remsh (on HPUX) takes the arguments the other way around */
377 args[argc++] = machine;
378 if (user && !(daemon_over_rsh && dash_l_set)) {
383 if (user && !(daemon_over_rsh && dash_l_set)) {
387 args[argc++] = machine;
390 args[argc++] = rsync_path;
392 if (blocking_io < 0) {
394 if ((cp = strrchr(cmd, '/')) != NULL)
398 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
402 server_options(args,&argc);
404 if (argc >= MAX_ARGS - 2) {
405 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
406 exit_cleanup(RERR_SYNTAX);
412 if (!daemon_over_rsh && path && *path)
418 for (i = 0; i < argc; i++)
419 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
420 rprintf(FCLIENT, "\n");
424 int from_gen_pipe[2];
425 if (fd_pair(from_gen_pipe) < 0) {
426 rsyserr(FERROR, errno, "pipe");
427 exit_cleanup(RERR_IPC);
429 batch_gen_fd = from_gen_pipe[0];
430 *f_out = from_gen_pipe[1];
432 ret = -1; /* no child pid */
433 } else if (local_server) {
434 /* If the user didn't request --[no-]whole-file, force
435 * it on, but only if we're not batch processing. */
436 if (whole_file < 0 && !write_batch)
438 ret = local_child(argc, args, f_in, f_out, child_main);
440 ret = piped_child(args,f_in,f_out);
448 out_of_memory("do_cmd");
449 return 0; /* not reached */
452 /* The receiving side operates in one of two modes:
454 * 1. it receives any number of files into a destination directory,
455 * placing them according to their names in the file-list.
457 * 2. it receives a single file and saves it using the name in the
458 * destination path instead of its file-list name. This requires a
459 * "local name" for writing out the destination file.
461 * So, our task is to figure out what mode/local-name we need.
462 * For mode 1, we change into the destination directory and return NULL.
463 * For mode 2, we change into the directory containing the destination
464 * file (if we aren't already there) and return the local-name. */
465 static char *get_local_name(struct file_list *flist, char *dest_path)
472 rprintf(FINFO, "get_local_name count=%d %s\n",
473 flist->count, NS(dest_path));
476 if (!dest_path || list_only)
479 /* See what currently exists at the destination. */
480 if ((statret = safe_stat(dest_path, &st)) == 0) {
481 /* If the destination is a dir, enter it and use mode 1. */
482 if (S_ISDIR(st.st_mode)) {
484 die_on_unsafe_path(dest_path, 0);
485 if (!push_dir(dest_path, 0)) {
486 rsyserr(FERROR, errno, "push_dir#1 %s failed",
487 full_fname(dest_path));
488 exit_cleanup(RERR_FILESELECT);
492 if (sanitize_paths && S_ISLNK(st.st_mode))
493 die_on_unsafe_path(dest_path, 0);
494 if (flist->count > 1) {
496 "ERROR: destination must be a directory when"
497 " copying more than 1 file\n");
498 exit_cleanup(RERR_FILESELECT);
500 /* Caution: flist->count could be 0! */
501 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
503 "ERROR: cannot overwrite non-directory"
504 " with a directory\n");
505 exit_cleanup(RERR_FILESELECT);
507 } else if (errno != ENOENT) {
508 /* If we don't know what's at the destination, fail. */
509 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
510 full_fname(dest_path));
511 exit_cleanup(RERR_FILESELECT);
514 cp = strrchr(dest_path, '/');
516 /* If we need a destination directory because the transfer is not
517 * of a single non-directory or the user has requested one via a
518 * destination path ending in a slash, create one and use mode 1. */
519 if (flist->count > 1 || (cp && !cp[1])) {
520 /* Lop off the final slash (if any). */
526 "ERROR: destination path is not a directory\n");
527 exit_cleanup(RERR_SYNTAX);
530 if (mkdir_defmode(dest_path) != 0) {
531 rsyserr(FERROR, errno, "mkdir %s failed",
532 full_fname(dest_path));
533 exit_cleanup(RERR_FILEIO);
539 rprintf(FINFO, "created directory %s\n", dest_path);
542 /* Indicate that dest dir doesn't really exist. */
547 die_on_unsafe_path(dest_path, 0);
548 if (!push_dir(dest_path, dry_run > 1)) {
549 rsyserr(FERROR, errno, "push_dir#2 %s failed",
550 full_fname(dest_path));
551 exit_cleanup(RERR_FILESELECT);
557 /* Otherwise, we are writing a single file, possibly on top of an
558 * existing non-directory. Change to the item's parent directory
559 * (if it has a path component), return the basename of the
560 * destination file as the local name, and use mode 2. */
569 die_on_unsafe_path(dest_path, 0);
570 if (!push_dir(dest_path, 0)) {
571 rsyserr(FERROR, errno, "push_dir#3 %s failed",
572 full_fname(dest_path));
573 exit_cleanup(RERR_FILESELECT);
580 /* Call this if the destination dir (which is assumed to be in curr_dir)
581 * does not yet exist and we can't create it due to being in dry-run
582 * mode. We'll fix dirs that can be relative to the non-existent dir. */
583 static void fix_basis_dirs(void)
585 char **dir, *new, *slash;
591 slash = strrchr(curr_dir, '/');
593 for (dir = basis_dir; *dir; dir++) {
596 len = curr_dir_len + 1 + strlen(*dir) + 1;
597 if (!(new = new_array(char, len)))
598 out_of_memory("fix_basis_dirs");
599 if (slash && strncmp(*dir, "../", 3) == 0) {
600 /* We want to remove only one leading "../" prefix for
601 * the directory we couldn't create in dry-run mode:
602 * this ensures that any other ".." references get
603 * evaluated the same as they would for a live copy. */
605 pathjoin(new, len, curr_dir, *dir + 3);
608 pathjoin(new, len, curr_dir, *dir);
613 /* This is only called by the sender. */
614 static void read_final_goodbye(int f_in, int f_out)
618 if (protocol_version < 29)
621 while ((i = read_int(f_in)) == the_file_list->count
622 && read_shortint(f_in) == ITEM_IS_NEW) {
623 /* Forward the keep-alive (no-op) to the receiver. */
624 write_int(f_out, the_file_list->count);
625 write_shortint(f_out, ITEM_IS_NEW);
630 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
632 exit_cleanup(RERR_PROTOCOL);
637 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
639 struct file_list *flist;
643 rprintf(FINFO, "server_sender starting pid=%ld\n",
647 if (am_daemon && lp_write_only(module_id)) {
648 rprintf(FERROR, "ERROR: module is write only\n");
649 exit_cleanup(RERR_SYNTAX);
652 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
654 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
655 remove_source_files == 1 ? "source" : "sent");
656 exit_cleanup(RERR_SYNTAX);
660 if (!relative_paths) {
662 die_on_unsafe_path(dir, 0);
663 if (!push_dir(dir, 0)) {
664 rsyserr(FERROR, errno, "push_dir#3 %s failed",
666 exit_cleanup(RERR_FILESELECT);
672 if (argc == 0 && (recurse || list_only)) {
678 flist = send_file_list(f_out,argc,argv);
679 if (!flist || flist->count == 0) {
682 the_file_list = flist;
684 io_start_buffering_in();
685 io_start_buffering_out();
687 send_files(flist,f_out,f_in);
688 io_flush(FULL_FLUSH);
690 if (protocol_version >= 24)
691 read_final_goodbye(f_in, f_out);
692 io_flush(FULL_FLUSH);
697 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
703 /* The receiving side mustn't obey this, or an existing symlink that
704 * points to an identical file won't be replaced by the referent. */
705 copy_links = copy_dirlinks = 0;
707 if (preserve_hard_links)
710 if (fd_pair(error_pipe) < 0) {
711 rsyserr(FERROR, errno, "pipe failed in do_recv");
712 exit_cleanup(RERR_IPC);
715 io_flush(NORMAL_FLUSH);
717 if ((pid = do_fork()) == -1) {
718 rsyserr(FERROR, errno, "fork failed in do_recv");
719 exit_cleanup(RERR_IPC);
723 close(error_pipe[0]);
727 /* we can't let two processes write to the socket at one time */
728 close_multiplexing_out();
730 /* set place to send errors */
731 set_msg_fd_out(error_pipe[1]);
733 recv_files(f_in, flist, local_name);
734 io_flush(FULL_FLUSH);
737 send_msg(MSG_DONE, "", 0);
738 io_flush(FULL_FLUSH);
740 /* Handle any keep-alive packets from the post-processing work
741 * that the generator does. */
742 if (protocol_version >= 29) {
743 kluge_around_eof = -1;
745 /* This should only get stopped via a USR2 signal. */
746 while (read_int(f_in) == flist->count
747 && read_shortint(f_in) == ITEM_IS_NEW) {}
749 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
751 exit_cleanup(RERR_PROTOCOL);
754 /* Finally, we go to sleep until our parent kills us with a
755 * USR2 signal. We sleep for a short time, as on some OSes
756 * a signal won't interrupt a sleep! */
762 close_multiplexing_in();
763 if (write_batch && !am_server)
766 close(error_pipe[1]);
770 io_start_buffering_out();
772 set_msg_fd_in(error_pipe[0]);
774 generate_files(f_out, flist, local_name);
777 io_flush(FULL_FLUSH);
778 if (protocol_version >= 24) {
779 /* send a final goodbye message */
780 write_int(f_out, -1);
782 io_flush(FULL_FLUSH);
786 wait_process_with_flush(pid, &exit_code);
791 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
794 struct file_list *flist;
795 char *local_name = NULL;
797 int save_verbose = verbose;
799 if (filesfrom_fd >= 0) {
800 /* We can't mix messages with files-from data on the socket,
801 * so temporarily turn off verbose messages. */
806 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
807 argc, (long)getpid());
810 if (am_daemon && lp_read_only(module_id)) {
811 rprintf(FERROR,"ERROR: module is read only\n");
812 exit_cleanup(RERR_SYNTAX);
820 if (!am_daemon && !push_dir(dir, 0)) {
821 rsyserr(FERROR, errno, "push_dir#4 %s failed",
823 exit_cleanup(RERR_FILESELECT);
827 io_start_buffering_in();
828 recv_filter_list(f_in);
830 if (filesfrom_fd >= 0) {
831 /* We need to send the files-from names to the sender at the
832 * same time that we receive the file-list from them, so we
833 * need the IO routines to automatically write out the names
834 * onto our f_out socket as we read the file-list. This
835 * avoids both deadlock and extra delays/buffers. */
836 io_set_filesfrom_fds(filesfrom_fd, f_out);
840 flist = recv_file_list(f_in);
841 verbose = save_verbose;
843 rprintf(FERROR,"server_recv: recv_file_list error\n");
844 exit_cleanup(RERR_FILESELECT);
846 the_file_list = flist;
849 local_name = get_local_name(flist,argv[0]);
851 /* Now that we know what our destination directory turned out to be,
852 * we can sanitize the --link-/copy-/compare-dest args correctly. */
853 if (sanitize_paths) {
855 for (dir = basis_dir; *dir; dir++) {
856 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
857 die_on_unsafe_path(*dir, 0);
860 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
861 /* A relative path gets this checked at every dir change. */
862 if (*partial_dir == '/')
863 die_on_unsafe_path(partial_dir, 0);
868 if (server_filter_list.head) {
870 struct filter_list_struct *elp = &server_filter_list;
872 for (dir = basis_dir; *dir; dir++) {
873 if (check_filter(elp, *dir, 1) < 0)
874 goto options_rejected;
876 if (partial_dir && *partial_dir == '/'
877 && check_filter(elp, partial_dir, 1) < 0) {
880 "Your options have been rejected by the server.\n");
881 exit_cleanup(RERR_SYNTAX);
885 exit_code = do_recv(f_in,f_out,flist,local_name);
886 exit_cleanup(exit_code);
890 int child_main(int argc, char *argv[])
892 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
897 void start_server(int f_in, int f_out, int argc, char *argv[])
899 set_nonblocking(f_in);
900 set_nonblocking(f_out);
902 io_set_sock_fds(f_in, f_out);
903 setup_protocol(f_out, f_in);
904 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
908 if (protocol_version >= 23)
909 io_start_multiplex_out();
912 keep_dirlinks = 0; /* Must be disabled on the sender. */
913 if (need_messages_from_generator)
914 io_start_multiplex_in();
916 recv_filter_list(f_in);
917 do_server_sender(f_in, f_out, argc, argv);
919 do_server_recv(f_in, f_out, argc, argv);
926 * This is called once the connection has been negotiated. It is used
927 * for rsyncd, remote-shell, and local connections.
929 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
931 struct file_list *flist = NULL;
932 int exit_code = 0, exit_code2 = 0;
933 char *local_name = NULL;
935 cleanup_child_pid = pid;
937 set_nonblocking(f_in);
938 set_nonblocking(f_out);
941 io_set_sock_fds(f_in, f_out);
942 setup_protocol(f_out,f_in);
943 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
947 if (protocol_version >= 23 && !read_batch)
948 io_start_multiplex_in();
950 /* We set our stderr file handle to blocking because ssh might have
951 * set it to non-blocking. This can be particularly troublesome if
952 * stderr is a clone of stdout, because ssh would have set our stdout
953 * to non-blocking at the same time (which can easily cause us to lose
954 * output from our print statements). This kluge shouldn't cause ssh
955 * any problems for how we use it. Note also that we delayed setting
956 * this until after the above protocol setup so that we know for sure
957 * that ssh is done twiddling its file descriptors. */
958 set_blocking(STDERR_FILENO);
961 keep_dirlinks = 0; /* Must be disabled on the sender. */
962 io_start_buffering_out();
965 send_filter_list(f_out);
969 if (write_batch && !am_server)
970 start_write_batch(f_out);
971 flist = send_file_list(f_out, argc, argv);
974 rprintf(FINFO,"file list sent\n");
975 the_file_list = flist;
977 io_flush(NORMAL_FLUSH);
978 send_files(flist,f_out,f_in);
979 io_flush(FULL_FLUSH);
981 if (protocol_version >= 24)
982 read_final_goodbye(f_in, f_out);
985 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
986 io_flush(FULL_FLUSH);
987 wait_process_with_flush(pid, &exit_code);
990 io_flush(FULL_FLUSH);
991 exit_cleanup(exit_code);
994 if (need_messages_from_generator && !read_batch)
995 io_start_multiplex_out();
1000 send_filter_list(read_batch ? -1 : f_out);
1002 if (filesfrom_fd >= 0) {
1003 io_set_filesfrom_fds(filesfrom_fd, f_out);
1007 if (write_batch && !am_server)
1008 start_write_batch(f_in);
1009 flist = recv_file_list(f_in);
1010 the_file_list = flist;
1012 if (flist && flist->count > 0) {
1013 local_name = get_local_name(flist, argv[0]);
1017 exit_code2 = do_recv(f_in, f_out, flist, local_name);
1025 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1026 io_flush(FULL_FLUSH);
1027 wait_process_with_flush(pid, &exit_code);
1030 return MAX(exit_code, exit_code2);
1033 static int copy_argv (char *argv[])
1037 for (i = 0; argv[i]; i++) {
1038 if (!(argv[i] = strdup(argv[i]))) {
1039 rprintf (FERROR, "out of memory at %s(%d)\n",
1040 __FILE__, __LINE__);
1050 * Start a client for either type of remote connection. Work out
1051 * whether the arguments request a remote shell or rsyncd connection,
1052 * and call the appropriate connection function, then run_client.
1054 * Calls either start_socket_client (for sockets) or do_cmd and
1055 * client_run (for ssh).
1057 static int start_client(int argc, char *argv[])
1060 char *shell_machine = NULL;
1061 char *shell_path = NULL;
1062 char *shell_user = NULL;
1068 /* Don't clobber argv[] so that ps(1) can still show the right
1070 if ((rc = copy_argv(argv)))
1073 if (!read_batch) { /* for read_batch, NO source is specified */
1074 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1075 if (shell_path) { /* source is remote */
1079 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1081 "The source and destination cannot both be remote.\n");
1082 exit_cleanup(RERR_SYNTAX);
1085 if (filesfrom_host && *filesfrom_host
1086 && strcmp(filesfrom_host, shell_machine) != 0) {
1088 "--files-from hostname is not the same as the transfer hostname\n");
1089 exit_cleanup(RERR_SYNTAX);
1093 return start_socket_client(shell_machine,
1097 daemon_over_rsh = 1;
1101 } else { /* source is local, check dest arg */
1111 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1112 if (shell_path && filesfrom_host && *filesfrom_host
1113 && strcmp(filesfrom_host, shell_machine) != 0) {
1115 "--files-from hostname is not the same as the transfer hostname\n");
1116 exit_cleanup(RERR_SYNTAX);
1118 if (!shell_path) { /* no hostspec found, so src & dest are local */
1120 if (filesfrom_host) {
1122 "--files-from cannot be remote when the transfer is local\n");
1123 exit_cleanup(RERR_SYNTAX);
1125 shell_machine = NULL;
1127 } else if (rsync_port) {
1129 return start_socket_client(shell_machine,
1133 daemon_over_rsh = 1;
1136 } else { /* read_batch */
1138 shell_path = argv[argc-1];
1139 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1140 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1141 exit_cleanup(RERR_SYNTAX);
1145 if (shell_machine) {
1146 p = strrchr(shell_machine,'@');
1149 shell_user = shell_machine;
1150 shell_machine = p+1;
1155 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1156 shell_cmd ? shell_cmd : "",
1157 shell_machine ? shell_machine : "",
1158 shell_user ? shell_user : "",
1159 shell_path ? shell_path : "");
1162 /* for remote source, only single dest arg can remain ... */
1163 if (!am_sender && argc > 1) {
1165 exit_cleanup(RERR_SYNTAX);
1168 /* ... or no dest at all */
1169 if (!am_sender && argc == 0)
1172 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1175 /* if we're running an rsync server on the remote host over a
1176 * remote shell command, we need to do the RSYNCD protocol first */
1177 if (daemon_over_rsh) {
1179 tmpret = start_inband_exchange(shell_user, shell_path,
1185 ret = client_run(f_in, f_out, pid, argc, argv);
1194 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1196 exit_cleanup(RERR_SIGNAL1);
1199 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1205 _exit(RERR_PARTIAL);
1209 RETSIGTYPE remember_children(UNUSED(int val))
1214 /* An empty waitpid() loop was put here by Tridge and we could never
1215 * get him to explain why he put it in, so rather than taking it
1216 * out we're instead saving the child exit statuses for later use.
1217 * The waitpid() loop presumably eliminates all possibility of leaving
1218 * zombie children, maybe that's why he did it. */
1219 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1220 /* save the child's exit status */
1221 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1222 if (pid_stat_table[cnt].pid == 0) {
1223 pid_stat_table[cnt].pid = pid;
1224 pid_stat_table[cnt].status = status;
1230 #ifndef HAVE_SIGACTION
1231 signal(SIGCHLD, remember_children);
1237 * This routine catches signals and tries to send them to gdb.
1239 * Because it's called from inside a signal handler it ought not to
1240 * use too many library routines.
1242 * @todo Perhaps use "screen -X" instead/as well, to help people
1243 * debugging without easy access to X. Perhaps use an environment
1244 * variable, or just call a script?
1246 * @todo The /proc/ magic probably only works on Linux (and
1247 * Solaris?) Can we be more portable?
1249 #ifdef MAINTAINER_MODE
1250 const char *get_panic_action(void)
1252 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1257 return "xterm -display :0 -T Panic -n Panic "
1258 "-e gdb /proc/%d/exe %d";
1263 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1265 * This signal handler is only installed if we were configured with
1266 * --enable-maintainer-mode. Perhaps it should always be on and we
1267 * should just look at the environment variable, but I'm a bit leery
1268 * of a signal sending us into a busy loop.
1270 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1275 sprintf(cmd_buf, get_panic_action(),
1276 getpid(), getpid());
1278 /* Unless we failed to execute gdb, we allow the process to
1279 * continue. I'm not sure if that's right. */
1280 ret = system(cmd_buf);
1287 int main(int argc,char *argv[])
1290 int orig_argc = argc;
1291 char **orig_argv = argv;
1292 #ifdef HAVE_SIGACTION
1293 # ifdef HAVE_SIGPROCMASK
1296 sigemptyset(&sigmask);
1298 sigact.sa_flags = SA_NOCLDSTOP;
1300 SIGACTMASK(SIGUSR1, sigusr1_handler);
1301 SIGACTMASK(SIGUSR2, sigusr2_handler);
1302 SIGACTMASK(SIGCHLD, remember_children);
1303 #ifdef MAINTAINER_MODE
1304 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1305 SIGACTMASK(SIGFPE, rsync_panic_handler);
1306 SIGACTMASK(SIGABRT, rsync_panic_handler);
1307 SIGACTMASK(SIGBUS, rsync_panic_handler);
1310 starttime = time(NULL);
1311 am_root = (MY_UID() == 0);
1313 memset(&stats, 0, sizeof(stats));
1317 exit_cleanup(RERR_SYNTAX);
1320 /* we set a 0 umask so that correct file permissions can be
1322 orig_umask = umask(0);
1324 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1325 setlocale(LC_CTYPE, "");
1328 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1329 /* FIXME: We ought to call the same error-handling
1330 * code here, rather than relying on getopt. */
1332 exit_cleanup(RERR_SYNTAX);
1335 SIGACTMASK(SIGINT, sig_int);
1336 SIGACTMASK(SIGHUP, sig_int);
1337 SIGACTMASK(SIGTERM, sig_int);
1338 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1339 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1342 /* Ignore SIGPIPE; we consistently check error codes and will
1344 SIGACTION(SIGPIPE, SIG_IGN);
1346 SIGACTION(SIGXFSZ, SIG_IGN);
1349 /* Initialize push_dir here because on some old systems getcwd
1350 * (implemented by forking "pwd" and reading its output) doesn't
1351 * work when there are other child processes. Also, on all systems
1352 * that implement getcwd that way "pwd" can't be found after chroot. */
1357 if ((write_batch || read_batch) && !am_server) {
1359 write_batch_shell_file(orig_argc, orig_argv, argc);
1361 if (read_batch && strcmp(batch_name, "-") == 0)
1362 batch_fd = STDIN_FILENO;
1364 batch_fd = do_open(batch_name,
1365 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1366 : O_RDONLY, S_IRUSR | S_IWUSR);
1369 rsyserr(FERROR, errno, "Batch file %s open error",
1370 full_fname(batch_name));
1371 exit_cleanup(RERR_FILEIO);
1374 read_stream_flags(batch_fd);
1376 if (write_batch < 0)
1379 if (am_daemon && !am_server)
1380 return daemon_main();
1384 exit_cleanup(RERR_SYNTAX);
1388 set_nonblocking(STDIN_FILENO);
1389 set_nonblocking(STDOUT_FILENO);
1391 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1392 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1395 ret = start_client(argc, argv);
1397 exit_cleanup(RERR_STARTCLIENT);