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 keep_dirlinks;
47 extern int preserve_hard_links;
48 extern int protocol_version;
50 extern int relative_paths;
51 extern int rsync_port;
52 extern int read_batch;
53 extern int write_batch;
54 extern int filesfrom_fd;
55 extern pid_t cleanup_child_pid;
56 extern char *files_from;
57 extern char *remote_filesfrom_file;
58 extern char *rsync_path;
59 extern char *shell_cmd;
60 extern struct file_list *batch_flist;
63 /* there's probably never more than at most 2 outstanding child processes,
64 * but set it higher just in case.
66 #define MAXCHILDPROCS 5
71 } pid_stat_table[MAXCHILDPROCS];
73 static void show_malloc_stats(void);
75 /****************************************************************************
76 wait for a process to exit, calling io_flush while waiting
77 ****************************************************************************/
78 void wait_process(pid_t pid, int *status)
83 while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
88 if (waited_pid == -1 && errno == ECHILD) {
89 /* status of requested child no longer available.
90 * check to see if it was processed by the sigchld_handler.
92 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
93 if (pid == pid_stat_table[cnt].pid) {
94 *status = pid_stat_table[cnt].status;
95 pid_stat_table[cnt].pid = 0;
101 /* TODO: If the child exited on a signal, then log an
102 * appropriate error message. Perhaps we should also accept a
103 * message describing the purpose of the child. Also indicate
104 * this to the caller so that thhey know something went
106 *status = WEXITSTATUS(*status);
109 static void report(int f)
111 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)
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 */
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 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
154 rprintf(FINFO,"Number of files transferred: %d\n",
155 stats.num_transferred_files);
156 rprintf(FINFO,"Total file size: %.0f bytes\n",
157 (double)stats.total_size);
158 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
159 (double)stats.total_transferred_size);
160 rprintf(FINFO,"Literal data: %.0f bytes\n",
161 (double)stats.literal_data);
162 rprintf(FINFO,"Matched data: %.0f bytes\n",
163 (double)stats.matched_data);
164 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
165 rprintf(FINFO,"Total bytes written: %.0f\n",
166 (double)stats.total_written);
167 rprintf(FINFO,"Total bytes read: %.0f\n",
168 (double)stats.total_read);
171 if (verbose || do_stats) {
172 rprintf(FINFO,"\nwrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
173 (double)stats.total_written,
174 (double)stats.total_read,
175 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
176 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
177 (double)stats.total_size,
178 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
187 * If our C library can get malloc statistics, then show them to FINFO
189 static void show_malloc_stats(void)
196 rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
198 am_server ? "server " : "",
199 am_daemon ? "daemon " : "",
201 rprintf(FINFO, " arena: %10d (bytes from sbrk)\n", mi.arena);
202 rprintf(FINFO, " ordblks: %10d (chunks not in use)\n", mi.ordblks);
203 rprintf(FINFO, " smblks: %10d\n", mi.smblks);
204 rprintf(FINFO, " hblks: %10d (chunks from mmap)\n", mi.hblks);
205 rprintf(FINFO, " hblkhd: %10d (bytes from mmap)\n", mi.hblkhd);
206 rprintf(FINFO, " allmem: %10d (bytes from sbrk + mmap)\n",
207 mi.arena + mi.hblkhd);
208 rprintf(FINFO, " usmblks: %10d\n", mi.usmblks);
209 rprintf(FINFO, " fsmblks: %10d\n", mi.fsmblks);
210 rprintf(FINFO, " uordblks: %10d (bytes used)\n", mi.uordblks);
211 rprintf(FINFO, " fordblks: %10d (bytes free)\n", mi.fordblks);
212 rprintf(FINFO, " keepcost: %10d (bytes in releasable chunk)\n", mi.keepcost);
213 #endif /* HAVE_MALLINFO */
217 /* Start the remote shell. cmd may be NULL to use the default. */
218 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
219 int *f_in, int *f_out)
222 char *args[MAX_ARGS];
224 char *tok, *dir = NULL;
227 if (!read_batch && !local_server) {
228 char *rsh_env = getenv(RSYNC_RSH_ENV);
237 for (tok = strtok(cmd, " "); tok; tok = strtok(NULL, " ")) {
238 if (argc >= MAX_ARGS) {
239 rprintf(FERROR, "Command is too long\n");
240 exit_cleanup(RERR_SYNTAX);
245 /* check to see if we've already been given '-l user' in
246 * the remote-shell command */
247 for (i = 0; i < argc-1; i++) {
248 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
253 /* remsh (on HPUX) takes the arguments the other way around */
254 args[argc++] = machine;
255 if (user && !(daemon_over_rsh && dash_l_set)) {
260 if (user && !(daemon_over_rsh && dash_l_set)) {
264 args[argc++] = machine;
267 args[argc++] = rsync_path;
269 if (blocking_io < 0) {
271 if ((cp = strrchr(cmd, '/')) != NULL)
275 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
279 server_options(args,&argc);
284 if (!daemon_over_rsh && path && *path)
287 if (argc >= (int)(sizeof args / sizeof args[0])) {
288 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
289 exit_cleanup(RERR_MALLOC); /* XXX Need better RERR? */
295 rprintf(FINFO,"cmd=");
297 rprintf(FINFO,"%s ",args[i]);
303 create_flist_from_batch(); /* sets batch_flist */
304 ret = local_child(argc, args, f_in, f_out, child_main);
306 ret = piped_child(args,f_in,f_out);
315 out_of_memory("do_cmd");
316 return 0; /* not reached */
320 static char *get_local_name(struct file_list *flist,char *name)
326 rprintf(FINFO,"get_local_name count=%d %s\n",
327 flist->count, NS(name));
332 if (do_stat(name,&st) == 0) {
333 if (S_ISDIR(st.st_mode)) {
334 if (!push_dir(name)) {
335 rsyserr(FERROR, errno, "push_dir#1 %s failed",
337 exit_cleanup(RERR_FILESELECT);
341 if (flist->count > 1) {
342 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
343 exit_cleanup(RERR_FILESELECT);
348 if (flist->count <= 1 && ((e = strlen(name)) <= 1 || name[e-1] != '/'))
351 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
352 rsyserr(FERROR, errno, "mkdir %s failed", full_fname(name));
353 exit_cleanup(RERR_FILEIO);
356 rprintf(FINFO,"created directory %s\n",name);
359 if (!push_dir(name)) {
360 rsyserr(FERROR, errno, "push_dir#2 %s failed",
362 exit_cleanup(RERR_FILESELECT);
369 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
372 struct file_list *flist;
376 rprintf(FINFO, "server_sender starting pid=%ld\n",
380 if (am_daemon && lp_write_only(module_id) && am_sender) {
381 rprintf(FERROR, "ERROR: module is write only\n");
382 exit_cleanup(RERR_SYNTAX);
386 if (!relative_paths && !push_dir(dir)) {
387 rsyserr(FERROR, errno, "push_dir#3 %s failed",
389 exit_cleanup(RERR_FILESELECT);
394 if (strcmp(dir,".")) {
396 if (strcmp(dir,"/") == 0)
402 if (argc == 0 && recurse) {
408 flist = send_file_list(f_out,argc,argv);
409 if (!flist || flist->count == 0) {
413 io_start_buffering_in(f_in);
414 io_start_buffering_out(f_out);
415 send_files(flist,f_out,f_in);
416 io_flush(FULL_FLUSH);
418 if (protocol_version >= 24) {
419 /* final goodbye message */
422 io_flush(FULL_FLUSH);
427 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
433 if (preserve_hard_links)
434 init_hard_links(flist);
437 /* I moved this here from recv_files() to prevent a race condition */
438 if (recurse && delete_mode && !local_name && flist->count>0) {
443 if (fd_pair(error_pipe) < 0) {
444 rprintf(FERROR,"error pipe failed in do_recv\n");
445 exit_cleanup(RERR_SOCKETIO);
448 io_flush(NORMAL_FLUSH);
450 if ((pid=do_fork()) == 0) {
451 close(error_pipe[0]);
455 /* we can't let two processes write to the socket at one time */
456 io_multiplexing_close();
458 /* set place to send errors */
459 set_msg_fd_out(error_pipe[1]);
461 recv_files(f_in,flist,local_name);
462 io_flush(FULL_FLUSH);
465 send_msg(MSG_DONE, "", 0);
466 io_flush(FULL_FLUSH);
467 /* finally we go to sleep until our parent kills us
468 * with a USR2 signal. We sleep for a short time as on
469 * some OSes a signal won't interrupt a sleep! */
476 close(error_pipe[1]);
480 io_start_buffering_out(f_out);
482 set_msg_fd_in(error_pipe[0]);
484 generate_files(f_out, flist, local_name);
486 get_redo_num(); /* Read final MSG_DONE and any prior messages. */
488 io_flush(FULL_FLUSH);
489 if (protocol_version >= 24) {
490 /* send a final goodbye message */
491 write_int(f_out, -1);
493 io_flush(FULL_FLUSH);
497 wait_process(pid, &status);
502 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
505 struct file_list *flist;
506 char *local_name = NULL;
510 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
511 argc, (long)getpid());
514 if (am_daemon && lp_read_only(module_id) && !am_sender) {
515 rprintf(FERROR,"ERROR: module is read only\n");
516 exit_cleanup(RERR_SYNTAX);
525 if (!am_daemon && !push_dir(dir)) {
526 rsyserr(FERROR, errno, "push_dir#4 %s failed",
528 exit_cleanup(RERR_FILESELECT);
532 io_start_buffering_in(f_in);
533 if (delete_mode && !delete_excluded)
534 recv_exclude_list(f_in);
536 if (filesfrom_fd >= 0) {
537 /* We're receiving the file info from the sender, so we need
538 * the IO routines to automatically write out the names onto
539 * our f_out socket as we read the list info from the sender.
540 * This avoids both deadlock and extra delays/buffers. */
541 io_set_filesfrom_fds(filesfrom_fd, f_out);
548 flist = recv_file_list(f_in);
550 rprintf(FERROR,"server_recv: recv_file_list error\n");
551 exit_cleanup(RERR_FILESELECT);
555 if (strcmp(dir,".")) {
556 argv[0] += strlen(dir);
557 if (argv[0][0] == '/')
560 local_name = get_local_name(flist,argv[0]);
563 status = do_recv(f_in,f_out,flist,local_name);
564 exit_cleanup(status);
568 int child_main(int argc, char *argv[])
570 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
575 void start_server(int f_in, int f_out, int argc, char *argv[])
577 setup_protocol(f_out, f_in);
579 set_nonblocking(f_in);
580 set_nonblocking(f_out);
582 if (protocol_version >= 23)
583 io_start_multiplex_out(f_out);
586 keep_dirlinks = 0; /* Must be disabled on the sender. */
588 recv_exclude_list(f_in);
592 do_server_sender(f_in, f_out, argc, argv);
594 do_server_recv(f_in, f_out, argc, argv);
601 * This is called once the connection has been negotiated. It is used
602 * for rsyncd, remote-shell, and local connections.
604 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
606 struct file_list *flist = NULL;
607 int status = 0, status2 = 0;
608 char *local_name = NULL;
610 cleanup_child_pid = pid;
614 set_nonblocking(f_in);
615 set_nonblocking(f_out);
617 setup_protocol(f_out,f_in);
619 if (protocol_version >= 23)
620 io_start_multiplex_in(f_in);
623 keep_dirlinks = 0; /* Must be disabled on the sender. */
624 io_start_buffering_out(f_out);
627 if (delete_mode && !delete_excluded)
628 send_exclude_list(f_out);
629 if (remote_filesfrom_file)
631 if (!read_batch) /* don't write to pipe */
632 flist = send_file_list(f_out,argc,argv);
634 rprintf(FINFO,"file list sent\n");
636 io_flush(NORMAL_FLUSH);
637 send_files(flist,f_out,f_in);
638 io_flush(FULL_FLUSH);
639 if (protocol_version >= 24) {
640 /* final goodbye message */
645 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
646 io_flush(FULL_FLUSH);
647 wait_process(pid, &status);
650 io_flush(FULL_FLUSH);
651 exit_cleanup(status);
658 send_exclude_list(f_out);
660 if (filesfrom_fd >= 0) {
661 io_set_filesfrom_fds(filesfrom_fd, f_out);
665 flist = recv_file_list(f_in);
666 if (!flist || flist->count == 0) {
667 rprintf(FINFO, "client: nothing to do: "
668 "perhaps you need to specify some filenames or "
669 "the --recursive option?\n");
673 local_name = get_local_name(flist,argv[0]);
675 status2 = do_recv(f_in,f_out,flist,local_name);
679 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
680 io_flush(FULL_FLUSH);
681 wait_process(pid, &status);
684 return MAX(status, status2);
687 static int copy_argv (char *argv[])
691 for (i = 0; argv[i]; i++) {
692 if (!(argv[i] = strdup(argv[i]))) {
693 rprintf (FERROR, "out of memory at %s(%d)\n",
704 * Start a client for either type of remote connection. Work out
705 * whether the arguments request a remote shell or rsyncd connection,
706 * and call the appropriate connection function, then run_client.
708 * Calls either start_socket_client (for sockets) or do_cmd and
709 * client_run (for ssh).
711 static int start_client(int argc, char *argv[])
714 char *shell_machine = NULL;
715 char *shell_path = NULL;
716 char *shell_user = NULL;
722 /* Don't clobber argv[] so that ps(1) can still show the right
724 if ((rc = copy_argv(argv)))
727 /* rsync:// always uses rsync server over direct socket connection */
728 if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0) {
731 host = argv[0] + strlen(URL_PREFIX);
732 p = strchr(host,'/');
739 p = strchr(host,':');
741 rsync_port = atoi(p+1);
744 return start_socket_client(host, path, argc-1, argv+1);
747 if (!read_batch) { /* for read_batch, NO source is specified */
748 p = find_colon(argv[0]);
749 if (p) { /* source is remote */
750 if (remote_filesfrom_file
751 && remote_filesfrom_file != files_from + 1
752 && strncmp(files_from, argv[0], p-argv[0]+1) != 0) {
754 "--files-from hostname is not transfer hostname\n");
755 exit_cleanup(RERR_SYNTAX);
757 if (p[1] == ':') { /* double colon */
760 return start_socket_client(argv[0], p+2,
767 if (argc < 1) { /* destination required */
769 exit_cleanup(RERR_SYNTAX);
774 shell_machine = argv[0];
777 } else { /* source is local */
780 /* rsync:// destination uses rsync server over direct socket */
781 if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
784 host = argv[argc-1] + strlen(URL_PREFIX);
785 p = strchr(host,'/');
792 p = strchr(host,':');
794 rsync_port = atoi(p+1);
797 return start_socket_client(host, path, argc-1, argv);
800 p = find_colon(argv[argc-1]); /* look in dest arg */
801 if (p && remote_filesfrom_file
802 && remote_filesfrom_file != files_from + 1
803 && strncmp(files_from, argv[argc-1], p-argv[argc-1]+1) != 0) {
805 "--files-from hostname is not transfer hostname\n");
806 exit_cleanup(RERR_SYNTAX);
808 if (!p) { /* no colon found, so src & dest are local */
810 if (remote_filesfrom_file) {
812 "--files-from is remote but transfer is local\n");
813 exit_cleanup(RERR_SYNTAX);
815 } else if (p[1] == ':') { /* double colon */
818 return start_socket_client(argv[argc-1], p+2,
827 exit_cleanup(RERR_SYNTAX);
831 shell_machine = NULL;
832 shell_path = argv[argc-1];
835 shell_machine = argv[argc-1];
840 } else { /* read_batch */
843 shell_path = argv[argc-1];
847 p = strrchr(shell_machine,'@');
850 shell_user = shell_machine;
856 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
857 shell_cmd?shell_cmd:"",
858 shell_machine?shell_machine:"",
859 shell_user?shell_user:"",
860 shell_path?shell_path:"");
863 /* for remote source, only single dest arg can remain ... */
864 if (!am_sender && argc > 1) {
866 exit_cleanup(RERR_SYNTAX);
869 /* ... or no dest at all */
870 if (!am_sender && argc == 0) {
874 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
877 /* if we're running an rsync server on the remote host over a
878 * remote shell command, we need to do the RSYNCD protocol first */
879 if (daemon_over_rsh) {
881 tmpret = start_inband_exchange(shell_user, shell_path,
887 ret = client_run(f_in, f_out, pid, argc, argv);
896 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
898 exit_cleanup(RERR_SIGNAL);
901 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
903 if (log_got_error) _exit(RERR_PARTIAL);
907 static RETSIGTYPE sigchld_handler(UNUSED(int val))
912 /* An empty waitpid() loop was put here by Tridge and we could never
913 * get him to explain why he put it in, so rather than taking it
914 * out we're instead saving the child exit statuses for later use.
915 * The waitpid() loop presumably eliminates all possibility of leaving
916 * zombie children, maybe that's why he did it.
918 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
919 /* save the child's exit status */
920 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
921 if (pid_stat_table[cnt].pid == 0) {
922 pid_stat_table[cnt].pid = pid;
923 pid_stat_table[cnt].status = status;
933 * This routine catches signals and tries to send them to gdb.
935 * Because it's called from inside a signal handler it ought not to
936 * use too many library routines.
938 * @todo Perhaps use "screen -X" instead/as well, to help people
939 * debugging without easy access to X. Perhaps use an environment
940 * variable, or just call a script?
942 * @todo The /proc/ magic probably only works on Linux (and
943 * Solaris?) Can we be more portable?
945 #ifdef MAINTAINER_MODE
946 const char *get_panic_action(void)
948 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
953 return "xterm -display :0 -T Panic -n Panic "
954 "-e gdb /proc/%d/exe %d";
959 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
961 * This signal handler is only installed if we were configured with
962 * --enable-maintainer-mode. Perhaps it should always be on and we
963 * should just look at the environment variable, but I'm a bit leery
964 * of a signal sending us into a busy loop.
966 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
971 sprintf(cmd_buf, get_panic_action(),
974 /* Unless we failed to execute gdb, we allow the process to
975 * continue. I'm not sure if that's right. */
976 ret = system(cmd_buf);
983 int main(int argc,char *argv[])
992 signal(SIGUSR1, sigusr1_handler);
993 signal(SIGUSR2, sigusr2_handler);
994 signal(SIGCHLD, sigchld_handler);
995 #ifdef MAINTAINER_MODE
996 signal(SIGSEGV, rsync_panic_handler);
997 signal(SIGFPE, rsync_panic_handler);
998 signal(SIGABRT, rsync_panic_handler);
999 signal(SIGBUS, rsync_panic_handler);
1000 #endif /* def MAINTAINER_MODE */
1002 starttime = time(NULL);
1003 am_root = (MY_UID() == 0);
1005 memset(&stats, 0, sizeof(stats));
1009 exit_cleanup(RERR_SYNTAX);
1012 /* we set a 0 umask so that correct file permissions can be
1014 orig_umask = (int)umask(0);
1016 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1017 /* FIXME: We ought to call the same error-handling
1018 * code here, rather than relying on getopt. */
1020 exit_cleanup(RERR_SYNTAX);
1023 signal(SIGINT,SIGNAL_CAST sig_int);
1024 signal(SIGHUP,SIGNAL_CAST sig_int);
1025 signal(SIGTERM,SIGNAL_CAST sig_int);
1027 /* Ignore SIGPIPE; we consistently check error codes and will
1029 signal(SIGPIPE, SIG_IGN);
1031 /* Initialize push_dir here because on some old systems getcwd
1032 * (implemented by forking "pwd" and reading its output) doesn't
1033 * work when there are other child processes. Also, on all systems
1034 * that implement getcwd that way "pwd" can't be found after chroot. */
1039 if (write_batch && !am_server) {
1040 write_batch_argvs_file(orig_argc, orig_argv);
1043 if (am_daemon && !am_server)
1044 return daemon_main();
1048 exit_cleanup(RERR_SYNTAX);
1052 verbose = MAX(verbose,1);
1055 set_nonblocking(STDIN_FILENO);
1056 set_nonblocking(STDOUT_FILENO);
1058 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1059 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1062 ret = start_client(argc, argv);
1064 exit_cleanup(RERR_STARTCLIENT);