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;
32 extern int blocking_io;
33 extern int cvs_exclude;
34 extern int delete_mode;
35 extern int delete_excluded;
36 extern int delete_after;
37 extern int daemon_over_rsh;
41 extern int local_server;
42 extern int log_got_error;
44 extern int orig_umask;
45 extern int preserve_hard_links;
46 extern int protocol_version;
48 extern int relative_paths;
49 extern int rsync_port;
50 extern int read_batch;
51 extern int write_batch;
52 extern int filesfrom_fd;
53 extern pid_t cleanup_child_pid;
54 extern char *files_from;
55 extern char *remote_filesfrom_file;
56 extern char *rsync_path;
57 extern char *shell_cmd;
58 extern struct file_list *batch_flist;
60 /* there's probably never more than at most 2 outstanding child processes,
61 * but set it higher just in case.
63 #define MAXCHILDPROCS 5
68 } pid_stat_table[MAXCHILDPROCS];
70 static void show_malloc_stats(void);
72 /****************************************************************************
73 wait for a process to exit, calling io_flush while waiting
74 ****************************************************************************/
75 void wait_process(pid_t pid, int *status)
80 while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
85 if ((waited_pid == -1) && (errno == ECHILD)) {
86 /* status of requested child no longer available.
87 * check to see if it was processed by the sigchld_handler.
89 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
90 if (pid == pid_stat_table[cnt].pid) {
91 *status = pid_stat_table[cnt].status;
92 pid_stat_table[cnt].pid = 0;
98 /* TODO: If the child exited on a signal, then log an
99 * appropriate error message. Perhaps we should also accept a
100 * message describing the purpose of the child. Also indicate
101 * this to the caller so that thhey know something went
103 *status = WEXITSTATUS(*status);
106 static void report(int f)
108 time_t t = time(NULL);
111 if (do_stats && verbose > 1) {
112 /* These come out from every process */
118 log_exit(0, __FILE__, __LINE__);
119 if (f == -1 || !am_sender) return;
122 send_stats = verbose || protocol_version >= 20;
124 if (am_sender && send_stats) {
126 /* store total_written in a temporary
127 * because write_longint changes it */
128 w = stats.total_written;
129 write_longint(f,stats.total_read);
131 write_longint(f,stats.total_size);
136 /* this is the client */
138 if (!am_sender && send_stats) {
140 stats.total_written = read_longint(f);
141 /* store total_read in a temporary, read_longint changes it */
143 stats.total_size = read_longint(f);
144 stats.total_read = r;
148 if (!am_sender && !send_stats) {
149 /* missing the bytes written by the generator */
150 rprintf(FINFO, "\nCannot show stats as receiver because remote protocol version is less than 20\n");
151 rprintf(FINFO, "Use --stats -v to show stats\n");
154 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
155 rprintf(FINFO,"Number of files transferred: %d\n",
156 stats.num_transferred_files);
157 rprintf(FINFO,"Total file size: %.0f bytes\n",
158 (double)stats.total_size);
159 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
160 (double)stats.total_transferred_size);
161 rprintf(FINFO,"Literal data: %.0f bytes\n",
162 (double)stats.literal_data);
163 rprintf(FINFO,"Matched data: %.0f bytes\n",
164 (double)stats.matched_data);
165 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
166 rprintf(FINFO,"Total bytes written: %.0f\n",
167 (double)stats.total_written);
168 rprintf(FINFO,"Total bytes read: %.0f\n",
169 (double)stats.total_read);
172 if (verbose || do_stats) {
173 rprintf(FINFO,"\nwrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
174 (double)stats.total_written,
175 (double)stats.total_read,
176 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
177 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
178 (double)stats.total_size,
179 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
188 * If our C library can get malloc statistics, then show them to FINFO
190 static void show_malloc_stats(void)
197 rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
199 am_server ? "server " : "",
200 am_daemon ? "daemon " : "",
201 am_sender ? "sender" : "receiver");
202 rprintf(FINFO, " arena: %10d (bytes from sbrk)\n", mi.arena);
203 rprintf(FINFO, " ordblks: %10d (chunks not in use)\n", mi.ordblks);
204 rprintf(FINFO, " smblks: %10d\n", mi.smblks);
205 rprintf(FINFO, " hblks: %10d (chunks from mmap)\n", mi.hblks);
206 rprintf(FINFO, " hblkhd: %10d (bytes from mmap)\n", mi.hblkhd);
207 rprintf(FINFO, " usmblks: %10d\n", mi.usmblks);
208 rprintf(FINFO, " fsmblks: %10d\n", mi.fsmblks);
209 rprintf(FINFO, " uordblks: %10d (bytes used)\n", mi.uordblks);
210 rprintf(FINFO, " fordblks: %10d (bytes free)\n", mi.fordblks);
211 rprintf(FINFO, " keepcost: %10d (bytes in releasable chunk)\n", mi.keepcost);
212 #endif /* HAVE_MALLINFO */
216 /* Start the remote shell. cmd may be NULL to use the default. */
217 static pid_t do_cmd(char *cmd,char *machine,char *user,char *path,int *f_in,int *f_out)
225 if (!read_batch && !local_server) {
226 char *rsh_env = getenv(RSYNC_RSH_ENV);
235 for (tok=strtok(cmd," ");tok;tok=strtok(NULL," ")) {
239 /* check to see if we've already been given '-l user' in
240 * the remote-shell command */
241 for (i = 0; i < argc-1; i++) {
242 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
247 /* remsh (on HPUX) takes the arguments the other way around */
248 args[argc++] = machine;
249 if (user && !(daemon_over_rsh && dash_l_set)) {
254 if (user && !(daemon_over_rsh && dash_l_set)) {
258 args[argc++] = machine;
261 args[argc++] = rsync_path;
263 if (blocking_io < 0) {
265 if ((cp = strrchr(cmd, '/')) != NULL)
269 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
273 server_options(args,&argc);
278 if (!daemon_over_rsh && path && *path)
284 rprintf(FINFO,"cmd=");
286 rprintf(FINFO,"%s ",args[i]);
292 create_flist_from_batch(); /* sets batch_flist */
293 ret = local_child(argc, args, f_in, f_out, child_main);
295 ret = piped_child(args,f_in,f_out);
303 out_of_memory("do_cmd");
304 return 0; /* not reached */
310 static char *get_local_name(struct file_list *flist,char *name)
316 rprintf(FINFO,"get_local_name count=%d %s\n",
317 flist->count, NS(name));
322 if (do_stat(name,&st) == 0) {
323 if (S_ISDIR(st.st_mode)) {
324 if (!push_dir(name)) {
325 rprintf(FERROR, "push_dir %s failed: %s (1)\n",
326 full_fname(name), strerror(errno));
327 exit_cleanup(RERR_FILESELECT);
331 if (flist->count > 1) {
332 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
333 exit_cleanup(RERR_FILESELECT);
338 if (flist->count <= 1 && ((e = strlen(name)) <= 1 || name[e-1] != '/'))
341 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
342 rprintf(FERROR, "mkdir %s failed: %s\n",
343 full_fname(name), strerror(errno));
344 exit_cleanup(RERR_FILEIO);
347 rprintf(FINFO,"created directory %s\n",name);
350 if (!push_dir(name)) {
351 rprintf(FERROR, "push_dir %s failed: %s (2)\n",
352 full_fname(name), strerror(errno));
353 exit_cleanup(RERR_FILESELECT);
360 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
363 struct file_list *flist;
367 rprintf(FINFO, "server_sender starting pid=%ld\n",
371 if (!relative_paths && !push_dir(dir)) {
372 rprintf(FERROR, "push_dir %s failed: %s (3)\n",
373 full_fname(dir), strerror(errno));
374 exit_cleanup(RERR_FILESELECT);
379 if (strcmp(dir,".")) {
381 if (strcmp(dir,"/") == 0)
387 if (argc == 0 && recurse) {
393 flist = send_file_list(f_out,argc,argv);
394 if (!flist || flist->count == 0) {
398 io_start_buffering_in(f_in);
399 io_start_buffering_out(f_out);
400 send_files(flist,f_out,f_in);
401 io_flush(FULL_FLUSH);
403 if (protocol_version >= 24) {
404 /* final goodbye message */
407 io_flush(FULL_FLUSH);
412 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
418 if (preserve_hard_links)
419 init_hard_links(flist);
422 /* I moved this here from recv_files() to prevent a race condition */
423 if (recurse && delete_mode && !local_name && flist->count>0) {
428 if (fd_pair(error_pipe) < 0) {
429 rprintf(FERROR,"error pipe failed in do_recv\n");
430 exit_cleanup(RERR_SOCKETIO);
433 io_flush(NORMAL_FLUSH);
435 if ((pid=do_fork()) == 0) {
436 close(error_pipe[0]);
437 if (f_in != f_out) close(f_out);
439 /* we can't let two processes write to the socket at one time */
440 io_multiplexing_close();
442 /* set place to send errors */
443 set_msg_fd_out(error_pipe[1]);
445 recv_files(f_in,flist,local_name);
446 io_flush(FULL_FLUSH);
449 send_msg(MSG_DONE, "", 0);
450 io_flush(FULL_FLUSH);
451 /* finally we go to sleep until our parent kills us
452 * with a USR2 signal. We sleep for a short time as on
453 * some OSes a signal won't interrupt a sleep! */
458 close(error_pipe[1]);
459 if (f_in != f_out) close(f_in);
461 io_start_buffering_out(f_out);
463 set_msg_fd_in(error_pipe[0]);
465 generate_files(f_out, flist, local_name);
467 get_redo_num(); /* Read final MSG_DONE and any prior messages. */
468 io_flush(FULL_FLUSH);
469 if (protocol_version >= 24) {
470 /* send a final goodbye message */
471 write_int(f_out, -1);
473 io_flush(FULL_FLUSH);
477 wait_process(pid, &status);
482 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
485 struct file_list *flist;
486 char *local_name=NULL;
490 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
491 argc, (long)getpid());
494 if (am_daemon && lp_read_only(module_id) && !am_sender) {
495 rprintf(FERROR,"ERROR: module is read only\n");
496 exit_cleanup(RERR_SYNTAX);
505 if (!am_daemon && !push_dir(dir)) {
506 rprintf(FERROR, "push_dir %s failed: %s (4)\n",
507 full_fname(dir), strerror(errno));
508 exit_cleanup(RERR_FILESELECT);
512 io_start_buffering_in(f_in);
513 if (delete_mode && !delete_excluded)
514 recv_exclude_list(f_in);
516 if (filesfrom_fd >= 0) {
517 /* We're receiving the file info from the sender, so we need
518 * the IO routines to automatically write out the names onto
519 * our f_out socket as we read the list info from the sender.
520 * This avoids both deadlock and extra delays/buffers. */
521 io_set_filesfrom_fds(filesfrom_fd, f_out);
528 flist = recv_file_list(f_in);
530 rprintf(FERROR,"server_recv: recv_file_list error\n");
531 exit_cleanup(RERR_FILESELECT);
535 if (strcmp(dir,".")) {
536 argv[0] += strlen(dir);
537 if (argv[0][0] == '/') argv[0]++;
539 local_name = get_local_name(flist,argv[0]);
542 status = do_recv(f_in,f_out,flist,local_name);
543 exit_cleanup(status);
547 int child_main(int argc, char *argv[])
549 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
554 void start_server(int f_in, int f_out, int argc, char *argv[])
556 setup_protocol(f_out, f_in);
558 set_nonblocking(f_in);
559 set_nonblocking(f_out);
561 if (protocol_version >= 23)
562 io_start_multiplex_out(f_out);
566 recv_exclude_list(f_in);
570 do_server_sender(f_in, f_out, argc, argv);
572 do_server_recv(f_in, f_out, argc, argv);
579 * This is called once the connection has been negotiated. It is used
580 * for rsyncd, remote-shell, and local connections.
582 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
584 struct file_list *flist = NULL;
585 int status = 0, status2 = 0;
586 char *local_name = NULL;
588 cleanup_child_pid = pid;
592 set_nonblocking(f_in);
593 set_nonblocking(f_out);
595 setup_protocol(f_out,f_in);
597 if (protocol_version >= 23)
598 io_start_multiplex_in(f_in);
601 io_start_buffering_out(f_out);
604 if (delete_mode && !delete_excluded)
605 send_exclude_list(f_out);
606 if (remote_filesfrom_file)
608 if (!read_batch) /* don't write to pipe */
609 flist = send_file_list(f_out,argc,argv);
611 rprintf(FINFO,"file list sent\n");
613 io_flush(NORMAL_FLUSH);
614 send_files(flist,f_out,f_in);
615 io_flush(FULL_FLUSH);
616 if (protocol_version >= 24) {
617 /* final goodbye message */
622 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
623 io_flush(FULL_FLUSH);
624 wait_process(pid, &status);
627 io_flush(FULL_FLUSH);
628 exit_cleanup(status);
636 send_exclude_list(f_out);
638 if (filesfrom_fd >= 0) {
639 io_set_filesfrom_fds(filesfrom_fd, f_out);
643 flist = recv_file_list(f_in);
644 if (!flist || flist->count == 0) {
645 rprintf(FINFO, "client: nothing to do: "
646 "perhaps you need to specify some filenames or "
647 "the --recursive option?\n");
651 local_name = get_local_name(flist,argv[0]);
653 status2 = do_recv(f_in,f_out,flist,local_name);
657 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
658 io_flush(FULL_FLUSH);
659 wait_process(pid, &status);
662 return MAX(status, status2);
665 static int copy_argv (char *argv[])
669 for (i = 0; argv[i]; i++) {
670 if (!(argv[i] = strdup(argv[i]))) {
671 rprintf (FERROR, "out of memory at %s(%d)\n",
682 * Start a client for either type of remote connection. Work out
683 * whether the arguments request a remote shell or rsyncd connection,
684 * and call the appropriate connection function, then run_client.
686 * Calls either start_socket_client (for sockets) or do_cmd and
687 * client_run (for ssh).
689 static int start_client(int argc, char *argv[])
692 char *shell_machine = NULL;
693 char *shell_path = NULL;
694 char *shell_user = NULL;
700 /* Don't clobber argv[] so that ps(1) can still show the right
702 if ((rc = copy_argv(argv)))
705 /* rsync:// always uses rsync server over direct socket connection */
706 if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0) {
709 host = argv[0] + strlen(URL_PREFIX);
710 p = strchr(host,'/');
717 p = strchr(host,':');
719 rsync_port = atoi(p+1);
722 return start_socket_client(host, path, argc-1, argv+1);
726 p = find_colon(argv[0]);
728 if (remote_filesfrom_file
729 && remote_filesfrom_file != files_from + 1
730 && strncmp(files_from, argv[0], p-argv[0]+1) != 0) {
732 "--files-from hostname is not transfer hostname\n");
733 exit_cleanup(RERR_SYNTAX);
735 if (p[1] == ':') { /* double colon */
738 return start_socket_client(argv[0], p+2,
747 exit_cleanup(RERR_SYNTAX);
752 shell_machine = argv[0];
759 /* rsync:// destination uses rsync server over direct socket */
760 if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
763 host = argv[argc-1] + strlen(URL_PREFIX);
764 p = strchr(host,'/');
771 p = strchr(host,':');
773 rsync_port = atoi(p+1);
776 return start_socket_client(host, path, argc-1, argv);
779 p = find_colon(argv[argc-1]);
780 if (p && remote_filesfrom_file
781 && remote_filesfrom_file != files_from + 1
782 && strncmp(files_from, argv[argc-1], p-argv[argc-1]+1) != 0) {
784 "--files-from hostname is not transfer hostname\n");
785 exit_cleanup(RERR_SYNTAX);
789 if (remote_filesfrom_file) {
791 "--files-from is remote but transfer is local\n");
792 exit_cleanup(RERR_SYNTAX);
794 } else if (p[1] == ':') { /* double colon */
797 return start_socket_client(argv[argc-1], p+2,
806 exit_cleanup(RERR_SYNTAX);
810 shell_machine = NULL;
811 shell_path = argv[argc-1];
814 shell_machine = argv[argc-1];
822 shell_path = argv[argc-1];
826 p = strrchr(shell_machine,'@');
829 shell_user = shell_machine;
835 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
836 shell_cmd?shell_cmd:"",
837 shell_machine?shell_machine:"",
838 shell_user?shell_user:"",
839 shell_path?shell_path:"");
842 if (!am_sender && argc > 1) {
844 exit_cleanup(RERR_SYNTAX);
847 if (argc == 0 && !am_sender) {
851 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
854 /* if we're running an rsync server on the remote host over a
855 * remote shell command, we need to do the RSYNCD protocol first */
856 if (daemon_over_rsh) {
858 tmpret = start_inband_exchange(shell_user, shell_path,
864 ret = client_run(f_in, f_out, pid, argc, argv);
873 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
875 exit_cleanup(RERR_SIGNAL);
878 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
880 if (log_got_error) _exit(RERR_PARTIAL);
884 static RETSIGTYPE sigchld_handler(UNUSED(int val))
889 /* An empty waitpid() loop was put here by Tridge and we could never
890 * get him to explain why he put it in, so rather than taking it
891 * out we're instead saving the child exit statuses for later use.
892 * The waitpid() loop presumably eliminates all possibility of leaving
893 * zombie children, maybe that's why he did it.
895 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
896 /* save the child's exit status */
897 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
898 if (pid_stat_table[cnt].pid == 0) {
899 pid_stat_table[cnt].pid = pid;
900 pid_stat_table[cnt].status = status;
910 * This routine catches signals and tries to send them to gdb.
912 * Because it's called from inside a signal handler it ought not to
913 * use too many library routines.
915 * @todo Perhaps use "screen -X" instead/as well, to help people
916 * debugging without easy access to X. Perhaps use an environment
917 * variable, or just call a script?
919 * @todo The /proc/ magic probably only works on Linux (and
920 * Solaris?) Can we be more portable?
922 #ifdef MAINTAINER_MODE
923 const char *get_panic_action(void)
925 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
930 return "xterm -display :0 -T Panic -n Panic "
931 "-e gdb /proc/%d/exe %d";
936 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
938 * This signal handler is only installed if we were configured with
939 * --enable-maintainer-mode. Perhaps it should always be on and we
940 * should just look at the environment variable, but I'm a bit leery
941 * of a signal sending us into a busy loop.
943 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
948 sprintf(cmd_buf, get_panic_action(),
951 /* Unless we failed to execute gdb, we allow the process to
952 * continue. I'm not sure if that's right. */
953 ret = system(cmd_buf);
960 int main(int argc,char *argv[])
969 signal(SIGUSR1, sigusr1_handler);
970 signal(SIGUSR2, sigusr2_handler);
971 signal(SIGCHLD, sigchld_handler);
972 #ifdef MAINTAINER_MODE
973 signal(SIGSEGV, rsync_panic_handler);
974 signal(SIGFPE, rsync_panic_handler);
975 signal(SIGABRT, rsync_panic_handler);
976 signal(SIGBUS, rsync_panic_handler);
977 #endif /* def MAINTAINER_MODE */
979 starttime = time(NULL);
980 am_root = (getuid() == 0);
982 memset(&stats, 0, sizeof(stats));
986 exit_cleanup(RERR_SYNTAX);
989 /* we set a 0 umask so that correct file permissions can be
991 orig_umask = (int)umask(0);
993 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
994 /* FIXME: We ought to call the same error-handling
995 * code here, rather than relying on getopt. */
997 exit_cleanup(RERR_SYNTAX);
1000 signal(SIGINT,SIGNAL_CAST sig_int);
1001 signal(SIGHUP,SIGNAL_CAST sig_int);
1002 signal(SIGTERM,SIGNAL_CAST sig_int);
1004 /* Ignore SIGPIPE; we consistently check error codes and will
1006 signal(SIGPIPE, SIG_IGN);
1008 /* Initialize push_dir here because on some old systems getcwd
1009 * (implemented by forking "pwd" and reading its output) doesn't
1010 * work when there are other child processes. Also, on all systems
1011 * that implement getcwd that way "pwd" can't be found after chroot. */
1014 if (write_batch && !am_server) {
1015 write_batch_argvs_file(orig_argc, orig_argv);
1018 if (am_daemon && !am_server)
1019 return daemon_main();
1023 exit_cleanup(RERR_SYNTAX);
1027 verbose = MAX(verbose,1);
1029 #ifndef SUPPORT_LINKS
1030 if (!am_server && preserve_links) {
1031 rprintf(FERROR,"ERROR: symbolic links not supported\n");
1032 exit_cleanup(RERR_UNSUPPORTED);
1037 set_nonblocking(STDIN_FILENO);
1038 set_nonblocking(STDOUT_FILENO);
1040 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1041 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1044 ret = start_client(argc, argv);
1046 exit_cleanup(RERR_STARTCLIENT);