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;
35 /* there's probably never more than at most 2 outstanding child processes,
36 * but set it higher just in case.
38 #define MAXCHILDPROCS 5
43 } pid_stat_table[MAXCHILDPROCS];
45 static void show_malloc_stats(void);
47 /****************************************************************************
48 wait for a process to exit, calling io_flush while waiting
49 ****************************************************************************/
50 void wait_process(pid_t pid, int *status)
55 while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
60 if ((waited_pid == -1) && (errno == ECHILD)) {
61 /* status of requested child no longer available.
62 * check to see if it was processed by the sigchld_handler.
64 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
65 if (pid == pid_stat_table[cnt].pid) {
66 *status = pid_stat_table[cnt].status;
67 pid_stat_table[cnt].pid = 0;
73 /* TODO: If the child exited on a signal, then log an
74 * appropriate error message. Perhaps we should also accept a
75 * message describing the purpose of the child. Also indicate
76 * this to the caller so that thhey know something went
78 *status = WEXITSTATUS(*status);
81 static void report(int f)
83 time_t t = time(NULL);
85 extern int remote_version;
89 /* These come out from every process */
96 log_exit(0, __FILE__, __LINE__);
97 if (f == -1 || !am_sender) return;
100 send_stats = verbose || (remote_version >= 20);
102 if (am_sender && send_stats) {
104 /* store total_written in a temporary
105 * because write_longint changes it */
106 w = stats.total_written;
107 write_longint(f,stats.total_read);
109 write_longint(f,stats.total_size);
114 /* this is the client */
116 if (!am_sender && send_stats) {
118 stats.total_written = read_longint(f);
119 /* store total_read in a temporary, read_longint changes it */
121 stats.total_size = read_longint(f);
122 stats.total_read = r;
126 if (!am_sender && !send_stats) {
127 /* missing the bytes written by the generator */
128 rprintf(FINFO, "\nCannot show stats as receiver because remote protocol version is less than 20\n");
129 rprintf(FINFO, "Use --stats -v to show stats\n");
132 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
133 rprintf(FINFO,"Number of files transferred: %d\n",
134 stats.num_transferred_files);
135 rprintf(FINFO,"Total file size: %.0f bytes\n",
136 (double)stats.total_size);
137 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
138 (double)stats.total_transferred_size);
139 rprintf(FINFO,"Literal data: %.0f bytes\n",
140 (double)stats.literal_data);
141 rprintf(FINFO,"Matched data: %.0f bytes\n",
142 (double)stats.matched_data);
143 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
144 rprintf(FINFO,"Total bytes written: %.0f\n",
145 (double)stats.total_written);
146 rprintf(FINFO,"Total bytes read: %.0f\n",
147 (double)stats.total_read);
150 if (verbose || do_stats) {
151 rprintf(FINFO,"\nwrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
152 (double)stats.total_written,
153 (double)stats.total_read,
154 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
155 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
156 (double)stats.total_size,
157 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
166 * If our C library can get malloc statistics, then show them to FINFO
168 static void show_malloc_stats(void)
175 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
177 am_server ? "server " : "",
178 am_daemon ? "daemon " : "",
179 am_sender ? "sender" : "receiver");
180 rprintf(FINFO, " arena: %10d (bytes from sbrk)\n", mi.arena);
181 rprintf(FINFO, " ordblks: %10d (chunks not in use)\n", mi.ordblks);
182 rprintf(FINFO, " smblks: %10d\n", mi.smblks);
183 rprintf(FINFO, " hblks: %10d (chunks from mmap)\n", mi.hblks);
184 rprintf(FINFO, " hblkhd: %10d (bytes from mmap)\n", mi.hblkhd);
185 rprintf(FINFO, " usmblks: %10d\n", mi.usmblks);
186 rprintf(FINFO, " fsmblks: %10d\n", mi.fsmblks);
187 rprintf(FINFO, " uordblks: %10d (bytes used)\n", mi.uordblks);
188 rprintf(FINFO, " fordblks: %10d (bytes free)\n", mi.fordblks);
189 rprintf(FINFO, " keepcost: %10d (bytes in releasable chunk)\n", mi.keepcost);
190 #endif /* HAVE_MALLINFO */
194 /* Start the remote shell. cmd may be NULL to use the default. */
195 static pid_t do_cmd(char *cmd,char *machine,char *user,char *path,int *f_in,int *f_out)
202 extern int local_server;
203 extern char *rsync_path;
204 extern int blocking_io;
205 extern int daemon_over_rsh;
206 extern int read_batch;
208 if (!read_batch && !local_server) {
210 cmd = getenv(RSYNC_RSH_ENV);
217 for (tok=strtok(cmd," ");tok;tok=strtok(NULL," ")) {
221 /* check to see if we've already been given '-l user' in
222 the remote-shell command */
223 for (i = 0; i < argc-1; i++) {
224 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
229 /* remsh (on HPUX) takes the arguments the other way around */
230 args[argc++] = machine;
231 if (user && !(daemon_over_rsh && dash_l_set)) {
236 if (user && !(daemon_over_rsh && dash_l_set)) {
240 args[argc++] = machine;
243 args[argc++] = rsync_path;
245 if ((blocking_io == -1) && (strcmp(cmd, RSYNC_RSH) == 0))
248 server_options(args,&argc);
254 if (!daemon_over_rsh && path && *path)
260 rprintf(FINFO,"cmd=");
262 rprintf(FINFO,"%s ",args[i]);
268 create_flist_from_batch(); /* sets batch_flist */
269 ret = local_child(argc, args, f_in, f_out, child_main);
271 ret = piped_child(args,f_in,f_out);
279 out_of_memory("do_cmd");
280 return 0; /* not reached */
286 static char *get_local_name(struct file_list *flist,char *name)
289 extern int orig_umask;
292 rprintf(FINFO,"get_local_name count=%d %s\n",
293 flist->count, NS(name));
298 if (do_stat(name,&st) == 0) {
299 if (S_ISDIR(st.st_mode)) {
300 if (!push_dir(name, 0)) {
301 rprintf(FERROR,"push_dir %s : %s (1)\n",
302 name,strerror(errno));
303 exit_cleanup(RERR_FILESELECT);
307 if (flist->count > 1) {
308 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
309 exit_cleanup(RERR_FILESELECT);
314 if (flist->count <= 1)
317 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
318 rprintf(FERROR, RSYNC_NAME ": mkdir %s: %s\n",
319 name, strerror(errno));
320 exit_cleanup(RERR_FILEIO);
323 rprintf(FINFO,"created directory %s\n",name);
326 if (!push_dir(name, 0)) {
327 rprintf(FERROR, RSYNC_NAME ": push_dir %s: %s\n",
328 name, strerror(errno));
329 exit_cleanup(RERR_FILESELECT);
338 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
341 struct file_list *flist;
343 extern int relative_paths;
345 extern int remote_version;
348 rprintf(FINFO,"server_sender starting pid=%d\n",(int)getpid());
350 if (!relative_paths && !push_dir(dir, 0)) {
351 rprintf(FERROR,"push_dir %s: %s (3)\n",dir,strerror(errno));
352 exit_cleanup(RERR_FILESELECT);
357 if (strcmp(dir,".")) {
359 if (strcmp(dir,"/") == 0)
365 if (argc == 0 && recurse) {
371 flist = send_file_list(f_out,argc,argv);
372 if (!flist || flist->count == 0) {
376 send_files(flist,f_out,f_in);
379 if (remote_version >= 24) {
380 /* final goodbye message */
388 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
394 extern int preserve_hard_links;
395 extern int delete_after;
397 extern int delete_mode;
398 extern int remote_version;
400 if (preserve_hard_links)
401 init_hard_links(flist);
404 /* I moved this here from recv_files() to prevent a race condition */
405 if (recurse && delete_mode && !local_name && flist->count>0) {
410 if (fd_pair(recv_pipe) < 0) {
411 rprintf(FERROR,"pipe failed in do_recv\n");
412 exit_cleanup(RERR_SOCKETIO);
415 if (fd_pair(error_pipe) < 0) {
416 rprintf(FERROR,"error pipe failed in do_recv\n");
417 exit_cleanup(RERR_SOCKETIO);
422 if ((pid=do_fork()) == 0) {
424 close(error_pipe[0]);
425 if (f_in != f_out) close(f_out);
427 /* we can't let two processes write to the socket at one time */
428 io_multiplexing_close();
430 /* set place to send errors */
431 set_error_fd(error_pipe[1]);
433 recv_files(f_in,flist,local_name,recv_pipe[1]);
437 write_int(recv_pipe[1],1);
440 /* finally we go to sleep until our parent kills us
441 with a USR2 signal. We sleep for a short time as on
442 some OSes a signal won't interrupt a sleep! */
448 close(error_pipe[1]);
449 if (f_in != f_out) close(f_in);
451 io_start_buffering(f_out);
453 io_set_error_fd(error_pipe[0]);
455 generate_files(f_out,flist,local_name,recv_pipe[0]);
457 read_int(recv_pipe[0]);
459 if (remote_version >= 24) {
460 /* send a final goodbye message */
461 write_int(f_out, -1);
467 wait_process(pid, &status);
472 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
475 struct file_list *flist;
476 char *local_name=NULL;
478 extern int delete_mode;
479 extern int delete_excluded;
480 extern int module_id;
481 extern int read_batch;
482 extern struct file_list *batch_flist;
485 rprintf(FINFO,"server_recv(%d) starting pid=%d\n",argc,(int)getpid());
487 if (am_daemon && lp_read_only(module_id) && !am_sender) {
488 rprintf(FERROR,"ERROR: module is read only\n");
489 exit_cleanup(RERR_SYNTAX);
498 if (!am_daemon && !push_dir(dir, 0)) {
499 rprintf(FERROR,"push_dir %s : %s (4)\n",
500 dir,strerror(errno));
501 exit_cleanup(RERR_FILESELECT);
505 if (delete_mode && !delete_excluded)
506 recv_exclude_list(f_in);
508 if (filesfrom_fd >= 0) {
509 /* We're receiving the file info from the sender, so we need
510 * the IO routines to automatically write out the names onto
511 * our f_out socket as we read the list info from the sender.
512 * This avoids both deadlock and extra delays/buffers. */
513 io_set_filesfrom_fds(filesfrom_fd, f_out);
520 flist = recv_file_list(f_in);
522 rprintf(FERROR,"server_recv: recv_file_list error\n");
523 exit_cleanup(RERR_FILESELECT);
527 if (strcmp(dir,".")) {
528 argv[0] += strlen(dir);
529 if (argv[0][0] == '/') argv[0]++;
531 local_name = get_local_name(flist,argv[0]);
534 status = do_recv(f_in,f_out,flist,local_name);
535 exit_cleanup(status);
539 int child_main(int argc, char *argv[])
541 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
546 void start_server(int f_in, int f_out, int argc, char *argv[])
548 extern int cvs_exclude;
549 extern int remote_version;
550 extern int read_batch;
552 setup_protocol(f_out, f_in);
554 set_nonblocking(f_in);
555 set_nonblocking(f_out);
557 if (remote_version >= 23)
558 io_start_multiplex_out(f_out);
562 recv_exclude_list(f_in);
566 do_server_sender(f_in, f_out, argc, argv);
568 do_server_recv(f_in, f_out, argc, argv);
575 * This is called once the connection has been negotiated. It is used
576 * for rsyncd, remote-shell, and local connections.
578 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
580 struct file_list *flist = NULL;
581 int status = 0, status2 = 0;
582 char *local_name = NULL;
583 extern int remote_version;
584 extern pid_t cleanup_child_pid;
585 extern int write_batch;
586 extern int read_batch;
587 extern struct file_list *batch_flist;
589 cleanup_child_pid = pid;
593 set_nonblocking(f_in);
594 set_nonblocking(f_out);
596 setup_protocol(f_out,f_in);
598 if (remote_version >= 23)
599 io_start_multiplex_in(f_in);
602 extern int cvs_exclude;
603 extern int delete_mode;
604 extern int delete_excluded;
607 if (delete_mode && !delete_excluded)
608 send_exclude_list(f_out);
609 if (remote_filesfrom_file)
611 if (!read_batch) /* dw -- don't write to pipe */
612 flist = send_file_list(f_out,argc,argv);
614 rprintf(FINFO,"file list sent\n");
616 send_files(flist,f_out,f_in);
617 if (remote_version >= 24) {
618 /* final goodbye message */
623 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
625 wait_process(pid, &status);
628 exit_cleanup(status);
632 extern int list_only;
637 send_exclude_list(f_out);
639 if (filesfrom_fd >= 0) {
640 io_set_filesfrom_fds(filesfrom_fd, f_out);
644 flist = recv_file_list(f_in);
645 if (!flist || flist->count == 0) {
646 rprintf(FINFO, "client: nothing to do: "
647 "perhaps you need to specify some filenames or "
648 "the --recursive option?\n");
652 local_name = get_local_name(flist,argv[0]);
654 status2 = do_recv(f_in,f_out,flist,local_name);
658 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
660 wait_process(pid, &status);
663 return MAX(status, status2);
666 static int copy_argv (char *argv[])
670 for (i = 0; argv[i]; i++) {
671 if (!(argv[i] = strdup(argv[i]))) {
672 rprintf (FERROR, "out of memory at %s(%d)\n",
683 * Start a client for either type of remote connection. Work out
684 * whether the arguments request a remote shell or rsyncd connection,
685 * and call the appropriate connection function, then run_client.
687 * Calls either start_socket_client (for sockets) or do_cmd and
688 * client_run (for ssh).
690 static int start_client(int argc, char *argv[])
693 char *shell_machine = NULL;
694 char *shell_path = NULL;
695 char *shell_user = NULL;
699 extern int local_server;
700 extern char *shell_cmd;
701 extern int rsync_port;
702 extern int daemon_over_rsh;
703 extern int read_batch;
706 /* Don't clobber argv[] so that ps(1) can still show the right
708 if ((rc = copy_argv(argv)))
711 /* rsync:// always uses rsync server over direct socket connection */
712 if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0) {
715 host = argv[0] + strlen(URL_PREFIX);
716 p = strchr(host,'/');
723 p = strchr(host,':');
725 rsync_port = atoi(p+1);
728 return start_socket_client(host, path, argc-1, argv+1);
732 p = find_colon(argv[0]);
734 if (remote_filesfrom_file
735 && remote_filesfrom_file != files_from + 1
736 && strncmp(files_from, argv[0], p-argv[0]+1) != 0) {
738 "--files-from hostname is not transfer hostname\n");
739 exit_cleanup(RERR_SYNTAX);
741 if (p[1] == ':') { /* double colon */
744 return start_socket_client(argv[0], p+2,
753 exit_cleanup(RERR_SYNTAX);
758 shell_machine = argv[0];
765 /* rsync:// destination uses rsync server over direct socket */
766 if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
769 host = argv[argc-1] + strlen(URL_PREFIX);
770 p = strchr(host,'/');
777 p = strchr(host,':');
779 rsync_port = atoi(p+1);
782 return start_socket_client(host, path, argc-1, argv);
785 p = find_colon(argv[argc-1]);
786 if (p && remote_filesfrom_file
787 && remote_filesfrom_file != files_from + 1
788 && strncmp(files_from, argv[argc-1], p-argv[argc-1]+1) != 0) {
790 "--files-from hostname is not transfer hostname\n");
791 exit_cleanup(RERR_SYNTAX);
795 if (remote_filesfrom_file) {
797 "--files-from is remote but transfer is local\n");
798 exit_cleanup(RERR_SYNTAX);
800 } else if (p[1] == ':') { /* double colon */
803 return start_socket_client(argv[argc-1], p+2,
812 exit_cleanup(RERR_SYNTAX);
816 shell_machine = NULL;
817 shell_path = argv[argc-1];
820 shell_machine = argv[argc-1];
828 shell_path = argv[argc-1];
832 p = strchr(shell_machine,'@');
835 shell_user = shell_machine;
841 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
842 shell_cmd?shell_cmd:"",
843 shell_machine?shell_machine:"",
844 shell_user?shell_user:"",
845 shell_path?shell_path:"");
848 if (!am_sender && argc > 1) {
850 exit_cleanup(RERR_SYNTAX);
853 if (argc == 0 && !am_sender) {
854 extern int list_only;
858 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
861 /* if we're running an rsync server on the remote host over a
862 remote shell command, we need to do the RSYNCD protocol first */
863 if (daemon_over_rsh) {
865 tmpret = start_inband_exchange(shell_user, shell_path,
871 ret = client_run(f_in, f_out, pid, argc, argv);
880 static RETSIGTYPE sigusr1_handler(int UNUSED(val)) {
881 exit_cleanup(RERR_SIGNAL);
884 static RETSIGTYPE sigusr2_handler(int UNUSED(val)) {
885 extern int log_got_error;
886 if (log_got_error) _exit(RERR_PARTIAL);
890 static RETSIGTYPE sigchld_handler(int UNUSED(val)) {
894 /* An empty waitpid() loop was put here by Tridge and we could never
895 * get him to explain why he put it in, so rather than taking it
896 * out we're instead saving the child exit statuses for later use.
897 * The waitpid() loop presumably eliminates all possibility of leaving
898 * zombie children, maybe that's why he did it.
900 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
901 /* save the child's exit status */
902 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
903 if (pid_stat_table[cnt].pid == 0) {
904 pid_stat_table[cnt].pid = pid;
905 pid_stat_table[cnt].status = status;
915 * This routine catches signals and tries to send them to gdb.
917 * Because it's called from inside a signal handler it ought not to
918 * use too many library routines.
920 * @todo Perhaps use "screen -X" instead/as well, to help people
921 * debugging without easy access to X. Perhaps use an environment
922 * variable, or just call a script?
924 * @todo The /proc/ magic probably only works on Linux (and
925 * Solaris?) Can we be more portable?
927 #ifdef MAINTAINER_MODE
928 const char *get_panic_action(void)
930 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
935 return "xterm -display :0 -T Panic -n Panic "
936 "-e gdb /proc/%d/exe %d";
941 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
943 * This signal handler is only installed if we were configured with
944 * --enable-maintainer-mode. Perhaps it should always be on and we
945 * should just look at the environment variable, but I'm a bit leery
946 * of a signal sending us into a busy loop.
948 static RETSIGTYPE rsync_panic_handler(int UNUSED(whatsig))
953 sprintf(cmd_buf, get_panic_action(),
956 /* Unless we failed to execute gdb, we allow the process to
957 * continue. I'm not sure if that's right. */
958 ret = system(cmd_buf);
965 int main(int argc,char *argv[])
968 extern int orig_umask;
971 extern int write_batch;
978 signal(SIGUSR1, sigusr1_handler);
979 signal(SIGUSR2, sigusr2_handler);
980 signal(SIGCHLD, sigchld_handler);
981 #ifdef MAINTAINER_MODE
982 signal(SIGSEGV, rsync_panic_handler);
983 signal(SIGFPE, rsync_panic_handler);
984 signal(SIGABRT, rsync_panic_handler);
985 signal(SIGBUS, rsync_panic_handler);
986 #endif /* def MAINTAINER_MODE */
988 starttime = time(NULL);
989 am_root = (getuid() == 0);
991 memset(&stats, 0, sizeof(stats));
995 exit_cleanup(RERR_SYNTAX);
998 /* we set a 0 umask so that correct file permissions can be
1000 orig_umask = (int)umask(0);
1002 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1003 /* FIXME: We ought to call the same error-handling
1004 * code here, rather than relying on getopt. */
1006 exit_cleanup(RERR_SYNTAX);
1009 signal(SIGINT,SIGNAL_CAST sig_int);
1010 signal(SIGHUP,SIGNAL_CAST sig_int);
1011 signal(SIGTERM,SIGNAL_CAST sig_int);
1013 /* Ignore SIGPIPE; we consistently check error codes and will
1015 signal(SIGPIPE, SIG_IGN);
1017 /* Initialize push_dir here because on some old systems getcwd
1018 (implemented by forking "pwd" and reading its output) doesn't
1019 work when there are other child processes. Also, on all systems
1020 that implement getcwd that way "pwd" can't be found after chroot. */
1023 if (write_batch && !am_server) {
1024 write_batch_argvs_file(orig_argc, orig_argv);
1027 if (am_daemon && !am_server)
1028 return daemon_main();
1032 exit_cleanup(RERR_SYNTAX);
1036 verbose = MAX(verbose,1);
1038 #ifndef SUPPORT_LINKS
1039 if (!am_server && preserve_links) {
1040 rprintf(FERROR,"ERROR: symbolic links not supported\n");
1041 exit_cleanup(RERR_UNSUPPORTED);
1046 set_nonblocking(STDIN_FILENO);
1047 set_nonblocking(STDOUT_FILENO);
1049 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1050 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1053 ret = start_client(argc, argv);
1055 exit_cleanup(RERR_STARTCLIENT);