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 as published by
11 * the Free Software Foundation; either version 3 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, visit the http://fsf.org website.
26 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
36 extern int am_generator;
38 extern int inc_recurse;
39 extern int blocking_io;
40 extern int remove_source_files;
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 protect_args;
54 extern int relative_paths;
55 extern int sanitize_paths;
56 extern int curr_dir_depth;
57 extern int curr_dir_len;
59 extern int rsync_port;
60 extern int whole_file;
61 extern int read_batch;
62 extern int write_batch;
64 extern int filesfrom_fd;
65 extern pid_t cleanup_child_pid;
66 extern struct stats stats;
67 extern char *filesfrom_host;
68 extern char *partial_dir;
69 extern char *basis_dir[];
70 extern char *rsync_path;
71 extern char *shell_cmd;
72 extern char *batch_name;
73 extern char *password_file;
74 extern char curr_dir[MAXPATHLEN];
75 extern struct file_list *first_flist;
76 extern struct filter_list_struct server_filter_list;
78 extern iconv_t ic_send;
82 int daemon_over_rsh = 0;
83 mode_t orig_umask = 0;
84 int batch_gen_fd = -1;
86 /* There's probably never more than at most 2 outstanding child processes,
87 * but set it higher, just in case. */
88 #define MAXCHILDPROCS 7
91 # ifdef HAVE_SIGPROCMASK
92 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
94 # define SIGACTMASK(n,h) SIGACTION(n,h)
96 static struct sigaction sigact;
102 } pid_stat_table[MAXCHILDPROCS];
104 static time_t starttime, endtime;
105 static int64 total_read, total_written;
107 static void show_malloc_stats(void);
109 /* Works like waitpid(), but if we already harvested the child pid in our
110 * remember_children(), we succeed instead of returning an error. */
111 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
116 waited_pid = waitpid(pid, status_ptr, flags);
117 } while (waited_pid == -1 && errno == EINTR);
119 if (waited_pid == -1 && errno == ECHILD) {
120 /* Status of requested child no longer available: check to
121 * see if it was processed by remember_children(). */
123 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
124 if (pid == pid_stat_table[cnt].pid) {
125 *status_ptr = pid_stat_table[cnt].status;
126 pid_stat_table[cnt].pid = 0;
135 /* Wait for a process to exit, calling io_flush while waiting. */
136 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
141 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
143 io_flush(FULL_FLUSH);
146 /* TODO: If the child exited on a signal, then log an
147 * appropriate error message. Perhaps we should also accept a
148 * message describing the purpose of the child. Also indicate
149 * this to the caller so that they know something went wrong. */
150 if (waited_pid < 0) {
151 rsyserr(FERROR, errno, "waitpid");
152 *exit_code_ptr = RERR_WAITCHILD;
153 } else if (!WIFEXITED(status)) {
155 if (WCOREDUMP(status))
156 *exit_code_ptr = RERR_CRASHED;
159 if (WIFSIGNALED(status))
160 *exit_code_ptr = RERR_TERMINATED;
162 *exit_code_ptr = RERR_WAITCHILD;
164 *exit_code_ptr = WEXITSTATUS(status);
167 /* This function gets called from all 3 processes. We want the client side
168 * to actually output the text, but the sender is the only process that has
169 * all the stats we need. So, if we're a client sender, we do the report.
170 * If we're a server sender, we write the stats on the supplied fd. If
171 * we're the client receiver we read the stats from the supplied fd and do
172 * the report. All processes might also generate a set of debug stats, if
173 * the verbose level is high enough (this is the only thing that the
174 * generator process and the server receiver ever do here). */
175 static void handle_stats(int f)
177 endtime = time(NULL);
179 /* Cache two stats because the read/write code can change it. */
180 total_read = stats.total_read;
181 total_written = stats.total_written;
183 if (do_stats && verbose > 1) {
184 /* These come out from every process */
193 if (f == -1 || !am_sender)
199 write_varlong30(f, total_read, 3);
200 write_varlong30(f, total_written, 3);
201 write_varlong30(f, stats.total_size, 3);
202 if (protocol_version >= 29) {
203 write_varlong30(f, stats.flist_buildtime, 3);
204 write_varlong30(f, stats.flist_xfertime, 3);
210 /* this is the client */
212 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
214 else if (!am_sender) {
215 /* Read the first two in opposite order because the meaning of
216 * read/write swaps when switching from sender to receiver. */
217 total_written = read_varlong30(f, 3);
218 total_read = read_varlong30(f, 3);
219 stats.total_size = read_varlong30(f, 3);
220 if (protocol_version >= 29) {
221 stats.flist_buildtime = read_varlong30(f, 3);
222 stats.flist_xfertime = read_varlong30(f, 3);
224 } else if (write_batch) {
225 /* The --read-batch process is going to be a client
226 * receiver, so we need to give it the stats. */
227 write_varlong30(batch_fd, total_read, 3);
228 write_varlong30(batch_fd, total_written, 3);
229 write_varlong30(batch_fd, stats.total_size, 3);
230 if (protocol_version >= 29) {
231 write_varlong30(batch_fd, stats.flist_buildtime, 3);
232 write_varlong30(batch_fd, stats.flist_xfertime, 3);
237 static void output_summary(void)
240 rprintf(FCLIENT, "\n");
241 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
242 rprintf(FINFO,"Number of files transferred: %d\n",
243 stats.num_transferred_files);
244 rprintf(FINFO,"Total file size: %s bytes\n",
245 human_num(stats.total_size));
246 rprintf(FINFO,"Total transferred file size: %s bytes\n",
247 human_num(stats.total_transferred_size));
248 rprintf(FINFO,"Literal data: %s bytes\n",
249 human_num(stats.literal_data));
250 rprintf(FINFO,"Matched data: %s bytes\n",
251 human_num(stats.matched_data));
252 rprintf(FINFO,"File list size: %s\n",
253 human_num(stats.flist_size));
254 if (stats.flist_buildtime) {
256 "File list generation time: %.3f seconds\n",
257 (double)stats.flist_buildtime / 1000);
259 "File list transfer time: %.3f seconds\n",
260 (double)stats.flist_xfertime / 1000);
262 rprintf(FINFO,"Total bytes sent: %s\n",
263 human_num(total_written));
264 rprintf(FINFO,"Total bytes received: %s\n",
265 human_num(total_read));
268 if (verbose || do_stats) {
269 rprintf(FCLIENT, "\n");
271 "sent %s bytes received %s bytes %s bytes/sec\n",
272 human_num(total_written), human_num(total_read),
273 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
274 rprintf(FINFO, "total size is %s speedup is %.2f\n",
275 human_num(stats.total_size),
276 (double)stats.total_size / (total_written+total_read));
285 * If our C library can get malloc statistics, then show them to FINFO
287 static void show_malloc_stats(void)
294 rprintf(FCLIENT, "\n");
295 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
296 getpid(), am_server ? "server " : "",
297 am_daemon ? "daemon " : "", who_am_i());
298 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
300 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
302 rprintf(FINFO, " smblks: %10ld\n",
304 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
306 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
308 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
309 (long)mi.arena + mi.hblkhd);
310 rprintf(FINFO, " usmblks: %10ld\n",
312 rprintf(FINFO, " fsmblks: %10ld\n",
314 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
316 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
318 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
320 #endif /* HAVE_MALLINFO */
324 /* Start the remote shell. cmd may be NULL to use the default. */
325 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
326 int *f_in_p, int *f_out_p)
329 char *args[MAX_ARGS];
334 if (!read_batch && !local_server) {
335 char *t, *f, in_quote = '\0';
336 char *rsh_env = getenv(RSYNC_RSH_ENV);
345 for (t = f = cmd; *f; f++) {
348 /* Comparison leaves rooms for server_options(). */
349 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
352 while (*f != ' ' || in_quote) {
356 "Missing trailing-%c in remote-shell command.\n",
358 exit_cleanup(RERR_SYNTAX);
363 if (*f == '\'' || *f == '"') {
368 if (*f == in_quote && *++f != in_quote) {
378 /* check to see if we've already been given '-l user' in
379 * the remote-shell command */
380 for (i = 0; i < argc-1; i++) {
381 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
386 /* remsh (on HPUX) takes the arguments the other way around */
387 args[argc++] = machine;
388 if (user && !(daemon_over_rsh && dash_l_set)) {
393 if (user && !(daemon_over_rsh && dash_l_set)) {
397 args[argc++] = machine;
400 args[argc++] = rsync_path;
402 if (blocking_io < 0) {
404 if ((cp = strrchr(cmd, '/')) != NULL)
408 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
412 server_options(args,&argc);
414 if (argc >= MAX_ARGS - 2)
420 if (!daemon_over_rsh) {
421 while (remote_argc > 0) {
422 if (argc >= MAX_ARGS - 1) {
424 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
425 exit_cleanup(RERR_SYNTAX);
427 args[argc++] = *remote_argv++;
435 for (i = 0; i < argc; i++)
436 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
437 rprintf(FCLIENT, "\n");
441 int from_gen_pipe[2];
442 if (fd_pair(from_gen_pipe) < 0) {
443 rsyserr(FERROR, errno, "pipe");
444 exit_cleanup(RERR_IPC);
446 batch_gen_fd = from_gen_pipe[0];
447 *f_out_p = from_gen_pipe[1];
449 ret = -1; /* no child pid */
450 } else if (local_server) {
451 /* If the user didn't request --[no-]whole-file, force
452 * it on, but only if we're not batch processing. */
453 if (whole_file < 0 && !write_batch)
455 ret = local_child(argc, args, f_in_p, f_out_p, child_main);
460 int convert = ic_send != (iconv_t)-1;
464 alloc_xbuf(&outbuf, 1024);
467 ret = piped_child(args, f_in_p, f_out_p);
469 for (i = 0; args[i]; i++) {} /* find first NULL */
470 args[i] = "rsync"; /* set a new arg0 */
472 print_child_argv("protected args:", args + i + 1);
477 INIT_XBUF_STRLEN(inbuf, args[i]);
478 iconvbufs(ic_send, &inbuf, &outbuf,
479 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
480 outbuf.buf[outbuf.len] = '\0';
481 write_buf(fd, outbuf.buf, outbuf.len + 1);
485 write_buf(fd, args[i], strlen(args[i]) + 1);
493 ret = piped_child(args, f_in_p, f_out_p);
502 out_of_memory("do_cmd");
503 return 0; /* not reached */
506 /* The receiving side operates in one of two modes:
508 * 1. it receives any number of files into a destination directory,
509 * placing them according to their names in the file-list.
511 * 2. it receives a single file and saves it using the name in the
512 * destination path instead of its file-list name. This requires a
513 * "local name" for writing out the destination file.
515 * So, our task is to figure out what mode/local-name we need.
516 * For mode 1, we change into the destination directory and return NULL.
517 * For mode 2, we change into the directory containing the destination
518 * file (if we aren't already there) and return the local-name. */
519 static char *get_local_name(struct file_list *flist, char *dest_path)
526 rprintf(FINFO, "get_local_name count=%d %s\n",
527 file_total, NS(dest_path));
530 if (!dest_path || list_only)
533 /* See what currently exists at the destination. */
534 if ((statret = do_stat(dest_path, &st)) == 0) {
535 /* If the destination is a dir, enter it and use mode 1. */
536 if (S_ISDIR(st.st_mode)) {
537 if (!push_dir(dest_path, 0)) {
538 rsyserr(FERROR, errno, "push_dir#1 %s failed",
539 full_fname(dest_path));
540 exit_cleanup(RERR_FILESELECT);
544 if (file_total > 1) {
546 "ERROR: destination must be a directory when"
547 " copying more than 1 file\n");
548 exit_cleanup(RERR_FILESELECT);
550 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
552 "ERROR: cannot overwrite non-directory"
553 " with a directory\n");
554 exit_cleanup(RERR_FILESELECT);
556 } else if (errno != ENOENT) {
557 /* If we don't know what's at the destination, fail. */
558 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
559 full_fname(dest_path));
560 exit_cleanup(RERR_FILESELECT);
563 cp = strrchr(dest_path, '/');
565 /* If we need a destination directory because the transfer is not
566 * of a single non-directory or the user has requested one via a
567 * destination path ending in a slash, create one and use mode 1. */
568 if (file_total > 1 || (cp && !cp[1])) {
569 /* Lop off the final slash (if any). */
575 "ERROR: destination path is not a directory\n");
576 exit_cleanup(RERR_SYNTAX);
579 if (mkdir_defmode(dest_path) != 0) {
580 rsyserr(FERROR, errno, "mkdir %s failed",
581 full_fname(dest_path));
582 exit_cleanup(RERR_FILEIO);
585 if (flist->high >= flist->low
586 && strcmp(flist->files[flist->low]->basename, ".") == 0)
587 flist->files[0]->flags |= FLAG_DIR_CREATED;
590 rprintf(FINFO, "created directory %s\n", dest_path);
593 /* Indicate that dest dir doesn't really exist. */
597 if (!push_dir(dest_path, dry_run > 1)) {
598 rsyserr(FERROR, errno, "push_dir#2 %s failed",
599 full_fname(dest_path));
600 exit_cleanup(RERR_FILESELECT);
606 /* Otherwise, we are writing a single file, possibly on top of an
607 * existing non-directory. Change to the item's parent directory
608 * (if it has a path component), return the basename of the
609 * destination file as the local name, and use mode 2. */
617 if (!push_dir(dest_path, 0)) {
618 rsyserr(FERROR, errno, "push_dir#3 %s failed",
619 full_fname(dest_path));
620 exit_cleanup(RERR_FILESELECT);
627 /* Call this if the destination dir (which is assumed to be in curr_dir)
628 * does not yet exist and we can't create it due to being in dry-run
629 * mode. We'll fix dirs that can be relative to the non-existent dir. */
630 static void fix_basis_dirs(void)
632 char **dir, *new, *slash;
638 slash = strrchr(curr_dir, '/');
640 for (dir = basis_dir; *dir; dir++) {
643 len = curr_dir_len + 1 + strlen(*dir) + 1;
644 if (!(new = new_array(char, len)))
645 out_of_memory("fix_basis_dirs");
646 if (slash && strncmp(*dir, "../", 3) == 0) {
647 /* We want to remove only one leading "../" prefix for
648 * the directory we couldn't create in dry-run mode:
649 * this ensures that any other ".." references get
650 * evaluated the same as they would for a live copy. */
652 pathjoin(new, len, curr_dir, *dir + 3);
655 pathjoin(new, len, curr_dir, *dir);
660 /* This is only called by the sender. */
661 static void read_final_goodbye(int f_in)
665 char xname[MAXPATHLEN];
667 if (protocol_version < 29)
670 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
675 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
677 exit_cleanup(RERR_PROTOCOL);
681 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
683 struct file_list *flist;
687 rprintf(FINFO, "server_sender starting pid=%ld\n",
691 if (am_daemon && lp_write_only(module_id)) {
692 rprintf(FERROR, "ERROR: module is write only\n");
693 exit_cleanup(RERR_SYNTAX);
696 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
698 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
699 remove_source_files == 1 ? "source" : "sent");
700 exit_cleanup(RERR_SYNTAX);
704 if (!relative_paths) {
705 if (!push_dir(dir, 0)) {
706 rsyserr(FERROR, errno, "push_dir#3 %s failed",
708 exit_cleanup(RERR_FILESELECT);
714 if (argc == 0 && (recurse || list_only)) {
720 flist = send_file_list(f_out,argc,argv);
721 if (!flist || flist->used == 0)
724 io_start_buffering_in(f_in);
726 send_files(f_in, f_out);
727 io_flush(FULL_FLUSH);
729 if (protocol_version >= 24)
730 read_final_goodbye(f_in);
731 io_flush(FULL_FLUSH);
736 static int do_recv(int f_in, int f_out, char *local_name)
742 /* The receiving side mustn't obey this, or an existing symlink that
743 * points to an identical file won't be replaced by the referent. */
744 copy_links = copy_dirlinks = 0;
746 #ifdef SUPPORT_HARD_LINKS
747 if (preserve_hard_links && !inc_recurse)
748 match_hard_links(first_flist);
751 if (fd_pair(error_pipe) < 0) {
752 rsyserr(FERROR, errno, "pipe failed in do_recv");
753 exit_cleanup(RERR_IPC);
756 io_flush(NORMAL_FLUSH);
758 if ((pid = do_fork()) == -1) {
759 rsyserr(FERROR, errno, "fork failed in do_recv");
760 exit_cleanup(RERR_IPC);
764 close(error_pipe[0]);
768 /* we can't let two processes write to the socket at one time */
769 io_end_multiplex_out();
771 /* set place to send errors */
772 set_msg_fd_out(error_pipe[1]);
773 io_start_buffering_out(error_pipe[1]);
775 recv_files(f_in, local_name);
776 io_flush(FULL_FLUSH);
779 send_msg(MSG_DONE, "", 1, 0);
780 write_varlong(error_pipe[1], stats.total_read, 3);
781 io_flush(FULL_FLUSH);
783 /* Handle any keep-alive packets from the post-processing work
784 * that the generator does. */
785 if (protocol_version >= 29) {
788 char xname[MAXPATHLEN];
790 kluge_around_eof = -1;
792 /* This should only get stopped via a USR2 signal. */
793 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
796 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
798 exit_cleanup(RERR_PROTOCOL);
801 /* Finally, we go to sleep until our parent kills us with a
802 * USR2 signal. We sleep for a short time, as on some OSes
803 * a signal won't interrupt a sleep! */
810 io_end_multiplex_in();
811 if (write_batch && !am_server)
814 close(error_pipe[1]);
818 io_start_buffering_out(f_out);
820 set_msg_fd_in(error_pipe[0]);
821 io_start_buffering_in(error_pipe[0]);
823 #ifdef SUPPORT_HARD_LINKS
824 if (preserve_hard_links && inc_recurse) {
825 struct file_list *flist;
826 for (flist = first_flist; flist; flist = flist->next)
827 match_hard_links(flist);
831 generate_files(f_out, local_name);
834 io_flush(FULL_FLUSH);
835 if (protocol_version >= 24) {
836 /* send a final goodbye message */
837 write_ndx(f_out, NDX_DONE);
839 io_flush(FULL_FLUSH);
843 wait_process_with_flush(pid, &exit_code);
847 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
850 struct file_list *flist;
851 char *local_name = NULL;
853 int save_verbose = verbose;
855 if (filesfrom_fd >= 0) {
856 /* We can't mix messages with files-from data on the socket,
857 * so temporarily turn off verbose messages. */
862 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
863 argc, (long)getpid());
866 if (am_daemon && lp_read_only(module_id)) {
867 rprintf(FERROR,"ERROR: module is read only\n");
868 exit_cleanup(RERR_SYNTAX);
876 if (!am_daemon && !push_dir(dir, 0)) {
877 rsyserr(FERROR, errno, "push_dir#4 %s failed",
879 exit_cleanup(RERR_FILESELECT);
883 if (protocol_version >= 30)
884 io_start_multiplex_in();
886 io_start_buffering_in(f_in);
887 recv_filter_list(f_in);
889 if (filesfrom_fd >= 0) {
890 /* We need to send the files-from names to the sender at the
891 * same time that we receive the file-list from them, so we
892 * need the IO routines to automatically write out the names
893 * onto our f_out socket as we read the file-list. This
894 * avoids both deadlock and extra delays/buffers. */
895 io_set_filesfrom_fds(filesfrom_fd, f_out);
899 flist = recv_file_list(f_in);
901 rprintf(FERROR,"server_recv: recv_file_list error\n");
902 exit_cleanup(RERR_FILESELECT);
904 if (inc_recurse && file_total == 1)
905 recv_additional_file_list(f_in);
906 verbose = save_verbose;
909 local_name = get_local_name(flist,argv[0]);
911 /* Now that we know what our destination directory turned out to be,
912 * we can sanitize the --link-/copy-/compare-dest args correctly. */
913 if (sanitize_paths) {
915 for (dir = basis_dir; *dir; dir++) {
916 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
919 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
924 if (server_filter_list.head) {
926 struct filter_list_struct *elp = &server_filter_list;
928 for (dir = basis_dir; *dir; dir++) {
929 if (check_filter(elp, *dir, 1) < 0)
930 goto options_rejected;
932 if (partial_dir && *partial_dir == '/'
933 && check_filter(elp, partial_dir, 1) < 0) {
936 "Your options have been rejected by the server.\n");
937 exit_cleanup(RERR_SYNTAX);
941 exit_code = do_recv(f_in, f_out, local_name);
942 exit_cleanup(exit_code);
946 int child_main(int argc, char *argv[])
948 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
953 void start_server(int f_in, int f_out, int argc, char *argv[])
955 set_nonblocking(f_in);
956 set_nonblocking(f_out);
958 io_set_sock_fds(f_in, f_out);
959 setup_protocol(f_out, f_in);
961 if (protocol_version >= 23)
962 io_start_multiplex_out();
965 keep_dirlinks = 0; /* Must be disabled on the sender. */
966 if (need_messages_from_generator)
967 io_start_multiplex_in();
968 recv_filter_list(f_in);
969 do_server_sender(f_in, f_out, argc, argv);
971 do_server_recv(f_in, f_out, argc, argv);
977 * This is called once the connection has been negotiated. It is used
978 * for rsyncd, remote-shell, and local connections.
980 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
982 struct file_list *flist = NULL;
983 int exit_code = 0, exit_code2 = 0;
984 char *local_name = NULL;
986 cleanup_child_pid = pid;
988 set_nonblocking(f_in);
989 set_nonblocking(f_out);
992 io_set_sock_fds(f_in, f_out);
993 setup_protocol(f_out,f_in);
995 /* We set our stderr file handle to blocking because ssh might have
996 * set it to non-blocking. This can be particularly troublesome if
997 * stderr is a clone of stdout, because ssh would have set our stdout
998 * to non-blocking at the same time (which can easily cause us to lose
999 * output from our print statements). This kluge shouldn't cause ssh
1000 * any problems for how we use it. Note also that we delayed setting
1001 * this until after the above protocol setup so that we know for sure
1002 * that ssh is done twiddling its file descriptors. */
1003 set_blocking(STDERR_FILENO);
1006 keep_dirlinks = 0; /* Must be disabled on the sender. */
1007 if (protocol_version >= 30)
1008 io_start_multiplex_out();
1010 io_start_buffering_out(f_out);
1011 if (!filesfrom_host)
1012 set_msg_fd_in(f_in);
1013 send_filter_list(f_out);
1015 filesfrom_fd = f_in;
1017 if (write_batch && !am_server)
1018 start_write_batch(f_out);
1019 flist = send_file_list(f_out, argc, argv);
1022 rprintf(FINFO,"file list sent\n");
1024 if (protocol_version >= 23)
1025 io_start_multiplex_in();
1027 io_flush(NORMAL_FLUSH);
1028 send_files(f_in, f_out);
1029 io_flush(FULL_FLUSH);
1031 if (protocol_version >= 24)
1032 read_final_goodbye(f_in);
1035 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1036 io_flush(FULL_FLUSH);
1037 wait_process_with_flush(pid, &exit_code);
1040 io_flush(FULL_FLUSH);
1041 exit_cleanup(exit_code);
1045 if (protocol_version >= 23)
1046 io_start_multiplex_in();
1047 if (need_messages_from_generator)
1048 io_start_multiplex_out();
1054 send_filter_list(read_batch ? -1 : f_out);
1056 if (filesfrom_fd >= 0) {
1057 io_set_filesfrom_fds(filesfrom_fd, f_out);
1061 if (write_batch && !am_server)
1062 start_write_batch(f_in);
1063 flist = recv_file_list(f_in);
1064 if (inc_recurse && file_total == 1)
1065 recv_additional_file_list(f_in);
1067 if (flist && flist->used > 0) {
1068 local_name = get_local_name(flist, argv[0]);
1072 exit_code2 = do_recv(f_in, f_out, local_name);
1080 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1081 io_flush(FULL_FLUSH);
1082 wait_process_with_flush(pid, &exit_code);
1085 return MAX(exit_code, exit_code2);
1088 static int copy_argv(char *argv[])
1092 for (i = 0; argv[i]; i++) {
1093 if (!(argv[i] = strdup(argv[i]))) {
1094 rprintf (FERROR, "out of memory at %s(%d)\n",
1095 __FILE__, __LINE__);
1105 * Start a client for either type of remote connection. Work out
1106 * whether the arguments request a remote shell or rsyncd connection,
1107 * and call the appropriate connection function, then run_client.
1109 * Calls either start_socket_client (for sockets) or do_cmd and
1110 * client_run (for ssh).
1112 static int start_client(int argc, char *argv[])
1114 char *p, *shell_machine = NULL, *shell_user = NULL;
1121 /* Don't clobber argv[] so that ps(1) can still show the right
1123 if ((ret = copy_argv(argv)) != 0)
1126 if (!read_batch) { /* for read_batch, NO source is specified */
1127 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1128 if (path) { /* source is remote */
1135 if (argc == 1 || **argv == ':')
1136 argc = 0; /* no dest arg */
1137 else if (check_for_hostspec(*argv, &dummy1, &dummy2)) {
1139 "The source and destination cannot both be remote.\n");
1140 exit_cleanup(RERR_SYNTAX);
1142 remote_argc--; /* don't count dest */
1145 if (filesfrom_host && *filesfrom_host
1146 && strcmp(filesfrom_host, shell_machine) != 0) {
1148 "--files-from hostname is not the same as the transfer hostname\n");
1149 exit_cleanup(RERR_SYNTAX);
1153 daemon_over_rsh = shell_cmd ? 1 : -1;
1154 } else { /* source is local, check dest arg */
1159 remote_argv = argv + argc;
1161 static char *dotarg[1] = { "." };
1163 remote_argv = dotarg;
1168 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1169 if (path && filesfrom_host && *filesfrom_host
1170 && strcmp(filesfrom_host, shell_machine) != 0) {
1172 "--files-from hostname is not the same as the transfer hostname\n");
1173 exit_cleanup(RERR_SYNTAX);
1175 if (!path) { /* no hostspec found, so src & dest are local */
1177 if (filesfrom_host) {
1179 "--files-from cannot be remote when the transfer is local\n");
1180 exit_cleanup(RERR_SYNTAX);
1182 shell_machine = NULL;
1183 } else { /* hostspec was found, so dest is remote */
1186 daemon_over_rsh = shell_cmd ? 1 : -1;
1189 } else { /* read_batch */
1191 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1192 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1193 exit_cleanup(RERR_SYNTAX);
1195 remote_argv = argv + argc - 1;
1203 /* For local source, extra source args must not have hostspec. */
1204 for (i = 1; i < argc; i++) {
1205 if (check_for_hostspec(argv[i], &dummy1, &dummy2)) {
1206 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1207 exit_cleanup(RERR_SYNTAX);
1212 /* For remote source, any extra source args must be ":SOURCE" args. */
1213 for (i = 1; i < remote_argc; i++) {
1214 if (*remote_argv[i] != ':') {
1215 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1216 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1217 exit_cleanup(RERR_SYNTAX);
1225 if (daemon_over_rsh < 0)
1226 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1228 if (password_file && !daemon_over_rsh) {
1229 rprintf(FERROR, "The --password-file option may only be "
1230 "used when accessing an rsync daemon.\n");
1231 exit_cleanup(RERR_SYNTAX);
1234 if (shell_machine) {
1235 p = strrchr(shell_machine,'@');
1238 shell_user = shell_machine;
1239 shell_machine = p+1;
1244 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1245 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1246 remote_argv ? NS(remote_argv[0]) : "");
1249 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1252 /* if we're running an rsync server on the remote host over a
1253 * remote shell command, we need to do the RSYNCD protocol first */
1254 if (daemon_over_rsh) {
1256 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1261 ret = client_run(f_in, f_out, pid, argc, argv);
1270 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1272 exit_cleanup(RERR_SIGNAL1);
1275 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1281 _exit(RERR_PARTIAL);
1285 RETSIGTYPE remember_children(UNUSED(int val))
1290 /* An empty waitpid() loop was put here by Tridge and we could never
1291 * get him to explain why he put it in, so rather than taking it
1292 * out we're instead saving the child exit statuses for later use.
1293 * The waitpid() loop presumably eliminates all possibility of leaving
1294 * zombie children, maybe that's why he did it. */
1295 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1296 /* save the child's exit status */
1297 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1298 if (pid_stat_table[cnt].pid == 0) {
1299 pid_stat_table[cnt].pid = pid;
1300 pid_stat_table[cnt].status = status;
1306 #ifndef HAVE_SIGACTION
1307 signal(SIGCHLD, remember_children);
1313 * This routine catches signals and tries to send them to gdb.
1315 * Because it's called from inside a signal handler it ought not to
1316 * use too many library routines.
1318 * @todo Perhaps use "screen -X" instead/as well, to help people
1319 * debugging without easy access to X. Perhaps use an environment
1320 * variable, or just call a script?
1322 * @todo The /proc/ magic probably only works on Linux (and
1323 * Solaris?) Can we be more portable?
1325 #ifdef MAINTAINER_MODE
1326 const char *get_panic_action(void)
1328 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1333 return "xterm -display :0 -T Panic -n Panic "
1334 "-e gdb /proc/%d/exe %d";
1339 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1341 * This signal handler is only installed if we were configured with
1342 * --enable-maintainer-mode. Perhaps it should always be on and we
1343 * should just look at the environment variable, but I'm a bit leery
1344 * of a signal sending us into a busy loop.
1346 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1351 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1352 getpid(), getpid());
1354 /* Unless we failed to execute gdb, we allow the process to
1355 * continue. I'm not sure if that's right. */
1356 ret = system(cmd_buf);
1363 int main(int argc,char *argv[])
1366 int orig_argc = argc;
1367 char **orig_argv = argv;
1368 #ifdef HAVE_SIGACTION
1369 # ifdef HAVE_SIGPROCMASK
1372 sigemptyset(&sigmask);
1374 sigact.sa_flags = SA_NOCLDSTOP;
1376 SIGACTMASK(SIGUSR1, sigusr1_handler);
1377 SIGACTMASK(SIGUSR2, sigusr2_handler);
1378 SIGACTMASK(SIGCHLD, remember_children);
1379 #ifdef MAINTAINER_MODE
1380 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1381 SIGACTMASK(SIGFPE, rsync_panic_handler);
1382 SIGACTMASK(SIGABRT, rsync_panic_handler);
1383 SIGACTMASK(SIGBUS, rsync_panic_handler);
1386 starttime = time(NULL);
1387 am_root = (MY_UID() == 0);
1389 memset(&stats, 0, sizeof(stats));
1393 exit_cleanup(RERR_SYNTAX);
1396 /* we set a 0 umask so that correct file permissions can be
1398 orig_umask = umask(0);
1400 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1401 setlocale(LC_CTYPE, "");
1404 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1405 /* FIXME: We ought to call the same error-handling
1406 * code here, rather than relying on getopt. */
1408 exit_cleanup(RERR_SYNTAX);
1411 SIGACTMASK(SIGINT, sig_int);
1412 SIGACTMASK(SIGHUP, sig_int);
1413 SIGACTMASK(SIGTERM, sig_int);
1414 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1415 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1418 /* Ignore SIGPIPE; we consistently check error codes and will
1420 SIGACTION(SIGPIPE, SIG_IGN);
1422 SIGACTION(SIGXFSZ, SIG_IGN);
1425 /* Initialize push_dir here because on some old systems getcwd
1426 * (implemented by forking "pwd" and reading its output) doesn't
1427 * work when there are other child processes. Also, on all systems
1428 * that implement getcwd that way "pwd" can't be found after chroot. */
1433 if ((write_batch || read_batch) && !am_server) {
1435 write_batch_shell_file(orig_argc, orig_argv, argc);
1437 if (read_batch && strcmp(batch_name, "-") == 0)
1438 batch_fd = STDIN_FILENO;
1440 batch_fd = do_open(batch_name,
1441 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1442 : O_RDONLY, S_IRUSR | S_IWUSR);
1445 rsyserr(FERROR, errno, "Batch file %s open error",
1446 full_fname(batch_name));
1447 exit_cleanup(RERR_FILEIO);
1450 read_stream_flags(batch_fd);
1452 write_stream_flags(batch_fd);
1455 if (write_batch < 0)
1458 if (am_daemon && !am_server)
1459 return daemon_main();
1461 if (am_server && protect_args) {
1462 char buf[MAXPATHLEN];
1464 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1465 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1467 exit_cleanup(RERR_SYNTAX);
1473 exit_cleanup(RERR_SYNTAX);
1477 set_nonblocking(STDIN_FILENO);
1478 set_nonblocking(STDOUT_FILENO);
1480 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1481 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1484 ret = start_client(argc, argv);
1486 exit_cleanup(RERR_STARTCLIENT);