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;
29 /* there's probably never more than at most 2 outstanding child processes,
30 * but set it higher just in case.
32 #define MAXCHILDPROCS 5
37 } pid_stat_table[MAXCHILDPROCS];
39 static void show_malloc_stats(void);
41 /****************************************************************************
42 wait for a process to exit, calling io_flush while waiting
43 ****************************************************************************/
44 void wait_process(pid_t pid, int *status)
49 while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
54 if ((waited_pid == -1) && (errno == ECHILD)) {
55 /* status of requested child no longer available.
56 * check to see if it was processed by the sigchld_handler.
58 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
59 if (pid == pid_stat_table[cnt].pid) {
60 *status = pid_stat_table[cnt].status;
61 pid_stat_table[cnt].pid = 0;
67 /* TODO: If the child exited on a signal, then log an
68 * appropriate error message. Perhaps we should also accept a
69 * message describing the purpose of the child. Also indicate
70 * this to the caller so that thhey know something went
72 *status = WEXITSTATUS(*status);
75 static void report(int f)
77 time_t t = time(NULL);
82 extern int remote_version;
86 /* These come out from every process */
92 log_exit(0, __FILE__, __LINE__);
93 if (f == -1 || !am_sender) return;
96 send_stats = verbose || (remote_version >= 20);
98 if (am_sender && send_stats) {
100 /* store total_written in a temporary
101 because write_longint changes it */
102 w = stats.total_written;
103 write_longint(f,stats.total_read);
105 write_longint(f,stats.total_size);
110 /* this is the client */
112 if (!am_sender && send_stats) {
114 stats.total_written = read_longint(f);
115 /* store total_read in a temporary, read_longint changes it */
117 stats.total_size = read_longint(f);
118 stats.total_read = r;
122 if (!am_sender && !send_stats) {
123 /* missing the bytes written by the generator */
124 rprintf(FINFO, "\nCannot show stats as receiver because remote protocol version is less than 20\n");
125 rprintf(FINFO, "Use --stats -v to show stats\n");
128 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
129 rprintf(FINFO,"Number of files transferred: %d\n",
130 stats.num_transferred_files);
131 rprintf(FINFO,"Total file size: %.0f bytes\n",
132 (double)stats.total_size);
133 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
134 (double)stats.total_transferred_size);
135 rprintf(FINFO,"Literal data: %.0f bytes\n",
136 (double)stats.literal_data);
137 rprintf(FINFO,"Matched data: %.0f bytes\n",
138 (double)stats.matched_data);
139 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
140 rprintf(FINFO,"Total bytes written: %.0f\n",
141 (double)stats.total_written);
142 rprintf(FINFO,"Total bytes read: %.0f\n\n",
143 (double)stats.total_read);
146 if (verbose || do_stats) {
147 rprintf(FINFO,"wrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
148 (double)stats.total_written,
149 (double)stats.total_read,
150 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
151 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
152 (double)stats.total_size,
153 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
162 * If our C library can get malloc statistics, then show them to FINFO
164 static void show_malloc_stats(void)
168 extern int am_server;
169 extern int am_sender;
170 extern int am_daemon;
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) && (strcmp(cmd, RSYNC_RSH) == 0))
247 server_options(args,&argc);
253 if (!daemon_over_rsh && path && *path)
259 rprintf(FINFO,"cmd=");
261 rprintf(FINFO,"%s ",args[i]);
267 create_flist_from_batch(); /* sets batch_flist */
268 ret = local_child(argc, args, f_in, f_out, child_main);
270 ret = piped_child(args,f_in,f_out);
278 out_of_memory("do_cmd");
279 return 0; /* not reached */
285 static char *get_local_name(struct file_list *flist,char *name)
288 extern int orig_umask;
291 rprintf(FINFO,"get_local_name count=%d %s\n",
292 flist->count, NS(name));
297 if (do_stat(name,&st) == 0) {
298 if (S_ISDIR(st.st_mode)) {
299 if (!push_dir(name, 0)) {
300 rprintf(FERROR,"push_dir %s : %s (1)\n",
301 name,strerror(errno));
302 exit_cleanup(RERR_FILESELECT);
306 if (flist->count > 1) {
307 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
308 exit_cleanup(RERR_FILESELECT);
313 if (flist->count <= 1)
316 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
317 rprintf(FERROR, RSYNC_NAME ": mkdir %s: %s\n",
318 name, strerror(errno));
319 exit_cleanup(RERR_FILEIO);
322 rprintf(FINFO,"created directory %s\n",name);
325 if (!push_dir(name, 0)) {
326 rprintf(FERROR, RSYNC_NAME ": push_dir %s: %s\n",
327 name, strerror(errno));
328 exit_cleanup(RERR_FILESELECT);
337 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
340 struct file_list *flist;
342 extern int relative_paths;
344 extern int remote_version;
347 rprintf(FINFO,"server_sender starting pid=%d\n",(int)getpid());
349 if (!relative_paths && !push_dir(dir, 0)) {
350 rprintf(FERROR,"push_dir %s: %s (3)\n",dir,strerror(errno));
351 exit_cleanup(RERR_FILESELECT);
356 if (strcmp(dir,".")) {
358 if (strcmp(dir,"/") == 0)
364 if (argc == 0 && recurse) {
370 flist = send_file_list(f_out,argc,argv);
371 if (!flist || flist->count == 0) {
375 send_files(flist,f_out,f_in);
378 if (remote_version >= 24) {
379 /* final goodbye message */
387 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
393 extern int preserve_hard_links;
394 extern int delete_after;
396 extern int delete_mode;
397 extern int remote_version;
399 if (preserve_hard_links)
400 init_hard_links(flist);
403 /* I moved this here from recv_files() to prevent a race condition */
404 if (recurse && delete_mode && !local_name && flist->count>0) {
409 if (fd_pair(recv_pipe) < 0) {
410 rprintf(FERROR,"pipe failed in do_recv\n");
411 exit_cleanup(RERR_SOCKETIO);
414 if (fd_pair(error_pipe) < 0) {
415 rprintf(FERROR,"error pipe failed in do_recv\n");
416 exit_cleanup(RERR_SOCKETIO);
421 if ((pid=do_fork()) == 0) {
423 close(error_pipe[0]);
424 if (f_in != f_out) close(f_out);
426 /* we can't let two processes write to the socket at one time */
427 io_multiplexing_close();
429 /* set place to send errors */
430 set_error_fd(error_pipe[1]);
432 recv_files(f_in,flist,local_name,recv_pipe[1]);
436 write_int(recv_pipe[1],1);
439 /* finally we go to sleep until our parent kills us
440 with a USR2 signal. We sleep for a short time as on
441 some OSes a signal won't interrupt a sleep! */
447 close(error_pipe[1]);
448 if (f_in != f_out) close(f_in);
450 io_start_buffering(f_out);
452 io_set_error_fd(error_pipe[0]);
454 generate_files(f_out,flist,local_name,recv_pipe[0]);
456 read_int(recv_pipe[0]);
458 if (remote_version >= 24) {
459 /* send a final goodbye message */
460 write_int(f_out, -1);
466 wait_process(pid, &status);
471 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
474 struct file_list *flist;
475 char *local_name=NULL;
477 extern int delete_mode;
478 extern int delete_excluded;
479 extern int am_daemon;
480 extern int module_id;
481 extern int am_sender;
482 extern int read_batch;
483 extern struct file_list *batch_flist;
486 rprintf(FINFO,"server_recv(%d) starting pid=%d\n",argc,(int)getpid());
488 if (am_daemon && lp_read_only(module_id) && !am_sender) {
489 rprintf(FERROR,"ERROR: module is read only\n");
490 exit_cleanup(RERR_SYNTAX);
499 if (!am_daemon && !push_dir(dir, 0)) {
500 rprintf(FERROR,"push_dir %s : %s (4)\n",
501 dir,strerror(errno));
502 exit_cleanup(RERR_FILESELECT);
506 if (delete_mode && !delete_excluded)
507 recv_exclude_list(f_in);
512 flist = recv_file_list(f_in);
514 rprintf(FERROR,"server_recv: recv_file_list error\n");
515 exit_cleanup(RERR_FILESELECT);
519 if (strcmp(dir,".")) {
520 argv[0] += strlen(dir);
521 if (argv[0][0] == '/') argv[0]++;
523 local_name = get_local_name(flist,argv[0]);
526 status = do_recv(f_in,f_out,flist,local_name);
527 exit_cleanup(status);
531 int child_main(int argc, char *argv[])
533 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
538 void start_server(int f_in, int f_out, int argc, char *argv[])
540 extern int cvs_exclude;
541 extern int am_sender;
542 extern int remote_version;
543 extern int read_batch;
545 setup_protocol(f_out, f_in);
547 set_nonblocking(f_in);
548 set_nonblocking(f_out);
550 if (remote_version >= 23)
551 io_start_multiplex_out(f_out);
555 recv_exclude_list(f_in);
559 do_server_sender(f_in, f_out, argc, argv);
561 do_server_recv(f_in, f_out, argc, argv);
568 * This is called once the connection has been negotiated. It is used
569 * for rsyncd, remote-shell, and local connections.
571 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
573 struct file_list *flist = NULL;
574 int status = 0, status2 = 0;
575 char *local_name = NULL;
576 extern int am_sender;
577 extern int remote_version;
578 extern pid_t cleanup_child_pid;
579 extern int write_batch;
580 extern int read_batch;
581 extern struct file_list *batch_flist;
583 cleanup_child_pid = pid;
587 set_nonblocking(f_in);
588 set_nonblocking(f_out);
590 setup_protocol(f_out,f_in);
592 if (remote_version >= 23)
593 io_start_multiplex_in(f_in);
596 extern int cvs_exclude;
597 extern int delete_mode;
598 extern int delete_excluded;
601 if (delete_mode && !delete_excluded)
602 send_exclude_list(f_out);
603 if (!read_batch) /* dw -- don't write to pipe */
604 flist = send_file_list(f_out,argc,argv);
606 rprintf(FINFO,"file list sent\n");
608 send_files(flist,f_out,f_in);
609 if (remote_version >= 24) {
610 /* final goodbye message */
615 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
617 wait_process(pid, &status);
620 exit_cleanup(status);
624 extern int list_only;
629 send_exclude_list(f_out);
631 flist = recv_file_list(f_in);
632 if (!flist || flist->count == 0) {
633 rprintf(FINFO, "client: nothing to do: "
634 "perhaps you need to specify some filenames or "
635 "the --recursive option?\n");
639 local_name = get_local_name(flist,argv[0]);
641 status2 = do_recv(f_in,f_out,flist,local_name);
645 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
647 wait_process(pid, &status);
650 return MAX(status, status2);
653 static char *find_colon(char *s)
660 /* now check to see if there is a / in the string before the : - if there is then
661 discard the colon on the assumption that the : is part of a filename */
663 if (p2 && p2 < p) return NULL;
669 static int copy_argv (char *argv[])
673 for (i = 0; argv[i]; i++) {
674 if (!(argv[i] = strdup(argv[i]))) {
675 rprintf (FERROR, "out of memory at %s(%d)\n",
686 * Start a client for either type of remote connection. Work out
687 * whether the arguments request a remote shell or rsyncd connection,
688 * and call the appropriate connection function, then run_client.
690 * Calls either start_socket_client (for sockets) or do_cmd and
691 * client_run (for ssh).
693 static int start_client(int argc, char *argv[])
696 char *shell_machine = NULL;
697 char *shell_path = NULL;
698 char *shell_user = NULL;
702 extern int local_server;
703 extern int am_sender;
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]);
739 if (p[1] == ':') { /* double colon */
742 return start_socket_client(argv[0], p+2,
751 exit_cleanup(RERR_SYNTAX);
756 shell_machine = argv[0];
763 /* rsync:// destination uses rsync server over direct socket */
764 if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
767 host = argv[argc-1] + strlen(URL_PREFIX);
768 p = strchr(host,'/');
775 p = strchr(host,':');
777 rsync_port = atoi(p+1);
780 return start_socket_client(host, path, argc-1, argv);
783 p = find_colon(argv[argc-1]);
786 } else if (p[1] == ':') { /* double colon */
789 return start_socket_client(argv[argc-1], p+2,
798 exit_cleanup(RERR_SYNTAX);
802 shell_machine = NULL;
803 shell_path = argv[argc-1];
806 shell_machine = argv[argc-1];
814 shell_path = argv[argc-1];
818 p = strchr(shell_machine,'@');
821 shell_user = shell_machine;
827 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
828 shell_cmd?shell_cmd:"",
829 shell_machine?shell_machine:"",
830 shell_user?shell_user:"",
831 shell_path?shell_path:"");
834 if (!am_sender && argc > 1) {
836 exit_cleanup(RERR_SYNTAX);
839 if (argc == 0 && !am_sender) {
840 extern int list_only;
844 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
847 /* if we're running an rsync server on the remote host over a
848 remote shell command, we need to do the RSYNCD protocol first */
849 if (daemon_over_rsh) {
851 tmpret = start_inband_exchange(shell_user, shell_path,
857 ret = client_run(f_in, f_out, pid, argc, argv);
866 static RETSIGTYPE sigusr1_handler(int UNUSED(val)) {
867 exit_cleanup(RERR_SIGNAL);
870 static RETSIGTYPE sigusr2_handler(int UNUSED(val)) {
871 extern int log_got_error;
872 if (log_got_error) _exit(RERR_PARTIAL);
876 static RETSIGTYPE sigchld_handler(int UNUSED(val)) {
880 /* An empty waitpid() loop was put here by Tridge and we could never
881 * get him to explain why he put it in, so rather than taking it
882 * out we're instead saving the child exit statuses for later use.
883 * The waitpid() loop presumably eliminates all possibility of leaving
884 * zombie children, maybe that's why he did it.
886 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
887 /* save the child's exit status */
888 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
889 if (pid_stat_table[cnt].pid == 0) {
890 pid_stat_table[cnt].pid = pid;
891 pid_stat_table[cnt].status = status;
901 * This routine catches signals and tries to send them to gdb.
903 * Because it's called from inside a signal handler it ought not to
904 * use too many library routines.
906 * @todo Perhaps use "screen -X" instead/as well, to help people
907 * debugging without easy access to X. Perhaps use an environment
908 * variable, or just call a script?
910 * @todo The /proc/ magic probably only works on Linux (and
911 * Solaris?) Can we be more portable?
913 #ifdef MAINTAINER_MODE
914 const char *get_panic_action(void)
916 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
921 return "xterm -display :0 -T Panic -n Panic "
922 "-e gdb /proc/%d/exe %d";
927 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
929 * This signal handler is only installed if we were configured with
930 * --enable-maintainer-mode. Perhaps it should always be on and we
931 * should just look at the environment variable, but I'm a bit leery
932 * of a signal sending us into a busy loop.
934 static RETSIGTYPE rsync_panic_handler(int UNUSED(whatsig))
939 sprintf(cmd_buf, get_panic_action(),
942 /* Unless we failed to execute gdb, we allow the process to
943 * continue. I'm not sure if that's right. */
944 ret = system(cmd_buf);
951 int main(int argc,char *argv[])
954 extern int orig_umask;
956 extern int am_daemon;
957 extern int am_server;
959 extern int write_batch;
966 signal(SIGUSR1, sigusr1_handler);
967 signal(SIGUSR2, sigusr2_handler);
968 signal(SIGCHLD, sigchld_handler);
969 #ifdef MAINTAINER_MODE
970 signal(SIGSEGV, rsync_panic_handler);
971 signal(SIGFPE, rsync_panic_handler);
972 signal(SIGABRT, rsync_panic_handler);
973 signal(SIGBUS, rsync_panic_handler);
974 #endif /* def MAINTAINER_MODE */
976 starttime = time(NULL);
977 am_root = (getuid() == 0);
979 memset(&stats, 0, sizeof(stats));
983 exit_cleanup(RERR_SYNTAX);
986 /* we set a 0 umask so that correct file permissions can be
988 orig_umask = (int)umask(0);
990 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
991 /* FIXME: We ought to call the same error-handling
992 * code here, rather than relying on getopt. */
994 exit_cleanup(RERR_SYNTAX);
997 signal(SIGINT,SIGNAL_CAST sig_int);
998 signal(SIGHUP,SIGNAL_CAST sig_int);
999 signal(SIGTERM,SIGNAL_CAST sig_int);
1001 /* Ignore SIGPIPE; we consistently check error codes and will
1003 signal(SIGPIPE, SIG_IGN);
1005 /* Initialize push_dir here because on some old systems getcwd
1006 (implemented by forking "pwd" and reading its output) doesn't
1007 work when there are other child processes. Also, on all systems
1008 that implement getcwd that way "pwd" can't be found after chroot. */
1011 if (write_batch && !am_server) {
1012 write_batch_argvs_file(orig_argc, orig_argv);
1015 if (am_daemon && !am_server)
1016 return daemon_main();
1020 exit_cleanup(RERR_SYNTAX);
1024 verbose = MAX(verbose,1);
1026 #ifndef SUPPORT_LINKS
1027 if (!am_server && preserve_links) {
1028 rprintf(FERROR,"ERROR: symbolic links not supported\n");
1029 exit_cleanup(RERR_UNSUPPORTED);
1034 set_nonblocking(STDIN_FILENO);
1035 set_nonblocking(STDOUT_FILENO);
1037 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1038 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1041 ret = start_client(argc, argv);
1043 exit_cleanup(RERR_STARTCLIENT);