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 *dest_option;
72 extern char *basis_dir[];
73 extern char *rsync_path;
74 extern char *shell_cmd;
75 extern char *batch_name;
76 extern char *password_file;
77 extern char curr_dir[MAXPATHLEN];
78 extern struct file_list *first_flist;
79 extern struct filter_list_struct server_filter_list;
81 extern iconv_t ic_send;
85 int daemon_over_rsh = 0;
86 mode_t orig_umask = 0;
87 int batch_gen_fd = -1;
89 /* There's probably never more than at most 2 outstanding child processes,
90 * but set it higher, just in case. */
91 #define MAXCHILDPROCS 7
94 # ifdef HAVE_SIGPROCMASK
95 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
97 # define SIGACTMASK(n,h) SIGACTION(n,h)
99 static struct sigaction sigact;
105 } pid_stat_table[MAXCHILDPROCS];
107 static time_t starttime, endtime;
108 static int64 total_read, total_written;
110 static void show_malloc_stats(void);
112 /* Works like waitpid(), but if we already harvested the child pid in our
113 * remember_children(), we succeed instead of returning an error. */
114 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
119 waited_pid = waitpid(pid, status_ptr, flags);
120 } while (waited_pid == -1 && errno == EINTR);
122 if (waited_pid == -1 && errno == ECHILD) {
123 /* Status of requested child no longer available: check to
124 * see if it was processed by remember_children(). */
126 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
127 if (pid == pid_stat_table[cnt].pid) {
128 *status_ptr = pid_stat_table[cnt].status;
129 pid_stat_table[cnt].pid = 0;
138 /* Wait for a process to exit, calling io_flush while waiting. */
139 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
144 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
146 io_flush(FULL_FLUSH);
149 /* TODO: If the child exited on a signal, then log an
150 * appropriate error message. Perhaps we should also accept a
151 * message describing the purpose of the child. Also indicate
152 * this to the caller so that they know something went wrong. */
153 if (waited_pid < 0) {
154 rsyserr(FERROR, errno, "waitpid");
155 *exit_code_ptr = RERR_WAITCHILD;
156 } else if (!WIFEXITED(status)) {
158 if (WCOREDUMP(status))
159 *exit_code_ptr = RERR_CRASHED;
162 if (WIFSIGNALED(status))
163 *exit_code_ptr = RERR_TERMINATED;
165 *exit_code_ptr = RERR_WAITCHILD;
167 *exit_code_ptr = WEXITSTATUS(status);
170 /* This function gets called from all 3 processes. We want the client side
171 * to actually output the text, but the sender is the only process that has
172 * all the stats we need. So, if we're a client sender, we do the report.
173 * If we're a server sender, we write the stats on the supplied fd. If
174 * we're the client receiver we read the stats from the supplied fd and do
175 * the report. All processes might also generate a set of debug stats, if
176 * the verbose level is high enough (this is the only thing that the
177 * generator process and the server receiver ever do here). */
178 static void handle_stats(int f)
180 endtime = time(NULL);
182 /* Cache two stats because the read/write code can change it. */
183 total_read = stats.total_read;
184 total_written = stats.total_written;
186 if (do_stats && verbose > 1) {
187 /* These come out from every process */
196 if (f == -1 || !am_sender)
202 write_varlong30(f, total_read, 3);
203 write_varlong30(f, total_written, 3);
204 write_varlong30(f, stats.total_size, 3);
205 if (protocol_version >= 29) {
206 write_varlong30(f, stats.flist_buildtime, 3);
207 write_varlong30(f, stats.flist_xfertime, 3);
213 /* this is the client */
215 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
217 else if (!am_sender) {
218 /* Read the first two in opposite order because the meaning of
219 * read/write swaps when switching from sender to receiver. */
220 total_written = read_varlong30(f, 3);
221 total_read = read_varlong30(f, 3);
222 stats.total_size = read_varlong30(f, 3);
223 if (protocol_version >= 29) {
224 stats.flist_buildtime = read_varlong30(f, 3);
225 stats.flist_xfertime = read_varlong30(f, 3);
227 } else if (write_batch) {
228 /* The --read-batch process is going to be a client
229 * receiver, so we need to give it the stats. */
230 write_varlong30(batch_fd, total_read, 3);
231 write_varlong30(batch_fd, total_written, 3);
232 write_varlong30(batch_fd, stats.total_size, 3);
233 if (protocol_version >= 29) {
234 write_varlong30(batch_fd, stats.flist_buildtime, 3);
235 write_varlong30(batch_fd, stats.flist_xfertime, 3);
240 static void output_summary(void)
243 rprintf(FCLIENT, "\n");
244 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
245 rprintf(FINFO,"Number of files transferred: %d\n",
246 stats.num_transferred_files);
247 rprintf(FINFO,"Total file size: %s bytes\n",
248 human_num(stats.total_size));
249 rprintf(FINFO,"Total transferred file size: %s bytes\n",
250 human_num(stats.total_transferred_size));
251 rprintf(FINFO,"Literal data: %s bytes\n",
252 human_num(stats.literal_data));
253 rprintf(FINFO,"Matched data: %s bytes\n",
254 human_num(stats.matched_data));
255 rprintf(FINFO,"File list size: %s\n",
256 human_num(stats.flist_size));
257 if (stats.flist_buildtime) {
259 "File list generation time: %.3f seconds\n",
260 (double)stats.flist_buildtime / 1000);
262 "File list transfer time: %.3f seconds\n",
263 (double)stats.flist_xfertime / 1000);
265 rprintf(FINFO,"Total bytes sent: %s\n",
266 human_num(total_written));
267 rprintf(FINFO,"Total bytes received: %s\n",
268 human_num(total_read));
271 if (verbose || do_stats) {
272 rprintf(FCLIENT, "\n");
274 "sent %s bytes received %s bytes %s bytes/sec\n",
275 human_num(total_written), human_num(total_read),
276 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
277 rprintf(FINFO, "total size is %s speedup is %.2f%s\n",
278 human_num(stats.total_size),
279 (double)stats.total_size / (total_written+total_read),
280 dry_run ? " (DRY RUN)" : "");
289 * If our C library can get malloc statistics, then show them to FINFO
291 static void show_malloc_stats(void)
298 rprintf(FCLIENT, "\n");
299 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
300 getpid(), am_server ? "server " : "",
301 am_daemon ? "daemon " : "", who_am_i());
302 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
304 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
306 rprintf(FINFO, " smblks: %10ld\n",
308 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
310 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
312 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
313 (long)mi.arena + mi.hblkhd);
314 rprintf(FINFO, " usmblks: %10ld\n",
316 rprintf(FINFO, " fsmblks: %10ld\n",
318 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
320 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
322 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
324 #endif /* HAVE_MALLINFO */
328 /* Start the remote shell. cmd may be NULL to use the default. */
329 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
330 int *f_in_p, int *f_out_p)
333 char *args[MAX_ARGS];
338 if (!read_batch && !local_server) {
339 char *t, *f, in_quote = '\0';
340 char *rsh_env = getenv(RSYNC_RSH_ENV);
349 for (t = f = cmd; *f; f++) {
352 /* Comparison leaves rooms for server_options(). */
353 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
356 while (*f != ' ' || in_quote) {
360 "Missing trailing-%c in remote-shell command.\n",
362 exit_cleanup(RERR_SYNTAX);
367 if (*f == '\'' || *f == '"') {
372 if (*f == in_quote && *++f != in_quote) {
382 /* check to see if we've already been given '-l user' in
383 * the remote-shell command */
384 for (i = 0; i < argc-1; i++) {
385 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
390 /* remsh (on HPUX) takes the arguments the other way around */
391 args[argc++] = machine;
392 if (user && !(daemon_over_rsh && dash_l_set)) {
397 if (user && !(daemon_over_rsh && dash_l_set)) {
401 args[argc++] = machine;
404 args[argc++] = rsync_path;
406 if (blocking_io < 0) {
408 if ((cp = strrchr(cmd, '/')) != NULL)
412 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
416 server_options(args,&argc);
418 if (argc >= MAX_ARGS - 2)
424 if (!daemon_over_rsh) {
425 while (remote_argc > 0) {
426 if (argc >= MAX_ARGS - 1) {
428 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
429 exit_cleanup(RERR_SYNTAX);
431 args[argc++] = *remote_argv++;
439 for (i = 0; i < argc; i++)
440 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
441 rprintf(FCLIENT, "\n");
445 int from_gen_pipe[2];
446 set_allow_inc_recurse();
447 if (fd_pair(from_gen_pipe) < 0) {
448 rsyserr(FERROR, errno, "pipe");
449 exit_cleanup(RERR_IPC);
451 batch_gen_fd = from_gen_pipe[0];
452 *f_out_p = from_gen_pipe[1];
454 ret = -1; /* no child pid */
458 } else if (local_server) {
459 /* If the user didn't request --[no-]whole-file, force
460 * it on, but only if we're not batch processing. */
461 if (whole_file < 0 && !write_batch)
463 set_allow_inc_recurse();
464 ret = local_child(argc, args, f_in_p, f_out_p, child_main);
475 int convert = ic_send != (iconv_t)-1;
479 alloc_xbuf(&outbuf, 1024);
482 ret = piped_child(args, f_in_p, f_out_p);
484 for (i = 0; args[i]; i++) {} /* find first NULL */
485 args[i] = "rsync"; /* set a new arg0 */
487 print_child_argv("protected args:", args + i + 1);
492 INIT_XBUF_STRLEN(inbuf, args[i]);
493 iconvbufs(ic_send, &inbuf, &outbuf,
494 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
495 outbuf.buf[outbuf.len] = '\0';
496 write_buf(fd, outbuf.buf, outbuf.len + 1);
500 write_buf(fd, args[i], strlen(args[i]) + 1);
508 ret = piped_child(args, f_in_p, f_out_p);
517 out_of_memory("do_cmd");
518 return 0; /* not reached */
521 /* The receiving side operates in one of two modes:
523 * 1. it receives any number of files into a destination directory,
524 * placing them according to their names in the file-list.
526 * 2. it receives a single file and saves it using the name in the
527 * destination path instead of its file-list name. This requires a
528 * "local name" for writing out the destination file.
530 * So, our task is to figure out what mode/local-name we need.
531 * For mode 1, we change into the destination directory and return NULL.
532 * For mode 2, we change into the directory containing the destination
533 * file (if we aren't already there) and return the local-name. */
534 static char *get_local_name(struct file_list *flist, char *dest_path)
541 rprintf(FINFO, "get_local_name count=%d %s\n",
542 file_total, NS(dest_path));
545 if (!dest_path || list_only)
548 /* See what currently exists at the destination. */
549 if ((statret = do_stat(dest_path, &st)) == 0) {
550 /* If the destination is a dir, enter it and use mode 1. */
551 if (S_ISDIR(st.st_mode)) {
552 if (!push_dir(dest_path, 0)) {
553 rsyserr(FERROR, errno, "push_dir#1 %s failed",
554 full_fname(dest_path));
555 exit_cleanup(RERR_FILESELECT);
559 if (file_total > 1) {
561 "ERROR: destination must be a directory when"
562 " copying more than 1 file\n");
563 exit_cleanup(RERR_FILESELECT);
565 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
567 "ERROR: cannot overwrite non-directory"
568 " with a directory\n");
569 exit_cleanup(RERR_FILESELECT);
571 } else if (errno != ENOENT) {
572 /* If we don't know what's at the destination, fail. */
573 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
574 full_fname(dest_path));
575 exit_cleanup(RERR_FILESELECT);
578 cp = strrchr(dest_path, '/');
580 /* If we need a destination directory because the transfer is not
581 * of a single non-directory or the user has requested one via a
582 * destination path ending in a slash, create one and use mode 1. */
583 if (file_total > 1 || (cp && !cp[1])) {
584 /* Lop off the final slash (if any). */
590 "ERROR: destination path is not a directory\n");
591 exit_cleanup(RERR_SYNTAX);
594 if (mkdir_defmode(dest_path) != 0) {
595 rsyserr(FERROR, errno, "mkdir %s failed",
596 full_fname(dest_path));
597 exit_cleanup(RERR_FILEIO);
600 if (flist->high >= flist->low
601 && strcmp(flist->files[flist->low]->basename, ".") == 0)
602 flist->files[0]->flags |= FLAG_DIR_CREATED;
605 rprintf(FINFO, "created directory %s\n", dest_path);
608 /* Indicate that dest dir doesn't really exist. */
612 if (!push_dir(dest_path, dry_run > 1)) {
613 rsyserr(FERROR, errno, "push_dir#2 %s failed",
614 full_fname(dest_path));
615 exit_cleanup(RERR_FILESELECT);
621 /* Otherwise, we are writing a single file, possibly on top of an
622 * existing non-directory. Change to the item's parent directory
623 * (if it has a path component), return the basename of the
624 * destination file as the local name, and use mode 2. */
632 if (!push_dir(dest_path, 0)) {
633 rsyserr(FERROR, errno, "push_dir#3 %s failed",
634 full_fname(dest_path));
635 exit_cleanup(RERR_FILESELECT);
642 /* This function checks on our alternate-basis directories. If we're in
643 * dry-run mode and the destination dir does not yet exist, we'll try to
644 * tweak any dest-relative paths to make them work for a dry-run (the
645 * destination dir must be in curr_dir[] when this function is called).
646 * We also report if any arg that is non-existent or not a directory. */
647 static void check_alt_basis_dirs(void)
650 char **dir_p, *slash = strrchr(curr_dir, '/');
652 for (dir_p = basis_dir; *dir_p; dir_p++) {
653 if (dry_run > 1 && **dir_p != '/') {
654 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
655 char *new = new_array(char, len);
657 out_of_memory("check_alt_basis_dirs");
658 if (slash && strncmp(*dir_p, "../", 3) == 0) {
659 /* We want to remove only one leading "../" prefix for
660 * the directory we couldn't create in dry-run mode:
661 * this ensures that any other ".." references get
662 * evaluated the same as they would for a live copy. */
664 pathjoin(new, len, curr_dir, *dir_p + 3);
667 pathjoin(new, len, curr_dir, *dir_p);
670 if (do_stat(*dir_p, &st) < 0) {
671 rprintf(FWARNING, "%s arg does not exist: %s\n",
672 dest_option, *dir_p);
673 } else if (!S_ISDIR(st.st_mode)) {
674 rprintf(FWARNING, "%s arg is not a dir: %s\n",
675 dest_option, *dir_p);
680 /* This is only called by the sender. */
681 static void read_final_goodbye(int f_in)
685 char xname[MAXPATHLEN];
687 if (protocol_version < 29)
690 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
695 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
697 exit_cleanup(RERR_PROTOCOL);
701 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
703 struct file_list *flist;
707 rprintf(FINFO, "server_sender starting pid=%ld\n",
711 if (am_daemon && lp_write_only(module_id)) {
712 rprintf(FERROR, "ERROR: module is write only\n");
713 exit_cleanup(RERR_SYNTAX);
716 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
718 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
719 remove_source_files == 1 ? "source" : "sent");
720 exit_cleanup(RERR_SYNTAX);
724 if (!relative_paths) {
725 if (!push_dir(dir, 0)) {
726 rsyserr(FERROR, errno, "push_dir#3 %s failed",
728 exit_cleanup(RERR_FILESELECT);
734 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
740 flist = send_file_list(f_out,argc,argv);
741 if (!flist || flist->used == 0)
744 io_start_buffering_in(f_in);
746 send_files(f_in, f_out);
747 io_flush(FULL_FLUSH);
749 if (protocol_version >= 24)
750 read_final_goodbye(f_in);
751 io_flush(FULL_FLUSH);
756 static int do_recv(int f_in, int f_out, char *local_name)
762 /* The receiving side mustn't obey this, or an existing symlink that
763 * points to an identical file won't be replaced by the referent. */
764 copy_links = copy_dirlinks = 0;
766 #ifdef SUPPORT_HARD_LINKS
767 if (preserve_hard_links && !inc_recurse)
768 match_hard_links(first_flist);
771 if (fd_pair(error_pipe) < 0) {
772 rsyserr(FERROR, errno, "pipe failed in do_recv");
773 exit_cleanup(RERR_IPC);
776 io_flush(NORMAL_FLUSH);
778 if ((pid = do_fork()) == -1) {
779 rsyserr(FERROR, errno, "fork failed in do_recv");
780 exit_cleanup(RERR_IPC);
784 close(error_pipe[0]);
788 /* we can't let two processes write to the socket at one time */
789 io_end_multiplex_out();
791 /* set place to send errors */
792 set_msg_fd_out(error_pipe[1]);
793 io_start_buffering_out(error_pipe[1]);
795 recv_files(f_in, local_name);
796 io_flush(FULL_FLUSH);
799 send_msg(MSG_DONE, "", 1, 0);
800 write_varlong(error_pipe[1], stats.total_read, 3);
801 io_flush(FULL_FLUSH);
803 /* Handle any keep-alive packets from the post-processing work
804 * that the generator does. */
805 if (protocol_version >= 29) {
808 char xname[MAXPATHLEN];
810 kluge_around_eof = -1;
812 /* This should only get stopped via a USR2 signal. */
813 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
816 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
818 exit_cleanup(RERR_PROTOCOL);
821 /* Finally, we go to sleep until our parent kills us with a
822 * USR2 signal. We sleep for a short time, as on some OSes
823 * a signal won't interrupt a sleep! */
830 io_end_multiplex_in();
831 if (write_batch && !am_server)
834 close(error_pipe[1]);
838 io_start_buffering_out(f_out);
840 set_msg_fd_in(error_pipe[0]);
841 io_start_buffering_in(error_pipe[0]);
843 #ifdef SUPPORT_HARD_LINKS
844 if (preserve_hard_links && inc_recurse) {
845 struct file_list *flist;
846 for (flist = first_flist; flist; flist = flist->next)
847 match_hard_links(flist);
851 generate_files(f_out, local_name);
854 io_flush(FULL_FLUSH);
855 if (protocol_version >= 24) {
856 /* send a final goodbye message */
857 write_ndx(f_out, NDX_DONE);
859 io_flush(FULL_FLUSH);
863 wait_process_with_flush(pid, &exit_code);
867 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
870 struct file_list *flist;
871 char *local_name = NULL;
873 int save_verbose = verbose;
875 if (filesfrom_fd >= 0) {
876 /* We can't mix messages with files-from data on the socket,
877 * so temporarily turn off verbose messages. */
882 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
883 argc, (long)getpid());
886 if (am_daemon && lp_read_only(module_id)) {
887 rprintf(FERROR,"ERROR: module is read only\n");
888 exit_cleanup(RERR_SYNTAX);
896 if (!am_daemon && !push_dir(dir, 0)) {
897 rsyserr(FERROR, errno, "push_dir#4 %s failed",
899 exit_cleanup(RERR_FILESELECT);
903 if (protocol_version >= 30)
904 io_start_multiplex_in();
906 io_start_buffering_in(f_in);
907 recv_filter_list(f_in);
909 if (filesfrom_fd >= 0) {
910 /* We need to send the files-from names to the sender at the
911 * same time that we receive the file-list from them, so we
912 * need the IO routines to automatically write out the names
913 * onto our f_out socket as we read the file-list. This
914 * avoids both deadlock and extra delays/buffers. */
915 io_set_filesfrom_fds(filesfrom_fd, f_out);
919 flist = recv_file_list(f_in);
921 rprintf(FERROR,"server_recv: recv_file_list error\n");
922 exit_cleanup(RERR_FILESELECT);
924 if (inc_recurse && file_total == 1)
925 recv_additional_file_list(f_in);
926 verbose = save_verbose;
929 local_name = get_local_name(flist,argv[0]);
931 /* Now that we know what our destination directory turned out to be,
932 * we can sanitize the --link-/copy-/compare-dest args correctly. */
933 if (sanitize_paths) {
935 for (dir_p = basis_dir; *dir_p; dir_p++)
936 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth);
938 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth);
940 check_alt_basis_dirs();
942 if (server_filter_list.head) {
944 struct filter_list_struct *elp = &server_filter_list;
946 for (dir = basis_dir; *dir; dir++) {
947 if (check_filter(elp, *dir, 1) < 0)
948 goto options_rejected;
950 if (partial_dir && *partial_dir == '/'
951 && check_filter(elp, partial_dir, 1) < 0) {
954 "Your options have been rejected by the server.\n");
955 exit_cleanup(RERR_SYNTAX);
959 exit_code = do_recv(f_in, f_out, local_name);
960 exit_cleanup(exit_code);
964 int child_main(int argc, char *argv[])
966 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
971 void start_server(int f_in, int f_out, int argc, char *argv[])
973 set_nonblocking(f_in);
974 set_nonblocking(f_out);
976 io_set_sock_fds(f_in, f_out);
977 setup_protocol(f_out, f_in);
979 if (protocol_version >= 23)
980 io_start_multiplex_out();
983 keep_dirlinks = 0; /* Must be disabled on the sender. */
984 if (need_messages_from_generator)
985 io_start_multiplex_in();
986 recv_filter_list(f_in);
987 do_server_sender(f_in, f_out, argc, argv);
989 do_server_recv(f_in, f_out, argc, argv);
995 * This is called once the connection has been negotiated. It is used
996 * for rsyncd, remote-shell, and local connections.
998 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1000 struct file_list *flist = NULL;
1001 int exit_code = 0, exit_code2 = 0;
1002 char *local_name = NULL;
1004 cleanup_child_pid = pid;
1006 set_nonblocking(f_in);
1007 set_nonblocking(f_out);
1010 io_set_sock_fds(f_in, f_out);
1011 setup_protocol(f_out,f_in);
1013 /* We set our stderr file handle to blocking because ssh might have
1014 * set it to non-blocking. This can be particularly troublesome if
1015 * stderr is a clone of stdout, because ssh would have set our stdout
1016 * to non-blocking at the same time (which can easily cause us to lose
1017 * output from our print statements). This kluge shouldn't cause ssh
1018 * any problems for how we use it. Note also that we delayed setting
1019 * this until after the above protocol setup so that we know for sure
1020 * that ssh is done twiddling its file descriptors. */
1021 set_blocking(STDERR_FILENO);
1024 keep_dirlinks = 0; /* Must be disabled on the sender. */
1025 if (protocol_version >= 30)
1026 io_start_multiplex_out();
1028 io_start_buffering_out(f_out);
1029 if (!filesfrom_host)
1030 set_msg_fd_in(f_in);
1031 send_filter_list(f_out);
1033 filesfrom_fd = f_in;
1035 if (write_batch && !am_server)
1036 start_write_batch(f_out);
1037 flist = send_file_list(f_out, argc, argv);
1040 rprintf(FINFO,"file list sent\n");
1042 if (protocol_version >= 23)
1043 io_start_multiplex_in();
1045 io_flush(NORMAL_FLUSH);
1046 send_files(f_in, f_out);
1047 io_flush(FULL_FLUSH);
1049 if (protocol_version >= 24)
1050 read_final_goodbye(f_in);
1053 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1054 io_flush(FULL_FLUSH);
1055 wait_process_with_flush(pid, &exit_code);
1058 io_flush(FULL_FLUSH);
1059 exit_cleanup(exit_code);
1063 if (protocol_version >= 23)
1064 io_start_multiplex_in();
1065 if (need_messages_from_generator)
1066 io_start_multiplex_out();
1074 send_filter_list(read_batch ? -1 : f_out);
1076 if (filesfrom_fd >= 0) {
1077 io_set_filesfrom_fds(filesfrom_fd, f_out);
1081 if (write_batch && !am_server)
1082 start_write_batch(f_in);
1083 flist = recv_file_list(f_in);
1084 if (inc_recurse && file_total == 1)
1085 recv_additional_file_list(f_in);
1087 if (flist && flist->used > 0) {
1088 local_name = get_local_name(flist, argv[0]);
1090 check_alt_basis_dirs();
1092 exit_code2 = do_recv(f_in, f_out, local_name);
1100 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1101 io_flush(FULL_FLUSH);
1102 wait_process_with_flush(pid, &exit_code);
1105 return MAX(exit_code, exit_code2);
1108 static int copy_argv(char *argv[])
1112 for (i = 0; argv[i]; i++) {
1113 if (!(argv[i] = strdup(argv[i]))) {
1114 rprintf (FERROR, "out of memory at %s(%d)\n",
1115 __FILE__, __LINE__);
1125 * Start a client for either type of remote connection. Work out
1126 * whether the arguments request a remote shell or rsyncd connection,
1127 * and call the appropriate connection function, then run_client.
1129 * Calls either start_socket_client (for sockets) or do_cmd and
1130 * client_run (for ssh).
1132 static int start_client(int argc, char *argv[])
1134 char *p, *shell_machine = NULL, *shell_user = NULL;
1141 /* Don't clobber argv[] so that ps(1) can still show the right
1143 if ((ret = copy_argv(argv)) != 0)
1146 if (!read_batch) { /* for read_batch, NO source is specified */
1147 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1148 if (path) { /* source is remote */
1155 if (argc == 1 || **argv == ':')
1156 argc = 0; /* no dest arg */
1157 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1159 "The source and destination cannot both be remote.\n");
1160 exit_cleanup(RERR_SYNTAX);
1162 remote_argc--; /* don't count dest */
1165 if (filesfrom_host && *filesfrom_host
1166 && strcmp(filesfrom_host, shell_machine) != 0) {
1168 "--files-from hostname is not the same as the transfer hostname\n");
1169 exit_cleanup(RERR_SYNTAX);
1173 daemon_over_rsh = shell_cmd ? 1 : -1;
1174 } else { /* source is local, check dest arg */
1179 remote_argv = argv + argc;
1181 static char *dotarg[1] = { "." };
1183 remote_argv = dotarg;
1189 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1190 if (path && filesfrom_host && *filesfrom_host
1191 && strcmp(filesfrom_host, shell_machine) != 0) {
1193 "--files-from hostname is not the same as the transfer hostname\n");
1194 exit_cleanup(RERR_SYNTAX);
1196 if (!path) { /* no hostspec found, so src & dest are local */
1198 if (filesfrom_host) {
1200 "--files-from cannot be remote when the transfer is local\n");
1201 exit_cleanup(RERR_SYNTAX);
1203 shell_machine = NULL;
1204 } else { /* hostspec was found, so dest is remote */
1207 daemon_over_rsh = shell_cmd ? 1 : -1;
1210 } else { /* read_batch */
1212 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1213 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1214 exit_cleanup(RERR_SYNTAX);
1216 remote_argv = argv + argc - 1;
1222 int dummy_port = rsync_port;
1224 /* For local source, extra source args must not have hostspec. */
1225 for (i = 1; i < argc; i++) {
1226 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1227 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1228 exit_cleanup(RERR_SYNTAX);
1233 int dummy_port = rsync_port;
1235 /* For remote source, any extra source args must have either
1236 * the same hostname or an empty hostname. */
1237 for (i = 1; i < remote_argc; i++) {
1238 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1240 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1241 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1242 exit_cleanup(RERR_SYNTAX);
1244 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1245 rprintf(FERROR, "All source args must come from the same machine.\n");
1246 exit_cleanup(RERR_SYNTAX);
1248 if (rsync_port != dummy_port) {
1249 if (!rsync_port || !dummy_port)
1250 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1252 rprintf(FERROR, "All source args must use the same port number.\n");
1253 exit_cleanup(RERR_SYNTAX);
1255 remote_argv[i] = arg;
1263 if (daemon_over_rsh < 0)
1264 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1266 if (password_file && !daemon_over_rsh) {
1267 rprintf(FERROR, "The --password-file option may only be "
1268 "used when accessing an rsync daemon.\n");
1269 exit_cleanup(RERR_SYNTAX);
1272 if (connect_timeout) {
1273 rprintf(FERROR, "The --contimeout option may only be "
1274 "used when connecting to an rsync daemon.\n");
1275 exit_cleanup(RERR_SYNTAX);
1278 if (shell_machine) {
1279 p = strrchr(shell_machine,'@');
1282 shell_user = shell_machine;
1283 shell_machine = p+1;
1288 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1289 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1290 remote_argv ? NS(remote_argv[0]) : "");
1293 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1296 /* if we're running an rsync server on the remote host over a
1297 * remote shell command, we need to do the RSYNCD protocol first */
1298 if (daemon_over_rsh) {
1300 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1305 ret = client_run(f_in, f_out, pid, argc, argv);
1314 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1316 exit_cleanup(RERR_SIGNAL1);
1319 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1325 _exit(RERR_PARTIAL);
1329 RETSIGTYPE remember_children(UNUSED(int val))
1334 /* An empty waitpid() loop was put here by Tridge and we could never
1335 * get him to explain why he put it in, so rather than taking it
1336 * out we're instead saving the child exit statuses for later use.
1337 * The waitpid() loop presumably eliminates all possibility of leaving
1338 * zombie children, maybe that's why he did it. */
1339 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1340 /* save the child's exit status */
1341 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1342 if (pid_stat_table[cnt].pid == 0) {
1343 pid_stat_table[cnt].pid = pid;
1344 pid_stat_table[cnt].status = status;
1350 #ifndef HAVE_SIGACTION
1351 signal(SIGCHLD, remember_children);
1357 * This routine catches signals and tries to send them to gdb.
1359 * Because it's called from inside a signal handler it ought not to
1360 * use too many library routines.
1362 * @todo Perhaps use "screen -X" instead/as well, to help people
1363 * debugging without easy access to X. Perhaps use an environment
1364 * variable, or just call a script?
1366 * @todo The /proc/ magic probably only works on Linux (and
1367 * Solaris?) Can we be more portable?
1369 #ifdef MAINTAINER_MODE
1370 const char *get_panic_action(void)
1372 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1377 return "xterm -display :0 -T Panic -n Panic "
1378 "-e gdb /proc/%d/exe %d";
1383 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1385 * This signal handler is only installed if we were configured with
1386 * --enable-maintainer-mode. Perhaps it should always be on and we
1387 * should just look at the environment variable, but I'm a bit leery
1388 * of a signal sending us into a busy loop.
1390 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1395 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1396 getpid(), getpid());
1398 /* Unless we failed to execute gdb, we allow the process to
1399 * continue. I'm not sure if that's right. */
1400 ret = system(cmd_buf);
1407 int main(int argc,char *argv[])
1410 int orig_argc = argc;
1411 char **orig_argv = argv;
1412 #ifdef HAVE_SIGACTION
1413 # ifdef HAVE_SIGPROCMASK
1416 sigemptyset(&sigmask);
1418 sigact.sa_flags = SA_NOCLDSTOP;
1420 SIGACTMASK(SIGUSR1, sigusr1_handler);
1421 SIGACTMASK(SIGUSR2, sigusr2_handler);
1422 SIGACTMASK(SIGCHLD, remember_children);
1423 #ifdef MAINTAINER_MODE
1424 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1425 SIGACTMASK(SIGFPE, rsync_panic_handler);
1426 SIGACTMASK(SIGABRT, rsync_panic_handler);
1427 SIGACTMASK(SIGBUS, rsync_panic_handler);
1430 starttime = time(NULL);
1431 am_root = (MY_UID() == 0);
1433 memset(&stats, 0, sizeof(stats));
1437 exit_cleanup(RERR_SYNTAX);
1440 /* we set a 0 umask so that correct file permissions can be
1442 orig_umask = umask(0);
1444 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1445 setlocale(LC_CTYPE, "");
1448 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1449 /* FIXME: We ought to call the same error-handling
1450 * code here, rather than relying on getopt. */
1452 exit_cleanup(RERR_SYNTAX);
1455 SIGACTMASK(SIGINT, sig_int);
1456 SIGACTMASK(SIGHUP, sig_int);
1457 SIGACTMASK(SIGTERM, sig_int);
1458 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1459 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1462 /* Ignore SIGPIPE; we consistently check error codes and will
1464 SIGACTION(SIGPIPE, SIG_IGN);
1466 SIGACTION(SIGXFSZ, SIG_IGN);
1469 /* Initialize push_dir here because on some old systems getcwd
1470 * (implemented by forking "pwd" and reading its output) doesn't
1471 * work when there are other child processes. Also, on all systems
1472 * that implement getcwd that way "pwd" can't be found after chroot. */
1477 if ((write_batch || read_batch) && !am_server) {
1479 write_batch_shell_file(orig_argc, orig_argv, argc);
1481 if (read_batch && strcmp(batch_name, "-") == 0)
1482 batch_fd = STDIN_FILENO;
1484 batch_fd = do_open(batch_name,
1485 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1486 : O_RDONLY, S_IRUSR | S_IWUSR);
1489 rsyserr(FERROR, errno, "Batch file %s open error",
1490 full_fname(batch_name));
1491 exit_cleanup(RERR_FILEIO);
1494 read_stream_flags(batch_fd);
1496 write_stream_flags(batch_fd);
1499 if (write_batch < 0)
1506 } else if (am_daemon)
1507 return daemon_main();
1509 if (am_server && protect_args) {
1510 char buf[MAXPATHLEN];
1512 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1513 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1515 exit_cleanup(RERR_SYNTAX);
1521 exit_cleanup(RERR_SYNTAX);
1525 set_nonblocking(STDIN_FILENO);
1526 set_nonblocking(STDOUT_FILENO);
1528 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1529 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1532 ret = start_client(argc, argv);
1534 exit_cleanup(RERR_STARTCLIENT);