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-2007 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 3 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, visit the http://fsf.org website.
25 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
35 extern int am_generator;
37 extern int inc_recurse;
38 extern int blocking_io;
39 extern int remove_source_files;
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;
50 extern int file_total;
52 extern int protect_args;
53 extern int relative_paths;
54 extern int sanitize_paths;
55 extern int curr_dir_depth;
56 extern int curr_dir_len;
58 extern int rsync_port;
59 extern int whole_file;
60 extern int read_batch;
61 extern int write_batch;
63 extern int filesfrom_fd;
64 extern pid_t cleanup_child_pid;
65 extern struct stats stats;
66 extern char *filesfrom_host;
67 extern char *partial_dir;
68 extern char *basis_dir[];
69 extern char *rsync_path;
70 extern char *shell_cmd;
71 extern char *batch_name;
72 extern char *password_file;
73 extern char curr_dir[MAXPATHLEN];
74 extern struct file_list *first_flist;
75 extern struct filter_list_struct server_filter_list;
78 int daemon_over_rsh = 0;
79 mode_t orig_umask = 0;
80 int batch_gen_fd = -1;
82 /* There's probably never more than at most 2 outstanding child processes,
83 * but set it higher, just in case. */
84 #define MAXCHILDPROCS 7
87 # ifdef HAVE_SIGPROCMASK
88 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
90 # define SIGACTMASK(n,h) SIGACTION(n,h)
92 static struct sigaction sigact;
98 } pid_stat_table[MAXCHILDPROCS];
100 static time_t starttime, endtime;
101 static int64 total_read, total_written;
103 static void show_malloc_stats(void);
105 /* Works like waitpid(), but if we already harvested the child pid in our
106 * remember_children(), we succeed instead of returning an error. */
107 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
112 waited_pid = waitpid(pid, status_ptr, flags);
113 } while (waited_pid == -1 && errno == EINTR);
115 if (waited_pid == -1 && errno == ECHILD) {
116 /* Status of requested child no longer available: check to
117 * see if it was processed by remember_children(). */
119 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
120 if (pid == pid_stat_table[cnt].pid) {
121 *status_ptr = pid_stat_table[cnt].status;
122 pid_stat_table[cnt].pid = 0;
131 /* Wait for a process to exit, calling io_flush while waiting. */
132 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
137 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
139 io_flush(FULL_FLUSH);
142 /* TODO: If the child exited on a signal, then log an
143 * appropriate error message. Perhaps we should also accept a
144 * message describing the purpose of the child. Also indicate
145 * this to the caller so that they know something went wrong. */
146 if (waited_pid < 0) {
147 rsyserr(FERROR, errno, "waitpid");
148 *exit_code_ptr = RERR_WAITCHILD;
149 } else if (!WIFEXITED(status)) {
151 if (WCOREDUMP(status))
152 *exit_code_ptr = RERR_CRASHED;
155 if (WIFSIGNALED(status))
156 *exit_code_ptr = RERR_TERMINATED;
158 *exit_code_ptr = RERR_WAITCHILD;
160 *exit_code_ptr = WEXITSTATUS(status);
163 /* This function gets called from all 3 processes. We want the client side
164 * to actually output the text, but the sender is the only process that has
165 * all the stats we need. So, if we're a client sender, we do the report.
166 * If we're a server sender, we write the stats on the supplied fd. If
167 * we're the client receiver we read the stats from the supplied fd and do
168 * the report. All processes might also generate a set of debug stats, if
169 * the verbose level is high enough (this is the only thing that the
170 * generator process and the server receiver ever do here). */
171 static void handle_stats(int f)
173 endtime = time(NULL);
175 /* Cache two stats because the read/write code can change it. */
176 total_read = stats.total_read;
177 total_written = stats.total_written;
179 if (do_stats && verbose > 1) {
180 /* These come out from every process */
189 if (f == -1 || !am_sender)
195 write_varlong30(f, total_read, 3);
196 write_varlong30(f, total_written, 3);
197 write_varlong30(f, stats.total_size, 3);
198 if (protocol_version >= 29) {
199 write_varlong30(f, stats.flist_buildtime, 3);
200 write_varlong30(f, stats.flist_xfertime, 3);
206 /* this is the client */
208 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
210 else if (!am_sender) {
211 /* Read the first two in opposite order because the meaning of
212 * read/write swaps when switching from sender to receiver. */
213 total_written = read_varlong30(f, 3);
214 total_read = read_varlong30(f, 3);
215 stats.total_size = read_varlong30(f, 3);
216 if (protocol_version >= 29) {
217 stats.flist_buildtime = read_varlong30(f, 3);
218 stats.flist_xfertime = read_varlong30(f, 3);
220 } else if (write_batch) {
221 /* The --read-batch process is going to be a client
222 * receiver, so we need to give it the stats. */
223 write_varlong30(batch_fd, total_read, 3);
224 write_varlong30(batch_fd, total_written, 3);
225 write_varlong30(batch_fd, stats.total_size, 3);
226 if (protocol_version >= 29) {
227 write_varlong30(batch_fd, stats.flist_buildtime, 3);
228 write_varlong30(batch_fd, stats.flist_xfertime, 3);
233 static void output_summary(void)
236 rprintf(FCLIENT, "\n");
237 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
238 rprintf(FINFO,"Number of files transferred: %d\n",
239 stats.num_transferred_files);
240 rprintf(FINFO,"Total file size: %s bytes\n",
241 human_num(stats.total_size));
242 rprintf(FINFO,"Total transferred file size: %s bytes\n",
243 human_num(stats.total_transferred_size));
244 rprintf(FINFO,"Literal data: %s bytes\n",
245 human_num(stats.literal_data));
246 rprintf(FINFO,"Matched data: %s bytes\n",
247 human_num(stats.matched_data));
248 rprintf(FINFO,"File list size: %s\n",
249 human_num(stats.flist_size));
250 if (stats.flist_buildtime) {
252 "File list generation time: %.3f seconds\n",
253 (double)stats.flist_buildtime / 1000);
255 "File list transfer time: %.3f seconds\n",
256 (double)stats.flist_xfertime / 1000);
258 rprintf(FINFO,"Total bytes sent: %s\n",
259 human_num(total_written));
260 rprintf(FINFO,"Total bytes received: %s\n",
261 human_num(total_read));
264 if (verbose || do_stats) {
265 rprintf(FCLIENT, "\n");
267 "sent %s bytes received %s bytes %s bytes/sec\n",
268 human_num(total_written), human_num(total_read),
269 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
270 rprintf(FINFO, "total size is %s speedup is %.2f\n",
271 human_num(stats.total_size),
272 (double)stats.total_size / (total_written+total_read));
281 * If our C library can get malloc statistics, then show them to FINFO
283 static void show_malloc_stats(void)
290 rprintf(FCLIENT, "\n");
291 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
292 getpid(), am_server ? "server " : "",
293 am_daemon ? "daemon " : "", who_am_i());
294 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
296 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
298 rprintf(FINFO, " smblks: %10ld\n",
300 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
302 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
304 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
305 (long)mi.arena + mi.hblkhd);
306 rprintf(FINFO, " usmblks: %10ld\n",
308 rprintf(FINFO, " fsmblks: %10ld\n",
310 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
312 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
314 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
316 #endif /* HAVE_MALLINFO */
320 /* Start the remote shell. cmd may be NULL to use the default. */
321 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
322 int *f_in_p, int *f_out_p)
325 char *args[MAX_ARGS];
330 if (!read_batch && !local_server) {
331 char *t, *f, in_quote = '\0';
332 char *rsh_env = getenv(RSYNC_RSH_ENV);
341 for (t = f = cmd; *f; f++) {
344 /* Comparison leaves rooms for server_options(). */
345 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
348 while (*f != ' ' || in_quote) {
352 "Missing trailing-%c in remote-shell command.\n",
354 exit_cleanup(RERR_SYNTAX);
359 if (*f == '\'' || *f == '"') {
364 if (*f == in_quote && *++f != in_quote) {
374 /* check to see if we've already been given '-l user' in
375 * the remote-shell command */
376 for (i = 0; i < argc-1; i++) {
377 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
382 /* remsh (on HPUX) takes the arguments the other way around */
383 args[argc++] = machine;
384 if (user && !(daemon_over_rsh && dash_l_set)) {
389 if (user && !(daemon_over_rsh && dash_l_set)) {
393 args[argc++] = machine;
396 args[argc++] = rsync_path;
398 if (blocking_io < 0) {
400 if ((cp = strrchr(cmd, '/')) != NULL)
404 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
408 server_options(args,&argc);
410 if (argc >= MAX_ARGS - 2)
416 if (!daemon_over_rsh) {
417 while (remote_argc > 0) {
418 if (argc >= MAX_ARGS - 1) {
420 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
421 exit_cleanup(RERR_SYNTAX);
423 args[argc++] = *remote_argv++;
431 for (i = 0; i < argc; i++)
432 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
433 rprintf(FCLIENT, "\n");
437 int from_gen_pipe[2];
438 if (fd_pair(from_gen_pipe) < 0) {
439 rsyserr(FERROR, errno, "pipe");
440 exit_cleanup(RERR_IPC);
442 batch_gen_fd = from_gen_pipe[0];
443 *f_out_p = from_gen_pipe[1];
445 ret = -1; /* no child pid */
446 } else if (local_server) {
447 /* If the user didn't request --[no-]whole-file, force
448 * it on, but only if we're not batch processing. */
449 if (whole_file < 0 && !write_batch)
451 ret = local_child(argc, args, f_in_p, f_out_p, child_main);
454 char *save_opts1, *save_opts2;
455 for (i = 0; strcmp(args[i], "--server") != 0; i++) {}
456 save_opts1 = args[i+1];
457 save_opts2 = args[i+2];
460 ret = piped_child(args, f_in_p, f_out_p);
461 args[i] = args[i-1]; /* move command name over --server */
462 args[i+1] = save_opts1;
463 args[i+2] = save_opts2;
465 write_sbuf(*f_out_p, args[i++]);
466 write_byte(*f_out_p, 0);
468 write_byte(*f_out_p, 0);
470 ret = piped_child(args, f_in_p, f_out_p);
479 out_of_memory("do_cmd");
480 return 0; /* not reached */
483 /* The receiving side operates in one of two modes:
485 * 1. it receives any number of files into a destination directory,
486 * placing them according to their names in the file-list.
488 * 2. it receives a single file and saves it using the name in the
489 * destination path instead of its file-list name. This requires a
490 * "local name" for writing out the destination file.
492 * So, our task is to figure out what mode/local-name we need.
493 * For mode 1, we change into the destination directory and return NULL.
494 * For mode 2, we change into the directory containing the destination
495 * file (if we aren't already there) and return the local-name. */
496 static char *get_local_name(struct file_list *flist, char *dest_path)
503 rprintf(FINFO, "get_local_name count=%d %s\n",
504 file_total, NS(dest_path));
507 if (!dest_path || list_only)
510 /* See what currently exists at the destination. */
511 if ((statret = do_stat(dest_path, &st)) == 0) {
512 /* If the destination is a dir, enter it and use mode 1. */
513 if (S_ISDIR(st.st_mode)) {
514 if (!push_dir(dest_path, 0)) {
515 rsyserr(FERROR, errno, "push_dir#1 %s failed",
516 full_fname(dest_path));
517 exit_cleanup(RERR_FILESELECT);
521 if (file_total > 1) {
523 "ERROR: destination must be a directory when"
524 " copying more than 1 file\n");
525 exit_cleanup(RERR_FILESELECT);
527 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
529 "ERROR: cannot overwrite non-directory"
530 " with a directory\n");
531 exit_cleanup(RERR_FILESELECT);
533 } else if (errno != ENOENT) {
534 /* If we don't know what's at the destination, fail. */
535 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
536 full_fname(dest_path));
537 exit_cleanup(RERR_FILESELECT);
540 cp = strrchr(dest_path, '/');
542 /* If we need a destination directory because the transfer is not
543 * of a single non-directory or the user has requested one via a
544 * destination path ending in a slash, create one and use mode 1. */
545 if (file_total > 1 || (cp && !cp[1])) {
546 /* Lop off the final slash (if any). */
552 "ERROR: destination path is not a directory\n");
553 exit_cleanup(RERR_SYNTAX);
556 if (mkdir_defmode(dest_path) != 0) {
557 rsyserr(FERROR, errno, "mkdir %s failed",
558 full_fname(dest_path));
559 exit_cleanup(RERR_FILEIO);
562 if (strcmp(flist->files[0]->basename, ".") == 0)
563 flist->files[0]->flags |= FLAG_DIR_CREATED;
566 rprintf(FINFO, "created directory %s\n", dest_path);
569 /* Indicate that dest dir doesn't really exist. */
573 if (!push_dir(dest_path, dry_run > 1)) {
574 rsyserr(FERROR, errno, "push_dir#2 %s failed",
575 full_fname(dest_path));
576 exit_cleanup(RERR_FILESELECT);
582 /* Otherwise, we are writing a single file, possibly on top of an
583 * existing non-directory. Change to the item's parent directory
584 * (if it has a path component), return the basename of the
585 * destination file as the local name, and use mode 2. */
593 if (!push_dir(dest_path, 0)) {
594 rsyserr(FERROR, errno, "push_dir#3 %s failed",
595 full_fname(dest_path));
596 exit_cleanup(RERR_FILESELECT);
603 /* Call this if the destination dir (which is assumed to be in curr_dir)
604 * does not yet exist and we can't create it due to being in dry-run
605 * mode. We'll fix dirs that can be relative to the non-existent dir. */
606 static void fix_basis_dirs(void)
608 char **dir, *new, *slash;
614 slash = strrchr(curr_dir, '/');
616 for (dir = basis_dir; *dir; dir++) {
619 len = curr_dir_len + 1 + strlen(*dir) + 1;
620 if (!(new = new_array(char, len)))
621 out_of_memory("fix_basis_dirs");
622 if (slash && strncmp(*dir, "../", 3) == 0) {
623 /* We want to remove only one leading "../" prefix for
624 * the directory we couldn't create in dry-run mode:
625 * this ensures that any other ".." references get
626 * evaluated the same as they would for a live copy. */
628 pathjoin(new, len, curr_dir, *dir + 3);
631 pathjoin(new, len, curr_dir, *dir);
636 /* This is only called by the sender. */
637 static void read_final_goodbye(int f_in)
641 char xname[MAXPATHLEN];
643 if (protocol_version < 29)
646 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
651 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
653 exit_cleanup(RERR_PROTOCOL);
657 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
659 struct file_list *flist;
663 rprintf(FINFO, "server_sender starting pid=%ld\n",
667 if (am_daemon && lp_write_only(module_id)) {
668 rprintf(FERROR, "ERROR: module is write only\n");
669 exit_cleanup(RERR_SYNTAX);
672 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
674 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
675 remove_source_files == 1 ? "source" : "sent");
676 exit_cleanup(RERR_SYNTAX);
680 if (!relative_paths) {
681 if (!push_dir(dir, 0)) {
682 rsyserr(FERROR, errno, "push_dir#3 %s failed",
684 exit_cleanup(RERR_FILESELECT);
690 if (argc == 0 && (recurse || list_only)) {
696 flist = send_file_list(f_out,argc,argv);
697 if (!flist || flist->used == 0)
700 io_start_buffering_in(f_in);
702 send_files(f_in, f_out);
703 io_flush(FULL_FLUSH);
705 if (protocol_version >= 24)
706 read_final_goodbye(f_in);
707 io_flush(FULL_FLUSH);
712 static int do_recv(int f_in, int f_out, char *local_name)
718 /* The receiving side mustn't obey this, or an existing symlink that
719 * points to an identical file won't be replaced by the referent. */
720 copy_links = copy_dirlinks = 0;
722 #ifdef SUPPORT_HARD_LINKS
723 if (preserve_hard_links && !inc_recurse)
724 match_hard_links(first_flist);
727 if (fd_pair(error_pipe) < 0) {
728 rsyserr(FERROR, errno, "pipe failed in do_recv");
729 exit_cleanup(RERR_IPC);
732 io_flush(NORMAL_FLUSH);
734 if ((pid = do_fork()) == -1) {
735 rsyserr(FERROR, errno, "fork failed in do_recv");
736 exit_cleanup(RERR_IPC);
740 close(error_pipe[0]);
744 /* we can't let two processes write to the socket at one time */
745 io_end_multiplex_out();
747 /* set place to send errors */
748 set_msg_fd_out(error_pipe[1]);
749 io_start_buffering_out(error_pipe[1]);
751 recv_files(f_in, local_name);
752 io_flush(FULL_FLUSH);
755 send_msg(MSG_DONE, "", 1, 0);
756 write_varlong(error_pipe[1], stats.total_read, 3);
757 io_flush(FULL_FLUSH);
759 /* Handle any keep-alive packets from the post-processing work
760 * that the generator does. */
761 if (protocol_version >= 29) {
764 char xname[MAXPATHLEN];
766 kluge_around_eof = -1;
768 /* This should only get stopped via a USR2 signal. */
769 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
772 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
774 exit_cleanup(RERR_PROTOCOL);
777 /* Finally, we go to sleep until our parent kills us with a
778 * USR2 signal. We sleep for a short time, as on some OSes
779 * a signal won't interrupt a sleep! */
786 io_end_multiplex_in();
787 if (write_batch && !am_server)
790 close(error_pipe[1]);
794 io_start_buffering_out(f_out);
796 set_msg_fd_in(error_pipe[0]);
797 io_start_buffering_in(error_pipe[0]);
799 #ifdef SUPPORT_HARD_LINKS
800 if (preserve_hard_links && inc_recurse) {
801 struct file_list *flist;
802 for (flist = first_flist; flist; flist = flist->next)
803 match_hard_links(flist);
807 generate_files(f_out, local_name);
810 io_flush(FULL_FLUSH);
811 if (protocol_version >= 24) {
812 /* send a final goodbye message */
813 write_ndx(f_out, NDX_DONE);
815 io_flush(FULL_FLUSH);
819 wait_process_with_flush(pid, &exit_code);
823 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
826 struct file_list *flist;
827 char *local_name = NULL;
829 int save_verbose = verbose;
831 if (filesfrom_fd >= 0) {
832 /* We can't mix messages with files-from data on the socket,
833 * so temporarily turn off verbose messages. */
838 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
839 argc, (long)getpid());
842 if (am_daemon && lp_read_only(module_id)) {
843 rprintf(FERROR,"ERROR: module is read only\n");
844 exit_cleanup(RERR_SYNTAX);
852 if (!am_daemon && !push_dir(dir, 0)) {
853 rsyserr(FERROR, errno, "push_dir#4 %s failed",
855 exit_cleanup(RERR_FILESELECT);
859 if (protocol_version >= 30)
860 io_start_multiplex_in();
862 io_start_buffering_in(f_in);
863 recv_filter_list(f_in);
865 if (filesfrom_fd >= 0) {
866 /* We need to send the files-from names to the sender at the
867 * same time that we receive the file-list from them, so we
868 * need the IO routines to automatically write out the names
869 * onto our f_out socket as we read the file-list. This
870 * avoids both deadlock and extra delays/buffers. */
871 io_set_filesfrom_fds(filesfrom_fd, f_out);
875 flist = recv_file_list(f_in);
877 rprintf(FERROR,"server_recv: recv_file_list error\n");
878 exit_cleanup(RERR_FILESELECT);
880 if (inc_recurse && file_total == 1)
881 recv_additional_file_list(f_in);
882 verbose = save_verbose;
885 local_name = get_local_name(flist,argv[0]);
887 /* Now that we know what our destination directory turned out to be,
888 * we can sanitize the --link-/copy-/compare-dest args correctly. */
889 if (sanitize_paths) {
891 for (dir = basis_dir; *dir; dir++) {
892 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
895 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
900 if (server_filter_list.head) {
902 struct filter_list_struct *elp = &server_filter_list;
904 for (dir = basis_dir; *dir; dir++) {
905 if (check_filter(elp, *dir, 1) < 0)
906 goto options_rejected;
908 if (partial_dir && *partial_dir == '/'
909 && check_filter(elp, partial_dir, 1) < 0) {
912 "Your options have been rejected by the server.\n");
913 exit_cleanup(RERR_SYNTAX);
917 exit_code = do_recv(f_in, f_out, local_name);
918 exit_cleanup(exit_code);
922 int child_main(int argc, char *argv[])
924 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
929 void start_server(int f_in, int f_out, int argc, char *argv[])
931 set_nonblocking(f_in);
932 set_nonblocking(f_out);
934 io_set_sock_fds(f_in, f_out);
935 setup_protocol(f_out, f_in);
940 if (protocol_version >= 23)
941 io_start_multiplex_out();
944 keep_dirlinks = 0; /* Must be disabled on the sender. */
945 if (need_messages_from_generator)
946 io_start_multiplex_in();
947 recv_filter_list(f_in);
948 do_server_sender(f_in, f_out, argc, argv);
950 do_server_recv(f_in, f_out, argc, argv);
956 * This is called once the connection has been negotiated. It is used
957 * for rsyncd, remote-shell, and local connections.
959 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
961 struct file_list *flist = NULL;
962 int exit_code = 0, exit_code2 = 0;
963 char *local_name = NULL;
965 cleanup_child_pid = pid;
967 set_nonblocking(f_in);
968 set_nonblocking(f_out);
971 io_set_sock_fds(f_in, f_out);
972 setup_protocol(f_out,f_in);
977 /* We set our stderr file handle to blocking because ssh might have
978 * set it to non-blocking. This can be particularly troublesome if
979 * stderr is a clone of stdout, because ssh would have set our stdout
980 * to non-blocking at the same time (which can easily cause us to lose
981 * output from our print statements). This kluge shouldn't cause ssh
982 * any problems for how we use it. Note also that we delayed setting
983 * this until after the above protocol setup so that we know for sure
984 * that ssh is done twiddling its file descriptors. */
985 set_blocking(STDERR_FILENO);
988 keep_dirlinks = 0; /* Must be disabled on the sender. */
989 if (protocol_version >= 30)
990 io_start_multiplex_out();
992 io_start_buffering_out(f_out);
995 send_filter_list(f_out);
999 if (write_batch && !am_server)
1000 start_write_batch(f_out);
1001 flist = send_file_list(f_out, argc, argv);
1004 rprintf(FINFO,"file list sent\n");
1006 if (protocol_version >= 23)
1007 io_start_multiplex_in();
1009 io_flush(NORMAL_FLUSH);
1010 send_files(f_in, f_out);
1011 io_flush(FULL_FLUSH);
1013 if (protocol_version >= 24)
1014 read_final_goodbye(f_in);
1017 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1018 io_flush(FULL_FLUSH);
1019 wait_process_with_flush(pid, &exit_code);
1022 io_flush(FULL_FLUSH);
1023 exit_cleanup(exit_code);
1027 if (protocol_version >= 23)
1028 io_start_multiplex_in();
1029 if (need_messages_from_generator)
1030 io_start_multiplex_out();
1036 send_filter_list(read_batch ? -1 : f_out);
1038 if (filesfrom_fd >= 0) {
1039 io_set_filesfrom_fds(filesfrom_fd, f_out);
1043 if (write_batch && !am_server)
1044 start_write_batch(f_in);
1045 flist = recv_file_list(f_in);
1046 if (inc_recurse && file_total == 1)
1047 recv_additional_file_list(f_in);
1049 if (flist && flist->used > 0) {
1050 local_name = get_local_name(flist, argv[0]);
1054 exit_code2 = do_recv(f_in, f_out, local_name);
1062 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1063 io_flush(FULL_FLUSH);
1064 wait_process_with_flush(pid, &exit_code);
1067 return MAX(exit_code, exit_code2);
1070 static int copy_argv(char *argv[])
1074 for (i = 0; argv[i]; i++) {
1075 if (!(argv[i] = strdup(argv[i]))) {
1076 rprintf (FERROR, "out of memory at %s(%d)\n",
1077 __FILE__, __LINE__);
1087 * Start a client for either type of remote connection. Work out
1088 * whether the arguments request a remote shell or rsyncd connection,
1089 * and call the appropriate connection function, then run_client.
1091 * Calls either start_socket_client (for sockets) or do_cmd and
1092 * client_run (for ssh).
1094 static int start_client(int argc, char *argv[])
1096 char *p, *shell_machine = NULL, *shell_user = NULL;
1103 /* Don't clobber argv[] so that ps(1) can still show the right
1105 if ((ret = copy_argv(argv)) != 0)
1108 if (!read_batch) { /* for read_batch, NO source is specified */
1109 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1110 if (path) { /* source is remote */
1117 if (argc == 1 || **argv == ':')
1118 argc = 0; /* no dest arg */
1119 else if (check_for_hostspec(*argv, &dummy1, &dummy2)) {
1121 "The source and destination cannot both be remote.\n");
1122 exit_cleanup(RERR_SYNTAX);
1124 remote_argc--; /* don't count dest */
1127 if (filesfrom_host && *filesfrom_host
1128 && strcmp(filesfrom_host, shell_machine) != 0) {
1130 "--files-from hostname is not the same as the transfer hostname\n");
1131 exit_cleanup(RERR_SYNTAX);
1135 daemon_over_rsh = shell_cmd ? 1 : -1;
1136 } else { /* source is local, check dest arg */
1141 remote_argv = argv + argc;
1143 static char *dotarg[1] = { "." };
1145 remote_argv = dotarg;
1150 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1151 if (path && filesfrom_host && *filesfrom_host
1152 && strcmp(filesfrom_host, shell_machine) != 0) {
1154 "--files-from hostname is not the same as the transfer hostname\n");
1155 exit_cleanup(RERR_SYNTAX);
1157 if (!path) { /* no hostspec found, so src & dest are local */
1159 if (filesfrom_host) {
1161 "--files-from cannot be remote when the transfer is local\n");
1162 exit_cleanup(RERR_SYNTAX);
1164 shell_machine = NULL;
1165 } else { /* hostspec was found, so dest is remote */
1168 daemon_over_rsh = shell_cmd ? 1 : -1;
1171 } else { /* read_batch */
1173 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1174 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1175 exit_cleanup(RERR_SYNTAX);
1177 remote_argv = argv + argc - 1;
1185 /* For local source, extra source args must not have hostspec. */
1186 for (i = 1; i < argc; i++) {
1187 if (check_for_hostspec(argv[i], &dummy1, &dummy2)) {
1188 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1189 exit_cleanup(RERR_SYNTAX);
1194 /* For remote source, any extra source args must be ":SOURCE" args. */
1195 for (i = 1; i < remote_argc; i++) {
1196 if (*remote_argv[i] != ':') {
1197 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1198 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1199 exit_cleanup(RERR_SYNTAX);
1207 if (daemon_over_rsh < 0)
1208 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1210 if (password_file && !daemon_over_rsh) {
1211 rprintf(FERROR, "The --password-file option may only be "
1212 "used when accessing an rsync daemon.\n");
1213 exit_cleanup(RERR_SYNTAX);
1216 if (shell_machine) {
1217 p = strrchr(shell_machine,'@');
1220 shell_user = shell_machine;
1221 shell_machine = p+1;
1226 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1227 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1228 remote_argv ? NS(remote_argv[0]) : "");
1231 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1234 /* if we're running an rsync server on the remote host over a
1235 * remote shell command, we need to do the RSYNCD protocol first */
1236 if (daemon_over_rsh) {
1238 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1243 ret = client_run(f_in, f_out, pid, argc, argv);
1252 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1254 exit_cleanup(RERR_SIGNAL1);
1257 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1263 _exit(RERR_PARTIAL);
1267 RETSIGTYPE remember_children(UNUSED(int val))
1272 /* An empty waitpid() loop was put here by Tridge and we could never
1273 * get him to explain why he put it in, so rather than taking it
1274 * out we're instead saving the child exit statuses for later use.
1275 * The waitpid() loop presumably eliminates all possibility of leaving
1276 * zombie children, maybe that's why he did it. */
1277 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1278 /* save the child's exit status */
1279 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1280 if (pid_stat_table[cnt].pid == 0) {
1281 pid_stat_table[cnt].pid = pid;
1282 pid_stat_table[cnt].status = status;
1288 #ifndef HAVE_SIGACTION
1289 signal(SIGCHLD, remember_children);
1295 * This routine catches signals and tries to send them to gdb.
1297 * Because it's called from inside a signal handler it ought not to
1298 * use too many library routines.
1300 * @todo Perhaps use "screen -X" instead/as well, to help people
1301 * debugging without easy access to X. Perhaps use an environment
1302 * variable, or just call a script?
1304 * @todo The /proc/ magic probably only works on Linux (and
1305 * Solaris?) Can we be more portable?
1307 #ifdef MAINTAINER_MODE
1308 const char *get_panic_action(void)
1310 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1315 return "xterm -display :0 -T Panic -n Panic "
1316 "-e gdb /proc/%d/exe %d";
1321 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1323 * This signal handler is only installed if we were configured with
1324 * --enable-maintainer-mode. Perhaps it should always be on and we
1325 * should just look at the environment variable, but I'm a bit leery
1326 * of a signal sending us into a busy loop.
1328 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1333 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1334 getpid(), getpid());
1336 /* Unless we failed to execute gdb, we allow the process to
1337 * continue. I'm not sure if that's right. */
1338 ret = system(cmd_buf);
1345 int main(int argc,char *argv[])
1348 int orig_argc = argc;
1349 char **orig_argv = argv;
1350 #ifdef HAVE_SIGACTION
1351 # ifdef HAVE_SIGPROCMASK
1354 sigemptyset(&sigmask);
1356 sigact.sa_flags = SA_NOCLDSTOP;
1358 SIGACTMASK(SIGUSR1, sigusr1_handler);
1359 SIGACTMASK(SIGUSR2, sigusr2_handler);
1360 SIGACTMASK(SIGCHLD, remember_children);
1361 #ifdef MAINTAINER_MODE
1362 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1363 SIGACTMASK(SIGFPE, rsync_panic_handler);
1364 SIGACTMASK(SIGABRT, rsync_panic_handler);
1365 SIGACTMASK(SIGBUS, rsync_panic_handler);
1368 starttime = time(NULL);
1369 am_root = (MY_UID() == 0);
1371 memset(&stats, 0, sizeof(stats));
1375 exit_cleanup(RERR_SYNTAX);
1378 /* we set a 0 umask so that correct file permissions can be
1380 orig_umask = umask(0);
1382 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1383 setlocale(LC_CTYPE, "");
1386 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1387 /* FIXME: We ought to call the same error-handling
1388 * code here, rather than relying on getopt. */
1390 exit_cleanup(RERR_SYNTAX);
1393 SIGACTMASK(SIGINT, sig_int);
1394 SIGACTMASK(SIGHUP, sig_int);
1395 SIGACTMASK(SIGTERM, sig_int);
1396 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1397 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1400 /* Ignore SIGPIPE; we consistently check error codes and will
1402 SIGACTION(SIGPIPE, SIG_IGN);
1404 SIGACTION(SIGXFSZ, SIG_IGN);
1407 /* Initialize push_dir here because on some old systems getcwd
1408 * (implemented by forking "pwd" and reading its output) doesn't
1409 * work when there are other child processes. Also, on all systems
1410 * that implement getcwd that way "pwd" can't be found after chroot. */
1415 if ((write_batch || read_batch) && !am_server) {
1417 write_batch_shell_file(orig_argc, orig_argv, argc);
1419 if (read_batch && strcmp(batch_name, "-") == 0)
1420 batch_fd = STDIN_FILENO;
1422 batch_fd = do_open(batch_name,
1423 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1424 : O_RDONLY, S_IRUSR | S_IWUSR);
1427 rsyserr(FERROR, errno, "Batch file %s open error",
1428 full_fname(batch_name));
1429 exit_cleanup(RERR_FILEIO);
1432 read_stream_flags(batch_fd);
1434 write_stream_flags(batch_fd);
1437 if (write_batch < 0)
1440 if (am_daemon && !am_server)
1441 return daemon_main();
1443 if (am_server && protect_args) {
1444 char buf[MAXPATHLEN];
1446 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1447 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1449 exit_cleanup(RERR_SYNTAX);
1455 exit_cleanup(RERR_SYNTAX);
1459 set_nonblocking(STDIN_FILENO);
1460 set_nonblocking(STDOUT_FILENO);
1462 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1463 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1466 ret = start_client(argc, argv);
1468 exit_cleanup(RERR_STARTCLIENT);