1 /* -*- c-file-style: "linux" -*-
3 Copyright (C) 1996-2001 by Andrew Tridgell <tridge@samba.org>
4 Copyright (C) Paul Mackerras 1996
5 Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 extern struct stats stats;
27 extern char *files_from;
28 extern int filesfrom_fd;
29 extern char *remote_filesfrom_file;
34 extern int protocol_version;
36 /* there's probably never more than at most 2 outstanding child processes,
37 * but set it higher just in case.
39 #define MAXCHILDPROCS 5
44 } pid_stat_table[MAXCHILDPROCS];
46 static void show_malloc_stats(void);
48 /****************************************************************************
49 wait for a process to exit, calling io_flush while waiting
50 ****************************************************************************/
51 void wait_process(pid_t pid, int *status)
56 while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
61 if ((waited_pid == -1) && (errno == ECHILD)) {
62 /* status of requested child no longer available.
63 * check to see if it was processed by the sigchld_handler.
65 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
66 if (pid == pid_stat_table[cnt].pid) {
67 *status = pid_stat_table[cnt].status;
68 pid_stat_table[cnt].pid = 0;
74 /* TODO: If the child exited on a signal, then log an
75 * appropriate error message. Perhaps we should also accept a
76 * message describing the purpose of the child. Also indicate
77 * this to the caller so that thhey know something went
79 *status = WEXITSTATUS(*status);
82 static void report(int f)
84 time_t t = time(NULL);
88 if (do_stats && verbose > 1) {
89 /* These come out from every process */
95 log_exit(0, __FILE__, __LINE__);
96 if (f == -1 || !am_sender) return;
99 send_stats = verbose || protocol_version >= 20;
101 if (am_sender && send_stats) {
103 /* store total_written in a temporary
104 * because write_longint changes it */
105 w = stats.total_written;
106 write_longint(f,stats.total_read);
108 write_longint(f,stats.total_size);
113 /* this is the client */
115 if (!am_sender && send_stats) {
117 stats.total_written = read_longint(f);
118 /* store total_read in a temporary, read_longint changes it */
120 stats.total_size = read_longint(f);
121 stats.total_read = r;
125 if (!am_sender && !send_stats) {
126 /* missing the bytes written by the generator */
127 rprintf(FINFO, "\nCannot show stats as receiver because remote protocol version is less than 20\n");
128 rprintf(FINFO, "Use --stats -v to show stats\n");
131 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
132 rprintf(FINFO,"Number of files transferred: %d\n",
133 stats.num_transferred_files);
134 rprintf(FINFO,"Total file size: %.0f bytes\n",
135 (double)stats.total_size);
136 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
137 (double)stats.total_transferred_size);
138 rprintf(FINFO,"Literal data: %.0f bytes\n",
139 (double)stats.literal_data);
140 rprintf(FINFO,"Matched data: %.0f bytes\n",
141 (double)stats.matched_data);
142 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
143 rprintf(FINFO,"Total bytes written: %.0f\n",
144 (double)stats.total_written);
145 rprintf(FINFO,"Total bytes read: %.0f\n",
146 (double)stats.total_read);
149 if (verbose || do_stats) {
150 rprintf(FINFO,"\nwrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
151 (double)stats.total_written,
152 (double)stats.total_read,
153 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
154 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
155 (double)stats.total_size,
156 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
165 * If our C library can get malloc statistics, then show them to FINFO
167 static void show_malloc_stats(void)
174 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
176 am_server ? "server " : "",
177 am_daemon ? "daemon " : "",
178 am_sender ? "sender" : "receiver");
179 rprintf(FINFO, " arena: %10d (bytes from sbrk)\n", mi.arena);
180 rprintf(FINFO, " ordblks: %10d (chunks not in use)\n", mi.ordblks);
181 rprintf(FINFO, " smblks: %10d\n", mi.smblks);
182 rprintf(FINFO, " hblks: %10d (chunks from mmap)\n", mi.hblks);
183 rprintf(FINFO, " hblkhd: %10d (bytes from mmap)\n", mi.hblkhd);
184 rprintf(FINFO, " usmblks: %10d\n", mi.usmblks);
185 rprintf(FINFO, " fsmblks: %10d\n", mi.fsmblks);
186 rprintf(FINFO, " uordblks: %10d (bytes used)\n", mi.uordblks);
187 rprintf(FINFO, " fordblks: %10d (bytes free)\n", mi.fordblks);
188 rprintf(FINFO, " keepcost: %10d (bytes in releasable chunk)\n", mi.keepcost);
189 #endif /* HAVE_MALLINFO */
193 /* Start the remote shell. cmd may be NULL to use the default. */
194 static pid_t do_cmd(char *cmd,char *machine,char *user,char *path,int *f_in,int *f_out)
201 extern int local_server;
202 extern char *rsync_path;
203 extern int blocking_io;
204 extern int daemon_over_rsh;
205 extern int read_batch;
207 if (!read_batch && !local_server) {
209 cmd = getenv(RSYNC_RSH_ENV);
216 for (tok=strtok(cmd," ");tok;tok=strtok(NULL," ")) {
220 /* check to see if we've already been given '-l user' in
221 the remote-shell command */
222 for (i = 0; i < argc-1; i++) {
223 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
228 /* remsh (on HPUX) takes the arguments the other way around */
229 args[argc++] = machine;
230 if (user && !(daemon_over_rsh && dash_l_set)) {
235 if (user && !(daemon_over_rsh && dash_l_set)) {
239 args[argc++] = machine;
242 args[argc++] = rsync_path;
244 if (blocking_io == -1) {
245 char *cp = strrchr(cmd, '/');
250 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
254 server_options(args,&argc);
260 if (!daemon_over_rsh && path && *path)
266 rprintf(FINFO,"cmd=");
268 rprintf(FINFO,"%s ",args[i]);
274 create_flist_from_batch(); /* sets batch_flist */
275 ret = local_child(argc, args, f_in, f_out, child_main);
277 ret = piped_child(args,f_in,f_out);
285 out_of_memory("do_cmd");
286 return 0; /* not reached */
292 static char *get_local_name(struct file_list *flist,char *name)
296 extern int orig_umask;
299 rprintf(FINFO,"get_local_name count=%d %s\n",
300 flist->count, NS(name));
305 if (do_stat(name,&st) == 0) {
306 if (S_ISDIR(st.st_mode)) {
307 if (!push_dir(name, 0)) {
308 rprintf(FERROR, "push_dir %s failed: %s (1)\n",
309 full_fname(name), strerror(errno));
310 exit_cleanup(RERR_FILESELECT);
314 if (flist->count > 1) {
315 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
316 exit_cleanup(RERR_FILESELECT);
321 if (flist->count <= 1 && ((e = strlen(name)) <= 1 || name[e-1] != '/'))
324 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
325 rprintf(FERROR, "mkdir %s failed: %s\n",
326 full_fname(name), strerror(errno));
327 exit_cleanup(RERR_FILEIO);
330 rprintf(FINFO,"created directory %s\n",name);
333 if (!push_dir(name, 0)) {
334 rprintf(FERROR, "push_dir %s failed: %s (2)\n",
335 full_fname(name), strerror(errno));
336 exit_cleanup(RERR_FILESELECT);
345 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
348 struct file_list *flist;
350 extern int relative_paths;
354 rprintf(FINFO,"server_sender starting pid=%d\n",(int)getpid());
356 if (!relative_paths && !push_dir(dir, 0)) {
357 rprintf(FERROR, "push_dir %s failed: %s (3)\n",
358 full_fname(dir), strerror(errno));
359 exit_cleanup(RERR_FILESELECT);
364 if (strcmp(dir,".")) {
366 if (strcmp(dir,"/") == 0)
372 if (argc == 0 && recurse) {
378 flist = send_file_list(f_out,argc,argv);
379 if (!flist || flist->count == 0) {
383 send_files(flist,f_out,f_in);
386 if (protocol_version >= 24) {
387 /* final goodbye message */
395 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
401 extern int preserve_hard_links;
402 extern int delete_after;
404 extern int delete_mode;
406 if (preserve_hard_links)
407 init_hard_links(flist);
410 /* I moved this here from recv_files() to prevent a race condition */
411 if (recurse && delete_mode && !local_name && flist->count>0) {
416 if (fd_pair(recv_pipe) < 0) {
417 rprintf(FERROR,"pipe failed in do_recv\n");
418 exit_cleanup(RERR_SOCKETIO);
421 if (fd_pair(error_pipe) < 0) {
422 rprintf(FERROR,"error pipe failed in do_recv\n");
423 exit_cleanup(RERR_SOCKETIO);
428 if ((pid=do_fork()) == 0) {
430 close(error_pipe[0]);
431 if (f_in != f_out) close(f_out);
433 /* we can't let two processes write to the socket at one time */
434 io_multiplexing_close();
436 /* set place to send errors */
437 set_error_fd(error_pipe[1]);
439 recv_files(f_in,flist,local_name,recv_pipe[1]);
443 write_int(recv_pipe[1],1);
446 /* finally we go to sleep until our parent kills us
447 with a USR2 signal. We sleep for a short time as on
448 some OSes a signal won't interrupt a sleep! */
454 close(error_pipe[1]);
455 if (f_in != f_out) close(f_in);
457 io_start_buffering(f_out);
459 io_set_error_fd(error_pipe[0]);
461 generate_files(f_out,flist,local_name,recv_pipe[0]);
463 read_int(recv_pipe[0]);
465 if (protocol_version >= 24) {
466 /* send a final goodbye message */
467 write_int(f_out, -1);
473 wait_process(pid, &status);
478 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
481 struct file_list *flist;
482 char *local_name=NULL;
484 extern int delete_mode;
485 extern int delete_excluded;
486 extern int module_id;
487 extern int read_batch;
488 extern struct file_list *batch_flist;
491 rprintf(FINFO,"server_recv(%d) starting pid=%d\n",argc,(int)getpid());
493 if (am_daemon && lp_read_only(module_id) && !am_sender) {
494 rprintf(FERROR,"ERROR: module is read only\n");
495 exit_cleanup(RERR_SYNTAX);
504 if (!am_daemon && !push_dir(dir, 0)) {
505 rprintf(FERROR, "push_dir %s failed: %s (4)\n",
506 full_fname(dir), strerror(errno));
507 exit_cleanup(RERR_FILESELECT);
511 if (delete_mode && !delete_excluded)
512 recv_exclude_list(f_in);
514 if (filesfrom_fd >= 0) {
515 /* We're receiving the file info from the sender, so we need
516 * the IO routines to automatically write out the names onto
517 * our f_out socket as we read the list info from the sender.
518 * This avoids both deadlock and extra delays/buffers. */
519 io_set_filesfrom_fds(filesfrom_fd, f_out);
526 flist = recv_file_list(f_in);
528 rprintf(FERROR,"server_recv: recv_file_list error\n");
529 exit_cleanup(RERR_FILESELECT);
533 if (strcmp(dir,".")) {
534 argv[0] += strlen(dir);
535 if (argv[0][0] == '/') argv[0]++;
537 local_name = get_local_name(flist,argv[0]);
540 status = do_recv(f_in,f_out,flist,local_name);
541 exit_cleanup(status);
545 int child_main(int argc, char *argv[])
547 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
552 void start_server(int f_in, int f_out, int argc, char *argv[])
554 extern int cvs_exclude;
555 extern int read_batch;
557 setup_protocol(f_out, f_in);
559 set_nonblocking(f_in);
560 set_nonblocking(f_out);
562 if (protocol_version >= 23)
563 io_start_multiplex_out(f_out);
567 recv_exclude_list(f_in);
571 do_server_sender(f_in, f_out, argc, argv);
573 do_server_recv(f_in, f_out, argc, argv);
580 * This is called once the connection has been negotiated. It is used
581 * for rsyncd, remote-shell, and local connections.
583 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
585 struct file_list *flist = NULL;
586 int status = 0, status2 = 0;
587 char *local_name = NULL;
588 extern pid_t cleanup_child_pid;
589 extern int write_batch;
590 extern int read_batch;
591 extern struct file_list *batch_flist;
593 cleanup_child_pid = pid;
597 set_nonblocking(f_in);
598 set_nonblocking(f_out);
600 setup_protocol(f_out,f_in);
602 if (protocol_version >= 23)
603 io_start_multiplex_in(f_in);
606 extern int cvs_exclude;
607 extern int delete_mode;
608 extern int delete_excluded;
611 if (delete_mode && !delete_excluded)
612 send_exclude_list(f_out);
613 if (remote_filesfrom_file)
615 if (!read_batch) /* dw -- don't write to pipe */
616 flist = send_file_list(f_out,argc,argv);
618 rprintf(FINFO,"file list sent\n");
620 send_files(flist,f_out,f_in);
621 if (protocol_version >= 24) {
622 /* final goodbye message */
627 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
629 wait_process(pid, &status);
632 exit_cleanup(status);
636 extern int list_only;
641 send_exclude_list(f_out);
643 if (filesfrom_fd >= 0) {
644 io_set_filesfrom_fds(filesfrom_fd, f_out);
648 flist = recv_file_list(f_in);
649 if (!flist || flist->count == 0) {
650 rprintf(FINFO, "client: nothing to do: "
651 "perhaps you need to specify some filenames or "
652 "the --recursive option?\n");
656 local_name = get_local_name(flist,argv[0]);
658 status2 = do_recv(f_in,f_out,flist,local_name);
662 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
664 wait_process(pid, &status);
667 return MAX(status, status2);
670 static int copy_argv (char *argv[])
674 for (i = 0; argv[i]; i++) {
675 if (!(argv[i] = strdup(argv[i]))) {
676 rprintf (FERROR, "out of memory at %s(%d)\n",
687 * Start a client for either type of remote connection. Work out
688 * whether the arguments request a remote shell or rsyncd connection,
689 * and call the appropriate connection function, then run_client.
691 * Calls either start_socket_client (for sockets) or do_cmd and
692 * client_run (for ssh).
694 static int start_client(int argc, char *argv[])
697 char *shell_machine = NULL;
698 char *shell_path = NULL;
699 char *shell_user = NULL;
703 extern int local_server;
704 extern char *shell_cmd;
705 extern int rsync_port;
706 extern int daemon_over_rsh;
707 extern int read_batch;
710 /* Don't clobber argv[] so that ps(1) can still show the right
712 if ((rc = copy_argv(argv)))
715 /* rsync:// always uses rsync server over direct socket connection */
716 if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0) {
719 host = argv[0] + strlen(URL_PREFIX);
720 p = strchr(host,'/');
727 p = strchr(host,':');
729 rsync_port = atoi(p+1);
732 return start_socket_client(host, path, argc-1, argv+1);
736 p = find_colon(argv[0]);
738 if (remote_filesfrom_file
739 && remote_filesfrom_file != files_from + 1
740 && strncmp(files_from, argv[0], p-argv[0]+1) != 0) {
742 "--files-from hostname is not transfer hostname\n");
743 exit_cleanup(RERR_SYNTAX);
745 if (p[1] == ':') { /* double colon */
748 return start_socket_client(argv[0], p+2,
757 exit_cleanup(RERR_SYNTAX);
762 shell_machine = argv[0];
769 /* rsync:// destination uses rsync server over direct socket */
770 if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
773 host = argv[argc-1] + strlen(URL_PREFIX);
774 p = strchr(host,'/');
781 p = strchr(host,':');
783 rsync_port = atoi(p+1);
786 return start_socket_client(host, path, argc-1, argv);
789 p = find_colon(argv[argc-1]);
790 if (p && remote_filesfrom_file
791 && remote_filesfrom_file != files_from + 1
792 && strncmp(files_from, argv[argc-1], p-argv[argc-1]+1) != 0) {
794 "--files-from hostname is not transfer hostname\n");
795 exit_cleanup(RERR_SYNTAX);
799 if (remote_filesfrom_file) {
801 "--files-from is remote but transfer is local\n");
802 exit_cleanup(RERR_SYNTAX);
804 } else if (p[1] == ':') { /* double colon */
807 return start_socket_client(argv[argc-1], p+2,
816 exit_cleanup(RERR_SYNTAX);
820 shell_machine = NULL;
821 shell_path = argv[argc-1];
824 shell_machine = argv[argc-1];
832 shell_path = argv[argc-1];
836 p = strchr(shell_machine,'@');
839 shell_user = shell_machine;
845 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
846 shell_cmd?shell_cmd:"",
847 shell_machine?shell_machine:"",
848 shell_user?shell_user:"",
849 shell_path?shell_path:"");
852 if (!am_sender && argc > 1) {
854 exit_cleanup(RERR_SYNTAX);
857 if (argc == 0 && !am_sender) {
858 extern int list_only;
862 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
865 /* if we're running an rsync server on the remote host over a
866 remote shell command, we need to do the RSYNCD protocol first */
867 if (daemon_over_rsh) {
869 tmpret = start_inband_exchange(shell_user, shell_path,
875 ret = client_run(f_in, f_out, pid, argc, argv);
884 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
886 exit_cleanup(RERR_SIGNAL);
889 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
891 extern int log_got_error;
892 if (log_got_error) _exit(RERR_PARTIAL);
896 static RETSIGTYPE sigchld_handler(UNUSED(int val))
901 /* An empty waitpid() loop was put here by Tridge and we could never
902 * get him to explain why he put it in, so rather than taking it
903 * out we're instead saving the child exit statuses for later use.
904 * The waitpid() loop presumably eliminates all possibility of leaving
905 * zombie children, maybe that's why he did it.
907 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
908 /* save the child's exit status */
909 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
910 if (pid_stat_table[cnt].pid == 0) {
911 pid_stat_table[cnt].pid = pid;
912 pid_stat_table[cnt].status = status;
922 * This routine catches signals and tries to send them to gdb.
924 * Because it's called from inside a signal handler it ought not to
925 * use too many library routines.
927 * @todo Perhaps use "screen -X" instead/as well, to help people
928 * debugging without easy access to X. Perhaps use an environment
929 * variable, or just call a script?
931 * @todo The /proc/ magic probably only works on Linux (and
932 * Solaris?) Can we be more portable?
934 #ifdef MAINTAINER_MODE
935 const char *get_panic_action(void)
937 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
942 return "xterm -display :0 -T Panic -n Panic "
943 "-e gdb /proc/%d/exe %d";
948 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
950 * This signal handler is only installed if we were configured with
951 * --enable-maintainer-mode. Perhaps it should always be on and we
952 * should just look at the environment variable, but I'm a bit leery
953 * of a signal sending us into a busy loop.
955 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
960 sprintf(cmd_buf, get_panic_action(),
963 /* Unless we failed to execute gdb, we allow the process to
964 * continue. I'm not sure if that's right. */
965 ret = system(cmd_buf);
972 int main(int argc,char *argv[])
975 extern int orig_umask;
978 extern int write_batch;
985 signal(SIGUSR1, sigusr1_handler);
986 signal(SIGUSR2, sigusr2_handler);
987 signal(SIGCHLD, sigchld_handler);
988 #ifdef MAINTAINER_MODE
989 signal(SIGSEGV, rsync_panic_handler);
990 signal(SIGFPE, rsync_panic_handler);
991 signal(SIGABRT, rsync_panic_handler);
992 signal(SIGBUS, rsync_panic_handler);
993 #endif /* def MAINTAINER_MODE */
995 starttime = time(NULL);
996 am_root = (getuid() == 0);
998 memset(&stats, 0, sizeof(stats));
1002 exit_cleanup(RERR_SYNTAX);
1005 /* we set a 0 umask so that correct file permissions can be
1007 orig_umask = (int)umask(0);
1009 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1010 /* FIXME: We ought to call the same error-handling
1011 * code here, rather than relying on getopt. */
1013 exit_cleanup(RERR_SYNTAX);
1016 signal(SIGINT,SIGNAL_CAST sig_int);
1017 signal(SIGHUP,SIGNAL_CAST sig_int);
1018 signal(SIGTERM,SIGNAL_CAST sig_int);
1020 /* Ignore SIGPIPE; we consistently check error codes and will
1022 signal(SIGPIPE, SIG_IGN);
1024 /* Initialize push_dir here because on some old systems getcwd
1025 (implemented by forking "pwd" and reading its output) doesn't
1026 work when there are other child processes. Also, on all systems
1027 that implement getcwd that way "pwd" can't be found after chroot. */
1030 if (write_batch && !am_server) {
1031 write_batch_argvs_file(orig_argc, orig_argv);
1034 if (am_daemon && !am_server)
1035 return daemon_main();
1039 exit_cleanup(RERR_SYNTAX);
1043 verbose = MAX(verbose,1);
1045 #ifndef SUPPORT_LINKS
1046 if (!am_server && preserve_links) {
1047 rprintf(FERROR,"ERROR: symbolic links not supported\n");
1048 exit_cleanup(RERR_UNSUPPORTED);
1053 set_nonblocking(STDIN_FILENO);
1054 set_nonblocking(STDOUT_FILENO);
1056 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1057 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1060 ret = start_client(argc, argv);
1062 exit_cleanup(RERR_STARTCLIENT);