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;
30 extern int am_generator;
33 extern int blocking_io;
34 extern int cvs_exclude;
35 extern int delete_mode;
36 extern int delete_excluded;
37 extern int delete_after;
38 extern int daemon_over_rsh;
42 extern int local_server;
43 extern int log_got_error;
45 extern int orig_umask;
46 extern int preserve_hard_links;
47 extern int protocol_version;
49 extern int relative_paths;
50 extern int rsync_port;
51 extern int read_batch;
52 extern int write_batch;
53 extern int filesfrom_fd;
54 extern pid_t cleanup_child_pid;
55 extern char *files_from;
56 extern char *remote_filesfrom_file;
57 extern char *rsync_path;
58 extern char *shell_cmd;
59 extern struct file_list *batch_flist;
62 /* there's probably never more than at most 2 outstanding child processes,
63 * but set it higher just in case.
65 #define MAXCHILDPROCS 5
70 } pid_stat_table[MAXCHILDPROCS];
72 static void show_malloc_stats(void);
74 /****************************************************************************
75 wait for a process to exit, calling io_flush while waiting
76 ****************************************************************************/
77 void wait_process(pid_t pid, int *status)
82 while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
87 if ((waited_pid == -1) && (errno == ECHILD)) {
88 /* status of requested child no longer available.
89 * check to see if it was processed by the sigchld_handler.
91 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
92 if (pid == pid_stat_table[cnt].pid) {
93 *status = pid_stat_table[cnt].status;
94 pid_stat_table[cnt].pid = 0;
100 /* TODO: If the child exited on a signal, then log an
101 * appropriate error message. Perhaps we should also accept a
102 * message describing the purpose of the child. Also indicate
103 * this to the caller so that thhey know something went
105 *status = WEXITSTATUS(*status);
108 static void report(int f)
110 time_t t = time(NULL);
113 if (do_stats && verbose > 1) {
114 /* These come out from every process */
123 log_exit(0, __FILE__, __LINE__);
124 if (f == -1 || !am_sender) return;
127 send_stats = verbose || protocol_version >= 20;
129 if (am_sender && send_stats) {
131 /* store total_written in a temporary
132 * because write_longint changes it */
133 w = stats.total_written;
134 write_longint(f,stats.total_read);
136 write_longint(f,stats.total_size);
141 /* this is the client */
143 if (!am_sender && send_stats) {
145 stats.total_written = read_longint(f);
146 /* store total_read in a temporary, read_longint changes it */
148 stats.total_size = read_longint(f);
149 stats.total_read = r;
153 if (!am_sender && !send_stats) {
154 /* missing the bytes written by the generator */
155 rprintf(FINFO, "\nCannot show stats as receiver because remote protocol version is less than 20\n");
156 rprintf(FINFO, "Use --stats -v to show stats\n");
159 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
160 rprintf(FINFO,"Number of files transferred: %d\n",
161 stats.num_transferred_files);
162 rprintf(FINFO,"Total file size: %.0f bytes\n",
163 (double)stats.total_size);
164 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
165 (double)stats.total_transferred_size);
166 rprintf(FINFO,"Literal data: %.0f bytes\n",
167 (double)stats.literal_data);
168 rprintf(FINFO,"Matched data: %.0f bytes\n",
169 (double)stats.matched_data);
170 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
171 rprintf(FINFO,"Total bytes written: %.0f\n",
172 (double)stats.total_written);
173 rprintf(FINFO,"Total bytes read: %.0f\n",
174 (double)stats.total_read);
177 if (verbose || do_stats) {
178 rprintf(FINFO,"\nwrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
179 (double)stats.total_written,
180 (double)stats.total_read,
181 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
182 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
183 (double)stats.total_size,
184 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
193 * If our C library can get malloc statistics, then show them to FINFO
195 static void show_malloc_stats(void)
202 rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
204 am_server ? "server " : "",
205 am_daemon ? "daemon " : "",
207 rprintf(FINFO, " arena: %10d (bytes from sbrk)\n", mi.arena);
208 rprintf(FINFO, " ordblks: %10d (chunks not in use)\n", mi.ordblks);
209 rprintf(FINFO, " smblks: %10d\n", mi.smblks);
210 rprintf(FINFO, " hblks: %10d (chunks from mmap)\n", mi.hblks);
211 rprintf(FINFO, " hblkhd: %10d (bytes from mmap)\n", mi.hblkhd);
212 rprintf(FINFO, " usmblks: %10d\n", mi.usmblks);
213 rprintf(FINFO, " fsmblks: %10d\n", mi.fsmblks);
214 rprintf(FINFO, " uordblks: %10d (bytes used)\n", mi.uordblks);
215 rprintf(FINFO, " fordblks: %10d (bytes free)\n", mi.fordblks);
216 rprintf(FINFO, " keepcost: %10d (bytes in releasable chunk)\n", mi.keepcost);
217 #endif /* HAVE_MALLINFO */
221 /* Start the remote shell. cmd may be NULL to use the default. */
222 static pid_t do_cmd(char *cmd,char *machine,char *user,char *path,int *f_in,int *f_out)
230 if (!read_batch && !local_server) {
231 char *rsh_env = getenv(RSYNC_RSH_ENV);
240 for (tok=strtok(cmd," ");tok;tok=strtok(NULL," ")) {
244 /* check to see if we've already been given '-l user' in
245 * the remote-shell command */
246 for (i = 0; i < argc-1; i++) {
247 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
252 /* remsh (on HPUX) takes the arguments the other way around */
253 args[argc++] = machine;
254 if (user && !(daemon_over_rsh && dash_l_set)) {
259 if (user && !(daemon_over_rsh && dash_l_set)) {
263 args[argc++] = machine;
266 args[argc++] = rsync_path;
268 if (blocking_io < 0) {
270 if ((cp = strrchr(cmd, '/')) != NULL)
274 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
278 server_options(args,&argc);
283 if (!daemon_over_rsh && path && *path)
289 rprintf(FINFO,"cmd=");
291 rprintf(FINFO,"%s ",args[i]);
297 create_flist_from_batch(); /* sets batch_flist */
298 ret = local_child(argc, args, f_in, f_out, child_main);
300 ret = piped_child(args,f_in,f_out);
308 out_of_memory("do_cmd");
309 return 0; /* not reached */
313 static char *get_local_name(struct file_list *flist,char *name)
319 rprintf(FINFO,"get_local_name count=%d %s\n",
320 flist->count, NS(name));
325 if (do_stat(name,&st) == 0) {
326 if (S_ISDIR(st.st_mode)) {
327 if (!push_dir(name)) {
328 rprintf(FERROR, "push_dir %s failed: %s (1)\n",
329 full_fname(name), strerror(errno));
330 exit_cleanup(RERR_FILESELECT);
334 if (flist->count > 1) {
335 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
336 exit_cleanup(RERR_FILESELECT);
341 if (flist->count <= 1 && ((e = strlen(name)) <= 1 || name[e-1] != '/'))
344 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
345 rprintf(FERROR, "mkdir %s failed: %s\n",
346 full_fname(name), strerror(errno));
347 exit_cleanup(RERR_FILEIO);
350 rprintf(FINFO,"created directory %s\n",name);
353 if (!push_dir(name)) {
354 rprintf(FERROR, "push_dir %s failed: %s (2)\n",
355 full_fname(name), strerror(errno));
356 exit_cleanup(RERR_FILESELECT);
363 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
366 struct file_list *flist;
370 rprintf(FINFO, "server_sender starting pid=%ld\n",
374 if (!relative_paths && !push_dir(dir)) {
375 rprintf(FERROR, "push_dir %s failed: %s (3)\n",
376 full_fname(dir), strerror(errno));
377 exit_cleanup(RERR_FILESELECT);
382 if (strcmp(dir,".")) {
384 if (strcmp(dir,"/") == 0)
390 if (argc == 0 && recurse) {
396 flist = send_file_list(f_out,argc,argv);
397 if (!flist || flist->count == 0) {
401 io_start_buffering_in(f_in);
402 io_start_buffering_out(f_out);
403 send_files(flist,f_out,f_in);
404 io_flush(FULL_FLUSH);
406 if (protocol_version >= 24) {
407 /* final goodbye message */
410 io_flush(FULL_FLUSH);
415 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
421 if (preserve_hard_links)
422 init_hard_links(flist);
425 /* I moved this here from recv_files() to prevent a race condition */
426 if (recurse && delete_mode && !local_name && flist->count>0) {
431 if (fd_pair(error_pipe) < 0) {
432 rprintf(FERROR,"error pipe failed in do_recv\n");
433 exit_cleanup(RERR_SOCKETIO);
436 io_flush(NORMAL_FLUSH);
438 if ((pid=do_fork()) == 0) {
439 close(error_pipe[0]);
440 if (f_in != f_out) close(f_out);
442 /* we can't let two processes write to the socket at one time */
443 io_multiplexing_close();
445 /* set place to send errors */
446 set_msg_fd_out(error_pipe[1]);
448 recv_files(f_in,flist,local_name);
449 io_flush(FULL_FLUSH);
452 send_msg(MSG_DONE, "", 0);
453 io_flush(FULL_FLUSH);
454 /* finally we go to sleep until our parent kills us
455 * with a USR2 signal. We sleep for a short time as on
456 * some OSes a signal won't interrupt a sleep! */
463 close(error_pipe[1]);
464 if (f_in != f_out) close(f_in);
466 io_start_buffering_out(f_out);
468 set_msg_fd_in(error_pipe[0]);
470 generate_files(f_out, flist, local_name);
472 get_redo_num(); /* Read final MSG_DONE and any prior messages. */
474 io_flush(FULL_FLUSH);
475 if (protocol_version >= 24) {
476 /* send a final goodbye message */
477 write_int(f_out, -1);
479 io_flush(FULL_FLUSH);
483 wait_process(pid, &status);
488 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
491 struct file_list *flist;
492 char *local_name=NULL;
496 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
497 argc, (long)getpid());
500 if (am_daemon && lp_read_only(module_id) && !am_sender) {
501 rprintf(FERROR,"ERROR: module is read only\n");
502 exit_cleanup(RERR_SYNTAX);
511 if (!am_daemon && !push_dir(dir)) {
512 rprintf(FERROR, "push_dir %s failed: %s (4)\n",
513 full_fname(dir), strerror(errno));
514 exit_cleanup(RERR_FILESELECT);
518 io_start_buffering_in(f_in);
519 if (delete_mode && !delete_excluded)
520 recv_exclude_list(f_in);
522 if (filesfrom_fd >= 0) {
523 /* We're receiving the file info from the sender, so we need
524 * the IO routines to automatically write out the names onto
525 * our f_out socket as we read the list info from the sender.
526 * This avoids both deadlock and extra delays/buffers. */
527 io_set_filesfrom_fds(filesfrom_fd, f_out);
534 flist = recv_file_list(f_in);
536 rprintf(FERROR,"server_recv: recv_file_list error\n");
537 exit_cleanup(RERR_FILESELECT);
541 if (strcmp(dir,".")) {
542 argv[0] += strlen(dir);
543 if (argv[0][0] == '/') argv[0]++;
545 local_name = get_local_name(flist,argv[0]);
548 status = do_recv(f_in,f_out,flist,local_name);
549 exit_cleanup(status);
553 int child_main(int argc, char *argv[])
555 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
560 void start_server(int f_in, int f_out, int argc, char *argv[])
562 setup_protocol(f_out, f_in);
564 set_nonblocking(f_in);
565 set_nonblocking(f_out);
567 if (protocol_version >= 23)
568 io_start_multiplex_out(f_out);
572 recv_exclude_list(f_in);
576 do_server_sender(f_in, f_out, argc, argv);
578 do_server_recv(f_in, f_out, argc, argv);
585 * This is called once the connection has been negotiated. It is used
586 * for rsyncd, remote-shell, and local connections.
588 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
590 struct file_list *flist = NULL;
591 int status = 0, status2 = 0;
592 char *local_name = NULL;
594 cleanup_child_pid = pid;
598 set_nonblocking(f_in);
599 set_nonblocking(f_out);
601 setup_protocol(f_out,f_in);
603 if (protocol_version >= 23)
604 io_start_multiplex_in(f_in);
607 io_start_buffering_out(f_out);
610 if (delete_mode && !delete_excluded)
611 send_exclude_list(f_out);
612 if (remote_filesfrom_file)
614 if (!read_batch) /* don't write to pipe */
615 flist = send_file_list(f_out,argc,argv);
617 rprintf(FINFO,"file list sent\n");
619 io_flush(NORMAL_FLUSH);
620 send_files(flist,f_out,f_in);
621 io_flush(FULL_FLUSH);
622 if (protocol_version >= 24) {
623 /* final goodbye message */
628 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
629 io_flush(FULL_FLUSH);
630 wait_process(pid, &status);
633 io_flush(FULL_FLUSH);
634 exit_cleanup(status);
642 send_exclude_list(f_out);
644 if (filesfrom_fd >= 0) {
645 io_set_filesfrom_fds(filesfrom_fd, f_out);
649 flist = recv_file_list(f_in);
650 if (!flist || flist->count == 0) {
651 rprintf(FINFO, "client: nothing to do: "
652 "perhaps you need to specify some filenames or "
653 "the --recursive option?\n");
657 local_name = get_local_name(flist,argv[0]);
659 status2 = do_recv(f_in,f_out,flist,local_name);
663 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
664 io_flush(FULL_FLUSH);
665 wait_process(pid, &status);
668 return MAX(status, status2);
671 static int copy_argv (char *argv[])
675 for (i = 0; argv[i]; i++) {
676 if (!(argv[i] = strdup(argv[i]))) {
677 rprintf (FERROR, "out of memory at %s(%d)\n",
688 * Start a client for either type of remote connection. Work out
689 * whether the arguments request a remote shell or rsyncd connection,
690 * and call the appropriate connection function, then run_client.
692 * Calls either start_socket_client (for sockets) or do_cmd and
693 * client_run (for ssh).
695 static int start_client(int argc, char *argv[])
698 char *shell_machine = NULL;
699 char *shell_path = NULL;
700 char *shell_user = NULL;
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 = strrchr(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) {
857 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
860 /* if we're running an rsync server on the remote host over a
861 * remote shell command, we need to do the RSYNCD protocol first */
862 if (daemon_over_rsh) {
864 tmpret = start_inband_exchange(shell_user, shell_path,
870 ret = client_run(f_in, f_out, pid, argc, argv);
879 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
881 exit_cleanup(RERR_SIGNAL);
884 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
886 if (log_got_error) _exit(RERR_PARTIAL);
890 static RETSIGTYPE sigchld_handler(UNUSED(int val))
895 /* An empty waitpid() loop was put here by Tridge and we could never
896 * get him to explain why he put it in, so rather than taking it
897 * out we're instead saving the child exit statuses for later use.
898 * The waitpid() loop presumably eliminates all possibility of leaving
899 * zombie children, maybe that's why he did it.
901 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
902 /* save the child's exit status */
903 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
904 if (pid_stat_table[cnt].pid == 0) {
905 pid_stat_table[cnt].pid = pid;
906 pid_stat_table[cnt].status = status;
916 * This routine catches signals and tries to send them to gdb.
918 * Because it's called from inside a signal handler it ought not to
919 * use too many library routines.
921 * @todo Perhaps use "screen -X" instead/as well, to help people
922 * debugging without easy access to X. Perhaps use an environment
923 * variable, or just call a script?
925 * @todo The /proc/ magic probably only works on Linux (and
926 * Solaris?) Can we be more portable?
928 #ifdef MAINTAINER_MODE
929 const char *get_panic_action(void)
931 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
936 return "xterm -display :0 -T Panic -n Panic "
937 "-e gdb /proc/%d/exe %d";
942 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
944 * This signal handler is only installed if we were configured with
945 * --enable-maintainer-mode. Perhaps it should always be on and we
946 * should just look at the environment variable, but I'm a bit leery
947 * of a signal sending us into a busy loop.
949 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
954 sprintf(cmd_buf, get_panic_action(),
957 /* Unless we failed to execute gdb, we allow the process to
958 * continue. I'm not sure if that's right. */
959 ret = system(cmd_buf);
966 int main(int argc,char *argv[])
975 signal(SIGUSR1, sigusr1_handler);
976 signal(SIGUSR2, sigusr2_handler);
977 signal(SIGCHLD, sigchld_handler);
978 #ifdef MAINTAINER_MODE
979 signal(SIGSEGV, rsync_panic_handler);
980 signal(SIGFPE, rsync_panic_handler);
981 signal(SIGABRT, rsync_panic_handler);
982 signal(SIGBUS, rsync_panic_handler);
983 #endif /* def MAINTAINER_MODE */
985 starttime = time(NULL);
986 am_root = (MY_UID() == 0);
988 memset(&stats, 0, sizeof(stats));
992 exit_cleanup(RERR_SYNTAX);
995 /* we set a 0 umask so that correct file permissions can be
997 orig_umask = (int)umask(0);
999 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1000 /* FIXME: We ought to call the same error-handling
1001 * code here, rather than relying on getopt. */
1003 exit_cleanup(RERR_SYNTAX);
1006 signal(SIGINT,SIGNAL_CAST sig_int);
1007 signal(SIGHUP,SIGNAL_CAST sig_int);
1008 signal(SIGTERM,SIGNAL_CAST sig_int);
1010 /* Ignore SIGPIPE; we consistently check error codes and will
1012 signal(SIGPIPE, SIG_IGN);
1014 /* Initialize push_dir here because on some old systems getcwd
1015 * (implemented by forking "pwd" and reading its output) doesn't
1016 * work when there are other child processes. Also, on all systems
1017 * that implement getcwd that way "pwd" can't be found after chroot. */
1022 if (write_batch && !am_server) {
1023 write_batch_argvs_file(orig_argc, orig_argv);
1026 if (am_daemon && !am_server)
1027 return daemon_main();
1031 exit_cleanup(RERR_SYNTAX);
1035 verbose = MAX(verbose,1);
1038 set_nonblocking(STDIN_FILENO);
1039 set_nonblocking(STDOUT_FILENO);
1041 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1042 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1045 ret = start_client(argc, argv);
1047 exit_cleanup(RERR_STARTCLIENT);