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 got_xfer_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;
54 extern int protect_args;
55 extern int relative_paths;
56 extern int sanitize_paths;
57 extern int curr_dir_depth;
58 extern int curr_dir_len;
60 extern int rsync_port;
61 extern int whole_file;
62 extern int read_batch;
63 extern int write_batch;
65 extern int filesfrom_fd;
66 extern int connect_timeout;
67 extern pid_t cleanup_child_pid;
68 extern struct stats stats;
69 extern char *filesfrom_host;
70 extern char *partial_dir;
71 extern char *basis_dir[];
72 extern char *rsync_path;
73 extern char *shell_cmd;
74 extern char *batch_name;
75 extern char *password_file;
76 extern char curr_dir[MAXPATHLEN];
77 extern struct file_list *first_flist;
78 extern struct filter_list_struct server_filter_list;
80 extern iconv_t ic_send;
84 int daemon_over_rsh = 0;
85 mode_t orig_umask = 0;
86 int batch_gen_fd = -1;
88 /* There's probably never more than at most 2 outstanding child processes,
89 * but set it higher, just in case. */
90 #define MAXCHILDPROCS 7
93 # ifdef HAVE_SIGPROCMASK
94 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
96 # define SIGACTMASK(n,h) SIGACTION(n,h)
98 static struct sigaction sigact;
104 } pid_stat_table[MAXCHILDPROCS];
106 static time_t starttime, endtime;
107 static int64 total_read, total_written;
109 static void show_malloc_stats(void);
111 /* Works like waitpid(), but if we already harvested the child pid in our
112 * remember_children(), we succeed instead of returning an error. */
113 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
118 waited_pid = waitpid(pid, status_ptr, flags);
119 } while (waited_pid == -1 && errno == EINTR);
121 if (waited_pid == -1 && errno == ECHILD) {
122 /* Status of requested child no longer available: check to
123 * see if it was processed by remember_children(). */
125 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
126 if (pid == pid_stat_table[cnt].pid) {
127 *status_ptr = pid_stat_table[cnt].status;
128 pid_stat_table[cnt].pid = 0;
137 /* Wait for a process to exit, calling io_flush while waiting. */
138 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
143 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
145 io_flush(FULL_FLUSH);
148 /* TODO: If the child exited on a signal, then log an
149 * appropriate error message. Perhaps we should also accept a
150 * message describing the purpose of the child. Also indicate
151 * this to the caller so that they know something went wrong. */
152 if (waited_pid < 0) {
153 rsyserr(FERROR, errno, "waitpid");
154 *exit_code_ptr = RERR_WAITCHILD;
155 } else if (!WIFEXITED(status)) {
157 if (WCOREDUMP(status))
158 *exit_code_ptr = RERR_CRASHED;
161 if (WIFSIGNALED(status))
162 *exit_code_ptr = RERR_TERMINATED;
164 *exit_code_ptr = RERR_WAITCHILD;
166 *exit_code_ptr = WEXITSTATUS(status);
169 /* This function gets called from all 3 processes. We want the client side
170 * to actually output the text, but the sender is the only process that has
171 * all the stats we need. So, if we're a client sender, we do the report.
172 * If we're a server sender, we write the stats on the supplied fd. If
173 * we're the client receiver we read the stats from the supplied fd and do
174 * the report. All processes might also generate a set of debug stats, if
175 * the verbose level is high enough (this is the only thing that the
176 * generator process and the server receiver ever do here). */
177 static void handle_stats(int f)
179 endtime = time(NULL);
181 /* Cache two stats because the read/write code can change it. */
182 total_read = stats.total_read;
183 total_written = stats.total_written;
185 if (do_stats && verbose > 1) {
186 /* These come out from every process */
195 if (f == -1 || !am_sender)
201 write_varlong30(f, total_read, 3);
202 write_varlong30(f, total_written, 3);
203 write_varlong30(f, stats.total_size, 3);
204 if (protocol_version >= 29) {
205 write_varlong30(f, stats.flist_buildtime, 3);
206 write_varlong30(f, stats.flist_xfertime, 3);
212 /* this is the client */
214 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
216 else if (!am_sender) {
217 /* Read the first two in opposite order because the meaning of
218 * read/write swaps when switching from sender to receiver. */
219 total_written = read_varlong30(f, 3);
220 total_read = read_varlong30(f, 3);
221 stats.total_size = read_varlong30(f, 3);
222 if (protocol_version >= 29) {
223 stats.flist_buildtime = read_varlong30(f, 3);
224 stats.flist_xfertime = read_varlong30(f, 3);
226 } else if (write_batch) {
227 /* The --read-batch process is going to be a client
228 * receiver, so we need to give it the stats. */
229 write_varlong30(batch_fd, total_read, 3);
230 write_varlong30(batch_fd, total_written, 3);
231 write_varlong30(batch_fd, stats.total_size, 3);
232 if (protocol_version >= 29) {
233 write_varlong30(batch_fd, stats.flist_buildtime, 3);
234 write_varlong30(batch_fd, stats.flist_xfertime, 3);
239 static void output_summary(void)
242 rprintf(FCLIENT, "\n");
243 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
244 rprintf(FINFO,"Number of files transferred: %d\n",
245 stats.num_transferred_files);
246 rprintf(FINFO,"Total file size: %s bytes\n",
247 human_num(stats.total_size));
248 rprintf(FINFO,"Total transferred file size: %s bytes\n",
249 human_num(stats.total_transferred_size));
250 rprintf(FINFO,"Literal data: %s bytes\n",
251 human_num(stats.literal_data));
252 rprintf(FINFO,"Matched data: %s bytes\n",
253 human_num(stats.matched_data));
254 rprintf(FINFO,"File list size: %s\n",
255 human_num(stats.flist_size));
256 if (stats.flist_buildtime) {
258 "File list generation time: %.3f seconds\n",
259 (double)stats.flist_buildtime / 1000);
261 "File list transfer time: %.3f seconds\n",
262 (double)stats.flist_xfertime / 1000);
264 rprintf(FINFO,"Total bytes sent: %s\n",
265 human_num(total_written));
266 rprintf(FINFO,"Total bytes received: %s\n",
267 human_num(total_read));
270 if (verbose || do_stats) {
271 rprintf(FCLIENT, "\n");
273 "sent %s bytes received %s bytes %s bytes/sec\n",
274 human_num(total_written), human_num(total_read),
275 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
276 rprintf(FINFO, "total size is %s speedup is %.2f%s\n",
277 human_num(stats.total_size),
278 (double)stats.total_size / (total_written+total_read),
279 dry_run ? " (DRY RUN)" : "");
288 * If our C library can get malloc statistics, then show them to FINFO
290 static void show_malloc_stats(void)
297 rprintf(FCLIENT, "\n");
298 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
299 getpid(), am_server ? "server " : "",
300 am_daemon ? "daemon " : "", who_am_i());
301 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
303 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
305 rprintf(FINFO, " smblks: %10ld\n",
307 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
309 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
311 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
312 (long)mi.arena + mi.hblkhd);
313 rprintf(FINFO, " usmblks: %10ld\n",
315 rprintf(FINFO, " fsmblks: %10ld\n",
317 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
319 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
321 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
323 #endif /* HAVE_MALLINFO */
327 /* Start the remote shell. cmd may be NULL to use the default. */
328 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
329 int *f_in_p, int *f_out_p)
332 char *args[MAX_ARGS];
337 if (!read_batch && !local_server) {
338 char *t, *f, in_quote = '\0';
339 char *rsh_env = getenv(RSYNC_RSH_ENV);
348 for (t = f = cmd; *f; f++) {
351 /* Comparison leaves rooms for server_options(). */
352 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
355 while (*f != ' ' || in_quote) {
359 "Missing trailing-%c in remote-shell command.\n",
361 exit_cleanup(RERR_SYNTAX);
366 if (*f == '\'' || *f == '"') {
371 if (*f == in_quote && *++f != in_quote) {
381 /* check to see if we've already been given '-l user' in
382 * the remote-shell command */
383 for (i = 0; i < argc-1; i++) {
384 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
389 /* remsh (on HPUX) takes the arguments the other way around */
390 args[argc++] = machine;
391 if (user && !(daemon_over_rsh && dash_l_set)) {
396 if (user && !(daemon_over_rsh && dash_l_set)) {
400 args[argc++] = machine;
403 args[argc++] = rsync_path;
405 if (blocking_io < 0) {
407 if ((cp = strrchr(cmd, '/')) != NULL)
411 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
415 server_options(args,&argc);
417 if (argc >= MAX_ARGS - 2)
423 if (!daemon_over_rsh) {
424 while (remote_argc > 0) {
425 if (argc >= MAX_ARGS - 1) {
427 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
428 exit_cleanup(RERR_SYNTAX);
430 args[argc++] = *remote_argv++;
438 for (i = 0; i < argc; i++)
439 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
440 rprintf(FCLIENT, "\n");
444 int from_gen_pipe[2];
445 set_allow_inc_recurse();
446 if (fd_pair(from_gen_pipe) < 0) {
447 rsyserr(FERROR, errno, "pipe");
448 exit_cleanup(RERR_IPC);
450 batch_gen_fd = from_gen_pipe[0];
451 *f_out_p = from_gen_pipe[1];
453 ret = -1; /* no child pid */
457 } else if (local_server) {
458 /* If the user didn't request --[no-]whole-file, force
459 * it on, but only if we're not batch processing. */
460 if (whole_file < 0 && !write_batch)
462 set_allow_inc_recurse();
463 ret = local_child(argc, args, f_in_p, f_out_p, child_main);
474 int convert = ic_send != (iconv_t)-1;
478 alloc_xbuf(&outbuf, 1024);
481 ret = piped_child(args, f_in_p, f_out_p);
483 for (i = 0; args[i]; i++) {} /* find first NULL */
484 args[i] = "rsync"; /* set a new arg0 */
486 print_child_argv("protected args:", args + i + 1);
491 INIT_XBUF_STRLEN(inbuf, args[i]);
492 iconvbufs(ic_send, &inbuf, &outbuf,
493 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
494 outbuf.buf[outbuf.len] = '\0';
495 write_buf(fd, outbuf.buf, outbuf.len + 1);
499 write_buf(fd, args[i], strlen(args[i]) + 1);
507 ret = piped_child(args, f_in_p, f_out_p);
516 out_of_memory("do_cmd");
517 return 0; /* not reached */
520 /* The receiving side operates in one of two modes:
522 * 1. it receives any number of files into a destination directory,
523 * placing them according to their names in the file-list.
525 * 2. it receives a single file and saves it using the name in the
526 * destination path instead of its file-list name. This requires a
527 * "local name" for writing out the destination file.
529 * So, our task is to figure out what mode/local-name we need.
530 * For mode 1, we change into the destination directory and return NULL.
531 * For mode 2, we change into the directory containing the destination
532 * file (if we aren't already there) and return the local-name. */
533 static char *get_local_name(struct file_list *flist, char *dest_path)
540 rprintf(FINFO, "get_local_name count=%d %s\n",
541 file_total, NS(dest_path));
544 if (!dest_path || list_only)
547 /* See what currently exists at the destination. */
548 if ((statret = do_stat(dest_path, &st)) == 0) {
549 /* If the destination is a dir, enter it and use mode 1. */
550 if (S_ISDIR(st.st_mode)) {
551 if (!push_dir(dest_path, 0)) {
552 rsyserr(FERROR, errno, "push_dir#1 %s failed",
553 full_fname(dest_path));
554 exit_cleanup(RERR_FILESELECT);
558 if (file_total > 1) {
560 "ERROR: destination must be a directory when"
561 " copying more than 1 file\n");
562 exit_cleanup(RERR_FILESELECT);
564 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
566 "ERROR: cannot overwrite non-directory"
567 " with a directory\n");
568 exit_cleanup(RERR_FILESELECT);
570 } else if (errno != ENOENT) {
571 /* If we don't know what's at the destination, fail. */
572 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
573 full_fname(dest_path));
574 exit_cleanup(RERR_FILESELECT);
577 cp = strrchr(dest_path, '/');
579 /* If we need a destination directory because the transfer is not
580 * of a single non-directory or the user has requested one via a
581 * destination path ending in a slash, create one and use mode 1. */
582 if (file_total > 1 || (cp && !cp[1])) {
583 /* Lop off the final slash (if any). */
589 "ERROR: destination path is not a directory\n");
590 exit_cleanup(RERR_SYNTAX);
593 if (mkdir_defmode(dest_path) != 0) {
594 rsyserr(FERROR, errno, "mkdir %s failed",
595 full_fname(dest_path));
596 exit_cleanup(RERR_FILEIO);
599 if (flist->high >= flist->low
600 && strcmp(flist->files[flist->low]->basename, ".") == 0)
601 flist->files[0]->flags |= FLAG_DIR_CREATED;
604 rprintf(FINFO, "created directory %s\n", dest_path);
607 /* Indicate that dest dir doesn't really exist. */
611 if (!push_dir(dest_path, dry_run > 1)) {
612 rsyserr(FERROR, errno, "push_dir#2 %s failed",
613 full_fname(dest_path));
614 exit_cleanup(RERR_FILESELECT);
620 /* Otherwise, we are writing a single file, possibly on top of an
621 * existing non-directory. Change to the item's parent directory
622 * (if it has a path component), return the basename of the
623 * destination file as the local name, and use mode 2. */
631 if (!push_dir(dest_path, 0)) {
632 rsyserr(FERROR, errno, "push_dir#3 %s failed",
633 full_fname(dest_path));
634 exit_cleanup(RERR_FILESELECT);
641 /* Call this if the destination dir (which is assumed to be in curr_dir)
642 * does not yet exist and we can't create it due to being in dry-run
643 * mode. We'll fix dirs that can be relative to the non-existent dir. */
644 static void fix_basis_dirs(void)
646 char **dir, *new, *slash;
652 slash = strrchr(curr_dir, '/');
654 for (dir = basis_dir; *dir; dir++) {
657 len = curr_dir_len + 1 + strlen(*dir) + 1;
658 if (!(new = new_array(char, len)))
659 out_of_memory("fix_basis_dirs");
660 if (slash && strncmp(*dir, "../", 3) == 0) {
661 /* We want to remove only one leading "../" prefix for
662 * the directory we couldn't create in dry-run mode:
663 * this ensures that any other ".." references get
664 * evaluated the same as they would for a live copy. */
666 pathjoin(new, len, curr_dir, *dir + 3);
669 pathjoin(new, len, curr_dir, *dir);
674 /* This is only called by the sender. */
675 static void read_final_goodbye(int f_in)
679 char xname[MAXPATHLEN];
681 if (protocol_version < 29)
684 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
689 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
691 exit_cleanup(RERR_PROTOCOL);
695 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
697 struct file_list *flist;
701 rprintf(FINFO, "server_sender starting pid=%ld\n",
705 if (am_daemon && lp_write_only(module_id)) {
706 rprintf(FERROR, "ERROR: module is write only\n");
707 exit_cleanup(RERR_SYNTAX);
710 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
712 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
713 remove_source_files == 1 ? "source" : "sent");
714 exit_cleanup(RERR_SYNTAX);
718 if (!relative_paths) {
719 if (!push_dir(dir, 0)) {
720 rsyserr(FERROR, errno, "push_dir#3 %s failed",
722 exit_cleanup(RERR_FILESELECT);
728 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
734 flist = send_file_list(f_out,argc,argv);
735 if (!flist || flist->used == 0)
738 io_start_buffering_in(f_in);
740 send_files(f_in, f_out);
741 io_flush(FULL_FLUSH);
743 if (protocol_version >= 24)
744 read_final_goodbye(f_in);
745 io_flush(FULL_FLUSH);
750 static int do_recv(int f_in, int f_out, char *local_name)
756 /* The receiving side mustn't obey this, or an existing symlink that
757 * points to an identical file won't be replaced by the referent. */
758 copy_links = copy_dirlinks = 0;
760 #ifdef SUPPORT_HARD_LINKS
761 if (preserve_hard_links && !inc_recurse)
762 match_hard_links(first_flist);
765 if (fd_pair(error_pipe) < 0) {
766 rsyserr(FERROR, errno, "pipe failed in do_recv");
767 exit_cleanup(RERR_IPC);
770 io_flush(NORMAL_FLUSH);
772 if ((pid = do_fork()) == -1) {
773 rsyserr(FERROR, errno, "fork failed in do_recv");
774 exit_cleanup(RERR_IPC);
778 close(error_pipe[0]);
782 /* we can't let two processes write to the socket at one time */
783 io_end_multiplex_out();
785 /* set place to send errors */
786 set_msg_fd_out(error_pipe[1]);
787 io_start_buffering_out(error_pipe[1]);
789 recv_files(f_in, local_name);
790 io_flush(FULL_FLUSH);
793 send_msg(MSG_DONE, "", 1, 0);
794 write_varlong(error_pipe[1], stats.total_read, 3);
795 io_flush(FULL_FLUSH);
797 /* Handle any keep-alive packets from the post-processing work
798 * that the generator does. */
799 if (protocol_version >= 29) {
802 char xname[MAXPATHLEN];
804 kluge_around_eof = -1;
806 /* This should only get stopped via a USR2 signal. */
807 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
810 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
812 exit_cleanup(RERR_PROTOCOL);
815 /* Finally, we go to sleep until our parent kills us with a
816 * USR2 signal. We sleep for a short time, as on some OSes
817 * a signal won't interrupt a sleep! */
824 io_end_multiplex_in();
825 if (write_batch && !am_server)
828 close(error_pipe[1]);
832 io_start_buffering_out(f_out);
834 set_msg_fd_in(error_pipe[0]);
835 io_start_buffering_in(error_pipe[0]);
837 #ifdef SUPPORT_HARD_LINKS
838 if (preserve_hard_links && inc_recurse) {
839 struct file_list *flist;
840 for (flist = first_flist; flist; flist = flist->next)
841 match_hard_links(flist);
845 generate_files(f_out, local_name);
848 io_flush(FULL_FLUSH);
849 if (protocol_version >= 24) {
850 /* send a final goodbye message */
851 write_ndx(f_out, NDX_DONE);
853 io_flush(FULL_FLUSH);
857 wait_process_with_flush(pid, &exit_code);
861 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
864 struct file_list *flist;
865 char *local_name = NULL;
867 int save_verbose = verbose;
869 if (filesfrom_fd >= 0) {
870 /* We can't mix messages with files-from data on the socket,
871 * so temporarily turn off verbose messages. */
876 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
877 argc, (long)getpid());
880 if (am_daemon && lp_read_only(module_id)) {
881 rprintf(FERROR,"ERROR: module is read only\n");
882 exit_cleanup(RERR_SYNTAX);
890 if (!am_daemon && !push_dir(dir, 0)) {
891 rsyserr(FERROR, errno, "push_dir#4 %s failed",
893 exit_cleanup(RERR_FILESELECT);
897 if (protocol_version >= 30)
898 io_start_multiplex_in();
900 io_start_buffering_in(f_in);
901 recv_filter_list(f_in);
903 if (filesfrom_fd >= 0) {
904 /* We need to send the files-from names to the sender at the
905 * same time that we receive the file-list from them, so we
906 * need the IO routines to automatically write out the names
907 * onto our f_out socket as we read the file-list. This
908 * avoids both deadlock and extra delays/buffers. */
909 io_set_filesfrom_fds(filesfrom_fd, f_out);
913 flist = recv_file_list(f_in);
915 rprintf(FERROR,"server_recv: recv_file_list error\n");
916 exit_cleanup(RERR_FILESELECT);
918 if (inc_recurse && file_total == 1)
919 recv_additional_file_list(f_in);
920 verbose = save_verbose;
923 local_name = get_local_name(flist,argv[0]);
925 /* Now that we know what our destination directory turned out to be,
926 * we can sanitize the --link-/copy-/compare-dest args correctly. */
927 if (sanitize_paths) {
929 for (dir = basis_dir; *dir; dir++) {
930 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth);
933 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth);
938 if (server_filter_list.head) {
940 struct filter_list_struct *elp = &server_filter_list;
942 for (dir = basis_dir; *dir; dir++) {
943 if (check_filter(elp, *dir, 1) < 0)
944 goto options_rejected;
946 if (partial_dir && *partial_dir == '/'
947 && check_filter(elp, partial_dir, 1) < 0) {
950 "Your options have been rejected by the server.\n");
951 exit_cleanup(RERR_SYNTAX);
955 exit_code = do_recv(f_in, f_out, local_name);
956 exit_cleanup(exit_code);
960 int child_main(int argc, char *argv[])
962 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
967 void start_server(int f_in, int f_out, int argc, char *argv[])
969 set_nonblocking(f_in);
970 set_nonblocking(f_out);
972 io_set_sock_fds(f_in, f_out);
973 setup_protocol(f_out, f_in);
975 if (protocol_version >= 23)
976 io_start_multiplex_out();
979 keep_dirlinks = 0; /* Must be disabled on the sender. */
980 if (need_messages_from_generator)
981 io_start_multiplex_in();
982 recv_filter_list(f_in);
983 do_server_sender(f_in, f_out, argc, argv);
985 do_server_recv(f_in, f_out, argc, argv);
991 * This is called once the connection has been negotiated. It is used
992 * for rsyncd, remote-shell, and local connections.
994 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
996 struct file_list *flist = NULL;
997 int exit_code = 0, exit_code2 = 0;
998 char *local_name = NULL;
1000 cleanup_child_pid = pid;
1002 set_nonblocking(f_in);
1003 set_nonblocking(f_out);
1006 io_set_sock_fds(f_in, f_out);
1007 setup_protocol(f_out,f_in);
1009 /* We set our stderr file handle to blocking because ssh might have
1010 * set it to non-blocking. This can be particularly troublesome if
1011 * stderr is a clone of stdout, because ssh would have set our stdout
1012 * to non-blocking at the same time (which can easily cause us to lose
1013 * output from our print statements). This kluge shouldn't cause ssh
1014 * any problems for how we use it. Note also that we delayed setting
1015 * this until after the above protocol setup so that we know for sure
1016 * that ssh is done twiddling its file descriptors. */
1017 set_blocking(STDERR_FILENO);
1020 keep_dirlinks = 0; /* Must be disabled on the sender. */
1021 if (protocol_version >= 30)
1022 io_start_multiplex_out();
1024 io_start_buffering_out(f_out);
1025 if (!filesfrom_host)
1026 set_msg_fd_in(f_in);
1027 send_filter_list(f_out);
1029 filesfrom_fd = f_in;
1031 if (write_batch && !am_server)
1032 start_write_batch(f_out);
1033 flist = send_file_list(f_out, argc, argv);
1036 rprintf(FINFO,"file list sent\n");
1038 if (protocol_version >= 23)
1039 io_start_multiplex_in();
1041 io_flush(NORMAL_FLUSH);
1042 send_files(f_in, f_out);
1043 io_flush(FULL_FLUSH);
1045 if (protocol_version >= 24)
1046 read_final_goodbye(f_in);
1049 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1050 io_flush(FULL_FLUSH);
1051 wait_process_with_flush(pid, &exit_code);
1054 io_flush(FULL_FLUSH);
1055 exit_cleanup(exit_code);
1059 if (protocol_version >= 23)
1060 io_start_multiplex_in();
1061 if (need_messages_from_generator)
1062 io_start_multiplex_out();
1070 send_filter_list(read_batch ? -1 : f_out);
1072 if (filesfrom_fd >= 0) {
1073 io_set_filesfrom_fds(filesfrom_fd, f_out);
1077 if (write_batch && !am_server)
1078 start_write_batch(f_in);
1079 flist = recv_file_list(f_in);
1080 if (inc_recurse && file_total == 1)
1081 recv_additional_file_list(f_in);
1083 if (flist && flist->used > 0) {
1084 local_name = get_local_name(flist, argv[0]);
1088 exit_code2 = do_recv(f_in, f_out, local_name);
1096 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1097 io_flush(FULL_FLUSH);
1098 wait_process_with_flush(pid, &exit_code);
1101 return MAX(exit_code, exit_code2);
1104 static int copy_argv(char *argv[])
1108 for (i = 0; argv[i]; i++) {
1109 if (!(argv[i] = strdup(argv[i]))) {
1110 rprintf (FERROR, "out of memory at %s(%d)\n",
1111 __FILE__, __LINE__);
1121 * Start a client for either type of remote connection. Work out
1122 * whether the arguments request a remote shell or rsyncd connection,
1123 * and call the appropriate connection function, then run_client.
1125 * Calls either start_socket_client (for sockets) or do_cmd and
1126 * client_run (for ssh).
1128 static int start_client(int argc, char *argv[])
1130 char *p, *shell_machine = NULL, *shell_user = NULL;
1137 /* Don't clobber argv[] so that ps(1) can still show the right
1139 if ((ret = copy_argv(argv)) != 0)
1142 if (!read_batch) { /* for read_batch, NO source is specified */
1143 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1144 if (path) { /* source is remote */
1151 if (argc == 1 || **argv == ':')
1152 argc = 0; /* no dest arg */
1153 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1155 "The source and destination cannot both be remote.\n");
1156 exit_cleanup(RERR_SYNTAX);
1158 remote_argc--; /* don't count dest */
1161 if (filesfrom_host && *filesfrom_host
1162 && strcmp(filesfrom_host, shell_machine) != 0) {
1164 "--files-from hostname is not the same as the transfer hostname\n");
1165 exit_cleanup(RERR_SYNTAX);
1169 daemon_over_rsh = shell_cmd ? 1 : -1;
1170 } else { /* source is local, check dest arg */
1175 remote_argv = argv + argc;
1177 static char *dotarg[1] = { "." };
1179 remote_argv = dotarg;
1185 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1186 if (path && filesfrom_host && *filesfrom_host
1187 && strcmp(filesfrom_host, shell_machine) != 0) {
1189 "--files-from hostname is not the same as the transfer hostname\n");
1190 exit_cleanup(RERR_SYNTAX);
1192 if (!path) { /* no hostspec found, so src & dest are local */
1194 if (filesfrom_host) {
1196 "--files-from cannot be remote when the transfer is local\n");
1197 exit_cleanup(RERR_SYNTAX);
1199 shell_machine = NULL;
1200 } else { /* hostspec was found, so dest is remote */
1203 daemon_over_rsh = shell_cmd ? 1 : -1;
1206 } else { /* read_batch */
1208 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1209 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1210 exit_cleanup(RERR_SYNTAX);
1212 remote_argv = argv + argc - 1;
1218 int dummy_port = rsync_port;
1220 /* For local source, extra source args must not have hostspec. */
1221 for (i = 1; i < argc; i++) {
1222 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1223 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1224 exit_cleanup(RERR_SYNTAX);
1229 int dummy_port = rsync_port;
1231 /* For remote source, any extra source args must have either
1232 * the same hostname or an empty hostname. */
1233 for (i = 1; i < remote_argc; i++) {
1234 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1236 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1237 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1238 exit_cleanup(RERR_SYNTAX);
1240 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1241 rprintf(FERROR, "All source args must come from the same machine.\n");
1242 exit_cleanup(RERR_SYNTAX);
1244 if (rsync_port != dummy_port) {
1245 if (!rsync_port || !dummy_port)
1246 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1248 rprintf(FERROR, "All source args must use the same port number.\n");
1249 exit_cleanup(RERR_SYNTAX);
1251 remote_argv[i] = arg;
1259 if (daemon_over_rsh < 0)
1260 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1262 if (password_file && !daemon_over_rsh) {
1263 rprintf(FERROR, "The --password-file option may only be "
1264 "used when accessing an rsync daemon.\n");
1265 exit_cleanup(RERR_SYNTAX);
1268 if (connect_timeout) {
1269 rprintf(FERROR, "The --contimeout option may only be "
1270 "used when connecting to an rsync daemon.\n");
1271 exit_cleanup(RERR_SYNTAX);
1274 if (shell_machine) {
1275 p = strrchr(shell_machine,'@');
1278 shell_user = shell_machine;
1279 shell_machine = p+1;
1284 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1285 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1286 remote_argv ? NS(remote_argv[0]) : "");
1289 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1292 /* if we're running an rsync server on the remote host over a
1293 * remote shell command, we need to do the RSYNCD protocol first */
1294 if (daemon_over_rsh) {
1296 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1301 ret = client_run(f_in, f_out, pid, argc, argv);
1310 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1312 exit_cleanup(RERR_SIGNAL1);
1315 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1321 _exit(RERR_PARTIAL);
1325 RETSIGTYPE remember_children(UNUSED(int val))
1330 /* An empty waitpid() loop was put here by Tridge and we could never
1331 * get him to explain why he put it in, so rather than taking it
1332 * out we're instead saving the child exit statuses for later use.
1333 * The waitpid() loop presumably eliminates all possibility of leaving
1334 * zombie children, maybe that's why he did it. */
1335 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1336 /* save the child's exit status */
1337 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1338 if (pid_stat_table[cnt].pid == 0) {
1339 pid_stat_table[cnt].pid = pid;
1340 pid_stat_table[cnt].status = status;
1346 #ifndef HAVE_SIGACTION
1347 signal(SIGCHLD, remember_children);
1353 * This routine catches signals and tries to send them to gdb.
1355 * Because it's called from inside a signal handler it ought not to
1356 * use too many library routines.
1358 * @todo Perhaps use "screen -X" instead/as well, to help people
1359 * debugging without easy access to X. Perhaps use an environment
1360 * variable, or just call a script?
1362 * @todo The /proc/ magic probably only works on Linux (and
1363 * Solaris?) Can we be more portable?
1365 #ifdef MAINTAINER_MODE
1366 const char *get_panic_action(void)
1368 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1373 return "xterm -display :0 -T Panic -n Panic "
1374 "-e gdb /proc/%d/exe %d";
1379 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1381 * This signal handler is only installed if we were configured with
1382 * --enable-maintainer-mode. Perhaps it should always be on and we
1383 * should just look at the environment variable, but I'm a bit leery
1384 * of a signal sending us into a busy loop.
1386 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1391 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1392 getpid(), getpid());
1394 /* Unless we failed to execute gdb, we allow the process to
1395 * continue. I'm not sure if that's right. */
1396 ret = system(cmd_buf);
1403 int main(int argc,char *argv[])
1406 int orig_argc = argc;
1407 char **orig_argv = argv;
1408 #ifdef HAVE_SIGACTION
1409 # ifdef HAVE_SIGPROCMASK
1412 sigemptyset(&sigmask);
1414 sigact.sa_flags = SA_NOCLDSTOP;
1416 SIGACTMASK(SIGUSR1, sigusr1_handler);
1417 SIGACTMASK(SIGUSR2, sigusr2_handler);
1418 SIGACTMASK(SIGCHLD, remember_children);
1419 #ifdef MAINTAINER_MODE
1420 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1421 SIGACTMASK(SIGFPE, rsync_panic_handler);
1422 SIGACTMASK(SIGABRT, rsync_panic_handler);
1423 SIGACTMASK(SIGBUS, rsync_panic_handler);
1426 starttime = time(NULL);
1427 am_root = (MY_UID() == 0);
1429 memset(&stats, 0, sizeof(stats));
1433 exit_cleanup(RERR_SYNTAX);
1436 /* we set a 0 umask so that correct file permissions can be
1438 orig_umask = umask(0);
1440 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1441 setlocale(LC_CTYPE, "");
1444 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1445 /* FIXME: We ought to call the same error-handling
1446 * code here, rather than relying on getopt. */
1448 exit_cleanup(RERR_SYNTAX);
1451 SIGACTMASK(SIGINT, sig_int);
1452 SIGACTMASK(SIGHUP, sig_int);
1453 SIGACTMASK(SIGTERM, sig_int);
1454 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1455 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1458 /* Ignore SIGPIPE; we consistently check error codes and will
1460 SIGACTION(SIGPIPE, SIG_IGN);
1462 SIGACTION(SIGXFSZ, SIG_IGN);
1465 /* Initialize push_dir here because on some old systems getcwd
1466 * (implemented by forking "pwd" and reading its output) doesn't
1467 * work when there are other child processes. Also, on all systems
1468 * that implement getcwd that way "pwd" can't be found after chroot. */
1473 if ((write_batch || read_batch) && !am_server) {
1475 write_batch_shell_file(orig_argc, orig_argv, argc);
1477 if (read_batch && strcmp(batch_name, "-") == 0)
1478 batch_fd = STDIN_FILENO;
1480 batch_fd = do_open(batch_name,
1481 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1482 : O_RDONLY, S_IRUSR | S_IWUSR);
1485 rsyserr(FERROR, errno, "Batch file %s open error",
1486 full_fname(batch_name));
1487 exit_cleanup(RERR_FILEIO);
1490 read_stream_flags(batch_fd);
1492 write_stream_flags(batch_fd);
1495 if (write_batch < 0)
1502 } else if (am_daemon)
1503 return daemon_main();
1505 if (am_server && protect_args) {
1506 char buf[MAXPATHLEN];
1508 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1509 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1511 exit_cleanup(RERR_SYNTAX);
1517 exit_cleanup(RERR_SYNTAX);
1521 set_nonblocking(STDIN_FILENO);
1522 set_nonblocking(STDOUT_FILENO);
1524 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1525 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1528 ret = start_client(argc, argv);
1530 exit_cleanup(RERR_STARTCLIENT);