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-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 version 3 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
24 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
34 extern int am_generator;
36 extern int inc_recurse;
37 extern int blocking_io;
38 extern int remove_source_files;
39 extern int daemon_over_rsh;
40 extern int need_messages_from_generator;
41 extern int kluge_around_eof;
43 extern int log_got_error;
45 extern int copy_links;
46 extern int copy_dirlinks;
47 extern int keep_dirlinks;
48 extern int preserve_hard_links;
49 extern int protocol_version;
50 extern int file_total;
52 extern int relative_paths;
53 extern int sanitize_paths;
54 extern int curr_dir_depth;
55 extern int curr_dir_len;
57 extern int rsync_port;
58 extern int whole_file;
59 extern int read_batch;
60 extern int write_batch;
62 extern int filesfrom_fd;
63 extern pid_t cleanup_child_pid;
64 extern struct stats stats;
65 extern char *filesfrom_host;
66 extern char *partial_dir;
67 extern char *basis_dir[];
68 extern char *rsync_path;
69 extern char *shell_cmd;
70 extern char *batch_name;
71 extern char *password_file;
72 extern char curr_dir[MAXPATHLEN];
73 extern struct filter_list_struct server_filter_list;
77 mode_t orig_umask = 0;
78 int batch_gen_fd = -1;
80 /* There's probably never more than at most 2 outstanding child processes,
81 * but set it higher, just in case. */
82 #define MAXCHILDPROCS 7
85 # ifdef HAVE_SIGPROCMASK
86 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
88 # define SIGACTMASK(n,h) SIGACTION(n,h)
90 static struct sigaction sigact;
96 } pid_stat_table[MAXCHILDPROCS];
98 static time_t starttime, endtime;
99 static int64 total_read, total_written;
101 static void show_malloc_stats(void);
103 /* Works like waitpid(), but if we already harvested the child pid in our
104 * remember_children(), we succeed instead of returning an error. */
105 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
110 waited_pid = waitpid(pid, status_ptr, flags);
111 } while (waited_pid == -1 && errno == EINTR);
113 if (waited_pid == -1 && errno == ECHILD) {
114 /* Status of requested child no longer available: check to
115 * see if it was processed by remember_children(). */
117 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
118 if (pid == pid_stat_table[cnt].pid) {
119 *status_ptr = pid_stat_table[cnt].status;
120 pid_stat_table[cnt].pid = 0;
129 /* Wait for a process to exit, calling io_flush while waiting. */
130 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
135 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
137 io_flush(FULL_FLUSH);
140 /* TODO: If the child exited on a signal, then log an
141 * appropriate error message. Perhaps we should also accept a
142 * message describing the purpose of the child. Also indicate
143 * this to the caller so that they know something went wrong. */
144 if (waited_pid < 0) {
145 rsyserr(FERROR, errno, "waitpid");
146 *exit_code_ptr = RERR_WAITCHILD;
147 } else if (!WIFEXITED(status)) {
149 if (WCOREDUMP(status))
150 *exit_code_ptr = RERR_CRASHED;
153 if (WIFSIGNALED(status))
154 *exit_code_ptr = RERR_TERMINATED;
156 *exit_code_ptr = RERR_WAITCHILD;
158 *exit_code_ptr = WEXITSTATUS(status);
161 /* This function gets called from all 3 processes. We want the client side
162 * to actually output the text, but the sender is the only process that has
163 * all the stats we need. So, if we're a client sender, we do the report.
164 * If we're a server sender, we write the stats on the supplied fd. If
165 * we're the client receiver we read the stats from the supplied fd and do
166 * the report. All processes might also generate a set of debug stats, if
167 * the verbose level is high enough (this is the only thing that the
168 * generator process and the server receiver ever do here). */
169 static void handle_stats(int f)
171 endtime = time(NULL);
173 /* Cache two stats because the read/write code can change it. */
174 total_read = stats.total_read;
175 total_written = stats.total_written;
177 if (do_stats && verbose > 1) {
178 /* These come out from every process */
187 if (f == -1 || !am_sender)
193 write_varlong30(f, total_read, 3);
194 write_varlong30(f, total_written, 3);
195 write_varlong30(f, stats.total_size, 3);
196 if (protocol_version >= 29) {
197 write_varlong30(f, stats.flist_buildtime, 3);
198 write_varlong30(f, stats.flist_xfertime, 3);
204 /* this is the client */
206 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
208 else if (!am_sender) {
209 /* Read the first two in opposite order because the meaning of
210 * read/write swaps when switching from sender to receiver. */
211 total_written = read_varlong30(f, 3);
212 total_read = read_varlong30(f, 3);
213 stats.total_size = read_varlong30(f, 3);
214 if (protocol_version >= 29) {
215 stats.flist_buildtime = read_varlong30(f, 3);
216 stats.flist_xfertime = read_varlong30(f, 3);
218 } else if (write_batch) {
219 /* The --read-batch process is going to be a client
220 * receiver, so we need to give it the stats. */
221 write_varlong30(batch_fd, total_read, 3);
222 write_varlong30(batch_fd, total_written, 3);
223 write_varlong30(batch_fd, stats.total_size, 3);
224 if (protocol_version >= 29) {
225 write_varlong30(batch_fd, stats.flist_buildtime, 3);
226 write_varlong30(batch_fd, stats.flist_xfertime, 3);
231 static void output_summary(void)
234 rprintf(FCLIENT, "\n");
235 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
236 rprintf(FINFO,"Number of files transferred: %d\n",
237 stats.num_transferred_files);
238 rprintf(FINFO,"Total file size: %s bytes\n",
239 human_num(stats.total_size));
240 rprintf(FINFO,"Total transferred file size: %s bytes\n",
241 human_num(stats.total_transferred_size));
242 rprintf(FINFO,"Literal data: %s bytes\n",
243 human_num(stats.literal_data));
244 rprintf(FINFO,"Matched data: %s bytes\n",
245 human_num(stats.matched_data));
246 rprintf(FINFO,"File list size: %s\n",
247 human_num(stats.flist_size));
248 if (stats.flist_buildtime) {
250 "File list generation time: %.3f seconds\n",
251 (double)stats.flist_buildtime / 1000);
253 "File list transfer time: %.3f seconds\n",
254 (double)stats.flist_xfertime / 1000);
256 rprintf(FINFO,"Total bytes sent: %s\n",
257 human_num(total_written));
258 rprintf(FINFO,"Total bytes received: %s\n",
259 human_num(total_read));
262 if (verbose || do_stats) {
263 rprintf(FCLIENT, "\n");
265 "sent %s bytes received %s bytes %s bytes/sec\n",
266 human_num(total_written), human_num(total_read),
267 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
268 rprintf(FINFO, "total size is %s speedup is %.2f\n",
269 human_num(stats.total_size),
270 (double)stats.total_size / (total_written+total_read));
279 * If our C library can get malloc statistics, then show them to FINFO
281 static void show_malloc_stats(void)
288 rprintf(FCLIENT, "\n");
289 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
290 getpid(), am_server ? "server " : "",
291 am_daemon ? "daemon " : "", who_am_i());
292 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
294 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
296 rprintf(FINFO, " smblks: %10ld\n",
298 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
300 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
302 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
303 (long)mi.arena + mi.hblkhd);
304 rprintf(FINFO, " usmblks: %10ld\n",
306 rprintf(FINFO, " fsmblks: %10ld\n",
308 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
310 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
312 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
314 #endif /* HAVE_MALLINFO */
318 /* Start the remote shell. cmd may be NULL to use the default. */
319 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
320 int *f_in, int *f_out)
323 char *args[MAX_ARGS];
328 if (!read_batch && !local_server) {
329 char *t, *f, in_quote = '\0';
330 char *rsh_env = getenv(RSYNC_RSH_ENV);
339 for (t = f = cmd; *f; f++) {
342 /* Comparison leaves rooms for server_options(). */
343 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
344 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
345 exit_cleanup(RERR_SYNTAX);
348 while (*f != ' ' || in_quote) {
352 "Missing trailing-%c in remote-shell command.\n",
354 exit_cleanup(RERR_SYNTAX);
359 if (*f == '\'' || *f == '"') {
364 if (*f == in_quote && *++f != in_quote) {
374 /* check to see if we've already been given '-l user' in
375 * the remote-shell command */
376 for (i = 0; i < argc-1; i++) {
377 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
382 /* remsh (on HPUX) takes the arguments the other way around */
383 args[argc++] = machine;
384 if (user && !(daemon_over_rsh && dash_l_set)) {
389 if (user && !(daemon_over_rsh && dash_l_set)) {
393 args[argc++] = machine;
396 args[argc++] = rsync_path;
398 if (blocking_io < 0) {
400 if ((cp = strrchr(cmd, '/')) != NULL)
404 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
408 server_options(args,&argc);
410 if (argc >= MAX_ARGS - 2) {
411 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
412 exit_cleanup(RERR_SYNTAX);
418 if (!daemon_over_rsh && path && *path)
424 for (i = 0; i < argc; i++)
425 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
426 rprintf(FCLIENT, "\n");
430 int from_gen_pipe[2];
431 if (fd_pair(from_gen_pipe) < 0) {
432 rsyserr(FERROR, errno, "pipe");
433 exit_cleanup(RERR_IPC);
435 batch_gen_fd = from_gen_pipe[0];
436 *f_out = from_gen_pipe[1];
438 ret = -1; /* no child pid */
439 } else if (local_server) {
440 /* If the user didn't request --[no-]whole-file, force
441 * it on, but only if we're not batch processing. */
442 if (whole_file < 0 && !write_batch)
444 ret = local_child(argc, args, f_in, f_out, child_main);
446 ret = piped_child(args,f_in,f_out);
454 out_of_memory("do_cmd");
455 return 0; /* not reached */
458 /* The receiving side operates in one of two modes:
460 * 1. it receives any number of files into a destination directory,
461 * placing them according to their names in the file-list.
463 * 2. it receives a single file and saves it using the name in the
464 * destination path instead of its file-list name. This requires a
465 * "local name" for writing out the destination file.
467 * So, our task is to figure out what mode/local-name we need.
468 * For mode 1, we change into the destination directory and return NULL.
469 * For mode 2, we change into the directory containing the destination
470 * file (if we aren't already there) and return the local-name. */
471 static char *get_local_name(struct file_list *flist, char *dest_path)
478 rprintf(FINFO, "get_local_name count=%d %s\n",
479 file_total, NS(dest_path));
482 if (!dest_path || list_only)
485 /* See what currently exists at the destination. */
486 if ((statret = do_stat(dest_path, &st)) == 0) {
487 /* If the destination is a dir, enter it and use mode 1. */
488 if (S_ISDIR(st.st_mode)) {
489 if (!push_dir(dest_path, 0)) {
490 rsyserr(FERROR, errno, "push_dir#1 %s failed",
491 full_fname(dest_path));
492 exit_cleanup(RERR_FILESELECT);
496 if (file_total > 1) {
498 "ERROR: destination must be a directory when"
499 " copying more than 1 file\n");
500 exit_cleanup(RERR_FILESELECT);
502 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
504 "ERROR: cannot overwrite non-directory"
505 " with a directory\n");
506 exit_cleanup(RERR_FILESELECT);
508 } else if (errno != ENOENT) {
509 /* If we don't know what's at the destination, fail. */
510 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
511 full_fname(dest_path));
512 exit_cleanup(RERR_FILESELECT);
515 cp = strrchr(dest_path, '/');
517 /* If we need a destination directory because the transfer is not
518 * of a single non-directory or the user has requested one via a
519 * destination path ending in a slash, create one and use mode 1. */
520 if (file_total > 1 || (cp && !cp[1])) {
521 /* Lop off the final slash (if any). */
527 "ERROR: destination path is not a directory\n");
528 exit_cleanup(RERR_SYNTAX);
531 if (mkdir_defmode(dest_path) != 0) {
532 rsyserr(FERROR, errno, "mkdir %s failed",
533 full_fname(dest_path));
534 exit_cleanup(RERR_FILEIO);
540 rprintf(FINFO, "created directory %s\n", dest_path);
543 /* Indicate that dest dir doesn't really exist. */
547 if (!push_dir(dest_path, dry_run > 1)) {
548 rsyserr(FERROR, errno, "push_dir#2 %s failed",
549 full_fname(dest_path));
550 exit_cleanup(RERR_FILESELECT);
556 /* Otherwise, we are writing a single file, possibly on top of an
557 * existing non-directory. Change to the item's parent directory
558 * (if it has a path component), return the basename of the
559 * destination file as the local name, and use mode 2. */
567 if (!push_dir(dest_path, 0)) {
568 rsyserr(FERROR, errno, "push_dir#3 %s failed",
569 full_fname(dest_path));
570 exit_cleanup(RERR_FILESELECT);
577 /* Call this if the destination dir (which is assumed to be in curr_dir)
578 * does not yet exist and we can't create it due to being in dry-run
579 * mode. We'll fix dirs that can be relative to the non-existent dir. */
580 static void fix_basis_dirs(void)
582 char **dir, *new, *slash;
588 slash = strrchr(curr_dir, '/');
590 for (dir = basis_dir; *dir; dir++) {
593 len = curr_dir_len + 1 + strlen(*dir) + 1;
594 if (!(new = new_array(char, len)))
595 out_of_memory("fix_basis_dirs");
596 if (slash && strncmp(*dir, "../", 3) == 0) {
597 /* We want to remove only one leading "../" prefix for
598 * the directory we couldn't create in dry-run mode:
599 * this ensures that any other ".." references get
600 * evaluated the same as they would for a live copy. */
602 pathjoin(new, len, curr_dir, *dir + 3);
605 pathjoin(new, len, curr_dir, *dir);
610 /* This is only called by the sender. */
611 static void read_final_goodbye(int f_in)
615 char xname[MAXPATHLEN];
617 if (protocol_version < 29)
620 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
625 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
627 exit_cleanup(RERR_PROTOCOL);
631 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
633 struct file_list *flist;
637 rprintf(FINFO, "server_sender starting pid=%ld\n",
641 if (am_daemon && lp_write_only(module_id)) {
642 rprintf(FERROR, "ERROR: module is write only\n");
643 exit_cleanup(RERR_SYNTAX);
646 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
648 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
649 remove_source_files == 1 ? "source" : "sent");
650 exit_cleanup(RERR_SYNTAX);
654 if (!relative_paths) {
655 if (!push_dir(dir, 0)) {
656 rsyserr(FERROR, errno, "push_dir#3 %s failed",
658 exit_cleanup(RERR_FILESELECT);
664 if (argc == 0 && (recurse || list_only)) {
670 flist = send_file_list(f_out,argc,argv);
671 if (!flist || flist->used == 0)
674 io_start_buffering_in(f_in);
676 send_files(f_in, f_out);
677 io_flush(FULL_FLUSH);
679 if (protocol_version >= 24)
680 read_final_goodbye(f_in);
681 io_flush(FULL_FLUSH);
686 static int do_recv(int f_in, int f_out, char *local_name)
692 /* The receiving side mustn't obey this, or an existing symlink that
693 * points to an identical file won't be replaced by the referent. */
694 copy_links = copy_dirlinks = 0;
696 #ifdef SUPPORT_HARD_LINKS
697 if (preserve_hard_links)
701 if (fd_pair(error_pipe) < 0) {
702 rsyserr(FERROR, errno, "pipe failed in do_recv");
703 exit_cleanup(RERR_IPC);
706 io_flush(NORMAL_FLUSH);
708 if ((pid = do_fork()) == -1) {
709 rsyserr(FERROR, errno, "fork failed in do_recv");
710 exit_cleanup(RERR_IPC);
714 close(error_pipe[0]);
718 /* we can't let two processes write to the socket at one time */
719 io_end_multiplex_out();
721 /* set place to send errors */
722 set_msg_fd_out(error_pipe[1]);
723 io_start_buffering_out(error_pipe[1]);
725 recv_files(f_in, local_name);
726 io_flush(FULL_FLUSH);
729 send_msg(MSG_DONE, "", 1, 0);
730 write_varlong(error_pipe[1], stats.total_read, 3);
731 io_flush(FULL_FLUSH);
733 /* Handle any keep-alive packets from the post-processing work
734 * that the generator does. */
735 if (protocol_version >= 29) {
738 char xname[MAXPATHLEN];
740 kluge_around_eof = -1;
742 /* This should only get stopped via a USR2 signal. */
743 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
746 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
748 exit_cleanup(RERR_PROTOCOL);
751 /* Finally, we go to sleep until our parent kills us with a
752 * USR2 signal. We sleep for a short time, as on some OSes
753 * a signal won't interrupt a sleep! */
760 io_end_multiplex_in();
761 if (write_batch && !am_server)
764 close(error_pipe[1]);
768 io_start_buffering_out(f_out);
770 set_msg_fd_in(error_pipe[0]);
771 io_start_buffering_in(error_pipe[0]);
773 generate_files(f_out, local_name);
776 io_flush(FULL_FLUSH);
777 if (protocol_version >= 24) {
778 /* send a final goodbye message */
779 write_ndx(f_out, NDX_DONE);
781 io_flush(FULL_FLUSH);
785 wait_process_with_flush(pid, &exit_code);
789 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
792 struct file_list *flist;
793 char *local_name = NULL;
795 int save_verbose = verbose;
797 if (filesfrom_fd >= 0) {
798 /* We can't mix messages with files-from data on the socket,
799 * so temporarily turn off verbose messages. */
804 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
805 argc, (long)getpid());
808 if (am_daemon && lp_read_only(module_id)) {
809 rprintf(FERROR,"ERROR: module is read only\n");
810 exit_cleanup(RERR_SYNTAX);
818 if (!am_daemon && !push_dir(dir, 0)) {
819 rsyserr(FERROR, errno, "push_dir#4 %s failed",
821 exit_cleanup(RERR_FILESELECT);
825 if (protocol_version >= 30)
826 io_start_multiplex_in();
828 io_start_buffering_in(f_in);
829 recv_filter_list(f_in);
831 if (filesfrom_fd >= 0) {
832 /* We need to send the files-from names to the sender at the
833 * same time that we receive the file-list from them, so we
834 * need the IO routines to automatically write out the names
835 * onto our f_out socket as we read the file-list. This
836 * avoids both deadlock and extra delays/buffers. */
837 io_set_filesfrom_fds(filesfrom_fd, f_out);
841 flist = recv_file_list(f_in);
843 rprintf(FERROR,"server_recv: recv_file_list error\n");
844 exit_cleanup(RERR_FILESELECT);
846 if (inc_recurse && file_total == 1)
847 recv_additional_file_list(f_in);
848 verbose = save_verbose;
851 local_name = get_local_name(flist,argv[0]);
853 /* Now that we know what our destination directory turned out to be,
854 * we can sanitize the --link-/copy-/compare-dest args correctly. */
855 if (sanitize_paths) {
857 for (dir = basis_dir; *dir; dir++) {
858 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
861 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
866 if (server_filter_list.head) {
868 struct filter_list_struct *elp = &server_filter_list;
870 for (dir = basis_dir; *dir; dir++) {
871 if (check_filter(elp, *dir, 1) < 0)
872 goto options_rejected;
874 if (partial_dir && *partial_dir == '/'
875 && check_filter(elp, partial_dir, 1) < 0) {
878 "Your options have been rejected by the server.\n");
879 exit_cleanup(RERR_SYNTAX);
883 exit_code = do_recv(f_in, f_out, local_name);
884 exit_cleanup(exit_code);
888 int child_main(int argc, char *argv[])
890 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
895 void start_server(int f_in, int f_out, int argc, char *argv[])
897 set_nonblocking(f_in);
898 set_nonblocking(f_out);
900 io_set_sock_fds(f_in, f_out);
901 setup_protocol(f_out, f_in);
906 if (protocol_version >= 23)
907 io_start_multiplex_out();
910 keep_dirlinks = 0; /* Must be disabled on the sender. */
911 if (need_messages_from_generator)
912 io_start_multiplex_in();
913 recv_filter_list(f_in);
914 do_server_sender(f_in, f_out, argc, argv);
916 do_server_recv(f_in, f_out, argc, argv);
922 * This is called once the connection has been negotiated. It is used
923 * for rsyncd, remote-shell, and local connections.
925 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
927 struct file_list *flist = NULL;
928 int exit_code = 0, exit_code2 = 0;
929 char *local_name = NULL;
931 cleanup_child_pid = pid;
933 set_nonblocking(f_in);
934 set_nonblocking(f_out);
937 io_set_sock_fds(f_in, f_out);
938 setup_protocol(f_out,f_in);
943 /* We set our stderr file handle to blocking because ssh might have
944 * set it to non-blocking. This can be particularly troublesome if
945 * stderr is a clone of stdout, because ssh would have set our stdout
946 * to non-blocking at the same time (which can easily cause us to lose
947 * output from our print statements). This kluge shouldn't cause ssh
948 * any problems for how we use it. Note also that we delayed setting
949 * this until after the above protocol setup so that we know for sure
950 * that ssh is done twiddling its file descriptors. */
951 set_blocking(STDERR_FILENO);
954 keep_dirlinks = 0; /* Must be disabled on the sender. */
955 if (protocol_version >= 30)
956 io_start_multiplex_out();
958 io_start_buffering_out(f_out);
961 send_filter_list(f_out);
965 if (write_batch && !am_server)
966 start_write_batch(f_out);
967 flist = send_file_list(f_out, argc, argv);
970 rprintf(FINFO,"file list sent\n");
972 if (protocol_version >= 23)
973 io_start_multiplex_in();
975 io_flush(NORMAL_FLUSH);
976 send_files(f_in, f_out);
977 io_flush(FULL_FLUSH);
979 if (protocol_version >= 24)
980 read_final_goodbye(f_in);
983 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
984 io_flush(FULL_FLUSH);
985 wait_process_with_flush(pid, &exit_code);
988 io_flush(FULL_FLUSH);
989 exit_cleanup(exit_code);
993 if (protocol_version >= 23)
994 io_start_multiplex_in();
995 if (need_messages_from_generator)
996 io_start_multiplex_out();
1002 send_filter_list(read_batch ? -1 : f_out);
1004 if (filesfrom_fd >= 0) {
1005 io_set_filesfrom_fds(filesfrom_fd, f_out);
1009 if (write_batch && !am_server)
1010 start_write_batch(f_in);
1011 flist = recv_file_list(f_in);
1012 if (inc_recurse && file_total == 1)
1013 recv_additional_file_list(f_in);
1015 if (flist && flist->used > 0) {
1016 local_name = get_local_name(flist, argv[0]);
1020 exit_code2 = do_recv(f_in, f_out, local_name);
1028 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1029 io_flush(FULL_FLUSH);
1030 wait_process_with_flush(pid, &exit_code);
1033 return MAX(exit_code, exit_code2);
1036 static int copy_argv(char *argv[])
1040 for (i = 0; argv[i]; i++) {
1041 if (!(argv[i] = strdup(argv[i]))) {
1042 rprintf (FERROR, "out of memory at %s(%d)\n",
1043 __FILE__, __LINE__);
1053 * Start a client for either type of remote connection. Work out
1054 * whether the arguments request a remote shell or rsyncd connection,
1055 * and call the appropriate connection function, then run_client.
1057 * Calls either start_socket_client (for sockets) or do_cmd and
1058 * client_run (for ssh).
1060 static int start_client(int argc, char *argv[])
1063 char *shell_machine = NULL;
1064 char *shell_path = NULL;
1065 char *shell_user = NULL;
1071 /* Don't clobber argv[] so that ps(1) can still show the right
1073 if ((rc = copy_argv(argv)))
1076 if (!read_batch) { /* for read_batch, NO source is specified */
1077 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1078 if (shell_path) { /* source is remote */
1082 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1084 "The source and destination cannot both be remote.\n");
1085 exit_cleanup(RERR_SYNTAX);
1088 if (filesfrom_host && *filesfrom_host
1089 && strcmp(filesfrom_host, shell_machine) != 0) {
1091 "--files-from hostname is not the same as the transfer hostname\n");
1092 exit_cleanup(RERR_SYNTAX);
1096 return start_socket_client(shell_machine,
1100 daemon_over_rsh = 1;
1104 } else { /* source is local, check dest arg */
1114 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1115 if (shell_path && filesfrom_host && *filesfrom_host
1116 && strcmp(filesfrom_host, shell_machine) != 0) {
1118 "--files-from hostname is not the same as the transfer hostname\n");
1119 exit_cleanup(RERR_SYNTAX);
1121 if (!shell_path) { /* no hostspec found, so src & dest are local */
1123 if (filesfrom_host) {
1125 "--files-from cannot be remote when the transfer is local\n");
1126 exit_cleanup(RERR_SYNTAX);
1128 shell_machine = NULL;
1130 } else if (rsync_port) {
1132 return start_socket_client(shell_machine,
1136 daemon_over_rsh = 1;
1139 } else { /* read_batch */
1141 shell_path = argv[argc-1];
1142 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1143 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1144 exit_cleanup(RERR_SYNTAX);
1148 if (password_file && !daemon_over_rsh) {
1149 rprintf(FERROR, "The --password-file option may only be "
1150 "used when accessing an rsync daemon.\n");
1151 exit_cleanup(RERR_SYNTAX);
1154 if (shell_machine) {
1155 p = strrchr(shell_machine,'@');
1158 shell_user = shell_machine;
1159 shell_machine = p+1;
1164 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1165 shell_cmd ? shell_cmd : "",
1166 shell_machine ? shell_machine : "",
1167 shell_user ? shell_user : "",
1168 shell_path ? shell_path : "");
1171 /* for remote source, only single dest arg can remain ... */
1172 if (!am_sender && argc > 1) {
1174 exit_cleanup(RERR_SYNTAX);
1177 /* ... or no dest at all */
1178 if (!am_sender && argc == 0)
1181 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1184 /* if we're running an rsync server on the remote host over a
1185 * remote shell command, we need to do the RSYNCD protocol first */
1186 if (daemon_over_rsh) {
1188 tmpret = start_inband_exchange(shell_user, shell_path,
1194 ret = client_run(f_in, f_out, pid, argc, argv);
1203 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1205 exit_cleanup(RERR_SIGNAL1);
1208 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1214 _exit(RERR_PARTIAL);
1218 RETSIGTYPE remember_children(UNUSED(int val))
1223 /* An empty waitpid() loop was put here by Tridge and we could never
1224 * get him to explain why he put it in, so rather than taking it
1225 * out we're instead saving the child exit statuses for later use.
1226 * The waitpid() loop presumably eliminates all possibility of leaving
1227 * zombie children, maybe that's why he did it. */
1228 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1229 /* save the child's exit status */
1230 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1231 if (pid_stat_table[cnt].pid == 0) {
1232 pid_stat_table[cnt].pid = pid;
1233 pid_stat_table[cnt].status = status;
1239 #ifndef HAVE_SIGACTION
1240 signal(SIGCHLD, remember_children);
1246 * This routine catches signals and tries to send them to gdb.
1248 * Because it's called from inside a signal handler it ought not to
1249 * use too many library routines.
1251 * @todo Perhaps use "screen -X" instead/as well, to help people
1252 * debugging without easy access to X. Perhaps use an environment
1253 * variable, or just call a script?
1255 * @todo The /proc/ magic probably only works on Linux (and
1256 * Solaris?) Can we be more portable?
1258 #ifdef MAINTAINER_MODE
1259 const char *get_panic_action(void)
1261 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1266 return "xterm -display :0 -T Panic -n Panic "
1267 "-e gdb /proc/%d/exe %d";
1272 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1274 * This signal handler is only installed if we were configured with
1275 * --enable-maintainer-mode. Perhaps it should always be on and we
1276 * should just look at the environment variable, but I'm a bit leery
1277 * of a signal sending us into a busy loop.
1279 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1284 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1285 getpid(), getpid());
1287 /* Unless we failed to execute gdb, we allow the process to
1288 * continue. I'm not sure if that's right. */
1289 ret = system(cmd_buf);
1296 int main(int argc,char *argv[])
1299 int orig_argc = argc;
1300 char **orig_argv = argv;
1301 #ifdef HAVE_SIGACTION
1302 # ifdef HAVE_SIGPROCMASK
1305 sigemptyset(&sigmask);
1307 sigact.sa_flags = SA_NOCLDSTOP;
1309 SIGACTMASK(SIGUSR1, sigusr1_handler);
1310 SIGACTMASK(SIGUSR2, sigusr2_handler);
1311 SIGACTMASK(SIGCHLD, remember_children);
1312 #ifdef MAINTAINER_MODE
1313 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1314 SIGACTMASK(SIGFPE, rsync_panic_handler);
1315 SIGACTMASK(SIGABRT, rsync_panic_handler);
1316 SIGACTMASK(SIGBUS, rsync_panic_handler);
1319 starttime = time(NULL);
1320 am_root = (MY_UID() == 0);
1322 memset(&stats, 0, sizeof(stats));
1326 exit_cleanup(RERR_SYNTAX);
1329 /* we set a 0 umask so that correct file permissions can be
1331 orig_umask = umask(0);
1333 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1334 setlocale(LC_CTYPE, "");
1337 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1338 /* FIXME: We ought to call the same error-handling
1339 * code here, rather than relying on getopt. */
1341 exit_cleanup(RERR_SYNTAX);
1344 SIGACTMASK(SIGINT, sig_int);
1345 SIGACTMASK(SIGHUP, sig_int);
1346 SIGACTMASK(SIGTERM, sig_int);
1347 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1348 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1351 /* Ignore SIGPIPE; we consistently check error codes and will
1353 SIGACTION(SIGPIPE, SIG_IGN);
1355 SIGACTION(SIGXFSZ, SIG_IGN);
1358 /* Initialize push_dir here because on some old systems getcwd
1359 * (implemented by forking "pwd" and reading its output) doesn't
1360 * work when there are other child processes. Also, on all systems
1361 * that implement getcwd that way "pwd" can't be found after chroot. */
1366 if ((write_batch || read_batch) && !am_server) {
1368 write_batch_shell_file(orig_argc, orig_argv, argc);
1370 if (read_batch && strcmp(batch_name, "-") == 0)
1371 batch_fd = STDIN_FILENO;
1373 batch_fd = do_open(batch_name,
1374 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1375 : O_RDONLY, S_IRUSR | S_IWUSR);
1378 rsyserr(FERROR, errno, "Batch file %s open error",
1379 full_fname(batch_name));
1380 exit_cleanup(RERR_FILEIO);
1383 read_stream_flags(batch_fd);
1385 write_stream_flags(batch_fd);
1388 if (write_batch < 0)
1391 if (am_daemon && !am_server)
1392 return daemon_main();
1396 exit_cleanup(RERR_SYNTAX);
1400 set_nonblocking(STDIN_FILENO);
1401 set_nonblocking(STDOUT_FILENO);
1403 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1404 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1407 ret = start_client(argc, argv);
1409 exit_cleanup(RERR_STARTCLIENT);