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);
112 if (do_stats && verbose > 1) {
113 /* These come out from every process */
122 log_exit(0, __FILE__, __LINE__);
123 if (f == -1 || !am_sender) return;
129 /* store total_written in a temporary
130 * because write_longint changes it */
131 w = stats.total_written;
132 write_longint(f,stats.total_read);
134 write_longint(f,stats.total_size);
139 /* this is the client */
143 stats.total_written = read_longint(f);
144 /* store total_read in a temporary, read_longint changes it */
146 stats.total_size = read_longint(f);
147 stats.total_read = r;
151 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
152 rprintf(FINFO,"Number of files transferred: %d\n",
153 stats.num_transferred_files);
154 rprintf(FINFO,"Total file size: %.0f bytes\n",
155 (double)stats.total_size);
156 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
157 (double)stats.total_transferred_size);
158 rprintf(FINFO,"Literal data: %.0f bytes\n",
159 (double)stats.literal_data);
160 rprintf(FINFO,"Matched data: %.0f bytes\n",
161 (double)stats.matched_data);
162 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
163 rprintf(FINFO,"Total bytes written: %.0f\n",
164 (double)stats.total_written);
165 rprintf(FINFO,"Total bytes read: %.0f\n",
166 (double)stats.total_read);
169 if (verbose || do_stats) {
170 rprintf(FINFO,"\nwrote %.0f bytes read %.0f bytes %.2f bytes/sec\n",
171 (double)stats.total_written,
172 (double)stats.total_read,
173 (stats.total_written+stats.total_read)/(0.5 + (t-starttime)));
174 rprintf(FINFO,"total size is %.0f speedup is %.2f\n",
175 (double)stats.total_size,
176 (1.0*stats.total_size)/(stats.total_written+stats.total_read));
185 * If our C library can get malloc statistics, then show them to FINFO
187 static void show_malloc_stats(void)
194 rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
196 am_server ? "server " : "",
197 am_daemon ? "daemon " : "",
199 rprintf(FINFO, " arena: %10d (bytes from sbrk)\n", mi.arena);
200 rprintf(FINFO, " ordblks: %10d (chunks not in use)\n", mi.ordblks);
201 rprintf(FINFO, " smblks: %10d\n", mi.smblks);
202 rprintf(FINFO, " hblks: %10d (chunks from mmap)\n", mi.hblks);
203 rprintf(FINFO, " hblkhd: %10d (bytes from mmap)\n", mi.hblkhd);
204 rprintf(FINFO, " allmem: %10d (bytes from sbrk + mmap)\n",
205 mi.arena + mi.hblkhd);
206 rprintf(FINFO, " usmblks: %10d\n", mi.usmblks);
207 rprintf(FINFO, " fsmblks: %10d\n", mi.fsmblks);
208 rprintf(FINFO, " uordblks: %10d (bytes used)\n", mi.uordblks);
209 rprintf(FINFO, " fordblks: %10d (bytes free)\n", mi.fordblks);
210 rprintf(FINFO, " keepcost: %10d (bytes in releasable chunk)\n", mi.keepcost);
211 #endif /* HAVE_MALLINFO */
215 /* Start the remote shell. cmd may be NULL to use the default. */
216 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
217 int *f_in, int *f_out)
222 char *tok, *dir = NULL;
225 if (!read_batch && !local_server) {
226 char *rsh_env = getenv(RSYNC_RSH_ENV);
235 for (tok = strtok(cmd, " "); tok; tok = strtok(NULL, " "))
238 /* check to see if we've already been given '-l user' in
239 * the remote-shell command */
240 for (i = 0; i < argc-1; i++) {
241 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
246 /* remsh (on HPUX) takes the arguments the other way around */
247 args[argc++] = machine;
248 if (user && !(daemon_over_rsh && dash_l_set)) {
253 if (user && !(daemon_over_rsh && dash_l_set)) {
257 args[argc++] = machine;
260 args[argc++] = rsync_path;
262 if (blocking_io < 0) {
264 if ((cp = strrchr(cmd, '/')) != NULL)
268 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
272 server_options(args,&argc);
277 if (!daemon_over_rsh && path && *path)
280 if (argc >= (int)(sizeof args / sizeof args[0])) {
281 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
282 exit_cleanup(RERR_MALLOC); /* XXX Need better RERR? */
288 rprintf(FINFO,"cmd=");
290 rprintf(FINFO,"%s ",args[i]);
296 create_flist_from_batch(); /* sets batch_flist */
297 ret = local_child(argc, args, f_in, f_out, child_main);
299 ret = piped_child(args,f_in,f_out);
307 out_of_memory("do_cmd");
308 return 0; /* not reached */
312 static char *get_local_name(struct file_list *flist,char *name)
318 rprintf(FINFO,"get_local_name count=%d %s\n",
319 flist->count, NS(name));
324 if (do_stat(name,&st) == 0) {
325 if (S_ISDIR(st.st_mode)) {
326 if (!push_dir(name)) {
327 rsyserr(FERROR, errno, "push_dir#1 %s failed",
329 exit_cleanup(RERR_FILESELECT);
333 if (flist->count > 1) {
334 rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
335 exit_cleanup(RERR_FILESELECT);
340 if (flist->count <= 1 && ((e = strlen(name)) <= 1 || name[e-1] != '/'))
343 if (do_mkdir(name,0777 & ~orig_umask) != 0) {
344 rsyserr(FERROR, errno, "mkdir %s failed", full_fname(name));
345 exit_cleanup(RERR_FILEIO);
348 rprintf(FINFO,"created directory %s\n",name);
351 if (!push_dir(name)) {
352 rsyserr(FERROR, errno, "push_dir#2 %s failed",
354 exit_cleanup(RERR_FILESELECT);
361 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
364 struct file_list *flist;
368 rprintf(FINFO, "server_sender starting pid=%ld\n",
372 if (am_daemon && lp_write_only(module_id) && am_sender) {
373 rprintf(FERROR, "ERROR: module is write only\n");
374 exit_cleanup(RERR_SYNTAX);
378 if (!relative_paths && !push_dir(dir)) {
379 rsyserr(FERROR, errno, "push_dir#3 %s failed",
381 exit_cleanup(RERR_FILESELECT);
386 if (strcmp(dir,".")) {
388 if (strcmp(dir,"/") == 0)
394 if (argc == 0 && recurse) {
400 flist = send_file_list(f_out,argc,argv);
401 if (!flist || flist->count == 0) {
405 io_start_buffering_in(f_in);
406 io_start_buffering_out(f_out);
407 send_files(flist,f_out,f_in);
408 io_flush(FULL_FLUSH);
410 if (protocol_version >= 24) {
411 /* final goodbye message */
414 io_flush(FULL_FLUSH);
419 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
425 if (preserve_hard_links)
426 init_hard_links(flist);
429 /* I moved this here from recv_files() to prevent a race condition */
430 if (recurse && delete_mode && !local_name && flist->count>0) {
435 if (fd_pair(error_pipe) < 0) {
436 rprintf(FERROR,"error pipe failed in do_recv\n");
437 exit_cleanup(RERR_SOCKETIO);
440 io_flush(NORMAL_FLUSH);
442 if ((pid=do_fork()) == 0) {
443 close(error_pipe[0]);
444 if (f_in != f_out) close(f_out);
446 /* we can't let two processes write to the socket at one time */
447 io_multiplexing_close();
449 /* set place to send errors */
450 set_msg_fd_out(error_pipe[1]);
452 recv_files(f_in,flist,local_name);
453 io_flush(FULL_FLUSH);
456 send_msg(MSG_DONE, "", 0);
457 io_flush(FULL_FLUSH);
458 /* finally we go to sleep until our parent kills us
459 * with a USR2 signal. We sleep for a short time as on
460 * some OSes a signal won't interrupt a sleep! */
467 close(error_pipe[1]);
468 if (f_in != f_out) close(f_in);
470 io_start_buffering_out(f_out);
472 set_msg_fd_in(error_pipe[0]);
474 generate_files(f_out, flist, local_name);
476 get_redo_num(); /* Read final MSG_DONE and any prior messages. */
478 io_flush(FULL_FLUSH);
479 if (protocol_version >= 24) {
480 /* send a final goodbye message */
481 write_int(f_out, -1);
483 io_flush(FULL_FLUSH);
487 wait_process(pid, &status);
492 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
495 struct file_list *flist;
496 char *local_name = NULL;
500 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
501 argc, (long)getpid());
504 if (am_daemon && lp_read_only(module_id) && !am_sender) {
505 rprintf(FERROR,"ERROR: module is read only\n");
506 exit_cleanup(RERR_SYNTAX);
515 if (!am_daemon && !push_dir(dir)) {
516 rsyserr(FERROR, errno, "push_dir#4 %s failed",
518 exit_cleanup(RERR_FILESELECT);
522 io_start_buffering_in(f_in);
523 if (delete_mode && !delete_excluded)
524 recv_exclude_list(f_in);
526 if (filesfrom_fd >= 0) {
527 /* We're receiving the file info from the sender, so we need
528 * the IO routines to automatically write out the names onto
529 * our f_out socket as we read the list info from the sender.
530 * This avoids both deadlock and extra delays/buffers. */
531 io_set_filesfrom_fds(filesfrom_fd, f_out);
538 flist = recv_file_list(f_in);
540 rprintf(FERROR,"server_recv: recv_file_list error\n");
541 exit_cleanup(RERR_FILESELECT);
545 if (strcmp(dir,".")) {
546 argv[0] += strlen(dir);
547 if (argv[0][0] == '/') argv[0]++;
549 local_name = get_local_name(flist,argv[0]);
552 status = do_recv(f_in,f_out,flist,local_name);
553 exit_cleanup(status);
557 int child_main(int argc, char *argv[])
559 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
564 void start_server(int f_in, int f_out, int argc, char *argv[])
566 setup_protocol(f_out, f_in);
568 set_nonblocking(f_in);
569 set_nonblocking(f_out);
571 if (protocol_version >= 23)
572 io_start_multiplex_out(f_out);
576 recv_exclude_list(f_in);
580 do_server_sender(f_in, f_out, argc, argv);
582 do_server_recv(f_in, f_out, argc, argv);
589 * This is called once the connection has been negotiated. It is used
590 * for rsyncd, remote-shell, and local connections.
592 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
594 struct file_list *flist = NULL;
595 int status = 0, status2 = 0;
596 char *local_name = NULL;
598 cleanup_child_pid = pid;
602 set_nonblocking(f_in);
603 set_nonblocking(f_out);
605 setup_protocol(f_out,f_in);
607 if (protocol_version >= 23)
608 io_start_multiplex_in(f_in);
611 io_start_buffering_out(f_out);
614 if (delete_mode && !delete_excluded)
615 send_exclude_list(f_out);
616 if (remote_filesfrom_file)
618 if (!read_batch) /* don't write to pipe */
619 flist = send_file_list(f_out,argc,argv);
621 rprintf(FINFO,"file list sent\n");
623 io_flush(NORMAL_FLUSH);
624 send_files(flist,f_out,f_in);
625 io_flush(FULL_FLUSH);
626 if (protocol_version >= 24) {
627 /* final goodbye message */
632 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
633 io_flush(FULL_FLUSH);
634 wait_process(pid, &status);
637 io_flush(FULL_FLUSH);
638 exit_cleanup(status);
645 send_exclude_list(f_out);
647 if (filesfrom_fd >= 0) {
648 io_set_filesfrom_fds(filesfrom_fd, f_out);
652 flist = recv_file_list(f_in);
653 if (!flist || flist->count == 0) {
654 rprintf(FINFO, "client: nothing to do: "
655 "perhaps you need to specify some filenames or "
656 "the --recursive option?\n");
660 local_name = get_local_name(flist,argv[0]);
662 status2 = do_recv(f_in,f_out,flist,local_name);
666 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
667 io_flush(FULL_FLUSH);
668 wait_process(pid, &status);
671 return MAX(status, status2);
674 static int copy_argv (char *argv[])
678 for (i = 0; argv[i]; i++) {
679 if (!(argv[i] = strdup(argv[i]))) {
680 rprintf (FERROR, "out of memory at %s(%d)\n",
691 * Start a client for either type of remote connection. Work out
692 * whether the arguments request a remote shell or rsyncd connection,
693 * and call the appropriate connection function, then run_client.
695 * Calls either start_socket_client (for sockets) or do_cmd and
696 * client_run (for ssh).
698 static int start_client(int argc, char *argv[])
701 char *shell_machine = NULL;
702 char *shell_path = NULL;
703 char *shell_user = NULL;
709 /* Don't clobber argv[] so that ps(1) can still show the right
711 if ((rc = copy_argv(argv)))
714 /* rsync:// always uses rsync server over direct socket connection */
715 if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0) {
718 host = argv[0] + strlen(URL_PREFIX);
719 p = strchr(host,'/');
726 p = strchr(host,':');
728 rsync_port = atoi(p+1);
731 return start_socket_client(host, path, argc-1, argv+1);
735 p = find_colon(argv[0]);
737 if (remote_filesfrom_file
738 && remote_filesfrom_file != files_from + 1
739 && strncmp(files_from, argv[0], p-argv[0]+1) != 0) {
741 "--files-from hostname is not transfer hostname\n");
742 exit_cleanup(RERR_SYNTAX);
744 if (p[1] == ':') { /* double colon */
747 return start_socket_client(argv[0], p+2,
756 exit_cleanup(RERR_SYNTAX);
761 shell_machine = argv[0];
768 /* rsync:// destination uses rsync server over direct socket */
769 if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
772 host = argv[argc-1] + strlen(URL_PREFIX);
773 p = strchr(host,'/');
780 p = strchr(host,':');
782 rsync_port = atoi(p+1);
785 return start_socket_client(host, path, argc-1, argv);
788 p = find_colon(argv[argc-1]);
789 if (p && remote_filesfrom_file
790 && remote_filesfrom_file != files_from + 1
791 && strncmp(files_from, argv[argc-1], p-argv[argc-1]+1) != 0) {
793 "--files-from hostname is not transfer hostname\n");
794 exit_cleanup(RERR_SYNTAX);
798 if (remote_filesfrom_file) {
800 "--files-from is remote but transfer is local\n");
801 exit_cleanup(RERR_SYNTAX);
803 } else if (p[1] == ':') { /* double colon */
806 return start_socket_client(argv[argc-1], p+2,
815 exit_cleanup(RERR_SYNTAX);
819 shell_machine = NULL;
820 shell_path = argv[argc-1];
823 shell_machine = argv[argc-1];
831 shell_path = argv[argc-1];
835 p = strrchr(shell_machine,'@');
838 shell_user = shell_machine;
844 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
845 shell_cmd?shell_cmd:"",
846 shell_machine?shell_machine:"",
847 shell_user?shell_user:"",
848 shell_path?shell_path:"");
851 if (!am_sender && argc > 1) {
853 exit_cleanup(RERR_SYNTAX);
856 if (argc == 0 && !am_sender) {
860 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
863 /* if we're running an rsync server on the remote host over a
864 * remote shell command, we need to do the RSYNCD protocol first */
865 if (daemon_over_rsh) {
867 tmpret = start_inband_exchange(shell_user, shell_path,
873 ret = client_run(f_in, f_out, pid, argc, argv);
882 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
884 exit_cleanup(RERR_SIGNAL);
887 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
889 if (log_got_error) _exit(RERR_PARTIAL);
893 static RETSIGTYPE sigchld_handler(UNUSED(int val))
898 /* An empty waitpid() loop was put here by Tridge and we could never
899 * get him to explain why he put it in, so rather than taking it
900 * out we're instead saving the child exit statuses for later use.
901 * The waitpid() loop presumably eliminates all possibility of leaving
902 * zombie children, maybe that's why he did it.
904 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
905 /* save the child's exit status */
906 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
907 if (pid_stat_table[cnt].pid == 0) {
908 pid_stat_table[cnt].pid = pid;
909 pid_stat_table[cnt].status = status;
919 * This routine catches signals and tries to send them to gdb.
921 * Because it's called from inside a signal handler it ought not to
922 * use too many library routines.
924 * @todo Perhaps use "screen -X" instead/as well, to help people
925 * debugging without easy access to X. Perhaps use an environment
926 * variable, or just call a script?
928 * @todo The /proc/ magic probably only works on Linux (and
929 * Solaris?) Can we be more portable?
931 #ifdef MAINTAINER_MODE
932 const char *get_panic_action(void)
934 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
939 return "xterm -display :0 -T Panic -n Panic "
940 "-e gdb /proc/%d/exe %d";
945 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
947 * This signal handler is only installed if we were configured with
948 * --enable-maintainer-mode. Perhaps it should always be on and we
949 * should just look at the environment variable, but I'm a bit leery
950 * of a signal sending us into a busy loop.
952 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
957 sprintf(cmd_buf, get_panic_action(),
960 /* Unless we failed to execute gdb, we allow the process to
961 * continue. I'm not sure if that's right. */
962 ret = system(cmd_buf);
969 int main(int argc,char *argv[])
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 = (MY_UID() == 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. */
1025 if (write_batch && !am_server) {
1026 write_batch_argvs_file(orig_argc, orig_argv);
1029 if (am_daemon && !am_server)
1030 return daemon_main();
1034 exit_cleanup(RERR_SYNTAX);
1038 verbose = MAX(verbose,1);
1041 set_nonblocking(STDIN_FILENO);
1042 set_nonblocking(STDOUT_FILENO);
1044 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1045 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1048 ret = start_client(argc, argv);
1050 exit_cleanup(RERR_STARTCLIENT);