2 * The startup routines, including main(), for rsync.
4 * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003, 2004, 2005, 2006, 2007 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
25 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
35 extern int am_generator;
37 extern int inc_recurse;
38 extern int blocking_io;
39 extern int remove_source_files;
40 extern int daemon_over_rsh;
41 extern int need_messages_from_generator;
42 extern int kluge_around_eof;
44 extern int log_got_error;
46 extern int copy_links;
47 extern int copy_dirlinks;
48 extern int keep_dirlinks;
49 extern int preserve_hard_links;
50 extern int protocol_version;
51 extern int file_total;
53 extern int relative_paths;
54 extern int sanitize_paths;
55 extern int curr_dir_depth;
56 extern int curr_dir_len;
58 extern int rsync_port;
59 extern int whole_file;
60 extern int read_batch;
61 extern int write_batch;
63 extern int filesfrom_fd;
64 extern pid_t cleanup_child_pid;
65 extern struct stats stats;
66 extern char *filesfrom_host;
67 extern char *partial_dir;
68 extern char *basis_dir[];
69 extern char *rsync_path;
70 extern char *shell_cmd;
71 extern char *batch_name;
72 extern char *password_file;
73 extern char curr_dir[MAXPATHLEN];
74 extern struct filter_list_struct server_filter_list;
78 mode_t orig_umask = 0;
79 int batch_gen_fd = -1;
81 /* There's probably never more than at most 2 outstanding child processes,
82 * but set it higher, just in case. */
83 #define MAXCHILDPROCS 7
86 # ifdef HAVE_SIGPROCMASK
87 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
89 # define SIGACTMASK(n,h) SIGACTION(n,h)
91 static struct sigaction sigact;
97 } pid_stat_table[MAXCHILDPROCS];
99 static time_t starttime, endtime;
100 static int64 total_read, total_written;
102 static void show_malloc_stats(void);
104 /* Works like waitpid(), but if we already harvested the child pid in our
105 * remember_children(), we succeed instead of returning an error. */
106 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
111 waited_pid = waitpid(pid, status_ptr, flags);
112 } while (waited_pid == -1 && errno == EINTR);
114 if (waited_pid == -1 && errno == ECHILD) {
115 /* Status of requested child no longer available: check to
116 * see if it was processed by remember_children(). */
118 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
119 if (pid == pid_stat_table[cnt].pid) {
120 *status_ptr = pid_stat_table[cnt].status;
121 pid_stat_table[cnt].pid = 0;
130 /* Wait for a process to exit, calling io_flush while waiting. */
131 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
136 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
138 io_flush(FULL_FLUSH);
141 /* TODO: If the child exited on a signal, then log an
142 * appropriate error message. Perhaps we should also accept a
143 * message describing the purpose of the child. Also indicate
144 * this to the caller so that they know something went wrong. */
145 if (waited_pid < 0) {
146 rsyserr(FERROR, errno, "waitpid");
147 *exit_code_ptr = RERR_WAITCHILD;
148 } else if (!WIFEXITED(status)) {
150 if (WCOREDUMP(status))
151 *exit_code_ptr = RERR_CRASHED;
154 if (WIFSIGNALED(status))
155 *exit_code_ptr = RERR_TERMINATED;
157 *exit_code_ptr = RERR_WAITCHILD;
159 *exit_code_ptr = WEXITSTATUS(status);
162 /* This function gets called from all 3 processes. We want the client side
163 * to actually output the text, but the sender is the only process that has
164 * all the stats we need. So, if we're a client sender, we do the report.
165 * If we're a server sender, we write the stats on the supplied fd. If
166 * we're the client receiver we read the stats from the supplied fd and do
167 * the report. All processes might also generate a set of debug stats, if
168 * the verbose level is high enough (this is the only thing that the
169 * generator process and the server receiver ever do here). */
170 static void handle_stats(int f)
172 endtime = time(NULL);
174 /* Cache two stats because the read/write code can change it. */
175 total_read = stats.total_read;
176 total_written = stats.total_written;
178 if (do_stats && verbose > 1) {
179 /* These come out from every process */
188 if (f == -1 || !am_sender)
194 write_longint(f, total_read);
195 write_longint(f, total_written);
196 write_longint(f, stats.total_size);
197 if (protocol_version >= 29) {
198 write_longint(f, stats.flist_buildtime);
199 write_longint(f, stats.flist_xfertime);
205 /* this is the client */
207 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
209 else if (!am_sender) {
210 /* Read the first two in opposite order because the meaning of
211 * read/write swaps when switching from sender to receiver. */
212 total_written = read_longint(f);
213 total_read = read_longint(f);
214 stats.total_size = read_longint(f);
215 if (protocol_version >= 29) {
216 stats.flist_buildtime = read_longint(f);
217 stats.flist_xfertime = read_longint(f);
219 } else if (write_batch) {
220 /* The --read-batch process is going to be a client
221 * receiver, so we need to give it the stats. */
222 write_longint(batch_fd, total_read);
223 write_longint(batch_fd, total_written);
224 write_longint(batch_fd, stats.total_size);
225 if (protocol_version >= 29) {
226 write_longint(batch_fd, stats.flist_buildtime);
227 write_longint(batch_fd, stats.flist_xfertime);
232 static void output_summary(void)
235 rprintf(FCLIENT, "\n");
236 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
237 rprintf(FINFO,"Number of files transferred: %d\n",
238 stats.num_transferred_files);
239 rprintf(FINFO,"Total file size: %s bytes\n",
240 human_num(stats.total_size));
241 rprintf(FINFO,"Total transferred file size: %s bytes\n",
242 human_num(stats.total_transferred_size));
243 rprintf(FINFO,"Literal data: %s bytes\n",
244 human_num(stats.literal_data));
245 rprintf(FINFO,"Matched data: %s bytes\n",
246 human_num(stats.matched_data));
247 rprintf(FINFO,"File list size: %s\n",
248 human_num(stats.flist_size));
249 if (stats.flist_buildtime) {
251 "File list generation time: %.3f seconds\n",
252 (double)stats.flist_buildtime / 1000);
254 "File list transfer time: %.3f seconds\n",
255 (double)stats.flist_xfertime / 1000);
257 rprintf(FINFO,"Total bytes sent: %s\n",
258 human_num(total_written));
259 rprintf(FINFO,"Total bytes received: %s\n",
260 human_num(total_read));
263 if (verbose || do_stats) {
264 rprintf(FCLIENT, "\n");
266 "sent %s bytes received %s bytes %s bytes/sec\n",
267 human_num(total_written), human_num(total_read),
268 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
269 rprintf(FINFO, "total size is %s speedup is %.2f\n",
270 human_num(stats.total_size),
271 (double)stats.total_size / (total_written+total_read));
280 * If our C library can get malloc statistics, then show them to FINFO
282 static void show_malloc_stats(void)
289 rprintf(FCLIENT, "\n");
290 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
291 getpid(), am_server ? "server " : "",
292 am_daemon ? "daemon " : "", who_am_i());
293 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
295 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
297 rprintf(FINFO, " smblks: %10ld\n",
299 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
301 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
303 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
304 (long)mi.arena + mi.hblkhd);
305 rprintf(FINFO, " usmblks: %10ld\n",
307 rprintf(FINFO, " fsmblks: %10ld\n",
309 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
311 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
313 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
315 #endif /* HAVE_MALLINFO */
319 /* Start the remote shell. cmd may be NULL to use the default. */
320 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
321 int *f_in, int *f_out)
324 char *args[MAX_ARGS];
329 if (!read_batch && !local_server) {
330 char *t, *f, in_quote = '\0';
331 char *rsh_env = getenv(RSYNC_RSH_ENV);
340 for (t = f = cmd; *f; f++) {
343 /* Comparison leaves rooms for server_options(). */
344 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
345 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
346 exit_cleanup(RERR_SYNTAX);
349 while (*f != ' ' || in_quote) {
353 "Missing trailing-%c in remote-shell command.\n",
355 exit_cleanup(RERR_SYNTAX);
360 if (*f == '\'' || *f == '"') {
365 if (*f == in_quote && *++f != in_quote) {
375 /* check to see if we've already been given '-l user' in
376 * the remote-shell command */
377 for (i = 0; i < argc-1; i++) {
378 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
383 /* remsh (on HPUX) takes the arguments the other way around */
384 args[argc++] = machine;
385 if (user && !(daemon_over_rsh && dash_l_set)) {
390 if (user && !(daemon_over_rsh && dash_l_set)) {
394 args[argc++] = machine;
397 args[argc++] = rsync_path;
399 if (blocking_io < 0) {
401 if ((cp = strrchr(cmd, '/')) != NULL)
405 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
409 server_options(args,&argc);
411 if (argc >= MAX_ARGS - 2) {
412 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
413 exit_cleanup(RERR_SYNTAX);
419 if (!daemon_over_rsh && path && *path)
425 for (i = 0; i < argc; i++)
426 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
427 rprintf(FCLIENT, "\n");
431 int from_gen_pipe[2];
432 if (fd_pair(from_gen_pipe) < 0) {
433 rsyserr(FERROR, errno, "pipe");
434 exit_cleanup(RERR_IPC);
436 batch_gen_fd = from_gen_pipe[0];
437 *f_out = from_gen_pipe[1];
439 ret = -1; /* no child pid */
440 } else if (local_server) {
441 /* If the user didn't request --[no-]whole-file, force
442 * it on, but only if we're not batch processing. */
443 if (whole_file < 0 && !write_batch)
445 ret = local_child(argc, args, f_in, f_out, child_main);
447 ret = piped_child(args,f_in,f_out);
455 out_of_memory("do_cmd");
456 return 0; /* not reached */
459 /* The receiving side operates in one of two modes:
461 * 1. it receives any number of files into a destination directory,
462 * placing them according to their names in the file-list.
464 * 2. it receives a single file and saves it using the name in the
465 * destination path instead of its file-list name. This requires a
466 * "local name" for writing out the destination file.
468 * So, our task is to figure out what mode/local-name we need.
469 * For mode 1, we change into the destination directory and return NULL.
470 * For mode 2, we change into the directory containing the destination
471 * file (if we aren't already there) and return the local-name. */
472 static char *get_local_name(struct file_list *flist, char *dest_path)
479 rprintf(FINFO, "get_local_name count=%d %s\n",
480 file_total, NS(dest_path));
483 if (!dest_path || list_only)
486 /* See what currently exists at the destination. */
487 if ((statret = do_stat(dest_path, &st)) == 0) {
488 /* If the destination is a dir, enter it and use mode 1. */
489 if (S_ISDIR(st.st_mode)) {
490 if (!push_dir(dest_path, 0)) {
491 rsyserr(FERROR, errno, "push_dir#1 %s failed",
492 full_fname(dest_path));
493 exit_cleanup(RERR_FILESELECT);
497 if (file_total > 1) {
499 "ERROR: destination must be a directory when"
500 " copying more than 1 file\n");
501 exit_cleanup(RERR_FILESELECT);
503 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
505 "ERROR: cannot overwrite non-directory"
506 " with a directory\n");
507 exit_cleanup(RERR_FILESELECT);
509 } else if (errno != ENOENT) {
510 /* If we don't know what's at the destination, fail. */
511 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
512 full_fname(dest_path));
513 exit_cleanup(RERR_FILESELECT);
516 cp = strrchr(dest_path, '/');
518 /* If we need a destination directory because the transfer is not
519 * of a single non-directory or the user has requested one via a
520 * destination path ending in a slash, create one and use mode 1. */
521 if (file_total > 1 || (cp && !cp[1])) {
522 /* Lop off the final slash (if any). */
528 "ERROR: destination path is not a directory\n");
529 exit_cleanup(RERR_SYNTAX);
532 if (mkdir_defmode(dest_path) != 0) {
533 rsyserr(FERROR, errno, "mkdir %s failed",
534 full_fname(dest_path));
535 exit_cleanup(RERR_FILEIO);
541 rprintf(FINFO, "created directory %s\n", dest_path);
544 /* Indicate that dest dir doesn't really exist. */
548 if (!push_dir(dest_path, dry_run > 1)) {
549 rsyserr(FERROR, errno, "push_dir#2 %s failed",
550 full_fname(dest_path));
551 exit_cleanup(RERR_FILESELECT);
557 /* Otherwise, we are writing a single file, possibly on top of an
558 * existing non-directory. Change to the item's parent directory
559 * (if it has a path component), return the basename of the
560 * destination file as the local name, and use mode 2. */
568 if (!push_dir(dest_path, 0)) {
569 rsyserr(FERROR, errno, "push_dir#3 %s failed",
570 full_fname(dest_path));
571 exit_cleanup(RERR_FILESELECT);
578 /* Call this if the destination dir (which is assumed to be in curr_dir)
579 * does not yet exist and we can't create it due to being in dry-run
580 * mode. We'll fix dirs that can be relative to the non-existent dir. */
581 static void fix_basis_dirs(void)
583 char **dir, *new, *slash;
589 slash = strrchr(curr_dir, '/');
591 for (dir = basis_dir; *dir; dir++) {
594 len = curr_dir_len + 1 + strlen(*dir) + 1;
595 if (!(new = new_array(char, len)))
596 out_of_memory("fix_basis_dirs");
597 if (slash && strncmp(*dir, "../", 3) == 0) {
598 /* We want to remove only one leading "../" prefix for
599 * the directory we couldn't create in dry-run mode:
600 * this ensures that any other ".." references get
601 * evaluated the same as they would for a live copy. */
603 pathjoin(new, len, curr_dir, *dir + 3);
606 pathjoin(new, len, curr_dir, *dir);
611 /* This is only called by the sender. */
612 static void read_final_goodbye(int f_in, int f_out)
616 char xname[MAXPATHLEN];
618 if (protocol_version < 29)
621 i = read_ndx_and_attrs(f_in, f_out, &iflags,
622 &fnamecmp_type, xname, &xlen);
626 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
628 exit_cleanup(RERR_PROTOCOL);
632 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
634 struct file_list *flist;
638 rprintf(FINFO, "server_sender starting pid=%ld\n",
642 if (am_daemon && lp_write_only(module_id)) {
643 rprintf(FERROR, "ERROR: module is write only\n");
644 exit_cleanup(RERR_SYNTAX);
647 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
649 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
650 remove_source_files == 1 ? "source" : "sent");
651 exit_cleanup(RERR_SYNTAX);
655 if (!relative_paths) {
656 if (!push_dir(dir, 0)) {
657 rsyserr(FERROR, errno, "push_dir#3 %s failed",
659 exit_cleanup(RERR_FILESELECT);
665 if (argc == 0 && (recurse || list_only)) {
671 flist = send_file_list(f_out,argc,argv);
672 if (!flist || flist->count == 0)
675 io_start_buffering_in(f_in);
677 send_files(f_in, f_out);
678 io_flush(FULL_FLUSH);
680 if (protocol_version >= 24)
681 read_final_goodbye(f_in, f_out);
682 io_flush(FULL_FLUSH);
687 static int do_recv(int f_in, int f_out, char *local_name)
693 /* The receiving side mustn't obey this, or an existing symlink that
694 * points to an identical file won't be replaced by the referent. */
695 copy_links = copy_dirlinks = 0;
697 #ifdef SUPPORT_HARD_LINKS
698 if (preserve_hard_links)
702 if (fd_pair(error_pipe) < 0) {
703 rsyserr(FERROR, errno, "pipe failed in do_recv");
704 exit_cleanup(RERR_IPC);
707 io_flush(NORMAL_FLUSH);
709 if ((pid = do_fork()) == -1) {
710 rsyserr(FERROR, errno, "fork failed in do_recv");
711 exit_cleanup(RERR_IPC);
715 close(error_pipe[0]);
719 /* we can't let two processes write to the socket at one time */
720 io_end_multiplex_out();
722 /* set place to send errors */
723 set_msg_fd_out(error_pipe[1]);
724 io_start_buffering_out(error_pipe[1]);
726 recv_files(f_in, local_name);
727 io_flush(FULL_FLUSH);
730 send_msg(MSG_DONE, "", 1);
731 write_longint(error_pipe[1], stats.total_read);
732 io_flush(FULL_FLUSH);
734 /* Handle any keep-alive packets from the post-processing work
735 * that the generator does. */
736 if (protocol_version >= 29) {
739 char xname[MAXPATHLEN];
741 kluge_around_eof = -1;
743 /* This should only get stopped via a USR2 signal. */
744 read_ndx_and_attrs(f_in, -1, &iflags, &fnamecmp_type,
747 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
749 exit_cleanup(RERR_PROTOCOL);
752 /* Finally, we go to sleep until our parent kills us with a
753 * USR2 signal. We sleep for a short time, as on some OSes
754 * a signal won't interrupt a sleep! */
761 io_end_multiplex_in();
762 if (write_batch && !am_server)
765 close(error_pipe[1]);
769 io_start_buffering_out(f_out);
771 set_msg_fd_in(error_pipe[0]);
772 io_start_buffering_in(error_pipe[0]);
774 generate_files(f_out, local_name);
777 io_flush(FULL_FLUSH);
778 if (protocol_version >= 24) {
779 /* send a final goodbye message */
780 write_ndx(f_out, NDX_DONE);
782 io_flush(FULL_FLUSH);
786 wait_process_with_flush(pid, &exit_code);
790 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
793 struct file_list *flist;
794 char *local_name = NULL;
796 int save_verbose = verbose;
798 if (filesfrom_fd >= 0) {
799 /* We can't mix messages with files-from data on the socket,
800 * so temporarily turn off verbose messages. */
805 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
806 argc, (long)getpid());
809 if (am_daemon && lp_read_only(module_id)) {
810 rprintf(FERROR,"ERROR: module is read only\n");
811 exit_cleanup(RERR_SYNTAX);
819 if (!am_daemon && !push_dir(dir, 0)) {
820 rsyserr(FERROR, errno, "push_dir#4 %s failed",
822 exit_cleanup(RERR_FILESELECT);
826 if (protocol_version >= 30)
827 io_start_multiplex_in();
829 io_start_buffering_in(f_in);
830 recv_filter_list(f_in);
832 if (filesfrom_fd >= 0) {
833 /* We need to send the files-from names to the sender at the
834 * same time that we receive the file-list from them, so we
835 * need the IO routines to automatically write out the names
836 * onto our f_out socket as we read the file-list. This
837 * avoids both deadlock and extra delays/buffers. */
838 io_set_filesfrom_fds(filesfrom_fd, f_out);
842 flist = recv_file_list(f_in);
844 rprintf(FERROR,"server_recv: recv_file_list error\n");
845 exit_cleanup(RERR_FILESELECT);
847 if (inc_recurse && file_total == 1)
848 recv_additional_file_list(f_in);
849 verbose = save_verbose;
852 local_name = get_local_name(flist,argv[0]);
854 /* Now that we know what our destination directory turned out to be,
855 * we can sanitize the --link-/copy-/compare-dest args correctly. */
856 if (sanitize_paths) {
858 for (dir = basis_dir; *dir; dir++) {
859 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
862 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
867 if (server_filter_list.head) {
869 struct filter_list_struct *elp = &server_filter_list;
871 for (dir = basis_dir; *dir; dir++) {
872 if (check_filter(elp, *dir, 1) < 0)
873 goto options_rejected;
875 if (partial_dir && *partial_dir == '/'
876 && check_filter(elp, partial_dir, 1) < 0) {
879 "Your options have been rejected by the server.\n");
880 exit_cleanup(RERR_SYNTAX);
884 exit_code = do_recv(f_in, f_out, local_name);
885 exit_cleanup(exit_code);
889 int child_main(int argc, char *argv[])
891 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
896 void start_server(int f_in, int f_out, int argc, char *argv[])
898 set_nonblocking(f_in);
899 set_nonblocking(f_out);
901 io_set_sock_fds(f_in, f_out);
902 setup_protocol(f_out, f_in);
903 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
907 if (protocol_version >= 23)
908 io_start_multiplex_out();
911 keep_dirlinks = 0; /* Must be disabled on the sender. */
912 if (need_messages_from_generator)
913 io_start_multiplex_in();
914 recv_filter_list(f_in);
915 do_server_sender(f_in, f_out, argc, argv);
917 do_server_recv(f_in, f_out, argc, argv);
923 * This is called once the connection has been negotiated. It is used
924 * for rsyncd, remote-shell, and local connections.
926 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
928 struct file_list *flist = NULL;
929 int exit_code = 0, exit_code2 = 0;
930 char *local_name = NULL;
932 cleanup_child_pid = pid;
934 set_nonblocking(f_in);
935 set_nonblocking(f_out);
938 io_set_sock_fds(f_in, f_out);
939 setup_protocol(f_out,f_in);
940 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
944 /* We set our stderr file handle to blocking because ssh might have
945 * set it to non-blocking. This can be particularly troublesome if
946 * stderr is a clone of stdout, because ssh would have set our stdout
947 * to non-blocking at the same time (which can easily cause us to lose
948 * output from our print statements). This kluge shouldn't cause ssh
949 * any problems for how we use it. Note also that we delayed setting
950 * this until after the above protocol setup so that we know for sure
951 * that ssh is done twiddling its file descriptors. */
952 set_blocking(STDERR_FILENO);
955 keep_dirlinks = 0; /* Must be disabled on the sender. */
956 if (protocol_version >= 30)
957 io_start_multiplex_out();
959 io_start_buffering_out(f_out);
962 send_filter_list(f_out);
966 if (write_batch && !am_server)
967 start_write_batch(f_out);
968 flist = send_file_list(f_out, argc, argv);
971 rprintf(FINFO,"file list sent\n");
973 if (protocol_version >= 23)
974 io_start_multiplex_in();
976 io_flush(NORMAL_FLUSH);
977 send_files(f_in, f_out);
978 io_flush(FULL_FLUSH);
980 if (protocol_version >= 24)
981 read_final_goodbye(f_in, f_out);
984 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
985 io_flush(FULL_FLUSH);
986 wait_process_with_flush(pid, &exit_code);
989 io_flush(FULL_FLUSH);
990 exit_cleanup(exit_code);
994 if (protocol_version >= 23)
995 io_start_multiplex_in();
996 if (need_messages_from_generator)
997 io_start_multiplex_out();
1003 send_filter_list(read_batch ? -1 : f_out);
1005 if (filesfrom_fd >= 0) {
1006 io_set_filesfrom_fds(filesfrom_fd, f_out);
1010 if (write_batch && !am_server)
1011 start_write_batch(f_in);
1012 flist = recv_file_list(f_in);
1013 if (inc_recurse && file_total == 1)
1014 recv_additional_file_list(f_in);
1016 if (flist && flist->count > 0) {
1017 local_name = get_local_name(flist, argv[0]);
1021 exit_code2 = do_recv(f_in, f_out, local_name);
1029 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1030 io_flush(FULL_FLUSH);
1031 wait_process_with_flush(pid, &exit_code);
1034 return MAX(exit_code, exit_code2);
1037 static int copy_argv(char *argv[])
1041 for (i = 0; argv[i]; i++) {
1042 if (!(argv[i] = strdup(argv[i]))) {
1043 rprintf (FERROR, "out of memory at %s(%d)\n",
1044 __FILE__, __LINE__);
1054 * Start a client for either type of remote connection. Work out
1055 * whether the arguments request a remote shell or rsyncd connection,
1056 * and call the appropriate connection function, then run_client.
1058 * Calls either start_socket_client (for sockets) or do_cmd and
1059 * client_run (for ssh).
1061 static int start_client(int argc, char *argv[])
1064 char *shell_machine = NULL;
1065 char *shell_path = NULL;
1066 char *shell_user = NULL;
1072 /* Don't clobber argv[] so that ps(1) can still show the right
1074 if ((rc = copy_argv(argv)))
1077 if (!read_batch) { /* for read_batch, NO source is specified */
1078 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1079 if (shell_path) { /* source is remote */
1083 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1085 "The source and destination cannot both be remote.\n");
1086 exit_cleanup(RERR_SYNTAX);
1089 if (filesfrom_host && *filesfrom_host
1090 && strcmp(filesfrom_host, shell_machine) != 0) {
1092 "--files-from hostname is not the same as the transfer hostname\n");
1093 exit_cleanup(RERR_SYNTAX);
1097 return start_socket_client(shell_machine,
1101 daemon_over_rsh = 1;
1105 } else { /* source is local, check dest arg */
1115 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1116 if (shell_path && filesfrom_host && *filesfrom_host
1117 && strcmp(filesfrom_host, shell_machine) != 0) {
1119 "--files-from hostname is not the same as the transfer hostname\n");
1120 exit_cleanup(RERR_SYNTAX);
1122 if (!shell_path) { /* no hostspec found, so src & dest are local */
1124 if (filesfrom_host) {
1126 "--files-from cannot be remote when the transfer is local\n");
1127 exit_cleanup(RERR_SYNTAX);
1129 shell_machine = NULL;
1131 } else if (rsync_port) {
1133 return start_socket_client(shell_machine,
1137 daemon_over_rsh = 1;
1140 } else { /* read_batch */
1142 shell_path = argv[argc-1];
1143 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1144 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1145 exit_cleanup(RERR_SYNTAX);
1149 if (password_file && !daemon_over_rsh) {
1150 rprintf(FERROR, "The --password-file option may only be "
1151 "used when accessing an rsync daemon.\n");
1152 exit_cleanup(RERR_SYNTAX);
1155 if (shell_machine) {
1156 p = strrchr(shell_machine,'@');
1159 shell_user = shell_machine;
1160 shell_machine = p+1;
1165 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1166 shell_cmd ? shell_cmd : "",
1167 shell_machine ? shell_machine : "",
1168 shell_user ? shell_user : "",
1169 shell_path ? shell_path : "");
1172 /* for remote source, only single dest arg can remain ... */
1173 if (!am_sender && argc > 1) {
1175 exit_cleanup(RERR_SYNTAX);
1178 /* ... or no dest at all */
1179 if (!am_sender && argc == 0)
1182 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1185 /* if we're running an rsync server on the remote host over a
1186 * remote shell command, we need to do the RSYNCD protocol first */
1187 if (daemon_over_rsh) {
1189 tmpret = start_inband_exchange(shell_user, shell_path,
1195 ret = client_run(f_in, f_out, pid, argc, argv);
1204 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1206 exit_cleanup(RERR_SIGNAL1);
1209 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1215 _exit(RERR_PARTIAL);
1219 RETSIGTYPE remember_children(UNUSED(int val))
1224 /* An empty waitpid() loop was put here by Tridge and we could never
1225 * get him to explain why he put it in, so rather than taking it
1226 * out we're instead saving the child exit statuses for later use.
1227 * The waitpid() loop presumably eliminates all possibility of leaving
1228 * zombie children, maybe that's why he did it. */
1229 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1230 /* save the child's exit status */
1231 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1232 if (pid_stat_table[cnt].pid == 0) {
1233 pid_stat_table[cnt].pid = pid;
1234 pid_stat_table[cnt].status = status;
1240 #ifndef HAVE_SIGACTION
1241 signal(SIGCHLD, remember_children);
1247 * This routine catches signals and tries to send them to gdb.
1249 * Because it's called from inside a signal handler it ought not to
1250 * use too many library routines.
1252 * @todo Perhaps use "screen -X" instead/as well, to help people
1253 * debugging without easy access to X. Perhaps use an environment
1254 * variable, or just call a script?
1256 * @todo The /proc/ magic probably only works on Linux (and
1257 * Solaris?) Can we be more portable?
1259 #ifdef MAINTAINER_MODE
1260 const char *get_panic_action(void)
1262 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1267 return "xterm -display :0 -T Panic -n Panic "
1268 "-e gdb /proc/%d/exe %d";
1273 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1275 * This signal handler is only installed if we were configured with
1276 * --enable-maintainer-mode. Perhaps it should always be on and we
1277 * should just look at the environment variable, but I'm a bit leery
1278 * of a signal sending us into a busy loop.
1280 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1285 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1286 getpid(), getpid());
1288 /* Unless we failed to execute gdb, we allow the process to
1289 * continue. I'm not sure if that's right. */
1290 ret = system(cmd_buf);
1297 int main(int argc,char *argv[])
1300 int orig_argc = argc;
1301 char **orig_argv = argv;
1302 #ifdef HAVE_SIGACTION
1303 # ifdef HAVE_SIGPROCMASK
1306 sigemptyset(&sigmask);
1308 sigact.sa_flags = SA_NOCLDSTOP;
1310 SIGACTMASK(SIGUSR1, sigusr1_handler);
1311 SIGACTMASK(SIGUSR2, sigusr2_handler);
1312 SIGACTMASK(SIGCHLD, remember_children);
1313 #ifdef MAINTAINER_MODE
1314 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1315 SIGACTMASK(SIGFPE, rsync_panic_handler);
1316 SIGACTMASK(SIGABRT, rsync_panic_handler);
1317 SIGACTMASK(SIGBUS, rsync_panic_handler);
1320 starttime = time(NULL);
1321 am_root = (MY_UID() == 0);
1323 memset(&stats, 0, sizeof(stats));
1327 exit_cleanup(RERR_SYNTAX);
1330 /* we set a 0 umask so that correct file permissions can be
1332 orig_umask = umask(0);
1334 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1335 setlocale(LC_CTYPE, "");
1338 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1339 /* FIXME: We ought to call the same error-handling
1340 * code here, rather than relying on getopt. */
1342 exit_cleanup(RERR_SYNTAX);
1345 SIGACTMASK(SIGINT, sig_int);
1346 SIGACTMASK(SIGHUP, sig_int);
1347 SIGACTMASK(SIGTERM, sig_int);
1348 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1349 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1352 /* Ignore SIGPIPE; we consistently check error codes and will
1354 SIGACTION(SIGPIPE, SIG_IGN);
1356 SIGACTION(SIGXFSZ, SIG_IGN);
1359 /* Initialize push_dir here because on some old systems getcwd
1360 * (implemented by forking "pwd" and reading its output) doesn't
1361 * work when there are other child processes. Also, on all systems
1362 * that implement getcwd that way "pwd" can't be found after chroot. */
1367 if ((write_batch || read_batch) && !am_server) {
1369 write_batch_shell_file(orig_argc, orig_argv, argc);
1371 if (read_batch && strcmp(batch_name, "-") == 0)
1372 batch_fd = STDIN_FILENO;
1374 batch_fd = do_open(batch_name,
1375 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1376 : O_RDONLY, S_IRUSR | S_IWUSR);
1379 rsyserr(FERROR, errno, "Batch file %s open error",
1380 full_fname(batch_name));
1381 exit_cleanup(RERR_FILEIO);
1384 read_stream_flags(batch_fd);
1386 write_stream_flags(batch_fd);
1389 if (write_batch < 0)
1392 if (am_daemon && !am_server)
1393 return daemon_main();
1397 exit_cleanup(RERR_SYNTAX);
1401 set_nonblocking(STDIN_FILENO);
1402 set_nonblocking(STDOUT_FILENO);
1404 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1405 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1408 ret = start_client(argc, argv);
1410 exit_cleanup(RERR_STARTCLIENT);