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-2008 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
35 extern int am_generator;
37 extern int inc_recurse;
38 extern int blocking_io;
39 extern int human_readable;
40 extern int always_checksum;
41 extern int remove_source_files;
42 extern int output_needs_newline;
43 extern int need_messages_from_generator;
44 extern int kluge_around_eof;
45 extern int got_xfer_error;
47 extern int copy_links;
48 extern int copy_dirlinks;
49 extern int copy_unsafe_links;
50 extern int keep_dirlinks;
51 extern int preserve_hard_links;
52 extern int protocol_version;
53 extern int file_total;
56 extern int protect_args;
57 extern int relative_paths;
58 extern int sanitize_paths;
59 extern int curr_dir_depth;
60 extern int curr_dir_len;
62 extern int rsync_port;
63 extern int whole_file;
64 extern int read_batch;
65 extern int write_batch;
67 extern int filesfrom_fd;
68 extern int connect_timeout;
69 extern pid_t cleanup_child_pid;
70 extern unsigned int module_dirlen;
71 extern struct stats stats;
72 extern char *stdout_format;
73 extern char *logfile_format;
74 extern char *filesfrom_host;
75 extern char *partial_dir;
76 extern char *dest_option;
77 extern char *basis_dir[];
78 extern char *rsync_path;
79 extern char *shell_cmd;
80 extern char *batch_name;
81 extern char *password_file;
82 extern char curr_dir[MAXPATHLEN];
83 extern struct file_list *first_flist;
84 extern struct filter_list_struct daemon_filter_list;
88 int daemon_over_rsh = 0;
89 mode_t orig_umask = 0;
90 int batch_gen_fd = -1;
91 int sender_keeps_checksum = 0;
93 /* There's probably never more than at most 2 outstanding child processes,
94 * but set it higher, just in case. */
95 #define MAXCHILDPROCS 7
98 # ifdef HAVE_SIGPROCMASK
99 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
101 # define SIGACTMASK(n,h) SIGACTION(n,h)
103 static struct sigaction sigact;
109 } pid_stat_table[MAXCHILDPROCS];
111 static time_t starttime, endtime;
112 static int64 total_read, total_written;
114 static void show_malloc_stats(void);
116 /* Works like waitpid(), but if we already harvested the child pid in our
117 * remember_children(), we succeed instead of returning an error. */
118 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
123 waited_pid = waitpid(pid, status_ptr, flags);
124 } while (waited_pid == -1 && errno == EINTR);
126 if (waited_pid == -1 && errno == ECHILD) {
127 /* Status of requested child no longer available: check to
128 * see if it was processed by remember_children(). */
130 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
131 if (pid == pid_stat_table[cnt].pid) {
132 *status_ptr = pid_stat_table[cnt].status;
133 pid_stat_table[cnt].pid = 0;
142 /* Wait for a process to exit, calling io_flush while waiting. */
143 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
148 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
150 io_flush(FULL_FLUSH);
153 /* TODO: If the child exited on a signal, then log an
154 * appropriate error message. Perhaps we should also accept a
155 * message describing the purpose of the child. Also indicate
156 * this to the caller so that they know something went wrong. */
157 if (waited_pid < 0) {
158 rsyserr(FERROR, errno, "waitpid");
159 *exit_code_ptr = RERR_WAITCHILD;
160 } else if (!WIFEXITED(status)) {
162 if (WCOREDUMP(status))
163 *exit_code_ptr = RERR_CRASHED;
166 if (WIFSIGNALED(status))
167 *exit_code_ptr = RERR_TERMINATED;
169 *exit_code_ptr = RERR_WAITCHILD;
171 *exit_code_ptr = WEXITSTATUS(status);
174 /* This function gets called from all 3 processes. We want the client side
175 * to actually output the text, but the sender is the only process that has
176 * all the stats we need. So, if we're a client sender, we do the report.
177 * If we're a server sender, we write the stats on the supplied fd. If
178 * we're the client receiver we read the stats from the supplied fd and do
179 * the report. All processes might also generate a set of debug stats, if
180 * the verbose level is high enough (this is the only thing that the
181 * generator process and the server receiver ever do here). */
182 static void handle_stats(int f)
184 endtime = time(NULL);
186 /* Cache two stats because the read/write code can change it. */
187 total_read = stats.total_read;
188 total_written = stats.total_written;
190 if (INFO_GTE(STATS, 3)) {
191 /* These come out from every process */
200 if (f == -1 || !am_sender)
206 write_varlong30(f, total_read, 3);
207 write_varlong30(f, total_written, 3);
208 write_varlong30(f, stats.total_size, 3);
209 if (protocol_version >= 29) {
210 write_varlong30(f, stats.flist_buildtime, 3);
211 write_varlong30(f, stats.flist_xfertime, 3);
217 /* this is the client */
219 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
221 else if (!am_sender) {
222 /* Read the first two in opposite order because the meaning of
223 * read/write swaps when switching from sender to receiver. */
224 total_written = read_varlong30(f, 3);
225 total_read = read_varlong30(f, 3);
226 stats.total_size = read_varlong30(f, 3);
227 if (protocol_version >= 29) {
228 stats.flist_buildtime = read_varlong30(f, 3);
229 stats.flist_xfertime = read_varlong30(f, 3);
231 } else if (write_batch) {
232 /* The --read-batch process is going to be a client
233 * receiver, so we need to give it the stats. */
234 write_varlong30(batch_fd, total_read, 3);
235 write_varlong30(batch_fd, total_written, 3);
236 write_varlong30(batch_fd, stats.total_size, 3);
237 if (protocol_version >= 29) {
238 write_varlong30(batch_fd, stats.flist_buildtime, 3);
239 write_varlong30(batch_fd, stats.flist_xfertime, 3);
244 static void output_summary(void)
246 if (INFO_GTE(STATS, 2)) {
247 rprintf(FCLIENT, "\n");
248 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
249 rprintf(FINFO,"Number of files transferred: %d\n",
250 stats.num_transferred_files);
251 rprintf(FINFO,"Total file size: %s bytes\n",
252 big_num(stats.total_size, human_readable));
253 rprintf(FINFO,"Total transferred file size: %s bytes\n",
254 big_num(stats.total_transferred_size, human_readable));
255 rprintf(FINFO,"Literal data: %s bytes\n",
256 big_num(stats.literal_data, human_readable));
257 rprintf(FINFO,"Matched data: %s bytes\n",
258 big_num(stats.matched_data, human_readable));
259 rprintf(FINFO,"File list size: %s\n",
260 big_num(stats.flist_size, human_readable));
261 if (stats.flist_buildtime) {
263 "File list generation time: %.3f seconds\n",
264 (double)stats.flist_buildtime / 1000);
266 "File list transfer time: %.3f seconds\n",
267 (double)stats.flist_xfertime / 1000);
269 rprintf(FINFO,"Total bytes sent: %s\n",
270 big_num(total_written, human_readable));
271 rprintf(FINFO,"Total bytes received: %s\n",
272 big_num(total_read, human_readable));
275 if (INFO_GTE(STATS, 1)) {
276 rprintf(FCLIENT, "\n");
278 "sent %s bytes received %s bytes %s bytes/sec\n",
279 big_num(total_written, human_readable),
280 big_num(total_read, human_readable),
281 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
282 rprintf(FINFO, "total size is %s speedup is %.2f%s\n",
283 big_num(stats.total_size, human_readable),
284 (double)stats.total_size / (total_written+total_read),
285 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
294 * If our C library can get malloc statistics, then show them to FINFO
296 static void show_malloc_stats(void)
303 rprintf(FCLIENT, "\n");
304 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
305 getpid(), am_server ? "server " : "",
306 am_daemon ? "daemon " : "", who_am_i());
307 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
309 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
311 rprintf(FINFO, " smblks: %10ld\n",
313 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
315 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
317 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
318 (long)mi.arena + mi.hblkhd);
319 rprintf(FINFO, " usmblks: %10ld\n",
321 rprintf(FINFO, " fsmblks: %10ld\n",
323 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
325 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
327 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
329 #endif /* HAVE_MALLINFO */
333 /* Start the remote shell. cmd may be NULL to use the default. */
334 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
335 int *f_in_p, int *f_out_p)
338 char *args[MAX_ARGS];
342 if (!read_batch && !local_server) {
343 char *t, *f, in_quote = '\0';
344 char *rsh_env = getenv(RSYNC_RSH_ENV);
349 cmd = strdup(cmd); /* MEMORY LEAK */
353 for (t = f = cmd; *f; f++) {
356 /* Comparison leaves rooms for server_options(). */
357 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
360 while (*f != ' ' || in_quote) {
364 "Missing trailing-%c in remote-shell command.\n",
366 exit_cleanup(RERR_SYNTAX);
371 if (*f == '\'' || *f == '"') {
376 if (*f == in_quote && *++f != in_quote) {
386 /* check to see if we've already been given '-l user' in
387 * the remote-shell command */
388 for (i = 0; i < argc-1; i++) {
389 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
394 /* remsh (on HPUX) takes the arguments the other way around */
395 args[argc++] = machine;
396 if (user && !(daemon_over_rsh && dash_l_set)) {
401 if (user && !(daemon_over_rsh && dash_l_set)) {
405 args[argc++] = machine;
408 args[argc++] = rsync_path;
410 if (blocking_io < 0) {
412 if ((cp = strrchr(cmd, '/')) != NULL)
416 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
420 server_options(args,&argc);
422 if (argc >= MAX_ARGS - 2)
428 if (!daemon_over_rsh) {
429 while (remote_argc > 0) {
430 if (argc >= MAX_ARGS - 1) {
432 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
433 exit_cleanup(RERR_SYNTAX);
435 args[argc++] = *remote_argv++;
442 if (DEBUG_GTE(CMD, 2)) {
443 for (i = 0; i < argc; i++)
444 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
445 rprintf(FCLIENT, "\n");
449 int from_gen_pipe[2];
450 set_allow_inc_recurse();
451 if (fd_pair(from_gen_pipe) < 0) {
452 rsyserr(FERROR, errno, "pipe");
453 exit_cleanup(RERR_IPC);
455 batch_gen_fd = from_gen_pipe[0];
456 *f_out_p = from_gen_pipe[1];
458 pid = (pid_t)-1; /* no child pid */
462 } else if (local_server) {
463 /* If the user didn't request --[no-]whole-file, force
464 * it on, but only if we're not batch processing. */
465 if (whole_file < 0 && !write_batch)
467 set_allow_inc_recurse();
468 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
473 pid = piped_child(args, f_in_p, f_out_p);
478 send_protected_args(*f_out_p, args);
484 out_of_memory("do_cmd");
485 return 0; /* not reached */
488 /* The receiving side operates in one of two modes:
490 * 1. it receives any number of files into a destination directory,
491 * placing them according to their names in the file-list.
493 * 2. it receives a single file and saves it using the name in the
494 * destination path instead of its file-list name. This requires a
495 * "local name" for writing out the destination file.
497 * So, our task is to figure out what mode/local-name we need.
498 * For mode 1, we change into the destination directory and return NULL.
499 * For mode 2, we change into the directory containing the destination
500 * file (if we aren't already there) and return the local-name. */
501 static char *get_local_name(struct file_list *flist, char *dest_path)
507 if (DEBUG_GTE(RECV, 1)) {
508 rprintf(FINFO, "get_local_name count=%d %s\n",
509 file_total, NS(dest_path));
512 if (!dest_path || list_only)
515 if (daemon_filter_list.head) {
516 char *slash = strrchr(dest_path, '/');
517 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
521 if ((*dest_path != '.' || dest_path[1] != '\0')
522 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
523 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
524 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
526 exit_cleanup(RERR_FILESELECT);
532 /* See what currently exists at the destination. */
533 if ((statret = do_stat(dest_path, &st)) == 0) {
534 /* If the destination is a dir, enter it and use mode 1. */
535 if (S_ISDIR(st.st_mode)) {
536 if (!change_dir(dest_path, CD_NORMAL)) {
537 rsyserr(FERROR, errno, "change_dir#1 %s failed",
538 full_fname(dest_path));
539 exit_cleanup(RERR_FILESELECT);
543 if (file_total > 1) {
545 "ERROR: destination must be a directory when"
546 " copying more than 1 file\n");
547 exit_cleanup(RERR_FILESELECT);
549 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
551 "ERROR: cannot overwrite non-directory"
552 " with a directory\n");
553 exit_cleanup(RERR_FILESELECT);
555 } else if (errno != ENOENT) {
556 /* If we don't know what's at the destination, fail. */
557 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
558 full_fname(dest_path));
559 exit_cleanup(RERR_FILESELECT);
562 cp = strrchr(dest_path, '/');
564 /* If we need a destination directory because the transfer is not
565 * of a single non-directory or the user has requested one via a
566 * destination path ending in a slash, create one and use mode 1. */
567 if (file_total > 1 || (cp && !cp[1])) {
568 /* Lop off the final slash (if any). */
574 "ERROR: destination path is not a directory\n");
575 exit_cleanup(RERR_SYNTAX);
578 if (mkdir_defmode(dest_path) != 0) {
579 rsyserr(FERROR, errno, "mkdir %s failed",
580 full_fname(dest_path));
581 exit_cleanup(RERR_FILEIO);
584 if (flist->high >= flist->low
585 && strcmp(flist->files[flist->low]->basename, ".") == 0)
586 flist->files[0]->flags |= FLAG_DIR_CREATED;
588 if (INFO_GTE(NAME, 1))
589 rprintf(FINFO, "created directory %s\n", dest_path);
592 /* Indicate that dest dir doesn't really exist. */
596 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
597 rsyserr(FERROR, errno, "change_dir#2 %s failed",
598 full_fname(dest_path));
599 exit_cleanup(RERR_FILESELECT);
605 /* Otherwise, we are writing a single file, possibly on top of an
606 * existing non-directory. Change to the item's parent directory
607 * (if it has a path component), return the basename of the
608 * destination file as the local name, and use mode 2. */
616 if (!change_dir(dest_path, CD_NORMAL)) {
617 rsyserr(FERROR, errno, "change_dir#3 %s failed",
618 full_fname(dest_path));
619 exit_cleanup(RERR_FILESELECT);
626 /* This function checks on our alternate-basis directories. If we're in
627 * dry-run mode and the destination dir does not yet exist, we'll try to
628 * tweak any dest-relative paths to make them work for a dry-run (the
629 * destination dir must be in curr_dir[] when this function is called).
630 * We also warn about any arg that is non-existent or not a directory. */
631 static void check_alt_basis_dirs(void)
634 char **dir_p, *slash = strrchr(curr_dir, '/');
636 for (dir_p = basis_dir; *dir_p; dir_p++) {
637 if (dry_run > 1 && **dir_p != '/') {
638 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
639 char *new = new_array(char, len);
641 out_of_memory("check_alt_basis_dirs");
642 if (slash && strncmp(*dir_p, "../", 3) == 0) {
643 /* We want to remove only one leading "../" prefix for
644 * the directory we couldn't create in dry-run mode:
645 * this ensures that any other ".." references get
646 * evaluated the same as they would for a live copy. */
648 pathjoin(new, len, curr_dir, *dir_p + 3);
651 pathjoin(new, len, curr_dir, *dir_p);
654 if (do_stat(*dir_p, &st) < 0) {
655 rprintf(FWARNING, "%s arg does not exist: %s\n",
656 dest_option, *dir_p);
657 } else if (!S_ISDIR(st.st_mode)) {
658 rprintf(FWARNING, "%s arg is not a dir: %s\n",
659 dest_option, *dir_p);
664 /* This is only called by the sender. */
665 static void read_final_goodbye(int f_in)
669 char xname[MAXPATHLEN];
671 if (protocol_version < 29)
674 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
679 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
681 exit_cleanup(RERR_PROTOCOL);
685 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
687 struct file_list *flist;
690 if (DEBUG_GTE(SEND, 1)) {
691 rprintf(FINFO, "server_sender starting pid=%ld\n",
695 if (am_daemon && lp_write_only(module_id)) {
696 rprintf(FERROR, "ERROR: module is write only\n");
697 exit_cleanup(RERR_SYNTAX);
700 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
702 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
703 remove_source_files == 1 ? "source" : "sent");
704 exit_cleanup(RERR_SYNTAX);
708 if (!relative_paths) {
709 if (!change_dir(dir, CD_NORMAL)) {
710 rsyserr(FERROR, errno, "change_dir#3 %s failed",
712 exit_cleanup(RERR_FILESELECT);
718 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
724 flist = send_file_list(f_out,argc,argv);
725 if (!flist || flist->used == 0)
728 io_start_buffering_in(f_in);
730 send_files(f_in, f_out);
731 io_flush(FULL_FLUSH);
733 if (protocol_version >= 24)
734 read_final_goodbye(f_in);
735 io_flush(FULL_FLUSH);
740 static int do_recv(int f_in, int f_out, char *local_name)
746 /* The receiving side mustn't obey this, or an existing symlink that
747 * points to an identical file won't be replaced by the referent. */
748 copy_links = copy_dirlinks = copy_unsafe_links = 0;
750 #ifdef SUPPORT_HARD_LINKS
751 if (preserve_hard_links && !inc_recurse)
752 match_hard_links(first_flist);
755 if (fd_pair(error_pipe) < 0) {
756 rsyserr(FERROR, errno, "pipe failed in do_recv");
757 exit_cleanup(RERR_IPC);
760 io_flush(NORMAL_FLUSH);
762 if ((pid = do_fork()) == -1) {
763 rsyserr(FERROR, errno, "fork failed in do_recv");
764 exit_cleanup(RERR_IPC);
768 close(error_pipe[0]);
772 /* we can't let two processes write to the socket at one time */
773 io_end_multiplex_out();
775 /* set place to send errors */
776 set_msg_fd_out(error_pipe[1]);
777 io_start_buffering_out(error_pipe[1]);
779 recv_files(f_in, local_name);
780 io_flush(FULL_FLUSH);
783 if (output_needs_newline) {
785 output_needs_newline = 0;
788 send_msg(MSG_DONE, "", 1, 0);
789 write_varlong(error_pipe[1], stats.total_read, 3);
790 io_flush(FULL_FLUSH);
792 /* Handle any keep-alive packets from the post-processing work
793 * that the generator does. */
794 if (protocol_version >= 29) {
797 char xname[MAXPATHLEN];
799 kluge_around_eof = -1;
801 /* This should only get stopped via a USR2 signal. */
802 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
805 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
807 exit_cleanup(RERR_PROTOCOL);
810 /* Finally, we go to sleep until our parent kills us with a
811 * USR2 signal. We sleep for a short time, as on some OSes
812 * a signal won't interrupt a sleep! */
819 io_end_multiplex_in();
820 if (write_batch && !am_server)
823 close(error_pipe[1]);
827 io_start_buffering_out(f_out);
829 set_msg_fd_in(error_pipe[0]);
830 io_start_buffering_in(error_pipe[0]);
832 #ifdef SUPPORT_HARD_LINKS
833 if (preserve_hard_links && inc_recurse) {
834 struct file_list *flist;
835 for (flist = first_flist; flist; flist = flist->next)
836 match_hard_links(flist);
840 generate_files(f_out, local_name);
843 io_flush(FULL_FLUSH);
844 if (protocol_version >= 24) {
845 /* send a final goodbye message */
846 write_ndx(f_out, NDX_DONE);
848 io_flush(FULL_FLUSH);
852 wait_process_with_flush(pid, &exit_code);
856 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
859 struct file_list *flist;
860 char *local_name = NULL;
863 if (filesfrom_fd >= 0) {
864 /* We can't mix messages with files-from data on the socket,
865 * so temporarily turn off info/debug messages. */
866 negate_output_levels();
871 if (DEBUG_GTE(RECV, 1)) {
872 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
873 argc, (long)getpid());
876 if (am_daemon && lp_read_only(module_id)) {
877 rprintf(FERROR,"ERROR: module is read only\n");
878 exit_cleanup(RERR_SYNTAX);
886 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
887 rsyserr(FERROR, errno, "change_dir#4 %s failed",
889 exit_cleanup(RERR_FILESELECT);
893 if (protocol_version >= 30)
894 io_start_multiplex_in();
896 io_start_buffering_in(f_in);
897 recv_filter_list(f_in);
899 if (filesfrom_fd >= 0) {
900 /* We need to send the files-from names to the sender at the
901 * same time that we receive the file-list from them, so we
902 * need the IO routines to automatically write out the names
903 * onto our f_out socket as we read the file-list. This
904 * avoids both deadlock and extra delays/buffers. */
905 io_set_filesfrom_fds(filesfrom_fd, f_out);
909 flist = recv_file_list(f_in);
911 rprintf(FERROR,"server_recv: recv_file_list error\n");
912 exit_cleanup(RERR_FILESELECT);
914 if (inc_recurse && file_total == 1)
915 recv_additional_file_list(f_in);
918 negate_output_levels();
921 local_name = get_local_name(flist,argv[0]);
923 /* Now that we know what our destination directory turned out to be,
924 * we can sanitize the --link-/copy-/compare-dest args correctly. */
925 if (sanitize_paths) {
927 for (dir_p = basis_dir; *dir_p; dir_p++)
928 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
930 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
932 check_alt_basis_dirs();
934 if (daemon_filter_list.head) {
936 struct filter_list_struct *elp = &daemon_filter_list;
938 for (dir_p = basis_dir; *dir_p; dir_p++) {
941 dir += module_dirlen;
942 if (check_filter(elp, FLOG, dir, 1) < 0)
943 goto options_rejected;
945 if (partial_dir && *partial_dir == '/'
946 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
949 "Your options have been rejected by the server.\n");
950 exit_cleanup(RERR_SYNTAX);
954 exit_code = do_recv(f_in, f_out, local_name);
955 exit_cleanup(exit_code);
959 int child_main(int argc, char *argv[])
961 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
966 void start_server(int f_in, int f_out, int argc, char *argv[])
968 set_nonblocking(f_in);
969 set_nonblocking(f_out);
971 io_set_sock_fds(f_in, f_out);
972 setup_protocol(f_out, f_in);
974 if (protocol_version >= 23)
975 io_start_multiplex_out();
978 keep_dirlinks = 0; /* Must be disabled on the sender. */
979 if (need_messages_from_generator)
980 io_start_multiplex_in();
981 recv_filter_list(f_in);
982 do_server_sender(f_in, f_out, argc, argv);
984 do_server_recv(f_in, f_out, argc, argv);
990 * This is called once the connection has been negotiated. It is used
991 * for rsyncd, remote-shell, and local connections.
993 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
995 struct file_list *flist = NULL;
996 int exit_code = 0, exit_code2 = 0;
997 char *local_name = NULL;
999 cleanup_child_pid = pid;
1001 set_nonblocking(f_in);
1002 set_nonblocking(f_out);
1005 io_set_sock_fds(f_in, f_out);
1006 setup_protocol(f_out,f_in);
1008 /* We set our stderr file handle to blocking because ssh might have
1009 * set it to non-blocking. This can be particularly troublesome if
1010 * stderr is a clone of stdout, because ssh would have set our stdout
1011 * to non-blocking at the same time (which can easily cause us to lose
1012 * output from our print statements). This kluge shouldn't cause ssh
1013 * any problems for how we use it. Note also that we delayed setting
1014 * this until after the above protocol setup so that we know for sure
1015 * that ssh is done twiddling its file descriptors. */
1016 set_blocking(STDERR_FILENO);
1019 keep_dirlinks = 0; /* Must be disabled on the sender. */
1022 && (log_format_has(stdout_format, 'C')
1023 || log_format_has(logfile_format, 'C')))
1024 sender_keeps_checksum = 1;
1026 if (protocol_version >= 30)
1027 io_start_multiplex_out();
1029 io_start_buffering_out(f_out);
1030 if (!filesfrom_host)
1031 set_msg_fd_in(f_in);
1032 send_filter_list(f_out);
1034 filesfrom_fd = f_in;
1036 if (write_batch && !am_server)
1037 start_write_batch(f_out);
1038 flist = send_file_list(f_out, argc, argv);
1040 if (DEBUG_GTE(FLIST, 3))
1041 rprintf(FINFO,"file list sent\n");
1043 if (protocol_version >= 23)
1044 io_start_multiplex_in();
1046 io_flush(NORMAL_FLUSH);
1047 send_files(f_in, f_out);
1048 io_flush(FULL_FLUSH);
1050 if (protocol_version >= 24)
1051 read_final_goodbye(f_in);
1053 if (DEBUG_GTE(EXIT, 2))
1054 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1055 io_flush(FULL_FLUSH);
1056 wait_process_with_flush(pid, &exit_code);
1059 io_flush(FULL_FLUSH);
1060 exit_cleanup(exit_code);
1064 if (protocol_version >= 23)
1065 io_start_multiplex_in();
1066 if (need_messages_from_generator)
1067 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]);
1086 check_alt_basis_dirs();
1088 exit_code2 = do_recv(f_in, f_out, local_name);
1095 if (DEBUG_GTE(RECV, 1))
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;
1183 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1184 if (path && filesfrom_host && *filesfrom_host
1185 && strcmp(filesfrom_host, shell_machine) != 0) {
1187 "--files-from hostname is not the same as the transfer hostname\n");
1188 exit_cleanup(RERR_SYNTAX);
1190 if (!path) { /* no hostspec found, so src & dest are local */
1192 if (filesfrom_host) {
1194 "--files-from cannot be remote when the transfer is local\n");
1195 exit_cleanup(RERR_SYNTAX);
1197 shell_machine = NULL;
1198 } else { /* hostspec was found, so dest is remote */
1201 daemon_over_rsh = shell_cmd ? 1 : -1;
1204 } else { /* read_batch */
1206 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1207 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1208 exit_cleanup(RERR_SYNTAX);
1210 remote_argv = argv + argc - 1;
1216 int dummy_port = rsync_port;
1218 /* For local source, extra source args must not have hostspec. */
1219 for (i = 1; i < argc; i++) {
1220 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1221 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1222 exit_cleanup(RERR_SYNTAX);
1227 int dummy_port = rsync_port;
1229 /* For remote source, any extra source args must have either
1230 * the same hostname or an empty hostname. */
1231 for (i = 1; i < remote_argc; i++) {
1232 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1234 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1235 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1236 exit_cleanup(RERR_SYNTAX);
1238 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1239 rprintf(FERROR, "All source args must come from the same machine.\n");
1240 exit_cleanup(RERR_SYNTAX);
1242 if (rsync_port != dummy_port) {
1243 if (!rsync_port || !dummy_port)
1244 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1246 rprintf(FERROR, "All source args must use the same port number.\n");
1247 exit_cleanup(RERR_SYNTAX);
1249 remote_argv[i] = arg;
1253 if (daemon_over_rsh < 0)
1254 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1256 if (password_file && !daemon_over_rsh) {
1257 rprintf(FERROR, "The --password-file option may only be "
1258 "used when accessing an rsync daemon.\n");
1259 exit_cleanup(RERR_SYNTAX);
1262 if (connect_timeout) {
1263 rprintf(FERROR, "The --contimeout option may only be "
1264 "used when connecting to an rsync daemon.\n");
1265 exit_cleanup(RERR_SYNTAX);
1268 if (shell_machine) {
1269 p = strrchr(shell_machine,'@');
1272 shell_user = shell_machine;
1273 shell_machine = p+1;
1277 if (DEBUG_GTE(CMD, 2)) {
1278 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1279 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1280 remote_argv ? NS(remote_argv[0]) : "");
1283 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1286 /* if we're running an rsync server on the remote host over a
1287 * remote shell command, we need to do the RSYNCD protocol first */
1288 if (daemon_over_rsh) {
1290 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1295 ret = client_run(f_in, f_out, pid, argc, argv);
1304 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1306 exit_cleanup(RERR_SIGNAL1);
1309 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1315 _exit(RERR_PARTIAL);
1319 RETSIGTYPE remember_children(UNUSED(int val))
1324 /* An empty waitpid() loop was put here by Tridge and we could never
1325 * get him to explain why he put it in, so rather than taking it
1326 * out we're instead saving the child exit statuses for later use.
1327 * The waitpid() loop presumably eliminates all possibility of leaving
1328 * zombie children, maybe that's why he did it. */
1329 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1330 /* save the child's exit status */
1331 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1332 if (pid_stat_table[cnt].pid == 0) {
1333 pid_stat_table[cnt].pid = pid;
1334 pid_stat_table[cnt].status = status;
1340 #ifndef HAVE_SIGACTION
1341 signal(SIGCHLD, remember_children);
1347 * This routine catches signals and tries to send them to gdb.
1349 * Because it's called from inside a signal handler it ought not to
1350 * use too many library routines.
1352 * @todo Perhaps use "screen -X" instead/as well, to help people
1353 * debugging without easy access to X. Perhaps use an environment
1354 * variable, or just call a script?
1356 * @todo The /proc/ magic probably only works on Linux (and
1357 * Solaris?) Can we be more portable?
1359 #ifdef MAINTAINER_MODE
1360 const char *get_panic_action(void)
1362 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1367 return "xterm -display :0 -T Panic -n Panic "
1368 "-e gdb /proc/%d/exe %d";
1373 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1375 * This signal handler is only installed if we were configured with
1376 * --enable-maintainer-mode. Perhaps it should always be on and we
1377 * should just look at the environment variable, but I'm a bit leery
1378 * of a signal sending us into a busy loop.
1380 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1385 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1386 getpid(), getpid());
1388 /* Unless we failed to execute gdb, we allow the process to
1389 * continue. I'm not sure if that's right. */
1390 ret = system(cmd_buf);
1397 int main(int argc,char *argv[])
1400 int orig_argc = argc;
1401 char **orig_argv = argv;
1402 #ifdef HAVE_SIGACTION
1403 # ifdef HAVE_SIGPROCMASK
1406 sigemptyset(&sigmask);
1408 sigact.sa_flags = SA_NOCLDSTOP;
1410 SIGACTMASK(SIGUSR1, sigusr1_handler);
1411 SIGACTMASK(SIGUSR2, sigusr2_handler);
1412 SIGACTMASK(SIGCHLD, remember_children);
1413 #ifdef MAINTAINER_MODE
1414 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1415 SIGACTMASK(SIGFPE, rsync_panic_handler);
1416 SIGACTMASK(SIGABRT, rsync_panic_handler);
1417 SIGACTMASK(SIGBUS, rsync_panic_handler);
1420 starttime = time(NULL);
1422 am_root = our_uid == 0;
1424 memset(&stats, 0, sizeof(stats));
1428 exit_cleanup(RERR_SYNTAX);
1431 /* we set a 0 umask so that correct file permissions can be
1433 orig_umask = umask(0);
1435 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1436 setlocale(LC_CTYPE, "");
1439 if (!parse_arguments(&argc, (const char ***) &argv)) {
1440 /* FIXME: We ought to call the same error-handling
1441 * code here, rather than relying on getopt. */
1443 exit_cleanup(RERR_SYNTAX);
1446 SIGACTMASK(SIGINT, sig_int);
1447 SIGACTMASK(SIGHUP, sig_int);
1448 SIGACTMASK(SIGTERM, sig_int);
1449 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1450 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1453 /* Ignore SIGPIPE; we consistently check error codes and will
1455 SIGACTION(SIGPIPE, SIG_IGN);
1457 SIGACTION(SIGXFSZ, SIG_IGN);
1460 /* Initialize change_dir() here because on some old systems getcwd
1461 * (implemented by forking "pwd" and reading its output) doesn't
1462 * work when there are other child processes. Also, on all systems
1463 * that implement getcwd that way "pwd" can't be found after chroot. */
1464 change_dir(NULL, CD_NORMAL);
1468 if ((write_batch || read_batch) && !am_server) {
1470 write_batch_shell_file(orig_argc, orig_argv, argc);
1472 if (read_batch && strcmp(batch_name, "-") == 0)
1473 batch_fd = STDIN_FILENO;
1475 batch_fd = do_open(batch_name,
1476 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1477 : O_RDONLY, S_IRUSR | S_IWUSR);
1480 rsyserr(FERROR, errno, "Batch file %s open error",
1481 full_fname(batch_name));
1482 exit_cleanup(RERR_FILEIO);
1485 read_stream_flags(batch_fd);
1487 write_stream_flags(batch_fd);
1489 if (write_batch < 0)
1496 } else if (am_daemon)
1497 return daemon_main();
1499 if (am_server && protect_args) {
1500 char buf[MAXPATHLEN];
1502 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1503 if (!parse_arguments(&argc, (const char ***) &argv)) {
1505 exit_cleanup(RERR_SYNTAX);
1511 exit_cleanup(RERR_SYNTAX);
1515 set_nonblocking(STDIN_FILENO);
1516 set_nonblocking(STDOUT_FILENO);
1518 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1519 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1522 ret = start_client(argc, argv);
1524 exit_cleanup(RERR_STARTCLIENT);